feat: add change hostename procedure

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

.editorconfig

@@ -6,10 +6,6 @@ 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/OctoApp-Plugin">OctoApp For Klipper</a></h3></th>
+<th><h3><a href="https://github.com/crysxd/OctoPrint-OctoApp">OctoApp For Klipper</a></h3></th>
 <th><h3></h3></th>
 </tr>
 

docs/changelog.md

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

kiauh/components/crowsnest/crowsnest.py

@@ -28,9 +28,8 @@ from components.crowsnest import (
 from components.klipper.klipper import Klipper
 from core.backup_manager.backup_manager import BackupManager
 from core.constants import CURRENT_USER
-from core.logger import DialogType, Logger
+from core.instance_manager.instance_manager import InstanceManager
 from core.settings.kiauh_settings import KiauhSettings
-from core.types import ComponentStatus
 from utils.common import (
     check_install_dependencies,
     get_install_status,
@@ -40,11 +39,12 @@ from utils.git_utils import (
     git_pull_wrapper,
 )
 from utils.input_utils import get_confirm
-from utils.instance_utils import get_instances
+from utils.logger import DialogType, Logger
 from utils.sys_utils import (
     cmd_sysctl_service,
     parse_packages_from_file,
 )
+from utils.types import ComponentStatus
 
 
 def install_crowsnest() -> None:
@@ -55,7 +55,8 @@ def install_crowsnest() -> None:
     check_install_dependencies({"make"})
 
     # Step 3: Check for Multi Instance
-    instances: List[Klipper] = get_instances(Klipper)
+    im = InstanceManager(Klipper)
+    instances: List[Klipper] = im.instances
 
     if len(instances) > 1:
         print_multi_instance_warning(instances)
@@ -94,7 +95,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],
         ],
     )
 

kiauh/components/klipper/klipper.py

@@ -8,9 +8,9 @@
 # ======================================================================= #
 from __future__ import annotations
 
-from dataclasses import dataclass, field
+from dataclasses import dataclass
 from pathlib import Path
