chore: this is the last commit for KIAUH v5

206fd4828d

72b89d905e

.editorconfig

@@ -6,6 +6,10 @@ 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}]
+indent_size = 2

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

@@ -0,0 +1,33 @@
+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,8 +1,13 @@
 .idea
 .vscode
 .pytest_cache
+.jupyter
+*.ipynb
+*.ipynb_checkpoints
+*.tmp
 __pycache__
 .kiauh-env
 *.code-workspace
 *.iml
 kiauh.cfg
+klipper_repos.txt

README.md

@@ -28,12 +28,12 @@
 
 ### 📋 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 
+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 
+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/) 
+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">
@@ -44,7 +44,7 @@ select `Choose OS -> Raspberry Pi OS (other)`: \
   <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 
+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 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 
+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 
+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" 
+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,77 +101,83 @@ prompt and confirm by hitting ENTER.
 
 <h2 align="center">🌐 Sources & Further Information</h2>
 
-<table>
+<table align="center">
 <tr>
-<th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</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/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/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://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://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/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/KevinOConnor">KevinOConnor</a></th>
-<th>by <a href="https://github.com/Arksine">Arksine</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/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>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/nlef/moonraker-telegram-bot">Moonraker-Telegram-Bot</a></h3></th>
+    <th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</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/jordanruthe/KlipperScreen">KlipperScreen</a></h3></th>
-<th><h3><a href="https://github.com/TheSpaghettiDetective/moonraker-obico">Obico for Klipper</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>
 </tr>
 
 <tr>
-<th><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></th>
+    <th><h3><a href="https://github.com/nlef/moonraker-telegram-bot">Moonraker-Telegram-Bot</a></h3></th>
-<th><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></th>
+    <th><h3><a href="https://github.com/Kragrathea/pgcode">PrettyGCode for Klipper</a></h3></th>
-<th><img src="https://avatars.githubusercontent.com/u/46323662?s=200&v=4" alt="Obico logo" height="64"></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>
 </tr>
 
 <tr>
-<th>by <a href="https://github.com/nlef">nlef</a></th>
+    <th><h3><a href="https://github.com/Clon1998/mobileraker_companion">Mobileraker's Companion</a></h3></th>
-<th>by <a href="https://github.com/Kragrathea">Kragrathea</a></th>
+    <th><h3><a href="https://octoeverywhere.com/?source=kiauh_readme">OctoEverywhere For Klipper</a></h3></th>
-<th>by <a href="https://github.com/TheSpaghettiDetective">Obico</a></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>
 </tr>
 
 <tr>
-<th><h3><a href="https://github.com/Clon1998/mobileraker_companion">Mobileraker's Companion</a></h3></th>
+    <th><h3><a href="https://github.com/staubgeborener/klipper-backup">Klipper-Backup</a></h3></th>
-<th><h3><a href="https://octoeverywhere.com/?source=kiauh_readme">OctoEverywhere For Klipper</a></h3></th>
+    <th><h3><a href="https://simplyprint.io/">SimplyPrint for Klipper</a></h3></th>
-<th><h3><a href="https://github.com/crysxd/OctoPrint-OctoApp">OctoApp For Klipper</a></h3></th>
-<th><h3></h3></th>
 </tr>
-
 <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="OctoEverywhere Logo" height="64"></a></th>
+    <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://octoeverywhere.com/?source=kiauh_readme"><img src="https://octoeverywhere.com/img/logo.svg" alt="OctoEverywhere Logo" 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://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/Staubgeborener">Staubgeborener</a></th>
-<th>by <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
+    <th>by <a href="https://github.com/SimplyPrint">SimplyPrint</a></th>
-<th>by <a href="https://github.com/crysxd">Christian Würthner</a></th>
-<th></th>
 </tr>
-
-
 </table>
 
 <hr>
@@ -186,6 +192,12 @@ prompt and confirm by hitting ENTER.
 
 <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

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

default_kiauh.cfg

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

docs/changelog.md

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

kiauh.py

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

kiauh.sh

@@ -10,99 +10,62 @@
 #=======================================================================#
 
 set -e
-clear
+clear -x
 
-function main() {
+# make sure we have the correct permissions while running the script
-  local python_command
+umask 022
-  local entrypoint
 
-  if command -v python3 &>/dev/null; then
+### sourcing all additional scripts
-    python_command="python3"
+KIAUH_SRCDIR="$(dirname -- "$(readlink -f "${BASH_SOURCE[0]}")")"
-  elif command -v python &>/dev/null; then
+for script in "${KIAUH_SRCDIR}/scripts/"*.sh; do . "${script}"; done
-    python_command="python"
+for script in "${KIAUH_SRCDIR}/scripts/ui/"*.sh; do . "${script}"; done
-  else
-    echo "Python is not installed. Please install Python and try again."
-    exit 1
-  fi
 
-  entrypoint=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
+#===================================================#
+#=================== UPDATE KIAUH ==================#
+#===================================================#
 
-  ${python_command} "${entrypoint}/kiauh.py"
+function update_kiauh() {
+  status_msg "Updating KIAUH ..."
+
+  cd "${KIAUH_SRCDIR}"
+  git reset --hard && git pull
+
+  ok_msg "Update complete! Please restart KIAUH."
+  exit 0
 }
 
-main
+#===================================================#
+#=================== KIAUH STATUS ==================#
+#===================================================#
 
-#### sourcing all additional scripts
+function kiauh_update_avail() {
-#KIAUH_SRCDIR="$(dirname -- "$(readlink -f "${BASH_SOURCE[0]}")")"
+  [[ ! -d "${KIAUH_SRCDIR}/.git" ]] && return
-#for script in "${KIAUH_SRCDIR}/scripts/"*.sh; do . "${script}"; done
+  local origin head
-#for script in "${KIAUH_SRCDIR}/scripts/ui/"*.sh; do . "${script}"; done
+
-#
+  cd "${KIAUH_SRCDIR}"
-##===================================================#
+
-##=================== UPDATE KIAUH ==================#
+  ### abort if not on master branch
-##===================================================#
+  ! git branch -a | grep -q "\* master" && return
-#
+
-#function update_kiauh() {
+  ### compare commit hash
-#  status_msg "Updating KIAUH ..."
+  git fetch -q
-#
+  origin=$(git rev-parse --short=8 origin/master)
-#  cd "${KIAUH_SRCDIR}"
+  head=$(git rev-parse --short=8 HEAD)
-#  git reset --hard && git pull
+
-#
+  if [[ ${origin} != "${head}" ]]; then
-#  ok_msg "Update complete! Please restart KIAUH."
+    echo "true"
-#  exit 0
+  fi
-#}
+}
-#
+
-##===================================================#
+function main() {
-##=================== KIAUH STATUS ==================#
+  read_kiauh_ini "${FUNCNAME[0]}"
-##===================================================#
+  main_menu
-#
+}
-#function kiauh_update_avail() {
+
-#  [[ ! -d "${KIAUH_SRCDIR}/.git" ]] && return
+check_if_ratos
-#  local origin head
+check_euid
-#
+init_logfile
-#  cd "${KIAUH_SRCDIR}"
+set_globals
-#
+read_kiauh_ini
-#  ### abort if not on master branch
+init_ini
-#  ! git branch -a | grep -q "\* master" && return
+main
-#
-#  ### 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,15 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-import sys
-from pathlib import Path
-
-PROJECT_ROOT = Path(__file__).resolve().parent.parent
-APPLICATION_ROOT = Path(__file__).resolve().parent
-sys.path.append(str(APPLICATION_ROOT))

kiauh/components/crowsnest/__init__.py

@@ -1,16 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from pathlib import Path
-
-from core.backup_manager import BACKUP_ROOT_DIR
-
-CROWSNEST_DIR = Path.home().joinpath("crowsnest")
-CROWSNEST_REPO = "https://github.com/mainsail-crew/crowsnest.git"
-CROWSNEST_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("crowsnest-backups")

kiauh/components/crowsnest/crowsnest.py

@@ -1,173 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-from __future__ import annotations
-
-import shutil
-import time
-from pathlib import Path
-from subprocess import CalledProcessError, run
-from typing import List
-
-from components.crowsnest import CROWSNEST_BACKUP_DIR, CROWSNEST_DIR, CROWSNEST_REPO
-from components.klipper.klipper import Klipper
-from core.backup_manager.backup_manager import BackupManager
-from core.instance_manager.instance_manager import InstanceManager
-from core.settings.kiauh_settings import KiauhSettings
-from utils.common import (
-    check_install_dependencies,
-    get_install_status,
-)
-from utils.constants import CURRENT_USER
-from utils.git_utils import (
-    git_clone_wrapper,
-    git_pull_wrapper,
-)
-from utils.input_utils import get_confirm
-from utils.logger import DialogType, Logger
-from utils.sys_utils import (
-    cmd_sysctl_service,
-    parse_packages_from_file,
-)
-from utils.types import ComponentStatus
-
-
-def install_crowsnest() -> None:
-    # 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
-    im = InstanceManager(Klipper)
-    instances: List[Klipper] = im.instances
-
-    if len(instances) > 1:
-        print_multi_instance_warning(instances)
-
-        if not get_confirm("Do you want to continue with the installation?"):
-            Logger.print_info("Crowsnest installation aborted!")
-            return
-
-        Logger.print_status("Launching crowsnest's install configurator ...")
-        time.sleep(3)
-        configure_multi_instance()
-
-    # Step 4: Launch crowsnest installer
-    Logger.print_status("Launching crowsnest installer ...")
-    Logger.print_info("Installer will prompt you for sudo password!")
-    try:
-        run(
-            f"sudo make install BASE_USER={CURRENT_USER}",
-            cwd=CROWSNEST_DIR,
-            shell=True,
-            check=True,
-        )
-    except CalledProcessError as e:
-        Logger.print_error(f"Something went wrong! Please try again...\n{e}")
-        return
-
-
-def print_multi_instance_warning(instances: List[Klipper]) -> None:
-    _instances = [f"● {instance.data_dir_name}" for instance in instances]
-    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:",
-            *_instances,
-        ],
-        end="",
-    )
-
-
-def configure_multi_instance() -> None:
-    config = Path(CROWSNEST_DIR).joinpath("tools/.config")
-    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 config.exists():
-            Path.unlink(config)
-        return
-
-    if not config.exists():
-        Logger.print_error("Generating .config failed, installation aborted")
-
-
-def update_crowsnest() -> None:
-    try:
-        cmd_sysctl_service("crowsnest", "stop")
-
-        if not CROWSNEST_DIR.exists():
-            git_clone_wrapper(CROWSNEST_REPO, CROWSNEST_DIR, "master")
-        else:
-            Logger.print_status("Updating Crowsnest ...")
-
-            settings = KiauhSettings()
-            if settings.kiauh.backup_before_update:
-                bm = BackupManager()
-                bm.backup_directory(
-                    "crowsnest",
-                    source=CROWSNEST_DIR,
-                    target=CROWSNEST_BACKUP_DIR,
-                )
-
-            git_pull_wrapper(CROWSNEST_REPO, CROWSNEST_DIR)
-
-            script = CROWSNEST_DIR.joinpath("tools/install.sh")
-            deps = parse_packages_from_file(script)
-            check_install_dependencies(deps)
-
-        cmd_sysctl_service("crowsnest", "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 = [
-        Path("/usr/local/bin/crowsnest"),
-        Path("/etc/logrotate.d/crowsnest"),
-        Path("/etc/systemd/system/crowsnest.service"),
-    ]
-    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/klipper/__init__.py

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

kiauh/components/klipper/assets/klipper.env

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

kiauh/components/klipper/assets/klipper.service

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

kiauh/components/klipper/assets/printer.cfg

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

kiauh/components/klipper/klipper.py

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

kiauh/components/klipper/klipper_dialogs.py

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

kiauh/components/klipper/klipper_remove.py

@@ -1,131 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-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.fs_utils import remove_file
-from utils.input_utils import get_selection_input
-from utils.logger import Logger
-from utils.sys_utils import cmd_sysctl_manage
-
-
-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, show_index=True, show_select_all=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()
-
-    cmd_sysctl_manage("daemon-reload")
-
-
-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

