Configure.py

#!/usr/bin/env python3
"""
MIT License

Copyright (c) 2020 PyKOB - MorseKOB in Python

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""

"""Configure.py

Configures system values and user preferences for the suite of PyKOB applications.

Provides a Command Line Interface (CLI) the the pykob.config module.
"""
import argparse
import sys
GUI = True                              # Hope for the best
try:
    import tkinter as tk
except ModuleNotFoundError:
    GUI = False

from pykob import config
from pykob import preferencesWindow

NONE_CFG_VALUE = "NONE"

def stringOrNone(s:str) -> str:
    """Return `None` if the value is "NONE" (case insensitive) or the value

    Parameters
    ----------
    s : str
        'NONE' (case insensitive) or a string value.

    Return
    ------
    None or `String value`
    """
    r = None if s.upper() == "NONE" else s
    return r

def _doFilePreferences():
    prefs = preferencesWindow.PreferencesWindow()

def _doFileExit():
    sys.exit(0)

def main(argv):
    # Check for command line parameters...
    #  If none are supplied, print the current configuration
    #  If arguments are given, process them for 'help' or the setting values.
    #  If values are specified, update the config and save it, then
    #  print the configuration.

    # System configuration
    port = None
    gpio = None
    # User configuration
    auto_connect = None
    invert_key_input = None
    remote = None
    interface_type = None
    server_url = None
    sound = None
    sounder = None
    sounder_pwrsv = None
    spacing = None
    station = None
    code_type = None
    wire = None
    min_char_speed = None
    text_speed = None
    gui_config = False

    try:
        arg_parser = argparse.ArgumentParser(description="Display the PyKOB configuration as well as key system values. "
            + "Allow configuration values to be set and saved.", \
            parents=\
            [\
            config.auto_connect_override, \
            config.code_type_override, \
            config.interface_type_override, \
            config.invert_key_input_override, \
            config.min_char_speed_override, \
            config.remote_override, \
            config.serial_port_override, \
            config.gpio_override, \
            config.server_url_override, \
            config.sound_override, \
            config.sounder_override, \
            config.sounder_pwrsv_override, \
            config.spacing_override, \
            config.station_override, \
            config.text_speed_override, \
            config.wire_override])
        if GUI:
            arg_parser.add_argument('-G', '--gui', dest="gui_config", action='store_true',
                            help="Use preferences panel GUI for interactive configuration.")

        args = arg_parser.parse_args()

        # Set config values if they were specified
        save_config = False
        if not args.auto_connect == config.auto_connect:
            config.set_auto_connect(args.auto_connect)
            save_config = True
        if not args.code_type == config.code_type:
            config.set_code_type(args.code_type)
            save_config = True
        if not args.interface_type == config.interface_type:
            config.set_interface_type(args.interface_type)
            save_config = True
        if not args.invert_key_input == config.invert_key_input:
            config.set_invert_key_input(args.invert_key_input)
            save_config = True
        if not args.min_char_speed == config.min_char_speed:
            config.set_min_char_speed(args.min_char_speed)
            save_config = True
        if not args.remote == config.remote:
            config.set_remote(args.remote)
            save_config = True
        if not args.serial_port == config.serial_port:
            config.set_serial_port(args.serial_port)
            save_config = True
        if not args.gpio == config.gpio:
            config.set_gpio(args.gpio)
            save_config = True
        if not args.server_url == config.server_url:
            s = config.server_url
            if s and s.upper() == 'DEFAULT':
                config.set_server_url(None)
            else:
                config.set_server_url(args.server_url)
            save_config = True
        if not args.sound == config.sound:
            config.set_sound(args.sound)
            save_config = True
        if not args.sounder == config.sounder:
            config.set_sounder(args.sounder)
            save_config = True
        if not args.sounder_power_save == config.sounder_power_save:
            config.set_sounder_power_save(args.sounder_power_save)
            save_config = True
        if not args.spacing == config.spacing:
            config.set_spacing(args.spacing)
            save_config = True
        if not args.station == config.station:
            config.set_station(args.station)
            save_config = True
        if not args.text_speed == config.text_speed:
            config.set_text_speed(args.text_speed)
            save_config = True
        if not args.wire == config.wire:
            config.set_wire(args.wire)
            save_config = True

        # If any of the configuration values changed, save the configuration.
        if save_config:
            config.save_config()
    except Exception as ex:
        print("Error processing arguments: {}".format(ex))
        sys.exit(1)

    if GUI and args.gui_config:
        try:
            root = tk.Tk()
            root.overrideredirect(1)
            root.withdraw()

            menu = tk.Menu()
            root.config(menu=menu)
            fileMenu = tk.Menu(menu)
            menu.add_cascade(label='File', menu=fileMenu)
            fileMenu.add_command(label='Preferences...', command=_doFilePreferences)
            fileMenu.add_separator()
            fileMenu.add_command(label='Quit', command=_doFileExit)

            prefs = preferencesWindow.PreferencesWindow(quitWhenDismissed=True)
            prefs.display()

            # root.quit()

        except KeyboardInterrupt:
            print()
            sys.exit(0)

    # If no arguments were given print the system info in addition to the configuration.
    if len(argv) == 0:
        print("======================================")
        print("        System Information")
        print("======================================")
        config.print_system_info()
        print("======================================")
        print("          Configuration")

    config.print_config()
    sys.exit(0)

if __name__ == "__main__":
    try:
        main(sys.argv[1:])
    except ValueError as ex:
        print(ex.args[0])
        sys.exit(1)     # Indicate this was an abnormal exit
    except KeyboardInterrupt:
        print()
        sys.exit(0)     # Indicate this was a normal exit