-from subprocess import CalledProcessError
+from subprocess import CalledProcessError, run
 
 from components.klipper import (
     KLIPPER_CFG_NAME,
@@ -23,36 +23,29 @@ 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 core.logger import Logger
+from utils.logger import Logger
-from utils.fs_utils import create_folders, get_data_dir
-from utils.sys_utils import get_service_file_path
 
 
 # noinspection PyMethodMayBeStatic
-@dataclass(repr=True)
+@dataclass
-class Klipper:
+class Klipper(BaseInstance):
-    suffix: str
-    base: BaseInstance = field(init=False, repr=False)
-    service_file_path: Path = field(init=False)
-    log_file_name: str = KLIPPER_LOG_NAME
     klipper_dir: Path = KLIPPER_DIR
     env_dir: Path = KLIPPER_ENV_DIR
-    data_dir: Path = field(init=False)
+    cfg_file: Path | None = None
-    cfg_file: Path = field(init=False)
+    log: Path | None = None
-    serial: Path = field(init=False)
+    serial: Path | None = None
-    uds: Path = field(init=False)
+    uds: Path | None = None
 
-    def __post_init__(self):
+    def __init__(self, suffix: str = "") -> None:
-        self.base: BaseInstance = BaseInstance(Klipper, self.suffix)
+        super().__init__(suffix=suffix)
-        self.base.log_file_name = self.log_file_name
 
-        self.service_file_path: Path = get_service_file_path(Klipper, self.suffix)
+    def __post_init__(self) -> None:
-        self.data_dir: Path = get_data_dir(Klipper, self.suffix)
+        super().__post_init__()
-        self.cfg_file: Path = self.base.cfg_dir.joinpath(KLIPPER_CFG_NAME)
+        self.cfg_file = self.cfg_dir.joinpath(KLIPPER_CFG_NAME)
-        self.serial: Path = self.base.comms_dir.joinpath(KLIPPER_SERIAL_NAME)
+        self.log = self.log_dir.joinpath(KLIPPER_LOG_NAME)
-        self.uds: Path = self.base.comms_dir.joinpath(KLIPPER_UDS_NAME)
+        self.serial = self.comms_dir.joinpath(KLIPPER_SERIAL_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
@@ -60,15 +53,15 @@ class Klipper:
         Logger.print_status("Creating new Klipper Instance ...")
 
         try:
-            create_folders(self.base.base_folders)
+            self.create_folders()
 
             create_service_file(
-                name=self.service_file_path.name,
+                name=self.get_service_file_name(extension=True),
                 content=self._prep_service_file_content(),
             )
 
             create_env_file(
-                path=self.base.sysd_dir.joinpath(KLIPPER_ENV_FILE_NAME),
+                path=self.sysd_dir.joinpath(KLIPPER_ENV_FILE_NAME),
                 content=self._prep_env_file_content(),
             )
 
@@ -79,6 +72,21 @@ class Klipper:
             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
 
@@ -91,7 +99,7 @@ class Klipper:
 
         service_content = template_content.replace(
             "%USER%",
-            CURRENT_USER,
+            self.user,
         )
         service_content = service_content.replace(
             "%KLIPPER_DIR%",
@@ -103,7 +111,7 @@ class Klipper:
         )
         service_content = service_content.replace(
             "%ENV_FILE%",
-            self.base.sysd_dir.joinpath(KLIPPER_ENV_FILE_NAME).as_posix(),
+            self.sysd_dir.joinpath(KLIPPER_ENV_FILE_NAME).as_posix(),
         )
         return service_content
 
@@ -122,7 +130,7 @@ class Klipper:
         )
         env_file_content = env_file_content.replace(
             "%CFG%",
-            f"{self.base.cfg_dir}/{KLIPPER_CFG_NAME}",
+            f"{self.cfg_dir}/{KLIPPER_CFG_NAME}",
         )
         env_file_content = env_file_content.replace(
             "%SERIAL%",
@@ -130,7 +138,7 @@ class Klipper:
         )
         env_file_content = env_file_content.replace(
             "%LOG%",
-            self.base.log_dir.joinpath(self.log_file_name).as_posix(),
+            self.log.as_posix() if self.log else "",
         )
         env_file_content = env_file_content.replace(
             "%UDS%",

kiauh/components/klipper/klipper_dialogs.py

@@ -17,7 +17,7 @@ from core.constants import (
     COLOR_YELLOW,
     RESET_FORMAT,
 )
-from core.instance_type import InstanceType
+from core.instance_manager.base_instance import BaseInstance
 from core.menus.base_menu import print_back_footer
 
 
@@ -28,7 +28,7 @@ class DisplayType(Enum):
 
 
 def print_instance_overview(
-    instances: List[InstanceType],
+    instances: List[BaseInstance],
     display_type: DisplayType = DisplayType.SERVICE_NAME,
     show_headline=True,
     show_index=False,
@@ -53,7 +53,7 @@ def print_instance_overview(
 
     for i, s in enumerate(instances):
         if display_type is DisplayType.SERVICE_NAME:
-            name = s.service_file_path.stem
+            name = s.get_service_file_name()
         else:
             name = s.data_dir
         line = f"{COLOR_CYAN}{f'{i + start_index})' if show_index else '●'} {name}{RESET_FORMAT}"

kiauh/components/klipper/klipper_remove.py

@@ -14,11 +14,10 @@ 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.instance_utils import get_instances
+from utils.logger import Logger
-from utils.sys_utils import unit_file_exists
+from utils.sys_utils import cmd_sysctl_manage
 
 
 def run_klipper_removal(
@@ -26,17 +25,17 @@ def run_klipper_removal(
     remove_dir: bool,
     remove_env: bool,
 ) -> None:
-    klipper_instances: List[Klipper] = get_instances(Klipper)
+    im = InstanceManager(Klipper)
 
     if remove_service:
         Logger.print_status("Removing Klipper instances ...")
-        if klipper_instances:
+        if im.instances:
-            instances_to_remove = select_instances_to_remove(klipper_instances)
+            instances_to_remove = select_instances_to_remove(im.instances)
-            remove_instances(instances_to_remove)
+            remove_instances(im, instances_to_remove)
         else:
             Logger.print_info("No Klipper Services installed! Skipped ...")
 
-    if (remove_dir or remove_env) and unit_file_exists("klipper", suffix="service"):
+    if (remove_dir or remove_env) and im.instances:
         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)
@@ -75,20 +74,26 @@ def select_instances_to_remove(instances: List[Klipper]) -> List[Klipper] | None
 
 
 def remove_instances(
+    instance_manager: InstanceManager,
     instance_list: List[Klipper] | None,
 ) -> None:
     if not instance_list:
         return
 
     for instance in instance_list:
-        Logger.print_status(f"Removing instance {instance.service_file_path.stem} ...")
+        Logger.print_status(f"Removing instance {instance.get_service_file_name()} ...")
-        InstanceManager.remove(instance)
+        instance_manager.current_instance = 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.base.log_dir.glob("klippy.log*"))
+        all_logfiles = list(instance.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,15 +35,13 @@ 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.instance_utils import get_instances
+from utils.logger import DialogType, Logger
 from utils.sys_utils import (
     cmd_sysctl_manage,
-    cmd_sysctl_service,
     create_python_venv,
     install_python_requirements,
     parse_packages_from_file,
@@ -53,8 +51,8 @@ from utils.sys_utils import (
 def install_klipper() -> None:
     Logger.print_status("Installing Klipper ...")
 
-    klipper_list: List[Klipper] = get_instances(Klipper)
+    klipper_list: List[Klipper] = InstanceManager(Klipper).instances
-    moonraker_list: List[Moonraker] = get_instances(Moonraker)
+    moonraker_list: List[Moonraker] = InstanceManager(Moonraker).instances
     match_moonraker: bool = False
 
     # if there are more moonraker instances than klipper instances, ask the user to
@@ -96,7 +94,7 @@ def install_klipper() -> None:
 
 
 def run_klipper_setup(
-    klipper_list: List[Klipper], name_dict: Dict[int, str], create_example_cfg: bool
+    klipper_list: List[Klipper], name_dict: Dict[int, str], example_cfg: bool
 ) -> None:
     if not klipper_list:
         setup_klipper_prerequesites()
@@ -106,16 +104,7 @@ def run_klipper_setup(
         if name_dict[i] in [n.suffix for n in klipper_list]:
             continue
 
-        instance = Klipper(suffix=name_dict[i])
+        create_klipper_instance(name_dict[i], example_cfg)
-        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")
 
@@ -165,8 +154,8 @@ def setup_klipper_prerequesites() -> None:
     # install klipper dependencies and create python virtualenv
     try:
         install_klipper_packages()
-        if create_python_venv(KLIPPER_ENV_DIR):
+        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
@@ -200,8 +189,8 @@ def update_klipper() -> None:
     if settings.kiauh.backup_before_update:
         backup_klipper_dir()
 
-    instances = get_instances(Klipper)
+    instance_manager = InstanceManager(Klipper)
-    InstanceManager.stop_all(instances)
+    instance_manager.stop_all_instance()
 
     git_pull_wrapper(repo=settings.klipper.repo_url, target_dir=KLIPPER_DIR)
 
@@ -210,7 +199,20 @@ def update_klipper() -> None:
     # install possible new python dependencies
     install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
 
-    InstanceManager.start_all(instances)
+    instance_manager.start_all_instance()
+
+
+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:
@@ -229,11 +231,13 @@ def display_moonraker_info(moonraker_list: List[Moonraker]) -> bool:
         DialogType.INFO,
         [
             "Existing Moonraker instances detected:",
-            *[f"● {m.service_file_path.stem}" for m in moonraker_list],
+            *[f"● {m.get_service_file_name()}" 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,
     )
     _input: bool = get_confirm("Proceed with installation?")
     return _input

kiauh/components/klipper/klipper_utils.py

@@ -31,16 +31,15 @@ from components.webui_client.client_config.client_config_setup import (
 )
 from core.backup_manager.backup_manager import BackupManager
 from core.constants import CURRENT_USER
-from core.instance_manager.base_instance import SUFFIX_BLACKLIST
+from core.instance_manager.instance_manager import InstanceManager
-from core.logger import DialogType, Logger
 from core.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.input_utils import get_confirm, get_number_input, get_string_input
-from utils.instance_utils import get_instances
+from utils.logger import DialogType, Logger
 from utils.sys_utils import cmd_sysctl_service
+from utils.types import ComponentStatus
 
 
 def get_klipper_status() -> ComponentStatus:
@@ -48,7 +47,7 @@ def get_klipper_status() -> ComponentStatus:
 
 
 def add_to_existing() -> bool | None:
-    kl_instances: List[Klipper] = get_instances(Klipper)
+    kl_instances: List[Klipper] = InstanceManager(Klipper).instances
     print_instance_overview(kl_instances)
     _input: bool | None = get_confirm("Add new instances?", allow_go_back=True)
     return _input
@@ -61,7 +60,7 @@ 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 = get_instances(Klipper)
+    kl_instances = InstanceManager(Klipper).instances
     print_select_instance_count_dialog()
     question = (
         f"Number of"
@@ -74,7 +73,7 @@ def get_install_count() -> int | None:
 
 def assign_custom_name(key: int, name_dict: Dict[int, str]) -> None:
     existing_names = []
-    existing_names.extend(SUFFIX_BLACKLIST)
+    existing_names.extend(Klipper.blacklist())
     existing_names.extend(name_dict[n] for n in name_dict)
     pattern = r"^[a-zA-Z0-9]+$"
 
@@ -103,6 +102,7 @@ def check_user_groups() -> None:
             "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?"):
@@ -160,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.base.cfg_dir}'")
+    Logger.print_status(f"Creating example printer.cfg in '{instance.cfg_dir}'")
     if instance.cfg_file.is_file():
         Logger.print_info(f"'{instance.cfg_file}' already exists.")
         return
@@ -175,7 +175,7 @@ def create_example_printer_cfg(
 
     scp = SimpleConfigParser()
     scp.read(target)
-    scp.set("virtual_sdcard", "path", str(instance.base.gcodes_dir))
+    scp.set("virtual_sdcard", "path", str(instance.gcodes_dir))
 
     # include existing client configs in the example config
     if clients is not None and len(clients) > 0:
@@ -187,7 +187,7 @@ def create_example_printer_cfg(
 
     scp.write(target)
 
-    Logger.print_ok(f"Example printer.cfg created in '{instance.base.cfg_dir}'")
+    Logger.print_ok(f"Example printer.cfg created in '{instance.cfg_dir}'")
 
 
 def backup_klipper_dir() -> None:

kiauh/components/klipper/menus/klipper_remove_menu.py

@@ -35,11 +35,11 @@ class KlipperRemoveMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            "a": Option(method=self.toggle_all),
+            "a": Option(method=self.toggle_all, menu=False),
-            "1": Option(method=self.toggle_remove_klipper_service),
+            "1": Option(method=self.toggle_remove_klipper_service, menu=False),
-            "2": Option(method=self.toggle_remove_klipper_dir),
+            "2": Option(method=self.toggle_remove_klipper_dir, menu=False),
-            "3": Option(method=self.toggle_remove_klipper_env),
+            "3": Option(method=self.toggle_remove_klipper_env, menu=False),
-            "c": Option(method=self.run_removal_process),
+            "c": Option(method=self.run_removal_process, menu=False),
         }
 
     def print_menu(self) -> None:

kiauh/components/klipper_firmware/firmware_utils.py

@@ -18,8 +18,7 @@ from components.klipper_firmware.flash_options import (
     FlashOptions,
 )
 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
 from utils.sys_utils import log_process
 
 
@@ -118,13 +117,13 @@ def start_flash_process(flash_options: FlashOptions) -> None:
         else:
             raise Exception("Invalid value for flash_method!")
 
-        instances = get_instances(Klipper)
+        instance_manager = InstanceManager(Klipper)
-        InstanceManager.stop_all(instances)
+        instance_manager.stop_all_instance()
 
         process = Popen(cmd, cwd=KLIPPER_DIR, stdout=PIPE, stderr=STDOUT, text=True)
         log_process(process)
 
-        InstanceManager.start_all(instances)
+        instance_manager.start_all_instance()
 
         rc = process.returncode
         if rc != 0:

kiauh/components/klipper_firmware/menus/klipper_build_menu.py

@@ -18,9 +18,9 @@ from components.klipper_firmware.firmware_utils import (
     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.logger import Logger
 from utils.sys_utils import (
     check_package_install,
     install_system_packages,
@@ -47,10 +47,10 @@ class KlipperBuildFirmwareMenu(BaseMenu):
     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)
+            self.default_option = Option(method=self.start_build_process, menu=False)
         else:
             self.input_label_txt = "Press ENTER to install dependencies"
-            self.default_option = Option(method=self.install_missing_deps)
+            self.default_option = Option(method=self.install_missing_deps, menu=False)
 
     def print_menu(self) -> None:
         header = " [ Build Firmware Menu ] "
@@ -81,7 +81,6 @@ class KlipperBuildFirmwareMenu(BaseMenu):
             line = f"{COLOR_RED}Dependencies are missing!{RESET_FORMAT}"
 
         menu += f"║ {line:<62} ║\n"
-        menu += "╟───────────────────────────────────────────────────────╢\n"
 
         print(menu, end="")
 

kiauh/components/klipper_firmware/menus/klipper_flash_error_menu.py

@@ -32,7 +32,7 @@ class KlipperNoFirmwareErrorMenu(BaseMenu):
         self.previous_menu = previous_menu
 
     def set_options(self) -> None:
-        self.default_option = Option(method=self.go_back)
+        self.default_option = Option(self.go_back, False)
 
     def print_menu(self) -> None:
         header = "!!! NO FIRMWARE FILE FOUND !!!"
@@ -79,7 +79,7 @@ class KlipperNoBoardTypesErrorMenu(BaseMenu):
         self.previous_menu = previous_menu
 
     def set_options(self) -> None:
-        self.default_option = Option(method=self.go_back)
+        self.default_option = Option(self.go_back, False)
 
     def print_menu(self) -> None:
         header = "!!! ERROR GETTING BOARD LIST !!!"

kiauh/components/klipper_firmware/menus/klipper_flash_menu.py

@@ -36,10 +36,10 @@ from components.klipper_firmware.menus.klipper_flash_help_menu import (
     KlipperMcuConnectionHelpMenu,
 )
 from core.constants import COLOR_CYAN, COLOR_RED, COLOR_YELLOW, RESET_FORMAT
-from core.logger import DialogType, Logger
 from core.menus import FooterType, Option
 from core.menus.base_menu import BaseMenu
 from utils.input_utils import get_number_input
+from utils.logger import DialogType, Logger
 
 
 # noinspection PyUnusedLocal
@@ -61,8 +61,8 @@ class KlipperFlashMethodMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(self.select_regular),
+            "1": Option(self.select_regular, menu=False),
-            "2": Option(self.select_sdcard),
+            "2": Option(self.select_sdcard, menu=False),
         }
 
     def print_menu(self) -> None:
@@ -123,10 +123,10 @@ class KlipperFlashCommandMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(self.select_flash),
+            "1": Option(self.select_flash, menu=False),
-            "2": Option(self.select_serialflash),
+            "2": Option(self.select_serialflash, menu=False),
         }
-        self.default_option = Option(self.select_flash)
+        self.default_option = Option(self.select_flash, menu=False)
 
     def print_menu(self) -> None:
         menu = textwrap.dedent(
@@ -174,9 +174,9 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(method=self.select_usb),
+            "1": Option(method=self.select_usb, menu=False),
-            "2": Option(method=self.select_dfu),
+            "2": Option(method=self.select_dfu, menu=False),
-            "3": Option(method=self.select_usb_dfu),
+            "3": Option(method=self.select_usb_dfu, menu=False),
         }
 
     def print_menu(self) -> None:
@@ -249,7 +249,7 @@ class KlipperSelectMcuIdMenu(BaseMenu):
         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
+        self.footer_type = FooterType.BACK_HELP
 
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
         self.previous_menu = (
@@ -260,12 +260,13 @@ class KlipperSelectMcuIdMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            f"{i}": Option(self.flash_mcu, f"{i}") for i in range(len(self.mcu_list))
+            f"{i}": Option(self.flash_mcu, False, f"{i}")
+            for i in range(len(self.mcu_list))
         }
 
     def print_menu(self) -> None:
         header = "!!! ATTENTION !!!"
-        header2 = f"[{COLOR_CYAN}List of detected MCUs{RESET_FORMAT}]"
+        header2 = f"[{COLOR_CYAN}List of available MCUs{RESET_FORMAT}]"
         color = COLOR_RED
         count = 62 - len(color) - len(RESET_FORMAT)
         menu = textwrap.dedent(
@@ -277,21 +278,15 @@ class KlipperSelectMcuIdMenu(BaseMenu):
             ║ ONLY flash a firmware created for the respective MCU! ║
             ║                                                       ║
             ╟{header2:─^64}╢
-            ║                                                       ║
             """
         )[1:]
 
         for i, mcu in enumerate(self.mcu_list):
             mcu = mcu.split("/")[-1]
-            menu += f"║ {i}) {COLOR_CYAN}{mcu:<51}{RESET_FORMAT}║\n"
+            menu += f"   ● MCU #{i}: {COLOR_CYAN}{mcu}{RESET_FORMAT}\n"
+        menu += "╟───────────────────────────┬───────────────────────────╢"
 
-        menu += textwrap.dedent(
+        print(menu, end="\n")
-            """
-            ║                                                       ║
-            ╟───────────────────────────────────────────────────────╢
-            """
-        )[1:]
-        print(menu, end="")
 
     def flash_mcu(self, **kwargs):
         try:
@@ -328,7 +323,7 @@ class KlipperSelectSDFlashBoardMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            f"{i}": Option(self.board_select, f"{i}")
+            f"{i}": Option(self.board_select, False, f"{i}")
             for i in range(len(self.available_boards))
         }
 
@@ -349,8 +344,8 @@ class KlipperSelectSDFlashBoardMenu(BaseMenu):
 
             for i, board in enumerate(self.available_boards):
                 line = f" {i}) {board}"
-                menu += f"║{line:<55}║\n"
+                menu += f"|{line:<55}|\n"
-            menu += "╟───────────────────────────────────────────────────────╢"
+
             print(menu, end="")
 
     def board_select(self, **kwargs):
@@ -398,11 +393,11 @@ class KlipperFlashOverviewMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            "y": Option(self.execute_flash),
+            "Y": Option(self.execute_flash, menu=False),
-            "n": Option(self.abort_process),
+            "N": Option(self.abort_process, menu=False),
         }
 
-        self.default_option = Option(self.execute_flash)
+        self.default_option = Option(self.execute_flash, menu=False)
 
     def print_menu(self) -> None:
         header = "!!! ATTENTION !!!"
@@ -412,7 +407,7 @@ class KlipperFlashOverviewMenu(BaseMenu):
         method = self.flash_options.flash_method.value
         command = self.flash_options.flash_command.value
         conn_type = self.flash_options.connection_type.value
-        mcu = self.flash_options.selected_mcu.split("/")[-1]
+        mcu = self.flash_options.selected_mcu
         board = self.flash_options.selected_board
         baudrate = self.flash_options.selected_baudrate
         subheader = f"[{COLOR_CYAN}Overview{RESET_FORMAT}]"
@@ -426,37 +421,26 @@ class KlipperFlashOverviewMenu(BaseMenu):
             ║ sure everything is correct, start the process. If any ║
             ║ parameter needs to be changed, you can go back (B)    ║
             ║ step by step or abort and start from the beginning.   ║
-            ║{subheader:─^64}║
+            ║{subheader:-^64}║
-            ║                                                       ║
             """
         )[1:]
 
-        menu += textwrap.dedent(
+        menu += f"   ● MCU: {COLOR_CYAN}{mcu}{RESET_FORMAT}\n"
-            f"""
+        menu += f"   ● Connection: {COLOR_CYAN}{conn_type}{RESET_FORMAT}\n"
-            ║ MCU: {COLOR_CYAN}{mcu:<48}{RESET_FORMAT} ║
+        menu += f"   ● Flash method: {COLOR_CYAN}{method}{RESET_FORMAT}\n"
-            ║ Connection: {COLOR_CYAN}{conn_type:<41}{RESET_FORMAT} ║
+        menu += f"   ● Flash command: {COLOR_CYAN}{command}{RESET_FORMAT}\n"
-            ║ Flash method: {COLOR_CYAN}{method:<39}{RESET_FORMAT} ║
-            ║ Flash command: {COLOR_CYAN}{command:<38}{RESET_FORMAT} ║
-            """
-        )[1:]
 
         if self.flash_options.flash_method is FlashMethod.SD_CARD:
-            menu += textwrap.dedent(
+            menu += f"   ● Board type: {COLOR_CYAN}{board}{RESET_FORMAT}\n"
-                f"""
+            menu += f"   ● Baudrate: {COLOR_CYAN}{baudrate}{RESET_FORMAT}\n"
-                ║ Board type: {COLOR_CYAN}{board:<41}{RESET_FORMAT} ║
-                ║ Baudrate: {COLOR_CYAN}{baudrate:<43}{RESET_FORMAT} ║
-                """
-            )[1:]
 
         menu += textwrap.dedent(
             """
-            ║                                                       ║
             ╟───────────────────────────────────────────────────────╢
             ║  Y) Start flash process                               ║
             ║  N) Abort - Return to Advanced Menu                   ║
-            ╟───────────────────────────────────────────────────────╢
             """
-        )[1:]
+        )
         print(menu, end="")
 
     def execute_flash(self, **kwargs):

kiauh/components/klipperscreen/klipperscreen.py

@@ -28,9 +28,7 @@ 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,
@@ -42,13 +40,14 @@ from utils.git_utils import (
     git_pull_wrapper,
 )
 from utils.input_utils import get_confirm
-from utils.instance_utils import get_instances
+from utils.logger import DialogType, Logger
 from utils.sys_utils import (
     check_python_version,
     cmd_sysctl_service,
     install_python_requirements,
-    remove_system_service,
+    remove_service_file,
 )
+from utils.types import ComponentStatus
 
 
 def install_klipperscreen() -> None:
@@ -57,7 +56,8 @@ def install_klipperscreen() -> None:
     if not check_python_version(3, 7):
         return
 
-    mr_instances = get_instances(Moonraker)
+    mr_im = InstanceManager(Moonraker)
+    mr_instances = mr_im.instances
     if not mr_instances:
         Logger.print_dialog(
             DialogType.WARNING,
@@ -68,6 +68,8 @@ 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?",
@@ -84,7 +86,7 @@ def install_klipperscreen() -> None:
         run(KLIPPERSCREEN_INSTALL_SCRIPT.as_posix(), shell=True, check=True)
         if mr_instances:
             patch_klipperscreen_update_manager(mr_instances)
-            InstanceManager.restart_all(mr_instances)
+            mr_im.restart_all_instance()
         else:
             Logger.print_info(
                 "Moonraker is not installed! Cannot add "
@@ -103,8 +105,8 @@ def patch_klipperscreen_update_manager(instances: List[Moonraker]) -> None:
         options=[
             ("type", "git_repo"),
             ("path", KLIPPERSCREEN_DIR.as_posix()),
-            ("origin", KLIPPERSCREEN_REPO),
+            ("orgin", KLIPPERSCREEN_REPO),
-            ("managed_services", "KlipperScreen"),
+            ("manages_servcies", "KlipperScreen"),
             ("env", f"{KLIPPERSCREEN_ENV_DIR}/bin/python"),
             ("requirements", KLIPPERSCREEN_REQ_FILE.as_posix()),
             ("install_script", KLIPPERSCREEN_INSTALL_SCRIPT.as_posix()),
@@ -164,7 +166,10 @@ def remove_klipperscreen() -> None:
             Logger.print_warn("KlipperScreen environment not found!")
 
         if KLIPPERSCREEN_SERVICE_FILE.exists():
-            remove_system_service(KLIPPERSCREEN_SERVICE_NAME)
+            remove_service_file(
+                KLIPPERSCREEN_SERVICE_NAME,
+                KLIPPERSCREEN_SERVICE_FILE,
+            )
 
         logfile = Path(f"/tmp/{KLIPPERSCREEN_LOG_NAME}")
         if logfile.exists():
@@ -172,15 +177,17 @@ def remove_klipperscreen() -> None:
             remove_with_sudo(logfile)
             Logger.print_ok("KlipperScreen log file successfully removed!")
 
-        kl_instances: List[Klipper] = get_instances(Klipper)
+        kl_im = InstanceManager(Klipper)
+        kl_instances: List[Klipper] = kl_im.instances
         for instance in kl_instances:
-            logfile = instance.base.log_dir.joinpath(KLIPPERSCREEN_LOG_NAME)
+            logfile = instance.log_dir.joinpath(KLIPPERSCREEN_LOG_NAME)
             if logfile.exists():
                 Logger.print_status(f"Removing {logfile} ...")
                 Path(logfile).unlink()
                 Logger.print_ok(f"{logfile} successfully removed!")
 
-        mr_instances: List[Moonraker] = get_instances(Moonraker)
+        mr_im = InstanceManager(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,14 +13,13 @@ from typing import List
 
 from components.klipper.klipper import Klipper
 from components.log_uploads import LogFile
-from core.logger import Logger
+from core.instance_manager.instance_manager import InstanceManager
-from utils.instance_utils import get_instances
+from utils.logger import Logger
 
 
 def get_logfile_list() -> List[LogFile]:
-    log_dirs: List[Path] = [
+    cm = InstanceManager(Klipper)
-        instance.base.log_dir for instance in get_instances(Klipper)
+    log_dirs: List[Path] = [instance.log_dir for instance in cm.instances]
-    ]
 
     logfiles: List[LogFile] = []
     for _dir in log_dirs:

kiauh/components/log_uploads/menus/log_upload_menu.py

@@ -13,9 +13,9 @@ 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.logger import Logger
 
 
 # noinspection PyMethodMayBeStatic
@@ -32,7 +32,7 @@ class LogUploadMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            f"{index}": Option(self.upload, opt_index=f"{index}")
+            f"{index}": Option(self.upload, False, opt_index=f"{index}")
             for index in range(len(self.logfile_list))
         }
 

kiauh/components/mobileraker/mobileraker.py

@@ -27,9 +27,7 @@ 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 (
@@ -37,13 +35,14 @@ from utils.git_utils import (
     git_pull_wrapper,
 )
 from utils.input_utils import get_confirm
-from utils.instance_utils import get_instances
+from utils.logger import DialogType, Logger
 from utils.sys_utils import (
     check_python_version,
     cmd_sysctl_service,
     install_python_requirements,
-    remove_system_service,
+    remove_service_file,
 )
+from utils.types import ComponentStatus
 
 
 def install_mobileraker() -> None:
@@ -52,7 +51,8 @@ def install_mobileraker() -> None:
     if not check_python_version(3, 7):
         return
 
-    mr_instances = get_instances(Moonraker)
+    mr_im = InstanceManager(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)
-            InstanceManager.restart_all(mr_instances)
+            mr_im.restart_all_instance()
         else:
             Logger.print_info(
                 "Moonraker is not installed! Cannot add Mobileraker's "
@@ -161,17 +161,22 @@ def remove_mobileraker() -> None:
             Logger.print_warn("Mobileraker's companion environment not found!")
 
         if MOBILERAKER_SERVICE_FILE.exists():
-            remove_system_service(MOBILERAKER_SERVICE_NAME)
+            remove_service_file(
+                MOBILERAKER_SERVICE_NAME,
+                MOBILERAKER_SERVICE_FILE,
+            )
 
-        kl_instances: List[Klipper] = get_instances(Klipper)
+        kl_im = InstanceManager(Klipper)
+        kl_instances: List[Klipper] = kl_im.instances
         for instance in kl_instances:
-            logfile = instance.base.log_dir.joinpath(MOBILERAKER_LOG_NAME)
+            logfile = instance.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_instances: List[Moonraker] = get_instances(Moonraker)
+        mr_im = InstanceManager(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

@@ -35,12 +35,12 @@ class MoonrakerRemoveMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            "a": Option(method=self.toggle_all),
+            "a": Option(method=self.toggle_all, menu=False),
-            "1": Option(method=self.toggle_remove_moonraker_service),
+            "1": Option(method=self.toggle_remove_moonraker_service, menu=False),
-            "2": Option(method=self.toggle_remove_moonraker_dir),
+            "2": Option(method=self.toggle_remove_moonraker_dir, menu=False),
-            "3": Option(method=self.toggle_remove_moonraker_env),
+            "3": Option(method=self.toggle_remove_moonraker_env, menu=False),
-            "4": Option(method=self.toggle_remove_moonraker_polkit),
+            "4": Option(method=self.toggle_remove_moonraker_polkit, menu=False),
-            "c": Option(method=self.run_removal_process),
+            "c": Option(method=self.run_removal_process, menu=False),
         }
 
     def print_menu(self) -> None:

kiauh/components/moonraker/moonraker.py

@@ -8,11 +8,10 @@
 # ======================================================================= #
 from __future__ import annotations
 
-from dataclasses import dataclass, field
+from dataclasses import dataclass
 from pathlib import Path
-from subprocess import CalledProcessError
+from subprocess import CalledProcessError, run
 
-from components.klipper.klipper import Klipper
 from components.moonraker import (
     MOONRAKER_CFG_NAME,
     MOONRAKER_DIR,
@@ -22,58 +21,50 @@ 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.fs_utils import create_folders
+from utils.logger import Logger
-from utils.sys_utils import get_service_file_path
 
 
 # noinspection PyMethodMayBeStatic
 @dataclass
-class Moonraker:
+class Moonraker(BaseInstance):
-    suffix: str
-    base: BaseInstance = field(init=False, repr=False)
-    service_file_path: Path = field(init=False)
-    log_file_name: str = MOONRAKER_LOG_NAME
     moonraker_dir: Path = MOONRAKER_DIR
     env_dir: Path = MOONRAKER_ENV_DIR
-    data_dir: Path = field(init=False)
+    cfg_file: Path | None = None
-    cfg_file: Path = field(init=False)
+    port: int | None = None
-    backup_dir: Path = field(init=False)
+    backup_dir: Path | None = None
-    certs_dir: Path = field(init=False)
+    certs_dir: Path | None = None
-    db_dir: Path = field(init=False)
+    db_dir: Path | None = None
-    port: int | None = field(init=False)
+    log: Path | None = None
 
-    def __post_init__(self):
+    def __init__(self, suffix: str = ""):
-        self.base: BaseInstance = BaseInstance(Klipper, self.suffix)
+        super().__init__(suffix=suffix)
-        self.base.log_file_name = self.log_file_name
 
-        self.service_file_path: Path = get_service_file_path(Moonraker, self.suffix)
+    def __post_init__(self) -> None:
-        self.data_dir: Path = self.base.data_dir
+        super().__post_init__()
-        self.cfg_file: Path = self.base.cfg_dir.joinpath(MOONRAKER_CFG_NAME)
+        self.cfg_file = self.cfg_dir.joinpath(MOONRAKER_CFG_NAME)
-        self.backup_dir: Path = self.base.data_dir.joinpath("backup")
+        self.port = self._get_port()
-        self.certs_dir: Path = self.base.data_dir.joinpath("certs")
+        self.backup_dir = self.data_dir.joinpath("backup")
-        self.db_dir: Path = self.base.data_dir.joinpath("database")
+        self.certs_dir = self.data_dir.joinpath("certs")
-        self.port: int | None = self._get_port()
+        self.db_dir = self.data_dir.joinpath("database")
+        self.log = self.log_dir.joinpath(MOONRAKER_LOG_NAME)
 
-    def create(self) -> None:
+    def create(self, create_example_cfg: bool = False) -> None:
         from utils.sys_utils import create_env_file, create_service_file
 
         Logger.print_status("Creating new Moonraker Instance ...")
 
         try:
-            create_folders(self.base.base_folders)
+            self.create_folders([self.backup_dir, self.certs_dir, self.db_dir])
-
             create_service_file(
-                name=self.service_file_path.name,
+                name=self.get_service_file_name(extension=True),
                 content=self._prep_service_file_content(),
             )
             create_env_file(
-                path=self.base.sysd_dir.joinpath(MOONRAKER_ENV_FILE_NAME),
+                path=self.sysd_dir.joinpath(MOONRAKER_ENV_FILE_NAME),
                 content=self._prep_env_file_content(),
             )
 
@@ -84,6 +75,21 @@ class Moonraker:
             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
 
@@ -96,7 +102,7 @@ class Moonraker:
 
         service_content = template_content.replace(
             "%USER%",
-            CURRENT_USER,
+            self.user,
         )
         service_content = service_content.replace(
             "%MOONRAKER_DIR%",
@@ -108,7 +114,7 @@ class Moonraker:
         )
         service_content = service_content.replace(
             "%ENV_FILE%",
-            self.base.sysd_dir.joinpath(MOONRAKER_ENV_FILE_NAME).as_posix(),
+            self.sysd_dir.joinpath(MOONRAKER_ENV_FILE_NAME).as_posix(),
         )
         return service_content
 
@@ -128,7 +134,7 @@ class Moonraker:
         )
         env_file_content = env_file_content.replace(
             "%PRINTER_DATA%",
-            self.base.data_dir.as_posix(),
+            self.data_dir.as_posix(),
         )
 
         return env_file_content

kiauh/components/moonraker/moonraker_dialogs.py

@@ -37,8 +37,8 @@ def print_moonraker_overview(
         dialog += "║                                                       ║\n"
 
     instance_map = {
-        k.service_file_path.stem: (
+        k.get_service_file_name(): (
-            k.service_file_path.stem.replace("klipper", "moonraker")
+            k.get_service_file_name().replace("klipper", "moonraker")
             if k.suffix in [m.suffix for m in moonraker_instances]
             else ""
         )

kiauh/components/moonraker/moonraker_remove.py

@@ -15,11 +15,10 @@ 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.instance_utils import get_instances
+from utils.logger import Logger
-from utils.sys_utils import unit_file_exists
+from utils.sys_utils import cmd_sysctl_manage
 
 
 def run_moonraker_removal(
@@ -28,18 +27,17 @@ def run_moonraker_removal(
     remove_env: bool,
     remove_polkit: bool,
 ) -> None:
-    instances = get_instances(Moonraker)
+    im = InstanceManager(Moonraker)
 
     if remove_service:
         Logger.print_status("Removing Moonraker instances ...")
-        if instances:
+        if im.instances:
-            instances_to_remove = select_instances_to_remove(instances)
+            instances_to_remove = select_instances_to_remove(im.instances)
-            remove_instances(instances_to_remove)
+            remove_instances(im, instances_to_remove)
         else:
             Logger.print_info("No Moonraker Services installed! Skipped ...")
 
-    delete_remaining: bool = remove_polkit or remove_dir or remove_env
+    if (remove_polkit or remove_dir or remove_env) and im.instances:
-    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
@@ -86,14 +84,20 @@ def select_instances_to_remove(
 
 
 def remove_instances(
+    instance_manager: InstanceManager,
     instance_list: List[Moonraker] | None,
 ) -> None:
     if not instance_list:
         Logger.print_info("No Moonraker instances found. Skipped ...")
         return
     for instance in instance_list:
-        Logger.print_status(f"Removing instance {instance.service_file_path.stem} ...")
+        Logger.print_status(f"Removing instance {instance.get_service_file_name()} ...")
-        InstanceManager.remove(instance)
+        instance_manager.current_instance = 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 +118,7 @@ def remove_polkit_rules() -> None:
 def delete_moonraker_logs(instances: List[Moonraker]) -> None:
     all_logfiles = []
     for instance in instances:
-        all_logfiles = list(instance.base.log_dir.glob("moonraker.log*"))
+        all_logfiles = list(instance.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,7 +38,6 @@ 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
@@ -47,11 +46,10 @@ from utils.input_utils import (
     get_confirm,
     get_selection_input,
 )
-from utils.instance_utils import get_instances
+from utils.logger import Logger
 from utils.sys_utils import (
     check_python_version,
     cmd_sysctl_manage,
-    cmd_sysctl_service,
     create_python_venv,
     install_python_requirements,
     parse_packages_from_file,
@@ -59,17 +57,18 @@ from utils.sys_utils import (
 
 
 def install_moonraker() -> None:
-    klipper_list: List[Klipper] = get_instances(Klipper)
+    if not check_moonraker_install_requirements():
-
-    if not check_moonraker_install_requirements(klipper_list):
         return
 
-    moonraker_list: List[Moonraker] = get_instances(Moonraker)
+    klipper_list: List[Klipper] = InstanceManager(Klipper).instances
-    instances: List[Moonraker] = []
+    mr_im = InstanceManager(Moonraker)
+    moonraker_list: List[Moonraker] = mr_im.instances
+
+    instance_names = []
     selected_option: str | Klipper
 
-    if len(klipper_list) == 1:
+    if len(klipper_list) == 0:
-        instances.append(Moonraker(klipper_list[0].suffix))
+        instance_names.append(klipper_list[0].suffix)
     else:
         print_moonraker_overview(
             klipper_list,
@@ -88,12 +87,12 @@ def install_moonraker() -> None:
             return
 
         if selected_option == "a":
-            instances.extend([Moonraker(k.suffix) for k in klipper_list])
+            instance_names.extend([k.suffix for k in klipper_list])
         else:
             klipper_instance: Klipper | None = options.get(selected_option)
             if klipper_instance is None:
                 raise Exception("Error selecting instance!")
-            instances.append(Moonraker(klipper_instance.suffix))
+            instance_names.append(klipper_instance.suffix)
 
     create_example_cfg = get_confirm("Create example moonraker.conf?")
 
@@ -103,23 +102,26 @@ def install_moonraker() -> None:
         install_moonraker_polkit()
 
         used_ports_map = {m.suffix: m.port for m in moonraker_list}
-        for instance in instances:
+        for name in instance_names:
-            instance.create()
+            current_instance = Moonraker(suffix=name)
-            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(instance, used_ports_map, clients)
+                create_example_moonraker_conf(current_instance, used_ports_map, clients)
 
-            cmd_sysctl_service(instance.service_file_path.name, "start")
+            mr_im.start_instance()
 
         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(moonraker_list) > 1:
+        if MainsailData().client_dir.exists() and len(mr_im.instances) > 1:
             enable_mainsail_remotemode()
 
     except Exception as e:
@@ -127,9 +129,9 @@ def install_moonraker() -> None:
         return
 
 
-def check_moonraker_install_requirements(klipper_list: List[Klipper]) -> bool:
+def check_moonraker_install_requirements() -> bool:
     def check_klipper_instances() -> bool:
-        if len(klipper_list) >= 1:
+        if len(InstanceManager(Klipper).instances) >= 1:
             return True
 
         Logger.print_warn("Klipper not installed!")
@@ -148,9 +150,9 @@ def setup_moonraker_prerequesites() -> None:
 
     # install moonraker dependencies and create python virtualenv
     install_moonraker_packages()
-    if create_python_venv(MOONRAKER_ENV_DIR):
+    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:
@@ -206,8 +208,8 @@ def update_moonraker() -> None:
     if settings.kiauh.backup_before_update:
         backup_moonraker_dir()
 
-    instances = get_instances(Moonraker)
+    instance_manager = InstanceManager(Moonraker)
-    InstanceManager.stop_all(instances)
+    instance_manager.stop_all_instance()
 
     git_pull_wrapper(repo=settings.moonraker.repo_url, target_dir=MOONRAKER_DIR)
 
@@ -216,4 +218,4 @@ def update_moonraker() -> None:
     # install possible new python dependencies
     install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
 
-    InstanceManager.start_all(instances)
+    instance_manager.start_all_instance()

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.logger import Logger
+from core.instance_manager.instance_manager import InstanceManager
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
-from core.types import ComponentStatus
 from utils.common import get_install_status
-from utils.instance_utils import get_instances
+from utils.logger import Logger
 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.base.cfg_dir}'")
+    Logger.print_status(f"Creating example moonraker.conf in '{instance.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.base.comms_dir.joinpath("klippy.sock")
+    uds = instance.comms_dir.joinpath("klippy.sock")
 
     scp = SimpleConfigParser()
     scp.read(target)
@@ -123,7 +123,7 @@ 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.base.cfg_dir}'")
+    Logger.print_ok(f"Example moonraker.conf created in '{instance.cfg_dir}'")
 
 
 def backup_moonraker_dir() -> None:
@@ -135,11 +135,12 @@ def backup_moonraker_dir() -> None:
 
 
 def backup_moonraker_db_dir() -> None:
-    instances: List[Moonraker] = get_instances(Moonraker)
+    im = InstanceManager(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

@@ -8,57 +8,48 @@
 # ======================================================================= #
 from __future__ import annotations
 
-from dataclasses import dataclass, field
+from dataclasses import dataclass
 from pathlib import Path
 from subprocess import CalledProcessError, run
 
 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 core.logger import Logger
+from utils.logger import Logger
-from utils.sys_utils import get_service_file_path
 
 
 @dataclass
-class Octoeverywhere:
+class Octoeverywhere(BaseInstance):
-    suffix: str
-    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 = OE_STORE_DIR
-    store_dir: Path = field(init=False)
+    cfg_file: Path | None = None
-    cfg_file: Path = field(init=False)
+    sys_cfg_file: Path | None = None
-    sys_cfg_file: Path = field(init=False)
+    log: Path | None = None
+
+    def __init__(self, suffix: str = ""):
+        super().__init__(suffix=suffix)
 
     def __post_init__(self):
-        self.base: BaseInstance = BaseInstance(Moonraker, self.suffix)
+        super().__post_init__()
-        self.base.log_file_name = self.log_file_name
+        self.cfg_file = self.cfg_dir.joinpath(OE_CFG_NAME)
-
+        self.sys_cfg_file = self.cfg_dir.joinpath(OE_SYS_CFG_NAME)
-        self.service_file_path: Path = get_service_file_path(
+        self.log = self.log_dir.joinpath(OE_LOG_NAME)
-            Octoeverywhere, self.suffix
-        )
-        self.store_dir = self.base.data_dir.joinpath("store")
-        self.cfg_file = self.base.cfg_dir.joinpath(OE_CFG_NAME)
-        self.sys_cfg_file = self.base.cfg_dir.joinpath(OE_SYS_CFG_NAME)
-        self.data_dir = self.base.data_dir
-        self.sys_cfg_file = self.base.cfg_dir.joinpath(OE_SYS_CFG_NAME)
 
     def create(self) -> None:
         Logger.print_status("Creating OctoEverywhere for Klipper Instance ...")
 
         try:
-            cmd = f"{OE_INSTALL_SCRIPT} {self.base.cfg_dir}/{MOONRAKER_CFG_NAME}"
+            cmd = f"{OE_INSTALL_SCRIPT} {self.cfg_dir}/{MOONRAKER_CFG_NAME}"
             run(cmd, check=True, shell=True)
 
         except CalledProcessError as e:
@@ -73,3 +64,20 @@ class Octoeverywhere:
         except CalledProcessError as e:
             Logger.print_error(f"Error updating OctoEverywhere for Klipper: {e}")
             raise
+
+    def delete(self) -> None:
+        service_file: str = self.get_service_file_name(extension=True)
+        service_file_path: 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.as_posix()]
+            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,8 +22,6 @@ 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,
@@ -35,11 +33,13 @@ 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.instance_utils import get_instances
+from utils.logger import DialogType, Logger
 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,7 +54,8 @@ def install_octoeverywhere() -> None:
         return
 
     force_clone = False
-    oe_instances: List[Octoeverywhere] = get_instances(Octoeverywhere)
+    oe_im = InstanceManager(Octoeverywhere)
+    oe_instances: List[Octoeverywhere] = oe_im.instances
     if oe_instances:
         Logger.print_dialog(
             DialogType.INFO,
@@ -63,6 +64,8 @@ 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 ...")
@@ -71,9 +74,10 @@ def install_octoeverywhere() -> None:
             Logger.print_status("Re-Installing OctoEverywhere for Klipper ...")
             force_clone = True
 
-    mr_instances: List[Moonraker] = get_instances(Moonraker)
+    mr_im = InstanceManager(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,
@@ -83,6 +87,8 @@ 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(
@@ -97,10 +103,10 @@ def install_octoeverywhere() -> None:
         git_clone_wrapper(OE_REPO, OE_DIR, force=force_clone)
 
         for moonraker in mr_instances:
-            instance = Octoeverywhere(suffix=moonraker.suffix)
+            oe_im.current_instance = Octoeverywhere(suffix=moonraker.suffix)
-            instance.create()
+            oe_im.create_instance()
 
-        InstanceManager.restart_all(mr_instances)
+        mr_im.restart_all_instance()
 
         Logger.print_dialog(
             DialogType.SUCCESS,
@@ -130,12 +136,13 @@ def update_octoeverywhere() -> None:
 
 def remove_octoeverywhere() -> None:
     Logger.print_status("Removing OctoEverywhere for Klipper ...")
-
+    mr_im = InstanceManager(Moonraker)
-    mr_instances: List[Moonraker] = get_instances(Moonraker)
+    mr_instances: List[Moonraker] = mr_im.instances
-    ob_instances: List[Octoeverywhere] = get_instances(Octoeverywhere)
+    ob_im = InstanceManager(Octoeverywhere)
+    ob_instances: List[Octoeverywhere] = ob_im.instances
 
     try:
-        remove_oe_instances(ob_instances)
+        remove_oe_instances(ob_im, ob_instances)
         remove_oe_dir()
         remove_oe_env()
         remove_config_section(f"include {OE_SYS_CFG_NAME}", mr_instances)
@@ -166,6 +173,7 @@ def install_oe_dependencies() -> None:
 
 
 def remove_oe_instances(
+    instance_manager: InstanceManager,
     instance_list: List[Octoeverywhere],
 ) -> None:
     if not instance_list:
@@ -173,8 +181,13 @@ def remove_oe_instances(
         return
 
     for instance in instance_list:
-        Logger.print_status(f"Removing instance {instance.service_file_path.stem} ...")
+        Logger.print_status(f"Removing instance {instance.get_service_file_name()} ...")
-        InstanceManager.remove(instance)
+        instance_manager.current_instance = 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,8 +9,7 @@
 
 from __future__ import annotations
 
-from abc import ABC
+from abc import ABC, abstractmethod
-from dataclasses import dataclass
 from enum import Enum
 from pathlib import Path
 
@@ -25,32 +24,89 @@ class WebClientConfigType(Enum):
     FLUIDD: str = "fluidd-config"
 
 
-@dataclass()
 class BaseWebClient(ABC):
     """Base class for webclient data"""
 
-    client: WebClientType
+    @property
-    name: str
+    @abstractmethod
-    display_name: str
+    def client(self) -> WebClientType:
-    client_dir: Path
+        raise NotImplementedError
-    config_file: Path
+
-    backup_dir: Path
+    @property
-    repo_path: str
+    @abstractmethod
-    download_url: str
+    def name(self) -> str:
-    nginx_access_log: Path
+        raise NotImplementedError
-    nginx_error_log: Path
+
-    client_config: BaseWebClientConfig
+    @property
+    @abstractmethod
+    def display_name(self) -> str:
+        raise NotImplementedError
+
+    @property
+    @abstractmethod
+    def client_dir(self) -> Path:
+        raise NotImplementedError
+
+    @property
+    @abstractmethod
+    def backup_dir(self) -> Path:
+        raise NotImplementedError
+
+    @property
+    @abstractmethod
+    def repo_path(self) -> str:
+        raise NotImplementedError
+
+    @property
+    @abstractmethod
+    def download_url(self) -> str:
+        raise NotImplementedError
+
+    @property
+    @abstractmethod
+    def client_config(self) -> BaseWebClientConfig:
+        raise NotImplementedError
 
 
-@dataclass()
 class BaseWebClientConfig(ABC):
     """Base class for webclient config data"""
 
-    client_config: WebClientConfigType
+    @property
-    name: str
+    @abstractmethod
-    display_name: str
+    def client_config(self) -> WebClientConfigType:
-    config_filename: str
+        raise NotImplementedError
-    config_dir: Path
+
-    backup_dir: Path
+    @property
-    repo_url: str
+    @abstractmethod
-    config_section: str
+    def name(self) -> str:
+        raise NotImplementedError
+
+    @property
+    @abstractmethod
+    def display_name(self) -> str:
+        raise NotImplementedError
+
+    @property
+    @abstractmethod
+    def config_filename(self) -> str:
+        raise NotImplementedError
+
+    @property
+    @abstractmethod
+    def config_dir(self) -> Path:
+        raise NotImplementedError
+
+    @property
+    @abstractmethod
+    def backup_dir(self) -> Path:
+        raise NotImplementedError
+
+    @property
+    @abstractmethod
+    def repo_url(self) -> str:
+        raise NotImplementedError
+
+    @property
+    @abstractmethod
+    def config_section(self) -> str:
+        raise NotImplementedError

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.logger import Logger
+from core.instance_manager.instance_manager import InstanceManager
 from utils.config_utils import remove_config_section
 from utils.fs_utils import run_remove_routines
-from utils.instance_utils import get_instances
+from utils.logger import Logger
 
 
 def run_client_config_removal(
@@ -36,8 +36,7 @@ def remove_client_config_dir(client_config: BaseWebClientConfig) -> None:
 
 
 def remove_client_config_symlink(client_config: BaseWebClientConfig) -> None:
-    instances: List[Klipper] = get_instances(Klipper)
+    im = InstanceManager(Klipper)
+    instances: List[Klipper] = im.instances
     for instance in instances:
-        run_remove_routines(
+        run_remove_routines(instance.cfg_dir.joinpath(client_config.config_filename))
-            instance.base.cfg_dir.joinpath(client_config.config_filename)
-        )

kiauh/components/webui_client/client_config/client_config_setup.py

@@ -24,14 +24,13 @@ 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.instance_utils import get_instances
+from utils.logger import Logger
 
 
 def install_client_config(client_data: BaseWebClient) -> None:
@@ -49,8 +48,10 @@ def install_client_config(client_data: BaseWebClient) -> None:
         else:
             return
 
-    mr_instances: List[Moonraker] = get_instances(Moonraker)
+    mr_im = InstanceManager(Moonraker)
-    kl_instances = get_instances(Klipper)
+    mr_instances: List[Moonraker] = mr_im.instances
+    kl_im = InstanceManager(Klipper)
+    kl_instances = kl_im.instances
 
     try:
         download_client_config(client_config)
@@ -70,7 +71,7 @@ def install_client_config(client_data: BaseWebClient) -> None:
             ],
         )
         add_config_section_at_top(client_config.config_section, kl_instances)
-        InstanceManager.restart_all(kl_instances)
+        kl_im.restart_all_instance()
 
     except Exception as e:
         Logger.print_error(f"{display_name} installation failed!\n{e}")
@@ -112,12 +113,16 @@ def update_client_config(client: BaseWebClient) -> None:
 
 
 def create_client_config_symlink(
-    client_config: BaseWebClientConfig, klipper_instances: List[Klipper]
+    client_config: BaseWebClientConfig, klipper_instances: List[Klipper] | None = None
 ) -> 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:
-        Logger.print_status(f"Create symlink for {client_config.config_filename} ...")
+        target = instance.cfg_dir
-        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,7 +10,7 @@
 from typing import List
 
 from components.webui_client.base_data import BaseWebClient
-from core.logger import DialogType, Logger
+from utils.logger import DialogType, Logger
 
 
 def print_moonraker_not_found_dialog() -> None:
@@ -24,6 +24,8 @@ def print_moonraker_not_found_dialog() -> None:
             "another machine in your network. Otherwise Mainsail will NOT work "
             "correctly.",
         ],
+        padding_top=0,
+        padding_bottom=0,
     )
 
 
@@ -34,6 +36,8 @@ def print_client_already_installed_dialog(name: str) -> None:
             f"{name} seems to be already installed!",
             f"If you continue, your current {name} installation will be overwritten.",
         ],
+        padding_top=0,
+        padding_bottom=0,
     )
 
 
@@ -53,6 +57,8 @@ def print_client_port_select_dialog(
             "The following ports were found to be in use already:",
             *[f"● {port}" for port in ports_in_use],
         ],
+        padding_top=0,
+        padding_bottom=0,
     )
 
 
@@ -71,6 +77,8 @@ 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,45 +6,49 @@
 #                                                                         #
 #  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 core.backup_manager.backup_manager import BackupManager
+from components.webui_client.client_utils import backup_mainsail_config_json
-from core.constants import NGINX_SITES_AVAILABLE, NGINX_SITES_ENABLED
+from core.instance_manager.instance_manager import InstanceManager
-from core.logger import Logger
 from utils.config_utils import remove_config_section
 from utils.fs_utils import (
-    remove_with_sudo,
+    remove_nginx_config,
+    remove_nginx_logs,
     run_remove_routines,
 )
-from utils.instance_utils import get_instances
+from utils.logger import Logger
 
 
 def run_client_removal(
     client: BaseWebClient,
     remove_client: bool,
     remove_client_cfg: bool,
-    backup_config: bool,
+    backup_ms_config_json: bool,
 ) -> None:
-    mr_instances: List[Moonraker] = get_instances(Moonraker)
+    mr_im = InstanceManager(Moonraker)
-    kl_instances: List[Klipper] = get_instances(Klipper)
+    mr_instances: List[Moonraker] = mr_im.instances
+    kl_im = InstanceManager(Klipper)
+    kl_instances: List[Klipper] = kl_im.instances
 
-    if backup_config:
+    if backup_ms_config_json and client.client == WebClientType.MAINSAIL:
-        bm = BackupManager()
+        backup_mainsail_config_json()
-        bm.backup_file(client.config_file)
 
     if remove_client:
         client_name = client.name
         remove_client_dir(client)
-        remove_client_nginx_config(client_name)
+        remove_nginx_config(client_name)
-        remove_client_nginx_logs(client, kl_instances)
+        remove_nginx_logs(client_name, kl_instances)
 
         section = f"update_manager {client_name}"
         remove_config_section(section, mr_instances)
@@ -60,26 +64,3 @@ 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,8 +6,7 @@
 #                                                                         #
 #  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
 
@@ -28,24 +27,27 @@ from components.webui_client.client_dialogs import (
     print_moonraker_not_found_dialog,
 )
 from components.webui_client.client_utils import (
-    copy_common_vars_nginx_cfg,
+    backup_mainsail_config_json,
-    copy_upstream_nginx_cfg,
-    create_nginx_cfg,
     detect_client_cfg_conflict,
     enable_mainsail_remotemode,
-    get_next_free_port,
+    restore_mainsail_config_json,
-    is_valid_port,
-    read_ports_from_nginx_configs,
     symlink_webui_nginx_log,
 )
 from core.instance_manager.instance_manager import InstanceManager
-from core.logger import Logger
 from core.settings.kiauh_settings import KiauhSettings
 from utils.common import check_install_dependencies
 from utils.config_utils import add_config_section
-from utils.fs_utils import unzip
+from utils.fs_utils import (
+    copy_common_vars_nginx_cfg,
+    copy_upstream_nginx_cfg,
+    create_nginx_cfg,
+    get_next_free_port,
+    is_valid_port,
+    read_ports_from_nginx_configs,
+    unzip,
+)
 from utils.input_utils import get_confirm, get_number_input
-from utils.instance_utils import get_instances
+from utils.logger import Logger
 from utils.sys_utils import (
     cmd_sysctl_service,
     download_file,
@@ -63,7 +65,8 @@ def install_client(client: BaseWebClient) -> None:
         )
         return
 
-    mr_instances: List[Moonraker] = get_instances(Moonraker)
+    mr_im = InstanceManager(Moonraker)
+    mr_instances: List[Moonraker] = mr_im.instances
 
     enable_remotemode = False
     if not mr_instances:
@@ -80,7 +83,8 @@ def install_client(client: BaseWebClient) -> None:
     ):
         enable_remotemode = True
 
-    kl_instances = get_instances(Klipper)
+    kl_im = InstanceManager(Klipper)
+    kl_instances = kl_im.instances
     install_client_cfg = False
     client_config: BaseWebClientConfig = client.client_config
     if (
@@ -125,7 +129,7 @@ def install_client(client: BaseWebClient) -> None:
                     ("path", str(client.client_dir)),
                 ],
             )
-            InstanceManager.restart_all(mr_instances)
+            mr_im.restart_all_instance()
         if install_client_cfg and kl_instances:
             install_client_config(client)
 
@@ -141,7 +145,7 @@ def install_client(client: BaseWebClient) -> None:
         )
 
         if kl_instances:
-            symlink_webui_nginx_log(client, kl_instances)
+            symlink_webui_nginx_log(kl_instances)
         cmd_sysctl_service("nginx", "restart")
 
     except Exception as e:
@@ -181,10 +185,10 @@ def update_client(client: BaseWebClient) -> None:
         )
         return
 
-    with tempfile.NamedTemporaryFile(suffix=".json") as tmp_file:
+    if client.client == WebClientType.MAINSAIL:
-        Logger.print_status(
+        backup_mainsail_config_json(is_temp=True)
-            f"Creating temporary backup of {client.config_file} as {tmp_file.name} ..."
+
-        )
+    download_client(client)
-        shutil.copy(client.config_file, tmp_file.name)
+
-        download_client(client)
+    if client.client == WebClientType.MAINSAIL:
-        shutil.copy(tmp_file.name, client.config_file)
+        restore_mainsail_config_json()

kiauh/components/webui_client/client_utils.py

@@ -9,14 +9,11 @@
 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,
@@ -24,23 +21,16 @@ 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 (
+from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
-    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 core.types import ComponentStatus
+from utils import NGINX_CONFD, NGINX_SITES_AVAILABLE
 from utils.common import get_install_status
-from utils.fs_utils import create_symlink, remove_file
 from utils.git_utils import (
-    get_latest_remote_tag,
+    get_latest_tag,
     get_latest_unstable_tag,
 )
+from utils.logger import Logger
+from utils.types import ComponentStatus
 
 
 def get_client_status(
@@ -83,6 +73,26 @@ def get_current_client_config(clients: List[BaseWebClient]) -> str:
     return f"{COLOR_CYAN}-{RESET_FORMAT}"
 
 
+def backup_mainsail_config_json(is_temp: bool = 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")
@@ -101,19 +111,17 @@ def enable_mainsail_remotemode() -> None:
     Logger.print_ok("Mainsails remote mode enabled!")
 
 
-def symlink_webui_nginx_log(
+def symlink_webui_nginx_log(klipper_instances: List[Klipper]) -> None:
-    client: BaseWebClient, klipper_instances: List[Klipper]
-) -> None:
     Logger.print_status("Link NGINX logs into log directory ...")
-    access_log = client.nginx_access_log
+    access_log = Path("/var/log/nginx/mainsail-access.log")
-    error_log = client.nginx_error_log
+    error_log = Path("/var/log/nginx/mainsail-error.log")
 
     for instance in klipper_instances:
-        desti_access = instance.base.log_dir.joinpath(access_log.name)
+        desti_access = instance.log_dir.joinpath("mainsail-access.log")
         if not desti_access.exists():
             desti_access.symlink_to(access_log)
 
-        desti_error = instance.base.log_dir.joinpath(error_log.name)
+        desti_error = instance.log_dir.joinpath("mainsail-error.log")
         if not desti_error.exists():
             desti_error.symlink_to(error_log)
 
@@ -137,7 +145,7 @@ def get_local_client_version(client: BaseWebClient) -> str | None:
 
 def get_remote_client_version(client: BaseWebClient) -> str | None:
     try:
-        if (tag := get_latest_remote_tag(client.repo_path)) != "":
+        if (tag := get_latest_tag(client.repo_path)) != "":
             return str(tag)
         return None
     except Exception:
@@ -154,7 +162,9 @@ def backup_client_data(client: BaseWebClient) -> None:
 
     bm = BackupManager()
     bm.backup_directory(f"{name}-{version}", src, dest)
-    bm.backup_file(client.config_file, dest)
+    if name == "mainsail":
+        c_json = MainsailData().client_dir.joinpath("config.json")
+        bm.backup_file(c_json, dest)
     bm.backup_file(NGINX_SITES_AVAILABLE.joinpath(name), dest)
 
 
@@ -212,132 +222,3 @@ 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()
+@dataclass(frozen=True)
 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()
+@dataclass(frozen=True)
 class FluiddData(BaseWebClient):
     BASE_DL_URL = "https://github.com/fluidd-core/fluidd/releases"
 
@@ -41,16 +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
 
-    def __post_init__(self):
+    @property
+    def download_url(self) -> str:
         from components.webui_client.client_utils import get_download_url
 
-        self.client_config = FluiddConfigWeb()
+        url: str = get_download_url(self.BASE_DL_URL, self)
-        self.download_url = get_download_url(self.BASE_DL_URL, self)
+        return url
+
+    @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()
+@dataclass(frozen=True)
 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()
+@dataclass(frozen=True)
 class MainsailData(BaseWebClient):
     BASE_DL_URL: str = "https://github.com/mainsail-crew/mainsail/releases"
 
@@ -41,16 +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
 
-    def __post_init__(self):
+    @property
+    def download_url(self) -> str:
         from components.webui_client.client_utils import get_download_url
 
-        self.client_config = MainsailConfigWeb()
+        url: str = get_download_url(self.BASE_DL_URL, self)
-        self.download_url = get_download_url(self.BASE_DL_URL, self)
+        return url
+
+    @property
+    def client_config(self) -> BaseWebClientConfig:
+        return MainsailConfigWeb()

kiauh/components/webui_client/menus/client_remove_menu.py

@@ -12,7 +12,7 @@ import textwrap
 from typing import Type
 
 from components.webui_client import client_remove
-from components.webui_client.base_data import BaseWebClient
+from components.webui_client.base_data import BaseWebClient, WebClientType
 from core.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
@@ -28,7 +28,7 @@ class ClientRemoveMenu(BaseMenu):
         self.client: BaseWebClient = client
         self.remove_client: bool = False
         self.remove_client_cfg: bool = False
-        self.backup_config_json: bool = False
+        self.backup_mainsail_config_json: bool = False
         self.selection_state: bool = False
 
     def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
@@ -38,12 +38,13 @@ class ClientRemoveMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            "a": Option(method=self.toggle_all),
+            "a": Option(method=self.toggle_all, menu=False),
-            "1": Option(method=self.toggle_rm_client),
+            "1": Option(method=self.toggle_rm_client, menu=False),
-            "2": Option(method=self.toggle_rm_client_config),
+            "2": Option(method=self.toggle_rm_client_config, menu=False),
-            "3": Option(method=self.toggle_backup_config_json),
+            "c": Option(method=self.run_removal_process, menu=False),
-            "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
@@ -57,7 +58,6 @@ 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"""
             ╔═══════════════════════════════════════════════════════╗
@@ -70,7 +70,19 @@ 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                                          ║
             ╟───────────────────────────────────────────────────────╢
@@ -82,7 +94,7 @@ class ClientRemoveMenu(BaseMenu):
         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
+        self.backup_mainsail_config_json = self.selection_state
 
     def toggle_rm_client(self, **kwargs) -> None:
         self.remove_client = not self.remove_client
@@ -90,14 +102,14 @@ class ClientRemoveMenu(BaseMenu):
     def toggle_rm_client_config(self, **kwargs) -> None:
         self.remove_client_cfg = not self.remove_client_cfg
 
-    def toggle_backup_config_json(self, **kwargs) -> None:
+    def toggle_backup_mainsail_config_json(self, **kwargs) -> None:
-        self.backup_config_json = not self.backup_config_json
+        self.backup_mainsail_config_json = not self.backup_mainsail_config_json
 
     def run_removal_process(self, **kwargs) -> None:
         if (
             not self.remove_client
             and not self.remove_client_cfg
-            and not self.backup_config_json
+            and not self.backup_mainsail_config_json
         ):
             error = f"{COLOR_RED}Nothing selected ...{RESET_FORMAT}"
             print(error)
@@ -107,12 +119,12 @@ class ClientRemoveMenu(BaseMenu):
             client=self.client,
             remove_client=self.remove_client,
             remove_client_cfg=self.remove_client_cfg,
-            backup_config=self.backup_config_json,
+            backup_ms_config_json=self.backup_mainsail_config_json,
         )
 
         self.remove_client = False
         self.remove_client_cfg = False
-        self.backup_config_json = False
+        self.backup_mainsail_config_json = False
 
         self._go_back()
 

kiauh/core/backup_manager/backup_manager.py

@@ -13,12 +13,8 @@ from pathlib import Path
 from typing import List
 
 from core.backup_manager import BACKUP_ROOT_DIR
-from core.logger import Logger
 from utils.common import get_current_date
-
+from utils.logger import Logger
-
-class BackupManagerException(Exception):
-    pass
 
 
 # noinspection PyUnusedLocal
@@ -69,7 +65,7 @@ class BackupManager:
 
     def backup_directory(
         self, name: str, source: Path, target: Path | None = None
-    ) -> Path | None:
+    ) -> None:
         Logger.print_status(f"Creating backup of {name} in {target} ...")
 
         if source is None or not Path(source).exists():
@@ -80,15 +76,15 @@ class BackupManager:
         try:
             date = get_current_date().get("date")
             time = get_current_date().get("time")
-            backup_target = target.joinpath(f"{name.lower()}-{date}-{time}")
+            shutil.copytree(
-            shutil.copytree(source, backup_target, ignore=self.ignore_folders_func)
+                source,
+                target.joinpath(f"{name.lower()}-{date}-{time}"),
+                ignore=self.ignore_folders_func,
+            )
             Logger.print_ok("Backup successful!")
-
-            return backup_target
-
         except OSError as e:
             Logger.print_error(f"Unable to backup directory '{source}':\n{e}")
-            raise BackupManagerException(f"Unable to backup directory '{source}':\n{e}")
+            return
 
     def ignore_folders_func(self, dirpath, filenames) -> List[str]:
         return (

kiauh/core/constants.py

@@ -11,8 +11,6 @@ import os
 import pwd
 from pathlib import Path
 
-from core.backup_manager import BACKUP_ROOT_DIR
-
 # text colors and formats
 COLOR_WHITE = "\033[37m"  # white
 COLOR_MAGENTA = "\033[35m"  # magenta
@@ -21,19 +19,6 @@ 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/instance_manager/base_instance.py

@@ -10,49 +10,115 @@
 from __future__ import annotations
 
 import re
+from abc import ABC, abstractmethod
 from dataclasses import dataclass, field
 from pathlib import Path
 from typing import List
 
-from utils.fs_utils import get_data_dir
+from core.constants import CURRENT_USER, SYSTEMD
-
+from utils.logger import Logger
-SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion"]
 
 
-@dataclass(repr=True)
+@dataclass
-class BaseInstance:
+class BaseInstance(ABC):
-    instance_type: type
     suffix: str
-    log_file_name: str | None = None
+    user: str = field(default=CURRENT_USER, init=False)
-    data_dir: Path = field(init=False)
+    data_dir: Path | None = None
-    base_folders: List[Path] = field(init=False)
+    data_dir_name: str = ""
-    cfg_dir: Path = field(init=False)
+    is_legacy_instance: bool = False
-    log_dir: Path = field(init=False)
+    cfg_dir: Path | None = None
-    gcodes_dir: Path = field(init=False)
+    log_dir: Path | None = None
-    comms_dir: Path = field(init=False)
+    comms_dir: Path | None = None
-    sysd_dir: Path = field(init=False)
+    sysd_dir: Path | None = None
-    is_legacy_instance: bool = field(init=False)
+    gcodes_dir: Path | None = None
 
-    def __post_init__(self):
+    def __post_init__(self) -> None:
-        self.data_dir = get_data_dir(self.instance_type, self.suffix)
+        self._set_data_dir()
-        # the following attributes require the data_dir to be set
+        self._set_is_legacy_instance()
-        self.cfg_dir = self.data_dir.joinpath("config")
+        if self.data_dir is not None:
-        self.log_dir = self.data_dir.joinpath("logs")
+            self.cfg_dir = self.data_dir.joinpath("config")
-        self.gcodes_dir = self.data_dir.joinpath("gcodes")
+            self.log_dir = self.data_dir.joinpath("logs")
-        self.comms_dir = self.data_dir.joinpath("comms")
+            self.comms_dir = self.data_dir.joinpath("comms")
-        self.sysd_dir = self.data_dir.joinpath("systemd")
+            self.sysd_dir = self.data_dir.joinpath("systemd")
-        self.is_legacy_instance = self._set_is_legacy_instance()
+            self.gcodes_dir = self.data_dir.joinpath("gcodes")
-        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: List[Path] | None = None) -> None:
+        dirs: List[Path | None] = [
             self.data_dir,
             self.cfg_dir,
             self.log_dir,
-            self.gcodes_dir,
             self.comms_dir,
             self.sysd_dir,
+            self.gcodes_dir,
         ]
 
-    def _set_is_legacy_instance(self) -> bool:
+        if add_dirs:
-        legacy_pattern = r"^(?!printer)(.+)_data"
+            dirs.extend(add_dirs)
-        match = re.search(legacy_pattern, self.data_dir.name)
 
-        return True if (match and self.suffix != "") else False
+        for _dir in dirs:
+            if _dir is None:
+                continue
+            _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: str = 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:
+        path: Path = SYSTEMD.joinpath(self.get_service_file_name(extension=True))
+        return path
+
+    def delete_logfiles(self, log_name: str) -> None:
+        from utils.fs_utils import run_remove_routines
+
+        if not self.log_dir or 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

@@ -8,101 +8,189 @@
 # ======================================================================= #
 from __future__ import annotations
 
+import re
+import subprocess
 from pathlib import Path
-from subprocess import CalledProcessError
+from typing import List, Type, TypeVar
-from typing import List
 
-from core.instance_type import InstanceType
+from core.constants import SYSTEMD
-from core.logger import Logger
+from core.instance_manager.base_instance import BaseInstance
+from utils.logger import Logger
 from utils.sys_utils import cmd_sysctl_service
 
+T = TypeVar("T", bound=BaseInstance, covariant=True)
 
+
+# noinspection PyMethodMayBeStatic
 class InstanceManager:
-    @staticmethod
+    def __init__(self, instance_type: Type[T]) -> None:
-    def enable(instance: InstanceType) -> None:
+        self._instance_type = instance_type
-        service_name: str = instance.service_file_path.name
+        self._current_instance: Type[T] | None = None
+        self._instance_suffix: str | None = None
+        self._instance_service: str | None = None
+        self._instance_service_full: str | None = None
+        self._instance_service_path: str | None = None
+        self._instances: List[T] = []
+
+    @property
+    def instance_type(self) -> Type[T]:
+        return self._instance_type
+
+    @instance_type.setter
+    def instance_type(self, value: Type[T]):
+        self._instance_type = value
+
+    @property
+    def current_instance(self) -> Type[T] | None:
+        return self._current_instance
+
+    @current_instance.setter
+    def current_instance(self, value: Type[T] | None) -> None:
+        self._current_instance = value
+        if value is not None:
+            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 | None:
+        return self._instance_suffix
+
+    @instance_suffix.setter
+    def instance_suffix(self, value: str | None):
+        self._instance_suffix = value
+
+    @property
+    def instance_service(self) -> str | None:
+        return self._instance_service
+
+    @instance_service.setter
+    def instance_service(self, value: str | None) -> None:
+        self._instance_service = value
+
+    @property
+    def instance_service_full(self) -> str:
+        return f"{self._instance_service}.service"
+
+    @property
+    def instance_service_path(self) -> str | None:
+        return self._instance_service_path
+
+    @instance_service_path.setter
+    def instance_service_path(self, value: str | None) -> None:
+        self._instance_service_path = value
+
+    @property
+    def instances(self) -> List[Type[T]]:
+        return self.find_instances()
+
+    @instances.setter
+    def instances(self, value: List[T]) -> None:
+        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(service_name, "enable")
+            cmd_sysctl_service(self.instance_service_full, "enable")
-        except CalledProcessError as e:
+        except subprocess.CalledProcessError as e:
-            Logger.print_error(f"Error enabling service {service_name}:")
+            Logger.print_error(f"Error enabling service {self.instance_service_full}:")
             Logger.print_error(f"{e}")
 
-    @staticmethod
+    def disable_instance(self) -> None:
-    def disable(instance: InstanceType) -> None:
-        service_name: str = instance.service_file_path.name
         try:
-            cmd_sysctl_service(service_name, "disable")
+            cmd_sysctl_service(self.instance_service_full, "disable")
-        except CalledProcessError as e:
+        except subprocess.CalledProcessError as e:
-            Logger.print_error(f"Error disabling {service_name}: {e}")
+            Logger.print_error(f"Error disabling {self.instance_service_full}:")
+            Logger.print_error(f"{e}")
+
+    def start_instance(self) -> None:
+        try:
+            cmd_sysctl_service(self.instance_service_full, "start")
+        except subprocess.CalledProcessError as e:
+            Logger.print_error(f"Error starting {self.instance_service_full}:")
+            Logger.print_error(f"{e}")
+
+    def restart_instance(self) -> None:
+        try:
+            cmd_sysctl_service(self.instance_service_full, "restart")
+        except subprocess.CalledProcessError as e:
+            Logger.print_error(f"Error restarting {self.instance_service_full}:")
+            Logger.print_error(f"{e}")
+
+    def start_all_instance(self) -> None:
+        for instance in self.instances:
+            self.current_instance = instance
+            self.start_instance()
+
+    def restart_all_instance(self) -> None:
+        for instance in self.instances:
+            self.current_instance = instance
+            self.restart_instance()
+
+    def stop_instance(self) -> None:
+        try:
+            cmd_sysctl_service(self.instance_service_full, "stop")
+        except subprocess.CalledProcessError as e:
+            Logger.print_error(f"Error stopping {self.instance_service_full}:")
+            Logger.print_error(f"{e}")
             raise
 
-    @staticmethod
+    def stop_all_instance(self) -> None:
-    def start(instance: InstanceType) -> None:
+        for instance in self.instances:
-        service_name: str = instance.service_file_path.name
+            self.current_instance = instance
-        try:
+            self.stop_instance()
-            cmd_sysctl_service(service_name, "start")
-        except CalledProcessError as e:
-            Logger.print_error(f"Error starting {service_name}: {e}")
-            raise
 
-    @staticmethod
+    def find_instances(self) -> List[Type[T]]:
-    def stop(instance: InstanceType) -> None:
+        from utils.common import convert_camelcase_to_kebabcase
-        name: str = instance.service_file_path.name
-        try:
-            cmd_sysctl_service(name, "stop")
-        except CalledProcessError as e:
-            Logger.print_error(f"Error stopping {name}: {e}")
-            raise
 
-    @staticmethod
+        name = convert_camelcase_to_kebabcase(self.instance_type.__name__)
-    def restart(instance: InstanceType) -> None:
+        pattern = re.compile(f"^{name}(-[0-9a-zA-Z]+)?.service$")
-        name: str = instance.service_file_path.name
+        excluded = self.instance_type.blacklist()
-        try:
-            cmd_sysctl_service(name, "restart")
-        except CalledProcessError as e:
-            Logger.print_error(f"Error restarting {name}: {e}")
-            raise
 
-    @staticmethod
+        service_list = [
-    def start_all(instances: List[InstanceType]) -> None:
+            Path(SYSTEMD, service)
-        for instance in instances:
+            for service in SYSTEMD.iterdir()
-            InstanceManager.start(instance)
+            if pattern.search(service.name)
+            and not any(s in service.name for s in excluded)
+        ]
 
-    @staticmethod
+        instance_list = [
-    def stop_all(instances: List[InstanceType]) -> None:
+            self.instance_type(suffix=self._get_instance_suffix(name, service))
-        for instance in instances:
+            for service in service_list
-            InstanceManager.stop(instance)
+        ]
 
-    @staticmethod
+        return sorted(instance_list, key=lambda x: self._sort_instance_list(x.suffix))
-    def restart_all(instances: List[InstanceType]) -> None:
-        for instance in instances:
-            InstanceManager.restart(instance)
 
-    @staticmethod
+    def _get_instance_suffix(self, name: str, file_path: Path) -> str:
-    def remove(instance: InstanceType) -> None:
+        # to get the suffix of the instance, we remove the name of the instance from
-        from utils.fs_utils import run_remove_routines
+        # the file name, if the remaining part an empty string we return it
-        from utils.sys_utils import remove_system_service
+        # 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 ""
 
-        try:
+    def _sort_instance_list(self, suffix: int | str | None):
-            # remove the service file
+        if suffix is None:
-            service_file_path: Path = instance.service_file_path
+            return
-            if service_file_path is not None:
+        elif isinstance(suffix, str) and suffix.isdigit():
-                remove_system_service(service_file_path.name)
+            return f"{int(suffix):04}"
-
+        else:
-            # then remove all the log files
+            return suffix
-            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

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

kiauh/core/instance_type.py

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

@@ -10,7 +10,7 @@ from __future__ import annotations
 
 from dataclasses import dataclass
 from enum import Enum
-from typing import Any, Callable, Type
+from typing import Any, Callable
 
 
 @dataclass
@@ -18,14 +18,13 @@ 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
     """
 
-    def __repr__(self):
+    method: Callable | None = None
-        return f"Option(method={self.method.__name__}, opt_index={self.opt_index}, opt_data={self.opt_data})"
+    menu: bool = False
-
-    method: Type[Callable]
     opt_index: str = ""
     opt_data: Any = None
 

kiauh/core/menus/advanced_menu.py

@@ -43,13 +43,13 @@ class AdvancedMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(method=self.build),
+            "1": Option(method=self.build, menu=True),
-            "2": Option(method=self.flash),
+            "2": Option(method=self.flash, menu=False),
-            "3": Option(method=self.build_flash),
+            "3": Option(method=self.build_flash, menu=False),
-            "4": Option(method=self.get_id),
+            "4": Option(method=self.get_id, menu=False),
-            "5": Option(method=self.klipper_rollback),
+            "5": Option(method=self.klipper_rollback, menu=True),
-            "6": Option(method=self.moonraker_rollback),
+            "6": Option(method=self.moonraker_rollback, menu=True),
-            "7": Option(method=self.change_hostname),
+            "7": Option(method=self.change_hostname, menu=True),
         }
 
     def print_menu(self) -> None:

kiauh/core/menus/backup_menu.py

@@ -43,15 +43,15 @@ class BackupMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(method=self.backup_klipper),
+            "1": Option(method=self.backup_klipper, menu=False),
-            "2": Option(method=self.backup_moonraker),
+            "2": Option(method=self.backup_moonraker, menu=False),
-            "3": Option(method=self.backup_printer_config),
+            "3": Option(method=self.backup_printer_config, menu=False),
-            "4": Option(method=self.backup_moonraker_db),
+            "4": Option(method=self.backup_moonraker_db, menu=False),
-            "5": Option(method=self.backup_mainsail),
+            "5": Option(method=self.backup_mainsail, menu=False),
-            "6": Option(method=self.backup_fluidd),
+            "6": Option(method=self.backup_fluidd, menu=False),
-            "7": Option(method=self.backup_mainsail_config),
+            "7": Option(method=self.backup_mainsail_config, menu=False),
-            "8": Option(method=self.backup_fluidd_config),
+            "8": Option(method=self.backup_fluidd_config, menu=False),
-            "9": Option(method=self.backup_klipperscreen),
+            "9": Option(method=self.backup_klipperscreen, menu=False),
         }
 
     def print_menu(self) -> None:

kiauh/core/menus/base_menu.py

@@ -23,9 +23,8 @@ from core.constants import (
     COLOR_YELLOW,
     RESET_FORMAT,
 )
-from core.logger import Logger
 from core.menus import FooterType, Option
-from utils.input_utils import get_selection_input
+from utils.logger import Logger
 
 
 def clear() -> None:
@@ -124,12 +123,12 @@ class BaseMenu(metaclass=PostInitCaller):
 
         # conditionally add options based on footer type
         if self.footer_type is FooterType.QUIT:
-            self.options["q"] = Option(method=self.__exit)
+            self.options["q"] = Option(method=self.__exit, menu=False)
         if self.footer_type is FooterType.BACK:
-            self.options["b"] = Option(method=self.__go_back)
+            self.options["b"] = Option(method=self.__go_back, menu=False)
         if self.footer_type is FooterType.BACK_HELP:
-            self.options["b"] = Option(method=self.__go_back)
+            self.options["b"] = Option(method=self.__go_back, menu=False)
-            self.options["h"] = Option(method=self.__go_to_help)
+            self.options["h"] = Option(method=self.__go_to_help, menu=False)
         # if defined, add the default option to the options dict
         if self.default_option is not None:
             self.options[""] = self.default_option
@@ -142,7 +141,7 @@ class BaseMenu(metaclass=PostInitCaller):
     def __go_to_help(self, **kwargs) -> None:
         if self.help_menu is None:
             return
-        self.help_menu(previous_menu=self.__class__).run()
+        self.help_menu(previous_menu=self).run()
 
     def __exit(self, **kwargs) -> None:
         Logger.print_ok("###### Happy printing!", False)
@@ -178,20 +177,43 @@ class BaseMenu(metaclass=PostInitCaller):
         self.print_menu()
         self.print_footer()
 
+    def validate_user_input(self, usr_input: str) -> Option:
+        """
+        Validate the user input and either return an Option, a string or None
+        :param usr_input: The user input in form of a string
+        :return: Option, str or None
+        """
+        usr_input = usr_input.lower()
+        option = self.options.get(usr_input, Option(None, False, "", None))
+
+        # if option/usr_input is None/empty string, we execute the menus default option if specified
+        if (option is None or usr_input == "") and self.default_option is not None:
+            self.default_option.opt_index = usr_input
+            return self.default_option
+
+        # user selected a regular option
+        option.opt_index = usr_input
+        return option
+
+    def handle_user_input(self) -> Option:
+        """Handle the user input, return the validated input or print an error."""
+        while True:
+            print(f"{COLOR_CYAN}###### {self.input_label_txt}: {RESET_FORMAT}", end="")
+            usr_input = input().lower()
+            validated_input = self.validate_user_input(usr_input)
+
+            if validated_input.method is not None:
+                return validated_input
+            else:
+                Logger.print_error("Invalid input!", False)
+
     def run(self) -> None:
         """Start the menu lifecycle. When this function returns, the lifecycle of the menu ends."""
         try:
             self.display_menu()
-            option = get_selection_input(self.input_label_txt, self.options)
+            option = self.handle_user_input()
-            selected_option: Option = self.options.get(option)
+            option.method(opt_index=option.opt_index, opt_data=option.opt_data)
-
-            selected_option.method(
-                opt_index=selected_option.opt_index,
-                opt_data=selected_option.opt_data,
-            )
-
             self.run()
-
         except Exception as e:
             Logger.print_error(
                 f"An unexpected error occured:\n{e}\n{traceback.format_exc()}"

kiauh/core/menus/install_menu.py

@@ -40,16 +40,16 @@ class InstallMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(method=self.install_klipper),
+            "1": Option(method=self.install_klipper, menu=False),
-            "2": Option(method=self.install_moonraker),
+            "2": Option(method=self.install_moonraker, menu=False),
-            "3": Option(method=self.install_mainsail),
+            "3": Option(method=self.install_mainsail, menu=False),
-            "4": Option(method=self.install_fluidd),
+            "4": Option(method=self.install_fluidd, menu=False),
-            "5": Option(method=self.install_mainsail_config),
+            "5": Option(method=self.install_mainsail_config, menu=False),
-            "6": Option(method=self.install_fluidd_config),
+            "6": Option(method=self.install_fluidd_config, menu=False),
-            "7": Option(method=self.install_klipperscreen),
+            "7": Option(method=self.install_klipperscreen, menu=False),
-            "8": Option(method=self.install_mobileraker),
+            "8": Option(method=self.install_mobileraker, menu=False),
-            "9": Option(method=self.install_crowsnest),
+            "9": Option(method=self.install_crowsnest, menu=False),
-            "10": Option(method=self.install_octoeverywhere),
+            "10": Option(method=self.install_octoeverywhere, menu=False),
         }
 
     def print_menu(self) -> None:

kiauh/core/menus/main_menu.py

@@ -33,7 +33,6 @@ from core.constants import (
     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
@@ -42,9 +41,9 @@ from core.menus.install_menu import InstallMenu
 from core.menus.remove_menu import RemoveMenu
 from core.menus.settings_menu import SettingsMenu
 from core.menus.update_menu import UpdateMenu
-from core.types import ComponentStatus, StatusMap, StatusText
 from extensions.extensions_menu import ExtensionsMenu
-from utils.common import get_kiauh_version
+from utils.logger import Logger
+from utils.types import ComponentStatus, StatusMap, StatusText
 
 
 # noinspection PyUnusedLocal
@@ -56,9 +55,7 @@ class MainMenu(BaseMenu):
         self.header: bool = True
         self.footer_type: FooterType = FooterType.QUIT
 
-        self.version = ""
+        self.kl_status = self.kl_repo = self.mr_status = self.mr_repo = ""
-        self.kl_status = self.kl_owner = self.kl_repo = ""
-        self.mr_status = self.mr_owner = self.mr_repo = ""
         self.ms_status = self.fl_status = self.ks_status = self.mb_status = ""
         self.cn_status = self.cc_status = self.oe_status = ""
         self._init_status()
@@ -69,14 +66,14 @@ class MainMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            "0": Option(method=self.log_upload_menu),
+            "0": Option(method=self.log_upload_menu, menu=True),
-            "1": Option(method=self.install_menu),
+            "1": Option(method=self.install_menu, menu=True),
-            "2": Option(method=self.update_menu),
+            "2": Option(method=self.update_menu, menu=True),
-            "3": Option(method=self.remove_menu),
+            "3": Option(method=self.remove_menu, menu=True),
-            "4": Option(method=self.advanced_menu),
+            "4": Option(method=self.advanced_menu, menu=True),
-            "5": Option(method=self.backup_menu),
+            "5": Option(method=self.backup_menu, menu=True),
-            "e": Option(method=self.extension_menu),
+            "e": Option(method=self.extension_menu, menu=True),
-            "s": Option(method=self.settings_menu),
+            "s": Option(method=self.settings_menu, menu=True),
         }
 
     def _init_status(self) -> None:
@@ -89,7 +86,6 @@ 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())
@@ -104,7 +100,6 @@ class MainMenu(BaseMenu):
         status_data: ComponentStatus = status_fn(*args)
         code: int = status_data.status
         status: StatusText = StatusMap[code]
-        owner: str = status_data.owner
         repo: str = status_data.repo
         instance_count: int = status_data.instances
 
@@ -113,7 +108,6 @@ class MainMenu(BaseMenu):
             count_txt = f": {instance_count}"
 
         setattr(self, f"{name}_status", self._format_by_code(code, status, count_txt))
-        setattr(self, f"{name}_owner", f"{COLOR_CYAN}{owner}{RESET_FORMAT}")
         setattr(self, f"{name}_repo", f"{COLOR_CYAN}{repo}{RESET_FORMAT}")
 
     def _format_by_code(self, code: int, status: str, count: str) -> str:
@@ -131,7 +125,7 @@ class MainMenu(BaseMenu):
         self._fetch_status()
 
         header = " [ Main Menu ] "
-        footer1 = f"{COLOR_CYAN}{self.version}{RESET_FORMAT}"
+        footer1 = f"{COLOR_CYAN}KIAUH v6.0.0{RESET_FORMAT}"
         footer2 = f"Changelog: {COLOR_MAGENTA}https://git.io/JnmlX{RESET_FORMAT}"
         color = COLOR_CYAN
         count = 62 - len(color) - len(RESET_FORMAT)
@@ -143,19 +137,17 @@ class MainMenu(BaseMenu):
             ║ {color}{header:~^{count}}{RESET_FORMAT} ║
             ╟──────────────────┬────────────────────────────────────╢
             ║  0) [Log-Upload] │   Klipper: {self.kl_status:<{pad1}} ║
-            ║                  │     Owner: {self.kl_owner:<{pad1}} ║
+            ║                  │      Repo: {self.kl_repo:<{pad1}} ║
-            ║  1) [Install]    │      Repo: {self.kl_repo:<{pad1}} ║
+            ║  1) [Install]    ├────────────────────────────────────╢
-            ║  2) [Update]     ├────────────────────────────────────╢
+            ║  2) [Update]     │ Moonraker: {self.mr_status:<{pad1}} ║
-            ║  3) [Remove]     │ Moonraker: {self.mr_status:<{pad1}} ║
+            ║  3) [Remove]     │      Repo: {self.mr_repo:<{pad1}} ║
-            ║  4) [Advanced]   │     Owner: {self.mr_owner:<{pad1}} ║
+            ║  4) [Advanced]   ├────────────────────────────────────╢
-            ║  5) [Backup]     │      Repo: {self.mr_repo:<{pad1}} ║
+            ║  5) [Backup]     │        Mainsail: {self.ms_status:<{pad2}} ║
-            ║                  ├────────────────────────────────────╢
-            ║  S) [Settings]   │        Mainsail: {self.ms_status:<{pad2}} ║
             ║                  │          Fluidd: {self.fl_status:<{pad2}} ║
-            ║ Community:       │   Client-Config: {self.cc_status:<{pad2}} ║
+            ║  S) [Settings]   │   Client-Config: {self.cc_status:<{pad2}} ║
-            ║  E) [Extensions] │                                    ║
+            ║                  │                                    ║
-            ║                  │   KlipperScreen: {self.ks_status:<{pad2}} ║
+            ║ Community:       │   KlipperScreen: {self.ks_status:<{pad2}} ║
-            ║                  │     Mobileraker: {self.mb_status:<{pad2}} ║
+            ║  E) [Extensions] │     Mobileraker: {self.mb_status:<{pad2}} ║
             ║                  │  OctoEverywhere: {self.oe_status:<{pad2}} ║
             ║                  │       Crowsnest: {self.cn_status:<{pad2}} ║
             ╟──────────────────┼────────────────────────────────────╢

