feat(extensions): implement initial extension feature and first extension

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

.gitignore

@@ -1,3 +1,7 @@
 .vscode
+.idea
+.pytest_cache
+.kiauh-env
 *.code-workspace
-klipper_repos.txt
+*.iml
+kiauh.cfg

kiauh.cfg.example

@@ -0,0 +1,16 @@
+[kiauh]
+backup_before_update: False
+
+[klipper]
+repository_url: https://github.com/Klipper3d/klipper
+branch: master
+method: https
+
+[moonraker]
+repository_url: https://github.com/Arksine/moonraker
+branch: master
+method: https
+
+[mainsail]
+default_port: 80
+unstable_releases: False

kiauh.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from kiauh.main import main
+
+if __name__ == "__main__":
+    main()

kiauh.sh

@@ -12,77 +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
+  local entrypoint
-for script in "${KIAUH_SRCDIR}/scripts/ui/"*.sh; do . "${script}"; done
 
-#===================================================#
+  if command -v python3 &>/dev/null; then
-#=================== UPDATE KIAUH ==================#
+    python_command="python3"
-#===================================================#
+  elif command -v python &>/dev/null; then
-
+    python_command="python"
-function update_kiauh() {
+  else
-  status_msg "Updating KIAUH ..."
+    echo "Python is not installed. Please install Python and try again."
-
+    exit 1
-  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
+
+  entrypoint=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
+
+  ${python_command} "${entrypoint}/kiauh.py"
 }
 
-function kiauh_update_dialog() {
+main
-  [[ ! $(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
+#### sourcing all additional scripts
-  read -p "${cyan}###### Do you want to update now? (Y/n):${white} " yn
+#KIAUH_SRCDIR="$(dirname -- "$(readlink -f "${BASH_SOURCE[0]}")")"
-  while true; do
+#for script in "${KIAUH_SRCDIR}/scripts/"*.sh; do . "${script}"; done
-    case "${yn}" in
+#for script in "${KIAUH_SRCDIR}/scripts/ui/"*.sh; do . "${script}"; done
-      Y|y|Yes|yes|"")
+#
-        do_action "update_kiauh"
+##===================================================#
-        break;;
+##=================== UPDATE KIAUH ==================#
-      N|n|No|no)
+##===================================================#
-        break;;
+#
-      *)
+#function update_kiauh() {
-        deny_action "kiauh_update_dialog";;
+#  status_msg "Updating KIAUH ..."
-    esac
+#
-  done
+#  cd "${KIAUH_SRCDIR}"
-}
+#  git reset --hard && git pull
-
+#
-check_euid
+#  ok_msg "Update complete! Please restart KIAUH."
-init_logfile
+#  exit 0
-set_globals
+#}
-kiauh_update_dialog
+#
-main_menu
+##===================================================#
+##=================== 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/__init__.py

@@ -0,0 +1,16 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+
+APPLICATION_ROOT = Path(__file__).resolve().parent.parent
+KIAUH_CFG = APPLICATION_ROOT.joinpath("kiauh.cfg")
+KIAUH_BACKUP_DIR = Path.home().joinpath("kiauh-backups")

kiauh/components/klipper/__init__.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+
+MODULE_PATH = Path(__file__).resolve().parent
+
+KLIPPER_DIR = Path.home().joinpath("klipper")
+KLIPPER_ENV_DIR = Path.home().joinpath("klippy-env")
+KLIPPER_REQUIREMENTS_TXT = KLIPPER_DIR.joinpath("scripts/klippy-requirements.txt")
+DEFAULT_KLIPPER_REPO_URL = "https://github.com/Klipper3D/klipper"
+
+EXIT_KLIPPER_SETUP = "Exiting Klipper setup ..."

kiauh/components/klipper/assets/klipper.env

@@ -0,0 +1 @@
+KLIPPER_ARGS="%KLIPPER_DIR%/klippy/klippy.py %CFG% -I %SERIAL% -l %LOG% -a %UDS%"

kiauh/components/klipper/assets/klipper.service

@@ -0,0 +1,18 @@
+[Unit]
+Description=Klipper 3D Printer Firmware SV1
+Documentation=https://www.klipper3d.org/
+After=network-online.target
+Wants=udev.target
+
+[Install]
+WantedBy=multi-user.target
+
+[Service]
+Type=simple
+User=%USER%
+RemainAfterExit=yes
+WorkingDirectory=%KLIPPER_DIR%
+EnvironmentFile=%ENV_FILE%
+ExecStart=%ENV%/bin/python $KLIPPER_ARGS
+Restart=always
+RestartSec=10

kiauh/components/klipper/assets/printer.cfg

@@ -0,0 +1,11 @@
+[mcu]
+serial: /dev/serial/by-id/<your-mcu-id>
+
+[virtual_sdcard]
+path: %GCODES_DIR%
+on_error_gcode: CANCEL_PRINT
+
+[printer]
+kinematics: none
+max_velocity: 1000
+max_accel: 1000

kiauh/components/klipper/klipper.py

@@ -0,0 +1,154 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import subprocess
+from pathlib import Path
+from typing import List
+
+from kiauh.core.instance_manager.base_instance import BaseInstance
+from kiauh.components.klipper import KLIPPER_DIR, KLIPPER_ENV_DIR, MODULE_PATH
+from kiauh.utils.constants import SYSTEMD
+from kiauh.utils.logger import Logger
+
+
+# noinspection PyMethodMayBeStatic
+class Klipper(BaseInstance):
+    @classmethod
+    def blacklist(cls) -> List[str]:
+        return ["None", "mcu"]
+
+    def __init__(self, suffix: str = ""):
+        super().__init__(instance_type=self, suffix=suffix)
+        self.klipper_dir: Path = KLIPPER_DIR
+        self.env_dir: Path = KLIPPER_ENV_DIR
+        self._cfg_file = self.cfg_dir.joinpath("printer.cfg")
+        self._log = self.log_dir.joinpath("klippy.log")
+        self._serial = self.comms_dir.joinpath("klippy.serial")
+        self._uds = self.comms_dir.joinpath("klippy.sock")
+
+    @property
+    def cfg_file(self) -> Path:
+        return self._cfg_file
+
+    @property
+    def log(self) -> Path:
+        return self._log
+
+    @property
+    def serial(self) -> Path:
+        return self._serial
+
+    @property
+    def uds(self) -> Path:
+        return self._uds
+
+    def create(self) -> None:
+        Logger.print_status("Creating new Klipper Instance ...")
+        service_template_path = MODULE_PATH.joinpath("assets/klipper.service")
+        service_file_name = self.get_service_file_name(extension=True)
+        service_file_target = SYSTEMD.joinpath(service_file_name)
+        env_template_file_path = MODULE_PATH.joinpath("assets/klipper.env")
+        env_file_target = self.sysd_dir.joinpath("klipper.env")
+
+        try:
+            self.create_folders()
+            self.write_service_file(
+                service_template_path, service_file_target, env_file_target
+            )
+            self.write_env_file(env_template_file_path, env_file_target)
+
+        except subprocess.CalledProcessError as e:
+            Logger.print_error(
+                f"Error creating service file {service_file_target}: {e}"
+            )
+            raise
+        except OSError as e:
+            Logger.print_error(f"Error creating env file {env_file_target}: {e}")
+            raise
+
+    def delete(self) -> None:
+        service_file = self.get_service_file_name(extension=True)
+        service_file_path = self.get_service_file_path()
+
+        Logger.print_status(f"Deleting Klipper Instance: {service_file}")
+
+        try:
+            command = ["sudo", "rm", "-f", service_file_path]
+            subprocess.run(command, check=True)
+            Logger.print_ok(f"Service file deleted: {service_file_path}")
+        except subprocess.CalledProcessError as e:
+            Logger.print_error(f"Error deleting service file: {e}")
+            raise
+
+    def write_service_file(
+        self,
+        service_template_path: Path,
+        service_file_target: Path,
+        env_file_target: Path,
+    ) -> None:
+        service_content = self._prep_service_file(
+            service_template_path, env_file_target
+        )
+        command = ["sudo", "tee", service_file_target]
+        subprocess.run(
+            command,
+            input=service_content.encode(),
+            stdout=subprocess.DEVNULL,
+            check=True,
+        )
+        Logger.print_ok(f"Service file created: {service_file_target}")
+
+    def write_env_file(
+        self, env_template_file_path: Path, env_file_target: Path
+    ) -> None:
+        env_file_content = self._prep_env_file(env_template_file_path)
+        with open(env_file_target, "w") as env_file:
+            env_file.write(env_file_content)
+        Logger.print_ok(f"Env file created: {env_file_target}")
+
+    def _prep_service_file(
+        self, service_template_path: Path, env_file_path: Path
+    ) -> str:
+        try:
+            with open(service_template_path, "r") as template_file:
+                template_content = template_file.read()
+        except FileNotFoundError:
+            Logger.print_error(
+                f"Unable to open {service_template_path} - File not found"
+            )
+            raise
+        service_content = template_content.replace("%USER%", self.user)
+        service_content = service_content.replace(
+            "%KLIPPER_DIR%", str(self.klipper_dir)
+        )
+        service_content = service_content.replace("%ENV%", str(self.env_dir))
+        service_content = service_content.replace("%ENV_FILE%", str(env_file_path))
+        return service_content
+
+    def _prep_env_file(self, env_template_file_path: Path) -> str:
+        try:
+            with open(env_template_file_path, "r") as env_file:
+                env_template_file_content = env_file.read()
+        except FileNotFoundError:
+            Logger.print_error(
+                f"Unable to open {env_template_file_path} - File not found"
+            )
+            raise
+        env_file_content = env_template_file_content.replace(
+            "%KLIPPER_DIR%", str(self.klipper_dir)
+        )
+        env_file_content = env_file_content.replace(
+            "%CFG%", f"{self.cfg_dir}/printer.cfg"
+        )
+        env_file_content = env_file_content.replace("%SERIAL%", str(self.serial))
+        env_file_content = env_file_content.replace("%LOG%", str(self.log))
+        env_file_content = env_file_content.replace("%UDS%", str(self.uds))
+        return env_file_content

kiauh/components/klipper/klipper_dialogs.py

