Release v6.0.0-alpha.4

Merge develop into master (v6.0.0-alpha.4)

.editorconfig

@@ -6,6 +6,10 @@ indent_size = 4
 insert_final_newline = true
 trim_trailing_whitespace = true
 charset = utf-8
+end_of_line = lf
 
 [*.py]
 max_line_length = 88
+
+[*.sh]
+indent_size = 2

README.md

@@ -154,7 +154,7 @@ prompt and confirm by hitting ENTER.
 <tr>
 <th><h3><a href="https://github.com/Clon1998/mobileraker_companion">Mobileraker's Companion</a></h3></th>
 <th><h3><a href="https://octoeverywhere.com/?source=kiauh_readme">OctoEverywhere For Klipper</a></h3></th>
-<th><h3><a href="https://github.com/crysxd/OctoPrint-OctoApp">OctoApp For Klipper</a></h3></th>
+<th><h3><a href="https://github.com/crysxd/OctoApp-Plugin">OctoApp For Klipper</a></h3></th>
 <th><h3></h3></th>
 </tr>
 

docs/changelog.md

@@ -2,13 +2,54 @@
 
 This document covers possible important changes to KIAUH.
 
+### 2024-08-31 (v6.0.0-alpha.1)
+Long time no see, but here we are again!
+A lot has happened in the background, but now it is time to take it out into the wild.
+
+#### KIAUH has now reached version 6! Well, at least in an alpha state...
+
+The project has seen a complete rewrite of the script from scratch in Python.
+It requires Python 3.8 or newer to run. Because this update is still in an alpha state, bugs may or will occur.
+During startup, you will be asked if you want to start the new version 6 or the old version 5.
+As long as version 6 is in a pre-release state, version 5 will still be available. If there are any critical issues
+with the new version that were overlooked, you can always switch back to the old version.
+
+In case you selected not to get asked about which version to start (option 3 or 4 in the startup dialog) and you want to
+revert that decision, you will find a line called `version_to_launch=` within the `.kiauh.ini` file in your home directory.
+Just delete that line, save the file and restart KIAUH. KIAUH will then ask you again which version you want to start.
+
+Here is a list of the most important changes to KIAUH in regard to version 6:
+- The majority of features available in KIAUH v5 are still available; they just got migrated from Bash to Python.
+- It is now possible to add new/remove instances to/from existing multi-instance installations of Klipper and Moonraker
+- KIAUH now has an Extension-System. This allows contributors to add new installers to KIAUH without having to modify the main script.
+    - You will now find some of the features that were previously available in the Installer-Menu in the Extensions-Menu.
+    - The current extensions are:
+        - G-Code Shell Command (previously found in the Advanced-Menu)
+        - Mainsail Theme Installer (previously found in the Advanced-Menu)
+        - Klipper-Backup (new in v6!)
+        - Moonraker Telegram Bot (previously found in the Installer-Menu)
+        - PrettyGCode for Klipper (previously found in the Installer-Menu)
+        - Obico for Klipper (previously found in the Installer-Menu)
+    - The following additional extensions are planned, but not yet available:
+        - Spoolman (available in v5 in the Installer-Menu)
+        - OctoApp (available in v5 in the Installer-Menu)
+- KIAUH has its own config file now
+    - The file has some default values for the currently supported options
+    - There might be more options in the future
+    - It is located in KIAUH's root directory and is called `default.kiauh.cfg`
+        - DO NOT EDIT the default file directly, instead make a copy of it and call it `kiauh.cfg`
+        - Settings changed via the Advanced-Menu will be written to the `kiauh.cfg`
+- Support for OctoPrint was removed
+
+Feel free to give version 6 a try and report any bugs or issues you encounter! Every feedback is appreciated.
+
 ### 2023-06-17
-KIAUH has now added support for installing Mobileraker's companion! 
+KIAUH has now added support for installing Mobileraker's companion!
 Mobileraker is a free and Open Source Android and iOS App for Klipper, utilizing the Moonraker API, allowing you
 to control your printer. Thank you to [Clon1998](https://github.com/Clon1998) for adding this feature!
 
 ### 2023-02-03
-The installer for MJPG-Streamer got replaced by crowsnest. It is an improved webcam service, utilizing ustreamer. 
+The installer for MJPG-Streamer got replaced by crowsnest. It is an improved webcam service, utilizing ustreamer.
 Please have a look here for additional info about crowsnest and how to configure it: https://github.com/mainsail-crew/crowsnest \
 It's unsure if the previous MJPG-Streamer installer will be updated and make its way back into KIAUH.
 A big thanks to [KwadFan](https://github.com/KwadFan) for writing the crowsnest implementation.
@@ -115,7 +156,7 @@ membership for example caused issues when installing mjpg-streamer while not usi
 Other issues could occur when trying to flash an MCU on Debian or Ubuntu distributions where a user might not be part
 of the dialout group by default. A check for the tty group is also done. The tty group is needed for setting
 up a linux MCU (currently not yet supported by KIAUH).
-* There is an issue when trying to install Mainsail or Fluidd on Ubuntu 21.10. Permissions on that distro seem to have seen a rework 
+* There is an issue when trying to install Mainsail or Fluidd on Ubuntu 21.10. Permissions on that distro seem to have seen a rework
  in comparison to 20.04 and users will be greeted with an "Error 403 - Permission denied" message after installing one of Klippers webinterfaces.
 I still have to figure out a viable solution for that.
 

kiauh.sh

@@ -12,97 +12,166 @@
 set -e
 clear
 
-function main() {
-  local python_command
+# make sure we have the correct permissions while running the script
+umask 022
+
+### sourcing all additional scripts
+KIAUH_SRCDIR="$(dirname -- "$(readlink -f "${BASH_SOURCE[0]}")")"
+for script in "${KIAUH_SRCDIR}/scripts/"*.sh; do . "${script}"; done
+for script in "${KIAUH_SRCDIR}/scripts/ui/"*.sh; do . "${script}"; done
+
+#===================================================#
+#=================== UPDATE KIAUH ==================#
+#===================================================#
+
+function update_kiauh() {
+  status_msg "Updating KIAUH ..."
+
+  cd "${KIAUH_SRCDIR}"
+  git reset --hard && git pull
+
+  ok_msg "Update complete! Please restart KIAUH."
+  exit 0
+}
+
+#===================================================#
+#=================== KIAUH STATUS ==================#
+#===================================================#
+
+function kiauh_update_avail() {
+  [[ ! -d "${KIAUH_SRCDIR}/.git" ]] && return
+  local origin head
+
+  cd "${KIAUH_SRCDIR}"
+
+  ### abort if not on master branch
+  ! git branch -a | grep -q "\* master" && return
+
+  ### compare commit hash
+  git fetch -q
+  origin=$(git rev-parse --short=8 origin/master)
+  head=$(git rev-parse --short=8 HEAD)
+
+  if [[ ${origin} != "${head}" ]]; then
+    echo "true"
+  fi
+}
+
+function save_startup_version() {
+  local launch_version
+
+  echo "${1}"
+
+  sed -i "/^version_to_launch=/d" "${INI_FILE}"
+  sed -i '$a'"version_to_launch=${1}" "${INI_FILE}"
+}
+
+function kiauh_update_dialog() {
+  [[ ! $(kiauh_update_avail) == "true" ]] && return
+  top_border
+  echo -e "|${green}              New KIAUH update available!              ${white}|"
+  hr
+  echo -e "|${green}  View Changelog: https://git.io/JnmlX                 ${white}|"
+  blank_line
+  echo -e "|${yellow}  It is recommended to keep KIAUH up to date. Updates  ${white}|"
+  echo -e "|${yellow}  usually contain bugfixes, important changes or new   ${white}|"
+  echo -e "|${yellow}  features. Please consider updating!                  ${white}|"
+  bottom_border
+
+  local yn
+  read -p "${cyan}###### Do you want to update now? (Y/n):${white} " yn
+  while true; do
+    case "${yn}" in
+     Y|y|Yes|yes|"")
+       do_action "update_kiauh"
+       break;;
+     N|n|No|no)
+       break;;
+     *)
+       deny_action "kiauh_update_dialog";;
+    esac
+  done
+}
+
+function launch_kiauh_v5() {
+    main_menu
+}
+
+function launch_kiauh_v6() {
   local entrypoint
 
-  if command -v python3 &>/dev/null; then
-    python_command="python3"
-  elif command -v python &>/dev/null; then
-    python_command="python"
-  else
-    echo "Python is not installed. Please install Python and try again."
+  if ! command -v python3 &>/dev/null || [[ $(python3 -V | cut -d " " -f2 | cut -d "." -f2) -lt 8 ]]; then
+    echo "Python 3.8 or higher is not installed!"
+    echo "Please install Python 3.8 or higher and try again."
     exit 1
   fi
 
   entrypoint=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
 
-  ${python_command} "${entrypoint}/kiauh.py"
+  export PYTHONPATH="${entrypoint}"
+
+  clear
+  python3 "${entrypoint}/kiauh.py"
 }
 
-main
+function main() {
+  read_kiauh_ini "${FUNCNAME[0]}"
 
-#### sourcing all additional scripts
-#KIAUH_SRCDIR="$(dirname -- "$(readlink -f "${BASH_SOURCE[0]}")")"
-#for script in "${KIAUH_SRCDIR}/scripts/"*.sh; do . "${script}"; done
-#for script in "${KIAUH_SRCDIR}/scripts/ui/"*.sh; do . "${script}"; done
-#
-##===================================================#
-##=================== UPDATE KIAUH ==================#
-##===================================================#
-#
-#function update_kiauh() {
-#  status_msg "Updating KIAUH ..."
-#
-#  cd "${KIAUH_SRCDIR}"
-#  git reset --hard && git pull
-#
-#  ok_msg "Update complete! Please restart KIAUH."
-#  exit 0
-#}
-#
-##===================================================#
-##=================== KIAUH STATUS ==================#
-##===================================================#
-#
-#function kiauh_update_avail() {
-#  [[ ! -d "${KIAUH_SRCDIR}/.git" ]] && return
-#  local origin head
-#
-#  cd "${KIAUH_SRCDIR}"
-#
-#  ### abort if not on master branch
-#  ! git branch -a | grep -q "\* master" && return
-#
-#  ### compare commit hash
-#  git fetch -q
-#  origin=$(git rev-parse --short=8 origin/master)
-#  head=$(git rev-parse --short=8 HEAD)
-#
-#  if [[ ${origin} != "${head}" ]]; then
-#    echo "true"
-#  fi
-#}
-#
-#function kiauh_update_dialog() {
-#  [[ ! $(kiauh_update_avail) == "true" ]] && return
-#  top_border
-#  echo -e "|${green}              New KIAUH update available!              ${white}|"
-#  hr
-#  echo -e "|${green}  View Changelog: https://git.io/JnmlX                 ${white}|"
-#  blank_line
-#  echo -e "|${yellow}  It is recommended to keep KIAUH up to date. Updates  ${white}|"
-#  echo -e "|${yellow}  usually contain bugfixes, important changes or new   ${white}|"
-#  echo -e "|${yellow}  features. Please consider updating!                  ${white}|"
-#  bottom_border
-#
-#  local yn
-#  read -p "${cyan}###### Do you want to update now? (Y/n):${white} " yn
-#  while true; do
-#    case "${yn}" in
-#      Y|y|Yes|yes|"")
-#        do_action "update_kiauh"
-#        break;;
-#      N|n|No|no)
-#        break;;
-#      *)
-#        deny_action "kiauh_update_dialog";;
-#    esac
-#  done
-#}
-#
-#check_euid
-#init_logfile
-#set_globals
-#kiauh_update_dialog
-#main_menu
+  if [[ ${version_to_launch} -eq 5 ]]; then
+    launch_kiauh_v5
+  elif [[ ${version_to_launch} -eq 6 ]]; then
+    launch_kiauh_v6
+  else
+    top_border
+    echo -e "|         ${green}KIAUH v6.0.0-alpha1 is available now!${white}         |"
+    hr
+    echo -e "|         View Changelog: ${magenta}https://git.io/JnmlX${white}          |"
+    blank_line
+    echo -e "| KIAUH v6 was completely rewritten from the ground up. |"
+    echo -e "| It's based on Python 3.8 and has many improvements.   |"
+    blank_line
+    echo -e "| ${yellow}NOTE: Version 6 is still in alpha, so bugs may occur!${white} |"
+    echo -e "| ${yellow}Yet, your feedback and bug reports are very much${white}      |"
+    echo -e "| ${yellow}appreciated and will help finalize the release.${white}       |"
+    hr
+    echo -e "| Would you like to try out KIAUH v6?                   |"
+    echo -e "| 1) Yes                                                |"
+    echo -e "| 2) No                                                 |"
+    echo -e "| 3) Yes, remember my choice for next time              |"
+    echo -e "| 4) No, remember my choice for next time               |"
+    quit_footer
+    while true; do
+      read -p "${cyan}###### Select action:${white} " -e input
+      case "${input}" in
+        1)
+          launch_kiauh_v6
+          break;;
+        2)
+          launch_kiauh_v5
+          break;;
+        3)
+          save_startup_version 6
+          launch_kiauh_v6
+          break;;
+        4)
+          save_startup_version 5
+          launch_kiauh_v5
+          break;;
+        Q|q)
+          echo -e "${green}###### Happy printing! ######${white}"; echo
+          exit 0;;
+        *)
+          error_msg "Invalid Input!\n";;
+      esac
+    done && input=""
+  fi
+}
+
+check_if_ratos
+check_euid
+init_logfile
+set_globals
+kiauh_update_dialog
+read_kiauh_ini
+init_ini
+main

kiauh/components/crowsnest/__init__.py

@@ -10,7 +10,21 @@
 from pathlib import Path
 
 from core.backup_manager import BACKUP_ROOT_DIR
+from core.constants import SYSTEMD
 
-CROWSNEST_DIR = Path.home().joinpath("crowsnest")
+# repo
 CROWSNEST_REPO = "https://github.com/mainsail-crew/crowsnest.git"
+
+# names
+CROWSNEST_SERVICE_NAME = "crowsnest.service"
+
+# directories
+CROWSNEST_DIR = Path.home().joinpath("crowsnest")
 CROWSNEST_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("crowsnest-backups")
+
+# files
+CROWSNEST_MULTI_CONFIG = CROWSNEST_DIR.joinpath("tools/.config")
+CROWSNEST_INSTALL_SCRIPT = CROWSNEST_DIR.joinpath("tools/install.sh")
+CROWSNEST_BIN_FILE = Path("/usr/local/bin/crowsnest")
+CROWSNEST_LOGROTATE_FILE = Path("/etc/logrotate.d/crowsnest")
+CROWSNEST_SERVICE_FILE = SYSTEMD.joinpath(CROWSNEST_SERVICE_NAME)

kiauh/components/crowsnest/crowsnest.py

@@ -14,27 +14,37 @@ from pathlib import Path
 from subprocess import CalledProcessError, run
 from typing import List
 
-from components.crowsnest import CROWSNEST_BACKUP_DIR, CROWSNEST_DIR, CROWSNEST_REPO
+from components.crowsnest import (
+    CROWSNEST_BACKUP_DIR,
+    CROWSNEST_BIN_FILE,
+    CROWSNEST_DIR,
+    CROWSNEST_INSTALL_SCRIPT,
+    CROWSNEST_LOGROTATE_FILE,
+    CROWSNEST_MULTI_CONFIG,
+    CROWSNEST_REPO,
+    CROWSNEST_SERVICE_FILE,
+    CROWSNEST_SERVICE_NAME,
+)
 from components.klipper.klipper import Klipper
 from core.backup_manager.backup_manager import BackupManager
-from core.instance_manager.instance_manager import InstanceManager
+from core.constants import CURRENT_USER
+from core.logger import DialogType, Logger
 from core.settings.kiauh_settings import KiauhSettings
+from core.types import ComponentStatus
 from utils.common import (
     check_install_dependencies,
     get_install_status,
 )
-from utils.constants import CURRENT_USER
 from utils.git_utils import (
     git_clone_wrapper,
     git_pull_wrapper,
 )
 from utils.input_utils import get_confirm
-from utils.logger import DialogType, Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
     cmd_sysctl_service,
     parse_packages_from_file,
 )
-from utils.types import ComponentStatus
 
 
 def install_crowsnest() -> None:
@@ -42,11 +52,10 @@ def install_crowsnest() -> None:
     git_clone_wrapper(CROWSNEST_REPO, CROWSNEST_DIR, "master")
 
     # Step 2: Install dependencies
-    check_install_dependencies(["make"])
+    check_install_dependencies({"make"})
 
     # Step 3: Check for Multi Instance
-    im = InstanceManager(Klipper)
-    instances: List[Klipper] = im.instances
+    instances: List[Klipper] = get_instances(Klipper)
 
     if len(instances) > 1:
         print_multi_instance_warning(instances)
@@ -75,7 +84,6 @@ def install_crowsnest() -> None:
 
 
 def print_multi_instance_warning(instances: List[Klipper]) -> None:
-    _instances = [f"● {instance.data_dir_name}" for instance in instances]
     Logger.print_dialog(
         DialogType.WARNING,
         [
@@ -86,14 +94,12 @@ def print_multi_instance_warning(instances: List[Klipper]) -> None:
             "this instance to set up your 'crowsnest.conf' and steering it's service.",
             "\n\n",
             "The following instances were found:",
-            *_instances,
+            *[f"● {instance.data_dir.name}" for instance in instances],
         ],
-        end="",
     )
 
 
 def configure_multi_instance() -> None:
-    config = Path(CROWSNEST_DIR).joinpath("tools/.config")
     try:
         run(
             "make config",
@@ -103,17 +109,17 @@ def configure_multi_instance() -> None:
         )
     except CalledProcessError as e:
         Logger.print_error(f"Something went wrong! Please try again...\n{e}")
-        if config.exists():
-            Path.unlink(config)
+        if CROWSNEST_MULTI_CONFIG.exists():
+            Path.unlink(CROWSNEST_MULTI_CONFIG)
         return
 
-    if not config.exists():
+    if not CROWSNEST_MULTI_CONFIG.exists():
         Logger.print_error("Generating .config failed, installation aborted")
 
 
 def update_crowsnest() -> None:
     try:
-        cmd_sysctl_service("crowsnest", "stop")
+        cmd_sysctl_service(CROWSNEST_SERVICE_NAME, "stop")
 
         if not CROWSNEST_DIR.exists():
             git_clone_wrapper(CROWSNEST_REPO, CROWSNEST_DIR, "master")
@@ -124,18 +130,17 @@ def update_crowsnest() -> None:
             if settings.kiauh.backup_before_update:
                 bm = BackupManager()
                 bm.backup_directory(
-                    "crowsnest",
+                    CROWSNEST_DIR.name,
                     source=CROWSNEST_DIR,
                     target=CROWSNEST_BACKUP_DIR,
                 )
 
             git_pull_wrapper(CROWSNEST_REPO, CROWSNEST_DIR)
 
-            script = CROWSNEST_DIR.joinpath("tools/install.sh")
-            deps = parse_packages_from_file(script)
-            check_install_dependencies(deps)
+            deps = parse_packages_from_file(CROWSNEST_INSTALL_SCRIPT)
+            check_install_dependencies({*deps})
 
-        cmd_sysctl_service("crowsnest", "restart")
+        cmd_sysctl_service(CROWSNEST_SERVICE_NAME, "restart")
 
         Logger.print_ok("Crowsnest updated successfully.", end="\n\n")
     except CalledProcessError as e:
@@ -145,9 +150,9 @@ def update_crowsnest() -> None:
 
 def get_crowsnest_status() -> ComponentStatus:
     files = [
-        Path("/usr/local/bin/crowsnest"),
-        Path("/etc/logrotate.d/crowsnest"),
-        Path("/etc/systemd/system/crowsnest.service"),
+        CROWSNEST_BIN_FILE,
+        CROWSNEST_LOGROTATE_FILE,
+        CROWSNEST_SERVICE_FILE,
     ]
     return get_install_status(CROWSNEST_DIR, files=files)
 

kiauh/components/klipper/__init__.py

@@ -13,9 +13,24 @@ from core.backup_manager import BACKUP_ROOT_DIR
 
 MODULE_PATH = Path(__file__).resolve().parent
 
+# names
+KLIPPER_LOG_NAME = "klippy.log"
+KLIPPER_CFG_NAME = "printer.cfg"
+KLIPPER_SERIAL_NAME = "klippy.serial"
+KLIPPER_UDS_NAME = "klippy.sock"
+KLIPPER_ENV_FILE_NAME = "klipper.env"
+KLIPPER_SERVICE_NAME = "klipper.service"
+
+# directories
 KLIPPER_DIR = Path.home().joinpath("klipper")
 KLIPPER_ENV_DIR = Path.home().joinpath("klippy-env")
 KLIPPER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("klipper-backups")
-KLIPPER_REQUIREMENTS_TXT = KLIPPER_DIR.joinpath("scripts/klippy-requirements.txt")
+
+# files
+KLIPPER_REQ_FILE = KLIPPER_DIR.joinpath("scripts/klippy-requirements.txt")
+KLIPPER_INSTALL_SCRIPT = KLIPPER_DIR.joinpath("scripts/install-ubuntu-22.04.sh")
+KLIPPER_SERVICE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{KLIPPER_SERVICE_NAME}")
+KLIPPER_ENV_FILE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{KLIPPER_ENV_FILE_NAME}")
+
 
 EXIT_KLIPPER_SETUP = "Exiting Klipper setup ..."

kiauh/components/klipper/klipper.py

@@ -6,147 +6,137 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
-import subprocess
+from dataclasses import dataclass, field
 from pathlib import Path
-from typing import List
+from subprocess import CalledProcessError
 
-from components.klipper import KLIPPER_DIR, KLIPPER_ENV_DIR, MODULE_PATH
+from components.klipper import (
+    KLIPPER_CFG_NAME,
+    KLIPPER_DIR,
+    KLIPPER_ENV_DIR,
+    KLIPPER_ENV_FILE_NAME,
+    KLIPPER_ENV_FILE_TEMPLATE,
+    KLIPPER_LOG_NAME,
+    KLIPPER_SERIAL_NAME,
+    KLIPPER_SERVICE_TEMPLATE,
+    KLIPPER_UDS_NAME,
+)
+from core.constants import CURRENT_USER
 from core.instance_manager.base_instance import BaseInstance
-from utils.constants import SYSTEMD
-from utils.logger import Logger
+from core.logger import Logger
+from utils.fs_utils import create_folders, get_data_dir
+from utils.sys_utils import get_service_file_path
 
 
 # noinspection PyMethodMayBeStatic
-class Klipper(BaseInstance):
-    @classmethod
-    def blacklist(cls) -> List[str]:
-        return ["None", "mcu"]
+@dataclass(repr=True)
+class Klipper:
+    suffix: str
+    base: BaseInstance = field(init=False, repr=False)
+    service_file_path: Path = field(init=False)
+    log_file_name: str = KLIPPER_LOG_NAME
+    klipper_dir: Path = KLIPPER_DIR
+    env_dir: Path = KLIPPER_ENV_DIR
+    data_dir: Path = field(init=False)
+    cfg_file: Path = field(init=False)
+    env_file: Path = field(init=False)
+    serial: Path = field(init=False)
+    uds: Path = field(init=False)
 
-    def __init__(self, suffix: str = ""):
-        super().__init__(instance_type=self, suffix=suffix)
-        self.klipper_dir: Path = KLIPPER_DIR
-        self.env_dir: Path = KLIPPER_ENV_DIR
-        self._cfg_file = self.cfg_dir.joinpath("printer.cfg")
-        self._log = self.log_dir.joinpath("klippy.log")
-        self._serial = self.comms_dir.joinpath("klippy.serial")
-        self._uds = self.comms_dir.joinpath("klippy.sock")
+    def __post_init__(self):
+        self.base: BaseInstance = BaseInstance(Klipper, self.suffix)
+        self.base.log_file_name = self.log_file_name
 
-    @property
-    def cfg_file(self) -> Path:
-        return self._cfg_file
-
-    @property
-    def log(self) -> Path:
-        return self._log
-
-    @property
-    def serial(self) -> Path:
-        return self._serial
-
-    @property
-    def uds(self) -> Path:
-        return self._uds
+        self.service_file_path: Path = get_service_file_path(Klipper, self.suffix)
+        self.data_dir: Path = get_data_dir(Klipper, self.suffix)
+        self.cfg_file: Path = self.base.cfg_dir.joinpath(KLIPPER_CFG_NAME)
+        self.env_file: Path = self.base.sysd_dir.joinpath(KLIPPER_ENV_FILE_NAME)
+        self.serial: Path = self.base.comms_dir.joinpath(KLIPPER_SERIAL_NAME)
+        self.uds: Path = self.base.comms_dir.joinpath(KLIPPER_UDS_NAME)
 
     def create(self) -> None:
+        from utils.sys_utils import create_env_file, create_service_file
+
         Logger.print_status("Creating new Klipper Instance ...")
-        service_template_path = MODULE_PATH.joinpath("assets/klipper.service")
-        service_file_name = self.get_service_file_name(extension=True)
-        service_file_target = SYSTEMD.joinpath(service_file_name)
-        env_template_file_path = MODULE_PATH.joinpath("assets/klipper.env")
-        env_file_target = self.sysd_dir.joinpath("klipper.env")
 
         try:
