add unit flood time, add app template

app_template.py

@@ -0,0 +1,150 @@
+#!/usr/bin/env python
+#
+###############################################################################
+#   Copyright (C) 2016-2019 Cortney T. Buffington, N0MJS <n0mjs@me.com>
+#
+#   This program is free software; you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation; either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program; if not, write to the Free Software Foundation,
+#   Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
+###############################################################################
+
+# Python modules we need
+import sys
+from bitarray import bitarray
+from time import time
+from importlib import import_module
+
+# Twisted is pretty important, so I keep it separate
+from twisted.internet.protocol import Factory, Protocol
+from twisted.protocols.basic import NetstringReceiver
+from twisted.internet import reactor, task
+
+# Things we import from the main hblink module
+from hblink import HBSYSTEM, OPENBRIDGE, systems, hblink_handler, reportFactory, REPORT_OPCODES, mk_aliases
+from dmr_utils3.utils import bytes_3, int_id, get_alias
+from dmr_utils3 import decode, bptc, const
+import config
+import log
+from const import *
+
+# Stuff for socket reporting
+import pickle
+# REMOVE LATER from datetime import datetime
+# The module needs logging, but handlers, etc. are controlled by the parent
+import logging
+logger = logging.getLogger(__name__)
+
+
+# Does anybody read this stuff? There's a PEP somewhere that says I should do this.
+__author__     = 'Cortney T. Buffington, N0MJS'
+__copyright__  = 'Copyright (c) 2016-2018 Cortney T. Buffington, N0MJS and the K0USY Group'
+__credits__    = 'Colin Durbridge, G4EML, Steve Zingman, N4IRS; Mike Zingman, N4IRR; Jonathan Naylor, G4KLX; Hans Barthen, DL5DI; Torsten Shultze, DG1HT'
+__license__    = 'GNU GPLv3'
+__maintainer__ = 'Cort Buffington, N0MJS'
+__email__      = 'n0mjs@me.com'
+
+# Module gobal varaibles
+
+
+class OBP(OPENBRIDGE):
+
+    def __init__(self, _name, _config, _report):
+        OPENBRIDGE.__init__(self, _name, _config, _report)
+
+
+    def dmrd_received(self, _peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data):
+        pass
+
+
+class HBP(HBSYSTEM):
+
+    def __init__(self, _name, _config, _report):
+        HBSYSTEM.__init__(self, _name, _config, _report)
+
+    def dmrd_received(self, _peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data):
+        pass
+
+
+
+#************************************************
+#      MAIN PROGRAM LOOP STARTS HERE
+#************************************************
+
+if __name__ == '__main__':
+
+    import argparse
+    import sys
+    import os
+    import signal
+
+    # Change the current directory to the location of the application
+    os.chdir(os.path.dirname(os.path.realpath(sys.argv[0])))
+
+    # CLI argument parser - handles picking up the config file from the command line, and sending a "help" message
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-c', '--config', action='store', dest='CONFIG_FILE', help='/full/path/to/config.file (usually hblink.cfg)')
+    parser.add_argument('-l', '--logging', action='store', dest='LOG_LEVEL', help='Override config file logging level.')
+    cli_args = parser.parse_args()
+
+    # Ensure we have a path for the config file, if one wasn't specified, then use the default (top of file)
+    if not cli_args.CONFIG_FILE:
+        cli_args.CONFIG_FILE = os.path.dirname(os.path.abspath(__file__))+'/hblink.cfg'
+
+    # Call the external routine to build the configuration dictionary
+    CONFIG = config.build_config(cli_args.CONFIG_FILE)
+
+    # Start the system logger
+    if cli_args.LOG_LEVEL:
+        CONFIG['LOGGER']['LOG_LEVEL'] = cli_args.LOG_LEVEL
+    logger = log.config_logging(CONFIG['LOGGER'])
+    logger.info('\n\nCopyright (c) 2013, 2014, 2015, 2016, 2018\n\tThe Regents of the K0USY Group. All rights reserved.\n')
+    logger.debug('(GLOBAL) Logging system started, anything from here on gets logged')
+
+    # Set up the signal handler
+    def sig_handler(_signal, _frame):
+        logger.info('(GLOBAL) SHUTDOWN: CONFBRIDGE IS TERMINATING WITH SIGNAL %s', str(_signal))
+        hblink_handler(_signal, _frame)
+        logger.info('(GLOBAL) SHUTDOWN: ALL SYSTEM HANDLERS EXECUTED - STOPPING REACTOR')
+        reactor.stop()
+
+    # Set signal handers so that we can gracefully exit if need be
+    for sig in [signal.SIGINT, signal.SIGTERM]:
+        signal.signal(sig, sig_handler)
+
+    # Create the name-number mapping dictionaries
+    peer_ids, subscriber_ids, talkgroup_ids = mk_aliases(CONFIG)
+
+    # INITIALIZE THE REPORTING LOOP
+    if CONFIG['REPORTS']['REPORT']:
+        report_server = config_reports(CONFIG, bridgeReportFactory)
+    else:
+        report_server = None
+        logger.info('(REPORT) TCP Socket reporting not configured')
+
+    # HBlink instance creation
+    logger.info('(GLOBAL) HBlink \'bridge.py\' -- SYSTEM STARTING...')
+    for system in CONFIG['SYSTEMS']:
+        if CONFIG['SYSTEMS'][system]['ENABLED']:
+            if CONFIG['SYSTEMS'][system]['MODE'] == 'OPENBRIDGE':
+                systems[system] = OBP(system, CONFIG, report_server)
+            else:
+                systems[system] = HBP(system, CONFIG, report_server)
+            reactor.listenUDP(CONFIG['SYSTEMS'][system]['PORT'], systems[system], interface=CONFIG['SYSTEMS'][system]['IP'])
+            logger.debug('(GLOBAL) %s instance created: %s, %s', CONFIG['SYSTEMS'][system]['MODE'], system, systems[system])
+
+    def loopingErrHandle(failure):
+        logger.error('(GLOBAL) STOPPING REACTOR TO AVOID MEMORY LEAK: Unhandled error in timed loop.\n %s', failure)
+        reactor.stop()
+
+
+    reactor.run()

