refactor(KIAUH): allow reading ipv6 configured ports with possible default_server suffixes

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

.editorconfig

@@ -1,15 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 4
-insert_final_newline = true
-trim_trailing_whitespace = true
-charset = utf-8
-end_of_line = lf
-
-[*.py]
-max_line_length = 88
-
-[*.{sh,yml,yaml,json,md}]
-indent_size = 2

.github/FUNDING.yml

@@ -9,4 +9,4 @@ community_bridge: # Replace with a single Community Bridge project-name e.g., cl
 liberapay: # Replace with a single Liberapay username
 issuehunt: # Replace with a single IssueHunt username
 otechie: # Replace with a single Otechie username
-custom: https://paypal.me/dwillner0
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/deploy-docs.yml

@@ -1,31 +0,0 @@
-name: Deploy Documentation
-on:
-  workflow_dispatch:
-  push:
-    branches:
-      - docs
-permissions:
-  contents: write
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Configure Git Credentials
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-      - uses: actions/cache@v4
-        with:
-          key: mkdocs-material-${{ env.cache_id }}
-          path: .cache
-          restore-keys: |
-            mkdocs-material-
-      - name: Install dependencies
-        run: pip install -r requirements.txt
-      - name: Build and deploy documentation
-        run: mkdocs gh-deploy --force

.github/workflows/release-ff-and-tag.yml

@@ -1,33 +0,0 @@
-name: Release - Fast-Forward and Tag
-on:
-  workflow_dispatch:
-    inputs:
-      tag_name:
-        description: 'Provide a tag name (e.g. v1.0.0)'
-        required: true
-        type: string
-
-jobs:
-  ff-and-tag:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          ref: 'master'
-      - name: Merge Fast Forward
-        uses: MaximeHeckel/github-action-merge-fast-forward@v1.1.0
-        with:
-          branchtomerge: origin/develop
-          branch: master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Create and Push Tag
-        run: |
-          git tag ${{ inputs.tag_name }}
-          git push origin ${{ inputs.tag_name }}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,13 +1,7 @@
-.idea
 .vscode
+.idea
 .pytest_cache
-.jupyter
-*.ipynb
-*.ipynb_checkpoints
-*.tmp
-__pycache__
 .kiauh-env
 *.code-workspace
 *.iml
 kiauh.cfg
-klipper_repos.txt

.shellcheckrc

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

Dockerfile

@@ -1,6 +0,0 @@
-FROM squidfunk/mkdocs-material:latest
-
-# Install additional plugins required by our mkdocs configuration
-RUN pip install \
-    mkdocs-git-revision-date-localized-plugin \
-    mkdocstrings[python]

README.md

@@ -28,23 +28,23 @@
 
 ### 📋 Prerequisites
 KIAUH is a script that assists you in installing Klipper on a Linux operating system that has
-already been flashed to your Raspberry Pi's (or other SBC's) SD card. As a result, you must ensure
-that you have a functional Linux system on hand. `Raspberry Pi OS Lite (either 32bit or 64bit)` is a recommended Linux image
-if you are using a Raspberry Pi. The [official Raspberry Pi Imager](https://www.raspberrypi.com/software/)
+already been flashed to your Raspberry Pi's (or other SBC's) SD card. As a result, you must ensure 
+that you have a functional Linux system on hand. `Raspberry Pi OS Lite (32bit)` is a recommended Linux image 
+if you are using a Raspberry Pi. The [official Raspberry Pi Imager](https://www.raspberrypi.com/software/) 
 is the simplest way to flash an image like this to an SD card.
 
-* Once you have downloaded, installed and launched the Raspberry Pi Imager,
+* Once you have downloaded, installed and launched the Raspberry Pi Imager, 
 select `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>
 
-* Then select `Raspberry Pi OS Lite (32bit)` (or 64bit if you want to use that instead):
+* Then select `Raspberry Pi OS Lite (32bit)`:
 <p align="center">
   <img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager2.png" alt="KIAUH logo" height="350">
 </p>
 
-* Back in the Raspberry Pi Imager's main menu, select the corresponding SD card to which
+* Back in the Raspberry Pi Imager's main menu, select the corresponding SD card to which 
 you want to flash the image.
 
 * Make sure to go into the Advanced Option (the cog icon in the lower left corner of the main menu)
@@ -52,9 +52,9 @@ and enable SSH and configure Wi-Fi.
 
 * If you need more help for using the Raspberry Pi Imager, please visit the [official documentation](https://www.raspberrypi.com/documentation/computers/getting-started.html).
 
-These steps **only** apply if you are actually using a Raspberry Pi. In case you want
-to use a different SBC (like an Orange Pi or any other Pi derivates), please look up on how to get an appropriate Linux image flashed
-to the SD card before proceeding further (usually done with Balena Etcher in those cases). Also make sure that KIAUH will be able to run
+These steps **only** apply if you are actually using a Raspberry Pi. In case you want 
+to use a different SBC (like an Orange Pi or any other Pi derivates), please look up on how to get an appropriate Linux image flashed 
+to the SD card before proceeding further (usually done with Balena Etcher in those cases). Also make sure that KIAUH will be able to run 
 and operate on the Linux Distribution you are going to flash. You likely will have the most success with
 distributions based on Debian 11 Bullseye. Read the notes further down below in this document.
 
@@ -82,8 +82,8 @@ Finally, start KIAUH by running the next command:
 ```
 
 * **Step 4:** \
-You should now find yourself in the main menu of KIAUH. You will see several actions to choose from depending
-on what you want to do. To choose an action, simply type the corresponding number into the "Perform action"
+You should now find yourself in the main menu of KIAUH. You will see several actions to choose from depending 
+on what you want to do. To choose an action, simply type the corresponding number into the "Perform action" 
 prompt and confirm by hitting ENTER.
 
 <hr>
@@ -101,103 +101,79 @@ prompt and confirm by hitting ENTER.
 
 <h2 align="center">🌐 Sources & Further Information</h2>
 
-<table align="center">
+<table>
 <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>
+<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>
+<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>by <a href="https://github.com/KevinOConnor">KevinOConnor</a></th>
-    <th>by <a href="https://github.com/Arksine">Arksine</a></th>
-    <th>by <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
+<th>by <a href="https://github.com/KevinOConnor">KevinOConnor</a></th>
+<th>by <a href="https://github.com/Arksine">Arksine</a></th>
+<th>by <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://camo.githubusercontent.com/627be7fc67195b626b298af9b9677d7c58e698c67305e54324cffbe06130d4a4/68747470733a2f2f6f63746f7072696e742e6f72672f6173736574732f696d672f6c6f676f2e706e67" alt="OctoPrint Logo" height="64"></th>
+</tr>
+<tr>
+<th>by <a href="https://github.com/fluidd-core">fluidd-core</a></th>
+<th>by <a href="https://github.com/jordanruthe">jordanruthe</a></th>
+<th>by <a href="https://github.com/OctoPrint">OctoPrint</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>by <a href="https://github.com/fluidd-core">fluidd-core</a></th>
-    <th>by <a href="https://github.com/jordanruthe">jordanruthe</a></th>
-    <th>by <a href="https://github.com/OctoPrint">OctoPrint</a></th>
+<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><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>by <a href="https://github.com/nlef">nlef</a></th>
-    <th>by <a href="https://github.com/Kragrathea">Kragrathea</a></th>
-    <th>by <a href="https://github.com/TheSpaghettiDetective">Obico</a></th>
+<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><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>by <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
-    <th>by <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
-    <th>by <a href="https://github.com/crysxd">Christian Würthner</a></th>
+<th>by <a href="https://github.com/nlef">nlef</a></th>
+<th>by <a href="https://github.com/Kragrathea">Kragrathea</a></th>
+<th>by <a href="https://github.com/TheSpaghettiDetective">Obico</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>
+<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></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>
+<th><a href="https://github.com/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="OctoEverywhere Logo" height="64"></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></th>
 </tr>
+
 <tr>
-    <th>by <a href="https://github.com/Staubgeborener">Staubgeborener</a></th>
-    <th>by <a href="https://github.com/SimplyPrint">SimplyPrint</a></th>
+<th>by <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
+<th>by <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
+<th></th>
 </tr>
+
+
 </table>
 
 <hr>
 
-<h2 align="center">🎖️ Contributors 🎖️</h2>
-
-<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>
-
-<hr>
-
-<div align="center">
-    <img src="https://repobeats.axiom.co/api/embed/a1afbda9190c04a90cf4bd3061e5573bc836cb05.svg" alt="Repobeats analytics image"/>
-</div>
-
-<hr>
-
 <h2 align="center">✨ Credits ✨</h2>
 
 * A big thank you to [lixxbox](https://github.com/lixxbox) for that awesome KIAUH-Logo!

README_zh.md

@@ -1,206 +0,0 @@
-# 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>

default.kiauh.cfg

@@ -1,36 +0,0 @@
-[kiauh]
-backup_before_update: False
-
-[klipper]
-# add custom repositories here, if at least one is given, the first in the list will be used by default
-# otherwise the official repository is used
-#
-# format: https://github.com/username/repository, branch
-# example: https://github.com/Klipper3d/klipper, master
-#
-# branch is optional, if given, it must be preceded by a comma, if not given, 'master' is used
-repositories:
-    https://github.com/Klipper3d/klipper
-
-[moonraker]
-# Moonraker supports two optional Python packages that can be used to reduce its CPU load
-# If set to true, those packages will be installed during the Moonraker installation
-optional_speedups: True
-
-# add custom repositories here, if at least one is given, the first in the list will be used by default
-# otherwise the official repository is used
-#
-# format: https://github.com/username/repository, branch
-# example: https://github.com/Arksine/moonraker, master
-#
-# branch is optional, if given, it must be preceded by a comma, if not given, 'master' is used
-repositories:
-    https://github.com/Arksine/moonraker
-
-[mainsail]
-port: 80
-unstable_releases: False
-
-[fluidd]
-port: 80
-unstable_releases: False

docker-compose.yml

@@ -1,8 +0,0 @@
-services:
-  mkdocs:
-    build: .
-    ports:
-      - "8000:8000"
-    volumes:
-      - ./:/docs
-    command: serve --dev-addr=0.0.0.0:8000

docs/changelog.md

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

docs/extensions/index.md

@@ -1 +0,0 @@
-# Community Extensions

docs/index.md

@@ -1,23 +0,0 @@
-!!! tip "Important"
-    This documentation is for KIAUH version 6 and still work in progress!
-
-<h1 align="center">
-  KIAUH - Klipper Installation And Update Helper
-</h1>
-
-<p align="center">
-  <img src="assets/logo-large.png" alt="KIAUH logo" width="400"/>
-</p>
-<p align="center" style="font-size: 1.2em; font-weight: bold;">
-  A handy installation script that makes installing Klipper (and more) a breeze!
-</p>
-
-
-## Features
-
-- Easy installation of Klipper and related components
-- Support for multiple instances
-- Extension system for additional functionality
-- Configuration management
-- And more!
-

docs/setup/installation.md

@@ -1,39 +0,0 @@
-# Installing KIAUH
-
-In the following sections, you will be guided through the installation
-process step-by-step.
-
-To use KIAUH, it is enough to download the script and run it on your
-Raspberry Pi or other compatible device. If you need to know how to
-set up a Raspberry Pi or if you are unsure whether your current setup
-is sufficient, please refer to the [Raspberry Pi Installation Guide](raspberry-pi-setup.md)
-and follow the steps therein. Afterwards, you can return to this guide to install KIAUH.
-
-### Prerequisites
-Before you can download and run KIAUH, you need to ensure that ``git`` is
-installed on your system. Open a terminal and run the following command:
-
-```bash
-sudo apt-get update && sudo apt-get install git -y
-```
-
-### Downloading KIAUH
-After `git` was successfully installed, you can download KIAUH by
-cloning the repository from GitHub. It is recommended to clone it into
-your home directory. Run the following command in your terminal:
-```bash
-cd ~ && git clone https://github.com/dw-0/kiauh.git
-```
-
-### Running KIAUH
-Once the repository is cloned, you can start KIAUH. Make sure you are in
-your home directory and execute the script by running the following
-command:
-```bash
-./kiauh/kiauh.sh
-```
-
-After executing the command, you will be presented with the KIAUH menu,
-which allows you to install and manage various 3D printing software.
-For more information on how to use KIAUH, please refer to the
-[Usage Guide](usage.md).

docs/setup/raspberry-pi-setup.md

@@ -1,49 +0,0 @@
-# Raspberry Pi Setup
-
-This guide will help you set up a Raspberry Pi for running Klipper and other,
-Klipper related 3D printing software. In case you are using a different single-board
-computer (SBC), please refer to the manufacturer's instructions for installing
-a compatible version of Linux on your device.
-
-It is assumed that you have at least a Raspberry Pi 3 or newer, along with a
-microSD card (at least 8GB, preferably 16GB or more) and a power supply.
-Additionally, you will need a computer with an SD card reader to prepare
-the microSD card.
-
-KIAUH requires a Linux operating system that has already been flashed to your
-Raspberry Pi's (or other SBC's) microSD card. As a result, you must ensure that you
-already have a functional Linux system on hand before you can proceed with
-installing KIAUH. `Raspberry Pi OS Lite` (either 32bit or 64bit) is a recommended Linux image
-if you are using a Raspberry Pi.
-
----
-
-To flash `Raspberry Pi OS Lite` to your microSD card using the official [Raspberry Pi Imager](https://www.raspberrypi.com/software/),
-follow the steps below. If you encounter any issues or need further assistance, please refer to the [official Raspberry Pi documentation](https://www.raspberrypi.com/documentation/computers/getting-started.html).
-
-1. Open the Raspberry Pi Imager application on your computer.
-2. Click on `Choose OS` and select `Raspberry Pi OS (other)`.
-   ![OS selection](https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager1.png)
-3. Choose `Raspberry Pi OS Lite (32bit)` (or 64bit if desired).
-   ![Lite selection](https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager2.png)
-4. Insert the microSD card into your computer's SD card reader.
-5. In the main menu of the Imager, select the correct microSD card.
-6. Click the gear icon at the bottom left of the main menu to open advanced options.
-7. Enable SSH and enter your Wi-Fi credentials.
-
-    !!! info
-        Wi-Fi is only necessary if you want to connect to your Raspberry Pi over a wireless network. If you plan to use a wired Ethernet connection, you can skip this step. SSH is required for remote access to your Raspberry Pi, so make sure to enable it.
-
-8. Click `Save` to close the advanced options menu.
-9. Click `Write` to start flashing the image to the microSD card.
-
-    !!! warning
-        All data on the microSD card will be overwritten!
-
-10. Once the flashing process is complete, safely eject the microSD card from your computer.
-11. Insert the microSD card into your Raspberry Pi.
-12. Connect your Raspberry Pi to a power source to boot it up.
-13. Wait for a few minutes to allow the Raspberry Pi to complete its initial setup.
-14. You can now connect to your Raspberry Pi via SSH using the IP address assigned by your router. The default username is `pi` and the default password is `raspberry`.
-
-If you successfully connected to your Raspberry Pi via SSH, you can proceed to install KIAUH by following the instructions in the [Installation Guide](installation.md).

kiauh.cfg.example

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

kiauh.py

@@ -1,5 +1,7 @@
+#!/usr/bin/env python3
+
 # ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#  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                                          #
@@ -7,6 +9,7 @@
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
 
-from components.klipper import KLIPPER_DIR
+from kiauh.main import main
 
-SD_FLASH_SCRIPT = KLIPPER_DIR.joinpath("scripts/flash-sdcard.sh")
+if __name__ == "__main__":
+    main()

kiauh.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 #=======================================================================#
-# Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>       #
+# Copyright (C) 2020 - 2023 Dominik Willner <th33xitus@gmail.com>       #
 #                                                                       #
 # This file is part of KIAUH - Klipper Installation And Update Helper   #
 # https://github.com/dw-0/kiauh                                         #
@@ -10,121 +10,99 @@
 #=======================================================================#
 
 set -e
-clear -x
-
-# make sure we have the correct permissions while running the script
-umask 022
-
-#===================================================#
-#=================== UPDATE KIAUH ==================#
-#===================================================#
-
-function update_kiauh() {
-  status_msg "Updating KIAUH ..."
-
-  cd "${KIAUH_SRCDIR}"
-  git reset --hard && git pull
-
-  ok_msg "Update complete! Please restart KIAUH."
-  exit 0
-}
-
-#===================================================#
-#=================== KIAUH STATUS ==================#
-#===================================================#
-
-function kiauh_update_avail() {
-  [[ ! -d "${KIAUH_SRCDIR}/.git" ]] && return
-  local origin head
-
-  cd "${KIAUH_SRCDIR}"
-
-  ### abort if not on master branch
-  ! git branch -a | grep -q "\* master" && return
-
-  ### compare commit hash
-  git fetch -q
-  origin=$(git rev-parse --short=8 origin/master)
-  head=$(git rev-parse --short=8 HEAD)
-
-  if [[ ${origin} != "${head}" ]]; then
-    echo "true"
-  fi
-}
-
-function kiauh_update_dialog() {
-  [[ ! $(kiauh_update_avail) == "true" ]] && return
-  top_border
-  echo -e "|${green}              New KIAUH update available!              ${white}|"
-  hr
-  echo -e "|${green}  View Changelog: https://git.io/JnmlX                 ${white}|"
-  blank_line
-  echo -e "|${yellow}  It is recommended to keep KIAUH up to date. Updates  ${white}|"
-  echo -e "|${yellow}  usually contain bugfixes, important changes or new   ${white}|"
-  echo -e "|${yellow}  features. Please consider updating!                  ${white}|"
-  bottom_border
-
-  local yn
-  read -p "${cyan}###### Do you want to update now? (Y/n):${white} " yn
-  while true; do
-    case "${yn}" in
-     Y|y|Yes|yes|"")
-       do_action "update_kiauh"
-       break;;
-     N|n|No|no)
-       break;;
-     *)
-       deny_action "kiauh_update_dialog";;
-    esac
-  done
-}
-
-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
-}
-
-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
-}
+clear
 
 function main() {
-   local entrypoint
+  local python_command
+  local entrypoint
 
-   if ! command -v python3 &>/dev/null || [[ $(python3 -V | cut -d " " -f2 | cut -d "." -f2) -lt 8 ]]; then
-     echo "Python 3.8 or higher is not installed!"
-     echo "Please install Python 3.8 or higher and try again."
-     exit 1
-   fi
+  if command -v python3 &>/dev/null; then
+    python_command="python3"
+  elif command -v python &>/dev/null; then
+    python_command="python"
+  else
+    echo "Python is not installed. Please install Python and try again."
+    exit 1
+  fi
 
-   entrypoint=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
+  entrypoint=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
 
-   export PYTHONPATH="${entrypoint}"
-
-   clear -x
-   python3 "${entrypoint}/kiauh/main.py"
+  ${python_command} "${entrypoint}/kiauh.py"
 }
 
-check_if_ratos
-check_euid
-kiauh_update_dialog
 main
+
+#### sourcing all additional scripts
+#KIAUH_SRCDIR="$(dirname -- "$(readlink -f "${BASH_SOURCE[0]}")")"
+#for script in "${KIAUH_SRCDIR}/scripts/"*.sh; do . "${script}"; done
+#for script in "${KIAUH_SRCDIR}/scripts/ui/"*.sh; do . "${script}"; done
+#
+##===================================================#
+##=================== UPDATE KIAUH ==================#
+##===================================================#
+#
+#function update_kiauh() {
+#  status_msg "Updating KIAUH ..."
+#
+#  cd "${KIAUH_SRCDIR}"
+#  git reset --hard && git pull
+#
+#  ok_msg "Update complete! Please restart KIAUH."
+#  exit 0
+#}
+#
+##===================================================#
+##=================== KIAUH STATUS ==================#
+##===================================================#
+#
+#function kiauh_update_avail() {
+#  [[ ! -d "${KIAUH_SRCDIR}/.git" ]] && return
+#  local origin head
+#
+#  cd "${KIAUH_SRCDIR}"
+#
+#  ### abort if not on master branch
+#  ! git branch -a | grep -q "\* master" && return
+#
+#  ### compare commit hash
+#  git fetch -q
+#  origin=$(git rev-parse --short=8 origin/master)
+#  head=$(git rev-parse --short=8 HEAD)
+#
+#  if [[ ${origin} != "${head}" ]]; then
+#    echo "true"
+#  fi
+#}
+#
+#function kiauh_update_dialog() {
+#  [[ ! $(kiauh_update_avail) == "true" ]] && return
+#  top_border
+#  echo -e "|${green}              New KIAUH update available!              ${white}|"
+#  hr
+#  echo -e "|${green}  View Changelog: https://git.io/JnmlX                 ${white}|"
+#  blank_line
+#  echo -e "|${yellow}  It is recommended to keep KIAUH up to date. Updates  ${white}|"
+#  echo -e "|${yellow}  usually contain bugfixes, important changes or new   ${white}|"
+#  echo -e "|${yellow}  features. Please consider updating!                  ${white}|"
+#  bottom_border
+#
+#  local yn
+#  read -p "${cyan}###### Do you want to update now? (Y/n):${white} " yn
+#  while true; do
+#    case "${yn}" in
+#      Y|y|Yes|yes|"")
+#        do_action "update_kiauh"
+#        break;;
+#      N|n|No|no)
+#        break;;
+#      *)
+#        deny_action "kiauh_update_dialog";;
+#    esac
+#  done
+#}
+#
+#check_euid
+#init_logfile
+#set_globals
+#kiauh_update_dialog
+#main_menu

kiauh/__init__.py

@@ -1,5 +1,7 @@
+#!/usr/bin/env python3
+
 # ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#  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                                          #
@@ -11,5 +13,7 @@ import sys
 from pathlib import Path
 
 PROJECT_ROOT = Path(__file__).resolve().parent.parent
+KIAUH_CFG = PROJECT_ROOT.joinpath("kiauh.cfg")
+
 APPLICATION_ROOT = Path(__file__).resolve().parent
 sys.path.append(str(APPLICATION_ROOT))

kiauh/components/crowsnest/__init__.py

@@ -1,28 +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 pathlib import Path
-
-from core.constants import SYSTEMD
-
-# repo
-CROWSNEST_REPO = "https://github.com/mainsail-crew/crowsnest.git"
-
-# names
-CROWSNEST_SERVICE_NAME = "crowsnest.service"
-
-# directories
-CROWSNEST_DIR = Path.home().joinpath("crowsnest")
-
-# files
-CROWSNEST_MULTI_CONFIG = CROWSNEST_DIR.joinpath("tools/.config")
-CROWSNEST_INSTALL_SCRIPT = CROWSNEST_DIR.joinpath("tools/install.sh")
-CROWSNEST_BIN_FILE = Path("/usr/local/bin/crowsnest")
-CROWSNEST_LOGROTATE_FILE = Path("/etc/logrotate.d/crowsnest")
-CROWSNEST_SERVICE_FILE = SYSTEMD.joinpath(CROWSNEST_SERVICE_NAME)

kiauh/components/crowsnest/crowsnest.py

@@ -1,176 +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
-import time
-from pathlib import Path
-from subprocess import CalledProcessError, run
-from typing import List
-
-from components.crowsnest import (
-    CROWSNEST_BIN_FILE,
-    CROWSNEST_DIR,
-    CROWSNEST_INSTALL_SCRIPT,
-    CROWSNEST_LOGROTATE_FILE,
-    CROWSNEST_MULTI_CONFIG,
-    CROWSNEST_REPO,
-    CROWSNEST_SERVICE_FILE,
-    CROWSNEST_SERVICE_NAME,
-)
-from components.klipper.klipper import Klipper
-from core.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 (
-    check_install_dependencies,
-    get_install_status,
-)
-from utils.git_utils import (
-    git_clone_wrapper,
-    git_pull_wrapper,
-)
-from utils.input_utils import get_confirm
-from utils.instance_utils import get_instances
-from utils.sys_utils import (
-    cmd_sysctl_service,
-    parse_packages_from_file,
-)
-
-
-def install_crowsnest() -> None:
-    # Step 1: Clone crowsnest repo
-    git_clone_wrapper(CROWSNEST_REPO, CROWSNEST_DIR, "master")
-
-    # Step 2: Install dependencies
-    check_install_dependencies({"make"})
-
-    # Step 3: Check for Multi Instance
-    instances: List[Klipper] = get_instances(Klipper)
-
-    if len(instances) > 1:
-        print_multi_instance_warning(instances)
-
-        if not get_confirm("Do you want to continue with the installation?"):
-            Logger.print_info("Crowsnest installation aborted!")
-            return
-
-        Logger.print_status("Launching crowsnest's install configurator ...")
-        time.sleep(3)
-        configure_multi_instance()
-
-    # Step 4: Launch crowsnest installer
-    Logger.print_status("Launching crowsnest installer ...")
-    Logger.print_info("Installer will prompt you for sudo password!")
-    try:
-        run(
-            "sudo make install",
-            cwd=CROWSNEST_DIR,
-            shell=True,
-            check=True,
-        )
-    except CalledProcessError as e:
-        Logger.print_error(f"Something went wrong! Please try again...\n{e}")
-        return
-
-
-def print_multi_instance_warning(instances: List[Klipper]) -> None:
-    Logger.print_dialog(
-        DialogType.WARNING,
-        [
-            "Multi instance install detected!",
-            "\n\n",
-            "Crowsnest is NOT designed to support multi instances. A workaround "
-            "for this is to choose the most used instance as a 'master' and use "
-            "this instance to set up your 'crowsnest.conf' and steering it's service.",
-            "\n\n",
-            "The following instances were found:",
-            *[f"● {instance.data_dir.name}" for instance in instances],
-        ],
-    )
-
-
-def configure_multi_instance() -> None:
-    try:
-        run(
-            "make config",
-            cwd=CROWSNEST_DIR,
-            shell=True,
-            check=True,
-        )
-    except CalledProcessError as e:
-        Logger.print_error(f"Something went wrong! Please try again...\n{e}")
-        if CROWSNEST_MULTI_CONFIG.exists():
-            Path.unlink(CROWSNEST_MULTI_CONFIG)
-        return
-
-    if not CROWSNEST_MULTI_CONFIG.exists():
-        Logger.print_error("Generating .config failed, installation aborted")
-
-
-def update_crowsnest() -> None:
-    try:
-        cmd_sysctl_service(CROWSNEST_SERVICE_NAME, "stop")
-
-        if not CROWSNEST_DIR.exists():
-            git_clone_wrapper(CROWSNEST_REPO, CROWSNEST_DIR, "master")
-        else:
-            Logger.print_status("Updating Crowsnest ...")
-
-            settings = KiauhSettings()
-            if settings.kiauh.backup_before_update:
-                svc = BackupService()
-                svc.backup_directory(
-                    source_path=CROWSNEST_DIR,
-                    target_path="crowsnest",
-                    backup_name="crowsnest",
-                )
-
-            git_pull_wrapper(CROWSNEST_DIR)
-
-            deps = parse_packages_from_file(CROWSNEST_INSTALL_SCRIPT)
-            check_install_dependencies({*deps})
-
-        cmd_sysctl_service(CROWSNEST_SERVICE_NAME, "restart")
-
-        Logger.print_ok("Crowsnest updated successfully.", end="\n\n")
-    except CalledProcessError as e:
-        Logger.print_error(f"Something went wrong! Please try again...\n{e}")
-        return
-
-
-def get_crowsnest_status() -> ComponentStatus:
-    files = [
-        CROWSNEST_BIN_FILE,
-        CROWSNEST_LOGROTATE_FILE,
-        CROWSNEST_SERVICE_FILE,
-    ]
-    return get_install_status(CROWSNEST_DIR, files=files)
-
-
-def remove_crowsnest() -> None:
-    if not CROWSNEST_DIR.exists():
-        Logger.print_info("Crowsnest does not seem to be installed! Skipping ...")
-        return
-
-    try:
-        run(
-            "make uninstall",
-            cwd=CROWSNEST_DIR,
-            shell=True,
-            check=True,
-        )
-    except CalledProcessError as e:
-        Logger.print_error(f"Something went wrong! Please try again...\n{e}")
-        return
-
-    Logger.print_status("Removing crowsnest directory ...")
-    shutil.rmtree(CROWSNEST_DIR)
-    Logger.print_ok("Directory removed!")

kiauh/components/fluidd/__init__.py

