feat: KIAUH v6 - full rewrite of KIAUH in Python (#428)

kiauh/core/backup_manager/__init__.py

@@ -0,0 +1,12 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+
+BACKUP_ROOT_DIR = Path.home().joinpath("kiauh-backups")

kiauh/core/backup_manager/backup_manager.py

@@ -0,0 +1,94 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import shutil
+from pathlib import Path
+from typing import List
+
+from core.backup_manager import BACKUP_ROOT_DIR
+from core.logger import Logger
+from utils.common import get_current_date
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class BackupManager:
+    def __init__(self, backup_root_dir: Path = BACKUP_ROOT_DIR):
+        self._backup_root_dir: Path = backup_root_dir
+        self._ignore_folders: List[str] = []
+
+    @property
+    def backup_root_dir(self) -> Path:
+        return self._backup_root_dir
+
+    @backup_root_dir.setter
+    def backup_root_dir(self, value: Path):
+        self._backup_root_dir = value
+
+    @property
+    def ignore_folders(self) -> List[str]:
+        return self._ignore_folders
+
+    @ignore_folders.setter
+    def ignore_folders(self, value: List[str]):
+        self._ignore_folders = value
+
+    def backup_file(self, file: Path, target: Path | None = None, custom_filename=None):
+        Logger.print_status(f"Creating backup of {file} ...")
+
+        if not file.exists():
+            Logger.print_info("File does not exist! Skipping ...")
+            return
+
+        target = self.backup_root_dir if target is None else target
+
+        if Path(file).is_file():
+            date = get_current_date().get("date")
+            time = get_current_date().get("time")
+            filename = f"{file.stem}-{date}-{time}{file.suffix}"
+            filename = custom_filename if custom_filename is not None else filename
+            try:
+                Path(target).mkdir(exist_ok=True)
+                shutil.copyfile(file, target.joinpath(filename))
+                Logger.print_ok("Backup successful!")
+            except OSError as e:
+                Logger.print_error(f"Unable to backup '{file}':\n{e}")
+        else:
+            Logger.print_info(f"File '{file}' not found ...")
+
+    def backup_directory(
+        self, name: str, source: Path, target: Path | None = None
+    ) -> None:
+        Logger.print_status(f"Creating backup of {name} in {target} ...")
+
+        if source is None or not Path(source).exists():
+            Logger.print_info("Source directory does not exist! Skipping ...")
+            return
+
+        target = self.backup_root_dir if target is None else target
+        try:
+            date = get_current_date().get("date")
+            time = get_current_date().get("time")
+            shutil.copytree(
+                source,
+                target.joinpath(f"{name.lower()}-{date}-{time}"),
+                ignore=self.ignore_folders_func,
+            )
+            Logger.print_ok("Backup successful!")
+        except OSError as e:
+            Logger.print_error(f"Unable to backup directory '{source}':\n{e}")
+            return
+
+    def ignore_folders_func(self, dirpath, filenames) -> List[str]:
+        return (
+            [f for f in filenames if f in self._ignore_folders]
+            if self._ignore_folders
+            else []
+        )

kiauh/core/constants.py

@@ -0,0 +1,39 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import os
+import pwd
+from pathlib import Path
+
+from core.backup_manager import BACKUP_ROOT_DIR
+
+# text colors and formats
+COLOR_WHITE = "\033[37m"  # white
+COLOR_MAGENTA = "\033[35m"  # magenta
+COLOR_GREEN = "\033[92m"  # bright green
+COLOR_YELLOW = "\033[93m"  # bright yellow
+COLOR_RED = "\033[91m"  # bright red
+COLOR_CYAN = "\033[96m"  # bright cyan
+RESET_FORMAT = "\033[0m"  # reset format
+
+# global dependencies
+GLOBAL_DEPS = ["git", "wget", "curl", "unzip", "dfu-util", "python3-virtualenv"]
+
+# strings
+INVALID_CHOICE = "Invalid choice. Please select a valid value."
+
+# current user
+CURRENT_USER = pwd.getpwuid(os.getuid())[0]
+
+# dirs
+SYSTEMD = Path("/etc/systemd/system")
+PRINTER_CFG_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("printer-cfg-backups")
+NGINX_SITES_AVAILABLE = Path("/etc/nginx/sites-available")
+NGINX_SITES_ENABLED = Path("/etc/nginx/sites-enabled")
+NGINX_CONFD = Path("/etc/nginx/conf.d")

kiauh/core/decorators.py

@@ -0,0 +1,24 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import warnings
+from typing import Callable
+
+
+def deprecated(info: str = "", replaced_by: Callable | None = None) -> Callable:
+    def decorator(func) -> Callable:
+        def wrapper(*args, **kwargs):
+            msg = f"{info}{replaced_by.__name__ if replaced_by else ''}"
+            warnings.warn(msg, category=DeprecationWarning, stacklevel=2)
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator

kiauh/core/instance_manager/base_instance.py

@@ -0,0 +1,58 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from __future__ import annotations
+
+import re
+from dataclasses import dataclass, field
+from pathlib import Path
+from typing import List
+
+from utils.fs_utils import get_data_dir
+
+SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion"]
+
+
+@dataclass(repr=True)
+class BaseInstance:
+    instance_type: type
+    suffix: str
+    log_file_name: str | None = None
+    data_dir: Path = field(init=False)
+    base_folders: List[Path] = field(init=False)
+    cfg_dir: Path = field(init=False)
+    log_dir: Path = field(init=False)
+    gcodes_dir: Path = field(init=False)
+    comms_dir: Path = field(init=False)
+    sysd_dir: Path = field(init=False)
+    is_legacy_instance: bool = field(init=False)
+
+    def __post_init__(self):
+        self.data_dir = get_data_dir(self.instance_type, self.suffix)
+        # the following attributes require the data_dir to be set
+        self.cfg_dir = self.data_dir.joinpath("config")
+        self.log_dir = self.data_dir.joinpath("logs")
+        self.gcodes_dir = self.data_dir.joinpath("gcodes")
+        self.comms_dir = self.data_dir.joinpath("comms")
+        self.sysd_dir = self.data_dir.joinpath("systemd")
+        self.is_legacy_instance = self._set_is_legacy_instance()
+        self.base_folders = [
+            self.data_dir,
+            self.cfg_dir,
+            self.log_dir,
+            self.gcodes_dir,
+            self.comms_dir,
+            self.sysd_dir,
+        ]
+
+    def _set_is_legacy_instance(self) -> bool:
+        legacy_pattern = r"^(?!printer)(.+)_data"
+        match = re.search(legacy_pattern, self.data_dir.name)
+
+        return True if (match and self.suffix != "") else False

kiauh/core/instance_manager/instance_manager.py

@@ -0,0 +1,108 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+from pathlib import Path
+from subprocess import CalledProcessError
+from typing import List
+
+from core.instance_type import InstanceType
+from core.logger import Logger
+from utils.sys_utils import cmd_sysctl_service
+
+
+class InstanceManager:
+    @staticmethod
+    def enable(instance: InstanceType) -> None:
+        service_name: str = instance.service_file_path.name
+        try:
+            cmd_sysctl_service(service_name, "enable")
+        except CalledProcessError as e:
+            Logger.print_error(f"Error enabling service {service_name}:")
+            Logger.print_error(f"{e}")
+
+    @staticmethod
+    def disable(instance: InstanceType) -> None:
+        service_name: str = instance.service_file_path.name
+        try:
+            cmd_sysctl_service(service_name, "disable")
+        except CalledProcessError as e:
+            Logger.print_error(f"Error disabling {service_name}: {e}")
+            raise
+
+    @staticmethod
+    def start(instance: InstanceType) -> None:
+        service_name: str = instance.service_file_path.name
+        try:
+            cmd_sysctl_service(service_name, "start")
+        except CalledProcessError as e:
+            Logger.print_error(f"Error starting {service_name}: {e}")
+            raise
+
+    @staticmethod
+    def stop(instance: InstanceType) -> None:
+        name: str = instance.service_file_path.name
+        try:
+            cmd_sysctl_service(name, "stop")
+        except CalledProcessError as e:
+            Logger.print_error(f"Error stopping {name}: {e}")
+            raise
+
+    @staticmethod
+    def restart(instance: InstanceType) -> None:
+        name: str = instance.service_file_path.name
+        try:
+            cmd_sysctl_service(name, "restart")
+        except CalledProcessError as e:
+            Logger.print_error(f"Error restarting {name}: {e}")
+            raise
+
+    @staticmethod
+    def start_all(instances: List[InstanceType]) -> None:
+        for instance in instances:
+            InstanceManager.start(instance)
+
+    @staticmethod
+    def stop_all(instances: List[InstanceType]) -> None:
+        for instance in instances:
+            InstanceManager.stop(instance)
+
+    @staticmethod
+    def restart_all(instances: List[InstanceType]) -> None:
+        for instance in instances:
+            InstanceManager.restart(instance)
+
+    @staticmethod
+    def remove(instance: InstanceType) -> None:
+        from utils.fs_utils import run_remove_routines
+        from utils.sys_utils import remove_system_service
+
+        try:
+            # remove the service file
+            service_file_path: Path = instance.service_file_path
+            if service_file_path is not None:
+                remove_system_service(service_file_path.name)
+
+            # then remove all the log files
+            if (
+                not instance.log_file_name
+                or not instance.base.log_dir
+                or not instance.base.log_dir.exists()
+            ):
+                return
+
+            files = instance.base.log_dir.iterdir()
+            logs = [f for f in files if f.name.startswith(instance.log_file_name)]
+            for log in logs:
+                Logger.print_status(f"Remove '{log}'")
+                run_remove_routines(log)
+
+        except Exception as e:
+            Logger.print_error(f"Error removing service: {e}")
+            raise

kiauh/core/instance_type.py

@@ -0,0 +1,25 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from typing import TypeVar
+
+from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from components.octoeverywhere.octoeverywhere import Octoeverywhere
+from extensions.obico.moonraker_obico import MoonrakerObico
+from extensions.telegram_bot.moonraker_telegram_bot import MoonrakerTelegramBot
+
+InstanceType = TypeVar(
+    "InstanceType",
+    Klipper,
+    Moonraker,
+    MoonrakerTelegramBot,
+    MoonrakerObico,
+    Octoeverywhere,
+)

kiauh/core/logger.py

@@ -0,0 +1,194 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from enum import Enum
+from typing import List
+
+from core.constants import (
+    COLOR_CYAN,
+    COLOR_GREEN,
+    COLOR_MAGENTA,
+    COLOR_RED,
+    COLOR_WHITE,
+    COLOR_YELLOW,
+    RESET_FORMAT,
+)
+
+
+class DialogType(Enum):
+    INFO = ("INFO", COLOR_WHITE)
+    SUCCESS = ("SUCCESS", COLOR_GREEN)
+    ATTENTION = ("ATTENTION", COLOR_YELLOW)
+    WARNING = ("WARNING", COLOR_YELLOW)
+    ERROR = ("ERROR", COLOR_RED)
+    CUSTOM = (None, None)
+
+
+class DialogCustomColor(Enum):
+    WHITE = COLOR_WHITE
+    GREEN = COLOR_GREEN
+    YELLOW = COLOR_YELLOW
+    RED = COLOR_RED
+    CYAN = COLOR_CYAN
+    MAGENTA = COLOR_MAGENTA
+
+
+LINE_WIDTH = 53
+
+
+class Logger:
+    @staticmethod
+    def info(msg) -> None:
+        # log to kiauh.log
+        pass
+
+    @staticmethod
+    def warn(msg) -> None:
+        # log to kiauh.log
+        pass
+
+    @staticmethod
+    def error(msg) -> None:
+        # log to kiauh.log
+        pass
+
+    @staticmethod
+    def print_info(msg, prefix=True, start="", end="\n") -> None:
+        message = f"[INFO] {msg}" if prefix else msg
+        print(f"{COLOR_WHITE}{start}{message}{RESET_FORMAT}", end=end)
+
+    @staticmethod
+    def print_ok(msg: str = "Success!", prefix=True, start="", end="\n") -> None:
+        message = f"[OK] {msg}" if prefix else msg
+        print(f"{COLOR_GREEN}{start}{message}{RESET_FORMAT}", end=end)
+
+    @staticmethod
+    def print_warn(msg, prefix=True, start="", end="\n") -> None:
+        message = f"[WARN] {msg}" if prefix else msg
+        print(f"{COLOR_YELLOW}{start}{message}{RESET_FORMAT}", end=end)
+
+    @staticmethod
+    def print_error(msg, prefix=True, start="", end="\n") -> None:
+        message = f"[ERROR] {msg}" if prefix else msg
+        print(f"{COLOR_RED}{start}{message}{RESET_FORMAT}", end=end)
+
+    @staticmethod
+    def print_status(msg, prefix=True, start="", end="\n") -> None:
+        message = f"\n###### {msg}" if prefix else msg
+        print(f"{COLOR_MAGENTA}{start}{message}{RESET_FORMAT}", end=end)
+
+    @staticmethod
+    def print_dialog(
+        title: DialogType,
+        content: List[str],
+        center_content: bool = False,
+        custom_title: str | None = None,
+        custom_color: DialogCustomColor | None = None,
+        margin_top: int = 0,
+        margin_bottom: int = 0,
+    ) -> None:
+        """
+        Prints a dialog with the given title and content.
+        Those dialogs should be used to display verbose messages to the user which
+        require simple interaction like confirmation or input. Do not use this for
+        navigating through the application.
+
+        :param title: The type of the dialog.
+        :param content: The content of the dialog.
+        :param center_content: Whether to center the content or not.
+        :param custom_title: A custom title for the dialog.
+        :param custom_color: A custom color for the dialog.
+        :param margin_top: The number of empty lines to print before the dialog.
+        :param margin_bottom: The number of empty lines to print after the dialog.
+        """
+        dialog_color = Logger._get_dialog_color(title, custom_color)
+        dialog_title = Logger._get_dialog_title(title, custom_title)
+        dialog_title_formatted = Logger._format_dialog_title(dialog_title)
+        dialog_content = Logger.format_content(content, LINE_WIDTH, center_content)
+        top = Logger._format_top_border(dialog_color)
+        bottom = Logger._format_bottom_border()
+
+        print("\n" * margin_top)
+        print(
+            f"{top}{dialog_title_formatted}{dialog_content}{bottom}",
+            end="",
+        )
+        print("\n" * margin_bottom)
+
+    @staticmethod
+    def _get_dialog_title(
+        title: DialogType, custom_title: str | None = None
+    ) -> str | None:
+        if title == DialogType.CUSTOM and custom_title:
+            return f"[ {custom_title} ]"
+        return f"[ {title.value[0]} ]" if title.value[0] else None
+
+    @staticmethod
+    def _get_dialog_color(
+        title: DialogType, custom_color: DialogCustomColor | None = None
+    ) -> str:
+        if title == DialogType.CUSTOM and custom_color:
+            return str(custom_color.value)
+
+        color: str = title.value[1] if title.value[1] else DialogCustomColor.WHITE.value
+
+        return color
+
+    @staticmethod
+    def _format_top_border(color: str) -> str:
+        return f"{color}┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓"
+
+    @staticmethod
+    def _format_bottom_border() -> str:
+        return (
+            f"\n┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛{RESET_FORMAT}"
+        )
+
+    @staticmethod
+    def _format_dialog_title(title: str | None) -> str:
+        if title is not None:
+            return textwrap.dedent(f"""
+                ┃ {title:^{LINE_WIDTH}} ┃
+                ┠───────────────────────────────────────────────────────┨
+                """)
+        else:
+            return "\n"
+
+    @staticmethod
+    def format_content(
+        content: List[str],
+        line_width: int,
+        center_content: bool = False,
+        border_left: str = "┃",
+        border_right: str = "┃",
+    ) -> str:
+        wrapper = textwrap.TextWrapper(line_width)
+
+        lines = []
+        for i, c in enumerate(content):
+            paragraph = wrapper.wrap(c)
+            lines.extend(paragraph)
+
+            # add a full blank line if we have a double newline
+            # character unless we are at the end of the list
+            if c == "\n\n" and i < len(content) - 1:
+                lines.append(" " * line_width)
+
+        if not center_content:
+            formatted_lines = [
+                f"{border_left} {line:<{line_width}} {border_right}" for line in lines
+            ]
+        else:
+            formatted_lines = [
+                f"{border_left} {line:^{line_width}} {border_right}" for line in lines
+            ]
+
+        return "\n".join(formatted_lines)

kiauh/core/menus/__init__.py

@@ -0,0 +1,34 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+from dataclasses import dataclass
+from enum import Enum
+from typing import Any, Callable, Type
+
+
+@dataclass
+class Option:
+    """
+    Represents a menu option.
+    :param method: Method that will be used to call the menu option
+    :param opt_index: Can be used to pass the user input to the menu option
+    :param opt_data: Can be used to pass any additional data to the menu option
+    """
+
+    method: Type[Callable] | None = None
+    opt_index: str = ""
+    opt_data: Any = None
+
+
+class FooterType(Enum):
+    QUIT = "QUIT"
+    BACK = "BACK"
+    BACK_HELP = "BACK_HELP"
+    BLANK = "BLANK"

kiauh/core/menus/advanced_menu.py

@@ -0,0 +1,98 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from components.klipper import KLIPPER_DIR
+from components.klipper.klipper import Klipper
+from components.klipper_firmware.menus.klipper_build_menu import (
+    KlipperBuildFirmwareMenu,
+)
+from components.klipper_firmware.menus.klipper_flash_menu import (
+    KlipperFlashMethodMenu,
+    KlipperSelectMcuConnectionMenu,
+)
+from components.moonraker import MOONRAKER_DIR
+from components.moonraker.moonraker import Moonraker
+from core.constants import COLOR_YELLOW, RESET_FORMAT
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+from procedures.system import change_system_hostname
+from utils.git_utils import rollback_repository
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class AdvancedMenu(BaseMenu):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
+        super().__init__()
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from core.menus.main_menu import MainMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "1": Option(method=self.build),
+            "2": Option(method=self.flash),
+            "3": Option(method=self.build_flash),
+            "4": Option(method=self.get_id),
+            "5": Option(method=self.klipper_rollback),
+            "6": Option(method=self.moonraker_rollback),
+            "7": Option(method=self.change_hostname),
+        }
+
+    def print_menu(self) -> None:
+        header = " [ Advanced Menu ] "
+        color = COLOR_YELLOW
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────┬───────────────────────────╢
+            ║ Klipper Firmware:         │ Repository Rollback:      ║
+            ║  1) [Build]               │  5) [Klipper]             ║
+            ║  2) [Flash]               │  6) [Moonraker]           ║
+            ║  3) [Build + Flash]       │                           ║
+            ║  4) [Get MCU ID]          │ System:                   ║
+            ║                           │  7) [Change hostname]     ║
+            ╟───────────────────────────┴───────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def klipper_rollback(self, **kwargs) -> None:
+        rollback_repository(KLIPPER_DIR, Klipper)
+
+    def moonraker_rollback(self, **kwargs) -> None:
+        rollback_repository(MOONRAKER_DIR, Moonraker)
+
+    def build(self, **kwargs) -> None:
+        KlipperBuildFirmwareMenu(previous_menu=self.__class__).run()
+
+    def flash(self, **kwargs) -> None:
+        KlipperFlashMethodMenu(previous_menu=self.__class__).run()
+
+    def build_flash(self, **kwargs) -> None:
+        KlipperBuildFirmwareMenu(previous_menu=KlipperFlashMethodMenu).run()
+        KlipperFlashMethodMenu(previous_menu=self.__class__).run()
+
+    def get_id(self, **kwargs) -> None:
+        KlipperSelectMcuConnectionMenu(
+            previous_menu=self.__class__,
+            standalone=True,
+        ).run()
+
+    def change_hostname(self, **kwargs) -> None:
+        change_system_hostname()