kiauh/core/menus/remove_menu.py

@@ -41,14 +41,14 @@ class RemoveMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(method=self.remove_klipper),
+            "1": Option(method=self.remove_klipper, menu=True),
-            "2": Option(method=self.remove_moonraker),
+            "2": Option(method=self.remove_moonraker, menu=True),
-            "3": Option(method=self.remove_mainsail),
+            "3": Option(method=self.remove_mainsail, menu=True),
-            "4": Option(method=self.remove_fluidd),
+            "4": Option(method=self.remove_fluidd, menu=True),
-            "5": Option(method=self.remove_klipperscreen),
+            "5": Option(method=self.remove_klipperscreen, menu=True),
-            "6": Option(method=self.remove_mobileraker),
+            "6": Option(method=self.remove_mobileraker, menu=True),
-            "7": Option(method=self.remove_crowsnest),
+            "7": Option(method=self.remove_crowsnest, menu=True),
-            "8": Option(method=self.remove_octoeverywhere),
+            "8": Option(method=self.remove_octoeverywhere, menu=True),
         }
 
     def print_menu(self) -> None:

kiauh/core/menus/settings_menu.py

@@ -8,16 +8,23 @@
 # ======================================================================= #
 from __future__ import annotations
 
+import shutil
 import textwrap