@@ -0,0 +1,136 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import textwrap
+from typing import List
+
+from kiauh.core.instance_manager.base_instance import BaseInstance
+from kiauh.core.menus.base_menu import print_back_footer
+from kiauh.utils.constants import COLOR_GREEN, RESET_FORMAT, COLOR_YELLOW, COLOR_CYAN
+
+
+def print_instance_overview(
+    instances: List[BaseInstance], show_index=False, show_select_all=False
+):
+    headline = f"{COLOR_GREEN}The following Klipper instances were found:{RESET_FORMAT}"
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        |{headline:^64}|
+        |-------------------------------------------------------|
+        """
+    )[1:]
+
+    if show_select_all:
+        select_all = f"{COLOR_YELLOW}a) Select all{RESET_FORMAT}"
+        dialog += f"| {select_all:<63}|\n"
+        dialog += "|                                                       |\n"
+
+    for i, s in enumerate(instances):
+        line = f"{COLOR_CYAN}{f'{i})' if show_index else '●'} {s.get_service_file_name()}{RESET_FORMAT}"
+        dialog += f"| {line:<63}|\n"
+
+    print(dialog, end="")
+    print_back_footer()
+
+
+def print_select_instance_count_dialog():
+    line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
+    line2 = f"{COLOR_YELLOW}Setting up too many instances may crash your system.{RESET_FORMAT}"
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        | Please select the number of Klipper instances to set  |
+        | up. The number of Klipper instances will determine    |
+        | the amount of printers you can run from this host.    |
+        |                                                       |
+        | {line1:<63}|
+        | {line2:<63}|
+        """
+    )[1:]
+
+    print(dialog, end="")
+    print_back_footer()
+
+
+def print_select_custom_name_dialog():
+    line1 = f"{COLOR_YELLOW}INFO:{RESET_FORMAT}"
+    line2 = f"{COLOR_YELLOW}Only alphanumeric characters are allowed!{RESET_FORMAT}"
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        | You can now assign a custom name to each instance.    |
+        | If skipped, each instance will get an index assigned  |
+        | in ascending order, starting at index '1'.            |
+        |                                                       |
+        | {line1:<63}|
+        | {line2:<63}|
+        """
+    )[1:]
+
+    print(dialog, end="")
+    print_back_footer()
+
+
+def print_missing_usergroup_dialog(missing_groups) -> None:
+    line1 = f"{COLOR_YELLOW}WARNING: Your current user is not in group:{RESET_FORMAT}"
+    line2 = f"{COLOR_CYAN}● tty{RESET_FORMAT}"
+    line3 = f"{COLOR_CYAN}● dialout{RESET_FORMAT}"
+    line4 = f"{COLOR_YELLOW}INFO:{RESET_FORMAT}"
+    line5 = f"{COLOR_YELLOW}Relog required for group assignments to take effect!{RESET_FORMAT}"
+
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        | {line1:<63}|
+        """
+    )[1:]
+
+    if "tty" in missing_groups:
+        dialog += f"| {line2:<63}|\n"
+    if "dialout" in missing_groups:
+        dialog += f"| {line3:<63}|\n"
+
+    dialog += textwrap.dedent(
+        f"""
+        |                                                       |
+        | It is possible that you won't be able to successfully |
+        | connect and/or flash the controller board without     |
+        | your user being a member of that group.               |
+        | If you want to add the current user to the group(s)   |
+        | listed above, answer with 'Y'. Else skip with 'n'.    |
+        |                                                       |
+        | {line4:<63}|
+        | {line5:<63}|
+        \\=======================================================/
+        """
+    )[1:]
+
+    print(dialog, end="")
+
+
+def print_update_warn_dialog() -> None:
+    line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
+    line2 = f"{COLOR_YELLOW}Do NOT continue if there are ongoing prints running!{RESET_FORMAT}"
+    line3 = f"{COLOR_YELLOW}All Klipper instances will be restarted during the {RESET_FORMAT}"
+    line4 = f"{COLOR_YELLOW}update process and ongoing prints WILL FAIL.{RESET_FORMAT}"
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        | {line1:<63}|
+        | {line2:<63}|
+        | {line3:<63}|
+        | {line4:<63}|
+        \\=======================================================/
+        """
+    )[1:]
+
+    print(dialog, end="")

kiauh/components/klipper/klipper_remove.py

@@ -0,0 +1,132 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import shutil
+from typing import List, Union
+
+from kiauh.core.instance_manager.instance_manager import InstanceManager
+from kiauh.components.klipper import KLIPPER_DIR, KLIPPER_ENV_DIR
+from kiauh.components.klipper.klipper import Klipper
+from kiauh.components.klipper.klipper_dialogs import print_instance_overview
+from kiauh.utils.filesystem_utils import remove_file
+from kiauh.utils.input_utils import get_selection_input
+from kiauh.utils.logger import Logger
+
+
+def run_klipper_removal(
+    remove_service: bool,
+    remove_dir: bool,
+    remove_env: bool,
+    delete_logs: bool,
+) -> None:
+    im = InstanceManager(Klipper)
+
+    if remove_service:
+        Logger.print_status("Removing Klipper instances ...")
+        if im.instances:
+            instances_to_remove = select_instances_to_remove(im.instances)
+            remove_instances(im, instances_to_remove)
+        else:
+            Logger.print_info("No Klipper Services installed! Skipped ...")
+
+    if (remove_dir or remove_env) and im.instances:
+        Logger.print_warn("There are still other Klipper services installed!")
+        Logger.print_warn("Therefor the following parts cannot be removed:")
+        Logger.print_warn(
+            """
+            ● Klipper local repository
+            ● Klipper Python environment
+            """,
+            False,
+        )
+    else:
+        if remove_dir:
+            Logger.print_status("Removing Klipper local repository ...")
+            remove_klipper_dir()
+        if remove_env:
+            Logger.print_status("Removing Klipper Python environment ...")
+            remove_klipper_env()
+
+    # delete klipper logs of all instances
+    if delete_logs:
+        Logger.print_status("Removing all Klipper logs ...")
+        delete_klipper_logs(im.instances)
+
+
+def select_instances_to_remove(
+    instances: List[Klipper],
+) -> Union[List[Klipper], None]:
+    print_instance_overview(instances, True, True)
+
+    options = [str(i) for i in range(len(instances))]
+    options.extend(["a", "A", "b", "B"])
+
+    selection = get_selection_input("Select Klipper instance to remove", options)
+
+    instances_to_remove = []
+    if selection == "b".lower():
+        return None
+    elif selection == "a".lower():
+        instances_to_remove.extend(instances)
+    else:
+        instance = instances[int(selection)]
+        instances_to_remove.append(instance)
+
+    return instances_to_remove
+
+
+def remove_instances(
+    instance_manager: InstanceManager,
+    instance_list: List[Klipper],
+) -> None:
+    for instance in instance_list:
+        Logger.print_status(f"Removing instance {instance.get_service_file_name()} ...")
+        instance_manager.current_instance = instance
+        instance_manager.stop_instance()
+        instance_manager.disable_instance()
+        instance_manager.delete_instance()
+
+    instance_manager.reload_daemon()
+
+
+def remove_klipper_dir() -> None:
+    if not KLIPPER_DIR.exists():
+        Logger.print_info(f"'{KLIPPER_DIR}' does not exist. Skipped ...")
+        return
+
+    try:
+        shutil.rmtree(KLIPPER_DIR)
+    except OSError as e:
+        Logger.print_error(f"Unable to delete '{KLIPPER_DIR}':\n{e}")
+
+
+def remove_klipper_env() -> None:
+    if not KLIPPER_ENV_DIR.exists():
+        Logger.print_info(f"'{KLIPPER_ENV_DIR}' does not exist. Skipped ...")
+        return
+
+    try:
+        shutil.rmtree(KLIPPER_ENV_DIR)
+    except OSError as e:
+        Logger.print_error(f"Unable to delete '{KLIPPER_ENV_DIR}':\n{e}")
+
+
+def delete_klipper_logs(instances: List[Klipper]) -> None:
+    all_logfiles = []
+    for instance in instances:
+        all_logfiles = list(instance.log_dir.glob("klippy.log*"))
+    if not all_logfiles:
+        Logger.print_info("No Klipper logs found. Skipped ...")
+        return
+
+    for log in all_logfiles:
+        Logger.print_status(f"Remove '{log}'")
+        remove_file(log)

kiauh/components/klipper/klipper_setup.py

@@ -0,0 +1,185 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+
+from kiauh import KIAUH_CFG
+from kiauh.core.backup_manager.backup_manager import BackupManager
+from kiauh.core.config_manager.config_manager import ConfigManager
+from kiauh.core.instance_manager.instance_manager import InstanceManager
+from kiauh.components.klipper import (
+    EXIT_KLIPPER_SETUP,
+    DEFAULT_KLIPPER_REPO_URL,
+    KLIPPER_DIR,
+    KLIPPER_ENV_DIR,
+    KLIPPER_REQUIREMENTS_TXT,
+)
+from kiauh.components.klipper.klipper import Klipper
+from kiauh.components.klipper.klipper_dialogs import print_update_warn_dialog
+from kiauh.components.klipper.klipper_utils import (
+    handle_disruptive_system_packages,
+    check_user_groups,
+    handle_to_multi_instance_conversion,
+    create_example_printer_cfg,
+    add_to_existing,
+    get_install_count,
+    init_name_scheme,
+    check_is_single_to_multi_conversion,
+    update_name_scheme,
+    handle_instance_naming,
+)
+from kiauh.core.repo_manager.repo_manager import RepoManager
+from kiauh.components.moonraker.moonraker import Moonraker
+from kiauh.utils.input_utils import get_confirm
+from kiauh.utils.logger import Logger
+from kiauh.utils.system_utils import (
+    parse_packages_from_file,
+    create_python_venv,
+    install_python_requirements,
+    update_system_package_lists,
+    install_system_packages,
+)
+
+
+def install_klipper() -> None:
+    kl_im = InstanceManager(Klipper)
+
+    # ask to add new instances, if there are existing ones
+    if kl_im.instances and not add_to_existing():
+        Logger.print_status(EXIT_KLIPPER_SETUP)
+        return
+
+    install_count = get_install_count()
+    if install_count is None:
+        Logger.print_status(EXIT_KLIPPER_SETUP)
+        return
+
+    # create a dict of the size of the existing instances + install count
+    name_dict = {c: "" for c in range(len(kl_im.instances) + install_count)}
+    name_scheme = init_name_scheme(kl_im.instances, install_count)
+    mr_im = InstanceManager(Moonraker)
+    name_scheme = update_name_scheme(
+        name_scheme, name_dict, kl_im.instances, mr_im.instances
+    )
+
+    handle_instance_naming(name_dict, name_scheme)
+
+    create_example_cfg = get_confirm("Create example printer.cfg?")
+
+    try:
+        if not kl_im.instances:
+            setup_klipper_prerequesites()
+
+        count = 0
+        for name in name_dict:
+            if name_dict[name] in [n.suffix for n in kl_im.instances]:
+                continue
+
+            if check_is_single_to_multi_conversion(kl_im.instances):
+                handle_to_multi_instance_conversion(name_dict[name])
+                continue
+
+            count += 1
+            create_klipper_instance(name_dict[name], create_example_cfg)
+
+            if count == install_count:
+                break
+
+        kl_im.reload_daemon()
+
+    except Exception:
+        Logger.print_error("Klipper installation failed!")
+        return
+
+    # step 4: check/handle conflicting packages/services
+    handle_disruptive_system_packages()
+
+    # step 5: check for required group membership
+    check_user_groups()
+
+
+def setup_klipper_prerequesites() -> None:
+    cm = ConfigManager(cfg_file=KIAUH_CFG)
+    repo = str(cm.get_value("klipper", "repository_url") or DEFAULT_KLIPPER_REPO_URL)
+    branch = str(cm.get_value("klipper", "branch") or "master")
+
+    repo_manager = RepoManager(
+        repo=repo,
+        branch=branch,
+        target_dir=KLIPPER_DIR,
+    )
+    repo_manager.clone_repo()
+
+    # install klipper dependencies and create python virtualenv
+    try:
+        install_klipper_packages(KLIPPER_DIR)
+        create_python_venv(KLIPPER_ENV_DIR)
+        install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQUIREMENTS_TXT)
+    except Exception:
+        Logger.print_error("Error during installation of Klipper requirements!")
+        raise
+
+
+def install_klipper_packages(klipper_dir: Path) -> None:
+    script = klipper_dir.joinpath("scripts/install-debian.sh")
+    packages = parse_packages_from_file(script)
+    packages = [pkg.replace("python-dev", "python3-dev") for pkg in packages]
+    # Add dfu-util for octopi-images
+    packages.append("dfu-util")
+    # Add dbus requirement for DietPi distro
+    if Path("/boot/dietpi/.version").exists():
+        packages.append("dbus")
+
+    update_system_package_lists(silent=False)
+    install_system_packages(packages)
+
+
+def update_klipper() -> None:
+    print_update_warn_dialog()
+    if not get_confirm("Update Klipper now?"):
+        return
+
+    cm = ConfigManager(cfg_file=KIAUH_CFG)
+    if cm.get_value("kiauh", "backup_before_update"):
+        bm = BackupManager()
+        bm.backup_directory("klipper", KLIPPER_DIR)
+        bm.backup_directory("klippy-env", KLIPPER_ENV_DIR)
+
+    instance_manager = InstanceManager(Klipper)
+    instance_manager.stop_all_instance()
+
+    repo = str(cm.get_value("klipper", "repository_url") or DEFAULT_KLIPPER_REPO_URL)
+    branch = str(cm.get_value("klipper", "branch") or "master")
+
+    repo_manager = RepoManager(
+        repo=repo,
+        branch=branch,
+        target_dir=KLIPPER_DIR,
+    )
+    repo_manager.pull_repo()
+
+    # install possible new system packages
+    install_klipper_packages(KLIPPER_DIR)
+    # install possible new python dependencies
+    install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQUIREMENTS_TXT)
+
+    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:
+        create_example_printer_cfg(new_instance)
+    kl_im.start_instance()

kiauh/components/klipper/klipper_utils.py

@@ -0,0 +1,278 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import os
+import re
+import grp
+import shutil
+import subprocess
+import textwrap
+from pathlib import Path
+
+from typing import List, Union, Literal, Dict
+
+from kiauh.core.config_manager.config_manager import ConfigManager
+from kiauh.core.instance_manager.base_instance import BaseInstance
+from kiauh.core.instance_manager.instance_manager import InstanceManager
+from kiauh.core.instance_manager.name_scheme import NameScheme
+from kiauh.core.repo_manager.repo_manager import RepoManager
+from kiauh.components.klipper import MODULE_PATH, KLIPPER_DIR, KLIPPER_ENV_DIR
+from kiauh.components.klipper.klipper import Klipper
+from kiauh.components.klipper.klipper_dialogs import (
+    print_missing_usergroup_dialog,
+    print_instance_overview,
+    print_select_instance_count_dialog,
+    print_select_custom_name_dialog,
+)
+from kiauh.components.moonraker.moonraker import Moonraker
+from kiauh.components.moonraker.moonraker_utils import moonraker_to_multi_conversion
+from kiauh.utils.common import get_install_status_common
+from kiauh.utils.constants import CURRENT_USER
+from kiauh.utils.input_utils import get_confirm, get_string_input, get_number_input
+from kiauh.utils.logger import Logger
+from kiauh.utils.system_utils import mask_system_service
+
+
+def get_klipper_status() -> (
+    Dict[
+        Literal["status", "status_code", "instances", "repo", "local", "remote"],
+        Union[str, int],
+    ]
+):
+    status = get_install_status_common(Klipper, KLIPPER_DIR, KLIPPER_ENV_DIR)
+    return {
+        "status": status.get("status"),
+        "status_code": status.get("status_code"),
+        "instances": status.get("instances"),
+        "repo": RepoManager.get_repo_name(KLIPPER_DIR),
+        "local": RepoManager.get_local_commit(KLIPPER_DIR),
+        "remote": RepoManager.get_remote_commit(KLIPPER_DIR),
+    }
+
+
+def check_is_multi_install(
+    existing_instances: List[Klipper], install_count: int
+) -> bool:
+    return not existing_instances and install_count > 1
+
+
+def check_is_single_to_multi_conversion(existing_instances: List[Klipper]) -> bool:
+    return len(existing_instances) == 1 and existing_instances[0].suffix == ""
+
+
+def init_name_scheme(
+    existing_instances: List[Klipper], install_count: int
+) -> NameScheme:
+    if check_is_multi_install(
+        existing_instances, install_count
+    ) or check_is_single_to_multi_conversion(existing_instances):
+        print_select_custom_name_dialog()
+        if get_confirm("Assign custom names?", False, allow_go_back=True):
+            return NameScheme.CUSTOM
+        else:
+            return NameScheme.INDEX
+    else:
+        return NameScheme.SINGLE
+
+
+def update_name_scheme(
+    name_scheme: NameScheme,
+    name_dict: Dict[int, str],
+    klipper_instances: List[Klipper],
+    moonraker_instances: List[Moonraker],
+) -> NameScheme:
+    # if there are more moonraker instances installed than klipper, we
+    # load their names into the name_dict, as we will detect and enforce that naming scheme
+    if len(moonraker_instances) > len(klipper_instances):
+        update_name_dict(name_dict, moonraker_instances)
+        return detect_name_scheme(moonraker_instances)
+    elif len(klipper_instances) > 1:
+        update_name_dict(name_dict, klipper_instances)
+        return detect_name_scheme(klipper_instances)
+    else:
+        return name_scheme
+
+
+def update_name_dict(name_dict: Dict[int, str], instances: List[BaseInstance]) -> None:
+    for k, v in enumerate(instances):
+        name_dict[k] = v.suffix
+
+
+def handle_instance_naming(name_dict: Dict[int, str], name_scheme: NameScheme) -> None:
+    if name_scheme == NameScheme.SINGLE:
+        return
+
+    for k in name_dict:
+        if name_dict[k] == "" and name_scheme == NameScheme.INDEX:
+            name_dict[k] = str(k + 1)
+        elif name_dict[k] == "" and name_scheme == NameScheme.CUSTOM:
+            assign_custom_name(k, name_dict)
+
+
+def add_to_existing() -> bool:
+    kl_instances = InstanceManager(Klipper).instances
+    print_instance_overview(kl_instances)
+    return get_confirm("Add new instances?", allow_go_back=True)
+
+
+def get_install_count() -> Union[int, None]:
+    """
+    Print a dialog for selecting the amount of Klipper instances
+    to set up with an option to navigate back. Returns None if the
+    user selected to go back, otherwise an integer greater or equal than 1 |
+    :return: Integer >= 1 or None
+    """
+    kl_instances = InstanceManager(Klipper).instances
+    print_select_instance_count_dialog()
+    question = f"Number of{' additional' if len(kl_instances) > 0 else ''} Klipper instances to set up"
+    return get_number_input(question, 1, default=1, allow_go_back=True)
+
+
+def assign_custom_name(key: int, name_dict: Dict[int, str]) -> None:
+    existing_names = []
+    existing_names.extend(Klipper.blacklist())
+    existing_names.extend(name_dict[n] for n in name_dict)
+    question = f"Enter name for instance {key + 1}"
+    name_dict[key] = get_string_input(question, exclude=existing_names)
+
+
+def handle_to_multi_instance_conversion(new_name: str) -> None:
+    Logger.print_status("Converting single instance to multi instances ...")
+    klipper_to_multi_conversion(new_name)
+    moonraker_to_multi_conversion(new_name)
+
+
+def klipper_to_multi_conversion(new_name: str) -> None:
+    Logger.print_status("Convert Klipper single to multi instance ...")
+    im = InstanceManager(Klipper)
+    im.current_instance = im.instances[0]
+    # temporarily store the data dir path
+    old_data_dir = im.instances[0].data_dir
+    # remove the old single instance
+    im.stop_instance()
+    im.disable_instance()
+    im.delete_instance()
+    # create a new klipper instance with the new name
+    im.current_instance = Klipper(suffix=new_name)
+    new_data_dir: Path = im.current_instance.data_dir
+
+    # rename the old data dir and use it for the new instance
+    Logger.print_status(f"Rename '{old_data_dir}' to '{new_data_dir}' ...")
+    if not new_data_dir.is_dir():
+        old_data_dir.rename(new_data_dir)
+    else:
+        Logger.print_info(f"'{new_data_dir}' already exist. Skipped ...")
+
+    im.create_instance()
+    im.enable_instance()
+    im.start_instance()
+
+
+def check_user_groups():
+    current_groups = [grp.getgrgid(gid).gr_name for gid in os.getgroups()]
+
+    missing_groups = []
+    if "tty" not in current_groups:
+        missing_groups.append("tty")
+    if "dialout" not in current_groups:
+        missing_groups.append("dialout")
+
+    if not missing_groups:
+        return
+
+    print_missing_usergroup_dialog(missing_groups)
+    if not get_confirm(f"Add user '{CURRENT_USER}' to group(s) now?"):
+        log = "Skipped adding user to required groups. You might encounter issues."
+        Logger.warn(log)
+        return
+
+    try:
+        for group in missing_groups:
+            Logger.print_status(f"Adding user '{CURRENT_USER}' to group {group} ...")
+            command = ["sudo", "usermod", "-a", "-G", group, CURRENT_USER]
+            subprocess.run(command, check=True)
+            Logger.print_ok(f"Group {group} assigned to user '{CURRENT_USER}'.")
+    except subprocess.CalledProcessError as e:
+        Logger.print_error(f"Unable to add user to usergroups: {e}")
+        raise
+
+    log = "Remember to relog/restart this machine for the group(s) to be applied!"
+    Logger.print_warn(log)
+
+
+def handle_disruptive_system_packages() -> None:
+    services = []
+
+    command = ["systemctl", "is-enabled", "brltty"]
+    brltty_status = subprocess.run(command, capture_output=True, text=True)
+
+    command = ["systemctl", "is-enabled", "brltty-udev"]
+    brltty_udev_status = subprocess.run(command, capture_output=True, text=True)
+
+    command = ["systemctl", "is-enabled", "ModemManager"]
+    modem_manager_status = subprocess.run(command, capture_output=True, text=True)
+
+    if "enabled" in brltty_status.stdout:
+        services.append("brltty")
+    if "enabled" in brltty_udev_status.stdout:
+        services.append("brltty-udev")
+    if "enabled" in modem_manager_status.stdout:
+        services.append("ModemManager")
+
+    for service in services if services else []:
+        try:
+            log = f"{service} service detected! Masking {service} service ..."
+            Logger.print_status(log)
+            mask_system_service(service)
+            Logger.print_ok(f"{service} service masked!")
+        except subprocess.CalledProcessError:
+            warn_msg = textwrap.dedent(
+                f"""
+                KIAUH was unable to mask the {service} system service. 
+                Please fix the problem manually. Otherwise, this may have 
+                undesirable effects on the operation of Klipper.
+                """
+            )[1:]
+            Logger.print_warn(warn_msg)
+
+
+def detect_name_scheme(instance_list: List[BaseInstance]) -> NameScheme:
+    pattern = re.compile("^\d+$")
+    for instance in instance_list:
+        if not pattern.match(instance.suffix):
+            return NameScheme.CUSTOM
+
+    return NameScheme.INDEX
+
+
+def get_highest_index(instance_list: List[Klipper]) -> int:
+    indices = [int(instance.suffix.split("-")[-1]) for instance in instance_list]
+    return max(indices)
+
+
+def create_example_printer_cfg(instance: Klipper) -> None:
+    Logger.print_status(f"Creating example printer.cfg in '{instance.cfg_dir}'")
+    if instance.cfg_file.is_file():
+        Logger.print_info(f"'{instance.cfg_file}' already exists.")
+        return
+
+    source = MODULE_PATH.joinpath("assets/printer.cfg")
+    target = instance.cfg_file
+    try:
+        shutil.copy(source, target)
+    except OSError as e:
+        Logger.print_error(f"Unable to create example printer.cfg:\n{e}")
+        return
+
+    cm = ConfigManager(target)
+    cm.set_value("virtual_sdcard", "path", str(instance.gcodes_dir))
+    cm.write_config()
+    Logger.print_ok(f"Example printer.cfg created in '{instance.cfg_dir}'")

kiauh/components/klipper/menus/klipper_remove_menu.py

@@ -0,0 +1,109 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import textwrap
+
+from kiauh.core.menus import BACK_HELP_FOOTER
+from kiauh.core.menus.base_menu import BaseMenu
+from kiauh.components.klipper import klipper_remove
+from kiauh.utils.constants import RESET_FORMAT, COLOR_RED, COLOR_CYAN
+
+
+# noinspection PyUnusedLocal
+class KlipperRemoveMenu(BaseMenu):
+    def __init__(self):
+        super().__init__(
+            header=False,
+            options={
+                "0": self.toggle_all,
+                "1": self.toggle_remove_klipper_service,
+                "2": self.toggle_remove_klipper_dir,
+                "3": self.toggle_remove_klipper_env,
+                "4": self.toggle_delete_klipper_logs,
+                "5": self.run_removal_process,
+            },
+            footer_type=BACK_HELP_FOOTER,
+        )
+        self.remove_klipper_service = False
+        self.remove_klipper_dir = False
+        self.remove_klipper_env = False
+        self.delete_klipper_logs = False
+
+    def print_menu(self) -> None:
+        header = " [ Remove Klipper ] "
+        color = COLOR_RED
+        count = 62 - len(color) - len(RESET_FORMAT)
+        checked = f"[{COLOR_CYAN}x{RESET_FORMAT}]"
+        unchecked = "[ ]"
+        o1 = checked if self.remove_klipper_service else unchecked
+        o2 = checked if self.remove_klipper_dir else unchecked
+        o3 = checked if self.remove_klipper_env else unchecked
+        o4 = checked if self.delete_klipper_logs else unchecked
+        menu = textwrap.dedent(
+            f"""
+            /=======================================================\\
+            | {color}{header:~^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            | Enter a number and hit enter to select / deselect     |
+            | the specific option for removal.                      |
+            |-------------------------------------------------------|
+            |  0) Select everything                                 |
+            |-------------------------------------------------------|
+            |  1) {o1} Remove Service                                |
+            |  2) {o2} Remove Local Repository                       |
+            |  3) {o3} Remove Python Environment                     |
+            |  4) {o4} Delete all Log-Files                          |
+            |-------------------------------------------------------|
+            |  5) Continue                                          |
+            """
+        )[1:]
+        print(menu, end="")
+
+    def toggle_all(self, **kwargs) -> None:
+        self.remove_klipper_service = True
+        self.remove_klipper_dir = True
+        self.remove_klipper_env = True
+        self.delete_klipper_logs = True
+
+    def toggle_remove_klipper_service(self, **kwargs) -> None:
+        self.remove_klipper_service = not self.remove_klipper_service
+
+    def toggle_remove_klipper_dir(self, **kwargs) -> None:
+        self.remove_klipper_dir = not self.remove_klipper_dir
+
+    def toggle_remove_klipper_env(self, **kwargs) -> None:
+        self.remove_klipper_env = not self.remove_klipper_env
+
+    def toggle_delete_klipper_logs(self, **kwargs) -> None:
+        self.delete_klipper_logs = not self.delete_klipper_logs
+
+    def run_removal_process(self, **kwargs) -> None:
+        if (
+            not self.remove_klipper_service
+            and not self.remove_klipper_dir
+            and not self.remove_klipper_env
+            and not self.delete_klipper_logs
+        ):
+            error = f"{COLOR_RED}Nothing selected! Select options to remove first.{RESET_FORMAT}"
+            print(error)
+            return
+
+        klipper_remove.run_klipper_removal(
+            self.remove_klipper_service,
+            self.remove_klipper_dir,
+            self.remove_klipper_env,
+            self.delete_klipper_logs,
+        )
+
+        self.remove_klipper_service = False
+        self.remove_klipper_dir = False
+        self.remove_klipper_env = False
+        self.delete_klipper_logs = False

kiauh/components/log_uploads/__init__.py

@@ -0,0 +1,16 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+from typing import Dict, Union, Literal
+
+FileKey = Literal["filepath", "display_name"]
+LogFile = Dict[FileKey, Union[str, Path]]

kiauh/components/log_uploads/log_upload_utils.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from typing import List
+from pathlib import Path
+
+import urllib.request
+
+from kiauh.core.instance_manager.instance_manager import InstanceManager
+from kiauh.components.klipper.klipper import Klipper
+from kiauh.components.log_uploads import LogFile
+from kiauh.utils.logger import Logger
+
+
+def get_logfile_list() -> List[LogFile]:
+    cm = InstanceManager(Klipper)
+    log_dirs: List[Path] = [instance.log_dir for instance in cm.instances]
+
+    logfiles: List[LogFile] = []
+    for _dir in log_dirs:
+        for f in _dir.iterdir():
+            logfiles.append({"filepath": f, "display_name": get_display_name(f)})
+
+    return logfiles
+
+
+def get_display_name(filepath: Path) -> str:
+    printer = " ".join(filepath.parts[-3].split("_")[:-1])
+    name = filepath.name
+
+    return f"{printer}: {name}"
+
+
+def upload_logfile(logfile: LogFile) -> None:
+    file = logfile.get("filepath")
+    name = logfile.get("display_name")
+    Logger.print_status(f"Uploading the following logfile from {name} ...")
+
+    with open(file, "rb") as f:
+        headers = {"x-random": ""}
+        req = urllib.request.Request("http://paste.c-net.org/", headers=headers, data=f)
+        try:
+            response = urllib.request.urlopen(req)
+            link = response.read().decode("utf-8")
+            Logger.print_ok("Upload successfull! Access it via the following link:")
+            Logger.print_ok(f">>>> {link}", False)
+        except Exception as e:
+            Logger.print_error(f"Uploading logfile failed!")
+            Logger.print_error(str(e))

kiauh/components/log_uploads/menus/log_upload_menu.py

@@ -0,0 +1,54 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import textwrap
+
+from kiauh.core.menus import BACK_FOOTER
+from kiauh.core.menus.base_menu import BaseMenu
+from kiauh.components.log_uploads.log_upload_utils import upload_logfile
+from kiauh.components.log_uploads.log_upload_utils import get_logfile_list
+from kiauh.utils.constants import RESET_FORMAT, COLOR_YELLOW
+
+
+# noinspection PyMethodMayBeStatic
+class LogUploadMenu(BaseMenu):
+    def __init__(self):
+        self.logfile_list = get_logfile_list()
+        options = {index: self.upload for index in range(len(self.logfile_list))}
+        super().__init__(
+            header=True,
+            options=options,
+            footer_type=BACK_FOOTER,
+        )
+
+    def print_menu(self):
+        header = " [ Log Upload ] "
+        color = COLOR_YELLOW
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            /=======================================================\\
+            | {color}{header:~^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            | You can select the following logfiles for uploading:  |
+            |                                                       |
+            """
+        )[1:]
+
+        logfile_list = get_logfile_list()
+        for logfile in enumerate(logfile_list):
+            line = f"{logfile[0]}) {logfile[1].get('display_name')}"
+            menu += f"| {line:<54}|\n"
+
+        print(menu, end="")
+
+    def upload(self, **kwargs):
+        upload_logfile(self.logfile_list[kwargs.get("opt_index")])

kiauh/components/mainsail/__init__.py

@@ -0,0 +1,24 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+
+MODULE_PATH = Path(__file__).resolve().parent
+MAINSAIL_DIR = Path(Path.home(), "mainsail")
+MAINSAIL_CONFIG_DIR = Path(Path.home(), "mainsail-config")
+MAINSAIL_CONFIG_JSON = Path(MAINSAIL_DIR, "config.json")
+MAINSAIL_URL = (
+    "https://github.com/mainsail-crew/mainsail/releases/latest/download/mainsail.zip"
+)
+MAINSAIL_UNSTABLE_URL = (
+    "https://github.com/mainsail-crew/mainsail/releases/download/%TAG%/mainsail.zip"
+)
+MAINSAIL_CONFIG_REPO_URL = "https://github.com/mainsail-crew/mainsail-config.git"

kiauh/components/mainsail/assets/mainsail-config-updater.conf

@@ -0,0 +1,6 @@
+[update_manager mainsail-config]
+type: git_repo
+primary_branch: master
+path: ~/mainsail-config
+origin: https://github.com/mainsail-crew/mainsail-config.git
+managed_services: klipper

kiauh/components/mainsail/assets/mainsail-updater.conf

@@ -0,0 +1,5 @@
+[update_manager mainsail]
+type: web
+channel: stable
+repo: mainsail-crew/mainsail
+path: ~/mainsail

kiauh/components/mainsail/mainsail_dialogs.py

@@ -0,0 +1,95 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import textwrap
+
+from kiauh.core.menus.base_menu import print_back_footer
+from kiauh.utils.constants import RESET_FORMAT, COLOR_YELLOW, COLOR_CYAN
+
+
+def print_moonraker_not_found_dialog():
+    line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
+    line2 = f"{COLOR_YELLOW}No local Moonraker installation was found!{RESET_FORMAT}"
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        | {line1:<63}|
+        | {line2:<63}|
+        |-------------------------------------------------------|
+        | It is possible to install Mainsail without a local    |
+        | Moonraker installation. If you continue, you need to  |
+        | make sure, that Moonraker is installed on another     |
+        | machine in your network. Otherwise Mainsail will NOT  |
+        | work correctly.                                       |
+        """
+    )[1:]
+
+    print(dialog, end="")
+    print_back_footer()
+
+
+def print_mainsail_already_installed_dialog():
+    line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
+    line2 = f"{COLOR_YELLOW}Mainsail seems to be already installed!{RESET_FORMAT}"
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        | {line1:<63}|
+        | {line2:<63}|
+        |-------------------------------------------------------|
+        | If you continue, your current Mainsail installation   |
+        | will be overwritten. You will not loose any printer   |
+        | configurations and the Moonraker database will remain |
+        | untouched.                                            |
+        """
+    )[1:]
+
+    print(dialog, end="")
+    print_back_footer()
+
+
+def print_install_mainsail_config_dialog():
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        | It is recommended to use special macros in order to   |
+        | have Mainsail fully functional and working.           |
+        |                                                       |
+        | The recommended macros for Mainsail can be seen here: |
+        | https://github.com/mainsail-crew/mainsail-config      |
+        |                                                       |
+        | If you already use these macros skip this step.       |
+        | Otherwise you should consider to answer with 'Y' to   |
+        | download the recommended macros.                      |
+        \\=======================================================/
+        """
+    )[1:]
+
+    print(dialog, end="")
+
+
+def print_mainsail_port_select_dialog(port: str):
+    port = f"{COLOR_CYAN}{port}{RESET_FORMAT}"
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        | Please select the port, Mainsail should be served on. |
+        | If you are unsure what to select, hit Enter to apply  |
+        | the suggested value of: {port:38} |
+        |                                                       |
+        | In case you need Mainsail to be served on a specific  |
+        | port, you can set it now. Make sure the port is not   |
+        | used by any other application on your system!         |
+        \\=======================================================/
+        """
+    )[1:]
+
+    print(dialog, end="")

