Modularized... I think this works.

dmr_const.py

@@ -23,7 +23,6 @@ from __future__ import print_function
 from bitarray import bitarray
 
 
-# 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 Cortney T. Buffington, N0MJS and the K0USY Group'
 __credits__    = ''
@@ -31,16 +30,6 @@ __license__    = 'GNU GPLv3'
 __maintainer__ = 'Cort Buffington, N0MJS'
 __email__      = 'n0mjs@me.com'
 
-# Timers
-STREAM_TO = .360
-
-# HomeBrew Protocol Frame Types
-HBPF_VOICE      = 0x0
-HBPF_VOICE_SYNC = 0x1
-HBPF_DATA_SYNC  = 0x2
-HBPF_SLT_VHEAD  = 0x1
-HBPF_SLT_VTERM  = 0x2
-
 # Slot Type Data types
 DMR_SLT_VHEAD = '\x01'
 DMR_SLT_VTERM = '\x02'

dmr_utils.py

@@ -0,0 +1,119 @@
+#!/usr/bin/env python
+#
+###############################################################################
+# hb_router.py -- a call routing applicaiton for hblink.py
+#   Copyright (C) 2016  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
+###############################################################################
+
+from __future__ import print_function
+
+import os
+
+from time import time
+from urllib import URLopener
+from csv import reader as csv_reader
+from binascii import b2a_hex as ahex
+
+# 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 Cortney T. Buffington, N0MJS and the K0USY Group'
+__credits__    = 'Colin Durbridge, G4EML, Steve Zingman, N4IRS; Mike Zingman'
+__license__    = 'GNU GPLv3'
+__maintainer__ = 'Cort Buffington, N0MJS'
+__email__      = 'n0mjs@me.com'
+
+#************************************************
+#     STRING UTILITY FUNCTIONS
+#************************************************
+
+# Create a 2 byte hex string from an integer
+def hex_str_2(_int_id):
+    try:
+        return format(_int_id,'x').rjust(4,'0').decode('hex')
+    except TypeError:
+        raise
+
+# Create a 3 byte hex string from an integer
+def hex_str_3(_int_id):
+    try:
+        return format(_int_id,'x').rjust(6,'0').decode('hex')
+    except TypeError:
+        raise
+
+# Create a 4 byte hex string from an integer
+def hex_str_4(_int_id):
+    try:
+        return format(_int_id,'x').rjust(8,'0').decode('hex')
+    except TypeError:
+        raise
+
+# Convert a hex string to an int (radio ID, etc.)
+def int_id(_hex_string):
+    return int(ahex(_hex_string), 16)
+
+
+#************************************************
+#     ID ALIAS FUNCTIONS
+#************************************************
+
+# Download and build dictionaries for mapping number to aliases
+# Used by applications. These lookups take time, please do not shove them
+# into this file everywhere and send a pull request!!!
+# Download a new file if it doesn't exist, or is older than the stale time
+def try_download(_path, _file, _url, _stale,):
+    now = time()
+    url = URLopener()
+    file_exists = os.path.isfile(_path+_file) == True
+    if file_exists:
+        file_old = (os.path.getmtime(_path+_file) + _stale) < now
+    if not file_exists or (file_exists and file_old):
+        try:
+            url.retrieve(_url, _path+_file)
+            result = 'ID ALIAS MAPPER: \'{}\' successfully downloaded'.format(_file)
+        except IOError:
+            result = 'ID ALIAS MAPPER: \'{}\' could not be downloaded'.format(_file)
+    else:
+        result = 'ID ALIAS MAPPER: \'{}\' is current, not downloaded'.format(_file)
+    url.close()
+    return result
+  
+def mk_id_dict(_path, _file):
+    dict = {}
+    try:
+        with open(_path+_file, 'rU') as _handle:
+            ids = csv_reader(_handle, dialect='excel', delimiter=',')
+            for row in ids:
+                dict[int(row[0])] = (row[1])
+            _handle.close
+            return dict
+    except IOError:
+        return dict
+
+def get_info(_id, _dict):
+    if _id in _dict:
+        return _dict[_id]
+    return _id
+
+# These are the functions you should use to look up IDs in the dictionaries  
+def sub_alias(_sub_id):
+    return get_info(int_id(_sub_id), subscriber_ids)
+    
+def peer_alias(_peer_id):
+    return get_info(int_id(_peer_id), peer_ids)
+
+def tg_alias(_tgid):
+    return get_info(int_id(_tgid), talkgroup_ids)

hb_const.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+#
+###############################################################################
+# hb_router.py -- a call routing applicaiton for hblink.py
+#   Copyright (C) 2016  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
+###############################################################################
+
+from __future__ import print_function
+
+__author__     = 'Cortney T. Buffington, N0MJS'
+__copyright__  = 'Copyright (c) 2016 Cortney T. Buffington, N0MJS and the K0USY Group'
+__credits__    = ''
+__license__    = 'GNU GPLv3'
+__maintainer__ = 'Cort Buffington, N0MJS'
+__email__      = 'n0mjs@me.com'
+
+# Timers
+STREAM_TO = .360
+
+# HomeBrew Protocol Frame Types
+HBPF_VOICE      = 0x0
+HBPF_VOICE_SYNC = 0x1
+HBPF_DATA_SYNC  = 0x2
+HBPF_SLT_VHEAD  = 0x1
+HBPF_SLT_VTERM  = 0x2

hb_router.py

@@ -23,7 +23,6 @@ from __future__ import print_function
 
 # Python modules we need
 import sys
-from binascii import b2a_hex as h
 from bitarray import bitarray
 from time import time
 
@@ -33,74 +32,14 @@ from twisted.internet import reactor
 from twisted.internet import task
 
 # Things we import from the main hblink module
-from hblink import CONFIG, HBSYSTEM, logger, systems, hex_str_3, int_id, sub_alias, peer_alias, tg_alias
+from hblink import HBSYSTEM, systems, int_id, hblink_handler
+from dmr_utils import hex_str_3, int_id, sub_alias, peer_alias, tg_alias
 import dec_dmr
 import bptc