-from typing import Literal, Tuple, Type
+from pathlib import Path
+from typing import Tuple, Type
 
+from components.klipper import KLIPPER_DIR
+from components.klipper.klipper import Klipper
+from components.moonraker import MOONRAKER_DIR
+from components.moonraker.moonraker import Moonraker
 from core.constants import COLOR_CYAN, COLOR_GREEN, RESET_FORMAT
-from core.logger import DialogType, Logger
+from core.instance_manager.instance_manager import InstanceManager
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
-from core.settings.kiauh_settings import KiauhSettings, RepoSettings
+from core.settings.kiauh_settings import KiauhSettings
-from procedures.switch_repo import run_switch_repo_routine
+from utils.git_utils import git_clone_wrapper
 from utils.input_utils import get_confirm, get_string_input
+from utils.logger import DialogType, Logger
 
 
 # noinspection PyUnusedLocal
@@ -40,11 +47,11 @@ class SettingsMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            "1": Option(method=self.set_klipper_repo),
+            "1": Option(method=self.set_klipper_repo, menu=True),
-            "2": Option(method=self.set_moonraker_repo),
+            "2": Option(method=self.set_moonraker_repo, menu=True),
-            "3": Option(method=self.toggle_mainsail_release),
+            "3": Option(method=self.toggle_mainsail_release, menu=True),
-            "4": Option(method=self.toggle_fluidd_release),
+            "4": Option(method=self.toggle_fluidd_release, menu=False),
-            "5": Option(method=self.toggle_backup_before_update),
+            "5": Option(method=self.toggle_backup_before_update, menu=False),
         }
 
     def print_menu(self) -> None:
@@ -97,28 +104,22 @@ class SettingsMenu(BaseMenu):
         self.mainsail_unstable = self.settings.mainsail.unstable_releases
         self.fluidd_unstable = self.settings.fluidd.unstable_releases
 
-    def _format_repo_str(self, repo_name: Literal["klipper", "moonraker"]) -> None:
+    def _format_repo_str(self, repo_name: str) -> None:
-        repo: RepoSettings = self.settings[repo_name]
+        repo = self.settings.get(repo_name, "repo_url")
-        repo_str = f"{'/'.join(repo.repo_url.rsplit('/', 2)[-2:])}"
+        repo = f"{'/'.join(repo.rsplit('/', 2)[-2:])}"
-        branch_str = f"({COLOR_CYAN}@ {repo.branch}{RESET_FORMAT})"
+        branch = self.settings.get(repo_name, "branch")
-
+        branch = f"({COLOR_CYAN}@ {branch}{RESET_FORMAT})"
-        setattr(
+        setattr(self, f"{repo_name}_repo", f"{COLOR_CYAN}{repo}{RESET_FORMAT} {branch}")
-            self,
-            f"{repo_name}_repo",
-            f"{COLOR_CYAN}{repo_str}{RESET_FORMAT} {branch_str}",
-        )
 
     def _gather_input(self) -> Tuple[str, str]:
         Logger.print_dialog(
             DialogType.ATTENTION,
             [
-                "There is no input validation in place! Make sure your the input is "
+                "There is no input validation in place! Make sure your"
-                "valid and has no typos or invalid characters! For the change to take "
+                " input is valid and has no typos! For any change to"
-                "effect, the new repository will be cloned. A backup of the old "
+                " take effect, the repository must be cloned again. "
-                "repository will be created.",
+                "Make sure you don't have any ongoing prints running, "
-                "\n\n",
+                "as the services will be restarted!"
-                "Make sure you don't have any ongoing prints running, as the services "
-                "will be restarted during this process! You will loose any ongoing print!",
             ],
         )
         repo = get_string_input(
@@ -132,7 +133,7 @@ class SettingsMenu(BaseMenu):
 
         return repo, branch
 
-    def _set_repo(self, repo_name: Literal["klipper", "moonraker"]) -> None:
+    def _set_repo(self, repo_name: str) -> None:
         repo_url, branch = self._gather_input()
         display_name = repo_name.capitalize()
         Logger.print_dialog(
@@ -146,13 +147,10 @@ class SettingsMenu(BaseMenu):
         )
 
         if get_confirm("Apply changes?", allow_go_back=True):
-            repo: RepoSettings = self.settings[repo_name]
+            self.settings.set(repo_name, "repo_url", repo_url)
-            repo.repo_url = repo_url
+            self.settings.set(repo_name, "branch", branch)
-            repo.branch = branch
-
             self.settings.save()
             self._load_settings()
-
             Logger.print_ok("Changes saved!")
         else:
             Logger.print_info(
@@ -162,10 +160,31 @@ class SettingsMenu(BaseMenu):
 
         Logger.print_status(f"Switching to {display_name}'s new source repository ...")
         self._switch_repo(repo_name)
+        Logger.print_ok(f"Switched to {repo_url} at branch {branch}!")
 
-    def _switch_repo(self, name: Literal["klipper", "moonraker"]) -> None:
+    def _switch_repo(self, name: str) -> None:
-        repo: RepoSettings = self.settings[name]
+        target_dir: Path
-        run_switch_repo_routine(name, repo)
+        if name == "klipper":
+            target_dir = KLIPPER_DIR
+            _type = Klipper
+        elif name == "moonraker":
+            target_dir = MOONRAKER_DIR
+            _type = Moonraker
+        else:
+            Logger.print_error("Invalid repository name!")
+            return
+
+        if target_dir.exists():
+            shutil.rmtree(target_dir)
+
+        im = InstanceManager(_type)
+        im.stop_all_instance()
+
+        repo = self.settings.get(name, "repo_url")
+        branch = self.settings.get(name, "branch")
+        git_clone_wrapper(repo, target_dir, branch)
+
+        im.start_all_instance()
 
     def set_klipper_repo(self, **kwargs) -> None:
         self._set_repo("klipper")

kiauh/core/menus/update_menu.py

@@ -46,17 +46,17 @@ from core.constants import (
     COLOR_YELLOW,
     RESET_FORMAT,
 )
-from core.logger import DialogType, Logger
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
-from core.spinner import Spinner
-from core.types import ComponentStatus
 from utils.input_utils import get_confirm
+from utils.logger import DialogType, Logger
+from utils.spinner import Spinner
 from utils.sys_utils import (
     get_upgradable_packages,
     update_system_package_lists,
     upgrade_system_packages,
 )
+from utils.types import ComponentStatus
 
 
 # noinspection PyUnusedLocal
@@ -102,22 +102,22 @@ class UpdateMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            "a": Option(self.update_all),
+            "a": Option(self.update_all, menu=False),
-            "1": Option(self.update_klipper),
+            "1": Option(self.update_klipper, menu=False),
-            "2": Option(self.update_moonraker),
+            "2": Option(self.update_moonraker, menu=False),
-            "3": Option(self.update_mainsail),
+            "3": Option(self.update_mainsail, menu=False),
-            "4": Option(self.update_fluidd),
+            "4": Option(self.update_fluidd, menu=False),
-            "5": Option(self.update_mainsail_config),
+            "5": Option(self.update_mainsail_config, menu=False),
-            "6": Option(self.update_fluidd_config),
+            "6": Option(self.update_fluidd_config, menu=False),
-            "7": Option(self.update_klipperscreen),
+            "7": Option(self.update_klipperscreen, menu=False),
-            "8": Option(self.update_mobileraker),
+            "8": Option(self.update_mobileraker, menu=False),
-            "9": Option(self.update_crowsnest),
+            "9": Option(self.update_crowsnest, menu=False),
-            "10": Option(self.update_octoeverywhere),
+            "10": Option(self.update_octoeverywhere, menu=False),
-            "11": Option(self.upgrade_system_packages),
+            "11": Option(self.upgrade_system_packages, menu=False),
         }
 
     def print_menu(self) -> None:
-        spinner = Spinner("Loading update menu, please wait", color="green")
+        spinner = Spinner("Loading update menu, please wait")
         spinner.start()
 
         self._fetch_update_status()
@@ -281,6 +281,8 @@ class UpdateMenu(BaseMenu):
                 DialogType.CUSTOM,
                 ["The following packages will be upgraded:", "\n\n", pkgs],
                 custom_title="UPGRADABLE SYSTEM UPDATES",
+                padding_top=0,
+                padding_bottom=0,
             )
             if not get_confirm("Continue?"):
                 return

kiauh/core/settings/kiauh_settings.py

@@ -8,15 +8,12 @@
 # ======================================================================= #
 from __future__ import annotations
 
-from dataclasses import dataclass, field
-from typing import Any
-
-from core.logger import DialogType, Logger
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     NoOptionError,
     NoSectionError,
     SimpleConfigParser,
 )
+from utils.logger import DialogType, Logger
 from utils.sys_utils import kill
 
 from kiauh import PROJECT_ROOT
@@ -25,21 +22,33 @@ DEFAULT_CFG = PROJECT_ROOT.joinpath("default.kiauh.cfg")
 CUSTOM_CFG = PROJECT_ROOT.joinpath("kiauh.cfg")
 
 
-@dataclass
 class AppSettings:
-    backup_before_update: bool | None = field(default=None)
+    def __init__(self) -> None:
+        self.backup_before_update = None
 
 
-@dataclass
+class KlipperSettings:
-class RepoSettings:
+    def __init__(self) -> None:
-    repo_url: str | None = field(default=None)
+        self.repo_url = None
-    branch: str | None = field(default=None)
+        self.branch = None
 
 
-@dataclass
+class MoonrakerSettings:
-class WebUiSettings:
+    def __init__(self) -> None:
-    port: str | None = field(default=None)
+        self.repo_url = None
-    unstable_releases: bool | None = field(default=None)
+        self.branch = None
+
+
+class MainsailSettings:
+    def __init__(self) -> None:
+        self.port = None
+        self.unstable_releases = None
+
+
+class FluiddSettings:
+    def __init__(self) -> None:
+        self.port = None
+        self.unstable_releases = None
 
 
 # noinspection PyUnusedLocal
@@ -52,12 +61,6 @@ class KiauhSettings:
             cls._instance = super(KiauhSettings, cls).__new__(cls, *args, **kwargs)
         return cls._instance
 
-    def __repr__(self) -> str:
-        return f"KiauhSettings(kiauh={self.kiauh}, klipper={self.klipper}, moonraker={self.moonraker}, mainsail={self.mainsail}, fluidd={self.fluidd})"
-
-    def __getitem__(self, item: str) -> Any:
-        return getattr(self, item)
-
     def __init__(self) -> None:
         if not hasattr(self, "__initialized"):
             self.__initialized = False
@@ -66,10 +69,20 @@ class KiauhSettings:
         self.__initialized = True
         self.config = SimpleConfigParser()
         self.kiauh = AppSettings()
-        self.klipper = RepoSettings()
+        self.klipper = KlipperSettings()
-        self.moonraker = RepoSettings()
+        self.moonraker = MoonrakerSettings()
-        self.mainsail = WebUiSettings()
+        self.mainsail = MainsailSettings()
-        self.fluidd = WebUiSettings()
+        self.fluidd = FluiddSettings()
+
+        self.kiauh.backup_before_update = None
+        self.klipper.repo_url = None
+        self.klipper.branch = None
+        self.moonraker.repo_url = None
+        self.moonraker.branch = None
+        self.mainsail.port = None
+        self.mainsail.unstable_releases = None
+        self.fluidd.port = None
+        self.fluidd.unstable_releases = None
 
         self._load_config()
 
@@ -89,8 +102,22 @@ class KiauhSettings:
         except AttributeError:
             raise
 
+    def set(self, section: str, option: str, value: str | int | bool) -> None:
+        """
+        Set a value in the settings state by providing the section and option name as strings.
+        Prefer direct access to the properties, as it is usually safer!
+        :param section: The section name as string.
+        :param option: The option name as string.
+        :param value: The value to set as string, int or bool.
+        """
+        try:
+            section = getattr(self, section)
+            section.option = value  # type: ignore
+        except AttributeError:
+            raise
+
     def save(self) -> None:
-        self._set_config_options_state()
+        self._set_config_options()
         self.config.write(CUSTOM_CFG)
         self._load_config()
 
@@ -102,7 +129,7 @@ class KiauhSettings:
         self.config.read(cfg)
 
         self._validate_cfg()
-        self._apply_settings_from_file()
+        self._read_settings()
 
     def _validate_cfg(self) -> None:
         try:
@@ -144,7 +171,7 @@ class KiauhSettings:
         if v.isdigit() or v.lower() == "true" or v.lower() == "false":
             raise ValueError
 
-    def _apply_settings_from_file(self) -> None:
+    def _read_settings(self) -> None:
         self.kiauh.backup_before_update = self.config.getboolean(
             "kiauh", "backup_before_update"
         )
@@ -161,7 +188,7 @@ class KiauhSettings:
             "fluidd", "unstable_releases"
         )
 
-    def _set_config_options_state(self) -> None:
+    def _set_config_options(self) -> None:
         self.config.set(
             "kiauh",
             "backup_before_update",

kiauh/core/spinner.py

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

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

@@ -85,46 +85,10 @@ class DuplicateOptionError(Exception):
 class SimpleConfigParser:
     """A customized config parser targeted at handling Klipper style config files"""
 
-    # definition of section line:
+    _SECTION_RE = re.compile(r"\s*\[(\w+\s?.+)]\s*([#;].*)?$")
-    #  - then line MUST start with an opening square bracket - it is the first section marker
+    _OPTION_RE = re.compile(r"^\s*(\w+)\s*[:=]\s*([^=:].*)\s*([#;].*)?$")
-    #  - the section marker MUST be followed by at least one character - it is the section name
+    _MLOPTION_RE = re.compile(r"^\s*(\w+)\s*[:=]\s*([#;].*)?$")
-    #  - the section name MUST be followed by a closing square bracket - it is the second section marker
-    #  - the second section marker MAY be followed by any amount of whitespace characters
-    #  - the second section marker MAY be followed by a # or ; - it is the comment marker
-    #  - the inline comment MAY be of any length and character
-    _SECTION_RE = re.compile(r"\[(.+)]\s*([#;].*)?$")
-
-    # definition of option line:
-    #  - the line MUST start with a word - it is the option name
-    #  - the option name MUST be followed by a colon or an equal sign - it is the separator
-    #  - the separator MUST be followed by a value
-    #    - the separator MAY have any amount of leading or trailing whitespaces
-    #    - the separator MUST NOT be directly followed by a colon or equal sign
-    #  - the value MAY be of any length and character
-    #    - the value MAY contain any amount of trailing whitespaces
-    #    - the value MAY be followed by a # or ; - it is the comment marker
-    #  - the inline comment MAY be of any length and character
-    _OPTION_RE = re.compile(r"^([^:=\s]+)\s?[:=]\s*([^=:].*)\s*([#;].*)?$")
-
-    # definition of multiline option line:
-    #  - the line MUST start with a word - it is the option name
-    #  - the option name MUST be followed by a colon or an equal sign - it is the separator
-    #  - the separator MUST NOT be followed by a value
-    #    - the separator MAY have any amount of leading or trailing whitespaces
-    #    - the separator MUST NOT be directly followed by a colon or equal sign
-    #    - the separator MAY be followed by a # or ; - it is the comment marker
-    #  - the inline comment MAY be of any length and character
-    _MLOPTION_RE = re.compile(r"^([^:=\s]+)\s*[:=]\s*([#;].*)?$")
-
-    # definition of comment line:
-    #  - the line MAY start with any amount of whitespace characters
-    #  - the line MUST contain a # or ; - it is the comment marker
-    #  - the comment marker MAY be followed by any amount of whitespace characters
-    #  - the comment MAY be of any length and character
     _COMMENT_RE = re.compile(r"^\s*([#;].*)?$")
-
-    # definition of empty line:
-    #  - the line MUST contain only whitespace characters
     _EMPTY_LINE_RE = re.compile(r"^\s*$")
 
     BOOLEAN_STATES = {

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

@@ -21,8 +21,4 @@ testcases = [
         "serial",
         "/dev/serial/by-id/<your-mcu-id>",
     ),
-    ("parameter_temperature_(°C): 155", "parameter_temperature_(°C)", "155"),
-    ("parameter_humidity_(%_RH): 45", "parameter_humidity_(%_RH)", "45"),
-    ("parameter_spool_weight_(%): 10", "parameter_spool_weight_(%)", "10"),
-    ("path: /dev/shm/drying_box.json", "path", "/dev/shm/drying_box.json"),
 ]

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

@@ -14,7 +14,7 @@ def parser():
     return SimpleConfigParser()
 
 
-class TestSingleLineParsing:
+class TestLineParsing:
     @pytest.mark.parametrize("given, expected", [*case_parse_section])
     def test_parse_section(self, parser, given, expected):
         parser._parse_section(given)

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

@@ -14,14 +14,4 @@ testcases = [
     ("", False),
     ("# that's a comment", False),
     ("; that's a comment", False),
-    ("parameter_humidity_(%_RH):", True),
-    ("parameter_spool_weight_(%):", True),
-    ("parameter_temperature_(°C):", True),
-    ("parameter_humidity_(%_RH): 18.123", False),
-    ("parameter_spool_weight_(%): 150", False),
-    ("parameter_temperature_(°C): 30,5", False),
-    ("trusted_clients:", True),
-    ("trusted_clients: 192.168.1.0/24", False),
-    ("cors_domains:", True),
-    ("cors_domains: http://*.lan", False),
 ]

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

@@ -26,6 +26,5 @@ testcases = [
     ("description: homing!", True),
     ("description: inline macro :-)", True),
     ("path: %GCODES_DIR%", True),
-    ("path: /dev/shm/drying_box.json", True),
     ("serial = /dev/serial/by-id/<your-mcu-id>", True),
 ]

kiauh/extensions/extensions_menu.py

@@ -16,11 +16,11 @@ from pathlib import Path
 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.logger import Logger
 
 
 # noinspection PyUnusedLocal
@@ -38,7 +38,9 @@ class ExtensionsMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            i: Option(self.extension_submenu, opt_data=self.extensions.get(i))
+            i: Option(
+                self.extension_submenu, menu=True, opt_data=self.extensions.get(i)
+            )
             for i in self.extensions
         }
 
@@ -117,12 +119,12 @@ class ExtensionSubmenu(BaseMenu):
         )
 
     def set_options(self) -> None:
-        self.options["1"] = Option(self.extension.install_extension)
+        self.options["1"] = Option(self.extension.install_extension, menu=False)
         if self.extension.metadata.get("updates"):
-            self.options["2"] = Option(self.extension.update_extension)
+            self.options["2"] = Option(self.extension.update_extension, menu=False)
-            self.options["3"] = Option(self.extension.remove_extension)
+            self.options["3"] = Option(self.extension.remove_extension, menu=False)
         else:
-            self.options["2"] = Option(self.extension.remove_extension)
+            self.options["2"] = Option(self.extension.remove_extension, menu=False)
 
     def print_menu(self) -> None:
         header = f" [ {self.extension.metadata.get('display_name')} ] "

kiauh/extensions/gcode_shell_cmd/gcode_shell_cmd_extension.py

@@ -14,7 +14,6 @@ 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,
 )
@@ -28,7 +27,7 @@ from extensions.gcode_shell_cmd import (
 )
 from utils.fs_utils import check_file_exist
 from utils.input_utils import get_confirm
-from utils.instance_utils import get_instances
+from utils.logger import Logger
 
 
 # noinspection PyMethodMayBeStatic
@@ -56,8 +55,8 @@ class GcodeShellCmdExtension(BaseExtension):
             Logger.print_warn("Installation aborted due to user request.")
             return
 
-        instances = get_instances(Klipper)
+        im = InstanceManager(Klipper)
-        InstanceManager.stop_all(instances)
+        im.stop_all_instance()
 
         try:
             Logger.print_status(f"Copy extension to '{KLIPPER_EXTRAS}' ...")
@@ -67,9 +66,9 @@ class GcodeShellCmdExtension(BaseExtension):
             return
 
         if install_example:
-            self.install_example_cfg(instances)
+            self.install_example_cfg(im.instances)
 
-        InstanceManager.start_all(instances)
+        im.start_all_instance()
 
         Logger.print_ok("Installing G-Code Shell Command extension successful!")
 
