diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..edc4f8a
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+end_of_line = lf
+
+[*.py]
+max_line_length = 88
+
+[*.sh]
+indent_size = 2
diff --git a/.gitignore b/.gitignore
index ce8ca81..bff7f5f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,8 @@
.idea
.vscode
+.pytest_cache
+__pycache__
+.kiauh-env
*.code-workspace
-klipper_repos.txt
+*.iml
+kiauh.cfg
diff --git a/README.md b/README.md
index 1020c7b..74df0a7 100644
--- a/README.md
+++ b/README.md
@@ -159,7 +159,7 @@ prompt and confirm by hitting ENTER.
- |
+ |
 |
 |
@@ -176,6 +176,16 @@ prompt and confirm by hitting ENTER.
+🎖️ Contributors 🎖️
+
+
+
+
+
✨ Credits ✨
* A big thank you to [lixxbox](https://github.com/lixxbox) for that awesome KIAUH-Logo!
diff --git a/default.kiauh.cfg b/default.kiauh.cfg
new file mode 100644
index 0000000..cd36055
--- /dev/null
+++ b/default.kiauh.cfg
@@ -0,0 +1,18 @@
+[kiauh]
+backup_before_update: False
+
+[klipper]
+repo_url: https://github.com/Klipper3d/klipper
+branch: master
+
+[moonraker]
+repo_url: https://github.com/Arksine/moonraker
+branch: master
+
+[mainsail]
+port: 80
+unstable_releases: False
+
+[fluidd]
+port: 81
+unstable_releases: False
diff --git a/docs/changelog.md b/docs/changelog.md
index 7a11382..0699150 100644
--- a/docs/changelog.md
+++ b/docs/changelog.md
@@ -2,13 +2,54 @@
This document covers possible important changes to KIAUH.
+### 2024-08-31 (v6.0.0-alpha.1)
+Long time no see, but here we are again!
+A lot has happened in the background, but now it is time to take it out into the wild.
+
+#### KIAUH has now reached version 6! Well, at least in an alpha state...
+
+The project has seen a complete rewrite of the script from scratch in Python.
+It requires Python 3.8 or newer to run. Because this update is still in an alpha state, bugs may or will occur.
+During startup, you will be asked if you want to start the new version 6 or the old version 5.
+As long as version 6 is in a pre-release state, version 5 will still be available. If there are any critical issues
+with the new version that were overlooked, you can always switch back to the old version.
+
+In case you selected not to get asked about which version to start (option 3 or 4 in the startup dialog) and you want to
+revert that decision, you will find a line called `version_to_launch=` within the `.kiauh.ini` file in your home directory.
+Just delete that line, save the file and restart KIAUH. KIAUH will then ask you again which version you want to start.
+
+Here is a list of the most important changes to KIAUH in regard to version 6:
+- The majority of features available in KIAUH v5 are still available; they just got migrated from Bash to Python.
+- It is now possible to add new/remove instances to/from existing multi-instance installations of Klipper and Moonraker
+- KIAUH now has an Extension-System. This allows contributors to add new installers to KIAUH without having to modify the main script.
+ - You will now find some of the features that were previously available in the Installer-Menu in the Extensions-Menu.
+ - The current extensions are:
+ - G-Code Shell Command (previously found in the Advanced-Menu)
+ - Mainsail Theme Installer (previously found in the Advanced-Menu)
+ - Klipper-Backup (new in v6!)
+ - Moonraker Telegram Bot (previously found in the Installer-Menu)
+ - PrettyGCode for Klipper (previously found in the Installer-Menu)
+ - Obico for Klipper (previously found in the Installer-Menu)
+ - The following additional extensions are planned, but not yet available:
+ - Spoolman (available in v5 in the Installer-Menu)
+ - OctoApp (available in v5 in the Installer-Menu)
+- KIAUH has its own config file now
+ - The file has some default values for the currently supported options
+ - There might be more options in the future
+ - It is located in KIAUH's root directory and is called `default.kiauh.cfg`
+ - DO NOT EDIT the default file directly, instead make a copy of it and call it `kiauh.cfg`
+ - Settings changed via the Advanced-Menu will be written to the `kiauh.cfg`
+- Support for OctoPrint was removed
+
+Feel free to give version 6 a try and report any bugs or issues you encounter! Every feedback is appreciated.
+
### 2023-06-17
-KIAUH has now added support for installing Mobileraker's companion!
+KIAUH has now added support for installing Mobileraker's companion!
Mobileraker is a free and Open Source Android and iOS App for Klipper, utilizing the Moonraker API, allowing you
to control your printer. Thank you to [Clon1998](https://github.com/Clon1998) for adding this feature!
### 2023-02-03
-The installer for MJPG-Streamer got replaced by crowsnest. It is an improved webcam service, utilizing ustreamer.
+The installer for MJPG-Streamer got replaced by crowsnest. It is an improved webcam service, utilizing ustreamer.
Please have a look here for additional info about crowsnest and how to configure it: https://github.com/mainsail-crew/crowsnest \
It's unsure if the previous MJPG-Streamer installer will be updated and make its way back into KIAUH.
A big thanks to [KwadFan](https://github.com/KwadFan) for writing the crowsnest implementation.
@@ -115,7 +156,7 @@ membership for example caused issues when installing mjpg-streamer while not usi
Other issues could occur when trying to flash an MCU on Debian or Ubuntu distributions where a user might not be part
of the dialout group by default. A check for the tty group is also done. The tty group is needed for setting
up a linux MCU (currently not yet supported by KIAUH).
-* There is an issue when trying to install Mainsail or Fluidd on Ubuntu 21.10. Permissions on that distro seem to have seen a rework
+* There is an issue when trying to install Mainsail or Fluidd on Ubuntu 21.10. Permissions on that distro seem to have seen a rework
in comparison to 20.04 and users will be greeted with an "Error 403 - Permission denied" message after installing one of Klippers webinterfaces.
I still have to figure out a viable solution for that.
diff --git a/kiauh.py b/kiauh.py
new file mode 100644
index 0000000..ff930a4
--- /dev/null
+++ b/kiauh.py
@@ -0,0 +1,15 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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()
diff --git a/kiauh.sh b/kiauh.sh
index 35307d2..b5e083d 100755
--- a/kiauh.sh
+++ b/kiauh.sh
@@ -54,6 +54,15 @@ function kiauh_update_avail() {
fi
}
+function save_startup_version() {
+ local launch_version
+
+ echo "${1}"
+
+ sed -i "/^version_to_launch=/d" "${INI_FILE}"
+ sed -i '$a'"version_to_launch=${1}" "${INI_FILE}"
+}
+
function kiauh_update_dialog() {
[[ ! $(kiauh_update_avail) == "true" ]] && return
top_border
@@ -70,20 +79,96 @@ function kiauh_update_dialog() {
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";;
+ Y|y|Yes|yes|"")
+ do_action "update_kiauh"
+ break;;
+ N|n|No|no)
+ break;;
+ *)
+ deny_action "kiauh_update_dialog";;
esac
done
}
+function launch_kiauh_v5() {
+ main_menu
+}
+
+function launch_kiauh_v6() {
+ local entrypoint
+
+ if ! command -v python3 &>/dev/null || [[ $(python3 -V | cut -d " " -f2 | cut -d "." -f2) -lt 8 ]]; then
+ echo "Python 3.8 or higher is not installed!"
+ echo "Please install Python 3.8 or higher and try again."
+ exit 1
+ fi
+
+ entrypoint=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
+
+ export PYTHONPATH="${entrypoint}"
+
+ clear
+ python3 "${entrypoint}/kiauh.py"
+}
+
+function main() {
+ read_kiauh_ini "${FUNCNAME[0]}"
+
+ if [[ ${version_to_launch} -eq 5 ]]; then
+ launch_kiauh_v5
+ elif [[ ${version_to_launch} -eq 6 ]]; then
+ launch_kiauh_v6
+ else
+ top_border
+ echo -e "| ${green}KIAUH v6.0.0-alpha1 is available now!${white} |"
+ hr
+ echo -e "| View Changelog: ${magenta}https://git.io/JnmlX${white} |"
+ blank_line
+ echo -e "| KIAUH v6 was completely rewritten from the ground up. |"
+ echo -e "| It's based on Python 3.8 and has many improvements. |"
+ blank_line
+ echo -e "| ${yellow}NOTE: Version 6 is still in alpha, so bugs may occur!${white} |"
+ echo -e "| ${yellow}Yet, your feedback and bug reports are very much${white} |"
+ echo -e "| ${yellow}appreciated and will help finalize the release.${white} |"
+ hr
+ echo -e "| Would you like to try out KIAUH v6? |"
+ echo -e "| 1) Yes |"
+ echo -e "| 2) No |"
+ echo -e "| 3) Yes, remember my choice for next time |"
+ echo -e "| 4) No, remember my choice for next time |"
+ quit_footer
+ while true; do
+ read -p "${cyan}###### Select action:${white} " -e input
+ case "${input}" in
+ 1)
+ launch_kiauh_v6
+ break;;
+ 2)
+ launch_kiauh_v5
+ break;;
+ 3)
+ save_startup_version 6
+ launch_kiauh_v6
+ break;;
+ 4)
+ save_startup_version 5
+ launch_kiauh_v5
+ break;;
+ Q|q)
+ echo -e "${green}###### Happy printing! ######${white}"; echo
+ exit 0;;
+ *)
+ error_msg "Invalid Input!\n";;
+ esac
+ done && input=""
+ fi
+}
+
check_if_ratos
check_euid
init_logfile
set_globals
kiauh_update_dialog
-main_menu
+read_kiauh_ini
+init_ini
+main
diff --git a/kiauh/__init__.py b/kiauh/__init__.py
new file mode 100644
index 0000000..5c08988
--- /dev/null
+++ b/kiauh/__init__.py
@@ -0,0 +1,15 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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 sys
+from pathlib import Path
+
+PROJECT_ROOT = Path(__file__).resolve().parent.parent
+APPLICATION_ROOT = Path(__file__).resolve().parent
+sys.path.append(str(APPLICATION_ROOT))
diff --git a/kiauh/components/__init__.py b/kiauh/components/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/kiauh/components/crowsnest/__init__.py b/kiauh/components/crowsnest/__init__.py
new file mode 100644
index 0000000..aa95234
--- /dev/null
+++ b/kiauh/components/crowsnest/__init__.py
@@ -0,0 +1,30 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+
+from pathlib import Path
+
+from core.backup_manager import BACKUP_ROOT_DIR
+from core.constants import SYSTEMD
+
+# repo
+CROWSNEST_REPO = "https://github.com/mainsail-crew/crowsnest.git"
+
+# names
+CROWSNEST_SERVICE_NAME = "crowsnest.service"
+
+# directories
+CROWSNEST_DIR = Path.home().joinpath("crowsnest")
+CROWSNEST_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("crowsnest-backups")
+
+# files
+CROWSNEST_MULTI_CONFIG = CROWSNEST_DIR.joinpath("tools/.config")
+CROWSNEST_INSTALL_SCRIPT = CROWSNEST_DIR.joinpath("tools/install.sh")
+CROWSNEST_BIN_FILE = Path("/usr/local/bin/crowsnest")
+CROWSNEST_LOGROTATE_FILE = Path("/etc/logrotate.d/crowsnest")
+CROWSNEST_SERVICE_FILE = SYSTEMD.joinpath(CROWSNEST_SERVICE_NAME)
diff --git a/kiauh/components/crowsnest/crowsnest.py b/kiauh/components/crowsnest/crowsnest.py
new file mode 100644
index 0000000..085a9b2
--- /dev/null
+++ b/kiauh/components/crowsnest/crowsnest.py
@@ -0,0 +1,178 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import shutil
+import time
+from pathlib import Path
+from subprocess import CalledProcessError, run
+from typing import List
+
+from components.crowsnest import (
+ CROWSNEST_BACKUP_DIR,
+ CROWSNEST_BIN_FILE,
+ CROWSNEST_DIR,
+ CROWSNEST_INSTALL_SCRIPT,
+ CROWSNEST_LOGROTATE_FILE,
+ CROWSNEST_MULTI_CONFIG,
+ CROWSNEST_REPO,
+ CROWSNEST_SERVICE_FILE,
+ CROWSNEST_SERVICE_NAME,
+)
+from components.klipper.klipper import Klipper
+from core.backup_manager.backup_manager import BackupManager
+from core.constants import CURRENT_USER
+from core.logger import DialogType, Logger
+from core.settings.kiauh_settings import KiauhSettings
+from core.types import ComponentStatus
+from utils.common import (
+ check_install_dependencies,
+ get_install_status,
+)
+from utils.git_utils import (
+ git_clone_wrapper,
+ git_pull_wrapper,
+)
+from utils.input_utils import get_confirm
+from utils.instance_utils import get_instances
+from utils.sys_utils import (
+ cmd_sysctl_service,
+ parse_packages_from_file,
+)
+
+
+def install_crowsnest() -> None:
+ # Step 1: Clone crowsnest repo
+ git_clone_wrapper(CROWSNEST_REPO, CROWSNEST_DIR, "master")
+
+ # Step 2: Install dependencies
+ check_install_dependencies({"make"})
+
+ # Step 3: Check for Multi Instance
+ instances: List[Klipper] = get_instances(Klipper)
+
+ if len(instances) > 1:
+ print_multi_instance_warning(instances)
+
+ if not get_confirm("Do you want to continue with the installation?"):
+ Logger.print_info("Crowsnest installation aborted!")
+ return
+
+ Logger.print_status("Launching crowsnest's install configurator ...")
+ time.sleep(3)
+ configure_multi_instance()
+
+ # Step 4: Launch crowsnest installer
+ Logger.print_status("Launching crowsnest installer ...")
+ Logger.print_info("Installer will prompt you for sudo password!")
+ try:
+ run(
+ f"sudo make install BASE_USER={CURRENT_USER}",
+ cwd=CROWSNEST_DIR,
+ shell=True,
+ check=True,
+ )
+ except CalledProcessError as e:
+ Logger.print_error(f"Something went wrong! Please try again...\n{e}")
+ return
+
+
+def print_multi_instance_warning(instances: List[Klipper]) -> None:
+ Logger.print_dialog(
+ DialogType.WARNING,
+ [
+ "Multi instance install detected!",
+ "\n\n",
+ "Crowsnest is NOT designed to support multi instances. A workaround "
+ "for this is to choose the most used instance as a 'master' and use "
+ "this instance to set up your 'crowsnest.conf' and steering it's service.",
+ "\n\n",
+ "The following instances were found:",
+ *[f"● {instance.data_dir.name}" for instance in instances],
+ ],
+ )
+
+
+def configure_multi_instance() -> None:
+ try:
+ run(
+ "make config",
+ cwd=CROWSNEST_DIR,
+ shell=True,
+ check=True,
+ )
+ except CalledProcessError as e:
+ Logger.print_error(f"Something went wrong! Please try again...\n{e}")
+ if CROWSNEST_MULTI_CONFIG.exists():
+ Path.unlink(CROWSNEST_MULTI_CONFIG)
+ return
+
+ if not CROWSNEST_MULTI_CONFIG.exists():
+ Logger.print_error("Generating .config failed, installation aborted")
+
+
+def update_crowsnest() -> None:
+ try:
+ cmd_sysctl_service(CROWSNEST_SERVICE_NAME, "stop")
+
+ if not CROWSNEST_DIR.exists():
+ git_clone_wrapper(CROWSNEST_REPO, CROWSNEST_DIR, "master")
+ else:
+ Logger.print_status("Updating Crowsnest ...")
+
+ settings = KiauhSettings()
+ if settings.kiauh.backup_before_update:
+ bm = BackupManager()
+ bm.backup_directory(
+ CROWSNEST_DIR.name,
+ source=CROWSNEST_DIR,
+ target=CROWSNEST_BACKUP_DIR,
+ )
+
+ git_pull_wrapper(CROWSNEST_REPO, CROWSNEST_DIR)
+
+ deps = parse_packages_from_file(CROWSNEST_INSTALL_SCRIPT)
+ check_install_dependencies({*deps})
+
+ cmd_sysctl_service(CROWSNEST_SERVICE_NAME, "restart")
+
+ Logger.print_ok("Crowsnest updated successfully.", end="\n\n")
+ except CalledProcessError as e:
+ Logger.print_error(f"Something went wrong! Please try again...\n{e}")
+ return
+
+
+def get_crowsnest_status() -> ComponentStatus:
+ files = [
+ CROWSNEST_BIN_FILE,
+ CROWSNEST_LOGROTATE_FILE,
+ CROWSNEST_SERVICE_FILE,
+ ]
+ return get_install_status(CROWSNEST_DIR, files=files)
+
+
+def remove_crowsnest() -> None:
+ if not CROWSNEST_DIR.exists():
+ Logger.print_info("Crowsnest does not seem to be installed! Skipping ...")
+ return
+
+ try:
+ run(
+ "make uninstall",
+ cwd=CROWSNEST_DIR,
+ shell=True,
+ check=True,
+ )
+ except CalledProcessError as e:
+ Logger.print_error(f"Something went wrong! Please try again...\n{e}")
+ return
+
+ Logger.print_status("Removing crowsnest directory ...")
+ shutil.rmtree(CROWSNEST_DIR)
+ Logger.print_ok("Directory removed!")
diff --git a/kiauh/components/klipper/__init__.py b/kiauh/components/klipper/__init__.py
new file mode 100644
index 0000000..2e282e4
--- /dev/null
+++ b/kiauh/components/klipper/__init__.py
@@ -0,0 +1,36 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+
+from pathlib import Path
+
+from core.backup_manager import BACKUP_ROOT_DIR
+
+MODULE_PATH = Path(__file__).resolve().parent
+
+# names
+KLIPPER_LOG_NAME = "klippy.log"
+KLIPPER_CFG_NAME = "printer.cfg"
+KLIPPER_SERIAL_NAME = "klippy.serial"
+KLIPPER_UDS_NAME = "klippy.sock"
+KLIPPER_ENV_FILE_NAME = "klipper.env"
+KLIPPER_SERVICE_NAME = "klipper.service"
+
+# directories
+KLIPPER_DIR = Path.home().joinpath("klipper")
+KLIPPER_ENV_DIR = Path.home().joinpath("klippy-env")
+KLIPPER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("klipper-backups")
+
+# files
+KLIPPER_REQ_FILE = KLIPPER_DIR.joinpath("scripts/klippy-requirements.txt")
+KLIPPER_INSTALL_SCRIPT = KLIPPER_DIR.joinpath("scripts/install-ubuntu-22.04.sh")
+KLIPPER_SERVICE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{KLIPPER_SERVICE_NAME}")
+KLIPPER_ENV_FILE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{KLIPPER_ENV_FILE_NAME}")
+
+
+EXIT_KLIPPER_SETUP = "Exiting Klipper setup ..."
diff --git a/kiauh/components/klipper/assets/klipper.env b/kiauh/components/klipper/assets/klipper.env
new file mode 100644
index 0000000..b56553e
--- /dev/null
+++ b/kiauh/components/klipper/assets/klipper.env
@@ -0,0 +1 @@
+KLIPPER_ARGS="%KLIPPER_DIR%/klippy/klippy.py %CFG% -I %SERIAL% -l %LOG% -a %UDS%"
diff --git a/kiauh/components/klipper/assets/klipper.service b/kiauh/components/klipper/assets/klipper.service
new file mode 100644
index 0000000..b41788f
--- /dev/null
+++ b/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
diff --git a/kiauh/components/klipper/assets/printer.cfg b/kiauh/components/klipper/assets/printer.cfg
new file mode 100644
index 0000000..88fe7df
--- /dev/null
+++ b/kiauh/components/klipper/assets/printer.cfg
@@ -0,0 +1,11 @@
+[mcu]
+serial: /dev/serial/by-id/
+
+[virtual_sdcard]
+path: %GCODES_DIR%
+on_error_gcode: CANCEL_PRINT
+
+[printer]
+kinematics: none
+max_velocity: 1000
+max_accel: 1000
diff --git a/kiauh/components/klipper/klipper.py b/kiauh/components/klipper/klipper.py
new file mode 100644
index 0000000..88e128d
--- /dev/null
+++ b/kiauh/components/klipper/klipper.py
@@ -0,0 +1,140 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from pathlib import Path
+from subprocess import CalledProcessError
+
+from components.klipper import (
+ KLIPPER_CFG_NAME,
+ KLIPPER_DIR,
+ KLIPPER_ENV_DIR,
+ KLIPPER_ENV_FILE_NAME,
+ KLIPPER_ENV_FILE_TEMPLATE,
+ KLIPPER_LOG_NAME,
+ KLIPPER_SERIAL_NAME,
+ KLIPPER_SERVICE_TEMPLATE,
+ KLIPPER_UDS_NAME,
+)
+from core.constants import CURRENT_USER
+from core.instance_manager.base_instance import BaseInstance
+from core.logger import Logger
+from utils.fs_utils import create_folders, get_data_dir
+from utils.sys_utils import get_service_file_path
+
+
+# noinspection PyMethodMayBeStatic
+@dataclass(repr=True)
+class Klipper:
+ suffix: str
+ base: BaseInstance = field(init=False, repr=False)
+ service_file_path: Path = field(init=False)
+ log_file_name: str = KLIPPER_LOG_NAME
+ klipper_dir: Path = KLIPPER_DIR
+ env_dir: Path = KLIPPER_ENV_DIR
+ data_dir: Path = field(init=False)
+ cfg_file: Path = field(init=False)
+ serial: Path = field(init=False)
+ uds: Path = field(init=False)
+
+ def __post_init__(self):
+ self.base: BaseInstance = BaseInstance(Klipper, self.suffix)
+ self.base.log_file_name = self.log_file_name
+
+ self.service_file_path: Path = get_service_file_path(Klipper, self.suffix)
+ self.data_dir: Path = get_data_dir(Klipper, self.suffix)
+ self.cfg_file: Path = self.base.cfg_dir.joinpath(KLIPPER_CFG_NAME)
+ self.serial: Path = self.base.comms_dir.joinpath(KLIPPER_SERIAL_NAME)
+ self.uds: Path = self.base.comms_dir.joinpath(KLIPPER_UDS_NAME)
+
+ def create(self) -> None:
+ from utils.sys_utils import create_env_file, create_service_file
+
+ Logger.print_status("Creating new Klipper Instance ...")
+
+ try:
+ create_folders(self.base.base_folders)
+
+ create_service_file(
+ name=self.service_file_path.name,
+ content=self._prep_service_file_content(),
+ )
+
+ create_env_file(
+ path=self.base.sysd_dir.joinpath(KLIPPER_ENV_FILE_NAME),
+ content=self._prep_env_file_content(),
+ )
+
+ except CalledProcessError as e:
+ Logger.print_error(f"Error creating instance: {e}")
+ raise
+ except OSError as e:
+ Logger.print_error(f"Error creating env file: {e}")
+ raise
+
+ def _prep_service_file_content(self) -> str:
+ template = KLIPPER_SERVICE_TEMPLATE
+
+ try:
+ with open(template, "r") as template_file:
+ template_content = template_file.read()
+ except FileNotFoundError:
+ Logger.print_error(f"Unable to open {template} - File not found")
+ raise
+
+ service_content = template_content.replace(
+ "%USER%",
+ CURRENT_USER,
+ )
+ service_content = service_content.replace(
+ "%KLIPPER_DIR%",
+ self.klipper_dir.as_posix(),
+ )
+ service_content = service_content.replace(
+ "%ENV%",
+ self.env_dir.as_posix(),
+ )
+ service_content = service_content.replace(
+ "%ENV_FILE%",
+ self.base.sysd_dir.joinpath(KLIPPER_ENV_FILE_NAME).as_posix(),
+ )
+ return service_content
+
+ def _prep_env_file_content(self) -> str:
+ template = KLIPPER_ENV_FILE_TEMPLATE
+
+ try:
+ with open(template, "r") as env_file:
+ env_template_file_content = env_file.read()
+ except FileNotFoundError:
+ Logger.print_error(f"Unable to open {template} - File not found")
+ raise
+
+ env_file_content = env_template_file_content.replace(
+ "%KLIPPER_DIR%", self.klipper_dir.as_posix()
+ )
+ env_file_content = env_file_content.replace(
+ "%CFG%",
+ f"{self.base.cfg_dir}/{KLIPPER_CFG_NAME}",
+ )
+ env_file_content = env_file_content.replace(
+ "%SERIAL%",
+ self.serial.as_posix() if self.serial else "",
+ )
+ env_file_content = env_file_content.replace(
+ "%LOG%",
+ self.base.log_dir.joinpath(self.log_file_name).as_posix(),
+ )
+ env_file_content = env_file_content.replace(
+ "%UDS%",
+ self.uds.as_posix() if self.uds else "",
+ )
+
+ return env_file_content
diff --git a/kiauh/components/klipper/klipper_dialogs.py b/kiauh/components/klipper/klipper_dialogs.py
new file mode 100644
index 0000000..9108b32
--- /dev/null
+++ b/kiauh/components/klipper/klipper_dialogs.py
@@ -0,0 +1,114 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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 enum import Enum, unique
+from typing import List
+
+from core.constants import (
+ COLOR_CYAN,
+ COLOR_GREEN,
+ COLOR_YELLOW,
+ RESET_FORMAT,
+)
+from core.instance_type import InstanceType
+from core.menus.base_menu import print_back_footer
+
+
+@unique
+class DisplayType(Enum):
+ SERVICE_NAME = "SERVICE_NAME"
+ PRINTER_NAME = "PRINTER_NAME"
+
+
+def print_instance_overview(
+ instances: List[InstanceType],
+ display_type: DisplayType = DisplayType.SERVICE_NAME,
+ show_headline=True,
+ show_index=False,
+ start_index=0,
+ show_select_all=False,
+) -> None:
+ dialog = "╔═══════════════════════════════════════════════════════╗\n"
+ if show_headline:
+ d_type = (
+ "Klipper instances"
+ if display_type is DisplayType.SERVICE_NAME
+ else "printer directories"
+ )
+ headline = f"{COLOR_GREEN}The following {d_type} were found:{RESET_FORMAT}"
+ dialog += f"║{headline:^64}║\n"
+ dialog += "╟───────────────────────────────────────────────────────╢\n"
+
+ if show_select_all:
+ select_all = f"{COLOR_YELLOW}a) Select all{RESET_FORMAT}"
+ dialog += f"║ {select_all:<63}║\n"
+ dialog += "║ ║\n"
+
+ for i, s in enumerate(instances):
+ if display_type is DisplayType.SERVICE_NAME:
+ name = s.service_file_path.stem
+ else:
+ name = s.data_dir
+ line = f"{COLOR_CYAN}{f'{i + start_index})' if show_index else '●'} {name}{RESET_FORMAT}"
+ dialog += f"║ {line:<63}║\n"
+ dialog += "╟───────────────────────────────────────────────────────╢\n"
+
+ print(dialog, end="")
+ print_back_footer()
+
+
+def print_select_instance_count_dialog() -> None:
+ line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
+ line2 = f"{COLOR_YELLOW}Setting up too many instances may crash your system.{RESET_FORMAT}"
+ dialog = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ Please select the number of Klipper instances to set ║
+ ║ 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() -> None:
+ line1 = f"{COLOR_YELLOW}INFO:{RESET_FORMAT}"
+ line2 = f"{COLOR_YELLOW}Only alphanumeric characters are allowed!{RESET_FORMAT}"
+ dialog = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ Do you want to assign a custom name to each instance? ║
+ ║ ║
+ ║ Assigning a custom name will create a Klipper service ║
+ ║ and a printer directory with the chosen name. ║
+ ║ ║
+ ║ Example for custom name 'kiauh': ║
+ ║ ● Klipper service: klipper-kiauh.service ║
+ ║ ● Printer directory: printer_kiauh_data ║
+ ║ ║
+ ║ If skipped, each instance will get an index assigned ║
+ ║ in ascending order, starting at '1' in case of a new ║
+ ║ installation. Otherwise, the index will be derived ║
+ ║ from amount of already existing instances. ║
+ ║ ║
+ ║ {line1:<63}║
+ ║ {line2:<63}║
+ ╟───────────────────────────────────────────────────────╢
+ """
+ )[1:]
+
+ print(dialog, end="")
+ print_back_footer()
diff --git a/kiauh/components/klipper/klipper_remove.py b/kiauh/components/klipper/klipper_remove.py
new file mode 100644
index 0000000..cb176bd
--- /dev/null
+++ b/kiauh/components/klipper/klipper_remove.py
@@ -0,0 +1,98 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+from typing import List
+
+from components.klipper import KLIPPER_DIR, KLIPPER_ENV_DIR
+from components.klipper.klipper import Klipper
+from components.klipper.klipper_dialogs import print_instance_overview
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
+from utils.fs_utils import run_remove_routines
+from utils.input_utils import get_selection_input
+from utils.instance_utils import get_instances
+from utils.sys_utils import unit_file_exists
+
+
+def run_klipper_removal(
+ remove_service: bool,
+ remove_dir: bool,
+ remove_env: bool,
+) -> None:
+ klipper_instances: List[Klipper] = get_instances(Klipper)
+
+ if remove_service:
+ Logger.print_status("Removing Klipper instances ...")
+ if klipper_instances:
+ instances_to_remove = select_instances_to_remove(klipper_instances)
+ remove_instances(instances_to_remove)
+ else:
+ Logger.print_info("No Klipper Services installed! Skipped ...")
+
+ if (remove_dir or remove_env) and unit_file_exists("klipper", suffix="service"):
+ Logger.print_info("There are still other Klipper services installed:")
+ Logger.print_info(f"● '{KLIPPER_DIR}' was not removed.", prefix=False)
+ Logger.print_info(f"● '{KLIPPER_ENV_DIR}' was not removed.", prefix=False)
+ else:
+ if remove_dir:
+ Logger.print_status("Removing Klipper local repository ...")
+ run_remove_routines(KLIPPER_DIR)
+ if remove_env:
+ Logger.print_status("Removing Klipper Python environment ...")
+ run_remove_routines(KLIPPER_ENV_DIR)
+
+
+def select_instances_to_remove(instances: List[Klipper]) -> List[Klipper] | None:
+ start_index = 1
+ options = [str(i + start_index) for i in range(len(instances))]
+ options.extend(["a", "b"])
+ instance_map = {options[i]: instances[i] for i in range(len(instances))}
+
+ print_instance_overview(
+ instances,
+ start_index=start_index,
+ show_index=True,
+ show_select_all=True,
+ )
+ selection = get_selection_input("Select Klipper instance to remove", options)
+
+ instances_to_remove = []
+ if selection == "b":
+ return None
+ elif selection == "a":
+ instances_to_remove.extend(instances)
+ else:
+ instances_to_remove.append(instance_map[selection])
+
+ return instances_to_remove
+
+
+def remove_instances(
+ instance_list: List[Klipper] | None,
+) -> None:
+ if not instance_list:
+ return
+
+ for instance in instance_list:
+ Logger.print_status(f"Removing instance {instance.service_file_path.stem} ...")
+ InstanceManager.remove(instance)
+
+
+def delete_klipper_logs(instances: List[Klipper]) -> None:
+ all_logfiles = []
+ for instance in instances:
+ all_logfiles = list(instance.base.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}'")
+ run_remove_routines(log)
diff --git a/kiauh/components/klipper/klipper_setup.py b/kiauh/components/klipper/klipper_setup.py
new file mode 100644
index 0000000..2dde455
--- /dev/null
+++ b/kiauh/components/klipper/klipper_setup.py
@@ -0,0 +1,239 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Dict, List, Tuple
+
+from components.klipper import (
+ EXIT_KLIPPER_SETUP,
+ KLIPPER_DIR,
+ KLIPPER_ENV_DIR,
+ KLIPPER_INSTALL_SCRIPT,
+ KLIPPER_REQ_FILE,
+)
+from components.klipper.klipper import Klipper
+from components.klipper.klipper_dialogs import (
+ print_select_custom_name_dialog,
+)
+from components.klipper.klipper_utils import (
+ assign_custom_name,
+ backup_klipper_dir,
+ check_user_groups,
+ create_example_printer_cfg,
+ get_install_count,
+ handle_disruptive_system_packages,
+)
+from components.moonraker.moonraker import Moonraker
+from components.webui_client.client_utils import (
+ get_existing_clients,
+)
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
+from core.settings.kiauh_settings import KiauhSettings
+from utils.common import check_install_dependencies
+from utils.git_utils import git_clone_wrapper, git_pull_wrapper
+from utils.input_utils import get_confirm
+from utils.instance_utils import get_instances
+from utils.sys_utils import (
+ cmd_sysctl_manage,
+ cmd_sysctl_service,
+ create_python_venv,
+ install_python_requirements,
+ parse_packages_from_file,
+)
+
+
+def install_klipper() -> None:
+ Logger.print_status("Installing Klipper ...")
+
+ klipper_list: List[Klipper] = get_instances(Klipper)
+ moonraker_list: List[Moonraker] = get_instances(Moonraker)
+ match_moonraker: bool = False
+
+ # if there are more moonraker instances than klipper instances, ask the user to
+ # match the klipper instance count to the count of moonraker instances with the same suffix
+ if len(moonraker_list) > len(klipper_list):
+ is_confirmed = display_moonraker_info(moonraker_list)
+ if not is_confirmed:
+ Logger.print_status(EXIT_KLIPPER_SETUP)
+ return
+ match_moonraker = True
+
+ install_count, name_dict = get_install_count_and_name_dict(
+ klipper_list, moonraker_list
+ )
+
+ if install_count == 0:
+ Logger.print_status(EXIT_KLIPPER_SETUP)
+ return
+
+ is_multi_install = install_count > 1 or (len(name_dict) >= 1 and install_count >= 1)
+ if not name_dict and install_count == 1:
+ name_dict = {0: ""}
+ elif is_multi_install and not match_moonraker:
+ custom_names = use_custom_names_or_go_back()
+ if custom_names is None:
+ Logger.print_status(EXIT_KLIPPER_SETUP)
+ return
+
+ handle_instance_names(install_count, name_dict, custom_names)
+
+ create_example_cfg = get_confirm("Create example printer.cfg?")
+ # run the actual installation
+ try:
+ run_klipper_setup(klipper_list, name_dict, create_example_cfg)
+ except Exception as e:
+ Logger.print_error(e)
+ Logger.print_error("Klipper installation failed!")
+ return
+
+
+def run_klipper_setup(
+ klipper_list: List[Klipper], name_dict: Dict[int, str], create_example_cfg: bool
+) -> None:
+ if not klipper_list:
+ setup_klipper_prerequesites()
+
+ for i in name_dict:
+ # skip this iteration if there is already an instance with the name
+ if name_dict[i] in [n.suffix for n in klipper_list]:
+ continue
+
+ instance = Klipper(suffix=name_dict[i])
+ instance.create()
+ cmd_sysctl_service(instance.service_file_path.name, "enable")
+
+ if create_example_cfg:
+ # if a client-config is installed, include it in the new example cfg
+ clients = get_existing_clients()
+ create_example_printer_cfg(instance, clients)
+
+ cmd_sysctl_service(instance.service_file_path.name, "start")
+
+ cmd_sysctl_manage("daemon-reload")
+
+ # step 4: check/handle conflicting packages/services
+ handle_disruptive_system_packages()
+
+ # step 5: check for required group membership
+ check_user_groups()
+
+
+def handle_instance_names(
+ install_count: int, name_dict: Dict[int, str], custom_names: bool
+) -> None:
+ for i in range(install_count): # 3
+ key: int = len(name_dict.keys()) + 1
+ if custom_names:
+ assign_custom_name(key, name_dict)
+ else:
+ name_dict[key] = str(len(name_dict) + 1)
+
+
+def get_install_count_and_name_dict(
+ klipper_list: List[Klipper], moonraker_list: List[Moonraker]
+) -> Tuple[int, Dict[int, str]]:
+ install_count: int | None
+ if len(moonraker_list) > len(klipper_list):
+ install_count = len(moonraker_list)
+ name_dict = {i: moonraker.suffix for i, moonraker in enumerate(moonraker_list)}
+ else:
+ install_count = get_install_count()
+ name_dict = {i: klipper.suffix for i, klipper in enumerate(klipper_list)}
+
+ if install_count is None:
+ Logger.print_status(EXIT_KLIPPER_SETUP)
+ return 0, {}
+
+ return install_count, name_dict
+
+
+def setup_klipper_prerequesites() -> None:
+ settings = KiauhSettings()
+ repo = settings.klipper.repo_url
+ branch = settings.klipper.branch
+
+ git_clone_wrapper(repo, KLIPPER_DIR, branch)
+
+ # install klipper dependencies and create python virtualenv
+ try:
+ install_klipper_packages()
+ if create_python_venv(KLIPPER_ENV_DIR):
+ install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
+ except Exception:
+ Logger.print_error("Error during installation of Klipper requirements!")
+ raise
+
+
+def install_klipper_packages() -> None:
+ script = KLIPPER_INSTALL_SCRIPT
+ packages = parse_packages_from_file(script)
+
+ # Add dbus requirement for DietPi distro
+ if Path("/boot/dietpi/.version").exists():
+ packages.append("dbus")
+
+ check_install_dependencies({*packages})
+
+
+def update_klipper() -> None:
+ Logger.print_dialog(
+ DialogType.WARNING,
+ [
+ "Do NOT continue if there are ongoing prints running!",
+ "All Klipper instances will be restarted during the update process and "
+ "ongoing prints WILL FAIL.",
+ ],
+ )
+
+ if not get_confirm("Update Klipper now?"):
+ return
+
+ settings = KiauhSettings()
+ if settings.kiauh.backup_before_update:
+ backup_klipper_dir()
+
+ instances = get_instances(Klipper)
+ InstanceManager.stop_all(instances)
+
+ git_pull_wrapper(repo=settings.klipper.repo_url, target_dir=KLIPPER_DIR)
+
+ # install possible new system packages
+ install_klipper_packages()
+ # install possible new python dependencies
+ install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
+
+ InstanceManager.start_all(instances)
+
+
+def use_custom_names_or_go_back() -> bool | None:
+ print_select_custom_name_dialog()
+ _input: bool | None = get_confirm(
+ "Assign custom names?",
+ False,
+ allow_go_back=True,
+ )
+ return _input
+
+
+def display_moonraker_info(moonraker_list: List[Moonraker]) -> bool:
+ # todo: only show the klipper instances that are not already installed
+ Logger.print_dialog(
+ DialogType.INFO,
+ [
+ "Existing Moonraker instances detected:",
+ *[f"● {m.service_file_path.stem}" for m in moonraker_list],
+ "\n\n",
+ "The following Klipper instances will be installed:",
+ *[f"● klipper-{m.suffix}" for m in moonraker_list],
+ ],
+ )
+ _input: bool = get_confirm("Proceed with installation?")
+ return _input
diff --git a/kiauh/components/klipper/klipper_utils.py b/kiauh/components/klipper/klipper_utils.py
new file mode 100644
index 0000000..d85c699
--- /dev/null
+++ b/kiauh/components/klipper/klipper_utils.py
@@ -0,0 +1,196 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import grp
+import os
+import shutil
+from subprocess import CalledProcessError, run
+from typing import Dict, List
+
+from components.klipper import (
+ KLIPPER_BACKUP_DIR,
+ KLIPPER_DIR,
+ KLIPPER_ENV_DIR,
+ MODULE_PATH,
+)
+from components.klipper.klipper import Klipper
+from components.klipper.klipper_dialogs import (
+ print_instance_overview,
+ print_select_instance_count_dialog,
+)
+from components.webui_client.base_data import BaseWebClient
+from components.webui_client.client_config.client_config_setup import (
+ create_client_config_symlink,
+)
+from core.backup_manager.backup_manager import BackupManager
+from core.constants import CURRENT_USER
+from core.instance_manager.base_instance import SUFFIX_BLACKLIST
+from core.logger import DialogType, Logger
+from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+ SimpleConfigParser,
+)
+from core.types import ComponentStatus
+from utils.common import get_install_status
+from utils.input_utils import get_confirm, get_number_input, get_string_input
+from utils.instance_utils import get_instances
+from utils.sys_utils import cmd_sysctl_service
+
+
+def get_klipper_status() -> ComponentStatus:
+ return get_install_status(KLIPPER_DIR, KLIPPER_ENV_DIR, Klipper)
+
+
+def add_to_existing() -> bool | None:
+ kl_instances: List[Klipper] = get_instances(Klipper)
+ print_instance_overview(kl_instances)
+ _input: bool | None = get_confirm("Add new instances?", allow_go_back=True)
+ return _input
+
+
+def get_install_count() -> int | None:
+ """
+ Print a dialog for selecting the amount of Klipper instances
+ to set up with an option to navigate back. Returns None if the
+ user selected to go back, otherwise an integer greater or equal than 1 |
+ :return: Integer >= 1 or None
+ """
+ kl_instances = get_instances(Klipper)
+ print_select_instance_count_dialog()
+ question = (
+ f"Number of"
+ f"{' additional' if len(kl_instances) > 0 else ''} "
+ f"Klipper instances to set up"
+ )
+ _input: int | None = get_number_input(question, 1, default=1, allow_go_back=True)
+ return _input
+
+
+def assign_custom_name(key: int, name_dict: Dict[int, str]) -> None:
+ existing_names = []
+ existing_names.extend(SUFFIX_BLACKLIST)
+ existing_names.extend(name_dict[n] for n in name_dict)
+ pattern = r"^[a-zA-Z0-9]+$"
+
+ question = f"Enter name for instance {key}"
+ name_dict[key] = get_string_input(question, exclude=existing_names, regex=pattern)
+
+
+def check_user_groups() -> None:
+ user_groups = [grp.getgrgid(gid).gr_name for gid in os.getgroups()]
+ missing_groups = [g for g in ["tty", "dialout"] if g not in user_groups]
+
+ if not missing_groups:
+ return
+
+ Logger.print_dialog(
+ DialogType.ATTENTION,
+ [
+ "Your current user is not in group:",
+ *[f"● {g}" for g in missing_groups],
+ "\n\n",
+ "It is possible that you won't be able to successfully connect and/or "
+ "flash the controller board without your user being a member of that "
+ "group. If you want to add the current user to the group(s) listed above, "
+ "answer with 'Y'. Else skip with 'n'.",
+ "\n\n",
+ "INFO:",
+ "Relog required for group assignments to take effect!",
+ ],
+ )
+
+ if not get_confirm(f"Add user '{CURRENT_USER}' to group(s) now?"):
+ log = "Skipped adding user to required groups. You might encounter issues."
+ Logger.warn(log)
+ 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]
+ run(command, check=True)
+ Logger.print_ok(f"Group {group} assigned to user '{CURRENT_USER}'.")
+ except 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 = run(command, capture_output=True, text=True)
+
+ command = ["systemctl", "is-enabled", "brltty-udev"]
+ brltty_udev_status = run(command, capture_output=True, text=True)
+
+ command = ["systemctl", "is-enabled", "ModemManager"]
+ modem_manager_status = 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:
+ cmd_sysctl_service(service, "mask")
+ except CalledProcessError:
+ Logger.print_dialog(
+ DialogType.WARNING,
+ [
+ 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."
+ ],
+ )
+
+
+def create_example_printer_cfg(
+ instance: Klipper, clients: List[BaseWebClient] | None = None
+) -> None:
+ Logger.print_status(f"Creating example printer.cfg in '{instance.base.cfg_dir}'")
+ 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
+
+ scp = SimpleConfigParser()
+ scp.read(target)
+ scp.set("virtual_sdcard", "path", str(instance.base.gcodes_dir))
+
+ # include existing client configs in the example config
+ if clients is not None and len(clients) > 0:
+ for c in clients:
+ client_config = c.client_config
+ section = client_config.config_section
+ scp.add_section(section=section)
+ create_client_config_symlink(client_config, [instance])
+
+ scp.write(target)
+
+ Logger.print_ok(f"Example printer.cfg created in '{instance.base.cfg_dir}'")
+
+
+def backup_klipper_dir() -> None:
+ bm = BackupManager()
+ bm.backup_directory("klipper", source=KLIPPER_DIR, target=KLIPPER_BACKUP_DIR)
+ bm.backup_directory("klippy-env", source=KLIPPER_ENV_DIR, target=KLIPPER_BACKUP_DIR)
diff --git a/kiauh/components/klipper/menus/__init__.py b/kiauh/components/klipper/menus/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/kiauh/components/klipper/menus/klipper_remove_menu.py b/kiauh/components/klipper/menus/klipper_remove_menu.py
new file mode 100644
index 0000000..c488a8a
--- /dev/null
+++ b/kiauh/components/klipper/menus/klipper_remove_menu.py
@@ -0,0 +1,118 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from components.klipper import klipper_remove
+from core.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
+from core.menus import FooterType, Option
+from core.menus.base_menu import BaseMenu
+
+
+# noinspection PyUnusedLocal
+class KlipperRemoveMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+ self.footer_type = FooterType.BACK
+ self.remove_klipper_service = False
+ self.remove_klipper_dir = False
+ self.remove_klipper_env = False
+ self.selection_state = False
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from core.menus.remove_menu import RemoveMenu
+
+ self.previous_menu = previous_menu if previous_menu is not None else RemoveMenu
+
+ def set_options(self) -> None:
+ self.options = {
+ "a": Option(method=self.toggle_all),
+ "1": Option(method=self.toggle_remove_klipper_service),
+ "2": Option(method=self.toggle_remove_klipper_dir),
+ "3": Option(method=self.toggle_remove_klipper_env),
+ "c": Option(method=self.run_removal_process),
+ }
+
+ def print_menu(self) -> None:
+ header = " [ Remove Klipper ] "
+ 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
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ Enter a number and hit enter to select / deselect ║
+ ║ the specific option for removal. ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ a) {self._get_selection_state_str():37} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ 1) {o1} Remove Service ║
+ ║ 2) {o2} Remove Local Repository ║
+ ║ 3) {o3} Remove Python Environment ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ C) Continue ║
+ ╟───────────────────────────────────────────────────────╢
+ """
+ )[1:]
+ print(menu, end="")
+
+ def toggle_all(self, **kwargs) -> None:
+ self.selection_state = not self.selection_state
+ self.remove_klipper_service = self.selection_state
+ self.remove_klipper_dir = self.selection_state
+ self.remove_klipper_env = self.selection_state
+
+ def toggle_remove_klipper_service(self, **kwargs) -> None:
+ self.remove_klipper_service = not self.remove_klipper_service
+
+ 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 run_removal_process(self, **kwargs) -> None:
+ if (
+ not self.remove_klipper_service
+ and not self.remove_klipper_dir
+ and not self.remove_klipper_env
+ ):
+ 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.remove_klipper_service = False
+ self.remove_klipper_dir = False
+ self.remove_klipper_env = False
+
+ self._go_back()
+
+ def _get_selection_state_str(self) -> str:
+ return (
+ "Select everything" if not self.selection_state else "Deselect everything"
+ )
+
+ def _go_back(self, **kwargs) -> None:
+ if self.previous_menu is not None:
+ self.previous_menu().run()
diff --git a/kiauh/components/klipper_firmware/__init__.py b/kiauh/components/klipper_firmware/__init__.py
new file mode 100644
index 0000000..f27ce38
--- /dev/null
+++ b/kiauh/components/klipper_firmware/__init__.py
@@ -0,0 +1,12 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+
+from components.klipper import KLIPPER_DIR
+
+SD_FLASH_SCRIPT = KLIPPER_DIR.joinpath("scripts/flash-sdcard.sh")
diff --git a/kiauh/components/klipper_firmware/firmware_utils.py b/kiauh/components/klipper_firmware/firmware_utils.py
new file mode 100644
index 0000000..9a59bdb
--- /dev/null
+++ b/kiauh/components/klipper_firmware/firmware_utils.py
@@ -0,0 +1,176 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+
+from subprocess import PIPE, STDOUT, CalledProcessError, Popen, check_output, run
+from typing import List
+
+from components.klipper import KLIPPER_DIR
+from components.klipper.klipper import Klipper
+from components.klipper_firmware import SD_FLASH_SCRIPT
+from components.klipper_firmware.flash_options import (
+ FlashMethod,
+ FlashOptions,
+)
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
+from utils.instance_utils import get_instances
+from utils.sys_utils import log_process
+
+
+def find_firmware_file() -> bool:
+ target = KLIPPER_DIR.joinpath("out")
+ target_exists: bool = target.exists()
+
+ f1 = "klipper.elf.hex"
+ f2 = "klipper.elf"
+ f3 = "klipper.bin"
+ fw_file_exists: bool = (
+ target.joinpath(f1).exists() and target.joinpath(f2).exists()
+ ) or target.joinpath(f3).exists()
+
+ return target_exists and fw_file_exists
+
+
+def find_usb_device_by_id() -> List[str]:
+ try:
+ command = "find /dev/serial/by-id/* 2>/dev/null"
+ output = check_output(command, shell=True, text=True)
+ return output.splitlines()
+ except CalledProcessError as e:
+ Logger.print_error("Unable to find a USB device!")
+ Logger.print_error(e, prefix=False)
+ return []
+
+
+def find_uart_device() -> List[str]:
+ try:
+ command = '"find /dev -maxdepth 1 -regextype posix-extended -regex "^\/dev\/tty(AMA0|S0)$" 2>/dev/null"'
+ output = check_output(command, shell=True, text=True)
+ return output.splitlines()
+ except CalledProcessError as e:
+ Logger.print_error("Unable to find a UART device!")
+ Logger.print_error(e, prefix=False)
+ return []
+
+
+def find_usb_dfu_device() -> List[str]:
+ try:
+ command = '"lsusb | grep "DFU" | cut -d " " -f 6 2>/dev/null"'
+ output = check_output(command, shell=True, text=True)
+ return output.splitlines()
+ except CalledProcessError as e:
+ Logger.print_error("Unable to find a USB DFU device!")
+ Logger.print_error(e, prefix=False)
+ return []
+
+
+def get_sd_flash_board_list() -> List[str]:
+ if not KLIPPER_DIR.exists() or not SD_FLASH_SCRIPT.exists():
+ return []
+
+ try:
+ cmd = f"{SD_FLASH_SCRIPT} -l"
+ blist: List[str] = check_output(cmd, shell=True, text=True).splitlines()[1:]
+ return blist
+ except CalledProcessError as e:
+ Logger.print_error(f"An unexpected error occured:\n{e}")
+ return []
+
+
+def start_flash_process(flash_options: FlashOptions) -> None:
+ Logger.print_status(f"Flashing '{flash_options.selected_mcu}' ...")
+ try:
+ if not flash_options.flash_method:
+ raise Exception("Missing value for flash_method!")
+ if not flash_options.flash_command:
+ raise Exception("Missing value for flash_command!")
+ if not flash_options.selected_mcu:
+ raise Exception("Missing value for selected_mcu!")
+ if not flash_options.connection_type:
+ raise Exception("Missing value for connection_type!")
+ if (
+ flash_options.flash_method == FlashMethod.SD_CARD
+ and not flash_options.selected_board
+ ):
+ raise Exception("Missing value for selected_board!")
+
+ if flash_options.flash_method is FlashMethod.REGULAR:
+ cmd = [
+ "make",
+ flash_options.flash_command.value,
+ f"FLASH_DEVICE={flash_options.selected_mcu}",
+ ]
+ elif flash_options.flash_method is FlashMethod.SD_CARD:
+ if not SD_FLASH_SCRIPT.exists():
+ raise Exception("Unable to find Klippers sdcard flash script!")
+ cmd = [
+ SD_FLASH_SCRIPT.as_posix(),
+ f"-b {flash_options.selected_baudrate}",
+ flash_options.selected_mcu,
+ flash_options.selected_board,
+ ]
+ else:
+ raise Exception("Invalid value for flash_method!")
+
+ instances = get_instances(Klipper)
+ InstanceManager.stop_all(instances)
+
+ process = Popen(cmd, cwd=KLIPPER_DIR, stdout=PIPE, stderr=STDOUT, text=True)
+ log_process(process)
+
+ InstanceManager.start_all(instances)
+
+ rc = process.returncode
+ if rc != 0:
+ raise Exception(f"Flashing failed with returncode: {rc}")
+ else:
+ Logger.print_ok("Flashing successfull!", start="\n", end="\n\n")
+
+ except (Exception, CalledProcessError):
+ Logger.print_error("Flashing failed!", start="\n")
+ Logger.print_error("See the console output above!", end="\n\n")
+
+
+def run_make_clean() -> None:
+ try:
+ run(
+ "make clean",
+ cwd=KLIPPER_DIR,
+ shell=True,
+ check=True,
+ )
+ except CalledProcessError as e:
+ Logger.print_error(f"Unexpected error:\n{e}")
+ raise
+
+
+def run_make_menuconfig() -> None:
+ try:
+ run(
+ "make PYTHON=python3 menuconfig",
+ cwd=KLIPPER_DIR,
+ shell=True,
+ check=True,
+ )
+ except CalledProcessError as e:
+ Logger.print_error(f"Unexpected error:\n{e}")
+ raise
+
+
+def run_make() -> None:
+ try:
+ run(
+ "make PYTHON=python3",
+ cwd=KLIPPER_DIR,
+ shell=True,
+ check=True,
+ )
+ except CalledProcessError as e:
+ Logger.print_error(f"Unexpected error:\n{e}")
+ raise
diff --git a/kiauh/components/klipper_firmware/flash_options.py b/kiauh/components/klipper_firmware/flash_options.py
new file mode 100644
index 0000000..da12d1a
--- /dev/null
+++ b/kiauh/components/klipper_firmware/flash_options.py
@@ -0,0 +1,105 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+from dataclasses import field
+from enum import Enum
+from typing import List
+
+
+class FlashMethod(Enum):
+ REGULAR = "Regular"
+ SD_CARD = "SD Card"
+
+
+class FlashCommand(Enum):
+ FLASH = "flash"
+ SERIAL_FLASH = "serialflash"
+
+
+class ConnectionType(Enum):
+ USB = "USB"
+ USB_DFU = "USB (DFU)"
+ UART = "UART"
+
+
+class FlashOptions:
+ _instance = None
+ _flash_method: FlashMethod | None = None
+ _flash_command: FlashCommand | None = None
+ _connection_type: ConnectionType | None = None
+ _mcu_list: List[str] = field(default_factory=list)
+ _selected_mcu: str = ""
+ _selected_board: str = ""
+ _selected_baudrate: int = 250000
+
+ def __new__(cls, *args, **kwargs):
+ if not cls._instance:
+ cls._instance = super(FlashOptions, cls).__new__(cls, *args, **kwargs)
+ return cls._instance
+
+ @classmethod
+ def destroy(cls) -> None:
+ cls._instance = None
+
+ @property
+ def flash_method(self) -> FlashMethod | None:
+ return self._flash_method
+
+ @flash_method.setter
+ def flash_method(self, value: FlashMethod | None):
+ self._flash_method = value
+
+ @property
+ def flash_command(self) -> FlashCommand | None:
+ return self._flash_command
+
+ @flash_command.setter
+ def flash_command(self, value: FlashCommand | None):
+ self._flash_command = value
+
+ @property
+ def connection_type(self) -> ConnectionType | None:
+ return self._connection_type
+
+ @connection_type.setter
+ def connection_type(self, value: ConnectionType | None):
+ self._connection_type = value
+
+ @property
+ def mcu_list(self) -> List[str]:
+ return self._mcu_list
+
+ @mcu_list.setter
+ def mcu_list(self, value: List[str]) -> None:
+ self._mcu_list = value
+
+ @property
+ def selected_mcu(self) -> str:
+ return self._selected_mcu
+
+ @selected_mcu.setter
+ def selected_mcu(self, value: str) -> None:
+ self._selected_mcu = value
+
+ @property
+ def selected_board(self) -> str:
+ return self._selected_board
+
+ @selected_board.setter
+ def selected_board(self, value: str) -> None:
+ self._selected_board = value
+
+ @property
+ def selected_baudrate(self) -> int:
+ return self._selected_baudrate
+
+ @selected_baudrate.setter
+ def selected_baudrate(self, value: int) -> None:
+ self._selected_baudrate = value
diff --git a/kiauh/components/klipper_firmware/menus/klipper_build_menu.py b/kiauh/components/klipper_firmware/menus/klipper_build_menu.py
new file mode 100644
index 0000000..cd92e4f
--- /dev/null
+++ b/kiauh/components/klipper_firmware/menus/klipper_build_menu.py
@@ -0,0 +1,114 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import List, Set, Type
+
+from components.klipper import KLIPPER_DIR
+from components.klipper_firmware.firmware_utils import (
+ run_make,
+ run_make_clean,
+ run_make_menuconfig,
+)
+from core.constants import COLOR_CYAN, COLOR_GREEN, COLOR_RED, RESET_FORMAT
+from core.logger import Logger
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+from utils.sys_utils import (
+ check_package_install,
+ install_system_packages,
+ update_system_package_lists,
+)
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperBuildFirmwareMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+ self.deps: Set[str] = {"build-essential", "dpkg-dev", "make"}
+ self.missing_deps: List[str] = check_package_install(self.deps)
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from core.menus.advanced_menu import AdvancedMenu
+
+ self.previous_menu = (
+ previous_menu if previous_menu is not None else AdvancedMenu
+ )
+
+ def set_options(self) -> None:
+ if len(self.missing_deps) == 0:
+ self.input_label_txt = "Press ENTER to continue"
+ self.default_option = Option(method=self.start_build_process)
+ else:
+ self.input_label_txt = "Press ENTER to install dependencies"
+ self.default_option = Option(method=self.install_missing_deps)
+
+ def print_menu(self) -> None:
+ header = " [ Build Firmware Menu ] "
+ color = COLOR_CYAN
+ count = 62 - len(color) - len(RESET_FORMAT)
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ The following dependencies are required: ║
+ ║ ║
+ """
+ )[1:]
+
+ for d in self.deps:
+ status_ok = f"{COLOR_GREEN}*INSTALLED*{RESET_FORMAT}"
+ status_missing = f"{COLOR_RED}*MISSING*{RESET_FORMAT}"
+ status = status_missing if d in self.missing_deps else status_ok
+ padding = 39 - len(d) + len(status) + (len(status_ok) - len(status))
+ d = f" {COLOR_CYAN}● {d}{RESET_FORMAT}"
+ menu += f"║ {d}{status:>{padding}} ║\n"
+ menu += "║ ║\n"
+
+ if len(self.missing_deps) == 0:
+ line = f"{COLOR_GREEN}All dependencies are met!{RESET_FORMAT}"
+ else:
+ line = f"{COLOR_RED}Dependencies are missing!{RESET_FORMAT}"
+
+ menu += f"║ {line:<62} ║\n"
+
+ print(menu, end="")
+
+ def install_missing_deps(self, **kwargs) -> None:
+ try:
+ update_system_package_lists(silent=False)
+ Logger.print_status("Installing system packages...")
+ install_system_packages(self.missing_deps)
+ except Exception as e:
+ Logger.print_error(e)
+ Logger.print_error("Installing dependencies failed!")
+ finally:
+ # restart this menu
+ KlipperBuildFirmwareMenu().run()
+
+ def start_build_process(self, **kwargs) -> None:
+ try:
+ run_make_clean()
+ run_make_menuconfig()
+ run_make()
+
+ Logger.print_ok("Firmware successfully built!")
+ Logger.print_ok(f"Firmware file located in '{KLIPPER_DIR}/out'!")
+
+ except Exception as e:
+ Logger.print_error(e)
+ Logger.print_error("Building Klipper Firmware failed!")
+
+ finally:
+ if self.previous_menu is not None:
+ self.previous_menu().run()
diff --git a/kiauh/components/klipper_firmware/menus/klipper_flash_error_menu.py b/kiauh/components/klipper_firmware/menus/klipper_flash_error_menu.py
new file mode 100644
index 0000000..19ab94e
--- /dev/null
+++ b/kiauh/components/klipper_firmware/menus/klipper_flash_error_menu.py
@@ -0,0 +1,111 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from components.klipper_firmware.flash_options import FlashMethod, FlashOptions
+from core.constants import COLOR_RED, RESET_FORMAT
+from core.menus import FooterType, Option
+from core.menus.base_menu import BaseMenu
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperNoFirmwareErrorMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+ self.flash_options = FlashOptions()
+ self.footer_type = FooterType.BLANK
+ self.input_label_txt = "Press ENTER to go back to [Advanced Menu]"
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ self.previous_menu = previous_menu
+
+ def set_options(self) -> None:
+ self.default_option = Option(method=self.go_back)
+
+ def print_menu(self) -> None:
+ header = "!!! NO FIRMWARE FILE FOUND !!!"
+ color = COLOR_RED
+ count = 62 - len(color) - len(RESET_FORMAT)
+ line1 = f"{color}Unable to find a compiled firmware file!{RESET_FORMAT}"
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ {line1:<62} ║
+ ║ ║
+ ║ Make sure, that: ║
+ ║ ● the folder '~/klipper/out' and its content exist ║
+ ║ ● the folder contains the following file: ║
+ """
+ )[1:]
+
+ if self.flash_options.flash_method is FlashMethod.REGULAR:
+ menu += "║ ● 'klipper.elf' ║\n"
+ menu += "║ ● 'klipper.elf.hex' ║\n"
+ else:
+ menu += "║ ● 'klipper.bin' ║\n"
+
+ print(menu, end="")
+
+ def go_back(self, **kwargs) -> None:
+ from core.menus.advanced_menu import AdvancedMenu
+
+ AdvancedMenu().run()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperNoBoardTypesErrorMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+ self.footer_type = FooterType.BLANK
+ self.input_label_txt = "Press ENTER to go back to [Main Menu]"
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ self.previous_menu = previous_menu
+
+ def set_options(self) -> None:
+ self.default_option = Option(method=self.go_back)
+
+ def print_menu(self) -> None:
+ header = "!!! ERROR GETTING BOARD LIST !!!"
+ color = COLOR_RED
+ count = 62 - len(color) - len(RESET_FORMAT)
+ line1 = f"{color}Reading the list of supported boards failed!{RESET_FORMAT}"
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ {line1:<62} ║
+ ║ ║
+ ║ Make sure, that: ║
+ ║ ● the folder '~/klipper' and all its content exist ║
+ ║ ● the content of folder '~/klipper' is not currupted ║
+ ║ ● the file '~/klipper/scripts/flash-sd.py' exist ║
+ ║ ● your current user has access to those files/folders ║
+ ║ ║
+ ║ If in doubt or this process continues to fail, please ║
+ ║ consider to download Klipper again. ║
+ """
+ )[1:]
+ print(menu, end="")
+
+ def go_back(self, **kwargs) -> None:
+ from core.menus.main_menu import MainMenu
+
+ MainMenu().run()
diff --git a/kiauh/components/klipper_firmware/menus/klipper_flash_help_menu.py b/kiauh/components/klipper_firmware/menus/klipper_flash_help_menu.py
new file mode 100644
index 0000000..831375e
--- /dev/null
+++ b/kiauh/components/klipper_firmware/menus/klipper_flash_help_menu.py
@@ -0,0 +1,170 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
+from core.menus.base_menu import BaseMenu
+
+
+# noinspection DuplicatedCode
+class KlipperFlashMethodHelpMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from components.klipper_firmware.menus.klipper_flash_menu import (
+ KlipperFlashMethodMenu,
+ )
+
+ self.previous_menu = (
+ previous_menu if previous_menu is not None else KlipperFlashMethodMenu
+ )
+
+ def set_options(self) -> None:
+ pass
+
+ def print_menu(self) -> None:
+ header = " < ? > Help: Flash MCU < ? > "
+ color = COLOR_YELLOW
+ count = 62 - len(color) - len(RESET_FORMAT)
+ subheader1 = f"{COLOR_CYAN}Regular flashing method:{RESET_FORMAT}"
+ subheader2 = f"{COLOR_CYAN}Updating via SD-Card Update:{RESET_FORMAT}"
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ {subheader1:<62} ║
+ ║ The default method to flash controller boards which ║
+ ║ are connected and updated over USB and not by placing ║
+ ║ a compiled firmware file onto an internal SD-Card. ║
+ ║ ║
+ ║ Common controllers that get flashed that way are: ║
+ ║ - Arduino Mega 2560 ║
+ ║ - Fysetc F6 / S6 (used without a Display + SD-Slot) ║
+ ║ ║
+ ║ {subheader2:<62} ║
+ ║ Many popular controller boards ship with a bootloader ║
+ ║ capable of updating the firmware via SD-Card. ║
+ ║ Choose this method if your controller board supports ║
+ ║ this way of updating. This method ONLY works for up- ║
+ ║ grading firmware. The initial flashing procedure must ║
+ ║ be done manually per the instructions that apply to ║
+ ║ your controller board. ║
+ ║ ║
+ ║ Common controllers that can be flashed that way are: ║
+ ║ - BigTreeTech SKR 1.3 / 1.4 (Turbo) / E3 / Mini E3 ║
+ ║ - Fysetc F6 / S6 (used with a Display + SD-Slot) ║
+ ║ - Fysetc Spider ║
+ ║ ║
+ ╟───────────────────────────────────────────────────────╢
+ """
+ )[1:]
+ print(menu, end="")
+
+
+# noinspection DuplicatedCode
+class KlipperFlashCommandHelpMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from components.klipper_firmware.menus.klipper_flash_menu import (
+ KlipperFlashCommandMenu,
+ )
+
+ self.previous_menu = (
+ previous_menu if previous_menu is not None else KlipperFlashCommandMenu
+ )
+
+ def set_options(self) -> None:
+ pass
+
+ def print_menu(self) -> None:
+ header = " < ? > Help: Flash MCU < ? > "
+ color = COLOR_YELLOW
+ count = 62 - len(color) - len(RESET_FORMAT)
+ subheader1 = f"{COLOR_CYAN}make flash:{RESET_FORMAT}"
+ subheader2 = f"{COLOR_CYAN}make serialflash:{RESET_FORMAT}"
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ {subheader1:<62} ║
+ ║ The default command to flash controller board, it ║
+ ║ will detect selected microcontroller and use suitable ║
+ ║ tool for flashing it. ║
+ ║ ║
+ ║ {subheader2:<62} ║
+ ║ Special command to flash STM32 microcontrollers in ║
+ ║ DFU mode but connected via serial. stm32flash command ║
+ ║ will be used internally. ║
+ ║ ║
+ """
+ )[1:]
+ print(menu, end="")
+
+
+# noinspection DuplicatedCode
+class KlipperMcuConnectionHelpMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from components.klipper_firmware.menus.klipper_flash_menu import (
+ KlipperSelectMcuConnectionMenu,
+ )
+
+ self.previous_menu = (
+ previous_menu
+ if previous_menu is not None
+ else KlipperSelectMcuConnectionMenu
+ )
+
+ def set_options(self) -> None:
+ pass
+
+ def print_menu(self) -> None:
+ header = " < ? > Help: Flash MCU < ? > "
+ color = COLOR_YELLOW
+ count = 62 - len(color) - len(RESET_FORMAT)
+ subheader1 = f"{COLOR_CYAN}USB:{RESET_FORMAT}"
+ subheader2 = f"{COLOR_CYAN}UART:{RESET_FORMAT}"
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ {subheader1:<62} ║
+ ║ Selecting USB as the connection method will scan the ║
+ ║ USB ports for connected controller boards. This will ║
+ ║ be similar to the 'ls /dev/serial/by-id/*' command ║
+ ║ suggested by the official Klipper documentation for ║
+ ║ determining successfull USB connections! ║
+ ║ ║
+ ║ {subheader2:<62} ║
+ ║ Selecting UART as the connection method will list all ║
+ ║ possible UART serial ports. Note: This method ALWAYS ║
+ ║ returns something as it seems impossible to determine ║
+ ║ if a valid Klipper controller board is connected or ║
+ ║ not. Because of that, you MUST know which UART serial ║
+ ║ port your controller board is connected to when using ║
+ ║ this connection method. ║
+ ║ ║
+ ╟───────────────────────────────────────────────────────╢
+ """
+ )[1:]
+ print(menu, end="")
diff --git a/kiauh/components/klipper_firmware/menus/klipper_flash_menu.py b/kiauh/components/klipper_firmware/menus/klipper_flash_menu.py
new file mode 100644
index 0000000..a32ccac
--- /dev/null
+++ b/kiauh/components/klipper_firmware/menus/klipper_flash_menu.py
@@ -0,0 +1,454 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+import time
+from typing import Type
+
+from components.klipper_firmware.firmware_utils import (
+ find_firmware_file,
+ find_uart_device,
+ find_usb_device_by_id,
+ find_usb_dfu_device,
+ get_sd_flash_board_list,
+ start_flash_process,
+)
+from components.klipper_firmware.flash_options import (
+ ConnectionType,
+ FlashCommand,
+ FlashMethod,
+ FlashOptions,
+)
+from components.klipper_firmware.menus.klipper_flash_error_menu import (
+ KlipperNoBoardTypesErrorMenu,
+ KlipperNoFirmwareErrorMenu,
+)
+from components.klipper_firmware.menus.klipper_flash_help_menu import (
+ KlipperFlashCommandHelpMenu,
+ KlipperFlashMethodHelpMenu,
+ KlipperMcuConnectionHelpMenu,
+)
+from core.constants import COLOR_CYAN, COLOR_RED, COLOR_YELLOW, RESET_FORMAT
+from core.logger import DialogType, Logger
+from core.menus import FooterType, Option
+from core.menus.base_menu import BaseMenu
+from utils.input_utils import get_number_input
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperFlashMethodMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+ super().__init__()
+ self.help_menu = KlipperFlashMethodHelpMenu
+ self.input_label_txt = "Select flash method"
+ self.footer_type = FooterType.BACK_HELP
+ self.flash_options = FlashOptions()
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from core.menus.advanced_menu import AdvancedMenu
+
+ self.previous_menu = (
+ previous_menu if previous_menu is not None else AdvancedMenu
+ )
+
+ def set_options(self) -> None:
+ self.options = {
+ "1": Option(self.select_regular),
+ "2": Option(self.select_sdcard),
+ }
+
+ def print_menu(self) -> None:
+ header = " [ MCU Flash Menu ] "
+ subheader = f"{COLOR_YELLOW}ATTENTION:{RESET_FORMAT}"
+ subline1 = f"{COLOR_YELLOW}Make sure to select the correct method for the MCU!{RESET_FORMAT}"
+ subline2 = f"{COLOR_YELLOW}Not all MCUs support both methods!{RESET_FORMAT}"
+
+ color = COLOR_CYAN
+ count = 62 - len(color) - len(RESET_FORMAT)
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ Select the flash method for flashing the MCU. ║
+ ║ ║
+ ║ {subheader:<62} ║
+ ║ {subline1:<62} ║
+ ║ {subline2:<62} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ 1) Regular flashing method ║
+ ║ 2) Updating via SD-Card Update ║
+ ╟───────────────────────────┬───────────────────────────╢
+ """
+ )[1:]
+ print(menu, end="")
+
+ def select_regular(self, **kwargs):
+ self.flash_options.flash_method = FlashMethod.REGULAR
+ self.goto_next_menu()
+
+ def select_sdcard(self, **kwargs):
+ self.flash_options.flash_method = FlashMethod.SD_CARD
+ self.goto_next_menu()
+
+ def goto_next_menu(self, **kwargs):
+ if find_firmware_file():
+ KlipperFlashCommandMenu(previous_menu=self.__class__).run()
+ else:
+ KlipperNoFirmwareErrorMenu().run()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperFlashCommandMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+ super().__init__()
+ self.help_menu = KlipperFlashCommandHelpMenu
+ self.input_label_txt = "Select flash command"
+ self.footer_type = FooterType.BACK_HELP
+ self.flash_options = FlashOptions()
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ self.previous_menu = (
+ previous_menu if previous_menu is not None else KlipperFlashMethodMenu
+ )
+
+ def set_options(self) -> None:
+ self.options = {
+ "1": Option(self.select_flash),
+ "2": Option(self.select_serialflash),
+ }
+ self.default_option = Option(self.select_flash)
+
+ def print_menu(self) -> None:
+ menu = textwrap.dedent(
+ """
+ ╔═══════════════════════════════════════════════════════╗
+ ║ Which flash command to use for flashing the MCU? ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ 1) make flash (default) ║
+ ║ 2) make serialflash (stm32flash) ║
+ ╟───────────────────────────┬───────────────────────────╢
+ """
+ )[1:]
+ print(menu, end="")
+
+ def select_flash(self, **kwargs):
+ self.flash_options.flash_command = FlashCommand.FLASH
+ self.goto_next_menu()
+
+ def select_serialflash(self, **kwargs):
+ self.flash_options.flash_command = FlashCommand.SERIAL_FLASH
+ self.goto_next_menu()
+
+ def goto_next_menu(self, **kwargs):
+ KlipperSelectMcuConnectionMenu(previous_menu=self.__class__).run()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperSelectMcuConnectionMenu(BaseMenu):
+ def __init__(
+ self, previous_menu: Type[BaseMenu] | None = None, standalone: bool = False
+ ):
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+ self.__standalone = standalone
+ self.help_menu = KlipperMcuConnectionHelpMenu
+ self.input_label_txt = "Select connection type"
+ self.footer_type = FooterType.BACK_HELP
+ self.flash_options = FlashOptions()
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ self.previous_menu = (
+ previous_menu if previous_menu is not None else KlipperFlashCommandMenu
+ )
+
+ def set_options(self) -> None:
+ self.options = {
+ "1": Option(method=self.select_usb),
+ "2": Option(method=self.select_dfu),
+ "3": Option(method=self.select_usb_dfu),
+ }
+
+ def print_menu(self) -> None:
+ header = "Make sure that the controller board is connected now!"
+ color = COLOR_YELLOW
+ count = 62 - len(color) - len(RESET_FORMAT)
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ How is the controller board connected to the host? ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ 1) USB ║
+ ║ 2) UART ║
+ ║ 3) USB (DFU mode) ║
+ ╟───────────────────────────┬───────────────────────────╢
+ """
+ )[1:]
+ print(menu, end="")
+
+ def select_usb(self, **kwargs):
+ self.flash_options.connection_type = ConnectionType.USB
+ self.get_mcu_list()
+
+ def select_dfu(self, **kwargs):
+ self.flash_options.connection_type = ConnectionType.UART
+ self.get_mcu_list()
+
+ def select_usb_dfu(self, **kwargs):
+ self.flash_options.connection_type = ConnectionType.USB_DFU
+ self.get_mcu_list()
+
+ def get_mcu_list(self, **kwargs):
+ conn_type = self.flash_options.connection_type
+
+ if conn_type is ConnectionType.USB:
+ Logger.print_status("Identifying MCU connected via USB ...")
+ self.flash_options.mcu_list = find_usb_device_by_id()
+ elif conn_type is ConnectionType.UART:
+ Logger.print_status("Identifying MCU possibly connected via UART ...")
+ self.flash_options.mcu_list = find_uart_device()
+ elif conn_type is ConnectionType.USB_DFU:
+ Logger.print_status("Identifying MCU connected via USB in DFU mode ...")
+ self.flash_options.mcu_list = find_usb_dfu_device()
+
+ if len(self.flash_options.mcu_list) < 1:
+ Logger.print_warn("No MCUs found!")
+ Logger.print_warn("Make sure they are connected and repeat this step.")
+
+ # if standalone is True, we only display the MCUs to the user and return
+ if self.__standalone and len(self.flash_options.mcu_list) > 0:
+ Logger.print_ok("The following MCUs were found:", prefix=False)
+ for i, mcu in enumerate(self.flash_options.mcu_list):
+ print(f" ● MCU #{i}: {COLOR_CYAN}{mcu}{RESET_FORMAT}")
+ time.sleep(3)
+ return
+
+ self.goto_next_menu()
+
+ def goto_next_menu(self, **kwargs):
+ KlipperSelectMcuIdMenu(previous_menu=self.__class__).run()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperSelectMcuIdMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+ super().__init__()
+ self.flash_options = FlashOptions()
+ self.mcu_list = self.flash_options.mcu_list
+ self.input_label_txt = "Select MCU to flash"
+ self.footer_type = FooterType.BACK_HELP
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ self.previous_menu = (
+ previous_menu
+ if previous_menu is not None
+ else KlipperSelectMcuConnectionMenu
+ )
+
+ def set_options(self) -> None:
+ self.options = {
+ f"{i}": Option(self.flash_mcu, f"{i}") for i in range(len(self.mcu_list))
+ }
+
+ def print_menu(self) -> None:
+ header = "!!! ATTENTION !!!"
+ header2 = f"[{COLOR_CYAN}List of available MCUs{RESET_FORMAT}]"
+ color = COLOR_RED
+ count = 62 - len(color) - len(RESET_FORMAT)
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ Make sure, to select the correct MCU! ║
+ ║ ONLY flash a firmware created for the respective MCU! ║
+ ║ ║
+ ╟{header2:─^64}╢
+ """
+ )[1:]
+
+ for i, mcu in enumerate(self.mcu_list):
+ mcu = mcu.split("/")[-1]
+ menu += f" ● MCU #{i}: {COLOR_CYAN}{mcu}{RESET_FORMAT}\n"
+ menu += "╟───────────────────────────┬───────────────────────────╢"
+
+ print(menu, end="\n")
+
+ def flash_mcu(self, **kwargs):
+ try:
+ index: int | None = kwargs.get("opt_index", None)
+ if index is None:
+ raise Exception("opt_index is None")
+
+ index = int(index)
+ selected_mcu = self.mcu_list[index]
+ self.flash_options.selected_mcu = selected_mcu
+
+ if self.flash_options.flash_method == FlashMethod.SD_CARD:
+ KlipperSelectSDFlashBoardMenu(previous_menu=self.__class__).run()
+ elif self.flash_options.flash_method == FlashMethod.REGULAR:
+ KlipperFlashOverviewMenu(previous_menu=self.__class__).run()
+ except Exception as e:
+ Logger.print_error(e)
+ Logger.print_error("Flashing failed!")
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperSelectSDFlashBoardMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+ super().__init__()
+ self.flash_options = FlashOptions()
+ self.available_boards = get_sd_flash_board_list()
+ self.input_label_txt = "Select board type"
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ self.previous_menu = (
+ previous_menu if previous_menu is not None else KlipperSelectMcuIdMenu
+ )
+
+ def set_options(self) -> None:
+ self.options = {
+ f"{i}": Option(self.board_select, f"{i}")
+ for i in range(len(self.available_boards))
+ }
+
+ def print_menu(self) -> None:
+ if len(self.available_boards) < 1:
+ KlipperNoBoardTypesErrorMenu().run()
+ else:
+ menu = textwrap.dedent(
+ """
+ ╔═══════════════════════════════════════════════════════╗
+ ║ Please select the type of board that corresponds to ║
+ ║ the currently selected MCU ID you chose before. ║
+ ║ ║
+ ║ The following boards are currently supported: ║
+ ╟───────────────────────────────────────────────────────╢
+ """
+ )[1:]
+
+ for i, board in enumerate(self.available_boards):
+ line = f" {i}) {board}"
+ menu += f"|{line:<55}|\n"
+
+ print(menu, end="")
+
+ def board_select(self, **kwargs):
+ try:
+ index: int | None = kwargs.get("opt_index", None)
+ if index is None:
+ raise Exception("opt_index is None")
+
+ index = int(index)
+ self.flash_options.selected_board = self.available_boards[index]
+ self.baudrate_select()
+ except Exception as e:
+ Logger.print_error(e)
+ Logger.print_error("Board selection failed!")
+
+ def baudrate_select(self, **kwargs):
+ Logger.print_dialog(
+ DialogType.CUSTOM,
+ [
+ "If your board is flashed with firmware that connects "
+ "at a custom baud rate, please change it now.",
+ "\n\n",
+ "If you are unsure, stick to the default 250000!",
+ ],
+ )
+ self.flash_options.selected_baudrate = get_number_input(
+ question="Please set the baud rate",
+ default=250000,
+ min_count=0,
+ allow_go_back=True,
+ )
+ KlipperFlashOverviewMenu(previous_menu=self.__class__).run()
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KlipperFlashOverviewMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+ super().__init__()
+ self.flash_options = FlashOptions()
+ self.input_label_txt = "Perform action (default=Y)"
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+ def set_options(self) -> None:
+ self.options = {
+ "Y": Option(self.execute_flash),
+ "N": Option(self.abort_process),
+ }
+
+ self.default_option = Option(self.execute_flash)
+
+ def print_menu(self) -> None:
+ header = "!!! ATTENTION !!!"
+ color = COLOR_RED
+ count = 62 - len(color) - len(RESET_FORMAT)
+
+ method = self.flash_options.flash_method.value
+ command = self.flash_options.flash_command.value
+ conn_type = self.flash_options.connection_type.value
+ mcu = self.flash_options.selected_mcu
+ board = self.flash_options.selected_board
+ baudrate = self.flash_options.selected_baudrate
+ subheader = f"[{COLOR_CYAN}Overview{RESET_FORMAT}]"
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ Before contuining the flashing process, please check ║
+ ║ if all parameters were set correctly! Once you made ║
+ ║ sure everything is correct, start the process. If any ║
+ ║ parameter needs to be changed, you can go back (B) ║
+ ║ step by step or abort and start from the beginning. ║
+ ║{subheader:-^64}║
+ """
+ )[1:]
+
+ menu += f" ● MCU: {COLOR_CYAN}{mcu}{RESET_FORMAT}\n"
+ menu += f" ● Connection: {COLOR_CYAN}{conn_type}{RESET_FORMAT}\n"
+ menu += f" ● Flash method: {COLOR_CYAN}{method}{RESET_FORMAT}\n"
+ menu += f" ● Flash command: {COLOR_CYAN}{command}{RESET_FORMAT}\n"
+
+ if self.flash_options.flash_method is FlashMethod.SD_CARD:
+ menu += f" ● Board type: {COLOR_CYAN}{board}{RESET_FORMAT}\n"
+ menu += f" ● Baudrate: {COLOR_CYAN}{baudrate}{RESET_FORMAT}\n"
+
+ menu += textwrap.dedent(
+ """
+ ╟───────────────────────────────────────────────────────╢
+ ║ Y) Start flash process ║
+ ║ N) Abort - Return to Advanced Menu ║
+ """
+ )
+ print(menu, end="")
+
+ def execute_flash(self, **kwargs):
+ start_flash_process(self.flash_options)
+ Logger.print_info("Returning to MCU Flash Menu in 5 seconds ...")
+ time.sleep(5)
+ KlipperFlashMethodMenu().run()
+
+ def abort_process(self, **kwargs):
+ from core.menus.advanced_menu import AdvancedMenu
+
+ AdvancedMenu().run()
diff --git a/kiauh/components/klipperscreen/__init__.py b/kiauh/components/klipperscreen/__init__.py
new file mode 100644
index 0000000..c86386d
--- /dev/null
+++ b/kiauh/components/klipperscreen/__init__.py
@@ -0,0 +1,34 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from pathlib import Path
+
+from core.backup_manager import BACKUP_ROOT_DIR
+from core.constants import SYSTEMD
+
+# repo
+KLIPPERSCREEN_REPO = "https://github.com/KlipperScreen/KlipperScreen.git"
+
+# names
+KLIPPERSCREEN_SERVICE_NAME = "KlipperScreen.service"
+KLIPPERSCREEN_UPDATER_SECTION_NAME = "update_manager KlipperScreen"
+KLIPPERSCREEN_LOG_NAME = "KlipperScreen.log"
+
+# directories
+KLIPPERSCREEN_DIR = Path.home().joinpath("KlipperScreen")
+KLIPPERSCREEN_ENV_DIR = Path.home().joinpath(".KlipperScreen-env")
+KLIPPERSCREEN_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("klipperscreen-backups")
+
+# files
+KLIPPERSCREEN_REQ_FILE = KLIPPERSCREEN_DIR.joinpath(
+ "scripts/KlipperScreen-requirements.txt"
+)
+KLIPPERSCREEN_INSTALL_SCRIPT = KLIPPERSCREEN_DIR.joinpath(
+ "scripts/KlipperScreen-install.sh"
+)
+KLIPPERSCREEN_SERVICE_FILE = SYSTEMD.joinpath(KLIPPERSCREEN_SERVICE_NAME)
diff --git a/kiauh/components/klipperscreen/klipperscreen.py b/kiauh/components/klipperscreen/klipperscreen.py
new file mode 100644
index 0000000..3ed0694
--- /dev/null
+++ b/kiauh/components/klipperscreen/klipperscreen.py
@@ -0,0 +1,206 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+import shutil
+from pathlib import Path
+from subprocess import CalledProcessError, run
+from typing import List
+
+from components.klipper.klipper import Klipper
+from components.klipperscreen import (
+ KLIPPERSCREEN_BACKUP_DIR,
+ KLIPPERSCREEN_DIR,
+ KLIPPERSCREEN_ENV_DIR,
+ KLIPPERSCREEN_INSTALL_SCRIPT,
+ KLIPPERSCREEN_LOG_NAME,
+ KLIPPERSCREEN_REPO,
+ KLIPPERSCREEN_REQ_FILE,
+ KLIPPERSCREEN_SERVICE_FILE,
+ KLIPPERSCREEN_SERVICE_NAME,
+ KLIPPERSCREEN_UPDATER_SECTION_NAME,
+)
+from components.moonraker.moonraker import Moonraker
+from core.backup_manager.backup_manager import BackupManager
+from core.constants import SYSTEMD
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
+from core.settings.kiauh_settings import KiauhSettings
+from core.types import ComponentStatus
+from utils.common import (
+ check_install_dependencies,
+ get_install_status,
+)
+from utils.config_utils import add_config_section, remove_config_section
+from utils.fs_utils import remove_with_sudo
+from utils.git_utils import (
+ git_clone_wrapper,
+ git_pull_wrapper,
+)
+from utils.input_utils import get_confirm
+from utils.instance_utils import get_instances
+from utils.sys_utils import (
+ check_python_version,
+ cmd_sysctl_service,
+ install_python_requirements,
+ remove_system_service,
+)
+
+
+def install_klipperscreen() -> None:
+ Logger.print_status("Installing KlipperScreen ...")
+
+ if not check_python_version(3, 7):
+ return
+
+ mr_instances = get_instances(Moonraker)
+ if not mr_instances:
+ Logger.print_dialog(
+ DialogType.WARNING,
+ [
+ "Moonraker not found! KlipperScreen will not properly work "
+ "without a working Moonraker installation.",
+ "\n\n",
+ "KlipperScreens update manager configuration for Moonraker "
+ "will not be added to any moonraker.conf.",
+ ],
+ )
+ if not get_confirm(
+ "Continue KlipperScreen installation?",
+ default_choice=False,
+ allow_go_back=True,
+ ):
+ return
+
+ check_install_dependencies()
+
+ git_clone_wrapper(KLIPPERSCREEN_REPO, KLIPPERSCREEN_DIR)
+
+ try:
+ run(KLIPPERSCREEN_INSTALL_SCRIPT.as_posix(), shell=True, check=True)
+ if mr_instances:
+ patch_klipperscreen_update_manager(mr_instances)
+ InstanceManager.restart_all(mr_instances)
+ else:
+ Logger.print_info(
+ "Moonraker is not installed! Cannot add "
+ "KlipperScreen to update manager!"
+ )
+ Logger.print_ok("KlipperScreen successfully installed!")
+ except CalledProcessError as e:
+ Logger.print_error(f"Error installing KlipperScreen:\n{e}")
+ return
+
+
+def patch_klipperscreen_update_manager(instances: List[Moonraker]) -> None:
+ add_config_section(
+ section=KLIPPERSCREEN_UPDATER_SECTION_NAME,
+ instances=instances,
+ options=[
+ ("type", "git_repo"),
+ ("path", KLIPPERSCREEN_DIR.as_posix()),
+ ("orgin", KLIPPERSCREEN_REPO),
+ ("manages_servcies", "KlipperScreen"),
+ ("env", f"{KLIPPERSCREEN_ENV_DIR}/bin/python"),
+ ("requirements", KLIPPERSCREEN_REQ_FILE.as_posix()),
+ ("install_script", KLIPPERSCREEN_INSTALL_SCRIPT.as_posix()),
+ ],
+ )
+
+
+def update_klipperscreen() -> None:
+ if not KLIPPERSCREEN_DIR.exists():
+ Logger.print_info("KlipperScreen does not seem to be installed! Skipping ...")
+ return
+
+ try:
+ Logger.print_status("Updating KlipperScreen ...")
+
+ cmd_sysctl_service(KLIPPERSCREEN_SERVICE_NAME, "stop")
+
+ settings = KiauhSettings()
+ if settings.kiauh.backup_before_update:
+ backup_klipperscreen_dir()
+
+ git_pull_wrapper(KLIPPERSCREEN_REPO, KLIPPERSCREEN_DIR)
+
+ install_python_requirements(KLIPPERSCREEN_ENV_DIR, KLIPPERSCREEN_REQ_FILE)
+
+ cmd_sysctl_service(KLIPPERSCREEN_SERVICE_NAME, "start")
+
+ Logger.print_ok("KlipperScreen updated successfully.", end="\n\n")
+ except CalledProcessError as e:
+ Logger.print_error(f"Error updating KlipperScreen:\n{e}")
+ return
+
+
+def get_klipperscreen_status() -> ComponentStatus:
+ return get_install_status(
+ KLIPPERSCREEN_DIR,
+ KLIPPERSCREEN_ENV_DIR,
+ files=[SYSTEMD.joinpath(KLIPPERSCREEN_SERVICE_NAME)],
+ )
+
+
+def remove_klipperscreen() -> None:
+ Logger.print_status("Removing KlipperScreen ...")
+ try:
+ if KLIPPERSCREEN_DIR.exists():
+ Logger.print_status("Removing KlipperScreen directory ...")
+ shutil.rmtree(KLIPPERSCREEN_DIR)
+ Logger.print_ok("KlipperScreen directory successfully removed!")
+ else:
+ Logger.print_warn("KlipperScreen directory not found!")
+
+ if KLIPPERSCREEN_ENV_DIR.exists():
+ Logger.print_status("Removing KlipperScreen environment ...")
+ shutil.rmtree(KLIPPERSCREEN_ENV_DIR)
+ Logger.print_ok("KlipperScreen environment successfully removed!")
+ else:
+ Logger.print_warn("KlipperScreen environment not found!")
+
+ if KLIPPERSCREEN_SERVICE_FILE.exists():
+ remove_system_service(KLIPPERSCREEN_SERVICE_NAME)
+
+ logfile = Path(f"/tmp/{KLIPPERSCREEN_LOG_NAME}")
+ if logfile.exists():
+ Logger.print_status("Removing KlipperScreen log file ...")
+ remove_with_sudo(logfile)
+ Logger.print_ok("KlipperScreen log file successfully removed!")
+
+ kl_instances: List[Klipper] = get_instances(Klipper)
+ for instance in kl_instances:
+ logfile = instance.base.log_dir.joinpath(KLIPPERSCREEN_LOG_NAME)
+ if logfile.exists():
+ Logger.print_status(f"Removing {logfile} ...")
+ Path(logfile).unlink()
+ Logger.print_ok(f"{logfile} successfully removed!")
+
+ mr_instances: List[Moonraker] = get_instances(Moonraker)
+ if mr_instances:
+ Logger.print_status("Removing KlipperScreen from update manager ...")
+ remove_config_section("update_manager KlipperScreen", mr_instances)
+ Logger.print_ok("KlipperScreen successfully removed from update manager!")
+
+ Logger.print_ok("KlipperScreen successfully removed!")
+
+ except Exception as e:
+ Logger.print_error(f"Error removing KlipperScreen:\n{e}")
+
+
+def backup_klipperscreen_dir() -> None:
+ bm = BackupManager()
+ bm.backup_directory(
+ KLIPPERSCREEN_DIR.name,
+ source=KLIPPERSCREEN_DIR,
+ target=KLIPPERSCREEN_BACKUP_DIR,
+ )
+ bm.backup_directory(
+ KLIPPERSCREEN_ENV_DIR.name,
+ source=KLIPPERSCREEN_ENV_DIR,
+ target=KLIPPERSCREEN_BACKUP_DIR,
+ )
diff --git a/kiauh/components/log_uploads/__init__.py b/kiauh/components/log_uploads/__init__.py
new file mode 100644
index 0000000..0303dee
--- /dev/null
+++ b/kiauh/components/log_uploads/__init__.py
@@ -0,0 +1,14 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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, Literal, Union
+
+FileKey = Literal["filepath", "display_name"]
+LogFile = Dict[FileKey, Union[str, Path]]
diff --git a/kiauh/components/log_uploads/log_upload_utils.py b/kiauh/components/log_uploads/log_upload_utils.py
new file mode 100644
index 0000000..97fdb7a
--- /dev/null
+++ b/kiauh/components/log_uploads/log_upload_utils.py
@@ -0,0 +1,55 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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 urllib.request
+from pathlib import Path
+from typing import List
+
+from components.klipper.klipper import Klipper
+from components.log_uploads import LogFile
+from core.logger import Logger
+from utils.instance_utils import get_instances
+
+
+def get_logfile_list() -> List[LogFile]:
+ log_dirs: List[Path] = [
+ instance.base.log_dir for instance in get_instances(Klipper)
+ ]
+
+ 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 successful! Access it via the following link:")
+ Logger.print_ok(f">>>> {link}", False)
+ except Exception as e:
+ Logger.print_error("Uploading logfile failed!")
+ Logger.print_error(str(e))
diff --git a/kiauh/components/log_uploads/menus/log_upload_menu.py b/kiauh/components/log_uploads/menus/log_upload_menu.py
new file mode 100644
index 0000000..5867e4e
--- /dev/null
+++ b/kiauh/components/log_uploads/menus/log_upload_menu.py
@@ -0,0 +1,70 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from components.log_uploads.log_upload_utils import get_logfile_list, upload_logfile
+from core.constants import COLOR_YELLOW, RESET_FORMAT
+from core.logger import Logger
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+
+
+# noinspection PyMethodMayBeStatic
+class LogUploadMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+ self.logfile_list = get_logfile_list()
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from core.menus.main_menu import MainMenu
+
+ self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+ def set_options(self) -> None:
+ self.options = {
+ f"{index}": Option(self.upload, opt_index=f"{index}")
+ for index in range(len(self.logfile_list))
+ }
+
+ def print_menu(self) -> None:
+ header = " [ Log Upload ] "
+ color = COLOR_YELLOW
+ count = 62 - len(color) - len(RESET_FORMAT)
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ You can select the following logfiles for uploading: ║
+ ║ ║
+ """
+ )[1:]
+
+ for logfile in enumerate(self.logfile_list):
+ line = f"{logfile[0]}) {logfile[1].get('display_name')}"
+ menu += f"║ {line:<54}║\n"
+ menu += "╟───────────────────────────────────────────────────────╢\n"
+
+ print(menu, end="")
+
+ def upload(self, **kwargs):
+ try:
+ index: int | None = kwargs.get("opt_index", None)
+ if index is None:
+ raise Exception("opt_index is None")
+
+ index = int(index)
+ upload_logfile(self.logfile_list[index])
+ except Exception as e:
+ Logger.print_error(e)
+ Logger.print_error("Log upload failed!")
diff --git a/kiauh/components/mobileraker/__init__.py b/kiauh/components/mobileraker/__init__.py
new file mode 100644
index 0000000..e8be4ad
--- /dev/null
+++ b/kiauh/components/mobileraker/__init__.py
@@ -0,0 +1,30 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from pathlib import Path
+
+from core.backup_manager import BACKUP_ROOT_DIR
+from core.constants import SYSTEMD
+
+# repo
+MOBILERAKER_REPO = "https://github.com/Clon1998/mobileraker_companion.git"
+
+# names
+MOBILERAKER_SERVICE_NAME = "mobileraker.service"
+MOBILERAKER_UPDATER_SECTION_NAME = "update_manager mobileraker"
+MOBILERAKER_LOG_NAME = "mobileraker.log"
+
+# directories
+MOBILERAKER_DIR = Path.home().joinpath("mobileraker_companion")
+MOBILERAKER_ENV_DIR = Path.home().joinpath("mobileraker-env")
+MOBILERAKER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("mobileraker-backups")
+
+# files
+MOBILERAKER_INSTALL_SCRIPT = MOBILERAKER_DIR.joinpath("scripts/install.sh")
+MOBILERAKER_REQ_FILE = MOBILERAKER_DIR.joinpath("scripts/mobileraker-requirements.txt")
+MOBILERAKER_SERVICE_FILE = SYSTEMD.joinpath(MOBILERAKER_SERVICE_NAME)
diff --git a/kiauh/components/mobileraker/mobileraker.py b/kiauh/components/mobileraker/mobileraker.py
new file mode 100644
index 0000000..6370524
--- /dev/null
+++ b/kiauh/components/mobileraker/mobileraker.py
@@ -0,0 +1,201 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+import shutil
+from pathlib import Path
+from subprocess import CalledProcessError, run
+from typing import List
+
+from components.klipper.klipper import Klipper
+from components.mobileraker import (
+ MOBILERAKER_BACKUP_DIR,
+ MOBILERAKER_DIR,
+ MOBILERAKER_ENV_DIR,
+ MOBILERAKER_INSTALL_SCRIPT,
+ MOBILERAKER_LOG_NAME,
+ MOBILERAKER_REPO,
+ MOBILERAKER_REQ_FILE,
+ MOBILERAKER_SERVICE_FILE,
+ MOBILERAKER_SERVICE_NAME,
+ MOBILERAKER_UPDATER_SECTION_NAME,
+)
+from components.moonraker.moonraker import Moonraker
+from core.backup_manager.backup_manager import BackupManager
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
+from core.settings.kiauh_settings import KiauhSettings
+from core.types import ComponentStatus
+from utils.common import check_install_dependencies, get_install_status
+from utils.config_utils import add_config_section, remove_config_section
+from utils.git_utils import (
+ git_clone_wrapper,
+ git_pull_wrapper,
+)
+from utils.input_utils import get_confirm
+from utils.instance_utils import get_instances
+from utils.sys_utils import (
+ check_python_version,
+ cmd_sysctl_service,
+ install_python_requirements,
+ remove_system_service,
+)
+
+
+def install_mobileraker() -> None:
+ Logger.print_status("Installing Mobileraker's companion ...")
+
+ if not check_python_version(3, 7):
+ return
+
+ mr_instances = get_instances(Moonraker)
+ if not mr_instances:
+ Logger.print_dialog(
+ DialogType.WARNING,
+ [
+ "Moonraker not found! Mobileraker's companion will not properly work "
+ "without a working Moonraker installation.",
+ "Mobileraker's companion's update manager configuration for Moonraker "
+ "will not be added to any moonraker.conf.",
+ ],
+ )
+ if not get_confirm(
+ "Continue Mobileraker's companion installation?",
+ default_choice=False,
+ allow_go_back=True,
+ ):
+ return
+
+ check_install_dependencies()
+
+ git_clone_wrapper(MOBILERAKER_REPO, MOBILERAKER_DIR)
+
+ try:
+ run(MOBILERAKER_INSTALL_SCRIPT.as_posix(), shell=True, check=True)
+ if mr_instances:
+ patch_mobileraker_update_manager(mr_instances)
+ InstanceManager.restart_all(mr_instances)
+ else:
+ Logger.print_info(
+ "Moonraker is not installed! Cannot add Mobileraker's "
+ "companion to update manager!"
+ )
+ Logger.print_ok("Mobileraker's companion successfully installed!")
+ except CalledProcessError as e:
+ Logger.print_error(f"Error installing Mobileraker's companion:\n{e}")
+ return
+
+
+def patch_mobileraker_update_manager(instances: List[Moonraker]) -> None:
+ add_config_section(
+ section=MOBILERAKER_UPDATER_SECTION_NAME,
+ instances=instances,
+ options=[
+ ("type", "git_repo"),
+ ("path", MOBILERAKER_DIR.as_posix()),
+ ("origin", MOBILERAKER_REPO),
+ ("primary_branch", "main"),
+ ("managed_services", "mobileraker"),
+ ("env", f"{MOBILERAKER_ENV_DIR}/bin/python"),
+ ("requirements", MOBILERAKER_REQ_FILE.as_posix()),
+ ("install_script", MOBILERAKER_INSTALL_SCRIPT.as_posix()),
+ ],
+ )
+
+
+def update_mobileraker() -> None:
+ try:
+ if not MOBILERAKER_DIR.exists():
+ Logger.print_info(
+ "Mobileraker's companion does not seem to be installed! Skipping ..."
+ )
+ return
+
+ Logger.print_status("Updating Mobileraker's companion ...")
+
+ cmd_sysctl_service(MOBILERAKER_SERVICE_NAME, "stop")
+
+ settings = KiauhSettings()
+ if settings.kiauh.backup_before_update:
+ backup_mobileraker_dir()
+
+ git_pull_wrapper(MOBILERAKER_REPO, MOBILERAKER_DIR)
+
+ install_python_requirements(MOBILERAKER_ENV_DIR, MOBILERAKER_REQ_FILE)
+
+ cmd_sysctl_service(MOBILERAKER_SERVICE_NAME, "start")
+
+ Logger.print_ok("Mobileraker's companion updated successfully.", end="\n\n")
+ except CalledProcessError as e:
+ Logger.print_error(f"Error updating Mobileraker's companion:\n{e}")
+ return
+
+
+def get_mobileraker_status() -> ComponentStatus:
+ return get_install_status(
+ MOBILERAKER_DIR,
+ MOBILERAKER_ENV_DIR,
+ files=[MOBILERAKER_SERVICE_FILE],
+ )
+
+
+def remove_mobileraker() -> None:
+ Logger.print_status("Removing Mobileraker's companion ...")
+ try:
+ if MOBILERAKER_DIR.exists():
+ Logger.print_status("Removing Mobileraker's companion directory ...")
+ shutil.rmtree(MOBILERAKER_DIR)
+ Logger.print_ok("Mobileraker's companion directory successfully removed!")
+ else:
+ Logger.print_warn("Mobileraker's companion directory not found!")
+
+ if MOBILERAKER_ENV_DIR.exists():
+ Logger.print_status("Removing Mobileraker's companion environment ...")
+ shutil.rmtree(MOBILERAKER_ENV_DIR)
+ Logger.print_ok("Mobileraker's companion environment successfully removed!")
+ else:
+ Logger.print_warn("Mobileraker's companion environment not found!")
+
+ if MOBILERAKER_SERVICE_FILE.exists():
+ remove_system_service(MOBILERAKER_SERVICE_NAME)
+
+ kl_instances: List[Klipper] = get_instances(Klipper)
+ for instance in kl_instances:
+ logfile = instance.base.log_dir.joinpath(MOBILERAKER_LOG_NAME)
+ if logfile.exists():
+ Logger.print_status(f"Removing {logfile} ...")
+ Path(logfile).unlink()
+ Logger.print_ok(f"{logfile} successfully removed!")
+
+ mr_instances: List[Moonraker] = get_instances(Moonraker)
+ if mr_instances:
+ Logger.print_status(
+ "Removing Mobileraker's companion from update manager ..."
+ )
+ remove_config_section(MOBILERAKER_UPDATER_SECTION_NAME, mr_instances)
+ Logger.print_ok(
+ "Mobileraker's companion successfully removed from update manager!"
+ )
+
+ Logger.print_ok("Mobileraker's companion successfully removed!")
+
+ except Exception as e:
+ Logger.print_error(f"Error removing Mobileraker's companion:\n{e}")
+
+
+def backup_mobileraker_dir() -> None:
+ bm = BackupManager()
+ bm.backup_directory(
+ MOBILERAKER_DIR.name,
+ source=MOBILERAKER_DIR,
+ target=MOBILERAKER_BACKUP_DIR,
+ )
+ bm.backup_directory(
+ MOBILERAKER_ENV_DIR.name,
+ source=MOBILERAKER_ENV_DIR,
+ target=MOBILERAKER_BACKUP_DIR,
+ )
diff --git a/kiauh/components/moonraker/__init__.py b/kiauh/components/moonraker/__init__.py
new file mode 100644
index 0000000..8924129
--- /dev/null
+++ b/kiauh/components/moonraker/__init__.py
@@ -0,0 +1,45 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+
+from pathlib import Path
+
+from core.backup_manager import BACKUP_ROOT_DIR
+
+MODULE_PATH = Path(__file__).resolve().parent
+
+# names
+MOONRAKER_CFG_NAME = "moonraker.conf"
+MOONRAKER_LOG_NAME = "moonraker.log"
+MOONRAKER_SERVICE_NAME = "moonraker.service"
+MOONRAKER_DEFAULT_PORT = 7125
+MOONRAKER_ENV_FILE_NAME = "moonraker.env"
+
+# directories
+MOONRAKER_DIR = Path.home().joinpath("moonraker")
+MOONRAKER_ENV_DIR = Path.home().joinpath("moonraker-env")
+MOONRAKER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("moonraker-backups")
+MOONRAKER_DB_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("moonraker-db-backups")
+
+# files
+MOONRAKER_INSTALL_SCRIPT = MOONRAKER_DIR.joinpath("scripts/install-moonraker.sh")
+MOONRAKER_REQ_FILE = MOONRAKER_DIR.joinpath("scripts/moonraker-requirements.txt")
+MOONRAKER_SPEEDUPS_REQ_FILE = MOONRAKER_DIR.joinpath("scripts/moonraker-speedups.txt")
+MOONRAKER_DEPS_JSON_FILE = MOONRAKER_DIR.joinpath("scripts/system-dependencies.json")
+# introduced due to
+# https://github.com/Arksine/moonraker/issues/349
+# https://github.com/Arksine/moonraker/pull/346
+POLKIT_LEGACY_FILE = Path("/etc/polkit-1/localauthority/50-local.d/10-moonraker.pkla")
+POLKIT_FILE = Path("/etc/polkit-1/rules.d/moonraker.rules")
+POLKIT_USR_FILE = Path("/usr/share/polkit-1/rules.d/moonraker.rules")
+POLKIT_SCRIPT = MOONRAKER_DIR.joinpath("scripts/set-policykit-rules.sh")
+MOONRAKER_SERVICE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{MOONRAKER_SERVICE_NAME}")
+MOONRAKER_ENV_FILE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{MOONRAKER_ENV_FILE_NAME}")
+
+
+EXIT_MOONRAKER_SETUP = "Exiting Moonraker setup ..."
diff --git a/kiauh/components/moonraker/assets/moonraker.conf b/kiauh/components/moonraker/assets/moonraker.conf
new file mode 100644
index 0000000..d985233
--- /dev/null
+++ b/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
diff --git a/kiauh/components/moonraker/assets/moonraker.env b/kiauh/components/moonraker/assets/moonraker.env
new file mode 100644
index 0000000..bca6af5
--- /dev/null
+++ b/kiauh/components/moonraker/assets/moonraker.env
@@ -0,0 +1 @@
+MOONRAKER_ARGS="%MOONRAKER_DIR%/moonraker/moonraker.py -d %PRINTER_DATA%"
\ No newline at end of file
diff --git a/kiauh/components/moonraker/assets/moonraker.service b/kiauh/components/moonraker/assets/moonraker.service
new file mode 100644
index 0000000..696d7ba
--- /dev/null
+++ b/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
diff --git a/kiauh/components/moonraker/menus/__init__.py b/kiauh/components/moonraker/menus/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/kiauh/components/moonraker/menus/moonraker_remove_menu.py b/kiauh/components/moonraker/menus/moonraker_remove_menu.py
new file mode 100644
index 0000000..2721675
--- /dev/null
+++ b/kiauh/components/moonraker/menus/moonraker_remove_menu.py
@@ -0,0 +1,128 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from components.moonraker import moonraker_remove
+from core.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+
+
+# noinspection PyUnusedLocal
+class MoonrakerRemoveMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+ self.remove_moonraker_service = False
+ self.remove_moonraker_dir = False
+ self.remove_moonraker_env = False
+ self.remove_moonraker_polkit = False
+ self.selection_state = False
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from core.menus.remove_menu import RemoveMenu
+
+ self.previous_menu = previous_menu if previous_menu is not None else RemoveMenu
+
+ def set_options(self) -> None:
+ self.options = {
+ "a": Option(method=self.toggle_all),
+ "1": Option(method=self.toggle_remove_moonraker_service),
+ "2": Option(method=self.toggle_remove_moonraker_dir),
+ "3": Option(method=self.toggle_remove_moonraker_env),
+ "4": Option(method=self.toggle_remove_moonraker_polkit),
+ "c": Option(method=self.run_removal_process),
+ }
+
+ def print_menu(self) -> None:
+ header = " [ Remove Moonraker ] "
+ 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
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ Enter a number and hit enter to select / deselect ║
+ ║ the specific option for removal. ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ a) {self._get_selection_state_str():37} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ 1) {o1} Remove Service ║
+ ║ 2) {o2} Remove Local Repository ║
+ ║ 3) {o3} Remove Python Environment ║
+ ║ 4) {o4} Remove Policy Kit Rules ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ C) Continue ║
+ ╟───────────────────────────────────────────────────────╢
+ """
+ )[1:]
+ print(menu, end="")
+
+ def toggle_all(self, **kwargs) -> None:
+ self.selection_state = not self.selection_state
+ self.remove_moonraker_service = self.selection_state
+ self.remove_moonraker_dir = self.selection_state
+ self.remove_moonraker_env = self.selection_state
+ self.remove_moonraker_polkit = self.selection_state
+
+ def toggle_remove_moonraker_service(self, **kwargs) -> None:
+ self.remove_moonraker_service = not self.remove_moonraker_service
+
+ 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 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
+ ):
+ 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.remove_moonraker_service = False
+ self.remove_moonraker_dir = False
+ self.remove_moonraker_env = False
+ self.remove_moonraker_polkit = False
+
+ self._go_back()
+
+ def _get_selection_state_str(self) -> str:
+ return (
+ "Select everything" if not self.selection_state else "Deselect everything"
+ )
+
+ def _go_back(self, **kwargs) -> None:
+ if self.previous_menu is not None:
+ self.previous_menu().run()
diff --git a/kiauh/components/moonraker/moonraker.py b/kiauh/components/moonraker/moonraker.py
new file mode 100644
index 0000000..0aad053
--- /dev/null
+++ b/kiauh/components/moonraker/moonraker.py
@@ -0,0 +1,144 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from pathlib import Path
+from subprocess import CalledProcessError
+
+from components.klipper.klipper import Klipper
+from components.moonraker import (
+ MOONRAKER_CFG_NAME,
+ MOONRAKER_DIR,
+ MOONRAKER_ENV_DIR,
+ MOONRAKER_ENV_FILE_NAME,
+ MOONRAKER_ENV_FILE_TEMPLATE,
+ MOONRAKER_LOG_NAME,
+ MOONRAKER_SERVICE_TEMPLATE,
+)
+from core.constants import CURRENT_USER
+from core.instance_manager.base_instance import BaseInstance
+from core.logger import Logger
+from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+ SimpleConfigParser,
+)
+from utils.fs_utils import create_folders
+from utils.sys_utils import get_service_file_path
+
+
+# noinspection PyMethodMayBeStatic
+@dataclass
+class Moonraker:
+ suffix: str
+ base: BaseInstance = field(init=False, repr=False)
+ service_file_path: Path = field(init=False)
+ log_file_name: str = MOONRAKER_LOG_NAME
+ moonraker_dir: Path = MOONRAKER_DIR
+ env_dir: Path = MOONRAKER_ENV_DIR
+ data_dir: Path = field(init=False)
+ cfg_file: Path = field(init=False)
+ backup_dir: Path = field(init=False)
+ certs_dir: Path = field(init=False)
+ db_dir: Path = field(init=False)
+ port: int | None = field(init=False)
+
+ def __post_init__(self):
+ self.base: BaseInstance = BaseInstance(Klipper, self.suffix)
+ self.base.log_file_name = self.log_file_name
+
+ self.service_file_path: Path = get_service_file_path(Moonraker, self.suffix)
+ self.data_dir: Path = self.base.data_dir
+ self.cfg_file: Path = self.base.cfg_dir.joinpath(MOONRAKER_CFG_NAME)
+ self.backup_dir: Path = self.base.data_dir.joinpath("backup")
+ self.certs_dir: Path = self.base.data_dir.joinpath("certs")
+ self.db_dir: Path = self.base.data_dir.joinpath("database")
+ self.port: int | None = self._get_port()
+
+ def create(self) -> None:
+ from utils.sys_utils import create_env_file, create_service_file
+
+ Logger.print_status("Creating new Moonraker Instance ...")
+
+ try:
+ create_folders(self.base.base_folders)
+
+ create_service_file(
+ name=self.service_file_path.name,
+ content=self._prep_service_file_content(),
+ )
+ create_env_file(
+ path=self.base.sysd_dir.joinpath(MOONRAKER_ENV_FILE_NAME),
+ content=self._prep_env_file_content(),
+ )
+
+ except CalledProcessError as e:
+ Logger.print_error(f"Error creating instance: {e}")
+ raise
+ except OSError as e:
+ Logger.print_error(f"Error creating env file: {e}")
+ raise
+
+ def _prep_service_file_content(self) -> str:
+ template = MOONRAKER_SERVICE_TEMPLATE
+
+ try:
+ with open(template, "r") as template_file:
+ template_content = template_file.read()
+ except FileNotFoundError:
+ Logger.print_error(f"Unable to open {template} - File not found")
+ raise
+
+ service_content = template_content.replace(
+ "%USER%",
+ CURRENT_USER,
+ )
+ service_content = service_content.replace(
+ "%MOONRAKER_DIR%",
+ self.moonraker_dir.as_posix(),
+ )
+ service_content = service_content.replace(
+ "%ENV%",
+ self.env_dir.as_posix(),
+ )
+ service_content = service_content.replace(
+ "%ENV_FILE%",
+ self.base.sysd_dir.joinpath(MOONRAKER_ENV_FILE_NAME).as_posix(),
+ )
+ return service_content
+
+ def _prep_env_file_content(self) -> str:
+ template = MOONRAKER_ENV_FILE_TEMPLATE
+
+ try:
+ with open(template, "r") as env_file:
+ env_template_file_content = env_file.read()
+ except FileNotFoundError:
+ Logger.print_error(f"Unable to open {template} - File not found")
+ raise
+
+ env_file_content = env_template_file_content.replace(
+ "%MOONRAKER_DIR%",
+ self.moonraker_dir.as_posix(),
+ )
+ env_file_content = env_file_content.replace(
+ "%PRINTER_DATA%",
+ self.base.data_dir.as_posix(),
+ )
+
+ return env_file_content
+
+ def _get_port(self) -> int | None:
+ if not self.cfg_file or not self.cfg_file.is_file():
+ return None
+
+ scp = SimpleConfigParser()
+ scp.read(self.cfg_file)
+ port: int | None = scp.getint("server", "port", fallback=None)
+
+ return port
diff --git a/kiauh/components/moonraker/moonraker_dialogs.py b/kiauh/components/moonraker/moonraker_dialogs.py
new file mode 100644
index 0000000..63e6789
--- /dev/null
+++ b/kiauh/components/moonraker/moonraker_dialogs.py
@@ -0,0 +1,71 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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 components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from core.constants import COLOR_CYAN, COLOR_GREEN, COLOR_YELLOW, RESET_FORMAT
+from core.menus.base_menu import print_back_footer
+
+
+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.service_file_path.stem: (
+ k.service_file_path.stem.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+1})' 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()
diff --git a/kiauh/components/moonraker/moonraker_remove.py b/kiauh/components/moonraker/moonraker_remove.py
new file mode 100644
index 0000000..7fe5ef9
--- /dev/null
+++ b/kiauh/components/moonraker/moonraker_remove.py
@@ -0,0 +1,124 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+from subprocess import DEVNULL, PIPE, CalledProcessError, run
+from typing import List
+
+from components.klipper.klipper_dialogs import print_instance_overview
+from components.moonraker import MOONRAKER_DIR, MOONRAKER_ENV_DIR
+from components.moonraker.moonraker import Moonraker
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
+from utils.fs_utils import run_remove_routines
+from utils.input_utils import get_selection_input
+from utils.instance_utils import get_instances
+from utils.sys_utils import unit_file_exists
+
+
+def run_moonraker_removal(
+ remove_service: bool,
+ remove_dir: bool,
+ remove_env: bool,
+ remove_polkit: bool,
+) -> None:
+ instances = get_instances(Moonraker)
+
+ if remove_service:
+ Logger.print_status("Removing Moonraker instances ...")
+ if instances:
+ instances_to_remove = select_instances_to_remove(instances)
+ remove_instances(instances_to_remove)
+ else:
+ Logger.print_info("No Moonraker Services installed! Skipped ...")
+
+ delete_remaining: bool = remove_polkit or remove_dir or remove_env
+ if delete_remaining and unit_file_exists("moonraker", suffix="service"):
+ Logger.print_info("There are still other Moonraker services installed")
+ Logger.print_info(
+ "● Moonraker PolicyKit rules were not removed.", prefix=False
+ )
+ Logger.print_info(f"● '{MOONRAKER_DIR}' was not removed.", prefix=False)
+ Logger.print_info(f"● '{MOONRAKER_ENV_DIR}' was not removed.", prefix=False)
+ else:
+ if remove_polkit:
+ Logger.print_status("Removing all Moonraker policykit rules ...")
+ remove_polkit_rules()
+ if remove_dir:
+ Logger.print_status("Removing Moonraker local repository ...")
+ run_remove_routines(MOONRAKER_DIR)
+ if remove_env:
+ Logger.print_status("Removing Moonraker Python environment ...")
+ run_remove_routines(MOONRAKER_ENV_DIR)
+
+
+def select_instances_to_remove(
+ instances: List[Moonraker],
+) -> List[Moonraker] | None:
+ start_index = 1
+ options = [str(i + start_index) for i in range(len(instances))]
+ options.extend(["a", "b"])
+ instance_map = {options[i]: instances[i] for i in range(len(instances))}
+
+ print_instance_overview(
+ instances,
+ start_index=start_index,
+ show_index=True,
+ show_select_all=True,
+ )
+ selection = get_selection_input("Select Moonraker instance to remove", options)
+
+ instances_to_remove = []
+ if selection == "b":
+ return None
+ elif selection == "a":
+ instances_to_remove.extend(instances)
+ else:
+ instances_to_remove.append(instance_map[selection])
+
+ return instances_to_remove
+
+
+def remove_instances(
+ instance_list: List[Moonraker] | None,
+) -> None:
+ if not instance_list:
+ Logger.print_info("No Moonraker instances found. Skipped ...")
+ return
+ for instance in instance_list:
+ Logger.print_status(f"Removing instance {instance.service_file_path.stem} ...")
+ InstanceManager.remove(instance)
+
+
+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:
+ cmd = [f"{MOONRAKER_DIR}/scripts/set-policykit-rules.sh", "--clear"]
+ run(cmd, stderr=PIPE, stdout=DEVNULL, check=True)
+ except CalledProcessError as e:
+ Logger.print_error(f"Error while removing policykit rules: {e}")
+
+ Logger.print_ok("Policykit rules successfully removed!")
+
+
+def delete_moonraker_logs(instances: List[Moonraker]) -> None:
+ all_logfiles = []
+ for instance in instances:
+ all_logfiles = list(instance.base.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}'")
+ run_remove_routines(log)
diff --git a/kiauh/components/moonraker/moonraker_setup.py b/kiauh/components/moonraker/moonraker_setup.py
new file mode 100644
index 0000000..d7b8a15
--- /dev/null
+++ b/kiauh/components/moonraker/moonraker_setup.py
@@ -0,0 +1,219 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import json
+import subprocess
+from typing import List
+
+from components.klipper.klipper import Klipper
+from components.moonraker import (
+ EXIT_MOONRAKER_SETUP,
+ MOONRAKER_DEPS_JSON_FILE,
+ MOONRAKER_DIR,
+ MOONRAKER_ENV_DIR,
+ MOONRAKER_INSTALL_SCRIPT,
+ MOONRAKER_REQ_FILE,
+ MOONRAKER_SPEEDUPS_REQ_FILE,
+ POLKIT_FILE,
+ POLKIT_LEGACY_FILE,
+ POLKIT_SCRIPT,
+ POLKIT_USR_FILE,
+)
+from components.moonraker.moonraker import Moonraker
+from components.moonraker.moonraker_dialogs import print_moonraker_overview
+from components.moonraker.moonraker_utils import (
+ backup_moonraker_dir,
+ create_example_moonraker_conf,
+)
+from components.webui_client.client_utils import (
+ enable_mainsail_remotemode,
+ get_existing_clients,
+)
+from components.webui_client.mainsail_data import MainsailData
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
+from core.settings.kiauh_settings import KiauhSettings
+from utils.common import check_install_dependencies
+from utils.fs_utils import check_file_exist
+from utils.git_utils import git_clone_wrapper, git_pull_wrapper
+from utils.input_utils import (
+ get_confirm,
+ get_selection_input,
+)
+from utils.instance_utils import get_instances
+from utils.sys_utils import (
+ check_python_version,
+ cmd_sysctl_manage,
+ cmd_sysctl_service,
+ create_python_venv,
+ install_python_requirements,
+ parse_packages_from_file,
+)
+
+
+def install_moonraker() -> None:
+ klipper_list: List[Klipper] = get_instances(Klipper)
+
+ if not check_moonraker_install_requirements(klipper_list):
+ return
+
+ moonraker_list: List[Moonraker] = get_instances(Moonraker)
+ instances: List[Moonraker] = []
+ selected_option: str | Klipper
+
+ if len(klipper_list) == 1:
+ instances.append(Moonraker(klipper_list[0].suffix))
+ else:
+ print_moonraker_overview(
+ klipper_list,
+ moonraker_list,
+ show_index=True,
+ show_select_all=True,
+ )
+ options = {str(i + 1): k for i, k in enumerate(klipper_list)}
+ additional_options = {"a": None, "b": None}
+ options = {**options, **additional_options}
+ question = "Select Klipper instance to setup Moonraker for"
+ selected_option = get_selection_input(question, options)
+
+ if selected_option == "b":
+ Logger.print_status(EXIT_MOONRAKER_SETUP)
+ return
+
+ if selected_option == "a":
+ instances.extend([Moonraker(k.suffix) for k in klipper_list])
+ else:
+ klipper_instance: Klipper | None = options.get(selected_option)
+ if klipper_instance is None:
+ raise Exception("Error selecting instance!")
+ instances.append(Moonraker(klipper_instance.suffix))
+
+ create_example_cfg = get_confirm("Create example moonraker.conf?")
+
+ try:
+ check_install_dependencies()
+ setup_moonraker_prerequesites()
+ install_moonraker_polkit()
+
+ used_ports_map = {m.suffix: m.port for m in moonraker_list}
+ for instance in instances:
+ instance.create()
+ cmd_sysctl_service(instance.service_file_path.name, "enable")
+
+ if create_example_cfg:
+ # if a webclient and/or it's config is installed, patch
+ # its update section to the config
+ clients = get_existing_clients()
+ create_example_moonraker_conf(instance, used_ports_map, clients)
+
+ cmd_sysctl_service(instance.service_file_path.name, "start")
+
+ cmd_sysctl_manage("daemon-reload")
+
+ # if mainsail is installed, and we installed
+ # multiple moonraker instances, we enable mainsails remote mode
+ if MainsailData().client_dir.exists() and len(moonraker_list) > 1:
+ enable_mainsail_remotemode()
+
+ except Exception as e:
+ Logger.print_error(f"Error while installing Moonraker: {e}")
+ return
+
+
+def check_moonraker_install_requirements(klipper_list: List[Klipper]) -> bool:
+ def check_klipper_instances() -> bool:
+ if len(klipper_list) >= 1:
+ return True
+
+ Logger.print_warn("Klipper not installed!")
+ Logger.print_warn("Moonraker cannot be installed! Install Klipper first.")
+ return False
+
+ return check_python_version(3, 7) and check_klipper_instances()
+
+
+def setup_moonraker_prerequesites() -> None:
+ settings = KiauhSettings()
+ repo = settings.moonraker.repo_url
+ branch = settings.moonraker.branch
+
+ git_clone_wrapper(repo, MOONRAKER_DIR, branch)
+
+ # install moonraker dependencies and create python virtualenv
+ install_moonraker_packages()
+ if create_python_venv(MOONRAKER_ENV_DIR):
+ install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
+ install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_SPEEDUPS_REQ_FILE)
+
+
+def install_moonraker_packages() -> None:
+ moonraker_deps = []
+
+ if MOONRAKER_DEPS_JSON_FILE.exists():
+ with open(MOONRAKER_DEPS_JSON_FILE, "r") as deps:
+ moonraker_deps = json.load(deps).get("debian", [])
+ elif MOONRAKER_INSTALL_SCRIPT.exists():
+ moonraker_deps = parse_packages_from_file(MOONRAKER_INSTALL_SCRIPT)
+
+ if not moonraker_deps:
+ raise ValueError("Error reading Moonraker dependencies!")
+
+ check_install_dependencies({*moonraker_deps})
+
+
+def install_moonraker_polkit() -> None:
+ 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 update_moonraker() -> None:
+ if not get_confirm("Update Moonraker now?"):
+ return
+
+ settings = KiauhSettings()
+ if settings.kiauh.backup_before_update:
+ backup_moonraker_dir()
+
+ instances = get_instances(Moonraker)
+ InstanceManager.stop_all(instances)
+
+ git_pull_wrapper(repo=settings.moonraker.repo_url, target_dir=MOONRAKER_DIR)
+
+ # install possible new system packages
+ install_moonraker_packages()
+ # install possible new python dependencies
+ install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
+
+ InstanceManager.start_all(instances)
diff --git a/kiauh/components/moonraker/moonraker_utils.py b/kiauh/components/moonraker/moonraker_utils.py
new file mode 100644
index 0000000..42acc81
--- /dev/null
+++ b/kiauh/components/moonraker/moonraker_utils.py
@@ -0,0 +1,145 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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, List, Optional
+
+from components.moonraker import (
+ MODULE_PATH,
+ MOONRAKER_BACKUP_DIR,
+ MOONRAKER_DB_BACKUP_DIR,
+ MOONRAKER_DEFAULT_PORT,
+ MOONRAKER_DIR,
+ MOONRAKER_ENV_DIR,
+)
+from components.moonraker.moonraker import Moonraker
+from components.webui_client.base_data import BaseWebClient
+from core.backup_manager.backup_manager import BackupManager
+from core.logger import Logger
+from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+ SimpleConfigParser,
+)
+from core.types import ComponentStatus
+from utils.common import get_install_status
+from utils.instance_utils import get_instances
+from utils.sys_utils import (
+ get_ipv4_addr,
+)
+
+
+def get_moonraker_status() -> ComponentStatus:
+ return get_install_status(MOONRAKER_DIR, MOONRAKER_ENV_DIR, Moonraker)
+
+
+def create_example_moonraker_conf(
+ instance: Moonraker,
+ ports_map: Dict[str, int],
+ clients: Optional[List[BaseWebClient]] = None,
+) -> None:
+ Logger.print_status(f"Creating example moonraker.conf in '{instance.base.cfg_dir}'")
+ if instance.cfg_file.is_file():
+ Logger.print_info(f"'{instance.cfg_file}' already exists.")
+ return
+
+ 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 MOONRAKER_DEFAULT_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.base.comms_dir.joinpath("klippy.sock")
+
+ scp = SimpleConfigParser()
+ scp.read(target)
+ trusted_clients: List[str] = [
+ ".".join(ip),
+ *scp.get("authorization", "trusted_clients"),
+ ]
+
+ scp.set("server", "port", str(port))
+ scp.set("server", "klippy_uds_address", str(uds))
+ scp.set(
+ "authorization",
+ "trusted_clients",
+ "\n".join(trusted_clients),
+ True,
+ )
+
+ # add existing client and client configs in the update section
+ if clients is not None and len(clients) > 0:
+ for c in clients:
+ # client part
+ c_section = f"update_manager {c.name}"
+ c_options = [
+ ("type", "web"),
+ ("channel", "stable"),
+ ("repo", c.repo_path),
+ ("path", c.client_dir),
+ ]
+ scp.add_section(section=c_section)
+ for option in c_options:
+ scp.set(c_section, option[0], option[1])
+
+ # client config part
+ c_config = c.client_config
+ if c_config.config_dir.exists():
+ c_config_section = f"update_manager {c_config.name}"
+ c_config_options = [
+ ("type", "git_repo"),
+ ("primary_branch", "master"),
+ ("path", c_config.config_dir),
+ ("origin", c_config.repo_url),
+ ("managed_services", "klipper"),
+ ]
+ scp.add_section(section=c_config_section)
+ for option in c_config_options:
+ scp.set(c_config_section, option[0], option[1])
+
+ scp.write(target)
+ Logger.print_ok(f"Example moonraker.conf created in '{instance.base.cfg_dir}'")
+
+
+def backup_moonraker_dir() -> None:
+ bm = BackupManager()
+ bm.backup_directory("moonraker", source=MOONRAKER_DIR, target=MOONRAKER_BACKUP_DIR)
+ bm.backup_directory(
+ "moonraker-env", source=MOONRAKER_ENV_DIR, target=MOONRAKER_BACKUP_DIR
+ )
+
+
+def backup_moonraker_db_dir() -> None:
+ instances: List[Moonraker] = get_instances(Moonraker)
+ bm = BackupManager()
+
+ for instance in instances:
+ name = f"database-{instance.data_dir.name}"
+ bm.backup_directory(
+ name, source=instance.db_dir, target=MOONRAKER_DB_BACKUP_DIR
+ )
diff --git a/kiauh/components/octoeverywhere/__init__.py b/kiauh/components/octoeverywhere/__init__.py
new file mode 100644
index 0000000..84c0e63
--- /dev/null
+++ b/kiauh/components/octoeverywhere/__init__.py
@@ -0,0 +1,29 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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
+
+# repo
+OE_REPO = "https://github.com/QuinnDamerell/OctoPrint-OctoEverywhere.git"
+
+# directories
+OE_DIR = Path.home().joinpath("octoeverywhere")
+OE_ENV_DIR = Path.home().joinpath("octoeverywhere-env")
+OE_STORE_DIR = OE_DIR.joinpath("octoeverywhere-store")
+
+# files
+OE_REQ_FILE = OE_DIR.joinpath("requirements.txt")
+OE_DEPS_JSON_FILE = OE_DIR.joinpath("moonraker-system-dependencies.json")
+OE_INSTALL_SCRIPT = OE_DIR.joinpath("install.sh")
+OE_UPDATE_SCRIPT = OE_DIR.joinpath("update.sh")
+OE_INSTALLER_LOG_FILE = Path.home().joinpath("octoeverywhere-installer.log")
+
+# filenames
+OE_CFG_NAME = "octoeverywhere.conf"
+OE_LOG_NAME = "octoeverywhere.log"
+OE_SYS_CFG_NAME = "octoeverywhere-system.cfg"
diff --git a/kiauh/components/octoeverywhere/octoeverywhere.py b/kiauh/components/octoeverywhere/octoeverywhere.py
new file mode 100644
index 0000000..7a1f58a
--- /dev/null
+++ b/kiauh/components/octoeverywhere/octoeverywhere.py
@@ -0,0 +1,75 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from pathlib import Path
+from subprocess import CalledProcessError, run
+
+from components.moonraker import MOONRAKER_CFG_NAME
+from components.moonraker.moonraker import Moonraker
+from components.octoeverywhere import (
+ OE_CFG_NAME,
+ OE_DIR,
+ OE_ENV_DIR,
+ OE_INSTALL_SCRIPT,
+ OE_LOG_NAME,
+ OE_SYS_CFG_NAME,
+ OE_UPDATE_SCRIPT,
+)
+from core.instance_manager.base_instance import BaseInstance
+from core.logger import Logger
+from utils.sys_utils import get_service_file_path
+
+
+@dataclass
+class Octoeverywhere:
+ suffix: str
+ base: BaseInstance = field(init=False, repr=False)
+ service_file_path: Path = field(init=False)
+ log_file_name = OE_LOG_NAME
+ dir: Path = OE_DIR
+ env_dir: Path = OE_ENV_DIR
+ data_dir: Path = field(init=False)
+ store_dir: Path = field(init=False)
+ cfg_file: Path = field(init=False)
+ sys_cfg_file: Path = field(init=False)
+
+ def __post_init__(self):
+ self.base: BaseInstance = BaseInstance(Moonraker, self.suffix)
+ self.base.log_file_name = self.log_file_name
+
+ self.service_file_path: Path = get_service_file_path(
+ Octoeverywhere, self.suffix
+ )
+ self.store_dir = self.base.data_dir.joinpath("store")
+ self.cfg_file = self.base.cfg_dir.joinpath(OE_CFG_NAME)
+ self.sys_cfg_file = self.base.cfg_dir.joinpath(OE_SYS_CFG_NAME)
+ self.data_dir = self.base.data_dir
+ self.sys_cfg_file = self.base.cfg_dir.joinpath(OE_SYS_CFG_NAME)
+
+ def create(self) -> None:
+ Logger.print_status("Creating OctoEverywhere for Klipper Instance ...")
+
+ try:
+ cmd = f"{OE_INSTALL_SCRIPT} {self.base.cfg_dir}/{MOONRAKER_CFG_NAME}"
+ run(cmd, check=True, shell=True)
+
+ except CalledProcessError as e:
+ Logger.print_error(f"Error creating instance: {e}")
+ raise
+
+ @staticmethod
+ def update() -> None:
+ try:
+ run(OE_UPDATE_SCRIPT.as_posix(), check=True, shell=True, cwd=OE_DIR)
+
+ except CalledProcessError as e:
+ Logger.print_error(f"Error updating OctoEverywhere for Klipper: {e}")
+ raise
diff --git a/kiauh/components/octoeverywhere/octoeverywhere_setup.py b/kiauh/components/octoeverywhere/octoeverywhere_setup.py
new file mode 100644
index 0000000..9940de4
--- /dev/null
+++ b/kiauh/components/octoeverywhere/octoeverywhere_setup.py
@@ -0,0 +1,197 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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
+from typing import List
+
+from components.moonraker.moonraker import Moonraker
+from components.octoeverywhere import (
+ OE_DEPS_JSON_FILE,
+ OE_DIR,
+ OE_ENV_DIR,
+ OE_INSTALL_SCRIPT,
+ OE_INSTALLER_LOG_FILE,
+ OE_REPO,
+ OE_REQ_FILE,
+ OE_SYS_CFG_NAME,
+)
+from components.octoeverywhere.octoeverywhere import Octoeverywhere
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
+from core.types import ComponentStatus
+from utils.common import (
+ check_install_dependencies,
+ get_install_status,
+ moonraker_exists,
+)
+from utils.config_utils import (
+ remove_config_section,
+)
+from utils.fs_utils import run_remove_routines
+from utils.git_utils import git_clone_wrapper
+from utils.input_utils import get_confirm
+from utils.instance_utils import get_instances
+from utils.sys_utils import (
+ install_python_requirements,
+ parse_packages_from_file,
+)
+
+
+def get_octoeverywhere_status() -> ComponentStatus:
+ return get_install_status(OE_DIR, OE_ENV_DIR, Octoeverywhere)
+
+
+def install_octoeverywhere() -> None:
+ Logger.print_status("Installing OctoEverywhere for Klipper ...")
+
+ # check if moonraker is installed. if not, notify the user and exit
+ if not moonraker_exists():
+ return
+
+ force_clone = False
+ oe_instances: List[Octoeverywhere] = get_instances(Octoeverywhere)
+ if oe_instances:
+ Logger.print_dialog(
+ DialogType.INFO,
+ [
+ "OctoEverywhere is already installed!",
+ "It is safe to run the installer again to link your "
+ "printer or repair any issues.",
+ ],
+ )
+ if not get_confirm("Re-run OctoEverywhere installation?"):
+ Logger.print_info("Exiting OctoEverywhere for Klipper installation ...")
+ return
+ else:
+ Logger.print_status("Re-Installing OctoEverywhere for Klipper ...")
+ force_clone = True
+
+ mr_instances: List[Moonraker] = get_instances(Moonraker)
+
+ mr_names = [f"● {moonraker.data_dir.name}" for moonraker in mr_instances]
+ if len(mr_names) > 1:
+ Logger.print_dialog(
+ DialogType.INFO,
+ [
+ "The following Moonraker instances were found:",
+ *mr_names,
+ "\n\n",
+ "The setup will apply the same names to OctoEverywhere!",
+ ],
+ )
+
+ if not get_confirm(
+ "Continue OctoEverywhere for Klipper installation?",
+ default_choice=True,
+ allow_go_back=True,
+ ):
+ Logger.print_info("Exiting OctoEverywhere for Klipper installation ...")
+ return
+
+ try:
+ git_clone_wrapper(OE_REPO, OE_DIR, force=force_clone)
+
+ for moonraker in mr_instances:
+ instance = Octoeverywhere(suffix=moonraker.suffix)
+ instance.create()
+
+ InstanceManager.restart_all(mr_instances)
+
+ Logger.print_dialog(
+ DialogType.SUCCESS,
+ ["OctoEverywhere for Klipper successfully installed!"],
+ center_content=True,
+ )
+
+ except Exception as e:
+ Logger.print_error(
+ f"Error during OctoEverywhere for Klipper installation:\n{e}"
+ )
+
+
+def update_octoeverywhere() -> None:
+ Logger.print_status("Updating OctoEverywhere for Klipper ...")
+ try:
+ Octoeverywhere.update()
+ Logger.print_dialog(
+ DialogType.SUCCESS,
+ ["OctoEverywhere for Klipper successfully updated!"],
+ center_content=True,
+ )
+
+ except Exception as e:
+ Logger.print_error(f"Error during OctoEverywhere for Klipper update:\n{e}")
+
+
+def remove_octoeverywhere() -> None:
+ Logger.print_status("Removing OctoEverywhere for Klipper ...")
+
+ mr_instances: List[Moonraker] = get_instances(Moonraker)
+ ob_instances: List[Octoeverywhere] = get_instances(Octoeverywhere)
+
+ try:
+ remove_oe_instances(ob_instances)
+ remove_oe_dir()
+ remove_oe_env()
+ remove_config_section(f"include {OE_SYS_CFG_NAME}", mr_instances)
+ run_remove_routines(OE_INSTALLER_LOG_FILE)
+ Logger.print_dialog(
+ DialogType.SUCCESS,
+ ["OctoEverywhere for Klipper successfully removed!"],
+ center_content=True,
+ )
+
+ except Exception as e:
+ Logger.print_error(f"Error during OctoEverywhere for Klipper removal:\n{e}")
+
+
+def install_oe_dependencies() -> None:
+ oe_deps = []
+ if OE_DEPS_JSON_FILE.exists():
+ with open(OE_DEPS_JSON_FILE, "r") as deps:
+ oe_deps = json.load(deps).get("debian", [])
+ elif OE_INSTALL_SCRIPT.exists():
+ oe_deps = parse_packages_from_file(OE_INSTALL_SCRIPT)
+
+ if not oe_deps:
+ raise ValueError("Error reading OctoEverywhere dependencies!")
+
+ check_install_dependencies({*oe_deps})
+ install_python_requirements(OE_ENV_DIR, OE_REQ_FILE)
+
+
+def remove_oe_instances(
+ instance_list: List[Octoeverywhere],
+) -> None:
+ if not instance_list:
+ Logger.print_info("No OctoEverywhere instances found. Skipped ...")
+ return
+
+ for instance in instance_list:
+ Logger.print_status(f"Removing instance {instance.service_file_path.stem} ...")
+ InstanceManager.remove(instance)
+
+
+def remove_oe_dir() -> None:
+ Logger.print_status("Removing OctoEverywhere for Klipper directory ...")
+
+ if not OE_DIR.exists():
+ Logger.print_info(f"'{OE_DIR}' does not exist. Skipped ...")
+ return
+
+ run_remove_routines(OE_DIR)
+
+
+def remove_oe_env() -> None:
+ Logger.print_status("Removing OctoEverywhere for Klipper environment ...")
+
+ if not OE_ENV_DIR.exists():
+ Logger.print_info(f"'{OE_ENV_DIR}' does not exist. Skipped ...")
+ return
+
+ run_remove_routines(OE_ENV_DIR)
diff --git a/kiauh/components/webui_client/__init__.py b/kiauh/components/webui_client/__init__.py
new file mode 100644
index 0000000..371c365
--- /dev/null
+++ b/kiauh/components/webui_client/__init__.py
@@ -0,0 +1,12 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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
diff --git a/kiauh/components/webui_client/assets/common_vars.conf b/kiauh/components/webui_client/assets/common_vars.conf
new file mode 100644
index 0000000..9c3f85e
--- /dev/null
+++ b/kiauh/components/webui_client/assets/common_vars.conf
@@ -0,0 +1,6 @@
+# /etc/nginx/conf.d/common_vars.conf
+
+map $http_upgrade $connection_upgrade {
+ default upgrade;
+ '' close;
+}
\ No newline at end of file
diff --git a/kiauh/components/webui_client/assets/nginx_cfg b/kiauh/components/webui_client/assets/nginx_cfg
new file mode 100644
index 0000000..d7aabf4
--- /dev/null
+++ b/kiauh/components/webui_client/assets/nginx_cfg
@@ -0,0 +1,95 @@
+server {
+ listen %PORT%;
+ # uncomment the next line to activate IPv6
+ # 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;
+ }
+
+ 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/;
+ }
+}
diff --git a/kiauh/components/webui_client/assets/upstreams.conf b/kiauh/components/webui_client/assets/upstreams.conf
new file mode 100644
index 0000000..d04e04a
--- /dev/null
+++ b/kiauh/components/webui_client/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;
+}
\ No newline at end of file
diff --git a/kiauh/components/webui_client/base_data.py b/kiauh/components/webui_client/base_data.py
new file mode 100644
index 0000000..f46798b
--- /dev/null
+++ b/kiauh/components/webui_client/base_data.py
@@ -0,0 +1,56 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+
+from __future__ import annotations
+
+from abc import ABC
+from dataclasses import dataclass
+from enum import Enum
+from pathlib import Path
+
+
+class WebClientType(Enum):
+ MAINSAIL: str = "mainsail"
+ FLUIDD: str = "fluidd"
+
+
+class WebClientConfigType(Enum):
+ MAINSAIL: str = "mainsail-config"
+ FLUIDD: str = "fluidd-config"
+
+
+@dataclass()
+class BaseWebClient(ABC):
+ """Base class for webclient data"""
+
+ client: WebClientType
+ name: str
+ display_name: str
+ client_dir: Path
+ config_file: Path
+ backup_dir: Path
+ repo_path: str
+ download_url: str
+ nginx_access_log: Path
+ nginx_error_log: Path
+ client_config: BaseWebClientConfig
+
+
+@dataclass()
+class BaseWebClientConfig(ABC):
+ """Base class for webclient config data"""
+
+ client_config: WebClientConfigType
+ name: str
+ display_name: str
+ config_filename: str
+ config_dir: Path
+ backup_dir: Path
+ repo_url: str
+ config_section: str
diff --git a/kiauh/components/webui_client/client_config/__init__.py b/kiauh/components/webui_client/client_config/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/kiauh/components/webui_client/client_config/client_config_remove.py b/kiauh/components/webui_client/client_config/client_config_remove.py
new file mode 100644
index 0000000..f0f5170
--- /dev/null
+++ b/kiauh/components/webui_client/client_config/client_config_remove.py
@@ -0,0 +1,43 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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 components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from components.webui_client.base_data import BaseWebClientConfig
+from core.logger import Logger
+from utils.config_utils import remove_config_section
+from utils.fs_utils import run_remove_routines
+from utils.instance_utils import get_instances
+
+
+def run_client_config_removal(
+ client_config: BaseWebClientConfig,
+ kl_instances: List[Klipper],
+ mr_instances: List[Moonraker],
+) -> None:
+ remove_client_config_dir(client_config)
+ remove_client_config_symlink(client_config)
+ remove_config_section(f"update_manager {client_config.name}", mr_instances)
+ remove_config_section(client_config.config_section, kl_instances)
+
+
+def remove_client_config_dir(client_config: BaseWebClientConfig) -> None:
+ Logger.print_status(f"Removing {client_config.display_name} ...")
+ run_remove_routines(client_config.config_dir)
+
+
+def remove_client_config_symlink(client_config: BaseWebClientConfig) -> None:
+ instances: List[Klipper] = get_instances(Klipper)
+ for instance in instances:
+ run_remove_routines(
+ instance.base.cfg_dir.joinpath(client_config.config_filename)
+ )
diff --git a/kiauh/components/webui_client/client_config/client_config_setup.py b/kiauh/components/webui_client/client_config/client_config_setup.py
new file mode 100644
index 0000000..1e9a54c
--- /dev/null
+++ b/kiauh/components/webui_client/client_config/client_config_setup.py
@@ -0,0 +1,125 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import shutil
+import subprocess
+from pathlib import Path
+from typing import List
+
+from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from components.webui_client.base_data import BaseWebClient, BaseWebClientConfig
+from components.webui_client.client_dialogs import (
+ print_client_already_installed_dialog,
+)
+from components.webui_client.client_utils import (
+ backup_client_config_data,
+ detect_client_cfg_conflict,
+)
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
+from core.settings.kiauh_settings import KiauhSettings
+from utils.common import backup_printer_config_dir
+from utils.config_utils import add_config_section, add_config_section_at_top
+from utils.fs_utils import create_symlink
+from utils.git_utils import git_clone_wrapper, git_pull_wrapper
+from utils.input_utils import get_confirm
+from utils.instance_utils import get_instances
+
+
+def install_client_config(client_data: BaseWebClient) -> None:
+ client_config: BaseWebClientConfig = client_data.client_config
+ display_name = client_config.display_name
+
+ if detect_client_cfg_conflict(client_data):
+ Logger.print_info("Another Client-Config is already installed! Skipped ...")
+ return
+
+ if client_config.config_dir.exists():
+ print_client_already_installed_dialog(display_name)
+ if get_confirm(f"Re-install {display_name}?", allow_go_back=True):
+ shutil.rmtree(client_config.config_dir)
+ else:
+ return
+
+ mr_instances: List[Moonraker] = get_instances(Moonraker)
+ kl_instances = get_instances(Klipper)
+
+ try:
+ download_client_config(client_config)
+ create_client_config_symlink(client_config, kl_instances)
+
+ backup_printer_config_dir()
+
+ add_config_section(
+ section=f"update_manager {client_config.name}",
+ instances=mr_instances,
+ options=[
+ ("type", "git_repo"),
+ ("primary_branch", "master"),
+ ("path", str(client_config.config_dir)),
+ ("origin", str(client_config.repo_url)),
+ ("managed_services", "klipper"),
+ ],
+ )
+ add_config_section_at_top(client_config.config_section, kl_instances)
+ InstanceManager.restart_all(kl_instances)
+
+ except Exception as e:
+ Logger.print_error(f"{display_name} installation failed!\n{e}")
+ return
+
+ Logger.print_ok(f"{display_name} installation complete!", start="\n")
+
+
+def download_client_config(client_config: BaseWebClientConfig) -> None:
+ try:
+ Logger.print_status(f"Downloading {client_config.display_name} ...")
+ repo = client_config.repo_url
+ target_dir = client_config.config_dir
+ git_clone_wrapper(repo, target_dir)
+ except Exception:
+ Logger.print_error(f"Downloading {client_config.display_name} failed!")
+ raise
+
+
+def update_client_config(client: BaseWebClient) -> None:
+ client_config: BaseWebClientConfig = client.client_config
+
+ Logger.print_status(f"Updating {client_config.display_name} ...")
+
+ if not client_config.config_dir.exists():
+ Logger.print_info(
+ f"Unable to update {client_config.display_name}. Directory does not exist! Skipping ..."
+ )
+ return
+
+ settings = KiauhSettings()
+ if settings.kiauh.backup_before_update:
+ backup_client_config_data(client)
+
+ git_pull_wrapper(client_config.repo_url, client_config.config_dir)
+
+ Logger.print_ok(f"Successfully updated {client_config.display_name}.")
+ Logger.print_info("Restart Klipper to reload the configuration!")
+
+
+def create_client_config_symlink(
+ client_config: BaseWebClientConfig, klipper_instances: List[Klipper]
+) -> None:
+ for instance in klipper_instances:
+ Logger.print_status(f"Create symlink for {client_config.config_filename} ...")
+ source = Path(client_config.config_dir, client_config.config_filename)
+ target = instance.base.cfg_dir
+ Logger.print_status(f"Linking {source} to {target}")
+ try:
+ create_symlink(source, target)
+ except subprocess.CalledProcessError:
+ Logger.print_error("Creating symlink failed!")
diff --git a/kiauh/components/webui_client/client_dialogs.py b/kiauh/components/webui_client/client_dialogs.py
new file mode 100644
index 0000000..a615fb4
--- /dev/null
+++ b/kiauh/components/webui_client/client_dialogs.py
@@ -0,0 +1,88 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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 components.webui_client.base_data import BaseWebClient
+from core.logger import DialogType, Logger
+
+
+def print_moonraker_not_found_dialog() -> None:
+ Logger.print_dialog(
+ DialogType.WARNING,
+ [
+ "No local Moonraker installation was found!",
+ "\n\n",
+ "It is possible to install Mainsail without a local Moonraker installation. "
+ "If you continue, you need to make sure, that Moonraker is installed on "
+ "another machine in your network. Otherwise Mainsail will NOT work "
+ "correctly.",
+ ],
+ )
+
+
+def print_client_already_installed_dialog(name: str) -> None:
+ Logger.print_dialog(
+ DialogType.WARNING,
+ [
+ f"{name} seems to be already installed!",
+ f"If you continue, your current {name} installation will be overwritten.",
+ ],
+ )
+
+
+def print_client_port_select_dialog(
+ name: str, port: int, ports_in_use: List[int]
+) -> None:
+ Logger.print_dialog(
+ DialogType.CUSTOM,
+ [
+ f"Please select the port, {name} should be served on. If your are unsure "
+ f"what to select, hit Enter to apply the suggested value of: {port}",
+ "\n\n",
+ f"In case you need {name} to be served on a specific port, you can set it "
+ f"now. Make sure that the port is not already used by another application "
+ f"on your system!",
+ "\n\n",
+ "The following ports were found to be in use already:",
+ *[f"● {port}" for port in ports_in_use],
+ ],
+ )
+
+
+def print_install_client_config_dialog(client: BaseWebClient) -> None:
+ name = client.display_name
+ url = client.client_config.repo_url.replace(".git", "")
+ Logger.print_dialog(
+ DialogType.INFO,
+ [
+ f"It is recommended to use special macros in order to have {name} fully "
+ f"functional and working.",
+ "\n\n",
+ f"The recommended macros for {name} can be seen here:",
+ url,
+ "\n\n",
+ "If you already use these macros skip this step. Otherwise you should "
+ "consider to answer with 'Y' to download the recommended macros.",
+ ],
+ )
+
+
+def print_ipv6_warning_dialog() -> None:
+ Logger.print_dialog(
+ DialogType.WARNING,
+ [
+ "It looks like IPv6 is enabled on this system!",
+ "This may cause issues with the installation of NGINX in the following "
+ "steps! It is recommended to disable IPv6 on your system to avoid this issue.",
+ "\n\n",
+ "If you think this warning is a false alarm, and you are sure that "
+ "IPv6 is disabled, you can continue with the installation.",
+ ],
+ )
diff --git a/kiauh/components/webui_client/client_remove.py b/kiauh/components/webui_client/client_remove.py
new file mode 100644
index 0000000..92e844d
--- /dev/null
+++ b/kiauh/components/webui_client/client_remove.py
@@ -0,0 +1,85 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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 components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from components.webui_client.base_data import (
+ BaseWebClient,
+)
+from components.webui_client.client_config.client_config_remove import (
+ run_client_config_removal,
+)
+from core.backup_manager.backup_manager import BackupManager
+from core.constants import NGINX_SITES_AVAILABLE, NGINX_SITES_ENABLED
+from core.logger import Logger
+from utils.config_utils import remove_config_section
+from utils.fs_utils import (
+ remove_with_sudo,
+ run_remove_routines,
+)
+from utils.instance_utils import get_instances
+
+
+def run_client_removal(
+ client: BaseWebClient,
+ remove_client: bool,
+ remove_client_cfg: bool,
+ backup_config: bool,
+) -> None:
+ mr_instances: List[Moonraker] = get_instances(Moonraker)
+ kl_instances: List[Klipper] = get_instances(Klipper)
+
+ if backup_config:
+ bm = BackupManager()
+ bm.backup_file(client.config_file)
+
+ if remove_client:
+ client_name = client.name
+ remove_client_dir(client)
+ remove_client_nginx_config(client_name)
+ remove_client_nginx_logs(client, kl_instances)
+
+ section = f"update_manager {client_name}"
+ remove_config_section(section, mr_instances)
+
+ if remove_client_cfg:
+ run_client_config_removal(
+ client.client_config,
+ kl_instances,
+ mr_instances,
+ )
+
+
+def remove_client_dir(client: BaseWebClient) -> None:
+ Logger.print_status(f"Removing {client.display_name} ...")
+ run_remove_routines(client.client_dir)
+
+
+def remove_client_nginx_config(name: str) -> None:
+ Logger.print_status(f"Removing NGINX config for {name.capitalize()} ...")
+
+ remove_with_sudo(NGINX_SITES_AVAILABLE.joinpath(name))
+ remove_with_sudo(NGINX_SITES_ENABLED.joinpath(name))
+
+
+def remove_client_nginx_logs(client: BaseWebClient, instances: List[Klipper]) -> None:
+ Logger.print_status(f"Removing NGINX logs for {client.display_name} ...")
+
+ remove_with_sudo(client.nginx_access_log)
+ remove_with_sudo(client.nginx_error_log)
+
+ if not instances:
+ return
+
+ for instance in instances:
+ run_remove_routines(
+ instance.base.log_dir.joinpath(client.nginx_access_log.name)
+ )
+ run_remove_routines(instance.base.log_dir.joinpath(client.nginx_error_log.name))
diff --git a/kiauh/components/webui_client/client_setup.py b/kiauh/components/webui_client/client_setup.py
new file mode 100644
index 0000000..5827c4f
--- /dev/null
+++ b/kiauh/components/webui_client/client_setup.py
@@ -0,0 +1,190 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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 tempfile
+from pathlib import Path
+from typing import List
+
+from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from components.webui_client import MODULE_PATH
+from components.webui_client.base_data import (
+ BaseWebClient,
+ BaseWebClientConfig,
+ WebClientType,
+)
+from components.webui_client.client_config.client_config_setup import (
+ install_client_config,
+)
+from components.webui_client.client_dialogs import (
+ print_client_port_select_dialog,
+ print_install_client_config_dialog,
+ print_moonraker_not_found_dialog,
+)
+from components.webui_client.client_utils import (
+ copy_common_vars_nginx_cfg,
+ copy_upstream_nginx_cfg,
+ create_nginx_cfg,
+ detect_client_cfg_conflict,
+ enable_mainsail_remotemode,
+ get_next_free_port,
+ is_valid_port,
+ read_ports_from_nginx_configs,
+ symlink_webui_nginx_log,
+)
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
+from core.settings.kiauh_settings import KiauhSettings
+from utils.common import check_install_dependencies
+from utils.config_utils import add_config_section
+from utils.fs_utils import unzip
+from utils.input_utils import get_confirm, get_number_input
+from utils.instance_utils import get_instances
+from utils.sys_utils import (
+ cmd_sysctl_service,
+ download_file,
+ get_ipv4_addr,
+)
+
+
+def install_client(client: BaseWebClient) -> None:
+ if client is None:
+ raise ValueError("Missing parameter client_data!")
+
+ if client.client_dir.exists():
+ Logger.print_info(
+ f"{client.display_name} seems to be already installed! Skipped ..."
+ )
+ return
+
+ mr_instances: List[Moonraker] = get_instances(Moonraker)
+
+ enable_remotemode = False
+ if not mr_instances:
+ print_moonraker_not_found_dialog()
+ if not get_confirm(f"Continue {client.display_name} installation?"):
+ return
+
+ # if moonraker is not installed or multiple instances
+ # are installed we enable mainsails remote mode
+ if (
+ client.client == WebClientType.MAINSAIL
+ and not mr_instances
+ or len(mr_instances) > 1
+ ):
+ enable_remotemode = True
+
+ kl_instances = get_instances(Klipper)
+ install_client_cfg = False
+ client_config: BaseWebClientConfig = client.client_config
+ if (
+ kl_instances
+ and not client_config.config_dir.exists()
+ and not detect_client_cfg_conflict(client)
+ ):
+ print_install_client_config_dialog(client)
+ question = f"Download the recommended {client_config.display_name}?"
+ install_client_cfg = get_confirm(question, allow_go_back=False)
+
+ settings = KiauhSettings()
+ port: int = settings.get(client.name, "port")
+ ports_in_use: List[int] = read_ports_from_nginx_configs()
+
+ # check if configured port is a valid number and not in use already
+ valid_port = is_valid_port(port, ports_in_use)
+ while not valid_port:
+ next_port = get_next_free_port(ports_in_use)
+ print_client_port_select_dialog(client.display_name, next_port, ports_in_use)
+ port = get_number_input(
+ f"Configure {client.display_name} for port",
+ min_count=int(next_port),
+ default=next_port,
+ )
+ valid_port = is_valid_port(port, ports_in_use)
+
+ check_install_dependencies({"nginx"})
+
+ try:
+ download_client(client)
+ if enable_remotemode and client.client == WebClientType.MAINSAIL:
+ enable_mainsail_remotemode()
+ if mr_instances:
+ add_config_section(
+ section=f"update_manager {client.name}",
+ instances=mr_instances,
+ options=[
+ ("type", "web"),
+ ("channel", "stable"),
+ ("repo", str(client.repo_path)),
+ ("path", str(client.client_dir)),
+ ],
+ )
+ InstanceManager.restart_all(mr_instances)
+ if install_client_cfg and kl_instances:
+ install_client_config(client)
+
+ copy_upstream_nginx_cfg()
+ copy_common_vars_nginx_cfg()
+ create_nginx_cfg(
+ display_name=client.display_name,
+ cfg_name=client.name,
+ template_src=MODULE_PATH.joinpath("assets/nginx_cfg"),
+ PORT=port,
+ ROOT_DIR=client.client_dir,
+ NAME=client.name,
+ )
+
+ if kl_instances:
+ symlink_webui_nginx_log(client, kl_instances)
+ cmd_sysctl_service("nginx", "restart")
+
+ except Exception as e:
+ Logger.print_error(f"{client.display_name} installation failed!\n{e}")
+ return
+
+ log = f"Open {client.display_name} now on: http://{get_ipv4_addr()}:{port}"
+ Logger.print_ok(f"{client.display_name} installation complete!", start="\n")
+ Logger.print_ok(log, prefix=False, end="\n\n")
+
+
+def download_client(client: BaseWebClient) -> None:
+ zipfile = f"{client.name.lower()}.zip"
+ target = Path().home().joinpath(zipfile)
+ try:
+ Logger.print_status(
+ f"Downloading {client.display_name} from {client.download_url} ..."
+ )
+ download_file(client.download_url, target, True)
+ Logger.print_ok("Download complete!")
+
+ Logger.print_status(f"Extracting {zipfile} ...")
+ unzip(target, client.client_dir)
+ target.unlink(missing_ok=True)
+ Logger.print_ok("OK!")
+
+ except Exception:
+ Logger.print_error(f"Downloading {client.display_name} failed!")
+ raise
+
+
+def update_client(client: BaseWebClient) -> None:
+ Logger.print_status(f"Updating {client.display_name} ...")
+ if not client.client_dir.exists():
+ Logger.print_info(
+ f"Unable to update {client.display_name}. Directory does not exist! Skipping ..."
+ )
+ return
+
+ with tempfile.NamedTemporaryFile(suffix=".json") as tmp_file:
+ Logger.print_status(
+ f"Creating temporary backup of {client.config_file} as {tmp_file.name} ..."
+ )
+ shutil.copy(client.config_file, tmp_file.name)
+ download_client(client)
+ shutil.copy(tmp_file.name, client.config_file)
diff --git a/kiauh/components/webui_client/client_utils.py b/kiauh/components/webui_client/client_utils.py
new file mode 100644
index 0000000..db7f057
--- /dev/null
+++ b/kiauh/components/webui_client/client_utils.py
@@ -0,0 +1,343 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import json
+import re
+import shutil
+from pathlib import Path
+from subprocess import PIPE, CalledProcessError, run
+from typing import List, get_args
+
+from components.klipper.klipper import Klipper
+from components.webui_client import MODULE_PATH
+from components.webui_client.base_data import (
+ BaseWebClient,
+ WebClientType,
+)
+from components.webui_client.fluidd_data import FluiddData
+from components.webui_client.mainsail_data import MainsailData
+from core.backup_manager.backup_manager import BackupManager
+from core.constants import (
+ COLOR_CYAN,
+ COLOR_YELLOW,
+ NGINX_CONFD,
+ NGINX_SITES_AVAILABLE,
+ NGINX_SITES_ENABLED,
+ RESET_FORMAT,
+)
+from core.logger import Logger
+from core.settings.kiauh_settings import KiauhSettings
+from core.types import ComponentStatus
+from utils.common import get_install_status
+from utils.fs_utils import create_symlink, remove_file
+from utils.git_utils import (
+ get_latest_remote_tag,
+ get_latest_unstable_tag,
+)
+
+
+def get_client_status(
+ client: BaseWebClient, fetch_remote: bool = False
+) -> ComponentStatus:
+ files = [
+ NGINX_SITES_AVAILABLE.joinpath(client.name),
+ NGINX_CONFD.joinpath("upstreams.conf"),
+ NGINX_CONFD.joinpath("common_vars.conf"),
+ ]
+ comp_status: ComponentStatus = get_install_status(client.client_dir, files=files)
+
+ # if the client dir does not exist, set the status to not
+ # installed even if the other files are present
+ if not client.client_dir.exists():
+ comp_status.status = 0
+
+ comp_status.local = get_local_client_version(client)
+ comp_status.remote = get_remote_client_version(client) if fetch_remote else None
+ return comp_status
+
+
+def get_client_config_status(client: BaseWebClient) -> ComponentStatus:
+ return get_install_status(client.client_config.config_dir)
+
+
+def get_current_client_config(clients: List[BaseWebClient]) -> str:
+ installed = []
+ for client in clients:
+ client_config = client.client_config
+ if client_config.config_dir.exists():
+ installed.append(client)
+
+ if len(installed) > 1:
+ return f"{COLOR_YELLOW}Conflict!{RESET_FORMAT}"
+ elif len(installed) == 1:
+ cfg = installed[0].client_config
+ return f"{COLOR_CYAN}{cfg.display_name}{RESET_FORMAT}"
+
+ return f"{COLOR_CYAN}-{RESET_FORMAT}"
+
+
+def enable_mainsail_remotemode() -> None:
+ Logger.print_status("Enable Mainsails remote mode ...")
+ c_json = MainsailData().client_dir.joinpath("config.json")
+ with open(c_json, "r") as f:
+ config_data = json.load(f)
+
+ if config_data["instancesDB"] == "browser":
+ Logger.print_info("Remote mode already configured. Skipped ...")
+ return
+
+ Logger.print_status("Setting instance storage location to 'browser' ...")
+ config_data["instancesDB"] = "browser"
+
+ with open(c_json, "w") as f:
+ json.dump(config_data, f, indent=4)
+ Logger.print_ok("Mainsails remote mode enabled!")
+
+
+def symlink_webui_nginx_log(
+ client: BaseWebClient, klipper_instances: List[Klipper]
+) -> None:
+ Logger.print_status("Link NGINX logs into log directory ...")
+ access_log = client.nginx_access_log
+ error_log = client.nginx_error_log
+
+ for instance in klipper_instances:
+ desti_access = instance.base.log_dir.joinpath(access_log.name)
+ if not desti_access.exists():
+ desti_access.symlink_to(access_log)
+
+ desti_error = instance.base.log_dir.joinpath(error_log.name)
+ if not desti_error.exists():
+ desti_error.symlink_to(error_log)
+
+
+def get_local_client_version(client: BaseWebClient) -> str | None:
+ relinfo_file = client.client_dir.joinpath("release_info.json")
+ version_file = client.client_dir.joinpath(".version")
+
+ if not client.client_dir.exists():
+ return None
+ if not relinfo_file.is_file() and not version_file.is_file():
+ return "n/a"
+
+ if relinfo_file.is_file():
+ with open(relinfo_file, "r") as f:
+ return str(json.load(f)["version"])
+ else:
+ with open(version_file, "r") as f:
+ return f.readlines()[0]
+
+
+def get_remote_client_version(client: BaseWebClient) -> str | None:
+ try:
+ if (tag := get_latest_remote_tag(client.repo_path)) != "":
+ return str(tag)
+ return None
+ except Exception:
+ return None
+
+
+def backup_client_data(client: BaseWebClient) -> None:
+ name = client.name
+ src = client.client_dir
+ dest = client.backup_dir
+
+ with open(src.joinpath(".version"), "r") as v:
+ version = v.readlines()[0]
+
+ bm = BackupManager()
+ bm.backup_directory(f"{name}-{version}", src, dest)
+ bm.backup_file(client.config_file, dest)
+ bm.backup_file(NGINX_SITES_AVAILABLE.joinpath(name), dest)
+
+
+def backup_client_config_data(client: BaseWebClient) -> None:
+ client_config = client.client_config
+ name = client_config.name
+ source = client_config.config_dir
+ target = client_config.backup_dir
+ bm = BackupManager()
+ bm.backup_directory(name, source, target)
+
+
+def get_existing_clients() -> List[BaseWebClient]:
+ clients = list(get_args(WebClientType))
+ installed_clients: List[BaseWebClient] = []
+ for client in clients:
+ if client.client_dir.exists():
+ installed_clients.append(client)
+
+ return installed_clients
+
+
+def detect_client_cfg_conflict(curr_client: BaseWebClient) -> bool:
+ """
+ Check if any other client configs are present on the system.
+ It is usually not harmful, but chances are they can conflict each other.
+ Multiple client configs are, at least, redundant to have them installed
+ :param curr_client: The client name to check for the conflict
+ :return: True, if other client configs were found, else False
+ """
+
+ mainsail_cfg_status: ComponentStatus = get_client_config_status(MainsailData())
+ fluidd_cfg_status: ComponentStatus = get_client_config_status(FluiddData())
+
+ if curr_client.client == WebClientType.MAINSAIL and fluidd_cfg_status.status == 2:
+ return True
+ if curr_client.client == WebClientType.FLUIDD and mainsail_cfg_status.status == 2:
+ return True
+
+ return False
+
+
+def get_download_url(base_url: str, client: BaseWebClient) -> str:
+ settings = KiauhSettings()
+ use_unstable = settings.get(client.name, "unstable_releases")
+ stable_url = f"{base_url}/latest/download/{client.name}.zip"
+
+ if not use_unstable:
+ return stable_url
+
+ try:
+ unstable_tag = get_latest_unstable_tag(client.repo_path)
+ if unstable_tag == "":
+ raise Exception
+ return f"{base_url}/download/{unstable_tag}/{client.name}.zip"
+ except Exception:
+ return stable_url
+
+
+#################################################
+## NGINX RELATED FUNCTIONS
+#################################################
+
+
+def copy_upstream_nginx_cfg() -> None:
+ """
+ Creates an upstream.conf in /etc/nginx/conf.d
+ :return: None
+ """
+ source = MODULE_PATH.joinpath("assets/upstreams.conf")
+ target = NGINX_CONFD.joinpath("upstreams.conf")
+ try:
+ command = ["sudo", "cp", source, target]
+ run(command, stderr=PIPE, check=True)
+ except CalledProcessError as e:
+ log = f"Unable to create upstreams.conf: {e.stderr.decode()}"
+ Logger.print_error(log)
+ raise
+
+
+def copy_common_vars_nginx_cfg() -> None:
+ """
+ Creates a common_vars.conf in /etc/nginx/conf.d
+ :return: None
+ """
+ source = MODULE_PATH.joinpath("assets/common_vars.conf")
+ target = NGINX_CONFD.joinpath("common_vars.conf")
+ try:
+ command = ["sudo", "cp", source, target]
+ run(command, stderr=PIPE, check=True)
+ except CalledProcessError as e:
+ log = f"Unable to create upstreams.conf: {e.stderr.decode()}"
+ Logger.print_error(log)
+ raise
+
+
+def generate_nginx_cfg_from_template(name: str, template_src: Path, **kwargs) -> None:
+ """
+ Creates an NGINX config from a template file and
+ replaces all placeholders passed as kwargs. A placeholder must be defined
+ in the template file as %{placeholder}%.
+ :param name: name of the config to create
+ :param template_src: the path to the template file
+ :return: None
+ """
+ tmp = Path.home().joinpath(f"{name}.tmp")
+ shutil.copy(template_src, tmp)
+ with open(tmp, "r+") as f:
+ content = f.read()
+
+ for key, value in kwargs.items():
+ content = content.replace(f"%{key}%", str(value))
+
+ f.seek(0)
+ f.write(content)
+ f.truncate()
+
+ target = NGINX_SITES_AVAILABLE.joinpath(name)
+ try:
+ command = ["sudo", "mv", tmp, target]
+ run(command, stderr=PIPE, check=True)
+ except CalledProcessError as e:
+ log = f"Unable to create '{target}': {e.stderr.decode()}"
+ Logger.print_error(log)
+ raise
+
+
+def create_nginx_cfg(
+ display_name: str,
+ cfg_name: str,
+ template_src: Path,
+ **kwargs,
+) -> None:
+ from utils.sys_utils import set_nginx_permissions
+
+ try:
+ Logger.print_status(f"Creating NGINX config for {display_name} ...")
+
+ source = NGINX_SITES_AVAILABLE.joinpath(cfg_name)
+ target = NGINX_SITES_ENABLED.joinpath(cfg_name)
+ remove_file(Path("/etc/nginx/sites-enabled/default"), True)
+ generate_nginx_cfg_from_template(cfg_name, template_src=template_src, **kwargs)
+ create_symlink(source, target, True)
+ set_nginx_permissions()
+
+ Logger.print_ok(f"NGINX config for {display_name} successfully created.")
+ except Exception:
+ Logger.print_error(f"Creating NGINX config for {display_name} failed!")
+ raise
+
+
+def read_ports_from_nginx_configs() -> List[int]:
+ """
+ Helper function to iterate over all NGINX configs and read all ports defined for listen
+ :return: A sorted list of listen ports
+ """
+ if not NGINX_SITES_ENABLED.exists():
+ return []
+
+ port_list = []
+ for config in NGINX_SITES_ENABLED.iterdir():
+ if not config.is_file():
+ continue
+
+ with open(config, "r") as cfg:
+ lines = cfg.readlines()
+
+ for line in lines:
+ line = line.replace("default_server", "")
+ line = re.sub(r"[;:\[\]]", "", line.strip())
+ if line.startswith("listen") and line.split()[-1] not in port_list:
+ port_list.append(line.split()[-1])
+
+ ports_to_ints_list = [int(port) for port in port_list]
+ return sorted(ports_to_ints_list, key=lambda x: int(x))
+
+
+def is_valid_port(port: int, ports_in_use: List[int]) -> bool:
+ return port not in ports_in_use
+
+
+def get_next_free_port(ports_in_use: List[int]) -> int:
+ valid_ports = set(range(80, 7125))
+ used_ports = set(map(int, ports_in_use))
+
+ return min(valid_ports - used_ports)
diff --git a/kiauh/components/webui_client/fluidd_data.py b/kiauh/components/webui_client/fluidd_data.py
new file mode 100644
index 0000000..b499351
--- /dev/null
+++ b/kiauh/components/webui_client/fluidd_data.py
@@ -0,0 +1,56 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from pathlib import Path
+
+from components.webui_client.base_data import (
+ BaseWebClient,
+ BaseWebClientConfig,
+ WebClientConfigType,
+ WebClientType,
+)
+from core.backup_manager import BACKUP_ROOT_DIR
+
+
+@dataclass()
+class FluiddConfigWeb(BaseWebClientConfig):
+ client_config: WebClientConfigType = WebClientConfigType.FLUIDD
+ name: str = client_config.value
+ display_name: str = name.title()
+ config_dir: Path = Path.home().joinpath("fluidd-config")
+ config_filename: str = "fluidd.cfg"
+ config_section: str = f"include {config_filename}"
+ backup_dir: Path = BACKUP_ROOT_DIR.joinpath("fluidd-config-backups")
+ repo_url: str = "https://github.com/fluidd-core/fluidd-config.git"
+
+
+@dataclass()
+class FluiddData(BaseWebClient):
+ BASE_DL_URL = "https://github.com/fluidd-core/fluidd/releases"
+
+ client: WebClientType = WebClientType.FLUIDD
+ name: str = client.value
+ display_name: str = name.capitalize()
+ client_dir: Path = Path.home().joinpath("fluidd")
+ config_file: Path = client_dir.joinpath("config.json")
+ backup_dir: Path = BACKUP_ROOT_DIR.joinpath("fluidd-backups")
+ repo_path: str = "fluidd-core/fluidd"
+ nginx_access_log: Path = Path("/var/log/nginx/fluidd-access.log")
+ nginx_error_log: Path = Path("/var/log/nginx/fluidd-error.log")
+ client_config: BaseWebClientConfig = None
+ download_url: str | None = None
+
+ def __post_init__(self):
+ from components.webui_client.client_utils import get_download_url
+
+ self.client_config = FluiddConfigWeb()
+ self.download_url = get_download_url(self.BASE_DL_URL, self)
diff --git a/kiauh/components/webui_client/mainsail_data.py b/kiauh/components/webui_client/mainsail_data.py
new file mode 100644
index 0000000..1d520a1
--- /dev/null
+++ b/kiauh/components/webui_client/mainsail_data.py
@@ -0,0 +1,56 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from pathlib import Path
+
+from components.webui_client.base_data import (
+ BaseWebClient,
+ BaseWebClientConfig,
+ WebClientConfigType,
+ WebClientType,
+)
+from core.backup_manager import BACKUP_ROOT_DIR
+
+
+@dataclass()
+class MainsailConfigWeb(BaseWebClientConfig):
+ client_config: WebClientConfigType = WebClientConfigType.MAINSAIL
+ name: str = client_config.value
+ display_name: str = name.title()
+ config_dir: Path = Path.home().joinpath("mainsail-config")
+ config_filename: str = "mainsail.cfg"
+ config_section: str = f"include {config_filename}"
+ backup_dir: Path = BACKUP_ROOT_DIR.joinpath("mainsail-config-backups")
+ repo_url: str = "https://github.com/mainsail-crew/mainsail-config.git"
+
+
+@dataclass()
+class MainsailData(BaseWebClient):
+ BASE_DL_URL: str = "https://github.com/mainsail-crew/mainsail/releases"
+
+ client: WebClientType = WebClientType.MAINSAIL
+ name: str = WebClientType.MAINSAIL.value
+ display_name: str = name.capitalize()
+ client_dir: Path = Path.home().joinpath("mainsail")
+ config_file: Path = client_dir.joinpath("config.json")
+ backup_dir: Path = BACKUP_ROOT_DIR.joinpath("mainsail-backups")
+ repo_path: str = "mainsail-crew/mainsail"
+ nginx_access_log: Path = Path("/var/log/nginx/mainsail-access.log")
+ nginx_error_log: Path = Path("/var/log/nginx/mainsail-error.log")
+ client_config: BaseWebClientConfig = None
+ download_url: str | None = None
+
+ def __post_init__(self):
+ from components.webui_client.client_utils import get_download_url
+
+ self.client_config = MainsailConfigWeb()
+ self.download_url = get_download_url(self.BASE_DL_URL, self)
diff --git a/kiauh/components/webui_client/menus/__init__.py b/kiauh/components/webui_client/menus/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/kiauh/components/webui_client/menus/client_remove_menu.py b/kiauh/components/webui_client/menus/client_remove_menu.py
new file mode 100644
index 0000000..cc16049
--- /dev/null
+++ b/kiauh/components/webui_client/menus/client_remove_menu.py
@@ -0,0 +1,126 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from components.webui_client import client_remove
+from components.webui_client.base_data import BaseWebClient
+from core.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+
+
+# noinspection PyUnusedLocal
+class ClientRemoveMenu(BaseMenu):
+ def __init__(
+ self, client: BaseWebClient, previous_menu: Type[BaseMenu] | None = None
+ ):
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+ self.client: BaseWebClient = client
+ self.remove_client: bool = False
+ self.remove_client_cfg: bool = False
+ self.backup_config_json: bool = False
+ self.selection_state: bool = False
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from core.menus.remove_menu import RemoveMenu
+
+ self.previous_menu = previous_menu if previous_menu is not None else RemoveMenu
+
+ def set_options(self) -> None:
+ self.options = {
+ "a": Option(method=self.toggle_all),
+ "1": Option(method=self.toggle_rm_client),
+ "2": Option(method=self.toggle_rm_client_config),
+ "3": Option(method=self.toggle_backup_config_json),
+ "c": Option(method=self.run_removal_process),
+ }
+
+ def print_menu(self) -> None:
+ client_name = self.client.display_name
+ client_config = self.client.client_config
+ client_config_name = client_config.display_name
+
+ header = f" [ Remove {client_name} ] "
+ color = COLOR_RED
+ count = 62 - len(color) - len(RESET_FORMAT)
+ checked = f"[{COLOR_CYAN}x{RESET_FORMAT}]"
+ unchecked = "[ ]"
+ o1 = checked if self.remove_client else unchecked
+ o2 = checked if self.remove_client_cfg else unchecked
+ o3 = checked if self.backup_config_json else unchecked
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ Enter a number and hit enter to select / deselect ║
+ ║ the specific option for removal. ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ a) {self._get_selection_state_str():37} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ 1) {o1} Remove {client_name:16} ║
+ ║ 2) {o2} Remove {client_config_name:24} ║
+ ║ 3) {o3} Backup config.json ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ C) Continue ║
+ ╟───────────────────────────────────────────────────────╢
+ """
+ )[1:]
+ print(menu, end="")
+
+ def toggle_all(self, **kwargs) -> None:
+ self.selection_state = not self.selection_state
+ self.remove_client = self.selection_state
+ self.remove_client_cfg = self.selection_state
+ self.backup_config_json = self.selection_state
+
+ def toggle_rm_client(self, **kwargs) -> None:
+ self.remove_client = not self.remove_client
+
+ def toggle_rm_client_config(self, **kwargs) -> None:
+ self.remove_client_cfg = not self.remove_client_cfg
+
+ def toggle_backup_config_json(self, **kwargs) -> None:
+ self.backup_config_json = not self.backup_config_json
+
+ def run_removal_process(self, **kwargs) -> None:
+ if (
+ not self.remove_client
+ and not self.remove_client_cfg
+ and not self.backup_config_json
+ ):
+ error = f"{COLOR_RED}Nothing selected ...{RESET_FORMAT}"
+ print(error)
+ return
+
+ client_remove.run_client_removal(
+ client=self.client,
+ remove_client=self.remove_client,
+ remove_client_cfg=self.remove_client_cfg,
+ backup_config=self.backup_config_json,
+ )
+
+ self.remove_client = False
+ self.remove_client_cfg = False
+ self.backup_config_json = False
+
+ self._go_back()
+
+ def _get_selection_state_str(self) -> str:
+ return (
+ "Select everything" if not self.selection_state else "Deselect everything"
+ )
+
+ def _go_back(self, **kwargs) -> None:
+ if self.previous_menu is not None:
+ self.previous_menu().run()
diff --git a/kiauh/core/__init__.py b/kiauh/core/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/kiauh/core/backup_manager/__init__.py b/kiauh/core/backup_manager/__init__.py
new file mode 100644
index 0000000..642c8aa
--- /dev/null
+++ b/kiauh/core/backup_manager/__init__.py
@@ -0,0 +1,12 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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
+
+BACKUP_ROOT_DIR = Path.home().joinpath("kiauh-backups")
diff --git a/kiauh/core/backup_manager/backup_manager.py b/kiauh/core/backup_manager/backup_manager.py
new file mode 100644
index 0000000..824f58c
--- /dev/null
+++ b/kiauh/core/backup_manager/backup_manager.py
@@ -0,0 +1,94 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import shutil
+from pathlib import Path
+from typing import List
+
+from core.backup_manager import BACKUP_ROOT_DIR
+from core.logger import Logger
+from utils.common import get_current_date
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class BackupManager:
+ def __init__(self, backup_root_dir: Path = BACKUP_ROOT_DIR):
+ self._backup_root_dir: Path = backup_root_dir
+ self._ignore_folders: List[str] = []
+
+ @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
+
+ @property
+ def ignore_folders(self) -> List[str]:
+ return self._ignore_folders
+
+ @ignore_folders.setter
+ def ignore_folders(self, value: List[str]):
+ self._ignore_folders = value
+
+ def backup_file(self, file: Path, target: Path | None = None, custom_filename=None):
+ Logger.print_status(f"Creating backup of {file} ...")
+
+ if not file.exists():
+ Logger.print_info("File does not exist! Skipping ...")
+ return
+
+ target = self.backup_root_dir if target is None else target
+
+ 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))
+ Logger.print_ok("Backup successful!")
+ except OSError as e:
+ Logger.print_error(f"Unable to backup '{file}':\n{e}")
+ else:
+ Logger.print_info(f"File '{file}' not found ...")
+
+ def backup_directory(
+ self, name: str, source: Path, target: Path | None = None
+ ) -> None:
+ Logger.print_status(f"Creating backup of {name} in {target} ...")
+
+ if source is None or not Path(source).exists():
+ Logger.print_info("Source directory does not exist! Skipping ...")
+ return
+
+ target = self.backup_root_dir if target is None else target
+ try:
+ date = get_current_date().get("date")
+ time = get_current_date().get("time")
+ shutil.copytree(
+ source,
+ target.joinpath(f"{name.lower()}-{date}-{time}"),
+ ignore=self.ignore_folders_func,
+ )
+ Logger.print_ok("Backup successful!")
+ except OSError as e:
+ Logger.print_error(f"Unable to backup directory '{source}':\n{e}")
+ return
+
+ def ignore_folders_func(self, dirpath, filenames) -> List[str]:
+ return (
+ [f for f in filenames if f in self._ignore_folders]
+ if self._ignore_folders
+ else []
+ )
diff --git a/kiauh/core/constants.py b/kiauh/core/constants.py
new file mode 100644
index 0000000..d613ccf
--- /dev/null
+++ b/kiauh/core/constants.py
@@ -0,0 +1,39 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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
+
+from core.backup_manager import BACKUP_ROOT_DIR
+
+# 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
+
+# global dependencies
+GLOBAL_DEPS = ["git", "wget", "curl", "unzip", "dfu-util", "python3-virtualenv"]
+
+# strings
+INVALID_CHOICE = "Invalid choice. Please select a valid value."
+
+# current user
+CURRENT_USER = pwd.getpwuid(os.getuid())[0]
+
+# dirs
+SYSTEMD = Path("/etc/systemd/system")
+PRINTER_CFG_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("printer-cfg-backups")
+NGINX_SITES_AVAILABLE = Path("/etc/nginx/sites-available")
+NGINX_SITES_ENABLED = Path("/etc/nginx/sites-enabled")
+NGINX_CONFD = Path("/etc/nginx/conf.d")
diff --git a/kiauh/core/decorators.py b/kiauh/core/decorators.py
new file mode 100644
index 0000000..c34b5e3
--- /dev/null
+++ b/kiauh/core/decorators.py
@@ -0,0 +1,24 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import warnings
+from typing import Callable
+
+
+def deprecated(info: str = "", replaced_by: Callable | None = None) -> Callable:
+ def decorator(func) -> Callable:
+ def wrapper(*args, **kwargs):
+ msg = f"{info}{replaced_by.__name__ if replaced_by else ''}"
+ warnings.warn(msg, category=DeprecationWarning, stacklevel=2)
+ return func(*args, **kwargs)
+
+ return wrapper
+
+ return decorator
diff --git a/kiauh/core/instance_manager/__init__.py b/kiauh/core/instance_manager/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/kiauh/core/instance_manager/base_instance.py b/kiauh/core/instance_manager/base_instance.py
new file mode 100644
index 0000000..642693c
--- /dev/null
+++ b/kiauh/core/instance_manager/base_instance.py
@@ -0,0 +1,58 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+
+from __future__ import annotations
+
+import re
+from dataclasses import dataclass, field
+from pathlib import Path
+from typing import List
+
+from utils.fs_utils import get_data_dir
+
+SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion"]
+
+
+@dataclass(repr=True)
+class BaseInstance:
+ instance_type: type
+ suffix: str
+ log_file_name: str | None = None
+ data_dir: Path = field(init=False)
+ base_folders: List[Path] = field(init=False)
+ cfg_dir: Path = field(init=False)
+ log_dir: Path = field(init=False)
+ gcodes_dir: Path = field(init=False)
+ comms_dir: Path = field(init=False)
+ sysd_dir: Path = field(init=False)
+ is_legacy_instance: bool = field(init=False)
+
+ def __post_init__(self):
+ self.data_dir = get_data_dir(self.instance_type, self.suffix)
+ # the following attributes require the data_dir to be set
+ self.cfg_dir = self.data_dir.joinpath("config")
+ self.log_dir = self.data_dir.joinpath("logs")
+ self.gcodes_dir = self.data_dir.joinpath("gcodes")
+ self.comms_dir = self.data_dir.joinpath("comms")
+ self.sysd_dir = self.data_dir.joinpath("systemd")
+ self.is_legacy_instance = self._set_is_legacy_instance()
+ self.base_folders = [
+ self.data_dir,
+ self.cfg_dir,
+ self.log_dir,
+ self.gcodes_dir,
+ self.comms_dir,
+ self.sysd_dir,
+ ]
+
+ def _set_is_legacy_instance(self) -> bool:
+ legacy_pattern = r"^(?!printer)(.+)_data"
+ match = re.search(legacy_pattern, self.data_dir.name)
+
+ return True if (match and self.suffix != "") else False
diff --git a/kiauh/core/instance_manager/instance_manager.py b/kiauh/core/instance_manager/instance_manager.py
new file mode 100644
index 0000000..9142bee
--- /dev/null
+++ b/kiauh/core/instance_manager/instance_manager.py
@@ -0,0 +1,108 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+from pathlib import Path
+from subprocess import CalledProcessError
+from typing import List
+
+from core.instance_type import InstanceType
+from core.logger import Logger
+from utils.sys_utils import cmd_sysctl_service
+
+
+class InstanceManager:
+ @staticmethod
+ def enable(instance: InstanceType) -> None:
+ service_name: str = instance.service_file_path.name
+ try:
+ cmd_sysctl_service(service_name, "enable")
+ except CalledProcessError as e:
+ Logger.print_error(f"Error enabling service {service_name}:")
+ Logger.print_error(f"{e}")
+
+ @staticmethod
+ def disable(instance: InstanceType) -> None:
+ service_name: str = instance.service_file_path.name
+ try:
+ cmd_sysctl_service(service_name, "disable")
+ except CalledProcessError as e:
+ Logger.print_error(f"Error disabling {service_name}: {e}")
+ raise
+
+ @staticmethod
+ def start(instance: InstanceType) -> None:
+ service_name: str = instance.service_file_path.name
+ try:
+ cmd_sysctl_service(service_name, "start")
+ except CalledProcessError as e:
+ Logger.print_error(f"Error starting {service_name}: {e}")
+ raise
+
+ @staticmethod
+ def stop(instance: InstanceType) -> None:
+ name: str = instance.service_file_path.name
+ try:
+ cmd_sysctl_service(name, "stop")
+ except CalledProcessError as e:
+ Logger.print_error(f"Error stopping {name}: {e}")
+ raise
+
+ @staticmethod
+ def restart(instance: InstanceType) -> None:
+ name: str = instance.service_file_path.name
+ try:
+ cmd_sysctl_service(name, "restart")
+ except CalledProcessError as e:
+ Logger.print_error(f"Error restarting {name}: {e}")
+ raise
+
+ @staticmethod
+ def start_all(instances: List[InstanceType]) -> None:
+ for instance in instances:
+ InstanceManager.start(instance)
+
+ @staticmethod
+ def stop_all(instances: List[InstanceType]) -> None:
+ for instance in instances:
+ InstanceManager.stop(instance)
+
+ @staticmethod
+ def restart_all(instances: List[InstanceType]) -> None:
+ for instance in instances:
+ InstanceManager.restart(instance)
+
+ @staticmethod
+ def remove(instance: InstanceType) -> None:
+ from utils.fs_utils import run_remove_routines
+ from utils.sys_utils import remove_system_service
+
+ try:
+ # remove the service file
+ service_file_path: Path = instance.service_file_path
+ if service_file_path is not None:
+ remove_system_service(service_file_path.name)
+
+ # then remove all the log files
+ if (
+ not instance.log_file_name
+ or not instance.base.log_dir
+ or not instance.base.log_dir.exists()
+ ):
+ return
+
+ files = instance.base.log_dir.iterdir()
+ logs = [f for f in files if f.name.startswith(instance.log_file_name)]
+ for log in logs:
+ Logger.print_status(f"Remove '{log}'")
+ run_remove_routines(log)
+
+ except Exception as e:
+ Logger.print_error(f"Error removing service: {e}")
+ raise
diff --git a/kiauh/core/instance_type.py b/kiauh/core/instance_type.py
new file mode 100644
index 0000000..c021c50
--- /dev/null
+++ b/kiauh/core/instance_type.py
@@ -0,0 +1,25 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+
+from typing import TypeVar
+
+from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from components.octoeverywhere.octoeverywhere import Octoeverywhere
+from extensions.obico.moonraker_obico import MoonrakerObico
+from extensions.telegram_bot.moonraker_telegram_bot import MoonrakerTelegramBot
+
+InstanceType = TypeVar(
+ "InstanceType",
+ Klipper,
+ Moonraker,
+ MoonrakerTelegramBot,
+ MoonrakerObico,
+ Octoeverywhere,
+)
diff --git a/kiauh/core/logger.py b/kiauh/core/logger.py
new file mode 100644
index 0000000..0387163
--- /dev/null
+++ b/kiauh/core/logger.py
@@ -0,0 +1,194 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from enum import Enum
+from typing import List
+
+from core.constants import (
+ COLOR_CYAN,
+ COLOR_GREEN,
+ COLOR_MAGENTA,
+ COLOR_RED,
+ COLOR_WHITE,
+ COLOR_YELLOW,
+ RESET_FORMAT,
+)
+
+
+class DialogType(Enum):
+ INFO = ("INFO", COLOR_WHITE)
+ SUCCESS = ("SUCCESS", COLOR_GREEN)
+ ATTENTION = ("ATTENTION", COLOR_YELLOW)
+ WARNING = ("WARNING", COLOR_YELLOW)
+ ERROR = ("ERROR", COLOR_RED)
+ CUSTOM = (None, None)
+
+
+class DialogCustomColor(Enum):
+ WHITE = COLOR_WHITE
+ GREEN = COLOR_GREEN
+ YELLOW = COLOR_YELLOW
+ RED = COLOR_RED
+ CYAN = COLOR_CYAN
+ MAGENTA = COLOR_MAGENTA
+
+
+LINE_WIDTH = 53
+
+
+class Logger:
+ @staticmethod
+ def info(msg) -> None:
+ # log to kiauh.log
+ pass
+
+ @staticmethod
+ def warn(msg) -> None:
+ # log to kiauh.log
+ pass
+
+ @staticmethod
+ def error(msg) -> None:
+ # log to kiauh.log
+ pass
+
+ @staticmethod
+ def print_info(msg, prefix=True, start="", end="\n") -> None:
+ message = f"[INFO] {msg}" if prefix else msg
+ print(f"{COLOR_WHITE}{start}{message}{RESET_FORMAT}", end=end)
+
+ @staticmethod
+ def print_ok(msg: str = "Success!", prefix=True, start="", end="\n") -> None:
+ message = f"[OK] {msg}" if prefix else msg
+ print(f"{COLOR_GREEN}{start}{message}{RESET_FORMAT}", end=end)
+
+ @staticmethod
+ def print_warn(msg, prefix=True, start="", end="\n") -> None:
+ message = f"[WARN] {msg}" if prefix else msg
+ print(f"{COLOR_YELLOW}{start}{message}{RESET_FORMAT}", end=end)
+
+ @staticmethod
+ def print_error(msg, prefix=True, start="", end="\n") -> None:
+ message = f"[ERROR] {msg}" if prefix else msg
+ print(f"{COLOR_RED}{start}{message}{RESET_FORMAT}", end=end)
+
+ @staticmethod
+ def print_status(msg, prefix=True, start="", end="\n") -> None:
+ message = f"\n###### {msg}" if prefix else msg
+ print(f"{COLOR_MAGENTA}{start}{message}{RESET_FORMAT}", end=end)
+
+ @staticmethod
+ def print_dialog(
+ title: DialogType,
+ content: List[str],
+ center_content: bool = False,
+ custom_title: str | None = None,
+ custom_color: DialogCustomColor | None = None,
+ margin_top: int = 0,
+ margin_bottom: int = 0,
+ ) -> None:
+ """
+ Prints a dialog with the given title and content.
+ Those dialogs should be used to display verbose messages to the user which
+ require simple interaction like confirmation or input. Do not use this for
+ navigating through the application.
+
+ :param title: The type of the dialog.
+ :param content: The content of the dialog.
+ :param center_content: Whether to center the content or not.
+ :param custom_title: A custom title for the dialog.
+ :param custom_color: A custom color for the dialog.
+ :param margin_top: The number of empty lines to print before the dialog.
+ :param margin_bottom: The number of empty lines to print after the dialog.
+ """
+ dialog_color = Logger._get_dialog_color(title, custom_color)
+ dialog_title = Logger._get_dialog_title(title, custom_title)
+ dialog_title_formatted = Logger._format_dialog_title(dialog_title)
+ dialog_content = Logger.format_content(content, LINE_WIDTH, center_content)
+ top = Logger._format_top_border(dialog_color)
+ bottom = Logger._format_bottom_border()
+
+ print("\n" * margin_top)
+ print(
+ f"{top}{dialog_title_formatted}{dialog_content}{bottom}",
+ end="",
+ )
+ print("\n" * margin_bottom)
+
+ @staticmethod
+ def _get_dialog_title(
+ title: DialogType, custom_title: str | None = None
+ ) -> str | None:
+ if title == DialogType.CUSTOM and custom_title:
+ return f"[ {custom_title} ]"
+ return f"[ {title.value[0]} ]" if title.value[0] else None
+
+ @staticmethod
+ def _get_dialog_color(
+ title: DialogType, custom_color: DialogCustomColor | None = None
+ ) -> str:
+ if title == DialogType.CUSTOM and custom_color:
+ return str(custom_color.value)
+
+ color: str = title.value[1] if title.value[1] else DialogCustomColor.WHITE.value
+
+ return color
+
+ @staticmethod
+ def _format_top_border(color: str) -> str:
+ return f"{color}┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓"
+
+ @staticmethod
+ def _format_bottom_border() -> str:
+ return (
+ f"\n┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛{RESET_FORMAT}"
+ )
+
+ @staticmethod
+ def _format_dialog_title(title: str | None) -> str:
+ if title is not None:
+ return textwrap.dedent(f"""
+ ┃ {title:^{LINE_WIDTH}} ┃
+ ┠───────────────────────────────────────────────────────┨
+ """)
+ else:
+ return "\n"
+
+ @staticmethod
+ def format_content(
+ content: List[str],
+ line_width: int,
+ center_content: bool = False,
+ border_left: str = "┃",
+ border_right: str = "┃",
+ ) -> str:
+ wrapper = textwrap.TextWrapper(line_width)
+
+ lines = []
+ for i, c in enumerate(content):
+ paragraph = wrapper.wrap(c)
+ lines.extend(paragraph)
+
+ # add a full blank line if we have a double newline
+ # character unless we are at the end of the list
+ if c == "\n\n" and i < len(content) - 1:
+ lines.append(" " * line_width)
+
+ if not center_content:
+ formatted_lines = [
+ f"{border_left} {line:<{line_width}} {border_right}" for line in lines
+ ]
+ else:
+ formatted_lines = [
+ f"{border_left} {line:^{line_width}} {border_right}" for line in lines
+ ]
+
+ return "\n".join(formatted_lines)
diff --git a/kiauh/core/menus/__init__.py b/kiauh/core/menus/__init__.py
new file mode 100644
index 0000000..1166127
--- /dev/null
+++ b/kiauh/core/menus/__init__.py
@@ -0,0 +1,34 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+from dataclasses import dataclass
+from enum import Enum
+from typing import Any, Callable, Type
+
+
+@dataclass
+class Option:
+ """
+ Represents a menu option.
+ :param method: Method that will be used to call the menu option
+ :param opt_index: Can be used to pass the user input to the menu option
+ :param opt_data: Can be used to pass any additional data to the menu option
+ """
+
+ method: Type[Callable] | None = None
+ opt_index: str = ""
+ opt_data: Any = None
+
+
+class FooterType(Enum):
+ QUIT = "QUIT"
+ BACK = "BACK"
+ BACK_HELP = "BACK_HELP"
+ BLANK = "BLANK"
diff --git a/kiauh/core/menus/advanced_menu.py b/kiauh/core/menus/advanced_menu.py
new file mode 100644
index 0000000..484e1ba
--- /dev/null
+++ b/kiauh/core/menus/advanced_menu.py
@@ -0,0 +1,98 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from components.klipper import KLIPPER_DIR
+from components.klipper.klipper import Klipper
+from components.klipper_firmware.menus.klipper_build_menu import (
+ KlipperBuildFirmwareMenu,
+)
+from components.klipper_firmware.menus.klipper_flash_menu import (
+ KlipperFlashMethodMenu,
+ KlipperSelectMcuConnectionMenu,
+)
+from components.moonraker import MOONRAKER_DIR
+from components.moonraker.moonraker import Moonraker
+from core.constants import COLOR_YELLOW, RESET_FORMAT
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+from procedures.system import change_system_hostname
+from utils.git_utils import rollback_repository
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class AdvancedMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from core.menus.main_menu import MainMenu
+
+ self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+ def set_options(self) -> None:
+ self.options = {
+ "1": Option(method=self.build),
+ "2": Option(method=self.flash),
+ "3": Option(method=self.build_flash),
+ "4": Option(method=self.get_id),
+ "5": Option(method=self.klipper_rollback),
+ "6": Option(method=self.moonraker_rollback),
+ "7": Option(method=self.change_hostname),
+ }
+
+ def print_menu(self) -> None:
+ header = " [ Advanced Menu ] "
+ color = COLOR_YELLOW
+ count = 62 - len(color) - len(RESET_FORMAT)
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────┬───────────────────────────╢
+ ║ Klipper Firmware: │ Repository Rollback: ║
+ ║ 1) [Build] │ 5) [Klipper] ║
+ ║ 2) [Flash] │ 6) [Moonraker] ║
+ ║ 3) [Build + Flash] │ ║
+ ║ 4) [Get MCU ID] │ System: ║
+ ║ │ 7) [Change hostname] ║
+ ╟───────────────────────────┴───────────────────────────╢
+ """
+ )[1:]
+ print(menu, end="")
+
+ def klipper_rollback(self, **kwargs) -> None:
+ rollback_repository(KLIPPER_DIR, Klipper)
+
+ def moonraker_rollback(self, **kwargs) -> None:
+ rollback_repository(MOONRAKER_DIR, Moonraker)
+
+ def build(self, **kwargs) -> None:
+ KlipperBuildFirmwareMenu(previous_menu=self.__class__).run()
+
+ def flash(self, **kwargs) -> None:
+ KlipperFlashMethodMenu(previous_menu=self.__class__).run()
+
+ def build_flash(self, **kwargs) -> None:
+ KlipperBuildFirmwareMenu(previous_menu=KlipperFlashMethodMenu).run()
+ KlipperFlashMethodMenu(previous_menu=self.__class__).run()
+
+ def get_id(self, **kwargs) -> None:
+ KlipperSelectMcuConnectionMenu(
+ previous_menu=self.__class__,
+ standalone=True,
+ ).run()
+
+ def change_hostname(self, **kwargs) -> None:
+ change_system_hostname()
diff --git a/kiauh/core/menus/backup_menu.py b/kiauh/core/menus/backup_menu.py
new file mode 100644
index 0000000..be998b1
--- /dev/null
+++ b/kiauh/core/menus/backup_menu.py
@@ -0,0 +1,108 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from components.klipper.klipper_utils import backup_klipper_dir
+from components.klipperscreen.klipperscreen import backup_klipperscreen_dir
+from components.moonraker.moonraker_utils import (
+ backup_moonraker_db_dir,
+ backup_moonraker_dir,
+)
+from components.webui_client.client_utils import (
+ backup_client_config_data,
+ backup_client_data,
+)
+from components.webui_client.fluidd_data import FluiddData
+from components.webui_client.mainsail_data import MainsailData
+from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+from utils.common import backup_printer_config_dir
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class BackupMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from core.menus.main_menu import MainMenu
+
+ self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+ def set_options(self) -> None:
+ self.options = {
+ "1": Option(method=self.backup_klipper),
+ "2": Option(method=self.backup_moonraker),
+ "3": Option(method=self.backup_printer_config),
+ "4": Option(method=self.backup_moonraker_db),
+ "5": Option(method=self.backup_mainsail),
+ "6": Option(method=self.backup_fluidd),
+ "7": Option(method=self.backup_mainsail_config),
+ "8": Option(method=self.backup_fluidd_config),
+ "9": Option(method=self.backup_klipperscreen),
+ }
+
+ def print_menu(self) -> None:
+ header = " [ Backup Menu ] "
+ line1 = f"{COLOR_YELLOW}INFO: Backups are located in '~/kiauh-backups'{RESET_FORMAT}"
+ color = COLOR_CYAN
+ count = 62 - len(color) - len(RESET_FORMAT)
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ {line1:^62} ║
+ ╟───────────────────────────┬───────────────────────────╢
+ ║ Klipper & Moonraker API: │ Client-Config: ║
+ ║ 1) [Klipper] │ 7) [Mainsail-Config] ║
+ ║ 2) [Moonraker] │ 8) [Fluidd-Config] ║
+ ║ 3) [Config Folder] │ ║
+ ║ 4) [Moonraker Database] │ Touchscreen GUI: ║
+ ║ │ 9) [KlipperScreen] ║
+ ║ Webinterface: │ ║
+ ║ 5) [Mainsail] │ ║
+ ║ 6) [Fluidd] │ ║
+ ╟───────────────────────────┴───────────────────────────╢
+ """
+ )[1:]
+ print(menu, end="")
+
+ def backup_klipper(self, **kwargs) -> None:
+ backup_klipper_dir()
+
+ def backup_moonraker(self, **kwargs) -> None:
+ backup_moonraker_dir()
+
+ def backup_printer_config(self, **kwargs) -> None:
+ backup_printer_config_dir()
+
+ def backup_moonraker_db(self, **kwargs) -> None:
+ backup_moonraker_db_dir()
+
+ def backup_mainsail(self, **kwargs) -> None:
+ backup_client_data(MainsailData())
+
+ def backup_fluidd(self, **kwargs) -> None:
+ backup_client_data(FluiddData())
+
+ def backup_mainsail_config(self, **kwargs) -> None:
+ backup_client_config_data(MainsailData())
+
+ def backup_fluidd_config(self, **kwargs) -> None:
+ backup_client_config_data(FluiddData())
+
+ def backup_klipperscreen(self, **kwargs) -> None:
+ backup_klipperscreen_dir()
diff --git a/kiauh/core/menus/base_menu.py b/kiauh/core/menus/base_menu.py
new file mode 100644
index 0000000..d4eb30e
--- /dev/null
+++ b/kiauh/core/menus/base_menu.py
@@ -0,0 +1,223 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+
+from __future__ import annotations
+
+import subprocess
+import sys
+import textwrap
+import traceback
+from abc import abstractmethod
+from typing import Dict, Type
+
+from core.constants import (
+ COLOR_CYAN,
+ COLOR_GREEN,
+ COLOR_RED,
+ COLOR_YELLOW,
+ RESET_FORMAT,
+)
+from core.logger import Logger
+from core.menus import FooterType, Option
+
+
+def clear() -> None:
+ subprocess.call("clear", shell=True)
+
+
+def print_header() -> None:
+ 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() -> None:
+ 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() -> None:
+ 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() -> None:
+ 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="")
+
+
+def print_blank_footer() -> None:
+ print("╚═══════════════════════════════════════════════════════╝")
+
+
+class PostInitCaller(type):
+ def __call__(cls, *args, **kwargs):
+ obj = type.__call__(cls, *args, **kwargs)
+ obj.__post_init__()
+ return obj
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class BaseMenu(metaclass=PostInitCaller):
+ options: Dict[str, Option] = {}
+ options_offset: int = 0
+ default_option: Option = None
+ input_label_txt: str = "Perform action"
+ header: bool = False
+ previous_menu: Type[BaseMenu] | None = None
+ help_menu: Type[BaseMenu] | None = None
+ footer_type: FooterType = FooterType.BACK
+
+ def __init__(self, **kwargs) -> None:
+ if type(self) is BaseMenu:
+ raise NotImplementedError("BaseMenu cannot be instantiated directly.")
+
+ def __post_init__(self) -> None:
+ self.set_previous_menu(self.previous_menu)
+ self.set_options()
+
+ # conditionally add options based on footer type
+ if self.footer_type is FooterType.QUIT:
+ self.options["q"] = Option(method=self.__exit)
+ if self.footer_type is FooterType.BACK:
+ self.options["b"] = Option(method=self.__go_back)
+ if self.footer_type is FooterType.BACK_HELP:
+ self.options["b"] = Option(method=self.__go_back)
+ self.options["h"] = Option(method=self.__go_to_help)
+ # if defined, add the default option to the options dict
+ if self.default_option is not None:
+ self.options[""] = self.default_option
+
+ def __go_back(self, **kwargs) -> None:
+ if self.previous_menu is None:
+ return
+ self.previous_menu().run()
+
+ def __go_to_help(self, **kwargs) -> None:
+ if self.help_menu is None:
+ return
+ self.help_menu(previous_menu=self).run()
+
+ def __exit(self, **kwargs) -> None:
+ Logger.print_ok("###### Happy printing!", False)
+ sys.exit(0)
+
+ @abstractmethod
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ raise NotImplementedError
+
+ @abstractmethod
+ def set_options(self) -> None:
+ raise NotImplementedError
+
+ @abstractmethod
+ def print_menu(self) -> None:
+ raise NotImplementedError
+
+ def print_footer(self) -> None:
+ if self.footer_type is FooterType.QUIT:
+ print_quit_footer()
+ elif self.footer_type is FooterType.BACK:
+ print_back_footer()
+ elif self.footer_type is FooterType.BACK_HELP:
+ print_back_help_footer()
+ elif self.footer_type is FooterType.BLANK:
+ print_blank_footer()
+ else:
+ raise NotImplementedError("FooterType not correctly implemented!")
+
+ def display_menu(self) -> None:
+ if self.header:
+ print_header()
+ self.print_menu()
+ self.print_footer()
+
+ def validate_user_input(self, usr_input: str) -> Option:
+ """
+ Validate the user input and either return an Option, a string or None
+ :param usr_input: The user input in form of a string
+ :return: Option, str or None
+ """
+ usr_input = usr_input.lower()
+ option = self.options.get(
+ usr_input,
+ Option(method=None, opt_index="", opt_data=None),
+ )
+
+ # if option/usr_input is None/empty string, we execute the menus default option if specified
+ if (option is None or usr_input == "") and self.default_option is not None:
+ self.default_option.opt_index = usr_input
+ return self.default_option
+
+ # user selected a regular option
+ option.opt_index = usr_input
+ return option
+
+ def handle_user_input(self) -> Option:
+ """Handle the user input, return the validated input or print an error."""
+ while True:
+ print(f"{COLOR_CYAN}###### {self.input_label_txt}: {RESET_FORMAT}", end="")
+ usr_input = input().lower()
+ validated_input = self.validate_user_input(usr_input)
+
+ if validated_input.method is not None:
+ return validated_input
+ else:
+ Logger.print_error("Invalid input!", False)
+
+ def run(self) -> None:
+ """Start the menu lifecycle. When this function returns, the lifecycle of the menu ends."""
+ try:
+ self.display_menu()
+ option = self.handle_user_input()
+ option.method(opt_index=option.opt_index, opt_data=option.opt_data)
+ self.run()
+ except Exception as e:
+ Logger.print_error(
+ f"An unexpected error occured:\n{e}\n{traceback.format_exc()}"
+ )
diff --git a/kiauh/core/menus/install_menu.py b/kiauh/core/menus/install_menu.py
new file mode 100644
index 0000000..990b8dc
--- /dev/null
+++ b/kiauh/core/menus/install_menu.py
@@ -0,0 +1,109 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from components.crowsnest.crowsnest import install_crowsnest
+from components.klipper import klipper_setup
+from components.klipperscreen.klipperscreen import install_klipperscreen
+from components.mobileraker.mobileraker import install_mobileraker
+from components.moonraker import moonraker_setup
+from components.octoeverywhere.octoeverywhere_setup import install_octoeverywhere
+from components.webui_client import client_setup
+from components.webui_client.client_config import client_config_setup
+from components.webui_client.fluidd_data import FluiddData
+from components.webui_client.mainsail_data import MainsailData
+from core.constants import COLOR_GREEN, RESET_FORMAT
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class InstallMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from core.menus.main_menu import MainMenu
+
+ self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+ def set_options(self) -> None:
+ self.options = {
+ "1": Option(method=self.install_klipper),
+ "2": Option(method=self.install_moonraker),
+ "3": Option(method=self.install_mainsail),
+ "4": Option(method=self.install_fluidd),
+ "5": Option(method=self.install_mainsail_config),
+ "6": Option(method=self.install_fluidd_config),
+ "7": Option(method=self.install_klipperscreen),
+ "8": Option(method=self.install_mobileraker),
+ "9": Option(method=self.install_crowsnest),
+ "10": Option(method=self.install_octoeverywhere),
+ }
+
+ def print_menu(self) -> None:
+ header = " [ Installation Menu ] "
+ color = COLOR_GREEN
+ count = 62 - len(color) - len(RESET_FORMAT)
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────┬───────────────────────────╢
+ ║ Firmware & API: │ Touchscreen GUI: ║
+ ║ 1) [Klipper] │ 7) [KlipperScreen] ║
+ ║ 2) [Moonraker] │ ║
+ ║ │ Android / iOS: ║
+ ║ Webinterface: │ 8) [Mobileraker] ║
+ ║ 3) [Mainsail] │ ║
+ ║ 4) [Fluidd] │ Webcam Streamer: ║
+ ║ │ 9) [Crowsnest] ║
+ ║ Client-Config: │ ║
+ ║ 5) [Mainsail-Config] │ Remote Access: ║
+ ║ 6) [Fluidd-Config] │ 10) [OctoEverywhere] ║
+ ║ │ ║
+ ╟───────────────────────────┴───────────────────────────╢
+ """
+ )[1:]
+ print(menu, end="")
+
+ def install_klipper(self, **kwargs) -> None:
+ klipper_setup.install_klipper()
+
+ def install_moonraker(self, **kwargs) -> None:
+ moonraker_setup.install_moonraker()
+
+ def install_mainsail(self, **kwargs) -> None:
+ client_setup.install_client(MainsailData())
+
+ def install_mainsail_config(self, **kwargs) -> None:
+ client_config_setup.install_client_config(MainsailData())
+
+ def install_fluidd(self, **kwargs) -> None:
+ client_setup.install_client(FluiddData())
+
+ def install_fluidd_config(self, **kwargs) -> None:
+ client_config_setup.install_client_config(FluiddData())
+
+ def install_klipperscreen(self, **kwargs) -> None:
+ install_klipperscreen()
+
+ def install_mobileraker(self, **kwargs) -> None:
+ install_mobileraker()
+
+ def install_crowsnest(self, **kwargs) -> None:
+ install_crowsnest()
+
+ def install_octoeverywhere(self, **kwargs) -> None:
+ install_octoeverywhere()
diff --git a/kiauh/core/menus/main_menu.py b/kiauh/core/menus/main_menu.py
new file mode 100644
index 0000000..b7dec43
--- /dev/null
+++ b/kiauh/core/menus/main_menu.py
@@ -0,0 +1,189 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import sys
+import textwrap
+from typing import Callable, Type
+
+from components.crowsnest.crowsnest import get_crowsnest_status
+from components.klipper.klipper_utils import get_klipper_status
+from components.klipperscreen.klipperscreen import get_klipperscreen_status
+from components.log_uploads.menus.log_upload_menu import LogUploadMenu
+from components.mobileraker.mobileraker import get_mobileraker_status
+from components.moonraker.moonraker_utils import get_moonraker_status
+from components.octoeverywhere.octoeverywhere_setup import get_octoeverywhere_status
+from components.webui_client.client_utils import (
+ get_client_status,
+ get_current_client_config,
+)
+from components.webui_client.fluidd_data import FluiddData
+from components.webui_client.mainsail_data import MainsailData
+from core.constants import (
+ COLOR_CYAN,
+ COLOR_GREEN,
+ COLOR_MAGENTA,
+ COLOR_RED,
+ COLOR_YELLOW,
+ RESET_FORMAT,
+)
+from core.logger import Logger
+from core.menus import FooterType
+from core.menus.advanced_menu import AdvancedMenu
+from core.menus.backup_menu import BackupMenu
+from core.menus.base_menu import BaseMenu, Option
+from core.menus.install_menu import InstallMenu
+from core.menus.remove_menu import RemoveMenu
+from core.menus.settings_menu import SettingsMenu
+from core.menus.update_menu import UpdateMenu
+from core.types import ComponentStatus, StatusMap, StatusText
+from extensions.extensions_menu import ExtensionsMenu
+from utils.common import get_kiauh_version
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class MainMenu(BaseMenu):
+ def __init__(self) -> None:
+ super().__init__()
+
+ self.header: bool = True
+ self.footer_type: FooterType = FooterType.QUIT
+
+ self.version = ""
+ self.kl_status = self.kl_repo = self.mr_status = self.mr_repo = ""
+ self.ms_status = self.fl_status = self.ks_status = self.mb_status = ""
+ self.cn_status = self.cc_status = self.oe_status = ""
+ self._init_status()
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ """MainMenu does not have a previous menu"""
+ pass
+
+ def set_options(self) -> None:
+ self.options = {
+ "0": Option(method=self.log_upload_menu),
+ "1": Option(method=self.install_menu),
+ "2": Option(method=self.update_menu),
+ "3": Option(method=self.remove_menu),
+ "4": Option(method=self.advanced_menu),
+ "5": Option(method=self.backup_menu),
+ "e": Option(method=self.extension_menu),
+ "s": Option(method=self.settings_menu),
+ }
+
+ def _init_status(self) -> None:
+ status_vars = ["kl", "mr", "ms", "fl", "ks", "mb", "cn", "oe"]
+ for var in status_vars:
+ setattr(
+ self,
+ f"{var}_status",
+ f"{COLOR_RED}Not installed{RESET_FORMAT}",
+ )
+
+ def _fetch_status(self) -> None:
+ self.version = get_kiauh_version()
+ self._get_component_status("kl", get_klipper_status)
+ self._get_component_status("mr", get_moonraker_status)
+ self._get_component_status("ms", get_client_status, MainsailData())
+ self._get_component_status("fl", get_client_status, FluiddData())
+ self.cc_status = get_current_client_config([MainsailData(), FluiddData()])
+ self._get_component_status("ks", get_klipperscreen_status)
+ self._get_component_status("mb", get_mobileraker_status)
+ self._get_component_status("cn", get_crowsnest_status)
+ self._get_component_status("oe", get_octoeverywhere_status)
+
+ def _get_component_status(self, name: str, status_fn: Callable, *args) -> None:
+ status_data: ComponentStatus = status_fn(*args)
+ code: int = status_data.status
+ status: StatusText = StatusMap[code]
+ repo: str = status_data.repo
+ instance_count: int = status_data.instances
+
+ count_txt: str = ""
+ if instance_count > 0 and code == 2:
+ count_txt = f": {instance_count}"
+
+ setattr(self, f"{name}_status", self._format_by_code(code, status, count_txt))
+ setattr(self, f"{name}_repo", f"{COLOR_CYAN}{repo}{RESET_FORMAT}")
+
+ def _format_by_code(self, code: int, status: str, count: str) -> str:
+ color = COLOR_RED
+ if code == 0:
+ color = COLOR_RED
+ elif code == 1:
+ color = COLOR_YELLOW
+ elif code == 2:
+ color = COLOR_GREEN
+
+ return f"{color}{status}{count}{RESET_FORMAT}"
+
+ def print_menu(self) -> None:
+ self._fetch_status()
+
+ header = " [ Main Menu ] "
+ footer1 = f"{COLOR_CYAN}{self.version}{RESET_FORMAT}"
+ footer2 = f"Changelog: {COLOR_MAGENTA}https://git.io/JnmlX{RESET_FORMAT}"
+ color = COLOR_CYAN
+ count = 62 - len(color) - len(RESET_FORMAT)
+ pad1 = 32
+ pad2 = 26
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟──────────────────┬────────────────────────────────────╢
+ ║ 0) [Log-Upload] │ Klipper: {self.kl_status:<{pad1}} ║
+ ║ │ Repo: {self.kl_repo:<{pad1}} ║
+ ║ 1) [Install] ├────────────────────────────────────╢
+ ║ 2) [Update] │ Moonraker: {self.mr_status:<{pad1}} ║
+ ║ 3) [Remove] │ Repo: {self.mr_repo:<{pad1}} ║
+ ║ 4) [Advanced] ├────────────────────────────────────╢
+ ║ 5) [Backup] │ Mainsail: {self.ms_status:<{pad2}} ║
+ ║ │ Fluidd: {self.fl_status:<{pad2}} ║
+ ║ S) [Settings] │ Client-Config: {self.cc_status:<{pad2}} ║
+ ║ │ ║
+ ║ Community: │ KlipperScreen: {self.ks_status:<{pad2}} ║
+ ║ E) [Extensions] │ Mobileraker: {self.mb_status:<{pad2}} ║
+ ║ │ OctoEverywhere: {self.oe_status:<{pad2}} ║
+ ║ │ Crowsnest: {self.cn_status:<{pad2}} ║
+ ╟──────────────────┼────────────────────────────────────╢
+ ║ {footer1:^25} │ {footer2:^43} ║
+ ╟──────────────────┴────────────────────────────────────╢
+ """
+ )[1:]
+ print(menu, end="")
+
+ def exit(self, **kwargs) -> None:
+ Logger.print_ok("###### Happy printing!", False)
+ sys.exit(0)
+
+ def log_upload_menu(self, **kwargs) -> None:
+ LogUploadMenu().run()
+
+ def install_menu(self, **kwargs) -> None:
+ InstallMenu(previous_menu=self.__class__).run()
+
+ def update_menu(self, **kwargs) -> None:
+ UpdateMenu(previous_menu=self.__class__).run()
+
+ def remove_menu(self, **kwargs) -> None:
+ RemoveMenu(previous_menu=self.__class__).run()
+
+ def advanced_menu(self, **kwargs) -> None:
+ AdvancedMenu(previous_menu=self.__class__).run()
+
+ def backup_menu(self, **kwargs) -> None:
+ BackupMenu(previous_menu=self.__class__).run()
+
+ def settings_menu(self, **kwargs) -> None:
+ SettingsMenu(previous_menu=self.__class__).run()
+
+ def extension_menu(self, **kwargs) -> None:
+ ExtensionsMenu(previous_menu=self.__class__).run()
diff --git a/kiauh/core/menus/remove_menu.py b/kiauh/core/menus/remove_menu.py
new file mode 100644
index 0000000..2f18455
--- /dev/null
+++ b/kiauh/core/menus/remove_menu.py
@@ -0,0 +1,102 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Type
+
+from components.crowsnest.crowsnest import remove_crowsnest
+from components.klipper.menus.klipper_remove_menu import KlipperRemoveMenu
+from components.klipperscreen.klipperscreen import remove_klipperscreen
+from components.mobileraker.mobileraker import remove_mobileraker
+from components.moonraker.menus.moonraker_remove_menu import (
+ MoonrakerRemoveMenu,
+)
+from components.octoeverywhere.octoeverywhere_setup import remove_octoeverywhere
+from components.webui_client.fluidd_data import FluiddData
+from components.webui_client.mainsail_data import MainsailData
+from components.webui_client.menus.client_remove_menu import ClientRemoveMenu
+from core.constants import COLOR_RED, RESET_FORMAT
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class RemoveMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from core.menus.main_menu import MainMenu
+
+ self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+ def set_options(self) -> None:
+ self.options = {
+ "1": Option(method=self.remove_klipper),
+ "2": Option(method=self.remove_moonraker),
+ "3": Option(method=self.remove_mainsail),
+ "4": Option(method=self.remove_fluidd),
+ "5": Option(method=self.remove_klipperscreen),
+ "6": Option(method=self.remove_mobileraker),
+ "7": Option(method=self.remove_crowsnest),
+ "8": Option(method=self.remove_octoeverywhere),
+ }
+
+ def print_menu(self) -> None:
+ header = " [ Remove Menu ] "
+ color = COLOR_RED
+ count = 62 - len(color) - len(RESET_FORMAT)
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ INFO: Configurations and/or any backups will be kept! ║
+ ╟───────────────────────────┬───────────────────────────╢
+ ║ Firmware & API: │ Android / iOS: ║
+ ║ 1) [Klipper] │ 6) [Mobileraker] ║
+ ║ 2) [Moonraker] │ ║
+ ║ │ Webcam Streamer: ║
+ ║ Klipper Webinterface: │ 7) [Crowsnest] ║
+ ║ 3) [Mainsail] │ ║
+ ║ 4) [Fluidd] │ Remote Access: ║
+ ║ │ 8) [OctoEverywhere] ║
+ ║ Touchscreen GUI: │ ║
+ ║ 5) [KlipperScreen] │ ║
+ ╟───────────────────────────┴───────────────────────────╢
+ """
+ )[1:]
+ print(menu, end="")
+
+ def remove_klipper(self, **kwargs) -> None:
+ KlipperRemoveMenu(previous_menu=self.__class__).run()
+
+ def remove_moonraker(self, **kwargs) -> None:
+ MoonrakerRemoveMenu(previous_menu=self.__class__).run()
+
+ def remove_mainsail(self, **kwargs) -> None:
+ ClientRemoveMenu(previous_menu=self.__class__, client=MainsailData()).run()
+
+ def remove_fluidd(self, **kwargs) -> None:
+ ClientRemoveMenu(previous_menu=self.__class__, client=FluiddData()).run()
+
+ def remove_klipperscreen(self, **kwargs) -> None:
+ remove_klipperscreen()
+
+ def remove_mobileraker(self, **kwargs) -> None:
+ remove_mobileraker()
+
+ def remove_crowsnest(self, **kwargs) -> None:
+ remove_crowsnest()
+
+ def remove_octoeverywhere(self, **kwargs) -> None:
+ remove_octoeverywhere()
diff --git a/kiauh/core/menus/settings_menu.py b/kiauh/core/menus/settings_menu.py
new file mode 100644
index 0000000..5989d96
--- /dev/null
+++ b/kiauh/core/menus/settings_menu.py
@@ -0,0 +1,209 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import shutil
+import textwrap
+from pathlib import Path
+from typing import Tuple, Type
+
+from components.klipper import KLIPPER_DIR
+from components.klipper.klipper import Klipper
+from components.moonraker import MOONRAKER_DIR
+from components.moonraker.moonraker import Moonraker
+from core.constants import COLOR_CYAN, COLOR_GREEN, RESET_FORMAT
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+from core.settings.kiauh_settings import KiauhSettings
+from utils.git_utils import git_clone_wrapper
+from utils.input_utils import get_confirm, get_string_input
+from utils.instance_utils import get_instances
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class SettingsMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+ self.klipper_repo: str | None = None
+ self.moonraker_repo: str | None = None
+ self.mainsail_unstable: bool | None = None
+ self.fluidd_unstable: bool | None = None
+ self.auto_backups_enabled: bool | None = None
+ self._load_settings()
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from core.menus.main_menu import MainMenu
+
+ self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+ def set_options(self) -> None:
+ self.options = {
+ "1": Option(method=self.set_klipper_repo),
+ "2": Option(method=self.set_moonraker_repo),
+ "3": Option(method=self.toggle_mainsail_release),
+ "4": Option(method=self.toggle_fluidd_release),
+ "5": Option(method=self.toggle_backup_before_update),
+ }
+
+ def print_menu(self) -> None:
+ header = " [ KIAUH Settings ] "
+ color = COLOR_CYAN
+ count = 62 - len(color) - len(RESET_FORMAT)
+ checked = f"[{COLOR_GREEN}x{RESET_FORMAT}]"
+ unchecked = "[ ]"
+ o1 = checked if self.mainsail_unstable else unchecked
+ o2 = checked if self.fluidd_unstable else unchecked
+ o3 = checked if self.auto_backups_enabled else unchecked
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ Klipper source repository: ║
+ ║ ● {self.klipper_repo:<67} ║
+ ║ ║
+ ║ Moonraker source repository: ║
+ ║ ● {self.moonraker_repo:<67} ║
+ ║ ║
+ ║ Install unstable Webinterface releases: ║
+ ║ {o1} Mainsail ║
+ ║ {o2} Fluidd ║
+ ║ ║
+ ║ Auto-Backup: ║
+ ║ {o3} Automatic backup before update ║
+ ║ ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ 1) Set Klipper source repository ║
+ ║ 2) Set Moonraker source repository ║
+ ║ ║
+ ║ 3) Toggle unstable Mainsail releases ║
+ ║ 4) Toggle unstable Fluidd releases ║
+ ║ ║
+ ║ 5) Toggle automatic backups before updates ║
+ ╟───────────────────────────────────────────────────────╢
+ """
+ )[1:]
+ print(menu, end="")
+
+ def _load_settings(self) -> None:
+ self.settings = KiauhSettings()
+
+ self._format_repo_str("klipper")
+ self._format_repo_str("moonraker")
+
+ self.auto_backups_enabled = self.settings.kiauh.backup_before_update
+ self.mainsail_unstable = self.settings.mainsail.unstable_releases
+ self.fluidd_unstable = self.settings.fluidd.unstable_releases
+
+ def _format_repo_str(self, repo_name: str) -> None:
+ repo = self.settings.get(repo_name, "repo_url")
+ repo = f"{'/'.join(repo.rsplit('/', 2)[-2:])}"
+ branch = self.settings.get(repo_name, "branch")
+ branch = f"({COLOR_CYAN}@ {branch}{RESET_FORMAT})"
+ setattr(self, f"{repo_name}_repo", f"{COLOR_CYAN}{repo}{RESET_FORMAT} {branch}")
+
+ def _gather_input(self) -> Tuple[str, str]:
+ Logger.print_dialog(
+ DialogType.ATTENTION,
+ [
+ "There is no input validation in place! Make sure your"
+ " input is valid and has no typos! For any change to"
+ " take effect, the repository must be cloned again. "
+ "Make sure you don't have any ongoing prints running, "
+ "as the services will be restarted!"
+ ],
+ )
+ repo = get_string_input(
+ "Enter new repository URL",
+ allow_special_chars=True,
+ )
+ branch = get_string_input(
+ "Enter new branch name",
+ allow_special_chars=True,
+ )
+
+ return repo, branch
+
+ def _set_repo(self, repo_name: str) -> None:
+ repo_url, branch = self._gather_input()
+ display_name = repo_name.capitalize()
+ Logger.print_dialog(
+ DialogType.CUSTOM,
+ [
+ f"New {display_name} repository URL:",
+ f"● {repo_url}",
+ f"New {display_name} repository branch:",
+ f"● {branch}",
+ ],
+ )
+
+ if get_confirm("Apply changes?", allow_go_back=True):
+ self.settings.set(repo_name, "repo_url", repo_url)
+ self.settings.set(repo_name, "branch", branch)
+ self.settings.save()
+ self._load_settings()
+ Logger.print_ok("Changes saved!")
+ else:
+ Logger.print_info(
+ f"Skipping change of {display_name} source repository ..."
+ )
+ return
+
+ Logger.print_status(f"Switching to {display_name}'s new source repository ...")
+ self._switch_repo(repo_name)
+ Logger.print_ok(f"Switched to {repo_url} at branch {branch}!")
+
+ def _switch_repo(self, name: str) -> None:
+ target_dir: Path
+ if name == "klipper":
+ target_dir = KLIPPER_DIR
+ _type = Klipper
+ elif name == "moonraker":
+ target_dir = MOONRAKER_DIR
+ _type = Moonraker
+ else:
+ Logger.print_error("Invalid repository name!")
+ return
+
+ if target_dir.exists():
+ shutil.rmtree(target_dir)
+
+ instances = get_instances(_type)
+ InstanceManager.stop_all(instances)
+
+ repo = self.settings.get(name, "repo_url")
+ branch = self.settings.get(name, "branch")
+ git_clone_wrapper(repo, target_dir, branch)
+
+ InstanceManager.start_all(instances)
+
+ def set_klipper_repo(self, **kwargs) -> None:
+ self._set_repo("klipper")
+
+ def set_moonraker_repo(self, **kwargs) -> None:
+ self._set_repo("moonraker")
+
+ def toggle_mainsail_release(self, **kwargs) -> None:
+ self.mainsail_unstable = not self.mainsail_unstable
+ self.settings.mainsail.unstable_releases = self.mainsail_unstable
+ self.settings.save()
+
+ def toggle_fluidd_release(self, **kwargs) -> None:
+ self.fluidd_unstable = not self.fluidd_unstable
+ self.settings.fluidd.unstable_releases = self.fluidd_unstable
+ self.settings.save()
+
+ def toggle_backup_before_update(self, **kwargs) -> None:
+ self.auto_backups_enabled = not self.auto_backups_enabled
+ self.settings.kiauh.backup_before_update = self.auto_backups_enabled
+ self.settings.save()
diff --git a/kiauh/core/menus/update_menu.py b/kiauh/core/menus/update_menu.py
new file mode 100644
index 0000000..daa6b21
--- /dev/null
+++ b/kiauh/core/menus/update_menu.py
@@ -0,0 +1,291 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import textwrap
+from typing import Callable, List, Type
+
+from components.crowsnest.crowsnest import get_crowsnest_status, update_crowsnest
+from components.klipper.klipper_setup import update_klipper
+from components.klipper.klipper_utils import (
+ get_klipper_status,
+)
+from components.klipperscreen.klipperscreen import (
+ get_klipperscreen_status,
+ update_klipperscreen,
+)
+from components.mobileraker.mobileraker import (
+ get_mobileraker_status,
+ update_mobileraker,
+)
+from components.moonraker.moonraker_setup import update_moonraker
+from components.moonraker.moonraker_utils import get_moonraker_status
+from components.octoeverywhere.octoeverywhere_setup import (
+ get_octoeverywhere_status,
+ update_octoeverywhere,
+)
+from components.webui_client.client_config.client_config_setup import (
+ update_client_config,
+)
+from components.webui_client.client_setup import update_client
+from components.webui_client.client_utils import (
+ get_client_config_status,
+ get_client_status,
+)
+from components.webui_client.fluidd_data import FluiddData
+from components.webui_client.mainsail_data import MainsailData
+from core.constants import (
+ COLOR_GREEN,
+ COLOR_RED,
+ COLOR_YELLOW,
+ RESET_FORMAT,
+)
+from core.logger import DialogType, Logger
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+from core.spinner import Spinner
+from core.types import ComponentStatus
+from utils.input_utils import get_confirm
+from utils.sys_utils import (
+ get_upgradable_packages,
+ update_system_package_lists,
+ upgrade_system_packages,
+)
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class UpdateMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+ self.packages: List[str] = []
+ self.package_count: int = 0
+
+ self.klipper_local = self.klipper_remote = ""
+ self.moonraker_local = self.moonraker_remote = ""
+ self.mainsail_local = self.mainsail_remote = ""
+ self.mainsail_config_local = self.mainsail_config_remote = ""
+ self.fluidd_local = self.fluidd_remote = ""
+ self.fluidd_config_local = self.fluidd_config_remote = ""
+ self.klipperscreen_local = self.klipperscreen_remote = ""
+ self.mobileraker_local = self.mobileraker_remote = ""
+ self.crowsnest_local = self.crowsnest_remote = ""
+ self.octoeverywhere_local = self.octoeverywhere_remote = ""
+
+ self.mainsail_data = MainsailData()
+ self.fluidd_data = FluiddData()
+ self.status_data = {
+ "klipper": {"installed": False, "local": None, "remote": None},
+ "moonraker": {"installed": False, "local": None, "remote": None},
+ "mainsail": {"installed": False, "local": None, "remote": None},
+ "mainsail_config": {"installed": False, "local": None, "remote": None},
+ "fluidd": {"installed": False, "local": None, "remote": None},
+ "fluidd_config": {"installed": False, "local": None, "remote": None},
+ "mobileraker": {"installed": False, "local": None, "remote": None},
+ "klipperscreen": {"installed": False, "local": None, "remote": None},
+ "crowsnest": {"installed": False, "local": None, "remote": None},
+ "octoeverywhere": {"installed": False, "local": None, "remote": None},
+ }
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from core.menus.main_menu import MainMenu
+
+ self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+ def set_options(self) -> None:
+ self.options = {
+ "a": Option(self.update_all),
+ "1": Option(self.update_klipper),
+ "2": Option(self.update_moonraker),
+ "3": Option(self.update_mainsail),
+ "4": Option(self.update_fluidd),
+ "5": Option(self.update_mainsail_config),
+ "6": Option(self.update_fluidd_config),
+ "7": Option(self.update_klipperscreen),
+ "8": Option(self.update_mobileraker),
+ "9": Option(self.update_crowsnest),
+ "10": Option(self.update_octoeverywhere),
+ "11": Option(self.upgrade_system_packages),
+ }
+
+ def print_menu(self) -> None:
+ spinner = Spinner("Loading update menu, please wait", color="green")
+ spinner.start()
+
+ self._fetch_update_status()
+
+ spinner.stop()
+
+ header = " [ Update Menu ] "
+ color = COLOR_GREEN
+ count = 62 - len(color) - len(RESET_FORMAT)
+
+ sysupgrades: str = "No upgrades available."
+ padding = 29
+ if self.package_count > 0:
+ sysupgrades = (
+ f"{COLOR_GREEN}{self.package_count} upgrades available!{RESET_FORMAT}"
+ )
+ padding = 38
+
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────┬───────────────┬───────────────╢
+ ║ a) Update all │ │ ║
+ ║ │ Current: │ Latest: ║
+ ║ Klipper & API: ├───────────────┼───────────────╢
+ ║ 1) Klipper │ {self.klipper_local:<22} │ {self.klipper_remote:<22} ║
+ ║ 2) Moonraker │ {self.moonraker_local:<22} │ {self.moonraker_remote:<22} ║
+ ║ │ │ ║
+ ║ Webinterface: ├───────────────┼───────────────╢
+ ║ 3) Mainsail │ {self.mainsail_local:<22} │ {self.mainsail_remote:<22} ║
+ ║ 4) Fluidd │ {self.fluidd_local:<22} │ {self.fluidd_remote:<22} ║
+ ║ │ │ ║
+ ║ Client-Config: ├───────────────┼───────────────╢
+ ║ 5) Mainsail-Config │ {self.mainsail_config_local:<22} │ {self.mainsail_config_remote:<22} ║
+ ║ 6) Fluidd-Config │ {self.fluidd_config_local:<22} │ {self.fluidd_config_remote:<22} ║
+ ║ │ │ ║
+ ║ Other: ├───────────────┼───────────────╢
+ ║ 7) KlipperScreen │ {self.klipperscreen_local:<22} │ {self.klipperscreen_remote:<22} ║
+ ║ 8) Mobileraker │ {self.mobileraker_local:<22} │ {self.mobileraker_remote:<22} ║
+ ║ 9) Crowsnest │ {self.crowsnest_local:<22} │ {self.crowsnest_remote:<22} ║
+ ║ 10) OctoEverywhere │ {self.octoeverywhere_local:<22} │ {self.octoeverywhere_remote:<22} ║
+ ║ ├───────────────┴───────────────╢
+ ║ 11) System │ {sysupgrades:^{padding}} ║
+ ╟───────────────────────┴───────────────────────────────╢
+ """
+ )[1:]
+ print(menu, end="")
+
+ def update_all(self, **kwargs) -> None:
+ print("update_all")
+
+ def update_klipper(self, **kwargs) -> None:
+ if self._check_is_installed("klipper"):
+ update_klipper()
+
+ def update_moonraker(self, **kwargs) -> None:
+ if self._check_is_installed("moonraker"):
+ update_moonraker()
+
+ def update_mainsail(self, **kwargs) -> None:
+ if self._check_is_installed("mainsail"):
+ update_client(self.mainsail_data)
+
+ def update_mainsail_config(self, **kwargs) -> None:
+ if self._check_is_installed("mainsail_config"):
+ update_client_config(self.mainsail_data)
+
+ def update_fluidd(self, **kwargs) -> None:
+ if self._check_is_installed("fluidd"):
+ update_client(self.fluidd_data)
+
+ def update_fluidd_config(self, **kwargs) -> None:
+ if self._check_is_installed("fluidd_config"):
+ update_client_config(self.fluidd_data)
+
+ def update_klipperscreen(self, **kwargs) -> None:
+ if self._check_is_installed("klipperscreen"):
+ update_klipperscreen()
+
+ def update_mobileraker(self, **kwargs) -> None:
+ if self._check_is_installed("mobileraker"):
+ update_mobileraker()
+
+ def update_crowsnest(self, **kwargs) -> None:
+ if self._check_is_installed("crowsnest"):
+ update_crowsnest()
+
+ def update_octoeverywhere(self, **kwargs) -> None:
+ if self._check_is_installed("octoeverywhere"):
+ update_octoeverywhere()
+
+ def upgrade_system_packages(self, **kwargs) -> None:
+ self._run_system_updates()
+
+ def _fetch_update_status(self) -> None:
+ self._set_status_data("klipper", get_klipper_status)
+ self._set_status_data("moonraker", get_moonraker_status)
+ self._set_status_data("mainsail", get_client_status, self.mainsail_data, True)
+ self._set_status_data(
+ "mainsail_config", get_client_config_status, self.mainsail_data
+ )
+ self._set_status_data("fluidd", get_client_status, self.fluidd_data, True)
+ self._set_status_data(
+ "fluidd_config", get_client_config_status, self.fluidd_data
+ )
+ self._set_status_data("klipperscreen", get_klipperscreen_status)
+ self._set_status_data("mobileraker", get_mobileraker_status)
+ self._set_status_data("crowsnest", get_crowsnest_status)
+ self._set_status_data("octoeverywhere", get_octoeverywhere_status)
+
+ update_system_package_lists(silent=True)
+ self.packages = get_upgradable_packages()
+ self.package_count = len(self.packages)
+
+ def _format_local_status(self, local_version, remote_version) -> str:
+ color = COLOR_RED
+ if not local_version:
+ color = COLOR_RED
+ elif local_version == remote_version:
+ color = COLOR_GREEN
+ elif local_version != remote_version:
+ color = COLOR_YELLOW
+
+ return f"{color}{local_version or '-'}{RESET_FORMAT}"
+
+ def _set_status_data(self, name: str, status_fn: Callable, *args) -> None:
+ comp_status: ComponentStatus = status_fn(*args)
+
+ self.status_data[name]["installed"] = True if comp_status.status == 2 else False
+ self.status_data[name]["local"] = comp_status.local
+ self.status_data[name]["remote"] = comp_status.remote
+
+ self._set_status_string(name)
+
+ def _set_status_string(self, name: str) -> None:
+ local_status = self.status_data[name].get("local", None)
+ remote_status = self.status_data[name].get("remote", None)
+
+ color = COLOR_GREEN if remote_status else COLOR_RED
+ local_txt = self._format_local_status(local_status, remote_status)
+ remote_txt = f"{color}{remote_status or '-'}{RESET_FORMAT}"
+
+ setattr(self, f"{name}_local", local_txt)
+ setattr(self, f"{name}_remote", remote_txt)
+
+ def _check_is_installed(self, name: str) -> bool:
+ if not self.status_data[name]["installed"]:
+ Logger.print_info(f"{name.capitalize()} is not installed! Skipped ...")
+ return False
+ return True
+
+ def _run_system_updates(self) -> None:
+ if not self.packages:
+ Logger.print_info("No system upgrades available!")
+ return
+
+ try:
+ pkgs: str = ", ".join(self.packages)
+ Logger.print_dialog(
+ DialogType.CUSTOM,
+ ["The following packages will be upgraded:", "\n\n", pkgs],
+ custom_title="UPGRADABLE SYSTEM UPDATES",
+ )
+ if not get_confirm("Continue?"):
+ return
+ Logger.print_status("Upgrading system packages ...")
+ upgrade_system_packages(self.packages)
+ except Exception as e:
+ Logger.print_error(f"Error upgrading system packages:\n{e}")
+ raise
diff --git a/kiauh/core/settings/__init__.py b/kiauh/core/settings/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/kiauh/core/settings/kiauh_settings.py b/kiauh/core/settings/kiauh_settings.py
new file mode 100644
index 0000000..2fad91d
--- /dev/null
+++ b/kiauh/core/settings/kiauh_settings.py
@@ -0,0 +1,222 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+from core.logger import DialogType, Logger
+from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+ NoOptionError,
+ NoSectionError,
+ SimpleConfigParser,
+)
+from utils.sys_utils import kill
+
+from kiauh import PROJECT_ROOT
+
+DEFAULT_CFG = PROJECT_ROOT.joinpath("default.kiauh.cfg")
+CUSTOM_CFG = PROJECT_ROOT.joinpath("kiauh.cfg")
+
+
+class AppSettings:
+ def __init__(self) -> None:
+ self.backup_before_update = None
+
+
+class KlipperSettings:
+ def __init__(self) -> None:
+ self.repo_url = None
+ self.branch = None
+
+
+class MoonrakerSettings:
+ def __init__(self) -> None:
+ self.repo_url = None
+ self.branch = None
+
+
+class MainsailSettings:
+ def __init__(self) -> None:
+ self.port = None
+ self.unstable_releases = None
+
+
+class FluiddSettings:
+ def __init__(self) -> None:
+ self.port = None
+ self.unstable_releases = None
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class KiauhSettings:
+ _instance = None
+
+ def __new__(cls, *args, **kwargs) -> "KiauhSettings":
+ if cls._instance is None:
+ cls._instance = super(KiauhSettings, cls).__new__(cls, *args, **kwargs)
+ return cls._instance
+
+ def __init__(self) -> None:
+ if not hasattr(self, "__initialized"):
+ self.__initialized = False
+ if self.__initialized:
+ return
+ self.__initialized = True
+ self.config = SimpleConfigParser()
+ self.kiauh = AppSettings()
+ self.klipper = KlipperSettings()
+ self.moonraker = MoonrakerSettings()
+ self.mainsail = MainsailSettings()
+ self.fluidd = FluiddSettings()
+
+ self.kiauh.backup_before_update = None
+ self.klipper.repo_url = None
+ self.klipper.branch = None
+ self.moonraker.repo_url = None
+ self.moonraker.branch = None
+ self.mainsail.port = None
+ self.mainsail.unstable_releases = None
+ self.fluidd.port = None
+ self.fluidd.unstable_releases = None
+
+ self._load_config()
+
+ def get(self, section: str, option: str) -> str | int | bool:
+ """
+ Get a value from the settings state by providing the section and option name as strings.
+ Prefer direct access to the properties, as it is usually safer!
+ :param section: The section name as string.
+ :param option: The option name as string.
+ :return: The value of the option as string, int or bool.
+ """
+
+ try:
+ section = getattr(self, section)
+ value = getattr(section, option)
+ return value # type: ignore
+ except AttributeError:
+ raise
+
+ def set(self, section: str, option: str, value: str | int | bool) -> None:
+ """
+ Set a value in the settings state by providing the section and option name as strings.
+ Prefer direct access to the properties, as it is usually safer!
+ :param section: The section name as string.
+ :param option: The option name as string.
+ :param value: The value to set as string, int or bool.
+ """
+ try:
+ section = getattr(self, section)
+ section.option = value # type: ignore
+ except AttributeError:
+ raise
+
+ def save(self) -> None:
+ self._set_config_options()
+ self.config.write(CUSTOM_CFG)
+ self._load_config()
+
+ def _load_config(self) -> None:
+ if not CUSTOM_CFG.exists() and not DEFAULT_CFG.exists():
+ self._kill()
+
+ cfg = CUSTOM_CFG if CUSTOM_CFG.exists() else DEFAULT_CFG
+ self.config.read(cfg)
+
+ self._validate_cfg()
+ self._read_settings()
+
+ def _validate_cfg(self) -> None:
+ try:
+ self._validate_bool("kiauh", "backup_before_update")
+
+ self._validate_str("klipper", "repo_url")
+ self._validate_str("klipper", "branch")
+
+ self._validate_int("mainsail", "port")
+ self._validate_bool("mainsail", "unstable_releases")
+
+ self._validate_int("fluidd", "port")
+ self._validate_bool("fluidd", "unstable_releases")
+
+ except ValueError:
+ err = f"Invalid value for option '{self._v_option}' in section '{self._v_section}'"
+ Logger.print_error(err)
+ kill()
+ except NoSectionError:
+ err = f"Missing section '{self._v_section}' in config file"
+ Logger.print_error(err)
+ kill()
+ except NoOptionError:
+ err = f"Missing option '{self._v_option}' in section '{self._v_section}'"
+ Logger.print_error(err)
+ kill()
+
+ def _validate_bool(self, section: str, option: str) -> None:
+ self._v_section, self._v_option = (section, option)
+ bool(self.config.getboolean(section, option))
+
+ def _validate_int(self, section: str, option: str) -> None:
+ self._v_section, self._v_option = (section, option)
+ int(self.config.getint(section, option))
+
+ def _validate_str(self, section: str, option: str) -> None:
+ self._v_section, self._v_option = (section, option)
+ v = self.config.get(section, option)
+ if v.isdigit() or v.lower() == "true" or v.lower() == "false":
+ raise ValueError
+
+ def _read_settings(self) -> None:
+ self.kiauh.backup_before_update = self.config.getboolean(
+ "kiauh", "backup_before_update"
+ )
+ self.klipper.repo_url = self.config.get("klipper", "repo_url")
+ self.klipper.branch = self.config.get("klipper", "branch")
+ self.moonraker.repo_url = self.config.get("moonraker", "repo_url")
+ self.moonraker.branch = self.config.get("moonraker", "branch")
+ self.mainsail.port = self.config.getint("mainsail", "port")
+ self.mainsail.unstable_releases = self.config.getboolean(
+ "mainsail", "unstable_releases"
+ )
+ self.fluidd.port = self.config.getint("fluidd", "port")
+ self.fluidd.unstable_releases = self.config.getboolean(
+ "fluidd", "unstable_releases"
+ )
+
+ def _set_config_options(self) -> None:
+ self.config.set(
+ "kiauh",
+ "backup_before_update",
+ str(self.kiauh.backup_before_update),
+ )
+ self.config.set("klipper", "repo_url", self.klipper.repo_url)
+ self.config.set("klipper", "branch", self.klipper.branch)
+ self.config.set("moonraker", "repo_url", self.moonraker.repo_url)
+ self.config.set("moonraker", "branch", self.moonraker.branch)
+ self.config.set("mainsail", "port", str(self.mainsail.port))
+ self.config.set(
+ "mainsail",
+ "unstable_releases",
+ str(self.mainsail.unstable_releases),
+ )
+ self.config.set("fluidd", "port", str(self.fluidd.port))
+ self.config.set(
+ "fluidd", "unstable_releases", str(self.fluidd.unstable_releases)
+ )
+
+ def _kill(self) -> None:
+ Logger.print_dialog(
+ DialogType.ERROR,
+ [
+ "No KIAUH configuration file found! Please make sure you have at least "
+ "one of the following configuration files in KIAUH's root directory:",
+ "● default.kiauh.cfg",
+ "● kiauh.cfg",
+ ],
+ )
+ kill()
diff --git a/kiauh/core/spinner.py b/kiauh/core/spinner.py
new file mode 100644
index 0000000..55da0f1
--- /dev/null
+++ b/kiauh/core/spinner.py
@@ -0,0 +1,61 @@
+import sys
+import threading
+import time
+from typing import List, Literal
+
+from core.constants import (
+ COLOR_GREEN,
+ COLOR_RED,
+ COLOR_WHITE,
+ COLOR_YELLOW,
+ RESET_FORMAT,
+)
+
+SpinnerColor = Literal["white", "red", "green", "yellow"]
+
+
+class Spinner:
+ def __init__(
+ self,
+ message: str = "Loading",
+ color: SpinnerColor = "white",
+ interval: float = 0.2,
+ ) -> None:
+ self.message = f"{message} ..."
+ self.interval = interval
+ self._stop_event = threading.Event()
+ self._thread = threading.Thread(target=self._animate)
+ self._color = ""
+ self._set_color(color)
+
+ def _animate(self) -> None:
+ animation: List[str] = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]
+ while not self._stop_event.is_set():
+ for char in animation:
+ sys.stdout.write(f"\r{self._color}{char}{RESET_FORMAT} {self.message}")
+ sys.stdout.flush()
+ time.sleep(self.interval)
+ if self._stop_event.is_set():
+ break
+ sys.stdout.write("\r" + " " * (len(self.message) + 1) + "\r")
+ sys.stdout.flush()
+
+ def _set_color(self, color: SpinnerColor) -> None:
+ if color == "white":
+ self._color = COLOR_WHITE
+ elif color == "red":
+ self._color = COLOR_RED
+ elif color == "green":
+ self._color = COLOR_GREEN
+ elif color == "yellow":
+ self._color = COLOR_YELLOW
+
+ def start(self) -> None:
+ self._stop_event.clear()
+ if not self._thread.is_alive():
+ self._thread = threading.Thread(target=self._animate)
+ self._thread.start()
+
+ def stop(self) -> None:
+ self._stop_event.set()
+ self._thread.join()
diff --git a/kiauh/core/submodules/__init__.py b/kiauh/core/submodules/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/kiauh/core/submodules/simple_config_parser/.editorconfig b/kiauh/core/submodules/simple_config_parser/.editorconfig
new file mode 100644
index 0000000..2546a60
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/.editorconfig
@@ -0,0 +1,13 @@
+# see https://editorconfig.org/
+root = true
+
+[*]
+end_of_line = lf
+trim_trailing_whitespace = true
+indent_style = space
+insert_final_newline = true
+indent_size = 4
+charset = utf-8
+
+[*.py]
+max_line_length = 88
diff --git a/kiauh/core/submodules/simple_config_parser/.gitignore b/kiauh/core/submodules/simple_config_parser/.gitignore
new file mode 100644
index 0000000..a5d5089
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/.gitignore
@@ -0,0 +1,13 @@
+*.py[cod]
+*.pyc
+__pycache__
+.pytest_cache/
+
+.idea/
+.vscode/
+
+.venv*/
+venv*/
+
+.coverage
+htmlcov/
diff --git a/kiauh/core/submodules/simple_config_parser/LICENSE b/kiauh/core/submodules/simple_config_parser/LICENSE
new file mode 100644
index 0000000..f288702
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+
+ Copyright (C)
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C)
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
diff --git a/kiauh/core/submodules/simple_config_parser/README.md b/kiauh/core/submodules/simple_config_parser/README.md
new file mode 100644
index 0000000..dda49fa
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/README.md
@@ -0,0 +1,6 @@
+# Simple Config Parser
+
+A custom config parser inspired by Python's configparser module.
+Specialized for handling Klipper style config files.
+
+
diff --git a/kiauh/core/submodules/simple_config_parser/pyproject.toml b/kiauh/core/submodules/simple_config_parser/pyproject.toml
new file mode 100644
index 0000000..a3bca47
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/pyproject.toml
@@ -0,0 +1,66 @@
+[project]
+name = "simple-config-parser"
+version = "0.0.1"
+description = "A simple config parser for Python"
+authors = [
+ {name = "Dominik Willner", email = "th33xitus@gmail.com"},
+]
+readme = "README.md"
+license = {text = "GPL-3.0-only"}
+requires-python = ">=3.8"
+
+[project.urls]
+homepage = "https://github.com/dw-0/simple-config-parser"
+repository = "https://github.com/dw-0/simple-config-parser"
+documentation = "https://github.com/dw-0/simple-config-parser"
+
+[project.optional-dependencies]
+dev=["ruff"]
+
+[tool.ruff]
+required-version = ">=0.3.4"
+respect-gitignore = true
+exclude = [".git",".github", "./docs"]
+line-length = 88
+indent-width = 4
+output-format = "full"
+
+[tool.ruff.format]
+indent-style = "space"
+line-ending = "lf"
+quote-style = "double"
+
+[tool.ruff.lint]
+extend-select = ["I"]
+
+[tool.pytest.ini_options]
+minversion = "8.2.1"
+testpaths = ["tests/**/*.py"]
+addopts = "--cov --cov-config=pyproject.toml --cov-report=html"
+
+[tool.coverage.run]
+branch = true
+source = ["src.simple_config_parser"]
+
+[tool.coverage.report]
+# Regexes for lines to exclude from consideration
+exclude_also = [
+ # Don't complain about missing debug-only code:
+ "def __repr__",
+ "if self\\.debug",
+
+ # Don't complain if tests don't hit defensive assertion code:
+ "raise AssertionError",
+ "raise NotImplementedError",
+
+ # Don't complain if non-runnable code isn't run:
+ "if 0:",
+ "if __name__ == .__main__.:",
+
+ # Don't complain about abstract methods, they aren't run:
+ "@(abc\\.)?abstractmethod",
+ ]
+
+[tool.coverage.html]
+title = "SimpleConfigParser Coverage Report"
+directory = "htmlcov"
diff --git a/kiauh/core/submodules/simple_config_parser/requirements-dev.txt b/kiauh/core/submodules/simple_config_parser/requirements-dev.txt
new file mode 100644
index 0000000..7e73e5f
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/requirements-dev.txt
@@ -0,0 +1,3 @@
+ruff >= 0.3.4
+pytest >= 8.2.1
+pytest-cov >= 5.0.0
diff --git a/kiauh/core/submodules/simple_config_parser/src/simple_config_parser/__init__.py b/kiauh/core/submodules/simple_config_parser/src/simple_config_parser/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/kiauh/core/submodules/simple_config_parser/src/simple_config_parser/simple_config_parser.py b/kiauh/core/submodules/simple_config_parser/src/simple_config_parser/simple_config_parser.py
new file mode 100644
index 0000000..b3f10c6
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/src/simple_config_parser/simple_config_parser.py
@@ -0,0 +1,552 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# https://github.com/dw-0/simple-config-parser #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+
+from __future__ import annotations
+
+import re
+from pathlib import Path
+from typing import Callable, Dict, List, Match, Tuple, TypedDict
+
+_UNSET = object()
+
+
+class Section(TypedDict):
+ """
+ A single section in the config file
+
+ - _raw: The raw representation of the section name
+ - options: A list of options in the section
+ """
+
+ _raw: str
+ options: List[Option]
+
+
+class Option(TypedDict, total=False):
+ """
+ A single option in a section in the config file
+
+ - is_multiline: Whether the option is a multiline option
+ - option: The name of the option
+ - value: The value of the option
+ - _raw: The raw representation of the option
+ - _raw_value: The raw value of the option
+
+ A multinline option is an option that contains multiple lines of text following
+ the option name in the next line. The value of a multiline option is a list of
+ strings, where each string represents a single line of text.
+ """
+
+ is_multiline: bool
+ option: str
+ value: str | List[str]
+ _raw: str
+ _raw_value: str | List[str]
+
+
+class NoSectionError(Exception):
+ """Raised when a section is not defined"""
+
+ def __init__(self, section: str):
+ msg = f"Section '{section}' is not defined"
+ super().__init__(msg)
+
+
+class NoOptionError(Exception):
+ """Raised when an option is not defined in a section"""
+
+ def __init__(self, option: str, section: str):
+ msg = f"Option '{option}' in section '{section}' is not defined"
+ super().__init__(msg)
+
+
+class DuplicateSectionError(Exception):
+ """Raised when a section is defined more than once"""
+
+ def __init__(self, section: str):
+ msg = f"Section '{section}' is defined more than once"
+ super().__init__(msg)
+
+
+class DuplicateOptionError(Exception):
+ """Raised when an option is defined more than once"""
+
+ def __init__(self, option: str, section: str):
+ msg = f"Option '{option}' in section '{section}' is defined more than once"
+ super().__init__(msg)
+
+
+# noinspection PyMethodMayBeStatic
+class SimpleConfigParser:
+ """A customized config parser targeted at handling Klipper style config files"""
+
+ _SECTION_RE = re.compile(r"\s*\[(\w+\s?.+)]\s*([#;].*)?$")
+ _OPTION_RE = re.compile(r"^\s*(\w+)\s*[:=]\s*([^=:].*)\s*([#;].*)?$")
+ _MLOPTION_RE = re.compile(r"^\s*(\w+)\s*[:=]\s*([#;].*)?$")
+ _COMMENT_RE = re.compile(r"^\s*([#;].*)?$")
+ _EMPTY_LINE_RE = re.compile(r"^\s*$")
+
+ BOOLEAN_STATES = {
+ "1": True,
+ "yes": True,
+ "true": True,
+ "on": True,
+ "0": False,
+ "no": False,
+ "false": False,
+ "off": False,
+ }
+
+ def __init__(self):
+ self._config: Dict = {}
+ self._header: List[str] = []
+ self._all_sections: List[str] = []
+ self._all_options: Dict = {}
+ self.section_name: str = ""
+ self.in_option_block: bool = False # whether we are in a multiline option block
+
+ def read(self, file: Path) -> None:
+ """
+ Read the given file and store the result in the internal state.
+ Call this method before using any other methods. Calling this method
+ multiple times will reset the internal state on each call.
+ """
+
+ self._reset_state()
+
+ try:
+ with open(file, "r") as f:
+ self._parse_config(f.readlines())
+
+ except OSError:
+ raise
+
+ def _reset_state(self):
+ """Reset the internal state."""
+
+ self._config.clear()
+ self._header.clear()
+ self._all_sections.clear()
+ self._all_options.clear()
+ self.section_name = ""
+ self.in_option_block = False
+
+ def write(self, filename):
+ """Write the internal state to the given file"""
+
+ content = self._construct_content()
+
+ with open(filename, "w") as f:
+ f.write(content)
+
+ def _construct_content(self) -> str:
+ """
+ Constructs the content of the configuration file based on the internal state of
+ the _config object by iterating over the sections and their options. It starts
+ by checking if a header is present and extends the content list with its elements.
+ Then, for each section, it appends the raw representation of the section to the
+ content list. If the section has a body, it iterates over its options and extends
+ the content list with their raw representations. If an option is multiline, it
+ also extends the content list with its raw value. Finally, the content list is
+ joined into a single string and returned.
+
+ :return: The content of the configuration file as a string
+ """
+ content: List[str] = []
+ if self._header is not None:
+ content.extend(self._header)
+ for section in self._config:
+ content.append(self._config[section]["_raw"])
+
+ if (sec_body := self._config[section].get("body")) is not None:
+ for option in sec_body:
+ content.extend(option["_raw"])
+ if option["is_multiline"]:
+ content.extend(option["_raw_value"])
+ content: str = "".join(content)
+
+ return content
+
+ def sections(self) -> List[str]:
+ """Return a list of section names"""
+
+ return self._all_sections
+
+ def add_section(self, section: str) -> None:
+ """Add a new section to the internal state"""
+
+ if section in self._all_sections:
+ raise DuplicateSectionError(section)
+ self._all_sections.append(section)
+ self._all_options[section] = {}
+ self._config[section] = {"_raw": f"\n[{section}]\n", "body": []}
+
+ def remove_section(self, section: str) -> None:
+ """Remove the given section"""
+
+ if section not in self._all_sections:
+ raise NoSectionError(section)
+
+ self._all_sections.pop(self._all_sections.index(section))
+ self._all_options.pop(section)
+ self._config.pop(section)
+
+ def options(self, section) -> List[str]:
+ """Return a list of option names for the given section name"""
+
+ return self._all_options.get(section)
+
+ def get(
+ self, section: str, option: str, fallback: str | _UNSET = _UNSET
+ ) -> str | List[str]:
+ """
+ Return the value of the given option in the given section
+
+ If the key is not found and 'fallback' is provided, it is used as
+ a fallback value.
+ """
+
+ try:
+ if section not in self._all_sections:
+ raise NoSectionError(section)
+
+ if option not in self._all_options.get(section):
+ raise NoOptionError(option, section)
+
+ return self._all_options[section][option]
+ except (NoSectionError, NoOptionError):
+ if fallback is _UNSET:
+ raise
+ return fallback
+
+ def getint(self, section: str, option: str, fallback: int | _UNSET = _UNSET) -> int:
+ """Return the value of the given option in the given section as an int"""
+
+ return self._get_conv(section, option, int, fallback=fallback)
+
+ def getfloat(
+ self, section: str, option: str, fallback: float | _UNSET = _UNSET
+ ) -> float:
+ return self._get_conv(section, option, float, fallback=fallback)
+
+ def getboolean(
+ self, section: str, option: str, fallback: bool | _UNSET = _UNSET
+ ) -> bool:
+ return self._get_conv(
+ section, option, self._convert_to_boolean, fallback=fallback
+ )
+
+ def _convert_to_boolean(self, value) -> bool:
+ if value.lower() not in self.BOOLEAN_STATES:
+ raise ValueError("Not a boolean: %s" % value)
+ return self.BOOLEAN_STATES[value.lower()]
+
+ def _get_conv(
+ self,
+ section: str,
+ option: str,
+ conv: Callable[[str], int | float | bool],
+ fallback: _UNSET = _UNSET,
+ ) -> int | float | bool:
+ try:
+ return conv(self.get(section, option, fallback))
+ except:
+ if fallback is not _UNSET:
+ return fallback
+ raise
+
+ def items(self, section: str) -> List[Tuple[str, str]]:
+ """Return a list of (option, value) tuples for a specific section"""
+
+ if section not in self._all_sections:
+ raise NoSectionError(section)
+
+ result = []
+ for _option in self._all_options[section]:
+ result.append((_option, self._all_options[section][_option]))
+
+ return result
+
+ def set(
+ self,
+ section: str,
+ option: str,
+ value: str,
+ multiline: bool = False,
+ indent: int = 4,
+ ) -> None:
+ """Set the given option to the given value in the given section
+
+ If the option is already defined, it will be overwritten. If the option
+ is not defined yet, it will be added to the section body.
+
+ The multiline parameter can be used to specify whether the value is
+ multiline or not. If it is not specified, the value will be considered
+ as multiline if it contains a newline character. The value will then be split
+ into multiple lines. If the value does not contain a newline character, it
+ will be considered as a single line value. The indent parameter can be used
+ to specify the indentation of the multiline value. Indentations are with spaces.
+
+ :param section: The section to set the option in
+ :param option: The option to set
+ :param value: The value to set
+ :param multiline: Whether the value is multiline or not
+ :param indent: The indentation for multiline values
+ """
+
+ if section not in self._all_sections:
+ raise NoSectionError(section)
+
+ # prepare the options value and raw value depending on the multiline flag
+ _raw_value: List[str] | None = None
+ if multiline or "\n" in value:
+ _multiline = True
+ _raw: str = f"{option}:\n"
+ _value: List[str] = value.split("\n")
+ _raw_value: List[str] = [f"{' ' * indent}{v}\n" for v in _value]
+ else:
+ _multiline = False
+ _raw: str = f"{option}: {value}\n"
+ _value: str = value
+
+ # the option does not exist yet
+ if option not in self._all_options.get(section):
+ _option: Option = {
+ "is_multiline": _multiline,
+ "option": option,
+ "value": _value,
+ "_raw": _raw,
+ }
+ if _raw_value is not None:
+ _option["_raw_value"] = _raw_value
+ self._config[section]["body"].insert(0, _option)
+
+ # the option exists and we need to update it
+ else:
+ for _option in self._config[section]["body"]:
+ if _option["option"] == option:
+ if multiline:
+ _option["_raw"] = _raw
+ else:
+ # we preserve inline comments by replacing the old value with the new one
+ _option["_raw"] = _option["_raw"].replace(
+ _option["value"], _value
+ )
+ _option["value"] = _value
+ if _raw_value is not None:
+ _option["_raw_value"] = _raw_value
+ break
+
+ self._all_options[section][option] = _value
+
+ def remove_option(self, section: str, option: str) -> None:
+ """Remove the given option from the given section"""
+
+ if section not in self._all_sections:
+ raise NoSectionError(section)
+
+ if option not in self._all_options.get(section):
+ raise NoOptionError(option, section)
+
+ for _option in self._config[section]["body"]:
+ if _option["option"] == option:
+ del self._all_options[section][option]
+ self._config[section]["body"].remove(_option)
+ break
+
+ def has_section(self, section: str) -> bool:
+ """Return True if the given section exists, False otherwise"""
+ return section in self._all_sections
+
+ def has_option(self, section: str, option: str) -> bool:
+ """Return True if the given option exists in the given section, False otherwise"""
+ return option in self._all_options.get(section)
+
+ def _is_section(self, line: str) -> bool:
+ """Check if the given line contains a section definition"""
+ return self._SECTION_RE.match(line) is not None
+
+ def _is_option(self, line: str) -> bool:
+ """Check if the given line contains an option definition"""
+
+ match: Match[str] | None = self._OPTION_RE.match(line)
+
+ if not match:
+ return False
+
+ # if there is no value, it's not a regular option but a multiline option
+ if match.group(2).strip() == "":
+ return False
+
+ if not match.group(1).strip() == "":
+ return True
+
+ return False
+
+ def _is_comment(self, line: str) -> bool:
+ """Check if the given line is a comment"""
+ return self._COMMENT_RE.match(line) is not None
+
+ def _is_empty_line(self, line: str) -> bool:
+ """Check if the given line is an empty line"""
+ return self._EMPTY_LINE_RE.match(line) is not None
+
+ def _is_multiline_option(self, line: str) -> bool:
+ """Check if the given line starts a multiline option block"""
+
+ match: Match[str] | None = self._MLOPTION_RE.match(line)
+
+ if not match:
+ return False
+
+ return True
+
+ def _parse_config(self, content: List[str]) -> None:
+ """Parse the given content and store the result in the internal state"""
+
+ _curr_multi_opt = ""
+
+ # THE ORDER MATTERS, DO NOT REORDER THE CONDITIONS!
+ for line in content:
+ if self._is_section(line):
+ self._parse_section(line)
+
+ elif self._is_option(line):
+ self._parse_option(line)
+
+ # if it's not a regular option with the value inline,
+ # it might be a might be a multiline option block
+ elif self._is_multiline_option(line):
+ self.in_option_block = True
+ _curr_multi_opt = self._OPTION_RE.match(line).group(1).strip()
+ self._add_option_to_section_body(_curr_multi_opt, "", line)
+
+ elif self.in_option_block:
+ self._parse_multiline_option(_curr_multi_opt, line)
+
+ # if it's nothing from above, it's probably a comment or an empty line
+ elif self._is_comment(line) or self._is_empty_line(line):
+ self._parse_comment(line)
+
+ def _parse_section(self, line: str) -> None:
+ """Parse a section line and store the result in the internal state"""
+
+ match: Match[str] | None = self._SECTION_RE.match(line)
+ if not match:
+ return
+
+ self.in_option_block = False
+
+ section_name: str = match.group(1).strip()
+ self._store_internal_state_section(section_name, line)
+
+ def _store_internal_state_section(self, section: str, raw_value: str) -> None:
+ """Store the given section and its raw value in the internal state"""
+
+ if section in self._all_sections:
+ raise DuplicateSectionError(section)
+
+ self.section_name = section
+ self._all_sections.append(section)
+ self._all_options[section] = {}
+ self._config[section]: Section = {"_raw": raw_value, "body": []}
+
+ def _parse_option(self, line: str) -> None:
+ """Parse an option line and store the result in the internal state"""
+
+ self.in_option_block = False
+
+ match: Match[str] | None = self._OPTION_RE.match(line)
+ if not match:
+ return
+
+ option: str = match.group(1).strip()
+ value: str = match.group(2).strip()
+
+ if ";" in value:
+ i = value.index(";")
+ value = value[:i].strip()
+ elif "#" in value:
+ i = value.index("#")
+ value = value[:i].strip()
+
+ self._store_internal_state_option(option, value, line)
+
+ def _store_internal_state_option(
+ self, option: str, value: str, raw_value: str
+ ) -> None:
+ """Store the given option and its raw value in the internal state"""
+
+ section_options = self._all_options.setdefault(self.section_name, {})
+
+ if option in section_options:
+ raise DuplicateOptionError(option, self.section_name)
+
+ section_options[option] = value
+ self._add_option_to_section_body(option, value, raw_value)
+
+ def _parse_multiline_option(self, curr_ml_opt: str, line: str) -> None:
+ """Parse a multiline option line and store the result in the internal state"""
+
+ section_options = self._all_options.setdefault(self.section_name, {})
+ multiline_options = section_options.setdefault(curr_ml_opt, [])
+
+ _cleaned_line = line.strip().strip("\n")
+ if _cleaned_line and not self._is_comment(line):
+ multiline_options.append(_cleaned_line)
+
+ # add the option to the internal multiline option value state
+ self._ensure_section_body_exists()
+ for _option in self._config[self.section_name]["body"]:
+ if _option.get("option") == curr_ml_opt:
+ _option.update(
+ is_multiline=True,
+ _raw_value=_option.get("_raw_value", []) + [line],
+ value=multiline_options,
+ )
+
+ def _parse_comment(self, line: str) -> None:
+ """
+ Parse a comment line and store the result in the internal state
+
+ If the there was no previous section parsed, the lines are handled as
+ the file header and added to the internal header list as it means, that
+ we are at the very top of the file.
+ """
+
+ self.in_option_block = False
+
+ if not self.section_name:
+ self._header.append(line)
+ else:
+ self._add_option_to_section_body("", "", line)
+
+ def _ensure_section_body_exists(self) -> None:
+ """
+ Ensure that the section body exists in the internal state.
+ If the section body does not exist, it is created as an empty list
+ """
+ if self.section_name not in self._config:
+ self._config.setdefault(self.section_name, {}).setdefault("body", [])
+
+ def _add_option_to_section_body(
+ self, option: str, value: str, line: str, is_multiline: bool = False
+ ) -> None:
+ """Add a raw option line to the internal state"""
+
+ self._ensure_section_body_exists()
+
+ new_option: Option = {
+ "is_multiline": is_multiline,
+ "option": option,
+ "value": value,
+ "_raw": line,
+ }
+
+ option_body = self._config[self.section_name]["body"]
+ option_body.append(new_option)
diff --git a/kiauh/core/submodules/simple_config_parser/tests/Test SimpleConfigParser.run.xml b/kiauh/core/submodules/simple_config_parser/tests/Test SimpleConfigParser.run.xml
new file mode 100644
index 0000000..bc62c5c
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/tests/Test SimpleConfigParser.run.xml
@@ -0,0 +1,21 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/kiauh/core/submodules/simple_config_parser/tests/__init__.py b/kiauh/core/submodules/simple_config_parser/tests/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/internal_state/test_content_handling.py b/kiauh/core/submodules/simple_config_parser/tests/features/internal_state/test_content_handling.py
new file mode 100644
index 0000000..d54681e
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/tests/features/internal_state/test_content_handling.py
@@ -0,0 +1,95 @@
+import pytest
+
+from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+
+
+@pytest.fixture
+def parser():
+ parser = SimpleConfigParser()
+ parser._header = ["header1\n", "header2\n"]
+ parser._config = {
+ "section1": {
+ "_raw": "[section1]\n",
+ "body": [
+ {
+ "_raw": "option1: value1\n",
+ "_raw_value": "value1\n",
+ "is_multiline": False,
+ "option": "option1",
+ "value": "value1",
+ },
+ {
+ "_raw": "option2: value2\n",
+ "_raw_value": "value2\n",
+ "is_multiline": False,
+ "option": "option2",
+ "value": "value2",
+ },
+ ],
+ },
+ "section2": {
+ "_raw": "[section2]\n",
+ "body": [
+ {
+ "_raw": "option3: value3\n",
+ "_raw_value": "value3\n",
+ "is_multiline": False,
+ "option": "option3",
+ "value": "value3",
+ },
+ ],
+ },
+ "section3": {
+ "_raw": "[section3]\n",
+ "body": [
+ {
+ "_raw": "option4:\n",
+ "_raw_value": [" value4\n", " value5\n", " value6\n"],
+ "is_multiline": True,
+ "option": "option4",
+ "value": ["value4", "value5", "value6"],
+ },
+ ],
+ },
+ }
+ return parser
+
+
+def test_construct_content(parser):
+ content = parser._construct_content()
+ assert (
+ content == "header1\nheader2\n"
+ "[section1]\n"
+ "option1: value1\n"
+ "option2: value2\n"
+ "[section2]\n"
+ "option3: value3\n"
+ "[section3]\n"
+ "option4:\n"
+ " value4\n"
+ " value5\n"
+ " value6\n"
+ )
+
+
+def test_construct_content_no_header(parser):
+ parser._header = None
+ content = parser._construct_content()
+ assert (
+ content == "[section1]\n"
+ "option1: value1\n"
+ "option2: value2\n"
+ "[section2]\n"
+ "option3: value3\n"
+ "[section3]\n"
+ "option4:\n"
+ " value4\n"
+ " value5\n"
+ " value6\n"
+ )
+
+
+def test_construct_content_no_sections(parser):
+ parser._config = {}
+ content = parser._construct_content()
+ assert content == "".join(parser._header)
diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/internal_state/test_internal_state_changes.py b/kiauh/core/submodules/simple_config_parser/tests/features/internal_state/test_internal_state_changes.py
new file mode 100644
index 0000000..789368c
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/tests/features/internal_state/test_internal_state_changes.py
@@ -0,0 +1,84 @@
+import pytest
+
+from src.simple_config_parser.simple_config_parser import (
+ DuplicateOptionError,
+ DuplicateSectionError,
+ SimpleConfigParser,
+)
+
+
+@pytest.fixture
+def parser():
+ return SimpleConfigParser()
+
+
+class TestInternalStateChanges:
+ @pytest.mark.parametrize(
+ "given", ["dummy_section", "dummy_section 2", "another_section"]
+ )
+ def test_ensure_section_body_exists(self, parser, given):
+ parser._config = {}
+ parser.section_name = given
+ parser._ensure_section_body_exists()
+
+ assert parser._config[given] is not None
+ assert parser._config[given]["body"] == []
+
+ def test_add_option_to_section_body(self):
+ pass
+
+ @pytest.mark.parametrize(
+ "given", ["dummy_section", "dummy_section 2", "another_section\n"]
+ )
+ def test_store_internal_state_section(self, parser, given):
+ parser._store_internal_state_section(given, given)
+
+ assert parser._all_sections == [given]
+ assert parser._all_options[given] == {}
+ assert parser._config[given]["body"] == []
+ assert parser._config[given]["_raw"] == given
+
+ def test_duplicate_section_error(self, parser):
+ section_name = "dummy_section"
+ parser._all_sections = [section_name]
+
+ with pytest.raises(DuplicateSectionError) as excinfo:
+ parser._store_internal_state_section(section_name, section_name)
+ message = f"Section '{section_name}' is defined more than once"
+ assert message in str(excinfo.value)
+
+ # Check that the internal state of the parser is correct
+ assert parser.in_option_block is False
+ assert parser.section_name == ""
+ assert parser._all_sections == [section_name]
+
+ @pytest.mark.parametrize(
+ "given_name, given_value, given_raw_value",
+ [("dummyoption", "dummyvalue", "dummyvalue\n")],
+ )
+ def test_store_internal_state_option(
+ self, parser, given_name, given_value, given_raw_value
+ ):
+ parser.section_name = "dummy_section"
+ parser._store_internal_state_option(given_name, given_value, given_raw_value)
+
+ assert parser._all_options[parser.section_name] == {given_name: given_value}
+
+ new_option = {
+ "is_multiline": False,
+ "option": given_name,
+ "value": given_value,
+ "_raw": given_raw_value,
+ }
+ assert parser._config[parser.section_name]["body"] == [new_option]
+
+ def test_duplicate_option_error(self, parser):
+ option_name = "dummyoption"
+ value = "dummyvalue"
+ parser.section_name = "dummy_section"
+ parser._all_options = {parser.section_name: {option_name: value}}
+
+ with pytest.raises(DuplicateOptionError) as excinfo:
+ parser._store_internal_state_option(option_name, value, value)
+ message = f"Option '{option_name}' in section '{parser.section_name}' is defined more than once"
+ assert message in str(excinfo.value)
diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_comment.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_comment.py
new file mode 100644
index 0000000..d84b40f
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_comment.py
@@ -0,0 +1,6 @@
+testcases = [
+ "# comment # 1",
+ "; comment # 2",
+ " ; indented comment",
+ " # another indented comment",
+]
diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_option.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_option.py
new file mode 100644
index 0000000..fbe9001
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_option.py
@@ -0,0 +1,24 @@
+testcases = [
+ ("option: value", "option", "value"),
+ ("option : value", "option", "value"),
+ ("option :value", "option", "value"),
+ ("option= value", "option", "value"),
+ ("option = value", "option", "value"),
+ ("option =value", "option", "value"),
+ ("option: value\n", "option", "value"),
+ ("option: value # inline comment", "option", "value"),
+ ("option: value # inline comment\n", "option", "value"),
+ (
+ "description: Helper: park toolhead used in PAUSE and CANCEL_PRINT",
+ "description",
+ "Helper: park toolhead used in PAUSE and CANCEL_PRINT",
+ ),
+ ("description: homing!", "description", "homing!"),
+ ("description: inline macro :-)", "description", "inline macro :-)"),
+ ("path: %GCODES_DIR%", "path", "%GCODES_DIR%"),
+ (
+ "serial = /dev/serial/by-id/",
+ "serial",
+ "/dev/serial/by-id/",
+ ),
+]
diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_section.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_section.py
new file mode 100644
index 0000000..bab0f69
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/data/case_parse_section.py
@@ -0,0 +1,8 @@
+testcases = [
+ ("[test_section]", "test_section"),
+ ("[test_section two]", "test_section two"),
+ ("[section1] # inline comment", "section1"),
+ ("[section2] ; second comment", "section2"),
+ ("[include moonraker-obico-update.cfg]", "include moonraker-obico-update.cfg"),
+ ("[include moonraker_obico_macros.cfg]", "include moonraker_obico_macros.cfg"),
+]
diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/test_line_parsing.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/test_line_parsing.py
new file mode 100644
index 0000000..96366e3
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_parsing/test_line_parsing.py
@@ -0,0 +1,92 @@
+import pytest
+from data.case_parse_comment import testcases as case_parse_comment
+from data.case_parse_option import testcases as case_parse_option
+from data.case_parse_section import testcases as case_parse_section
+
+from src.simple_config_parser.simple_config_parser import (
+ Option,
+ SimpleConfigParser,
+)
+
+
+@pytest.fixture
+def parser():
+ return SimpleConfigParser()
+
+
+class TestLineParsing:
+ @pytest.mark.parametrize("given, expected", [*case_parse_section])
+ def test_parse_section(self, parser, given, expected):
+ parser._parse_section(given)
+
+ # Check that the internal state of the parser is correct
+ assert parser.section_name == expected
+ assert parser.in_option_block is False
+ assert parser._all_sections == [expected]
+ assert parser._config[expected]["_raw"] == given
+ assert parser._config[expected]["body"] == []
+
+ @pytest.mark.parametrize(
+ "given, expected_option, expected_value", [*case_parse_option]
+ )
+ def test_parse_option(self, parser, given, expected_option, expected_value):
+ section_name = "test_section"
+ parser.section_name = section_name
+ parser._parse_option(given)
+
+ # Check that the internal state of the parser is correct
+ assert parser.section_name == section_name
+ assert parser.in_option_block is False
+ assert parser._all_options[section_name][expected_option] == expected_value
+
+ section_option = parser._config[section_name]["body"][0]
+ assert section_option["option"] == expected_option
+ assert section_option["value"] == expected_value
+ assert section_option["_raw"] == given
+
+ @pytest.mark.parametrize(
+ "option, next_line",
+ [("gcode", "next line"), ("gcode", " {{% some jinja template %}}")],
+ )
+ def test_parse_multiline_option(self, parser, option, next_line):
+ parser.section_name = "dummy_section"
+ parser.in_option_block = True
+ parser._add_option_to_section_body(option, "", option)
+ parser._parse_multiline_option(option, next_line)
+ cleaned_next_line = next_line.strip().strip("\n")
+
+ assert parser._all_options[parser.section_name] is not None
+ assert parser._all_options[parser.section_name][option] == [cleaned_next_line]
+
+ expected_option: Option = {
+ "is_multiline": True,
+ "option": option,
+ "value": [cleaned_next_line],
+ "_raw": option,
+ "_raw_value": [next_line],
+ }
+ assert parser._config[parser.section_name]["body"] == [expected_option]
+
+ @pytest.mark.parametrize("given", [*case_parse_comment])
+ def test_parse_comment(self, parser, given):
+ parser.section_name = "dummy_section"
+ parser._parse_comment(given)
+
+ # internal state checks after parsing
+ assert parser.in_option_block is False
+
+ expected_option = {
+ "is_multiline": False,
+ "_raw": given,
+ "option": "",
+ "value": "",
+ }
+ assert parser._config[parser.section_name]["body"] == [expected_option]
+
+ @pytest.mark.parametrize("given", ["# header line", "; another header line"])
+ def test_parse_header_comment(self, parser, given):
+ parser.section_name = ""
+ parser._parse_comment(given)
+
+ assert parser.in_option_block is False
+ assert parser._header == [given]
diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_comment.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_comment.py
new file mode 100644
index 0000000..107745c
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_comment.py
@@ -0,0 +1,9 @@
+testcases = [
+ ("# an arbitrary comment", True),
+ ("; another arbitrary comment", True),
+ (" ; indented comment", True),
+ (" # indented comment", True),
+ ("not_a: comment", False),
+ ("also_not_a= comment", False),
+ ("[definitely_not_a_comment]", False),
+]
diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_empty.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_empty.py
new file mode 100644
index 0000000..7fe6afc
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_empty.py
@@ -0,0 +1,9 @@
+testcases = [
+ ("", True),
+ (" ", True),
+ ("not empty", False),
+ (" # indented comment", False),
+ ("not: empty", False),
+ ("also_not= empty", False),
+ ("[definitely_not_empty]", False),
+]
diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_multiline_option.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_multiline_option.py
new file mode 100644
index 0000000..ed93f87
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_multiline_option.py
@@ -0,0 +1,17 @@
+testcases = [
+ ("valid_option:", True),
+ ("valid_option:\n", True),
+ ("valid_option: ; inline comment", True),
+ ("valid_option: # inline comment", True),
+ ("valid_option :", True),
+ ("valid_option=", True),
+ ("valid_option= ", True),
+ ("valid_option =", True),
+ ("valid_option = ", True),
+ ("invalid_option ==", False),
+ ("invalid_option :=", False),
+ ("not_a_valid_option", False),
+ ("", False),
+ ("# that's a comment", False),
+ ("; that's a comment", False),
+]
diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_option.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_option.py
new file mode 100644
index 0000000..280e851
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_option.py
@@ -0,0 +1,30 @@
+testcases = [
+ ("valid_option: value", True),
+ ("valid_option: value\n", True),
+ ("valid_option: value ; inline comment", True),
+ ("valid_option: value # inline comment", True),
+ ("valid_option: value # inline comment\n", True),
+ ("valid_option : value", True),
+ ("valid_option :value", True),
+ ("valid_option= value", True),
+ ("valid_option = value", True),
+ ("valid_option =value", True),
+ ("invalid_option:", False),
+ ("invalid_option=", False),
+ ("invalid_option:: value", False),
+ ("invalid_option :: value", False),
+ ("invalid_option ::value", False),
+ ("invalid_option== value", False),
+ ("invalid_option == value", False),
+ ("invalid_option ==value", False),
+ ("invalid_option:= value", False),
+ ("invalid_option := value", False),
+ ("invalid_option :=value", False),
+ ("[that_is_a_section]", False),
+ ("[that_is_section two]", False),
+ ("not_a_valid_option", False),
+ ("description: homing!", True),
+ ("description: inline macro :-)", True),
+ ("path: %GCODES_DIR%", True),
+ ("serial = /dev/serial/by-id/", True),
+]
diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_section.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_section.py
new file mode 100644
index 0000000..42b93d0
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/data/case_line_is_section.py
@@ -0,0 +1,12 @@
+testcases = [
+ ("[example_section]", True),
+ ("[gcode_macro CANCEL_PRINT]", True),
+ ("[gcode_macro SET_PAUSE_NEXT_LAYER]", True),
+ ("[gcode_macro _TOOLHEAD_PARK_PAUSE_CANCEL]", True),
+ ("[update_manager moonraker-obico]", True),
+ ("[include moonraker_obico_macros.cfg]", True),
+ ("[include moonraker-obico-update.cfg]", True),
+ ("[example_section two]", True),
+ ("not_a_valid_section", False),
+ ("section: invalid", False),
+]
diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/test_line_type_detection.py b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/test_line_type_detection.py
new file mode 100644
index 0000000..854fde7
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/tests/features/line_type_detection/test_line_type_detection.py
@@ -0,0 +1,37 @@
+import pytest
+from data.case_line_is_comment import testcases as case_line_is_comment
+from data.case_line_is_empty import testcases as case_line_is_empty
+from data.case_line_is_multiline_option import (
+ testcases as case_line_is_multiline_option,
+)
+from data.case_line_is_option import testcases as case_line_is_option
+from data.case_line_is_section import testcases as case_line_is_section
+
+from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+
+
+@pytest.fixture
+def parser():
+ return SimpleConfigParser()
+
+
+class TestLineTypeDetection:
+ @pytest.mark.parametrize("given, expected", [*case_line_is_section])
+ def test_line_is_section(self, parser, given, expected):
+ assert parser._is_section(given) is expected
+
+ @pytest.mark.parametrize("given, expected", [*case_line_is_option])
+ def test_line_is_option(self, parser, given, expected):
+ assert parser._is_option(given) is expected
+
+ @pytest.mark.parametrize("given, expected", [*case_line_is_multiline_option])
+ def test_line_is_multiline_option(self, parser, given, expected):
+ assert parser._is_multiline_option(given) is expected
+
+ @pytest.mark.parametrize("given, expected", [*case_line_is_comment])
+ def test_line_is_comment(self, parser, given, expected):
+ assert parser._is_comment(given) is expected
+
+ @pytest.mark.parametrize("given, expected", [*case_line_is_empty])
+ def test_line_is_empty(self, parser, given, expected):
+ assert parser._is_empty_line(given) is expected
diff --git a/kiauh/core/submodules/simple_config_parser/tests/features/public_api/test_public_api.py b/kiauh/core/submodules/simple_config_parser/tests/features/public_api/test_public_api.py
new file mode 100644
index 0000000..0e59b5a
--- /dev/null
+++ b/kiauh/core/submodules/simple_config_parser/tests/features/public_api/test_public_api.py
@@ -0,0 +1,196 @@
+import pytest
+
+from src.simple_config_parser.simple_config_parser import (
+ DuplicateSectionError,
+ NoOptionError,
+ NoSectionError,
+ SimpleConfigParser,
+)
+
+
+@pytest.fixture
+def parser():
+ return SimpleConfigParser()
+
+
+class TestPublicAPI:
+ def test_has_section(self, parser):
+ parser._all_sections = ["section1"]
+ assert parser.has_section("section1") is True
+
+ @pytest.mark.parametrize("section", ["section1", "section2", "section three"])
+ def test_add_section(self, parser, section):
+ parser.add_section(section)
+
+ assert section in parser._all_sections
+ assert parser._all_options[section] == {}
+
+ cfg_section = {"_raw": f"\n[{section}]\n", "body": []}
+ assert parser._config[section] == cfg_section
+
+ @pytest.mark.parametrize("section", ["section1", "section2", "section three"])
+ def test_add_existing_section(self, parser, section):
+ parser._all_sections = [section]
+
+ with pytest.raises(DuplicateSectionError):
+ parser.add_section(section)
+
+ assert parser._all_sections == [section]
+
+ @pytest.mark.parametrize("section", ["section1", "section2", "section three"])
+ def test_remove_section(self, parser, section):
+ parser.add_section(section)
+ parser.remove_section(section)
+
+ assert section not in parser._all_sections
+ assert section not in parser._all_options
+ assert section not in parser._config
+
+ @pytest.mark.parametrize("section", ["section1", "section2", "section three"])
+ def test_remove_non_existing_section(self, parser, section):
+ with pytest.raises(NoSectionError):
+ parser.remove_section(section)
+
+ def test_get_all_sections(self, parser):
+ parser.add_section("section1")
+ parser.add_section("section2")
+ parser.add_section("section three")
+
+ assert parser.sections() == ["section1", "section2", "section three"]
+
+ def test_has_option(self, parser):
+ parser.add_section("section1")
+ parser.set("section1", "option1", "value1")
+
+ assert parser.has_option("section1", "option1") is True
+
+ @pytest.mark.parametrize(
+ "section, option, value",
+ [
+ ("section1", "option1", "value1"),
+ ("section2", "option2", "value2"),
+ ("section three", "option3", "value three"),
+ ],
+ )
+ def test_set_new_option(self, parser, section, option, value):
+ parser.add_section(section)
+ parser.set(section, option, value)
+
+ assert section in parser._all_sections
+ assert option in parser._all_options[section]
+ assert parser._all_options[section][option] == value
+
+ assert parser._config[section]["body"][0]["is_multiline"] is False
+ assert parser._config[section]["body"][0]["option"] == option
+ assert parser._config[section]["body"][0]["value"] == value
+ assert parser._config[section]["body"][0]["_raw"] == f"{option}: {value}\n"
+
+ def test_set_existing_option(self, parser):
+ section, option, value1, value2 = "section1", "option1", "value1", "value2"
+
+ parser.add_section(section)
+ parser.set(section, option, value1)
+ parser.set(section, option, value2)
+
+ assert parser._all_options[section][option] == value2
+ assert parser._config[section]["body"][0]["is_multiline"] is False
+ assert parser._config[section]["body"][0]["option"] == option
+ assert parser._config[section]["body"][0]["value"] == value2
+ assert parser._config[section]["body"][0]["_raw"] == f"{option}: {value2}\n"
+
+ def test_set_new_multiline_option(self, parser):
+ section, option, value = "section1", "option1", "value1\nvalue2\nvalue3"
+
+ parser.add_section(section)
+ parser.set(section, option, value)
+
+ assert parser._config[section]["body"][0]["is_multiline"] is True
+ assert parser._config[section]["body"][0]["option"] == option
+
+ values = ["value1", "value2", "value3"]
+ raw_values = [" value1\n", " value2\n", " value3\n"]
+ assert parser._config[section]["body"][0]["value"] == values
+ assert parser._config[section]["body"][0]["_raw"] == f"{option}:\n"
+ assert parser._config[section]["body"][0]["_raw_value"] == raw_values
+ assert parser._all_options[section][option] == values
+
+ def test_set_option_of_non_existing_section(self, parser):
+ with pytest.raises(NoSectionError):
+ parser.set("section1", "option1", "value1")
+
+ def test_remove_option(self, parser):
+ section, option, value = "section1", "option1", "value1"
+
+ parser.add_section(section)
+ parser.set(section, option, value)
+ parser.remove_option(section, option)
+
+ assert option not in parser._all_options[section]
+ assert option not in parser._config[section]["body"]
+
+ def test_remove_non_existing_option(self, parser):
+ parser.add_section("section1")
+ with pytest.raises(NoOptionError):
+ parser.remove_option("section1", "option1")
+
+ def test_remove_option_of_non_existing_section(self, parser):
+ with pytest.raises(NoSectionError):
+ parser.remove_option("section1", "option1")
+
+ def test_get_option(self, parser):
+ parser.add_section("section1")
+ parser.add_section("section2")
+ parser.set("section1", "option1", "value1")
+ parser.set("section2", "option2", "value2")
+ parser.set("section2", "option3", "value two")
+
+ assert parser.get("section1", "option1") == "value1"
+ assert parser.get("section2", "option2") == "value2"
+ assert parser.get("section2", "option3") == "value two"
+
+ def test_get_option_of_non_existing_section(self, parser):
+ with pytest.raises(NoSectionError):
+ parser.get("section1", "option1")
+
+ def test_get_option_of_non_existing_option(self, parser):
+ parser.add_section("section1")
+ with pytest.raises(NoOptionError):
+ parser.get("section1", "option1")
+
+ def test_get_option_fallback(self, parser):
+ parser.add_section("section1")
+ assert parser.get("section1", "option1", "fallback_value") == "fallback_value"
+
+ def test_get_options(self, parser):
+ parser.add_section("section1")
+ parser.set("section1", "option1", "value1")
+ parser.set("section1", "option2", "value2")
+ parser.set("section1", "option3", "value3")
+
+ options = {"option1": "value1", "option2": "value2", "option3": "value3"}
+ assert parser.options("section1") == options
+
+ def test_get_option_as_int(self, parser):
+ parser.add_section("section1")
+ parser.set("section1", "option1", "1")
+
+ option = parser.getint("section1", "option1")
+ assert isinstance(option, int) is True
+
+ def test_get_option_as_float(self, parser):
+ parser.add_section("section1")
+ parser.set("section1", "option1", "1.234")
+
+ option = parser.getfloat("section1", "option1")
+ assert isinstance(option, float) is True
+
+ @pytest.mark.parametrize(
+ "value",
+ ["True", "true", "on", "1", "yes", "False", "false", "off", "0", "no"],
+ )
+ def test_get_option_as_boolean(self, parser, value):
+ parser.add_section("section1")
+ parser.set("section1", "option1", value)
+
+ option = parser.getboolean("section1", "option1")
+ assert isinstance(option, bool) is True
diff --git a/kiauh/core/types.py b/kiauh/core/types.py
new file mode 100644
index 0000000..274ef9d
--- /dev/null
+++ b/kiauh/core/types.py
@@ -0,0 +1,29 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Dict, Literal
+
+StatusText = Literal["Installed", "Not installed", "Incomplete"]
+StatusCode = Literal[0, 1, 2]
+StatusMap: Dict[StatusCode, StatusText] = {
+ 0: "Not installed",
+ 1: "Incomplete",
+ 2: "Installed",
+}
+
+
+@dataclass
+class ComponentStatus:
+ status: StatusCode
+ repo: str | None = None
+ local: str | None = None
+ remote: str | None = None
+ instances: int | None = None
diff --git a/kiauh/extensions/__init__.py b/kiauh/extensions/__init__.py
new file mode 100644
index 0000000..7e995bf
--- /dev/null
+++ b/kiauh/extensions/__init__.py
@@ -0,0 +1,12 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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
+
+EXTENSION_ROOT = Path(__file__).resolve().parents[1].joinpath("extensions")
diff --git a/kiauh/extensions/base_extension.py b/kiauh/extensions/base_extension.py
new file mode 100644
index 0000000..008c520
--- /dev/null
+++ b/kiauh/extensions/base_extension.py
@@ -0,0 +1,29 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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 ABC, abstractmethod
+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
+
+ def update_extension(self, **kwargs) -> None:
+ raise NotImplementedError
+
+ @abstractmethod
+ def remove_extension(self, **kwargs) -> None:
+ raise NotImplementedError
diff --git a/kiauh/extensions/extensions_menu.py b/kiauh/extensions/extensions_menu.py
new file mode 100644
index 0000000..60b1167
--- /dev/null
+++ b/kiauh/extensions/extensions_menu.py
@@ -0,0 +1,162 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import importlib
+import inspect
+import json
+import textwrap
+from pathlib import Path
+from typing import Dict, List, Type
+
+from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
+from core.logger import Logger
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+from extensions import EXTENSION_ROOT
+from extensions.base_extension import BaseExtension
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class ExtensionsMenu(BaseMenu):
+ def __init__(self, previous_menu: Type[BaseMenu] | None = None):
+ super().__init__()
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+ self.extensions: Dict[str, BaseExtension] = self.discover_extensions()
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from core.menus.main_menu import MainMenu
+
+ self.previous_menu = previous_menu if previous_menu is not None else MainMenu
+
+ def set_options(self) -> None:
+ self.options = {
+ i: Option(self.extension_submenu, opt_data=self.extensions.get(i))
+ for i in self.extensions
+ }
+
+ def discover_extensions(self) -> Dict[str, BaseExtension]:
+ ext_dict = {}
+
+ for ext in EXTENSION_ROOT.iterdir():
+ metadata_json = Path(ext).joinpath("metadata.json")
+ if not metadata_json.exists():
+ continue
+
+ try:
+ with open(metadata_json, "r") as m:
+ # read extension metadata from json
+ metadata = json.load(m).get("metadata")
+ module_name = metadata.get("module")
+ module_path = f"kiauh.extensions.{ext.name}.{module_name}"
+
+ # get the class name of the extension
+ ext_class: Type[BaseExtension] = inspect.getmembers(
+ importlib.import_module(module_path),
+ predicate=lambda o: inspect.isclass(o)
+ and issubclass(o, BaseExtension)
+ and o != BaseExtension,
+ )[0][1]
+
+ # instantiate the extension with its metadata and add to dict
+ ext_instance: BaseExtension = ext_class(metadata)
+ ext_dict[f"{metadata.get('index')}"] = ext_instance
+
+ except (IOError, json.JSONDecodeError, ImportError) as e:
+ print(f"Failed loading extension {ext}: {e}")
+
+ return dict(sorted(ext_dict.items()))
+
+ def extension_submenu(self, **kwargs):
+ ExtensionSubmenu(kwargs.get("opt_data"), self.__class__).run()
+
+ def print_menu(self) -> None:
+ 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.values():
+ index = extension.metadata.get("index")
+ name = extension.metadata.get("display_name")
+ row = f"{index}) {name}"
+ print(f"║ {row:<53} ║")
+ print("╟───────────────────────────────────────────────────────╢")
+
+
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
+class ExtensionSubmenu(BaseMenu):
+ def __init__(
+ self, extension: BaseExtension, previous_menu: Type[BaseMenu] | None = None
+ ):
+ super().__init__()
+ self.extension = extension
+ self.previous_menu: Type[BaseMenu] | None = previous_menu
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ self.previous_menu = (
+ previous_menu if previous_menu is not None else ExtensionsMenu
+ )
+
+ def set_options(self) -> None:
+ self.options["1"] = Option(self.extension.install_extension)
+ if self.extension.metadata.get("updates"):
+ self.options["2"] = Option(self.extension.update_extension)
+ self.options["3"] = Option(self.extension.remove_extension)
+ else:
+ self.options["2"] = Option(self.extension.remove_extension)
+
+ def print_menu(self) -> None:
+ header = f" [ {self.extension.metadata.get('display_name')} ] "
+ color = COLOR_YELLOW
+ count = 62 - len(color) - len(RESET_FORMAT)
+ line_width = 53
+ description: List[str] = self.extension.metadata.get("description", [])
+ description_text = Logger.format_content(
+ description,
+ line_width,
+ border_left="║",
+ border_right="║",
+ )
+
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ """
+ )[1:]
+ menu += f"{description_text}\n"
+ menu += textwrap.dedent(
+ """
+ ╟───────────────────────────────────────────────────────╢
+ ║ 1) Install ║
+ """
+ )[1:]
+
+ if self.extension.metadata.get("updates"):
+ menu += "║ 2) Update ║\n"
+ menu += "║ 3) Remove ║\n"
+ else:
+ menu += "║ 2) Remove ║\n"
+ menu += "╟───────────────────────────────────────────────────────╢\n"
+
+ print(menu, end="")
diff --git a/kiauh/extensions/gcode_shell_cmd/__init__.py b/kiauh/extensions/gcode_shell_cmd/__init__.py
new file mode 100644
index 0000000..95336dc
--- /dev/null
+++ b/kiauh/extensions/gcode_shell_cmd/__init__.py
@@ -0,0 +1,19 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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")
diff --git a/kiauh/extensions/gcode_shell_cmd/assets/gcode_shell_command.py b/kiauh/extensions/gcode_shell_cmd/assets/gcode_shell_command.py
new file mode 100644
index 0000000..85b664b
--- /dev/null
+++ b/kiauh/extensions/gcode_shell_cmd/assets/gcode_shell_command.py
@@ -0,0 +1,94 @@
+# Run a shell command via gcode
+#
+# Copyright (C) 2019 Eric Callahan
+#
+# This file may be distributed under the terms of the GNU GPLv3 license.
+import logging
+import os
+import shlex
+import subprocess
+
+
+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.0, above=0.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 + 0.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)
diff --git a/kiauh/extensions/gcode_shell_cmd/assets/shell_command.cfg b/kiauh/extensions/gcode_shell_cmd/assets/shell_command.cfg
new file mode 100644
index 0000000..34e7581
--- /dev/null
+++ b/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
\ No newline at end of file
diff --git a/kiauh/extensions/gcode_shell_cmd/gcode_shell_cmd_extension.py b/kiauh/extensions/gcode_shell_cmd/gcode_shell_cmd_extension.py
new file mode 100644
index 0000000..290bc42
--- /dev/null
+++ b/kiauh/extensions/gcode_shell_cmd/gcode_shell_cmd_extension.py
@@ -0,0 +1,131 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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 components.klipper.klipper import Klipper
+from core.backup_manager.backup_manager import BackupManager
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import Logger
+from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+ SimpleConfigParser,
+)
+from extensions.base_extension import BaseExtension
+from extensions.gcode_shell_cmd import (
+ EXAMPLE_CFG_SRC,
+ EXTENSION_SRC,
+ EXTENSION_TARGET_PATH,
+ KLIPPER_DIR,
+ KLIPPER_EXTRAS,
+)
+from utils.fs_utils import check_file_exist
+from utils.input_utils import get_confirm
+from utils.instance_utils import get_instances
+
+
+# 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
+
+ instances = get_instances(Klipper)
+ InstanceManager.stop_all(instances)
+
+ 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(instances)
+
+ InstanceManager.start_all(instances)
+
+ Logger.print_ok("Installing G-Code Shell Command extension successful!")
+
+ 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.base.cfg_dir for instance in instances]
+ # copy extension to klippy/extras
+ for cfg_dir in cfg_dirs:
+ Logger.print_status(f"Create shell_command.cfg in '{cfg_dir}' ...")
+ 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}' ...")
+ scp = SimpleConfigParser()
+ scp.read(cfg_file)
+ if scp.has_section(section):
+ Logger.print_info("Section already defined! Skipping ...")
+ continue
+ scp.add_section(section)
+ scp.write(cfg_file)
+ Logger.print_ok("Done!")
diff --git a/kiauh/extensions/gcode_shell_cmd/metadata.json b/kiauh/extensions/gcode_shell_cmd/metadata.json
new file mode 100644
index 0000000..7d7ccdc
--- /dev/null
+++ b/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": ["Run a shell commands from gcode."]
+ }
+}
diff --git a/kiauh/extensions/klipper_backup/__init__.py b/kiauh/extensions/klipper_backup/__init__.py
new file mode 100644
index 0000000..e65e0f5
--- /dev/null
+++ b/kiauh/extensions/klipper_backup/__init__.py
@@ -0,0 +1,19 @@
+# ======================================================================= #
+# Copyright (C) 2023 - 2024 Staubgeborener and Tylerjet #
+# https://github.com/Staubgeborener/klipper-backup #
+# https://klipperbackup.xyz #
+# #
+# 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 = "klipper_backup_extension.py"
+MODULE_PATH = Path(__file__).resolve().parent
+MOONRAKER_CONF = Path.home().joinpath("printer_data", "config", "moonraker.conf")
+KLIPPERBACKUP_DIR = Path.home().joinpath("klipper-backup")
+KLIPPERBACKUP_CONFIG_DIR = Path.home().joinpath("config_backup")
+KLIPPERBACKUP_REPO_URL = "https://github.com/staubgeborener/klipper-backup"
diff --git a/kiauh/extensions/klipper_backup/klipper_backup_extension.py b/kiauh/extensions/klipper_backup/klipper_backup_extension.py
new file mode 100644
index 0000000..95b34ee
--- /dev/null
+++ b/kiauh/extensions/klipper_backup/klipper_backup_extension.py
@@ -0,0 +1,127 @@
+# ======================================================================= #
+# Copyright (C) 2023 - 2024 Staubgeborener and Tylerjet #
+# https://github.com/Staubgeborener/klipper-backup #
+# https://klipperbackup.xyz #
+# #
+# 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 subprocess
+from core.constants import SYSTEMD
+from core.logger import Logger
+from pathlib import Path
+from extensions.base_extension import BaseExtension
+from extensions.klipper_backup import (
+ KLIPPERBACKUP_CONFIG_DIR,
+ KLIPPERBACKUP_DIR,
+ KLIPPERBACKUP_REPO_URL,
+ MOONRAKER_CONF,
+)
+from utils.fs_utils import check_file_exist, remove_with_sudo
+from utils.git_utils import git_cmd_clone
+from utils.input_utils import get_confirm
+from utils.sys_utils import cmd_sysctl_manage, remove_system_service, unit_file_exists
+
+
+class KlipperbackupExtension(BaseExtension):
+
+ def remove_extension(self, **kwargs) -> None:
+ if not check_file_exist(KLIPPERBACKUP_DIR):
+ Logger.print_info("Extension does not seem to be installed! Skipping ...")
+ return
+
+ def uninstall_service(service_name: str, unit_type: str) -> bool:
+ try:
+ full_service_name = f"{service_name}.{unit_type}"
+ if unit_type == "service":
+ remove_system_service(full_service_name)
+ elif unit_type == "timer":
+ full_service_path: Path = SYSTEMD.joinpath(full_service_name)
+ Logger.print_status(f"Removing {full_service_name} ...")
+ remove_with_sudo(full_service_path)
+ Logger.print_ok(f"{service_name}.{unit_type} successfully removed!")
+ cmd_sysctl_manage("daemon-reload")
+ cmd_sysctl_manage("reset-failed")
+ else:
+ Logger.print_error(f"Unknown unit type {unit_type} of {full_service_name}")
+ except:
+ Logger.print_error(f"Failed to remove {full_service_name}: {str(e)}")
+
+ def check_crontab_entry(entry) -> bool:
+ try:
+ crontab_content = subprocess.check_output(["crontab", "-l"], stderr=subprocess.DEVNULL, text=True)
+ except subprocess.CalledProcessError:
+ return False
+ return any(entry in line for line in crontab_content.splitlines())
+
+ def remove_moonraker_entry():
+ original_file_path = MOONRAKER_CONF
+ comparison_file_path = os.path.join(str(KLIPPERBACKUP_DIR), "install-files", "moonraker.conf")
+ if not (os.path.exists(original_file_path) and os.path.exists(comparison_file_path)):
+ return False
+ with open(original_file_path, "r") as original_file, open(comparison_file_path, "r") as comparison_file:
+ original_content = original_file.read()
+ comparison_content = comparison_file.read()
+ if comparison_content in original_content:
+ Logger.print_status("Removing Klipper-Backup moonraker entry ...")
+ modified_content = original_content.replace(comparison_content, "").strip()
+ modified_content = "\n".join(line for line in modified_content.split("\n") if line.strip())
+ with open(original_file_path, "w") as original_file:
+ original_file.write(modified_content)
+ Logger.print_ok("Klipper-Backup moonraker entry successfully removed!")
+ return True
+ return False
+
+ if get_confirm("Do you really want to remove the extension?", True, False):
+ # Remove systemd timer and services
+ service_names = ["klipper-backup-on-boot", "klipper-backup-filewatch", "klipper-backup"]
+ unit_types = ["timer", "service"]
+
+ for service_name in service_names:
+ for unit_type in unit_types:
+ if unit_file_exists(service_name, unit_type):
+ uninstall_service(service_name, unit_type)
+
+ # Remnove crontab entry
+ try:
+ if check_crontab_entry("/klipper-backup/script.sh"):
+ Logger.print_status("Removing Klipper-Backup crontab entry ...")
+ crontab_content = subprocess.check_output(["crontab", "-l"], text=True)
+ modified_content = "\n".join(line for line in crontab_content.splitlines() if "/klipper-backup/script.sh" not in line)
+ subprocess.run(["crontab", "-"], input=modified_content + "\n", text=True, check=True)
+ Logger.print_ok("Klipper-Backup crontab entry successfully removed!")
+ except subprocess.CalledProcessError:
+ Logger.print_error("Unable to remove the Klipper-Backup cron entry")
+
+ # Remove moonraker entry
+ try:
+ remove_moonraker_entry()
+ except:
+ Logger.print_error("Unable to remove the Klipper-Backup moonraker entry")
+
+ # Remove Klipper-backup extension
+ Logger.print_status("Removing Klipper-Backup extension ...")
+ try:
+ remove_with_sudo(KLIPPERBACKUP_DIR)
+ if check_file_exist(KLIPPERBACKUP_CONFIG_DIR):
+ remove_with_sudo(KLIPPERBACKUP_CONFIG_DIR)
+ Logger.print_ok("Extension Klipper-Backup successfully removed!")
+ except:
+ Logger.print_error(f"Unable to remove Klipper-Backup extension")
+
+ def install_extension(self, **kwargs) -> None:
+ if not KLIPPERBACKUP_DIR.exists():
+ git_cmd_clone(KLIPPERBACKUP_REPO_URL, KLIPPERBACKUP_DIR)
+ subprocess.run(["chmod", "+x", str(KLIPPERBACKUP_DIR / "install.sh")])
+ subprocess.run([str(KLIPPERBACKUP_DIR / "install.sh")])
+
+ def update_extension(self, **kwargs) -> None:
+ if not check_file_exist(KLIPPERBACKUP_DIR):
+ Logger.print_info("Extension does not seem to be installed! Skipping ...")
+ return
+ subprocess.run([str(KLIPPERBACKUP_DIR / "install.sh"), "check_updates"])
diff --git a/kiauh/extensions/klipper_backup/metadata.json b/kiauh/extensions/klipper_backup/metadata.json
new file mode 100644
index 0000000..ac09323
--- /dev/null
+++ b/kiauh/extensions/klipper_backup/metadata.json
@@ -0,0 +1,10 @@
+{
+ "metadata": {
+ "index": 3,
+ "module": "klipper_backup_extension",
+ "maintained_by": "Staubgeborener",
+ "display_name": "Klipper-Backup",
+ "description": ["Backup all your Klipper files to GitHub"],
+ "updates": true
+ }
+}
diff --git a/kiauh/extensions/mainsail_theme_installer/__init__.py b/kiauh/extensions/mainsail_theme_installer/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/kiauh/extensions/mainsail_theme_installer/mainsail_theme_installer_extension.py b/kiauh/extensions/mainsail_theme_installer/mainsail_theme_installer_extension.py
new file mode 100644
index 0000000..0483c4d
--- /dev/null
+++ b/kiauh/extensions/mainsail_theme_installer/mainsail_theme_installer_extension.py
@@ -0,0 +1,189 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import csv
+import shutil
+import textwrap
+import urllib.request
+from dataclasses import dataclass
+from typing import Any, Dict, List, Type, Union
+
+from components.klipper.klipper import Klipper
+from components.klipper.klipper_dialogs import (
+ DisplayType,
+ print_instance_overview,
+)
+from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
+from core.instance_manager.base_instance import BaseInstance
+from core.instance_type import InstanceType
+from core.logger import Logger
+from core.menus import Option
+from core.menus.base_menu import BaseMenu
+from extensions.base_extension import BaseExtension
+from utils.git_utils import git_clone_wrapper
+from utils.input_utils import get_selection_input
+from utils.instance_utils import get_instances
+
+
+@dataclass
+class ThemeData:
+ name: str
+ short_note: str
+ author: str
+ repo: str
+
+
+# noinspection PyMethodMayBeStatic
+class MainsailThemeInstallerExtension(BaseExtension):
+ instances: List[Klipper] = get_instances(Klipper)
+
+ def install_extension(self, **kwargs) -> None:
+ MainsailThemeInstallMenu(self.instances).run()
+
+ def remove_extension(self, **kwargs) -> None:
+ print_instance_overview(
+ self.instances,
+ display_type=DisplayType.PRINTER_NAME,
+ show_headline=True,
+ show_index=True,
+ show_select_all=True,
+ )
+ printer_list = get_printer_selection(self.instances, True)
+ if printer_list is None:
+ return
+
+ for printer in printer_list:
+ Logger.print_status(f"Uninstalling theme from {printer.cfg_dir} ...")
+ theme_dir = printer.cfg_dir.joinpath(".theme")
+ if not theme_dir.exists():
+ Logger.print_info(f"{theme_dir} not found. Skipping ...")
+ continue
+ try:
+ shutil.rmtree(theme_dir)
+ Logger.print_ok("Theme successfully uninstalled!")
+ except OSError as e:
+ Logger.print_error("Unable to uninstall theme")
+ Logger.print_error(e)
+
+
+# noinspection PyMethodMayBeStatic
+class MainsailThemeInstallMenu(BaseMenu):
+ THEMES_URL: str = (
+ "https://raw.githubusercontent.com/mainsail-crew/gb-docs/main/_data/themes.csv"
+ )
+
+ def __init__(self, instances: List[Klipper]):
+ super().__init__()
+ self.themes: List[ThemeData] = self.load_themes()
+ self.instances = instances
+
+ def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
+ from extensions.extensions_menu import ExtensionsMenu
+
+ self.previous_menu = (
+ previous_menu if previous_menu is not None else ExtensionsMenu
+ )
+
+ def set_options(self) -> None:
+ self.options = {
+ f"{index}": Option(self.install_theme, opt_index=f"{index}")
+ for index in range(len(self.themes))
+ }
+
+ def print_menu(self) -> None:
+ header = " [ Mainsail Theme Installer ] "
+ color = COLOR_YELLOW
+ line1 = f"{COLOR_CYAN}A preview of each Mainsail theme can be found here:{RESET_FORMAT}"
+ count = 62 - len(color) - len(RESET_FORMAT)
+ menu = textwrap.dedent(
+ f"""
+ ╔═══════════════════════════════════════════════════════╗
+ ║ {color}{header:~^{count}}{RESET_FORMAT} ║
+ ╟───────────────────────────────────────────────────────╢
+ ║ {line1:<62} ║
+ ║ https://docs.mainsail.xyz/theming/themes ║
+ ╟───────────────────────────────────────────────────────╢
+ """
+ )[1:]
+ for i, theme in enumerate(self.themes):
+ j: str = f" {i}" if i < 10 else f"{i}"
+ row: str = f"{j}) [{theme.name}]"
+ menu += f"║ {row:<53} ║\n"
+ print(menu, end="")
+
+ def load_themes(self) -> List[ThemeData]:
+ with urllib.request.urlopen(self.THEMES_URL) as response:
+ themes: List[ThemeData] = []
+ content: str = response.read().decode()
+ csv_data: List[str] = content.splitlines()
+ fieldnames = ["name", "short_note", "author", "repo"]
+ csv_reader = csv.DictReader(csv_data, fieldnames=fieldnames, delimiter=",")
+ next(csv_reader) # skip the header of the csv file
+ for row in csv_reader:
+ row: Dict[str, str] # type: ignore
+ theme: ThemeData = ThemeData(**row)
+ themes.append(theme)
+
+ return themes
+
+ def install_theme(self, **kwargs: Any):
+ opt_index: str | None = kwargs.get("opt_index", None)
+
+ if not opt_index:
+ raise ValueError("No option index provided")
+
+ index: int = int(opt_index)
+ theme_data: ThemeData = self.themes[index]
+ theme_author: str = theme_data.author
+ theme_repo: str = theme_data.repo
+ theme_repo_url: str = f"https://github.com/{theme_author}/{theme_repo}"
+
+ print_instance_overview(
+ self.instances,
+ display_type=DisplayType.PRINTER_NAME,
+ show_headline=True,
+ show_index=True,
+ show_select_all=True,
+ )
+
+ printer_list = get_printer_selection(self.instances, True)
+ if printer_list is None:
+ return
+
+ for printer in printer_list:
+ git_clone_wrapper(theme_repo_url, printer.cfg_dir.joinpath(".theme"))
+
+ if len(theme_data.short_note) > 1:
+ Logger.print_warn("Info from the creator:", prefix=False, start="\n")
+ Logger.print_info(theme_data.short_note, prefix=False, end="\n\n")
+
+
+def get_printer_selection(
+ instances: List[InstanceType], is_install: bool
+) -> Union[List[BaseInstance], None]:
+ options = [str(i) for i in range(len(instances))]
+ options.extend(["a", "b"])
+
+ if is_install:
+ q = "Select the printer to install the theme for"
+ else:
+ q = "Select the printer to remove the theme from"
+ selection = get_selection_input(q, options)
+
+ install_for = []
+ if selection == "b":
+ return None
+ elif selection == "a":
+ install_for.extend(instances)
+ else:
+ instance = instances[int(selection)]
+ install_for.append(instance)
+
+ return install_for
diff --git a/kiauh/extensions/mainsail_theme_installer/metadata.json b/kiauh/extensions/mainsail_theme_installer/metadata.json
new file mode 100644
index 0000000..ffb802a
--- /dev/null
+++ b/kiauh/extensions/mainsail_theme_installer/metadata.json
@@ -0,0 +1,9 @@
+{
+ "metadata": {
+ "index": 2,
+ "module": "mainsail_theme_installer_extension",
+ "maintained_by": "dw-0",
+ "display_name": "Mainsail Theme Installer",
+ "description": ["Install Mainsail Themes maintained by the Mainsail community."]
+ }
+}
diff --git a/kiauh/extensions/obico/__init__.py b/kiauh/extensions/obico/__init__.py
new file mode 100644
index 0000000..a7e8031
--- /dev/null
+++ b/kiauh/extensions/obico/__init__.py
@@ -0,0 +1,34 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from pathlib import Path
+
+MODULE_PATH = Path(__file__).resolve().parent
+
+# repo
+OBICO_REPO = "https://github.com/TheSpaghettiDetective/moonraker-obico.git"
+
+# names
+OBICO_SERVICE_NAME = "moonraker-obico.service"
+OBICO_ENV_FILE_NAME = "moonraker-obico.env"
+OBICO_CFG_NAME = "moonraker-obico.cfg"
+OBICO_CFG_SAMPLE_NAME = "moonraker-obico.cfg.sample"
+OBICO_LOG_NAME = "moonraker-obico.log"
+OBICO_UPDATE_CFG_NAME = "moonraker-obico-update.cfg"
+OBICO_UPDATE_CFG_SAMPLE_NAME = "moonraker-obico-update.cfg.sample"
+OBICO_MACROS_CFG_NAME = "moonraker_obico_macros.cfg"
+
+# directories
+OBICO_DIR = Path.home().joinpath("moonraker-obico")
+OBICO_ENV_DIR = Path.home().joinpath("moonraker-obico-env")
+
+# files
+OBICO_SERVICE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{OBICO_SERVICE_NAME}")
+OBICO_ENV_FILE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{OBICO_ENV_FILE_NAME}")
+OBICO_LINK_SCRIPT = OBICO_DIR.joinpath("scripts/link.sh")
+OBICO_REQ_FILE = OBICO_DIR.joinpath("requirements.txt")
diff --git a/kiauh/extensions/obico/assets/moonraker-obico.env b/kiauh/extensions/obico/assets/moonraker-obico.env
new file mode 100644
index 0000000..3c3d32b
--- /dev/null
+++ b/kiauh/extensions/obico/assets/moonraker-obico.env
@@ -0,0 +1 @@
+OBICO_ARGS="-m moonraker_obico.app -c %CFG%"
diff --git a/kiauh/extensions/obico/assets/moonraker-obico.service b/kiauh/extensions/obico/assets/moonraker-obico.service
new file mode 100644
index 0000000..e6bed45
--- /dev/null
+++ b/kiauh/extensions/obico/assets/moonraker-obico.service
@@ -0,0 +1,16 @@
+#Systemd service file for moonraker-obico
+[Unit]
+Description=Moonraker-Obico
+After=network-online.target moonraker.service
+
+[Install]
+WantedBy=multi-user.target
+
+[Service]
+Type=simple
+User=%USER%
+WorkingDirectory=%OBICO_DIR%
+EnvironmentFile=%ENV_FILE%
+ExecStart=%ENV%/bin/python3 $OBICO_ARGS
+Restart=always
+RestartSec=5
diff --git a/kiauh/extensions/obico/metadata.json b/kiauh/extensions/obico/metadata.json
new file mode 100644
index 0000000..cdf5753
--- /dev/null
+++ b/kiauh/extensions/obico/metadata.json
@@ -0,0 +1,16 @@
+{
+ "metadata": {
+ "index": 6,
+ "module": "moonraker_obico_extension",
+ "maintained_by": "Obico",
+ "display_name": "Obico for Klipper",
+ "description": [
+ "Open source 3D Printing cloud and AI",
+ "- AI-Powered Failure Detection",
+ "- Free Remote Monitoring and Access",
+ "- 25FPS High-Def Webcam Streaming",
+ "- Free 4.9-Star Mobile App"
+ ],
+ "updates": true
+ }
+}
diff --git a/kiauh/extensions/obico/moonraker_obico.py b/kiauh/extensions/obico/moonraker_obico.py
new file mode 100644
index 0000000..0aa248c
--- /dev/null
+++ b/kiauh/extensions/obico/moonraker_obico.py
@@ -0,0 +1,145 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from pathlib import Path
+from subprocess import CalledProcessError, run
+
+from components.moonraker.moonraker import Moonraker
+from core.constants import CURRENT_USER
+from core.instance_manager.base_instance import BaseInstance
+from core.logger import Logger
+from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+ SimpleConfigParser,
+)
+from extensions.obico import (
+ OBICO_CFG_NAME,
+ OBICO_DIR,
+ OBICO_ENV_DIR,
+ OBICO_ENV_FILE_NAME,
+ OBICO_ENV_FILE_TEMPLATE,
+ OBICO_LINK_SCRIPT,
+ OBICO_LOG_NAME,
+ OBICO_SERVICE_TEMPLATE,
+)
+from utils.fs_utils import create_folders
+from utils.sys_utils import get_service_file_path
+
+
+# noinspection PyMethodMayBeStatic
+@dataclass(repr=True)
+class MoonrakerObico:
+ suffix: str
+ base: BaseInstance = field(init=False, repr=False)
+ service_file_path: Path = field(init=False)
+ log_file_name: str = OBICO_LOG_NAME
+ dir: Path = OBICO_DIR
+ env_dir: Path = OBICO_ENV_DIR
+ data_dir: Path = field(init=False)
+ cfg_file: Path = field(init=False)
+ is_linked: bool = False
+
+ def __post_init__(self):
+ self.base: BaseInstance = BaseInstance(Moonraker, self.suffix)
+ self.base.log_file_name = self.log_file_name
+
+ self.service_file_path: Path = get_service_file_path(
+ MoonrakerObico, self.suffix
+ )
+ self.data_dir: Path = self.base.data_dir
+ self.cfg_file = self.base.cfg_dir.joinpath(OBICO_CFG_NAME)
+ self.is_linked: bool = self._check_link_status()
+
+ def create(self) -> None:
+ from utils.sys_utils import create_env_file, create_service_file
+
+ Logger.print_status("Creating new Obico for Klipper Instance ...")
+
+ try:
+ create_folders(self.base.base_folders)
+ create_service_file(
+ name=self.service_file_path.name,
+ content=self._prep_service_file_content(),
+ )
+ create_env_file(
+ path=self.base.sysd_dir.joinpath(OBICO_ENV_FILE_NAME),
+ content=self._prep_env_file_content(),
+ )
+
+ except CalledProcessError as e:
+ Logger.print_error(f"Error creating instance: {e}")
+ raise
+ except OSError as e:
+ Logger.print_error(f"Error creating env file: {e}")
+ raise
+
+ def link(self) -> None:
+ Logger.print_status(
+ f"Linking instance for printer {self.data_dir.name} to the Obico server ..."
+ )
+ try:
+ cmd = [f"{OBICO_LINK_SCRIPT} -q -c {self.cfg_file}"]
+ if self.suffix:
+ cmd.append(f"-n {self.suffix}")
+ run(cmd, check=True, shell=True)
+ except CalledProcessError as e:
+ Logger.print_error(f"Error during Obico linking: {e}")
+ raise
+
+ def _prep_service_file_content(self) -> str:
+ template = OBICO_SERVICE_TEMPLATE
+
+ try:
+ with open(template, "r") as template_file:
+ template_content = template_file.read()
+ except FileNotFoundError:
+ Logger.print_error(f"Unable to open {template} - File not found")
+ raise
+
+ service_content = template_content.replace(
+ "%USER%",
+ CURRENT_USER,
+ )
+ service_content = service_content.replace(
+ "%OBICO_DIR%",
+ self.dir.as_posix(),
+ )
+ service_content = service_content.replace(
+ "%ENV%",
+ self.env_dir.as_posix(),
+ )
+ service_content = service_content.replace(
+ "%ENV_FILE%",
+ self.base.sysd_dir.joinpath(OBICO_ENV_FILE_NAME).as_posix(),
+ )
+ return service_content
+
+ def _prep_env_file_content(self) -> str:
+ template = OBICO_ENV_FILE_TEMPLATE
+
+ try:
+ with open(template, "r") as env_file:
+ env_template_file_content = env_file.read()
+ except FileNotFoundError:
+ Logger.print_error(f"Unable to open {template} - File not found")
+ raise
+ env_file_content = env_template_file_content.replace(
+ "%CFG%",
+ f"{self.base.cfg_dir}/{self.cfg_file}",
+ )
+ return env_file_content
+
+ def _check_link_status(self) -> bool:
+ if not self.cfg_file or not self.cfg_file.exists():
+ return False
+
+ scp = SimpleConfigParser()
+ scp.read(self.cfg_file)
+ return scp.get("server", "auth_token", None) is not None
diff --git a/kiauh/extensions/obico/moonraker_obico_extension.py b/kiauh/extensions/obico/moonraker_obico_extension.py
new file mode 100644
index 0000000..e19bd53
--- /dev/null
+++ b/kiauh/extensions/obico/moonraker_obico_extension.py
@@ -0,0 +1,367 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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
+
+from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
+from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+ SimpleConfigParser,
+)
+from extensions.base_extension import BaseExtension
+from extensions.obico import (
+ OBICO_CFG_SAMPLE_NAME,
+ OBICO_DIR,
+ OBICO_ENV_DIR,
+ OBICO_MACROS_CFG_NAME,
+ OBICO_REPO,
+ OBICO_REQ_FILE,
+ OBICO_UPDATE_CFG_NAME,
+ OBICO_UPDATE_CFG_SAMPLE_NAME,
+)
+from extensions.obico.moonraker_obico import (
+ MoonrakerObico,
+)
+from utils.common import check_install_dependencies, moonraker_exists
+from utils.config_utils import (
+ add_config_section,
+ remove_config_section,
+)
+from utils.fs_utils import run_remove_routines
+from utils.git_utils import git_clone_wrapper, git_pull_wrapper
+from utils.input_utils import get_confirm, get_selection_input, get_string_input
+from utils.instance_utils import get_instances
+from utils.sys_utils import (
+ cmd_sysctl_manage,
+ cmd_sysctl_service,
+ create_python_venv,
+ install_python_requirements,
+ parse_packages_from_file,
+)
+
+
+# noinspection PyMethodMayBeStatic
+class ObicoExtension(BaseExtension):
+ server_url: str
+
+ def install_extension(self, **kwargs) -> None:
+ Logger.print_status("Installing Obico for Klipper ...")
+
+ # check if moonraker is installed. if not, notify the user and exit
+ if not moonraker_exists():
+ return
+
+ # if obico is already installed, ask if the user wants to repair an
+ # incomplete installation or link to the obico server
+ force_clone = False
+ obico_instances: List[MoonrakerObico] = get_instances(MoonrakerObico)
+ if obico_instances:
+ self._print_is_already_installed()
+ options = ["l", "r", "b"]
+ action = get_selection_input("Perform action", option_list=options)
+ if action.lower() == "b":
+ Logger.print_info("Exiting Obico for Klipper installation ...")
+ return
+ elif action.lower() == "l":
+ unlinked_instances: List[MoonrakerObico] = [
+ obico for obico in obico_instances if not obico.is_linked
+ ]
+ self._link_obico_instances(unlinked_instances)
+ return
+ else:
+ Logger.print_status("Re-Installing Obico for Klipper ...")
+ force_clone = True
+
+ # let the user confirm installation
+ kl_instances: List[Klipper] = get_instances(Klipper)
+ mr_instances: List[Moonraker] = get_instances(Moonraker)
+ self._print_moonraker_instances(mr_instances)
+ if not get_confirm(
+ "Continue Obico for Klipper installation?",
+ default_choice=True,
+ allow_go_back=True,
+ ):
+ return
+
+ try:
+ git_clone_wrapper(OBICO_REPO, OBICO_DIR, force=force_clone)
+ self._install_dependencies()
+
+ # ask the user for the obico server url
+ self._get_server_url()
+
+ # create obico instances
+ for moonraker in mr_instances:
+ instance = MoonrakerObico(suffix=moonraker.suffix)
+ instance.create()
+
+ cmd_sysctl_service(instance.service_file_path.name, "enable")
+
+ # create obico config
+ self._create_obico_cfg(instance, moonraker)
+
+ # create obico macros
+ self._create_obico_macros_cfg(moonraker)
+
+ # create obico update manager
+ self._create_obico_update_manager_cfg(moonraker)
+
+ cmd_sysctl_service(instance.service_file_path.name, "start")
+
+ cmd_sysctl_manage("daemon-reload")
+
+ # add to klippers config
+ self._patch_printer_cfg(kl_instances)
+ InstanceManager.restart_all(kl_instances)
+
+ # add to moonraker update manager
+ self._patch_moonraker_conf(mr_instances)
+ InstanceManager.restart_all(mr_instances)
+
+ # check linking of / ask for linking instances
+ self._check_and_opt_link_instances()
+
+ Logger.print_dialog(
+ DialogType.SUCCESS,
+ ["Obico for Klipper successfully installed!"],
+ center_content=True,
+ )
+
+ except Exception as e:
+ Logger.print_error(f"Error during Obico for Klipper installation:\n{e}")
+
+ def update_extension(self, **kwargs) -> None:
+ Logger.print_status("Updating Obico for Klipper ...")
+ try:
+ instances = get_instances(MoonrakerObico)
+ InstanceManager.stop_all(instances)
+
+ git_pull_wrapper(OBICO_REPO, OBICO_DIR)
+ self._install_dependencies()
+
+ InstanceManager.start_all(instances)
+ Logger.print_ok("Obico for Klipper successfully updated!")
+
+ except Exception as e:
+ Logger.print_error(f"Error during Obico for Klipper update:\n{e}")
+
+ def remove_extension(self, **kwargs) -> None:
+ Logger.print_status("Removing Obico for Klipper ...")
+
+ kl_instances: List[Klipper] = get_instances(Klipper)
+ mr_instances: List[Moonraker] = get_instances(Moonraker)
+ ob_instances: List[MoonrakerObico] = get_instances(MoonrakerObico)
+
+ try:
+ self._remove_obico_instances(ob_instances)
+ self._remove_obico_dir()
+ self._remove_obico_env()
+ remove_config_section(f"include {OBICO_MACROS_CFG_NAME}", kl_instances)
+ remove_config_section(f"include {OBICO_UPDATE_CFG_NAME}", mr_instances)
+ Logger.print_dialog(
+ DialogType.SUCCESS,
+ ["Obico for Klipper successfully removed!"],
+ center_content=True,
+ )
+
+ except Exception as e:
+ Logger.print_error(f"Error during Obico for Klipper removal:\n{e}")
+
+ def _obico_server_url_prompt(self) -> None:
+ Logger.print_dialog(
+ DialogType.CUSTOM,
+ custom_title="Obico Server URL",
+ content=[
+ "You can use a self-hosted Obico Server or the Obico Cloud. "
+ "For more information, please visit:",
+ "https://obico.io.",
+ "\n\n",
+ "For the Obico Cloud, leave it as the default:",
+ "https://app.obico.io.",
+ "\n\n",
+ "For self-hosted server, specify:",
+ "http://server_ip:port",
+ "For instance, 'http://192.168.0.5:3334'.",
+ ],
+ )
+
+ def _print_moonraker_instances(self, mr_instances: List[Moonraker]) -> None:
+ mr_names = [f"● {moonraker.data_dir.name}" for moonraker in mr_instances]
+ if len(mr_names) > 1:
+ Logger.print_dialog(
+ DialogType.INFO,
+ [
+ "The following Moonraker instances were found:",
+ *mr_names,
+ "\n\n",
+ "The setup will apply the same names to Obico!",
+ ],
+ )
+
+ def _print_is_already_installed(self) -> None:
+ Logger.print_dialog(
+ DialogType.INFO,
+ [
+ "Obico is already installed!",
+ "It is safe to run the installer again to link your "
+ "printer or repair any issues.",
+ "\n\n",
+ "You can perform the following actions:",
+ "L) Link printer to the Obico server",
+ "R) Repair installation",
+ ],
+ )
+
+ def _get_server_url(self) -> None:
+ self._obico_server_url_prompt()
+ pattern = r"^(http|https)://[a-zA-Z0-9./?=_%:-]*$"
+ self.server_url = get_string_input(
+ "Obico Server URL",
+ regex=pattern,
+ default="https://app.obico.io",
+ )
+
+ def _install_dependencies(self) -> None:
+ # install dependencies
+ script = OBICO_DIR.joinpath("install.sh")
+ package_list = parse_packages_from_file(script)
+ check_install_dependencies({*package_list})
+
+ # create virtualenv
+ if create_python_venv(OBICO_ENV_DIR):
+ install_python_requirements(OBICO_ENV_DIR, OBICO_REQ_FILE)
+
+ def _create_obico_macros_cfg(self, moonraker: Moonraker) -> None:
+ macros_cfg = OBICO_DIR.joinpath(f"include_cfgs/{OBICO_MACROS_CFG_NAME}")
+ macros_target = moonraker.base.cfg_dir.joinpath(OBICO_MACROS_CFG_NAME)
+ if not macros_target.exists():
+ shutil.copy(macros_cfg, macros_target)
+ else:
+ Logger.print_info(
+ f"Obico's '{OBICO_MACROS_CFG_NAME}' in {moonraker.base.cfg_dir} already exists! Skipped ..."
+ )
+
+ def _create_obico_update_manager_cfg(self, moonraker: Moonraker) -> None:
+ update_cfg = OBICO_DIR.joinpath(OBICO_UPDATE_CFG_SAMPLE_NAME)
+ update_cfg_target = moonraker.base.cfg_dir.joinpath(OBICO_UPDATE_CFG_NAME)
+ if not update_cfg_target.exists():
+ shutil.copy(update_cfg, update_cfg_target)
+ else:
+ Logger.print_info(
+ f"Obico's '{OBICO_UPDATE_CFG_NAME}' in {moonraker.base.cfg_dir} already exists! Skipped ..."
+ )
+
+ def _create_obico_cfg(
+ self, current_instance: MoonrakerObico, moonraker: Moonraker
+ ) -> None:
+ cfg_template = OBICO_DIR.joinpath(OBICO_CFG_SAMPLE_NAME)
+ cfg_target_file = current_instance.cfg_file
+
+ if not cfg_template.exists():
+ Logger.print_error(
+ f"Obico config template file {cfg_target_file} does not exist!"
+ )
+ return
+
+ if not cfg_target_file.exists():
+ shutil.copy(cfg_template, cfg_target_file)
+ self._patch_obico_cfg(moonraker, current_instance)
+ else:
+ Logger.print_info(
+ f"Obico config in {current_instance.base.cfg_dir} already exists! Skipped ..."
+ )
+
+ def _patch_obico_cfg(self, moonraker: Moonraker, obico: MoonrakerObico) -> None:
+ scp = SimpleConfigParser()
+ scp.read(obico.cfg_file)
+ scp.set("server", "url", self.server_url)
+ scp.set("moonraker", "port", str(moonraker.port))
+ scp.set(
+ "logging",
+ "path",
+ obico.base.log_dir.joinpath(obico.log_file_name).as_posix(),
+ )
+ scp.write(obico.cfg_file)
+
+ def _patch_printer_cfg(self, klipper: List[Klipper]) -> None:
+ add_config_section(
+ section=f"include {OBICO_MACROS_CFG_NAME}", instances=klipper
+ )
+
+ def _patch_moonraker_conf(self, instances: List[Moonraker]) -> None:
+ add_config_section(
+ section=f"include {OBICO_UPDATE_CFG_NAME}", instances=instances
+ )
+
+ def _link_obico_instances(self, unlinked_instances) -> None:
+ for obico in unlinked_instances:
+ obico.link()
+
+ def _check_and_opt_link_instances(self) -> None:
+ Logger.print_status("Checking link status of Obico instances ...")
+
+ ob_instances: List[MoonrakerObico] = get_instances(MoonrakerObico)
+ unlinked_instances: List[MoonrakerObico] = [
+ obico for obico in ob_instances if not obico.is_linked
+ ]
+ if unlinked_instances:
+ Logger.print_dialog(
+ DialogType.INFO,
+ [
+ "The Obico instances for the following printers are not "
+ "linked to the server:",
+ *[f"● {obico.data_dir.name}" for obico in unlinked_instances],
+ "\n\n",
+ "It will take only 10 seconds to link the printer to the Obico server.",
+ "For more information visit:",
+ "https://www.obico.io/docs/user-guides/klipper-setup/",
+ "\n\n",
+ "If you don't want to link the printer now, you can restart the "
+ "linking process later by running this installer again.",
+ ],
+ )
+ if not get_confirm("Do you want to link the printers now?"):
+ Logger.print_info("Linking to Obico server skipped ...")
+ return
+
+ self._link_obico_instances(unlinked_instances)
+
+ def _remove_obico_instances(
+ self,
+ instance_list: List[MoonrakerObico],
+ ) -> None:
+ if not instance_list:
+ Logger.print_info("No Obico instances found. Skipped ...")
+ return
+
+ for instance in instance_list:
+ Logger.print_status(
+ f"Removing instance {instance.service_file_path.stem} ..."
+ )
+ InstanceManager.remove(instance)
+
+ def _remove_obico_dir(self) -> None:
+ Logger.print_status("Removing Obico for Klipper directory ...")
+
+ if not OBICO_DIR.exists():
+ Logger.print_info(f"'{OBICO_DIR}' does not exist. Skipped ...")
+ return
+
+ run_remove_routines(OBICO_DIR)
+
+ def _remove_obico_env(self) -> None:
+ Logger.print_status("Removing Obico for Klipper environment ...")
+
+ if not OBICO_ENV_DIR.exists():
+ Logger.print_info(f"'{OBICO_ENV_DIR}' does not exist. Skipped ...")
+ return
+
+ run_remove_routines(OBICO_ENV_DIR)
diff --git a/kiauh/extensions/pretty_gcode/__init__.py b/kiauh/extensions/pretty_gcode/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/kiauh/extensions/pretty_gcode/assets/pgcode.local.conf b/kiauh/extensions/pretty_gcode/assets/pgcode.local.conf
new file mode 100644
index 0000000..eab6162
--- /dev/null
+++ b/kiauh/extensions/pretty_gcode/assets/pgcode.local.conf
@@ -0,0 +1,19 @@
+# PrettyGCode website configuration
+# copy this file to /etc/nginx/sites-available/pgcode.local.conf
+# then to enable:
+# sudo ln -s /etc/nginx/sites-available/pgcode.local.conf /etc/nginx/sites-enabled/pgcode.local.conf
+# then restart ngninx:
+# sudo systemctl reload nginx
+server {
+ listen %PORT%;
+ listen [::]:%PORT%;
+ server_name pgcode.local;
+
+ root %ROOT_DIR%;
+
+ index pgcode.html;
+
+ location / {
+ try_files $uri $uri/ =404;
+ }
+}
diff --git a/kiauh/extensions/pretty_gcode/metadata.json b/kiauh/extensions/pretty_gcode/metadata.json
new file mode 100644
index 0000000..187a429
--- /dev/null
+++ b/kiauh/extensions/pretty_gcode/metadata.json
@@ -0,0 +1,10 @@
+{
+ "metadata": {
+ "index": 5,
+ "module": "pretty_gcode_extension",
+ "maintained_by": "Kragrathea",
+ "display_name": "PrettyGCode for Klipper",
+ "description": ["3D G-Code viewer for Klipper"],
+ "updates": true
+ }
+}
diff --git a/kiauh/extensions/pretty_gcode/pretty_gcode_extension.py b/kiauh/extensions/pretty_gcode/pretty_gcode_extension.py
new file mode 100644
index 0000000..06a0804
--- /dev/null
+++ b/kiauh/extensions/pretty_gcode/pretty_gcode_extension.py
@@ -0,0 +1,101 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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 components.webui_client.client_utils import create_nginx_cfg
+from core.constants import NGINX_SITES_AVAILABLE, NGINX_SITES_ENABLED
+from core.logger import DialogType, Logger
+from extensions.base_extension import BaseExtension
+from utils.common import check_install_dependencies
+from utils.fs_utils import (
+ remove_file,
+)
+from utils.git_utils import git_clone_wrapper, git_pull_wrapper
+from utils.input_utils import get_number_input
+from utils.sys_utils import cmd_sysctl_service, get_ipv4_addr
+
+MODULE_PATH = Path(__file__).resolve().parent
+PGC_DIR = Path.home().joinpath("pgcode")
+PGC_REPO = "https://github.com/Kragrathea/pgcode"
+PGC_CONF = "pgcode.local.conf"
+
+
+# noinspection PyMethodMayBeStatic
+class PrettyGcodeExtension(BaseExtension):
+ def install_extension(self, **kwargs) -> None:
+ Logger.print_status("Installing PrettyGCode for Klipper ...")
+ Logger.print_dialog(
+ DialogType.ATTENTION,
+ [
+ "Make sure you don't select a port which is already in use by "
+ "another application. Your input will not be validated! Choosing a port "
+ "which is already in use by another application may cause issues!",
+ "The default port is 7136.",
+ ],
+ )
+
+ port = get_number_input(
+ "On which port should PrettyGCode run",
+ min_count=0,
+ default=7136,
+ allow_go_back=True,
+ )
+
+ check_install_dependencies({"nginx"})
+
+ try:
+ if PGC_DIR.exists():
+ shutil.rmtree(PGC_DIR)
+
+ git_clone_wrapper(PGC_REPO, PGC_DIR)
+
+ create_nginx_cfg(
+ "PrettyGCode for Klipper",
+ cfg_name=PGC_CONF,
+ template_src=MODULE_PATH.joinpath(f"assets/{PGC_CONF}"),
+ ROOT_DIR=PGC_DIR,
+ PORT=port,
+ )
+
+ cmd_sysctl_service("nginx", "restart")
+
+ log = f"Open PrettyGCode now on: http://{get_ipv4_addr()}:{port}"
+ Logger.print_ok("PrettyGCode installation complete!", start="\n")
+ Logger.print_ok(log, prefix=False, end="\n\n")
+
+ except Exception as e:
+ Logger.print_error(
+ f"Error during PrettyGCode for Klipper installation: {e}"
+ )
+
+ def update_extension(self, **kwargs) -> None:
+ Logger.print_status("Updating PrettyGCode for Klipper ...")
+ try:
+ git_pull_wrapper(PGC_REPO, PGC_DIR)
+
+ except Exception as e:
+ Logger.print_error(f"Error during PrettyGCode for Klipper update: {e}")
+
+ def remove_extension(self, **kwargs) -> None:
+ try:
+ Logger.print_status("Removing PrettyGCode for Klipper ...")
+
+ # remove pgc dir
+ shutil.rmtree(PGC_DIR)
+ # remove nginx config
+ remove_file(NGINX_SITES_AVAILABLE.joinpath(PGC_CONF), True)
+ remove_file(NGINX_SITES_ENABLED.joinpath(PGC_CONF), True)
+ # restart nginx
+ cmd_sysctl_service("nginx", "restart")
+
+ Logger.print_ok("PrettyGCode for Klipper removed!")
+
+ except Exception as e:
+ Logger.print_error(f"Error during PrettyGCode for Klipper removal: {e}")
diff --git a/kiauh/extensions/telegram_bot/__init__.py b/kiauh/extensions/telegram_bot/__init__.py
new file mode 100644
index 0000000..2b43fc6
--- /dev/null
+++ b/kiauh/extensions/telegram_bot/__init__.py
@@ -0,0 +1,29 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from pathlib import Path
+
+MODULE_PATH = Path(__file__).resolve().parent
+
+# repo
+TG_BOT_REPO = "https://github.com/nlef/moonraker-telegram-bot.git"
+
+# names
+TG_BOT_CFG_NAME = "telegram.conf"
+TG_BOT_LOG_NAME = "telegram.log"
+TG_BOT_SERVICE_NAME = "moonraker-telegram-bot.service"
+TG_BOT_ENV_FILE_NAME = "moonraker-telegram-bot.env"
+
+# directories
+TG_BOT_DIR = Path.home().joinpath("moonraker-telegram-bot")
+TG_BOT_ENV = Path.home().joinpath("moonraker-telegram-bot-env")
+
+# files
+TG_BOT_SERVICE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{TG_BOT_SERVICE_NAME}")
+TG_BOT_ENV_FILE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{TG_BOT_ENV_FILE_NAME}")
+TG_BOT_REQ_FILE = TG_BOT_DIR.joinpath("scripts/requirements.txt")
diff --git a/kiauh/extensions/telegram_bot/assets/moonraker-telegram-bot.env b/kiauh/extensions/telegram_bot/assets/moonraker-telegram-bot.env
new file mode 100644
index 0000000..280f165
--- /dev/null
+++ b/kiauh/extensions/telegram_bot/assets/moonraker-telegram-bot.env
@@ -0,0 +1 @@
+TELEGRAM_BOT_ARGS="%TELEGRAM_BOT_DIR%/bot/main.py -c %CFG% -l %LOG%"
\ No newline at end of file
diff --git a/kiauh/extensions/telegram_bot/assets/moonraker-telegram-bot.service b/kiauh/extensions/telegram_bot/assets/moonraker-telegram-bot.service
new file mode 100644
index 0000000..567481d
--- /dev/null
+++ b/kiauh/extensions/telegram_bot/assets/moonraker-telegram-bot.service
@@ -0,0 +1,16 @@
+[Unit]
+Description=Moonraker Telegram Bot SV1 %INST%
+Documentation=https://github.com/nlef/moonraker-telegram-bot/wiki
+After=network-online.target
+
+[Install]
+WantedBy=multi-user.target
+
+[Service]
+Type=simple
+User=%USER%
+WorkingDirectory=%TELEGRAM_BOT_DIR%
+EnvironmentFile=%ENV_FILE%
+ExecStart=%ENV%/bin/python $TELEGRAM_BOT_ARGS
+Restart=always
+RestartSec=10
diff --git a/kiauh/extensions/telegram_bot/metadata.json b/kiauh/extensions/telegram_bot/metadata.json
new file mode 100644
index 0000000..35b72ae
--- /dev/null
+++ b/kiauh/extensions/telegram_bot/metadata.json
@@ -0,0 +1,11 @@
+{
+ "metadata": {
+ "index": 4,
+ "module": "moonraker_telegram_bot_extension",
+ "maintained_by": "nlef",
+ "display_name": "Moonraker Telegram Bot",
+ "description": ["Control your printer with the Telegram messenger app."],
+ "project_url": "https://github.com/nlef/moonraker-telegram-bot",
+ "updates": true
+ }
+}
diff --git a/kiauh/extensions/telegram_bot/moonraker_telegram_bot.py b/kiauh/extensions/telegram_bot/moonraker_telegram_bot.py
new file mode 100644
index 0000000..51116de
--- /dev/null
+++ b/kiauh/extensions/telegram_bot/moonraker_telegram_bot.py
@@ -0,0 +1,127 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from pathlib import Path
+from subprocess import CalledProcessError
+
+from components.moonraker.moonraker import Moonraker
+from core.constants import CURRENT_USER
+from core.instance_manager.base_instance import BaseInstance
+from core.logger import Logger
+from extensions.telegram_bot import (
+ TG_BOT_CFG_NAME,
+ TG_BOT_DIR,
+ TG_BOT_ENV,
+ TG_BOT_ENV_FILE_NAME,
+ TG_BOT_ENV_FILE_TEMPLATE,
+ TG_BOT_LOG_NAME,
+ TG_BOT_SERVICE_TEMPLATE,
+)
+from utils.fs_utils import create_folders
+from utils.sys_utils import get_service_file_path
+
+
+# noinspection PyMethodMayBeStatic
+@dataclass(repr=True)
+class MoonrakerTelegramBot:
+ suffix: str
+ base: BaseInstance = field(init=False, repr=False)
+ service_file_path: Path = field(init=False)
+ log_file_name: str = TG_BOT_LOG_NAME
+ bot_dir: Path = TG_BOT_DIR
+ env_dir: Path = TG_BOT_ENV
+ data_dir: Path = field(init=False)
+ cfg_file: Path = field(init=False)
+
+ def __post_init__(self):
+ self.base: BaseInstance = BaseInstance(Moonraker, self.suffix)
+ self.base.log_file_name = self.log_file_name
+
+ self.service_file_path: Path = get_service_file_path(
+ MoonrakerTelegramBot, self.suffix
+ )
+ self.data_dir: Path = self.base.data_dir
+ self.cfg_file = self.base.cfg_dir.joinpath(TG_BOT_CFG_NAME)
+
+ def create(self) -> None:
+ from utils.sys_utils import create_env_file, create_service_file
+
+ Logger.print_status("Creating new Moonraker Telegram Bot Instance ...")
+
+ try:
+ create_folders(self.base.base_folders)
+ create_service_file(
+ name=self.service_file_path.name,
+ content=self._prep_service_file_content(),
+ )
+ create_env_file(
+ path=self.base.sysd_dir.joinpath(TG_BOT_ENV_FILE_NAME),
+ content=self._prep_env_file_content(),
+ )
+
+ except CalledProcessError as e:
+ Logger.print_error(f"Error creating instance: {e}")
+ raise
+ except OSError as e:
+ Logger.print_error(f"Error creating env file: {e}")
+ raise
+
+ def _prep_service_file_content(self) -> str:
+ template = TG_BOT_SERVICE_TEMPLATE
+
+ try:
+ with open(template, "r") as template_file:
+ template_content = template_file.read()
+ except FileNotFoundError:
+ Logger.print_error(f"Unable to open {template} - File not found")
+ raise
+
+ service_content = template_content.replace(
+ "%USER%",
+ CURRENT_USER,
+ )
+ service_content = service_content.replace(
+ "%TELEGRAM_BOT_DIR%",
+ self.bot_dir.as_posix(),
+ )
+ service_content = service_content.replace(
+ "%ENV%",
+ self.env_dir.as_posix(),
+ )
+ service_content = service_content.replace(
+ "%ENV_FILE%",
+ self.base.sysd_dir.joinpath(TG_BOT_ENV_FILE_NAME).as_posix(),
+ )
+ return service_content
+
+ def _prep_env_file_content(self) -> str:
+ template = TG_BOT_ENV_FILE_TEMPLATE
+
+ try:
+ with open(template, "r") as env_file:
+ env_template_file_content = env_file.read()
+ except FileNotFoundError:
+ Logger.print_error(f"Unable to open {template} - File not found")
+ raise
+
+ env_file_content = env_template_file_content.replace(
+ "%TELEGRAM_BOT_DIR%",
+ self.bot_dir.as_posix(),
+ )
+ env_file_content = env_file_content.replace(
+ "%CFG%",
+ f"{self.base.cfg_dir}/printer.cfg",
+ )
+ env_file_content = env_file_content.replace(
+ "%LOG%",
+ self.base.log_dir.joinpath(self.log_file_name).as_posix(),
+ )
+ return env_file_content
diff --git a/kiauh/extensions/telegram_bot/moonraker_telegram_bot_extension.py b/kiauh/extensions/telegram_bot/moonraker_telegram_bot_extension.py
new file mode 100644
index 0000000..7bbc749
--- /dev/null
+++ b/kiauh/extensions/telegram_bot/moonraker_telegram_bot_extension.py
@@ -0,0 +1,225 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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 subprocess import run
+from typing import List
+
+from components.moonraker.moonraker import Moonraker
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
+from extensions.base_extension import BaseExtension
+from extensions.telegram_bot import TG_BOT_REPO, TG_BOT_REQ_FILE
+from extensions.telegram_bot.moonraker_telegram_bot import (
+ TG_BOT_DIR,
+ TG_BOT_ENV,
+ MoonrakerTelegramBot,
+)
+from utils.common import check_install_dependencies
+from utils.config_utils import add_config_section, remove_config_section
+from utils.fs_utils import remove_file
+from utils.git_utils import git_clone_wrapper, git_pull_wrapper
+from utils.input_utils import get_confirm
+from utils.instance_utils import get_instances
+from utils.sys_utils import (
+ cmd_sysctl_manage,
+ cmd_sysctl_service,
+ create_python_venv,
+ install_python_requirements,
+ parse_packages_from_file,
+)
+
+
+# noinspection PyMethodMayBeStatic
+class TelegramBotExtension(BaseExtension):
+ def install_extension(self, **kwargs) -> None:
+ Logger.print_status("Installing Moonraker Telegram Bot ...")
+
+ mr_instances: List[Moonraker] = get_instances(Moonraker)
+ if not mr_instances:
+ Logger.print_dialog(
+ DialogType.WARNING,
+ [
+ "No Moonraker instances found!",
+ "Moonraker Telegram Bot requires Moonraker to be installed. "
+ "Please install Moonraker first!",
+ ],
+ )
+ return
+
+ instance_names = [
+ f"● {instance.service_file_path.name}" for instance in mr_instances
+ ]
+ Logger.print_dialog(
+ DialogType.INFO,
+ [
+ "The following Moonraker instances were found:",
+ *instance_names,
+ "\n\n",
+ "The setup will apply the same names to Telegram Bot!",
+ ],
+ )
+ if not get_confirm(
+ "Continue Moonraker Telegram Bot installation?",
+ default_choice=True,
+ allow_go_back=True,
+ ):
+ return
+
+ create_example_cfg = get_confirm("Create example telegram.conf?")
+
+ try:
+ git_clone_wrapper(TG_BOT_REPO, TG_BOT_DIR)
+ self._install_dependencies()
+
+ # create and start services / create bot configs
+ show_config_dialog = False
+ tb_names = [mr_i.suffix for mr_i in mr_instances]
+ for name in tb_names:
+ instance = MoonrakerTelegramBot(suffix=name)
+ instance.create()
+
+ cmd_sysctl_service(instance.service_file_path.name, "enable")
+
+ if create_example_cfg:
+ Logger.print_status(
+ f"Creating Telegram Bot config in {instance.base.cfg_dir} ..."
+ )
+ template = TG_BOT_DIR.joinpath("scripts/base_install_template")
+ target_file = instance.cfg_file
+ if not target_file.exists():
+ show_config_dialog = True
+ run(["cp", template, target_file], check=True)
+ else:
+ Logger.print_info(
+ f"Telegram Bot config in {instance.base.cfg_dir} already exists! Skipped ..."
+ )
+
+ cmd_sysctl_service(instance.service_file_path.name, "start")
+
+ cmd_sysctl_manage("daemon-reload")
+
+ # add to moonraker update manager
+ self._patch_bot_update_manager(mr_instances)
+
+ # restart moonraker
+ InstanceManager.restart_all(mr_instances)
+
+ if show_config_dialog:
+ Logger.print_dialog(
+ DialogType.ATTENTION,
+ [
+ "During the installation of the Moonraker Telegram Bot, "
+ "a basic config was created per instance. You need to edit the "
+ "config file to set up your Telegram Bot. Please refer to the "
+ "following wiki page for further information:",
+ "https://github.com/nlef/moonraker-telegram-bot/wiki",
+ ],
+ margin_bottom=1,
+ )
+
+ Logger.print_ok("Telegram Bot installation complete!")
+ except Exception as e:
+ Logger.print_error(
+ f"Error during installation of Moonraker Telegram Bot:\n{e}"
+ )
+
+ def update_extension(self, **kwargs) -> None:
+ Logger.print_status("Updating Moonraker Telegram Bot ...")
+
+ instances = get_instances(MoonrakerTelegramBot)
+ InstanceManager.stop_all(instances)
+
+ git_pull_wrapper(TG_BOT_REPO, TG_BOT_DIR)
+ self._install_dependencies()
+
+ InstanceManager.start_all(instances)
+
+ def remove_extension(self, **kwargs) -> None:
+ Logger.print_status("Removing Moonraker Telegram Bot ...")
+
+ mr_instances: List[Moonraker] = get_instances(Moonraker)
+ tb_instances: List[MoonrakerTelegramBot] = get_instances(MoonrakerTelegramBot)
+
+ try:
+ self._remove_bot_instances(tb_instances)
+ self._remove_bot_dir()
+ self._remove_bot_env()
+ remove_config_section("update_manager moonraker-telegram-bot", mr_instances)
+ self._delete_bot_logs(tb_instances)
+ except Exception as e:
+ Logger.print_error(f"Error during removal of Moonraker Telegram Bot:\n{e}")
+
+ Logger.print_ok("Moonraker Telegram Bot removed!")
+
+ def _install_dependencies(self) -> None:
+ # install dependencies
+ script = TG_BOT_DIR.joinpath("scripts/install.sh")
+ package_list = parse_packages_from_file(script)
+ check_install_dependencies({*package_list})
+
+ # create virtualenv
+ if create_python_venv(TG_BOT_ENV):
+ install_python_requirements(TG_BOT_ENV, TG_BOT_REQ_FILE)
+
+ def _patch_bot_update_manager(self, instances: List[Moonraker]) -> None:
+ env_py = f"{TG_BOT_ENV}/bin/python"
+ add_config_section(
+ section="update_manager moonraker-telegram-bot",
+ instances=instances,
+ options=[
+ ("type", "git_repo"),
+ ("path", str(TG_BOT_DIR)),
+ ("orgin", TG_BOT_REPO),
+ ("env", env_py),
+ ("requirements", "scripts/requirements.txt"),
+ ("install_script", "scripts/install.sh"),
+ ],
+ )
+
+ def _remove_bot_instances(
+ self,
+ instance_list: List[MoonrakerTelegramBot],
+ ) -> None:
+ for instance in instance_list:
+ Logger.print_status(
+ f"Removing instance {instance.service_file_path.stem} ..."
+ )
+ InstanceManager.remove(instance)
+
+ def _remove_bot_dir(self) -> None:
+ if not TG_BOT_DIR.exists():
+ Logger.print_info(f"'{TG_BOT_DIR}' does not exist. Skipped ...")
+ return
+
+ try:
+ shutil.rmtree(TG_BOT_DIR)
+ except OSError as e:
+ Logger.print_error(f"Unable to delete '{TG_BOT_DIR}':\n{e}")
+
+ def _remove_bot_env(self) -> None:
+ if not TG_BOT_ENV.exists():
+ Logger.print_info(f"'{TG_BOT_ENV}' does not exist. Skipped ...")
+ return
+
+ try:
+ shutil.rmtree(TG_BOT_ENV)
+ except OSError as e:
+ Logger.print_error(f"Unable to delete '{TG_BOT_ENV}':\n{e}")
+
+ def _delete_bot_logs(self, instances: List[MoonrakerTelegramBot]) -> None:
+ all_logfiles = []
+ for instance in instances:
+ all_logfiles = list(instance.base.log_dir.glob("telegram_bot.log*"))
+ if not all_logfiles:
+ Logger.print_info("No Moonraker Telegram Bot logs found. Skipped ...")
+ return
+
+ for log in all_logfiles:
+ Logger.print_status(f"Remove '{log}'")
+ remove_file(log)
diff --git a/kiauh/main.py b/kiauh/main.py
new file mode 100644
index 0000000..7844505
--- /dev/null
+++ b/kiauh/main.py
@@ -0,0 +1,20 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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 core.logger import Logger
+from core.menus.main_menu import MainMenu
+from core.settings.kiauh_settings import KiauhSettings
+
+
+def main() -> None:
+ try:
+ KiauhSettings()
+ MainMenu().run()
+ except KeyboardInterrupt:
+ Logger.print_ok("\nHappy printing!\n", prefix=False)
diff --git a/kiauh/procedures/__init__.py b/kiauh/procedures/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/kiauh/procedures/system.py b/kiauh/procedures/system.py
new file mode 100644
index 0000000..93bf058
--- /dev/null
+++ b/kiauh/procedures/system.py
@@ -0,0 +1,103 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+
+from pathlib import Path
+from subprocess import PIPE, CalledProcessError, run
+
+from core.logger import DialogType, Logger
+from utils.common import check_install_dependencies, get_current_date
+from utils.fs_utils import check_file_exist
+from utils.input_utils import get_confirm, get_string_input
+
+
+def change_system_hostname() -> None:
+ """
+ Procedure to change the system hostname.
+ :return:
+ """
+
+ Logger.print_dialog(
+ DialogType.CUSTOM,
+ [
+ "Changing the hostname of this system allows you to access an installed "
+ "webinterface by simply typing the hostname like this in the browser:",
+ "\n\n",
+ "http://.local",
+ "\n\n",
+ "Example: If you set your hostname to 'my-printer', you can access an "
+ "installed webinterface by tyoing 'http://my-printer.local' in the "
+ "browser.",
+ ],
+ custom_title="CHANGE SYSTEM HOSTNAME",
+ )
+ if not get_confirm("Do you want to change the hostname?", default_choice=False):
+ return
+
+ Logger.print_dialog(
+ DialogType.CUSTOM,
+ [
+ "Allowed characters: a-z, 0-9 and '-'",
+ "The name must not contain the following:",
+ "\n\n",
+ "● Any special characters",
+ "● No leading or trailing '-'",
+ ],
+ )
+ hostname = get_string_input(
+ "Enter the new hostname",
+ regex="^[a-z0-9]+([a-z0-9-]*[a-z0-9])?$",
+ )
+ if not get_confirm(f"Change the hostname to '{hostname}'?", default_choice=False):
+ Logger.print_info("Aborting hostname change ...")
+ return
+
+ try:
+ Logger.print_status("Changing hostname ...")
+
+ Logger.print_status("Checking for dependencies ...")
+ check_install_dependencies({"avahi-daemon"}, include_global=False)
+
+ # create or backup hosts file
+ Logger.print_status("Creating backup of hosts file ...")
+ hosts_file = Path("/etc/hosts")
+ if not check_file_exist(hosts_file, True):
+ cmd = ["sudo", "touch", hosts_file.as_posix()]
+ run(cmd, stderr=PIPE, check=True)
+ else:
+ date_time = get_current_date()
+ name = f"hosts.{date_time.get('date')}-{date_time.get('time')}.bak"
+ hosts_file_backup = Path(f"/etc/{name}")
+ cmd = [
+ "sudo",
+ "cp",
+ hosts_file.as_posix(),
+ hosts_file_backup.as_posix(),
+ ]
+ run(cmd, stderr=PIPE, check=True)
+ Logger.print_ok()
+
+ # call hostnamectl set-hostname
+ Logger.print_status(f"Setting hostname to '{hostname}' ...")
+ cmd = ["sudo", "hostnamectl", "set-hostname", hostname]
+ run(cmd, stderr=PIPE, check=True)
+ Logger.print_ok()
+
+ # add hostname to hosts file at the end of the file
+ Logger.print_status("Writing new hostname to /etc/hosts ...")
+ stdin = f"127.0.0.1 {hostname}\n"
+ cmd = ["sudo", "tee", "-a", hosts_file.as_posix()]
+ run(cmd, input=stdin.encode(), stderr=PIPE, stdout=PIPE, check=True)
+ Logger.print_ok()
+
+ Logger.print_ok("New hostname successfully configured!")
+ Logger.print_ok("Remember to reboot for the changes to take effect!\n")
+
+ except CalledProcessError as e:
+ Logger.print_error(f"Error during change hostname procedure: {e}")
+ return
diff --git a/kiauh/utils/__init__.py b/kiauh/utils/__init__.py
new file mode 100644
index 0000000..371c365
--- /dev/null
+++ b/kiauh/utils/__init__.py
@@ -0,0 +1,12 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# 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
diff --git a/kiauh/utils/common.py b/kiauh/utils/common.py
new file mode 100644
index 0000000..7c0ba22
--- /dev/null
+++ b/kiauh/utils/common.py
@@ -0,0 +1,177 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import re
+from datetime import datetime
+from pathlib import Path
+from typing import Dict, List, Literal, Optional, Set
+
+from components.klipper.klipper import Klipper
+from core.constants import (
+ COLOR_CYAN,
+ GLOBAL_DEPS,
+ PRINTER_CFG_BACKUP_DIR,
+ RESET_FORMAT,
+)
+from core.logger import DialogType, Logger
+from core.types import ComponentStatus, StatusCode
+from utils.git_utils import (
+ get_local_commit,
+ get_local_tags,
+ get_remote_commit,
+ get_repo_name,
+)
+from utils.instance_utils import get_instances
+from utils.sys_utils import (
+ check_package_install,
+ install_system_packages,
+ update_system_package_lists,
+)
+
+
+def get_kiauh_version() -> str:
+ """
+ Helper method to get the current KIAUH version by reading the latest tag
+ :return: string of the latest tag
+ """
+ return get_local_tags(Path(__file__).parent.parent)[-1]
+
+
+def convert_camelcase_to_kebabcase(name: str) -> str:
+ return re.sub(r"(? 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: Set[str] | None = None, include_global: bool = True
+) -> None:
+ """
+ Common helper method to check if dependencies are installed
+ and if not, install them automatically |
+ :param include_global: Wether to include the global dependencies or not
+ :param deps: List of strings of package names to check if installed
+ :return: None
+ """
+ if deps is None:
+ deps = set()
+
+ if include_global:
+ deps.update(GLOBAL_DEPS)
+
+ requirements = check_package_install(deps)
+ if requirements:
+ Logger.print_status("Installing dependencies ...")
+ Logger.print_info("The following packages need installation:")
+ for r in requirements:
+ print(f"{COLOR_CYAN}● {r}{RESET_FORMAT}")
+ update_system_package_lists(silent=False)
+ install_system_packages(requirements)
+
+
+def get_install_status(
+ repo_dir: Path,
+ env_dir: Optional[Path] = None,
+ instance_type: type | None = None,
+ files: Optional[List[Path]] = None,
+) -> ComponentStatus:
+ """
+ Helper method to get the installation status of software components
+ :param repo_dir: the repository directory
+ :param env_dir: the python environment directory
+ :param instance_type: The component type
+ :param files: List of optional files to check for existence
+ :return: Dictionary with status string, statuscode and instance count
+ """
+ from utils.instance_utils import get_instances
+
+ checks = [repo_dir.exists()]
+
+ if env_dir is not None:
+ checks.append(env_dir.exists())
+
+ instances = 0
+ if instance_type is not None:
+ instances = len(get_instances(instance_type))
+ checks.append(instances > 0)
+
+ if files is not None:
+ for f in files:
+ checks.append(f.exists())
+
+ status: StatusCode
+ if all(checks):
+ status = 2 # installed
+ elif not any(checks):
+ status = 0 # not installed
+ else:
+ status = 1 # incomplete
+
+ return ComponentStatus(
+ status=status,
+ instances=instances,
+ repo=get_repo_name(repo_dir),
+ local=get_local_commit(repo_dir),
+ remote=get_remote_commit(repo_dir),
+ )
+
+
+def backup_printer_config_dir() -> None:
+ # local import to prevent circular import
+ from core.backup_manager.backup_manager import BackupManager
+
+ instances: List[Klipper] = get_instances(Klipper)
+ bm = BackupManager()
+
+ for instance in instances:
+ name = f"config-{instance.data_dir.name}"
+ bm.backup_directory(
+ name,
+ source=instance.base.cfg_dir,
+ target=PRINTER_CFG_BACKUP_DIR,
+ )
+
+
+def moonraker_exists(name: str = "") -> bool:
+ """
+ Helper method to check if a Moonraker instance exists
+ :param name: Optional name of an installer where the check is performed
+ :return: True if at least one Moonraker instance exists, False otherwise
+ """
+ from components.moonraker.moonraker import Moonraker
+
+ mr_instances: List[Moonraker] = get_instances(Moonraker)
+
+ info = (
+ f"{name} requires Moonraker to be installed"
+ if name
+ else "A Moonraker installation is required"
+ )
+
+ if not mr_instances:
+ Logger.print_dialog(
+ DialogType.WARNING,
+ [
+ "No Moonraker instances found!",
+ f"{info}. Please install Moonraker first!",
+ ],
+ )
+ return False
+ return True
diff --git a/kiauh/utils/config_utils.py b/kiauh/utils/config_utils.py
new file mode 100644
index 0000000..28f88d9
--- /dev/null
+++ b/kiauh/utils/config_utils.py
@@ -0,0 +1,89 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import tempfile
+from pathlib import Path
+from typing import List, Tuple
+
+from core.instance_type import InstanceType
+from core.logger import Logger
+from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+ SimpleConfigParser,
+)
+
+ConfigOption = Tuple[str, str]
+
+
+def add_config_section(
+ section: str,
+ instances: List[InstanceType],
+ options: List[ConfigOption] | None = None,
+) -> None:
+ for instance in instances:
+ cfg_file = instance.cfg_file
+ Logger.print_status(f"Add section '[{section}]' to '{cfg_file}' ...")
+
+ if not Path(cfg_file).exists():
+ Logger.print_warn(f"'{cfg_file}' not found!")
+ continue
+
+ scp = SimpleConfigParser()
+ scp.read(cfg_file)
+ if scp.has_section(section):
+ Logger.print_info("Section already exist. Skipped ...")
+ continue
+
+ scp.add_section(section)
+
+ if options is not None:
+ for option in reversed(options):
+ scp.set(section, option[0], option[1])
+
+ scp.write(cfg_file)
+
+
+def add_config_section_at_top(section: str, instances: List[InstanceType]) -> None:
+ # TODO: this could be implemented natively in SimpleConfigParser
+ for instance in instances:
+ tmp_cfg = tempfile.NamedTemporaryFile(mode="w", delete=False)
+ tmp_cfg_path = Path(tmp_cfg.name)
+ scp = SimpleConfigParser()
+ scp.read(tmp_cfg_path)
+ scp.add_section(section)
+ scp.write(tmp_cfg_path)
+ tmp_cfg.close()
+
+ cfg_file = instance.cfg_file
+ with open(cfg_file, "r") as org:
+ org_content = org.readlines()
+ with open(tmp_cfg_path, "a") as tmp:
+ tmp.writelines(org_content)
+
+ cfg_file.unlink()
+ tmp_cfg_path.rename(cfg_file)
+
+
+def remove_config_section(section: str, instances: List[InstanceType]) -> None:
+ for instance in instances:
+ cfg_file = instance.cfg_file
+ Logger.print_status(f"Remove section '[{section}]' from '{cfg_file}' ...")
+
+ if not Path(cfg_file).exists():
+ Logger.print_warn(f"'{cfg_file}' not found!")
+ continue
+
+ scp = SimpleConfigParser()
+ scp.read(cfg_file)
+ if not scp.has_section(section):
+ Logger.print_info("Section does not exist. Skipped ...")
+ continue
+
+ scp.remove_section(section)
+ scp.write(cfg_file)
diff --git a/kiauh/utils/fs_utils.py b/kiauh/utils/fs_utils.py
new file mode 100644
index 0000000..095b7fe
--- /dev/null
+++ b/kiauh/utils/fs_utils.py
@@ -0,0 +1,142 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import re
+import shutil
+from pathlib import Path
+from subprocess import DEVNULL, PIPE, CalledProcessError, check_output, run
+from typing import List
+from zipfile import ZipFile
+
+from core.decorators import deprecated
+from core.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.as_posix()]
+ check_output(command, stderr=DEVNULL)
+ return True
+ except 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.as_posix(), target.as_posix()]
+ if sudo:
+ cmd.insert(0, "sudo")
+ run(cmd, stderr=PIPE, check=True)
+ except CalledProcessError as e:
+ Logger.print_error(f"Failed to create symlink: {e}")
+ raise
+
+
+def remove_with_sudo(file: Path) -> None:
+ try:
+ cmd = ["sudo", "rm", "-rf", file.as_posix()]
+ run(cmd, stderr=PIPE, check=True)
+ except CalledProcessError as e:
+ Logger.print_error(f"Failed to remove {file}: {e}")
+ raise
+
+
+@deprecated(info="Use remove_with_sudo instead", replaced_by=remove_with_sudo)
+def remove_file(file_path: Path, sudo=False) -> None:
+ try:
+ cmd = f"{'sudo ' if sudo else ''}rm -f {file_path}"
+ run(cmd, stderr=PIPE, check=True, shell=True)
+ except CalledProcessError as e:
+ log = f"Cannot remove file {file_path}: {e.stderr.decode()}"
+ Logger.print_error(log)
+ raise
+
+
+def run_remove_routines(file: Path) -> None:
+ try:
+ if not file.is_symlink() and not file.exists():
+ Logger.print_info(f"File '{file}' does not exist. Skipped ...")
+ return
+
+ if file.is_dir():
+ shutil.rmtree(file)
+ elif file.is_file() or file.is_symlink():
+ file.unlink()
+ else:
+ raise OSError(f"File '{file}' is neither a file nor a directory!")
+ Logger.print_ok(f"File '{file}' was successfully removed!")
+ except OSError as e:
+ Logger.print_error(f"Unable to delete '{file}':\n{e}")
+ try:
+ Logger.print_info("Trying to remove with sudo ...")
+ remove_with_sudo(file)
+ Logger.print_ok(f"File '{file}' was successfully removed!")
+ except CalledProcessError as e:
+ Logger.print_error(f"Error deleting '{file}' with sudo:\n{e}")
+ Logger.print_error("Remove this directory manually!")
+
+
+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 create_folders(dirs: List[Path]) -> None:
+ try:
+ for _dir in dirs:
+ if _dir.exists():
+ continue
+ _dir.mkdir(exist_ok=True)
+ Logger.print_ok(f"Created directory '{_dir}'!")
+ except OSError as e:
+ Logger.print_error(f"Error creating directories: {e}")
+ raise
+
+
+def get_data_dir(instance_type: type, suffix: str) -> Path:
+ from utils.sys_utils import get_service_file_path
+
+ # if the service file exists, we read the data dir path from it
+ # this also ensures compatibility with pre v6.0.0 instances
+ service_file_path: Path = get_service_file_path(instance_type, suffix)
+ if service_file_path and service_file_path.exists():
+ with open(service_file_path, "r") as service_file:
+ lines = service_file.readlines()
+ for line in lines:
+ pattern = r"^EnvironmentFile=(.+)(/systemd/.+\.env)"
+ match = re.search(pattern, line)
+ if match:
+ return Path(match.group(1))
+
+ if suffix != "":
+ # this is the new data dir naming scheme introduced in v6.0.0
+ return Path.home().joinpath(f"printer_{suffix}_data")
+
+ return Path.home().joinpath("printer_data")
diff --git a/kiauh/utils/git_utils.py b/kiauh/utils/git_utils.py
new file mode 100644
index 0000000..484f1a9
--- /dev/null
+++ b/kiauh/utils/git_utils.py
@@ -0,0 +1,289 @@
+from __future__ import annotations
+
+import json
+import shutil
+import urllib.request
+from http.client import HTTPResponse
+from json import JSONDecodeError
+from pathlib import Path
+from subprocess import DEVNULL, PIPE, CalledProcessError, check_output, run
+from typing import List, Type
+
+from core.instance_manager.instance_manager import InstanceManager
+from core.instance_type import InstanceType
+from core.logger import Logger
+from utils.input_utils import get_confirm, get_number_input
+from utils.instance_utils import get_instances
+
+
+def git_clone_wrapper(
+ repo: str, target_dir: Path, branch: str | None = None, force: bool = False
+) -> None:
+ """
+ Clones a repository from the given URL and checks out the specified branch if given.
+
+ :param repo: The URL of the repository to clone.
+ :param branch: The branch to check out. If None, the default branch will be checked out.
+ :param target_dir: The directory where the repository will be cloned.
+ :param force: Force the cloning of the repository even if it already exists.
+ :return: None
+ """
+ log = f"Cloning repository from '{repo}'"
+ Logger.print_status(log)
+ try:
+ if Path(target_dir).exists():
+ question = f"'{target_dir}' already exists. Overwrite?"
+ if not force and not get_confirm(question, default_choice=False):
+ Logger.print_info("Skip cloning of repository ...")
+ return
+ shutil.rmtree(target_dir)
+
+ git_cmd_clone(repo, target_dir)
+ git_cmd_checkout(branch, target_dir)
+ except 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 git_pull_wrapper(repo: str, target_dir: Path) -> None:
+ """
+ A function that updates a repository using git pull.
+
+ :param repo: The repository to update.
+ :param target_dir: The directory of the repository.
+ :return: None
+ """
+ Logger.print_status(f"Updating repository '{repo}' ...")
+ try:
+ git_cmd_pull(target_dir)
+ except CalledProcessError:
+ log = "An unexpected error occured during updating the repository."
+ Logger.print_error(log)
+ return
+
+
+def get_repo_name(repo: Path) -> str | None:
+ """
+ Helper method to extract the organisation and name of a repository |
+ :param repo: repository to extract the values from
+ :return: String in form of "/" or None
+ """
+ if not repo.exists() or not repo.joinpath(".git").exists():
+ return "-"
+
+ try:
+ cmd = ["git", "-C", repo.as_posix(), "config", "--get", "remote.origin.url"]
+ result: str = check_output(cmd, stderr=DEVNULL).decode(encoding="utf-8")
+ substrings: List[str] = result.strip().split("/")[-2:]
+ return "/".join(substrings).replace(".git", "")
+ except CalledProcessError:
+ return None
+
+
+def get_local_tags(repo_path: Path, _filter: str | None = None) -> List[str]:
+ """
+ Get all tags of a local Git repository
+ :param repo_path: Path to the local Git repository
+ :param _filter: Optional filter to filter the tags by
+ :return: List of tags
+ """
+ try:
+ cmd = ["git", "tag", "-l"]
+
+ if _filter is not None:
+ cmd.append(f"'${_filter}'")
+
+ result: str = check_output(
+ cmd,
+ stderr=DEVNULL,
+ cwd=repo_path.as_posix(),
+ ).decode(encoding="utf-8")
+
+ tags = result.split("\n")
+ return tags[:-1]
+
+ except CalledProcessError:
+ return []
+
+
+def get_remote_tags(repo_path: str) -> List[str]:
+ """
+ Gets the tags of a GitHub repostiory
+ :param repo_path: path of the GitHub repository - e.g. `/`
+ :return: List of tags
+ """
+ try:
+ url = f"https://api.github.com/repos/{repo_path}/tags"
+ with urllib.request.urlopen(url) as r:
+ response: HTTPResponse = r
+ if response.getcode() != 200:
+ Logger.print_error(
+ f"Error retrieving tags: HTTP status code {response.getcode()}"
+ )
+ return []
+
+ data = json.loads(response.read())
+ return [item["name"] for item in data]
+ except (JSONDecodeError, TypeError) as e:
+ Logger.print_error(f"Error while processing the response: {e}")
+ raise
+
+
+def get_latest_remote_tag(repo_path: str) -> str:
+ """
+ Gets the latest stable tag of a GitHub repostiory
+ :param repo_path: path of the GitHub repository - e.g. `/`
+ :return: tag or empty string
+ """
+ try:
+ if len(latest_tag := get_remote_tags(repo_path)) > 0:
+ return latest_tag[0]
+ else:
+ return ""
+ except Exception:
+ raise
+
+
+def get_latest_unstable_tag(repo_path: str) -> str:
+ """
+ Gets the latest unstable (alpha, beta, rc) tag of a GitHub repository
+ :param repo_path: path of the GitHub repository - e.g. `/`
+ :return: tag or empty string
+ """
+ try:
+ if (
+ len(unstable_tags := [t for t in get_remote_tags(repo_path) if "-" in t])
+ > 0
+ ):
+ return unstable_tags[0]
+ else:
+ return ""
+ except Exception:
+ Logger.print_error("Error while getting the latest unstable tag")
+ raise
+
+
+def compare_semver_tags(tag1: str, tag2: str) -> bool:
+ """
+ Compare two semver version strings.
+ Does not support comparing pre-release versions (e.g. 1.0.0-rc.1, 1.0.0-beta.1)
+ :param tag1: First version string
+ :param tag2: Second version string
+ :return: True if tag1 is greater than tag2, False otherwise
+ """
+ if tag1 == tag2:
+ return False
+
+ def parse_version(v):
+ return list(map(int, v[1:].split(".")))
+
+ tag1_parts = parse_version(tag1)
+ tag2_parts = parse_version(tag2)
+
+ max_len = max(len(tag1_parts), len(tag2_parts))
+ tag1_parts += [0] * (max_len - len(tag1_parts))
+ tag2_parts += [0] * (max_len - len(tag2_parts))
+
+ for part1, part2 in zip(tag1_parts, tag2_parts):
+ if part1 != part2:
+ return part1 > part2
+
+ return False
+
+
+def get_local_commit(repo: Path) -> str | None:
+ if not repo.exists() or not repo.joinpath(".git").exists():
+ return None
+
+ try:
+ cmd = f"cd {repo} && git describe HEAD --always --tags | cut -d '-' -f 1,2"
+ return check_output(cmd, shell=True, text=True).strip()
+ except CalledProcessError:
+ return None
+
+
+def get_remote_commit(repo: Path) -> str | None:
+ if not repo.exists() or not repo.joinpath(".git").exists():
+ return None
+
+ try:
+ # get locally checked out branch
+ branch_cmd = f"cd {repo} && git branch | grep -E '\*'"
+ branch = 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 check_output(cmd, shell=True, text=True).strip()
+ except CalledProcessError:
+ return None
+
+
+def git_cmd_clone(repo: str, target_dir: Path) -> None:
+ try:
+ command = ["git", "clone", repo, target_dir.as_posix()]
+ run(command, check=True)
+
+ Logger.print_ok("Clone successful!")
+ except CalledProcessError as e:
+ error = e.stderr.decode() if e.stderr else "Unknown error"
+ log = f"Error cloning repository {repo}: {error}"
+ Logger.print_error(log)
+ raise
+
+
+def git_cmd_checkout(branch: str | None, target_dir: Path) -> None:
+ if branch is None:
+ return
+
+ try:
+ command = ["git", "checkout", f"{branch}"]
+ run(command, cwd=target_dir, check=True)
+
+ Logger.print_ok("Checkout successful!")
+ except CalledProcessError as e:
+ log = f"Error checking out branch {branch}: {e.stderr.decode()}"
+ Logger.print_error(log)
+ raise
+
+
+def git_cmd_pull(target_dir: Path) -> None:
+ try:
+ command = ["git", "pull"]
+ run(command, cwd=target_dir, check=True)
+ except CalledProcessError as e:
+ log = f"Error on git pull: {e.stderr.decode()}"
+ Logger.print_error(log)
+ raise
+
+
+def rollback_repository(repo_dir: Path, instance: Type[InstanceType]) -> None:
+ q1 = "How many commits do you want to roll back"
+ amount = get_number_input(q1, 1, allow_go_back=True)
+
+ instances = get_instances(instance)
+
+ Logger.print_warn("Do not continue if you have ongoing prints!", start="\n")
+ Logger.print_warn(
+ f"All currently running {instance.__name__} services will be stopped!"
+ )
+ if not get_confirm(
+ f"Roll back {amount} commit{'s' if amount > 1 else ''}",
+ default_choice=False,
+ allow_go_back=True,
+ ):
+ Logger.print_info("Aborting roll back ...")
+ return
+
+ InstanceManager.stop_all(instances)
+
+ try:
+ cmd = ["git", "reset", "--hard", f"HEAD~{amount}"]
+ run(cmd, cwd=repo_dir, check=True, stdout=PIPE, stderr=PIPE)
+ Logger.print_ok(f"Rolled back {amount} commits!", start="\n")
+ except CalledProcessError as e:
+ Logger.print_error(f"An error occured during repo rollback:\n{e}")
+
+ InstanceManager.start_all(instances)
diff --git a/kiauh/utils/input_utils.py b/kiauh/utils/input_utils.py
new file mode 100644
index 0000000..3fa5783
--- /dev/null
+++ b/kiauh/utils/input_utils.py
@@ -0,0 +1,172 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import re
+from typing import Dict, List
+
+from core.constants import COLOR_CYAN, INVALID_CHOICE, RESET_FORMAT
+from core.logger import Logger
+
+
+def get_confirm(question: str, default_choice=True, allow_go_back=False) -> 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: int | None = None,
+ default: int | None = None,
+ allow_go_back: bool = False,
+) -> 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 == "" and default is not None:
+ 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,
+ regex: str | None = None,
+ exclude: List[str] | None = None,
+ allow_special_chars: bool = False,
+ default: str | None = None,
+) -> str:
+ """
+ Helper method to get a string input from the user
+ :param question: The question to display
+ :param regex: An optional regex pattern to validate the input against
+ :param exclude: List of strings which are not allowed
+ :param allow_special_chars: Wheter to allow special characters in the input
+ :param default: Optional default value
+ :return: The validated string value
+ """
+ _exclude = [] if exclude is None else exclude
+ _question = format_question(question, default)
+ _pattern = re.compile(regex) if regex is not None else None
+ while True:
+ _input = input(_question)
+
+ if _input.lower() in _exclude:
+ Logger.print_error("This value is already in use/reserved.")
+ elif default is not None and _input == "":
+ return default
+ elif _pattern is not None and _pattern.match(_input):
+ return _input
+ elif allow_special_chars:
+ return _input
+ elif not allow_special_chars and _input.isalnum():
+ return _input
+ else:
+ Logger.print_error(INVALID_CHOICE)
+
+
+def get_selection_input(question: str, option_list: List | Dict, 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().lower()
+
+ if isinstance(option_list, list):
+ if _input in option_list:
+ return _input
+ elif isinstance(option_list, dict):
+ if _input in option_list.keys():
+ return _input
+ else:
+ raise ValueError("Invalid option_list type")
+
+ 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 | None) -> 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
diff --git a/kiauh/utils/instance_utils.py b/kiauh/utils/instance_utils.py
new file mode 100644
index 0000000..b95e99d
--- /dev/null
+++ b/kiauh/utils/instance_utils.py
@@ -0,0 +1,56 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import re
+from pathlib import Path
+from typing import List
+
+from core.constants import SYSTEMD
+from core.instance_manager.base_instance import SUFFIX_BLACKLIST
+from core.instance_type import InstanceType
+
+
+def get_instances(instance_type: type) -> List[InstanceType]:
+ from utils.common import convert_camelcase_to_kebabcase
+
+ if not isinstance(instance_type, type):
+ raise ValueError("instance_type must be a class")
+
+ name = convert_camelcase_to_kebabcase(instance_type.__name__)
+ pattern = re.compile(f"^{name}(-[0-9a-zA-Z]+)?.service$")
+
+ service_list = [
+ Path(SYSTEMD, service)
+ for service in SYSTEMD.iterdir()
+ if pattern.search(service.name)
+ and not any(s in service.name for s in SUFFIX_BLACKLIST)
+ ]
+
+ instance_list = [
+ instance_type(get_instance_suffix(name, service)) for service in service_list
+ ]
+
+ def _sort_instance_list(suffix: int | str | None):
+ if suffix is None:
+ return
+ elif isinstance(suffix, str) and suffix.isdigit():
+ return f"{int(suffix):04}"
+ else:
+ return suffix
+
+ return sorted(instance_list, key=lambda x: _sort_instance_list(x.suffix))
+
+
+def get_instance_suffix(name: str, file_path: Path) -> str:
+ # to get the suffix of the instance, we remove the name of the instance from
+ # the file name, if the remaining part an empty string we return it
+ # otherwise there is and hyphen left, and we return the part after the hyphen
+ suffix = file_path.stem[len(name) :]
+ return suffix[1:] if suffix else ""
diff --git a/kiauh/utils/sys_utils.py b/kiauh/utils/sys_utils.py
new file mode 100644
index 0000000..d2b7534
--- /dev/null
+++ b/kiauh/utils/sys_utils.py
@@ -0,0 +1,528 @@
+# ======================================================================= #
+# Copyright (C) 2020 - 2024 Dominik Willner #
+# #
+# This file is part of KIAUH - Klipper Installation And Update Helper #
+# https://github.com/dw-0/kiauh #
+# #
+# This file may be distributed under the terms of the GNU GPLv3 license #
+# ======================================================================= #
+from __future__ import annotations
+
+import os
+import re
+import select
+import shutil
+import socket
+import sys
+import time
+import urllib.error
+import urllib.request
+from pathlib import Path
+from subprocess import DEVNULL, PIPE, CalledProcessError, Popen, check_output, run
+from typing import List, Literal, Set
+
+from core.constants import SYSTEMD
+from core.logger import Logger
+from utils.fs_utils import check_file_exist, remove_with_sudo
+from utils.input_utils import get_confirm
+
+SysCtlServiceAction = Literal[
+ "start",
+ "stop",
+ "restart",
+ "reload",
+ "enable",
+ "disable",
+ "mask",
+ "unmask",
+]
+SysCtlManageAction = Literal["daemon-reload", "reset-failed"]
+
+
+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 check_python_version(major: int, minor: int) -> bool:
+ """
+ Checks the python version and returns True if it's at least the given version
+ :param major: the major version to check
+ :param minor: the minor version to check
+ :return: bool
+ """
+ if not (sys.version_info.major >= major and sys.version_info.minor >= minor):
+ Logger.print_error("Versioncheck failed!")
+ Logger.print_error(f"Python {major}.{minor} or newer required.")
+ return False
+ return True
+
+
+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 = []
+ 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) -> bool:
+ """
+ Create a python 3 virtualenv at the provided target destination.
+ Returns True if the virtualenv was created successfully.
+ Returns False if the virtualenv already exists, recreation was declined or creation failed.
+ :param target: Path where to create the virtualenv at
+ :return: bool
+ """
+ Logger.print_status("Set up Python virtual environment ...")
+ if not target.exists():
+ try:
+ cmd = ["virtualenv", "-p", "/usr/bin/python3", target.as_posix()]
+ run(cmd, check=True)
+ Logger.print_ok("Setup of virtualenv successful!")
+ return True
+ except CalledProcessError as e:
+ Logger.print_error(f"Error setting up virtualenv:\n{e}")
+ return False
+ else:
+ if not get_confirm(
+ "Virtualenv already exists. Re-create?", default_choice=False
+ ):
+ Logger.print_info("Skipping re-creation of virtualenv ...")
+ return False
+
+ try:
+ shutil.rmtree(target)
+ create_python_venv(target)
+ return True
+ except OSError as e:
+ log = f"Error removing existing virtualenv: {e.strerror}"
+ Logger.print_error(log, False)
+ return False
+
+
+def update_python_pip(target: Path) -> None:
+ """
+ Updates pip in the provided target destination |
+ :param target: Path of the virtualenv
+ :return: None
+ """
+ Logger.print_status("Updating pip ...")
+ try:
+ pip_location: Path = target.joinpath("bin/pip")
+ pip_exists: bool = check_file_exist(pip_location)
+
+ if not pip_exists:
+ raise FileNotFoundError("Error updating pip! Not found.")
+
+ command = [pip_location.as_posix(), "install", "-U", "pip"]
+ result = run(command, stderr=PIPE, text=True)
+ if result.returncode != 0 or result.stderr:
+ Logger.print_error(f"{result.stderr}", False)
+ Logger.print_error("Updating pip failed!")
+ return
+
+ Logger.print_ok("Updating pip successful!")
+ except FileNotFoundError as e:
+ Logger.print_error(e)
+ raise
+ except CalledProcessError as e:
+ Logger.print_error(f"Error updating pip:\n{e.output.decode()}")
+ raise
+
+
+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
+ """
+ try:
+ # always update pip before installing requirements
+ update_python_pip(target)
+
+ Logger.print_status("Installing Python requirements ...")
+ command = [
+ target.joinpath("bin/pip").as_posix(),
+ "install",
+ "-r",
+ f"{requirements}",
+ ]
+ result = run(command, stderr=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 successful!")
+ except 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: float = 0
+ cache_files: List[Path] = [
+ 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 = run(command, stderr=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 update successful!")
+ except CalledProcessError as e:
+ Logger.print_error(f"Error updating system package list:\n{e.stderr.decode()}")
+ raise
+
+
+def get_upgradable_packages() -> List[str]:
+ """
+ Reads all system packages that can be upgraded.
+ :return: A list of package names available for upgrade
+ """
+ try:
+ command = ["apt", "list", "--upgradable"]
+ output: str = check_output(command, stderr=DEVNULL, text=True, encoding="utf-8")
+ pkglist = []
+ for line in output.split("\n"):
+ if "/" not in line:
+ continue
+ pkg = line.split("/")[0]
+ pkglist.append(pkg)
+ return pkglist
+ except CalledProcessError as e:
+ raise Exception(f"Error reading upgradable packages: {e}")
+
+
+def check_package_install(packages: Set[str]) -> List[str]:
+ """
+ Checks the system for installed packages |
+ :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 = run(
+ command,
+ stdout=PIPE,
+ stderr=DEVNULL,
+ text=True,
+ )
+ if "installed" not in result.stdout.strip("'").split():
+ not_installed.append(package)
+
+ 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)
+ run(command, stderr=PIPE, check=True)
+
+ Logger.print_ok("Packages successfully installed.")
+ except CalledProcessError as e:
+ Logger.print_error(f"Error installing packages:\n{e.stderr.decode()}")
+ raise
+
+
+def upgrade_system_packages(packages: List[str]) -> None:
+ """
+ Updates a list of system packages |
+ :param packages: List of system package names
+ :return: None
+ """
+ try:
+ command = ["sudo", "apt-get", "upgrade", "-y"]
+ for pkg in packages:
+ command.append(pkg)
+ run(command, stderr=PIPE, check=True)
+
+ Logger.print_ok("Packages successfully upgraded.")
+ except CalledProcessError as e:
+ raise Exception(f"Error upgrading packages:\n{e.stderr.decode()}")
+
+
+# this feels hacky and not quite right, but for now it works
+# see: https://stackoverflow.com/questions/166506/finding-local-ip-addresses-using-pythons-stdlib
+def get_ipv4_addr() -> str:
+ """
+ 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 str(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 = run(cmd, shell=True, stdout=PIPE, text=True)
+ permissions = homedir_perm.stdout
+
+ if permissions.count("x") < 3:
+ Logger.print_status("Granting NGINX the required permissions ...")
+ run(["chmod", "og+x", Path.home()])
+ Logger.print_ok("Permissions granted.")
+
+
+def cmd_sysctl_service(name: str, action: SysCtlServiceAction) -> 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} ...")
+ run(["sudo", "systemctl", action, name], stderr=PIPE, check=True)
+ Logger.print_ok("OK!")
+ except CalledProcessError as e:
+ log = f"Failed to {action} {name}: {e.stderr.decode()}"
+ Logger.print_error(log)
+ raise
+
+
+def cmd_sysctl_manage(action: SysCtlManageAction) -> None:
+ try:
+ run(["sudo", "systemctl", action], stderr=PIPE, check=True)
+ except CalledProcessError as e:
+ log = f"Failed to run {action}: {e.stderr.decode()}"
+ Logger.print_error(log)
+ raise
+
+
+def unit_file_exists(
+ name: str, suffix: Literal["service", "timer"], exclude: List[str] | None = None
+) -> bool:
+ """
+ Checks if a systemd unit file of the provided suffix exists.
+ :param name: the name of the unit file
+ :param suffix: suffix of the unit file, either "service" or "timer"
+ :param exclude: List of strings of names to exclude
+ :return: True if the unit file exists, False otherwise
+ """
+ exclude = exclude or []
+ pattern = re.compile(f"^{name}(-[0-9a-zA-Z]+)?.{suffix}$")
+ 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 exclude)
+ ]
+ return any(service_list)
+
+
+def log_process(process: Popen) -> None:
+ """
+ Helper method to print stdout of a process in near realtime to the console.
+ :param process: Process to log the output from
+ :return: None
+ """
+ while True:
+ if process.stdout is not None:
+ reads = [process.stdout.fileno()]
+ ret = select.select(reads, [], [])
+ for fd in ret[0]:
+ if fd == process.stdout.fileno():
+ line = process.stdout.readline()
+ if line:
+ print(line.strip(), flush=True)
+ else:
+ break
+
+ if process.poll() is not None:
+ break
+
+
+def create_service_file(name: str, content: str) -> None:
+ """
+ Creates a service file at the provided path with the provided content.
+ :param name: the name of the service file
+ :param content: the content of the service file
+ :return: None
+ """
+ try:
+ run(
+ ["sudo", "tee", SYSTEMD.joinpath(name)],
+ input=content.encode(),
+ stdout=DEVNULL,
+ check=True,
+ )
+ Logger.print_ok(f"Service file created: {SYSTEMD.joinpath(name)}")
+ except CalledProcessError as e:
+ Logger.print_error(f"Error creating service file: {e}")
+ raise
+
+
+def create_env_file(path: Path, content: str) -> None:
+ """
+ Creates an env file at the provided path with the provided content.
+ :param path: the path of the env file
+ :param content: the content of the env file
+ :return: None
+ """
+ try:
+ with open(path, "w") as env_file:
+ env_file.write(content)
+ Logger.print_ok(f"Env file created: {path}")
+ except OSError as e:
+ Logger.print_error(f"Error creating env file: {e}")
+ raise
+
+
+def remove_system_service(service_name: str) -> None:
+ """
+ Disables and removes a systemd service
+ :param service_name: name of the service unit file - must end with '.service'
+ :return: None
+ """
+ try:
+ if not service_name.endswith(".service"):
+ raise ValueError(f"service_name '{service_name}' must end with '.service'")
+
+ file: Path = SYSTEMD.joinpath(service_name)
+ if not file.exists() or not file.is_file():
+ Logger.print_info(f"Service '{service_name}' does not exist! Skipped ...")
+ return
+
+ Logger.print_status(f"Removing {service_name} ...")
+ cmd_sysctl_service(service_name, "stop")
+ cmd_sysctl_service(service_name, "disable")
+ remove_with_sudo(file)
+ cmd_sysctl_manage("daemon-reload")
+ cmd_sysctl_manage("reset-failed")
+ Logger.print_ok(f"{service_name} successfully removed!")
+ except Exception as e:
+ Logger.print_error(f"Error removing {service_name}: {e}")
+ raise
+
+
+def get_service_file_path(instance_type: type, suffix: str) -> Path:
+ from utils.common import convert_camelcase_to_kebabcase
+
+ if not isinstance(instance_type, type):
+ raise ValueError("instance_type must be a class")
+
+ name: str = convert_camelcase_to_kebabcase(instance_type.__name__)
+ if suffix != "":
+ name += f"-{suffix}"
+
+ file_path: Path = SYSTEMD.joinpath(f"{name}.service")
+
+ return file_path
diff --git a/klipper_repos.txt.example b/klipper_repos.txt.example
deleted file mode 100644
index 6cc3393..0000000
--- a/klipper_repos.txt.example
+++ /dev/null
@@ -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 ','.
-# , -> 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
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000..1881881
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,32 @@
+[project]
+requires-python = ">=3.8"
+
+[project.optional-dependencies]
+dev=["ruff", "mypy"]
+
+[tool.ruff]
+required-version = ">=0.3.4"
+respect-gitignore = true
+exclude = [".git",".github", "./docs"]
+line-length = 88
+indent-width = 4
+output-format = "full"
+
+[tool.ruff.format]
+indent-style = "space"
+line-ending = "lf"
+quote-style = "double"
+
+[tool.ruff.lint]
+extend-select = ["I"]
+
+[tool.mypy]
+python_version = "3.8"
+platform = "linux"
+# strict = true # TODO: enable this once everything is else is handled
+check_untyped_defs = true
+ignore_missing_imports = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_return_any = true
+warn_unreachable = true
diff --git a/resources/gcode_shell_command.py b/resources/gcode_shell_command.py
index bb38ae5..3f316e6 100755
--- a/resources/gcode_shell_command.py
+++ b/resources/gcode_shell_command.py
@@ -8,22 +8,26 @@ 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')
+ 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.timeout = config.getfloat("timeout", 2.0, above=0.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,
+ "RUN_SHELL_COMMAND",
+ "CMD",
+ self.name,
self.cmd_RUN_SHELL_COMMAND,
- desc=self.cmd_RUN_SHELL_COMMAND_help)
+ desc=self.cmd_RUN_SHELL_COMMAND_help,
+ )
def _process_output(self, eventime):
if self.proc_fd is None:
@@ -33,11 +37,11 @@ class ShellCommand:
except Exception:
pass
data = self.partial_output + data.decode()
- if '\n' not in data:
+ if "\n" not in data:
self.partial_output = data
return
- elif data[-1] != '\n':
- split = data.rfind('\n') + 1
+ elif data[-1] != "\n":
+ split = data.rfind("\n") + 1
self.partial_output = data[split:]
data = data[:split]
else:
@@ -45,16 +49,19 @@ class ShellCommand:
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 = 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)
+ self.command + gcode_params,
+ stdout=subprocess.PIPE,
+ stderr=subprocess.STDOUT,
+ )
except Exception:
- logging.exception(
- "shell_command: Command {%s} failed" % (self.name))
+ 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()
@@ -64,7 +71,7 @@ class ShellCommand:
endtime = eventtime + self.timeout
complete = False
while eventtime < endtime:
- eventtime = reactor.pause(eventtime + .05)
+ eventtime = reactor.pause(eventtime + 0.05)
if proc.poll() is not None:
complete = True
break
diff --git a/scripts/ui/main_menu.sh b/scripts/ui/main_menu.sh
index 011a9ae..14cc1a4 100755
--- a/scripts/ui/main_menu.sh
+++ b/scripts/ui/main_menu.sh
@@ -40,7 +40,7 @@ function main_ui() {
function get_kiauh_version() {
local version
cd "${KIAUH_SRCDIR}"
- version="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
+ version="$(git tag -l 'v5*' | tail -1)"
echo "${version}"
}
@@ -93,9 +93,6 @@ function main_menu() {
clear && print_header
main_ui
- ### initialize kiauh.ini
- init_ini
-
local action
while true; do
read -p "${cyan}####### Perform action:${white} " action
diff --git a/scripts/utilities.sh b/scripts/utilities.sh
index fa2dfe1..aed70d5 100644
--- a/scripts/utilities.sh
+++ b/scripts/utilities.sh
@@ -193,6 +193,10 @@ function init_ini() {
echo -e "\nmulti_instance_names=\c" >> "${INI_FILE}"
fi
+ if ! grep -Eq "^version_to_launch=" "${INI_FILE}"; then
+ echo -e "\nversion_to_launch=\n\c" >> "${INI_FILE}"
+ fi
+
### strip all empty lines out of the file
sed -i "/^[[:blank:]]*$/ d" "${INI_FILE}"
}
@@ -377,9 +381,9 @@ function create_required_folders() {
function update_system_package_lists() {
local cache_mtime update_age update_interval silent
-
+
if [[ $1 == '--silent' ]]; then silent="true"; fi
-
+
if [[ -e /var/lib/apt/periodic/update-success-stamp ]]; then
cache_mtime="$(stat -c %Y /var/lib/apt/periodic/update-success-stamp)"
elif [[ -e /var/lib/apt/lists ]]; then
@@ -411,10 +415,10 @@ function update_system_package_lists() {
function check_system_updates() {
local updates_avail status
if ! update_system_package_lists --silent; then
- status="${red}Update check failed! ${white}"
+ status="${red}Update check failed! ${white}"
else
updates_avail="$(apt list --upgradeable 2>/dev/null | sed "1d")"
-
+
if [[ -n ${updates_avail} ]]; then
status="${yellow}System upgrade available!${white}"
# add system to application_updates_available in kiauh.ini
@@ -423,7 +427,7 @@ function check_system_updates() {
status="${green}System up to date! ${white}"
fi
fi
-
+
echo "${status}"
}