-import constants as const
+import hb_config
-
+import hb_log
-# Import Bridging rules
+import dmr_const
-# Note: A stanza *must* exist for any MASTER or CLIENT configured in the main
+import hb_const
-# configuration file and listed as "active". It can be empty, 
-# but it has to exist.
-try:
-    from hb_routing_rules import RULES as RULES_FILE
-    logger.info('Routing rules file found and rules imported')
-except ImportError:
-    sys.exit('Routing rules file not found or invalid')
-    
-# Convert integer GROUP ID numbers from the config into hex strings
-# we need to send in the actual data packets.
-for _system in RULES_FILE:
-    for _rule in RULES_FILE[_system]['GROUP_VOICE']:
-        _rule['SRC_GROUP'] = hex_str_3(_rule['SRC_GROUP'])
-        _rule['DST_GROUP'] = hex_str_3(_rule['DST_GROUP'])
-        _rule['SRC_TS']    = _rule['SRC_TS']
-        _rule['DST_TS']    = _rule['DST_TS']
-        for i, e in enumerate(_rule['ON']):
-            _rule['ON'][i] = hex_str_3(_rule['ON'][i])
-        for i, e in enumerate(_rule['OFF']):
-            _rule['OFF'][i] = hex_str_3(_rule['OFF'][i])
-        _rule['TIMEOUT']= _rule['TIMEOUT']*60
-        _rule['TIMER']      = time() + _rule['TIMEOUT']
-    if _system not in CONFIG['SYSTEMS']:
-        sys.exit('ERROR: Routing rules found for system not configured main configuration')
-for _system in CONFIG['SYSTEMS']:
-    if _system not in RULES_FILE:
-        sys.exit('ERROR: Routing rules not found for all systems configured')
-
-RULES = RULES_FILE
-
-# Import subscriber ACL
-# ACL may be a single list of subscriber IDs
-# Global action is to allow or deny them. Multiple lists with different actions and ranges
-# are not yet implemented.
-try:
-    from sub_acl import ACL_ACTION, ACL
-    # uses more memory to build hex strings, but processes MUCH faster when checking for matches
-    for i, e in enumerate(ACL):
-        ACL[i] = hex_str_3(ACL[i])
-    logger.info('Subscriber access control file found, subscriber ACL imported')
-except ImportError:
-    logger.critical('\'sub_acl.py\' not found - all subscriber IDs are valid')
-    ACL_ACTION = 'NONE'
-
-# Depending on which type of ACL is used (PERMIT, DENY... or there isn't one)
-# define a differnet function to be used to check the ACL
-if ACL_ACTION == 'PERMIT':
-    def allow_sub(_sub):
-        if _sub in ACL:
-            return True
-        else:
-            return False
-elif ACL_ACTION == 'DENY':
-    def allow_sub(_sub):
-        if _sub not in ACL:
-            return True
-        else:
-            return False
-else:
-    def allow_sub(_sub):
-        return True
 
 # Does anybody read this stuff? There's a PEP somewhere that says I should do this.
 __author__     = 'Cortney T. Buffington, N0MJS'
@@ -111,6 +50,75 @@ __maintainer__ = 'Cort Buffington, N0MJS'
 __email__      = 'n0mjs@me.com'
 __status__     = 'pre-alpha'
 
+# Module gobal varaibles
+
+
+# Import Bridging rules
+# Note: A stanza *must* exist for any MASTER or CLIENT configured in the main
+# configuration file and listed as "active". It can be empty, 
+# but it has to exist.
+def make_rules():
+    try:
+        from hb_routing_rules import RULES as RULES_FILE
+        logger.info('Routing rules file found and rules imported')
+    except ImportError:
+        sys.exit('Routing rules file not found or invalid')
+    
+    # Convert integer GROUP ID numbers from the config into hex strings
+    # we need to send in the actual data packets.
+    for _system in RULES_FILE:
+        for _rule in RULES_FILE[_system]['GROUP_VOICE']:
+            _rule['SRC_GROUP'] = hex_str_3(_rule['SRC_GROUP'])
+            _rule['DST_GROUP'] = hex_str_3(_rule['DST_GROUP'])
+            _rule['SRC_TS']    = _rule['SRC_TS']
+            _rule['DST_TS']    = _rule['DST_TS']
+            for i, e in enumerate(_rule['ON']):
+                _rule['ON'][i] = hex_str_3(_rule['ON'][i])
+            for i, e in enumerate(_rule['OFF']):
+                _rule['OFF'][i] = hex_str_3(_rule['OFF'][i])
+            _rule['TIMEOUT']= _rule['TIMEOUT']*60
+            _rule['TIMER']      = time() + _rule['TIMEOUT']
+        if _system not in CONFIG['SYSTEMS']:
+            sys.exit('ERROR: Routing rules found for system not configured main configuration')
+    for _system in CONFIG['SYSTEMS']:
+        if _system not in RULES_FILE:
+            sys.exit('ERROR: Routing rules not found for all systems configured')
+    return RULES_FILE
+
+
+# Import subscriber ACL
+# ACL may be a single list of subscriber IDs
+# Global action is to allow or deny them. Multiple lists with different actions and ranges
+# are not yet implemented.
+def build_acl():
+    try:
+        from sub_acl import ACL_ACTION, ACL
+        # uses more memory to build hex strings, but processes MUCH faster when checking for matches
+        for i, e in enumerate(ACL):
+            ACL[i] = hex_str_3(ACL[i])
+        logger.info('Subscriber access control file found, subscriber ACL imported')
+    except ImportError:
+        logger.critical('\'sub_acl.py\' not found - all subscriber IDs are valid')
+        ACL_ACTION = 'NONE'
+
+    # Depending on which type of ACL is used (PERMIT, DENY... or there isn't one)
+    # define a differnet function to be used to check the ACL
+    if ACL_ACTION == 'PERMIT':
+        def allow_sub(_sub):
+            if _sub in ACL:
+                return True
+            else:
+                return False
+    elif ACL_ACTION == 'DENY':
+        def allow_sub(_sub):
+            if _sub not in ACL:
+                return True
+            else:
+                return False
+    else:
+        def allow_sub(_sub):
+            return True
+
 
 # Run this every minute for rule timer updates
 def rule_timer_loop():
@@ -140,8 +148,8 @@ def rule_timer_loop():
 
 class routerSYSTEM(HBSYSTEM):
     
-    def __init__(self, _name, _config):
+    def __init__(self, _name, _config, _logger):
-        HBSYSTEM.__init__(self, _name, _config)
+        HBSYSTEM.__init__(self, _name, _config, _logger)
         
         # Status information for the system, TS1 & TS2
         # 1 & 2 are "timeslot"
@@ -158,7 +166,7 @@ class routerSYSTEM(HBSYSTEM):
                 'TX_TGID':      '\x00\x00\x00',
                 'RX_TIME':      time(),
                 'TX_TIME':      time(),
-                'RX_TYPE':      const.HBPF_SLT_VTERM,
+                'RX_TYPE':      hb_const.HBPF_SLT_VTERM,
                 'RX_LC':        '\x00',
                 'TX_H_LC':      '\x00',
                 'TX_T_LC':      '\x00',
@@ -180,7 +188,7 @@ class routerSYSTEM(HBSYSTEM):
                 'TX_TGID':      '\x00\x00\x00',
                 'RX_TIME':      time(),
                 'TX_TIME':      time(),
-                'RX_TYPE':      const.HBPF_SLT_VTERM,
+                'RX_TYPE':      hb_const.HBPF_SLT_VTERM,
                 'RX_LC':        '\x00',
                 'TX_H_LC':      '\x00',
                 'TX_T_LC':      '\x00',
@@ -207,7 +215,7 @@ class routerSYSTEM(HBSYSTEM):
             
             # Is this a new call stream?   
             if (_stream_id != self.STATUS[_slot]['RX_STREAM_ID']):