-            self.create_folders()
-            self.write_service_file(
-                service_template_path, service_file_target, env_file_target
-            )
-            self.write_env_file(env_template_file_path, env_file_target)
+            create_folders(self.base.base_folders)
 
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(
-                f"Error creating service file {service_file_target}: {e}"
+            create_service_file(
+                name=self.service_file_path.name,
+                content=self._prep_service_file_content(),
             )
+
+            create_env_file(
+                path=self.base.sysd_dir.joinpath(KLIPPER_ENV_FILE_NAME),
+                content=self._prep_env_file_content(),
+            )
+
+        except CalledProcessError as e:
+            Logger.print_error(f"Error creating instance: {e}")
             raise
         except OSError as e:
-            Logger.print_error(f"Error creating env file {env_file_target}: {e}")
+            Logger.print_error(f"Error creating env file: {e}")
             raise
 
-    def delete(self) -> None:
-        service_file = self.get_service_file_name(extension=True)
-        service_file_path = self.get_service_file_path()
-
-        Logger.print_status(f"Deleting Klipper Instance: {service_file}")
+    def _prep_service_file_content(self) -> str:
+        template = KLIPPER_SERVICE_TEMPLATE
 
         try:
-            command = ["sudo", "rm", "-f", service_file_path]
-            subprocess.run(command, check=True)
-            Logger.print_ok(f"Service file deleted: {service_file_path}")
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(f"Error deleting service file: {e}")
-            raise
-
-    def write_service_file(
-        self,
-        service_template_path: Path,
-        service_file_target: Path,
-        env_file_target: Path,
-    ) -> None:
-        service_content = self._prep_service_file(
-            service_template_path, env_file_target
-        )
-        command = ["sudo", "tee", service_file_target]
-        subprocess.run(
-            command,
-            input=service_content.encode(),
-            stdout=subprocess.DEVNULL,
-            check=True,
-        )
-        Logger.print_ok(f"Service file created: {service_file_target}")
-
-    def write_env_file(
-        self, env_template_file_path: Path, env_file_target: Path
-    ) -> None:
-        env_file_content = self._prep_env_file(env_template_file_path)
-        with open(env_file_target, "w") as env_file:
-            env_file.write(env_file_content)
-        Logger.print_ok(f"Env file created: {env_file_target}")
-
-    def _prep_service_file(
-        self, service_template_path: Path, env_file_path: Path
-    ) -> str:
-        try:
-            with open(service_template_path, "r") as template_file:
+            with open(template, "r") as template_file:
                 template_content = template_file.read()
         except FileNotFoundError:
-            Logger.print_error(
-                f"Unable to open {service_template_path} - File not found"
-            )
+            Logger.print_error(f"Unable to open {template} - File not found")
             raise
-        service_content = template_content.replace("%USER%", self.user)
-        service_content = service_content.replace(
-            "%KLIPPER_DIR%", str(self.klipper_dir)
+
+        service_content = template_content.replace(
+            "%USER%",
+            CURRENT_USER,
+        )
+        service_content = service_content.replace(
+            "%KLIPPER_DIR%",
+            self.klipper_dir.as_posix(),
+        )
+        service_content = service_content.replace(
+            "%ENV%",
+            self.env_dir.as_posix(),
+        )
+        service_content = service_content.replace(
+            "%ENV_FILE%",
+            self.base.sysd_dir.joinpath(KLIPPER_ENV_FILE_NAME).as_posix(),
         )
-        service_content = service_content.replace("%ENV%", str(self.env_dir))
-        service_content = service_content.replace("%ENV_FILE%", str(env_file_path))
         return service_content
 
-    def _prep_env_file(self, env_template_file_path: Path) -> str:
+    def _prep_env_file_content(self) -> str:
+        template = KLIPPER_ENV_FILE_TEMPLATE
+
         try:
-            with open(env_template_file_path, "r") as env_file:
+            with open(template, "r") as env_file:
                 env_template_file_content = env_file.read()
         except FileNotFoundError:
-            Logger.print_error(
-                f"Unable to open {env_template_file_path} - File not found"
-            )
+            Logger.print_error(f"Unable to open {template} - File not found")
             raise
+
         env_file_content = env_template_file_content.replace(
-            "%KLIPPER_DIR%", str(self.klipper_dir)
+            "%KLIPPER_DIR%", self.klipper_dir.as_posix()
         )
         env_file_content = env_file_content.replace(
-            "%CFG%", f"{self.cfg_dir}/printer.cfg"
+            "%CFG%",
+            f"{self.base.cfg_dir}/{KLIPPER_CFG_NAME}",
         )
-        env_file_content = env_file_content.replace("%SERIAL%", str(self.serial))
-        env_file_content = env_file_content.replace("%LOG%", str(self.log))
-        env_file_content = env_file_content.replace("%UDS%", str(self.uds))
+        env_file_content = env_file_content.replace(
+            "%SERIAL%",
+            self.serial.as_posix() if self.serial else "",
+        )
+        env_file_content = env_file_content.replace(
+            "%LOG%",
+            self.base.log_dir.joinpath(self.log_file_name).as_posix(),
+        )
+        env_file_content = env_file_content.replace(
+            "%UDS%",
+            self.uds.as_posix() if self.uds else "",
+        )
+
         return env_file_content

kiauh/components/klipper/klipper_dialogs.py

@@ -11,14 +11,14 @@ import textwrap
 from enum import Enum, unique
 from typing import List
 
-from core.instance_manager.base_instance import BaseInstance
-from core.menus.base_menu import print_back_footer
-from utils.constants import (
+from core.constants import (
     COLOR_CYAN,
     COLOR_GREEN,
     COLOR_YELLOW,
     RESET_FORMAT,
 )
+from core.menus.base_menu import print_back_footer
+from utils.instance_type import InstanceType
 
 
 @unique
@@ -28,12 +28,13 @@ class DisplayType(Enum):
 
 
 def print_instance_overview(
-    instances: List[BaseInstance],
+    instances: List[InstanceType],
     display_type: DisplayType = DisplayType.SERVICE_NAME,
     show_headline=True,
     show_index=False,
+    start_index=0,
     show_select_all=False,
-):
+) -> None:
     dialog = "╔═══════════════════════════════════════════════════════╗\n"
     if show_headline:
         d_type = (
@@ -52,10 +53,10 @@ def print_instance_overview(
 
     for i, s in enumerate(instances):
         if display_type is DisplayType.SERVICE_NAME:
-            name = s.get_service_file_name()
+            name = s.service_file_path.stem
         else:
             name = s.data_dir
-        line = f"{COLOR_CYAN}{f'{i})' if show_index else '●'} {name}{RESET_FORMAT}"
+        line = f"{COLOR_CYAN}{f'{i + start_index})' if show_index else '●'} {name}{RESET_FORMAT}"
         dialog += f"║ {line:<63}║\n"
     dialog += "╟───────────────────────────────────────────────────────╢\n"
 
@@ -63,7 +64,7 @@ def print_instance_overview(
     print_back_footer()
 
 
-def print_select_instance_count_dialog():
+def print_select_instance_count_dialog() -> None:
     line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
     line2 = f"{COLOR_YELLOW}Setting up too many instances may crash your system.{RESET_FORMAT}"
     dialog = textwrap.dedent(
@@ -83,15 +84,25 @@ def print_select_instance_count_dialog():
     print_back_footer()
 
 
-def print_select_custom_name_dialog():
+def print_select_custom_name_dialog() -> None:
     line1 = f"{COLOR_YELLOW}INFO:{RESET_FORMAT}"
     line2 = f"{COLOR_YELLOW}Only alphanumeric characters are allowed!{RESET_FORMAT}"
     dialog = textwrap.dedent(
         f"""
         ╔═══════════════════════════════════════════════════════╗
-        ║ You can now assign a custom name to each instance.    ║
+        ║ Do you want to assign a custom name to each instance? ║
+        ║                                                       ║
+        ║ Assigning a custom name will create a Klipper service ║
+        ║ and a printer directory with the chosen name.         ║
+        ║                                                       ║
+        ║ Example for custom name 'kiauh':                      ║
+        ║  ● Klipper service:   klipper-kiauh.service           ║
+        ║  ● Printer directory: printer_kiauh_data              ║
+        ║                                                       ║
         ║ If skipped, each instance will get an index assigned  ║
-        ║ in ascending order, starting at index '1'.            ║
+        ║ in ascending order, starting at '1' in case of a new  ║
+        ║ installation. Otherwise, the index will be derived    ║
+        ║ from amount of already existing instances.            ║
         ║                                                       ║
         ║ {line1:<63}║
         ║ {line2:<63}║

kiauh/components/klipper/klipper_remove.py

@@ -6,126 +6,90 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
-import shutil
-from typing import List, Union
+from typing import List
 
 from components.klipper import KLIPPER_DIR, KLIPPER_ENV_DIR
 from components.klipper.klipper import Klipper
 from components.klipper.klipper_dialogs import print_instance_overview
 from core.instance_manager.instance_manager import InstanceManager
-from utils.fs_utils import remove_file
+from core.logger import Logger
+from utils.fs_utils import run_remove_routines
 from utils.input_utils import get_selection_input
-from utils.logger import Logger
-from utils.sys_utils import cmd_sysctl_manage
+from utils.instance_utils import get_instances
+from utils.sys_utils import unit_file_exists
 
 
 def run_klipper_removal(
     remove_service: bool,
     remove_dir: bool,
     remove_env: bool,
-    delete_logs: bool,
 ) -> None:
-    im = InstanceManager(Klipper)
+    klipper_instances: List[Klipper] = get_instances(Klipper)
 
     if remove_service:
         Logger.print_status("Removing Klipper instances ...")
-        if im.instances:
-            instances_to_remove = select_instances_to_remove(im.instances)
-            remove_instances(im, instances_to_remove)
+        if klipper_instances:
+            instances_to_remove = select_instances_to_remove(klipper_instances)
+            remove_instances(instances_to_remove)
         else:
             Logger.print_info("No Klipper Services installed! Skipped ...")
 
-    if (remove_dir or remove_env) and im.instances:
-        Logger.print_warn("There are still other Klipper services installed!")
-        Logger.print_warn("Therefor the following parts cannot be removed:")
-        Logger.print_warn(
-            """
-            ● Klipper local repository
-            ● Klipper Python environment
-            """,
-            False,
-        )
+    if (remove_dir or remove_env) and unit_file_exists("klipper", suffix="service"):
+        Logger.print_info("There are still other Klipper services installed:")
+        Logger.print_info(f"● '{KLIPPER_DIR}' was not removed.", prefix=False)
+        Logger.print_info(f"● '{KLIPPER_ENV_DIR}' was not removed.", prefix=False)
     else:
         if remove_dir:
             Logger.print_status("Removing Klipper local repository ...")
-            remove_klipper_dir()
+            run_remove_routines(KLIPPER_DIR)
         if remove_env:
             Logger.print_status("Removing Klipper Python environment ...")
-            remove_klipper_env()
-
-    # delete klipper logs of all instances
-    if delete_logs:
-        Logger.print_status("Removing all Klipper logs ...")
-        delete_klipper_logs(im.instances)
+            run_remove_routines(KLIPPER_ENV_DIR)
 
 
-def select_instances_to_remove(
-    instances: List[Klipper],
-) -> Union[List[Klipper], None]:
-    print_instance_overview(instances, show_index=True, show_select_all=True)
-
-    options = [str(i) for i in range(len(instances))]
-    options.extend(["a", "A", "b", "B"])
+def select_instances_to_remove(instances: List[Klipper]) -> List[Klipper] | None:
+    start_index = 1
+    options = [str(i + start_index) for i in range(len(instances))]
+    options.extend(["a", "b"])
+    instance_map = {options[i]: instances[i] for i in range(len(instances))}
 
+    print_instance_overview(
+        instances,
+        start_index=start_index,
+        show_index=True,
+        show_select_all=True,
+    )
     selection = get_selection_input("Select Klipper instance to remove", options)
 
     instances_to_remove = []
-    if selection == "b".lower():
+    if selection == "b":
         return None
-    elif selection == "a".lower():
+    elif selection == "a":
         instances_to_remove.extend(instances)
     else:
-        instance = instances[int(selection)]
-        instances_to_remove.append(instance)
+        instances_to_remove.append(instance_map[selection])
 
     return instances_to_remove
 
 
 def remove_instances(
-    instance_manager: InstanceManager,
-    instance_list: List[Klipper],
+    instance_list: List[Klipper] | None,
 ) -> None:
+    if not instance_list:
+        return
+
     for instance in instance_list:
-        Logger.print_status(f"Removing instance {instance.get_service_file_name()} ...")
-        instance_manager.current_instance = instance
-        instance_manager.stop_instance()
-        instance_manager.disable_instance()
-        instance_manager.delete_instance()
-
-    cmd_sysctl_manage("daemon-reload")
+        Logger.print_status(f"Removing instance {instance.service_file_path.stem} ...")
+        InstanceManager.remove(instance)
+        delete_klipper_env_file(instance)
 
 
-def remove_klipper_dir() -> None:
-    if not KLIPPER_DIR.exists():
-        Logger.print_info(f"'{KLIPPER_DIR}' does not exist. Skipped ...")
+def delete_klipper_env_file(instance: Klipper):
+    Logger.print_status(f"Remove '{instance.env_file}'")
+    if not instance.env_file.exists():
+        msg = f"Env file in {instance.base.sysd_dir} not found. Skipped ..."
+        Logger.print_info(msg)
         return
-
-    try:
-        shutil.rmtree(KLIPPER_DIR)
-    except OSError as e:
-        Logger.print_error(f"Unable to delete '{KLIPPER_DIR}':\n{e}")
-
-
-def remove_klipper_env() -> None:
-    if not KLIPPER_ENV_DIR.exists():
-        Logger.print_info(f"'{KLIPPER_ENV_DIR}' does not exist. Skipped ...")
-        return
-
-    try:
-        shutil.rmtree(KLIPPER_ENV_DIR)
-    except OSError as e:
-        Logger.print_error(f"Unable to delete '{KLIPPER_ENV_DIR}':\n{e}")
-
-
-def delete_klipper_logs(instances: List[Klipper]) -> None:
-    all_logfiles = []
-    for instance in instances:
-        all_logfiles = list(instance.log_dir.glob("klippy.log*"))
-    if not all_logfiles:
-        Logger.print_info("No Klipper logs found. Skipped ...")
-        return
-
-    for log in all_logfiles:
-        Logger.print_status(f"Remove '{log}'")
-        remove_file(log)
+    run_remove_routines(instance.env_file)

kiauh/components/klipper/klipper_setup.py

@@ -6,41 +6,44 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 from pathlib import Path
+from typing import Dict, List, Tuple
 
 from components.klipper import (
     EXIT_KLIPPER_SETUP,
     KLIPPER_DIR,
     KLIPPER_ENV_DIR,
-    KLIPPER_REQUIREMENTS_TXT,
+    KLIPPER_INSTALL_SCRIPT,
+    KLIPPER_REQ_FILE,
 )
 from components.klipper.klipper import Klipper
+from components.klipper.klipper_dialogs import (
+    print_select_custom_name_dialog,
+)
 from components.klipper.klipper_utils import (
-    add_to_existing,
+    assign_custom_name,
     backup_klipper_dir,
-    check_is_single_to_multi_conversion,
     check_user_groups,
     create_example_printer_cfg,
     get_install_count,
     handle_disruptive_system_packages,
-    handle_instance_naming,
-    handle_to_multi_instance_conversion,
-    init_name_scheme,
-    update_name_scheme,
 )
 from components.moonraker.moonraker import Moonraker
 from components.webui_client.client_utils import (
     get_existing_clients,
 )
 from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
 from core.settings.kiauh_settings import KiauhSettings
 from utils.common import check_install_dependencies
 from utils.git_utils import git_clone_wrapper, git_pull_wrapper
 from utils.input_utils import get_confirm
-from utils.logger import DialogType, Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
     cmd_sysctl_manage,
+    cmd_sysctl_service,
     create_python_venv,
     install_python_requirements,
     parse_packages_from_file,
@@ -48,57 +51,74 @@ from utils.sys_utils import (
 
 
 def install_klipper() -> None:
-    kl_im = InstanceManager(Klipper)
+    Logger.print_status("Installing Klipper ...")
 
-    # ask to add new instances, if there are existing ones
-    if kl_im.instances and not add_to_existing():
-        Logger.print_status(EXIT_KLIPPER_SETUP)
-        return
+    klipper_list: List[Klipper] = get_instances(Klipper)
+    moonraker_list: List[Moonraker] = get_instances(Moonraker)
+    match_moonraker: bool = False
 
-    install_count = get_install_count()
-    if install_count is None:
-        Logger.print_status(EXIT_KLIPPER_SETUP)
-        return
+    # if there are more moonraker instances than klipper instances, ask the user to
+    # match the klipper instance count to the count of moonraker instances with the same suffix
+    if len(moonraker_list) > len(klipper_list):
+        is_confirmed = display_moonraker_info(moonraker_list)
+        if not is_confirmed:
+            Logger.print_status(EXIT_KLIPPER_SETUP)
+            return
+        match_moonraker = True
 
-    # create a dict of the size of the existing instances + install count
-    name_dict = {c: "" for c in range(len(kl_im.instances) + install_count)}
-    name_scheme = init_name_scheme(kl_im.instances, install_count)
-    mr_im = InstanceManager(Moonraker)
-    name_scheme = update_name_scheme(
-        name_scheme, name_dict, kl_im.instances, mr_im.instances
+    install_count, name_dict = get_install_count_and_name_dict(
+        klipper_list, moonraker_list
     )
 
-    handle_instance_naming(name_dict, name_scheme)
+    if install_count == 0:
+        Logger.print_status(EXIT_KLIPPER_SETUP)
+        return
+
+    is_multi_install = install_count > 1 or (len(name_dict) >= 1 and install_count >= 1)
+    if not name_dict and install_count == 1:
+        name_dict = {0: ""}
+    elif is_multi_install and not match_moonraker:
+        custom_names = use_custom_names_or_go_back()
+        if custom_names is None:
+            Logger.print_status(EXIT_KLIPPER_SETUP)
+            return
+
+        handle_instance_names(install_count, name_dict, custom_names)
 
     create_example_cfg = get_confirm("Create example printer.cfg?")
-
+    # run the actual installation
     try:
-        if not kl_im.instances:
-            check_install_dependencies(["git"])
-            setup_klipper_prerequesites()
-
-        count = 0
-        for name in name_dict:
-            if name_dict[name] in [n.suffix for n in kl_im.instances]:
-                continue
-
-            if check_is_single_to_multi_conversion(kl_im.instances):
-                handle_to_multi_instance_conversion(name_dict[name])
-                continue
-
-            count += 1
-            create_klipper_instance(name_dict[name], create_example_cfg)
-
-            if count == install_count:
-                break
-
-        cmd_sysctl_manage("daemon-reload")
-
+        run_klipper_setup(klipper_list, name_dict, create_example_cfg)
     except Exception as e:
         Logger.print_error(e)
         Logger.print_error("Klipper installation failed!")
         return
 
+
+def run_klipper_setup(
+    klipper_list: List[Klipper], name_dict: Dict[int, str], create_example_cfg: bool
+) -> None:
+    if not klipper_list:
+        setup_klipper_prerequesites()
+
+    for i in name_dict:
+        # skip this iteration if there is already an instance with the name
+        if name_dict[i] in [n.suffix for n in klipper_list]:
+            continue
+
+        instance = Klipper(suffix=name_dict[i])
+        instance.create()
+        cmd_sysctl_service(instance.service_file_path.name, "enable")
+
+        if create_example_cfg:
+            # if a client-config is installed, include it in the new example cfg
+            clients = get_existing_clients()
+            create_example_printer_cfg(instance, clients)
+
+        cmd_sysctl_service(instance.service_file_path.name, "start")
+
+    cmd_sysctl_manage("daemon-reload")
+
     # step 4: check/handle conflicting packages/services
     handle_disruptive_system_packages()
 
@@ -106,6 +126,35 @@ def install_klipper() -> None:
     check_user_groups()
 
 
+def handle_instance_names(
+    install_count: int, name_dict: Dict[int, str], custom_names: bool
+) -> None:
+    for i in range(install_count):  # 3
+        key: int = len(name_dict.keys()) + 1
+        if custom_names:
+            assign_custom_name(key, name_dict)
+        else:
+            name_dict[key] = str(len(name_dict) + 1)
+
+
+def get_install_count_and_name_dict(
+    klipper_list: List[Klipper], moonraker_list: List[Moonraker]
+) -> Tuple[int, Dict[int, str]]:
+    install_count: int | None
+    if len(moonraker_list) > len(klipper_list):
+        install_count = len(moonraker_list)
+        name_dict = {i: moonraker.suffix for i, moonraker in enumerate(moonraker_list)}
+    else:
+        install_count = get_install_count()
+        name_dict = {i: klipper.suffix for i, klipper in enumerate(klipper_list)}
+
+        if install_count is None:
+            Logger.print_status(EXIT_KLIPPER_SETUP)
+            return 0, {}
+
+    return install_count, name_dict
+
+
 def setup_klipper_prerequesites() -> None:
     settings = KiauhSettings()
     repo = settings.klipper.repo_url
@@ -115,26 +164,23 @@ def setup_klipper_prerequesites() -> None:
 
     # install klipper dependencies and create python virtualenv
     try:
-        install_klipper_packages(KLIPPER_DIR)
-        create_python_venv(KLIPPER_ENV_DIR)
-        install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQUIREMENTS_TXT)
+        install_klipper_packages()
+        if create_python_venv(KLIPPER_ENV_DIR):
+            install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
     except Exception:
         Logger.print_error("Error during installation of Klipper requirements!")
         raise
 
 
-def install_klipper_packages(klipper_dir: Path) -> None:
-    script = klipper_dir.joinpath("scripts/install-debian.sh")
+def install_klipper_packages() -> None:
+    script = KLIPPER_INSTALL_SCRIPT
     packages = parse_packages_from_file(script)
-    packages = [pkg.replace("python-dev", "python3-dev") for pkg in packages]
-    packages.append("python3-venv")
-    # Add dfu-util for octopi-images
-    packages.append("dfu-util")
+
     # Add dbus requirement for DietPi distro
     if Path("/boot/dietpi/.version").exists():
         packages.append("dbus")
 
-    check_install_dependencies(packages)
+    check_install_dependencies({*packages})
 
 
 def update_klipper() -> None:
@@ -145,7 +191,6 @@ def update_klipper() -> None:
             "All Klipper instances will be restarted during the update process and "
             "ongoing prints WILL FAIL.",
         ],
-        end="",
     )
 
     if not get_confirm("Update Klipper now?"):
@@ -155,27 +200,40 @@ def update_klipper() -> None:
     if settings.kiauh.backup_before_update:
         backup_klipper_dir()
 
-    instance_manager = InstanceManager(Klipper)
-    instance_manager.stop_all_instance()
+    instances = get_instances(Klipper)
+    InstanceManager.stop_all(instances)
 
     git_pull_wrapper(repo=settings.klipper.repo_url, target_dir=KLIPPER_DIR)
 
     # install possible new system packages
-    install_klipper_packages(KLIPPER_DIR)
+    install_klipper_packages()
     # install possible new python dependencies
-    install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQUIREMENTS_TXT)
+    install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
 
-    instance_manager.start_all_instance()
+    InstanceManager.start_all(instances)
 
 
-def create_klipper_instance(name: str, create_example_cfg: bool) -> None:
-    kl_im = InstanceManager(Klipper)
-    new_instance = Klipper(suffix=name)
-    kl_im.current_instance = new_instance
-    kl_im.create_instance()
-    kl_im.enable_instance()
-    if create_example_cfg:
-        # if a client-config is installed, include it in the new example cfg
-        clients = get_existing_clients()
-        create_example_printer_cfg(new_instance, clients)
-    kl_im.start_instance()
+def use_custom_names_or_go_back() -> bool | None:
+    print_select_custom_name_dialog()
+    _input: bool | None = get_confirm(
+        "Assign custom names?",
+        False,
+        allow_go_back=True,
+    )
+    return _input
+
+
+def display_moonraker_info(moonraker_list: List[Moonraker]) -> bool:
+    # todo: only show the klipper instances that are not already installed
+    Logger.print_dialog(
+        DialogType.INFO,
+        [
+            "Existing Moonraker instances detected:",
+            *[f"● {m.service_file_path.stem}" for m in moonraker_list],
+            "\n\n",
+            "The following Klipper instances will be installed:",
+            *[f"● klipper-{m.suffix}" for m in moonraker_list],
+        ],
+    )
+    _input: bool = get_confirm("Proceed with installation?")
+    return _input

kiauh/components/klipper/klipper_utils.py

@@ -6,13 +6,13 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import grp
 import os
-import re
 import shutil
 from subprocess import CalledProcessError, run
-from typing import Dict, List, Optional, Union
+from typing import Dict, List
 
 from components.klipper import (
     KLIPPER_BACKUP_DIR,
@@ -23,185 +23,68 @@ from components.klipper import (
 from components.klipper.klipper import Klipper
 from components.klipper.klipper_dialogs import (
     print_instance_overview,
-    print_select_custom_name_dialog,
     print_select_instance_count_dialog,
 )
-from components.moonraker.moonraker import Moonraker
-from components.moonraker.moonraker_utils import moonraker_to_multi_conversion
 from components.webui_client.base_data import BaseWebClient
 from components.webui_client.client_config.client_config_setup import (
     create_client_config_symlink,
 )
 from core.backup_manager.backup_manager import BackupManager
-from core.instance_manager.base_instance import BaseInstance
-from core.instance_manager.instance_manager import InstanceManager
-from core.instance_manager.name_scheme import NameScheme
+from core.constants import CURRENT_USER
+from core.instance_manager.base_instance import SUFFIX_BLACKLIST
+from core.logger import DialogType, Logger
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
-from utils import PRINTER_CFG_BACKUP_DIR
+from core.types import ComponentStatus
 from utils.common import get_install_status
-from utils.constants import CURRENT_USER
 from utils.input_utils import get_confirm, get_number_input, get_string_input
-from utils.logger import DialogType, Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import cmd_sysctl_service
-from utils.types import ComponentStatus
 
 
 def get_klipper_status() -> ComponentStatus:
     return get_install_status(KLIPPER_DIR, KLIPPER_ENV_DIR, Klipper)
 
 
-def check_is_multi_install(
-    existing_instances: List[Klipper], install_count: int
-) -> bool:
-    return not existing_instances and install_count > 1
-
-
-def check_is_single_to_multi_conversion(
-    existing_instances: List[Klipper],
-) -> bool:
-    return len(existing_instances) == 1 and existing_instances[0].suffix == ""
-
-
-def init_name_scheme(
-    existing_instances: List[Klipper], install_count: int
-) -> NameScheme:
-    if check_is_multi_install(
-        existing_instances, install_count
-    ) or check_is_single_to_multi_conversion(existing_instances):
-        print_select_custom_name_dialog()
-        if get_confirm("Assign custom names?", False, allow_go_back=True):
-            return NameScheme.CUSTOM
-        else:
-            return NameScheme.INDEX
-    else:
-        return NameScheme.SINGLE
-
-
-def update_name_scheme(
-    name_scheme: NameScheme,
-    name_dict: Dict[int, str],
-    klipper_instances: List[Klipper],
-    moonraker_instances: List[Moonraker],
-) -> NameScheme:
-    # if there are more moonraker instances installed
-    # than klipper, we load their names into the name_dict,
-    # as we will detect and enforce that naming scheme
-    if len(moonraker_instances) > len(klipper_instances):
-        update_name_dict(name_dict, moonraker_instances)
-        return detect_name_scheme(moonraker_instances)
-    elif len(klipper_instances) > 1:
-        update_name_dict(name_dict, klipper_instances)
-        return detect_name_scheme(klipper_instances)
-    else:
-        return name_scheme
-
-
-def update_name_dict(name_dict: Dict[int, str], instances: List[BaseInstance]) -> None:
-    for k, v in enumerate(instances):
-        name_dict[k] = v.suffix
-
-
-def handle_instance_naming(name_dict: Dict[int, str], name_scheme: NameScheme) -> None:
-    if name_scheme == NameScheme.SINGLE:
-        return
-
-    for k in name_dict:
-        if name_dict[k] == "" and name_scheme == NameScheme.INDEX:
-            name_dict[k] = str(k + 1)
-        elif name_dict[k] == "" and name_scheme == NameScheme.CUSTOM:
-            assign_custom_name(k, name_dict)
-
-
-def add_to_existing() -> bool:
-    kl_instances = InstanceManager(Klipper).instances
+def add_to_existing() -> bool | None:
+    kl_instances: List[Klipper] = get_instances(Klipper)
     print_instance_overview(kl_instances)
-    return get_confirm("Add new instances?", allow_go_back=True)
+    _input: bool | None = get_confirm("Add new instances?", allow_go_back=True)
+    return _input
 
 
-def get_install_count() -> Union[int, None]:
+def get_install_count() -> int | None:
     """
     Print a dialog for selecting the amount of Klipper instances
     to set up with an option to navigate back. Returns None if the
     user selected to go back, otherwise an integer greater or equal than 1 |
     :return: Integer >= 1 or None
     """
-    kl_instances = InstanceManager(Klipper).instances
+    kl_instances = get_instances(Klipper)
     print_select_instance_count_dialog()
     question = (
         f"Number of"
         f"{' additional' if len(kl_instances) > 0 else ''} "
         f"Klipper instances to set up"
     )
-    return get_number_input(question, 1, default=1, allow_go_back=True)
+    _input: int | None = get_number_input(question, 1, default=1, allow_go_back=True)
+    return _input
 
 
 def assign_custom_name(key: int, name_dict: Dict[int, str]) -> None:
     existing_names = []
-    existing_names.extend(Klipper.blacklist())
+    existing_names.extend(SUFFIX_BLACKLIST)
     existing_names.extend(name_dict[n] for n in name_dict)
-    question = f"Enter name for instance {key + 1}"
-    name_dict[key] = get_string_input(question, exclude=existing_names)
+    pattern = r"^[a-zA-Z0-9]+$"
+
+    question = f"Enter name for instance {key}"
+    name_dict[key] = get_string_input(question, exclude=existing_names, regex=pattern)
 
 
-def handle_to_multi_instance_conversion(new_name: str) -> None:
-    Logger.print_status("Converting single instance to multi instances ...")
-    klipper_to_multi_conversion(new_name)
-    moonraker_to_multi_conversion(new_name)
-
-
-def klipper_to_multi_conversion(new_name: str) -> None:
-    Logger.print_status("Convert Klipper single to multi instance ...")
-    im = InstanceManager(Klipper)
-    im.current_instance = im.instances[0]
-
-    # temporarily store the data dir path
-    old_data_dir = im.instances[0].data_dir
-    old_data_dir_name = im.instances[0].data_dir_name
-
-    # backup the old data_dir
-    bm = BackupManager()
-    name = f"config-{old_data_dir_name}"
-    bm.backup_directory(
-        name,
-        source=im.current_instance.cfg_dir,
-        target=PRINTER_CFG_BACKUP_DIR,
-    )
-
-    # remove the old single instance
-    im.stop_instance()
-    im.disable_instance()
-    im.delete_instance()
-
-    # create a new klipper instance with the new name
-    new_instance = Klipper(suffix=new_name)
-    im.current_instance = new_instance
-
-    if not new_instance.data_dir.is_dir():
-        # rename the old data dir and use it for the new instance
-        Logger.print_status(f"Rename '{old_data_dir}' to '{new_instance.data_dir}' ...")
-        old_data_dir.rename(new_instance.data_dir)
-    else:
-        Logger.print_info(f"Existing '{new_instance.data_dir}' found ...")
-
-    # patch the virtual_sdcard sections path
-    # value to match the new printer_data foldername
-    scp = SimpleConfigParser()
-    scp.read(new_instance.cfg_file)
-    if scp.has_section("virtual_sdcard"):
-        scp.set("virtual_sdcard", "path", str(new_instance.gcodes_dir))
-        scp.write(new_instance.cfg_file)
-
-    # finalize creating the new instance
-    im.create_instance()
-    im.enable_instance()
-    im.start_instance()
-
-
-def check_user_groups():
+def check_user_groups() -> None:
     user_groups = [grp.getgrgid(gid).gr_name for gid in os.getgroups()]
-    missing_groups = [g for g in user_groups if g == "tty" or g == "dialout"]
+    missing_groups = [g for g in ["tty", "dialout"] if g not in user_groups]
 
     if not missing_groups:
         return
@@ -220,7 +103,6 @@ def check_user_groups():
             "INFO:",
             "Relog required for group assignments to take effect!",
         ],
-        end="",
     )
 
     if not get_confirm(f"Add user '{CURRENT_USER}' to group(s) now?"):
@@ -272,27 +154,13 @@ def handle_disruptive_system_packages() -> None:
                     "Please fix the problem manually. Otherwise, this may have "
                     "undesirable effects on the operation of Klipper."
                 ],
-                end="",
             )
 
 
-def detect_name_scheme(instance_list: List[BaseInstance]) -> NameScheme:
-    pattern = re.compile("^\d+$")
-    for instance in instance_list:
-        if not pattern.match(instance.suffix):
-            return NameScheme.CUSTOM
-
-    return NameScheme.INDEX
-
-
-def get_highest_index(instance_list: List[Klipper]) -> int:
-    return max([int(instance.suffix.split("-")[-1]) for instance in instance_list])
-
-
 def create_example_printer_cfg(
-    instance: Klipper, clients: Optional[List[BaseWebClient]] = None
+    instance: Klipper, clients: List[BaseWebClient] | None = None
 ) -> None:
-    Logger.print_status(f"Creating example printer.cfg in '{instance.cfg_dir}'")
+    Logger.print_status(f"Creating example printer.cfg in '{instance.base.cfg_dir}'")
     if instance.cfg_file.is_file():
         Logger.print_info(f"'{instance.cfg_file}' already exists.")
         return
@@ -306,8 +174,8 @@ def create_example_printer_cfg(
         return
 
     scp = SimpleConfigParser()
-    scp.read(target)
-    scp.set("virtual_sdcard", "path", str(instance.gcodes_dir))
+    scp.read_file(target)
+    scp.set_option("virtual_sdcard", "path", str(instance.base.gcodes_dir))
 
     # include existing client configs in the example config
     if clients is not None and len(clients) > 0:
@@ -317,9 +185,9 @@ def create_example_printer_cfg(
             scp.add_section(section=section)
             create_client_config_symlink(client_config, [instance])
 
-    scp.write(target)
+    scp.write_file(target)
 
-    Logger.print_ok(f"Example printer.cfg created in '{instance.cfg_dir}'")
+    Logger.print_ok(f"Example printer.cfg created in '{instance.base.cfg_dir}'")
 
 
 def backup_klipper_dir() -> None:

kiauh/components/klipper/menus/klipper_remove_menu.py

@@ -6,42 +6,40 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
-from typing import Optional, Type
+from typing import Type
 
 from components.klipper import klipper_remove
+from core.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
 from core.menus import FooterType, Option
 from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
 
 
 # noinspection PyUnusedLocal
 class KlipperRemoveMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
-        self.previous_menu = previous_menu
-        self.footer_type = FooterType.BACK_HELP
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+        self.footer_type = FooterType.BACK
         self.remove_klipper_service = False
         self.remove_klipper_dir = False
         self.remove_klipper_env = False
-        self.delete_klipper_logs = False
+        self.selection_state = False
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.remove_menu import RemoveMenu
 
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else RemoveMenu
-        )
+        self.previous_menu = previous_menu if previous_menu is not None else RemoveMenu
 
     def set_options(self) -> None:
         self.options = {
-            "0": Option(method=self.toggle_all, menu=False),
-            "1": Option(method=self.toggle_remove_klipper_service, menu=False),
-            "2": Option(method=self.toggle_remove_klipper_dir, menu=False),
-            "3": Option(method=self.toggle_remove_klipper_env, menu=False),
-            "4": Option(method=self.toggle_delete_klipper_logs, menu=False),
-            "c": Option(method=self.run_removal_process, menu=False),
+            "a": Option(method=self.toggle_all),
+            "1": Option(method=self.toggle_remove_klipper_service),
+            "2": Option(method=self.toggle_remove_klipper_dir),
+            "3": Option(method=self.toggle_remove_klipper_env),
+            "c": Option(method=self.run_removal_process),
         }
 
     def print_menu(self) -> None:
@@ -53,7 +51,6 @@ class KlipperRemoveMenu(BaseMenu):
         o1 = checked if self.remove_klipper_service else unchecked
         o2 = checked if self.remove_klipper_dir else unchecked
         o3 = checked if self.remove_klipper_env else unchecked
-        o4 = checked if self.delete_klipper_logs else unchecked
         menu = textwrap.dedent(
             f"""
             ╔═══════════════════════════════════════════════════════╗
@@ -62,12 +59,11 @@ class KlipperRemoveMenu(BaseMenu):
             ║ Enter a number and hit enter to select / deselect     ║
             ║ the specific option for removal.                      ║
             ╟───────────────────────────────────────────────────────╢
-            ║  0) Select everything                                 ║
+            ║  a) {self._get_selection_state_str():37}             ║
             ╟───────────────────────────────────────────────────────╢
             ║  1) {o1} Remove Service                                ║
             ║  2) {o2} Remove Local Repository                       ║
             ║  3) {o3} Remove Python Environment                     ║
-            ║  4) {o4} Delete all Log-Files                          ║
             ╟───────────────────────────────────────────────────────╢
             ║  C) Continue                                          ║
             ╟───────────────────────────────────────────────────────╢
@@ -76,10 +72,10 @@ class KlipperRemoveMenu(BaseMenu):
         print(menu, end="")
 
     def toggle_all(self, **kwargs) -> None:
-        self.remove_klipper_service = True
-        self.remove_klipper_dir = True
-        self.remove_klipper_env = True
-        self.delete_klipper_logs = True
+        self.selection_state = not self.selection_state
+        self.remove_klipper_service = self.selection_state
+        self.remove_klipper_dir = self.selection_state
+        self.remove_klipper_env = self.selection_state
 
     def toggle_remove_klipper_service(self, **kwargs) -> None:
         self.remove_klipper_service = not self.remove_klipper_service
@@ -90,15 +86,11 @@ class KlipperRemoveMenu(BaseMenu):
     def toggle_remove_klipper_env(self, **kwargs) -> None:
         self.remove_klipper_env = not self.remove_klipper_env
 
-    def toggle_delete_klipper_logs(self, **kwargs) -> None:
-        self.delete_klipper_logs = not self.delete_klipper_logs
-
     def run_removal_process(self, **kwargs) -> None:
         if (
             not self.remove_klipper_service
             and not self.remove_klipper_dir
             and not self.remove_klipper_env
-            and not self.delete_klipper_logs
         ):
             error = f"{COLOR_RED}Nothing selected! Select options to remove first.{RESET_FORMAT}"
             print(error)
@@ -108,10 +100,19 @@ class KlipperRemoveMenu(BaseMenu):
             self.remove_klipper_service,
             self.remove_klipper_dir,
             self.remove_klipper_env,
-            self.delete_klipper_logs,
         )
 
         self.remove_klipper_service = False
         self.remove_klipper_dir = False
         self.remove_klipper_env = False
-        self.delete_klipper_logs = False
+
+        self._go_back()
+
+    def _get_selection_state_str(self) -> str:
+        return (
+            "Select everything" if not self.selection_state else "Deselect everything"
+        )
+
+    def _go_back(self, **kwargs) -> None:
+        if self.previous_menu is not None:
+            self.previous_menu().run()

kiauh/components/klipper_firmware/firmware_utils.py

@@ -18,20 +18,22 @@ from components.klipper_firmware.flash_options import (
     FlashOptions,
 )
 from core.instance_manager.instance_manager import InstanceManager
-from utils.logger import Logger
+from core.logger import Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import log_process
 
 
 def find_firmware_file() -> bool:
     target = KLIPPER_DIR.joinpath("out")
-    target_exists = target.exists()
+    target_exists: bool = target.exists()
 
     f1 = "klipper.elf.hex"
     f2 = "klipper.elf"
     f3 = "klipper.bin"
-    fw_file_exists = (
+    f4 = "klipper.uf2"
+    fw_file_exists: bool = (
         target.joinpath(f1).exists() and target.joinpath(f2).exists()
-    ) or target.joinpath(f3).exists()
+    ) or target.joinpath(f3).exists() or target.joinpath(f4).exists()
 
     return target_exists and fw_file_exists
 
@@ -75,10 +77,11 @@ def get_sd_flash_board_list() -> List[str]:
 
     try:
         cmd = f"{SD_FLASH_SCRIPT} -l"
-        blist = check_output(cmd, shell=True, text=True)
-        return blist.splitlines()[1:]
+        blist: List[str] = check_output(cmd, shell=True, text=True).splitlines()[1:]
+        return blist
     except CalledProcessError as e:
         Logger.print_error(f"An unexpected error occured:\n{e}")
+        return []
 
 
 def start_flash_process(flash_options: FlashOptions) -> None:
@@ -116,13 +119,13 @@ def start_flash_process(flash_options: FlashOptions) -> None:
         else:
             raise Exception("Invalid value for flash_method!")
 
-        instance_manager = InstanceManager(Klipper)
-        instance_manager.stop_all_instance()
+        instances = get_instances(Klipper)
+        InstanceManager.stop_all(instances)
 
         process = Popen(cmd, cwd=KLIPPER_DIR, stdout=PIPE, stderr=STDOUT, text=True)
         log_process(process)
 
-        instance_manager.start_all_instance()
+        InstanceManager.start_all(instances)
 
         rc = process.returncode
         if rc != 0:

kiauh/components/klipper_firmware/flash_options.py

@@ -6,10 +6,11 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 from dataclasses import field
 from enum import Enum
-from typing import List, Union
+from typing import List
 
 
 class FlashMethod(Enum):
@@ -30,9 +31,9 @@ class ConnectionType(Enum):
 
 class FlashOptions:
     _instance = None
-    _flash_method: Union[FlashMethod, None] = None
-    _flash_command: Union[FlashCommand, None] = None
-    _connection_type: Union[ConnectionType, None] = None
+    _flash_method: FlashMethod | None = None
+    _flash_command: FlashCommand | None = None
+    _connection_type: ConnectionType | None = None
     _mcu_list: List[str] = field(default_factory=list)
     _selected_mcu: str = ""
     _selected_board: str = ""
@@ -44,31 +45,31 @@ class FlashOptions:
         return cls._instance
 
     @classmethod
-    def destroy(cls):
+    def destroy(cls) -> None:
         cls._instance = None
 
     @property
-    def flash_method(self) -> Union[FlashMethod, None]:
+    def flash_method(self) -> FlashMethod | None:
         return self._flash_method
 
     @flash_method.setter
-    def flash_method(self, value: Union[FlashMethod, None]):
+    def flash_method(self, value: FlashMethod | None):
         self._flash_method = value
 
     @property
-    def flash_command(self) -> Union[FlashCommand, None]:
+    def flash_command(self) -> FlashCommand | None:
         return self._flash_command
 
     @flash_command.setter
-    def flash_command(self, value: Union[FlashCommand, None]):
+    def flash_command(self, value: FlashCommand | None):
         self._flash_command = value
 
     @property
-    def connection_type(self) -> Union[ConnectionType, None]:
+    def connection_type(self) -> ConnectionType | None:
         return self._connection_type
 
     @connection_type.setter
-    def connection_type(self, value: Union[ConnectionType, None]):
+    def connection_type(self, value: ConnectionType | None):
         self._connection_type = value
 
     @property

kiauh/components/klipper_firmware/menus/klipper_build_menu.py