@@ -0,0 +1,26 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+
+from core.backup_manager import BACKUP_ROOT_DIR
+
+MODULE_PATH = Path(__file__).resolve().parent
+FLUIDD_DIR = Path.home().joinpath("fluidd")
+FLUIDD_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("fluidd-backups")
+FLUIDD_CONFIG_DIR = Path.home().joinpath("fluidd-config")
+FLUIDD_NGINX_CFG = Path("/etc/nginx/sites-enabled/fluidd")
+FLUIDD_URL = "https://github.com/fluidd-core/fluidd/releases/latest/download/fluidd.zip"
+FLUIDD_UNSTABLE_URL = (
+    "https://github.com/fluidd-core/fluidd/releases/download/%TAG%/fluidd.zip"
+)
+FLUIDD_CONFIG_REPO_URL = "https://github.com/fluidd-core/fluidd-config.git"
+

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

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

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

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

kiauh/components/fluidd/fluidd_dialogs.py

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

kiauh/components/fluidd/fluidd_remove.py

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

kiauh/components/fluidd/fluidd_setup.py

@@ -0,0 +1,242 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import subprocess
+from pathlib import Path
+from typing import List
+
+from components.fluidd import (
+    FLUIDD_URL,
+    FLUIDD_CONFIG_REPO_URL,
+    FLUIDD_CONFIG_DIR,
+    FLUIDD_DIR,
+    MODULE_PATH,
+)
+from components.fluidd.fluidd_dialogs import (
+    print_fluidd_already_installed_dialog,
+    print_install_fluidd_config_dialog,
+    print_fluidd_port_select_dialog,
+    print_moonraker_not_found_dialog,
+)
+from components.fluidd.fluidd_utils import symlink_webui_nginx_log
+from kiauh import KIAUH_CFG
+from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from core.config_manager.config_manager import ConfigManager
+from core.instance_manager.instance_manager import InstanceManager
+from core.repo_manager.repo_manager import RepoManager
+from utils import NGINX_SITES_AVAILABLE, NGINX_SITES_ENABLED
+from utils.common import check_install_dependencies
+from utils.filesystem_utils import (
+    unzip,
+    copy_upstream_nginx_cfg,
+    copy_common_vars_nginx_cfg,
+    create_nginx_cfg,
+    create_symlink,
+    remove_file,
+    read_ports_from_nginx_configs,
+    get_next_free_port, is_valid_port,
+    )
+from utils.input_utils import get_confirm, get_number_input
+from utils.logger import Logger
+from utils.system_utils import (
+    download_file,
+    set_nginx_permissions,
+    get_ipv4_addr,
+    control_systemd_service,
+)
+
+
+def install_fluidd() -> None:
+    mr_im = InstanceManager(Moonraker)
+    mr_instances: List[Moonraker] = mr_im.instances
+
+    if not mr_instances:
+        print_moonraker_not_found_dialog()
+        if not get_confirm("Continue Fluidd installation?", allow_go_back=True):
+            return
+
+    if Path.home().joinpath("fluidd").exists():
+        print_fluidd_already_installed_dialog()
+        do_reinstall = get_confirm("Re-install Fluidd?", allow_go_back=True)
+        if not do_reinstall:
+            return
+
+    kl_im = InstanceManager(Klipper)
+    kl_instances = kl_im.instances
+    install_fl_config = False
+    if kl_instances:
+        print_install_fluidd_config_dialog()
+        question = "Download the recommended macros?"
+        install_fl_config = get_confirm(question, allow_go_back=False)
+
+    cm = ConfigManager(cfg_file=KIAUH_CFG)
+    fluidd_port = cm.get_value("fluidd", "port")
+    ports_in_use = read_ports_from_nginx_configs()
+
+    # check if configured port is a valid number and not in use already
+    valid_port = is_valid_port(fluidd_port, ports_in_use)
+    while not valid_port:
+        next_port = get_next_free_port(ports_in_use)
+        print_fluidd_port_select_dialog(next_port, ports_in_use)
+        fluidd_port = str(get_number_input(
+            "Configure Fluidd for port",
+            min_count=int(next_port),
+            default=next_port,
+        ))
+        valid_port = is_valid_port(fluidd_port, ports_in_use)
+
+    check_install_dependencies(["nginx"])
+
+    try:
+        download_fluidd()
+        if mr_instances:
+            patch_moonraker_conf(
+                mr_instances,
+                "Fluidd",
+                "update_manager fluidd",
+                "fluidd-updater.conf",
+            )
+            mr_im.restart_all_instance()
+        if install_fl_config and kl_instances:
+            download_fluidd_cfg()
+            create_fluidd_cfg_symlink(kl_instances)
+            patch_moonraker_conf(
+                mr_instances,
+                "fluidd-config",
+                "update_manager fluidd-config",
+                "fluidd-config-updater.conf",
+            )
+            patch_printer_config(kl_instances)
+            kl_im.restart_all_instance()
+
+        copy_upstream_nginx_cfg()
+        copy_common_vars_nginx_cfg()
+        create_fluidd_nginx_cfg(fluidd_port)
+        if kl_instances:
+            symlink_webui_nginx_log(kl_instances)
+        control_systemd_service("nginx", "restart")
+
+    except Exception as e:
+        Logger.print_error(f"Fluidd installation failed!\n{e}")
+        return
+
+    log = f"Open Fluidd now on: http://{get_ipv4_addr()}:{fluidd_port}"
+    Logger.print_ok("Fluidd installation complete!", start="\n")
+    Logger.print_ok(log, prefix=False, end="\n\n")
+
+
+def download_fluidd() -> None:
+    try:
+        Logger.print_status("Downloading Fluidd ...")
+        target = Path.home().joinpath("fluidd.zip")
+        download_file(FLUIDD_URL, target, True)
+        Logger.print_ok("Download complete!")
+
+        Logger.print_status("Extracting fluidd.zip ...")
+        unzip(Path.home().joinpath("fluidd.zip"), FLUIDD_DIR)
+        target.unlink(missing_ok=True)
+        Logger.print_ok("OK!")
+
+    except Exception:
+        Logger.print_error("Downloading Fluidd failed!")
+        raise
+
+
+def update_fluidd() -> None:
+    Logger.print_status("Updating Fluidd ...")
+    download_fluidd()
+
+
+def download_fluidd_cfg() -> None:
+    try:
+        Logger.print_status("Downloading fluidd-config ...")
+        rm = RepoManager(FLUIDD_CONFIG_REPO_URL, target_dir=FLUIDD_CONFIG_DIR)
+        rm.clone_repo()
+    except Exception:
+        Logger.print_error("Downloading fluidd-config failed!")
+        raise
+
+
+def create_fluidd_cfg_symlink(klipper_instances: List[Klipper]) -> None:
+    Logger.print_status("Create symlink of fluidd.cfg ...")
+    source = Path(FLUIDD_CONFIG_DIR, "fluidd.cfg")
+    for instance in klipper_instances:
+        target = instance.cfg_dir
+        Logger.print_status(f"Linking {source} to {target}")
+        try:
+            create_symlink(source, target)
+        except subprocess.CalledProcessError:
+            Logger.print_error("Creating symlink failed!")
+
+
+def create_fluidd_nginx_cfg(port: int) -> None:
+    root_dir = FLUIDD_DIR
+    source = NGINX_SITES_AVAILABLE.joinpath("fluidd")
+    target = NGINX_SITES_ENABLED.joinpath("fluidd")
+    try:
+        Logger.print_status("Creating NGINX config for Fluidd ...")
+        remove_file(Path("/etc/nginx/sites-enabled/default"), True)
+        create_nginx_cfg("fluidd", port, root_dir)
+        create_symlink(source, target, True)
+        set_nginx_permissions()
+        Logger.print_ok("NGINX config for Fluidd successfully created.")
+    except Exception:
+        Logger.print_error("Creating NGINX config for Fluidd failed!")
+        raise
+
+
+# TODO: could be fully extracted, its webui agnostic, and used for mainsail and fluidd
+def patch_moonraker_conf(
+    moonraker_instances: List[Moonraker],
+    name: str,
+    section_name: str,
+    template_file: str,
+) -> None:
+    for instance in moonraker_instances:
+        cfg_file = instance.cfg_file
+        Logger.print_status(f"Add {name} update section to '{cfg_file}' ...")
+
+        if not Path(cfg_file).exists():
+            Logger.print_warn(f"'{cfg_file}' not found!")
+            return
+
+        cm = ConfigManager(cfg_file)
+        if cm.config.has_section(section_name):
+            Logger.print_info("Section already exist. Skipped ...")
+            return
+
+        template = MODULE_PATH.joinpath("assets", template_file)
+        with open(template, "r") as t:
+            template_content = "\n"
+            template_content += t.read()
+
+        with open(cfg_file, "a") as f:
+            f.write(template_content)
+
+
+# TODO: could be made fully webui agnostic and extracted, and used for mainsail and fluidd
+def patch_printer_config(klipper_instances: List[Klipper]) -> None:
+    for instance in klipper_instances:
+        cfg_file = instance.cfg_file
+        Logger.print_status(f"Including fluidd-config in '{cfg_file}' ...")
+
+        if not Path(cfg_file).exists():
+            Logger.print_warn(f"'{cfg_file}' not found!")
+            return
+
+        cm = ConfigManager(cfg_file)
+        if cm.config.has_section("include fluidd.cfg"):
+            Logger.print_info("Section already exist. Skipped ...")
+            return
+
+        with open(cfg_file, "a") as f:
+            f.write("\n[include fluidd.cfg]")

kiauh/components/fluidd/fluidd_utils.py

@@ -0,0 +1,79 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import json
+import urllib.request
+from json import JSONDecodeError
+from pathlib import Path
+from typing import List
+
+from components.fluidd import FLUIDD_DIR, FLUIDD_BACKUP_DIR
+from components.klipper.klipper import Klipper
+from core.backup_manager.backup_manager import BackupManager
+from utils import NGINX_SITES_AVAILABLE, NGINX_CONFD
+from utils.common import get_install_status_webui
+from utils.logger import Logger
+
+
+# TODO: could be extracted and made generic
+def get_fluidd_status() -> str:
+    return get_install_status_webui(
+        FLUIDD_DIR,
+        NGINX_SITES_AVAILABLE.joinpath("fluidd"),
+        NGINX_CONFD.joinpath("upstreams.conf"),
+        NGINX_CONFD.joinpath("common_vars.conf"),
+    )
+
+
+# TODO: could be extracted and made generic
+def symlink_webui_nginx_log(klipper_instances: List[Klipper]) -> None:
+    Logger.print_status("Link NGINX logs into log directory ...")
+    access_log = Path("/var/log/nginx/fluidd-access.log")
+    error_log = Path("/var/log/nginx/fluidd-error.log")
+
+    for instance in klipper_instances:
+        desti_access = instance.log_dir.joinpath("fluidd-access.log")
+        if not desti_access.exists():
+            desti_access.symlink_to(access_log)
+
+        desti_error = instance.log_dir.joinpath("fluidd-error.log")
+        if not desti_error.exists():
+            desti_error.symlink_to(error_log)
+
+
+# TODO: could be extracted and made generic
+def get_fluidd_local_version() -> str:
+    relinfo_file = FLUIDD_DIR.joinpath("release_info.json")
+    if not relinfo_file.is_file():
+        return "-"
+
+    with open(relinfo_file, "r") as f:
+        return json.load(f)["version"]
+
+
+# TODO: could be extracted and made generic
+def get_fluidd_remote_version() -> str:
+    url = "https://api.github.com/repos/fluidd-core/fluidd/tags"
+    try:
+        with urllib.request.urlopen(url) as response:
+            data = json.loads(response.read())
+        return data[0]["name"]
+    except (JSONDecodeError, TypeError):
+        return "ERROR"
+
+
+# TODO: could be extracted and made generic
+def backup_fluidd_data() -> None:
+    with open(FLUIDD_DIR.joinpath(".version"), "r") as v:
+        version = v.readlines()[0]
+    bm = BackupManager()
+    bm.backup_directory(f"fluidd-{version}", FLUIDD_DIR, FLUIDD_BACKUP_DIR)
+    bm.backup_file(NGINX_SITES_AVAILABLE.joinpath("fluidd"), FLUIDD_BACKUP_DIR)

kiauh/components/fluidd/menus/fluidd_remove_menu.py

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

kiauh/components/klipper/__init__.py

@@ -1,5 +1,7 @@
+#!/usr/bin/env python3
+
 # ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#  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                                          #
@@ -9,28 +11,14 @@
 
 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"
-
-# names
-KLIPPER_LOG_NAME = "klippy.log"
-KLIPPER_CFG_NAME = "printer.cfg"
-KLIPPER_SERIAL_NAME = "klippy.serial"
-KLIPPER_UDS_NAME = "klippy.sock"
-KLIPPER_ENV_FILE_NAME = "klipper.env"
-KLIPPER_SERVICE_NAME = "klipper.service"
-
-# directories
 KLIPPER_DIR = Path.home().joinpath("klipper")
-KLIPPER_KCONFIGS_DIR = Path.home().joinpath("klipper-kconfigs")
 KLIPPER_ENV_DIR = Path.home().joinpath("klippy-env")
-
-# files
-KLIPPER_REQ_FILE = KLIPPER_DIR.joinpath("scripts/klippy-requirements.txt")
-KLIPPER_INSTALL_SCRIPT = KLIPPER_DIR.joinpath("scripts/install-ubuntu-22.04.sh")
-KLIPPER_SERVICE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{KLIPPER_SERVICE_NAME}")
-KLIPPER_ENV_FILE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{KLIPPER_ENV_FILE_NAME}")
-
+KLIPPER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("klipper-backups")
+KLIPPER_REQUIREMENTS_TXT = KLIPPER_DIR.joinpath("scripts/klippy-requirements.txt")
+DEFAULT_KLIPPER_REPO_URL = "https://github.com/Klipper3D/klipper"
 
 EXIT_KLIPPER_SETUP = "Exiting Klipper setup ..."

kiauh/components/klipper/klipper.py

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

kiauh/components/klipper/klipper_dialogs.py

@@ -1,5 +1,7 @@
+#!/usr/bin/env python3
+
 # ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#  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                                          #
@@ -8,74 +10,50 @@
 # ======================================================================= #
 
 import textwrap
-from enum import Enum, unique
 from typing import List
 
+from core.instance_manager.base_instance import BaseInstance
 from core.menus.base_menu import print_back_footer
-from core.types.color import Color
-from utils.instance_type import InstanceType
-
-
-@unique
-class DisplayType(Enum):
-    SERVICE_NAME = "SERVICE_NAME"
-    PRINTER_NAME = "PRINTER_NAME"
+from utils.constants import COLOR_GREEN, RESET_FORMAT, COLOR_YELLOW, COLOR_CYAN
 
 
 def print_instance_overview(
-    instances: List[InstanceType],
-    display_type: DisplayType = DisplayType.SERVICE_NAME,
-    show_headline=True,
-    show_index=False,
-    start_index=0,
-    show_select_all=False,
-) -> None:
-    dialog = "╔═══════════════════════════════════════════════════════╗\n"
-    if show_headline:
-        d_type = (
-            "Klipper instances"
-            if display_type is DisplayType.SERVICE_NAME
-            else "printer directories"
-        )
-        headline = Color.apply(f"The following {d_type} were found:", Color.GREEN)
-        dialog += f"║{headline:^64}║\n"
-        dialog += "╟───────────────────────────────────────────────────────╢\n"
+    instances: List[BaseInstance], show_index=False, show_select_all=False
+):
+    headline = f"{COLOR_GREEN}The following Klipper instances were found:{RESET_FORMAT}"
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        |{headline:^64}|
+        |-------------------------------------------------------|
+        """
+    )[1:]
 
     if show_select_all:
-        select_all = Color.apply("a) Select all", Color.YELLOW)
-        dialog += f"║ {select_all:<63}║\n"
-        dialog += "║                                                       ║\n"
+        select_all = f"{COLOR_YELLOW}a) Select all{RESET_FORMAT}"
+        dialog += f"| {select_all:<63}|\n"
+        dialog += "|                                                       |\n"
 
     for i, s in enumerate(instances):
-        if display_type is DisplayType.SERVICE_NAME:
-            name = s.service_file_path.stem
-        else:
-            name = s.data_dir
-        line = Color.apply(
-            f"{f'{i + start_index})' if show_index else '●'} {name}", Color.CYAN
-        )
-        dialog += f"║ {line:<63}║\n"
-    dialog += "╟───────────────────────────────────────────────────────╢\n"
+        line = f"{COLOR_CYAN}{f'{i})' if show_index else '●'} {s.get_service_file_name()}{RESET_FORMAT}"
+        dialog += f"| {line:<63}|\n"
 
     print(dialog, end="")
     print_back_footer()
 
 
-def print_select_instance_count_dialog() -> None:
-    line1 = Color.apply("WARNING:", Color.YELLOW)
-    line2 = Color.apply(
-        "Setting up too many instances may crash your system.", Color.YELLOW
-    )
+def print_select_instance_count_dialog():
+    line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
+    line2 = f"{COLOR_YELLOW}Setting up too many instances may crash your system.{RESET_FORMAT}"
     dialog = textwrap.dedent(
         f"""
-        ╔═══════════════════════════════════════════════════════╗
-        ║ Please select the number of Klipper instances to set  ║
-        ║ up. The number of Klipper instances will determine    ║
-        ║ the amount of printers you can run from this host.    ║
-        ║                                                       ║
-        ║ {line1:<63}║
-        ║ {line2:<63}║
-        ╟───────────────────────────────────────────────────────╢
+        /=======================================================\\
+        | Please select the number of Klipper instances to set  |
+        | up. The number of Klipper instances will determine    |
+        | the amount of printers you can run from this host.    |
+        |                                                       |
+        | {line1:<63}|
+        | {line2:<63}|
         """
     )[1:]
 
@@ -83,31 +61,76 @@ def print_select_instance_count_dialog() -> None:
     print_back_footer()
 
 
-def print_select_custom_name_dialog() -> None:
-    line1 = Color.apply("INFO:", Color.YELLOW)
-    line2 = Color.apply("Only alphanumeric characters are allowed!", Color.YELLOW)
+def print_select_custom_name_dialog():
+    line1 = f"{COLOR_YELLOW}INFO:{RESET_FORMAT}"
+    line2 = f"{COLOR_YELLOW}Only alphanumeric characters are allowed!{RESET_FORMAT}"
     dialog = textwrap.dedent(
         f"""