-                if (self.STATUS[_slot]['RX_TYPE'] != const.HBPF_SLT_VTERM) and (pkt_time < (self.STATUS[_slot]['RX_TIME'] + const.STREAM_TO)) and (_rf_src != self.STATUS[_slot]['RX_RFS']):
+                if (self.STATUS[_slot]['RX_TYPE'] != hb_const.HBPF_SLT_VTERM) and (pkt_time < (self.STATUS[_slot]['RX_TIME'] + hb_const.STREAM_TO)) and (_rf_src != self.STATUS[_slot]['RX_RFS']):
                     logger.warning('(%s) Packet received with STREAM ID: %s <FROM> SUB: %s REPEATER: %s <TO> TGID %s, SLOT %s collided with existing call', self._system, int_id(_stream_id), int_id(_rf_src), int_id(_radio_id), int_id(_dst_id), _slot)
                     return
                 
@@ -216,14 +224,14 @@ class routerSYSTEM(HBSYSTEM):
                 logger.info('(%s) *CALL START* STREAM ID: %s SUB: %s (%s) REPEATER: %s (%s) TGID %s (%s), TS %s', self._system, int_id(_stream_id), sub_alias(_rf_src), int_id(_rf_src), peer_alias(_radio_id), int_id(_radio_id), tg_alias(_dst_id), int_id(_dst_id), _slot)
                 
                 # If we can, use the LC from the voice header as to keep all options intact
-                if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD:
+                if _frame_type == hb_const.HBPF_DATA_SYNC and _dtype_vseq == hb_const.HBPF_SLT_VHEAD:
                     decoded = dec_dmr.voice_head_term(dmrpkt)
                     self.STATUS[_slot]['RX_LC'] = decoded['LC']
                 
                 # If we don't have a voice header then don't wait to decode it from the Embedded LC
                 # just make a new one from the HBP header. This is good enough, and it saves lots of time
                 else:
-                    self.STATUS[_slot]['RX_LC'] = const.LC_OPT + _dst_id + _rf_src
+                    self.STATUS[_slot]['RX_LC'] = dmr_const.LC_OPT + _dst_id + _rf_src
 
 
             for rule in RULES[self._system]['GROUP_VOICE']:
@@ -242,19 +250,19 @@ class routerSYSTEM(HBSYSTEM):
                     # The "continue" at the end of each means the next iteration of the for loop that tests for matching rules
                     #
                     if ((rule['DST_GROUP'] != _target_status[rule['DST_TS']]['RX_TGID']) and ((pkt_time - _target_status[rule['DST_TS']]['RX_TIME']) < RULES[_target]['GROUP_HANGTIME'])):
-                        if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD:
+                        if _frame_type == hb_const.HBPF_DATA_SYNC and _dtype_vseq == hb_const.HBPF_SLT_VHEAD:
                             logger.info('(%s) Call not routed to TGID%s, target active or in group hangtime: HBSystem: %s, TS: %s, TGID: %s', self._system, int_id(rule['DST_GROUP']), _target, rule['DST_TS'], int_id(_target_status[rule['DST_TS']]['RX_TGID']))
                         continue    
                     if ((rule['DST_GROUP'] != _target_status[rule['DST_TS']]['TX_TGID']) and ((pkt_time - _target_status[rule['DST_TS']]['TX_TIME']) < RULES[_target]['GROUP_HANGTIME'])):
-                        if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD:
+                        if _frame_type == hb_const.HBPF_DATA_SYNC and _dtype_vseq == hb_const.HBPF_SLT_VHEAD:
                             logger.info('(%s) Call not routed to TGID%s, target in group hangtime: HBSystem: %s, TS: %s, TGID: %s', self._system, int_id(rule['DST_GROUP']), _target, rule['DST_TS'], int_id(_target_status[rule['DST_TS']]['TX_TGID']))
                         continue
-                    if (rule['DST_GROUP'] == _target_status[rule['DST_TS']]['RX_TGID']) and ((pkt_time - _target_status[rule['DST_TS']]['RX_TIME']) < const.STREAM_TO):
+                    if (rule['DST_GROUP'] == _target_status[rule['DST_TS']]['RX_TGID']) and ((pkt_time - _target_status[rule['DST_TS']]['RX_TIME']) < hb_const.STREAM_TO):
-                        if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD:
+                        if _frame_type == hb_const.HBPF_DATA_SYNC and _dtype_vseq == hb_const.HBPF_SLT_VHEAD:
                             logger.info('(%s) Call not routed to TGID%s, matching call already active on target: HBSystem: %s, TS: %s, TGID: %s', self._system, int_id(rule['DST_GROUP']), _target, rule['DST_TS'], int_id(_target_status[rule['DST_TS']]['RX_TGID']))
                         continue
-                    if (rule['DST_GROUP'] == _target_status[rule['DST_TS']]['TX_TGID']) and (_rf_src != _target_status[rule['DST_TS']]['TX_RFS']) and ((pkt_time - _target_status[rule['DST_TS']]['TX_TIME']) < const.STREAM_TO):
+                    if (rule['DST_GROUP'] == _target_status[rule['DST_TS']]['TX_TGID']) and (_rf_src != _target_status[rule['DST_TS']]['TX_RFS']) and ((pkt_time - _target_status[rule['DST_TS']]['TX_TIME']) < hb_const.STREAM_TO):
-                        if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD:
+                        if _frame_type == hb_const.HBPF_DATA_SYNC and _dtype_vseq == hb_const.HBPF_SLT_VHEAD:
                             logger.info('(%s) Call not routed for subscriber %s, call route in progress on target: HBSystem: %s, TS: %s, TGID: %s, SUB: %s', self._system, int_id(_rf_src), _target, rule['DST_TS'], int_id(_target_status[rule['DST_TS']]['TX_TGID']), _target_status[rule['DST_TS']]['TX_RFS'])
                         continue
 
@@ -289,10 +297,10 @@ class routerSYSTEM(HBSYSTEM):
                     dmrbits = bitarray(endian='big')
                     dmrbits.frombytes(dmrpkt)
                     # Create a voice header packet (FULL LC)
-                    if _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VHEAD:
+                    if _frame_type == hb_const.HBPF_DATA_SYNC and _dtype_vseq == hb_const.HBPF_SLT_VHEAD:
                         dmrbits = _target_status[rule['DST_TS']]['TX_H_LC'][0:98] + dmrbits[98:166] + _target_status[rule['DST_TS']]['TX_H_LC'][98:197]
                     # Create a voice terminator packet (FULL LC)
-                    elif _frame_type == const.HBPF_DATA_SYNC and _dtype_vseq == const.HBPF_SLT_VTERM:
+                    elif _frame_type == hb_const.HBPF_DATA_SYNC and _dtype_vseq == hb_const.HBPF_SLT_VTERM:
                         dmrbits = _target_status[rule['DST_TS']]['TX_T_LC'][0:98] + dmrbits[98:166] + _target_status[rule['DST_TS']]['TX_T_LC'][98:197]
                     # Create a Burst B-E packet (Embedded LC)
                     elif _dtype_vseq in [1,2,3,4]:
@@ -307,7 +315,7 @@ class routerSYSTEM(HBSYSTEM):
             
             
             # Final actions - Is this a voice terminator?