@@ -6,9 +6,10 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
-from typing import Optional, Type
+from typing import List, Set, Type
 
 from components.klipper import KLIPPER_DIR
 from components.klipper_firmware.firmware_utils import (
@@ -16,10 +17,10 @@ from components.klipper_firmware.firmware_utils import (
     run_make_clean,
     run_make_menuconfig,
 )
+from core.constants import COLOR_CYAN, COLOR_GREEN, COLOR_RED, RESET_FORMAT
+from core.logger import Logger
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_CYAN, COLOR_GREEN, COLOR_RED, RESET_FORMAT
-from utils.logger import Logger
 from utils.sys_utils import (
     check_package_install,
     install_system_packages,
@@ -30,26 +31,26 @@ from utils.sys_utils import (
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class KlipperBuildFirmwareMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
-        self.previous_menu = previous_menu
-        self.deps = ["build-essential", "dpkg-dev", "make"]
-        self.missing_deps = check_package_install(self.deps)
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+        self.deps: Set[str] = {"build-essential", "dpkg-dev", "make"}
+        self.missing_deps: List[str] = check_package_install(self.deps)
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.advanced_menu import AdvancedMenu
 
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = (
             previous_menu if previous_menu is not None else AdvancedMenu
         )
 
     def set_options(self) -> None:
         if len(self.missing_deps) == 0:
             self.input_label_txt = "Press ENTER to continue"
-            self.default_option = Option(method=self.start_build_process, menu=False)
+            self.default_option = Option(method=self.start_build_process)
         else:
             self.input_label_txt = "Press ENTER to install dependencies"
-            self.default_option = Option(method=self.install_missing_deps, menu=False)
+            self.default_option = Option(method=self.install_missing_deps)
 
     def print_menu(self) -> None:
         header = " [ Build Firmware Menu ] "
@@ -80,6 +81,7 @@ class KlipperBuildFirmwareMenu(BaseMenu):
             line = f"{COLOR_RED}Dependencies are missing!{RESET_FORMAT}"
 
         menu += f"║ {line:<62} ║\n"
+        menu += "╟───────────────────────────────────────────────────────╢\n"
 
         print(menu, end="")
 
@@ -109,4 +111,5 @@ class KlipperBuildFirmwareMenu(BaseMenu):
             Logger.print_error("Building Klipper Firmware failed!")
 
         finally:
-            self.previous_menu().run()
+            if self.previous_menu is not None:
+                self.previous_menu().run()

kiauh/components/klipper_firmware/menus/klipper_flash_error_menu.py

@@ -6,31 +6,33 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
+
 import textwrap
-from typing import Optional, Type
+from typing import Type
 
 from components.klipper_firmware.flash_options import FlashMethod, FlashOptions
+from core.constants import COLOR_RED, RESET_FORMAT
 from core.menus import FooterType, Option
 from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_RED, RESET_FORMAT
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class KlipperNoFirmwareErrorMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
 
         self.flash_options = FlashOptions()
         self.footer_type = FooterType.BLANK
         self.input_label_txt = "Press ENTER to go back to [Advanced Menu]"
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         self.previous_menu = previous_menu
 
     def set_options(self) -> None:
-        self.default_option = Option(self.go_back, False)
+        self.default_option = Option(method=self.go_back)
 
     def print_menu(self) -> None:
         header = "!!! NO FIRMWARE FILE FOUND !!!"
@@ -67,17 +69,17 @@ class KlipperNoFirmwareErrorMenu(BaseMenu):
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class KlipperNoBoardTypesErrorMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
         self.footer_type = FooterType.BLANK
         self.input_label_txt = "Press ENTER to go back to [Main Menu]"
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         self.previous_menu = previous_menu
 
     def set_options(self) -> None:
-        self.default_option = Option(self.go_back, False)
+        self.default_option = Option(method=self.go_back)
 
     def print_menu(self) -> None:
         header = "!!! ERROR GETTING BOARD LIST !!!"

kiauh/components/klipper_firmware/menus/klipper_flash_help_menu.py

@@ -6,25 +6,27 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
-import textwrap
-from typing import Optional, Type
+from __future__ import annotations
 
+import textwrap
+from typing import Type
+
+from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
 from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
 
 
 # noinspection DuplicatedCode
 class KlipperFlashMethodHelpMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from components.klipper_firmware.menus.klipper_flash_menu import (
             KlipperFlashMethodMenu,
         )
 
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = (
             previous_menu if previous_menu is not None else KlipperFlashMethodMenu
         )
 
@@ -73,16 +75,16 @@ class KlipperFlashMethodHelpMenu(BaseMenu):
 
 # noinspection DuplicatedCode
 class KlipperFlashCommandHelpMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from components.klipper_firmware.menus.klipper_flash_menu import (
             KlipperFlashCommandMenu,
         )
 
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = (
             previous_menu if previous_menu is not None else KlipperFlashCommandMenu
         )
 
@@ -117,16 +119,16 @@ class KlipperFlashCommandHelpMenu(BaseMenu):
 
 # noinspection DuplicatedCode
 class KlipperMcuConnectionHelpMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from components.klipper_firmware.menus.klipper_flash_menu import (
             KlipperSelectMcuConnectionMenu,
         )
 
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = (
             previous_menu
             if previous_menu is not None
             else KlipperSelectMcuConnectionMenu

kiauh/components/klipper_firmware/menus/klipper_flash_menu.py

@@ -6,10 +6,11 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
 import time
-from typing import Optional, Type
+from typing import Type
 
 from components.klipper_firmware.firmware_utils import (
     find_firmware_file,
@@ -34,34 +35,34 @@ from components.klipper_firmware.menus.klipper_flash_help_menu import (
     KlipperFlashMethodHelpMenu,
     KlipperMcuConnectionHelpMenu,
 )
+from core.constants import COLOR_CYAN, COLOR_RED, COLOR_YELLOW, RESET_FORMAT
+from core.logger import DialogType, Logger
 from core.menus import FooterType, Option
 from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_CYAN, COLOR_RED, COLOR_YELLOW, RESET_FORMAT
 from utils.input_utils import get_number_input
-from utils.logger import DialogType, Logger
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class KlipperFlashMethodMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
         self.help_menu = KlipperFlashMethodHelpMenu
         self.input_label_txt = "Select flash method"
         self.footer_type = FooterType.BACK_HELP
         self.flash_options = FlashOptions()
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.advanced_menu import AdvancedMenu
 
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = (
             previous_menu if previous_menu is not None else AdvancedMenu
         )
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(self.select_regular, menu=False),
-            "2": Option(self.select_sdcard, menu=False),
+            "1": Option(self.select_regular),
+            "2": Option(self.select_sdcard),
         }
 
     def print_menu(self) -> None:
@@ -108,24 +109,24 @@ class KlipperFlashMethodMenu(BaseMenu):
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class KlipperFlashCommandMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
         self.help_menu = KlipperFlashCommandHelpMenu
         self.input_label_txt = "Select flash command"
         self.footer_type = FooterType.BACK_HELP
         self.flash_options = FlashOptions()
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        self.previous_menu: Type[BaseMenu] = (
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        self.previous_menu = (
             previous_menu if previous_menu is not None else KlipperFlashMethodMenu
         )
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(self.select_flash, menu=False),
-            "2": Option(self.select_serialflash, menu=False),
+            "1": Option(self.select_flash),
+            "2": Option(self.select_serialflash),
         }
-        self.default_option = Option(self.select_flash, menu=False)
+        self.default_option = Option(self.select_flash)
 
     def print_menu(self) -> None:
         menu = textwrap.dedent(
@@ -156,26 +157,26 @@ class KlipperFlashCommandMenu(BaseMenu):
 # noinspection PyMethodMayBeStatic
 class KlipperSelectMcuConnectionMenu(BaseMenu):
     def __init__(
-        self, previous_menu: Optional[Type[BaseMenu]] = None, standalone: bool = False
+        self, previous_menu: Type[BaseMenu] | None = None, standalone: bool = False
     ):
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
         self.__standalone = standalone
         self.help_menu = KlipperMcuConnectionHelpMenu
         self.input_label_txt = "Select connection type"
         self.footer_type = FooterType.BACK_HELP
         self.flash_options = FlashOptions()
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        self.previous_menu: Type[BaseMenu] = (
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        self.previous_menu = (
             previous_menu if previous_menu is not None else KlipperFlashCommandMenu
         )
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(method=self.select_usb, menu=False),
-            "2": Option(method=self.select_dfu, menu=False),
-            "3": Option(method=self.select_usb_dfu, menu=False),
+            "1": Option(method=self.select_usb),
+            "2": Option(method=self.select_dfu),
+            "3": Option(method=self.select_usb_dfu),
         }
 
     def print_menu(self) -> None:
@@ -243,15 +244,15 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class KlipperSelectMcuIdMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
         self.flash_options = FlashOptions()
         self.mcu_list = self.flash_options.mcu_list
         self.input_label_txt = "Select MCU to flash"
-        self.footer_type = FooterType.BACK_HELP
+        self.footer_type = FooterType.BACK
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        self.previous_menu: Type[BaseMenu] = (
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        self.previous_menu = (
             previous_menu
             if previous_menu is not None
             else KlipperSelectMcuConnectionMenu
@@ -259,13 +260,12 @@ class KlipperSelectMcuIdMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            f"{i}": Option(self.flash_mcu, False, f"{i}")
-            for i in range(len(self.mcu_list))
+            f"{i}": Option(self.flash_mcu, f"{i}") for i in range(len(self.mcu_list))
         }
 
     def print_menu(self) -> None:
         header = "!!! ATTENTION !!!"
-        header2 = f"[{COLOR_CYAN}List of available MCUs{RESET_FORMAT}]"
+        header2 = f"[{COLOR_CYAN}List of detected MCUs{RESET_FORMAT}]"
         color = COLOR_RED
         count = 62 - len(color) - len(RESET_FORMAT)
         menu = textwrap.dedent(
@@ -277,44 +277,58 @@ class KlipperSelectMcuIdMenu(BaseMenu):
             ║ ONLY flash a firmware created for the respective MCU! ║
             ║                                                       ║
             ╟{header2:─^64}╢
+            ║                                                       ║
             """
         )[1:]
 
         for i, mcu in enumerate(self.mcu_list):
             mcu = mcu.split("/")[-1]
-            menu += f"   ● MCU #{i}: {COLOR_CYAN}{mcu}{RESET_FORMAT}\n"
-        menu += "╟───────────────────────────┬───────────────────────────╢"
+            menu += f"║ {i}) {COLOR_CYAN}{mcu:<51}{RESET_FORMAT}║\n"
 
-        print(menu, end="\n")
+        menu += textwrap.dedent(
+            """
+            ║                                                       ║
+            ╟───────────────────────────────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
 
     def flash_mcu(self, **kwargs):
-        index = int(kwargs.get("opt_index"))
-        selected_mcu = self.mcu_list[index]
-        self.flash_options.selected_mcu = selected_mcu
+        try:
+            index: int | None = kwargs.get("opt_index", None)
+            if index is None:
+                raise Exception("opt_index is None")
 
-        if self.flash_options.flash_method == FlashMethod.SD_CARD:
-            KlipperSelectSDFlashBoardMenu(previous_menu=self.__class__).run()
-        elif self.flash_options.flash_method == FlashMethod.REGULAR:
-            KlipperFlashOverviewMenu(previous_menu=self.__class__).run()
+            index = int(index)
+            selected_mcu = self.mcu_list[index]
+            self.flash_options.selected_mcu = selected_mcu
+
+            if self.flash_options.flash_method == FlashMethod.SD_CARD:
+                KlipperSelectSDFlashBoardMenu(previous_menu=self.__class__).run()
+            elif self.flash_options.flash_method == FlashMethod.REGULAR:
+                KlipperFlashOverviewMenu(previous_menu=self.__class__).run()
+        except Exception as e:
+            Logger.print_error(e)
+            Logger.print_error("Flashing failed!")
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class KlipperSelectSDFlashBoardMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
         self.flash_options = FlashOptions()
         self.available_boards = get_sd_flash_board_list()
         self.input_label_txt = "Select board type"
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        self.previous_menu: Type[BaseMenu] = (
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        self.previous_menu = (
             previous_menu if previous_menu is not None else KlipperSelectMcuIdMenu
         )
 
     def set_options(self) -> None:
         self.options = {
-            f"{i}": Option(self.board_select, False, f"{i}")
+            f"{i}": Option(self.board_select, f"{i}")
             for i in range(len(self.available_boards))
         }
 
@@ -335,14 +349,22 @@ class KlipperSelectSDFlashBoardMenu(BaseMenu):
 
             for i, board in enumerate(self.available_boards):
                 line = f" {i}) {board}"
-                menu += f"|{line:<55}|\n"
-
+                menu += f"║{line:<55}║\n"
+            menu += "╟───────────────────────────────────────────────────────╢"
             print(menu, end="")
 
     def board_select(self, **kwargs):
-        board = int(kwargs.get("opt_index"))
-        self.flash_options.selected_board = self.available_boards[board]
-        self.baudrate_select()
+        try:
+            index: int | None = kwargs.get("opt_index", None)
+            if index is None:
+                raise Exception("opt_index is None")
+
+            index = int(index)
+            self.flash_options.selected_board = self.available_boards[index]
+            self.baudrate_select()
+        except Exception as e:
+            Logger.print_error(e)
+            Logger.print_error("Board selection failed!")
 
     def baudrate_select(self, **kwargs):
         Logger.print_dialog(
@@ -353,7 +375,6 @@ class KlipperSelectSDFlashBoardMenu(BaseMenu):
                 "\n\n",
                 "If you are unsure, stick to the default 250000!",
             ],
-            end="",
         )
         self.flash_options.selected_baudrate = get_number_input(
             question="Please set the baud rate",
@@ -367,21 +388,21 @@ class KlipperSelectSDFlashBoardMenu(BaseMenu):
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class KlipperFlashOverviewMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
         self.flash_options = FlashOptions()
         self.input_label_txt = "Perform action (default=Y)"
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        self.previous_menu: Type[BaseMenu] = previous_menu
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
 
     def set_options(self) -> None:
         self.options = {
-            "Y": Option(self.execute_flash, menu=False),
-            "N": Option(self.abort_process, menu=False),
+            "y": Option(self.execute_flash),
+            "n": Option(self.abort_process),
         }
 
-        self.default_option = Option(self.execute_flash, menu=False)
+        self.default_option = Option(self.execute_flash)
 
     def print_menu(self) -> None:
         header = "!!! ATTENTION !!!"
@@ -391,7 +412,7 @@ class KlipperFlashOverviewMenu(BaseMenu):
         method = self.flash_options.flash_method.value
         command = self.flash_options.flash_command.value
         conn_type = self.flash_options.connection_type.value
-        mcu = self.flash_options.selected_mcu
+        mcu = self.flash_options.selected_mcu.split("/")[-1]
         board = self.flash_options.selected_board
         baudrate = self.flash_options.selected_baudrate
         subheader = f"[{COLOR_CYAN}Overview{RESET_FORMAT}]"
@@ -405,26 +426,37 @@ class KlipperFlashOverviewMenu(BaseMenu):
             ║ sure everything is correct, start the process. If any ║
             ║ parameter needs to be changed, you can go back (B)    ║
             ║ step by step or abort and start from the beginning.   ║
-            ║{subheader:-^64}║
+            ║{subheader:─^64}║
+            ║                                                       ║
             """
         )[1:]
 
-        menu += f"   ● MCU: {COLOR_CYAN}{mcu}{RESET_FORMAT}\n"
-        menu += f"   ● Connection: {COLOR_CYAN}{conn_type}{RESET_FORMAT}\n"
-        menu += f"   ● Flash method: {COLOR_CYAN}{method}{RESET_FORMAT}\n"
-        menu += f"   ● Flash command: {COLOR_CYAN}{command}{RESET_FORMAT}\n"
+        menu += textwrap.dedent(
+            f"""
+            ║ MCU: {COLOR_CYAN}{mcu:<48}{RESET_FORMAT} ║
+            ║ Connection: {COLOR_CYAN}{conn_type:<41}{RESET_FORMAT} ║
+            ║ Flash method: {COLOR_CYAN}{method:<39}{RESET_FORMAT} ║
+            ║ Flash command: {COLOR_CYAN}{command:<38}{RESET_FORMAT} ║
+            """
+        )[1:]
 
         if self.flash_options.flash_method is FlashMethod.SD_CARD:
-            menu += f"   ● Board type: {COLOR_CYAN}{board}{RESET_FORMAT}\n"
-            menu += f"   ● Baudrate: {COLOR_CYAN}{baudrate}{RESET_FORMAT}\n"
+            menu += textwrap.dedent(
+                f"""
+                ║ Board type: {COLOR_CYAN}{board:<41}{RESET_FORMAT} ║
+                ║ Baudrate: {COLOR_CYAN}{baudrate:<43}{RESET_FORMAT} ║
+                """
+            )[1:]
 
         menu += textwrap.dedent(
             """
+            ║                                                       ║
             ╟───────────────────────────────────────────────────────╢
             ║  Y) Start flash process                               ║
             ║  N) Abort - Return to Advanced Menu                   ║
+            ╟───────────────────────────────────────────────────────╢
             """
-        )
+        )[1:]
         print(menu, end="")
 
     def execute_flash(self, **kwargs):

kiauh/components/klipperscreen/__init__.py

@@ -9,8 +9,26 @@
 from pathlib import Path
 
 from core.backup_manager import BACKUP_ROOT_DIR
+from core.constants import SYSTEMD
 
+# repo
 KLIPPERSCREEN_REPO = "https://github.com/KlipperScreen/KlipperScreen.git"
+
+# names
+KLIPPERSCREEN_SERVICE_NAME = "KlipperScreen.service"
+KLIPPERSCREEN_UPDATER_SECTION_NAME = "update_manager KlipperScreen"
+KLIPPERSCREEN_LOG_NAME = "KlipperScreen.log"
+
+# directories
 KLIPPERSCREEN_DIR = Path.home().joinpath("KlipperScreen")
-KLIPPERSCREEN_ENV = Path.home().joinpath(".KlipperScreen-env")
+KLIPPERSCREEN_ENV_DIR = Path.home().joinpath(".KlipperScreen-env")
 KLIPPERSCREEN_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("klipperscreen-backups")
+
+# files
+KLIPPERSCREEN_REQ_FILE = KLIPPERSCREEN_DIR.joinpath(
+    "scripts/KlipperScreen-requirements.txt"
+)
+KLIPPERSCREEN_INSTALL_SCRIPT = KLIPPERSCREEN_DIR.joinpath(
+    "scripts/KlipperScreen-install.sh"
+)
+KLIPPERSCREEN_SERVICE_FILE = SYSTEMD.joinpath(KLIPPERSCREEN_SERVICE_NAME)

kiauh/components/klipperscreen/klipperscreen.py

@@ -15,33 +15,40 @@ from components.klipper.klipper import Klipper
 from components.klipperscreen import (
     KLIPPERSCREEN_BACKUP_DIR,
     KLIPPERSCREEN_DIR,
-    KLIPPERSCREEN_ENV,
+    KLIPPERSCREEN_ENV_DIR,
+    KLIPPERSCREEN_INSTALL_SCRIPT,
+    KLIPPERSCREEN_LOG_NAME,
     KLIPPERSCREEN_REPO,
+    KLIPPERSCREEN_REQ_FILE,
+    KLIPPERSCREEN_SERVICE_FILE,
+    KLIPPERSCREEN_SERVICE_NAME,
+    KLIPPERSCREEN_UPDATER_SECTION_NAME,
 )
 from components.moonraker.moonraker import Moonraker
 from core.backup_manager.backup_manager import BackupManager
+from core.constants import SYSTEMD
 from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
 from core.settings.kiauh_settings import KiauhSettings
+from core.types import ComponentStatus
 from utils.common import (
     check_install_dependencies,
     get_install_status,
 )
 from utils.config_utils import add_config_section, remove_config_section
-from utils.constants import SYSTEMD
 from utils.fs_utils import remove_with_sudo
 from utils.git_utils import (
     git_clone_wrapper,
     git_pull_wrapper,
 )
 from utils.input_utils import get_confirm
-from utils.logger import DialogType, Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
     check_python_version,
-    cmd_sysctl_manage,
     cmd_sysctl_service,
     install_python_requirements,
+    remove_system_service,
 )
-from utils.types import ComponentStatus
 
 
 def install_klipperscreen() -> None:
@@ -50,8 +57,7 @@ def install_klipperscreen() -> None:
     if not check_python_version(3, 7):
         return
 
-    mr_im = InstanceManager(Moonraker)
-    mr_instances = mr_im.instances
+    mr_instances = get_instances(Moonraker)
     if not mr_instances:
         Logger.print_dialog(
             DialogType.WARNING,
@@ -62,7 +68,6 @@ def install_klipperscreen() -> None:
                 "KlipperScreens update manager configuration for Moonraker "
                 "will not be added to any moonraker.conf.",
             ],
-            end="",
         )
         if not get_confirm(
             "Continue KlipperScreen installation?",
@@ -71,17 +76,15 @@ def install_klipperscreen() -> None:
         ):
             return
 
-    package_list = ["git", "wget", "curl", "unzip", "dfu-util"]
-    check_install_dependencies(package_list)
+    check_install_dependencies()
 
     git_clone_wrapper(KLIPPERSCREEN_REPO, KLIPPERSCREEN_DIR)
 
     try:
-        script = f"{KLIPPERSCREEN_DIR}/scripts/KlipperScreen-install.sh"
-        run(script, shell=True, check=True)
+        run(KLIPPERSCREEN_INSTALL_SCRIPT.as_posix(), shell=True, check=True)
         if mr_instances:
             patch_klipperscreen_update_manager(mr_instances)
-            mr_im.restart_all_instance()
+            InstanceManager.restart_all(mr_instances)
         else:
             Logger.print_info(
                 "Moonraker is not installed! Cannot add "
@@ -94,34 +97,30 @@ def install_klipperscreen() -> None:
 
 
 def patch_klipperscreen_update_manager(instances: List[Moonraker]) -> None:
-    env_py = f"{KLIPPERSCREEN_ENV}/bin/python"
     add_config_section(
-        section="update_manager KlipperScreen",
+        section=KLIPPERSCREEN_UPDATER_SECTION_NAME,
         instances=instances,
         options=[
             ("type", "git_repo"),
-            ("path", str(KLIPPERSCREEN_DIR)),
-            ("orgin", KLIPPERSCREEN_REPO),
-            ("env", env_py),
-            ("requirements", "scripts/KlipperScreen-requirements.txt"),
-            ("install_script", "scripts/KlipperScreen-install.sh"),
+            ("path", KLIPPERSCREEN_DIR.as_posix()),
+            ("origin", KLIPPERSCREEN_REPO),
+            ("managed_services", "KlipperScreen"),
+            ("env", f"{KLIPPERSCREEN_ENV_DIR}/bin/python"),
+            ("requirements", KLIPPERSCREEN_REQ_FILE.as_posix()),
+            ("install_script", KLIPPERSCREEN_INSTALL_SCRIPT.as_posix()),
         ],
     )
 
 
 def update_klipperscreen() -> None:
+    if not KLIPPERSCREEN_DIR.exists():
+        Logger.print_info("KlipperScreen does not seem to be installed! Skipping ...")
+        return
+
     try:
-        cmd_sysctl_service("KlipperScreen", "stop")
-
-        if not KLIPPERSCREEN_DIR.exists():
-            Logger.print_info(
-                "KlipperScreen does not seem to be installed! Skipping ..."
-            )
-            return
-
         Logger.print_status("Updating KlipperScreen ...")
 
-        cmd_sysctl_service("KlipperScreen", "stop")
+        cmd_sysctl_service(KLIPPERSCREEN_SERVICE_NAME, "stop")
 
         settings = KiauhSettings()
         if settings.kiauh.backup_before_update:
@@ -129,12 +128,9 @@ def update_klipperscreen() -> None:
 
         git_pull_wrapper(KLIPPERSCREEN_REPO, KLIPPERSCREEN_DIR)
 
-        requirements = KLIPPERSCREEN_DIR.joinpath(
-            "/scripts/KlipperScreen-requirements.txt"
-        )
-        install_python_requirements(KLIPPERSCREEN_ENV, requirements)
+        install_python_requirements(KLIPPERSCREEN_ENV_DIR, KLIPPERSCREEN_REQ_FILE)
 
-        cmd_sysctl_service("KlipperScreen", "start")
+        cmd_sysctl_service(KLIPPERSCREEN_SERVICE_NAME, "start")
 
         Logger.print_ok("KlipperScreen updated successfully.", end="\n\n")
     except CalledProcessError as e:
@@ -145,8 +141,8 @@ def update_klipperscreen() -> None:
 def get_klipperscreen_status() -> ComponentStatus:
     return get_install_status(
         KLIPPERSCREEN_DIR,
-        KLIPPERSCREEN_ENV,
-        files=[SYSTEMD.joinpath("KlipperScreen.service")],
+        KLIPPERSCREEN_ENV_DIR,
+        files=[SYSTEMD.joinpath(KLIPPERSCREEN_SERVICE_NAME)],
     )
 
 
@@ -160,40 +156,31 @@ def remove_klipperscreen() -> None:
         else:
             Logger.print_warn("KlipperScreen directory not found!")
 
-        if KLIPPERSCREEN_ENV.exists():
+        if KLIPPERSCREEN_ENV_DIR.exists():
             Logger.print_status("Removing KlipperScreen environment ...")
-            shutil.rmtree(KLIPPERSCREEN_ENV)
+            shutil.rmtree(KLIPPERSCREEN_ENV_DIR)
             Logger.print_ok("KlipperScreen environment successfully removed!")
         else:
             Logger.print_warn("KlipperScreen environment not found!")
 
-        service = SYSTEMD.joinpath("KlipperScreen.service")
-        if service.exists():
-            Logger.print_status("Removing KlipperScreen service ...")
-            cmd_sysctl_service(service, "stop")
-            cmd_sysctl_service(service, "disable")
-            remove_with_sudo(service)
-            cmd_sysctl_manage("daemon-reload")
-            cmd_sysctl_manage("reset-failed")
-            Logger.print_ok("KlipperScreen service successfully removed!")
+        if KLIPPERSCREEN_SERVICE_FILE.exists():
+            remove_system_service(KLIPPERSCREEN_SERVICE_NAME)
 
-        logfile = Path("/tmp/KlipperScreen.log")
+        logfile = Path(f"/tmp/{KLIPPERSCREEN_LOG_NAME}")
         if logfile.exists():
             Logger.print_status("Removing KlipperScreen log file ...")
             remove_with_sudo(logfile)
             Logger.print_ok("KlipperScreen log file successfully removed!")
 
-        kl_im = InstanceManager(Klipper)
-        kl_instances: List[Klipper] = kl_im.instances
+        kl_instances: List[Klipper] = get_instances(Klipper)
         for instance in kl_instances:
-            logfile = instance.log_dir.joinpath("KlipperScreen.log")
+            logfile = instance.base.log_dir.joinpath(KLIPPERSCREEN_LOG_NAME)
             if logfile.exists():
                 Logger.print_status(f"Removing {logfile} ...")
                 Path(logfile).unlink()
                 Logger.print_ok(f"{logfile} successfully removed!")
 
-        mr_im = InstanceManager(Moonraker)
-        mr_instances: List[Moonraker] = mr_im.instances
+        mr_instances: List[Moonraker] = get_instances(Moonraker)
         if mr_instances:
             Logger.print_status("Removing KlipperScreen from update manager ...")
             remove_config_section("update_manager KlipperScreen", mr_instances)
@@ -208,12 +195,12 @@ def remove_klipperscreen() -> None:
 def backup_klipperscreen_dir() -> None:
     bm = BackupManager()
     bm.backup_directory(
-        "KlipperScreen",
+        KLIPPERSCREEN_DIR.name,
         source=KLIPPERSCREEN_DIR,
         target=KLIPPERSCREEN_BACKUP_DIR,
     )
     bm.backup_directory(
-        "KlipperScreen-env",
-        source=KLIPPERSCREEN_ENV,
+        KLIPPERSCREEN_ENV_DIR.name,
+        source=KLIPPERSCREEN_ENV_DIR,
         target=KLIPPERSCREEN_BACKUP_DIR,
     )

kiauh/components/log_uploads/log_upload_utils.py

@@ -13,13 +13,14 @@ from typing import List
 
 from components.klipper.klipper import Klipper
 from components.log_uploads import LogFile
-from core.instance_manager.instance_manager import InstanceManager
-from utils.logger import Logger
+from core.logger import Logger
+from utils.instance_utils import get_instances
 
 
 def get_logfile_list() -> List[LogFile]:
-    cm = InstanceManager(Klipper)
-    log_dirs: List[Path] = [instance.log_dir for instance in cm.instances]
+    log_dirs: List[Path] = [
+        instance.base.log_dir for instance in get_instances(Klipper)
+    ]
 
     logfiles: List[LogFile] = []
     for _dir in log_dirs:

kiauh/components/log_uploads/menus/log_upload_menu.py

@@ -6,37 +6,37 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
-from typing import Optional, Type
+from typing import Type
 
 from components.log_uploads.log_upload_utils import get_logfile_list, upload_logfile
+from core.constants import COLOR_YELLOW, RESET_FORMAT
+from core.logger import Logger
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_YELLOW, RESET_FORMAT
 
 
 # noinspection PyMethodMayBeStatic
 class LogUploadMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
         self.logfile_list = get_logfile_list()
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
 
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else MainMenu
-        )
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
 
     def set_options(self) -> None:
         self.options = {
-            f"{index}": Option(self.upload, False, opt_index=f"{index}")
+            f"{index}": Option(self.upload, opt_index=f"{index}")
             for index in range(len(self.logfile_list))
         }
 
-    def print_menu(self):
+    def print_menu(self) -> None:
         header = " [ Log Upload ] "
         color = COLOR_YELLOW
         count = 62 - len(color) - len(RESET_FORMAT)
@@ -58,5 +58,13 @@ class LogUploadMenu(BaseMenu):
         print(menu, end="")
 
     def upload(self, **kwargs):
-        index = int(kwargs.get("opt_index"))
-        upload_logfile(self.logfile_list[index])
+        try:
+            index: int | None = kwargs.get("opt_index", None)
+            if index is None:
+                raise Exception("opt_index is None")
+
+            index = int(index)
+            upload_logfile(self.logfile_list[index])
+        except Exception as e:
+            Logger.print_error(e)
+            Logger.print_error("Log upload failed!")

kiauh/components/mobileraker/mobileraker.py

@@ -1,211 +0,0 @@
-# ======================================================================= #
-#  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 shutil
-from pathlib import Path
-from subprocess import CalledProcessError, run
-from typing import List
-
-from components.klipper.klipper import Klipper
-from components.mobileraker import (
-    MOBILERAKER_BACKUP_DIR,
-    MOBILERAKER_DIR,
-    MOBILERAKER_ENV,
-    MOBILERAKER_REPO,
-)
-from components.moonraker.moonraker import Moonraker
-from core.backup_manager.backup_manager import BackupManager
-from core.instance_manager.instance_manager import InstanceManager
-from core.settings.kiauh_settings import KiauhSettings
-from utils.common import check_install_dependencies, get_install_status
-from utils.config_utils import add_config_section, remove_config_section
-from utils.constants import SYSTEMD
-from utils.fs_utils import remove_with_sudo
-from utils.git_utils import (
-    git_clone_wrapper,
-    git_pull_wrapper,
-)
-from utils.input_utils import get_confirm
-from utils.logger import DialogType, Logger
-from utils.sys_utils import (
-    check_python_version,
-    cmd_sysctl_manage,
-    cmd_sysctl_service,
-    install_python_requirements,
-)
-from utils.types import ComponentStatus
-
-
-def install_mobileraker() -> None:
-    Logger.print_status("Installing Mobileraker's companion ...")
-
-    if not check_python_version(3, 7):
-        return
-
-    mr_im = InstanceManager(Moonraker)
-    mr_instances = mr_im.instances
-    if not mr_instances:
-        Logger.print_dialog(
-            DialogType.WARNING,
-            [
-                "Moonraker not found! Mobileraker's companion will not properly work "
-                "without a working Moonraker installation.",
-                "Mobileraker's companion's update manager configuration for Moonraker "
-                "will not be added to any moonraker.conf.",
-            ],
-            end="",
-        )
-        if not get_confirm(
-            "Continue Mobileraker's companion installation?",
-            default_choice=False,
-            allow_go_back=True,
-        ):
-            return
-
-    package_list = ["git", "wget", "curl", "unzip", "dfu-util"]
-    check_install_dependencies(package_list)
-
-    git_clone_wrapper(MOBILERAKER_REPO, MOBILERAKER_DIR)
-
-    try:
-        script = f"{MOBILERAKER_DIR}/scripts/install.sh"
-        run(script, shell=True, check=True)
-        if mr_instances:
-            patch_mobileraker_update_manager(mr_instances)
-            mr_im.restart_all_instance()
-        else:
-            Logger.print_info(
-                "Moonraker is not installed! Cannot add Mobileraker's "
-                "companion to update manager!"
-            )
-        Logger.print_ok("Mobileraker's companion successfully installed!")
-    except CalledProcessError as e:
-        Logger.print_error(f"Error installing Mobileraker's companion:\n{e}")
-        return
-
-
-def patch_mobileraker_update_manager(instances: List[Moonraker]) -> None:
-    env_py = f"{MOBILERAKER_ENV}/bin/python"
-    add_config_section(
-        section="update_manager mobileraker",
-        instances=instances,
-        options=[
-            ("type", "git_repo"),
-            ("path", "mobileraker_companion"),
-            ("orgin", MOBILERAKER_REPO),
-            ("primary_branch", "main"),
-            ("managed_services", "mobileraker"),
-            ("env", env_py),
-            ("requirements", "scripts/mobileraker-requirements.txt"),
-            ("install_script", "scripts/install.sh"),
-        ],
-    )
-
-
-def update_mobileraker() -> None:
-    try:
-        if not MOBILERAKER_DIR.exists():
-            Logger.print_info(
-                "Mobileraker's companion does not seem to be installed! Skipping ..."
-            )
-            return
-
-        Logger.print_status("Updating Mobileraker's companion ...")
-
-        cmd_sysctl_service("mobileraker", "stop")
-
-        settings = KiauhSettings()
-        if settings.kiauh.backup_before_update:
-            backup_mobileraker_dir()
-
-        git_pull_wrapper(MOBILERAKER_REPO, MOBILERAKER_DIR)
-
-        requirements = MOBILERAKER_DIR.joinpath("/scripts/mobileraker-requirements.txt")
-        install_python_requirements(MOBILERAKER_ENV, requirements)
-
-        cmd_sysctl_service("mobileraker", "start")
-
-        Logger.print_ok("Mobileraker's companion updated successfully.", end="\n\n")
-    except CalledProcessError as e:
-        Logger.print_error(f"Error updating Mobileraker's companion:\n{e}")
-        return
-
-
-def get_mobileraker_status() -> ComponentStatus:
-    return get_install_status(
-        MOBILERAKER_DIR,
-        MOBILERAKER_ENV,
-        files=[SYSTEMD.joinpath("mobileraker.service")],
-    )
-
-
-def remove_mobileraker() -> None:
-    Logger.print_status("Removing Mobileraker's companion ...")
-    try:
-        if MOBILERAKER_DIR.exists():
-            Logger.print_status("Removing Mobileraker's companion directory ...")
-            shutil.rmtree(MOBILERAKER_DIR)
-            Logger.print_ok("Mobileraker's companion directory successfully removed!")
-        else:
-            Logger.print_warn("Mobileraker's companion directory not found!")
-
-        if MOBILERAKER_ENV.exists():
-            Logger.print_status("Removing Mobileraker's companion environment ...")
-            shutil.rmtree(MOBILERAKER_ENV)
-            Logger.print_ok("Mobileraker's companion environment successfully removed!")
-        else:
-            Logger.print_warn("Mobileraker's companion environment not found!")
-
-        service = SYSTEMD.joinpath("mobileraker.service")
-        if service.exists():
-            Logger.print_status("Removing mobileraker service ...")
-            cmd_sysctl_service(service, "stop")
-            cmd_sysctl_service(service, "disable")
-            remove_with_sudo(service)
-            cmd_sysctl_manage("daemon-reload")
-            cmd_sysctl_manage("reset-failed")
-            Logger.print_ok("Mobileraker's companion service successfully removed!")
-
-        kl_im = InstanceManager(Klipper)
-        kl_instances: List[Klipper] = kl_im.instances
-        for instance in kl_instances:
-            logfile = instance.log_dir.joinpath("mobileraker.log")
-            if logfile.exists():
-                Logger.print_status(f"Removing {logfile} ...")
-                Path(logfile).unlink()
-                Logger.print_ok(f"{logfile} successfully removed!")
-
-        mr_im = InstanceManager(Moonraker)
-        mr_instances: List[Moonraker] = mr_im.instances
-        if mr_instances:
-            Logger.print_status(
-                "Removing Mobileraker's companion from update manager ..."
-            )
-            remove_config_section("update_manager mobileraker", mr_instances)
-            Logger.print_ok(
-                "Mobileraker's companion successfully removed from update manager!"
-            )
-
-        Logger.print_ok("Mobileraker's companion successfully removed!")
-
-    except Exception as e:
-        Logger.print_error(f"Error removing Mobileraker's companion:\n{e}")
-
-
-def backup_mobileraker_dir() -> None:
-    bm = BackupManager()
-    bm.backup_directory(
-        "mobileraker_companion",
-        source=MOBILERAKER_DIR,
-        target=MOBILERAKER_BACKUP_DIR,
-    )
-    bm.backup_directory(
-        "mobileraker-env",
-        source=MOBILERAKER_ENV,
-        target=MOBILERAKER_BACKUP_DIR,
-    )

kiauh/components/moonraker/__init__.py

@@ -13,21 +13,33 @@ from core.backup_manager import BACKUP_ROOT_DIR
 
 MODULE_PATH = Path(__file__).resolve().parent
 
+# names
+MOONRAKER_CFG_NAME = "moonraker.conf"
+MOONRAKER_LOG_NAME = "moonraker.log"
+MOONRAKER_SERVICE_NAME = "moonraker.service"
+MOONRAKER_DEFAULT_PORT = 7125
+MOONRAKER_ENV_FILE_NAME = "moonraker.env"
+
+# directories
 MOONRAKER_DIR = Path.home().joinpath("moonraker")
 MOONRAKER_ENV_DIR = Path.home().joinpath("moonraker-env")
 MOONRAKER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("moonraker-backups")
 MOONRAKER_DB_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("moonraker-db-backups")
-MOONRAKER_REQUIREMENTS_TXT = MOONRAKER_DIR.joinpath(
-    "scripts/moonraker-requirements.txt"
-)
-DEFAULT_MOONRAKER_PORT = 7125
 
+# files
+MOONRAKER_INSTALL_SCRIPT = MOONRAKER_DIR.joinpath("scripts/install-moonraker.sh")
+MOONRAKER_REQ_FILE = MOONRAKER_DIR.joinpath("scripts/moonraker-requirements.txt")
+MOONRAKER_SPEEDUPS_REQ_FILE = MOONRAKER_DIR.joinpath("scripts/moonraker-speedups.txt")
+MOONRAKER_DEPS_JSON_FILE = MOONRAKER_DIR.joinpath("scripts/system-dependencies.json")
 # introduced due to
 # https://github.com/Arksine/moonraker/issues/349
 # https://github.com/Arksine/moonraker/pull/346
 POLKIT_LEGACY_FILE = Path("/etc/polkit-1/localauthority/50-local.d/10-moonraker.pkla")
 POLKIT_FILE = Path("/etc/polkit-1/rules.d/moonraker.rules")
 POLKIT_USR_FILE = Path("/usr/share/polkit-1/rules.d/moonraker.rules")
-POLKIT_SCRIPT = Path.home().joinpath("moonraker/scripts/set-policykit-rules.sh")
+POLKIT_SCRIPT = MOONRAKER_DIR.joinpath("scripts/set-policykit-rules.sh")
+MOONRAKER_SERVICE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{MOONRAKER_SERVICE_NAME}")
+MOONRAKER_ENV_FILE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{MOONRAKER_ENV_FILE_NAME}")
+
 
 EXIT_MOONRAKER_SETUP = "Exiting Moonraker setup ..."

kiauh/components/moonraker/menus/moonraker_remove_menu.py

@@ -6,43 +6,41 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
-from typing import Optional, Type
+from typing import Type
 
 from components.moonraker import moonraker_remove
+from core.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
 
 
 # noinspection PyUnusedLocal
 class MoonrakerRemoveMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
         self.remove_moonraker_service = False
         self.remove_moonraker_dir = False
         self.remove_moonraker_env = False
         self.remove_moonraker_polkit = False
-        self.delete_moonraker_logs = False
+        self.selection_state = False
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.remove_menu import RemoveMenu
 
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else RemoveMenu
-        )
+        self.previous_menu = previous_menu if previous_menu is not None else RemoveMenu
 
     def set_options(self) -> None:
         self.options = {
-            "0": Option(method=self.toggle_all, menu=False),
-            "1": Option(method=self.toggle_remove_moonraker_service, menu=False),
-            "2": Option(method=self.toggle_remove_moonraker_dir, menu=False),
-            "3": Option(method=self.toggle_remove_moonraker_env, menu=False),
-            "4": Option(method=self.toggle_remove_moonraker_polkit, menu=False),
-            "5": Option(method=self.toggle_delete_moonraker_logs, menu=False),
-            "c": Option(method=self.run_removal_process, menu=False),
+            "a": Option(method=self.toggle_all),
+            "1": Option(method=self.toggle_remove_moonraker_service),
+            "2": Option(method=self.toggle_remove_moonraker_dir),
+            "3": Option(method=self.toggle_remove_moonraker_env),
+            "4": Option(method=self.toggle_remove_moonraker_polkit),
+            "c": Option(method=self.run_removal_process),
         }
 
     def print_menu(self) -> None:
@@ -55,7 +53,6 @@ class MoonrakerRemoveMenu(BaseMenu):
         o2 = checked if self.remove_moonraker_dir else unchecked
         o3 = checked if self.remove_moonraker_env else unchecked
         o4 = checked if self.remove_moonraker_polkit else unchecked
-        o5 = checked if self.delete_moonraker_logs else unchecked
         menu = textwrap.dedent(
             f"""
             ╔═══════════════════════════════════════════════════════╗
@@ -64,13 +61,12 @@ class MoonrakerRemoveMenu(BaseMenu):
             ║ Enter a number and hit enter to select / deselect     ║
             ║ the specific option for removal.                      ║
             ╟───────────────────────────────────────────────────────╢
-            ║  0) Select everything                                 ║
+            ║  a) {self._get_selection_state_str():37}             ║
             ╟───────────────────────────────────────────────────────╢
             ║  1) {o1} Remove Service                                ║
             ║  2) {o2} Remove Local Repository                       ║
             ║  3) {o3} Remove Python Environment                     ║
             ║  4) {o4} Remove Policy Kit Rules                       ║