kiauh/core/menus/backup_menu.py

@@ -0,0 +1,108 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from components.klipper.klipper_utils import backup_klipper_dir
+from components.klipperscreen.klipperscreen import backup_klipperscreen_dir
+from components.moonraker.moonraker_utils import (
+    backup_moonraker_db_dir,
+    backup_moonraker_dir,
+)
+from components.webui_client.client_utils import (
+    backup_client_config_data,
+    backup_client_data,
+)
+from components.webui_client.fluidd_data import FluiddData
+from components.webui_client.mainsail_data import MainsailData
+from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+from utils.common import backup_printer_config_dir
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class BackupMenu(BaseMenu):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
+        super().__init__()
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from core.menus.main_menu import MainMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "1": Option(method=self.backup_klipper),
+            "2": Option(method=self.backup_moonraker),
+            "3": Option(method=self.backup_printer_config),
+            "4": Option(method=self.backup_moonraker_db),
+            "5": Option(method=self.backup_mainsail),
+            "6": Option(method=self.backup_fluidd),
+            "7": Option(method=self.backup_mainsail_config),
+            "8": Option(method=self.backup_fluidd_config),
+            "9": Option(method=self.backup_klipperscreen),
+        }
+
+    def print_menu(self) -> None:
+        header = " [ Backup Menu ] "
+        line1 = f"{COLOR_YELLOW}INFO: Backups are located in '~/kiauh-backups'{RESET_FORMAT}"
+        color = COLOR_CYAN
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ {line1:^62} ║
+            ╟───────────────────────────┬───────────────────────────╢
+            ║ Klipper & Moonraker API:  │ Client-Config:            ║
+            ║  1) [Klipper]             │  7) [Mainsail-Config]     ║
+            ║  2) [Moonraker]           │  8) [Fluidd-Config]       ║
+            ║  3) [Config Folder]       │                           ║
+            ║  4) [Moonraker Database]  │ Touchscreen GUI:          ║
+            ║                           │  9) [KlipperScreen]       ║
+            ║ Webinterface:             │                           ║
+            ║  5) [Mainsail]            │                           ║
+            ║  6) [Fluidd]              │                           ║
+            ╟───────────────────────────┴───────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def backup_klipper(self, **kwargs) -> None:
+        backup_klipper_dir()
+
+    def backup_moonraker(self, **kwargs) -> None:
+        backup_moonraker_dir()
+
+    def backup_printer_config(self, **kwargs) -> None:
+        backup_printer_config_dir()
+
+    def backup_moonraker_db(self, **kwargs) -> None:
+        backup_moonraker_db_dir()
+
+    def backup_mainsail(self, **kwargs) -> None:
+        backup_client_data(MainsailData())
+
+    def backup_fluidd(self, **kwargs) -> None:
+        backup_client_data(FluiddData())
+
+    def backup_mainsail_config(self, **kwargs) -> None:
+        backup_client_config_data(MainsailData())
+
+    def backup_fluidd_config(self, **kwargs) -> None:
+        backup_client_config_data(FluiddData())
+
+    def backup_klipperscreen(self, **kwargs) -> None:
+        backup_klipperscreen_dir()

kiauh/core/menus/base_menu.py

@@ -0,0 +1,223 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from __future__ import annotations
+
+import subprocess
+import sys
+import textwrap
+import traceback
+from abc import abstractmethod
+from typing import Dict, Type
+
+from core.constants import (
+    COLOR_CYAN,
+    COLOR_GREEN,
+    COLOR_RED,
+    COLOR_YELLOW,
+    RESET_FORMAT,
+)
+from core.logger import Logger
+from core.menus import FooterType, Option
+
+
+def clear() -> None:
+    subprocess.call("clear", shell=True)
+
+
+def print_header() -> None:
+    line1 = " [ KIAUH ] "
+    line2 = "Klipper Installation And Update Helper"
+    line3 = ""
+    color = COLOR_CYAN
+    count = 62 - len(color) - len(RESET_FORMAT)
+    header = textwrap.dedent(
+        f"""
+        ╔═══════════════════════════════════════════════════════╗
+        ║ {color}{line1:~^{count}}{RESET_FORMAT} ║
+        ║ {color}{line2:^{count}}{RESET_FORMAT} ║
+        ║ {color}{line3:~^{count}}{RESET_FORMAT} ║
+        ╚═══════════════════════════════════════════════════════╝
+        """
+    )[1:]
+    print(header, end="")
+
+
+def print_quit_footer() -> None:
+    text = "Q) Quit"
+    color = COLOR_RED
+    count = 62 - len(color) - len(RESET_FORMAT)
+    footer = textwrap.dedent(
+        f"""
+        ║ {color}{text:^{count}}{RESET_FORMAT} ║
+        ╚═══════════════════════════════════════════════════════╝
+        """
+    )[1:]
+    print(footer, end="")
+
+
+def print_back_footer() -> None:
+    text = "B) « Back"
+    color = COLOR_GREEN
+    count = 62 - len(color) - len(RESET_FORMAT)
+    footer = textwrap.dedent(
+        f"""
+        ║ {color}{text:^{count}}{RESET_FORMAT} ║
+        ╚═══════════════════════════════════════════════════════╝
+        """
+    )[1:]
+    print(footer, end="")
+
+
+def print_back_help_footer() -> None:
+    text1 = "B) « Back"
+    text2 = "H) Help [?]"
+    color1 = COLOR_GREEN
+    color2 = COLOR_YELLOW
+    count = 34 - len(color1) - len(RESET_FORMAT)
+    footer = textwrap.dedent(
+        f"""
+        ║ {color1}{text1:^{count}}{RESET_FORMAT} │ {color2}{text2:^{count}}{RESET_FORMAT} ║
+        ╚═══════════════════════════╧═══════════════════════════╝
+        """
+    )[1:]
+    print(footer, end="")
+
+
+def print_blank_footer() -> None:
+    print("╚═══════════════════════════════════════════════════════╝")
+
+
+class PostInitCaller(type):
+    def __call__(cls, *args, **kwargs):
+        obj = type.__call__(cls, *args, **kwargs)
+        obj.__post_init__()
+        return obj
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class BaseMenu(metaclass=PostInitCaller):
+    options: Dict[str, Option] = {}
+    options_offset: int = 0
+    default_option: Option = None
+    input_label_txt: str = "Perform action"
+    header: bool = False
+    previous_menu: Type[BaseMenu] | None = None
+    help_menu: Type[BaseMenu] | None = None
+    footer_type: FooterType = FooterType.BACK
+
+    def __init__(self, **kwargs) -> None:
+        if type(self) is BaseMenu:
+            raise NotImplementedError("BaseMenu cannot be instantiated directly.")
+
+    def __post_init__(self) -> None:
+        self.set_previous_menu(self.previous_menu)
+        self.set_options()
+
+        # conditionally add options based on footer type
+        if self.footer_type is FooterType.QUIT:
+            self.options["q"] = Option(method=self.__exit)
+        if self.footer_type is FooterType.BACK:
+            self.options["b"] = Option(method=self.__go_back)
+        if self.footer_type is FooterType.BACK_HELP:
+            self.options["b"] = Option(method=self.__go_back)
+            self.options["h"] = Option(method=self.__go_to_help)
+        # if defined, add the default option to the options dict
+        if self.default_option is not None:
+            self.options[""] = self.default_option
+
+    def __go_back(self, **kwargs) -> None:
+        if self.previous_menu is None:
+            return
+        self.previous_menu().run()
+
+    def __go_to_help(self, **kwargs) -> None:
+        if self.help_menu is None:
+            return
+        self.help_menu(previous_menu=self).run()
+
+    def __exit(self, **kwargs) -> None:
+        Logger.print_ok("###### Happy printing!", False)
+        sys.exit(0)
+
+    @abstractmethod
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    def set_options(self) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    def print_menu(self) -> None:
+        raise NotImplementedError
+
+    def print_footer(self) -> None:
+        if self.footer_type is FooterType.QUIT:
+            print_quit_footer()
+        elif self.footer_type is FooterType.BACK:
+            print_back_footer()
+        elif self.footer_type is FooterType.BACK_HELP:
+            print_back_help_footer()
+        elif self.footer_type is FooterType.BLANK:
+            print_blank_footer()
+        else:
+            raise NotImplementedError("FooterType not correctly implemented!")
+
+    def display_menu(self) -> None:
+        if self.header:
+            print_header()
+        self.print_menu()
+        self.print_footer()
+
+    def validate_user_input(self, usr_input: str) -> Option:
+        """
+        Validate the user input and either return an Option, a string or None
+        :param usr_input: The user input in form of a string
+        :return: Option, str or None
+        """
+        usr_input = usr_input.lower()
+        option = self.options.get(
+            usr_input,
+            Option(method=None, opt_index="", opt_data=None),
+        )
+
+        # if option/usr_input is None/empty string, we execute the menus default option if specified
+        if (option is None or usr_input == "") and self.default_option is not None:
+            self.default_option.opt_index = usr_input
+            return self.default_option
+
+        # user selected a regular option
+        option.opt_index = usr_input
+        return option
+
+    def handle_user_input(self) -> Option:
+        """Handle the user input, return the validated input or print an error."""
+        while True:
+            print(f"{COLOR_CYAN}###### {self.input_label_txt}: {RESET_FORMAT}", end="")
+            usr_input = input().lower()
+            validated_input = self.validate_user_input(usr_input)
+
+            if validated_input.method is not None:
+                return validated_input
+            else:
+                Logger.print_error("Invalid input!", False)
+
+    def run(self) -> None:
+        """Start the menu lifecycle. When this function returns, the lifecycle of the menu ends."""
+        try:
+            self.display_menu()
+            option = self.handle_user_input()
+            option.method(opt_index=option.opt_index, opt_data=option.opt_data)
+            self.run()
+        except Exception as e:
+            Logger.print_error(
+                f"An unexpected error occured:\n{e}\n{traceback.format_exc()}"
+            )