-            if (_frame_type == const.HBPF_DATA_SYNC) and (_dtype_vseq == const.HBPF_SLT_VTERM) and (self.STATUS[_slot]['RX_TYPE'] != const.HBPF_SLT_VTERM):
+            if (_frame_type == hb_const.HBPF_DATA_SYNC) and (_dtype_vseq == hb_const.HBPF_SLT_VTERM) and (self.STATUS[_slot]['RX_TYPE'] != hb_const.HBPF_SLT_VTERM):
                 call_duration = pkt_time - self.STATUS['RX_START']
                 logger.info('(%s) *CALL END*   STREAM ID: %s SUB: %s (%s) REPEATER: %s (%s) TGID %s (%s), TS %s, Duration: %s', self._system, int_id(_stream_id), sub_alias(_rf_src), int_id(_rf_src), peer_alias(_radio_id), int_id(_radio_id), tg_alias(_dst_id), int_id(_dst_id), _slot, call_duration)
                 
@@ -374,12 +382,107 @@ class routerSYSTEM(HBSYSTEM):
 #************************************************
 
 if __name__ == '__main__':
-    logger.info('HBlink \'hb_router.py\' (c) 2016 N0MJS & the K0USY Group - SYSTEM STARTING...')
+    
+    import argparse
+    import sys
+    import os
+    import signal
+    from dmrutils import try_download, mk_id_dict
+    
+    
+    #
+    # Parse the command line and make adjustments
+    #
+    
+    # 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'
+
+
+    #
+    # Build the configuration file
+    #
+
+    # Call the external routine to build the configuration dictionary
+    CONFIG = hb_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 = hb_log.config_logging(CONFIG['LOGGER'])
+    logger.debug('Logging system started, anything from here on gets logged')
+    
+    
+    #
+    # Set up the signal handler
+    #
+    
+    def sig_handler(_signal, _frame):
+        logger.info('SHUTDOWN: HBROUTER IS TERMINATING WITH SIGNAL %s', str(_signal))
+        hblink_handler(_signal, _frame, logger)
+        logger.info('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.SIGTERM, signal.SIGINT]:
+        signal.signal(sig, sig_handler)
+    
+    
+    #
+    # ID ALIAS CREATION
+    #
+    
+    # Download
+    if CONFIG['ALIASES']['TRY_DOWNLOAD'] == True:
+        # Try updating peer aliases file
+        result = try_download(CONFIG['ALIASES']['PATH'], CONFIG['ALIASES']['PEER_FILE'], CONFIG['ALIASES']['PEER_URL'], CONFIG['ALIASES']['STALE_TIME'])
+        logger.info(result)
+        # Try updating subscriber aliases file
+        result = try_download(CONFIG['ALIASES']['PATH'], CONFIG['ALIASES']['SUBSCRIBER_FILE'], CONFIG['ALIASES']['SUBSCRIBER_URL'], CONFIG['ALIASES']['STALE_TIME'])
+        logger.info(result)
+        
+    # Make Dictionaries
+    peer_ids = mk_id_dict(CONFIG['ALIASES']['PATH'], CONFIG['ALIASES']['PEER_FILE'])
+    if peer_ids:
+        logger.info('ID ALIAS MAPPER: peer_ids dictionary is available')
+        
+    subscriber_ids = mk_id_dict(CONFIG['ALIASES']['PATH'], CONFIG['ALIASES']['SUBSCRIBER_FILE'])
+    if subscriber_ids:
+        logger.info('ID ALIAS MAPPER: peer_ids dictionary is available')
+    
+    talkgroup_ids = mk_id_dict(CONFIG['ALIASES']['PATH'], CONFIG['ALIASES']['TGID_FILE'])
+    if talkgroup_ids:
+        logger.info('ID ALIAS MAPPER: peer_ids dictionary is available')
+    
+    
+    #
+    # START HB_ROUTER
+    #
+    
+    # Build the routing rules file
+    RULES = make_rules()
+    
+    # Build the Access Control List
+    build_acl()
     
     # HBlink instance creation
+    logger.info('HBlink \'hb_router.py\' (c) 2016 N0MJS & the K0USY Group - SYSTEM STARTING...')
     for system in CONFIG['SYSTEMS']:
         if CONFIG['SYSTEMS'][system]['ENABLED']:
-            systems[system] = routerSYSTEM(system, CONFIG)
+            systems[system] = routerSYSTEM(system, CONFIG, logger)
             reactor.listenUDP(CONFIG['SYSTEMS'][system]['PORT'], systems[system], interface=CONFIG['SYSTEMS'][system]['IP'])
             logger.debug('%s instance created: %s, %s', CONFIG['SYSTEMS'][system]['MODE'], system, systems[system])
             

hblink.py

@@ -21,27 +21,15 @@
 
 from __future__ import print_function
 
-# Python modules we need
-import argparse
-import sys
-import os
-import signal
-
 # Specifig functions from modules we need
-from binascii import b2a_hex as h
+from binascii import b2a_hex as ahex
-from binascii import a2b_hex as a
+from binascii import a2b_hex as bhex
-from socket import gethostbyname
 from random import randint
 from hashlib import sha256
 from time import time
-from urllib import URLopener
+from bitstring import BitArray
-from csv import reader as csv_reader
-#from bitstring import BitArray
 import socket
 
-# Debugging functions
-from pprint import pprint
-
 # Twisted is pretty important, so I keep it separate
 from twisted.internet.protocol import DatagramProtocol
 from twisted.internet import reactor
@@ -50,6 +38,7 @@ from twisted.internet import task
 # Other files we pull from -- this is mostly for readability and segmentation
 import hb_log
 import hb_config
+from dmr_utils import int_id, hex_str_4
 
 # Does anybody read this stuff? There's a PEP somewhere that says I should do this.
 __author__     = 'Cortney T. Buffington, N0MJS'
@@ -63,132 +52,12 @@ __email__      = 'n0mjs@me.com'
 # Global variables used whether we are a module or __main__
 systems = {}
 
-# 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 execution directory
-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 = hb_config.build_config(cli_args.CONFIG_FILE)
-
-# Call the external routing to start the system logger
-if cli_args.LOG_LEVEL:
-    CONFIG['LOGGER']['LOG_LEVEL'] = cli_args.LOG_LEVEL
-logger = hb_log.config_logging(CONFIG['LOGGER'])
-logger.debug('Logging system started, anything from here on gets logged')
-
-# Download and build dictionaries for mapping number to aliases
-# Used by applications. These lookups take time, please do not shove them
-# into this file everywhere and send a pull request!!!
-# Download a new file if it doesn't exist, or is older than the stale time
-def try_download(_path, _file, _url, _stale):
-    now = time()
-    url = URLopener()
-    file_exists = os.path.isfile(_path+_file) == True
-    if file_exists:
-        file_old = (os.path.getmtime(_path+_file) + _stale) < now
-    if not file_exists or (file_exists and file_old):
-        try:
-            url.retrieve(_url, _path+_file)
-            logger.info('ID ALIAS MAPPER: DOWNLOAD: \'%s\' successfully downloaded', _file)
-        except IOError:
-            logger.warning('ID ALIAS MAPPER: DOWNLOAD: \'%s\' could not be downloaded', _file)
-    else:
-        logger.info('ID ALIAS MAPPER: DOWNLOAD: \'%s\' is current, not downloaded', _file)
-    url.close()
-  
-def mk_id_dict(_path, _file):
-    dict = {}
-    try:
-        with open(_path+_file, 'rU') as _handle:
-            ids = csv_reader(_handle, dialect='excel', delimiter=',')
-            for row in ids:
-                dict[int(row[0])] = (row[1])
-            logger.info('ID ALIAS MAPPER: IMPORT: %s IDs from FILE %s', len(dict), _file)
-            _handle.close
-    except IOError:
-        logger.warning('ID ALIAS MAPPER: IMPORT: FILE %s not found; aliases will not be available', _file)
-    return dict
-
-def get_info(_id, _dict):
-    if _id in _dict:
-        return _dict[_id]
-    return _id
- 
-# Download files and build the dictionaries
-if CONFIG['ALIASES']['TRY_DOWNLOAD'] == True:
-    try_download(CONFIG['ALIASES']['PATH'], CONFIG['ALIASES']['PEER_FILE'], CONFIG['ALIASES']['PEER_URL'], CONFIG['ALIASES']['STALE_TIME'])
-    try_download(CONFIG['ALIASES']['PATH'], CONFIG['ALIASES']['SUBSCRIBER_FILE'], CONFIG['ALIASES']['SUBSCRIBER_URL'], CONFIG['ALIASES']['STALE_TIME'])
-peer_ids = mk_id_dict(CONFIG['ALIASES']['PATH'], CONFIG['ALIASES']['PEER_FILE'])
-subscriber_ids = mk_id_dict(CONFIG['ALIASES']['PATH'], CONFIG['ALIASES']['SUBSCRIBER_FILE'])
-talkgroup_ids = mk_id_dict(CONFIG['ALIASES']['PATH'], CONFIG['ALIASES']['TGID_FILE'])
-
-# These are the functions you should use to look up IDs in the dictionaries  
-def sub_alias(_sub_id):
-    return get_info(int_id(_sub_id), subscriber_ids)
-    
-def peer_alias(_peer_id):
-    return get_info(int_id(_peer_id), peer_ids)
-
-def tg_alias(_tgid):
-    return get_info(int_id(_tgid), talkgroup_ids)
-
-
 # Shut ourselves down gracefully by disconnecting from the masters and clients.
-def handler(_signal, _frame):
+def hblink_handler(_signal, _frame, _logger):
-    logger.info('*** HBLINK IS TERMINATING WITH SIGNAL %s ***', str(_signal))
-
     for system in systems:
-        this_system = systems[system]
+        _logger.info('SHUTDOWN: DE-REGISTER SYSTEM: %s', system)
-        if CONFIG['SYSTEMS'][system]['MODE'] == 'MASTER':
+        systems[system].dereg()
-            for client in CONFIG['SYSTEMS'][system]['CLIENTS']:
-                this_system.send_client(client, 'MSTCL'+client)
-                logger.info('(%s) Sending De-Registration to Client: %s (%s)', system, CONFIG['SYSTEMS'][system]['CLIENTS'][client]['CALLSIGN'], CONFIG['SYSTEMS'][system]['CLIENTS'][client]['RADIO_ID'])
-        elif CONFIG['SYSTEMS'][system]['MODE'] == 'CLIENT':
-            this_system.send_master('RPTCL'+CONFIG['SYSTEMS'][system]['RADIO_ID'])
-            logger.info('(%s) De-Registering From the Master', system)
 
-    reactor.stop()
-
-# Set signal handers so that we can gracefully exit if need be
-for sig in [signal.SIGTERM, signal.SIGINT]:
-    signal.signal(sig, handler)
-
-
-#************************************************
-#     UTILITY FUNCTIONS
-#************************************************
-
-# Create a 3 byte hex string from an integer
-def hex_str_3(_int_id):
-    try:
-        #return hex(_int_id)[2:].rjust(6,'0').decode('hex')
-        return format(_int_id,'x').rjust(6,'0').decode('hex')
-    except TypeError:
-        logger.error('hex_str_3: invalid integer length')
-
-# Create a 4 byte hex string from an integer
-def hex_str_4(_int_id):
-    try:
-        #return hex(_int_id)[2:].rjust(8,'0').decode('hex')
-        return format(_int_id,'x').rjust(8,'0').decode('hex')
-    except TypeError:
-        logger.error('hex_str_4: invalid integer length')
-
-# Convert a hex string to an int (radio ID, etc.)
-def int_id(_hex_string):
-    return int(h(_hex_string), 16)
 
 #************************************************
 #     AMBE CLASS: Used to parse out AMBE and send to gateway
@@ -217,7 +86,7 @@ class AMBE:
         _client, _seq, _srcID, _dstID, _rptID, _bits, _slot, _callType, _frameType, _voiceSeq, _streamID )
 
         #logger.debug('Frame 1:(%s)', self.ByteToHex(_data))