@@ -1,173 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from pathlib import Path
-
-from components.klipper import (
-    EXIT_KLIPPER_SETUP,
-    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 (
-    add_to_existing,
-    backup_klipper_dir,
-    check_is_single_to_multi_conversion,
-    check_user_groups,
-    create_example_printer_cfg,
-    get_install_count,
-    handle_disruptive_system_packages,
-    handle_instance_naming,
-    handle_to_multi_instance_conversion,
-    init_name_scheme,
-    update_name_scheme,
-)
-from components.moonraker.moonraker import Moonraker
-from components.webui_client.client_utils import (
-    get_existing_clients,
-)
-from core.instance_manager.instance_manager import InstanceManager
-from core.settings.kiauh_settings import KiauhSettings
-from utils.common import check_install_dependencies
-from utils.git_utils import git_clone_wrapper, git_pull_wrapper
-from utils.input_utils import get_confirm
-from utils.logger import Logger
-from utils.sys_utils import (
-    cmd_sysctl_manage,
-    create_python_venv,
-    install_python_requirements,
-    parse_packages_from_file,
-)
-
-
-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:
-            check_install_dependencies(["git"])
-            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
-
-        cmd_sysctl_manage("daemon-reload")
-
-    except Exception as e:
-        Logger.print_error(e)
-        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:
-    settings = KiauhSettings()
-    repo = settings.klipper.repo_url
-    branch = settings.klipper.branch
-
-    git_clone_wrapper(repo, KLIPPER_DIR, branch)
-
-    # install klipper dependencies and create python virtualenv
-    try:
-        install_klipper_packages(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")
-
-    check_install_dependencies(packages)
-
-
-def update_klipper() -> None:
-    print_update_warn_dialog()
-    if not get_confirm("Update Klipper now?"):
-        return
-
-    settings = KiauhSettings()
-    if settings.kiauh.backup_before_update:
-        backup_klipper_dir()
-
-    instance_manager = InstanceManager(Klipper)
-    instance_manager.stop_all_instance()
-
-    git_pull_wrapper(repo=settings.klipper.repo_url, target_dir=KLIPPER_DIR)
-
-    # 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:
-        # if a client-config is installed, include it in the new example cfg
-        clients = get_existing_clients()
-        create_example_printer_cfg(new_instance, clients)
-    kl_im.start_instance()

kiauh/components/klipper/klipper_utils.py

@@ -1,318 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-import grp
-import os
-import re
-import shutil
-from subprocess import CalledProcessError, run
-from typing import Dict, List, Optional, Union
-
-from components.klipper import (
-    KLIPPER_BACKUP_DIR,
-    KLIPPER_DIR,
-    KLIPPER_ENV_DIR,
-    MODULE_PATH,
-)
-from components.klipper.klipper import Klipper
-from components.klipper.klipper_dialogs import (
-    print_instance_overview,
-    print_missing_usergroup_dialog,
-    print_select_custom_name_dialog,
-    print_select_instance_count_dialog,
-)
-from components.moonraker.moonraker import Moonraker
-from components.moonraker.moonraker_utils import moonraker_to_multi_conversion
-from components.webui_client.base_data import BaseWebClient
-from components.webui_client.client_config.client_config_setup import (
-    create_client_config_symlink,
-)
-from core.backup_manager.backup_manager import BackupManager
-from core.instance_manager.base_instance import BaseInstance
-from core.instance_manager.instance_manager import InstanceManager
-from core.instance_manager.name_scheme import NameScheme
-from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
-    SimpleConfigParser,
-)
-from utils import PRINTER_CFG_BACKUP_DIR
-from utils.common import get_install_status
-from utils.constants import CURRENT_USER
-from utils.input_utils import get_confirm, get_number_input, get_string_input
-from utils.logger import DialogType, Logger
-from utils.sys_utils import cmd_sysctl_service
-from utils.types import ComponentStatus
-
-
-def get_klipper_status() -> ComponentStatus:
-    return get_install_status(KLIPPER_DIR, KLIPPER_ENV_DIR, 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)
-    return get_confirm("Add new instances?", allow_go_back=True)
-
-
-def get_install_count() -> Union[int, None]:
-    """
-    Print a dialog for selecting the amount of Klipper instances
-    to set up with an option to navigate back. Returns None if the
-    user selected to go back, otherwise an integer greater or equal than 1 |
-    :return: Integer >= 1 or None
-    """
-    kl_instances = InstanceManager(Klipper).instances
-    print_select_instance_count_dialog()
-    question = (
-        f"Number of"
-        f"{' additional' if len(kl_instances) > 0 else ''} "
-        f"Klipper instances to set up"
-    )
-    return get_number_input(question, 1, default=1, allow_go_back=True)
-
-
-def assign_custom_name(key: int, name_dict: Dict[int, str]) -> None:
-    existing_names = []
-    existing_names.extend(Klipper.blacklist())
-    existing_names.extend(name_dict[n] for n in name_dict)
-    question = f"Enter name for instance {key + 1}"
-    name_dict[key] = get_string_input(question, exclude=existing_names)
-
-
-def handle_to_multi_instance_conversion(new_name: str) -> None:
-    Logger.print_status("Converting single instance to multi instances ...")
-    klipper_to_multi_conversion(new_name)
-    moonraker_to_multi_conversion(new_name)
-
-
-def klipper_to_multi_conversion(new_name: str) -> None:
-    Logger.print_status("Convert Klipper single to multi instance ...")
-    im = InstanceManager(Klipper)
-    im.current_instance = im.instances[0]
-
-    # temporarily store the data dir path
-    old_data_dir = im.instances[0].data_dir
-    old_data_dir_name = im.instances[0].data_dir_name
-
-    # backup the old data_dir
-    bm = BackupManager()
-    name = f"config-{old_data_dir_name}"
-    bm.backup_directory(
-        name,
-        source=im.current_instance.cfg_dir,
-        target=PRINTER_CFG_BACKUP_DIR,
-    )
-
-    # remove the old single instance
-    im.stop_instance()
-    im.disable_instance()
-    im.delete_instance()
-
-    # create a new klipper instance with the new name
-    new_instance = Klipper(suffix=new_name)
-    im.current_instance = new_instance
-
-    if not new_instance.data_dir.is_dir():
-        # rename the old data dir and use it for the new instance
-        Logger.print_status(f"Rename '{old_data_dir}' to '{new_instance.data_dir}' ...")
-        old_data_dir.rename(new_instance.data_dir)
-    else:
-        Logger.print_info(f"Existing '{new_instance.data_dir}' found ...")
-
-    # patch the virtual_sdcard sections path
-    # value to match the new printer_data foldername
-    scp = SimpleConfigParser()
-    scp.read(new_instance.cfg_file)
-    if scp.has_section("virtual_sdcard"):
-        scp.set("virtual_sdcard", "path", str(new_instance.gcodes_dir))
-        scp.write(new_instance.cfg_file)
-
-    # finalize creating the new instance
-    im.create_instance()
-    im.enable_instance()
-    im.start_instance()
-
-
-def check_user_groups():
-    current_groups = [grp.getgrgid(gid).gr_name for gid in os.getgroups()]
-
-    missing_groups = []
-    if "tty" not in current_groups:
-        missing_groups.append("tty")
-    if "dialout" not in current_groups:
-        missing_groups.append("dialout")
-
-    if not missing_groups:
-        return
-
-    print_missing_usergroup_dialog(missing_groups)
-    if not get_confirm(f"Add user '{CURRENT_USER}' to group(s) now?"):
-        log = "Skipped adding user to required groups. You might encounter issues."
-        Logger.warn(log)
-        return
-
-    try:
-        for group in missing_groups:
-            Logger.print_status(f"Adding user '{CURRENT_USER}' to group {group} ...")
-            command = ["sudo", "usermod", "-a", "-G", group, CURRENT_USER]
-            run(command, check=True)
-            Logger.print_ok(f"Group {group} assigned to user '{CURRENT_USER}'.")
-    except CalledProcessError as e:
-        Logger.print_error(f"Unable to add user to usergroups: {e}")
-        raise
-
-    log = "Remember to relog/restart this machine for the group(s) to be applied!"
-    Logger.print_warn(log)
-
-
-def handle_disruptive_system_packages() -> None:
-    services = []
-
-    command = ["systemctl", "is-enabled", "brltty"]
-    brltty_status = run(command, capture_output=True, text=True)
-
-    command = ["systemctl", "is-enabled", "brltty-udev"]
-    brltty_udev_status = run(command, capture_output=True, text=True)
-
-    command = ["systemctl", "is-enabled", "ModemManager"]
-    modem_manager_status = run(command, capture_output=True, text=True)
-
-    if "enabled" in brltty_status.stdout:
-        services.append("brltty")
-    if "enabled" in brltty_udev_status.stdout:
-        services.append("brltty-udev")
-    if "enabled" in modem_manager_status.stdout:
-        services.append("ModemManager")
-
-    for service in services if services else []:
-        try:
-            cmd_sysctl_service(service, "mask")
-        except CalledProcessError:
-            Logger.print_dialog(
-                DialogType.WARNING,
-                [
-                    f"KIAUH was unable to mask the {service} system service. "
-                    "Please fix the problem manually. Otherwise, this may have "
-                    "undesirable effects on the operation of Klipper."
-                ],
-                end="",
-            )
-
-
-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:
-    return max([int(instance.suffix.split("-")[-1]) for instance in instance_list])
-
-
-def create_example_printer_cfg(
-    instance: Klipper, clients: Optional[List[BaseWebClient]] = None
-) -> None:
-    Logger.print_status(f"Creating example printer.cfg in '{instance.cfg_dir}'")
-    if instance.cfg_file.is_file():
-        Logger.print_info(f"'{instance.cfg_file}' already exists.")
-        return
-
-    source = MODULE_PATH.joinpath("assets/printer.cfg")
-    target = instance.cfg_file
-    try:
-        shutil.copy(source, target)
-    except OSError as e:
-        Logger.print_error(f"Unable to create example printer.cfg:\n{e}")
-        return
-
-    scp = SimpleConfigParser()
-    scp.read(target)
-    scp.set("virtual_sdcard", "path", str(instance.gcodes_dir))
-
-    # include existing client configs in the example config
-    if clients is not None and len(clients) > 0:
-        for c in clients:
-            client_config = c.client_config
-            section = client_config.config_section
-            scp.add_section(section=section)
-            create_client_config_symlink(client_config, [instance])
-
-    scp.write(target)
-
-    Logger.print_ok(f"Example printer.cfg created in '{instance.cfg_dir}'")
-
-
-def backup_klipper_dir() -> None:
-    bm = BackupManager()
-    bm.backup_directory("klipper", source=KLIPPER_DIR, target=KLIPPER_BACKUP_DIR)
-    bm.backup_directory("klippy-env", source=KLIPPER_ENV_DIR, target=KLIPPER_BACKUP_DIR)

kiauh/components/klipper/menus/klipper_remove_menu.py

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

kiauh/components/klipper_firmware/__init__.py

@@ -1,12 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from components.klipper import KLIPPER_DIR
-
-SD_FLASH_SCRIPT = KLIPPER_DIR.joinpath("scripts/flash-sdcard.sh")

kiauh/components/klipper_firmware/firmware_utils.py

@@ -1,174 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from subprocess import PIPE, STDOUT, CalledProcessError, Popen, check_output, run
-from typing import List
-
-from components.klipper import KLIPPER_DIR
-from components.klipper.klipper import Klipper
-from components.klipper_firmware import SD_FLASH_SCRIPT
-from components.klipper_firmware.flash_options import (
-    FlashMethod,
-    FlashOptions,
-)
-from core.instance_manager.instance_manager import InstanceManager
-from utils.logger import Logger
-from utils.sys_utils import log_process
-
-
-def find_firmware_file() -> bool:
-    target = KLIPPER_DIR.joinpath("out")
-    target_exists = target.exists()
-
-    f1 = "klipper.elf.hex"
-    f2 = "klipper.elf"
-    f3 = "klipper.bin"
-    fw_file_exists = (
-        target.joinpath(f1).exists() and target.joinpath(f2).exists()
-    ) or target.joinpath(f3).exists()
-
-    return target_exists and fw_file_exists
-
-
-def find_usb_device_by_id() -> List[str]:
-    try:
-        command = "find /dev/serial/by-id/* 2>/dev/null"
-        output = check_output(command, shell=True, text=True)
-        return output.splitlines()
-    except CalledProcessError as e:
-        Logger.print_error("Unable to find a USB device!")
-        Logger.print_error(e, prefix=False)
-        return []
-
-
-def find_uart_device() -> List[str]:
-    try:
-        command = '"find /dev -maxdepth 1 -regextype posix-extended -regex "^\/dev\/tty(AMA0|S0)$" 2>/dev/null"'
-        output = check_output(command, shell=True, text=True)
-        return output.splitlines()
-    except CalledProcessError as e:
-        Logger.print_error("Unable to find a UART device!")
-        Logger.print_error(e, prefix=False)
-        return []
-
-
-def find_usb_dfu_device() -> List[str]:
-    try:
-        command = '"lsusb | grep "DFU" | cut -d " " -f 6 2>/dev/null"'
-        output = check_output(command, shell=True, text=True)
-        return output.splitlines()
-    except CalledProcessError as e:
-        Logger.print_error("Unable to find a USB DFU device!")
-        Logger.print_error(e, prefix=False)
-        return []
-
-
-def get_sd_flash_board_list() -> List[str]:
-    if not KLIPPER_DIR.exists() or not SD_FLASH_SCRIPT.exists():
-        return []
-
-    try:
-        cmd = f"{SD_FLASH_SCRIPT} -l"
-        blist = check_output(cmd, shell=True, text=True)
-        return blist.splitlines()[1:]
-    except CalledProcessError as e:
-        Logger.print_error(f"An unexpected error occured:\n{e}")
-
-
-def start_flash_process(flash_options: FlashOptions) -> None:
-    Logger.print_status(f"Flashing '{flash_options.selected_mcu}' ...")
-    try:
-        if not flash_options.flash_method:
-            raise Exception("Missing value for flash_method!")
-        if not flash_options.flash_command:
-            raise Exception("Missing value for flash_command!")
-        if not flash_options.selected_mcu:
-            raise Exception("Missing value for selected_mcu!")
-        if not flash_options.connection_type:
-            raise Exception("Missing value for connection_type!")
-        if (
-            flash_options.flash_method == FlashMethod.SD_CARD
-            and not flash_options.selected_board
-        ):
-            raise Exception("Missing value for selected_board!")
-
-        if flash_options.flash_method is FlashMethod.REGULAR:
-            cmd = [
-                "make",
-                flash_options.flash_command.value,
-                f"FLASH_DEVICE={flash_options.selected_mcu}",
-            ]
-        elif flash_options.flash_method is FlashMethod.SD_CARD:
-            if not SD_FLASH_SCRIPT.exists():
-                raise Exception("Unable to find Klippers sdcard flash script!")
-            cmd = [
-                SD_FLASH_SCRIPT.as_posix(),
-                f"-b {flash_options.selected_baudrate}",
-                flash_options.selected_mcu,
-                flash_options.selected_board,
-            ]
-        else:
-            raise Exception("Invalid value for flash_method!")
-
-        instance_manager = InstanceManager(Klipper)
-        instance_manager.stop_all_instance()
-
-        process = Popen(cmd, cwd=KLIPPER_DIR, stdout=PIPE, stderr=STDOUT, text=True)
-        log_process(process)
-
-        instance_manager.start_all_instance()
-
-        rc = process.returncode
-        if rc != 0:
-            raise Exception(f"Flashing failed with returncode: {rc}")
-        else:
-            Logger.print_ok("Flashing successfull!", start="\n", end="\n\n")
-
-    except (Exception, CalledProcessError):
-        Logger.print_error("Flashing failed!", start="\n")
-        Logger.print_error("See the console output above!", end="\n\n")
-
-
-def run_make_clean() -> None:
-    try:
-        run(
-            "make clean",
-            cwd=KLIPPER_DIR,
-            shell=True,
-            check=True,
-        )
-    except CalledProcessError as e:
-        Logger.print_error(f"Unexpected error:\n{e}")
-        raise
-
-
-def run_make_menuconfig() -> None:
-    try:
-        run(
-            "make PYTHON=python3 menuconfig",
-            cwd=KLIPPER_DIR,
-            shell=True,
-            check=True,
-        )
-    except CalledProcessError as e:
-        Logger.print_error(f"Unexpected error:\n{e}")
-        raise
-
-
-def run_make() -> None:
-    try:
-        run(
-            "make PYTHON=python3",
-            cwd=KLIPPER_DIR,
-            shell=True,
-            check=True,
-        )
-    except CalledProcessError as e:
-        Logger.print_error(f"Unexpected error:\n{e}")
-        raise

kiauh/components/klipper_firmware/flash_options.py

@@ -1,104 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from dataclasses import field
-from enum import Enum
-from typing import List, Union
-
-
-class FlashMethod(Enum):
-    REGULAR = "Regular"
-    SD_CARD = "SD Card"
-
-
-class FlashCommand(Enum):
-    FLASH = "flash"
-    SERIAL_FLASH = "serialflash"
-
-
-class ConnectionType(Enum):
-    USB = "USB"
-    USB_DFU = "USB (DFU)"
-    UART = "UART"
-
-
-class FlashOptions:
-    _instance = None
-    _flash_method: Union[FlashMethod, None] = None
-    _flash_command: Union[FlashCommand, None] = None
-    _connection_type: Union[ConnectionType, None] = None
-    _mcu_list: List[str] = field(default_factory=list)
-    _selected_mcu: str = ""
-    _selected_board: str = ""
-    _selected_baudrate: int = 250000
-
-    def __new__(cls, *args, **kwargs):
-        if not cls._instance:
-            cls._instance = super(FlashOptions, cls).__new__(cls, *args, **kwargs)
-        return cls._instance
-
-    @classmethod
-    def destroy(cls):
-        cls._instance = None
-
-    @property
-    def flash_method(self) -> Union[FlashMethod, None]:
-        return self._flash_method
-
-    @flash_method.setter
-    def flash_method(self, value: Union[FlashMethod, None]):
-        self._flash_method = value
-
-    @property
-    def flash_command(self) -> Union[FlashCommand, None]:
-        return self._flash_command
-
-    @flash_command.setter
-    def flash_command(self, value: Union[FlashCommand, None]):
-        self._flash_command = value
-
-    @property
-    def connection_type(self) -> Union[ConnectionType, None]:
-        return self._connection_type
-
-    @connection_type.setter
-    def connection_type(self, value: Union[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

kiauh/components/klipper_firmware/menus/klipper_build_menu.py

@@ -1,112 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-import textwrap
-from typing import Optional, Type
-
-from components.klipper import KLIPPER_DIR
-from components.klipper_firmware.firmware_utils import (
-    run_make,
-    run_make_clean,
-    run_make_menuconfig,
-)
-from core.menus import Option
-from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_CYAN, COLOR_GREEN, COLOR_RED, RESET_FORMAT
-from utils.logger import Logger
-from utils.sys_utils import (
-    check_package_install,
-    install_system_packages,
-    update_system_package_lists,
-)
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperBuildFirmwareMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
-        super().__init__()
-        self.previous_menu = previous_menu
-        self.deps = ["build-essential", "dpkg-dev", "make"]
-        self.missing_deps = check_package_install(self.deps)
-
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        from core.menus.advanced_menu import AdvancedMenu
-
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else AdvancedMenu
-        )
-
-    def set_options(self) -> None:
-        if len(self.missing_deps) == 0:
-            self.input_label_txt = "Press ENTER to continue"
-            self.default_option = Option(method=self.start_build_process, menu=False)
-        else:
-            self.input_label_txt = "Press ENTER to install dependencies"
-            self.default_option = Option(method=self.install_missing_deps, menu=False)
-
-    def print_menu(self) -> None:
-        header = " [ Build Firmware Menu ] "
-        color = COLOR_CYAN
-        count = 62 - len(color) - len(RESET_FORMAT)
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:~^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            | The following dependencies are required:              |
-            |                                                       |
-            """
-        )[1:]
-
-        for d in self.deps:
-            status_ok = f"{COLOR_GREEN}*INSTALLED*{RESET_FORMAT}"
-            status_missing = f"{COLOR_RED}*MISSING*{RESET_FORMAT}"
-            status = status_missing if d in self.missing_deps else status_ok
-            padding = 39 - len(d) + len(status) + (len(status_ok) - len(status))
-            d = f" {COLOR_CYAN}● {d}{RESET_FORMAT}"
-            menu += f"| {d}{status:>{padding}} |\n"
-
-        menu += "|                                                       |\n"
-        if len(self.missing_deps) == 0:
-            line = f"{COLOR_GREEN}All dependencies are met!{RESET_FORMAT}"
-        else:
-            line = f"{COLOR_RED}Dependencies are missing!{RESET_FORMAT}"
-
-        menu += f"| {line:<62} |\n"
-
-        print(menu, end="")
-
-    def install_missing_deps(self, **kwargs) -> None:
-        try:
-            update_system_package_lists(silent=False)
-            Logger.print_status("Installing system packages...")
-            install_system_packages(self.missing_deps)
-        except Exception as e:
-            Logger.print_error(e)
-            Logger.print_error("Installing dependencies failed!")
-        finally:
-            # restart this menu
-            KlipperBuildFirmwareMenu().run()
-
-    def start_build_process(self, **kwargs) -> None:
-        try:
-            run_make_clean()
-            run_make_menuconfig()
-            run_make()
-
-            Logger.print_ok("Firmware successfully built!")
-            Logger.print_ok(f"Firmware file located in '{KLIPPER_DIR}/out'!")
-
-        except Exception as e:
-            Logger.print_error(e)
-            Logger.print_error("Building Klipper Firmware failed!")
-
-        finally:
-            self.previous_menu().run()

kiauh/components/klipper_firmware/menus/klipper_flash_error_menu.py

@@ -1,109 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-import textwrap
-from typing import Optional, Type
-
-from components.klipper_firmware.flash_options import FlashMethod, FlashOptions
-from core.menus import FooterType, Option
-from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_RED, RESET_FORMAT
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperNoFirmwareErrorMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
-        super().__init__()
-        self.previous_menu = 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: Optional[Type[BaseMenu]]) -> None:
-        self.previous_menu = previous_menu
-
-    def set_options(self) -> None:
-        self.default_option = Option(self.go_back, False)
-
-    def print_menu(self) -> None:
-        header = "!!! NO FIRMWARE FILE FOUND !!!"
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
-        line1 = f"{color}Unable to find a compiled firmware file!{RESET_FORMAT}"
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            | {line1:<62} |
-            |                                                       |
-            | Make sure, that:                                      |
-            | ● the folder '~/klipper/out' and its content exist    |
-            | ● the folder contains the following file:             |
-            """
-        )[1:]
-
-        if self.flash_options.flash_method is FlashMethod.REGULAR:
-            menu += "|   ● 'klipper.elf'                                     |\n"
-            menu += "|   ● 'klipper.elf.hex'                                 |\n"
-        else:
-            menu += "|   ● 'klipper.bin'                                     |\n"
-
-        print(menu, end="")
-
-    def go_back(self, **kwargs) -> None:
-        from core.menus.advanced_menu import AdvancedMenu
-
-        AdvancedMenu().run()
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperNoBoardTypesErrorMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
-        super().__init__()
-        self.previous_menu = 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: Optional[Type[BaseMenu]]) -> None:
-        self.previous_menu = previous_menu
-
-    def set_options(self) -> None:
-        self.default_option = Option(self.go_back, False)
-
-    def print_menu(self) -> None:
-        header = "!!! ERROR GETTING BOARD LIST !!!"
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
-        line1 = f"{color}Reading the list of supported boards failed!{RESET_FORMAT}"
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            | {line1:<62} |
-            |                                                       |
-            | Make sure, that:                                      |
-            | ● the folder '~/klipper' and all its content exist    |
-            | ● the content of folder '~/klipper' is not currupted  |
-            | ● the file '~/klipper/scripts/flash-sd.py' exist      |
-            | ● your current user has access to those files/folders |
-            |                                                       |
-            | If in doubt or this process continues to fail, please |
-            | consider to download Klipper again.                   |
-            """
-        )[1:]
-        print(menu, end="")
-
-    def go_back(self, **kwargs) -> None:
-        from core.menus.main_menu import MainMenu
-
-        MainMenu().run()

kiauh/components/klipper_firmware/menus/klipper_flash_help_menu.py

@@ -1,166 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-import textwrap
-from typing import Optional, Type
-
-from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
-
-
-# noinspection DuplicatedCode
-class KlipperFlashMethodHelpMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
-        super().__init__()
-        self.previous_menu = previous_menu
-
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        from components.klipper_firmware.menus.klipper_flash_menu import (
-            KlipperFlashMethodMenu,
-        )
-
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else KlipperFlashMethodMenu
-        )
-
-    def set_options(self) -> None:
-        pass
-
-    def print_menu(self) -> None:
-        header = " < ? > Help: Flash MCU < ? > "
-        color = COLOR_YELLOW
-        count = 62 - len(color) - len(RESET_FORMAT)
-        subheader1 = f"{COLOR_CYAN}Regular flashing method:{RESET_FORMAT}"
-        subheader2 = f"{COLOR_CYAN}Updating via SD-Card Update:{RESET_FORMAT}"
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:~^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            | {subheader1:<62} |
-            | The default method to flash controller boards which   |
-            | are connected and updated over USB and not by placing |
-            | a compiled firmware file onto an internal SD-Card.    |
-            |                                                       |
-            | Common controllers that get flashed that way are:     |
-            | - Arduino Mega 2560                                   |
-            | - Fysetc F6 / S6 (used without a Display + SD-Slot)   |
-            |                                                       |
-            | {subheader2:<62} |
-            | Many popular controller boards ship with a bootloader |
-            | capable of updating the firmware via SD-Card.         |
-            | Choose this method if your controller board supports  |
-            | this way of updating. This method ONLY works for up-  |
-            | grading firmware. The initial flashing procedure must |
-            | be done manually per the instructions that apply to   |
-            | your controller board.                                |
-            |                                                       |
-            | Common controllers that can be flashed that way are:  |
-            | - BigTreeTech SKR 1.3 / 1.4 (Turbo) / E3 / Mini E3    |
-            | - Fysetc F6 / S6 (used with a Display + SD-Slot)      |
-            | - Fysetc Spider                                       |
-            |                                                       |
-            """
-        )[1:]
-        print(menu, end="")
-
-
-# noinspection DuplicatedCode
-class KlipperFlashCommandHelpMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
-        super().__init__()
-        self.previous_menu = previous_menu
-
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        from components.klipper_firmware.menus.klipper_flash_menu import (
-            KlipperFlashCommandMenu,
-        )
-
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else KlipperFlashCommandMenu
-        )
-
-    def set_options(self) -> None:
-        pass
-
-    def print_menu(self) -> None:
-        header = " < ? > Help: Flash MCU < ? > "
-        color = COLOR_YELLOW
-        count = 62 - len(color) - len(RESET_FORMAT)
-        subheader1 = f"{COLOR_CYAN}make flash:{RESET_FORMAT}"
-        subheader2 = f"{COLOR_CYAN}make serialflash:{RESET_FORMAT}"
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:~^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            | {subheader1:<62} |
-            | The default command to flash controller board, it     |
-            | will detect selected microcontroller and use suitable |
-            | tool for flashing it.                                 |
-            |                                                       |
-            | {subheader2:<62} |
-            | Special command to flash STM32 microcontrollers in    |
-            | DFU mode but connected via serial. stm32flash command |
-            | will be used internally.                              |
-            |                                                       |
-            """
-        )[1:]
-        print(menu, end="")
-
-
-# noinspection DuplicatedCode
-class KlipperMcuConnectionHelpMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
-        super().__init__()
-        self.previous_menu = previous_menu
-
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        from components.klipper_firmware.menus.klipper_flash_menu import (
-            KlipperSelectMcuConnectionMenu,
-        )
-
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu
-            if previous_menu is not None
-            else KlipperSelectMcuConnectionMenu
-        )
-
-    def set_options(self) -> None:
-        pass
-
-    def print_menu(self) -> None:
-        header = " < ? > Help: Flash MCU < ? > "
-        color = COLOR_YELLOW
-        count = 62 - len(color) - len(RESET_FORMAT)
-        subheader1 = f"{COLOR_CYAN}USB:{RESET_FORMAT}"
-        subheader2 = f"{COLOR_CYAN}UART:{RESET_FORMAT}"
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:~^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            | {subheader1:<62} |
-            | Selecting USB as the connection method will scan the  |
-            | USB ports for connected controller boards. This will  |
-            | be similar to the 'ls /dev/serial/by-id/*' command    |
-            | suggested by the official Klipper documentation for   |
-            | determining successfull USB connections!              |
-            |                                                       |
-            | {subheader2:<62} |
-            | Selecting UART as the connection method will list all |
-            | possible UART serial ports. Note: This method ALWAYS  |
-            | returns something as it seems impossible to determine |
-            | if a valid Klipper controller board is connected or   |
-            | not. Because of that, you MUST know which UART serial |
-            | port your controller board is connected to when using |
-            | this connection method.                               |
-            |                                                       |
-            """
-        )[1:]
-        print(menu, end="")

kiauh/components/klipper_firmware/menus/klipper_flash_menu.py

@@ -1,442 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-import textwrap
-import time
-from typing import Optional, Type
-
-from components.klipper_firmware.firmware_utils import (
-    find_firmware_file,
-    find_uart_device,
-    find_usb_device_by_id,
-    find_usb_dfu_device,
-    get_sd_flash_board_list,
-    start_flash_process,
-)
-from components.klipper_firmware.flash_options import (
-    ConnectionType,
-    FlashCommand,
-    FlashMethod,
-    FlashOptions,
-)
-from components.klipper_firmware.menus.klipper_flash_error_menu import (
-    KlipperNoBoardTypesErrorMenu,
-    KlipperNoFirmwareErrorMenu,
-)
-from components.klipper_firmware.menus.klipper_flash_help_menu import (
-    KlipperFlashCommandHelpMenu,
-    KlipperFlashMethodHelpMenu,
-    KlipperMcuConnectionHelpMenu,
-)
-from core.menus import FooterType, Option
-from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_CYAN, COLOR_RED, COLOR_YELLOW, RESET_FORMAT
-from utils.input_utils import get_number_input
-from utils.logger import Logger
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperFlashMethodMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
-        super().__init__()
-        self.help_menu = KlipperFlashMethodHelpMenu
-        self.input_label_txt = "Select flash method"
-        self.footer_type = FooterType.BACK_HELP
-        self.flash_options = FlashOptions()
-
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        from core.menus.advanced_menu import AdvancedMenu
-
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else AdvancedMenu
-        )
-
-    def set_options(self) -> None:
-        self.options = {
-            "1": Option(self.select_regular, menu=False),
-            "2": Option(self.select_sdcard, menu=False),
-        }
-
-    def print_menu(self) -> None:
-        header = " [ MCU Flash Menu ] "
-        subheader = f"{COLOR_YELLOW}ATTENTION:{RESET_FORMAT}"
-        subline1 = f"{COLOR_YELLOW}Make sure to select the correct method for the  MCU!{RESET_FORMAT}"
-        subline2 = f"{COLOR_YELLOW}Not all MCUs support both methods!{RESET_FORMAT}"
-
-        color = COLOR_CYAN
-        count = 62 - len(color) - len(RESET_FORMAT)
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:~^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            | Select the flash method for flashing the MCU.         |
-            |                                                       |
-            | {subheader:<62} |
-            | {subline1:<62} |
-            | {subline2:<62} |
-            |-------------------------------------------------------|
-            |                                                       |
-            | 1) Regular flashing method                            |
-            | 2) Updating via SD-Card Update                        |
-            |                                                       |
-            """
-        )[1:]
-        print(menu, end="")
-
-    def select_regular(self, **kwargs):
-        self.flash_options.flash_method = FlashMethod.REGULAR
-        self.goto_next_menu()
-
-    def select_sdcard(self, **kwargs):
-        self.flash_options.flash_method = FlashMethod.SD_CARD
-        self.goto_next_menu()
-
-    def goto_next_menu(self, **kwargs):
-        if find_firmware_file():
-            KlipperFlashCommandMenu(previous_menu=self.__class__).run()
-        else:
-            KlipperNoFirmwareErrorMenu().run()
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperFlashCommandMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
-        super().__init__()
-        self.help_menu = KlipperFlashCommandHelpMenu
-        self.input_label_txt = "Select flash command"
-        self.footer_type = FooterType.BACK_HELP
-        self.flash_options = FlashOptions()
-
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else KlipperFlashMethodMenu
-        )
-
-    def set_options(self) -> None:
-        self.options = {
-            "1": Option(self.select_flash, menu=False),
-            "2": Option(self.select_serialflash, menu=False),
-        }
-        self.default_option = Option(self.select_flash, menu=False)
-
-    def print_menu(self) -> None:
-        menu = textwrap.dedent(
-            """
-            /=======================================================\\
-            |                                                       |
-            | Which flash command to use for flashing the MCU?      |
-            | 1) make flash (default)                               |
-            | 2) make serialflash (stm32flash)                      |
-            |                                                       |
-            """
-        )[1:]
-        print(menu, end="")
-
-    def select_flash(self, **kwargs):
-        self.flash_options.flash_command = FlashCommand.FLASH
-        self.goto_next_menu()
-
-    def select_serialflash(self, **kwargs):
-        self.flash_options.flash_command = FlashCommand.SERIAL_FLASH
-        self.goto_next_menu()
-
-    def goto_next_menu(self, **kwargs):
-        KlipperSelectMcuConnectionMenu(previous_menu=self.__class__).run()
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperSelectMcuConnectionMenu(BaseMenu):
-    def __init__(
-        self, previous_menu: Optional[Type[BaseMenu]] = None, standalone: bool = False
-    ):
-        super().__init__()
-        self.previous_menu = 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: Optional[Type[BaseMenu]]) -> None:
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else KlipperFlashCommandMenu
-        )
-
-    def set_options(self) -> None:
-        self.options = {
-            "1": Option(method=self.select_usb, menu=False),
-            "2": Option(method=self.select_dfu, menu=False),
-            "3": Option(method=self.select_usb_dfu, menu=False),
-        }
-
-    def print_menu(self) -> None:
-        header = "Make sure that the controller board is connected now!"
-        color = COLOR_YELLOW
-        count = 62 - len(color) - len(RESET_FORMAT)
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            |                                                       |
-            | How is the controller board connected to the host?    |
-            | 1) USB                                                |
-            | 2) UART                                               |
-            | 3) USB (DFU mode)                                     |
-            |                                                       |
-            """
-        )[1:]
-        print(menu, end="")
-
-    def select_usb(self, **kwargs):
-        self.flash_options.connection_type = ConnectionType.USB
-        self.get_mcu_list()
-
-    def select_dfu(self, **kwargs):
-        self.flash_options.connection_type = ConnectionType.UART
-        self.get_mcu_list()
-
-    def select_usb_dfu(self, **kwargs):
-        self.flash_options.connection_type = ConnectionType.USB_DFU
-        self.get_mcu_list()
-
-    def get_mcu_list(self, **kwargs):
-        conn_type = self.flash_options.connection_type
-
-        if conn_type is ConnectionType.USB:
-            Logger.print_status("Identifying MCU connected via USB ...")
-            self.flash_options.mcu_list = find_usb_device_by_id()
-        elif conn_type is ConnectionType.UART:
-            Logger.print_status("Identifying MCU possibly connected via UART ...")
-            self.flash_options.mcu_list = find_uart_device()
-        elif conn_type is ConnectionType.USB_DFU:
-            Logger.print_status("Identifying MCU connected via USB in DFU mode ...")
-            self.flash_options.mcu_list = find_usb_dfu_device()
-
-        if len(self.flash_options.mcu_list) < 1:
-            Logger.print_warn("No MCUs found!")
-            Logger.print_warn("Make sure they are connected and repeat this step.")
-
-        # if standalone is True, we only display the MCUs to the user and return
-        if self.__standalone and len(self.flash_options.mcu_list) > 0:
-            Logger.print_ok("The following MCUs were found:", prefix=False)
-            for i, mcu in enumerate(self.flash_options.mcu_list):
-                print(f"   ● MCU #{i}: {COLOR_CYAN}{mcu}{RESET_FORMAT}")
-            time.sleep(3)
-            return
-
-        self.goto_next_menu()
-
-    def goto_next_menu(self, **kwargs):
-        KlipperSelectMcuIdMenu(previous_menu=self.__class__).run()
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperSelectMcuIdMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
-        super().__init__()
-        self.flash_options = FlashOptions()
-        self.mcu_list = self.flash_options.mcu_list
-        self.input_label_txt = "Select MCU to flash"
-        self.footer_type = FooterType.BACK_HELP
-
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu
-            if previous_menu is not None
-            else KlipperSelectMcuConnectionMenu
-        )
-
-    def set_options(self) -> None:
-        self.options = {
-            f"{i}": Option(self.flash_mcu, False, f"{i}")
-            for i in range(len(self.mcu_list))
-        }
-
-    def print_menu(self) -> None:
-        header = "!!! ATTENTION !!!"
-        header2 = f"[{COLOR_CYAN}List of available MCUs{RESET_FORMAT}]"
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            | Make sure, to select the correct MCU!                 |
-            | ONLY flash a firmware created for the respective MCU! |
-            |                                                       |
-            |{header2:-^64}|
-            
-            """
-        )[1:]
-
-        for i, mcu in enumerate(self.mcu_list):
-            mcu = mcu.split("/")[-1]
-            menu += f"   ● MCU #{i}: {COLOR_CYAN}{mcu}{RESET_FORMAT}\n"
-
-        print(menu, end="\n")
-
-    def flash_mcu(self, **kwargs):
-        index = int(kwargs.get("opt_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()
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperSelectSDFlashBoardMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = 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: Optional[Type[BaseMenu]]) -> None:
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else KlipperSelectMcuIdMenu
-        )
-
-    def set_options(self) -> None:
-        self.options = {
-            f"{i}": Option(self.board_select, False, f"{i}")
-            for i in range(len(self.available_boards))
-        }
-
-    def print_menu(self) -> None:
-        if len(self.available_boards) < 1:
-            KlipperNoBoardTypesErrorMenu().run()
-        else:
-            menu = textwrap.dedent(
-                """
-                /=======================================================\\
-                | Please select the type of board that corresponds to   |
-                | the currently selected MCU ID you chose before.       |
-                |                                                       |
-                | The following boards are currently supported:         |
-                |-------------------------------------------------------|
-                """
-            )[1:]
-
-            for i, board in enumerate(self.available_boards):
-                line = f" {i}) {board}"
-                menu += f"|{line:<55}|\n"
-
-            print(menu, end="")
-
-    def board_select(self, **kwargs):
-        board = int(kwargs.get("opt_index"))
-        self.flash_options.selected_board = self.available_boards[board]
-        self.baudrate_select()
-
-    def baudrate_select(self, **kwargs):
-        menu = textwrap.dedent(
-            """
-            /=======================================================\\
-            | If your board is flashed with firmware that connects  |
-            | at a custom baud rate, please change it now.          |
-            |                                                       |
-            | If you are unsure, stick to the default 250000!       |
-            \\=======================================================/
-            """
-        )[1:]
-        print(menu, end="")
-        self.flash_options.selected_baudrate = get_number_input(
-            question="Please set the baud rate",
-            default=250000,
-            min_count=0,
-            allow_go_back=True,
-        )
-        KlipperFlashOverviewMenu(previous_menu=self.__class__).run()
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KlipperFlashOverviewMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
-        super().__init__()
-        self.flash_options = FlashOptions()
-        self.input_label_txt = "Perform action (default=Y)"
-
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        self.previous_menu: Type[BaseMenu] = previous_menu
-
-    def set_options(self) -> None:
-        self.options = {
-            "Y": Option(self.execute_flash, menu=False),
-            "N": Option(self.abort_process, menu=False),
-        }
-
-        self.default_option = Option(self.execute_flash, menu=False)
-
-    def print_menu(self) -> None:
-        header = "!!! ATTENTION !!!"
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
-
-        method = self.flash_options.flash_method.value
-        command = self.flash_options.flash_command.value
-        conn_type = self.flash_options.connection_type.value
-        mcu = self.flash_options.selected_mcu
-        board = self.flash_options.selected_board
-        baudrate = self.flash_options.selected_baudrate
-        subheader = f"[{COLOR_CYAN}Overview{RESET_FORMAT}]"
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            | Before contuining the flashing process, please check  |
-            | if all parameters were set correctly! Once you made   |
-            | sure everything is correct, start the process. If any |
-            | parameter needs to be changed, you can go back (B)    |
-            | step by step or abort and start from the beginning.   |
-            |{subheader:-^64}|
-            
-            """
-        )[1:]
-
-        menu += f"   ● MCU: {COLOR_CYAN}{mcu}{RESET_FORMAT}\n"
-        menu += f"   ● Connection: {COLOR_CYAN}{conn_type}{RESET_FORMAT}\n"
-        menu += f"   ● Flash method: {COLOR_CYAN}{method}{RESET_FORMAT}\n"
-        menu += f"   ● Flash command: {COLOR_CYAN}{command}{RESET_FORMAT}\n"
-
-        if self.flash_options.flash_method is FlashMethod.SD_CARD:
-            menu += f"   ● Board type: {COLOR_CYAN}{board}{RESET_FORMAT}\n"
-            menu += f"   ● Baudrate: {COLOR_CYAN}{baudrate}{RESET_FORMAT}\n"
-
-        menu += textwrap.dedent(
-            """
-            |-------------------------------------------------------|
-            |  Y) Start flash process                               |
-            |  N) Abort - Return to Advanced Menu                   |
-            """
-        )
-        print(menu, end="")
-
-    def execute_flash(self, **kwargs):
-        start_flash_process(self.flash_options)
-        Logger.print_info("Returning to MCU Flash Menu in 5 seconds ...")
-        time.sleep(5)
-        KlipperFlashMethodMenu().run()
-
-    def abort_process(self, **kwargs):
-        from core.menus.advanced_menu import AdvancedMenu
-
-        AdvancedMenu().run()