kiauh/core/menus/install_menu.py

@@ -0,0 +1,109 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from components.crowsnest.crowsnest import install_crowsnest
+from components.klipper import klipper_setup
+from components.klipperscreen.klipperscreen import install_klipperscreen
+from components.mobileraker.mobileraker import install_mobileraker
+from components.moonraker import moonraker_setup
+from components.octoeverywhere.octoeverywhere_setup import install_octoeverywhere
+from components.webui_client import client_setup
+from components.webui_client.client_config import client_config_setup
+from components.webui_client.fluidd_data import FluiddData
+from components.webui_client.mainsail_data import MainsailData
+from core.constants import COLOR_GREEN, RESET_FORMAT
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class InstallMenu(BaseMenu):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
+        super().__init__()
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from core.menus.main_menu import MainMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "1": Option(method=self.install_klipper),
+            "2": Option(method=self.install_moonraker),
+            "3": Option(method=self.install_mainsail),
+            "4": Option(method=self.install_fluidd),
+            "5": Option(method=self.install_mainsail_config),
+            "6": Option(method=self.install_fluidd_config),
+            "7": Option(method=self.install_klipperscreen),
+            "8": Option(method=self.install_mobileraker),
+            "9": Option(method=self.install_crowsnest),
+            "10": Option(method=self.install_octoeverywhere),
+        }
+
+    def print_menu(self) -> None:
+        header = " [ Installation Menu ] "
+        color = COLOR_GREEN
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────┬───────────────────────────╢
+            ║ Firmware & API:           │ Touchscreen GUI:          ║
+            ║  1) [Klipper]             │  7) [KlipperScreen]       ║
+            ║  2) [Moonraker]           │                           ║
+            ║                           │ Android / iOS:            ║
+            ║ Webinterface:             │  8) [Mobileraker]         ║
+            ║  3) [Mainsail]            │                           ║
+            ║  4) [Fluidd]              │ Webcam Streamer:          ║
+            ║                           │  9) [Crowsnest]           ║
+            ║ Client-Config:            │                           ║
+            ║  5) [Mainsail-Config]     │ Remote Access:            ║
+            ║  6) [Fluidd-Config]       │ 10) [OctoEverywhere]      ║
+            ║                           │                           ║
+            ╟───────────────────────────┴───────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def install_klipper(self, **kwargs) -> None:
+        klipper_setup.install_klipper()
+
+    def install_moonraker(self, **kwargs) -> None:
+        moonraker_setup.install_moonraker()
+
+    def install_mainsail(self, **kwargs) -> None:
+        client_setup.install_client(MainsailData())
+
+    def install_mainsail_config(self, **kwargs) -> None:
+        client_config_setup.install_client_config(MainsailData())
+
+    def install_fluidd(self, **kwargs) -> None:
+        client_setup.install_client(FluiddData())
+
+    def install_fluidd_config(self, **kwargs) -> None:
+        client_config_setup.install_client_config(FluiddData())
+
+    def install_klipperscreen(self, **kwargs) -> None:
+        install_klipperscreen()
+
+    def install_mobileraker(self, **kwargs) -> None:
+        install_mobileraker()
+
+    def install_crowsnest(self, **kwargs) -> None:
+        install_crowsnest()
+
+    def install_octoeverywhere(self, **kwargs) -> None:
+        install_octoeverywhere()

kiauh/core/menus/main_menu.py

@@ -0,0 +1,189 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import sys
+import textwrap
+from typing import Callable, Type
+
+from components.crowsnest.crowsnest import get_crowsnest_status
+from components.klipper.klipper_utils import get_klipper_status
+from components.klipperscreen.klipperscreen import get_klipperscreen_status
+from components.log_uploads.menus.log_upload_menu import LogUploadMenu
+from components.mobileraker.mobileraker import get_mobileraker_status
+from components.moonraker.moonraker_utils import get_moonraker_status
+from components.octoeverywhere.octoeverywhere_setup import get_octoeverywhere_status
+from components.webui_client.client_utils import (
+    get_client_status,
+    get_current_client_config,
+)
+from components.webui_client.fluidd_data import FluiddData
+from components.webui_client.mainsail_data import MainsailData
+from core.constants import (
+    COLOR_CYAN,
+    COLOR_GREEN,
+    COLOR_MAGENTA,
+    COLOR_RED,
+    COLOR_YELLOW,
+    RESET_FORMAT,
+)
+from core.logger import Logger
+from core.menus import FooterType
+from core.menus.advanced_menu import AdvancedMenu
+from core.menus.backup_menu import BackupMenu
+from core.menus.base_menu import BaseMenu, Option
+from core.menus.install_menu import InstallMenu
+from core.menus.remove_menu import RemoveMenu
+from core.menus.settings_menu import SettingsMenu
+from core.menus.update_menu import UpdateMenu
+from core.types import ComponentStatus, StatusMap, StatusText
+from extensions.extensions_menu import ExtensionsMenu
+from utils.common import get_kiauh_version
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class MainMenu(BaseMenu):
+    def __init__(self) -> None:
+        super().__init__()
+
+        self.header: bool = True
+        self.footer_type: FooterType = FooterType.QUIT
+
+        self.version = ""
+        self.kl_status = self.kl_repo = self.mr_status = self.mr_repo = ""
+        self.ms_status = self.fl_status = self.ks_status = self.mb_status = ""
+        self.cn_status = self.cc_status = self.oe_status = ""
+        self._init_status()
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        """MainMenu does not have a previous menu"""
+        pass
+
+    def set_options(self) -> None:
+        self.options = {
+            "0": Option(method=self.log_upload_menu),
+            "1": Option(method=self.install_menu),
+            "2": Option(method=self.update_menu),
+            "3": Option(method=self.remove_menu),
+            "4": Option(method=self.advanced_menu),
+            "5": Option(method=self.backup_menu),
+            "e": Option(method=self.extension_menu),
+            "s": Option(method=self.settings_menu),
+        }
+
+    def _init_status(self) -> None:
+        status_vars = ["kl", "mr", "ms", "fl", "ks", "mb", "cn", "oe"]
+        for var in status_vars:
+            setattr(
+                self,
+                f"{var}_status",
+                f"{COLOR_RED}Not installed{RESET_FORMAT}",
+            )
+
+    def _fetch_status(self) -> None:
+        self.version = get_kiauh_version()
+        self._get_component_status("kl", get_klipper_status)
+        self._get_component_status("mr", get_moonraker_status)
+        self._get_component_status("ms", get_client_status, MainsailData())
+        self._get_component_status("fl", get_client_status, FluiddData())
+        self.cc_status = get_current_client_config([MainsailData(), FluiddData()])
+        self._get_component_status("ks", get_klipperscreen_status)
+        self._get_component_status("mb", get_mobileraker_status)
+        self._get_component_status("cn", get_crowsnest_status)
+        self._get_component_status("oe", get_octoeverywhere_status)
+
+    def _get_component_status(self, name: str, status_fn: Callable, *args) -> None:
+        status_data: ComponentStatus = status_fn(*args)
+        code: int = status_data.status
+        status: StatusText = StatusMap[code]
+        repo: str = status_data.repo
+        instance_count: int = status_data.instances
+
+        count_txt: str = ""
+        if instance_count > 0 and code == 2:
+            count_txt = f": {instance_count}"
+
+        setattr(self, f"{name}_status", self._format_by_code(code, status, count_txt))
+        setattr(self, f"{name}_repo", f"{COLOR_CYAN}{repo}{RESET_FORMAT}")
+
+    def _format_by_code(self, code: int, status: str, count: str) -> str:
+        color = COLOR_RED
+        if code == 0:
+            color = COLOR_RED
+        elif code == 1:
+            color = COLOR_YELLOW
+        elif code == 2:
+            color = COLOR_GREEN
+
+        return f"{color}{status}{count}{RESET_FORMAT}"
+
+    def print_menu(self) -> None:
+        self._fetch_status()
+
+        header = " [ Main Menu ] "
+        footer1 = f"{COLOR_CYAN}{self.version}{RESET_FORMAT}"
+        footer2 = f"Changelog: {COLOR_MAGENTA}https://git.io/JnmlX{RESET_FORMAT}"
+        color = COLOR_CYAN
+        count = 62 - len(color) - len(RESET_FORMAT)
+        pad1 = 32
+        pad2 = 26
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            ╟──────────────────┬────────────────────────────────────╢
+            ║  0) [Log-Upload] │   Klipper: {self.kl_status:<{pad1}} ║
+            ║                  │      Repo: {self.kl_repo:<{pad1}} ║
+            ║  1) [Install]    ├────────────────────────────────────╢
+            ║  2) [Update]     │ Moonraker: {self.mr_status:<{pad1}} ║
+            ║  3) [Remove]     │      Repo: {self.mr_repo:<{pad1}} ║
+            ║  4) [Advanced]   ├────────────────────────────────────╢
+            ║  5) [Backup]     │        Mainsail: {self.ms_status:<{pad2}} ║
+            ║                  │          Fluidd: {self.fl_status:<{pad2}} ║
+            ║  S) [Settings]   │   Client-Config: {self.cc_status:<{pad2}} ║
+            ║                  │                                    ║
+            ║ Community:       │   KlipperScreen: {self.ks_status:<{pad2}} ║
+            ║  E) [Extensions] │     Mobileraker: {self.mb_status:<{pad2}} ║
+            ║                  │  OctoEverywhere: {self.oe_status:<{pad2}} ║
+            ║                  │       Crowsnest: {self.cn_status:<{pad2}} ║
+            ╟──────────────────┼────────────────────────────────────╢
+            ║ {footer1:^25} │ {footer2:^43} ║
+            ╟──────────────────┴────────────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def exit(self, **kwargs) -> None:
+        Logger.print_ok("###### Happy printing!", False)
+        sys.exit(0)
+
+    def log_upload_menu(self, **kwargs) -> None:
+        LogUploadMenu().run()
+
+    def install_menu(self, **kwargs) -> None:
+        InstallMenu(previous_menu=self.__class__).run()
+
+    def update_menu(self, **kwargs) -> None:
+        UpdateMenu(previous_menu=self.__class__).run()
+
+    def remove_menu(self, **kwargs) -> None:
+        RemoveMenu(previous_menu=self.__class__).run()
+
+    def advanced_menu(self, **kwargs) -> None:
+        AdvancedMenu(previous_menu=self.__class__).run()
+
+    def backup_menu(self, **kwargs) -> None:
+        BackupMenu(previous_menu=self.__class__).run()
+
+    def settings_menu(self, **kwargs) -> None:
+        SettingsMenu(previous_menu=self.__class__).run()
+
+    def extension_menu(self, **kwargs) -> None:
+        ExtensionsMenu(previous_menu=self.__class__).run()

kiauh/core/menus/remove_menu.py

@@ -0,0 +1,102 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from components.crowsnest.crowsnest import remove_crowsnest
+from components.klipper.menus.klipper_remove_menu import KlipperRemoveMenu
+from components.klipperscreen.klipperscreen import remove_klipperscreen
+from components.mobileraker.mobileraker import remove_mobileraker
+from components.moonraker.menus.moonraker_remove_menu import (
+    MoonrakerRemoveMenu,
+)
+from components.octoeverywhere.octoeverywhere_setup import remove_octoeverywhere
+from components.webui_client.fluidd_data import FluiddData
+from components.webui_client.mainsail_data import MainsailData
+from components.webui_client.menus.client_remove_menu import ClientRemoveMenu
+from core.constants import COLOR_RED, RESET_FORMAT
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class RemoveMenu(BaseMenu):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
+        super().__init__()
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from core.menus.main_menu import MainMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "1": Option(method=self.remove_klipper),
+            "2": Option(method=self.remove_moonraker),
+            "3": Option(method=self.remove_mainsail),
+            "4": Option(method=self.remove_fluidd),
+            "5": Option(method=self.remove_klipperscreen),
+            "6": Option(method=self.remove_mobileraker),
+            "7": Option(method=self.remove_crowsnest),
+            "8": Option(method=self.remove_octoeverywhere),
+        }
+
+    def print_menu(self) -> None:
+        header = " [ Remove Menu ] "
+        color = COLOR_RED
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ INFO: Configurations and/or any backups will be kept! ║
+            ╟───────────────────────────┬───────────────────────────╢
+            ║ Firmware & API:           │ Android / iOS:            ║
+            ║  1) [Klipper]             │  6) [Mobileraker]         ║
+            ║  2) [Moonraker]           │                           ║
+            ║                           │ Webcam Streamer:          ║
+            ║ Klipper Webinterface:     │  7) [Crowsnest]           ║
+            ║  3) [Mainsail]            │                           ║
+            ║  4) [Fluidd]              │ Remote Access:            ║
+            ║                           │  8) [OctoEverywhere]      ║
+            ║ Touchscreen GUI:          │                           ║
+            ║  5) [KlipperScreen]       │                           ║
+            ╟───────────────────────────┴───────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def remove_klipper(self, **kwargs) -> None:
+        KlipperRemoveMenu(previous_menu=self.__class__).run()
+
+    def remove_moonraker(self, **kwargs) -> None:
+        MoonrakerRemoveMenu(previous_menu=self.__class__).run()
+
+    def remove_mainsail(self, **kwargs) -> None:
+        ClientRemoveMenu(previous_menu=self.__class__, client=MainsailData()).run()
+
+    def remove_fluidd(self, **kwargs) -> None:
+        ClientRemoveMenu(previous_menu=self.__class__, client=FluiddData()).run()
+
+    def remove_klipperscreen(self, **kwargs) -> None:
+        remove_klipperscreen()
+
+    def remove_mobileraker(self, **kwargs) -> None:
+        remove_mobileraker()
+
+    def remove_crowsnest(self, **kwargs) -> None:
+        remove_crowsnest()
+
+    def remove_octoeverywhere(self, **kwargs) -> None:
+        remove_octoeverywhere()