-        ╔═══════════════════════════════════════════════════════╗
-        ║ Do you want to assign a custom name to each instance? ║
-        ║                                                       ║
-        ║ Assigning a custom name will create a Klipper service ║
-        ║ and a printer directory with the chosen name.         ║
-        ║                                                       ║
-        ║ Example for custom name 'kiauh':                      ║
-        ║  ● Klipper service:   klipper-kiauh.service           ║
-        ║  ● Printer directory: printer_kiauh_data              ║
-        ║                                                       ║
-        ║ If skipped, each instance will get an index assigned  ║
-        ║ in ascending order, starting at '1' in case of a new  ║
-        ║ installation. Otherwise, the index will be derived    ║
-        ║ from amount of already existing instances.            ║
-        ║                                                       ║
-        ║ {line1:<63}║
-        ║ {line2:<63}║
-        ╟───────────────────────────────────────────────────────╢
+        /=======================================================\\
+        | You can now assign a custom name to each instance.    |
+        | If skipped, each instance will get an index assigned  |
+        | in ascending order, starting at index '1'.            |
+        |                                                       |
+        | {line1:<63}|
+        | {line2:<63}|
         """
     )[1:]
 
     print(dialog, end="")
     print_back_footer()
+
+
+def print_missing_usergroup_dialog(missing_groups) -> None:
+    line1 = f"{COLOR_YELLOW}WARNING: Your current user is not in group:{RESET_FORMAT}"
+    line2 = f"{COLOR_CYAN}● tty{RESET_FORMAT}"
+    line3 = f"{COLOR_CYAN}● dialout{RESET_FORMAT}"
+    line4 = f"{COLOR_YELLOW}INFO:{RESET_FORMAT}"
+    line5 = f"{COLOR_YELLOW}Relog required for group assignments to take effect!{RESET_FORMAT}"
+
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        | {line1:<63}|
+        """
+    )[1:]
+
+    if "tty" in missing_groups:
+        dialog += f"| {line2:<63}|\n"
+    if "dialout" in missing_groups:
+        dialog += f"| {line3:<63}|\n"
+
+    dialog += textwrap.dedent(
+        f"""
+        |                                                       |
+        | It is possible that you won't be able to successfully |
+        | connect and/or flash the controller board without     |
+        | your user being a member of that group.               |
+        | If you want to add the current user to the group(s)   |
+        | listed above, answer with 'Y'. Else skip with 'n'.    |
+        |                                                       |
+        | {line4:<63}|
+        | {line5:<63}|
+        \\=======================================================/
+        """
+    )[1:]
+
+    print(dialog, end="")
+
+
+def print_update_warn_dialog() -> None:
+    line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
+    line2 = f"{COLOR_YELLOW}Do NOT continue if there are ongoing prints running!{RESET_FORMAT}"
+    line3 = f"{COLOR_YELLOW}All Klipper instances will be restarted during the {RESET_FORMAT}"
+    line4 = f"{COLOR_YELLOW}update process and ongoing prints WILL FAIL.{RESET_FORMAT}"
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        | {line1:<63}|
+        | {line2:<63}|
+        | {line3:<63}|
+        | {line4:<63}|
+        \\=======================================================/
+        """
+    )[1:]
+
+    print(dialog, end="")

kiauh/components/klipper/klipper_remove.py

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

kiauh/components/klipper/klipper_setup.py

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

kiauh/components/klipper/klipper_utils.py

@@ -1,116 +1,197 @@
+#!/usr/bin/env python3
+
 # ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
-from __future__ import annotations
 
 import grp
 import os
+import re
 import shutil
+import subprocess
+import textwrap
 from pathlib import Path
-from subprocess import CalledProcessError, run
-from typing import Dict, List
+from typing import List, Union, Literal, Dict
 
 from components.klipper import (
+    MODULE_PATH,
     KLIPPER_DIR,
     KLIPPER_ENV_DIR,
-    KLIPPER_INSTALL_SCRIPT,
-    MODULE_PATH,
+    KLIPPER_BACKUP_DIR,
 )
 from components.klipper.klipper import Klipper
 from components.klipper.klipper_dialogs import (
+    print_missing_usergroup_dialog,
     print_instance_overview,
     print_select_instance_count_dialog,
+    print_select_custom_name_dialog,
 )
-from components.webui_client.base_data import BaseWebClient
-from components.webui_client.client_config.client_config_setup import (
-    create_client_config_symlink,
-)
-from core.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,
-)
-from core.types.component_status import ComponentStatus
-from utils.common import check_install_dependencies, get_install_status
-from utils.fs_utils import check_file_exist
-from utils.input_utils import get_confirm, get_number_input, get_string_input
-from utils.instance_utils import get_instances
-from utils.sys_utils import (
-    cmd_sysctl_service,
-    install_python_packages,
-    parse_packages_from_file,
-)
+from components.moonraker.moonraker import Moonraker
+from components.moonraker.moonraker_utils import moonraker_to_multi_conversion
+from core.backup_manager.backup_manager import BackupManager
+from core.config_manager.config_manager import ConfigManager
+from core.instance_manager.base_instance import BaseInstance
+from core.instance_manager.instance_manager import InstanceManager
+from core.instance_manager.name_scheme import NameScheme
+from core.repo_manager.repo_manager import RepoManager
+from utils.common import get_install_status_common
+from utils.constants import CURRENT_USER
+from utils.input_utils import get_confirm, get_string_input, get_number_input
+from utils.logger import Logger
+from utils.system_utils import mask_system_service
 
 
-def get_klipper_status() -> ComponentStatus:
-    return get_install_status(KLIPPER_DIR, KLIPPER_ENV_DIR, Klipper)
+def get_klipper_status() -> Dict[
+    Literal["status", "status_code", "instances", "repo", "local", "remote"],
+    Union[str, int],
+]:
+    status = get_install_status_common(Klipper, KLIPPER_DIR, KLIPPER_ENV_DIR)
+    return {
+        "status": status.get("status"),
+        "status_code": status.get("status_code"),
+        "instances": status.get("instances"),
+        "repo": RepoManager.get_repo_name(KLIPPER_DIR),
+        "local": RepoManager.get_local_commit(KLIPPER_DIR),
+        "remote": RepoManager.get_remote_commit(KLIPPER_DIR),
+    }
 
 
-def add_to_existing() -> bool | None:
-    kl_instances: List[Klipper] = get_instances(Klipper)
+def check_is_multi_install(
+    existing_instances: List[Klipper], install_count: int
+) -> bool:
+    return not existing_instances and install_count > 1
+
+
+def check_is_single_to_multi_conversion(existing_instances: List[Klipper]) -> bool:
+    return len(existing_instances) == 1 and existing_instances[0].suffix == ""
+
+
+def init_name_scheme(
+    existing_instances: List[Klipper], install_count: int
+) -> NameScheme:
+    if check_is_multi_install(
+        existing_instances, install_count
+    ) or check_is_single_to_multi_conversion(existing_instances):
+        print_select_custom_name_dialog()
+        if get_confirm("Assign custom names?", False, allow_go_back=True):
+            return NameScheme.CUSTOM
+        else:
+            return NameScheme.INDEX
+    else:
+        return NameScheme.SINGLE
+
+
+def update_name_scheme(
+    name_scheme: NameScheme,
+    name_dict: Dict[int, str],
+    klipper_instances: List[Klipper],
+    moonraker_instances: List[Moonraker],
+) -> NameScheme:
+    # if there are more moonraker instances installed than klipper, we
+    # load their names into the name_dict, as we will detect and enforce that naming scheme
+    if len(moonraker_instances) > len(klipper_instances):
+        update_name_dict(name_dict, moonraker_instances)
+        return detect_name_scheme(moonraker_instances)
+    elif len(klipper_instances) > 1:
+        update_name_dict(name_dict, klipper_instances)
+        return detect_name_scheme(klipper_instances)
+    else:
+        return name_scheme
+
+
+def update_name_dict(name_dict: Dict[int, str], instances: List[BaseInstance]) -> None:
+    for k, v in enumerate(instances):
+        name_dict[k] = v.suffix
+
+
+def handle_instance_naming(name_dict: Dict[int, str], name_scheme: NameScheme) -> None:
+    if name_scheme == NameScheme.SINGLE:
+        return
+
+    for k in name_dict:
+        if name_dict[k] == "" and name_scheme == NameScheme.INDEX:
+            name_dict[k] = str(k + 1)
+        elif name_dict[k] == "" and name_scheme == NameScheme.CUSTOM:
+            assign_custom_name(k, name_dict)
+
+
+def add_to_existing() -> bool:
+    kl_instances = InstanceManager(Klipper).instances
     print_instance_overview(kl_instances)
-    _input: bool | None = get_confirm("Add new instances?", allow_go_back=True)
-    return _input
+    return get_confirm("Add new instances?", allow_go_back=True)
 
 
-def get_install_count() -> int | None:
+def get_install_count() -> Union[int, None]:
     """
     Print a dialog for selecting the amount of Klipper instances
     to set up with an option to navigate back. Returns None if the
     user selected to go back, otherwise an integer greater or equal than 1 |
     :return: Integer >= 1 or None
     """
-    kl_instances = get_instances(Klipper)
+    kl_instances = InstanceManager(Klipper).instances
     print_select_instance_count_dialog()
-    question = (
-        f"Number of"
-        f"{' additional' if len(kl_instances) > 0 else ''} "
-        f"Klipper instances to set up"
-    )
-    _input: int | None = get_number_input(question, 1, default=1, allow_go_back=True)
-    return _input
+    question = f"Number of{' additional' if len(kl_instances) > 0 else ''} Klipper instances to set up"
+    return get_number_input(question, 1, default=1, allow_go_back=True)
 
 
 def assign_custom_name(key: int, name_dict: Dict[int, str]) -> None:
     existing_names = []
-    existing_names.extend(SUFFIX_BLACKLIST)
+    existing_names.extend(Klipper.blacklist())
     existing_names.extend(name_dict[n] for n in name_dict)
-    pattern = r"^[a-zA-Z0-9]+$"
-
-    question = f"Enter name for instance {key}"
-    name_dict[key] = get_string_input(question, exclude=existing_names, regex=pattern)
+    question = f"Enter name for instance {key + 1}"
+    name_dict[key] = get_string_input(question, exclude=existing_names)
 
 
-def check_user_groups() -> None:
-    user_groups = [grp.getgrgid(gid).gr_name for gid in os.getgroups()]
-    missing_groups = [g for g in ["tty", "dialout"] if g not in user_groups]
+def handle_to_multi_instance_conversion(new_name: str) -> None:
+    Logger.print_status("Converting single instance to multi instances ...")
+    klipper_to_multi_conversion(new_name)
+    moonraker_to_multi_conversion(new_name)
+
+
+def klipper_to_multi_conversion(new_name: str) -> None:
+    Logger.print_status("Convert Klipper single to multi instance ...")
+    im = InstanceManager(Klipper)
+    im.current_instance = im.instances[0]
+    # temporarily store the data dir path
+    old_data_dir = im.instances[0].data_dir
+    # remove the old single instance
+    im.stop_instance()
+    im.disable_instance()
+    im.delete_instance()
+    # create a new klipper instance with the new name
+    im.current_instance = Klipper(suffix=new_name)
+    new_data_dir: Path = im.current_instance.data_dir
+
+    # rename the old data dir and use it for the new instance
+    Logger.print_status(f"Rename '{old_data_dir}' to '{new_data_dir}' ...")
+    if not new_data_dir.is_dir():
+        old_data_dir.rename(new_data_dir)
+    else:
+        Logger.print_info(f"'{new_data_dir}' already exist. Skipped ...")
+
+    im.create_instance()
+    im.enable_instance()
+    im.start_instance()
+
+
+def check_user_groups():
+    current_groups = [grp.getgrgid(gid).gr_name for gid in os.getgroups()]
+
+    missing_groups = []
+    if "tty" not in current_groups:
+        missing_groups.append("tty")
+    if "dialout" not in current_groups:
+        missing_groups.append("dialout")
 
     if not missing_groups:
         return
 
-    Logger.print_dialog(
-        DialogType.ATTENTION,
-        [
-            "Your current user is not in group:",
-            *[f"● {g}" for g in missing_groups],
-            "\n\n",
-            "It is possible that you won't be able to successfully connect and/or "
-            "flash the controller board without your user being a member of that "
-            "group. If you want to add the current user to the group(s) listed above, "
-            "answer with 'Y'. Else skip with 'n'.",
-            "\n\n",
-            "INFO:",
-            "Relog required for group assignments to take effect!",
-        ],
-    )
-
+    print_missing_usergroup_dialog(missing_groups)
     if not get_confirm(f"Add user '{CURRENT_USER}' to group(s) now?"):
         log = "Skipped adding user to required groups. You might encounter issues."
         Logger.warn(log)
@@ -120,9 +201,9 @@ def check_user_groups() -> None:
         for group in missing_groups:
             Logger.print_status(f"Adding user '{CURRENT_USER}' to group {group} ...")
             command = ["sudo", "usermod", "-a", "-G", group, CURRENT_USER]
-            run(command, check=True)
+            subprocess.run(command, check=True)
             Logger.print_ok(f"Group {group} assigned to user '{CURRENT_USER}'.")
-    except CalledProcessError as e:
+    except subprocess.CalledProcessError as e:
         Logger.print_error(f"Unable to add user to usergroups: {e}")
         raise
 
@@ -134,13 +215,13 @@ def handle_disruptive_system_packages() -> None:
     services = []
 
     command = ["systemctl", "is-enabled", "brltty"]
-    brltty_status = run(command, capture_output=True, text=True)
+    brltty_status = subprocess.run(command, capture_output=True, text=True)
 
     command = ["systemctl", "is-enabled", "brltty-udev"]
-    brltty_udev_status = run(command, capture_output=True, text=True)
+    brltty_udev_status = subprocess.run(command, capture_output=True, text=True)
 
     command = ["systemctl", "is-enabled", "ModemManager"]
-    modem_manager_status = run(command, capture_output=True, text=True)
+    modem_manager_status = subprocess.run(command, capture_output=True, text=True)
 
     if "enabled" in brltty_status.stdout:
         services.append("brltty")
@@ -151,22 +232,37 @@ def handle_disruptive_system_packages() -> None:
 
     for service in services if services else []:
         try:
-            cmd_sysctl_service(service, "mask")
-        except CalledProcessError:
-            Logger.print_dialog(
-                DialogType.WARNING,
-                [
-                    f"KIAUH was unable to mask the {service} system service. "
-                    "Please fix the problem manually. Otherwise, this may have "
-                    "undesirable effects on the operation of Klipper."
-                ],
-            )
+            log = f"{service} service detected! Masking {service} service ..."
+            Logger.print_status(log)
+            mask_system_service(service)
+            Logger.print_ok(f"{service} service masked!")
+        except subprocess.CalledProcessError:
+            warn_msg = textwrap.dedent(
+                f"""
+                KIAUH was unable to mask the {service} system service. 
+                Please fix the problem manually. Otherwise, this may have 
+                undesirable effects on the operation of Klipper.
+                """
+            )[1:]
+            Logger.print_warn(warn_msg)
 
 
-def create_example_printer_cfg(
-    instance: Klipper, clients: List[BaseWebClient] | None = None
-) -> None:
-    Logger.print_status(f"Creating example printer.cfg in '{instance.base.cfg_dir}'")
+def detect_name_scheme(instance_list: List[BaseInstance]) -> NameScheme:
+    pattern = re.compile("^\d+$")
+    for instance in instance_list:
+        if not pattern.match(instance.suffix):
+            return NameScheme.CUSTOM
+
+    return NameScheme.INDEX
+
+
+def get_highest_index(instance_list: List[Klipper]) -> int:
+    indices = [int(instance.suffix.split("-")[-1]) for instance in instance_list]
+    return max(indices)
+
+
+def create_example_printer_cfg(instance: Klipper) -> None:
+    Logger.print_status(f"Creating example printer.cfg in '{instance.cfg_dir}'")
     if instance.cfg_file.is_file():
         Logger.print_info(f"'{instance.cfg_file}' already exists.")
         return
@@ -179,85 +275,13 @@ def create_example_printer_cfg(
         Logger.print_error(f"Unable to create example printer.cfg:\n{e}")
         return
 
-    scp = SimpleConfigParser()
-    scp.read_file(target)
-    scp.set_option("virtual_sdcard", "path", str(instance.base.gcodes_dir))
-
-    # include existing client configs in the example config
-    if clients is not None and len(clients) > 0:
-        for c in clients:
-            client_config = c.client_config
-            section = client_config.config_section
-            scp.add_section(section=section)
-            create_client_config_symlink(client_config, [instance])
-
-    scp.write_file(target)
-
-    Logger.print_ok(f"Example printer.cfg created in '{instance.base.cfg_dir}'")
+    cm = ConfigManager(target)
+    cm.set_value("virtual_sdcard", "path", str(instance.gcodes_dir))
+    cm.write_config()
+    Logger.print_ok(f"Example printer.cfg created in '{instance.cfg_dir}'")
 
 
 def backup_klipper_dir() -> None:
-    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:
-    script = KLIPPER_INSTALL_SCRIPT
-    packages = parse_packages_from_file(script)
-
-    # Add pkg-config for rp2040 build
-    packages.append("pkg-config")
-
-    # Add dbus requirement for DietPi distro
-    if check_file_exist(Path("/boot/dietpi/.version")):
-        packages.append("dbus")
-
-    check_install_dependencies({*packages})
-
-
-def install_input_shaper_deps() -> None:
-    if not KLIPPER_ENV_DIR.exists():
-        Logger.print_warn("Required Klipper python environment not found!")
-        return
-
-    Logger.print_dialog(
-        DialogType.CUSTOM,
-        [
-            "Resonance measurements and shaper auto-calibration require additional "
-            "software dependencies which are not installed by default. "
-            "If you agree, the following additional system packages will be installed:",
-            "● python3-numpy",
-            "● python3-matplotlib",
-            "● libatlas-base-dev",
-            "● libopenblas-dev",
-            "\n\n",
-            "Also, the following Python package will be installed:",
-            "● numpy",
-        ],
-        custom_title="Install Input Shaper Dependencies",
-    )
-    if not get_confirm(
-        "Do you want to install the required packages?", default_choice=False
-    ):
-        return
-
-    apt_deps = (
-        "python3-numpy",
-        "python3-matplotlib",
-        "libatlas-base-dev",
-        "libopenblas-dev",
-    )
-    check_install_dependencies({*apt_deps})
-
-    py_deps = ("numpy",)
-
-    install_python_packages(KLIPPER_ENV_DIR, {*py_deps})
+    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)

kiauh/components/klipper/menus/klipper_remove_menu.py

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

kiauh/components/klipper/services/klipper_instance_service.py

@@ -1,46 +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
-
-from typing import List
-
-from components.klipper.klipper import Klipper
-from utils.instance_utils import get_instances
-
-
-class KlipperInstanceService:
-    __cls_instance = None
-    __instances: List[Klipper] = []
-
-    def __new__(cls) -> "KlipperInstanceService":
-        if cls.__cls_instance is None:
-            cls.__cls_instance = super(KlipperInstanceService, cls).__new__(cls)
-        return cls.__cls_instance
-
-    def __init__(self) -> None:
-        if not hasattr(self, "__initialized"):
-            self.__initialized = False
-        if self.__initialized:
-            return
-        self.__initialized = True
-
-    def load_instances(self) -> None:
-        self.__instances = get_instances(Klipper)
-
-    def create_new_instance(self, suffix: str) -> Klipper:
-        instance = Klipper(suffix)
-        self.__instances.append(instance)
-        return instance
-
-    def get_all_instances(self) -> List[Klipper]:
-        return self.__instances
-
-    def get_instance_by_suffix(self, suffix: str) -> Klipper | None:
-        instances: List[Klipper] = [i for i in self.__instances if i.suffix == suffix]
-        return instances[0] if instances else None

kiauh/components/klipper/services/klipper_setup_service.py

@@ -1,366 +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
-
-from copy import copy
-from typing import Dict, List, Tuple
-
-from components.klipper import (
-    EXIT_KLIPPER_SETUP,
-    KLIPPER_DIR,
-    KLIPPER_ENV_DIR,
-    KLIPPER_REPO_URL,
-    KLIPPER_REQ_FILE,
-)
-from components.klipper.klipper import Klipper
-from components.klipper.klipper_dialogs import (
-    print_instance_overview,
-    print_select_custom_name_dialog,
-)
-from components.klipper.klipper_utils import (
-    assign_custom_name,
-    backup_klipper_dir,
-    check_user_groups,
-    create_example_printer_cfg,
-    get_install_count,
-    handle_disruptive_system_packages,
-    install_klipper_packages,
-)
-from components.klipper.services.klipper_instance_service import KlipperInstanceService
-from components.moonraker.moonraker import Moonraker
-from components.moonraker.services.moonraker_instance_service import (
-    MoonrakerInstanceService,
-)
-from components.webui_client.client_utils import (
-    get_existing_clients,
-)
-from core.instance_manager.instance_manager import InstanceManager
-from core.logger import DialogType, Logger
-from core.services.message_service import Message, MessageService
-from core.settings.kiauh_settings import KiauhSettings
-from core.types.color import Color
-from utils.fs_utils import run_remove_routines
-from utils.git_utils import git_clone_wrapper, git_pull_wrapper
-from utils.input_utils import get_confirm, get_selection_input
-from utils.sys_utils import (
-    cmd_sysctl_manage,
-    create_python_venv,
-    install_python_requirements,
-    unit_file_exists,
-)
-
-
-# noinspection PyMethodMayBeStatic
-class KlipperSetupService:
-    __cls_instance = None
-
-    kisvc: KlipperInstanceService
-    misvc: MoonrakerInstanceService
-    msgsvc = MessageService
-
-    settings: KiauhSettings
-    klipper_list: List[Klipper]
-    moonraker_list: List[Moonraker]
-
-    def __new__(cls) -> "KlipperSetupService":
-        if cls.__cls_instance is None:
-            cls.__cls_instance = super(KlipperSetupService, cls).__new__(cls)
-        return cls.__cls_instance
-
-    def __init__(self) -> None:
-        if not hasattr(self, "__initialized"):
-            self.__initialized = False
-        if self.__initialized:
-            return
-        self.__initialized = True
-        self.__init_state()
-
-    def __init_state(self) -> None:
-        self.settings = KiauhSettings()
-
-        self.kisvc = KlipperInstanceService()
-        self.kisvc.load_instances()
-        self.klipper_list = self.kisvc.get_all_instances()
-
-        self.misvc = MoonrakerInstanceService()
-        self.misvc.load_instances()
-        self.moonraker_list = self.misvc.get_all_instances()
-
-        self.msgsvc = MessageService()
-
-    def __refresh_state(self) -> None:
-        self.kisvc.load_instances()
-        self.klipper_list = self.kisvc.get_all_instances()
-
-        self.misvc.load_instances()
-        self.moonraker_list = self.misvc.get_all_instances()
-
-    def install(self) -> None:
-        self.__refresh_state()
-
-        Logger.print_status("Installing Klipper ...")
-
-        match_moonraker: bool = False
-
-        # if there are more moonraker instances than klipper instances, ask the user to
-        # match the klipper instance count to the count of moonraker instances with the same suffix
-        if len(self.moonraker_list) > len(self.klipper_list):
-            is_confirmed = self.__display_moonraker_info()
-            if not is_confirmed:
-                Logger.print_status(EXIT_KLIPPER_SETUP)
-                return
-            match_moonraker = True
-
-        install_count, name_dict = self.__get_install_count_and_name_dict()
-
-        if install_count == 0:
-            Logger.print_status(EXIT_KLIPPER_SETUP)
-            return
-
-        is_multi_install = install_count > 1 or (
-            len(name_dict) >= 1 and install_count >= 1
-        )
-        if not name_dict and install_count == 1:
-            name_dict = {0: ""}
-        elif is_multi_install and not match_moonraker:
-            custom_names = self.__use_custom_names_or_go_back()
-            if custom_names is None:
-                Logger.print_status(EXIT_KLIPPER_SETUP)
-                return
-
-            self.__handle_instance_names(install_count, name_dict, custom_names)
-
-        create_example_cfg = get_confirm("Create example printer.cfg?")
-        # run the actual installation
-        try:
-            self.__run_setup(name_dict, create_example_cfg)
-        except Exception as e:
-            Logger.print_error(e)
-            Logger.print_error("Klipper installation failed!")
-            return
-
-    def update(self) -> None:
-        Logger.print_dialog(
-            DialogType.WARNING,
-            [
-                "Do NOT continue if there are ongoing prints running!",
-                "All Klipper instances will be restarted during the update process and "
-                "ongoing prints WILL FAIL.",
-            ],
-        )
-
-        if not get_confirm("Update Klipper now?"):
-            return
-
-        self.__refresh_state()
-
-        if self.settings.kiauh.backup_before_update:
-            backup_klipper_dir()
-
-        InstanceManager.stop_all(self.klipper_list)
-        git_pull_wrapper(KLIPPER_DIR)
-        install_klipper_packages()
-        install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
-        InstanceManager.start_all(self.klipper_list)
-
-    def remove(
-        self,
-        remove_service: bool,
-        remove_dir: bool,
-        remove_env: bool,
-    ) -> None:
-        self.__refresh_state()
-
-        completion_msg = Message(
-            title="Klipper Removal Process completed",
-            color=Color.GREEN,
-        )
-
-        if remove_service:
-            Logger.print_status("Removing Klipper instances ...")
-            if self.klipper_list:
-                instances_to_remove = self.__get_instances_to_remove()
-                self.__remove_instances(instances_to_remove)
-                if instances_to_remove:
-                    instance_names = [
-                        i.service_file_path.stem for i in instances_to_remove
-                    ]
-                    txt = f"● Klipper instances removed: {', '.join(instance_names)}"
-                    completion_msg.text.append(txt)
-            else:
-                Logger.print_info("No Klipper Services installed! Skipped ...")
-
-        if (remove_dir or remove_env) and unit_file_exists("klipper", suffix="service"):
-            completion_msg.text = [
-                "Some Klipper services are still installed:",
-                f"● '{KLIPPER_DIR}' was not removed, even though selected for removal.",
-                f"● '{KLIPPER_ENV_DIR}' was not removed, even though selected for removal.",
-            ]
-        else:
-            if remove_dir:
-                Logger.print_status("Removing Klipper local repository ...")
-                if run_remove_routines(KLIPPER_DIR):
-                    completion_msg.text.append("● Klipper local repository removed")
-            if remove_env:
-                Logger.print_status("Removing Klipper Python environment ...")
-                if run_remove_routines(KLIPPER_ENV_DIR):
-                    completion_msg.text.append("● Klipper Python environment removed")
-
-        if completion_msg.text:
-            completion_msg.text.insert(0, "The following actions were performed:")
-        else:
-            completion_msg.color = Color.YELLOW
-            completion_msg.centered = True
-            completion_msg.text = ["Nothing to remove."]
-
-        self.msgsvc.set_message(completion_msg)
-
-    def __get_install_count_and_name_dict(self) -> Tuple[int, Dict[int, str]]:
-        install_count: int | None
-        if len(self.moonraker_list) > len(self.klipper_list):
-            install_count = len(self.moonraker_list)
-            name_dict = {
-                i: moonraker.suffix for i, moonraker in enumerate(self.moonraker_list)
-            }
-        else:
-            install_count = get_install_count()
-            name_dict = {
-                i: klipper.suffix for i, klipper in enumerate(self.klipper_list)
-            }
-
-            if install_count is None:
-                Logger.print_status(EXIT_KLIPPER_SETUP)
-                return 0, {}
-
-        return install_count, name_dict
-
-    def __run_setup(self, name_dict: Dict[int, str], create_example_cfg: bool) -> None:
-        if not self.klipper_list:
-            self.__install_deps()
-
-        for i in name_dict:
-            # skip this iteration if there is already an instance with the name
-            if name_dict[i] in [n.suffix for n in self.klipper_list]:
-                continue
-
-            instance = Klipper(suffix=name_dict[i])
-            instance.create()
-            InstanceManager.enable(instance)
-
-            if create_example_cfg:
-                # if a client-config is installed, include it in the new example cfg
-                clients = get_existing_clients()
-                create_example_printer_cfg(instance, clients)
-
-            InstanceManager.start(instance)
-
-        cmd_sysctl_manage("daemon-reload")
-
-        # step 4: check/handle conflicting packages/services
-        handle_disruptive_system_packages()
-
-        # step 5: check for required group membership
-        check_user_groups()
-
-    def __install_deps(self) -> None:
-        default_repo = (KLIPPER_REPO_URL, "master")
-        repo = self.settings.klipper.repositories
-        # pull the first repo defined in kiauh.cfg or fallback to the official Klipper repo
-        repo, branch = (repo[0].url, repo[0].branch) if repo else default_repo
-        git_clone_wrapper(repo, KLIPPER_DIR, branch)
-
-        try:
-            install_klipper_packages()
-            if create_python_venv(KLIPPER_ENV_DIR, False, False, self.settings.klipper.use_python_binary):
-                install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
-        except Exception:
-            Logger.print_error("Error during installation of Klipper requirements!")
-            raise
-
-    def __display_moonraker_info(self) -> bool:
-        # todo: only show the klipper instances that are not already installed
-        Logger.print_dialog(
-            DialogType.INFO,
-            [
-                "Existing Moonraker instances detected:",
-                *[f"● {m.service_file_path.stem}" for m in self.moonraker_list],
-                "\n\n",
-                "The following Klipper instances will be installed:",
-                *[f"● klipper-{m.suffix}" for m in self.moonraker_list],
-            ],
-        )
-        _input: bool = get_confirm("Proceed with installation?")
-        return _input
-
-    def __handle_instance_names(
-        self, install_count: int, name_dict: Dict[int, str], custom_names: bool
-    ) -> None:
-        for i in range(install_count):  # 3
-            key: int = len(name_dict.keys()) + 1
-            if custom_names:
-                assign_custom_name(key, name_dict)
-            else:
-                name_dict[key] = str(len(name_dict) + 1)
-
-    def __use_custom_names_or_go_back(self) -> bool | None:
-        print_select_custom_name_dialog()
-        _input: bool | None = get_confirm(
-            "Assign custom names?",
-            False,
-            allow_go_back=True,
-        )
-        return _input
-
-    def __get_instances_to_remove(self) -> List[Klipper] | None:
-        start_index = 1
-        curr_instances: List[Klipper] = self.klipper_list
-        instance_count = len(curr_instances)
-
-        options = [str(i + start_index) for i in range(instance_count)]
-        options.extend(["a", "b"])
-        instance_map = {options[i]: self.klipper_list[i] for i in range(instance_count)}
-
-        print_instance_overview(
-            self.klipper_list,
-            start_index=start_index,
-            show_index=True,
-            show_select_all=True,
-        )
-        selection = get_selection_input("Select Klipper instance to remove", options)
-
-        if selection == "b":
-            return None
-        elif selection == "a":
-            return copy(self.klipper_list)
-
-        return [instance_map[selection]]
-
-    def __remove_instances(
-        self,
-        instance_list: List[Klipper] | None,
-    ) -> None:
-        if not instance_list:
-            return
-
-        for instance in instance_list:
-            Logger.print_status(
-                f"Removing instance {instance.service_file_path.stem} ..."
-            )
-            InstanceManager.remove(instance)
-            self.__delete_klipper_env_file(instance)
-
-        self.__refresh_state()
-
-    def __delete_klipper_env_file(self, instance: Klipper):
-        Logger.print_status(f"Remove '{instance.env_file}'")
-        if not instance.env_file.exists():
-            msg = f"Env file in {instance.base.sysd_dir} not found. Skipped ..."
-            Logger.print_info(msg)
-            return
-        run_remove_routines(instance.env_file)

kiauh/components/klipper_firmware/firmware_utils.py

@@ -1,213 +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  #
-# ======================================================================= #
-import re
-from pathlib import Path
-from subprocess import (
-    DEVNULL,
-    PIPE,
-    STDOUT,
-    CalledProcessError,
-    Popen,
-    check_output,
-    run,
-)
-from typing import List
-
-from components.klipper import KLIPPER_DIR
-from components.klipper.klipper import Klipper
-from components.klipper_firmware import SD_FLASH_SCRIPT
-from components.klipper_firmware.flash_options import (
-    FlashMethod,
-    FlashOptions,
-)
-from core.instance_manager.instance_manager import InstanceManager
-from core.logger import Logger
-from utils.instance_utils import get_instances
-from utils.sys_utils import log_process
-
-
-def find_firmware_file() -> bool:
-    target = KLIPPER_DIR.joinpath("out")
-    target_exists: bool = target.exists()
-
-    f1 = "klipper.elf.hex"
-    f2 = "klipper.elf"
-    f3 = "klipper.bin"
-    f4 = "klipper.uf2"
-    fw_file_exists: bool = (
-        (target.joinpath(f1).exists() and target.joinpath(f2).exists())
-        or target.joinpath(f3).exists()
-        or target.joinpath(f4).exists()
-    )
-
-    return target_exists and fw_file_exists
-
-
-def find_usb_device_by_id() -> List[str]:
-    try:
-        command = "find /dev/serial/by-id/*"
-        output = check_output(command, shell=True, text=True, stderr=DEVNULL)
-        return output.splitlines()
-    except CalledProcessError as e:
-        Logger.print_error("Unable to find a USB device!")
-        Logger.print_error(e, prefix=False)
-        return []
-
-
-def find_uart_device() -> List[str]:
-    try:
-        cmd = "find /dev -maxdepth 1"
-        output = check_output(cmd, shell=True, text=True, stderr=DEVNULL)
-        device_list = []
-        if output:
-            pattern = r"^/dev/tty(AMA0|S0)$"
-            devices = output.splitlines()
-            device_list = [d for d in devices if re.search(pattern, d)]
-        return device_list
-    except CalledProcessError as e:
-        Logger.print_error("Unable to find a UART device!")
-        Logger.print_error(e, prefix=False)
-        return []
-
-
-def find_usb_dfu_device() -> List[str]:
-    try:
-        output = check_output("lsusb", shell=True, text=True, stderr=DEVNULL)
-        device_list = []
-        if output:
-            devices = output.splitlines()
-            device_list = [d.split(" ")[5] for d in devices if "DFU" in d]
-        return device_list
-
-    except CalledProcessError as e:
-        Logger.print_error("Unable to find a USB DFU device!")
-        Logger.print_error(e, prefix=False)
-        return []
-
-
-def find_usb_rp2_boot_device() -> List[str]:
-    try:
-        output = check_output("lsusb", shell=True, text=True, stderr=DEVNULL)
-        device_list = []
-        if output:
-            devices = output.splitlines()
-            device_list = [d.split(" ")[5] for d in devices if "RP2 Boot" in d]
-        return device_list
-
-    except CalledProcessError as e:
-        Logger.print_error("Unable to find a USB RP2 Boot device!")
-        Logger.print_error(e, prefix=False)
-        return []
-
-
-def get_sd_flash_board_list() -> List[str]:
-    if not KLIPPER_DIR.exists() or not SD_FLASH_SCRIPT.exists():
-        return []
-
-    try:
-        cmd = f"{SD_FLASH_SCRIPT} -l"
-        blist: List[str] = check_output(cmd, shell=True, text=True).splitlines()[1:]
-        return blist
-    except CalledProcessError as e:
-        Logger.print_error(f"An unexpected error occured:\n{e}")
-        return []
-
-
-def start_flash_process(flash_options: FlashOptions) -> None:
-    Logger.print_status(f"Flashing '{flash_options.selected_mcu}' ...")
-    try:
-        if not flash_options.flash_method:
-            raise Exception("Missing value for flash_method!")
-        if not flash_options.flash_command:
-            raise Exception("Missing value for flash_command!")
-        if not flash_options.selected_mcu:
-            raise Exception("Missing value for selected_mcu!")
-        if not flash_options.connection_type:
-            raise Exception("Missing value for connection_type!")
-        if (
-            flash_options.flash_method == FlashMethod.SD_CARD
-            and not flash_options.selected_board
-        ):
-            raise Exception("Missing value for selected_board!")
-
-        if flash_options.flash_method is FlashMethod.REGULAR:
-            cmd = [
-                "make",
-                f"KCONFIG_CONFIG={flash_options.selected_kconfig}",
-                flash_options.flash_command.value,
-                f"FLASH_DEVICE={flash_options.selected_mcu}",
-            ]
-        elif flash_options.flash_method is FlashMethod.SD_CARD:
-            if not SD_FLASH_SCRIPT.exists():
-                raise Exception("Unable to find Klippers sdcard flash script!")
-            cmd = [
-                SD_FLASH_SCRIPT.as_posix(),
-                f"-b {flash_options.selected_baudrate}",
-                flash_options.selected_mcu,
-                flash_options.selected_board,
-            ]
-        else:
-            raise Exception("Invalid value for flash_method!")
-
-        instances = get_instances(Klipper)
-        InstanceManager.stop_all(instances)
-
-        process = Popen(cmd, cwd=KLIPPER_DIR, stdout=PIPE, stderr=STDOUT, text=True)
-        log_process(process)
-
-        InstanceManager.start_all(instances)
-
-        rc = process.returncode
-        if rc != 0:
-            raise Exception(f"Flashing failed with returncode: {rc}")
-        else:
-            Logger.print_ok("Flashing successful!", start="\n", end="\n\n")
-
-    except (Exception, CalledProcessError):
-        Logger.print_error("Flashing failed!", start="\n")
-        Logger.print_error("See the console output above!", end="\n\n")
-
-
-def run_make_clean(kconfig=Path(KLIPPER_DIR.joinpath(".config"))) -> None:
-    try:
-        run(
-            f"make KCONFIG_CONFIG={kconfig} clean",
-            cwd=KLIPPER_DIR,
-            shell=True,
-            check=True,
-        )
-    except CalledProcessError as e:
-        Logger.print_error(f"Unexpected error:\n{e}")
-        raise
-
-
-def run_make_menuconfig(kconfig=Path(KLIPPER_DIR.joinpath(".config"))) -> None:
-    try:
-        run(
-            f"make PYTHON=python3 KCONFIG_CONFIG={kconfig} menuconfig",
-            cwd=KLIPPER_DIR,
-            shell=True,
-            check=True,
-        )
-    except CalledProcessError as e:
-        Logger.print_error(f"Unexpected error:\n{e}")
-        raise
-
-
-def run_make(kconfig=Path(KLIPPER_DIR.joinpath(".config"))) -> None:
-    try:
-        run(
-            f"make PYTHON=python3 KCONFIG_CONFIG={kconfig}",
-            cwd=KLIPPER_DIR,
-            shell=True,
-            check=True,
-        )
-    except CalledProcessError as e:
-        Logger.print_error(f"Unexpected error:\n{e}")
-        raise

kiauh/components/klipper_firmware/flash_options.py

@@ -1,115 +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
-
-from dataclasses import field
-from enum import Enum
-from typing import List
-
-
-class FlashMethod(Enum):
-    REGULAR = "Regular"
-    SD_CARD = "SD Card"
-
-
-class FlashCommand(Enum):
-    FLASH = "flash"
-    SERIAL_FLASH = "serialflash"
-
-
-class ConnectionType(Enum):
-    USB = "USB"
-    USB_DFU = "USB (DFU)"
-    USB_RP2040 = "USB (RP2040)"
-    UART = "UART"
-
-
-class FlashOptions:
-    _instance = None
-    _flash_method: FlashMethod | None = None
-    _flash_command: FlashCommand | None = None
-    _connection_type: ConnectionType | None = None
-    _mcu_list: List[str] = field(default_factory=list)
-    _selected_mcu: str = ""
-    _selected_board: str = ""
-    _selected_baudrate: int = 250000
-    _selected_kconfig: str = ".config"
-
-    def __new__(cls, *args, **kwargs):
-        if not cls._instance:
-            cls._instance = super(FlashOptions, cls).__new__(cls, *args, **kwargs)
-        return cls._instance
-
-    @classmethod
-    def destroy(cls) -> None:
-        cls._instance = None
-
-    @property
-    def flash_method(self) -> FlashMethod | None:
-        return self._flash_method
-
-    @flash_method.setter
-    def flash_method(self, value: FlashMethod | None):
-        self._flash_method = value
-
-    @property
-    def flash_command(self) -> FlashCommand | None:
-        return self._flash_command
-
-    @flash_command.setter
-    def flash_command(self, value: FlashCommand | None):
-        self._flash_command = value
-
-    @property
-    def connection_type(self) -> ConnectionType | None:
-        return self._connection_type
-
-    @connection_type.setter
-    def connection_type(self, value: ConnectionType | None):
-        self._connection_type = value
-
-    @property
-    def mcu_list(self) -> List[str]:
-        return self._mcu_list
-
-    @mcu_list.setter
-    def mcu_list(self, value: List[str]) -> None:
-        self._mcu_list = value
-
-    @property
-    def selected_mcu(self) -> str:
-        return self._selected_mcu
-
-    @selected_mcu.setter
-    def selected_mcu(self, value: str) -> None:
-        self._selected_mcu = value
-
-    @property
-    def selected_board(self) -> str:
-        return self._selected_board
-
-    @selected_board.setter
-    def selected_board(self, value: str) -> None:
-        self._selected_board = value
-
-    @property
-    def selected_baudrate(self) -> int:
-        return self._selected_baudrate
-
-    @selected_baudrate.setter
-    def selected_baudrate(self, value: int) -> None:
-        self._selected_baudrate = value
-
-    @property
-    def selected_kconfig(self) -> str:
-        return self._selected_kconfig
-
-    @selected_kconfig.setter
-    def selected_kconfig(self, value: str) -> None:
-        self._selected_kconfig = value

kiauh/components/klipper_firmware/menus/klipper_build_menu.py

@@ -1,274 +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 textwrap
-from pathlib import Path
-from shutil import copyfile
-from typing import List, Set, Type
-
-from components.klipper import KLIPPER_DIR, KLIPPER_KCONFIGS_DIR
-from components.klipper_firmware.firmware_utils import (
-    run_make,
-    run_make_clean,
-    run_make_menuconfig,
-)
-from components.klipper_firmware.flash_options import FlashOptions
-from core.logger import DialogType, Logger
-from core.menus import Option
-from core.menus.base_menu import BaseMenu
-from core.types.color import Color
-from utils.input_utils import get_confirm, get_string_input
-from utils.sys_utils import (
-    check_package_install,
-    install_system_packages,
-    update_system_package_lists,
-)
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperKConfigMenu(BaseMenu):
-    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
-        super().__init__()
-        self.title = "Firmware Config Menu"
-        self.title_color = Color.CYAN
-        self.previous_menu: Type[BaseMenu] | None = previous_menu
-        self.flash_options = FlashOptions()
-        self.kconfigs_dirname = KLIPPER_KCONFIGS_DIR
-        self.kconfig_default = KLIPPER_DIR.joinpath(".config")
-        self.configs: List[Path] = []
-        self.kconfig = (
-            self.kconfig_default if not Path(self.kconfigs_dirname).is_dir() else None
-        )
-
-    def run(self) -> None:
-        if not self.kconfig:
-            super().run()
-        else:
-            self.flash_options.selected_kconfig = self.kconfig
-
-    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        from core.menus.advanced_menu import AdvancedMenu
-
-        self.previous_menu = (
-            previous_menu if previous_menu is not None else AdvancedMenu
-        )
-
-    def set_options(self) -> None:
-        if not Path(self.kconfigs_dirname).is_dir():
-            return
-
-        self.input_label_txt = "Select config or action to continue (default=N)"
-        self.default_option = Option(
-            method=self.select_config, opt_data=self.kconfig_default
-        )
-
-        option_index = 1
-        for kconfig in Path(self.kconfigs_dirname).iterdir():
-            if not kconfig.name.endswith(".config"):
-                continue
-            kconfig_path = self.kconfigs_dirname.joinpath(kconfig)
-            if Path(kconfig_path).is_file():
-                self.configs += [kconfig]
-                self.options[str(option_index)] = Option(
-                    method=self.select_config, opt_data=kconfig_path
-                )
-                option_index += 1
-        self.options["n"] = Option(
-            method=self.select_config, opt_data=self.kconfig_default
-        )
-
-    def print_menu(self) -> None:
-        cfg_found_str = Color.apply(
-            "Previously saved firmware configs found!", Color.GREEN
-        )
-        menu = textwrap.dedent(
-            f"""
-            ╟───────────────────────────────────────────────────────╢
-            ║ {cfg_found_str:^62} ║
-            ║                                                       ║
-            ║    Select an existing config or create a new one.     ║
-            ╟───────────────────────────────────────────────────────╢
-            ║ Available firmware configs:                           ║
-            """
-        )[1:]
-
-        start_index = 1
-        for i, s in enumerate(self.configs):
-            line = f"{start_index + i}) {s.name}"
-            menu += f"║ {line:<54}║\n"
-
-        new_config = Color.apply("N) Create new firmware config", Color.GREEN)
-        menu += "║                                                       ║\n"
-        menu += f"║ {new_config:<62} ║\n"
-
-        menu += "╟───────────────────────────────────────────────────────╢\n"
-
-        print(menu, end="")
-
-    def select_config(self, **kwargs) -> None:
-        selection: str | None = kwargs.get("opt_data", None)
-        if selection is None:
-            raise Exception("opt_data is None")
-        if not Path(selection).is_file() and selection != self.kconfig_default:
-            raise Exception("opt_data does not exists")
-        self.kconfig = selection
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperBuildFirmwareMenu(BaseMenu):
-    def __init__(
-        self, kconfig: str | None = None, previous_menu: Type[BaseMenu] | None = None
-    ):
-        super().__init__()
-        self.title = "Build Firmware Menu"
-        self.title_color = Color.CYAN
-        self.previous_menu: Type[BaseMenu] | None = previous_menu
-        self.deps: Set[str] = {"build-essential", "dpkg-dev", "make"}
-        self.missing_deps: List[str] = check_package_install(self.deps)
-        self.flash_options = FlashOptions()
-        self.kconfigs_dirname = KLIPPER_KCONFIGS_DIR
-        self.kconfig_default = KLIPPER_DIR.joinpath(".config")
-        self.kconfig = self.flash_options.selected_kconfig
-
-    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        from core.menus.advanced_menu import AdvancedMenu
-
-        self.previous_menu = (
-            previous_menu if previous_menu is not None else AdvancedMenu
-        )
-
-    def set_options(self) -> None:
-        self.input_label_txt = "Press ENTER to install dependencies"
-        self.default_option = Option(method=self.install_missing_deps)
-
-    def run(self):
-        # immediately start the build process if all dependencies are met
-        if len(self.missing_deps) == 0:
-            self.start_build_process()
-        else:
-            super().run()
-
-    def print_menu(self) -> None:
-        txt = Color.apply("Dependencies are missing!", Color.RED)
-        menu = textwrap.dedent(
-            f"""
-            ╟───────────────────────────────────────────────────────╢
-            ║ {txt:^62} ║
-            ╟───────────────────────────────────────────────────────╢
-            ║ The following dependencies are required:              ║
-            ║                                                       ║
-            """
-        )[1:]
-
-        for d in self.deps:
-            status_ok = Color.apply("*INSTALLED*", Color.GREEN)
-            status_missing = Color.apply("*MISSING*", Color.RED)
-            status = status_missing if d in self.missing_deps else status_ok
-            padding = 40 - len(d) + len(status) + (len(status_ok) - len(status))
-            d = Color.apply(f"● {d}", Color.CYAN)
-            menu += f"║ {d}{status:>{padding}} ║\n"
-
-        menu += "║                                                       ║\n"
-        menu += "╟───────────────────────────────────────────────────────╢\n"
-
-        print(menu, end="")
-
-    def install_missing_deps(self, **kwargs) -> None:
-        try:
-            update_system_package_lists(silent=False)
-            Logger.print_status("Installing system packages...")
-            install_system_packages(self.missing_deps)
-        except Exception as e:
-            Logger.print_error(e)
-            Logger.print_error("Installing dependencies failed!")
-        finally:
-            # restart this menu
-            KlipperBuildFirmwareMenu().run()
-
-    def start_build_process(self, **kwargs) -> None:
-        try:
-            run_make_clean(self.kconfig)
-            run_make_menuconfig(self.kconfig)
-            run_make(self.kconfig)
-
-            Logger.print_ok("Firmware successfully built!")
-            Logger.print_ok(f"Firmware file located in '{KLIPPER_DIR}/out'!")
-
-            if self.kconfig == self.kconfig_default:
-                self.save_firmware_config()
-
-        except Exception as e:
-            Logger.print_error(e)
-            Logger.print_error("Building Klipper Firmware failed!")
-
-        finally:
-            if self.previous_menu is not None:
-                self.previous_menu().run()
-
-    def save_firmware_config(self) -> None:
-        Logger.print_dialog(
-            DialogType.CUSTOM,
-            [
-                "You can save the firmware build configs for multiple MCUs,"
-                " and use them to update the firmware after a Klipper version upgrade"
-            ],
-            custom_title="Save firmware config",
-        )
-        if not get_confirm(
-            "Do you want to save firmware config?", default_choice=False
-        ):
-            return
-
-        filename = self.kconfig_default
-        while True:
-            Logger.print_dialog(
-                DialogType.CUSTOM,
-                [
-                    "Allowed characters: a-z, 0-9 and '-'",
-                    "The name must not contain the following:",
-                    "\n\n",
-                    "● Any special characters",
-                    "● No leading or trailing '-'",
-                ],
-            )
-            input_name = get_string_input(
-                "Enter the new firmware config name",
-                regex=r"^[a-z0-9]+([a-z0-9-]*[a-z0-9])?$",
-            )
-            filename = self.kconfigs_dirname.joinpath(f"{input_name}.config")
-
-            if Path(filename).is_file():
-                if get_confirm(
-                    f"Firmware config {input_name} already exists, overwrite?",
-                    default_choice=False,
-                ):
-                    break
-
-            if Path(filename).is_dir():
-                Logger.print_error(f"Path {filename} exists and it's a directory")
-
-            if not Path(filename).exists():
-                break
-
-        if not get_confirm(
-            f"Save firmware config to '{filename}'?", default_choice=True
-        ):
-            Logger.print_info("Aborted saving firmware config ...")
-            return
-
-        if not Path(self.kconfigs_dirname).exists():
-            Path(self.kconfigs_dirname).mkdir()
-
-        copyfile(self.kconfig_default, filename)
-
-        Logger.print_ok()
-        Logger.print_ok(f"Firmware config successfully saved to {filename}")

kiauh/components/klipper_firmware/menus/klipper_flash_error_menu.py

@@ -1,107 +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 textwrap
-from typing import Type
-
-from components.klipper_firmware.flash_options import FlashMethod, FlashOptions
-from core.menus import FooterType, Option
-from core.menus.base_menu import BaseMenu, MenuTitleStyle
-from core.types.color import Color
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperNoFirmwareErrorMenu(BaseMenu):
-    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
-        super().__init__()
-        self.title = "!!! NO FIRMWARE FILE FOUND !!!"
-        self.title_color = Color.RED
-        self.title_style = MenuTitleStyle.PLAIN
-        self.previous_menu: Type[BaseMenu] | None = previous_menu
-
-        self.flash_options = FlashOptions()
-        self.footer_type = FooterType.BLANK
-        self.input_label_txt = "Press ENTER to go back to [Advanced Menu]"
-
-    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        self.previous_menu = previous_menu
-
-    def set_options(self) -> None:
-        self.default_option = Option(method=self.go_back)
-
-    def print_menu(self) -> None:
-        line1 = "Unable to find a compiled firmware file!"
-        menu = textwrap.dedent(
-            f"""
-            ╟───────────────────────────────────────────────────────╢
-            ║ {Color.apply(line1, Color.RED):<62} ║
-            ║                                                       ║
-            ║ Make sure, that:                                      ║
-            ║ ● the folder '~/klipper/out' and its content exist    ║
-            ║ ● the folder contains the following file:             ║
-            """
-        )[1:]
-
-        if self.flash_options.flash_method is FlashMethod.REGULAR:
-            menu += "║   ● 'klipper.elf'                                     ║\n"
-            menu += "║   ● 'klipper.elf.hex'                                 ║\n"
-        else:
-            menu += "║   ● 'klipper.bin'                                     ║\n"
-
-        print(menu, end="")
-
-    def go_back(self, **kwargs) -> None:
-        from core.menus.advanced_menu import AdvancedMenu
-
-        AdvancedMenu().run()
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperNoBoardTypesErrorMenu(BaseMenu):
-    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
-        super().__init__()
-        self.title = "!!! ERROR GETTING BOARD LIST !!!"
-        self.title_color = Color.RED
-        self.title_style = MenuTitleStyle.PLAIN
-        self.previous_menu: Type[BaseMenu] | None = previous_menu
-        self.footer_type = FooterType.BLANK
-        self.input_label_txt = "Press ENTER to go back to [Main Menu]"
-
-    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        self.previous_menu = previous_menu
-
-    def set_options(self) -> None:
-        self.default_option = Option(method=self.go_back)
-
-    def print_menu(self) -> None:
-        line1 = "Reading the list of supported boards failed!"
-        menu = textwrap.dedent(
-            f"""
-            ╟───────────────────────────────────────────────────────╢
-            ║ {Color.apply(line1, Color.RED):<62} ║
-            ║                                                       ║
-            ║ Make sure, that:                                      ║
-            ║ ● the folder '~/klipper' and all its content exist    ║
-            ║ ● the content of folder '~/klipper' is not currupted  ║
-            ║ ● the file '~/klipper/scripts/flash-sd.py' exist      ║
-            ║ ● your current user has access to those files/folders ║
-            ║                                                       ║
-            ║ If in doubt or this process continues to fail, please ║
-            ║ consider to download Klipper again.                   ║
-            """
-        )[1:]
-        print(menu, end="")
-
-    def go_back(self, **kwargs) -> None:
-        from core.menus.main_menu import MainMenu
-
-        MainMenu().run()

kiauh/components/klipper_firmware/menus/klipper_flash_help_menu.py

@@ -1,177 +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 textwrap
-from typing import Tuple, Type
-
-from core.menus.base_menu import BaseMenu, MenuTitleStyle
-from core.types.color import Color
-
-
-def __title_config__() -> Tuple[str, Color, MenuTitleStyle]:
-    return "< ? > Help: Flash MCU < ? >", Color.YELLOW, MenuTitleStyle.PLAIN
-
-
-# noinspection DuplicatedCode
-class KlipperFlashMethodHelpMenu(BaseMenu):
-    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
-        super().__init__()
-        self.title, self.title_color, self.title_style = __title_config__()
-        self.previous_menu: Type[BaseMenu] | None = previous_menu
-
-    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        from components.klipper_firmware.menus.klipper_flash_menu import (
-            KlipperFlashMethodMenu,
-        )
-
-        self.previous_menu = (
-            previous_menu if previous_menu is not None else KlipperFlashMethodMenu
-        )
-
-    def set_options(self) -> None:
-        pass
-
-    def print_menu(self) -> None:
-        subheader1 = Color.apply("Regular flashing method:", Color.CYAN)
-        subheader2 = Color.apply("Updating via SD-Card Update:", Color.CYAN)
-        menu = textwrap.dedent(
-            f"""
-            ╟───────────────────────────────────────────────────────╢
-            ║ {subheader1:<62} ║
-            ║ The default method to flash controller boards which   ║
-            ║ are connected and updated over USB and not by placing ║
-            ║ a compiled firmware file onto an internal SD-Card.    ║
-            ║                                                       ║
-            ║ Common controllers that get flashed that way are:     ║
-            ║ - Arduino Mega 2560                                   ║
-            ║ - Fysetc F6 / S6 (used without a Display + SD-Slot)   ║
-            ║                                                       ║
-            ║ {subheader2:<62} ║
-            ║ Many popular controller boards ship with a bootloader ║
-            ║ capable of updating the firmware via SD-Card.         ║
-            ║ Choose this method if your controller board supports  ║
-            ║ this way of updating. This method ONLY works for up-  ║
-            ║ grading firmware. The initial flashing procedure must ║
-            ║ be done manually per the instructions that apply to   ║
-            ║ your controller board.                                ║
-            ║                                                       ║
-            ║ Common controllers that can be flashed that way are:  ║
-            ║ - BigTreeTech SKR 1.3 / 1.4 (Turbo) / E3 / Mini E3    ║
-            ║ - Fysetc F6 / S6 (used with a Display + SD-Slot)      ║
-            ║ - Fysetc Spider                                       ║
-            ║                                                       ║
-            ╟───────────────────────────────────────────────────────╢
-            """
-        )[1:]
-        print(menu, end="")
-
-
-# noinspection DuplicatedCode
-class KlipperFlashCommandHelpMenu(BaseMenu):
-    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
-        super().__init__()
-        self.title, self.title_color, self.title_style = __title_config__()
-        self.previous_menu: Type[BaseMenu] | None = previous_menu
-
-    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        from components.klipper_firmware.menus.klipper_flash_menu import (
-            KlipperFlashCommandMenu,
-        )
-
-        self.previous_menu = (
-            previous_menu if previous_menu is not None else KlipperFlashCommandMenu
-        )
-
-    def set_options(self) -> None:
-        pass
-
-    def print_menu(self) -> None:
-        subheader1 = Color.apply("make flash:", Color.CYAN)
-        subheader2 = Color.apply("make serialflash:", Color.CYAN)
-        menu = textwrap.dedent(
-            f"""
-            ╟───────────────────────────────────────────────────────╢
-            ║ {subheader1:<62} ║
-            ║ The default command to flash controller board, it     ║
-            ║ will detect selected microcontroller and use suitable ║
-            ║ tool for flashing it.                                 ║
-            ║                                                       ║
-            ║ {subheader2:<62} ║
-            ║ Special command to flash STM32 microcontrollers in    ║
-            ║ DFU mode but connected via serial. stm32flash command ║
-            ║ will be used internally.                              ║
-            ║                                                       ║
-            """
-        )[1:]
-        print(menu, end="")
-
-
-# noinspection DuplicatedCode
-class KlipperMcuConnectionHelpMenu(BaseMenu):
-    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
-        super().__init__()
-        self.title, self.title_color, self.title_style = __title_config__()
-        self.previous_menu: Type[BaseMenu] | None = previous_menu
-
-    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        from components.klipper_firmware.menus.klipper_flash_menu import (
-            KlipperSelectMcuConnectionMenu,
-        )
-
-        self.previous_menu = (
-            previous_menu
-            if previous_menu is not None
-            else KlipperSelectMcuConnectionMenu
-        )
-
-    def set_options(self) -> None:
-        pass
-
-    def print_menu(self) -> None:
-        subheader1 = Color.apply("USB:", Color.CYAN)
-        subheader2 = Color.apply("UART:", Color.CYAN)
-        subheader3 = Color.apply("USB DFU:", Color.CYAN)
-        subheader4 = Color.apply("USB RP2040 Boot:", Color.CYAN)
-        menu = textwrap.dedent(
-            f"""
-            ╟───────────────────────────────────────────────────────╢
-            ║ {subheader1:<62} ║
-            ║ Selecting USB as the connection method will scan the  ║
-            ║ USB ports for connected controller boards. This will  ║
-            ║ be similar to the 'ls /dev/serial/by-id/*' command    ║
-            ║ suggested by the official Klipper documentation for   ║
-            ║ determining successfull USB connections!              ║
-            ║                                                       ║
-            ║ {subheader2:<62} ║
-            ║ Selecting UART as the connection method will list all ║
-            ║ possible UART serial ports. Note: This method ALWAYS  ║
-            ║ returns something as it seems impossible to determine ║
-            ║ if a valid Klipper controller board is connected or   ║
-            ║ not. Because of that, you MUST know which UART serial ║
-            ║ port your controller board is connected to when using ║
-            ║ this connection method.                               ║
-            ║                                                       ║
-            ║ {subheader3:<62} ║
-            ║ Selecting USB DFU as the connection method will scan  ║
-            ║ the USB ports for connected controller boards in      ║
-            ║ STM32 DFU mode, which is usually done by holding down ║
-            ║ the BOOT button or setting a special jumper on the    ║
-            ║ board before powering up.                             ║
-            ║                                                       ║
-            ║ {subheader4:<62} ║
-            ║ Selecting USB RP2 Boot as the connection method will  ║
-            ║ scan the USB ports for connected RP2040 controller    ║
-            ║ boards in Boot mode, which is usually done by holding ║
-            ║ down the BOOT button before powering up.              ║
-            ║                                                       ║
-            ╟───────────────────────────────────────────────────────╢
-            """
-        )[1:]
-        print(menu, end="")

kiauh/components/klipper_firmware/menus/klipper_flash_menu.py

@@ -1,484 +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 textwrap
-import time
-from pathlib import Path
-from typing import Type
-
-from components.klipper_firmware.firmware_utils import (
-    find_firmware_file,
-    find_uart_device,
-    find_usb_device_by_id,
-    find_usb_dfu_device,
-    find_usb_rp2_boot_device,
-    get_sd_flash_board_list,
-    start_flash_process,
-)
-from components.klipper_firmware.flash_options import (
-    ConnectionType,
-    FlashCommand,
-    FlashMethod,
-    FlashOptions,
-)
-from components.klipper_firmware.menus.klipper_flash_error_menu import (
-    KlipperNoBoardTypesErrorMenu,
-    KlipperNoFirmwareErrorMenu,
-)
-from components.klipper_firmware.menus.klipper_flash_help_menu import (
-    KlipperFlashCommandHelpMenu,
-    KlipperFlashMethodHelpMenu,
-    KlipperMcuConnectionHelpMenu,
-)
-from core.logger import DialogType, Logger
-from core.menus import FooterType, Option
-from core.menus.base_menu import BaseMenu, MenuTitleStyle
-from core.types.color import Color
-from utils.input_utils import get_number_input
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperFlashMethodMenu(BaseMenu):
-    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
-        super().__init__()
-        self.title = "MCU Flash Menu"
-        self.title_color = Color.CYAN
-        self.help_menu = KlipperFlashMethodHelpMenu
-        self.input_label_txt = "Select flash method"
-        self.footer_type = FooterType.BACK_HELP
-        self.flash_options = FlashOptions()
-
-    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        from core.menus.advanced_menu import AdvancedMenu
-
-        self.previous_menu = (
-            previous_menu if previous_menu is not None else AdvancedMenu
-        )
-
-    def set_options(self) -> None:
-        self.options = {
-            "1": Option(self.select_regular),
-            "2": Option(self.select_sdcard),
-        }
-
-    def print_menu(self) -> None:
-        subheader = Color.apply("ATTENTION:", Color.YELLOW)
-        subline1 = Color.apply(
-            "Make sure to select the correct method for the MCU!", Color.YELLOW
-        )
-        subline2 = Color.apply("Not all MCUs support both methods!", Color.YELLOW)
-        menu = textwrap.dedent(
-            f"""
-            ╟───────────────────────────────────────────────────────╢
-            ║ Select the flash method for flashing the MCU.         ║
-            ║                                                       ║
-            ║ {subheader:<62} ║
-            ║ {subline1:<62} ║
-            ║ {subline2:<62} ║
-            ╟───────────────────────────────────────────────────────╢
-            ║ 1) Regular flashing method                            ║
-            ║ 2) Updating via SD-Card Update                        ║
-            ╟───────────────────────────┬───────────────────────────╢
-            """
-        )[1:]
-        print(menu, end="")
-
-    def select_regular(self, **kwargs):
-        self.flash_options.flash_method = FlashMethod.REGULAR
-        self.goto_next_menu()
-
-    def select_sdcard(self, **kwargs):
-        self.flash_options.flash_method = FlashMethod.SD_CARD
-        self.goto_next_menu()
-
-    def goto_next_menu(self, **kwargs):
-        if find_firmware_file():
-            KlipperFlashCommandMenu(previous_menu=self.__class__).run()
-        else:
-            KlipperNoFirmwareErrorMenu().run()
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperFlashCommandMenu(BaseMenu):
-    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
-        super().__init__()
-        self.title = "Which flash command to use for flashing the MCU?"
-        self.title_style = MenuTitleStyle.PLAIN
-        self.title_color = Color.YELLOW
-        self.help_menu = KlipperFlashCommandHelpMenu
-        self.input_label_txt = "Select flash command"
-        self.footer_type = FooterType.BACK_HELP
-        self.flash_options = FlashOptions()
-
-    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        self.previous_menu = (
-            previous_menu if previous_menu is not None else KlipperFlashMethodMenu
-        )
-
-    def set_options(self) -> None:
-        self.options = {
-            "1": Option(self.select_flash),
-            "2": Option(self.select_serialflash),
-        }
-        self.default_option = Option(self.select_flash)
-
-    def print_menu(self) -> None:
-        menu = textwrap.dedent(
-            """
-            ╟───────────────────────────────────────────────────────╢
-            ║ 1) make flash (default)                               ║
-            ║ 2) make serialflash (stm32flash)                      ║
-            ╟───────────────────────────┬───────────────────────────╢
-            """
-        )[1:]
-        print(menu, end="")
-
-    def select_flash(self, **kwargs):
-        self.flash_options.flash_command = FlashCommand.FLASH
-        self.goto_next_menu()
-
-    def select_serialflash(self, **kwargs):
-        self.flash_options.flash_command = FlashCommand.SERIAL_FLASH
-        self.goto_next_menu()
-
-    def goto_next_menu(self, **kwargs):
-        KlipperSelectMcuConnectionMenu(previous_menu=self.__class__).run()
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperSelectMcuConnectionMenu(BaseMenu):
-    def __init__(
-        self, previous_menu: Type[BaseMenu] | None = None, standalone: bool = False
-    ):
-        super().__init__()
-        self.title = "Make sure that the controller board is connected now!"
-        self.title_style = MenuTitleStyle.PLAIN
-        self.title_color = Color.YELLOW
-        self.previous_menu: Type[BaseMenu] | None = previous_menu
-        self.__standalone = standalone
-        self.help_menu = KlipperMcuConnectionHelpMenu
-        self.input_label_txt = "Select connection type"
-        self.footer_type = FooterType.BACK_HELP
-        self.flash_options = FlashOptions()
-
-    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        self.previous_menu = (
-            previous_menu if previous_menu is not None else KlipperFlashCommandMenu
-        )
-
-    def set_options(self) -> None:
-        self.options = {
-            "1": Option(method=self.select_usb),
-            "2": Option(method=self.select_dfu),
-            "3": Option(method=self.select_usb_dfu),
-            "4": Option(method=self.select_usb_rp2040),
-        }
-
-    def print_menu(self) -> None:
-        menu = textwrap.dedent(
-            """
-            ╟───────────────────────────────────────────────────────╢
-            ║ How is the controller board connected to the host?    ║
-            ╟───────────────────────────────────────────────────────╢
-            ║ 1) USB                                                ║
-            ║ 2) UART                                               ║
-            ║ 3) USB (DFU mode)                                     ║
-            ║ 4) USB (RP2040 mode)                                  ║
-            ╟───────────────────────────┬───────────────────────────╢
-            """
-        )[1:]
-        print(menu, end="")
-
-    def select_usb(self, **kwargs):
-        self.flash_options.connection_type = ConnectionType.USB
-        self.get_mcu_list()
-
-    def select_dfu(self, **kwargs):
-        self.flash_options.connection_type = ConnectionType.UART
-        self.get_mcu_list()
-
-    def select_usb_dfu(self, **kwargs):
-        self.flash_options.connection_type = ConnectionType.USB_DFU
-        self.get_mcu_list()
-
-    def select_usb_rp2040(self, **kwargs):
-        self.flash_options.connection_type = ConnectionType.USB_RP2040
-        self.get_mcu_list()
-
-    def get_mcu_list(self, **kwargs):
-        conn_type = self.flash_options.connection_type
-
-        if conn_type is ConnectionType.USB:
-            Logger.print_status("Identifying MCU connected via USB ...")
-            self.flash_options.mcu_list = find_usb_device_by_id()
-        elif conn_type is ConnectionType.UART:
-            Logger.print_status("Identifying MCU possibly connected via UART ...")
-            self.flash_options.mcu_list = find_uart_device()
-        elif conn_type is ConnectionType.USB_DFU:
-            Logger.print_status("Identifying MCU connected via USB in DFU mode ...")
-            self.flash_options.mcu_list = find_usb_dfu_device()
-        elif conn_type is ConnectionType.USB_RP2040:
-            Logger.print_status(
-                "Identifying MCU connected via USB in RP2 Boot mode ..."
-            )
-            self.flash_options.mcu_list = find_usb_rp2_boot_device()
-
-        if len(self.flash_options.mcu_list) < 1:
-            Logger.print_warn("No MCUs found!")
-            Logger.print_warn("Make sure they are connected and repeat this step.")
-
-        # if standalone is True, we only display the MCUs to the user and return
-        if self.__standalone and len(self.flash_options.mcu_list) > 0:
-            Logger.print_ok("The following MCUs were found:", prefix=False)
-            for i, mcu in enumerate(self.flash_options.mcu_list):
-                print(f"   ● MCU #{i}: {Color.CYAN}{mcu}{Color.RST}")
-            time.sleep(3)
-            return
-
-        self.goto_next_menu()
-
-    def goto_next_menu(self, **kwargs):
-        KlipperSelectMcuIdMenu(previous_menu=self.__class__).run()
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperSelectMcuIdMenu(BaseMenu):
-    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
-        super().__init__()
-        self.title = "!!! ATTENTION !!!"
-        self.title_style = MenuTitleStyle.PLAIN
-        self.title_color = Color.RED
-        self.flash_options = FlashOptions()
-        self.mcu_list = self.flash_options.mcu_list
-        self.input_label_txt = "Select MCU to flash"
-        self.footer_type = FooterType.BACK
-
-    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        self.previous_menu = (
-            previous_menu
-            if previous_menu is not None
-            else KlipperSelectMcuConnectionMenu
-        )
-
-    def set_options(self) -> None:
-        self.options = {
-            f"{i}": Option(self.flash_mcu, f"{i}") for i in range(len(self.mcu_list))
-        }
-
-    def print_menu(self) -> None:
-        header2 = f"[{Color.apply('List of detected MCUs', Color.CYAN)}]"
-        menu = textwrap.dedent(
-            f"""
-            ╟───────────────────────────────────────────────────────╢
-            ║ Make sure, to select the correct MCU!                 ║
-            ║ ONLY flash a firmware created for the respective MCU! ║
-            ║                                                       ║
-            ╟{header2:─^64}╢
-            ║                                                       ║
-            """
-        )[1:]
-
-        for i, mcu in enumerate(self.mcu_list):
-            mcu = mcu.split("/")[-1]
-            menu += f"║ {i}) {Color.apply(f'{mcu:<51}', Color.CYAN)}║\n"
-
-        menu += textwrap.dedent(
-            """
-            ║                                                       ║
-            ╟───────────────────────────────────────────────────────╢
-            """
-        )[1:]
-        print(menu, end="")
-
-    def flash_mcu(self, **kwargs):
-        try:
-            index: int | None = kwargs.get("opt_index", None)
-            if index is None:
-                raise Exception("opt_index is None")
-
-            index = int(index)
-            selected_mcu = self.mcu_list[index]
-            self.flash_options.selected_mcu = selected_mcu
-
-            if self.flash_options.flash_method == FlashMethod.SD_CARD:
-                KlipperSelectSDFlashBoardMenu(previous_menu=self.__class__).run()
-            elif self.flash_options.flash_method == FlashMethod.REGULAR:
-                KlipperFlashOverviewMenu(previous_menu=self.__class__).run()
-        except Exception as e:
-            Logger.print_error(e)
-            Logger.print_error("Flashing failed!")
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperSelectSDFlashBoardMenu(BaseMenu):
-    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
-        super().__init__()
-        self.flash_options = FlashOptions()
-        self.available_boards = get_sd_flash_board_list()
-        self.input_label_txt = "Select board type"
-
-    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        self.previous_menu = (
-            previous_menu if previous_menu is not None else KlipperSelectMcuIdMenu
-        )
-
-    def set_options(self) -> None:
-        self.options = {
-            f"{i}": Option(self.board_select, f"{i}")
-            for i in range(len(self.available_boards))
-        }
-
-    def print_menu(self) -> None:
-        if len(self.available_boards) < 1:
-            KlipperNoBoardTypesErrorMenu().run()
-        else:
-            menu = textwrap.dedent(
-                """
-                ║ Please select the type of board that corresponds to   ║
-                ║ the currently selected MCU ID you chose before.       ║
-                ║                                                       ║
-                ║ The following boards are currently supported:         ║
-                ╟───────────────────────────────────────────────────────╢
-                """
-            )[1:]
-
-            for i, board in enumerate(self.available_boards):
-                line = f" {i}) {board}"
-                menu += f"║{line:<55}║\n"
-            menu += "╟───────────────────────────────────────────────────────╢"
-            print(menu, end="")
-
-    def board_select(self, **kwargs):
-        try:
-            index: int | None = kwargs.get("opt_index", None)
-            if index is None:
-                raise Exception("opt_index is None")
-
-            index = int(index)
-            self.flash_options.selected_board = self.available_boards[index]
-            self.baudrate_select()
-        except Exception as e:
-            Logger.print_error(e)
-            Logger.print_error("Board selection failed!")
-
-    def baudrate_select(self, **kwargs):
-        Logger.print_dialog(
-            DialogType.CUSTOM,
-            [
-                "If your board is flashed with firmware that connects "
-                "at a custom baud rate, please change it now.",
-                "\n\n",
-                "If you are unsure, stick to the default 250000!",
-            ],
-        )
-        self.flash_options.selected_baudrate = get_number_input(
-            question="Please set the baud rate",
-            default=250000,
-            min_value=0,
-            allow_go_back=True,
-        )
-        KlipperFlashOverviewMenu(previous_menu=self.__class__).run()
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperFlashOverviewMenu(BaseMenu):
-    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
-        super().__init__()
-        self.title = "!!! ATTENTION !!!"
-        self.title_style = MenuTitleStyle.PLAIN
-        self.title_color = Color.RED
-        self.flash_options = FlashOptions()
-        self.input_label_txt = "Perform action (default=Y)"
-
-    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        self.previous_menu: Type[BaseMenu] | None = previous_menu
-
-    def set_options(self) -> None:
-        self.options = {
-            "y": Option(self.execute_flash),
-            "n": Option(self.abort_process),
-        }
-
-        self.default_option = Option(self.execute_flash)
-
-    def print_menu(self) -> None:
-        method = self.flash_options.flash_method.value
-        command = self.flash_options.flash_command.value
-        conn_type = self.flash_options.connection_type.value
-        mcu = self.flash_options.selected_mcu.split("/")[-1]
-        board = self.flash_options.selected_board
-        baudrate = self.flash_options.selected_baudrate
-        kconfig = Path(self.flash_options.selected_kconfig).name
-        color = Color.CYAN
-        subheader = f"[{Color.apply('Overview', color)}]"
-        menu = textwrap.dedent(
-            f"""
-            ╟───────────────────────────────────────────────────────╢
-            ║ Before contuining the flashing process, please check  ║
-            ║ if all parameters were set correctly! Once you made   ║
-            ║ sure everything is correct, start the process. If any ║
-            ║ parameter needs to be changed, you can go back (B)    ║
-            ║ step by step or abort and start from the beginning.   ║
-            ║{subheader:─^64}║
-            ║                                                       ║
-            """
-        )[1:]
-
-        menu += textwrap.dedent(
-            f"""
-            ║ MCU: {Color.apply(f"{mcu:<48}", color)} ║
-            ║ Connection: {Color.apply(f"{conn_type:<41}", color)} ║
-            ║ Flash method: {Color.apply(f"{method:<39}", color)} ║
-            ║ Flash command: {Color.apply(f"{command:<38}", color)} ║
-            """
-        )[1:]
-
-        if self.flash_options.flash_method is FlashMethod.SD_CARD:
-            menu += textwrap.dedent(
-                f"""
-                ║ Board type: {Color.apply(f"{board:<41}", color)} ║
-                ║ Baudrate: {Color.apply(f"{baudrate:<43}", color)} ║
-                """
-            )[1:]
-
-        if self.flash_options.flash_method is FlashMethod.REGULAR:
-            menu += textwrap.dedent(
-                f"""
-                ║ Firmware config: {Color.apply(f"{kconfig:<36}", color)} ║
-                """
-            )[1:]
-
-        menu += textwrap.dedent(
-            """
-            ║                                                       ║
-            ╟───────────────────────────────────────────────────────╢
-            ║  Y) Start flash process                               ║
-            ║  N) Abort - Return to Advanced Menu                   ║
-            ╟───────────────────────────────────────────────────────╢
-            """
-        )[1:]
-        print(menu, end="")
-
-    def execute_flash(self, **kwargs):
-        start_flash_process(self.flash_options)
-        Logger.print_info("Returning to MCU Flash Menu in 5 seconds ...")
-        time.sleep(5)
-        KlipperFlashMethodMenu().run()
-
-    def abort_process(self, **kwargs):
-        from core.menus.advanced_menu import AdvancedMenu
-
-        AdvancedMenu().run()

kiauh/components/klipperscreen/__init__.py

@@ -1,32 +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 pathlib import Path
-
-from core.constants import SYSTEMD
-
-# repo
-KLIPPERSCREEN_REPO = "https://github.com/KlipperScreen/KlipperScreen.git"
-
-# names
-KLIPPERSCREEN_SERVICE_NAME = "KlipperScreen.service"
-KLIPPERSCREEN_UPDATER_SECTION_NAME = "update_manager KlipperScreen"
-KLIPPERSCREEN_LOG_NAME = "KlipperScreen.log"
-
-# directories
-KLIPPERSCREEN_DIR = Path.home().joinpath("KlipperScreen")
-KLIPPERSCREEN_ENV_DIR = Path.home().joinpath(".KlipperScreen-env")
-
-# files
-KLIPPERSCREEN_REQ_FILE = KLIPPERSCREEN_DIR.joinpath(
-    "scripts/KlipperScreen-requirements.txt"
-)
-KLIPPERSCREEN_INSTALL_SCRIPT = KLIPPERSCREEN_DIR.joinpath(
-    "scripts/KlipperScreen-install.sh"
-)
-KLIPPERSCREEN_SERVICE_FILE = SYSTEMD.joinpath(KLIPPERSCREEN_SERVICE_NAME)

kiauh/components/klipperscreen/klipperscreen.py

@@ -1,207 +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  #
-# ======================================================================= #
-import shutil
-from pathlib import Path
-from subprocess import CalledProcessError, run
-from typing import List
-
-from components.klipper.klipper import Klipper
-from components.klipperscreen import (
-    KLIPPERSCREEN_DIR,
-    KLIPPERSCREEN_ENV_DIR,
-    KLIPPERSCREEN_INSTALL_SCRIPT,
-    KLIPPERSCREEN_LOG_NAME,
-    KLIPPERSCREEN_REPO,
-    KLIPPERSCREEN_REQ_FILE,
-    KLIPPERSCREEN_SERVICE_FILE,
-    KLIPPERSCREEN_SERVICE_NAME,
-    KLIPPERSCREEN_UPDATER_SECTION_NAME,
-)
-from components.moonraker.moonraker import Moonraker
-from core.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 (
-    check_install_dependencies,
-    get_install_status,
-)
-from utils.config_utils import add_config_section, remove_config_section
-from utils.fs_utils import remove_with_sudo
-from utils.git_utils import (
-    git_clone_wrapper,
-    git_pull_wrapper,
-)
-from utils.input_utils import get_confirm
-from utils.instance_utils import get_instances
-from utils.sys_utils import (
-    check_python_version,
-    cmd_sysctl_service,
-    install_python_requirements,
-    remove_system_service,
-)
-
-
-def install_klipperscreen() -> None:
-    Logger.print_status("Installing KlipperScreen ...")
-
-    if not check_python_version(3, 7):
-        return
-
-    mr_instances = get_instances(Moonraker)
-    if not mr_instances:
-        Logger.print_dialog(
-            DialogType.WARNING,
-            [
-                "Moonraker not found! KlipperScreen will not properly work "
-                "without a working Moonraker installation.",
-                "\n\n",
-                "KlipperScreens update manager configuration for Moonraker "
-                "will not be added to any moonraker.conf.",
-            ],
-        )
-        if not get_confirm(
-            "Continue KlipperScreen installation?",
-            default_choice=False,
-            allow_go_back=True,
-        ):
-            return
-
-    check_install_dependencies()
-
-    git_clone_wrapper(KLIPPERSCREEN_REPO, KLIPPERSCREEN_DIR)
-
-    try:
-        run(KLIPPERSCREEN_INSTALL_SCRIPT.as_posix(), shell=True, check=True)
-        if mr_instances:
-            patch_klipperscreen_update_manager(mr_instances)
-            InstanceManager.restart_all(mr_instances)
-        else:
-            Logger.print_info(
-                "Moonraker is not installed! Cannot add "
-                "KlipperScreen to update manager!"
-            )
-        Logger.print_ok("KlipperScreen successfully installed!")
-    except CalledProcessError as e:
-        Logger.print_error(f"Error installing KlipperScreen:\n{e}")
-        return
-
-
-def patch_klipperscreen_update_manager(instances: List[Moonraker]) -> None:
-    BackupService().backup_moonraker_conf()
-    add_config_section(
-        section=KLIPPERSCREEN_UPDATER_SECTION_NAME,
-        instances=instances,
-        options=[
-            ("type", "git_repo"),
-            ("path", KLIPPERSCREEN_DIR.as_posix()),
-            ("origin", KLIPPERSCREEN_REPO),
-            ("managed_services", "KlipperScreen"),
-            ("env", f"{KLIPPERSCREEN_ENV_DIR}/bin/python"),
-            ("requirements", KLIPPERSCREEN_REQ_FILE.as_posix()),
-            ("install_script", KLIPPERSCREEN_INSTALL_SCRIPT.as_posix()),
-        ],
-    )
-
-
-def update_klipperscreen() -> None:
-    if not KLIPPERSCREEN_DIR.exists():
-        Logger.print_info("KlipperScreen does not seem to be installed! Skipping ...")
-        return
-
-    try:
-        Logger.print_status("Updating KlipperScreen ...")
-
-        cmd_sysctl_service(KLIPPERSCREEN_SERVICE_NAME, "stop")
-
-        settings = KiauhSettings()
-        if settings.kiauh.backup_before_update:
-            backup_klipperscreen_dir()
-
-        git_pull_wrapper(KLIPPERSCREEN_DIR)
-
-        install_python_requirements(KLIPPERSCREEN_ENV_DIR, KLIPPERSCREEN_REQ_FILE)
-
-        cmd_sysctl_service(KLIPPERSCREEN_SERVICE_NAME, "start")
-
-        Logger.print_ok("KlipperScreen updated successfully.", end="\n\n")
-    except CalledProcessError as e:
-        Logger.print_error(f"Error updating KlipperScreen:\n{e}")
-        return
-
-
-def get_klipperscreen_status() -> ComponentStatus:
-    return get_install_status(
-        KLIPPERSCREEN_DIR,
-        KLIPPERSCREEN_ENV_DIR,
-        files=[SYSTEMD.joinpath(KLIPPERSCREEN_SERVICE_NAME)],
-    )
-
-
-def remove_klipperscreen() -> None:
-    Logger.print_status("Removing KlipperScreen ...")
-    try:
-        if KLIPPERSCREEN_DIR.exists():
-            Logger.print_status("Removing KlipperScreen directory ...")
-            shutil.rmtree(KLIPPERSCREEN_DIR)
-            Logger.print_ok("KlipperScreen directory successfully removed!")
-        else:
-            Logger.print_warn("KlipperScreen directory not found!")
-
-        if KLIPPERSCREEN_ENV_DIR.exists():
-            Logger.print_status("Removing KlipperScreen environment ...")
-            shutil.rmtree(KLIPPERSCREEN_ENV_DIR)
-            Logger.print_ok("KlipperScreen environment successfully removed!")
-        else:
-            Logger.print_warn("KlipperScreen environment not found!")
-
-        if KLIPPERSCREEN_SERVICE_FILE.exists():
-            remove_system_service(KLIPPERSCREEN_SERVICE_NAME)
-
-        logfile = Path(f"/tmp/{KLIPPERSCREEN_LOG_NAME}")
-        if logfile.exists():
-            Logger.print_status("Removing KlipperScreen log file ...")
-            remove_with_sudo(logfile)
-            Logger.print_ok("KlipperScreen log file successfully removed!")
-
-        kl_instances: List[Klipper] = get_instances(Klipper)
-        for instance in kl_instances:
-            logfile = instance.base.log_dir.joinpath(KLIPPERSCREEN_LOG_NAME)
-            if logfile.exists():
-                Logger.print_status(f"Removing {logfile} ...")
-                Path(logfile).unlink()
-                Logger.print_ok(f"{logfile} successfully removed!")
-
-        mr_instances: List[Moonraker] = get_instances(Moonraker)
-        if mr_instances:
-            Logger.print_status("Removing KlipperScreen from update manager ...")
-            BackupService().backup_moonraker_conf()
-            remove_config_section("update_manager KlipperScreen", mr_instances)
-            Logger.print_ok("KlipperScreen successfully removed from update manager!")
-
-        Logger.print_ok("KlipperScreen successfully removed!")
-
-    except Exception as e:
-        Logger.print_error(f"Error removing KlipperScreen:\n{e}")
-
-
-def backup_klipperscreen_dir() -> None:
-    svc = BackupService()
-    svc.backup_directory(
-        source_path=KLIPPERSCREEN_DIR,
-        backup_name="KlipperScreen",
-        target_path="KlipperScreen",
-    )
-    svc.backup_directory(
-        source_path=KLIPPERSCREEN_ENV_DIR,
-        backup_name="KlipperScreen-env",
-        target_path="KlipperScreen",
-    )

kiauh/components/log_uploads/__init__.py

@@ -1,5 +1,7 @@
+#!/usr/bin/env python3
+
 # ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#  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                                          #
@@ -8,7 +10,7 @@
 # ======================================================================= #
 
 from pathlib import Path
-from typing import Dict, Literal, Union
+from typing import Dict, Union, Literal
 
 FileKey = Literal["filepath", "display_name"]
 LogFile = Dict[FileKey, Union[str, Path]]

kiauh/components/log_uploads/log_upload_utils.py

@@ -1,5 +1,7 @@
+#!/usr/bin/env python3
+
 # ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#  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                                          #
@@ -13,14 +15,13 @@ from typing import List
 
 from components.klipper.klipper import Klipper
 from components.log_uploads import LogFile
-from core.logger import Logger
-from utils.instance_utils import get_instances
+from core.instance_manager.instance_manager import InstanceManager
+from utils.logger import Logger
 
 
 def get_logfile_list() -> List[LogFile]:
-    log_dirs: List[Path] = [
-        instance.base.log_dir for instance in get_instances(Klipper)
-    ]
+    cm = InstanceManager(Klipper)
+    log_dirs: List[Path] = [instance.log_dir for instance in cm.instances]
 
     logfiles: List[LogFile] = []
     for _dir in log_dirs:
@@ -48,8 +49,8 @@ def upload_logfile(logfile: LogFile) -> None:
         try:
             response = urllib.request.urlopen(req)
             link = response.read().decode("utf-8")
-            Logger.print_ok("Upload successful! Access it via the following link:")
+            Logger.print_ok("Upload successfull! Access it via the following link:")
             Logger.print_ok(f">>>> {link}", False)
         except Exception as e:
-            Logger.print_error("Uploading logfile failed!")
+            Logger.print_error(f"Uploading logfile failed!")
             Logger.print_error(str(e))

kiauh/components/log_uploads/menus/log_upload_menu.py

@@ -1,67 +1,54 @@
+#!/usr/bin/env python3
+
 # ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
-from __future__ import annotations
 
 import textwrap
-from typing import Type
 
-from components.log_uploads.log_upload_utils import get_logfile_list, upload_logfile
-from core.logger import Logger
-from core.menus import Option
+from components.log_uploads.log_upload_utils import get_logfile_list
+from components.log_uploads.log_upload_utils import upload_logfile
+from core.menus import BACK_FOOTER
 from core.menus.base_menu import BaseMenu
-from core.types.color import Color
+from utils.constants import RESET_FORMAT, COLOR_YELLOW
 
 
 # noinspection PyMethodMayBeStatic
 class LogUploadMenu(BaseMenu):
-    def __init__(self, previous_menu: Type[BaseMenu] | None = None):
-        super().__init__()
-        self.title = "Log Upload"
-        self.title_color = Color.YELLOW
-        self.previous_menu: Type[BaseMenu] | None = previous_menu
+    def __init__(self):
         self.logfile_list = get_logfile_list()
+        options = {index: self.upload for index in range(len(self.logfile_list))}
+        super().__init__(
+            header=True,
+            options=options,
+            footer_type=BACK_FOOTER,
+        )
 
-    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        from core.menus.main_menu import MainMenu
-
-        self.previous_menu = previous_menu if previous_menu is not None else MainMenu
-
-    def set_options(self) -> None:
-        self.options = {
-            f"{index}": Option(self.upload, opt_index=f"{index}")
-            for index in range(len(self.logfile_list))
-        }
-
-    def print_menu(self) -> None:
+    def print_menu(self):
+        header = " [ Log Upload ] "
+        color = COLOR_YELLOW
+        count = 62 - len(color) - len(RESET_FORMAT)
         menu = textwrap.dedent(
-            """
-            ╟───────────────────────────────────────────────────────╢
-            ║ You can select the following logfiles for uploading:  ║
-            ║                                                       ║
+            f"""
+            /=======================================================\\
+            | {color}{header:~^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            | You can select the following logfiles for uploading:  |
+            |                                                       |
             """
         )[1:]
 