kiauh/components/klipperscreen/__init__.py

@@ -1,16 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-from pathlib import Path
-
-from core.backup_manager import BACKUP_ROOT_DIR
-
-KLIPPERSCREEN_REPO = "https://github.com/KlipperScreen/KlipperScreen.git"
-KLIPPERSCREEN_DIR = Path.home().joinpath("KlipperScreen")
-KLIPPERSCREEN_ENV = Path.home().joinpath(".KlipperScreen-env")
-KLIPPERSCREEN_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("klipperscreen-backups")

kiauh/components/klipperscreen/klipperscreen.py

@@ -1,219 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-import shutil
-from pathlib import Path
-from subprocess import CalledProcessError, run
-from typing import List
-
-from components.klipper.klipper import Klipper
-from components.klipperscreen import (
-    KLIPPERSCREEN_BACKUP_DIR,
-    KLIPPERSCREEN_DIR,
-    KLIPPERSCREEN_ENV,
-    KLIPPERSCREEN_REPO,
-)
-from components.moonraker.moonraker import Moonraker
-from core.backup_manager.backup_manager import BackupManager
-from core.instance_manager.instance_manager import InstanceManager
-from core.settings.kiauh_settings import KiauhSettings
-from utils.common import (
-    check_install_dependencies,
-    get_install_status,
-)
-from utils.config_utils import add_config_section, remove_config_section
-from utils.constants import SYSTEMD
-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.logger import DialogType, Logger
-from utils.sys_utils import (
-    check_python_version,
-    cmd_sysctl_manage,
-    cmd_sysctl_service,
-    install_python_requirements,
-)
-from utils.types import ComponentStatus
-
-
-def install_klipperscreen() -> None:
-    Logger.print_status("Installing KlipperScreen ...")
-
-    if not check_python_version(3, 7):
-        return
-
-    mr_im = InstanceManager(Moonraker)
-    mr_instances = mr_im.instances
-    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.",
-            ],
-            end="",
-        )
-        if not get_confirm(
-            "Continue KlipperScreen installation?",
-            default_choice=False,
-            allow_go_back=True,
-        ):
-            return
-
-    package_list = ["git", "wget", "curl", "unzip", "dfu-util"]
-    check_install_dependencies(package_list)
-
-    git_clone_wrapper(KLIPPERSCREEN_REPO, KLIPPERSCREEN_DIR)
-
-    try:
-        script = f"{KLIPPERSCREEN_DIR}/scripts/KlipperScreen-install.sh"
-        run(script, shell=True, check=True)
-        if mr_instances:
-            patch_klipperscreen_update_manager(mr_instances)
-            mr_im.restart_all_instance()
-        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:
-    env_py = f"{KLIPPERSCREEN_ENV}/bin/python"
-    add_config_section(
-        section="update_manager KlipperScreen",
-        instances=instances,
-        options=[
-            ("type", "git_repo"),
-            ("path", str(KLIPPERSCREEN_DIR)),
-            ("orgin", KLIPPERSCREEN_REPO),
-            ("env", env_py),
-            ("requirements", "scripts/KlipperScreen-requirements.txt"),
-            ("install_script", "scripts/KlipperScreen-install.sh"),
-        ],
-    )
-
-
-def update_klipperscreen() -> None:
-    try:
-        cmd_sysctl_service("KlipperScreen", "stop")
-
-        if not KLIPPERSCREEN_DIR.exists():
-            Logger.print_info(
-                "KlipperScreen does not seem to be installed! Skipping ..."
-            )
-            return
-
-        Logger.print_status("Updating KlipperScreen ...")
-
-        cmd_sysctl_service("KlipperScreen", "stop")
-
-        settings = KiauhSettings()
-        if settings.kiauh.backup_before_update:
-            backup_klipperscreen_dir()
-
-        git_pull_wrapper(KLIPPERSCREEN_REPO, KLIPPERSCREEN_DIR)
-
-        requirements = KLIPPERSCREEN_DIR.joinpath(
-            "/scripts/KlipperScreen-requirements.txt"
-        )
-        install_python_requirements(KLIPPERSCREEN_ENV, requirements)
-
-        cmd_sysctl_service("KlipperScreen", "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,
-        files=[SYSTEMD.joinpath("KlipperScreen.service")],
-    )
-
-
-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.exists():
-            Logger.print_status("Removing KlipperScreen environment ...")
-            shutil.rmtree(KLIPPERSCREEN_ENV)
-            Logger.print_ok("KlipperScreen environment successfully removed!")
-        else:
-            Logger.print_warn("KlipperScreen environment not found!")
-
-        service = SYSTEMD.joinpath("KlipperScreen.service")
-        if service.exists():
-            Logger.print_status("Removing KlipperScreen service ...")
-            cmd_sysctl_service(service, "stop")
-            cmd_sysctl_service(service, "disable")
-            remove_with_sudo(service)
-            cmd_sysctl_manage("daemon-reload")
-            cmd_sysctl_manage("reset-failed")
-            Logger.print_ok("KlipperScreen service successfully removed!")
-
-        logfile = Path("/tmp/KlipperScreen.log")
-        if logfile.exists():
-            Logger.print_status("Removing KlipperScreen log file ...")
-            remove_with_sudo(logfile)
-            Logger.print_ok("KlipperScreen log file successfully removed!")
-
-        kl_im = InstanceManager(Klipper)
-        kl_instances: List[Klipper] = kl_im.instances
-        for instance in kl_instances:
-            logfile = instance.log_dir.joinpath("KlipperScreen.log")
-            if logfile.exists():
-                Logger.print_status(f"Removing {logfile} ...")
-                Path(logfile).unlink()
-                Logger.print_ok(f"{logfile} successfully removed!")
-
-        mr_im = InstanceManager(Moonraker)
-        mr_instances: List[Moonraker] = mr_im.instances
-        if mr_instances:
-            Logger.print_status("Removing KlipperScreen from update manager ...")
-            remove_config_section("update_manager KlipperScreen", mr_instances)
-            Logger.print_ok("KlipperScreen successfully removed from update manager!")
-
-        Logger.print_ok("KlipperScreen successfully removed!")
-
-    except Exception as e:
-        Logger.print_error(f"Error removing KlipperScreen:\n{e}")
-
-
-def backup_klipperscreen_dir() -> None:
-    bm = BackupManager()
-    bm.backup_directory(
-        "KlipperScreen",
-        source=KLIPPERSCREEN_DIR,
-        target=KLIPPERSCREEN_BACKUP_DIR,
-    )
-    bm.backup_directory(
-        "KlipperScreen-env",
-        source=KLIPPERSCREEN_ENV,
-        target=KLIPPERSCREEN_BACKUP_DIR,
-    )

kiauh/components/log_uploads/__init__.py

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

kiauh/components/log_uploads/log_upload_utils.py

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

kiauh/components/log_uploads/menus/log_upload_menu.py

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

kiauh/components/mobileraker/__init__.py

@@ -1,16 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-from pathlib import Path
-
-from core.backup_manager import BACKUP_ROOT_DIR
-
-MOBILERAKER_REPO = "https://github.com/Clon1998/mobileraker_companion.git"
-MOBILERAKER_DIR = Path.home().joinpath("mobileraker_companion")
-MOBILERAKER_ENV = Path.home().joinpath("mobileraker-env")
-MOBILERAKER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("mobileraker-backups")

kiauh/components/mobileraker/mobileraker.py

@@ -1,211 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-import shutil
-from pathlib import Path
-from subprocess import CalledProcessError, run
-from typing import List
-
-from components.klipper.klipper import Klipper
-from components.mobileraker import (
-    MOBILERAKER_BACKUP_DIR,
-    MOBILERAKER_DIR,
-    MOBILERAKER_ENV,
-    MOBILERAKER_REPO,
-)
-from components.moonraker.moonraker import Moonraker
-from core.backup_manager.backup_manager import BackupManager
-from core.instance_manager.instance_manager import InstanceManager
-from core.settings.kiauh_settings import KiauhSettings
-from utils.common import check_install_dependencies, get_install_status
-from utils.config_utils import add_config_section, remove_config_section
-from utils.constants import SYSTEMD
-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.logger import DialogType, Logger
-from utils.sys_utils import (
-    check_python_version,
-    cmd_sysctl_manage,
-    cmd_sysctl_service,
-    install_python_requirements,
-)
-from utils.types import ComponentStatus
-
-
-def install_mobileraker() -> None:
-    Logger.print_status("Installing Mobileraker's companion ...")
-
-    if not check_python_version(3, 7):
-        return
-
-    mr_im = InstanceManager(Moonraker)
-    mr_instances = mr_im.instances
-    if not mr_instances:
-        Logger.print_dialog(
-            DialogType.WARNING,
-            [
-                "Moonraker not found! Mobileraker's companion will not properly work "
-                "without a working Moonraker installation.",
-                "Mobileraker's companion's update manager configuration for Moonraker "
-                "will not be added to any moonraker.conf.",
-            ],
-            end="",
-        )
-        if not get_confirm(
-            "Continue Mobileraker's companion installation?",
-            default_choice=False,
-            allow_go_back=True,
-        ):
-            return
-
-    package_list = ["git", "wget", "curl", "unzip", "dfu-util"]
-    check_install_dependencies(package_list)
-
-    git_clone_wrapper(MOBILERAKER_REPO, MOBILERAKER_DIR)
-
-    try:
-        script = f"{MOBILERAKER_DIR}/scripts/install.sh"
-        run(script, shell=True, check=True)
-        if mr_instances:
-            patch_mobileraker_update_manager(mr_instances)
-            mr_im.restart_all_instance()
-        else:
-            Logger.print_info(
-                "Moonraker is not installed! Cannot add Mobileraker's "
-                "companion to update manager!"
-            )
-        Logger.print_ok("Mobileraker's companion successfully installed!")
-    except CalledProcessError as e:
-        Logger.print_error(f"Error installing Mobileraker's companion:\n{e}")
-        return
-
-
-def patch_mobileraker_update_manager(instances: List[Moonraker]) -> None:
-    env_py = f"{MOBILERAKER_ENV}/bin/python"
-    add_config_section(
-        section="update_manager mobileraker",
-        instances=instances,
-        options=[
-            ("type", "git_repo"),
-            ("path", "mobileraker_companion"),
-            ("orgin", MOBILERAKER_REPO),
-            ("primary_branch", "main"),
-            ("managed_services", "mobileraker"),
-            ("env", env_py),
-            ("requirements", "scripts/mobileraker-requirements.txt"),
-            ("install_script", "scripts/install.sh"),
-        ],
-    )
-
-
-def update_mobileraker() -> None:
-    try:
-        if not MOBILERAKER_DIR.exists():
-            Logger.print_info(
-                "Mobileraker's companion does not seem to be installed! Skipping ..."
-            )
-            return
-
-        Logger.print_status("Updating Mobileraker's companion ...")
-
-        cmd_sysctl_service("mobileraker", "stop")
-
-        settings = KiauhSettings()
-        if settings.kiauh.backup_before_update:
-            backup_mobileraker_dir()
-
-        git_pull_wrapper(MOBILERAKER_REPO, MOBILERAKER_DIR)
-
-        requirements = MOBILERAKER_DIR.joinpath("/scripts/mobileraker-requirements.txt")
-        install_python_requirements(MOBILERAKER_ENV, requirements)
-
-        cmd_sysctl_service("mobileraker", "start")
-
-        Logger.print_ok("Mobileraker's companion updated successfully.", end="\n\n")
-    except CalledProcessError as e:
-        Logger.print_error(f"Error updating Mobileraker's companion:\n{e}")
-        return
-
-
-def get_mobileraker_status() -> ComponentStatus:
-    return get_install_status(
-        MOBILERAKER_DIR,
-        MOBILERAKER_ENV,
-        files=[SYSTEMD.joinpath("mobileraker.service")],
-    )
-
-
-def remove_mobileraker() -> None:
-    Logger.print_status("Removing Mobileraker's companion ...")
-    try:
-        if MOBILERAKER_DIR.exists():
-            Logger.print_status("Removing Mobileraker's companion directory ...")
-            shutil.rmtree(MOBILERAKER_DIR)
-            Logger.print_ok("Mobileraker's companion directory successfully removed!")
-        else:
-            Logger.print_warn("Mobileraker's companion directory not found!")
-
-        if MOBILERAKER_ENV.exists():
-            Logger.print_status("Removing Mobileraker's companion environment ...")
-            shutil.rmtree(MOBILERAKER_ENV)
-            Logger.print_ok("Mobileraker's companion environment successfully removed!")
-        else:
-            Logger.print_warn("Mobileraker's companion environment not found!")
-
-        service = SYSTEMD.joinpath("mobileraker.service")
-        if service.exists():
-            Logger.print_status("Removing mobileraker service ...")
-            cmd_sysctl_service(service, "stop")
-            cmd_sysctl_service(service, "disable")
-            remove_with_sudo(service)
-            cmd_sysctl_manage("daemon-reload")
-            cmd_sysctl_manage("reset-failed")
-            Logger.print_ok("Mobileraker's companion service successfully removed!")
-
-        kl_im = InstanceManager(Klipper)
-        kl_instances: List[Klipper] = kl_im.instances
-        for instance in kl_instances:
-            logfile = instance.log_dir.joinpath("mobileraker.log")
-            if logfile.exists():
-                Logger.print_status(f"Removing {logfile} ...")
-                Path(logfile).unlink()
-                Logger.print_ok(f"{logfile} successfully removed!")
-
-        mr_im = InstanceManager(Moonraker)
-        mr_instances: List[Moonraker] = mr_im.instances
-        if mr_instances:
-            Logger.print_status(
-                "Removing Mobileraker's companion from update manager ..."
-            )
-            remove_config_section("update_manager mobileraker", mr_instances)
-            Logger.print_ok(
-                "Mobileraker's companion successfully removed from update manager!"
-            )
-
-        Logger.print_ok("Mobileraker's companion successfully removed!")
-
-    except Exception as e:
-        Logger.print_error(f"Error removing Mobileraker's companion:\n{e}")
-
-
-def backup_mobileraker_dir() -> None:
-    bm = BackupManager()
-    bm.backup_directory(
-        "mobileraker_companion",
-        source=MOBILERAKER_DIR,
-        target=MOBILERAKER_BACKUP_DIR,
-    )
-    bm.backup_directory(
-        "mobileraker-env",
-        source=MOBILERAKER_ENV,
-        target=MOBILERAKER_BACKUP_DIR,
-    )

kiauh/components/moonraker/__init__.py

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

kiauh/components/moonraker/assets/moonraker.conf

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

kiauh/components/moonraker/assets/moonraker.env

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

kiauh/components/moonraker/assets/moonraker.service

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

kiauh/components/moonraker/menus/moonraker_remove_menu.py

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

kiauh/components/moonraker/moonraker.py

@@ -1,158 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-from __future__ import annotations
-
-import subprocess
-from pathlib import Path
-from typing import List
-
-from components.moonraker import MODULE_PATH, MOONRAKER_DIR, MOONRAKER_ENV_DIR
-from core.instance_manager.base_instance import BaseInstance
-from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
-    SimpleConfigParser,
-)
-from utils.constants import SYSTEMD
-from utils.logger import Logger
-
-
-# noinspection PyMethodMayBeStatic
-class Moonraker(BaseInstance):
-    @classmethod
-    def blacklist(cls) -> List[str]:
-        return ["None", "mcu", "obico"]
-
-    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._comms_dir = self.data_dir.joinpath("comms")
-        self.log = self.log_dir.joinpath("moonraker.log")
-
-    @property
-    def db_dir(self) -> Path:
-        return self._db_dir
-
-    @property
-    def comms_dir(self) -> Path:
-        return self._comms_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:
-            self.create_folders([self.backup_dir, self.certs_dir, self._db_dir])
-            self.write_service_file(
-                service_template_path, service_file_target, env_file_target
-            )
-            self.write_env_file(env_template_file_path, env_file_target)
-
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(
-                f"Error creating service file {service_file_target}: {e}"
-            )
-            raise
-        except OSError as e:
-            Logger.print_error(f"Error writing file: {e}")
-            raise
-
-    def delete(self) -> None:
-        service_file = self.get_service_file_name(extension=True)
-        service_file_path = self.get_service_file_path()
-
-        Logger.print_status(f"Deleting Moonraker Instance: {service_file}")
-
-        try:
-            command = ["sudo", "rm", "-f", service_file_path]
-            subprocess.run(command, check=True)
-            Logger.print_ok(f"Service file deleted: {service_file_path}")
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(f"Error deleting service file: {e}")
-            raise
-
-    def write_service_file(
-        self,
-        service_template_path: Path,
-        service_file_target: Path,
-        env_file_target: Path,
-    ) -> None:
-        service_content = self._prep_service_file(
-            service_template_path, env_file_target
-        )
-        command = ["sudo", "tee", service_file_target]
-        subprocess.run(
-            command,
-            input=service_content.encode(),
-            stdout=subprocess.DEVNULL,
-            check=True,
-        )
-        Logger.print_ok(f"Service file created: {service_file_target}")
-
-    def write_env_file(
-        self, env_template_file_path: Path, env_file_target: Path
-    ) -> None:
-        env_file_content = self._prep_env_file(env_template_file_path)
-        with open(env_file_target, "w") as env_file:
-            env_file.write(env_file_content)
-        Logger.print_ok(f"Env file created: {env_file_target}")
-
-    def _prep_service_file(
-        self, service_template_path: Path, env_file_path: Path
-    ) -> str:
-        try:
-            with open(service_template_path, "r") as template_file:
-                template_content = template_file.read()
-        except FileNotFoundError:
-            Logger.print_error(
-                f"Unable to open {service_template_path} - File not found"
-            )
-            raise
-        service_content = template_content.replace("%USER%", self.user)
-        service_content = service_content.replace(
-            "%MOONRAKER_DIR%", str(self.moonraker_dir)
-        )
-        service_content = service_content.replace("%ENV%", str(self.env_dir))
-        service_content = service_content.replace("%ENV_FILE%", str(env_file_path))
-        return service_content
-
-    def _prep_env_file(self, env_template_file_path: Path) -> str:
-        try:
-            with open(env_template_file_path, "r") as env_file:
-                env_template_file_content = env_file.read()
-        except FileNotFoundError:
-            Logger.print_error(
-                f"Unable to open {env_template_file_path} - File not found"
-            )
-            raise
-        env_file_content = env_template_file_content.replace(
-            "%MOONRAKER_DIR%", str(self.moonraker_dir)
-        )
-        env_file_content = env_file_content.replace(
-            "%PRINTER_DATA%", str(self.data_dir)
-        )
-        return env_file_content
-
-    def _get_port(self) -> int | None:
-        if not self.cfg_file.is_file():
-            return None
-
-        scp = SimpleConfigParser()
-        scp.read(self.cfg_file)
-        port = scp.getint("server", "port", fallback=None)
-
-        return port

kiauh/components/moonraker/moonraker_dialogs.py

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

kiauh/components/moonraker/moonraker_remove.py

@@ -1,160 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-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.fs_utils import remove_file
-from utils.input_utils import get_selection_input
-from utils.logger import Logger
-from utils.sys_utils import cmd_sysctl_manage
-
-
-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, show_index=True, show_select_all=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()
-
-    cmd_sysctl_manage("daemon-reload")
-
-
-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