bridge.py

@@ -2,6 +2,7 @@
 #
 ###############################################################################
 #   Copyright (C) 2016-2019 Cortney T. Buffington, N0MJS <n0mjs@me.com>
+#   Copyright (C) 2020-2021 Eric, KF7EEL, <kf7eel@qsl.net>
 #
 #   This program is free software; you can redistribute it and/or modify
 #   it under the terms of the GNU General Public License as published by
@@ -70,12 +71,12 @@ from datetime import datetime
 
 
 # Does anybody read this stuff? There's a PEP somewhere that says I should do this.
-__author__     = 'Cortney T. Buffington, N0MJS'
+__author__     = 'Cortney T. Buffington, N0MJS, Eric Craw, KF7EEL, kf7eel@qsl.net'
-__copyright__  = 'Copyright (c) 2016-2019 Cortney T. Buffington, N0MJS and the K0USY Group'
+__copyright__  = 'Copyright (c) 2016-2019 Cortney T. Buffington, N0MJS and the K0USY Group, Copyright (c) 2020-2021, Eric Craw, KF7EEL'
 __credits__    = 'Colin Durbridge, G4EML, Steve Zingman, N4IRS; Mike Zingman, N4IRR; Jonathan Naylor, G4KLX; Hans Barthen, DL5DI; Torsten Shultze, DG1HT'
 __license__    = 'GNU GPLv3'
-__maintainer__ = 'Cort Buffington, N0MJS'
+__maintainer__ = 'Eric Craw, KF7EEL'
-__email__      = 'n0mjs@me.com'
+__email__      = 'kf7eel@qsl.net'
 
 ##import os, ast
 
@@ -160,17 +161,7 @@ def download_config(L_CONFIG_FILE, cli_file):
     try:
         req = requests.post(user_man_url, data=json_object, headers={'Content-Type': 'application/json'})
         resp = json.loads(req.text)
-##        print(resp)
-
-##        print(type(resp))
-##        conf = config.build_config(resp['config'])
-##        print(conf)
-##        with open('/tmp/conf_telp.cfg', 'w') as f:
-##            f.write(str(resp['config']))
-##        print(resp)
         iterate_config = resp['peers'].copy()
-##        iterate_masters = resp['masters'].copy()
-        
         corrected_config = resp['config'].copy()
         corrected_config['SYSTEMS'] = {}
         corrected_config['LOGGER'] = {}
@@ -178,35 +169,18 @@ def download_config(L_CONFIG_FILE, cli_file):
         corrected_config['SYSTEMS'].update(iterate_config)
         corrected_config['LOGGER'].update(L_CONFIG_FILE['LOGGER'])
 ##        corrected_config['USER_MANAGER'].update(resp['config']['USER_MANAGER'])
-##        print(resp['config']['USER_MANAGER'])
         corrected_config['USER_MANAGER'] = {}
         corrected_config['USER_MANAGER']['THIS_SERVER_NAME'] = L_CONFIG_FILE['USER_MANAGER']['THIS_SERVER_NAME']
         corrected_config['USER_MANAGER']['URL'] = L_CONFIG_FILE['USER_MANAGER']['URL']
         corrected_config['USER_MANAGER']['SHARED_SECRET'] = L_CONFIG_FILE['USER_MANAGER']['SHARED_SECRET']
         corrected_config['USER_MANAGER']['REMOTE_CONFIG_ENABLED'] = L_CONFIG_FILE['USER_MANAGER']['REMOTE_CONFIG_ENABLED']
         corrected_config['USER_MANAGER'].update(resp['config']['USER_MANAGER'])