-        for logfile in enumerate(self.logfile_list):
+        logfile_list = get_logfile_list()
+        for logfile in enumerate(logfile_list):
             line = f"{logfile[0]}) {logfile[1].get('display_name')}"
-            menu += f"║ {line:<54}║\n"
-        menu += "╟───────────────────────────────────────────────────────╢\n"
+            menu += f"| {line:<54}|\n"
 
         print(menu, end="")
 
     def upload(self, **kwargs):
-        try:
-            index: int | None = kwargs.get("opt_index", None)
-            if index is None:
-                raise Exception("opt_index is None")
-
-            index = int(index)
-            upload_logfile(self.logfile_list[index])
-        except Exception as e:
-            Logger.print_error(e)
-            Logger.print_error("Log upload failed!")
+        upload_logfile(self.logfile_list[kwargs.get("opt_index")])

kiauh/components/mainsail/__init__.py

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

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

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

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

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

kiauh/components/mainsail/mainsail_dialogs.py

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

kiauh/components/mainsail/mainsail_remove.py

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

kiauh/components/mainsail/mainsail_setup.py

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

kiauh/components/mainsail/mainsail_utils.py

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

kiauh/components/mainsail/menus/mainsail_remove_menu.py

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

kiauh/components/moonraker/__init__.py