@@ -1,218 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-import json
-import subprocess
-from pathlib import Path
-
-from components.klipper.klipper import Klipper
-from components.moonraker import (
-    EXIT_MOONRAKER_SETUP,
-    MOONRAKER_DIR,
-    MOONRAKER_ENV_DIR,
-    MOONRAKER_REQUIREMENTS_TXT,
-    POLKIT_FILE,
-    POLKIT_LEGACY_FILE,
-    POLKIT_SCRIPT,
-    POLKIT_USR_FILE,
-)
-from components.moonraker.moonraker import Moonraker
-from components.moonraker.moonraker_dialogs import print_moonraker_overview
-from components.moonraker.moonraker_utils import (
-    backup_moonraker_dir,
-    create_example_moonraker_conf,
-)
-from components.webui_client.client_utils import (
-    enable_mainsail_remotemode,
-    get_existing_clients,
-)
-from components.webui_client.mainsail_data import MainsailData
-from core.instance_manager.instance_manager import InstanceManager
-from core.settings.kiauh_settings import KiauhSettings
-from utils.common import check_install_dependencies
-from utils.fs_utils import check_file_exist
-from utils.git_utils import git_clone_wrapper, git_pull_wrapper
-from utils.input_utils import (
-    get_confirm,
-    get_selection_input,
-)
-from utils.logger import Logger
-from utils.sys_utils import (
-    check_python_version,
-    cmd_sysctl_manage,
-    create_python_venv,
-    install_python_requirements,
-    parse_packages_from_file,
-)
-
-
-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?")
-
-    try:
-        check_install_dependencies(["git"])
-        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:
-                # 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(current_instance, used_ports_map, clients)
-
-            mr_im.start_instance()
-
-        cmd_sysctl_manage("daemon-reload")
-
-        # if mainsail is installed, and we installed
-        # multiple moonraker instances, we enable mainsails remote mode
-        if MainsailData().client_dir.exists() and len(mr_im.instances) > 1:
-            enable_mainsail_remotemode()
-
-    except Exception as e:
-        Logger.print_error(f"Error while installing Moonraker: {e}")
-        return
-
-
-def check_moonraker_install_requirements() -> bool:
-    def check_klipper_instances() -> bool:
-        if len(InstanceManager(Klipper).instances) >= 1:
-            return True
-
-        Logger.print_warn("Klipper not installed!")
-        Logger.print_warn("Moonraker cannot be installed! Install Klipper first.")
-        return False
-
-    return check_python_version(3, 7) and check_klipper_instances()
-
-
-def setup_moonraker_prerequesites() -> None:
-    settings = KiauhSettings()
-    repo = settings.moonraker.repo_url
-    branch = settings.moonraker.branch
-
-    git_clone_wrapper(repo, MOONRAKER_DIR, branch)
-
-    # install moonraker dependencies and create python virtualenv
-    install_moonraker_packages(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:
-    install_script = moonraker_dir.joinpath("scripts/install-moonraker.sh")
-    deps_json = MOONRAKER_DIR.joinpath("scripts/system-dependencies.json")
-    moonraker_deps = []
-
-    if deps_json.exists():
-        with open(deps_json, "r") as deps:
-            moonraker_deps = json.load(deps).get("debian", [])
-    elif install_script.exists():
-        moonraker_deps = parse_packages_from_file(install_script)
-
-    if not moonraker_deps:
-        raise ValueError("Error reading Moonraker dependencies!")
-
-    check_install_dependencies(moonraker_deps)
-
-
-def install_moonraker_polkit() -> None:
-    Logger.print_status("Installing Moonraker policykit rules ...")
-
-    legacy_file_exists = check_file_exist(POLKIT_LEGACY_FILE, True)
-    polkit_file_exists = check_file_exist(POLKIT_FILE, True)
-    usr_file_exists = check_file_exist(POLKIT_USR_FILE, True)
-
-    if legacy_file_exists or (polkit_file_exists and usr_file_exists):
-        Logger.print_info("Moonraker policykit rules are already installed.")
-        return
-
-    try:
-        command = [POLKIT_SCRIPT, "--disable-systemctl"]
-        result = subprocess.run(
-            command,
-            stderr=subprocess.PIPE,
-            stdout=subprocess.DEVNULL,
-            text=True,
-        )
-        if result.returncode != 0 or result.stderr:
-            Logger.print_error(f"{result.stderr}", False)
-            Logger.print_error("Installing Moonraker policykit rules failed!")
-            return
-
-        Logger.print_ok("Moonraker policykit rules successfully installed!")
-    except subprocess.CalledProcessError as e:
-        log = f"Error while installing Moonraker policykit rules: {e.stderr.decode()}"
-        Logger.print_error(log)
-
-
-def update_moonraker() -> None:
-    if not get_confirm("Update Moonraker now?"):
-        return
-
-    settings = KiauhSettings()
-    if settings.kiauh.backup_before_update:
-        backup_moonraker_dir()
-
-    instance_manager = InstanceManager(Moonraker)
-    instance_manager.stop_all_instance()
-
-    git_pull_wrapper(
-        repo=settings.moonraker.repo_url, target_dir=MOONRAKER_DIR
-    )
-
-    # 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

@@ -1,200 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-import shutil
-from typing import Dict, List, Optional
-
-from components.moonraker import (
-    DEFAULT_MOONRAKER_PORT,
-    MODULE_PATH,
-    MOONRAKER_BACKUP_DIR,
-    MOONRAKER_DB_BACKUP_DIR,
-    MOONRAKER_DIR,
-    MOONRAKER_ENV_DIR,
-)
-from components.moonraker.moonraker import Moonraker
-from components.webui_client.base_data import BaseWebClient
-from components.webui_client.client_utils import enable_mainsail_remotemode
-from components.webui_client.mainsail_data import MainsailData
-from core.backup_manager.backup_manager import BackupManager
-from core.instance_manager.instance_manager import InstanceManager
-from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
-    SimpleConfigParser,
-)
-from utils.common import get_install_status
-from utils.logger import Logger
-from utils.sys_utils import (
-    get_ipv4_addr,
-)
-from utils.types import ComponentStatus
-
-
-def get_moonraker_status() -> ComponentStatus:
-    return get_install_status(MOONRAKER_DIR, MOONRAKER_ENV_DIR, Moonraker)
-
-
-def create_example_moonraker_conf(
-    instance: Moonraker,
-    ports_map: Dict[str, int],
-    clients: Optional[List[BaseWebClient]] = None,
-) -> None:
-    Logger.print_status(f"Creating example moonraker.conf in '{instance.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")
-
-    scp = SimpleConfigParser()
-    scp.read(target)
-    trusted_clients: List[str] = [
-        ".".join(ip),
-        *scp.get("authorization", "trusted_clients"),
-    ]
-
-    scp.set("server", "port", str(port))
-    scp.set("server", "klippy_uds_address", str(uds))
-    scp.set(
-        "authorization",
-        "trusted_clients",
-        "\n".join(trusted_clients),
-        True,
-    )
-
-    # add existing client and client configs in the update section
-    if clients is not None and len(clients) > 0:
-        for c in clients:
-            # client part
-            c_section = f"update_manager {c.name}"
-            c_options = [
-                ("type", "web"),
-                ("channel", "stable"),
-                ("repo", c.repo_path),
-                ("path", c.client_dir),
-            ]
-            scp.add_section(section=c_section)
-            for option in c_options:
-                scp.set(c_section, option[0], option[1])
-
-            # client config part
-            c_config = c.client_config
-            if c_config.config_dir.exists():
-                c_config_section = f"update_manager {c_config.name}"
-                c_config_options = [
-                    ("type", "git_repo"),
-                    ("primary_branch", "master"),
-                    ("path", c_config.config_dir),
-                    ("origin", c_config.repo_url),
-                    ("managed_services", "klipper"),
-                ]
-                scp.add_section(section=c_config_section)
-                for option in c_config_options:
-                    scp.set(c_config_section, option[0], option[1])
-
-    scp.write(target)
-    Logger.print_ok(f"Example moonraker.conf created in '{instance.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 moonraker instance with the new name
-    new_instance = Moonraker(suffix=new_name)
-    im.current_instance = new_instance
-
-    # patch the server sections klippy_uds_address value to match the new printer_data foldername
-    scp = SimpleConfigParser()
-    scp.read(new_instance.cfg_file)
-    if scp.has_section("server"):
-        scp.set(
-            "server",
-            "klippy_uds_address",
-            str(new_instance.comms_dir.joinpath("klippy.sock")),
-        )
-        scp.write(new_instance.cfg_file)
-
-    # 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 MainsailData().client_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/webui_client/__init__.py

@@ -1,12 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from pathlib import Path
-
-MODULE_PATH = Path(__file__).resolve().parent

kiauh/components/webui_client/assets/nginx_cfg

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

kiauh/components/webui_client/base_data.py

@@ -1,112 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from __future__ import annotations
-
-from abc import ABC, abstractmethod
-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"
-
-
-class BaseWebClient(ABC):
-    """Base class for webclient data"""
-
-    @property
-    @abstractmethod
-    def client(self) -> WebClientType:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def name(self) -> str:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def display_name(self) -> str:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def client_dir(self) -> Path:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def backup_dir(self) -> Path:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def repo_path(self) -> str:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def download_url(self) -> str:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def client_config(self) -> BaseWebClientConfig:
-        raise NotImplementedError
-
-
-class BaseWebClientConfig(ABC):
-    """Base class for webclient config data"""
-
-    @property
-    @abstractmethod
-    def client_config(self) -> WebClientConfigType:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def name(self) -> str:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def display_name(self) -> str:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def config_filename(self) -> str:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def config_dir(self) -> Path:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def backup_dir(self) -> Path:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def repo_url(self) -> str:
-        raise NotImplementedError
-
-    @property
-    @abstractmethod
-    def config_section(self) -> str:
-        raise NotImplementedError

kiauh/components/webui_client/client_config/client_config_remove.py

@@ -1,61 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-
-import shutil
-import subprocess
-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.instance_manager.instance_manager import InstanceManager
-from utils.config_utils import remove_config_section
-from utils.fs_utils import remove_file
-from utils.logger import Logger
-
-
-def run_client_config_removal(
-    client_config: BaseWebClientConfig,
-    kl_instances: List[Klipper],
-    mr_instances: List[Moonraker],
-) -> None:
-    remove_client_config_dir(client_config)
-    remove_client_config_symlink(client_config)
-    remove_config_section(f"update_manager {client_config.name}", mr_instances)
-    remove_config_section(client_config.config_section, kl_instances)
-
-
-def remove_client_config_dir(client_config: BaseWebClientConfig) -> None:
-    Logger.print_status(f"Removing {client_config.name} ...")
-    client_config_dir = client_config.config_dir
-    if not client_config_dir.exists():
-        Logger.print_info(f"'{client_config_dir}' does not exist. Skipping ...")
-        return
-
-    try:
-        shutil.rmtree(client_config_dir)
-    except OSError as e:
-        Logger.print_error(f"Unable to delete '{client_config_dir}':\n{e}")
-
-
-def remove_client_config_symlink(client_config: BaseWebClientConfig) -> None:
-    im = InstanceManager(Klipper)
-    instances: List[Klipper] = im.instances
-    for instance in instances:
-        Logger.print_status(f"Removing symlink from '{instance.cfg_dir}' ...")
-        symlink = instance.cfg_dir.joinpath(client_config.config_filename)
-        if not symlink.is_symlink():
-            Logger.print_info(f"'{symlink}' does not exist. Skipping ...")
-            continue
-
-        try:
-            remove_file(symlink)
-        except subprocess.CalledProcessError:
-            Logger.print_error("Failed to remove symlink!")

kiauh/components/webui_client/client_config/client_config_setup.py

@@ -1,129 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-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,
-    config_for_other_client_exist,
-)
-from core.instance_manager.instance_manager import InstanceManager
-from core.settings.kiauh_settings import KiauhSettings
-from utils.common import backup_printer_config_dir
-from utils.config_utils import add_config_section, add_config_section_at_top
-from utils.fs_utils import create_symlink
-from utils.git_utils import git_clone_wrapper, git_pull_wrapper
-from utils.input_utils import get_confirm
-from utils.logger import Logger
-
-
-def install_client_config(client_data: BaseWebClient) -> None:
-    client_config: BaseWebClientConfig = client_data.client_config
-    display_name = client_config.display_name
-
-    if config_for_other_client_exist(client_data.client):
-        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_im = InstanceManager(Moonraker)
-    mr_instances: List[Moonraker] = mr_im.instances
-    kl_im = InstanceManager(Klipper)
-    kl_instances = kl_im.instances
-
-    try:
-        download_client_config(client_config)
-        create_client_config_symlink(client_config, kl_instances)
-
-        backup_printer_config_dir()
-
-        add_config_section(
-            section=f"update_manager {client_config.name}",
-            instances=mr_instances,
-            options=[
-                ("type", "git_repo"),
-                ("primary_branch", "master"),
-                ("path", str(client_config.config_dir)),
-                ("origin", str(client_config.repo_url)),
-                ("managed_services", "klipper"),
-            ],
-        )
-        add_config_section_at_top(client_config.config_section, kl_instances)
-        kl_im.restart_all_instance()
-
-    except Exception as e:
-        Logger.print_error(f"{display_name} installation failed!\n{e}")
-        return
-
-    Logger.print_ok(f"{display_name} installation complete!", start="\n")
-
-
-def download_client_config(client_config: BaseWebClientConfig) -> None:
-    try:
-        Logger.print_status(f"Downloading {client_config.display_name} ...")
-        repo = client_config.repo_url
-        target_dir = client_config.config_dir
-        git_clone_wrapper(repo, target_dir)
-    except Exception:
-        Logger.print_error(f"Downloading {client_config.display_name} failed!")
-        raise
-
-
-def update_client_config(client: BaseWebClient) -> None:
-    client_config: BaseWebClientConfig = client.client_config
-
-    Logger.print_status(f"Updating {client_config.display_name} ...")
-
-    if not client_config.config_dir.exists():
-        Logger.print_info(
-            f"Unable to update {client_config.display_name}. Directory does not exist! Skipping ..."
-        )
-        return
-
-    settings = KiauhSettings()
-    if settings.kiauh.backup_before_update:
-        backup_client_config_data(client)
-
-    git_pull_wrapper(client_config.repo_url, client_config.config_dir)
-
-    Logger.print_ok(f"Successfully updated {client_config.display_name}.")
-    Logger.print_info("Restart Klipper to reload the configuration!")
-
-
-def create_client_config_symlink(
-    client_config: BaseWebClientConfig, klipper_instances: List[Klipper] = None
-) -> None:
-    if klipper_instances is None:
-        kl_im = InstanceManager(Klipper)
-        klipper_instances = kl_im.instances
-
-    Logger.print_status(f"Create symlink for {client_config.config_filename} ...")
-    source = Path(client_config.config_dir, client_config.config_filename)
-    for instance in klipper_instances:
-        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!")

kiauh/components/webui_client/client_dialogs.py

@@ -1,108 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-import textwrap
-from typing import List
-
-from components.webui_client.base_data import BaseWebClient
-from core.menus.base_menu import print_back_footer
-from utils.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
-
-
-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_client_already_installed_dialog(name: str):
-    line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
-    line2 = f"{COLOR_YELLOW}{name} seems to be already installed!{RESET_FORMAT}"
-    line3 = f"If you continue, your current {name}"
-    dialog = textwrap.dedent(
-        f"""
-        /=======================================================\\
-        | {line1:<63}|
-        | {line2:<63}|
-        |-------------------------------------------------------|
-        | {line3:<54}|
-        | installation will be overwritten.                     |
-        """
-    )[1:]
-
-    print(dialog, end="")
-    print_back_footer()
-
-
-def print_client_port_select_dialog(name: str, port: int, ports_in_use: List[int]):
-    port = f"{COLOR_CYAN}{port}{RESET_FORMAT}"
-    line1 = f"Please select the port, {name} should be served on."
-    line2 = f"In case you need {name} to be served on a specific"
-    dialog = textwrap.dedent(
-        f"""
-        /=======================================================\\
-        | {line1:<54}|
-        | If you are unsure what to select, hit Enter to apply  |
-        | the suggested value of: {port:38} |
-        |                                                       |
-        | {line2:<54}|
-        | 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="")
-
-
-def print_install_client_config_dialog(client: BaseWebClient):
-    name = client.display_name
-    url = client.client_config.repo_url.replace(".git", "")
-    line1 = f"have {name} fully functional and working."
-    line2 = f"The recommended macros for {name} can be seen here:"
-    dialog = textwrap.dedent(
-        f"""
-        /=======================================================\\
-        | It is recommended to use special macros in order to   |
-        | {line1:<54}|
-        |                                                       |
-        | {line2:<54}|
-        | {url:<54}|
-        |                                                       |
-        | 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="")

kiauh/components/webui_client/client_remove.py

@@ -1,74 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-
-import shutil
-from typing import List
-
-from components.klipper.klipper import Klipper
-from components.moonraker.moonraker import Moonraker
-from components.webui_client.base_data import (
-    BaseWebClient,
-    WebClientType,
-)
-from components.webui_client.client_config.client_config_remove import (
-    run_client_config_removal,
-)
-from components.webui_client.client_utils import backup_mainsail_config_json
-from core.instance_manager.instance_manager import InstanceManager
-from utils.config_utils import remove_config_section
-from utils.fs_utils import (
-    remove_nginx_config,
-    remove_nginx_logs,
-)
-from utils.logger import Logger
-
-
-def run_client_removal(
-    client: BaseWebClient,
-    rm_client: bool,
-    rm_client_config: bool,
-    backup_ms_config_json: bool,
-) -> None:
-    mr_im = InstanceManager(Moonraker)
-    mr_instances: List[Moonraker] = mr_im.instances
-    kl_im = InstanceManager(Klipper)
-    kl_instances: List[Klipper] = kl_im.instances
-
-    if backup_ms_config_json and client.client == WebClientType.MAINSAIL:
-        backup_mainsail_config_json()
-
-    if rm_client:
-        client_name = client.name
-        remove_client_dir(client)
-        remove_nginx_config(client_name)
-        remove_nginx_logs(client_name, kl_instances)
-
-        section = f"update_manager {client_name}"
-        remove_config_section(section, mr_instances)
-
-    if rm_client_config:
-        run_client_config_removal(
-            client.client_config,
-            kl_instances,
-            mr_instances,
-        )
-
-
-def remove_client_dir(client: BaseWebClient) -> None:
-    Logger.print_status(f"Removing {client.display_name} ...")
-    client_dir = client.client_dir
-    if not client.client_dir.exists():
-        Logger.print_info(f"'{client_dir}' does not exist. Skipping ...")
-        return
-
-    try:
-        shutil.rmtree(client_dir)
-    except OSError as e:
-        Logger.print_error(f"Unable to delete '{client_dir}':\n{e}")

kiauh/components/webui_client/client_setup.py

@@ -1,197 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from pathlib import Path
-from typing import List
-
-from components.klipper.klipper import Klipper
-from components.moonraker.moonraker import Moonraker
-from components.webui_client import MODULE_PATH
-from components.webui_client.base_data import (
-    BaseWebClient,
-    BaseWebClientConfig,
-    WebClientType,
-)
-from components.webui_client.client_config.client_config_setup import (
-    install_client_config,
-)
-from components.webui_client.client_dialogs import (
-    print_client_port_select_dialog,
-    print_install_client_config_dialog,
-    print_moonraker_not_found_dialog,
-)
-from components.webui_client.client_utils import (
-    backup_mainsail_config_json,
-    config_for_other_client_exist,
-    enable_mainsail_remotemode,
-    restore_mainsail_config_json,
-    symlink_webui_nginx_log,
-)
-from core.instance_manager.instance_manager import InstanceManager
-from core.settings.kiauh_settings import KiauhSettings
-from utils.common import check_install_dependencies
-from utils.config_utils import add_config_section
-from utils.fs_utils import (
-    copy_common_vars_nginx_cfg,
-    copy_upstream_nginx_cfg,
-    create_nginx_cfg,
-    get_next_free_port,
-    is_valid_port,
-    read_ports_from_nginx_configs,
-    unzip,
-)
-from utils.input_utils import get_confirm, get_number_input
-from utils.logger import Logger
-from utils.sys_utils import (
-    cmd_sysctl_service,
-    download_file,
-    get_ipv4_addr,
-)
-
-
-def install_client(client: BaseWebClient) -> None:
-    if client is None:
-        raise ValueError("Missing parameter client_data!")
-
-    if client.client_dir.exists():
-        Logger.print_info(
-            f"{client.display_name} seems to be already installed! Skipped ..."
-        )
-        return
-
-    mr_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(
-            f"Continue {client.display_name} installation?",
-            allow_go_back=True,
-        ):
-            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_im = InstanceManager(Klipper)
-    kl_instances = kl_im.instances
-    install_client_cfg = False
-    client_config: BaseWebClientConfig = client.client_config
-    if (
-        kl_instances
-        and not client_config.config_dir.exists()
-        and not config_for_other_client_exist(client_to_ignore=client.client)
-    ):
-        print_install_client_config_dialog(client)
-        question = f"Download the recommended {client_config.display_name}?"
-        install_client_cfg = get_confirm(question, allow_go_back=False)
-
-    settings = KiauhSettings()
-    port: int = settings.get(client.name, "port")
-    ports_in_use: List[int] = read_ports_from_nginx_configs()
-
-    # check if configured port is a valid number and not in use already
-    valid_port = is_valid_port(port, ports_in_use)
-    while not valid_port:
-        next_port = get_next_free_port(ports_in_use)
-        print_client_port_select_dialog(client.display_name, next_port, ports_in_use)
-        port = get_number_input(
-            f"Configure {client.display_name} for port",
-            min_count=int(next_port),
-            default=next_port,
-        )
-        valid_port = is_valid_port(port, ports_in_use)
-
-    check_install_dependencies(["nginx", "unzip"])
-
-    try:
-        download_client(client)
-        if enable_remotemode and client.client == WebClientType.MAINSAIL:
-            enable_mainsail_remotemode()
-        if mr_instances:
-            add_config_section(
-                section=f"update_manager {client.name}",
-                instances=mr_instances,
-                options=[
-                    ("type", "web"),
-                    ("channel", "stable"),
-                    ("repo", str(client.repo_path)),
-                    ("path", str(client.client_dir)),
-                ],
-            )
-            mr_im.restart_all_instance()
-        if install_client_cfg and kl_instances:
-            install_client_config(client)
-
-        copy_upstream_nginx_cfg()
-        copy_common_vars_nginx_cfg()
-        create_nginx_cfg(
-            display_name=client.display_name,
-            cfg_name=client.name,
-            template_src=MODULE_PATH.joinpath("assets/nginx_cfg"),
-            PORT=port,
-            ROOT_DIR=client.client_dir,
-            NAME=client.name,
-        )
-
-        if kl_instances:
-            symlink_webui_nginx_log(kl_instances)
-        cmd_sysctl_service("nginx", "restart")
-
-    except Exception as e:
-        Logger.print_error(f"{client.display_name} installation failed!\n{e}")
-        return
-
-    log = f"Open {client.display_name} now on: http://{get_ipv4_addr()}:{port}"
-    Logger.print_ok(f"{client.display_name} installation complete!", start="\n")
-    Logger.print_ok(log, prefix=False, end="\n\n")
-
-
-def download_client(client: BaseWebClient) -> None:
-    zipfile = f"{client.name.lower()}.zip"
-    target = Path().home().joinpath(zipfile)
-    try:
-        Logger.print_status(
-            f"Downloading {client.display_name} from {client.download_url} ..."
-        )
-        download_file(client.download_url, target, True)
-        Logger.print_ok("Download complete!")
-
-        Logger.print_status(f"Extracting {zipfile} ...")
-        unzip(target, client.client_dir)
-        target.unlink(missing_ok=True)
-        Logger.print_ok("OK!")
-
-    except Exception:
-        Logger.print_error(f"Downloading {client.display_name} failed!")
-        raise
-
-
-def update_client(client: BaseWebClient) -> None:
-    Logger.print_status(f"Updating {client.display_name} ...")
-    if not client.client_dir.exists():
-        Logger.print_info(
-            f"Unable to update {client.display_name}. Directory does not exist! Skipping ..."
-        )
-        return
-
-    if client.client == WebClientType.MAINSAIL:
-        backup_mainsail_config_json(is_temp=True)
-
-    download_client(client)
-
-    if client.client == WebClientType.MAINSAIL:
-        restore_mainsail_config_json()

kiauh/components/webui_client/client_utils.py