-            ║  5) {o5} Delete all Log-Files                          ║
             ╟───────────────────────────────────────────────────────╢
             ║  C) Continue                                          ║
             ╟───────────────────────────────────────────────────────╢
@@ -79,11 +75,11 @@ class MoonrakerRemoveMenu(BaseMenu):
         print(menu, end="")
 
     def toggle_all(self, **kwargs) -> None:
-        self.remove_moonraker_service = True
-        self.remove_moonraker_dir = True
-        self.remove_moonraker_env = True
-        self.remove_moonraker_polkit = True
-        self.delete_moonraker_logs = True
+        self.selection_state = not self.selection_state
+        self.remove_moonraker_service = self.selection_state
+        self.remove_moonraker_dir = self.selection_state
+        self.remove_moonraker_env = self.selection_state
+        self.remove_moonraker_polkit = self.selection_state
 
     def toggle_remove_moonraker_service(self, **kwargs) -> None:
         self.remove_moonraker_service = not self.remove_moonraker_service
@@ -97,16 +93,12 @@ class MoonrakerRemoveMenu(BaseMenu):
     def toggle_remove_moonraker_polkit(self, **kwargs) -> None:
         self.remove_moonraker_polkit = not self.remove_moonraker_polkit
 
-    def toggle_delete_moonraker_logs(self, **kwargs) -> None:
-        self.delete_moonraker_logs = not self.delete_moonraker_logs
-
     def run_removal_process(self, **kwargs) -> None:
         if (
             not self.remove_moonraker_service
             and not self.remove_moonraker_dir
             and not self.remove_moonraker_env
             and not self.remove_moonraker_polkit
-            and not self.delete_moonraker_logs
         ):
             error = f"{COLOR_RED}Nothing selected! Select options to remove first.{RESET_FORMAT}"
             print(error)
@@ -117,11 +109,20 @@ class MoonrakerRemoveMenu(BaseMenu):
             self.remove_moonraker_dir,
             self.remove_moonraker_env,
             self.remove_moonraker_polkit,
-            self.delete_moonraker_logs,
         )
 
         self.remove_moonraker_service = False
         self.remove_moonraker_dir = False
         self.remove_moonraker_env = False
         self.remove_moonraker_polkit = False
-        self.delete_moonraker_logs = False
+
+        self._go_back()
+
+    def _get_selection_state_str(self) -> str:
+        return (
+            "Select everything" if not self.selection_state else "Deselect everything"
+        )
+
+    def _go_back(self, **kwargs) -> None:
+        if self.previous_menu is not None:
+            self.previous_menu().run()

kiauh/components/moonraker/moonraker.py

@@ -8,151 +8,139 @@
 # ======================================================================= #
 from __future__ import annotations
 
-import subprocess
+from dataclasses import dataclass, field
 from pathlib import Path
-from typing import List
+from subprocess import CalledProcessError
 
-from components.moonraker import MODULE_PATH, MOONRAKER_DIR, MOONRAKER_ENV_DIR
+from components.klipper.klipper import Klipper
+from components.moonraker import (
+    MOONRAKER_CFG_NAME,
+    MOONRAKER_DIR,
+    MOONRAKER_ENV_DIR,
+    MOONRAKER_ENV_FILE_NAME,
+    MOONRAKER_ENV_FILE_TEMPLATE,
+    MOONRAKER_LOG_NAME,
+    MOONRAKER_SERVICE_TEMPLATE,
+)
+from core.constants import CURRENT_USER
 from core.instance_manager.base_instance import BaseInstance
+from core.logger import Logger
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
-from utils.constants import SYSTEMD
-from utils.logger import Logger
+from utils.fs_utils import create_folders
+from utils.sys_utils import get_service_file_path
 
 
 # noinspection PyMethodMayBeStatic
-class Moonraker(BaseInstance):
-    @classmethod
-    def blacklist(cls) -> List[str]:
-        return ["None", "mcu", "obico"]
+@dataclass
+class Moonraker:
+    suffix: str
+    base: BaseInstance = field(init=False, repr=False)
+    service_file_path: Path = field(init=False)
+    log_file_name: str = MOONRAKER_LOG_NAME
+    moonraker_dir: Path = MOONRAKER_DIR
+    env_dir: Path = MOONRAKER_ENV_DIR
+    data_dir: Path = field(init=False)
+    cfg_file: Path = field(init=False)
+    env_file: Path = field(init=False)
+    backup_dir: Path = field(init=False)
+    certs_dir: Path = field(init=False)
+    db_dir: Path = field(init=False)
+    port: int | None = field(init=False)
 
-    def __init__(self, suffix: str = ""):
-        super().__init__(instance_type=self, suffix=suffix)
-        self.moonraker_dir: Path = MOONRAKER_DIR
-        self.env_dir: Path = MOONRAKER_ENV_DIR
-        self.cfg_file = self.cfg_dir.joinpath("moonraker.conf")
-        self.port = self._get_port()
-        self.backup_dir = self.data_dir.joinpath("backup")
-        self.certs_dir = self.data_dir.joinpath("certs")
-        self._db_dir = self.data_dir.joinpath("database")
-        self._comms_dir = self.data_dir.joinpath("comms")
-        self.log = self.log_dir.joinpath("moonraker.log")
+    def __post_init__(self):
+        self.base: BaseInstance = BaseInstance(Klipper, self.suffix)
+        self.base.log_file_name = self.log_file_name
 
-    @property
-    def db_dir(self) -> Path:
-        return self._db_dir
+        self.service_file_path: Path = get_service_file_path(Moonraker, self.suffix)
+        self.data_dir: Path = self.base.data_dir
+        self.cfg_file: Path = self.base.cfg_dir.joinpath(MOONRAKER_CFG_NAME)
+        self.env_file: Path = self.base.sysd_dir.joinpath(MOONRAKER_ENV_FILE_NAME)
+        self.backup_dir: Path = self.base.data_dir.joinpath("backup")
+        self.certs_dir: Path = self.base.data_dir.joinpath("certs")
+        self.db_dir: Path = self.base.data_dir.joinpath("database")
+        self.port: int | None = self._get_port()
 
-    @property
-    def comms_dir(self) -> Path:
-        return self._comms_dir
+    def create(self) -> None:
+        from utils.sys_utils import create_env_file, create_service_file
 
-    def create(self, create_example_cfg: bool = False) -> None:
         Logger.print_status("Creating new Moonraker Instance ...")
-        service_template_path = MODULE_PATH.joinpath("assets/moonraker.service")
-        env_template_file_path = MODULE_PATH.joinpath("assets/moonraker.env")
-        service_file_name = self.get_service_file_name(extension=True)
-        service_file_target = SYSTEMD.joinpath(service_file_name)
-        env_file_target = self.sysd_dir.joinpath("moonraker.env")
 
         try:
-            self.create_folders([self.backup_dir, self.certs_dir, self._db_dir])
-            self.write_service_file(
-                service_template_path, service_file_target, env_file_target
-            )
-            self.write_env_file(env_template_file_path, env_file_target)
+            create_folders(self.base.base_folders)
 
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(
-                f"Error creating service file {service_file_target}: {e}"
+            create_service_file(
+                name=self.service_file_path.name,
+                content=self._prep_service_file_content(),
             )
+            create_env_file(
+                path=self.base.sysd_dir.joinpath(MOONRAKER_ENV_FILE_NAME),
+                content=self._prep_env_file_content(),
+            )
+
+        except CalledProcessError as e:
+            Logger.print_error(f"Error creating instance: {e}")
             raise
         except OSError as e:
-            Logger.print_error(f"Error writing file: {e}")
+            Logger.print_error(f"Error creating env file: {e}")
             raise
 
-    def delete(self) -> None:
-        service_file = self.get_service_file_name(extension=True)
-        service_file_path = self.get_service_file_path()
-
-        Logger.print_status(f"Deleting Moonraker Instance: {service_file}")
+    def _prep_service_file_content(self) -> str:
+        template = MOONRAKER_SERVICE_TEMPLATE
 
         try:
-            command = ["sudo", "rm", "-f", service_file_path]
-            subprocess.run(command, check=True)
-            Logger.print_ok(f"Service file deleted: {service_file_path}")
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(f"Error deleting service file: {e}")
-            raise
-
-    def write_service_file(
-        self,
-        service_template_path: Path,
-        service_file_target: Path,
-        env_file_target: Path,
-    ) -> None:
-        service_content = self._prep_service_file(
-            service_template_path, env_file_target
-        )
-        command = ["sudo", "tee", service_file_target]
-        subprocess.run(
-            command,
-            input=service_content.encode(),
-            stdout=subprocess.DEVNULL,
-            check=True,
-        )
-        Logger.print_ok(f"Service file created: {service_file_target}")
-
-    def write_env_file(
-        self, env_template_file_path: Path, env_file_target: Path
-    ) -> None:
-        env_file_content = self._prep_env_file(env_template_file_path)
-        with open(env_file_target, "w") as env_file:
-            env_file.write(env_file_content)
-        Logger.print_ok(f"Env file created: {env_file_target}")
-
-    def _prep_service_file(
-        self, service_template_path: Path, env_file_path: Path
-    ) -> str:
-        try:
-            with open(service_template_path, "r") as template_file:
+            with open(template, "r") as template_file:
                 template_content = template_file.read()
         except FileNotFoundError:
-            Logger.print_error(
-                f"Unable to open {service_template_path} - File not found"
-            )
+            Logger.print_error(f"Unable to open {template} - File not found")
             raise
-        service_content = template_content.replace("%USER%", self.user)
-        service_content = service_content.replace(
-            "%MOONRAKER_DIR%", str(self.moonraker_dir)
+
+        service_content = template_content.replace(
+            "%USER%",
+            CURRENT_USER,
+        )
+        service_content = service_content.replace(
+            "%MOONRAKER_DIR%",
+            self.moonraker_dir.as_posix(),
+        )
+        service_content = service_content.replace(
+            "%ENV%",
+            self.env_dir.as_posix(),
+        )
+        service_content = service_content.replace(
+            "%ENV_FILE%",
+            self.base.sysd_dir.joinpath(MOONRAKER_ENV_FILE_NAME).as_posix(),
         )
-        service_content = service_content.replace("%ENV%", str(self.env_dir))
-        service_content = service_content.replace("%ENV_FILE%", str(env_file_path))
         return service_content
 
-    def _prep_env_file(self, env_template_file_path: Path) -> str:
+    def _prep_env_file_content(self) -> str:
+        template = MOONRAKER_ENV_FILE_TEMPLATE
+
         try:
-            with open(env_template_file_path, "r") as env_file:
+            with open(template, "r") as env_file:
                 env_template_file_content = env_file.read()
         except FileNotFoundError:
-            Logger.print_error(
-                f"Unable to open {env_template_file_path} - File not found"
-            )
+            Logger.print_error(f"Unable to open {template} - File not found")
             raise
+
         env_file_content = env_template_file_content.replace(
-            "%MOONRAKER_DIR%", str(self.moonraker_dir)
+            "%MOONRAKER_DIR%",
+            self.moonraker_dir.as_posix(),
         )
         env_file_content = env_file_content.replace(
-            "%PRINTER_DATA%", str(self.data_dir)
+            "%PRINTER_DATA%",
+            self.base.data_dir.as_posix(),
         )
+
         return env_file_content
 
     def _get_port(self) -> int | None:
-        if not self.cfg_file.is_file():
+        if not self.cfg_file or not self.cfg_file.is_file():
             return None
 
         scp = SimpleConfigParser()
-        scp.read(self.cfg_file)
-        port = scp.getint("server", "port", fallback=None)
+        scp.read_file(self.cfg_file)
+        port: int | None = scp.getint("server", "port", fallback=None)
 
         return port

kiauh/components/moonraker/moonraker_dialogs.py

@@ -12,8 +12,8 @@ from typing import List
 
 from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
+from core.constants import COLOR_CYAN, COLOR_GREEN, COLOR_YELLOW, RESET_FORMAT
 from core.menus.base_menu import print_back_footer
-from utils.constants import COLOR_CYAN, COLOR_GREEN, COLOR_YELLOW, RESET_FORMAT
 
 
 def print_moonraker_overview(
@@ -37,8 +37,8 @@ def print_moonraker_overview(
         dialog += "║                                                       ║\n"
 
     instance_map = {
-        k.get_service_file_name(): (
-            k.get_service_file_name().replace("klipper", "moonraker")
+        k.service_file_path.stem: (
+            k.service_file_path.stem.replace("klipper", "moonraker")
             if k.suffix in [m.suffix for m in moonraker_instances]
             else ""
         )
@@ -48,7 +48,7 @@ def print_moonraker_overview(
     for i, k in enumerate(instance_map):
         mr_name = instance_map.get(k)
         m = f"<-> {mr_name}" if mr_name != "" else ""
-        line = f"{COLOR_CYAN}{f'{i})' if show_index else '●'} {k} {m} {RESET_FORMAT}"
+        line = f"{COLOR_CYAN}{f'{i+1})' if show_index else '●'} {k} {m} {RESET_FORMAT}"
         dialog += f"║ {line:<63}║\n"
 
     warn_l1 = f"{COLOR_YELLOW}PLEASE NOTE: {RESET_FORMAT}"

kiauh/components/moonraker/moonraker_remove.py

@@ -6,19 +6,20 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
-import shutil
-import subprocess
-from typing import List, Union
+from subprocess import DEVNULL, PIPE, CalledProcessError, run
+from typing import List
 
 from components.klipper.klipper_dialogs import print_instance_overview
 from components.moonraker import MOONRAKER_DIR, MOONRAKER_ENV_DIR
 from components.moonraker.moonraker import Moonraker
 from core.instance_manager.instance_manager import InstanceManager
-from utils.fs_utils import remove_file
+from core.logger import Logger
+from utils.fs_utils import run_remove_routines
 from utils.input_utils import get_selection_input
-from utils.logger import Logger
-from utils.sys_utils import cmd_sysctl_manage
+from utils.instance_utils import get_instances
+from utils.sys_utils import unit_file_exists
 
 
 def run_moonraker_removal(
@@ -26,102 +27,74 @@ def run_moonraker_removal(
     remove_dir: bool,
     remove_env: bool,
     remove_polkit: bool,
-    delete_logs: bool,
 ) -> None:
-    im = InstanceManager(Moonraker)
+    instances = get_instances(Moonraker)
 
     if remove_service:
         Logger.print_status("Removing Moonraker instances ...")
-        if im.instances:
-            instances_to_remove = select_instances_to_remove(im.instances)
-            remove_instances(im, instances_to_remove)
+        if instances:
+            instances_to_remove = select_instances_to_remove(instances)
+            remove_instances(instances_to_remove)
         else:
             Logger.print_info("No Moonraker Services installed! Skipped ...")
 
-    if (remove_polkit or remove_dir or remove_env) and im.instances:
-        Logger.print_warn("There are still other Moonraker services installed!")
-        Logger.print_warn("Therefor the following parts cannot be removed:")
-        Logger.print_warn(
-            """
-            ● Moonraker PolicyKit rules
-            ● Moonraker local repository
-            ● Moonraker Python environment
-            """,
-            False,
+    delete_remaining: bool = remove_polkit or remove_dir or remove_env
+    if delete_remaining and unit_file_exists("moonraker", suffix="service"):
+        Logger.print_info("There are still other Moonraker services installed")
+        Logger.print_info(
+            "●  Moonraker PolicyKit rules were not removed.", prefix=False
         )
+        Logger.print_info(f"● '{MOONRAKER_DIR}' was not removed.", prefix=False)
+        Logger.print_info(f"● '{MOONRAKER_ENV_DIR}' was not removed.", prefix=False)
     else:
         if remove_polkit:
             Logger.print_status("Removing all Moonraker policykit rules ...")
             remove_polkit_rules()
         if remove_dir:
             Logger.print_status("Removing Moonraker local repository ...")
-            remove_moonraker_dir()
+            run_remove_routines(MOONRAKER_DIR)
         if remove_env:
             Logger.print_status("Removing Moonraker Python environment ...")
-            remove_moonraker_env()
-
-    # delete moonraker logs of all instances
-    if delete_logs:
-        Logger.print_status("Removing all Moonraker logs ...")
-        delete_moonraker_logs(im.instances)
+            run_remove_routines(MOONRAKER_ENV_DIR)
 
 
 def select_instances_to_remove(
     instances: List[Moonraker],
-) -> Union[List[Moonraker], None]:
-    print_instance_overview(instances, show_index=True, show_select_all=True)
-
-    options = [str(i) for i in range(len(instances))]
-    options.extend(["a", "A", "b", "B"])
+) -> List[Moonraker] | None:
+    start_index = 1
+    options = [str(i + start_index) for i in range(len(instances))]
+    options.extend(["a", "b"])
+    instance_map = {options[i]: instances[i] for i in range(len(instances))}
 
+    print_instance_overview(
+        instances,
+        start_index=start_index,
+        show_index=True,
+        show_select_all=True,
+    )
     selection = get_selection_input("Select Moonraker instance to remove", options)
 
     instances_to_remove = []
-    if selection == "b".lower():
+    if selection == "b":
         return None
-    elif selection == "a".lower():
+    elif selection == "a":
         instances_to_remove.extend(instances)
     else:
-        instance = instances[int(selection)]
-        instances_to_remove.append(instance)
+        instances_to_remove.append(instance_map[selection])
 
     return instances_to_remove
 
 
 def remove_instances(
-    instance_manager: InstanceManager,
-    instance_list: List[Moonraker],
+    instance_list: List[Moonraker] | None,
 ) -> None:
+    if not instance_list:
+        Logger.print_info("No Moonraker instances found. Skipped ...")
+        return
     for instance in instance_list:
-        Logger.print_status(f"Removing instance {instance.get_service_file_name()} ...")
-        instance_manager.current_instance = instance
-        instance_manager.stop_instance()
-        instance_manager.disable_instance()
-        instance_manager.delete_instance()
-
-    cmd_sysctl_manage("daemon-reload")
-
-
-def remove_moonraker_dir() -> None:
-    if not MOONRAKER_DIR.exists():
-        Logger.print_info(f"'{MOONRAKER_DIR}' does not exist. Skipped ...")
-        return
-
-    try:
-        shutil.rmtree(MOONRAKER_DIR)
-    except OSError as e:
-        Logger.print_error(f"Unable to delete '{MOONRAKER_DIR}':\n{e}")
-
-
-def remove_moonraker_env() -> None:
-    if not MOONRAKER_ENV_DIR.exists():
-        Logger.print_info(f"'{MOONRAKER_ENV_DIR}' does not exist. Skipped ...")
-        return
-
-    try:
-        shutil.rmtree(MOONRAKER_ENV_DIR)
-    except OSError as e:
-        Logger.print_error(f"Unable to delete '{MOONRAKER_ENV_DIR}':\n{e}")
+        Logger.print_status(f"Removing instance {instance.service_file_path.stem} ...")
+        InstanceManager.remove(instance)
+        delete_moonraker_env_file(instance)
 
 
 def remove_polkit_rules() -> None:
@@ -131,30 +104,18 @@ def remove_polkit_rules() -> None:
         return
 
     try:
-        command = [
-            f"{MOONRAKER_DIR}/scripts/set-policykit-rules.sh",
-            "--clear",
-        ]
-        subprocess.run(
-            command,
-            stderr=subprocess.PIPE,
-            stdout=subprocess.DEVNULL,
-            check=True,
-        )
-    except subprocess.CalledProcessError as e:
+        cmd = [f"{MOONRAKER_DIR}/scripts/set-policykit-rules.sh", "--clear"]
+        run(cmd, stderr=PIPE, stdout=DEVNULL, check=True)
+    except CalledProcessError as e:
         Logger.print_error(f"Error while removing policykit rules: {e}")
 
     Logger.print_ok("Policykit rules successfully removed!")
 
 
-def delete_moonraker_logs(instances: List[Moonraker]) -> None:
-    all_logfiles = []
-    for instance in instances:
-        all_logfiles = list(instance.log_dir.glob("moonraker.log*"))
-    if not all_logfiles:
-        Logger.print_info("No Moonraker logs found. Skipped ...")
+def delete_moonraker_env_file(instance: Moonraker):
+    Logger.print_status(f"Remove '{instance.env_file}'")
+    if not instance.env_file.exists():
+        msg = f"Env file in {instance.base.sysd_dir} not found. Skipped ..."
+        Logger.print_info(msg)
         return
-
-    for log in all_logfiles:
-        Logger.print_status(f"Remove '{log}'")
-        remove_file(log)
+    run_remove_routines(instance.env_file)

kiauh/components/moonraker/moonraker_setup.py

@@ -6,16 +6,21 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
+
 import json
 import subprocess
-from pathlib import Path
+from typing import List
 
 from components.klipper.klipper import Klipper
 from components.moonraker import (
     EXIT_MOONRAKER_SETUP,
+    MOONRAKER_DEPS_JSON_FILE,
     MOONRAKER_DIR,
     MOONRAKER_ENV_DIR,
-    MOONRAKER_REQUIREMENTS_TXT,
+    MOONRAKER_INSTALL_SCRIPT,
+    MOONRAKER_REQ_FILE,
+    MOONRAKER_SPEEDUPS_REQ_FILE,
     POLKIT_FILE,
     POLKIT_LEGACY_FILE,
     POLKIT_SCRIPT,
@@ -33,6 +38,7 @@ from components.webui_client.client_utils import (
 )
 from components.webui_client.mainsail_data import MainsailData
 from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
 from core.settings.kiauh_settings import KiauhSettings
 from utils.common import check_install_dependencies
 from utils.fs_utils import check_file_exist
@@ -41,10 +47,11 @@ from utils.input_utils import (
     get_confirm,
     get_selection_input,
 )
-from utils.logger import Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
     check_python_version,
     cmd_sysctl_manage,
+    cmd_sysctl_service,
     create_python_venv,
     install_python_requirements,
     parse_packages_from_file,
@@ -52,70 +59,67 @@ from utils.sys_utils import (
 
 
 def install_moonraker() -> None:
-    if not check_moonraker_install_requirements():
+    klipper_list: List[Klipper] = get_instances(Klipper)
+
+    if not check_moonraker_install_requirements(klipper_list):
         return
 
-    kl_im = InstanceManager(Klipper)
-    klipper_instances = kl_im.instances
-    mr_im = InstanceManager(Moonraker)
-    moonraker_instances = mr_im.instances
+    moonraker_list: List[Moonraker] = get_instances(Moonraker)
+    instances: List[Moonraker] = []
+    selected_option: str | Klipper
 
-    selected_klipper_instance = 0
-    if len(klipper_instances) > 1:
+    if len(klipper_list) == 1:
+        instances.append(Moonraker(klipper_list[0].suffix))
+    else:
         print_moonraker_overview(
-            klipper_instances,
-            moonraker_instances,
+            klipper_list,
+            moonraker_list,
             show_index=True,
             show_select_all=True,
         )
-        options = [str(i) for i in range(len(klipper_instances))]
-        options.extend(["a", "A", "b", "B"])
+        options = {str(i + 1): k for i, k in enumerate(klipper_list)}
+        additional_options = {"a": None, "b": None}
+        options = {**options, **additional_options}
         question = "Select Klipper instance to setup Moonraker for"
-        selected_klipper_instance = get_selection_input(question, options).lower()
+        selected_option = get_selection_input(question, options)
 
-    instance_names = []
-    if selected_klipper_instance == "b":
-        Logger.print_status(EXIT_MOONRAKER_SETUP)
-        return
+        if selected_option == "b":
+            Logger.print_status(EXIT_MOONRAKER_SETUP)
+            return
 
-    elif selected_klipper_instance == "a":
-        for instance in klipper_instances:
-            instance_names.append(instance.suffix)
-
-    else:
-        index = int(selected_klipper_instance)
-        instance_names.append(klipper_instances[index].suffix)
+        if selected_option == "a":
+            instances.extend([Moonraker(k.suffix) for k in klipper_list])
+        else:
+            klipper_instance: Klipper | None = options.get(selected_option)
+            if klipper_instance is None:
+                raise Exception("Error selecting instance!")
+            instances.append(Moonraker(klipper_instance.suffix))
 
     create_example_cfg = get_confirm("Create example moonraker.conf?")
 
     try:
-        check_install_dependencies(["git"])
+        check_install_dependencies()
         setup_moonraker_prerequesites()
         install_moonraker_polkit()
 
-        used_ports_map = {
-            instance.suffix: instance.port for instance in moonraker_instances
-        }
-        for name in instance_names:
-            current_instance = Moonraker(suffix=name)
-
-            mr_im.current_instance = current_instance
-            mr_im.create_instance()
-            mr_im.enable_instance()
+        used_ports_map = {m.suffix: m.port for m in moonraker_list}
+        for instance in instances:
+            instance.create()
+            cmd_sysctl_service(instance.service_file_path.name, "enable")
 
             if create_example_cfg:
                 # if a webclient and/or it's config is installed, patch
                 # its update section to the config
                 clients = get_existing_clients()
-                create_example_moonraker_conf(current_instance, used_ports_map, clients)
+                create_example_moonraker_conf(instance, used_ports_map, clients)
 
-            mr_im.start_instance()
+            cmd_sysctl_service(instance.service_file_path.name, "start")
 
         cmd_sysctl_manage("daemon-reload")
 
         # if mainsail is installed, and we installed
         # multiple moonraker instances, we enable mainsails remote mode
-        if MainsailData().client_dir.exists() and len(mr_im.instances) > 1:
+        if MainsailData().client_dir.exists() and len(moonraker_list) > 1:
             enable_mainsail_remotemode()
 
     except Exception as e:
@@ -123,9 +127,9 @@ def install_moonraker() -> None:
         return
 
 
-def check_moonraker_install_requirements() -> bool:
+def check_moonraker_install_requirements(klipper_list: List[Klipper]) -> bool:
     def check_klipper_instances() -> bool:
-        if len(InstanceManager(Klipper).instances) >= 1:
+        if len(klipper_list) >= 1:
             return True
 
         Logger.print_warn("Klipper not installed!")
@@ -143,26 +147,25 @@ def setup_moonraker_prerequesites() -> None:
     git_clone_wrapper(repo, MOONRAKER_DIR, branch)
 
     # install moonraker dependencies and create python virtualenv
-    install_moonraker_packages(MOONRAKER_DIR)
-    create_python_venv(MOONRAKER_ENV_DIR)
-    install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQUIREMENTS_TXT)
+    install_moonraker_packages()
+    if create_python_venv(MOONRAKER_ENV_DIR):
+        install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
+        install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_SPEEDUPS_REQ_FILE)
 
 
-def install_moonraker_packages(moonraker_dir: Path) -> None:
-    install_script = moonraker_dir.joinpath("scripts/install-moonraker.sh")
-    deps_json = MOONRAKER_DIR.joinpath("scripts/system-dependencies.json")
+def install_moonraker_packages() -> None:
     moonraker_deps = []
 
-    if deps_json.exists():
-        with open(deps_json, "r") as deps:
+    if MOONRAKER_DEPS_JSON_FILE.exists():
+        with open(MOONRAKER_DEPS_JSON_FILE, "r") as deps:
             moonraker_deps = json.load(deps).get("debian", [])
-    elif install_script.exists():
-        moonraker_deps = parse_packages_from_file(install_script)
+    elif MOONRAKER_INSTALL_SCRIPT.exists():
+        moonraker_deps = parse_packages_from_file(MOONRAKER_INSTALL_SCRIPT)
 
     if not moonraker_deps:
         raise ValueError("Error reading Moonraker dependencies!")
 
-    check_install_dependencies(moonraker_deps)
+    check_install_dependencies({*moonraker_deps})
 
 
 def install_moonraker_polkit() -> None:
@@ -203,16 +206,14 @@ def update_moonraker() -> None:
     if settings.kiauh.backup_before_update:
         backup_moonraker_dir()
 
-    instance_manager = InstanceManager(Moonraker)
-    instance_manager.stop_all_instance()
+    instances = get_instances(Moonraker)
+    InstanceManager.stop_all(instances)
 
-    git_pull_wrapper(
-        repo=settings.moonraker.repo_url, target_dir=MOONRAKER_DIR
-    )
+    git_pull_wrapper(repo=settings.moonraker.repo_url, target_dir=MOONRAKER_DIR)
 
     # install possible new system packages
-    install_moonraker_packages(MOONRAKER_DIR)
+    install_moonraker_packages()
     # install possible new python dependencies
-    install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQUIREMENTS_TXT)
+    install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
 
-    instance_manager.start_all_instance()
+    InstanceManager.start_all(instances)

kiauh/components/moonraker/moonraker_utils.py

@@ -11,28 +11,26 @@ import shutil
 from typing import Dict, List, Optional
 
 from components.moonraker import (
-    DEFAULT_MOONRAKER_PORT,
     MODULE_PATH,
     MOONRAKER_BACKUP_DIR,
     MOONRAKER_DB_BACKUP_DIR,
+    MOONRAKER_DEFAULT_PORT,
     MOONRAKER_DIR,
     MOONRAKER_ENV_DIR,
 )
 from components.moonraker.moonraker import Moonraker
 from components.webui_client.base_data import BaseWebClient
-from components.webui_client.client_utils import enable_mainsail_remotemode
-from components.webui_client.mainsail_data import MainsailData
 from core.backup_manager.backup_manager import BackupManager
-from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
+from core.types import ComponentStatus
 from utils.common import get_install_status
-from utils.logger import Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
     get_ipv4_addr,
 )
-from utils.types import ComponentStatus
 
 
 def get_moonraker_status() -> ComponentStatus:
@@ -44,7 +42,7 @@ def create_example_moonraker_conf(
     ports_map: Dict[str, int],
     clients: Optional[List[BaseWebClient]] = None,
 ) -> None:
-    Logger.print_status(f"Creating example moonraker.conf in '{instance.cfg_dir}'")
+    Logger.print_status(f"Creating example moonraker.conf in '{instance.base.cfg_dir}'")
     if instance.cfg_file.is_file():
         Logger.print_info(f"'{instance.cfg_file}' already exists.")
         return
@@ -68,7 +66,7 @@ def create_example_moonraker_conf(
         # of moonraker-1 is 7125 and moonraker-3 is 7127 and there are moonraker.conf files for moonraker-1
         # and moonraker-3 already. though, there does not seem to be a very reliable way of always assigning
         # the correct port to each instance and the user will likely be required to correct the value manually.
-        port = max(ports) + 1 if ports else DEFAULT_MOONRAKER_PORT
+        port = max(ports) + 1 if ports else MOONRAKER_DEFAULT_PORT
     else:
         port = ports_map.get(instance.suffix)
 
@@ -76,23 +74,18 @@ def create_example_moonraker_conf(
 
     ip = get_ipv4_addr().split(".")[:2]
     ip.extend(["0", "0/16"])
-    uds = instance.comms_dir.joinpath("klippy.sock")
+    uds = instance.base.comms_dir.joinpath("klippy.sock")
 
     scp = SimpleConfigParser()
-    scp.read(target)
+    scp.read_file(target)
     trusted_clients: List[str] = [
-        ".".join(ip),
-        *scp.get("authorization", "trusted_clients"),
+        f"    {'.'.join(ip)}\n",
+        *scp.getval("authorization", "trusted_clients"),
     ]
 
-    scp.set("server", "port", str(port))
-    scp.set("server", "klippy_uds_address", str(uds))
-    scp.set(
-        "authorization",
-        "trusted_clients",
-        "\n".join(trusted_clients),
-        True,
-    )
+    scp.set_option("server", "port", str(port))
+    scp.set_option("server", "klippy_uds_address", str(uds))
+    scp.set_option("authorization", "trusted_clients", trusted_clients)
 
     # add existing client and client configs in the update section
     if clients is not None and len(clients) > 0:
@@ -107,7 +100,7 @@ def create_example_moonraker_conf(
             ]
             scp.add_section(section=c_section)
             for option in c_options:
-                scp.set(c_section, option[0], option[1])
+                scp.set_option(c_section, option[0], option[1])
 
             # client config part
             c_config = c.client_config
@@ -122,65 +115,13 @@ def create_example_moonraker_conf(
                 ]
                 scp.add_section(section=c_config_section)
                 for option in c_config_options:
-                    scp.set(c_config_section, option[0], option[1])
+                    scp.set_option(c_config_section, option[0], option[1])
 
-    scp.write(target)
-    Logger.print_ok(f"Example moonraker.conf created in '{instance.cfg_dir}'")
+    scp.write_file(target)
+    Logger.print_ok(f"Example moonraker.conf created in '{instance.base.cfg_dir}'")
 
 
-def moonraker_to_multi_conversion(new_name: str) -> None:
-    """
-    Converts the first instance in the List of Moonraker instances to an instance
-    with a new name. This method will be called when converting from a single Klipper
-    instance install to a multi instance install when Moonraker is also already
-    installed with a single instance.
-    :param new_name: new name the previous single instance is renamed to
-    :return: None
-    """
-    im = InstanceManager(Moonraker)
-    instances: List[Moonraker] = im.instances
-    if not instances:
-        return
-
-    # in case there are multiple Moonraker instances, we don't want to do anything
-    if len(instances) > 1:
-        Logger.print_info("More than a single Moonraker instance found. Skipped ...")
-        return
-
-    Logger.print_status("Convert Moonraker single to multi instance ...")
-
-    # remove the old single instance
-    im.current_instance = im.instances[0]
-    im.stop_instance()
-    im.disable_instance()
-    im.delete_instance()
-
-    # create a new moonraker instance with the new name
-    new_instance = Moonraker(suffix=new_name)
-    im.current_instance = new_instance
-
-    # patch the server sections klippy_uds_address value to match the new printer_data foldername
-    scp = SimpleConfigParser()
-    scp.read(new_instance.cfg_file)
-    if scp.has_section("server"):
-        scp.set(
-            "server",
-            "klippy_uds_address",
-            str(new_instance.comms_dir.joinpath("klippy.sock")),
-        )
-        scp.write(new_instance.cfg_file)
-
-    # create, enable and start the new moonraker instance
-    im.create_instance()
-    im.enable_instance()
-    im.start_instance()
-
-    # if mainsail is installed, we enable mainsails remote mode
-    if MainsailData().client_dir.exists() and len(im.instances) > 1:
-        enable_mainsail_remotemode()
-
-
-def backup_moonraker_dir():
+def backup_moonraker_dir() -> None:
     bm = BackupManager()
     bm.backup_directory("moonraker", source=MOONRAKER_DIR, target=MOONRAKER_BACKUP_DIR)
     bm.backup_directory(
@@ -189,12 +130,11 @@ def backup_moonraker_dir():
 
 
 def backup_moonraker_db_dir() -> None:
-    im = InstanceManager(Moonraker)
-    instances: List[Moonraker] = im.instances
+    instances: List[Moonraker] = get_instances(Moonraker)
     bm = BackupManager()
 
     for instance in instances:
-        name = f"database-{instance.data_dir_name}"
+        name = f"database-{instance.data_dir.name}"
         bm.backup_directory(
             name, source=instance.db_dir, target=MOONRAKER_DB_BACKUP_DIR
         )

kiauh/components/webui_client/base_data.py

@@ -9,7 +9,8 @@
 
 from __future__ import annotations
 
-from abc import ABC, abstractmethod
+from abc import ABC
+from dataclasses import dataclass
 from enum import Enum
 from pathlib import Path
 
@@ -24,89 +25,32 @@ class WebClientConfigType(Enum):
     FLUIDD: str = "fluidd-config"
 
 
+@dataclass()
 class BaseWebClient(ABC):
     """Base class for webclient data"""
 
-    @property
-    @abstractmethod
-    def client(self) -> WebClientType:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def name(self) -> str:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def display_name(self) -> str:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def client_dir(self) -> Path:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def backup_dir(self) -> Path:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def repo_path(self) -> str:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def download_url(self) -> str:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def client_config(self) -> BaseWebClientConfig:
-        raise NotImplementedError
+    client: WebClientType
+    name: str
+    display_name: str
+    client_dir: Path
+    config_file: Path
+    backup_dir: Path
+    repo_path: str
+    download_url: str
+    nginx_access_log: Path
+    nginx_error_log: Path
+    client_config: BaseWebClientConfig
 
 
+@dataclass()
 class BaseWebClientConfig(ABC):
     """Base class for webclient config data"""
 
-    @property
-    @abstractmethod
-    def client_config(self) -> WebClientConfigType:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def name(self) -> str:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def display_name(self) -> str:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def config_filename(self) -> str:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def config_dir(self) -> Path:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def backup_dir(self) -> Path:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def repo_url(self) -> str:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def config_section(self) -> str:
-        raise NotImplementedError
+    client_config: WebClientConfigType
+    name: str
+    display_name: str
+    config_filename: str
+    config_dir: Path
+    backup_dir: Path
+    repo_url: str
+    config_section: str

kiauh/components/webui_client/client_config/client_config_remove.py

@@ -8,17 +8,15 @@
 # ======================================================================= #
 
 
-import shutil
-import subprocess
 from typing import List
 
 from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
 from components.webui_client.base_data import BaseWebClientConfig
-from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
 from utils.config_utils import remove_config_section
-from utils.fs_utils import remove_file
-from utils.logger import Logger
+from utils.fs_utils import run_remove_routines
+from utils.instance_utils import get_instances
 
 
 def run_client_config_removal(
@@ -33,29 +31,13 @@ def run_client_config_removal(
 
 
 def remove_client_config_dir(client_config: BaseWebClientConfig) -> None:
-    Logger.print_status(f"Removing {client_config.name} ...")
-    client_config_dir = client_config.config_dir
-    if not client_config_dir.exists():
-        Logger.print_info(f"'{client_config_dir}' does not exist. Skipping ...")
-        return
-
-    try:
-        shutil.rmtree(client_config_dir)
-    except OSError as e:
-        Logger.print_error(f"Unable to delete '{client_config_dir}':\n{e}")
+    Logger.print_status(f"Removing {client_config.display_name} ...")
+    run_remove_routines(client_config.config_dir)
 
 
 def remove_client_config_symlink(client_config: BaseWebClientConfig) -> None:
-    im = InstanceManager(Klipper)
-    instances: List[Klipper] = im.instances
+    instances: List[Klipper] = get_instances(Klipper)
     for instance in instances:
-        Logger.print_status(f"Removing symlink from '{instance.cfg_dir}' ...")
-        symlink = instance.cfg_dir.joinpath(client_config.config_filename)
-        if not symlink.is_symlink():
-            Logger.print_info(f"'{symlink}' does not exist. Skipping ...")
-            continue
-
-        try:
-            remove_file(symlink)
-        except subprocess.CalledProcessError:
-            Logger.print_error("Failed to remove symlink!")
+        run_remove_routines(
+            instance.base.cfg_dir.joinpath(client_config.config_filename)
+        )

kiauh/components/webui_client/client_config/client_config_setup.py

@@ -6,6 +6,7 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import shutil
 import subprocess
@@ -20,23 +21,24 @@ from components.webui_client.client_dialogs import (
 )
 from components.webui_client.client_utils import (
     backup_client_config_data,
-    config_for_other_client_exist,
+    detect_client_cfg_conflict,
 )
 from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
 from core.settings.kiauh_settings import KiauhSettings
 from utils.common import backup_printer_config_dir
 from utils.config_utils import add_config_section, add_config_section_at_top
 from utils.fs_utils import create_symlink
 from utils.git_utils import git_clone_wrapper, git_pull_wrapper
 from utils.input_utils import get_confirm
-from utils.logger import Logger
+from utils.instance_utils import get_instances
 
 
 def install_client_config(client_data: BaseWebClient) -> None:
     client_config: BaseWebClientConfig = client_data.client_config
     display_name = client_config.display_name
 
-    if config_for_other_client_exist(client_data.client):
+    if detect_client_cfg_conflict(client_data):
         Logger.print_info("Another Client-Config is already installed! Skipped ...")
         return
 
@@ -47,10 +49,8 @@ def install_client_config(client_data: BaseWebClient) -> None:
         else:
             return
 
-    mr_im = InstanceManager(Moonraker)
-    mr_instances: List[Moonraker] = mr_im.instances
-    kl_im = InstanceManager(Klipper)
-    kl_instances = kl_im.instances
+    mr_instances: List[Moonraker] = get_instances(Moonraker)
+    kl_instances = get_instances(Klipper)
 
     try:
         download_client_config(client_config)
@@ -70,7 +70,7 @@ def install_client_config(client_data: BaseWebClient) -> None:
             ],
         )
         add_config_section_at_top(client_config.config_section, kl_instances)
-        kl_im.restart_all_instance()
+        InstanceManager.restart_all(kl_instances)
 
     except Exception as e:
         Logger.print_error(f"{display_name} installation failed!\n{e}")
@@ -112,16 +112,12 @@ def update_client_config(client: BaseWebClient) -> None:
 
 
 def create_client_config_symlink(
-    client_config: BaseWebClientConfig, klipper_instances: List[Klipper] = None
+    client_config: BaseWebClientConfig, klipper_instances: List[Klipper]
 ) -> None:
-    if klipper_instances is None:
-        kl_im = InstanceManager(Klipper)
-        klipper_instances = kl_im.instances
-
-    Logger.print_status(f"Create symlink for {client_config.config_filename} ...")
-    source = Path(client_config.config_dir, client_config.config_filename)
     for instance in klipper_instances:
-        target = instance.cfg_dir
+        Logger.print_status(f"Create symlink for {client_config.config_filename} ...")
+        source = Path(client_config.config_dir, client_config.config_filename)
+        target = instance.base.cfg_dir
         Logger.print_status(f"Linking {source} to {target}")
         try:
             create_symlink(source, target)

kiauh/components/webui_client/client_dialogs.py

@@ -7,102 +7,82 @@
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
 
-import textwrap
 from typing import List
 
 from components.webui_client.base_data import BaseWebClient
-from core.menus.base_menu import print_back_footer
-from utils.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
+from core.logger import DialogType, Logger
 
 
-def print_moonraker_not_found_dialog():
-    line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
-    line2 = f"{COLOR_YELLOW}No local Moonraker installation was found!{RESET_FORMAT}"
-    dialog = textwrap.dedent(
-        f"""
-        /=======================================================\\
-        | {line1:<63}|
-        | {line2:<63}|
-        |-------------------------------------------------------|
-        | It is possible to install Mainsail without a local    |
-        | Moonraker installation. If you continue, you need to  |
-        | make sure, that Moonraker is installed on another     |
-        | machine in your network. Otherwise Mainsail will NOT  |
-        | work correctly.                                       |
-        """
-    )[1:]
-
-    print(dialog, end="")
-    print_back_footer()
+def print_moonraker_not_found_dialog() -> None:
+    Logger.print_dialog(
+        DialogType.WARNING,
+        [
+            "No local Moonraker installation was found!",
+            "\n\n",
+            "It is possible to install Mainsail without a local Moonraker installation. "
+            "If you continue, you need to make sure, that Moonraker is installed on "
+            "another machine in your network. Otherwise Mainsail will NOT work "
+            "correctly.",
+        ],
+    )
 
 
-def print_client_already_installed_dialog(name: str):
-    line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
-    line2 = f"{COLOR_YELLOW}{name} seems to be already installed!{RESET_FORMAT}"
-    line3 = f"If you continue, your current {name}"
-    dialog = textwrap.dedent(
-        f"""
-        /=======================================================\\
-        | {line1:<63}|
-        | {line2:<63}|
-        |-------------------------------------------------------|
-        | {line3:<54}|
-        | installation will be overwritten.                     |
-        """
-    )[1:]
-
-    print(dialog, end="")
-    print_back_footer()
+def print_client_already_installed_dialog(name: str) -> None:
+    Logger.print_dialog(
+        DialogType.WARNING,
+        [
+            f"{name} seems to be already installed!",
+            f"If you continue, your current {name} installation will be overwritten.",
+        ],
+    )
 
 
-def print_client_port_select_dialog(name: str, port: int, ports_in_use: List[int]):
-    port = f"{COLOR_CYAN}{port}{RESET_FORMAT}"
-    line1 = f"Please select the port, {name} should be served on."
-    line2 = f"In case you need {name} to be served on a specific"
-    dialog = textwrap.dedent(
-        f"""
-        /=======================================================\\
-        | {line1:<54}|
-        | If you are unsure what to select, hit Enter to apply  |
-        | the suggested value of: {port:38} |
-        |                                                       |
-        | {line2:<54}|
-        | port, you can set it now. Make sure the port is not   |
-        | used by any other application on your system!         |
-        """
-    )[1:]
-
-    if len(ports_in_use) > 0:
-        dialog += "|-------------------------------------------------------|\n"
-        dialog += "| The following ports were found to be in use already:  |\n"
-        for port in ports_in_use:
-            port = f"{COLOR_CYAN}● {port}{RESET_FORMAT}"
-            dialog += f"|  {port:60}  |\n"
-
-    dialog += "\\=======================================================/\n"
-
-    print(dialog, end="")
+def print_client_port_select_dialog(
+    name: str, port: int, ports_in_use: List[int]
+) -> None:
+    Logger.print_dialog(
+        DialogType.CUSTOM,
+        [
+            f"Please select the port, {name} should be served on. If your are unsure "
+            f"what to select, hit Enter to apply the suggested value of: {port}",
+            "\n\n",
+            f"In case you need {name} to be served on a specific port, you can set it "
+            f"now. Make sure that the port is not already used by another application "
+            f"on your system!",
+            "\n\n",
+            "The following ports were found to be in use already:",
+            *[f"● {port}" for port in ports_in_use],
+        ],
+    )
 
 
-def print_install_client_config_dialog(client: BaseWebClient):
+def print_install_client_config_dialog(client: BaseWebClient) -> None:
     name = client.display_name
     url = client.client_config.repo_url.replace(".git", "")
-    line1 = f"have {name} fully functional and working."
-    line2 = f"The recommended macros for {name} can be seen here:"
-    dialog = textwrap.dedent(
-        f"""
-        /=======================================================\\
-        | It is recommended to use special macros in order to   |
-        | {line1:<54}|
-        |                                                       |
-        | {line2:<54}|
-        | {url:<54}|
-        |                                                       |
-        | If you already use these macros skip this step.       |
-        | Otherwise you should consider to answer with 'Y' to   |
-        | download the recommended macros.                      |
-        \\=======================================================/
-        """
-    )[1:]
+    Logger.print_dialog(
+        DialogType.INFO,
+        [
+            f"It is recommended to use special macros in order to have {name} fully "
+            f"functional and working.",
+            "\n\n",
+            f"The recommended macros for {name} can be seen here:",
+            url,
+            "\n\n",
+            "If you already use these macros skip this step. Otherwise you should "
+            "consider to answer with 'Y' to download the recommended macros.",
+        ],
+    )
 
-    print(dialog, end="")
+
+def print_ipv6_warning_dialog() -> None:
+    Logger.print_dialog(
+        DialogType.WARNING,
+        [
+            "It looks like IPv6 is enabled on this system!",
+            "This may cause issues with the installation of NGINX in the following "
+            "steps! It is recommended to disable IPv6 on your system to avoid this issue.",
+            "\n\n",
+            "If you think this warning is a false alarm, and you are sure that "
+            "IPv6 is disabled, you can continue with the installation.",
+        ],
+    )

kiauh/components/webui_client/client_remove.py

@@ -6,54 +6,50 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
-
-
-import shutil
 from typing import List
 
 from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
 from components.webui_client.base_data import (
     BaseWebClient,
-    WebClientType,
 )
 from components.webui_client.client_config.client_config_remove import (
     run_client_config_removal,
 )
-from components.webui_client.client_utils import backup_mainsail_config_json
-from core.instance_manager.instance_manager import InstanceManager
+from core.backup_manager.backup_manager import BackupManager
+from core.constants import NGINX_SITES_AVAILABLE, NGINX_SITES_ENABLED
+from core.logger import Logger
 from utils.config_utils import remove_config_section
 from utils.fs_utils import (
-    remove_nginx_config,
-    remove_nginx_logs,
+    remove_with_sudo,
+    run_remove_routines,
 )
-from utils.logger import Logger
+from utils.instance_utils import get_instances
 
 
 def run_client_removal(
     client: BaseWebClient,
-    rm_client: bool,
-    rm_client_config: bool,
-    backup_ms_config_json: bool,
+    remove_client: bool,
+    remove_client_cfg: bool,
+    backup_config: bool,
 ) -> None:
-    mr_im = InstanceManager(Moonraker)
-    mr_instances: List[Moonraker] = mr_im.instances
-    kl_im = InstanceManager(Klipper)
-    kl_instances: List[Klipper] = kl_im.instances
+    mr_instances: List[Moonraker] = get_instances(Moonraker)
+    kl_instances: List[Klipper] = get_instances(Klipper)
 
-    if backup_ms_config_json and client.client == WebClientType.MAINSAIL:
-        backup_mainsail_config_json()
+    if backup_config:
+        bm = BackupManager()
+        bm.backup_file(client.config_file)
 
-    if rm_client:
+    if remove_client:
         client_name = client.name
         remove_client_dir(client)
-        remove_nginx_config(client_name)
-        remove_nginx_logs(client_name, kl_instances)
+        remove_client_nginx_config(client_name)
+        remove_client_nginx_logs(client, kl_instances)
 
         section = f"update_manager {client_name}"
         remove_config_section(section, mr_instances)
 
-    if rm_client_config:
+    if remove_client_cfg:
         run_client_config_removal(
             client.client_config,
             kl_instances,
@@ -63,12 +59,27 @@ def run_client_removal(
 
 def remove_client_dir(client: BaseWebClient) -> None:
     Logger.print_status(f"Removing {client.display_name} ...")
-    client_dir = client.client_dir
-    if not client.client_dir.exists():
-        Logger.print_info(f"'{client_dir}' does not exist. Skipping ...")
+    run_remove_routines(client.client_dir)
+
+
+def remove_client_nginx_config(name: str) -> None:
+    Logger.print_status(f"Removing NGINX config for {name.capitalize()} ...")
+
+    remove_with_sudo(NGINX_SITES_AVAILABLE.joinpath(name))
+    remove_with_sudo(NGINX_SITES_ENABLED.joinpath(name))
+
+
+def remove_client_nginx_logs(client: BaseWebClient, instances: List[Klipper]) -> None:
+    Logger.print_status(f"Removing NGINX logs for {client.display_name} ...")
+
+    remove_with_sudo(client.nginx_access_log)
+    remove_with_sudo(client.nginx_error_log)
+
+    if not instances:
         return
 
-    try:
-        shutil.rmtree(client_dir)
-    except OSError as e:
-        Logger.print_error(f"Unable to delete '{client_dir}':\n{e}")
+    for instance in instances:
+        run_remove_routines(
+            instance.base.log_dir.joinpath(client.nginx_access_log.name)
+        )
+        run_remove_routines(instance.base.log_dir.joinpath(client.nginx_error_log.name))

kiauh/components/webui_client/client_setup.py

@@ -6,7 +6,8 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
-
+import shutil
+import tempfile
 from pathlib import Path
 from typing import List
 
@@ -27,27 +28,24 @@ from components.webui_client.client_dialogs import (
     print_moonraker_not_found_dialog,
 )
 from components.webui_client.client_utils import (
-    backup_mainsail_config_json,
-    config_for_other_client_exist,
-    enable_mainsail_remotemode,
-    restore_mainsail_config_json,
-    symlink_webui_nginx_log,
-)
-from core.instance_manager.instance_manager import InstanceManager
-from core.settings.kiauh_settings import KiauhSettings
-from utils.common import check_install_dependencies
-from utils.config_utils import add_config_section
-from utils.fs_utils import (
     copy_common_vars_nginx_cfg,
     copy_upstream_nginx_cfg,
     create_nginx_cfg,
+    detect_client_cfg_conflict,
+    enable_mainsail_remotemode,
     get_next_free_port,
     is_valid_port,
     read_ports_from_nginx_configs,
-    unzip,
+    symlink_webui_nginx_log,
 )
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
+from core.settings.kiauh_settings import KiauhSettings
+from utils.common import check_install_dependencies
+from utils.config_utils import add_config_section
+from utils.fs_utils import unzip
 from utils.input_utils import get_confirm, get_number_input
-from utils.logger import Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
     cmd_sysctl_service,
     download_file,
@@ -65,16 +63,12 @@ def install_client(client: BaseWebClient) -> None:
         )
         return
 
-    mr_im = InstanceManager(Moonraker)
-    mr_instances: List[Moonraker] = mr_im.instances
+    mr_instances: List[Moonraker] = get_instances(Moonraker)
 
     enable_remotemode = False
     if not mr_instances:
         print_moonraker_not_found_dialog()
-        if not get_confirm(
-            f"Continue {client.display_name} installation?",
-            allow_go_back=True,
-        ):
+        if not get_confirm(f"Continue {client.display_name} installation?"):
             return
 
     # if moonraker is not installed or multiple instances
@@ -86,14 +80,13 @@ def install_client(client: BaseWebClient) -> None:
     ):
         enable_remotemode = True
 
-    kl_im = InstanceManager(Klipper)
-    kl_instances = kl_im.instances
+    kl_instances = get_instances(Klipper)
     install_client_cfg = False
     client_config: BaseWebClientConfig = client.client_config
     if (
         kl_instances
         and not client_config.config_dir.exists()
-        and not config_for_other_client_exist(client_to_ignore=client.client)
+        and not detect_client_cfg_conflict(client)
     ):
         print_install_client_config_dialog(client)
         question = f"Download the recommended {client_config.display_name}?"
@@ -115,7 +108,7 @@ def install_client(client: BaseWebClient) -> None:
         )
         valid_port = is_valid_port(port, ports_in_use)
 
-    check_install_dependencies(["nginx", "unzip"])
+    check_install_dependencies({"nginx"})
 
     try:
         download_client(client)
@@ -132,7 +125,7 @@ def install_client(client: BaseWebClient) -> None:
                     ("path", str(client.client_dir)),
                 ],
             )
-            mr_im.restart_all_instance()
+            InstanceManager.restart_all(mr_instances)
         if install_client_cfg and kl_instances:
             install_client_config(client)
 
@@ -148,7 +141,7 @@ def install_client(client: BaseWebClient) -> None:
         )
 
         if kl_instances:
-            symlink_webui_nginx_log(kl_instances)
+            symlink_webui_nginx_log(client, kl_instances)
         cmd_sysctl_service("nginx", "restart")
 
     except Exception as e:
@@ -188,10 +181,10 @@ def update_client(client: BaseWebClient) -> None:
         )
         return
 
-    if client.client == WebClientType.MAINSAIL:
-        backup_mainsail_config_json(is_temp=True)
-
-    download_client(client)
-
-    if client.client == WebClientType.MAINSAIL:
-        restore_mainsail_config_json()
+    with tempfile.NamedTemporaryFile(suffix=".json") as tmp_file:
+        Logger.print_status(
+            f"Creating temporary backup of {client.config_file} as {tmp_file.name} ..."
+        )
+        shutil.copy(client.config_file, tmp_file.name)
+        download_client(client)
+        shutil.copy(tmp_file.name, client.config_file)

kiauh/components/webui_client/client_utils.py

@@ -6,30 +6,45 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
-import json  # noqa: I001
+import json
+import re
 import shutil
 from pathlib import Path
+from subprocess import PIPE, CalledProcessError, run
 from typing import List, get_args
 
 from components.klipper.klipper import Klipper
+from components.webui_client import MODULE_PATH
 from components.webui_client.base_data import (
     BaseWebClient,
-    BaseWebClientConfig,
     WebClientType,
 )
+from components.webui_client.fluidd_data import FluiddData
 from components.webui_client.mainsail_data import MainsailData
 from core.backup_manager.backup_manager import BackupManager
+from core.constants import (
+    COLOR_CYAN,
+    COLOR_YELLOW,
+    NGINX_CONFD,
+    NGINX_SITES_AVAILABLE,
+    NGINX_SITES_ENABLED,
+    RESET_FORMAT,
+)
+from core.logger import Logger
 from core.settings.kiauh_settings import KiauhSettings
-from utils import NGINX_CONFD, NGINX_SITES_AVAILABLE
+from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+    SimpleConfigParser,
+)
+from core.types import ComponentStatus
 from utils.common import get_install_status
-from utils.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
+from utils.fs_utils import create_symlink, remove_file
 from utils.git_utils import (
-    get_latest_tag,
+    get_latest_remote_tag,
     get_latest_unstable_tag,
 )
-from utils.logger import Logger
-from utils.types import ComponentStatus, InstallStatus
+from utils.instance_utils import get_instances
 
 
 def get_client_status(
@@ -40,57 +55,62 @@ def get_client_status(
         NGINX_CONFD.joinpath("upstreams.conf"),
         NGINX_CONFD.joinpath("common_vars.conf"),
     ]
-    status = get_install_status(client.client_dir, files=files)
+    comp_status: ComponentStatus = get_install_status(client.client_dir, files=files)
 
     # if the client dir does not exist, set the status to not
     # installed even if the other files are present
     if not client.client_dir.exists():
-        status["status"] = InstallStatus.NOT_INSTALLED
+        comp_status.status = 0
 
-    status["local"] = get_local_client_version(client)
-    status["remote"] = get_remote_client_version(client) if fetch_remote else None
-    return status
+    comp_status.local = get_local_client_version(client)
+    comp_status.remote = get_remote_client_version(client) if fetch_remote else None
+    return comp_status
 
 
 def get_client_config_status(client: BaseWebClient) -> ComponentStatus:
     return get_install_status(client.client_config.config_dir)
 
 
-def get_current_client_config(clients: List[BaseWebClient]) -> str:
-    installed = []
-    for client in clients:
-        client_config = client.client_config
-        if client_config.config_dir.exists():
-            installed.append(client)
+def get_current_client_config() -> str:
+    mainsail, fluidd = MainsailData(), FluiddData()
+    clients: List[BaseWebClient] = [mainsail, fluidd]
+    installed = [c for c in clients if c.client_config.config_dir.exists()]
 
-    if len(installed) > 1:
-        return f"{COLOR_YELLOW}Conflict!{RESET_FORMAT}"
+    if not installed:
+        return f"{COLOR_CYAN}-{RESET_FORMAT}"
     elif len(installed) == 1:
         cfg = installed[0].client_config
         return f"{COLOR_CYAN}{cfg.display_name}{RESET_FORMAT}"
 
-    return f"{COLOR_CYAN}-{RESET_FORMAT}"
+    # at this point, both client config folders exists, so we need to check
+    # which are actually included in the printer.cfg of all klipper instances
+    mainsail_includes, fluidd_includes = [], []
+    klipper_instances: List[Klipper] = get_instances(Klipper)
+    for instance in klipper_instances:
+        scp = SimpleConfigParser()
+        scp.read_file(instance.cfg_file)
+        includes_mainsail = scp.has_section(mainsail.client_config.config_section)
+        includes_fluidd = scp.has_section(fluidd.client_config.config_section)
 
+        if includes_mainsail:
+            mainsail_includes.append(instance)
+        if includes_fluidd:
+            fluidd_includes.append(instance)
 
-def backup_mainsail_config_json(is_temp=False) -> None:
-    c_json = MainsailData().client_dir.joinpath("config.json")
-    Logger.print_status(f"Backup '{c_json}' ...")
-    bm = BackupManager()
-    if is_temp:
-        fn = Path.home().joinpath("config.json.kiauh.bak")
-        bm.backup_file(c_json, custom_filename=fn)
+        # if both are included in the same file, we have a potential conflict
+        if includes_mainsail and includes_fluidd:
+            return f"{COLOR_YELLOW}Conflict!{RESET_FORMAT}"
+
+    if not mainsail_includes and not fluidd_includes:
+        # there are no includes at all, even though the client config folders exist
+        return f"{COLOR_CYAN}-{RESET_FORMAT}"
+    elif len(fluidd_includes) > len(mainsail_includes):
+        # there are more instances that include fluidd than mainsail
+        return f"{COLOR_CYAN}{fluidd.client_config.display_name}{RESET_FORMAT}"
     else:
-        bm.backup_file(c_json)
-
-
-def restore_mainsail_config_json() -> None:
-    try:
-        c_json = MainsailData().client_dir.joinpath("config.json")
-        Logger.print_status(f"Restore '{c_json}' ...")
-        source = Path.home().joinpath("config.json.kiauh.bak")
-        shutil.copy(source, c_json)
-    except OSError:
-        Logger.print_info("Unable to restore config.json. Skipped ...")
+        # there are the same amount of non-conflicting includes for each config
+        # or more instances include mainsail than fluidd
+        return f"{COLOR_CYAN}{mainsail.client_config.display_name}{RESET_FORMAT}"
 
 
 def enable_mainsail_remotemode() -> None:
@@ -111,45 +131,47 @@ def enable_mainsail_remotemode() -> None:
     Logger.print_ok("Mainsails remote mode enabled!")
 
 
-def symlink_webui_nginx_log(klipper_instances: List[Klipper]) -> None:
+def symlink_webui_nginx_log(
+    client: BaseWebClient, klipper_instances: List[Klipper]
+) -> None:
     Logger.print_status("Link NGINX logs into log directory ...")
-    access_log = Path("/var/log/nginx/mainsail-access.log")
-    error_log = Path("/var/log/nginx/mainsail-error.log")
+    access_log = client.nginx_access_log
+    error_log = client.nginx_error_log
 
     for instance in klipper_instances:
-        desti_access = instance.log_dir.joinpath("mainsail-access.log")
+        desti_access = instance.base.log_dir.joinpath(access_log.name)
         if not desti_access.exists():
             desti_access.symlink_to(access_log)
 
-        desti_error = instance.log_dir.joinpath("mainsail-error.log")
+        desti_error = instance.base.log_dir.joinpath(error_log.name)
         if not desti_error.exists():
             desti_error.symlink_to(error_log)
 
 
-def get_local_client_version(client: BaseWebClient) -> str:
+def get_local_client_version(client: BaseWebClient) -> str | None:
     relinfo_file = client.client_dir.joinpath("release_info.json")
     version_file = client.client_dir.joinpath(".version")
 
     if not client.client_dir.exists():
-        return "-"
+        return None
     if not relinfo_file.is_file() and not version_file.is_file():
         return "n/a"
 
     if relinfo_file.is_file():
         with open(relinfo_file, "r") as f:
-            return json.load(f)["version"]
+            return str(json.load(f)["version"])
     else:
         with open(version_file, "r") as f:
             return f.readlines()[0]
 
 
-def get_remote_client_version(client: BaseWebClient) -> str:
+def get_remote_client_version(client: BaseWebClient) -> str | None:
     try:
-        if (tag := get_latest_tag(client.repo_path)) != "":
-            return tag
-        return "ERROR"
+        if (tag := get_latest_remote_tag(client.repo_path)) != "":
+            return str(tag)
+        return None
     except Exception:
-        return "ERROR"
+        return None
 
 
 def backup_client_data(client: BaseWebClient) -> None:
@@ -162,9 +184,7 @@ def backup_client_data(client: BaseWebClient) -> None:
 
     bm = BackupManager()
     bm.backup_directory(f"{name}-{version}", src, dest)
-    if name == "mainsail":
-        c_json = MainsailData().client_dir.joinpath("config.json")
-        bm.backup_file(c_json, dest)
+    bm.backup_file(client.config_file, dest)
     bm.backup_file(NGINX_SITES_AVAILABLE.joinpath(name), dest)
 
 
@@ -187,30 +207,24 @@ def get_existing_clients() -> List[BaseWebClient]:
     return installed_clients
 
 
-def get_existing_client_config() -> List[BaseWebClient]:
-    clients = list(get_args(WebClientType))
-    installed_client_configs: List[BaseWebClient] = []
-    for client in clients:
-        c_config_data: BaseWebClientConfig = client.client_config
-        if c_config_data.config_dir.exists():
-            installed_client_configs.append(client)
-
-    return installed_client_configs
-
-
-def config_for_other_client_exist(client_to_ignore: WebClientType) -> bool:
+def detect_client_cfg_conflict(curr_client: BaseWebClient) -> bool:
     """
     Check if any other client configs are present on the system.
     It is usually not harmful, but chances are they can conflict each other.
     Multiple client configs are, at least, redundant to have them installed
-    :param client_to_ignore: The client name to ignore for the check
+    :param curr_client: The client name to check for the conflict
     :return: True, if other client configs were found, else False
     """
 
-    clients = set([c.name for c in get_existing_client_config()])
-    clients = clients - {client_to_ignore.value}
+    mainsail_cfg_status: ComponentStatus = get_client_config_status(MainsailData())
+    fluidd_cfg_status: ComponentStatus = get_client_config_status(FluiddData())
 
-    return True if len(clients) > 0 else False
+    if curr_client.client == WebClientType.MAINSAIL and fluidd_cfg_status.status == 2:
+        return True
+    if curr_client.client == WebClientType.FLUIDD and mainsail_cfg_status.status == 2:
+        return True
+
+    return False
 
 
 def get_download_url(base_url: str, client: BaseWebClient) -> str:
@@ -228,3 +242,132 @@ def get_download_url(base_url: str, client: BaseWebClient) -> str:
         return f"{base_url}/download/{unstable_tag}/{client.name}.zip"
     except Exception:
         return stable_url
+
+
+#################################################
+## NGINX RELATED FUNCTIONS
+#################################################
+
+
+def copy_upstream_nginx_cfg() -> None:
+    """
+    Creates an upstream.conf in /etc/nginx/conf.d
+    :return: None
+    """
+    source = MODULE_PATH.joinpath("assets/upstreams.conf")
+    target = NGINX_CONFD.joinpath("upstreams.conf")
+    try:
+        command = ["sudo", "cp", source, target]
+        run(command, stderr=PIPE, check=True)
+    except CalledProcessError as e:
+        log = f"Unable to create upstreams.conf: {e.stderr.decode()}"
+        Logger.print_error(log)
+        raise
+
+
+def copy_common_vars_nginx_cfg() -> None:
+    """
+    Creates a common_vars.conf in /etc/nginx/conf.d
+    :return: None
+    """
+    source = MODULE_PATH.joinpath("assets/common_vars.conf")
+    target = NGINX_CONFD.joinpath("common_vars.conf")
+    try:
+        command = ["sudo", "cp", source, target]
+        run(command, stderr=PIPE, check=True)
+    except CalledProcessError as e:
+        log = f"Unable to create upstreams.conf: {e.stderr.decode()}"
+        Logger.print_error(log)
+        raise
+
+
+def generate_nginx_cfg_from_template(name: str, template_src: Path, **kwargs) -> None:
+    """
+    Creates an NGINX config from a template file and
+    replaces all placeholders passed as kwargs. A placeholder must be defined
+    in the template file as %{placeholder}%.
+    :param name: name of the config to create
+    :param template_src: the path to the template file
+    :return: None
+    """
+    tmp = Path.home().joinpath(f"{name}.tmp")
+    shutil.copy(template_src, tmp)
+    with open(tmp, "r+") as f:
+        content = f.read()
+
+        for key, value in kwargs.items():
+            content = content.replace(f"%{key}%", str(value))
+
+        f.seek(0)
+        f.write(content)
+        f.truncate()
+
+    target = NGINX_SITES_AVAILABLE.joinpath(name)
+    try:
+        command = ["sudo", "mv", tmp, target]
+        run(command, stderr=PIPE, check=True)
+    except CalledProcessError as e:
+        log = f"Unable to create '{target}': {e.stderr.decode()}"
+        Logger.print_error(log)
+        raise
+
+
+def create_nginx_cfg(
+    display_name: str,
+    cfg_name: str,
+    template_src: Path,
+    **kwargs,
+) -> None:
+    from utils.sys_utils import set_nginx_permissions
+
+    try:
+        Logger.print_status(f"Creating NGINX config for {display_name} ...")
+
+        source = NGINX_SITES_AVAILABLE.joinpath(cfg_name)
+        target = NGINX_SITES_ENABLED.joinpath(cfg_name)
+        remove_file(Path("/etc/nginx/sites-enabled/default"), True)
+        generate_nginx_cfg_from_template(cfg_name, template_src=template_src, **kwargs)
+        create_symlink(source, target, True)
+        set_nginx_permissions()
+
+        Logger.print_ok(f"NGINX config for {display_name} successfully created.")
+    except Exception:
+        Logger.print_error(f"Creating NGINX config for {display_name} failed!")
+        raise
+
+
+def read_ports_from_nginx_configs() -> List[int]:
+    """
+    Helper function to iterate over all NGINX configs and read all ports defined for listen
+    :return: A sorted list of listen ports
+    """
+    if not NGINX_SITES_ENABLED.exists():
+        return []
+
+    port_list = []
+    for config in NGINX_SITES_ENABLED.iterdir():
+        if not config.is_file():
+            continue
+
+        with open(config, "r") as cfg:
+            lines = cfg.readlines()
+
+        for line in lines:
+            line = line.replace("default_server", "")
+            line = re.sub(r"[;:\[\]]", "", line.strip())
+            if line.startswith("listen") and line.split()[-1] not in port_list:
+                port_list.append(line.split()[-1])
+
+    ports_to_ints_list = [int(port) for port in port_list]
+    return sorted(ports_to_ints_list, key=lambda x: int(x))
+
+
+def is_valid_port(port: int, ports_in_use: List[int]) -> bool:
+    return port not in ports_in_use
+
+
+def get_next_free_port(ports_in_use: List[int]) -> int:
+    valid_ports = set(range(80, 7125))
+    used_ports = set(map(int, ports_in_use))
+
+    return min(valid_ports - used_ports)

kiauh/components/webui_client/fluidd_data.py

@@ -18,11 +18,10 @@ from components.webui_client.base_data import (
     WebClientConfigType,
     WebClientType,
 )
-from components.webui_client.client_utils import get_download_url
 from core.backup_manager import BACKUP_ROOT_DIR
 
 
-@dataclass(frozen=True)
+@dataclass()
 class FluiddConfigWeb(BaseWebClientConfig):
     client_config: WebClientConfigType = WebClientConfigType.FLUIDD
     name: str = client_config.value
@@ -34,7 +33,7 @@ class FluiddConfigWeb(BaseWebClientConfig):
     repo_url: str = "https://github.com/fluidd-core/fluidd-config.git"
 
 
-@dataclass(frozen=True)
+@dataclass()
 class FluiddData(BaseWebClient):
     BASE_DL_URL = "https://github.com/fluidd-core/fluidd/releases"
 
@@ -42,13 +41,16 @@ class FluiddData(BaseWebClient):
     name: str = client.value
     display_name: str = name.capitalize()
     client_dir: Path = Path.home().joinpath("fluidd")
+    config_file: Path = client_dir.joinpath("config.json")
     backup_dir: Path = BACKUP_ROOT_DIR.joinpath("fluidd-backups")
     repo_path: str = "fluidd-core/fluidd"
+    nginx_access_log: Path = Path("/var/log/nginx/fluidd-access.log")
+    nginx_error_log: Path = Path("/var/log/nginx/fluidd-error.log")
+    client_config: BaseWebClientConfig = None
+    download_url: str | None = None
 
-    @property
-    def download_url(self) -> str:
-        return get_download_url(self.BASE_DL_URL, self)
+    def __post_init__(self):
+        from components.webui_client.client_utils import get_download_url
 
-    @property
-    def client_config(self) -> BaseWebClientConfig:
-        return FluiddConfigWeb()
+        self.client_config = FluiddConfigWeb()
+        self.download_url = get_download_url(self.BASE_DL_URL, self)

kiauh/components/webui_client/mainsail_data.py

@@ -21,7 +21,7 @@ from components.webui_client.base_data import (
 from core.backup_manager import BACKUP_ROOT_DIR
 
 
-@dataclass(frozen=True)
+@dataclass()
 class MainsailConfigWeb(BaseWebClientConfig):
     client_config: WebClientConfigType = WebClientConfigType.MAINSAIL
     name: str = client_config.value
@@ -33,7 +33,7 @@ class MainsailConfigWeb(BaseWebClientConfig):
     repo_url: str = "https://github.com/mainsail-crew/mainsail-config.git"
 
 
-@dataclass(frozen=True)
+@dataclass()
 class MainsailData(BaseWebClient):
     BASE_DL_URL: str = "https://github.com/mainsail-crew/mainsail/releases"
 
@@ -41,15 +41,16 @@ class MainsailData(BaseWebClient):
     name: str = WebClientType.MAINSAIL.value
     display_name: str = name.capitalize()
     client_dir: Path = Path.home().joinpath("mainsail")
+    config_file: Path = client_dir.joinpath("config.json")
     backup_dir: Path = BACKUP_ROOT_DIR.joinpath("mainsail-backups")
     repo_path: str = "mainsail-crew/mainsail"
+    nginx_access_log: Path = Path("/var/log/nginx/mainsail-access.log")
+    nginx_error_log: Path = Path("/var/log/nginx/mainsail-error.log")
+    client_config: BaseWebClientConfig = None
+    download_url: str | None = None
 
-    @property
-    def download_url(self) -> str:
+    def __post_init__(self):
         from components.webui_client.client_utils import get_download_url
 
-        return get_download_url(self.BASE_DL_URL, self)
-
-    @property
-    def client_config(self) -> BaseWebClientConfig:
-        return MainsailConfigWeb()
+        self.client_config = MainsailConfigWeb()
+        self.download_url = get_download_url(self.BASE_DL_URL, self)

kiauh/components/webui_client/menus/client_remove_menu.py

@@ -6,45 +6,44 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
-from typing import Optional, Type
+from typing import Type
 
 from components.webui_client import client_remove
-from components.webui_client.base_data import BaseWebClient, WebClientType
+from components.webui_client.base_data import BaseWebClient
+from core.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
 
 
 # noinspection PyUnusedLocal
 class ClientRemoveMenu(BaseMenu):
     def __init__(
-        self, client: BaseWebClient, previous_menu: Optional[Type[BaseMenu]] = None
+        self, client: BaseWebClient, previous_menu: Type[BaseMenu] | None = None
     ):
         super().__init__()
-        self.previous_menu = previous_menu
-        self.client = client
-        self.rm_client = False
-        self.rm_client_config = False
-        self.backup_mainsail_config_json = False
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+        self.client: BaseWebClient = client
+        self.remove_client: bool = False
+        self.remove_client_cfg: bool = False
+        self.backup_config_json: bool = False
+        self.selection_state: bool = False
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.remove_menu import RemoveMenu
 
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else RemoveMenu
-        )
+        self.previous_menu = previous_menu if previous_menu is not None else RemoveMenu
 
     def set_options(self) -> None:
         self.options = {
-            "0": Option(method=self.toggle_all, menu=False),
-            "1": Option(method=self.toggle_rm_client, menu=False),
-            "2": Option(method=self.toggle_rm_client_config, menu=False),
-            "c": Option(method=self.run_removal_process, menu=False),
+            "a": Option(method=self.toggle_all),
+            "1": Option(method=self.toggle_rm_client),
+            "2": Option(method=self.toggle_rm_client_config),
+            "3": Option(method=self.toggle_backup_config_json),
+            "c": Option(method=self.run_removal_process),
         }
-        if self.client.client == WebClientType.MAINSAIL:
-            self.options["3"] = Option(self.toggle_backup_mainsail_config_json, False)
 
     def print_menu(self) -> None:
         client_name = self.client.display_name
@@ -56,8 +55,9 @@ class ClientRemoveMenu(BaseMenu):
         count = 62 - len(color) - len(RESET_FORMAT)
         checked = f"[{COLOR_CYAN}x{RESET_FORMAT}]"
         unchecked = "[ ]"
-        o1 = checked if self.rm_client else unchecked
-        o2 = checked if self.rm_client_config else unchecked
+        o1 = checked if self.remove_client else unchecked
+        o2 = checked if self.remove_client_cfg else unchecked
+        o3 = checked if self.backup_config_json else unchecked
         menu = textwrap.dedent(
             f"""
             ╔═══════════════════════════════════════════════════════╗
@@ -66,23 +66,11 @@ class ClientRemoveMenu(BaseMenu):
             ║ Enter a number and hit enter to select / deselect     ║
             ║ the specific option for removal.                      ║
             ╟───────────────────────────────────────────────────────╢
-            ║  0) Select everything                                 ║
+            ║  a) {self._get_selection_state_str():37}             ║
             ╟───────────────────────────────────────────────────────╢
             ║  1) {o1} Remove {client_name:16}                       ║
             ║  2) {o2} Remove {client_config_name:24}               ║
-            """
-        )[1:]
-
-        if self.client.client == WebClientType.MAINSAIL:
-            o3 = checked if self.backup_mainsail_config_json else unchecked
-            menu += textwrap.dedent(
-                f"""
-                ║  3) {o3} Backup config.json                            ║
-                """
-            )[1:]
-
-        menu += textwrap.dedent(
-            """
+            ║  3) {o3} Backup config.json                            ║
             ╟───────────────────────────────────────────────────────╢
             ║  C) Continue                                          ║
             ╟───────────────────────────────────────────────────────╢
@@ -91,24 +79,25 @@ class ClientRemoveMenu(BaseMenu):
         print(menu, end="")
 
     def toggle_all(self, **kwargs) -> None:
-        self.rm_client = True
-        self.rm_client_config = True
-        self.backup_mainsail_config_json = True
+        self.selection_state = not self.selection_state
+        self.remove_client = self.selection_state
+        self.remove_client_cfg = self.selection_state
+        self.backup_config_json = self.selection_state
 
     def toggle_rm_client(self, **kwargs) -> None:
-        self.rm_client = not self.rm_client
+        self.remove_client = not self.remove_client
 
     def toggle_rm_client_config(self, **kwargs) -> None:
-        self.rm_client_config = not self.rm_client_config
+        self.remove_client_cfg = not self.remove_client_cfg
 
-    def toggle_backup_mainsail_config_json(self, **kwargs) -> None:
-        self.backup_mainsail_config_json = not self.backup_mainsail_config_json
+    def toggle_backup_config_json(self, **kwargs) -> None:
+        self.backup_config_json = not self.backup_config_json
 
     def run_removal_process(self, **kwargs) -> None:
         if (
-            not self.rm_client
-            and not self.rm_client_config
-            and not self.backup_mainsail_config_json
+            not self.remove_client
+            and not self.remove_client_cfg
+            and not self.backup_config_json
         ):
             error = f"{COLOR_RED}Nothing selected ...{RESET_FORMAT}"
             print(error)
@@ -116,11 +105,22 @@ class ClientRemoveMenu(BaseMenu):
 
         client_remove.run_client_removal(
             client=self.client,
-            rm_client=self.rm_client,
-            rm_client_config=self.rm_client_config,
-            backup_ms_config_json=self.backup_mainsail_config_json,
+            remove_client=self.remove_client,
+            remove_client_cfg=self.remove_client_cfg,
+            backup_config=self.backup_config_json,
         )
 
-        self.rm_client = False
-        self.rm_client_config = False
-        self.backup_mainsail_config_json = False
+        self.remove_client = False
+        self.remove_client_cfg = False
+        self.backup_config_json = False
+
+        self._go_back()
+
+    def _get_selection_state_str(self) -> str:
+        return (
+            "Select everything" if not self.selection_state else "Deselect everything"
+        )
+
+    def _go_back(self, **kwargs) -> None:
+        if self.previous_menu is not None:
+            self.previous_menu().run()

kiauh/core/backup_manager/backup_manager.py

@@ -6,22 +6,27 @@
 #                                                                         #
 #  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
-from utils.logger import Logger
+
+
+class BackupManagerException(Exception):
+    pass
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class BackupManager:
     def __init__(self, backup_root_dir: Path = BACKUP_ROOT_DIR):
-        self._backup_root_dir = backup_root_dir
-        self._ignore_folders = None
+        self._backup_root_dir: Path = backup_root_dir
+        self._ignore_folders: List[str] = []
 
     @property
     def backup_root_dir(self) -> Path:
@@ -39,7 +44,7 @@ class BackupManager:
     def ignore_folders(self, value: List[str]):
         self._ignore_folders = value
 
-    def backup_file(self, file: Path, target: Path = None, custom_filename=None):
+    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():
@@ -62,7 +67,9 @@ class BackupManager:
         else:
             Logger.print_info(f"File '{file}' not found ...")
 
-    def backup_directory(self, name: str, source: Path, target: Path = None) -> None:
+    def backup_directory(
+        self, name: str, source: Path, target: Path | None = None
+    ) -> Path | None:
         Logger.print_status(f"Creating backup of {name} in {target} ...")
 
         if source is None or not Path(source).exists():
@@ -73,19 +80,19 @@ class BackupManager:
         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,
-            )
+            backup_target = target.joinpath(f"{name.lower()}-{date}-{time}")
+            shutil.copytree(source, backup_target, ignore=self.ignore_folders_func)
             Logger.print_ok("Backup successful!")
+
+            return backup_target
+
         except OSError as e:
             Logger.print_error(f"Unable to backup directory '{source}':\n{e}")
-            return
+            raise BackupManagerException(f"Unable to backup directory '{source}':\n{e}")
 
-    def ignore_folders_func(self, dirpath, filenames):
+    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 is not None
+            if self._ignore_folders
             else []
         )

kiauh/core/constants.py

@@ -11,6 +11,8 @@ 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
@@ -19,6 +21,19 @@ 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

@@ -6,12 +6,14 @@
 #                                                                         #
 #  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) -> Callable:
-    def decorator(func):
+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)

kiauh/core/instance_manager/base_instance.py

@@ -9,153 +9,50 @@
 
 from __future__ import annotations
 
-from abc import ABC, abstractmethod
+import re
+from dataclasses import dataclass, field
 from pathlib import Path
-from typing import List, Optional
+from typing import List
 
-from utils.constants import CURRENT_USER, SYSTEMD
+from utils.fs_utils import get_data_dir
+
+SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion"]
 
 
-class BaseInstance(ABC):
-    @classmethod
-    def blacklist(cls) -> List[str]:
-        return []
+@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 __init__(
-        self,
-        suffix: str,
-        instance_type: BaseInstance,
-    ):
-        self._instance_type = instance_type
-        self._suffix = suffix
-        self._user = CURRENT_USER
-        self._data_dir_name = self.get_data_dir_name_from_suffix()
-        self._data_dir = Path.home().joinpath(f"{self._data_dir_name}_data")
-        self._cfg_dir = self.data_dir.joinpath("config")
-        self._log_dir = self.data_dir.joinpath("logs")
-        self._comms_dir = self.data_dir.joinpath("comms")
-        self._sysd_dir = self.data_dir.joinpath("systemd")
-        self._gcodes_dir = self.data_dir.joinpath("gcodes")
-
-    @property
-    def instance_type(self) -> BaseInstance:
-        return self._instance_type
-
-    @instance_type.setter
-    def instance_type(self, value: BaseInstance) -> None:
-        self._instance_type = value
-
-    @property
-    def suffix(self) -> str:
-        return self._suffix
-
-    @suffix.setter
-    def suffix(self, value: str) -> None:
-        self._suffix = value
-
-    @property
-    def user(self) -> str:
-        return self._user
-
-    @user.setter
-    def user(self, value: str) -> None:
-        self._user = value
-
-    @property
-    def data_dir_name(self) -> str:
-        return self._data_dir_name
-
-    @data_dir_name.setter
-    def data_dir_name(self, value: str) -> None:
-        self._data_dir_name = value
-
-    @property
-    def data_dir(self) -> Path:
-        return self._data_dir
-
-    @data_dir.setter
-    def data_dir(self, value: Path) -> None:
-        self._data_dir = value
-
-    @property
-    def cfg_dir(self) -> Path:
-        return self._cfg_dir
-
-    @cfg_dir.setter
-    def cfg_dir(self, value: Path) -> None:
-        self._cfg_dir = value
-
-    @property
-    def log_dir(self) -> Path:
-        return self._log_dir
-
-    @log_dir.setter
-    def log_dir(self, value: Path) -> None:
-        self._log_dir = value
-
-    @property
-    def comms_dir(self) -> Path:
-        return self._comms_dir
-
-    @comms_dir.setter
-    def comms_dir(self, value: Path) -> None:
-        self._comms_dir = value
-
-    @property
-    def sysd_dir(self) -> Path:
-        return self._sysd_dir
-
-    @sysd_dir.setter
-    def sysd_dir(self, value: Path) -> None:
-        self._sysd_dir = value
-
-    @property
-    def gcodes_dir(self) -> Path:
-        return self._gcodes_dir
-
-    @gcodes_dir.setter
-    def gcodes_dir(self, value: Path) -> None:
-        self._gcodes_dir = value
-
-    @abstractmethod
-    def create(self) -> None:
-        raise NotImplementedError("Subclasses must implement the create method")
-
-    @abstractmethod
-    def delete(self) -> None:
-        raise NotImplementedError("Subclasses must implement the delete method")
-
-    def create_folders(self, add_dirs: Optional[List[Path]] = None) -> None:
-        dirs = [
+    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,
         ]
 
-        if add_dirs:
-            dirs.extend(add_dirs)
+    def _set_is_legacy_instance(self) -> bool:
+        legacy_pattern = r"^(?!printer)(.+)_data"
+        match = re.search(legacy_pattern, self.data_dir.name)
 
-        for _dir in dirs:
-            _dir.mkdir(exist_ok=True)
-
-    def get_service_file_name(self, extension: bool = False) -> str:
-        from utils.common import convert_camelcase_to_kebabcase
-
-        name = convert_camelcase_to_kebabcase(self.__class__.__name__)
-        if self.suffix != "":
-            name += f"-{self.suffix}"
-
-        return name if not extension else f"{name}.service"
-
-    def get_service_file_path(self) -> Path:
-        return SYSTEMD.joinpath(self.get_service_file_name(extension=True))
-
-    def get_data_dir_name_from_suffix(self) -> str:
-        if self._suffix == "":
-            return "printer"
-        elif self._suffix.isdigit():
-            return f"printer_{self._suffix}"
-        else:
-            return self._suffix
+        return True if (match and self.suffix != "") else False

kiauh/core/instance_manager/instance_manager.py

@@ -6,187 +6,103 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
-import re
-import subprocess
 from pathlib import Path
-from typing import List, Optional, TypeVar, Union
+from subprocess import CalledProcessError
+from typing import List
 
-from core.instance_manager.base_instance import BaseInstance
-from utils.constants import SYSTEMD
-from utils.logger import Logger
+from core.logger import Logger
+from utils.instance_type import InstanceType
 from utils.sys_utils import cmd_sysctl_service
 
-T = TypeVar(name="T", bound=BaseInstance, covariant=True)
 
-
-# noinspection PyMethodMayBeStatic
 class InstanceManager:
-    def __init__(self, instance_type: T) -> None:
-        self._instance_type = instance_type
-        self._current_instance: Optional[T] = None
-        self._instance_suffix: Optional[str] = None
-        self._instance_service: Optional[str] = None
-        self._instance_service_full: Optional[str] = None
-        self._instance_service_path: Optional[str] = None
-        self._instances: List[T] = []
-
-    @property
-    def instance_type(self) -> T:
-        return self._instance_type
-
-    @instance_type.setter
-    def instance_type(self, value: T):
-        self._instance_type = value
-
-    @property
-    def current_instance(self) -> T:
-        return self._current_instance
-
-    @current_instance.setter
-    def current_instance(self, value: T) -> None:
-        self._current_instance = value
-        self.instance_suffix = value.suffix
-        self.instance_service = value.get_service_file_name()
-        self.instance_service_path = value.get_service_file_path()
-
-    @property
-    def instance_suffix(self) -> str:
-        return self._instance_suffix
-
-    @instance_suffix.setter
-    def instance_suffix(self, value: str):
-        self._instance_suffix = value
-
-    @property
-    def instance_service(self) -> str:
-        return self._instance_service
-
-    @instance_service.setter
-    def instance_service(self, value: str):
-        self._instance_service = value
-
-    @property
-    def instance_service_full(self) -> str:
-        return f"{self._instance_service}.service"
-
-    @property
-    def instance_service_path(self) -> str:
-        return self._instance_service_path
-
-    @instance_service_path.setter
-    def instance_service_path(self, value: str):
-        self._instance_service_path = value
-
-    @property
-    def instances(self) -> List[T]:
-        return self.find_instances()
-
-    @instances.setter
-    def instances(self, value: List[T]):
-        self._instances = value
-
-    def create_instance(self) -> None:
-        if self.current_instance is not None:
-            try:
-                self.current_instance.create()
-            except (OSError, subprocess.CalledProcessError) as e:
-                Logger.print_error(f"Creating instance failed: {e}")
-                raise
-        else:
-            raise ValueError("current_instance cannot be None")
-
-    def delete_instance(self) -> None:
-        if self.current_instance is not None:
-            try:
-                self.current_instance.delete()
-            except (OSError, subprocess.CalledProcessError) as e:
-                Logger.print_error(f"Removing instance failed: {e}")
-                raise
-        else:
-            raise ValueError("current_instance cannot be None")
-
-    def enable_instance(self) -> None:
+    @staticmethod
+    def enable(instance: InstanceType) -> None:
+        service_name: str = instance.service_file_path.name
         try:
-            cmd_sysctl_service(self.instance_service_full, "enable")
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(f"Error enabling service {self.instance_service_full}:")
+            cmd_sysctl_service(service_name, "enable")
+        except CalledProcessError as e:
+            Logger.print_error(f"Error enabling service {service_name}:")
             Logger.print_error(f"{e}")
 
-    def disable_instance(self) -> None:
+    @staticmethod
+    def disable(instance: InstanceType) -> None:
+        service_name: str = instance.service_file_path.name
         try:
-            cmd_sysctl_service(self.instance_service_full, "disable")
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(f"Error disabling {self.instance_service_full}:")
-            Logger.print_error(f"{e}")
-
-    def start_instance(self) -> None:
-        try:
-            cmd_sysctl_service(self.instance_service_full, "start")
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(f"Error starting {self.instance_service_full}:")
-            Logger.print_error(f"{e}")
-
-    def restart_instance(self) -> None:
-        try:
-            cmd_sysctl_service(self.instance_service_full, "restart")
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(f"Error restarting {self.instance_service_full}:")
-            Logger.print_error(f"{e}")
-
-    def start_all_instance(self) -> None:
-        for instance in self.instances:
-            self.current_instance = instance
-            self.start_instance()
-
-    def restart_all_instance(self) -> None:
-        for instance in self.instances:
-            self.current_instance = instance
-            self.restart_instance()
-
-    def stop_instance(self) -> None:
-        try:
-            cmd_sysctl_service(self.instance_service_full, "stop")
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(f"Error stopping {self.instance_service_full}:")
-            Logger.print_error(f"{e}")
+            cmd_sysctl_service(service_name, "disable")
+        except CalledProcessError as e:
+            Logger.print_error(f"Error disabling {service_name}: {e}")
             raise
 
-    def stop_all_instance(self) -> None:
-        for instance in self.instances:
-            self.current_instance = instance
-            self.stop_instance()
+    @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
 
-    def find_instances(self) -> List[T]:
-        from utils.common import convert_camelcase_to_kebabcase
+    @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
 
-        name = convert_camelcase_to_kebabcase(self.instance_type.__name__)
-        pattern = re.compile(f"^{name}(-[0-9a-zA-Z]+)?.service$")
-        excluded = self.instance_type.blacklist()
+    @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
 
-        service_list = [
-            Path(SYSTEMD, service)
-            for service in SYSTEMD.iterdir()
-            if pattern.search(service.name)
-            and not any(s in service.name for s in excluded)
-        ]
+    @staticmethod
+    def start_all(instances: List[InstanceType]) -> None:
+        for instance in instances:
+            InstanceManager.start(instance)
 
-        instance_list = [
-            self.instance_type(suffix=self._get_instance_suffix(name, service))
-            for service in service_list
-        ]
+    @staticmethod
+    def stop_all(instances: List[InstanceType]) -> None:
+        for instance in instances:
+            InstanceManager.stop(instance)
 
-        return sorted(instance_list, key=lambda x: self._sort_instance_list(x.suffix))
+    @staticmethod
+    def restart_all(instances: List[InstanceType]) -> None:
+        for instance in instances:
+            InstanceManager.restart(instance)
 
-    def _get_instance_suffix(self, name: str, file_path: Path) -> str:
-        # to get the suffix of the instance, we remove the name of the instance from
-        # the file name, if the remaining part an empty string we return it
-        # otherwise there is and hyphen left, and we return the part after the hyphen
-        suffix = file_path.stem[len(name) :]
-        return suffix[1:] if suffix else ""
+    @staticmethod
+    def remove(instance: InstanceType) -> None:
+        from utils.fs_utils import run_remove_routines
+        from utils.sys_utils import remove_system_service
 
-    def _sort_instance_list(self, s: Union[int, str, None]):
-        if s is None:
-            return
+        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)
 
-        return int(s) if s.isdigit() else s
+            # 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_manager/name_scheme.py

@@ -1,8 +0,0 @@
-from enum import Enum, unique
-
-
-@unique
-class NameScheme(Enum):
-    SINGLE = "SINGLE"
-    INDEX = "INDEX"
-    CUSTOM = "CUSTOM"

kiauh/core/logger.py

@@ -6,11 +6,13 @@
 #                                                                         #
 #  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 utils.constants import (
+from core.constants import (
     COLOR_CYAN,
     COLOR_GREEN,
     COLOR_MAGENTA,
@@ -44,17 +46,17 @@ LINE_WIDTH = 53
 
 class Logger:
     @staticmethod
-    def info(msg):
+    def info(msg) -> None:
         # log to kiauh.log
         pass
 
     @staticmethod
-    def warn(msg):
+    def warn(msg) -> None:
         # log to kiauh.log
         pass
 
     @staticmethod
-    def error(msg):
+    def error(msg) -> None:
         # log to kiauh.log
         pass
 
@@ -64,7 +66,7 @@ class Logger:
         print(f"{COLOR_WHITE}{start}{message}{RESET_FORMAT}", end=end)
 
     @staticmethod
-    def print_ok(msg, prefix=True, start="", end="\n") -> None:
+    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)
 
@@ -88,10 +90,25 @@ class Logger:
         title: DialogType,
         content: List[str],
         center_content: bool = False,
-        custom_title: str = None,
-        custom_color: DialogCustomColor = None,
-        end: str = "\n",
+        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)
@@ -99,43 +116,44 @@ class Logger:
         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=end,
+            end="",
         )
+        print("\n" * margin_bottom)
 
     @staticmethod
-    def _get_dialog_title(title: DialogType, custom_title: str = None) -> str:
+    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
+        title: DialogType, custom_color: DialogCustomColor | None = None
     ) -> str:
         if title == DialogType.CUSTOM and custom_color:
             return str(custom_color.value)
-        return title.value[1] if title.value[1] else DialogCustomColor.WHITE.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 textwrap.dedent(
-            f"""
-            {color}┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
-            """
-        )[1:-1]
+        return f"{color}┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓"
 
     @staticmethod
     def _format_bottom_border() -> str:
-        return textwrap.dedent(
-            f"""
-            ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
-            {RESET_FORMAT}"""
+        return (
+            f"\n┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛{RESET_FORMAT}"
         )
 
     @staticmethod
-    def _format_dialog_title(title: str) -> str:
+    def _format_dialog_title(title: str | None) -> str:
         if title is not None:
             return textwrap.dedent(f"""
                 ┃ {title:^{LINE_WIDTH}} ┃

kiauh/core/menus/__init__.py

@@ -6,10 +6,11 @@
 #                                                                         #
 #  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, Union
+from typing import Any, Callable, Type
 
 
 @dataclass
@@ -17,13 +18,14 @@ class Option:
     """
     Represents a menu option.
     :param method: Method that will be used to call the menu option
-    :param menu: Flag for singaling that another menu will be opened
     :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: Union[Callable, None] = None
-    menu: bool = False
+    def __repr__(self):
+        return f"Option(method={self.method.__name__}, opt_index={self.opt_index}, opt_data={self.opt_data})"
+
+    method: Type[Callable]
     opt_index: str = ""
     opt_data: Any = None
 

kiauh/core/menus/advanced_menu.py

@@ -6,9 +6,10 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
-from typing import Optional, Type
+from typing import Type
 
 from components.klipper import KLIPPER_DIR
 from components.klipper.klipper import Klipper
@@ -21,37 +22,37 @@ from components.klipper_firmware.menus.klipper_flash_menu import (
 )
 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 utils.constants import COLOR_YELLOW, RESET_FORMAT
+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: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
 
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else MainMenu
-        )
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
 
-    def set_options(self):
+    def set_options(self) -> None:
         self.options = {
-            "1": Option(method=self.build, menu=True),
-            "2": Option(method=self.flash, menu=False),
-            "3": Option(method=self.build_flash, menu=False),
-            "4": Option(method=self.get_id, menu=False),
-            "5": Option(method=self.klipper_rollback, menu=True),
-            "6": Option(method=self.moonraker_rollback, menu=True),
+            "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):
+    def print_menu(self) -> None:
         header = " [ Advanced Menu ] "
         color = COLOR_YELLOW
         count = 62 - len(color) - len(RESET_FORMAT)
@@ -64,30 +65,34 @@ class AdvancedMenu(BaseMenu):
             ║  1) [Build]               │  5) [Klipper]             ║
             ║  2) [Flash]               │  6) [Moonraker]           ║
             ║  3) [Build + Flash]       │                           ║
-            ║  4) [Get MCU ID]          │                           ║
+            ║  4) [Get MCU ID]          │ System:                   ║
+            ║                           │  7) [Change hostname]     ║
             ╟───────────────────────────┴───────────────────────────╢
             """
         )[1:]
         print(menu, end="")
 
-    def klipper_rollback(self, **kwargs):
+    def klipper_rollback(self, **kwargs) -> None:
         rollback_repository(KLIPPER_DIR, Klipper)
 
-    def moonraker_rollback(self, **kwargs):
+    def moonraker_rollback(self, **kwargs) -> None:
         rollback_repository(MOONRAKER_DIR, Moonraker)
 
-    def build(self, **kwargs):
+    def build(self, **kwargs) -> None:
         KlipperBuildFirmwareMenu(previous_menu=self.__class__).run()
 
-    def flash(self, **kwargs):
+    def flash(self, **kwargs) -> None:
         KlipperFlashMethodMenu(previous_menu=self.__class__).run()
 
-    def build_flash(self, **kwargs):
+    def build_flash(self, **kwargs) -> None:
         KlipperBuildFirmwareMenu(previous_menu=KlipperFlashMethodMenu).run()
         KlipperFlashMethodMenu(previous_menu=self.__class__).run()
 
-    def get_id(self, **kwargs):
+    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

@@ -6,9 +6,10 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
-from typing import Optional, Type
+from typing import Type
 
 from components.klipper.klipper_utils import backup_klipper_dir
 from components.klipperscreen.klipperscreen import backup_klipperscreen_dir
@@ -22,40 +23,38 @@ from components.webui_client.client_utils import (
 )
 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
-from utils.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class BackupMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
 
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else 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, menu=False),
-            "2": Option(method=self.backup_moonraker, menu=False),
-            "3": Option(method=self.backup_printer_config, menu=False),
-            "4": Option(method=self.backup_moonraker_db, menu=False),
-            "5": Option(method=self.backup_mainsail, menu=False),
-            "6": Option(method=self.backup_fluidd, menu=False),
-            "7": Option(method=self.backup_mainsail_config, menu=False),
-            "8": Option(method=self.backup_fluidd_config, menu=False),
-            "9": Option(method=self.backup_klipperscreen, menu=False),
+            "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):
+    def print_menu(self) -> None:
         header = " [ Backup Menu ] "
         line1 = f"{COLOR_YELLOW}INFO: Backups are located in '~/kiauh-backups'{RESET_FORMAT}"
         color = COLOR_CYAN
@@ -81,29 +80,29 @@ class BackupMenu(BaseMenu):
         )[1:]
         print(menu, end="")
 
-    def backup_klipper(self, **kwargs):
+    def backup_klipper(self, **kwargs) -> None:
         backup_klipper_dir()
 
-    def backup_moonraker(self, **kwargs):
+    def backup_moonraker(self, **kwargs) -> None:
         backup_moonraker_dir()
 
-    def backup_printer_config(self, **kwargs):
+    def backup_printer_config(self, **kwargs) -> None:
         backup_printer_config_dir()
 
-    def backup_moonraker_db(self, **kwargs):
+    def backup_moonraker_db(self, **kwargs) -> None:
         backup_moonraker_db_dir()
 
-    def backup_mainsail(self, **kwargs):
+    def backup_mainsail(self, **kwargs) -> None:
         backup_client_data(MainsailData())
 
-    def backup_fluidd(self, **kwargs):
+    def backup_fluidd(self, **kwargs) -> None:
         backup_client_data(FluiddData())
 
-    def backup_mainsail_config(self, **kwargs):
+    def backup_mainsail_config(self, **kwargs) -> None:
         backup_client_config_data(MainsailData())
 
-    def backup_fluidd_config(self, **kwargs):
+    def backup_fluidd_config(self, **kwargs) -> None:
         backup_client_config_data(FluiddData())
 
-    def backup_klipperscreen(self, **kwargs):
+    def backup_klipperscreen(self, **kwargs) -> None:
         backup_klipperscreen_dir()

kiauh/core/menus/base_menu.py

@@ -14,24 +14,25 @@ import sys
 import textwrap
 import traceback
 from abc import abstractmethod
-from typing import Dict, Optional, Type
+from typing import Dict, Type
 
-from core.menus import FooterType, Option
-from utils.constants import (
+from core.constants import (
     COLOR_CYAN,
     COLOR_GREEN,
     COLOR_RED,
     COLOR_YELLOW,
     RESET_FORMAT,
 )
-from utils.logger import Logger
+from core.logger import Logger
+from core.menus import FooterType, Option
+from utils.input_utils import get_selection_input
 
 
-def clear():
+def clear() -> None:
     subprocess.call("clear", shell=True)
 
 
-def print_header():
+def print_header() -> None:
     line1 = " [ KIAUH ] "
     line2 = "Klipper Installation And Update Helper"
     line3 = ""
@@ -49,7 +50,7 @@ def print_header():
     print(header, end="")
 
 
-def print_quit_footer():
+def print_quit_footer() -> None:
     text = "Q) Quit"
     color = COLOR_RED
     count = 62 - len(color) - len(RESET_FORMAT)
@@ -62,7 +63,7 @@ def print_quit_footer():
     print(footer, end="")
 
 
-def print_back_footer():
+def print_back_footer() -> None:
     text = "B) « Back"
     color = COLOR_GREEN
     count = 62 - len(color) - len(RESET_FORMAT)
@@ -75,7 +76,7 @@ def print_back_footer():
     print(footer, end="")
 
 
-def print_back_help_footer():
+def print_back_help_footer() -> None:
     text1 = "B) « Back"
     text2 = "H) Help [?]"
     color1 = COLOR_GREEN
@@ -90,7 +91,7 @@ def print_back_help_footer():
     print(footer, end="")
 
 
-def print_blank_footer():
+def print_blank_footer() -> None:
     print("╚═══════════════════════════════════════════════════════╝")
 
 
@@ -109,42 +110,46 @@ class BaseMenu(metaclass=PostInitCaller):
     default_option: Option = None
     input_label_txt: str = "Perform action"
     header: bool = False
-    previous_menu: Type[BaseMenu] = None
-    help_menu: Type[BaseMenu] = None
+    previous_menu: Type[BaseMenu] | None = None
+    help_menu: Type[BaseMenu] | None = None
     footer_type: FooterType = FooterType.BACK
 
-    def __init__(self, **kwargs):
+    def __init__(self, **kwargs) -> None:
         if type(self) is BaseMenu:
             raise NotImplementedError("BaseMenu cannot be instantiated directly.")
 
-    def __post_init__(self):
+    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, menu=False)
+            self.options["q"] = Option(method=self.__exit)
         if self.footer_type is FooterType.BACK:
-            self.options["b"] = Option(method=self.__go_back, menu=False)
+            self.options["b"] = Option(method=self.__go_back)
         if self.footer_type is FooterType.BACK_HELP:
-            self.options["b"] = Option(method=self.__go_back, menu=False)
-            self.options["h"] = Option(method=self.__go_to_help, menu=False)
+            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):
+    def __go_back(self, **kwargs) -> None:
+        if self.previous_menu is None:
+            return
         self.previous_menu().run()
 
-    def __go_to_help(self, **kwargs):
-        self.help_menu(previous_menu=self).run()
+    def __go_to_help(self, **kwargs) -> None:
+        if self.help_menu is None:
+            return
+        self.help_menu(previous_menu=self.__class__).run()
 
-    def __exit(self, **kwargs):
+    def __exit(self, **kwargs) -> None:
         Logger.print_ok("###### Happy printing!", False)
         sys.exit(0)
 
     @abstractmethod
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         raise NotImplementedError
 
     @abstractmethod
@@ -173,43 +178,20 @@ class BaseMenu(metaclass=PostInitCaller):
         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(None, False, "", 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)
+            option = get_selection_input(self.input_label_txt, self.options)
+            selected_option: Option = self.options.get(option)
+
+            selected_option.method(
+                opt_index=selected_option.opt_index,
+                opt_data=selected_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

@@ -6,52 +6,49 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
-from typing import Optional, Type
+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.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
-from utils.constants import COLOR_GREEN, RESET_FORMAT
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class InstallMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
 
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else 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, menu=False),
-            "2": Option(method=self.install_moonraker, menu=False),
-            "3": Option(method=self.install_mainsail, menu=False),
-            "4": Option(method=self.install_fluidd, menu=False),
-            "5": Option(method=self.install_mainsail_config, menu=False),
-            "6": Option(method=self.install_fluidd_config, menu=False),
-            "7": Option(method=self.install_klipperscreen, menu=False),
-            "8": Option(method=self.install_mobileraker, menu=False),
-            "9": Option(method=self.install_crowsnest, menu=False),
+            "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_crowsnest),
         }
 