kiauh/components/mainsail/mainsail_remove.py

@@ -0,0 +1,164 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+
+import shutil
+import subprocess
+from pathlib import Path
+from typing import List
+
+from kiauh.core.config_manager.config_manager import ConfigManager
+from kiauh.core.instance_manager.instance_manager import InstanceManager
+from kiauh.components.klipper.klipper import Klipper
+from kiauh.components.mainsail import MAINSAIL_DIR, MAINSAIL_CONFIG_DIR
+from kiauh.components.mainsail.mainsail_utils import backup_config_json
+from kiauh.components.moonraker.moonraker import Moonraker
+from kiauh.utils import NGINX_SITES_AVAILABLE, NGINX_SITES_ENABLED
+from kiauh.utils.filesystem_utils import remove_file
+from kiauh.utils.logger import Logger
+
+
+def run_mainsail_removal(
+    remove_mainsail: bool,
+    remove_ms_config: bool,
+    backup_ms_config_json: bool,
+    remove_mr_updater_section: bool,
+    remove_msc_printer_cfg_include: bool,
+) -> None:
+    if backup_ms_config_json:
+        backup_config_json()
+    if remove_mainsail:
+        remove_mainsail_dir()
+        remove_nginx_config()
+        remove_nginx_logs()
+        if remove_mr_updater_section:
+            remove_updater_section("update_manager mainsail")
+    if remove_ms_config:
+        remove_mainsail_cfg_dir()
+        remove_mainsail_cfg_symlink()
+        if remove_mr_updater_section:
+            remove_updater_section("update_manager mainsail-config")
+        if remove_msc_printer_cfg_include:
+            remove_printer_cfg_include()
+
+
+def remove_mainsail_dir() -> None:
+    Logger.print_status("Removing Mainsail ...")
+    if not MAINSAIL_DIR.exists():
+        Logger.print_info(f"'{MAINSAIL_DIR}' does not exist. Skipping ...")
+        return
+
+    try:
+        shutil.rmtree(MAINSAIL_DIR)
+    except OSError as e:
+        Logger.print_error(f"Unable to delete '{MAINSAIL_DIR}':\n{e}")
+
+
+def remove_nginx_config() -> None:
+    Logger.print_status("Removing Mainsails NGINX config ...")
+    try:
+        remove_file(NGINX_SITES_AVAILABLE.joinpath("mainsail"), True)
+        remove_file(NGINX_SITES_ENABLED.joinpath("mainsail"), True)
+
+    except subprocess.CalledProcessError as e:
+        log = f"Unable to remove Mainsail NGINX config:\n{e.stderr.decode()}"
+        Logger.print_error(log)
+
+
+def remove_nginx_logs() -> None:
+    Logger.print_status("Removing Mainsails NGINX logs ...")
+    try:
+        remove_file(Path("/var/log/nginx/mainsail-access.log"), True)
+        remove_file(Path("/var/log/nginx/mainsail-error.log"), True)
+
+        im = InstanceManager(Klipper)
+        instances: List[Klipper] = im.instances
+        if not instances:
+            return
+
+        for instance in instances:
+            remove_file(instance.log_dir.joinpath("mainsail-access.log"))
+            remove_file(instance.log_dir.joinpath("mainsail-error.log"))
+
+    except (OSError, subprocess.CalledProcessError) as e:
+        Logger.print_error(f"Unable to NGINX logs:\n{e}")
+
+
+def remove_updater_section(name: str) -> None:
+    Logger.print_status("Remove updater section from moonraker.conf ...")
+    im = InstanceManager(Moonraker)
+    instances: List[Moonraker] = im.instances
+    if not instances:
+        Logger.print_info("Moonraker not installed. Skipped ...")
+        return
+
+    for instance in instances:
+        Logger.print_status(f"Remove section '{name}' in '{instance.cfg_file}' ...")
+
+        if not instance.cfg_file.is_file():
+            Logger.print_info(f"'{instance.cfg_file}' does not exist. Skipped ...")
+            continue
+
+        cm = ConfigManager(instance.cfg_file)
+        if not cm.config.has_section(name):
+            Logger.print_info("Section not present. Skipped ...")
+            continue
+
+        cm.config.remove_section(name)
+        cm.write_config()
+
+
+def remove_mainsail_cfg_dir() -> None:
+    Logger.print_status("Removing mainsail-config ...")
+    if not MAINSAIL_CONFIG_DIR.exists():
+        Logger.print_info(f"'{MAINSAIL_CONFIG_DIR}' does not exist. Skipping ...")
+        return
+
+    try:
+        shutil.rmtree(MAINSAIL_CONFIG_DIR)
+    except OSError as e:
+        Logger.print_error(f"Unable to delete '{MAINSAIL_CONFIG_DIR}':\n{e}")
+
+
+def remove_mainsail_cfg_symlink() -> None:
+    Logger.print_status("Removing mainsail.cfg symlinks ...")
+    im = InstanceManager(Klipper)
+    instances: List[Klipper] = im.instances
+    for instance in instances:
+        Logger.print_status(f"Removing symlink from '{instance.cfg_file}' ...")
+        try:
+            remove_file(instance.cfg_dir.joinpath("mainsail.cfg"))
+        except subprocess.CalledProcessError:
+            Logger.print_error("Failed to remove symlink!")
+
+
+def remove_printer_cfg_include() -> None:
+    Logger.print_status("Remove mainsail-config include from printer.cfg ...")
+    im = InstanceManager(Klipper)
+    instances: List[Klipper] = im.instances
+    if not instances:
+        Logger.print_info("Klipper not installed. Skipping ...")
+        return
+
+    for instance in instances:
+        log = f"Removing include from '{instance.cfg_file}' ..."
+        Logger.print_status(log)
+
+        if not instance.cfg_file.is_file():
+            continue
+
+        cm = ConfigManager(instance.cfg_file)
+        if not cm.config.has_section("include mainsail.cfg"):
+            Logger.print_info("Section not present. Skipped ...")
+            continue
+
+        cm.config.remove_section("include mainsail.cfg")
+        cm.write_config()

kiauh/components/mainsail/mainsail_setup.py

@@ -0,0 +1,256 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import subprocess
+from pathlib import Path
+from typing import List
+
+from kiauh import KIAUH_CFG
+from kiauh.core.config_manager.config_manager import ConfigManager
+from kiauh.core.instance_manager.instance_manager import InstanceManager
+from kiauh.core.repo_manager.repo_manager import RepoManager
+from kiauh.components.klipper.klipper import Klipper
+from kiauh.components.mainsail import (
+    MAINSAIL_URL,
+    MAINSAIL_DIR,
+    MAINSAIL_CONFIG_DIR,
+    MAINSAIL_CONFIG_REPO_URL,
+    MODULE_PATH,
+)
+from kiauh.components.mainsail.mainsail_dialogs import (
+    print_moonraker_not_found_dialog,
+    print_mainsail_already_installed_dialog,
+    print_install_mainsail_config_dialog,
+    print_mainsail_port_select_dialog,
+)
+from kiauh.components.mainsail.mainsail_utils import (
+    restore_config_json,
+    enable_mainsail_remotemode,
+    backup_config_json,
+    symlink_webui_nginx_log,
+)
+from kiauh.components.moonraker.moonraker import Moonraker
+from kiauh.utils import NGINX_SITES_AVAILABLE, NGINX_SITES_ENABLED
+from kiauh.utils.common import check_install_dependencies
+from kiauh.utils.filesystem_utils import (
+    unzip,
+    copy_upstream_nginx_cfg,
+    copy_common_vars_nginx_cfg,
+    create_nginx_cfg,
+    create_symlink,
+    remove_file,
+)
+from kiauh.utils.input_utils import get_confirm, get_number_input
+from kiauh.utils.logger import Logger
+from kiauh.utils.system_utils import (
+    download_file,
+    set_nginx_permissions,
+    get_ipv4_addr,
+    control_systemd_service,
+)
+
+
+def install_mainsail() -> None:
+    mr_im = InstanceManager(Moonraker)
+    mr_instances: List[Moonraker] = mr_im.instances
+
+    enable_remotemode = False
+    if not mr_instances:
+        print_moonraker_not_found_dialog()
+        if not get_confirm("Continue Mainsail installation?", allow_go_back=True):
+            return
+
+    # if moonraker is not installed or multiple instances
+    # are installed we enable mainsails remote mode
+    if not mr_instances or len(mr_instances) > 1:
+        enable_remotemode = True
+
+    do_reinstall = False
+    if Path.home().joinpath("mainsail").exists():
+        print_mainsail_already_installed_dialog()
+        do_reinstall = get_confirm("Re-install Mainsail?", allow_go_back=True)
+        if do_reinstall:
+            backup_config_json(is_temp=True)
+        else:
+            return
+
+    kl_im = InstanceManager(Klipper)
+    kl_instances = kl_im.instances
+    install_ms_config = False
+    if kl_instances:
+        print_install_mainsail_config_dialog()
+        question = "Download the recommended macros?"
+        install_ms_config = get_confirm(question, allow_go_back=False)
+
+    # if a default port is configured in the kiauh.cfg, we use that for the port
+    # otherwise we default to port 80, but show the user a dialog to confirm/change that port
+    cm = ConfigManager(cfg_file=KIAUH_CFG)
+    default_port = cm.get_value("mainsail", "default_port")
+    is_valid_port = default_port and default_port.isdigit()
+    mainsail_port = default_port if is_valid_port else "80"
+    if not is_valid_port:
+        print_mainsail_port_select_dialog(mainsail_port)
+        mainsail_port = get_number_input(
+            "Configure Mainsail for port",
+            min_count=mainsail_port,
+            default=mainsail_port,
+        )
+
+    check_install_dependencies(["nginx"])
+
+    try:
+        download_mainsail()
+        if do_reinstall:
+            restore_config_json()
+        if enable_remotemode:
+            enable_mainsail_remotemode()
+        if mr_instances:
+            patch_moonraker_conf(
+                mr_instances,
+                "Mainsail",
+                "update_manager mainsail",
+                "mainsail-updater.conf",
+            )
+            mr_im.restart_all_instance()
+        if install_ms_config and kl_instances:
+            download_mainsail_cfg()
+            create_mainsail_cfg_symlink(kl_instances)
+            patch_moonraker_conf(
+                mr_instances,
+                "mainsail-config",
+                "update_manager mainsail-config",
+                "mainsail-config-updater.conf",
+            )
+            patch_printer_config(kl_instances)
+            kl_im.restart_all_instance()
+
+        copy_upstream_nginx_cfg()
+        copy_common_vars_nginx_cfg()
+        create_mainsail_nginx_cfg(mainsail_port)
+        if kl_instances:
+            symlink_webui_nginx_log(kl_instances)
+        control_systemd_service("nginx", "restart")
+
+    except Exception as e:
+        Logger.print_error(f"Mainsail installation failed!\n{e}")
+        return
+
+    log = f"Open Mainsail now on: http://{get_ipv4_addr()}:{mainsail_port}"
+    Logger.print_ok("Mainsail installation complete!", start="\n")
+    Logger.print_ok(log, prefix=False, end="\n\n")
+
+
+def download_mainsail() -> None:
+    try:
+        Logger.print_status("Downloading Mainsail ...")
+        target = Path.home().joinpath("mainsail.zip")
+        download_file(MAINSAIL_URL, target, True)
+        Logger.print_ok("Download complete!")
+
+        Logger.print_status("Extracting mainsail.zip ...")
+        unzip(Path.home().joinpath("mainsail.zip"), MAINSAIL_DIR)
+        target.unlink(missing_ok=True)
+        Logger.print_ok("OK!")
+
+    except Exception:
+        Logger.print_error("Downloading Mainsail failed!")
+        raise
+
+
+def update_mainsail() -> None:
+    Logger.print_status("Updating Mainsail ...")
+    backup_config_json(is_temp=True)
+    download_mainsail()
+    restore_config_json()
+
+
+def download_mainsail_cfg() -> None:
+    try:
+        Logger.print_status("Downloading mainsail-config ...")
+        rm = RepoManager(MAINSAIL_CONFIG_REPO_URL, target_dir=MAINSAIL_CONFIG_DIR)
+        rm.clone_repo()
+    except Exception:
+        Logger.print_error("Downloading mainsail-config failed!")
+        raise
+
+
+def create_mainsail_cfg_symlink(klipper_instances: List[Klipper]) -> None:
+    Logger.print_status("Create symlink of mainsail.cfg ...")
+    source = Path(MAINSAIL_CONFIG_DIR, "mainsail.cfg")
+    for instance in klipper_instances:
+        target = instance.cfg_dir
+        Logger.print_status(f"Linking {source} to {target}")
+        try:
+            create_symlink(source, target)
+        except subprocess.CalledProcessError:
+            Logger.print_error("Creating symlink failed!")
+
+
+def create_mainsail_nginx_cfg(port: int) -> None:
+    root_dir = MAINSAIL_DIR
+    source = NGINX_SITES_AVAILABLE.joinpath("mainsail")
+    target = NGINX_SITES_ENABLED.joinpath("mainsail")
+    try:
+        Logger.print_status("Creating NGINX config for Mainsail ...")
+        remove_file(Path("/etc/nginx/sites-enabled/default"), True)
+        create_nginx_cfg("mainsail", port, root_dir)
+        create_symlink(source, target, True)
+        set_nginx_permissions()
+        Logger.print_ok("NGINX config for Mainsail successfully created.")
+    except Exception:
+        Logger.print_error("Creating NGINX config for Mainsail failed!")
+        raise
+
+
+def patch_moonraker_conf(
+    moonraker_instances: List[Moonraker],
+    name: str,
+    section_name: str,
+    template_file: str,
+) -> None:
+    for instance in moonraker_instances:
+        cfg_file = instance.cfg_file
+        Logger.print_status(f"Add {name} update section to '{cfg_file}' ...")
+
+        if not Path(cfg_file).exists():
+            Logger.print_warn(f"'{cfg_file}' not found!")
+            return
+
+        cm = ConfigManager(cfg_file)
+        if cm.config.has_section(section_name):
+            Logger.print_info("Section already exist. Skipped ...")
+            return
+
+        template = MODULE_PATH.joinpath("assets", template_file)
+        with open(template, "r") as t:
+            template_content = "\n"
+            template_content += t.read()
+
+        with open(cfg_file, "a") as f:
+            f.write(template_content)
+
+
+def patch_printer_config(klipper_instances: List[Klipper]) -> None:
+    for instance in klipper_instances:
+        cfg_file = instance.cfg_file
+        Logger.print_status(f"Including mainsail-config in '{cfg_file}' ...")
+
+        if not Path(cfg_file).exists():
+            Logger.print_warn(f"'{cfg_file}' not found!")
+            return
+
+        cm = ConfigManager(cfg_file)
+        if cm.config.has_section("include mainsail.cfg"):
+            Logger.print_info("Section already exist. Skipped ...")
+            return
+
+        with open(cfg_file, "a") as f:
+            f.write("\n[include mainsail.cfg]")

kiauh/components/mainsail/mainsail_utils.py

@@ -0,0 +1,99 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import json
+import shutil
+import requests
+from pathlib import Path
+from typing import List
+
+from kiauh.core.backup_manager.backup_manager import BackupManager
+from kiauh.components.klipper.klipper import Klipper
+from kiauh.components.mainsail import MAINSAIL_CONFIG_JSON, MAINSAIL_DIR
+from kiauh.utils import NGINX_SITES_AVAILABLE, NGINX_CONFD
+from kiauh.utils.common import get_install_status_webui
+from kiauh.utils.logger import Logger
+
+
+def get_mainsail_status() -> str:
+    return get_install_status_webui(
+        MAINSAIL_DIR,
+        NGINX_SITES_AVAILABLE.joinpath("mainsail"),
+        NGINX_CONFD.joinpath("upstreams.conf"),
+        NGINX_CONFD.joinpath("common_vars.conf"),
+    )
+
+
+def backup_config_json(is_temp=False) -> None:
+    Logger.print_status(f"Backup '{MAINSAIL_CONFIG_JSON}' ...")
+    bm = BackupManager()
+    if is_temp:
+        fn = Path.home().joinpath("config.json.kiauh.bak")
+        bm.backup_file([MAINSAIL_CONFIG_JSON], custom_filename=fn)
+    else:
+        bm.backup_file([MAINSAIL_CONFIG_JSON])
+
+
+def restore_config_json() -> None:
+    try:
+        Logger.print_status(f"Restore '{MAINSAIL_CONFIG_JSON}' ...")
+        source = Path.home().joinpath("config.json.kiauh.bak")
+        shutil.copy(source, MAINSAIL_CONFIG_JSON)
+    except OSError:
+        Logger.print_info("Unable to restore config.json. Skipped ...")
+
+
+def enable_mainsail_remotemode() -> None:
+    Logger.print_status("Enable Mainsails remote mode ...")
+    with open(MAINSAIL_CONFIG_JSON, "r") as f:
+        config_data = json.load(f)
+
+    if config_data["instancesDB"] == "browser":
+        Logger.print_info("Remote mode already configured. Skipped ...")
+        return
+
+    Logger.print_status("Setting instance storage location to 'browser' ...")
+    config_data["instancesDB"] = "browser"
+
+    with open(MAINSAIL_CONFIG_JSON, "w") as f:
+        json.dump(config_data, f, indent=4)
+    Logger.print_ok("Mainsails remote mode enabled!")
+
+
+def symlink_webui_nginx_log(klipper_instances: List[Klipper]) -> None:
+    Logger.print_status("Link NGINX logs into log directory ...")
+    access_log = Path("/var/log/nginx/mainsail-access.log")
+    error_log = Path("/var/log/nginx/mainsail-error.log")
+
+    for instance in klipper_instances:
+        desti_access = instance.log_dir.joinpath("mainsail-access.log")
+        if not desti_access.exists():
+            desti_access.symlink_to(access_log)
+
+        desti_error = instance.log_dir.joinpath("mainsail-error.log")
+        if not desti_error.exists():
+            desti_error.symlink_to(error_log)
+
+
+def get_mainsail_local_version() -> str:
+    relinfo_file = MAINSAIL_DIR.joinpath("release_info.json")
+    if not relinfo_file.is_file():
+        return "-"
+
+    with open(relinfo_file, "r") as f:
+        return json.load(f)["version"]
+
+
+def get_mainsail_remote_version() -> str:
+    url = "https://api.github.com/repos/mainsail-crew/mainsail/tags"
+    response = requests.get(url)
+    data = json.loads(response.text)
+    return data[0]["name"]

kiauh/components/mainsail/menus/mainsail_remove_menu.py

@@ -0,0 +1,122 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import textwrap
+
+from kiauh.core.menus import BACK_HELP_FOOTER
+from kiauh.core.menus.base_menu import BaseMenu
+from kiauh.components.mainsail import mainsail_remove
+from kiauh.utils.constants import RESET_FORMAT, COLOR_RED, COLOR_CYAN
+
+
+# noinspection PyUnusedLocal
+class MainsailRemoveMenu(BaseMenu):
+    def __init__(self):
+        super().__init__(
+            header=False,
+            options={
+                "0": self.toggle_all,
+                "1": self.toggle_remove_mainsail,
+                "2": self.toggle_remove_ms_config,
+                "3": self.toggle_backup_config_json,
+                "4": self.toggle_remove_updater_section,
+                "5": self.toggle_remove_printer_cfg_include,
+                "6": self.run_removal_process,
+            },
+            footer_type=BACK_HELP_FOOTER,
+        )
+        self.remove_mainsail = False
+        self.remove_ms_config = False
+        self.backup_config_json = False
+        self.remove_updater_section = False
+        self.remove_printer_cfg_include = False
+
+    def print_menu(self) -> None:
+        header = " [ Remove Mainsail ] "
+        color = COLOR_RED
+        count = 62 - len(color) - len(RESET_FORMAT)
+        checked = f"[{COLOR_CYAN}x{RESET_FORMAT}]"
+        unchecked = "[ ]"
+        o1 = checked if self.remove_mainsail else unchecked
+        o2 = checked if self.remove_ms_config else unchecked
+        o3 = checked if self.backup_config_json else unchecked
+        o4 = checked if self.remove_updater_section else unchecked
+        o5 = checked if self.remove_printer_cfg_include else unchecked
+        menu = textwrap.dedent(
+            f"""
+            /=======================================================\\
+            | {color}{header:~^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            | Enter a number and hit enter to select / deselect     |
+            | the specific option for removal.                      |
+            |-------------------------------------------------------|
+            |  0) Select everything                                 |
+            |-------------------------------------------------------|
+            |  1) {o1} Remove Mainsail                               |
+            |  2) {o2} Remove mainsail-config                        |
+            |  3) {o3} Backup config.json                            |
+            |                                                       |
+            |  printer.cfg & moonraker.conf                         |
+            |  4) {o4} Remove Moonraker update section               |
+            |  5) {o5} Remove printer.cfg include                    |
+            |-------------------------------------------------------|
+            |  6) Continue                                          |
+            """
+        )[1:]
+        print(menu, end="")
+
+    def toggle_all(self, **kwargs) -> None:
+        self.remove_mainsail = True
+        self.remove_ms_config = True
+        self.backup_config_json = True
+        self.remove_updater_section = True
+        self.remove_printer_cfg_include = True
+
+    def toggle_remove_mainsail(self, **kwargs) -> None:
+        self.remove_mainsail = not self.remove_mainsail
+
+    def toggle_remove_ms_config(self, **kwargs) -> None:
+        self.remove_ms_config = not self.remove_ms_config
+
+    def toggle_backup_config_json(self, **kwargs) -> None:
+        self.backup_config_json = not self.backup_config_json
+
+    def toggle_remove_updater_section(self, **kwargs) -> None:
+        self.remove_updater_section = not self.remove_updater_section
+
+    def toggle_remove_printer_cfg_include(self, **kwargs) -> None:
+        self.remove_printer_cfg_include = not self.remove_printer_cfg_include
+
+    def run_removal_process(self, **kwargs) -> None:
+        if (
+            not self.remove_mainsail
+            and not self.remove_ms_config
+            and not self.backup_config_json
+            and not self.remove_updater_section
+            and not self.remove_printer_cfg_include
+        ):
+            error = f"{COLOR_RED}Nothing selected! Select options to remove first.{RESET_FORMAT}"
+            print(error)
+            return
+
+        mainsail_remove.run_mainsail_removal(
+            remove_mainsail=self.remove_mainsail,
+            remove_ms_config=self.remove_ms_config,
+            backup_ms_config_json=self.backup_config_json,
+            remove_mr_updater_section=self.remove_updater_section,
+            remove_msc_printer_cfg_include=self.remove_printer_cfg_include,
+        )
+
+        self.remove_mainsail = False
+        self.remove_ms_config = False
+        self.backup_config_json = False
+        self.remove_updater_section = False
+        self.remove_printer_cfg_include = False