kiauh/core/menus/settings_menu.py

@@ -0,0 +1,209 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import shutil
+import textwrap
+from pathlib import Path
+from typing import Tuple, Type
+
+from components.klipper import KLIPPER_DIR
+from components.klipper.klipper import Klipper
+from components.moonraker import MOONRAKER_DIR
+from components.moonraker.moonraker import Moonraker
+from core.constants import COLOR_CYAN, COLOR_GREEN, RESET_FORMAT
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+from core.settings.kiauh_settings import KiauhSettings
+from utils.git_utils import git_clone_wrapper
+from utils.input_utils import get_confirm, get_string_input
+from utils.instance_utils import get_instances
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class SettingsMenu(BaseMenu):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
+        super().__init__()
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+        self.klipper_repo: str | None = None
+        self.moonraker_repo: str | None = None
+        self.mainsail_unstable: bool | None = None
+        self.fluidd_unstable: bool | None = None
+        self.auto_backups_enabled: bool | None = None
+        self._load_settings()
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from core.menus.main_menu import MainMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "1": Option(method=self.set_klipper_repo),
+            "2": Option(method=self.set_moonraker_repo),
+            "3": Option(method=self.toggle_mainsail_release),
+            "4": Option(method=self.toggle_fluidd_release),
+            "5": Option(method=self.toggle_backup_before_update),
+        }
+
+    def print_menu(self) -> None:
+        header = " [ KIAUH Settings ] "
+        color = COLOR_CYAN
+        count = 62 - len(color) - len(RESET_FORMAT)
+        checked = f"[{COLOR_GREEN}x{RESET_FORMAT}]"
+        unchecked = "[ ]"
+        o1 = checked if self.mainsail_unstable else unchecked
+        o2 = checked if self.fluidd_unstable else unchecked
+        o3 = checked if self.auto_backups_enabled else unchecked
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ Klipper source repository:                            ║
+            ║   ● {self.klipper_repo:<67} ║
+            ║                                                       ║
+            ║ Moonraker source repository:                          ║
+            ║   ● {self.moonraker_repo:<67} ║
+            ║                                                       ║
+            ║ Install unstable Webinterface releases:               ║
+            ║  {o1} Mainsail                                         ║
+            ║  {o2} Fluidd                                           ║
+            ║                                                       ║
+            ║ Auto-Backup:                                          ║
+            ║  {o3} Automatic backup before update                   ║
+            ║                                                       ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ 1) Set Klipper source repository                      ║
+            ║ 2) Set Moonraker source repository                    ║
+            ║                                                       ║
+            ║ 3) Toggle unstable Mainsail releases                  ║
+            ║ 4) Toggle unstable Fluidd releases                    ║
+            ║                                                       ║
+            ║ 5) Toggle automatic backups before updates            ║
+            ╟───────────────────────────────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def _load_settings(self) -> None:
+        self.settings = KiauhSettings()
+
+        self._format_repo_str("klipper")
+        self._format_repo_str("moonraker")
+
+        self.auto_backups_enabled = self.settings.kiauh.backup_before_update
+        self.mainsail_unstable = self.settings.mainsail.unstable_releases
+        self.fluidd_unstable = self.settings.fluidd.unstable_releases
+
+    def _format_repo_str(self, repo_name: str) -> None:
+        repo = self.settings.get(repo_name, "repo_url")
+        repo = f"{'/'.join(repo.rsplit('/', 2)[-2:])}"
+        branch = self.settings.get(repo_name, "branch")
+        branch = f"({COLOR_CYAN}@ {branch}{RESET_FORMAT})"
+        setattr(self, f"{repo_name}_repo", f"{COLOR_CYAN}{repo}{RESET_FORMAT} {branch}")
+
+    def _gather_input(self) -> Tuple[str, str]:
+        Logger.print_dialog(
+            DialogType.ATTENTION,
+            [
+                "There is no input validation in place! Make sure your"
+                " input is valid and has no typos! For any change to"
+                " take effect, the repository must be cloned again. "
+                "Make sure you don't have any ongoing prints running, "
+                "as the services will be restarted!"
+            ],
+        )
+        repo = get_string_input(
+            "Enter new repository URL",
+            allow_special_chars=True,
+        )
+        branch = get_string_input(
+            "Enter new branch name",
+            allow_special_chars=True,
+        )
+
+        return repo, branch
+
+    def _set_repo(self, repo_name: str) -> None:
+        repo_url, branch = self._gather_input()
+        display_name = repo_name.capitalize()
+        Logger.print_dialog(
+            DialogType.CUSTOM,
+            [
+                f"New {display_name} repository URL:",
+                f"● {repo_url}",
+                f"New {display_name} repository branch:",
+                f"● {branch}",
+            ],
+        )
+
+        if get_confirm("Apply changes?", allow_go_back=True):
+            self.settings.set(repo_name, "repo_url", repo_url)
+            self.settings.set(repo_name, "branch", branch)
+            self.settings.save()
+            self._load_settings()
+            Logger.print_ok("Changes saved!")
+        else:
+            Logger.print_info(
+                f"Skipping change of {display_name} source repository  ..."
+            )
+            return
+
+        Logger.print_status(f"Switching to {display_name}'s new source repository ...")
+        self._switch_repo(repo_name)
+        Logger.print_ok(f"Switched to {repo_url} at branch {branch}!")
+
+    def _switch_repo(self, name: str) -> None:
+        target_dir: Path
+        if name == "klipper":
+            target_dir = KLIPPER_DIR
+            _type = Klipper
+        elif name == "moonraker":
+            target_dir = MOONRAKER_DIR
+            _type = Moonraker
+        else:
+            Logger.print_error("Invalid repository name!")
+            return
+
+        if target_dir.exists():
+            shutil.rmtree(target_dir)
+
+        instances = get_instances(_type)
+        InstanceManager.stop_all(instances)
+
+        repo = self.settings.get(name, "repo_url")
+        branch = self.settings.get(name, "branch")
+        git_clone_wrapper(repo, target_dir, branch)
+
+        InstanceManager.start_all(instances)
+
+    def set_klipper_repo(self, **kwargs) -> None:
+        self._set_repo("klipper")
+
+    def set_moonraker_repo(self, **kwargs) -> None:
+        self._set_repo("moonraker")
+
+    def toggle_mainsail_release(self, **kwargs) -> None:
+        self.mainsail_unstable = not self.mainsail_unstable
+        self.settings.mainsail.unstable_releases = self.mainsail_unstable
+        self.settings.save()
+
+    def toggle_fluidd_release(self, **kwargs) -> None:
+        self.fluidd_unstable = not self.fluidd_unstable
+        self.settings.fluidd.unstable_releases = self.fluidd_unstable
+        self.settings.save()
+
+    def toggle_backup_before_update(self, **kwargs) -> None:
+        self.auto_backups_enabled = not self.auto_backups_enabled
+        self.settings.kiauh.backup_before_update = self.auto_backups_enabled
+        self.settings.save()

kiauh/core/menus/update_menu.py

@@ -0,0 +1,291 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Callable, List, Type
+
+from components.crowsnest.crowsnest import get_crowsnest_status, update_crowsnest
+from components.klipper.klipper_setup import update_klipper
+from components.klipper.klipper_utils import (
+    get_klipper_status,
+)
+from components.klipperscreen.klipperscreen import (
+    get_klipperscreen_status,
+    update_klipperscreen,
+)
+from components.mobileraker.mobileraker import (
+    get_mobileraker_status,
+    update_mobileraker,
+)
+from components.moonraker.moonraker_setup import update_moonraker
+from components.moonraker.moonraker_utils import get_moonraker_status
+from components.octoeverywhere.octoeverywhere_setup import (
+    get_octoeverywhere_status,
+    update_octoeverywhere,
+)
+from components.webui_client.client_config.client_config_setup import (
+    update_client_config,
+)
+from components.webui_client.client_setup import update_client
+from components.webui_client.client_utils import (
+    get_client_config_status,
+    get_client_status,
+)
+from components.webui_client.fluidd_data import FluiddData
+from components.webui_client.mainsail_data import MainsailData
+from core.constants import (
+    COLOR_GREEN,
+    COLOR_RED,
+    COLOR_YELLOW,
+    RESET_FORMAT,
+)
+from core.logger import DialogType, Logger
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+from core.spinner import Spinner
+from core.types import ComponentStatus
+from utils.input_utils import get_confirm
+from utils.sys_utils import (
+    get_upgradable_packages,
+    update_system_package_lists,
+    upgrade_system_packages,
+)
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class UpdateMenu(BaseMenu):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
+        super().__init__()
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+        self.packages: List[str] = []
+        self.package_count: int = 0
+
+        self.klipper_local = self.klipper_remote = ""
+        self.moonraker_local = self.moonraker_remote = ""
+        self.mainsail_local = self.mainsail_remote = ""
+        self.mainsail_config_local = self.mainsail_config_remote = ""
+        self.fluidd_local = self.fluidd_remote = ""
+        self.fluidd_config_local = self.fluidd_config_remote = ""
+        self.klipperscreen_local = self.klipperscreen_remote = ""
+        self.mobileraker_local = self.mobileraker_remote = ""
+        self.crowsnest_local = self.crowsnest_remote = ""
+        self.octoeverywhere_local = self.octoeverywhere_remote = ""
+
+        self.mainsail_data = MainsailData()
+        self.fluidd_data = FluiddData()
+        self.status_data = {
+            "klipper": {"installed": False, "local": None, "remote": None},
+            "moonraker": {"installed": False, "local": None, "remote": None},
+            "mainsail": {"installed": False, "local": None, "remote": None},
+            "mainsail_config": {"installed": False, "local": None, "remote": None},
+            "fluidd": {"installed": False, "local": None, "remote": None},
+            "fluidd_config": {"installed": False, "local": None, "remote": None},
+            "mobileraker": {"installed": False, "local": None, "remote": None},
+            "klipperscreen": {"installed": False, "local": None, "remote": None},
+            "crowsnest": {"installed": False, "local": None, "remote": None},
+            "octoeverywhere": {"installed": False, "local": None, "remote": None},
+        }
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from core.menus.main_menu import MainMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "a": Option(self.update_all),
+            "1": Option(self.update_klipper),
+            "2": Option(self.update_moonraker),
+            "3": Option(self.update_mainsail),
+            "4": Option(self.update_fluidd),
+            "5": Option(self.update_mainsail_config),
+            "6": Option(self.update_fluidd_config),
+            "7": Option(self.update_klipperscreen),
+            "8": Option(self.update_mobileraker),
+            "9": Option(self.update_crowsnest),
+            "10": Option(self.update_octoeverywhere),
+            "11": Option(self.upgrade_system_packages),
+        }
+
+    def print_menu(self) -> None:
+        spinner = Spinner("Loading update menu, please wait", color="green")
+        spinner.start()
+
+        self._fetch_update_status()
+
+        spinner.stop()
+
+        header = " [ Update Menu ] "
+        color = COLOR_GREEN
+        count = 62 - len(color) - len(RESET_FORMAT)
+
+        sysupgrades: str = "No upgrades available."
+        padding = 29
+        if self.package_count > 0:
+            sysupgrades = (
+                f"{COLOR_GREEN}{self.package_count} upgrades available!{RESET_FORMAT}"
+            )
+            padding = 38
+
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────┬───────────────┬───────────────╢
+            ║  a) Update all        │               │               ║
+            ║                       │ Current:      │ Latest:       ║
+            ║ Klipper & API:        ├───────────────┼───────────────╢
+            ║  1) Klipper           │ {self.klipper_local:<22} │ {self.klipper_remote:<22} ║
+            ║  2) Moonraker         │ {self.moonraker_local:<22} │ {self.moonraker_remote:<22} ║
+            ║                       │               │               ║
+            ║ Webinterface:         ├───────────────┼───────────────╢
+            ║  3) Mainsail          │ {self.mainsail_local:<22} │ {self.mainsail_remote:<22} ║
+            ║  4) Fluidd            │ {self.fluidd_local:<22} │ {self.fluidd_remote:<22} ║
+            ║                       │               │               ║
+            ║ Client-Config:        ├───────────────┼───────────────╢
+            ║  5) Mainsail-Config   │ {self.mainsail_config_local:<22} │ {self.mainsail_config_remote:<22} ║
+            ║  6) Fluidd-Config     │ {self.fluidd_config_local:<22} │ {self.fluidd_config_remote:<22} ║
+            ║                       │               │               ║
+            ║ Other:                ├───────────────┼───────────────╢
+            ║  7) KlipperScreen     │ {self.klipperscreen_local:<22} │ {self.klipperscreen_remote:<22} ║
+            ║  8) Mobileraker       │ {self.mobileraker_local:<22} │ {self.mobileraker_remote:<22} ║
+            ║  9) Crowsnest         │ {self.crowsnest_local:<22} │ {self.crowsnest_remote:<22} ║
+            ║ 10) OctoEverywhere    │ {self.octoeverywhere_local:<22} │ {self.octoeverywhere_remote:<22} ║
+            ║                       ├───────────────┴───────────────╢
+            ║ 11) System            │ {sysupgrades:^{padding}} ║
+            ╟───────────────────────┴───────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def update_all(self, **kwargs) -> None:
+        print("update_all")
+
+    def update_klipper(self, **kwargs) -> None:
+        if self._check_is_installed("klipper"):
+            update_klipper()
+
+    def update_moonraker(self, **kwargs) -> None:
+        if self._check_is_installed("moonraker"):
+            update_moonraker()
+
+    def update_mainsail(self, **kwargs) -> None:
+        if self._check_is_installed("mainsail"):
+            update_client(self.mainsail_data)
+
+    def update_mainsail_config(self, **kwargs) -> None:
+        if self._check_is_installed("mainsail_config"):
+            update_client_config(self.mainsail_data)
+
+    def update_fluidd(self, **kwargs) -> None:
+        if self._check_is_installed("fluidd"):
+            update_client(self.fluidd_data)
+
+    def update_fluidd_config(self, **kwargs) -> None:
+        if self._check_is_installed("fluidd_config"):
+            update_client_config(self.fluidd_data)
+
+    def update_klipperscreen(self, **kwargs) -> None:
+        if self._check_is_installed("klipperscreen"):
+            update_klipperscreen()
+
+    def update_mobileraker(self, **kwargs) -> None:
+        if self._check_is_installed("mobileraker"):
+            update_mobileraker()
+
+    def update_crowsnest(self, **kwargs) -> None:
+        if self._check_is_installed("crowsnest"):
+            update_crowsnest()
+
+    def update_octoeverywhere(self, **kwargs) -> None:
+        if self._check_is_installed("octoeverywhere"):
+            update_octoeverywhere()
+
+    def upgrade_system_packages(self, **kwargs) -> None:
+        self._run_system_updates()
+
+    def _fetch_update_status(self) -> None:
+        self._set_status_data("klipper", get_klipper_status)
+        self._set_status_data("moonraker", get_moonraker_status)
+        self._set_status_data("mainsail", get_client_status, self.mainsail_data, True)
+        self._set_status_data(
+            "mainsail_config", get_client_config_status, self.mainsail_data
+        )
+        self._set_status_data("fluidd", get_client_status, self.fluidd_data, True)
+        self._set_status_data(
+            "fluidd_config", get_client_config_status, self.fluidd_data
+        )
+        self._set_status_data("klipperscreen", get_klipperscreen_status)
+        self._set_status_data("mobileraker", get_mobileraker_status)
+        self._set_status_data("crowsnest", get_crowsnest_status)
+        self._set_status_data("octoeverywhere", get_octoeverywhere_status)
+
+        update_system_package_lists(silent=True)
+        self.packages = get_upgradable_packages()
+        self.package_count = len(self.packages)
+
+    def _format_local_status(self, local_version, remote_version) -> str:
+        color = COLOR_RED
+        if not local_version:
+            color = COLOR_RED
+        elif local_version == remote_version:
+            color = COLOR_GREEN
+        elif local_version != remote_version:
+            color = COLOR_YELLOW
+
+        return f"{color}{local_version or '-'}{RESET_FORMAT}"
+
+    def _set_status_data(self, name: str, status_fn: Callable, *args) -> None:
+        comp_status: ComponentStatus = status_fn(*args)
+
+        self.status_data[name]["installed"] = True if comp_status.status == 2 else False
+        self.status_data[name]["local"] = comp_status.local
+        self.status_data[name]["remote"] = comp_status.remote
+
+        self._set_status_string(name)
+
+    def _set_status_string(self, name: str) -> None:
+        local_status = self.status_data[name].get("local", None)
+        remote_status = self.status_data[name].get("remote", None)
+
+        color = COLOR_GREEN if remote_status else COLOR_RED
+        local_txt = self._format_local_status(local_status, remote_status)
+        remote_txt = f"{color}{remote_status or '-'}{RESET_FORMAT}"
+
+        setattr(self, f"{name}_local", local_txt)
+        setattr(self, f"{name}_remote", remote_txt)
+
+    def _check_is_installed(self, name: str) -> bool:
+        if not self.status_data[name]["installed"]:
+            Logger.print_info(f"{name.capitalize()} is not installed! Skipped ...")
+            return False
+        return True
+
+    def _run_system_updates(self) -> None:
+        if not self.packages:
+            Logger.print_info("No system upgrades available!")
+            return
+
+        try:
+            pkgs: str = ", ".join(self.packages)
+            Logger.print_dialog(
+                DialogType.CUSTOM,
+                ["The following packages will be upgraded:", "\n\n", pkgs],
+                custom_title="UPGRADABLE SYSTEM UPDATES",
+            )
+            if not get_confirm("Continue?"):
+                return
+            Logger.print_status("Upgrading system packages ...")
+            upgrade_system_packages(self.packages)
+        except Exception as e:
+            Logger.print_error(f"Error upgrading system packages:\n{e}")
+            raise