@@ -1,230 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-import json  # noqa: I001
-import shutil
-from pathlib import Path
-from typing import List, get_args
-
-from components.klipper.klipper import Klipper
-from components.webui_client.base_data import (
-    BaseWebClient,
-    BaseWebClientConfig,
-    WebClientType,
-)
-from components.webui_client.mainsail_data import MainsailData
-from core.backup_manager.backup_manager import BackupManager
-from core.settings.kiauh_settings import KiauhSettings
-from utils import NGINX_CONFD, NGINX_SITES_AVAILABLE
-from utils.common import get_install_status
-from utils.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
-from utils.git_utils import (
-    get_latest_tag,
-    get_latest_unstable_tag,
-)
-from utils.logger import Logger
-from utils.types import ComponentStatus, InstallStatus
-
-
-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"),
-    ]
-    status = 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():
-        status["status"] = InstallStatus.NOT_INSTALLED
-
-    status["local"] = get_local_client_version(client)
-    status["remote"] = get_remote_client_version(client) if fetch_remote else None
-    return status
-
-
-def get_client_config_status(client: BaseWebClient) -> ComponentStatus:
-    return get_install_status(client.client_config.config_dir)
-
-
-def get_current_client_config(clients: List[BaseWebClient]) -> str:
-    installed = []
-    for client in clients:
-        client_config = client.client_config
-        if client_config.config_dir.exists():
-            installed.append(client)
-
-    if len(installed) > 1:
-        return f"{COLOR_YELLOW}Conflict!{RESET_FORMAT}"
-    elif len(installed) == 1:
-        cfg = installed[0].client_config
-        return f"{COLOR_CYAN}{cfg.display_name}{RESET_FORMAT}"
-
-    return f"{COLOR_CYAN}-{RESET_FORMAT}"
-
-
-def backup_mainsail_config_json(is_temp=False) -> None:
-    c_json = MainsailData().client_dir.joinpath("config.json")
-    Logger.print_status(f"Backup '{c_json}' ...")
-    bm = BackupManager()
-    if is_temp:
-        fn = Path.home().joinpath("config.json.kiauh.bak")
-        bm.backup_file(c_json, custom_filename=fn)
-    else:
-        bm.backup_file(c_json)
-
-
-def restore_mainsail_config_json() -> None:
-    try:
-        c_json = MainsailData().client_dir.joinpath("config.json")
-        Logger.print_status(f"Restore '{c_json}' ...")
-        source = Path.home().joinpath("config.json.kiauh.bak")
-        shutil.copy(source, c_json)
-    except OSError:
-        Logger.print_info("Unable to restore config.json. Skipped ...")
-
-
-def enable_mainsail_remotemode() -> None:
-    Logger.print_status("Enable Mainsails remote mode ...")
-    c_json = MainsailData().client_dir.joinpath("config.json")
-    with open(c_json, "r") as f:
-        config_data = json.load(f)
-
-    if config_data["instancesDB"] == "browser":
-        Logger.print_info("Remote mode already configured. Skipped ...")
-        return
-
-    Logger.print_status("Setting instance storage location to 'browser' ...")
-    config_data["instancesDB"] = "browser"
-
-    with open(c_json, "w") as f:
-        json.dump(config_data, f, indent=4)
-    Logger.print_ok("Mainsails remote mode enabled!")
-
-
-def symlink_webui_nginx_log(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_local_client_version(client: BaseWebClient) -> str:
-    relinfo_file = client.client_dir.joinpath("release_info.json")
-    version_file = client.client_dir.joinpath(".version")
-
-    if not client.client_dir.exists():
-        return "-"
-    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 json.load(f)["version"]
-    else:
-        with open(version_file, "r") as f:
-            return f.readlines()[0]
-
-
-def get_remote_client_version(client: BaseWebClient) -> str:
-    try:
-        if (tag := get_latest_tag(client.repo_path)) != "":
-            return tag
-        return "ERROR"
-    except Exception:
-        return "ERROR"
-
-
-def backup_client_data(client: BaseWebClient) -> None:
-    name = client.name
-    src = client.client_dir
-    dest = client.backup_dir
-
-    with open(src.joinpath(".version"), "r") as v:
-        version = v.readlines()[0]
-
-    bm = BackupManager()
-    bm.backup_directory(f"{name}-{version}", src, dest)
-    if name == "mainsail":
-        c_json = MainsailData().client_dir.joinpath("config.json")
-        bm.backup_file(c_json, dest)
-    bm.backup_file(NGINX_SITES_AVAILABLE.joinpath(name), dest)
-
-
-def backup_client_config_data(client: BaseWebClient) -> None:
-    client_config = client.client_config
-    name = client_config.name
-    source = client_config.config_dir
-    target = client_config.backup_dir
-    bm = BackupManager()
-    bm.backup_directory(name, source, target)
-
-
-def get_existing_clients() -> List[BaseWebClient]:
-    clients = list(get_args(WebClientType))
-    installed_clients: List[BaseWebClient] = []
-    for client in clients:
-        if client.client_dir.exists():
-            installed_clients.append(client)
-
-    return installed_clients
-
-
-def get_existing_client_config() -> List[BaseWebClient]:
-    clients = list(get_args(WebClientType))
-    installed_client_configs: List[BaseWebClient] = []
-    for client in clients:
-        c_config_data: BaseWebClientConfig = client.client_config
-        if c_config_data.config_dir.exists():
-            installed_client_configs.append(client)
-
-    return installed_client_configs
-
-
-def config_for_other_client_exist(client_to_ignore: WebClientType) -> 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 client_to_ignore: The client name to ignore for the check
-    :return: True, if other client configs were found, else False
-    """
-
-    clients = set([c.name for c in get_existing_client_config()])
-    clients = clients - {client_to_ignore.value}
-
-    return True if len(clients) > 0 else 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

kiauh/components/webui_client/fluidd_data.py

@@ -1,54 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from __future__ import annotations
-
-from dataclasses import dataclass
-from pathlib import Path
-
-from components.webui_client.base_data import (
-    BaseWebClient,
-    BaseWebClientConfig,
-    WebClientConfigType,
-    WebClientType,
-)
-from components.webui_client.client_utils import get_download_url
-from core.backup_manager import BACKUP_ROOT_DIR
-
-
-@dataclass(frozen=True)
-class FluiddConfigWeb(BaseWebClientConfig):
-    client_config: WebClientConfigType = WebClientConfigType.FLUIDD
-    name: str = client_config.value
-    display_name: str = name.title()
-    config_dir: Path = Path.home().joinpath("fluidd-config")
-    config_filename: str = "fluidd.cfg"
-    config_section: str = f"include {config_filename}"
-    backup_dir: Path = BACKUP_ROOT_DIR.joinpath("fluidd-config-backups")
-    repo_url: str = "https://github.com/fluidd-core/fluidd-config.git"
-
-
-@dataclass(frozen=True)
-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")
-    backup_dir: Path = BACKUP_ROOT_DIR.joinpath("fluidd-backups")
-    repo_path: str = "fluidd-core/fluidd"
-
-    @property
-    def download_url(self) -> str:
-        return get_download_url(self.BASE_DL_URL, self)
-
-    @property
-    def client_config(self) -> BaseWebClientConfig:
-        return FluiddConfigWeb()

kiauh/components/webui_client/mainsail_data.py

@@ -1,55 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from __future__ import annotations
-
-from dataclasses import dataclass
-from pathlib import Path
-
-from components.webui_client.base_data import (
-    BaseWebClient,
-    BaseWebClientConfig,
-    WebClientConfigType,
-    WebClientType,
-)
-from core.backup_manager import BACKUP_ROOT_DIR
-
-
-@dataclass(frozen=True)
-class MainsailConfigWeb(BaseWebClientConfig):
-    client_config: WebClientConfigType = WebClientConfigType.MAINSAIL
-    name: str = client_config.value
-    display_name: str = name.title()
-    config_dir: Path = Path.home().joinpath("mainsail-config")
-    config_filename: str = "mainsail.cfg"
-    config_section: str = f"include {config_filename}"
-    backup_dir: Path = BACKUP_ROOT_DIR.joinpath("mainsail-config-backups")
-    repo_url: str = "https://github.com/mainsail-crew/mainsail-config.git"
-
-
-@dataclass(frozen=True)
-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")
-    backup_dir: Path = BACKUP_ROOT_DIR.joinpath("mainsail-backups")
-    repo_path: str = "mainsail-crew/mainsail"
-
-    @property
-    def download_url(self) -> str:
-        from components.webui_client.client_utils import get_download_url
-
-        return get_download_url(self.BASE_DL_URL, self)
-
-    @property
-    def client_config(self) -> BaseWebClientConfig:
-        return MainsailConfigWeb()

kiauh/components/webui_client/menus/client_remove_menu.py

@@ -1,125 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-import textwrap
-from typing import Optional, Type
-
-from components.webui_client import client_remove
-from components.webui_client.base_data import BaseWebClient, WebClientType
-from core.menus import Option
-from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
-
-
-# noinspection PyUnusedLocal
-class ClientRemoveMenu(BaseMenu):
-    def __init__(
-        self, client: BaseWebClient, previous_menu: Optional[Type[BaseMenu]] = None
-    ):
-        super().__init__()
-        self.previous_menu = previous_menu
-        self.client = client
-        self.rm_client = False
-        self.rm_client_config = False
-        self.backup_mainsail_config_json = False
-
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        from core.menus.remove_menu import RemoveMenu
-
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else RemoveMenu
-        )
-
-    def set_options(self) -> None:
-        self.options = {
-            "0": Option(method=self.toggle_all, menu=False),
-            "1": Option(method=self.toggle_rm_client, menu=False),
-            "2": Option(method=self.toggle_rm_client_config, menu=False),
-            "c": Option(method=self.run_removal_process, menu=False),
-        }
-        if self.client.client == WebClientType.MAINSAIL:
-            self.options["3"] = Option(self.toggle_backup_mainsail_config_json, False)
-
-    def print_menu(self) -> None:
-        client_name = self.client.display_name
-        client_config = self.client.client_config
-        client_config_name = client_config.display_name
-
-        header = f" [ Remove {client_name} ] "
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
-        checked = f"[{COLOR_CYAN}x{RESET_FORMAT}]"
-        unchecked = "[ ]"
-        o1 = checked if self.rm_client else unchecked
-        o2 = checked if self.rm_client_config 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 {client_name:16}                       |
-            |  2) {o2} Remove {client_config_name:24}               |
-            """
-        )[1:]
-
-        if self.client.client == WebClientType.MAINSAIL:
-            o3 = checked if self.backup_mainsail_config_json else unchecked
-            menu += textwrap.dedent(
-                f"""
-                |  3) {o3} Backup config.json                            |
-                """
-            )[1:]
-
-        menu += textwrap.dedent(
-            """
-            |-------------------------------------------------------|
-            |  C) Continue                                          |
-            """
-        )[1:]
-        print(menu, end="")
-
-    def toggle_all(self, **kwargs) -> None:
-        self.rm_client = True
-        self.rm_client_config = True
-        self.backup_mainsail_config_json = True
-
-    def toggle_rm_client(self, **kwargs) -> None:
-        self.rm_client = not self.rm_client
-
-    def toggle_rm_client_config(self, **kwargs) -> None:
-        self.rm_client_config = not self.rm_client_config
-
-    def toggle_backup_mainsail_config_json(self, **kwargs) -> None:
-        self.backup_mainsail_config_json = not self.backup_mainsail_config_json
-
-    def run_removal_process(self, **kwargs) -> None:
-        if (
-            not self.rm_client
-            and not self.rm_client_config
-            and not self.backup_mainsail_config_json
-        ):
-            error = f"{COLOR_RED}Nothing selected ...{RESET_FORMAT}"
-            print(error)
-            return
-
-        client_remove.run_client_removal(
-            client=self.client,
-            rm_client=self.rm_client,
-            rm_client_config=self.rm_client_config,
-            backup_ms_config_json=self.backup_mainsail_config_json,
-        )
-
-        self.rm_client = False
-        self.rm_client_config = False
-        self.backup_mainsail_config_json = False

kiauh/core/backup_manager/__init__.py

@@ -1,12 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from pathlib import Path
-
-BACKUP_ROOT_DIR = Path.home().joinpath("kiauh-backups")

kiauh/core/backup_manager/backup_manager.py

@@ -1,91 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-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, target: Path = None, custom_filename=None):
-        Logger.print_status(f"Creating backup of {file} ...")
-
-        if not file.exists():
-            Logger.print_info("File does not exist! Skipping ...")
-            return
-
-        target = self.backup_root_dir if target is None else target
-
-        if Path(file).is_file():
-            date = get_current_date().get("date")
-            time = get_current_date().get("time")
-            filename = f"{file.stem}-{date}-{time}{file.suffix}"
-            filename = custom_filename if custom_filename is not None else filename
-            try:
-                Path(target).mkdir(exist_ok=True)
-                shutil.copyfile(file, target.joinpath(filename))
-                Logger.print_ok("Backup successful!")
-            except OSError as e:
-                Logger.print_error(f"Unable to backup '{file}':\n{e}")
-        else:
-            Logger.print_info(f"File '{file}' not found ...")
-
-    def backup_directory(self, name: str, source: Path, target: Path = None) -> None:
-        Logger.print_status(f"Creating backup of {name} in {target} ...")
-
-        if source is None or not Path(source).exists():
-            Logger.print_info("Source directory does not exist! Skipping ...")
-            return
-
-        target = self.backup_root_dir if target is None else target
-        try:
-            date = get_current_date().get("date")
-            time = get_current_date().get("time")
-            shutil.copytree(
-                source,
-                target.joinpath(f"{name.lower()}-{date}-{time}"),
-                ignore=self.ignore_folders_func,
-            )
-            Logger.print_ok("Backup successful!")
-        except OSError as e:
-            Logger.print_error(f"Unable to backup directory '{source}':\n{e}")
-            return
-
-    def ignore_folders_func(self, dirpath, filenames):
-        return (
-            [f for f in filenames if f in self._ignore_folders]
-            if self._ignore_folders is not None
-            else []
-        )

kiauh/core/instance_manager/base_instance.py

@@ -1,161 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from __future__ import annotations
-
-from abc import ABC, abstractmethod
-from pathlib import Path
-from typing import List, Optional
-
-from utils.constants import CURRENT_USER, SYSTEMD
-
-
-class BaseInstance(ABC):
-    @classmethod
-    def blacklist(cls) -> List[str]:
-        return []
-
-    def __init__(
-        self,
-        suffix: str,
-        instance_type: BaseInstance,
-    ):
-        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) -> BaseInstance:
-        return self._instance_type
-
-    @instance_type.setter
-    def instance_type(self, value: 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: Path) -> None:
-        self._data_dir = value
-
-    @property
-    def cfg_dir(self) -> Path:
-        return self._cfg_dir
-
-    @cfg_dir.setter
-    def cfg_dir(self, value: Path) -> None:
-        self._cfg_dir = value
-
-    @property
-    def log_dir(self) -> Path:
-        return self._log_dir
-
-    @log_dir.setter
-    def log_dir(self, value: Path) -> None:
-        self._log_dir = value
-
-    @property
-    def comms_dir(self) -> Path:
-        return self._comms_dir
-
-    @comms_dir.setter
-    def comms_dir(self, value: Path) -> None:
-        self._comms_dir = value
-
-    @property
-    def sysd_dir(self) -> Path:
-        return self._sysd_dir
-
-    @sysd_dir.setter
-    def sysd_dir(self, value: Path) -> None:
-        self._sysd_dir = value
-
-    @property
-    def gcodes_dir(self) -> Path:
-        return self._gcodes_dir
-
-    @gcodes_dir.setter
-    def gcodes_dir(self, value: Path) -> 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: Optional[List[Path]] = None) -> None:
-        dirs = [
-            self.data_dir,
-            self.cfg_dir,
-            self.log_dir,
-            self.comms_dir,
-            self.sysd_dir,
-        ]
-
-        if add_dirs:
-            dirs.extend(add_dirs)
-
-        for _dir in dirs:
-            _dir.mkdir(exist_ok=True)
-
-    def get_service_file_name(self, extension: bool = False) -> str:
-        from utils.common import convert_camelcase_to_kebabcase
-
-        name = convert_camelcase_to_kebabcase(self.__class__.__name__)
-        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,192 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-import re
-import subprocess
-from pathlib import Path
-from typing import List, Optional, TypeVar, Union
-
-from core.instance_manager.base_instance import BaseInstance
-from utils.constants import SYSTEMD
-from utils.logger import Logger
-from utils.sys_utils import cmd_sysctl_service
-
-T = TypeVar(name="T", bound=BaseInstance, covariant=True)
-
-
-# noinspection PyMethodMayBeStatic
-class InstanceManager:
-    def __init__(self, instance_type: T) -> None:
-        self._instance_type = instance_type
-        self._current_instance: Optional[T] = 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[T] = []
-
-    @property
-    def instance_type(self) -> T:
-        return self._instance_type
-
-    @instance_type.setter
-    def instance_type(self, value: T):
-        self._instance_type = value
-
-    @property
-    def current_instance(self) -> T:
-        return self._current_instance
-
-    @current_instance.setter
-    def current_instance(self, value: T) -> 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[T]:
-        return self.find_instances()
-
-    @instances.setter
-    def instances(self, value: List[T]):
-        self._instances = value
-
-    def create_instance(self) -> None:
-        if self.current_instance is not None:
-            try:
-                self.current_instance.create()
-            except (OSError, subprocess.CalledProcessError) as e:
-                Logger.print_error(f"Creating instance failed: {e}")
-                raise
-        else:
-            raise ValueError("current_instance cannot be None")
-
-    def delete_instance(self) -> None:
-        if self.current_instance is not None:
-            try:
-                self.current_instance.delete()
-            except (OSError, subprocess.CalledProcessError) as e:
-                Logger.print_error(f"Removing instance failed: {e}")
-                raise
-        else:
-            raise ValueError("current_instance cannot be None")
-
-    def enable_instance(self) -> None:
-        try:
-            cmd_sysctl_service(self.instance_service_full, "enable")
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(f"Error enabling service {self.instance_service_full}:")
-            Logger.print_error(f"{e}")
-
-    def disable_instance(self) -> None:
-        try:
-            cmd_sysctl_service(self.instance_service_full, "disable")
-        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:
-        try:
-            cmd_sysctl_service(self.instance_service_full, "start")
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(f"Error starting {self.instance_service_full}:")
-            Logger.print_error(f"{e}")
-
-    def restart_instance(self) -> None:
-        try:
-            cmd_sysctl_service(self.instance_service_full, "restart")
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(f"Error restarting {self.instance_service_full}:")
-            Logger.print_error(f"{e}")
-
-    def start_all_instance(self) -> None:
-        for instance in self.instances:
-            self.current_instance = instance
-            self.start_instance()
-
-    def restart_all_instance(self) -> None:
-        for instance in self.instances:
-            self.current_instance = instance
-            self.restart_instance()
-
-    def stop_instance(self) -> None:
-        try:
-            cmd_sysctl_service(self.instance_service_full, "stop")
-        except subprocess.CalledProcessError as e:
-            Logger.print_error(f"Error stopping {self.instance_service_full}:")
-            Logger.print_error(f"{e}")
-            raise
-
-    def stop_all_instance(self) -> None:
-        for instance in self.instances:
-            self.current_instance = instance
-            self.stop_instance()
-
-    def find_instances(self) -> List[T]:
-        from utils.common import convert_camelcase_to_kebabcase
-
-        name = convert_camelcase_to_kebabcase(self.instance_type.__name__)
-        pattern = re.compile(f"^{name}(-[0-9a-zA-Z]+)?.service$")
-        excluded = self.instance_type.blacklist()
-
-        service_list = [
-            Path(SYSTEMD, service)
-            for service in SYSTEMD.iterdir()
-            if pattern.search(service.name)
-            and not any(s in service.name for s in excluded)
-        ]
-
-        instance_list = [
-            self.instance_type(suffix=self._get_instance_suffix(name, service))
-            for service in service_list
-        ]
-
-        return sorted(instance_list, key=lambda x: self._sort_instance_list(x.suffix))
-
-    def _get_instance_suffix(self, name: str, file_path: Path) -> str:
-        # to get the suffix of the instance, we remove the name of the instance from
-        # the file name, if the remaining part an empty string we return it
-        # otherwise there is and hyphen left, and we return the part after the hyphen
-        suffix = file_path.stem[len(name) :]
-        return suffix[1:] if suffix else ""
-
-    def _sort_instance_list(self, s: Union[int, str, None]):
-        if s is None:
-            return
-
-        return int(s) if s.isdigit() else s

kiauh/core/instance_manager/name_scheme.py

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

kiauh/core/menus/__init__.py

@@ -1,35 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from dataclasses import dataclass
-from enum import Enum
-from typing import Any, Callable, Union
-
-
-@dataclass
-class Option:
-    """
-    Represents a menu option.
-    :param method: Method that will be used to call the menu option
-    :param menu: Flag for singaling that another menu will be opened
-    :param opt_index: Can be used to pass the user input to the menu option
-    :param opt_data: Can be used to pass any additional data to the menu option
-    """
-
-    method: Union[Callable, None] = None
-    menu: bool = False
-    opt_index: str = ""
-    opt_data: Any = None
-
-
-class FooterType(Enum):
-    QUIT = "QUIT"
-    BACK = "BACK"
-    BACK_HELP = "BACK_HELP"
-    BLANK = "BLANK"

kiauh/core/menus/advanced_menu.py

@@ -1,96 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-import textwrap
-from typing import Optional, Type
-
-from components.klipper import KLIPPER_DIR
-from components.klipper.klipper import Klipper
-from components.klipper_firmware.menus.klipper_build_menu import (
-    KlipperBuildFirmwareMenu,
-)
-from components.klipper_firmware.menus.klipper_flash_menu import (
-    KlipperFlashMethodMenu,
-    KlipperSelectMcuConnectionMenu,
-)
-from components.moonraker import MOONRAKER_DIR
-from components.moonraker.moonraker import Moonraker
-from core.menus import Option
-from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_YELLOW, RESET_FORMAT
-from utils.git_utils import rollback_repository
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class AdvancedMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
-        super().__init__()
-        self.previous_menu = previous_menu
-
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        from core.menus.main_menu import MainMenu
-
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else MainMenu
-        )
-
-    def set_options(self):
-        self.options = {
-            "1": Option(method=self.klipper_rollback, menu=True),
-            "2": Option(method=self.moonraker_rollback, menu=True),
-            "3": Option(method=self.build, menu=True),
-            "4": Option(method=self.flash, menu=False),
-            "5": Option(method=self.build_flash, menu=False),
-            "6": Option(method=self.get_id, menu=False),
-        }
-
-    def print_menu(self):
-        header = " [ Advanced Menu ] "
-        color = COLOR_YELLOW
-        count = 62 - len(color) - len(RESET_FORMAT)
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:~^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            | Repo Rollback:                                        |
-            |  1) [Klipper]                                         |
-            |  2) [Moonraker]                                       |
-            |                                                       |
-            | Klipper Firmware:                                     |
-            |  3) [Build]                                           |
-            |  4) [Flash]                                           |
-            |  5) [Build + Flash]                                   |
-            |  6) [Get MCU ID]                                      |   
-            """
-        )[1:]
-        print(menu, end="")
-
-    def klipper_rollback(self, **kwargs):
-        rollback_repository(KLIPPER_DIR, Klipper)
-
-    def moonraker_rollback(self, **kwargs):
-        rollback_repository(MOONRAKER_DIR, Moonraker)
-
-    def build(self, **kwargs):
-        KlipperBuildFirmwareMenu(previous_menu=self.__class__).run()
-
-    def flash(self, **kwargs):
-        KlipperFlashMethodMenu(previous_menu=self.__class__).run()
-
-    def build_flash(self, **kwargs):
-        KlipperBuildFirmwareMenu(previous_menu=KlipperFlashMethodMenu).run()
-        KlipperFlashMethodMenu(previous_menu=self.__class__).run()
-
-    def get_id(self, **kwargs):
-        KlipperSelectMcuConnectionMenu(
-            previous_menu=self.__class__,
-            standalone=True,
-        ).run()

kiauh/core/menus/backup_menu.py

@@ -1,108 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-import textwrap
-from typing import Optional, Type
-
-from components.klipper.klipper_utils import backup_klipper_dir
-from components.klipperscreen.klipperscreen import backup_klipperscreen_dir
-from components.moonraker.moonraker_utils import (
-    backup_moonraker_db_dir,
-    backup_moonraker_dir,
-)
-from components.webui_client.client_utils import (
-    backup_client_config_data,
-    backup_client_data,
-)
-from components.webui_client.fluidd_data import FluiddData
-from components.webui_client.mainsail_data import MainsailData
-from core.menus import Option
-from core.menus.base_menu import BaseMenu
-from utils.common import backup_printer_config_dir
-from utils.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class BackupMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
-        super().__init__()
-        self.previous_menu = previous_menu
-
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        from core.menus.main_menu import MainMenu
-
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else MainMenu
-        )
-
-    def set_options(self) -> None:
-        self.options = {
-            "1": Option(method=self.backup_klipper, menu=False),
-            "2": Option(method=self.backup_moonraker, menu=False),
-            "3": Option(method=self.backup_printer_config, menu=False),
-            "4": Option(method=self.backup_moonraker_db, menu=False),
-            "5": Option(method=self.backup_mainsail, menu=False),
-            "6": Option(method=self.backup_fluidd, menu=False),
-            "7": Option(method=self.backup_mainsail_config, menu=False),
-            "8": Option(method=self.backup_fluidd_config, menu=False),
-            "9": Option(method=self.backup_klipperscreen, menu=False),
-        }
-
-    def print_menu(self):
-        header = " [ Backup Menu ] "
-        line1 = f"{COLOR_YELLOW}INFO: Backups are located in '~/kiauh-backups'{RESET_FORMAT}"
-        color = COLOR_CYAN
-        count = 62 - len(color) - len(RESET_FORMAT)
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:~^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            | {line1:^62} |
-            |-------------------------------------------------------|
-            | Klipper & Moonraker API:  | Client-Config:            |
-            |  1) [Klipper]             |  7) [Mainsail-Config]     |
-            |  2) [Moonraker]           |  8) [Fluidd-Config]       |
-            |  3) [Config Folder]       |                           |
-            |  4) [Moonraker Database]  | Touchscreen GUI:          |
-            |                           |  9) [KlipperScreen]       |
-            | Webinterface:             |                           |
-            |  5) [Mainsail]            |                           |
-            |  6) [Fluidd]              |                           |
-            """
-        )[1:]
-        print(menu, end="")
-
-    def backup_klipper(self, **kwargs):
-        backup_klipper_dir()
-
-    def backup_moonraker(self, **kwargs):
-        backup_moonraker_dir()
-
-    def backup_printer_config(self, **kwargs):
-        backup_printer_config_dir()
-
-    def backup_moonraker_db(self, **kwargs):
-        backup_moonraker_db_dir()
-
-    def backup_mainsail(self, **kwargs):
-        backup_client_data(MainsailData())
-
-    def backup_fluidd(self, **kwargs):
-        backup_client_data(FluiddData())
-
-    def backup_mainsail_config(self, **kwargs):
-        backup_client_config_data(MainsailData())
-
-    def backup_fluidd_config(self, **kwargs):
-        backup_client_config_data(FluiddData())
-
-    def backup_klipperscreen(self, **kwargs):
-        backup_klipperscreen_dir()