@@ -95,7 +94,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.base.cfg_dir for instance in instances]
+        cfg_dirs = [instance.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,9 +12,7 @@
 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,
@@ -22,106 +20,162 @@ from extensions.klipper_backup import (
     KLIPPERBACKUP_REPO_URL,
     MOONRAKER_CONF,
 )
-from utils.fs_utils import check_file_exist, remove_with_sudo
+from utils.fs_utils import check_file_exist
-from utils.git_utils import git_cmd_clone
 from utils.input_utils import get_confirm
-from utils.sys_utils import cmd_sysctl_manage, remove_system_service, unit_file_exists
+from utils.logger import Logger
+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():
-            git_cmd_clone(KLIPPERBACKUP_REPO_URL, KLIPPERBACKUP_DIR)
+            subprocess.run(
+                ["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:
-        if not check_file_exist(KLIPPERBACKUP_DIR):
+        extension_installed = check_file_exist(KLIPPERBACKUP_DIR)
+        if not extension_installed:
             Logger.print_info("Extension does not seem to be installed! Skipping ...")
             return
-        subprocess.run([str(KLIPPERBACKUP_DIR / "install.sh"), "check_updates"])
+        else:
+            subprocess.run([str(KLIPPERBACKUP_DIR / "install.sh"), "check_updates"])
+
+    def remove_extension(self, **kwargs) -> None:
+        def uninstall_service(service_name) -> bool:
+            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) -> bool:
+            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

@@ -12,8 +12,7 @@ import csv
 import shutil
 import textwrap
 import urllib.request
-from dataclasses import dataclass
+from typing import List, Type, TypedDict, Union
-from typing import Any, Dict, List, Type, Union
 
 from components.klipper.klipper import Klipper
 from components.klipper.klipper_dialogs import (
@@ -22,18 +21,16 @@ from components.klipper.klipper_dialogs import (
 )
 from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
 from core.instance_manager.base_instance import BaseInstance
-from core.instance_type import InstanceType
+from core.instance_manager.instance_manager import InstanceManager
-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.git_utils import git_clone_wrapper
 from utils.input_utils import get_selection_input
-from utils.instance_utils import get_instances
+from utils.logger import Logger
 
 
-@dataclass
+class ThemeData(TypedDict):
-class ThemeData:
     name: str
     short_note: str
     author: str
@@ -42,7 +39,8 @@ class ThemeData:
 
 # noinspection PyMethodMayBeStatic
 class MainsailThemeInstallerExtension(BaseExtension):
-    instances: List[Klipper] = get_instances(Klipper)
+    im = InstanceManager(Klipper)
+    instances: List[Klipper] = im.instances
 
     def install_extension(self, **kwargs) -> None:
         MainsailThemeInstallMenu(self.instances).run()
@@ -93,7 +91,7 @@ class MainsailThemeInstallMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {
-            f"{index}": Option(self.install_theme, opt_index=f"{index}")
+            f"{index}": Option(self.install_theme, False, opt_index=f"{index}")
             for index in range(len(self.themes))
         }
 
@@ -104,45 +102,36 @@ 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):
-            j: str = f" {i}" if i < 10 else f"{i}"
+            i = f" {i}" if i < 10 else f"{i}"
-            row: str = f"{j}) [{theme.name}]"
+            row = f"{i}) [{theme.get('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] = []
-            content: str = response.read().decode()
+            csv_data: str = response.read().decode().splitlines()
-            csv_data: List[str] = content.splitlines()
+            csv_reader = csv.DictReader(csv_data, delimiter=",")
-            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: Dict[str, str]  # type: ignore
+                row: ThemeData = row
-                theme: ThemeData = ThemeData(**row)
+                themes.append(row)
-                themes.append(theme)
 
         return themes
 
-    def install_theme(self, **kwargs: Any):
+    def install_theme(self, **kwargs):
-        opt_index: str | None = kwargs.get("opt_index", None)
+        index = int(kwargs.get("opt_index"))
-
-        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.author
+        theme_author: str = theme_data.get("author")
-        theme_repo: str = theme_data.repo
+        theme_repo: str = theme_data.get("repo")
         theme_repo_url: str = f"https://github.com/{theme_author}/{theme_repo}"
 
         print_instance_overview(
@@ -160,13 +149,13 @@ class MainsailThemeInstallMenu(BaseMenu):
         for printer in printer_list:
             git_clone_wrapper(theme_repo_url, printer.cfg_dir.joinpath(".theme"))
 
-        if len(theme_data.short_note) > 1:
+        if len(theme_data.get("short_note", "")) > 1:
             Logger.print_warn("Info from the creator:", prefix=False, start="\n")
-            Logger.print_info(theme_data.short_note, prefix=False, end="\n\n")
+            Logger.print_info(theme_data.get("short_note"), prefix=False, end="\n\n")
 
 
 def get_printer_selection(
-    instances: List[InstanceType], is_install: bool
+    instances: List[BaseInstance], 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

@@ -31,4 +31,3 @@ OBICO_ENV_DIR = Path.home().joinpath("moonraker-obico-env")
 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

@@ -8,14 +8,11 @@
 # ======================================================================= #
 from __future__ import annotations
 
-from dataclasses import dataclass, field
+from dataclasses import dataclass
 from pathlib import Path
 from subprocess import CalledProcessError, run
 
-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,
 )
@@ -29,32 +26,25 @@ from extensions.obico import (
     OBICO_LOG_NAME,
     OBICO_SERVICE_TEMPLATE,
 )
-from utils.fs_utils import create_folders
+from utils.logger import Logger
-from utils.sys_utils import get_service_file_path
 
 
 # noinspection PyMethodMayBeStatic
-@dataclass(repr=True)
+@dataclass
-class MoonrakerObico:
+class MoonrakerObico(BaseInstance):
-    suffix: str
-    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 | None = None
-    cfg_file: Path = field(init=False)
+    log: Path | None = None
     is_linked: bool = False
 
-    def __post_init__(self):
+    def __init__(self, suffix: str = ""):
-        self.base: BaseInstance = BaseInstance(Moonraker, self.suffix)
+        super().__init__(suffix=suffix)
-        self.base.log_file_name = self.log_file_name
 
-        self.service_file_path: Path = get_service_file_path(
+    def __post_init__(self):
-            MoonrakerObico, self.suffix
+        super().__post_init__()
-        )
+        self.cfg_file = self.cfg_dir.joinpath(OBICO_CFG_NAME)
-        self.data_dir: Path = self.base.data_dir
+        self.log = self.log_dir.joinpath(OBICO_LOG_NAME)
-        self.cfg_file = self.base.cfg_dir.joinpath(OBICO_CFG_NAME)
         self.is_linked: bool = self._check_link_status()
 
     def create(self) -> None:
@@ -63,13 +53,13 @@ class MoonrakerObico:
         Logger.print_status("Creating new Obico for Klipper Instance ...")
 
         try:
-            create_folders(self.base.base_folders)
+            self.create_folders()
             create_service_file(
-                name=self.service_file_path.name,
+                name=self.get_service_file_name(extension=True),
                 content=self._prep_service_file_content(),
             )
             create_env_file(
-                path=self.base.sysd_dir.joinpath(OBICO_ENV_FILE_NAME),
+                path=self.sysd_dir.joinpath(OBICO_ENV_FILE_NAME),
                 content=self._prep_env_file_content(),
             )
 
@@ -80,9 +70,24 @@ class MoonrakerObico:
             Logger.print_error(f"Error creating env file: {e}")
             raise
 
+    def delete(self) -> None:
+        service_file: str = self.get_service_file_name(extension=True)
+        service_file_path: 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.as_posix()]
+            run(command, check=True)
+            self.delete_logfiles(OBICO_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
+
     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:
             cmd = [f"{OBICO_LINK_SCRIPT} -q -c {self.cfg_file}"]
@@ -105,7 +110,7 @@ class MoonrakerObico:
 
         service_content = template_content.replace(
             "%USER%",
-            CURRENT_USER,
+            self.user,
         )
         service_content = service_content.replace(
             "%OBICO_DIR%",
@@ -117,7 +122,7 @@ class MoonrakerObico:
         )
         service_content = service_content.replace(
             "%ENV_FILE%",
-            self.base.sysd_dir.joinpath(OBICO_ENV_FILE_NAME).as_posix(),
+            self.sysd_dir.joinpath(OBICO_ENV_FILE_NAME).as_posix(),
         )
         return service_content
 
@@ -132,7 +137,7 @@ class MoonrakerObico:
             raise
         env_file_content = env_template_file_content.replace(
             "%CFG%",
-            f"{self.base.cfg_dir}/{self.cfg_file}",
+            f"{self.cfg_dir}/{self.cfg_file}",
         )
         return env_file_content
 

kiauh/extensions/obico/moonraker_obico_extension.py

@@ -12,7 +12,6 @@ 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,
 )
@@ -23,7 +22,6 @@ from extensions.obico import (
     OBICO_ENV_DIR,
     OBICO_MACROS_CFG_NAME,
     OBICO_REPO,
-    OBICO_REQ_FILE,
     OBICO_UPDATE_CFG_NAME,
     OBICO_UPDATE_CFG_SAMPLE_NAME,
 )
@@ -38,10 +36,9 @@ from utils.config_utils import (
 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.instance_utils import get_instances
+from utils.logger import DialogType, Logger
 from utils.sys_utils import (
     cmd_sysctl_manage,
-    cmd_sysctl_service,
     create_python_venv,
     install_python_requirements,
     parse_packages_from_file,
@@ -62,7 +59,8 @@ 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_instances: List[MoonrakerObico] = get_instances(MoonrakerObico)
+        obico_im = InstanceManager(MoonrakerObico)
+        obico_instances: List[MoonrakerObico] = obico_im.instances
         if obico_instances:
             self._print_is_already_installed()
             options = ["l", "r", "b"]
@@ -81,8 +79,10 @@ class ObicoExtension(BaseExtension):
                 force_clone = True
 
         # let the user confirm installation
-        kl_instances: List[Klipper] = get_instances(Klipper)
+        kl_im = InstanceManager(Klipper)
-        mr_instances: List[Moonraker] = get_instances(Moonraker)
+        kl_instances: List[Klipper] = kl_im.instances
+        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?",
@@ -100,13 +100,14 @@ class ObicoExtension(BaseExtension):
 
             # create obico instances
             for moonraker in mr_instances:
-                instance = MoonrakerObico(suffix=moonraker.suffix)
+                current_instance = MoonrakerObico(suffix=moonraker.suffix)
-                instance.create()
 
-                cmd_sysctl_service(instance.service_file_path.name, "enable")
+                obico_im.current_instance = current_instance
+                obico_im.create_instance()
+                obico_im.enable_instance()
 
                 # create obico config
-                self._create_obico_cfg(instance, moonraker)
+                self._create_obico_cfg(current_instance, moonraker)
 
                 # create obico macros
                 self._create_obico_macros_cfg(moonraker)
@@ -114,17 +115,17 @@ class ObicoExtension(BaseExtension):
                 # create obico update manager
                 self._create_obico_update_manager_cfg(moonraker)
 
-                cmd_sysctl_service(instance.service_file_path.name, "start")
+                obico_im.start_instance()
 
             cmd_sysctl_manage("daemon-reload")
 
             # add to klippers config
             self._patch_printer_cfg(kl_instances)
-            InstanceManager.restart_all(kl_instances)
+            kl_im.restart_all_instance()
 
             # add to moonraker update manager
             self._patch_moonraker_conf(mr_instances)
-            InstanceManager.restart_all(mr_instances)
+            mr_im.restart_all_instance()
 
             # check linking of / ask for linking instances
             self._check_and_opt_link_instances()
@@ -141,13 +142,13 @@ class ObicoExtension(BaseExtension):
     def update_extension(self, **kwargs) -> None:
         Logger.print_status("Updating Obico for Klipper ...")
         try:
-            instances = get_instances(MoonrakerObico)
+            tb_im = InstanceManager(MoonrakerObico)
-            InstanceManager.stop_all(instances)
+            tb_im.stop_all_instance()
 
             git_pull_wrapper(OBICO_REPO, OBICO_DIR)
             self._install_dependencies()
 
-            InstanceManager.start_all(instances)
+            tb_im.start_all_instance()
             Logger.print_ok("Obico for Klipper successfully updated!")
 
         except Exception as e:
@@ -155,13 +156,15 @@ class ObicoExtension(BaseExtension):
 
     def remove_extension(self, **kwargs) -> None:
         Logger.print_status("Removing Obico for Klipper ...")
-
+        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)
-        ob_instances: List[MoonrakerObico] = get_instances(MoonrakerObico)
+        mr_instances: List[Moonraker] = mr_im.instances
+        ob_im = InstanceManager(MoonrakerObico)
+        ob_instances: List[MoonrakerObico] = ob_im.instances
 
         try:
-            self._remove_obico_instances(ob_instances)
+            self._remove_obico_instances(ob_im, ob_instances)
             self._remove_obico_dir()
             self._remove_obico_env()
             remove_config_section(f"include {OBICO_MACROS_CFG_NAME}", kl_instances)
@@ -193,8 +196,8 @@ class ObicoExtension(BaseExtension):
             ],
         )
 
-    def _print_moonraker_instances(self, mr_instances: List[Moonraker]) -> None:
+    def _print_moonraker_instances(self, mr_instances) -> 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,27 +239,28 @@ class ObicoExtension(BaseExtension):
         check_install_dependencies({*package_list})
 
         # create virtualenv
-        if create_python_venv(OBICO_ENV_DIR):
+        create_python_venv(OBICO_ENV_DIR)
-            install_python_requirements(OBICO_ENV_DIR, OBICO_REQ_FILE)
+        requirements = OBICO_DIR.joinpath("requirements.txt")
+        install_python_requirements(OBICO_ENV_DIR, requirements)
 
-    def _create_obico_macros_cfg(self, moonraker: Moonraker) -> None:
+    def _create_obico_macros_cfg(self, moonraker) -> None:
         macros_cfg = OBICO_DIR.joinpath(f"include_cfgs/{OBICO_MACROS_CFG_NAME}")
-        macros_target = moonraker.base.cfg_dir.joinpath(OBICO_MACROS_CFG_NAME)
+        macros_target = moonraker.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_NAME}' in {moonraker.base.cfg_dir} already exists! Skipped ..."
+                f"Obico's '{OBICO_MACROS_CFG_NAME}' in {moonraker.cfg_dir} already exists! Skipped ..."
             )
 
-    def _create_obico_update_manager_cfg(self, moonraker: Moonraker) -> None:
+    def _create_obico_update_manager_cfg(self, moonraker) -> None:
         update_cfg = OBICO_DIR.joinpath(OBICO_UPDATE_CFG_SAMPLE_NAME)
-        update_cfg_target = moonraker.base.cfg_dir.joinpath(OBICO_UPDATE_CFG_NAME)
+        update_cfg_target = moonraker.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_NAME}' in {moonraker.base.cfg_dir} already exists! Skipped ..."
+                f"Obico's '{OBICO_UPDATE_CFG_NAME}' in {moonraker.cfg_dir} already exists! Skipped ..."
             )
 
     def _create_obico_cfg(
@@ -276,7 +280,7 @@ class ObicoExtension(BaseExtension):
             self._patch_obico_cfg(moonraker, current_instance)
         else:
             Logger.print_info(
-                f"Obico config in {current_instance.base.cfg_dir} already exists! Skipped ..."
+                f"Obico config in {current_instance.cfg_dir} already exists! Skipped ..."
             )
 
     def _patch_obico_cfg(self, moonraker: Moonraker, obico: MoonrakerObico) -> None:
@@ -284,11 +288,7 @@ class ObicoExtension(BaseExtension):
         scp.read(obico.cfg_file)
         scp.set("server", "url", self.server_url)
         scp.set("moonraker", "port", str(moonraker.port))
-        scp.set(
+        scp.set("logging", "path", obico.log.as_posix())
-            "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:
@@ -307,8 +307,8 @@ class ObicoExtension(BaseExtension):
 
     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] = get_instances(MoonrakerObico)
+        ob_instances: List[MoonrakerObico] = ob_im.instances
         unlinked_instances: List[MoonrakerObico] = [
             obico for obico in ob_instances if not obico.is_linked
         ]
@@ -318,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:",
@@ -336,6 +336,7 @@ class ObicoExtension(BaseExtension):
 
     def _remove_obico_instances(
         self,
+        instance_manager: InstanceManager,
         instance_list: List[MoonrakerObico],
     ) -> None:
         if not instance_list:
@@ -344,9 +345,14 @@ class ObicoExtension(BaseExtension):
 
         for instance in instance_list:
             Logger.print_status(
-                f"Removing instance {instance.service_file_path.stem} ..."
+                f"Removing instance {instance.get_service_file_name()} ..."
             )
-            InstanceManager.remove(instance)
+            instance_manager.current_instance = 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 ...")

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
@@ -51,11 +51,14 @@ class PrettyGcodeExtension(BaseExtension):
         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

@@ -26,4 +26,3 @@ 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

@@ -8,14 +8,11 @@
 # ======================================================================= #
 from __future__ import annotations
 
-from dataclasses import dataclass, field
+from dataclasses import dataclass
 from pathlib import Path
-from subprocess import CalledProcessError
+from subprocess import CalledProcessError, run
 
-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 extensions.telegram_bot import (
     TG_BOT_CFG_NAME,
     TG_BOT_DIR,
@@ -25,31 +22,24 @@ from extensions.telegram_bot import (
     TG_BOT_LOG_NAME,
     TG_BOT_SERVICE_TEMPLATE,
 )
-from utils.fs_utils import create_folders
+from utils.logger import Logger
-from utils.sys_utils import get_service_file_path
 
 
 # noinspection PyMethodMayBeStatic
-@dataclass(repr=True)
+@dataclass
-class MoonrakerTelegramBot:
+class MoonrakerTelegramBot(BaseInstance):
-    suffix: str
-    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 | None = None
-    cfg_file: Path = field(init=False)
+    log: Path | None = None
+
+    def __init__(self, suffix: str = ""):
+        super().__init__(suffix=suffix)
 
     def __post_init__(self):
-        self.base: BaseInstance = BaseInstance(Moonraker, self.suffix)
+        super().__post_init__()
-        self.base.log_file_name = self.log_file_name
+        self.cfg_file = self.cfg_dir.joinpath(TG_BOT_CFG_NAME)
-
+        self.log = self.log_dir.joinpath(TG_BOT_LOG_NAME)
-        self.service_file_path: Path = get_service_file_path(
-            MoonrakerTelegramBot, self.suffix
-        )
-        self.data_dir: Path = self.base.data_dir
-        self.cfg_file = self.base.cfg_dir.joinpath(TG_BOT_CFG_NAME)
 
     def create(self) -> None:
         from utils.sys_utils import create_env_file, create_service_file
@@ -57,13 +47,13 @@ class MoonrakerTelegramBot:
         Logger.print_status("Creating new Moonraker Telegram Bot Instance ...")
 
         try:
-            create_folders(self.base.base_folders)
+            self.create_folders()
             create_service_file(
-                name=self.service_file_path.name,
+                name=self.get_service_file_name(extension=True),
                 content=self._prep_service_file_content(),
             )
             create_env_file(
-                path=self.base.sysd_dir.joinpath(TG_BOT_ENV_FILE_NAME),
+                path=self.sysd_dir.joinpath(TG_BOT_ENV_FILE_NAME),
                 content=self._prep_env_file_content(),
             )
 
@@ -74,6 +64,20 @@ class MoonrakerTelegramBot:
             Logger.print_error(f"Error creating env file: {e}")
             raise
 
+    def delete(self) -> None:
+        service_file: str = self.get_service_file_name(extension=True)
+        service_file_path: 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.as_posix()]
+            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 _prep_service_file_content(self) -> str:
         template = TG_BOT_SERVICE_TEMPLATE
 
@@ -86,7 +90,7 @@ class MoonrakerTelegramBot:
 
         service_content = template_content.replace(
             "%USER%",
-            CURRENT_USER,
+            self.user,
         )
         service_content = service_content.replace(
             "%TELEGRAM_BOT_DIR%",
@@ -98,7 +102,7 @@ class MoonrakerTelegramBot:
         )
         service_content = service_content.replace(
             "%ENV_FILE%",
-            self.base.sysd_dir.joinpath(TG_BOT_ENV_FILE_NAME).as_posix(),
+            self.sysd_dir.joinpath(TG_BOT_ENV_FILE_NAME).as_posix(),
         )
         return service_content
 
@@ -118,10 +122,10 @@ class MoonrakerTelegramBot:
         )
         env_file_content = env_file_content.replace(
             "%CFG%",
-            f"{self.base.cfg_dir}/printer.cfg",
+            f"{self.cfg_dir}/printer.cfg",
         )
         env_file_content = env_file_content.replace(
             "%LOG%",
-            self.base.log_dir.joinpath(self.log_file_name).as_posix(),
+            self.log.as_posix() if self.log else "",
         )
         return env_file_content

kiauh/extensions/telegram_bot/moonraker_telegram_bot_extension.py

