Release v6.0.0-alpha.4

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

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+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

.gitignore

@@ -1,7 +1,7 @@
 .idea
 .vscode
-.idea
 .pytest_cache
+__pycache__
 .kiauh-env
 *.code-workspace
 *.iml

README.md

@@ -154,18 +154,20 @@ 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/OctoApp-Plugin">OctoApp For Klipper</a></h3></th>
 <th><h3></h3></th>
 </tr>
 
 <tr>
-<th><a href="https://github.com/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="OctoEverywhere Logo" height="64"></th>
+<th><a href="https://github.com/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="OctoEverywhere Logo" height="64"></a></th>
 <th><a href="https://octoeverywhere.com/?source=kiauh_readme"><img src="https://octoeverywhere.com/img/logo.svg" alt="OctoEverywhere Logo" height="64"></a></th>
-<th></th>
+<th><a href="https://octoapp.eu/?source=kiauh_readme"><img src="https://octoapp.eu/octoapp.webp" alt="OctoApp Logo" height="64"></a></th>
 </tr>
 
 <tr>
 <th>by <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
 <th>by <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
+<th>by <a href="https://github.com/crysxd">Christian Würthner</a></th>
 <th></th>
 </tr>
 
@@ -174,6 +176,16 @@ prompt and confirm by hitting ENTER.
 
 <hr>
 
+<h2 align="center">🎖️ Contributors 🎖️</h2>
+
+<div align="center">
+  <a href="https://github.com/dw-0/kiauh/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=dw-0/kiauh" alt=""/>
+  </a>
+</div>
+
+<hr>
+
 <h2 align="center">✨ Credits ✨</h2>
 
 * A big thank you to [lixxbox](https://github.com/lixxbox) for that awesome KIAUH-Logo!

default.kiauh.cfg

@@ -2,19 +2,17 @@
 backup_before_update: False
 
 [klipper]
-repository_url: https://github.com/Klipper3d/klipper
+repo_url: https://github.com/Klipper3d/klipper
 branch: master
-method: https
 
 [moonraker]
-repository_url: https://github.com/Arksine/moonraker
+repo_url: https://github.com/Arksine/moonraker
 branch: master
-method: https
 
 [mainsail]
 port: 80
 unstable_releases: False
 
 [fluidd]
-port: 80
+port: 81
 unstable_releases: False

docs/changelog.md

@@ -2,6 +2,47 @@
 
 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!
 Mobileraker is a free and Open Source Android and iOS App for Klipper, utilizing the Moonraker API, allowing you

kiauh.sh

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

kiauh/__init__.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -13,7 +11,5 @@ import sys
 from pathlib import Path
 
 PROJECT_ROOT = Path(__file__).resolve().parent.parent
-KIAUH_CFG = PROJECT_ROOT.joinpath("kiauh.cfg")
-
 APPLICATION_ROOT = Path(__file__).resolve().parent
 sys.path.append(str(APPLICATION_ROOT))

kiauh/components/crowsnest/__init__.py

@@ -0,0 +1,30 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+
+from core.backup_manager import BACKUP_ROOT_DIR
+from core.constants import SYSTEMD
+
+# 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

@@ -0,0 +1,178 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import shutil
+import time
+from pathlib import Path
+from subprocess import CalledProcessError, run
+from typing import List
+
+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.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.git_utils import (
+    git_clone_wrapper,
+    git_pull_wrapper,
+)
+from utils.input_utils import get_confirm
+from utils.instance_utils import get_instances
+from utils.sys_utils import (
+    cmd_sysctl_service,
+    parse_packages_from_file,
+)
+
+
+def install_crowsnest() -> None:
+    # Step 1: Clone crowsnest repo
+    git_clone_wrapper(CROWSNEST_REPO, CROWSNEST_DIR, "master")
+
+    # Step 2: Install dependencies
+    check_install_dependencies({"make"})
+
+    # Step 3: Check for Multi Instance
+    instances: List[Klipper] = get_instances(Klipper)
+
+    if len(instances) > 1:
+        print_multi_instance_warning(instances)
+
+        if not get_confirm("Do you want to continue with the installation?"):
+            Logger.print_info("Crowsnest installation aborted!")
+            return
+
+        Logger.print_status("Launching crowsnest's install configurator ...")
+        time.sleep(3)
+        configure_multi_instance()
+
+    # Step 4: Launch crowsnest installer
+    Logger.print_status("Launching crowsnest installer ...")
+    Logger.print_info("Installer will prompt you for sudo password!")
+    try:
+        run(
+            f"sudo make install BASE_USER={CURRENT_USER}",
+            cwd=CROWSNEST_DIR,
+            shell=True,
+            check=True,
+        )
+    except CalledProcessError as e:
+        Logger.print_error(f"Something went wrong! Please try again...\n{e}")
+        return
+
+
+def print_multi_instance_warning(instances: List[Klipper]) -> None:
+    Logger.print_dialog(
+        DialogType.WARNING,
+        [
+            "Multi instance install detected!",
+            "\n\n",
+            "Crowsnest is NOT designed to support multi instances. A workaround "
+            "for this is to choose the most used instance as a 'master' and use "
+            "this instance to set up your 'crowsnest.conf' and steering it's service.",
+            "\n\n",
+            "The following instances were found:",
+            *[f"● {instance.data_dir.name}" for instance in instances],
+        ],
+    )
+
+
+def configure_multi_instance() -> None:
+    try:
+        run(
+            "make config",
+            cwd=CROWSNEST_DIR,
+            shell=True,
+            check=True,
+        )
+    except CalledProcessError as e:
+        Logger.print_error(f"Something went wrong! Please try again...\n{e}")
+        if CROWSNEST_MULTI_CONFIG.exists():
+            Path.unlink(CROWSNEST_MULTI_CONFIG)
+        return
+
+    if not CROWSNEST_MULTI_CONFIG.exists():
+        Logger.print_error("Generating .config failed, installation aborted")
+
+
+def update_crowsnest() -> None:
+    try:
+        cmd_sysctl_service(CROWSNEST_SERVICE_NAME, "stop")
+
+        if not CROWSNEST_DIR.exists():
+            git_clone_wrapper(CROWSNEST_REPO, CROWSNEST_DIR, "master")
+        else:
+            Logger.print_status("Updating Crowsnest ...")
+
+            settings = KiauhSettings()
+            if settings.kiauh.backup_before_update:
+                bm = BackupManager()
+                bm.backup_directory(
+                    CROWSNEST_DIR.name,
+                    source=CROWSNEST_DIR,
+                    target=CROWSNEST_BACKUP_DIR,
+                )
+
+            git_pull_wrapper(CROWSNEST_REPO, CROWSNEST_DIR)
+
+            deps = parse_packages_from_file(CROWSNEST_INSTALL_SCRIPT)
+            check_install_dependencies({*deps})
+
+        cmd_sysctl_service(CROWSNEST_SERVICE_NAME, "restart")
+
+        Logger.print_ok("Crowsnest updated successfully.", end="\n\n")
+    except CalledProcessError as e:
+        Logger.print_error(f"Something went wrong! Please try again...\n{e}")
+        return
+
+
+def get_crowsnest_status() -> ComponentStatus:
+    files = [
+        CROWSNEST_BIN_FILE,
+        CROWSNEST_LOGROTATE_FILE,
+        CROWSNEST_SERVICE_FILE,
+    ]
+    return get_install_status(CROWSNEST_DIR, files=files)
+
+
+def remove_crowsnest() -> None:
+    if not CROWSNEST_DIR.exists():
+        Logger.print_info("Crowsnest does not seem to be installed! Skipping ...")
+        return
+
+    try:
+        run(
+            "make uninstall",
+            cwd=CROWSNEST_DIR,
+            shell=True,
+            check=True,
+        )
+    except CalledProcessError as e:
+        Logger.print_error(f"Something went wrong! Please try again...\n{e}")
+        return
+
+    Logger.print_status("Removing crowsnest directory ...")
+    shutil.rmtree(CROWSNEST_DIR)
+    Logger.print_ok("Directory removed!")

kiauh/components/klipper/__init__.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -15,10 +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")
+
-DEFAULT_KLIPPER_REPO_URL = "https://github.com/Klipper3D/klipper"
+# 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

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,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 core.logger import Logger
-from utils.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):
+@dataclass(repr=True)
-    @classmethod
+class Klipper:
-    def blacklist(cls) -> List[str]:
+    suffix: str
-        return ["None", "mcu"]
+    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 = ""):
+    def __post_init__(self):
-        super().__init__(instance_type=self, suffix=suffix)
+        self.base: BaseInstance = BaseInstance(Klipper, self.suffix)
-        self.klipper_dir: Path = KLIPPER_DIR
+        self.base.log_file_name = self.log_file_name
-        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")
 
-    @property
+        self.service_file_path: Path = get_service_file_path(Klipper, self.suffix)
-    def cfg_file(self) -> Path:
+        self.data_dir: Path = get_data_dir(Klipper, self.suffix)
-        return self._cfg_file
+        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)
-    @property
+        self.serial: Path = self.base.comms_dir.joinpath(KLIPPER_SERIAL_NAME)
-    def log(self) -> Path:
+        self.uds: Path = self.base.comms_dir.joinpath(KLIPPER_UDS_NAME)
-        return self._log
-
-    @property
-    def serial(self) -> Path:
-        return self._serial
-
-    @property
-    def uds(self) -> Path:
-        return self._uds
 
     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()
+            create_folders(self.base.base_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)
 