kiauh/components/moonraker/__init__.py

@@ -0,0 +1,32 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+
+MODULE_PATH = Path(__file__).resolve().parent
+
+MOONRAKER_DIR = Path.home().joinpath("moonraker")
+MOONRAKER_ENV_DIR = Path.home().joinpath("moonraker-env")
+MOONRAKER_REQUIREMENTS_TXT = MOONRAKER_DIR.joinpath(
+    "scripts/moonraker-requirements.txt"
+)
+DEFAULT_MOONRAKER_REPO_URL = "https://github.com/Arksine/moonraker"
+DEFAULT_MOONRAKER_PORT = 7125
+
+# introduced due to
+# https://github.com/Arksine/moonraker/issues/349
+# https://github.com/Arksine/moonraker/pull/346
+POLKIT_LEGACY_FILE = Path("/etc/polkit-1/localauthority/50-local.d/10-moonraker.pkla")
+POLKIT_FILE = Path("/etc/polkit-1/rules.d/moonraker.rules")
+POLKIT_USR_FILE = Path("/usr/share/polkit-1/rules.d/moonraker.rules")
+POLKIT_SCRIPT = Path.home().joinpath("moonraker/scripts/set-policykit-rules.sh")
+
+EXIT_MOONRAKER_SETUP = "Exiting Moonraker setup ..."

kiauh/components/moonraker/assets/moonraker.conf

@@ -0,0 +1,29 @@
+[server]
+host: 0.0.0.0
+port: %PORT%
+klippy_uds_address: %UDS%
+
+[authorization]
+trusted_clients:
+    10.0.0.0/8
+    127.0.0.0/8
+    169.254.0.0/16
+    172.16.0.0/12
+    192.168.0.0/16
+    FE80::/10
+    ::1/128
+cors_domains:
+    *.lan
+    *.local
+    *://localhost
+    *://localhost:*
+    *://my.mainsail.xyz
+    *://app.fluidd.xyz
+
+[octoprint_compat]
+
+[history]
+
+[update_manager]
+channel: dev
+refresh_interval: 168

kiauh/components/moonraker/assets/moonraker.env

@@ -0,0 +1 @@
+MOONRAKER_ARGS="%MOONRAKER_DIR%/moonraker/moonraker.py -d %PRINTER_DATA%"

kiauh/components/moonraker/assets/moonraker.service

@@ -0,0 +1,19 @@
+[Unit]
+Description=API Server for Klipper SV1
+Documentation=https://moonraker.readthedocs.io/
+Requires=network-online.target
+After=network-online.target
+
+[Install]
+WantedBy=multi-user.target
+
+[Service]
+Type=simple
+User=%USER%
+SupplementaryGroups=moonraker-admin
+RemainAfterExit=yes
+WorkingDirectory=%MOONRAKER_DIR%
+EnvironmentFile=%ENV_FILE%
+ExecStart=%ENV%/bin/python $MOONRAKER_ARGS
+Restart=always
+RestartSec=10

kiauh/components/moonraker/menus/moonraker_remove_menu.py

@@ -0,0 +1,120 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import textwrap
+
+from kiauh.core.menus import BACK_HELP_FOOTER
+from kiauh.core.menus.base_menu import BaseMenu
+from kiauh.components.moonraker import moonraker_remove
+from kiauh.utils.constants import RESET_FORMAT, COLOR_RED, COLOR_CYAN
+
+
+# noinspection PyUnusedLocal
+class MoonrakerRemoveMenu(BaseMenu):
+    def __init__(self):
+        super().__init__(
+            header=False,
+            options={
+                "0": self.toggle_all,
+                "1": self.toggle_remove_moonraker_service,
+                "2": self.toggle_remove_moonraker_dir,
+                "3": self.toggle_remove_moonraker_env,
+                "4": self.toggle_remove_moonraker_polkit,
+                "5": self.toggle_delete_moonraker_logs,
+                "6": self.run_removal_process,
+            },
+            footer_type=BACK_HELP_FOOTER,
+        )
+        self.remove_moonraker_service = False
+        self.remove_moonraker_dir = False
+        self.remove_moonraker_env = False
+        self.remove_moonraker_polkit = False
+        self.delete_moonraker_logs = False
+
+    def print_menu(self) -> None:
+        header = " [ Remove Moonraker ] "
+        color = COLOR_RED
+        count = 62 - len(color) - len(RESET_FORMAT)
+        checked = f"[{COLOR_CYAN}x{RESET_FORMAT}]"
+        unchecked = "[ ]"
+        o1 = checked if self.remove_moonraker_service else unchecked
+        o2 = checked if self.remove_moonraker_dir else unchecked
+        o3 = checked if self.remove_moonraker_env else unchecked
+        o4 = checked if self.remove_moonraker_polkit else unchecked
+        o5 = checked if self.delete_moonraker_logs else unchecked
+        menu = textwrap.dedent(
+            f"""
+            /=======================================================\\
+            | {color}{header:~^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            | Enter a number and hit enter to select / deselect     |
+            | the specific option for removal.                      |
+            |-------------------------------------------------------|
+            |  0) Select everything                                 |
+            |-------------------------------------------------------|
+            |  1) {o1} Remove Service                                |
+            |  2) {o2} Remove Local Repository                       |
+            |  3) {o3} Remove Python Environment                     |
+            |  4) {o4} Remove Policy Kit Rules                       |
+            |  5) {o5} Delete all Log-Files                          |
+            |-------------------------------------------------------|
+            |  6) Continue                                          |
+            """
+        )[1:]
+        print(menu, end="")
+
+    def toggle_all(self, **kwargs) -> None:
+        self.remove_moonraker_service = True
+        self.remove_moonraker_dir = True
+        self.remove_moonraker_env = True
+        self.remove_moonraker_polkit = True
+        self.delete_moonraker_logs = True
+
+    def toggle_remove_moonraker_service(self, **kwargs) -> None:
+        self.remove_moonraker_service = not self.remove_moonraker_service
+
+    def toggle_remove_moonraker_dir(self, **kwargs) -> None:
+        self.remove_moonraker_dir = not self.remove_moonraker_dir
+
+    def toggle_remove_moonraker_env(self, **kwargs) -> None:
+        self.remove_moonraker_env = not self.remove_moonraker_env
+
+    def toggle_remove_moonraker_polkit(self, **kwargs) -> None:
+        self.remove_moonraker_polkit = not self.remove_moonraker_polkit
+
+    def toggle_delete_moonraker_logs(self, **kwargs) -> None:
+        self.delete_moonraker_logs = not self.delete_moonraker_logs
+
+    def run_removal_process(self, **kwargs) -> None:
+        if (
+            not self.remove_moonraker_service
+            and not self.remove_moonraker_dir
+            and not self.remove_moonraker_env
+            and not self.remove_moonraker_polkit
+            and not self.delete_moonraker_logs
+        ):
+            error = f"{COLOR_RED}Nothing selected! Select options to remove first.{RESET_FORMAT}"
+            print(error)
+            return
+
+        moonraker_remove.run_moonraker_removal(
+            self.remove_moonraker_service,
+            self.remove_moonraker_dir,
+            self.remove_moonraker_env,
+            self.remove_moonraker_polkit,
+            self.delete_moonraker_logs,
+        )
+
+        self.remove_moonraker_service = False
+        self.remove_moonraker_dir = False
+        self.remove_moonraker_env = False
+        self.remove_moonraker_polkit = False
+        self.delete_moonraker_logs = False

kiauh/components/moonraker/moonraker.py

@@ -0,0 +1,147 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import subprocess
+from pathlib import Path
+from typing import List, Union
+
+from kiauh.core.config_manager.config_manager import ConfigManager
+from kiauh.core.instance_manager.base_instance import BaseInstance
+from kiauh.components.moonraker import MOONRAKER_DIR, MOONRAKER_ENV_DIR, MODULE_PATH
+from kiauh.utils.constants import SYSTEMD
+from kiauh.utils.logger import Logger
+
+
+# noinspection PyMethodMayBeStatic
+class Moonraker(BaseInstance):
+    @classmethod
+    def blacklist(cls) -> List[str]:
+        return ["None", "mcu"]
+
+    def __init__(self, suffix: str = ""):
+        super().__init__(instance_type=self, suffix=suffix)
+        self.moonraker_dir: Path = MOONRAKER_DIR
+        self.env_dir: Path = MOONRAKER_ENV_DIR
+        self.cfg_file = self.cfg_dir.joinpath("moonraker.conf")
+        self.port = self._get_port()
+        self.backup_dir = self.data_dir.joinpath("backup")
+        self.certs_dir = self.data_dir.joinpath("certs")
+        self.db_dir = self.data_dir.joinpath("database")
+        self.log = self.log_dir.joinpath("moonraker.log")
+
+    def create(self, create_example_cfg: bool = False) -> None:
+        Logger.print_status("Creating new Moonraker Instance ...")
+        service_template_path = MODULE_PATH.joinpath("assets/moonraker.service")
+        env_template_file_path = MODULE_PATH.joinpath("assets/moonraker.env")
+        service_file_name = self.get_service_file_name(extension=True)
+        service_file_target = SYSTEMD.joinpath(service_file_name)
+        env_file_target = self.sysd_dir.joinpath("moonraker.env")
+
+        try:
+            self.create_folders([self.backup_dir, self.certs_dir, self.db_dir])
+            self.write_service_file(
+                service_template_path, service_file_target, env_file_target
+            )
+            self.write_env_file(env_template_file_path, env_file_target)
+
+        except subprocess.CalledProcessError as e:
+            Logger.print_error(
+                f"Error creating service file {service_file_target}: {e}"
+            )
+            raise
+        except OSError as e:
+            Logger.print_error(f"Error writing file: {e}")
+            raise
+
+    def delete(self) -> None:
+        service_file = self.get_service_file_name(extension=True)
+        service_file_path = self.get_service_file_path()
+
+        Logger.print_status(f"Deleting Moonraker Instance: {service_file}")
+
+        try:
+            command = ["sudo", "rm", "-f", service_file_path]
+            subprocess.run(command, check=True)
+            Logger.print_ok(f"Service file deleted: {service_file_path}")
+        except subprocess.CalledProcessError as e:
+            Logger.print_error(f"Error deleting service file: {e}")
+            raise
+
+    def write_service_file(
+        self,
+        service_template_path: Path,
+        service_file_target: Path,
+        env_file_target: Path,
+    ) -> None:
+        service_content = self._prep_service_file(
+            service_template_path, env_file_target
+        )
+        command = ["sudo", "tee", service_file_target]
+        subprocess.run(
+            command,
+            input=service_content.encode(),
+            stdout=subprocess.DEVNULL,
+            check=True,
+        )
+        Logger.print_ok(f"Service file created: {service_file_target}")
+
+    def write_env_file(
+        self, env_template_file_path: Path, env_file_target: Path
+    ) -> None:
+        env_file_content = self._prep_env_file(env_template_file_path)
+        with open(env_file_target, "w") as env_file:
+            env_file.write(env_file_content)
+        Logger.print_ok(f"Env file created: {env_file_target}")
+
+    def _prep_service_file(
+        self, service_template_path: Path, env_file_path: Path
+    ) -> str:
+        try:
+            with open(service_template_path, "r") as template_file:
+                template_content = template_file.read()
+        except FileNotFoundError:
+            Logger.print_error(
+                f"Unable to open {service_template_path} - File not found"
+            )
+            raise
+        service_content = template_content.replace("%USER%", self.user)
+        service_content = service_content.replace(
+            "%MOONRAKER_DIR%", str(self.moonraker_dir)
+        )
+        service_content = service_content.replace("%ENV%", str(self.env_dir))
+        service_content = service_content.replace("%ENV_FILE%", str(env_file_path))
+        return service_content
+
+    def _prep_env_file(self, env_template_file_path: Path) -> str:
+        try:
+            with open(env_template_file_path, "r") as env_file:
+                env_template_file_content = env_file.read()
+        except FileNotFoundError:
+            Logger.print_error(
+                f"Unable to open {env_template_file_path} - File not found"
+            )
+            raise
+        env_file_content = env_template_file_content.replace(
+            "%MOONRAKER_DIR%", str(self.moonraker_dir)
+        )
+        env_file_content = env_file_content.replace(
+            "%PRINTER_DATA%", str(self.data_dir)
+        )
+        return env_file_content
+
+    def _get_port(self) -> Union[int, None]:
+        if not self.cfg_file.is_file():
+            return None
+
+        cm = ConfigManager(cfg_file=self.cfg_file)
+        port = cm.get_value("server", "port")
+
+        return int(port) if port is not None else port