@@ -12,9 +12,8 @@ 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 import TG_BOT_REPO
 from extensions.telegram_bot.moonraker_telegram_bot import (
     TG_BOT_DIR,
     TG_BOT_ENV,
@@ -25,10 +24,9 @@ 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.instance_utils import get_instances
+from utils.logger import DialogType, Logger
 from utils.sys_utils import (
     cmd_sysctl_manage,
-    cmd_sysctl_service,
     create_python_venv,
     install_python_requirements,
     parse_packages_from_file,
@@ -39,8 +37,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] = get_instances(Moonraker)
+        mr_instances: List[Moonraker] = mr_im.instances
         if not mr_instances:
             Logger.print_dialog(
                 DialogType.WARNING,
@@ -52,9 +50,7 @@ class TelegramBotExtension(BaseExtension):
             )
             return
 
-        instance_names = [
+        instance_names = [f"● {instance.data_dir_name}" for instance in mr_instances]
-            f"● {instance.service_file_path.name}" for instance in mr_instances
-        ]
         Logger.print_dialog(
             DialogType.INFO,
             [
@@ -79,28 +75,30 @@ class TelegramBotExtension(BaseExtension):
 
             # 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:
-                instance = MoonrakerTelegramBot(suffix=name)
+                current_instance = MoonrakerTelegramBot(suffix=name)
-                instance.create()
 
-                cmd_sysctl_service(instance.service_file_path.name, "enable")
+                tb_im.current_instance = current_instance
+                tb_im.create_instance()
+                tb_im.enable_instance()
 
                 if create_example_cfg:
                     Logger.print_status(
-                        f"Creating Telegram Bot config in {instance.base.cfg_dir} ..."
+                        f"Creating Telegram Bot config in {current_instance.cfg_dir} ..."
                     )
                     template = TG_BOT_DIR.joinpath("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 {instance.base.cfg_dir} already exists! Skipped ..."
+                            f"Telegram Bot config in {current_instance.cfg_dir} already exists! Skipped ..."
                         )
 
-                cmd_sysctl_service(instance.service_file_path.name, "start")
+                tb_im.start_instance()
 
             cmd_sysctl_manage("daemon-reload")
 
@@ -108,7 +106,7 @@ class TelegramBotExtension(BaseExtension):
             self._patch_bot_update_manager(mr_instances)
 
             # restart moonraker
-            InstanceManager.restart_all(mr_instances)
+            mr_im.restart_all_instance()
 
             if show_config_dialog:
                 Logger.print_dialog(
@@ -120,7 +118,6 @@ 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!")
@@ -131,23 +128,23 @@ class TelegramBotExtension(BaseExtension):
 
     def update_extension(self, **kwargs) -> None:
         Logger.print_status("Updating Moonraker Telegram Bot ...")
-
+        tb_im = InstanceManager(MoonrakerTelegramBot)
-        instances = get_instances(MoonrakerTelegramBot)
+        tb_im.stop_all_instance()
-        InstanceManager.stop_all(instances)
 
         git_pull_wrapper(TG_BOT_REPO, TG_BOT_DIR)
         self._install_dependencies()
 
-        InstanceManager.start_all(instances)
+        tb_im.start_all_instance()
 
     def remove_extension(self, **kwargs) -> None:
         Logger.print_status("Removing Moonraker Telegram Bot ...")
-
+        mr_im = InstanceManager(Moonraker)
-        mr_instances: List[Moonraker] = get_instances(Moonraker)
+        mr_instances: List[Moonraker] = mr_im.instances
-        tb_instances: List[MoonrakerTelegramBot] = get_instances(MoonrakerTelegramBot)
+        tb_im = InstanceManager(MoonrakerTelegramBot)
+        tb_instances: List[MoonrakerTelegramBot] = tb_im.instances
 
         try:
-            self._remove_bot_instances(tb_instances)
+            self._remove_bot_instances(tb_im, tb_instances)
             self._remove_bot_dir()
             self._remove_bot_env()
             remove_config_section("update_manager moonraker-telegram-bot", mr_instances)
@@ -164,8 +161,9 @@ class TelegramBotExtension(BaseExtension):
         check_install_dependencies({*package_list})
 
         # create virtualenv
-        if create_python_venv(TG_BOT_ENV):
+        create_python_venv(TG_BOT_ENV)
-            install_python_requirements(TG_BOT_ENV, TG_BOT_REQ_FILE)
+        requirements = TG_BOT_DIR.joinpath("scripts/requirements.txt")
+        install_python_requirements(TG_BOT_ENV, requirements)
 
     def _patch_bot_update_manager(self, instances: List[Moonraker]) -> None:
         env_py = f"{TG_BOT_ENV}/bin/python"
@@ -175,7 +173,7 @@ class TelegramBotExtension(BaseExtension):
             options=[
                 ("type", "git_repo"),
                 ("path", str(TG_BOT_DIR)),
-                ("origin", TG_BOT_REPO),
+                ("orgin", TG_BOT_REPO),
                 ("env", env_py),
                 ("requirements", "scripts/requirements.txt"),
                 ("install_script", "scripts/install.sh"),
@@ -184,13 +182,19 @@ 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.service_file_path.stem} ..."
+                f"Removing instance {instance.get_service_file_name()} ..."
             )
-            InstanceManager.remove(instance)
+            instance_manager.current_instance = 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 TG_BOT_DIR.exists():
@@ -215,7 +219,7 @@ class TelegramBotExtension(BaseExtension):
     def _delete_bot_logs(self, instances: List[MoonrakerTelegramBot]) -> None:
         all_logfiles = []
         for instance in instances:
-            all_logfiles = list(instance.base.log_dir.glob("telegram_bot.log*"))
+            all_logfiles = list(instance.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,9 +7,9 @@
 #  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() -> None:

kiauh/procedures/switch_repo.py

@@ -1,154 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-from __future__ import annotations
-
-import shutil
-from pathlib import Path
-from typing import Literal
-
-from components.klipper import (
-    KLIPPER_BACKUP_DIR,
-    KLIPPER_DIR,
-    KLIPPER_ENV_DIR,
-    KLIPPER_REQ_FILE,
-)
-from components.klipper.klipper import Klipper
-from components.klipper.klipper_setup import install_klipper_packages
-from components.moonraker import (
-    MOONRAKER_BACKUP_DIR,
-    MOONRAKER_DIR,
-    MOONRAKER_ENV_DIR,
-    MOONRAKER_REQ_FILE,
-)
-from components.moonraker.moonraker import Moonraker
-from components.moonraker.moonraker_setup import install_moonraker_packages
-from core.backup_manager.backup_manager import BackupManager, BackupManagerException
-from core.instance_manager.instance_manager import InstanceManager
-from core.logger import Logger
-from core.settings.kiauh_settings import RepoSettings
-from utils.git_utils import GitException, get_repo_name, git_clone_wrapper
-from utils.instance_utils import get_instances
-from utils.sys_utils import (
-    VenvCreationFailedException,
-    create_python_venv,
-    install_python_requirements,
-)
-
-
-class RepoSwitchFailedException(Exception):
-    pass
-
-
-def run_switch_repo_routine(
-    name: Literal["klipper", "moonraker"], repo_settings: RepoSettings
-) -> None:
-    repo_dir: Path = KLIPPER_DIR if name == "klipper" else MOONRAKER_DIR
-    env_dir: Path = KLIPPER_ENV_DIR if name == "klipper" else MOONRAKER_ENV_DIR
-    req_file = KLIPPER_REQ_FILE if name == "klipper" else MOONRAKER_REQ_FILE
-    backup_dir: Path = KLIPPER_BACKUP_DIR if name == "klipper" else MOONRAKER_BACKUP_DIR
-    _type = Klipper if name == "klipper" else Moonraker
-
-    # step 1: stop all instances
-    Logger.print_status(f"Stopping all {_type.__name__} instances ...")
-    instances = get_instances(_type)
-    InstanceManager.stop_all(instances)
-
-    repo_dir_backup_path: Path | None = None
-    env_dir_backup_path: Path | None = None
-
-    try:
-        # step 2: backup old repo and env
-        org, repo = get_repo_name(repo_dir)
-        backup_dir = backup_dir.joinpath(org)
-        bm = BackupManager()
-        repo_dir_backup_path = bm.backup_directory(
-            repo_dir.name,
-            repo_dir,
-            backup_dir,
-        )
-        env_dir_backup_path = bm.backup_directory(
-            env_dir.name,
-            env_dir,
-            backup_dir,
-        )
-
-        # step 3: read repo url and branch from settings
-        repo_url = repo_settings.repo_url
-        branch = repo_settings.branch
-
-        if not (repo_url or branch):
-            error = f"Invalid repository URL ({repo_url}) or branch ({branch})!"
-            raise ValueError(error)
-
-        # step 4: clone new repo
-        git_clone_wrapper(repo_url, repo_dir, branch, force=True)
-
-        # step 5: install os dependencies
-        if name == "klipper":
-            install_klipper_packages()
-        elif name == "moonraker":
-            install_moonraker_packages()
-
-        # step 6: recreate python virtualenv
-        Logger.print_status(f"Recreating {_type.__name__} virtualenv ...")
-        if not create_python_venv(env_dir, force=True):
-            raise GitException(f"Failed to recreate virtualenv for {_type.__name__}")
-        else:
-            install_python_requirements(env_dir, req_file)
-
-        Logger.print_ok(f"Switched to {repo_url} at branch {branch}!")
-
-    except BackupManagerException as e:
-        Logger.print_error(f"Error during backup of repository: {e}")
-        raise RepoSwitchFailedException(e)
-
-    except (GitException, VenvCreationFailedException) as e:
-        # if something goes wrong during cloning or recreating the virtualenv,
-        # we restore the backup of the repo and env
-        Logger.print_error(f"Error during repository switch: {e}", start="\n")
-        Logger.print_status(f"Restoring last backup of {_type.__name__} ...")
-        _restore_repo_backup(
-            _type.__name__,
-            env_dir,
-            env_dir_backup_path,
-            repo_dir,
-            repo_dir_backup_path,
-        )
-
-    except RepoSwitchFailedException as e:
-        Logger.print_error(f"Something went wrong: {e}")
-        return
-
-    Logger.print_status(f"Restarting all {_type.__name__} instances ...")
-    InstanceManager.start_all(instances)
-
-
-def _restore_repo_backup(
-    name: str,
-    env_dir: Path,
-    env_dir_backup_path: Path | None,
-    repo_dir: Path,
-    repo_dir_backup_path: Path | None,
-) -> None:
-    # if repo_dir_backup_path is not None and env_dir_backup_path is not None:
-    if not repo_dir_backup_path or not env_dir_backup_path:
-        raise RepoSwitchFailedException(
-            f"Unable to restore backup of {name}! Path of backups directory is None!"
-        )
-
-    try:
-        if repo_dir.exists():
-            shutil.rmtree(repo_dir)
-            shutil.copytree(repo_dir_backup_path, repo_dir)
-        if env_dir.exists():
-            shutil.rmtree(env_dir)
-            shutil.copytree(env_dir_backup_path, env_dir)
-        Logger.print_warn(f"Restored backup of {name} successfully!")
-    except Exception as e:
-        raise RepoSwitchFailedException(f"Error restoring backup: {e}")

kiauh/procedures/system.py

@@ -10,10 +10,10 @@
 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
+from utils.logger import DialogType, Logger
 
 
 def change_system_hostname() -> None:
@@ -35,6 +35,8 @@ def change_system_hostname() -> None:
             "browser.",
         ],
         custom_title="CHANGE SYSTEM HOSTNAME",
+        padding_top=0,
+        padding_bottom=0,
     )
     if not get_confirm("Do you want to change the hostname?", default_choice=False):
         return
@@ -48,6 +50,8 @@ def change_system_hostname() -> None:
             "● Any special characters",
             "● No leading or trailing '-'",
         ],
+        padding_top=0,
+        padding_bottom=0,
     )
     hostname = get_string_input(
         "Enter the new hostname",

kiauh/utils/__init__.py

@@ -9,4 +9,15 @@
 
 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,37 +11,24 @@ from __future__ import annotations
 import re
 from datetime import datetime
 from pathlib import Path
-from typing import Dict, List, Literal, Optional, Set
+from typing import Dict, List, Literal, Optional, Set, Type
 
 from components.klipper.klipper import Klipper
 from core.constants import (
     COLOR_CYAN,
-    GLOBAL_DEPS,
-    PRINTER_CFG_BACKUP_DIR,
     RESET_FORMAT,
 )
-from core.logger import DialogType, Logger
+from core.instance_manager.base_instance import BaseInstance
-from core.types import ComponentStatus, StatusCode
+from core.instance_manager.instance_manager import InstanceManager
-from utils.git_utils import (
+from utils import GLOBAL_DEPS, PRINTER_CFG_BACKUP_DIR
-    get_local_commit,
+from utils.git_utils import get_local_commit, get_remote_commit, get_repo_name
-    get_local_tags,
+from utils.logger import DialogType, Logger
-    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:
@@ -89,7 +76,7 @@ def check_install_dependencies(
 def get_install_status(
     repo_dir: Path,
     env_dir: Optional[Path] = None,
-    instance_type: type | None = None,
+    instance_type: Optional[Type[BaseInstance]] = None,
     files: Optional[List[Path]] = None,
 ) -> ComponentStatus:
     """
@@ -100,16 +87,15 @@ 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(get_instances(instance_type))
+        instances = len(im.instances)
         checks.append(instances > 0)
 
     if files is not None:
@@ -124,12 +110,10 @@ def get_install_status(
     else:
         status = 1  # incomplete
 
-    org, repo = get_repo_name(repo_dir)
     return ComponentStatus(
         status=status,
         instances=instances,
-        owner=org,
+        repo=get_repo_name(repo_dir),
-        repo=repo,
         local=get_local_commit(repo_dir),
         remote=get_remote_commit(repo_dir),
     )
@@ -139,14 +123,15 @@ def backup_printer_config_dir() -> None:
     # local import to prevent circular import
     from core.backup_manager.backup_manager import BackupManager
 
-    instances: List[Klipper] = get_instances(Klipper)
+    im = InstanceManager(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.base.cfg_dir,
+            source=instance.cfg_dir,
             target=PRINTER_CFG_BACKUP_DIR,
         )
 
@@ -159,7 +144,8 @@ def moonraker_exists(name: str = "") -> bool:
     """
     from components.moonraker.moonraker import Moonraker
 
-    mr_instances: List[Moonraker] = get_instances(Moonraker)
+    mr_im = InstanceManager(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, Tuple
+from typing import List, Optional, Tuple, TypeVar
 
-from core.instance_type import InstanceType
+from components.klipper.klipper import Klipper
-from core.logger import Logger
+from components.moonraker.moonraker import Moonraker
 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[InstanceType],
+    instances: List[B],
-    options: List[ConfigOption] | None = None,
+    options: Optional[List[ConfigOption]] = 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[InstanceType]) -> None:
+def add_config_section_at_top(section: str, instances: List[B]) -> 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[InstanceType]) -> No
         tmp_cfg_path.rename(cfg_file)
 
 
-def remove_config_section(section: str, instances: List[InstanceType]) -> None:
+def remove_config_section(section: str, instances: List[B]) -> 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,7 +8,6 @@
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
-from __future__ import annotations
 
 import re
 import shutil
@@ -17,8 +16,15 @@ 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 core.logger import Logger
+from utils import (
+    MODULE_PATH,
+    NGINX_CONFD,
+    NGINX_SITES_AVAILABLE,
+    NGINX_SITES_ENABLED,
+)
+from utils.logger import Logger
 
 
 def check_file_exist(file_path: Path, sudo=False) -> bool:
@@ -58,7 +64,7 @@ def remove_with_sudo(file: Path) -> None:
         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
 
 
@@ -75,23 +81,23 @@ def remove_file(file_path: Path, sudo=False) -> None:
 
 def run_remove_routines(file: Path) -> None:
     try:
-        if not file.is_symlink() and not file.exists():
+        if 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() or file.is_symlink():
+        elif file.is_file():
             file.unlink()
         else:
             raise OSError(f"File '{file}' is neither a file nor a directory!")
-        Logger.print_ok(f"File '{file}' was successfully removed!")
+        Logger.print_ok("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(f"File '{file}' was successfully removed!")
+            Logger.print_ok("Successfully removed!")
         except CalledProcessError as e:
             Logger.print_error(f"Error deleting '{file}' with sudo:\n{e}")
             Logger.print_error("Remove this directory manually!")
@@ -108,35 +114,143 @@ def unzip(filepath: Path, target_dir: Path) -> None:
         _zip.extractall(target_dir)
 
 
-def create_folders(dirs: List[Path]) -> None:
+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:
-        for _dir in dirs:
+        command = ["sudo", "cp", source, target]
-            if _dir.exists():
+        run(command, stderr=PIPE, check=True)
-                continue
+    except CalledProcessError as e:
-            _dir.mkdir(exist_ok=True)
+        log = f"Unable to create upstreams.conf: {e.stderr.decode()}"
-            Logger.print_ok(f"Created directory '{_dir}'!")
+        Logger.print_error(log)
-    except OSError as e:
-        Logger.print_error(f"Error creating directories: {e}")
         raise
 
 
-def get_data_dir(instance_type: type, suffix: str) -> Path:
+def copy_common_vars_nginx_cfg() -> None:
-    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))
 
-    if suffix != "":
+def generate_nginx_cfg_from_template(name: str, template_src: Path, **kwargs) -> None:
-        # this is the new data dir naming scheme introduced in v6.0.0
+    """
-        return Path.home().joinpath(f"printer_{suffix}_data")
+    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()
 
-    return Path.home().joinpath("printer_data")
+        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():
+        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

@@ -9,15 +9,10 @@ from pathlib import Path
 from subprocess import DEVNULL, PIPE, CalledProcessError, check_output, run
 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.instance_utils import get_instances
+from utils.logger import Logger
-
-
-class GitException(Exception):
-    pass
 
 
 def git_clone_wrapper(
@@ -47,10 +42,10 @@ def git_clone_wrapper(
     except CalledProcessError:
         log = "An unexpected error occured during cloning of the repository."
         Logger.print_error(log)
-        raise GitException(log)
+        return
     except OSError as e:
         Logger.print_error(f"Error removing existing repository: {e.strerror}")
-        raise GitException(f"Error removing existing repository: {e.strerror}")
+        return
 
 
 def git_pull_wrapper(repo: str, target_dir: Path) -> None:
@@ -70,58 +65,24 @@ def git_pull_wrapper(repo: str, target_dir: Path) -> None:
         return
 
 
-def get_repo_name(repo: Path) -> tuple[str, str] | None:
+def get_repo_name(repo: Path) -> str | None:
     """
     Helper method to extract the organisation and name of a repository |
     :param repo: repository to extract the values from
     :return: String in form of "<orga>/<name>" or None
     """
     if not repo.exists() or not repo.joinpath(".git").exists():
-        return "-", "-"
+        return "-"
 
     try:
         cmd = ["git", "-C", repo.as_posix(), "config", "--get", "remote.origin.url"]
-        result: str = check_output(cmd, stderr=DEVNULL).decode(encoding="utf-8")
+        result = check_output(cmd, stderr=DEVNULL)
-        substrings: List[str] = result.strip().split("/")[-2:]
+        return "/".join(result.decode().strip().split("/")[-2:])
-        return substrings[0], substrings[1]
-
-        # return "/".join(substrings).replace(".git", "")
     except CalledProcessError:
         return None
 
 
-def get_local_tags(repo_path: Path, _filter: str | None = None) -> List[str]:
+def get_tags(repo_path: str) -> 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:
@@ -139,14 +100,14 @@ def get_remote_tags(repo_path: str) -> List[str]:
         raise
 
 
-def get_latest_remote_tag(repo_path: str) -> str:
+def get_latest_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_remote_tags(repo_path)) > 0:
+        if len(latest_tag := get_tags(repo_path)) > 0:
             return latest_tag[0]
         else:
             return ""
@@ -161,10 +122,7 @@ def get_latest_unstable_tag(repo_path: str) -> str:
     :return: tag or empty string
     """
     try:
-        if (
+        if len(unstable_tags := [t for t in get_tags(repo_path) if "-" in t]) > 0:
-            len(unstable_tags := [t for t in get_remote_tags(repo_path) if "-" in t])
-            > 0
-        ):
             return unstable_tags[0]
         else:
             return ""
@@ -173,34 +131,6 @@ 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
@@ -234,8 +164,7 @@ def git_cmd_clone(repo: str, target_dir: Path) -> None:
 
         Logger.print_ok("Clone successful!")
     except CalledProcessError as e:
-        error = e.stderr.decode() if e.stderr else "Unknown error"
+        log = f"Error cloning repository {repo}: {e.stderr.decode()}"
-        log = f"Error cloning repository {repo}: {error}"
         Logger.print_error(log)
         raise
 
@@ -265,15 +194,15 @@ def git_cmd_pull(target_dir: Path) -> None:
         raise
 
 
-def rollback_repository(repo_dir: Path, instance: Type[InstanceType]) -> None:
+def rollback_repository(repo_dir: Path, instance: Type[BaseInstance]) -> None:
     q1 = "How many commits do you want to roll back"
     amount = get_number_input(q1, 1, allow_go_back=True)
 
-    instances = get_instances(instance)
+    im = InstanceManager(instance)
 
     Logger.print_warn("Do not continue if you have ongoing prints!", start="\n")
     Logger.print_warn(
-        f"All currently running {instance.__name__} services will be stopped!"
+        f"All currently running {im.instance_type.__name__} services will be stopped!"
     )
     if not get_confirm(
         f"Roll back {amount} commit{'s' if amount > 1 else ''}",
@@ -283,7 +212,7 @@ def rollback_repository(repo_dir: Path, instance: Type[InstanceType]) -> None:
         Logger.print_info("Aborting roll back ...")
         return
 
-    InstanceManager.stop_all(instances)
+    im.stop_all_instance()
 
     try:
         cmd = ["git", "reset", "--hard", f"HEAD~{amount}"]
@@ -292,4 +221,4 @@ def rollback_repository(repo_dir: Path, instance: Type[InstanceType]) -> None:
     except CalledProcessError as e:
         Logger.print_error(f"An error occured during repo rollback:\n{e}")
 
-    InstanceManager.start_all(instances)
+    im.start_all_instance()

kiauh/utils/input_utils.py

@@ -11,8 +11,9 @@ from __future__ import annotations
 import re
 from typing import Dict, List
 
-from core.constants import COLOR_CYAN, INVALID_CHOICE, RESET_FORMAT
+from core.constants import COLOR_CYAN, RESET_FORMAT
-from core.logger import Logger
+from utils import INVALID_CHOICE
+from utils.logger import Logger
 
 
 def get_confirm(question: str, default_choice=True, allow_go_back=False) -> bool | None:
@@ -137,7 +138,7 @@ def get_selection_input(question: str, option_list: List | Dict, default=None) -
         else:
             raise ValueError("Invalid option_list type")
 
-        Logger.print_error("Invalid option! Please select a valid option.", False)
+        Logger.print_error(INVALID_CHOICE)
 
 
 def format_question(question: str, default=None) -> str:

kiauh/utils/instance_utils.py

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

@@ -92,8 +92,8 @@ class Logger:
         center_content: bool = False,
         custom_title: str | None = None,
         custom_color: DialogCustomColor | None = None,
-        margin_top: int = 0,
+        padding_top: int = 1,
-        margin_bottom: int = 0,
+        padding_bottom: int = 1,
     ) -> None:
         """
         Prints a dialog with the given title and content.
@@ -106,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 margin_top: The number of empty lines to print before the dialog.
+        :param padding_top: The number of empty lines to print before the dialog.
-        :param margin_bottom: The number of empty lines to print after the dialog.
+        :param padding_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)
@@ -116,12 +116,12 @@ class Logger:
         top = Logger._format_top_border(dialog_color)
         bottom = Logger._format_bottom_border()
 
-        print("\n" * margin_top)
+        print("\n" * padding_top)
         print(
             f"{top}{dialog_title_formatted}{dialog_content}{bottom}",
             end="",
         )
-        print("\n" * margin_bottom)
+        print("\n" * padding_bottom)
 
     @staticmethod
     def _get_dialog_title(

kiauh/utils/spinner.py

@@ -0,0 +1,34 @@
+import sys
+import threading
+import time
+from typing import List
+
+
+class Spinner:
+    def __init__(self, message: str = "Loading", delay: float = 0.2) -> None:
+        self.message = f"{message} ..."
+        self.delay = delay
+        self._stop_event = threading.Event()
+        self._thread = threading.Thread(target=self._animate)
+
+    def _animate(self) -> None:
+        animation: List[str] = ["◜", "◝", "◞", "◟"]
+        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) -> 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/utils/sys_utils.py

@@ -22,9 +22,9 @@ from subprocess import DEVNULL, PIPE, CalledProcessError, Popen, check_output, r
 from typing import List, Literal, Set
 
 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",
@@ -39,10 +39,6 @@ SysCtlServiceAction = Literal[
 SysCtlManageAction = Literal["daemon-reload", "reset-failed"]
 
 
-class VenvCreationFailedException(Exception):
-    pass
-
-
 def kill(opt_err_msg: str = "") -> None:
     """
     Kills the application |
@@ -91,14 +87,11 @@ def parse_packages_from_file(source_file: Path) -> List[str]:
     return packages
 
 
-def create_python_venv(target: Path, force: bool = False) -> bool:
+def create_python_venv(target: Path) -> None:
     """
-    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 force: Force recreation of the virtualenv
     :param target: Path where to create the virtualenv at
-    :return: bool
+    :return: None
     """
     Logger.print_status("Set up Python virtual environment ...")
     if not target.exists():
@@ -106,25 +99,20 @@ def create_python_venv(target: Path, force: bool = False) -> bool:
             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}")
-            return False
+            raise
     else:
-        if not force and not get_confirm(
+        if get_confirm("Virtualenv already exists. Re-create?", default_choice=False):
-            "Virtualenv already exists. Re-create?", default_choice=False
+            try:
-        ):
+                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:
@@ -179,14 +167,14 @@ def install_python_requirements(target: Path, requirements: Path) -> None:
 
         if result.returncode != 0 or result.stderr:
             Logger.print_error(f"{result.stderr}", False)
-            raise VenvCreationFailedException("Installing Python requirements failed!")
+            Logger.print_error("Installing Python requirements failed!")
+            return
 
         Logger.print_ok("Installing Python requirements successful!")