-        except subprocess.CalledProcessError as e:
+            create_service_file(
-            Logger.print_error(
+                name=self.service_file_path.name,
-                f"Error creating service file {service_file_target}: {e}"
+                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:
+    def _prep_service_file_content(self) -> str:
-        service_file = self.get_service_file_name(extension=True)
+        template = KLIPPER_SERVICE_TEMPLATE
-        service_file_path = self.get_service_file_path()
-
-        Logger.print_status(f"Deleting Klipper Instance: {service_file}")
 
         try:
-            command = ["sudo", "rm", "-f", service_file_path]
+            with open(template, "r") as template_file:
-            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:
                 template_content = template_file.read()
         except FileNotFoundError:
-            Logger.print_error(
+            Logger.print_error(f"Unable to open {template} - File not found")
-                f"Unable to open {service_template_path} - File not found"
-            )
             raise
-        service_content = template_content.replace("%USER%", self.user)
+
-        service_content = service_content.replace(
+        service_content = template_content.replace(
-            "%KLIPPER_DIR%", str(self.klipper_dir)
+            "%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(
+            Logger.print_error(f"Unable to open {template} - File not found")
-                f"Unable to open {env_template_file_path} - 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(
-        env_file_content = env_file_content.replace("%LOG%", str(self.log))
+            "%SERIAL%",
-        env_file_content = env_file_content.replace("%UDS%", str(self.uds))
+            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

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -10,50 +8,75 @@
 # ======================================================================= #
 
 import textwrap
+from enum import Enum, unique
 from typing import List
 
-from core.instance_manager.base_instance import BaseInstance
+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_GREEN, RESET_FORMAT, COLOR_YELLOW, COLOR_CYAN
+from utils.instance_type import InstanceType
+
+
+@unique
+class DisplayType(Enum):
+    SERVICE_NAME = "SERVICE_NAME"
+    PRINTER_NAME = "PRINTER_NAME"
 
 
 def print_instance_overview(
-    instances: List[BaseInstance], show_index=False, show_select_all=False
+    instances: List[InstanceType],
-):
+    display_type: DisplayType = DisplayType.SERVICE_NAME,
-    headline = f"{COLOR_GREEN}The following Klipper instances were found:{RESET_FORMAT}"
+    show_headline=True,
-    dialog = textwrap.dedent(
+    show_index=False,
-        f"""
+    start_index=0,
-        /=======================================================\\
+    show_select_all=False,
-        |{headline:^64}|
+) -> None:
-        |-------------------------------------------------------|
+    dialog = "╔═══════════════════════════════════════════════════════╗\n"
-        """
+    if show_headline:
-    )[1:]
+        d_type = (
+            "Klipper instances"
+            if display_type is DisplayType.SERVICE_NAME
+            else "printer directories"
+        )
+        headline = f"{COLOR_GREEN}The following {d_type} were found:{RESET_FORMAT}"
+        dialog += f"║{headline:^64}║\n"
+        dialog += "╟───────────────────────────────────────────────────────╢\n"
 
     if show_select_all:
         select_all = f"{COLOR_YELLOW}a) Select all{RESET_FORMAT}"
-        dialog += f"| {select_all:<63}|\n"
+        dialog += f"║ {select_all:<63}║\n"
-        dialog += "|                                                       |\n"
+        dialog += "║                                                       ║\n"
 
     for i, s in enumerate(instances):
-        line = f"{COLOR_CYAN}{f'{i})' if show_index else '●'} {s.get_service_file_name()}{RESET_FORMAT}"
+        if display_type is DisplayType.SERVICE_NAME:
-        dialog += f"| {line:<63}|\n"
+            name = s.service_file_path.stem
+        else:
+            name = s.data_dir
+        line = f"{COLOR_CYAN}{f'{i + start_index})' if show_index else '●'} {name}{RESET_FORMAT}"
+        dialog += f"║ {line:<63}║\n"
+    dialog += "╟───────────────────────────────────────────────────────╢\n"
 
     print(dialog, end="")
     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(
         f"""
-        /=======================================================\\
+        ╔═══════════════════════════════════════════════════════╗
-        | Please select the number of Klipper instances to set  |
+        ║ Please select the number of Klipper instances to set  ║
-        | up. The number of Klipper instances will determine    |
+        ║ up. The number of Klipper instances will determine    ║
-        | the amount of printers you can run from this host.    |
+        ║ the amount of printers you can run from this host.    ║
-        |                                                       |
+        ║                                                       ║
-        | {line1:<63}|
+        ║ {line1:<63}║
-        | {line2:<63}|
+        ║ {line2:<63}║
+        ╟───────────────────────────────────────────────────────╢
         """
     )[1:]
 
@@ -61,76 +84,31 @@ 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? ║
-        | If skipped, each instance will get an index assigned  |
+        ║                                                       ║
-        | in ascending order, starting at index '1'.            |
+        ║ Assigning a custom name will create a Klipper service ║
-        |                                                       |
+        ║ and a printer directory with the chosen name.         ║
-        | {line1:<63}|
+        ║                                                       ║
-        | {line2:<63}|
+        ║ 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 '1' in case of a new  ║
+        ║ installation. Otherwise, the index will be derived    ║
+        ║ from amount of already existing instances.            ║
+        ║                                                       ║
+        ║ {line1:<63}║
+        ║ {line2:<63}║
+        ╟───────────────────────────────────────────────────────╢
         """
     )[1:]
 
     print(dialog, end="")
     print_back_footer()
-
-
-def print_missing_usergroup_dialog(missing_groups) -> None:
-    line1 = f"{COLOR_YELLOW}WARNING: Your current user is not in group:{RESET_FORMAT}"
-    line2 = f"{COLOR_CYAN}● tty{RESET_FORMAT}"
-    line3 = f"{COLOR_CYAN}● dialout{RESET_FORMAT}"
-    line4 = f"{COLOR_YELLOW}INFO:{RESET_FORMAT}"
-    line5 = f"{COLOR_YELLOW}Relog required for group assignments to take effect!{RESET_FORMAT}"
-
-    dialog = textwrap.dedent(
-        f"""
-        /=======================================================\\
-        | {line1:<63}|
-        """
-    )[1:]
-
-    if "tty" in missing_groups:
-        dialog += f"| {line2:<63}|\n"
-    if "dialout" in missing_groups:
-        dialog += f"| {line3:<63}|\n"
-
-    dialog += textwrap.dedent(
-        f"""
-        |                                                       |
-        | It is possible that you won't be able to successfully |
-        | connect and/or flash the controller board without     |
-        | your user being a member of that group.               |
-        | If you want to add the current user to the group(s)   |
-        | listed above, answer with 'Y'. Else skip with 'n'.    |
-        |                                                       |
-        | {line4:<63}|
-        | {line5:<63}|
-        \\=======================================================/
-        """
-    )[1:]
-
-    print(dialog, end="")
-
-
-def print_update_warn_dialog() -> None:
-    line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
-    line2 = f"{COLOR_YELLOW}Do NOT continue if there are ongoing prints running!{RESET_FORMAT}"
-    line3 = f"{COLOR_YELLOW}All Klipper instances will be restarted during the {RESET_FORMAT}"
-    line4 = f"{COLOR_YELLOW}update process and ongoing prints WILL FAIL.{RESET_FORMAT}"
-    dialog = textwrap.dedent(
-        f"""
-        /=======================================================\\
-        | {line1:<63}|
-        | {line2:<63}|
-        | {line3:<63}|
-        | {line4:<63}|
-        \\=======================================================/
-        """
-    )[1:]
-
-    print(dialog, end="")

kiauh/components/klipper/klipper_remove.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,125 +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
-from typing import List, Union
 
 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.filesystem_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.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:
+        if klipper_instances:
-            instances_to_remove = select_instances_to_remove(im.instances)
+            instances_to_remove = select_instances_to_remove(klipper_instances)
-            remove_instances(im, instances_to_remove)
+            remove_instances(instances_to_remove)
         else:
             Logger.print_info("No Klipper Services installed! Skipped ...")
 
-    if (remove_dir or remove_env) and im.instances:
+    if (remove_dir or remove_env) and unit_file_exists("klipper", suffix="service"):
-        Logger.print_warn("There are still other Klipper services installed!")
+        Logger.print_info("There are still other Klipper services installed:")
-        Logger.print_warn("Therefor the following parts cannot be removed:")
+        Logger.print_info(f"● '{KLIPPER_DIR}' was not removed.", prefix=False)
-        Logger.print_warn(
+        Logger.print_info(f"● '{KLIPPER_ENV_DIR}' was not removed.", prefix=False)
-            """
-            ● Klipper local repository
-            ● Klipper Python environment
-            """,
-            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()
+            run_remove_routines(KLIPPER_ENV_DIR)
-
-    # delete klipper logs of all instances
-    if delete_logs:
-        Logger.print_status("Removing all Klipper logs ...")
-        delete_klipper_logs(im.instances)
 
 
-def select_instances_to_remove(
+def select_instances_to_remove(instances: List[Klipper]) -> List[Klipper] | None:
-    instances: List[Klipper],
+    start_index = 1
-) -> Union[List[Klipper], None]:
+    options = [str(i + start_index) for i in range(len(instances))]
-    print_instance_overview(instances, True, True)
+    options.extend(["a", "b"])
-
+    instance_map = {options[i]: instances[i] for i in range(len(instances))}
-    options = [str(i) for i in range(len(instances))]
-    options.extend(["a", "A", "b", "B"])
 
+    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_map[selection])
-        instances_to_remove.append(instance)
 
     return instances_to_remove
 
 
 def remove_instances(
-    instance_manager: InstanceManager,
+    instance_list: List[Klipper] | None,
-    instance_list: List[Klipper],
 ) -> None:
+    if not instance_list:
+        return
+
     for instance in instance_list:
-        Logger.print_status(f"Removing instance {instance.get_service_file_name()} ...")
+        Logger.print_status(f"Removing instance {instance.service_file_path.stem} ...")
-        instance_manager.current_instance = instance
+        InstanceManager.remove(instance)
-        instance_manager.stop_instance()
+        delete_klipper_env_file(instance)
-        instance_manager.disable_instance()
-        instance_manager.delete_instance()
-
-    instance_manager.reload_daemon()
 
 
-def remove_klipper_dir() -> None:
+def delete_klipper_env_file(instance: Klipper):
-    if not KLIPPER_DIR.exists():
+    Logger.print_status(f"Remove '{instance.env_file}'")
-        Logger.print_info(f"'{KLIPPER_DIR}' does not exist. Skipped ...")
+    if not instance.env_file.exists():
+        msg = f"Env file in {instance.base.sysd_dir} not found. Skipped ..."
+        Logger.print_info(msg)
         return
-
+    run_remove_routines(instance.env_file)
-    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)

kiauh/components/klipper/klipper_setup.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,97 +6,119 @@
 #                                                                         #
 #  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 kiauh import KIAUH_CFG
 from components.klipper import (
     EXIT_KLIPPER_SETUP,
-    DEFAULT_KLIPPER_REPO_URL,
     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_update_warn_dialog
+from components.klipper.klipper_dialogs import (
+    print_select_custom_name_dialog,
+)
 from components.klipper.klipper_utils import (
-    handle_disruptive_system_packages,
+    assign_custom_name,
-    check_user_groups,
-    handle_to_multi_instance_conversion,
-    create_example_printer_cfg,
-    add_to_existing,
-    get_install_count,
-    init_name_scheme,
-    check_is_single_to_multi_conversion,
-    update_name_scheme,
-    handle_instance_naming,
     backup_klipper_dir,
+    check_user_groups,
+    create_example_printer_cfg,
+    get_install_count,
+    handle_disruptive_system_packages,
 )
 from components.moonraker.moonraker import Moonraker
-from core.config_manager.config_manager import ConfigManager
+from components.webui_client.client_utils import (
+    get_existing_clients,
+)
 from core.instance_manager.instance_manager import InstanceManager
-from core.repo_manager.repo_manager import RepoManager
+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 Logger
+from utils.instance_utils import get_instances
-from utils.system_utils import (
+from utils.sys_utils import (
-    parse_packages_from_file,
+    cmd_sysctl_manage,
+    cmd_sysctl_service,
     create_python_venv,
     install_python_requirements,
-    update_system_package_lists,
+    parse_packages_from_file,
-    install_system_packages,
 )
 
 
 def install_klipper() -> None:
-    kl_im = InstanceManager(Klipper)
+    Logger.print_status("Installing Klipper ...")
 
-    # ask to add new instances, if there are existing ones
+    klipper_list: List[Klipper] = get_instances(Klipper)
-    if kl_im.instances and not add_to_existing():
+    moonraker_list: List[Moonraker] = get_instances(Moonraker)
-        Logger.print_status(EXIT_KLIPPER_SETUP)
+    match_moonraker: bool = False
-        return
 
-    install_count = get_install_count()
+    # if there are more moonraker instances than klipper instances, ask the user to
-    if install_count is None:
+    # match the klipper instance count to the count of moonraker instances with the same suffix
-        Logger.print_status(EXIT_KLIPPER_SETUP)
+    if len(moonraker_list) > len(klipper_list):
-        return
+        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
+    install_count, name_dict = get_install_count_and_name_dict(
-    name_dict = {c: "" for c in range(len(kl_im.instances) + install_count)}
+        klipper_list, moonraker_list
-    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
     )
 
-    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:
+        run_klipper_setup(klipper_list, name_dict, create_example_cfg)
-            setup_klipper_prerequesites()
+    except Exception as e:
-
+        Logger.print_error(e)
-        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
-
-        kl_im.reload_daemon()
-
-    except Exception:
         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,79 +126,114 @@ def install_klipper() -> None:
     check_user_groups()
 
 
-def setup_klipper_prerequesites() -> None:
+def handle_instance_names(
-    cm = ConfigManager(cfg_file=KIAUH_CFG)
+    install_count: int, name_dict: Dict[int, str], custom_names: bool
-    repo = str(cm.get_value("klipper", "repository_url") or DEFAULT_KLIPPER_REPO_URL)
+) -> None:
-    branch = str(cm.get_value("klipper", "branch") or "master")
+    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)
 
-    repo_manager = RepoManager(
+
-        repo=repo,
+def get_install_count_and_name_dict(
-        branch=branch,
+    klipper_list: List[Klipper], moonraker_list: List[Moonraker]
-        target_dir=KLIPPER_DIR,
+) -> Tuple[int, Dict[int, str]]:
-    )
+    install_count: int | None
-    repo_manager.clone_repo()
+    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
+    branch = settings.klipper.branch
+
+    git_clone_wrapper(repo, KLIPPER_DIR, branch)
 
     # install klipper dependencies and create python virtualenv
     try:
-        install_klipper_packages(KLIPPER_DIR)
+        install_klipper_packages()
-        create_python_venv(KLIPPER_ENV_DIR)
+        if create_python_venv(KLIPPER_ENV_DIR):
-        install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQUIREMENTS_TXT)
+            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:
+def install_klipper_packages() -> None:
-    script = klipper_dir.joinpath("scripts/install-debian.sh")
+    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")
 
-    update_system_package_lists(silent=False)
+    check_install_dependencies({*packages})
-    install_system_packages(packages)
 
 
 def update_klipper() -> None:
-    print_update_warn_dialog()
+    Logger.print_dialog(
+        DialogType.WARNING,
+        [
+            "Do NOT continue if there are ongoing prints running!",
+            "All Klipper instances will be restarted during the update process and "
+            "ongoing prints WILL FAIL.",
+        ],
+    )
+
     if not get_confirm("Update Klipper now?"):
         return
 
-    cm = ConfigManager(cfg_file=KIAUH_CFG)
+    settings = KiauhSettings()
-    if cm.get_value("kiauh", "backup_before_update"):
+    if settings.kiauh.backup_before_update:
         backup_klipper_dir()
 
-    instance_manager = InstanceManager(Klipper)
+    instances = get_instances(Klipper)
-    instance_manager.stop_all_instance()
+    InstanceManager.stop_all(instances)
 
-    repo = str(cm.get_value("klipper", "repository_url") or DEFAULT_KLIPPER_REPO_URL)
+    git_pull_wrapper(repo=settings.klipper.repo_url, target_dir=KLIPPER_DIR)
-    branch = str(cm.get_value("klipper", "branch") or "master")
-
-    repo_manager = RepoManager(
-        repo=repo,
-        branch=branch,
-        target_dir=KLIPPER_DIR,
-    )
-    repo_manager.pull_repo()
 
     # 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:
+def use_custom_names_or_go_back() -> bool | None:
-    kl_im = InstanceManager(Klipper)
+    print_select_custom_name_dialog()
-    new_instance = Klipper(suffix=name)
+    _input: bool | None = get_confirm(
-    kl_im.current_instance = new_instance
+        "Assign custom names?",
-    kl_im.create_instance()
+        False,
-    kl_im.enable_instance()
+        allow_go_back=True,
-    if create_example_cfg:
+    )
-        create_example_printer_cfg(new_instance)
+    return _input
-    kl_im.start_instance()
+
+
+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

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,190 +6,105 @@
 #                                                                         #
 #  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
-import subprocess
+from subprocess import CalledProcessError, run
-import textwrap
+from typing import Dict, List
-from pathlib import Path
-from typing import List, Union, Literal, Dict
 
 from components.klipper import (
-    MODULE_PATH,
+    KLIPPER_BACKUP_DIR,
     KLIPPER_DIR,
     KLIPPER_ENV_DIR,
-    KLIPPER_BACKUP_DIR,
+    MODULE_PATH,
 )
 from components.klipper.klipper import Klipper
 from components.klipper.klipper_dialogs import (
-    print_missing_usergroup_dialog,
     print_instance_overview,
     print_select_instance_count_dialog,
-    print_select_custom_name_dialog,
 )
-from components.moonraker.moonraker import Moonraker
+from components.webui_client.base_data import BaseWebClient
-from components.moonraker.moonraker_utils import moonraker_to_multi_conversion
+from components.webui_client.client_config.client_config_setup import (
+    create_client_config_symlink,
+)
 from core.backup_manager.backup_manager import BackupManager
-from core.config_manager.config_manager import ConfigManager
+from core.constants import CURRENT_USER
-from core.instance_manager.base_instance import BaseInstance
+from core.instance_manager.base_instance import SUFFIX_BLACKLIST
-from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
-from core.instance_manager.name_scheme import NameScheme
+from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
-from core.repo_manager.repo_manager import RepoManager
+    SimpleConfigParser,
-from utils.common import get_install_status_common
+)
-from utils.constants import CURRENT_USER
+from core.types import ComponentStatus
-from utils.input_utils import get_confirm, get_string_input, get_number_input
+from utils.common import get_install_status
-from utils.logger import Logger
+from utils.input_utils import get_confirm, get_number_input, get_string_input
-from utils.system_utils import mask_system_service
+from utils.instance_utils import get_instances
+from utils.sys_utils import cmd_sysctl_service
 
 
-def get_klipper_status() -> Dict[
+def get_klipper_status() -> ComponentStatus:
-    Literal["status", "status_code", "instances", "repo", "local", "remote"],
+    return get_install_status(KLIPPER_DIR, KLIPPER_ENV_DIR, Klipper)
-    Union[str, int],
-]:
-    status = get_install_status_common(Klipper, KLIPPER_DIR, KLIPPER_ENV_DIR)
-    return {
-        "status": status.get("status"),
-        "status_code": status.get("status_code"),
-        "instances": status.get("instances"),
-        "repo": RepoManager.get_repo_name(KLIPPER_DIR),
-        "local": RepoManager.get_local_commit(KLIPPER_DIR),
-        "remote": RepoManager.get_remote_commit(KLIPPER_DIR),
-    }
 
 
-def check_is_multi_install(
+def add_to_existing() -> bool | None:
-    existing_instances: List[Klipper], install_count: int
+    kl_instances: List[Klipper] = get_instances(Klipper)
-) -> 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
     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{' additional' if len(kl_instances) > 0 else ''} Klipper instances to set up"
+    question = (
-    return get_number_input(question, 1, default=1, allow_go_back=True)
+        f"Number of"
+        f"{' additional' if len(kl_instances) > 0 else ''} "
+        f"Klipper instances to set up"
+    )
+    _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}"
+    pattern = r"^[a-zA-Z0-9]+$"
-    name_dict[key] = get_string_input(question, exclude=existing_names)
+
+    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:
+def check_user_groups() -> None:
-    Logger.print_status("Converting single instance to multi instances ...")
+    user_groups = [grp.getgrgid(gid).gr_name for gid in os.getgroups()]
-    klipper_to_multi_conversion(new_name)
+    missing_groups = [g for g in ["tty", "dialout"] if g not in user_groups]
-    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
-    # remove the old single instance
-    im.stop_instance()
-    im.disable_instance()
-    im.delete_instance()
-    # create a new klipper instance with the new name
-    im.current_instance = Klipper(suffix=new_name)
-    new_data_dir: Path = im.current_instance.data_dir
-
-    # rename the old data dir and use it for the new instance
-    Logger.print_status(f"Rename '{old_data_dir}' to '{new_data_dir}' ...")
-    if not new_data_dir.is_dir():
-        old_data_dir.rename(new_data_dir)
-    else:
-        Logger.print_info(f"'{new_data_dir}' already exist. Skipped ...")
-
-    im.create_instance()
-    im.enable_instance()
-    im.start_instance()
-
-
-def check_user_groups():
-    current_groups = [grp.getgrgid(gid).gr_name for gid in os.getgroups()]
-
-    missing_groups = []
-    if "tty" not in current_groups:
-        missing_groups.append("tty")
-    if "dialout" not in current_groups:
-        missing_groups.append("dialout")
 
     if not missing_groups:
         return
 
-    print_missing_usergroup_dialog(missing_groups)
+    Logger.print_dialog(
+        DialogType.ATTENTION,
+        [
+            "Your current user is not in group:",
+            *[f"● {g}" for g in missing_groups],
+            "\n\n",
+            "It is possible that you won't be able to successfully connect and/or "
+            "flash the controller board without your user being a member of that "
+            "group. If you want to add the current user to the group(s) listed above, "
+            "answer with 'Y'. Else skip with 'n'.",
+            "\n\n",
+            "INFO:",
+            "Relog required for group assignments to take effect!",
+        ],
+    )
+
     if not get_confirm(f"Add user '{CURRENT_USER}' to group(s) now?"):
         log = "Skipped adding user to required groups. You might encounter issues."
         Logger.warn(log)
@@ -201,9 +114,9 @@ def check_user_groups():
         for group in missing_groups:
             Logger.print_status(f"Adding user '{CURRENT_USER}' to group {group} ...")
             command = ["sudo", "usermod", "-a", "-G", group, CURRENT_USER]
-            subprocess.run(command, check=True)
+            run(command, check=True)
             Logger.print_ok(f"Group {group} assigned to user '{CURRENT_USER}'.")
-    except subprocess.CalledProcessError as e:
+    except CalledProcessError as e:
         Logger.print_error(f"Unable to add user to usergroups: {e}")
         raise
 
@@ -215,13 +128,13 @@ def handle_disruptive_system_packages() -> None:
     services = []
 
     command = ["systemctl", "is-enabled", "brltty"]
-    brltty_status = subprocess.run(command, capture_output=True, text=True)
+    brltty_status = run(command, capture_output=True, text=True)
 
     command = ["systemctl", "is-enabled", "brltty-udev"]
-    brltty_udev_status = subprocess.run(command, capture_output=True, text=True)
+    brltty_udev_status = run(command, capture_output=True, text=True)
 
     command = ["systemctl", "is-enabled", "ModemManager"]
-    modem_manager_status = subprocess.run(command, capture_output=True, text=True)
+    modem_manager_status = run(command, capture_output=True, text=True)
 
     if "enabled" in brltty_status.stdout:
         services.append("brltty")
@@ -232,37 +145,22 @@ def handle_disruptive_system_packages() -> None:
 
     for service in services if services else []:
         try:
-            log = f"{service} service detected! Masking {service} service ..."
+            cmd_sysctl_service(service, "mask")
-            Logger.print_status(log)
+        except CalledProcessError:
-            mask_system_service(service)
+            Logger.print_dialog(
-            Logger.print_ok(f"{service} service masked!")
+                DialogType.WARNING,
-        except subprocess.CalledProcessError:
+                [
-            warn_msg = textwrap.dedent(
+                    f"KIAUH was unable to mask the {service} system service. "
-                f"""
+                    "Please fix the problem manually. Otherwise, this may have "
-                KIAUH was unable to mask the {service} system service. 
+                    "undesirable effects on the operation of Klipper."
-                Please fix the problem manually. Otherwise, this may have 
+                ],
-                undesirable effects on the operation of Klipper.
+            )
-                """
-            )[1:]
-            Logger.print_warn(warn_msg)
 
 
-def detect_name_scheme(instance_list: List[BaseInstance]) -> NameScheme:
+def create_example_printer_cfg(
-    pattern = re.compile("^\d+$")
+    instance: Klipper, clients: List[BaseWebClient] | None = None
-    for instance in instance_list:
+) -> None:
-        if not pattern.match(instance.suffix):
+    Logger.print_status(f"Creating example printer.cfg in '{instance.base.cfg_dir}'")
-            return NameScheme.CUSTOM
-
-    return NameScheme.INDEX
-
-
-def get_highest_index(instance_list: List[Klipper]) -> int:
-    indices = [int(instance.suffix.split("-")[-1]) for instance in instance_list]
-    return max(indices)
-
-
-def create_example_printer_cfg(instance: Klipper) -> None:
-    Logger.print_status(f"Creating example printer.cfg in '{instance.cfg_dir}'")
     if instance.cfg_file.is_file():
         Logger.print_info(f"'{instance.cfg_file}' already exists.")
         return
@@ -275,10 +173,21 @@ def create_example_printer_cfg(instance: Klipper) -> None:
         Logger.print_error(f"Unable to create example printer.cfg:\n{e}")
         return
 
-    cm = ConfigManager(target)
+    scp = SimpleConfigParser()
-    cm.set_value("virtual_sdcard", "path", str(instance.gcodes_dir))
+    scp.read_file(target)
-    cm.write_config()
+    scp.set_option("virtual_sdcard", "path", str(instance.base.gcodes_dir))
-    Logger.print_ok(f"Example printer.cfg created in '{instance.cfg_dir}'")
+
+    # include existing client configs in the example config
+    if clients is not None and len(clients) > 0:
+        for c in clients:
+            client_config = c.client_config
+            section = client_config.config_section
+            scp.add_section(section=section)
+            create_client_config_symlink(client_config, [instance])
+
+    scp.write_file(target)
+
+    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

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,34 +6,41 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
+from typing import Type
 
 from components.klipper import klipper_remove
-from core.menus import BACK_HELP_FOOTER
+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 RESET_FORMAT, COLOR_RED, COLOR_CYAN
 
 
 # noinspection PyUnusedLocal
 class KlipperRemoveMenu(BaseMenu):
-    def __init__(self):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
-        super().__init__(
+        super().__init__()
-            header=False,
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
-            options={
+        self.footer_type = FooterType.BACK
-                "0": self.toggle_all,
-                "1": self.toggle_remove_klipper_service,
-                "2": self.toggle_remove_klipper_dir,
-                "3": self.toggle_remove_klipper_env,
-                "4": self.toggle_delete_klipper_logs,
-                "c": self.run_removal_process,
-            },
-            footer_type=BACK_HELP_FOOTER,
-        )
         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: Type[BaseMenu] | None) -> None:
+        from core.menus.remove_menu import RemoveMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else RemoveMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "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:
         header = " [ Remove Klipper ] "
@@ -46,32 +51,31 @@ 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"""
-            /=======================================================\\
+            ╔═══════════════════════════════════════════════════════╗
-            | {color}{header:~^{count}}{RESET_FORMAT} |
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
-            |-------------------------------------------------------|
+            ╟───────────────────────────────────────────────────────╢
-            | Enter a number and hit enter to select / deselect     |
+            ║ Enter a number and hit enter to select / deselect     ║
-            | the specific option for removal.                      |
+            ║ the specific option for removal.                      ║
-            |-------------------------------------------------------|
+            ╟───────────────────────────────────────────────────────╢
-            |  0) Select everything                                 |
+            ║  a) {self._get_selection_state_str():37}             ║
-            |-------------------------------------------------------|
+            ╟───────────────────────────────────────────────────────╢
-            |  1) {o1} Remove Service                                |
+            ║  1) {o1} Remove Service                                ║
-            |  2) {o2} Remove Local Repository                       |
+            ║  2) {o2} Remove Local Repository                       ║
-            |  3) {o3} Remove Python Environment                     |
+            ║  3) {o3} Remove Python Environment                     ║
-            |  4) {o4} Delete all Log-Files                          |
+            ╟───────────────────────────────────────────────────────╢
-            |-------------------------------------------------------|
+            ║  C) Continue                                          ║
-            |  C) Continue                                          |
+            ╟───────────────────────────────────────────────────────╢
             """
         )[1:]
         print(menu, end="")
 
     def toggle_all(self, **kwargs) -> None:
-        self.remove_klipper_service = True
+        self.selection_state = not self.selection_state
-        self.remove_klipper_dir = True
+        self.remove_klipper_service = self.selection_state
-        self.remove_klipper_env = True
+        self.remove_klipper_dir = self.selection_state
-        self.delete_klipper_logs = True
+        self.remove_klipper_env = self.selection_state
 
     def toggle_remove_klipper_service(self, **kwargs) -> None:
         self.remove_klipper_service = not self.remove_klipper_service
@@ -82,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)
@@ -100,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/__init__.py

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

kiauh/components/klipper_firmware/firmware_utils.py

@@ -0,0 +1,177 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from subprocess import PIPE, STDOUT, CalledProcessError, Popen, check_output, run
+from typing import List
+
+from components.klipper import KLIPPER_DIR
+from components.klipper.klipper import Klipper
+from components.klipper_firmware import SD_FLASH_SCRIPT
+from components.klipper_firmware.flash_options import (
+    FlashMethod,
+    FlashOptions,
+)
+from core.instance_manager.instance_manager import InstanceManager
+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: bool = target.exists()
+
+    f1 = "klipper.elf.hex"
+    f2 = "klipper.elf"
+    f3 = "klipper.bin"
+    f4 = "klipper.uf2"
+    fw_file_exists: bool = (
+        target.joinpath(f1).exists() and target.joinpath(f2).exists()
+    ) or target.joinpath(f3).exists() or target.joinpath(f4).exists()
+
+    return target_exists and fw_file_exists
+
+
+def find_usb_device_by_id() -> List[str]:
+    try:
+        command = "find /dev/serial/by-id/* 2>/dev/null"
+        output = check_output(command, shell=True, text=True)
+        return output.splitlines()
+    except CalledProcessError as e:
+        Logger.print_error("Unable to find a USB device!")
+        Logger.print_error(e, prefix=False)
+        return []
+
+
+def find_uart_device() -> List[str]:
+    try:
+        command = '"find /dev -maxdepth 1 -regextype posix-extended -regex "^\/dev\/tty(AMA0|S0)$" 2>/dev/null"'
+        output = check_output(command, shell=True, text=True)
+        return output.splitlines()
+    except CalledProcessError as e:
+        Logger.print_error("Unable to find a UART device!")
+        Logger.print_error(e, prefix=False)
+        return []
+
+
+def find_usb_dfu_device() -> List[str]:
+    try:
+        command = '"lsusb | grep "DFU" | cut -d " " -f 6 2>/dev/null"'
+        output = check_output(command, shell=True, text=True)
+        return output.splitlines()
+    except CalledProcessError as e:
+        Logger.print_error("Unable to find a USB DFU device!")
+        Logger.print_error(e, prefix=False)
+        return []
+
+
+def get_sd_flash_board_list() -> List[str]:
+    if not KLIPPER_DIR.exists() or not SD_FLASH_SCRIPT.exists():
+        return []
+
+    try:
+        cmd = f"{SD_FLASH_SCRIPT} -l"
+        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:
+    Logger.print_status(f"Flashing '{flash_options.selected_mcu}' ...")
+    try:
+        if not flash_options.flash_method:
+            raise Exception("Missing value for flash_method!")
+        if not flash_options.flash_command:
+            raise Exception("Missing value for flash_command!")
+        if not flash_options.selected_mcu:
+            raise Exception("Missing value for selected_mcu!")
+        if not flash_options.connection_type:
+            raise Exception("Missing value for connection_type!")
+        if (
+            flash_options.flash_method == FlashMethod.SD_CARD
+            and not flash_options.selected_board
+        ):
+            raise Exception("Missing value for selected_board!")
+
+        if flash_options.flash_method is FlashMethod.REGULAR:
+            cmd = [
+                "make",
+                flash_options.flash_command.value,
+                f"FLASH_DEVICE={flash_options.selected_mcu}",
+            ]
+        elif flash_options.flash_method is FlashMethod.SD_CARD:
+            if not SD_FLASH_SCRIPT.exists():
+                raise Exception("Unable to find Klippers sdcard flash script!")
+            cmd = [
+                SD_FLASH_SCRIPT.as_posix(),
+                f"-b {flash_options.selected_baudrate}",
+                flash_options.selected_mcu,
+                flash_options.selected_board,
+            ]
+        else:
+            raise Exception("Invalid value for flash_method!")
+
+        instances = get_instances(Klipper)
+        InstanceManager.stop_all(instances)
+
+        process = Popen(cmd, cwd=KLIPPER_DIR, stdout=PIPE, stderr=STDOUT, text=True)
+        log_process(process)
+
+        InstanceManager.start_all(instances)
+
+        rc = process.returncode
+        if rc != 0:
+            raise Exception(f"Flashing failed with returncode: {rc}")
+        else:
+            Logger.print_ok("Flashing successfull!", start="\n", end="\n\n")
+
+    except (Exception, CalledProcessError):
+        Logger.print_error("Flashing failed!", start="\n")
+        Logger.print_error("See the console output above!", end="\n\n")
+
+
+def run_make_clean() -> None:
+    try:
+        run(
+            "make clean",
+            cwd=KLIPPER_DIR,
+            shell=True,
+            check=True,
+        )
+    except CalledProcessError as e:
+        Logger.print_error(f"Unexpected error:\n{e}")
+        raise
+
+
+def run_make_menuconfig() -> None:
+    try:
+        run(
+            "make PYTHON=python3 menuconfig",
+            cwd=KLIPPER_DIR,
+            shell=True,
+            check=True,
+        )
+    except CalledProcessError as e:
+        Logger.print_error(f"Unexpected error:\n{e}")
+        raise
+
+
+def run_make() -> None:
+    try:
+        run(
+            "make PYTHON=python3",
+            cwd=KLIPPER_DIR,
+            shell=True,
+            check=True,
+        )
+    except CalledProcessError as e:
+        Logger.print_error(f"Unexpected error:\n{e}")
+        raise

kiauh/components/klipper_firmware/flash_options.py

@@ -0,0 +1,105 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+from dataclasses import field
+from enum import Enum
+from typing import List
+
+
+class FlashMethod(Enum):
+    REGULAR = "Regular"
+    SD_CARD = "SD Card"
+
+
+class FlashCommand(Enum):
+    FLASH = "flash"
+    SERIAL_FLASH = "serialflash"
+
+
+class ConnectionType(Enum):
+    USB = "USB"
+    USB_DFU = "USB (DFU)"
+    UART = "UART"
+
+
+class FlashOptions:
+    _instance = 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 = ""
+    _selected_baudrate: int = 250000
+
+    def __new__(cls, *args, **kwargs):
+        if not cls._instance:
+            cls._instance = super(FlashOptions, cls).__new__(cls, *args, **kwargs)
+        return cls._instance
+
+    @classmethod
+    def destroy(cls) -> None:
+        cls._instance = None
+
+    @property
+    def flash_method(self) -> FlashMethod | None:
+        return self._flash_method
+
+    @flash_method.setter
+    def flash_method(self, value: FlashMethod | None):
+        self._flash_method = value
+
+    @property
+    def flash_command(self) -> FlashCommand | None:
+        return self._flash_command
+
+    @flash_command.setter
+    def flash_command(self, value: FlashCommand | None):
+        self._flash_command = value
+
+    @property
+    def connection_type(self) -> ConnectionType | None:
+        return self._connection_type
+
+    @connection_type.setter
+    def connection_type(self, value: ConnectionType | None):
+        self._connection_type = value
+
+    @property
+    def mcu_list(self) -> List[str]:
+        return self._mcu_list
+
+    @mcu_list.setter
+    def mcu_list(self, value: List[str]) -> None:
+        self._mcu_list = value
+
+    @property
+    def selected_mcu(self) -> str:
+        return self._selected_mcu
+
+    @selected_mcu.setter
+    def selected_mcu(self, value: str) -> None:
+        self._selected_mcu = value
+
+    @property
+    def selected_board(self) -> str:
+        return self._selected_board
+
+    @selected_board.setter
+    def selected_board(self, value: str) -> None:
+        self._selected_board = value
+
+    @property
+    def selected_baudrate(self) -> int:
+        return self._selected_baudrate
+
+    @selected_baudrate.setter
+    def selected_baudrate(self, value: int) -> None:
+        self._selected_baudrate = value

kiauh/components/klipper_firmware/menus/klipper_build_menu.py

@@ -0,0 +1,115 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import List, Set, Type
+
+from components.klipper import KLIPPER_DIR
+from components.klipper_firmware.firmware_utils import (
+    run_make,
+    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.sys_utils import (
+    check_package_install,
+    install_system_packages,
+    update_system_package_lists,
+)
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperBuildFirmwareMenu(BaseMenu):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+        super().__init__()
+        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: Type[BaseMenu] | None) -> None:
+        from core.menus.advanced_menu import AdvancedMenu
+
+        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)
+        else:
+            self.input_label_txt = "Press ENTER to install dependencies"
+            self.default_option = Option(method=self.install_missing_deps)
+
+    def print_menu(self) -> None:
+        header = " [ Build Firmware Menu ] "
+        color = COLOR_CYAN
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ The following dependencies are required:              ║
+            ║                                                       ║
+            """
+        )[1:]
+
+        for d in self.deps:
+            status_ok = f"{COLOR_GREEN}*INSTALLED*{RESET_FORMAT}"
+            status_missing = f"{COLOR_RED}*MISSING*{RESET_FORMAT}"
+            status = status_missing if d in self.missing_deps else status_ok
+            padding = 39 - len(d) + len(status) + (len(status_ok) - len(status))
+            d = f" {COLOR_CYAN}● {d}{RESET_FORMAT}"
+            menu += f"║ {d}{status:>{padding}} ║\n"
+        menu += "║                                                       ║\n"
+
+        if len(self.missing_deps) == 0:
+            line = f"{COLOR_GREEN}All dependencies are met!{RESET_FORMAT}"
+        else:
+            line = f"{COLOR_RED}Dependencies are missing!{RESET_FORMAT}"
+
+        menu += f"║ {line:<62} ║\n"
+        menu += "╟───────────────────────────────────────────────────────╢\n"
+
+        print(menu, end="")
+
+    def install_missing_deps(self, **kwargs) -> None:
+        try:
+            update_system_package_lists(silent=False)
+            Logger.print_status("Installing system packages...")
+            install_system_packages(self.missing_deps)
+        except Exception as e:
+            Logger.print_error(e)
+            Logger.print_error("Installing dependencies failed!")
+        finally:
+            # restart this menu
+            KlipperBuildFirmwareMenu().run()
+
+    def start_build_process(self, **kwargs) -> None:
+        try:
+            run_make_clean()
+            run_make_menuconfig()
+            run_make()
+
+            Logger.print_ok("Firmware successfully built!")
+            Logger.print_ok(f"Firmware file located in '{KLIPPER_DIR}/out'!")
+
+        except Exception as e:
+            Logger.print_error(e)
+            Logger.print_error("Building Klipper Firmware failed!")
+
+        finally:
+            if self.previous_menu is not None:
+                self.previous_menu().run()

kiauh/components/klipper_firmware/menus/klipper_flash_error_menu.py

@@ -0,0 +1,111 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from components.klipper_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
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperNoFirmwareErrorMenu(BaseMenu):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+        super().__init__()
+        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: Type[BaseMenu] | None) -> None:
+        self.previous_menu = previous_menu
+
+    def set_options(self) -> None:
+        self.default_option = Option(method=self.go_back)
+
+    def print_menu(self) -> None:
+        header = "!!! NO FIRMWARE FILE FOUND !!!"
+        color = COLOR_RED
+        count = 62 - len(color) - len(RESET_FORMAT)
+        line1 = f"{color}Unable to find a compiled firmware file!{RESET_FORMAT}"
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ {line1:<62} ║
+            ║                                                       ║
+            ║ Make sure, that:                                      ║
+            ║ ● the folder '~/klipper/out' and its content exist    ║
+            ║ ● the folder contains the following file:             ║
+            """
+        )[1:]
+
+        if self.flash_options.flash_method is FlashMethod.REGULAR:
+            menu += "║   ● 'klipper.elf'                                     ║\n"
+            menu += "║   ● 'klipper.elf.hex'                                 ║\n"
+        else:
+            menu += "║   ● 'klipper.bin'                                     ║\n"
+
+        print(menu, end="")
+
+    def go_back(self, **kwargs) -> None:
+        from core.menus.advanced_menu import AdvancedMenu
+
+        AdvancedMenu().run()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperNoBoardTypesErrorMenu(BaseMenu):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+        super().__init__()
+        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: Type[BaseMenu] | None) -> None:
+        self.previous_menu = previous_menu
+
+    def set_options(self) -> None:
+        self.default_option = Option(method=self.go_back)
+
+    def print_menu(self) -> None:
+        header = "!!! ERROR GETTING BOARD LIST !!!"
+        color = COLOR_RED
+        count = 62 - len(color) - len(RESET_FORMAT)
+        line1 = f"{color}Reading the list of supported boards failed!{RESET_FORMAT}"
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ {line1:<62} ║
+            ║                                                       ║
+            ║ Make sure, that:                                      ║
+            ║ ● the folder '~/klipper' and all its content exist    ║
+            ║ ● the content of folder '~/klipper' is not currupted  ║
+            ║ ● the file '~/klipper/scripts/flash-sd.py' exist      ║
+            ║ ● your current user has access to those files/folders ║
+            ║                                                       ║
+            ║ If in doubt or this process continues to fail, please ║
+            ║ consider to download Klipper again.                   ║
+            """
+        )[1:]
+        print(menu, end="")
+
+    def go_back(self, **kwargs) -> None:
+        from core.menus.main_menu import MainMenu
+
+        MainMenu().run()

kiauh/components/klipper_firmware/menus/klipper_flash_help_menu.py