kiauh/core/menus/base_menu.py

@@ -1,219 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from __future__ import annotations
-
-import subprocess
-import sys
-import textwrap
-import traceback
-from abc import abstractmethod
-from typing import Dict, Optional, Type
-
-from core.menus import FooterType, Option
-from utils.constants import (
-    COLOR_CYAN,
-    COLOR_GREEN,
-    COLOR_RED,
-    COLOR_YELLOW,
-    RESET_FORMAT,
-)
-from utils.logger import Logger
-
-
-def clear():
-    subprocess.call("clear", shell=True)
-
-
-def print_header():
-    line1 = " [ KIAUH ] "
-    line2 = "Klipper Installation And Update Helper"
-    line3 = ""
-    color = COLOR_CYAN
-    count = 62 - len(color) - len(RESET_FORMAT)
-    header = textwrap.dedent(
-        f"""
-        /=======================================================\\
-        | {color}{line1:~^{count}}{RESET_FORMAT} |
-        | {color}{line2:^{count}}{RESET_FORMAT} |
-        | {color}{line3:~^{count}}{RESET_FORMAT} |
-        \=======================================================/
-        """
-    )[1:]
-    print(header, end="")
-
-
-def print_quit_footer():
-    text = "Q) Quit"
-    color = COLOR_RED
-    count = 62 - len(color) - len(RESET_FORMAT)
-    footer = textwrap.dedent(
-        f"""
-        |-------------------------------------------------------|
-        | {color}{text:^{count}}{RESET_FORMAT} |
-        \=======================================================/
-        """
-    )[1:]
-    print(footer, end="")
-
-
-def print_back_footer():
-    text = "B) « Back"
-    color = COLOR_GREEN
-    count = 62 - len(color) - len(RESET_FORMAT)
-    footer = textwrap.dedent(
-        f"""
-        |-------------------------------------------------------|
-        | {color}{text:^{count}}{RESET_FORMAT} |
-        \=======================================================/
-        """
-    )[1:]
-    print(footer, end="")
-
-
-def print_back_help_footer():
-    text1 = "B) « Back"
-    text2 = "H) Help [?]"
-    color1 = COLOR_GREEN
-    color2 = COLOR_YELLOW
-    count = 34 - len(color1) - len(RESET_FORMAT)
-    footer = textwrap.dedent(
-        f"""
-        |-------------------------------------------------------|
-        | {color1}{text1:^{count}}{RESET_FORMAT} | {color2}{text2:^{count}}{RESET_FORMAT} |
-        \=======================================================/
-        """
-    )[1:]
-    print(footer, end="")
-
-
-def print_blank_footer():
-    print("\=======================================================/")
-
-
-class PostInitCaller(type):
-    def __call__(cls, *args, **kwargs):
-        obj = type.__call__(cls, *args, **kwargs)
-        obj.__post_init__()
-        return obj
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class BaseMenu(metaclass=PostInitCaller):
-    options: Dict[str, Option] = {}
-    options_offset: int = 0
-    default_option: Option = None
-    input_label_txt: str = "Perform action"
-    header: bool = False
-    previous_menu: Type[BaseMenu] = None
-    help_menu: Type[BaseMenu] = None
-    footer_type: FooterType = FooterType.BACK
-
-    def __init__(self, **kwargs):
-        if type(self) is BaseMenu:
-            raise NotImplementedError("BaseMenu cannot be instantiated directly.")
-
-    def __post_init__(self):
-        self.set_previous_menu(self.previous_menu)
-        self.set_options()
-
-        # conditionally add options based on footer type
-        if self.footer_type is FooterType.QUIT:
-            self.options["q"] = Option(method=self.__exit, menu=False)
-        if self.footer_type is FooterType.BACK:
-            self.options["b"] = Option(method=self.__go_back, menu=False)
-        if self.footer_type is FooterType.BACK_HELP:
-            self.options["b"] = Option(method=self.__go_back, menu=False)
-            self.options["h"] = Option(method=self.__go_to_help, menu=False)
-        # if defined, add the default option to the options dict
-        if self.default_option is not None:
-            self.options[""] = self.default_option
-
-    def __go_back(self, **kwargs):
-        self.previous_menu().run()
-
-    def __go_to_help(self, **kwargs):
-        self.help_menu(previous_menu=self).run()
-
-    def __exit(self, **kwargs):
-        Logger.print_ok("###### Happy printing!", False)
-        sys.exit(0)
-
-    @abstractmethod
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        raise NotImplementedError
-
-    @abstractmethod
-    def set_options(self) -> None:
-        raise NotImplementedError
-
-    @abstractmethod
-    def print_menu(self) -> None:
-        raise NotImplementedError
-
-    def print_footer(self) -> None:
-        if self.footer_type is FooterType.QUIT:
-            print_quit_footer()
-        elif self.footer_type is FooterType.BACK:
-            print_back_footer()
-        elif self.footer_type is FooterType.BACK_HELP:
-            print_back_help_footer()
-        elif self.footer_type is FooterType.BLANK:
-            print_blank_footer()
-        else:
-            raise NotImplementedError
-
-    def display_menu(self) -> None:
-        if self.header:
-            print_header()
-        self.print_menu()
-        self.print_footer()
-
-    def validate_user_input(self, usr_input: str) -> Option:
-        """
-        Validate the user input and either return an Option, a string or None
-        :param usr_input: The user input in form of a string
-        :return: Option, str or None
-        """
-        usr_input = usr_input.lower()
-        option = self.options.get(usr_input, Option(None, False, "", None))
-
-        # if option/usr_input is None/empty string, we execute the menus default option if specified
-        if (option is None or usr_input == "") and self.default_option is not None:
-            self.default_option.opt_index = usr_input
-            return self.default_option
-
-        # user selected a regular option
-        option.opt_index = usr_input
-        return option
-
-    def handle_user_input(self) -> Option:
-        """Handle the user input, return the validated input or print an error."""
-        while True:
-            print(f"{COLOR_CYAN}###### {self.input_label_txt}: {RESET_FORMAT}", end="")
-            usr_input = input().lower()
-            validated_input = self.validate_user_input(usr_input)
-
-            if validated_input.method is not None:
-                return validated_input
-            else:
-                Logger.print_error("Invalid input!", False)
-
-    def run(self) -> None:
-        """Start the menu lifecycle. When this function returns, the lifecycle of the menu ends."""
-        try:
-            self.display_menu()
-            option = self.handle_user_input()
-            option.method(opt_index=option.opt_index, opt_data=option.opt_data)
-            self.run()
-        except Exception as e:
-            Logger.print_error(
-                f"An unexpected error occured:\n{e}\n{traceback.format_exc()}"
-            )

kiauh/core/menus/install_menu.py

@@ -1,104 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-import textwrap
-from typing import Optional, Type
-
-from components.crowsnest.crowsnest import install_crowsnest
-from components.klipper import klipper_setup
-from components.klipperscreen.klipperscreen import install_klipperscreen
-from components.mobileraker.mobileraker import install_mobileraker
-from components.moonraker import moonraker_setup
-from components.webui_client import client_setup
-from components.webui_client.client_config import client_config_setup
-from components.webui_client.fluidd_data import FluiddData
-from components.webui_client.mainsail_data import MainsailData
-from core.menus import Option
-from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_GREEN, RESET_FORMAT
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class InstallMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
-        super().__init__()
-        self.previous_menu = previous_menu
-
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        from core.menus.main_menu import MainMenu
-
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else MainMenu
-        )
-
-    def set_options(self) -> None:
-        self.options = {
-            "1": Option(method=self.install_klipper, menu=False),
-            "2": Option(method=self.install_moonraker, menu=False),
-            "3": Option(method=self.install_mainsail, menu=False),
-            "4": Option(method=self.install_fluidd, menu=False),
-            "5": Option(method=self.install_mainsail_config, menu=False),
-            "6": Option(method=self.install_fluidd_config, menu=False),
-            "7": Option(method=self.install_klipperscreen, menu=False),
-            "8": Option(method=self.install_mobileraker, menu=False),
-            "9": Option(method=self.install_crowsnest, menu=False),
-        }
-
-    def print_menu(self):
-        header = " [ Installation Menu ] "
-        color = COLOR_GREEN
-        count = 62 - len(color) - len(RESET_FORMAT)
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:~^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            | Firmware & API:           | Touchscreen GUI:          |
-            |  1) [Klipper]             |  7) [KlipperScreen]       |
-            |  2) [Moonraker]           |                           |
-            |                           | Android / iOS:            |
-            | Webinterface:             |  8) [Mobileraker]         |
-            |  3) [Mainsail]            |                           |
-            |  4) [Fluidd]              | Webcam Streamer:          |
-            |                           |  9) [Crowsnest]           |
-            | Client-Config:            |                           |
-            |  5) [Mainsail-Config]     |                           |
-            |  6) [Fluidd-Config]       |                           |
-            |                           |                           |
-            """
-        )[1:]
-        print(menu, end="")
-
-    def install_klipper(self, **kwargs):
-        klipper_setup.install_klipper()
-
-    def install_moonraker(self, **kwargs):
-        moonraker_setup.install_moonraker()
-
-    def install_mainsail(self, **kwargs):
-        client_setup.install_client(MainsailData())
-
-    def install_mainsail_config(self, **kwargs):
-        client_config_setup.install_client_config(MainsailData())
-
-    def install_fluidd(self, **kwargs):
-        client_setup.install_client(FluiddData())
-
-    def install_fluidd_config(self, **kwargs):
-        client_config_setup.install_client_config(FluiddData())
-
-    def install_klipperscreen(self, **kwargs):
-        install_klipperscreen()
-
-    def install_mobileraker(self, **kwargs):
-        install_mobileraker()
-
-    def install_crowsnest(self, **kwargs):
-        install_crowsnest()

kiauh/core/menus/main_menu.py

@@ -1,172 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-import textwrap
-from typing import Optional, Type
-
-from components.crowsnest.crowsnest import get_crowsnest_status
-from components.klipper.klipper_utils import get_klipper_status
-from components.klipperscreen.klipperscreen import get_klipperscreen_status
-from components.log_uploads.menus.log_upload_menu import LogUploadMenu
-from components.mobileraker.mobileraker import get_mobileraker_status
-from components.moonraker.moonraker_utils import get_moonraker_status
-from components.webui_client.client_utils import (
-    get_client_status,
-    get_current_client_config,
-)
-from components.webui_client.fluidd_data import FluiddData
-from components.webui_client.mainsail_data import MainsailData
-from core.menus import FooterType
-from core.menus.advanced_menu import AdvancedMenu
-from core.menus.backup_menu import BackupMenu
-from core.menus.base_menu import BaseMenu, Option
-from core.menus.install_menu import InstallMenu
-from core.menus.remove_menu import RemoveMenu
-from core.menus.settings_menu import SettingsMenu
-from core.menus.update_menu import UpdateMenu
-from extensions.extensions_menu import ExtensionsMenu
-from utils.constants import (
-    COLOR_CYAN,
-    COLOR_GREEN,
-    COLOR_MAGENTA,
-    COLOR_RED,
-    COLOR_YELLOW,
-    RESET_FORMAT,
-)
-from utils.types import ComponentStatus
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class MainMenu(BaseMenu):
-    def __init__(self):
-        super().__init__()
-
-        self.header = True
-        self.footer_type = FooterType.QUIT
-
-        self.kl_status = self.kl_repo = self.mr_status = self.mr_repo = ""
-        self.ms_status = self.fl_status = self.ks_status = self.mb_status = ""
-        self.cn_status = self.cc_status = ""
-        self.init_status()
-
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        """MainMenu does not have a previous menu"""
-        pass
-
-    def set_options(self) -> None:
-        self.options = {
-            "0": Option(method=self.log_upload_menu, menu=True),
-            "1": Option(method=self.install_menu, menu=True),
-            "2": Option(method=self.update_menu, menu=True),
-            "3": Option(method=self.remove_menu, menu=True),
-            "4": Option(method=self.advanced_menu, menu=True),
-            "5": Option(method=self.backup_menu, menu=True),
-            "e": Option(method=self.extension_menu, menu=True),
-            "s": Option(method=self.settings_menu, menu=True),
-        }
-
-    def init_status(self) -> None:
-        status_vars = ["kl", "mr", "ms", "fl", "ks", "mb", "cn"]
-        for var in status_vars:
-            setattr(
-                self,
-                f"{var}_status",
-                f"{COLOR_RED}Not installed!{RESET_FORMAT}",
-            )
-
-    def fetch_status(self) -> None:
-        self._get_component_status("kl", get_klipper_status)
-        self._get_component_status("mr", get_moonraker_status)
-        self._get_component_status("ms", get_client_status, MainsailData())
-        self._get_component_status("fl", get_client_status, FluiddData())
-        self.cc_status = get_current_client_config([MainsailData(), FluiddData()])
-        self._get_component_status("ks", get_klipperscreen_status)
-        self._get_component_status("mb", get_mobileraker_status)
-        self._get_component_status("cn", get_crowsnest_status)
-
-    def _get_component_status(self, name: str, status_fn: callable, *args) -> None:
-        status_data: ComponentStatus = status_fn(*args)
-        code: int = status_data.get("status").value.code
-        status: str = status_data.get("status").value.txt
-        repo: str = status_data.get("repo")
-        instance_count: int = status_data.get("instances")
-
-        count_txt: str = ""
-        if instance_count > 0 and code == 1:
-            count_txt = f": {instance_count}"
-
-        setattr(self, f"{name}_status", self._format_by_code(code, status, count_txt))
-        setattr(self, f"{name}_repo", f"{COLOR_CYAN}{repo}{RESET_FORMAT}")
-
-    def _format_by_code(self, code: int, status: str, count: str) -> str:
-        if code == 1:
-            return f"{COLOR_GREEN}{status}{count}{RESET_FORMAT}"
-        elif code == 2:
-            return f"{COLOR_RED}{status}{count}{RESET_FORMAT}"
-
-        return f"{COLOR_YELLOW}{status}{count}{RESET_FORMAT}"
-
-    def print_menu(self):
-        self.fetch_status()
-
-        header = " [ Main Menu ] "
-        footer1 = "KIAUH v6.0.0"
-        footer2 = f"Changelog: {COLOR_MAGENTA}https://git.io/JnmlX{RESET_FORMAT}"
-        color = COLOR_CYAN
-        count = 62 - len(color) - len(RESET_FORMAT)
-        pad1 = 32
-        pad2 = 26
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:~^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            |  0) [Log-Upload] |   Klipper: {self.kl_status:<{pad1}} |
-            |                  |      Repo: {self.kl_repo:<{pad1}} |
-            |  1) [Install]    |------------------------------------|
-            |  2) [Update]     | Moonraker: {self.mr_status:<{pad1}} |
-            |  3) [Remove]     |      Repo: {self.mr_repo:<{pad1}} |
-            |  4) [Advanced]   |------------------------------------|
-            |  5) [Backup]     |        Mainsail: {self.ms_status:<{pad2}} |
-            |                  |          Fluidd: {self.fl_status:<{pad2}} |
-            |  S) [Settings]   |   Client-Config: {self.cc_status:<{pad2}} |
-            |                  |                                    |
-            | Community:       |   KlipperScreen: {self.ks_status:<{pad2}} |
-            |  E) [Extensions] |     Mobileraker: {self.mb_status:<{pad2}} |
-            |                  |       Crowsnest: {self.cn_status:<{pad2}} |
-            |-------------------------------------------------------|
-            | {COLOR_CYAN}{footer1:^16}{RESET_FORMAT} | {footer2:^43} |
-            """
-        )[1:]
-        print(menu, end="")
-
-    def log_upload_menu(self, **kwargs):
-        LogUploadMenu().run()
-
-    def install_menu(self, **kwargs):
-        InstallMenu(previous_menu=self.__class__).run()
-
-    def update_menu(self, **kwargs):
-        UpdateMenu(previous_menu=self.__class__).run()
-
-    def remove_menu(self, **kwargs):
-        RemoveMenu(previous_menu=self.__class__).run()
-
-    def advanced_menu(self, **kwargs):
-        AdvancedMenu(previous_menu=self.__class__).run()
-
-    def backup_menu(self, **kwargs):
-        BackupMenu(previous_menu=self.__class__).run()
-
-    def settings_menu(self, **kwargs):
-        SettingsMenu(previous_menu=self.__class__).run()
-
-    def extension_menu(self, **kwargs):
-        ExtensionsMenu(previous_menu=self.__class__).run()

kiauh/core/menus/remove_menu.py

@@ -1,95 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-import textwrap
-from typing import Optional, Type
-
-from components.crowsnest.crowsnest import remove_crowsnest
-from components.klipper.menus.klipper_remove_menu import KlipperRemoveMenu
-from components.klipperscreen.klipperscreen import remove_klipperscreen
-from components.mobileraker.mobileraker import remove_mobileraker
-from components.moonraker.menus.moonraker_remove_menu import (
-    MoonrakerRemoveMenu,
-)
-from components.webui_client.fluidd_data import FluiddData
-from components.webui_client.mainsail_data import MainsailData
-from components.webui_client.menus.client_remove_menu import ClientRemoveMenu
-from core.menus import Option
-from core.menus.base_menu import BaseMenu
-from utils.constants import COLOR_RED, RESET_FORMAT
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class RemoveMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
-        super().__init__()
-        self.previous_menu = previous_menu
-
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        from core.menus.main_menu import MainMenu
-
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else MainMenu
-        )
-
-    def set_options(self):
-        self.options = {
-            "1": Option(method=self.remove_klipper, menu=True),
-            "2": Option(method=self.remove_moonraker, menu=True),
-            "3": Option(method=self.remove_mainsail, menu=True),
-            "4": Option(method=self.remove_fluidd, menu=True),
-            "5": Option(method=self.remove_klipperscreen, menu=True),
-            "6": Option(method=self.remove_mobileraker, menu=True),
-            "7": Option(method=self.remove_crowsnest, menu=True),
-        }
-
-    def print_menu(self):
-        header = " [ Remove Menu ] "
-        color = COLOR_RED
-        count = 62 - len(color) - len(RESET_FORMAT)
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:~^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            | INFO: Configurations and/or any backups will be kept! |
-            |-------------------------------------------------------|
-            | Firmware & API:           | Touchscreen GUI:          |
-            |  1) [Klipper]             |  5) [KlipperScreen]       |
-            |  2) [Moonraker]           |                           |
-            |                           | Android / iOS:            |
-            | Klipper Webinterface:     |  6) [Mobileraker]         |
-            |  3) [Mainsail]            |                           |
-            |  4) [Fluidd]              | Webcam Streamer:          |
-            |                           |  7) [Crowsnest]           |
-            """
-        )[1:]
-        print(menu, end="")
-
-    def remove_klipper(self, **kwargs):
-        KlipperRemoveMenu(previous_menu=self.__class__).run()
-
-    def remove_moonraker(self, **kwargs):
-        MoonrakerRemoveMenu(previous_menu=self.__class__).run()
-
-    def remove_mainsail(self, **kwargs):
-        ClientRemoveMenu(previous_menu=self.__class__, client=MainsailData()).run()
-
-    def remove_fluidd(self, **kwargs):
-        ClientRemoveMenu(previous_menu=self.__class__, client=FluiddData()).run()
-
-    def remove_klipperscreen(self, **kwargs):
-        remove_klipperscreen()
-
-    def remove_mobileraker(self, **kwargs):
-        remove_mobileraker()
-
-    def remove_crowsnest(self, **kwargs):
-        remove_crowsnest()

kiauh/core/menus/settings_menu.py

@@ -1,208 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-import shutil
-import textwrap
-from pathlib import Path
-from typing import Optional, Tuple, Type
-
-from components.klipper import KLIPPER_DIR
-from components.klipper.klipper import Klipper
-from components.moonraker import MOONRAKER_DIR
-from components.moonraker.moonraker import Moonraker
-from core.instance_manager.instance_manager import InstanceManager
-from core.menus import Option
-from core.menus.base_menu import BaseMenu
-from core.settings.kiauh_settings import KiauhSettings
-from utils.constants import COLOR_CYAN, COLOR_GREEN, RESET_FORMAT
-from utils.git_utils import git_clone_wrapper
-from utils.input_utils import get_confirm, get_string_input
-from utils.logger import DialogType, Logger
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class SettingsMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
-        super().__init__()
-        self.previous_menu = previous_menu
-        self.klipper_repo = None
-        self.moonraker_repo = None
-        self.mainsail_unstable = None
-        self.fluidd_unstable = None
-        self.auto_backups_enabled = None
-        self._load_settings()
-
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        from core.menus.main_menu import MainMenu
-
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else MainMenu
-        )
-
-    def set_options(self) -> None:
-        self.options = {
-            "1": Option(method=self.set_klipper_repo, menu=True),
-            "2": Option(method=self.set_moonraker_repo, menu=True),
-            "3": Option(method=self.toggle_mainsail_release, menu=True),
-            "4": Option(method=self.toggle_fluidd_release, menu=False),
-            "5": Option(method=self.toggle_backup_before_update, menu=False),
-        }
-
-    def print_menu(self):
-        header = " [ KIAUH Settings ] "
-        color = COLOR_CYAN
-        count = 62 - len(color) - len(RESET_FORMAT)
-        checked = f"[{COLOR_GREEN}x{RESET_FORMAT}]"
-        unchecked = "[ ]"
-        o1 = checked if self.mainsail_unstable else unchecked
-        o2 = checked if self.fluidd_unstable else unchecked
-        o3 = checked if self.auto_backups_enabled else unchecked
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:~^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            | Klipper source repository:                            |
-            |   ● {self.klipper_repo:<67} |
-            |                                                       |
-            | Moonraker source repository:                          |
-            |   ● {self.moonraker_repo:<67} |
-            |                                                       |
-            | Install unstable Webinterface releases:               |
-            |  {o1} Mainsail                                         |
-            |  {o2} Fluidd                                           |
-            |                                                       |
-            | Auto-Backup:                                          |
-            |  {o3} Automatic backup before update                   |
-            |                                                       |
-            |-------------------------------------------------------|
-            | 1) Set Klipper source repository                      |
-            | 2) Set Moonraker source repository                    |
-            |                                                       |
-            | 3) Toggle unstable Mainsail releases                  |
-            | 4) Toggle unstable Fluidd releases                    |
-            |                                                       |
-            | 5) Toggle automatic backups before updates            |
-            """
-        )[1:]
-        print(menu, end="")
-
-    def _load_settings(self):
-        self.settings = KiauhSettings()
-
-        self._format_repo_str("klipper")
-        self._format_repo_str("moonraker")
-
-        self.auto_backups_enabled = self.settings.kiauh.backup_before_update
-        self.mainsail_unstable = self.settings.mainsail.unstable_releases
-        self.fluidd_unstable = self.settings.fluidd.unstable_releases
-
-    def _format_repo_str(self, repo_name: str) -> None:
-        repo = self.settings.get(repo_name, "repo_url")
-        repo = f"{'/'.join(repo.rsplit('/', 2)[-2:])}"
-        branch = self.settings.get(repo_name, "branch")
-        branch = f"({COLOR_CYAN}@ {branch}{RESET_FORMAT})"
-        setattr(self, f"{repo_name}_repo", f"{COLOR_CYAN}{repo}{RESET_FORMAT} {branch}")
-
-    def _gather_input(self) -> Tuple[str, str]:
-        Logger.print_dialog(
-            DialogType.ATTENTION,
-            [
-                "There is no input validation in place! Make sure your"
-                " input is valid and has no typos! For any change to"
-                " take effect, the repository must be cloned again. "
-                "Make sure you don't have any ongoing prints running, "
-                "as the services will be restarted!"
-            ],
-        )
-        repo = get_string_input(
-            "Enter new repository URL",
-            allow_special_chars=True,
-        )
-        branch = get_string_input(
-            "Enter new branch name",
-            allow_special_chars=True,
-        )
-
-        return repo, branch
-
-    def _set_repo(self, repo_name: str):
-        repo_url, branch = self._gather_input()
-        display_name = repo_name.capitalize()
-        Logger.print_dialog(
-            DialogType.CUSTOM,
-            [
-                f"New {display_name} repository URL:",
-                f"● {repo_url}",
-                f"New {display_name} repository branch:",
-                f"● {branch}",
-            ],
-            end="",
-        )
-
-        if get_confirm("Apply changes?", allow_go_back=True):
-            self.settings.set(repo_name, "repo_url", repo_url)
-            self.settings.set(repo_name, "branch", branch)
-            self.settings.save()
-            self._load_settings()
-            Logger.print_ok("Changes saved!")
-        else:
-            Logger.print_info(
-                f"Skipping change of {display_name} source repository  ..."
-            )
-            return
-
-        Logger.print_status(f"Switching to {display_name}'s new source repository ...")
-        self._switch_repo(repo_name)
-        Logger.print_ok(f"Switched to {repo_url} at branch {branch}!")
-
-    def _switch_repo(self, name: str) -> None:
-        target_dir: Path
-        if name == "klipper":
-            target_dir = KLIPPER_DIR
-            _type = Klipper
-        elif name == "moonraker":
-            target_dir = MOONRAKER_DIR
-            _type = Moonraker
-        else:
-            Logger.print_error("Invalid repository name!")
-            return
-
-        if target_dir.exists():
-            shutil.rmtree(target_dir)
-
-        im = InstanceManager(_type)
-        im.stop_all_instance()
-
-        repo = self.settings.get(name, "repo_url")
-        branch = self.settings.get(name, "branch")
-        git_clone_wrapper(repo, target_dir, branch)
-
-        im.start_all_instance()
-
-    def set_klipper_repo(self, **kwargs):
-        self._set_repo("klipper")
-
-    def set_moonraker_repo(self, **kwargs):
-        self._set_repo("moonraker")
-
-    def toggle_mainsail_release(self, **kwargs):
-        self.mainsail_unstable = not self.mainsail_unstable
-        self.settings.mainsail.unstable_releases = self.mainsail_unstable
-        self.settings.save()
-
-    def toggle_fluidd_release(self, **kwargs):
-        self.fluidd_unstable = not self.fluidd_unstable
-        self.settings.fluidd.unstable_releases = self.fluidd_unstable
-        self.settings.save()
-
-    def toggle_backup_before_update(self, **kwargs):
-        self.auto_backups_enabled = not self.auto_backups_enabled
-        self.settings.kiauh.backup_before_update = self.auto_backups_enabled
-        self.settings.save()