-
-##        iterate_config.update(resp['masters'].copy())
-##        print(iterate_config)
-##        print(iterate_config)
-
-##        corrected_config = CONFIG_FILE.copy()
-
-        
-##        print(corrected_config)
-##        print()
-##        print(iterate_config['config']['SYSTEMS'])
-##        print(resp['config'])
-##        print((iterate_config['test']))
-##        print(corrected_config)
-        
         corrected_config['GLOBAL']['TG1_ACL'] = config.acl_build(corrected_config['GLOBAL']['TG1_ACL'], 4294967295)
         corrected_config['GLOBAL']['TG2_ACL'] = config.acl_build(corrected_config['GLOBAL']['TG2_ACL'], 4294967295)
         corrected_config['GLOBAL']['REG_ACL'] = config.acl_build(corrected_config['GLOBAL']['REG_ACL'], 4294967295)
         corrected_config['GLOBAL']['SUB_ACL'] = config.acl_build(corrected_config['GLOBAL']['SUB_ACL'], 4294967295)
 ##        corrected_config['SYSTEMS'] = {}
         for i in iterate_config:
-##            print(i)
 ##            corrected_config['SYSTEMS'][i] = {}
             if iterate_config[i]['MODE'] == 'MASTER' or iterate_config[i]['MODE'] == 'PROXY':
                 corrected_config['SYSTEMS'][i]['TG1_ACL'] = config.acl_build(iterate_config[i]['TG1_ACL'], 4294967295)
@@ -377,7 +351,7 @@ def make_bridges(_rules):
 
 
 # Run this every minute for rule timer updates
-def rule_timer_loop():
+def rule_timer_loop(unit_flood_time):
     global UNIT_MAP
     logger.debug('(ROUTER) routerHBP Rule timer loop started')
     _now = time()
@@ -391,7 +365,7 @@ def rule_timer_loop():
                         _system['ACTIVE'] = False
                         logger.info('(ROUTER) Conference Bridge TIMEOUT: DEACTIVATE System: %s, Bridge: %s, TS: %s, TGID: %s', _system['SYSTEM'], _bridge, _system['TS'], int_id(_system['TGID']))
                         # Send not active POST
-                        update_tg(CONFIG, 'off', 0, [{'SYSTEM':_system['SYSTEM']}, {'ts':_system['TS']}, {'tg': int_id(_system['TGID'])}])
+                        #update_tg(CONFIG, 'off', 0, [{'SYSTEM':_system['SYSTEM']}, {'ts':_system['TS']}, {'tg': int_id(_system['TGID'])}])
 
 ##                        print(_system)
                     else:
@@ -417,7 +391,7 @@ def rule_timer_loop():
             else:
                 logger.debug('(ROUTER) Conference Bridge NO ACTION: System: %s, Bridge: %s, TS: %s, TGID: %s', _system['SYSTEM'], _bridge, _system['TS'], int_id(_system['TGID']))
 
-    _then = _now - 60
+    _then = _now - unit_flood_time
     remove_list = []
     for unit in UNIT_MAP:
         if UNIT_MAP[unit][1] < (_then):
@@ -1369,6 +1343,8 @@ if __name__ == '__main__':
     import os
     import signal
 
+##    global unit_flood_time
+
     # Change the current directory to the location of the application
     os.chdir(os.path.dirname(os.path.realpath(sys.argv[0])))
 
@@ -1391,7 +1367,6 @@ if __name__ == '__main__':
     else:
         CONFIG = config.build_config(cli_args.CONFIG_FILE)
 
-
     # Ensure we have a path for the rules file, if one wasn't specified, then use the default (top of file)
     if not cli_args.RULES_FILE:
         cli_args.RULES_FILE = os.path.dirname(os.path.abspath(__file__))+'/rules.py'
@@ -1502,8 +1477,8 @@ if __name__ == '__main__':
         except (ImportError, FileNotFoundError):
             sys.exit('(ROUTER) TERMINATING: Routing bridges file not found or invalid: {}'.format(cli_args.RULES_FILE))
             spec = importlib.util.spec_from_file_location("module.name", cli_args.RULES_FILE)
-        print('--------')
+##        print('--------')
-        print(rules_module.BRIDGES)
+##        print(rules_module.BRIDGES)
         # Build the routing rules file
         BRIDGES = make_bridges(rules_module.BRIDGES)
         # Get rule parameter for private calls
@@ -1522,8 +1497,9 @@ if __name__ == '__main__':
         logger.error('(GLOBAL) STOPPING REACTOR TO AVOID MEMORY LEAK: Unhandled error in timed loop.\n %s', failure)
         reactor.stop()
 
+    unit_flood_time = CONFIG['OTHER']['UNIT_TIME']
     # Initialize the rule timer -- this if for user activated stuff
-    rule_timer_task = task.LoopingCall(rule_timer_loop)
+    rule_timer_task = task.LoopingCall(rule_timer_loop, unit_flood_time)
     rule_timer = rule_timer_task.start(60)
     rule_timer.addErrback(loopingErrHandle)