@@ -1,5 +1,7 @@
+#!/usr/bin/env python3
+
 # ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#  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                                          #
@@ -9,35 +11,26 @@
 
 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"
-
-# names
-MOONRAKER_CFG_NAME = "moonraker.conf"
-MOONRAKER_LOG_NAME = "moonraker.log"
-MOONRAKER_SERVICE_NAME = "moonraker.service"
-MOONRAKER_DEFAULT_PORT = 7125
-MOONRAKER_ENV_FILE_NAME = "moonraker.env"
-
-# directories
 MOONRAKER_DIR = Path.home().joinpath("moonraker")
 MOONRAKER_ENV_DIR = Path.home().joinpath("moonraker-env")
+MOONRAKER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("moonraker-backups")
+MOONRAKER_DB_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("moonraker-db-backups")
+MOONRAKER_REQUIREMENTS_TXT = MOONRAKER_DIR.joinpath(
+    "scripts/moonraker-requirements.txt"
+)
+DEFAULT_MOONRAKER_REPO_URL = "https://github.com/Arksine/moonraker"
+DEFAULT_MOONRAKER_PORT = 7125
 
-# files
-MOONRAKER_INSTALL_SCRIPT = MOONRAKER_DIR.joinpath("scripts/install-moonraker.sh")
-MOONRAKER_REQ_FILE = MOONRAKER_DIR.joinpath("scripts/moonraker-requirements.txt")
-MOONRAKER_SPEEDUPS_REQ_FILE = MOONRAKER_DIR.joinpath("scripts/moonraker-speedups.txt")
-MOONRAKER_DEPS_JSON_FILE = MOONRAKER_DIR.joinpath("scripts/system-dependencies.json")
 # introduced due to
 # https://github.com/Arksine/moonraker/issues/349
 # https://github.com/Arksine/moonraker/pull/346
 POLKIT_LEGACY_FILE = Path("/etc/polkit-1/localauthority/50-local.d/10-moonraker.pkla")
 POLKIT_FILE = Path("/etc/polkit-1/rules.d/moonraker.rules")
 POLKIT_USR_FILE = Path("/usr/share/polkit-1/rules.d/moonraker.rules")
-POLKIT_SCRIPT = MOONRAKER_DIR.joinpath("scripts/set-policykit-rules.sh")
-MOONRAKER_SERVICE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{MOONRAKER_SERVICE_NAME}")
-MOONRAKER_ENV_FILE_TEMPLATE = MODULE_PATH.joinpath(f"assets/{MOONRAKER_ENV_FILE_NAME}")
-
+POLKIT_SCRIPT = Path.home().joinpath("moonraker/scripts/set-policykit-rules.sh")
 
 EXIT_MOONRAKER_SETUP = "Exiting Moonraker setup ..."

kiauh/components/moonraker/assets/moonraker.conf

@@ -10,7 +10,6 @@ trusted_clients:
     169.254.0.0/16
     172.16.0.0/12
     192.168.0.0/16
-    FC00::/7
     FE80::/10
     ::1/128
 cors_domains:

kiauh/components/moonraker/menus/moonraker_remove_menu.py

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

kiauh/components/moonraker/moonraker.py

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

kiauh/components/moonraker/moonraker_dialogs.py

@@ -1,5 +1,7 @@
+#!/usr/bin/env python3
+
 # ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#  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                                          #
@@ -13,7 +15,7 @@ from typing import List
 from components.klipper.klipper import Klipper
 from components.moonraker.moonraker import Moonraker
 from core.menus.base_menu import print_back_footer