-        _dmr_frame = BitArray('0x'+h(_data[20:]))
+        _dmr_frame = BitArray('0x'+ahex(_data[20:]))
         _ambe = _dmr_frame[0:108] + _dmr_frame[156:264]
         #_sock.sendto(_ambe.tobytes(), ("127.0.0.1", 31000))
 
@@ -226,15 +95,17 @@ class AMBE:
         self._sock.sendto(ambeBytes[9:18], (self._exp_ip, self._exp_port))
         self._sock.sendto(ambeBytes[18:27], (self._exp_ip, self._exp_port))
 
+
 #************************************************
 #     HB MASTER CLASS
 #************************************************
 
 class HBSYSTEM(DatagramProtocol):
-    def __init__(self, _name, _config):
+    def __init__(self, _name, _config, _logger):
         # Define a few shortcuts to make the rest of the class more readable
         self._CONFIG = _config
         self._system = _name
+        self._logger = _logger
         self._config = self._CONFIG['SYSTEMS'][self._system]
         
         # Define shortcuts and generic function names based on the type of system we are
@@ -243,12 +114,14 @@ class HBSYSTEM(DatagramProtocol):
             self.send_system = self.send_clients
             self.maintenance_loop = self.master_maintenance_loop
             self.datagramReceived = self.master_datagramReceived
+            self.dereg = self.master_dereg
         
         elif self._config['MODE'] == 'CLIENT':
             self._stats = self._config['STATS']
             self.send_system = self.send_master
             self.maintenance_loop = self.client_maintenance_loop
             self.datagramReceived = self.client_datagramReceived
+            self.dereg = self.client_dereg
         
         # Configure for AMBE audio export if enabled
         if self._config['EXPORT_AMBE']:
@@ -261,55 +134,64 @@ class HBSYSTEM(DatagramProtocol):
     
     # Aliased in __init__ to maintenance_loop if system is a master
     def master_maintenance_loop(self):
-        logger.debug('(%s) Master maintenance loop started', self._system)
+        self._logger.debug('(%s) Master maintenance loop started', self._system)
         for client in self._clients:
             _this_client = self._clients[client]
             # Check to see if any of the clients have been quiet (no ping) longer than allowed
             if _this_client['LAST_PING']+self._CONFIG['GLOBAL']['PING_TIME']*self._CONFIG['GLOBAL']['MAX_MISSED'] < time():
