refactor(kiauh): remove legacy scripts, configurations, and assets af… (#729)

refactor(kiauh): remove legacy scripts, configurations, and assets after migration to Python-based KIAUH v6

.gitignore

@@ -10,3 +10,4 @@ __pycache__
 *.code-workspace
 *.iml
 kiauh.cfg
+klipper_repos.txt

.shellcheckrc

@@ -1,15 +0,0 @@
-source=scripts
-
-enable=avoid-nullary-conditions
-enable=deprecate-which
-enable=quote-safe-variables
-enable=require-variable-braces
-enable=require-double-brackets
-
-# SC2162: `read` without `-r` will mangle backslashes.
-# https://github.com/koalaman/shellcheck/wiki/SC2162
-disable=SC2162
-
-# SC2164: Use `cd ... || exit` in case `cd` fails
-# https://github.com/koalaman/shellcheck/wiki/SC2164
-disable=SC2164

README_zh.md

@@ -0,0 +1,206 @@
+# KIAUH - Klipper 安装与更新助手
+
+<p align="center">
+  <a>
+    <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/kiauh.png" alt="KIAUH logo" height="181">
+    <h1 align="center">Klipper Installation And Update Helper</h1>
+  </a>
+</p>
+
+<p align="center">
+  一个方便的安装脚本，让安装Klipper（以及更多组件）变得轻松！
+</p>
+
+<p align="center">
+  <a><img src="https://img.shields.io/github/license/dw-0/kiauh"></a>
+  <a><img src="https://img.shields.io/github/stars/dw-0/kiauh"></a>
+  <a><img src="https://img.shields.io/github/forks/dw-0/kiauh"></a>
+  <a><img src="https://img.shields.io/github/languages/top/dw-0/kiauh?logo=gnubash&logoColor=white"></a>
+  <a><img src="https://img.shields.io/github/v/tag/dw-0/kiauh"></a>
+  <br />
+  <a><img src="https://img.shields.io/github/last-commit/dw-0/kiauh"></a>
+  <a><img src="https://img.shields.io/github/contributors/dw-0/kiauh"></a>
+</p>
+
+## 📄 使用说明
+
+### 📋 系统要求
+KIAUH 是一个帮助您在 Linux 系统上安装 Klipper 的脚本工具，
+它需要一个已经写入树莓派（或其他单板计算机）SD 卡的 Linux 系统。
+如果您使用树莓派，推荐使用 `Raspberry Pi OS Lite (32位或64位)` 系统镜像。
+[官方 Raspberry Pi Imager](https://www.raspberrypi.com/software/) 是将此类镜像写入 SD 卡的最简单方式。
+
+* 下载、安装并启动 Raspberry Pi Imager 后，
+选择 `Choose OS -> Raspberry Pi OS (other)`:
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager1.png" alt="KIAUH logo" height="350">
+</p>
+
+* 然后选择 `Raspberry Pi OS Lite (32位)` (或如果您想使用64位版本):
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager2.png" alt="KIAUH logo" height="350">
+</p>
+
+* 返回 Raspberry Pi Imager 主界面，选择对应的 SD 卡作为写入目标。
+
+* 确保点击左下角的齿轮图标（在主菜单中）
+启用 SSH 并配置 Wi-Fi。
+
+* 如果您需要更多关于使用 Raspberry Pi Imager 的帮助，请访问 [官方文档](https://www.raspberrypi.com/documentation/computers/getting-started.html)。
+
+这些步骤**仅适用于**您实际使用树莓派的情况。如果您想使用其他单板计算机（如香橙派或其他 Pi 衍生产品），
+请查找如何将合适的 Linux 镜像写入 SD 卡（通常使用 Balena Etcher）。
+同时确保 KIAUH 能够在您要安装的 Linux 发行版上运行。
+您在使用基于 Debian 11 Bullseye 的系统时可能会获得最佳体验。
+请阅读本文档下方的注意事项。
+
+### 💾 下载并使用 KIAUH
+
+**📢 免责声明：使用此脚本的风险由您自行承担！**
+
+* **第一步：**
+要下载此脚本，需要先安装 git。
+如果您不确定是否已安装 git，请运行以下命令：
+```shell
+sudo apt-get update && sudo apt-get install git -y
+```
+
+* **第二步：**
+安装完 git 后，
+使用以下命令将 KIAUH 下载到您的主目录：
+
+```shell
+cd ~ && git clone https://github.com/dw-0/kiauh.git
+```
+
+* **第三步：**
+最后，通过运行以下命令启动 KIAUH：
+
+```shell
+./kiauh/kiauh.sh
+```
+
+* **第四步：**
+您现在应该会看到 KIAUH 的主菜单。
+根据您的选择，
+您会看到几个可选操作。
+要选择某个操作，只需在 "Perform action" 提示后输入对应的数字并按回车键确认。
+
+## ❗ 注意事项
+
+### **📋 请查看 [更新日志](docs/changelog.md) 以了解可能的重要更新！**
+
+- 主要在 Raspberry Pi OS Lite (Debian 10 Buster / Debian 11 Bullseye) 上测试
+    - 其他基于 Debian 的发行版（如 Ubuntu 20 到 22）也可能正常工作
+    - 据报告在 Armbian 上也可用，但未进行详细测试
+- 在使用此脚本的过程中，
+您会被要求输入 sudo 密码。
+因为有几个功能需要 sudo 权限。
+
+## 🌐 相关资源与更多信息
+
+<table align="center">
+<tr>
+    <th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
+    <th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
+    <th><h3><a href="https://github.com/mainsail-crew/mainsail">Mainsail</a></h3></th>
+</tr>
+<tr>
+    <th><img src="https://raw.githubusercontent.com/Klipper3d/klipper/master/docs/img/klipper-logo.png" alt="Klipper Logo" height="64"></th>
+    <th><img src="https://avatars.githubusercontent.com/u/9563098?v=4" alt="Arksine avatar" height="64"></th>
+    <th><img src="https://raw.githubusercontent.com/mainsail-crew/docs/master/assets/img/logo.png" alt="Mainsail Logo" height="64"></th>
+</tr>
+<tr>
+    <th>由 <a href="https://github.com/KevinOConnor">KevinOConnor</a></th>
+    <th>由 <a href="https://github.com/Arksine">Arksine</a></th>
+    <th>由 <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
+</tr>
+
+<tr>
+    <th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
+    <th><h3><a href="https://github.com/jordanruthe/KlipperScreen">KlipperScreen</a></h3></th>
+    <th><h3><a href="https://github.com/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
+</tr>
+<tr>
+    <th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
+    <th><img src="https://avatars.githubusercontent.com/u/31575189?v=4" alt="jordanruthe avatar" height="64"></th>
+    <th><img src="https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png" alt="OctoPrint Logo" height="64"></th>
+</tr>
+<tr>
+    <th>由 <a href="https://github.com/fluidd-core">fluidd-core</a></th>
+    <th>由 <a href="https://github.com/jordanruthe">jordanruthe</a></th>
+    <th>由 <a href="https://github.com/OctoPrint">OctoPrint</a></th>
+</tr>
+
+<tr>
+    <th><h3><a href="https://github.com/nlef/moonraker-telegram-bot">Moonraker-Telegram-Bot</a></h3></th>
+    <th><h3><a href="https://github.com/Kragrathea/pgcode">PrettyGCode for Klipper</a></h3></th>
+    <th><h3><a href="https://github.com/TheSpaghettiDetective/moonraker-obico">Obico for Klipper</a></h3></th>
+</tr>
+<tr>
+    <th><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></th>
+    <th><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></th>
+    <th><img src="https://avatars.githubusercontent.com/u/46323662?s=200&v=4" alt="Obico logo" height="64"></th>
+</tr>
+<tr>
+    <th>由 <a href="https://github.com/nlef">nlef</a></th>
+    <th>由 <a href="https://github.com/Kragrathea">Kragrathea</a></th>
+    <th>由 <a href="https://github.com/TheSpaghettiDetective">Obico</a></th>
+</tr>
+
+<tr>
+    <th><h3><a href="https://github.com/Clon1998/mobileraker_companion">Mobileraker's Companion</a></h3></th>
+    <th><h3><a href="https://octoeverywhere.com/?source=kiauh_readme">OctoEverywhere For Klipper</a></h3></th>
+    <th><h3><a href="https://github.com/crysxd/OctoApp-Plugin">OctoApp For Klipper</a></h3></th>
+</tr>
+<tr>
+    <th><a href="https://github.com/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="Mobileraker Logo" height="64"></a></th>
+    <th><a href="https://octoeverywhere.com/?source=kiauh_readme"><img src="https://octoeverywhere.com/img/logo.svg" alt="OctoEverywhere Logo" height="64"></a></th>
+    <th><a href="https://octoapp.eu/?source=kiauh_readme"><img src="https://octoapp.eu/octoapp.webp" alt="OctoApp Logo" height="64"></a></th>
+</tr>
+<tr>
+    <th>由 <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
+    <th>由 <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
+    <th>由 <a href="https://github.com/crysxd">Christian Würthner</a></th>
+</tr>
+
+<tr>
+    <th><h3><a href="https://github.com/staubgeborener/klipper-backup">Klipper-Backup</a></h3></th>
+    <th><h3><a href="https://simplyprint.io/">SimplyPrint for Klipper</a></h3></th>
+</tr>
+<tr>
+    <th><a href="https://github.com/staubgeborener/klipper-backup"><img src="https://avatars.githubusercontent.com/u/28908603?v=4" alt="Staubgeroner Avatar" height="64"></a></th>
+    <th><a href="https://github.com/SimplyPrint"><img src="https://avatars.githubusercontent.com/u/64896552?s=200&v=4" alt="" height="64"></a></th>
+</tr>
+<tr>
+    <th>由 <a href="https://github.com/Staubgeborener">Staubgeborener</a></th>
+    <th>由 <a href="https://github.com/SimplyPrint">SimplyPrint</a></th>
+</tr>
+</table>
+
+## 🎖️ 贡献者
+
+<div align="center">
+  <a href="https://github.com/dw-0/kiauh/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=dw-0/kiauh" alt=""/>
+  </a>
+</div>
+
+<div align="center">
+    <img src="https://repobeats.axiom.co/api/embed/a1afbda9190c04a90cf4bd3061e5573bc836cb05.svg" alt="Repobeats analytics image"/>
+</div>
+
+## ✨ 特别感谢
+
+* 非常感谢 [lixxbox](https://github.com/lixxbox) 设计了如此出色的 KIAUH 标志！
+* 同时，非常感谢所有通过 [Ko-fi](https://ko-fi.com/dw__0) 支持我的工作的人！
+* 最后但同样重要的是：感谢所有为 Klipper 社区做出贡献的成员，以及喜欢和分享这个项目的朋友们！
+
+<h4 align="center">特别感谢 JetBrains 为本项目提供其出色的软件赞助！</h4>
+<p align="center">
+  <a href="https://www.jetbrains.com/community/opensource/#support" target="_blank">
+    <img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main) logo." height="128">
+  </a>
+</p>

kiauh.py

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

kiauh.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
+# Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>       #
 #                                                                       #
 # This file is part of KIAUH - Klipper Installation And Update Helper   #
 # https://github.com/dw-0/kiauh                                         #
@@ -15,11 +15,6 @@ clear -x
 # make sure we have the correct permissions while running the script
 umask 022
 
-### sourcing all additional scripts
-KIAUH_SRCDIR="$(dirname -- "$(readlink -f "${BASH_SOURCE[0]}")")"
-for script in "${KIAUH_SRCDIR}/scripts/"*.sh; do . "${script}"; done
-for script in "${KIAUH_SRCDIR}/scripts/ui/"*.sh; do . "${script}"; done
-
 #===================================================#
 #=================== UPDATE KIAUH ==================#
 #===================================================#
@@ -57,15 +52,6 @@ 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
@@ -93,85 +79,52 @@ function kiauh_update_dialog() {
   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."
+function check_euid() {
+  if [[ ${EUID} -eq 0 ]]; then
+    echo -e "${red}"
+    top_border
+    echo -e "|       !!! THIS SCRIPT MUST NOT RUN AS ROOT !!!        |"
+    echo -e "|                                                       |"
+    echo -e "|        It will ask for credentials as needed.         |"
+    bottom_border
+    echo -e "${white}"
     exit 1
   fi
+}
 
-  entrypoint=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
-
-  export PYTHONPATH="${entrypoint}"
-
-  clear -x
-  python3 "${entrypoint}/kiauh.py"
+function check_if_ratos() {
+  if [[ -n $(which ratos) ]]; then
+    echo -e "${red}"
+    top_border
+    echo -e "|        !!! RatOS 2.1 or greater detected !!!          |"
+    echo -e "|                                                       |"
+    echo -e "|        KIAUH does currently not support RatOS.        |"
+    echo -e "| If you have any questions, please ask for help on the |"
+    echo -e "| RatRig Community Discord: https://discord.gg/ratrig   |"
+    bottom_border
+    echo -e "${white}"
+    exit 1
+  fi
 }
 
 function main() {
-  read_kiauh_ini "${FUNCNAME[0]}"
+   local entrypoint
 
-  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
+   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 -x
+   python3 "${entrypoint}/kiauh/main.py"
 }
 
 check_if_ratos
 check_euid
-init_logfile
-set_globals
 kiauh_update_dialog
-read_kiauh_ini
-init_ini
 main

kiauh/components/crowsnest/__init__.py

@@ -9,7 +9,6 @@
 
 from pathlib import Path
 
-from core.backup_manager import BACKUP_ROOT_DIR
 from core.constants import SYSTEMD
 
 # repo
@@ -20,7 +19,6 @@ 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")

kiauh/components/crowsnest/crowsnest.py

@@ -15,7 +15,6 @@ from subprocess import CalledProcessError, run
 from typing import List
 
 from components.crowsnest import (
-    CROWSNEST_BACKUP_DIR,
     CROWSNEST_BIN_FILE,
     CROWSNEST_DIR,
     CROWSNEST_INSTALL_SCRIPT,
@@ -26,8 +25,8 @@ from components.crowsnest import (
     CROWSNEST_SERVICE_NAME,
 )
 from components.klipper.klipper import Klipper
-from core.backup_manager.backup_manager import BackupManager
 from core.logger import DialogType, Logger
+from core.services.backup_service import BackupService
 from core.settings.kiauh_settings import KiauhSettings
 from core.types.component_status import ComponentStatus
 from utils.common import (
@@ -127,11 +126,11 @@ def update_crowsnest() -> None:
 
             settings = KiauhSettings()
             if settings.kiauh.backup_before_update:
-                bm = BackupManager()
-                bm.backup_directory(
-                    CROWSNEST_DIR.name,
-                    source=CROWSNEST_DIR,
-                    target=CROWSNEST_BACKUP_DIR,
+                svc = BackupService()
+                svc.backup_directory(
+                    source_path=CROWSNEST_DIR,
+                    target_path="crowsnest",
+                    backup_name="crowsnest",
                 )
 
             git_pull_wrapper(CROWSNEST_DIR)

kiauh/components/klipper/__init__.py

@@ -9,8 +9,6 @@
 
 from pathlib import Path
 
-from core.backup_manager import BACKUP_ROOT_DIR
-
 MODULE_PATH = Path(__file__).resolve().parent
 
 KLIPPER_REPO_URL = "https://github.com/Klipper3d/klipper.git"
@@ -27,7 +25,6 @@ KLIPPER_SERVICE_NAME = "klipper.service"
 KLIPPER_DIR = Path.home().joinpath("klipper")
 KLIPPER_KCONFIGS_DIR = Path.home().joinpath("klipper-kconfigs")
 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")

kiauh/components/klipper/klipper_utils.py

@@ -16,7 +16,6 @@ from subprocess import CalledProcessError, run
 from typing import Dict, List
 
 from components.klipper import (
-    KLIPPER_BACKUP_DIR,
     KLIPPER_DIR,
     KLIPPER_ENV_DIR,
     KLIPPER_INSTALL_SCRIPT,
@@ -31,10 +30,10 @@ 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.services.backup_service import BackupService
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
@@ -198,9 +197,17 @@ def create_example_printer_cfg(
 
 
 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)
+    svc = BackupService()
+    svc.backup_directory(
+        source_path=KLIPPER_DIR,
+        backup_name="klipper",
+        target_path="klipper",
+    )
+    svc.backup_directory(
+        source_path=KLIPPER_ENV_DIR,
+        backup_name="klippy-env",
+        target_path="klipper",
+    )
 
 
 def install_klipper_packages() -> None:

kiauh/components/klipperscreen/__init__.py

@@ -8,7 +8,6 @@
 # ======================================================================= #
 from pathlib import Path
 
-from core.backup_manager import BACKUP_ROOT_DIR
 from core.constants import SYSTEMD
 
 # repo
@@ -22,7 +21,6 @@ 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(

kiauh/components/klipperscreen/klipperscreen.py

@@ -13,7 +13,6 @@ 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,
@@ -25,10 +24,10 @@ from components.klipperscreen import (
     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.services.backup_service import BackupService
 from core.settings.kiauh_settings import KiauhSettings
 from core.types.component_status import ComponentStatus
 from utils.common import (
@@ -97,6 +96,7 @@ def install_klipperscreen() -> None:
 
 
 def patch_klipperscreen_update_manager(instances: List[Moonraker]) -> None:
+    BackupService().backup_moonraker_conf()
     add_config_section(
         section=KLIPPERSCREEN_UPDATER_SECTION_NAME,
         instances=instances,
@@ -183,6 +183,7 @@ def remove_klipperscreen() -> None:
         mr_instances: List[Moonraker] = get_instances(Moonraker)
         if mr_instances:
             Logger.print_status("Removing KlipperScreen from update manager ...")
+            BackupService().backup_moonraker_conf()
             remove_config_section("update_manager KlipperScreen", mr_instances)
             Logger.print_ok("KlipperScreen successfully removed from update manager!")
 
@@ -193,14 +194,14 @@ def remove_klipperscreen() -> None:
 
 
 def backup_klipperscreen_dir() -> None:
-    bm = BackupManager()
-    bm.backup_directory(
-        KLIPPERSCREEN_DIR.name,
-        source=KLIPPERSCREEN_DIR,
-        target=KLIPPERSCREEN_BACKUP_DIR,
+    svc = BackupService()
+    svc.backup_directory(
+        source_path=KLIPPERSCREEN_DIR,
+        backup_name="KlipperScreen",
+        target_path="KlipperScreen",
     )
-    bm.backup_directory(
-        KLIPPERSCREEN_ENV_DIR.name,
-        source=KLIPPERSCREEN_ENV_DIR,
-        target=KLIPPERSCREEN_BACKUP_DIR,
+    svc.backup_directory(
+        source_path=KLIPPERSCREEN_ENV_DIR,
+        backup_name="KlipperScreen-env",
+        target_path="KlipperScreen",
     )

kiauh/components/moonraker/__init__.py

@@ -9,8 +9,6 @@
 
 from pathlib import Path
 
-from core.backup_manager import BACKUP_ROOT_DIR
-
 MODULE_PATH = Path(__file__).resolve().parent
 
 MOONRAKER_REPO_URL = "https://github.com/Arksine/moonraker.git"
@@ -25,8 +23,6 @@ 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")

kiauh/components/moonraker/utils/sysdeps_parser.py

@@ -61,6 +61,9 @@ class SysDepsParser:
         version = distro_info.get("distro_version")
         if version:
             self.distro_version = _convert_version(version)
+        self.vendor: str = ""
+        if pathlib.Path("/etc/rpi-issue").is_file():
+            self.vendor = "raspberry-pi"
 
     def _parse_spec(self, full_spec: str) -> str | None:
         parts = full_spec.split(";", maxsplit=1)
@@ -109,6 +112,9 @@ class SysDepsParser:
             elif req_var == "distro_id":
                 left_op: str | Tuple[int | str, ...] = self.distro_id
                 right_op = dep_parts[2].strip().strip("\"'")
+            elif req_var == "vendor":
+                left_op = self.vendor
+                right_op = dep_parts[2].strip().strip("\"'")
             elif req_var == "distro_version":
                 if not self.distro_version:
                     logging.info(

kiauh/components/moonraker/utils/utils.py

@@ -14,8 +14,6 @@ from typing import Dict, List, Optional
 
 from components.moonraker import (
     MODULE_PATH,
-    MOONRAKER_BACKUP_DIR,
-    MOONRAKER_DB_BACKUP_DIR,
     MOONRAKER_DEFAULT_PORT,
     MOONRAKER_DEPS_JSON_FILE,
     MOONRAKER_DIR,
@@ -25,8 +23,8 @@ from components.moonraker import (
 from components.moonraker.moonraker import Moonraker
 from components.moonraker.utils.sysdeps_parser import SysDepsParser
 from components.webui_client.base_data import BaseWebClient
-from core.backup_manager.backup_manager import BackupManager
 from core.logger import Logger
+from core.services.backup_service import BackupService
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
@@ -126,7 +124,7 @@ def create_example_moonraker_conf(
     scp.read_file(target)
     trusted_clients: List[str] = [
         f"    {'.'.join(ip)}\n",
-        *scp.getval("authorization", "trusted_clients"),
+        *scp.getvals("authorization", "trusted_clients"),
     ]
 
     scp.set_option("server", "port", str(port))
@@ -168,21 +166,55 @@ def create_example_moonraker_conf(
 
 
 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
+    svc = BackupService()
+    svc.backup_directory(
+        source_path=MOONRAKER_DIR, backup_name="moonraker", target_path="moonraker"
+    )
+    svc.backup_directory(
+        source_path=MOONRAKER_ENV_DIR,
+        backup_name="moonraker-env",
+        target_path="moonraker",
     )
 
 
 def backup_moonraker_db_dir() -> None:
     instances: List[Moonraker] = get_instances(Moonraker)
-    bm = BackupManager()
+    svc = BackupService()
+
+    if not instances:
+        # fallback: search for printer data directories in the user's home directory
+        Logger.print_info("No Moonraker instances found via systemd services.")
+        Logger.print_info(
+            "Attempting to find printer data directories in home directory..."
+        )
+
+        home_dir = Path.home()
+        printer_data_dirs = []
+
+        for pattern in ["printer_data", "printer_*_data"]:
+            for data_dir in home_dir.glob(pattern):
+                if data_dir.is_dir():
+                    printer_data_dirs.append(data_dir)
+
+        if not printer_data_dirs:
+            Logger.print_info("Unable to find directory to backup!")
+            Logger.print_info("No printer data directories found in home directory.")
+            return
+
+        for data_dir in printer_data_dirs:
+            svc.backup_directory(
+                source_path=data_dir.joinpath("database"),
+                target_path=data_dir.name,
+                backup_name="database",
+            )
+
+        return
 
     for instance in instances:
-        name = f"database-{instance.data_dir.name}"
-        bm.backup_directory(
-            name, source=instance.db_dir, target=MOONRAKER_DB_BACKUP_DIR
+        svc.backup_directory(
+            source_path=instance.db_dir,
+            target_path=f"{instance.data_dir.name}",
+            backup_name="database",
         )
 
 

kiauh/components/webui_client/base_data.py

@@ -34,7 +34,6 @@ class BaseWebClient(ABC):
     display_name: str
     client_dir: Path
     config_file: Path
-    backup_dir: Path
     repo_path: str
     download_url: str
     nginx_config: Path
@@ -52,6 +51,5 @@ class BaseWebClientConfig(ABC):
     display_name: str
     config_filename: str
     config_dir: Path
-    backup_dir: Path
     repo_url: str
     config_section: str

kiauh/components/webui_client/client_config/client_config_remove.py

@@ -14,6 +14,7 @@ from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
 from components.webui_client.base_data import BaseWebClientConfig
 from core.logger import Logger
+from core.services.backup_service import BackupService
 from core.services.message_service import Message
 from core.types.color import Color
 from utils.config_utils import remove_config_section
@@ -35,6 +36,8 @@ def run_client_config_removal(
     if run_remove_routines(client_config.config_dir):
         completion_msg.text.append(f"● {client_config.display_name} removed")
 
+    BackupService().backup_printer_config_dir()
+
     completion_msg = remove_moonraker_config_section(
         completion_msg, client_config, mr_instances
     )

kiauh/components/webui_client/client_config/client_config_setup.py

@@ -25,8 +25,8 @@ from components.webui_client.client_utils import (
 )
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import Logger
+from core.services.backup_service import BackupService
 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
@@ -57,7 +57,7 @@ def install_client_config(client_data: BaseWebClient, cfg_backup=True) -> None:
         create_client_config_symlink(client_config, kl_instances)
 
         if cfg_backup:
-            backup_printer_config_dir()
+            BackupService().backup_printer_config_dir()
 
         add_config_section(
             section=f"update_manager {client_config.name}",

kiauh/components/webui_client/client_remove.py

@@ -16,9 +16,9 @@ from components.webui_client.base_data import (
 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 core.services.backup_service import BackupService
 from core.services.message_service import Message
 from core.types.color import Color
 from utils.config_utils import remove_config_section
@@ -43,8 +43,19 @@ def run_client_removal(
     kl_instances: List[Klipper] = get_instances(Klipper)
 
     if backup_config:
-        bm = BackupManager()
-        if bm.backup_file(client.config_file):
+        version = ""
+        src = client.client_dir
+        if src.joinpath(".version").exists():
+            with open(src.joinpath(".version"), "r") as v:
+                version = v.readlines()[0]
+
+        svc = BackupService()
+        target_path = svc.backup_root.joinpath(f"{client.client_dir.name}_{version}")
+        success = svc.backup_file(
+            source_path=client.config_file,
+            target_path=target_path,
+        )
+        if success:
             completion_msg.text.append(f"● {client.config_file.name} backup created")
 
     if remove_client:
@@ -56,6 +67,7 @@ def run_client_removal(
         if remove_client_nginx_logs(client, kl_instances):
             completion_msg.text.append("● NGINX logs removed")
 
+        BackupService().backup_moonraker_conf()
         section = f"update_manager {client_name}"
         handled_instances: List[Moonraker] = remove_config_section(
             section, mr_instances

kiauh/components/webui_client/client_setup.py

@@ -37,9 +37,10 @@ from components.webui_client.client_utils import (
 )
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
+from core.services.backup_service import BackupService
 from core.settings.kiauh_settings import KiauhSettings
 from core.types.color import Color
-from utils.common import backup_printer_config_dir, check_install_dependencies
+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
@@ -97,11 +98,12 @@ def install_client(
         if enable_remotemode and client.client == WebClientType.MAINSAIL:
             enable_mainsail_remotemode()
 
-        backup_printer_config_dir()
+        BackupService().backup_printer_config_dir()
         add_config_section(
             section=f"update_manager {client.name}",
             instances=mr_instances,
             options=[
+                ("persistent_files", ["config.json"]),
                 ("type", "web"),
                 ("channel", "stable"),
                 ("repo", str(client.repo_path)),

kiauh/components/webui_client/client_utils.py

@@ -24,13 +24,13 @@ from components.webui_client.base_data import (
 from components.webui_client.client_dialogs import print_client_port_select_dialog
 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 (
     NGINX_CONFD,
     NGINX_SITES_AVAILABLE,
     NGINX_SITES_ENABLED,
 )
 from core.logger import Logger
+from core.services.backup_service import BackupService
 from core.settings.kiauh_settings import KiauhSettings, WebUiSettings
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
@@ -119,7 +119,7 @@ def enable_mainsail_remotemode() -> None:
     with open(c_json, "r") as f:
         config_data = json.load(f)
 
-    if config_data["instancesDB"] == "browser":
+    if config_data["instancesDB"] == "browser" or config_data["instancesDB"] == "json":
         Logger.print_info("Remote mode already configured. Skipped ...")
         return
 
@@ -175,26 +175,39 @@ def get_remote_client_version(client: BaseWebClient) -> str | None:
 
 
 def backup_client_data(client: BaseWebClient) -> None:
-    name = client.name
+    version = ""
     src = client.client_dir
-    dest = client.backup_dir
+    if src.joinpath(".version").exists():
+        with open(src.joinpath(".version"), "r") as v:
+            version = v.readlines()[0]
 
-    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)
+    svc = BackupService()
+    target_path = svc.backup_root.joinpath(f"{client.client_dir.name}_{version}")
+    svc.backup_directory(
+        source_path=client.client_dir,
+        target_path=target_path,
+        backup_name=client.name,
+    )
+    svc.backup_file(
+        source_path=client.config_file,
+        target_path=target_path,
+    )
 
 
 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)
+    version = ""
+    src = client.client_dir
+    if src.joinpath(".version").exists():
+        with open(src.joinpath(".version"), "r") as v:
+            version = v.readlines()[0]
+
+    svc = BackupService()
+    target_path = svc.backup_root.joinpath(f"{client.client_dir.name}_{version}")
+    svc.backup_directory(
+        source_path=client.client_config.config_dir,
+        target_path=target_path,
+        backup_name=client.client_config.name,
+    )
 
 
 def get_existing_clients() -> List[BaseWebClient]:

kiauh/components/webui_client/fluidd_data.py

@@ -18,7 +18,6 @@ from components.webui_client.base_data import (
     WebClientConfigType,
     WebClientType,
 )
-from core.backup_manager import BACKUP_ROOT_DIR
 from core.constants import NGINX_SITES_AVAILABLE
 
 
@@ -30,7 +29,6 @@ class FluiddConfigWeb(BaseWebClientConfig):
     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"
 
 
@@ -43,7 +41,6 @@ class FluiddData(BaseWebClient):
     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_config: Path = NGINX_SITES_AVAILABLE.joinpath("fluidd")
     nginx_access_log: Path = Path("/var/log/nginx/fluidd-access.log")

kiauh/components/webui_client/mainsail_data.py

@@ -18,7 +18,6 @@ from components.webui_client.base_data import (
     WebClientConfigType,
     WebClientType,
 )
-from core.backup_manager import BACKUP_ROOT_DIR
 from core.constants import NGINX_SITES_AVAILABLE
 
 
@@ -30,7 +29,6 @@ class MainsailConfigWeb(BaseWebClientConfig):
     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"
 
 
@@ -43,7 +41,6 @@ class MainsailData(BaseWebClient):
     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_config: Path = NGINX_SITES_AVAILABLE.joinpath("mainsail")
     nginx_access_log: Path = Path("/var/log/nginx/mainsail-access.log")

kiauh/core/backup_manager/backup_manager.py

@@ -1,108 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-from __future__ import annotations
-
-import shutil
-from pathlib import Path
-from typing import List
-
-from core.backup_manager import BACKUP_ROOT_DIR
-from core.logger import Logger
-from utils.common import get_current_date
-
-
-class BackupManagerException(Exception):
-    pass
-
-
-# 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
-    ) -> bool:
-        Logger.print_status(f"Creating backup of {file} ...")
-
-        if not file.exists():
-            Logger.print_info("File does not exist! Skipping ...")
-            return False
-
-        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!")
-                return True
-            except OSError as e:
-                Logger.print_error(f"Unable to backup '{file}':\n{e}")
-                return False
-        else:
-            Logger.print_info(f"File '{file}' not found ...")
-            return False
-
-    def backup_directory(
-        self, name: str, source: Path, target: Path | None = None
-    ) -> Path | None:
-        Logger.print_status(f"Creating backup of {name} in {target} ...")
-
-        if source is None or not Path(source).exists():
-            Logger.print_info("Source directory does not exist! Skipping ...")
-            return None
-
-        target = self.backup_root_dir if target is None else target
-        try:
-            date = get_current_date().get("date")
-            time = get_current_date().get("time")
-            backup_target = target.joinpath(f"{name.lower()}-{date}-{time}")
-            shutil.copytree(
-                source,
-                backup_target,
-                ignore=self.ignore_folders_func,
-                ignore_dangling_symlinks=True,
-            )
-            Logger.print_ok("Backup successful!")
-
-            return backup_target
-
-        except OSError as e:
-            Logger.print_error(f"Unable to backup directory '{source}':\n{e}")
-            raise BackupManagerException(f"Unable to backup directory '{source}':\n{e}")
-
-    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 []
-        )

kiauh/core/constants.py

@@ -11,8 +11,6 @@ import os
 import pwd
 from pathlib import Path
 
-from core.backup_manager import BACKUP_ROOT_DIR
-
 # global dependencies
 GLOBAL_DEPS = ["git", "wget", "curl", "unzip", "dfu-util", "python3-virtualenv"]
 
@@ -24,7 +22,6 @@ CURRENT_USER = pwd.getpwuid(os.getuid())[0]
 
 # dirs
 SYSTEMD = Path("/etc/systemd/system")
-PRINTER_DATA_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("printer-data-backups")
 NGINX_SITES_AVAILABLE = Path("/etc/nginx/sites-available")
 NGINX_SITES_ENABLED = Path("/etc/nginx/sites-enabled")
 NGINX_CONFD = Path("/etc/nginx/conf.d")

kiauh/core/instance_manager/base_instance.py

@@ -16,8 +16,9 @@ from typing import List
 
 from utils.fs_utils import get_data_dir
 
-SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion"]
-
+# suffixes that are not allowed to be used for instances
+# because they would cause conflicts with other components or are reserved
+SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion", "hmi"]
 
 @dataclass(repr=True)
 class BaseInstance:

kiauh/core/menus/backup_menu.py

@@ -25,8 +25,8 @@ from components.webui_client.fluidd_data import FluiddData
 from components.webui_client.mainsail_data import MainsailData
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
+from core.services.backup_service import BackupService
 from core.types.color import Color
-from utils.common import backup_printer_config_dir
 
 
 # noinspection PyUnusedLocal
@@ -86,7 +86,7 @@ class BackupMenu(BaseMenu):
         backup_moonraker_dir()
 
     def backup_printer_config(self, **kwargs) -> None:
-        backup_printer_config_dir()
+        BackupService().backup_printer_config_dir()
 
     def backup_moonraker_db(self, **kwargs) -> None:
         backup_moonraker_db_dir()

kiauh/core/menus/repo_select_menu.py

@@ -10,14 +10,17 @@ from __future__ import annotations
 
 from typing import List, Literal, Type
 
-from core.logger import Logger
+from core.logger import Logger, DialogType
 from core.menus import Option
 from core.menus.base_menu import BaseMenu
 from core.settings.kiauh_settings import KiauhSettings, Repository
 from core.types.color import Color
 from procedures.switch_repo import run_switch_repo_routine
+from utils.input_utils import get_string_input, get_number_input, get_confirm
 
 
+# noinspection PyUnusedLocal
+# noinspection PyMethodMayBeStatic
 class RepoSelectMenu(BaseMenu):
     def __init__(
         self,
@@ -48,26 +51,27 @@ class RepoSelectMenu(BaseMenu):
 
     def set_options(self) -> None:
         self.options = {}
-
-        if not self.repos:
-            return
-
-        for idx, repo in enumerate(self.repos, start=1):
-            self.options[str(idx)] = Option(
-                method=self.select_repository, opt_data=repo
-            )
+        if self.repos:
+            for idx, repo in enumerate(self.repos, start=1):
+                self.options[str(idx)] = Option(
+                    method=self.select_repository, opt_data=repo
+                )
+        self.options["a"] = Option(method=self.add_repository)
+        self.options["r"] = Option(method=self.remove_repository)
+        self.options["b"] = Option(method=self.go_back)
 
     def print_menu(self) -> None:
         menu = "╟───────────────────────────────────────────────────────╢\n"
         menu += "║ Available Repositories:                               ║\n"
         menu += "╟───────────────────────────────────────────────────────╢\n"
-
         for idx, repo in enumerate(self.repos, start=1):
             url = f"● Repo: {repo.url.replace('.git', '')}"
             branch = f"└► Branch: {repo.branch}"
             menu += f"║ {idx}) {Color.apply(url, Color.CYAN):<59} ║\n"
             menu += f"║    {Color.apply(branch, Color.CYAN):<59} ║\n"
-
+        menu += "╟───────────────────────────────────────────────────────╢\n"
+        menu += "║ A) Add repository                                     ║\n"
+        menu += "║ R) Remove repository                                  ║\n"
         menu += "╟───────────────────────────────────────────────────────╢\n"
         print(menu, end="")
 
@@ -77,3 +81,82 @@ class RepoSelectMenu(BaseMenu):
             f"Switching to {self.name.capitalize()}'s new source repository ..."
         )
         run_switch_repo_routine(self.name, repo.url, repo.branch)
+
+    def add_repository(self, **kwargs) -> None:
+        while True:
+            Logger.print_dialog(
+                DialogType.CUSTOM,
+                custom_title="Enter the repository URL",
+                content=[
+                    "NOTE: There is no input validation in place, "
+                    "please check your input for correctness",
+                ],
+            )
+            url = get_string_input("Repository URL", allow_special_chars=True).strip()
+
+            Logger.print_dialog(
+                DialogType.CUSTOM,
+                custom_title="Enter the branch name",
+                content=[ "Press Enter to use the default branch (master)." ],
+                center_content=False,
+            )
+            branch = get_string_input("Branch", allow_special_chars=True, default="master").strip()
+            Logger.print_dialog(
+                DialogType.CUSTOM,
+                custom_title="Summary",
+                content=[
+                    f"● URL:    {url}",
+                    f"● Branch: {branch}",
+                ],
+            )
+            confirm = get_confirm("Save repository")
+            if confirm:
+                repo = Repository(url, branch)
+                if self.name == "klipper":
+                    self.settings.klipper.repositories.append(repo)
+                    self.settings.save()
+                    self.repos = self.settings.klipper.repositories
+                else:
+                    self.settings.moonraker.repositories.append(repo)
+                    self.settings.save()
+                    self.repos = self.settings.moonraker.repositories
+                Logger.print_ok("Repository added and saved.")
+
+                # Refresh menu to show new repo immediately and update options
+                self.set_options()
+                self.run()
+                break
+            else:
+                Logger.print_info("Operation cancelled by user.")
+                break
+
+    def remove_repository(self, **kwargs) -> None:
+        repos = self.repos
+        if not repos:
+            Logger.print_info("No repositories configured.")
+            return
+        repo_lines = [f"{idx}) {repo.url} [{repo.branch}]" for idx, repo in enumerate(repos, start=1)]
+        Logger.print_dialog(
+            DialogType.CUSTOM,
+            custom_title="Available Repositories",
+            content=[*repo_lines],
+        )
+        idx = get_number_input("Select the repository to remove", 1, len(repos))
+        removed = repos.pop(idx - 1)
+        if self.name == "klipper":
+            self.settings.klipper.repositories = repos
+            self.settings.save()
+            self.repos = self.settings.klipper.repositories
+        else:
+            self.settings.moonraker.repositories = repos
+            self.settings.save()
+            self.repos = self.settings.moonraker.repositories
+        Logger.print_ok(f"Removed repository: {removed.url} [{removed.branch}]")
+
+        # Refresh menu to show updated repo list and options
+        self.set_options()
+        self.run()
+
+    def go_back(self, **kwargs) -> None:
+        from core.menus.settings_menu import SettingsMenu
+        SettingsMenu().run()

kiauh/core/menus/settings_menu.py

@@ -117,20 +117,12 @@ class SettingsMenu(BaseMenu):
         )
 
     def switch_klipper_repo(self, **kwargs) -> None:
-        name = "Klipper"
         repos = self.settings.klipper.repositories
-        if not repos:
-            self._warn_no_repos(name)
-            return
-        RepoSelectMenu(name.lower(), repos=repos, previous_menu=self.__class__).run()
+        RepoSelectMenu("klipper", repos=repos, previous_menu=self.__class__).run()
 
     def switch_moonraker_repo(self, **kwargs) -> None:
-        name = "Moonraker"
         repos = self.settings.moonraker.repositories
-        if not repos:
-            self._warn_no_repos(name)
-            return
-        RepoSelectMenu(name.lower(), repos=repos, previous_menu=self.__class__).run()
+        RepoSelectMenu("moonraker", repos=repos, previous_menu=self.__class__).run()
 
     def toggle_mainsail_release(self, **kwargs) -> None:
         self.mainsail_unstable = not self.mainsail_unstable

kiauh/core/services/backup_service.py

@@ -0,0 +1,189 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import shutil
+from datetime import datetime
+from pathlib import Path
+from typing import List, Optional
+
+from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from core.logger import Logger
+from utils.instance_utils import get_instances
+
+
+class BackupService:
+    def __init__(self):
+        self._backup_root = Path.home().joinpath("kiauh_backups")
+
+    @property
+    def backup_root(self) -> Path:
+        return self._backup_root
+
+    @property
+    def timestamp(self) -> str:
+        return datetime.now().strftime("%Y%m%d-%H%M%S")
+
+    ################################################
+    # GENERIC BACKUP METHODS
+    ################################################
+
+    def backup_file(
+        self,
+        source_path: Path,
+        target_path: Optional[Path | str] = None,
+        target_name: Optional[str] = None,
+    ) -> bool:
+        source_path = Path(source_path)
+
+        Logger.print_status(f"Creating backup of {source_path} ...")
+
+        if not source_path.exists():
+            Logger.print_info(
+                f"File '{source_path}' does not exist! Skipping backup..."
+            )
+            return False
+
+        if not source_path.is_file():
+            Logger.print_info(f"'{source_path}' is not a file! Skipping backup...")
+            return False
+
+        try:
+            self._backup_root.mkdir(parents=True, exist_ok=True)
+
+            filename = (
+                target_name
+                or f"{source_path.stem}_{self.timestamp}{source_path.suffix}"
+            )
+            if target_path is not None:
+                backup_path = self._backup_root.joinpath(target_path, filename)
+            else:
+                backup_path = self._backup_root.joinpath(filename)
+
+            backup_path.mkdir(parents=True, exist_ok=True)
+            shutil.copy2(source_path, backup_path)
+
+            Logger.print_ok(
+                f"Successfully backed up '{source_path}' to '{backup_path}'"
+            )
+            return True
+
+        except Exception as e:
+            Logger.print_error(f"Failed to backup '{source_path}': {e}")
+            return False
+
+    def backup_directory(
+        self,
+        source_path: Path,
+        backup_name: str,
+        target_path: Optional[Path | str] = None,
+    ) -> Optional[Path]:
+        source_path = Path(source_path)
+
+        Logger.print_status(f"Creating backup of {source_path} ...")
+
+        if not source_path.exists():
+            Logger.print_info(
+                f"Directory '{source_path}' does not exist! Skipping backup..."
+            )
+            return None
+
+        if not source_path.is_dir():
+            Logger.print_info(f"'{source_path}' is not a directory! Skipping backup...")
+            return None
+
+        try:
+            self._backup_root.mkdir(parents=True, exist_ok=True)
+
+            backup_dir_name = f"{backup_name}_{self.timestamp}"
+
+            if target_path is not None:
+                backup_path = self._backup_root.joinpath(target_path, backup_dir_name)
+            else:
+                backup_path = self._backup_root.joinpath(backup_dir_name)
+
+            shutil.copytree(source_path, backup_path)
+
+            Logger.print_ok(
+                f"Successfully backed up '{source_path}' to '{backup_path}'"
+            )
+            return backup_path
+
+        except Exception as e:
+            Logger.print_error(f"Failed to backup directory '{source_path}': {e}")
+            return None
+
+    ################################################
+    # SPECIFIC BACKUP METHODS
+    ################################################
+
+    def backup_printer_cfg(self):
+        klipper_instances: List[Klipper] = get_instances(Klipper)
+        for instance in klipper_instances:
+            target_path: Path = self._backup_root.joinpath(
+                instance.data_dir.name, f"config_{self.timestamp}"
+            )
+            self.backup_file(
+                source_path=instance.cfg_file,
+                target_path=target_path,
+                target_name=instance.cfg_file.name,
+            )
+
+    def backup_moonraker_conf(self):
+        moonraker_instances: List[Moonraker] = get_instances(Moonraker)
+        for instance in moonraker_instances:
+            target_path: Path = self._backup_root.joinpath(
+                instance.data_dir.name, f"config_{self.timestamp}"
+            )
+            self.backup_file(
+                source_path=instance.cfg_file,
+                target_path=target_path,
+                target_name=instance.cfg_file.name,
+            )
+
+    def backup_printer_config_dir(self) -> None:
+        instances: List[Klipper] = get_instances(Klipper)
+        if not instances:
+            # fallback: search for printer data directories in the user's home directory
+            Logger.print_info("No Klipper instances found via systemd services.")
+            Logger.print_info(
+                "Attempting to find printer data directories in home directory..."
+            )
+
+            home_dir = Path.home()
+            printer_data_dirs = []
+
+            for pattern in ["printer_data", "printer_*_data"]:
+                for data_dir in home_dir.glob(pattern):
+                    if data_dir.is_dir():
+                        printer_data_dirs.append(data_dir)
+
+            if not printer_data_dirs:
+                Logger.print_info("Unable to find directory to backup!")
+                Logger.print_info(
+                    "No printer data directories found in home directory."
+                )
+                return
+
+            for data_dir in printer_data_dirs:
+                self.backup_directory(
+                    source_path=data_dir.joinpath("config"),
+                    target_path=data_dir.name,
+                    backup_name="config",
+                )
+
+            return
+
+        for instance in instances:
+            self.backup_directory(
+                source_path=instance.base.cfg_dir,
+                target_path=f"{instance.data_dir.name}",
+                backup_name="config",
+            )

kiauh/core/settings/kiauh_settings.py

@@ -8,14 +8,15 @@
 # ======================================================================= #
 from __future__ import annotations
 
+import shutil
 from dataclasses import dataclass, field
-from typing import Any, List
+from typing import Any, Callable, List, TypeVar
 
-from core.backup_manager.backup_manager import BackupManager
+from components.klipper import KLIPPER_REPO_URL
+from components.moonraker import MOONRAKER_REPO_URL
 from core.logger import DialogType, Logger
+from core.services.backup_service import BackupService
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
-    NoOptionError,
-    NoSectionError,
     SimpleConfigParser,
 )
 from utils.input_utils import get_confirm
@@ -26,13 +27,7 @@ from kiauh import PROJECT_ROOT
 DEFAULT_CFG = PROJECT_ROOT.joinpath("default.kiauh.cfg")
 CUSTOM_CFG = PROJECT_ROOT.joinpath("kiauh.cfg")
 
-
-class NoValueError(Exception):
-    """Raised when a required value is not defined for an option"""
-
-    def __init__(self, section: str, option: str):
-        msg = f"Missing value for option '{option}' in section '{section}'"
-        super().__init__(msg)
+T = TypeVar("T")
 
 
 class InvalidValueError(Exception):
@@ -53,17 +48,20 @@ class Repository:
     url: str
     branch: str
 
+
 @dataclass
 class KlipperSettings:
     repositories: List[Repository] | None = field(default=None)
     use_python_binary: str | None = field(default=None)
 
+
 @dataclass
 class MoonrakerSettings:
     optional_speedups: bool | None = field(default=None)
     repositories: List[Repository] | None = field(default=None)
     use_python_binary: str | None = field(default=None)
 
+
 @dataclass
 class WebUiSettings:
     port: int | None = field(default=None)
@@ -74,6 +72,7 @@ class WebUiSettings:
 # noinspection PyMethodMayBeStatic
 class KiauhSettings:
     __instance = None
+    __initialized = False
 
     def __new__(cls, *args, **kwargs) -> "KiauhSettings":
         if cls.__instance is None:
@@ -91,11 +90,10 @@ class KiauhSettings:
         return getattr(self, item)
 
     def __init__(self) -> None:
-        if not hasattr(self, "__initialized"):
-            self.__initialized = False
         if self.__initialized:
             return
         self.__initialized = True
+
         self.config = SimpleConfigParser()
         self.kiauh = AppSettings()
         self.klipper = KlipperSettings()
@@ -103,8 +101,9 @@ class KiauhSettings:
         self.mainsail = WebUiSettings()
         self.fluidd = WebUiSettings()
 
-        self._load_config()
+        self.__read_config_set_internal_state()
 
+    # todo: refactor this, at least rename to something else!
     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
@@ -122,135 +121,175 @@ class KiauhSettings:
             raise
 
     def save(self) -> None:
-        self._set_config_options_state()
-        self.config.write_file(CUSTOM_CFG)
-        self._load_config()
+        self.__write_internal_state_to_cfg()
+        self.__read_config_set_internal_state()
 
-    def _load_config(self) -> None:
+    def __read_config_set_internal_state(self) -> None:
         if not CUSTOM_CFG.exists() and not DEFAULT_CFG.exists():
-            self.__kill()
-
-        cfg = CUSTOM_CFG if CUSTOM_CFG.exists() else DEFAULT_CFG
-        self.config.read_file(cfg)
-
-        needs_migration = self._check_deprecated_repo_config()
-        if needs_migration:
-            self._prompt_migration_dialog()
-            return
-        else:
-            # Only validate if no migration was needed
-            self._validate_cfg()
-            self.__set_internal_state()
-
-    def _validate_cfg(self) -> None:
-        def __err_and_kill(error: str) -> None:
-            Logger.print_error(f"Error validating kiauh.cfg: {error}")
+            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()
 
-        try:
-            self._validate_bool("kiauh", "backup_before_update")
+        # copy default config to custom config if it does not exist
+        if not CUSTOM_CFG.exists():
+            shutil.copyfile(DEFAULT_CFG, CUSTOM_CFG)
 
-            self._validate_repositories("klipper", "repositories")
-            self._validate_repositories("moonraker", "repositories")
+        self.config.read_file(CUSTOM_CFG)
 
-            self._validate_int("mainsail", "port")
-            self._validate_bool("mainsail", "unstable_releases")
+        # check if there are deprecated repo_url and branch options in the kiauh.cfg
+        if self._check_deprecated_repo_config():
+            self._prompt_migration_dialog()
 
-            self._validate_int("fluidd", "port")
-            self._validate_bool("fluidd", "unstable_releases")
-            
-            self._validate_bool("moonraker", "optional_speedups")
-
-        except ValueError:
-            err = f"Invalid value for option '{self._v_option}' in section '{self._v_section}'"
-            __err_and_kill(err)
-        except NoSectionError:
-            err = f"Missing section '{self._v_section}' in config file"
-            __err_and_kill(err)
-        except NoOptionError:
-            err = f"Missing option '{self._v_option}' in section '{self._v_section}'"
-            __err_and_kill(err)
-        except NoValueError:
-            err = f"Missing value for option '{self._v_option}' in section '{self._v_section}'"
-            __err_and_kill(err)
-
-    def _validate_bool(self, section: str, option: str) -> None:
-        self._v_section, self._v_option = (section, option)
-        (bool(self.config.getboolean(section, option)))
-
-    def _validate_int(self, section: str, option: str) -> None:
-        self._v_section, self._v_option = (section, option)
-        int(self.config.getint(section, option))
-
-    def _validate_str(self, section: str, option: str) -> None:
-        self._v_section, self._v_option = (section, option)
-        v = self.config.getval(section, option)
-
-        if not v:
-            raise ValueError
-
-    def _validate_repositories(self, section: str, option: str) -> None:
-        self._v_section, self._v_option = (section, option)
-        repos = self.config.getval(section, option)
-        if not repos:
-            raise NoValueError(section, option)
-
-        for repo in repos:
-            if repo.strip().startswith("#") or repo.strip().startswith(";"):
-                continue
-            try:
-                if "," in repo:
-                    url, branch = repo.strip().split(",")
-                    if not url:
-                        raise InvalidValueError(section, option, repo)
-                else:
-                    url = repo.strip()
-                    if not url:
-                        raise InvalidValueError(section, option, repo)
-            except ValueError:
-                raise InvalidValueError(section, option, repo)
+        self.__set_internal_state()
 
     def __set_internal_state(self) -> None:
-        self.kiauh.backup_before_update = self.config.getboolean(
-            "kiauh", "backup_before_update"
+        # parse Kiauh options
+        self.kiauh.backup_before_update = self.__read_from_cfg(
+            "kiauh",
+            "backup_before_update",
+            self.config.getboolean,
+            False,
         )
 
-        self.moonraker.optional_speedups = self.config.getboolean("moonraker", "optional_speedups", True)
-
-        kl_repos = self.config.getval("klipper", "repositories")
-        self.klipper.repositories = self.__set_repo_state(kl_repos)
-
-        mr_repos = self.config.getval("moonraker", "repositories")
-        self.moonraker.repositories = self.__set_repo_state(mr_repos)
-
-        self.klipper.use_python_binary = self.config.getval("klipper", "use_python_binary", None)
-        self.moonraker.use_python_binary = self.config.getval("moonraker", "use_python_binary", None)
-
-        self.mainsail.port = self.config.getint("mainsail", "port")
-        self.mainsail.unstable_releases = self.config.getboolean(
-            "mainsail", "unstable_releases"
+        # parse Klipper options
+        self.klipper.use_python_binary = self.__read_from_cfg(
+            "klipper",
+            "use_python_binary",
+            self.config.getval,
+            None,
+            True,
         )
-        self.fluidd.port = self.config.getint("fluidd", "port")
-        self.fluidd.unstable_releases = self.config.getboolean(
-            "fluidd", "unstable_releases"
+        kl_repos: List[str] = self.__read_from_cfg(
+            "klipper",
+            "repositories",
+            self.config.getvals,
+            [KLIPPER_REPO_URL],
+        )
+        self.klipper.repositories = self.__set_repo_state("klipper", kl_repos)
+
+        # parse Moonraker options
+        self.moonraker.use_python_binary = self.__read_from_cfg(
+            "moonraker",
+            "use_python_binary",
+            self.config.getval,
+            None,
+            True,
+        )
+        self.moonraker.optional_speedups = self.__read_from_cfg(
+            "moonraker",
+            "optional_speedups",
+            self.config.getboolean,
+            True,
+        )
+        mr_repos: List[str] = self.__read_from_cfg(
+            "moonraker",
+            "repositories",
+            self.config.getvals,
+            [MOONRAKER_REPO_URL],
+        )
+        self.moonraker.repositories = self.__set_repo_state("moonraker", mr_repos)
+
+        # parse Mainsail options
+        self.mainsail.port = self.__read_from_cfg(
+            "mainsail",
+            "port",
+            self.config.getint,
+            80,
+        )
+        self.mainsail.unstable_releases = self.__read_from_cfg(
+            "mainsail",
+            "unstable_releases",
+            self.config.getboolean,
+            False,
         )
 
-    def __set_repo_state(self, repos: List[str]) -> List[Repository]:
+        # parse Fluidd options
+        self.fluidd.port = self.__read_from_cfg(
+            "fluidd",
+            "port",
+            self.config.getint,
+            80,
+        )
+        self.fluidd.unstable_releases = self.__read_from_cfg(
+            "fluidd",
+            "unstable_releases",
+            self.config.getboolean,
+            False,
+        )
+
+    def __check_option_exists(
+        self, section: str, option: str, fallback: Any, silent: bool = False
+    ) -> bool:
+        has_section = self.config.has_section(section)
+        has_option = self.config.has_option(section, option)
+
+        if not (has_section and has_option):
+            if not silent:
+                Logger.print_warn(
+                    f"Option '{option}' in section '{section}' not defined. Falling back to '{fallback}'."
+                )
+            return False
+        return True
+
+    def __read_bool_from_cfg(
+        self,
+        section: str,
+        option: str,
+        fallback: bool | None = None,
+        silent: bool = False,
+    ) -> bool | None:
+        if not self.__check_option_exists(section, option, fallback, silent):
+            return fallback
+        return self.config.getboolean(section, option, fallback)
+
+    def __read_from_cfg(
+        self,
+        section: str,
+        option: str,
+        getter: Callable[[str, str, T | None], T],
+        fallback: T = None,
+        silent: bool = False,
+    ) -> T:
+        if not self.__check_option_exists(section, option, fallback, silent):
+            return fallback
+        return getter(section, option, fallback)
+
+    def __set_repo_state(self, section: str, repos: List[str]) -> List[Repository]:
         _repos: List[Repository] = []
         for repo in repos:
-            if repo.strip().startswith("#") or repo.strip().startswith(";"):
-                continue
-            if "," in repo:
-                url, branch = repo.strip().split(",")
-                if not branch:
+            try:
+                if repo.strip().startswith("#") or repo.strip().startswith(";"):
+                    continue
+                if "," in repo:
+                    url, branch = repo.strip().split(",")
+
+                    if not branch:
+                        branch = "master"
+                else:
+                    url = repo.strip()
                     branch = "master"
-            else:
-                url = repo.strip()
-                branch = "master"
-            _repos.append(Repository(url.strip(), branch.strip()))
+
+                # url must not be empty otherwise it's considered
+                # as an unrecoverable, invalid configuration
+                if not url:
+                    raise InvalidValueError(section, "repositories", repo)
+
+                _repos.append(Repository(url.strip(), branch.strip()))
+
+            except InvalidValueError as e:
+                Logger.print_error(f"Error parsing kiauh.cfg: {e}")
+                kill()
+
         return _repos
 
-    def _set_config_options_state(self) -> None:
+    def __write_internal_state_to_cfg(self) -> None:
         """Updates the config with current settings, preserving values that haven't been modified"""
         if self.kiauh.backup_before_update is not None:
             self.config.set_option(
@@ -288,6 +327,8 @@ class KiauhSettings:
                 "fluidd", "unstable_releases", str(self.fluidd.unstable_releases)
             )
 
+        self.config.write_file(CUSTOM_CFG)
+
     def _check_deprecated_repo_config(self) -> bool:
         # repo_url and branch are deprecated - 2025.03.23
         for section in ["klipper", "moonraker"]:
@@ -299,22 +340,23 @@ class KiauhSettings:
 
     def _prompt_migration_dialog(self) -> None:
         migration_1: List[str] = [
-            "The old 'repo_url' and 'branch' options are now combined under 'repositories'.",
+            "Options 'repo_url' and 'branch' are now combined into a 'repositories' option.",
             "\n\n",
-            "Example format:",
-            "[klipper]",
-            "repositories:",
-            "    https://github.com/Klipper3d/klipper, master",
+            "● Old format:",
+            "  [klipper]",
+            "  repo_url: https://github.com/Klipper3d/klipper",
+            "  branch: master",
             "\n\n",
-            "[moonraker]",
-            "repositories:",
-            "    https://github.com/Arksine/moonraker, master",
+            "● New format:",
+            "  [klipper]",
+            "  repositories:",
+            "      https://github.com/Klipper3d/klipper, master",
         ]
         Logger.print_dialog(
             DialogType.ATTENTION,
             [
-                "Deprecated repository configuration found!",
-                "KAIUH can now attempt to automatically migrate your configuration.",
+                "Deprecated kiauh.cfg configuration found!",
+                "KAIUH can now attempt to automatically migrate the configuration.",
                 "\n\n",
                 *migration_1,
             ],
@@ -325,15 +367,15 @@ class KiauhSettings:
             Logger.print_dialog(
                 DialogType.ERROR,
                 [
-                    "Please update your configuration file manually.",
+                    "Please update the configuration file manually.",
                 ],
                 center_content=True,
             )
             kill()
 
     def _migrate_repo_config(self) -> None:
-        bm = BackupManager()
-        if not bm.backup_file(CUSTOM_CFG):
+        svc = BackupService()
+        if not svc.backup_file(CUSTOM_CFG):
             Logger.print_dialog(
                 DialogType.ERROR,
                 [
@@ -366,23 +408,7 @@ class KiauhSettings:
             self.config.write_file(CUSTOM_CFG)
             self.config.read_file(CUSTOM_CFG)  # reload config
 
-            # Validate the migrated config
-            self._validate_cfg()
-            self.__set_internal_state()
-
         except Exception as e:
             Logger.print_error(f"Error migrating configuration: {e}")
             Logger.print_error("Please migrate manually.")
             kill()
-
-    def __kill(self) -> None:
-        Logger.print_dialog(
-            DialogType.ERROR,
-            [
-                "No KIAUH configuration file found! Please make sure you have at least "
-                "one of the following configuration files in KIAUH's root directory:",
-                "● default.kiauh.cfg",
-                "● kiauh.cfg",
-            ],
-        )
-        kill()

kiauh/core/submodules/simple_config_parser/README.md

@@ -12,6 +12,7 @@ Specialized for handling Klipper style config files.
 - Option Block: A line starting with a word, followed by a `:` or `=` and a newline
 - Comment: A line starting with a `#` or `;`
 - Blank: A line containing only whitespace characters
+- SaveConfig: Klippers auto-generated SAVE_CONFIG section that can be found at the very end of the config file
 
 ---
 

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

@@ -49,6 +49,9 @@ LINE_COMMENT_RE = re.compile(r"^\s*[#;].*")
 #  - the line MUST contain only whitespace characters
 EMPTY_LINE_RE = re.compile(r"^\s*$")
 
+SAVE_CONFIG_START_RE = re.compile(r"^#\*# <-+ SAVE_CONFIG -+>$")
+SAVE_CONFIG_CONTENT_RE = re.compile(r"^#\*#.*$")
+
 BOOLEAN_STATES = {
     "1": True,
     "yes": True,

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

@@ -18,7 +18,7 @@ from ..simple_config_parser.constants import (
     LINE_COMMENT_RE,
     OPTION_RE,
     OPTIONS_BLOCK_START_RE,
-    SECTION_RE, LineType, INDENT,
+    SECTION_RE, LineType, INDENT, SAVE_CONFIG_START_RE, SAVE_CONFIG_CONTENT_RE,
 )
 
 _UNSET = object()
@@ -61,25 +61,34 @@ class SimpleConfigParser:
 
     def __init__(self) -> None:
         self.header: List[str] = []
+        self.save_config_block: List[str] = []
         self.config: Dict = {}
         self.current_section: str | None = None
         self.current_opt_block: str | None = None
         self.in_option_block: bool = False
 
     def _match_section(self, line: str) -> bool:
-        """Wheter or not the given line matches the definition of a section"""
+        """Whether the given line matches the definition of a section"""
         return SECTION_RE.match(line) is not None
 
     def _match_option(self, line: str) -> bool:
-        """Wheter or not the given line matches the definition of an option"""
+        """Whether the given line matches the definition of an option"""
         return OPTION_RE.match(line) is not None
 
     def _match_options_block_start(self, line: str) -> bool:
-        """Wheter or not the given line matches the definition of a multiline option"""
+        """Whether the given line matches the definition of a multiline option"""
         return OPTIONS_BLOCK_START_RE.match(line) is not None
 
+    def _match_save_config_start(self, line: str) -> bool:
+        """Whether the given line matches the definition of a save config start"""
+        return SAVE_CONFIG_START_RE.match(line) is not None
+
+    def _match_save_config_content(self, line: str) -> bool:
+        """Whether the given line matches the definition of a save config content"""
+        return SAVE_CONFIG_CONTENT_RE.match(line) is not None
+
     def _match_line_comment(self, line: str) -> bool:
-        """Wheter or not the given line matches the definition of a comment"""
+        """Whether the given line matches the definition of a comment"""
         return LINE_COMMENT_RE.match(line) is not None
 
     def _match_empty_line(self, line: str) -> bool:
@@ -124,6 +133,14 @@ class SimpleConfigParser:
                     element["value"].append(line.strip()) # indentation is removed
                     break
 
+        elif self._match_save_config_start(line):
+            self.current_opt_block = None
+            self.save_config_block.append(line)
+
+        elif self._match_save_config_content(line):
+            self.current_opt_block = None
+            self.save_config_block.append(line)
+
         elif self._match_empty_line(line) or self._match_line_comment(line):
             self.current_opt_block = None
 
@@ -185,6 +202,11 @@ class SimpleConfigParser:
                     if not last_line.endswith("\n"):
                         f.write("\n")
 
+            if self.save_config_block:
+                for line in self.save_config_block:
+                    f.write(line)
+                f.write("\n")
+
     def get_sections(self) -> List[str]:
         """Return a list of all section names, but exclude any section starting with '#_'"""
         return list(
@@ -314,9 +336,7 @@ class SimpleConfigParser:
                     elements.pop(i)
                     break
 
-    def getval(
-        self, section: str, option: str, fallback: str | _UNSET = _UNSET
-    ) -> str | List[str]:
+    def getval(self, section: str, option: str, fallback: str | _UNSET = _UNSET) -> str:
         """
         Return the value of the given option in the given section
 
@@ -329,22 +349,34 @@ class SimpleConfigParser:
             if option not in self.get_options(section):
                 raise NoOptionError(option, section)
 
-            # Find the option in the elements list
             for element in self.config[section]["elements"]:
-                if element["type"] in [LineType.OPTION.value, LineType.OPTION_BLOCK.value] and element["name"] == option:
-                    raw_value = element["value"]
-                    if isinstance(raw_value, str) and raw_value.endswith("\n"):
-                        return raw_value[:-1].strip()
-                    elif isinstance(raw_value, list):
-                        values: List[str] = []
-                        for i, val in enumerate(raw_value):
-                            val = val.strip().strip("\n")
-                            if len(val) < 1:
-                                continue
-                            values.append(val.strip())
-                        return values
-                    return str(raw_value)
-            raise NoOptionError(option, section)
+                if element["type"] is LineType.OPTION.value and element["name"] == option:
+                    return str(element["value"].strip().replace("\n", ""))
+            return ""
+
+        except (NoSectionError, NoOptionError):
+            if fallback is _UNSET:
+                raise
+            return fallback
+
+    def getvals(self, section: str, option: str, fallback: List[str] | _UNSET = _UNSET) -> List[str]:
+        """
+        Return the values of the given multi-line option in the given section
+
+        If the key is not found and 'fallback' is provided, it is used as
+        a fallback value.
+        """
+        try:
+            if section not in self.get_sections():
+                raise NoSectionError(section)
+            if option not in self.get_options(section):
+                raise NoOptionError(option, section)
+
+            for element in self.config[section]["elements"]:
+                if element["type"] is LineType.OPTION_BLOCK.value and element["name"] == option:
+                    return [val.strip() for val in element["value"] if val.strip()]
+            return []
+
         except (NoSectionError, NoOptionError):
             if fallback is _UNSET:
                 raise

kiauh/core/submodules/simple_config_parser/tests/assets/test_config_4.cfg

@@ -0,0 +1,116 @@
+# a comment at the very top
+# should be treated as the file header
+
+# up to the first section, including all blank lines
+
+[section_1]
+option_1: value_1
+option_1_1: True # this is a boolean
+option_1_2: 5 ; this is an integer
+option_1_3: 1.123 #;this is a float
+
+[section_2] ; comment
+option_2: value_2
+
+; comment
+
+[section_3]
+option_3: value_3 # comment
+
+[section_4]
+# comment
+option_4: value_4
+
+[section number 5]
+#option_5: value_5
+option_5 = this.is.value-5
+multi_option:
+    # these are multi-line values
+    value_5_1
+    value_5_2 ; here is a comment
+    value_5_3
+option_5_1: value_5_1
+
+[gcode_macro M117]
+rename_existing: M117.1
+gcode:
+    {% if rawparams %}
+       {% set escaped_msg = rawparams.split(';', 1)[0].split('\x23', 1)[0]|replace('"', '\\"') %}
+       SET_DISPLAY_TEXT MSG="{escaped_msg}"
+       RESPOND TYPE=command MSG="{escaped_msg}"
+    {% else %}
+        SET_DISPLAY_TEXT
+    {% endif %}
+
+# SDCard 'looping' (aka Marlin M808 commands) support
+#
+# Support SDCard looping
+[sdcard_loop]
+[gcode_macro M486]
+gcode:
+    # Parameters known to M486 are as follows:
+    #   [C<flag>] Cancel the current object
+    #   [P<index>] Cancel the object with the given index
+    #   [S<index>] Set the index of the current object.
+    #       If the object with the given index has been canceled, this will cause
+    #       the firmware to skip to the next object. The value -1 is used to
+    #       indicate something that isn’t an object and shouldn’t be skipped.
+    #   [T<count>] Reset the state and set the number of objects
+    #   [U<index>] Un-cancel the object with the given index. This command will be
+    #       ignored if the object has already been skipped
+
+    {% if 'exclude_object' not in printer %}
+        {action_raise_error("[exclude_object] is not enabled")}
+    {% endif %}
+
+    {% if 'T' in params %}
+        EXCLUDE_OBJECT RESET=1
+
+      {% for i in range(params.T | int) %}
+        EXCLUDE_OBJECT_DEFINE NAME={i}
+      {% endfor %}
+    {% endif %}
+
+    {% if 'C' in params %}
+      EXCLUDE_OBJECT CURRENT=1
+    {% endif %}
+
+    {% if 'P' in params %}
+      EXCLUDE_OBJECT NAME={params.P}
+    {% endif %}
+
+    {% if 'S' in params %}
+        {% if params.S == '-1' %}
+            {% if printer.exclude_object.current_object %}
+                EXCLUDE_OBJECT_END NAME={printer.exclude_object.current_object}
+            {% endif %}
+        {% else %}
+            EXCLUDE_OBJECT_START NAME={params.S}
+        {% endif %}
+    {% endif %}
+
+    {% if 'U' in params %}
+        EXCLUDE_OBJECT RESET=1 NAME={params.U}
+    {% endif %}
+
+#*# <---------------------- SAVE_CONFIG ---------------------->
+#*# DO NOT EDIT THIS BLOCK OR BELOW. The contents are auto-generated.
+#*#
+#*# [bed_mesh default]
+#*# version = 1
+#*# points =
+#*# 	  -0.152500, -0.133125, -0.113125, -0.159375, -0.232500
+#*# 	  -0.095000, -0.078750, -0.068125, -0.133125, -0.235000
+#*# 	  -0.092500, -0.040625, 0.004375, -0.077500, -0.193125
+#*# 	  -0.073750, 0.023750, 0.085625, 0.026875, -0.085000
+#*# 	  -0.140625, 0.038125, 0.126250, 0.097500, 0.003750
+#*# tension = 0.2
+#*# min_x = 26.0
+#*# algo = bicubic
+#*# y_count = 5
+#*# mesh_y_pps = 2
+#*# min_y = 5.0
+#*# x_count = 5
+#*# max_y = 174.0
+#*# mesh_x_pps = 2
+#*# max_x = 194.0

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_save_config_content/test_data/matching_data.txt

@@ -0,0 +1,22 @@
+#*# any content
+#*#
+#*# DO NOT EDIT THIS BLOCK OR BELOW. The contents are auto-generated.
+#*#
+#*# [bed_mesh default]
+#*# version = 1
+#*# points =
+#*# 	  -0.152500, -0.133125, -0.113125, -0.159375, -0.232500
+#*# 	  -0.095000, -0.078750, -0.068125, -0.133125, -0.235000
+#*# 	  -0.092500, -0.040625, 0.004375, -0.077500, -0.193125
+#*# 	  -0.073750, 0.023750, 0.085625, 0.026875, -0.085000
+#*# 	  -0.140625, 0.038125, 0.126250, 0.097500, 0.003750
+#*# tension = 0.2
+#*# min_x = 26.0
+#*# algo = bicubic
+#*# y_count = 5
+#*# mesh_y_pps = 2
+#*# min_y = 5.0
+#*# x_count = 5
+#*# max_y = 174.0
+#*# mesh_x_pps = 2
+#*# max_x = 194.0

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_save_config_content/test_data/non_matching_data.txt

@@ -0,0 +1,6 @@
+ #*# leading space prevents match
+random
+*# not starting with hash-star-hash
+#   *# spaced out
+<- SAVE_CONFIG ->
+;#*# semicolon first

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_save_config_content/test_match_save_config_content.py

@@ -0,0 +1,37 @@
+# ======================================================================= #
+#  Copyright (C) 2024 Dominik Willner <th33xitus@gmail.com>               #
+#                                                                         #
+#  https://github.com/dw-0/simple-config-parser                           #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+
+import pytest
+
+from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from tests.utils import load_testdata_from_file
+
+BASE_DIR = Path(__file__).parent.joinpath("test_data")
+MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
+NON_MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("non_matching_data.txt")
+
+
+@pytest.fixture
+def parser():
+    return SimpleConfigParser()
+
+
+def test_matching_lines(parser):
+    """Alle Zeilen in matching_data.txt sollen als Save-Config-Content erkannt werden."""
+    matching_lines = load_testdata_from_file(MATCHING_TEST_DATA_PATH)
+    for line in matching_lines:
+        assert parser._match_save_config_content(line) is True, f"Line should be a save config content: {line!r}"
+
+
+def test_non_matching_lines(parser):
+    """Alle Zeilen in non_matching_data.txt sollen NICHT als Save-Config-Content erkannt werden."""
+    non_matching_lines = load_testdata_from_file(NON_MATCHING_TEST_DATA_PATH)
+    for line in non_matching_lines:
+        assert parser._match_save_config_content(line) is False, f"Line should not be a save config content: {line!r}"

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_save_config_start/test_data/matching_data.txt

@@ -0,0 +1,6 @@
+#*# <- SAVE_CONFIG ->
+#*# <---- SAVE_CONFIG ---->
+#*# <------------------- SAVE_CONFIG ------------------->
+#*# <---------------------- SAVE_CONFIG ---------------------->
+#*# <----- SAVE_CONFIG ->
+#*# <- SAVE_CONFIG ----------------->

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_save_config_start/test_data/non_matching_data.txt

@@ -0,0 +1,13 @@
+#*#<- SAVE_CONFIG ->
+#*# <-SAVE_CONFIG ->
+#*# <- SAVE_CONFIG->
+#*# <- SAVE_CONFIG -> extra
+#*# SAVE_CONFIG ---->
+#*# < SAVE_CONFIG >
+# *# <- SAVE_CONFIG ->
+<- SAVE_CONFIG ->
+random text
+ #*# <---------------------- SAVE_CONFIG ---------------------->
+#*# <---------------------- SAVE_CONFIG ----------------------> #*#
+#*# <-------------------------------------------->
+#*# SAVE_CONFIG

kiauh/core/submodules/simple_config_parser/tests/line_matching/match_save_config_start/test_match_save_config_start.py

@@ -0,0 +1,37 @@
+# ======================================================================= #
+#  Copyright (C) 2024 Dominik Willner <th33xitus@gmail.com>               #
+#                                                                         #
+#  https://github.com/dw-0/simple-config-parser                           #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+
+import pytest
+
+from src.simple_config_parser.simple_config_parser import SimpleConfigParser
+from tests.utils import load_testdata_from_file
+
+BASE_DIR = Path(__file__).parent.joinpath("test_data")
+MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
+NON_MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("non_matching_data.txt")
+
+
+@pytest.fixture
+def parser():
+    return SimpleConfigParser()
+
+
+def test_matching_lines(parser):
+    """Test that all lines in the matching data file are correctly identified as save config start lines."""
+    matching_lines = load_testdata_from_file(MATCHING_TEST_DATA_PATH)
+    for line in matching_lines:
+        assert parser._match_save_config_start(line) is True, f"Line should be a save config start: {line!r}"
+
+
+def test_non_matching_lines(parser):
+    """Test that all lines in the non-matching data file are correctly identified as not save config start lines."""
+    non_matching_lines = load_testdata_from_file(NON_MATCHING_TEST_DATA_PATH)
+    for line in non_matching_lines:
+        assert parser._match_save_config_start(line) is False, f"Line should not be a save config start: {line!r}"

kiauh/core/submodules/simple_config_parser/tests/public_api/conftest.py

@@ -13,7 +13,7 @@ from src.simple_config_parser.simple_config_parser import SimpleConfigParser
 from tests.utils import load_testdata_from_file
 
 BASE_DIR = Path(__file__).parent.parent.joinpath("assets")
-CONFIG_FILES = ["test_config_1.cfg", "test_config_2.cfg", "test_config_3.cfg"]
+CONFIG_FILES = ["test_config_1.cfg", "test_config_2.cfg", "test_config_3.cfg", "test_config_4.cfg"]
 
 
 @pytest.fixture(params=CONFIG_FILES)

kiauh/core/submodules/simple_config_parser/tests/public_api/test_options_api.py

@@ -51,7 +51,7 @@ def test_getval(parser):
     assert parser.getval("section_2", "option_2") == "value_2"
 
     # test multiline option values
-    ml_val = parser.getval("section number 5", "multi_option")
+    ml_val = parser.getvals("section number 5", "multi_option")
     assert isinstance(ml_val, list)
     assert len(ml_val) > 0
 
@@ -164,7 +164,7 @@ def test_set_new_option(parser):
     assert parser.getval("new_section", "very_new_option") == "very_new_value"
 
     parser.set_option("section_2", "array_option", ["value_1", "value_2", "value_3"])
-    assert parser.getval("section_2", "array_option") == [
+    assert parser.getvals("section_2", "array_option") == [
         "value_1",
         "value_2",
         "value_3",

kiauh/extensions/extensions_menu.py

@@ -143,6 +143,31 @@ class ExtensionSubmenu(BaseMenu):
             """
         )[1:]
         menu += f"{description_text}\n"
+
+        # add links if available
+        website: str = (self.extension.metadata.get("website") or "").strip()
+        repo: str = (self.extension.metadata.get("repo") or "").strip()
+        if website or repo:
+            links_lines: List[str] = ["Links:"]
+            if website:
+                links_lines.append(f"● {website}")
+            if repo:
+                links_lines.append(f"● {repo}")
+
+            links_text = Logger.format_content(
+                links_lines,
+                line_width,
+                border_left="║",
+                border_right="║",
+            )
+
+            menu += textwrap.dedent(
+                """
+                ╟───────────────────────────────────────────────────────╢
+                """
+            )[1:]
+            menu += f"{links_text}\n"
+
         menu += textwrap.dedent(
             """
             ╟───────────────────────────────────────────────────────╢

kiauh/extensions/gcode_shell_cmd/gcode_shell_cmd_extension.py

@@ -9,12 +9,13 @@
 
 import os
 import shutil
+from datetime import datetime
 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.services.backup_service import BackupService
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
@@ -109,11 +110,13 @@ class GcodeShellCmdExtension(BaseExtension):
                 Logger.warn(f"Unable to create example config: {e}")
 
         # backup each printer.cfg before modification
-        bm = BackupManager()
+        svc = BackupService()
+        timestamp = datetime.now().strftime("%Y%m%d-%H%M%S")
         for instance in instances:
-            bm.backup_file(
-                instance.cfg_file,
-                custom_filename=f"{instance.suffix}.printer.cfg",
+            svc.backup_file(
+                source_path=instance.cfg_file,
+                target_path=f"{instance.data_dir.name}/config_{timestamp}",
+                target_name=instance.cfg_file.name,
             )
 
         # add section to printer.cfg if not already defined

kiauh/extensions/gcode_shell_cmd/metadata.json

@@ -4,6 +4,7 @@
     "module": "gcode_shell_cmd_extension",
     "maintained_by": "dw-0",
     "display_name": "G-Code Shell Command",
-    "description": ["Run a shell commands from gcode."]
+    "description": ["Run a shell commands from gcode."],
+    "updates": false
   }
 }

kiauh/extensions/klipper_backup/metadata.json

@@ -5,6 +5,8 @@
     "maintained_by": "Staubgeborener",
     "display_name": "Klipper-Backup",
     "description": ["Backup all your Klipper files to GitHub"],
+    "website": "https://klipperbackup.xyz",
+    "repo": "https://github.com/Staubgeborener/klipper-backup",
     "updates": true
   }
 }

kiauh/extensions/mainsail_theme_installer/metadata.json

@@ -4,6 +4,8 @@
     "module": "mainsail_theme_installer_extension",
     "maintained_by": "dw-0",
     "display_name": "Mainsail Theme Installer",
-    "description": ["Install Mainsail Themes maintained by the Mainsail community."]
+    "description": ["Install Mainsail Themes maintained by the Mainsail community."],
+    "website": "https://docs.mainsail.xyz/theming/themes",
+    "updates": false
   }
 }

kiauh/extensions/mobileraker/__init__.py

@@ -9,7 +9,6 @@
 
 from pathlib import Path
 
-from core.backup_manager import BACKUP_ROOT_DIR
 from core.constants import SYSTEMD
 
 # repo
@@ -23,7 +22,6 @@ 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")

kiauh/extensions/mobileraker/metadata.json

@@ -7,6 +7,7 @@
         "description": [
             "Companion for Mobileraker, enabling push notification for Klipper using Moonraker."
         ],
+        "repo": "https://github.com/Clon1998/mobileraker_companion",
         "updates": true
     }
 }

kiauh/extensions/mobileraker/mobileraker_extension.py

@@ -13,13 +13,12 @@ from typing import List
 
 from components.klipper.klipper import Klipper
 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.services.backup_service import BackupService
 from core.settings.kiauh_settings import KiauhSettings
 from extensions.base_extension import BaseExtension
 from extensions.mobileraker import (
-    MOBILERAKER_BACKUP_DIR,
     MOBILERAKER_DIR,
     MOBILERAKER_ENV_DIR,
     MOBILERAKER_INSTALL_SCRIPT,
@@ -152,6 +151,7 @@ class MobilerakerExtension(BaseExtension):
                 Logger.print_status(
                     "Removing Mobileraker's companion from update manager ..."
                 )
+                BackupService().backup_moonraker_conf()
                 remove_config_section(MOBILERAKER_UPDATER_SECTION_NAME, mr_instances)
                 Logger.print_ok(
                     "Mobileraker's companion successfully removed from update manager!"
@@ -163,6 +163,7 @@ class MobilerakerExtension(BaseExtension):
             Logger.print_error(f"Error removing Mobileraker's companion:\n{e}")
 
     def _patch_mobileraker_update_manager(self, instances: List[Moonraker]) -> None:
+        BackupService().backup_moonraker_conf()
         add_config_section(
             section=MOBILERAKER_UPDATER_SECTION_NAME,
             instances=instances,
@@ -179,14 +180,14 @@ class MobilerakerExtension(BaseExtension):
         )
 
     def _backup_mobileraker_dir(self) -> None:
-        bm = BackupManager()
-        bm.backup_directory(
-            MOBILERAKER_DIR.name,
-            source=MOBILERAKER_DIR,
-            target=MOBILERAKER_BACKUP_DIR,
+        svc = BackupService()
+        svc.backup_directory(
+            source_path=MOBILERAKER_DIR,
+            backup_name="mobileraker",
+            target_path="mobileraker",
         )
-        bm.backup_directory(
-            MOBILERAKER_ENV_DIR.name,
-            source=MOBILERAKER_ENV_DIR,
-            target=MOBILERAKER_BACKUP_DIR,
+        svc.backup_directory(
+            source_path=MOBILERAKER_ENV_DIR,
+            backup_name="mobileraker-env",
+            target_path="mobileraker",
         )

kiauh/extensions/obico/metadata.json

@@ -11,6 +11,8 @@
         "- 25FPS High-Def Webcam Streaming",
         "- Free 4.9-Star Mobile App"
     ],
+    "website": "https://obico.io",
+    "repo": "github.com/TheSpaghettiDetective/moonraker-obico",
     "updates": true
   }
 }

kiauh/extensions/obico/moonraker_obico_extension.py

@@ -14,6 +14,7 @@ from components.moonraker.moonraker import Moonraker
 from core.instance_manager.base_instance import SUFFIX_BLACKLIST
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
+from core.services.backup_service import BackupService
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
@@ -31,7 +32,10 @@ from extensions.obico import (
 from extensions.obico.moonraker_obico import (
     MoonrakerObico,
 )
-from utils.common import check_install_dependencies, moonraker_exists
+from utils.common import (
+    check_install_dependencies,
+    moonraker_exists,
+)
 from utils.config_utils import (
     add_config_section,
     remove_config_section,
@@ -119,6 +123,8 @@ class ObicoExtension(BaseExtension):
 
             cmd_sysctl_manage("daemon-reload")
 
+            BackupService().backup_printer_config_dir()
+
             # add to klippers config
             self._patch_printer_cfg(kl_instances)
             InstanceManager.restart_all(kl_instances)
@@ -165,6 +171,7 @@ class ObicoExtension(BaseExtension):
             self._remove_obico_instances(ob_instances)
             self._remove_obico_dir()
             self._remove_obico_env()
+            BackupService().backup_printer_config_dir()
             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(

kiauh/extensions/octoapp/metadata.json

@@ -12,6 +12,7 @@
             "- Live Gcode preview",
             "- And much much more!"
         ],
+        "repo": "https://github.com/crysxd/OctoApp-Plugin",
         "updates": true
     }
 }

kiauh/extensions/octoapp/octoapp_extension.py

@@ -13,6 +13,7 @@ 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.services.backup_service import BackupService
 from extensions.base_extension import BaseExtension
 from extensions.octoapp import (
     OA_DEPS_JSON_FILE,
@@ -133,6 +134,7 @@ class OctoappExtension(BaseExtension):
             self._remove_OA_store_dirs()
             self._remove_OA_dir()
             self._remove_OA_env()
+            BackupService().backup_moonraker_conf()
             remove_config_section(f"include {OA_SYS_CFG_NAME}", mr_instances)
             run_remove_routines(OA_INSTALLER_LOG_FILE)
             Logger.print_dialog(

kiauh/extensions/octoeverywhere/metadata.json

@@ -11,6 +11,8 @@
             "- Real-time Notifications",
             "- Live Streaming, and More!"
         ],
+        "website": "https://octoeverywhere.com",
+        "repo": "github.com/QuinnDamerell/OctoPrint-OctoEverywhere",
         "updates": true
     }
 }

kiauh/extensions/octoeverywhere/octoeverywhere_extension.py

@@ -12,6 +12,7 @@ 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 core.services.backup_service import BackupService
 from extensions.base_extension import BaseExtension
 from extensions.octoeverywhere import (
     OE_DEPS_JSON_FILE,
@@ -133,6 +134,7 @@ class OctoeverywhereExtension(BaseExtension):
             self._remove_oe_instances(ob_instances)
             self._remove_oe_dir()
             self._remove_oe_env()
+            BackupService().backup_moonraker_conf()
             remove_config_section(f"include {OE_SYS_CFG_NAME}", mr_instances)
             run_remove_routines(OE_INSTALLER_LOG_FILE)
             Logger.print_dialog(

kiauh/extensions/octoprint/__init__.py

@@ -6,7 +6,17 @@
 #                                                                         #
 #  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")
+# Constants
+OP_DEFAULT_PORT = 5000
+
+# OctoPrint instance naming/prefixes
+OP_ENV_PREFIX = "OctoPrint"
+OP_BASEDIR_PREFIX = ".octoprint"
+
+# Service/log filenames
+OP_LOG_NAME = "octoprint.log"
+
+# Files/paths (computed per-instance where applicable)
+OP_SUDOERS_FILE = Path("/etc/sudoers.d/octoprint-shutdown")

kiauh/extensions/octoprint/metadata.json

@@ -0,0 +1,18 @@
+{
+  "metadata": {
+    "index": 12,
+    "module": "octoprint_extension",
+    "maintained_by": "dw-0",
+    "display_name": "OctoPrint",
+    "description": [
+      "Open-source web interface to control and monitor your 3D printer",
+      "- Upload and manage G-code, start/pause/cancel prints",
+      "- Live webcam view and timelapse support",
+      "- Real-time temperature graphs and printer status",
+      "- Powerful plugin ecosystem"
+    ],
+    "website": "https://octoprint.org",
+    "repo": "https://github.com/OctoPrint/OctoPrint",
+    "updates": false
+  }
+}

kiauh/extensions/octoprint/octoprint.py

@@ -0,0 +1,116 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from pathlib import Path
+from textwrap import dedent
+
+from components.klipper.klipper import Klipper
+from core.constants import CURRENT_USER
+from core.instance_manager.base_instance import BaseInstance
+from core.logger import Logger
+from extensions.octoprint import (
+    OP_BASEDIR_PREFIX,
+    OP_ENV_PREFIX,
+    OP_LOG_NAME,
+)
+from utils.fs_utils import create_folders
+from utils.sys_utils import create_service_file, get_service_file_path
+
+
+@dataclass
+class Octoprint:
+    suffix: str
+    base: BaseInstance = field(init=False, repr=False)
+    service_file_path: Path = field(init=False)
+    log_file_name = OP_LOG_NAME
+    env_dir: Path = field(init=False)
+    basedir: Path = field(init=False)
+    cfg_file: Path = field(init=False)
+
+    def __post_init__(self):
+        self.base = BaseInstance(Klipper, self.suffix)
+        self.base.log_file_name = self.log_file_name
+
+        self.service_file_path = get_service_file_path(Octoprint, self.suffix)
+
+        # OctoPrint stores its data under ~/.octoprint[_SUFFIX]
+        self.basedir = (
+            Path.home().joinpath(OP_BASEDIR_PREFIX)
+            if self.suffix == ""
+            else Path.home().joinpath(f"{OP_BASEDIR_PREFIX}_{self.suffix}")
+        )
+        self.cfg_file = self.basedir.joinpath("config.yaml")
+
+        # OctoPrint virtualenv lives under ~/OctoPrint[_SUFFIX]
+        self.env_dir = (
+            Path.home().joinpath(OP_ENV_PREFIX)
+            if self.suffix == ""
+            else Path.home().joinpath(f"{OP_ENV_PREFIX}_{self.suffix}")
+        )
+
+    def create(self, port: int) -> None:
+        Logger.print_status(
+            f"Creating OctoPrint instance '{self.service_file_path.stem}' ..."
+        )
+
+        # Ensure basedir exists and config.yaml is present
+        create_folders([self.basedir])
+        if not self.cfg_file.exists():
+            Logger.print_status("Creating config.yaml ...")
+            self.cfg_file.write_text(self._prep_config_yaml())
+            Logger.print_ok("config.yaml created!")
+        else:
+            Logger.print_info("config.yaml already exists. Skipped ...")
+
+        create_service_file(self.service_file_path.name, self._prep_service_content(port))
+
+    def _prep_service_content(self, port: int) -> str:
+        basedir = self.basedir.as_posix()
+        cfg = self.cfg_file.as_posix()
+        octo_exec = self.env_dir.joinpath("bin/octoprint").as_posix()
+
+        return dedent(
+            f"""\
+            [Unit]
+            Description=Starts OctoPrint on startup
+            After=network-online.target
+            Wants=network-online.target
+
+            [Service]
+            Environment="LC_ALL=C.UTF-8"
+            Environment="LANG=C.UTF-8"
+            Type=simple
+            User={CURRENT_USER}
+            ExecStart={octo_exec} --basedir {basedir} --config {cfg} --port={port} serve
+
+            [Install]
+            WantedBy=multi-user.target
+            """
+        )
+
+    def _prep_config_yaml(self) -> str:
+        printer = self.base.comms_dir.joinpath("klippy.serial").as_posix()
+        restart_service = self.service_file_path.stem
+
+        return dedent(
+            f"""\
+            serial:
+                additionalPorts:
+                - {printer}
+                disconnectOnErrors: false
+                port: {printer}
+            server:
+                commands:
+                    serverRestartCommand: sudo service {restart_service} restart
+                    systemRestartCommand: sudo shutdown -r now
+                    systemShutdownCommand: sudo shutdown -h now
+            """
+        )

kiauh/extensions/octoprint/octoprint_extension.py

@@ -0,0 +1,286 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import re
+from typing import Dict, List, Optional, Set
+
+from components.klipper.klipper import Klipper
+from core.instance_manager.instance_manager import InstanceManager
+from core.logger import DialogType, Logger
+from core.types.color import Color
+from core.menus.base_menu import print_back_footer
+from extensions.base_extension import BaseExtension
+from extensions.octoprint import (
+    OP_SUDOERS_FILE, OP_DEFAULT_PORT,
+)
+from extensions.octoprint.octoprint import Octoprint
+from utils.common import check_install_dependencies
+from utils.fs_utils import run_remove_routines, remove_with_sudo
+from utils.input_utils import get_selection_input, get_confirm
+from utils.instance_utils import get_instances
+from utils.sys_utils import (
+    create_python_venv,
+    get_ipv4_addr,
+    install_python_packages,
+)
+
+
+# noinspection PyMethodMayBeStatic
+class OctoprintExtension(BaseExtension):
+    def install_extension(self, **kwargs) -> None:
+        Logger.print_status("Installing OctoPrint ...")
+
+        klipper_instances: List[Klipper] = get_instances(Klipper)
+        if not klipper_instances:
+            Logger.print_dialog(
+                DialogType.WARNING,
+                [
+                    "Klipper not found! Please install Klipper first.",
+                ],
+            )
+            return
+
+        existing_ops: List[Octoprint] = get_instances(Octoprint)
+        existing_by_suffix: Dict[str, Octoprint] = {op.suffix: op for op in existing_ops}
+        candidates: List[Klipper] = [k for k in klipper_instances if k.suffix not in existing_by_suffix]
+
+        chosen: List[Klipper] = []
+
+        if len(klipper_instances) == 1:
+            k = klipper_instances[0]
+            if k.suffix in existing_by_suffix:
+                if not get_confirm(
+                    f"OctoPrint already exists for '{k.service_file_path.stem}'. Reinstall?",
+                    default_choice=True,
+                    allow_go_back=True,
+                ):
+                    Logger.print_info("Aborted OctoPrint installation.")
+                    return
+            chosen = [k]
+        else:
+            while True:
+                dialog = "╔═══════════════════════════════════════════════════════╗\n"
+                headline = Color.apply(
+                    "The following Klipper instances were found:", Color.GREEN
+                )
+                dialog += f"║{headline:^64}║\n"
+                dialog += "╟───────────────────────────────────────────────────────╢\n"
+
+                if candidates:
+                    line_all = Color.apply("a) Select all (install for all missing)", Color.YELLOW)
+                    dialog += f"║ {line_all:<63}║\n"
+                    dialog += "║                                                       ║\n"
+
+                index_map: Dict[str, Klipper] = {}
+                for i, k in enumerate(klipper_instances, start=1):
+                    mapping = existing_by_suffix.get(k.suffix)
+                    suffix = f" <-> {mapping.service_file_path.stem}" if mapping else ""
+                    line = Color.apply(f"{i}) {k.service_file_path.stem}{suffix}", Color.CYAN)
+                    dialog += f"║ {line:<63}║\n"
+                    index_map[str(i)] = k
+
+                dialog += "╟───────────────────────────────────────────────────────╢\n"
+                print(dialog, end="")
+                print_back_footer()
+
+                allowed = list(index_map.keys()) + ["b"] + (["a"] if candidates else [])
+                choice = get_selection_input("Choose instance to install OctoPrint for", allowed)
+
+                if choice == "b":
+                    Logger.print_info("Aborted OctoPrint installation.")
+                    return
+                if choice == "a":
+                    chosen = candidates
+                    break
+
+                selected = index_map[choice]
+                if selected.suffix in existing_by_suffix:
+                    confirm = get_confirm(
+                        f"OctoPrint already exists for '{selected.service_file_path.stem}'. Reinstall?",
+                        default_choice=True,
+                        allow_go_back=True,
+                    )
+                    if not confirm:
+                        # back to menu
+                        continue
+                chosen = [selected]
+                break
+
+        deps = {
+            "git",
+            "wget",
+            "python3-pip",
+            "python3-dev",
+            "libyaml-dev",
+            "build-essential",
+            "python3-setuptools",
+            "python3-virtualenv",
+        }
+        check_install_dependencies(deps)
+
+        # Determine used ports from existing OctoPrint services and prepare regex
+        used_ports: Set[int] = set()
+        port_re = re.compile(r"--port=(\d+)")
+        for op in existing_ops:
+            try:
+                content = op.service_file_path.read_text()
+                m = port_re.search(content)
+                if m:
+                    used_ports.add(int(m.group(1)))
+            except OSError:
+                pass
+
+        # noinspection PyShadowingNames
+        def read_existing_port(suffix: str) -> Optional[int]:
+            op = existing_by_suffix.get(suffix)
+            if not op:
+                return None
+            try:
+                content = op.service_file_path.read_text()
+                m = port_re.search(content)
+                return int(m.group(1)) if m else None
+            except OSError:
+                return None
+
+        def next_free_port(start: int, used: Set[int]) -> int:
+            p = start
+            while p in used:
+                p += 1
+            used.add(p)
+            return p
+
+        created_ops: List[Octoprint] = []
+        for k in chosen:
+            # Keep existing port on reinstall, otherwise assign next free one
+            existing_port = read_existing_port(k.suffix)
+            port = existing_port if existing_port is not None else next_free_port(OP_DEFAULT_PORT, used_ports)
+
+            instance = Octoprint(suffix=k.suffix)
+
+            if create_python_venv(instance.env_dir, force=False):
+                Logger.print_ok(
+                    f"Virtualenv created: {instance.env_dir}", prefix=False
+                )
+            else:
+                Logger.print_info(
+                    f"Virtualenv exists: {instance.env_dir}. Skipping creation ..."
+                )
+
+            install_python_packages(instance.env_dir, ["octoprint"])
+
+            instance.create(port=port)
+            created_ops.append(instance)
+
+        for inst in created_ops:
+            try:
+                InstanceManager.enable(inst)
+                InstanceManager.start(inst)
+            except Exception as e:
+                Logger.print_error(
+                    f"Failed to enable/start {inst.service_file_path.name}: {e}"
+                )
+
+        ip = get_ipv4_addr()
+        lines = ["Access your new OctoPrint instance(s) at:"]
+        for inst in created_ops:
+            try:
+                content = inst.service_file_path.read_text()
+                m = port_re.search(content)
+                if m:
+                    # noinspection HttpUrlsUsage
+                    lines.append(f"● {inst.service_file_path.stem}: http://{ip}:{m.group(1)}")
+            except OSError:
+                pass
+
+        Logger.print_dialog(DialogType.SUCCESS, lines, center_content=False)
+
+    def remove_extension(self, **kwargs) -> None:
+        Logger.print_status("Removing OctoPrint ...")
+
+        try:
+            op_instances: List[Octoprint] = get_instances(Octoprint)
+            if not op_instances:
+                Logger.print_info("No OctoPrint instances found. Skipped ...")
+                return
+
+            remove_all = False
+            if len(op_instances) == 1:
+                to_remove = op_instances
+            else:
+                dialog = "╔═══════════════════════════════════════════════════════╗\n"
+                headline = Color.apply(
+                    "The following OctoPrint instances were found:", Color.GREEN
+                )
+                dialog += f"║{headline:^64}║\n"
+                dialog += "╟───────────────────────────────────────────────────────╢\n"
+                select_all = Color.apply("a) Select all", Color.YELLOW)
+                dialog += f"║ {select_all:<63}║\n"
+                dialog += "║                                                       ║\n"
+
+                for i, inst in enumerate(op_instances, start=1):
+                    line = Color.apply(
+                        f"{i}) {inst.service_file_path.stem}", Color.CYAN
+                    )
+                    dialog += f"║ {line:<63}║\n"
+                dialog += "╟───────────────────────────────────────────────────────╢\n"
+                print(dialog, end="")
+                print_back_footer()
+
+                allowed = [str(i) for i in range(1, len(op_instances) + 1)]
+                allowed.extend(["a", "b"])
+                choice = get_selection_input("Choose instance to remove", allowed)
+
+                if choice == "a":
+                    remove_all = True
+                    to_remove = op_instances
+                elif choice == "b":
+                    Logger.print_info("Aborted OctoPrint removal.")
+                    return
+                else:
+                    idx = int(choice) - 1
+                    to_remove = [op_instances[idx]]
+
+            for inst in to_remove:
+                Logger.print_status(
+                    f"Removing instance {inst.service_file_path.stem} ..."
+                )
+                try:
+                    InstanceManager.remove(inst)
+                except Exception as e:
+                    Logger.print_error(
+                        f"Failed to remove service {inst.service_file_path.name}: {e}"
+                    )
+
+                # Remove only this instance's env and basedir
+                if inst.env_dir.exists():
+                    Logger.print_status(f"Removing {inst.env_dir} ...")
+                    run_remove_routines(inst.env_dir)
+                if inst.basedir.exists():
+                    Logger.print_status(f"Removing {inst.basedir} ...")
+                    run_remove_routines(inst.basedir)
+
+            # Remove sudoers file only if no instances remain
+            remaining = get_instances(Octoprint)
+            if not remaining and OP_SUDOERS_FILE.exists():
+                Logger.print_status(f"Removing {OP_SUDOERS_FILE} ...")
+                remove_with_sudo(OP_SUDOERS_FILE)
+
+            Logger.print_dialog(
+                DialogType.SUCCESS,
+                [
+                    "Selected OctoPrint instance(s) successfully removed!"
+                    if not remove_all
+                    else "All OctoPrint instances successfully removed!",
+                ],
+                center_content=True,
+            )
+
+        except Exception as e:
+            Logger.print_error(f"Error during OctoPrint removal: {e}")

kiauh/extensions/pretty_gcode/metadata.json

@@ -5,6 +5,7 @@
     "maintained_by": "Kragrathea",
     "display_name": "PrettyGCode for Klipper",
     "description": ["3D G-Code viewer for Klipper"],
+    "repo": "https://github.com/Kragrathea/pgcode",
     "updates": true
   }
 }

kiauh/extensions/simply_print/metadata.json

@@ -1,13 +1,16 @@
 {
-    "metadata": {
-        "index": 10,
-        "module": "simply_print_extension",
-        "maintained_by": "dw-0",
-        "display_name": "SimplyPrint",
-        "description": [
-            "3D Printer Cloud Management Software.",
-            "\n\n",
-            "3D printing doesn't have to be a complicated, analog, SD card-filled experience; step into the future of modern 3D printing"
-        ]
-    }
+  "metadata": {
+    "index": 10,
+    "module": "simply_print_extension",
+    "maintained_by": "dw-0",
+    "display_name": "SimplyPrint",
+    "description": [
+      "3D Printer Cloud Management Software.",
+      "\n\n",
+      "3D printing doesn't have to be a complicated, analog, SD card-filled experience; step into the future of modern 3D printing"
+    ],
+    "website": "https://simplyprint.io",
+    "repo": "https://github.com/SimplyPrint",
+    "updates": false
+  }
 }

kiauh/extensions/simply_print/simply_print_extension.py

@@ -11,11 +11,12 @@ from typing import List
 from components.moonraker.moonraker import Moonraker
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
+from core.services.backup_service import BackupService
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
     SimpleConfigParser,
 )
 from extensions.base_extension import BaseExtension
-from utils.common import backup_printer_config_dir, moonraker_exists
+from utils.common import moonraker_exists
 from utils.input_utils import get_confirm
 
 
@@ -112,10 +113,10 @@ class SimplyPrintExtension(BaseExtension):
                 continue
 
             if is_install and not scp.has_section("simplyprint"):
-                backup_printer_config_dir()
+                BackupService().backup_printer_config_dir()
                 scp.add_section(section)
             elif not is_install and scp.has_section("simplyprint"):
-                backup_printer_config_dir()
+                BackupService().backup_printer_config_dir()
                 scp.remove_section(section)
             scp.write_file(moonraker.cfg_file)
             patched_files.append(moonraker.cfg_file)

kiauh/extensions/spoolman/metadata.json

@@ -13,6 +13,7 @@
       "\n\n",
       "Note: This extension installs Spoolman using Docker. Docker must be installed on your system before installing Spoolman."
     ],
+    "repo": "https://github.com/Donkie/Spoolman",
     "updates": true
   }
 }

kiauh/extensions/spoolman/spoolman_extension.py

@@ -15,9 +15,9 @@ from components.moonraker.moonraker import Moonraker
 from components.moonraker.services.moonraker_instance_service import (
     MoonrakerInstanceService,
 )
-from core.backup_manager.backup_manager import BackupManager
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import DialogType, Logger
+from core.services.backup_service import BackupService
 from extensions.base_extension import BaseExtension
 from extensions.spoolman import (
     SPOOLMAN_COMPOSE_FILE,
@@ -100,6 +100,7 @@ class SpoolmanExtension(BaseExtension):
         mr_instances: List[Moonraker] = mrsvc.get_all_instances()
 
         Logger.print_status("Removing Spoolman configuration from moonraker.conf...")
+        BackupService().backup_moonraker_conf()
         remove_config_section("spoolman", mr_instances)
 
         Logger.print_status("Removing Spoolman from moonraker.asvc...")
@@ -123,16 +124,15 @@ class SpoolmanExtension(BaseExtension):
                     "Failed to remove Spoolman image! Please remove it manually."
                 )
 
-        # backup Spoolman directory to ~/spoolman_data-<timestamp> before removing it
         try:
-            bm = BackupManager()
-            result = bm.backup_directory(
-                f"{SPOOLMAN_DIR.name}_data",
-                source=SPOOLMAN_DIR,
-                target=SPOOLMAN_DIR.parent,
+            svc = BackupService()
+            success = svc.backup_directory(
+                source_path=SPOOLMAN_DIR,
+                backup_name="spoolman",
+                target_path="spoolman",
             )
-            if result:
-                Logger.print_ok(f"Spoolman data backed up to {result}")
+            if success:
+                Logger.print_ok(f"Spoolman data backed up to {success}")
                 Logger.print_status("Removing Spoolman directory...")
                 if run_remove_routines(SPOOLMAN_DIR):
                     Logger.print_ok("Spoolman directory removed!")
@@ -290,6 +290,7 @@ class SpoolmanExtension(BaseExtension):
         mrsvc.load_instances()
         mr_instances = mrsvc.get_all_instances()
 
+        BackupService().backup_moonraker_conf()
         # noinspection HttpUrlsUsage
         add_config_section(
             section="spoolman",

kiauh/extensions/telegram_bot/metadata.json

@@ -5,7 +5,7 @@
     "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",
+    "repo": "https://github.com/nlef/moonraker-telegram-bot",
     "updates": true
   }
 }

kiauh/extensions/telegram_bot/moonraker_telegram_bot_extension.py

@@ -13,6 +13,7 @@ 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 core.services.backup_service import BackupService
 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 (
@@ -105,6 +106,7 @@ class TelegramBotExtension(BaseExtension):
             cmd_sysctl_manage("daemon-reload")
 
             # add to moonraker update manager
+            BackupService().backup_moonraker_conf()
             self._patch_bot_update_manager(mr_instances)
 
             # restart moonraker
@@ -150,6 +152,7 @@ class TelegramBotExtension(BaseExtension):
             self._remove_bot_instances(tb_instances)
             self._remove_bot_dir()
             self._remove_bot_env()
+            BackupService().backup_moonraker_conf()
             remove_config_section("update_manager moonraker-telegram-bot", mr_instances)
             self._delete_bot_logs(tb_instances)
         except Exception as e:

kiauh/main.py

@@ -27,3 +27,7 @@ def main() -> None:
         MainMenu().run()
     except KeyboardInterrupt:
         Logger.print_ok("\nHappy printing!\n", prefix=False)
+
+
+if __name__ == "__main__":
+    main()

kiauh/procedures/switch_repo.py

@@ -13,7 +13,6 @@ from pathlib import Path
 from typing import Literal
 
 from components.klipper import (
-    KLIPPER_BACKUP_DIR,
     KLIPPER_DIR,
     KLIPPER_ENV_DIR,
     KLIPPER_REQ_FILE,
@@ -21,7 +20,6 @@ from components.klipper import (
 from components.klipper.klipper import Klipper
 from components.klipper.klipper_utils import install_klipper_packages
 from components.moonraker import (
-    MOONRAKER_BACKUP_DIR,
     MOONRAKER_DIR,
     MOONRAKER_ENV_DIR,
     MOONRAKER_REQ_FILE,
@@ -30,10 +28,10 @@ from components.moonraker.moonraker import Moonraker
 from components.moonraker.services.moonraker_setup_service import (
     install_moonraker_packages,
 )
-from core.backup_manager.backup_manager import BackupManager, BackupManagerException
 from core.instance_manager.instance_manager import InstanceManager
 from core.logger import Logger
-from utils.git_utils import GitException, get_repo_name, git_clone_wrapper
+from core.services.backup_service import BackupService
+from utils.git_utils import GitException, git_clone_wrapper
 from utils.instance_utils import get_instances
 from utils.sys_utils import (
     VenvCreationFailedException,
@@ -52,7 +50,6 @@ def run_switch_repo_routine(
     repo_dir: Path = KLIPPER_DIR if name == "klipper" else MOONRAKER_DIR
     env_dir: Path = KLIPPER_ENV_DIR if name == "klipper" else MOONRAKER_ENV_DIR
     req_file = KLIPPER_REQ_FILE if name == "klipper" else MOONRAKER_REQ_FILE
-    backup_dir: Path = KLIPPER_BACKUP_DIR if name == "klipper" else MOONRAKER_BACKUP_DIR
     _type = Klipper if name == "klipper" else Moonraker
 
     # step 1: stop all instances
@@ -64,19 +61,17 @@ def run_switch_repo_routine(
     env_dir_backup_path: Path | None = None
 
     try:
-        # step 2: backup old repo and env
-        org, _ = get_repo_name(repo_dir)
-        backup_dir = backup_dir.joinpath(org)
-        bm = BackupManager()
-        repo_dir_backup_path = bm.backup_directory(
-            repo_dir.name,
-            repo_dir,
-            backup_dir,
+        svc = BackupService()
+        svc.backup_directory(
+            source_path=repo_dir,
+            backup_name=name,
+            target_path=name,
         )
-        env_dir_backup_path = bm.backup_directory(
-            env_dir.name,
-            env_dir,
-            backup_dir,
+        env_backup_name: str = f"{name if name == 'moonraker' else 'klippy'}-env"
+        svc.backup_directory(
+            source_path=env_dir,
+            backup_name=env_backup_name,
+            target_path=name,
         )
 
         if not (repo_url or branch):
@@ -101,10 +96,6 @@ def run_switch_repo_routine(
 
         Logger.print_ok(f"Switched to {repo_url} at branch {branch}!")
 
-    except BackupManagerException as e:
-        Logger.print_error(f"Error during backup of repository: {e}")
-        raise RepoSwitchFailedException(e)
-
     except (GitException, VenvCreationFailedException) as e:
         # if something goes wrong during cloning or recreating the virtualenv,
         # we restore the backup of the repo and env
@@ -122,6 +113,9 @@ def run_switch_repo_routine(
         Logger.print_error(f"Something went wrong: {e}")
         return
 
+    except Exception as e:
+        raise RepoSwitchFailedException(e)
+
     Logger.print_status(f"Restarting all {_type.__name__} instances ...")
     InstanceManager.start_all(instances)
 

kiauh/utils/common.py

@@ -14,11 +14,9 @@ from datetime import datetime
 from pathlib import Path
 from typing import Dict, List, Literal, Set
 
-from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
 from core.constants import (
     GLOBAL_DEPS,
-    PRINTER_DATA_BACKUP_DIR,
 )
 from core.logger import DialogType, Logger
 from core.types.color import Color
@@ -42,10 +40,13 @@ from utils.sys_utils import (
 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: string of the latest tag or a default value if no tags exist
     """
-    lastest_tag: str = get_local_tags(Path(__file__).parent.parent)[-1]
-    return lastest_tag
+    tags = get_local_tags(Path(__file__).parent.parent)
+    if tags:
+        return tags[-1]
+    else:
+        return "v?.?.?"
 
 
 def convert_camelcase_to_kebabcase(name: str) -> str:
@@ -148,26 +149,6 @@ def get_install_status(
     )
 
 
-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()
-
-    if not instances:
-        Logger.print_info("Unable to find directory to backup!")
-        Logger.print_info("Are there no Klipper instances installed?")
-        return
-
-    for instance in instances:
-        bm.backup_directory(
-            instance.data_dir.name,
-            source=instance.base.cfg_dir,
-            target=PRINTER_DATA_BACKUP_DIR,
-        )
-
-
 def moonraker_exists(name: str = "") -> List[Moonraker]:
     """
     Helper method to check if a Moonraker instance exists

kiauh/utils/config_utils.py

@@ -11,7 +11,7 @@ from __future__ import annotations
 import shutil
 import tempfile
 from pathlib import Path
-from typing import List, Tuple
+from typing import List, Tuple, Union
 
 from core.logger import Logger
 from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
@@ -19,7 +19,7 @@ from core.submodules.simple_config_parser.src.simple_config_parser.simple_config
 )
 from utils.instance_type import InstanceType
 
-ConfigOption = Tuple[str, str]
+ConfigOption = Tuple[str, Union[str, List[str]]]
 
 
 def add_config_section(
@@ -73,7 +73,7 @@ def add_config_section_at_top(section: str, instances: List[InstanceType]) -> No
             tmp.writelines(org_content)
 
         cfg_file.unlink()
-        shutil.move(tmp_cfg_path, cfg_file)
+        shutil.move(tmp_cfg_path.as_posix(), cfg_file)
 
         Logger.print_ok("OK!")
 
@@ -81,7 +81,7 @@ def add_config_section_at_top(section: str, instances: List[InstanceType]) -> No
 def remove_config_section(
     section: str, instances: List[InstanceType]
 ) -> List[InstanceType]:
-    removed_from: List[instances] = []
+    removed_from: List[InstanceType] = []
     for instance in instances:
         cfg_file = instance.cfg_file
         Logger.print_status(f"Remove section '[{section}]' from '{cfg_file}' ...")

kiauh/utils/instance_type.py

@@ -15,6 +15,7 @@ from extensions.obico.moonraker_obico import MoonrakerObico
 from extensions.octoeverywhere.octoeverywhere import Octoeverywhere
 from extensions.octoapp.octoapp import Octoapp
 from extensions.telegram_bot.moonraker_telegram_bot import MoonrakerTelegramBot
+from extensions.octoprint.octoprint import Octoprint
 
 InstanceType = TypeVar(
     "InstanceType",
@@ -24,4 +25,5 @@ InstanceType = TypeVar(
     MoonrakerObico,
     Octoeverywhere,
     Octoapp,
+    Octoprint,
 )

kiauh/utils/sys_utils.py

@@ -184,9 +184,6 @@ def install_python_requirements(target: Path, requirements: Path) -> None:
     :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(),
@@ -196,7 +193,7 @@ def install_python_requirements(target: Path, requirements: Path) -> None:
         ]
         result = run(command, stderr=PIPE, text=True)
 
-        if result.returncode != 0 or result.stderr:
+        if result.returncode != 0:
             Logger.print_error(f"{result.stderr}", False)
             raise VenvCreationFailedException("Installing Python requirements failed!")
 
@@ -216,9 +213,6 @@ def install_python_packages(target: Path, packages: List[str]) -> None:
     :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(),
@@ -228,7 +222,7 @@ def install_python_packages(target: Path, packages: List[str]) -> None:
             command.append(pkg)
         result = run(command, stderr=PIPE, text=True)
 
-        if result.returncode != 0 or result.stderr:
+        if result.returncode != 0:
             Logger.print_error(f"{result.stderr}", False)
             raise VenvCreationFailedException("Installing Python requirements failed!")
 

requirements-dev.txt

@@ -0,0 +1,2 @@
+ruff (>=0.9.10)
+pyright

resources/autocommit.sh

@@ -1,65 +0,0 @@
-#!/usr/bin/env bash
-
-#####################################################################
-### Please set the paths accordingly. In case you don't have all  ###
-### the listed folders, just keep that line commented out.        ###
-#####################################################################
-### Path to your config folder you want to back up
-#config_folder=~/klipper_config
-
-### Path to your Klipper folder, by default that is '~/klipper'
-#klipper_folder=~/klipper
-
-### Path to your Moonraker folder, by default that is '~/moonraker'
-#moonraker_folder=~/moonraker
-
-### Path to your Mainsail folder, by default that is '~/mainsail'
-#mainsail_folder=~/mainsail
-
-### Path to your Fluidd folder, by default that is '~/fluidd'
-#fluidd_folder=~/fluidd
-
-#####################################################################
-#####################################################################
-
-
-#####################################################################
-################ !!! DO NOT EDIT BELOW THIS LINE !!! ################
-#####################################################################
-grab_version() {
-  local klipper_commit moonraker_commit
-  local mainsail_ver fluidd_ver
-
-  if [[ -n ${klipper_folder} ]]; then
-    cd "${klipper_folder}"
-    klipper_commit=$(git rev-parse --short=7 HEAD)
-    m1="Klipper on commit: ${klipper_commit}"
-  fi
-  if [[ -n ${moonraker_folder} ]]; then
-    cd "${moonraker_folder}"
-    moonraker_commit=$(git rev-parse --short=7 HEAD)
-    m2="Moonraker on commit: ${moonraker_commit}"
-  fi
-  if [[ -n ${mainsail_folder} ]]; then
-    mainsail_ver=$(head -n 1 "${mainsail_folder}/.version")
-    m3="Mainsail version: ${mainsail_ver}"
-  fi
-  if [[ -n ${fluidd_folder} ]]; then
-    fluidd_ver=$(head -n 1 "${fluidd_folder}/.version")
-    m4="Fluidd version: ${fluidd_ver}"
-  fi
-}
-
-push_config() {
-  local current_date
-  
-  cd "${config_folder}" || exit 1
-  git pull
-  git add .
-  current_date=$(date +"%Y-%m-%d %T")
-  git commit -m "Autocommit from ${current_date}" -m "${m1}" -m "${m2}" -m "${m3}" -m "${m4}"
-  git push
-}
-
-grab_version
-push_config

resources/common_vars.conf

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

resources/example.printer.cfg

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

resources/fluidd

@@ -1,96 +0,0 @@
-# /etc/nginx/sites-available/fluidd
-
-server {
-    listen 80;
-
-    access_log /var/log/nginx/fluidd-access.log;
-    error_log /var/log/nginx/fluidd-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 fluidd static files
-    root /home/pi/fluidd;
-
-    index index.html;
-    server_name _;
-
-    # disable max upload size checks
-    client_max_body_size 0;
-
-    # disable proxy request buffering
-    proxy_request_buffering off;
-
-    location / {
-        try_files $uri $uri/ /index.html;
-    }
-
-    location = /index.html {
-        add_header Cache-Control "no-store, no-cache, must-revalidate";
-    }
-
-    location /websocket {
-        proxy_pass http://apiserver/websocket;
-        proxy_http_version 1.1;
-        proxy_set_header Upgrade $http_upgrade;
-        proxy_set_header Connection $connection_upgrade;
-        proxy_set_header Host $http_host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_read_timeout 86400;
-    }
-
-    location ~ ^/(printer|api|access|machine|server)/ {
-        proxy_pass http://apiserver$request_uri;
-        proxy_http_version 1.1;
-        proxy_set_header Upgrade $http_upgrade;
-        proxy_set_header Host $http_host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header X-Scheme $scheme;
-        proxy_read_timeout 600;
-    }
-
-    location /webcam/ {
-        postpone_output 0;
-        proxy_buffering off;
-        proxy_ignore_headers X-Accel-Buffering;
-        access_log off;
-        error_log off;
-        proxy_pass http://mjpgstreamer1/;
-    }
-
-    location /webcam2/ {
-        postpone_output 0;
-        proxy_buffering off;
-        proxy_ignore_headers X-Accel-Buffering;
-        access_log off;
-        error_log off;
-        proxy_pass http://mjpgstreamer2/;
-    }
-
-    location /webcam3/ {
-        postpone_output 0;
-        proxy_buffering off;
-        proxy_ignore_headers X-Accel-Buffering;
-        access_log off;
-        error_log off;
-        proxy_pass http://mjpgstreamer3/;
-    }
-
-    location /webcam4/ {
-        postpone_output 0;
-        proxy_buffering off;
-        proxy_ignore_headers X-Accel-Buffering;
-        access_log off;
-        error_log off;
-        proxy_pass http://mjpgstreamer4/;
-    }
-}

resources/gcode_shell_command.py

@@ -1,94 +0,0 @@
-# Run a shell command via gcode
-#
-# Copyright (C) 2019  Eric Callahan <arksine.code@gmail.com>
-#
-# This file may be distributed under the terms of the GNU GPLv3 license.
-import os
-import shlex
-import subprocess
-import logging
-
-
-class ShellCommand:
-    def __init__(self, config):
-        self.name = config.get_name().split()[-1]
-        self.printer = config.get_printer()
-        self.gcode = self.printer.lookup_object("gcode")
-        cmd = config.get("command")
-        cmd = os.path.expanduser(cmd)
-        self.command = shlex.split(cmd)
-        self.timeout = config.getfloat("timeout", 2.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)

resources/klipper.env

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

resources/klipper.service

@@ -1,18 +0,0 @@
-[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

resources/mainsail

@@ -1,96 +0,0 @@
-# /etc/nginx/sites-available/mainsail
-
-server {
-    listen 80;
-
-    access_log /var/log/nginx/mainsail-access.log;
-    error_log /var/log/nginx/mainsail-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 mainsail static files
-    root /home/pi/mainsail;
-
-    index index.html;
-    server_name _;
-
-    # disable max upload size checks
-    client_max_body_size 0;
-
-    # disable proxy request buffering
-    proxy_request_buffering off;
-
-    location / {
-        try_files $uri $uri/ /index.html;
-    }
-
-    location = /index.html {
-        add_header Cache-Control "no-store, no-cache, must-revalidate";
-    }
-
-    location /websocket {
-        proxy_pass http://apiserver/websocket;
-        proxy_http_version 1.1;
-        proxy_set_header Upgrade $http_upgrade;
-        proxy_set_header Connection $connection_upgrade;
-        proxy_set_header Host $http_host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_read_timeout 86400;
-    }
-
-    location ~ ^/(printer|api|access|machine|server)/ {
-        proxy_pass http://apiserver$request_uri;
-        proxy_http_version 1.1;
-        proxy_set_header Upgrade $http_upgrade;
-        proxy_set_header Host $http_host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header X-Scheme $scheme;
-        proxy_read_timeout 600;
-    }
-
-    location /webcam/ {
-        postpone_output 0;
-        proxy_buffering off;
-        proxy_ignore_headers X-Accel-Buffering;
-        access_log off;
-        error_log off;
-        proxy_pass http://mjpgstreamer1/;
-    }
-
-    location /webcam2/ {
-        postpone_output 0;
-        proxy_buffering off;
-        proxy_ignore_headers X-Accel-Buffering;
-        access_log off;
-        error_log off;
-        proxy_pass http://mjpgstreamer2/;
-    }
-
-    location /webcam3/ {
-        postpone_output 0;
-        proxy_buffering off;
-        proxy_ignore_headers X-Accel-Buffering;
-        access_log off;
-        error_log off;
-        proxy_pass http://mjpgstreamer3/;
-    }
-
-    location /webcam4/ {
-        postpone_output 0;
-        proxy_buffering off;
-        proxy_ignore_headers X-Accel-Buffering;
-        access_log off;
-        error_log off;
-        proxy_pass http://mjpgstreamer4/;
-    }
-}

resources/mjpg-streamer/webcam.txt

@@ -1,79 +0,0 @@
-### Windows users: To edit this file use Notepad++, VSCode, Atom or SublimeText.
-### Do not use Notepad or WordPad.
-
-### MacOSX users: If you use Textedit to edit this file make sure to use 
-### "plain text format" and "disable smart quotes" in "Textedit > Preferences"
-
-### Configure which camera to use
-#
-# Available options are:
-# - auto: tries first usb webcam, if that's not available tries raspi cam
-# - usb: only tries usb webcam
-# - raspi: only tries raspi cam
-#
-# Defaults to auto
-#
-#camera="auto"
-
-### Additional options to supply to MJPG Streamer for the USB camera
-#
-# See https://faq.octoprint.org/mjpg-streamer-config for available options
-#
-# Defaults to a resolution of 640x480 px and a framerate of 10 fps
-#
-#camera_usb_options="-r 640x480 -f 10"
-
-### Additional webcam devices known to cause problems with -f
-#
-# Apparently there a some devices out there that with the current 
-# mjpg_streamer release do not support the -f parameter (for specifying 
-# the capturing framerate) and will just refuse to output an image if it 
-# is supplied.
-#
-# The webcam daemon will detect those devices by their USB Vendor and Product
-# ID and remove the -f parameter from the options provided to mjpg_streamer.
-#
-# By default, this is done for the following devices:
-#   Logitech C170 (046d:082b)
-#   GEMBIRD (1908:2310)
-#   Genius F100 (0458:708c)
-#   Cubeternet GL-UPC822 UVC WebCam (1e4e:0102)
-#
-# Using the following option it is possible to add additional devices. If
-# your webcam happens to show above symptoms, try determining your cam's
-# vendor and product id via lsusb, activating the line below by removing # and 
-# adding it, e.g. for two broken cameras "aabb:ccdd" and "aabb:eeff"
-#
-#   additional_brokenfps_usb_devices=("aabb:ccdd" "aabb:eeff")
-#
-#
-#additional_brokenfps_usb_devices=()
-
-### Additional options to supply to MJPG Streamer for the RasPi Cam
-#
-# See https://faq.octoprint.org/mjpg-streamer-config for available options
-#
-# Defaults to 10fps
-#
-#camera_raspi_options="-fps 10"
-
-### Configuration of camera HTTP output
-#
-# Usually you should NOT need to change this at all! Only touch if you
-# know what you are doing and what the parameters mean.
-#
-# Below settings are used in the mjpg-streamer call like this:
-#
-#   -o "output_http.so -w $camera_http_webroot $camera_http_options"
-#
-# Current working directory is the mjpg-streamer base directory.
-#
-#camera_http_webroot="./www-mainsail"
-#camera_http_options="-n"
-
-### EXPERIMENTAL
-# Support for different streamer types.
-#
-# Available options:
-#   mjpeg [default] - stable MJPG-streamer
-#camera_streamer=mjpeg

resources/mjpg-streamer/webcamd

@@ -1,303 +0,0 @@
-#!/bin/bash
-
-########################################################################
-### DO NOT EDIT THIS FILE TO CHANGE THE CONFIG!!!                    ###
-### ---------------------------------------------------------------- ###
-### There is no need to edit this file for changing resolution,      ###
-### frame rates or any other mjpg-streamer parameters. Please edit   ###
-### /home/pi/klipper_config/webcam.txt instead - that's what it's    ###
-### there for! You can even do this with your Pi powered down by     ###
-### directly accessing the file when using the SD card as thumb      ###
-### drive in your regular computer.                                  ###
-########################################################################
-
-MJPGSTREAMER_HOME=/home/pi/mjpg-streamer
-MJPGSTREAMER_INPUT_USB="input_uvc.so"
-MJPGSTREAMER_INPUT_RASPICAM="input_raspicam.so"
-
-brokenfps_usb_devices=("046d:082b" "1908:2310" "0458:708c" "1e4e:0102" "0471:0311" "038f:6001" "046d:0804" "046d:0825" "046d:0994" "0ac8:3450")
-
-config_dir="/home/pi/klipper_config"
-
-echo "Starting up webcamDaemon..."
-echo ""
-
-cfg_files=()
-#cfg_files+=/boot/mainsail.txt
-if [[ -d ${config_dir} ]]; then
-  cfg_files+=( `ls ${config_dir}/webcam*.txt` )
-fi
-
-array_camera_config=()
-array_camera=()
-array_camera_usb_options=()
-array_camera_usb_device=()
-array_camera_raspi_options=()
-array_camera_http_webroot=()
-array_camera_http_options=()
-array_additional_brokenfps_usb_devices=()
-array_camera_device=()
-array_assigned_device=()
-
-echo "--- Configuration: ----------------------------"
-for cfg_file in ${cfg_files[@]}; do
-  # init configuration - DO NOT EDIT, USE /home/pi/klipper_config/webcam*.txt INSTEAD!
-  camera="auto"
-  camera_usb_options="-r 640x480 -f 10"
-  camera_raspi_options="-fps 10"
-  camera_http_webroot="./www-mjpgstreamer"
-  camera_http_options="-n"
-  additional_brokenfps_usb_devices=()
-
-  if [[ -e ${cfg_file} ]]; then
-      source "$cfg_file"
-  fi
-  usb_options="$camera_usb_options"
-
-  # if webcam device is explicitly given in /home/pi/klipper_config/webcam*.txt, save the path of the device
-  # to a variable and remove its parameter from usb_options
-  extracted_device=`echo $usb_options | sed 's@.*-d \(/dev/\(video[0-9]\+\|v4l/[^ ]*\)\).*@\1@'`
-  if [ "$extracted_device" != "$usb_options" ]
-  then
-    # the camera options refer to a device, save it in a variable
-    # replace video device parameter with empty string and strip extra whitespace
-    usb_options=`echo $usb_options | sed 's/\-d \/dev\/\(video[0-9]\+\|v4l\/[^ ]*\)//g' | awk '$1=$1'`
-  else
-    extracted_device=""
-  fi
-
-  # echo configuration
-  echo "cfg_file:      $cfg_file"
-  echo "camera:        $camera"
-  echo "usb options:   $camera_usb_options"
-  echo "raspi options: $camera_raspi_options"
-  echo "http options:  -w $camera_http_webroot $camera_http_options"
-  echo ""
-  echo "Explicitly USB device: $extracted_device"
-  echo "-----------------------------------------------"
-  echo ""
-
-  array_camera_config+=( $cfg_file )
-  array_camera+=( $camera )
-  array_camera_usb_options+=("$usb_options")
-  array_camera_usb_device+=("$extracted_device")
-  array_camera_raspi_options+=("$camera_raspi_options")
-  array_camera_http_webroot+=("$camera_http_webroot")
-  array_camera_http_options+=("$camera_http_options")
-  array_camera_brokenfps_usb_devices+=("${brokenfps_usb_devices[*]} ${additional_brokenfps_usb_devices[*]}")
-  array_camera_device+=("")
-done
-
-# check if array contains a string
-function containsString() {
-  local e match="$1"
-  shift
-  for e; do [[ "$e" == "$match" ]] && return 0; done
-  return 1
-}
-
-# cleans up when the script receives a SIGINT or SIGTERM
-function cleanup() {
-    # make sure that all child processed die when we die
-    local pids=$(jobs -pr)
-    [ -n "$pids" ] && kill $pids
-    exit 0
-}
-
-# says goodbye when the script shuts down
-function goodbye() {
-    # say goodbye
-    echo ""
-    echo "Goodbye..."
-    echo ""
-}
-
-# runs MJPG Streamer, using the provided input plugin + configuration
-function runMjpgStreamer {
-    input=$1
-
-    # There are problems with 0x000137ab firmware on VL805 (Raspberry Pi 4}).
-    # Try to autodetect offending firmware and temporarily fix the issue
-    # by changing power management mode
-    echo "Checking for VL805 (Raspberry Pi 4)..."
-    if [[ -f /usr/bin/vl805 ]]; then
-        VL805_VERSION=$(/usr/bin/vl805)
-        VL805_VERSION=${VL805_VERSION#*: }
-        echo " - version 0x${VL805_VERSION} detected"
-        case "$VL805_VERSION" in
-            00013701)
-                echo "    - nothing to be done. It shouldn't cause USB problems."
-                ;;
-            000137ab)
-                echo -e "    - \e[31mThis version is known to cause problems with USB cameras.\e[39m"
-                echo -e "      You may want to downgrade to 0x0013701."
-                echo -e "    - [FIXING] Trying the setpci -s 01:00.0 0xD4.B=0x41 hack to mitigate the"
-                echo -e "      issue. It disables ASPM L1 on the VL805. Your board may (or may not) get"
-                echo -e "      slightly hotter. For details see:"
-                echo -e "      https://www.raspberrypi.org/forums/viewtopic.php?f=28&t=244421"
-                setpci -s 01:00.0 0xD4.B=0x41
-                ;;
-            *)
-                echo "   - unknown firmware version. Doing nothing."
-                ;;
-        esac
-    else
-        echo "  - It seems that you don't have VL805 (Raspberry Pi 4)."
-        echo "    There should be no problems with USB (a.k.a. select() timeout)"
-    fi
-
-    pushd $MJPGSTREAMER_HOME > /dev/null 2>&1
-        echo Running ./mjpg_streamer -o "output_http.so -w $camera_http_webroot $camera_http_options" -i "$input"
-        LD_LIBRARY_PATH=. ./mjpg_streamer -o "output_http.so -w $camera_http_webroot $camera_http_options" -i "$input" &
-        sleep 1 &
-        sleep_pid=$!
-        wait ${sleep_pid}
-    popd > /dev/null 2>&1
-}
-
-# starts up the RasPiCam
-function startRaspi {
-    logger -s "Starting Raspberry Pi camera"
-    runMjpgStreamer "$MJPGSTREAMER_INPUT_RASPICAM $camera_raspi_options"
-}
-
-# starts up the USB webcam
-function startUsb {
-    options="$usb_options"
-    device="video0"
-
-    # check for parameter and set the device if it is given as a parameter
-    input=$1
-    if [[ -n $input ]]; then
-        device=`basename "$input"`
-    fi
-
-    # add video device into options
-    options="$options -d /dev/$device"
-
-    uevent_file="/sys/class/video4linux/$device/device/uevent"
-    if [ -e $uevent_file ]; then
-        # let's see what kind of webcam we have here, fetch vid and pid...
-        product=`cat $uevent_file | grep PRODUCT | cut -d"=" -f2`
-        vid=`echo $product | cut -d"/" -f1`
-        pid=`echo $product | cut -d"/" -f2`
-        vidpid=`printf "%04x:%04x" "0x$vid" "0x$pid"`
-
-        # ... then look if it is in our list of known broken-fps-devices and if so remove
-        # the -f parameter from the options (if it's in there, else that's just a no-op)
-        for identifier in ${brokenfps_usb_devices[@]};
-        do
-            if [ "$vidpid" = "$identifier" ]; then
-                echo
-                echo "Camera model $vidpid is known to not work with -f parameter, stripping it out"
-                echo
-                options=`echo $options | sed -e "s/\(\s\+\|^\)-f\s\+[0-9]\+//g"`
-            fi
-        done
-    fi
-
-    logger -s "Starting USB webcam"
-    runMjpgStreamer "$MJPGSTREAMER_INPUT_USB $options"
-}
-
-# make sure our cleanup function gets called when we receive SIGINT, SIGTERM
-trap "cleanup" SIGINT SIGTERM
-# say goodbye when we EXIT
-trap "goodbye" EXIT
-
-# we need this to prevent the later calls to vcgencmd from blocking
-# I have no idea why, but that's how it is...
-vcgencmd version > /dev/null 2>&1
-
-# keep mjpg streamer running if some camera is attached
-while true; do
-
-  # get list of usb video devices into an array
-  video_devices=($(find /dev -regextype sed -regex '\/dev/video[0-9]\+' | sort -nk1.11 2> /dev/null))
-
-  # add list of raspi camera into an array
-  if [ "`vcgencmd get_camera`" = "supported=1 detected=1" ]; then
-    video_devices+=( "raspi" )
-  fi
-
-  echo "Found video devices:"
-  printf '%s\n' "${video_devices[@]}"
-
-  for scan_mode in "usb" "usb-auto" "raspi" "auto"; do
-    camera=$scan_mode
-    if [[ "usb-auto" == "$scan_mode" ]]; then
-      camera="usb"
-    fi
-    for ((i=0;i<${#array_camera[@]};i++));  do
-      if [[ -z ${array_camera_device[${i}]} ]] && [[ $camera == ${array_camera[${i}]} ]]; then
-        camera_config="${array_camera_config[${i}]}"
-        usb_options="${array_camera_usb_options[${i}]}"
-        camera_usb_device="${array_camera_usb_device[${i}]}"
-        camera_raspi_options="${array_camera_raspi_options[${i}]}"
-        camera_http_webroot="${array_camera_http_webroot[${i}]}"
-        camera_http_options="${array_camera_http_options[${i}]}"
-        brokenfps_usb_devices="${array_camera_brokenfps_usb_devices[${i}]}"
-        if [[ ${camera_usb_device} ]] && { [[ "usb" == ${scan_mode} ]] || [[ "auto" == ${scan_mode} ]]; }; then
-           # usb device is explicitly set in options
-          usb_device_path=`readlink -f ${camera_usb_device}`
-          if containsString "$usb_device_path" "${array_camera_device[@]}"; then
-            if [[ "auto" != ${scan_mode} ]]; then
-              array_camera_device[${i}]="alredy_in_use"
-              echo "config file='$camera_config':Video device already in use."
-              continue
-            fi
-          elif containsString "$usb_device_path" "${video_devices[@]}"; then
-            array_camera_device[${i}]="$usb_device_path"
-            # explicitly set usb device was found in video_devices array, start usb with the found device
-            echo "config file='$camera_config':USB device was set in options and found in devices, start MJPG-streamer with the configured USB video device: $usb_device_path"
-            startUsb "$usb_device_path"
-            continue
-          fi
-        elif [[ -z ${camera_usb_device} ]] && { [[ "usb-auto" == ${scan_mode} ]] || [[ "auto" == ${scan_mode} ]]; }; then
-          for video_device in "${video_devices[@]}"; do
-            if [[ "raspi" != "$video_device" ]]; then
-              if containsString "$video_device" "${array_camera_device[@]}"; then
-                : #already in use
-              else
-                array_camera_device[${i}]="$video_device"
-                # device is not set explicitly in options, start usb with first found usb camera as the device
-                echo "config file='$camera_config':USB device was not set in options, start MJPG-streamer with the first found video device: ${video_device}"
-                startUsb "${video_device}"
-                break
-              fi
-            fi
-          done
-          if [[ -n ${array_camera_device[${i}]} ]]; then
-            continue
-          fi
-        fi
-        if [[ "raspi" == ${scan_mode} ]] || [[ "auto" == ${scan_mode} ]]; then
-          video_device="raspi"
-          if containsString "$video_device" "${array_camera_device[@]}"; then
-            if [[ "auto" != ${scan_mode} ]]; then
-              array_camera_device[${i}]="alredy_in_use"
-              echo "config file='$camera_config':RasPiCam device already in use."
-            fi
-          elif containsString "$video_device" "${video_devices[@]}"; then
-            array_camera_device[${i}]="$video_device"
-            echo "config file='$camera_config':Start MJPG-streamer with video device: ${video_device}"
-            startRaspi
-            sleep 30 &
-            sleep_pid=$!
-            wait ${sleep_pid}
-          fi
-        fi
-      fi
-    done
-  done
-  array_assigned_device=( ${array_camera_device[*]} )
-  if [[ ${#array_camera[@]} -eq ${#array_assigned_device[@]} ]]; then
-    echo "Done bring up all configured video device"
-    exit 0
-  else
-    echo "Scan again in two minutes"
-    sleep 120 &
-    sleep_pid=$!
-    wait ${sleep_pid}
-  fi
-done

resources/mjpg-streamer/webcamd.service

@@ -1,15 +0,0 @@
-[Unit]
-Description=Starts mjpg-streamer on startup
-After=network.target
-
-[Install]
-WantedBy=multi-user.target
-
-[Service]
-Type=forking
-User=%USER%
-WorkingDirectory=/usr/local/bin
-StandardOutput=append:/var/log/webcamd.log
-StandardError=append:/var/log/webcamd.log
-ExecStart=/usr/local/bin/webcamd
-Restart=always

resources/moonraker-telegram-bot.env

@@ -1 +0,0 @@
-TELEGRAM_BOT_ARGS="%TELEGRAM_BOT_DIR%/bot/main.py -c %CFG% -l %LOG%"

resources/moonraker-telegram-bot.service

@@ -1,16 +0,0 @@
-[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

resources/moonraker.conf

@@ -1,31 +0,0 @@
-[server]
-host: 0.0.0.0
-port: %PORT%
-klippy_uds_address: %UDS%
-
-[authorization]
-trusted_clients:
-    %LAN%
-    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
-    *.internal
-    *://localhost
-    *://localhost:*
-    *://my.mainsail.xyz
-    *://app.fluidd.xyz
-
-[octoprint_compat]
-
-[history]
-
-[update_manager]
-channel: dev
-refresh_interval: 168

resources/moonraker.env

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

resources/moonraker.service

@@ -1,19 +0,0 @@
-[Unit]
-Description=API Server for Klipper SV1 %INST%
-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

resources/shell_command.cfg

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

resources/upstreams.conf

@@ -1,25 +0,0 @@
-# /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;
-}

scripts/backup.sh

@@ -1,231 +0,0 @@
-#!/usr/bin/env bash
-
-#=======================================================================#
-# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
-#                                                                       #
-# This file is part of KIAUH - Klipper Installation And Update Helper   #
-# https://github.com/dw-0/kiauh                                         #
-#                                                                       #
-# This file may be distributed under the terms of the GNU GPLv3 license #
-#=======================================================================#
-
-set -e
-
-function get_date() {
-  local current_date
-  current_date=$(date +"%y%m%d-%H%M")
-  echo "${current_date}"
-}
-
-function check_for_backup_dir() {
-  [[ -d ${BACKUP_DIR} ]] && return
-
-  status_msg "Create KIAUH backup directory ..."
-  mkdir -p "${BACKUP_DIR}" && ok_msg "Directory created!"
-}
-
-function backup_before_update() {
-  read_kiauh_ini "${FUNCNAME[0]}"
-  local state="${backup_before_update}"
-  [[ ${state} = "false" ]] && return
-  backup_"${1}"
-}
-
-function backup_config_dir() {
-  check_for_backup_dir
-  local current_date config_pathes
-
-  config_pathes=$(get_config_folders)
-
-  if [[ -n "${config_pathes}" ]]; then
-    current_date=$(get_date)
-    status_msg "Timestamp: ${current_date}"
-
-    local i=0 folder folder_name target_dir
-    for folder in ${config_pathes}; do
-      if [[ -d ${folder} ]]; then
-        status_msg "Create backup of ${folder} ..."
-
-        folder_name=$(echo "${folder}" | rev | cut -d"/" -f2 | rev)
-        target_dir="${BACKUP_DIR}/configs/${current_date}/${folder_name}"
-        mkdir -p "${target_dir}"
-        cp -r "${folder}" "${target_dir}"
-        i=$(( i + 1 ))
-
-        ok_msg "Backup created in:\n${target_dir}"
-      fi
-    done
-  else
-    ok_msg "No config directory found! Skipping backup ..."
-  fi
-}
-
-function backup_moonraker_database() {
-  check_for_backup_dir
-  local current_date db_pathes
-
-  db_pathes=$(get_instance_folder_path "database")
-
-  if [[ -n ${db_pathes} ]]; then
-    current_date=$(get_date)
-    status_msg "Timestamp: ${current_date}"
-
-    local i=0 database folder_name target_dir
-    for database in ${db_pathes}; do
-      status_msg "Create backup of ${database} ..."
-
-      folder_name=$(echo "${database}" | rev | cut -d"/" -f2 | rev)
-      target_dir="${BACKUP_DIR}/moonraker_databases/${current_date}/${folder_name}"
-      mkdir -p "${target_dir}"
-      cp -r "${database}" "${target_dir}"
-      i=$(( i + 1 ))
-
-      ok_msg "Backup created in:\n${target_dir}"
-    done
-  else
-    print_error "No Moonraker database found! Skipping backup ..."
-  fi
-}
-
-function backup_klipper() {
-  local current_date
-
-  if [[ -d ${KLIPPER_DIR} && -d ${KLIPPY_ENV} ]]; then
-    status_msg "Creating Klipper backup ..."
-    check_for_backup_dir
-    current_date=$(get_date)
-    status_msg "Timestamp: ${current_date}"
-    mkdir -p "${BACKUP_DIR}/klipper-backups/${current_date}"
-    cp -r "${KLIPPER_DIR}" "${_}" && cp -r "${KLIPPY_ENV}" "${_}"
-    print_confirm "Klipper backup complete!"
-  else
-    print_error "Can't back up 'klipper' and/or 'klipper-env' directory! Not found!"
-  fi
-}
-
-function backup_mainsail() {
-  local current_date
-
-  if [[ -d ${MAINSAIL_DIR} ]]; then
-    status_msg "Creating Mainsail backup ..."
-    check_for_backup_dir
-    current_date=$(get_date)
-    status_msg "Timestamp: ${current_date}"
-    mkdir -p "${BACKUP_DIR}/mainsail-backups/${current_date}"
-    cp -r "${MAINSAIL_DIR}" "${_}"
-    print_confirm "Mainsail backup complete!"
-  else
-    print_error "Can't back up 'mainsail' directory! Not found!"
-  fi
-}
-
-function backup_fluidd() {
-  local current_date
-
-  if [[ -d ${FLUIDD_DIR} ]]; then
-    status_msg "Creating Fluidd backup ..."
-    check_for_backup_dir
-    current_date=$(get_date)
-    status_msg "Timestamp: ${current_date}"
-    mkdir -p "${BACKUP_DIR}/fluidd-backups/${current_date}"
-    cp -r "${FLUIDD_DIR}" "${_}"
-    print_confirm "Fluidd backup complete!"
-  else
-    print_error "Can't back up 'fluidd' directory! Not found!"
-  fi
-}
-
-function backup_moonraker() {
-  local current_date
-
-  if [[ -d ${MOONRAKER_DIR} && -d ${MOONRAKER_ENV} ]]; then
-    status_msg "Creating Moonraker backup ..."
-    check_for_backup_dir
-    current_date=$(get_date)
-    status_msg "Timestamp: ${current_date}"
-    mkdir -p "${BACKUP_DIR}/moonraker-backups/${current_date}"
-    cp -r "${MOONRAKER_DIR}" "${_}" && cp -r "${MOONRAKER_ENV}" "${_}"
-    print_confirm "Moonraker backup complete!"
-  else
-    print_error "Can't back up moonraker and/or moonraker-env directory! Not found!"
-  fi
-}
-
-function backup_octoprint() {
-  local current_date
-
-  if [[ -d ${OCTOPRINT_DIR} && -d ${OCTOPRINT_CFG_DIR} ]]; then
-    status_msg "Creating OctoPrint backup ..."
-    check_for_backup_dir
-    current_date=$(get_date)
-    status_msg "Timestamp: ${current_date}"
-    mkdir -p "${BACKUP_DIR}/octoprint-backups/${current_date}"
-    cp -r "${OCTOPRINT_DIR}" "${_}" && cp -r "${OCTOPRINT_CFG_DIR}" "${_}"
-    print_confirm " OctoPrint backup complete!"
-  else
-    print_error "Can't back up OctoPrint and/or .octoprint directory!\n Not found!"
-  fi
-}
-
-function backup_klipperscreen() {
-  local current_date
-  if [[ -d ${KLIPPERSCREEN_DIR} ]] ; then
-    status_msg "Creating KlipperScreen backup ..."
-    check_for_backup_dir
-    current_date=$(get_date)
-    status_msg "Timestamp: ${current_date}"
-    mkdir -p "${BACKUP_DIR}/klipperscreen-backups/${current_date}"
-    cp -r "${KLIPPERSCREEN_DIR}" "${_}"
-    print_confirm "KlipperScreen backup complete!"
-  else
-    print_error "Can't back up KlipperScreen directory!\n Not found!"
-  fi
-}
-
-function backup_telegram_bot() {
-  local current_date
-
-  if [[ -d ${TELEGRAM_BOT_DIR} ]] ; then
-    status_msg "Creating MoonrakerTelegramBot backup ..."
-    check_for_backup_dir
-    current_date=$(get_date)
-    status_msg "Timestamp: ${current_date}"
-    mkdir -p "${BACKUP_DIR}/MoonrakerTelegramBot-backups/${current_date}"
-    cp -r "${TELEGRAM_BOT_DIR}" "${_}"
-    print_confirm "MoonrakerTelegramBot backup complete!"
-  else
-    print_error "Can't back up MoonrakerTelegramBot directory!\n Not found!"
-  fi
-}
-
-function backup_octoeverywhere() {
-  local current_date
-
-  if [[ -d ${OCTOEVERYWHERE_DIR} ]] ; then
-    status_msg "Creating OctoEverywhere backup ..."
-    check_for_backup_dir
-    current_date=$(get_date)
-    status_msg "Timestamp: ${current_date}"
-    mkdir -p "${BACKUP_DIR}/OctoEverywhere-backups/${current_date}"
-    cp -r "${OCTOEVERYWHERE_DIR}" "${_}" && cp -r "${OCTOEVERYWHERE_ENV}" "${_}"
-    print_confirm "OctoEverywhere backup complete!"
-  else
-    print_error "Can't back up OctoEverywhere directory!\n Not found!"
-  fi
-}
-
-function backup_spoolman() {
-  local current_date
-
-  if [[ -d ${SPOOLMAN_DIR} ]] ; then
-    status_msg "Creating Spoolman backup ..."
-    check_for_backup_dir
-    current_date=$(get_date)
-    status_msg "Timestamp: ${current_date}"
-    mkdir -p "${BACKUP_DIR}/Spoolman-backups/${current_date}"
-    cp -r "${SPOOLMAN_DIR}" "${_}" && cp -r "${SPOOLMAN_DB_DIR}/spoolman.db" "${_}"
-    print_confirm "Spoolman backup complete!"
-  else
-    print_error "Can't back up Spoolman directory!\n Not found!"
-  fi
-}

scripts/crowsnest.sh

@@ -1,235 +0,0 @@
-#!/usr/bin/env bash
-
-#=======================================================================#
-# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
-#                                                                       #
-# This file is part of KIAUH - Klipper Installation And Update Helper   #
-# https://github.com/dw-0/kiauh                                         #
-#                                                                       #
-# This file may be distributed under the terms of the GNU GPLv3 license #
-#=======================================================================#
-
-#=======================================================================#
-# Crowsnest Installer brought to you by KwadFan <me@stephanwe.de>       #
-# Copyright (C) 2022 KwadFan <me@stephanwe.de>                          #
-# https://github.com/KwadFan/crowsnest                                  #
-#=======================================================================#
-
-# Error Handling
-set -e
-
-# Helper messages
-
-function multi_instance_message(){
-  echo -e "Crowsnest is NOT designed to support multi instances."
-  echo -e "A workaround for this is to choose the most used instance as a 'master'"
-  echo -e "Use this instance to set up your 'crowsnest.conf' and steering it's service.\n"
-  echo -e "Found the following instances:\n"
-  for i in ${1}; do
-    select_msg "${i}"
-  done
-  echo -e "\nLaunching crowsnest's configuration tool ..."
-  continue_config
-}
-
-# Helper funcs
-function clone_crowsnest(){
-  $(command -v git) clone "${CROWSNEST_REPO}" -b master "${CROWSNEST_DIR}"
-}
-
-function check_multi_instance(){
-  local -a instances
-  readarray -t instances < <(find "${HOME}" -regex "${HOME}/[a-zA-Z0-9_]+_data/*" -printf "%P\n" 2> /dev/null | sort)
-  if [[ "${#instances[@]}" -gt 1 ]]; then
-    status_msg "Multi instance install detected ..."
-    multi_instance_message "${instances[*]}"
-    if [[ -d "${HOME}/crowsnest" ]]; then
-      pushd "${HOME}/crowsnest" &> /dev/null || exit 1
-      if ! make config ;then
-        error_msg "Something went wrong! Please try again..."
-        if [[ -f "tools/.config" ]]; then
-          rm -f tools/.config
-        fi
-        exit 1
-      fi
-      if [[ ! -f "tools/.config" ]]; then
-        log_error "failure while generating .config"
-        error_msg "Generating .config failed, installation aborted"
-        exit 1
-      fi
-      popd &> /dev/null || exit 1
-    fi
-  fi
-}
-
-function continue_config() {
-  local reply
-  while true; do
-    read -erp "${cyan}###### Continue with configuration? (y/N):${white} " reply
-    case "${reply}" in
-      Y|y|Yes|yes)
-        select_msg "Yes"
-        break;;
-      N|n|No|no|"")
-        select_msg "No"
-        warn_msg "Installation aborted by user ... Exiting!"
-        exit 1;;
-      *)
-        error_msg "Invalid Input!\n";;
-    esac
-  done
-  return 0
-}
-
-# Install func
-function install_crowsnest(){
-
-  # Step 1: jump to home directory
-  pushd "${HOME}" &> /dev/null || exit 1
-
-  # Step 2: Clone crowsnest repo
-  status_msg "Cloning 'crowsnest' repository ..."
-  if [[ ! -d "${HOME}/crowsnest" && -z "$(ls -A "${HOME}/crowsnest" 2> /dev/null)" ]]; then
-    clone_crowsnest
-  else
-    ok_msg "crowsnest repository already exists ..."
-  fi
-
-  # Step 3: Install dependencies
-  dependency_check git make
-
-  # Step 4: Check for Multi Instance
-  check_multi_instance
-
-  # Step 5: Launch crowsnest installer
-  pushd "${HOME}/crowsnest" &> /dev/null || exit 1
-  title_msg "Installer will prompt you for sudo password!"
-  status_msg "Launching crowsnest installer ..."
-  if ! sudo make install; then
-    error_msg "Something went wrong! Please try again..."
-    exit 1
-  fi
-
-  # Step 5: Leave directory (twice due two pushd)
-  popd &> /dev/null || exit 1
-  popd &> /dev/null || exit 1
-}
-
-# Remove func
-function remove_crowsnest(){
-  if [[ -d "${CROWSNEST_DIR}" ]]; then
-    pushd "${HOME}/crowsnest" &> /dev/null || exit 1
-    title_msg "Uninstaller will prompt you for sudo password!"
-    status_msg "Launching crowsnest uninstaller ..."
-
-    if ! make uninstall; then
-      error_msg "Something went wrong! Please try again..."
-      exit 1
-    fi
-
-    status_msg "Removing crowsnest directory ..."
-    rm -rf "${CROWSNEST_DIR}"
-    ok_msg "Directory removed!"
-  fi
-
-  print_confirm "Crowsnest successfully removed!"
-}
-
-# Status funcs
-get_crowsnest_status(){
-  local -a files
-  local env_file
-  env_file="$(grep "EnvironmentFile" /etc/systemd/system/crowsnest.service 2>/dev/null | cut -d "=" -f2)"
-  files=(
-    "${CROWSNEST_DIR}"
-    "/usr/local/bin/crowsnest"
-    "/etc/logrotate.d/crowsnest"
-    "/etc/systemd/system/crowsnest.service"
-    "${env_file}"
-    )
-  local count
-  count=0
-
-  for file in "${files[@]}"; do
-    [[ -e "${file}" ]] && count=$(( count +1 ))
-  done
-  if [[ "${count}" -eq "${#files[*]}" ]]; then
-    echo "Installed"
-  elif [[ "${count}" -gt 0 ]]; then
-    echo "Incomplete!"
-  else
-    echo "Not installed!"
-  fi
-}
-
-# Update funcs
-# Shameless stolen from KlipperScreen.sh
-function get_local_crowsnest_commit() {
-  [[ ! -d ${CROWSNEST_DIR} || ! -d "${CROWSNEST_DIR}/.git" ]] && return
-
-  local commit
-  cd "${CROWSNEST_DIR}"
-  commit="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
-  echo "${commit}"
-}
-
-function get_remote_crowsnest_commit() {
-  [[ ! -d ${CROWSNEST_DIR} || ! -d "${CROWSNEST_DIR}/.git" ]] && return
-
-  local commit
-  cd "${CROWSNEST_DIR}" && git fetch origin -q
-  commit=$(git describe origin/master --always --tags | cut -d "-" -f 1,2)
-  echo "${commit}"
-}
-
-function compare_crowsnest_versions() {
-  local versions local_ver remote_ver
-  local_ver="$(get_local_crowsnest_commit)"
-  remote_ver="$(get_remote_crowsnest_commit)"
-
-  if [[ ${local_ver} != "${remote_ver}" ]]; then
-    versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
-    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    # add moonraker to application_updates_available in kiauh.ini
-    add_to_application_updates "crowsnest"
-  else
-    versions="${green}$(printf " %-14s" "${local_ver}")${white}"
-    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-  fi
-
-  echo "${versions}"
-}
-
-function install_crowsnest_dependencies() {
-  local packages log_name="Crowsnest"
-  local install_script="${CROWSNEST_DIR}/tools/install.sh"
-
-  ### read PKGLIST from official install-script
-  status_msg "Reading dependencies..."
-  # shellcheck disable=SC2016
-  packages="$(grep "PKGLIST=" "${install_script}" | cut -d'"' -f2 | sed 's/\${PKGLIST}//g' | tr -d '\n')"
-
-  echo "${cyan}${packages}${white}" | tr '[:space:]' '\n'
-    read -r -a packages <<< "${packages}"
-
-  ### Update system package lists if stale
-  update_system_package_lists
-
-  ### Install required packages
-  install_system_packages "${log_name}" "packages[@]"
-}
-
-function update_crowsnest() {
-  do_action_service "stop" "crowsnest"
-
-  if [[ ! -d ${CROWSNEST_DIR} ]]; then
-    clone_crowsnest
-  else
-    status_msg "Updating Crowsnest ..."
-    cd "${CROWSNEST_DIR}" && git pull
-    ### read PKGLIST and install possible new dependencies
-    install_crowsnest_dependencies
-  fi
-  ok_msg "Update complete!"
-  do_action_service "restart" "crowsnest"
-}

scripts/flash_klipper.sh

@@ -1,494 +0,0 @@
-#!/usr/bin/env bash
-
-#=======================================================================#
-# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
-#                                                                       #
-# This file is part of KIAUH - Klipper Installation And Update Helper   #
-# https://github.com/dw-0/kiauh                                         #
-#                                                                       #
-# This file may be distributed under the terms of the GNU GPLv3 license #
-#=======================================================================#
-
-set -e
-
-function init_flash_process() {
-  ### step 1: check for required userhgroups (tty & dialout)
-  check_usergroups
-
-  top_border
-  echo -e "|        ~~~~~~~~~~~~ [ Flash MCU ] ~~~~~~~~~~~~        |"
-  hr
-  echo -e "| Please select the flashing method to flash your MCU.  |"
-  echo -e "| Make sure to only select a method your MCU supports.  |"
-  echo -e "| Not all MCUs support both methods!                    |"
-  hr
-  blank_line
-  echo -e "| 1) Regular flashing method                            |"
-  echo -e "| 2) Updating via SD-Card Update                        |"
-  blank_line
-  back_help_footer
-
-  local choice method
-  while true; do
-    read -p "${cyan}###### Please select:${white} " choice
-    case "${choice}" in
-      1)
-        select_msg "Regular flashing method"
-        method="regular"
-        break;;
-      2)
-        select_msg "SD-Card Update"
-        method="sdcard"
-        break;;
-      B|b)
-        advanced_menu
-        break;;
-      H|h)
-        clear && print_header
-        show_flash_method_help
-        break;;
-      *)
-        error_msg "Invalid command!";;
-    esac
-  done
-
-  ### step 2: select how the mcu is flashed (flash/serialflash)
-  select_flash_command
-
-  ### step 3: select how the mcu is connected to the host
-  select_mcu_connection
-
-  ### step 4: select which detected mcu should be flashed
-  select_mcu_id "${method}"
-}
-
-#================================================#
-#=================== STEP 2 =====================#
-#================================================#
-function select_flash_command() {
-  unset flash_command
-
-  top_border
-  echo -e "| How to flash MCU?                                     |"
-  echo -e "| 1) make flash (default)                               |"
-  echo -e "| 2) make serialflash (stm32flash)                      |"
-  blank_line
-  back_help_footer
-
-  local choice
-  while true; do
-    read -p "${cyan}###### Flashing command:${white} " -i "1" -e choice
-    case "${choice}" in
-      1)
-        select_msg "Selected 'make flash' command"
-        flash_command="flash"
-        break;;
-      2)
-        select_msg "Selected 'make serialflash' command"
-        flash_command="serialflash"
-        break;;
-      B|b)
-        advanced_menu
-        break;;
-      H|h)
-        clear && print_header
-        show_mcu_flash_command_help
-        break;;
-      *)
-        error_msg "Invalid command!";;
-    esac
-  done
-}
-
-#================================================#
-#=================== STEP 3 =====================#
-#================================================#
-function select_mcu_connection() {
-  top_border
-  echo -e "| ${yellow}Make sure that the controller board is connected now!${white} |"
-  hr
-  blank_line
-  echo -e "| How is the controller board connected to the host?    |"
-  echo -e "| 1) USB                                                |"
-  echo -e "| 2) UART                                               |"
-  echo -e "| 3) USB (DFU mode)                                     |"
-  blank_line
-  back_help_footer
-
-  local choice
-  while true; do
-    read -p "${cyan}###### Connection method:${white} " choice
-    case "${choice}" in
-      1)
-        status_msg "Identifying MCU connected via USB ...\n"
-        get_usb_id || true # continue even after exit code 1
-        break;;
-      2)
-        status_msg "Identifying MCU possibly connected via UART ...\n"
-        get_uart_id || true # continue even after exit code 1
-        break;;
-      3)
-        status_msg "Identifying MCU connected via USB in DFU mode ...\n"
-        get_dfu_id || true # continue even after exit code 1
-        break;;
-      B|b)
-        advanced_menu
-        break;;
-      H|h)
-        clear && print_header
-        show_mcu_connection_help
-        break;;
-      *)
-        error_msg "Invalid command!";;
-    esac
-  done
-}
-
-function print_detected_mcu_to_screen() {
-  local i=1
-
-  if (( ${#mcu_list[@]} < 1 )); then
-    print_error "No MCU found!\n MCU either not connected or not detected!"
-    return
-  fi
-
-  for mcu in "${mcu_list[@]}"; do
-    echo -e " ● MCU #${i}: ${cyan}${mcu}${white}"
-    i=$(( i + 1 ))
-  done
-  echo
-}
-
-#================================================#
-#=================== STEP 4 =====================#
-#================================================#
-function select_mcu_id() {
-  local i=0 sel_index=0 method=${1}
-
-  if (( ${#mcu_list[@]} < 1 )); then
-    print_error "No MCU found!\n MCU either not connected or not detected!"
-    return
-  fi
-
-  top_border
-  echo -e "|                   ${red}!!! ATTENTION !!!${white}                   |"
-  hr
-  echo -e "| Make sure, to select the correct MCU!                 |"
-  echo -e "| ${red}ONLY flash a firmware created for the respective MCU!${white} |"
-  bottom_border
-  echo -e "${cyan}###### List of available MCU:${white}"
-
-  ### list all mcus
-  for mcu in "${mcu_list[@]}"; do
-    i=$(( i + 1 ))
-    mcu=$(echo "${mcu}" | rev | cut -d"/" -f1 | rev)
-    echo -e " ● MCU #${i}: ${cyan}${mcu}${white}"
-  done
-
-  ### verify user input
-  local regex="^[1-9]+$"
-  while [[ ! ${sel_index} =~ ${regex} ]] || [[ ${sel_index} -gt ${i} ]]; do
-    echo
-    read -p "${cyan}###### Select MCU to flash:${white} " sel_index
-
-    if [[ ! ${sel_index} =~ ${regex} ]]; then
-      error_msg "Invalid input!"
-    elif [[ ${sel_index} -lt 1 ]] || [[ ${sel_index} -gt ${i} ]]; then
-      error_msg "Please select a number between 1 and ${i}!"
-    fi
-
-    local mcu_index=$(( sel_index - 1 ))
-    local selected_mcu_id="${mcu_list[${mcu_index}]}"
-  done
-
-  ### confirm selection
-  local yn
-  while true; do
-    echo -e "\n###### You selected:\n ● MCU #${sel_index}: ${selected_mcu_id}\n"
-    read -p "${cyan}###### Continue? (Y/n):${white} " yn
-    case "${yn}" in
-      Y|y|Yes|yes|"")
-        select_msg "Yes"
-        status_msg "Flashing ${selected_mcu_id} ..."
-        if [[ ${method} == "regular" ]]; then
-          log_info "Flashing device '${selected_mcu_id}' with method '${method}'"
-          start_flash_mcu "${selected_mcu_id}"
-        elif [[ ${method} == "sdcard" ]]; then
-          log_info "Flashing device '${selected_mcu_id}' with method '${method}'"
-          start_flash_sd "${selected_mcu_id}"
-        else
-          print_error "No flash method set! Aborting..."
-          log_error "No flash method set!"
-          return
-        fi
-        break;;
-      N|n|No|no)
-        select_msg "No"
-        break;;
-      *)
-        error_msg "Invalid command!";;
-    esac
-  done
-}
-
-function start_flash_mcu() {
-  local device=${1}
-  do_action_service "stop" "klipper"
-
-  if make ${flash_command} FLASH_DEVICE="${device}"; then
-    ok_msg "Flashing successfull!"
-  else
-    warn_msg "Flashing failed!"
-    warn_msg "Please read the console output above!"
-  fi
-
-  do_action_service "start" "klipper"
-}
-
-function start_flash_sd() {
-  local i=0 board_list=() device=${1}
-  local flash_script="${KLIPPER_DIR}/scripts/flash-sdcard.sh"
-
-  ### write each supported board to the array to make it selectable
-  for board in $("${flash_script}" -l | tail -n +2); do
-    board_list+=("${board}")
-  done
-
-  top_border
-  echo -e "|  Please select the type of board that corresponds to  |"
-  echo -e "|  the currently selected MCU ID you chose before.      |"
-  blank_line
-  echo -e "|  The following boards are currently supported:        |"
-  hr
-  ### display all supported boards to the user
-  for board in "${board_list[@]}"; do
-    if [[ ${i} -lt 10 ]]; then
-      printf "|  ${i}) %-50s|\n" "${board_list[${i}]}"
-    else
-      printf "|  ${i}) %-49s|\n" "${board_list[${i}]}"
-    fi
-    i=$(( i + 1 ))
-  done
-  quit_footer
-
-  ### make the user select one of the boards
-  local choice
-  while true; do
-    read -p "${cyan}###### Please select board type:${white} " choice
-    if [[ ${choice} = "q" || ${choice} = "Q" ]]; then
-      clear && advanced_menu && break
-    elif [[ ${choice} -le ${#board_list[@]} ]]; then
-      local selected_board="${board_list[${choice}]}"
-      break
-    else
-      clear && print_header
-      error_msg "Invalid choice!"
-      flash_mcu_sd
-    fi
-  done
-
-  while true; do
-    echo
-    top_border
-    echo -e "| If your board is flashed with firmware that connects  |"
-    echo -e "| at a custom baud rate, please change it now.          |"
-    blank_line
-    echo -e "| If you are unsure, stick to the default 250000!       |"
-    bottom_border
-
-    local baud_rate regex="^[0-9]+$"
-    echo -e "${cyan}###### Please set the baud rate:${white} "
-    while [[ ! ${baud_rate} =~ ${regex} ]]; do
-      read -e -i "250000" -e baud_rate
-      local selected_baud_rate=${baud_rate}
-      break
-    done
-    break
-  done
-
-  ###flash process
-  do_action_service "stop" "klipper"
-  if "${flash_script}" -b "${selected_baud_rate}" "${device}" "${selected_board}"; then
-    print_confirm "Flashing successfull!"
-    log_info "Flash successfull!"
-  else
-    print_error "Flashing failed!\n Please read the console output above!"
-    log_error "Flash failed!"
-  fi
-  do_action_service "start" "klipper"
-}
-
-function build_fw() {
-  local python_version
-
-  if [[ ! -d ${KLIPPER_DIR} || ! -d ${KLIPPY_ENV} ]]; then
-    print_error "Klipper not found!\n Cannot build firmware without Klipper!"
-    return
-  fi
-
-  python_version=$(get_klipper_python_ver)
-
-  cd "${KLIPPER_DIR}"
-  status_msg "Initializing firmware build ..."
-  local dep=(build-essential dpkg-dev make)
-  dependency_check "${dep[@]}"
-
-  make clean
-
-  status_msg "Building firmware ..."
-  if (( python_version == 3 )); then
-    make PYTHON=python3 menuconfig
-    make PYTHON=python3
-  elif (( python_version == 2 )); then
-    make PYTHON=python2 menuconfig
-    make PYTHON=python2
-  else
-    warn_msg "Error reading Python version!"
-    return 1
-  fi
-
-  ok_msg "Firmware built!"
-}
-
-#================================================#
-#=================== HELPERS ====================#
-#================================================#
-
-function get_usb_id() {
-  unset mcu_list
-  sleep 1
-  mcus=$(find /dev/serial/by-id/* 2>/dev/null)
-
-  for mcu in ${mcus}; do
-    mcu_list+=("${mcu}")
-  done
-}
-
-function get_uart_id() {
-  unset mcu_list
-  sleep 1
-  mcus=$(find /dev -maxdepth 1 -regextype posix-extended -regex "^\/dev\/tty(AMA0|S0)$" 2>/dev/null)
-
-  for mcu in ${mcus}; do
-    mcu_list+=("${mcu}")
-  done
-}
-
-function get_dfu_id() {
-  unset mcu_list
-  sleep 1
-  mcus=$(lsusb | grep "DFU" | cut -d " " -f 6 2>/dev/null)
-
-  for mcu in ${mcus}; do
-    mcu_list+=("${mcu}")
-  done
-}
-
-function show_flash_method_help() {
-  top_border
-  echo -e "|     ~~~~~~~~ < ? > Help: Flash MCU < ? > ~~~~~~~~     |"
-  hr
-  echo -e "| ${cyan}Regular flashing method:${white}                              |"
-  echo -e "| The default method to flash controller boards which   |"
-  echo -e "| are connected and updated over USB and not by placing |"
-  echo -e "| a compiled firmware file onto an internal SD-Card.    |"
-  blank_line
-  echo -e "| Common controllers that get flashed that way are:     |"
-  echo -e "| - Arduino Mega 2560                                   |"
-  echo -e "| - Fysetc F6 / S6 (used without a Display + SD-Slot)   |"
-  blank_line
-  echo -e "| ${cyan}Updating via SD-Card Update:${white}                          |"
-  echo -e "| Many popular controller boards ship with a bootloader |"
-  echo -e "| capable of updating the firmware via SD-Card.         |"
-  echo -e "| Choose this method if your controller board supports  |"
-  echo -e "| this way of updating. This method ONLY works for up-  |"
-  echo -e "| grading firmware. The initial flashing procedure must |"
-  echo -e "| be done manually per the instructions that apply to   |"
-  echo -e "| your controller board.                                |"
-  blank_line
-  echo -e "| Common controllers that can be flashed that way are:  |"
-  echo -e "| - BigTreeTech SKR 1.3 / 1.4 (Turbo) / E3 / Mini E3    |"
-  echo -e "| - Fysetc F6 / S6 (used with a Display + SD-Slot)      |"
-  echo -e "| - Fysetc Spider                                       |"
-  blank_line
-  back_footer
-
-  local choice
-  while true; do
-    read -p "${cyan}###### Please select:${white} " choice
-    case "${choice}" in
-      B|b)
-        clear && print_header
-        init_flash_process
-        break;;
-      *)
-        error_msg "Invalid command!";;
-    esac
-  done
-}
-
-function show_mcu_flash_command_help() {
-  top_border
-  echo -e "|     ~~~~~~~~ < ? > Help: Flash MCU < ? > ~~~~~~~~     |"
-  hr
-  echo -e "| ${cyan}make flash:${white}                                           |"
-  echo -e "| The default command to flash controller board, it     |"
-  echo -e "| will detect selected microcontroller and use suitable |"
-  echo -e "| tool for flashing it.                                 |"
-  blank_line
-  echo -e "| ${cyan}make serialflash:${white}                                     |"
-  echo -e "| Special command to flash STM32 microcontrollers in    |"
-  echo -e "| DFU mode but connected via serial. stm32flash command |"
-  echo -e "| will be used internally.                              |"
-  blank_line
-  back_footer
-
-  local choice
-  while true; do
-    read -p "${cyan}###### Please select:${white} " choice
-    case "${choice}" in
-      B|b)
-        clear && print_header
-        select_flash_command
-        break;;
-      *)
-        error_msg "Invalid command!";;
-    esac
-  done
-}
-
-function show_mcu_connection_help() {
-  top_border
-  echo -e "|     ~~~~~~~~ < ? > Help: Flash MCU < ? > ~~~~~~~~     |"
-  hr
-  echo -e "| ${cyan}USB:${white}                                                  |"
-  echo -e "| Selecting USB as the connection method will scan the  |"
-  echo -e "| USB ports for connected controller boards. This will  |"
-  echo -e "| be similar to the 'ls /dev/serial/by-id/*' command    |"
-  echo -e "| suggested by the official Klipper documentation for   |"
-  echo -e "| determining successfull USB connections!              |"
-  blank_line
-  echo -e "| ${cyan}UART:${white}                                                 |"
-  echo -e "| Selecting UART as the connection method will list all |"
-  echo -e "| possible UART serial ports. Note: This method ALWAYS  |"
-  echo -e "| returns something as it seems impossible to determine |"
-  echo -e "| if a valid Klipper controller board is connected or   |"
-  echo -e "| not. Because of that, you ${red}MUST${white} know which UART serial |"
-  echo -e "| port your controller board is connected to when using |"
-  echo -e "| this connection method.                               |"
-  blank_line
-  back_footer
-
-  local choice
-  while true; do
-    read -p "${cyan}###### Please select:${white} " choice
-    case "${choice}" in
-      B|b)
-        clear && print_header
-        select_mcu_connection
-        break;;
-      *)
-        error_msg "Invalid command!";;
-    esac
-  done
-}

scripts/fluidd.sh

@@ -1,510 +0,0 @@
-#!/usr/bin/env bash
-
-#=======================================================================#
-# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
-#                                                                       #
-# This file is part of KIAUH - Klipper Installation And Update Helper   #
-# https://github.com/dw-0/kiauh                                         #
-#                                                                       #
-# This file may be distributed under the terms of the GNU GPLv3 license #
-#=======================================================================#
-
-set -e
-
-#===================================================#
-#================== INSTALL FLUIDD =================#
-#===================================================#
-
-function install_fluidd() {
-  if [[ -z $(moonraker_systemd) ]]; then
-    local error="Moonraker not installed! It's recommended to install Moonraker first!"
-    print_error "${error}"
-    while true; do
-      local yn
-      read -p "${cyan}###### Proceed to install Fluidd without installing Moonraker? (y/N):${white} " yn
-      case "${yn}" in
-        Y|y|Yes|yes)
-          select_msg "Yes"
-          break;;
-        N|n|No|no|"")
-          select_msg "No"
-          abort_msg "Exiting Fluidd setup ...\n"
-          return;;
-        *)
-          error_msg "Invalid Input!";;
-      esac
-    done
-  fi
-
-  ### checking dependencies
-  local dep=(wget nginx unzip)
-  dependency_check "${dep[@]}"
-  ### detect conflicting Haproxy and Apache2 installations
-  detect_conflicting_packages
-
-  status_msg "Initializing Fluidd installation ..."
-  ### first, we create a backup of the full klipper_config dir - safety first!
-  backup_config_dir
-
-  ### check for other enabled web interfaces
-  unset SET_LISTEN_PORT
-  detect_enabled_sites
-
-  ### check if another site already listens to port 80
-  fluidd_port_check
-
-  ### download fluidd
-  download_fluidd
-
-  ### ask user to install the recommended webinterface macros
-  install_fluidd_macros
-
-  ### create /etc/nginx/conf.d/upstreams.conf
-  set_upstream_nginx_cfg
-  ### create /etc/nginx/sites-available/<interface config>
-  set_nginx_cfg "fluidd"
-  ### nginx on ubuntu 21 and above needs special permissions to access the files
-  set_nginx_permissions
-
-  ### symlink nginx log
-  symlink_webui_nginx_log "fluidd"
-
-  ### add fluidd to the update manager in moonraker.conf
-  patch_fluidd_update_manager
-
-  fetch_webui_ports #WIP
-
-  ### confirm message
-  print_confirm "Fluidd has been set up!"
-}
-
-function install_fluidd_macros() {
-  local yn
-  while true; do
-    echo
-    top_border
-    echo -e "| It is recommended to use special macros in order to   |"
-    echo -e "| have Fluidd fully functional and working.             |"
-    blank_line
-    echo -e "| The recommended macros for Fluidd can be found here:  |"
-    echo -e "| https://github.com/fluidd-core/fluidd-config           |"
-    blank_line
-    echo -e "| If you already use these macros skip this step.       |"
-    echo -e "| Otherwise you should consider to answer with 'yes' to |"
-    echo -e "| download the recommended macros.                      |"
-    bottom_border
-    read -p "${cyan}###### Download the recommended macros? (Y/n):${white} " yn
-    case "${yn}" in
-      Y|y|Yes|yes|"")
-        select_msg "Yes"
-        download_fluidd_macros
-        break;;
-      N|n|No|no)
-        select_msg "No"
-        break;;
-      *)
-        print_error "Invalid command!";;
-    esac
-  done
-  return
-}
-
-function download_fluidd_macros() {
-  local ms_cfg_repo path configs regex line gcode_dir
-
-  ms_cfg_repo="https://github.com/fluidd-core/fluidd-config.git"
-  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/printer\.cfg"
-  configs=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)
-
-  if [[ -z ${configs} ]]; then
-    print_error "No printer.cfg found! Installation of Macros will be skipped ..."
-    log_error "execution stopped! reason: no printer.cfg found"
-    return
-  fi
-
-  status_msg "Cloning fluidd-config ..."
-  [[ -d "${HOME}/fluidd-config" ]] && rm -rf "${HOME}/fluidd-config"
-  if git clone --recurse-submodules "${ms_cfg_repo}" "${HOME}/fluidd-config"; then
-    for config in ${configs}; do
-      path=$(echo "${config}" | rev | cut -d"/" -f2- | rev)
-
-      if [[ -e "${path}/fluidd.cfg" && ! -h "${path}/fluidd.cfg" ]]; then
-        warn_msg "Attention! Existing fluidd.cfg detected!"
-        warn_msg "The file will be renamed to 'fluidd.bak.cfg' to be able to continue with the installation."
-        if ! mv "${path}/fluidd.cfg" "${path}/fluidd.bak.cfg"; then
-          error_msg "Renaming fluidd.cfg failed! Aborting installation ..."
-          return
-        fi
-      fi
-
-      if [[ -h "${path}/fluidd.cfg" ]]; then
-        warn_msg "Recreating symlink in ${path} ..."
-        rm -rf "${path}/fluidd.cfg"
-      fi
-
-      if ! ln -sf "${HOME}/fluidd-config/client.cfg" "${path}/fluidd.cfg"; then
-        error_msg "Creating symlink failed! Aborting installation ..."
-        return
-      fi
-
-      if ! grep -Eq "^\[include fluidd.cfg\]$" "${path}/printer.cfg"; then
-        log_info "${path}/printer.cfg"
-        sed -i "1 i [include fluidd.cfg]" "${path}/printer.cfg"
-      fi
-
-      line=$(($(grep -n "\[include fluidd.cfg\]" "${path}/printer.cfg" | tail -1 | cut -d: -f1) + 1))
-      gcode_dir=${path/config/gcodes}
-      if ! grep -Eq "^\[virtual_sdcard\]$" "${path}/printer.cfg"; then
-        log_info "${path}/printer.cfg"
-        sed -i "${line} i \[virtual_sdcard]\npath: ${gcode_dir}\non_error_gcode: CANCEL_PRINT\n" "${path}/printer.cfg"
-      fi
-    done
-  else
-    print_error "Cloning failed! Aborting installation ..."
-    log_error "execution stopped! reason: cloning failed"
-    return
-  fi
-
-  patch_fluidd_config_update_manager
-
-  ok_msg "Done!"
-}
-
-function download_fluidd() {
-  local url
-  url=$(get_fluidd_download_url)
-
-  status_msg "Downloading Fluidd from ${url} ..."
-
-  if [[ -d ${FLUIDD_DIR} ]]; then
-    rm -rf "${FLUIDD_DIR}"
-  fi
-
-  mkdir "${FLUIDD_DIR}" && cd "${FLUIDD_DIR}"
-
-  if wget "${url}"; then
-    ok_msg "Download complete!"
-    status_msg "Extracting archive ..."
-    unzip -q -o ./*.zip && ok_msg "Done!"
-    status_msg "Remove downloaded archive ..."
-    rm -rf ./*.zip && ok_msg "Done!"
-  else
-    print_error "Downloading Fluidd from\n ${url}\n failed!"
-    exit 1
-  fi
-}
-
-#===================================================#
-#================== REMOVE FLUIDD ==================#
-#===================================================#
-
-function remove_fluidd_dir() {
-  [[ ! -d ${FLUIDD_DIR} ]] && return
-
-  status_msg "Removing Fluidd directory ..."
-  rm -rf "${FLUIDD_DIR}" && ok_msg "Directory removed!"
-}
-
-function remove_fluidd_nginx_config() {
-  if [[ -e "/etc/nginx/sites-available/fluidd" ]]; then
-    status_msg "Removing Fluidd configuration for Nginx ..."
-    sudo rm "/etc/nginx/sites-available/fluidd" && ok_msg "File removed!"
-  fi
-  if [[ -L "/etc/nginx/sites-enabled/fluidd" ]]; then
-    status_msg "Removing Fluidd Symlink for Nginx ..."
-    sudo rm "/etc/nginx/sites-enabled/fluidd" && ok_msg "File removed!"
-  fi
-}
-
-function remove_fluidd_logs() {
-  local files
-  files=$(find /var/log/nginx -name "fluidd*" 2> /dev/null | sort)
-
-  if [[ -n ${files} ]]; then
-    for file in ${files}; do
-      status_msg "Removing ${file} ..."
-      sudo rm -f "${file}"
-      ok_msg "${file} removed!"
-    done
-  fi
-}
-
-function remove_fluidd_log_symlinks() {
-  local files regex
-
-  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/logs\/fluidd-.*"
-  files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" 2> /dev/null | sort)
-
-  if [[ -n ${files} ]]; then
-    for file in ${files}; do
-      status_msg "Removing ${file} ..."
-      rm -f "${file}"
-      ok_msg "${file} removed!"
-    done
-  fi
-}
-
-function remove_legacy_fluidd_log_symlinks() {
-  local files
-  files=$(find "${HOME}/klipper_logs" -name "fluidd*" 2> /dev/null | sort)
-
-  if [[ -n ${files} ]]; then
-    for file in ${files}; do
-      status_msg "Removing ${file} ..."
-      rm -f "${file}"
-      ok_msg "${file} removed!"
-    done
-  fi
-}
-
-function remove_fluidd_config() {
-  if [[ -d "${HOME}/fluidd-config"  ]]; then
-    status_msg "Removing ${HOME}/fluidd-config ..."
-    rm -rf "${HOME}/fluidd-config"
-    ok_msg "${HOME}/fluidd-config removed!"
-    print_confirm "Fluidd-Config successfully removed!"
-  fi
-}
-
-function remove_fluidd() {
-  remove_fluidd_dir
-  remove_fluidd_nginx_config
-  remove_fluidd_logs
-  remove_fluidd_log_symlinks
-  remove_legacy_fluidd_log_symlinks
-
-  ### remove fluidd_port from ~/.kiauh.ini
-  sed -i "/^fluidd_port=/d" "${INI_FILE}"
-
-  print_confirm "Fluidd successfully removed!"
-}
-
-#===================================================#
-#================== UPDATE FLUIDD ==================#
-#===================================================#
-
-function update_fluidd() {
-  backup_before_update "fluidd"
-  status_msg "Updating Fluidd ..."
-  download_fluidd
-  match_nginx_configs
-  symlink_webui_nginx_log "fluidd"
-  print_confirm "Fluidd successfully updated!"
-}
-
-#===================================================#
-#================== FLUIDD STATUS ==================#
-#===================================================#
-
-function get_fluidd_status() {
-  local status
-  local data_arr=("${FLUIDD_DIR}" "${NGINX_SA}/fluidd" "${NGINX_SE}/fluidd")
-
-  ### count+1 for each found data-item from array
-  local filecount=0
-  for data in "${data_arr[@]}"; do
-    [[ -e ${data} ]] && filecount=$(( filecount + 1 ))
-  done
-
-  if (( filecount == ${#data_arr[*]} )); then
-    status="Installed!"
-  elif (( filecount == 0 )); then
-    status="Not installed!"
-  else
-    status="Incomplete!"
-  fi
-  echo "${status}"
-}
-
-function get_local_fluidd_version() {
-  local versionfile="${FLUIDD_DIR}/.version"
-  local relinfofile="${FLUIDD_DIR}/release_info.json"
-  local version
-
-  if [[ -f ${relinfofile} ]]; then
-    version=$(grep -o '"version":"[^"]*' "${relinfofile}" | grep -o '[^"]*$')
-  elif [[ -f ${versionfile} ]]; then
-    version=$(head -n 1 "${versionfile}")
-  fi
-
-  echo "${version}"
-}
-
-function get_remote_fluidd_version() {
-  [[ ! $(dpkg-query -f'${Status}' --show curl 2>/dev/null) = *\ installed ]] && return
-
-  local tags
-  tags=$(curl -s "https://api.github.com/repos/fluidd-core/fluidd/tags" | grep "name" | cut -d'"' -f4)
-  echo "${tags}" | head -1
-}
-
-function compare_fluidd_versions() {
-  local versions local_ver remote_ver
-  local_ver="$(get_local_fluidd_version)"
-  remote_ver="$(get_remote_fluidd_version)"
-
-  if [[ ${local_ver} != "${remote_ver}" && ${local_ver} != "" ]]; then
-    versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
-    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-    # add moonraker to application_updates_available in kiauh.ini
-    add_to_application_updates "fluidd"
-  else
-    versions="${green}$(printf " %-14s" "${local_ver}")${white}"
-    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
-  fi
-
-  echo "${versions}"
-}
-
-#================================================#
-#=================== HELPERS ====================#
-#================================================#
-
-function get_fluidd_download_url() {
-  local releases_by_tag tags tag unstable_url url
-
-  ### latest stable download url
-  url="https://github.com/fluidd-core/fluidd/releases/latest/download/fluidd.zip"
-
-  read_kiauh_ini "${FUNCNAME[0]}"
-  if [[ ${fluidd_install_unstable} == "true" ]]; then
-    releases_by_tag="https://api.github.com/repos/fluidd-core/fluidd/tags"
-    tags=$(curl -s "${releases_by_tag}" | grep "name" | cut -d'"' -f4)
-    tag=$(echo "${tags}" | head -1)
-
-    ### latest unstable download url including pre-releases (alpha, beta, rc)
-    unstable_url="https://github.com/fluidd-core/fluidd/releases/download/${tag}/fluidd.zip"
-
-    if [[ ${unstable_url} == *"download//"* ]]; then
-      warn_msg "Download URL broken! Falling back to URL of latest stable release!"
-    else
-      url=${unstable_url}
-    fi
-  fi
-
-  echo "${url}"
-}
-
-function fluidd_port_check() {
-  if [[ ${FLUIDD_ENABLED} == "false" ]]; then
-
-    if [[ ${SITE_ENABLED} == "true" ]]; then
-      status_msg "Detected other enabled interfaces:"
-
-      [[ ${MAINSAIL_ENABLED} == "true" ]] && \
-      echo "   ${cyan}● Mainsail - Port: ${MAINSAIL_PORT}${white}"
-
-      if [[ ${MAINSAIL_PORT} == "80" ]]; then
-        PORT_80_BLOCKED="true"
-        select_fluidd_port
-      fi
-    else
-      DEFAULT_PORT=$(grep listen "${KIAUH_SRCDIR}/resources/fluidd" | head -1 | sed 's/^\s*//' | cut -d" " -f2 | cut -d";" -f1)
-      SET_LISTEN_PORT=${DEFAULT_PORT}
-    fi
-    SET_NGINX_CFG="true"
-
-  else
-    SET_NGINX_CFG="false"
-  fi
-}
-
-function select_fluidd_port() {
-  if [[ ${PORT_80_BLOCKED} == "true" ]]; then
-    echo
-    top_border
-    echo -e "|                    ${red}!!!WARNING!!!${white}                      |"
-    echo -e "| ${red}You need to choose a different port for Fluidd!${white}       |"
-    echo -e "| ${red}The following web interface is listening at port 80:${white}  |"
-    blank_line
-    [[ ${MAINSAIL_PORT} == "80" ]] && echo "|  ● Mainsail                                           |"
-    blank_line
-    echo -e "| Make sure you don't choose a port which was already   |"
-    echo -e "| assigned to another webinterface!                     |"
-    blank_line
-    echo -e "| Be aware: there is ${red}NO${white} sanity check for the following  |"
-    echo -e "| input. So make sure to choose a valid port!           |"
-    bottom_border
-
-    local new_port re="^[0-9]+$"
-    while true; do
-      read -p "${cyan}Please enter a new Port:${white} " new_port
-      if [[ ${new_port} =~ ${re} && ${new_port} != "${MAINSAIL_PORT}" ]]; then
-        select_msg "Setting port ${new_port} for Fluidd!"
-        SET_LISTEN_PORT=${new_port}
-        break
-      else
-        if [[ ! ${new_port} =~ ${re}  ]]; then
-          error_msg "Invalid input!"
-        else
-          error_msg "Port already taken! Select a different one!"
-        fi
-      fi
-    done
-  fi
-}
-
-function patch_fluidd_update_manager() {
-  local patched moonraker_configs regex
-  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/moonraker\.conf"
-  moonraker_configs=$(find "${HOME}" -maxdepth 3 -type f -regextype posix-extended -regex "${regex}" | sort)
-
-  patched="false"
-  for conf in ${moonraker_configs}; do
-    if ! grep -Eq "^\[update_manager fluidd\]\s*$" "${conf}"; then
-      ### add new line to conf if it doesn't end with one
-      [[ $(tail -c1 "${conf}" | wc -l) -eq 0 ]] && echo "" >> "${conf}"
-
-      ### add Fluidds update manager section to moonraker.conf
-      status_msg "Adding Fluidd to update manager in file:\n       ${conf}"
-      /bin/sh -c "cat >> ${conf}" << MOONRAKER_CONF
-
-[update_manager fluidd]
-type: web
-channel: stable
-repo: fluidd-core/fluidd
-path: ~/fluidd
-MOONRAKER_CONF
-
-    fi
-
-    patched="true"
-  done
-
-  if [[ ${patched} == "true" ]]; then
-    do_action_service "restart" "moonraker"
-  fi
-}
-
-function patch_fluidd_config_update_manager() {
-  local patched moonraker_configs regex
-  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/moonraker\.conf"
-  moonraker_configs=$(find "${HOME}" -maxdepth 3 -type f -regextype posix-extended -regex "${regex}" | sort)
-
-  patched="false"
-  for conf in ${moonraker_configs}; do
-    if ! grep -Eq "^\[update_manager fluidd-config\]\s*$" "${conf}"; then
-      ### add new line to conf if it doesn't end with one
-      [[ $(tail -c1 "${conf}" | wc -l) -eq 0 ]] && echo "" >> "${conf}"
-
-      ### add Fluidds update manager section to moonraker.conf
-      status_msg "Adding Fluidd-Config to update manager in file:\n       ${conf}"
-      /bin/sh -c "cat >> ${conf}" << MOONRAKER_CONF
-
-[update_manager fluidd-config]
-type: git_repo
-primary_branch: master
-path: ~/fluidd-config
-origin: https://github.com/fluidd-core/fluidd-config.git
-managed_services: klipper
-MOONRAKER_CONF
-
-    fi
-
-    patched="true"
-  done
-
-  if [[ ${patched} == "true" ]]; then
-    do_action_service "restart" "moonraker"
-  fi
-}

scripts/gcode_shell_command.sh

@@ -1,123 +0,0 @@
-#!/usr/bin/env bash
-
-#=======================================================================#
-# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>       #
-#                                                                       #
-# This file is part of KIAUH - Klipper Installation And Update Helper   #
-# https://github.com/dw-0/kiauh                                         #
-#                                                                       #
-# This file may be distributed under the terms of the GNU GPLv3 license #
-#=======================================================================#
-
-set -e
-
-#=================================================#
-#======== INSTALL GCODE_SHELL_COMMAND.PY =========#
-#=================================================#
-
-function setup_gcode_shell_command() {
-  top_border
-  echo -e "| You are about to install the 'G-Code Shell Command'   |"
-  echo -e "| extension. Please make sure to read the instructions  |"
-  echo -e "| before you continue and remember that potential risks |"
-  echo -e "| can be involved after installing this extension!      |"
-  blank_line
-  echo -e "| ${red}You accept that you are doing this on your own risk!${white}  |"
-  bottom_border
-
-  local yn
-  while true; do
-    read -p "${cyan}###### Do you want to continue? (Y/n):${white} " yn
-    case "${yn}" in
-      Y|y|Yes|yes|"")
-        select_msg "Yes"
-
-        if [[ ! -d "${KLIPPER_DIR}/klippy/extras" ]]; then
-          print_error "Folder ~/klipper/klippy/extras not found!\n      Klipper not installed yet?"
-          return
-        fi
-
-        status_msg "Installing gcode shell command extension ..."
-
-        if [[ ! -f "${KLIPPER_DIR}/klippy/extras/gcode_shell_command.py" ]]; then
-          install_gcode_shell_command
-        else
-          echo; warn_msg "File 'gcode_shell_command.py' already exists in the destination location!"
-
-          while true; do
-            read -p "${cyan}###### Do you want to overwrite it? (Y/n):${white} " yn
-            case "${yn}" in
-              Y|y|Yes|yes|"")
-                select_msg "Yes"
-                rm -f "${KLIPPER_DIR}/klippy/extras/gcode_shell_command.py"
-                install_gcode_shell_command
-                break;;
-              N|n|No|no)
-                select_msg "No"
-                break;;
-              *)
-                error_msg "Invalid Input!";;
-            esac
-          done
-        fi
-        return;;
-      N|n|No|no)
-        select_msg "No"
-        return;;
-      *)
-        error_msg "Invalid Input!";;
-    esac
-  done
-}
-
-function install_gcode_shell_command() {
-  do_action_service "stop" "klipper"
-  status_msg "Copy 'gcode_shell_command.py' to '${KLIPPER_DIR}/klippy/extras' ..."
-
-  if cp "${KIAUH_SRCDIR}/resources/gcode_shell_command.py" "${KLIPPER_DIR}/klippy/extras"; then
-    ok_msg "Done!"
-  else
-    error_msg "Cannot copy file to target destination...Exiting!"
-    return 1
-  fi
-
-  local yn
-  while true; do
-    echo
-    read -p "${cyan}###### Create an example shell command? (Y/n):${white} " yn
-    case "${yn}" in
-      Y|y|Yes|yes|"")
-        select_msg "Yes"
-        create_example_shell_command
-        break;;
-      N|n|No|no)
-        select_msg "No"
-        break;;
-    esac
-  done
-
-  do_action_service "restart" "klipper"
-  print_confirm "Shell command extension installed!"
-  return
-}
-
-function create_example_shell_command() {
-  ### create a backup of the config folder
-  backup_config_dir
-
-  local configs regex path
-  regex="${HOME//\//\\/}\/([A-Za-z0-9_]+)\/config\/printer\.cfg"
-  configs=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)
-
-  for cfg in ${configs}; do
-    path=$(echo "${cfg}" | rev | cut -d"/" -f2- | rev)
-
-    if [[ ! -f "${path}/shell_command.cfg" ]]; then
-      status_msg "Copy shell_command.cfg to ${path} ..."
-      cp "${KIAUH_SRCDIR}/resources/shell_command.cfg" "${path}"
-      ok_msg "${path}/shell_command.cfg created!"
-      ### write include to the very first line of the printer.cfg
-      sed -i "1 i [include shell_command.cfg]" "${cfg}"
-    fi
-  done
-}