kiauh/core/settings/kiauh_settings.py

@@ -0,0 +1,222 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+from core.logger import DialogType, Logger
+from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+    NoOptionError,
+    NoSectionError,
+    SimpleConfigParser,
+)
+from utils.sys_utils import kill
+
+from kiauh import PROJECT_ROOT
+
+DEFAULT_CFG = PROJECT_ROOT.joinpath("default.kiauh.cfg")
+CUSTOM_CFG = PROJECT_ROOT.joinpath("kiauh.cfg")
+
+
+class AppSettings:
+    def __init__(self) -> None:
+        self.backup_before_update = None
+
+
+class KlipperSettings:
+    def __init__(self) -> None:
+        self.repo_url = None
+        self.branch = None
+
+
+class MoonrakerSettings:
+    def __init__(self) -> None:
+        self.repo_url = None
+        self.branch = None
+
+
+class MainsailSettings:
+    def __init__(self) -> None:
+        self.port = None
+        self.unstable_releases = None
+
+
+class FluiddSettings:
+    def __init__(self) -> None:
+        self.port = None
+        self.unstable_releases = None
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KiauhSettings:
+    _instance = None
+
+    def __new__(cls, *args, **kwargs) -> "KiauhSettings":
+        if cls._instance is None:
+            cls._instance = super(KiauhSettings, cls).__new__(cls, *args, **kwargs)
+        return cls._instance
+
+    def __init__(self) -> None:
+        if not hasattr(self, "__initialized"):
+            self.__initialized = False
+        if self.__initialized:
+            return
+        self.__initialized = True
+        self.config = SimpleConfigParser()
+        self.kiauh = AppSettings()
+        self.klipper = KlipperSettings()
+        self.moonraker = MoonrakerSettings()
+        self.mainsail = MainsailSettings()
+        self.fluidd = FluiddSettings()
+
+        self.kiauh.backup_before_update = None
+        self.klipper.repo_url = None
+        self.klipper.branch = None
+        self.moonraker.repo_url = None
+        self.moonraker.branch = None
+        self.mainsail.port = None
+        self.mainsail.unstable_releases = None
+        self.fluidd.port = None
+        self.fluidd.unstable_releases = None
+
+        self._load_config()
+
+    def get(self, section: str, option: str) -> str | int | bool:
+        """
+        Get a value from the settings state by providing the section and option name as strings.
+        Prefer direct access to the properties, as it is usually safer!
+        :param section: The section name as string.
+        :param option: The option name as string.
+        :return: The value of the option as string, int or bool.
+        """
+
+        try:
+            section = getattr(self, section)
+            value = getattr(section, option)
+            return value  # type: ignore
+        except AttributeError:
+            raise
+
+    def set(self, section: str, option: str, value: str | int | bool) -> None:
+        """
+        Set a value in the settings state by providing the section and option name as strings.
+        Prefer direct access to the properties, as it is usually safer!
+        :param section: The section name as string.
+        :param option: The option name as string.
+        :param value: The value to set as string, int or bool.
+        """
+        try:
+            section = getattr(self, section)
+            section.option = value  # type: ignore
+        except AttributeError:
+            raise
+
+    def save(self) -> None:
+        self._set_config_options()
+        self.config.write(CUSTOM_CFG)
+        self._load_config()
+
+    def _load_config(self) -> None:
+        if not CUSTOM_CFG.exists() and not DEFAULT_CFG.exists():
+            self._kill()
+
+        cfg = CUSTOM_CFG if CUSTOM_CFG.exists() else DEFAULT_CFG
+        self.config.read(cfg)
+
+        self._validate_cfg()
+        self._read_settings()
+
+    def _validate_cfg(self) -> None:
+        try:
+            self._validate_bool("kiauh", "backup_before_update")
+
+            self._validate_str("klipper", "repo_url")
+            self._validate_str("klipper", "branch")
+
+            self._validate_int("mainsail", "port")
+            self._validate_bool("mainsail", "unstable_releases")
+
+            self._validate_int("fluidd", "port")
+            self._validate_bool("fluidd", "unstable_releases")
+
+        except ValueError:
+            err = f"Invalid value for option '{self._v_option}' in section '{self._v_section}'"
+            Logger.print_error(err)
+            kill()
+        except NoSectionError:
+            err = f"Missing section '{self._v_section}' in config file"
+            Logger.print_error(err)
+            kill()
+        except NoOptionError:
+            err = f"Missing option '{self._v_option}' in section '{self._v_section}'"
+            Logger.print_error(err)
+            kill()
+
+    def _validate_bool(self, section: str, option: str) -> None:
+        self._v_section, self._v_option = (section, option)
+        bool(self.config.getboolean(section, option))
+
+    def _validate_int(self, section: str, option: str) -> None:
+        self._v_section, self._v_option = (section, option)
+        int(self.config.getint(section, option))
+
+    def _validate_str(self, section: str, option: str) -> None:
+        self._v_section, self._v_option = (section, option)
+        v = self.config.get(section, option)
+        if v.isdigit() or v.lower() == "true" or v.lower() == "false":
+            raise ValueError
+
+    def _read_settings(self) -> None:
+        self.kiauh.backup_before_update = self.config.getboolean(
+            "kiauh", "backup_before_update"
+        )
+        self.klipper.repo_url = self.config.get("klipper", "repo_url")
+        self.klipper.branch = self.config.get("klipper", "branch")
+        self.moonraker.repo_url = self.config.get("moonraker", "repo_url")
+        self.moonraker.branch = self.config.get("moonraker", "branch")
+        self.mainsail.port = self.config.getint("mainsail", "port")
+        self.mainsail.unstable_releases = self.config.getboolean(
+            "mainsail", "unstable_releases"
+        )
+        self.fluidd.port = self.config.getint("fluidd", "port")
+        self.fluidd.unstable_releases = self.config.getboolean(
+            "fluidd", "unstable_releases"
+        )
+
+    def _set_config_options(self) -> None:
+        self.config.set(
+            "kiauh",
+            "backup_before_update",
+            str(self.kiauh.backup_before_update),
+        )
+        self.config.set("klipper", "repo_url", self.klipper.repo_url)
+        self.config.set("klipper", "branch", self.klipper.branch)
+        self.config.set("moonraker", "repo_url", self.moonraker.repo_url)
+        self.config.set("moonraker", "branch", self.moonraker.branch)
+        self.config.set("mainsail", "port", str(self.mainsail.port))
+        self.config.set(
+            "mainsail",
+            "unstable_releases",
+            str(self.mainsail.unstable_releases),
+        )
+        self.config.set("fluidd", "port", str(self.fluidd.port))
+        self.config.set(
+            "fluidd", "unstable_releases", str(self.fluidd.unstable_releases)
+        )
+
+    def _kill(self) -> None:
+        Logger.print_dialog(
+            DialogType.ERROR,
+            [
+                "No KIAUH configuration file found! Please make sure you have at least "
+                "one of the following configuration files in KIAUH's root directory:",
+                "● default.kiauh.cfg",
+                "● kiauh.cfg",
+            ],
+        )
+        kill()

kiauh/core/spinner.py

@@ -0,0 +1,61 @@
+import sys
+import threading
+import time
+from typing import List, Literal
+
+from core.constants import (
+    COLOR_GREEN,
+    COLOR_RED,
+    COLOR_WHITE,
+    COLOR_YELLOW,
+    RESET_FORMAT,
+)
+
+SpinnerColor = Literal["white", "red", "green", "yellow"]
+
+
+class Spinner:
+    def __init__(
+        self,
+        message: str = "Loading",
+        color: SpinnerColor = "white",
+        interval: float = 0.2,
+    ) -> None:
+        self.message = f"{message} ..."
+        self.interval = interval
+        self._stop_event = threading.Event()
+        self._thread = threading.Thread(target=self._animate)
+        self._color = ""
+        self._set_color(color)
+
+    def _animate(self) -> None:
+        animation: List[str] = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]
+        while not self._stop_event.is_set():
+            for char in animation:
+                sys.stdout.write(f"\r{self._color}{char}{RESET_FORMAT} {self.message}")
+                sys.stdout.flush()
+                time.sleep(self.interval)
+                if self._stop_event.is_set():
+                    break
+        sys.stdout.write("\r" + " " * (len(self.message) + 1) + "\r")
+        sys.stdout.flush()
+
+    def _set_color(self, color: SpinnerColor) -> None:
+        if color == "white":
+            self._color = COLOR_WHITE
+        elif color == "red":
+            self._color = COLOR_RED
+        elif color == "green":
+            self._color = COLOR_GREEN
+        elif color == "yellow":
+            self._color = COLOR_YELLOW
+
+    def start(self) -> None:
+        self._stop_event.clear()
+        if not self._thread.is_alive():
+            self._thread = threading.Thread(target=self._animate)
+            self._thread.start()
+
+    def stop(self) -> None:
+        self._stop_event.set()
+        self._thread.join()

kiauh/core/submodules/simple_config_parser/.editorconfig

@@ -0,0 +1,13 @@
+# see https://editorconfig.org/
+root = true
+
+[*]
+end_of_line = lf
+trim_trailing_whitespace = true
+indent_style = space
+insert_final_newline = true
+indent_size = 4
+charset = utf-8
+
+[*.py]
+max_line_length = 88

kiauh/core/submodules/simple_config_parser/.gitignore

@@ -0,0 +1,13 @@
+*.py[cod]
+*.pyc
+__pycache__
+.pytest_cache/
+
+.idea/
+.vscode/
+
+.venv*/
+venv*/
+
+.coverage
+htmlcov/