@@ -0,0 +1,170 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
+from core.menus.base_menu import BaseMenu
+
+
+# noinspection DuplicatedCode
+class KlipperFlashMethodHelpMenu(BaseMenu):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+        super().__init__()
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from components.klipper_firmware.menus.klipper_flash_menu import (
+            KlipperFlashMethodMenu,
+        )
+
+        self.previous_menu = (
+            previous_menu if previous_menu is not None else KlipperFlashMethodMenu
+        )
+
+    def set_options(self) -> None:
+        pass
+
+    def print_menu(self) -> None:
+        header = " < ? > Help: Flash MCU < ? > "
+        color = COLOR_YELLOW
+        count = 62 - len(color) - len(RESET_FORMAT)
+        subheader1 = f"{COLOR_CYAN}Regular flashing method:{RESET_FORMAT}"
+        subheader2 = f"{COLOR_CYAN}Updating via SD-Card Update:{RESET_FORMAT}"
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ {subheader1:<62} ║
+            ║ The default method to flash controller boards which   ║
+            ║ are connected and updated over USB and not by placing ║
+            ║ a compiled firmware file onto an internal SD-Card.    ║
+            ║                                                       ║
+            ║ Common controllers that get flashed that way are:     ║
+            ║ - Arduino Mega 2560                                   ║
+            ║ - Fysetc F6 / S6 (used without a Display + SD-Slot)   ║
+            ║                                                       ║
+            ║ {subheader2:<62} ║
+            ║ Many popular controller boards ship with a bootloader ║
+            ║ capable of updating the firmware via SD-Card.         ║
+            ║ Choose this method if your controller board supports  ║
+            ║ this way of updating. This method ONLY works for up-  ║
+            ║ grading firmware. The initial flashing procedure must ║
+            ║ be done manually per the instructions that apply to   ║
+            ║ your controller board.                                ║
+            ║                                                       ║
+            ║ Common controllers that can be flashed that way are:  ║
+            ║ - BigTreeTech SKR 1.3 / 1.4 (Turbo) / E3 / Mini E3    ║
+            ║ - Fysetc F6 / S6 (used with a Display + SD-Slot)      ║
+            ║ - Fysetc Spider                                       ║
+            ║                                                       ║
+            ╟───────────────────────────────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+
+# noinspection DuplicatedCode
+class KlipperFlashCommandHelpMenu(BaseMenu):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+        super().__init__()
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from components.klipper_firmware.menus.klipper_flash_menu import (
+            KlipperFlashCommandMenu,
+        )
+
+        self.previous_menu = (
+            previous_menu if previous_menu is not None else KlipperFlashCommandMenu
+        )
+
+    def set_options(self) -> None:
+        pass
+
+    def print_menu(self) -> None:
+        header = " < ? > Help: Flash MCU < ? > "
+        color = COLOR_YELLOW
+        count = 62 - len(color) - len(RESET_FORMAT)
+        subheader1 = f"{COLOR_CYAN}make flash:{RESET_FORMAT}"
+        subheader2 = f"{COLOR_CYAN}make serialflash:{RESET_FORMAT}"
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ {subheader1:<62} ║
+            ║ The default command to flash controller board, it     ║
+            ║ will detect selected microcontroller and use suitable ║
+            ║ tool for flashing it.                                 ║
+            ║                                                       ║
+            ║ {subheader2:<62} ║
+            ║ Special command to flash STM32 microcontrollers in    ║
+            ║ DFU mode but connected via serial. stm32flash command ║
+            ║ will be used internally.                              ║
+            ║                                                       ║
+            """
+        )[1:]
+        print(menu, end="")
+
+
+# noinspection DuplicatedCode
+class KlipperMcuConnectionHelpMenu(BaseMenu):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+        super().__init__()
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from components.klipper_firmware.menus.klipper_flash_menu import (
+            KlipperSelectMcuConnectionMenu,
+        )
+
+        self.previous_menu = (
+            previous_menu
+            if previous_menu is not None
+            else KlipperSelectMcuConnectionMenu
+        )
+
+    def set_options(self) -> None:
+        pass
+
+    def print_menu(self) -> None:
+        header = " < ? > Help: Flash MCU < ? > "
+        color = COLOR_YELLOW
+        count = 62 - len(color) - len(RESET_FORMAT)
+        subheader1 = f"{COLOR_CYAN}USB:{RESET_FORMAT}"
+        subheader2 = f"{COLOR_CYAN}UART:{RESET_FORMAT}"
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ {subheader1:<62} ║
+            ║ Selecting USB as the connection method will scan the  ║
+            ║ USB ports for connected controller boards. This will  ║
+            ║ be similar to the 'ls /dev/serial/by-id/*' command    ║
+            ║ suggested by the official Klipper documentation for   ║
+            ║ determining successfull USB connections!              ║
+            ║                                                       ║
+            ║ {subheader2:<62} ║
+            ║ Selecting UART as the connection method will list all ║
+            ║ possible UART serial ports. Note: This method ALWAYS  ║
+            ║ returns something as it seems impossible to determine ║
+            ║ if a valid Klipper controller board is connected or   ║
+            ║ not. Because of that, you MUST know which UART serial ║
+            ║ port your controller board is connected to when using ║
+            ║ this connection method.                               ║
+            ║                                                       ║
+            ╟───────────────────────────────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")

kiauh/components/klipper_firmware/menus/klipper_flash_menu.py

@@ -0,0 +1,471 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+import time
+from typing import Type
+
+from components.klipper_firmware.firmware_utils import (
+    find_firmware_file,
+    find_uart_device,
+    find_usb_device_by_id,
+    find_usb_dfu_device,
+    get_sd_flash_board_list,
+    start_flash_process,
+)
+from components.klipper_firmware.flash_options import (
+    ConnectionType,
+    FlashCommand,
+    FlashMethod,
+    FlashOptions,
+)
+from components.klipper_firmware.menus.klipper_flash_error_menu import (
+    KlipperNoBoardTypesErrorMenu,
+    KlipperNoFirmwareErrorMenu,
+)
+from components.klipper_firmware.menus.klipper_flash_help_menu import (
+    KlipperFlashCommandHelpMenu,
+    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.input_utils import get_number_input
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperFlashMethodMenu(BaseMenu):
+    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: Type[BaseMenu] | None) -> None:
+        from core.menus.advanced_menu import AdvancedMenu
+
+        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),
+            "2": Option(self.select_sdcard),
+        }
+
+    def print_menu(self) -> None:
+        header = " [ MCU Flash Menu ] "
+        subheader = f"{COLOR_YELLOW}ATTENTION:{RESET_FORMAT}"
+        subline1 = f"{COLOR_YELLOW}Make sure to select the correct method for the  MCU!{RESET_FORMAT}"
+        subline2 = f"{COLOR_YELLOW}Not all MCUs support both methods!{RESET_FORMAT}"
+
+        color = COLOR_CYAN
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ Select the flash method for flashing the MCU.         ║
+            ║                                                       ║
+            ║ {subheader:<62} ║
+            ║ {subline1:<62} ║
+            ║ {subline2:<62} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ 1) Regular flashing method                            ║
+            ║ 2) Updating via SD-Card Update                        ║
+            ╟───────────────────────────┬───────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def select_regular(self, **kwargs):
+        self.flash_options.flash_method = FlashMethod.REGULAR
+        self.goto_next_menu()
+
+    def select_sdcard(self, **kwargs):
+        self.flash_options.flash_method = FlashMethod.SD_CARD
+        self.goto_next_menu()
+
+    def goto_next_menu(self, **kwargs):
+        if find_firmware_file():
+            KlipperFlashCommandMenu(previous_menu=self.__class__).run()
+        else:
+            KlipperNoFirmwareErrorMenu().run()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperFlashCommandMenu(BaseMenu):
+    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: 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),
+            "2": Option(self.select_serialflash),
+        }
+        self.default_option = Option(self.select_flash)
+
+    def print_menu(self) -> None:
+        menu = textwrap.dedent(
+            """
+            ╔═══════════════════════════════════════════════════════╗
+            ║ Which flash command to use for flashing the MCU?      ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ 1) make flash (default)                               ║
+            ║ 2) make serialflash (stm32flash)                      ║
+            ╟───────────────────────────┬───────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def select_flash(self, **kwargs):
+        self.flash_options.flash_command = FlashCommand.FLASH
+        self.goto_next_menu()
+
+    def select_serialflash(self, **kwargs):
+        self.flash_options.flash_command = FlashCommand.SERIAL_FLASH
+        self.goto_next_menu()
+
+    def goto_next_menu(self, **kwargs):
+        KlipperSelectMcuConnectionMenu(previous_menu=self.__class__).run()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperSelectMcuConnectionMenu(BaseMenu):
+    def __init__(
+        self, previous_menu: Type[BaseMenu] | None = None, standalone: bool = False
+    ):
+        super().__init__()
+        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: 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),
+            "2": Option(method=self.select_dfu),
+            "3": Option(method=self.select_usb_dfu),
+        }
+
+    def print_menu(self) -> None:
+        header = "Make sure that the controller board is connected now!"
+        color = COLOR_YELLOW
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ How is the controller board connected to the host?    ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ 1) USB                                                ║
+            ║ 2) UART                                               ║
+            ║ 3) USB (DFU mode)                                     ║
+            ╟───────────────────────────┬───────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def select_usb(self, **kwargs):
+        self.flash_options.connection_type = ConnectionType.USB
+        self.get_mcu_list()
+
+    def select_dfu(self, **kwargs):
+        self.flash_options.connection_type = ConnectionType.UART
+        self.get_mcu_list()
+
+    def select_usb_dfu(self, **kwargs):
+        self.flash_options.connection_type = ConnectionType.USB_DFU
+        self.get_mcu_list()
+
+    def get_mcu_list(self, **kwargs):
+        conn_type = self.flash_options.connection_type
+
+        if conn_type is ConnectionType.USB:
+            Logger.print_status("Identifying MCU connected via USB ...")
+            self.flash_options.mcu_list = find_usb_device_by_id()
+        elif conn_type is ConnectionType.UART:
+            Logger.print_status("Identifying MCU possibly connected via UART ...")
+            self.flash_options.mcu_list = find_uart_device()
+        elif conn_type is ConnectionType.USB_DFU:
+            Logger.print_status("Identifying MCU connected via USB in DFU mode ...")
+            self.flash_options.mcu_list = find_usb_dfu_device()
+
+        if len(self.flash_options.mcu_list) < 1:
+            Logger.print_warn("No MCUs found!")
+            Logger.print_warn("Make sure they are connected and repeat this step.")
+
+        # if standalone is True, we only display the MCUs to the user and return
+        if self.__standalone and len(self.flash_options.mcu_list) > 0:
+            Logger.print_ok("The following MCUs were found:", prefix=False)
+            for i, mcu in enumerate(self.flash_options.mcu_list):
+                print(f"   ● MCU #{i}: {COLOR_CYAN}{mcu}{RESET_FORMAT}")
+            time.sleep(3)
+            return
+
+        self.goto_next_menu()
+
+    def goto_next_menu(self, **kwargs):
+        KlipperSelectMcuIdMenu(previous_menu=self.__class__).run()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperSelectMcuIdMenu(BaseMenu):
+    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
+
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        self.previous_menu = (
+            previous_menu
+            if previous_menu is not None
+            else KlipperSelectMcuConnectionMenu
+        )
+
+    def set_options(self) -> None:
+        self.options = {
+            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 detected MCUs{RESET_FORMAT}]"
+        color = COLOR_RED
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ Make sure, to select the correct MCU!                 ║
+            ║ 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"║ {i}) {COLOR_CYAN}{mcu:<51}{RESET_FORMAT}║\n"
+
+        menu += textwrap.dedent(
+            """
+            ║                                                       ║
+            ╟───────────────────────────────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def flash_mcu(self, **kwargs):
+        try:
+            index: int | None = kwargs.get("opt_index", None)
+            if index is None:
+                raise Exception("opt_index is None")
+
+            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: 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: 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, f"{i}")
+            for i in range(len(self.available_boards))
+        }
+
+    def print_menu(self) -> None:
+        if len(self.available_boards) < 1:
+            KlipperNoBoardTypesErrorMenu().run()
+        else:
+            menu = textwrap.dedent(
+                """
+                ╔═══════════════════════════════════════════════════════╗
+                ║ Please select the type of board that corresponds to   ║
+                ║ the currently selected MCU ID you chose before.       ║
+                ║                                                       ║
+                ║ The following boards are currently supported:         ║
+                ╟───────────────────────────────────────────────────────╢
+                """
+            )[1:]
+
+            for i, board in enumerate(self.available_boards):
+                line = f" {i}) {board}"
+                menu += f"║{line:<55}║\n"
+            menu += "╟───────────────────────────────────────────────────────╢"
+            print(menu, end="")
+
+    def board_select(self, **kwargs):
+        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(
+            DialogType.CUSTOM,
+            [
+                "If your board is flashed with firmware that connects "
+                "at a custom baud rate, please change it now.",
+                "\n\n",
+                "If you are unsure, stick to the default 250000!",
+            ],
+        )
+        self.flash_options.selected_baudrate = get_number_input(
+            question="Please set the baud rate",
+            default=250000,
+            min_count=0,
+            allow_go_back=True,
+        )
+        KlipperFlashOverviewMenu(previous_menu=self.__class__).run()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperFlashOverviewMenu(BaseMenu):
+    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: Type[BaseMenu] | None) -> None:
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+    def set_options(self) -> None:
+        self.options = {
+            "y": Option(self.execute_flash),
+            "n": Option(self.abort_process),
+        }
+
+        self.default_option = Option(self.execute_flash)
+
+    def print_menu(self) -> None:
+        header = "!!! ATTENTION !!!"
+        color = COLOR_RED
+        count = 62 - len(color) - len(RESET_FORMAT)
+
+        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.split("/")[-1]
+        board = self.flash_options.selected_board
+        baudrate = self.flash_options.selected_baudrate
+        subheader = f"[{COLOR_CYAN}Overview{RESET_FORMAT}]"
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ Before contuining the flashing process, please check  ║
+            ║ if all parameters were set correctly! Once you made   ║
+            ║ 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}║
+            ║                                                       ║
+            """
+        )[1:]
+
+        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 += 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):
+        start_flash_process(self.flash_options)
+        Logger.print_info("Returning to MCU Flash Menu in 5 seconds ...")
+        time.sleep(5)
+        KlipperFlashMethodMenu().run()
+
+    def abort_process(self, **kwargs):
+        from core.menus.advanced_menu import AdvancedMenu
+
+        AdvancedMenu().run()

kiauh/components/klipperscreen/__init__.py

@@ -0,0 +1,34 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from 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_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

@@ -0,0 +1,206 @@
+# ======================================================================= #
+#  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.klipperscreen import (
+    KLIPPERSCREEN_BACKUP_DIR,
+    KLIPPERSCREEN_DIR,
+    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.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.instance_utils import get_instances
+from utils.sys_utils import (
+    check_python_version,
+    cmd_sysctl_service,
+    install_python_requirements,
+    remove_system_service,
+)
+
+
+def install_klipperscreen() -> None:
+    Logger.print_status("Installing KlipperScreen ...")
+
+    if not check_python_version(3, 7):
+        return
+
+    mr_instances = get_instances(Moonraker)
+    if not mr_instances:
+        Logger.print_dialog(
+            DialogType.WARNING,
+            [
+                "Moonraker not found! KlipperScreen will not properly work "
+                "without a working Moonraker installation.",
+                "\n\n",
+                "KlipperScreens update manager configuration for Moonraker "
+                "will not be added to any moonraker.conf.",
+            ],
+        )
+        if not get_confirm(
+            "Continue KlipperScreen installation?",
+            default_choice=False,
+            allow_go_back=True,
+        ):
+            return
+
+    check_install_dependencies()
+
+    git_clone_wrapper(KLIPPERSCREEN_REPO, KLIPPERSCREEN_DIR)
+
+    try:
+        run(KLIPPERSCREEN_INSTALL_SCRIPT.as_posix(), shell=True, check=True)
+        if mr_instances:
+            patch_klipperscreen_update_manager(mr_instances)
+            InstanceManager.restart_all(mr_instances)
+        else:
+            Logger.print_info(
+                "Moonraker is not installed! Cannot add "
+                "KlipperScreen to update manager!"
+            )
+        Logger.print_ok("KlipperScreen successfully installed!")
+    except CalledProcessError as e:
+        Logger.print_error(f"Error installing KlipperScreen:\n{e}")
+        return
+
+
+def patch_klipperscreen_update_manager(instances: List[Moonraker]) -> None:
+    add_config_section(
+        section=KLIPPERSCREEN_UPDATER_SECTION_NAME,
+        instances=instances,
+        options=[
+            ("type", "git_repo"),
+            ("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:
+        Logger.print_status("Updating KlipperScreen ...")
+
+        cmd_sysctl_service(KLIPPERSCREEN_SERVICE_NAME, "stop")
+
+        settings = KiauhSettings()
+        if settings.kiauh.backup_before_update:
+            backup_klipperscreen_dir()
+
+        git_pull_wrapper(KLIPPERSCREEN_REPO, KLIPPERSCREEN_DIR)
+
+        install_python_requirements(KLIPPERSCREEN_ENV_DIR, KLIPPERSCREEN_REQ_FILE)
+
+        cmd_sysctl_service(KLIPPERSCREEN_SERVICE_NAME, "start")
+
+        Logger.print_ok("KlipperScreen updated successfully.", end="\n\n")
+    except CalledProcessError as e:
+        Logger.print_error(f"Error updating KlipperScreen:\n{e}")
+        return
+
+
+def get_klipperscreen_status() -> ComponentStatus:
+    return get_install_status(
+        KLIPPERSCREEN_DIR,
+        KLIPPERSCREEN_ENV_DIR,
+        files=[SYSTEMD.joinpath(KLIPPERSCREEN_SERVICE_NAME)],
+    )
+
+
+def remove_klipperscreen() -> None:
+    Logger.print_status("Removing KlipperScreen ...")
+    try:
+        if KLIPPERSCREEN_DIR.exists():
+            Logger.print_status("Removing KlipperScreen directory ...")
+            shutil.rmtree(KLIPPERSCREEN_DIR)
+            Logger.print_ok("KlipperScreen directory successfully removed!")
+        else:
+            Logger.print_warn("KlipperScreen directory not found!")
+
+        if KLIPPERSCREEN_ENV_DIR.exists():
+            Logger.print_status("Removing KlipperScreen environment ...")
+            shutil.rmtree(KLIPPERSCREEN_ENV_DIR)
+            Logger.print_ok("KlipperScreen environment successfully removed!")
+        else:
+            Logger.print_warn("KlipperScreen environment not found!")
+
+        if KLIPPERSCREEN_SERVICE_FILE.exists():
+            remove_system_service(KLIPPERSCREEN_SERVICE_NAME)
+
+        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_instances: List[Klipper] = get_instances(Klipper)
+        for instance in kl_instances:
+            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_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)
+            Logger.print_ok("KlipperScreen successfully removed from update manager!")
+
+        Logger.print_ok("KlipperScreen successfully removed!")
+
+    except Exception as e:
+        Logger.print_error(f"Error removing KlipperScreen:\n{e}")
+
+
+def backup_klipperscreen_dir() -> None:
+    bm = BackupManager()
+    bm.backup_directory(
+        KLIPPERSCREEN_DIR.name,
+        source=KLIPPERSCREEN_DIR,
+        target=KLIPPERSCREEN_BACKUP_DIR,
+    )
+    bm.backup_directory(
+        KLIPPERSCREEN_ENV_DIR.name,
+        source=KLIPPERSCREEN_ENV_DIR,
+        target=KLIPPERSCREEN_BACKUP_DIR,
+    )

kiauh/components/log_uploads/__init__.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -10,7 +8,7 @@
 # ======================================================================= #
 
 from pathlib import Path
-from typing import Dict, Union, Literal
+from typing import Dict, Literal, Union
 
 FileKey = Literal["filepath", "display_name"]
 LogFile = Dict[FileKey, Union[str, Path]]

kiauh/components/log_uploads/log_upload_utils.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -15,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 core.logger import Logger
-from utils.logger import Logger
+from utils.instance_utils import get_instances
 
 
 def get_logfile_list() -> List[LogFile]:
-    cm = InstanceManager(Klipper)
+    log_dirs: List[Path] = [
-    log_dirs: List[Path] = [instance.log_dir for instance in cm.instances]
+        instance.base.log_dir for instance in get_instances(Klipper)
+    ]
 
     logfiles: List[LogFile] = []
     for _dir in log_dirs:
@@ -49,8 +48,8 @@ def upload_logfile(logfile: LogFile) -> None:
         try:
             response = urllib.request.urlopen(req)
             link = response.read().decode("utf-8")
-            Logger.print_ok("Upload successfull! Access it via the following link:")
+            Logger.print_ok("Upload successful! Access it via the following link:")
             Logger.print_ok(f">>>> {link}", False)
         except Exception as e:
-            Logger.print_error(f"Uploading logfile failed!")
+            Logger.print_error("Uploading logfile failed!")
             Logger.print_error(str(e))

kiauh/components/log_uploads/menus/log_upload_menu.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,47 +6,65 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
+from typing import Type
 
-from components.log_uploads.log_upload_utils import get_logfile_list
+from components.log_uploads.log_upload_utils import get_logfile_list, upload_logfile
-from components.log_uploads.log_upload_utils import upload_logfile
+from core.constants import COLOR_YELLOW, RESET_FORMAT
-from core.menus import BACK_FOOTER
+from core.logger import Logger
+from core.menus import Option
 from core.menus.base_menu import BaseMenu
-from utils.constants import RESET_FORMAT, COLOR_YELLOW
 
 
 # noinspection PyMethodMayBeStatic
 class LogUploadMenu(BaseMenu):
-    def __init__(self):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+        super().__init__()
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
         self.logfile_list = get_logfile_list()
-        options = {index: self.upload for index in range(len(self.logfile_list))}
-        super().__init__(
-            header=True,
-            options=options,
-            footer_type=BACK_FOOTER,
-        )
 
-    def print_menu(self):
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from core.menus.main_menu import MainMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            f"{index}": Option(self.upload, opt_index=f"{index}")
+            for index in range(len(self.logfile_list))
+        }
+
+    def print_menu(self) -> None:
         header = " [ Log Upload ] "
         color = COLOR_YELLOW
         count = 62 - len(color) - len(RESET_FORMAT)
         menu = textwrap.dedent(
             f"""
-            /=======================================================\\
+            ╔═══════════════════════════════════════════════════════╗
-            | {color}{header:~^{count}}{RESET_FORMAT} |
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
-            |-------------------------------------------------------|
+            ╟───────────────────────────────────────────────────────╢
-            | You can select the following logfiles for uploading:  |
+            ║ You can select the following logfiles for uploading:  ║
-            |                                                       |
+            ║                                                       ║
             """
         )[1:]
 
-        logfile_list = get_logfile_list()
+        for logfile in enumerate(self.logfile_list):
-        for logfile in enumerate(logfile_list):
             line = f"{logfile[0]}) {logfile[1].get('display_name')}"
-            menu += f"| {line:<54}|\n"
+            menu += f"║ {line:<54}║\n"
+        menu += "╟───────────────────────────────────────────────────────╢\n"
 
         print(menu, end="")
 
     def upload(self, **kwargs):
-        upload_logfile(self.logfile_list[kwargs.get("opt_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/moonraker/__init__.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -15,22 +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_REPO_URL = "https://github.com/Arksine/moonraker"
-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

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,36 +6,42 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
+from typing import Type
 
 from components.moonraker import moonraker_remove
-from core.menus import BACK_HELP_FOOTER
+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 RESET_FORMAT, COLOR_RED, COLOR_CYAN
 
 
 # noinspection PyUnusedLocal
 class MoonrakerRemoveMenu(BaseMenu):
-    def __init__(self):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
-        super().__init__(
+        super().__init__()
-            header=False,
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
-            options={
-                "0": self.toggle_all,
-                "1": self.toggle_remove_moonraker_service,
-                "2": self.toggle_remove_moonraker_dir,
-                "3": self.toggle_remove_moonraker_env,
-                "4": self.toggle_remove_moonraker_polkit,
-                "5": self.toggle_delete_moonraker_logs,
-                "c": self.run_removal_process,
-            },
-            footer_type=BACK_HELP_FOOTER,
-        )
         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: Type[BaseMenu] | None) -> None:
+        from core.menus.remove_menu import RemoveMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else RemoveMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "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:
         header = " [ Remove Moonraker ] "
@@ -49,34 +53,33 @@ 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"""
-            /=======================================================\\
+            ╔═══════════════════════════════════════════════════════╗
-            | {color}{header:~^{count}}{RESET_FORMAT} |
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
-            |-------------------------------------------------------|
+            ╟───────────────────────────────────────────────────────╢
-            | Enter a number and hit enter to select / deselect     |
+            ║ Enter a number and hit enter to select / deselect     ║
-            | the specific option for removal.                      |
+            ║ the specific option for removal.                      ║
-            |-------------------------------------------------------|
+            ╟───────────────────────────────────────────────────────╢
-            |  0) Select everything                                 |
+            ║  a) {self._get_selection_state_str():37}             ║
-            |-------------------------------------------------------|
+            ╟───────────────────────────────────────────────────────╢
-            |  1) {o1} Remove Service                                |
+            ║  1) {o1} Remove Service                                ║
-            |  2) {o2} Remove Local Repository                       |
+            ║  2) {o2} Remove Local Repository                       ║
-            |  3) {o3} Remove Python Environment                     |
+            ║  3) {o3} Remove Python Environment                     ║
-            |  4) {o4} Remove Policy Kit Rules                       |
+            ║  4) {o4} Remove Policy Kit Rules                       ║
-            |  5) {o5} Delete all Log-Files                          |
+            ╟───────────────────────────────────────────────────────╢
-            |-------------------------------------------------------|
+            ║  C) Continue                                          ║
-            |  C) Continue                                          |
+            ╟───────────────────────────────────────────────────────╢
             """
         )[1:]
         print(menu, end="")
 
     def toggle_all(self, **kwargs) -> None:
-        self.remove_moonraker_service = True
+        self.selection_state = not self.selection_state
-        self.remove_moonraker_dir = True
+        self.remove_moonraker_service = self.selection_state
-        self.remove_moonraker_env = True
+        self.remove_moonraker_dir = self.selection_state
-        self.remove_moonraker_polkit = True
+        self.remove_moonraker_env = self.selection_state
-        self.delete_moonraker_logs = True
+        self.remove_moonraker_polkit = self.selection_state
 
     def toggle_remove_moonraker_service(self, **kwargs) -> None:
         self.remove_moonraker_service = not self.remove_moonraker_service
@@ -90,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)
@@ -110,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

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,144 +6,141 @@
 #                                                                         #
 #  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, Union
+from subprocess import CalledProcessError
 
-from components.moonraker import MOONRAKER_DIR, MOONRAKER_ENV_DIR, MODULE_PATH
+from components.klipper.klipper import Klipper
-from core.config_manager.config_manager import ConfigManager
+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 utils.constants import SYSTEMD
+from core.logger import Logger
-from utils.logger import Logger
+from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+    SimpleConfigParser,
+)
+from utils.fs_utils import create_folders
+from utils.sys_utils import get_service_file_path
 
 
 # noinspection PyMethodMayBeStatic
-class Moonraker(BaseInstance):
+@dataclass
-    @classmethod
+class Moonraker:
-    def blacklist(cls) -> List[str]:
+    suffix: str
-        return ["None", "mcu"]
+    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 = ""):
+    def __post_init__(self):
-        super().__init__(instance_type=self, suffix=suffix)
+        self.base: BaseInstance = BaseInstance(Klipper, self.suffix)
-        self.moonraker_dir: Path = MOONRAKER_DIR
+        self.base.log_file_name = self.log_file_name
-        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.log = self.log_dir.joinpath("moonraker.log")
 
-    @property
+        self.service_file_path: Path = get_service_file_path(Moonraker, self.suffix)
-    def db_dir(self) -> Path:
+        self.data_dir: Path = self.base.data_dir
-        return self._db_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()
+
+    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])
+            create_folders(self.base.base_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)
 
