FreeDATA/modem/config.py

import configparser
import structlog

class CONFIG:
    """
    CONFIG class for handling with config files

    """

    def __init__(self, configfile: str):
        # set up logger
        self.log = structlog.get_logger("CONFIG")

        # init configparser
        self.config = configparser.ConfigParser(inline_comment_prefixes="#", allow_no_value=True)
        
        try:
            self.config_name = configfile
        
        except Exception:
            self.config_name = "config.ini"

        self.log.info("[CFG] logfile init", file=self.config_name)

        # check if log file exists
        self.config_exists()

    def config_exists(self):
        """
        check if config file exists
        """
        try:
            return bool(self.config.read(self.config_name, None))
        except Exception as configerror:
            self.log.error("[CFG] logfile init error", e=configerror)
            return False

    def write_config(self, section: str, key: str, value):
        """
        write values to config
        """

    # Validates config data
    def validate(self, data):
        for section in data:
            for setting in data[section]:
                if section == 'NETWORK':
                    if setting == 'modemport' and int(data[section][setting]) == 0:
                        raise Exception("'modemport' should be an integer")
                if section == 'STATION':
                    if setting == 'mycall' and len(data[section][setting]) <= 0:
                        raise Exception("'%s' can't be empty" % setting)
                    if setting == 'mygrid' and len(data[section][setting]) <= 0:
                        raise Exception("'%s' can't be empty" % setting)
                    if setting == 'ssid_list' and not isinstance(data[section][setting], list):
                        raise Exception("'%s' needs to be a list" % setting)
        # TODO finish this for all config settings!
    
    # Sets and writes config data from a dict containing data settings
    def write(self, data):

        # Validate config data before writing
        self.validate(data)

        for section in data:
            # init section if it doesn't exist yet
            if not section.upper() in self.config.keys():
                self.config[section] = {}

            for setting in data[section]:
                self.config[section][setting] = data[section][setting]
        
        # Write config data to file
        try:
            with open(self.config_name, 'w') as configfile:
                self.config.write(configfile)
                return self.config
        except Exception as conferror:
            self.log.error("[CFG] reading logfile", e=conferror)
            return False

    # TODO remove this method when ready
    def write_entire_config(self, data):
        """
        write entire config
        """
        self.config['NETWORK'] = {'#Network settings': None,
                                  'ModemPORT': data[50]
                                  }

        self.config['STATION'] = {'#Station settings': None,
                                  'mycall': data[1],
                                  'mygrid': data[2],
                                  'ssid_list': list(data[18])# [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] # list(data[18])
                                  }

        self.config['AUDIO'] = {'#Audio settings': None,
                                'rx': data[3],
                                'tx': data[4],
                                'txaudiolevel': data[14],
                                'rxaudiolevel': data[25],
                                'auto_tune': data[19]

                                }
        self.config['RADIO'] = {'#Radio settings': None,
                                'radiocontrol': data[5],
                                'rigctld_ip': data[6],
                                'rigctld_port': data[7]
                                }
        self.config['Modem'] = {'#Modem settings': None,
                              'scatter': data[8],
                              'fft': data[9],
                              'narrowband': data[10],
                              'fmin': data[11],
                              'fmax': data[12],
                              'qrv': data[15],
                              'rx_buffer_size': data[16],
                              'explorer': data[17],
                              'stats': data[19],
                              'fsk': data[13],
                              'tx_delay': data[21],
                              'transmit_morse_identifier' : data[26]
        }
        self.config['TCI'] = {'#TCI settings': None,
                              'ip': data[22],
                              'port': data[23]
                              }

        self.config['MESH'] = {'#Mesh settings': None,
                              'enable_protocol': data[24]
                              }

        try:
            with open(self.config_name, 'w') as configfile:
                self.config.write(configfile)
        except Exception as conferror:
            self.log.error("[CFG] reading logfile", e=conferror)


    def read(self):
        """
        read config file
        """
        if not self.config_exists():
            return False

        return {s:dict(self.config.items(s)) for s in self.config.sections()}

    def get(self, area, key, default):
        """
        read from config and add if not exists

        """

        for _ in range(2):
            try:
                parameter = (
                    self.config[area][key] in ["True", "true", True]
                    if default in ["True", "true", True, "False", "false", False]
                    else self.config[area][key]
                )
            except KeyError:
                self.config[area][key] = str(default)

        self.log.info("[CFG] reading...", parameter=parameter, key=key)
        return parameter