kiauh/core/submodules/simple_config_parser/LICENSE

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    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, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

kiauh/core/submodules/simple_config_parser/README.md

@@ -0,0 +1,6 @@
+# Simple Config Parser
+
+A custom config parser inspired by Python's configparser module.
+Specialized for handling Klipper style config files.
+
+

kiauh/core/submodules/simple_config_parser/pyproject.toml

@@ -0,0 +1,66 @@
+[project]
+name = "simple-config-parser"
+version = "0.0.1"
+description = "A simple config parser for Python"
+authors = [
+    {name = "Dominik Willner", email = "th33xitus@gmail.com"},
+]
+readme = "README.md"
+license = {text = "GPL-3.0-only"}
+requires-python = ">=3.8"
+
+[project.urls]
+homepage = "https://github.com/dw-0/simple-config-parser"
+repository = "https://github.com/dw-0/simple-config-parser"
+documentation = "https://github.com/dw-0/simple-config-parser"
+
+[project.optional-dependencies]
+dev=["ruff"]
+
+[tool.ruff]
+required-version = ">=0.3.4"
+respect-gitignore = true
+exclude = [".git",".github", "./docs"]
+line-length = 88
+indent-width = 4
+output-format = "full"
+
+[tool.ruff.format]
+indent-style = "space"
+line-ending = "lf"
+quote-style = "double"
+
+[tool.ruff.lint]
+extend-select = ["I"]
+
+[tool.pytest.ini_options]
+minversion = "8.2.1"
+testpaths = ["tests/**/*.py"]
+addopts = "--cov --cov-config=pyproject.toml --cov-report=html"
+
+[tool.coverage.run]
+branch = true
+source = ["src.simple_config_parser"]
+
+[tool.coverage.report]
+# Regexes for lines to exclude from consideration
+exclude_also = [
+    # Don't complain about missing debug-only code:
+    "def __repr__",
+    "if self\\.debug",
+
+    # Don't complain if tests don't hit defensive assertion code:
+    "raise AssertionError",
+    "raise NotImplementedError",
+
+    # Don't complain if non-runnable code isn't run:
+    "if 0:",
+    "if __name__ == .__main__.:",
+
+    # Don't complain about abstract methods, they aren't run:
+    "@(abc\\.)?abstractmethod",
+    ]
+
+[tool.coverage.html]
+title = "SimpleConfigParser Coverage Report"
+directory = "htmlcov"

kiauh/core/submodules/simple_config_parser/requirements-dev.txt

@@ -0,0 +1,3 @@
+ruff >= 0.3.4
+pytest >= 8.2.1
+pytest-cov >= 5.0.0

kiauh/core/submodules/simple_config_parser/src/simple_config_parser/simple_config_parser.py

@@ -0,0 +1,552 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  https://github.com/dw-0/simple-config-parser                           #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from __future__ import annotations
+
+import re
+from pathlib import Path
+from typing import Callable, Dict, List, Match, Tuple, TypedDict
+
+_UNSET = object()
+
+
+class Section(TypedDict):
+    """
+    A single section in the config file
+
+    - _raw: The raw representation of the section name
+    - options: A list of options in the section
+    """
+
+    _raw: str
+    options: List[Option]
+
+
+class Option(TypedDict, total=False):
+    """
+    A single option in a section in the config file
+
+    - is_multiline: Whether the option is a multiline option
+    - option: The name of the option
+    - value: The value of the option
+    - _raw: The raw representation of the option
+    - _raw_value: The raw value of the option
+
+    A multinline option is an option that contains multiple lines of text following
+    the option name in the next line. The value of a multiline option is a list of
+    strings, where each string represents a single line of text.
+    """
+
+    is_multiline: bool
+    option: str
+    value: str | List[str]
+    _raw: str
+    _raw_value: str | List[str]
+
+
+class NoSectionError(Exception):
+    """Raised when a section is not defined"""
+
+    def __init__(self, section: str):
+        msg = f"Section '{section}' is not defined"
+        super().__init__(msg)
+
+
+class NoOptionError(Exception):
+    """Raised when an option is not defined in a section"""
+
+    def __init__(self, option: str, section: str):
+        msg = f"Option '{option}' in section '{section}' is not defined"
+        super().__init__(msg)
+
+
+class DuplicateSectionError(Exception):
+    """Raised when a section is defined more than once"""
+
+    def __init__(self, section: str):
+        msg = f"Section '{section}' is defined more than once"
+        super().__init__(msg)
+
+
+class DuplicateOptionError(Exception):
+    """Raised when an option is defined more than once"""
+
+    def __init__(self, option: str, section: str):
+        msg = f"Option '{option}' in section '{section}' is defined more than once"
+        super().__init__(msg)
+
+
+# noinspection PyMethodMayBeStatic
+class SimpleConfigParser:
+    """A customized config parser targeted at handling Klipper style config files"""
+
+    _SECTION_RE = re.compile(r"\s*\[(\w+\s?.+)]\s*([#;].*)?$")
+    _OPTION_RE = re.compile(r"^\s*(\w+)\s*[:=]\s*([^=:].*)\s*([#;].*)?$")
+    _MLOPTION_RE = re.compile(r"^\s*(\w+)\s*[:=]\s*([#;].*)?$")
+    _COMMENT_RE = re.compile(r"^\s*([#;].*)?$")
+    _EMPTY_LINE_RE = re.compile(r"^\s*$")
+
+    BOOLEAN_STATES = {
+        "1": True,
+        "yes": True,
+        "true": True,
+        "on": True,
+        "0": False,
+        "no": False,
+        "false": False,
+        "off": False,
+    }
+
+    def __init__(self):
+        self._config: Dict = {}
+        self._header: List[str] = []
+        self._all_sections: List[str] = []
+        self._all_options: Dict = {}
+        self.section_name: str = ""
+        self.in_option_block: bool = False  # whether we are in a multiline option block
+
+    def read(self, file: Path) -> None:
+        """
+        Read the given file and store the result in the internal state.
+        Call this method before using any other methods. Calling this method
+        multiple times will reset the internal state on each call.
+        """
+
+        self._reset_state()
+
+        try:
+            with open(file, "r") as f:
+                self._parse_config(f.readlines())
+
+        except OSError:
+            raise
+
+    def _reset_state(self):
+        """Reset the internal state."""
+
+        self._config.clear()
+        self._header.clear()
+        self._all_sections.clear()
+        self._all_options.clear()
+        self.section_name = ""
+        self.in_option_block = False
+
+    def write(self, filename):
+        """Write the internal state to the given file"""
+
+        content = self._construct_content()
+
+        with open(filename, "w") as f:
+            f.write(content)
+
+    def _construct_content(self) -> str:
+        """
+        Constructs the content of the configuration file based on the internal state of
+        the _config object by iterating over the sections and their options. It starts
+        by checking if a header is present and extends the content list with its elements.
+        Then, for each section, it appends the raw representation of the section to the
+        content list. If the section has a body, it iterates over its options and extends
+        the content list with their raw representations. If an option is multiline, it
+        also extends the content list with its raw value. Finally, the content list is
+        joined into a single string and returned.
+
+        :return: The content of the configuration file as a string
+        """
+        content: List[str] = []
+        if self._header is not None:
+            content.extend(self._header)
+        for section in self._config:
+            content.append(self._config[section]["_raw"])
+
+            if (sec_body := self._config[section].get("body")) is not None:
+                for option in sec_body:
+                    content.extend(option["_raw"])
+                    if option["is_multiline"]:
+                        content.extend(option["_raw_value"])
+        content: str = "".join(content)
+
+        return content
+
+    def sections(self) -> List[str]:
+        """Return a list of section names"""
+
+        return self._all_sections
+
+    def add_section(self, section: str) -> None:
+        """Add a new section to the internal state"""
+
+        if section in self._all_sections:
+            raise DuplicateSectionError(section)
+        self._all_sections.append(section)
+        self._all_options[section] = {}
+        self._config[section] = {"_raw": f"\n[{section}]\n", "body": []}
+
+    def remove_section(self, section: str) -> None:
+        """Remove the given section"""
+
+        if section not in self._all_sections:
+            raise NoSectionError(section)
+
+        self._all_sections.pop(self._all_sections.index(section))
+        self._all_options.pop(section)
+        self._config.pop(section)
+
+    def options(self, section) -> List[str]:
+        """Return a list of option names for the given section name"""
+
+        return self._all_options.get(section)
+
+    def get(
+        self, section: str, option: str, fallback: str | _UNSET = _UNSET
+    ) -> str | List[str]:
+        """
+        Return the value of the given option in the given section
+
+        If the key is not found and 'fallback' is provided, it is used as
+        a fallback value.
+        """
+
+        try:
+            if section not in self._all_sections:
+                raise NoSectionError(section)
+
+            if option not in self._all_options.get(section):
+                raise NoOptionError(option, section)
+
+            return self._all_options[section][option]
+        except (NoSectionError, NoOptionError):
+            if fallback is _UNSET:
+                raise
+            return fallback
+
+    def getint(self, section: str, option: str, fallback: int | _UNSET = _UNSET) -> int:
+        """Return the value of the given option in the given section as an int"""
+
+        return self._get_conv(section, option, int, fallback=fallback)
+
+    def getfloat(
+        self, section: str, option: str, fallback: float | _UNSET = _UNSET
+    ) -> float:
+        return self._get_conv(section, option, float, fallback=fallback)
+
+    def getboolean(
+        self, section: str, option: str, fallback: bool | _UNSET = _UNSET
+    ) -> bool:
+        return self._get_conv(
+            section, option, self._convert_to_boolean, fallback=fallback
+        )
+
+    def _convert_to_boolean(self, value) -> bool:
+        if value.lower() not in self.BOOLEAN_STATES:
+            raise ValueError("Not a boolean: %s" % value)
+        return self.BOOLEAN_STATES[value.lower()]
+
+    def _get_conv(
+        self,
+        section: str,
+        option: str,
+        conv: Callable[[str], int | float | bool],
+        fallback: _UNSET = _UNSET,
+    ) -> int | float | bool:
+        try:
+            return conv(self.get(section, option, fallback))
+        except:
+            if fallback is not _UNSET:
+                return fallback
+            raise
+
+    def items(self, section: str) -> List[Tuple[str, str]]:
+        """Return a list of (option, value) tuples for a specific section"""
+
+        if section not in self._all_sections:
+            raise NoSectionError(section)
+
+        result = []
+        for _option in self._all_options[section]:
+            result.append((_option, self._all_options[section][_option]))
+
+        return result
+
+    def set(
+        self,
+        section: str,
+        option: str,
+        value: str,
+        multiline: bool = False,
+        indent: int = 4,
+    ) -> None:
+        """Set the given option to the given value in the given section
+
+        If the option is already defined, it will be overwritten. If the option
+        is not defined yet, it will be added to the section body.
+
+        The multiline parameter can be used to specify whether the value is
+        multiline or not. If it is not specified, the value will be considered
+        as multiline if it contains a newline character. The value will then be split
+        into multiple lines. If the value does not contain a newline character, it
+        will be considered as a single line value. The indent parameter can be used
+        to specify the indentation of the multiline value. Indentations are with spaces.
+
+        :param section: The section to set the option in
+        :param option: The option to set
+        :param value: The value to set
+        :param multiline: Whether the value is multiline or not
+        :param indent: The indentation for multiline values
+        """
+
+        if section not in self._all_sections:
+            raise NoSectionError(section)
+
+        # prepare the options value and raw value depending on the multiline flag
+        _raw_value: List[str] | None = None
+        if multiline or "\n" in value:
+            _multiline = True
+            _raw: str = f"{option}:\n"
+            _value: List[str] = value.split("\n")
+            _raw_value: List[str] = [f"{' ' * indent}{v}\n" for v in _value]
+        else:
+            _multiline = False
+            _raw: str = f"{option}: {value}\n"
+            _value: str = value
+
+        # the option does not exist yet
+        if option not in self._all_options.get(section):
+            _option: Option = {
+                "is_multiline": _multiline,
+                "option": option,
+                "value": _value,
+                "_raw": _raw,
+            }
+            if _raw_value is not None:
+                _option["_raw_value"] = _raw_value
+            self._config[section]["body"].insert(0, _option)
+
+        # the option exists and we need to update it
+        else:
+            for _option in self._config[section]["body"]:
+                if _option["option"] == option:
+                    if multiline:
+                        _option["_raw"] = _raw
+                    else:
+                        # we preserve inline comments by replacing the old value with the new one
+                        _option["_raw"] = _option["_raw"].replace(
+                            _option["value"], _value
+                        )
+                    _option["value"] = _value
+                    if _raw_value is not None:
+                        _option["_raw_value"] = _raw_value
+                    break
+
+        self._all_options[section][option] = _value
+
+    def remove_option(self, section: str, option: str) -> None:
+        """Remove the given option from the given section"""
+
+        if section not in self._all_sections:
+            raise NoSectionError(section)
+
+        if option not in self._all_options.get(section):
+            raise NoOptionError(option, section)
+
+        for _option in self._config[section]["body"]:
+            if _option["option"] == option:
+                del self._all_options[section][option]
+                self._config[section]["body"].remove(_option)
+                break
+
+    def has_section(self, section: str) -> bool:
+        """Return True if the given section exists, False otherwise"""
+        return section in self._all_sections
+
+    def has_option(self, section: str, option: str) -> bool:
+        """Return True if the given option exists in the given section, False otherwise"""
+        return option in self._all_options.get(section)
+
+    def _is_section(self, line: str) -> bool:
+        """Check if the given line contains a section definition"""
+        return self._SECTION_RE.match(line) is not None
+
+    def _is_option(self, line: str) -> bool:
+        """Check if the given line contains an option definition"""
+
+        match: Match[str] | None = self._OPTION_RE.match(line)
+
+        if not match:
+            return False
+
+        # if there is no value, it's not a regular option but a multiline option
+        if match.group(2).strip() == "":
+            return False
+
+        if not match.group(1).strip() == "":
+            return True
+
+        return False
+
+    def _is_comment(self, line: str) -> bool:
+        """Check if the given line is a comment"""
+        return self._COMMENT_RE.match(line) is not None
+
+    def _is_empty_line(self, line: str) -> bool:
+        """Check if the given line is an empty line"""
+        return self._EMPTY_LINE_RE.match(line) is not None
+
+    def _is_multiline_option(self, line: str) -> bool:
+        """Check if the given line starts a multiline option block"""
+
+        match: Match[str] | None = self._MLOPTION_RE.match(line)
+
+        if not match:
+            return False
+
+        return True
+
+    def _parse_config(self, content: List[str]) -> None:
+        """Parse the given content and store the result in the internal state"""
+
+        _curr_multi_opt = ""
+
+        # THE ORDER MATTERS, DO NOT REORDER THE CONDITIONS!
+        for line in content:
+            if self._is_section(line):
+                self._parse_section(line)
+
+            elif self._is_option(line):
+                self._parse_option(line)
+
+            # if it's not a regular option with the value inline,
+            # it might be a might be a multiline option block
+            elif self._is_multiline_option(line):
+                self.in_option_block = True
+                _curr_multi_opt = self._OPTION_RE.match(line).group(1).strip()
+                self._add_option_to_section_body(_curr_multi_opt, "", line)
+
+            elif self.in_option_block:
+                self._parse_multiline_option(_curr_multi_opt, line)
+
+            # if it's nothing from above, it's probably a comment or an empty line
+            elif self._is_comment(line) or self._is_empty_line(line):
+                self._parse_comment(line)
+
+    def _parse_section(self, line: str) -> None:
+        """Parse a section line and store the result in the internal state"""
+
+        match: Match[str] | None = self._SECTION_RE.match(line)
+        if not match:
+            return
+
+        self.in_option_block = False
+
+        section_name: str = match.group(1).strip()
+        self._store_internal_state_section(section_name, line)
+
+    def _store_internal_state_section(self, section: str, raw_value: str) -> None:
+        """Store the given section and its raw value in the internal state"""
+
+        if section in self._all_sections:
+            raise DuplicateSectionError(section)
+
+        self.section_name = section
+        self._all_sections.append(section)
+        self._all_options[section] = {}
+        self._config[section]: Section = {"_raw": raw_value, "body": []}
+
+    def _parse_option(self, line: str) -> None:
+        """Parse an option line and store the result in the internal state"""
+
+        self.in_option_block = False
+
+        match: Match[str] | None = self._OPTION_RE.match(line)
+        if not match:
+            return
+
+        option: str = match.group(1).strip()
+        value: str = match.group(2).strip()
+
+        if ";" in value:
+            i = value.index(";")
+            value = value[:i].strip()
+        elif "#" in value:
+            i = value.index("#")
+            value = value[:i].strip()
+
+        self._store_internal_state_option(option, value, line)
+
+    def _store_internal_state_option(
+        self, option: str, value: str, raw_value: str
+    ) -> None:
+        """Store the given option and its raw value in the internal state"""
+
+        section_options = self._all_options.setdefault(self.section_name, {})
+
+        if option in section_options:
+            raise DuplicateOptionError(option, self.section_name)
+
+        section_options[option] = value
+        self._add_option_to_section_body(option, value, raw_value)
+
+    def _parse_multiline_option(self, curr_ml_opt: str, line: str) -> None:
+        """Parse a multiline option line and store the result in the internal state"""
+
+        section_options = self._all_options.setdefault(self.section_name, {})
+        multiline_options = section_options.setdefault(curr_ml_opt, [])
+
+        _cleaned_line = line.strip().strip("\n")
+        if _cleaned_line and not self._is_comment(line):
+            multiline_options.append(_cleaned_line)
+
+        # add the option to the internal multiline option value state
+        self._ensure_section_body_exists()
+        for _option in self._config[self.section_name]["body"]:
+            if _option.get("option") == curr_ml_opt:
+                _option.update(
+                    is_multiline=True,
+                    _raw_value=_option.get("_raw_value", []) + [line],
+                    value=multiline_options,
+                )
+
+    def _parse_comment(self, line: str) -> None:
+        """
+        Parse a comment line and store the result in the internal state
+
+        If the there was no previous section parsed, the lines are handled as
+        the file header and added to the internal header list as it means, that
+        we are at the very top of the file.
+        """
+
+        self.in_option_block = False
+
+        if not self.section_name:
+            self._header.append(line)
+        else:
+            self._add_option_to_section_body("", "", line)
+
+    def _ensure_section_body_exists(self) -> None:
+        """
+        Ensure that the section body exists in the internal state.
+        If the section body does not exist, it is created as an empty list
+        """
+        if self.section_name not in self._config:
+            self._config.setdefault(self.section_name, {}).setdefault("body", [])
+
+    def _add_option_to_section_body(
+        self, option: str, value: str, line: str, is_multiline: bool = False
+    ) -> None:
+        """Add a raw option line to the internal state"""
+
+        self._ensure_section_body_exists()
+
+        new_option: Option = {
+            "is_multiline": is_multiline,
+            "option": option,
+            "value": value,
+            "_raw": line,
+        }
+
+        option_body = self._config[self.section_name]["body"]
+        option_body.append(new_option)