-from core.types.color import Color
+from utils.constants import COLOR_GREEN, RESET_FORMAT, COLOR_YELLOW, COLOR_CYAN
 
 
 def print_moonraker_overview(
@@ -22,23 +24,23 @@ def print_moonraker_overview(
     show_index=False,
     show_select_all=False,
 ):
-    headline = Color.apply("The following instances were found:", Color.GREEN)
+    headline = f"{COLOR_GREEN}The following instances were found:{RESET_FORMAT}"
     dialog = textwrap.dedent(
         f"""
-        ╔═══════════════════════════════════════════════════════╗
-        ║{headline:^64}║
-        ╟───────────────────────────────────────────────────────╢
+        /=======================================================\\
+        |{headline:^64}|
+        |-------------------------------------------------------|
         """
     )[1:]
 
     if show_select_all:
-        select_all = Color.apply("a) Select all", Color.YELLOW)
-        dialog += f"║ {select_all:<63}║\n"
-        dialog += "║                                                       ║\n"
+        select_all = f"{COLOR_YELLOW}a) Select all{RESET_FORMAT}"
+        dialog += f"| {select_all:<63}|\n"
+        dialog += "|                                                       |\n"
 
     instance_map = {
-        k.service_file_path.stem: (
-            k.service_file_path.stem.replace("klipper", "moonraker")
+        k.get_service_file_name(): (
+            k.get_service_file_name().replace("klipper", "moonraker")
             if k.suffix in [m.suffix for m in moonraker_instances]
             else ""
         )
@@ -48,24 +50,19 @@ def print_moonraker_overview(
     for i, k in enumerate(instance_map):
         mr_name = instance_map.get(k)
         m = f"<-> {mr_name}" if mr_name != "" else ""
-        line = Color.apply(f"{f'{i + 1})' if show_index else '●'} {k} {m}", Color.CYAN)
-        dialog += f"║ {line:<63}║\n"
+        line = f"{COLOR_CYAN}{f'{i})' if show_index else '●'} {k} {m} {RESET_FORMAT}"
+        dialog += f"| {line:<63}|\n"
 
-    warn_l1 = Color.apply("PLEASE NOTE:", Color.YELLOW)
-    warn_l2 = Color.apply(
-        "If you select an instance with an existing Moonraker", Color.YELLOW
-    )
-    warn_l3 = Color.apply(
-        "instance, that Moonraker instance will be re-created!", Color.YELLOW
-    )
+    warn_l1 = f"{COLOR_YELLOW}PLEASE NOTE: {RESET_FORMAT}"
+    warn_l2 = f"{COLOR_YELLOW}If you select an instance with an existing Moonraker{RESET_FORMAT}"
+    warn_l3 = f"{COLOR_YELLOW}instance, that Moonraker instance will be re-created!{RESET_FORMAT}"
     warning = textwrap.dedent(
         f"""
-        ║                                                       ║
-        ╟───────────────────────────────────────────────────────╢
-        ║ {warn_l1:<63}║
-        ║ {warn_l2:<63}║
-        ║ {warn_l3:<63}║
-        ╟───────────────────────────────────────────────────────╢
+        |                                                       |
+        |-------------------------------------------------------|
+        | {warn_l1:<63}|
+        | {warn_l2:<63}|
+        | {warn_l3:<63}|
         """
     )[1:]
 

kiauh/components/moonraker/moonraker_remove.py

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

kiauh/components/moonraker/moonraker_setup.py

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

kiauh/components/moonraker/moonraker_utils.py

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

kiauh/components/moonraker/services/moonraker_instance_service.py

@@ -1,49 +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
-
-from typing import Dict, List
-
-from components.moonraker.moonraker import Moonraker
-from utils.instance_utils import get_instances
-
-
-class MoonrakerInstanceService:
-    __cls_instance = None
-    __instances: List[Moonraker] = []
-
-    def __new__(cls) -> "MoonrakerInstanceService":
-        if cls.__cls_instance is None:
-            cls.__cls_instance = super(MoonrakerInstanceService, cls).__new__(cls)
-        return cls.__cls_instance
-
-    def __init__(self) -> None:
-        if not hasattr(self, "__initialized"):
-            self.__initialized = False
-        if self.__initialized:
-            return
-        self.__initialized = True
-
-    def load_instances(self) -> None:
-        self.__instances = get_instances(Moonraker)
-
-    def create_new_instance(self, suffix: str) -> Moonraker:
-        instance = Moonraker(suffix)
-        self.__instances.append(instance)
-        return instance
-
-    def get_all_instances(self) -> List[Moonraker]:
-        return self.__instances
-
-    def get_instance_by_suffix(self, suffix: str) -> Moonraker | None:
-        instances: List[Moonraker] = [i for i in self.__instances if i.suffix == suffix]
-        return instances[0] if instances else None
-
-    def get_instance_port_map(self) -> Dict[str, int]:
-        return {i.suffix: i.port for i in self.__instances}

kiauh/components/moonraker/services/moonraker_setup_service.py

@@ -1,408 +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
-
-from copy import copy
-from subprocess import DEVNULL, PIPE, CalledProcessError, run
-from typing import List
-
-from components.klipper.klipper import Klipper
-from components.klipper.klipper_dialogs import print_instance_overview
-from components.klipper.services.klipper_instance_service import KlipperInstanceService
-from components.moonraker import (
-    EXIT_MOONRAKER_SETUP,
-    MOONRAKER_DIR,
-    MOONRAKER_ENV_DIR,
-    MOONRAKER_REPO_URL,
-    MOONRAKER_REQ_FILE,
-    MOONRAKER_SPEEDUPS_REQ_FILE,
-    POLKIT_FILE,
-    POLKIT_LEGACY_FILE,
-    POLKIT_SCRIPT,
-    POLKIT_USR_FILE,
-)
-from components.moonraker.moonraker import Moonraker
-from components.moonraker.moonraker_dialogs import print_moonraker_overview
-from components.moonraker.services.moonraker_instance_service import (
-    MoonrakerInstanceService,
-)
-from components.moonraker.utils.utils import (
-    backup_moonraker_dir,
-    create_example_moonraker_conf,
-    install_moonraker_packages,
-    remove_polkit_rules,
-)
-from components.webui_client.client_utils import (
-    enable_mainsail_remotemode,
-    get_existing_clients,
-)
-from components.webui_client.mainsail_data import MainsailData
-from core.instance_manager.instance_manager import InstanceManager
-from core.logger import DialogType, Logger
-from core.services.message_service import Message, MessageService
-from core.settings.kiauh_settings import KiauhSettings
-from core.types.color import Color
-from utils.common import check_install_dependencies
-from utils.fs_utils import check_file_exist, run_remove_routines
-from utils.git_utils import git_clone_wrapper, git_pull_wrapper
-from utils.input_utils import (
-    get_confirm,
-    get_selection_input,
-)
-from utils.sys_utils import (
-    check_python_version,
-    cmd_sysctl_manage,
-    cmd_sysctl_service,
-    create_python_venv,
-    get_ipv4_addr,
-    install_python_requirements,
-    unit_file_exists,
-)
-
-
-# noinspection PyMethodMayBeStatic
-class MoonrakerSetupService:
-    __cls_instance = None
-
-    kisvc: KlipperInstanceService
-    misvc: MoonrakerInstanceService
-    msgsvc = MessageService
-
-    settings: KiauhSettings
-    klipper_list: List[Klipper]
-    moonraker_list: List[Moonraker]
-
-    def __new__(cls) -> "MoonrakerSetupService":
-        if cls.__cls_instance is None:
-            cls.__cls_instance = super(MoonrakerSetupService, cls).__new__(cls)
-        return cls.__cls_instance
-
-    def __init__(self) -> None:
-        if not hasattr(self, "__initialized"):
-            self.__initialized = False
-        if self.__initialized:
-            return
-        self.__initialized = True
-        self.__init_state()
-
-    def __init_state(self) -> None:
-        self.settings = KiauhSettings()
-
-        self.kisvc = KlipperInstanceService()
-        self.kisvc.load_instances()
-        self.klipper_list = self.kisvc.get_all_instances()
-
-        self.misvc = MoonrakerInstanceService()
-        self.misvc.load_instances()
-        self.moonraker_list = self.misvc.get_all_instances()
-
-        self.msgsvc = MessageService()
-
-    def __refresh_state(self) -> None:
-        self.kisvc.load_instances()
-        self.klipper_list = self.kisvc.get_all_instances()
-
-        self.misvc.load_instances()
-        self.moonraker_list = self.misvc.get_all_instances()
-
-    def install(self) -> None:
-        self.__refresh_state()
-
-        if not self.__check_requirements(self.klipper_list):
-            return
-
-        new_instances: List[Moonraker] = []
-        selected_option: str | Klipper
-
-        if len(self.klipper_list) == 1:
-            suffix: str = self.klipper_list[0].suffix
-            new_inst = self.misvc.create_new_instance(suffix)
-            new_instances.append(new_inst)
-
-        else:
-            print_moonraker_overview(
-                self.klipper_list,
-                self.moonraker_list,
-                show_index=True,
-                show_select_all=True,
-            )
-            options = {str(i + 1): k for i, k in enumerate(self.klipper_list)}
-            additional_options = {"a": None, "b": None}
-            options = {**options, **additional_options}
-            question = "Select Klipper instance to setup Moonraker for"
-            selected_option = get_selection_input(question, options)
-
-            if selected_option == "b":
-                Logger.print_status(EXIT_MOONRAKER_SETUP)
-                return
-
-            if selected_option == "a":
-                new_inst_list: List[Moonraker] = [
-                    self.misvc.create_new_instance(k.suffix) for k in self.klipper_list
-                ]
-                new_instances.extend(new_inst_list)
-            else:
-                klipper_instance: Klipper | None = options.get(selected_option)
-                if klipper_instance is None:
-                    raise Exception("Error selecting instance!")
-                new_inst = self.misvc.create_new_instance(klipper_instance.suffix)
-                new_instances.append(new_inst)
-
-        create_example_cfg = get_confirm("Create example moonraker.conf?")
-
-        try:
-            self.__run_setup(new_instances, create_example_cfg)
-        except Exception as e:
-            Logger.print_error(f"Error while installing Moonraker: {e}")
-            return
-
-    def update(self) -> None:
-        Logger.print_dialog(
-            DialogType.WARNING,
-            [
-                "Be careful if there are ongoing prints running!",
-                "All Moonraker instances will be restarted during the update process and "
-                "ongoing prints COULD FAIL.",
-            ],
-        )
-
-        if not get_confirm("Update Moonraker now?"):
-            return
-
-        self.__refresh_state()
-
-        if self.settings.kiauh.backup_before_update:
-            backup_moonraker_dir()
-
-        InstanceManager.stop_all(self.moonraker_list)
-        git_pull_wrapper(MOONRAKER_DIR)
-        install_moonraker_packages()
-        install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
-        InstanceManager.start_all(self.moonraker_list)
-
-    def remove(
-        self,
-        remove_service: bool,
-        remove_dir: bool,
-        remove_env: bool,
-        remove_polkit: bool,
-    ) -> None:
-        self.__refresh_state()
-
-        completion_msg = Message(
-            title="Moonraker Removal Process completed",
-            color=Color.GREEN,
-        )
-
-        if remove_service:
-            Logger.print_status("Removing Moonraker instances ...")
-            if self.moonraker_list:
-                instances_to_remove = self.__get_instances_to_remove()
-                self.__remove_instances(instances_to_remove)
-                if instances_to_remove:
-                    instance_names = [
-                        i.service_file_path.stem for i in instances_to_remove
-                    ]
-                    txt = f"● Moonraker instances removed: {', '.join(instance_names)}"
-                    completion_msg.text.append(txt)
-            else:
-                Logger.print_info("No Moonraker Services installed! Skipped ...")
-
-        if (remove_polkit or remove_dir or remove_env) and unit_file_exists(
-            "moonraker", suffix="service"
-        ):
-            completion_msg.text = [
-                "Some Klipper services are still installed:",
-                "● Moonraker PolicyKit rules were not removed, even though selected for removal.",
-                f"● '{MOONRAKER_DIR}' was not removed, even though selected for removal.",
-                f"● '{MOONRAKER_ENV_DIR}' was not removed, even though selected for removal.",
-            ]
-        else:
-            if remove_polkit:
-                Logger.print_status("Removing all Moonraker policykit rules ...")
-                if remove_polkit_rules():
-                    completion_msg.text.append("● Moonraker policykit rules removed")
-            if remove_dir:
-                Logger.print_status("Removing Moonraker local repository ...")
-                if run_remove_routines(MOONRAKER_DIR):
-                    completion_msg.text.append("● Moonraker local repository removed")
-            if remove_env:
-                Logger.print_status("Removing Moonraker Python environment ...")
-                if run_remove_routines(MOONRAKER_ENV_DIR):
-                    completion_msg.text.append("● Moonraker Python environment removed")
-
-        if completion_msg.text:
-            completion_msg.text.insert(0, "The following actions were performed:")
-        else:
-            completion_msg.color = Color.YELLOW
-            completion_msg.centered = True
-            completion_msg.text = ["Nothing to remove."]
-
-        self.msgsvc.set_message(completion_msg)
-
-    def __run_setup(
-        self, new_instances: List[Moonraker], create_example_cfg: bool
-    ) -> None:
-        check_install_dependencies()
-        self.__install_deps()
-
-        ports_map = self.misvc.get_instance_port_map()
-        for i in new_instances:
-            i.create()
-            cmd_sysctl_service(i.service_file_path.name, "enable")
-
-            if create_example_cfg:
-                # if a webclient and/or it's config is installed, patch
-                # its update section to the config
-                clients = get_existing_clients()
-                create_example_moonraker_conf(i, ports_map, clients)
-
-            cmd_sysctl_service(i.service_file_path.name, "start")
-
-        cmd_sysctl_manage("daemon-reload")
-
-        # if mainsail is installed, and we installed
-        # multiple moonraker instances, we enable mainsails remote mode
-        if MainsailData().client_dir.exists() and len(self.moonraker_list) > 1:
-            enable_mainsail_remotemode()
-
-        self.misvc.load_instances()
-        new_instances = [
-            self.misvc.get_instance_by_suffix(i.suffix) for i in new_instances
-        ]
-
-        ip: str = get_ipv4_addr()
-        # noinspection HttpUrlsUsage
-        url_list = [
-            f"● {i.service_file_path.stem}: http://{ip}:{i.port}"
-            for i in new_instances
-            if i.port
-        ]
-        dialog_content = []
-        if url_list:
-            dialog_content.append("You can access Moonraker via the following URL:")
-            dialog_content.extend(url_list)
-
-        Logger.print_dialog(
-            DialogType.CUSTOM,
-            custom_title="Moonraker successfully installed!",
-            custom_color=Color.GREEN,
-            content=dialog_content,
-        )
-
-    def __check_requirements(self, klipper_list: List[Klipper]) -> bool:
-        is_klipper_installed = len(klipper_list) >= 1
-        if not is_klipper_installed:
-            Logger.print_warn("Klipper not installed!")
-            Logger.print_warn("Moonraker cannot be installed! Install Klipper first.")
-
-        is_python_ok = check_python_version(3, 7)
-
-        return is_klipper_installed and is_python_ok
-
-    def __install_deps(self) -> None:
-        default_repo = (MOONRAKER_REPO_URL, "master")
-        repo = self.settings.moonraker.repositories
-        # pull the first repo defined in kiauh.cfg or fallback to the official Moonraker repo
-        repo, branch = (repo[0].url, repo[0].branch) if repo else default_repo
-        git_clone_wrapper(repo, MOONRAKER_DIR, branch)
-
-        try:
-            install_moonraker_packages()
-            if create_python_venv(MOONRAKER_ENV_DIR, False, False, self.settings.moonraker.use_python_binary):
-                install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
-                if self.settings.moonraker.optional_speedups:
-                    install_python_requirements(
-                        MOONRAKER_ENV_DIR, MOONRAKER_SPEEDUPS_REQ_FILE
-                    )
-            self.__install_polkit()
-        except Exception:
-            Logger.print_error("Error during installation of Moonraker requirements!")
-            raise
-
-    def __install_polkit(self) -> None:
-        Logger.print_status("Installing Moonraker policykit rules ...")
-
-        legacy_file_exists = check_file_exist(POLKIT_LEGACY_FILE, True)
-        polkit_file_exists = check_file_exist(POLKIT_FILE, True)
-        usr_file_exists = check_file_exist(POLKIT_USR_FILE, True)
-
-        if legacy_file_exists or (polkit_file_exists and usr_file_exists):
-            Logger.print_info("Moonraker policykit rules are already installed.")
-            return
-
-        try:
-            command = [POLKIT_SCRIPT, "--disable-systemctl"]
-            result = run(
-                command,
-                stderr=PIPE,
-                stdout=DEVNULL,
-                text=True,
-            )
-            if result.returncode != 0 or result.stderr:
-                Logger.print_error(f"{result.stderr}", False)
-                Logger.print_error("Installing Moonraker policykit rules failed!")
-                return
-
-            Logger.print_ok("Moonraker policykit rules successfully installed!")
-        except CalledProcessError as e:
-            log = (
-                f"Error while installing Moonraker policykit rules: {e.stderr.decode()}"
-            )
-            Logger.print_error(log)
-
-    def __get_instances_to_remove(self) -> List[Moonraker] | None:
-        start_index = 1
-        curr_instances: List[Moonraker] = self.moonraker_list
-        instance_count = len(curr_instances)
-
-        options = [str(i + start_index) for i in range(instance_count)]
-        options.extend(["a", "b"])
-        instance_map = {
-            options[i]: self.moonraker_list[i] for i in range(instance_count)
-        }
-
-        print_instance_overview(
-            self.moonraker_list,
-            start_index=start_index,
-            show_index=True,
-            show_select_all=True,
-        )
-        selection = get_selection_input("Select Moonraker instance to remove", options)
-
-        if selection == "b":
-            return None
-        elif selection == "a":
-            return copy(self.moonraker_list)
-
-        return [instance_map[selection]]
-
-    def __remove_instances(
-        self,
-        instance_list: List[Moonraker] | None,
-    ) -> None:
-        if not instance_list:
-            return
-
-        for instance in instance_list:
-            Logger.print_status(
-                f"Removing instance {instance.service_file_path.stem} ..."
-            )
-            InstanceManager.remove(instance)
-            self.__delete_env_file(instance)
-
-        self.__refresh_state()
-
-    def __delete_env_file(self, instance: Moonraker):
-        Logger.print_status(f"Remove '{instance.env_file}'")
-        if not instance.env_file.exists():
-            msg = f"Env file in {instance.base.sysd_dir} not found. Skipped ..."
-            Logger.print_info(msg)
-            return
-        run_remove_routines(instance.env_file)

kiauh/components/moonraker/utils/sysdeps_parser.py

@@ -1,179 +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                                          #
-#  It was modified by Dominik Willner <th33xitus@gmail.com>               #
-#                                                                         #
-#  The original file is part of Moonraker:                                #
-#  https://github.com/Arksine/moonraker                                   #
-#  Copyright (C) 2025 Eric Callahan <arksine.code@gmail.com>              #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from __future__ import annotations
-
-import logging
-import pathlib
-import re
-import shlex
-from typing import Any, Dict, List, Tuple
-
-
-def _get_distro_info() -> Dict[str, Any]:
-    release_file = pathlib.Path("/etc/os-release")
-    release_info: Dict[str, str] = {}
-    with release_file.open("r") as f:
-        lexer = shlex.shlex(f, posix=True)
-        lexer.whitespace_split = True
-        for item in list(lexer):
-            if "=" in item:
-                key, val = item.split("=", maxsplit=1)
-                release_info[key] = val
-    return dict(
-        distro_id=release_info.get("ID", ""),
-        distro_version=release_info.get("VERSION_ID", ""),
-        aliases=release_info.get("ID_LIKE", "").split(),
-    )
-
-
-def _convert_version(version: str) -> Tuple[str | int, ...]:
-    version = version.strip()
-    ver_match = re.match(r"\d+(\.\d+)*((?:-|\.).+)?", version)
-    if ver_match is not None:
-        return tuple(
-            [
-                int(part) if part.isdigit() else part
-                for part in re.split(r"\.|-", version)
-            ]
-        )
-    return (version,)
-
-
-class SysDepsParser:
-    def __init__(self, distro_info: Dict[str, Any] | None = None) -> None:
-        if distro_info is None:
-            distro_info = _get_distro_info()
-        self.distro_id: str = distro_info.get("distro_id", "")
-        self.aliases: List[str] = distro_info.get("aliases", [])
-        self.distro_version: Tuple[int | str, ...] = tuple()
-        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)
-        if len(parts) == 1:
-            return full_spec
-        pkg_name = parts[0].strip()
-        expressions = re.split(r"( and | or )", parts[1].strip())
-        if not len(expressions) & 1:
-            # There should always be an odd number of expressions.  Each
-            # expression is separated by an "and" or "or" operator
-            logging.info(
-                f"Requirement specifier is missing an expression "
-                f"between logical operators : {full_spec}"
-            )
-            return None
-        last_result: bool = True
-        last_logical_op: str | None = "and"
-        for idx, exp in enumerate(expressions):
-            if idx & 1:
-                if last_logical_op is not None:
-                    logging.info(
-                        "Requirement specifier contains sequential logical "
-                        f"operators: {full_spec}"
-                    )
-                    return None
-                logical_op = exp.strip()
-                if logical_op not in ("and", "or"):
-                    logging.info(
-                        f"Invalid logical operator {logical_op} in requirement "
-                        f"specifier: {full_spec}"
-                    )
-                    return None
-                last_logical_op = logical_op
-                continue
-            elif last_logical_op is None:
-                logging.info(
-                    f"Requirement specifier contains two seqential expressions "
-                    f"without a logical operator: {full_spec}"
-                )
-                return None
-            dep_parts = re.split(r"(==|!=|<=|>=|<|>)", exp.strip())
-            req_var = dep_parts[0].strip().lower()
-            if len(dep_parts) != 3:
-                logging.info(f"Invalid comparison, must be 3 parts: {full_spec}")
-                return None
-            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(
-                        "Distro Version not detected, cannot satisfy requirement: "
-                        f"{full_spec}"
-                    )
-                    return None
-                left_op = self.distro_version
-                right_op = _convert_version(dep_parts[2].strip().strip("\"'"))
-            else:
-                logging.info(f"Invalid requirement specifier: {full_spec}")
-                return None
-            operator = dep_parts[1].strip()
-            try:
-                compfunc = {
-                    "<": lambda x, y: x < y,
-                    ">": lambda x, y: x > y,
-                    "==": lambda x, y: x == y,
-                    "!=": lambda x, y: x != y,
-                    ">=": lambda x, y: x >= y,
-                    "<=": lambda x, y: x <= y,
-                }.get(operator, lambda x, y: False)
-                result = compfunc(left_op, right_op)
-                if last_logical_op == "and":
-                    last_result &= result
-                else:
-                    last_result |= result
-                last_logical_op = None
-            except Exception:
-                logging.exception(f"Error comparing requirements: {full_spec}")
-                return None
-        if last_result:
-            return pkg_name
-        return None
-
-    def parse_dependencies(self, sys_deps: Dict[str, List[str]]) -> List[str]:
-        if not self.distro_id:
-            logging.info(
-                "Failed to detect current distro ID, cannot parse dependencies"
-            )
-            return []
-        all_ids = [self.distro_id] + self.aliases
-        for distro_id in all_ids:
-            if distro_id in sys_deps:
-                if not sys_deps[distro_id]:
-                    logging.info(
-                        f"Dependency data contains an empty package definition "
-                        f"for linux distro '{distro_id}'"
-                    )
-                    continue
-                processed_deps: List[str] = []
-                for dep in sys_deps[distro_id]:
-                    parsed_dep = self._parse_spec(dep)
-                    if parsed_dep is not None:
-                        processed_deps.append(parsed_dep)
-                return processed_deps
-        else:
-            logging.info(
-                f"Dependency data has no package definition for linux "
-                f"distro '{self.distro_id}'"
-            )
-        return []

kiauh/components/moonraker/utils/utils.py

@@ -1,228 +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  #
-# ======================================================================= #
-import json
-import shutil
-from pathlib import Path
-from subprocess import DEVNULL, PIPE, CalledProcessError, run
-from typing import Dict, List, Optional
-
-from components.moonraker import (
-    MODULE_PATH,
-    MOONRAKER_DEFAULT_PORT,
-    MOONRAKER_DEPS_JSON_FILE,
-    MOONRAKER_DIR,
-    MOONRAKER_ENV_DIR,
-    MOONRAKER_INSTALL_SCRIPT,
-)
-from components.moonraker.moonraker import Moonraker
-from components.moonraker.utils.sysdeps_parser import SysDepsParser
-from components.webui_client.base_data import BaseWebClient
-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,
-)
-from core.types.component_status import ComponentStatus
-from utils.common import check_install_dependencies, get_install_status
-from utils.instance_utils import get_instances
-from utils.sys_utils import (
-    get_ipv4_addr,
-    parse_packages_from_file,
-)
-
-
-def get_moonraker_status() -> ComponentStatus:
-    return get_install_status(MOONRAKER_DIR, MOONRAKER_ENV_DIR, Moonraker)
-
-
-def install_moonraker_packages() -> None:
-    Logger.print_status("Parsing Moonraker system dependencies  ...")
-
-    moonraker_deps = []
-    if MOONRAKER_DEPS_JSON_FILE.exists():
-        Logger.print_info(
-            f"Parsing system dependencies from {MOONRAKER_DEPS_JSON_FILE.name} ..."
-        )
-        parser = SysDepsParser()
-        sysdeps = load_sysdeps_json(MOONRAKER_DEPS_JSON_FILE)
-        moonraker_deps.extend(parser.parse_dependencies(sysdeps))
-
-    elif MOONRAKER_INSTALL_SCRIPT.exists():
-        Logger.print_warn(f"{MOONRAKER_DEPS_JSON_FILE.name} not found!")
-        Logger.print_info(
-            f"Parsing system dependencies from {MOONRAKER_INSTALL_SCRIPT.name} ..."
-        )
-        moonraker_deps = parse_packages_from_file(MOONRAKER_INSTALL_SCRIPT)
-
-    if not moonraker_deps:
-        raise ValueError("Error parsing Moonraker dependencies!")
-
-    check_install_dependencies({*moonraker_deps})
-
-
-def remove_polkit_rules() -> bool:
-    if not MOONRAKER_DIR.exists():
-        log = "Cannot remove policykit rules. Moonraker directory not found."
-        Logger.print_warn(log)
-        return False
-
-    try:
-        cmd = [f"{MOONRAKER_DIR}/scripts/set-policykit-rules.sh", "--clear"]
-        run(cmd, stderr=PIPE, stdout=DEVNULL, check=True)
-        return True
-    except CalledProcessError as e:
-        Logger.print_error(f"Error while removing policykit rules: {e}")
-        return False
-
-
-def create_example_moonraker_conf(
-    instance: Moonraker,
-    ports_map: Dict[str, int],
-    clients: Optional[List[BaseWebClient]] = None,
-) -> None:
-    Logger.print_status(f"Creating example moonraker.conf in '{instance.base.cfg_dir}'")
-    if instance.cfg_file.is_file():
-        Logger.print_info(f"'{instance.cfg_file}' already exists.")
-        return
-
-    source = MODULE_PATH.joinpath("assets/moonraker.conf")
-    target = instance.cfg_file
-    try:
-        shutil.copy(source, target)
-    except OSError as e:
-        Logger.print_error(f"Unable to create example moonraker.conf:\n{e}")
-        return
-
-    ports = [
-        ports_map.get(instance)
-        for instance in ports_map
-        if ports_map.get(instance) is not None
-    ]
-    if ports_map.get(instance.suffix) is None:
-        # this could be improved to not increment the max value of the ports list and assign it as the port
-        # as it can lead to situation where the port for e.g. instance moonraker-2 becomes 7128 if the port
-        # of moonraker-1 is 7125 and moonraker-3 is 7127 and there are moonraker.conf files for moonraker-1
-        # and moonraker-3 already. though, there does not seem to be a very reliable way of always assigning
-        # the correct port to each instance and the user will likely be required to correct the value manually.
-        port = max(ports) + 1 if ports else MOONRAKER_DEFAULT_PORT
-    else:
-        port = ports_map.get(instance.suffix)
-
-    ports_map[instance.suffix] = port
-
-    ip = get_ipv4_addr().split(".")[:2]
-    ip.extend(["0", "0/16"])
-    uds = instance.base.comms_dir.joinpath("klippy.sock")
-
-    scp = SimpleConfigParser()
-    scp.read_file(target)
-    trusted_clients: List[str] = [
-        f"    {'.'.join(ip)}\n",
-        *scp.getvals("authorization", "trusted_clients"),
-    ]
-
-    scp.set_option("server", "port", str(port))
-    scp.set_option("server", "klippy_uds_address", str(uds))
-    scp.set_option("authorization", "trusted_clients", trusted_clients)
-
-    # add existing client and client configs in the update section
-    if clients is not None and len(clients) > 0:
-        for c in clients:
-            # client part
-            c_section = f"update_manager {c.name}"
-            c_options = [
-                ("type", "web"),
-                ("channel", "stable"),
-                ("repo", c.repo_path),
-                ("path", c.client_dir),
-            ]
-            scp.add_section(section=c_section)
-            for option in c_options:
-                scp.set_option(c_section, option[0], option[1])
-
-            # client config part
-            c_config = c.client_config
-            if c_config.config_dir.exists():
-                c_config_section = f"update_manager {c_config.name}"
-                c_config_options = [
-                    ("type", "git_repo"),
-                    ("primary_branch", "master"),
-                    ("path", c_config.config_dir),
-                    ("origin", c_config.repo_url),
-                    ("managed_services", "klipper"),
-                ]
-                scp.add_section(section=c_config_section)
-                for option in c_config_options:
-                    scp.set_option(c_config_section, option[0], option[1])
-
-    scp.write_file(target)
-    Logger.print_ok(f"Example moonraker.conf created in '{instance.base.cfg_dir}'")
-
-
-def backup_moonraker_dir() -> None:
-    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)
-    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:
-        svc.backup_directory(
-            source_path=instance.db_dir,
-            target_path=f"{instance.data_dir.name}",
-            backup_name="database",
-        )
-
-
-def load_sysdeps_json(file: Path) -> Dict[str, List[str]]:
-    try:
-        sysdeps: Dict[str, List[str]] = json.loads(file.read_bytes())
-    except json.JSONDecodeError as e:
-        Logger.print_error(f"Unable to parse {file.name}:\n{e}")
-        return {}
-    else:
-        return sysdeps

kiauh/components/webui_client/base_data.py

@@ -1,55 +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
-
-from abc import ABC
-from dataclasses import dataclass
-from enum import Enum
-from pathlib import Path
-
-
-class WebClientType(Enum):
-    MAINSAIL: str = "mainsail"
-    FLUIDD: str = "fluidd"
-
-
-class WebClientConfigType(Enum):
-    MAINSAIL: str = "mainsail-config"
-    FLUIDD: str = "fluidd-config"
-
-
-@dataclass()
-class BaseWebClient(ABC):
-    """Base class for webclient data"""
-
-    client: WebClientType
-    name: str
-    display_name: str
-    client_dir: Path
-    config_file: Path
-    repo_path: str
-    download_url: str
-    nginx_config: Path
-    nginx_access_log: Path
-    nginx_error_log: Path
-    client_config: BaseWebClientConfig
-
-
-@dataclass()
-class BaseWebClientConfig(ABC):
-    """Base class for webclient config data"""
-
-    client_config: WebClientConfigType
-    name: str
-    display_name: str
-    config_filename: str
-    config_dir: Path
-    repo_url: str
-    config_section: str

kiauh/components/webui_client/client_config/client_config_remove.py

@@ -1,94 +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 typing import List
-
-from components.klipper.klipper import Klipper
-from components.moonraker.moonraker import Moonraker
-from components.webui_client.base_data import BaseWebClientConfig
-from core.logger import Logger
-from core.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
-from utils.fs_utils import run_remove_routines
-from utils.instance_type import InstanceType
-from utils.instance_utils import get_instances
-
-
-def run_client_config_removal(
-    client_config: BaseWebClientConfig,
-    kl_instances: List[Klipper],
-    mr_instances: List[Moonraker],
-) -> Message:
-    completion_msg = Message(
-        title=f"{client_config.display_name} Removal Process completed",
-        color=Color.GREEN,
-    )
-    Logger.print_status(f"Removing {client_config.display_name} ...")
-    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
-    )
-
-    completion_msg = remove_printer_config_section(
-        completion_msg, client_config, kl_instances
-    )
-
-    if completion_msg.text:
-        completion_msg.text.insert(0, "The following actions were performed:")
-    else:
-        completion_msg.color = Color.YELLOW
-        completion_msg.centered = True
-        completion_msg.text = ["Nothing to remove."]
-
-    return completion_msg
-
-
-def remove_cfg_symlink(client_config: BaseWebClientConfig, message: Message) -> Message:
-    instances: List[Klipper] = get_instances(Klipper)
-    kl_instances = []
-    for instance in instances:
-        cfg = instance.base.cfg_dir.joinpath(client_config.config_filename)
-        if run_remove_routines(cfg):
-            kl_instances.append(instance)
-    text = f"{client_config.display_name} removed from instance"
-    return update_msg(kl_instances, message, text)
-
-
-def remove_printer_config_section(
-    message: Message, client_config: BaseWebClientConfig, kl_instances: List[Klipper]
-) -> Message:
-    kl_section = client_config.config_section
-    kl_instances = remove_config_section(kl_section, kl_instances)
-    text = f"Klipper config section '{kl_section}' removed for instance"
-    return update_msg(kl_instances, message, text)
-
-
-def remove_moonraker_config_section(
-    message: Message, client_config: BaseWebClientConfig, mr_instances: List[Moonraker]
-) -> Message:
-    mr_section = f"update_manager {client_config.name}"
-    mr_instances = remove_config_section(mr_section, mr_instances)
-    text = f"Moonraker config section '{mr_section}' removed for instance"
-    return update_msg(mr_instances, message, text)
-
-
-def update_msg(instances: List[InstanceType], message: Message, text: str) -> Message:
-    if not instances:
-        return message
-
-    instance_names = [i.service_file_path.stem for i in instances]
-    message.text.append(f"● {text}: {', '.join(instance_names)}")
-    return message