-    def print_menu(self):
+    def print_menu(self) -> None:
         header = " [ Installation Menu ] "
         color = COLOR_GREEN
         count = 62 - len(color) - len(RESET_FORMAT)
@@ -63,43 +60,39 @@ class InstallMenu(BaseMenu):
             ║ Firmware & API:           │ Touchscreen GUI:          ║
             ║  1) [Klipper]             │  7) [KlipperScreen]       ║
             ║  2) [Moonraker]           │                           ║
-            ║                           │ Android / iOS:            ║
-            ║ Webinterface:             │  8) [Mobileraker]         ║
+            ║                           │ Webcam Streamer:          ║
+            ║ Webinterface:             │  8) [Crowsnest]           ║
             ║  3) [Mainsail]            │                           ║
-            ║  4) [Fluidd]              │ Webcam Streamer:          ║
-            ║                           │  9) [Crowsnest]           ║
+            ║  4) [Fluidd]              │                           ║
+            ║                           │                           ║
             ║ Client-Config:            │                           ║
             ║  5) [Mainsail-Config]     │                           ║
             ║  6) [Fluidd-Config]       │                           ║
-            ║                           │                           ║
             ╟───────────────────────────┴───────────────────────────╢
             """
         )[1:]
         print(menu, end="")
 
-    def install_klipper(self, **kwargs):
+    def install_klipper(self, **kwargs) -> None:
         klipper_setup.install_klipper()
 
-    def install_moonraker(self, **kwargs):
+    def install_moonraker(self, **kwargs) -> None:
         moonraker_setup.install_moonraker()
 
-    def install_mainsail(self, **kwargs):
+    def install_mainsail(self, **kwargs) -> None:
         client_setup.install_client(MainsailData())
 
-    def install_mainsail_config(self, **kwargs):
+    def install_mainsail_config(self, **kwargs) -> None:
         client_config_setup.install_client_config(MainsailData())
 
-    def install_fluidd(self, **kwargs):
+    def install_fluidd(self, **kwargs) -> None:
         client_setup.install_client(FluiddData())
 
-    def install_fluidd_config(self, **kwargs):
+    def install_fluidd_config(self, **kwargs) -> None:
         client_config_setup.install_client_config(FluiddData())
 
-    def install_klipperscreen(self, **kwargs):
+    def install_klipperscreen(self, **kwargs) -> None:
         install_klipperscreen()
 
-    def install_mobileraker(self, **kwargs):
-        install_mobileraker()
-
-    def install_crowsnest(self, **kwargs):
+    def install_crowsnest(self, **kwargs) -> None:
         install_crowsnest()

kiauh/core/menus/main_menu.py

@@ -6,15 +6,16 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
+
 import sys
 import textwrap
-from typing import Optional, Type
+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.webui_client.client_utils import (
     get_client_status,
@@ -22,6 +23,15 @@ from components.webui_client.client_utils import (
 )
 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
@@ -30,95 +40,94 @@ 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.constants import (
-    COLOR_CYAN,
-    COLOR_GREEN,
-    COLOR_MAGENTA,
-    COLOR_RED,
-    COLOR_YELLOW,
-    RESET_FORMAT,
-)
-from utils.logger import Logger
-from utils.types import ComponentStatus
+from utils.common import get_kiauh_version, trunc_string
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class MainMenu(BaseMenu):
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
 
-        self.header = True
-        self.footer_type = FooterType.QUIT
+        self.header: bool = True
+        self.footer_type: FooterType = FooterType.QUIT
 
-        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.init_status()
+        self.version = ""
+        self.kl_status, self.kl_owner, self.kl_repo = "", "", ""
+        self.mr_status, self.mr_owner, self.mr_repo = "", "", ""
+        self.ms_status, self.fl_status, self.ks_status = "", "", ""
+        self.cn_status, self.cc_status = "", ""
+        self._init_status()
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    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, menu=True),
-            "1": Option(method=self.install_menu, menu=True),
-            "2": Option(method=self.update_menu, menu=True),
-            "3": Option(method=self.remove_menu, menu=True),
-            "4": Option(method=self.advanced_menu, menu=True),
-            "5": Option(method=self.backup_menu, menu=True),
-            "e": Option(method=self.extension_menu, menu=True),
-            "s": Option(method=self.settings_menu, menu=True),
+            "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"]
+    def _init_status(self) -> None:
+        status_vars = ["kl", "mr", "ms", "fl", "ks", "cn"]
         for var in status_vars:
             setattr(
                 self,
                 f"{var}_status",
-                f"{COLOR_RED}Not installed!{RESET_FORMAT}",
+                f"{COLOR_RED}Not installed{RESET_FORMAT}",
             )
 
-    def fetch_status(self) -> None:
+    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.cc_status = get_current_client_config()
 
-    def _get_component_status(self, name: str, status_fn: callable, *args) -> None:
+    def _get_component_status(self, name: str, status_fn: Callable, *args) -> None:
         status_data: ComponentStatus = status_fn(*args)
-        code: int = status_data.get("status").value.code
-        status: str = status_data.get("status").value.txt
-        repo: str = status_data.get("repo")
-        instance_count: int = status_data.get("instances")
+        code: int = status_data.status
+        status: StatusText = StatusMap[code]
+        owner: str = trunc_string(status_data.owner, 23)
+        repo: str = trunc_string(status_data.repo, 23)
+        instance_count: int = status_data.instances
 
         count_txt: str = ""
-        if instance_count > 0 and code == 1:
+        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}_owner", f"{COLOR_CYAN}{owner}{RESET_FORMAT}")
         setattr(self, f"{name}_repo", f"{COLOR_CYAN}{repo}{RESET_FORMAT}")
 
     def _format_by_code(self, code: int, status: str, count: str) -> str:
-        if code == 1:
-            return f"{COLOR_GREEN}{status}{count}{RESET_FORMAT}"
+        color = COLOR_RED
+        if code == 0:
+            color = COLOR_RED
+        elif code == 1:
+            color = COLOR_YELLOW
         elif code == 2:
-            return f"{COLOR_RED}{status}{count}{RESET_FORMAT}"
+            color = COLOR_GREEN
 
-        return f"{COLOR_YELLOW}{status}{count}{RESET_FORMAT}"
+        return f"{color}{status}{count}{RESET_FORMAT}"
 
-    def print_menu(self):
-        self.fetch_status()
+    def print_menu(self) -> None:
+        self._fetch_status()
 
         header = " [ Main Menu ] "
-        footer1 = f"{COLOR_CYAN}KIAUH v6.0.0{RESET_FORMAT}"
+        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)
@@ -130,17 +139,18 @@ class MainMenu(BaseMenu):
             ║ {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}} ║
+            ║                  │     Owner: {self.kl_owner:<{pad1}} ║
+            ║  1) [Install]    │      Repo: {self.kl_repo:<{pad1}} ║
+            ║  2) [Update]     ├────────────────────────────────────╢
+            ║  3) [Remove]     │ Moonraker: {self.mr_status:<{pad1}} ║
+            ║  4) [Advanced]   │     Owner: {self.mr_owner:<{pad1}} ║
+            ║  5) [Backup]     │      Repo: {self.mr_repo:<{pad1}} ║
+            ║                  ├────────────────────────────────────╢
+            ║  S) [Settings]   │        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}} ║
+            ║ Community:       │   Client-Config: {self.cc_status:<{pad2}} ║
+            ║  E) [Extensions] │                                    ║
+            ║                  │   KlipperScreen: {self.ks_status:<{pad2}} ║
             ║                  │       Crowsnest: {self.cn_status:<{pad2}} ║
             ╟──────────────────┼────────────────────────────────────╢
             ║ {footer1:^25} │ {footer2:^43} ║
@@ -149,30 +159,30 @@ class MainMenu(BaseMenu):
         )[1:]
         print(menu, end="")
 
-    def exit(self, **kwargs):
+    def exit(self, **kwargs) -> None:
         Logger.print_ok("###### Happy printing!", False)
         sys.exit(0)
 
-    def log_upload_menu(self, **kwargs):
+    def log_upload_menu(self, **kwargs) -> None:
         LogUploadMenu().run()
 
-    def install_menu(self, **kwargs):
+    def install_menu(self, **kwargs) -> None:
         InstallMenu(previous_menu=self.__class__).run()
 
-    def update_menu(self, **kwargs):
+    def update_menu(self, **kwargs) -> None:
         UpdateMenu(previous_menu=self.__class__).run()
 
-    def remove_menu(self, **kwargs):
+    def remove_menu(self, **kwargs) -> None:
         RemoveMenu(previous_menu=self.__class__).run()
 
-    def advanced_menu(self, **kwargs):
+    def advanced_menu(self, **kwargs) -> None:
         AdvancedMenu(previous_menu=self.__class__).run()
 
-    def backup_menu(self, **kwargs):
+    def backup_menu(self, **kwargs) -> None:
         BackupMenu(previous_menu=self.__class__).run()
 
-    def settings_menu(self, **kwargs):
+    def settings_menu(self, **kwargs) -> None:
         SettingsMenu(previous_menu=self.__class__).run()
 
-    def extension_menu(self, **kwargs):
+    def extension_menu(self, **kwargs) -> None:
         ExtensionsMenu(previous_menu=self.__class__).run()

kiauh/core/menus/remove_menu.py

@@ -6,51 +6,48 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
-from typing import Optional, Type
+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.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
-from utils.constants import COLOR_RED, RESET_FORMAT
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class RemoveMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
 
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else MainMenu
-        )
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
 
-    def set_options(self):
+    def set_options(self) -> None:
         self.options = {
-            "1": Option(method=self.remove_klipper, menu=True),
-            "2": Option(method=self.remove_moonraker, menu=True),
-            "3": Option(method=self.remove_mainsail, menu=True),
-            "4": Option(method=self.remove_fluidd, menu=True),
-            "5": Option(method=self.remove_klipperscreen, menu=True),
-            "6": Option(method=self.remove_mobileraker, menu=True),
-            "7": Option(method=self.remove_crowsnest, menu=True),
+            "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_crowsnest),
         }
 
-    def print_menu(self):
+    def print_menu(self) -> None:
         header = " [ Remove Menu ] "
         color = COLOR_RED
         count = 62 - len(color) - len(RESET_FORMAT)
@@ -64,33 +61,29 @@ class RemoveMenu(BaseMenu):
             ║ Firmware & API:           │ Touchscreen GUI:          ║
             ║  1) [Klipper]             │  5) [KlipperScreen]       ║
             ║  2) [Moonraker]           │                           ║
-            ║                           │ Android / iOS:            ║
-            ║ Klipper Webinterface:     │  6) [Mobileraker]         ║
+            ║                           │ Webcam Streamer:          ║
+            ║ Klipper Webinterface:     │  6) [Crowsnest]           ║
             ║  3) [Mainsail]            │                           ║
-            ║  4) [Fluidd]              │ Webcam Streamer:          ║
-            ║                           │  7) [Crowsnest]           ║
+            ║  4) [Fluidd]              │                           ║
             ╟───────────────────────────┴───────────────────────────╢
             """
         )[1:]
         print(menu, end="")
 