-        except subprocess.CalledProcessError as e:
+            create_service_file(
-            Logger.print_error(
+                name=self.service_file_path.name,
-                f"Error creating service file {service_file_target}: {e}"
+                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:
+    def _prep_service_file_content(self) -> str:
-        service_file = self.get_service_file_name(extension=True)
+        template = MOONRAKER_SERVICE_TEMPLATE
-        service_file_path = self.get_service_file_path()
-
-        Logger.print_status(f"Deleting Moonraker Instance: {service_file}")
 
         try:
-            command = ["sudo", "rm", "-f", service_file_path]
+            with open(template, "r") as template_file:
-            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:
                 template_content = template_file.read()
         except FileNotFoundError:
-            Logger.print_error(
+            Logger.print_error(f"Unable to open {template} - File not found")
-                f"Unable to open {service_template_path} - File not found"
-            )
             raise
-        service_content = template_content.replace("%USER%", self.user)
+
-        service_content = service_content.replace(
+        service_content = template_content.replace(
-            "%MOONRAKER_DIR%", str(self.moonraker_dir)
+            "%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(
+            Logger.print_error(f"Unable to open {template} - File not found")
-                f"Unable to open {env_template_file_path} - 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) -> Union[int, None]:
+    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
 
-        cm = ConfigManager(cfg_file=self.cfg_file)
+        scp = SimpleConfigParser()
-        port = cm.get_value("server", "port")
+        scp.read_file(self.cfg_file)
+        port: int | None = scp.getint("server", "port", fallback=None)
 
-        return int(port) if port is not None else port
+        return port

kiauh/components/moonraker/moonraker_dialogs.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -14,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_GREEN, RESET_FORMAT, COLOR_YELLOW, COLOR_CYAN
 
 
 def print_moonraker_overview(
@@ -27,20 +25,20 @@ def print_moonraker_overview(
     headline = f"{COLOR_GREEN}The following instances were found:{RESET_FORMAT}"
     dialog = textwrap.dedent(
         f"""
-        /=======================================================\\
+        ╔═══════════════════════════════════════════════════════╗
-        |{headline:^64}|
+        ║{headline:^64}║
-        |-------------------------------------------------------|
+        ╟───────────────────────────────────────────────────────╢
         """
     )[1:]
 
     if show_select_all:
         select_all = f"{COLOR_YELLOW}a) Select all{RESET_FORMAT}"
-        dialog += f"| {select_all:<63}|\n"
+        dialog += f"║ {select_all:<63}║\n"
-        dialog += "|                                                       |\n"
+        dialog += "║                                                       ║\n"
 
     instance_map = {
-        k.get_service_file_name(): (
+        k.service_file_path.stem: (
-            k.get_service_file_name().replace("klipper", "moonraker")
+            k.service_file_path.stem.replace("klipper", "moonraker")
             if k.suffix in [m.suffix for m in moonraker_instances]
             else ""
         )
@@ -50,19 +48,20 @@ 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"
+        dialog += f"║ {line:<63}║\n"
 
     warn_l1 = f"{COLOR_YELLOW}PLEASE NOTE: {RESET_FORMAT}"
     warn_l2 = f"{COLOR_YELLOW}If you select an instance with an existing Moonraker{RESET_FORMAT}"
     warn_l3 = f"{COLOR_YELLOW}instance, that Moonraker instance will be re-created!{RESET_FORMAT}"
     warning = textwrap.dedent(
         f"""
-        |                                                       |
+        ║                                                       ║
-        |-------------------------------------------------------|
+        ╟───────────────────────────────────────────────────────╢
-        | {warn_l1:<63}|
+        ║ {warn_l1:<63}║
-        | {warn_l2:<63}|
+        ║ {warn_l2:<63}║
-        | {warn_l3:<63}|
+        ║ {warn_l3:<63}║
+        ╟───────────────────────────────────────────────────────╢
         """
     )[1:]
 

kiauh/components/moonraker/moonraker_remove.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,18 +6,20 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
-import shutil
+from subprocess import DEVNULL, PIPE, CalledProcessError, run
-import subprocess
+from typing import List
-from typing import List, Union
 
 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.filesystem_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.instance_utils import get_instances
+from utils.sys_utils import unit_file_exists
 
 
 def run_moonraker_removal(
@@ -27,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:
+        if instances:
-            instances_to_remove = select_instances_to_remove(im.instances)
+            instances_to_remove = select_instances_to_remove(instances)
-            remove_instances(im, instances_to_remove)
+            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:
+    delete_remaining: bool = remove_polkit or remove_dir or remove_env
-        Logger.print_warn("There are still other Moonraker services installed!")
+    if delete_remaining and unit_file_exists("moonraker", suffix="service"):
-        Logger.print_warn("Therefor the following parts cannot be removed:")
+        Logger.print_info("There are still other Moonraker services installed")
-        Logger.print_warn(
+        Logger.print_info(
-            """
+            "●  Moonraker PolicyKit rules were not removed.", prefix=False
-            ● Moonraker PolicyKit rules
-            ● Moonraker local repository
-            ● Moonraker Python environment
-            """,
-            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()
+            run_remove_routines(MOONRAKER_ENV_DIR)
-
-    # delete moonraker logs of all instances
-    if delete_logs:
-        Logger.print_status("Removing all Moonraker logs ...")
-        delete_moonraker_logs(im.instances)
 
 
 def select_instances_to_remove(
     instances: List[Moonraker],
-) -> Union[List[Moonraker], None]:
+) -> List[Moonraker] | None:
-    print_instance_overview(instances, True, True)
+    start_index = 1
-
+    options = [str(i + start_index) for i in range(len(instances))]
-    options = [str(i) for i in range(len(instances))]
+    options.extend(["a", "b"])
-    options.extend(["a", "A", "b", "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_map[selection])
-        instances_to_remove.append(instance)
 
     return instances_to_remove
 
 
 def remove_instances(
-    instance_manager: InstanceManager,
+    instance_list: List[Moonraker] | None,
-    instance_list: List[Moonraker],
 ) -> 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()} ...")
+        Logger.print_status(f"Removing instance {instance.service_file_path.stem} ...")
-        instance_manager.current_instance = instance
+        InstanceManager.remove(instance)
-        instance_manager.stop_instance()
+        delete_moonraker_env_file(instance)
-        instance_manager.disable_instance()
-        instance_manager.delete_instance()
-
-    instance_manager.reload_daemon()
-
-
-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}")
 
 
 def remove_polkit_rules() -> None:
@@ -132,24 +104,18 @@ def remove_polkit_rules() -> None:
         return
 
     try:
-        command = [f"{MOONRAKER_DIR}/scripts/set-policykit-rules.sh", "--clear"]
+        cmd = [f"{MOONRAKER_DIR}/scripts/set-policykit-rules.sh", "--clear"]
-        subprocess.run(
+        run(cmd, stderr=PIPE, stdout=DEVNULL, check=True)
-            command, stderr=subprocess.PIPE, stdout=subprocess.DEVNULL, check=True
+    except CalledProcessError as e:
-        )
-    except subprocess.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:
+def delete_moonraker_env_file(instance: Moonraker):
-    all_logfiles = []
+    Logger.print_status(f"Remove '{instance.env_file}'")
-    for instance in instances:
+    if not instance.env_file.exists():
-        all_logfiles = list(instance.log_dir.glob("moonraker.log*"))
+        msg = f"Env file in {instance.base.sysd_dir} not found. Skipped ..."
-    if not all_logfiles:
+        Logger.print_info(msg)
-        Logger.print_info("No Moonraker logs found. Skipped ...")
         return
-
+    run_remove_routines(instance.env_file)
-    for log in all_logfiles:
-        Logger.print_status(f"Remove '{log}'")
-        remove_file(log)

kiauh/components/moonraker/moonraker_setup.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,160 +6,166 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
+import json
 import subprocess
-import sys
-from pathlib import Path
 from typing import List
 
-from components.webui_client import MAINSAIL_DIR
-from components.webui_client.client_utils import enable_mainsail_remotemode
-from kiauh import KIAUH_CFG
 from components.klipper.klipper import Klipper
-from components.klipper.klipper_dialogs import print_instance_overview
 from components.moonraker import (
     EXIT_MOONRAKER_SETUP,
-    DEFAULT_MOONRAKER_REPO_URL,
+    MOONRAKER_DEPS_JSON_FILE,
     MOONRAKER_DIR,
     MOONRAKER_ENV_DIR,
-    MOONRAKER_REQUIREMENTS_TXT,
+    MOONRAKER_INSTALL_SCRIPT,
-    POLKIT_LEGACY_FILE,
+    MOONRAKER_REQ_FILE,
+    MOONRAKER_SPEEDUPS_REQ_FILE,
     POLKIT_FILE,
-    POLKIT_USR_FILE,
+    POLKIT_LEGACY_FILE,
     POLKIT_SCRIPT,
+    POLKIT_USR_FILE,
 )
 from components.moonraker.moonraker import Moonraker
 from components.moonraker.moonraker_dialogs import print_moonraker_overview
 from components.moonraker.moonraker_utils import (
-    create_example_moonraker_conf,
     backup_moonraker_dir,
+    create_example_moonraker_conf,
 )
-from core.config_manager.config_manager import ConfigManager
+from components.webui_client.client_utils import (
+    enable_mainsail_remotemode,
+    get_existing_clients,
+)
+from components.webui_client.mainsail_data import MainsailData
 from core.instance_manager.instance_manager import InstanceManager
-from core.repo_manager.repo_manager import RepoManager
+from core.logger import Logger
-from utils.filesystem_utils import check_file_exist
+from core.settings.kiauh_settings import KiauhSettings
+from utils.common import check_install_dependencies
+from utils.fs_utils import check_file_exist
+from utils.git_utils import git_clone_wrapper, git_pull_wrapper
 from utils.input_utils import (
     get_confirm,
     get_selection_input,
 )
-from utils.logger import Logger
+from utils.instance_utils import get_instances
-from utils.system_utils import (
+from utils.sys_utils import (
-    parse_packages_from_file,
+    check_python_version,
+    cmd_sysctl_manage,
+    cmd_sysctl_service,
     create_python_venv,
     install_python_requirements,
-    update_system_package_lists,
+    parse_packages_from_file,
-    install_system_packages,
 )
 
 
 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)
+    moonraker_list: List[Moonraker] = get_instances(Moonraker)
-    klipper_instances = kl_im.instances
+    instances: List[Moonraker] = []
-    mr_im = InstanceManager(Moonraker)
+    selected_option: str | Klipper
-    moonraker_instances = mr_im.instances
 
-    selected_klipper_instance = 0
+    if len(klipper_list) == 1:
-    if len(klipper_instances) > 1:
+        instances.append(Moonraker(klipper_list[0].suffix))
+    else:
         print_moonraker_overview(
-            klipper_instances,
+            klipper_list,
-            moonraker_instances,
+            moonraker_list,
             show_index=True,
             show_select_all=True,
         )
-        options = [str(i) for i in range(len(klipper_instances))]
+        options = {str(i + 1): k for i, k in enumerate(klipper_list)}
-        options.extend(["a", "A", "b", "B"])
+        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_option == "b":
-    if selected_klipper_instance == "b":
+            Logger.print_status(EXIT_MOONRAKER_SETUP)
-        Logger.print_status(EXIT_MOONRAKER_SETUP)
+            return
-        return
 
-    elif selected_klipper_instance == "a":
+        if selected_option == "a":
-        for instance in klipper_instances:
+            instances.extend([Moonraker(k.suffix) for k in klipper_list])
-            instance_names.append(instance.suffix)
+        else:
-
+            klipper_instance: Klipper | None = options.get(selected_option)
-    else:
+            if klipper_instance is None:
-        index = int(selected_klipper_instance)
+                raise Exception("Error selecting instance!")
-        instance_names.append(klipper_instances[index].suffix)
+            instances.append(Moonraker(klipper_instance.suffix))
 
     create_example_cfg = get_confirm("Create example moonraker.conf?")
-    setup_moonraker_prerequesites()
-    install_moonraker_polkit()
 
-    used_ports_map = {
+    try:
-        instance.suffix: instance.port for instance in moonraker_instances
+        check_install_dependencies()
-    }
+        setup_moonraker_prerequesites()
-    for name in instance_names:
+        install_moonraker_polkit()
-        current_instance = Moonraker(suffix=name)
 
-        mr_im.current_instance = current_instance
+        used_ports_map = {m.suffix: m.port for m in moonraker_list}
-        mr_im.create_instance()
+        for instance in instances:
-        mr_im.enable_instance()
+            instance.create()
+            cmd_sysctl_service(instance.service_file_path.name, "enable")
 
-        if create_example_cfg:
+            if create_example_cfg:
-            create_example_moonraker_conf(current_instance, used_ports_map)
+                # 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(instance, used_ports_map, clients)
 
-        mr_im.start_instance()
+            cmd_sysctl_service(instance.service_file_path.name, "start")
 
-    mr_im.reload_daemon()
+        cmd_sysctl_manage("daemon-reload")
 
-    # if mainsail is installed, and we installed
+        # if mainsail is installed, and we installed
-    # multiple moonraker instances, we enable mainsails remote mode
+        # multiple moonraker instances, we enable mainsails remote mode
-    if MAINSAIL_DIR.exists() and len(mr_im.instances) > 1:
+        if MainsailData().client_dir.exists() and len(moonraker_list) > 1:
-        enable_mainsail_remotemode()
+            enable_mainsail_remotemode()
+
+    except Exception as e:
+        Logger.print_error(f"Error while installing Moonraker: {e}")
+        return
 
 
-def check_moonraker_install_requirements() -> bool:
+def check_moonraker_install_requirements(klipper_list: List[Klipper]) -> bool:
-    if not (sys.version_info.major >= 3 and sys.version_info.minor >= 7):
+    def check_klipper_instances() -> bool:
-        Logger.print_error("Versioncheck failed!")
+        if len(klipper_list) >= 1:
-        Logger.print_error("Python 3.7 or newer required to run Moonraker.")
+            return True
-        return False
 
-    kl_instance_count = len(InstanceManager(Klipper).instances)
-    if kl_instance_count < 1:
         Logger.print_warn("Klipper not installed!")
         Logger.print_warn("Moonraker cannot be installed! Install Klipper first.")
         return False
 
-    mr_instance_count = len(InstanceManager(Moonraker).instances)
+    return check_python_version(3, 7) and check_klipper_instances()
-    if mr_instance_count >= kl_instance_count:
-        Logger.print_warn("Unable to install more Moonraker instances!")
-        Logger.print_warn("More Klipper instances required.")
-        return False
-
-    return True
 
 
 def setup_moonraker_prerequesites() -> None:
-    cm = ConfigManager(cfg_file=KIAUH_CFG)
+    settings = KiauhSettings()
-    repo = str(
+    repo = settings.moonraker.repo_url
-        cm.get_value("moonraker", "repository_url") or DEFAULT_MOONRAKER_REPO_URL
+    branch = settings.moonraker.branch
-    )
-    branch = str(cm.get_value("moonraker", "branch") or "master")
 
-    repo_manager = RepoManager(
+    git_clone_wrapper(repo, MOONRAKER_DIR, branch)
-        repo=repo,
-        branch=branch,
-        target_dir=MOONRAKER_DIR,
-    )
-    repo_manager.clone_repo()
 
     # install moonraker dependencies and create python virtualenv
-    install_moonraker_packages(MOONRAKER_DIR)
+    install_moonraker_packages()
-    create_python_venv(MOONRAKER_ENV_DIR)
+    if create_python_venv(MOONRAKER_ENV_DIR):
-    install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQUIREMENTS_TXT)
+        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:
+def install_moonraker_packages() -> None:
-    script = moonraker_dir.joinpath("scripts/install-moonraker.sh")
+    moonraker_deps = []
-    packages = parse_packages_from_file(script)
+
-    update_system_package_lists(silent=False)
+    if MOONRAKER_DEPS_JSON_FILE.exists():
-    install_system_packages(packages)
+        with open(MOONRAKER_DEPS_JSON_FILE, "r") as deps:
+            moonraker_deps = json.load(deps).get("debian", [])
+    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})
 
 
 def install_moonraker_polkit() -> None:
@@ -178,7 +182,10 @@ def install_moonraker_polkit() -> None:
     try:
         command = [POLKIT_SCRIPT, "--disable-systemctl"]
         result = subprocess.run(
-            command, stderr=subprocess.PIPE, stdout=subprocess.DEVNULL, text=True
+            command,
+            stderr=subprocess.PIPE,
+            stdout=subprocess.DEVNULL,
+            text=True,
         )
         if result.returncode != 0 or result.stderr:
             Logger.print_error(f"{result.stderr}", False)
@@ -191,43 +198,22 @@ def install_moonraker_polkit() -> None:
         Logger.print_error(log)
 
 
-def handle_existing_instances(instance_list: List[Klipper]) -> bool:
-    instance_count = len(instance_list)
-
-    if instance_count > 0:
-        print_instance_overview(instance_list)
-        if not get_confirm("Add new instances?", allow_go_back=True):
-            return False
-
-    return True
-
-
 def update_moonraker() -> None:
     if not get_confirm("Update Moonraker now?"):
         return
 
-    cm = ConfigManager(cfg_file=KIAUH_CFG)
+    settings = KiauhSettings()
-    if cm.get_value("kiauh", "backup_before_update"):
+    if settings.kiauh.backup_before_update:
         backup_moonraker_dir()
 
-    instance_manager = InstanceManager(Moonraker)
+    instances = get_instances(Moonraker)
-    instance_manager.stop_all_instance()
+    InstanceManager.stop_all(instances)
 
-    repo = str(
+    git_pull_wrapper(repo=settings.moonraker.repo_url, target_dir=MOONRAKER_DIR)
-        cm.get_value("moonraker", "repository_url") or DEFAULT_MOONRAKER_REPO_URL
-    )
-    branch = str(cm.get_value("moonraker", "branch") or "master")
-
-    repo_manager = RepoManager(
-        repo=repo,
-        branch=branch,
-        target_dir=MOONRAKER_DIR,
-    )
-    repo_manager.pull_repo()
 
     # 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

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -10,49 +8,41 @@
 # ======================================================================= #
 
 import shutil
-from typing import Dict, Literal, List, Union
+from typing import Dict, List, Optional
 
 from components.moonraker import (
-    DEFAULT_MOONRAKER_PORT,
     MODULE_PATH,
-    MOONRAKER_DIR,
-    MOONRAKER_ENV_DIR,
     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 import MAINSAIL_DIR
+from components.webui_client.base_data import BaseWebClient
-from components.webui_client.client_utils import enable_mainsail_remotemode
 from core.backup_manager.backup_manager import BackupManager
-from core.config_manager.config_manager import ConfigManager
+from core.logger import Logger
-from core.instance_manager.instance_manager import InstanceManager
+from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
-from core.repo_manager.repo_manager import RepoManager
+    SimpleConfigParser,
-from utils.common import get_install_status_common
+)
-from utils.logger import Logger
+from core.types import ComponentStatus
-from utils.system_utils import (
+from utils.common import get_install_status
+from utils.instance_utils import get_instances
+from utils.sys_utils import (
     get_ipv4_addr,
 )
 
 
-def get_moonraker_status() -> Dict[
+def get_moonraker_status() -> ComponentStatus:
-    Literal["status", "status_code", "instances", "repo", "local", "remote"],
+    return get_install_status(MOONRAKER_DIR, MOONRAKER_ENV_DIR, Moonraker)
-    Union[str, int],
-]:
-    status = get_install_status_common(Moonraker, MOONRAKER_DIR, MOONRAKER_ENV_DIR)
-    return {
-        "status": status.get("status"),
-        "status_code": status.get("status_code"),
-        "instances": status.get("instances"),
-        "repo": RepoManager.get_repo_name(MOONRAKER_DIR),
-        "local": RepoManager.get_local_commit(MOONRAKER_DIR),
-        "remote": RepoManager.get_remote_commit(MOONRAKER_DIR),
-    }
 
 
 def create_example_moonraker_conf(
-    instance: Moonraker, ports_map: Dict[str, int]
+    instance: Moonraker,
+    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
@@ -76,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)
 
@@ -84,58 +74,54 @@ 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")
 
-    cm = ConfigManager(target)
+    scp = SimpleConfigParser()
-    trusted_clients = f"\n{'.'.join(ip)}"
+    scp.read_file(target)
-    trusted_clients += cm.get_value("authorization", "trusted_clients")
+    trusted_clients: List[str] = [
+        f"    {'.'.join(ip)}\n",
+        *scp.getval("authorization", "trusted_clients"),
+    ]
 
-    cm.set_value("server", "port", str(port))
+    scp.set_option("server", "port", str(port))
-    cm.set_value("server", "klippy_uds_address", str(uds))
+    scp.set_option("server", "klippy_uds_address", str(uds))
-    cm.set_value("authorization", "trusted_clients", trusted_clients)
+    scp.set_option("authorization", "trusted_clients", trusted_clients)
 
-    cm.write_config()
+    # add existing client and client configs in the update section
-    Logger.print_ok(f"Example moonraker.conf created in '{instance.cfg_dir}'")
+    if clients is not None and len(clients) > 0:
+        for c in clients:
+            # client part
+            c_section = f"update_manager {c.name}"
+            c_options = [
+                ("type", "web"),
+                ("channel", "stable"),
+                ("repo", c.repo_path),
+                ("path", c.client_dir),
+            ]
+            scp.add_section(section=c_section)
+            for option in c_options:
+                scp.set_option(c_section, option[0], option[1])
+
+            # client config part
+            c_config = c.client_config
+            if c_config.config_dir.exists():
+                c_config_section = f"update_manager {c_config.name}"
+                c_config_options = [
+                    ("type", "git_repo"),
+                    ("primary_branch", "master"),
+                    ("path", c_config.config_dir),
+                    ("origin", c_config.repo_url),
+                    ("managed_services", "klipper"),
+                ]
+                scp.add_section(section=c_config_section)
+                for option in c_config_options:
+                    scp.set_option(c_config_section, option[0], option[1])
+
+    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:
+def backup_moonraker_dir() -> 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 klipper instance with the new name
-    im.current_instance = Moonraker(suffix=new_name)
-    # 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 MAINSAIL_DIR.exists() and len(im.instances) > 1:
-        enable_mainsail_remotemode()
-
-
-def backup_moonraker_dir():
     bm = BackupManager()
     bm.backup_directory("moonraker", source=MOONRAKER_DIR, target=MOONRAKER_BACKUP_DIR)
     bm.backup_directory(
@@ -144,12 +130,11 @@ def backup_moonraker_dir():
 
 
 def backup_moonraker_db_dir() -> None:
-    im = InstanceManager(Moonraker)
+    instances: List[Moonraker] = get_instances(Moonraker)
-    instances: List[Moonraker] = im.instances
     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/__init__.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -10,68 +8,5 @@
 # ======================================================================= #
 
 from pathlib import Path
-from typing import Literal, TypedDict, Set
-
-from core.backup_manager import BACKUP_ROOT_DIR
 
 MODULE_PATH = Path(__file__).resolve().parent
-
-###########
-# MAINSAIL
-###########
-MAINSAIL_DIR = Path.home().joinpath("mainsail")
-MAINSAIL_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("mainsail-backups")
-MAINSAIL_CONFIG_DIR = Path.home().joinpath("mainsail-config")
-MAINSAIL_CONFIG_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("mainsail-config-backups")
-MAINSAIL_CONFIG_REPO_URL = "https://github.com/mainsail-crew/mainsail-config.git"
-MAINSAIL_CONFIG_JSON = MAINSAIL_DIR.joinpath("config.json")
-MAINSAIL_URL = (
-    "https://github.com/mainsail-crew/mainsail/releases/latest/download/mainsail.zip"
-)
-MAINSAIL_PRE_RLS_URL = (
-    "https://github.com/mainsail-crew/mainsail/releases/download/%TAG%/mainsail.zip"
-)
-MAINSAIL_TAGS_URL = "https://api.github.com/repos/mainsail-crew/mainsail/tags"
-
-#########
-# FLUIDD
-#########
-FLUIDD_DIR = Path.home().joinpath("fluidd")
-FLUIDD_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("fluidd-backups")
-FLUIDD_CONFIG_DIR = Path.home().joinpath("fluidd-config")
-FLUIDD_CONFIG_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("fluidd-config-backups")
-FLUIDD_CONFIG_REPO_URL = "https://github.com/fluidd-core/fluidd-config.git"
-FLUIDD_URL = "https://github.com/fluidd-core/fluidd/releases/latest/download/fluidd.zip"
-FLUIDD_PRE_RLS_URL = (
-    "https://github.com/fluidd-core/fluidd/releases/download/%TAG%/fluidd.zip"
-)
-FLUIDD_TAGS_URL = "https://api.github.com/repos/fluidd-core/fluidd/tags"
-
-ClientName = Literal["mainsail", "fluidd"]
-ClientConfigName = Literal["mainsail-config", "fluidd-config"]
-
-
-class ClientData(TypedDict):
-    name: ClientName
-    display_name: str
-    dir: Path
-    backup_dir: Path
-    url: str
-    pre_release_url: str
-    tags_url: str
-    remote_mode: bool  # required only for Mainsail
-    mr_conf_repo: str
-    mr_conf_path: str
-    client_config: "ClientConfigData"
-
-
-class ClientConfigData(TypedDict):
-    name: ClientConfigName
-    display_name: str
-    cfg_filename: str
-    dir: Path
-    backup_dir: Path
-    url: str
-    printer_cfg_section: str
-    mr_conf_path: str
-    mr_conf_origin: str

kiauh/components/webui_client/base_data.py

@@ -0,0 +1,56 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from __future__ import annotations
+
+from abc import ABC
+from dataclasses import dataclass
+from enum import Enum
+from pathlib import Path
+
+
+class WebClientType(Enum):
+    MAINSAIL: str = "mainsail"
+    FLUIDD: str = "fluidd"
+
+
+class WebClientConfigType(Enum):
+    MAINSAIL: str = "mainsail-config"
+    FLUIDD: str = "fluidd-config"
+
+
+@dataclass()
+class BaseWebClient(ABC):
+    """Base class for webclient data"""
+
+    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"""
+
+    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

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -10,55 +8,36 @@
 # ======================================================================= #
 
 
-import shutil
-import subprocess
 from typing import List
 
 from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
-from components.webui_client import ClientConfigData
+from components.webui_client.base_data import BaseWebClientConfig
-from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
-from utils.filesystem_utils import remove_file, remove_config_section
+from utils.config_utils import remove_config_section
-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(
-    client_config: ClientConfigData,
+    client_config: BaseWebClientConfig,
-    remove_moonraker_conf_section: bool,
-    remove_printer_cfg_include: bool,
     kl_instances: List[Klipper],
     mr_instances: List[Moonraker],
 ) -> None:
     remove_client_config_dir(client_config)
     remove_client_config_symlink(client_config)
-    if remove_moonraker_conf_section:
+    remove_config_section(f"update_manager {client_config.name}", mr_instances)
-        remove_config_section(
+    remove_config_section(client_config.config_section, kl_instances)
-            f"update_manager {client_config.get('name')}", mr_instances
-        )
-    if remove_printer_cfg_include:
-        remove_config_section(client_config.get("printer_cfg_section"), kl_instances)
 
 
-def remove_client_config_dir(client_config: ClientConfigData) -> None:
+def remove_client_config_dir(client_config: BaseWebClientConfig) -> None:
-    Logger.print_status(f"Removing {client_config.get('name')} ...")
+    Logger.print_status(f"Removing {client_config.display_name} ...")
-    client_config_dir = client_config.get("dir")
+    run_remove_routines(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}")
 
 
-def remove_client_config_symlink(client_config: ClientConfigData) -> None:
+def remove_client_config_symlink(client_config: BaseWebClientConfig) -> None:
-    Logger.print_status(f"Removing {client_config.get('cfg_filename')} symlinks ...")
+    instances: List[Klipper] = get_instances(Klipper)
-    im = InstanceManager(Klipper)
-    instances: List[Klipper] = im.instances
     for instance in instances:
-        Logger.print_status(f"Removing symlink from '{instance.cfg_file}' ...")
+        run_remove_routines(
-        try:
+            instance.base.cfg_dir.joinpath(client_config.config_filename)
-            remove_file(instance.cfg_dir.joinpath(client_config.get("cfg_filename")))
+        )
-        except subprocess.CalledProcessError:
-            Logger.print_error("Failed to remove symlink!")

kiauh/components/webui_client/client_config/client_config_setup.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,136 +6,118 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import shutil
 import subprocess
 from pathlib import Path
-from typing import List, get_args
+from typing import List
 
-from kiauh import KIAUH_CFG
 from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
-from components.webui_client import ClientConfigData, ClientName, ClientData
+from components.webui_client.base_data import BaseWebClient, BaseWebClientConfig
-from components.webui_client.client_dialogs import print_client_already_installed_dialog
+from components.webui_client.client_dialogs import (
+    print_client_already_installed_dialog,
+)
 from components.webui_client.client_utils import (
-    load_client_data,
     backup_client_config_data,
+    detect_client_cfg_conflict,
 )
-from core.config_manager.config_manager import ConfigManager
-
 from core.instance_manager.instance_manager import InstanceManager
-from core.repo_manager.repo_manager import RepoManager
+from core.logger import Logger
-from utils.filesystem_utils import (
+from core.settings.kiauh_settings import KiauhSettings
-    create_symlink,
+from utils.common import backup_printer_config_dir
-    add_config_section,
+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_name: ClientName) -> None:
+def install_client_config(client_data: BaseWebClient) -> None:
-    client: ClientData = load_client_data(client_name)
+    client_config: BaseWebClientConfig = client_data.client_config
-    client_config: ClientConfigData = client.get("client_config")
+    display_name = client_config.display_name
-    d_name = client_config.get("display_name")
 
-    if check_existing_client_config_install(client_name):
+    if detect_client_cfg_conflict(client_data):
         Logger.print_info("Another Client-Config is already installed! Skipped ...")
         return
 
-    if client_config.get("dir").exists():
+    if client_config.config_dir.exists():
-        print_client_already_installed_dialog(d_name)
+        print_client_already_installed_dialog(display_name)
-        if get_confirm(f"Re-install {d_name}?", allow_go_back=True):
+        if get_confirm(f"Re-install {display_name}?", allow_go_back=True):
-            shutil.rmtree(client_config.get("dir"))
+            shutil.rmtree(client_config.config_dir)
         else:
             return
 
-    mr_im = InstanceManager(Moonraker)
+    mr_instances: List[Moonraker] = get_instances(Moonraker)
-    mr_instances: List[Moonraker] = mr_im.instances
+    kl_instances = get_instances(Klipper)
-    kl_im = InstanceManager(Klipper)
-    kl_instances = kl_im.instances
 
     try:
         download_client_config(client_config)
         create_client_config_symlink(client_config, kl_instances)
+
+        backup_printer_config_dir()
+
         add_config_section(
-            section=f"update_manager {client_config.get('name')}",
+            section=f"update_manager {client_config.name}",
             instances=mr_instances,
             options=[
                 ("type", "git_repo"),
                 ("primary_branch", "master"),
-                ("path", client_config.get("mr_conf_path")),
+                ("path", str(client_config.config_dir)),
-                ("origin", client_config.get("mr_conf_origin")),
+                ("origin", str(client_config.repo_url)),
                 ("managed_services", "klipper"),
             ],
         )
-        add_config_section(client_config.get("printer_cfg_section"), kl_instances)
+        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"{d_name} installation failed!\n{e}")
+        Logger.print_error(f"{display_name} installation failed!\n{e}")
         return
 
-    Logger.print_ok(f"{d_name} installation complete!", start="\n")
+    Logger.print_ok(f"{display_name} installation complete!", start="\n")
 
 
-def check_existing_client_config_install(client_name: ClientName) -> bool:
+def download_client_config(client_config: BaseWebClientConfig) -> None:
-    # check if any other client-configs are present
-    # as they can conflict each other, or are at least
-    # redundant to have, so we skip the installation
-    client_list = list(get_args(ClientName))
-    client_list.remove(client_name)
-    for c in client_list:
-        c_data: ClientData = load_client_data(c)
-        c_config_data: ClientConfigData = c_data.get("client_config")
-        if c_config_data.get("dir").exists():
-            return True
-
-    return False
-
-
-def download_client_config(client_config: ClientConfigData) -> None:
     try:
-        Logger.print_status(f"Downloading {client_config.get('display_name')} ...")
+        Logger.print_status(f"Downloading {client_config.display_name} ...")
-        rm = RepoManager(
+        repo = client_config.repo_url
-            client_config.get("url"), target_dir=str(client_config.get("dir"))
+        target_dir = client_config.config_dir
-        )
+        git_clone_wrapper(repo, target_dir)
-        rm.clone_repo()
     except Exception:
-        Logger.print_error(f"Downloading {client_config.get('display_name')} failed!")
+        Logger.print_error(f"Downloading {client_config.display_name} failed!")
         raise
 
 
-def update_client_config(client: ClientData) -> None:
+def update_client_config(client: BaseWebClient) -> None:
-    client_config: ClientConfigData = client.get("client_config")
+    client_config: BaseWebClientConfig = client.client_config
 
-    Logger.print_status(f"Updating {client_config.get('display_name')} ...")
+    Logger.print_status(f"Updating {client_config.display_name} ...")
 
-    cm = ConfigManager(cfg_file=KIAUH_CFG)
+    if not client_config.config_dir.exists():
-    if cm.get_value("kiauh", "backup_before_update"):
+        Logger.print_info(
+            f"Unable to update {client_config.display_name}. Directory does not exist! Skipping ..."
+        )
+        return
+
+    settings = KiauhSettings()
+    if settings.kiauh.backup_before_update:
         backup_client_config_data(client)
 
-    repo_manager = RepoManager(
+    git_pull_wrapper(client_config.repo_url, client_config.config_dir)
-        repo=client_config.get("url"),
-        branch="master",
-        target_dir=str(client_config.get("dir")),
-    )
-    repo_manager.pull_repo()
 
-    Logger.print_ok(f"Successfully updated {client_config.get('display_name')}.")
+    Logger.print_ok(f"Successfully updated {client_config.display_name}.")
-    Logger.print_warn("Remember to restart Klipper to reload the configurations!")
+    Logger.print_info("Restart Klipper to reload the configuration!")
 
 
 def create_client_config_symlink(
-    client_config: ClientConfigData, 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.get('cfg_filename')} ...")
-    source = Path(client_config.get("dir"), client_config.get("cfg_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

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -9,103 +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 import ClientData
+from components.webui_client.base_data import BaseWebClient
-from core.menus.base_menu import print_back_footer
+from core.logger import DialogType, Logger
-from utils.constants import RESET_FORMAT, COLOR_YELLOW, COLOR_CYAN
 
 
-def print_moonraker_not_found_dialog():
+def print_moonraker_not_found_dialog() -> None:
-    line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
+    Logger.print_dialog(
-    line2 = f"{COLOR_YELLOW}No local Moonraker installation was found!{RESET_FORMAT}"
+        DialogType.WARNING,
-    dialog = textwrap.dedent(
+        [
-        f"""
+            "No local Moonraker installation was found!",
-        /=======================================================\\
+            "\n\n",
-        | {line1:<63}|
+            "It is possible to install Mainsail without a local Moonraker installation. "
-        | {line2:<63}|
+            "If you continue, you need to make sure, that Moonraker is installed on "
-        |-------------------------------------------------------|
+            "another machine in your network. Otherwise Mainsail will NOT work "
-        | It is possible to install Mainsail without a local    |
+            "correctly.",
-        | 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_client_already_installed_dialog(name: str):
+def print_client_already_installed_dialog(name: str) -> None:
-    line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
+    Logger.print_dialog(
-    line2 = f"{COLOR_YELLOW}{name} seems to be already installed!{RESET_FORMAT}"
+        DialogType.WARNING,
-    line3 = f"If you continue, your current {name}"
+        [
-    dialog = textwrap.dedent(
+            f"{name} seems to be already installed!",
-        f"""
+            f"If you continue, your current {name} installation will be overwritten.",
-        /=======================================================\\
+        ],
-        | {line1:<63}|
+    )
-        | {line2:<63}|
-        |-------------------------------------------------------|
-        | {line3:<54}|
-        | installation will be overwritten.                     |
-        """
-    )[1:]
-
-    print(dialog, end="")
-    print_back_footer()
 
 
-def print_client_port_select_dialog(name: str, port: str, ports_in_use: List[str]):
+def print_client_port_select_dialog(
-    port = f"{COLOR_CYAN}{port}{RESET_FORMAT}"
+    name: str, port: int, ports_in_use: List[int]
-    line1 = f"Please select the port, {name} should be served on."
+) -> None:
-    line2 = f"In case you need {name} to be served on a specific"
+    Logger.print_dialog(
-    dialog = textwrap.dedent(
+        DialogType.CUSTOM,
-        f"""
+        [
-        /=======================================================\\
+            f"Please select the port, {name} should be served on. If your are unsure "
-        | {line1:<54}|
+            f"what to select, hit Enter to apply the suggested value of: {port}",
-        | If you are unsure what to select, hit Enter to apply  |
+            "\n\n",
-        | the suggested value of: {port:38} |
+            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 "
-        | {line2:<54}|
+            f"on your system!",
-        | port, you can set it now. Make sure the port is not   |
+            "\n\n",
-        | used by any other application on your system!         |
+            "The following ports were found to be in use already:",
-        \\=======================================================/
+            *[f"● {port}" for port in ports_in_use],
-        """
+        ],
-    )[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_install_client_config_dialog(client: ClientData):
+def print_install_client_config_dialog(client: BaseWebClient) -> None:
-    name = client.get("display_name")
+    name = client.display_name
-    url = client.get("client_config").get("url").replace(".git", "")
+    url = client.client_config.repo_url.replace(".git", "")
-    line1 = f"have {name} fully functional and working."
+    Logger.print_dialog(
-    line2 = f"The recommended macros for {name} can be seen here:"
+        DialogType.INFO,
-    dialog = textwrap.dedent(
+        [
-        f"""
+            f"It is recommended to use special macros in order to have {name} fully "
-        /=======================================================\\
+            f"functional and working.",
-        | It is recommended to use special macros in order to   |
+            "\n\n",
-        | {line1:<54}|
+            f"The recommended macros for {name} can be seen here:",
-        |                                                       |
+            url,
-        | {line2:<54}|
+            "\n\n",
-        | {url:<54}|
+            "If you already use these macros skip this step. Otherwise you should "
-        |                                                       |
+            "consider to answer with 'Y' to download the recommended macros.",
-        | If you already use these macros skip this step.       |
+        ],
-        | Otherwise you should consider to answer with 'Y' to   |
+    )
-        | download the recommended macros.                      |
-        \\=======================================================/
-        """
-    )[1:]
 
-    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

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,68 +6,80 @@
 #                                                                         #
 #  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 import ClientData
+from components.webui_client.base_data import (
+    BaseWebClient,
+)
 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.backup_manager.backup_manager import BackupManager
-
+from core.constants import NGINX_SITES_AVAILABLE, NGINX_SITES_ENABLED
-from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
-from utils.filesystem_utils import (
+from utils.config_utils import remove_config_section
-    remove_nginx_config,
+from utils.fs_utils import (
-    remove_nginx_logs,
+    remove_with_sudo,
-    remove_config_section,
+    run_remove_routines,
 )
-from utils.logger import Logger
+from utils.instance_utils import get_instances
 
 
 def run_client_removal(
-    client: ClientData,
+    client: BaseWebClient,
-    rm_client: bool,
+    remove_client: bool,
-    rm_client_config: bool,
+    remove_client_cfg: bool,
-    backup_ms_config_json: bool,
+    backup_config: bool,
-    rm_moonraker_conf_section: bool,
-    rm_printer_cfg_section: bool,
 ) -> None:
-    mr_im = InstanceManager(Moonraker)
+    mr_instances: List[Moonraker] = get_instances(Moonraker)
-    mr_instances: List[Moonraker] = mr_im.instances
+    kl_instances: List[Klipper] = get_instances(Klipper)
-    kl_im = InstanceManager(Klipper)
+
-    kl_instances: List[Klipper] = kl_im.instances
+    if backup_config:
-    if backup_ms_config_json and client.get("name") == "mainsail":
+        bm = BackupManager()
-        backup_mainsail_config_json()
+        bm.backup_file(client.config_file)
-    if rm_client:
+
-        client_name = client.get("name")
+    if remove_client:
+        client_name = client.name
         remove_client_dir(client)
-        remove_nginx_config(client_name)
+        remove_client_nginx_config(client_name)
-        remove_nginx_logs(client_name)
+        remove_client_nginx_logs(client, kl_instances)
-        if rm_moonraker_conf_section:
+
-            section = f"update_manager {client_name}"
+        section = f"update_manager {client_name}"
-            remove_config_section(section, mr_instances)
+        remove_config_section(section, mr_instances)
-    if rm_client_config:
+
+    if remove_client_cfg:
         run_client_config_removal(
-            client.get("client_config"),
+            client.client_config,
-            rm_moonraker_conf_section,
-            rm_printer_cfg_section,
             kl_instances,
             mr_instances,
         )
 
 
-def remove_client_dir(client: ClientData) -> None:
+def remove_client_dir(client: BaseWebClient) -> None:
-    Logger.print_status(f"Removing {client.get('display_name')} ...")
+    Logger.print_status(f"Removing {client.display_name} ...")
-    client_dir = client.get("dir")
+    run_remove_routines(client.client_dir)
-    if not client.get("dir").exists():
+
-        Logger.print_info(f"'{client_dir}' does not exist. Skipping ...")
+
+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:
+    for instance in instances:
-        shutil.rmtree(client_dir)
+        run_remove_routines(
-    except OSError as e:
+            instance.base.log_dir.joinpath(client.nginx_access_log.name)
-        Logger.print_error(f"Unable to delete '{client_dir}':\n{e}")
+        )
+        run_remove_routines(instance.base.log_dir.joinpath(client.nginx_error_log.name))

kiauh/components/webui_client/client_setup.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,200 +6,185 @@
 #                                                                         #
 #  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
 
 from components.klipper.klipper import Klipper
-from components.webui_client import (
-    ClientName,
-    ClientData,
-)
-
 from components.moonraker.moonraker import Moonraker
+from components.webui_client import MODULE_PATH
+from components.webui_client.base_data import (
+    BaseWebClient,
+    BaseWebClientConfig,
+    WebClientType,
+)
 from components.webui_client.client_config.client_config_setup import (
     install_client_config,
-    check_existing_client_config_install,
 )
 from components.webui_client.client_dialogs import (
-    print_moonraker_not_found_dialog,
     print_client_port_select_dialog,
     print_install_client_config_dialog,
+    print_moonraker_not_found_dialog,
 )
 from components.webui_client.client_utils import (
-    backup_mainsail_config_json,
-    restore_mainsail_config_json,
-    enable_mainsail_remotemode,
-    symlink_webui_nginx_log,
-    load_client_data,
-)
-from core.config_manager.config_manager import ConfigManager
-from core.instance_manager.instance_manager import InstanceManager
-from kiauh import KIAUH_CFG
-from utils import NGINX_SITES_AVAILABLE, NGINX_SITES_ENABLED
-from utils.common import check_install_dependencies
-from utils.filesystem_utils import (
-    unzip,
-    copy_upstream_nginx_cfg,
     copy_common_vars_nginx_cfg,
+    copy_upstream_nginx_cfg,
     create_nginx_cfg,
-    create_symlink,
+    detect_client_cfg_conflict,
-    remove_file,
+    enable_mainsail_remotemode,
-    add_config_section,
-    read_ports_from_nginx_configs,
-    is_valid_port,
     get_next_free_port,
+    is_valid_port,
+    read_ports_from_nginx_configs,
+    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.system_utils import (
+from utils.sys_utils import (
+    cmd_sysctl_service,
     download_file,
-    set_nginx_permissions,
     get_ipv4_addr,
-    control_systemd_service,
 )
 
 
-def install_client(client_name: ClientName) -> None:
+def install_client(client: BaseWebClient) -> None:
-    client: ClientData = load_client_data(client_name)
-    d_name = client.get("display_name")
-
     if client is None:
-        Logger.print_error("Missing parameter client_name!")
+        raise ValueError("Missing parameter client_data!")
-        return
 
-    if client.get("dir").exists():
+    if client.client_dir.exists():
         Logger.print_info(
-            f"{client.get('display_name')} seems to be already installed! Skipped ..."
+            f"{client.display_name} seems to be already installed! Skipped ..."
         )
         return
 
-    mr_im = InstanceManager(Moonraker)
+    mr_instances: List[Moonraker] = get_instances(Moonraker)
-    mr_instances: List[Moonraker] = mr_im.instances
 
     enable_remotemode = False
     if not mr_instances:
         print_moonraker_not_found_dialog()
-        if not get_confirm(
+        if not get_confirm(f"Continue {client.display_name} installation?"):
-            f"Continue {d_name} installation?",
-            allow_go_back=True,
-        ):
             return
 
     # if moonraker is not installed or multiple instances
     # are installed we enable mainsails remote mode
-    if client.get("remote_mode") and not mr_instances or len(mr_instances) > 1:
+    if (
+        client.client == WebClientType.MAINSAIL
+        and not mr_instances
+        or len(mr_instances) > 1
+    ):
         enable_remotemode = True
 
-    kl_im = InstanceManager(Klipper)
+    kl_instances = get_instances(Klipper)
-    kl_instances = kl_im.instances
     install_client_cfg = False
-    client_config = client.get("client_config")
+    client_config: BaseWebClientConfig = client.client_config
     if (
         kl_instances
-        and not client_config.get("dir").exists()
+        and not client_config.config_dir.exists()
-        and not check_existing_client_config_install(client.get("name"))
+        and not detect_client_cfg_conflict(client)
     ):
         print_install_client_config_dialog(client)
-        question = f"Download the recommended {client_config.get('display_name')}?"
+        question = f"Download the recommended {client_config.display_name}?"
         install_client_cfg = get_confirm(question, allow_go_back=False)
 
-    cm = ConfigManager(cfg_file=KIAUH_CFG)
+    settings = KiauhSettings()
-    client_port = cm.get_value(client.get("name"), "port")
+    port: int = settings.get(client.name, "port")
-    ports_in_use = read_ports_from_nginx_configs()
+    ports_in_use: List[int] = read_ports_from_nginx_configs()
 
     # check if configured port is a valid number and not in use already
-    valid_port = is_valid_port(client_port, ports_in_use)
+    valid_port = is_valid_port(port, ports_in_use)
     while not valid_port:
         next_port = get_next_free_port(ports_in_use)
-        print_client_port_select_dialog(d_name, next_port, ports_in_use)
+        print_client_port_select_dialog(client.display_name, next_port, ports_in_use)
-        client_port = str(
+        port = get_number_input(
-            get_number_input(
+            f"Configure {client.display_name} for port",
-                f"Configure {d_name} for port",
+            min_count=int(next_port),
-                min_count=int(next_port),
+            default=next_port,
-                default=next_port,
-            )
         )
-        valid_port = is_valid_port(client_port, ports_in_use)
+        valid_port = is_valid_port(port, ports_in_use)
 
-    check_install_dependencies(["nginx"])
+    check_install_dependencies({"nginx"})
 
     try:
         download_client(client)
-        if enable_remotemode and client.get("name") == "mainsail":
+        if enable_remotemode and client.client == WebClientType.MAINSAIL:
             enable_mainsail_remotemode()
         if mr_instances:
             add_config_section(
-                section=f"update_manager {client.get('name')}",
+                section=f"update_manager {client.name}",
                 instances=mr_instances,
                 options=[
                     ("type", "web"),
                     ("channel", "stable"),
-                    ("repo", client.get("mr_conf_repo")),
+                    ("repo", str(client.repo_path)),
-                    ("path", client.get("mr_conf_path")),
+                    ("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.get("name"))
+            install_client_config(client)
 
         copy_upstream_nginx_cfg()
         copy_common_vars_nginx_cfg()
-        create_client_nginx_cfg(client, client_port)
+        create_nginx_cfg(
+            display_name=client.display_name,
+            cfg_name=client.name,
+            template_src=MODULE_PATH.joinpath("assets/nginx_cfg"),
+            PORT=port,
+            ROOT_DIR=client.client_dir,
+            NAME=client.name,
+        )
+
         if kl_instances:
-            symlink_webui_nginx_log(kl_instances)
+            symlink_webui_nginx_log(client, kl_instances)
-        control_systemd_service("nginx", "restart")
+        cmd_sysctl_service("nginx", "restart")
 
     except Exception as e:
-        Logger.print_error(f"{d_name} installation failed!\n{e}")
+        Logger.print_error(f"{client.display_name} installation failed!\n{e}")
         return
 
-    log = f"Open {d_name} now on: http://{get_ipv4_addr()}:{client_port}"
+    log = f"Open {client.display_name} now on: http://{get_ipv4_addr()}:{port}"
-    Logger.print_ok(f"{d_name} installation complete!", start="\n")
+    Logger.print_ok(f"{client.display_name} installation complete!", start="\n")
     Logger.print_ok(log, prefix=False, end="\n\n")
 
 
-def download_client(client: ClientData) -> None:
+def download_client(client: BaseWebClient) -> None:
-    zipfile = f"{client.get('name').lower()}.zip"
+    zipfile = f"{client.name.lower()}.zip"
     target = Path().home().joinpath(zipfile)
     try:
-        Logger.print_status(f"Downloading {zipfile} ...")
+        Logger.print_status(
-        download_file(client.get("url"), target, True)
+            f"Downloading {client.display_name} from {client.download_url} ..."
+        )
+        download_file(client.download_url, target, True)
         Logger.print_ok("Download complete!")
 
         Logger.print_status(f"Extracting {zipfile} ...")
-        unzip(target, client.get("dir"))
+        unzip(target, client.client_dir)
         target.unlink(missing_ok=True)
         Logger.print_ok("OK!")
 
     except Exception:
-        Logger.print_error(f"Downloading {zipfile} failed!")
+        Logger.print_error(f"Downloading {client.display_name} failed!")
         raise
 
 
-def update_client(client: ClientData) -> None:
+def update_client(client: BaseWebClient) -> None:
-    Logger.print_status(f"Updating {client.get('display_name')} ...")
+    Logger.print_status(f"Updating {client.display_name} ...")
-    if client.get("name") == "mainsail":
+    if not client.client_dir.exists():
-        backup_mainsail_config_json(is_temp=True)
+        Logger.print_info(
+            f"Unable to update {client.display_name}. Directory does not exist! Skipping ..."
+        )
+        return
 
-    download_client(client)
+    with tempfile.NamedTemporaryFile(suffix=".json") as tmp_file:
-
+        Logger.print_status(
-    if client.get("name") == "mainsail":
+            f"Creating temporary backup of {client.config_file} as {tmp_file.name} ..."
-        restore_mainsail_config_json()
+        )
-
+        shutil.copy(client.config_file, tmp_file.name)
-
+        download_client(client)
-def create_client_nginx_cfg(client: ClientData, port: int) -> None:
+        shutil.copy(tmp_file.name, client.config_file)
-    d_name = client.get("display_name")
-    root_dir = client.get("dir")
-    source = NGINX_SITES_AVAILABLE.joinpath(client.get("name"))
-    target = NGINX_SITES_ENABLED.joinpath(client.get("name"))
-    try:
-        Logger.print_status(f"Creating NGINX config for {d_name} ...")
-        remove_file(Path("/etc/nginx/sites-enabled/default"), True)
-        create_nginx_cfg(client.get("name"), port, root_dir)
-        create_symlink(source, target, True)
-        set_nginx_permissions()
-        Logger.print_ok(f"NGINX config for {d_name} successfully created.")
-    except Exception:
-        Logger.print_error(f"Creating NGINX config for {d_name} failed!")
-        raise

kiauh/components/webui_client/client_utils.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,164 +6,117 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import json
+import re
 import shutil
-from json import JSONDecodeError
 from pathlib import Path
-from typing import List, Optional, Dict, Literal, Union
+from subprocess import PIPE, CalledProcessError, run
-
+from typing import List, get_args
-import urllib.request
 
 from components.klipper.klipper import Klipper
-from components.webui_client import (
+from components.webui_client import MODULE_PATH
-    MAINSAIL_CONFIG_JSON,
+from components.webui_client.base_data import (
-    MAINSAIL_DIR,
+    BaseWebClient,
-    MAINSAIL_BACKUP_DIR,
+    WebClientType,
-    FLUIDD_PRE_RLS_URL,
-    FLUIDD_BACKUP_DIR,
-    FLUIDD_URL,
-    FLUIDD_DIR,
-    ClientData,
-    FLUIDD_CONFIG_REPO_URL,
-    FLUIDD_CONFIG_DIR,
-    ClientConfigData,
-    MAINSAIL_PRE_RLS_URL,
-    MAINSAIL_URL,
-    MAINSAIL_CONFIG_REPO_URL,
-    MAINSAIL_CONFIG_DIR,
-    ClientName,
-    MAINSAIL_TAGS_URL,
-    FLUIDD_TAGS_URL,
-    FLUIDD_CONFIG_BACKUP_DIR,
-    MAINSAIL_CONFIG_BACKUP_DIR,
 )
+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.repo_manager.repo_manager import RepoManager
+from core.constants import (
-from utils import NGINX_SITES_AVAILABLE, NGINX_CONFD
+    COLOR_CYAN,
-from utils.common import get_install_status_webui, get_install_status_common
+    COLOR_YELLOW,
-from utils.constants import COLOR_CYAN, RESET_FORMAT, COLOR_YELLOW
+    NGINX_CONFD,
-from utils.logger import Logger
+    NGINX_SITES_AVAILABLE,
+    NGINX_SITES_ENABLED,
+    RESET_FORMAT,
+)
+from core.logger import Logger
+from core.settings.kiauh_settings import KiauhSettings
+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.fs_utils import create_symlink, remove_file
+from utils.git_utils import (
+    get_latest_remote_tag,
+    get_latest_unstable_tag,
+)
+from utils.instance_utils import get_instances
 
 
-def load_client_data(client_name: ClientName) -> Optional[ClientData]:
+def get_client_status(
-    client_data = None
+    client: BaseWebClient, fetch_remote: bool = False
-
+) -> ComponentStatus:
-    if client_name == "mainsail":
+    files = [
-        client_config_data = ClientConfigData(
+        NGINX_SITES_AVAILABLE.joinpath(client.name),
-            name="mainsail-config",
-            display_name="Mainsail-Config",
-            cfg_filename="mainsail.cfg",
-            dir=MAINSAIL_CONFIG_DIR,
-            backup_dir=MAINSAIL_CONFIG_BACKUP_DIR,
-            url=MAINSAIL_CONFIG_REPO_URL,
-            printer_cfg_section="include mainsail.cfg",
-            mr_conf_path="~/mainsail-config",
-            mr_conf_origin=MAINSAIL_CONFIG_REPO_URL,
-        )
-        client_data = ClientData(
-            name=client_name,
-            display_name=client_name.capitalize(),
-            dir=MAINSAIL_DIR,
-            backup_dir=MAINSAIL_BACKUP_DIR,
-            url=MAINSAIL_URL,
-            pre_release_url=MAINSAIL_PRE_RLS_URL,
-            tags_url=MAINSAIL_TAGS_URL,
-            remote_mode=True,
-            mr_conf_repo="mainsail-crew/mainsail",
-            mr_conf_path="~/mainsail",
-            client_config=client_config_data,
-        )
-    elif client_name == "fluidd":
-        client_config_data = ClientConfigData(
-            name="fluidd-config",
-            display_name="Fluidd-Config",
-            cfg_filename="fluidd.cfg",
-            dir=FLUIDD_CONFIG_DIR,
-            backup_dir=FLUIDD_CONFIG_BACKUP_DIR,
-            url=FLUIDD_CONFIG_REPO_URL,
-            printer_cfg_section="include fluidd.cfg",
-            mr_conf_path="~/fluidd-config",
-            mr_conf_origin=FLUIDD_CONFIG_REPO_URL,
-        )
-        client_data = ClientData(
-            name=client_name,
-            display_name=client_name.capitalize(),
-            dir=FLUIDD_DIR,
-            backup_dir=FLUIDD_BACKUP_DIR,
-            url=FLUIDD_URL,
-            pre_release_url=FLUIDD_PRE_RLS_URL,
-            tags_url=FLUIDD_TAGS_URL,
-            remote_mode=False,
-            mr_conf_repo="fluidd-core/fluidd",
-            mr_conf_path="~/fluidd",
-            client_config=client_config_data,
-        )
-
-    return client_data
-
-
-def get_client_status(client: ClientData) -> str:
-    return get_install_status_webui(
-        client.get("dir"),
-        NGINX_SITES_AVAILABLE.joinpath(client.get("name")),
         NGINX_CONFD.joinpath("upstreams.conf"),
         NGINX_CONFD.joinpath("common_vars.conf"),
-    )
+    ]
+    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():
+        comp_status.status = 0
+
+    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: ClientData) -> Dict[
+def get_client_config_status(client: BaseWebClient) -> ComponentStatus:
-    Literal["repo", "local", "remote"],
+    return get_install_status(client.client_config.config_dir)
-    Union[str, int],
-]:
-    client_config = client.get("client_config")
-    client_config = client_config.get("dir")
-
-    return {
-        "repo": RepoManager.get_repo_name(client_config),
-        "local": RepoManager.get_local_commit(client_config),
-        "remote": RepoManager.get_remote_commit(client_config),
-    }
 
 
-def get_current_client_config(clients: List[ClientData]) -> str:
+def get_current_client_config() -> str:
-    installed = []
+    mainsail, fluidd = MainsailData(), FluiddData()
-    for client in clients:
+    clients: List[BaseWebClient] = [mainsail, fluidd]
-        client_config = client.get("client_config")
+    installed = [c for c in clients if c.client_config.config_dir.exists()]
-        if client_config.get("dir").exists():
-            installed.append(client)
 
-    if len(installed) > 1:
+    if not installed:
-        return f"{COLOR_YELLOW}Conflict!{RESET_FORMAT}"
+        return f"{COLOR_CYAN}-{RESET_FORMAT}"
     elif len(installed) == 1:
-        cfg = installed[0].get("client_config")
+        cfg = installed[0].client_config
-        return f"{COLOR_CYAN}{cfg.get('display_name')}{RESET_FORMAT}"
+        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:
+        # if both are included in the same file, we have a potential conflict
-    Logger.print_status(f"Backup '{MAINSAIL_CONFIG_JSON}' ...")
+        if includes_mainsail and includes_fluidd:
-    bm = BackupManager()
+            return f"{COLOR_YELLOW}Conflict!{RESET_FORMAT}"
-    if is_temp:
+
-        fn = Path.home().joinpath("config.json.kiauh.bak")
+    if not mainsail_includes and not fluidd_includes:
-        bm.backup_file(MAINSAIL_CONFIG_JSON, custom_filename=fn)
+        # 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(MAINSAIL_CONFIG_JSON)
+        # 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 restore_mainsail_config_json() -> None:
-    try:
-        Logger.print_status(f"Restore '{MAINSAIL_CONFIG_JSON}' ...")
-        source = Path.home().joinpath("config.json.kiauh.bak")
-        shutil.copy(source, MAINSAIL_CONFIG_JSON)
-    except OSError:
-        Logger.print_info("Unable to restore config.json. Skipped ...")
 
 
 def enable_mainsail_remotemode() -> None:
     Logger.print_status("Enable Mainsails remote mode ...")
-    with open(MAINSAIL_CONFIG_JSON, "r") as f:
+    c_json = MainsailData().client_dir.joinpath("config.json")
+    with open(c_json, "r") as f:
         config_data = json.load(f)
 
     if config_data["instancesDB"] == "browser":
@@ -175,63 +126,248 @@ def enable_mainsail_remotemode() -> None:
     Logger.print_status("Setting instance storage location to 'browser' ...")
     config_data["instancesDB"] = "browser"
 
-    with open(MAINSAIL_CONFIG_JSON, "w") as f:
+    with open(c_json, "w") as f:
         json.dump(config_data, f, indent=4)
     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")
+    access_log = client.nginx_access_log
-    error_log = Path("/var/log/nginx/mainsail-error.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: ClientData) -> str:
+def get_local_client_version(client: BaseWebClient) -> str | None:
-    relinfo_file = client.get("dir").joinpath("release_info.json")
+    relinfo_file = client.client_dir.joinpath("release_info.json")
-    if not relinfo_file.is_file():
+    version_file = client.client_dir.joinpath(".version")
-        return "-"
 
-    with open(relinfo_file, "r") as f:
+    if not client.client_dir.exists():
-        return json.load(f)["version"]
+        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 str(json.load(f)["version"])
+    else:
+        with open(version_file, "r") as f:
+            return f.readlines()[0]
 
 
-def get_remote_client_version(client: ClientData) -> str:
+def get_remote_client_version(client: BaseWebClient) -> str | None:
     try:
-        with urllib.request.urlopen(client.get("tags_url")) as response:
+        if (tag := get_latest_remote_tag(client.repo_path)) != "":
-            data = json.loads(response.read())
+            return str(tag)
-        return data[0]["name"]
+        return None
-    except (JSONDecodeError, TypeError):
+    except Exception:
-        return "ERROR"
+        return None
 
 
-def backup_client_data(client: ClientData) -> None:
+def backup_client_data(client: BaseWebClient) -> None:
-    name = client.get("name")
+    name = client.name
-    src = client.get("dir")
+    src = client.client_dir
-    dest = client.get("backup_dir")
+    dest = client.backup_dir
 
     with open(src.joinpath(".version"), "r") as v:
         version = v.readlines()[0]
 
     bm = BackupManager()
     bm.backup_directory(f"{name}-{version}", src, dest)
-    if name == "mainsail":
+    bm.backup_file(client.config_file, dest)
-        bm.backup_file(MAINSAIL_CONFIG_JSON, dest)
     bm.backup_file(NGINX_SITES_AVAILABLE.joinpath(name), dest)
 
 
-def backup_client_config_data(client: ClientData) -> None:
+def backup_client_config_data(client: BaseWebClient) -> None:
-    client_config = client.get("client_config")
+    client_config = client.client_config
-    name = client_config.get("name")
+    name = client_config.name
-    source = client_config.get("dir")
+    source = client_config.config_dir
-    target = client_config.get("backup_dir")
+    target = client_config.backup_dir
     bm = BackupManager()
     bm.backup_directory(name, source, target)
+
+
+def get_existing_clients() -> List[BaseWebClient]:
+    clients = list(get_args(WebClientType))
+    installed_clients: List[BaseWebClient] = []
+    for client in clients:
+        if client.client_dir.exists():
+            installed_clients.append(client)
+
+    return installed_clients
+
+
+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 curr_client: The client name to check for the conflict
+    :return: True, if other client configs were found, else False
+    """
+
+    mainsail_cfg_status: ComponentStatus = get_client_config_status(MainsailData())
+    fluidd_cfg_status: ComponentStatus = get_client_config_status(FluiddData())
+
+    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:
+    settings = KiauhSettings()
+    use_unstable = settings.get(client.name, "unstable_releases")
+    stable_url = f"{base_url}/latest/download/{client.name}.zip"
+
+    if not use_unstable:
+        return stable_url
+
+    try:
+        unstable_tag = get_latest_unstable_tag(client.repo_path)
+        if unstable_tag == "":
+            raise Exception
+        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

@@ -0,0 +1,56 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from pathlib import Path
+
+from components.webui_client.base_data import (
+    BaseWebClient,
+    BaseWebClientConfig,
+    WebClientConfigType,
+    WebClientType,
+)
+from core.backup_manager import BACKUP_ROOT_DIR
+
+
+@dataclass()
+class FluiddConfigWeb(BaseWebClientConfig):
+    client_config: WebClientConfigType = WebClientConfigType.FLUIDD
+    name: str = client_config.value
+    display_name: str = name.title()
+    config_dir: Path = Path.home().joinpath("fluidd-config")
+    config_filename: str = "fluidd.cfg"
+    config_section: str = f"include {config_filename}"
+    backup_dir: Path = BACKUP_ROOT_DIR.joinpath("fluidd-config-backups")
+    repo_url: str = "https://github.com/fluidd-core/fluidd-config.git"
+
+
+@dataclass()
+class FluiddData(BaseWebClient):
+    BASE_DL_URL = "https://github.com/fluidd-core/fluidd/releases"
+
+    client: WebClientType = WebClientType.FLUIDD
+    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
+
+    def __post_init__(self):
+        from components.webui_client.client_utils import get_download_url
+
+        self.client_config = FluiddConfigWeb()
+        self.download_url = get_download_url(self.BASE_DL_URL, self)

kiauh/components/webui_client/mainsail_data.py

@@ -0,0 +1,56 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from pathlib import Path
+
+from components.webui_client.base_data import (
+    BaseWebClient,
+    BaseWebClientConfig,
+    WebClientConfigType,
+    WebClientType,
+)
+from core.backup_manager import BACKUP_ROOT_DIR
+
+
+@dataclass()
+class MainsailConfigWeb(BaseWebClientConfig):
+    client_config: WebClientConfigType = WebClientConfigType.MAINSAIL
+    name: str = client_config.value
+    display_name: str = name.title()
+    config_dir: Path = Path.home().joinpath("mainsail-config")
+    config_filename: str = "mainsail.cfg"
+    config_section: str = f"include {config_filename}"
+    backup_dir: Path = BACKUP_ROOT_DIR.joinpath("mainsail-config-backups")
+    repo_url: str = "https://github.com/mainsail-crew/mainsail-config.git"
+
+
+@dataclass()
+class MainsailData(BaseWebClient):
+    BASE_DL_URL: str = "https://github.com/mainsail-crew/mainsail/releases"
+
+    client: WebClientType = WebClientType.MAINSAIL
+    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
+
+    def __post_init__(self):
+        from components.webui_client.client_utils import get_download_url
+
+        self.client_config = MainsailConfigWeb()
+        self.download_url = get_download_url(self.BASE_DL_URL, self)

kiauh/components/webui_client/menus/client_remove_menu.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,126 +6,98 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
-from typing import Callable, Dict
+from typing import Type
 
-from components.webui_client import client_remove, ClientData
+from components.webui_client import client_remove
-from core.menus import BACK_HELP_FOOTER
+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 RESET_FORMAT, COLOR_RED, COLOR_CYAN
 
 
 # noinspection PyUnusedLocal
 class ClientRemoveMenu(BaseMenu):
-    def __init__(self, client: ClientData):
+    def __init__(
-        self.client = client
+        self, client: BaseWebClient, previous_menu: Type[BaseMenu] | None = None
-        self.rm_client = False
+    ):
-        self.rm_client_config = False
+        super().__init__()
-        self.backup_mainsail_config_json = False
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
-        self.rm_moonraker_conf_section = False
+        self.client: BaseWebClient = client
-        self.rm_printer_cfg_section = False
+        self.remove_client: bool = False
+        self.remove_client_cfg: bool = False
+        self.backup_config_json: bool = False
+        self.selection_state: bool = False
 
-        super().__init__(
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-            header=False,
+        from core.menus.remove_menu import RemoveMenu
-            options=self.get_options(),
-            footer_type=BACK_HELP_FOOTER,
-        )
 
-    def get_options(self) -> Dict[str, Callable]:
+        self.previous_menu = previous_menu if previous_menu is not None else RemoveMenu
-        options = {
+
-            "0": self.toggle_all,
+    def set_options(self) -> None:
-            "1": self.toggle_rm_client,
+        self.options = {
-            "2": self.toggle_rm_client_config,
+            "a": Option(method=self.toggle_all),
-            "3": self.toggle_rm_printer_cfg_section,
+            "1": Option(method=self.toggle_rm_client),
-            "4": self.toggle_rm_moonraker_conf_section,
+            "2": Option(method=self.toggle_rm_client_config),
-            "c": self.run_removal_process,
+            "3": Option(method=self.toggle_backup_config_json),
+            "c": Option(method=self.run_removal_process),
         }
-        if self.client.get("name") == "mainsail":
-            options["5"] = self.toggle_backup_mainsail_config_json
-
-        return options
 
     def print_menu(self) -> None:
-        client_name = self.client.get("display_name")
+        client_name = self.client.display_name
-        client_config = self.client.get("client_config")
+        client_config = self.client.client_config
-        client_config_name = client_config.get("display_name")
+        client_config_name = client_config.display_name
 
         header = f" [ Remove {client_name} ] "
         color = COLOR_RED
         count = 62 - len(color) - len(RESET_FORMAT)
         checked = f"[{COLOR_CYAN}x{RESET_FORMAT}]"
         unchecked = "[ ]"
-        o1 = checked if self.rm_client else unchecked
+        o1 = checked if self.remove_client else unchecked
-        o2 = checked if self.rm_client_config else unchecked
+        o2 = checked if self.remove_client_cfg else unchecked
-        o3 = checked if self.rm_printer_cfg_section else unchecked
+        o3 = checked if self.backup_config_json else unchecked
-        o4 = checked if self.rm_moonraker_conf_section else unchecked
         menu = textwrap.dedent(
             f"""
-            /=======================================================\\
+            ╔═══════════════════════════════════════════════════════╗
-            | {color}{header:~^{count}}{RESET_FORMAT} |
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
-            |-------------------------------------------------------|
+            ╟───────────────────────────────────────────────────────╢
-            | Enter a number and hit enter to select / deselect     |
+            ║ Enter a number and hit enter to select / deselect     ║
-            | the specific option for removal.                      |
+            ║ the specific option for removal.                      ║
-            |-------------------------------------------------------|
+            ╟───────────────────────────────────────────────────────╢
-            |  0) Select everything                                 |
+            ║  a) {self._get_selection_state_str():37}             ║
-            |-------------------------------------------------------|
+            ╟───────────────────────────────────────────────────────╢
-            |  1) {o1} Remove {client_name:16}                       |
+            ║  1) {o1} Remove {client_name:16}                       ║
-            |  2) {o2} Remove {client_config_name:24}               |
+            ║  2) {o2} Remove {client_config_name:24}               ║
-            |                                                       |
+            ║  3) {o3} Backup config.json                            ║
-            | printer.cfg & moonraker.conf                          |
+            ╟───────────────────────────────────────────────────────╢
-            |  3) {o3} Remove printer.cfg include                    |
+            ║  C) Continue                                          ║
-            |  4) {o4} Remove Moonraker update section               |
+            ╟───────────────────────────────────────────────────────╢
-            """
-        )[1:]
-
-        if self.client.get("name") == "mainsail":
-            o5 = checked if self.backup_mainsail_config_json else unchecked
-            menu += textwrap.dedent(
-                f"""
-                |                                                       |
-                | Mainsail config.json                                  |
-                |  5) {o5} Backup config.json                            |
-                """
-            )[1:]
-
-        menu += textwrap.dedent(
-            """
-            |-------------------------------------------------------|
-            |  C) Continue                                          |
             """
         )[1:]
         print(menu, end="")
 
     def toggle_all(self, **kwargs) -> None:
-        self.rm_client = True
+        self.selection_state = not self.selection_state
-        self.rm_client_config = True
+        self.remove_client = self.selection_state
-        self.backup_mainsail_config_json = True
+        self.remove_client_cfg = self.selection_state
-        self.rm_moonraker_conf_section = True
+        self.backup_config_json = self.selection_state
-        self.rm_printer_cfg_section = True
 
     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:
+    def toggle_backup_config_json(self, **kwargs) -> None:
-        self.backup_mainsail_config_json = not self.backup_mainsail_config_json
+        self.backup_config_json = not self.backup_config_json
-
-    def toggle_rm_moonraker_conf_section(self, **kwargs) -> None:
-        self.rm_moonraker_conf_section = not self.rm_moonraker_conf_section
-
-    def toggle_rm_printer_cfg_section(self, **kwargs) -> None:
-        self.rm_printer_cfg_section = not self.rm_printer_cfg_section
 
     def run_removal_process(self, **kwargs) -> None:
         if (
-            not self.rm_client
+            not self.remove_client
-            and not self.rm_client_config
+            and not self.remove_client_cfg
-            and not self.backup_mainsail_config_json
+            and not self.backup_config_json
-            and not self.rm_moonraker_conf_section
-            and not self.rm_printer_cfg_section
         ):
             error = f"{COLOR_RED}Nothing selected ...{RESET_FORMAT}"
             print(error)
@@ -135,15 +105,22 @@ class ClientRemoveMenu(BaseMenu):
 
         client_remove.run_client_removal(
             client=self.client,
-            rm_client=self.rm_client,
+            remove_client=self.remove_client,
-            rm_client_config=self.rm_client_config,
+            remove_client_cfg=self.remove_client_cfg,
-            backup_ms_config_json=self.backup_mainsail_config_json,
+            backup_config=self.backup_config_json,
-            rm_moonraker_conf_section=self.rm_moonraker_conf_section,
-            rm_printer_cfg_section=self.rm_printer_cfg_section,
         )
 
-        self.rm_client = False
+        self.remove_client = False
-        self.rm_client_config = False
+        self.remove_client_cfg = False
-        self.backup_mainsail_config_json = False
+        self.backup_config_json = False
-        self.rm_moonraker_conf_section = False
+
-        self.rm_printer_cfg_section = 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/__init__.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #

kiauh/core/backup_manager/backup_manager.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,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._backup_root_dir: Path = backup_root_dir
-        self._ignore_folders = None
+        self._ignore_folders: List[str] = []
 
     @property
     def backup_root_dir(self) -> Path:
@@ -41,13 +44,15 @@ class BackupManager:
     def ignore_folders(self, value: List[str]):
         self._ignore_folders = value
 
-    def backup_file(self, file: Path = None, target: Path = None, custom_filename=None):
+    def backup_file(self, file: Path, target: Path | None = None, custom_filename=None):
-        if not file:
+        Logger.print_status(f"Creating backup of {file} ...")
-            raise ValueError("Parameter 'file' cannot be None!")
+
+        if not file.exists():
+            Logger.print_info("File does not exist! Skipping ...")
+            return
 
         target = self.backup_root_dir if target is None else target
 
-        Logger.print_status(f"Creating backup of {file} ...")
         if Path(file).is_file():
             date = get_current_date().get("date")
             time = get_current_date().get("time")
@@ -56,35 +61,38 @@ class BackupManager:
             try:
                 Path(target).mkdir(exist_ok=True)
                 shutil.copyfile(file, target.joinpath(filename))
-                Logger.print_ok("Backup successfull!")
+                Logger.print_ok("Backup successful!")
             except OSError as e:
                 Logger.print_error(f"Unable to backup '{file}':\n{e}")
         else:
             Logger.print_info(f"File '{file}' not found ...")
 
-    def backup_directory(self, name: str, source: Path, target: Path = None) -> None:
+    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():
-            raise OSError("Parameter 'source' is None or Path does not exist!")
+            Logger.print_info("Source directory does not exist! Skipping ...")
+            return
 
         target = self.backup_root_dir if target is None else target
         try:
-            log = f"Creating backup of {name} in {target} ..."
-            Logger.print_status(log)
             date = get_current_date().get("date")
             time = get_current_date().get("time")
-            shutil.copytree(
+            backup_target = target.joinpath(f"{name.lower()}-{date}-{time}")
-                source,
+            shutil.copytree(source, backup_target, ignore=self.ignore_folders_func)
-                target.joinpath(f"{name.lower()}-{date}-{time}"),
+            Logger.print_ok("Backup successful!")
-                ignore=self.ignore_folders_func,
+
-            )
+            return backup_target
-            Logger.print_ok("Backup successfull!")
+
         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/config_manager/config_manager.py

@@ -1,85 +0,0 @@
-#!/usr/bin/env python3
-
-# ======================================================================= #
-#  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 configparser
-from pathlib import Path
-from typing import Union
-
-from utils.logger import Logger
-
-
-# noinspection PyMethodMayBeStatic
-class ConfigManager:
-    def __init__(self, cfg_file: Path):
-        self.config_file = cfg_file
-        self.config = CustomConfigParser()
-
-        if cfg_file.is_file():
-            self.read_config()
-
-    def read_config(self) -> None:
-        if not self.config_file:
-            Logger.print_error("Unable to read config file. File not found.")
-            return
-
-        self.config.read_file(open(self.config_file, "r"))
-
-    def write_config(self) -> None:
-        with open(self.config_file, "w") as cfg:
-            self.config.write(cfg)
-
-    def get_value(self, section: str, key: str, silent=True) -> Union[str, bool, None]:
-        if not self.config.has_section(section):
-            if not silent:
-                log = f"Section not defined. Unable to read section: [{section}]."
-                Logger.print_error(log)
-            return None
-
-        if not self.config.has_option(section, key):
-            if not silent:
-                log = f"Option not defined in section [{section}]. Unable to read option: '{key}'."
-                Logger.print_error(log)
-            return None
-
-        value = self.config.get(section, key)
-        if value == "True" or value == "true":
-            return True
-        elif value == "False" or value == "false":
-            return False
-        else:
-            return value
-
-    def set_value(self, section: str, key: str, value: str):
-        self.config.set(section, key, value)
-
-
-class CustomConfigParser(configparser.ConfigParser):
-    """
-    A custom ConfigParser class overwriting the write() method of configparser.Configparser.
-    Key and value will be delimited by a ": ".
-    Note the whitespace AFTER the colon, which is the whole reason for that overwrite.
-    """
-
-    def write(self, fp, space_around_delimiters=False):
-        if self._defaults:
-            fp.write("[%s]\n" % configparser.DEFAULTSECT)
-            for key, value in self._defaults.items():
-                fp.write("%s: %s\n" % (key, str(value).replace("\n", "\n\t")))
-            fp.write("\n")
-        for section in self._sections:
-            fp.write("[%s]\n" % section)
-            for key, value in self._sections[section].items():
-                if key == "__name__":
-                    continue
-                if (value is not None) or (self._optcre == self.OPTCRE):
-                    key = ": ".join((key, str(value).replace("\n", "\n\t")))
-                fp.write("%s\n" % key)
-            fp.write("\n")

kiauh/core/constants.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -13,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
@@ -21,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

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

kiauh/core/instance_manager/base_instance.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -9,153 +7,52 @@
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
 
-from abc import abstractmethod, ABC
+from __future__ import annotations
+
+import re
+from dataclasses import dataclass, field
 from pathlib import Path
-from typing import List, Type, TypeVar
+from typing import List
 
-from utils.constants import SYSTEMD, CURRENT_USER
+from utils.fs_utils import get_data_dir
 
-B = TypeVar(name="B", bound="BaseInstance", covariant=True)
+SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion"]
 
 
-class BaseInstance(ABC):
+@dataclass(repr=True)
-    @classmethod
+class BaseInstance:
-    def blacklist(cls) -> List[str]:
+    instance_type: type
-        return []
+    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__(
+    def __post_init__(self):
-        self,
+        self.data_dir = get_data_dir(self.instance_type, self.suffix)
-        suffix: str,
+        # the following attributes require the data_dir to be set
-        instance_type: B = B,
+        self.cfg_dir = self.data_dir.joinpath("config")
-    ):
+        self.log_dir = self.data_dir.joinpath("logs")
-        self._instance_type = instance_type
+        self.gcodes_dir = self.data_dir.joinpath("gcodes")
-        self._suffix = suffix
+        self.comms_dir = self.data_dir.joinpath("comms")
-        self._user = CURRENT_USER
+        self.sysd_dir = self.data_dir.joinpath("systemd")
-        self._data_dir_name = self.get_data_dir_name_from_suffix()
+        self.is_legacy_instance = self._set_is_legacy_instance()
-        self._data_dir = Path.home().joinpath(f"{self._data_dir_name}_data")
+        self.base_folders = [
-        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) -> Type["BaseInstance"]:
-        return self._instance_type
-
-    @instance_type.setter
-    def instance_type(self, value: Type["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: str) -> None:
-        self._data_dir = value
-
-    @property
-    def cfg_dir(self) -> Path:
-        return self._cfg_dir
-
-    @cfg_dir.setter
-    def cfg_dir(self, value: str) -> None:
-        self._cfg_dir = value
-
-    @property
-    def log_dir(self) -> Path:
-        return self._log_dir
-
-    @log_dir.setter
-    def log_dir(self, value: str) -> None:
-        self._log_dir = value
-
-    @property
-    def comms_dir(self) -> Path:
-        return self._comms_dir
-
-    @comms_dir.setter
-    def comms_dir(self, value: str) -> None:
-        self._comms_dir = value
-
-    @property
-    def sysd_dir(self) -> Path:
-        return self._sysd_dir
-
-    @sysd_dir.setter
-    def sysd_dir(self, value: str) -> None:
-        self._sysd_dir = value
-
-    @property
-    def gcodes_dir(self) -> Path:
-        return self._gcodes_dir
-
-    @gcodes_dir.setter
-    def gcodes_dir(self, value: str) -> 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: List[Path] = None) -> None:
-        dirs = [
             self.data_dir,
             self.cfg_dir,
             self.log_dir,
+            self.gcodes_dir,
             self.comms_dir,
             self.sysd_dir,
         ]
 
-        if add_dirs:
+    def _set_is_legacy_instance(self) -> bool:
-            dirs.extend(add_dirs)
+        legacy_pattern = r"^(?!printer)(.+)_data"
+        match = re.search(legacy_pattern, self.data_dir.name)
 
-        for _dir in dirs:
+        return True if (match and self.suffix != "") else False
-            _dir.mkdir(exist_ok=True)
-
-    def get_service_file_name(self, extension: bool = False) -> str:
-        name = f"{self.__class__.__name__.lower()}"
-        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

kiauh/core/instance_manager/instance_manager.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,206 +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, Union, TypeVar
+from subprocess import CalledProcessError
+from typing import List
 
-from core.instance_manager.base_instance import BaseInstance
+from core.logger import Logger
-from utils.constants import SYSTEMD
+from utils.instance_type import InstanceType
-from utils.logger import Logger
+from utils.sys_utils import cmd_sysctl_service
-
-I = TypeVar(name="I", bound=BaseInstance, covariant=True)
 
 
-# noinspection PyMethodMayBeStatic
 class InstanceManager:
-    def __init__(self, instance_type: I) -> None:
+    @staticmethod
-        self._instance_type = instance_type
+    def enable(instance: InstanceType) -> None:
-        self._current_instance: Optional[I] = None
+        service_name: str = instance.service_file_path.name
-        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[I] = []
-
-    @property
-    def instance_type(self) -> I:
-        return self._instance_type
-
-    @instance_type.setter
-    def instance_type(self, value: I):
-        self._instance_type = value
-
-    @property
-    def current_instance(self) -> I:
-        return self._current_instance
-
-    @current_instance.setter
-    def current_instance(self, value: I) -> 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[I]:
-        return self.find_instances()
-
-    @instances.setter
-    def instances(self, value: List[I]):
-        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:
-        Logger.print_status(f"Enabling {self.instance_service_full} ...")
         try:
-            command = ["sudo", "systemctl", "enable", self.instance_service_full]
+            cmd_sysctl_service(service_name, "enable")
-            if subprocess.run(command, check=True):
+        except CalledProcessError as e:
-                Logger.print_ok(f"{self.instance_service_full} enabled.")
+            Logger.print_error(f"Error enabling service {service_name}:")
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(f"Error enabling service {self.instance_service_full}:")
             Logger.print_error(f"{e}")
 
-    def disable_instance(self) -> None:
+    @staticmethod
-        Logger.print_status(f"Disabling {self.instance_service_full} ...")
+    def disable(instance: InstanceType) -> None:
+        service_name: str = instance.service_file_path.name
         try:
-            command = ["sudo", "systemctl", "disable", self.instance_service_full]
+            cmd_sysctl_service(service_name, "disable")
-            if subprocess.run(command, check=True):
+        except CalledProcessError as e:
-                Logger.print_ok(f"{self.instance_service_full} disabled.")
+            Logger.print_error(f"Error disabling {service_name}: {e}")
-        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:
-        Logger.print_status(f"Starting {self.instance_service_full} ...")
-        try:
-            command = ["sudo", "systemctl", "start", self.instance_service_full]
-            if subprocess.run(command, check=True):
-                Logger.print_ok(f"{self.instance_service_full} started.")
-        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:
-        Logger.print_status(f"Restarting {self.instance_service_full} ...")
-        try:
-            command = ["sudo", "systemctl", "restart", self.instance_service_full]
-            if subprocess.run(command, check=True):
-                Logger.print_ok(f"{self.instance_service_full} restarted.")
-        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:
-        Logger.print_status(f"Stopping {self.instance_service_full} ...")
-        try:
-            command = ["sudo", "systemctl", "stop", self.instance_service_full]
-            if subprocess.run(command, check=True):
-                Logger.print_ok(f"{self.instance_service_full} stopped.")
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(f"Error stopping {self.instance_service_full}:")
-            Logger.print_error(f"{e}")
             raise
 
-    def stop_all_instance(self) -> None:
+    @staticmethod
-        for instance in self.instances:
+    def start(instance: InstanceType) -> None:
-            self.current_instance = instance
+        service_name: str = instance.service_file_path.name
-            self.stop_instance()
-
-    def reload_daemon(self) -> None:
-        Logger.print_status("Reloading systemd manager configuration ...")
         try:
-            command = ["sudo", "systemctl", "daemon-reload"]
+            cmd_sysctl_service(service_name, "start")
-            if subprocess.run(command, check=True):
+        except CalledProcessError as e:
-                Logger.print_ok("Systemd manager configuration reloaded")
+            Logger.print_error(f"Error starting {service_name}: {e}")
-        except subprocess.CalledProcessError as e:
-            Logger.print_error("Error reloading systemd manager configuration:")
-            Logger.print_error(f"{e}")
             raise
 
-    def find_instances(self) -> List[I]:
+    @staticmethod
-        name = self.instance_type.__name__.lower()
+    def stop(instance: InstanceType) -> None:
-        pattern = re.compile(f"^{name}(-[0-9a-zA-Z]+)?.service$")
+        name: str = instance.service_file_path.name
-        excluded = self.instance_type.blacklist()
+        try:
+            cmd_sysctl_service(name, "stop")
+        except CalledProcessError as e:
+            Logger.print_error(f"Error stopping {name}: {e}")
+            raise
 
-        service_list = [
+    @staticmethod
-            Path(SYSTEMD, service)
+    def restart(instance: InstanceType) -> None:
-            for service in SYSTEMD.iterdir()
+        name: str = instance.service_file_path.name
-            if pattern.search(service.name)
+        try:
-            and not any(s in service.name for s in excluded)
+            cmd_sysctl_service(name, "restart")
-        ]
+        except CalledProcessError as e:
+            Logger.print_error(f"Error restarting {name}: {e}")
+            raise
 
-        instance_list = [
+    @staticmethod
-            self.instance_type(suffix=self._get_instance_suffix(service))
+    def start_all(instances: List[InstanceType]) -> None:
-            for service in service_list
+        for instance in instances:
-        ]
+            InstanceManager.start(instance)
 
-        return sorted(instance_list, key=lambda x: self._sort_instance_list(x.suffix))
+    @staticmethod
+    def stop_all(instances: List[InstanceType]) -> None:
+        for instance in instances:
+            InstanceManager.stop(instance)
 
-    def _get_instance_suffix(self, file_path: Path) -> str:
+    @staticmethod
-        return file_path.stem.split("-")[-1] if "-" in file_path.stem else ""
+    def restart_all(instances: List[InstanceType]) -> None:
+        for instance in instances:
+            InstanceManager.restart(instance)
 
-    def _sort_instance_list(self, s: Union[int, str, None]):
+    @staticmethod
-        if s is None:
+    def remove(instance: InstanceType) -> None:
-            return
+        from utils.fs_utils import run_remove_routines
+        from utils.sys_utils import remove_system_service
 
-        return int(s) if s.isdigit() else s
+        try:
+            # remove the service file
+            service_file_path: Path = instance.service_file_path
+            if service_file_path is not None:
+                remove_system_service(service_file_path.name)
+
+            # then remove all the log files
+            if (
+                not instance.log_file_name
+                or not instance.base.log_dir
+                or not instance.base.log_dir.exists()
+            ):
+                return
+
+            files = instance.base.log_dir.iterdir()
+            logs = [f for f in files if f.name.startswith(instance.log_file_name)]
+            for log in logs:
+                Logger.print_status(f"Remove '{log}'")
+                run_remove_routines(log)
+
+        except Exception as e:
+            Logger.print_error(f"Error removing service: {e}")
+            raise

kiauh/core/instance_manager/name_scheme.py

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

kiauh/core/logger.py

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

kiauh/core/menus/__init__.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,7 +6,32 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
-QUIT_FOOTER = "quit"
+from dataclasses import dataclass
-BACK_FOOTER = "back"
+from enum import Enum
-BACK_HELP_FOOTER = "back_help"
+from typing import Any, Callable, Type
+
+
+@dataclass
+class Option:
+    """
+    Represents a menu option.
+    :param method: Method that will be used to call the menu option
+    :param opt_index: Can be used to pass the user input to the menu option
+    :param opt_data: Can be used to pass any additional data to the menu option
+    """
+
+    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
+
+
+class FooterType(Enum):
+    QUIT = "QUIT"
+    BACK = "BACK"
+    BACK_HELP = "BACK_HELP"
+    BLANK = "BLANK"

kiauh/core/menus/advanced_menu.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,35 +6,93 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
+from typing import Type
 
-from core.menus import BACK_FOOTER
+from components.klipper import KLIPPER_DIR
+from components.klipper.klipper import Klipper
+from components.klipper_firmware.menus.klipper_build_menu import (
+    KlipperBuildFirmwareMenu,
+)
+from components.klipper_firmware.menus.klipper_flash_menu import (
+    KlipperFlashMethodMenu,
+    KlipperSelectMcuConnectionMenu,
+)
+from components.moonraker import MOONRAKER_DIR
+from components.moonraker.moonraker import Moonraker
+from core.constants import COLOR_YELLOW, RESET_FORMAT
+from core.menus import Option
 from core.menus.base_menu import BaseMenu
-from 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):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
-        super().__init__(header=True, options={}, footer_type=BACK_FOOTER)
+        super().__init__()
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
 
-    def print_menu(self):
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from core.menus.main_menu import MainMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "1": Option(method=self.build),
+            "2": Option(method=self.flash),
+            "3": Option(method=self.build_flash),
+            "4": Option(method=self.get_id),
+            "5": Option(method=self.klipper_rollback),
+            "6": Option(method=self.moonraker_rollback),
+            "7": Option(method=self.change_hostname),
+        }
+
+    def print_menu(self) -> None:
         header = " [ Advanced Menu ] "
         color = COLOR_YELLOW
         count = 62 - len(color) - len(RESET_FORMAT)
         menu = textwrap.dedent(
             f"""
-            /=======================================================\\
+            ╔═══════════════════════════════════════════════════════╗
-            | {color}{header:~^{count}}{RESET_FORMAT} |
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
-            |-------------------------------------------------------|
+            ╟───────────────────────────┬───────────────────────────╢
-            | Klipper & API:          | Mainsail:                   |
+            ║ Klipper Firmware:         │ Repository Rollback:      ║
-            |  0) [Rollback]          |  5) [Theme installer]       |
+            ║  1) [Build]               │  5) [Klipper]             ║
-            |                         |                             |
+            ║  2) [Flash]               │  6) [Moonraker]           ║
-            | Firmware:               | System:                     |
+            ║  3) [Build + Flash]       │                           ║
-            |  1) [Build only]        |  6) [Change hostname]       |
+            ║  4) [Get MCU ID]          │ System:                   ║
-            |  2) [Flash only]        |                             |
+            ║                           │  7) [Change hostname]     ║
-            |  3) [Build + Flash]     | Extras:                     |
+            ╟───────────────────────────┴───────────────────────────╢
-            |  4) [Get MCU ID]        |  7) [G-Code Shell Command]  |
             """
         )[1:]
         print(menu, end="")
+
+    def klipper_rollback(self, **kwargs) -> None:
+        rollback_repository(KLIPPER_DIR, Klipper)
+
+    def moonraker_rollback(self, **kwargs) -> None:
+        rollback_repository(MOONRAKER_DIR, Moonraker)
+
+    def build(self, **kwargs) -> None:
+        KlipperBuildFirmwareMenu(previous_menu=self.__class__).run()
+
+    def flash(self, **kwargs) -> None:
+        KlipperFlashMethodMenu(previous_menu=self.__class__).run()
+
+    def build_flash(self, **kwargs) -> None:
+        KlipperBuildFirmwareMenu(previous_menu=KlipperFlashMethodMenu).run()
+        KlipperFlashMethodMenu(previous_menu=self.__class__).run()
+
+    def get_id(self, **kwargs) -> None:
+        KlipperSelectMcuConnectionMenu(
+            previous_menu=self.__class__,
+            standalone=True,
+        ).run()
+
+    def change_hostname(self, **kwargs) -> None:
+        change_system_hostname()

kiauh/core/menus/backup_menu.py

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

kiauh/core/menus/base_menu.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -9,28 +7,32 @@
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
 
+from __future__ import annotations
+
 import subprocess
 import sys
 import textwrap
-from abc import abstractmethod, ABC
+import traceback
-from typing import Dict, Any, Literal, Union, Callable
+from abc import abstractmethod
+from typing import Dict, Type
 
-from core.menus import QUIT_FOOTER, BACK_FOOTER, BACK_HELP_FOOTER
+from core.constants import (
-from utils.constants import (
-    COLOR_GREEN,
-    COLOR_YELLOW,
-    COLOR_RED,
     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 = ""
@@ -38,45 +40,43 @@ def print_header():
     count = 62 - len(color) - len(RESET_FORMAT)
     header = textwrap.dedent(
         f"""