kiauh/core/submodules/simple_config_parser/tests/Test SimpleConfigParser.run.xml

@@ -0,0 +1,21 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Test SimpleConfigParser" type="tests" factoryName="py.test">
+    <module name="simple-config-parser" />
+    <option name="ENV_FILES" value="" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="PARENT_ENVS" value="true" />
+    <option name="SDK_HOME" value="" />
+    <option name="SDK_NAME" value="Python 3.8 (simple-config-parser)" />
+    <option name="WORKING_DIRECTORY" value="" />
+    <option name="IS_MODULE_SDK" value="false" />
+    <option name="ADD_CONTENT_ROOTS" value="true" />
+    <option name="ADD_SOURCE_ROOTS" value="true" />
+    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
+    <option name="_new_keywords" value="&quot;&quot;" />
+    <option name="_new_parameters" value="&quot;&quot;" />
+    <option name="_new_additionalArguments" value="&quot;-s -vv&quot;" />
+    <option name="_new_target" value="&quot;&quot;" />
+    <option name="_new_targetType" value="&quot;PATH&quot;" />
+    <method v="2" />
+  </configuration>
+</component>

kiauh/core/submodules/simple_config_parser/tests/features/internal_state/test_content_handling.py

@@ -0,0 +1,95 @@
+import pytest
+
+from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+
+
+@pytest.fixture
+def parser():
+    parser = SimpleConfigParser()
+    parser._header = ["header1\n", "header2\n"]
+    parser._config = {
+        "section1": {
+            "_raw": "[section1]\n",
+            "body": [
+                {
+                    "_raw": "option1: value1\n",
+                    "_raw_value": "value1\n",
+                    "is_multiline": False,
+                    "option": "option1",
+                    "value": "value1",
+                },
+                {
+                    "_raw": "option2: value2\n",
+                    "_raw_value": "value2\n",
+                    "is_multiline": False,
+                    "option": "option2",
+                    "value": "value2",
+                },
+            ],
+        },
+        "section2": {
+            "_raw": "[section2]\n",
+            "body": [
+                {
+                    "_raw": "option3: value3\n",
+                    "_raw_value": "value3\n",
+                    "is_multiline": False,
+                    "option": "option3",
+                    "value": "value3",
+                },
+            ],
+        },
+        "section3": {
+            "_raw": "[section3]\n",
+            "body": [
+                {
+                    "_raw": "option4:\n",
+                    "_raw_value": ["    value4\n", "    value5\n", "    value6\n"],
+                    "is_multiline": True,
+                    "option": "option4",
+                    "value": ["value4", "value5", "value6"],
+                },
+            ],
+        },
+    }
+    return parser
+
+
+def test_construct_content(parser):
+    content = parser._construct_content()
+    assert (
+        content == "header1\nheader2\n"
+        "[section1]\n"
+        "option1: value1\n"
+        "option2: value2\n"
+        "[section2]\n"
+        "option3: value3\n"
+        "[section3]\n"
+        "option4:\n"
+        "    value4\n"
+        "    value5\n"
+        "    value6\n"
+    )
+
+
+def test_construct_content_no_header(parser):
+    parser._header = None
+    content = parser._construct_content()
+    assert (
+        content == "[section1]\n"
+        "option1: value1\n"
+        "option2: value2\n"
+        "[section2]\n"
+        "option3: value3\n"
+        "[section3]\n"
+        "option4:\n"
+        "    value4\n"
+        "    value5\n"
+        "    value6\n"
+    )
+
+
+def test_construct_content_no_sections(parser):
+    parser._config = {}
+    content = parser._construct_content()
+    assert content == "".join(parser._header)

kiauh/core/submodules/simple_config_parser/tests/features/internal_state/test_internal_state_changes.py

@@ -0,0 +1,84 @@
+import pytest
+
+from src.simple_config_parser.simple_config_parser import (
+    DuplicateOptionError,
+    DuplicateSectionError,
+    SimpleConfigParser,
+)
+
+
+@pytest.fixture
+def parser():
+    return SimpleConfigParser()
+
+
+class TestInternalStateChanges:
+    @pytest.mark.parametrize(
+        "given", ["dummy_section", "dummy_section 2", "another_section"]
+    )
+    def test_ensure_section_body_exists(self, parser, given):
+        parser._config = {}
+        parser.section_name = given
+        parser._ensure_section_body_exists()
+
+        assert parser._config[given] is not None
+        assert parser._config[given]["body"] == []
+
+    def test_add_option_to_section_body(self):
+        pass
+
+    @pytest.mark.parametrize(
+        "given", ["dummy_section", "dummy_section 2", "another_section\n"]
+    )
+    def test_store_internal_state_section(self, parser, given):
+        parser._store_internal_state_section(given, given)
+
+        assert parser._all_sections == [given]
+        assert parser._all_options[given] == {}
+        assert parser._config[given]["body"] == []
+        assert parser._config[given]["_raw"] == given
+
+    def test_duplicate_section_error(self, parser):
+        section_name = "dummy_section"
+        parser._all_sections = [section_name]
+
+        with pytest.raises(DuplicateSectionError) as excinfo:
+            parser._store_internal_state_section(section_name, section_name)
+            message = f"Section '{section_name}' is defined more than once"
+            assert message in str(excinfo.value)
+
+        # Check that the internal state of the parser is correct
+        assert parser.in_option_block is False
+        assert parser.section_name == ""
+        assert parser._all_sections == [section_name]
+
+    @pytest.mark.parametrize(
+        "given_name, given_value, given_raw_value",
+        [("dummyoption", "dummyvalue", "dummyvalue\n")],
+    )
+    def test_store_internal_state_option(
+        self, parser, given_name, given_value, given_raw_value
+    ):
+        parser.section_name = "dummy_section"
+        parser._store_internal_state_option(given_name, given_value, given_raw_value)
+
+        assert parser._all_options[parser.section_name] == {given_name: given_value}
+
+        new_option = {
+            "is_multiline": False,
+            "option": given_name,
+            "value": given_value,
+            "_raw": given_raw_value,
+        }
+        assert parser._config[parser.section_name]["body"] == [new_option]
+
+    def test_duplicate_option_error(self, parser):
+        option_name = "dummyoption"
+        value = "dummyvalue"
+        parser.section_name = "dummy_section"
+        parser._all_options = {parser.section_name: {option_name: value}}
+
+        with pytest.raises(DuplicateOptionError) as excinfo:
+            parser._store_internal_state_option(option_name, value, value)
+            message = f"Option '{option_name}' in section '{parser.section_name}' is defined more than once"
+            assert message in str(excinfo.value)

kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_comment.py

@@ -0,0 +1,6 @@
+testcases = [
+    "# comment # 1",
+    "; comment # 2",
+    "    ; indented comment",
+    "        # another indented comment",
+]

kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_option.py

@@ -0,0 +1,24 @@
+testcases = [
+    ("option: value", "option", "value"),
+    ("option : value", "option", "value"),
+    ("option :value", "option", "value"),
+    ("option= value", "option", "value"),
+    ("option = value", "option", "value"),
+    ("option =value", "option", "value"),
+    ("option: value\n", "option", "value"),
+    ("option: value # inline comment", "option", "value"),
+    ("option: value # inline comment\n", "option", "value"),
+    (
+        "description: Helper: park toolhead used in PAUSE and CANCEL_PRINT",
+        "description",
+        "Helper: park toolhead used in PAUSE and CANCEL_PRINT",
+    ),
+    ("description: homing!", "description", "homing!"),
+    ("description: inline macro :-)", "description", "inline macro :-)"),
+    ("path: %GCODES_DIR%", "path", "%GCODES_DIR%"),
+    (
+        "serial = /dev/serial/by-id/<your-mcu-id>",
+        "serial",
+        "/dev/serial/by-id/<your-mcu-id>",
+    ),
+]

kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_section.py

@@ -0,0 +1,8 @@
+testcases = [
+    ("[test_section]", "test_section"),
+    ("[test_section two]", "test_section two"),
+    ("[section1] # inline comment", "section1"),
+    ("[section2] ; second comment", "section2"),
+    ("[include moonraker-obico-update.cfg]", "include moonraker-obico-update.cfg"),
+    ("[include moonraker_obico_macros.cfg]", "include moonraker_obico_macros.cfg"),
+]

kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/test_line_parsing.py