kiauh/components/webui_client/client_config/client_config_setup.py

@@ -1,126 +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
-import subprocess
-from pathlib import Path
-from typing import List
-
-from components.klipper.klipper import Klipper
-from components.moonraker.moonraker import Moonraker
-from components.webui_client.base_data import BaseWebClient, BaseWebClientConfig
-from components.webui_client.client_dialogs import (
-    print_client_already_installed_dialog,
-)
-from components.webui_client.client_utils import (
-    backup_client_config_data,
-    detect_client_cfg_conflict,
-)
-from core.instance_manager.instance_manager import InstanceManager
-from core.logger import Logger
-from core.services.backup_service import BackupService
-from core.settings.kiauh_settings import KiauhSettings
-from utils.config_utils import add_config_section, add_config_section_at_top
-from utils.fs_utils import create_symlink
-from utils.git_utils import git_clone_wrapper, git_pull_wrapper
-from utils.input_utils import get_confirm
-from utils.instance_utils import get_instances
-
-
-def install_client_config(client_data: BaseWebClient, cfg_backup=True) -> None:
-    client_config: BaseWebClientConfig = client_data.client_config
-    display_name = client_config.display_name
-
-    if detect_client_cfg_conflict(client_data):
-        Logger.print_info("Another Client-Config is already installed! Skipped ...")
-        return
-
-    if client_config.config_dir.exists():
-        print_client_already_installed_dialog(display_name)
-        if get_confirm(f"Re-install {display_name}?", allow_go_back=True):
-            shutil.rmtree(client_config.config_dir)
-        else:
-            return
-
-    mr_instances: List[Moonraker] = get_instances(Moonraker)
-    kl_instances = get_instances(Klipper)
-
-    try:
-        download_client_config(client_config)
-        create_client_config_symlink(client_config, kl_instances)
-
-        if cfg_backup:
-            BackupService().backup_printer_config_dir()
-
-        add_config_section(
-            section=f"update_manager {client_config.name}",
-            instances=mr_instances,
-            options=[
-                ("type", "git_repo"),
-                ("primary_branch", "master"),
-                ("path", str(client_config.config_dir)),
-                ("origin", str(client_config.repo_url)),
-                ("managed_services", "klipper"),
-            ],
-        )
-        add_config_section_at_top(client_config.config_section, kl_instances)
-        InstanceManager.restart_all(kl_instances)
-
-    except Exception as e:
-        Logger.print_error(f"{display_name} installation failed!\n{e}")
-        return
-
-    Logger.print_ok(f"{display_name} installation complete!", start="\n")
-
-
-def download_client_config(client_config: BaseWebClientConfig) -> None:
-    try:
-        Logger.print_status(f"Downloading {client_config.display_name} ...")
-        repo = client_config.repo_url
-        target_dir = client_config.config_dir
-        git_clone_wrapper(repo, target_dir)
-    except Exception:
-        Logger.print_error(f"Downloading {client_config.display_name} failed!")
-        raise
-
-
-def update_client_config(client: BaseWebClient) -> None:
-    client_config: BaseWebClientConfig = client.client_config
-
-    Logger.print_status(f"Updating {client_config.display_name} ...")
-
-    if not client_config.config_dir.exists():
-        Logger.print_info(
-            f"Unable to update {client_config.display_name}. Directory does not exist! Skipping ..."
-        )
-        return
-
-    settings = KiauhSettings()
-    if settings.kiauh.backup_before_update:
-        backup_client_config_data(client)
-
-    git_pull_wrapper(client_config.config_dir)
-
-    Logger.print_ok(f"Successfully updated {client_config.display_name}.")
-    Logger.print_info("Restart Klipper to reload the configuration!")
-
-
-def create_client_config_symlink(
-    client_config: BaseWebClientConfig, klipper_instances: List[Klipper]
-) -> None:
-    for instance in klipper_instances:
-        Logger.print_status(f"Create symlink for {client_config.config_filename} ...")
-        source = Path(client_config.config_dir, client_config.config_filename)
-        target = instance.base.cfg_dir
-        Logger.print_status(f"Linking {source} to {target}")
-        try:
-            create_symlink(source, target)
-        except subprocess.CalledProcessError:
-            Logger.print_error("Creating symlink failed!")

kiauh/components/webui_client/client_dialogs.py

@@ -1,93 +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 typing import List
-
-from components.webui_client.base_data import BaseWebClient
-from core.logger import DialogType, Logger
-
-
-def print_moonraker_not_found_dialog(name: str) -> None:
-    Logger.print_dialog(
-        DialogType.WARNING,
-        [
-            "No local Moonraker installation was found!",
-            "\n\n",
-            f"It is possible to install {name} without a local Moonraker installation. "
-            "If you continue, you need to make sure, that Moonraker is installed on "
-            f"another machine in your network. Otherwise {name} will NOT work "
-            "correctly.",
-        ],
-    )
-
-
-def print_client_already_installed_dialog(name: str) -> None:
-    Logger.print_dialog(
-        DialogType.WARNING,
-        [
-            f"{name} seems to be already installed!",
-            f"If you continue, your current {name} installation will be overwritten.",
-        ],
-    )
-
-
-def print_client_port_select_dialog(
-    name: str, port: int, ports_in_use: List[int]
-) -> None:
-    dialog_content: List[str] = [
-        f"Please select the port, {name} should be served on. If your are unsure "
-        f"what to select, hit Enter to apply the suggested value of: {port}",
-        "\n\n",
-        f"In case you need {name} to be served on a specific port, you can set it "
-        f"now. Make sure that the port is not already used by another application "
-        f"on your system!",
-    ]
-
-    if ports_in_use:
-        dialog_content.extend(
-            [
-                "\n\n",
-                "The following ports were found to be already in use:",
-                *[f"● {p}" for p in ports_in_use if p != port],
-            ]
-        )
-
-    Logger.print_dialog(DialogType.CUSTOM, dialog_content)
-
-
-def print_install_client_config_dialog(client: BaseWebClient) -> None:
-    name = client.display_name
-    url = client.client_config.repo_url.replace(".git", "")
-    Logger.print_dialog(
-        DialogType.INFO,
-        [
-            f"It is recommended to use special macros in order to have {name} fully "
-            f"functional and working.",
-            "\n\n",
-            f"The recommended macros for {name} can be seen here:",
-            url,
-            "\n\n",
-            "If you already use these macros skip this step. Otherwise you should "
-            "consider to answer with 'Y' to download the recommended macros.",
-        ],
-    )
-
-
-def print_ipv6_warning_dialog() -> None:
-    Logger.print_dialog(
-        DialogType.WARNING,
-        [
-            "It looks like IPv6 is enabled on this system!",
-            "This may cause issues with the installation of NGINX in the following "
-            "steps! It is recommended to disable IPv6 on your system to avoid this issue.",
-            "\n\n",
-            "If you think this warning is a false alarm, and you are sure that "
-            "IPv6 is disabled, you can continue with the installation.",
-        ],
-    )

kiauh/components/webui_client/client_remove.py

@@ -1,124 +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 typing import List
-
-from components.klipper.klipper import Klipper
-from components.moonraker.moonraker import Moonraker
-from components.webui_client.base_data import (
-    BaseWebClient,
-)
-from components.webui_client.client_config.client_config_remove import (
-    run_client_config_removal,
-)
-from core.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
-from utils.fs_utils import (
-    remove_with_sudo,
-    run_remove_routines,
-)
-from utils.instance_utils import get_instances
-
-
-def run_client_removal(
-    client: BaseWebClient,
-    remove_client: bool,
-    remove_client_cfg: bool,
-    backup_config: bool,
-) -> Message:
-    completion_msg = Message(
-        title=f"{client.display_name} Removal Process completed",
-        color=Color.GREEN,
-    )
-    mr_instances: List[Moonraker] = get_instances(Moonraker)
-    kl_instances: List[Klipper] = get_instances(Klipper)
-
-    if backup_config:
-        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:
-        client_name = client.name
-        if remove_client_dir(client):
-            completion_msg.text.append(f"● {client.display_name} removed")
-        if remove_client_nginx_config(client_name):
-            completion_msg.text.append("● NGINX config removed")
-        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
-        )
-        if handled_instances:
-            names = [i.service_file_path.stem for i in handled_instances]
-            completion_msg.text.append(
-                f"● Moonraker config section '{section}' removed for instance: {', '.join(names)}"
-            )
-
-    if remove_client_cfg:
-        cfg_completion_msg = run_client_config_removal(
-            client.client_config,
-            kl_instances,
-            mr_instances,
-        )
-        if cfg_completion_msg.color == Color.GREEN:
-            completion_msg.text.extend(cfg_completion_msg.text[1:])
-
-    if not completion_msg.text:
-        completion_msg.color = Color.YELLOW
-        completion_msg.centered = True
-        completion_msg.text.append("Nothing to remove.")
-    else:
-        completion_msg.text.insert(0, "The following actions were performed:")
-
-    return completion_msg
-
-
-def remove_client_dir(client: BaseWebClient) -> bool:
-    Logger.print_status(f"Removing {client.display_name} ...")
-    return run_remove_routines(client.client_dir)
-
-
-def remove_client_nginx_config(name: str) -> bool:
-    Logger.print_status(f"Removing NGINX config for {name.capitalize()} ...")
-    return remove_with_sudo(
-        [
-            NGINX_SITES_AVAILABLE.joinpath(name),
-            NGINX_SITES_ENABLED.joinpath(name),
-        ]
-    )
-
-
-def remove_client_nginx_logs(client: BaseWebClient, instances: List[Klipper]) -> bool:
-    Logger.print_status(f"Removing NGINX logs for {client.display_name} ...")
-
-    files = [client.nginx_access_log, client.nginx_error_log]
-    if instances:
-        for instance in instances:
-            files.append(instance.base.log_dir.joinpath(client.nginx_access_log.name))
-            files.append(instance.base.log_dir.joinpath(client.nginx_error_log.name))
-
-    return remove_with_sudo(files)

kiauh/components/webui_client/client_setup.py

@@ -1,188 +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  #
-# ======================================================================= #
-import shutil
-import tempfile
-from pathlib import Path
-from typing import List
-
-from components.klipper.klipper import Klipper
-from components.moonraker.moonraker import Moonraker
-from components.webui_client import MODULE_PATH
-from components.webui_client.base_data import (
-    BaseWebClient,
-    BaseWebClientConfig,
-    WebClientType,
-)
-from components.webui_client.client_config.client_config_setup import (
-    install_client_config,
-)
-from components.webui_client.client_dialogs import (
-    print_install_client_config_dialog,
-    print_moonraker_not_found_dialog,
-)
-from components.webui_client.client_utils import (
-    copy_common_vars_nginx_cfg,
-    copy_upstream_nginx_cfg,
-    create_nginx_cfg,
-    detect_client_cfg_conflict,
-    enable_mainsail_remotemode,
-    get_client_port_selection,
-    symlink_webui_nginx_log,
-)
-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 check_install_dependencies
-from utils.config_utils import add_config_section
-from utils.fs_utils import unzip
-from utils.input_utils import get_confirm
-from utils.instance_utils import get_instances
-from utils.sys_utils import (
-    cmd_sysctl_service,
-    download_file,
-    get_ipv4_addr,
-)
-
-
-def install_client(
-    client: BaseWebClient,
-    settings: KiauhSettings,
-    reinstall: bool = False,
-) -> None:
-    mr_instances: List[Moonraker] = get_instances(Moonraker)
-
-    enable_remotemode = False
-    if not mr_instances:
-        print_moonraker_not_found_dialog(client.display_name)
-        if not get_confirm(f"Continue {client.display_name} installation?"):
-            return
-
-    # if moonraker is not installed or multiple instances
-    # are installed we enable mainsails remote mode
-    if (
-        client.client == WebClientType.MAINSAIL
-        and not mr_instances
-        or len(mr_instances) > 1
-    ):
-        enable_remotemode = True
-
-    kl_instances = get_instances(Klipper)
-    install_client_cfg = False
-    client_config: BaseWebClientConfig = client.client_config
-    if (
-        kl_instances
-        and not client_config.config_dir.exists()
-        and not detect_client_cfg_conflict(client)
-    ):
-        print_install_client_config_dialog(client)
-        question = f"Download the recommended {client_config.display_name}?"
-        install_client_cfg = get_confirm(question, allow_go_back=False)
-
-    default_port: int = int(settings.get(client.name, "port"))
-    port: int = (
-        default_port if reinstall else get_client_port_selection(client, settings)
-    )
-
-    check_install_dependencies({"nginx"})
-
-    try:
-        download_client(client)
-        if enable_remotemode and client.client == WebClientType.MAINSAIL:
-            enable_mainsail_remotemode()
-
-        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)),
-                ("path", str(client.client_dir)),
-            ],
-        )
-        InstanceManager.restart_all(mr_instances)
-
-        if install_client_cfg and kl_instances:
-            install_client_config(client, False)
-
-        copy_upstream_nginx_cfg()
-        copy_common_vars_nginx_cfg()
-        create_nginx_cfg(
-            display_name=client.display_name,
-            cfg_name=client.name,
-            template_src=MODULE_PATH.joinpath("assets/nginx_cfg"),
-            PORT=port,
-            ROOT_DIR=client.client_dir,
-            NAME=client.name,
-        )
-
-        if kl_instances:
-            symlink_webui_nginx_log(client, kl_instances)
-        cmd_sysctl_service("nginx", "restart")
-
-    except Exception as e:
-        Logger.print_error(e)
-        Logger.print_dialog(
-            DialogType.ERROR,
-            center_content=True,
-            content=[f"{client.display_name} installation failed!"],
-        )
-        return
-
-    # noinspection HttpUrlsUsage
-    Logger.print_dialog(
-        DialogType.CUSTOM,
-        custom_title=f"{client.display_name} installation complete!",
-        custom_color=Color.GREEN,
-        center_content=True,
-        content=[
-            f"Open {client.display_name} now on: http://{get_ipv4_addr()}{'' if port == 80 else f':{port}'}",
-        ],
-    )
-
-
-def download_client(client: BaseWebClient) -> None:
-    zipfile = f"{client.name.lower()}.zip"
-    target = Path().home().joinpath(zipfile)
-    try:
-        Logger.print_status(
-            f"Downloading {client.display_name} from {client.download_url} ..."
-        )
-        download_file(client.download_url, target, True)
-        Logger.print_ok("Download complete!")
-
-        Logger.print_status(f"Extracting {zipfile} ...")
-        unzip(target, client.client_dir)
-        target.unlink(missing_ok=True)
-        Logger.print_ok("OK!")
-
-    except Exception:
-        Logger.print_error(f"Downloading {client.display_name} failed!")
-        raise
-
-
-def update_client(client: BaseWebClient) -> None:
-    Logger.print_status(f"Updating {client.display_name} ...")
-    if not client.client_dir.exists():
-        Logger.print_info(
-            f"Unable to update {client.display_name}. Directory does not exist! Skipping ..."
-        )
-        return
-
-    with tempfile.NamedTemporaryFile(suffix=".json") as tmp_file:
-        Logger.print_status(
-            f"Creating temporary backup of {client.config_file} as {tmp_file.name} ..."
-        )
-        shutil.copy(client.config_file, tmp_file.name)
-        download_client(client)
-        shutil.copy(tmp_file.name, client.config_file)

kiauh/components/webui_client/client_utils.py

@@ -1,466 +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 json
-import re
-import shutil
-from pathlib import Path
-from subprocess import PIPE, CalledProcessError, run
-from typing import List, get_args
-
-from components.klipper.klipper import Klipper
-from components.webui_client import MODULE_PATH
-from components.webui_client.base_data import (
-    BaseWebClient,
-    WebClientType,
-)
-from components.webui_client.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.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,
-)
-from core.types.color import Color
-from core.types.component_status import ComponentStatus
-from utils.common import get_install_status
-from utils.fs_utils import create_symlink, remove_file
-from utils.git_utils import (
-    get_latest_remote_tag,
-    get_latest_unstable_tag,
-)
-from utils.input_utils import get_number_input
-from utils.instance_utils import get_instances
-
-
-def get_client_status(
-    client: BaseWebClient, fetch_remote: bool = False
-) -> ComponentStatus:
-    files = [
-        NGINX_SITES_AVAILABLE.joinpath(client.name),
-        NGINX_CONFD.joinpath("upstreams.conf"),
-        NGINX_CONFD.joinpath("common_vars.conf"),
-    ]
-    comp_status: ComponentStatus = get_install_status(client.client_dir, files=files)
-
-    # if the client dir does not exist, set the status to not
-    # installed even if the other files are present
-    if not client.client_dir.exists():
-        comp_status.status = 0
-
-    comp_status.local = get_local_client_version(client)
-    comp_status.remote = get_remote_client_version(client) if fetch_remote else None
-    return comp_status
-
-
-def get_client_config_status(client: BaseWebClient) -> ComponentStatus:
-    return get_install_status(client.client_config.config_dir)
-
-
-def get_current_client_config() -> str:
-    mainsail, fluidd = MainsailData(), FluiddData()
-    clients: List[BaseWebClient] = [mainsail, fluidd]
-    installed = [c for c in clients if c.client_config.config_dir.exists()]
-
-    if not installed:
-        return Color.apply("-", Color.CYAN)
-    elif len(installed) == 1:
-        cfg = installed[0].client_config
-        return Color.apply(cfg.display_name, Color.CYAN)
-
-    # at this point, both client config folders exists, so we need to check
-    # which are actually included in the printer.cfg of all klipper instances
-    mainsail_includes, fluidd_includes = [], []
-    klipper_instances: List[Klipper] = get_instances(Klipper)
-    for instance in klipper_instances:
-        scp = SimpleConfigParser()
-        scp.read_file(instance.cfg_file)
-        includes_mainsail = scp.has_section(mainsail.client_config.config_section)
-        includes_fluidd = scp.has_section(fluidd.client_config.config_section)
-
-        if includes_mainsail:
-            mainsail_includes.append(instance)
-        if includes_fluidd:
-            fluidd_includes.append(instance)
-
-        # if both are included in the same file, we have a potential conflict
-        if includes_mainsail and includes_fluidd:
-            return Color.apply("Conflict", Color.YELLOW)
-
-    if not mainsail_includes and not fluidd_includes:
-        # there are no includes at all, even though the client config folders exist
-        return Color.apply("-", Color.CYAN)
-    elif len(fluidd_includes) > len(mainsail_includes):
-        # there are more instances that include fluidd than mainsail
-        return Color.apply(fluidd.client_config.display_name, Color.CYAN)
-    else:
-        # there are the same amount of non-conflicting includes for each config
-        # or more instances include mainsail than fluidd
-        return Color.apply(mainsail.client_config.display_name, Color.CYAN)
-
-
-def enable_mainsail_remotemode() -> None:
-    Logger.print_status("Enable Mainsails remote mode ...")
-    c_json = MainsailData().client_dir.joinpath("config.json")
-    with open(c_json, "r") as f:
-        config_data = json.load(f)
-
-    if config_data["instancesDB"] == "browser" or config_data["instancesDB"] == "json":
-        Logger.print_info("Remote mode already configured. Skipped ...")
-        return
-
-    Logger.print_status("Setting instance storage location to 'browser' ...")
-    config_data["instancesDB"] = "browser"
-
-    with open(c_json, "w") as f:
-        json.dump(config_data, f, indent=4)
-    Logger.print_ok("Mainsails remote mode enabled!")
-
-
-def symlink_webui_nginx_log(
-    client: BaseWebClient, klipper_instances: List[Klipper]
-) -> None:
-    Logger.print_status("Link NGINX logs into log directory ...")
-    access_log = client.nginx_access_log
-    error_log = client.nginx_error_log
-
-    for instance in klipper_instances:
-        desti_access = instance.base.log_dir.joinpath(access_log.name)
-        if not desti_access.exists():
-            desti_access.symlink_to(access_log)
-
-        desti_error = instance.base.log_dir.joinpath(error_log.name)
-        if not desti_error.exists():
-            desti_error.symlink_to(error_log)
-
-
-def get_local_client_version(client: BaseWebClient) -> str | None:
-    relinfo_file = client.client_dir.joinpath("release_info.json")
-    version_file = client.client_dir.joinpath(".version")
-
-    if not client.client_dir.exists():
-        return None
-    if not relinfo_file.is_file() and not version_file.is_file():
-        return "n/a"
-
-    if relinfo_file.is_file():
-        with open(relinfo_file, "r") as f:
-            return str(json.load(f)["version"])
-    else:
-        with open(version_file, "r") as f:
-            return f.readlines()[0]
-
-
-def get_remote_client_version(client: BaseWebClient) -> str | None:
-    try:
-        if (tag := get_latest_remote_tag(client.repo_path)) != "":
-            return str(tag)
-        return None
-    except Exception:
-        return None
-
-
-def backup_client_data(client: BaseWebClient) -> None:
-    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_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:
-    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]:
-    clients = list(get_args(WebClientType))
-    installed_clients: List[BaseWebClient] = []
-    for client in clients:
-        if client.client_dir.exists():
-            installed_clients.append(client)
-
-    return installed_clients
-
-
-def detect_client_cfg_conflict(curr_client: BaseWebClient) -> bool:
-    """
-    Check if any other client configs are present on the system.
-    It is usually not harmful, but chances are they can conflict each other.
-    Multiple client configs are, at least, redundant to have them installed
-    :param curr_client: The client name to check for the conflict
-    :return: True, if other client configs were found, else False
-    """
-
-    mainsail_cfg_status: ComponentStatus = get_client_config_status(MainsailData())
-    fluidd_cfg_status: ComponentStatus = get_client_config_status(FluiddData())
-
-    if curr_client.client == WebClientType.MAINSAIL and fluidd_cfg_status.status == 2:
-        return True
-    if curr_client.client == WebClientType.FLUIDD and mainsail_cfg_status.status == 2:
-        return True
-
-    return False
-
-
-def get_download_url(base_url: str, client: BaseWebClient) -> str:
-    settings = KiauhSettings()
-    use_unstable = settings.get(client.name, "unstable_releases")
-    stable_url = f"{base_url}/latest/download/{client.name}.zip"
-
-    if not use_unstable:
-        return stable_url
-
-    try:
-        unstable_tag = get_latest_unstable_tag(client.repo_path)
-        if unstable_tag == "":
-            raise Exception
-        return f"{base_url}/download/{unstable_tag}/{client.name}.zip"
-    except Exception:
-        return stable_url
-
-
-#################################################
-## NGINX RELATED FUNCTIONS
-#################################################
-
-
-def copy_upstream_nginx_cfg() -> None:
-    """
-    Creates an upstream.conf in /etc/nginx/conf.d
-    :return: None
-    """
-    source = MODULE_PATH.joinpath("assets/upstreams.conf")
-    target = NGINX_CONFD.joinpath("upstreams.conf")
-    try:
-        command = ["sudo", "cp", source, target]
-        run(command, stderr=PIPE, check=True)
-    except CalledProcessError as e:
-        log = f"Unable to create upstreams.conf: {e.stderr.decode()}"
-        Logger.print_error(log)
-        raise
-
-
-def copy_common_vars_nginx_cfg() -> None:
-    """
-    Creates a common_vars.conf in /etc/nginx/conf.d
-    :return: None
-    """
-    source = MODULE_PATH.joinpath("assets/common_vars.conf")
-    target = NGINX_CONFD.joinpath("common_vars.conf")
-    try:
-        command = ["sudo", "cp", source, target]
-        run(command, stderr=PIPE, check=True)
-    except CalledProcessError as e:
-        log = f"Unable to create upstreams.conf: {e.stderr.decode()}"
-        Logger.print_error(log)
-        raise
-
-
-def generate_nginx_cfg_from_template(name: str, template_src: Path, **kwargs) -> None:
-    """
-    Creates an NGINX config from a template file and
-    replaces all placeholders passed as kwargs. A placeholder must be defined
-    in the template file as %{placeholder}%.
-    :param name: name of the config to create
-    :param template_src: the path to the template file
-    :return: None
-    """
-    tmp = Path.home().joinpath(f"{name}.tmp")
-    shutil.copy(template_src, tmp)
-    with open(tmp, "r+") as f:
-        content = f.read()
-
-        for key, value in kwargs.items():
-            content = content.replace(f"%{key}%", str(value))
-
-        f.seek(0)
-        f.write(content)
-        f.truncate()
-
-    target = NGINX_SITES_AVAILABLE.joinpath(name)
-    try:
-        command = ["sudo", "mv", tmp, target]
-        run(command, stderr=PIPE, check=True)
-    except CalledProcessError as e:
-        log = f"Unable to create '{target}': {e.stderr.decode()}"
-        Logger.print_error(log)
-        raise
-
-
-def create_nginx_cfg(
-    display_name: str,
-    cfg_name: str,
-    template_src: Path,
-    **kwargs,
-) -> None:
-    from utils.sys_utils import set_nginx_permissions
-
-    try:
-        Logger.print_status(f"Creating NGINX config for {display_name} ...")
-
-        source = NGINX_SITES_AVAILABLE.joinpath(cfg_name)
-        target = NGINX_SITES_ENABLED.joinpath(cfg_name)
-        remove_file(Path("/etc/nginx/sites-enabled/default"), True)
-        generate_nginx_cfg_from_template(cfg_name, template_src=template_src, **kwargs)
-        create_symlink(source, target, True)
-        set_nginx_permissions()
-
-        Logger.print_ok(f"NGINX config for {display_name} successfully created.")
-    except Exception:
-        Logger.print_error(f"Creating NGINX config for {display_name} failed!")
-        raise
-
-
-def get_nginx_config_list() -> List[Path]:
-    """
-    Get a list of all NGINX config files in /etc/nginx/sites-enabled
-    :return: List of NGINX config files
-    """
-    configs: List[Path] = []
-    for config in NGINX_SITES_ENABLED.iterdir():
-        if not config.is_file():
-            continue
-        configs.append(config)
-    return configs
-
-
-def get_nginx_listen_port(config: Path) -> int | None:
-    """
-    Get the listen port from an NGINX config file
-    :param config: The NGINX config file to read the port from
-    :return: The listen port as int or None if not found/parsable
-    """
-
-    # noinspection HttpUrlsUsage
-    pattern = r"default_server|http://|https://|[;\[\]]"
-    port = ""
-    with open(config, "r") as cfg:
-        for line in cfg.readlines():
-            line = re.sub(pattern, "", line.strip())
-            if line.startswith("listen"):
-                if ":" not in line:
-                    port = line.split()[-1]
-                else:
-                    port = line.split(":")[-1]
-        try:
-            return int(port)
-        except ValueError:
-            Logger.print_error(
-                f"Unable to parse listen port {port} from {config.name}!"
-            )
-            return None
-
-
-def read_ports_from_nginx_configs() -> List[int]:
-    """
-    Helper function to iterate over all NGINX configs
-    and read all ports defined for listen
-    :return: A sorted list of listen ports
-    """
-    if not NGINX_SITES_ENABLED.exists():
-        return []
-
-    port_list: List[int] = []
-    for config in get_nginx_config_list():
-        port = get_nginx_listen_port(config)
-        if port is not None:
-            port_list.append(port)
-
-    return sorted(port_list, key=lambda x: int(x))
-
-
-def get_client_port_selection(
-    client: BaseWebClient,
-    settings: KiauhSettings,
-    reconfigure=False,
-) -> int:
-    default_port: int = int(settings.get(client.name, "port"))
-    ports_in_use: List[int] = read_ports_from_nginx_configs()
-    next_free_port: int = get_next_free_port(ports_in_use)
-
-    port: int = (
-        next_free_port
-        if not reconfigure and default_port in ports_in_use
-        else default_port
-    )
-
-    print_client_port_select_dialog(client.display_name, port, ports_in_use)
-
-    while True:
-        _type = "Reconfigure" if reconfigure else "Configure"
-        question = f"{_type} {client.display_name} for port"
-        port_input = get_number_input(question, min_value=80, default=port)
-
-        if port_input not in ports_in_use:
-            client_settings: WebUiSettings = settings[client.name]
-            client_settings.port = port_input
-            settings.save()
-
-            return port_input
-
-        Logger.print_error("This port is already in use. Please select another one.")
-
-
-def get_next_free_port(ports_in_use: List[int]) -> int:
-    valid_ports = set(range(80, 7125))
-    used_ports = set(map(int, ports_in_use))
-
-    return min(valid_ports - used_ports)
-
-
-def set_listen_port(client: BaseWebClient, curr_port: int, new_port: int) -> None:
-    """
-    Set the port the client should listen on in the NGINX config
-    :param curr_port: The current port the client listens on
-    :param new_port: The new port to set
-    :param client: The client to set the port for
-    :return: None
-    """
-    config = NGINX_SITES_AVAILABLE.joinpath(client.name)
-    with open(config, "r") as f:
-        lines = f.readlines()
-
-    for i, line in enumerate(lines):
-        if "listen" in line:
-            lines[i] = line.replace(str(curr_port), str(new_port))
-
-    with open(config, "w") as f:
-        f.writelines(lines)