-
+    except CalledProcessError as e:
-    except Exception as e:
+        log = f"Error installing Python requirements:\n{e.output.decode()}"
-        log = f"Error installing Python requirements: {e}"
         Logger.print_error(log)
-        raise VenvCreationFailedException(log)
+        raise
 
 
 def update_system_package_lists(silent: bool, rls_info_change=False) -> None:
@@ -413,18 +401,15 @@ def cmd_sysctl_manage(action: SysCtlManageAction) -> None:
         raise
 
 
-def unit_file_exists(
+def service_instance_exists(name: str, exclude: List[str] | None = None) -> bool:
-    name: str, suffix: Literal["service", "timer"], exclude: List[str] | None = None
-) -> bool:
     """
-    Checks if a systemd unit file of the provided suffix exists.
+    Checks if a systemd service instance exists.
-    :param name: the name of the unit file
+    :param name: the service name
-    :param suffix: suffix of the unit file, either "service" or "timer"
+    :param exclude: List of strings of service names to exclude
-    :param exclude: List of strings of names to exclude
+    :return: True if the service exists, False otherwise
-    :return: True if the unit file exists, False otherwise
     """
     exclude = exclude or []
-    pattern = re.compile(f"^{name}(-[0-9a-zA-Z]+)?.{suffix}$")
+    pattern = re.compile(f"^{name}(-[0-9a-zA-Z]+)?.service$")
     service_list = [
         Path(SYSTEMD, service)
         for service in SYSTEMD.iterdir()
@@ -491,43 +476,21 @@ def create_env_file(path: Path, content: str) -> None:
         raise
 
 
-def remove_system_service(service_name: str) -> None:
+def remove_service_file(service_name: str, service_file: Path) -> None:
     """
-    Disables and removes a systemd service
+    Removes a systemd service file at the provided path with the provided name.
-    :param service_name: name of the service unit file - must end with '.service'
+    :param service_name: the name of the 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(file)
+        remove_with_sudo(service_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}: {e}")
+        Logger.print_error(f"Error removing {service_name}:\n{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

kiauh/utils/types.py

@@ -23,7 +23,6 @@ StatusMap: Dict[StatusCode, StatusText] = {
 @dataclass
 class ComponentStatus:
     status: StatusCode
-    owner: str | None = None
     repo: str | None = None
     local: str | None = None
     remote: str | None = None

scripts/backup.sh

@@ -45,13 +45,13 @@ function backup_config_dir() {
     for folder in ${config_pathes}; do
       if [[ -d ${folder} ]]; then
         status_msg "Create backup of ${folder} ..."
-
+  
         folder_name=$(echo "${folder}" | rev | cut -d"/" -f2 | rev)
         target_dir="${BACKUP_DIR}/configs/${current_date}/${folder_name}"
         mkdir -p "${target_dir}"
         cp -r "${folder}" "${target_dir}"
         i=$(( i + 1 ))
-
+  
         ok_msg "Backup created in:\n${target_dir}"
       fi
     done
@@ -213,19 +213,3 @@ function backup_octoeverywhere() {
     print_error "Can't back up OctoEverywhere directory!\n Not found!"
   fi
 }
-
-function backup_spoolman() {
-  local current_date
-
-  if [[ -d ${SPOOLMAN_DIR} ]] ; then
-    status_msg "Creating Spoolman backup ..."
-    check_for_backup_dir
-    current_date=$(get_date)
-    status_msg "Timestamp: ${current_date}"
-    mkdir -p "${BACKUP_DIR}/Spoolman-backups/${current_date}"
-    cp -r "${SPOOLMAN_DIR}" "${_}" && cp -r "${SPOOLMAN_DB_DIR}/spoolman.db" "${_}"
-    print_confirm "Spoolman backup complete!"
-  else
-    print_error "Can't back up Spoolman directory!\n Not found!"
-  fi
-}

scripts/fluidd.sh

@@ -37,7 +37,7 @@ function install_fluidd() {
   fi
 
   ### checking dependencies
-  local dep=(wget nginx unzip)
+  local dep=(wget nginx)
   dependency_check "${dep[@]}"
   ### detect conflicting Haproxy and Apache2 installations
   detect_conflicting_packages

scripts/globals.sh

@@ -87,9 +87,4 @@ function set_globals() {
   OCTOAPP_ENV="${HOME}/octoapp-env"
   OCTOAPP_DIR="${HOME}/octoapp"
   OCTOAPP_REPO="https://github.com/crysxd/OctoApp-Plugin.git"
-
-  #=============== Spoolman ================#
-  SPOOLMAN_DIR="${HOME}/Spoolman"
-  SPOOLMAN_DB_DIR="${HOME}/.local/share/spoolman"
-  SPOOLMAN_REPO="https://api.github.com/repos/Donkie/Spoolman/releases/latest"
 }

scripts/mainsail.sh

@@ -37,7 +37,7 @@ function install_mainsail() {
   fi
 
   ### checking dependencies
-  local dep=(wget nginx unzip)
+  local dep=(wget nginx)
   dependency_check "${dep[@]}"
   ### detect conflicting Haproxy and Apache2 installations
   detect_conflicting_packages

scripts/moonraker.sh

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

scripts/spoolman.sh

@@ -1,281 +0,0 @@
-#!/usr/bin/env bash
-
-#=======================================================================#
-# 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 #
-#=======================================================================#
-
-# Error Handling
-set -e
-
-function install_spoolman() {
-
-  pushd "${HOME}" &> /dev/null || exit 1
-
-  dependency_check curl jq
-
-  if [[ ! -d "${SPOOLMAN_DIR}" && -z "$(ls -A "${SPOOLMAN_DIR}" 2> /dev/null)" ]]; then
-    status_msg "Downloading spoolman..."
-    setup_spoolman_folder
-    status_msg "Downloading complete"
-    start_install_script
-    advanced_config_prompt
-  else
-    ### In case spoolman is "incomplete" rerun install script
-    if get_spoolman_status | grep -q "Incomplete!"; then
-      start_install_script
-      exit 1
-    fi
-
-    ok_msg "Spoolman already installed"
-    exit 1
-  fi
-
-  enable_moonraker_integration_prompt
-  patch_spoolman_update_manager
-
-  do_action_service "restart" "moonraker"
-}
-
-function update_spoolman() {
-  ### stop and disable old spoolman service
-  do_action_service "stop" "Spoolman"
-  do_action_service "disable" "Spoolman"
-
-  mv "${SPOOLMAN_DIR}" "${SPOOLMAN_DIR}_old"
-
-  setup_spoolman_folder
-  cp "${SPOOLMAN_DIR}_old/.env" "${SPOOLMAN_DIR}/.env"
-
-  start_install_script
-
-  rm -rf "${SPOOLMAN_DIR}_old"
-}
-
-function remove_spoolman(){
-  if [[ -d "${SPOOLMAN_DIR}" ]]; then
-    status_msg "Removing spoolman service..."
-    do_action_service "stop" "Spoolman"
-    do_action_service "disable" "Spoolman"
-    sudo rm -f "${SYSTEMD}/Spoolman.service"
-    sudo systemctl daemon-reload
-    sudo systemctl reset-failed
-    ok_msg "Spoolman service removed!"
-
-    status_msg "Removing spoolman directory..."
-    rm -rf "${SPOOLMAN_DIR}"
-    ok_msg "Spoolman directory removed!"
-  fi
-
-  print_confirm "Spoolman successfully removed!"
-}
-
-function update_moonraker_configs() {
-  local moonraker_configs regex
-  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/moonraker\.conf"
-  moonraker_configs=$(find "${HOME}" -maxdepth 3 -type f -regextype posix-extended -regex "${regex}" | sort)
-
-  for conf in ${moonraker_configs}; do
-    if ! grep -Eq "^\[update_manager Spoolman\]\s*$" "${conf}"; then
-      ### add new line to conf if it doesn't end with one
-      [[ $(tail -c1 "${conf}" | wc -l) -eq 0 ]] && echo "" >> "${conf}"
-      /bin/sh -c "cat >> ${conf}" << MOONRAKER_CONF
-${1}
-MOONRAKER_CONF
-    fi
-  done
-}
-
-function enable_moonraker_integration() {
-  local integration_str env_port
-  # get spoolman port from .env
-  env_port=$(grep "^SPOOLMAN_PORT=" "${SPOOLMAN_DIR}/.env" | cut -d"=" -f2)
-
-  integration_str="
-[spoolman]
-server: http://$(hostname -I | cut -d" " -f1):${env_port}
-"
-
-  status_msg "Adding Spoolman integration..."
-  update_moonraker_configs "${integration_str}"
-}
-
-function patch_spoolman_update_manager() {
-  local updater_str
-  updater_str="
-[update_manager Spoolman]
-type: zip
-channel: stable
-repo: Donkie/Spoolman
-path: ${SPOOLMAN_DIR}
-virtualenv: .venv
-requirements: requirements.txt
-persistent_files:
-  .venv
-  .env
-managed_services: Spoolman
-"
-
-  update_moonraker_configs "${updater_str}"
-
-  # add spoolman service to moonraker.asvc
-  local moonraker_asvc regex
-  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/moonraker\.asvc"
-  moonraker_asvc=$(find "${HOME}" -maxdepth 2 -type f -regextype posix-extended -regex "${regex}" | sort)
-
-  if [[ -n ${moonraker_asvc} ]]; then
-    status_msg "Adding Spoolman service to moonraker.asvc..."
-    /bin/sh -c "echo 'Spoolman' >> ${moonraker_asvc}"
-  fi
-}
-
-function advanced_config_prompt() {
-  local reply
-  while true; do
-    read -erp "${cyan}###### Continue with default configuration? (Y/n):${white} " reply
-    case "${reply}" in
-      Y|y|Yes|yes|"")
-        select_msg "Yes"
-        break;;
-      N|n|No|no)
-        select_msg "No"
-        advanced_config
-        break;;
-      *)
-        error_msg "Invalid Input!\n";;
-    esac
-  done
-  return 0
-}
-
-function enable_moonraker_integration_prompt() {
-  local reply
-  while true; do
-    read -erp "${cyan}###### Enable Moonraker integration? (Y/n):${white} " reply
-    case "${reply}" in
-      Y|y|Yes|yes|"")
-        select_msg "Yes"
-        enable_moonraker_integration
-        break;;
-      N|n|No|no)
-        select_msg "No"
-        break;;
-      *)
-        error_msg "Invalid Input!\n";;
-    esac
-  done
-  return 0
-}
-
-function advanced_config() {
-  status_msg "###### Advanced configuration"
-
-  local reply
-  while true; do
-    read -erp "${cyan}###### Select spoolman port (7912):${white} " reply
-    ### set default
-    if [[ -z "${reply}" ]]; then
-      reply="7912"
-    fi
-
-    select_msg "${reply}"
-    ### check if port is valid
-    if ! [[ "${reply}" =~ ^[0-9]+$ && "${reply}" -ge 1024 && "${reply}" -le 65535 ]]; then
-      error_msg "Invalid port number!\n"
-      continue
-    fi
-
-    ### update .env
-    sed -i "s/^SPOOLMAN_PORT=.*$/SPOOLMAN_PORT=${reply}/" "${SPOOLMAN_DIR}/.env"
-    do_action_service "restart" "Spoolman"
-    break
-  done
-  return 0
-}
-
-function setup_spoolman_folder() {
-  local source_url
-  ### get latest spoolman release url
-  source_url="$(curl -s "${SPOOLMAN_REPO}" | jq -r '.assets[] | select(.name == "spoolman.zip").browser_download_url')"
-
-  mkdir -p "${SPOOLMAN_DIR}"
-  curl -sSL "${source_url}" -o /tmp/temp.zip
-  unzip /tmp/temp.zip -d "${SPOOLMAN_DIR}" &> /dev/null
-  rm /tmp/temp.zip
-
-  chmod +x "${SPOOLMAN_DIR}"/scripts/install.sh
-}
-
-function start_install_script() {
-
-  pushd "${SPOOLMAN_DIR}" &> /dev/null || exit 1
-
-  if bash ./scripts/install.sh; then
-    ok_msg "Spoolman successfully installed!"
-  else
-    print_error "Spoolman installation failed!"
-    exit 1
-  fi
-}
-
-function get_spoolman_status() {
-  local -a files
-  files=(
-      "${SPOOLMAN_DIR}"
-      "${SYSTEMD}/Spoolman.service"
-      "${SPOOLMAN_DB_DIR}"
-    )
-
-  local count
-  count=0
-
-  for file in "${files[@]}"; do
-    [[ -e "${file}" ]] && count=$(( count +1 ))
-  done
-
-  if [[ "${count}" -eq "${#files[*]}" ]]; then
-    echo "Installed"
-  elif [[ "${count}" -gt 0 ]]; then
-    echo "Incomplete!"
-  else
-    echo "Not installed!"
-  fi
-}
-
-function get_local_spoolman_version() {
-  [[ ! -d "${SPOOLMAN_DIR}" ]] && return
-  
-  local version
-  version=$(grep -o '"version":\s*"[^"]*' "${SPOOLMAN_DIR}"/release_info.json | cut -d'"' -f4)
-  echo "${version}"
-}
-
-function get_remote_spoolman_version() {
-  [[ ! -d "${SPOOLMAN_DIR}" ]] && return
-
-  local version
-  version=$(curl -s "${SPOOLMAN_REPO}" | grep -o '"tag_name":\s*"v[^"]*"' | cut -d'"' -f4)
-  echo "${version}"
-}
-
-function compare_spoolman_versions() {
-  local local_ver remote_ver
-  local_ver="$(get_local_spoolman_version)"
-  remote_ver="$(get_remote_spoolman_version)"
-
-  if [[ ${local_ver} != "${remote_ver}" ]]; then
-    versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
-    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    # add spoolman to application_updates_available in kiauh.ini
-    add_to_application_updates "spoolman"
-  else
-    versions="${green}$(printf " %-14s" "${local_ver}")${white}"
-    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-  fi
-
-  echo "${versions}"
-}

scripts/ui/backup_menu.sh

@@ -26,7 +26,6 @@ function backup_ui() {
   echo -e "| Klipper Webinterface:      | Other:                   |"
   echo -e "|  5) [Mainsail]             |  9) [Telegram Bot]       |"
   echo -e "|  6) [Fluidd]               | 10) [OctoEverywhere]     |"
-  echo -e "|                            | 11) [Spoolman]           |"
   back_footer
 }
 
@@ -57,8 +56,6 @@ function backup_menu() {
         do_action "backup_telegram_bot" "backup_ui";;
       10)
         do_action "backup_octoeverywhere" "backup_ui";;
-      11)
-        do_action "backup_spoolman" "backup_ui";;
       B|b)
         clear; main_menu; break;;
       *)

scripts/ui/install_menu.sh

@@ -19,19 +19,19 @@ function install_ui() {
   echo -e "|  all necessary dependencies for the various           |"
   echo -e "|  functions on a completely fresh system.              |"
   hr
-  echo -e "| Firmware & API:          | Other:                     |"
+  echo -e "| Firmware & API:          | 3rd Party Webinterface:    |"
-  echo -e "|  1) [Klipper]            |  7) [PrettyGCode]          |"
+  echo -e "|  1) [Klipper]            |  6) [OctoPrint]            |"
-  echo -e "|  2) [Moonraker]          |  8) [Telegram Bot]         |"
+  echo -e "|  2) [Moonraker]          |                            |"
-  echo -e "|                          |  9) $(obico_install_title) |"
+  echo -e "|                          | Other:                     |"
-  echo -e "| Klipper Webinterface:    | 10) [OctoEverywhere]       |"
+  echo -e "| Klipper Webinterface:    |  7) [PrettyGCode]          |"
-  echo -e "|  3) [Mainsail]           | 11) [Mobileraker]          |"
+  echo -e "|  3) [Mainsail]           |  8) [Telegram Bot]         |"
-  echo -e "|  4) [Fluidd]             | 12) [OctoApp for Klipper]  |"
+  echo -e "|  4) [Fluidd]             |  9) $(obico_install_title) |"
-  echo -e "|                          | 13) [Spoolman]             |"
+  echo -e "|                          | 10) [OctoEverywhere]       |"
-  echo -e "| Touchscreen GUI:         |                            |"
+  echo -e "|                          | 11) [Mobileraker]          |"
-  echo -e "|  5) [KlipperScreen]      | Webcam Streamer:           |"
+  echo -e "| Touchscreen GUI:         | 12) [OctoApp for Klipper]  |"
-  echo -e "|                          | 14) [Crowsnest]            |"
+  echo -e "|  5) [KlipperScreen]      |                            |"
-  echo -e "| 3rd Party Webinterface:  |                            |"
+  echo -e "|                          | Webcam Streamer:           |"
-  echo -e "|  6) [OctoPrint]          |                            |"
+  echo -e "|                          | 13) [Crowsnest]            |"
   back_footer
 }
 
@@ -75,8 +75,6 @@ function install_menu() {
       12)
         do_action "octoapp_setup_dialog" "install_ui";;
       13)
-        do_action "install_spoolman" "install_ui";;
-      14)
         do_action "install_crowsnest" "install_ui";;
       B|b)
         clear; main_menu; break;;

scripts/ui/main_menu.sh

@@ -29,7 +29,6 @@ function main_ui() {
   echo -e "|                  |  OctoEverywhere: $(print_status "octoeverywhere")|"
   echo -e "|                  |     Mobileraker: $(print_status "mobileraker")|"
   echo -e "|                  |         OctoApp: $(print_status "octoapp")|"
-  echo -e "|                  |        Spoolman: $(print_status "spoolman")|"
   echo -e "|                  |                                    |"
   echo -e "|                  |       Octoprint: $(print_status "octoprint")|"
   hr
@@ -40,7 +39,7 @@ function main_ui() {
 function get_kiauh_version() {
   local version
   cd "${KIAUH_SRCDIR}"
-  version="$(git tag -l 'v5*' | tail -1)"
+  version="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
   echo "${version}"
 }
 
@@ -93,6 +92,9 @@ 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/ui/remove_menu.sh

@@ -17,21 +17,21 @@ function remove_ui() {
   hr
   echo -e "| ${yellow}INFO: Configurations and/or any backups will be kept!${white} |"
   hr
-  echo -e "| Firmware & API:           | Webcam Streamer:          |"
+  echo -e "| Firmware & API:           | 3rd Party Webinterface:   |"
-  echo -e "|  1) [Klipper]             |  9) [Crowsnest]           |"
+  echo -e "|  1) [Klipper]             |  8) [OctoPrint]           |"
-  echo -e "|  2) [Moonraker]           | 10) [MJPG-Streamer]       |"
+  echo -e "|  2) [Moonraker]           |                           |"
-  echo -e "|                           |                           |"
+  echo -e "|                           | Webcam Streamer:          |"
-  echo -e "| Klipper Webinterface:     | Other:                    |"
+  echo -e "| Klipper Webinterface:     |  9) [Crowsnest]           |"
-  echo -e "|  3) [Mainsail]            | 11) [PrettyGCode]         |"
+  echo -e "|  3) [Mainsail]            | 10) [MJPG-Streamer]       |"
-  echo -e "|  4) [Mainsail-Config]     | 12) [Telegram Bot]        |"
+  echo -e "|  4) [Mainsail-Config]     |                           |"
-  echo -e "|  5) [Fluidd]              | 13) [Obico for Klipper]   |"
+  echo -e "|  5) [Fluidd]              | Other:                    |"
-  echo -e "|  6) [Fluidd-Config]       | 14) [OctoEverywhere]      |"
+  echo -e "|  6) [Fluidd-Config]       | 11) [PrettyGCode]         |"
+  echo -e "|                           | 12) [Telegram Bot]        |"
+  echo -e "| Touchscreen GUI:          | 13) [Obico for Klipper]   |"
+  echo -e "|  7) [KlipperScreen]       | 14) [OctoEverywhere]      |"
   echo -e "|                           | 15) [Mobileraker]         |"
-  echo -e "| Touchscreen GUI:          | 16) [NGINX]               |"
+  echo -e "|                           | 16) [NGINX]               |"
-  echo -e "|  7) [KlipperScreen]       | 17) [OctoApp]             |"
+  echo -e "|                           | 17) [OctoApp]             |"
-  echo -e "|                           | 18) [Spoolman]            |"
-  echo -e "| 3rd Party Webinterface:   |                           |"
-  echo -e "|  8) [OctoPrint]           |                           |"
   back_footer
 }
 
@@ -76,8 +76,6 @@ function remove_menu() {
         do_action "remove_nginx" "remove_ui";;
       17)
         do_action "remove_octoapp" "remove_ui";;
-      18)
-        do_action "remove_spoolman" "remove_ui";;
       B|b)
         clear; main_menu; break;;
       *)

scripts/ui/update_menu.sh

@@ -36,16 +36,15 @@ function update_ui() {
   echo -e "| 10) [Mobileraker]      |$(compare_mobileraker_versions)|"
   echo -e "| 11) [Crowsnest]        |$(compare_crowsnest_versions)|"
   echo -e "| 12) [OctoApp]          |$(compare_octoapp_versions)|"
-  echo -e "| 13) [Spoolman]         |$(compare_spoolman_versions)|"
   echo -e "|                        |------------------------------|"
-  echo -e "| 14) [System]           |  $(check_system_updates)   |"
+  echo -e "| 13) [System]           |  $(check_system_updates)   |"
   back_footer
 }
 
 function update_menu() {
   clear -x && sudo true && clear -x # (re)cache sudo credentials so password prompt doesn't bork ui
   do_action "" "update_ui"
-
+  
   local action
   while true; do
     read -p "${cyan}####### Perform action:${white} " action
@@ -77,8 +76,6 @@ function update_menu() {
       12)
         do_action "update_octoapp" "update_ui";;
       13)
-        do_action "update_spoolman" "update_ui";;
-      14)
         do_action "upgrade_system_packages" "update_ui";;
       a)
         do_action "update_all" "update_ui";;
@@ -104,7 +101,7 @@ function update_all() {
       print_confirm "Everything is already up-to-date!"
       echo; break
     fi
-
+    
     echo
     top_border
     echo -e "|  The following installations will be updated:         |"
@@ -124,9 +121,6 @@ function update_all() {
     [[ "${update_arr[*]}" =~ "klipperscreen" ]] && \
     echo -e "|  ${cyan}● KlipperScreen${white}                                      |"
 
-    [[ "${update_arr[*]}" =~ "spoolman" ]] && \
-    echo -e "|  ${cyan}● SpoolMan${white}                                      |"
-
     [[ "${update_arr[*]}" =~ "pgc_for_klipper" ]] && \
     echo -e "|  ${cyan}● PrettyGCode for Klipper${white}                            |"
 
@@ -146,7 +140,7 @@ function update_all() {
     echo -e "|  ${cyan}● System${white}                                             |"
 
     bottom_border
-
+    
     local yn
     read -p "${cyan}###### Do you want to proceed? (Y/n):${white} " yn
     case "${yn}" in

scripts/utilities.sh

@@ -28,21 +28,6 @@ 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 ===============#
 #================================================#
@@ -193,10 +178,6 @@ 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}"
 }
@@ -381,9 +362,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
@@ -415,10 +396,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
@@ -427,7 +408,7 @@ function check_system_updates() {
       status="${green}System up to date!       ${white}"
     fi
   fi
-
+  
   echo "${status}"
 }