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

Signed-off-by: Dominik Willner <th33xitus@gmail.com>

.editorconfig

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

README.md

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

docs/changelog.md

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

kiauh.sh

@@ -12,97 +12,163 @@
 set -e
 clear
 
-function main() {
+### sourcing all additional scripts
-  local python_command
+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/components/crowsnest/__init__.py

@@ -10,7 +10,7 @@
 from pathlib import Path
 
 from core.backup_manager import BACKUP_ROOT_DIR
-from utils.constants import SYSTEMD
+from core.constants import SYSTEMD
 
 # repo
 CROWSNEST_REPO = "https://github.com/mainsail-crew/crowsnest.git"

kiauh/components/crowsnest/crowsnest.py

@@ -27,24 +27,24 @@ from components.crowsnest import (
 )
 from components.klipper.klipper import Klipper
 from core.backup_manager.backup_manager import BackupManager
-from core.instance_manager.instance_manager import InstanceManager
+from core.constants import CURRENT_USER
+from core.logger import DialogType, Logger
 from core.settings.kiauh_settings import KiauhSettings
+from core.types import ComponentStatus
 from utils.common import (
     check_install_dependencies,
     get_install_status,
 )
-from utils.constants import CURRENT_USER
 from utils.git_utils import (
     git_clone_wrapper,
     git_pull_wrapper,
 )
 from utils.input_utils import get_confirm
-from utils.logger import DialogType, Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
     cmd_sysctl_service,
     parse_packages_from_file,
 )
-from utils.types import ComponentStatus
 
 
 def install_crowsnest() -> None:
@@ -52,11 +52,10 @@ def install_crowsnest() -> None:
     git_clone_wrapper(CROWSNEST_REPO, CROWSNEST_DIR, "master")
 
     # Step 2: Install dependencies
-    check_install_dependencies(["make"])
+    check_install_dependencies({"make"})
 
     # Step 3: Check for Multi Instance
-    im = InstanceManager(Klipper)
+    instances: List[Klipper] = get_instances(Klipper)
-    instances: List[Klipper] = im.instances
 
     if len(instances) > 1:
         print_multi_instance_warning(instances)
@@ -95,7 +94,7 @@ def print_multi_instance_warning(instances: List[Klipper]) -> None:
             "this instance to set up your 'crowsnest.conf' and steering it's service.",
             "\n\n",
             "The following instances were found:",
-            *[f"● {instance.data_dir_name}" for instance in instances],
+            *[f"● {instance.data_dir.name}" for instance in instances],
         ],
     )
 
@@ -139,7 +138,7 @@ def update_crowsnest() -> None:
             git_pull_wrapper(CROWSNEST_REPO, CROWSNEST_DIR)
 
             deps = parse_packages_from_file(CROWSNEST_INSTALL_SCRIPT)
-            check_install_dependencies(deps)
+            check_install_dependencies({*deps})
 
         cmd_sysctl_service(CROWSNEST_SERVICE_NAME, "restart")
 

kiauh/components/klipper/klipper.py

@@ -6,9 +6,11 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
-from dataclasses import dataclass
+from __future__ import annotations
+
+from dataclasses import dataclass, field
 from pathlib import Path
-from subprocess import CalledProcessError, run
+from subprocess import CalledProcessError
 
 from components.klipper import (
     KLIPPER_CFG_NAME,
@@ -21,29 +23,36 @@ from components.klipper import (
     KLIPPER_SERVICE_TEMPLATE,
     KLIPPER_UDS_NAME,
 )
+from core.constants import CURRENT_USER
 from core.instance_manager.base_instance import BaseInstance
-from utils.logger import Logger
+from core.logger import Logger
+from utils.fs_utils import create_folders, get_data_dir
+from utils.sys_utils import get_service_file_path
 
 
 # noinspection PyMethodMayBeStatic
-@dataclass
+@dataclass(repr=True)
-class Klipper(BaseInstance):
+class Klipper:
+    suffix: str
+    base: BaseInstance = field(init=False, repr=False)
+    service_file_path: Path = field(init=False)
+    log_file_name: str = KLIPPER_LOG_NAME
     klipper_dir: Path = KLIPPER_DIR
     env_dir: Path = KLIPPER_ENV_DIR
-    cfg_file: Path = None
+    data_dir: Path = field(init=False)
-    log: Path = None
+    cfg_file: Path = field(init=False)
-    serial: Path = None
+    serial: Path = field(init=False)
-    uds: Path = None
+    uds: Path = field(init=False)
 
-    def __init__(self, suffix: str = "") -> None:
+    def __post_init__(self):
-        super().__init__(instance_type=self, suffix=suffix)
+        self.base: BaseInstance = BaseInstance(Klipper, self.suffix)
+        self.base.log_file_name = self.log_file_name
 
-    def __post_init__(self) -> None:
+        self.service_file_path: Path = get_service_file_path(Klipper, self.suffix)
-        super().__post_init__()
+        self.data_dir: Path = get_data_dir(Klipper, self.suffix)
-        self.cfg_file = self.cfg_dir.joinpath(KLIPPER_CFG_NAME)
+        self.cfg_file: Path = self.base.cfg_dir.joinpath(KLIPPER_CFG_NAME)
-        self.log = self.log_dir.joinpath(KLIPPER_LOG_NAME)
+        self.serial: Path = self.base.comms_dir.joinpath(KLIPPER_SERIAL_NAME)
-        self.serial = self.comms_dir.joinpath(KLIPPER_SERIAL_NAME)
+        self.uds: Path = self.base.comms_dir.joinpath(KLIPPER_UDS_NAME)
-        self.uds = self.comms_dir.joinpath(KLIPPER_UDS_NAME)
 
     def create(self) -> None:
         from utils.sys_utils import create_env_file, create_service_file
@@ -51,15 +60,15 @@ class Klipper(BaseInstance):
         Logger.print_status("Creating new Klipper Instance ...")
 
         try:
-            self.create_folders()
+            create_folders(self.base.base_folders)
 
             create_service_file(
-                name=self.get_service_file_name(extension=True),
+                name=self.service_file_path.name,
                 content=self._prep_service_file_content(),
             )
 
             create_env_file(
-                path=self.sysd_dir.joinpath(KLIPPER_ENV_FILE_NAME),
+                path=self.base.sysd_dir.joinpath(KLIPPER_ENV_FILE_NAME),
                 content=self._prep_env_file_content(),
             )
 
@@ -70,21 +79,6 @@ class Klipper(BaseInstance):
             Logger.print_error(f"Error creating env file: {e}")
             raise
 
-    def delete(self) -> None:
-        service_file = self.get_service_file_name(extension=True)
-        service_file_path = self.get_service_file_path()
-
-        Logger.print_status(f"Removing Klipper Instance: {service_file}")
-
-        try:
-            command = ["sudo", "rm", "-f", service_file_path]
-            run(command, check=True)
-            self.delete_logfiles(KLIPPER_LOG_NAME)
-            Logger.print_ok("Instance successfully removed!")
-        except CalledProcessError as e:
-            Logger.print_error(f"Error removing instance: {e}")
-            raise
-
     def _prep_service_file_content(self) -> str:
         template = KLIPPER_SERVICE_TEMPLATE
 
@@ -97,7 +91,7 @@ class Klipper(BaseInstance):
 
         service_content = template_content.replace(
             "%USER%",
-            self.user,
+            CURRENT_USER,
         )
         service_content = service_content.replace(
             "%KLIPPER_DIR%",
@@ -109,7 +103,7 @@ class Klipper(BaseInstance):
         )
         service_content = service_content.replace(
             "%ENV_FILE%",
-            self.sysd_dir.joinpath(KLIPPER_ENV_FILE_NAME).as_posix(),
+            self.base.sysd_dir.joinpath(KLIPPER_ENV_FILE_NAME).as_posix(),
         )
         return service_content
 
@@ -128,19 +122,19 @@ class Klipper(BaseInstance):
         )
         env_file_content = env_file_content.replace(
             "%CFG%",
-            f"{self.cfg_dir}/{KLIPPER_CFG_NAME}",
+            f"{self.base.cfg_dir}/{KLIPPER_CFG_NAME}",
         )
         env_file_content = env_file_content.replace(
             "%SERIAL%",
-            self.serial.as_posix(),
+            self.serial.as_posix() if self.serial else "",
         )
         env_file_content = env_file_content.replace(
             "%LOG%",
-            self.log.as_posix(),
+            self.base.log_dir.joinpath(self.log_file_name).as_posix(),
         )
         env_file_content = env_file_content.replace(
             "%UDS%",
-            self.uds.as_posix(),
+            self.uds.as_posix() if self.uds else "",
         )
 
         return env_file_content

kiauh/components/klipper/klipper_dialogs.py

@@ -11,14 +11,14 @@ import textwrap
 from enum import Enum, unique
 from typing import List
 