-        /=======================================================\\
+        ╔═══════════════════════════════════════════════════════╗
-        | {color}{line1:~^{count}}{RESET_FORMAT} |
+        ║ {color}{line1:~^{count}}{RESET_FORMAT} ║
-        | {color}{line2:^{count}}{RESET_FORMAT} |
+        ║ {color}{line2:^{count}}{RESET_FORMAT} ║
-        | {color}{line3:~^{count}}{RESET_FORMAT} |
+        ║ {color}{line3:~^{count}}{RESET_FORMAT} ║
-        \=======================================================/
+        ╚═══════════════════════════════════════════════════════╝
         """
     )[1:]
     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)
     footer = textwrap.dedent(
         f"""
-        |-------------------------------------------------------|
+        ║ {color}{text:^{count}}{RESET_FORMAT} ║
-        | {color}{text:^{count}}{RESET_FORMAT} |
+        ╚═══════════════════════════════════════════════════════╝
-        \=======================================================/
         """
     )[1:]
     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)
     footer = textwrap.dedent(
         f"""
-        |-------------------------------------------------------|
+        ║ {color}{text:^{count}}{RESET_FORMAT} ║
-        | {color}{text:^{count}}{RESET_FORMAT} |
+        ╚═══════════════════════════════════════════════════════╝
-        \=======================================================/
         """
     )[1:]
     print(footer, end="")
 
 
-def print_back_help_footer():
+def print_back_help_footer() -> None:
     text1 = "B) « Back"
     text2 = "H) Help [?]"
     color1 = COLOR_GREEN
@@ -84,106 +84,115 @@ def print_back_help_footer():
     count = 34 - len(color1) - len(RESET_FORMAT)
     footer = textwrap.dedent(
         f"""