kiauh/components/moonraker/moonraker_dialogs.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import textwrap
+from typing import List
+
+from kiauh.core.menus.base_menu import print_back_footer
+from kiauh.components.klipper.klipper import Klipper
+from kiauh.components.moonraker.moonraker import Moonraker
+from kiauh.utils.constants import COLOR_GREEN, RESET_FORMAT, COLOR_YELLOW, COLOR_CYAN
+
+
+def print_moonraker_overview(
+    klipper_instances: List[Klipper],
+    moonraker_instances: List[Moonraker],
+    show_index=False,
+    show_select_all=False,
+):
+    headline = f"{COLOR_GREEN}The following instances were found:{RESET_FORMAT}"
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        |{headline:^64}|
+        |-------------------------------------------------------|
+        """
+    )[1:]
+
+    if show_select_all:
+        select_all = f"{COLOR_YELLOW}a) Select all{RESET_FORMAT}"
+        dialog += f"| {select_all:<63}|\n"
+        dialog += "|                                                       |\n"
+
+    instance_map = {
+        k.get_service_file_name(): k.get_service_file_name().replace(
+            "klipper", "moonraker"
+        )
+        if k.suffix in [m.suffix for m in moonraker_instances]
+        else ""
+        for k in klipper_instances
+    }
+
+    for i, k in enumerate(instance_map):
+        mr_name = instance_map.get(k)
+        m = f"<-> {mr_name}" if mr_name != "" else ""
+        line = f"{COLOR_CYAN}{f'{i})' if show_index else '●'} {k} {m} {RESET_FORMAT}"
+        dialog += f"| {line:<63}|\n"
+
+    warn_l1 = f"{COLOR_YELLOW}PLEASE NOTE: {RESET_FORMAT}"
+    warn_l2 = f"{COLOR_YELLOW}If you select an instance with an existing Moonraker{RESET_FORMAT}"
+    warn_l3 = f"{COLOR_YELLOW}instance, that Moonraker instance will be re-created!{RESET_FORMAT}"
+    warning = textwrap.dedent(
+        f"""
+        |                                                       |
+        |-------------------------------------------------------|
+        | {warn_l1:<63}|
+        | {warn_l2:<63}|
+        | {warn_l3:<63}|
+        """
+    )[1:]
+
+    dialog += warning
+
+    print(dialog, end="")
+    print_back_footer()

kiauh/components/moonraker/moonraker_remove.py

@@ -0,0 +1,155 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import shutil
+import subprocess
+from typing import List, Union
+
+from kiauh.core.instance_manager.instance_manager import InstanceManager
+from kiauh.components.klipper.klipper_dialogs import print_instance_overview
+from kiauh.components.moonraker import MOONRAKER_DIR, MOONRAKER_ENV_DIR
+from kiauh.components.moonraker.moonraker import Moonraker
+from kiauh.utils.filesystem_utils import remove_file
+from kiauh.utils.input_utils import get_selection_input
+from kiauh.utils.logger import Logger
+
+
+def run_moonraker_removal(
+    remove_service: bool,
+    remove_dir: bool,
+    remove_env: bool,
+    remove_polkit: bool,
+    delete_logs: bool,
+) -> None:
+    im = InstanceManager(Moonraker)
+
+    if remove_service:
+        Logger.print_status("Removing Moonraker instances ...")
+        if im.instances:
+            instances_to_remove = select_instances_to_remove(im.instances)
+            remove_instances(im, instances_to_remove)
+        else:
+            Logger.print_info("No Moonraker Services installed! Skipped ...")
+
+    if (remove_polkit or remove_dir or remove_env) and im.instances:
+        Logger.print_warn("There are still other Moonraker services installed!")
+        Logger.print_warn("Therefor the following parts cannot be removed:")
+        Logger.print_warn(
+            """
+            ● Moonraker PolicyKit rules
+            ● Moonraker local repository
+            ● Moonraker Python environment
+            """,
+            False,
+        )
+    else:
+        if remove_polkit:
+            Logger.print_status("Removing all Moonraker policykit rules ...")
+            remove_polkit_rules()
+        if remove_dir:
+            Logger.print_status("Removing Moonraker local repository ...")
+            remove_moonraker_dir()
+        if remove_env:
+            Logger.print_status("Removing Moonraker Python environment ...")
+            remove_moonraker_env()
+
+    # delete moonraker logs of all instances
+    if delete_logs:
+        Logger.print_status("Removing all Moonraker logs ...")
+        delete_moonraker_logs(im.instances)
+
+
+def select_instances_to_remove(
+    instances: List[Moonraker],
+) -> Union[List[Moonraker], None]:
+    print_instance_overview(instances, True, True)
+
+    options = [str(i) for i in range(len(instances))]
+    options.extend(["a", "A", "b", "B"])
+
+    selection = get_selection_input("Select Moonraker instance to remove", options)
+
+    instances_to_remove = []
+    if selection == "b".lower():
+        return None
+    elif selection == "a".lower():
+        instances_to_remove.extend(instances)
+    else:
+        instance = instances[int(selection)]
+        instances_to_remove.append(instance)
+
+    return instances_to_remove
+
+
+def remove_instances(
+    instance_manager: InstanceManager,
+    instance_list: List[Moonraker],
+) -> None:
+    for instance in instance_list:
+        Logger.print_status(f"Removing instance {instance.get_service_file_name()} ...")
+        instance_manager.current_instance = instance
+        instance_manager.stop_instance()
+        instance_manager.disable_instance()
+        instance_manager.delete_instance()
+
+    instance_manager.reload_daemon()
+
+
+def remove_moonraker_dir() -> None:
+    if not MOONRAKER_DIR.exists():
+        Logger.print_info(f"'{MOONRAKER_DIR}' does not exist. Skipped ...")
+        return
+
+    try:
+        shutil.rmtree(MOONRAKER_DIR)
+    except OSError as e:
+        Logger.print_error(f"Unable to delete '{MOONRAKER_DIR}':\n{e}")
+
+
+def remove_moonraker_env() -> None:
+    if not MOONRAKER_ENV_DIR.exists():
+        Logger.print_info(f"'{MOONRAKER_ENV_DIR}' does not exist. Skipped ...")
+        return
+
+    try:
+        shutil.rmtree(MOONRAKER_ENV_DIR)
+    except OSError as e:
+        Logger.print_error(f"Unable to delete '{MOONRAKER_ENV_DIR}':\n{e}")
+
+
+def remove_polkit_rules() -> None:
+    if not MOONRAKER_DIR.exists():
+        log = "Cannot remove policykit rules. Moonraker directory not found."
+        Logger.print_warn(log)
+        return
+
+    try:
+        command = [f"{MOONRAKER_DIR}/scripts/set-policykit-rules.sh", "--clear"]
+        subprocess.run(
+            command, stderr=subprocess.PIPE, stdout=subprocess.DEVNULL, check=True
+        )
+    except subprocess.CalledProcessError as e:
+        Logger.print_error(f"Error while removing policykit rules: {e}")
+
+    Logger.print_ok("Policykit rules successfully removed!")
+
+
+def delete_moonraker_logs(instances: List[Moonraker]) -> None:
+    all_logfiles = []
+    for instance in instances:
+        all_logfiles = list(instance.log_dir.glob("moonraker.log*"))
+    if not all_logfiles:
+        Logger.print_info("No Moonraker logs found. Skipped ...")
+        return
+
+    for log in all_logfiles:
+        Logger.print_status(f"Remove '{log}'")
+        remove_file(log)

kiauh/components/moonraker/moonraker_setup.py

@@ -0,0 +1,233 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import subprocess
+import sys
+from pathlib import Path
+from typing import List
+
+from kiauh import KIAUH_CFG
+from kiauh.core.backup_manager.backup_manager import BackupManager
+from kiauh.core.config_manager.config_manager import ConfigManager
+from kiauh.core.instance_manager.instance_manager import InstanceManager
+from kiauh.components.klipper.klipper import Klipper
+from kiauh.components.klipper.klipper_dialogs import print_instance_overview
+from kiauh.core.repo_manager.repo_manager import RepoManager
+from kiauh.components.mainsail import MAINSAIL_DIR
+from kiauh.components.mainsail.mainsail_utils import enable_mainsail_remotemode
+from kiauh.components.moonraker import (
+    EXIT_MOONRAKER_SETUP,
+    DEFAULT_MOONRAKER_REPO_URL,
+    MOONRAKER_DIR,
+    MOONRAKER_ENV_DIR,
+    MOONRAKER_REQUIREMENTS_TXT,
+    POLKIT_LEGACY_FILE,
+    POLKIT_FILE,
+    POLKIT_USR_FILE,
+    POLKIT_SCRIPT,
+)
+from kiauh.components.moonraker.moonraker import Moonraker
+from kiauh.components.moonraker.moonraker_dialogs import print_moonraker_overview
+from kiauh.components.moonraker.moonraker_utils import create_example_moonraker_conf
+from kiauh.utils.filesystem_utils import check_file_exist
+from kiauh.utils.input_utils import (
+    get_confirm,
+    get_selection_input,
+)
+from kiauh.utils.logger import Logger
+from kiauh.utils.system_utils import (
+    parse_packages_from_file,
+    create_python_venv,
+    install_python_requirements,
+    update_system_package_lists,
+    install_system_packages,
+)
+
+
+def install_moonraker() -> None:
+    if not check_moonraker_install_requirements():
+        return
+
+    kl_im = InstanceManager(Klipper)
+    klipper_instances = kl_im.instances
+    mr_im = InstanceManager(Moonraker)
+    moonraker_instances = mr_im.instances
+
+    selected_klipper_instance = 0
+    if len(klipper_instances) > 1:
+        print_moonraker_overview(
+            klipper_instances,
+            moonraker_instances,
+            show_index=True,
+            show_select_all=True,
+        )
+        options = [str(i) for i in range(len(klipper_instances))]
+        options.extend(["a", "A", "b", "B"])
+        question = "Select Klipper instance to setup Moonraker for"
+        selected_klipper_instance = get_selection_input(question, options).lower()
+
+    instance_names = []
+    if selected_klipper_instance == "b":
+        Logger.print_status(EXIT_MOONRAKER_SETUP)
+        return
+
+    elif selected_klipper_instance == "a":
+        for instance in klipper_instances:
+            instance_names.append(instance.suffix)
+
+    else:
+        index = int(selected_klipper_instance)
+        instance_names.append(klipper_instances[index].suffix)
+
+    create_example_cfg = get_confirm("Create example moonraker.conf?")
+    setup_moonraker_prerequesites()
+    install_moonraker_polkit()
+
+    used_ports_map = {
+        instance.suffix: instance.port for instance in moonraker_instances
+    }
+    for name in instance_names:
+        current_instance = Moonraker(suffix=name)
+
+        mr_im.current_instance = current_instance
+        mr_im.create_instance()
+        mr_im.enable_instance()
+
+        if create_example_cfg:
+            create_example_moonraker_conf(current_instance, used_ports_map)
+
+        mr_im.start_instance()
+
+    mr_im.reload_daemon()
+
+    # if mainsail is installed, and we installed
+    # multiple moonraker instances, we enable mainsails remote mode
+    if MAINSAIL_DIR.exists() and len(mr_im.instances) > 1:
+        enable_mainsail_remotemode()
+
+
+def check_moonraker_install_requirements() -> bool:
+    if not (sys.version_info.major >= 3 and sys.version_info.minor >= 7):
+        Logger.print_error("Versioncheck failed!")
+        Logger.print_error("Python 3.7 or newer required to run Moonraker.")
+        return False
+
+    kl_instance_count = len(InstanceManager(Klipper).instances)
+    if kl_instance_count < 1:
+        Logger.print_warn("Klipper not installed!")
+        Logger.print_warn("Moonraker cannot be installed! Install Klipper first.")
+        return False
+
+    mr_instance_count = len(InstanceManager(Moonraker).instances)
+    if mr_instance_count >= kl_instance_count:
+        Logger.print_warn("Unable to install more Moonraker instances!")
+        Logger.print_warn("More Klipper instances required.")
+        return False
+
+    return True
+
+
+def setup_moonraker_prerequesites() -> None:
+    cm = ConfigManager(cfg_file=KIAUH_CFG)
+    repo = str(
+        cm.get_value("moonraker", "repository_url") or DEFAULT_MOONRAKER_REPO_URL
+    )
+    branch = str(cm.get_value("moonraker", "branch") or "master")
+
+    repo_manager = RepoManager(
+        repo=repo,
+        branch=branch,
+        target_dir=MOONRAKER_DIR,
+    )
+    repo_manager.clone_repo()
+
+    # install moonraker dependencies and create python virtualenv
+    install_moonraker_packages(MOONRAKER_DIR)
+    create_python_venv(MOONRAKER_ENV_DIR)
+    install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQUIREMENTS_TXT)
+
+
+def install_moonraker_packages(moonraker_dir: Path) -> None:
+    script = moonraker_dir.joinpath("scripts/install-moonraker.sh")
+    packages = parse_packages_from_file(script)
+    update_system_package_lists(silent=False)
+    install_system_packages(packages)
+
+
+def install_moonraker_polkit() -> None:
+    Logger.print_status("Installing Moonraker policykit rules ...")
+
+    legacy_file_exists = check_file_exist(POLKIT_LEGACY_FILE, True)
+    polkit_file_exists = check_file_exist(POLKIT_FILE, True)
+    usr_file_exists = check_file_exist(POLKIT_USR_FILE, True)
+
+    if legacy_file_exists or (polkit_file_exists and usr_file_exists):
+        Logger.print_info("Moonraker policykit rules are already installed.")
+        return
+
+    try:
+        command = [POLKIT_SCRIPT, "--disable-systemctl"]
+        result = subprocess.run(
+            command, stderr=subprocess.PIPE, stdout=subprocess.DEVNULL, text=True
+        )
+        if result.returncode != 0 or result.stderr:
+            Logger.print_error(f"{result.stderr}", False)
+            Logger.print_error("Installing Moonraker policykit rules failed!")
+            return
+
+        Logger.print_ok("Moonraker policykit rules successfully installed!")
+    except subprocess.CalledProcessError as e:
+        log = f"Error while installing Moonraker policykit rules: {e.stderr.decode()}"
+        Logger.print_error(log)
+
+
+def handle_existing_instances(instance_list: List[Klipper]) -> bool:
+    instance_count = len(instance_list)
+
+    if instance_count > 0:
+        print_instance_overview(instance_list)
+        if not get_confirm("Add new instances?", allow_go_back=True):
+            return False
+
+    return True
+
+
+def update_moonraker() -> None:
+    if not get_confirm("Update Moonraker now?"):
+        return
+
+    cm = ConfigManager(cfg_file=KIAUH_CFG)
+    if cm.get_value("kiauh", "backup_before_update"):
+        bm = BackupManager()
+        bm.backup_directory("moonraker", MOONRAKER_DIR)
+        bm.backup_directory("moonraker-env", MOONRAKER_ENV_DIR)
+
+    instance_manager = InstanceManager(Moonraker)
+    instance_manager.stop_all_instance()
+
+    repo = str(
+        cm.get_value("moonraker", "repository_url") or DEFAULT_MOONRAKER_REPO_URL
+    )
+    branch = str(cm.get_value("moonraker", "branch") or "master")
+
+    repo_manager = RepoManager(
+        repo=repo,
+        branch=branch,
+        target_dir=MOONRAKER_DIR,
+    )
+    repo_manager.pull_repo()
+
+    # install possible new system packages
+    install_moonraker_packages(MOONRAKER_DIR)
+    # install possible new python dependencies
+    install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQUIREMENTS_TXT)
+
+    instance_manager.start_all_instance()

kiauh/components/moonraker/moonraker_utils.py

@@ -0,0 +1,134 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import shutil
+from typing import Dict, Literal, List, Union
+
+from kiauh.core.config_manager.config_manager import ConfigManager
+from kiauh.core.instance_manager.instance_manager import InstanceManager
+from kiauh.core.repo_manager.repo_manager import RepoManager
+from kiauh.components.mainsail import MAINSAIL_DIR
+from kiauh.components.mainsail.mainsail_utils import enable_mainsail_remotemode
+from kiauh.components.moonraker import (
+    DEFAULT_MOONRAKER_PORT,
+    MODULE_PATH,
+    MOONRAKER_DIR,
+    MOONRAKER_ENV_DIR,
+)
+from kiauh.components.moonraker.moonraker import Moonraker
+from kiauh.utils.common import get_install_status_common
+from kiauh.utils.logger import Logger
+from kiauh.utils.system_utils import (
+    get_ipv4_addr,
+)
+
+
+def get_moonraker_status() -> (
+    Dict[
+        Literal["status", "status_code", "instances", "repo", "local", "remote"],
+        Union[str, int],
+    ]
+):
+    status = get_install_status_common(Moonraker, MOONRAKER_DIR, MOONRAKER_ENV_DIR)
+    return {
+        "status": status.get("status"),
+        "status_code": status.get("status_code"),
+        "instances": status.get("instances"),
+        "repo": RepoManager.get_repo_name(MOONRAKER_DIR),
+        "local": RepoManager.get_local_commit(MOONRAKER_DIR),
+        "remote": RepoManager.get_remote_commit(MOONRAKER_DIR),
+    }
+
+
+def create_example_moonraker_conf(
+    instance: Moonraker, ports_map: Dict[str, int]
+) -> None:
+    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
+
+    source = MODULE_PATH.joinpath("assets/moonraker.conf")
+    target = instance.cfg_file
+    try:
+        shutil.copy(source, target)
+    except OSError as e:
+        Logger.print_error(f"Unable to create example moonraker.conf:\n{e}")
+        return
+
+    ports = [
+        ports_map.get(instance)
+        for instance in ports_map
+        if ports_map.get(instance) is not None
+    ]
+    if ports_map.get(instance.suffix) is None:
+        # this could be improved to not increment the max value of the ports list and assign it as the port
+        # as it can lead to situation where the port for e.g. instance moonraker-2 becomes 7128 if the port
+        # of moonraker-1 is 7125 and moonraker-3 is 7127 and there are moonraker.conf files for moonraker-1
+        # and moonraker-3 already. though, there does not seem to be a very reliable way of always assigning
+        # the correct port to each instance and the user will likely be required to correct the value manually.
+        port = max(ports) + 1 if ports else DEFAULT_MOONRAKER_PORT
+    else:
+        port = ports_map.get(instance.suffix)
+
+    ports_map[instance.suffix] = port
+
+    ip = get_ipv4_addr().split(".")[:2]
+    ip.extend(["0", "0/16"])
+    uds = instance.comms_dir.joinpath("klippy.sock")
+
+    cm = ConfigManager(target)
+    trusted_clients = f"\n{'.'.join(ip)}"
+    trusted_clients += cm.get_value("authorization", "trusted_clients")
+
+    cm.set_value("server", "port", str(port))
+    cm.set_value("server", "klippy_uds_address", str(uds))
+    cm.set_value("authorization", "trusted_clients", trusted_clients)
+
+    cm.write_config()
+    Logger.print_ok(f"Example moonraker.conf created in '{instance.cfg_dir}'")
+
+
+def moonraker_to_multi_conversion(new_name: str) -> None:
+    """
+    Converts the first instance in the List of Moonraker instances to an instance
+    with a new name. This method will be called when converting from a single Klipper
+    instance install to a multi instance install when Moonraker is also already
+    installed with a single instance.
+    :param new_name: new name the previous single instance is renamed to
+    :return: None
+    """
+    im = InstanceManager(Moonraker)
+    instances: List[Moonraker] = im.instances
+    if not instances:
+        return
+
+    # in case there are multiple Moonraker instances, we don't want to do anything
+    if len(instances) > 1:
+        Logger.print_info("More than a single Moonraker instance found. Skipped ...")
+        return
+
+    Logger.print_status("Convert Moonraker single to multi instance ...")
+    # remove the old single instance
+    im.current_instance = im.instances[0]
+    im.stop_instance()
+    im.disable_instance()
+    im.delete_instance()
+    # create a new klipper instance with the new name
+    im.current_instance = Moonraker(suffix=new_name)
+    # create, enable and start the new moonraker instance
+    im.create_instance()
+    im.enable_instance()
+    im.start_instance()
+
+    # if mainsail is installed, we enable mainsails remote mode
+    if MAINSAIL_DIR.exists() and len(im.instances) > 1:
+        enable_mainsail_remotemode()

kiauh/core/backup_manager/backup_manager.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import shutil
+from pathlib import Path
+from typing import List
+
+from kiauh import KIAUH_BACKUP_DIR
+from kiauh.utils.common import get_current_date
+from kiauh.utils.logger import Logger
+
+
+# noinspection PyMethodMayBeStatic
+class BackupManager:
+    def __init__(self, backup_root_dir: Path = KIAUH_BACKUP_DIR):
+        self._backup_root_dir = backup_root_dir
+
+    @property
+    def backup_root_dir(self) -> Path:
+        return self._backup_root_dir
+
+    @backup_root_dir.setter
+    def backup_root_dir(self, value: Path):
+        self._backup_root_dir = value
+
+    def backup_file(
+        self, files: List[Path] = None, target: Path = None, custom_filename=None
+    ):
+        if not files:
+            raise ValueError("Parameter 'files' cannot be None or an empty List!")
+
+        target = self.backup_root_dir if target is None else target
+        for file in files:
+            Logger.print_status(f"Creating backup of {file} ...")
+            if Path(file).is_file():
+                date = get_current_date().get("date")
+                time = get_current_date().get("time")
+                filename = f"{file.stem}-{date}-{time}{file.suffix}"
+                filename = custom_filename if custom_filename is not None else filename
+                try:
+                    Path(target).mkdir(exist_ok=True)
+                    shutil.copyfile(file, target.joinpath(filename))
+                except OSError as e:
+                    Logger.print_error(f"Unable to backup '{file}':\n{e}")
+                    continue
+            else:
+                Logger.print_info(f"File '{file}' not found ...")
+
+    def backup_directory(self, name: str, source: Path, target: Path = None) -> None:
+        if source is None or not Path(source).exists():
+            raise OSError
+
+        target = self.backup_root_dir if target is None else target
+        try:
+            log = f"Creating backup of {name} in {target} ..."
+            Logger.print_status(log)
+            date = get_current_date().get("date")
+            time = get_current_date().get("time")
+            shutil.copytree(source, target.joinpath(f"{name}-{date}-{time}"))
+        except OSError as e:
+            Logger.print_error(f"Unable to backup directory '{source}':\n{e}")
+            return
+
+        Logger.print_ok("Backup successfull!")

kiauh/core/base_extension.py

@@ -0,0 +1,32 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from abc import abstractmethod, ABC
+from typing import Dict
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class BaseExtension(ABC):
+    def __init__(self, metadata: Dict[str, str]):
+        self.metadata = metadata
+
+    @abstractmethod
+    def install_extension(self, **kwargs) -> None:
+        raise NotImplementedError(
+            "Subclasses must implement the install_extension method"
+        )
+
+    @abstractmethod
+    def remove_extension(self, **kwargs) -> None:
+        raise NotImplementedError(
+            "Subclasses must implement the remove_extension method"
+        )

kiauh/core/config_manager/config_manager.py

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

kiauh/core/instance_manager/base_instance.py

@@ -0,0 +1,161 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from abc import abstractmethod, ABC
+from pathlib import Path
+from typing import List, Type, TypeVar
+
+from kiauh.utils.constants import SYSTEMD, CURRENT_USER
+
+B = TypeVar(name="B", bound="BaseInstance", covariant=True)
+
+
+class BaseInstance(ABC):
+    @classmethod
+    def blacklist(cls) -> List[str]:
+        return []
+
+    def __init__(
+        self,
+        suffix: str,
+        instance_type: B = B,
+    ):
+        self._instance_type = instance_type
+        self._suffix = suffix
+        self._user = CURRENT_USER
+        self._data_dir_name = self.get_data_dir_name_from_suffix()
+        self._data_dir = Path.home().joinpath(f"{self._data_dir_name}_data")
+        self._cfg_dir = self.data_dir.joinpath("config")
+        self._log_dir = self.data_dir.joinpath("logs")
+        self._comms_dir = self.data_dir.joinpath("comms")
+        self._sysd_dir = self.data_dir.joinpath("systemd")
+        self._gcodes_dir = self.data_dir.joinpath("gcodes")
+
+    @property
+    def instance_type(self) -> Type["BaseInstance"]:
+        return self._instance_type
+
+    @instance_type.setter
+    def instance_type(self, value: Type["BaseInstance"]) -> None:
+        self._instance_type = value
+
+    @property
+    def suffix(self) -> str:
+        return self._suffix
+
+    @suffix.setter
+    def suffix(self, value: str) -> None:
+        self._suffix = value
+
+    @property
+    def user(self) -> str:
+        return self._user
+
+    @user.setter
+    def user(self, value: str) -> None:
+        self._user = value
+
+    @property
+    def data_dir_name(self) -> str:
+        return self._data_dir_name
+
+    @data_dir_name.setter
+    def data_dir_name(self, value: str) -> None:
+        self._data_dir_name = value
+
+    @property
+    def data_dir(self) -> Path:
+        return self._data_dir
+
+    @data_dir.setter
+    def data_dir(self, value: str) -> None:
+        self._data_dir = value
+
+    @property
+    def cfg_dir(self) -> Path:
+        return self._cfg_dir
+
+    @cfg_dir.setter
+    def cfg_dir(self, value: str) -> None:
+        self._cfg_dir = value
+
+    @property
+    def log_dir(self) -> Path:
+        return self._log_dir
+
+    @log_dir.setter
+    def log_dir(self, value: str) -> None:
+        self._log_dir = value
+
+    @property
+    def comms_dir(self) -> Path:
+        return self._comms_dir
+
+    @comms_dir.setter
+    def comms_dir(self, value: str) -> None:
+        self._comms_dir = value
+
+    @property
+    def sysd_dir(self) -> Path:
+        return self._sysd_dir
+
+    @sysd_dir.setter
+    def sysd_dir(self, value: str) -> None:
+        self._sysd_dir = value
+
+    @property
+    def gcodes_dir(self) -> Path:
+        return self._gcodes_dir
+
+    @gcodes_dir.setter
+    def gcodes_dir(self, value: str) -> None:
+        self._gcodes_dir = value
+
+    @abstractmethod
+    def create(self) -> None:
+        raise NotImplementedError("Subclasses must implement the create method")
+
+    @abstractmethod
+    def delete(self) -> None:
+        raise NotImplementedError("Subclasses must implement the delete method")
+
+    def create_folders(self, add_dirs: List[Path] = None) -> None:
+        dirs = [
+            self.data_dir,
+            self.cfg_dir,
+            self.log_dir,
+            self.comms_dir,
+            self.sysd_dir,
+        ]
+
+        if add_dirs:
+            dirs.extend(add_dirs)
+
+        for _dir in dirs:
+            _dir.mkdir(exist_ok=True)
+
+    def get_service_file_name(self, extension: bool = False) -> str:
+        name = f"{self.__class__.__name__.lower()}"
+        if self.suffix != "":
+            name += f"-{self.suffix}"
+
+        return name if not extension else f"{name}.service"
+
+    def get_service_file_path(self) -> Path:
+        return SYSTEMD.joinpath(self.get_service_file_name(extension=True))
+
+    def get_data_dir_name_from_suffix(self) -> str:
+        if self._suffix == "":
+            return "printer"
+        elif self._suffix.isdigit():
+            return f"printer_{self._suffix}"
+        else:
+            return self._suffix

kiauh/core/instance_manager/instance_manager.py

@@ -0,0 +1,214 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import re
+import subprocess
+from pathlib import Path
+from typing import List, Optional, Union, TypeVar
+
+from kiauh.core.instance_manager.base_instance import BaseInstance
+from kiauh.utils.constants import SYSTEMD
+from kiauh.utils.logger import Logger
+
+
+I = TypeVar(name="I", bound=BaseInstance, covariant=True)
+
+
+# noinspection PyMethodMayBeStatic
+class InstanceManager:
+    def __init__(self, instance_type: I) -> None:
+        self._instance_type = instance_type
+        self._current_instance: Optional[I] = None
+        self._instance_suffix: Optional[str] = None
+        self._instance_service: Optional[str] = None
+        self._instance_service_full: Optional[str] = None
+        self._instance_service_path: Optional[str] = None
+        self._instances: List[I] = []
+
+    @property
+    def instance_type(self) -> I:
+        return self._instance_type
+
+    @instance_type.setter
+    def instance_type(self, value: I):
+        self._instance_type = value
+
+    @property
+    def current_instance(self) -> I:
+        return self._current_instance
+
+    @current_instance.setter
+    def current_instance(self, value: I) -> None:
+        self._current_instance = value
+        self.instance_suffix = value.suffix
+        self.instance_service = value.get_service_file_name()
+        self.instance_service_path = value.get_service_file_path()
+
+    @property
+    def instance_suffix(self) -> str:
+        return self._instance_suffix
+
+    @instance_suffix.setter
+    def instance_suffix(self, value: str):
+        self._instance_suffix = value
+
+    @property
+    def instance_service(self) -> str:
+        return self._instance_service
+
+    @instance_service.setter
+    def instance_service(self, value: str):
+        self._instance_service = value
+
+    @property
+    def instance_service_full(self) -> str:
+        return f"{self._instance_service}.service"
+
+    @property
+    def instance_service_path(self) -> str:
+        return self._instance_service_path
+
+    @instance_service_path.setter
+    def instance_service_path(self, value: str):
+        self._instance_service_path = value
+
+    @property
+    def instances(self) -> List[I]:
+        return self.find_instances()
+
+    @instances.setter
+    def instances(self, value: List[I]):
+        self._instances = value
+
+    def create_instance(self) -> None:
+        if self.current_instance is not None:
+            try:
+                self.current_instance.create()
+            except (OSError, subprocess.CalledProcessError) as e:
+                Logger.print_error(f"Creating instance failed: {e}")
+                raise
+        else:
+            raise ValueError("current_instance cannot be None")
+
+    def delete_instance(self) -> None:
+        if self.current_instance is not None:
+            try:
+                self.current_instance.delete()
+            except (OSError, subprocess.CalledProcessError) as e:
+                Logger.print_error(f"Removing instance failed: {e}")
+                raise
+        else:
+            raise ValueError("current_instance cannot be None")
+
+    def enable_instance(self) -> None:
+        Logger.print_status(f"Enabling {self.instance_service_full} ...")
+        try:
+            command = ["sudo", "systemctl", "enable", self.instance_service_full]
+            if subprocess.run(command, check=True):
+                Logger.print_ok(f"{self.instance_service_full} enabled.")
+        except subprocess.CalledProcessError as e:
+            Logger.print_error(f"Error enabling service {self.instance_service_full}:")
+            Logger.print_error(f"{e}")
+
+    def disable_instance(self) -> None:
+        Logger.print_status(f"Disabling {self.instance_service_full} ...")
+        try:
+            command = ["sudo", "systemctl", "disable", self.instance_service_full]
+            if subprocess.run(command, check=True):
+                Logger.print_ok(f"{self.instance_service_full} disabled.")
+        except subprocess.CalledProcessError as e:
+            Logger.print_error(f"Error disabling {self.instance_service_full}:")
+            Logger.print_error(f"{e}")
+
+    def start_instance(self) -> None:
+        Logger.print_status(f"Starting {self.instance_service_full} ...")
+        try:
+            command = ["sudo", "systemctl", "start", self.instance_service_full]
+            if subprocess.run(command, check=True):
+                Logger.print_ok(f"{self.instance_service_full} started.")
+        except subprocess.CalledProcessError as e:
+            Logger.print_error(f"Error starting {self.instance_service_full}:")
+            Logger.print_error(f"{e}")
+
+    def restart_instance(self) -> None:
+        Logger.print_status(f"Restarting {self.instance_service_full} ...")
+        try:
+            command = ["sudo", "systemctl", "restart", self.instance_service_full]
+            if subprocess.run(command, check=True):
+                Logger.print_ok(f"{self.instance_service_full} restarted.")
+        except subprocess.CalledProcessError as e:
+            Logger.print_error(f"Error restarting {self.instance_service_full}:")
+            Logger.print_error(f"{e}")
+
+    def start_all_instance(self) -> None:
+        for instance in self.instances:
+            self.current_instance = instance
+            self.start_instance()
+
+    def restart_all_instance(self) -> None:
+        for instance in self.instances:
+            self.current_instance = instance
+            self.restart_instance()
+
+    def stop_instance(self) -> None:
+        Logger.print_status(f"Stopping {self.instance_service_full} ...")
+        try:
+            command = ["sudo", "systemctl", "stop", self.instance_service_full]
+            if subprocess.run(command, check=True):
+                Logger.print_ok(f"{self.instance_service_full} stopped.")
+        except subprocess.CalledProcessError as e:
+            Logger.print_error(f"Error stopping {self.instance_service_full}:")
+            Logger.print_error(f"{e}")
+            raise
+
+    def stop_all_instance(self) -> None:
+        for instance in self.instances:
+            self.current_instance = instance
+            self.stop_instance()
+
+    def reload_daemon(self) -> None:
+        Logger.print_status("Reloading systemd manager configuration ...")
+        try:
+            command = ["sudo", "systemctl", "daemon-reload"]
+            if subprocess.run(command, check=True):
+                Logger.print_ok("Systemd manager configuration reloaded")
+        except subprocess.CalledProcessError as e:
+            Logger.print_error("Error reloading systemd manager configuration:")
+            Logger.print_error(f"{e}")
+            raise
+
+    def find_instances(self) -> List[I]:
+        name = self.instance_type.__name__.lower()
+        pattern = re.compile(f"^{name}(-[0-9a-zA-Z]+)?.service$")
+        excluded = self.instance_type.blacklist()
+
+        service_list = [
+            Path(SYSTEMD, service)
+            for service in SYSTEMD.iterdir()
+            if pattern.search(service.name)
+            and not any(s in service.name for s in excluded)
+        ]
+
+        instance_list = [
+            self.instance_type(suffix=self._get_instance_suffix(service))
+            for service in service_list
+        ]
+
+        return sorted(instance_list, key=lambda x: self._sort_instance_list(x.suffix))
+
+    def _get_instance_suffix(self, file_path: Path) -> str:
+        return file_path.stem.split("-")[-1] if "-" in file_path.stem else ""
+
+    def _sort_instance_list(self, s: Union[int, str, None]):
+        if s is None:
+            return
+
+        return int(s) if s.isdigit() else s

kiauh/core/instance_manager/name_scheme.py

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

kiauh/core/menus/__init__.py

@@ -0,0 +1,14 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+QUIT_FOOTER = "quit"
+BACK_FOOTER = "back"
+BACK_HELP_FOOTER = "back_help"

kiauh/core/menus/advanced_menu.py

@@ -0,0 +1,42 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import textwrap
+
+from kiauh.core.menus import BACK_FOOTER
+from kiauh.core.menus.base_menu import BaseMenu
+from kiauh.utils.constants import COLOR_YELLOW, RESET_FORMAT
+
+
+class AdvancedMenu(BaseMenu):
+    def __init__(self):
+        super().__init__(header=True, options={}, footer_type=BACK_FOOTER)
+
+    def print_menu(self):
+        header = " [ Advanced Menu ] "
+        color = COLOR_YELLOW
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            /=======================================================\\
+            | {color}{header:~^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            | Klipper & API:          | Mainsail:                   |
+            |  0) [Rollback]          |  5) [Theme installer]       |
+            |                         |                             |
+            | Firmware:               | System:                     |
+            |  1) [Build only]        |  6) [Change hostname]       |
+            |  2) [Flash only]        |                             |
+            |  3) [Build + Flash]     | Extras:                     |
+            |  4) [Get MCU ID]        |  7) [G-Code Shell Command]  |
+            """
+        )[1:]
+        print(menu, end="")