-                logger.info('(%s) Client %s (%s) has timed out', self._system, _this_client['CALLSIGN'], _this_client['RADIO_ID'])
+                self._logger.info('(%s) Client %s (%s) has timed out', self._system, _this_client['CALLSIGN'], _this_client['RADIO_ID'])
                 # Remove any timed out clients from the configuration
                 del self._CONFIG['SYSTEMS'][self._system]['CLIENTS'][client]
     
     # Aliased in __init__ to maintenance_loop if system is a client           
     def client_maintenance_loop(self):
-        logger.debug('(%s) Client maintenance loop started', self._system)
+        self._logger.debug('(%s) Client maintenance loop started', self._system)
         # If we're not connected, zero out the stats and send a login request RPTL
         if self._stats['CONNECTION'] == 'NO' or self._stats['CONNECTION'] == 'RTPL_SENT':
             self._stats['PINGS_SENT'] = 0
             self._stats['PINGS_ACKD'] = 0
             self._stats['CONNECTION'] = 'RTPL_SENT'
             self.send_master('RPTL'+self._config['RADIO_ID'])
-            logger.info('(%s) Sending login request to master %s:%s', self._system, self._config['MASTER_IP'], self._config['MASTER_PORT'])
+            self._logger.info('(%s) Sending login request to master %s:%s', self._system, self._config['MASTER_IP'], self._config['MASTER_PORT'])
         # If we are connected, sent a ping to the master and increment the counter
         if self._stats['CONNECTION'] == 'YES':
             self.send_master('RPTPING'+self._config['RADIO_ID'])
             self._stats['PINGS_SENT'] += 1
-            logger.debug('(%s) RPTPING Sent to Master. Pings Since Connected: %s', self._system, self._stats['PINGS_SENT'])
+            self._logger.debug('(%s) RPTPING Sent to Master. Pings Since Connected: %s', self._system, self._stats['PINGS_SENT'])
 
     def send_clients(self, _packet):
         for _client in self._clients:
             self.send_client(_client, _packet)
-            #logger.debug('(%s) Packet sent to client %s', self._system, self._clients[_client]['RADIO_ID'])
+            #self._logger.debug('(%s) Packet sent to client %s', self._system, self._clients[_client]['RADIO_ID'])
 
     def send_client(self, _client, _packet):
         _ip = self._clients[_client]['IP']
         _port = self._clients[_client]['PORT']
         self.transport.write(_packet, (_ip, _port))
         # KEEP THE FOLLOWING COMMENTED OUT UNLESS YOU'RE DEBUGGING DEEPLY!!!!
-        #logger.debug('(%s) TX Packet to %s on port %s: %s', self._clients[_client]['RADIO_ID'], self._clients[_client]['IP'], self._clients[_client]['PORT'], h(_packet))
+        #self._logger.debug('(%s) TX Packet to %s on port %s: %s', self._clients[_client]['RADIO_ID'], self._clients[_client]['IP'], self._clients[_client]['PORT'], ahex(_packet))
 
     def send_master(self, _packet):
         self.transport.write(_packet, (self._config['MASTER_IP'], self._config['MASTER_PORT']))
         # KEEP THE FOLLOWING COMMENTED OUT UNLESS YOU'RE DEBUGGING DEEPLY!!!!
-        #logger.debug('(%s) TX Packet to %s:%s -- %s', self._system, self._config['MASTER_IP'], self._config['MASTER_PORT'], h(_packet))
+        #self._logger.debug('(%s) TX Packet to %s:%s -- %s', self._system, self._config['MASTER_IP'], self._config['MASTER_PORT'], ahex(_packet))
 
     def dmrd_received(self, _radio_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data):
         pass
     
+    def master_dereg(self):
+        for _client in self._clients:
+            self.send_client(_client, 'MSTCL'+_client)
+            self._logger.info('(%s) De-Registration sent to Client: %s (%s)', self._system, self._clients[_client]['CALLSIGN'], self._clients[_client][client]['RADIO_ID'])
+            
+    def client_dereg(self):
+        self.send_master('RPTCL'+self._config['RADIO_ID'])
+        self._logger.info('(%s) De-Registeration sent to Master: %s:%s', self._system, self._config['MASTER_IP'], self._config['MASTER_PORT'])
+    
     # Aliased in __init__ to datagramReceived if system is a master
     def master_datagramReceived(self, _data, (_host, _port)):
         # Keep This Line Commented Unless HEAVILY Debugging!
-        #logger.debug('(%s) RX packet from %s:%s -- %s', self._system, _host, _port, h(_data))
+        #self._logger.debug('(%s) RX packet from %s:%s -- %s', self._system, _host, _port, ahex(_data))
 
         # Extract the command, which is various length, all but one 4 significant characters -- RPTCL
         _command = _data[:4]
@@ -329,7 +211,7 @@ class HBSYSTEM(DatagramProtocol):
                 _frame_type = (_bits & 0x30) >> 4
                 _dtype_vseq = (_bits & 0xF) # data, 1=voice header, 2=voice terminator; voice, 0=burst A ... 5=burst F
                 _stream_id = _data[16:20]
-                #logger.debug('(%s) DMRD - Seqence: %s, RF Source: %s, Destination ID: %s', self._system, int_id(_seq), int_id(_rf_src), int_id(_dst_id))
+                #self._logger.debug('(%s) DMRD - Seqence: %s, RF Source: %s, Destination ID: %s', self._system, int_id(_seq), int_id(_rf_src), int_id(_dst_id))
 
                 # If AMBE audio exporting is configured...
                 if self._config['EXPORT_AMBE']:
@@ -340,7 +222,7 @@ class HBSYSTEM(DatagramProtocol):
                     for _client in self._clients:
                         if _client != _radio_id:
                             self.send_client(_client, _data)
-                            logger.debug('(%s) Packet on TS%s from %s (%s) for destination ID %s repeated to client: %s (%s) [Stream ID: %s]', self._system, _slot, self._clients[_radio_id]['CALLSIGN'], int_id(_radio_id), int_id(_dst_id), self._clients[_client]['CALLSIGN'], int_id(_client), int_id(_stream_id))
+                            self._logger.debug('(%s) Packet on TS%s from %s (%s) for destination ID %s repeated to client: %s (%s) [Stream ID: %s]', self._system, _slot, self._clients[_radio_id]['CALLSIGN'], int_id(_radio_id), int_id(_dst_id), self._clients[_client]['CALLSIGN'], int_id(_client), int_id(_stream_id))
 
                 # Userland actions -- typically this is the function you subclass for an application
                 self.dmrd_received(_radio_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data)
@@ -355,7 +237,7 @@ class HBSYSTEM(DatagramProtocol):
                     'IP': _host,
                     'PORT': _port,
                     'SALT': randint(0,0xFFFFFFFF),