kiauh/components/webui_client/fluidd_data.py

@@ -1,55 +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
-
-from dataclasses import dataclass
-from pathlib import Path
-
-from components.webui_client.base_data import (
-    BaseWebClient,
-    BaseWebClientConfig,
-    WebClientConfigType,
-    WebClientType,
-)
-from core.constants import NGINX_SITES_AVAILABLE
-
-
-@dataclass()
-class FluiddConfigWeb(BaseWebClientConfig):
-    client_config: WebClientConfigType = WebClientConfigType.FLUIDD
-    name: str = client_config.value
-    display_name: str = name.title()
-    config_dir: Path = Path.home().joinpath("fluidd-config")
-    config_filename: str = "fluidd.cfg"
-    config_section: str = f"include {config_filename}"
-    repo_url: str = "https://github.com/fluidd-core/fluidd-config.git"
-
-
-@dataclass()
-class FluiddData(BaseWebClient):
-    BASE_DL_URL = "https://github.com/fluidd-core/fluidd/releases"
-
-    client: WebClientType = WebClientType.FLUIDD
-    name: str = client.value
-    display_name: str = name.capitalize()
-    client_dir: Path = Path.home().joinpath("fluidd")
-    config_file: Path = client_dir.joinpath("config.json")
-    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")
-    nginx_error_log: Path = Path("/var/log/nginx/fluidd-error.log")
-    client_config: BaseWebClientConfig = None
-    download_url: str | None = None
-
-    def __post_init__(self):
-        from components.webui_client.client_utils import get_download_url
-
-        self.client_config = FluiddConfigWeb()
-        self.download_url = get_download_url(self.BASE_DL_URL, self)

kiauh/components/webui_client/mainsail_data.py

@@ -1,55 +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
-
-from dataclasses import dataclass
-from pathlib import Path
-
-from components.webui_client.base_data import (
-    BaseWebClient,
-    BaseWebClientConfig,
-    WebClientConfigType,
-    WebClientType,
-)
-from core.constants import NGINX_SITES_AVAILABLE
-
-
-@dataclass()
-class MainsailConfigWeb(BaseWebClientConfig):
-    client_config: WebClientConfigType = WebClientConfigType.MAINSAIL
-    name: str = client_config.value
-    display_name: str = name.title()
-    config_dir: Path = Path.home().joinpath("mainsail-config")
-    config_filename: str = "mainsail.cfg"
-    config_section: str = f"include {config_filename}"
-    repo_url: str = "https://github.com/mainsail-crew/mainsail-config.git"
-
-
-@dataclass()
-class MainsailData(BaseWebClient):
-    BASE_DL_URL: str = "https://github.com/mainsail-crew/mainsail/releases"
-
-    client: WebClientType = WebClientType.MAINSAIL
-    name: str = WebClientType.MAINSAIL.value
-    display_name: str = name.capitalize()
-    client_dir: Path = Path.home().joinpath("mainsail")
-    config_file: Path = client_dir.joinpath("config.json")
-    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")
-    nginx_error_log: Path = Path("/var/log/nginx/mainsail-error.log")
-    client_config: BaseWebClientConfig = None
-    download_url: str | None = None
-
-    def __post_init__(self):
-        from components.webui_client.client_utils import get_download_url
-
-        self.client_config = MainsailConfigWeb()
-        self.download_url = get_download_url(self.BASE_DL_URL, self)

kiauh/components/webui_client/menus/client_install_menu.py

@@ -1,105 +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 textwrap
-from typing import Type
-
-from components.webui_client.base_data import BaseWebClient
-from components.webui_client.client_setup import install_client
-from components.webui_client.client_utils import (
-    get_client_port_selection,
-    get_nginx_listen_port,
-    set_listen_port,
-)
-from core.logger import Logger
-from core.menus import Option
-from core.menus.base_menu import BaseMenu
-from core.services.message_service import Message
-from core.settings.kiauh_settings import KiauhSettings, WebUiSettings
-from core.types.color import Color
-from utils.sys_utils import cmd_sysctl_service, get_ipv4_addr
-
-
-# noinspection PyUnusedLocal
-class ClientInstallMenu(BaseMenu):
-    def __init__(
-        self, client: BaseWebClient, previous_menu: Type[BaseMenu] | None = None
-    ):
-        super().__init__()
-        self.title = f"Installation Menu > {client.display_name}"
-        self.title_color = Color.GREEN
-        self.previous_menu: Type[BaseMenu] | None = previous_menu
-        self.client: BaseWebClient = client
-        self.settings = KiauhSettings()
-        self.client_settings: WebUiSettings = self.settings[client.name]
-
-    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        from core.menus.install_menu import InstallMenu
-
-        self.previous_menu = previous_menu if previous_menu is not None else InstallMenu
-
-    def set_options(self) -> None:
-        self.options = {
-            "1": Option(method=self.reinstall_client),
-            "2": Option(method=self.change_listen_port),
-        }
-
-    def print_menu(self) -> None:
-        client_name = self.client.display_name
-        port = f"(Current: {Color.apply(self._get_current_port(), Color.GREEN)})"
-        menu = textwrap.dedent(
-            f"""
-            ╟───────────────────────────────────────────────────────╢
-            ║  1) Reinstall {client_name:16}                        ║
-            ║  2) Reconfigure Listen Port {port:<34} ║
-            ╟───────────────────────────────────────────────────────╢
-            """
-        )[1:]
-        print(menu, end="")
-
-    def reinstall_client(self, **kwargs) -> None:
-        install_client(self.client, settings=self.settings, reinstall=True)
-
-    def change_listen_port(self, **kwargs) -> None:
-        curr_port = self._get_current_port()
-        new_port = get_client_port_selection(
-            self.client,
-            self.settings,
-            reconfigure=True,
-        )
-
-        cmd_sysctl_service("nginx", "stop")
-        set_listen_port(self.client, curr_port, new_port)
-
-        Logger.print_status("Saving new port configuration ...")
-        self.client_settings.port = new_port
-        self.settings.save()
-        Logger.print_ok("Port configuration saved!")
-
-        cmd_sysctl_service("nginx", "start")
-
-        # noinspection HttpUrlsUsage
-        message = Message(
-            title="Port reconfiguration complete!",
-            text=[
-                f"Open {self.client.display_name} now on: "
-                f"http://{get_ipv4_addr()}:{new_port}",
-            ],
-            color=Color.GREEN,
-        )
-        self.message_service.set_message(message)
-
-    def _get_current_port(self) -> int:
-        curr_port = get_nginx_listen_port(self.client.nginx_config)
-        if curr_port is None:
-            # if the port is not found in the config file we use
-            # the default port from the kiauh settings as fallback
-            return int(self.client_settings.port)
-        return curr_port

kiauh/components/webui_client/menus/client_remove_menu.py

@@ -1,114 +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 textwrap
-from typing import Type
-
-from components.webui_client import client_remove
-from components.webui_client.base_data import BaseWebClient
-from core.menus import Option
-from core.menus.base_menu import BaseMenu
-from core.types.color import Color
-
-
-# noinspection PyUnusedLocal
-class ClientRemoveMenu(BaseMenu):
-    def __init__(
-        self, client: BaseWebClient, previous_menu: Type[BaseMenu] | None = None
-    ):
-        super().__init__()
-        self.title = f"Remove {client.display_name}"
-        self.title_color = Color.RED
-        self.previous_menu: Type[BaseMenu] | None = previous_menu
-        self.client: BaseWebClient = client
-        self.remove_client: bool = False
-        self.remove_client_cfg: bool = False
-        self.backup_config_json: bool = False
-        self.select_state: bool = False
-
-    def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
-        from core.menus.remove_menu import RemoveMenu
-
-        self.previous_menu = previous_menu if previous_menu is not None else RemoveMenu
-
-    def set_options(self) -> None:
-        self.options = {
-            "a": Option(method=self.toggle_all),
-            "1": Option(method=self.toggle_rm_client),
-            "2": Option(method=self.toggle_rm_client_config),
-            "3": Option(method=self.toggle_backup_config_json),
-            "c": Option(method=self.run_removal_process),
-        }
-
-    def print_menu(self) -> None:
-        client_name = self.client.display_name
-        client_config = self.client.client_config
-        client_config_name = client_config.display_name
-
-        checked = f"[{Color.apply('x', Color.CYAN)}]"
-        unchecked = "[ ]"
-        o1 = checked if self.remove_client else unchecked
-        o2 = checked if self.remove_client_cfg else unchecked
-        o3 = checked if self.backup_config_json else unchecked
-        sel_state = f"{'Select' if not self.select_state else 'Deselect'} everything"
-        menu = textwrap.dedent(
-            f"""
-            ╟───────────────────────────────────────────────────────╢
-            ║ Enter a number and hit enter to select / deselect     ║
-            ║ the specific option for removal.                      ║
-            ╟───────────────────────────────────────────────────────╢
-            ║  a) {sel_state:49} ║
-            ╟───────────────────────────────────────────────────────╢
-            ║  1) {o1} Remove {client_name:16}                       ║
-            ║  2) {o2} Remove {client_config_name:24}               ║
-            ║  3) {o3} Backup config.json                            ║
-            ╟───────────────────────────────────────────────────────╢
-            ║  C) Continue                                          ║
-            ╟───────────────────────────────────────────────────────╢
-            """
-        )[1:]
-        print(menu, end="")
-
-    def toggle_all(self, **kwargs) -> None:
-        self.select_state = not self.select_state
-        self.remove_client = self.select_state
-        self.remove_client_cfg = self.select_state
-        self.backup_config_json = self.select_state
-
-    def toggle_rm_client(self, **kwargs) -> None:
-        self.remove_client = not self.remove_client
-
-    def toggle_rm_client_config(self, **kwargs) -> None:
-        self.remove_client_cfg = not self.remove_client_cfg
-
-    def toggle_backup_config_json(self, **kwargs) -> None:
-        self.backup_config_json = not self.backup_config_json
-
-    def run_removal_process(self, **kwargs) -> None:
-        if (
-            not self.remove_client
-            and not self.remove_client_cfg
-            and not self.backup_config_json
-        ):
-            print(Color.apply("Nothing selected ...", Color.RED))
-            return
-
-        completion_msg = client_remove.run_client_removal(
-            client=self.client,
-            remove_client=self.remove_client,
-            remove_client_cfg=self.remove_client_cfg,
-            backup_config=self.backup_config_json,
-        )
-        self.message_service.set_message(completion_msg)
-
-        self.remove_client = False
-        self.remove_client_cfg = False
-        self.backup_config_json = False
-        self.select_state = False

kiauh/core/backup_manager/__init__.py

@@ -1,5 +1,7 @@
+#!/usr/bin/env python3
+
 # ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#  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                                          #
@@ -9,4 +11,4 @@
 
 from pathlib import Path
 
-MODULE_PATH = Path(__file__).resolve().parent
+BACKUP_ROOT_DIR = Path.home().joinpath("kiauh-backups")

kiauh/core/backup_manager/backup_manager.py

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

kiauh/core/base_extension.py

@@ -1,5 +1,7 @@
+#!/usr/bin/env python3
+
 # ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#  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                                          #
@@ -7,7 +9,7 @@
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
 
-from abc import ABC, abstractmethod
+from abc import abstractmethod, ABC
 from typing import Dict
 
 
@@ -19,11 +21,12 @@ class BaseExtension(ABC):
 
     @abstractmethod
     def install_extension(self, **kwargs) -> None:
-        raise NotImplementedError
-
-    def update_extension(self, **kwargs) -> None:
-        raise NotImplementedError
+        raise NotImplementedError(
+            "Subclasses must implement the install_extension method"
+        )
 
     @abstractmethod
     def remove_extension(self, **kwargs) -> None:
-        raise NotImplementedError
+        raise NotImplementedError(
+            "Subclasses must implement the remove_extension method"
+        )

kiauh/core/config_manager/config_manager.py

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

kiauh/core/decorators.py

@@ -1,24 +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 warnings
-from typing import Callable
-
-
-def deprecated(info: str = "", replaced_by: Callable | None = None) -> Callable:
-    def decorator(func) -> Callable:
-        def wrapper(*args, **kwargs):
-            msg = f"{info}{replaced_by.__name__ if replaced_by else ''}"
-            warnings.warn(msg, category=DeprecationWarning, stacklevel=2)
-            return func(*args, **kwargs)
-
-        return wrapper
-
-    return decorator

kiauh/core/instance_manager/base_instance.py

@@ -1,5 +1,7 @@
+#!/usr/bin/env python3
+
 # ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#  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                                          #
@@ -7,53 +9,153 @@
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
 
-from __future__ import annotations
-
-import re
-from dataclasses import dataclass, field
+from abc import abstractmethod, ABC
 from pathlib import Path
-from typing import List
+from typing import List, Type, TypeVar
 
-from utils.fs_utils import get_data_dir
+from utils.constants import SYSTEMD, CURRENT_USER
 
-# 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"]
+B = TypeVar(name="B", bound="BaseInstance", covariant=True)
 
-@dataclass(repr=True)
-class BaseInstance:
-    instance_type: type
-    suffix: str
-    log_file_name: str | None = None
-    data_dir: Path = field(init=False)
-    base_folders: List[Path] = field(init=False)
-    cfg_dir: Path = field(init=False)
-    log_dir: Path = field(init=False)
-    gcodes_dir: Path = field(init=False)
-    comms_dir: Path = field(init=False)
-    sysd_dir: Path = field(init=False)
-    is_legacy_instance: bool = field(init=False)
 
-    def __post_init__(self):
-        self.data_dir = get_data_dir(self.instance_type, self.suffix)
-        # the following attributes require the data_dir to be set
-        self.cfg_dir = self.data_dir.joinpath("config")
-        self.log_dir = self.data_dir.joinpath("logs")
-        self.gcodes_dir = self.data_dir.joinpath("gcodes")
-        self.comms_dir = self.data_dir.joinpath("comms")
-        self.sysd_dir = self.data_dir.joinpath("systemd")
-        self.is_legacy_instance = self._set_is_legacy_instance()
-        self.base_folders = [
+class BaseInstance(ABC):
+    @classmethod
+    def blacklist(cls) -> List[str]:
+        return []
+
+    def __init__(
+        self,
+        suffix: str,
+        instance_type: B = B,
+    ):
+        self._instance_type = instance_type
+        self._suffix = suffix
+        self._user = CURRENT_USER
+        self._data_dir_name = self.get_data_dir_name_from_suffix()
+        self._data_dir = Path.home().joinpath(f"{self._data_dir_name}_data")
+        self._cfg_dir = self.data_dir.joinpath("config")
+        self._log_dir = self.data_dir.joinpath("logs")
+        self._comms_dir = self.data_dir.joinpath("comms")
+        self._sysd_dir = self.data_dir.joinpath("systemd")
+        self._gcodes_dir = self.data_dir.joinpath("gcodes")
+
+    @property
+    def instance_type(self) -> Type["BaseInstance"]:
+        return self._instance_type
+
+    @instance_type.setter
+    def instance_type(self, value: Type["BaseInstance"]) -> None:
+        self._instance_type = value
+
+    @property
+    def suffix(self) -> str:
+        return self._suffix
+
+    @suffix.setter
+    def suffix(self, value: str) -> None:
+        self._suffix = value
+
+    @property
+    def user(self) -> str:
+        return self._user
+
+    @user.setter
+    def user(self, value: str) -> None:
+        self._user = value
+
+    @property
+    def data_dir_name(self) -> str:
+        return self._data_dir_name
+
+    @data_dir_name.setter
+    def data_dir_name(self, value: str) -> None:
+        self._data_dir_name = value
+
+    @property
+    def data_dir(self) -> Path:
+        return self._data_dir
+
+    @data_dir.setter
+    def data_dir(self, value: str) -> None:
+        self._data_dir = value
+
+    @property
+    def cfg_dir(self) -> Path:
+        return self._cfg_dir
+
+    @cfg_dir.setter
+    def cfg_dir(self, value: str) -> None:
+        self._cfg_dir = value
+
+    @property
+    def log_dir(self) -> Path:
+        return self._log_dir
+
+    @log_dir.setter
+    def log_dir(self, value: str) -> None:
+        self._log_dir = value
+
+    @property
+    def comms_dir(self) -> Path:
+        return self._comms_dir
+
+    @comms_dir.setter
+    def comms_dir(self, value: str) -> None:
+        self._comms_dir = value
+
+    @property
+    def sysd_dir(self) -> Path:
+        return self._sysd_dir
+
+    @sysd_dir.setter
+    def sysd_dir(self, value: str) -> None:
+        self._sysd_dir = value
+
+    @property
+    def gcodes_dir(self) -> Path:
+        return self._gcodes_dir
+
+    @gcodes_dir.setter
+    def gcodes_dir(self, value: str) -> None:
+        self._gcodes_dir = value
+
+    @abstractmethod
+    def create(self) -> None:
+        raise NotImplementedError("Subclasses must implement the create method")
+
+    @abstractmethod
+    def delete(self) -> None:
+        raise NotImplementedError("Subclasses must implement the delete method")
+
+    def create_folders(self, add_dirs: List[Path] = None) -> None:
+        dirs = [
             self.data_dir,
             self.cfg_dir,
             self.log_dir,
-            self.gcodes_dir,
             self.comms_dir,
             self.sysd_dir,
         ]
 
-    def _set_is_legacy_instance(self) -> bool:
-        legacy_pattern = r"^(?!printer)(.+)_data"
-        match = re.search(legacy_pattern, self.data_dir.name)
+        if add_dirs:
+            dirs.extend(add_dirs)
 
-        return True if (match and self.suffix != "") else False
+        for _dir in dirs:
+            _dir.mkdir(exist_ok=True)
+
+    def get_service_file_name(self, extension: bool = False) -> str:
+        name = f"{self.__class__.__name__.lower()}"
+        if self.suffix != "":
+            name += f"-{self.suffix}"
+
+        return name if not extension else f"{name}.service"
+
+    def get_service_file_path(self) -> Path:
+        return SYSTEMD.joinpath(self.get_service_file_name(extension=True))
+
+    def get_data_dir_name_from_suffix(self) -> str:
+        if self._suffix == "":
+            return "printer"
+        elif self._suffix.isdigit():
+            return f"printer_{self._suffix}"
+        else:
+            return self._suffix

kiauh/core/instance_manager/instance_manager.py

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

kiauh/core/instance_manager/name_scheme.py

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

kiauh/core/logger.py

@@ -1,169 +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 textwrap
-from enum import Enum
-from typing import List
-
-from core.types.color import Color
-
-
-class DialogType(Enum):
-    INFO = ("INFO", Color.WHITE)
-    SUCCESS = ("SUCCESS", Color.GREEN)
-    ATTENTION = ("ATTENTION", Color.YELLOW)
-    WARNING = ("WARNING", Color.YELLOW)
-    ERROR = ("ERROR", Color.RED)
-    CUSTOM = (None, None)
-
-
-LINE_WIDTH = 53
-
-
-BORDER_TOP: str = "┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓"
-BORDER_BOTTOM: str = "┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛"
-BORDER_TITLE: str = "┠───────────────────────────────────────────────────────┨"
-BORDER_LEFT: str = "┃"
-BORDER_RIGHT: str = "┃"
-
-
-class Logger:
-    @staticmethod
-    def print_info(msg, prefix=True, start="", end="\n") -> None:
-        message = f"[INFO] {msg}" if prefix else msg
-        Logger.__print(Color.WHITE, start, message, end)
-
-    @staticmethod
-    def print_ok(msg: str = "Success!", prefix=True, start="", end="\n") -> None:
-        message = f"[OK] {msg}" if prefix else msg
-        Logger.__print(Color.GREEN, start, message, end)
-
-    @staticmethod
-    def print_warn(msg, prefix=True, start="", end="\n") -> None:
-        message = f"[WARN] {msg}" if prefix else msg
-        Logger.__print(Color.YELLOW, start, message, end)
-
-    @staticmethod
-    def print_error(msg, prefix=True, start="", end="\n") -> None:
-        message = f"[ERROR] {msg}" if prefix else msg
-        Logger.__print(Color.RED, start, message, end)
-
-    @staticmethod
-    def print_status(msg, prefix=True, start="", end="\n") -> None:
-        message = f"\n###### {msg}" if prefix else msg
-        Logger.__print(Color.MAGENTA, start, message, end)
-
-    @staticmethod
-    def __print(color: Color, start: str, message: str, end: str) -> None:
-        print(Color.apply(f"{start}{message}", color), end=end)
-
-    @staticmethod
-    def print_dialog(
-        title: DialogType,
-        content: List[str],
-        center_content: bool = False,
-        custom_title: str | None = None,
-        custom_color: Color | None = None,
-        margin_top: int = 0,
-        margin_bottom: int = 0,
-    ) -> None:
-        """
-        Prints a dialog with the given title and content.
-        Those dialogs should be used to display verbose messages to the user which
-        require simple interaction like confirmation or input. Do not use this for
-        navigating through the application.
-
-        :param title: The type of the dialog.
-        :param content: The content of the dialog.
-        :param center_content: Whether to center the content or not.
-        :param custom_title: A custom title for the dialog.
-        :param custom_color: A custom color for the dialog.
-        :param margin_top: The number of empty lines to print before the dialog.
-        :param margin_bottom: The number of empty lines to print after the dialog.
-        """
-        color = Logger._get_dialog_color(title, custom_color)
-        dialog_title = Logger._get_dialog_title(title, custom_title)
-
-        if margin_top > 0:
-            print("\n" * margin_top, end="")
-
-        print(Color.apply(BORDER_TOP, color))
-
-        if dialog_title:
-            print(Color.apply(f"┃ {dialog_title:^{LINE_WIDTH}} ┃", color))
-            print(Color.apply(BORDER_TITLE, color))
-
-        if content:
-            print(
-                Logger.format_content(
-                    content,
-                    LINE_WIDTH,
-                    color,
-                    center_content,
-                )
-            )
-
-        print(Color.apply(BORDER_BOTTOM, color))
-
-        if margin_bottom > 0:
-            print("\n" * margin_bottom, end="")
-
-    @staticmethod
-    def _get_dialog_title(
-        title: DialogType, custom_title: str | None = None
-    ) -> str | None:
-        if title == DialogType.CUSTOM and custom_title:
-            return f"[ {custom_title} ]"
-        return f"[ {title.value[0]} ]" if title.value[0] else None
-
-    @staticmethod
-    def _get_dialog_color(
-        title: DialogType, custom_color: Color | None = None
-    ) -> Color:
-        if title == DialogType.CUSTOM and custom_color:
-            return custom_color
-
-        color: Color = title.value[1] if title.value[1] else Color.WHITE
-
-        return color
-
-    @staticmethod
-    def format_content(
-        content: List[str],
-        line_width: int,
-        color: Color = Color.WHITE,
-        center_content: bool = False,
-        border_left: str = "┃",
-        border_right: str = "┃",
-    ) -> str:
-        wrapper = textwrap.TextWrapper(line_width)
-
-        lines = []
-        for i, c in enumerate(content):
-            paragraph = wrapper.wrap(c)
-            lines.extend(paragraph)
-
-            # add a full blank line if we have a double newline
-            # character unless we are at the end of the list
-            if c == "\n\n" and i < len(content) - 1:
-                lines.append(" " * line_width)
-
-        if not center_content:
-            formatted_lines = [
-                Color.apply(f"{border_left} {line:<{line_width}} {border_right}", color)
-                for line in lines
-            ]
-        else:
-            formatted_lines = [
-                Color.apply(f"{border_left} {line:^{line_width}} {border_right}", color)
-                for line in lines
-            ]
-
-        return "\n".join(formatted_lines)

kiauh/core/menus/__init__.py

@@ -1,37 +1,14 @@
+#!/usr/bin/env python3
+
 # ======================================================================= #
-#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
 #                                                                         #
 #  This file is part of KIAUH - Klipper Installation And Update Helper    #
 #  https://github.com/dw-0/kiauh                                          #
 #                                                                         #
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
-from __future__ import annotations
 
-from dataclasses import dataclass
-from enum import Enum
-from typing import Any, Callable, Type
-
-
-@dataclass
-class Option:
-    """
-    Represents a menu option.
-    :param method: Method that will be used to call the menu option
-    :param opt_index: Can be used to pass the user input to the menu option
-    :param opt_data: Can be used to pass any additional data to the menu option
-    """
-
-    def __repr__(self):
-        return f"Option(method={self.method.__name__}, opt_index={self.opt_index}, opt_data={self.opt_data})"
-
-    method: Type[Callable]
-    opt_index: str = ""
-    opt_data: Any = None
-
-
-class FooterType(Enum):
-    QUIT = "QUIT"
-    BACK = "BACK"
-    BACK_HELP = "BACK_HELP"
-    BLANK = "BLANK"
+QUIT_FOOTER = "quit"
+BACK_FOOTER = "back"
+BACK_HELP_FOOTER = "back_help"