kiauh/core/menus/base_menu.py

@@ -0,0 +1,189 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import subprocess
+import sys
+import textwrap
+from abc import abstractmethod, ABC
+from typing import Dict, Any, Literal, Union, Callable, Type
+
+from kiauh.core.menus import QUIT_FOOTER, BACK_FOOTER, BACK_HELP_FOOTER
+from kiauh.utils.constants import (
+    COLOR_GREEN,
+    COLOR_YELLOW,
+    COLOR_RED,
+    COLOR_CYAN,
+    RESET_FORMAT,
+)
+from kiauh.utils.logger import Logger
+
+
+def clear():
+    subprocess.call("clear", shell=True)
+
+
+def print_header():
+    line1 = " [ KIAUH ] "
+    line2 = "Klipper Installation And Update Helper"
+    line3 = ""
+    color = COLOR_CYAN
+    count = 62 - len(color) - len(RESET_FORMAT)
+    header = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        | {color}{line1:~^{count}}{RESET_FORMAT} |
+        | {color}{line2:^{count}}{RESET_FORMAT} |
+        | {color}{line3:~^{count}}{RESET_FORMAT} |
+        \=======================================================/
+        """
+    )[1:]
+    print(header, end="")
+
+
+def print_quit_footer():
+    text = "Q) Quit"
+    color = COLOR_RED
+    count = 62 - len(color) - len(RESET_FORMAT)
+    footer = textwrap.dedent(
+        f"""
+        |-------------------------------------------------------|
+        | {color}{text:^{count}}{RESET_FORMAT} |
+        \=======================================================/
+        """
+    )[1:]
+    print(footer, end="")
+
+
+def print_back_footer():
+    text = "B) « Back"
+    color = COLOR_GREEN
+    count = 62 - len(color) - len(RESET_FORMAT)
+    footer = textwrap.dedent(
+        f"""
+        |-------------------------------------------------------|
+        | {color}{text:^{count}}{RESET_FORMAT} |
+        \=======================================================/
+        """
+    )[1:]
+    print(footer, end="")
+
+
+def print_back_help_footer():
+    text1 = "B) « Back"
+    text2 = "H) Help [?]"
+    color1 = COLOR_GREEN
+    color2 = COLOR_YELLOW
+    count = 34 - len(color1) - len(RESET_FORMAT)
+    footer = textwrap.dedent(
+        f"""
+        |-------------------------------------------------------|
+        | {color1}{text1:^{count}}{RESET_FORMAT} | {color2}{text2:^{count}}{RESET_FORMAT} |
+        \=======================================================/
+        """
+    )[1:]
+    print(footer, end="")
+
+
+class BaseMenu(ABC):
+    NAVI_OPTIONS = {"quit": ["q"], "back": ["b"], "back_help": ["b", "h"]}
+
+    def __init__(
+        self,
+        options: Dict[str, Union[Callable, Any]],
+        options_offset: int = 0,
+        header: bool = True,
+        footer_type: Literal[
+            "QUIT_FOOTER", "BACK_FOOTER", "BACK_HELP_FOOTER"
+        ] = QUIT_FOOTER,
+    ):
+        self.previous_menu = None
+        self.options = options
+        self.options_offset = options_offset
+        self.header = header
+        self.footer_type = footer_type
+
+    @abstractmethod
+    def print_menu(self) -> None:
+        raise NotImplementedError("Subclasses must implement the print_menu method")
+
+    def print_footer(self) -> None:
+        footer_type_map = {
+            QUIT_FOOTER: print_quit_footer,
+            BACK_FOOTER: print_back_footer,
+            BACK_HELP_FOOTER: print_back_help_footer,
+        }
+        footer_function = footer_type_map.get(self.footer_type, print_quit_footer)
+        footer_function()
+
+    def display(self) -> None:
+        # clear()
+        if self.header:
+            print_header()
+        self.print_menu()
+        self.print_footer()
+
+    def handle_user_input(self) -> str:
+        while True:
+            choice = input(f"{COLOR_CYAN}###### Perform action: {RESET_FORMAT}").lower()
+            option = self.options.get(choice, None)
+
+            has_navi_option = self.footer_type in self.NAVI_OPTIONS
+            user_navigated = choice in self.NAVI_OPTIONS[self.footer_type]
+            if has_navi_option and user_navigated:
+                return choice
+
+            if option is not None:
+                return choice
+            else:
+                Logger.print_error("Invalid input!", False)
+
+    def start(self) -> None:
+        while True:
+            self.display()
+            choice = self.handle_user_input()
+
+            if choice == "q":
+                Logger.print_ok("###### Happy printing!", False)
+                sys.exit(0)
+            elif choice == "b":
+                return
+            elif choice == "h":
+                print("help!")
+            else:
+                self.execute_option(choice)
+
+    def execute_option(self, choice: str) -> None:
+        option = self.options.get(choice, None)
+
+        if isinstance(option, type) and issubclass(option, BaseMenu):
+            self.navigate_to_menu(option, True)
+        elif isinstance(option, BaseMenu):
+            self.navigate_to_menu(option, False)
+        elif callable(option):
+            option(opt_index=choice)
+        elif option is None:
+            raise NotImplementedError(f"No implementation for option {choice}")
+        else:
+            raise TypeError(
+                f"Type {type(option)} of option {choice} not of type BaseMenu or Method"
+            )
+
+    def navigate_to_menu(self, menu, instantiate: bool) -> None:
+        """
+        Method for handling the actual menu switch. Can either take in a menu type or an already
+        instantiated menu class. Use instantiated menu classes only if the menu requires specific input parameters
+        :param menu: A menu type or menu instance
+        :param instantiate: Specify if the menu requires instantiation
+        :return: None
+        """
+        menu = menu() if instantiate else menu
+        menu.previous_menu = self
+        menu.start()

kiauh/core/menus/extensions_menu.py

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

kiauh/core/menus/install_menu.py

@@ -0,0 +1,98 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import textwrap
+
+from kiauh.core.menus import BACK_FOOTER
+from kiauh.core.menus.base_menu import BaseMenu
+from kiauh.components.klipper import klipper_setup
+from kiauh.components.mainsail import mainsail_setup
+from kiauh.components.moonraker import moonraker_setup
+from kiauh.utils.constants import COLOR_GREEN, RESET_FORMAT
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class InstallMenu(BaseMenu):
+    def __init__(self):
+        super().__init__(
+            header=True,
+            options={
+                "1": self.install_klipper,
+                "2": self.install_moonraker,
+                "3": self.install_mainsail,
+                "4": self.install_fluidd,
+                "5": self.install_klipperscreen,
+                "6": self.install_pretty_gcode,
+                "7": self.install_telegram_bot,
+                "8": self.install_obico,
+                "9": self.install_octoeverywhere,
+                "10": self.install_mobileraker,
+                "11": self.install_crowsnest,
+            },
+            footer_type=BACK_FOOTER,
+        )
+
+    def print_menu(self):
+        header = " [ Installation Menu ] "
+        color = COLOR_GREEN
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            /=======================================================\\
+            | {color}{header:~^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            | Firmware & API:          | Other:                     |
+            |  1) [Klipper]            |  6) [PrettyGCode]          |
+            |  2) [Moonraker]          |  7) [Telegram Bot]         |
+            |                          |  8) $(obico_install_title) |
+            | Klipper Webinterface:    |  9) [OctoEverywhere]       |
+            |  3) [Mainsail]           | 10) [Mobileraker]          |
+            |  4) [Fluidd]             |                            |
+            |                          | Webcam Streamer:           |
+            | Touchscreen GUI:         | 11) [Crowsnest]            |
+            |  5) [KlipperScreen]      |                            |
+            """
+        )[1:]
+        print(menu, end="")
+
+    def install_klipper(self, **kwargs):
+        klipper_setup.install_klipper()
+
+    def install_moonraker(self, **kwargs):
+        moonraker_setup.install_moonraker()
+
+    def install_mainsail(self, **kwargs):
+        mainsail_setup.install_mainsail()
+
+    def install_fluidd(self, **kwargs):
+        print("install_fluidd")
+
+    def install_klipperscreen(self, **kwargs):
+        print("install_klipperscreen")
+
+    def install_pretty_gcode(self, **kwargs):
+        print("install_pretty_gcode")
+
+    def install_telegram_bot(self, **kwargs):
+        print("install_telegram_bot")
+
+    def install_obico(self, **kwargs):
+        print("install_obico")
+
+    def install_octoeverywhere(self, **kwargs):
+        print("install_octoeverywhere")
+
+    def install_mobileraker(self, **kwargs):
+        print("install_mobileraker")
+
+    def install_crowsnest(self, **kwargs):
+        print("install_crowsnest")

kiauh/core/menus/main_menu.py

@@ -0,0 +1,129 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import textwrap
+
+from kiauh.core.menus import QUIT_FOOTER
+from kiauh.core.menus.advanced_menu import AdvancedMenu
+from kiauh.core.menus.base_menu import BaseMenu
+from kiauh.core.menus.extensions_menu import ExtensionsMenu
+from kiauh.core.menus.install_menu import InstallMenu
+from kiauh.core.menus.remove_menu import RemoveMenu
+from kiauh.core.menus.settings_menu import SettingsMenu
+from kiauh.core.menus.update_menu import UpdateMenu
+from kiauh.components.klipper.klipper_utils import get_klipper_status
+from kiauh.components.log_uploads.menus.log_upload_menu import LogUploadMenu
+from kiauh.components.mainsail.mainsail_utils import get_mainsail_status
+from kiauh.components.moonraker.moonraker_utils import get_moonraker_status
+from kiauh.utils.constants import (
+    COLOR_MAGENTA,
+    COLOR_CYAN,
+    RESET_FORMAT,
+    COLOR_RED,
+    COLOR_GREEN,
+    COLOR_YELLOW,
+)
+
+
+class MainMenu(BaseMenu):
+    def __init__(self):
+        super().__init__(
+            header=True,
+            options={
+                "0": LogUploadMenu,
+                "1": InstallMenu,
+                "2": UpdateMenu,
+                "3": RemoveMenu,
+                "4": AdvancedMenu,
+                "5": None,
+                "e": ExtensionsMenu,
+                "s": SettingsMenu,
+            },
+            footer_type=QUIT_FOOTER,
+        )
+        self.kl_status = ""
+        self.kl_repo = ""
+        self.mr_status = ""
+        self.mr_repo = ""
+        self.ms_status = ""
+        self.fl_status = ""
+        self.ks_status = ""
+        self.mb_status = ""
+        self.cn_status = ""
+        self.tg_status = ""
+        self.ob_status = ""
+        self.oe_status = ""
+        self.init_status()
+
+    def init_status(self) -> None:
+        status_vars = ["kl", "mr", "ms", "fl", "ks", "mb", "cn", "tg", "ob", "oe"]
+        for var in status_vars:
+            setattr(self, f"{var}_status", f"{COLOR_RED}Not installed!{RESET_FORMAT}")
+
+    def fetch_status(self) -> None:
+        # klipper
+        klipper_status = get_klipper_status()
+        kl_status = klipper_status.get("status")
+        kl_code = klipper_status.get("status_code")
+        kl_instances = f" {klipper_status.get('instances')}" if kl_code == 1 else ""
+        self.kl_status = self.format_status_by_code(kl_code, kl_status, kl_instances)
+        self.kl_repo = f"{COLOR_CYAN}{klipper_status.get('repo')}{RESET_FORMAT}"
+        # moonraker
+        moonraker_status = get_moonraker_status()
+        mr_status = moonraker_status.get("status")
+        mr_code = moonraker_status.get("status_code")
+        mr_instances = f" {moonraker_status.get('instances')}" if mr_code == 1 else ""
+        self.mr_status = self.format_status_by_code(mr_code, mr_status, mr_instances)
+        self.mr_repo = f"{COLOR_CYAN}{moonraker_status.get('repo')}{RESET_FORMAT}"
+        # mainsail
+        self.ms_status = get_mainsail_status()
+
+    def format_status_by_code(self, code: int, status: str, count: str) -> str:
+        if code == 1:
+            return f"{COLOR_GREEN}{status}{count}{RESET_FORMAT}"
+        elif code == 2:
+            return f"{COLOR_RED}{status}{count}{RESET_FORMAT}"
+
+        return f"{COLOR_YELLOW}{status}{count}{RESET_FORMAT}"
+
+    def print_menu(self):
+        self.fetch_status()
+
+        header = " [ Main Menu ] "
+        footer1 = "KIAUH v6.0.0"
+        footer2 = f"Changelog: {COLOR_MAGENTA}https://git.io/JnmlX{RESET_FORMAT}"
+        color = COLOR_CYAN
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            /=======================================================\\
+            | {color}{header:~^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            |  0) [Log-Upload] |   Klipper: {self.kl_status:<32} |
+            |                  |      Repo: {self.kl_repo:<32} |
+            |  1) [Install]    |------------------------------------|
+            |  2) [Update]     | Moonraker: {self.mr_status:<32} |
+            |  3) [Remove]     |      Repo: {self.mr_repo:<32} |
+            |  4) [Advanced]   |------------------------------------|
+            |  5) [Backup]     |        Mainsail: {self.ms_status:<26} |
+            |                  |          Fluidd: {self.fl_status:<26} |
+            |  E) [Extensions] |   KlipperScreen: {self.ks_status:<26} |
+            |                  |     Mobileraker: {self.mb_status:<26} |
+            |                  |                                    |
+            |                  |       Crowsnest: {self.cn_status:<26} |
+            |                  |    Telegram Bot: {self.tg_status:<26} |
+            |                  |           Obico: {self.ob_status:<26} |
+            |  S) [Settings]   |  OctoEverywhere: {self.oe_status:<26} |
+            |-------------------------------------------------------|
+            | {COLOR_CYAN}{footer1:^16}{RESET_FORMAT} | {footer2:^43} |
+            """
+        )[1:]
+        print(menu, end="")

kiauh/core/menus/remove_menu.py

@@ -0,0 +1,104 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import textwrap
+
+from kiauh.core.menus import BACK_FOOTER
+from kiauh.core.menus.base_menu import BaseMenu
+from kiauh.components.klipper.menus.klipper_remove_menu import KlipperRemoveMenu
+from kiauh.components.mainsail.menus.mainsail_remove_menu import MainsailRemoveMenu
+from kiauh.components.moonraker.menus.moonraker_remove_menu import MoonrakerRemoveMenu
+from kiauh.utils.constants import COLOR_RED, RESET_FORMAT
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class RemoveMenu(BaseMenu):
+    def __init__(self):
+        super().__init__(
+            header=True,
+            options={
+                "1": KlipperRemoveMenu,
+                "2": MoonrakerRemoveMenu,
+                "3": MainsailRemoveMenu,
+                "5": self.remove_fluidd,
+                "6": self.remove_klipperscreen,
+                "7": self.remove_crowsnest,
+                "8": self.remove_mjpgstreamer,
+                "9": self.remove_pretty_gcode,
+                "10": self.remove_telegram_bot,
+                "11": self.remove_obico,
+                "12": self.remove_octoeverywhere,
+                "13": self.remove_mobileraker,
+                "14": self.remove_nginx,
+            },
+            footer_type=BACK_FOOTER,
+        )
+
+    def print_menu(self):
+        header = " [ Remove Menu ] "
+        color = COLOR_RED
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            /=======================================================\\
+            | {color}{header:~^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            | INFO: Configurations and/or any backups will be kept! |
+            |-------------------------------------------------------|
+            | Firmware & API:           | Webcam Streamer:          |
+            |  1) [Klipper]             |  6) [Crowsnest]           |
+            |  2) [Moonraker]           |  7) [MJPG-Streamer]       |
+            |                           |                           |
+            | Klipper Webinterface:     | Other:                    |
+            |  3) [Mainsail]            |  8) [PrettyGCode]         |
+            |  4) [Fluidd]              |  9) [Telegram Bot]        |
+            |                           | 10) [Obico for Klipper]   |
+            | Touchscreen GUI:          | 11) [OctoEverywhere]      |
+            |  5) [KlipperScreen]       | 12) [Mobileraker]         |
+            |                           | 13) [NGINX]               |
+            |                           |                           |
+            """
+        )[1:]
+        print(menu, end="")
+
+    def remove_fluidd(self, **kwargs):
+        print("remove_fluidd")
+
+    def remove_fluidd_config(self, **kwargs):
+        print("remove_fluidd_config")
+
+    def remove_klipperscreen(self, **kwargs):
+        print("remove_klipperscreen")
+
+    def remove_crowsnest(self, **kwargs):
+        print("remove_crowsnest")
+
+    def remove_mjpgstreamer(self, **kwargs):
+        print("remove_mjpgstreamer")
+
+    def remove_pretty_gcode(self, **kwargs):
+        print("remove_pretty_gcode")
+
+    def remove_telegram_bot(self, **kwargs):
+        print("remove_telegram_bot")
+
+    def remove_obico(self, **kwargs):
+        print("remove_obico")
+
+    def remove_octoeverywhere(self, **kwargs):
+        print("remove_octoeverywhere")
+
+    def remove_mobileraker(self, **kwargs):
+        print("remove_mobileraker")
+
+    def remove_nginx(self, **kwargs):
+        print("remove_nginx")

kiauh/core/menus/settings_menu.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from kiauh.core.menus.base_menu import BaseMenu
+
+
+# noinspection PyMethodMayBeStatic
+class SettingsMenu(BaseMenu):
+    def __init__(self):
+        super().__init__(header=True, options={})
+
+    def print_menu(self):
+        print("self")
+
+    def execute_option_p(self):
+        # Implement the functionality for Option P
+        print("Executing Option P")
+
+    def execute_option_q(self):
+        # Implement the functionality for Option Q
+        print("Executing Option Q")
+
+    def execute_option_r(self):
+        # Implement the functionality for Option R
+        print("Executing Option R")

kiauh/core/menus/update_menu.py