@@ -0,0 +1,92 @@
+import pytest
+from data.case_parse_comment import testcases as case_parse_comment
+from data.case_parse_option import testcases as case_parse_option
+from data.case_parse_section import testcases as case_parse_section
+
+from src.simple_config_parser.simple_config_parser import (
+    Option,
+    SimpleConfigParser,
+)
+
+
+@pytest.fixture
+def parser():
+    return SimpleConfigParser()
+
+
+class TestLineParsing:
+    @pytest.mark.parametrize("given, expected", [*case_parse_section])
+    def test_parse_section(self, parser, given, expected):
+        parser._parse_section(given)
+
+        # Check that the internal state of the parser is correct
+        assert parser.section_name == expected
+        assert parser.in_option_block is False
+        assert parser._all_sections == [expected]
+        assert parser._config[expected]["_raw"] == given
+        assert parser._config[expected]["body"] == []
+
+    @pytest.mark.parametrize(
+        "given, expected_option, expected_value", [*case_parse_option]
+    )
+    def test_parse_option(self, parser, given, expected_option, expected_value):
+        section_name = "test_section"
+        parser.section_name = section_name
+        parser._parse_option(given)
+
+        # Check that the internal state of the parser is correct
+        assert parser.section_name == section_name
+        assert parser.in_option_block is False
+        assert parser._all_options[section_name][expected_option] == expected_value
+
+        section_option = parser._config[section_name]["body"][0]
+        assert section_option["option"] == expected_option
+        assert section_option["value"] == expected_value
+        assert section_option["_raw"] == given
+
+    @pytest.mark.parametrize(
+        "option, next_line",
+        [("gcode", "next line"), ("gcode", "    {{% some jinja template %}}")],
+    )
+    def test_parse_multiline_option(self, parser, option, next_line):
+        parser.section_name = "dummy_section"
+        parser.in_option_block = True
+        parser._add_option_to_section_body(option, "", option)
+        parser._parse_multiline_option(option, next_line)
+        cleaned_next_line = next_line.strip().strip("\n")
+
+        assert parser._all_options[parser.section_name] is not None
+        assert parser._all_options[parser.section_name][option] == [cleaned_next_line]
+
+        expected_option: Option = {
+            "is_multiline": True,
+            "option": option,
+            "value": [cleaned_next_line],
+            "_raw": option,
+            "_raw_value": [next_line],
+        }
+        assert parser._config[parser.section_name]["body"] == [expected_option]
+
+    @pytest.mark.parametrize("given", [*case_parse_comment])
+    def test_parse_comment(self, parser, given):
+        parser.section_name = "dummy_section"
+        parser._parse_comment(given)
+
+        # internal state checks after parsing
+        assert parser.in_option_block is False
+
+        expected_option = {
+            "is_multiline": False,
+            "_raw": given,
+            "option": "",
+            "value": "",
+        }
+        assert parser._config[parser.section_name]["body"] == [expected_option]
+
+    @pytest.mark.parametrize("given", ["# header line", "; another header line"])
+    def test_parse_header_comment(self, parser, given):
+        parser.section_name = ""
+        parser._parse_comment(given)
+
+        assert parser.in_option_block is False
+        assert parser._header == [given]

kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_comment.py

@@ -0,0 +1,9 @@
+testcases = [
+    ("# an arbitrary comment", True),
+    ("; another arbitrary comment", True),
+    ("  ; indented comment", True),
+    ("  # indented comment", True),
+    ("not_a: comment", False),
+    ("also_not_a= comment", False),
+    ("[definitely_not_a_comment]", False),
+]

kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_empty.py

@@ -0,0 +1,9 @@
+testcases = [
+    ("", True),
+    (" ", True),
+    ("not empty", False),
+    ("  # indented comment", False),
+    ("not: empty", False),
+    ("also_not= empty", False),
+    ("[definitely_not_empty]", False),
+]

kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_multiline_option.py

@@ -0,0 +1,17 @@
+testcases = [
+    ("valid_option:", True),
+    ("valid_option:\n", True),
+    ("valid_option: ; inline comment", True),
+    ("valid_option: # inline comment", True),
+    ("valid_option :", True),
+    ("valid_option=", True),
+    ("valid_option= ", True),
+    ("valid_option =", True),
+    ("valid_option = ", True),
+    ("invalid_option ==", False),
+    ("invalid_option :=", False),
+    ("not_a_valid_option", False),
+    ("", False),
+    ("# that's a comment", False),
+    ("; that's a comment", False),
+]

kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_option.py

@@ -0,0 +1,30 @@
+testcases = [
+    ("valid_option: value", True),
+    ("valid_option: value\n", True),
+    ("valid_option: value ; inline comment", True),
+    ("valid_option: value # inline comment", True),
+    ("valid_option: value # inline comment\n", True),
+    ("valid_option : value", True),
+    ("valid_option :value", True),
+    ("valid_option= value", True),
+    ("valid_option = value", True),
+    ("valid_option =value", True),
+    ("invalid_option:", False),
+    ("invalid_option=", False),
+    ("invalid_option:: value", False),
+    ("invalid_option :: value", False),
+    ("invalid_option ::value", False),
+    ("invalid_option== value", False),
+    ("invalid_option == value", False),
+    ("invalid_option ==value", False),
+    ("invalid_option:= value", False),
+    ("invalid_option := value", False),
+    ("invalid_option :=value", False),
+    ("[that_is_a_section]", False),
+    ("[that_is_section two]", False),
+    ("not_a_valid_option", False),
+    ("description: homing!", True),
+    ("description: inline macro :-)", True),
+    ("path: %GCODES_DIR%", True),
+    ("serial = /dev/serial/by-id/<your-mcu-id>", True),
+]

kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_section.py

@@ -0,0 +1,12 @@
+testcases = [
+    ("[example_section]", True),
+    ("[gcode_macro CANCEL_PRINT]", True),
+    ("[gcode_macro SET_PAUSE_NEXT_LAYER]", True),
+    ("[gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]", True),
+    ("[update_manager moonraker-obico]", True),
+    ("[include moonraker_obico_macros.cfg]", True),
+    ("[include moonraker-obico-update.cfg]", True),
+    ("[example_section two]", True),
+    ("not_a_valid_section", False),
+    ("section: invalid", False),
+]

kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/test_line_type_detection.py

@@ -0,0 +1,37 @@
+import pytest
+from data.case_line_is_comment import testcases as case_line_is_comment
+from data.case_line_is_empty import testcases as case_line_is_empty
+from data.case_line_is_multiline_option import (
+    testcases as case_line_is_multiline_option,
+)
+from data.case_line_is_option import testcases as case_line_is_option
+from data.case_line_is_section import testcases as case_line_is_section
+
+from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+
+
+@pytest.fixture
+def parser():
+    return SimpleConfigParser()
+
+
+class TestLineTypeDetection:
+    @pytest.mark.parametrize("given, expected", [*case_line_is_section])
+    def test_line_is_section(self, parser, given, expected):
+        assert parser._is_section(given) is expected
+
+    @pytest.mark.parametrize("given, expected", [*case_line_is_option])
+    def test_line_is_option(self, parser, given, expected):
+        assert parser._is_option(given) is expected
+
+    @pytest.mark.parametrize("given, expected", [*case_line_is_multiline_option])
+    def test_line_is_multiline_option(self, parser, given, expected):
+        assert parser._is_multiline_option(given) is expected
+
+    @pytest.mark.parametrize("given, expected", [*case_line_is_comment])
+    def test_line_is_comment(self, parser, given, expected):
+        assert parser._is_comment(given) is expected
+
+    @pytest.mark.parametrize("given, expected", [*case_line_is_empty])
+    def test_line_is_empty(self, parser, given, expected):
+        assert parser._is_empty_line(given) is expected

kiauh/core/submodules/simple_config_parser/tests/features/public_api/test_public_api.py

@@ -0,0 +1,196 @@
+import pytest
+
+from src.simple_config_parser.simple_config_parser import (
+    DuplicateSectionError,
+    NoOptionError,
+    NoSectionError,
+    SimpleConfigParser,
+)
+
+
+@pytest.fixture
+def parser():
+    return SimpleConfigParser()
+
+
+class TestPublicAPI:
+    def test_has_section(self, parser):
+        parser._all_sections = ["section1"]
+        assert parser.has_section("section1") is True
+
+    @pytest.mark.parametrize("section", ["section1", "section2", "section three"])
+    def test_add_section(self, parser, section):
+        parser.add_section(section)
+
+        assert section in parser._all_sections
+        assert parser._all_options[section] == {}
+
+        cfg_section = {"_raw": f"\n[{section}]\n", "body": []}
+        assert parser._config[section] == cfg_section
+
+    @pytest.mark.parametrize("section", ["section1", "section2", "section three"])
+    def test_add_existing_section(self, parser, section):
+        parser._all_sections = [section]
+
+        with pytest.raises(DuplicateSectionError):
+            parser.add_section(section)
+
+        assert parser._all_sections == [section]
+
+    @pytest.mark.parametrize("section", ["section1", "section2", "section three"])
+    def test_remove_section(self, parser, section):
+        parser.add_section(section)
+        parser.remove_section(section)
+
+        assert section not in parser._all_sections
+        assert section not in parser._all_options
+        assert section not in parser._config
+
+    @pytest.mark.parametrize("section", ["section1", "section2", "section three"])
+    def test_remove_non_existing_section(self, parser, section):
+        with pytest.raises(NoSectionError):
+            parser.remove_section(section)
+
+    def test_get_all_sections(self, parser):
+        parser.add_section("section1")
+        parser.add_section("section2")
+        parser.add_section("section three")
+
+        assert parser.sections() == ["section1", "section2", "section three"]
+
+    def test_has_option(self, parser):
+        parser.add_section("section1")
+        parser.set("section1", "option1", "value1")
+
+        assert parser.has_option("section1", "option1") is True
+
+    @pytest.mark.parametrize(
+        "section, option, value",
+        [
+            ("section1", "option1", "value1"),
+            ("section2", "option2", "value2"),
+            ("section three", "option3", "value three"),
+        ],
+    )
+    def test_set_new_option(self, parser, section, option, value):
+        parser.add_section(section)
+        parser.set(section, option, value)
+
+        assert section in parser._all_sections
+        assert option in parser._all_options[section]
+        assert parser._all_options[section][option] == value
+
+        assert parser._config[section]["body"][0]["is_multiline"] is False
+        assert parser._config[section]["body"][0]["option"] == option
+        assert parser._config[section]["body"][0]["value"] == value
+        assert parser._config[section]["body"][0]["_raw"] == f"{option}: {value}\n"
+
+    def test_set_existing_option(self, parser):
+        section, option, value1, value2 = "section1", "option1", "value1", "value2"
+
+        parser.add_section(section)
+        parser.set(section, option, value1)
+        parser.set(section, option, value2)
+
+        assert parser._all_options[section][option] == value2
+        assert parser._config[section]["body"][0]["is_multiline"] is False
+        assert parser._config[section]["body"][0]["option"] == option
+        assert parser._config[section]["body"][0]["value"] == value2
+        assert parser._config[section]["body"][0]["_raw"] == f"{option}: {value2}\n"
+
+    def test_set_new_multiline_option(self, parser):
+        section, option, value = "section1", "option1", "value1\nvalue2\nvalue3"
+
+        parser.add_section(section)
+        parser.set(section, option, value)
+
+        assert parser._config[section]["body"][0]["is_multiline"] is True
+        assert parser._config[section]["body"][0]["option"] == option
+
+        values = ["value1", "value2", "value3"]
+        raw_values = ["    value1\n", "    value2\n", "    value3\n"]
+        assert parser._config[section]["body"][0]["value"] == values
+        assert parser._config[section]["body"][0]["_raw"] == f"{option}:\n"
+        assert parser._config[section]["body"][0]["_raw_value"] == raw_values
+        assert parser._all_options[section][option] == values
+
+    def test_set_option_of_non_existing_section(self, parser):
+        with pytest.raises(NoSectionError):
+            parser.set("section1", "option1", "value1")
+
+    def test_remove_option(self, parser):
+        section, option, value = "section1", "option1", "value1"
+
+        parser.add_section(section)
+        parser.set(section, option, value)
+        parser.remove_option(section, option)
+
+        assert option not in parser._all_options[section]
+        assert option not in parser._config[section]["body"]
+
+    def test_remove_non_existing_option(self, parser):
+        parser.add_section("section1")
+        with pytest.raises(NoOptionError):
+            parser.remove_option("section1", "option1")
+
+    def test_remove_option_of_non_existing_section(self, parser):
+        with pytest.raises(NoSectionError):
+            parser.remove_option("section1", "option1")
+
+    def test_get_option(self, parser):
+        parser.add_section("section1")
+        parser.add_section("section2")
+        parser.set("section1", "option1", "value1")
+        parser.set("section2", "option2", "value2")
+        parser.set("section2", "option3", "value two")
+
+        assert parser.get("section1", "option1") == "value1"
+        assert parser.get("section2", "option2") == "value2"
+        assert parser.get("section2", "option3") == "value two"
+
+    def test_get_option_of_non_existing_section(self, parser):
+        with pytest.raises(NoSectionError):
+            parser.get("section1", "option1")
+
+    def test_get_option_of_non_existing_option(self, parser):
+        parser.add_section("section1")
+        with pytest.raises(NoOptionError):
+            parser.get("section1", "option1")
+
+    def test_get_option_fallback(self, parser):
+        parser.add_section("section1")
+        assert parser.get("section1", "option1", "fallback_value") == "fallback_value"
+
+    def test_get_options(self, parser):
+        parser.add_section("section1")
+        parser.set("section1", "option1", "value1")
+        parser.set("section1", "option2", "value2")
+        parser.set("section1", "option3", "value3")
+
+        options = {"option1": "value1", "option2": "value2", "option3": "value3"}
+        assert parser.options("section1") == options
+
+    def test_get_option_as_int(self, parser):
+        parser.add_section("section1")
+        parser.set("section1", "option1", "1")
+
+        option = parser.getint("section1", "option1")
+        assert isinstance(option, int) is True
+
+    def test_get_option_as_float(self, parser):
+        parser.add_section("section1")
+        parser.set("section1", "option1", "1.234")
+
+        option = parser.getfloat("section1", "option1")
+        assert isinstance(option, float) is True
+
+    @pytest.mark.parametrize(
+        "value",
+        ["True", "true", "on", "1", "yes", "False", "false", "off", "0", "no"],
+    )
+    def test_get_option_as_boolean(self, parser, value):
+        parser.add_section("section1")
+        parser.set("section1", "option1", value)
+
+        option = parser.getboolean("section1", "option1")
+        assert isinstance(option, bool) is True

kiauh/core/types.py

@@ -0,0 +1,29 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Dict, Literal
+
+StatusText = Literal["Installed", "Not installed", "Incomplete"]
+StatusCode = Literal[0, 1, 2]
+StatusMap: Dict[StatusCode, StatusText] = {
+    0: "Not installed",
+    1: "Incomplete",
+    2: "Installed",
+}
+
+
+@dataclass
+class ComponentStatus:
+    status: StatusCode
+    repo: str | None = None
+    local: str | None = None
+    remote: str | None = None
+    instances: int | None = None