-    def remove_klipper(self, **kwargs):
+    def remove_klipper(self, **kwargs) -> None:
         KlipperRemoveMenu(previous_menu=self.__class__).run()
 
-    def remove_moonraker(self, **kwargs):
+    def remove_moonraker(self, **kwargs) -> None:
         MoonrakerRemoveMenu(previous_menu=self.__class__).run()
 
-    def remove_mainsail(self, **kwargs):
+    def remove_mainsail(self, **kwargs) -> None:
         ClientRemoveMenu(previous_menu=self.__class__, client=MainsailData()).run()
 
-    def remove_fluidd(self, **kwargs):
+    def remove_fluidd(self, **kwargs) -> None:
         ClientRemoveMenu(previous_menu=self.__class__, client=FluiddData()).run()
 
-    def remove_klipperscreen(self, **kwargs):
+    def remove_klipperscreen(self, **kwargs) -> None:
         remove_klipperscreen()
 
-    def remove_mobileraker(self, **kwargs):
-        remove_mobileraker()
-
-    def remove_crowsnest(self, **kwargs):
+    def remove_crowsnest(self, **kwargs) -> None:
         remove_crowsnest()

kiauh/core/menus/settings_menu.py

@@ -6,55 +6,48 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
-import shutil
-import textwrap
-from pathlib import Path
-from typing import Optional, Tuple, Type
+from __future__ import annotations
 
-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.instance_manager.instance_manager import InstanceManager
+import textwrap
+from typing import Literal, Tuple, Type
+
+from core.constants import COLOR_CYAN, COLOR_GREEN, RESET_FORMAT
+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.constants import COLOR_CYAN, COLOR_GREEN, RESET_FORMAT
-from utils.git_utils import git_clone_wrapper
+from core.settings.kiauh_settings import KiauhSettings, RepoSettings
+from procedures.switch_repo import run_switch_repo_routine
 from utils.input_utils import get_confirm, get_string_input
-from utils.logger import DialogType, Logger
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class SettingsMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
         super().__init__()
-        self.previous_menu = previous_menu
-        self.klipper_repo = None
-        self.moonraker_repo = None
-        self.mainsail_unstable = None
-        self.fluidd_unstable = None
-        self.auto_backups_enabled = None
+        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: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
 
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else 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, menu=True),
-            "2": Option(method=self.set_moonraker_repo, menu=True),
-            "3": Option(method=self.toggle_mainsail_release, menu=True),
-            "4": Option(method=self.toggle_fluidd_release, menu=False),
-            "5": Option(method=self.toggle_backup_before_update, menu=False),
+            "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):
+    def print_menu(self) -> None:
         header = " [ KIAUH Settings ] "
         color = COLOR_CYAN
         count = 62 - len(color) - len(RESET_FORMAT)
@@ -94,7 +87,7 @@ class SettingsMenu(BaseMenu):
         )[1:]
         print(menu, end="")
 
-    def _load_settings(self):
+    def _load_settings(self) -> None:
         self.settings = KiauhSettings()
 
         self._format_repo_str("klipper")
@@ -104,22 +97,28 @@ class SettingsMenu(BaseMenu):
         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 _format_repo_str(self, repo_name: Literal["klipper", "moonraker"]) -> None:
+        repo: RepoSettings = self.settings[repo_name]
+        repo_str = f"{'/'.join(repo.repo_url.rsplit('/', 2)[-2:])}"
+        branch_str = f"({COLOR_CYAN}@ {repo.branch}{RESET_FORMAT})"
+
+        setattr(
+            self,
+            f"{repo_name}_repo",
+            f"{COLOR_CYAN}{repo_str}{RESET_FORMAT} {branch_str}",
+        )
 
     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!"
+                "There is no input validation in place! Make sure your the input is "
+                "valid and has no typos or invalid characters! For the change to take "
+                "effect, the new repository will be cloned. A backup of the old "
+                "repository will be created.",
+                "\n\n",
+                "Make sure you don't have any ongoing prints running, as the services "
+                "will be restarted during this process! You will loose any ongoing print!",
             ],
         )
         repo = get_string_input(
@@ -133,7 +132,7 @@ class SettingsMenu(BaseMenu):
 
         return repo, branch
 
-    def _set_repo(self, repo_name: str):
+    def _set_repo(self, repo_name: Literal["klipper", "moonraker"]) -> None:
         repo_url, branch = self._gather_input()
         display_name = repo_name.capitalize()
         Logger.print_dialog(
@@ -144,14 +143,16 @@ class SettingsMenu(BaseMenu):
                 f"New {display_name} repository branch:",
                 f"● {branch}",
             ],
-            end="",
         )
 
         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)
+            repo: RepoSettings = self.settings[repo_name]
+            repo.repo_url = repo_url
+            repo.branch = branch
+
             self.settings.save()
             self._load_settings()
+
             Logger.print_ok("Changes saved!")
         else:
             Logger.print_info(
@@ -161,49 +162,28 @@ class SettingsMenu(BaseMenu):
 
         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
+    def _switch_repo(self, name: Literal["klipper", "moonraker"]) -> None:
+        repo: RepoSettings = self.settings[name]
+        run_switch_repo_routine(name, repo)
 
-        if target_dir.exists():
-            shutil.rmtree(target_dir)
-
-        im = InstanceManager(_type)
-        im.stop_all_instance()
-
-        repo = self.settings.get(name, "repo_url")
-        branch = self.settings.get(name, "branch")
-        git_clone_wrapper(repo, target_dir, branch)
-
-        im.start_all_instance()
-
-    def set_klipper_repo(self, **kwargs):
+    def set_klipper_repo(self, **kwargs) -> None:
         self._set_repo("klipper")
 
-    def set_moonraker_repo(self, **kwargs):
+    def set_moonraker_repo(self, **kwargs) -> None:
         self._set_repo("moonraker")
 
-    def toggle_mainsail_release(self, **kwargs):
+    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):
+    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):
+    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

@@ -6,9 +6,10 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
-from typing import Optional, Type
+from typing import Callable, List, Type
 
 from components.crowsnest.crowsnest import get_crowsnest_status, update_crowsnest
 from components.klipper.klipper_setup import update_klipper
@@ -19,10 +20,6 @@ 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.webui_client.client_config.client_config_setup import (
@@ -35,153 +32,305 @@ from components.webui_client.client_utils import (
 )
 from components.webui_client.fluidd_data import FluiddData
 from components.webui_client.mainsail_data import MainsailData
-from core.menus import Option
-from core.menus.base_menu import BaseMenu
-from utils.constants import (
+from core.constants import (
     COLOR_GREEN,
     COLOR_RED,
     COLOR_YELLOW,
     RESET_FORMAT,
 )
-from utils.types import ComponentStatus
+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: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
 
-        self.kl_local = self.kl_remote = self.mr_local = self.mr_remote = ""
-        self.ms_local = self.ms_remote = self.fl_local = self.fl_remote = ""
-        self.mc_local = self.mc_remote = self.fc_local = self.fc_remote = ""
-        self.ks_local = self.ks_remote = self.mb_local = self.mb_remote = ""
-        self.cn_local = self.cn_remote = ""
+        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.crowsnest_local = self.crowsnest_remote = ""
 
         self.mainsail_data = MainsailData()
         self.fluidd_data = FluiddData()
-        self._fetch_update_status()
+        self.status_data = {
+            "klipper": {
+                "display_name": "Klipper",
+                "installed": False,
+                "local": None,
+                "remote": None,
+            },
+            "moonraker": {
+                "display_name": "Moonraker",
+                "installed": False,
+                "local": None,
+                "remote": None,
+            },
+            "mainsail": {
+                "display_name": "Mainsail",
+                "installed": False,
+                "local": None,
+                "remote": None,
+            },
+            "mainsail_config": {
+                "display_name": "Mainsail-Config",
+                "installed": False,
+                "local": None,
+                "remote": None,
+            },
+            "fluidd": {
+                "display_name": "Fluidd",
+                "installed": False,
+                "local": None,
+                "remote": None,
+            },
+            "fluidd_config": {
+                "display_name": "Fluidd-Config",
+                "installed": False,
+                "local": None,
+                "remote": None,
+            },
+            "klipperscreen": {
+                "display_name": "KlipperScreen",
+                "installed": False,
+                "local": None,
+                "remote": None,
+            },
+            "crowsnest": {
+                "display_name": "Crowsnest",
+                "installed": False,
+                "local": None,
+                "remote": None,
+            },
+        }
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
 
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else MainMenu
-        )
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
 
     def set_options(self) -> None:
         self.options = {
-            "0": Option(self.update_all, menu=False),
-            "1": Option(self.update_klipper, menu=False),
-            "2": Option(self.update_moonraker, menu=False),
-            "3": Option(self.update_mainsail, menu=False),
-            "4": Option(self.update_fluidd, menu=False),
-            "5": Option(self.update_mainsail_config, menu=False),
-            "6": Option(self.update_fluidd_config, menu=False),
-            "7": Option(self.update_klipperscreen, menu=False),
-            "8": Option(self.update_mobileraker, menu=False),
-            "9": Option(self.update_crowsnest, menu=False),
-            "10": Option(self.upgrade_system_packages, menu=False),
+            "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_crowsnest),
+            "9": Option(self.upgrade_system_packages),
         }
 
-    def print_menu(self):
+    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} ║
             ╟───────────────────────┬───────────────┬───────────────╢
-            ║  0) Update all        │               │               ║
+            ║  a) Update all        │               │               ║
             ║                       │ Current:      │ Latest:       ║
             ║ Klipper & API:        ├───────────────┼───────────────╢
-            ║  1) Klipper           │ {self.kl_local:<22} │ {self.kl_remote:<22} ║
-            ║  2) Moonraker         │ {self.mr_local:<22} │ {self.mr_remote:<22} ║
+            ║  1) Klipper           │ {self.klipper_local:<22} │ {self.klipper_remote:<22} ║
+            ║  2) Moonraker         │ {self.moonraker_local:<22} │ {self.moonraker_remote:<22} ║
             ║                       │               │               ║
             ║ Webinterface:         ├───────────────┼───────────────╢
-            ║  3) Mainsail          │ {self.ms_local:<22} │ {self.ms_remote:<22} ║
-            ║  4) Fluidd            │ {self.fl_local:<22} │ {self.fl_remote:<22} ║
+            ║  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.mc_local:<22} │ {self.mc_remote:<22} ║
-            ║  6) Fluidd-Config     │ {self.fc_local:<22} │ {self.fc_remote:<22} ║
+            ║  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.ks_local:<22} │ {self.ks_remote:<22} ║
-            ║  8) Mobileraker       │ {self.mb_local:<22} │ {self.mb_remote:<22} ║
-            ║  9) Crowsnest         │ {self.cn_local:<22} │ {self.cn_remote:<22} ║
+            ║  7) KlipperScreen     │ {self.klipperscreen_local:<22} │ {self.klipperscreen_remote:<22} ║
+            ║  8) Crowsnest         │ {self.crowsnest_local:<22} │ {self.crowsnest_remote:<22} ║
             ║                       ├───────────────┴───────────────╢
-            ║ 10) System            │                               ║
+            ║  9) System            │ {sysupgrades:^{padding}} ║
             ╟───────────────────────┴───────────────────────────────╢
             """
         )[1:]
         print(menu, end="")
 
-    def update_all(self, **kwargs):
-        print("update_all")
+    def update_all(self, **kwargs) -> None:
+        Logger.print_status("Updating all components ...")
+        self.update_klipper()
+        self.update_moonraker()
+        self.update_mainsail()
+        self.update_mainsail_config()
+        self.update_fluidd()
+        self.update_fluidd_config()
+        self.update_klipperscreen()
+        self.update_crowsnest()
+        self.upgrade_system_packages()
 
-    def update_klipper(self, **kwargs):
-        update_klipper()
+    def update_klipper(self, **kwargs) -> None:
+        self._run_update_routine("klipper", update_klipper)
 
-    def update_moonraker(self, **kwargs):
-        update_moonraker()
+    def update_moonraker(self, **kwargs) -> None:
+        self._run_update_routine("moonraker", update_moonraker)
 
-    def update_mainsail(self, **kwargs):
-        update_client(self.mainsail_data)
+    def update_mainsail(self, **kwargs) -> None:
+        self._run_update_routine(
+            "mainsail",
+            update_client,
+            self.mainsail_data,
+        )
 
-    def update_mainsail_config(self, **kwargs):
-        update_client_config(self.mainsail_data)
+    def update_mainsail_config(self, **kwargs) -> None:
+        self._run_update_routine(
+            "mainsail_config",
+            update_client_config,
+            self.mainsail_data,
+        )
 
-    def update_fluidd(self, **kwargs):
-        update_client(self.fluidd_data)
+    def update_fluidd(self, **kwargs) -> None:
+        self._run_update_routine(
+            "fluidd",
+            update_client,
+            self.fluidd_data,
+        )
 
-    def update_fluidd_config(self, **kwargs):
-        update_client_config(self.fluidd_data)
+    def update_fluidd_config(self, **kwargs) -> None:
+        self._run_update_routine(
+            "fluidd_config",
+            update_client_config,
+            self.fluidd_data,
+        )
 
-    def update_klipperscreen(self, **kwargs):
-        update_klipperscreen()
+    def update_klipperscreen(self, **kwargs) -> None:
+        self._run_update_routine("klipperscreen", update_klipperscreen)
 
-    def update_mobileraker(self, **kwargs):
-        update_mobileraker()
+    def update_crowsnest(self, **kwargs) -> None:
+        self._run_update_routine("crowsnest", update_crowsnest)
 
-    def update_crowsnest(self, **kwargs):
-        update_crowsnest()
+    def upgrade_system_packages(self, **kwargs) -> None:
+        self._run_system_updates()
 
-    def upgrade_system_packages(self, **kwargs): ...
+    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("crowsnest", get_crowsnest_status)
 
-    def _fetch_update_status(self):
-        # klipper
-        self._get_update_status("kl", get_klipper_status)
-        # moonraker
-        self._get_update_status("mr", get_moonraker_status)
-        # mainsail
-        self._get_update_status("ms", get_client_status, self.mainsail_data, True)
-        # mainsail-config
-        self._get_update_status("mc", get_client_config_status, self.mainsail_data)
-        # fluidd
-        self._get_update_status("fl", get_client_status, self.fluidd_data, True)
-        # fluidd-config
-        self._get_update_status("fc", get_client_config_status, self.fluidd_data)
-        # klipperscreen
-        self._get_update_status("ks", get_klipperscreen_status)
-        # mobileraker
-        self._get_update_status("mb", get_mobileraker_status)
-        # crowsnest
-        self._get_update_status("cn", get_crowsnest_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:
-        if local_version == remote_version:
-            return f"{COLOR_GREEN}{local_version}{RESET_FORMAT}"
-        return f"{COLOR_YELLOW}{local_version}{RESET_FORMAT}"
+        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
 
-    def _get_update_status(self, name: str, status_fn: callable, *args) -> None:
-        status_data: ComponentStatus = status_fn(*args)
-        local_ver = status_data.get("local")
-        remote_ver = status_data.get("remote")
-        color = COLOR_GREEN if remote_ver != "ERROR" else COLOR_RED
-        setattr(self, f"{name}_local", self._format_local_status(local_ver, remote_ver))
-        setattr(self, f"{name}_remote", f"{color}{remote_ver}{RESET_FORMAT}")
+        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:
+        return self.status_data[name]["installed"]
+
+    def _is_update_available(self, name: str) -> bool:
+        return self.status_data[name]["local"] != self.status_data[name]["remote"]
+
+    def _run_update_routine(self, name: str, update_fn: Callable, *args) -> None:
+        display_name = self.status_data[name]["display_name"]
+        is_installed = self._check_is_installed(name)
+        is_update_available = self._is_update_available(name)
+
+        if not is_installed:
+            Logger.print_info(f"{display_name} is not installed! Skipped ...")
+            return
+        elif not is_update_available:
+            Logger.print_info(f"{display_name} is already up to date! Skipped ...")
+            return
+
+        update_fn(*args)
+
+    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

@@ -8,14 +8,15 @@
 # ======================================================================= #
 from __future__ import annotations
 
-from typing import Union
+from dataclasses import dataclass, field
+from typing import Any
 
+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.logger import DialogType, Logger
 from utils.sys_utils import kill
 
 from kiauh import PROJECT_ROOT
@@ -24,33 +25,21 @@ DEFAULT_CFG = PROJECT_ROOT.joinpath("default.kiauh.cfg")
 CUSTOM_CFG = PROJECT_ROOT.joinpath("kiauh.cfg")
 
 
+@dataclass
 class AppSettings:
-    def __init__(self) -> None:
-        self.backup_before_update = None
+    backup_before_update: bool | None = field(default=None)
 
 
-class KlipperSettings:
-    def __init__(self) -> None:
-        self.repo_url = None
-        self.branch = None
+@dataclass
+class RepoSettings:
+    repo_url: str | None = field(default=None)
+    branch: str | None = field(default=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
+@dataclass
+class WebUiSettings:
+    port: str | None = field(default=None)
+    unstable_releases: bool | None = field(default=None)
 
 
 # noinspection PyUnusedLocal
@@ -61,36 +50,37 @@ class KiauhSettings:
     def __new__(cls, *args, **kwargs) -> "KiauhSettings":
         if cls._instance is None:
             cls._instance = super(KiauhSettings, cls).__new__(cls, *args, **kwargs)
-            cls._instance.__initialized = False
         return cls._instance
 
+    def __repr__(self) -> str:
+        return (
+            f"KiauhSettings(kiauh={self.kiauh}, klipper={self.klipper},"
+            f" moonraker={self.moonraker}, mainsail={self.mainsail},"
+            f" fluidd={self.fluidd})"
+        )
+
+    def __getitem__(self, item: str) -> Any:
+        return getattr(self, item)
+
     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.klipper = RepoSettings()
+        self.moonraker = RepoSettings()
+        self.mainsail = WebUiSettings()
+        self.fluidd = WebUiSettings()
 
         self._load_config()
 
-    def get(self, section: str, option: str) -> Union[str, int, bool]:
+    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!
+        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.
@@ -99,27 +89,13 @@ class KiauhSettings:
         try:
             section = getattr(self, section)
             value = getattr(section, option)
-            return value
-        except AttributeError:
-            raise
-
-    def set(self, section: str, option: str, value: Union[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
+            return value  # type: ignore
         except AttributeError:
             raise
 
     def save(self) -> None:
-        self._set_config_options()
-        self.config.write(CUSTOM_CFG)
+        self._set_config_options_state()
+        self.config.write_file(CUSTOM_CFG)
         self._load_config()
 
     def _load_config(self) -> None:
@@ -127,10 +103,10 @@ class KiauhSettings:
             self._kill()
 
         cfg = CUSTOM_CFG if CUSTOM_CFG.exists() else DEFAULT_CFG
-        self.config.read(cfg)
+        self.config.read_file(cfg)
 
         self._validate_cfg()
-        self._read_settings()
+        self._apply_settings_from_file()
 
     def _validate_cfg(self) -> None:
         try:
@@ -160,7 +136,7 @@ class KiauhSettings:
 
     def _validate_bool(self, section: str, option: str) -> None:
         self._v_section, self._v_option = (section, option)
-        bool(self.config.getboolean(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)
@@ -168,18 +144,18 @@ class KiauhSettings:
 
     def _validate_str(self, section: str, option: str) -> None:
         self._v_section, self._v_option = (section, option)
-        v = self.config.get(section, option)
+        v = self.config.getval(section, option)
         if v.isdigit() or v.lower() == "true" or v.lower() == "false":
             raise ValueError
 
-    def _read_settings(self):
+    def _apply_settings_from_file(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.klipper.repo_url = self.config.getval("klipper", "repo_url")
+        self.klipper.branch = self.config.getval("klipper", "branch")
+        self.moonraker.repo_url = self.config.getval("moonraker", "repo_url")
+        self.moonraker.branch = self.config.getval("moonraker", "branch")
         self.mainsail.port = self.config.getint("mainsail", "port")
         self.mainsail.unstable_releases = self.config.getboolean(
             "mainsail", "unstable_releases"
@@ -189,24 +165,24 @@ class KiauhSettings:
             "fluidd", "unstable_releases"
         )
 
-    def _set_config_options(self):
-        self.config.set(
+    def _set_config_options_state(self) -> None:
+        self.config.set_option(
             "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(
+        self.config.set_option("klipper", "repo_url", self.klipper.repo_url)
+        self.config.set_option("klipper", "branch", self.klipper.branch)
+        self.config.set_option("moonraker", "repo_url", self.moonraker.repo_url)
+        self.config.set_option("moonraker", "branch", self.moonraker.branch)
+        self.config.set_option("mainsail", "port", str(self.mainsail.port))
+        self.config.set_option(
             "mainsail",
             "unstable_releases",
             str(self.mainsail.unstable_releases),
         )
-        self.config.set("fluidd", "port", str(self.fluidd.port))
-        self.config.set(
+        self.config.set_option("fluidd", "port", str(self.fluidd.port))
+        self.config.set_option(
             "fluidd", "unstable_releases", str(self.fluidd.unstable_releases)
         )
 
@@ -219,6 +195,5 @@ class KiauhSettings:
                 "● default.kiauh.cfg",
                 "● kiauh.cfg",
             ],
-            end="",
         )
         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/src/simple_config_parser/constants.py

@@ -0,0 +1,62 @@
+# ======================================================================= #
+#  Copyright (C) 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  #
+# ======================================================================= #
+import re
+
+# definition of section line:
+#  - then line MUST start with an opening square bracket - it is the first section marker
+#  - the section marker MUST be followed by at least one character - it is the section name
+#  - the section name MUST be followed by a closing square bracket - it is the second section marker
+#  - the second section marker MAY be followed by any amount of whitespace characters
+#  - the second section marker MAY be followed by a # or ; - it is the comment marker
+#  - the inline comment MAY be of any length and character
+SECTION_RE = re.compile(r"^\[(\S.*\S|\S)]\s*([#;].*)?$")
+
+# definition of option line:
+#  - the line MUST start with a word - it is the option name
+#  - the option name MUST be followed by a colon or an equal sign - it is the separator
+#  - the separator MUST be followed by a value
+#    - the separator MAY have any amount of leading or trailing whitespaces
+#    - the separator MUST NOT be directly followed by a colon or equal sign
+#  - the value MAY be of any length and character
+#    - the value MAY contain any amount of trailing whitespaces
+#    - the value MAY be followed by a # or ; - it is the comment marker
+#  - the inline comment MAY be of any length and character
+OPTION_RE = re.compile(r"^([^;#:=\s]+)\s?[:=]\s*([^;#:=\s][^;#]*?)\s*([#;].*)?$")
+# definition of options block start line:
+#  - the line MUST start with a word - it is the option name
+#  - the option name MUST be followed by a colon or an equal sign - it is the separator
+#  - the separator MUST NOT be followed by a value
+#    - the separator MAY have any amount of leading or trailing whitespaces
+#    - the separator MUST NOT be directly followed by a colon or equal sign
+#    - the separator MAY be followed by a # or ; - it is the comment marker
+#  - the inline comment MAY be of any length and character
+OPTIONS_BLOCK_START_RE = re.compile(r"^([^;#:=\s]+)\s*[:=]\s*([#;].*)?$")
+
+# definition of comment line:
+#  - the line MAY start with any amount of whitespace characters
+#  - the line MUST contain a # or ; - it is the comment marker
+#  - the comment marker MAY be followed by any amount of whitespace characters
+#  - the comment MAY be of any length and character
+LINE_COMMENT_RE = re.compile(r"^\s*[#;].*")
+
+# definition of empty line:
+#  - the line MUST contain only whitespace characters
+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,
+}
+
+HEADER_IDENT = "#_header"

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

@@ -1,5 +1,5 @@
 # ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2024 Dominik Willner <th33xitus@gmail.com>               #
 #                                                                         #
 #  https://github.com/dw-0/simple-config-parser                           #
 #                                                                         #
@@ -8,47 +8,24 @@
 
 from __future__ import annotations
 
-import re
+import secrets
+import string
 from pathlib import Path
-from typing import Callable, Dict, List, Match, Tuple, TypedDict
+from typing import Callable, Dict, List
+
+from ..simple_config_parser.constants import (
+    BOOLEAN_STATES,
+    EMPTY_LINE_RE,
+    HEADER_IDENT,
+    LINE_COMMENT_RE,
+    OPTION_RE,
+    OPTIONS_BLOCK_START_RE,
+    SECTION_RE,
+)
 
 _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"""
 
@@ -57,14 +34,6 @@ class NoSectionError(Exception):
         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"""
 
@@ -73,11 +42,11 @@ class DuplicateSectionError(Exception):
         super().__init__(msg)
 
 
-class DuplicateOptionError(Exception):
-    """Raised when an option is defined more than once"""
+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 defined more than once"
+        msg = f"Option '{option}' in section '{section}' is not defined"
         super().__init__(msg)
 
 
@@ -85,123 +54,195 @@ class DuplicateOptionError(Exception):
 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*$")
+    def __init__(self) -> None:
+        self.header: List[str] = []
+        self.config: Dict = {}
+        self.current_section: str | None = None
+        self.current_opt_block: str | None = None
+        self.current_collector: str | None = None
+        self.in_option_block: bool = False
 
-    BOOLEAN_STATES = {
-        "1": True,
-        "yes": True,
-        "true": True,
-        "on": True,
-        "0": False,
-        "no": False,
-        "false": False,
-        "off": False,
-    }
+    def _match_section(self, line: str) -> bool:
+        """Wheter or not the given line matches the definition of a section"""
+        return SECTION_RE.match(line) is not None
 
-    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 _match_option(self, line: str) -> bool:
+        """Wheter or not the given line matches the definition of an option"""
+        return OPTION_RE.match(line) is not None
 
-    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.
-        """
+    def _match_options_block_start(self, line: str) -> bool:
+        """Wheter or not the given line matches the definition of a multiline option"""
+        return OPTIONS_BLOCK_START_RE.match(line) is not None
 
-        self._reset_state()
+    def _match_line_comment(self, line: str) -> bool:
+        """Wheter or not the given line matches the definition of a comment"""
+        return LINE_COMMENT_RE.match(line) is not None
 
-        try:
-            with open(file, "r") as f:
-                self._parse_config(f.readlines())
+    def _match_empty_line(self, line: str) -> bool:
+        """Wheter or not the given line matches the definition of an empty line"""
+        return EMPTY_LINE_RE.match(line) is not None
 
-        except OSError:
-            raise
+    def _parse_line(self, line: str) -> None:
+        """Parses a line and determines its type"""
+        if self._match_section(line):
+            self.current_collector = None
+            self.current_opt_block = None
+            self.current_section = SECTION_RE.match(line).group(1)
+            self.config[self.current_section] = {"_raw": line}
 
-    def _reset_state(self):
-        """Reset the internal state."""
+        elif self._match_option(line):
+            self.current_collector = None
+            self.current_opt_block = None
+            option = OPTION_RE.match(line).group(1)
+            value = OPTION_RE.match(line).group(2)
+            self.config[self.current_section][option] = {"_raw": line, "value": value}
 