-        |-------------------------------------------------------|
+        ║ {color1}{text1:^{count}}{RESET_FORMAT} │ {color2}{text2:^{count}}{RESET_FORMAT} ║
-        | {color1}{text1:^{count}}{RESET_FORMAT} | {color2}{text2:^{count}}{RESET_FORMAT} |
+        ╚═══════════════════════════╧═══════════════════════════╝
-        \=======================================================/
         """
     )[1:]
     print(footer, end="")
 
 
-class BaseMenu(ABC):
+def print_blank_footer() -> None:
-    NAVI_OPTIONS = {"quit": ["q"], "back": ["b"], "back_help": ["b", "h"]}
+    print("╚═══════════════════════════════════════════════════════╝")
 
-    def __init__(
+
-        self,
+class PostInitCaller(type):
-        options: Dict[str, Union[Callable, Any]],
+    def __call__(cls, *args, **kwargs):
-        options_offset: int = 0,
+        obj = type.__call__(cls, *args, **kwargs)
-        header: bool = True,
+        obj.__post_init__()
-        footer_type: Literal[
+        return obj
-            "QUIT_FOOTER", "BACK_FOOTER", "BACK_HELP_FOOTER"
+
-        ] = QUIT_FOOTER,
+
-    ):
+# noinspection PyUnusedLocal
-        self.previous_menu = None
+# noinspection PyMethodMayBeStatic
-        self.options = options
+class BaseMenu(metaclass=PostInitCaller):
-        self.options_offset = options_offset
+    options: Dict[str, Option] = {}
-        self.header = header
+    options_offset: int = 0
-        self.footer_type = footer_type
+    default_option: Option = None
+    input_label_txt: str = "Perform action"
+    header: bool = False
+    previous_menu: Type[BaseMenu] | None = None
+    help_menu: Type[BaseMenu] | None = None
+    footer_type: FooterType = FooterType.BACK
+
+    def __init__(self, **kwargs) -> None:
+        if type(self) is BaseMenu:
+            raise NotImplementedError("BaseMenu cannot be instantiated directly.")
+
+    def __post_init__(self) -> None:
+        self.set_previous_menu(self.previous_menu)
+        self.set_options()
+
+        # conditionally add options based on footer type
+        if self.footer_type is FooterType.QUIT:
+            self.options["q"] = Option(method=self.__exit)
+        if self.footer_type is FooterType.BACK:
+            self.options["b"] = Option(method=self.__go_back)
+        if self.footer_type is FooterType.BACK_HELP:
+            self.options["b"] = Option(method=self.__go_back)
+            self.options["h"] = Option(method=self.__go_to_help)
+        # if defined, add the default option to the options dict
+        if self.default_option is not None:
+            self.options[""] = self.default_option
+
+    def __go_back(self, **kwargs) -> None:
+        if self.previous_menu is None:
+            return
+        self.previous_menu().run()
+
+    def __go_to_help(self, **kwargs) -> None:
+        if self.help_menu is None:
+            return
+        self.help_menu(previous_menu=self.__class__).run()
+
+    def __exit(self, **kwargs) -> None:
+        Logger.print_ok("###### Happy printing!", False)
+        sys.exit(0)
+
+    @abstractmethod
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    def set_options(self) -> None:
+        raise NotImplementedError
 
     @abstractmethod
     def print_menu(self) -> None:
-        raise NotImplementedError("Subclasses must implement the print_menu method")
+        raise NotImplementedError
 
     def print_footer(self) -> None:
-        footer_type_map = {
+        if self.footer_type is FooterType.QUIT:
-            QUIT_FOOTER: print_quit_footer,
+            print_quit_footer()
-            BACK_FOOTER: print_back_footer,
+        elif self.footer_type is FooterType.BACK:
-            BACK_HELP_FOOTER: print_back_help_footer,
+            print_back_footer()
-        }
+        elif self.footer_type is FooterType.BACK_HELP:
-        footer_function = footer_type_map.get(self.footer_type, print_quit_footer)
+            print_back_help_footer()
-        footer_function()
+        elif self.footer_type is FooterType.BLANK:
+            print_blank_footer()
+        else:
+            raise NotImplementedError("FooterType not correctly implemented!")
 
-    def display(self) -> None:
+    def display_menu(self) -> None:
-        # clear()
         if self.header:
             print_header()
         self.print_menu()
         self.print_footer()
 
-    def handle_user_input(self) -> str:
+    def run(self) -> None:
-        while True:
+        """Start the menu lifecycle. When this function returns, the lifecycle of the menu ends."""
-            choice = input(f"{COLOR_CYAN}###### Perform action: {RESET_FORMAT}").lower()
+        try:
-            option = self.options.get(choice, None)
+            self.display_menu()
+            option = get_selection_input(self.input_label_txt, self.options)
+            selected_option: Option = self.options.get(option)
 
-            has_navi_option = self.footer_type in self.NAVI_OPTIONS
+            selected_option.method(
-            user_navigated = choice in self.NAVI_OPTIONS[self.footer_type]
+                opt_index=selected_option.opt_index,
-            if has_navi_option and user_navigated:
+                opt_data=selected_option.opt_data,
-                return choice
-
-            if option is not None:
-                return choice
-            else:
-                Logger.print_error("Invalid input!", False)
-
-    def start(self) -> None:
-        while True:
-            self.display()
-            choice = self.handle_user_input()
-
-            if choice == "q":
-                Logger.print_ok("###### Happy printing!", False)
-                sys.exit(0)
-            elif choice == "b":
-                return
-            elif choice == "h":
-                print("help!")
-            else:
-                self.execute_option(choice)
-
-    def execute_option(self, choice: str) -> None:
-        option = self.options.get(choice, None)
-
-        if isinstance(option, type) and issubclass(option, BaseMenu):
-            self.navigate_to_menu(option, True)
-        elif isinstance(option, BaseMenu):
-            self.navigate_to_menu(option, False)
-        elif callable(option):
-            option(opt_index=choice)
-        elif option is None:
-            raise NotImplementedError(f"No implementation for option {choice}")
-        else:
-            raise TypeError(
-                f"Type {type(option)} of option {choice} not of type BaseMenu or Method"
             )
 
-    def navigate_to_menu(self, menu, instantiate: bool) -> None:
+            self.run()
-        """
+
-        Method for handling the actual menu switch. Can either take in a menu type or an already
+        except Exception as e:
-        instantiated menu class. Use instantiated menu classes only if the menu requires specific input parameters
+            Logger.print_error(
-        :param menu: A menu type or menu instance
+                f"An unexpected error occured:\n{e}\n{traceback.format_exc()}"
-        :param instantiate: Specify if the menu requires instantiation
+            )
-        :return: None
-        """
-        menu = menu() if instantiate else menu
-        menu.previous_menu = self
-        menu.start()

kiauh/core/menus/extensions_menu.py

@@ -1,135 +0,0 @@
-#!/usr/bin/env python3
-
-# ======================================================================= #
-#  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 importlib
-import inspect
-import json
-import textwrap
-from pathlib import Path
-from typing import List, Dict
-
-from core.base_extension import BaseExtension
-from core.menus import BACK_FOOTER
-from core.menus.base_menu import BaseMenu
-from utils.constants import RESET_FORMAT, COLOR_CYAN, COLOR_YELLOW
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class ExtensionsMenu(BaseMenu):
-    def __init__(self):
-        self.extensions = self.discover_extensions()
-        super().__init__(
-            header=True,
-            options=self.get_options(),
-            footer_type=BACK_FOOTER,
-        )
-
-    def discover_extensions(self) -> List[BaseExtension]:
-        extensions = []
-        extensions_dir = Path(__file__).resolve().parents[2].joinpath("extensions")
-
-        for extension in extensions_dir.iterdir():
-            metadata_json = Path(extension).joinpath("metadata.json")
-            if not metadata_json.exists():
-                continue
-
-            try:
-                with open(metadata_json, "r") as m:
-                    metadata = json.load(m).get("metadata")
-                    module_name = (
-                        f"kiauh.extensions.{extension.name}.{metadata.get('module')}"
-                    )
-                    name, extension = inspect.getmembers(
-                        importlib.import_module(module_name),
-                        predicate=lambda o: inspect.isclass(o)
-                        and issubclass(o, BaseExtension)
-                        and o != BaseExtension,
-                    )[0]
-                    extensions.append(extension(metadata))
-            except (IOError, json.JSONDecodeError, ImportError) as e:
-                print(f"Failed loading extension {extension}: {e}")
-
-        return sorted(extensions, key=lambda ex: ex.metadata.get("index"))
-
-    def get_options(self) -> Dict[str, BaseMenu]:
-        options = {}
-        for extension in self.extensions:
-            index = extension.metadata.get("index")
-            options[f"{index}"] = ExtensionSubmenu(extension)
-
-        return options
-
-    def print_menu(self):
-        header = " [ Extensions Menu ] "
-        color = COLOR_CYAN
-        line1 = f"{COLOR_YELLOW}Available Extensions:{RESET_FORMAT}"
-        count = 62 - len(color) - len(RESET_FORMAT)
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:~^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            | {line1:<62} |
-            |                                                       |
-            """
-        )[1:]
-        print(menu, end="")
-
-        for extension in self.extensions:
-            index = extension.metadata.get("index")
-            name = extension.metadata.get("display_name")
-            row = f"{index}) {name}"
-            print(f"| {row:<53} |")
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class ExtensionSubmenu(BaseMenu):
-    def __init__(self, extension: BaseExtension):
-        self.extension = extension
-        self.extension_name = extension.metadata.get("display_name")
-        self.extension_desc = extension.metadata.get("description")
-        super().__init__(
-            header=False,
-            options={
-                "1": extension.install_extension,
-                "2": extension.remove_extension,
-            },
-            footer_type=BACK_FOOTER,
-        )
-
-    def print_menu(self) -> None:
-        header = f" [ {self.extension_name} ] "
-        color = COLOR_YELLOW
-        count = 62 - len(color) - len(RESET_FORMAT)
-
-        wrapper = textwrap.TextWrapper(55, initial_indent="| ", subsequent_indent="| ")
-        lines = wrapper.wrap(self.extension_desc)
-        formatted_lines = [f"{line:<55} |" for line in lines]
-        description_text = "\n".join(formatted_lines)
-
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:~^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            """
-        )[1:]
-        menu += f"{description_text}\n"
-        menu += textwrap.dedent(
-            """
-            |-------------------------------------------------------|
-            | 1) Install                                            |
-            | 2) Remove                                             |
-            """
-        )[1:]
-        print(menu, end="")

kiauh/core/menus/install_menu.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,77 +6,93 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
+from typing import Type
 
+from components.crowsnest.crowsnest import install_crowsnest
 from components.klipper import klipper_setup
+from components.klipperscreen.klipperscreen import install_klipperscreen
 from components.moonraker import moonraker_setup
 from components.webui_client import client_setup
 from components.webui_client.client_config import client_config_setup
-from core.menus import BACK_FOOTER
+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):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
-        super().__init__(
+        super().__init__()
-            header=True,
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
-            options={
-                "1": self.install_klipper,
-                "2": self.install_moonraker,
-                "3": self.install_mainsail,
-                "4": self.install_fluidd,
-                "5": self.install_mainsail_config,
-                "6": self.install_fluidd_config,
-                "7": None,
-                "8": None,
-                "9": None,
-            },
-            footer_type=BACK_FOOTER,
-        )
 
-    def print_menu(self):
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from core.menus.main_menu import MainMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "1": Option(method=self.install_klipper),
+            "2": Option(method=self.install_moonraker),
+            "3": Option(method=self.install_mainsail),
+            "4": Option(method=self.install_fluidd),
+            "5": Option(method=self.install_mainsail_config),
+            "6": Option(method=self.install_fluidd_config),
+            "7": Option(method=self.install_klipperscreen),
+            "8": Option(method=self.install_crowsnest),
+        }
+
+    def print_menu(self) -> None:
         header = " [ Installation Menu ] "
         color = COLOR_GREEN
         count = 62 - len(color) - len(RESET_FORMAT)
         menu = textwrap.dedent(
             f"""
