mirror of
https://github.com/dw-0/kiauh.git
synced 2025-12-15 03:24:29 +05:00
Compare commits
33 Commits
v6.0.0-bet
...
develop-do
| Author | SHA1 | Date | |
|---|---|---|---|
|
0e998ed66c | ||
|
|
06a78b7c83 | ||
|
|
31150c98e2 | ||
|
|
3317114780 | ||
|
|
8851bd68f8 | ||
|
|
9168ad88a6 | ||
|
|
03c0d46a2e | ||
|
|
8a8afc60ee | ||
|
|
5b68710b23 | ||
|
|
6cee0252ee | ||
|
|
aff63665de | ||
|
|
1ed1e0fc4c | ||
|
|
81ac102644 | ||
|
|
89b48168f4 | ||
|
195b7fa926 | ||
|
|
12919c7140 | ||
|
|
ee3d64e0dd | ||
|
|
393822b8b6 | ||
|
|
e590f668e6 | ||
|
075f2d384b | ||
|
|
afdde34721 | ||
|
|
393dd1d5bf | ||
|
|
8170057434 | ||
|
985b66d41f | ||
|
|
f95d2586bf | ||
|
|
f5141e7eff | ||
|
|
33113e72e9 | ||
|
|
6f59fd06aa | ||
|
|
56ea43ccb6 | ||
|
|
25e22c993f | ||
|
|
ead521b377 | ||
|
|
3c952ccc12 | ||
|
|
c8f713c00e |
@@ -11,5 +11,5 @@ end_of_line = lf
|
||||
[*.py]
|
||||
max_line_length = 88
|
||||
|
||||
[*.{sh,yml,yaml,json}]
|
||||
[*.{sh,yml,yaml,json,md}]
|
||||
indent_size = 2
|
||||
31
.github/workflows/deploy-docs.yml
vendored
Normal file
31
.github/workflows/deploy-docs.yml
vendored
Normal file
@@ -0,0 +1,31 @@
|
||||
name: Deploy Documentation
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- docs
|
||||
permissions:
|
||||
contents: write
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Configure Git Credentials
|
||||
run: |
|
||||
git config user.name github-actions[bot]
|
||||
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: 3.x
|
||||
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
|
||||
- uses: actions/cache@v4
|
||||
with:
|
||||
key: mkdocs-material-${{ env.cache_id }}
|
||||
path: .cache
|
||||
restore-keys: |
|
||||
mkdocs-material-
|
||||
- name: Install dependencies
|
||||
run: pip install -r requirements.txt
|
||||
- name: Build and deploy documentation
|
||||
run: mkdocs gh-deploy --force
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -10,3 +10,4 @@ __pycache__
|
||||
*.code-workspace
|
||||
*.iml
|
||||
kiauh.cfg
|
||||
klipper_repos.txt
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
source=scripts
|
||||
|
||||
enable=avoid-nullary-conditions
|
||||
enable=deprecate-which
|
||||
enable=quote-safe-variables
|
||||
enable=require-variable-braces
|
||||
enable=require-double-brackets
|
||||
|
||||
# SC2162: `read` without `-r` will mangle backslashes.
|
||||
# https://github.com/koalaman/shellcheck/wiki/SC2162
|
||||
disable=SC2162
|
||||
|
||||
# SC2164: Use `cd ... || exit` in case `cd` fails
|
||||
# https://github.com/koalaman/shellcheck/wiki/SC2164
|
||||
disable=SC2164
|
||||
6
Dockerfile
Normal file
6
Dockerfile
Normal file
@@ -0,0 +1,6 @@
|
||||
FROM squidfunk/mkdocs-material:latest
|
||||
|
||||
# Install additional plugins required by our mkdocs configuration
|
||||
RUN pip install \
|
||||
mkdocs-git-revision-date-localized-plugin \
|
||||
mkdocstrings[python]
|
||||
206
README_zh.md
Normal file
206
README_zh.md
Normal file
@@ -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>
|
||||
8
docker-compose.yml
Normal file
8
docker-compose.yml
Normal file
@@ -0,0 +1,8 @@
|
||||
services:
|
||||
mkdocs:
|
||||
build: .
|
||||
ports:
|
||||
- "8000:8000"
|
||||
volumes:
|
||||
- ./:/docs
|
||||
command: serve --dev-addr=0.0.0.0:8000
|
||||
BIN
docs/assets/logo-large.png
Normal file
BIN
docs/assets/logo-large.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 49 KiB After Width: | Height: | Size: 49 KiB |
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 58 KiB |
@@ -276,7 +276,7 @@ Each service gets its corresponding instance added to the service filename.
|
||||
|
||||
* The user can now choose to install Klipper as a systemd service.
|
||||
|
||||
* The Shell Command extension and `shell_command.py` got renamed to G-Code Shell Command extension and `gcode_shell_command.py`. In case the [pending PR](https://github.com/KevinOConnor/klipper/pull/2173) will be merged in the future, this was an early attempt to dodge possible incompatibilities. The [G-Code Shell Command docs](gcode_shell_command.md) has been updated accordingly.
|
||||
* The Shell Command extension and `shell_command.py` got renamed to G-Code Shell Command extension and `gcode_shell_command.py`. In case the [pending PR](https://github.com/KevinOConnor/klipper/pull/2173) will be merged in the future, this was an early attempt to dodge possible incompatibilities. The [G-Code Shell Command docs](extensions/gcode-shell-command) has been updated accordingly.
|
||||
|
||||
* The way how KIAUH interacts and writes to the users printer.cfg got changed. Usually KIAUH wrote everything directly into the printer.cfg. The way it will work from now on is, that a new file called `kiauh.cfg` will be created if there is something that needs to be written to the printer.cfg and everything gets written to `kiauh.cfg` instead. The only thing which then gets written to the users printer.cfg is `[include kiauh.cfg]`. This line will be located at the very top of the existing printer.cfg with a little comment as a note. The user can then decide to either keep the `kiauh.cfg` or take its content, places it into the printer.cfg directly and remove the `[include kiauh.cfg]`.
|
||||
|
||||
1
docs/extensions/index.md
Normal file
1
docs/extensions/index.md
Normal file
@@ -0,0 +1 @@
|
||||
# Community Extensions
|
||||
23
docs/index.md
Normal file
23
docs/index.md
Normal file
@@ -0,0 +1,23 @@
|
||||
!!! tip "Important"
|
||||
This documentation is for KIAUH version 6 and still work in progress!
|
||||
|
||||
<h1 align="center">
|
||||
KIAUH - Klipper Installation And Update Helper
|
||||
</h1>
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/logo-large.png" alt="KIAUH logo" width="400"/>
|
||||
</p>
|
||||
<p align="center" style="font-size: 1.2em; font-weight: bold;">
|
||||
A handy installation script that makes installing Klipper (and more) a breeze!
|
||||
</p>
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
- Easy installation of Klipper and related components
|
||||
- Support for multiple instances
|
||||
- Extension system for additional functionality
|
||||
- Configuration management
|
||||
- And more!
|
||||
|
||||
39
docs/setup/installation.md
Normal file
39
docs/setup/installation.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# Installing KIAUH
|
||||
|
||||
In the following sections, you will be guided through the installation
|
||||
process step-by-step.
|
||||
|
||||
To use KIAUH, it is enough to download the script and run it on your
|
||||
Raspberry Pi or other compatible device. If you need to know how to
|
||||
set up a Raspberry Pi or if you are unsure whether your current setup
|
||||
is sufficient, please refer to the [Raspberry Pi Installation Guide](raspberry-pi-setup.md)
|
||||
and follow the steps therein. Afterwards, you can return to this guide to install KIAUH.
|
||||
|
||||
### Prerequisites
|
||||
Before you can download and run KIAUH, you need to ensure that ``git`` is
|
||||
installed on your system. Open a terminal and run the following command:
|
||||
|
||||
```bash
|
||||
sudo apt-get update && sudo apt-get install git -y
|
||||
```
|
||||
|
||||
### Downloading KIAUH
|
||||
After `git` was successfully installed, you can download KIAUH by
|
||||
cloning the repository from GitHub. It is recommended to clone it into
|
||||
your home directory. Run the following command in your terminal:
|
||||
```bash
|
||||
cd ~ && git clone https://github.com/dw-0/kiauh.git
|
||||
```
|
||||
|
||||
### Running KIAUH
|
||||
Once the repository is cloned, you can start KIAUH. Make sure you are in
|
||||
your home directory and execute the script by running the following
|
||||
command:
|
||||
```bash
|
||||
./kiauh/kiauh.sh
|
||||
```
|
||||
|
||||
After executing the command, you will be presented with the KIAUH menu,
|
||||
which allows you to install and manage various 3D printing software.
|
||||
For more information on how to use KIAUH, please refer to the
|
||||
[Usage Guide](usage.md).
|
||||
49
docs/setup/raspberry-pi-setup.md
Normal file
49
docs/setup/raspberry-pi-setup.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# Raspberry Pi Setup
|
||||
|
||||
This guide will help you set up a Raspberry Pi for running Klipper and other,
|
||||
Klipper related 3D printing software. In case you are using a different single-board
|
||||
computer (SBC), please refer to the manufacturer's instructions for installing
|
||||
a compatible version of Linux on your device.
|
||||
|
||||
It is assumed that you have at least a Raspberry Pi 3 or newer, along with a
|
||||
microSD card (at least 8GB, preferably 16GB or more) and a power supply.
|
||||
Additionally, you will need a computer with an SD card reader to prepare
|
||||
the microSD card.
|
||||
|
||||
KIAUH requires a Linux operating system that has already been flashed to your
|
||||
Raspberry Pi's (or other SBC's) microSD card. As a result, you must ensure that you
|
||||
already have a functional Linux system on hand before you can proceed with
|
||||
installing KIAUH. `Raspberry Pi OS Lite` (either 32bit or 64bit) is a recommended Linux image
|
||||
if you are using a Raspberry Pi.
|
||||
|
||||
---
|
||||
|
||||
To flash `Raspberry Pi OS Lite` to your microSD card using the official [Raspberry Pi Imager](https://www.raspberrypi.com/software/),
|
||||
follow the steps below. If you encounter any issues or need further assistance, please refer to the [official Raspberry Pi documentation](https://www.raspberrypi.com/documentation/computers/getting-started.html).
|
||||
|
||||
1. Open the Raspberry Pi Imager application on your computer.
|
||||
2. Click on `Choose OS` and select `Raspberry Pi OS (other)`.
|
||||
|
||||
3. Choose `Raspberry Pi OS Lite (32bit)` (or 64bit if desired).
|
||||
|
||||
4. Insert the microSD card into your computer's SD card reader.
|
||||
5. In the main menu of the Imager, select the correct microSD card.
|
||||
6. Click the gear icon at the bottom left of the main menu to open advanced options.
|
||||
7. Enable SSH and enter your Wi-Fi credentials.
|
||||
|
||||
!!! info
|
||||
Wi-Fi is only necessary if you want to connect to your Raspberry Pi over a wireless network. If you plan to use a wired Ethernet connection, you can skip this step. SSH is required for remote access to your Raspberry Pi, so make sure to enable it.
|
||||
|
||||
8. Click `Save` to close the advanced options menu.
|
||||
9. Click `Write` to start flashing the image to the microSD card.
|
||||
|
||||
!!! warning
|
||||
All data on the microSD card will be overwritten!
|
||||
|
||||
10. Once the flashing process is complete, safely eject the microSD card from your computer.
|
||||
11. Insert the microSD card into your Raspberry Pi.
|
||||
12. Connect your Raspberry Pi to a power source to boot it up.
|
||||
13. Wait for a few minutes to allow the Raspberry Pi to complete its initial setup.
|
||||
14. You can now connect to your Raspberry Pi via SSH using the IP address assigned by your router. The default username is `pi` and the default password is `raspberry`.
|
||||
|
||||
If you successfully connected to your Raspberry Pi via SSH, you can proceed to install KIAUH by following the instructions in the [Installation Guide](installation.md).
|
||||
15
kiauh.py
15
kiauh.py
@@ -1,15 +0,0 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
|
||||
from kiauh.main import main
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
105
kiauh.sh
105
kiauh.sh
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
#=======================================================================#
|
||||
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
|
||||
# Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
@@ -15,11 +15,6 @@ clear -x
|
||||
# make sure we have the correct permissions while running the script
|
||||
umask 022
|
||||
|
||||
### sourcing all additional scripts
|
||||
KIAUH_SRCDIR="$(dirname -- "$(readlink -f "${BASH_SOURCE[0]}")")"
|
||||
for script in "${KIAUH_SRCDIR}/scripts/"*.sh; do . "${script}"; done
|
||||
for script in "${KIAUH_SRCDIR}/scripts/ui/"*.sh; do . "${script}"; done
|
||||
|
||||
#===================================================#
|
||||
#=================== UPDATE KIAUH ==================#
|
||||
#===================================================#
|
||||
@@ -57,15 +52,6 @@ function kiauh_update_avail() {
|
||||
fi
|
||||
}
|
||||
|
||||
function save_startup_version() {
|
||||
local launch_version
|
||||
|
||||
echo "${1}"
|
||||
|
||||
sed -i "/^version_to_launch=/d" "${INI_FILE}"
|
||||
sed -i '$a'"version_to_launch=${1}" "${INI_FILE}"
|
||||
}
|
||||
|
||||
function kiauh_update_dialog() {
|
||||
[[ ! $(kiauh_update_avail) == "true" ]] && return
|
||||
top_border
|
||||
@@ -93,11 +79,35 @@ function kiauh_update_dialog() {
|
||||
done
|
||||
}
|
||||
|
||||
function launch_kiauh_v5() {
|
||||
main_menu
|
||||
function check_euid() {
|
||||
if [[ ${EUID} -eq 0 ]]; then
|
||||
echo -e "${red}"
|
||||
top_border
|
||||
echo -e "| !!! THIS SCRIPT MUST NOT RUN AS ROOT !!! |"
|
||||
echo -e "| |"
|
||||
echo -e "| It will ask for credentials as needed. |"
|
||||
bottom_border
|
||||
echo -e "${white}"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
function launch_kiauh_v6() {
|
||||
function check_if_ratos() {
|
||||
if [[ -n $(which ratos) ]]; then
|
||||
echo -e "${red}"
|
||||
top_border
|
||||
echo -e "| !!! RatOS 2.1 or greater detected !!! |"
|
||||
echo -e "| |"
|
||||
echo -e "| KIAUH does currently not support RatOS. |"
|
||||
echo -e "| If you have any questions, please ask for help on the |"
|
||||
echo -e "| RatRig Community Discord: https://discord.gg/ratrig |"
|
||||
bottom_border
|
||||
echo -e "${white}"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
function main() {
|
||||
local entrypoint
|
||||
|
||||
if ! command -v python3 &>/dev/null || [[ $(python3 -V | cut -d " " -f2 | cut -d "." -f2) -lt 8 ]]; then
|
||||
@@ -111,67 +121,10 @@ function launch_kiauh_v6() {
|
||||
export PYTHONPATH="${entrypoint}"
|
||||
|
||||
clear -x
|
||||
python3 "${entrypoint}/kiauh.py"
|
||||
}
|
||||
|
||||
function main() {
|
||||
read_kiauh_ini "${FUNCNAME[0]}"
|
||||
|
||||
if [[ ${version_to_launch} -eq 5 ]]; then
|
||||
launch_kiauh_v5
|
||||
elif [[ ${version_to_launch} -eq 6 ]]; then
|
||||
launch_kiauh_v6
|
||||
else
|
||||
top_border
|
||||
echo -e "| ${green}KIAUH v6.0.0-alpha1 is available now!${white} |"
|
||||
hr
|
||||
echo -e "| View Changelog: ${magenta}https://git.io/JnmlX${white} |"
|
||||
blank_line
|
||||
echo -e "| KIAUH v6 was completely rewritten from the ground up. |"
|
||||
echo -e "| It's based on Python 3.8 and has many improvements. |"
|
||||
blank_line
|
||||
echo -e "| ${yellow}NOTE: Version 6 is still in alpha, so bugs may occur!${white} |"
|
||||
echo -e "| ${yellow}Yet, your feedback and bug reports are very much${white} |"
|
||||
echo -e "| ${yellow}appreciated and will help finalize the release.${white} |"
|
||||
hr
|
||||
echo -e "| Would you like to try out KIAUH v6? |"
|
||||
echo -e "| 1) Yes |"
|
||||
echo -e "| 2) No |"
|
||||
echo -e "| 3) Yes, remember my choice for next time |"
|
||||
echo -e "| 4) No, remember my choice for next time |"
|
||||
quit_footer
|
||||
while true; do
|
||||
read -p "${cyan}###### Select action:${white} " -e input
|
||||
case "${input}" in
|
||||
1)
|
||||
launch_kiauh_v6
|
||||
break;;
|
||||
2)
|
||||
launch_kiauh_v5
|
||||
break;;
|
||||
3)
|
||||
save_startup_version 6
|
||||
launch_kiauh_v6
|
||||
break;;
|
||||
4)
|
||||
save_startup_version 5
|
||||
launch_kiauh_v5
|
||||
break;;
|
||||
Q|q)
|
||||
echo -e "${green}###### Happy printing! ######${white}"; echo
|
||||
exit 0;;
|
||||
*)
|
||||
error_msg "Invalid Input!\n";;
|
||||
esac
|
||||
done && input=""
|
||||
fi
|
||||
python3 "${entrypoint}/kiauh/main.py"
|
||||
}
|
||||
|
||||
check_if_ratos
|
||||
check_euid
|
||||
init_logfile
|
||||
set_globals
|
||||
kiauh_update_dialog
|
||||
read_kiauh_ini
|
||||
init_ini
|
||||
main
|
||||
|
||||
@@ -9,7 +9,6 @@
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
from core.backup_manager import BACKUP_ROOT_DIR
|
||||
from core.constants import SYSTEMD
|
||||
|
||||
# repo
|
||||
@@ -20,7 +19,6 @@ CROWSNEST_SERVICE_NAME = "crowsnest.service"
|
||||
|
||||
# directories
|
||||
CROWSNEST_DIR = Path.home().joinpath("crowsnest")
|
||||
CROWSNEST_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("crowsnest-backups")
|
||||
|
||||
# files
|
||||
CROWSNEST_MULTI_CONFIG = CROWSNEST_DIR.joinpath("tools/.config")
|
||||
|
||||
@@ -15,7 +15,6 @@ from subprocess import CalledProcessError, run
|
||||
from typing import List
|
||||
|
||||
from components.crowsnest import (
|
||||
CROWSNEST_BACKUP_DIR,
|
||||
CROWSNEST_BIN_FILE,
|
||||
CROWSNEST_DIR,
|
||||
CROWSNEST_INSTALL_SCRIPT,
|
||||
@@ -26,8 +25,8 @@ from components.crowsnest import (
|
||||
CROWSNEST_SERVICE_NAME,
|
||||
)
|
||||
from components.klipper.klipper import Klipper
|
||||
from core.backup_manager.backup_manager import BackupManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.settings.kiauh_settings import KiauhSettings
|
||||
from core.types.component_status import ComponentStatus
|
||||
from utils.common import (
|
||||
@@ -127,11 +126,11 @@ def update_crowsnest() -> None:
|
||||
|
||||
settings = KiauhSettings()
|
||||
if settings.kiauh.backup_before_update:
|
||||
bm = BackupManager()
|
||||
bm.backup_directory(
|
||||
CROWSNEST_DIR.name,
|
||||
source=CROWSNEST_DIR,
|
||||
target=CROWSNEST_BACKUP_DIR,
|
||||
svc = BackupService()
|
||||
svc.backup_directory(
|
||||
source_path=CROWSNEST_DIR,
|
||||
target_path="crowsnest",
|
||||
backup_name="crowsnest",
|
||||
)
|
||||
|
||||
git_pull_wrapper(CROWSNEST_DIR)
|
||||
|
||||
@@ -9,8 +9,6 @@
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
from core.backup_manager import BACKUP_ROOT_DIR
|
||||
|
||||
MODULE_PATH = Path(__file__).resolve().parent
|
||||
|
||||
KLIPPER_REPO_URL = "https://github.com/Klipper3d/klipper.git"
|
||||
@@ -27,7 +25,6 @@ KLIPPER_SERVICE_NAME = "klipper.service"
|
||||
KLIPPER_DIR = Path.home().joinpath("klipper")
|
||||
KLIPPER_KCONFIGS_DIR = Path.home().joinpath("klipper-kconfigs")
|
||||
KLIPPER_ENV_DIR = Path.home().joinpath("klippy-env")
|
||||
KLIPPER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("klipper-backups")
|
||||
|
||||
# files
|
||||
KLIPPER_REQ_FILE = KLIPPER_DIR.joinpath("scripts/klippy-requirements.txt")
|
||||
|
||||
@@ -16,7 +16,6 @@ from subprocess import CalledProcessError, run
|
||||
from typing import Dict, List
|
||||
|
||||
from components.klipper import (
|
||||
KLIPPER_BACKUP_DIR,
|
||||
KLIPPER_DIR,
|
||||
KLIPPER_ENV_DIR,
|
||||
KLIPPER_INSTALL_SCRIPT,
|
||||
@@ -31,10 +30,10 @@ from components.webui_client.base_data import BaseWebClient
|
||||
from components.webui_client.client_config.client_config_setup import (
|
||||
create_client_config_symlink,
|
||||
)
|
||||
from core.backup_manager.backup_manager import BackupManager
|
||||
from core.constants import CURRENT_USER
|
||||
from core.instance_manager.base_instance import SUFFIX_BLACKLIST
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
@@ -198,9 +197,17 @@ def create_example_printer_cfg(
|
||||
|
||||
|
||||
def backup_klipper_dir() -> None:
|
||||
bm = BackupManager()
|
||||
bm.backup_directory("klipper", source=KLIPPER_DIR, target=KLIPPER_BACKUP_DIR)
|
||||
bm.backup_directory("klippy-env", source=KLIPPER_ENV_DIR, target=KLIPPER_BACKUP_DIR)
|
||||
svc = BackupService()
|
||||
svc.backup_directory(
|
||||
source_path=KLIPPER_DIR,
|
||||
backup_name="klipper",
|
||||
target_path="klipper",
|
||||
)
|
||||
svc.backup_directory(
|
||||
source_path=KLIPPER_ENV_DIR,
|
||||
backup_name="klippy-env",
|
||||
target_path="klipper",
|
||||
)
|
||||
|
||||
|
||||
def install_klipper_packages() -> None:
|
||||
|
||||
@@ -8,7 +8,6 @@
|
||||
# ======================================================================= #
|
||||
from pathlib import Path
|
||||
|
||||
from core.backup_manager import BACKUP_ROOT_DIR
|
||||
from core.constants import SYSTEMD
|
||||
|
||||
# repo
|
||||
@@ -22,7 +21,6 @@ KLIPPERSCREEN_LOG_NAME = "KlipperScreen.log"
|
||||
# directories
|
||||
KLIPPERSCREEN_DIR = Path.home().joinpath("KlipperScreen")
|
||||
KLIPPERSCREEN_ENV_DIR = Path.home().joinpath(".KlipperScreen-env")
|
||||
KLIPPERSCREEN_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("klipperscreen-backups")
|
||||
|
||||
# files
|
||||
KLIPPERSCREEN_REQ_FILE = KLIPPERSCREEN_DIR.joinpath(
|
||||
|
||||
@@ -13,7 +13,6 @@ from typing import List
|
||||
|
||||
from components.klipper.klipper import Klipper
|
||||
from components.klipperscreen import (
|
||||
KLIPPERSCREEN_BACKUP_DIR,
|
||||
KLIPPERSCREEN_DIR,
|
||||
KLIPPERSCREEN_ENV_DIR,
|
||||
KLIPPERSCREEN_INSTALL_SCRIPT,
|
||||
@@ -25,10 +24,10 @@ from components.klipperscreen import (
|
||||
KLIPPERSCREEN_UPDATER_SECTION_NAME,
|
||||
)
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from core.backup_manager.backup_manager import BackupManager
|
||||
from core.constants import SYSTEMD
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.settings.kiauh_settings import KiauhSettings
|
||||
from core.types.component_status import ComponentStatus
|
||||
from utils.common import (
|
||||
@@ -97,6 +96,7 @@ def install_klipperscreen() -> None:
|
||||
|
||||
|
||||
def patch_klipperscreen_update_manager(instances: List[Moonraker]) -> None:
|
||||
BackupService().backup_moonraker_conf()
|
||||
add_config_section(
|
||||
section=KLIPPERSCREEN_UPDATER_SECTION_NAME,
|
||||
instances=instances,
|
||||
@@ -183,6 +183,7 @@ def remove_klipperscreen() -> None:
|
||||
mr_instances: List[Moonraker] = get_instances(Moonraker)
|
||||
if mr_instances:
|
||||
Logger.print_status("Removing KlipperScreen from update manager ...")
|
||||
BackupService().backup_moonraker_conf()
|
||||
remove_config_section("update_manager KlipperScreen", mr_instances)
|
||||
Logger.print_ok("KlipperScreen successfully removed from update manager!")
|
||||
|
||||
@@ -193,14 +194,14 @@ def remove_klipperscreen() -> None:
|
||||
|
||||
|
||||
def backup_klipperscreen_dir() -> None:
|
||||
bm = BackupManager()
|
||||
bm.backup_directory(
|
||||
KLIPPERSCREEN_DIR.name,
|
||||
source=KLIPPERSCREEN_DIR,
|
||||
target=KLIPPERSCREEN_BACKUP_DIR,
|
||||
svc = BackupService()
|
||||
svc.backup_directory(
|
||||
source_path=KLIPPERSCREEN_DIR,
|
||||
backup_name="KlipperScreen",
|
||||
target_path="KlipperScreen",
|
||||
)
|
||||
bm.backup_directory(
|
||||
KLIPPERSCREEN_ENV_DIR.name,
|
||||
source=KLIPPERSCREEN_ENV_DIR,
|
||||
target=KLIPPERSCREEN_BACKUP_DIR,
|
||||
svc.backup_directory(
|
||||
source_path=KLIPPERSCREEN_ENV_DIR,
|
||||
backup_name="KlipperScreen-env",
|
||||
target_path="KlipperScreen",
|
||||
)
|
||||
|
||||
@@ -9,8 +9,6 @@
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
from core.backup_manager import BACKUP_ROOT_DIR
|
||||
|
||||
MODULE_PATH = Path(__file__).resolve().parent
|
||||
|
||||
MOONRAKER_REPO_URL = "https://github.com/Arksine/moonraker.git"
|
||||
@@ -25,8 +23,6 @@ MOONRAKER_ENV_FILE_NAME = "moonraker.env"
|
||||
# directories
|
||||
MOONRAKER_DIR = Path.home().joinpath("moonraker")
|
||||
MOONRAKER_ENV_DIR = Path.home().joinpath("moonraker-env")
|
||||
MOONRAKER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("moonraker-backups")
|
||||
MOONRAKER_DB_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("moonraker-db-backups")
|
||||
|
||||
# files
|
||||
MOONRAKER_INSTALL_SCRIPT = MOONRAKER_DIR.joinpath("scripts/install-moonraker.sh")
|
||||
|
||||
@@ -61,6 +61,9 @@ class SysDepsParser:
|
||||
version = distro_info.get("distro_version")
|
||||
if version:
|
||||
self.distro_version = _convert_version(version)
|
||||
self.vendor: str = ""
|
||||
if pathlib.Path("/etc/rpi-issue").is_file():
|
||||
self.vendor = "raspberry-pi"
|
||||
|
||||
def _parse_spec(self, full_spec: str) -> str | None:
|
||||
parts = full_spec.split(";", maxsplit=1)
|
||||
@@ -109,6 +112,9 @@ class SysDepsParser:
|
||||
elif req_var == "distro_id":
|
||||
left_op: str | Tuple[int | str, ...] = self.distro_id
|
||||
right_op = dep_parts[2].strip().strip("\"'")
|
||||
elif req_var == "vendor":
|
||||
left_op = self.vendor
|
||||
right_op = dep_parts[2].strip().strip("\"'")
|
||||
elif req_var == "distro_version":
|
||||
if not self.distro_version:
|
||||
logging.info(
|
||||
|
||||
@@ -14,8 +14,6 @@ from typing import Dict, List, Optional
|
||||
|
||||
from components.moonraker import (
|
||||
MODULE_PATH,
|
||||
MOONRAKER_BACKUP_DIR,
|
||||
MOONRAKER_DB_BACKUP_DIR,
|
||||
MOONRAKER_DEFAULT_PORT,
|
||||
MOONRAKER_DEPS_JSON_FILE,
|
||||
MOONRAKER_DIR,
|
||||
@@ -25,8 +23,8 @@ from components.moonraker import (
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from components.moonraker.utils.sysdeps_parser import SysDepsParser
|
||||
from components.webui_client.base_data import BaseWebClient
|
||||
from core.backup_manager.backup_manager import BackupManager
|
||||
from core.logger import Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
@@ -126,7 +124,7 @@ def create_example_moonraker_conf(
|
||||
scp.read_file(target)
|
||||
trusted_clients: List[str] = [
|
||||
f" {'.'.join(ip)}\n",
|
||||
*scp.getval("authorization", "trusted_clients"),
|
||||
*scp.getvals("authorization", "trusted_clients"),
|
||||
]
|
||||
|
||||
scp.set_option("server", "port", str(port))
|
||||
@@ -168,21 +166,55 @@ def create_example_moonraker_conf(
|
||||
|
||||
|
||||
def backup_moonraker_dir() -> None:
|
||||
bm = BackupManager()
|
||||
bm.backup_directory("moonraker", source=MOONRAKER_DIR, target=MOONRAKER_BACKUP_DIR)
|
||||
bm.backup_directory(
|
||||
"moonraker-env", source=MOONRAKER_ENV_DIR, target=MOONRAKER_BACKUP_DIR
|
||||
svc = BackupService()
|
||||
svc.backup_directory(
|
||||
source_path=MOONRAKER_DIR, backup_name="moonraker", target_path="moonraker"
|
||||
)
|
||||
svc.backup_directory(
|
||||
source_path=MOONRAKER_ENV_DIR,
|
||||
backup_name="moonraker-env",
|
||||
target_path="moonraker",
|
||||
)
|
||||
|
||||
|
||||
def backup_moonraker_db_dir() -> None:
|
||||
instances: List[Moonraker] = get_instances(Moonraker)
|
||||
bm = BackupManager()
|
||||
svc = BackupService()
|
||||
|
||||
if not instances:
|
||||
# fallback: search for printer data directories in the user's home directory
|
||||
Logger.print_info("No Moonraker instances found via systemd services.")
|
||||
Logger.print_info(
|
||||
"Attempting to find printer data directories in home directory..."
|
||||
)
|
||||
|
||||
home_dir = Path.home()
|
||||
printer_data_dirs = []
|
||||
|
||||
for pattern in ["printer_data", "printer_*_data"]:
|
||||
for data_dir in home_dir.glob(pattern):
|
||||
if data_dir.is_dir():
|
||||
printer_data_dirs.append(data_dir)
|
||||
|
||||
if not printer_data_dirs:
|
||||
Logger.print_info("Unable to find directory to backup!")
|
||||
Logger.print_info("No printer data directories found in home directory.")
|
||||
return
|
||||
|
||||
for data_dir in printer_data_dirs:
|
||||
svc.backup_directory(
|
||||
source_path=data_dir.joinpath("database"),
|
||||
target_path=data_dir.name,
|
||||
backup_name="database",
|
||||
)
|
||||
|
||||
return
|
||||
|
||||
for instance in instances:
|
||||
name = f"database-{instance.data_dir.name}"
|
||||
bm.backup_directory(
|
||||
name, source=instance.db_dir, target=MOONRAKER_DB_BACKUP_DIR
|
||||
svc.backup_directory(
|
||||
source_path=instance.db_dir,
|
||||
target_path=f"{instance.data_dir.name}",
|
||||
backup_name="database",
|
||||
)
|
||||
|
||||
|
||||
|
||||
@@ -34,7 +34,6 @@ class BaseWebClient(ABC):
|
||||
display_name: str
|
||||
client_dir: Path
|
||||
config_file: Path
|
||||
backup_dir: Path
|
||||
repo_path: str
|
||||
download_url: str
|
||||
nginx_config: Path
|
||||
@@ -52,6 +51,5 @@ class BaseWebClientConfig(ABC):
|
||||
display_name: str
|
||||
config_filename: str
|
||||
config_dir: Path
|
||||
backup_dir: Path
|
||||
repo_url: str
|
||||
config_section: str
|
||||
|
||||
@@ -14,6 +14,7 @@ from components.klipper.klipper import Klipper
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from components.webui_client.base_data import BaseWebClientConfig
|
||||
from core.logger import Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.services.message_service import Message
|
||||
from core.types.color import Color
|
||||
from utils.config_utils import remove_config_section
|
||||
@@ -35,6 +36,8 @@ def run_client_config_removal(
|
||||
if run_remove_routines(client_config.config_dir):
|
||||
completion_msg.text.append(f"● {client_config.display_name} removed")
|
||||
|
||||
BackupService().backup_printer_config_dir()
|
||||
|
||||
completion_msg = remove_moonraker_config_section(
|
||||
completion_msg, client_config, mr_instances
|
||||
)
|
||||
|
||||
@@ -25,8 +25,8 @@ from components.webui_client.client_utils import (
|
||||
)
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.settings.kiauh_settings import KiauhSettings
|
||||
from utils.common import backup_printer_config_dir
|
||||
from utils.config_utils import add_config_section, add_config_section_at_top
|
||||
from utils.fs_utils import create_symlink
|
||||
from utils.git_utils import git_clone_wrapper, git_pull_wrapper
|
||||
@@ -57,7 +57,7 @@ def install_client_config(client_data: BaseWebClient, cfg_backup=True) -> None:
|
||||
create_client_config_symlink(client_config, kl_instances)
|
||||
|
||||
if cfg_backup:
|
||||
backup_printer_config_dir()
|
||||
BackupService().backup_printer_config_dir()
|
||||
|
||||
add_config_section(
|
||||
section=f"update_manager {client_config.name}",
|
||||
|
||||
@@ -16,9 +16,9 @@ from components.webui_client.base_data import (
|
||||
from components.webui_client.client_config.client_config_remove import (
|
||||
run_client_config_removal,
|
||||
)
|
||||
from core.backup_manager.backup_manager import BackupManager
|
||||
from core.constants import NGINX_SITES_AVAILABLE, NGINX_SITES_ENABLED
|
||||
from core.logger import Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.services.message_service import Message
|
||||
from core.types.color import Color
|
||||
from utils.config_utils import remove_config_section
|
||||
@@ -43,8 +43,19 @@ def run_client_removal(
|
||||
kl_instances: List[Klipper] = get_instances(Klipper)
|
||||
|
||||
if backup_config:
|
||||
bm = BackupManager()
|
||||
if bm.backup_file(client.config_file):
|
||||
version = ""
|
||||
src = client.client_dir
|
||||
if src.joinpath(".version").exists():
|
||||
with open(src.joinpath(".version"), "r") as v:
|
||||
version = v.readlines()[0]
|
||||
|
||||
svc = BackupService()
|
||||
target_path = svc.backup_root.joinpath(f"{client.client_dir.name}_{version}")
|
||||
success = svc.backup_file(
|
||||
source_path=client.config_file,
|
||||
target_path=target_path,
|
||||
)
|
||||
if success:
|
||||
completion_msg.text.append(f"● {client.config_file.name} backup created")
|
||||
|
||||
if remove_client:
|
||||
@@ -56,6 +67,7 @@ def run_client_removal(
|
||||
if remove_client_nginx_logs(client, kl_instances):
|
||||
completion_msg.text.append("● NGINX logs removed")
|
||||
|
||||
BackupService().backup_moonraker_conf()
|
||||
section = f"update_manager {client_name}"
|
||||
handled_instances: List[Moonraker] = remove_config_section(
|
||||
section, mr_instances
|
||||
|
||||
@@ -37,9 +37,10 @@ from components.webui_client.client_utils import (
|
||||
)
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.settings.kiauh_settings import KiauhSettings
|
||||
from core.types.color import Color
|
||||
from utils.common import backup_printer_config_dir, check_install_dependencies
|
||||
from utils.common import check_install_dependencies
|
||||
from utils.config_utils import add_config_section
|
||||
from utils.fs_utils import unzip
|
||||
from utils.input_utils import get_confirm
|
||||
@@ -97,11 +98,12 @@ def install_client(
|
||||
if enable_remotemode and client.client == WebClientType.MAINSAIL:
|
||||
enable_mainsail_remotemode()
|
||||
|
||||
backup_printer_config_dir()
|
||||
BackupService().backup_printer_config_dir()
|
||||
add_config_section(
|
||||
section=f"update_manager {client.name}",
|
||||
instances=mr_instances,
|
||||
options=[
|
||||
("persistent_files", ["config.json"]),
|
||||
("type", "web"),
|
||||
("channel", "stable"),
|
||||
("repo", str(client.repo_path)),
|
||||
|
||||
@@ -24,13 +24,13 @@ from components.webui_client.base_data import (
|
||||
from components.webui_client.client_dialogs import print_client_port_select_dialog
|
||||
from components.webui_client.fluidd_data import FluiddData
|
||||
from components.webui_client.mainsail_data import MainsailData
|
||||
from core.backup_manager.backup_manager import BackupManager
|
||||
from core.constants import (
|
||||
NGINX_CONFD,
|
||||
NGINX_SITES_AVAILABLE,
|
||||
NGINX_SITES_ENABLED,
|
||||
)
|
||||
from core.logger import Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.settings.kiauh_settings import KiauhSettings, WebUiSettings
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
@@ -119,7 +119,7 @@ def enable_mainsail_remotemode() -> None:
|
||||
with open(c_json, "r") as f:
|
||||
config_data = json.load(f)
|
||||
|
||||
if config_data["instancesDB"] == "browser":
|
||||
if config_data["instancesDB"] == "browser" or config_data["instancesDB"] == "json":
|
||||
Logger.print_info("Remote mode already configured. Skipped ...")
|
||||
return
|
||||
|
||||
@@ -175,26 +175,39 @@ def get_remote_client_version(client: BaseWebClient) -> str | None:
|
||||
|
||||
|
||||
def backup_client_data(client: BaseWebClient) -> None:
|
||||
name = client.name
|
||||
version = ""
|
||||
src = client.client_dir
|
||||
dest = client.backup_dir
|
||||
|
||||
if src.joinpath(".version").exists():
|
||||
with open(src.joinpath(".version"), "r") as v:
|
||||
version = v.readlines()[0]
|
||||
|
||||
bm = BackupManager()
|
||||
bm.backup_directory(f"{name}-{version}", src, dest)
|
||||
bm.backup_file(client.config_file, dest)
|
||||
bm.backup_file(NGINX_SITES_AVAILABLE.joinpath(name), dest)
|
||||
svc = BackupService()
|
||||
target_path = svc.backup_root.joinpath(f"{client.client_dir.name}_{version}")
|
||||
svc.backup_directory(
|
||||
source_path=client.client_dir,
|
||||
target_path=target_path,
|
||||
backup_name=client.name,
|
||||
)
|
||||
svc.backup_file(
|
||||
source_path=client.config_file,
|
||||
target_path=target_path,
|
||||
)
|
||||
|
||||
|
||||
def backup_client_config_data(client: BaseWebClient) -> None:
|
||||
client_config = client.client_config
|
||||
name = client_config.name
|
||||
source = client_config.config_dir
|
||||
target = client_config.backup_dir
|
||||
bm = BackupManager()
|
||||
bm.backup_directory(name, source, target)
|
||||
version = ""
|
||||
src = client.client_dir
|
||||
if src.joinpath(".version").exists():
|
||||
with open(src.joinpath(".version"), "r") as v:
|
||||
version = v.readlines()[0]
|
||||
|
||||
svc = BackupService()
|
||||
target_path = svc.backup_root.joinpath(f"{client.client_dir.name}_{version}")
|
||||
svc.backup_directory(
|
||||
source_path=client.client_config.config_dir,
|
||||
target_path=target_path,
|
||||
backup_name=client.client_config.name,
|
||||
)
|
||||
|
||||
|
||||
def get_existing_clients() -> List[BaseWebClient]:
|
||||
|
||||
@@ -18,7 +18,6 @@ from components.webui_client.base_data import (
|
||||
WebClientConfigType,
|
||||
WebClientType,
|
||||
)
|
||||
from core.backup_manager import BACKUP_ROOT_DIR
|
||||
from core.constants import NGINX_SITES_AVAILABLE
|
||||
|
||||
|
||||
@@ -30,7 +29,6 @@ class FluiddConfigWeb(BaseWebClientConfig):
|
||||
config_dir: Path = Path.home().joinpath("fluidd-config")
|
||||
config_filename: str = "fluidd.cfg"
|
||||
config_section: str = f"include {config_filename}"
|
||||
backup_dir: Path = BACKUP_ROOT_DIR.joinpath("fluidd-config-backups")
|
||||
repo_url: str = "https://github.com/fluidd-core/fluidd-config.git"
|
||||
|
||||
|
||||
@@ -43,7 +41,6 @@ class FluiddData(BaseWebClient):
|
||||
display_name: str = name.capitalize()
|
||||
client_dir: Path = Path.home().joinpath("fluidd")
|
||||
config_file: Path = client_dir.joinpath("config.json")
|
||||
backup_dir: Path = BACKUP_ROOT_DIR.joinpath("fluidd-backups")
|
||||
repo_path: str = "fluidd-core/fluidd"
|
||||
nginx_config: Path = NGINX_SITES_AVAILABLE.joinpath("fluidd")
|
||||
nginx_access_log: Path = Path("/var/log/nginx/fluidd-access.log")
|
||||
|
||||
@@ -18,7 +18,6 @@ from components.webui_client.base_data import (
|
||||
WebClientConfigType,
|
||||
WebClientType,
|
||||
)
|
||||
from core.backup_manager import BACKUP_ROOT_DIR
|
||||
from core.constants import NGINX_SITES_AVAILABLE
|
||||
|
||||
|
||||
@@ -30,7 +29,6 @@ class MainsailConfigWeb(BaseWebClientConfig):
|
||||
config_dir: Path = Path.home().joinpath("mainsail-config")
|
||||
config_filename: str = "mainsail.cfg"
|
||||
config_section: str = f"include {config_filename}"
|
||||
backup_dir: Path = BACKUP_ROOT_DIR.joinpath("mainsail-config-backups")
|
||||
repo_url: str = "https://github.com/mainsail-crew/mainsail-config.git"
|
||||
|
||||
|
||||
@@ -43,7 +41,6 @@ class MainsailData(BaseWebClient):
|
||||
display_name: str = name.capitalize()
|
||||
client_dir: Path = Path.home().joinpath("mainsail")
|
||||
config_file: Path = client_dir.joinpath("config.json")
|
||||
backup_dir: Path = BACKUP_ROOT_DIR.joinpath("mainsail-backups")
|
||||
repo_path: str = "mainsail-crew/mainsail"
|
||||
nginx_config: Path = NGINX_SITES_AVAILABLE.joinpath("mainsail")
|
||||
nginx_access_log: Path = Path("/var/log/nginx/mainsail-access.log")
|
||||
|
||||
@@ -1,108 +0,0 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
from __future__ import annotations
|
||||
|
||||
import shutil
|
||||
from pathlib import Path
|
||||
from typing import List
|
||||
|
||||
from core.backup_manager import BACKUP_ROOT_DIR
|
||||
from core.logger import Logger
|
||||
from utils.common import get_current_date
|
||||
|
||||
|
||||
class BackupManagerException(Exception):
|
||||
pass
|
||||
|
||||
|
||||
# noinspection PyUnusedLocal
|
||||
# noinspection PyMethodMayBeStatic
|
||||
class BackupManager:
|
||||
def __init__(self, backup_root_dir: Path = BACKUP_ROOT_DIR):
|
||||
self._backup_root_dir: Path = backup_root_dir
|
||||
self._ignore_folders: List[str] = []
|
||||
|
||||
@property
|
||||
def backup_root_dir(self) -> Path:
|
||||
return self._backup_root_dir
|
||||
|
||||
@backup_root_dir.setter
|
||||
def backup_root_dir(self, value: Path):
|
||||
self._backup_root_dir = value
|
||||
|
||||
@property
|
||||
def ignore_folders(self) -> List[str]:
|
||||
return self._ignore_folders
|
||||
|
||||
@ignore_folders.setter
|
||||
def ignore_folders(self, value: List[str]):
|
||||
self._ignore_folders = value
|
||||
|
||||
def backup_file(
|
||||
self, file: Path, target: Path | None = None, custom_filename=None
|
||||
) -> bool:
|
||||
Logger.print_status(f"Creating backup of {file} ...")
|
||||
|
||||
if not file.exists():
|
||||
Logger.print_info("File does not exist! Skipping ...")
|
||||
return False
|
||||
|
||||
target = self.backup_root_dir if target is None else target
|
||||
|
||||
if Path(file).is_file():
|
||||
date = get_current_date().get("date")
|
||||
time = get_current_date().get("time")
|
||||
filename = f"{file.stem}-{date}-{time}{file.suffix}"
|
||||
filename = custom_filename if custom_filename is not None else filename
|
||||
try:
|
||||
Path(target).mkdir(exist_ok=True)
|
||||
shutil.copyfile(file, target.joinpath(filename))
|
||||
Logger.print_ok("Backup successful!")
|
||||
return True
|
||||
except OSError as e:
|
||||
Logger.print_error(f"Unable to backup '{file}':\n{e}")
|
||||
return False
|
||||
else:
|
||||
Logger.print_info(f"File '{file}' not found ...")
|
||||
return False
|
||||
|
||||
def backup_directory(
|
||||
self, name: str, source: Path, target: Path | None = None
|
||||
) -> Path | None:
|
||||
Logger.print_status(f"Creating backup of {name} in {target} ...")
|
||||
|
||||
if source is None or not Path(source).exists():
|
||||
Logger.print_info("Source directory does not exist! Skipping ...")
|
||||
return None
|
||||
|
||||
target = self.backup_root_dir if target is None else target
|
||||
try:
|
||||
date = get_current_date().get("date")
|
||||
time = get_current_date().get("time")
|
||||
backup_target = target.joinpath(f"{name.lower()}-{date}-{time}")
|
||||
shutil.copytree(
|
||||
source,
|
||||
backup_target,
|
||||
ignore=self.ignore_folders_func,
|
||||
ignore_dangling_symlinks=True,
|
||||
)
|
||||
Logger.print_ok("Backup successful!")
|
||||
|
||||
return backup_target
|
||||
|
||||
except OSError as e:
|
||||
Logger.print_error(f"Unable to backup directory '{source}':\n{e}")
|
||||
raise BackupManagerException(f"Unable to backup directory '{source}':\n{e}")
|
||||
|
||||
def ignore_folders_func(self, dirpath, filenames) -> List[str]:
|
||||
return (
|
||||
[f for f in filenames if f in self._ignore_folders]
|
||||
if self._ignore_folders
|
||||
else []
|
||||
)
|
||||
@@ -11,8 +11,6 @@ import os
|
||||
import pwd
|
||||
from pathlib import Path
|
||||
|
||||
from core.backup_manager import BACKUP_ROOT_DIR
|
||||
|
||||
# global dependencies
|
||||
GLOBAL_DEPS = ["git", "wget", "curl", "unzip", "dfu-util", "python3-virtualenv"]
|
||||
|
||||
@@ -24,7 +22,6 @@ CURRENT_USER = pwd.getpwuid(os.getuid())[0]
|
||||
|
||||
# dirs
|
||||
SYSTEMD = Path("/etc/systemd/system")
|
||||
PRINTER_DATA_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("printer-data-backups")
|
||||
NGINX_SITES_AVAILABLE = Path("/etc/nginx/sites-available")
|
||||
NGINX_SITES_ENABLED = Path("/etc/nginx/sites-enabled")
|
||||
NGINX_CONFD = Path("/etc/nginx/conf.d")
|
||||
|
||||
@@ -16,8 +16,9 @@ from typing import List
|
||||
|
||||
from utils.fs_utils import get_data_dir
|
||||
|
||||
SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion"]
|
||||
|
||||
# suffixes that are not allowed to be used for instances
|
||||
# because they would cause conflicts with other components or are reserved
|
||||
SUFFIX_BLACKLIST: List[str] = ["None", "mcu", "obico", "bambu", "companion", "hmi"]
|
||||
|
||||
@dataclass(repr=True)
|
||||
class BaseInstance:
|
||||
|
||||
@@ -25,8 +25,8 @@ from components.webui_client.fluidd_data import FluiddData
|
||||
from components.webui_client.mainsail_data import MainsailData
|
||||
from core.menus import Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.services.backup_service import BackupService
|
||||
from core.types.color import Color
|
||||
from utils.common import backup_printer_config_dir
|
||||
|
||||
|
||||
# noinspection PyUnusedLocal
|
||||
@@ -86,7 +86,7 @@ class BackupMenu(BaseMenu):
|
||||
backup_moonraker_dir()
|
||||
|
||||
def backup_printer_config(self, **kwargs) -> None:
|
||||
backup_printer_config_dir()
|
||||
BackupService().backup_printer_config_dir()
|
||||
|
||||
def backup_moonraker_db(self, **kwargs) -> None:
|
||||
backup_moonraker_db_dir()
|
||||
|
||||
@@ -10,14 +10,17 @@ from __future__ import annotations
|
||||
|
||||
from typing import List, Literal, Type
|
||||
|
||||
from core.logger import Logger
|
||||
from core.logger import Logger, DialogType
|
||||
from core.menus import Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.settings.kiauh_settings import KiauhSettings, Repository
|
||||
from core.types.color import Color
|
||||
from procedures.switch_repo import run_switch_repo_routine
|
||||
from utils.input_utils import get_string_input, get_number_input, get_confirm
|
||||
|
||||
|
||||
# noinspection PyUnusedLocal
|
||||
# noinspection PyMethodMayBeStatic
|
||||
class RepoSelectMenu(BaseMenu):
|
||||
def __init__(
|
||||
self,
|
||||
@@ -48,26 +51,27 @@ class RepoSelectMenu(BaseMenu):
|
||||
|
||||
def set_options(self) -> None:
|
||||
self.options = {}
|
||||
|
||||
if not self.repos:
|
||||
return
|
||||
|
||||
if self.repos:
|
||||
for idx, repo in enumerate(self.repos, start=1):
|
||||
self.options[str(idx)] = Option(
|
||||
method=self.select_repository, opt_data=repo
|
||||
)
|
||||
self.options["a"] = Option(method=self.add_repository)
|
||||
self.options["r"] = Option(method=self.remove_repository)
|
||||
self.options["b"] = Option(method=self.go_back)
|
||||
|
||||
def print_menu(self) -> None:
|
||||
menu = "╟───────────────────────────────────────────────────────╢\n"
|
||||
menu += "║ Available Repositories: ║\n"
|
||||
menu += "╟───────────────────────────────────────────────────────╢\n"
|
||||
|
||||
for idx, repo in enumerate(self.repos, start=1):
|
||||
url = f"● Repo: {repo.url.replace('.git', '')}"
|
||||
branch = f"└► Branch: {repo.branch}"
|
||||
menu += f"║ {idx}) {Color.apply(url, Color.CYAN):<59} ║\n"
|
||||
menu += f"║ {Color.apply(branch, Color.CYAN):<59} ║\n"
|
||||
|
||||
menu += "╟───────────────────────────────────────────────────────╢\n"
|
||||
menu += "║ A) Add repository ║\n"
|
||||
menu += "║ R) Remove repository ║\n"
|
||||
menu += "╟───────────────────────────────────────────────────────╢\n"
|
||||
print(menu, end="")
|
||||
|
||||
@@ -77,3 +81,82 @@ class RepoSelectMenu(BaseMenu):
|
||||
f"Switching to {self.name.capitalize()}'s new source repository ..."
|
||||
)
|
||||
run_switch_repo_routine(self.name, repo.url, repo.branch)
|
||||
|
||||
def add_repository(self, **kwargs) -> None:
|
||||
while True:
|
||||
Logger.print_dialog(
|
||||
DialogType.CUSTOM,
|
||||
custom_title="Enter the repository URL",
|
||||
content=[
|
||||
"NOTE: There is no input validation in place, "
|
||||
"please check your input for correctness",
|
||||
],
|
||||
)
|
||||
url = get_string_input("Repository URL", allow_special_chars=True).strip()
|
||||
|
||||
Logger.print_dialog(
|
||||
DialogType.CUSTOM,
|
||||
custom_title="Enter the branch name",
|
||||
content=[ "Press Enter to use the default branch (master)." ],
|
||||
center_content=False,
|
||||
)
|
||||
branch = get_string_input("Branch", allow_special_chars=True, default="master").strip()
|
||||
Logger.print_dialog(
|
||||
DialogType.CUSTOM,
|
||||
custom_title="Summary",
|
||||
content=[
|
||||
f"● URL: {url}",
|
||||
f"● Branch: {branch}",
|
||||
],
|
||||
)
|
||||
confirm = get_confirm("Save repository")
|
||||
if confirm:
|
||||
repo = Repository(url, branch)
|
||||
if self.name == "klipper":
|
||||
self.settings.klipper.repositories.append(repo)
|
||||
self.settings.save()
|
||||
self.repos = self.settings.klipper.repositories
|
||||
else:
|
||||
self.settings.moonraker.repositories.append(repo)
|
||||
self.settings.save()
|
||||
self.repos = self.settings.moonraker.repositories
|
||||
Logger.print_ok("Repository added and saved.")
|
||||
|
||||
# Refresh menu to show new repo immediately and update options
|
||||
self.set_options()
|
||||
self.run()
|
||||
break
|
||||
else:
|
||||
Logger.print_info("Operation cancelled by user.")
|
||||
break
|
||||
|
||||
def remove_repository(self, **kwargs) -> None:
|
||||
repos = self.repos
|
||||
if not repos:
|
||||
Logger.print_info("No repositories configured.")
|
||||
return
|
||||
repo_lines = [f"{idx}) {repo.url} [{repo.branch}]" for idx, repo in enumerate(repos, start=1)]
|
||||
Logger.print_dialog(
|
||||
DialogType.CUSTOM,
|
||||
custom_title="Available Repositories",
|
||||
content=[*repo_lines],
|
||||
)
|
||||
idx = get_number_input("Select the repository to remove", 1, len(repos))
|
||||
removed = repos.pop(idx - 1)
|
||||
if self.name == "klipper":
|
||||
self.settings.klipper.repositories = repos
|
||||
self.settings.save()
|
||||
self.repos = self.settings.klipper.repositories
|
||||
else:
|
||||
self.settings.moonraker.repositories = repos
|
||||
self.settings.save()
|
||||
self.repos = self.settings.moonraker.repositories
|
||||
Logger.print_ok(f"Removed repository: {removed.url} [{removed.branch}]")
|
||||
|
||||
# Refresh menu to show updated repo list and options
|
||||
self.set_options()
|
||||
self.run()
|
||||
|
||||
def go_back(self, **kwargs) -> None:
|
||||
from core.menus.settings_menu import SettingsMenu
|
||||
SettingsMenu().run()
|
||||
|
||||
@@ -117,20 +117,12 @@ class SettingsMenu(BaseMenu):
|
||||
)
|
||||
|
||||
def switch_klipper_repo(self, **kwargs) -> None:
|
||||
name = "Klipper"
|
||||
repos = self.settings.klipper.repositories
|
||||
if not repos:
|
||||
self._warn_no_repos(name)
|
||||
return
|
||||
RepoSelectMenu(name.lower(), repos=repos, previous_menu=self.__class__).run()
|
||||
RepoSelectMenu("klipper", repos=repos, previous_menu=self.__class__).run()
|
||||
|
||||
def switch_moonraker_repo(self, **kwargs) -> None:
|
||||
name = "Moonraker"
|
||||
repos = self.settings.moonraker.repositories
|
||||
if not repos:
|
||||
self._warn_no_repos(name)
|
||||
return
|
||||
RepoSelectMenu(name.lower(), repos=repos, previous_menu=self.__class__).run()
|
||||
RepoSelectMenu("moonraker", repos=repos, previous_menu=self.__class__).run()
|
||||
|
||||
def toggle_mainsail_release(self, **kwargs) -> None:
|
||||
self.mainsail_unstable = not self.mainsail_unstable
|
||||
|
||||
189
kiauh/core/services/backup_service.py
Normal file
189
kiauh/core/services/backup_service.py
Normal file
@@ -0,0 +1,189 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
from __future__ import annotations
|
||||
|
||||
import shutil
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
from typing import List, Optional
|
||||
|
||||
from components.klipper.klipper import Klipper
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from core.logger import Logger
|
||||
from utils.instance_utils import get_instances
|
||||
|
||||
|
||||
class BackupService:
|
||||
def __init__(self):
|
||||
self._backup_root = Path.home().joinpath("kiauh_backups")
|
||||
|
||||
@property
|
||||
def backup_root(self) -> Path:
|
||||
return self._backup_root
|
||||
|
||||
@property
|
||||
def timestamp(self) -> str:
|
||||
return datetime.now().strftime("%Y%m%d-%H%M%S")
|
||||
|
||||
################################################
|
||||
# GENERIC BACKUP METHODS
|
||||
################################################
|
||||
|
||||
def backup_file(
|
||||
self,
|
||||
source_path: Path,
|
||||
target_path: Optional[Path | str] = None,
|
||||
target_name: Optional[str] = None,
|
||||
) -> bool:
|
||||
source_path = Path(source_path)
|
||||
|
||||
Logger.print_status(f"Creating backup of {source_path} ...")
|
||||
|
||||
if not source_path.exists():
|
||||
Logger.print_info(
|
||||
f"File '{source_path}' does not exist! Skipping backup..."
|
||||
)
|
||||
return False
|
||||
|
||||
if not source_path.is_file():
|
||||
Logger.print_info(f"'{source_path}' is not a file! Skipping backup...")
|
||||
return False
|
||||
|
||||
try:
|
||||
self._backup_root.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
filename = (
|
||||
target_name
|
||||
or f"{source_path.stem}_{self.timestamp}{source_path.suffix}"
|
||||
)
|
||||
if target_path is not None:
|
||||
backup_path = self._backup_root.joinpath(target_path, filename)
|
||||
else:
|
||||
backup_path = self._backup_root.joinpath(filename)
|
||||
|
||||
backup_path.mkdir(parents=True, exist_ok=True)
|
||||
shutil.copy2(source_path, backup_path)
|
||||
|
||||
Logger.print_ok(
|
||||
f"Successfully backed up '{source_path}' to '{backup_path}'"
|
||||
)
|
||||
return True
|
||||
|
||||
except Exception as e:
|
||||
Logger.print_error(f"Failed to backup '{source_path}': {e}")
|
||||
return False
|
||||
|
||||
def backup_directory(
|
||||
self,
|
||||
source_path: Path,
|
||||
backup_name: str,
|
||||
target_path: Optional[Path | str] = None,
|
||||
) -> Optional[Path]:
|
||||
source_path = Path(source_path)
|
||||
|
||||
Logger.print_status(f"Creating backup of {source_path} ...")
|
||||
|
||||
if not source_path.exists():
|
||||
Logger.print_info(
|
||||
f"Directory '{source_path}' does not exist! Skipping backup..."
|
||||
)
|
||||
return None
|
||||
|
||||
if not source_path.is_dir():
|
||||
Logger.print_info(f"'{source_path}' is not a directory! Skipping backup...")
|
||||
return None
|
||||
|
||||
try:
|
||||
self._backup_root.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
backup_dir_name = f"{backup_name}_{self.timestamp}"
|
||||
|
||||
if target_path is not None:
|
||||
backup_path = self._backup_root.joinpath(target_path, backup_dir_name)
|
||||
else:
|
||||
backup_path = self._backup_root.joinpath(backup_dir_name)
|
||||
|
||||
shutil.copytree(source_path, backup_path)
|
||||
|
||||
Logger.print_ok(
|
||||
f"Successfully backed up '{source_path}' to '{backup_path}'"
|
||||
)
|
||||
return backup_path
|
||||
|
||||
except Exception as e:
|
||||
Logger.print_error(f"Failed to backup directory '{source_path}': {e}")
|
||||
return None
|
||||
|
||||
################################################
|
||||
# SPECIFIC BACKUP METHODS
|
||||
################################################
|
||||
|
||||
def backup_printer_cfg(self):
|
||||
klipper_instances: List[Klipper] = get_instances(Klipper)
|
||||
for instance in klipper_instances:
|
||||
target_path: Path = self._backup_root.joinpath(
|
||||
instance.data_dir.name, f"config_{self.timestamp}"
|
||||
)
|
||||
self.backup_file(
|
||||
source_path=instance.cfg_file,
|
||||
target_path=target_path,
|
||||
target_name=instance.cfg_file.name,
|
||||
)
|
||||
|
||||
def backup_moonraker_conf(self):
|
||||
moonraker_instances: List[Moonraker] = get_instances(Moonraker)
|
||||
for instance in moonraker_instances:
|
||||
target_path: Path = self._backup_root.joinpath(
|
||||
instance.data_dir.name, f"config_{self.timestamp}"
|
||||
)
|
||||
self.backup_file(
|
||||
source_path=instance.cfg_file,
|
||||
target_path=target_path,
|
||||
target_name=instance.cfg_file.name,
|
||||
)
|
||||
|
||||
def backup_printer_config_dir(self) -> None:
|
||||
instances: List[Klipper] = get_instances(Klipper)
|
||||
if not instances:
|
||||
# fallback: search for printer data directories in the user's home directory
|
||||
Logger.print_info("No Klipper instances found via systemd services.")
|
||||
Logger.print_info(
|
||||
"Attempting to find printer data directories in home directory..."
|
||||
)
|
||||
|
||||
home_dir = Path.home()
|
||||
printer_data_dirs = []
|
||||
|
||||
for pattern in ["printer_data", "printer_*_data"]:
|
||||
for data_dir in home_dir.glob(pattern):
|
||||
if data_dir.is_dir():
|
||||
printer_data_dirs.append(data_dir)
|
||||
|
||||
if not printer_data_dirs:
|
||||
Logger.print_info("Unable to find directory to backup!")
|
||||
Logger.print_info(
|
||||
"No printer data directories found in home directory."
|
||||
)
|
||||
return
|
||||
|
||||
for data_dir in printer_data_dirs:
|
||||
self.backup_directory(
|
||||
source_path=data_dir.joinpath("config"),
|
||||
target_path=data_dir.name,
|
||||
backup_name="config",
|
||||
)
|
||||
|
||||
return
|
||||
|
||||
for instance in instances:
|
||||
self.backup_directory(
|
||||
source_path=instance.base.cfg_dir,
|
||||
target_path=f"{instance.data_dir.name}",
|
||||
backup_name="config",
|
||||
)
|
||||
@@ -8,14 +8,15 @@
|
||||
# ======================================================================= #
|
||||
from __future__ import annotations
|
||||
|
||||
import shutil
|
||||
from dataclasses import dataclass, field
|
||||
from typing import Any, List
|
||||
from typing import Any, Callable, List, TypeVar
|
||||
|
||||
from core.backup_manager.backup_manager import BackupManager
|
||||
from components.klipper import KLIPPER_REPO_URL
|
||||
from components.moonraker import MOONRAKER_REPO_URL
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
NoOptionError,
|
||||
NoSectionError,
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from utils.input_utils import get_confirm
|
||||
@@ -26,13 +27,7 @@ from kiauh import PROJECT_ROOT
|
||||
DEFAULT_CFG = PROJECT_ROOT.joinpath("default.kiauh.cfg")
|
||||
CUSTOM_CFG = PROJECT_ROOT.joinpath("kiauh.cfg")
|
||||
|
||||
|
||||
class NoValueError(Exception):
|
||||
"""Raised when a required value is not defined for an option"""
|
||||
|
||||
def __init__(self, section: str, option: str):
|
||||
msg = f"Missing value for option '{option}' in section '{section}'"
|
||||
super().__init__(msg)
|
||||
T = TypeVar("T")
|
||||
|
||||
|
||||
class InvalidValueError(Exception):
|
||||
@@ -53,17 +48,20 @@ class Repository:
|
||||
url: str
|
||||
branch: str
|
||||
|
||||
|
||||
@dataclass
|
||||
class KlipperSettings:
|
||||
repositories: List[Repository] | None = field(default=None)
|
||||
use_python_binary: str | None = field(default=None)
|
||||
|
||||
|
||||
@dataclass
|
||||
class MoonrakerSettings:
|
||||
optional_speedups: bool | None = field(default=None)
|
||||
repositories: List[Repository] | None = field(default=None)
|
||||
use_python_binary: str | None = field(default=None)
|
||||
|
||||
|
||||
@dataclass
|
||||
class WebUiSettings:
|
||||
port: int | None = field(default=None)
|
||||
@@ -74,6 +72,7 @@ class WebUiSettings:
|
||||
# noinspection PyMethodMayBeStatic
|
||||
class KiauhSettings:
|
||||
__instance = None
|
||||
__initialized = False
|
||||
|
||||
def __new__(cls, *args, **kwargs) -> "KiauhSettings":
|
||||
if cls.__instance is None:
|
||||
@@ -91,11 +90,10 @@ class KiauhSettings:
|
||||
return getattr(self, item)
|
||||
|
||||
def __init__(self) -> None:
|
||||
if not hasattr(self, "__initialized"):
|
||||
self.__initialized = False
|
||||
if self.__initialized:
|
||||
return
|
||||
self.__initialized = True
|
||||
|
||||
self.config = SimpleConfigParser()
|
||||
self.kiauh = AppSettings()
|
||||
self.klipper = KlipperSettings()
|
||||
@@ -103,8 +101,9 @@ class KiauhSettings:
|
||||
self.mainsail = WebUiSettings()
|
||||
self.fluidd = WebUiSettings()
|
||||
|
||||
self._load_config()
|
||||
self.__read_config_set_internal_state()
|
||||
|
||||
# todo: refactor this, at least rename to something else!
|
||||
def get(self, section: str, option: str) -> str | int | bool:
|
||||
"""
|
||||
Get a value from the settings state by providing the section and option name as
|
||||
@@ -122,135 +121,175 @@ class KiauhSettings:
|
||||
raise
|
||||
|
||||
def save(self) -> None:
|
||||
self._set_config_options_state()
|
||||
self.config.write_file(CUSTOM_CFG)
|
||||
self._load_config()
|
||||
self.__write_internal_state_to_cfg()
|
||||
self.__read_config_set_internal_state()
|
||||
|
||||
def _load_config(self) -> None:
|
||||
def __read_config_set_internal_state(self) -> None:
|
||||
if not CUSTOM_CFG.exists() and not DEFAULT_CFG.exists():
|
||||
self.__kill()
|
||||
|
||||
cfg = CUSTOM_CFG if CUSTOM_CFG.exists() else DEFAULT_CFG
|
||||
self.config.read_file(cfg)
|
||||
|
||||
needs_migration = self._check_deprecated_repo_config()
|
||||
if needs_migration:
|
||||
self._prompt_migration_dialog()
|
||||
return
|
||||
else:
|
||||
# Only validate if no migration was needed
|
||||
self._validate_cfg()
|
||||
self.__set_internal_state()
|
||||
|
||||
def _validate_cfg(self) -> None:
|
||||
def __err_and_kill(error: str) -> None:
|
||||
Logger.print_error(f"Error validating kiauh.cfg: {error}")
|
||||
Logger.print_dialog(
|
||||
DialogType.ERROR,
|
||||
[
|
||||
"No KIAUH configuration file found! Please make sure you have at least "
|
||||
"one of the following configuration files in KIAUH's root directory:",
|
||||
"● default.kiauh.cfg",
|
||||
"● kiauh.cfg",
|
||||
],
|
||||
)
|
||||
kill()
|
||||
|
||||
try:
|
||||
self._validate_bool("kiauh", "backup_before_update")
|
||||
# copy default config to custom config if it does not exist
|
||||
if not CUSTOM_CFG.exists():
|
||||
shutil.copyfile(DEFAULT_CFG, CUSTOM_CFG)
|
||||
|
||||
self._validate_repositories("klipper", "repositories")
|
||||
self._validate_repositories("moonraker", "repositories")
|
||||
self.config.read_file(CUSTOM_CFG)
|
||||
|
||||
self._validate_int("mainsail", "port")
|
||||
self._validate_bool("mainsail", "unstable_releases")
|
||||
# check if there are deprecated repo_url and branch options in the kiauh.cfg
|
||||
if self._check_deprecated_repo_config():
|
||||
self._prompt_migration_dialog()
|
||||
|
||||
self._validate_int("fluidd", "port")
|
||||
self._validate_bool("fluidd", "unstable_releases")
|
||||
|
||||
self._validate_bool("moonraker", "optional_speedups")
|
||||
|
||||
except ValueError:
|
||||
err = f"Invalid value for option '{self._v_option}' in section '{self._v_section}'"
|
||||
__err_and_kill(err)
|
||||
except NoSectionError:
|
||||
err = f"Missing section '{self._v_section}' in config file"
|
||||
__err_and_kill(err)
|
||||
except NoOptionError:
|
||||
err = f"Missing option '{self._v_option}' in section '{self._v_section}'"
|
||||
__err_and_kill(err)
|
||||
except NoValueError:
|
||||
err = f"Missing value for option '{self._v_option}' in section '{self._v_section}'"
|
||||
__err_and_kill(err)
|
||||
|
||||
def _validate_bool(self, section: str, option: str) -> None:
|
||||
self._v_section, self._v_option = (section, option)
|
||||
(bool(self.config.getboolean(section, option)))
|
||||
|
||||
def _validate_int(self, section: str, option: str) -> None:
|
||||
self._v_section, self._v_option = (section, option)
|
||||
int(self.config.getint(section, option))
|
||||
|
||||
def _validate_str(self, section: str, option: str) -> None:
|
||||
self._v_section, self._v_option = (section, option)
|
||||
v = self.config.getval(section, option)
|
||||
|
||||
if not v:
|
||||
raise ValueError
|
||||
|
||||
def _validate_repositories(self, section: str, option: str) -> None:
|
||||
self._v_section, self._v_option = (section, option)
|
||||
repos = self.config.getval(section, option)
|
||||
if not repos:
|
||||
raise NoValueError(section, option)
|
||||
|
||||
for repo in repos:
|
||||
if repo.strip().startswith("#") or repo.strip().startswith(";"):
|
||||
continue
|
||||
try:
|
||||
if "," in repo:
|
||||
url, branch = repo.strip().split(",")
|
||||
if not url:
|
||||
raise InvalidValueError(section, option, repo)
|
||||
else:
|
||||
url = repo.strip()
|
||||
if not url:
|
||||
raise InvalidValueError(section, option, repo)
|
||||
except ValueError:
|
||||
raise InvalidValueError(section, option, repo)
|
||||
self.__set_internal_state()
|
||||
|
||||
def __set_internal_state(self) -> None:
|
||||
self.kiauh.backup_before_update = self.config.getboolean(
|
||||
"kiauh", "backup_before_update"
|
||||
# parse Kiauh options
|
||||
self.kiauh.backup_before_update = self.__read_from_cfg(
|
||||
"kiauh",
|
||||
"backup_before_update",
|
||||
self.config.getboolean,
|
||||
False,
|
||||
)
|
||||
|
||||
self.moonraker.optional_speedups = self.config.getboolean("moonraker", "optional_speedups", True)
|
||||
|
||||
kl_repos = self.config.getval("klipper", "repositories")
|
||||
self.klipper.repositories = self.__set_repo_state(kl_repos)
|
||||
|
||||
mr_repos = self.config.getval("moonraker", "repositories")
|
||||
self.moonraker.repositories = self.__set_repo_state(mr_repos)
|
||||
|
||||
self.klipper.use_python_binary = self.config.getval("klipper", "use_python_binary", None)
|
||||
self.moonraker.use_python_binary = self.config.getval("moonraker", "use_python_binary", None)
|
||||
|
||||
self.mainsail.port = self.config.getint("mainsail", "port")
|
||||
self.mainsail.unstable_releases = self.config.getboolean(
|
||||
"mainsail", "unstable_releases"
|
||||
# parse Klipper options
|
||||
self.klipper.use_python_binary = self.__read_from_cfg(
|
||||
"klipper",
|
||||
"use_python_binary",
|
||||
self.config.getval,
|
||||
None,
|
||||
True,
|
||||
)
|
||||
self.fluidd.port = self.config.getint("fluidd", "port")
|
||||
self.fluidd.unstable_releases = self.config.getboolean(
|
||||
"fluidd", "unstable_releases"
|
||||
kl_repos: List[str] = self.__read_from_cfg(
|
||||
"klipper",
|
||||
"repositories",
|
||||
self.config.getvals,
|
||||
[KLIPPER_REPO_URL],
|
||||
)
|
||||
self.klipper.repositories = self.__set_repo_state("klipper", kl_repos)
|
||||
|
||||
# parse Moonraker options
|
||||
self.moonraker.use_python_binary = self.__read_from_cfg(
|
||||
"moonraker",
|
||||
"use_python_binary",
|
||||
self.config.getval,
|
||||
None,
|
||||
True,
|
||||
)
|
||||
self.moonraker.optional_speedups = self.__read_from_cfg(
|
||||
"moonraker",
|
||||
"optional_speedups",
|
||||
self.config.getboolean,
|
||||
True,
|
||||
)
|
||||
mr_repos: List[str] = self.__read_from_cfg(
|
||||
"moonraker",
|
||||
"repositories",
|
||||
self.config.getvals,
|
||||
[MOONRAKER_REPO_URL],
|
||||
)
|
||||
self.moonraker.repositories = self.__set_repo_state("moonraker", mr_repos)
|
||||
|
||||
# parse Mainsail options
|
||||
self.mainsail.port = self.__read_from_cfg(
|
||||
"mainsail",
|
||||
"port",
|
||||
self.config.getint,
|
||||
80,
|
||||
)
|
||||
self.mainsail.unstable_releases = self.__read_from_cfg(
|
||||
"mainsail",
|
||||
"unstable_releases",
|
||||
self.config.getboolean,
|
||||
False,
|
||||
)
|
||||
|
||||
def __set_repo_state(self, repos: List[str]) -> List[Repository]:
|
||||
# parse Fluidd options
|
||||
self.fluidd.port = self.__read_from_cfg(
|
||||
"fluidd",
|
||||
"port",
|
||||
self.config.getint,
|
||||
80,
|
||||
)
|
||||
self.fluidd.unstable_releases = self.__read_from_cfg(
|
||||
"fluidd",
|
||||
"unstable_releases",
|
||||
self.config.getboolean,
|
||||
False,
|
||||
)
|
||||
|
||||
def __check_option_exists(
|
||||
self, section: str, option: str, fallback: Any, silent: bool = False
|
||||
) -> bool:
|
||||
has_section = self.config.has_section(section)
|
||||
has_option = self.config.has_option(section, option)
|
||||
|
||||
if not (has_section and has_option):
|
||||
if not silent:
|
||||
Logger.print_warn(
|
||||
f"Option '{option}' in section '{section}' not defined. Falling back to '{fallback}'."
|
||||
)
|
||||
return False
|
||||
return True
|
||||
|
||||
def __read_bool_from_cfg(
|
||||
self,
|
||||
section: str,
|
||||
option: str,
|
||||
fallback: bool | None = None,
|
||||
silent: bool = False,
|
||||
) -> bool | None:
|
||||
if not self.__check_option_exists(section, option, fallback, silent):
|
||||
return fallback
|
||||
return self.config.getboolean(section, option, fallback)
|
||||
|
||||
def __read_from_cfg(
|
||||
self,
|
||||
section: str,
|
||||
option: str,
|
||||
getter: Callable[[str, str, T | None], T],
|
||||
fallback: T = None,
|
||||
silent: bool = False,
|
||||
) -> T:
|
||||
if not self.__check_option_exists(section, option, fallback, silent):
|
||||
return fallback
|
||||
return getter(section, option, fallback)
|
||||
|
||||
def __set_repo_state(self, section: str, repos: List[str]) -> List[Repository]:
|
||||
_repos: List[Repository] = []
|
||||
for repo in repos:
|
||||
try:
|
||||
if repo.strip().startswith("#") or repo.strip().startswith(";"):
|
||||
continue
|
||||
if "," in repo:
|
||||
url, branch = repo.strip().split(",")
|
||||
|
||||
if not branch:
|
||||
branch = "master"
|
||||
else:
|
||||
url = repo.strip()
|
||||
branch = "master"
|
||||
|
||||
# url must not be empty otherwise it's considered
|
||||
# as an unrecoverable, invalid configuration
|
||||
if not url:
|
||||
raise InvalidValueError(section, "repositories", repo)
|
||||
|
||||
_repos.append(Repository(url.strip(), branch.strip()))
|
||||
|
||||
except InvalidValueError as e:
|
||||
Logger.print_error(f"Error parsing kiauh.cfg: {e}")
|
||||
kill()
|
||||
|
||||
return _repos
|
||||
|
||||
def _set_config_options_state(self) -> None:
|
||||
def __write_internal_state_to_cfg(self) -> None:
|
||||
"""Updates the config with current settings, preserving values that haven't been modified"""
|
||||
if self.kiauh.backup_before_update is not None:
|
||||
self.config.set_option(
|
||||
@@ -288,6 +327,8 @@ class KiauhSettings:
|
||||
"fluidd", "unstable_releases", str(self.fluidd.unstable_releases)
|
||||
)
|
||||
|
||||
self.config.write_file(CUSTOM_CFG)
|
||||
|
||||
def _check_deprecated_repo_config(self) -> bool:
|
||||
# repo_url and branch are deprecated - 2025.03.23
|
||||
for section in ["klipper", "moonraker"]:
|
||||
@@ -299,22 +340,23 @@ class KiauhSettings:
|
||||
|
||||
def _prompt_migration_dialog(self) -> None:
|
||||
migration_1: List[str] = [
|
||||
"The old 'repo_url' and 'branch' options are now combined under 'repositories'.",
|
||||
"Options 'repo_url' and 'branch' are now combined into a 'repositories' option.",
|
||||
"\n\n",
|
||||
"Example format:",
|
||||
"[klipper]",
|
||||
"repositories:",
|
||||
"● Old format:",
|
||||
" [klipper]",
|
||||
" repo_url: https://github.com/Klipper3d/klipper",
|
||||
" branch: master",
|
||||
"\n\n",
|
||||
"● New format:",
|
||||
" [klipper]",
|
||||
" repositories:",
|
||||
" https://github.com/Klipper3d/klipper, master",
|
||||
"\n\n",
|
||||
"[moonraker]",
|
||||
"repositories:",
|
||||
" https://github.com/Arksine/moonraker, master",
|
||||
]
|
||||
Logger.print_dialog(
|
||||
DialogType.ATTENTION,
|
||||
[
|
||||
"Deprecated repository configuration found!",
|
||||
"KAIUH can now attempt to automatically migrate your configuration.",
|
||||
"Deprecated kiauh.cfg configuration found!",
|
||||
"KAIUH can now attempt to automatically migrate the configuration.",
|
||||
"\n\n",
|
||||
*migration_1,
|
||||
],
|
||||
@@ -325,15 +367,15 @@ class KiauhSettings:
|
||||
Logger.print_dialog(
|
||||
DialogType.ERROR,
|
||||
[
|
||||
"Please update your configuration file manually.",
|
||||
"Please update the configuration file manually.",
|
||||
],
|
||||
center_content=True,
|
||||
)
|
||||
kill()
|
||||
|
||||
def _migrate_repo_config(self) -> None:
|
||||
bm = BackupManager()
|
||||
if not bm.backup_file(CUSTOM_CFG):
|
||||
svc = BackupService()
|
||||
if not svc.backup_file(CUSTOM_CFG):
|
||||
Logger.print_dialog(
|
||||
DialogType.ERROR,
|
||||
[
|
||||
@@ -366,23 +408,7 @@ class KiauhSettings:
|
||||
self.config.write_file(CUSTOM_CFG)
|
||||
self.config.read_file(CUSTOM_CFG) # reload config
|
||||
|
||||
# Validate the migrated config
|
||||
self._validate_cfg()
|
||||
self.__set_internal_state()
|
||||
|
||||
except Exception as e:
|
||||
Logger.print_error(f"Error migrating configuration: {e}")
|
||||
Logger.print_error("Please migrate manually.")
|
||||
kill()
|
||||
|
||||
def __kill(self) -> None:
|
||||
Logger.print_dialog(
|
||||
DialogType.ERROR,
|
||||
[
|
||||
"No KIAUH configuration file found! Please make sure you have at least "
|
||||
"one of the following configuration files in KIAUH's root directory:",
|
||||
"● default.kiauh.cfg",
|
||||
"● kiauh.cfg",
|
||||
],
|
||||
)
|
||||
kill()
|
||||
|
||||
@@ -12,6 +12,7 @@ Specialized for handling Klipper style config files.
|
||||
- Option Block: A line starting with a word, followed by a `:` or `=` and a newline
|
||||
- Comment: A line starting with a `#` or `;`
|
||||
- Blank: A line containing only whitespace characters
|
||||
- SaveConfig: Klippers auto-generated SAVE_CONFIG section that can be found at the very end of the config file
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -49,6 +49,9 @@ LINE_COMMENT_RE = re.compile(r"^\s*[#;].*")
|
||||
# - the line MUST contain only whitespace characters
|
||||
EMPTY_LINE_RE = re.compile(r"^\s*$")
|
||||
|
||||
SAVE_CONFIG_START_RE = re.compile(r"^#\*# <-+ SAVE_CONFIG -+>$")
|
||||
SAVE_CONFIG_CONTENT_RE = re.compile(r"^#\*#.*$")
|
||||
|
||||
BOOLEAN_STATES = {
|
||||
"1": True,
|
||||
"yes": True,
|
||||
|
||||
@@ -18,7 +18,7 @@ from ..simple_config_parser.constants import (
|
||||
LINE_COMMENT_RE,
|
||||
OPTION_RE,
|
||||
OPTIONS_BLOCK_START_RE,
|
||||
SECTION_RE, LineType, INDENT,
|
||||
SECTION_RE, LineType, INDENT, SAVE_CONFIG_START_RE, SAVE_CONFIG_CONTENT_RE,
|
||||
)
|
||||
|
||||
_UNSET = object()
|
||||
@@ -61,25 +61,34 @@ class SimpleConfigParser:
|
||||
|
||||
def __init__(self) -> None:
|
||||
self.header: List[str] = []
|
||||
self.save_config_block: List[str] = []
|
||||
self.config: Dict = {}
|
||||
self.current_section: str | None = None
|
||||
self.current_opt_block: str | None = None
|
||||
self.in_option_block: bool = False
|
||||
|
||||
def _match_section(self, line: str) -> bool:
|
||||
"""Wheter or not the given line matches the definition of a section"""
|
||||
"""Whether the given line matches the definition of a section"""
|
||||
return SECTION_RE.match(line) is not None
|
||||
|
||||
def _match_option(self, line: str) -> bool:
|
||||
"""Wheter or not the given line matches the definition of an option"""
|
||||
"""Whether the given line matches the definition of an option"""
|
||||
return OPTION_RE.match(line) is not None
|
||||
|
||||
def _match_options_block_start(self, line: str) -> bool:
|
||||
"""Wheter or not the given line matches the definition of a multiline option"""
|
||||
"""Whether the given line matches the definition of a multiline option"""
|
||||
return OPTIONS_BLOCK_START_RE.match(line) is not None
|
||||
|
||||
def _match_save_config_start(self, line: str) -> bool:
|
||||
"""Whether the given line matches the definition of a save config start"""
|
||||
return SAVE_CONFIG_START_RE.match(line) is not None
|
||||
|
||||
def _match_save_config_content(self, line: str) -> bool:
|
||||
"""Whether the given line matches the definition of a save config content"""
|
||||
return SAVE_CONFIG_CONTENT_RE.match(line) is not None
|
||||
|
||||
def _match_line_comment(self, line: str) -> bool:
|
||||
"""Wheter or not the given line matches the definition of a comment"""
|
||||
"""Whether the given line matches the definition of a comment"""
|
||||
return LINE_COMMENT_RE.match(line) is not None
|
||||
|
||||
def _match_empty_line(self, line: str) -> bool:
|
||||
@@ -124,6 +133,14 @@ class SimpleConfigParser:
|
||||
element["value"].append(line.strip()) # indentation is removed
|
||||
break
|
||||
|
||||
elif self._match_save_config_start(line):
|
||||
self.current_opt_block = None
|
||||
self.save_config_block.append(line)
|
||||
|
||||
elif self._match_save_config_content(line):
|
||||
self.current_opt_block = None
|
||||
self.save_config_block.append(line)
|
||||
|
||||
elif self._match_empty_line(line) or self._match_line_comment(line):
|
||||
self.current_opt_block = None
|
||||
|
||||
@@ -185,6 +202,11 @@ class SimpleConfigParser:
|
||||
if not last_line.endswith("\n"):
|
||||
f.write("\n")
|
||||
|
||||
if self.save_config_block:
|
||||
for line in self.save_config_block:
|
||||
f.write(line)
|
||||
f.write("\n")
|
||||
|
||||
def get_sections(self) -> List[str]:
|
||||
"""Return a list of all section names, but exclude any section starting with '#_'"""
|
||||
return list(
|
||||
@@ -314,9 +336,7 @@ class SimpleConfigParser:
|
||||
elements.pop(i)
|
||||
break
|
||||
|
||||
def getval(
|
||||
self, section: str, option: str, fallback: str | _UNSET = _UNSET
|
||||
) -> str | List[str]:
|
||||
def getval(self, section: str, option: str, fallback: str | _UNSET = _UNSET) -> str:
|
||||
"""
|
||||
Return the value of the given option in the given section
|
||||
|
||||
@@ -329,22 +349,34 @@ class SimpleConfigParser:
|
||||
if option not in self.get_options(section):
|
||||
raise NoOptionError(option, section)
|
||||
|
||||
# Find the option in the elements list
|
||||
for element in self.config[section]["elements"]:
|
||||
if element["type"] in [LineType.OPTION.value, LineType.OPTION_BLOCK.value] and element["name"] == option:
|
||||
raw_value = element["value"]
|
||||
if isinstance(raw_value, str) and raw_value.endswith("\n"):
|
||||
return raw_value[:-1].strip()
|
||||
elif isinstance(raw_value, list):
|
||||
values: List[str] = []
|
||||
for i, val in enumerate(raw_value):
|
||||
val = val.strip().strip("\n")
|
||||
if len(val) < 1:
|
||||
continue
|
||||
values.append(val.strip())
|
||||
return values
|
||||
return str(raw_value)
|
||||
if element["type"] is LineType.OPTION.value and element["name"] == option:
|
||||
return str(element["value"].strip().replace("\n", ""))
|
||||
return ""
|
||||
|
||||
except (NoSectionError, NoOptionError):
|
||||
if fallback is _UNSET:
|
||||
raise
|
||||
return fallback
|
||||
|
||||
def getvals(self, section: str, option: str, fallback: List[str] | _UNSET = _UNSET) -> List[str]:
|
||||
"""
|
||||
Return the values of the given multi-line option in the given section
|
||||
|
||||
If the key is not found and 'fallback' is provided, it is used as
|
||||
a fallback value.
|
||||
"""
|
||||
try:
|
||||
if section not in self.get_sections():
|
||||
raise NoSectionError(section)
|
||||
if option not in self.get_options(section):
|
||||
raise NoOptionError(option, section)
|
||||
|
||||
for element in self.config[section]["elements"]:
|
||||
if element["type"] is LineType.OPTION_BLOCK.value and element["name"] == option:
|
||||
return [val.strip() for val in element["value"] if val.strip()]
|
||||
return []
|
||||
|
||||
except (NoSectionError, NoOptionError):
|
||||
if fallback is _UNSET:
|
||||
raise
|
||||
|
||||
@@ -0,0 +1,116 @@
|
||||
# a comment at the very top
|
||||
# should be treated as the file header
|
||||
|
||||
# up to the first section, including all blank lines
|
||||
|
||||
[section_1]
|
||||
option_1: value_1
|
||||
option_1_1: True # this is a boolean
|
||||
option_1_2: 5 ; this is an integer
|
||||
option_1_3: 1.123 #;this is a float
|
||||
|
||||
[section_2] ; comment
|
||||
option_2: value_2
|
||||
|
||||
; comment
|
||||
|
||||
[section_3]
|
||||
option_3: value_3 # comment
|
||||
|
||||
[section_4]
|
||||
# comment
|
||||
option_4: value_4
|
||||
|
||||
[section number 5]
|
||||
#option_5: value_5
|
||||
option_5 = this.is.value-5
|
||||
multi_option:
|
||||
# these are multi-line values
|
||||
value_5_1
|
||||
value_5_2 ; here is a comment
|
||||
value_5_3
|
||||
option_5_1: value_5_1
|
||||
|
||||
[gcode_macro M117]
|
||||
rename_existing: M117.1
|
||||
gcode:
|
||||
{% if rawparams %}
|
||||
{% set escaped_msg = rawparams.split(';', 1)[0].split('\x23', 1)[0]|replace('"', '\\"') %}
|
||||
SET_DISPLAY_TEXT MSG="{escaped_msg}"
|
||||
RESPOND TYPE=command MSG="{escaped_msg}"
|
||||
{% else %}
|
||||
SET_DISPLAY_TEXT
|
||||
{% endif %}
|
||||
|
||||
# SDCard 'looping' (aka Marlin M808 commands) support
|
||||
#
|
||||
# Support SDCard looping
|
||||
[sdcard_loop]
|
||||
[gcode_macro M486]
|
||||
gcode:
|
||||
# Parameters known to M486 are as follows:
|
||||
# [C<flag>] Cancel the current object
|
||||
# [P<index>] Cancel the object with the given index
|
||||
# [S<index>] Set the index of the current object.
|
||||
# If the object with the given index has been canceled, this will cause
|
||||
# the firmware to skip to the next object. The value -1 is used to
|
||||
# indicate something that isn’t an object and shouldn’t be skipped.
|
||||
# [T<count>] Reset the state and set the number of objects
|
||||
# [U<index>] Un-cancel the object with the given index. This command will be
|
||||
# ignored if the object has already been skipped
|
||||
|
||||
{% if 'exclude_object' not in printer %}
|
||||
{action_raise_error("[exclude_object] is not enabled")}
|
||||
{% endif %}
|
||||
|
||||
{% if 'T' in params %}
|
||||
EXCLUDE_OBJECT RESET=1
|
||||
|
||||
{% for i in range(params.T | int) %}
|
||||
EXCLUDE_OBJECT_DEFINE NAME={i}
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
|
||||
{% if 'C' in params %}
|
||||
EXCLUDE_OBJECT CURRENT=1
|
||||
{% endif %}
|
||||
|
||||
{% if 'P' in params %}
|
||||
EXCLUDE_OBJECT NAME={params.P}
|
||||
{% endif %}
|
||||
|
||||
{% if 'S' in params %}
|
||||
{% if params.S == '-1' %}
|
||||
{% if printer.exclude_object.current_object %}
|
||||
EXCLUDE_OBJECT_END NAME={printer.exclude_object.current_object}
|
||||
{% endif %}
|
||||
{% else %}
|
||||
EXCLUDE_OBJECT_START NAME={params.S}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
{% if 'U' in params %}
|
||||
EXCLUDE_OBJECT RESET=1 NAME={params.U}
|
||||
{% endif %}
|
||||
|
||||
#*# <---------------------- SAVE_CONFIG ---------------------->
|
||||
#*# DO NOT EDIT THIS BLOCK OR BELOW. The contents are auto-generated.
|
||||
#*#
|
||||
#*# [bed_mesh default]
|
||||
#*# version = 1
|
||||
#*# points =
|
||||
#*# -0.152500, -0.133125, -0.113125, -0.159375, -0.232500
|
||||
#*# -0.095000, -0.078750, -0.068125, -0.133125, -0.235000
|
||||
#*# -0.092500, -0.040625, 0.004375, -0.077500, -0.193125
|
||||
#*# -0.073750, 0.023750, 0.085625, 0.026875, -0.085000
|
||||
#*# -0.140625, 0.038125, 0.126250, 0.097500, 0.003750
|
||||
#*# tension = 0.2
|
||||
#*# min_x = 26.0
|
||||
#*# algo = bicubic
|
||||
#*# y_count = 5
|
||||
#*# mesh_y_pps = 2
|
||||
#*# min_y = 5.0
|
||||
#*# x_count = 5
|
||||
#*# max_y = 174.0
|
||||
#*# mesh_x_pps = 2
|
||||
#*# max_x = 194.0
|
||||
@@ -0,0 +1,22 @@
|
||||
#*# any content
|
||||
#*#
|
||||
#*# DO NOT EDIT THIS BLOCK OR BELOW. The contents are auto-generated.
|
||||
#*#
|
||||
#*# [bed_mesh default]
|
||||
#*# version = 1
|
||||
#*# points =
|
||||
#*# -0.152500, -0.133125, -0.113125, -0.159375, -0.232500
|
||||
#*# -0.095000, -0.078750, -0.068125, -0.133125, -0.235000
|
||||
#*# -0.092500, -0.040625, 0.004375, -0.077500, -0.193125
|
||||
#*# -0.073750, 0.023750, 0.085625, 0.026875, -0.085000
|
||||
#*# -0.140625, 0.038125, 0.126250, 0.097500, 0.003750
|
||||
#*# tension = 0.2
|
||||
#*# min_x = 26.0
|
||||
#*# algo = bicubic
|
||||
#*# y_count = 5
|
||||
#*# mesh_y_pps = 2
|
||||
#*# min_y = 5.0
|
||||
#*# x_count = 5
|
||||
#*# max_y = 174.0
|
||||
#*# mesh_x_pps = 2
|
||||
#*# max_x = 194.0
|
||||
@@ -0,0 +1,6 @@
|
||||
#*# leading space prevents match
|
||||
random
|
||||
*# not starting with hash-star-hash
|
||||
# *# spaced out
|
||||
<- SAVE_CONFIG ->
|
||||
;#*# semicolon first
|
||||
@@ -0,0 +1,37 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2024 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# https://github.com/dw-0/simple-config-parser #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from tests.utils import load_testdata_from_file
|
||||
|
||||
BASE_DIR = Path(__file__).parent.joinpath("test_data")
|
||||
MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
|
||||
NON_MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("non_matching_data.txt")
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def parser():
|
||||
return SimpleConfigParser()
|
||||
|
||||
|
||||
def test_matching_lines(parser):
|
||||
"""Alle Zeilen in matching_data.txt sollen als Save-Config-Content erkannt werden."""
|
||||
matching_lines = load_testdata_from_file(MATCHING_TEST_DATA_PATH)
|
||||
for line in matching_lines:
|
||||
assert parser._match_save_config_content(line) is True, f"Line should be a save config content: {line!r}"
|
||||
|
||||
|
||||
def test_non_matching_lines(parser):
|
||||
"""Alle Zeilen in non_matching_data.txt sollen NICHT als Save-Config-Content erkannt werden."""
|
||||
non_matching_lines = load_testdata_from_file(NON_MATCHING_TEST_DATA_PATH)
|
||||
for line in non_matching_lines:
|
||||
assert parser._match_save_config_content(line) is False, f"Line should not be a save config content: {line!r}"
|
||||
@@ -0,0 +1,6 @@
|
||||
#*# <- SAVE_CONFIG ->
|
||||
#*# <---- SAVE_CONFIG ---->
|
||||
#*# <------------------- SAVE_CONFIG ------------------->
|
||||
#*# <---------------------- SAVE_CONFIG ---------------------->
|
||||
#*# <----- SAVE_CONFIG ->
|
||||
#*# <- SAVE_CONFIG ----------------->
|
||||
@@ -0,0 +1,13 @@
|
||||
#*#<- SAVE_CONFIG ->
|
||||
#*# <-SAVE_CONFIG ->
|
||||
#*# <- SAVE_CONFIG->
|
||||
#*# <- SAVE_CONFIG -> extra
|
||||
#*# SAVE_CONFIG ---->
|
||||
#*# < SAVE_CONFIG >
|
||||
# *# <- SAVE_CONFIG ->
|
||||
<- SAVE_CONFIG ->
|
||||
random text
|
||||
#*# <---------------------- SAVE_CONFIG ---------------------->
|
||||
#*# <---------------------- SAVE_CONFIG ----------------------> #*#
|
||||
#*# <-------------------------------------------->
|
||||
#*# SAVE_CONFIG
|
||||
@@ -0,0 +1,37 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2024 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# https://github.com/dw-0/simple-config-parser #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from tests.utils import load_testdata_from_file
|
||||
|
||||
BASE_DIR = Path(__file__).parent.joinpath("test_data")
|
||||
MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
|
||||
NON_MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("non_matching_data.txt")
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def parser():
|
||||
return SimpleConfigParser()
|
||||
|
||||
|
||||
def test_matching_lines(parser):
|
||||
"""Test that all lines in the matching data file are correctly identified as save config start lines."""
|
||||
matching_lines = load_testdata_from_file(MATCHING_TEST_DATA_PATH)
|
||||
for line in matching_lines:
|
||||
assert parser._match_save_config_start(line) is True, f"Line should be a save config start: {line!r}"
|
||||
|
||||
|
||||
def test_non_matching_lines(parser):
|
||||
"""Test that all lines in the non-matching data file are correctly identified as not save config start lines."""
|
||||
non_matching_lines = load_testdata_from_file(NON_MATCHING_TEST_DATA_PATH)
|
||||
for line in non_matching_lines:
|
||||
assert parser._match_save_config_start(line) is False, f"Line should not be a save config start: {line!r}"
|
||||
@@ -13,7 +13,7 @@ from src.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from tests.utils import load_testdata_from_file
|
||||
|
||||
BASE_DIR = Path(__file__).parent.parent.joinpath("assets")
|
||||
CONFIG_FILES = ["test_config_1.cfg", "test_config_2.cfg", "test_config_3.cfg"]
|
||||
CONFIG_FILES = ["test_config_1.cfg", "test_config_2.cfg", "test_config_3.cfg", "test_config_4.cfg"]
|
||||
|
||||
|
||||
@pytest.fixture(params=CONFIG_FILES)
|
||||
|
||||
@@ -51,7 +51,7 @@ def test_getval(parser):
|
||||
assert parser.getval("section_2", "option_2") == "value_2"
|
||||
|
||||
# test multiline option values
|
||||
ml_val = parser.getval("section number 5", "multi_option")
|
||||
ml_val = parser.getvals("section number 5", "multi_option")
|
||||
assert isinstance(ml_val, list)
|
||||
assert len(ml_val) > 0
|
||||
|
||||
@@ -164,7 +164,7 @@ def test_set_new_option(parser):
|
||||
assert parser.getval("new_section", "very_new_option") == "very_new_value"
|
||||
|
||||
parser.set_option("section_2", "array_option", ["value_1", "value_2", "value_3"])
|
||||
assert parser.getval("section_2", "array_option") == [
|
||||
assert parser.getvals("section_2", "array_option") == [
|
||||
"value_1",
|
||||
"value_2",
|
||||
"value_3",
|
||||
|
||||
@@ -143,6 +143,31 @@ class ExtensionSubmenu(BaseMenu):
|
||||
"""
|
||||
)[1:]
|
||||
menu += f"{description_text}\n"
|
||||
|
||||
# add links if available
|
||||
website: str = (self.extension.metadata.get("website") or "").strip()
|
||||
repo: str = (self.extension.metadata.get("repo") or "").strip()
|
||||
if website or repo:
|
||||
links_lines: List[str] = ["Links:"]
|
||||
if website:
|
||||
links_lines.append(f"● {website}")
|
||||
if repo:
|
||||
links_lines.append(f"● {repo}")
|
||||
|
||||
links_text = Logger.format_content(
|
||||
links_lines,
|
||||
line_width,
|
||||
border_left="║",
|
||||
border_right="║",
|
||||
)
|
||||
|
||||
menu += textwrap.dedent(
|
||||
"""
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
"""
|
||||
)[1:]
|
||||
menu += f"{links_text}\n"
|
||||
|
||||
menu += textwrap.dedent(
|
||||
"""
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
|
||||
@@ -9,12 +9,13 @@
|
||||
|
||||
import os
|
||||
import shutil
|
||||
from datetime import datetime
|
||||
from typing import List
|
||||
|
||||
from components.klipper.klipper import Klipper
|
||||
from core.backup_manager.backup_manager import BackupManager
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
@@ -109,11 +110,13 @@ class GcodeShellCmdExtension(BaseExtension):
|
||||
Logger.warn(f"Unable to create example config: {e}")
|
||||
|
||||
# backup each printer.cfg before modification
|
||||
bm = BackupManager()
|
||||
svc = BackupService()
|
||||
timestamp = datetime.now().strftime("%Y%m%d-%H%M%S")
|
||||
for instance in instances:
|
||||
bm.backup_file(
|
||||
instance.cfg_file,
|
||||
custom_filename=f"{instance.suffix}.printer.cfg",
|
||||
svc.backup_file(
|
||||
source_path=instance.cfg_file,
|
||||
target_path=f"{instance.data_dir.name}/config_{timestamp}",
|
||||
target_name=instance.cfg_file.name,
|
||||
)
|
||||
|
||||
# add section to printer.cfg if not already defined
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
"module": "gcode_shell_cmd_extension",
|
||||
"maintained_by": "dw-0",
|
||||
"display_name": "G-Code Shell Command",
|
||||
"description": ["Run a shell commands from gcode."]
|
||||
"description": ["Run a shell commands from gcode."],
|
||||
"updates": false
|
||||
}
|
||||
}
|
||||
|
||||
@@ -5,6 +5,8 @@
|
||||
"maintained_by": "Staubgeborener",
|
||||
"display_name": "Klipper-Backup",
|
||||
"description": ["Backup all your Klipper files to GitHub"],
|
||||
"website": "https://klipperbackup.xyz",
|
||||
"repo": "https://github.com/Staubgeborener/klipper-backup",
|
||||
"updates": true
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,6 +4,8 @@
|
||||
"module": "mainsail_theme_installer_extension",
|
||||
"maintained_by": "dw-0",
|
||||
"display_name": "Mainsail Theme Installer",
|
||||
"description": ["Install Mainsail Themes maintained by the Mainsail community."]
|
||||
"description": ["Install Mainsail Themes maintained by the Mainsail community."],
|
||||
"website": "https://docs.mainsail.xyz/theming/themes",
|
||||
"updates": false
|
||||
}
|
||||
}
|
||||
|
||||
@@ -9,7 +9,6 @@
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
from core.backup_manager import BACKUP_ROOT_DIR
|
||||
from core.constants import SYSTEMD
|
||||
|
||||
# repo
|
||||
@@ -23,7 +22,6 @@ MOBILERAKER_LOG_NAME = "mobileraker.log"
|
||||
# directories
|
||||
MOBILERAKER_DIR = Path.home().joinpath("mobileraker_companion")
|
||||
MOBILERAKER_ENV_DIR = Path.home().joinpath("mobileraker-env")
|
||||
MOBILERAKER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("mobileraker-backups")
|
||||
|
||||
# files
|
||||
MOBILERAKER_INSTALL_SCRIPT = MOBILERAKER_DIR.joinpath("scripts/install.sh")
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
"description": [
|
||||
"Companion for Mobileraker, enabling push notification for Klipper using Moonraker."
|
||||
],
|
||||
"repo": "https://github.com/Clon1998/mobileraker_companion",
|
||||
"updates": true
|
||||
}
|
||||
}
|
||||
|
||||
@@ -13,13 +13,12 @@ from typing import List
|
||||
|
||||
from components.klipper.klipper import Klipper
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from core.backup_manager.backup_manager import BackupManager
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.settings.kiauh_settings import KiauhSettings
|
||||
from extensions.base_extension import BaseExtension
|
||||
from extensions.mobileraker import (
|
||||
MOBILERAKER_BACKUP_DIR,
|
||||
MOBILERAKER_DIR,
|
||||
MOBILERAKER_ENV_DIR,
|
||||
MOBILERAKER_INSTALL_SCRIPT,
|
||||
@@ -152,6 +151,7 @@ class MobilerakerExtension(BaseExtension):
|
||||
Logger.print_status(
|
||||
"Removing Mobileraker's companion from update manager ..."
|
||||
)
|
||||
BackupService().backup_moonraker_conf()
|
||||
remove_config_section(MOBILERAKER_UPDATER_SECTION_NAME, mr_instances)
|
||||
Logger.print_ok(
|
||||
"Mobileraker's companion successfully removed from update manager!"
|
||||
@@ -163,6 +163,7 @@ class MobilerakerExtension(BaseExtension):
|
||||
Logger.print_error(f"Error removing Mobileraker's companion:\n{e}")
|
||||
|
||||
def _patch_mobileraker_update_manager(self, instances: List[Moonraker]) -> None:
|
||||
BackupService().backup_moonraker_conf()
|
||||
add_config_section(
|
||||
section=MOBILERAKER_UPDATER_SECTION_NAME,
|
||||
instances=instances,
|
||||
@@ -179,14 +180,14 @@ class MobilerakerExtension(BaseExtension):
|
||||
)
|
||||
|
||||
def _backup_mobileraker_dir(self) -> None:
|
||||
bm = BackupManager()
|
||||
bm.backup_directory(
|
||||
MOBILERAKER_DIR.name,
|
||||
source=MOBILERAKER_DIR,
|
||||
target=MOBILERAKER_BACKUP_DIR,
|
||||
svc = BackupService()
|
||||
svc.backup_directory(
|
||||
source_path=MOBILERAKER_DIR,
|
||||
backup_name="mobileraker",
|
||||
target_path="mobileraker",
|
||||
)
|
||||
bm.backup_directory(
|
||||
MOBILERAKER_ENV_DIR.name,
|
||||
source=MOBILERAKER_ENV_DIR,
|
||||
target=MOBILERAKER_BACKUP_DIR,
|
||||
svc.backup_directory(
|
||||
source_path=MOBILERAKER_ENV_DIR,
|
||||
backup_name="mobileraker-env",
|
||||
target_path="mobileraker",
|
||||
)
|
||||
|
||||
@@ -11,6 +11,8 @@
|
||||
"- 25FPS High-Def Webcam Streaming",
|
||||
"- Free 4.9-Star Mobile App"
|
||||
],
|
||||
"website": "https://obico.io",
|
||||
"repo": "github.com/TheSpaghettiDetective/moonraker-obico",
|
||||
"updates": true
|
||||
}
|
||||
}
|
||||
|
||||
@@ -14,6 +14,7 @@ from components.moonraker.moonraker import Moonraker
|
||||
from core.instance_manager.base_instance import SUFFIX_BLACKLIST
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
@@ -31,7 +32,10 @@ from extensions.obico import (
|
||||
from extensions.obico.moonraker_obico import (
|
||||
MoonrakerObico,
|
||||
)
|
||||
from utils.common import check_install_dependencies, moonraker_exists
|
||||
from utils.common import (
|
||||
check_install_dependencies,
|
||||
moonraker_exists,
|
||||
)
|
||||
from utils.config_utils import (
|
||||
add_config_section,
|
||||
remove_config_section,
|
||||
@@ -119,6 +123,8 @@ class ObicoExtension(BaseExtension):
|
||||
|
||||
cmd_sysctl_manage("daemon-reload")
|
||||
|
||||
BackupService().backup_printer_config_dir()
|
||||
|
||||
# add to klippers config
|
||||
self._patch_printer_cfg(kl_instances)
|
||||
InstanceManager.restart_all(kl_instances)
|
||||
@@ -165,6 +171,7 @@ class ObicoExtension(BaseExtension):
|
||||
self._remove_obico_instances(ob_instances)
|
||||
self._remove_obico_dir()
|
||||
self._remove_obico_env()
|
||||
BackupService().backup_printer_config_dir()
|
||||
remove_config_section(f"include {OBICO_MACROS_CFG_NAME}", kl_instances)
|
||||
remove_config_section(f"include {OBICO_UPDATE_CFG_NAME}", mr_instances)
|
||||
Logger.print_dialog(
|
||||
|
||||
@@ -12,6 +12,7 @@
|
||||
"- Live Gcode preview",
|
||||
"- And much much more!"
|
||||
],
|
||||
"repo": "https://github.com/crysxd/OctoApp-Plugin",
|
||||
"updates": true
|
||||
}
|
||||
}
|
||||
|
||||
@@ -13,6 +13,7 @@ from components.klipper.klipper import Klipper
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from extensions.base_extension import BaseExtension
|
||||
from extensions.octoapp import (
|
||||
OA_DEPS_JSON_FILE,
|
||||
@@ -133,6 +134,7 @@ class OctoappExtension(BaseExtension):
|
||||
self._remove_OA_store_dirs()
|
||||
self._remove_OA_dir()
|
||||
self._remove_OA_env()
|
||||
BackupService().backup_moonraker_conf()
|
||||
remove_config_section(f"include {OA_SYS_CFG_NAME}", mr_instances)
|
||||
run_remove_routines(OA_INSTALLER_LOG_FILE)
|
||||
Logger.print_dialog(
|
||||
|
||||
@@ -11,6 +11,8 @@
|
||||
"- Real-time Notifications",
|
||||
"- Live Streaming, and More!"
|
||||
],
|
||||
"website": "https://octoeverywhere.com",
|
||||
"repo": "github.com/QuinnDamerell/OctoPrint-OctoEverywhere",
|
||||
"updates": true
|
||||
}
|
||||
}
|
||||
|
||||
@@ -12,6 +12,7 @@ from typing import List
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from extensions.base_extension import BaseExtension
|
||||
from extensions.octoeverywhere import (
|
||||
OE_DEPS_JSON_FILE,
|
||||
@@ -133,6 +134,7 @@ class OctoeverywhereExtension(BaseExtension):
|
||||
self._remove_oe_instances(ob_instances)
|
||||
self._remove_oe_dir()
|
||||
self._remove_oe_env()
|
||||
BackupService().backup_moonraker_conf()
|
||||
remove_config_section(f"include {OE_SYS_CFG_NAME}", mr_instances)
|
||||
run_remove_routines(OE_INSTALLER_LOG_FILE)
|
||||
Logger.print_dialog(
|
||||
|
||||
@@ -6,7 +6,17 @@
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
BACKUP_ROOT_DIR = Path.home().joinpath("kiauh-backups")
|
||||
# Constants
|
||||
OP_DEFAULT_PORT = 5000
|
||||
|
||||
# OctoPrint instance naming/prefixes
|
||||
OP_ENV_PREFIX = "OctoPrint"
|
||||
OP_BASEDIR_PREFIX = ".octoprint"
|
||||
|
||||
# Service/log filenames
|
||||
OP_LOG_NAME = "octoprint.log"
|
||||
|
||||
# Files/paths (computed per-instance where applicable)
|
||||
OP_SUDOERS_FILE = Path("/etc/sudoers.d/octoprint-shutdown")
|
||||
18
kiauh/extensions/octoprint/metadata.json
Normal file
18
kiauh/extensions/octoprint/metadata.json
Normal file
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"metadata": {
|
||||
"index": 12,
|
||||
"module": "octoprint_extension",
|
||||
"maintained_by": "dw-0",
|
||||
"display_name": "OctoPrint",
|
||||
"description": [
|
||||
"Open-source web interface to control and monitor your 3D printer",
|
||||
"- Upload and manage G-code, start/pause/cancel prints",
|
||||
"- Live webcam view and timelapse support",
|
||||
"- Real-time temperature graphs and printer status",
|
||||
"- Powerful plugin ecosystem"
|
||||
],
|
||||
"website": "https://octoprint.org",
|
||||
"repo": "https://github.com/OctoPrint/OctoPrint",
|
||||
"updates": false
|
||||
}
|
||||
}
|
||||
116
kiauh/extensions/octoprint/octoprint.py
Normal file
116
kiauh/extensions/octoprint/octoprint.py
Normal file
@@ -0,0 +1,116 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
from __future__ import annotations
|
||||
|
||||
from dataclasses import dataclass, field
|
||||
from pathlib import Path
|
||||
from textwrap import dedent
|
||||
|
||||
from components.klipper.klipper import Klipper
|
||||
from core.constants import CURRENT_USER
|
||||
from core.instance_manager.base_instance import BaseInstance
|
||||
from core.logger import Logger
|
||||
from extensions.octoprint import (
|
||||
OP_BASEDIR_PREFIX,
|
||||
OP_ENV_PREFIX,
|
||||
OP_LOG_NAME,
|
||||
)
|
||||
from utils.fs_utils import create_folders
|
||||
from utils.sys_utils import create_service_file, get_service_file_path
|
||||
|
||||
|
||||
@dataclass
|
||||
class Octoprint:
|
||||
suffix: str
|
||||
base: BaseInstance = field(init=False, repr=False)
|
||||
service_file_path: Path = field(init=False)
|
||||
log_file_name = OP_LOG_NAME
|
||||
env_dir: Path = field(init=False)
|
||||
basedir: Path = field(init=False)
|
||||
cfg_file: Path = field(init=False)
|
||||
|
||||
def __post_init__(self):
|
||||
self.base = BaseInstance(Klipper, self.suffix)
|
||||
self.base.log_file_name = self.log_file_name
|
||||
|
||||
self.service_file_path = get_service_file_path(Octoprint, self.suffix)
|
||||
|
||||
# OctoPrint stores its data under ~/.octoprint[_SUFFIX]
|
||||
self.basedir = (
|
||||
Path.home().joinpath(OP_BASEDIR_PREFIX)
|
||||
if self.suffix == ""
|
||||
else Path.home().joinpath(f"{OP_BASEDIR_PREFIX}_{self.suffix}")
|
||||
)
|
||||
self.cfg_file = self.basedir.joinpath("config.yaml")
|
||||
|
||||
# OctoPrint virtualenv lives under ~/OctoPrint[_SUFFIX]
|
||||
self.env_dir = (
|
||||
Path.home().joinpath(OP_ENV_PREFIX)
|
||||
if self.suffix == ""
|
||||
else Path.home().joinpath(f"{OP_ENV_PREFIX}_{self.suffix}")
|
||||
)
|
||||
|
||||
def create(self, port: int) -> None:
|
||||
Logger.print_status(
|
||||
f"Creating OctoPrint instance '{self.service_file_path.stem}' ..."
|
||||
)
|
||||
|
||||
# Ensure basedir exists and config.yaml is present
|
||||
create_folders([self.basedir])
|
||||
if not self.cfg_file.exists():
|
||||
Logger.print_status("Creating config.yaml ...")
|
||||
self.cfg_file.write_text(self._prep_config_yaml())
|
||||
Logger.print_ok("config.yaml created!")
|
||||
else:
|
||||
Logger.print_info("config.yaml already exists. Skipped ...")
|
||||
|
||||
create_service_file(self.service_file_path.name, self._prep_service_content(port))
|
||||
|
||||
def _prep_service_content(self, port: int) -> str:
|
||||
basedir = self.basedir.as_posix()
|
||||
cfg = self.cfg_file.as_posix()
|
||||
octo_exec = self.env_dir.joinpath("bin/octoprint").as_posix()
|
||||
|
||||
return dedent(
|
||||
f"""\
|
||||
[Unit]
|
||||
Description=Starts OctoPrint on startup
|
||||
After=network-online.target
|
||||
Wants=network-online.target
|
||||
|
||||
[Service]
|
||||
Environment="LC_ALL=C.UTF-8"
|
||||
Environment="LANG=C.UTF-8"
|
||||
Type=simple
|
||||
User={CURRENT_USER}
|
||||
ExecStart={octo_exec} --basedir {basedir} --config {cfg} --port={port} serve
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
"""
|
||||
)
|
||||
|
||||
def _prep_config_yaml(self) -> str:
|
||||
printer = self.base.comms_dir.joinpath("klippy.serial").as_posix()
|
||||
restart_service = self.service_file_path.stem
|
||||
|
||||
return dedent(
|
||||
f"""\
|
||||
serial:
|
||||
additionalPorts:
|
||||
- {printer}
|
||||
disconnectOnErrors: false
|
||||
port: {printer}
|
||||
server:
|
||||
commands:
|
||||
serverRestartCommand: sudo service {restart_service} restart
|
||||
systemRestartCommand: sudo shutdown -r now
|
||||
systemShutdownCommand: sudo shutdown -h now
|
||||
"""
|
||||
)
|
||||
286
kiauh/extensions/octoprint/octoprint_extension.py
Normal file
286
kiauh/extensions/octoprint/octoprint_extension.py
Normal file
@@ -0,0 +1,286 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
from __future__ import annotations
|
||||
|
||||
import re
|
||||
from typing import Dict, List, Optional, Set
|
||||
|
||||
from components.klipper.klipper import Klipper
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.types.color import Color
|
||||
from core.menus.base_menu import print_back_footer
|
||||
from extensions.base_extension import BaseExtension
|
||||
from extensions.octoprint import (
|
||||
OP_SUDOERS_FILE, OP_DEFAULT_PORT,
|
||||
)
|
||||
from extensions.octoprint.octoprint import Octoprint
|
||||
from utils.common import check_install_dependencies
|
||||
from utils.fs_utils import run_remove_routines, remove_with_sudo
|
||||
from utils.input_utils import get_selection_input, get_confirm
|
||||
from utils.instance_utils import get_instances
|
||||
from utils.sys_utils import (
|
||||
create_python_venv,
|
||||
get_ipv4_addr,
|
||||
install_python_packages,
|
||||
)
|
||||
|
||||
|
||||
# noinspection PyMethodMayBeStatic
|
||||
class OctoprintExtension(BaseExtension):
|
||||
def install_extension(self, **kwargs) -> None:
|
||||
Logger.print_status("Installing OctoPrint ...")
|
||||
|
||||
klipper_instances: List[Klipper] = get_instances(Klipper)
|
||||
if not klipper_instances:
|
||||
Logger.print_dialog(
|
||||
DialogType.WARNING,
|
||||
[
|
||||
"Klipper not found! Please install Klipper first.",
|
||||
],
|
||||
)
|
||||
return
|
||||
|
||||
existing_ops: List[Octoprint] = get_instances(Octoprint)
|
||||
existing_by_suffix: Dict[str, Octoprint] = {op.suffix: op for op in existing_ops}
|
||||
candidates: List[Klipper] = [k for k in klipper_instances if k.suffix not in existing_by_suffix]
|
||||
|
||||
chosen: List[Klipper] = []
|
||||
|
||||
if len(klipper_instances) == 1:
|
||||
k = klipper_instances[0]
|
||||
if k.suffix in existing_by_suffix:
|
||||
if not get_confirm(
|
||||
f"OctoPrint already exists for '{k.service_file_path.stem}'. Reinstall?",
|
||||
default_choice=True,
|
||||
allow_go_back=True,
|
||||
):
|
||||
Logger.print_info("Aborted OctoPrint installation.")
|
||||
return
|
||||
chosen = [k]
|
||||
else:
|
||||
while True:
|
||||
dialog = "╔═══════════════════════════════════════════════════════╗\n"
|
||||
headline = Color.apply(
|
||||
"The following Klipper instances were found:", Color.GREEN
|
||||
)
|
||||
dialog += f"║{headline:^64}║\n"
|
||||
dialog += "╟───────────────────────────────────────────────────────╢\n"
|
||||
|
||||
if candidates:
|
||||
line_all = Color.apply("a) Select all (install for all missing)", Color.YELLOW)
|
||||
dialog += f"║ {line_all:<63}║\n"
|
||||
dialog += "║ ║\n"
|
||||
|
||||
index_map: Dict[str, Klipper] = {}
|
||||
for i, k in enumerate(klipper_instances, start=1):
|
||||
mapping = existing_by_suffix.get(k.suffix)
|
||||
suffix = f" <-> {mapping.service_file_path.stem}" if mapping else ""
|
||||
line = Color.apply(f"{i}) {k.service_file_path.stem}{suffix}", Color.CYAN)
|
||||
dialog += f"║ {line:<63}║\n"
|
||||
index_map[str(i)] = k
|
||||
|
||||
dialog += "╟───────────────────────────────────────────────────────╢\n"
|
||||
print(dialog, end="")
|
||||
print_back_footer()
|
||||
|
||||
allowed = list(index_map.keys()) + ["b"] + (["a"] if candidates else [])
|
||||
choice = get_selection_input("Choose instance to install OctoPrint for", allowed)
|
||||
|
||||
if choice == "b":
|
||||
Logger.print_info("Aborted OctoPrint installation.")
|
||||
return
|
||||
if choice == "a":
|
||||
chosen = candidates
|
||||
break
|
||||
|
||||
selected = index_map[choice]
|
||||
if selected.suffix in existing_by_suffix:
|
||||
confirm = get_confirm(
|
||||
f"OctoPrint already exists for '{selected.service_file_path.stem}'. Reinstall?",
|
||||
default_choice=True,
|
||||
allow_go_back=True,
|
||||
)
|
||||
if not confirm:
|
||||
# back to menu
|
||||
continue
|
||||
chosen = [selected]
|
||||
break
|
||||
|
||||
deps = {
|
||||
"git",
|
||||
"wget",
|
||||
"python3-pip",
|
||||
"python3-dev",
|
||||
"libyaml-dev",
|
||||
"build-essential",
|
||||
"python3-setuptools",
|
||||
"python3-virtualenv",
|
||||
}
|
||||
check_install_dependencies(deps)
|
||||
|
||||
# Determine used ports from existing OctoPrint services and prepare regex
|
||||
used_ports: Set[int] = set()
|
||||
port_re = re.compile(r"--port=(\d+)")
|
||||
for op in existing_ops:
|
||||
try:
|
||||
content = op.service_file_path.read_text()
|
||||
m = port_re.search(content)
|
||||
if m:
|
||||
used_ports.add(int(m.group(1)))
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
# noinspection PyShadowingNames
|
||||
def read_existing_port(suffix: str) -> Optional[int]:
|
||||
op = existing_by_suffix.get(suffix)
|
||||
if not op:
|
||||
return None
|
||||
try:
|
||||
content = op.service_file_path.read_text()
|
||||
m = port_re.search(content)
|
||||
return int(m.group(1)) if m else None
|
||||
except OSError:
|
||||
return None
|
||||
|
||||
def next_free_port(start: int, used: Set[int]) -> int:
|
||||
p = start
|
||||
while p in used:
|
||||
p += 1
|
||||
used.add(p)
|
||||
return p
|
||||
|
||||
created_ops: List[Octoprint] = []
|
||||
for k in chosen:
|
||||
# Keep existing port on reinstall, otherwise assign next free one
|
||||
existing_port = read_existing_port(k.suffix)
|
||||
port = existing_port if existing_port is not None else next_free_port(OP_DEFAULT_PORT, used_ports)
|
||||
|
||||
instance = Octoprint(suffix=k.suffix)
|
||||
|
||||
if create_python_venv(instance.env_dir, force=False):
|
||||
Logger.print_ok(
|
||||
f"Virtualenv created: {instance.env_dir}", prefix=False
|
||||
)
|
||||
else:
|
||||
Logger.print_info(
|
||||
f"Virtualenv exists: {instance.env_dir}. Skipping creation ..."
|
||||
)
|
||||
|
||||
install_python_packages(instance.env_dir, ["octoprint"])
|
||||
|
||||
instance.create(port=port)
|
||||
created_ops.append(instance)
|
||||
|
||||
for inst in created_ops:
|
||||
try:
|
||||
InstanceManager.enable(inst)
|
||||
InstanceManager.start(inst)
|
||||
except Exception as e:
|
||||
Logger.print_error(
|
||||
f"Failed to enable/start {inst.service_file_path.name}: {e}"
|
||||
)
|
||||
|
||||
ip = get_ipv4_addr()
|
||||
lines = ["Access your new OctoPrint instance(s) at:"]
|
||||
for inst in created_ops:
|
||||
try:
|
||||
content = inst.service_file_path.read_text()
|
||||
m = port_re.search(content)
|
||||
if m:
|
||||
# noinspection HttpUrlsUsage
|
||||
lines.append(f"● {inst.service_file_path.stem}: http://{ip}:{m.group(1)}")
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
Logger.print_dialog(DialogType.SUCCESS, lines, center_content=False)
|
||||
|
||||
def remove_extension(self, **kwargs) -> None:
|
||||
Logger.print_status("Removing OctoPrint ...")
|
||||
|
||||
try:
|
||||
op_instances: List[Octoprint] = get_instances(Octoprint)
|
||||
if not op_instances:
|
||||
Logger.print_info("No OctoPrint instances found. Skipped ...")
|
||||
return
|
||||
|
||||
remove_all = False
|
||||
if len(op_instances) == 1:
|
||||
to_remove = op_instances
|
||||
else:
|
||||
dialog = "╔═══════════════════════════════════════════════════════╗\n"
|
||||
headline = Color.apply(
|
||||
"The following OctoPrint instances were found:", Color.GREEN
|
||||
)
|
||||
dialog += f"║{headline:^64}║\n"
|
||||
dialog += "╟───────────────────────────────────────────────────────╢\n"
|
||||
select_all = Color.apply("a) Select all", Color.YELLOW)
|
||||
dialog += f"║ {select_all:<63}║\n"
|
||||
dialog += "║ ║\n"
|
||||
|
||||
for i, inst in enumerate(op_instances, start=1):
|
||||
line = Color.apply(
|
||||
f"{i}) {inst.service_file_path.stem}", Color.CYAN
|
||||
)
|
||||
dialog += f"║ {line:<63}║\n"
|
||||
dialog += "╟───────────────────────────────────────────────────────╢\n"
|
||||
print(dialog, end="")
|
||||
print_back_footer()
|
||||
|
||||
allowed = [str(i) for i in range(1, len(op_instances) + 1)]
|
||||
allowed.extend(["a", "b"])
|
||||
choice = get_selection_input("Choose instance to remove", allowed)
|
||||
|
||||
if choice == "a":
|
||||
remove_all = True
|
||||
to_remove = op_instances
|
||||
elif choice == "b":
|
||||
Logger.print_info("Aborted OctoPrint removal.")
|
||||
return
|
||||
else:
|
||||
idx = int(choice) - 1
|
||||
to_remove = [op_instances[idx]]
|
||||
|
||||
for inst in to_remove:
|
||||
Logger.print_status(
|
||||
f"Removing instance {inst.service_file_path.stem} ..."
|
||||
)
|
||||
try:
|
||||
InstanceManager.remove(inst)
|
||||
except Exception as e:
|
||||
Logger.print_error(
|
||||
f"Failed to remove service {inst.service_file_path.name}: {e}"
|
||||
)
|
||||
|
||||
# Remove only this instance's env and basedir
|
||||
if inst.env_dir.exists():
|
||||
Logger.print_status(f"Removing {inst.env_dir} ...")
|
||||
run_remove_routines(inst.env_dir)
|
||||
if inst.basedir.exists():
|
||||
Logger.print_status(f"Removing {inst.basedir} ...")
|
||||
run_remove_routines(inst.basedir)
|
||||
|
||||
# Remove sudoers file only if no instances remain
|
||||
remaining = get_instances(Octoprint)
|
||||
if not remaining and OP_SUDOERS_FILE.exists():
|
||||
Logger.print_status(f"Removing {OP_SUDOERS_FILE} ...")
|
||||
remove_with_sudo(OP_SUDOERS_FILE)
|
||||
|
||||
Logger.print_dialog(
|
||||
DialogType.SUCCESS,
|
||||
[
|
||||
"Selected OctoPrint instance(s) successfully removed!"
|
||||
if not remove_all
|
||||
else "All OctoPrint instances successfully removed!",
|
||||
],
|
||||
center_content=True,
|
||||
)
|
||||
|
||||
except Exception as e:
|
||||
Logger.print_error(f"Error during OctoPrint removal: {e}")
|
||||
@@ -5,6 +5,7 @@
|
||||
"maintained_by": "Kragrathea",
|
||||
"display_name": "PrettyGCode for Klipper",
|
||||
"description": ["3D G-Code viewer for Klipper"],
|
||||
"repo": "https://github.com/Kragrathea/pgcode",
|
||||
"updates": true
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,6 +8,9 @@
|
||||
"3D Printer Cloud Management Software.",
|
||||
"\n\n",
|
||||
"3D printing doesn't have to be a complicated, analog, SD card-filled experience; step into the future of modern 3D printing"
|
||||
]
|
||||
],
|
||||
"website": "https://simplyprint.io",
|
||||
"repo": "https://github.com/SimplyPrint",
|
||||
"updates": false
|
||||
}
|
||||
}
|
||||
|
||||
@@ -11,11 +11,12 @@ from typing import List
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from extensions.base_extension import BaseExtension
|
||||
from utils.common import backup_printer_config_dir, moonraker_exists
|
||||
from utils.common import moonraker_exists
|
||||
from utils.input_utils import get_confirm
|
||||
|
||||
|
||||
@@ -112,10 +113,10 @@ class SimplyPrintExtension(BaseExtension):
|
||||
continue
|
||||
|
||||
if is_install and not scp.has_section("simplyprint"):
|
||||
backup_printer_config_dir()
|
||||
BackupService().backup_printer_config_dir()
|
||||
scp.add_section(section)
|
||||
elif not is_install and scp.has_section("simplyprint"):
|
||||
backup_printer_config_dir()
|
||||
BackupService().backup_printer_config_dir()
|
||||
scp.remove_section(section)
|
||||
scp.write_file(moonraker.cfg_file)
|
||||
patched_files.append(moonraker.cfg_file)
|
||||
|
||||
@@ -13,6 +13,7 @@
|
||||
"\n\n",
|
||||
"Note: This extension installs Spoolman using Docker. Docker must be installed on your system before installing Spoolman."
|
||||
],
|
||||
"repo": "https://github.com/Donkie/Spoolman",
|
||||
"updates": true
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15,9 +15,9 @@ from components.moonraker.moonraker import Moonraker
|
||||
from components.moonraker.services.moonraker_instance_service import (
|
||||
MoonrakerInstanceService,
|
||||
)
|
||||
from core.backup_manager.backup_manager import BackupManager
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from extensions.base_extension import BaseExtension
|
||||
from extensions.spoolman import (
|
||||
SPOOLMAN_COMPOSE_FILE,
|
||||
@@ -100,6 +100,7 @@ class SpoolmanExtension(BaseExtension):
|
||||
mr_instances: List[Moonraker] = mrsvc.get_all_instances()
|
||||
|
||||
Logger.print_status("Removing Spoolman configuration from moonraker.conf...")
|
||||
BackupService().backup_moonraker_conf()
|
||||
remove_config_section("spoolman", mr_instances)
|
||||
|
||||
Logger.print_status("Removing Spoolman from moonraker.asvc...")
|
||||
@@ -123,16 +124,15 @@ class SpoolmanExtension(BaseExtension):
|
||||
"Failed to remove Spoolman image! Please remove it manually."
|
||||
)
|
||||
|
||||
# backup Spoolman directory to ~/spoolman_data-<timestamp> before removing it
|
||||
try:
|
||||
bm = BackupManager()
|
||||
result = bm.backup_directory(
|
||||
f"{SPOOLMAN_DIR.name}_data",
|
||||
source=SPOOLMAN_DIR,
|
||||
target=SPOOLMAN_DIR.parent,
|
||||
svc = BackupService()
|
||||
success = svc.backup_directory(
|
||||
source_path=SPOOLMAN_DIR,
|
||||
backup_name="spoolman",
|
||||
target_path="spoolman",
|
||||
)
|
||||
if result:
|
||||
Logger.print_ok(f"Spoolman data backed up to {result}")
|
||||
if success:
|
||||
Logger.print_ok(f"Spoolman data backed up to {success}")
|
||||
Logger.print_status("Removing Spoolman directory...")
|
||||
if run_remove_routines(SPOOLMAN_DIR):
|
||||
Logger.print_ok("Spoolman directory removed!")
|
||||
@@ -290,6 +290,7 @@ class SpoolmanExtension(BaseExtension):
|
||||
mrsvc.load_instances()
|
||||
mr_instances = mrsvc.get_all_instances()
|
||||
|
||||
BackupService().backup_moonraker_conf()
|
||||
# noinspection HttpUrlsUsage
|
||||
add_config_section(
|
||||
section="spoolman",
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
"maintained_by": "nlef",
|
||||
"display_name": "Moonraker Telegram Bot",
|
||||
"description": ["Control your printer with the Telegram messenger app."],
|
||||
"project_url": "https://github.com/nlef/moonraker-telegram-bot",
|
||||
"repo": "https://github.com/nlef/moonraker-telegram-bot",
|
||||
"updates": true
|
||||
}
|
||||
}
|
||||
|
||||
@@ -13,6 +13,7 @@ from typing import List
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from extensions.base_extension import BaseExtension
|
||||
from extensions.telegram_bot import TG_BOT_REPO, TG_BOT_REQ_FILE
|
||||
from extensions.telegram_bot.moonraker_telegram_bot import (
|
||||
@@ -105,6 +106,7 @@ class TelegramBotExtension(BaseExtension):
|
||||
cmd_sysctl_manage("daemon-reload")
|
||||
|
||||
# add to moonraker update manager
|
||||
BackupService().backup_moonraker_conf()
|
||||
self._patch_bot_update_manager(mr_instances)
|
||||
|
||||
# restart moonraker
|
||||
@@ -150,6 +152,7 @@ class TelegramBotExtension(BaseExtension):
|
||||
self._remove_bot_instances(tb_instances)
|
||||
self._remove_bot_dir()
|
||||
self._remove_bot_env()
|
||||
BackupService().backup_moonraker_conf()
|
||||
remove_config_section("update_manager moonraker-telegram-bot", mr_instances)
|
||||
self._delete_bot_logs(tb_instances)
|
||||
except Exception as e:
|
||||
|
||||
@@ -27,3 +27,7 @@ def main() -> None:
|
||||
MainMenu().run()
|
||||
except KeyboardInterrupt:
|
||||
Logger.print_ok("\nHappy printing!\n", prefix=False)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
|
||||
@@ -13,7 +13,6 @@ from pathlib import Path
|
||||
from typing import Literal
|
||||
|
||||
from components.klipper import (
|
||||
KLIPPER_BACKUP_DIR,
|
||||
KLIPPER_DIR,
|
||||
KLIPPER_ENV_DIR,
|
||||
KLIPPER_REQ_FILE,
|
||||
@@ -21,7 +20,6 @@ from components.klipper import (
|
||||
from components.klipper.klipper import Klipper
|
||||
from components.klipper.klipper_utils import install_klipper_packages
|
||||
from components.moonraker import (
|
||||
MOONRAKER_BACKUP_DIR,
|
||||
MOONRAKER_DIR,
|
||||
MOONRAKER_ENV_DIR,
|
||||
MOONRAKER_REQ_FILE,
|
||||
@@ -30,10 +28,10 @@ from components.moonraker.moonraker import Moonraker
|
||||
from components.moonraker.services.moonraker_setup_service import (
|
||||
install_moonraker_packages,
|
||||
)
|
||||
from core.backup_manager.backup_manager import BackupManager, BackupManagerException
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import Logger
|
||||
from utils.git_utils import GitException, get_repo_name, git_clone_wrapper
|
||||
from core.services.backup_service import BackupService
|
||||
from utils.git_utils import GitException, git_clone_wrapper
|
||||
from utils.instance_utils import get_instances
|
||||
from utils.sys_utils import (
|
||||
VenvCreationFailedException,
|
||||
@@ -52,7 +50,6 @@ def run_switch_repo_routine(
|
||||
repo_dir: Path = KLIPPER_DIR if name == "klipper" else MOONRAKER_DIR
|
||||
env_dir: Path = KLIPPER_ENV_DIR if name == "klipper" else MOONRAKER_ENV_DIR
|
||||
req_file = KLIPPER_REQ_FILE if name == "klipper" else MOONRAKER_REQ_FILE
|
||||
backup_dir: Path = KLIPPER_BACKUP_DIR if name == "klipper" else MOONRAKER_BACKUP_DIR
|
||||
_type = Klipper if name == "klipper" else Moonraker
|
||||
|
||||
# step 1: stop all instances
|
||||
@@ -64,19 +61,17 @@ def run_switch_repo_routine(
|
||||
env_dir_backup_path: Path | None = None
|
||||
|
||||
try:
|
||||
# step 2: backup old repo and env
|
||||
org, _ = get_repo_name(repo_dir)
|
||||
backup_dir = backup_dir.joinpath(org)
|
||||
bm = BackupManager()
|
||||
repo_dir_backup_path = bm.backup_directory(
|
||||
repo_dir.name,
|
||||
repo_dir,
|
||||
backup_dir,
|
||||
svc = BackupService()
|
||||
svc.backup_directory(
|
||||
source_path=repo_dir,
|
||||
backup_name=name,
|
||||
target_path=name,
|
||||
)
|
||||
env_dir_backup_path = bm.backup_directory(
|
||||
env_dir.name,
|
||||
env_dir,
|
||||
backup_dir,
|
||||
env_backup_name: str = f"{name if name == 'moonraker' else 'klippy'}-env"
|
||||
svc.backup_directory(
|
||||
source_path=env_dir,
|
||||
backup_name=env_backup_name,
|
||||
target_path=name,
|
||||
)
|
||||
|
||||
if not (repo_url or branch):
|
||||
@@ -101,10 +96,6 @@ def run_switch_repo_routine(
|
||||
|
||||
Logger.print_ok(f"Switched to {repo_url} at branch {branch}!")
|
||||
|
||||
except BackupManagerException as e:
|
||||
Logger.print_error(f"Error during backup of repository: {e}")
|
||||
raise RepoSwitchFailedException(e)
|
||||
|
||||
except (GitException, VenvCreationFailedException) as e:
|
||||
# if something goes wrong during cloning or recreating the virtualenv,
|
||||
# we restore the backup of the repo and env
|
||||
@@ -122,6 +113,9 @@ def run_switch_repo_routine(
|
||||
Logger.print_error(f"Something went wrong: {e}")
|
||||
return
|
||||
|
||||
except Exception as e:
|
||||
raise RepoSwitchFailedException(e)
|
||||
|
||||
Logger.print_status(f"Restarting all {_type.__name__} instances ...")
|
||||
InstanceManager.start_all(instances)
|
||||
|
||||
|
||||
@@ -14,11 +14,9 @@ from datetime import datetime
|
||||
from pathlib import Path
|
||||
from typing import Dict, List, Literal, Set
|
||||
|
||||
from components.klipper.klipper import Klipper
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from core.constants import (
|
||||
GLOBAL_DEPS,
|
||||
PRINTER_DATA_BACKUP_DIR,
|
||||
)
|
||||
from core.logger import DialogType, Logger
|
||||
from core.types.color import Color
|
||||
@@ -42,10 +40,13 @@ from utils.sys_utils import (
|
||||
def get_kiauh_version() -> str:
|
||||
"""
|
||||
Helper method to get the current KIAUH version by reading the latest tag
|
||||
:return: string of the latest tag
|
||||
:return: string of the latest tag or a default value if no tags exist
|
||||
"""
|
||||
lastest_tag: str = get_local_tags(Path(__file__).parent.parent)[-1]
|
||||
return lastest_tag
|
||||
tags = get_local_tags(Path(__file__).parent.parent)
|
||||
if tags:
|
||||
return tags[-1]
|
||||
else:
|
||||
return "v?.?.?"
|
||||
|
||||
|
||||
def convert_camelcase_to_kebabcase(name: str) -> str:
|
||||
@@ -148,26 +149,6 @@ def get_install_status(
|
||||
)
|
||||
|
||||
|
||||
def backup_printer_config_dir() -> None:
|
||||
# local import to prevent circular import
|
||||
from core.backup_manager.backup_manager import BackupManager
|
||||
|
||||
instances: List[Klipper] = get_instances(Klipper)
|
||||
bm = BackupManager()
|
||||
|
||||
if not instances:
|
||||
Logger.print_info("Unable to find directory to backup!")
|
||||
Logger.print_info("Are there no Klipper instances installed?")
|
||||
return
|
||||
|
||||
for instance in instances:
|
||||
bm.backup_directory(
|
||||
instance.data_dir.name,
|
||||
source=instance.base.cfg_dir,
|
||||
target=PRINTER_DATA_BACKUP_DIR,
|
||||
)
|
||||
|
||||
|
||||
def moonraker_exists(name: str = "") -> List[Moonraker]:
|
||||
"""
|
||||
Helper method to check if a Moonraker instance exists
|
||||
|
||||
@@ -11,7 +11,7 @@ from __future__ import annotations
|
||||
import shutil
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
from typing import List, Tuple
|
||||
from typing import List, Tuple, Union
|
||||
|
||||
from core.logger import Logger
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
@@ -19,7 +19,7 @@ from core.submodules.simple_config_parser.src.simple_config_parser.simple_config
|
||||
)
|
||||
from utils.instance_type import InstanceType
|
||||
|
||||
ConfigOption = Tuple[str, str]
|
||||
ConfigOption = Tuple[str, Union[str, List[str]]]
|
||||
|
||||
|
||||
def add_config_section(
|
||||
@@ -73,7 +73,7 @@ def add_config_section_at_top(section: str, instances: List[InstanceType]) -> No
|
||||
tmp.writelines(org_content)
|
||||
|
||||
cfg_file.unlink()
|
||||
shutil.move(tmp_cfg_path, cfg_file)
|
||||
shutil.move(tmp_cfg_path.as_posix(), cfg_file)
|
||||
|
||||
Logger.print_ok("OK!")
|
||||
|
||||
@@ -81,7 +81,7 @@ def add_config_section_at_top(section: str, instances: List[InstanceType]) -> No
|
||||
def remove_config_section(
|
||||
section: str, instances: List[InstanceType]
|
||||
) -> List[InstanceType]:
|
||||
removed_from: List[instances] = []
|
||||
removed_from: List[InstanceType] = []
|
||||
for instance in instances:
|
||||
cfg_file = instance.cfg_file
|
||||
Logger.print_status(f"Remove section '[{section}]' from '{cfg_file}' ...")
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import re
|
||||
import shutil
|
||||
import urllib.request
|
||||
from http.client import HTTPResponse
|
||||
@@ -121,6 +120,59 @@ def get_local_tags(repo_path: Path, _filter: str | None = None) -> List[str]:
|
||||
:param _filter: Optional filter to filter the tags by
|
||||
:return: List of tags
|
||||
"""
|
||||
|
||||
def parse_version(version: str) -> tuple:
|
||||
# Remove 'v' prefix if present
|
||||
if version.startswith("v") and version[1:][0].isdigit():
|
||||
version = version[1:]
|
||||
|
||||
# Split into version parts and pre-release parts
|
||||
if "-" in version:
|
||||
version_part, pre_part = version.split("-", 1)
|
||||
pre_parts = pre_part.replace("-", ".").split(".")
|
||||
else:
|
||||
version_part = version
|
||||
pre_parts = []
|
||||
|
||||
# Split version into components
|
||||
version_parts = version_part.split(".")
|
||||
|
||||
# Convert to integers where possible
|
||||
def try_int(x):
|
||||
try:
|
||||
return int(x)
|
||||
except ValueError:
|
||||
return (
|
||||
x.lower()
|
||||
) # Convert strings to lowercase for case-insensitive comparison
|
||||
|
||||
version_ints = [try_int(part) for part in version_parts]
|
||||
|
||||
# Pad version parts to at least 3 components
|
||||
while len(version_ints) < 3:
|
||||
version_ints.append(0)
|
||||
|
||||
# Handle pre-release versions
|
||||
pre_type = 999 # High number for stable releases
|
||||
pre_num = 0
|
||||
|
||||
if pre_parts:
|
||||
pre_type_map = {"alpha": 0, "beta": 1, "rc": 2}
|
||||
pre_type = pre_type_map.get(
|
||||
pre_parts[0].lower(), 3
|
||||
) # Default to 3 for unknown pre-release types
|
||||
|
||||
if len(pre_parts) > 1 and str(pre_parts[1]).isdigit():
|
||||
pre_num = int(pre_parts[1])
|
||||
|
||||
return (
|
||||
version_ints[0], # major
|
||||
version_ints[1], # minor
|
||||
version_ints[2], # patch
|
||||
pre_type, # pre-release type (higher number = more stable)
|
||||
pre_num, # pre-release number
|
||||
)
|
||||
|
||||
try:
|
||||
cmd: List[str] = ["git", "tag", "-l"]
|
||||
|
||||
@@ -135,10 +187,8 @@ def get_local_tags(repo_path: Path, _filter: str | None = None) -> List[str]:
|
||||
|
||||
tags: List[str] = result.split("\n")[:-1]
|
||||
|
||||
return sorted(
|
||||
tags,
|
||||
key=lambda x: [int(i) if i.isdigit() else i for i in re.split(r"(\d+)", x)],
|
||||
)
|
||||
# Sort using our custom version parser
|
||||
return sorted(tags, key=parse_version)
|
||||
|
||||
except CalledProcessError:
|
||||
return []
|
||||
|
||||
@@ -15,6 +15,7 @@ from extensions.obico.moonraker_obico import MoonrakerObico
|
||||
from extensions.octoeverywhere.octoeverywhere import Octoeverywhere
|
||||
from extensions.octoapp.octoapp import Octoapp
|
||||
from extensions.telegram_bot.moonraker_telegram_bot import MoonrakerTelegramBot
|
||||
from extensions.octoprint.octoprint import Octoprint
|
||||
|
||||
InstanceType = TypeVar(
|
||||
"InstanceType",
|
||||
@@ -24,4 +25,5 @@ InstanceType = TypeVar(
|
||||
MoonrakerObico,
|
||||
Octoeverywhere,
|
||||
Octoapp,
|
||||
Octoprint,
|
||||
)
|
||||
|
||||
@@ -184,9 +184,6 @@ def install_python_requirements(target: Path, requirements: Path) -> None:
|
||||
:return: None
|
||||
"""
|
||||
try:
|
||||
# always update pip before installing requirements
|
||||
update_python_pip(target)
|
||||
|
||||
Logger.print_status("Installing Python requirements ...")
|
||||
command = [
|
||||
target.joinpath("bin/pip").as_posix(),
|
||||
@@ -196,7 +193,7 @@ def install_python_requirements(target: Path, requirements: Path) -> None:
|
||||
]
|
||||
result = run(command, stderr=PIPE, text=True)
|
||||
|
||||
if result.returncode != 0 or result.stderr:
|
||||
if result.returncode != 0:
|
||||
Logger.print_error(f"{result.stderr}", False)
|
||||
raise VenvCreationFailedException("Installing Python requirements failed!")
|
||||
|
||||
@@ -216,9 +213,6 @@ def install_python_packages(target: Path, packages: List[str]) -> None:
|
||||
:return: None
|
||||
"""
|
||||
try:
|
||||
# always update pip before installing requirements
|
||||
update_python_pip(target)
|
||||
|
||||
Logger.print_status("Installing Python requirements ...")
|
||||
command = [
|
||||
target.joinpath("bin/pip").as_posix(),
|
||||
@@ -228,7 +222,7 @@ def install_python_packages(target: Path, packages: List[str]) -> None:
|
||||
command.append(pkg)
|
||||
result = run(command, stderr=PIPE, text=True)
|
||||
|
||||
if result.returncode != 0 or result.stderr:
|
||||
if result.returncode != 0:
|
||||
Logger.print_error(f"{result.stderr}", False)
|
||||
raise VenvCreationFailedException("Installing Python requirements failed!")
|
||||
|
||||
|
||||
84
mkdocs.yml
Normal file
84
mkdocs.yml
Normal file
@@ -0,0 +1,84 @@
|
||||
site_name: KIAUH Documentation
|
||||
site_description: Documentation for the Klipper Installation And Update Helper
|
||||
repo_url: https://github.com/dw-0/kiauh
|
||||
repo_name: dw-0/kiauh
|
||||
edit_uri: edit/master/docs
|
||||
|
||||
copyright: Copyright © 2025 Dominik Willner
|
||||
|
||||
theme:
|
||||
name: material
|
||||
logo: assets/logo.png
|
||||
favicon: assets/logo.png
|
||||
icon:
|
||||
repo: fontawesome/brands/github
|
||||
palette:
|
||||
- media: "(prefers-color-scheme: light)"
|
||||
scheme: default
|
||||
primary: blue-grey
|
||||
accent: cyan
|
||||
toggle:
|
||||
icon: material/weather-night
|
||||
name: Switch to dark mode
|
||||
- media: "(prefers-color-scheme: dark)"
|
||||
scheme: slate
|
||||
primary: blue-grey
|
||||
accent: cyan
|
||||
toggle:
|
||||
icon: material/weather-sunny
|
||||
name: Switch to light mode
|
||||
features:
|
||||
- navigation.instant
|
||||
- navigation.tracking
|
||||
- navigation.sections
|
||||
- navigation.expand
|
||||
- navigation.indexes
|
||||
- navigation.top
|
||||
- toc.follow
|
||||
- content.code.copy
|
||||
|
||||
plugins:
|
||||
- search
|
||||
- git-revision-date-localized:
|
||||
enable_creation_date: true
|
||||
- mkdocstrings:
|
||||
handlers:
|
||||
python:
|
||||
paths: [.]
|
||||
options:
|
||||
docstring_style: google
|
||||
|
||||
markdown_extensions:
|
||||
- admonition
|
||||
- pymdownx.details
|
||||
- pymdownx.superfences
|
||||
- pymdownx.highlight:
|
||||
anchor_linenums: true
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.snippets
|
||||
- pymdownx.superfences
|
||||
- tables
|
||||
- attr_list
|
||||
- md_in_html
|
||||
|
||||
nav:
|
||||
- Home: index.md
|
||||
- Installation:
|
||||
- setup/raspberry-pi-setup.md
|
||||
- setup/installation.md
|
||||
- Configuration: configuration.md
|
||||
- Extensions:
|
||||
- extensions/index.md
|
||||
- extensions/gcode-shell-command.md
|
||||
- Development:
|
||||
- development/contributing.md
|
||||
- development/changelog.md
|
||||
|
||||
extra:
|
||||
social:
|
||||
- icon: simple/github
|
||||
link: https://github.com/dw-0
|
||||
- icon: simple/kofi
|
||||
link: https://ko-fi.com/dw__0
|
||||
- icon: simple/paypal
|
||||
link: https://www.paypal.com/paypalme/dwillner0
|
||||
2
requirements-dev.txt
Normal file
2
requirements-dev.txt
Normal file
@@ -0,0 +1,2 @@
|
||||
ruff (>=0.9.10)
|
||||
pyright
|
||||
4
requirements.txt
Normal file
4
requirements.txt
Normal file
@@ -0,0 +1,4 @@
|
||||
mkdocs-material
|
||||
mkdocs
|
||||
mkdocstrings[python]
|
||||
mkdocs-git-revision-date-localized-plugin
|
||||
@@ -1,65 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
#####################################################################
|
||||
### Please set the paths accordingly. In case you don't have all ###
|
||||
### the listed folders, just keep that line commented out. ###
|
||||
#####################################################################
|
||||
### Path to your config folder you want to back up
|
||||
#config_folder=~/klipper_config
|
||||
|
||||
### Path to your Klipper folder, by default that is '~/klipper'
|
||||
#klipper_folder=~/klipper
|
||||
|
||||
### Path to your Moonraker folder, by default that is '~/moonraker'
|
||||
#moonraker_folder=~/moonraker
|
||||
|
||||
### Path to your Mainsail folder, by default that is '~/mainsail'
|
||||
#mainsail_folder=~/mainsail
|
||||
|
||||
### Path to your Fluidd folder, by default that is '~/fluidd'
|
||||
#fluidd_folder=~/fluidd
|
||||
|
||||
#####################################################################
|
||||
#####################################################################
|
||||
|
||||
|
||||
#####################################################################
|
||||
################ !!! DO NOT EDIT BELOW THIS LINE !!! ################
|
||||
#####################################################################
|
||||
grab_version() {
|
||||
local klipper_commit moonraker_commit
|
||||
local mainsail_ver fluidd_ver
|
||||
|
||||
if [[ -n ${klipper_folder} ]]; then
|
||||
cd "${klipper_folder}"
|
||||
klipper_commit=$(git rev-parse --short=7 HEAD)
|
||||
m1="Klipper on commit: ${klipper_commit}"
|
||||
fi
|
||||
if [[ -n ${moonraker_folder} ]]; then
|
||||
cd "${moonraker_folder}"
|
||||
moonraker_commit=$(git rev-parse --short=7 HEAD)
|
||||
m2="Moonraker on commit: ${moonraker_commit}"
|
||||
fi
|
||||
if [[ -n ${mainsail_folder} ]]; then
|
||||
mainsail_ver=$(head -n 1 "${mainsail_folder}/.version")
|
||||
m3="Mainsail version: ${mainsail_ver}"
|
||||
fi
|
||||
if [[ -n ${fluidd_folder} ]]; then
|
||||
fluidd_ver=$(head -n 1 "${fluidd_folder}/.version")
|
||||
m4="Fluidd version: ${fluidd_ver}"
|
||||
fi
|
||||
}
|
||||
|
||||
push_config() {
|
||||
local current_date
|
||||
|
||||
cd "${config_folder}" || exit 1
|
||||
git pull
|
||||
git add .
|
||||
current_date=$(date +"%Y-%m-%d %T")
|
||||
git commit -m "Autocommit from ${current_date}" -m "${m1}" -m "${m2}" -m "${m3}" -m "${m4}"
|
||||
git push
|
||||
}
|
||||
|
||||
grab_version
|
||||
push_config
|
||||
@@ -1,6 +0,0 @@
|
||||
# /etc/nginx/conf.d/common_vars.conf
|
||||
|
||||
map $http_upgrade $connection_upgrade {
|
||||
default upgrade;
|
||||
'' close;
|
||||
}
|
||||
@@ -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
|
||||
@@ -1,96 +0,0 @@
|
||||
# /etc/nginx/sites-available/fluidd
|
||||
|
||||
server {
|
||||
listen 80;
|
||||
|
||||
access_log /var/log/nginx/fluidd-access.log;
|
||||
error_log /var/log/nginx/fluidd-error.log;
|
||||
|
||||
# disable this section on smaller hardware like a pi zero
|
||||
gzip on;
|
||||
gzip_vary on;
|
||||
gzip_proxied any;
|
||||
gzip_proxied expired no-cache no-store private auth;
|
||||
gzip_comp_level 4;
|
||||
gzip_buffers 16 8k;
|
||||
gzip_http_version 1.1;
|
||||
gzip_types text/plain text/css text/xml text/javascript application/javascript application/x-javascript application/json application/xml;
|
||||
|
||||
# web_path from fluidd static files
|
||||
root /home/pi/fluidd;
|
||||
|
||||
index index.html;
|
||||
server_name _;
|
||||
|
||||
# disable max upload size checks
|
||||
client_max_body_size 0;
|
||||
|
||||
# disable proxy request buffering
|
||||
proxy_request_buffering off;
|
||||
|
||||
location / {
|
||||
try_files $uri $uri/ /index.html;
|
||||
}
|
||||
|
||||
location = /index.html {
|
||||
add_header Cache-Control "no-store, no-cache, must-revalidate";
|
||||
}
|
||||
|
||||
location /websocket {
|
||||
proxy_pass http://apiserver/websocket;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection $connection_upgrade;
|
||||
proxy_set_header Host $http_host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_read_timeout 86400;
|
||||
}
|
||||
|
||||
location ~ ^/(printer|api|access|machine|server)/ {
|
||||
proxy_pass http://apiserver$request_uri;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Host $http_host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Scheme $scheme;
|
||||
proxy_read_timeout 600;
|
||||
}
|
||||
|
||||
location /webcam/ {
|
||||
postpone_output 0;
|
||||
proxy_buffering off;
|
||||
proxy_ignore_headers X-Accel-Buffering;
|
||||
access_log off;
|
||||
error_log off;
|
||||
proxy_pass http://mjpgstreamer1/;
|
||||
}
|
||||
|
||||
location /webcam2/ {
|
||||
postpone_output 0;
|
||||
proxy_buffering off;
|
||||
proxy_ignore_headers X-Accel-Buffering;
|
||||
access_log off;
|
||||
error_log off;
|
||||
proxy_pass http://mjpgstreamer2/;
|
||||
}
|
||||
|
||||
location /webcam3/ {
|
||||
postpone_output 0;
|
||||
proxy_buffering off;
|
||||
proxy_ignore_headers X-Accel-Buffering;
|
||||
access_log off;
|
||||
error_log off;
|
||||
proxy_pass http://mjpgstreamer3/;
|
||||
}
|
||||
|
||||
location /webcam4/ {
|
||||
postpone_output 0;
|
||||
proxy_buffering off;
|
||||
proxy_ignore_headers X-Accel-Buffering;
|
||||
access_log off;
|
||||
error_log off;
|
||||
proxy_pass http://mjpgstreamer4/;
|
||||
}
|
||||
}
|
||||
@@ -1,94 +0,0 @@
|
||||
# Run a shell command via gcode
|
||||
#
|
||||
# Copyright (C) 2019 Eric Callahan <arksine.code@gmail.com>
|
||||
#
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license.
|
||||
import os
|
||||
import shlex
|
||||
import subprocess
|
||||
import logging
|
||||
|
||||
|
||||
class ShellCommand:
|
||||
def __init__(self, config):
|
||||
self.name = config.get_name().split()[-1]
|
||||
self.printer = config.get_printer()
|
||||
self.gcode = self.printer.lookup_object("gcode")
|
||||
cmd = config.get("command")
|
||||
cmd = os.path.expanduser(cmd)
|
||||
self.command = shlex.split(cmd)
|
||||
self.timeout = config.getfloat("timeout", 2.0, above=0.0)
|
||||
self.verbose = config.getboolean("verbose", True)
|
||||
self.proc_fd = None
|
||||
self.partial_output = ""
|
||||
self.gcode.register_mux_command(
|
||||
"RUN_SHELL_COMMAND",
|
||||
"CMD",
|
||||
self.name,
|
||||
self.cmd_RUN_SHELL_COMMAND,
|
||||
desc=self.cmd_RUN_SHELL_COMMAND_help,
|
||||
)
|
||||
|
||||
def _process_output(self, eventime):
|
||||
if self.proc_fd is None:
|
||||
return
|
||||
try:
|
||||
data = os.read(self.proc_fd, 4096)
|
||||
except Exception:
|
||||
pass
|
||||
data = self.partial_output + data.decode()
|
||||
if "\n" not in data:
|
||||
self.partial_output = data
|
||||
return
|
||||
elif data[-1] != "\n":
|
||||
split = data.rfind("\n") + 1
|
||||
self.partial_output = data[split:]
|
||||
data = data[:split]
|
||||
else:
|
||||
self.partial_output = ""
|
||||
self.gcode.respond_info(data)
|
||||
|
||||
cmd_RUN_SHELL_COMMAND_help = "Run a linux shell command"
|
||||
|
||||
def cmd_RUN_SHELL_COMMAND(self, params):
|
||||
gcode_params = params.get("PARAMS", "")
|
||||
gcode_params = shlex.split(gcode_params)
|
||||
reactor = self.printer.get_reactor()
|
||||
try:
|
||||
proc = subprocess.Popen(
|
||||
self.command + gcode_params,
|
||||
stdout=subprocess.PIPE,
|
||||
stderr=subprocess.STDOUT,
|
||||
)
|
||||
except Exception:
|
||||
logging.exception("shell_command: Command {%s} failed" % (self.name))
|
||||
raise self.gcode.error("Error running command {%s}" % (self.name))
|
||||
if self.verbose:
|
||||
self.proc_fd = proc.stdout.fileno()
|
||||
self.gcode.respond_info("Running Command {%s}...:" % (self.name))
|
||||
hdl = reactor.register_fd(self.proc_fd, self._process_output)
|
||||
eventtime = reactor.monotonic()
|
||||
endtime = eventtime + self.timeout
|
||||
complete = False
|
||||
while eventtime < endtime:
|
||||
eventtime = reactor.pause(eventtime + 0.05)
|
||||
if proc.poll() is not None:
|
||||
complete = True
|
||||
break
|
||||
if not complete:
|
||||
proc.terminate()
|
||||
if self.verbose:
|
||||
if self.partial_output:
|
||||
self.gcode.respond_info(self.partial_output)
|
||||
self.partial_output = ""
|
||||
if complete:
|
||||
msg = "Command {%s} finished\n" % (self.name)
|
||||
else:
|
||||
msg = "Command {%s} timed out" % (self.name)
|
||||
self.gcode.respond_info(msg)
|
||||
reactor.unregister_fd(hdl)
|
||||
self.proc_fd = None
|
||||
|
||||
|
||||
def load_config_prefix(config):
|
||||
return ShellCommand(config)
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user