-        self._config.clear()
-        self._header.clear()
-        self._all_sections.clear()
-        self._all_options.clear()
-        self.section_name = ""
-        self.in_option_block = False
+        elif self._match_options_block_start(line):
+            self.current_collector = None
+            option = OPTIONS_BLOCK_START_RE.match(line).group(1)
+            self.current_opt_block = option
+            self.config[self.current_section][option] = {"_raw": line, "value": []}
 
-    def write(self, filename):
-        """Write the internal state to the given file"""
+        elif self.current_opt_block is not None:
+            self.config[self.current_section][self.current_opt_block]["value"].append(
+                line
+            )
 
-        content = self._construct_content()
+        elif self._match_empty_line(line) or self._match_line_comment(line):
+            self.current_opt_block = None
 
-        with open(filename, "w") as f:
-            f.write(content)
+            # if current_section is None, we are at the beginning of the file,
+            # so we consider the part up to the first section as the file header
+            if not self.current_section:
+                self.config.setdefault(HEADER_IDENT, []).append(line)
+            else:
+                section = self.config[self.current_section]
 
-    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.
+                # set the current collector to a new value, so that continuous
+                # empty lines or comments are collected into the same collector
+                if not self.current_collector:
+                    self.current_collector = self._generate_rand_id()
+                    section[self.current_collector] = []
 
-        :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"])
+                section[self.current_collector].append(line)
 
-            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)
+    def read_file(self, file: Path) -> None:
+        """Read and parse a config file"""
+        with open(file, "r") as file:
+            for line in file:
+                self._parse_line(line)
 
-        return content
+        # print(json.dumps(self.config, indent=4))
 
-    def sections(self) -> List[str]:
-        """Return a list of section names"""
+    def write_file(self, file: Path) -> None:
+        """Write the current config to the config file"""
+        if not file:
+            raise ValueError("No config file specified")
 
-        return self._all_sections
+        with open(file, "w") as file:
+            self._write_header(file)
+            self._write_sections(file)
+
+    def _write_header(self, file) -> None:
+        """Write the header to the config file"""
+        for line in self.config.get(HEADER_IDENT, []):
+            file.write(line)
+
+    def _write_sections(self, file) -> None:
+        """Write the sections to the config file"""
+        for section in self.get_sections():
+            for key, value in self.config[section].items():
+                self._write_section_content(file, key, value)
+
+    def _write_section_content(self, file, key, value) -> None:
+        """Write the content of a section to the config file"""
+        if key == "_raw":
+            file.write(value)
+        elif key.startswith("#_"):
+            for line in value:
+                file.write(line)
+        elif isinstance(value["value"], list):
+            file.write(value["_raw"])
+            for line in value["value"]:
+                file.write(line)
+        else:
+            file.write(value["_raw"])
+
+    def get_sections(self) -> List[str]:
+        """Return a list of all section names, but exclude any section starting with '#_'"""
+        return list(
+            filter(
+                lambda section: not section.startswith("#_"),
+                self.config.keys(),
+            )
+        )
+
+    def has_section(self, section: str) -> bool:
+        """Check if a section exists"""
+        return section in self.get_sections()
 
     def add_section(self, section: str) -> None:
-        """Add a new section to the internal state"""
-
-        if section in self._all_sections:
+        """Add a new section to the config"""
+        if section in self.get_sections():
             raise DuplicateSectionError(section)
-        self._all_sections.append(section)
-        self._all_options[section] = {}
-        self._config[section] = {"_raw": f"\n[{section}]\n", "body": []}
+
+        if len(self.get_sections()) >= 1:
+            self._check_set_section_spacing()
+
+        self.config[section] = {"_raw": f"[{section}]\n"}
+
+    def _check_set_section_spacing(self):
+        prev_section = self.get_sections()[-1]
+        prev_section_content = self.config[prev_section]
+        last_item = list(prev_section_content.keys())[-1]
+        if last_item.startswith("#_") and last_item.keys()[-1] != "\n":
+            prev_section_content[last_item].append("\n")
+        else:
+            prev_section_content[self._generate_rand_id()] = ["\n"]
 
     def remove_section(self, section: str) -> None:
-        """Remove the given section"""
+        """Remove a section from the config"""
+        self.config.pop(section, None)
 
-        if section not in self._all_sections:
-            raise NoSectionError(section)
+    def get_options(self, section: str) -> List[str]:
+        """Return a list of all option names for a given section"""
+        return list(
+            filter(
+                lambda option: option != "_raw" and not option.startswith("#_"),
+                self.config[section].keys(),
+            )
+        )
 
-        self._all_sections.pop(self._all_sections.index(section))
-        self._all_options.pop(section)
-        self._config.pop(section)
+    def has_option(self, section: str, option: str) -> bool:
+        """Check if an option exists in a section"""
+        return self.has_section(section) and option in self.get_options(section)
 
-    def options(self, section) -> List[str]:
-        """Return a list of option names for the given section name"""
+    def set_option(self, section: str, option: str, value: str | List[str]) -> None:
+        """
+        Set the value of an option in a section. If the section does not exist,
+        it is created. If the option does not exist, it is created.
+        """
+        if not self.has_section(section):
+            self.add_section(section)
 
-        return self._all_options.get(section)
+        if not self.has_option(section, option):
+            self.config[section][option] = {
+                "_raw": f"{option}:\n"
+                if isinstance(value, list)
+                else f"{option}: {value}\n",
+                "value": value,
+            }
+        else:
+            opt = self.config[section][option]
+            if not isinstance(value, list):
+                opt["_raw"] = opt["_raw"].replace(opt["value"], value)
+            opt["value"] = value
 
-    def get(
+    def remove_option(self, section: str, option: str) -> None:
+        """Remove an option from a section"""
+        self.config[section].pop(option, None)
+
+    def getval(
         self, section: str, option: str, fallback: str | _UNSET = _UNSET
     ) -> str | List[str]:
         """
@@ -210,15 +251,12 @@ class SimpleConfigParser:
         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:
+            if section not in self.get_sections():
                 raise NoSectionError(section)
-
-            if option not in self._all_options.get(section):
+            if option not in self.get_options(section):
                 raise NoOptionError(option, section)
-
-            return self._all_options[section][option]
+            return self.config[section][option]["value"]
         except (NoSectionError, NoOptionError):
             if fallback is _UNSET:
                 raise
@@ -226,25 +264,29 @@ class SimpleConfigParser:
 
     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 the value of the given option in the given section as a float"""
         return self._get_conv(section, option, float, fallback=fallback)
 
     def getboolean(
         self, section: str, option: str, fallback: bool | _UNSET = _UNSET
     ) -> bool:
+        """Return the value of the given option in the given section as a boolean"""
         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:
+    def _convert_to_boolean(self, value: str) -> bool:
+        """Convert a string to a boolean"""
+        if isinstance(value, bool):
+            return value
+        if value.lower() not in BOOLEAN_STATES:
             raise ValueError("Not a boolean: %s" % value)
-        return self.BOOLEAN_STATES[value.lower()]
+        return BOOLEAN_STATES[value.lower()]
 
     def _get_conv(
         self,
@@ -253,300 +295,18 @@ class SimpleConfigParser:
         conv: Callable[[str], int | float | bool],
         fallback: _UNSET = _UNSET,
     ) -> int | float | bool:
+        """Return the value of the given option in the given section as a converted value"""
         try:
-            return conv(self.get(section, option, fallback))
-        except:
+            return conv(self.getval(section, option, fallback))
+        except ValueError as e:
             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)
+            raise ValueError(
+                f"Cannot convert {self.getval(section, option)} to {conv.__name__}"
+            ) from e
+
+    def _generate_rand_id(self) -> str:
+        """Generate a random id with 6 characters"""
+        chars = string.ascii_letters + string.digits
+        rand_string = "".join(secrets.choice(chars) for _ in range(12))
+        return f"#_{rand_string}"

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

@@ -1,21 +0,0 @@
-<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/assets/test_config_1.cfg

@@ -0,0 +1,32 @@
+# a comment at the very top
+# should be treated as the file header
+
+# up to the first section, including all blank lines
+
+[section_1]
+option_1: value_1
+option_1_1: True # this is a boolean
+option_1_2: 5 ; this is an integer
+option_1_3: 1.123 #;this is a float
+
+[section_2] ; comment
+option_2: value_2
+
+; comment
+
+[section_3]
+option_3: value_3 # comment
+
+[section_4]
+# comment
+option_4: value_4
+
+[section number 5]
+#option_5: value_5
+option_5 = this.is.value-5
+multi_option:
+  # these are multi-line values
+  value_5_1
+  value_5_2 ; here is a comment
+  value_5_3
+option_5_1: value_5_1

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

@@ -1,95 +0,0 @@
-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

@@ -1,84 +0,0 @@
-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

@@ -1,6 +0,0 @@
-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

@@ -1,24 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,92 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,17 +0,0 @@
-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

@@ -1,30 +0,0 @@
-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

@@ -1,12 +0,0 @@
-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

@@ -1,37 +0,0 @@
-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

@@ -1,196 +0,0 @@
-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/submodules/simple_config_parser/tests/line_matching/match_empty_line/test_data/matching_data.txt

@@ -0,0 +1,6 @@
+
+
+
+
+
+

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_empty_line/test_data/non_matching_data.txt

@@ -0,0 +1,7 @@
+not_empty
+[also_not_empty]
+#
+;
+ ;
+  #
+option: value

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_empty_line/test_match_empty_line.py

@@ -0,0 +1,39 @@
+# ======================================================================= #
+#  Copyright (C) 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 pathlib import Path
+
+import pytest
+
+from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from tests.utils import load_testdata_from_file
+
+BASE_DIR = Path(__file__).parent.joinpath("test_data")
+MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
+NON_MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("non_matching_data.txt")
+
+
+@pytest.fixture
+def parser():
+    return SimpleConfigParser()
+
+
+@pytest.mark.parametrize("line", load_testdata_from_file(MATCHING_TEST_DATA_PATH))
+def test_match_line_comment(parser, line):
+    """Test that a line matches the definition of a line comment"""
+    assert (
+        parser._match_empty_line(line) is True
+    ), f"Expected line '{line}' to match line comment definition!"
+
+
+@pytest.mark.parametrize("line", load_testdata_from_file(NON_MATCHING_TEST_DATA_PATH))
+def test_non_matching_line_comment(parser, line):
+    """Test that a line does not match the definition of a line comment"""
+    assert (
+        parser._match_empty_line(line) is False
+    ), f"Expected line '{line}' to not match line comment definition!"

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_line_comment/test_data/matching_data.txt

@@ -0,0 +1,28 @@
+;[example_section]
+#[example_section]
+# [example_section]
+; [example_section]
+;[gcode_macro CANCEL_PRINT]
+#[gcode_macro CANCEL_PRINT]
+# [gcode_macro CANCEL_PRINT]
+; [gcode_macro CANCEL_PRINT]
+;[gcode_macro SET_PAUSE_NEXT_LAYER]
+#[gcode_macro SET_PAUSE_NEXT_LAYER]
+# [gcode_macro SET_PAUSE_NEXT_LAYER]
+; [gcode_macro SET_PAUSE_NEXT_LAYER]
+;[gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]
+#[gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]
+# [gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]
+; [gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]
+ ;[gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]
+ #[gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]
+ # [gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]
+ ; [gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]
+  ;[gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]
+  #[gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]
+  # [gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]
+  ; [gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]
+   ;[gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]
+   #[gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]
+   # [gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]
+   ; [gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_line_comment/test_data/non_matching_data.txt

@@ -0,0 +1,5 @@
+not_a_comment: nono
+
+[also not a comment]
+not_a_comment: ; comment
+not_a_comment: # comment

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_line_comment/test_match_line_comment.py

@@ -0,0 +1,39 @@
+# ======================================================================= #
+#  Copyright (C) 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 pathlib import Path
+
+import pytest
+
+from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from tests.utils import load_testdata_from_file
+
+BASE_DIR = Path(__file__).parent.joinpath("test_data")
+MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
+NON_MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("non_matching_data.txt")
+
+
+@pytest.fixture
+def parser():
+    return SimpleConfigParser()
+
+
+@pytest.mark.parametrize("line", load_testdata_from_file(MATCHING_TEST_DATA_PATH))
+def test_match_line_comment(parser, line):
+    """Test that a line matches the definition of a line comment"""
+    assert (
+        parser._match_line_comment(line) is True
+    ), f"Expected line '{line}' to match line comment definition!"
+
+
+@pytest.mark.parametrize("line", load_testdata_from_file(NON_MATCHING_TEST_DATA_PATH))
+def test_non_matching_line_comment(parser, line):
+    """Test that a line does not match the definition of a line comment"""
+    assert (
+        parser._match_line_comment(line) is False
+    ), f"Expected line '{line}' to not match line comment definition!"

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_option/test_data/matching_data.txt

@@ -0,0 +1,461 @@
+baud: 250000
+minimum_cruise_ratio: 0.5
+square_corner_velocity: 5.0
+full_steps_per_rotation: 200
+position_min: 0
+homing_speed: 5.0
+homing_retract_dist: 5.0
+kinematics: cartesian
+kinematics: delta
+minimum_z_position: 0
+speed: 50
+horizontal_move_z: 5
+kinematics: deltesian
+minimum_z_position: 0
+min_angle: 5
+slow_ratio: 3
+kinematics: corexy
+kinematics: corexz
+kinematics: hybrid_corexy
+kinematics: hybrid_corexz
+kinematics: polar
+kinematics: rotary_delta
+minimum_z_position: 0
+speed: 50
+horizontal_move_z: 5
+kinematics: winch
+kinematics: none
+max_velocity: 1
+max_accel: 1
+instantaneous_corner_velocity: 1.000
+max_extrude_only_distance: 50.0
+pressure_advance: 0.0
+pressure_advance_smooth_time: 0.040
+max_power: 1.0
+pullup_resistor: 4700
+smooth_time: 1.0
+max_delta: 2.0
+pwm_cycle_time: 0.100
+min_extrude_temp: 170
+speed: 50
+horizontal_move_z: 5
+probe_count: 3, 3
+round_probe_count: 5
+fade_start: 1.0
+fade_end: 0.0
+split_delta_z: .025
+move_check_distance: 5.0
+mesh_pps: 2, 2
+algorithm: lagrange
+bicubic_tension: .2
+x_adjust: 0
+y_adjust: 0
+z_adjust: 0
+speed: 50
+horizontal_move_z: 5
+horizontal_move_z: 5
+probe_height: 0
+speed: 50
+probe_speed: 5
+speed: 50
+horizontal_move_z: 5
+screw_thread: CW-M3
+speed: 50
+horizontal_move_z: 5
+retries: 0
+retry_tolerance: 0
+speed: 50
+horizontal_move_z: 5
+max_adjust: 4
+retries: 0
+retry_tolerance: 0
+speed: 50.0
+z_hop_speed: 15.0
+move_to_previous: False
+axes: xyz
+endstop_align_zero: False
+description: G-Code macro
+initial_duration: 0.0
+timeout: 600
+enable_force_move: False
+recover_velocity: 50.
+retract_length: 0
+retract_speed: 20
+unretract_extra_length: 0
+unretract_speed: 10
+resolution: 1.0
+default_type: echo
+default_prefix: echo:
+shaper_freq_x: 0
+shaper_freq_y: 0
+shaper_type: mzv
+damping_ratio_x: 0.1
+damping_ratio_y: 0.1
+spi_speed: 5000000
+axes_map: x, y, z
+rate: 3200
+spi_speed: 5000000
+axes_map: x, y, z
+i2c_speed: 400000
+axes_map: x, y, z
+min_freq: 5
+max_freq: 133.33
+accel_per_hz: 75
+hz_per_sec: 1
+mcu: mcu
+deactivate_on_each_sample: True
+x_offset: 0.0
+y_offset: 0.0
+speed: 5.0
+samples: 1
+sampleretract_dist: 2.0
+samples_result: average
+samples_tolerance: 0.100
+samples_toleranceretries: 0
+pin_move_time: 0.680
+stow_on_each_sample: True
+probe_with_touch_mode: False
+pin_up_reports_not_triggered: True
+pin_up_touch_modereports_triggered: True
+recovery_time: 0.4
+sensor_type: ldc1612
+speed: 50
+horizontal_move_z: 5
+calibrate_start_x: 20
+calibrate_end_x: 200
+calibrate_y: 112.5
+max_error: 120
+hysteresis: 5
+heating_gain: 2
+extruder_heating_z: 50.
+max_validation_temp: 60.
+pullup_resistor: 4700
+inlineresistor: 0
+adc_voltage: 5.0
+voltage_offset: 0
+sensor_type: PT1000
+pullup_resistor: 4700
+spi_speed: 4000000
+tc_type: K
+tc_use_50Hz_filter: False
+tc_averaging_count: 1
+rtd_nominal_r: 100
+rtd_referencer: 430
+rtd_num_of_wires: 2
+rtd_use_50Hz_filter: False
+sensor_type: BME280
+sensor_type: AHT10
+sensor_type: temperature_mcu
+sensor_mcu: mcu
+sensor_type: temperature_host
+sensor_type: DS18B20
+sensor_type: temperature_combined
+max_power: 1.0
+shutdown_speed: 0
+cycle_time: 0.010
+hardware_pwm: False
+kick_start_time: 0.100
+off_below: 0.0
+tachometer_ppr: 2
+tachometer_poll_interval: 0.0015
+heater: extruder
+heater_temp: 50.0
+fan_speed: 1.0
+fan_speed: 1.0
+pid_deriv_time: 2.0
+target_temp: 40.0
+max_speed: 1.0
+min_speed: 0.3
+cycle_time: 0.010
+hardware_pwm: False
+initial_RED: 0.0
+initial_GREEN: 0.0
+initial_BLUE: 0.0
+initial_WHITE: 0.0
+color_order: GRB
+initial_RED: 0.0
+initial_GREEN: 0.0
+initial_BLUE: 0.0
+initial_WHITE: 0.0
+initial_RED: 0.0
+initial_GREEN: 0.0
+initial_BLUE: 0.0
+i2c_address: 98
+initial_RED: 0.0
+initial_GREEN: 0.0
+initial_BLUE: 0.0
+initial_WHITE: 0.0
+i2c_address: 98
+color_order: RGBW
+initial_RED: 0.0
+initial_GREEN: 0.0
+initial_BLUE: 0.0
+initial_WHITE: 0.0
+maximum_servo_angle: 180
+minimum_pulse_width: 0.001
+maximum_pulse_width: 0.002
+pwm: False
+cycle_time: 0.100
+hardware_pwm: False
+cycle_time: 0.100
+hardware_pwm: False
+cycle_time: 0.100
+interpolate: True
+senseresistor: 0.110
+stealthchop_threshold: 0
+driver_MSLUT0: 2863314260
+driver_MSLUT1: 1251300522
+driver_MSLUT2: 608774441
+driver_MSLUT3: 269500962
+driver_MSLUT4: 4227858431
+driver_MSLUT5: 3048961917
+driver_MSLUT6: 1227445590
+driver_MSLUT7: 4211234
+driver_W0: 2
+driver_W1: 1
+driver_W2: 1
+driver_W3: 1
+driver_X1: 128
+driver_X2: 255
+driver_X3: 255
+driver_START_SIN: 0
+driver_START_SIN90: 247
+driver_IHOLDDELAY: 8
+driver_TPOWERDOWN: 0
+driver_TBL: 1
+driver_TOFF: 4
+driver_HEND: 7
+driver_HSTRT: 0
+driver_VHIGHFS: 0
+driver_VHIGHCHM: 0
+driver_PWM_AUTOSCALE: True
+driver_PWM_FREQ: 1
+driver_PWM_GRAD: 4
+driver_PWM_AMPL: 128
+driver_SGT: 0
+driver_SEMIN: 0
+driver_SEUP: 0
+driver_SEMAX: 0
+driver_SEDN: 0
+driver_SEIMIN: 0
+driver_SFILT: 0
+interpolate: True
+sense_resistor: 0.110
+stealthchop_threshold: 0
+driver_MULTISTEP_FILT: True
+driver_IHOLDDELAY: 8
+driver_TPOWERDOWN: 20
+driver_TBL: 2
+driver_TOFF: 3
+driver_HEND: 0
+driver_HSTRT: 5
+driver_PWM_AUTOGRAD: True
+driver_PWM_AUTOSCALE: True
+driver_PWM_LIM: 12
+driver_PWM_REG: 8
+driver_PWM_FREQ: 1
+driver_PWM_GRAD: 14
+driver_PWM_OFS: 36
+interpolate: True
+sense_resistor: 0.110
+stealthchop_threshold: 0
+driver_MULTISTEP_FILT: True
+driver_IHOLDDELAY: 8
+driver_TPOWERDOWN: 20
+driver_TBL: 2
+driver_TOFF: 3
+driver_HEND: 0
+driver_HSTRT: 5
+driver_PWM_AUTOGRAD: True
+driver_PWM_AUTOSCALE: True
+driver_PWM_LIM: 12
+driver_PWM_REG: 8
+driver_PWM_FREQ: 1
+driver_PWM_GRAD: 14
+driver_PWM_OFS: 36
+driver_SGTHRS: 0
+driver_SEMIN: 0
+driver_SEUP: 0
+driver_SEMAX: 0
+driver_SEDN: 0
+driver_SEIMIN: 0
+spi_speed: 4000000
+interpolate: True
+idle_current_percent: 100
+driver_TBL: 2
+driver_RNDTF: 0
+driver_HDEC: 0
+driver_CHM: 0
+driver_HEND: 3
+driver_HSTRT: 3
+driver_TOFF: 4
+driver_SEIMIN: 0
+driver_SEDN: 0
+driver_SEMAX: 0
+driver_SEUP: 0
+driver_SEMIN: 0
+driver_SFILT: 0
+driver_SGT: 0
+driver_SLPH: 0
+driver_SLPL: 0
+driver_DISS2G: 0
+driver_TS2G: 3
+interpolate: True
+rref: 12000
+stealthchop_threshold: 0
+driver_MSLUT0: 2863314260
+driver_MSLUT1: 1251300522
+driver_MSLUT2: 608774441
+driver_MSLUT3: 269500962
+driver_MSLUT4: 4227858431
+driver_MSLUT5: 3048961917
+driver_MSLUT6: 1227445590
+driver_MSLUT7: 4211234
+driver_W0: 2
+driver_W1: 1
+driver_W2: 1
+driver_W3: 1
+driver_X1: 128
+driver_X2: 255
+driver_X3: 255
+driver_START_SIN: 0
+driver_START_SIN90: 247
+driver_OFFSET_SIN90: 0
+driver_MULTISTEP_FILT: True
+driver_IHOLDDELAY: 6
+driver_IRUNDELAY: 4
+driver_TPOWERDOWN: 10
+driver_TBL: 2
+driver_TOFF: 3
+driver_HEND: 2
+driver_HSTRT: 5
+driver_FD3: 0
+driver_TPFD: 4
+driver_CHM: 0
+driver_VHIGHFS: 0
+driver_VHIGHCHM: 0
+driver_DISS2G: 0
+driver_DISS2VS: 0
+driver_PWM_AUTOSCALE: True
+driver_PWM_AUTOGRAD: True
+driver_PWM_FREQ: 0
+driver_FREEWHEEL: 0
+driver_PWM_GRAD: 0
+driver_PWM_OFS: 29
+driver_PWM_REG: 4
+driver_PWM_LIM: 12
+driver_SGT: 0
+driver_SEMIN: 0
+driver_SEUP: 0
+driver_SEMAX: 0
+driver_SEDN: 0
+driver_SEIMIN: 0
+driver_SFILT: 0
+driver_SG4_ANGLE_OFFSET: 1
+interpolate: True
+sense_resistor: 0.075
+stealthchop_threshold: 0
+driver_MSLUT0: 2863314260
+driver_MSLUT1: 1251300522
+driver_MSLUT2: 608774441
+driver_MSLUT3: 269500962
+driver_MSLUT4: 4227858431
+driver_MSLUT5: 3048961917
+driver_MSLUT6: 1227445590
+driver_MSLUT7: 4211234
+driver_W0: 2
+driver_W1: 1
+driver_W2: 1
+driver_W3: 1
+driver_X1: 128
+driver_X2: 255
+driver_X3: 255
+driver_START_SIN: 0
+driver_START_SIN90: 247
+driver_MULTISTEP_FILT: True
+driver_IHOLDDELAY: 6
+driver_TPOWERDOWN: 10
+driver_TBL: 2
+driver_TOFF: 3
+driver_HEND: 2
+driver_HSTRT: 5
+driver_FD3: 0
+driver_TPFD: 4
+driver_CHM: 0
+driver_VHIGHFS: 0
+driver_VHIGHCHM: 0
+driver_DISS2G: 0
+driver_DISS2VS: 0
+driver_PWM_AUTOSCALE: True
+driver_PWM_AUTOGRAD: True
+driver_PWM_FREQ: 0
+driver_FREEWHEEL: 0
+driver_PWM_GRAD: 0
+driver_PWM_OFS: 30
+driver_PWM_REG: 4
+driver_PWM_LIM: 12
+driver_SGT: 0
+driver_SEMIN: 0
+driver_SEUP: 0
+driver_SEMAX: 0
+driver_SEDN: 0
+driver_SEIMIN: 0
+driver_SFILT: 0
+driver_DRVSTRENGTH: 0
+driver_BBMCLKS: 4
+driver_BBMTIME: 0
+driver_FILT_ISENSE: 0
+i2c_address: 96
+analog_pullup_resistor: 4700
+lcd_type: hd44780
+hd44780_protocol_init: True
+lcd_type: hd44780_spi
+hd44780_protocol_init: True
+lcd_type: st7920
+lcd_type: emulated_st7920
+lcd_type: uc1701
+vcomh: 0
+invert: False
+x_offset: 0
+type: disabled
+type: list
+type: command
+type: input
+pause_on_runout: True
+event_delay: 3.0
+pause_delay: 0.5
+detection_length: 7.0
+default_nominal_filament_diameter: 1.75
+max_difference: 0.2
+measurement_delay: 100
+cal_dia1: 1.50
+cal_dia2: 2.00
+raw_dia1: 9500
+raw_dia2: 10500
+default_nominal_filament_diameter: 1.75
+max_difference: 0.200
+measurement_delay: 70
+enable: False
+measurement_interval: 10
+logging: False
+min_diameter: 1.0
+use_current_dia_while_delay: False
+sensor_type: hx711
+gain: A-128
+sample_rate: 80
+sensor_type: hx717
+gain: A-128
+sample_rate: 320
+sensor_type: ads1220
+spi_speed: 512000
+gain: 128
+sample_rate: 660
+smooth_time: 2.0
+enable_pin: !gpio0_20
+standstill_power_down: False
+baud: 115200
+feedrate_splice: 0.8
+feedrate_normal: 1.0
+auto_load_speed: 2
+auto_cancel_variation: 0.1
+sample_period: 0.000400

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_option/test_data/non_matching_data.txt

@@ -0,0 +1,37 @@
+[section]
+[section with spaces]
+[section with spaces and comments] ; comment 1
+[section with spaces and comments] # comment 2
+ indented_option: value
+option_with_no_value:
+another_option_with_no_value:
+ indented_option_with_no_value:
+# position_min: 0
+# homing_speed: 5.0
+
+### this is a comment
+; this is also a comment
+# [section]
+# [section with spaces]
+# [section with spaces and comments] ; comment 1
+;[section]
+;[section with spaces]
+;[section with spaces and comments] ; comment 1
+# commented_option: value
+#commented_option: value
+;commented_option: value
+; commented_option: value
+#
+;
+option_1 :: value
+option_1:: value
+option_1 ::value
+option_2 == value
+option_2== value
+option_2 ==value
+option_1 := value
+option_1:= value
+option_1 :=value
+option_2 := value
+option_2:= value
+option_2 :=value

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_option/test_match_option.py

@@ -0,0 +1,39 @@
+# ======================================================================= #
+#  Copyright (C) 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 pathlib import Path
+
+import pytest
+
+from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from tests.utils import load_testdata_from_file
+
+BASE_DIR = Path(__file__).parent.joinpath("test_data")
+MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
+NON_MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("non_matching_data.txt")
+
+
+@pytest.fixture
+def parser():
+    return SimpleConfigParser()
+
+
+@pytest.mark.parametrize("line", load_testdata_from_file(MATCHING_TEST_DATA_PATH))
+def test_match_option(parser, line):
+    """Test that a line matches the definition of an option"""
+    assert (
+        parser._match_option(line) is True
+    ), f"Expected line '{line}' to match option definition!"
+
+
+@pytest.mark.parametrize("line", load_testdata_from_file(NON_MATCHING_TEST_DATA_PATH))
+def test_non_matching_option(parser, line):
+    """Test that a line does not match the definition of an option"""
+    assert (
+        parser._match_option(line) is False
+    ), f"Expected line '{line}' to not match option definition!"

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_option_block_start/test_data/matching_data.txt

@@ -0,0 +1,15 @@
+trusted_clients:
+gcode:
+cors_domains:
+an_options_block_start_with_comment: ; this is a comment
+an_options_block_start_with_comment: # this is a comment
+options_block_start_with_comment:;this is a comment
+options_block_start_with_comment :;this is a comment
+options_block_start_with_comment:#this is a comment
+options_block_start_with_comment :#this is a comment
+parameter_temperature_(°C):
+parameter_temperature_(°C)=
+parameter_humidity_(%_RH):
+parameter_humidity_(%_RH) :
+parameter_spool_weight_(%):
+parameter_spool_weight_(%) =

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_option_block_start/test_data/non_matching_data.txt

@@ -0,0 +1,31 @@
+type: jsonfile
+path: /dev/shm/drying_box.json
+baud: 250000
+minimum_cruise_ratio: 0.5
+square_corner_velocity: 5.0
+full_steps_per_rotation: 200
+position_min: 0
+homing_speed: 5.0
+# baud: 250000
+# minimum_cruise_ratio: 0.5
+# square_corner_velocity: 5.0
+# full_steps_per_rotation: 200
+# position_min: 0
+# homing_speed: 5.0
+
+### this is a comment
+; this is also a comment
+;
+#
+homing_speed::
+homing_speed::
+homing_speed ::
+homing_speed ::
+homing_speed==
+homing_speed==
+homing_speed ==
+homing_speed ==
+homing_speed :=
+homing_speed :=
+homing_speed =:
+homing_speed =:

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_option_block_start/test_match_options_block_start.py

@@ -0,0 +1,39 @@
+# ======================================================================= #
+#  Copyright (C) 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 pathlib import Path
+
+import pytest
+
+from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from tests.utils import load_testdata_from_file
+
+BASE_DIR = Path(__file__).parent.joinpath("test_data")
+MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
+NON_MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("non_matching_data.txt")
+
+
+@pytest.fixture
+def parser():
+    return SimpleConfigParser()
+
+
+@pytest.mark.parametrize("line", load_testdata_from_file(MATCHING_TEST_DATA_PATH))
+def test_match_options_block_start(parser, line):
+    """Test that a line matches the definition of an options block start"""
+    assert (
+        parser._match_options_block_start(line) is True
+    ), f"Expected line '{line}' to match options block start definition!"
+
+
+@pytest.mark.parametrize("line", load_testdata_from_file(NON_MATCHING_TEST_DATA_PATH))
+def test_non_matching_options_block_start(parser, line):
+    """Test that a line does not match the definition of an options block start"""
+    assert (
+        parser._match_options_block_start(line) is False
+    ), f"Expected line '{line}' to not match options block start definition!"

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_section/test_data/matching_data.txt

@@ -0,0 +1,127 @@
+[example_section]
+[gcode_macro CANCEL_PRINT]
+[gcode_macro SET_PAUSE_NEXT_LAYER]
+[gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]
+[update_manager moonraker-obico]
+[include moonraker_obico_macros.cfg]
+[include moonraker-obico-update.cfg]
+[example_section two]
+[valid_content]
+[valid content]
+[content123]
+[a]
+[valid_content] # comment
+[something];comment
+[mcu]
+[printer]
+[printer]
+[stepper_x]
+[stepper_y]
+[stepper_z]
+[printer]
+[stepper_a]
+[stepper_b]
+[stepper_c]
+[delta_calibrate]
+[printer]
+[stepper_left]
+[stepper_right]
+[stepper_bed]
+[stepper_arm]
+[delta_calibrate]
+[extruder]
+[heater_bed]
+[bed_mesh]
+[bed_tilt]
+[bed_screws]
+[screws_tilt_adjust]
+[z_tilt]
+[quad_gantry_level]
+[skew_correction]
+[z_thermal_adjust]
+[safe_z_home]
+[homing_override]
+[endstop_phase stepper_z]
+[gcode_macro my_cmd]
+[delayed_gcode my_delayed_gcode]
+[save_variables]
+[idle_timeout]
+[virtual_sdcard]
+[sdcard_loop]
+[force_move]
+[pause_resume]
+[firmware_retraction]
+[gcode_arcs]
+[respond]
+[exclude_object]
+[input_shaper]
+[adxl345]
+[lis2dw]
+[mpu9250 my_accelerometer]
+[resonance_tester]
+[board_pins my_aliases]
+[duplicate_pin_override]
+[probe]
+[bltouch]
+[smart_effector]
+[probe_eddy_current my_eddy_probe]
+[axis_twist_compensation]
+[stepper_z1]
+[extruder1]
+[dual_carriage]
+[extruder_stepper my_extra_stepper]
+[manual_stepper my_stepper]
+[verify_heater heater_config_name]
+[homing_heaters]
+[thermistor my_thermistor]
+[adc_temperature my_sensor]
+[heater_generic my_generic_heater]
+[temperature_sensor my_sensor]
+[temperature_probe my_probe]
+[fan]
+[heater_fan heatbreak_cooling_fan]
+[controller_fan my_controller_fan]
+[temperature_fan my_temp_fan]
+[fan_generic extruder_partfan]
+[led my_led]
+[neopixel my_neopixel]
+[dotstar my_dotstar]
+[pca9533 my_pca9533]
+[pca9632 my_pca9632]
+[servo my_servo]
+[gcode_button my_gcode_button]
+[output_pin my_pin]
+[pwm_tool my_tool]
+[pwm_cycle_time my_pin]
+[static_digital_output my_output_pins]
+[multi_pin my_multi_pin]
+[tmc2130 stepper_x]
+[tmc2208 stepper_x]
+[tmc2209 stepper_x]
+[tmc2660 stepper_x]
+[tmc2240 stepper_x]
+[tmc5160 stepper_x]
+[ad5206 my_digipot]
+[mcp4451 my_digipot]
+[mcp4728 my_dac]
+[mcp4018 my_digipot]
+[display]
+[display_data my_group_name my_data_name]
+[display_template my_template_name]
+[display_glyph my_display_glyph]
+[menu __some_list __some_name]
+[menu some_name]
+[menu some_list]
+[menu some_list some_command]
+[menu some_list some_input]
+[filament_switch_sensor my_sensor]
+[filament_motion_sensor my_sensor]
+[tsl1401cl_filament_width_sensor]
+[hall_filament_width_sensor]
+[load_cell]
+[sx1509 my_sx1509]
+[samd_sercom my_sercom]
+[adc_scaled my_name]
+[replicape]
+[palette2]
+[angle my_angle_sensor]

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_section/test_data/non_matching_data.txt

@@ -0,0 +1,19 @@
+section: invalid
+not_a_valid_section
+[missing_square_bracket
+missing_square_bracket]
+[]
+[ ]
+  [indented_section]
+           [indented_section]  # comment
+       [indented_section]  ; comment
+;[commented_section]
+#[another_commented_section]
+; [commented_section]
+# [another_commented_section]
+this_is_an_option: 123
+  this_is_an_indented_option: 123
+this_is_an_option_block_start:
+
+#
+;

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_section/test_match_section.py

@@ -0,0 +1,39 @@
+# ======================================================================= #
+#  Copyright (C) 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 pathlib import Path
+
+import pytest
+
+from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from tests.utils import load_testdata_from_file
+
+BASE_DIR = Path(__file__).parent.joinpath("test_data")
+MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
+NON_MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("non_matching_data.txt")
+
+
+@pytest.fixture
+def parser():
+    return SimpleConfigParser()
+
+
+@pytest.mark.parametrize("line", load_testdata_from_file(MATCHING_TEST_DATA_PATH))
+def test_match_section(parser, line):
+    """Test that a line matches the definition of a section"""
+    assert (
+        parser._match_section(line) is True
+    ), f"Expected line '{line}' to match section definition!"
+
+
+@pytest.mark.parametrize("line", load_testdata_from_file(NON_MATCHING_TEST_DATA_PATH))
+def test_non_matching_section(parser, line):
+    """Test that a line does not match the definition of a section"""
+    assert (
+        parser._match_section(line) is False
+    ), f"Expected line '{line}' to not match section definition!"