@@ -0,0 +1,162 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import textwrap
+
+from kiauh.core.menus import BACK_FOOTER
+from kiauh.core.menus.base_menu import BaseMenu
+from kiauh.components.klipper.klipper_setup import update_klipper
+from kiauh.components.klipper.klipper_utils import (
+    get_klipper_status,
+)
+from kiauh.components.mainsail.mainsail_setup import update_mainsail
+from kiauh.components.mainsail.mainsail_utils import (
+    get_mainsail_local_version,
+    get_mainsail_remote_version,
+)
+from kiauh.components.moonraker.moonraker_setup import update_moonraker
+from kiauh.components.moonraker.moonraker_utils import get_moonraker_status
+from kiauh.utils.constants import COLOR_GREEN, RESET_FORMAT, COLOR_YELLOW, COLOR_WHITE
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class UpdateMenu(BaseMenu):
+    def __init__(self):
+        super().__init__(
+            header=True,
+            options={
+                "0": self.update_all,
+                "1": self.update_klipper,
+                "2": self.update_moonraker,
+                "3": self.update_mainsail,
+                "4": self.update_fluidd,
+                "5": self.update_klipperscreen,
+                "6": self.update_pgc_for_klipper,
+                "7": self.update_telegram_bot,
+                "8": self.update_moonraker_obico,
+                "9": self.update_octoeverywhere,
+                "10": self.update_mobileraker,
+                "11": self.update_crowsnest,
+                "12": self.upgrade_system_packages,
+            },
+            footer_type=BACK_FOOTER,
+        )
+        self.kl_local = f"{COLOR_WHITE}{RESET_FORMAT}"
+        self.kl_remote = f"{COLOR_WHITE}{RESET_FORMAT}"
+        self.mr_local = f"{COLOR_WHITE}{RESET_FORMAT}"
+        self.mr_remote = f"{COLOR_WHITE}{RESET_FORMAT}"
+        self.ms_local = f"{COLOR_WHITE}{RESET_FORMAT}"
+        self.ms_remote = f"{COLOR_WHITE}{RESET_FORMAT}"
+
+    def print_menu(self):
+        self.fetch_update_status()
+
+        header = " [ Update Menu ] "
+        color = COLOR_GREEN
+        count = 62 - len(color) - len(RESET_FORMAT)
+        menu = textwrap.dedent(
+            f"""
+            /=======================================================\\
+            | {color}{header:~^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            |  0) Update all        |               |               |
+            |                       | Current:      | Latest:       |
+            | Klipper & API:        |---------------|---------------|
+            |  1) Klipper           | {self.kl_local:<22} | {self.kl_remote:<22} |
+            |  2) Moonraker         | {self.mr_local:<22} | {self.mr_remote:<22} |
+            |                       |               |               |
+            | Klipper Webinterface: |---------------|---------------|
+            |  3) Mainsail          | {self.ms_local:<22} | {self.ms_remote:<22} |
+            |  4) Fluidd            |               |               |
+            |                       |               |               |
+            | Touchscreen GUI:      |---------------|---------------|
+            |  5) KlipperScreen     |               |               |
+            |                       |               |               |
+            | Other:                |---------------|---------------|
+            |  6) PrettyGCode       |               |               |
+            |  7) Telegram Bot      |               |               |
+            |  8) Obico for Klipper |               |               |
+            |  9) OctoEverywhere    |               |               |
+            | 10) Mobileraker       |               |               |
+            | 11) Crowsnest         |               |               |
+            |                       |-------------------------------|
+            | 12) System            |                               |
+            """
+        )[1:]
+        print(menu, end="")
+
+    def update_all(self, **kwargs):
+        print("update_all")
+
+    def update_klipper(self, **kwargs):
+        update_klipper()
+
+    def update_moonraker(self, **kwargs):
+        update_moonraker()
+
+    def update_mainsail(self, **kwargs):
+        update_mainsail()
+
+    def update_fluidd(self, **kwargs):
+        print("update_fluidd")
+
+    def update_klipperscreen(self, **kwargs):
+        print("update_klipperscreen")
+
+    def update_pgc_for_klipper(self, **kwargs):
+        print("update_pgc_for_klipper")
+
+    def update_telegram_bot(self, **kwargs):
+        print("update_telegram_bot")
+
+    def update_moonraker_obico(self, **kwargs):
+        print("update_moonraker_obico")
+
+    def update_octoeverywhere(self, **kwargs):
+        print("update_octoeverywhere")
+
+    def update_mobileraker(self, **kwargs):
+        print("update_mobileraker")
+
+    def update_crowsnest(self, **kwargs):
+        print("update_crowsnest")
+
+    def upgrade_system_packages(self, **kwargs):
+        print("upgrade_system_packages")
+
+    def fetch_update_status(self):
+        # klipper
+        kl_status = get_klipper_status()
+        self.kl_local = kl_status.get("local")
+        self.kl_remote = kl_status.get("remote")
+        if self.kl_local == self.kl_remote:
+            self.kl_local = f"{COLOR_GREEN}{self.kl_local}{RESET_FORMAT}"
+        else:
+            self.kl_local = f"{COLOR_YELLOW}{self.kl_local}{RESET_FORMAT}"
+        self.kl_remote = f"{COLOR_GREEN}{self.kl_remote}{RESET_FORMAT}"
+        # moonraker
+        mr_status = get_moonraker_status()
+        self.mr_local = mr_status.get("local")
+        self.mr_remote = mr_status.get("remote")
+        if self.mr_local == self.mr_remote:
+            self.mr_local = f"{COLOR_GREEN}{self.mr_local}{RESET_FORMAT}"
+        else:
+            self.mr_local = f"{COLOR_YELLOW}{self.mr_local}{RESET_FORMAT}"
+        self.mr_remote = f"{COLOR_GREEN}{self.mr_remote}{RESET_FORMAT}"
+        # mainsail
+        self.ms_local = get_mainsail_local_version()
+        self.ms_remote = get_mainsail_remote_version()
+        if self.ms_local == self.ms_remote:
+            self.ms_local = f"{COLOR_GREEN}{self.ms_local}{RESET_FORMAT}"
+        else:
+            self.ms_local = f"{COLOR_YELLOW}{self.ms_local}{RESET_FORMAT}"
+        self.ms_remote = f"{COLOR_GREEN}{self.ms_remote}{RESET_FORMAT}"

kiauh/core/repo_manager/repo_manager.py

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

kiauh/extensions/gcode_shell_cmd/__init__.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+
+
+EXT_MODULE_NAME = "gcode_shell_command.py"
+MODULE_PATH = Path(__file__).resolve().parent
+MODULE_ASSETS = MODULE_PATH.joinpath("assets")
+KLIPPER_DIR = Path.home().joinpath("klipper")
+KLIPPER_EXTRAS = KLIPPER_DIR.joinpath("klippy/extras")
+EXTENSION_SRC = MODULE_ASSETS.joinpath(EXT_MODULE_NAME)
+EXTENSION_TARGET_PATH = KLIPPER_EXTRAS.joinpath(EXT_MODULE_NAME)
+EXAMPLE_CFG_SRC = MODULE_ASSETS.joinpath("shell_command.cfg")

kiauh/extensions/gcode_shell_cmd/assets/gcode_shell_command.py

@@ -0,0 +1,87 @@
+# Run a shell command via gcode
+#
+# Copyright (C) 2019  Eric Callahan <arksine.code@gmail.com>
+#
+# This file may be distributed under the terms of the GNU GPLv3 license.
+import os
+import shlex
+import subprocess
+import logging
+
+class ShellCommand:
+    def __init__(self, config):
+        self.name = config.get_name().split()[-1]
+        self.printer = config.get_printer()
+        self.gcode = self.printer.lookup_object('gcode')
+        cmd = config.get('command')
+        cmd = os.path.expanduser(cmd)
+        self.command = shlex.split(cmd)
+        self.timeout = config.getfloat('timeout', 2., above=0.)
+        self.verbose = config.getboolean('verbose', True)
+        self.proc_fd = None
+        self.partial_output = ""
+        self.gcode.register_mux_command(
+            "RUN_SHELL_COMMAND", "CMD", self.name,
+            self.cmd_RUN_SHELL_COMMAND,
+            desc=self.cmd_RUN_SHELL_COMMAND_help)
+
+    def _process_output(self, eventime):
+        if self.proc_fd is None:
+            return
+        try:
+            data = os.read(self.proc_fd, 4096)
+        except Exception:
+            pass
+        data = self.partial_output + data.decode()
+        if '\n' not in data:
+            self.partial_output = data
+            return
+        elif data[-1] != '\n':
+            split = data.rfind('\n') + 1
+            self.partial_output = data[split:]
+            data = data[:split]
+        else:
+            self.partial_output = ""
+        self.gcode.respond_info(data)
+
+    cmd_RUN_SHELL_COMMAND_help = "Run a linux shell command"
+    def cmd_RUN_SHELL_COMMAND(self, params):
+        gcode_params = params.get('PARAMS','')
+        gcode_params = shlex.split(gcode_params)
+        reactor = self.printer.get_reactor()
+        try:
+            proc = subprocess.Popen(
+                self.command + gcode_params, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
+        except Exception:
+            logging.exception(
+                "shell_command: Command {%s} failed" % (self.name))
+            raise self.gcode.error("Error running command {%s}" % (self.name))
+        if self.verbose:
+            self.proc_fd = proc.stdout.fileno()
+            self.gcode.respond_info("Running Command {%s}...:" % (self.name))
+            hdl = reactor.register_fd(self.proc_fd, self._process_output)
+        eventtime = reactor.monotonic()
+        endtime = eventtime + self.timeout
+        complete = False
+        while eventtime < endtime:
+            eventtime = reactor.pause(eventtime + .05)
+            if proc.poll() is not None:
+                complete = True
+                break
+        if not complete:
+            proc.terminate()
+        if self.verbose:
+            if self.partial_output:
+                self.gcode.respond_info(self.partial_output)
+                self.partial_output = ""
+            if complete:
+                msg = "Command {%s} finished\n" % (self.name)
+            else:
+                msg = "Command {%s} timed out" % (self.name)
+            self.gcode.respond_info(msg)
+            reactor.unregister_fd(hdl)
+            self.proc_fd = None
+
+
+def load_config_prefix(config):
+    return ShellCommand(config)

kiauh/extensions/gcode_shell_cmd/assets/shell_command.cfg

@@ -0,0 +1,7 @@
+[gcode_shell_command hello_world]
+command: echo hello world
+timeout: 2.
+verbose: True
+[gcode_macro HELLO_WORLD]
+gcode:
+    RUN_SHELL_COMMAND CMD=hello_world

kiauh/extensions/gcode_shell_cmd/gcode_shell_cmd_extension.py

@@ -0,0 +1,127 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import os
+import shutil
+from typing import List
+
+from kiauh.components.klipper.klipper import Klipper
+from kiauh.core.backup_manager.backup_manager import BackupManager
+from kiauh.core.base_extension import BaseExtension
+from kiauh.core.config_manager.config_manager import ConfigManager
+from kiauh.core.instance_manager.instance_manager import InstanceManager
+from kiauh.extensions.gcode_shell_cmd import (
+    EXTENSION_TARGET_PATH,
+    EXTENSION_SRC,
+    KLIPPER_DIR,
+    EXAMPLE_CFG_SRC,
+    KLIPPER_EXTRAS,
+)
+from kiauh.utils.filesystem_utils import check_file_exist
+from kiauh.utils.input_utils import get_confirm
+from kiauh.utils.logger import Logger
+
+
+# noinspection PyMethodMayBeStatic
+class GcodeShellCmdExtension(BaseExtension):
+    def install_extension(self, **kwargs) -> None:
+        install_example = get_confirm("Create an example shell command?", False, False)
+
+        klipper_dir_exists = check_file_exist(KLIPPER_DIR)
+        if not klipper_dir_exists:
+            Logger.print_warn(
+                "No Klipper directory found! Unable to install extension."
+            )
+            return
+
+        extension_installed = check_file_exist(EXTENSION_TARGET_PATH)
+        overwrite = True
+        if extension_installed:
+            overwrite = get_confirm(
+                "Extension seems to be installed already. Overwrite?", True, False
+            )
+
+        if not overwrite:
+            Logger.print_warn("Installation aborted due to user request.")
+            return
+
+        im = InstanceManager(Klipper)
+        im.stop_all_instance()
+
+        try:
+            Logger.print_status(f"Copy extension to '{KLIPPER_EXTRAS}' ...")
+            shutil.copy(EXTENSION_SRC, EXTENSION_TARGET_PATH)
+        except OSError as e:
+            Logger.print_error(f"Unable to install extension: {e}")
+            return
+
+        if install_example:
+            self.install_example_cfg(im.instances)
+
+        im.start_all_instance()
+
+        Logger.print_ok("Installing G-Code Shell Command extension successfull!")
+
+    def remove_extension(self, **kwargs) -> None:
+        extension_installed = check_file_exist(EXTENSION_TARGET_PATH)
+        if not extension_installed:
+            Logger.print_info("Extension does not seem to be installed! Skipping ...")
+            return
+
+        question = "Do you really want to remove the extension?"
+        if get_confirm(question, True, False):
+            try:
+                Logger.print_status(f"Removing '{EXTENSION_TARGET_PATH}' ...")
+                os.remove(EXTENSION_TARGET_PATH)
+                Logger.print_ok("Extension successfully removed!")
+            except OSError as e:
+                Logger.print_error(f"Unable to remove extension: {e}")
+
+            Logger.print_warn("PLEASE NOTE:")
+            Logger.print_warn(
+                "Remaining gcode shell command will cause Klipper to throw an error."
+            )
+            Logger.print_warn("Make sure to remove them from the printer.cfg!")
+
+    def install_example_cfg(self, instances: List[Klipper]):
+        cfg_dirs = [instance.cfg_dir for instance in instances]
+        # copy extension to klippy/extras
+        for cfg_dir in cfg_dirs:
+            Logger.print_status(f"Create shell_command.cfg in '{cfg_dir}' ...")
+            if check_file_exist(cfg_dir.joinpath("shell_command.cfg")):
+                Logger.print_info("File already exists! Skipping ...")
+                continue
+            try:
+                shutil.copy(EXAMPLE_CFG_SRC, cfg_dir)
+                Logger.print_ok("Done!")
+            except OSError as e:
+                Logger.warn(f"Unable to create example config: {e}")
+
+        # backup each printer.cfg before modification
+        bm = BackupManager()
+        for instance in instances:
+            bm.backup_file(
+                [instance.cfg_file],
+                custom_filename=f"{instance.suffix}.printer.cfg",
+            )
+
+        # add section to printer.cfg if not already defined
+        section = "include shell_command.cfg"
+        cfg_files = [instance.cfg_file for instance in instances]
+        for cfg_file in cfg_files:
+            Logger.print_status(f"Include shell_command.cfg in '{cfg_file}' ...")
+            cm = ConfigManager(cfg_file)
+            if cm.config.has_section(section):
+                Logger.print_info("Section already defined! Skipping ...")
+                continue
+            cm.config.add_section(section)
+            cm.write_config()
+            Logger.print_ok("Done!")

kiauh/extensions/gcode_shell_cmd/metadata.json

@@ -0,0 +1,9 @@
+{
+  "metadata": {
+    "index": 1,
+    "module": "gcode_shell_cmd_extension",
+    "maintained_by": "dw-0",
+    "display_name": "G-Code Shell Command",
+    "description": "Allows to run a shell command from gcode."
+  }
+}

kiauh/main.py

@@ -0,0 +1,20 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from kiauh.core.menus.main_menu import MainMenu
+from kiauh.utils.logger import Logger
+
+
+def main():
+    try:
+        MainMenu().start()
+    except KeyboardInterrupt:
+        Logger.print_ok("\nHappy printing!\n", prefix=False)

kiauh/utils/__init__.py

@@ -0,0 +1,20 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+
+MODULE_PATH = Path(__file__).resolve().parent
+INVALID_CHOICE = "Invalid choice. Please select a valid value."
+
+# ================== 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/assets/common_vars.conf

@@ -0,0 +1,6 @@
+# /etc/nginx/conf.d/common_vars.conf
+
+map $http_upgrade $connection_upgrade {
+    default upgrade;
+    '' close;
+}

kiauh/utils/assets/nginx_cfg

@@ -0,0 +1,96 @@
+# /etc/nginx/sites-available/%NAME%
+
+server {
+    listen %PORT%;
+
+    access_log /var/log/nginx/%NAME%-access.log;
+    error_log /var/log/nginx/%NAME%-error.log;
+
+    # disable this section on smaller hardware like a pi zero
+    gzip on;
+    gzip_vary on;
+    gzip_proxied any;
+    gzip_proxied expired no-cache no-store private auth;
+    gzip_comp_level 4;
+    gzip_buffers 16 8k;
+    gzip_http_version 1.1;
+    gzip_types text/plain text/css text/xml text/javascript application/javascript application/x-javascript application/json application/xml;
+
+    # web_path from %NAME% static files
+    root %ROOT_DIR%;
+
+    index index.html;
+    server_name _;
+
+    # disable max upload size checks
+    client_max_body_size 0;
+
+    # disable proxy request buffering
+    proxy_request_buffering off;
+
+    location / {
+        try_files $uri $uri/ /index.html;
+    }
+
+    location = /index.html {
+        add_header Cache-Control "no-store, no-cache, must-revalidate";
+    }
+
+    location /websocket {
+        proxy_pass http://apiserver/websocket;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection $connection_upgrade;
+        proxy_set_header Host $http_host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_read_timeout 86400;
+    }
+
+    location ~ ^/(printer|api|access|machine|server)/ {
+        proxy_pass http://apiserver$request_uri;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Host $http_host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Scheme $scheme;
+        proxy_read_timeout 600;
+    }
+
+    location /webcam/ {
+        postpone_output 0;
+        proxy_buffering off;
+        proxy_ignore_headers X-Accel-Buffering;
+        access_log off;
+        error_log off;
+        proxy_pass http://mjpgstreamer1/;
+    }
+
+    location /webcam2/ {
+        postpone_output 0;
+        proxy_buffering off;
+        proxy_ignore_headers X-Accel-Buffering;
+        access_log off;
+        error_log off;
+        proxy_pass http://mjpgstreamer2/;
+    }
+
+    location /webcam3/ {
+        postpone_output 0;
+        proxy_buffering off;
+        proxy_ignore_headers X-Accel-Buffering;
+        access_log off;
+        error_log off;
+        proxy_pass http://mjpgstreamer3/;
+    }
+
+    location /webcam4/ {
+        postpone_output 0;
+        proxy_buffering off;
+        proxy_ignore_headers X-Accel-Buffering;
+        access_log off;
+        error_log off;
+        proxy_pass http://mjpgstreamer4/;
+    }
+}

kiauh/utils/assets/upstreams.conf

@@ -0,0 +1,25 @@
+# /etc/nginx/conf.d/upstreams.conf
+upstream apiserver {
+    ip_hash;
+    server 127.0.0.1:7125;
+}
+
+upstream mjpgstreamer1 {
+    ip_hash;
+    server 127.0.0.1:8080;
+}
+
+upstream mjpgstreamer2 {
+    ip_hash;
+    server 127.0.0.1:8081;
+}
+
+upstream mjpgstreamer3 {
+    ip_hash;
+    server 127.0.0.1:8082;
+}
+
+upstream mjpgstreamer4 {
+    ip_hash;
+    server 127.0.0.1:8083;
+}

kiauh/utils/common.py

@@ -0,0 +1,118 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from datetime import datetime
+from pathlib import Path
+from typing import Dict, Literal, List, Type, Union
+
+from kiauh.core.instance_manager.base_instance import BaseInstance
+from kiauh.core.instance_manager.instance_manager import InstanceManager
+from kiauh.utils.constants import (
+    COLOR_CYAN,
+    RESET_FORMAT,
+    COLOR_YELLOW,
+    COLOR_GREEN,
+    COLOR_RED,
+)
+from kiauh.utils.filesystem_utils import check_file_exist
+from kiauh.utils.logger import Logger
+from kiauh.utils.system_utils import check_package_install, install_system_packages
+
+
+def get_current_date() -> Dict[Literal["date", "time"], str]:
+    """
+    Get the current date |
+    :return: Dict holding a date and time key:value pair
+    """
+    now: datetime = datetime.today()
+    date: str = now.strftime("%Y%m%d")
+    time: str = now.strftime("%H%M%S")
+
+    return {"date": date, "time": time}
+
+
+def check_install_dependencies(deps: List[str]) -> None:
+    """
+    Common helper method to check if dependencies are installed
+    and if not, install them automatically |
+    :param deps: List of strings of package names to check if installed
+    :return: None
+    """
+    requirements = check_package_install(deps)
+    if requirements:
+        Logger.print_status("Installing dependencies ...")
+        Logger.print_info("The following packages need installation:")
+        for _ in requirements:
+            print(f"{COLOR_CYAN}● {_}{RESET_FORMAT}")
+        install_system_packages(requirements)
+
+
+def get_install_status_common(
+    instance_type: Type[BaseInstance], repo_dir: Path, env_dir: Path
+) -> Dict[Literal["status", "status_code", "instances"], Union[str, int]]:
+    """
+    Helper method to get the installation status of software components,
+    which only consist of 3 major parts and if those parts exist, the
+    component can be considered as "installed". Typically, Klipper or
+    Moonraker match that criteria.
+    :param instance_type: The component type
+    :param repo_dir: the repository directory
+    :param env_dir: the python environment directory
+    :return: Dictionary with status string, statuscode and instance count
+    """
+    im = InstanceManager(instance_type)
+    instances_exist = len(im.instances) > 0
+    status = [repo_dir.exists(), env_dir.exists(), instances_exist]
+    if all(status):
+        return {
+            "status": "Installed:",
+            "status_code": 1,
+            "instances": len(im.instances),
+        }
+    elif not any(status):
+        return {
+            "status": "Not installed!",
+            "status_code": 2,
+            "instances": len(im.instances),
+        }
+    else:
+        return {
+            "status": "Incomplete!",
+            "status_code": 3,
+            "instances": len(im.instances),
+        }
+
+
+def get_install_status_webui(
+    install_dir: Path, nginx_cfg: Path, upstreams_cfg: Path, common_cfg: Path
+) -> str:
+    """
+    Helper method to get the installation status of webuis
+    like Mainsail or Fluidd |
+    :param install_dir: folder of the static webui files
+    :param nginx_cfg: the webuis NGINX config
+    :param upstreams_cfg: the required upstreams.conf
+    :param common_cfg: the required common_vars.conf
+    :return: formatted string, containing the status
+    """
+    dir_exist = install_dir.exists()
+    nginx_cfg_exist = check_file_exist(nginx_cfg)
+    upstreams_cfg_exist = check_file_exist(upstreams_cfg)
+    common_cfg_exist = check_file_exist(common_cfg)
+    status = [dir_exist, nginx_cfg_exist]
+    general_nginx_status = [upstreams_cfg_exist, common_cfg_exist]
+
+    if all(status) and all(general_nginx_status):
+        return f"{COLOR_GREEN}Installed!{RESET_FORMAT}"
+    elif not all(status):
+        return f"{COLOR_RED}Not installed!{RESET_FORMAT}"
+    else:
+        return f"{COLOR_YELLOW}Incomplete!{RESET_FORMAT}"

kiauh/utils/constants.py

@@ -0,0 +1,26 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import os
+import pwd
+from pathlib import Path
+
+# text colors and formats
+COLOR_WHITE = "\033[37m"  # white
+COLOR_MAGENTA = "\033[35m"  # magenta
+COLOR_GREEN = "\033[92m"  # bright green
+COLOR_YELLOW = "\033[93m"  # bright yellow
+COLOR_RED = "\033[91m"  # bright red
+COLOR_CYAN = "\033[96m"  # bright cyan
+RESET_FORMAT = "\033[0m"  # reset format
+# current user
+CURRENT_USER = pwd.getpwuid(os.getuid())[0]
+SYSTEMD = Path("/etc/systemd/system")

kiauh/utils/filesystem_utils.py

@@ -0,0 +1,135 @@
+#!/usr/bin/env python3
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import shutil
+import subprocess
+from pathlib import Path
+from zipfile import ZipFile
+
+from kiauh.utils import (
+    NGINX_SITES_AVAILABLE,
+    MODULE_PATH,
+    NGINX_CONFD,
+)
+from kiauh.utils.logger import Logger
+
+
+def check_file_exist(file_path: Path, sudo=False) -> bool:
+    """
+    Helper function for checking the existence of a file |
+    :param file_path: the absolute path of the file to check
+    :param sudo: use sudo if required
+    :return: True, if file exists, otherwise False
+    """
+    if sudo:
+        try:
+            command = ["sudo", "find", file_path]
+            subprocess.check_output(command, stderr=subprocess.DEVNULL)
+            return True
+        except subprocess.CalledProcessError:
+            return False
+    else:
+        if file_path.exists():
+            return True
+        else:
+            return False
+
+
+def create_symlink(source: Path, target: Path, sudo=False) -> None:
+    try:
+        cmd = ["ln", "-sf", source, target]
+        if sudo:
+            cmd.insert(0, "sudo")
+        subprocess.run(cmd, stderr=subprocess.PIPE, check=True)
+    except subprocess.CalledProcessError as e:
+        Logger.print_error(f"Failed to create symlink: {e}")
+        raise
+
+
+def remove_file(file_path: Path, sudo=False) -> None:
+    try:
+        cmd = f"{'sudo ' if sudo else ''}rm -f {file_path}"
+        subprocess.run(cmd, stderr=subprocess.PIPE, check=True, shell=True)
+    except subprocess.CalledProcessError as e:
+        log = f"Cannot remove file {file_path}: {e.stderr.decode()}"
+        Logger.print_error(log)
+        raise
+
+
+def unzip(filepath: Path, target_dir: Path) -> None:
+    """
+    Helper function to unzip a zip-archive into a target directory |
+    :param filepath: the path to the zip-file to unzip
+    :param target_dir: the target directory to extract the files into
+    :return: None
+    """
+    with ZipFile(filepath, "r") as _zip:
+        _zip.extractall(target_dir)
+
+
+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]
+        subprocess.run(command, stderr=subprocess.PIPE, check=True)
+    except subprocess.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]
+        subprocess.run(command, stderr=subprocess.PIPE, check=True)
+    except subprocess.CalledProcessError as e:
+        log = f"Unable to create upstreams.conf: {e.stderr.decode()}"
+        Logger.print_error(log)
+        raise
+
+
+def create_nginx_cfg(name: str, port: int, root_dir: Path) -> None:
+    """
+    Creates an NGINX config from a template file and replaces all placeholders
+    :param name: name of the config to create
+    :param port: listen port
+    :param root_dir: directory of the static files
+    :return: None
+    """
+    tmp = Path.home().joinpath(f"{name}.tmp")
+    shutil.copy(MODULE_PATH.joinpath("assets/nginx_cfg"), tmp)
+    with open(tmp, "r+") as f:
+        content = f.read()
+        content = content.replace("%NAME%", name)
+        content = content.replace("%PORT%", str(port))
+        content = content.replace("%ROOT_DIR%", str(root_dir))
+        f.seek(0)
+        f.write(content)
+        f.truncate()
+
+    target = NGINX_SITES_AVAILABLE.joinpath(name)
+    try:
+        command = ["sudo", "mv", tmp, target]
+        subprocess.run(command, stderr=subprocess.PIPE, check=True)
+    except subprocess.CalledProcessError as e:
+        log = f"Unable to create '{target}': {e.stderr.decode()}"
+        Logger.print_error(log)
+        raise