-            /=======================================================\\
+            ╔═══════════════════════════════════════════════════════╗
-            | {color}{header:~^{count}}{RESET_FORMAT} |
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
-            |-------------------------------------------------------|
+            ╟───────────────────────────┬───────────────────────────╢
-            | Firmware & API:           | Touchscreen GUI:          |
+            ║ Firmware & API:           │ Touchscreen GUI:          ║
-            |  1) [Klipper]             |  7) [KlipperScreen]       |
+            ║  1) [Klipper]             │  7) [KlipperScreen]       ║
-            |  2) [Moonraker]           |                           |
+            ║  2) [Moonraker]           │                           ║
-            |                           | Android / iOS:            |
+            ║                           │ Webcam Streamer:          ║
-            | Webinterface:             |  8) [Mobileraker]         |
+            ║ Webinterface:             │  8) [Crowsnest]           ║
-            |  3) [Mainsail]            |                           |
+            ║  3) [Mainsail]            │                           ║
-            |  4) [Fluidd]              | Webcam Streamer:          |
+            ║  4) [Fluidd]              │                           ║
-            |                           |  9) [Crowsnest]           |
+            ║                           │                           ║
-            | Client-Config:            |                           |
+            ║ Client-Config:            │                           ║
-            |  5) [Mainsail-Config]     |                           |
+            ║  5) [Mainsail-Config]     │                           ║
-            |  6) [Fluidd-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(client_name="mainsail")
+        client_setup.install_client(MainsailData())
 
-    def install_mainsail_config(self, **kwargs):
+    def install_mainsail_config(self, **kwargs) -> None:
-        client_config_setup.install_client_config(client_name="mainsail")
+        client_config_setup.install_client_config(MainsailData())
 
-    def install_fluidd(self, **kwargs):
+    def install_fluidd(self, **kwargs) -> None:
-        client_setup.install_client(client_name="fluidd")
+        client_setup.install_client(FluiddData())
 
-    def install_fluidd_config(self, **kwargs):
+    def install_fluidd_config(self, **kwargs) -> None:
-        client_config_setup.install_client_config(client_name="fluidd")
+        client_config_setup.install_client_config(FluiddData())
+
+    def install_klipperscreen(self, **kwargs) -> None:
+        install_klipperscreen()
+
+    def install_crowsnest(self, **kwargs) -> None:
+        install_crowsnest()

kiauh/core/menus/main_menu.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,132 +6,183 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
+import sys
 import textwrap
+from typing import Callable, Type
 
+from components.crowsnest.crowsnest import get_crowsnest_status
 from components.klipper.klipper_utils import get_klipper_status
+from components.klipperscreen.klipperscreen import get_klipperscreen_status
 from components.log_uploads.menus.log_upload_menu import LogUploadMenu
 from components.moonraker.moonraker_utils import get_moonraker_status
 from components.webui_client.client_utils import (
     get_client_status,
-    load_client_data,
     get_current_client_config,
 )
-from core.menus import QUIT_FOOTER
+from components.webui_client.fluidd_data import FluiddData
+from components.webui_client.mainsail_data import MainsailData
+from core.constants import (
+    COLOR_CYAN,
+    COLOR_GREEN,
+    COLOR_MAGENTA,
+    COLOR_RED,
+    COLOR_YELLOW,
+    RESET_FORMAT,
+)
+from core.logger import Logger
+from core.menus import FooterType
 from core.menus.advanced_menu import AdvancedMenu
 from core.menus.backup_menu import BackupMenu
-from core.menus.base_menu import BaseMenu
+from core.menus.base_menu import BaseMenu, Option
-from core.menus.extensions_menu import ExtensionsMenu
 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 utils.constants import (
+from core.types import ComponentStatus, StatusMap, StatusText
-    COLOR_MAGENTA,
+from extensions.extensions_menu import ExtensionsMenu
-    COLOR_CYAN,
+from utils.common import get_kiauh_version, trunc_string
-    RESET_FORMAT,
-    COLOR_RED,
-    COLOR_GREEN,
-    COLOR_YELLOW,
-)
 
 
+# noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class MainMenu(BaseMenu):
-    def __init__(self):
+    def __init__(self) -> None:
-        super().__init__(
+        super().__init__()
-            header=True,
-            options={
-                "0": LogUploadMenu,
-                "1": InstallMenu,
-                "2": UpdateMenu,
-                "3": RemoveMenu,
-                "4": AdvancedMenu,
-                "5": BackupMenu,
-                "e": ExtensionsMenu,
-                "s": SettingsMenu,
-            },
-            footer_type=QUIT_FOOTER,
-        )
-        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()
 
-    def init_status(self) -> None:
+        self.header: bool = True
-        status_vars = ["kl", "mr", "ms", "fl", "ks", "mb", "cn"]
+        self.footer_type: FooterType = FooterType.QUIT
+
+        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: Type[BaseMenu] | None) -> None:
+        """MainMenu does not have a previous menu"""
+        pass
+
+    def set_options(self) -> None:
+        self.options = {
+            "0": Option(method=self.log_upload_menu),
+            "1": Option(method=self.install_menu),
+            "2": Option(method=self.update_menu),
+            "3": Option(method=self.remove_menu),
+            "4": Option(method=self.advanced_menu),
+            "5": Option(method=self.backup_menu),
+            "e": Option(method=self.extension_menu),
+            "s": Option(method=self.settings_menu),
+        }
+
+    def _init_status(self) -> None:
+        status_vars = ["kl", "mr", "ms", "fl", "ks", "cn"]
         for var in status_vars:
-            setattr(self, f"{var}_status", f"{COLOR_RED}Not installed!{RESET_FORMAT}")
+            setattr(
+                self,
+                f"{var}_status",
+                f"{COLOR_RED}Not installed{RESET_FORMAT}",
+            )
 
-    def fetch_status(self) -> None:
+    def _fetch_status(self) -> None:
-        # klipper
+        self.version = get_kiauh_version()
-        klipper_status = get_klipper_status()
+        self._get_component_status("kl", get_klipper_status)
-        kl_status = klipper_status.get("status")
+        self._get_component_status("mr", get_moonraker_status)
-        kl_code = klipper_status.get("status_code")
+        self._get_component_status("ms", get_client_status, MainsailData())
-        kl_instances = f" {klipper_status.get('instances')}" if kl_code == 1 else ""
+        self._get_component_status("fl", get_client_status, FluiddData())
-        self.kl_status = self.format_status_by_code(kl_code, kl_status, kl_instances)
+        self._get_component_status("ks", get_klipperscreen_status)
-        self.kl_repo = f"{COLOR_CYAN}{klipper_status.get('repo')}{RESET_FORMAT}"
+        self._get_component_status("cn", get_crowsnest_status)
-        # moonraker
+        self.cc_status = get_current_client_config()
-        moonraker_status = get_moonraker_status()
-        mr_status = moonraker_status.get("status")
-        mr_code = moonraker_status.get("status_code")
-        mr_instances = f" {moonraker_status.get('instances')}" if mr_code == 1 else ""
-        self.mr_status = self.format_status_by_code(mr_code, mr_status, mr_instances)
-        self.mr_repo = f"{COLOR_CYAN}{moonraker_status.get('repo')}{RESET_FORMAT}"
-        # mainsail
-        mainsail_client_data = load_client_data("mainsail")
-        self.ms_status = get_client_status(mainsail_client_data)
-        # fluidd
-        fluidd_client_data = load_client_data("fluidd")
-        self.fl_status = get_client_status(fluidd_client_data)
-        # client-config
-        self.cc_status = get_current_client_config(
-            [mainsail_client_data, fluidd_client_data]
-        )
 
-    def format_status_by_code(self, code: int, status: str, count: str) -> str:
+    def _get_component_status(self, name: str, status_fn: Callable, *args) -> None:
-        if code == 1:
+        status_data: ComponentStatus = status_fn(*args)
-            return f"{COLOR_GREEN}{status}{count}{RESET_FORMAT}"
+        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 == 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:
+        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):
+    def print_menu(self) -> None:
-        self.fetch_status()
+        self._fetch_status()
 
         header = " [ Main Menu ] "
-        footer1 = "KIAUH v6.0.0"
+        footer1 = f"{COLOR_CYAN}{self.version}{RESET_FORMAT}"
         footer2 = f"Changelog: {COLOR_MAGENTA}https://git.io/JnmlX{RESET_FORMAT}"
         color = COLOR_CYAN
         count = 62 - len(color) - len(RESET_FORMAT)
+        pad1 = 32
+        pad2 = 26
         menu = textwrap.dedent(
             f"""
-            /=======================================================\\
+            ╔═══════════════════════════════════════════════════════╗
-            | {color}{header:~^{count}}{RESET_FORMAT} |
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
-            |-------------------------------------------------------|
+            ╟──────────────────┬────────────────────────────────────╢
-            |  0) [Log-Upload] |   Klipper: {self.kl_status:<32} |
+            ║  0) [Log-Upload] │   Klipper: {self.kl_status:<{pad1}} ║
-            |                  |      Repo: {self.kl_repo:<32} |
+            ║                  │     Owner: {self.kl_owner:<{pad1}} ║
-            |  1) [Install]    |------------------------------------|
+            ║  1) [Install]    │      Repo: {self.kl_repo:<{pad1}} ║
-            |  2) [Update]     | Moonraker: {self.mr_status:<32} |
+            ║  2) [Update]     ├────────────────────────────────────╢
-            |  3) [Remove]     |      Repo: {self.mr_repo:<32} |
+            ║  3) [Remove]     │ Moonraker: {self.mr_status:<{pad1}} ║
-            |  4) [Advanced]   |------------------------------------|
+            ║  4) [Advanced]   │     Owner: {self.mr_owner:<{pad1}} ║
-            |  5) [Backup]     |        Mainsail: {self.ms_status:<26} |
+            ║  5) [Backup]     │      Repo: {self.mr_repo:<{pad1}} ║
-            |                  |          Fluidd: {self.fl_status:<26} |
+            ║                  ├────────────────────────────────────╢
-            |  S) [Settings]   |   Client-Config: {self.cc_status:<26} |
+            ║  S) [Settings]   │        Mainsail: {self.ms_status:<{pad2}} ║
-            |                  |                                    |
+            ║                  │          Fluidd: {self.fl_status:<{pad2}} ║
-            | Community:       |   KlipperScreen: {self.ks_status:<26} |
+            ║ Community:       │   Client-Config: {self.cc_status:<{pad2}} ║
-            |  E) [Extensions] |     Mobileraker: {self.mb_status:<26} |
+            ║  E) [Extensions] │                                    ║
-            |                  |       Crowsnest: {self.cn_status:<26} |
+            ║                  │   KlipperScreen: {self.ks_status:<{pad2}} ║
-            |-------------------------------------------------------|
+            ║                  │       Crowsnest: {self.cn_status:<{pad2}} ║
-            | {COLOR_CYAN}{footer1:^16}{RESET_FORMAT} | {footer2:^43} |
+            ╟──────────────────┼────────────────────────────────────╢
+            ║ {footer1:^25} │ {footer2:^43} ║
+            ╟──────────────────┴────────────────────────────────────╢
             """
         )[1:]
         print(menu, end="")
+
+    def exit(self, **kwargs) -> None:
+        Logger.print_ok("###### Happy printing!", False)
+        sys.exit(0)
+
+    def log_upload_menu(self, **kwargs) -> None:
+        LogUploadMenu().run()
+
+    def install_menu(self, **kwargs) -> None:
+        InstallMenu(previous_menu=self.__class__).run()
+
+    def update_menu(self, **kwargs) -> None:
+        UpdateMenu(previous_menu=self.__class__).run()
+
+    def remove_menu(self, **kwargs) -> None:
+        RemoveMenu(previous_menu=self.__class__).run()
+
+    def advanced_menu(self, **kwargs) -> None:
+        AdvancedMenu(previous_menu=self.__class__).run()
+
+    def backup_menu(self, **kwargs) -> None:
+        BackupMenu(previous_menu=self.__class__).run()
+
+    def settings_menu(self, **kwargs) -> None:
+        SettingsMenu(previous_menu=self.__class__).run()
+
+    def extension_menu(self, **kwargs) -> None:
+        ExtensionsMenu(previous_menu=self.__class__).run()

kiauh/core/menus/remove_menu.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,65 +6,84 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
+from typing import Type
 
+from components.crowsnest.crowsnest import remove_crowsnest
 from components.klipper.menus.klipper_remove_menu import KlipperRemoveMenu
-from components.moonraker.menus.moonraker_remove_menu import MoonrakerRemoveMenu
+from components.klipperscreen.klipperscreen import remove_klipperscreen
-from components.webui_client.client_utils import load_client_data
+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.menus import BACK_FOOTER
+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):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
-        super().__init__(
+        super().__init__()
-            header=True,
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
-            options={
-                "1": KlipperRemoveMenu,
-                "2": MoonrakerRemoveMenu,
-                "3": ClientRemoveMenu(client=load_client_data("mainsail")),
-                "4": ClientRemoveMenu(client=load_client_data("fluidd")),
-                "5": None,
-                "6": None,
-                "7": None,
-                "8": None,
-                "9": None,
-                "10": None,
-                "11": None,
-                "12": None,
-                "13": None,
-            },
-            footer_type=BACK_FOOTER,
-        )
 
-    def print_menu(self):
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+        from core.menus.main_menu import MainMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "1": Option(method=self.remove_klipper),
+            "2": Option(method=self.remove_moonraker),
+            "3": Option(method=self.remove_mainsail),
+            "4": Option(method=self.remove_fluidd),
+            "5": Option(method=self.remove_klipperscreen),
+            "6": Option(method=self.remove_crowsnest),
+        }
+
+    def print_menu(self) -> None:
         header = " [ Remove Menu ] "
         color = COLOR_RED
         count = 62 - len(color) - len(RESET_FORMAT)
         menu = textwrap.dedent(
             f"""
-            /=======================================================\\
+            ╔═══════════════════════════════════════════════════════╗
-            | {color}{header:~^{count}}{RESET_FORMAT} |
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
-            |-------------------------------------------------------|
+            ╟───────────────────────────────────────────────────────╢
-            | INFO: Configurations and/or any backups will be kept! |
+            ║ INFO: Configurations and/or any backups will be kept! ║
-            |-------------------------------------------------------|
+            ╟───────────────────────────┬───────────────────────────╢
-            | Firmware & API:           | Webcam Streamer:          |
+            ║ Firmware & API:           │ Touchscreen GUI:          ║
-            |  1) [Klipper]             |  6) [Crowsnest]           |
+            ║  1) [Klipper]             │  5) [KlipperScreen]       ║
-            |  2) [Moonraker]           |  7) [MJPG-Streamer]       |
+            ║  2) [Moonraker]           │                           ║
-            |                           |                           |
+            ║                           │ Webcam Streamer:          ║
-            | Klipper Webinterface:     | Other:                    |
+            ║ Klipper Webinterface:     │  6) [Crowsnest]           ║
-            |  3) [Mainsail]            |  8) [PrettyGCode]         |
+            ║  3) [Mainsail]            │                           ║
-            |  4) [Fluidd]              |  9) [Telegram Bot]        |
+            ║  4) [Fluidd]              │                           ║
-            |                           | 10) [Obico for Klipper]   |
+            ╟───────────────────────────┴───────────────────────────╢
-            | Touchscreen GUI:          | 11) [OctoEverywhere]      |
-            |  5) [KlipperScreen]       | 12) [Mobileraker]         |
-            |                           | 13) [NGINX]               |
-            |                           |                           |
             """
         )[1:]
         print(menu, end="")
+
+    def remove_klipper(self, **kwargs) -> None:
+        KlipperRemoveMenu(previous_menu=self.__class__).run()
+
+    def remove_moonraker(self, **kwargs) -> None:
+        MoonrakerRemoveMenu(previous_menu=self.__class__).run()
+
+    def remove_mainsail(self, **kwargs) -> None:
+        ClientRemoveMenu(previous_menu=self.__class__, client=MainsailData()).run()
+
+    def remove_fluidd(self, **kwargs) -> None:
+        ClientRemoveMenu(previous_menu=self.__class__, client=FluiddData()).run()
+
+    def remove_klipperscreen(self, **kwargs) -> None:
+        remove_klipperscreen()
+
+    def remove_crowsnest(self, **kwargs) -> None:
+        remove_crowsnest()