-                    'RADIO_ID': str(int(h(_radio_id), 16)),
+                    'RADIO_ID': str(int(ahex(_radio_id), 16)),
                     'CALLSIGN': '',
                     'RX_FREQ': '',
                     'TX_FREQ': '',
@@ -371,14 +253,14 @@ class HBSYSTEM(DatagramProtocol):
                     'SOFTWARE_ID': '',
                     'PACKAGE_ID': '',
                 }})
-                logger.info('(%s) Repeater Logging in with Radio ID: %s, %s:%s', self._system, int_id(_radio_id), _host, _port)
+                self._logger.info('(%s) Repeater Logging in with Radio ID: %s, %s:%s', self._system, int_id(_radio_id), _host, _port)
                 _salt_str = hex_str_4(self._clients[_radio_id]['SALT'])
                 self.send_client(_radio_id, 'RPTACK'+_salt_str)
                 self._clients[_radio_id]['CONNECTION'] = 'CHALLENGE_SENT'
-                logger.info('(%s) Sent Challenge Response to %s for login: %s', self._system, int_id(_radio_id), self._clients[_radio_id]['SALT'])
+                self._logger.info('(%s) Sent Challenge Response to %s for login: %s', self._system, int_id(_radio_id), self._clients[_radio_id]['SALT'])
             else:
                 self.transport.write('MSTNAK'+_radio_id, (_host, _port))
-                logger.warning('(%s) Invalid Login from Radio ID: %s', self._system, int_id(_radio_id))
+                self._logger.warning('(%s) Invalid Login from Radio ID: %s', self._system, int_id(_radio_id))
 
         elif _command == 'RPTK':    # Repeater has answered our login challenge
             _radio_id = _data[4:8]
@@ -394,14 +276,14 @@ class HBSYSTEM(DatagramProtocol):
                 if _sent_hash == _calc_hash:
                     _this_client['CONNECTION'] = 'WAITING_CONFIG'
                     self.send_client(_radio_id, 'RPTACK'+_radio_id)
-                    logger.info('(%s) Client %s has completed the login exchange successfully', self._system, _this_client['RADIO_ID'])
+                    self._logger.info('(%s) Client %s has completed the login exchange successfully', self._system, _this_client['RADIO_ID'])
                 else:
-                    logger.info('(%s) Client %s has FAILED the login exchange successfully', self._system, _this_client['RADIO_ID'])
+                    self._logger.info('(%s) Client %s has FAILED the login exchange successfully', self._system, _this_client['RADIO_ID'])
                     self.transport.write('MSTNAK'+_radio_id, (_host, _port))
                     del self._clients[_radio_id]
             else:
                 self.transport.write('MSTNAK'+_radio_id, (_host, _port))
-                logger.warning('(%s) Login challenge from Radio ID that has not logged in: %s', self._system, int_id(_radio_id))
+                self._logger.warning('(%s) Login challenge from Radio ID that has not logged in: %s', self._system, int_id(_radio_id))
 
         elif _command == 'RPTC':    # Repeater is sending it's configuraiton OR disconnecting
             if _data[:5] == 'RPTCL':    # Disconnect command
@@ -410,7 +292,7 @@ class HBSYSTEM(DatagramProtocol):
                             and self._clients[_radio_id]['CONNECTION'] == 'YES' \
                             and self._clients[_radio_id]['IP'] == _host \
                             and self._clients[_radio_id]['PORT'] == _port:
-                    logger.info('(%s) Client is closing down: %s (%s)', self._system, self._clients[_radio_id]['CALLSIGN'], int_id(_radio_id))
+                    self._logger.info('(%s) Client is closing down: %s (%s)', self._system, self._clients[_radio_id]['CALLSIGN'], int_id(_radio_id))
                     self.transport.write('MSTNAK'+_radio_id, (_host, _port))
                     del self._clients[_radio_id]
 
@@ -439,10 +321,10 @@ class HBSYSTEM(DatagramProtocol):
                     _this_client['PACKAGE_ID'] = _data[262:302]
 
                     self.send_client(_radio_id, 'RPTACK'+_radio_id)
-                    logger.info('(%s) Client %s (%s) has sent repeater configuration', self._system, _this_client['CALLSIGN'], _this_client['RADIO_ID'])
+                    self._logger.info('(%s) Client %s (%s) has sent repeater configuration', self._system, _this_client['CALLSIGN'], _this_client['RADIO_ID'])
                 else:
                     self.transport.write('MSTNAK'+_radio_id, (_host, _port))
-                    logger.warning('(%s) Client info from Radio ID that has not logged in: %s', self._system, int_id(_radio_id))
+                    self._logger.warning('(%s) Client info from Radio ID that has not logged in: %s', self._system, int_id(_radio_id))
 
         elif _command == 'RPTP':    # RPTPing -- client is pinging us
                 _radio_id = _data[7:11]
@@ -452,18 +334,18 @@ class HBSYSTEM(DatagramProtocol):
                             and self._clients[_radio_id]['PORT'] == _port:
                     self._clients[_radio_id]['LAST_PING'] = time()
                     self.send_client(_radio_id, 'MSTPONG'+_radio_id)
-                    logger.debug('(%s) Received and answered RPTPING from client %s (%s)', self._system, self._clients[_radio_id]['CALLSIGN'], int_id(_radio_id))
+                    self._logger.debug('(%s) Received and answered RPTPING from client %s (%s)', self._system, self._clients[_radio_id]['CALLSIGN'], int_id(_radio_id))
                 else:
                     self.transport.write('MSTNAK'+_radio_id, (_host, _port))
-                    logger.warning('(%s) Client info from Radio ID that has not logged in: %s', self._system, int_id(_radio_id))
+                    self._logger.warning('(%s) Client info from Radio ID that has not logged in: %s', self._system, int_id(_radio_id))
 
         else:
-            logger.error('(%s) Unrecognized command from: %s. Packet: %s', self._system, int_id(_radio_id), h(_data))
+            self._logger.error('(%s) Unrecognized command from: %s. Packet: %s', self._system, int_id(_radio_id), ahex(_data))
         
     # Aliased in __init__ to datagramReceived if system is a client
     def client_datagramReceived(self, _data, (_host, _port)):
         # Keep This Line Commented Unless HEAVILY Debugging!
-        # logger.debug('(%s) RX packet from %s:%s -- %s', self._system, _host, _port, h(_data))
+        # self._logger.debug('(%s) RX packet from %s:%s -- %s', self._system, _host, _port, ahex(_data))
 
         # Validate that we receveived this packet from the master - security check!
         if self._config['MASTER_IP'] == _host and self._config['MASTER_PORT'] == _port:
@@ -481,7 +363,7 @@ class HBSYSTEM(DatagramProtocol):
                     _frame_type = (_bits & 0x30) >> 4
                     _dtype_vseq = (_bits & 0xF) # data, 1=voice header, 2=voice terminator; voice, 0=burst A ... 5=burst F
                     _stream_id = _data[16:20]