kiauh/core/menus/update_menu.py

@@ -1,186 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-import textwrap
-from typing import Optional, Type
-
-from components.crowsnest.crowsnest import get_crowsnest_status, update_crowsnest
-from components.klipper.klipper_setup import update_klipper
-from components.klipper.klipper_utils import (
-    get_klipper_status,
-)
-from components.klipperscreen.klipperscreen import (
-    get_klipperscreen_status,
-    update_klipperscreen,
-)
-from components.mobileraker.mobileraker import (
-    get_mobileraker_status,
-    update_mobileraker,
-)
-from components.moonraker.moonraker_setup import update_moonraker
-from components.moonraker.moonraker_utils import get_moonraker_status
-from components.webui_client.client_config.client_config_setup import (
-    update_client_config,
-)
-from components.webui_client.client_setup import update_client
-from components.webui_client.client_utils import (
-    get_client_config_status,
-    get_client_status,
-)
-from components.webui_client.fluidd_data import FluiddData
-from components.webui_client.mainsail_data import MainsailData
-from core.menus import Option
-from core.menus.base_menu import BaseMenu
-from utils.constants import (
-    COLOR_GREEN,
-    COLOR_RED,
-    COLOR_YELLOW,
-    RESET_FORMAT,
-)
-from utils.types import ComponentStatus
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class UpdateMenu(BaseMenu):
-    def __init__(self, previous_menu: Optional[Type[BaseMenu]] = None):
-        super().__init__()
-        self.previous_menu = previous_menu
-
-        self.kl_local = self.kl_remote = self.mr_local = self.mr_remote = ""
-        self.ms_local = self.ms_remote = self.fl_local = self.fl_remote = ""
-        self.mc_local = self.mc_remote = self.fc_local = self.fc_remote = ""
-        self.ks_local = self.ks_remote = self.mb_local = self.mb_remote = ""
-        self.cn_local = self.cn_remote = ""
-
-        self.mainsail_data = MainsailData()
-        self.fluidd_data = FluiddData()
-        self._fetch_update_status()
-
-    def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
-        from core.menus.main_menu import MainMenu
-
-        self.previous_menu: Type[BaseMenu] = (
-            previous_menu if previous_menu is not None else MainMenu
-        )
-
-    def set_options(self) -> None:
-        self.options = {
-            "0": Option(self.update_all, menu=False),
-            "1": Option(self.update_klipper, menu=False),
-            "2": Option(self.update_moonraker, menu=False),
-            "3": Option(self.update_mainsail, menu=False),
-            "4": Option(self.update_fluidd, menu=False),
-            "5": Option(self.update_mainsail_config, menu=False),
-            "6": Option(self.update_fluidd_config, menu=False),
-            "7": Option(self.update_klipperscreen, menu=False),
-            "8": Option(self.update_mobileraker, menu=False),
-            "9": Option(self.update_crowsnest, menu=False),
-            "10": Option(self.upgrade_system_packages, menu=False),
-        }
-
-    def print_menu(self):
-        self._fetch_update_status()
-
-        header = " [ Update Menu ] "
-        color = COLOR_GREEN
-        count = 62 - len(color) - len(RESET_FORMAT)
-        menu = textwrap.dedent(
-            f"""
-            /=======================================================\\
-            | {color}{header:~^{count}}{RESET_FORMAT} |
-            |-------------------------------------------------------|
-            |  0) Update all        |               |               |
-            |                       | Current:      | Latest:       |
-            | Klipper & API:        |---------------|---------------|
-            |  1) Klipper           | {self.kl_local:<22} | {self.kl_remote:<22} |
-            |  2) Moonraker         | {self.mr_local:<22} | {self.mr_remote:<22} |
-            |                       |               |               |
-            | Webinterface:         |---------------|---------------|
-            |  3) Mainsail          | {self.ms_local:<22} | {self.ms_remote:<22} |
-            |  4) Fluidd            | {self.fl_local:<22} | {self.fl_remote:<22} |
-            |                       |               |               |
-            | Client-Config:        |---------------|---------------|
-            |  5) Mainsail-Config   | {self.mc_local:<22} | {self.mc_remote:<22} |
-            |  6) Fluidd-Config     | {self.fc_local:<22} | {self.fc_remote:<22} |
-            |                       |               |               |
-            | Other:                |---------------|---------------|
-            |  7) KlipperScreen     | {self.ks_local:<22} | {self.ks_remote:<22} |
-            |  8) Mobileraker       | {self.mb_local:<22} | {self.mb_remote:<22} |
-            |  9) Crowsnest         | {self.cn_local:<22} | {self.cn_remote:<22} |
-            |                       |-------------------------------|
-            | 10) System            |                               |
-            """
-        )[1:]
-        print(menu, end="")
-
-    def update_all(self, **kwargs):
-        print("update_all")
-
-    def update_klipper(self, **kwargs):
-        update_klipper()
-
-    def update_moonraker(self, **kwargs):
-        update_moonraker()
-
-    def update_mainsail(self, **kwargs):
-        update_client(self.mainsail_data)
-
-    def update_mainsail_config(self, **kwargs):
-        update_client_config(self.mainsail_data)
-
-    def update_fluidd(self, **kwargs):
-        update_client(self.fluidd_data)
-
-    def update_fluidd_config(self, **kwargs):
-        update_client_config(self.fluidd_data)
-
-    def update_klipperscreen(self, **kwargs):
-        update_klipperscreen()
-
-    def update_mobileraker(self, **kwargs):
-        update_mobileraker()
-
-    def update_crowsnest(self, **kwargs):
-        update_crowsnest()
-
-    def upgrade_system_packages(self, **kwargs): ...
-
-    def _fetch_update_status(self):
-        # klipper
-        self._get_update_status("kl", get_klipper_status)
-        # moonraker
-        self._get_update_status("mr", get_moonraker_status)
-        # mainsail
-        self._get_update_status("ms", get_client_status, self.mainsail_data, True)
-        # mainsail-config
-        self._get_update_status("mc", get_client_config_status, self.mainsail_data)
-        # fluidd
-        self._get_update_status("fl", get_client_status, self.fluidd_data, True)
-        # fluidd-config
-        self._get_update_status("fc", get_client_config_status, self.fluidd_data)
-        # klipperscreen
-        self._get_update_status("ks", get_klipperscreen_status)
-        # mobileraker
-        self._get_update_status("mb", get_mobileraker_status)
-        # crowsnest
-        self._get_update_status("cn", get_crowsnest_status)
-
-    def _format_local_status(self, local_version, remote_version) -> str:
-        if local_version == remote_version:
-            return f"{COLOR_GREEN}{local_version}{RESET_FORMAT}"
-        return f"{COLOR_YELLOW}{local_version}{RESET_FORMAT}"
-
-    def _get_update_status(self, name: str, status_fn: callable, *args) -> None:
-        status_data: ComponentStatus = status_fn(*args)
-        local_ver = status_data.get("local")
-        remote_ver = status_data.get("remote")
-        color = COLOR_GREEN if remote_ver != "ERROR" else COLOR_RED
-        setattr(self, f"{name}_local", self._format_local_status(local_ver, remote_ver))
-        setattr(self, f"{name}_remote", f"{color}{remote_ver}{RESET_FORMAT}")

kiauh/core/settings/kiauh_settings.py

@@ -1,226 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  This file is part of KIAUH - Klipper Installation And Update Helper    #
-#  https://github.com/dw-0/kiauh                                          #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-from __future__ import annotations
-
-import textwrap
-from typing import Union
-
-from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
-    NoOptionError,
-    NoSectionError,
-    SimpleConfigParser,
-)
-from utils.constants import COLOR_RED, RESET_FORMAT
-from utils.logger import Logger
-from utils.sys_utils import kill
-
-from kiauh import PROJECT_ROOT
-
-
-class AppSettings:
-    def __init__(self) -> None:
-        self.backup_before_update = None
-
-
-class KlipperSettings:
-    def __init__(self) -> None:
-        self.repo_url = None
-        self.branch = None
-
-
-class MoonrakerSettings:
-    def __init__(self) -> None:
-        self.repo_url = None
-        self.branch = None
-
-
-class MainsailSettings:
-    def __init__(self) -> None:
-        self.port = None
-        self.unstable_releases = None
-
-
-class FluiddSettings:
-    def __init__(self) -> None:
-        self.port = None
-        self.unstable_releases = None
-
-
-# noinspection PyUnusedLocal
-# noinspection PyMethodMayBeStatic
-class KiauhSettings:
-    _instance = None
-    _default_cfg = PROJECT_ROOT.joinpath("default_kiauh.cfg")
-    _custom_cfg = PROJECT_ROOT.joinpath("kiauh.cfg")
-
-    def __new__(cls, *args, **kwargs) -> "KiauhSettings":
-        if cls._instance is None:
-            cls._instance = super(KiauhSettings, cls).__new__(cls, *args, **kwargs)
-            cls._instance.__initialized = False
-        return cls._instance
-
-    def __init__(self) -> None:
-        if self.__initialized:
-            return
-        self.__initialized = True
-        self.config = SimpleConfigParser()
-        self.kiauh = AppSettings()
-        self.klipper = KlipperSettings()
-        self.moonraker = MoonrakerSettings()
-        self.mainsail = MainsailSettings()
-        self.fluidd = FluiddSettings()
-
-        self.kiauh.backup_before_update = None
-        self.klipper.repo_url = None
-        self.klipper.branch = None
-        self.moonraker.repo_url = None
-        self.moonraker.branch = None
-        self.mainsail.port = None
-        self.mainsail.unstable_releases = None
-        self.fluidd.port = None
-        self.fluidd.unstable_releases = None
-
-        self._load_config()
-
-    def get(self, section: str, option: str) -> Union[str, int, bool]:
-        """
-        Get a value from the settings state by providing the section and option name as strings.
-        Prefer direct access to the properties, as it is usually safer!
-        :param section: The section name as string.
-        :param option: The option name as string.
-        :return: The value of the option as string, int or bool.
-        """
-
-        try:
-            section = getattr(self, section)
-            value = getattr(section, option)
-            return value
-        except AttributeError:
-            raise
-
-    def set(self, section: str, option: str, value: Union[str, int, bool]) -> None:
-        """
-        Set a value in the settings state by providing the section and option name as strings.
-        Prefer direct access to the properties, as it is usually safer!
-        :param section: The section name as string.
-        :param option: The option name as string.
-        :param value: The value to set as string, int or bool.
-        """
-        try:
-            section = getattr(self, section)
-            section.option = value
-        except AttributeError:
-            raise
-
-    def save(self) -> None:
-        self._set_config_options()
-        self.config.write(self._custom_cfg)
-        self._load_config()
-
-    def _load_config(self) -> None:
-        if not self._custom_cfg.exists() and not self._default_cfg.exists():
-            self._kill()
-
-        cfg = self._custom_cfg if self._custom_cfg.exists() else self._default_cfg
-        self.config.read(cfg)
-
-        self._validate_cfg()
-        self._read_settings()
-
-    def _validate_cfg(self) -> None:
-        try:
-            self._validate_bool("kiauh", "backup_before_update")
-
-            self._validate_str("klipper", "repo_url")
-            self._validate_str("klipper", "branch")
-
-            self._validate_int("mainsail", "port")
-            self._validate_bool("mainsail", "unstable_releases")
-
-            self._validate_int("fluidd", "port")
-            self._validate_bool("fluidd", "unstable_releases")
-
-        except ValueError:
-            err = f"Invalid value for option '{self._v_option}' in section '{self._v_section}'"
-            Logger.print_error(err)
-            kill()
-        except NoSectionError:
-            err = f"Missing section '{self._v_section}' in config file"
-            Logger.print_error(err)
-            kill()
-        except NoOptionError:
-            err = f"Missing option '{self._v_option}' in section '{self._v_section}'"
-            Logger.print_error(err)
-            kill()
-
-    def _validate_bool(self, section: str, option: str) -> None:
-        self._v_section, self._v_option = (section, option)
-        bool(self.config.getboolean(section, option))
-
-    def _validate_int(self, section: str, option: str) -> None:
-        self._v_section, self._v_option = (section, option)
-        int(self.config.getint(section, option))
-
-    def _validate_str(self, section: str, option: str) -> None:
-        self._v_section, self._v_option = (section, option)
-        v = self.config.get(section, option)
-        if v.isdigit() or v.lower() == "true" or v.lower() == "false":
-            raise ValueError
-
-    def _read_settings(self):
-        self.kiauh.backup_before_update = self.config.getboolean(
-            "kiauh", "backup_before_update"
-        )
-        self.klipper.repo_url = self.config.get("klipper", "repo_url")
-        self.klipper.branch = self.config.get("klipper", "branch")
-        self.moonraker.repo_url = self.config.get("moonraker", "repo_url")
-        self.moonraker.branch = self.config.get("moonraker", "branch")
-        self.mainsail.port = self.config.getint("mainsail", "port")
-        self.mainsail.unstable_releases = self.config.getboolean(
-            "mainsail", "unstable_releases"
-        )
-        self.fluidd.port = self.config.getint("fluidd", "port")
-        self.fluidd.unstable_releases = self.config.getboolean(
-            "fluidd", "unstable_releases"
-        )
-
-    def _set_config_options(self):
-        self.config.set(
-            "kiauh",
-            "backup_before_update",
-            str(self.kiauh.backup_before_update),
-        )
-        self.config.set("klipper", "repo_url", self.klipper.repo_url)
-        self.config.set("klipper", "branch", self.klipper.branch)
-        self.config.set("moonraker", "repo_url", self.moonraker.repo_url)
-        self.config.set("moonraker", "branch", self.moonraker.branch)
-        self.config.set("mainsail", "port", str(self.mainsail.port))
-        self.config.set(
-            "mainsail",
-            "unstable_releases",
-            str(self.mainsail.unstable_releases),
-        )
-        self.config.set("fluidd", "port", str(self.fluidd.port))
-        self.config.set(
-            "fluidd", "unstable_releases", str(self.fluidd.unstable_releases)
-        )
-
-    def _kill(self) -> None:
-        l1 = "!!! ERROR !!!"
-        l2 = "No KIAUH configuration file found!"
-        error = textwrap.dedent(
-            f"""
-            {COLOR_RED}/=======================================================\\
-            | {l1:^53} |
-            | {l2:^53} |
-            \=======================================================/{RESET_FORMAT}
-            """
-        )[1:]
-        print(error, end="")
-        kill()

kiauh/core/submodules/simple_config_parser/.editorconfig

@@ -1,13 +0,0 @@
-# see https://editorconfig.org/
-root = true
-
-[*]
-end_of_line = lf
-trim_trailing_whitespace = true
-indent_style = space
-insert_final_newline = true
-indent_size = 4
-charset = utf-8
-
-[*.py]
-max_line_length = 88

kiauh/core/submodules/simple_config_parser/.gitignore

@@ -1,13 +0,0 @@
-*.py[cod]
-*.pyc
-__pycache__
-.pytest_cache/
-
-.idea/
-.vscode/
-
-.venv*/
-venv*/
-
-.coverage
-htmlcov/

kiauh/core/submodules/simple_config_parser/LICENSE

@@ -1,674 +0,0 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-                            Preamble
-
-  The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
-  The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works.  By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users.  We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors.  You can apply it to
-your programs, too.
-
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    <program>  Copyright (C) <year>  <name of author>
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<https://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.

kiauh/core/submodules/simple_config_parser/README.md

@@ -1,6 +0,0 @@
-# Simple Config Parser
-
-A custom config parser inspired by Python's configparser module.
-Specialized for handling Klipper style config files.
-
-

kiauh/core/submodules/simple_config_parser/pyproject.toml

@@ -1,66 +0,0 @@
-[project]
-name = "simple-config-parser"
-version = "0.0.1"
-description = "A simple config parser for Python"
-authors = [
-    {name = "Dominik Willner", email = "th33xitus@gmail.com"},
-]
-readme = "README.md"
-license = {text = "GPL-3.0-only"}
-requires-python = ">=3.8"
-
-[project.urls]
-homepage = "https://github.com/dw-0/simple-config-parser"
-repository = "https://github.com/dw-0/simple-config-parser"
-documentation = "https://github.com/dw-0/simple-config-parser"
-
-[project.optional-dependencies]
-dev=["ruff"]
-
-[tool.ruff]
-required-version = ">=0.3.4"
-respect-gitignore = true
-exclude = [".git",".github", "./docs"]
-line-length = 88
-indent-width = 4
-output-format = "full"
-
-[tool.ruff.format]
-indent-style = "space"
-line-ending = "lf"
-quote-style = "double"
-
-[tool.ruff.lint]
-extend-select = ["I"]
-
-[tool.pytest.ini_options]
-minversion = "8.2.1"
-testpaths = ["tests/**/*.py"]
-addopts = "--cov --cov-config=pyproject.toml --cov-report=html"
-
-[tool.coverage.run]
-branch = true
-source = ["src.simple_config_parser"]
-
-[tool.coverage.report]
-# Regexes for lines to exclude from consideration
-exclude_also = [
-    # Don't complain about missing debug-only code:
-    "def __repr__",
-    "if self\\.debug",
-
-    # Don't complain if tests don't hit defensive assertion code:
-    "raise AssertionError",
-    "raise NotImplementedError",
-
-    # Don't complain if non-runnable code isn't run:
-    "if 0:",
-    "if __name__ == .__main__.:",
-
-    # Don't complain about abstract methods, they aren't run:
-    "@(abc\\.)?abstractmethod",
-    ]
-
-[tool.coverage.html]
-title = "SimpleConfigParser Coverage Report"
-directory = "htmlcov"

kiauh/core/submodules/simple_config_parser/requirements-dev.txt

@@ -1,3 +0,0 @@
-ruff >= 0.3.4
-pytest >= 8.2.1
-pytest-cov >= 5.0.0

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

