mirror of
https://github.com/KevinMidboe/mktxp-no-cli.git
synced 2026-01-10 19:35:34 +00:00
DS refactor, fixes/optimizations
This commit is contained in:
Arseniy Kuznetsov
@@ -12,9 +12,10 @@
|
||||
|
||||
|
||||
[MKTXP]
|
||||
port = 49090
|
||||
socket_timeout = 2
|
||||
initial_delay_on_failure = 120
|
||||
max_delay_on_failure = 900
|
||||
delay_inc_div = 5
|
||||
bandwidth_test_interval = 420
|
||||
port = 49090 # default metrics HTTP server port
|
||||
bandwidth_test_interval = 420 # Interval between periodic bandwidth tests
|
||||
|
||||
socket_timeout = 2 # Socket connection timeout
|
||||
initial_delay_on_failure = 120 # Delay untill next connection attempt to a RouterOS Device
|
||||
max_delay_on_failure = 900 # Max delay untill next connection attempt to a RouterOS Device
|
||||
delay_inc_div = 5 # Delay increment factor
|
||||
|
||||
@@ -23,263 +23,263 @@ from mktxp.utils.utils import FSHelper
|
||||
'''
|
||||
|
||||
class MKTXPConfigKeys:
|
||||
''' MKTXP config file keys
|
||||
'''
|
||||
# Section Keys
|
||||
ENABLED_KEY = 'enabled'
|
||||
HOST_KEY = 'hostname'
|
||||
PORT_KEY = 'port'
|
||||
USER_KEY = 'username'
|
||||
PASSWD_KEY = 'password'
|
||||
''' MKTXP config file keys
|
||||
'''
|
||||
# Section Keys
|
||||
ENABLED_KEY = 'enabled'
|
||||
HOST_KEY = 'hostname'
|
||||
PORT_KEY = 'port'
|
||||
USER_KEY = 'username'
|
||||
PASSWD_KEY = 'password'
|
||||
|
||||
SSL_KEY = 'use_ssl'
|
||||
NO_SSL_CERTIFICATE = 'no_ssl_certificate'
|
||||
SSL_CERTIFICATE_VERIFY = 'ssl_certificate_verify'
|
||||
SSL_KEY = 'use_ssl'
|
||||
NO_SSL_CERTIFICATE = 'no_ssl_certificate'
|
||||
SSL_CERTIFICATE_VERIFY = 'ssl_certificate_verify'
|
||||
|
||||
FE_DHCP_KEY = 'dhcp'
|
||||
FE_DHCP_LEASE_KEY = 'dhcp_lease'
|
||||
FE_DHCP_POOL_KEY = 'pool'
|
||||
FE_INTERFACE_KEY = 'interface'
|
||||
FE_FIREWALL_KEY = 'firewall'
|
||||
FE_MONITOR_KEY = 'monitor'
|
||||
FE_ROUTE_KEY = 'route'
|
||||
FE_WIRELESS_KEY = 'wireless'
|
||||
FE_WIRELESS_CLIENTS_KEY = 'wireless_clients'
|
||||
FE_CAPSMAN_KEY = 'capsman'
|
||||
FE_CAPSMAN_CLIENTS_KEY = 'capsman_clients'
|
||||
FE_DHCP_KEY = 'dhcp'
|
||||
FE_DHCP_LEASE_KEY = 'dhcp_lease'
|
||||
FE_DHCP_POOL_KEY = 'pool'
|
||||
FE_INTERFACE_KEY = 'interface'
|
||||
FE_FIREWALL_KEY = 'firewall'
|
||||
FE_MONITOR_KEY = 'monitor'
|
||||
FE_ROUTE_KEY = 'route'
|
||||
FE_WIRELESS_KEY = 'wireless'
|
||||
FE_WIRELESS_CLIENTS_KEY = 'wireless_clients'
|
||||
FE_CAPSMAN_KEY = 'capsman'
|
||||
FE_CAPSMAN_CLIENTS_KEY = 'capsman_clients'
|
||||
|
||||
MKTXP_SOCKET_TIMEOUT = 'socket_timeout'
|
||||
MKTXP_SOCKET_TIMEOUT = 'socket_timeout'
|
||||
MKTXP_INITIAL_DELAY = 'initial_delay_on_failure'
|
||||
MKTXP_MAX_DELAY = 'max_delay_on_failure'
|
||||
MKTXP_INC_DIV = 'delay_inc_div'
|
||||
MKTXP_BANDWIDTH_TEST_INTERVAL = 'bandwidth_test_interval'
|
||||
MKTXP_SOCKET_TIMEOUT = 'socket_timeout'
|
||||
MKTXP_SOCKET_TIMEOUT = 'socket_timeout'
|
||||
MKTXP_INITIAL_DELAY = 'initial_delay_on_failure'
|
||||
MKTXP_MAX_DELAY = 'max_delay_on_failure'
|
||||
MKTXP_INC_DIV = 'delay_inc_div'
|
||||
MKTXP_BANDWIDTH_TEST_INTERVAL = 'bandwidth_test_interval'
|
||||
|
||||
# UnRegistered entries placeholder
|
||||
NO_ENTRIES_REGISTERED = 'NoEntriesRegistered'
|
||||
# UnRegistered entries placeholder
|
||||
NO_ENTRIES_REGISTERED = 'NoEntriesRegistered'
|
||||
|
||||
MKTXP_USE_COMMENTS_OVER_NAMES = 'use_comments_over_names'
|
||||
MKTXP_USE_COMMENTS_OVER_NAMES = 'use_comments_over_names'
|
||||
|
||||
|
||||
# Base router id labels
|
||||
ROUTERBOARD_NAME = 'routerboard_name'
|
||||
ROUTERBOARD_ADDRESS = 'routerboard_address'
|
||||
# Base router id labels
|
||||
ROUTERBOARD_NAME = 'routerboard_name'
|
||||
ROUTERBOARD_ADDRESS = 'routerboard_address'
|
||||
|
||||
# Default values
|
||||
DEFAULT_API_PORT = 8728
|
||||
DEFAULT_API_SSL_PORT = 8729
|
||||
DEFAULT_MKTXP_PORT = 49090
|
||||
DEFAULT_MKTXP_SOCKET_TIMEOUT = 2
|
||||
DEFAULT_MKTXP_INITIAL_DELAY = 120
|
||||
DEFAULT_MKTXP_MAX_DELAY = 900
|
||||
DEFAULT_MKTXP_INC_DIV = 5
|
||||
DEFAULT_MKTXP_BANDWIDTH_TEST_INTERVAL = 420
|
||||
# Default values
|
||||
DEFAULT_API_PORT = 8728
|
||||
DEFAULT_API_SSL_PORT = 8729
|
||||
DEFAULT_MKTXP_PORT = 49090
|
||||
DEFAULT_MKTXP_SOCKET_TIMEOUT = 2
|
||||
DEFAULT_MKTXP_INITIAL_DELAY = 120
|
||||
DEFAULT_MKTXP_MAX_DELAY = 900
|
||||
DEFAULT_MKTXP_INC_DIV = 5
|
||||
DEFAULT_MKTXP_BANDWIDTH_TEST_INTERVAL = 420
|
||||
|
||||
BOOLEAN_KEYS = (ENABLED_KEY, SSL_KEY, NO_SSL_CERTIFICATE, SSL_CERTIFICATE_VERIFY,
|
||||
FE_DHCP_KEY, FE_DHCP_LEASE_KEY, FE_DHCP_POOL_KEY, FE_INTERFACE_KEY, FE_FIREWALL_KEY,
|
||||
FE_MONITOR_KEY, FE_ROUTE_KEY, MKTXP_USE_COMMENTS_OVER_NAMES,
|
||||
FE_WIRELESS_KEY, FE_WIRELESS_CLIENTS_KEY, FE_CAPSMAN_KEY, FE_CAPSMAN_CLIENTS_KEY)
|
||||
|
||||
STR_KEYS = (HOST_KEY, USER_KEY, PASSWD_KEY)
|
||||
MKTXP_INT_KEYS = (PORT_KEY, MKTXP_SOCKET_TIMEOUT, MKTXP_INITIAL_DELAY, MKTXP_MAX_DELAY, MKTXP_INC_DIV, MKTXP_BANDWIDTH_TEST_INTERVAL)
|
||||
BOOLEAN_KEYS = (ENABLED_KEY, SSL_KEY, NO_SSL_CERTIFICATE, SSL_CERTIFICATE_VERIFY,
|
||||
FE_DHCP_KEY, FE_DHCP_LEASE_KEY, FE_DHCP_POOL_KEY, FE_INTERFACE_KEY, FE_FIREWALL_KEY,
|
||||
FE_MONITOR_KEY, FE_ROUTE_KEY, MKTXP_USE_COMMENTS_OVER_NAMES,
|
||||
FE_WIRELESS_KEY, FE_WIRELESS_CLIENTS_KEY, FE_CAPSMAN_KEY, FE_CAPSMAN_CLIENTS_KEY)
|
||||
|
||||
STR_KEYS = (HOST_KEY, USER_KEY, PASSWD_KEY)
|
||||
MKTXP_INT_KEYS = (PORT_KEY, MKTXP_SOCKET_TIMEOUT, MKTXP_INITIAL_DELAY, MKTXP_MAX_DELAY, MKTXP_INC_DIV, MKTXP_BANDWIDTH_TEST_INTERVAL)
|
||||
|
||||
# MKTXP config entry nane
|
||||
MKTXP_CONFIG_ENTRY_NAME = 'MKTXP'
|
||||
# MKTXP config entry nane
|
||||
MKTXP_CONFIG_ENTRY_NAME = 'MKTXP'
|
||||
|
||||
|
||||
class ConfigEntry:
|
||||
MKTXPEntry = namedtuple('MKTXPEntry', [MKTXPConfigKeys.ENABLED_KEY, MKTXPConfigKeys.HOST_KEY, MKTXPConfigKeys.PORT_KEY,
|
||||
MKTXPConfigKeys.USER_KEY, MKTXPConfigKeys.PASSWD_KEY,
|
||||
MKTXPConfigKeys.SSL_KEY, MKTXPConfigKeys.NO_SSL_CERTIFICATE, MKTXPConfigKeys.SSL_CERTIFICATE_VERIFY,
|
||||
|
||||
MKTXPConfigKeys.FE_DHCP_KEY, MKTXPConfigKeys.FE_DHCP_LEASE_KEY, MKTXPConfigKeys.FE_DHCP_POOL_KEY, MKTXPConfigKeys.FE_INTERFACE_KEY, MKTXPConfigKeys.FE_FIREWALL_KEY,
|
||||
MKTXPConfigKeys.FE_MONITOR_KEY, MKTXPConfigKeys.FE_ROUTE_KEY, MKTXPConfigKeys.FE_WIRELESS_KEY, MKTXPConfigKeys.FE_WIRELESS_CLIENTS_KEY,
|
||||
MKTXPConfigKeys.FE_CAPSMAN_KEY, MKTXPConfigKeys.FE_CAPSMAN_CLIENTS_KEY, MKTXPConfigKeys.MKTXP_USE_COMMENTS_OVER_NAMES
|
||||
])
|
||||
_MKTXPEntry = namedtuple('_MKTXPEntry', [MKTXPConfigKeys.PORT_KEY, MKTXPConfigKeys.MKTXP_SOCKET_TIMEOUT,
|
||||
MKTXPConfigKeys.MKTXP_INITIAL_DELAY, MKTXPConfigKeys.MKTXP_MAX_DELAY,
|
||||
MKTXPConfigKeys.MKTXP_INC_DIV, MKTXPConfigKeys.MKTXP_BANDWIDTH_TEST_INTERVAL])
|
||||
MKTXPEntry = namedtuple('MKTXPEntry', [MKTXPConfigKeys.ENABLED_KEY, MKTXPConfigKeys.HOST_KEY, MKTXPConfigKeys.PORT_KEY,
|
||||
MKTXPConfigKeys.USER_KEY, MKTXPConfigKeys.PASSWD_KEY,
|
||||
MKTXPConfigKeys.SSL_KEY, MKTXPConfigKeys.NO_SSL_CERTIFICATE, MKTXPConfigKeys.SSL_CERTIFICATE_VERIFY,
|
||||
|
||||
MKTXPConfigKeys.FE_DHCP_KEY, MKTXPConfigKeys.FE_DHCP_LEASE_KEY, MKTXPConfigKeys.FE_DHCP_POOL_KEY, MKTXPConfigKeys.FE_INTERFACE_KEY, MKTXPConfigKeys.FE_FIREWALL_KEY,
|
||||
MKTXPConfigKeys.FE_MONITOR_KEY, MKTXPConfigKeys.FE_ROUTE_KEY, MKTXPConfigKeys.FE_WIRELESS_KEY, MKTXPConfigKeys.FE_WIRELESS_CLIENTS_KEY,
|
||||
MKTXPConfigKeys.FE_CAPSMAN_KEY, MKTXPConfigKeys.FE_CAPSMAN_CLIENTS_KEY, MKTXPConfigKeys.MKTXP_USE_COMMENTS_OVER_NAMES
|
||||
])
|
||||
_MKTXPEntry = namedtuple('_MKTXPEntry', [MKTXPConfigKeys.PORT_KEY, MKTXPConfigKeys.MKTXP_SOCKET_TIMEOUT,
|
||||
MKTXPConfigKeys.MKTXP_INITIAL_DELAY, MKTXPConfigKeys.MKTXP_MAX_DELAY,
|
||||
MKTXPConfigKeys.MKTXP_INC_DIV, MKTXPConfigKeys.MKTXP_BANDWIDTH_TEST_INTERVAL])
|
||||
|
||||
|
||||
class OSConfig(metaclass = ABCMeta):
|
||||
''' OS-related config
|
||||
'''
|
||||
@staticmethod
|
||||
def os_config(quiet = False):
|
||||
''' Factory method
|
||||
'''
|
||||
if sys.platform == 'linux':
|
||||
return LinuxConfig()
|
||||
elif sys.platform == 'darwin':
|
||||
return OSXConfig()
|
||||
else:
|
||||
if not quiet:
|
||||
print(f'Non-supported platform: {sys.platform}')
|
||||
return None
|
||||
''' OS-related config
|
||||
'''
|
||||
@staticmethod
|
||||
def os_config(quiet = False):
|
||||
''' Factory method
|
||||
'''
|
||||
if sys.platform == 'linux':
|
||||
return LinuxConfig()
|
||||
elif sys.platform == 'darwin':
|
||||
return OSXConfig()
|
||||
else:
|
||||
if not quiet:
|
||||
print(f'Non-supported platform: {sys.platform}')
|
||||
return None
|
||||
|
||||
@property
|
||||
@abstractmethod
|
||||
def mktxp_user_dir_path(self):
|
||||
pass
|
||||
@property
|
||||
@abstractmethod
|
||||
def mktxp_user_dir_path(self):
|
||||
pass
|
||||
|
||||
|
||||
class OSXConfig(OSConfig):
|
||||
''' OSX-related config
|
||||
'''
|
||||
@property
|
||||
def mktxp_user_dir_path(self):
|
||||
return FSHelper.full_path('~/mktxp')
|
||||
''' OSX-related config
|
||||
'''
|
||||
@property
|
||||
def mktxp_user_dir_path(self):
|
||||
return FSHelper.full_path('~/mktxp')
|
||||
|
||||
|
||||
class LinuxConfig(OSConfig):
|
||||
''' Linux-related config
|
||||
'''
|
||||
@property
|
||||
def mktxp_user_dir_path(self):
|
||||
return FSHelper.full_path('~/mktxp')
|
||||
#return FSHelper.full_path('/etc/mktxp')
|
||||
''' Linux-related config
|
||||
'''
|
||||
@property
|
||||
def mktxp_user_dir_path(self):
|
||||
return FSHelper.full_path('~/mktxp')
|
||||
#return FSHelper.full_path('/etc/mktxp')
|
||||
|
||||
|
||||
class MKTXPConfigHandler:
|
||||
def __init__(self):
|
||||
self.os_config = OSConfig.os_config()
|
||||
if not self.os_config:
|
||||
sys.exit(1)
|
||||
def __init__(self):
|
||||
self.os_config = OSConfig.os_config()
|
||||
if not self.os_config:
|
||||
sys.exit(1)
|
||||
|
||||
# mktxp user config folder
|
||||
if not os.path.exists(self.os_config.mktxp_user_dir_path):
|
||||
os.makedirs(self.os_config.mktxp_user_dir_path)
|
||||
# mktxp user config folder
|
||||
if not os.path.exists(self.os_config.mktxp_user_dir_path):
|
||||
os.makedirs(self.os_config.mktxp_user_dir_path)
|
||||
|
||||
# if needed, stage the user config data
|
||||
self.usr_conf_data_path = os.path.join(self.os_config.mktxp_user_dir_path, 'mktxp.conf')
|
||||
self.mktxp_conf_path = os.path.join(self.os_config.mktxp_user_dir_path, '_mktxp.conf')
|
||||
# if needed, stage the user config data
|
||||
self.usr_conf_data_path = os.path.join(self.os_config.mktxp_user_dir_path, 'mktxp.conf')
|
||||
self.mktxp_conf_path = os.path.join(self.os_config.mktxp_user_dir_path, '_mktxp.conf')
|
||||
|
||||
self._create_os_path(self.usr_conf_data_path, 'mktxp/cli/config/mktxp.conf')
|
||||
self._create_os_path(self.mktxp_conf_path, 'mktxp/cli/config/_mktxp.conf')
|
||||
self._create_os_path(self.usr_conf_data_path, 'mktxp/cli/config/mktxp.conf')
|
||||
self._create_os_path(self.mktxp_conf_path, 'mktxp/cli/config/_mktxp.conf')
|
||||
|
||||
self.re_compiled = {}
|
||||
self.re_compiled = {}
|
||||
|
||||
self._read_from_disk()
|
||||
|
||||
self._read_from_disk()
|
||||
def _read_from_disk(self):
|
||||
''' (Force-)Read conf data from disk
|
||||
'''
|
||||
self.config = ConfigObj(self.usr_conf_data_path)
|
||||
self._config = ConfigObj(self.mktxp_conf_path)
|
||||
|
||||
def _read_from_disk(self):
|
||||
''' (Force-)Read conf data from disk
|
||||
'''
|
||||
self.config = ConfigObj(self.usr_conf_data_path)
|
||||
self._config = ConfigObj(self.mktxp_conf_path)
|
||||
|
||||
def _create_os_path(self, os_path, resource_path):
|
||||
if not os.path.exists(os_path):
|
||||
# stage from the conf templates
|
||||
lookup_path = resource_filename(Requirement.parse("mktxp"), resource_path)
|
||||
shutil.copy(lookup_path, os_path)
|
||||
def _create_os_path(self, os_path, resource_path):
|
||||
if not os.path.exists(os_path):
|
||||
# stage from the conf templates
|
||||
lookup_path = resource_filename(Requirement.parse("mktxp"), resource_path)
|
||||
shutil.copy(lookup_path, os_path)
|
||||
|
||||
|
||||
# MKTXP entries
|
||||
##############
|
||||
def register_entry(self, entry_name, entry_args, quiet = False):
|
||||
''' Registers MKTXP conf entry
|
||||
'''
|
||||
if entry_name in self.registered_entries():
|
||||
if not quiet:
|
||||
print('"{0}": entry name already registered'.format(entry_name))
|
||||
return False
|
||||
else:
|
||||
self.config[entry_name] = entry_args
|
||||
self.config.write()
|
||||
if not quiet:
|
||||
print('Entry registered: {0}'.format(entry_name))
|
||||
return True
|
||||
# MKTXP entries
|
||||
##############
|
||||
def register_entry(self, entry_name, entry_args, quiet = False):
|
||||
''' Registers MKTXP conf entry
|
||||
'''
|
||||
if entry_name in self.registered_entries():
|
||||
if not quiet:
|
||||
print('"{0}": entry name already registered'.format(entry_name))
|
||||
return False
|
||||
else:
|
||||
self.config[entry_name] = entry_args
|
||||
self.config.write()
|
||||
if not quiet:
|
||||
print('Entry registered: {0}'.format(entry_name))
|
||||
return True
|
||||
|
||||
def unregister_entry(self, entry_name, quiet = False):
|
||||
''' Un-registers MKTXP conf entry
|
||||
'''
|
||||
if self.config[entry_name]:
|
||||
del(self.config[entry_name])
|
||||
self.config.write()
|
||||
if not quiet:
|
||||
print('Unregistered entry: {}'.format(entry_name))
|
||||
return True
|
||||
else:
|
||||
if not quiet:
|
||||
print('Entry is not registered: {}'.format(entry_name))
|
||||
return False
|
||||
def unregister_entry(self, entry_name, quiet = False):
|
||||
''' Un-registers MKTXP conf entry
|
||||
'''
|
||||
if self.config[entry_name]:
|
||||
del(self.config[entry_name])
|
||||
self.config.write()
|
||||
if not quiet:
|
||||
print('Unregistered entry: {}'.format(entry_name))
|
||||
return True
|
||||
else:
|
||||
if not quiet:
|
||||
print('Entry is not registered: {}'.format(entry_name))
|
||||
return False
|
||||
|
||||
def registered_entries(self):
|
||||
''' All MKTXP registered entries
|
||||
'''
|
||||
registered_entries = [entry_name for entry_name in self.config.keys()]
|
||||
if not registered_entries:
|
||||
registered_entries = [MKTXPConfigKeys.NO_ENTRIES_REGISTERED]
|
||||
def registered_entries(self):
|
||||
''' All MKTXP registered entries
|
||||
'''
|
||||
registered_entries = [entry_name for entry_name in self.config.keys()]
|
||||
if not registered_entries:
|
||||
registered_entries = [MKTXPConfigKeys.NO_ENTRIES_REGISTERED]
|
||||
|
||||
return registered_entries
|
||||
return registered_entries
|
||||
|
||||
def entry(self, entry_name):
|
||||
''' Given an entry name, reads and returns the entry info
|
||||
'''
|
||||
entry_reader = self.entry_reader(entry_name)
|
||||
return ConfigEntry.MKTXPEntry(**entry_reader)
|
||||
def entry(self, entry_name):
|
||||
''' Given an entry name, reads and returns the entry info
|
||||
'''
|
||||
entry_reader = self.entry_reader(entry_name)
|
||||
return ConfigEntry.MKTXPEntry(**entry_reader)
|
||||
|
||||
def _entry(self):
|
||||
''' MKTXP internal config entry
|
||||
'''
|
||||
_entry_reader = self._entry_reader()
|
||||
return ConfigEntry._MKTXPEntry(**_entry_reader)
|
||||
def _entry(self):
|
||||
''' MKTXP internal config entry
|
||||
'''
|
||||
_entry_reader = self._entry_reader()
|
||||
return ConfigEntry._MKTXPEntry(**_entry_reader)
|
||||
|
||||
|
||||
# Helpers
|
||||
def entry_reader(self, entry_name):
|
||||
entry_reader = {}
|
||||
write_needed = False
|
||||
for key in MKTXPConfigKeys.BOOLEAN_KEYS:
|
||||
if self.config[entry_name].get(key):
|
||||
entry_reader[key] = self.config[entry_name].as_bool(key)
|
||||
else:
|
||||
entry_reader[key] = False
|
||||
write_needed = True # read from disk next time
|
||||
# Helpers
|
||||
def entry_reader(self, entry_name):
|
||||
entry_reader = {}
|
||||
write_needed = False
|
||||
for key in MKTXPConfigKeys.BOOLEAN_KEYS:
|
||||
if self.config[entry_name].get(key):
|
||||
entry_reader[key] = self.config[entry_name].as_bool(key)
|
||||
else:
|
||||
entry_reader[key] = False
|
||||
write_needed = True # read from disk next time
|
||||
|
||||
for key in MKTXPConfigKeys.STR_KEYS:
|
||||
entry_reader[key] = self.config[entry_name][key]
|
||||
for key in MKTXPConfigKeys.STR_KEYS:
|
||||
entry_reader[key] = self.config[entry_name][key]
|
||||
|
||||
# port
|
||||
if self.config[entry_name].get(MKTXPConfigKeys.PORT_KEY):
|
||||
entry_reader[MKTXPConfigKeys.PORT_KEY] = self.config[entry_name].as_int(MKTXPConfigKeys.PORT_KEY)
|
||||
else:
|
||||
entry_reader[MKTXPConfigKeys.PORT_KEY] = self._default_value_for_key(MKTXPConfigKeys.SSL_KEY, entry_reader[MKTXPConfigKeys.SSL_KEY])
|
||||
write_needed = True # read from disk next time
|
||||
# port
|
||||
if self.config[entry_name].get(MKTXPConfigKeys.PORT_KEY):
|
||||
entry_reader[MKTXPConfigKeys.PORT_KEY] = self.config[entry_name].as_int(MKTXPConfigKeys.PORT_KEY)
|
||||
else:
|
||||
entry_reader[MKTXPConfigKeys.PORT_KEY] = self._default_value_for_key(MKTXPConfigKeys.SSL_KEY, entry_reader[MKTXPConfigKeys.SSL_KEY])
|
||||
write_needed = True # read from disk next time
|
||||
|
||||
if write_needed:
|
||||
self.config[entry_name] = entry_reader
|
||||
self.config.write()
|
||||
if write_needed:
|
||||
self.config[entry_name] = entry_reader
|
||||
self.config.write()
|
||||
|
||||
return entry_reader
|
||||
return entry_reader
|
||||
|
||||
def _entry_reader(self):
|
||||
_entry_reader = {}
|
||||
entry_name = MKTXPConfigKeys.MKTXP_CONFIG_ENTRY_NAME
|
||||
write_needed = False
|
||||
for key in MKTXPConfigKeys.MKTXP_INT_KEYS:
|
||||
if self._config[entry_name].get(key):
|
||||
_entry_reader[key] = self._config[entry_name].as_int(key)
|
||||
else:
|
||||
_entry_reader[key] = self._default_value_for_key(key)
|
||||
write_needed = True # read from disk next time
|
||||
|
||||
if write_needed:
|
||||
self._config[entry_name] = _entry_reader
|
||||
self._config.write()
|
||||
|
||||
return _entry_reader
|
||||
def _entry_reader(self):
|
||||
_entry_reader = {}
|
||||
entry_name = MKTXPConfigKeys.MKTXP_CONFIG_ENTRY_NAME
|
||||
write_needed = False
|
||||
for key in MKTXPConfigKeys.MKTXP_INT_KEYS:
|
||||
if self._config[entry_name].get(key):
|
||||
_entry_reader[key] = self._config[entry_name].as_int(key)
|
||||
else:
|
||||
_entry_reader[key] = self._default_value_for_key(key)
|
||||
write_needed = True # read from disk next time
|
||||
|
||||
if write_needed:
|
||||
self._config[entry_name] = _entry_reader
|
||||
self._config.write()
|
||||
|
||||
return _entry_reader
|
||||
|
||||
def _default_value_for_key(self, key, value = None):
|
||||
return {
|
||||
MKTXPConfigKeys.SSL_KEY: lambda value: MKTXPConfigKeys.DEFAULT_API_SSL_PORT if value else MKTXPConfigKeys.DEFAULT_API_PORT,
|
||||
MKTXPConfigKeys.PORT_KEY: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_PORT,
|
||||
MKTXPConfigKeys.MKTXP_SOCKET_TIMEOUT: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_SOCKET_TIMEOUT,
|
||||
MKTXPConfigKeys.MKTXP_INITIAL_DELAY: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_INITIAL_DELAY,
|
||||
MKTXPConfigKeys.MKTXP_MAX_DELAY: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_MAX_DELAY,
|
||||
MKTXPConfigKeys.MKTXP_INC_DIV: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_INC_DIV,
|
||||
MKTXPConfigKeys.MKTXP_BANDWIDTH_TEST_INTERVAL: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_BANDWIDTH_TEST_INTERVAL
|
||||
}[key](value)
|
||||
def _default_value_for_key(self, key, value = None):
|
||||
return {
|
||||
MKTXPConfigKeys.SSL_KEY: lambda value: MKTXPConfigKeys.DEFAULT_API_SSL_PORT if value else MKTXPConfigKeys.DEFAULT_API_PORT,
|
||||
MKTXPConfigKeys.PORT_KEY: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_PORT,
|
||||
MKTXPConfigKeys.MKTXP_SOCKET_TIMEOUT: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_SOCKET_TIMEOUT,
|
||||
MKTXPConfigKeys.MKTXP_INITIAL_DELAY: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_INITIAL_DELAY,
|
||||
MKTXPConfigKeys.MKTXP_MAX_DELAY: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_MAX_DELAY,
|
||||
MKTXPConfigKeys.MKTXP_INC_DIV: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_INC_DIV,
|
||||
MKTXPConfigKeys.MKTXP_BANDWIDTH_TEST_INTERVAL: lambda value: MKTXPConfigKeys.DEFAULT_MKTXP_BANDWIDTH_TEST_INTERVAL
|
||||
}[key](value)
|
||||
|
||||
|
||||
# Simplest possible Singleton impl
|
||||
|
||||
@@ -12,6 +12,7 @@
|
||||
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
## GNU General Public License for more details.
|
||||
|
||||
|
||||
import sys
|
||||
import subprocess
|
||||
import mktxp.cli.checks.chk_pv
|
||||
@@ -20,6 +21,7 @@ from mktxp.cli.options import MKTXPOptionsParser, MKTXPCommands
|
||||
from mktxp.cli.config.config import config_handler, ConfigEntry
|
||||
from mktxp.basep import MKTXPProcessor, MKTXPCLIProcessor
|
||||
|
||||
|
||||
class MKTXPDispatcher:
|
||||
''' Base MKTXP Commands Dispatcher
|
||||
'''
|
||||
@@ -92,7 +94,7 @@ class MKTXPDispatcher:
|
||||
|
||||
def print(self, args):
|
||||
if not (args['wifi_clients'] or args['capsman_clients']):
|
||||
print("Select metric option(s) to print out, or run 'mktxp print' -h to find out more")
|
||||
print("Select metric option(s) to print out, or run 'mktxp print -h' to find out more")
|
||||
|
||||
if args['wifi_clients']:
|
||||
MKTXPCLIProcessor.wifi_clients(args['entry_name'])
|
||||
@@ -100,6 +102,10 @@ class MKTXPDispatcher:
|
||||
if args['capsman_clients']:
|
||||
MKTXPCLIProcessor.capsman_clients(args['entry_name'])
|
||||
|
||||
if args['dhcp_clients']:
|
||||
MKTXPCLIProcessor.dhcp_clients(args['entry_name'])
|
||||
|
||||
|
||||
|
||||
def main():
|
||||
MKTXPDispatcher().dispatch()
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
## GNU General Public License for more details.
|
||||
|
||||
|
||||
import os
|
||||
import pkg_resources
|
||||
from argparse import ArgumentParser, HelpFormatter
|
||||
@@ -132,6 +133,9 @@ Selected metrics info can be printed on the command line. For more information,
|
||||
help = "WiFi clients metrics",
|
||||
action = 'store_true')
|
||||
|
||||
optional_args_group.add_argument('-dc', '--dhcp_clients', dest='dhcp_clients',
|
||||
help = "DHCP clients metrics",
|
||||
action = 'store_true')
|
||||
|
||||
# Options checking
|
||||
def _check_args(self, args, parser):
|
||||
|
||||
@@ -21,16 +21,17 @@ from mktxp.cli.config.config import config_handler
|
||||
class BaseOutputProcessor:
|
||||
OutputCapsmanEntry = namedtuple('OutputCapsmanEntry', ['dhcp_name', 'dhcp_address', 'mac_address', 'rx_signal', 'interface', 'ssid', 'tx_rate', 'rx_rate', 'uptime'])
|
||||
OutputWiFiEntry = namedtuple('OutputWiFiEntry', ['dhcp_name', 'dhcp_address', 'mac_address', 'signal_strength', 'signal_to_noise', 'interface', 'tx_rate', 'rx_rate', 'uptime'])
|
||||
OutputDHCPEntry = namedtuple('OutputDHCPEntry', ['host_name', 'comment', 'address', 'active_address', 'mac_address', 'server', 'expires_after'])
|
||||
|
||||
@staticmethod
|
||||
def augment_record(router_metric, registration_record, dhcp_lease_records):
|
||||
def augment_record(router_entry, registration_record, dhcp_lease_records):
|
||||
try:
|
||||
dhcp_lease_record = next((dhcp_lease_record for dhcp_lease_record in dhcp_lease_records if dhcp_lease_record['mac_address']==registration_record['mac_address']))
|
||||
dhcp_name = dhcp_lease_record.get('host_name')
|
||||
dhcp_comment = dhcp_lease_record.get('comment')
|
||||
|
||||
if dhcp_name and dhcp_comment:
|
||||
dhcp_name = f'{dhcp_name[0:20]} ({dhcp_comment[0:20]})' if not router_metric.router_entry.use_comments_over_names else dhcp_comment
|
||||
dhcp_name = f'{dhcp_name[0:20]} ({dhcp_comment[0:20]})' if not router_entry.config_entry.use_comments_over_names else dhcp_comment
|
||||
elif dhcp_comment:
|
||||
dhcp_name = dhcp_comment
|
||||
else:
|
||||
@@ -49,9 +50,12 @@ class BaseOutputProcessor:
|
||||
registration_record['rx_bytes'] = registration_record['bytes'].split(',')[1]
|
||||
del registration_record['bytes']
|
||||
|
||||
registration_record['tx_rate'] = BaseOutputProcessor.parse_rates(registration_record['tx_rate'])
|
||||
registration_record['rx_rate'] = BaseOutputProcessor.parse_rates(registration_record['rx_rate'])
|
||||
registration_record['uptime'] = naturaldelta(BaseOutputProcessor.parse_timedelta_seconds(registration_record['uptime']), months=True, minimum_unit='seconds', when=None)
|
||||
if registration_record.get('tx_rate'):
|
||||
registration_record['tx_rate'] = BaseOutputProcessor.parse_rates(registration_record['tx_rate'])
|
||||
if registration_record.get('rx_rate'):
|
||||
registration_record['rx_rate'] = BaseOutputProcessor.parse_rates(registration_record['rx_rate'])
|
||||
if registration_record.get('uptime'):
|
||||
registration_record['uptime'] = naturaldelta(BaseOutputProcessor.parse_timedelta_seconds(registration_record['uptime']), months=True, minimum_unit='seconds', when=None)
|
||||
|
||||
if registration_record.get('signal_strength'):
|
||||
registration_record['signal_strength'] = BaseOutputProcessor.parse_signal_strength(registration_record['signal_strength'])
|
||||
|
||||
@@ -11,27 +11,31 @@
|
||||
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
## GNU General Public License for more details.
|
||||
|
||||
|
||||
from tabulate import tabulate
|
||||
from mktxp.cli.output.base_out import BaseOutputProcessor
|
||||
from mktxp.datasources.dhcp_ds import DHCPMetricsDataSource
|
||||
from mktxp.datasources.capsman_ds import CapsmanRegistrationsMetricsDataSource
|
||||
|
||||
|
||||
class CapsmanOutput:
|
||||
''' CAPsMAN CLI Output
|
||||
'''
|
||||
@staticmethod
|
||||
def clients_summary(router_metric):
|
||||
def clients_summary(router_entry):
|
||||
registration_labels = ['interface', 'ssid', 'mac_address', 'rx_signal', 'uptime', 'tx_rate', 'rx_rate']
|
||||
registration_records = router_metric.capsman_registration_table_records(registration_labels, False)
|
||||
registration_records = CapsmanRegistrationsMetricsDataSource.metric_records(router_entry, metric_labels = registration_labels, add_router_id = False)
|
||||
if not registration_records:
|
||||
print('No CAPsMAN registration records')
|
||||
return
|
||||
|
||||
# translate / trim / augment registration records
|
||||
dhcp_lease_labels = ['host_name', 'comment', 'address', 'mac_address']
|
||||
dhcp_lease_records = router_metric.dhcp_lease_records(dhcp_lease_labels, False)
|
||||
dhcp_lease_records = DHCPMetricsDataSource.metric_records(router_entry, metric_labels = dhcp_lease_labels, add_router_id = False)
|
||||
|
||||
dhcp_rt_by_interface = {}
|
||||
for registration_record in sorted(registration_records, key = lambda rt_record: rt_record['rx_signal'], reverse=True):
|
||||
BaseOutputProcessor.augment_record(router_metric, registration_record, dhcp_lease_records)
|
||||
BaseOutputProcessor.augment_record(router_entry, registration_record, dhcp_lease_records)
|
||||
|
||||
interface = registration_record['interface']
|
||||
if interface in dhcp_rt_by_interface.keys():
|
||||
|
||||
48
mktxp/cli/output/dhcp_out.py
Normal file
48
mktxp/cli/output/dhcp_out.py
Normal file
@@ -0,0 +1,48 @@
|
||||
# coding=utf8
|
||||
## Copyright (c) 2020 Arseniy Kuznetsov
|
||||
##
|
||||
## 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 2
|
||||
## 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.
|
||||
|
||||
|
||||
from tabulate import tabulate
|
||||
from mktxp.cli.output.base_out import BaseOutputProcessor
|
||||
from mktxp.datasources.dhcp_ds import DHCPMetricsDataSource
|
||||
|
||||
|
||||
class DHCPOutput:
|
||||
''' DHCP Clients CLI Output
|
||||
'''
|
||||
@staticmethod
|
||||
def clients_summary(router_entry):
|
||||
dhcp_lease_labels = ['host_name', 'comment', 'active_address', 'address', 'mac_address', 'server', 'expires_after']
|
||||
dhcp_lease_records = DHCPMetricsDataSource.metric_records(router_entry, metric_labels = dhcp_lease_labels, add_router_id = False)
|
||||
if not dhcp_lease_records:
|
||||
print('No DHCP registration records')
|
||||
return
|
||||
|
||||
dhcp_by_server = {}
|
||||
for dhcp_lease_record in sorted(dhcp_lease_records, key = lambda dhcp_record: dhcp_record['active_address'], reverse=True):
|
||||
server = dhcp_lease_record['server']
|
||||
if server in dhcp_by_server.keys():
|
||||
dhcp_by_server[server].append(dhcp_lease_record)
|
||||
else:
|
||||
dhcp_by_server[server] = [dhcp_lease_record]
|
||||
|
||||
num_records = 0
|
||||
output_table = []
|
||||
for key in dhcp_by_server.keys():
|
||||
for record in dhcp_by_server[key]:
|
||||
output_table.append(BaseOutputProcessor.OutputDHCPEntry(**record))
|
||||
num_records += 1
|
||||
output_table.append({})
|
||||
print()
|
||||
print(tabulate(output_table, headers = "keys", tablefmt="github"))
|
||||
print(tabulate([{0:'DHCP Clients:', 1:num_records}], tablefmt="text"))
|
||||
@@ -11,27 +11,31 @@
|
||||
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
## GNU General Public License for more details.
|
||||
|
||||
|
||||
from tabulate import tabulate
|
||||
from mktxp.cli.output.base_out import BaseOutputProcessor
|
||||
from mktxp.datasources.dhcp_ds import DHCPMetricsDataSource
|
||||
from mktxp.datasources.wireless_ds import WirelessMetricsDataSource
|
||||
|
||||
|
||||
class WirelessOutput:
|
||||
''' Wireless Clients CLI Output
|
||||
'''
|
||||
@staticmethod
|
||||
def clients_summary(router_metric):
|
||||
def clients_summary(router_entry):
|
||||
registration_labels = ['interface', 'mac_address', 'signal_strength', 'uptime', 'tx_rate', 'rx_rate', 'signal_to_noise']
|
||||
registration_records = router_metric.wireless_registration_table_records(registration_labels, False)
|
||||
registration_records = WirelessMetricsDataSource.metric_records(router_entry, metric_labels = registration_labels, add_router_id = False)
|
||||
if not registration_records:
|
||||
print('No wireless registration records')
|
||||
return
|
||||
|
||||
# translate / trim / augment registration records
|
||||
dhcp_lease_labels = ['host_name', 'comment', 'address', 'mac_address']
|
||||
dhcp_lease_records = router_metric.dhcp_lease_records(dhcp_lease_labels, False)
|
||||
dhcp_lease_records = DHCPMetricsDataSource.metric_records(router_entry, metric_labels = dhcp_lease_labels, add_router_id = False)
|
||||
|
||||
dhcp_rt_by_interface = {}
|
||||
for registration_record in sorted(registration_records, key = lambda rt_record: rt_record['signal_strength'], reverse=True):
|
||||
BaseOutputProcessor.augment_record(router_metric, registration_record, dhcp_lease_records)
|
||||
BaseOutputProcessor.augment_record(router_entry, registration_record, dhcp_lease_records)
|
||||
|
||||
interface = registration_record['interface']
|
||||
if interface in dhcp_rt_by_interface.keys():
|
||||
|
||||
Reference in New Issue
Block a user