kiauh/utils/input_utils.py

@@ -0,0 +1,148 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from typing import Optional, List, Union
+
+from kiauh.utils import INVALID_CHOICE
+from kiauh.utils.constants import COLOR_CYAN, RESET_FORMAT
+from kiauh.utils.logger import Logger
+
+
+def get_confirm(
+    question: str, default_choice=True, allow_go_back=False
+) -> Union[bool, None]:
+    """
+    Helper method for validating confirmation (yes/no) user input. |
+    :param question: The question to display
+    :param default_choice: A default if input was submitted without input
+    :param allow_go_back: Navigate back to a previous dialog
+    :return: Either True or False, or None on go_back
+    """
+    options_confirm = ["y", "yes"]
+    options_decline = ["n", "no"]
+    options_go_back = ["b", "B"]
+
+    if default_choice:
+        def_choice = "(Y/n)"
+        options_confirm.append("")
+    else:
+        def_choice = "(y/N)"
+        options_decline.append("")
+
+    while True:
+        choice = (
+            input(format_question(question + f" {def_choice}", None)).strip().lower()
+        )
+
+        if choice in options_confirm:
+            return True
+        elif choice in options_decline:
+            return False
+        elif allow_go_back and choice in options_go_back:
+            return None
+        else:
+            Logger.print_error(INVALID_CHOICE)
+
+
+def get_number_input(
+    question: str, min_count: int, max_count=None, default=None, allow_go_back=False
+) -> Union[int, None]:
+    """
+    Helper method to get a number input from the user
+    :param question: The question to display
+    :param min_count: The lowest allowed value
+    :param max_count: The highest allowed value (or None)
+    :param default: Optional default value
+    :param allow_go_back: Navigate back to a previous dialog
+    :return: Either the validated number input, or None on go_back
+    """
+    options_go_back = ["b", "B"]
+    _question = format_question(question, default)
+    while True:
+        _input = input(_question)
+        if allow_go_back and _input in options_go_back:
+            return None
+
+        if _input == "":
+            return default
+
+        try:
+            return validate_number_input(_input, min_count, max_count)
+        except ValueError:
+            Logger.print_error(INVALID_CHOICE)
+
+
+def get_string_input(question: str, exclude=Optional[List], default=None) -> str:
+    """
+    Helper method to get a string input from the user
+    :param question: The question to display
+    :param exclude: List of strings which are not allowed
+    :param default: Optional default value
+    :return: The validated string value
+    """
+    while True:
+        _input = input(format_question(question, default)).strip()
+
+        if _input.isalnum() and _input.lower() not in exclude:
+            return _input
+
+        Logger.print_error(INVALID_CHOICE)
+        if _input in exclude:
+            Logger.print_error("This value is already in use/reserved.")
+
+
+def get_selection_input(question: str, option_list: List, default=None) -> str:
+    """
+    Helper method to get a selection from a list of options from the user
+    :param question: The question to display
+    :param option_list: The list of options the user can select from
+    :param default: Optional default value
+    :return: The option that was selected by the user
+    """
+    while True:
+        _input = input(format_question(question, default)).strip()
+
+        if _input in option_list:
+            return _input
+
+        Logger.print_error(INVALID_CHOICE)
+
+
+def format_question(question: str, default=None) -> str:
+    """
+    Helper method to have a standardized formatting of questions |
+    :param question: The question to display
+    :param default: If defined, the default option will be displayed to the user
+    :return: The formatted question string
+    """
+    formatted_q = question
+    if default is not None:
+        formatted_q += f" (default={default})"
+
+    return f"{COLOR_CYAN}###### {formatted_q}: {RESET_FORMAT}"
+
+
+def validate_number_input(value: str, min_count: int, max_count: int) -> int:
+    """
+    Helper method for a simple number input validation. |
+    :param value: The value to validate
+    :param min_count: The lowest allowed value
+    :param max_count: The highest allowed value (or None)
+    :return: The validated value as Integer
+    :raises: ValueError if value is invalid
+    """
+    if max_count is not None:
+        if min_count <= int(value) <= max_count:
+            return int(value)
+    elif int(value) >= min_count:
+        return int(value)
+
+    raise ValueError

kiauh/utils/logger.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from kiauh.utils.constants import (
+    COLOR_WHITE,
+    COLOR_GREEN,
+    COLOR_YELLOW,
+    COLOR_RED,
+    COLOR_MAGENTA,
+    RESET_FORMAT,
+)
+
+
+class Logger:
+    @staticmethod
+    def info(msg):
+        # log to kiauh.log
+        pass
+
+    @staticmethod
+    def warn(msg):
+        # log to kiauh.log
+        pass
+
+    @staticmethod
+    def error(msg):
+        # log to kiauh.log
+        pass
+
+    @staticmethod
+    def print_info(msg, prefix=True, start="", end="\n") -> None:
+        message = f"[INFO] {msg}" if prefix else msg
+        print(f"{COLOR_WHITE}{start}{message}{RESET_FORMAT}", end=end)
+
+    @staticmethod
+    def print_ok(msg, prefix=True, start="", end="\n") -> None:
+        message = f"[OK] {msg}" if prefix else msg
+        print(f"{COLOR_GREEN}{start}{message}{RESET_FORMAT}", end=end)
+
+    @staticmethod
+    def print_warn(msg, prefix=True, start="", end="\n") -> None:
+        message = f"[WARN] {msg}" if prefix else msg
+        print(f"{COLOR_YELLOW}{start}{message}{RESET_FORMAT}", end=end)
+
+    @staticmethod
+    def print_error(msg, prefix=True, start="", end="\n") -> None:
+        message = f"[ERROR] {msg}" if prefix else msg
+        print(f"{COLOR_RED}{start}{message}{RESET_FORMAT}", end=end)
+
+    @staticmethod
+    def print_status(msg, prefix=True, start="", end="\n") -> None:
+        message = f"\n###### {msg}" if prefix else msg
+        print(f"{COLOR_MAGENTA}{start}{message}{RESET_FORMAT}", end=end)

kiauh/utils/system_utils.py

@@ -0,0 +1,328 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import os
+import shutil
+import socket
+import subprocess
+import sys
+import time
+import urllib.error
+import urllib.request
+import venv
+from pathlib import Path
+from typing import List, Literal
+
+from kiauh.utils.input_utils import get_confirm
+from kiauh.utils.logger import Logger
+
+
+def kill(opt_err_msg: str = "") -> None:
+    """
+    Kills the application |
+    :param opt_err_msg: an optional, additional error message
+    :return: None
+    """
+
+    if opt_err_msg:
+        Logger.print_error(opt_err_msg)
+    Logger.print_error("A critical error has occured. KIAUH was terminated.")
+    sys.exit(1)
+
+
+def parse_packages_from_file(source_file: Path) -> List[str]:
+    """
+    Read the package names from bash scripts, when defined like:
+    PKGLIST="package1 package2 package3" |
+    :param source_file: path of the sourcefile to read from
+    :return: A list of package names
+    """
+
+    packages = []
+    print("Reading dependencies...")
+    with open(source_file, "r") as file:
+        for line in file:
+            line = line.strip()
+            if line.startswith("PKGLIST="):
+                line = line.replace('"', "")
+                line = line.replace("PKGLIST=", "")
+                line = line.replace("${PKGLIST}", "")
+                packages.extend(line.split())
+
+    return packages
+
+
+def create_python_venv(target: Path) -> None:
+    """
+    Create a python 3 virtualenv at the provided target destination |
+    :param target: Path where to create the virtualenv at
+    :return: None
+    """
+    Logger.print_status("Set up Python virtual environment ...")
+    if not target.exists():
+        try:
+            venv.create(target, with_pip=True)
+            Logger.print_ok("Setup of virtualenv successfull!")
+        except OSError as e:
+            Logger.print_error(f"Error setting up virtualenv:\n{e}")
+            raise
+        except subprocess.CalledProcessError as e:
+            Logger.print_error(f"Error setting up virtualenv:\n{e.output.decode()}")
+            raise
+    else:
+        if get_confirm("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 ...")
+
+
+def update_python_pip(target: Path) -> None:
+    """
+    Updates pip in the provided target destination |
+    :param target: Path of the virtualenv
+    :return: None
+    """
+    Logger.print_status("Updating pip ...")
+    try:
+        command = [target.joinpath("bin/pip"), "install", "-U", "pip"]
+        result = subprocess.run(command, stderr=subprocess.PIPE, text=True)
+        if result.returncode != 0 or result.stderr:
+            Logger.print_error(f"{result.stderr}", False)
+            Logger.print_error("Updating pip failed!")
+            return
+
+        Logger.print_ok("Updating pip successfull!")
+    except subprocess.CalledProcessError as e:
+        Logger.print_error(f"Error updating pip:\n{e.output.decode()}")
+
+
+def install_python_requirements(target: Path, requirements: Path) -> None:
+    """
+    Installs the python packages based on a provided requirements.txt |
+    :param target: Path of the virtualenv
+    :param requirements: Path to the requirements.txt file
+    :return: None
+    """
+    update_python_pip(target)
+    Logger.print_status("Installing Python requirements ...")
+    try:
+        command = [target.joinpath("bin/pip"), "install", "-r", f"{requirements}"]
+        result = subprocess.run(command, stderr=subprocess.PIPE, text=True)
+        if result.returncode != 0 or result.stderr:
+            Logger.print_error(f"{result.stderr}", False)
+            Logger.print_error("Installing Python requirements failed!")
+            return
+
+        Logger.print_ok("Installing Python requirements successfull!")
+    except subprocess.CalledProcessError as e:
+        log = f"Error installing Python requirements:\n{e.output.decode()}"
+        Logger.print_error(log)
+        raise
+
+
+def update_system_package_lists(silent: bool, rls_info_change=False) -> None:
+    """
+    Updates the systems package list |
+    :param silent: Log info to the console or not
+    :param rls_info_change: Flag for "--allow-releaseinfo-change"
+    :return: None
+    """
+    cache_mtime = 0
+    cache_files = [
+        Path("/var/lib/apt/periodic/update-success-stamp"),
+        Path("/var/lib/apt/lists"),
+    ]
+    for cache_file in cache_files:
+        if cache_file.exists():
+            cache_mtime = max(cache_mtime, os.path.getmtime(cache_file))
+
+    update_age = int(time.time() - cache_mtime)
+    update_interval = 6 * 3600  # 48hrs
+
+    if update_age <= update_interval:
+        return
+
+    if not silent:
+        Logger.print_status("Updating package list...")
+
+    try:
+        command = ["sudo", "apt-get", "update"]
+        if rls_info_change:
+            command.append("--allow-releaseinfo-change")
+
+        result = subprocess.run(command, stderr=subprocess.PIPE, text=True)
+        if result.returncode != 0 or result.stderr:
+            Logger.print_error(f"{result.stderr}", False)
+            Logger.print_error("Updating system package list failed!")
+            return
+
+        Logger.print_ok("System package list updated successfully!")
+    except subprocess.CalledProcessError as e:
+        kill(f"Error updating system package list:\n{e.stderr.decode()}")
+
+
+def check_package_install(packages: List[str]) -> List[str]:
+    """
+    Checks the system for installed packages |
+    :param packages: List of strings of package names
+    :return: A list containing the names of packages that are not installed
+    """
+    not_installed = []
+    for package in packages:
+        command = ["dpkg-query", "-f'${Status}'", "--show", package]
+        result = subprocess.run(
+            command, stdout=subprocess.PIPE, stderr=subprocess.DEVNULL, text=True
+        )
+        if "installed" not in result.stdout.strip("'").split():
+            not_installed.append(package)
+        else:
+            Logger.print_ok(f"{package} already installed.")
+
+    return not_installed
+
+
+def install_system_packages(packages: List[str]) -> None:
+    """
+    Installs a list of system packages |
+    :param packages: List of system package names
+    :return: None
+    """
+    try:
+        command = ["sudo", "apt-get", "install", "-y"]
+        for pkg in packages:
+            command.append(pkg)
+        subprocess.run(command, stderr=subprocess.PIPE, check=True)
+
+        Logger.print_ok("Packages installed successfully.")
+    except subprocess.CalledProcessError as e:
+        kill(f"Error installing packages:\n{e.stderr.decode()}")
+
+
+def mask_system_service(service_name: str) -> None:
+    """
+    Mask a system service to prevent it from starting |
+    :param service_name: name of the service to mask
+    :return: None
+    """
+    try:
+        command = ["sudo", "systemctl", "mask", service_name]
+        subprocess.run(command, stderr=subprocess.PIPE, check=True)
+    except subprocess.CalledProcessError as e:
+        log = f"Unable to mask system service {service_name}: {e.stderr.decode()}"
+        Logger.print_error(log)
+        raise
+
+
+# this feels hacky and not quite right, but for now it works
+# see: https://stackoverflow.com/questions/166506/finding-local-ip-addresses-using-pythons-stdlib
+def get_ipv4_addr() -> str:
+    """
+    Helper function that returns the IPv4 of the current machine
+    by opening a socket and sending a package to an arbitrary IP. |
+    :return: Local IPv4 of the current machine
+    """
+    s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+    s.settimeout(0)
+    try:
+        # doesn't even have to be reachable
+        s.connect(("192.255.255.255", 1))
+        return s.getsockname()[0]
+    except Exception:
+        return "127.0.0.1"
+    finally:
+        s.close()
+
+
+def download_file(url: str, target: Path, show_progress=True) -> None:
+    """
+    Helper method for downloading files from a provided URL |
+    :param url: the url to the file
+    :param target: the target path incl filename
+    :param show_progress: show download progress or not
+    :return: None
+    """
+    try:
+        if show_progress:
+            urllib.request.urlretrieve(url, target, download_progress)
+            sys.stdout.write("\n")
+        else:
+            urllib.request.urlretrieve(url, target)
+    except urllib.error.HTTPError as e:
+        Logger.print_error(f"Download failed! HTTP error occured: {e}")
+        raise
+    except urllib.error.URLError as e:
+        Logger.print_error(f"Download failed! URL error occured: {e}")
+        raise
+    except Exception as e:
+        Logger.print_error(f"Download failed! An error occured: {e}")
+        raise
+
+
+def download_progress(block_num, block_size, total_size) -> None:
+    """
+    Reporthook method for urllib.request.urlretrieve() method call in download_file() |
+    :param block_num:
+    :param block_size:
+    :param total_size: total filesize in bytes
+    :return: None
+    """
+    downloaded = block_num * block_size
+    percent = 100 if downloaded >= total_size else downloaded / total_size * 100
+    mb = 1024 * 1024
+    progress = int(percent / 5)
+    remaining = "-" * (20 - progress)
+    dl = f"\rDownloading: [{'#' * progress}{remaining}]{percent:.2f}% ({downloaded/mb:.2f}/{total_size/mb:.2f}MB)"
+    sys.stdout.write(dl)
+    sys.stdout.flush()
+
+
+def set_nginx_permissions() -> None:
+    """
+    Check if permissions of the users home directory
+    grant execution rights to group and other and set them if not set.
+    Required permissions for NGINX to be able to serve Mainsail/Fluidd.
+    This seems to have become necessary with Ubuntu 21+. |
+    :return: None
+    """
+    cmd = f"ls -ld {Path.home()} | cut -d' ' -f1"
+    homedir_perm = subprocess.run(cmd, shell=True, stdout=subprocess.PIPE, text=True)
+    homedir_perm = homedir_perm.stdout
+
+    if homedir_perm.count("x") < 3:
+        Logger.print_status("Granting NGINX the required permissions ...")
+        subprocess.run(["chmod", "og+x", Path.home()])
+        Logger.print_ok("Permissions granted.")
+
+
+def control_systemd_service(
+    name: str, action: Literal["start", "stop", "restart", "disable"]
+) -> None:
+    """
+    Helper method to execute several actions for a specific systemd service. |
+    :param name: the service name
+    :param action: Either "start", "stop", "restart" or "disable"
+    :return: None
+    """
+    try:
+        Logger.print_status(f"{action.capitalize()} {name}.service ...")
+        command = ["sudo", "systemctl", action, f"{name}.service"]
+        subprocess.run(command, stderr=subprocess.PIPE, check=True)
+        Logger.print_ok("OK!")
+    except subprocess.CalledProcessError as e:
+        log = f"Failed to {action} {name}.service: {e.stderr.decode()}"
+        Logger.print_error(log)
+        raise

klipper_repos.txt.example

@@ -1,18 +0,0 @@
-# This file acts as an example file.
-#
-# 1) Make a copy of this file and rename it to 'klipper_repos.txt'
-# 2) Add your custom Klipper repository to the bottom of that copy
-# 3) Save the file
-#
-# Back in KIAUH you can now go into -> [Settings] and use action '2' to set a different Klipper repository
-#
-# Make sure to always separate the repository and the branch with a ','.
-# <repository>,<branch> -> https://github.com/Klipper3d/klipper,master
-# If you omit a branch, it will always default to 'master'
-#
-# You are allowed to omit the 'https://github.com/' part of the repository URL
-# Down below are now a few examples of what is considered as valid:
-https://github.com/Klipper3d/klipper,master
-https://github.com/Klipper3d/klipper
-Klipper3d/klipper,master
-Klipper3d/klipper

pyproject.toml

@@ -0,0 +1,13 @@
+[tool.black]
+line-length = 88
+target-version = ['py38']
+include = '\.pyi?$'
+exclude = '''
+(
+      \.git/
+    | \.github/
+    | docs/
+    | resources/
+    | scripts/
+)
+'''