kiauh/core/menus/settings_menu.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,26 +6,184 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
+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, RepoSettings
+from procedures.switch_repo import run_switch_repo_routine
+from utils.input_utils import get_confirm, get_string_input
 
 
+# noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class SettingsMenu(BaseMenu):
-    def __init__(self):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
-        super().__init__(header=True, options={})
+        super().__init__()
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+        self.klipper_repo: str | None = None
+        self.moonraker_repo: str | None = None
+        self.mainsail_unstable: bool | None = None
+        self.fluidd_unstable: bool | None = None
+        self.auto_backups_enabled: bool | None = None
+        self._load_settings()
 
-    def print_menu(self):
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        print("self")
+        from core.menus.main_menu import MainMenu
 
-    def execute_option_p(self):
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
-        # Implement the functionality for Option P
-        print("Executing Option P")
 
-    def execute_option_q(self):
+    def set_options(self) -> None:
-        # Implement the functionality for Option Q
+        self.options = {
-        print("Executing Option Q")
+            "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 execute_option_r(self):
+    def print_menu(self) -> None:
-        # Implement the functionality for Option R
+        header = " [ KIAUH Settings ] "
-        print("Executing Option R")
+        color = COLOR_CYAN
+        count = 62 - len(color) - len(RESET_FORMAT)
+        checked = f"[{COLOR_GREEN}x{RESET_FORMAT}]"
+        unchecked = "[ ]"
+        o1 = checked if self.mainsail_unstable else unchecked
+        o2 = checked if self.fluidd_unstable else unchecked
+        o3 = checked if self.auto_backups_enabled else unchecked
+        menu = textwrap.dedent(
+            f"""
+            ╔═══════════════════════════════════════════════════════╗
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ Klipper source repository:                            ║
+            ║   ● {self.klipper_repo:<67} ║
+            ║                                                       ║
+            ║ Moonraker source repository:                          ║
+            ║   ● {self.moonraker_repo:<67} ║
+            ║                                                       ║
+            ║ Install unstable Webinterface releases:               ║
+            ║  {o1} Mainsail                                         ║
+            ║  {o2} Fluidd                                           ║
+            ║                                                       ║
+            ║ Auto-Backup:                                          ║
+            ║  {o3} Automatic backup before update                   ║
+            ║                                                       ║
+            ╟───────────────────────────────────────────────────────╢
+            ║ 1) Set Klipper source repository                      ║
+            ║ 2) Set Moonraker source repository                    ║
+            ║                                                       ║
+            ║ 3) Toggle unstable Mainsail releases                  ║
+            ║ 4) Toggle unstable Fluidd releases                    ║
+            ║                                                       ║
+            ║ 5) Toggle automatic backups before updates            ║
+            ╟───────────────────────────────────────────────────────╢
+            """
+        )[1:]
+        print(menu, end="")
+
+    def _load_settings(self) -> None:
+        self.settings = KiauhSettings()
+
+        self._format_repo_str("klipper")
+        self._format_repo_str("moonraker")
+
+        self.auto_backups_enabled = self.settings.kiauh.backup_before_update
+        self.mainsail_unstable = self.settings.mainsail.unstable_releases
+        self.fluidd_unstable = self.settings.fluidd.unstable_releases
+
+    def _format_repo_str(self, repo_name: 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 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(
+            "Enter new repository URL",
+            allow_special_chars=True,
+        )
+        branch = get_string_input(
+            "Enter new branch name",
+            allow_special_chars=True,
+        )
+
+        return repo, branch
+
+    def _set_repo(self, repo_name: Literal["klipper", "moonraker"]) -> None:
+        repo_url, branch = self._gather_input()
+        display_name = repo_name.capitalize()
+        Logger.print_dialog(
+            DialogType.CUSTOM,
+            [
+                f"New {display_name} repository URL:",
+                f"● {repo_url}",
+                f"New {display_name} repository branch:",
+                f"● {branch}",
+            ],
+        )
+
+        if get_confirm("Apply changes?", allow_go_back=True):
+            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(
+                f"Skipping change of {display_name} source repository  ..."
+            )
+            return
+
+        Logger.print_status(f"Switching to {display_name}'s new source repository ...")
+        self._switch_repo(repo_name)
+
+    def _switch_repo(self, name: Literal["klipper", "moonraker"]) -> None:
+        repo: RepoSettings = self.settings[name]
+        run_switch_repo_routine(name, repo)
+
+    def set_klipper_repo(self, **kwargs) -> None:
+        self._set_repo("klipper")
+
+    def set_moonraker_repo(self, **kwargs) -> None:
+        self._set_repo("moonraker")
+
+    def toggle_mainsail_release(self, **kwargs) -> None:
+        self.mainsail_unstable = not self.mainsail_unstable
+        self.settings.mainsail.unstable_releases = self.mainsail_unstable
+        self.settings.save()
+
+    def toggle_fluidd_release(self, **kwargs) -> None:
+        self.fluidd_unstable = not self.fluidd_unstable
+        self.settings.fluidd.unstable_releases = self.fluidd_unstable
+        self.settings.save()
+
+    def toggle_backup_before_update(self, **kwargs) -> None:
+        self.auto_backups_enabled = not self.auto_backups_enabled
+        self.settings.kiauh.backup_before_update = self.auto_backups_enabled
+        self.settings.save()

kiauh/core/menus/update_menu.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python3
-
 # ======================================================================= #
 #  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
@@ -8,13 +6,20 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
+from typing import Callable, List, Type
 
+from components.crowsnest.crowsnest import get_crowsnest_status, update_crowsnest
 from components.klipper.klipper_setup import update_klipper
 from components.klipper.klipper_utils import (
     get_klipper_status,
 )
+from components.klipperscreen.klipperscreen import (
+    get_klipperscreen_status,
+    update_klipperscreen,
+)
 from components.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 (
@@ -22,172 +27,310 @@ from components.webui_client.client_config.client_config_setup import (
 )
 from components.webui_client.client_setup import update_client
 from components.webui_client.client_utils import (
-    get_local_client_version,
-    get_remote_client_version,
-    load_client_data,
     get_client_config_status,
+    get_client_status,
 )
-from core.menus import BACK_FOOTER
+from components.webui_client.fluidd_data import FluiddData
-from core.menus.base_menu import BaseMenu
+from components.webui_client.mainsail_data import MainsailData
-from utils.constants import (
+from core.constants import (
     COLOR_GREEN,
-    RESET_FORMAT,
-    COLOR_YELLOW,
-    COLOR_WHITE,
     COLOR_RED,
+    COLOR_YELLOW,
+    RESET_FORMAT,
+)
+from core.logger import DialogType, Logger
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+from core.spinner import Spinner
+from core.types import ComponentStatus
+from utils.input_utils import get_confirm
+from utils.sys_utils import (
+    get_upgradable_packages,
+    update_system_package_lists,
+    upgrade_system_packages,
 )
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class UpdateMenu(BaseMenu):
-    def __init__(self):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
-        super().__init__(
+        super().__init__()
-            header=True,
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
-            options={
-                "0": self.update_all,
-                "1": self.update_klipper,
-                "2": self.update_moonraker,
-                "3": self.update_mainsail,
-                "4": self.update_fluidd,
-                "5": self.update_mainsail_config,
-                "6": self.update_fluidd_config,
-                "7": self.update_klipperscreen,
-                "8": self.update_mobileraker,
-                "9": self.update_crowsnest,
-                "10": self.upgrade_system_packages,
-            },
-            footer_type=BACK_FOOTER,
-        )
-        self.kl_local = f"{COLOR_WHITE}{RESET_FORMAT}"
-        self.kl_remote = f"{COLOR_WHITE}{RESET_FORMAT}"
-        self.mr_local = f"{COLOR_WHITE}{RESET_FORMAT}"
-        self.mr_remote = f"{COLOR_WHITE}{RESET_FORMAT}"
-        self.ms_local = f"{COLOR_WHITE}{RESET_FORMAT}"
-        self.ms_remote = f"{COLOR_WHITE}{RESET_FORMAT}"
-        self.fl_local = f"{COLOR_WHITE}{RESET_FORMAT}"
-        self.fl_remote = f"{COLOR_WHITE}{RESET_FORMAT}"
-        self.mc_local = f"{COLOR_WHITE}{RESET_FORMAT}"
-        self.mc_remote = f"{COLOR_WHITE}{RESET_FORMAT}"
-        self.fc_local = f"{COLOR_WHITE}{RESET_FORMAT}"
-        self.fc_remote = f"{COLOR_WHITE}{RESET_FORMAT}"
 
-    def print_menu(self):
+        self.packages: List[str] = []
-        self.fetch_update_status()
+        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.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: Type[BaseMenu] | None) -> None:
+        from core.menus.main_menu import MainMenu
+
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+    def set_options(self) -> None:
+        self.options = {
+            "a": Option(self.update_all),
+            "1": Option(self.update_klipper),
+            "2": Option(self.update_moonraker),
+            "3": Option(self.update_mainsail),
+            "4": Option(self.update_fluidd),
+            "5": Option(self.update_mainsail_config),
+            "6": Option(self.update_fluidd_config),
+            "7": Option(self.update_klipperscreen),
+            "8": Option(self.update_crowsnest),
+            "9": Option(self.upgrade_system_packages),
+        }
+
+    def print_menu(self) -> None:
+        spinner = Spinner("Loading update menu, please wait", color="green")
+        spinner.start()
+
+        self._fetch_update_status()
+
+        spinner.stop()
 
         header = " [ Update Menu ] "
         color = COLOR_GREEN
         count = 62 - len(color) - len(RESET_FORMAT)
+
+        sysupgrades: str = "No upgrades available."
+        padding = 29
+        if self.package_count > 0:
+            sysupgrades = (
+                f"{COLOR_GREEN}{self.package_count} upgrades available!{RESET_FORMAT}"
+            )
+            padding = 38
+
         menu = textwrap.dedent(
             f"""
-            /=======================================================\\
+            ╔═══════════════════════════════════════════════════════╗
-            | {color}{header:~^{count}}{RESET_FORMAT} |
+            ║ {color}{header:~^{count}}{RESET_FORMAT} ║
-            |-------------------------------------------------------|
+            ╟───────────────────────┬───────────────┬───────────────╢
-            |  0) Update all        |               |               |
+            ║  a) Update all        │               │               ║
-            |                       | Current:      | Latest:       |
+            ║                       │ Current:      │ Latest:       ║
-            | Klipper & API:        |---------------|---------------|
+            ║ Klipper & API:        ├───────────────┼───────────────╢
-            |  1) Klipper           | {self.kl_local:<22} | {self.kl_remote:<22} |
+            ║  1) Klipper           │ {self.klipper_local:<22} │ {self.klipper_remote:<22} ║
-            |  2) Moonraker         | {self.mr_local:<22} | {self.mr_remote:<22} |
+            ║  2) Moonraker         │ {self.moonraker_local:<22} │ {self.moonraker_remote:<22} ║
-            |                       |               |               |
+            ║                       │               │               ║
-            | Webinterface:         |---------------|---------------|
+            ║ Webinterface:         ├───────────────┼───────────────╢
-            |  3) Mainsail          | {self.ms_local:<22} | {self.ms_remote:<22} |
+            ║  3) Mainsail          │ {self.mainsail_local:<22} │ {self.mainsail_remote:<22} ║
-            |  4) Fluidd            | {self.fl_local:<22} | {self.fl_remote:<22} |
+            ║  4) Fluidd            │ {self.fluidd_local:<22} │ {self.fluidd_remote:<22} ║
-            |                       |               |               |
+            ║                       │               │               ║
-            | Client-Config:        |---------------|---------------|
+            ║ Client-Config:        ├───────────────┼───────────────╢
-            |  5) Mainsail-Config   | {self.mc_local:<22} | {self.mc_remote:<22} |
+            ║  5) Mainsail-Config   │ {self.mainsail_config_local:<22} │ {self.mainsail_config_remote:<22} ║
-            |  6) Fluidd-Config     | {self.fc_local:<22} | {self.fc_remote:<22} |
+            ║  6) Fluidd-Config     │ {self.fluidd_config_local:<22} │ {self.fluidd_config_remote:<22} ║
-            |                       |               |               |
+            ║                       │               │               ║
-            | Other:                |---------------|---------------|
+            ║ Other:                ├───────────────┼───────────────╢
-            |  7) KlipperScreen     |               |               |
+            ║  7) KlipperScreen     │ {self.klipperscreen_local:<22} │ {self.klipperscreen_remote:<22} ║
-            |  8) Mobileraker       |               |               |
+            ║  8) Crowsnest         │ {self.crowsnest_local:<22} │ {self.crowsnest_remote:<22} ║
-            |  9) Crowsnest         |               |               |
+            ║                       ├───────────────┴───────────────╢
-            |                       |-------------------------------|
+            ║  9) System            │ {sysupgrades:^{padding}} ║
-            | 10) System            |                               |
+            ╟───────────────────────┴───────────────────────────────╢
             """
         )[1:]
         print(menu, end="")
 
-    def update_all(self, **kwargs):
+    def update_all(self, **kwargs) -> None:
-        print("update_all")
+        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):
+    def update_klipper(self, **kwargs) -> None:
-        update_klipper()
+        self._run_update_routine("klipper", update_klipper)
 
-    def update_moonraker(self, **kwargs):
+    def update_moonraker(self, **kwargs) -> None:
-        update_moonraker()
+        self._run_update_routine("moonraker", update_moonraker)
 
-    def update_mainsail(self, **kwargs):
+    def update_mainsail(self, **kwargs) -> None:
-        update_client(load_client_data("mainsail"))
+        self._run_update_routine(
+            "mainsail",
+            update_client,
+            self.mainsail_data,
+        )
 
-    def update_mainsail_config(self, **kwargs):
+    def update_mainsail_config(self, **kwargs) -> None:
-        update_client_config(load_client_data("mainsail"))
+        self._run_update_routine(
+            "mainsail_config",
+            update_client_config,
+            self.mainsail_data,
+        )
 
-    def update_fluidd(self, **kwargs):
+    def update_fluidd(self, **kwargs) -> None:
-        update_client(load_client_data("fluidd"))
+        self._run_update_routine(
+            "fluidd",
+            update_client,
+            self.fluidd_data,
+        )
 
-    def update_fluidd_config(self, **kwargs):
+    def update_fluidd_config(self, **kwargs) -> None:
-        update_client_config(load_client_data("fluidd"))
+        self._run_update_routine(
+            "fluidd_config",
+            update_client_config,
+            self.fluidd_data,
+        )
 
-    def update_klipperscreen(self, **kwargs): ...
+    def update_klipperscreen(self, **kwargs) -> None:
+        self._run_update_routine("klipperscreen", update_klipperscreen)
 
-    def update_mobileraker(self, **kwargs): ...
+    def update_crowsnest(self, **kwargs) -> None:
+        self._run_update_routine("crowsnest", update_crowsnest)
 
-    def update_crowsnest(self, **kwargs): ...
+    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):
+        update_system_package_lists(silent=True)
-        # klipper
+        self.packages = get_upgradable_packages()
-        kl_status = get_klipper_status()
+        self.package_count = len(self.packages)
-        self.kl_local = kl_status.get("local")
+
-        self.kl_remote = kl_status.get("remote")
+    def _format_local_status(self, local_version, remote_version) -> str:
-        if self.kl_local == self.kl_remote:
+        color = COLOR_RED
-            self.kl_local = f"{COLOR_GREEN}{self.kl_local}{RESET_FORMAT}"
+        if not local_version:
-        else:
+            color = COLOR_RED
-            self.kl_local = f"{COLOR_YELLOW}{self.kl_local}{RESET_FORMAT}"
+        elif local_version == remote_version:
-        self.kl_remote = f"{COLOR_GREEN}{self.kl_remote}{RESET_FORMAT}"
+            color = COLOR_GREEN
-        # moonraker
+        elif local_version != remote_version:
-        mr_status = get_moonraker_status()
+            color = COLOR_YELLOW
-        self.mr_local = mr_status.get("local")
+
-        self.mr_remote = mr_status.get("remote")
+        return f"{color}{local_version or '-'}{RESET_FORMAT}"
-        if self.mr_local == self.mr_remote:
+
-            self.mr_local = f"{COLOR_GREEN}{self.mr_local}{RESET_FORMAT}"
+    def _set_status_data(self, name: str, status_fn: Callable, *args) -> None:
-        else:
+        comp_status: ComponentStatus = status_fn(*args)
-            self.mr_local = f"{COLOR_YELLOW}{self.mr_local}{RESET_FORMAT}"
+
-        self.mr_remote = f"{COLOR_GREEN}{self.mr_remote}{RESET_FORMAT}"
+        self.status_data[name]["installed"] = True if comp_status.status == 2 else False
-        # mainsail
+        self.status_data[name]["local"] = comp_status.local
-        mainsail_client_data = load_client_data("mainsail")
+        self.status_data[name]["remote"] = comp_status.remote
-        self.ms_local = get_local_client_version(mainsail_client_data)
+
-        self.ms_remote = get_remote_client_version(mainsail_client_data)
+        self._set_status_string(name)
-        if self.ms_local == self.ms_remote:
+
-            self.ms_local = f"{COLOR_GREEN}{self.ms_local}{RESET_FORMAT}"
+    def _set_status_string(self, name: str) -> None:
-        else:
+        local_status = self.status_data[name].get("local", None)
-            self.ms_local = f"{COLOR_YELLOW}{self.ms_local}{RESET_FORMAT}"
+        remote_status = self.status_data[name].get("remote", None)
-        self.ms_remote = f"{COLOR_GREEN if self.ms_remote != 'ERROR' else COLOR_RED}{self.ms_remote}{RESET_FORMAT}"
+
-        # fluidd
+        color = COLOR_GREEN if remote_status else COLOR_RED
-        fluidd_client_data = load_client_data("fluidd")
+        local_txt = self._format_local_status(local_status, remote_status)
-        self.fl_local = get_local_client_version(fluidd_client_data)
+        remote_txt = f"{color}{remote_status or '-'}{RESET_FORMAT}"
-        self.fl_remote = get_remote_client_version(fluidd_client_data)
+
-        if self.fl_local == self.fl_remote:
+        setattr(self, f"{name}_local", local_txt)
-            self.fl_local = f"{COLOR_GREEN}{self.fl_local}{RESET_FORMAT}"
+        setattr(self, f"{name}_remote", remote_txt)
-        else:
+
-            self.fl_local = f"{COLOR_YELLOW}{self.fl_local}{RESET_FORMAT}"
+    def _check_is_installed(self, name: str) -> bool:
-        self.fl_remote = f"{COLOR_GREEN if self.fl_remote != 'ERROR' else COLOR_RED}{self.fl_remote}{RESET_FORMAT}"
+        return self.status_data[name]["installed"]
-        # mainsail-config
+
-        mc_status = get_client_config_status(load_client_data("mainsail"))
+    def _is_update_available(self, name: str) -> bool:
-        self.mc_local = mc_status.get("local")
+        return self.status_data[name]["local"] != self.status_data[name]["remote"]
-        self.mc_remote = mc_status.get("remote")
+
-        if self.mc_local == self.mc_remote:
+    def _run_update_routine(self, name: str, update_fn: Callable, *args) -> None:
-            self.mc_local = f"{COLOR_GREEN}{self.mc_local}{RESET_FORMAT}"
+        display_name = self.status_data[name]["display_name"]
-        else:
+        is_installed = self._check_is_installed(name)
-            self.mc_local = f"{COLOR_YELLOW}{self.mc_local}{RESET_FORMAT}"
+        is_update_available = self._is_update_available(name)
-        self.mc_remote = f"{COLOR_GREEN}{self.mc_remote}{RESET_FORMAT}"
+
-        # fluidd-config
+        if not is_installed:
-        fc_status = get_client_config_status(load_client_data("fluidd"))
+            Logger.print_info(f"{display_name} is not installed! Skipped ...")
-        self.fc_local = fc_status.get("local")
+            return
-        self.fc_remote = fc_status.get("remote")
+        elif not is_update_available:
-        if self.fc_local == self.mc_remote:
+            Logger.print_info(f"{display_name} is already up to date! Skipped ...")
-            self.fc_local = f"{COLOR_GREEN}{self.fc_local}{RESET_FORMAT}"
+            return
-        else:
+
-            self.fc_local = f"{COLOR_YELLOW}{self.fc_local}{RESET_FORMAT}"
+        update_fn(*args)
-        self.fc_remote = f"{COLOR_GREEN}{self.fc_remote}{RESET_FORMAT}"
+
+    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/repo_manager/repo_manager.py

@@ -1,170 +0,0 @@
-#!/usr/bin/env python3
-
-# ======================================================================= #
-#  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
-import subprocess
-from pathlib import Path
-
-from utils.input_utils import get_confirm
-from utils.logger import Logger
-
-
-# noinspection PyMethodMayBeStatic
-class RepoManager:
-    def __init__(
-        self,
-        repo: str,
-        target_dir: str,
-        branch: str = None,
-    ):
-        self._repo = repo
-        self._branch = branch if branch is not None else "master"
-        self._method = self._get_method()
-        self._target_dir = target_dir
-
-    @property
-    def repo(self) -> str:
-        return self._repo
-
-    @repo.setter
-    def repo(self, value) -> None:
-        self._repo = value
-
-    @property
-    def branch(self) -> str:
-        return self._branch
-
-    @branch.setter
-    def branch(self, value) -> None:
-        self._branch = value
-
-    @property
-    def method(self) -> str:
-        return self._method
-
-    @method.setter
-    def method(self, value) -> None:
-        self._method = value
-
-    @property
-    def target_dir(self) -> str:
-        return self._target_dir
-
-    @target_dir.setter
-    def target_dir(self, value) -> None:
-        self._target_dir = value
-
-    @staticmethod
-    def get_repo_name(repo: Path) -> str:
-        """
-        Helper method to extract the organisation and name of a repository |
-        :param repo: repository to extract the values from
-        :return: String in form of "<orga>/<name>"
-        """
-        if not repo.exists() and not repo.joinpath(".git").exists():
-            return "-"
-
-        try:
-            cmd = ["git", "-C", repo, "config", "--get", "remote.origin.url"]
-            result = subprocess.check_output(cmd, stderr=subprocess.DEVNULL)
-            return "/".join(result.decode().strip().split("/")[-2:])
-        except subprocess.CalledProcessError:
-            return "-"
-
-    @staticmethod
-    def get_local_commit(repo: Path) -> str:
-        if not repo.exists() and not repo.joinpath(".git").exists():
-            return "-"
-
-        try:
-            cmd = f"cd {repo} && git describe HEAD --always --tags | cut -d '-' -f 1,2"
-            return subprocess.check_output(cmd, shell=True, text=True).strip()
-        except subprocess.CalledProcessError:
-            return "-"
-
-    @staticmethod
-    def get_remote_commit(repo: Path) -> str:
-        if not repo.exists() and not repo.joinpath(".git").exists():
-            return "-"
-
-        try:
-            # get locally checked out branch
-            branch_cmd = f"cd {repo} && git branch | grep -E '\*'"
-            branch = subprocess.check_output(branch_cmd, shell=True, text=True)
-            branch = branch.split("*")[-1].strip()
-            cmd = f"cd {repo} && git describe 'origin/{branch}' --always --tags | cut -d '-' -f 1,2"
-            return subprocess.check_output(cmd, shell=True, text=True).strip()
-        except subprocess.CalledProcessError:
-            return "-"
-
-    def clone_repo(self):
-        log = f"Cloning repository from '{self.repo}' with method '{self.method}'"
-        Logger.print_status(log)
-        try:
-            if Path(self.target_dir).exists():
-                question = f"'{self.target_dir}' already exists. Overwrite?"
-                if not get_confirm(question, default_choice=False):
-                    Logger.print_info("Skipping re-clone of repository.")
-                    return
-                shutil.rmtree(self.target_dir)
-
-            self._clone()
-            self._checkout()
-        except subprocess.CalledProcessError:
-            log = "An unexpected error occured during cloning of the repository."
-            Logger.print_error(log)
-            return
-        except OSError as e:
-            Logger.print_error(f"Error removing existing repository: {e.strerror}")
-            return
-
-    def pull_repo(self) -> None:
-        Logger.print_status(f"Updating repository '{self.repo}' ...")
-        try:
-            self._pull()
-        except subprocess.CalledProcessError:
-            log = "An unexpected error occured during updating the repository."
-            Logger.print_error(log)
-            return
-
-    def _clone(self):
-        try:
-            command = ["git", "clone", self.repo, self.target_dir]
-            subprocess.run(command, check=True)
-
-            Logger.print_ok("Clone successfull!")
-        except subprocess.CalledProcessError as e:
-            log = f"Error cloning repository {self.repo}: {e.stderr.decode()}"
-            Logger.print_error(log)
-            raise
-
-    def _checkout(self):
-        try:
-            command = ["git", "checkout", f"{self.branch}"]
-            subprocess.run(command, cwd=self.target_dir, check=True)
-
-            Logger.print_ok("Checkout successfull!")
-        except subprocess.CalledProcessError as e:
-            log = f"Error checking out branch {self.branch}: {e.stderr.decode()}"
-            Logger.print_error(log)
-            raise
-
-    def _pull(self) -> None:
-        try:
-            command = ["git", "pull"]
-            subprocess.run(command, cwd=self.target_dir, check=True)
-        except subprocess.CalledProcessError as e:
-            log = f"Error on git pull: {e.stderr.decode()}"
-            Logger.print_error(log)
-            raise
-
-    def _get_method(self) -> str:
-        return "ssh" if self.repo.startswith("git") else "https"

kiauh/core/settings/kiauh_settings.py

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

kiauh/core/spinner.py

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

kiauh/core/submodules/simple_config_parser/.editorconfig

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

kiauh/core/submodules/simple_config_parser/.gitignore

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

kiauh/core/submodules/simple_config_parser/LICENSE

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

kiauh/core/submodules/simple_config_parser/README.md

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

kiauh/core/submodules/simple_config_parser/pyproject.toml

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

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

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

kiauh/core/submodules/simple_config_parser/src/simple_config_parser/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

@@ -0,0 +1,312 @@
+# ======================================================================= #
+#  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 __future__ import annotations
+
+import secrets
+import string
+from pathlib import Path
+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 NoSectionError(Exception):
+    """Raised when a section is not defined"""
+
+    def __init__(self, section: str):
+        msg = f"Section '{section}' is not defined"
+        super().__init__(msg)
+
+
+class DuplicateSectionError(Exception):
+    """Raised when a section is defined more than once"""
+
+    def __init__(self, section: str):
+        msg = f"Section '{section}' is defined more than once"
+        super().__init__(msg)
+
+
+class 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)
+
+
+# noinspection PyMethodMayBeStatic
+class SimpleConfigParser:
+    """A customized config parser targeted at handling Klipper style config files"""
+
+    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
+
+    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 _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 _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
+
+    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
+
+    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
+
+    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}
+
+        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}
+
+        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": []}
+
+        elif self.current_opt_block is not None:
+            self.config[self.current_section][self.current_opt_block]["value"].append(
+                line
+            )
+
+        elif self._match_empty_line(line) or self._match_line_comment(line):
+            self.current_opt_block = None
+
+            # 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]
+
+                # 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] = []
+
+                section[self.current_collector].append(line)
+
+    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)
+
+        # print(json.dumps(self.config, indent=4))
+
+    def write_file(self, file: Path) -> None:
+        """Write the current config to the config file"""
+        if not file:
+            raise ValueError("No config file specified")
+
+        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 config"""
+        if section in self.get_sections():
+            raise DuplicateSectionError(section)
+
+        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 a section from the config"""
+        self.config.pop(section, None)
+
+    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(),
+            )
+        )
+
+    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 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)
+
+        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 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]:
+        """
+        Return the value of the given option in the given section
+
+        If the key is not found and 'fallback' is provided, it is used as
+        a fallback value.
+        """
+        try:
+            if section not in self.get_sections():
+                raise NoSectionError(section)
+            if option not in self.get_options(section):
+                raise NoOptionError(option, section)
+            return self.config[section][option]["value"]
+        except (NoSectionError, NoOptionError):
+            if fallback is _UNSET:
+                raise
+            return fallback
+
+    def getint(self, section: str, option: str, fallback: int | _UNSET = _UNSET) -> int:
+        """Return the value of the given option in the given section as an int"""
+        return self._get_conv(section, option, int, fallback=fallback)
+
+    def getfloat(
+        self, section: str, option: str, fallback: float | _UNSET = _UNSET
+    ) -> float:
+        """Return 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: 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 BOOLEAN_STATES[value.lower()]
+
+    def _get_conv(
+        self,
+        section: str,
+        option: str,
+        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.getval(section, option, fallback))
+        except ValueError as e:
+            if fallback is not _UNSET:
+                return fallback
+            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/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/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_(%) =