-                    #logger.debug('(%s) DMRD - Seqence: %s, RF Source: %s, Destination ID: %s', self._system, int_id(_seq), int_id(_rf_src), int_id(_dst_id))
+                    #self._logger.debug('(%s) DMRD - Seqence: %s, RF Source: %s, Destination ID: %s', self._system, int_id(_seq), int_id(_rf_src), int_id(_dst_id))
 
                     # If AMBE audio exporting is configured...
                     if self._config['EXPORT_AMBE']:
@@ -493,22 +375,22 @@ class HBSYSTEM(DatagramProtocol):
             elif _command == 'MSTN':    # Actually MSTNAK -- a NACK from the master
                 _radio_id = _data[4:8]
                 if _radio_id == self._config['RADIO_ID']: # Validate the source and intended target
-                    logger.warning('(%s) MSTNAK Received', self._system)
+                    self._logger.warning('(%s) MSTNAK Received', self._system)
                     self._stats['CONNECTION'] = 'NO' # Disconnect ourselves and re-register
 
             elif _command == 'RPTA':    # Actually RPTACK -- an ACK from the master
                 # Depending on the state, an RPTACK means different things, in each clause, we check and/or set the state
                 if self._stats['CONNECTION'] == 'RTPL_SENT': # If we've sent a login request...
                     _login_int32 = _data[6:10]
-                    logger.info('(%s) Repeater Login ACK Received with 32bit ID: %s', self._system, int_id(_login_int32))
+                    self._logger.info('(%s) Repeater Login ACK Received with 32bit ID: %s', self._system, int_id(_login_int32))
                     _pass_hash = sha256(_login_int32+self._config['PASSPHRASE']).hexdigest()
-                    _pass_hash = a(_pass_hash)
+                    _pass_hash = bhex(_pass_hash)
                     self.send_master('RPTK'+self._config['RADIO_ID']+_pass_hash)
                     self._stats['CONNECTION'] = 'AUTHENTICATED'
 
                 elif self._stats['CONNECTION'] == 'AUTHENTICATED': # If we've sent the login challenge...
                     if _data[6:10] == self._config['RADIO_ID']:
-                        logger.info('(%s) Repeater Authentication Accepted', self._system)
+                        self._logger.info('(%s) Repeater Authentication Accepted', self._system)
                         _config_packet =  self._config['RADIO_ID']+\
                                           self._config['CALLSIGN']+\
                                           self._config['RX_FREQ']+\
@@ -527,32 +409,32 @@ class HBSYSTEM(DatagramProtocol):
 
                         self.send_master('RPTC'+_config_packet)
                         self._stats['CONNECTION'] = 'CONFIG-SENT'
-                        logger.info('(%s) Repeater Configuration Sent', self._system)
+                        self._logger.info('(%s) Repeater Configuration Sent', self._system)
                     else:
                         self._stats['CONNECTION'] = 'NO'
-                        logger.error('(%s) Master ACK Contained wrong ID - Connection Reset', self._system)
+                        self._logger.error('(%s) Master ACK Contained wrong ID - Connection Reset', self._system)
 
                 elif self._stats['CONNECTION'] == 'CONFIG-SENT': # If we've sent out configuration to the master
                     if _data[6:10] == self._config['RADIO_ID']:
-                        logger.info('(%s) Repeater Configuration Accepted', self._system)
+                        self._logger.info('(%s) Repeater Configuration Accepted', self._system)
                         self._stats['CONNECTION'] = 'YES'
-                        logger.info('(%s) Connection to Master Completed', self._system)
+                        self._logger.info('(%s) Connection to Master Completed', self._system)
                     else:
                         self._stats['CONNECTION'] = 'NO'
-                        logger.error('(%s) Master ACK Contained wrong ID - Connection Reset', self._system)
+                        self._logger.error('(%s) Master ACK Contained wrong ID - Connection Reset', self._system)
 
             elif _command == 'MSTP':    # Actually MSTPONG -- a reply to RPTPING (send by client)
                 if _data [7:11] == self._config['RADIO_ID']:
                     self._stats['PINGS_ACKD'] += 1
-                    logger.debug('(%s) MSTPONG Received. Pongs Since Connected: %s', self._system, self._stats['PINGS_ACKD'])
+                    self._logger.debug('(%s) MSTPONG Received. Pongs Since Connected: %s', self._system, self._stats['PINGS_ACKD'])
 
             elif _command == 'MSTC':    # Actually MSTCL -- notify us the master is closing down
                 if _data[5:9] == self._config['RADIO_ID']:
                     self._stats['CONNECTION'] = 'NO'
-                    logger.info('(%s) MSTCL Recieved', self._system)
+                    self._logger.info('(%s) MSTCL Recieved', self._system)
 
             else:
-                logger.error('(%s) Received an invalid command in packet: %s', self._system, h(_data))
+                self._logger.error('(%s) Received an invalid command in packet: %s', self._system, ahex(_data))
 
 
 #************************************************
@@ -560,12 +442,74 @@ class HBSYSTEM(DatagramProtocol):
 #************************************************
 
 if __name__ == '__main__':
-    logger.info('HBlink \'HBlink.py\' (c) 2016 N0MJS & the K0USY Group - SYSTEM STARTING...')
+    # Python modules we need
+    import argparse
+    import sys
+    import os
+    import signal
+    
+    
+    #
+    # Parse the command line and make adjustments
+    #
+    
+    # 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 execution directory
+    if not cli_args.CONFIG_FILE:
+        cli_args.CONFIG_FILE = os.path.dirname(os.path.abspath(__file__))+'/hblink.cfg'
+
+
+    #
+    # Build the configuration file
+    #
+
+    # Call the external routine to build the configuration dictionary
+    CONFIG = hb_config.build_config(cli_args.CONFIG_FILE)
+
+
+    #
+    # Start the system logger
+    #
+    
+    # Call the external routing to start the system logger
+    if cli_args.LOG_LEVEL:
+        CONFIG['LOGGER']['LOG_LEVEL'] = cli_args.LOG_LEVEL
+    logger = hb_log.config_logging(CONFIG['LOGGER'])
+    logger.debug('Logging system started, anything from here on gets logged')
+
+    
+    #
+    # Set up the signal handler
+    #
+    
+    def sig_handler(_signal, _frame):
+        logger.info('SHUTDOWN: HBLINK IS TERMINATING WITH SIGNAL %s', str(_signal))
+        hblink_handler(_signal, _frame, logger)
+        logger.info('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.SIGTERM, signal.SIGINT]:
+        signal.signal(sig, sig_handler)
+
+
+    #
+    # START HB_ROUTER
+    #
 
     # HBlink instance creation
+    logger.info('HBlink \'HBlink.py\' (c) 2016 N0MJS & the K0USY Group - SYSTEM STARTING...')
     for system in CONFIG['SYSTEMS']:
         if CONFIG['SYSTEMS'][system]['ENABLED']:
-            systems[system] = HBSYSTEM(system, CONFIG)
+            systems[system] = HBSYSTEM(system, CONFIG, logger)
             reactor.listenUDP(CONFIG['SYSTEMS'][system]['PORT'], systems[system], interface=CONFIG['SYSTEMS'][system]['IP'])
             logger.debug('%s instance created: %s, %s', CONFIG['SYSTEMS'][system]['MODE'], system, systems[system])