-from core.instance_manager.base_instance import BaseInstance
+from core.constants import (
-from core.menus.base_menu import print_back_footer
-from utils.constants import (
     COLOR_CYAN,
     COLOR_GREEN,
     COLOR_YELLOW,
     RESET_FORMAT,
 )
+from core.instance_type import InstanceType
+from core.menus.base_menu import print_back_footer
 
 
 @unique
@@ -28,13 +28,13 @@ class DisplayType(Enum):
 
 
 def print_instance_overview(
-    instances: List[BaseInstance],
+    instances: List[InstanceType],
     display_type: DisplayType = DisplayType.SERVICE_NAME,
     show_headline=True,
     show_index=False,
     start_index=0,
     show_select_all=False,
-):
+) -> None:
     dialog = "╔═══════════════════════════════════════════════════════╗\n"
     if show_headline:
         d_type = (
@@ -53,7 +53,7 @@ def print_instance_overview(
 
     for i, s in enumerate(instances):
         if display_type is DisplayType.SERVICE_NAME:
-            name = s.get_service_file_name()
+            name = s.service_file_path.stem
         else:
             name = s.data_dir
         line = f"{COLOR_CYAN}{f'{i + start_index})' if show_index else '●'} {name}{RESET_FORMAT}"
@@ -64,7 +64,7 @@ def print_instance_overview(
     print_back_footer()
 
 
-def print_select_instance_count_dialog():
+def print_select_instance_count_dialog() -> None:
     line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
     line2 = f"{COLOR_YELLOW}Setting up too many instances may crash your system.{RESET_FORMAT}"
     dialog = textwrap.dedent(
@@ -84,7 +84,7 @@ 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(

kiauh/components/klipper/klipper_remove.py

@@ -6,17 +6,19 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
-from typing import List, Union
+from typing import List
 
 from components.klipper import KLIPPER_DIR, KLIPPER_ENV_DIR
 from components.klipper.klipper import Klipper
 from components.klipper.klipper_dialogs import print_instance_overview
 from core.instance_manager.instance_manager import InstanceManager
+from 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 cmd_sysctl_manage
+from utils.sys_utils import unit_file_exists
 
 
 def run_klipper_removal(
@@ -24,17 +26,17 @@ def run_klipper_removal(
     remove_dir: bool,
     remove_env: 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_info("There are still other Klipper services installed:")
         Logger.print_info(f"● '{KLIPPER_DIR}' was not removed.", prefix=False)
         Logger.print_info(f"● '{KLIPPER_ENV_DIR}' was not removed.", prefix=False)
@@ -47,9 +49,7 @@ def run_klipper_removal(
             run_remove_routines(KLIPPER_ENV_DIR)
 
 
-def select_instances_to_remove(
+def select_instances_to_remove(instances: List[Klipper]) -> List[Klipper] | None:
-    instances: List[Klipper],
-) -> Union[List[Klipper], None]:
     start_index = 1
     options = [str(i + start_index) for i in range(len(instances))]
     options.extend(["a", "b"])
@@ -75,26 +75,20 @@ def select_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()
-        instance_manager.disable_instance()
-        instance_manager.delete_instance()
-
-    cmd_sysctl_manage("daemon-reload")
 
 
 def delete_klipper_logs(instances: List[Klipper]) -> None:
     all_logfiles = []
     for instance in instances:
-        all_logfiles = list(instance.log_dir.glob("klippy.log*"))
+        all_logfiles = list(instance.base.log_dir.glob("klippy.log*"))
     if not all_logfiles:
         Logger.print_info("No Klipper logs found. Skipped ...")
         return

kiauh/components/klipper/klipper_setup.py

@@ -35,13 +35,15 @@ from components.webui_client.client_utils import (
     get_existing_clients,
 )
 from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
 from core.settings.kiauh_settings import KiauhSettings
 from utils.common import check_install_dependencies
 from utils.git_utils import git_clone_wrapper, git_pull_wrapper
 from utils.input_utils import get_confirm
-from utils.logger import DialogType, Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
     cmd_sysctl_manage,
+    cmd_sysctl_service,
     create_python_venv,
     install_python_requirements,
     parse_packages_from_file,
@@ -51,8 +53,8 @@ from utils.sys_utils import (
 def install_klipper() -> None:
     Logger.print_status("Installing Klipper ...")
 
-    klipper_list: List[Klipper] = InstanceManager(Klipper).instances
+    klipper_list: List[Klipper] = get_instances(Klipper)
-    moonraker_list: List[Moonraker] = InstanceManager(Moonraker).instances
+    moonraker_list: List[Moonraker] = get_instances(Moonraker)
     match_moonraker: bool = False
 
     # if there are more moonraker instances than klipper instances, ask the user to
@@ -94,7 +96,7 @@ def install_klipper() -> None:
 
 
 def run_klipper_setup(
-    klipper_list: List[Klipper], name_dict: Dict[int, str], example_cfg: bool
+    klipper_list: List[Klipper], name_dict: Dict[int, str], create_example_cfg: bool
 ) -> None:
     if not klipper_list:
         setup_klipper_prerequesites()
@@ -104,7 +106,16 @@ def run_klipper_setup(
         if name_dict[i] in [n.suffix for n in klipper_list]:
             continue
 
-        create_klipper_instance(name_dict[i], example_cfg)
+        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")
 
@@ -119,7 +130,7 @@ def handle_instance_names(
     install_count: int, name_dict: Dict[int, str], custom_names: bool
 ) -> None:
     for i in range(install_count):  # 3
-        key = max(name_dict.keys()) + 1
+        key: int = len(name_dict.keys()) + 1
         if custom_names:
             assign_custom_name(key, name_dict)
         else:
@@ -129,10 +140,10 @@ def handle_instance_names(
 def get_install_count_and_name_dict(
     klipper_list: List[Klipper], moonraker_list: List[Moonraker]
 ) -> Tuple[int, Dict[int, str]]:
+    install_count: int | None
     if len(moonraker_list) > len(klipper_list):
         install_count = len(moonraker_list)
         name_dict = {i: moonraker.suffix for i, moonraker in enumerate(moonraker_list)}
-
     else:
         install_count = get_install_count()
         name_dict = {i: klipper.suffix for i, klipper in enumerate(klipper_list)}
@@ -154,8 +165,8 @@ def setup_klipper_prerequesites() -> None:
     # install klipper dependencies and create python virtualenv
     try:
         install_klipper_packages()
-        create_python_venv(KLIPPER_ENV_DIR)
+        if create_python_venv(KLIPPER_ENV_DIR):
-        install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
+            install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
     except Exception:
         Logger.print_error("Error during installation of Klipper requirements!")
         raise
@@ -169,7 +180,7 @@ def install_klipper_packages() -> None:
     if Path("/boot/dietpi/.version").exists():
         packages.append("dbus")
 
-    check_install_dependencies(packages)
+    check_install_dependencies({*packages})
 
 
 def update_klipper() -> None:
@@ -189,8 +200,8 @@ def update_klipper() -> None:
     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)
 
     git_pull_wrapper(repo=settings.klipper.repo_url, target_dir=KLIPPER_DIR)
 
@@ -199,29 +210,17 @@ def update_klipper() -> None:
     # install possible new python dependencies
     install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
 
-    instance_manager.start_all_instance()
+    InstanceManager.start_all(instances)
-
-
-def create_klipper_instance(name: str, create_example_cfg: bool) -> None:
-    kl_im = InstanceManager(Klipper)
-    new_instance = Klipper(suffix=name)
-    kl_im.current_instance = new_instance
-    kl_im.create_instance()
-    kl_im.enable_instance()
-    if create_example_cfg:
-        # if a client-config is installed, include it in the new example cfg
-        clients = get_existing_clients()
-        create_example_printer_cfg(new_instance, clients)
-    kl_im.start_instance()
 
 
 def use_custom_names_or_go_back() -> bool | None:
     print_select_custom_name_dialog()
-    return get_confirm(
+    _input: bool | None = get_confirm(
         "Assign custom names?",
         False,
         allow_go_back=True,
     )
+    return _input
 
 
 def display_moonraker_info(moonraker_list: List[Moonraker]) -> bool:
@@ -230,12 +229,11 @@ def display_moonraker_info(moonraker_list: List[Moonraker]) -> bool:
         DialogType.INFO,
         [
             "Existing Moonraker instances detected:",
-            *[f"● {m.get_service_file_name()}" for m in moonraker_list],
+            *[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],
         ],
-        padding_top=0,
-        padding_bottom=0,
     )
-    return get_confirm("Proceed with installation?")
+    _input: bool = get_confirm("Proceed with installation?")
+    return _input

kiauh/components/klipper/klipper_utils.py

@@ -30,26 +30,28 @@ from components.webui_client.client_config.client_config_setup import (
     create_client_config_symlink,
 )
 from core.backup_manager.backup_manager import BackupManager
-from core.instance_manager.instance_manager import InstanceManager
+from core.constants import CURRENT_USER
+from core.instance_manager.base_instance import SUFFIX_BLACKLIST
+from core.logger import DialogType, Logger
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
+from core.types import ComponentStatus
 from utils.common import get_install_status
-from utils.constants import CURRENT_USER
 from utils.input_utils import get_confirm, get_number_input, get_string_input
-from utils.logger import DialogType, Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import cmd_sysctl_service
-from utils.types import ComponentStatus
 
 
 def get_klipper_status() -> ComponentStatus:
     return get_install_status(KLIPPER_DIR, KLIPPER_ENV_DIR, Klipper)
 
 
-def add_to_existing() -> bool:
+def add_to_existing() -> bool | None:
-    kl_instances = InstanceManager(Klipper).instances
+    kl_instances: List[Klipper] = get_instances(Klipper)
     print_instance_overview(kl_instances)
-    return get_confirm("Add new instances?", allow_go_back=True)
+    _input: bool | None = get_confirm("Add new instances?", allow_go_back=True)
+    return _input
 
 
 def get_install_count() -> int | None:
@@ -59,19 +61,20 @@ def get_install_count() -> int | None:
     user selected to go back, otherwise an integer greater or equal than 1 |
     :return: Integer >= 1 or None
     """
-    kl_instances = InstanceManager(Klipper).instances
+    kl_instances = get_instances(Klipper)
     print_select_instance_count_dialog()
     question = (
         f"Number of"
         f"{' additional' if len(kl_instances) > 0 else ''} "
         f"Klipper instances to set up"
     )
-    return get_number_input(question, 1, default=1, allow_go_back=True)
+    _input: int | None = get_number_input(question, 1, default=1, allow_go_back=True)
+    return _input
 
 
 def assign_custom_name(key: int, name_dict: Dict[int, str]) -> None:
     existing_names = []
-    existing_names.extend(Klipper.blacklist())
+    existing_names.extend(SUFFIX_BLACKLIST)
     existing_names.extend(name_dict[n] for n in name_dict)
     pattern = r"^[a-zA-Z0-9]+$"
 
@@ -79,7 +82,7 @@ def assign_custom_name(key: int, name_dict: Dict[int, str]) -> None:
     name_dict[key] = get_string_input(question, exclude=existing_names, regex=pattern)
 
 
-def check_user_groups():
+def check_user_groups() -> None:
     user_groups = [grp.getgrgid(gid).gr_name for gid in os.getgroups()]
     missing_groups = [g for g in ["tty", "dialout"] if g not in user_groups]
 
@@ -100,7 +103,6 @@ def check_user_groups():
             "INFO:",
             "Relog required for group assignments to take effect!",
         ],
-        padding_bottom=0,
     )
 
     if not get_confirm(f"Add user '{CURRENT_USER}' to group(s) now?"):
@@ -158,7 +160,7 @@ def handle_disruptive_system_packages() -> None:
 def create_example_printer_cfg(
     instance: Klipper, clients: List[BaseWebClient] | None = None
 ) -> None:
-    Logger.print_status(f"Creating example printer.cfg in '{instance.cfg_dir}'")
+    Logger.print_status(f"Creating example printer.cfg in '{instance.base.cfg_dir}'")
     if instance.cfg_file.is_file():
         Logger.print_info(f"'{instance.cfg_file}' already exists.")
         return
@@ -173,7 +175,7 @@ def create_example_printer_cfg(
 
     scp = SimpleConfigParser()
     scp.read(target)
-    scp.set("virtual_sdcard", "path", str(instance.gcodes_dir))
+    scp.set("virtual_sdcard", "path", str(instance.base.gcodes_dir))
 
     # include existing client configs in the example config
     if clients is not None and len(clients) > 0:
@@ -185,7 +187,7 @@ def create_example_printer_cfg(
 
     scp.write(target)
 
-    Logger.print_ok(f"Example printer.cfg created in '{instance.cfg_dir}'")
+    Logger.print_ok(f"Example printer.cfg created in '{instance.base.cfg_dir}'")
 
 
 def backup_klipper_dir() -> None:

kiauh/components/klipper/menus/klipper_remove_menu.py

@@ -6,41 +6,40 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
-from typing import Optional, Type
+from typing import Type
 
 from components.klipper import klipper_remove
+from core.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
 from core.menus import FooterType, Option
 from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
 
 
 # noinspection PyUnusedLocal
 class KlipperRemoveMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
         self.footer_type = FooterType.BACK
         self.remove_klipper_service = False
         self.remove_klipper_dir = False
         self.remove_klipper_env = False
         self.selection_state = False
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.remove_menu import RemoveMenu
 
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = previous_menu if previous_menu is not None else RemoveMenu
-            previous_menu if previous_menu is not None else RemoveMenu
-        )
 
     def set_options(self) -> None:
         self.options = {
-            "a": Option(method=self.toggle_all, menu=False),
+            "a": Option(method=self.toggle_all),
-            "1": Option(method=self.toggle_remove_klipper_service, menu=False),
+            "1": Option(method=self.toggle_remove_klipper_service),
-            "2": Option(method=self.toggle_remove_klipper_dir, menu=False),
+            "2": Option(method=self.toggle_remove_klipper_dir),
-            "3": Option(method=self.toggle_remove_klipper_env, menu=False),
+            "3": Option(method=self.toggle_remove_klipper_env),
-            "c": Option(method=self.run_removal_process, menu=False),
+            "c": Option(method=self.run_removal_process),
         }
 
     def print_menu(self) -> None:
@@ -73,10 +72,10 @@ class KlipperRemoveMenu(BaseMenu):
         print(menu, end="")
 
     def toggle_all(self, **kwargs) -> None:
-        self.remove_klipper_service = not self.remove_klipper_service
-        self.remove_klipper_dir = not self.remove_klipper_dir
-        self.remove_klipper_env = not self.remove_klipper_env
         self.selection_state = not self.selection_state
+        self.remove_klipper_service = self.selection_state
+        self.remove_klipper_dir = self.selection_state
+        self.remove_klipper_env = self.selection_state
 
     def toggle_remove_klipper_service(self, **kwargs) -> None:
         self.remove_klipper_service = not self.remove_klipper_service

kiauh/components/klipper_firmware/firmware_utils.py

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

kiauh/components/klipper_firmware/flash_options.py

@@ -45,7 +45,7 @@ class FlashOptions:
         return cls._instance
 
     @classmethod
-    def destroy(cls):
+    def destroy(cls) -> None:
         cls._instance = None
 
     @property

kiauh/components/klipper_firmware/menus/klipper_build_menu.py

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

kiauh/components/klipper_firmware/menus/klipper_flash_error_menu.py

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

kiauh/components/klipper_firmware/menus/klipper_flash_help_menu.py

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

kiauh/components/klipper_firmware/menus/klipper_flash_menu.py

@@ -6,10 +6,11 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
 import time
-from typing import Optional, Type
+from typing import Type
 
 from components.klipper_firmware.firmware_utils import (
     find_firmware_file,
@@ -34,34 +35,34 @@ from components.klipper_firmware.menus.klipper_flash_help_menu import (
     KlipperFlashMethodHelpMenu,
     KlipperMcuConnectionHelpMenu,
 )
+from core.constants import COLOR_CYAN, COLOR_RED, COLOR_YELLOW, RESET_FORMAT
+from core.logger import DialogType, Logger
 from core.menus import FooterType, Option
 from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_CYAN, COLOR_RED, COLOR_YELLOW, RESET_FORMAT
 from utils.input_utils import get_number_input
-from utils.logger import DialogType, Logger
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class KlipperFlashMethodMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
         self.help_menu = KlipperFlashMethodHelpMenu
         self.input_label_txt = "Select flash method"
         self.footer_type = FooterType.BACK_HELP
         self.flash_options = FlashOptions()
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.advanced_menu import AdvancedMenu
 
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = (
             previous_menu if previous_menu is not None else AdvancedMenu
         )
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(self.select_regular, menu=False),
+            "1": Option(self.select_regular),
-            "2": Option(self.select_sdcard, menu=False),
+            "2": Option(self.select_sdcard),
         }
 
     def print_menu(self) -> None:
@@ -108,24 +109,24 @@ class KlipperFlashMethodMenu(BaseMenu):
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class KlipperFlashCommandMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
         self.help_menu = KlipperFlashCommandHelpMenu
         self.input_label_txt = "Select flash command"
         self.footer_type = FooterType.BACK_HELP
         self.flash_options = FlashOptions()
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = (
             previous_menu if previous_menu is not None else KlipperFlashMethodMenu
         )
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(self.select_flash, menu=False),
+            "1": Option(self.select_flash),
-            "2": Option(self.select_serialflash, menu=False),
+            "2": Option(self.select_serialflash),
         }
-        self.default_option = Option(self.select_flash, menu=False)
+        self.default_option = Option(self.select_flash)
 
     def print_menu(self) -> None:
         menu = textwrap.dedent(
@@ -156,26 +157,26 @@ class KlipperFlashCommandMenu(BaseMenu):
 # noinspection PyMethodMayBeStatic
 class KlipperSelectMcuConnectionMenu(BaseMenu):
     def __init__(
-        self, previous_menu: Optional[Type[BaseMenu]] = None, standalone: bool = False
+        self, previous_menu: Type[BaseMenu] | None = None, standalone: bool = False
     ):
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
         self.__standalone = standalone
         self.help_menu = KlipperMcuConnectionHelpMenu
         self.input_label_txt = "Select connection type"
         self.footer_type = FooterType.BACK_HELP
         self.flash_options = FlashOptions()
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = (
             previous_menu if previous_menu is not None else KlipperFlashCommandMenu
         )
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(method=self.select_usb, menu=False),
+            "1": Option(method=self.select_usb),
-            "2": Option(method=self.select_dfu, menu=False),
+            "2": Option(method=self.select_dfu),
-            "3": Option(method=self.select_usb_dfu, menu=False),
+            "3": Option(method=self.select_usb_dfu),
         }
 
     def print_menu(self) -> None:
@@ -243,15 +244,15 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class KlipperSelectMcuIdMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
         self.flash_options = FlashOptions()
         self.mcu_list = self.flash_options.mcu_list
         self.input_label_txt = "Select MCU to flash"
         self.footer_type = FooterType.BACK_HELP
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = (
             previous_menu
             if previous_menu is not None
             else KlipperSelectMcuConnectionMenu
@@ -259,8 +260,7 @@ class KlipperSelectMcuIdMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            f"{i}": Option(self.flash_mcu, False, f"{i}")
+            f"{i}": Option(self.flash_mcu, f"{i}") for i in range(len(self.mcu_list))
-            for i in range(len(self.mcu_list))
         }
 
     def print_menu(self) -> None:
@@ -288,33 +288,41 @@ class KlipperSelectMcuIdMenu(BaseMenu):
         print(menu, end="\n")
 
     def flash_mcu(self, **kwargs):
-        index = int(kwargs.get("opt_index"))
+        try:
-        selected_mcu = self.mcu_list[index]
+            index: int | None = kwargs.get("opt_index", None)
-        self.flash_options.selected_mcu = selected_mcu
+            if index is None:
+                raise Exception("opt_index is None")
 
-        if self.flash_options.flash_method == FlashMethod.SD_CARD:
+            index = int(index)
-            KlipperSelectSDFlashBoardMenu(previous_menu=self.__class__).run()
+            selected_mcu = self.mcu_list[index]
-        elif self.flash_options.flash_method == FlashMethod.REGULAR:
+            self.flash_options.selected_mcu = selected_mcu
-            KlipperFlashOverviewMenu(previous_menu=self.__class__).run()
+
+            if self.flash_options.flash_method == FlashMethod.SD_CARD:
+                KlipperSelectSDFlashBoardMenu(previous_menu=self.__class__).run()
+            elif self.flash_options.flash_method == FlashMethod.REGULAR:
+                KlipperFlashOverviewMenu(previous_menu=self.__class__).run()
+        except Exception as e:
+            Logger.print_error(e)
+            Logger.print_error("Flashing failed!")
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class KlipperSelectSDFlashBoardMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
         self.flash_options = FlashOptions()
         self.available_boards = get_sd_flash_board_list()
         self.input_label_txt = "Select board type"
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = (
             previous_menu if previous_menu is not None else KlipperSelectMcuIdMenu
         )
 
     def set_options(self) -> None:
         self.options = {
-            f"{i}": Option(self.board_select, False, f"{i}")
+            f"{i}": Option(self.board_select, f"{i}")
             for i in range(len(self.available_boards))
         }
 
@@ -340,9 +348,17 @@ class KlipperSelectSDFlashBoardMenu(BaseMenu):
             print(menu, end="")
 
     def board_select(self, **kwargs):
-        board = int(kwargs.get("opt_index"))
+        try:
-        self.flash_options.selected_board = self.available_boards[board]
+            index: int | None = kwargs.get("opt_index", None)
-        self.baudrate_select()
+            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(
@@ -366,21 +382,21 @@ class KlipperSelectSDFlashBoardMenu(BaseMenu):
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class KlipperFlashOverviewMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
         self.flash_options = FlashOptions()
         self.input_label_txt = "Perform action (default=Y)"
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        self.previous_menu: Type[BaseMenu] = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
 
     def set_options(self) -> None:
         self.options = {
-            "Y": Option(self.execute_flash, menu=False),
+            "Y": Option(self.execute_flash),
-            "N": Option(self.abort_process, menu=False),
+            "N": Option(self.abort_process),
         }
 
-        self.default_option = Option(self.execute_flash, menu=False)
+        self.default_option = Option(self.execute_flash)
 
     def print_menu(self) -> None:
         header = "!!! ATTENTION !!!"

kiauh/components/klipperscreen/__init__.py

@@ -9,7 +9,7 @@
 from pathlib import Path
 
 from core.backup_manager import BACKUP_ROOT_DIR
-from utils.constants import SYSTEMD
+from core.constants import SYSTEMD
 
 # repo
 KLIPPERSCREEN_REPO = "https://github.com/KlipperScreen/KlipperScreen.git"

kiauh/components/klipperscreen/klipperscreen.py

@@ -26,28 +26,29 @@ from components.klipperscreen import (
 )
 from components.moonraker.moonraker import Moonraker
 from core.backup_manager.backup_manager import BackupManager
+from core.constants import SYSTEMD
 from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
 from core.settings.kiauh_settings import KiauhSettings
+from core.types import ComponentStatus
 from utils.common import (
     check_install_dependencies,
     get_install_status,
 )
 from utils.config_utils import add_config_section, remove_config_section
-from utils.constants import SYSTEMD
 from utils.fs_utils import remove_with_sudo
 from utils.git_utils import (
     git_clone_wrapper,
     git_pull_wrapper,
 )
 from utils.input_utils import get_confirm
-from utils.logger import DialogType, Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
     check_python_version,
     cmd_sysctl_service,
     install_python_requirements,
-    remove_service_file,
+    remove_system_service,
 )
-from utils.types import ComponentStatus
 
 
 def install_klipperscreen() -> None:
@@ -56,8 +57,7 @@ def install_klipperscreen() -> None:
     if not check_python_version(3, 7):
         return
 
-    mr_im = InstanceManager(Moonraker)
+    mr_instances = get_instances(Moonraker)
-    mr_instances = mr_im.instances
     if not mr_instances:
         Logger.print_dialog(
             DialogType.WARNING,
@@ -68,8 +68,6 @@ def install_klipperscreen() -> None:
                 "KlipperScreens update manager configuration for Moonraker "
                 "will not be added to any moonraker.conf.",
             ],
-            padding_top=0,
-            padding_bottom=0,
         )
         if not get_confirm(
             "Continue KlipperScreen installation?",
@@ -78,8 +76,7 @@ def install_klipperscreen() -> None:
         ):
             return
 
-    package_list = ["git", "wget", "curl", "unzip", "dfu-util"]
+    check_install_dependencies()
-    check_install_dependencies(package_list)
 
     git_clone_wrapper(KLIPPERSCREEN_REPO, KLIPPERSCREEN_DIR)
 
@@ -87,7 +84,7 @@ def install_klipperscreen() -> None:
         run(KLIPPERSCREEN_INSTALL_SCRIPT.as_posix(), shell=True, check=True)
         if mr_instances:
             patch_klipperscreen_update_manager(mr_instances)
-            mr_im.restart_all_instance()
+            InstanceManager.restart_all(mr_instances)
         else:
             Logger.print_info(
                 "Moonraker is not installed! Cannot add "
@@ -167,10 +164,7 @@ def remove_klipperscreen() -> None:
             Logger.print_warn("KlipperScreen environment not found!")
 
         if KLIPPERSCREEN_SERVICE_FILE.exists():
-            remove_service_file(
+            remove_system_service(KLIPPERSCREEN_SERVICE_NAME)
-                KLIPPERSCREEN_SERVICE_NAME,
-                KLIPPERSCREEN_SERVICE_FILE,
-            )
 
         logfile = Path(f"/tmp/{KLIPPERSCREEN_LOG_NAME}")
         if logfile.exists():
@@ -178,17 +172,15 @@ def remove_klipperscreen() -> None:
             remove_with_sudo(logfile)
             Logger.print_ok("KlipperScreen log file successfully removed!")
 
-        kl_im = InstanceManager(Klipper)
+        kl_instances: List[Klipper] = get_instances(Klipper)
-        kl_instances: List[Klipper] = kl_im.instances
         for instance in kl_instances:
-            logfile = instance.log_dir.joinpath(KLIPPERSCREEN_LOG_NAME)
+            logfile = instance.base.log_dir.joinpath(KLIPPERSCREEN_LOG_NAME)
             if logfile.exists():
                 Logger.print_status(f"Removing {logfile} ...")
                 Path(logfile).unlink()
                 Logger.print_ok(f"{logfile} successfully removed!")
 
-        mr_im = InstanceManager(Moonraker)
+        mr_instances: List[Moonraker] = get_instances(Moonraker)
-        mr_instances: List[Moonraker] = mr_im.instances
         if mr_instances:
             Logger.print_status("Removing KlipperScreen from update manager ...")
             remove_config_section("update_manager KlipperScreen", mr_instances)

kiauh/components/log_uploads/log_upload_utils.py

@@ -13,13 +13,14 @@ from typing import List
 
 from components.klipper.klipper import Klipper
 from components.log_uploads import LogFile
-from core.instance_manager.instance_manager import InstanceManager
+from 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:

kiauh/components/log_uploads/menus/log_upload_menu.py

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

kiauh/components/mobileraker/__init__.py

@@ -9,7 +9,7 @@
 from pathlib import Path
 
 from core.backup_manager import BACKUP_ROOT_DIR
-from utils.constants import SYSTEMD
+from core.constants import SYSTEMD
 
 # repo
 MOBILERAKER_REPO = "https://github.com/Clon1998/mobileraker_companion.git"

kiauh/components/mobileraker/mobileraker.py

@@ -27,7 +27,9 @@ from components.mobileraker import (
 from components.moonraker.moonraker import Moonraker
 from core.backup_manager.backup_manager import BackupManager
 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.git_utils import (
@@ -35,14 +37,13 @@ from utils.git_utils import (
     git_pull_wrapper,
 )
 from utils.input_utils import get_confirm
-from utils.logger import DialogType, Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
     check_python_version,
     cmd_sysctl_service,
     install_python_requirements,
-    remove_service_file,
+    remove_system_service,
 )
-from utils.types import ComponentStatus
 
 
 def install_mobileraker() -> None:
@@ -51,8 +52,7 @@ def install_mobileraker() -> None:
     if not check_python_version(3, 7):
         return
 
-    mr_im = InstanceManager(Moonraker)
+    mr_instances = get_instances(Moonraker)
-    mr_instances = mr_im.instances
     if not mr_instances:
         Logger.print_dialog(
             DialogType.WARNING,
@@ -78,7 +78,7 @@ def install_mobileraker() -> None:
         run(MOBILERAKER_INSTALL_SCRIPT.as_posix(), shell=True, check=True)
         if mr_instances:
             patch_mobileraker_update_manager(mr_instances)
-            mr_im.restart_all_instance()
+            InstanceManager.restart_all(mr_instances)
         else:
             Logger.print_info(
                 "Moonraker is not installed! Cannot add Mobileraker's "
@@ -161,22 +161,17 @@ def remove_mobileraker() -> None:
             Logger.print_warn("Mobileraker's companion environment not found!")
 
         if MOBILERAKER_SERVICE_FILE.exists():
-            remove_service_file(
+            remove_system_service(MOBILERAKER_SERVICE_NAME)
-                MOBILERAKER_SERVICE_NAME,
-                MOBILERAKER_SERVICE_FILE,
-            )
 
-        kl_im = InstanceManager(Klipper)
+        kl_instances: List[Klipper] = get_instances(Klipper)
-        kl_instances: List[Klipper] = kl_im.instances
         for instance in kl_instances:
-            logfile = instance.log_dir.joinpath(MOBILERAKER_LOG_NAME)
+            logfile = instance.base.log_dir.joinpath(MOBILERAKER_LOG_NAME)
             if logfile.exists():
                 Logger.print_status(f"Removing {logfile} ...")
                 Path(logfile).unlink()
                 Logger.print_ok(f"{logfile} successfully removed!")
 
-        mr_im = InstanceManager(Moonraker)
+        mr_instances: List[Moonraker] = get_instances(Moonraker)
-        mr_instances: List[Moonraker] = mr_im.instances
         if mr_instances:
             Logger.print_status(
                 "Removing Mobileraker's companion from update manager ..."

kiauh/components/moonraker/menus/moonraker_remove_menu.py

@@ -6,42 +6,41 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
-from typing import Optional, Type
+from typing import Type
 
 from components.moonraker import moonraker_remove
+from core.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
 
 
 # noinspection PyUnusedLocal
 class MoonrakerRemoveMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
         self.remove_moonraker_service = False
         self.remove_moonraker_dir = False
         self.remove_moonraker_env = False
         self.remove_moonraker_polkit = False
         self.selection_state = False
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.remove_menu import RemoveMenu
 
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = previous_menu if previous_menu is not None else RemoveMenu
-            previous_menu if previous_menu is not None else RemoveMenu
-        )
 
     def set_options(self) -> None:
         self.options = {
-            "a": Option(method=self.toggle_all, menu=False),
+            "a": Option(method=self.toggle_all),
-            "1": Option(method=self.toggle_remove_moonraker_service, menu=False),
+            "1": Option(method=self.toggle_remove_moonraker_service),
-            "2": Option(method=self.toggle_remove_moonraker_dir, menu=False),
+            "2": Option(method=self.toggle_remove_moonraker_dir),
-            "3": Option(method=self.toggle_remove_moonraker_env, menu=False),
+            "3": Option(method=self.toggle_remove_moonraker_env),
-            "4": Option(method=self.toggle_remove_moonraker_polkit, menu=False),
+            "4": Option(method=self.toggle_remove_moonraker_polkit),
-            "c": Option(method=self.run_removal_process, menu=False),
+            "c": Option(method=self.run_removal_process),
         }
 
     def print_menu(self) -> None:
@@ -76,11 +75,11 @@ class MoonrakerRemoveMenu(BaseMenu):
         print(menu, end="")
 
     def toggle_all(self, **kwargs) -> None:
-        self.remove_moonraker_service = not self.remove_moonraker_service
-        self.remove_moonraker_dir = not self.remove_moonraker_dir
-        self.remove_moonraker_env = not self.remove_moonraker_env
-        self.remove_moonraker_polkit = not self.remove_moonraker_polkit
         self.selection_state = not self.selection_state
+        self.remove_moonraker_service = self.selection_state
+        self.remove_moonraker_dir = self.selection_state
+        self.remove_moonraker_env = self.selection_state
+        self.remove_moonraker_polkit = self.selection_state
 
     def toggle_remove_moonraker_service(self, **kwargs) -> None:
         self.remove_moonraker_service = not self.remove_moonraker_service

kiauh/components/moonraker/moonraker.py

@@ -8,10 +8,11 @@
 # ======================================================================= #
 from __future__ import annotations
 
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from pathlib import Path
-from subprocess import CalledProcessError, run
+from subprocess import CalledProcessError
 
+from components.klipper.klipper import Klipper
 from components.moonraker import (
     MOONRAKER_CFG_NAME,
     MOONRAKER_DIR,
@@ -21,50 +22,58 @@ from components.moonraker import (
     MOONRAKER_LOG_NAME,
     MOONRAKER_SERVICE_TEMPLATE,
 )
+from core.constants import CURRENT_USER
 from core.instance_manager.base_instance import BaseInstance
+from core.logger import Logger
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
-from utils.logger import Logger
+from utils.fs_utils import create_folders
+from utils.sys_utils import get_service_file_path
 
 
 # noinspection PyMethodMayBeStatic
 @dataclass
-class Moonraker(BaseInstance):
+class Moonraker:
+    suffix: str
+    base: BaseInstance = field(init=False, repr=False)
+    service_file_path: Path = field(init=False)
+    log_file_name: str = MOONRAKER_LOG_NAME
     moonraker_dir: Path = MOONRAKER_DIR
     env_dir: Path = MOONRAKER_ENV_DIR
-    cfg_file: Path = None
+    data_dir: Path = field(init=False)
-    port: int = None
+    cfg_file: Path = field(init=False)
-    backup_dir: Path = None
+    backup_dir: Path = field(init=False)
-    certs_dir: Path = None
+    certs_dir: Path = field(init=False)
-    db_dir: Path = None
+    db_dir: Path = field(init=False)
-    log: Path = None
+    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.base.log_file_name = self.log_file_name
 
-    def __post_init__(self) -> None:
+        self.service_file_path: Path = get_service_file_path(Moonraker, self.suffix)
-        super().__post_init__()
+        self.data_dir: Path = self.base.data_dir
-        self.cfg_file = self.cfg_dir.joinpath(MOONRAKER_CFG_NAME)
+        self.cfg_file: Path = self.base.cfg_dir.joinpath(MOONRAKER_CFG_NAME)
-        self.port = self._get_port()
+        self.backup_dir: Path = self.base.data_dir.joinpath("backup")
-        self.backup_dir = self.data_dir.joinpath("backup")
+        self.certs_dir: Path = self.base.data_dir.joinpath("certs")
-        self.certs_dir = self.data_dir.joinpath("certs")
+        self.db_dir: Path = self.base.data_dir.joinpath("database")
-        self.db_dir = self.data_dir.joinpath("database")
+        self.port: int | None = self._get_port()
-        self.log = self.log_dir.joinpath(MOONRAKER_LOG_NAME)
 
-    def create(self, create_example_cfg: bool = False) -> None:
+    def create(self) -> None:
         from utils.sys_utils import create_env_file, create_service_file
 
         Logger.print_status("Creating new Moonraker Instance ...")
 
         try:
-            self.create_folders([self.backup_dir, self.certs_dir, self.db_dir])
+            create_folders(self.base.base_folders)
+
             create_service_file(
-                name=self.get_service_file_name(extension=True),
+                name=self.service_file_path.name,
                 content=self._prep_service_file_content(),
             )
             create_env_file(
-                path=self.sysd_dir.joinpath(MOONRAKER_ENV_FILE_NAME),
+                path=self.base.sysd_dir.joinpath(MOONRAKER_ENV_FILE_NAME),
                 content=self._prep_env_file_content(),
             )
 
@@ -75,21 +84,6 @@ class Moonraker(BaseInstance):
             Logger.print_error(f"Error creating env file: {e}")
             raise
 
-    def delete(self) -> None:
-        service_file = self.get_service_file_name(extension=True)
-        service_file_path = self.get_service_file_path()
-
-        Logger.print_status(f"Removing Moonraker Instance: {service_file}")
-
-        try:
-            command = ["sudo", "rm", "-f", service_file_path]
-            run(command, check=True)
-            self.delete_logfiles(MOONRAKER_LOG_NAME)
-            Logger.print_ok("Instance successfully removed!")
-        except CalledProcessError as e:
-            Logger.print_error(f"Error removing instance: {e}")
-            raise
-
     def _prep_service_file_content(self) -> str:
         template = MOONRAKER_SERVICE_TEMPLATE
 
@@ -102,7 +96,7 @@ class Moonraker(BaseInstance):
 
         service_content = template_content.replace(
             "%USER%",
-            self.user,
+            CURRENT_USER,
         )
         service_content = service_content.replace(
             "%MOONRAKER_DIR%",
@@ -114,7 +108,7 @@ class Moonraker(BaseInstance):
         )
         service_content = service_content.replace(
             "%ENV_FILE%",
-            self.sysd_dir.joinpath(MOONRAKER_ENV_FILE_NAME).as_posix(),
+            self.base.sysd_dir.joinpath(MOONRAKER_ENV_FILE_NAME).as_posix(),
         )
         return service_content
 
@@ -134,17 +128,17 @@ class Moonraker(BaseInstance):
         )
         env_file_content = env_file_content.replace(
             "%PRINTER_DATA%",
-            self.data_dir.as_posix(),
+            self.base.data_dir.as_posix(),
         )
 
         return env_file_content
 
     def _get_port(self) -> int | None:
-        if not self.cfg_file.is_file():
+        if not self.cfg_file or not self.cfg_file.is_file():
             return None
 
         scp = SimpleConfigParser()
         scp.read(self.cfg_file)
-        port = scp.getint("server", "port", fallback=None)
+        port: int | None = scp.getint("server", "port", fallback=None)
 
         return port

kiauh/components/moonraker/moonraker_dialogs.py

@@ -12,8 +12,8 @@ from typing import List
 
 from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
+from core.constants import COLOR_CYAN, COLOR_GREEN, COLOR_YELLOW, RESET_FORMAT
 from core.menus.base_menu import print_back_footer
-from utils.constants import COLOR_CYAN, COLOR_GREEN, COLOR_YELLOW, RESET_FORMAT
 
 
 def print_moonraker_overview(
@@ -37,8 +37,8 @@ def print_moonraker_overview(
         dialog += "║                                                       ║\n"
 
     instance_map = {
-        k.get_service_file_name(): (
+        k.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 ""
         )

kiauh/components/moonraker/moonraker_remove.py

@@ -6,18 +6,20 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 from subprocess import DEVNULL, PIPE, CalledProcessError, run
-from typing import List, Union
+from typing import List
 
 from components.klipper.klipper_dialogs import print_instance_overview
 from components.moonraker import MOONRAKER_DIR, MOONRAKER_ENV_DIR
 from components.moonraker.moonraker import Moonraker
 from core.instance_manager.instance_manager import InstanceManager
+from 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 cmd_sysctl_manage
+from utils.sys_utils import unit_file_exists
 
 
 def run_moonraker_removal(
@@ -26,17 +28,18 @@ def run_moonraker_removal(
     remove_env: bool,
     remove_polkit: 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
+    if delete_remaining and unit_file_exists("moonraker", suffix="service"):
         Logger.print_info("There are still other Moonraker services installed")
         Logger.print_info(
             "●  Moonraker PolicyKit rules were not removed.", prefix=False
@@ -57,7 +60,7 @@ def run_moonraker_removal(
 
 def select_instances_to_remove(
     instances: List[Moonraker],
-) -> Union[List[Moonraker], None]:
+) -> List[Moonraker] | None:
     start_index = 1
     options = [str(i + start_index) for i in range(len(instances))]
     options.extend(["a", "b"])
@@ -83,17 +86,14 @@ def select_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()
-        instance_manager.disable_instance()
-        instance_manager.delete_instance()
-
-    cmd_sysctl_manage("daemon-reload")
 
 
 def remove_polkit_rules() -> None:
@@ -114,7 +114,7 @@ def remove_polkit_rules() -> None:
 def delete_moonraker_logs(instances: List[Moonraker]) -> None:
     all_logfiles = []
     for instance in instances:
-        all_logfiles = list(instance.log_dir.glob("moonraker.log*"))
+        all_logfiles = list(instance.base.log_dir.glob("moonraker.log*"))
     if not all_logfiles:
         Logger.print_info("No Moonraker logs found. Skipped ...")
         return

kiauh/components/moonraker/moonraker_setup.py

@@ -38,6 +38,7 @@ from components.webui_client.client_utils import (
 )
 from components.webui_client.mainsail_data import MainsailData
 from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
 from core.settings.kiauh_settings import KiauhSettings
 from utils.common import check_install_dependencies
 from utils.fs_utils import check_file_exist
@@ -46,10 +47,11 @@ from utils.input_utils import (
     get_confirm,
     get_selection_input,
 )
-from utils.logger import Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
     check_python_version,
     cmd_sysctl_manage,
+    cmd_sysctl_service,
     create_python_venv,
     install_python_requirements,
     parse_packages_from_file,
@@ -57,18 +59,17 @@ from utils.sys_utils import (
 
 
 def install_moonraker() -> None:
-    if not check_moonraker_install_requirements():
+    klipper_list: List[Klipper] = get_instances(Klipper)
+
+    if not check_moonraker_install_requirements(klipper_list):
         return
 
-    klipper_list: List[Klipper] = InstanceManager(Klipper).instances
+    moonraker_list: List[Moonraker] = get_instances(Moonraker)
-    mr_im = InstanceManager(Moonraker)
+    instances: List[Moonraker] = []
-    moonraker_list: List[Moonraker] = mr_im.instances
-
-    instance_names = []
     selected_option: str | Klipper
 
-    if len(klipper_list) == 0:
+    if len(klipper_list) == 1:
-        instance_names.append(klipper_list[0].suffix)
+        instances.append(Moonraker(klipper_list[0].suffix))
     else:
         print_moonraker_overview(
             klipper_list,
@@ -87,9 +88,12 @@ def install_moonraker() -> None:
             return
 
         if selected_option == "a":
-            instance_names.extend([k.suffix for k in klipper_list])
+            instances.extend([Moonraker(k.suffix) for k in klipper_list])
         else:
-            instance_names.append(options.get(selected_option).suffix)
+            klipper_instance: Klipper | None = options.get(selected_option)
+            if klipper_instance is None:
+                raise Exception("Error selecting instance!")
+            instances.append(Moonraker(klipper_instance.suffix))
 
     create_example_cfg = get_confirm("Create example moonraker.conf?")
 
@@ -99,26 +103,23 @@ def install_moonraker() -> None:
         install_moonraker_polkit()
 
         used_ports_map = {m.suffix: m.port for m in moonraker_list}
-        for name in instance_names:
+        for instance in instances:
-            current_instance = Moonraker(suffix=name)
+            instance.create()
-
+            cmd_sysctl_service(instance.service_file_path.name, "enable")
-            mr_im.current_instance = current_instance
-            mr_im.create_instance()
-            mr_im.enable_instance()
 
             if create_example_cfg:
                 # if a webclient and/or it's config is installed, patch
                 # its update section to the config
                 clients = get_existing_clients()
-                create_example_moonraker_conf(current_instance, used_ports_map, clients)
+                create_example_moonraker_conf(instance, used_ports_map, clients)
 
-            mr_im.start_instance()
+            cmd_sysctl_service(instance.service_file_path.name, "start")
 
         cmd_sysctl_manage("daemon-reload")
 
         # if mainsail is installed, and we installed
         # multiple moonraker instances, we enable mainsails remote mode
-        if MainsailData().client_dir.exists() and len(mr_im.instances) > 1:
+        if MainsailData().client_dir.exists() and len(moonraker_list) > 1:
             enable_mainsail_remotemode()
 
     except Exception as e:
@@ -126,9 +127,9 @@ def install_moonraker() -> None:
         return
 
 
-def check_moonraker_install_requirements() -> bool:
+def check_moonraker_install_requirements(klipper_list: List[Klipper]) -> bool:
     def check_klipper_instances() -> bool:
-        if len(InstanceManager(Klipper).instances) >= 1:
+        if len(klipper_list) >= 1:
             return True
 
         Logger.print_warn("Klipper not installed!")
@@ -147,9 +148,9 @@ def setup_moonraker_prerequesites() -> None:
 
     # install moonraker dependencies and create python virtualenv
     install_moonraker_packages()
-    create_python_venv(MOONRAKER_ENV_DIR)
+    if create_python_venv(MOONRAKER_ENV_DIR):
-    install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
+        install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
-    install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_SPEEDUPS_REQ_FILE)
+        install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_SPEEDUPS_REQ_FILE)
 
 
 def install_moonraker_packages() -> None:
@@ -164,7 +165,7 @@ def install_moonraker_packages() -> None:
     if not moonraker_deps:
         raise ValueError("Error reading Moonraker dependencies!")
 
-    check_install_dependencies(moonraker_deps)
+    check_install_dependencies({*moonraker_deps})
 
 
 def install_moonraker_polkit() -> None:
@@ -205,8 +206,8 @@ def update_moonraker() -> None:
     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)
 
     git_pull_wrapper(repo=settings.moonraker.repo_url, target_dir=MOONRAKER_DIR)
 
@@ -215,4 +216,4 @@ def update_moonraker() -> None:
     # install possible new python dependencies
     install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
 
-    instance_manager.start_all_instance()
+    InstanceManager.start_all(instances)

kiauh/components/moonraker/moonraker_utils.py

@@ -21,16 +21,16 @@ from components.moonraker import (
 from components.moonraker.moonraker import Moonraker
 from components.webui_client.base_data import BaseWebClient
 from core.backup_manager.backup_manager import BackupManager
-from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
+from core.types import ComponentStatus
 from utils.common import get_install_status
-from utils.logger import Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
     get_ipv4_addr,
 )
-from utils.types import ComponentStatus
 
 
 def get_moonraker_status() -> ComponentStatus:
@@ -42,7 +42,7 @@ def create_example_moonraker_conf(
     ports_map: Dict[str, int],
     clients: Optional[List[BaseWebClient]] = None,
 ) -> None:
-    Logger.print_status(f"Creating example moonraker.conf in '{instance.cfg_dir}'")
+    Logger.print_status(f"Creating example moonraker.conf in '{instance.base.cfg_dir}'")
     if instance.cfg_file.is_file():
         Logger.print_info(f"'{instance.cfg_file}' already exists.")
         return
@@ -74,7 +74,7 @@ def create_example_moonraker_conf(
 
     ip = get_ipv4_addr().split(".")[:2]
     ip.extend(["0", "0/16"])
-    uds = instance.comms_dir.joinpath("klippy.sock")
+    uds = instance.base.comms_dir.joinpath("klippy.sock")
 
     scp = SimpleConfigParser()
     scp.read(target)
@@ -123,10 +123,10 @@ def create_example_moonraker_conf(
                     scp.set(c_config_section, option[0], option[1])
 
     scp.write(target)
-    Logger.print_ok(f"Example moonraker.conf created in '{instance.cfg_dir}'")
+    Logger.print_ok(f"Example moonraker.conf created in '{instance.base.cfg_dir}'")
 
 
-def backup_moonraker_dir():
+def backup_moonraker_dir() -> None:
     bm = BackupManager()
     bm.backup_directory("moonraker", source=MOONRAKER_DIR, target=MOONRAKER_BACKUP_DIR)
     bm.backup_directory(
@@ -135,12 +135,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/octoeverywhere/octoeverywhere.py

@@ -6,57 +6,59 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
+from dataclasses import dataclass, field
 from pathlib import Path
 from subprocess import CalledProcessError, run
-from typing import List
 
 from components.moonraker import MOONRAKER_CFG_NAME
+from components.moonraker.moonraker import Moonraker
 from components.octoeverywhere import (
     OE_CFG_NAME,
     OE_DIR,
     OE_ENV_DIR,
     OE_INSTALL_SCRIPT,
     OE_LOG_NAME,
-    OE_STORE_DIR,
     OE_SYS_CFG_NAME,
     OE_UPDATE_SCRIPT,
 )
 from core.instance_manager.base_instance import BaseInstance
-from utils.logger import Logger
+from core.logger import Logger
+from utils.sys_utils import get_service_file_path
 
 
-class Octoeverywhere(BaseInstance):
+@dataclass
-    @classmethod
+class Octoeverywhere:
-    def blacklist(cls) -> List[str]:
+    suffix: str
-        return ["None", "mcu", "bambu", "companion"]
+    base: BaseInstance = field(init=False, repr=False)
+    service_file_path: Path = field(init=False)
+    log_file_name = OE_LOG_NAME
+    dir: Path = OE_DIR
+    env_dir: Path = OE_ENV_DIR
+    data_dir: Path = field(init=False)
+    store_dir: Path = field(init=False)
+    cfg_file: Path = field(init=False)
+    sys_cfg_file: Path = field(init=False)
 
-    def __init__(self, suffix: str = ""):
+    def __post_init__(self):
-        super().__init__(instance_type=self, suffix=suffix)
+        self.base: BaseInstance = BaseInstance(Moonraker, self.suffix)
-        self.dir: Path = OE_DIR
+        self.base.log_file_name = self.log_file_name
-        self.env_dir: Path = OE_ENV_DIR
-        self.store_dir: Path = OE_STORE_DIR
-        self._cfg_file = self.cfg_dir.joinpath(OE_CFG_NAME)
-        self._sys_cfg_file = self.cfg_dir.joinpath(OE_SYS_CFG_NAME)
-        self._log = self.log_dir.joinpath(OE_LOG_NAME)
 
-    @property
+        self.service_file_path: Path = get_service_file_path(
-    def cfg_file(self) -> Path:
+            Octoeverywhere, self.suffix
-        return self._cfg_file
+        )
-
+        self.store_dir = self.base.data_dir.joinpath("store")
-    @property
+        self.cfg_file = self.base.cfg_dir.joinpath(OE_CFG_NAME)
-    def sys_cfg_file(self) -> Path:
+        self.sys_cfg_file = self.base.cfg_dir.joinpath(OE_SYS_CFG_NAME)
-        return self._sys_cfg_file
+        self.data_dir = self.base.data_dir
-
+        self.sys_cfg_file = self.base.cfg_dir.joinpath(OE_SYS_CFG_NAME)
-    @property
-    def log(self) -> Path:
-        return self._log
 
     def create(self) -> None:
         Logger.print_status("Creating OctoEverywhere for Klipper Instance ...")
 
         try:
-            cmd = f"{OE_INSTALL_SCRIPT} {self.cfg_dir}/{MOONRAKER_CFG_NAME}"
+            cmd = f"{OE_INSTALL_SCRIPT} {self.base.cfg_dir}/{MOONRAKER_CFG_NAME}"
             run(cmd, check=True, shell=True)
 
         except CalledProcessError as e:
@@ -64,27 +66,10 @@ class Octoeverywhere(BaseInstance):
             raise
 
     @staticmethod
-    def update():
+    def update() -> None:
         try:
             run(OE_UPDATE_SCRIPT.as_posix(), check=True, shell=True, cwd=OE_DIR)
 
         except CalledProcessError as e:
             Logger.print_error(f"Error updating OctoEverywhere for Klipper: {e}")
             raise
-
-    def delete(self) -> None:
-        service_file = self.get_service_file_name(extension=True)
-        service_file_path = self.get_service_file_path()
-
-        Logger.print_status(
-            f"Deleting OctoEverywhere for Klipper Instance: {service_file}"
-        )
-
-        try:
-            command = ["sudo", "rm", "-f", service_file_path]
-            run(command, check=True)
-            self.delete_logfiles(OE_LOG_NAME)
-            Logger.print_ok(f"Service file deleted: {service_file_path}")
-        except CalledProcessError as e:
-            Logger.print_error(f"Error deleting service file: {e}")
-            raise

kiauh/components/octoeverywhere/octoeverywhere_setup.py

@@ -22,6 +22,8 @@ from components.octoeverywhere import (
 )
 from components.octoeverywhere.octoeverywhere import Octoeverywhere
 from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
+from core.types import ComponentStatus
 from utils.common import (
     check_install_dependencies,
     get_install_status,
@@ -33,13 +35,11 @@ from utils.config_utils import (
 from utils.fs_utils import run_remove_routines
 from utils.git_utils import git_clone_wrapper
 from utils.input_utils import get_confirm
-from utils.logger import DialogType, Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
-    cmd_sysctl_manage,
     install_python_requirements,
     parse_packages_from_file,
 )
-from utils.types import ComponentStatus
 
 
 def get_octoeverywhere_status() -> ComponentStatus:
@@ -54,8 +54,7 @@ def install_octoeverywhere() -> None:
         return
 
     force_clone = False
-    oe_im = InstanceManager(Octoeverywhere)
+    oe_instances: List[Octoeverywhere] = get_instances(Octoeverywhere)
-    oe_instances: List[Octoeverywhere] = oe_im.instances
     if oe_instances:
         Logger.print_dialog(
             DialogType.INFO,
@@ -64,8 +63,6 @@ def install_octoeverywhere() -> None:
                 "It is safe to run the installer again to link your "
                 "printer or repair any issues.",
             ],
-            padding_top=0,
-            padding_bottom=0,
         )
         if not get_confirm("Re-run OctoEverywhere installation?"):
             Logger.print_info("Exiting OctoEverywhere for Klipper installation ...")
@@ -74,10 +71,9 @@ def install_octoeverywhere() -> None:
             Logger.print_status("Re-Installing OctoEverywhere for Klipper ...")
             force_clone = True
 
-    mr_im = InstanceManager(Moonraker)
+    mr_instances: List[Moonraker] = get_instances(Moonraker)
-    mr_instances: List[Moonraker] = mr_im.instances
 
-    mr_names = [f"● {moonraker.data_dir_name}" for moonraker in mr_instances]
+    mr_names = [f"● {moonraker.data_dir.name}" for moonraker in mr_instances]
     if len(mr_names) > 1:
         Logger.print_dialog(
             DialogType.INFO,
@@ -87,8 +83,6 @@ def install_octoeverywhere() -> None:
                 "\n\n",
                 "The setup will apply the same names to OctoEverywhere!",
             ],
-            padding_top=0,
-            padding_bottom=0,
         )
 
     if not get_confirm(
@@ -103,10 +97,10 @@ def install_octoeverywhere() -> None:
         git_clone_wrapper(OE_REPO, OE_DIR, force=force_clone)
 
         for moonraker in mr_instances:
-            oe_im.current_instance = Octoeverywhere(suffix=moonraker.suffix)
+            instance = Octoeverywhere(suffix=moonraker.suffix)
-            oe_im.create_instance()
+            instance.create()
 
-        mr_im.restart_all_instance()
+        InstanceManager.restart_all(mr_instances)
 
         Logger.print_dialog(
             DialogType.SUCCESS,
@@ -136,13 +130,12 @@ def update_octoeverywhere() -> None:
 
 def remove_octoeverywhere() -> None:
     Logger.print_status("Removing OctoEverywhere for Klipper ...")
-    mr_im = InstanceManager(Moonraker)
+
-    mr_instances: List[Moonraker] = mr_im.instances
+    mr_instances: List[Moonraker] = get_instances(Moonraker)
-    ob_im = InstanceManager(Octoeverywhere)
+    ob_instances: List[Octoeverywhere] = get_instances(Octoeverywhere)
-    ob_instances: List[Octoeverywhere] = ob_im.instances
 
     try:
-        remove_oe_instances(ob_im, ob_instances)
+        remove_oe_instances(ob_instances)
         remove_oe_dir()
         remove_oe_env()
         remove_config_section(f"include {OE_SYS_CFG_NAME}", mr_instances)
@@ -168,12 +161,11 @@ def install_oe_dependencies() -> None:
     if not oe_deps:
         raise ValueError("Error reading OctoEverywhere dependencies!")
 
-    check_install_dependencies(oe_deps)
+    check_install_dependencies({*oe_deps})
     install_python_requirements(OE_ENV_DIR, OE_REQ_FILE)
 
 
 def remove_oe_instances(
-    instance_manager: InstanceManager,
     instance_list: List[Octoeverywhere],
 ) -> None:
     if not instance_list:
@@ -181,13 +173,8 @@ def remove_oe_instances(
         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()
-        instance_manager.disable_instance()
-        instance_manager.delete_instance()
-
-    cmd_sysctl_manage("daemon-reload")
 
 
 def remove_oe_dir() -> None:

kiauh/components/webui_client/base_data.py

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

kiauh/components/webui_client/client_config/client_config_remove.py

@@ -13,10 +13,10 @@ from typing import List
 from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
 from components.webui_client.base_data import BaseWebClientConfig
-from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
 from utils.config_utils import remove_config_section
 from utils.fs_utils import run_remove_routines
-from utils.logger import Logger
+from utils.instance_utils import get_instances
 
 
 def run_client_config_removal(
@@ -36,7 +36,8 @@ def remove_client_config_dir(client_config: BaseWebClientConfig) -> None:
 
 
 def remove_client_config_symlink(client_config: BaseWebClientConfig) -> None:
-    im = InstanceManager(Klipper)
+    instances: List[Klipper] = get_instances(Klipper)
-    instances: List[Klipper] = im.instances
     for instance in instances:
-        run_remove_routines(instance.cfg_dir.joinpath(client_config.config_filename))
+        run_remove_routines(
+            instance.base.cfg_dir.joinpath(client_config.config_filename)
+        )

kiauh/components/webui_client/client_config/client_config_setup.py

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

kiauh/components/webui_client/client_dialogs.py

@@ -10,10 +10,10 @@
 from typing import List
 
 from components.webui_client.base_data import BaseWebClient
-from utils.logger import DialogType, Logger
+from core.logger import DialogType, Logger
 
 
-def print_moonraker_not_found_dialog():
+def print_moonraker_not_found_dialog() -> None:
     Logger.print_dialog(
         DialogType.WARNING,
         [
@@ -24,24 +24,22 @@ def print_moonraker_not_found_dialog():
             "another machine in your network. Otherwise Mainsail will NOT work "
             "correctly.",
         ],
-        padding_top=0,
-        padding_bottom=0,
     )
 
 
-def print_client_already_installed_dialog(name: str):
+def print_client_already_installed_dialog(name: str) -> None:
     Logger.print_dialog(
         DialogType.WARNING,
         [
             f"{name} seems to be already installed!",
             f"If you continue, your current {name} installation will be overwritten.",
         ],
-        padding_top=0,
-        padding_bottom=0,
     )
 
 
-def print_client_port_select_dialog(name: str, port: int, ports_in_use: List[int]):
+def print_client_port_select_dialog(
+    name: str, port: int, ports_in_use: List[int]
+) -> None:
     Logger.print_dialog(
         DialogType.CUSTOM,
         [
@@ -55,8 +53,6 @@ def print_client_port_select_dialog(name: str, port: int, ports_in_use: List[int
             "The following ports were found to be in use already:",
             *[f"● {port}" for port in ports_in_use],
         ],
-        padding_top=0,
-        padding_bottom=0,
     )
 
 
@@ -75,8 +71,6 @@ def print_install_client_config_dialog(client: BaseWebClient) -> None:
             "If you already use these macros skip this step. Otherwise you should "
             "consider to answer with 'Y' to download the recommended macros.",
         ],
-        padding_top=0,
-        padding_bottom=0,
     )
 
 

kiauh/components/webui_client/client_remove.py

@@ -6,49 +6,45 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
-
-
 from typing import List
 
 from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
 from components.webui_client.base_data import (
     BaseWebClient,
-    WebClientType,
 )
 from components.webui_client.client_config.client_config_remove import (
     run_client_config_removal,
 )
-from components.webui_client.client_utils import backup_mainsail_config_json
+from core.backup_manager.backup_manager import BackupManager
-from core.instance_manager.instance_manager import InstanceManager
+from core.constants import NGINX_SITES_AVAILABLE, NGINX_SITES_ENABLED
+from core.logger import Logger
 from utils.config_utils import remove_config_section
 from utils.fs_utils import (
-    remove_nginx_config,
+    remove_with_sudo,
-    remove_nginx_logs,
     run_remove_routines,
 )
-from utils.logger import Logger
+from utils.instance_utils import get_instances
 
 
 def run_client_removal(
     client: BaseWebClient,
     remove_client: bool,
     remove_client_cfg: bool,
-    backup_ms_config_json: bool,
+    backup_config: 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_ms_config_json and client.client == WebClientType.MAINSAIL:
+    if backup_config:
-        backup_mainsail_config_json()
+        bm = BackupManager()
+        bm.backup_file(client.config_file)
 
     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, kl_instances)
+        remove_client_nginx_logs(client, kl_instances)
 
         section = f"update_manager {client_name}"
         remove_config_section(section, mr_instances)
@@ -64,3 +60,26 @@ def run_client_removal(
 def remove_client_dir(client: BaseWebClient) -> None:
     Logger.print_status(f"Removing {client.display_name} ...")
     run_remove_routines(client.client_dir)
+
+
+def remove_client_nginx_config(name: str) -> None:
+    Logger.print_status(f"Removing NGINX config for {name.capitalize()} ...")
+
+    remove_with_sudo(NGINX_SITES_AVAILABLE.joinpath(name))
+    remove_with_sudo(NGINX_SITES_ENABLED.joinpath(name))
+
+
+def remove_client_nginx_logs(client: BaseWebClient, instances: List[Klipper]) -> None:
+    Logger.print_status(f"Removing NGINX logs for {client.display_name} ...")
+
+    remove_with_sudo(client.nginx_access_log)
+    remove_with_sudo(client.nginx_error_log)
+
+    if not instances:
+        return
+
+    for instance in instances:
+        run_remove_routines(
+            instance.base.log_dir.joinpath(client.nginx_access_log.name)
+        )
+        run_remove_routines(instance.base.log_dir.joinpath(client.nginx_error_log.name))

kiauh/components/webui_client/client_setup.py

@@ -6,7 +6,8 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
-
+import shutil
+import tempfile
 from pathlib import Path
 from typing import List
 
@@ -27,27 +28,24 @@ from components.webui_client.client_dialogs import (
     print_moonraker_not_found_dialog,
 )
 from components.webui_client.client_utils import (
-    backup_mainsail_config_json,
-    detect_client_cfg_conflict,
-    enable_mainsail_remotemode,
-    restore_mainsail_config_json,
-    symlink_webui_nginx_log,
-)
-from core.instance_manager.instance_manager import InstanceManager
-from core.settings.kiauh_settings import KiauhSettings
-from utils.common import check_install_dependencies
-from utils.config_utils import add_config_section
-from utils.fs_utils import (
     copy_common_vars_nginx_cfg,
     copy_upstream_nginx_cfg,
     create_nginx_cfg,
+    detect_client_cfg_conflict,
+    enable_mainsail_remotemode,
     get_next_free_port,
     is_valid_port,
     read_ports_from_nginx_configs,
-    unzip,
+    symlink_webui_nginx_log,
 )
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
+from core.settings.kiauh_settings import KiauhSettings
+from utils.common import check_install_dependencies
+from utils.config_utils import add_config_section
+from utils.fs_utils import unzip
 from utils.input_utils import get_confirm, get_number_input
-from utils.logger import Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
     cmd_sysctl_service,
     download_file,
@@ -65,8 +63,7 @@ def install_client(client: BaseWebClient) -> None:
         )
         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:
@@ -83,8 +80,7 @@ def install_client(client: BaseWebClient) -> None:
     ):
         enable_remotemode = True
 
-    kl_im = InstanceManager(Klipper)
+    kl_instances = get_instances(Klipper)
-    kl_instances = kl_im.instances
     install_client_cfg = False
     client_config: BaseWebClientConfig = client.client_config
     if (
@@ -112,7 +108,7 @@ def install_client(client: BaseWebClient) -> None:
         )
         valid_port = is_valid_port(port, ports_in_use)
 
-    check_install_dependencies(["nginx"])
+    check_install_dependencies({"nginx"})
 
     try:
         download_client(client)
@@ -129,7 +125,7 @@ def install_client(client: BaseWebClient) -> None:
                     ("path", str(client.client_dir)),
                 ],
             )
-            mr_im.restart_all_instance()
+            InstanceManager.restart_all(mr_instances)
         if install_client_cfg and kl_instances:
             install_client_config(client)
 
@@ -145,7 +141,7 @@ def install_client(client: BaseWebClient) -> None:
         )
 
         if kl_instances:
-            symlink_webui_nginx_log(kl_instances)
+            symlink_webui_nginx_log(client, kl_instances)
         cmd_sysctl_service("nginx", "restart")
 
     except Exception as e:
@@ -185,10 +181,10 @@ def update_client(client: BaseWebClient) -> None:
         )
         return
 
-    if client.client == WebClientType.MAINSAIL:
+    with tempfile.NamedTemporaryFile(suffix=".json") as tmp_file:
-        backup_mainsail_config_json(is_temp=True)
+        Logger.print_status(
-
+            f"Creating temporary backup of {client.config_file} as {tmp_file.name} ..."
-    download_client(client)
+        )
-
+        shutil.copy(client.config_file, tmp_file.name)
-    if client.client == WebClientType.MAINSAIL:
+        download_client(client)
-        restore_mainsail_config_json()
+        shutil.copy(tmp_file.name, client.config_file)

kiauh/components/webui_client/client_utils.py

@@ -9,11 +9,14 @@
 from __future__ import annotations
 
 import json
+import re
 import shutil
 from pathlib import Path
+from subprocess import PIPE, CalledProcessError, run
 from typing import List, get_args
 
 from components.klipper.klipper import Klipper
+from components.webui_client import MODULE_PATH
 from components.webui_client.base_data import (
     BaseWebClient,
     WebClientType,
@@ -21,16 +24,23 @@ from components.webui_client.base_data import (
 from components.webui_client.fluidd_data import FluiddData
 from components.webui_client.mainsail_data import MainsailData
 from core.backup_manager.backup_manager import BackupManager
+from core.constants import (
+    COLOR_CYAN,
+    COLOR_YELLOW,
+    NGINX_CONFD,
+    NGINX_SITES_AVAILABLE,
+    NGINX_SITES_ENABLED,
+    RESET_FORMAT,
+)
+from core.logger import Logger
 from core.settings.kiauh_settings import KiauhSettings
-from utils import NGINX_CONFD, NGINX_SITES_AVAILABLE
+from core.types import ComponentStatus
 from utils.common import get_install_status
-from utils.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
+from utils.fs_utils import create_symlink, remove_file
 from utils.git_utils import (
-    get_latest_tag,
+    get_latest_remote_tag,
     get_latest_unstable_tag,
 )
-from utils.logger import Logger
-from utils.types import ComponentStatus
 
 
 def get_client_status(
@@ -73,26 +83,6 @@ def get_current_client_config(clients: List[BaseWebClient]) -> str:
     return f"{COLOR_CYAN}-{RESET_FORMAT}"
 
 
-def backup_mainsail_config_json(is_temp=False) -> None:
-    c_json = MainsailData().client_dir.joinpath("config.json")
-    bm = BackupManager()
-    if is_temp:
-        fn = Path.home().joinpath("config.json.kiauh.bak")
-        bm.backup_file(c_json, custom_filename=fn)
-    else:
-        bm.backup_file(c_json)
-
-
-def restore_mainsail_config_json() -> None:
-    try:
-        c_json = MainsailData().client_dir.joinpath("config.json")
-        Logger.print_status(f"Restore '{c_json}' ...")
-        source = Path.home().joinpath("config.json.kiauh.bak")
-        shutil.copy(source, c_json)
-    except OSError:
-        Logger.print_info("Unable to restore config.json. Skipped ...")
-
-
 def enable_mainsail_remotemode() -> None:
     Logger.print_status("Enable Mainsails remote mode ...")
     c_json = MainsailData().client_dir.joinpath("config.json")
@@ -111,17 +101,19 @@ def enable_mainsail_remotemode() -> None:
     Logger.print_ok("Mainsails remote mode enabled!")
 
 
-def symlink_webui_nginx_log(klipper_instances: List[Klipper]) -> None:
+def symlink_webui_nginx_log(
+    client: BaseWebClient, klipper_instances: List[Klipper]
+) -> None:
     Logger.print_status("Link NGINX logs into log directory ...")
-    access_log = Path("/var/log/nginx/mainsail-access.log")
+    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)
 
@@ -137,7 +129,7 @@ def get_local_client_version(client: BaseWebClient) -> str | None:
 
     if relinfo_file.is_file():
         with open(relinfo_file, "r") as f:
-            return json.load(f)["version"]
+            return str(json.load(f)["version"])
     else:
         with open(version_file, "r") as f:
             return f.readlines()[0]
@@ -145,8 +137,8 @@ def get_local_client_version(client: BaseWebClient) -> str | None:
 
 def get_remote_client_version(client: BaseWebClient) -> str | None:
     try:
-        if (tag := get_latest_tag(client.repo_path)) != "":
+        if (tag := get_latest_remote_tag(client.repo_path)) != "":
-            return tag
+            return str(tag)
         return None
     except Exception:
         return None
@@ -162,9 +154,7 @@ def backup_client_data(client: BaseWebClient) -> None:
 
     bm = BackupManager()
     bm.backup_directory(f"{name}-{version}", src, dest)
-    if name == "mainsail":
+    bm.backup_file(client.config_file, dest)
-        c_json = MainsailData().client_dir.joinpath("config.json")
-        bm.backup_file(c_json, dest)
     bm.backup_file(NGINX_SITES_AVAILABLE.joinpath(name), dest)
 
 
@@ -222,3 +212,132 @@ def get_download_url(base_url: str, client: BaseWebClient) -> str:
         return f"{base_url}/download/{unstable_tag}/{client.name}.zip"
     except Exception:
         return stable_url
+
+
+#################################################
+## NGINX RELATED FUNCTIONS
+#################################################
+
+
+def copy_upstream_nginx_cfg() -> None:
+    """
+    Creates an upstream.conf in /etc/nginx/conf.d
+    :return: None
+    """
+    source = MODULE_PATH.joinpath("assets/upstreams.conf")
+    target = NGINX_CONFD.joinpath("upstreams.conf")
+    try:
+        command = ["sudo", "cp", source, target]
+        run(command, stderr=PIPE, check=True)
+    except CalledProcessError as e:
+        log = f"Unable to create upstreams.conf: {e.stderr.decode()}"
+        Logger.print_error(log)
+        raise
+
+
+def copy_common_vars_nginx_cfg() -> None:
+    """
+    Creates a common_vars.conf in /etc/nginx/conf.d
+    :return: None
+    """
+    source = MODULE_PATH.joinpath("assets/common_vars.conf")
+    target = NGINX_CONFD.joinpath("common_vars.conf")
+    try:
+        command = ["sudo", "cp", source, target]
+        run(command, stderr=PIPE, check=True)
+    except CalledProcessError as e:
+        log = f"Unable to create upstreams.conf: {e.stderr.decode()}"
+        Logger.print_error(log)
+        raise
+
+
+def generate_nginx_cfg_from_template(name: str, template_src: Path, **kwargs) -> None:
+    """
+    Creates an NGINX config from a template file and
+    replaces all placeholders passed as kwargs. A placeholder must be defined
+    in the template file as %{placeholder}%.
+    :param name: name of the config to create
+    :param template_src: the path to the template file
+    :return: None
+    """
+    tmp = Path.home().joinpath(f"{name}.tmp")
+    shutil.copy(template_src, tmp)
+    with open(tmp, "r+") as f:
+        content = f.read()
+
+        for key, value in kwargs.items():
+            content = content.replace(f"%{key}%", str(value))
+
+        f.seek(0)
+        f.write(content)
+        f.truncate()
+
+    target = NGINX_SITES_AVAILABLE.joinpath(name)
+    try:
+        command = ["sudo", "mv", tmp, target]
+        run(command, stderr=PIPE, check=True)
+    except CalledProcessError as e:
+        log = f"Unable to create '{target}': {e.stderr.decode()}"
+        Logger.print_error(log)
+        raise
+
+
+def create_nginx_cfg(
+    display_name: str,
+    cfg_name: str,
+    template_src: Path,
+    **kwargs,
+) -> None:
+    from utils.sys_utils import set_nginx_permissions
+
+    try:
+        Logger.print_status(f"Creating NGINX config for {display_name} ...")
+
+        source = NGINX_SITES_AVAILABLE.joinpath(cfg_name)
+        target = NGINX_SITES_ENABLED.joinpath(cfg_name)
+        remove_file(Path("/etc/nginx/sites-enabled/default"), True)
+        generate_nginx_cfg_from_template(cfg_name, template_src=template_src, **kwargs)
+        create_symlink(source, target, True)
+        set_nginx_permissions()
+
+        Logger.print_ok(f"NGINX config for {display_name} successfully created.")
+    except Exception:
+        Logger.print_error(f"Creating NGINX config for {display_name} failed!")
+        raise
+
+
+def read_ports_from_nginx_configs() -> List[int]:
+    """
+    Helper function to iterate over all NGINX configs and read all ports defined for listen
+    :return: A sorted list of listen ports
+    """
+    if not NGINX_SITES_ENABLED.exists():
+        return []
+
+    port_list = []
+    for config in NGINX_SITES_ENABLED.iterdir():
+        if not config.is_file():
+            continue
+
+        with open(config, "r") as cfg:
+            lines = cfg.readlines()
+
+        for line in lines:
+            line = line.replace("default_server", "")
+            line = re.sub(r"[;:\[\]]", "", line.strip())
+            if line.startswith("listen") and line.split()[-1] not in port_list:
+                port_list.append(line.split()[-1])
+
+    ports_to_ints_list = [int(port) for port in port_list]
+    return sorted(ports_to_ints_list, key=lambda x: int(x))
+
+
+def is_valid_port(port: int, ports_in_use: List[int]) -> bool:
+    return port not in ports_in_use
+
+
+def get_next_free_port(ports_in_use: List[int]) -> int:
+    valid_ports = set(range(80, 7125))
+    used_ports = set(map(int, ports_in_use))
+
+    return min(valid_ports - used_ports)

kiauh/components/webui_client/fluidd_data.py

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

kiauh/components/webui_client/mainsail_data.py

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

kiauh/components/webui_client/menus/client_remove_menu.py

@@ -6,46 +6,44 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
-from typing import Optional, Type
+from typing import Type
 
 from components.webui_client import client_remove
-from components.webui_client.base_data import BaseWebClient, WebClientType
+from components.webui_client.base_data import BaseWebClient
+from core.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
 
 
 # noinspection PyUnusedLocal
 class ClientRemoveMenu(BaseMenu):
     def __init__(
-        self, client: BaseWebClient, previous_menu: Optional[Type[BaseMenu]] = None
+        self, client: BaseWebClient, previous_menu: Type[BaseMenu] | None = None
     ):
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
-        self.client = client
+        self.client: BaseWebClient = client
-        self.remove_client = False
+        self.remove_client: bool = False
-        self.remove_client_cfg = False
+        self.remove_client_cfg: bool = False
-        self.backup_mainsail_config_json = False
+        self.backup_config_json: bool = False
-        self.selection_state = False
+        self.selection_state: bool = False
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.remove_menu import RemoveMenu
 
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = previous_menu if previous_menu is not None else RemoveMenu
-            previous_menu if previous_menu is not None else RemoveMenu
-        )
 
     def set_options(self) -> None:
         self.options = {
-            "a": Option(method=self.toggle_all, menu=False),
+            "a": Option(method=self.toggle_all),
-            "1": Option(method=self.toggle_rm_client, menu=False),
+            "1": Option(method=self.toggle_rm_client),
-            "2": Option(method=self.toggle_rm_client_config, menu=False),
+            "2": Option(method=self.toggle_rm_client_config),
-            "c": Option(method=self.run_removal_process, menu=False),
+            "3": Option(method=self.toggle_backup_config_json),
+            "c": Option(method=self.run_removal_process),
         }
-        if self.client.client == WebClientType.MAINSAIL:
-            self.options["3"] = Option(self.toggle_backup_mainsail_config_json, False)
 
     def print_menu(self) -> None:
         client_name = self.client.display_name
@@ -59,6 +57,7 @@ class ClientRemoveMenu(BaseMenu):
         unchecked = "[ ]"
         o1 = checked if self.remove_client else unchecked
         o2 = checked if self.remove_client_cfg else unchecked
+        o3 = checked if self.backup_config_json else unchecked
         menu = textwrap.dedent(
             f"""
             ╔═══════════════════════════════════════════════════════╗
@@ -71,19 +70,7 @@ class ClientRemoveMenu(BaseMenu):
             ╟───────────────────────────────────────────────────────╢
             ║  1) {o1} Remove {client_name:16}                       ║
             ║  2) {o2} Remove {client_config_name:24}               ║
-            """
+            ║  3) {o3} Backup config.json                            ║
-        )[1:]
-
-        if self.client.client == WebClientType.MAINSAIL:
-            o3 = checked if self.backup_mainsail_config_json else unchecked
-            menu += textwrap.dedent(
-                f"""
-                ║  3) {o3} Backup config.json                            ║
-                """
-            )[1:]
-
-        menu += textwrap.dedent(
-            """
             ╟───────────────────────────────────────────────────────╢
             ║  C) Continue                                          ║
             ╟───────────────────────────────────────────────────────╢
@@ -92,10 +79,10 @@ class ClientRemoveMenu(BaseMenu):
         print(menu, end="")
 
     def toggle_all(self, **kwargs) -> None:
-        self.remove_client = not self.remove_client
-        self.remove_client_cfg = not self.remove_client_cfg
-        self.backup_mainsail_config_json = not self.backup_mainsail_config_json
         self.selection_state = not self.selection_state
+        self.remove_client = self.selection_state
+        self.remove_client_cfg = self.selection_state
+        self.backup_config_json = self.selection_state
 
     def toggle_rm_client(self, **kwargs) -> None:
         self.remove_client = not self.remove_client
@@ -103,14 +90,14 @@ class ClientRemoveMenu(BaseMenu):
     def toggle_rm_client_config(self, **kwargs) -> None:
         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 run_removal_process(self, **kwargs) -> None:
         if (
             not self.remove_client
             and not self.remove_client_cfg
-            and not self.backup_mainsail_config_json
+            and not self.backup_config_json
         ):
             error = f"{COLOR_RED}Nothing selected ...{RESET_FORMAT}"
             print(error)
@@ -120,12 +107,12 @@ class ClientRemoveMenu(BaseMenu):
             client=self.client,
             remove_client=self.remove_client,
             remove_client_cfg=self.remove_client_cfg,
-            backup_ms_config_json=self.backup_mainsail_config_json,
+            backup_config=self.backup_config_json,
         )
 
         self.remove_client = False
         self.remove_client_cfg = False
-        self.backup_mainsail_config_json = False
+        self.backup_config_json = False
 
         self._go_back()
 

kiauh/core/backup_manager/backup_manager.py

@@ -6,22 +6,23 @@
 #                                                                         #
 #  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
 
 
 # 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:
@@ -39,7 +40,7 @@ class BackupManager:
     def ignore_folders(self, value: List[str]):
         self._ignore_folders = value
 
-    def backup_file(self, file: Path, target: Path = None, custom_filename=None):
+    def backup_file(self, file: Path, target: Path | None = None, custom_filename=None):
         Logger.print_status(f"Creating backup of {file} ...")
 
         if not file.exists():
@@ -62,7 +63,9 @@ class BackupManager:
         else:
             Logger.print_info(f"File '{file}' not found ...")
 
-    def backup_directory(self, name: str, source: Path, target: Path = None) -> None:
+    def backup_directory(
+        self, name: str, source: Path, target: Path | None = None
+    ) -> None:
         Logger.print_status(f"Creating backup of {name} in {target} ...")
 
         if source is None or not Path(source).exists():
@@ -83,9 +86,9 @@ class BackupManager:
             Logger.print_error(f"Unable to backup directory '{source}':\n{e}")
             return
 
-    def ignore_folders_func(self, dirpath, filenames):
+    def ignore_folders_func(self, dirpath, filenames) -> List[str]:
         return (
             [f for f in filenames if f in self._ignore_folders]
-            if self._ignore_folders is not None
+            if self._ignore_folders
             else []
         )

kiauh/core/constants.py

@@ -11,6 +11,8 @@ import os
 import pwd
 from pathlib import Path
 
+from core.backup_manager import BACKUP_ROOT_DIR
+
 # text colors and formats
 COLOR_WHITE = "\033[37m"  # white
 COLOR_MAGENTA = "\033[35m"  # magenta
@@ -19,6 +21,19 @@ COLOR_YELLOW = "\033[93m"  # bright yellow
 COLOR_RED = "\033[91m"  # bright red
 COLOR_CYAN = "\033[96m"  # bright cyan
 RESET_FORMAT = "\033[0m"  # reset format
+
+# global dependencies
+GLOBAL_DEPS = ["git", "wget", "curl", "unzip", "dfu-util", "python3-virtualenv"]
+
+# strings
+INVALID_CHOICE = "Invalid choice. Please select a valid value."
+
 # current user
 CURRENT_USER = pwd.getpwuid(os.getuid())[0]
+
+# dirs
 SYSTEMD = Path("/etc/systemd/system")
+PRINTER_CFG_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("printer-cfg-backups")
+NGINX_SITES_AVAILABLE = Path("/etc/nginx/sites-available")
+NGINX_SITES_ENABLED = Path("/etc/nginx/sites-enabled")
+NGINX_CONFD = Path("/etc/nginx/conf.d")

kiauh/core/decorators.py

@@ -6,12 +6,14 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
+
 import warnings
 from typing import Callable
 
 
-def deprecated(info: str = "", replaced_by: Callable = None) -> Callable:
+def deprecated(info: str = "", replaced_by: Callable | None = None) -> Callable:
-    def decorator(func):
+    def decorator(func) -> Callable:
         def wrapper(*args, **kwargs):
             msg = f"{info}{replaced_by.__name__ if replaced_by else ''}"
             warnings.warn(msg, category=DeprecationWarning, stacklevel=2)

kiauh/core/instance_manager/base_instance.py

@@ -10,112 +10,49 @@
 from __future__ import annotations
 
 import re
-from abc import ABC, abstractmethod
 from dataclasses import dataclass, field
 from pathlib import Path
-from typing import List, Optional
+from typing import List
 
-from utils.constants import CURRENT_USER, SYSTEMD
+from utils.fs_utils import get_data_dir
-from utils.logger import Logger
+
+SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion"]
 
 
-@dataclass
+@dataclass(repr=True)
-class BaseInstance(ABC):
+class BaseInstance:
-    instance_type: BaseInstance
+    instance_type: type
     suffix: str
-    user: str = field(default=CURRENT_USER, init=False)
+    log_file_name: str | None = None
-    data_dir: Path = None
+    data_dir: Path = field(init=False)
-    data_dir_name: str = ""
+    base_folders: List[Path] = field(init=False)
-    is_legacy_instance: bool = False
+    cfg_dir: Path = field(init=False)
-    cfg_dir: Path = None
+    log_dir: Path = field(init=False)
-    log_dir: Path = None
+    gcodes_dir: Path = field(init=False)
-    comms_dir: Path = None
+    comms_dir: Path = field(init=False)
-    sysd_dir: Path = None
+    sysd_dir: Path = field(init=False)
-    gcodes_dir: Path = None
+    is_legacy_instance: bool = field(init=False)
 
-    def __post_init__(self) -> None:
+    def __post_init__(self):
-        self._set_data_dir()
+        self.data_dir = get_data_dir(self.instance_type, self.suffix)
-        self._set_is_legacy_instance()
+        # the following attributes require the data_dir to be set
         self.cfg_dir = self.data_dir.joinpath("config")
         self.log_dir = self.data_dir.joinpath("logs")
+        self.gcodes_dir = self.data_dir.joinpath("gcodes")
         self.comms_dir = self.data_dir.joinpath("comms")
         self.sysd_dir = self.data_dir.joinpath("systemd")
-        self.gcodes_dir = self.data_dir.joinpath("gcodes")
+        self.is_legacy_instance = self._set_is_legacy_instance()
-
+        self.base_folders = [
-    @classmethod
-    def blacklist(cls) -> List[str]:
-        return ["None", "mcu", "obico", "bambu", "companion"]
-
-    @abstractmethod
-    def create(self) -> None:
-        raise NotImplementedError("Subclasses must implement the create method")
-
-    @abstractmethod
-    def delete(self) -> None:
-        raise NotImplementedError("Subclasses must implement the delete method")
-
-    def create_folders(self, add_dirs: Optional[List[Path]] = None) -> None:
-        dirs = [
             self.data_dir,
             self.cfg_dir,
             self.log_dir,
+            self.gcodes_dir,
             self.comms_dir,
             self.sysd_dir,
-            self.gcodes_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)
-
-    # todo: refactor into a set method and access the value by accessing the property
-    def get_service_file_name(self, extension: bool = False) -> str:
-        from utils.common import convert_camelcase_to_kebabcase
-
-        name = convert_camelcase_to_kebabcase(self.__class__.__name__)
-        if self.suffix != "":
-            name += f"-{self.suffix}"
-
-        return name if not extension else f"{name}.service"
-
-    # todo: refactor into a set method and access the value by accessing the property
-    def get_service_file_path(self) -> Path:
-        return SYSTEMD.joinpath(self.get_service_file_name(extension=True))
-
-    def delete_logfiles(self, log_name: str) -> None:
-        from utils.fs_utils import run_remove_routines
-
-        if not self.log_dir.exists():
-            return
-
-        files = self.log_dir.iterdir()
-        logs = [f for f in files if f.name.startswith(log_name)]
-        for log in logs:
-            Logger.print_status(f"Remove '{log}'")
-            run_remove_routines(log)
-
-    def _set_data_dir(self) -> None:
-        if self.suffix == "":
-            self.data_dir = Path.home().joinpath("printer_data")
-        else:
-            self.data_dir = Path.home().joinpath(f"printer_{self.suffix}_data")
-
-        if self.get_service_file_path().exists():
-            with open(self.get_service_file_path(), "r") as service_file:
-                service_content = service_file.read()
-                pattern = re.compile("^EnvironmentFile=(.+)(/systemd/.+\.env)")
-                match = re.search(pattern, service_content)
-                if match:
-                    self.data_dir = Path(match.group(1))
-
-    def _set_is_legacy_instance(self) -> None:
-        if (
-            self.suffix != ""
-            and not self.data_dir_name.startswith("printer_")
-            and not self.data_dir_name.endswith("_data")
-        ):
-            self.is_legacy_instance = True
-        else:
-            self.is_legacy_instance = False

kiauh/core/instance_manager/instance_manager.py

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

kiauh/core/instance_manager/name_scheme.py

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

kiauh/core/instance_type.py

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

kiauh/core/logger.py

@@ -6,11 +6,13 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
+
 import textwrap
 from enum import Enum
 from typing import List
 
-from utils.constants import (
+from core.constants import (
     COLOR_CYAN,
     COLOR_GREEN,
     COLOR_MAGENTA,
@@ -44,17 +46,17 @@ LINE_WIDTH = 53
 
 class Logger:
     @staticmethod
-    def info(msg):
+    def info(msg) -> None:
         # log to kiauh.log
         pass
 
     @staticmethod
-    def warn(msg):
+    def warn(msg) -> None:
         # log to kiauh.log
         pass
 
     @staticmethod
-    def error(msg):
+    def error(msg) -> None:
         # log to kiauh.log
         pass
 
@@ -64,7 +66,7 @@ class Logger:
         print(f"{COLOR_WHITE}{start}{message}{RESET_FORMAT}", end=end)
 
     @staticmethod
-    def print_ok(msg, prefix=True, start="", end="\n") -> None:
+    def print_ok(msg: str = "Success!", prefix=True, start="", end="\n") -> None:
         message = f"[OK] {msg}" if prefix else msg
         print(f"{COLOR_GREEN}{start}{message}{RESET_FORMAT}", end=end)
 
@@ -88,10 +90,10 @@ class Logger:
         title: DialogType,
         content: List[str],
         center_content: bool = False,
-        custom_title: str = None,
+        custom_title: str | None = None,
-        custom_color: DialogCustomColor = None,
+        custom_color: DialogCustomColor | None = None,
-        padding_top: int = 1,
+        margin_top: int = 0,
-        padding_bottom: int = 1,
+        margin_bottom: int = 0,
     ) -> None:
         """
         Prints a dialog with the given title and content.
@@ -104,8 +106,8 @@ class Logger:
         :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 padding_top: The number of empty lines to print before the dialog.
+        :param margin_top: The number of empty lines to print before the dialog.
-        :param padding_bottom: The number of empty lines to print after 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)
@@ -114,26 +116,31 @@ class Logger:
         top = Logger._format_top_border(dialog_color)
         bottom = Logger._format_bottom_border()
 
-        print("\n" * padding_top)
+        print("\n" * margin_top)
         print(
             f"{top}{dialog_title_formatted}{dialog_content}{bottom}",
             end="",
         )
-        print("\n" * padding_bottom)
+        print("\n" * margin_bottom)
 
     @staticmethod
-    def _get_dialog_title(title: DialogType, custom_title: str = None) -> str:
+    def _get_dialog_title(
+        title: DialogType, custom_title: str | None = None
+    ) -> str | None:
         if title == DialogType.CUSTOM and custom_title:
             return f"[ {custom_title} ]"
         return f"[ {title.value[0]} ]" if title.value[0] else None
 
     @staticmethod
     def _get_dialog_color(
-        title: DialogType, custom_color: DialogCustomColor = None
+        title: DialogType, custom_color: DialogCustomColor | None = None
     ) -> str:
         if title == DialogType.CUSTOM and custom_color:
             return str(custom_color.value)
-        return title.value[1] if title.value[1] else DialogCustomColor.WHITE.value
+
+        color: str = title.value[1] if title.value[1] else DialogCustomColor.WHITE.value
+
+        return color
 
     @staticmethod
     def _format_top_border(color: str) -> str:
@@ -146,7 +153,7 @@ class Logger:
         )
 
     @staticmethod
-    def _format_dialog_title(title: str) -> str:
+    def _format_dialog_title(title: str | None) -> str:
         if title is not None:
             return textwrap.dedent(f"""
                 ┃ {title:^{LINE_WIDTH}} ┃

kiauh/core/menus/__init__.py

@@ -6,10 +6,11 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 from dataclasses import dataclass
 from enum import Enum
-from typing import Any, Callable, Union
+from typing import Any, Callable, Type
 
 
 @dataclass
@@ -17,13 +18,11 @@ class Option:
     """
     Represents a menu option.
     :param method: Method that will be used to call the menu option
-    :param menu: Flag for singaling that another menu will be opened
     :param opt_index: Can be used to pass the user input to the menu option
     :param opt_data: Can be used to pass any additional data to the menu option
     """
 
-    method: Union[Callable, None] = None
+    method: Type[Callable] | None = None
-    menu: bool = False
     opt_index: str = ""
     opt_data: Any = None
 

kiauh/core/menus/advanced_menu.py

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

kiauh/core/menus/backup_menu.py

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

kiauh/core/menus/base_menu.py

@@ -14,24 +14,24 @@ import sys
 import textwrap
 import traceback
 from abc import abstractmethod
-from typing import Dict, Optional, Type
+from typing import Dict, Type
 
-from core.menus import FooterType, Option
+from core.constants import (
-from utils.constants import (
     COLOR_CYAN,
     COLOR_GREEN,
     COLOR_RED,
     COLOR_YELLOW,
     RESET_FORMAT,
 )
-from utils.logger import Logger
+from core.logger import Logger
+from core.menus import FooterType, Option
 
 
-def clear():
+def clear() -> None:
     subprocess.call("clear", shell=True)
 
 
-def print_header():
+def print_header() -> None:
     line1 = " [ KIAUH ] "
     line2 = "Klipper Installation And Update Helper"
     line3 = ""
@@ -49,7 +49,7 @@ def print_header():
     print(header, end="")
 
 
-def print_quit_footer():
+def print_quit_footer() -> None:
     text = "Q) Quit"
     color = COLOR_RED
     count = 62 - len(color) - len(RESET_FORMAT)
@@ -62,7 +62,7 @@ def print_quit_footer():
     print(footer, end="")
 
 
-def print_back_footer():
+def print_back_footer() -> None:
     text = "B) « Back"
     color = COLOR_GREEN
     count = 62 - len(color) - len(RESET_FORMAT)
@@ -75,7 +75,7 @@ def print_back_footer():
     print(footer, end="")
 
 
-def print_back_help_footer():
+def print_back_help_footer() -> None:
     text1 = "B) « Back"
     text2 = "H) Help [?]"
     color1 = COLOR_GREEN
@@ -90,7 +90,7 @@ def print_back_help_footer():
     print(footer, end="")
 
 
-def print_blank_footer():
+def print_blank_footer() -> None:
     print("╚═══════════════════════════════════════════════════════╝")
 
 
@@ -109,42 +109,46 @@ class BaseMenu(metaclass=PostInitCaller):
     default_option: Option = None
     input_label_txt: str = "Perform action"
     header: bool = False
-    previous_menu: Type[BaseMenu] = None
+    previous_menu: Type[BaseMenu] | None = None
-    help_menu: Type[BaseMenu] = None
+    help_menu: Type[BaseMenu] | None = None
     footer_type: FooterType = FooterType.BACK
 
-    def __init__(self, **kwargs):
+    def __init__(self, **kwargs) -> None:
         if type(self) is BaseMenu:
             raise NotImplementedError("BaseMenu cannot be instantiated directly.")
 
-    def __post_init__(self):
+    def __post_init__(self) -> None:
         self.set_previous_menu(self.previous_menu)
         self.set_options()
 
         # conditionally add options based on footer type
         if self.footer_type is FooterType.QUIT:
-            self.options["q"] = Option(method=self.__exit, menu=False)
+            self.options["q"] = Option(method=self.__exit)
         if self.footer_type is FooterType.BACK:
-            self.options["b"] = Option(method=self.__go_back, menu=False)
+            self.options["b"] = Option(method=self.__go_back)
         if self.footer_type is FooterType.BACK_HELP:
-            self.options["b"] = Option(method=self.__go_back, menu=False)
+            self.options["b"] = Option(method=self.__go_back)
-            self.options["h"] = Option(method=self.__go_to_help, menu=False)
+            self.options["h"] = Option(method=self.__go_to_help)
         # if defined, add the default option to the options dict
         if self.default_option is not None:
             self.options[""] = self.default_option
 
-    def __go_back(self, **kwargs):
+    def __go_back(self, **kwargs) -> None:
+        if self.previous_menu is None:
+            return
         self.previous_menu().run()
 
-    def __go_to_help(self, **kwargs):
+    def __go_to_help(self, **kwargs) -> None:
+        if self.help_menu is None:
+            return
         self.help_menu(previous_menu=self).run()
 
-    def __exit(self, **kwargs):
+    def __exit(self, **kwargs) -> None:
         Logger.print_ok("###### Happy printing!", False)
         sys.exit(0)
 
     @abstractmethod
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         raise NotImplementedError
 
     @abstractmethod
@@ -180,7 +184,10 @@ class BaseMenu(metaclass=PostInitCaller):
         :return: Option, str or None
         """
         usr_input = usr_input.lower()
-        option = self.options.get(usr_input, Option(None, False, "", None))
+        option = self.options.get(
+            usr_input,
+            Option(method=None, opt_index="", opt_data=None),
+        )
 
         # if option/usr_input is None/empty string, we execute the menus default option if specified
         if (option is None or usr_input == "") and self.default_option is not None:

kiauh/core/menus/install_menu.py

@@ -6,9 +6,10 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
-from typing import Optional, Type
+from typing import Type
 
 from components.crowsnest.crowsnest import install_crowsnest
 from components.klipper import klipper_setup
@@ -20,40 +21,38 @@ from components.webui_client import client_setup
 from components.webui_client.client_config import client_config_setup
 from components.webui_client.fluidd_data import FluiddData
 from components.webui_client.mainsail_data import MainsailData
+from core.constants import COLOR_GREEN, RESET_FORMAT
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_GREEN, RESET_FORMAT
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class InstallMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
 
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
-            previous_menu if previous_menu is not None else MainMenu
-        )
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(method=self.install_klipper, menu=False),
+            "1": Option(method=self.install_klipper),
-            "2": Option(method=self.install_moonraker, menu=False),
+            "2": Option(method=self.install_moonraker),
-            "3": Option(method=self.install_mainsail, menu=False),
+            "3": Option(method=self.install_mainsail),
-            "4": Option(method=self.install_fluidd, menu=False),
+            "4": Option(method=self.install_fluidd),
-            "5": Option(method=self.install_mainsail_config, menu=False),
+            "5": Option(method=self.install_mainsail_config),
-            "6": Option(method=self.install_fluidd_config, menu=False),
+            "6": Option(method=self.install_fluidd_config),
-            "7": Option(method=self.install_klipperscreen, menu=False),
+            "7": Option(method=self.install_klipperscreen),
-            "8": Option(method=self.install_mobileraker, menu=False),
+            "8": Option(method=self.install_mobileraker),
-            "9": Option(method=self.install_crowsnest, menu=False),
+            "9": Option(method=self.install_crowsnest),
-            "10": Option(method=self.install_octoeverywhere, menu=False),
+            "10": Option(method=self.install_octoeverywhere),
         }
 
-    def print_menu(self):
+    def print_menu(self) -> None:
         header = " [ Installation Menu ] "
         color = COLOR_GREEN
         count = 62 - len(color) - len(RESET_FORMAT)
@@ -79,32 +78,32 @@ class InstallMenu(BaseMenu):
         )[1:]
         print(menu, end="")
 
-    def install_klipper(self, **kwargs):
+    def install_klipper(self, **kwargs) -> None:
         klipper_setup.install_klipper()
 
-    def install_moonraker(self, **kwargs):
+    def install_moonraker(self, **kwargs) -> None:
         moonraker_setup.install_moonraker()
 
-    def install_mainsail(self, **kwargs):
+    def install_mainsail(self, **kwargs) -> None:
         client_setup.install_client(MainsailData())
 
-    def install_mainsail_config(self, **kwargs):
+    def install_mainsail_config(self, **kwargs) -> None:
         client_config_setup.install_client_config(MainsailData())
 
-    def install_fluidd(self, **kwargs):
+    def install_fluidd(self, **kwargs) -> None:
         client_setup.install_client(FluiddData())
 
-    def install_fluidd_config(self, **kwargs):
+    def install_fluidd_config(self, **kwargs) -> None:
         client_config_setup.install_client_config(FluiddData())
 
-    def install_klipperscreen(self, **kwargs):
+    def install_klipperscreen(self, **kwargs) -> None:
         install_klipperscreen()
 
-    def install_mobileraker(self, **kwargs):
+    def install_mobileraker(self, **kwargs) -> None:
         install_mobileraker()
 
-    def install_crowsnest(self, **kwargs):
+    def install_crowsnest(self, **kwargs) -> None:
         install_crowsnest()
 
-    def install_octoeverywhere(self, **kwargs):
+    def install_octoeverywhere(self, **kwargs) -> None:
         install_octoeverywhere()

kiauh/core/menus/main_menu.py

@@ -6,9 +6,11 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
+
 import sys
 import textwrap
-from typing import Optional, Type
+from typing import Callable, Type
 
 from components.crowsnest.crowsnest import get_crowsnest_status
 from components.klipper.klipper_utils import get_klipper_status
@@ -23,6 +25,15 @@ from components.webui_client.client_utils import (
 )
 from components.webui_client.fluidd_data import FluiddData
 from components.webui_client.mainsail_data import MainsailData
+from core.constants import (
+    COLOR_CYAN,
+    COLOR_GREEN,
+    COLOR_MAGENTA,
+    COLOR_RED,
+    COLOR_YELLOW,
+    RESET_FORMAT,
+)
+from core.logger import Logger
 from core.menus import FooterType
 from core.menus.advanced_menu import AdvancedMenu
 from core.menus.backup_menu import BackupMenu
@@ -31,47 +42,40 @@ from core.menus.install_menu import InstallMenu
 from core.menus.remove_menu import RemoveMenu
 from core.menus.settings_menu import SettingsMenu
 from core.menus.update_menu import UpdateMenu
+from core.types import ComponentStatus, StatusMap, StatusText
 from extensions.extensions_menu import ExtensionsMenu
-from utils.constants import (
+from utils.common import get_kiauh_version
-    COLOR_CYAN,
-    COLOR_GREEN,
-    COLOR_MAGENTA,
-    COLOR_RED,
-    COLOR_YELLOW,
-    RESET_FORMAT,
-)
-from utils.logger import Logger
-from utils.types import ComponentStatus, StatusMap, StatusText
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class MainMenu(BaseMenu):
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
 
-        self.header = True
+        self.header: bool = True
-        self.footer_type = FooterType.QUIT
+        self.footer_type: FooterType = FooterType.QUIT
 
+        self.version = ""
         self.kl_status = self.kl_repo = self.mr_status = self.mr_repo = ""
         self.ms_status = self.fl_status = self.ks_status = self.mb_status = ""
         self.cn_status = self.cc_status = self.oe_status = ""
         self._init_status()
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         """MainMenu does not have a previous menu"""
         pass
 
     def set_options(self) -> None:
         self.options = {
-            "0": Option(method=self.log_upload_menu, menu=True),
+            "0": Option(method=self.log_upload_menu),
-            "1": Option(method=self.install_menu, menu=True),
+            "1": Option(method=self.install_menu),
-            "2": Option(method=self.update_menu, menu=True),
+            "2": Option(method=self.update_menu),
-            "3": Option(method=self.remove_menu, menu=True),
+            "3": Option(method=self.remove_menu),
-            "4": Option(method=self.advanced_menu, menu=True),
+            "4": Option(method=self.advanced_menu),
-            "5": Option(method=self.backup_menu, menu=True),
+            "5": Option(method=self.backup_menu),
-            "e": Option(method=self.extension_menu, menu=True),
+            "e": Option(method=self.extension_menu),
-            "s": Option(method=self.settings_menu, menu=True),
+            "s": Option(method=self.settings_menu),
         }
 
     def _init_status(self) -> None:
@@ -84,6 +88,7 @@ class MainMenu(BaseMenu):
             )
 
     def _fetch_status(self) -> None:
+        self.version = get_kiauh_version()
         self._get_component_status("kl", get_klipper_status)
         self._get_component_status("mr", get_moonraker_status)
         self._get_component_status("ms", get_client_status, MainsailData())
@@ -94,7 +99,7 @@ class MainMenu(BaseMenu):
         self._get_component_status("cn", get_crowsnest_status)
         self._get_component_status("oe", get_octoeverywhere_status)
 
-    def _get_component_status(self, name: str, status_fn: callable, *args) -> None:
+    def _get_component_status(self, name: str, status_fn: Callable, *args) -> None:
         status_data: ComponentStatus = status_fn(*args)
         code: int = status_data.status
         status: StatusText = StatusMap[code]
@@ -119,11 +124,11 @@ class MainMenu(BaseMenu):
 
         return f"{color}{status}{count}{RESET_FORMAT}"
 
-    def print_menu(self):
+    def print_menu(self) -> None:
         self._fetch_status()
 
         header = " [ Main Menu ] "
-        footer1 = f"{COLOR_CYAN}KIAUH v6.0.0{RESET_FORMAT}"
+        footer1 = f"{COLOR_CYAN}{self.version}{RESET_FORMAT}"
         footer2 = f"Changelog: {COLOR_MAGENTA}https://git.io/JnmlX{RESET_FORMAT}"
         color = COLOR_CYAN
         count = 62 - len(color) - len(RESET_FORMAT)
@@ -155,30 +160,30 @@ class MainMenu(BaseMenu):
         )[1:]
         print(menu, end="")
 
-    def exit(self, **kwargs):
+    def exit(self, **kwargs) -> None:
         Logger.print_ok("###### Happy printing!", False)
         sys.exit(0)
 
-    def log_upload_menu(self, **kwargs):
+    def log_upload_menu(self, **kwargs) -> None:
         LogUploadMenu().run()
 
-    def install_menu(self, **kwargs):
+    def install_menu(self, **kwargs) -> None:
         InstallMenu(previous_menu=self.__class__).run()
 
-    def update_menu(self, **kwargs):
+    def update_menu(self, **kwargs) -> None:
         UpdateMenu(previous_menu=self.__class__).run()
 
-    def remove_menu(self, **kwargs):
+    def remove_menu(self, **kwargs) -> None:
         RemoveMenu(previous_menu=self.__class__).run()
 
-    def advanced_menu(self, **kwargs):
+    def advanced_menu(self, **kwargs) -> None:
         AdvancedMenu(previous_menu=self.__class__).run()
 
-    def backup_menu(self, **kwargs):
+    def backup_menu(self, **kwargs) -> None:
         BackupMenu(previous_menu=self.__class__).run()
 
-    def settings_menu(self, **kwargs):
+    def settings_menu(self, **kwargs) -> None:
         SettingsMenu(previous_menu=self.__class__).run()
 
-    def extension_menu(self, **kwargs):
+    def extension_menu(self, **kwargs) -> None:
         ExtensionsMenu(previous_menu=self.__class__).run()

kiauh/core/menus/remove_menu.py

@@ -6,9 +6,10 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import textwrap
-from typing import Optional, Type
+from typing import Type
 
 from components.crowsnest.crowsnest import remove_crowsnest
 from components.klipper.menus.klipper_remove_menu import KlipperRemoveMenu
@@ -21,38 +22,36 @@ from components.octoeverywhere.octoeverywhere_setup import remove_octoeverywhere
 from components.webui_client.fluidd_data import FluiddData
 from components.webui_client.mainsail_data import MainsailData
 from components.webui_client.menus.client_remove_menu import ClientRemoveMenu
+from core.constants import COLOR_RED, RESET_FORMAT
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_RED, RESET_FORMAT
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class RemoveMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
 
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
-            previous_menu if previous_menu is not None else MainMenu
-        )
 
-    def set_options(self):
+    def set_options(self) -> None:
         self.options = {
-            "1": Option(method=self.remove_klipper, menu=True),
+            "1": Option(method=self.remove_klipper),
-            "2": Option(method=self.remove_moonraker, menu=True),
+            "2": Option(method=self.remove_moonraker),
-            "3": Option(method=self.remove_mainsail, menu=True),
+            "3": Option(method=self.remove_mainsail),
-            "4": Option(method=self.remove_fluidd, menu=True),
+            "4": Option(method=self.remove_fluidd),
-            "5": Option(method=self.remove_klipperscreen, menu=True),
+            "5": Option(method=self.remove_klipperscreen),
-            "6": Option(method=self.remove_mobileraker, menu=True),
+            "6": Option(method=self.remove_mobileraker),
-            "7": Option(method=self.remove_crowsnest, menu=True),
+            "7": Option(method=self.remove_crowsnest),
-            "8": Option(method=self.remove_octoeverywhere, menu=True),
+            "8": Option(method=self.remove_octoeverywhere),
         }
 
-    def print_menu(self):
+    def print_menu(self) -> None:
         header = " [ Remove Menu ] "
         color = COLOR_RED
         count = 62 - len(color) - len(RESET_FORMAT)
@@ -78,26 +77,26 @@ class RemoveMenu(BaseMenu):
         )[1:]
         print(menu, end="")
 
-    def remove_klipper(self, **kwargs):
+    def remove_klipper(self, **kwargs) -> None:
         KlipperRemoveMenu(previous_menu=self.__class__).run()
 
-    def remove_moonraker(self, **kwargs):
+    def remove_moonraker(self, **kwargs) -> None:
         MoonrakerRemoveMenu(previous_menu=self.__class__).run()
 
-    def remove_mainsail(self, **kwargs):
+    def remove_mainsail(self, **kwargs) -> None:
         ClientRemoveMenu(previous_menu=self.__class__, client=MainsailData()).run()
 
-    def remove_fluidd(self, **kwargs):
+    def remove_fluidd(self, **kwargs) -> None:
         ClientRemoveMenu(previous_menu=self.__class__, client=FluiddData()).run()
 
-    def remove_klipperscreen(self, **kwargs):
+    def remove_klipperscreen(self, **kwargs) -> None:
         remove_klipperscreen()
 
-    def remove_mobileraker(self, **kwargs):
+    def remove_mobileraker(self, **kwargs) -> None:
         remove_mobileraker()
 
-    def remove_crowsnest(self, **kwargs):
+    def remove_crowsnest(self, **kwargs) -> None:
         remove_crowsnest()
 
-    def remove_octoeverywhere(self, **kwargs):
+    def remove_octoeverywhere(self, **kwargs) -> None:
         remove_octoeverywhere()

kiauh/core/menus/settings_menu.py

@@ -6,55 +6,56 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
+
 import shutil
 import textwrap
 from pathlib import Path
-from typing import Optional, Tuple, Type
+from typing import Tuple, Type
 
 from components.klipper import KLIPPER_DIR
 from components.klipper.klipper import Klipper
 from components.moonraker import MOONRAKER_DIR
 from components.moonraker.moonraker import Moonraker
+from core.constants import COLOR_CYAN, COLOR_GREEN, RESET_FORMAT
 from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
 from core.settings.kiauh_settings import KiauhSettings
-from utils.constants import COLOR_CYAN, COLOR_GREEN, RESET_FORMAT
 from utils.git_utils import git_clone_wrapper
 from utils.input_utils import get_confirm, get_string_input
-from utils.logger import DialogType, Logger
+from utils.instance_utils import get_instances
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class SettingsMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
-        self.klipper_repo = None
+        self.klipper_repo: str | None = None
-        self.moonraker_repo = None
+        self.moonraker_repo: str | None = None
-        self.mainsail_unstable = None
+        self.mainsail_unstable: bool | None = None
-        self.fluidd_unstable = None
+        self.fluidd_unstable: bool | None = None
-        self.auto_backups_enabled = None
+        self.auto_backups_enabled: bool | None = None
         self._load_settings()
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
 
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
-            previous_menu if previous_menu is not None else MainMenu
-        )
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(method=self.set_klipper_repo, menu=True),
+            "1": Option(method=self.set_klipper_repo),
-            "2": Option(method=self.set_moonraker_repo, menu=True),
+            "2": Option(method=self.set_moonraker_repo),
-            "3": Option(method=self.toggle_mainsail_release, menu=True),
+            "3": Option(method=self.toggle_mainsail_release),
-            "4": Option(method=self.toggle_fluidd_release, menu=False),
+            "4": Option(method=self.toggle_fluidd_release),
-            "5": Option(method=self.toggle_backup_before_update, menu=False),
+            "5": Option(method=self.toggle_backup_before_update),
         }
 
-    def print_menu(self):
+    def print_menu(self) -> None:
         header = " [ KIAUH Settings ] "
         color = COLOR_CYAN
         count = 62 - len(color) - len(RESET_FORMAT)
@@ -94,7 +95,7 @@ class SettingsMenu(BaseMenu):
         )[1:]
         print(menu, end="")
 
-    def _load_settings(self):
+    def _load_settings(self) -> None:
         self.settings = KiauhSettings()
 
         self._format_repo_str("klipper")
@@ -133,7 +134,7 @@ class SettingsMenu(BaseMenu):
 
         return repo, branch
 
-    def _set_repo(self, repo_name: str):
+    def _set_repo(self, repo_name: str) -> None:
         repo_url, branch = self._gather_input()
         display_name = repo_name.capitalize()
         Logger.print_dialog(
@@ -177,32 +178,32 @@ class SettingsMenu(BaseMenu):
         if target_dir.exists():
             shutil.rmtree(target_dir)
 
-        im = InstanceManager(_type)
+        instances = get_instances(_type)
-        im.stop_all_instance()
+        InstanceManager.stop_all(instances)
 
         repo = self.settings.get(name, "repo_url")
         branch = self.settings.get(name, "branch")
         git_clone_wrapper(repo, target_dir, branch)
 
-        im.start_all_instance()
+        InstanceManager.start_all(instances)
 
-    def set_klipper_repo(self, **kwargs):
+    def set_klipper_repo(self, **kwargs) -> None:
         self._set_repo("klipper")
 
-    def set_moonraker_repo(self, **kwargs):
+    def set_moonraker_repo(self, **kwargs) -> None:
         self._set_repo("moonraker")
 
-    def toggle_mainsail_release(self, **kwargs):
+    def toggle_mainsail_release(self, **kwargs) -> None:
         self.mainsail_unstable = not self.mainsail_unstable
         self.settings.mainsail.unstable_releases = self.mainsail_unstable
         self.settings.save()
 
-    def toggle_fluidd_release(self, **kwargs):
+    def toggle_fluidd_release(self, **kwargs) -> None:
         self.fluidd_unstable = not self.fluidd_unstable
         self.settings.fluidd.unstable_releases = self.fluidd_unstable
         self.settings.save()
 
-    def toggle_backup_before_update(self, **kwargs):
+    def toggle_backup_before_update(self, **kwargs) -> None:
         self.auto_backups_enabled = not self.auto_backups_enabled
         self.settings.kiauh.backup_before_update = self.auto_backups_enabled
         self.settings.save()

kiauh/core/menus/update_menu.py

@@ -6,8 +6,10 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
+
 import textwrap
-from typing import Optional, Type
+from typing import Callable, List, Type
 
 from components.crowsnest.crowsnest import get_crowsnest_status, update_crowsnest
 from components.klipper.klipper_setup import update_klipper
@@ -38,25 +40,34 @@ from components.webui_client.client_utils import (
 )
 from components.webui_client.fluidd_data import FluiddData
 from components.webui_client.mainsail_data import MainsailData
-from core.menus import Option
+from core.constants import (
-from core.menus.base_menu import BaseMenu
-from utils.constants import (
     COLOR_GREEN,
     COLOR_RED,
     COLOR_YELLOW,
     RESET_FORMAT,
 )
-from utils.logger import Logger
+from core.logger import DialogType, Logger
-from utils.spinner import Spinner
+from core.menus import Option
-from utils.types import ComponentStatus
+from core.menus.base_menu import BaseMenu
+from core.spinner import Spinner
+from core.types import ComponentStatus
+from utils.input_utils import get_confirm
+from utils.sys_utils import (
+    get_upgradable_packages,
+    update_system_package_lists,
+    upgrade_system_packages,
+)
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class UpdateMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+        self.packages: List[str] = []
+        self.package_count: int = 0
 
         self.klipper_local = self.klipper_remote = ""
         self.moonraker_local = self.moonraker_remote = ""
@@ -84,31 +95,29 @@ class UpdateMenu(BaseMenu):
             "octoeverywhere": {"installed": False, "local": None, "remote": None},
         }
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
 
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
-            previous_menu if previous_menu is not None else MainMenu
-        )
 
     def set_options(self) -> None:
         self.options = {
-            "a": Option(self.update_all, menu=False),
+            "a": Option(self.update_all),
-            "1": Option(self.update_klipper, menu=False),
+            "1": Option(self.update_klipper),
-            "2": Option(self.update_moonraker, menu=False),
+            "2": Option(self.update_moonraker),
-            "3": Option(self.update_mainsail, menu=False),
+            "3": Option(self.update_mainsail),
-            "4": Option(self.update_fluidd, menu=False),
+            "4": Option(self.update_fluidd),
-            "5": Option(self.update_mainsail_config, menu=False),
+            "5": Option(self.update_mainsail_config),
-            "6": Option(self.update_fluidd_config, menu=False),
+            "6": Option(self.update_fluidd_config),
-            "7": Option(self.update_klipperscreen, menu=False),
+            "7": Option(self.update_klipperscreen),
-            "8": Option(self.update_mobileraker, menu=False),
+            "8": Option(self.update_mobileraker),
-            "9": Option(self.update_crowsnest, menu=False),
+            "9": Option(self.update_crowsnest),
-            "10": Option(self.update_octoeverywhere, menu=False),
+            "10": Option(self.update_octoeverywhere),
-            "11": Option(self.upgrade_system_packages, menu=False),
+            "11": Option(self.upgrade_system_packages),
         }
 
-    def print_menu(self):
+    def print_menu(self) -> None:
-        spinner = Spinner()
+        spinner = Spinner("Loading update menu, please wait", color="green")
         spinner.start()
 
         self._fetch_update_status()
@@ -118,6 +127,15 @@ class UpdateMenu(BaseMenu):
         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"""
             ╔═══════════════════════════════════════════════════════╗
@@ -143,58 +161,59 @@ class UpdateMenu(BaseMenu):
             ║  9) Crowsnest         │ {self.crowsnest_local:<22} │ {self.crowsnest_remote:<22} ║
             ║ 10) OctoEverywhere    │ {self.octoeverywhere_local:<22} │ {self.octoeverywhere_remote:<22} ║
             ║                       ├───────────────┴───────────────╢
-            ║ 11) System            │                               ║
+            ║ 11) System            │ {sysupgrades:^{padding}} ║
             ╟───────────────────────┴───────────────────────────────╢
             """
         )[1:]
         print(menu, end="")
 
-    def update_all(self, **kwargs):
+    def update_all(self, **kwargs) -> None:
         print("update_all")
 
-    def update_klipper(self, **kwargs):
+    def update_klipper(self, **kwargs) -> None:
         if self._check_is_installed("klipper"):
             update_klipper()
 
-    def update_moonraker(self, **kwargs):
+    def update_moonraker(self, **kwargs) -> None:
         if self._check_is_installed("moonraker"):
             update_moonraker()
 
-    def update_mainsail(self, **kwargs):
+    def update_mainsail(self, **kwargs) -> None:
         if self._check_is_installed("mainsail"):
             update_client(self.mainsail_data)
 
-    def update_mainsail_config(self, **kwargs):
+    def update_mainsail_config(self, **kwargs) -> None:
         if self._check_is_installed("mainsail_config"):
             update_client_config(self.mainsail_data)
 
-    def update_fluidd(self, **kwargs):
+    def update_fluidd(self, **kwargs) -> None:
         if self._check_is_installed("fluidd"):
             update_client(self.fluidd_data)
 
-    def update_fluidd_config(self, **kwargs):
+    def update_fluidd_config(self, **kwargs) -> None:
         if self._check_is_installed("fluidd_config"):
             update_client_config(self.fluidd_data)
 
-    def update_klipperscreen(self, **kwargs):
+    def update_klipperscreen(self, **kwargs) -> None:
         if self._check_is_installed("klipperscreen"):
             update_klipperscreen()
 
-    def update_mobileraker(self, **kwargs):
+    def update_mobileraker(self, **kwargs) -> None:
         if self._check_is_installed("mobileraker"):
             update_mobileraker()
 
-    def update_crowsnest(self, **kwargs):
+    def update_crowsnest(self, **kwargs) -> None:
         if self._check_is_installed("crowsnest"):
             update_crowsnest()
 
-    def update_octoeverywhere(self, **kwargs):
+    def update_octoeverywhere(self, **kwargs) -> None:
         if self._check_is_installed("octoeverywhere"):
             update_octoeverywhere()
 
-    def upgrade_system_packages(self, **kwargs): ...
+    def upgrade_system_packages(self, **kwargs) -> None:
+        self._run_system_updates()
 
-    def _fetch_update_status(self):
+    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)
@@ -210,6 +229,10 @@ class UpdateMenu(BaseMenu):
         self._set_status_data("crowsnest", get_crowsnest_status)
         self._set_status_data("octoeverywhere", get_octoeverywhere_status)
 
+        update_system_package_lists(silent=True)
+        self.packages = get_upgradable_packages()
+        self.package_count = len(self.packages)
+
     def _format_local_status(self, local_version, remote_version) -> str:
         color = COLOR_RED
         if not local_version:
@@ -221,7 +244,7 @@ class UpdateMenu(BaseMenu):
 
         return f"{color}{local_version or '-'}{RESET_FORMAT}"
 
-    def _set_status_data(self, name: str, status_fn: callable, *args) -> None:
+    def _set_status_data(self, name: str, status_fn: Callable, *args) -> None:
         comp_status: ComponentStatus = status_fn(*args)
 
         self.status_data[name]["installed"] = True if comp_status.status == 2 else False
@@ -246,3 +269,23 @@ class UpdateMenu(BaseMenu):
             Logger.print_info(f"{name.capitalize()} is not installed! Skipped ...")
             return False
         return True
+
+    def _run_system_updates(self) -> None:
+        if not self.packages:
+            Logger.print_info("No system upgrades available!")
+            return
+
+        try:
+            pkgs: str = ", ".join(self.packages)
+            Logger.print_dialog(
+                DialogType.CUSTOM,
+                ["The following packages will be upgraded:", "\n\n", pkgs],
+                custom_title="UPGRADABLE SYSTEM UPDATES",
+            )
+            if not get_confirm("Continue?"):
+                return
+            Logger.print_status("Upgrading system packages ...")
+            upgrade_system_packages(self.packages)
+        except Exception as e:
+            Logger.print_error(f"Error upgrading system packages:\n{e}")
+            raise

kiauh/core/settings/kiauh_settings.py

@@ -8,14 +8,12 @@
 # ======================================================================= #
 from __future__ import annotations
 
-from typing import Union
+from core.logger import DialogType, Logger
-
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     NoOptionError,
     NoSectionError,
     SimpleConfigParser,
 )
-from utils.logger import DialogType, Logger
 from utils.sys_utils import kill
 
 from kiauh import PROJECT_ROOT
@@ -61,10 +59,11 @@ class KiauhSettings:
     def __new__(cls, *args, **kwargs) -> "KiauhSettings":
         if cls._instance is None:
             cls._instance = super(KiauhSettings, cls).__new__(cls, *args, **kwargs)
-            cls._instance.__initialized = False
         return cls._instance
 
     def __init__(self) -> None:
+        if not hasattr(self, "__initialized"):
+            self.__initialized = False
         if self.__initialized:
             return
         self.__initialized = True
@@ -87,7 +86,7 @@ class KiauhSettings:
 
         self._load_config()
 
-    def get(self, section: str, option: str) -> Union[str, int, bool]:
+    def get(self, section: str, option: str) -> str | int | bool:
         """
         Get a value from the settings state by providing the section and option name as strings.
         Prefer direct access to the properties, as it is usually safer!
@@ -99,11 +98,11 @@ class KiauhSettings:
         try:
             section = getattr(self, section)
             value = getattr(section, option)
-            return value
+            return value  # type: ignore
         except AttributeError:
             raise
 
-    def set(self, section: str, option: str, value: Union[str, int, bool]) -> None:
+    def set(self, section: str, option: str, value: str | int | bool) -> None:
         """
         Set a value in the settings state by providing the section and option name as strings.
         Prefer direct access to the properties, as it is usually safer!
@@ -113,7 +112,7 @@ class KiauhSettings:
         """
         try:
             section = getattr(self, section)
-            section.option = value
+            section.option = value  # type: ignore
         except AttributeError:
             raise
 
@@ -172,7 +171,7 @@ class KiauhSettings:
         if v.isdigit() or v.lower() == "true" or v.lower() == "false":
             raise ValueError
 
-    def _read_settings(self):
+    def _read_settings(self) -> None:
         self.kiauh.backup_before_update = self.config.getboolean(
             "kiauh", "backup_before_update"
         )
@@ -189,7 +188,7 @@ class KiauhSettings:
             "fluidd", "unstable_releases"
         )
 
-    def _set_config_options(self):
+    def _set_config_options(self) -> None:
         self.config.set(
             "kiauh",
             "backup_before_update",

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/extensions/extensions_menu.py

@@ -6,42 +6,39 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import importlib
 import inspect
 import json
 import textwrap
 from pathlib import Path
-from typing import Dict, List, Optional, Type
+from typing import Dict, List, Type
 
+from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
+from core.logger import Logger
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
 from extensions import EXTENSION_ROOT
 from extensions.base_extension import BaseExtension
-from utils.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
-from utils.logger import Logger
 
 
 # noinspection PyUnusedLocal
 # noinspection PyMethodMayBeStatic
 class ExtensionsMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
+    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
         super().__init__()
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
         self.extensions: Dict[str, BaseExtension] = self.discover_extensions()
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from core.menus.main_menu import MainMenu
 
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
-            previous_menu if previous_menu is not None else MainMenu
-        )
 
     def set_options(self) -> None:
         self.options = {
-            i: Option(
+            i: Option(self.extension_submenu, opt_data=self.extensions.get(i))
-                self.extension_submenu, menu=True, opt_data=self.extensions.get(i)
-            )
             for i in self.extensions
         }
 
@@ -80,7 +77,7 @@ class ExtensionsMenu(BaseMenu):
     def extension_submenu(self, **kwargs):
         ExtensionSubmenu(kwargs.get("opt_data"), self.__class__).run()
 
-    def print_menu(self):
+    def print_menu(self) -> None:
         header = " [ Extensions Menu ] "
         color = COLOR_CYAN
         line1 = f"{COLOR_YELLOW}Available Extensions:{RESET_FORMAT}"
@@ -108,24 +105,24 @@ class ExtensionsMenu(BaseMenu):
 # noinspection PyMethodMayBeStatic
 class ExtensionSubmenu(BaseMenu):
     def __init__(
-        self, extension: BaseExtension, previous_menu: Optional[Type[BaseMenu]] = None
+        self, extension: BaseExtension, previous_menu: Type[BaseMenu] | None = None
     ):
         super().__init__()
         self.extension = extension
-        self.previous_menu = previous_menu
+        self.previous_menu: Type[BaseMenu] | None = previous_menu
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = (
             previous_menu if previous_menu is not None else ExtensionsMenu
         )
 
     def set_options(self) -> None:
-        self.options["1"] = Option(self.extension.install_extension, menu=False)
+        self.options["1"] = Option(self.extension.install_extension)
         if self.extension.metadata.get("updates"):
-            self.options["2"] = Option(self.extension.update_extension, menu=False)
+            self.options["2"] = Option(self.extension.update_extension)
-            self.options["3"] = Option(self.extension.remove_extension, menu=False)
+            self.options["3"] = Option(self.extension.remove_extension)
         else:
-            self.options["2"] = Option(self.extension.remove_extension, menu=False)
+            self.options["2"] = Option(self.extension.remove_extension)
 
     def print_menu(self) -> None:
         header = f" [ {self.extension.metadata.get('display_name')} ] "

kiauh/extensions/gcode_shell_cmd/gcode_shell_cmd_extension.py

@@ -14,6 +14,7 @@ from typing import List
 from components.klipper.klipper import Klipper
 from core.backup_manager.backup_manager import BackupManager
 from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
@@ -27,7 +28,7 @@ from extensions.gcode_shell_cmd import (
 )
 from utils.fs_utils import check_file_exist
 from utils.input_utils import get_confirm
-from utils.logger import Logger
+from utils.instance_utils import get_instances
 
 
 # noinspection PyMethodMayBeStatic
@@ -55,8 +56,8 @@ class GcodeShellCmdExtension(BaseExtension):
             Logger.print_warn("Installation aborted due to user request.")
             return
 
-        im = InstanceManager(Klipper)
+        instances = get_instances(Klipper)
-        im.stop_all_instance()
+        InstanceManager.stop_all(instances)
 
         try:
             Logger.print_status(f"Copy extension to '{KLIPPER_EXTRAS}' ...")
@@ -66,9 +67,9 @@ class GcodeShellCmdExtension(BaseExtension):
             return
 
         if install_example:
-            self.install_example_cfg(im.instances)
+            self.install_example_cfg(instances)
 
-        im.start_all_instance()
+        InstanceManager.start_all(instances)
 
         Logger.print_ok("Installing G-Code Shell Command extension successful!")
 
@@ -94,7 +95,7 @@ class GcodeShellCmdExtension(BaseExtension):
             Logger.print_warn("Make sure to remove them from the printer.cfg!")
 
     def install_example_cfg(self, instances: List[Klipper]):
-        cfg_dirs = [instance.cfg_dir for instance in instances]
+        cfg_dirs = [instance.base.cfg_dir for instance in instances]
         # copy extension to klippy/extras
         for cfg_dir in cfg_dirs:
             Logger.print_status(f"Create shell_command.cfg in '{cfg_dir}' ...")

kiauh/extensions/klipper_backup/klipper_backup_extension.py

@@ -12,7 +12,9 @@
 import os
 import shutil
 import subprocess
-
+from core.constants import SYSTEMD
+from core.logger import Logger
+from pathlib import Path
 from extensions.base_extension import BaseExtension
 from extensions.klipper_backup import (
     KLIPPERBACKUP_CONFIG_DIR,
@@ -20,163 +22,106 @@ from extensions.klipper_backup import (
     KLIPPERBACKUP_REPO_URL,
     MOONRAKER_CONF,
 )
-from utils.fs_utils import check_file_exist
+from utils.fs_utils import check_file_exist, remove_with_sudo
+from utils.git_utils import git_cmd_clone
 from utils.input_utils import get_confirm
-from utils.logger import Logger
+from utils.sys_utils import cmd_sysctl_manage, remove_system_service, unit_file_exists
-from utils.sys_utils import service_instance_exists
 
 
-# noinspection PyMethodMayBeStatic
 class KlipperbackupExtension(BaseExtension):
+
+    def remove_extension(self, **kwargs) -> None:
+        if not check_file_exist(KLIPPERBACKUP_DIR):
+            Logger.print_info("Extension does not seem to be installed! Skipping ...")
+            return
+
+        def uninstall_service(service_name: str, unit_type: str) -> bool:
+            try:
+                full_service_name = f"{service_name}.{unit_type}"
+                if unit_type == "service":
+                    remove_system_service(full_service_name)
+                elif unit_type == "timer":
+                    full_service_path: Path = SYSTEMD.joinpath(full_service_name)
+                    Logger.print_status(f"Removing {full_service_name} ...")
+                    remove_with_sudo(full_service_path)
+                    Logger.print_ok(f"{service_name}.{unit_type} successfully removed!")
+                    cmd_sysctl_manage("daemon-reload")
+                    cmd_sysctl_manage("reset-failed")
+                else:
+                    Logger.print_error(f"Unknown unit type {unit_type} of {full_service_name}")
+            except:
+                Logger.print_error(f"Failed to remove {full_service_name}: {str(e)}")
+
+        def check_crontab_entry(entry) -> bool:
+            try:
+                crontab_content = subprocess.check_output(["crontab", "-l"], stderr=subprocess.DEVNULL, text=True)
+            except subprocess.CalledProcessError:
+                return False
+            return any(entry in line for line in crontab_content.splitlines())
+
+        def remove_moonraker_entry():
+            original_file_path = MOONRAKER_CONF
+            comparison_file_path = os.path.join(str(KLIPPERBACKUP_DIR), "install-files", "moonraker.conf")
+            if not (os.path.exists(original_file_path) and os.path.exists(comparison_file_path)):
+                return False
+            with open(original_file_path, "r") as original_file, open(comparison_file_path, "r") as comparison_file:
+                original_content = original_file.read()
+                comparison_content = comparison_file.read()
+            if comparison_content in original_content:
+                Logger.print_status("Removing Klipper-Backup moonraker entry ...")
+                modified_content = original_content.replace(comparison_content, "").strip()
+                modified_content = "\n".join(line for line in modified_content.split("\n") if line.strip())
+                with open(original_file_path, "w") as original_file:
+                    original_file.write(modified_content)
+                Logger.print_ok("Klipper-Backup moonraker entry successfully removed!")
+                return True
+            return False
+
+        if get_confirm("Do you really want to remove the extension?", True, False):
+            # Remove systemd timer and services
+            service_names = ["klipper-backup-on-boot", "klipper-backup-filewatch", "klipper-backup"]
+            unit_types = ["timer", "service"]
+
+            for service_name in service_names:
+                for unit_type in unit_types:
+                    if unit_file_exists(service_name, unit_type):
+                        uninstall_service(service_name, unit_type)
+
+            # Remnove crontab entry
+            try:
+                if check_crontab_entry("/klipper-backup/script.sh"):
+                    Logger.print_status("Removing Klipper-Backup crontab entry ...")
+                    crontab_content = subprocess.check_output(["crontab", "-l"], text=True)
+                    modified_content = "\n".join(line for line in crontab_content.splitlines() if "/klipper-backup/script.sh" not in line)
+                    subprocess.run(["crontab", "-"], input=modified_content + "\n", text=True, check=True)
+                    Logger.print_ok("Klipper-Backup crontab entry successfully removed!")
+            except subprocess.CalledProcessError:
+                Logger.print_error("Unable to remove the Klipper-Backup cron entry")
+
+            # Remove moonraker entry
+            try:
+                remove_moonraker_entry()
+            except:
+                Logger.print_error("Unable to remove the Klipper-Backup moonraker entry")
+
+            # Remove Klipper-backup extension
+            Logger.print_status("Removing Klipper-Backup extension ...")
+            try:
+                remove_with_sudo(KLIPPERBACKUP_DIR)
+                if check_file_exist(KLIPPERBACKUP_CONFIG_DIR):
+                    remove_with_sudo(KLIPPERBACKUP_CONFIG_DIR)
+                Logger.print_ok("Extension Klipper-Backup successfully removed!")
+            except:
+                Logger.print_error(f"Unable to remove Klipper-Backup extension")
+
     def install_extension(self, **kwargs) -> None:
         if not KLIPPERBACKUP_DIR.exists():
-            subprocess.run(
+            git_cmd_clone(KLIPPERBACKUP_REPO_URL, KLIPPERBACKUP_DIR)
-                ["git", "clone", str(KLIPPERBACKUP_REPO_URL), str(KLIPPERBACKUP_DIR)]
-            )
             subprocess.run(["chmod", "+x", str(KLIPPERBACKUP_DIR / "install.sh")])
         subprocess.run([str(KLIPPERBACKUP_DIR / "install.sh")])
 
     def update_extension(self, **kwargs) -> None:
-        extension_installed = check_file_exist(KLIPPERBACKUP_DIR)
+        if not check_file_exist(KLIPPERBACKUP_DIR):
-        if not extension_installed:
             Logger.print_info("Extension does not seem to be installed! Skipping ...")
             return
-        else:
+        subprocess.run([str(KLIPPERBACKUP_DIR / "install.sh"), "check_updates"])
-            subprocess.run([str(KLIPPERBACKUP_DIR / "install.sh"), "check_updates"])
-
-    def remove_extension(self, **kwargs) -> None:
-
-        def uninstall_service(service_name):
-            try:
-                subprocess.run(["sudo", "systemctl", "stop", service_name], check=True)
-                subprocess.run(
-                    ["sudo", "systemctl", "disable", service_name], check=True
-                )
-                subprocess.run(["sudo", "systemctl", "daemon-reload"], check=True)
-                service_path = f"/etc/systemd/system/{service_name}.service"
-                os.system(f"sudo rm {service_path}")
-                return True
-            except subprocess.CalledProcessError:
-                return False
-
-        def check_crontab_entry(entry):
-            try:
-                crontab_content = subprocess.check_output(
-                    ["crontab", "-l"], stderr=subprocess.DEVNULL, text=True
-                )
-            except subprocess.CalledProcessError:
-                return False
-            for line in crontab_content.splitlines():
-                if entry in line:
-                    return True
-            return False
-
-        extension_installed = check_file_exist(KLIPPERBACKUP_DIR)
-        if not extension_installed:
-            Logger.print_info("Extension does not seem to be installed! Skipping ...")
-            return
-
-        def remove_moonraker_entry():
-            original_file_path = MOONRAKER_CONF
-            comparison_file_path = os.path.join(
-                str(KLIPPERBACKUP_DIR), "install-files", "moonraker.conf"
-            )
-            if not os.path.exists(original_file_path) or not os.path.exists(
-                comparison_file_path
-            ):
-                return False
-            with open(original_file_path, "r") as original_file, open(
-                comparison_file_path, "r"
-            ) as comparison_file:
-                original_content = original_file.read()
-                comparison_content = comparison_file.read()
-            if comparison_content in original_content:
-                modified_content = original_content.replace(
-                    comparison_content, ""
-                ).strip()
-                modified_content = "\n".join(
-                    line for line in modified_content.split("\n") if line.strip()
-                )
-                with open(original_file_path, "w") as original_file:
-                    original_file.write(modified_content)
-                    return True
-            else:
-                return False
-
-        question = "Do you really want to remove the extension?"
-        if get_confirm(question, True, False):
-            # Remove Klipper-Backup services
-            service_names = [
-                "klipper-backup-on-boot",
-                "klipper-backup-filewatch",
-            ]
-            for service_name in service_names:
-                try:
-                    Logger.print_status(
-                        f"Check whether the {service_name} service is installed ..."
-                    )
-                    if service_instance_exists(service_name):
-                        Logger.print_info(f"Service {service_name} detected.")
-                        if uninstall_service(service_name):
-                            Logger.print_ok(
-                                f"The {service_name} service has been successfully uninstalled."
-                            )
-                        else:
-                            Logger.print_error(
-                               f"Error uninstalling the {service_name} service."
-                           )
-                    else:
-                        Logger.print_info(f"Service {service_name} NOT detected.")
-                except:
-                    Logger.print_error(f"Unable to remove the {service_name} service")
-
-            # Remove Klipper-Backup cron
-            Logger.print_status("Check for Klipper-Backup cron entry ...")
-            entry_to_check = "/klipper-backup/script.sh"
-            try:
-                if check_crontab_entry(entry_to_check):
-                    crontab_content = subprocess.check_output(
-                        ["crontab", "-l"], text=True
-                    )
-                    modified_content = "\n".join(
-                        line
-                        for line in crontab_content.splitlines()
-                        if entry_to_check not in line
-                    )
-                    subprocess.run(
-                        ["crontab", "-"], input=modified_content, text=True, check=True
-                    )
-                    Logger.print_ok(
-                        "The Klipper-Backup entry has been removed from the crontab."
-                    )
-                else:
-                    Logger.print_info(
-                        "The Klipper-Backup entry is not present in the crontab. Skipping ..."
-                    )
-            except:
-                Logger.print_error("Unable to remove the Klipper-Backup cron entry")
-
-            # Remove Moonraker entry
-            Logger.print_status("Check for Klipper-Backup moonraker entry ...")
-            try:
-                if remove_moonraker_entry():
-                    Logger.print_ok("Klipper-Backup entry in moonraker.conf removed")
-                else:
-                    Logger.print_info(
-                        "Klipper-Backup entry not found in moonraker.conf. Skipping ..."
-                    )
-            except:
-                Logger.print_error(
-                    "Unknown error, either the moonraker.conf is not found or the Klipper-Backup entry under ~/klipper-backup/install-files/moonraker.conf. Skipping ..."
-                )
-
-            # Remove Klipper-Backup
-            Logger.print_status(f"Removing '{KLIPPERBACKUP_DIR}' ...")
-            try:
-                shutil.rmtree(KLIPPERBACKUP_DIR)
-                config_backup_exists = check_file_exist(KLIPPERBACKUP_CONFIG_DIR)
-                if config_backup_exists:
-                    shutil.rmtree(KLIPPERBACKUP_CONFIG_DIR)
-                Logger.print_ok("Extension Klipper-Backup successfully removed!")
-            except OSError as e:
-                Logger.print_error(f"Unable to remove extension: {e}")

kiauh/extensions/mainsail_theme_installer/mainsail_theme_installer_extension.py

@@ -6,30 +6,34 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import csv
 import shutil
 import textwrap
 import urllib.request
-from typing import List, Optional, Type, TypedDict, Union
+from dataclasses import dataclass
+from typing import Any, Dict, List, Type, Union
 
 from components.klipper.klipper import Klipper
 from components.klipper.klipper_dialogs import (
     DisplayType,
     print_instance_overview,
 )
+from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
 from core.instance_manager.base_instance import BaseInstance
-from core.instance_manager.instance_manager import InstanceManager
+from core.instance_type import InstanceType
+from core.logger import Logger
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
 from extensions.base_extension import BaseExtension
-from utils.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
 from utils.git_utils import git_clone_wrapper
 from utils.input_utils import get_selection_input
-from utils.logger import Logger
+from utils.instance_utils import get_instances
 
 
-class ThemeData(TypedDict):
+@dataclass
+class ThemeData:
     name: str
     short_note: str
     author: str
@@ -38,8 +42,7 @@ class ThemeData(TypedDict):
 
 # noinspection PyMethodMayBeStatic
 class MainsailThemeInstallerExtension(BaseExtension):
-    im = InstanceManager(Klipper)
+    instances: List[Klipper] = get_instances(Klipper)
-    instances: List[Klipper] = im.instances
 
     def install_extension(self, **kwargs) -> None:
         MainsailThemeInstallMenu(self.instances).run()
@@ -81,16 +84,16 @@ class MainsailThemeInstallMenu(BaseMenu):
         self.themes: List[ThemeData] = self.load_themes()
         self.instances = instances
 
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
+    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         from extensions.extensions_menu import ExtensionsMenu
 
-        self.previous_menu: Type[BaseMenu] = (
+        self.previous_menu = (
             previous_menu if previous_menu is not None else ExtensionsMenu
         )
 
     def set_options(self) -> None:
         self.options = {
-            f"{index}": Option(self.install_theme, False, opt_index=f"{index}")
+            f"{index}": Option(self.install_theme, opt_index=f"{index}")
             for index in range(len(self.themes))
         }
 
@@ -101,36 +104,45 @@ class MainsailThemeInstallMenu(BaseMenu):
         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} ║
-            | https://docs.mainsail.xyz/theming/themes              |
+            ║ https://docs.mainsail.xyz/theming/themes              ║
-            |-------------------------------------------------------|
+            ╟───────────────────────────────────────────────────────╢
             """
         )[1:]
         for i, theme in enumerate(self.themes):
-            i = f" {i}" if i < 10 else f"{i}"
+            j: str = f" {i}" if i < 10 else f"{i}"
-            row = f"{i}) [{theme.get('name')}]"
+            row: str = f"{j}) [{theme.name}]"
-            menu += f"| {row:<53} |\n"
+            menu += f"║ {row:<53} ║\n"
         print(menu, end="")
 
     def load_themes(self) -> List[ThemeData]:
         with urllib.request.urlopen(self.THEMES_URL) as response:
             themes: List[ThemeData] = []
-            csv_data: str = response.read().decode().splitlines()
+            content: str = response.read().decode()
-            csv_reader = csv.DictReader(csv_data, delimiter=",")
+            csv_data: List[str] = content.splitlines()
+            fieldnames = ["name", "short_note", "author", "repo"]
+            csv_reader = csv.DictReader(csv_data, fieldnames=fieldnames, delimiter=",")
+            next(csv_reader)  # skip the header of the csv file
             for row in csv_reader:
-                row: ThemeData = row
+                row: Dict[str, str]  # type: ignore
-                themes.append(row)
+                theme: ThemeData = ThemeData(**row)
+                themes.append(theme)
 
         return themes
 
-    def install_theme(self, **kwargs):
+    def install_theme(self, **kwargs: Any):
-        index = int(kwargs.get("opt_index"))
+        opt_index: str | None = kwargs.get("opt_index", None)
+
+        if not opt_index:
+            raise ValueError("No option index provided")
+
+        index: int = int(opt_index)
         theme_data: ThemeData = self.themes[index]
-        theme_author: str = theme_data.get("author")
+        theme_author: str = theme_data.author
-        theme_repo: str = theme_data.get("repo")
+        theme_repo: str = theme_data.repo
         theme_repo_url: str = f"https://github.com/{theme_author}/{theme_repo}"
 
         print_instance_overview(
@@ -148,13 +160,13 @@ class MainsailThemeInstallMenu(BaseMenu):
         for printer in printer_list:
             git_clone_wrapper(theme_repo_url, printer.cfg_dir.joinpath(".theme"))
 
-        if len(theme_data.get("short_note", "")) > 1:
+        if len(theme_data.short_note) > 1:
             Logger.print_warn("Info from the creator:", prefix=False, start="\n")
-            Logger.print_info(theme_data.get("short_note"), prefix=False, end="\n\n")
+            Logger.print_info(theme_data.short_note, prefix=False, end="\n\n")
 
 
 def get_printer_selection(
-    instances: List[BaseInstance], is_install: bool
+    instances: List[InstanceType], is_install: bool
 ) -> Union[List[BaseInstance], None]:
     options = [str(i) for i in range(len(instances))]
     options.extend(["a", "b"])

kiauh/extensions/obico/__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
+
+MODULE_PATH = Path(__file__).resolve().parent
+
+# repo
+OBICO_REPO = "https://github.com/TheSpaghettiDetective/moonraker-obico.git"
+
+# names
+OBICO_SERVICE_NAME = "moonraker-obico.service"
+OBICO_ENV_FILE_NAME = "moonraker-obico.env"
+OBICO_CFG_NAME = "moonraker-obico.cfg"
+OBICO_CFG_SAMPLE_NAME = "moonraker-obico.cfg.sample"
+OBICO_LOG_NAME = "moonraker-obico.log"
+OBICO_UPDATE_CFG_NAME = "moonraker-obico-update.cfg"
+OBICO_UPDATE_CFG_SAMPLE_NAME = "moonraker-obico-update.cfg.sample"
+OBICO_MACROS_CFG_NAME = "moonraker_obico_macros.cfg"
+
+# directories
+OBICO_DIR = Path.home().joinpath("moonraker-obico")
+OBICO_ENV_DIR = Path.home().joinpath("moonraker-obico-env")
+
+# files
+OBICO_SERVICE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{OBICO_SERVICE_NAME}")
+OBICO_ENV_FILE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{OBICO_ENV_FILE_NAME}")
+OBICO_LINK_SCRIPT = OBICO_DIR.joinpath("scripts/link.sh")
+OBICO_REQ_FILE = OBICO_DIR.joinpath("requirements.txt")

kiauh/extensions/obico/moonraker_obico.py

@@ -6,130 +6,86 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
+from dataclasses import dataclass, field
 from pathlib import Path
-from subprocess import DEVNULL, CalledProcessError, run
+from subprocess import CalledProcessError, run
-from typing import List
 
+from components.moonraker.moonraker import Moonraker
+from core.constants import CURRENT_USER
 from core.instance_manager.base_instance import BaseInstance
+from core.logger import Logger
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
-from utils.constants import SYSTEMD
+from extensions.obico import (
-from utils.logger import Logger
+    OBICO_CFG_NAME,
-
+    OBICO_DIR,
-MODULE_PATH = Path(__file__).resolve().parent
+    OBICO_ENV_DIR,
-
+    OBICO_ENV_FILE_NAME,
-OBICO_DIR = Path.home().joinpath("moonraker-obico")
+    OBICO_ENV_FILE_TEMPLATE,
-OBICO_ENV = Path.home().joinpath("moonraker-obico-env")
+    OBICO_LINK_SCRIPT,
-OBICO_REPO = "https://github.com/TheSpaghettiDetective/moonraker-obico.git"
+    OBICO_LOG_NAME,
-
+    OBICO_SERVICE_TEMPLATE,
-OBICO_CFG = "moonraker-obico.cfg"
+)
-OBICO_CFG_SAMPLE = "moonraker-obico.cfg.sample"
+from utils.fs_utils import create_folders
-OBICO_LOG = "moonraker-obico.log"
+from utils.sys_utils import get_service_file_path
-OBICO_UPDATE_CFG = "moonraker-obico-update.cfg"
-OBICO_UPDATE_CFG_SAMPLE = "moonraker-obico-update.cfg.sample"
-OBICO_MACROS_CFG = "moonraker_obico_macros.cfg"
 
 
 # noinspection PyMethodMayBeStatic
-class MoonrakerObico(BaseInstance):
+@dataclass(repr=True)
-    @classmethod
+class MoonrakerObico:
-    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 = OBICO_LOG_NAME
+    dir: Path = OBICO_DIR
+    env_dir: Path = OBICO_ENV_DIR
+    data_dir: Path = field(init=False)
+    cfg_file: Path = field(init=False)
+    is_linked: bool = False
 
-    def __init__(self, suffix: str = ""):
+    def __post_init__(self):
-        super().__init__(instance_type=self, suffix=suffix)
+        self.base: BaseInstance = BaseInstance(Moonraker, self.suffix)
-        self.dir: Path = OBICO_DIR
+        self.base.log_file_name = self.log_file_name
-        self.env_dir: Path = OBICO_ENV
-        self._cfg_file = self.cfg_dir.joinpath("moonraker-obico.cfg")
-        self._log = self.log_dir.joinpath("moonraker-obico.log")
-        self._is_linked: bool = self._check_link_status()
-        self._assets_dir = MODULE_PATH.joinpath("assets")
 
-    @property
+        self.service_file_path: Path = get_service_file_path(
-    def cfg_file(self) -> Path:
+            MoonrakerObico, self.suffix
-        return self._cfg_file
+        )
-
+        self.data_dir: Path = self.base.data_dir
-    @property
+        self.cfg_file = self.base.cfg_dir.joinpath(OBICO_CFG_NAME)
-    def log(self) -> Path:
+        self.is_linked: bool = self._check_link_status()
-        return self._log
-
-    @property
-    def is_linked(self) -> bool:
-        return self._is_linked
 
     def create(self) -> None:
+        from utils.sys_utils import create_env_file, create_service_file
+
         Logger.print_status("Creating new Obico for Klipper Instance ...")
-        service_template_path = MODULE_PATH.joinpath("assets/moonraker-obico.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/moonraker-obico.env")
-        env_file_target = self.sysd_dir.joinpath("moonraker-obico.env")
 
         try:
-            self.create_folders()
+            create_folders(self.base.base_folders)
-            self.write_service_file(
+            create_service_file(
-                service_template_path, service_file_target, env_file_target
+                name=self.service_file_path.name,
+                content=self._prep_service_file_content(),
+            )
+            create_env_file(
+                path=self.base.sysd_dir.joinpath(OBICO_ENV_FILE_NAME),
+                content=self._prep_env_file_content(),
             )
-            self.write_env_file(env_template_file_path, env_file_target)
 
         except CalledProcessError as e:
-            Logger.print_error(
+            Logger.print_error(f"Error creating instance: {e}")
-                f"Error creating service file {service_file_target}: {e}"
-            )
             raise
         except OSError as e:
-            Logger.print_error(f"Error creating env file {env_file_target}: {e}")
+            Logger.print_error(f"Error creating env file: {e}")
             raise
 
-    def delete(self) -> None:
-        service_file = self.get_service_file_name(extension=True)
-        service_file_path = self.get_service_file_path()
-
-        Logger.print_status(f"Deleting Obico for Klipper Instance: {service_file}")
-
-        try:
-            command = ["sudo", "rm", "-f", service_file_path]
-            run(command, check=True)
-            Logger.print_ok(f"Service file deleted: {service_file_path}")
-        except 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]
-        run(
-            command,
-            input=service_content.encode(),
-            stdout=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 link(self) -> None:
         Logger.print_status(
-            f"Linking instance for printer {self.data_dir_name} to the Obico server ..."
+            f"Linking instance for printer {self.data_dir.name} to the Obico server ..."
         )
         try:
-            script = OBICO_DIR.joinpath("scripts/link.sh")
+            cmd = [f"{OBICO_LINK_SCRIPT} -q -c {self.cfg_file}"]
-            cmd = [f"{script} -q -c {self.cfg_file}"]
             if self.suffix:
                 cmd.append(f"-n {self.suffix}")
             run(cmd, check=True, shell=True)
@@ -137,40 +93,51 @@ class MoonrakerObico(BaseInstance):
             Logger.print_error(f"Error during Obico linking: {e}")
             raise
 
-    def _prep_service_file(
+    def _prep_service_file_content(self) -> str:
-        self, service_template_path: Path, env_file_path: Path
+        template = OBICO_SERVICE_TEMPLATE
-    ) -> str:
+
         try:
-            with open(service_template_path, "r") as template_file:
+            with open(template, "r") as template_file:
                 template_content = template_file.read()
         except FileNotFoundError:
-            Logger.print_error(
+            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("%OBICO_DIR%", str(self.dir))
+        service_content = template_content.replace(
-        service_content = service_content.replace("%ENV%", str(self.env_dir))
+            "%USER%",
-        service_content = service_content.replace("%ENV_FILE%", str(env_file_path))
+            CURRENT_USER,
+        )
+        service_content = service_content.replace(
+            "%OBICO_DIR%",
+            self.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(OBICO_ENV_FILE_NAME).as_posix(),
+        )
         return service_content
 
-    def _prep_env_file(self, env_template_file_path: Path) -> str:
+    def _prep_env_file_content(self) -> str:
+        template = OBICO_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(
             "%CFG%",
-            f"{self.cfg_dir}/{self.cfg_file}",
+            f"{self.base.cfg_dir}/{self.cfg_file}",
         )
         return env_file_content
 
     def _check_link_status(self) -> bool:
-        if not self.cfg_file.exists():
+        if not self.cfg_file or not self.cfg_file.exists():
             return False
 
         scp = SimpleConfigParser()

kiauh/extensions/obico/moonraker_obico_extension.py

@@ -12,19 +12,22 @@ from typing import List
 from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
 from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
 from extensions.base_extension import BaseExtension
-from extensions.obico.moonraker_obico import (
+from extensions.obico import (
-    OBICO_CFG_SAMPLE,
+    OBICO_CFG_SAMPLE_NAME,
     OBICO_DIR,
-    OBICO_ENV,
+    OBICO_ENV_DIR,
-    OBICO_LOG,
+    OBICO_MACROS_CFG_NAME,
-    OBICO_MACROS_CFG,
     OBICO_REPO,
-    OBICO_UPDATE_CFG,
+    OBICO_REQ_FILE,
-    OBICO_UPDATE_CFG_SAMPLE,
+    OBICO_UPDATE_CFG_NAME,
+    OBICO_UPDATE_CFG_SAMPLE_NAME,
+)
+from extensions.obico.moonraker_obico import (
     MoonrakerObico,
 )
 from utils.common import check_install_dependencies, moonraker_exists
@@ -32,12 +35,13 @@ from utils.config_utils import (
     add_config_section,
     remove_config_section,
 )
-from utils.fs_utils import remove_file
+from utils.fs_utils import run_remove_routines
 from utils.git_utils import git_clone_wrapper, git_pull_wrapper
 from utils.input_utils import get_confirm, get_selection_input, get_string_input
-from utils.logger import DialogType, Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
     cmd_sysctl_manage,
+    cmd_sysctl_service,
     create_python_venv,
     install_python_requirements,
     parse_packages_from_file,
@@ -58,8 +62,7 @@ class ObicoExtension(BaseExtension):
         # if obico is already installed, ask if the user wants to repair an
         # incomplete installation or link to the obico server
         force_clone = False
-        obico_im = InstanceManager(MoonrakerObico)
+        obico_instances: List[MoonrakerObico] = get_instances(MoonrakerObico)
-        obico_instances: List[MoonrakerObico] = obico_im.instances
         if obico_instances:
             self._print_is_already_installed()
             options = ["l", "r", "b"]
@@ -78,10 +81,8 @@ class ObicoExtension(BaseExtension):
                 force_clone = True
 
         # let the user confirm installation
-        kl_im = InstanceManager(Klipper)
+        kl_instances: List[Klipper] = get_instances(Klipper)
-        kl_instances: List[Klipper] = kl_im.instances
+        mr_instances: List[Moonraker] = get_instances(Moonraker)
-        mr_im = InstanceManager(Moonraker)
-        mr_instances: List[Moonraker] = mr_im.instances
         self._print_moonraker_instances(mr_instances)
         if not get_confirm(
             "Continue Obico for Klipper installation?",
@@ -99,14 +100,13 @@ class ObicoExtension(BaseExtension):
 
             # create obico instances
             for moonraker in mr_instances:
-                current_instance = MoonrakerObico(suffix=moonraker.suffix)
+                instance = MoonrakerObico(suffix=moonraker.suffix)
+                instance.create()
 
-                obico_im.current_instance = current_instance
+                cmd_sysctl_service(instance.service_file_path.name, "enable")
-                obico_im.create_instance()
-                obico_im.enable_instance()
 
                 # create obico config
-                self._create_obico_cfg(current_instance, moonraker)
+                self._create_obico_cfg(instance, moonraker)
 
                 # create obico macros
                 self._create_obico_macros_cfg(moonraker)
@@ -114,17 +114,17 @@ class ObicoExtension(BaseExtension):
                 # create obico update manager
                 self._create_obico_update_manager_cfg(moonraker)
 
-                obico_im.start_instance()
+                cmd_sysctl_service(instance.service_file_path.name, "start")
 
             cmd_sysctl_manage("daemon-reload")
 
             # add to klippers config
             self._patch_printer_cfg(kl_instances)
-            kl_im.restart_all_instance()
+            InstanceManager.restart_all(kl_instances)
 
             # add to moonraker update manager
             self._patch_moonraker_conf(mr_instances)
-            mr_im.restart_all_instance()
+            InstanceManager.restart_all(mr_instances)
 
             # check linking of / ask for linking instances
             self._check_and_opt_link_instances()
@@ -141,13 +141,13 @@ class ObicoExtension(BaseExtension):
     def update_extension(self, **kwargs) -> None:
         Logger.print_status("Updating Obico for Klipper ...")
         try:
-            tb_im = InstanceManager(MoonrakerObico)
+            instances = get_instances(MoonrakerObico)
-            tb_im.stop_all_instance()
+            InstanceManager.stop_all(instances)
 
             git_pull_wrapper(OBICO_REPO, OBICO_DIR)
             self._install_dependencies()
 
-            tb_im.start_all_instance()
+            InstanceManager.start_all(instances)
             Logger.print_ok("Obico for Klipper successfully updated!")
 
         except Exception as e:
@@ -155,20 +155,17 @@ class ObicoExtension(BaseExtension):
 
     def remove_extension(self, **kwargs) -> None:
         Logger.print_status("Removing Obico for Klipper ...")
-        kl_im = InstanceManager(Klipper)
+
-        kl_instances: List[Klipper] = kl_im.instances
+        kl_instances: List[Klipper] = get_instances(Klipper)
-        mr_im = InstanceManager(Moonraker)
+        mr_instances: List[Moonraker] = get_instances(Moonraker)
-        mr_instances: List[Moonraker] = mr_im.instances
+        ob_instances: List[MoonrakerObico] = get_instances(MoonrakerObico)
-        ob_im = InstanceManager(MoonrakerObico)
-        ob_instances: List[MoonrakerObico] = ob_im.instances
 
         try:
-            self._remove_obico_instances(ob_im, ob_instances)
+            self._remove_obico_instances(ob_instances)
             self._remove_obico_dir()
             self._remove_obico_env()
-            remove_config_section(f"include {OBICO_MACROS_CFG}", kl_instances)
+            remove_config_section(f"include {OBICO_MACROS_CFG_NAME}", kl_instances)
-            remove_config_section(f"include {OBICO_UPDATE_CFG}", mr_instances)
+            remove_config_section(f"include {OBICO_UPDATE_CFG_NAME}", mr_instances)
-            self._delete_obico_logs(ob_instances)
             Logger.print_dialog(
                 DialogType.SUCCESS,
                 ["Obico for Klipper successfully removed!"],
@@ -196,8 +193,8 @@ class ObicoExtension(BaseExtension):
             ],
         )
 
-    def _print_moonraker_instances(self, mr_instances) -> None:
+    def _print_moonraker_instances(self, mr_instances: List[Moonraker]) -> None:
-        mr_names = [f"● {moonraker.data_dir_name}" for moonraker in mr_instances]
+        mr_names = [f"● {moonraker.data_dir.name}" for moonraker in mr_instances]
         if len(mr_names) > 1:
             Logger.print_dialog(
                 DialogType.INFO,
@@ -236,37 +233,36 @@ class ObicoExtension(BaseExtension):
         # install dependencies
         script = OBICO_DIR.joinpath("install.sh")
         package_list = parse_packages_from_file(script)
-        check_install_dependencies(package_list)
+        check_install_dependencies({*package_list})
 
         # create virtualenv
-        create_python_venv(OBICO_ENV)
+        if create_python_venv(OBICO_ENV_DIR):
-        requirements = OBICO_DIR.joinpath("requirements.txt")
+            install_python_requirements(OBICO_ENV_DIR, OBICO_REQ_FILE)
-        install_python_requirements(OBICO_ENV, requirements)
 
-    def _create_obico_macros_cfg(self, moonraker) -> None:
+    def _create_obico_macros_cfg(self, moonraker: Moonraker) -> None:
-        macros_cfg = OBICO_DIR.joinpath(f"include_cfgs/{OBICO_MACROS_CFG}")
+        macros_cfg = OBICO_DIR.joinpath(f"include_cfgs/{OBICO_MACROS_CFG_NAME}")
-        macros_target = moonraker.cfg_dir.joinpath(OBICO_MACROS_CFG)
+        macros_target = moonraker.base.cfg_dir.joinpath(OBICO_MACROS_CFG_NAME)
         if not macros_target.exists():
             shutil.copy(macros_cfg, macros_target)
         else:
             Logger.print_info(
-                f"Obico's '{OBICO_MACROS_CFG}' in {moonraker.cfg_dir} already exists! Skipped ..."
+                f"Obico's '{OBICO_MACROS_CFG_NAME}' in {moonraker.base.cfg_dir} already exists! Skipped ..."
             )
 
-    def _create_obico_update_manager_cfg(self, moonraker) -> None:
+    def _create_obico_update_manager_cfg(self, moonraker: Moonraker) -> None:
-        update_cfg = OBICO_DIR.joinpath(OBICO_UPDATE_CFG_SAMPLE)
+        update_cfg = OBICO_DIR.joinpath(OBICO_UPDATE_CFG_SAMPLE_NAME)
-        update_cfg_target = moonraker.cfg_dir.joinpath(OBICO_UPDATE_CFG)
+        update_cfg_target = moonraker.base.cfg_dir.joinpath(OBICO_UPDATE_CFG_NAME)
         if not update_cfg_target.exists():
             shutil.copy(update_cfg, update_cfg_target)
         else:
             Logger.print_info(
-                f"Obico's '{OBICO_UPDATE_CFG}' in {moonraker.cfg_dir} already exists! Skipped ..."
+                f"Obico's '{OBICO_UPDATE_CFG_NAME}' in {moonraker.base.cfg_dir} already exists! Skipped ..."
             )
 
     def _create_obico_cfg(
         self, current_instance: MoonrakerObico, moonraker: Moonraker
     ) -> None:
-        cfg_template = OBICO_DIR.joinpath(OBICO_CFG_SAMPLE)
+        cfg_template = OBICO_DIR.joinpath(OBICO_CFG_SAMPLE_NAME)
         cfg_target_file = current_instance.cfg_file
 
         if not cfg_template.exists():
@@ -280,7 +276,7 @@ class ObicoExtension(BaseExtension):
             self._patch_obico_cfg(moonraker, current_instance)
         else:
             Logger.print_info(
-                f"Obico config in {current_instance.cfg_dir} already exists! Skipped ..."
+                f"Obico config in {current_instance.base.cfg_dir} already exists! Skipped ..."
             )
 
     def _patch_obico_cfg(self, moonraker: Moonraker, obico: MoonrakerObico) -> None:
@@ -288,23 +284,31 @@ class ObicoExtension(BaseExtension):
         scp.read(obico.cfg_file)
         scp.set("server", "url", self.server_url)
         scp.set("moonraker", "port", str(moonraker.port))
-        scp.set("logging", "path", str(obico.log))
+        scp.set(
+            "logging",
+            "path",
+            obico.base.log_dir.joinpath(obico.log_file_name).as_posix(),
+        )
         scp.write(obico.cfg_file)
 
     def _patch_printer_cfg(self, klipper: List[Klipper]) -> None:
-        add_config_section(section=f"include {OBICO_MACROS_CFG}", instances=klipper)
+        add_config_section(
+            section=f"include {OBICO_MACROS_CFG_NAME}", instances=klipper
+        )
 
     def _patch_moonraker_conf(self, instances: List[Moonraker]) -> None:
-        add_config_section(section=f"include {OBICO_UPDATE_CFG}", instances=instances)
+        add_config_section(
+            section=f"include {OBICO_UPDATE_CFG_NAME}", instances=instances
+        )
 
-    def _link_obico_instances(self, unlinked_instances):
+    def _link_obico_instances(self, unlinked_instances) -> None:
         for obico in unlinked_instances:
             obico.link()
 
-    def _check_and_opt_link_instances(self):
+    def _check_and_opt_link_instances(self) -> None:
         Logger.print_status("Checking link status of Obico instances ...")
-        ob_im = InstanceManager(MoonrakerObico)
+
-        ob_instances: List[MoonrakerObico] = ob_im.instances
+        ob_instances: List[MoonrakerObico] = get_instances(MoonrakerObico)
         unlinked_instances: List[MoonrakerObico] = [
             obico for obico in ob_instances if not obico.is_linked
         ]
@@ -314,7 +318,7 @@ class ObicoExtension(BaseExtension):
                 [
                     "The Obico instances for the following printers are not "
                     "linked to the server:",
-                    *[f"● {obico.data_dir_name}" for obico in unlinked_instances],
+                    *[f"● {obico.data_dir.name}" for obico in unlinked_instances],
                     "\n\n",
                     "It will take only 10 seconds to link the printer to the Obico server.",
                     "For more information visit:",
@@ -332,7 +336,6 @@ class ObicoExtension(BaseExtension):
 
     def _remove_obico_instances(
         self,
-        instance_manager: InstanceManager,
         instance_list: List[MoonrakerObico],
     ) -> None:
         if not instance_list:
@@ -341,44 +344,24 @@ class ObicoExtension(BaseExtension):
 
         for instance in instance_list:
             Logger.print_status(
-                f"Removing instance {instance.get_service_file_name()} ..."
+                f"Removing instance {instance.service_file_path.stem} ..."
             )
-            instance_manager.current_instance = instance
+            InstanceManager.remove(instance)
-            instance_manager.stop_instance()
-            instance_manager.disable_instance()
-            instance_manager.delete_instance()
-
-        cmd_sysctl_manage("daemon-reload")
 
     def _remove_obico_dir(self) -> None:
+        Logger.print_status("Removing Obico for Klipper directory ...")
+
         if not OBICO_DIR.exists():
             Logger.print_info(f"'{OBICO_DIR}' does not exist. Skipped ...")
             return
 
-        try:
+        run_remove_routines(OBICO_DIR)
-            shutil.rmtree(OBICO_DIR)
-        except OSError as e:
-            Logger.print_error(f"Unable to delete '{OBICO_DIR}':\n{e}")
 
     def _remove_obico_env(self) -> None:
-        if not OBICO_ENV.exists():
+        Logger.print_status("Removing Obico for Klipper environment ...")
-            Logger.print_info(f"'{OBICO_ENV}' does not exist. Skipped ...")
+
+        if not OBICO_ENV_DIR.exists():
+            Logger.print_info(f"'{OBICO_ENV_DIR}' does not exist. Skipped ...")
             return
 
-        try:
+        run_remove_routines(OBICO_ENV_DIR)
-            shutil.rmtree(OBICO_ENV)
-        except OSError as e:
-            Logger.print_error(f"Unable to delete '{OBICO_ENV}':\n{e}")
-
-    def _delete_obico_logs(self, instances: List[MoonrakerObico]) -> None:
-        Logger.print_status("Removing Obico logs ...")
-        all_logfiles = []
-        for instance in instances:
-            all_logfiles = list(instance.log_dir.glob(f"{OBICO_LOG}*"))
-        if not all_logfiles:
-            Logger.print_info("No Obico logs found. Skipped ...")
-            return
-
-        for log in all_logfiles:
-            Logger.print_status(f"Remove '{log}'")
-            remove_file(log)

kiauh/extensions/pretty_gcode/pretty_gcode_extension.py

@@ -9,16 +9,16 @@
 import shutil
 from pathlib import Path
 
+from components.webui_client.client_utils import create_nginx_cfg
+from core.constants import NGINX_SITES_AVAILABLE, NGINX_SITES_ENABLED
+from core.logger import DialogType, Logger
 from extensions.base_extension import BaseExtension
-from utils import NGINX_SITES_AVAILABLE, NGINX_SITES_ENABLED
 from utils.common import check_install_dependencies
 from utils.fs_utils import (
-    create_nginx_cfg,
     remove_file,
 )
 from utils.git_utils import git_clone_wrapper, git_pull_wrapper
 from utils.input_utils import get_number_input
-from utils.logger import DialogType, Logger
 from utils.sys_utils import cmd_sysctl_service, get_ipv4_addr
 
 MODULE_PATH = Path(__file__).resolve().parent
@@ -48,17 +48,14 @@ class PrettyGcodeExtension(BaseExtension):
             allow_go_back=True,
         )
 
-        check_install_dependencies(["nginx"])
+        check_install_dependencies({"nginx"})
 
         try:
-            # remove any existing pgc dir
             if PGC_DIR.exists():
                 shutil.rmtree(PGC_DIR)
 
-            # clone pgc repo
             git_clone_wrapper(PGC_REPO, PGC_DIR)
 
-            # copy pgc conf
             create_nginx_cfg(
                 "PrettyGCode for Klipper",
                 cfg_name=PGC_CONF,

kiauh/extensions/telegram_bot/__init__.py

@@ -0,0 +1,29 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from pathlib import Path
+
+MODULE_PATH = Path(__file__).resolve().parent
+
+# repo
+TG_BOT_REPO = "https://github.com/nlef/moonraker-telegram-bot.git"
+
+# names
+TG_BOT_CFG_NAME = "telegram.conf"
+TG_BOT_LOG_NAME = "telegram.log"
+TG_BOT_SERVICE_NAME = "moonraker-telegram-bot.service"
+TG_BOT_ENV_FILE_NAME = "moonraker-telegram-bot.env"
+
+# directories
+TG_BOT_DIR = Path.home().joinpath("moonraker-telegram-bot")
+TG_BOT_ENV = Path.home().joinpath("moonraker-telegram-bot-env")
+
+# files
+TG_BOT_SERVICE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{TG_BOT_SERVICE_NAME}")
+TG_BOT_ENV_FILE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{TG_BOT_ENV_FILE_NAME}")
+TG_BOT_REQ_FILE = TG_BOT_DIR.joinpath("scripts/requirements.txt")

kiauh/extensions/telegram_bot/moonraker_telegram_bot.py

@@ -6,148 +6,122 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
+from dataclasses import dataclass, field
 from pathlib import Path
-from subprocess import DEVNULL, CalledProcessError, run
+from subprocess import CalledProcessError
-from typing import List
 
+from components.moonraker.moonraker import Moonraker
+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 extensions.telegram_bot import (
-
+    TG_BOT_CFG_NAME,
-MODULE_PATH = Path(__file__).resolve().parent
+    TG_BOT_DIR,
-
+    TG_BOT_ENV,
-TELEGRAM_BOT_DIR = Path.home().joinpath("moonraker-telegram-bot")
+    TG_BOT_ENV_FILE_NAME,
-TELEGRAM_BOT_ENV = Path.home().joinpath("moonraker-telegram-bot-env")
+    TG_BOT_ENV_FILE_TEMPLATE,
-TELEGRAM_BOT_REPO = "https://github.com/nlef/moonraker-telegram-bot.git"
+    TG_BOT_LOG_NAME,
+    TG_BOT_SERVICE_TEMPLATE,
+)
+from utils.fs_utils import create_folders
+from utils.sys_utils import get_service_file_path
 
 
 # noinspection PyMethodMayBeStatic
-class MoonrakerTelegramBot(BaseInstance):
+@dataclass(repr=True)
-    @classmethod
+class MoonrakerTelegramBot:
-    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 = TG_BOT_LOG_NAME
+    bot_dir: Path = TG_BOT_DIR
+    env_dir: Path = TG_BOT_ENV
+    data_dir: Path = field(init=False)
+    cfg_file: Path = field(init=False)
 
-    def __init__(self, suffix: str = ""):
+    def __post_init__(self):
-        super().__init__(instance_type=self, suffix=suffix)
+        self.base: BaseInstance = BaseInstance(Moonraker, self.suffix)
-        self.bot_dir: Path = TELEGRAM_BOT_DIR
+        self.base.log_file_name = self.log_file_name
-        self.env_dir: Path = TELEGRAM_BOT_ENV
-        self._cfg_file = self.cfg_dir.joinpath("telegram.conf")
-        self._log = self.log_dir.joinpath("telegram.log")
-        self._assets_dir = MODULE_PATH.joinpath("assets")
 
-    @property
+        self.service_file_path: Path = get_service_file_path(
-    def cfg_file(self) -> Path:
+            MoonrakerTelegramBot, self.suffix
-        return self._cfg_file
+        )
-
+        self.data_dir: Path = self.base.data_dir
-    @property
+        self.cfg_file = self.base.cfg_dir.joinpath(TG_BOT_CFG_NAME)
-    def log(self) -> Path:
-        return self._log
 
     def create(self) -> None:
+        from utils.sys_utils import create_env_file, create_service_file
+
         Logger.print_status("Creating new Moonraker Telegram Bot Instance ...")
-        service_template_path = MODULE_PATH.joinpath(
-            "assets/moonraker-telegram-bot.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/moonraker-telegram-bot.env"
-        )
-        env_file_target = self.sysd_dir.joinpath("moonraker-telegram-bot.env")
 
         try:
-            self.create_folders()
+            create_folders(self.base.base_folders)
-            self.write_service_file(
+            create_service_file(
-                service_template_path, service_file_target, env_file_target
+                name=self.service_file_path.name,
+                content=self._prep_service_file_content(),
+            )
+            create_env_file(
+                path=self.base.sysd_dir.joinpath(TG_BOT_ENV_FILE_NAME),
+                content=self._prep_env_file_content(),
             )
-            self.write_env_file(env_template_file_path, env_file_target)
 
         except CalledProcessError as e:
-            Logger.print_error(
+            Logger.print_error(f"Error creating instance: {e}")
-                f"Error creating service file {service_file_target}: {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 = TG_BOT_SERVICE_TEMPLATE
-        service_file_path = self.get_service_file_path()
-
-        Logger.print_status(f"Deleting Moonraker Telegram Bot Instance: {service_file}")
 
         try:
-            command = ["sudo", "rm", "-f", service_file_path]
+            with open(template, "r") as template_file:
-            run(command, check=True)
-            Logger.print_ok(f"Service file deleted: {service_file_path}")
-        except 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]
-        run(
-            command,
-            input=service_content.encode(),
-            stdout=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 = template_content.replace(
+            "%USER%",
+            CURRENT_USER,
+        )
         service_content = service_content.replace(
             "%TELEGRAM_BOT_DIR%",
-            str(self.bot_dir),
+            self.bot_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(TG_BOT_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 = TG_BOT_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(
             "%TELEGRAM_BOT_DIR%",
-            str(self.bot_dir),
+            self.bot_dir.as_posix(),
         )
         env_file_content = env_file_content.replace(
             "%CFG%",
-            f"{self.cfg_dir}/printer.cfg",
+            f"{self.base.cfg_dir}/printer.cfg",
+        )
+        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("%LOG%", str(self.log))
         return env_file_content

kiauh/extensions/telegram_bot/moonraker_telegram_bot_extension.py

@@ -12,11 +12,12 @@ from typing import List
 
 from components.moonraker.moonraker import Moonraker
 from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
 from extensions.base_extension import BaseExtension
+from extensions.telegram_bot import TG_BOT_REPO, TG_BOT_REQ_FILE
 from extensions.telegram_bot.moonraker_telegram_bot import (
-    TELEGRAM_BOT_DIR,
+    TG_BOT_DIR,
-    TELEGRAM_BOT_ENV,
+    TG_BOT_ENV,
-    TELEGRAM_BOT_REPO,
     MoonrakerTelegramBot,
 )
 from utils.common import check_install_dependencies
@@ -24,9 +25,10 @@ from utils.config_utils import add_config_section, remove_config_section
 from utils.fs_utils import remove_file
 from utils.git_utils import git_clone_wrapper, git_pull_wrapper
 from utils.input_utils import get_confirm
-from utils.logger import DialogType, Logger
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
     cmd_sysctl_manage,
+    cmd_sysctl_service,
     create_python_venv,
     install_python_requirements,
     parse_packages_from_file,
@@ -37,8 +39,8 @@ from utils.sys_utils import (
 class TelegramBotExtension(BaseExtension):
     def install_extension(self, **kwargs) -> None:
         Logger.print_status("Installing Moonraker Telegram Bot ...")
-        mr_im = InstanceManager(Moonraker)
+
-        mr_instances: List[Moonraker] = mr_im.instances
+        mr_instances: List[Moonraker] = get_instances(Moonraker)
         if not mr_instances:
             Logger.print_dialog(
                 DialogType.WARNING,
@@ -50,7 +52,9 @@ class TelegramBotExtension(BaseExtension):
             )
             return
 
-        instance_names = [f"● {instance.data_dir_name}" for instance in mr_instances]
+        instance_names = [
+            f"● {instance.service_file_path.name}" for instance in mr_instances
+        ]
         Logger.print_dialog(
             DialogType.INFO,
             [
@@ -70,37 +74,33 @@ class TelegramBotExtension(BaseExtension):
         create_example_cfg = get_confirm("Create example telegram.conf?")
 
         try:
-            git_clone_wrapper(TELEGRAM_BOT_REPO, TELEGRAM_BOT_DIR)
+            git_clone_wrapper(TG_BOT_REPO, TG_BOT_DIR)
             self._install_dependencies()
 
             # create and start services / create bot configs
             show_config_dialog = False
-            tb_im = InstanceManager(MoonrakerTelegramBot)
             tb_names = [mr_i.suffix for mr_i in mr_instances]
             for name in tb_names:
-                current_instance = MoonrakerTelegramBot(suffix=name)
+                instance = MoonrakerTelegramBot(suffix=name)
+                instance.create()
 
-                tb_im.current_instance = current_instance
+                cmd_sysctl_service(instance.service_file_path.name, "enable")
-                tb_im.create_instance()
-                tb_im.enable_instance()
 
                 if create_example_cfg:
                     Logger.print_status(
-                        f"Creating Telegram Bot config in {current_instance.cfg_dir} ..."
+                        f"Creating Telegram Bot config in {instance.base.cfg_dir} ..."
                     )
-                    template = TELEGRAM_BOT_DIR.joinpath(
+                    template = TG_BOT_DIR.joinpath("scripts/base_install_template")
-                        "scripts/base_install_template"
+                    target_file = instance.cfg_file
-                    )
-                    target_file = current_instance.cfg_file
                     if not target_file.exists():
                         show_config_dialog = True
                         run(["cp", template, target_file], check=True)
                     else:
                         Logger.print_info(
-                            f"Telegram Bot config in {current_instance.cfg_dir} already exists! Skipped ..."
+                            f"Telegram Bot config in {instance.base.cfg_dir} already exists! Skipped ..."
                         )
 
-                tb_im.start_instance()
+                cmd_sysctl_service(instance.service_file_path.name, "start")
 
             cmd_sysctl_manage("daemon-reload")
 
@@ -108,7 +108,7 @@ class TelegramBotExtension(BaseExtension):
             self._patch_bot_update_manager(mr_instances)
 
             # restart moonraker
-            mr_im.restart_all_instance()
+            InstanceManager.restart_all(mr_instances)
 
             if show_config_dialog:
                 Logger.print_dialog(
@@ -120,6 +120,7 @@ class TelegramBotExtension(BaseExtension):
                         "following wiki page for further information:",
                         "https://github.com/nlef/moonraker-telegram-bot/wiki",
                     ],
+                    margin_bottom=1,
                 )
 
             Logger.print_ok("Telegram Bot installation complete!")
@@ -130,23 +131,23 @@ class TelegramBotExtension(BaseExtension):
 
     def update_extension(self, **kwargs) -> None:
         Logger.print_status("Updating Moonraker Telegram Bot ...")
-        tb_im = InstanceManager(MoonrakerTelegramBot)
-        tb_im.stop_all_instance()
 
-        git_pull_wrapper(TELEGRAM_BOT_REPO, TELEGRAM_BOT_DIR)
+        instances = get_instances(MoonrakerTelegramBot)
+        InstanceManager.stop_all(instances)
+
+        git_pull_wrapper(TG_BOT_REPO, TG_BOT_DIR)
         self._install_dependencies()
 
-        tb_im.start_all_instance()
+        InstanceManager.start_all(instances)
 
     def remove_extension(self, **kwargs) -> None:
         Logger.print_status("Removing Moonraker Telegram Bot ...")
-        mr_im = InstanceManager(Moonraker)
+
-        mr_instances: List[Moonraker] = mr_im.instances
+        mr_instances: List[Moonraker] = get_instances(Moonraker)
-        tb_im = InstanceManager(MoonrakerTelegramBot)
+        tb_instances: List[MoonrakerTelegramBot] = get_instances(MoonrakerTelegramBot)
-        tb_instances: List[MoonrakerTelegramBot] = tb_im.instances
 
         try:
-            self._remove_bot_instances(tb_im, tb_instances)
+            self._remove_bot_instances(tb_instances)
             self._remove_bot_dir()
             self._remove_bot_env()
             remove_config_section("update_manager moonraker-telegram-bot", mr_instances)
@@ -158,24 +159,23 @@ class TelegramBotExtension(BaseExtension):
 
     def _install_dependencies(self) -> None:
         # install dependencies
-        script = TELEGRAM_BOT_DIR.joinpath("scripts/install.sh")
+        script = TG_BOT_DIR.joinpath("scripts/install.sh")
         package_list = parse_packages_from_file(script)
-        check_install_dependencies(package_list)
+        check_install_dependencies({*package_list})
 
         # create virtualenv
-        create_python_venv(TELEGRAM_BOT_ENV)
+        if create_python_venv(TG_BOT_ENV):
-        requirements = TELEGRAM_BOT_DIR.joinpath("scripts/requirements.txt")
+            install_python_requirements(TG_BOT_ENV, TG_BOT_REQ_FILE)
-        install_python_requirements(TELEGRAM_BOT_ENV, requirements)
 
     def _patch_bot_update_manager(self, instances: List[Moonraker]) -> None:
-        env_py = f"{TELEGRAM_BOT_ENV}/bin/python"
+        env_py = f"{TG_BOT_ENV}/bin/python"
         add_config_section(
             section="update_manager moonraker-telegram-bot",
             instances=instances,
             options=[
                 ("type", "git_repo"),
-                ("path", str(TELEGRAM_BOT_DIR)),
+                ("path", str(TG_BOT_DIR)),
-                ("orgin", TELEGRAM_BOT_REPO),
+                ("orgin", TG_BOT_REPO),
                 ("env", env_py),
                 ("requirements", "scripts/requirements.txt"),
                 ("install_script", "scripts/install.sh"),
@@ -184,44 +184,38 @@ class TelegramBotExtension(BaseExtension):
 
     def _remove_bot_instances(
         self,
-        instance_manager: InstanceManager,
         instance_list: List[MoonrakerTelegramBot],
     ) -> None:
         for instance in instance_list:
             Logger.print_status(
-                f"Removing instance {instance.get_service_file_name()} ..."
+                f"Removing instance {instance.service_file_path.stem} ..."
             )
-            instance_manager.current_instance = instance
+            InstanceManager.remove(instance)
-            instance_manager.stop_instance()
-            instance_manager.disable_instance()
-            instance_manager.delete_instance()
-
-        cmd_sysctl_manage("daemon-reload")
 
     def _remove_bot_dir(self) -> None:
-        if not TELEGRAM_BOT_DIR.exists():
+        if not TG_BOT_DIR.exists():
-            Logger.print_info(f"'{TELEGRAM_BOT_DIR}' does not exist. Skipped ...")
+            Logger.print_info(f"'{TG_BOT_DIR}' does not exist. Skipped ...")
             return
 
         try:
-            shutil.rmtree(TELEGRAM_BOT_DIR)
+            shutil.rmtree(TG_BOT_DIR)
         except OSError as e:
-            Logger.print_error(f"Unable to delete '{TELEGRAM_BOT_DIR}':\n{e}")
+            Logger.print_error(f"Unable to delete '{TG_BOT_DIR}':\n{e}")
 
     def _remove_bot_env(self) -> None:
-        if not TELEGRAM_BOT_ENV.exists():
+        if not TG_BOT_ENV.exists():
-            Logger.print_info(f"'{TELEGRAM_BOT_ENV}' does not exist. Skipped ...")
+            Logger.print_info(f"'{TG_BOT_ENV}' does not exist. Skipped ...")
             return
 
         try:
-            shutil.rmtree(TELEGRAM_BOT_ENV)
+            shutil.rmtree(TG_BOT_ENV)
         except OSError as e:
-            Logger.print_error(f"Unable to delete '{TELEGRAM_BOT_ENV}':\n{e}")
+            Logger.print_error(f"Unable to delete '{TG_BOT_ENV}':\n{e}")
 
     def _delete_bot_logs(self, instances: List[MoonrakerTelegramBot]) -> None:
         all_logfiles = []
         for instance in instances:
-            all_logfiles = list(instance.log_dir.glob("telegram_bot.log*"))
+            all_logfiles = list(instance.base.log_dir.glob("telegram_bot.log*"))
         if not all_logfiles:
             Logger.print_info("No Moonraker Telegram Bot logs found. Skipped ...")
             return

kiauh/main.py

@@ -7,12 +7,12 @@
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
 
+from core.logger import Logger
 from core.menus.main_menu import MainMenu
 from core.settings.kiauh_settings import KiauhSettings
-from utils.logger import Logger
 
 
-def main():
+def main() -> None:
     try:
         KiauhSettings()
         MainMenu().run()

kiauh/procedures/system.py

@@ -0,0 +1,103 @@
+# ======================================================================= #
+#  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 subprocess import PIPE, CalledProcessError, run
+
+from core.logger import DialogType, Logger
+from utils.common import check_install_dependencies, get_current_date
+from utils.fs_utils import check_file_exist
+from utils.input_utils import get_confirm, get_string_input
+
+
+def change_system_hostname() -> None:
+    """
+    Procedure to change the system hostname.
+    :return:
+    """
+
+    Logger.print_dialog(
+        DialogType.CUSTOM,
+        [
+            "Changing the hostname of this system allows you to access an installed "
+            "webinterface by simply typing the hostname like this in the browser:",
+            "\n\n",
+            "http://<hostname>.local",
+            "\n\n",
+            "Example: If you set your hostname to 'my-printer', you can access an "
+            "installed webinterface by tyoing 'http://my-printer.local' in the "
+            "browser.",
+        ],
+        custom_title="CHANGE SYSTEM HOSTNAME",
+    )
+    if not get_confirm("Do you want to change the hostname?", default_choice=False):
+        return
+
+    Logger.print_dialog(
+        DialogType.CUSTOM,
+        [
+            "Allowed characters: a-z, 0-9 and '-'",
+            "The name must not contain the following:",
+            "\n\n",
+            "● Any special characters",
+            "● No leading or trailing '-'",
+        ],
+    )
+    hostname = get_string_input(
+        "Enter the new hostname",
+        regex="^[a-z0-9]+([a-z0-9-]*[a-z0-9])?$",
+    )
+    if not get_confirm(f"Change the hostname to '{hostname}'?", default_choice=False):
+        Logger.print_info("Aborting hostname change ...")
+        return
+
+    try:
+        Logger.print_status("Changing hostname ...")
+
+        Logger.print_status("Checking for dependencies ...")
+        check_install_dependencies({"avahi-daemon"}, include_global=False)
+
+        # create or backup hosts file
+        Logger.print_status("Creating backup of hosts file ...")
+        hosts_file = Path("/etc/hosts")
+        if not check_file_exist(hosts_file, True):
+            cmd = ["sudo", "touch", hosts_file.as_posix()]
+            run(cmd, stderr=PIPE, check=True)
+        else:
+            date_time = get_current_date()
+            name = f"hosts.{date_time.get('date')}-{date_time.get('time')}.bak"
+            hosts_file_backup = Path(f"/etc/{name}")
+            cmd = [
+                "sudo",
+                "cp",
+                hosts_file.as_posix(),
+                hosts_file_backup.as_posix(),
+            ]
+            run(cmd, stderr=PIPE, check=True)
+        Logger.print_ok()
+
+        # call hostnamectl set-hostname <hostname>
+        Logger.print_status(f"Setting hostname to '{hostname}' ...")
+        cmd = ["sudo", "hostnamectl", "set-hostname", hostname]
+        run(cmd, stderr=PIPE, check=True)
+        Logger.print_ok()
+
+        # add hostname to hosts file at the end of the file
+        Logger.print_status("Writing new hostname to /etc/hosts ...")
+        stdin = f"127.0.0.1       {hostname}\n"
+        cmd = ["sudo", "tee", "-a", hosts_file.as_posix()]
+        run(cmd, input=stdin.encode(), stderr=PIPE, stdout=PIPE, check=True)
+        Logger.print_ok()
+
+        Logger.print_ok("New hostname successfully configured!")
+        Logger.print_ok("Remember to reboot for the changes to take effect!\n")
+
+    except CalledProcessError as e:
+        Logger.print_error(f"Error during change hostname procedure: {e}")
+        return

kiauh/utils/__init__.py

@@ -9,15 +9,4 @@
 
 from pathlib import Path
 
-from core.backup_manager import BACKUP_ROOT_DIR
-
 MODULE_PATH = Path(__file__).resolve().parent
-INVALID_CHOICE = "Invalid choice. Please select a valid value."
-PRINTER_CFG_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("printer-cfg-backups")
-
-GLOBAL_DEPS = ["git", "wget", "curl", "unzip", "dfu-util", "python3-virtualenv"]
-
-# ================== NGINX =====================#
-NGINX_SITES_AVAILABLE = Path("/etc/nginx/sites-available")
-NGINX_SITES_ENABLED = Path("/etc/nginx/sites-enabled")
-NGINX_CONFD = Path("/etc/nginx/conf.d")

kiauh/utils/common.py

@@ -11,24 +11,37 @@ from __future__ import annotations
 import re
 from datetime import datetime
 from pathlib import Path
-from typing import Dict, List, Literal, Optional, Type
+from typing import Dict, List, Literal, Optional, Set
 
 from components.klipper.klipper import Klipper
-from core.instance_manager.base_instance import BaseInstance
+from core.constants import (
-from core.instance_manager.instance_manager import InstanceManager
-from utils import GLOBAL_DEPS, PRINTER_CFG_BACKUP_DIR
-from utils.constants import (
     COLOR_CYAN,
+    GLOBAL_DEPS,
+    PRINTER_CFG_BACKUP_DIR,
     RESET_FORMAT,
 )
-from utils.git_utils import get_local_commit, get_remote_commit, get_repo_name
+from core.logger import DialogType, Logger
-from utils.logger import DialogType, Logger
+from core.types import ComponentStatus, StatusCode
+from utils.git_utils import (
+    get_local_commit,
+    get_local_tags,
+    get_remote_commit,
+    get_repo_name,
+)
+from utils.instance_utils import get_instances
 from utils.sys_utils import (
     check_package_install,
     install_system_packages,
     update_system_package_lists,
 )
-from utils.types import ComponentStatus, StatusCode
+
+
+def get_kiauh_version() -> str:
+    """
+    Helper method to get the current KIAUH version by reading the latest tag
+    :return: string of the latest tag
+    """
+    return get_local_tags(Path(__file__).parent.parent)[-1]
 
 
 def convert_camelcase_to_kebabcase(name: str) -> str:
@@ -47,17 +60,23 @@ def get_current_date() -> Dict[Literal["date", "time"], str]:
     return {"date": date, "time": time}
 
 
-def check_install_dependencies(deps: List[str] | None = None) -> None:
+def check_install_dependencies(
+    deps: Set[str] | None = None, include_global: bool = True
+) -> None:
     """
     Common helper method to check if dependencies are installed
     and if not, install them automatically |
+    :param include_global: Wether to include the global dependencies or not
     :param deps: List of strings of package names to check if installed
     :return: None
     """
     if deps is None:
-        deps = []
+        deps = set()
 
-    requirements = check_package_install({*GLOBAL_DEPS, *deps})
+    if include_global:
+        deps.update(GLOBAL_DEPS)
+
+    requirements = check_package_install(deps)
     if requirements:
         Logger.print_status("Installing dependencies ...")
         Logger.print_info("The following packages need installation:")
@@ -70,7 +89,7 @@ def check_install_dependencies(deps: List[str] | None = None) -> None:
 def get_install_status(
     repo_dir: Path,
     env_dir: Optional[Path] = None,
-    instance_type: Optional[Type[BaseInstance]] = None,
+    instance_type: type | None = None,
     files: Optional[List[Path]] = None,
 ) -> ComponentStatus:
     """
@@ -81,27 +100,29 @@ def get_install_status(
     :param files: List of optional files to check for existence
     :return: Dictionary with status string, statuscode and instance count
     """
+    from utils.instance_utils import get_instances
+
     checks = [repo_dir.exists()]
 
     if env_dir is not None:
         checks.append(env_dir.exists())
 
-    im = InstanceManager(instance_type)
     instances = 0
     if instance_type is not None:
-        instances = len(im.instances)
+        instances = len(get_instances(instance_type))
         checks.append(instances > 0)
 
     if files is not None:
         for f in files:
             checks.append(f.exists())
 
+    status: StatusCode
     if all(checks):
-        status: StatusCode = 2  # installed
+        status = 2  # installed
     elif not any(checks):
-        status: StatusCode = 0  # not installed
+        status = 0  # not installed
     else:
-        status: StatusCode = 1  # incomplete
+        status = 1  # incomplete
 
     return ComponentStatus(
         status=status,
@@ -112,19 +133,18 @@ def get_install_status(
     )
 
 
-def backup_printer_config_dir():
+def backup_printer_config_dir() -> None:
     # local import to prevent circular import
     from core.backup_manager.backup_manager import BackupManager
 
-    im = InstanceManager(Klipper)
+    instances: List[Klipper] = get_instances(Klipper)
-    instances: List[Klipper] = im.instances
     bm = BackupManager()
 
     for instance in instances:
-        name = f"config-{instance.data_dir_name}"
+        name = f"config-{instance.data_dir.name}"
         bm.backup_directory(
             name,
-            source=instance.cfg_dir,
+            source=instance.base.cfg_dir,
             target=PRINTER_CFG_BACKUP_DIR,
         )
 
@@ -137,8 +157,7 @@ def moonraker_exists(name: str = "") -> bool:
     """
     from components.moonraker.moonraker import Moonraker
 
-    mr_im = InstanceManager(Moonraker)
+    mr_instances: List[Moonraker] = get_instances(Moonraker)
-    mr_instances: List[Moonraker] = mr_im.instances
 
     info = (
         f"{name} requires Moonraker to be installed"

kiauh/utils/config_utils.py

@@ -6,25 +6,25 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
+
 import tempfile
 from pathlib import Path
-from typing import List, Optional, Tuple, TypeVar
+from typing import List, Tuple
 
-from components.klipper.klipper import Klipper
+from core.instance_type import InstanceType
-from components.moonraker.moonraker import Moonraker
+from core.logger import Logger
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
-from utils.logger import Logger
 
-B = TypeVar("B", Klipper, Moonraker)
 ConfigOption = Tuple[str, str]
 
 
 def add_config_section(
     section: str,
-    instances: List[B],
+    instances: List[InstanceType],
-    options: Optional[List[ConfigOption]] = None,
+    options: List[ConfigOption] | None = None,
 ) -> None:
     for instance in instances:
         cfg_file = instance.cfg_file
@@ -49,7 +49,7 @@ def add_config_section(
         scp.write(cfg_file)
 
 
-def add_config_section_at_top(section: str, instances: List[B]):
+def add_config_section_at_top(section: str, instances: List[InstanceType]) -> None:
     # TODO: this could be implemented natively in SimpleConfigParser
     for instance in instances:
         tmp_cfg = tempfile.NamedTemporaryFile(mode="w", delete=False)
@@ -70,7 +70,7 @@ def add_config_section_at_top(section: str, instances: List[B]):
         tmp_cfg_path.rename(cfg_file)
 
 
-def remove_config_section(section: str, instances: List[B]) -> None:
+def remove_config_section(section: str, instances: List[InstanceType]) -> None:
     for instance in instances:
         cfg_file = instance.cfg_file
         Logger.print_status(f"Remove section '[{section}]' from '{cfg_file}' ...")

kiauh/utils/fs_utils.py

@@ -8,6 +8,7 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import re
 import shutil
@@ -16,15 +17,8 @@ from subprocess import DEVNULL, PIPE, CalledProcessError, check_output, run
 from typing import List
 from zipfile import ZipFile
 
-from components.klipper.klipper import Klipper
+from core.decorators import deprecated
-from utils import (
+from core.logger import Logger
-    MODULE_PATH,
-    NGINX_CONFD,
-    NGINX_SITES_AVAILABLE,
-    NGINX_SITES_ENABLED,
-)
-from utils.decorators import deprecated
-from utils.logger import Logger
 
 
 def check_file_exist(file_path: Path, sudo=False) -> bool:
@@ -36,7 +30,7 @@ def check_file_exist(file_path: Path, sudo=False) -> bool:
     """
     if sudo:
         try:
-            command = ["sudo", "find", file_path]
+            command = ["sudo", "find", file_path.as_posix()]
             check_output(command, stderr=DEVNULL)
             return True
         except CalledProcessError:
@@ -50,7 +44,7 @@ def check_file_exist(file_path: Path, sudo=False) -> bool:
 
 def create_symlink(source: Path, target: Path, sudo=False) -> None:
     try:
-        cmd = ["ln", "-sf", source, target]
+        cmd = ["ln", "-sf", source.as_posix(), target.as_posix()]
         if sudo:
             cmd.insert(0, "sudo")
         run(cmd, stderr=PIPE, check=True)
@@ -61,10 +55,10 @@ def create_symlink(source: Path, target: Path, sudo=False) -> None:
 
 def remove_with_sudo(file: Path) -> None:
     try:
-        cmd = ["sudo", "rm", "-rf", file]
+        cmd = ["sudo", "rm", "-rf", file.as_posix()]
         run(cmd, stderr=PIPE, check=True)
     except CalledProcessError as e:
-        Logger.print_error(f"Failed to remove file: {e}")
+        Logger.print_error(f"Failed to remove {file}: {e}")
         raise
 
 
@@ -81,23 +75,23 @@ def remove_file(file_path: Path, sudo=False) -> None:
 
 def run_remove_routines(file: Path) -> None:
     try:
-        if not file.exists():
+        if not file.is_symlink() and not file.exists():
             Logger.print_info(f"File '{file}' does not exist. Skipped ...")
             return
 
         if file.is_dir():
             shutil.rmtree(file)
-        elif file.is_file():
+        elif file.is_file() or file.is_symlink():
             file.unlink()
         else:
             raise OSError(f"File '{file}' is neither a file nor a directory!")
-        Logger.print_ok("Successfully removed!")
+        Logger.print_ok(f"File '{file}' was successfully removed!")
     except OSError as e:
         Logger.print_error(f"Unable to delete '{file}':\n{e}")
         try:
             Logger.print_info("Trying to remove with sudo ...")
             remove_with_sudo(file)
-            Logger.print_ok("Successfully removed!")
+            Logger.print_ok(f"File '{file}' was successfully removed!")
         except CalledProcessError as e:
             Logger.print_error(f"Error deleting '{file}' with sudo:\n{e}")
             Logger.print_error("Remove this directory manually!")
@@ -114,143 +108,35 @@ def unzip(filepath: Path, target_dir: Path) -> None:
         _zip.extractall(target_dir)
 
 
-def copy_upstream_nginx_cfg() -> None:
+def create_folders(dirs: List[Path]) -> 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]
+        for _dir in dirs:
-        run(command, stderr=PIPE, check=True)
+            if _dir.exists():
-    except CalledProcessError as e:
+                continue
-        log = f"Unable to create upstreams.conf: {e.stderr.decode()}"
+            _dir.mkdir(exist_ok=True)
-        Logger.print_error(log)
+            Logger.print_ok(f"Created directory '{_dir}'!")
+    except OSError as e:
+        Logger.print_error(f"Error creating directories: {e}")
         raise
 
 
-def copy_common_vars_nginx_cfg() -> None:
+def get_data_dir(instance_type: type, suffix: str) -> Path:
-    """
+    from utils.sys_utils import get_service_file_path
-    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
 
+    # if the service file exists, we read the data dir path from it
+    # this also ensures compatibility with pre v6.0.0 instances
+    service_file_path: Path = get_service_file_path(instance_type, suffix)
+    if service_file_path and service_file_path.exists():
+        with open(service_file_path, "r") as service_file:
+            lines = service_file.readlines()
+            for line in lines:
+                pattern = r"^EnvironmentFile=(.+)(/systemd/.+\.env)"
+                match = re.search(pattern, line)
+                if match:
+                    return Path(match.group(1))
 
-def generate_nginx_cfg_from_template(name: str, template_src: Path, **kwargs) -> None:
+    if suffix != "":
-    """
+        # this is the new data dir naming scheme introduced in v6.0.0
-    Creates an NGINX config from a template file and
+        return Path.home().joinpath(f"printer_{suffix}_data")
-    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():
+    return Path.home().joinpath("printer_data")
-            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():
-        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)
-
-
-def remove_nginx_config(name: str) -> None:
-    Logger.print_status(f"Removing NGINX config for {name.capitalize()} ...")
-
-    run_remove_routines(NGINX_SITES_AVAILABLE.joinpath(name))
-    run_remove_routines(NGINX_SITES_ENABLED.joinpath(name))
-
-
-def remove_nginx_logs(name: str, instances: List[Klipper]) -> None:
-    Logger.print_status(f"Removing NGINX logs for {name.capitalize()} ...")
-
-    run_remove_routines(Path(f"/var/log/nginx/{name}-access.log"))
-    run_remove_routines(Path(f"/var/log/nginx/{name}-error.log"))
-
-    if not instances:
-        return
-
-    for instance in instances:
-        run_remove_routines(instance.log_dir.joinpath(f"{name}-access.log"))
-        run_remove_routines(instance.log_dir.joinpath(f"{name}-error.log"))

kiauh/utils/git_utils.py

@@ -7,16 +7,17 @@ from http.client import HTTPResponse
 from json import JSONDecodeError
 from pathlib import Path
 from subprocess import DEVNULL, PIPE, CalledProcessError, check_output, run
-from typing import List, Optional, Type
+from typing import List, Type
 
-from core.instance_manager.base_instance import BaseInstance
 from core.instance_manager.instance_manager import InstanceManager
+from core.instance_type import InstanceType
+from core.logger import Logger
 from utils.input_utils import get_confirm, get_number_input
-from utils.logger import Logger
+from utils.instance_utils import get_instances
 
 
 def git_clone_wrapper(
-    repo: str, target_dir: Path, branch: Optional[str] = None, force: bool = False
+    repo: str, target_dir: Path, branch: str | None = None, force: bool = False
 ) -> None:
     """
     Clones a repository from the given URL and checks out the specified branch if given.
@@ -75,14 +76,46 @@ def get_repo_name(repo: Path) -> str | None:
         return "-"
 
     try:
-        cmd = ["git", "-C", repo, "config", "--get", "remote.origin.url"]
+        cmd = ["git", "-C", repo.as_posix(), "config", "--get", "remote.origin.url"]
-        result = check_output(cmd, stderr=DEVNULL)
+        result: str = check_output(cmd, stderr=DEVNULL).decode(encoding="utf-8")
-        return "/".join(result.decode().strip().split("/")[-2:])
+        substrings: List[str] = result.strip().split("/")[-2:]
+        return "/".join(substrings).replace(".git", "")
     except CalledProcessError:
         return None
 
 
-def get_tags(repo_path: str) -> List[str]:
+def get_local_tags(repo_path: Path, _filter: str | None = None) -> List[str]:
+    """
+    Get all tags of a local Git repository
+    :param repo_path: Path to the local Git repository
+    :param _filter: Optional filter to filter the tags by
+    :return: List of tags
+    """
+    try:
+        cmd = ["git", "tag", "-l"]
+
+        if _filter is not None:
+            cmd.append(f"'${_filter}'")
+
+        result: str = check_output(
+            cmd,
+            stderr=DEVNULL,
+            cwd=repo_path.as_posix(),
+        ).decode(encoding="utf-8")
+
+        tags = result.split("\n")
+        return tags[:-1]
+
+    except CalledProcessError:
+        return []
+
+
+def get_remote_tags(repo_path: str) -> List[str]:
+    """
+    Gets the tags of a GitHub repostiory
+    :param repo_path: path of the GitHub repository - e.g. `<owner>/<name>`
+    :return: List of tags
+    """
     try:
         url = f"https://api.github.com/repos/{repo_path}/tags"
         with urllib.request.urlopen(url) as r:
@@ -100,14 +133,14 @@ def get_tags(repo_path: str) -> List[str]:
         raise
 
 
-def get_latest_tag(repo_path: str) -> str:
+def get_latest_remote_tag(repo_path: str) -> str:
     """
     Gets the latest stable tag of a GitHub repostiory
     :param repo_path: path of the GitHub repository - e.g. `<owner>/<name>`
     :return: tag or empty string
     """
     try:
-        if len(latest_tag := get_tags(repo_path)) > 0:
+        if len(latest_tag := get_remote_tags(repo_path)) > 0:
             return latest_tag[0]
         else:
             return ""
@@ -122,7 +155,10 @@ def get_latest_unstable_tag(repo_path: str) -> str:
     :return: tag or empty string
     """
     try:
-        if len(unstable_tags := [t for t in get_tags(repo_path) if "-" in t]) > 0:
+        if (
+            len(unstable_tags := [t for t in get_remote_tags(repo_path) if "-" in t])
+            > 0
+        ):
             return unstable_tags[0]
         else:
             return ""
@@ -131,6 +167,34 @@ def get_latest_unstable_tag(repo_path: str) -> str:
         raise
 
 
+def compare_semver_tags(tag1: str, tag2: str) -> bool:
+    """
+    Compare two semver version strings.
+    Does not support comparing pre-release versions (e.g. 1.0.0-rc.1, 1.0.0-beta.1)
+    :param tag1: First version string
+    :param tag2: Second version string
+    :return: True if tag1 is greater than tag2, False otherwise
+    """
+    if tag1 == tag2:
+        return False
+
+    def parse_version(v):
+        return list(map(int, v[1:].split(".")))
+
+    tag1_parts = parse_version(tag1)
+    tag2_parts = parse_version(tag2)
+
+    max_len = max(len(tag1_parts), len(tag2_parts))
+    tag1_parts += [0] * (max_len - len(tag1_parts))
+    tag2_parts += [0] * (max_len - len(tag2_parts))
+
+    for part1, part2 in zip(tag1_parts, tag2_parts):
+        if part1 != part2:
+            return part1 > part2
+
+    return False
+
+
 def get_local_commit(repo: Path) -> str | None:
     if not repo.exists() or not repo.joinpath(".git").exists():
         return None
@@ -159,17 +223,18 @@ def get_remote_commit(repo: Path) -> str | None:
 
 def git_cmd_clone(repo: str, target_dir: Path) -> None:
     try:
-        command = ["git", "clone", repo, target_dir]
+        command = ["git", "clone", repo, target_dir.as_posix()]
         run(command, check=True)
 
         Logger.print_ok("Clone successful!")
     except CalledProcessError as e:
-        log = f"Error cloning repository {repo}: {e.stderr.decode()}"
+        error = e.stderr.decode() if e.stderr else "Unknown error"
+        log = f"Error cloning repository {repo}: {error}"
         Logger.print_error(log)
         raise
 
 
-def git_cmd_checkout(branch: str, target_dir: Path) -> None:
+def git_cmd_checkout(branch: str | None, target_dir: Path) -> None:
     if branch is None:
         return
 
@@ -194,15 +259,15 @@ def git_cmd_pull(target_dir: Path) -> None:
         raise
 
 
-def rollback_repository(repo_dir: Path, instance: Type[BaseInstance]) -> None:
+def rollback_repository(repo_dir: Path, instance: Type[InstanceType]) -> None:
     q1 = "How many commits do you want to roll back"
     amount = get_number_input(q1, 1, allow_go_back=True)
 
-    im = InstanceManager(instance)
+    instances = get_instances(instance)
 
     Logger.print_warn("Do not continue if you have ongoing prints!", start="\n")
     Logger.print_warn(
-        f"All currently running {im.instance_type.__name__} services will be stopped!"
+        f"All currently running {instance.__name__} services will be stopped!"
     )
     if not get_confirm(
         f"Roll back {amount} commit{'s' if amount > 1 else ''}",
@@ -212,7 +277,7 @@ def rollback_repository(repo_dir: Path, instance: Type[BaseInstance]) -> None:
         Logger.print_info("Aborting roll back ...")
         return
 
-    im.stop_all_instance()
+    InstanceManager.stop_all(instances)
 
     try:
         cmd = ["git", "reset", "--hard", f"HEAD~{amount}"]
@@ -221,4 +286,4 @@ def rollback_repository(repo_dir: Path, instance: Type[BaseInstance]) -> None:
     except CalledProcessError as e:
         Logger.print_error(f"An error occured during repo rollback:\n{e}")
 
-    im.start_all_instance()
+    InstanceManager.start_all(instances)

kiauh/utils/input_utils.py

@@ -9,11 +9,10 @@
 from __future__ import annotations
 
 import re
-from typing import Dict, List, Union
+from typing import Dict, List
 
-from utils import INVALID_CHOICE
+from core.constants import COLOR_CYAN, INVALID_CHOICE, RESET_FORMAT
-from utils.constants import COLOR_CYAN, RESET_FORMAT
+from core.logger import Logger
-from utils.logger import Logger
 
 
 def get_confirm(question: str, default_choice=True, allow_go_back=False) -> bool | None:
@@ -53,9 +52,9 @@ def get_confirm(question: str, default_choice=True, allow_go_back=False) -> bool
 def get_number_input(
     question: str,
     min_count: int,
-    max_count=None,
+    max_count: int | None = None,
-    default=None,
+    default: int | None = None,
-    allow_go_back=False,
+    allow_go_back: bool = False,
 ) -> int | None:
     """
     Helper method to get a number input from the user
@@ -73,7 +72,7 @@ def get_number_input(
         if allow_go_back and _input in options_go_back:
             return None
 
-        if _input == "":
+        if _input == "" and default is not None:
             return default
 
         try:
@@ -84,10 +83,10 @@ def get_number_input(
 
 def get_string_input(
     question: str,
-    regex: Union[str, None] = None,
+    regex: str | None = None,
-    exclude: Union[List, None] = None,
+    exclude: List[str] | None = None,
-    allow_special_chars=False,
+    allow_special_chars: bool = False,
-    default=None,
+    default: str | None = None,
 ) -> str:
     """
     Helper method to get a string input from the user
@@ -104,8 +103,6 @@ def get_string_input(
     while True:
         _input = input(_question)
 
-        print(_input)
-
         if _input.lower() in _exclude:
             Logger.print_error("This value is already in use/reserved.")
         elif default is not None and _input == "":
@@ -157,7 +154,7 @@ def format_question(question: str, default=None) -> str:
     return f"{COLOR_CYAN}###### {formatted_q}: {RESET_FORMAT}"
 
 
-def validate_number_input(value: str, min_count: int, max_count: int) -> int:
+def validate_number_input(value: str, min_count: int, max_count: int | None) -> int:
     """
     Helper method for a simple number input validation. |
     :param value: The value to validate

kiauh/utils/instance_utils.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
+
+import re
+from pathlib import Path
+from typing import List
+
+from core.constants import SYSTEMD
+from core.instance_manager.base_instance import SUFFIX_BLACKLIST
+from core.instance_type import InstanceType
+
+
+def get_instances(instance_type: type) -> List[InstanceType]:
+    from utils.common import convert_camelcase_to_kebabcase
+
+    if not isinstance(instance_type, type):
+        raise ValueError("instance_type must be a class")
+
+    name = convert_camelcase_to_kebabcase(instance_type.__name__)
+    pattern = re.compile(f"^{name}(-[0-9a-zA-Z]+)?.service$")
+
+    service_list = [
+        Path(SYSTEMD, service)
+        for service in SYSTEMD.iterdir()
+        if pattern.search(service.name)
+        and not any(s in service.name for s in SUFFIX_BLACKLIST)
+    ]
+
+    instance_list = [
+        instance_type(get_instance_suffix(name, service)) for service in service_list
+    ]
+
+    def _sort_instance_list(suffix: int | str | None):
+        if suffix is None:
+            return
+        elif isinstance(suffix, str) and suffix.isdigit():
+            return f"{int(suffix):04}"
+        else:
+            return suffix
+
+    return sorted(instance_list, key=lambda x: _sort_instance_list(x.suffix))
+
+
+def get_instance_suffix(name: str, file_path: Path) -> str:
+    # to get the suffix of the instance, we remove the name of the instance from
+    # the file name, if the remaining part an empty string we return it
+    # otherwise there is and hyphen left, and we return the part after the hyphen
+    suffix = file_path.stem[len(name) :]
+    return suffix[1:] if suffix else ""

kiauh/utils/spinner.py

@@ -1,33 +0,0 @@
-import sys
-import threading
-import time
-
-
-class Spinner:
-    def __init__(self, message="Loading", delay=0.2):
-        self.message = f"{message} ..."
-        self.delay = delay
-        self._stop_event = threading.Event()
-        self._thread = threading.Thread(target=self._animate)
-
-    def _animate(self):
-        animation = ["◜", "◝", "◞", "◟"]
-        while not self._stop_event.is_set():
-            for char in animation:
-                sys.stdout.write(f"\r{char} {self.message}")
-                sys.stdout.flush()
-                time.sleep(self.delay)
-                if self._stop_event.is_set():
-                    break
-        sys.stdout.write("\r" + " " * (len(self.message) + 1) + "\r")
-        sys.stdout.flush()
-
-    def start(self):
-        self._stop_event.clear()
-        if not self._thread.is_alive():
-            self._thread = threading.Thread(target=self._animate)
-            self._thread.start()
-
-    def stop(self):
-        self._stop_event.set()
-        self._thread.join()

kiauh/utils/sys_utils.py

@@ -6,6 +6,7 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
+from __future__ import annotations
 
 import os
 import re
@@ -17,13 +18,13 @@ import time
 import urllib.error
 import urllib.request
 from pathlib import Path
-from subprocess import DEVNULL, PIPE, CalledProcessError, Popen, run
+from subprocess import DEVNULL, PIPE, CalledProcessError, Popen, check_output, run
 from typing import List, Literal, Set
 
-from utils.constants import SYSTEMD
+from core.constants import SYSTEMD
+from core.logger import Logger
 from utils.fs_utils import check_file_exist, remove_with_sudo
 from utils.input_utils import get_confirm
-from utils.logger import Logger
 
 SysCtlServiceAction = Literal[
     "start",
@@ -86,11 +87,13 @@ def parse_packages_from_file(source_file: Path) -> List[str]:
     return packages
 
 
-def create_python_venv(target: Path) -> None:
+def create_python_venv(target: Path) -> bool:
     """
-    Create a python 3 virtualenv at the provided target destination |
+    Create a python 3 virtualenv at the provided target destination.
+    Returns True if the virtualenv was created successfully.
+    Returns False if the virtualenv already exists, recreation was declined or creation failed.
     :param target: Path where to create the virtualenv at
-    :return: None
+    :return: bool
     """
     Logger.print_status("Set up Python virtual environment ...")
     if not target.exists():
@@ -98,20 +101,25 @@ def create_python_venv(target: Path) -> None:
             cmd = ["virtualenv", "-p", "/usr/bin/python3", target.as_posix()]
             run(cmd, check=True)
             Logger.print_ok("Setup of virtualenv successful!")
+            return True
         except CalledProcessError as e:
             Logger.print_error(f"Error setting up virtualenv:\n{e}")
-            raise
+            return False
     else:
-        if get_confirm("Virtualenv already exists. Re-create?", default_choice=False):
+        if not get_confirm(
-            try:
+            "Virtualenv already exists. Re-create?", default_choice=False
-                shutil.rmtree(target)
+        ):
-                create_python_venv(target)
-            except OSError as e:
-                log = f"Error removing existing virtualenv: {e.strerror}"
-                Logger.print_error(log, False)
-                raise
-        else:
             Logger.print_info("Skipping re-creation of virtualenv ...")
+            return False
+
+        try:
+            shutil.rmtree(target)
+            create_python_venv(target)
+            return True
+        except OSError as e:
+            log = f"Error removing existing virtualenv: {e.strerror}"
+            Logger.print_error(log, False)
+            return False
 
 
 def update_python_pip(target: Path) -> None:
@@ -122,12 +130,13 @@ def update_python_pip(target: Path) -> None:
     """
     Logger.print_status("Updating pip ...")
     try:
-        pip_location = target.joinpath("bin/pip")
+        pip_location: Path = target.joinpath("bin/pip")
-        pip_exists = check_file_exist(pip_location)
+        pip_exists: bool = check_file_exist(pip_location)
+
         if not pip_exists:
             raise FileNotFoundError("Error updating pip! Not found.")
 
-        command = [pip_location, "install", "-U", "pip"]
+        command = [pip_location.as_posix(), "install", "-U", "pip"]
         result = run(command, stderr=PIPE, text=True)
         if result.returncode != 0 or result.stderr:
             Logger.print_error(f"{result.stderr}", False)
@@ -156,7 +165,7 @@ def install_python_requirements(target: Path, requirements: Path) -> None:
 
         Logger.print_status("Installing Python requirements ...")
         command = [
-            target.joinpath("bin/pip"),
+            target.joinpath("bin/pip").as_posix(),
             "install",
             "-r",
             f"{requirements}",
@@ -182,8 +191,8 @@ def update_system_package_lists(silent: bool, rls_info_change=False) -> None:
     :param rls_info_change: Flag for "--allow-releaseinfo-change"
     :return: None
     """
-    cache_mtime = 0
+    cache_mtime: float = 0
-    cache_files = [
+    cache_files: List[Path] = [
         Path("/var/lib/apt/periodic/update-success-stamp"),
         Path("/var/lib/apt/lists"),
     ]
@@ -217,6 +226,25 @@ def update_system_package_lists(silent: bool, rls_info_change=False) -> None:
         raise
 
 
+def get_upgradable_packages() -> List[str]:
+    """
+    Reads all system packages that can be upgraded.
+    :return: A list of package names available for upgrade
+    """
+    try:
+        command = ["apt", "list", "--upgradable"]
+        output: str = check_output(command, stderr=DEVNULL, text=True, encoding="utf-8")
+        pkglist = []
+        for line in output.split("\n"):
+            if "/" not in line:
+                continue
+            pkg = line.split("/")[0]
+            pkglist.append(pkg)
+        return pkglist
+    except CalledProcessError as e:
+        raise Exception(f"Error reading upgradable packages: {e}")
+
+
 def check_package_install(packages: Set[str]) -> List[str]:
     """
     Checks the system for installed packages |
@@ -250,12 +278,29 @@ def install_system_packages(packages: List[str]) -> None:
             command.append(pkg)
         run(command, stderr=PIPE, check=True)
 
-        Logger.print_ok("Packages installed successfully.")
+        Logger.print_ok("Packages successfully installed.")
     except CalledProcessError as e:
         Logger.print_error(f"Error installing packages:\n{e.stderr.decode()}")
         raise
 
 
+def upgrade_system_packages(packages: List[str]) -> None:
+    """
+    Updates a list of system packages |
+    :param packages: List of system package names
+    :return: None
+    """
+    try:
+        command = ["sudo", "apt-get", "upgrade", "-y"]
+        for pkg in packages:
+            command.append(pkg)
+        run(command, stderr=PIPE, check=True)
+
+        Logger.print_ok("Packages successfully upgraded.")
+    except CalledProcessError as e:
+        raise Exception(f"Error upgrading packages:\n{e.stderr.decode()}")
+
+
 # this feels hacky and not quite right, but for now it works
 # see: https://stackoverflow.com/questions/166506/finding-local-ip-addresses-using-pythons-stdlib
 def get_ipv4_addr() -> str:
@@ -269,7 +314,7 @@ def get_ipv4_addr() -> str:
     try:
         # doesn't even have to be reachable
         s.connect(("192.255.255.255", 1))
-        return s.getsockname()[0]
+        return str(s.getsockname()[0])
     except Exception:
         return "127.0.0.1"
     finally:
@@ -329,9 +374,9 @@ def set_nginx_permissions() -> None:
     """
     cmd = f"ls -ld {Path.home()} | cut -d' ' -f1"
     homedir_perm = run(cmd, shell=True, stdout=PIPE, text=True)
-    homedir_perm = homedir_perm.stdout
+    permissions = homedir_perm.stdout
 
-    if homedir_perm.count("x") < 3:
+    if permissions.count("x") < 3:
         Logger.print_status("Granting NGINX the required permissions ...")
         run(["chmod", "og+x", Path.home()])
         Logger.print_ok("Permissions granted.")
@@ -363,15 +408,18 @@ def cmd_sysctl_manage(action: SysCtlManageAction) -> None:
         raise
 
 
-def service_instance_exists(name: str, exclude: List[str] = None) -> bool:
+def unit_file_exists(
+    name: str, suffix: Literal["service", "timer"], exclude: List[str] | None = None
+) -> bool:
     """
-    Checks if a systemd service instance exists.
+    Checks if a systemd unit file of the provided suffix exists.
-    :param name: the service name
+    :param name: the name of the unit file
-    :param exclude: List of strings of service names to exclude
+    :param suffix: suffix of the unit file, either "service" or "timer"
-    :return: True if the service exists, False otherwise
+    :param exclude: List of strings of names to exclude
+    :return: True if the unit file exists, False otherwise
     """
     exclude = exclude or []
-    pattern = re.compile(f"^{name}(-[0-9a-zA-Z]+)?.service$")
+    pattern = re.compile(f"^{name}(-[0-9a-zA-Z]+)?.{suffix}$")
     service_list = [
         Path(SYSTEMD, service)
         for service in SYSTEMD.iterdir()
@@ -387,15 +435,16 @@ def log_process(process: Popen) -> None:
     :return: None
     """
     while True:
-        reads = [process.stdout.fileno()]
+        if process.stdout is not None:
-        ret = select.select(reads, [], [])
+            reads = [process.stdout.fileno()]
-        for fd in ret[0]:
+            ret = select.select(reads, [], [])
-            if fd == process.stdout.fileno():
+            for fd in ret[0]:
-                line = process.stdout.readline()
+                if fd == process.stdout.fileno():
-                if line:
+                    line = process.stdout.readline()
-                    print(line.strip(), flush=True)
+                    if line:
-                else:
+                        print(line.strip(), flush=True)
-                    break
+                    else:
+                        break
 
         if process.poll() is not None:
             break
@@ -437,21 +486,43 @@ def create_env_file(path: Path, content: str) -> None:
         raise
 
 
-def remove_service_file(service_name: str, service_file: Path) -> None:
+def remove_system_service(service_name: str) -> None:
     """
-    Removes a systemd service file at the provided path with the provided name.
+    Disables and removes a systemd service
-    :param service_name: the name of the service
+    :param service_name: name of the service unit file - must end with '.service'
-    :param service_file: the path of the service file
     :return: None
     """
     try:
+        if not service_name.endswith(".service"):
+            raise ValueError(f"service_name '{service_name}' must end with '.service'")
+
+        file: Path = SYSTEMD.joinpath(service_name)
+        if not file.exists() or not file.is_file():
+            Logger.print_info(f"Service '{service_name}' does not exist! Skipped ...")
+            return
+
         Logger.print_status(f"Removing {service_name} ...")
         cmd_sysctl_service(service_name, "stop")
         cmd_sysctl_service(service_name, "disable")
-        remove_with_sudo(service_file)
+        remove_with_sudo(file)
         cmd_sysctl_manage("daemon-reload")
         cmd_sysctl_manage("reset-failed")
         Logger.print_ok(f"{service_name} successfully removed!")
     except Exception as e:
-        Logger.print_error(f"Error removing {service_name}:\n{e}")
+        Logger.print_error(f"Error removing {service_name}: {e}")
         raise
+
+
+def get_service_file_path(instance_type: type, suffix: str) -> Path:
+    from utils.common import convert_camelcase_to_kebabcase
+
+    if not isinstance(instance_type, type):
+        raise ValueError("instance_type must be a class")
+
+    name: str = convert_camelcase_to_kebabcase(instance_type.__name__)
+    if suffix != "":
+        name += f"-{suffix}"
+
+    file_path: Path = SYSTEMD.joinpath(f"{name}.service")
+
+    return file_path

pyproject.toml

@@ -2,7 +2,7 @@
 requires-python = ">=3.8"
 
 [project.optional-dependencies]
-dev=["ruff"]
+dev=["ruff", "mypy"]
 
 [tool.ruff]
 required-version = ">=0.3.4"
@@ -19,3 +19,14 @@ quote-style = "double"
 
 [tool.ruff.lint]
 extend-select = ["I"]
+
+[tool.mypy]
+python_version = "3.8"
+platform = "linux"
+# strict = true # TODO: enable this once everything is else is handled
+check_untyped_defs = true
+ignore_missing_imports = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_return_any = true
+warn_unreachable = true

scripts/moonraker.sh

@@ -142,12 +142,12 @@ function moonraker_setup_dialog() {
 
 function install_moonraker_dependencies() {
   local packages log_name="Moonraker"
-  local install_script="${MOONRAKER_DIR}/scripts/install-moonraker.sh"
+  local package_json="${MOONRAKER_DIR}/scripts/system-dependencies.json"
 
   ### read PKGLIST from official install-script
   status_msg "Reading dependencies..."
   # shellcheck disable=SC2016
-  packages="$(grep "PKGLIST=" "${install_script}" | cut -d'"' -f2 | sed 's/\${PKGLIST}//g' | tr -d '\n')"
+  packages=$(cat $package_json | tr -d ' \n{}' | cut -d "]" -f1 | cut -d":" -f2 | tr -d '"[' | sed 's/,/ /g')
 
   echo "${cyan}${packages}${white}" | tr '[:space:]' '\n'
   read -r -a packages <<< "${packages}"

scripts/ui/main_menu.sh

@@ -40,7 +40,7 @@ function main_ui() {
 function get_kiauh_version() {
   local version
   cd "${KIAUH_SRCDIR}"
-  version="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
+  version="$(git tag -l 'v5*' | tail -1)"
   echo "${version}"
 }
 
@@ -93,9 +93,6 @@ function main_menu() {
   clear && print_header
   main_ui
 
-  ### initialize kiauh.ini
-  init_ini
-
   local action
   while true; do
     read -p "${cyan}####### Perform action:${white} " action

scripts/utilities.sh

@@ -28,6 +28,21 @@ function check_euid() {
   fi
 }
 
+function check_if_ratos() {
+  if [[ -n $(which ratos) ]]; then
+    echo -e "${red}"
+    top_border
+    echo -e "|        !!! RatOS 2.1 or greater detected !!!          |"
+    echo -e "|                                                       |"
+    echo -e "|        KIAUH does currently not support RatOS.        |"
+    echo -e "| If you have any questions, please ask for help on the |"
+    echo -e "| RatRig Community Discord: https://discord.gg/ratrig   |"
+    bottom_border
+    echo -e "${white}"
+    exit 1
+  fi
+}
+
 #================================================#
 #============= MESSAGE FORMATTING ===============#
 #================================================#
@@ -178,6 +193,10 @@ function init_ini() {
     echo -e "\nmulti_instance_names=\c" >> "${INI_FILE}"
   fi
 
+  if ! grep -Eq "^version_to_launch=" "${INI_FILE}"; then
+    echo -e "\nversion_to_launch=\n\c" >> "${INI_FILE}"
+  fi
+
   ### strip all empty lines out of the file
   sed -i "/^[[:blank:]]*$/ d" "${INI_FILE}"
 }
@@ -362,9 +381,9 @@ function create_required_folders() {
 
 function update_system_package_lists() {
   local cache_mtime update_age update_interval silent
-  
+
   if [[ $1 == '--silent' ]]; then silent="true"; fi
-  
+
   if [[ -e /var/lib/apt/periodic/update-success-stamp ]]; then
     cache_mtime="$(stat -c %Y /var/lib/apt/periodic/update-success-stamp)"
   elif [[ -e /var/lib/apt/lists ]]; then
@@ -396,10 +415,10 @@ function update_system_package_lists() {
 function check_system_updates() {
   local updates_avail status
   if ! update_system_package_lists --silent; then
-    status="${red}Update check failed!     ${white}" 
+    status="${red}Update check failed!     ${white}"
   else
     updates_avail="$(apt list --upgradeable 2>/dev/null | sed "1d")"
-    
+
     if [[ -n ${updates_avail} ]]; then
       status="${yellow}System upgrade available!${white}"
       # add system to application_updates_available in kiauh.ini
@@ -408,7 +427,7 @@ function check_system_updates() {
       status="${green}System up to date!       ${white}"
     fi
   fi
-  
+
   echo "${status}"
 }