@@ -1,551 +0,0 @@
-# ======================================================================= #
-#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
-#                                                                         #
-#  https://github.com/dw-0/simple-config-parser                           #
-#                                                                         #
-#  This file may be distributed under the terms of the GNU GPLv3 license  #
-# ======================================================================= #
-
-from __future__ import annotations
-
-import re
-from pathlib import Path
-from typing import Callable, Dict, List, Match, Tuple, TypedDict
-
-_UNSET = object()
-
-
-class Section(TypedDict):
-    """
-    A single section in the config file
-
-    - _raw: The raw representation of the section name
-    - options: A list of options in the section
-    """
-
-    _raw: str
-    options: List[Option]
-
-
-class Option(TypedDict, total=False):
-    """
-    A single option in a section in the config file
-
-    - is_multiline: Whether the option is a multiline option
-    - option: The name of the option
-    - value: The value of the option
-    - _raw: The raw representation of the option
-    - _raw_value: The raw value of the option
-
-    A multinline option is an option that contains multiple lines of text following
-    the option name in the next line. The value of a multiline option is a list of
-    strings, where each string represents a single line of text.
-    """
-
-    is_multiline: bool
-    option: str
-    value: str | List[str]
-    _raw: str
-    _raw_value: str | List[str]
-
-
-class NoSectionError(Exception):
-    """Raised when a section is not defined"""
-
-    def __init__(self, section: str):
-        msg = f"Section '{section}' is not defined"
-        super().__init__(msg)
-
-
-class NoOptionError(Exception):
-    """Raised when an option is not defined in a section"""
-
-    def __init__(self, option: str, section: str):
-        msg = f"Option '{option}' in section '{section}' is not defined"
-        super().__init__(msg)
-
-
-class DuplicateSectionError(Exception):
-    """Raised when a section is defined more than once"""
-
-    def __init__(self, section: str):
-        msg = f"Section '{section}' is defined more than once"
-        super().__init__(msg)
-
-
-class DuplicateOptionError(Exception):
-    """Raised when an option is defined more than once"""
-
-    def __init__(self, option: str, section: str):
-        msg = f"Option '{option}' in section '{section}' is defined more than once"
-        super().__init__(msg)
-
-
-# noinspection PyMethodMayBeStatic
-class SimpleConfigParser:
-    """A customized config parser targeted at handling Klipper style config files"""
-
-    _SECTION_RE = re.compile(r"\s*\[(\w+\s?[\w\-]+)]\s*([#;].*)?$")
-    _OPTION_RE = re.compile(r"^\s*(\w+)\s*[:=]\s*([^=:].*)\s*([#;].*)?$")
-    _MLOPTION_RE = re.compile(r"^\s*(\w+)\s*[:=]\s*([#;].*)?$")
-    _COMMENT_RE = re.compile(r"^\s*([#;].*)?$")
-    _EMPTY_LINE_RE = re.compile(r"^\s*$")
-
-    BOOLEAN_STATES = {
-        "1": True,
-        "yes": True,
-        "true": True,
-        "on": True,
-        "0": False,
-        "no": False,
-        "false": False,
-        "off": False,
-    }
-
-    def __init__(self):
-        self._config: Dict = {}
-        self._header: List[str] = []
-        self._all_sections: List[str] = []
-        self._all_options: Dict = {}
-        self.section_name: str = ""
-        self.in_option_block: bool = False  # whether we are in a multiline option block
-
-    def read(self, file: Path) -> None:
-        """
-        Read the given file and store the result in the internal state.
-        Call this method before using any other methods. Calling this method
-        multiple times will reset the internal state on each call.
-        """
-
-        self._reset_state()
-
-        try:
-            with open(file, "r") as f:
-                self._parse_config(f.readlines())
-
-        except OSError:
-            raise
-
-    def _reset_state(self):
-        """Reset the internal state."""
-
-        self._config.clear()
-        self._header.clear()
-        self._all_sections.clear()
-        self._all_options.clear()
-        self.section_name = ""
-        self.in_option_block = False
-
-    def write(self, filename):
-        """Write the internal state to the given file"""
-
-        content = self._construct_content()
-
-        with open(filename, "w") as f:
-            f.write(content)
-
-    def _construct_content(self) -> str:
-        """
-        Constructs the content of the configuration file based on the internal state of
-        the _config object by iterating over the sections and their options. It starts
-        by checking if a header is present and extends the content list with its elements.
-        Then, for each section, it appends the raw representation of the section to the
-        content list. If the section has a body, it iterates over its options and extends
-        the content list with their raw representations. If an option is multiline, it
-        also extends the content list with its raw value. Finally, the content list is
-        joined into a single string and returned.
-
-        :return: The content of the configuration file as a string
-        """
-        content: List[str] = []
-        if self._header is not None:
-            content.extend(self._header)
-        for section in self._config:
-            content.append(self._config[section]["_raw"])
-
-            if (sec_body := self._config[section].get("body")) is not None:
-                for option in sec_body:
-                    content.extend(option["_raw"])
-                    if option["is_multiline"]:
-                        content.extend(option["_raw_value"])
-        content: str = "".join(content)
-
-        return content
-
-    def sections(self) -> List[str]:
-        """Return a list of section names"""
-
-        return self._all_sections
-
-    def add_section(self, section: str) -> None:
-        """Add a new section to the internal state"""
-
-        if section in self._all_sections:
-            raise DuplicateSectionError(section)
-        self._all_sections.append(section)
-        self._all_options[section] = {}
-        self._config[section] = {"_raw": f"\n[{section}]\n", "body": []}
-
-    def remove_section(self, section: str) -> None:
-        """Remove the given section"""
-
-        if section not in self._all_sections:
-            raise NoSectionError(section)
-
-        del self._all_sections[self._all_sections.index(section)]
-        del self._all_options[section]
-        del self._config[section]
-
-    def options(self, section) -> List[str]:
-        """Return a list of option names for the given section name"""
-
-        return self._all_options.get(section)
-
-    def get(
-        self, section: str, option: str, fallback: str | _UNSET = _UNSET
-    ) -> str | List[str]:
-        """
-        Return the value of the given option in the given section
-
-        If the key is not found and 'fallback' is provided, it is used as
-        a fallback value.
-        """
-
-        try:
-            if section not in self._all_sections:
-                raise NoSectionError(section)
-
-            if option not in self._all_options.get(section):
-                raise NoOptionError(option, section)
-
-            return self._all_options[section][option]
-        except (NoSectionError, NoOptionError):
-            if fallback is _UNSET:
-                raise
-            return fallback
-
-    def getint(self, section: str, option: str, fallback: int | _UNSET = _UNSET) -> int:
-        """Return the value of the given option in the given section as an int"""
-
-        return self._get_conv(section, option, int, fallback=fallback)
-
-    def getfloat(
-        self, section: str, option: str, fallback: float | _UNSET = _UNSET
-    ) -> float:
-        return self._get_conv(section, option, float, fallback=fallback)
-
-    def getboolean(
-        self, section: str, option: str, fallback: bool | _UNSET = _UNSET
-    ) -> bool:
-        return self._get_conv(
-            section, option, self._convert_to_boolean, fallback=fallback
-        )
-
-    def _convert_to_boolean(self, value) -> bool:
-        if value.lower() not in self.BOOLEAN_STATES:
-            raise ValueError("Not a boolean: %s" % value)
-        return self.BOOLEAN_STATES[value.lower()]
-
-    def _get_conv(
-        self,
-        section: str,
-        option: str,
-        conv: Callable[[str], int | float | bool],
-        fallback: _UNSET = _UNSET,
-    ) -> int | float | bool:
-        try:
-            return conv(self.get(section, option, fallback))
-        except:
-            if fallback is not _UNSET:
-                return fallback
-            raise
-
-    def items(self, section: str) -> List[Tuple[str, str]]:
-        """Return a list of (option, value) tuples for a specific section"""
-
-        if section not in self._all_sections:
-            raise NoSectionError(section)
-
-        result = []
-        for _option in self._all_options[section]:
-            result.append((_option, self._all_options[section][_option]))
-
-        return result
-
-    def set(
-        self,
-        section: str,
-        option: str,
-        value: str,
-        multiline: bool = False,
-        indent: int = 4,
-    ) -> None:
-        """Set the given option to the given value in the given section
-
-        If the option is already defined, it will be overwritten. If the option
-        is not defined yet, it will be added to the section body.
-
-        The multiline parameter can be used to specify whether the value is
-        multiline or not. If it is not specified, the value will be considered
-        as multiline if it contains a newline character. The value will then be split
-        into multiple lines. If the value does not contain a newline character, it
-        will be considered as a single line value. The indent parameter can be used
-        to specify the indentation of the multiline value. Indentations are with spaces.
-
-        :param section: The section to set the option in
-        :param option: The option to set
-        :param value: The value to set
-        :param multiline: Whether the value is multiline or not
-        :param indent: The indentation for multiline values
-        """
-
-        if section not in self._all_sections:
-            raise NoSectionError(section)
-
-        # prepare the options value and raw value depending on the multiline flag
-        _raw_value: List[str] | None = None
-        if multiline or "\n" in value:
-            _multiline = True
-            _raw: str = f"{option}:\n"
-            _value: List[str] = value.split("\n")
-            _raw_value: List[str] = [f"{' ' * indent}{v}\n" for v in _value]
-        else:
-            _multiline = False
-            _raw: str = f"{option}: {value}\n"
-            _value: str = value
-
-        # the option does not exist yet
-        if option not in self._all_options.get(section):
-            _option: Option = {
-                "is_multiline": _multiline,
-                "option": option,
-                "value": _value,
-                "_raw": _raw,
-            }
-            if _raw_value is not None:
-                _option["_raw_value"] = _raw_value
-            self._config[section]["body"].insert(0, _option)
-
-        # the option exists and we need to update it
-        else:
-            for _option in self._config[section]["body"]:
-                if _option["option"] == option:
-                    if multiline:
-                        _option["_raw"] = _raw
-                    else:
-                        # we preserve inline comments by replacing the old value with the new one
-                        _option["_raw"] = _option["_raw"].replace(
-                            _option["value"], _value
-                        )
-                    _option["value"] = _value
-                    if _raw_value is not None:
-                        _option["_raw_value"] = _raw_value
-                    break
-
-        self._all_options[section][option] = _value
-
-    def remove_option(self, section: str, option: str) -> None:
-        """Remove the given option from the given section"""
-
-        if section not in self._all_sections:
-            raise NoSectionError(section)
-
-        if option not in self._all_options.get(section):
-            raise NoOptionError(option, section)
-
-        for _option in self._config[section]["body"]:
-            if _option["option"] == option:
-                del self._all_options[section][option]
-                self._config[section]["body"].remove(_option)
-                break
-
-    def has_section(self, section: str) -> bool:
-        """Return True if the given section exists, False otherwise"""
-        return section in self._all_sections
-
-    def has_option(self, section: str, option: str) -> bool:
-        """Return True if the given option exists in the given section, False otherwise"""
-        return option in self._all_options.get(section)
-
-    def _is_section(self, line: str) -> bool:
-        """Check if the given line contains a section definition"""
-        return self._SECTION_RE.match(line) is not None
-
-    def _is_option(self, line: str) -> bool:
-        """Check if the given line contains an option definition"""
-
-        match: Match[str] | None = self._OPTION_RE.match(line)
-
-        if not match:
-            return False
-
-        # if there is no value, it's not a regular option but a multiline option
-        if match.group(2).strip() == "":
-            return False
-
-        if not match.group(1).strip() == "":
-            return True
-
-        return False
-
-    def _is_comment(self, line: str) -> bool:
-        """Check if the given line is a comment"""
-        return self._COMMENT_RE.match(line) is not None
-
-    def _is_empty_line(self, line: str) -> bool:
-        """Check if the given line is an empty line"""
-        return self._EMPTY_LINE_RE.match(line) is not None
-
-    def _is_multiline_option(self, line: str) -> bool:
-        """Check if the given line starts a multiline option block"""
-
-        match: Match[str] | None = self._MLOPTION_RE.match(line)
-
-        if not match:
-            return False
-
-        return True
-
-    def _parse_config(self, content: List[str]) -> None:
-        """Parse the given content and store the result in the internal state"""
-
-        _curr_multi_opt = ""
-
-        # THE ORDER MATTERS, DO NOT REORDER THE CONDITIONS!
-        for line in content:
-            if self._is_section(line):
-                self._parse_section(line)
-
-            elif self._is_option(line):
-                self._parse_option(line)
-
-            # if it's not a regular option with the value inline,
-            # it might be a might be a multiline option block
-            elif self._is_multiline_option(line):
-                self.in_option_block = True
-                _curr_multi_opt = self._OPTION_RE.match(line).group(1).strip()
-                self._add_option_to_section_body(_curr_multi_opt, "", line)
-
-            elif self.in_option_block:
-                self._parse_multiline_option(_curr_multi_opt, line)
-
-            # if it's nothing from above, it's probably a comment or an empty line
-            elif self._is_comment(line) or self._is_empty_line(line):
-                self._parse_comment(line)
-
-    def _parse_section(self, line: str) -> None:
-        """Parse a section line and store the result in the internal state"""
-
-        match: Match[str] | None = self._SECTION_RE.match(line)
-        if not match:
-            return
-
-        self.in_option_block = False
-
-        section_name: str = match.group(1).strip()
-        self._store_internal_state_section(section_name, line)
-
-    def _store_internal_state_section(self, section: str, raw_value: str) -> None:
-        """Store the given section and its raw value in the internal state"""
-
-        if section in self._all_sections:
-            raise DuplicateSectionError(section)
-
-        self.section_name = section
-        self._all_sections.append(section)
-        self._config[section]: Section = {"_raw": raw_value, "body": []}
-
-    def _parse_option(self, line: str) -> None:
-        """Parse an option line and store the result in the internal state"""
-
-        self.in_option_block = False
-
-        match: Match[str] | None = self._OPTION_RE.match(line)
-        if not match:
-            return
-
-        option: str = match.group(1).strip()
-        value: str = match.group(2).strip()
-
-        if ";" in value:
-            i = value.index(";")
-            value = value[:i].strip()
-        elif "#" in value:
-            i = value.index("#")
-            value = value[:i].strip()
-
-        self._store_internal_state_option(option, value, line)
-
-    def _store_internal_state_option(
-        self, option: str, value: str, raw_value: str
-    ) -> None:
-        """Store the given option and its raw value in the internal state"""
-
-        section_options = self._all_options.setdefault(self.section_name, {})
-
-        if option in section_options:
-            raise DuplicateOptionError(option, self.section_name)
-
-        section_options[option] = value
-        self._add_option_to_section_body(option, value, raw_value)
-
-    def _parse_multiline_option(self, curr_ml_opt: str, line: str) -> None:
-        """Parse a multiline option line and store the result in the internal state"""
-
-        section_options = self._all_options.setdefault(self.section_name, {})
-        multiline_options = section_options.setdefault(curr_ml_opt, [])
-
-        _cleaned_line = line.strip().strip("\n")
-        if _cleaned_line and not self._is_comment(line):
-            multiline_options.append(_cleaned_line)
-
-        # add the option to the internal multiline option value state
-        self._ensure_section_body_exists()
-        for _option in self._config[self.section_name]["body"]:
-            if _option.get("option") == curr_ml_opt:
-                _option.update(
-                    is_multiline=True,
-                    _raw_value=_option.get("_raw_value", []) + [line],
-                    value=multiline_options,
-                )
-
-    def _parse_comment(self, line: str) -> None:
-        """
-        Parse a comment line and store the result in the internal state
-
-        If the there was no previous section parsed, the lines are handled as
-        the file header and added to the internal header list as it means, that
-        we are at the very top of the file.
-        """
-
-        self.in_option_block = False
-
-        if not self.section_name:
-            self._header.append(line)
-        else:
-            self._add_option_to_section_body("", "", line)
-
-    def _ensure_section_body_exists(self) -> None:
-        """
-        Ensure that the section body exists in the internal state.
-        If the section body does not exist, it is created as an empty list
-        """
-        if self.section_name not in self._config:
-            self._config.setdefault(self.section_name, {}).setdefault("body", [])
-
-    def _add_option_to_section_body(
-        self, option: str, value: str, line: str, is_multiline: bool = False
-    ) -> None:
-        """Add a raw option line to the internal state"""
-
-        self._ensure_section_body_exists()
-
-        new_option: Option = {
-            "is_multiline": is_multiline,
-            "option": option,
-            "value": value,
-            "_raw": line,
-        }
-
-        option_body = self._config[self.section_name]["body"]
-        option_body.append(new_option)

kiauh/core/submodules/simple_config_parser/tests/Test SimpleConfigParser.run.xml

@@ -1,21 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Test SimpleConfigParser" type="tests" factoryName="py.test">
-    <module name="simple-config-parser" />
-    <option name="ENV_FILES" value="" />
-    <option name="INTERPRETER_OPTIONS" value="" />
-    <option name="PARENT_ENVS" value="true" />
-    <option name="SDK_HOME" value="" />
-    <option name="SDK_NAME" value="Python 3.8 (simple-config-parser)" />
-    <option name="WORKING_DIRECTORY" value="" />
-    <option name="IS_MODULE_SDK" value="false" />
-    <option name="ADD_CONTENT_ROOTS" value="true" />
-    <option name="ADD_SOURCE_ROOTS" value="true" />
-    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
-    <option name="_new_keywords" value="&quot;&quot;" />
-    <option name="_new_parameters" value="&quot;&quot;" />
-    <option name="_new_additionalArguments" value="&quot;-s -vv&quot;" />
-    <option name="_new_target" value="&quot;&quot;" />
-    <option name="_new_targetType" value="&quot;PATH&quot;" />
-    <method v="2" />
-  </configuration>
-</component>

kiauh/core/submodules/simple_config_parser/tests/features/internal_state/test_content_handling.py

@@ -1,95 +0,0 @@
-import pytest
-
-from src.simple_config_parser.simple_config_parser import SimpleConfigParser
-
-
-@pytest.fixture
-def parser():
-    parser = SimpleConfigParser()
-    parser._header = ["header1\n", "header2\n"]
-    parser._config = {
-        "section1": {
-            "_raw": "[section1]\n",
-            "body": [
-                {
-                    "_raw": "option1: value1\n",
-                    "_raw_value": "value1\n",
-                    "is_multiline": False,
-                    "option": "option1",
-                    "value": "value1",
-                },
-                {
-                    "_raw": "option2: value2\n",
-                    "_raw_value": "value2\n",
-                    "is_multiline": False,
-                    "option": "option2",
-                    "value": "value2",
-                },
-            ],
-        },
-        "section2": {
-            "_raw": "[section2]\n",
-            "body": [
-                {
-                    "_raw": "option3: value3\n",
-                    "_raw_value": "value3\n",
-                    "is_multiline": False,
-                    "option": "option3",
-                    "value": "value3",
-                },
-            ],
-        },
-        "section3": {
-            "_raw": "[section3]\n",
-            "body": [
-                {
-                    "_raw": "option4:\n",
-                    "_raw_value": ["    value4\n", "    value5\n", "    value6\n"],
-                    "is_multiline": True,
-                    "option": "option4",
-                    "value": ["value4", "value5", "value6"],
-                },
-            ],
-        },
-    }
-    return parser
-
-
-def test_construct_content(parser):
-    content = parser._construct_content()
-    assert (
-        content == "header1\nheader2\n"
-        "[section1]\n"
-        "option1: value1\n"
-        "option2: value2\n"
-        "[section2]\n"
-        "option3: value3\n"
-        "[section3]\n"
-        "option4:\n"
-        "    value4\n"
-        "    value5\n"
-        "    value6\n"
-    )
-
-
-def test_construct_content_no_header(parser):
-    parser._header = None
-    content = parser._construct_content()
-    assert (
-        content == "[section1]\n"
-        "option1: value1\n"
-        "option2: value2\n"
-        "[section2]\n"
-        "option3: value3\n"
-        "[section3]\n"
-        "option4:\n"
-        "    value4\n"
-        "    value5\n"
-        "    value6\n"
-    )
-
-
-def test_construct_content_no_sections(parser):
-    parser._config = {}
-    content = parser._construct_content()
-    assert content == "".join(parser._header)

kiauh/core/submodules/simple_config_parser/tests/features/internal_state/test_internal_state_changes.py

@@ -1,83 +0,0 @@
-import pytest
-
-from src.simple_config_parser.simple_config_parser import (
-    DuplicateOptionError,
-    DuplicateSectionError,
-    SimpleConfigParser,
-)
-
-
-@pytest.fixture
-def parser():
-    return SimpleConfigParser()
-
-
-class TestInternalStateChanges:
-    @pytest.mark.parametrize(
-        "given", ["dummy_section", "dummy_section 2", "another_section"]
-    )
-    def test_ensure_section_body_exists(self, parser, given):
-        parser._config = {}
-        parser.section_name = given
-        parser._ensure_section_body_exists()
-
-        assert parser._config[given] is not None
-        assert parser._config[given]["body"] == []
-
-    def test_add_option_to_section_body(self):
-        pass
-
-    @pytest.mark.parametrize(
-        "given", ["dummy_section", "dummy_section 2", "another_section\n"]
-    )
-    def test_store_internal_state_section(self, parser, given):
-        parser._store_internal_state_section(given, given)
-
-        assert parser._all_sections == [given]
-        assert parser._config[given]["body"] == []
-        assert parser._config[given]["_raw"] == given
-
-    def test_duplicate_section_error(self, parser):
-        section_name = "dummy_section"
-        parser._all_sections = [section_name]
-
-        with pytest.raises(DuplicateSectionError) as excinfo:
-            parser._store_internal_state_section(section_name, section_name)
-            message = f"Section '{section_name}' is defined more than once"
-            assert message in str(excinfo.value)
-
-        # Check that the internal state of the parser is correct
-        assert parser.in_option_block is False
-        assert parser.section_name == ""
-        assert parser._all_sections == [section_name]
-
-    @pytest.mark.parametrize(
-        "given_name, given_value, given_raw_value",
-        [("dummyoption", "dummyvalue", "dummyvalue\n")],
-    )
-    def test_store_internal_state_option(
-        self, parser, given_name, given_value, given_raw_value
-    ):
-        parser.section_name = "dummy_section"
-        parser._store_internal_state_option(given_name, given_value, given_raw_value)
-
-        assert parser._all_options[parser.section_name] == {given_name: given_value}
-
-        new_option = {
-            "is_multiline": False,
-            "option": given_name,
-            "value": given_value,
-            "_raw": given_raw_value,
-        }
-        assert parser._config[parser.section_name]["body"] == [new_option]
-
-    def test_duplicate_option_error(self, parser):
-        option_name = "dummyoption"
-        value = "dummyvalue"
-        parser.section_name = "dummy_section"
-        parser._all_options = {parser.section_name: {option_name: value}}
-
-        with pytest.raises(DuplicateOptionError) as excinfo:
-            parser._store_internal_state_option(option_name, value, value)
-            message = f"Option '{option_name}' in section '{parser.section_name}' is defined more than once"
-            assert message in str(excinfo.value)

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

@@ -1,6 +0,0 @@
-testcases = [
-    "# comment # 1",
-    "; comment # 2",
-    "    ; indented comment",
-    "        # another indented comment",
-]

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

@@ -1,19 +0,0 @@
-testcases = [
-    ("option: value", "option", "value"),
-    ("option : value", "option", "value"),
-    ("option :value", "option", "value"),
-    ("option= value", "option", "value"),
-    ("option = value", "option", "value"),
-    ("option =value", "option", "value"),
-    ("option: value\n", "option", "value"),
-    ("option: value # inline comment", "option", "value"),
-    ("option: value # inline comment\n", "option", "value"),
-    ("description: homing!", "description", "homing!"),
-    ("description: inline macro :-)", "description", "inline macro :-)"),
-    ("path: %GCODES_DIR%", "path", "%GCODES_DIR%"),
-    (
-        "serial = /dev/serial/by-id/<your-mcu-id>",
-        "serial",
-        "/dev/serial/by-id/<your-mcu-id>",
-    ),
-]

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

@@ -1,6 +0,0 @@
-testcases = [
-    ("[test_section]", "test_section"),
-    ("[test_section two]", "test_section two"),
-    ("[section1] # inline comment", "section1"),
-    ("[section2] ; second comment", "section2"),
-]

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

@@ -1,92 +0,0 @@
-import pytest
-from data.case_parse_comment import testcases as case_parse_comment
-from data.case_parse_option import testcases as case_parse_option
-from data.case_parse_section import testcases as case_parse_section
-
-from src.simple_config_parser.simple_config_parser import (
-    Option,
-    SimpleConfigParser,
-)
-
-
-@pytest.fixture
-def parser():
-    return SimpleConfigParser()
-
-
-class TestLineParsing:
-    @pytest.mark.parametrize("given, expected", [*case_parse_section])
-    def test_parse_section(self, parser, given, expected):
-        parser._parse_section(given)
-
-        # Check that the internal state of the parser is correct
-        assert parser.section_name == expected
-        assert parser.in_option_block is False
-        assert parser._all_sections == [expected]
-        assert parser._config[expected]["_raw"] == given
-        assert parser._config[expected]["body"] == []
-
-    @pytest.mark.parametrize(
-        "given, expected_option, expected_value", [*case_parse_option]
-    )
-    def test_parse_option(self, parser, given, expected_option, expected_value):
-        section_name = "test_section"
-        parser.section_name = section_name
-        parser._parse_option(given)
-
-        # Check that the internal state of the parser is correct
-        assert parser.section_name == section_name
-        assert parser.in_option_block is False
-        assert parser._all_options[section_name][expected_option] == expected_value
-
-        section_option = parser._config[section_name]["body"][0]
-        assert section_option["option"] == expected_option
-        assert section_option["value"] == expected_value
-        assert section_option["_raw"] == given
-
-    @pytest.mark.parametrize(
-        "option, next_line",
-        [("gcode", "next line"), ("gcode", "    {{% some jinja template %}}")],
-    )
-    def test_parse_multiline_option(self, parser, option, next_line):
-        parser.section_name = "dummy_section"
-        parser.in_option_block = True
-        parser._add_option_to_section_body(option, "", option)
-        parser._parse_multiline_option(option, next_line)
-        cleaned_next_line = next_line.strip().strip("\n")
-
-        assert parser._all_options[parser.section_name] is not None
-        assert parser._all_options[parser.section_name][option] == [cleaned_next_line]
-
-        expected_option: Option = {
-            "is_multiline": True,
-            "option": option,
-            "value": [cleaned_next_line],
-            "_raw": option,
-            "_raw_value": [next_line],
-        }
-        assert parser._config[parser.section_name]["body"] == [expected_option]
-
-    @pytest.mark.parametrize("given", [*case_parse_comment])
-    def test_parse_comment(self, parser, given):
-        parser.section_name = "dummy_section"
-        parser._parse_comment(given)
-
-        # internal state checks after parsing
-        assert parser.in_option_block is False
-
-        expected_option = {
-            "is_multiline": False,
-            "_raw": given,
-            "option": "",
-            "value": "",
-        }
-        assert parser._config[parser.section_name]["body"] == [expected_option]
-
-    @pytest.mark.parametrize("given", ["# header line", "; another header line"])
-    def test_parse_header_comment(self, parser, given):
-        parser.section_name = ""
-        parser._parse_comment(given)
-
-        assert parser.in_option_block is False
-        assert parser._header == [given]

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

@@ -1,9 +0,0 @@
-testcases = [
-    ("# an arbitrary comment", True),
-    ("; another arbitrary comment", True),
-    ("  ; indented comment", True),
-    ("  # indented comment", True),
-    ("not_a: comment", False),
-    ("also_not_a= comment", False),
-    ("[definitely_not_a_comment]", False),
-]

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

@@ -1,9 +0,0 @@
-testcases = [
-    ("", True),
-    (" ", True),
-    ("not empty", False),
-    ("  # indented comment", False),
-    ("not: empty", False),
-    ("also_not= empty", False),
-    ("[definitely_not_empty]", False),
-]