mirror of
https://github.com/dw-0/kiauh.git
synced 2025-12-14 19:14:27 +05:00
Compare commits
76 Commits
v6.0.0-alp
...
v6.0.0-bet
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
afdde34721 | ||
|
|
393dd1d5bf | ||
|
|
8170057434 | ||
|
|
985b66d41f | ||
|
|
f95d2586bf | ||
|
|
f5141e7eff | ||
|
|
33113e72e9 | ||
|
|
6f59fd06aa | ||
|
|
56ea43ccb6 | ||
|
|
25e22c993f | ||
|
|
ead521b377 | ||
|
|
3c952ccc12 | ||
|
|
c8f713c00e | ||
|
|
95cf809378 | ||
|
|
c91816d13f | ||
|
|
1a6f06eaf2 | ||
|
|
ea8621af0c | ||
|
|
88742ab496 | ||
|
|
b99e6612e2 | ||
|
|
cf4e915430 | ||
|
|
c901cd1fdf | ||
|
|
da3c37a872 | ||
|
|
8f436646cd | ||
|
|
760f131d1c | ||
|
|
41804f0eaa | ||
|
|
d3c9bcc38c | ||
|
|
7fc36f3e68 | ||
|
|
a4942b9404 | ||
|
|
9e0a8a0081 | ||
|
|
6082528628 | ||
|
|
9e92e4a36a | ||
|
|
7e8f1f3d81 | ||
|
|
234cf2c751 | ||
|
|
3bc98eed13 | ||
|
|
777f5e45e7 | ||
|
|
acf0faf158 | ||
|
|
5c219ec544 | ||
|
|
70055e891e | ||
|
|
e3a0a9dec0 | ||
|
|
1cf81377ee | ||
|
|
aa4ea99c5c | ||
|
|
20ffc82a04 | ||
|
|
0becf9d574 | ||
|
|
ed1bfcdeb4 | ||
|
|
033916216c | ||
|
|
d8f47c0960 | ||
|
|
4978f22101 | ||
|
|
8330f90b56 | ||
|
|
2a08e3eb15 | ||
|
|
a2a3e92b50 | ||
|
|
a58288e7e3 | ||
|
|
3852464ab7 | ||
|
|
d9626adc98 | ||
|
|
4ae5a37ec6 | ||
|
|
935f81aab6 | ||
|
|
b02df9a1e0 | ||
|
|
dbbc87f18e | ||
|
|
243ea6582a | ||
|
|
91cba3637e | ||
|
|
3fc190ff25 | ||
|
|
6ff45aab41 | ||
|
|
b9c9feef3c | ||
|
|
d37d047aaa | ||
|
|
a3fb57aee3 | ||
|
|
8aee23830a | ||
|
|
dd14de9a41 | ||
|
|
1ca1e8ff6f | ||
|
|
12127efa21 | ||
|
|
66a5cdf9b1 | ||
|
|
9b1aba207c | ||
|
|
e274e3c00d | ||
|
|
dd99b0e1a6 | ||
|
|
a616876ace | ||
|
|
4925021aa8 | ||
|
|
e63d9d67ec | ||
|
|
106bf7675f |
@@ -11,5 +11,5 @@ end_of_line = lf
|
||||
[*.py]
|
||||
max_line_length = 88
|
||||
|
||||
[*.sh]
|
||||
[*.{sh,yml,yaml,json}]
|
||||
indent_size = 2
|
||||
33
.github/workflows/release-ff-and-tag.yml
vendored
Normal file
33
.github/workflows/release-ff-and-tag.yml
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
name: Release - Fast-Forward and Tag
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
tag_name:
|
||||
description: 'Provide a tag name (e.g. v1.0.0)'
|
||||
required: true
|
||||
type: string
|
||||
|
||||
jobs:
|
||||
ff-and-tag:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
ref: 'master'
|
||||
- name: Merge Fast Forward
|
||||
uses: MaximeHeckel/github-action-merge-fast-forward@v1.1.0
|
||||
with:
|
||||
branchtomerge: origin/develop
|
||||
branch: master
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
- name: Create and Push Tag
|
||||
run: |
|
||||
git tag ${{ inputs.tag_name }}
|
||||
git push origin ${{ inputs.tag_name }}
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
110
README.md
110
README.md
@@ -101,77 +101,83 @@ prompt and confirm by hitting ENTER.
|
||||
|
||||
<h2 align="center">🌐 Sources & Further Information</h2>
|
||||
|
||||
<table>
|
||||
<table align="center">
|
||||
<tr>
|
||||
<th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
|
||||
<th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
|
||||
<th><h3><a href="https://github.com/mainsail-crew/mainsail">Mainsail</a></h3></th>
|
||||
<th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
|
||||
<th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
|
||||
<th><h3><a href="https://github.com/mainsail-crew/mainsail">Mainsail</a></h3></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><img src="https://raw.githubusercontent.com/Klipper3d/klipper/master/docs/img/klipper-logo.png" alt="Klipper Logo" height="64"></th>
|
||||
<th><img src="https://avatars.githubusercontent.com/u/9563098?v=4" alt="Arksine avatar" height="64"></th>
|
||||
<th><img src="https://raw.githubusercontent.com/mainsail-crew/docs/master/assets/img/logo.png" alt="Mainsail Logo" height="64"></th>
|
||||
<th><img src="https://raw.githubusercontent.com/Klipper3d/klipper/master/docs/img/klipper-logo.png" alt="Klipper Logo" height="64"></th>
|
||||
<th><img src="https://avatars.githubusercontent.com/u/9563098?v=4" alt="Arksine avatar" height="64"></th>
|
||||
<th><img src="https://raw.githubusercontent.com/mainsail-crew/docs/master/assets/img/logo.png" alt="Mainsail Logo" height="64"></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>by <a href="https://github.com/KevinOConnor">KevinOConnor</a></th>
|
||||
<th>by <a href="https://github.com/Arksine">Arksine</a></th>
|
||||
<th>by <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
|
||||
<th><h3><a href="https://github.com/jordanruthe/KlipperScreen">KlipperScreen</a></h3></th>
|
||||
<th><h3><a href="https://github.com/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
|
||||
<th><img src="https://avatars.githubusercontent.com/u/31575189?v=4" alt="jordanruthe avatar" height="64"></th>
|
||||
<th><img src="https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png" alt="OctoPrint Logo" height="64"></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>by <a href="https://github.com/fluidd-core">fluidd-core</a></th>
|
||||
<th>by <a href="https://github.com/jordanruthe">jordanruthe</a></th>
|
||||
<th>by <a href="https://github.com/OctoPrint">OctoPrint</a></th>
|
||||
<th>by <a href="https://github.com/KevinOConnor">KevinOConnor</a></th>
|
||||
<th>by <a href="https://github.com/Arksine">Arksine</a></th>
|
||||
<th>by <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><h3><a href="https://github.com/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>
|
||||
<th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
|
||||
<th><h3><a href="https://github.com/jordanruthe/KlipperScreen">KlipperScreen</a></h3></th>
|
||||
<th><h3><a href="https://github.com/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
|
||||
<th><img src="https://avatars.githubusercontent.com/u/31575189?v=4" alt="jordanruthe avatar" height="64"></th>
|
||||
<th><img src="https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png" alt="OctoPrint Logo" height="64"></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>by <a href="https://github.com/fluidd-core">fluidd-core</a></th>
|
||||
<th>by <a href="https://github.com/jordanruthe">jordanruthe</a></th>
|
||||
<th>by <a href="https://github.com/OctoPrint">OctoPrint</a></th>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><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>
|
||||
<th><h3><a href="https://github.com/nlef/moonraker-telegram-bot">Moonraker-Telegram-Bot</a></h3></th>
|
||||
<th><h3><a href="https://github.com/Kragrathea/pgcode">PrettyGCode for Klipper</a></h3></th>
|
||||
<th><h3><a href="https://github.com/TheSpaghettiDetective/moonraker-obico">Obico for Klipper</a></h3></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></th>
|
||||
<th><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></th>
|
||||
<th><img src="https://avatars.githubusercontent.com/u/46323662?s=200&v=4" alt="Obico logo" height="64"></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>by <a href="https://github.com/nlef">nlef</a></th>
|
||||
<th>by <a href="https://github.com/Kragrathea">Kragrathea</a></th>
|
||||
<th>by <a href="https://github.com/TheSpaghettiDetective">Obico</a></th>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th>by <a href="https://github.com/nlef">nlef</a></th>
|
||||
<th>by <a href="https://github.com/Kragrathea">Kragrathea</a></th>
|
||||
<th>by <a href="https://github.com/TheSpaghettiDetective">Obico</a></th>
|
||||
<th><h3><a href="https://github.com/Clon1998/mobileraker_companion">Mobileraker's Companion</a></h3></th>
|
||||
<th><h3><a href="https://octoeverywhere.com/?source=kiauh_readme">OctoEverywhere For Klipper</a></h3></th>
|
||||
<th><h3><a href="https://github.com/crysxd/OctoApp-Plugin">OctoApp For Klipper</a></h3></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><a href="https://github.com/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="Mobileraker Logo" height="64"></a></th>
|
||||
<th><a href="https://octoeverywhere.com/?source=kiauh_readme"><img src="https://octoeverywhere.com/img/logo.svg" alt="OctoEverywhere Logo" height="64"></a></th>
|
||||
<th><a href="https://octoapp.eu/?source=kiauh_readme"><img src="https://octoapp.eu/octoapp.webp" alt="OctoApp Logo" height="64"></a></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>by <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
|
||||
<th>by <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
|
||||
<th>by <a href="https://github.com/crysxd">Christian Würthner</a></th>
|
||||
</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>
|
||||
<th><h3></h3></th>
|
||||
<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/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="OctoEverywhere Logo" height="64"></a></th>
|
||||
<th><a href="https://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>
|
||||
<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>by <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
|
||||
<th>by <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
|
||||
<th>by <a href="https://github.com/crysxd">Christian Würthner</a></th>
|
||||
<th></th>
|
||||
<th>by <a href="https://github.com/Staubgeborener">Staubgeborener</a></th>
|
||||
<th>by <a href="https://github.com/SimplyPrint">SimplyPrint</a></th>
|
||||
</tr>
|
||||
|
||||
|
||||
</table>
|
||||
|
||||
<hr>
|
||||
@@ -186,6 +192,12 @@ prompt and confirm by hitting ENTER.
|
||||
|
||||
<hr>
|
||||
|
||||
<div align="center">
|
||||
<img src="https://repobeats.axiom.co/api/embed/a1afbda9190c04a90cf4bd3061e5573bc836cb05.svg" alt="Repobeats analytics image"/>
|
||||
</div>
|
||||
|
||||
<hr>
|
||||
|
||||
<h2 align="center">✨ Credits ✨</h2>
|
||||
|
||||
* A big thank you to [lixxbox](https://github.com/lixxbox) for that awesome KIAUH-Logo!
|
||||
|
||||
@@ -2,12 +2,30 @@
|
||||
backup_before_update: False
|
||||
|
||||
[klipper]
|
||||
repo_url: https://github.com/Klipper3d/klipper
|
||||
branch: master
|
||||
# add custom repositories here, if at least one is given, the first in the list will be used by default
|
||||
# otherwise the official repository is used
|
||||
#
|
||||
# format: https://github.com/username/repository, branch
|
||||
# example: https://github.com/Klipper3d/klipper, master
|
||||
#
|
||||
# branch is optional, if given, it must be preceded by a comma, if not given, 'master' is used
|
||||
repositories:
|
||||
https://github.com/Klipper3d/klipper
|
||||
|
||||
[moonraker]
|
||||
repo_url: https://github.com/Arksine/moonraker
|
||||
branch: master
|
||||
# Moonraker supports two optional Python packages that can be used to reduce its CPU load
|
||||
# If set to true, those packages will be installed during the Moonraker installation
|
||||
optional_speedups: True
|
||||
|
||||
# add custom repositories here, if at least one is given, the first in the list will be used by default
|
||||
# otherwise the official repository is used
|
||||
#
|
||||
# format: https://github.com/username/repository, branch
|
||||
# example: https://github.com/Arksine/moonraker, master
|
||||
#
|
||||
# branch is optional, if given, it must be preceded by a comma, if not given, 'master' is used
|
||||
repositories:
|
||||
https://github.com/Arksine/moonraker
|
||||
|
||||
[mainsail]
|
||||
port: 80
|
||||
|
||||
8
kiauh.py
8
kiauh.py
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -9,13 +9,7 @@
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
|
||||
import io
|
||||
import sys
|
||||
|
||||
from kiauh.main import main
|
||||
|
||||
# ensure that all output is utf-8 encoded
|
||||
sys.stdout = io.TextIOWrapper(sys.stdout.buffer, encoding="utf-8")
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -27,10 +27,9 @@ from components.crowsnest import (
|
||||
)
|
||||
from components.klipper.klipper import Klipper
|
||||
from core.backup_manager.backup_manager import BackupManager
|
||||
from core.constants import CURRENT_USER
|
||||
from core.logger import DialogType, Logger
|
||||
from core.settings.kiauh_settings import KiauhSettings
|
||||
from core.types import ComponentStatus
|
||||
from core.types.component_status import ComponentStatus
|
||||
from utils.common import (
|
||||
check_install_dependencies,
|
||||
get_install_status,
|
||||
@@ -73,7 +72,7 @@ def install_crowsnest() -> None:
|
||||
Logger.print_info("Installer will prompt you for sudo password!")
|
||||
try:
|
||||
run(
|
||||
f"sudo make install BASE_USER={CURRENT_USER}",
|
||||
"sudo make install",
|
||||
cwd=CROWSNEST_DIR,
|
||||
shell=True,
|
||||
check=True,
|
||||
@@ -135,7 +134,7 @@ def update_crowsnest() -> None:
|
||||
target=CROWSNEST_BACKUP_DIR,
|
||||
)
|
||||
|
||||
git_pull_wrapper(CROWSNEST_REPO, CROWSNEST_DIR)
|
||||
git_pull_wrapper(CROWSNEST_DIR)
|
||||
|
||||
deps = parse_packages_from_file(CROWSNEST_INSTALL_SCRIPT)
|
||||
check_install_dependencies({*deps})
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -13,6 +13,8 @@ from core.backup_manager import BACKUP_ROOT_DIR
|
||||
|
||||
MODULE_PATH = Path(__file__).resolve().parent
|
||||
|
||||
KLIPPER_REPO_URL = "https://github.com/Klipper3d/klipper.git"
|
||||
|
||||
# names
|
||||
KLIPPER_LOG_NAME = "klippy.log"
|
||||
KLIPPER_CFG_NAME = "printer.cfg"
|
||||
@@ -23,6 +25,7 @@ KLIPPER_SERVICE_NAME = "klipper.service"
|
||||
|
||||
# directories
|
||||
KLIPPER_DIR = Path.home().joinpath("klipper")
|
||||
KLIPPER_KCONFIGS_DIR = Path.home().joinpath("klipper-kconfigs")
|
||||
KLIPPER_ENV_DIR = Path.home().joinpath("klippy-env")
|
||||
KLIPPER_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("klipper-backups")
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -11,13 +11,8 @@ import textwrap
|
||||
from enum import Enum, unique
|
||||
from typing import List
|
||||
|
||||
from core.constants import (
|
||||
COLOR_CYAN,
|
||||
COLOR_GREEN,
|
||||
COLOR_YELLOW,
|
||||
RESET_FORMAT,
|
||||
)
|
||||
from core.menus.base_menu import print_back_footer
|
||||
from core.types.color import Color
|
||||
from utils.instance_type import InstanceType
|
||||
|
||||
|
||||
@@ -42,12 +37,12 @@ def print_instance_overview(
|
||||
if display_type is DisplayType.SERVICE_NAME
|
||||
else "printer directories"
|
||||
)
|
||||
headline = f"{COLOR_GREEN}The following {d_type} were found:{RESET_FORMAT}"
|
||||
headline = Color.apply(f"The following {d_type} were found:", Color.GREEN)
|
||||
dialog += f"║{headline:^64}║\n"
|
||||
dialog += "╟───────────────────────────────────────────────────────╢\n"
|
||||
|
||||
if show_select_all:
|
||||
select_all = f"{COLOR_YELLOW}a) Select all{RESET_FORMAT}"
|
||||
select_all = Color.apply("a) Select all", Color.YELLOW)
|
||||
dialog += f"║ {select_all:<63}║\n"
|
||||
dialog += "║ ║\n"
|
||||
|
||||
@@ -56,7 +51,9 @@ def print_instance_overview(
|
||||
name = s.service_file_path.stem
|
||||
else:
|
||||
name = s.data_dir
|
||||
line = f"{COLOR_CYAN}{f'{i + start_index})' if show_index else '●'} {name}{RESET_FORMAT}"
|
||||
line = Color.apply(
|
||||
f"{f'{i + start_index})' if show_index else '●'} {name}", Color.CYAN
|
||||
)
|
||||
dialog += f"║ {line:<63}║\n"
|
||||
dialog += "╟───────────────────────────────────────────────────────╢\n"
|
||||
|
||||
@@ -65,8 +62,10 @@ def print_instance_overview(
|
||||
|
||||
|
||||
def print_select_instance_count_dialog() -> None:
|
||||
line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
|
||||
line2 = f"{COLOR_YELLOW}Setting up too many instances may crash your system.{RESET_FORMAT}"
|
||||
line1 = Color.apply("WARNING:", Color.YELLOW)
|
||||
line2 = Color.apply(
|
||||
"Setting up too many instances may crash your system.", Color.YELLOW
|
||||
)
|
||||
dialog = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
@@ -85,8 +84,8 @@ def print_select_instance_count_dialog() -> None:
|
||||
|
||||
|
||||
def print_select_custom_name_dialog() -> None:
|
||||
line1 = f"{COLOR_YELLOW}INFO:{RESET_FORMAT}"
|
||||
line2 = f"{COLOR_YELLOW}Only alphanumeric characters are allowed!{RESET_FORMAT}"
|
||||
line1 = Color.apply("INFO:", Color.YELLOW)
|
||||
line2 = Color.apply("Only alphanumeric characters are allowed!", Color.YELLOW)
|
||||
dialog = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
|
||||
@@ -1,95 +0,0 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import List
|
||||
|
||||
from components.klipper import KLIPPER_DIR, KLIPPER_ENV_DIR
|
||||
from components.klipper.klipper import Klipper
|
||||
from components.klipper.klipper_dialogs import print_instance_overview
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import Logger
|
||||
from utils.fs_utils import run_remove_routines
|
||||
from utils.input_utils import get_selection_input
|
||||
from utils.instance_utils import get_instances
|
||||
from utils.sys_utils import unit_file_exists
|
||||
|
||||
|
||||
def run_klipper_removal(
|
||||
remove_service: bool,
|
||||
remove_dir: bool,
|
||||
remove_env: bool,
|
||||
) -> None:
|
||||
klipper_instances: List[Klipper] = get_instances(Klipper)
|
||||
|
||||
if remove_service:
|
||||
Logger.print_status("Removing Klipper instances ...")
|
||||
if klipper_instances:
|
||||
instances_to_remove = select_instances_to_remove(klipper_instances)
|
||||
remove_instances(instances_to_remove)
|
||||
else:
|
||||
Logger.print_info("No Klipper Services installed! Skipped ...")
|
||||
|
||||
if (remove_dir or remove_env) and unit_file_exists("klipper", suffix="service"):
|
||||
Logger.print_info("There are still other Klipper services installed:")
|
||||
Logger.print_info(f"● '{KLIPPER_DIR}' was not removed.", prefix=False)
|
||||
Logger.print_info(f"● '{KLIPPER_ENV_DIR}' was not removed.", prefix=False)
|
||||
else:
|
||||
if remove_dir:
|
||||
Logger.print_status("Removing Klipper local repository ...")
|
||||
run_remove_routines(KLIPPER_DIR)
|
||||
if remove_env:
|
||||
Logger.print_status("Removing Klipper Python environment ...")
|
||||
run_remove_routines(KLIPPER_ENV_DIR)
|
||||
|
||||
|
||||
def select_instances_to_remove(instances: List[Klipper]) -> List[Klipper] | None:
|
||||
start_index = 1
|
||||
options = [str(i + start_index) for i in range(len(instances))]
|
||||
options.extend(["a", "b"])
|
||||
instance_map = {options[i]: instances[i] for i in range(len(instances))}
|
||||
|
||||
print_instance_overview(
|
||||
instances,
|
||||
start_index=start_index,
|
||||
show_index=True,
|
||||
show_select_all=True,
|
||||
)
|
||||
selection = get_selection_input("Select Klipper instance to remove", options)
|
||||
|
||||
instances_to_remove = []
|
||||
if selection == "b":
|
||||
return None
|
||||
elif selection == "a":
|
||||
instances_to_remove.extend(instances)
|
||||
else:
|
||||
instances_to_remove.append(instance_map[selection])
|
||||
|
||||
return instances_to_remove
|
||||
|
||||
|
||||
def remove_instances(
|
||||
instance_list: List[Klipper] | None,
|
||||
) -> None:
|
||||
if not instance_list:
|
||||
return
|
||||
|
||||
for instance in instance_list:
|
||||
Logger.print_status(f"Removing instance {instance.service_file_path.stem} ...")
|
||||
InstanceManager.remove(instance)
|
||||
delete_klipper_env_file(instance)
|
||||
|
||||
|
||||
def delete_klipper_env_file(instance: Klipper):
|
||||
Logger.print_status(f"Remove '{instance.env_file}'")
|
||||
if not instance.env_file.exists():
|
||||
msg = f"Env file in {instance.base.sysd_dir} not found. Skipped ..."
|
||||
Logger.print_info(msg)
|
||||
return
|
||||
run_remove_routines(instance.env_file)
|
||||
@@ -1,239 +0,0 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
from __future__ import annotations
|
||||
|
||||
from pathlib import Path
|
||||
from typing import Dict, List, Tuple
|
||||
|
||||
from components.klipper import (
|
||||
EXIT_KLIPPER_SETUP,
|
||||
KLIPPER_DIR,
|
||||
KLIPPER_ENV_DIR,
|
||||
KLIPPER_INSTALL_SCRIPT,
|
||||
KLIPPER_REQ_FILE,
|
||||
)
|
||||
from components.klipper.klipper import Klipper
|
||||
from components.klipper.klipper_dialogs import (
|
||||
print_select_custom_name_dialog,
|
||||
)
|
||||
from components.klipper.klipper_utils import (
|
||||
assign_custom_name,
|
||||
backup_klipper_dir,
|
||||
check_user_groups,
|
||||
create_example_printer_cfg,
|
||||
get_install_count,
|
||||
handle_disruptive_system_packages,
|
||||
)
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from components.webui_client.client_utils import (
|
||||
get_existing_clients,
|
||||
)
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.settings.kiauh_settings import KiauhSettings
|
||||
from utils.common import check_install_dependencies
|
||||
from utils.git_utils import git_clone_wrapper, git_pull_wrapper
|
||||
from utils.input_utils import get_confirm
|
||||
from utils.instance_utils import get_instances
|
||||
from utils.sys_utils import (
|
||||
cmd_sysctl_manage,
|
||||
cmd_sysctl_service,
|
||||
create_python_venv,
|
||||
install_python_requirements,
|
||||
parse_packages_from_file,
|
||||
)
|
||||
|
||||
|
||||
def install_klipper() -> None:
|
||||
Logger.print_status("Installing Klipper ...")
|
||||
|
||||
klipper_list: List[Klipper] = get_instances(Klipper)
|
||||
moonraker_list: List[Moonraker] = get_instances(Moonraker)
|
||||
match_moonraker: bool = False
|
||||
|
||||
# if there are more moonraker instances than klipper instances, ask the user to
|
||||
# match the klipper instance count to the count of moonraker instances with the same suffix
|
||||
if len(moonraker_list) > len(klipper_list):
|
||||
is_confirmed = display_moonraker_info(moonraker_list)
|
||||
if not is_confirmed:
|
||||
Logger.print_status(EXIT_KLIPPER_SETUP)
|
||||
return
|
||||
match_moonraker = True
|
||||
|
||||
install_count, name_dict = get_install_count_and_name_dict(
|
||||
klipper_list, moonraker_list
|
||||
)
|
||||
|
||||
if install_count == 0:
|
||||
Logger.print_status(EXIT_KLIPPER_SETUP)
|
||||
return
|
||||
|
||||
is_multi_install = install_count > 1 or (len(name_dict) >= 1 and install_count >= 1)
|
||||
if not name_dict and install_count == 1:
|
||||
name_dict = {0: ""}
|
||||
elif is_multi_install and not match_moonraker:
|
||||
custom_names = use_custom_names_or_go_back()
|
||||
if custom_names is None:
|
||||
Logger.print_status(EXIT_KLIPPER_SETUP)
|
||||
return
|
||||
|
||||
handle_instance_names(install_count, name_dict, custom_names)
|
||||
|
||||
create_example_cfg = get_confirm("Create example printer.cfg?")
|
||||
# run the actual installation
|
||||
try:
|
||||
run_klipper_setup(klipper_list, name_dict, create_example_cfg)
|
||||
except Exception as e:
|
||||
Logger.print_error(e)
|
||||
Logger.print_error("Klipper installation failed!")
|
||||
return
|
||||
|
||||
|
||||
def run_klipper_setup(
|
||||
klipper_list: List[Klipper], name_dict: Dict[int, str], create_example_cfg: bool
|
||||
) -> None:
|
||||
if not klipper_list:
|
||||
setup_klipper_prerequesites()
|
||||
|
||||
for i in name_dict:
|
||||
# skip this iteration if there is already an instance with the name
|
||||
if name_dict[i] in [n.suffix for n in klipper_list]:
|
||||
continue
|
||||
|
||||
instance = Klipper(suffix=name_dict[i])
|
||||
instance.create()
|
||||
cmd_sysctl_service(instance.service_file_path.name, "enable")
|
||||
|
||||
if create_example_cfg:
|
||||
# if a client-config is installed, include it in the new example cfg
|
||||
clients = get_existing_clients()
|
||||
create_example_printer_cfg(instance, clients)
|
||||
|
||||
cmd_sysctl_service(instance.service_file_path.name, "start")
|
||||
|
||||
cmd_sysctl_manage("daemon-reload")
|
||||
|
||||
# step 4: check/handle conflicting packages/services
|
||||
handle_disruptive_system_packages()
|
||||
|
||||
# step 5: check for required group membership
|
||||
check_user_groups()
|
||||
|
||||
|
||||
def handle_instance_names(
|
||||
install_count: int, name_dict: Dict[int, str], custom_names: bool
|
||||
) -> None:
|
||||
for i in range(install_count): # 3
|
||||
key: int = len(name_dict.keys()) + 1
|
||||
if custom_names:
|
||||
assign_custom_name(key, name_dict)
|
||||
else:
|
||||
name_dict[key] = str(len(name_dict) + 1)
|
||||
|
||||
|
||||
def get_install_count_and_name_dict(
|
||||
klipper_list: List[Klipper], moonraker_list: List[Moonraker]
|
||||
) -> Tuple[int, Dict[int, str]]:
|
||||
install_count: int | None
|
||||
if len(moonraker_list) > len(klipper_list):
|
||||
install_count = len(moonraker_list)
|
||||
name_dict = {i: moonraker.suffix for i, moonraker in enumerate(moonraker_list)}
|
||||
else:
|
||||
install_count = get_install_count()
|
||||
name_dict = {i: klipper.suffix for i, klipper in enumerate(klipper_list)}
|
||||
|
||||
if install_count is None:
|
||||
Logger.print_status(EXIT_KLIPPER_SETUP)
|
||||
return 0, {}
|
||||
|
||||
return install_count, name_dict
|
||||
|
||||
|
||||
def setup_klipper_prerequesites() -> None:
|
||||
settings = KiauhSettings()
|
||||
repo = settings.klipper.repo_url
|
||||
branch = settings.klipper.branch
|
||||
|
||||
git_clone_wrapper(repo, KLIPPER_DIR, branch)
|
||||
|
||||
# install klipper dependencies and create python virtualenv
|
||||
try:
|
||||
install_klipper_packages()
|
||||
if create_python_venv(KLIPPER_ENV_DIR):
|
||||
install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
|
||||
except Exception:
|
||||
Logger.print_error("Error during installation of Klipper requirements!")
|
||||
raise
|
||||
|
||||
|
||||
def install_klipper_packages() -> None:
|
||||
script = KLIPPER_INSTALL_SCRIPT
|
||||
packages = parse_packages_from_file(script)
|
||||
|
||||
# Add dbus requirement for DietPi distro
|
||||
if Path("/boot/dietpi/.version").exists():
|
||||
packages.append("dbus")
|
||||
|
||||
check_install_dependencies({*packages})
|
||||
|
||||
|
||||
def update_klipper() -> None:
|
||||
Logger.print_dialog(
|
||||
DialogType.WARNING,
|
||||
[
|
||||
"Do NOT continue if there are ongoing prints running!",
|
||||
"All Klipper instances will be restarted during the update process and "
|
||||
"ongoing prints WILL FAIL.",
|
||||
],
|
||||
)
|
||||
|
||||
if not get_confirm("Update Klipper now?"):
|
||||
return
|
||||
|
||||
settings = KiauhSettings()
|
||||
if settings.kiauh.backup_before_update:
|
||||
backup_klipper_dir()
|
||||
|
||||
instances = get_instances(Klipper)
|
||||
InstanceManager.stop_all(instances)
|
||||
|
||||
git_pull_wrapper(repo=settings.klipper.repo_url, target_dir=KLIPPER_DIR)
|
||||
|
||||
# install possible new system packages
|
||||
install_klipper_packages()
|
||||
# install possible new python dependencies
|
||||
install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
|
||||
|
||||
InstanceManager.start_all(instances)
|
||||
|
||||
|
||||
def use_custom_names_or_go_back() -> bool | None:
|
||||
print_select_custom_name_dialog()
|
||||
_input: bool | None = get_confirm(
|
||||
"Assign custom names?",
|
||||
False,
|
||||
allow_go_back=True,
|
||||
)
|
||||
return _input
|
||||
|
||||
|
||||
def display_moonraker_info(moonraker_list: List[Moonraker]) -> bool:
|
||||
# todo: only show the klipper instances that are not already installed
|
||||
Logger.print_dialog(
|
||||
DialogType.INFO,
|
||||
[
|
||||
"Existing Moonraker instances detected:",
|
||||
*[f"● {m.service_file_path.stem}" for m in moonraker_list],
|
||||
"\n\n",
|
||||
"The following Klipper instances will be installed:",
|
||||
*[f"● klipper-{m.suffix}" for m in moonraker_list],
|
||||
],
|
||||
)
|
||||
_input: bool = get_confirm("Proceed with installation?")
|
||||
return _input
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -11,6 +11,7 @@ from __future__ import annotations
|
||||
import grp
|
||||
import os
|
||||
import shutil
|
||||
from pathlib import Path
|
||||
from subprocess import CalledProcessError, run
|
||||
from typing import Dict, List
|
||||
|
||||
@@ -18,6 +19,7 @@ from components.klipper import (
|
||||
KLIPPER_BACKUP_DIR,
|
||||
KLIPPER_DIR,
|
||||
KLIPPER_ENV_DIR,
|
||||
KLIPPER_INSTALL_SCRIPT,
|
||||
MODULE_PATH,
|
||||
)
|
||||
from components.klipper.klipper import Klipper
|
||||
@@ -36,11 +38,16 @@ from core.logger import DialogType, Logger
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from core.types import ComponentStatus
|
||||
from utils.common import get_install_status
|
||||
from core.types.component_status import ComponentStatus
|
||||
from utils.common import check_install_dependencies, get_install_status
|
||||
from utils.fs_utils import check_file_exist
|
||||
from utils.input_utils import get_confirm, get_number_input, get_string_input
|
||||
from utils.instance_utils import get_instances
|
||||
from utils.sys_utils import cmd_sysctl_service
|
||||
from utils.sys_utils import (
|
||||
cmd_sysctl_service,
|
||||
install_python_packages,
|
||||
parse_packages_from_file,
|
||||
)
|
||||
|
||||
|
||||
def get_klipper_status() -> ComponentStatus:
|
||||
@@ -194,3 +201,56 @@ 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)
|
||||
|
||||
|
||||
def install_klipper_packages() -> None:
|
||||
script = KLIPPER_INSTALL_SCRIPT
|
||||
packages = parse_packages_from_file(script)
|
||||
|
||||
# Add pkg-config for rp2040 build
|
||||
packages.append("pkg-config")
|
||||
|
||||
# Add dbus requirement for DietPi distro
|
||||
if check_file_exist(Path("/boot/dietpi/.version")):
|
||||
packages.append("dbus")
|
||||
|
||||
check_install_dependencies({*packages})
|
||||
|
||||
|
||||
def install_input_shaper_deps() -> None:
|
||||
if not KLIPPER_ENV_DIR.exists():
|
||||
Logger.print_warn("Required Klipper python environment not found!")
|
||||
return
|
||||
|
||||
Logger.print_dialog(
|
||||
DialogType.CUSTOM,
|
||||
[
|
||||
"Resonance measurements and shaper auto-calibration require additional "
|
||||
"software dependencies which are not installed by default. "
|
||||
"If you agree, the following additional system packages will be installed:",
|
||||
"● python3-numpy",
|
||||
"● python3-matplotlib",
|
||||
"● libatlas-base-dev",
|
||||
"● libopenblas-dev",
|
||||
"\n\n",
|
||||
"Also, the following Python package will be installed:",
|
||||
"● numpy",
|
||||
],
|
||||
custom_title="Install Input Shaper Dependencies",
|
||||
)
|
||||
if not get_confirm(
|
||||
"Do you want to install the required packages?", default_choice=False
|
||||
):
|
||||
return
|
||||
|
||||
apt_deps = (
|
||||
"python3-numpy",
|
||||
"python3-matplotlib",
|
||||
"libatlas-base-dev",
|
||||
"libopenblas-dev",
|
||||
)
|
||||
check_install_dependencies({*apt_deps})
|
||||
|
||||
py_deps = ("numpy",)
|
||||
|
||||
install_python_packages(KLIPPER_ENV_DIR, {*py_deps})
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -11,22 +11,28 @@ from __future__ import annotations
|
||||
import textwrap
|
||||
from typing import Type
|
||||
|
||||
from components.klipper import klipper_remove
|
||||
from core.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
|
||||
from components.klipper.services.klipper_setup_service import KlipperSetupService
|
||||
from core.menus import FooterType, Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.types.color import Color
|
||||
|
||||
|
||||
# noinspection PyUnusedLocal
|
||||
class KlipperRemoveMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None):
|
||||
super().__init__()
|
||||
|
||||
self.title = "Remove Klipper"
|
||||
self.title_color = Color.RED
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
self.footer_type = FooterType.BACK
|
||||
self.remove_klipper_service = False
|
||||
self.remove_klipper_dir = False
|
||||
self.remove_klipper_env = False
|
||||
self.selection_state = False
|
||||
|
||||
self.rm_svc = False
|
||||
self.rm_dir = False
|
||||
self.rm_env = False
|
||||
self.select_state = False
|
||||
|
||||
self.klsvc = KlipperSetupService()
|
||||
|
||||
def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
|
||||
from core.menus.remove_menu import RemoveMenu
|
||||
@@ -43,23 +49,19 @@ class KlipperRemoveMenu(BaseMenu):
|
||||
}
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = " [ Remove Klipper ] "
|
||||
color = COLOR_RED
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
checked = f"[{COLOR_CYAN}x{RESET_FORMAT}]"
|
||||
checked = f"[{Color.apply('x', Color.CYAN)}]"
|
||||
unchecked = "[ ]"
|
||||
o1 = checked if self.remove_klipper_service else unchecked
|
||||
o2 = checked if self.remove_klipper_dir else unchecked
|
||||
o3 = checked if self.remove_klipper_env else unchecked
|
||||
o1 = checked if self.rm_svc else unchecked
|
||||
o2 = checked if self.rm_dir else unchecked
|
||||
o3 = checked if self.rm_env else unchecked
|
||||
sel_state = f"{'Select' if not self.select_state else 'Deselect'} everything"
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ Enter a number and hit enter to select / deselect ║
|
||||
║ the specific option for removal. ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ a) {self._get_selection_state_str():37} ║
|
||||
║ a) {sel_state:49} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ 1) {o1} Remove Service ║
|
||||
║ 2) {o2} Remove Local Repository ║
|
||||
@@ -72,47 +74,29 @@ class KlipperRemoveMenu(BaseMenu):
|
||||
print(menu, end="")
|
||||
|
||||
def toggle_all(self, **kwargs) -> None:
|
||||
self.selection_state = not self.selection_state
|
||||
self.remove_klipper_service = self.selection_state
|
||||
self.remove_klipper_dir = self.selection_state
|
||||
self.remove_klipper_env = self.selection_state
|
||||
self.select_state = not self.select_state
|
||||
self.rm_svc = self.select_state
|
||||
self.rm_dir = self.select_state
|
||||
self.rm_env = self.select_state
|
||||
|
||||
def toggle_remove_klipper_service(self, **kwargs) -> None:
|
||||
self.remove_klipper_service = not self.remove_klipper_service
|
||||
self.rm_svc = not self.rm_svc
|
||||
|
||||
def toggle_remove_klipper_dir(self, **kwargs) -> None:
|
||||
self.remove_klipper_dir = not self.remove_klipper_dir
|
||||
self.rm_dir = not self.rm_dir
|
||||
|
||||
def toggle_remove_klipper_env(self, **kwargs) -> None:
|
||||
self.remove_klipper_env = not self.remove_klipper_env
|
||||
self.rm_env = not self.rm_env
|
||||
|
||||
def run_removal_process(self, **kwargs) -> None:
|
||||
if (
|
||||
not self.remove_klipper_service
|
||||
and not self.remove_klipper_dir
|
||||
and not self.remove_klipper_env
|
||||
):
|
||||
error = f"{COLOR_RED}Nothing selected! Select options to remove first.{RESET_FORMAT}"
|
||||
print(error)
|
||||
if not self.rm_svc and not self.rm_dir and not self.rm_env:
|
||||
msg = "Nothing selected! Select options to remove first."
|
||||
print(Color.apply(msg, Color.RED))
|
||||
return
|
||||
|
||||
klipper_remove.run_klipper_removal(
|
||||
self.remove_klipper_service,
|
||||
self.remove_klipper_dir,
|
||||
self.remove_klipper_env,
|
||||
)
|
||||
self.klsvc.remove(self.rm_svc, self.rm_dir, self.rm_env)
|
||||
|
||||
self.remove_klipper_service = False
|
||||
self.remove_klipper_dir = False
|
||||
self.remove_klipper_env = False
|
||||
|
||||
self._go_back()
|
||||
|
||||
def _get_selection_state_str(self) -> str:
|
||||
return (
|
||||
"Select everything" if not self.selection_state else "Deselect everything"
|
||||
)
|
||||
|
||||
def _go_back(self, **kwargs) -> None:
|
||||
if self.previous_menu is not None:
|
||||
self.previous_menu().run()
|
||||
self.rm_svc = False
|
||||
self.rm_dir = False
|
||||
self.rm_env = False
|
||||
self.select_state = False
|
||||
|
||||
0
kiauh/components/klipper/services/__init__.py
Normal file
0
kiauh/components/klipper/services/__init__.py
Normal file
@@ -0,0 +1,46 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import List
|
||||
|
||||
from components.klipper.klipper import Klipper
|
||||
from utils.instance_utils import get_instances
|
||||
|
||||
|
||||
class KlipperInstanceService:
|
||||
__cls_instance = None
|
||||
__instances: List[Klipper] = []
|
||||
|
||||
def __new__(cls) -> "KlipperInstanceService":
|
||||
if cls.__cls_instance is None:
|
||||
cls.__cls_instance = super(KlipperInstanceService, cls).__new__(cls)
|
||||
return cls.__cls_instance
|
||||
|
||||
def __init__(self) -> None:
|
||||
if not hasattr(self, "__initialized"):
|
||||
self.__initialized = False
|
||||
if self.__initialized:
|
||||
return
|
||||
self.__initialized = True
|
||||
|
||||
def load_instances(self) -> None:
|
||||
self.__instances = get_instances(Klipper)
|
||||
|
||||
def create_new_instance(self, suffix: str) -> Klipper:
|
||||
instance = Klipper(suffix)
|
||||
self.__instances.append(instance)
|
||||
return instance
|
||||
|
||||
def get_all_instances(self) -> List[Klipper]:
|
||||
return self.__instances
|
||||
|
||||
def get_instance_by_suffix(self, suffix: str) -> Klipper | None:
|
||||
instances: List[Klipper] = [i for i in self.__instances if i.suffix == suffix]
|
||||
return instances[0] if instances else None
|
||||
366
kiauh/components/klipper/services/klipper_setup_service.py
Normal file
366
kiauh/components/klipper/services/klipper_setup_service.py
Normal file
@@ -0,0 +1,366 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
from __future__ import annotations
|
||||
|
||||
from copy import copy
|
||||
from typing import Dict, List, Tuple
|
||||
|
||||
from components.klipper import (
|
||||
EXIT_KLIPPER_SETUP,
|
||||
KLIPPER_DIR,
|
||||
KLIPPER_ENV_DIR,
|
||||
KLIPPER_REPO_URL,
|
||||
KLIPPER_REQ_FILE,
|
||||
)
|
||||
from components.klipper.klipper import Klipper
|
||||
from components.klipper.klipper_dialogs import (
|
||||
print_instance_overview,
|
||||
print_select_custom_name_dialog,
|
||||
)
|
||||
from components.klipper.klipper_utils import (
|
||||
assign_custom_name,
|
||||
backup_klipper_dir,
|
||||
check_user_groups,
|
||||
create_example_printer_cfg,
|
||||
get_install_count,
|
||||
handle_disruptive_system_packages,
|
||||
install_klipper_packages,
|
||||
)
|
||||
from components.klipper.services.klipper_instance_service import KlipperInstanceService
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from components.moonraker.services.moonraker_instance_service import (
|
||||
MoonrakerInstanceService,
|
||||
)
|
||||
from components.webui_client.client_utils import (
|
||||
get_existing_clients,
|
||||
)
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.message_service import Message, MessageService
|
||||
from core.settings.kiauh_settings import KiauhSettings
|
||||
from core.types.color import Color
|
||||
from utils.fs_utils import run_remove_routines
|
||||
from utils.git_utils import git_clone_wrapper, git_pull_wrapper
|
||||
from utils.input_utils import get_confirm, get_selection_input
|
||||
from utils.sys_utils import (
|
||||
cmd_sysctl_manage,
|
||||
create_python_venv,
|
||||
install_python_requirements,
|
||||
unit_file_exists,
|
||||
)
|
||||
|
||||
|
||||
# noinspection PyMethodMayBeStatic
|
||||
class KlipperSetupService:
|
||||
__cls_instance = None
|
||||
|
||||
kisvc: KlipperInstanceService
|
||||
misvc: MoonrakerInstanceService
|
||||
msgsvc = MessageService
|
||||
|
||||
settings: KiauhSettings
|
||||
klipper_list: List[Klipper]
|
||||
moonraker_list: List[Moonraker]
|
||||
|
||||
def __new__(cls) -> "KlipperSetupService":
|
||||
if cls.__cls_instance is None:
|
||||
cls.__cls_instance = super(KlipperSetupService, cls).__new__(cls)
|
||||
return cls.__cls_instance
|
||||
|
||||
def __init__(self) -> None:
|
||||
if not hasattr(self, "__initialized"):
|
||||
self.__initialized = False
|
||||
if self.__initialized:
|
||||
return
|
||||
self.__initialized = True
|
||||
self.__init_state()
|
||||
|
||||
def __init_state(self) -> None:
|
||||
self.settings = KiauhSettings()
|
||||
|
||||
self.kisvc = KlipperInstanceService()
|
||||
self.kisvc.load_instances()
|
||||
self.klipper_list = self.kisvc.get_all_instances()
|
||||
|
||||
self.misvc = MoonrakerInstanceService()
|
||||
self.misvc.load_instances()
|
||||
self.moonraker_list = self.misvc.get_all_instances()
|
||||
|
||||
self.msgsvc = MessageService()
|
||||
|
||||
def __refresh_state(self) -> None:
|
||||
self.kisvc.load_instances()
|
||||
self.klipper_list = self.kisvc.get_all_instances()
|
||||
|
||||
self.misvc.load_instances()
|
||||
self.moonraker_list = self.misvc.get_all_instances()
|
||||
|
||||
def install(self) -> None:
|
||||
self.__refresh_state()
|
||||
|
||||
Logger.print_status("Installing Klipper ...")
|
||||
|
||||
match_moonraker: bool = False
|
||||
|
||||
# if there are more moonraker instances than klipper instances, ask the user to
|
||||
# match the klipper instance count to the count of moonraker instances with the same suffix
|
||||
if len(self.moonraker_list) > len(self.klipper_list):
|
||||
is_confirmed = self.__display_moonraker_info()
|
||||
if not is_confirmed:
|
||||
Logger.print_status(EXIT_KLIPPER_SETUP)
|
||||
return
|
||||
match_moonraker = True
|
||||
|
||||
install_count, name_dict = self.__get_install_count_and_name_dict()
|
||||
|
||||
if install_count == 0:
|
||||
Logger.print_status(EXIT_KLIPPER_SETUP)
|
||||
return
|
||||
|
||||
is_multi_install = install_count > 1 or (
|
||||
len(name_dict) >= 1 and install_count >= 1
|
||||
)
|
||||
if not name_dict and install_count == 1:
|
||||
name_dict = {0: ""}
|
||||
elif is_multi_install and not match_moonraker:
|
||||
custom_names = self.__use_custom_names_or_go_back()
|
||||
if custom_names is None:
|
||||
Logger.print_status(EXIT_KLIPPER_SETUP)
|
||||
return
|
||||
|
||||
self.__handle_instance_names(install_count, name_dict, custom_names)
|
||||
|
||||
create_example_cfg = get_confirm("Create example printer.cfg?")
|
||||
# run the actual installation
|
||||
try:
|
||||
self.__run_setup(name_dict, create_example_cfg)
|
||||
except Exception as e:
|
||||
Logger.print_error(e)
|
||||
Logger.print_error("Klipper installation failed!")
|
||||
return
|
||||
|
||||
def update(self) -> None:
|
||||
Logger.print_dialog(
|
||||
DialogType.WARNING,
|
||||
[
|
||||
"Do NOT continue if there are ongoing prints running!",
|
||||
"All Klipper instances will be restarted during the update process and "
|
||||
"ongoing prints WILL FAIL.",
|
||||
],
|
||||
)
|
||||
|
||||
if not get_confirm("Update Klipper now?"):
|
||||
return
|
||||
|
||||
self.__refresh_state()
|
||||
|
||||
if self.settings.kiauh.backup_before_update:
|
||||
backup_klipper_dir()
|
||||
|
||||
InstanceManager.stop_all(self.klipper_list)
|
||||
git_pull_wrapper(KLIPPER_DIR)
|
||||
install_klipper_packages()
|
||||
install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
|
||||
InstanceManager.start_all(self.klipper_list)
|
||||
|
||||
def remove(
|
||||
self,
|
||||
remove_service: bool,
|
||||
remove_dir: bool,
|
||||
remove_env: bool,
|
||||
) -> None:
|
||||
self.__refresh_state()
|
||||
|
||||
completion_msg = Message(
|
||||
title="Klipper Removal Process completed",
|
||||
color=Color.GREEN,
|
||||
)
|
||||
|
||||
if remove_service:
|
||||
Logger.print_status("Removing Klipper instances ...")
|
||||
if self.klipper_list:
|
||||
instances_to_remove = self.__get_instances_to_remove()
|
||||
self.__remove_instances(instances_to_remove)
|
||||
if instances_to_remove:
|
||||
instance_names = [
|
||||
i.service_file_path.stem for i in instances_to_remove
|
||||
]
|
||||
txt = f"● Klipper instances removed: {', '.join(instance_names)}"
|
||||
completion_msg.text.append(txt)
|
||||
else:
|
||||
Logger.print_info("No Klipper Services installed! Skipped ...")
|
||||
|
||||
if (remove_dir or remove_env) and unit_file_exists("klipper", suffix="service"):
|
||||
completion_msg.text = [
|
||||
"Some Klipper services are still installed:",
|
||||
f"● '{KLIPPER_DIR}' was not removed, even though selected for removal.",
|
||||
f"● '{KLIPPER_ENV_DIR}' was not removed, even though selected for removal.",
|
||||
]
|
||||
else:
|
||||
if remove_dir:
|
||||
Logger.print_status("Removing Klipper local repository ...")
|
||||
if run_remove_routines(KLIPPER_DIR):
|
||||
completion_msg.text.append("● Klipper local repository removed")
|
||||
if remove_env:
|
||||
Logger.print_status("Removing Klipper Python environment ...")
|
||||
if run_remove_routines(KLIPPER_ENV_DIR):
|
||||
completion_msg.text.append("● Klipper Python environment removed")
|
||||
|
||||
if completion_msg.text:
|
||||
completion_msg.text.insert(0, "The following actions were performed:")
|
||||
else:
|
||||
completion_msg.color = Color.YELLOW
|
||||
completion_msg.centered = True
|
||||
completion_msg.text = ["Nothing to remove."]
|
||||
|
||||
self.msgsvc.set_message(completion_msg)
|
||||
|
||||
def __get_install_count_and_name_dict(self) -> Tuple[int, Dict[int, str]]:
|
||||
install_count: int | None
|
||||
if len(self.moonraker_list) > len(self.klipper_list):
|
||||
install_count = len(self.moonraker_list)
|
||||
name_dict = {
|
||||
i: moonraker.suffix for i, moonraker in enumerate(self.moonraker_list)
|
||||
}
|
||||
else:
|
||||
install_count = get_install_count()
|
||||
name_dict = {
|
||||
i: klipper.suffix for i, klipper in enumerate(self.klipper_list)
|
||||
}
|
||||
|
||||
if install_count is None:
|
||||
Logger.print_status(EXIT_KLIPPER_SETUP)
|
||||
return 0, {}
|
||||
|
||||
return install_count, name_dict
|
||||
|
||||
def __run_setup(self, name_dict: Dict[int, str], create_example_cfg: bool) -> None:
|
||||
if not self.klipper_list:
|
||||
self.__install_deps()
|
||||
|
||||
for i in name_dict:
|
||||
# skip this iteration if there is already an instance with the name
|
||||
if name_dict[i] in [n.suffix for n in self.klipper_list]:
|
||||
continue
|
||||
|
||||
instance = Klipper(suffix=name_dict[i])
|
||||
instance.create()
|
||||
InstanceManager.enable(instance)
|
||||
|
||||
if create_example_cfg:
|
||||
# if a client-config is installed, include it in the new example cfg
|
||||
clients = get_existing_clients()
|
||||
create_example_printer_cfg(instance, clients)
|
||||
|
||||
InstanceManager.start(instance)
|
||||
|
||||
cmd_sysctl_manage("daemon-reload")
|
||||
|
||||
# step 4: check/handle conflicting packages/services
|
||||
handle_disruptive_system_packages()
|
||||
|
||||
# step 5: check for required group membership
|
||||
check_user_groups()
|
||||
|
||||
def __install_deps(self) -> None:
|
||||
default_repo = (KLIPPER_REPO_URL, "master")
|
||||
repo = self.settings.klipper.repositories
|
||||
# pull the first repo defined in kiauh.cfg or fallback to the official Klipper repo
|
||||
repo, branch = (repo[0].url, repo[0].branch) if repo else default_repo
|
||||
git_clone_wrapper(repo, KLIPPER_DIR, branch)
|
||||
|
||||
try:
|
||||
install_klipper_packages()
|
||||
if create_python_venv(KLIPPER_ENV_DIR, False, False, self.settings.klipper.use_python_binary):
|
||||
install_python_requirements(KLIPPER_ENV_DIR, KLIPPER_REQ_FILE)
|
||||
except Exception:
|
||||
Logger.print_error("Error during installation of Klipper requirements!")
|
||||
raise
|
||||
|
||||
def __display_moonraker_info(self) -> bool:
|
||||
# todo: only show the klipper instances that are not already installed
|
||||
Logger.print_dialog(
|
||||
DialogType.INFO,
|
||||
[
|
||||
"Existing Moonraker instances detected:",
|
||||
*[f"● {m.service_file_path.stem}" for m in self.moonraker_list],
|
||||
"\n\n",
|
||||
"The following Klipper instances will be installed:",
|
||||
*[f"● klipper-{m.suffix}" for m in self.moonraker_list],
|
||||
],
|
||||
)
|
||||
_input: bool = get_confirm("Proceed with installation?")
|
||||
return _input
|
||||
|
||||
def __handle_instance_names(
|
||||
self, install_count: int, name_dict: Dict[int, str], custom_names: bool
|
||||
) -> None:
|
||||
for i in range(install_count): # 3
|
||||
key: int = len(name_dict.keys()) + 1
|
||||
if custom_names:
|
||||
assign_custom_name(key, name_dict)
|
||||
else:
|
||||
name_dict[key] = str(len(name_dict) + 1)
|
||||
|
||||
def __use_custom_names_or_go_back(self) -> bool | None:
|
||||
print_select_custom_name_dialog()
|
||||
_input: bool | None = get_confirm(
|
||||
"Assign custom names?",
|
||||
False,
|
||||
allow_go_back=True,
|
||||
)
|
||||
return _input
|
||||
|
||||
def __get_instances_to_remove(self) -> List[Klipper] | None:
|
||||
start_index = 1
|
||||
curr_instances: List[Klipper] = self.klipper_list
|
||||
instance_count = len(curr_instances)
|
||||
|
||||
options = [str(i + start_index) for i in range(instance_count)]
|
||||
options.extend(["a", "b"])
|
||||
instance_map = {options[i]: self.klipper_list[i] for i in range(instance_count)}
|
||||
|
||||
print_instance_overview(
|
||||
self.klipper_list,
|
||||
start_index=start_index,
|
||||
show_index=True,
|
||||
show_select_all=True,
|
||||
)
|
||||
selection = get_selection_input("Select Klipper instance to remove", options)
|
||||
|
||||
if selection == "b":
|
||||
return None
|
||||
elif selection == "a":
|
||||
return copy(self.klipper_list)
|
||||
|
||||
return [instance_map[selection]]
|
||||
|
||||
def __remove_instances(
|
||||
self,
|
||||
instance_list: List[Klipper] | None,
|
||||
) -> None:
|
||||
if not instance_list:
|
||||
return
|
||||
|
||||
for instance in instance_list:
|
||||
Logger.print_status(
|
||||
f"Removing instance {instance.service_file_path.stem} ..."
|
||||
)
|
||||
InstanceManager.remove(instance)
|
||||
self.__delete_klipper_env_file(instance)
|
||||
|
||||
self.__refresh_state()
|
||||
|
||||
def __delete_klipper_env_file(self, instance: Klipper):
|
||||
Logger.print_status(f"Remove '{instance.env_file}'")
|
||||
if not instance.env_file.exists():
|
||||
msg = f"Env file in {instance.base.sysd_dir} not found. Skipped ..."
|
||||
Logger.print_info(msg)
|
||||
return
|
||||
run_remove_routines(instance.env_file)
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -7,6 +7,7 @@
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
import re
|
||||
from pathlib import Path
|
||||
from subprocess import (
|
||||
DEVNULL,
|
||||
PIPE,
|
||||
@@ -138,6 +139,7 @@ def start_flash_process(flash_options: FlashOptions) -> None:
|
||||
if flash_options.flash_method is FlashMethod.REGULAR:
|
||||
cmd = [
|
||||
"make",
|
||||
f"KCONFIG_CONFIG={flash_options.selected_kconfig}",
|
||||
flash_options.flash_command.value,
|
||||
f"FLASH_DEVICE={flash_options.selected_mcu}",
|
||||
]
|
||||
@@ -165,17 +167,17 @@ def start_flash_process(flash_options: FlashOptions) -> None:
|
||||
if rc != 0:
|
||||
raise Exception(f"Flashing failed with returncode: {rc}")
|
||||
else:
|
||||
Logger.print_ok("Flashing successfull!", start="\n", end="\n\n")
|
||||
Logger.print_ok("Flashing successful!", start="\n", end="\n\n")
|
||||
|
||||
except (Exception, CalledProcessError):
|
||||
Logger.print_error("Flashing failed!", start="\n")
|
||||
Logger.print_error("See the console output above!", end="\n\n")
|
||||
|
||||
|
||||
def run_make_clean() -> None:
|
||||
def run_make_clean(kconfig=Path(KLIPPER_DIR.joinpath(".config"))) -> None:
|
||||
try:
|
||||
run(
|
||||
"make clean",
|
||||
f"make KCONFIG_CONFIG={kconfig} clean",
|
||||
cwd=KLIPPER_DIR,
|
||||
shell=True,
|
||||
check=True,
|
||||
@@ -185,10 +187,10 @@ def run_make_clean() -> None:
|
||||
raise
|
||||
|
||||
|
||||
def run_make_menuconfig() -> None:
|
||||
def run_make_menuconfig(kconfig=Path(KLIPPER_DIR.joinpath(".config"))) -> None:
|
||||
try:
|
||||
run(
|
||||
"make PYTHON=python3 menuconfig",
|
||||
f"make PYTHON=python3 KCONFIG_CONFIG={kconfig} menuconfig",
|
||||
cwd=KLIPPER_DIR,
|
||||
shell=True,
|
||||
check=True,
|
||||
@@ -198,10 +200,10 @@ def run_make_menuconfig() -> None:
|
||||
raise
|
||||
|
||||
|
||||
def run_make() -> None:
|
||||
def run_make(kconfig=Path(KLIPPER_DIR.joinpath(".config"))) -> None:
|
||||
try:
|
||||
run(
|
||||
"make PYTHON=python3",
|
||||
f"make PYTHON=python3 KCONFIG_CONFIG={kconfig}",
|
||||
cwd=KLIPPER_DIR,
|
||||
shell=True,
|
||||
check=True,
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -39,6 +39,7 @@ class FlashOptions:
|
||||
_selected_mcu: str = ""
|
||||
_selected_board: str = ""
|
||||
_selected_baudrate: int = 250000
|
||||
_selected_kconfig: str = ".config"
|
||||
|
||||
def __new__(cls, *args, **kwargs):
|
||||
if not cls._instance:
|
||||
@@ -104,3 +105,11 @@ class FlashOptions:
|
||||
@selected_baudrate.setter
|
||||
def selected_baudrate(self, value: int) -> None:
|
||||
self._selected_baudrate = value
|
||||
|
||||
@property
|
||||
def selected_kconfig(self) -> str:
|
||||
return self._selected_kconfig
|
||||
|
||||
@selected_kconfig.setter
|
||||
def selected_kconfig(self, value: str) -> None:
|
||||
self._selected_kconfig = value
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -9,18 +9,22 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import textwrap
|
||||
from pathlib import Path
|
||||
from shutil import copyfile
|
||||
from typing import List, Set, Type
|
||||
|
||||
from components.klipper import KLIPPER_DIR
|
||||
from components.klipper import KLIPPER_DIR, KLIPPER_KCONFIGS_DIR
|
||||
from components.klipper_firmware.firmware_utils import (
|
||||
run_make,
|
||||
run_make_clean,
|
||||
run_make_menuconfig,
|
||||
)
|
||||
from core.constants import COLOR_CYAN, COLOR_GREEN, COLOR_RED, RESET_FORMAT
|
||||
from core.logger import Logger
|
||||
from components.klipper_firmware.flash_options import FlashOptions
|
||||
from core.logger import DialogType, Logger
|
||||
from core.menus import Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.types.color import Color
|
||||
from utils.input_utils import get_confirm, get_string_input
|
||||
from utils.sys_utils import (
|
||||
check_package_install,
|
||||
install_system_packages,
|
||||
@@ -30,12 +34,25 @@ from utils.sys_utils import (
|
||||
|
||||
# noinspection PyUnusedLocal
|
||||
# noinspection PyMethodMayBeStatic
|
||||
class KlipperBuildFirmwareMenu(BaseMenu):
|
||||
class KlipperKConfigMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None):
|
||||
super().__init__()
|
||||
self.title = "Firmware Config Menu"
|
||||
self.title_color = Color.CYAN
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
self.deps: Set[str] = {"build-essential", "dpkg-dev", "make"}
|
||||
self.missing_deps: List[str] = check_package_install(self.deps)
|
||||
self.flash_options = FlashOptions()
|
||||
self.kconfigs_dirname = KLIPPER_KCONFIGS_DIR
|
||||
self.kconfig_default = KLIPPER_DIR.joinpath(".config")
|
||||
self.configs: List[Path] = []
|
||||
self.kconfig = (
|
||||
self.kconfig_default if not Path(self.kconfigs_dirname).is_dir() else None
|
||||
)
|
||||
|
||||
def run(self) -> None:
|
||||
if not self.kconfig:
|
||||
super().run()
|
||||
else:
|
||||
self.flash_options.selected_kconfig = self.kconfig
|
||||
|
||||
def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
|
||||
from core.menus.advanced_menu import AdvancedMenu
|
||||
@@ -45,21 +62,107 @@ class KlipperBuildFirmwareMenu(BaseMenu):
|
||||
)
|
||||
|
||||
def set_options(self) -> None:
|
||||
if len(self.missing_deps) == 0:
|
||||
self.input_label_txt = "Press ENTER to continue"
|
||||
self.default_option = Option(method=self.start_build_process)
|
||||
else:
|
||||
self.input_label_txt = "Press ENTER to install dependencies"
|
||||
self.default_option = Option(method=self.install_missing_deps)
|
||||
if not Path(self.kconfigs_dirname).is_dir():
|
||||
return
|
||||
|
||||
self.input_label_txt = "Select config or action to continue (default=N)"
|
||||
self.default_option = Option(
|
||||
method=self.select_config, opt_data=self.kconfig_default
|
||||
)
|
||||
|
||||
option_index = 1
|
||||
for kconfig in Path(self.kconfigs_dirname).iterdir():
|
||||
if not kconfig.name.endswith(".config"):
|
||||
continue
|
||||
kconfig_path = self.kconfigs_dirname.joinpath(kconfig)
|
||||
if Path(kconfig_path).is_file():
|
||||
self.configs += [kconfig]
|
||||
self.options[str(option_index)] = Option(
|
||||
method=self.select_config, opt_data=kconfig_path
|
||||
)
|
||||
option_index += 1
|
||||
self.options["n"] = Option(
|
||||
method=self.select_config, opt_data=self.kconfig_default
|
||||
)
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = " [ Build Firmware Menu ] "
|
||||
color = COLOR_CYAN
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
cfg_found_str = Color.apply(
|
||||
"Previously saved firmware configs found!", Color.GREEN
|
||||
)
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ {cfg_found_str:^62} ║
|
||||
║ ║
|
||||
║ Select an existing config or create a new one. ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ Available firmware configs: ║
|
||||
"""
|
||||
)[1:]
|
||||
|
||||
start_index = 1
|
||||
for i, s in enumerate(self.configs):
|
||||
line = f"{start_index + i}) {s.name}"
|
||||
menu += f"║ {line:<54}║\n"
|
||||
|
||||
new_config = Color.apply("N) Create new firmware config", Color.GREEN)
|
||||
menu += "║ ║\n"
|
||||
menu += f"║ {new_config:<62} ║\n"
|
||||
|
||||
menu += "╟───────────────────────────────────────────────────────╢\n"
|
||||
|
||||
print(menu, end="")
|
||||
|
||||
def select_config(self, **kwargs) -> None:
|
||||
selection: str | None = kwargs.get("opt_data", None)
|
||||
if selection is None:
|
||||
raise Exception("opt_data is None")
|
||||
if not Path(selection).is_file() and selection != self.kconfig_default:
|
||||
raise Exception("opt_data does not exists")
|
||||
self.kconfig = selection
|
||||
|
||||
|
||||
# noinspection PyUnusedLocal
|
||||
# noinspection PyMethodMayBeStatic
|
||||
class KlipperBuildFirmwareMenu(BaseMenu):
|
||||
def __init__(
|
||||
self, kconfig: str | None = None, previous_menu: Type[BaseMenu] | None = None
|
||||
):
|
||||
super().__init__()
|
||||
self.title = "Build Firmware Menu"
|
||||
self.title_color = Color.CYAN
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
self.deps: Set[str] = {"build-essential", "dpkg-dev", "make"}
|
||||
self.missing_deps: List[str] = check_package_install(self.deps)
|
||||
self.flash_options = FlashOptions()
|
||||
self.kconfigs_dirname = KLIPPER_KCONFIGS_DIR
|
||||
self.kconfig_default = KLIPPER_DIR.joinpath(".config")
|
||||
self.kconfig = self.flash_options.selected_kconfig
|
||||
|
||||
def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
|
||||
from core.menus.advanced_menu import AdvancedMenu
|
||||
|
||||
self.previous_menu = (
|
||||
previous_menu if previous_menu is not None else AdvancedMenu
|
||||
)
|
||||
|
||||
def set_options(self) -> None:
|
||||
self.input_label_txt = "Press ENTER to install dependencies"
|
||||
self.default_option = Option(method=self.install_missing_deps)
|
||||
|
||||
def run(self):
|
||||
# immediately start the build process if all dependencies are met
|
||||
if len(self.missing_deps) == 0:
|
||||
self.start_build_process()
|
||||
else:
|
||||
super().run()
|
||||
|
||||
def print_menu(self) -> None:
|
||||
txt = Color.apply("Dependencies are missing!", Color.RED)
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ {txt:^62} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ The following dependencies are required: ║
|
||||
║ ║
|
||||
@@ -67,20 +170,14 @@ class KlipperBuildFirmwareMenu(BaseMenu):
|
||||
)[1:]
|
||||
|
||||
for d in self.deps:
|
||||
status_ok = f"{COLOR_GREEN}*INSTALLED*{RESET_FORMAT}"
|
||||
status_missing = f"{COLOR_RED}*MISSING*{RESET_FORMAT}"
|
||||
status_ok = Color.apply("*INSTALLED*", Color.GREEN)
|
||||
status_missing = Color.apply("*MISSING*", Color.RED)
|
||||
status = status_missing if d in self.missing_deps else status_ok
|
||||
padding = 39 - len(d) + len(status) + (len(status_ok) - len(status))
|
||||
d = f" {COLOR_CYAN}● {d}{RESET_FORMAT}"
|
||||
padding = 40 - len(d) + len(status) + (len(status_ok) - len(status))
|
||||
d = Color.apply(f"● {d}", Color.CYAN)
|
||||
menu += f"║ {d}{status:>{padding}} ║\n"
|
||||
|
||||
menu += "║ ║\n"
|
||||
|
||||
if len(self.missing_deps) == 0:
|
||||
line = f"{COLOR_GREEN}All dependencies are met!{RESET_FORMAT}"
|
||||
else:
|
||||
line = f"{COLOR_RED}Dependencies are missing!{RESET_FORMAT}"
|
||||
|
||||
menu += f"║ {line:<62} ║\n"
|
||||
menu += "╟───────────────────────────────────────────────────────╢\n"
|
||||
|
||||
print(menu, end="")
|
||||
@@ -99,13 +196,16 @@ class KlipperBuildFirmwareMenu(BaseMenu):
|
||||
|
||||
def start_build_process(self, **kwargs) -> None:
|
||||
try:
|
||||
run_make_clean()
|
||||
run_make_menuconfig()
|
||||
run_make()
|
||||
run_make_clean(self.kconfig)
|
||||
run_make_menuconfig(self.kconfig)
|
||||
run_make(self.kconfig)
|
||||
|
||||
Logger.print_ok("Firmware successfully built!")
|
||||
Logger.print_ok(f"Firmware file located in '{KLIPPER_DIR}/out'!")
|
||||
|
||||
if self.kconfig == self.kconfig_default:
|
||||
self.save_firmware_config()
|
||||
|
||||
except Exception as e:
|
||||
Logger.print_error(e)
|
||||
Logger.print_error("Building Klipper Firmware failed!")
|
||||
@@ -113,3 +213,62 @@ class KlipperBuildFirmwareMenu(BaseMenu):
|
||||
finally:
|
||||
if self.previous_menu is not None:
|
||||
self.previous_menu().run()
|
||||
|
||||
def save_firmware_config(self) -> None:
|
||||
Logger.print_dialog(
|
||||
DialogType.CUSTOM,
|
||||
[
|
||||
"You can save the firmware build configs for multiple MCUs,"
|
||||
" and use them to update the firmware after a Klipper version upgrade"
|
||||
],
|
||||
custom_title="Save firmware config",
|
||||
)
|
||||
if not get_confirm(
|
||||
"Do you want to save firmware config?", default_choice=False
|
||||
):
|
||||
return
|
||||
|
||||
filename = self.kconfig_default
|
||||
while True:
|
||||
Logger.print_dialog(
|
||||
DialogType.CUSTOM,
|
||||
[
|
||||
"Allowed characters: a-z, 0-9 and '-'",
|
||||
"The name must not contain the following:",
|
||||
"\n\n",
|
||||
"● Any special characters",
|
||||
"● No leading or trailing '-'",
|
||||
],
|
||||
)
|
||||
input_name = get_string_input(
|
||||
"Enter the new firmware config name",
|
||||
regex=r"^[a-z0-9]+([a-z0-9-]*[a-z0-9])?$",
|
||||
)
|
||||
filename = self.kconfigs_dirname.joinpath(f"{input_name}.config")
|
||||
|
||||
if Path(filename).is_file():
|
||||
if get_confirm(
|
||||
f"Firmware config {input_name} already exists, overwrite?",
|
||||
default_choice=False,
|
||||
):
|
||||
break
|
||||
|
||||
if Path(filename).is_dir():
|
||||
Logger.print_error(f"Path {filename} exists and it's a directory")
|
||||
|
||||
if not Path(filename).exists():
|
||||
break
|
||||
|
||||
if not get_confirm(
|
||||
f"Save firmware config to '{filename}'?", default_choice=True
|
||||
):
|
||||
Logger.print_info("Aborted saving firmware config ...")
|
||||
return
|
||||
|
||||
if not Path(self.kconfigs_dirname).exists():
|
||||
Path(self.kconfigs_dirname).mkdir()
|
||||
|
||||
copyfile(self.kconfig_default, filename)
|
||||
|
||||
Logger.print_ok()
|
||||
Logger.print_ok(f"Firmware config successfully saved to {filename}")
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -12,9 +12,9 @@ import textwrap
|
||||
from typing import Type
|
||||
|
||||
from components.klipper_firmware.flash_options import FlashMethod, FlashOptions
|
||||
from core.constants import COLOR_RED, RESET_FORMAT
|
||||
from core.menus import FooterType, Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.menus.base_menu import BaseMenu, MenuTitleStyle
|
||||
from core.types.color import Color
|
||||
|
||||
|
||||
# noinspection PyUnusedLocal
|
||||
@@ -22,6 +22,9 @@ from core.menus.base_menu import BaseMenu
|
||||
class KlipperNoFirmwareErrorMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None):
|
||||
super().__init__()
|
||||
self.title = "!!! NO FIRMWARE FILE FOUND !!!"
|
||||
self.title_color = Color.RED
|
||||
self.title_style = MenuTitleStyle.PLAIN
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
|
||||
self.flash_options = FlashOptions()
|
||||
@@ -35,16 +38,11 @@ class KlipperNoFirmwareErrorMenu(BaseMenu):
|
||||
self.default_option = Option(method=self.go_back)
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = "!!! NO FIRMWARE FILE FOUND !!!"
|
||||
color = COLOR_RED
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
line1 = f"{color}Unable to find a compiled firmware file!{RESET_FORMAT}"
|
||||
line1 = "Unable to find a compiled firmware file!"
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:^{count}}{RESET_FORMAT} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ {line1:<62} ║
|
||||
║ {Color.apply(line1, Color.RED):<62} ║
|
||||
║ ║
|
||||
║ Make sure, that: ║
|
||||
║ ● the folder '~/klipper/out' and its content exist ║
|
||||
@@ -71,6 +69,9 @@ class KlipperNoFirmwareErrorMenu(BaseMenu):
|
||||
class KlipperNoBoardTypesErrorMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None):
|
||||
super().__init__()
|
||||
self.title = "!!! ERROR GETTING BOARD LIST !!!"
|
||||
self.title_color = Color.RED
|
||||
self.title_style = MenuTitleStyle.PLAIN
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
self.footer_type = FooterType.BLANK
|
||||
self.input_label_txt = "Press ENTER to go back to [Main Menu]"
|
||||
@@ -82,16 +83,11 @@ class KlipperNoBoardTypesErrorMenu(BaseMenu):
|
||||
self.default_option = Option(method=self.go_back)
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = "!!! ERROR GETTING BOARD LIST !!!"
|
||||
color = COLOR_RED
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
line1 = f"{color}Reading the list of supported boards failed!{RESET_FORMAT}"
|
||||
line1 = "Reading the list of supported boards failed!"
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:^{count}}{RESET_FORMAT} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ {line1:<62} ║
|
||||
║ {Color.apply(line1, Color.RED):<62} ║
|
||||
║ ║
|
||||
║ Make sure, that: ║
|
||||
║ ● the folder '~/klipper' and all its content exist ║
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -9,16 +9,21 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import textwrap
|
||||
from typing import Type
|
||||
from typing import Tuple, Type
|
||||
|
||||
from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.menus.base_menu import BaseMenu, MenuTitleStyle
|
||||
from core.types.color import Color
|
||||
|
||||
|
||||
def __title_config__() -> Tuple[str, Color, MenuTitleStyle]:
|
||||
return "< ? > Help: Flash MCU < ? >", Color.YELLOW, MenuTitleStyle.PLAIN
|
||||
|
||||
|
||||
# noinspection DuplicatedCode
|
||||
class KlipperFlashMethodHelpMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None):
|
||||
super().__init__()
|
||||
self.title, self.title_color, self.title_style = __title_config__()
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
|
||||
def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
|
||||
@@ -34,15 +39,10 @@ class KlipperFlashMethodHelpMenu(BaseMenu):
|
||||
pass
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = " < ? > Help: Flash MCU < ? > "
|
||||
color = COLOR_YELLOW
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
subheader1 = f"{COLOR_CYAN}Regular flashing method:{RESET_FORMAT}"
|
||||
subheader2 = f"{COLOR_CYAN}Updating via SD-Card Update:{RESET_FORMAT}"
|
||||
subheader1 = Color.apply("Regular flashing method:", Color.CYAN)
|
||||
subheader2 = Color.apply("Updating via SD-Card Update:", Color.CYAN)
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ {subheader1:<62} ║
|
||||
║ The default method to flash controller boards which ║
|
||||
@@ -77,6 +77,7 @@ class KlipperFlashMethodHelpMenu(BaseMenu):
|
||||
class KlipperFlashCommandHelpMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None):
|
||||
super().__init__()
|
||||
self.title, self.title_color, self.title_style = __title_config__()
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
|
||||
def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
|
||||
@@ -92,15 +93,10 @@ class KlipperFlashCommandHelpMenu(BaseMenu):
|
||||
pass
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = " < ? > Help: Flash MCU < ? > "
|
||||
color = COLOR_YELLOW
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
subheader1 = f"{COLOR_CYAN}make flash:{RESET_FORMAT}"
|
||||
subheader2 = f"{COLOR_CYAN}make serialflash:{RESET_FORMAT}"
|
||||
subheader1 = Color.apply("make flash:", Color.CYAN)
|
||||
subheader2 = Color.apply("make serialflash:", Color.CYAN)
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ {subheader1:<62} ║
|
||||
║ The default command to flash controller board, it ║
|
||||
@@ -121,6 +117,7 @@ class KlipperFlashCommandHelpMenu(BaseMenu):
|
||||
class KlipperMcuConnectionHelpMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None):
|
||||
super().__init__()
|
||||
self.title, self.title_color, self.title_style = __title_config__()
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
|
||||
def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
|
||||
@@ -138,17 +135,12 @@ class KlipperMcuConnectionHelpMenu(BaseMenu):
|
||||
pass
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = " < ? > Help: Flash MCU < ? > "
|
||||
color = COLOR_YELLOW
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
subheader1 = f"{COLOR_CYAN}USB:{RESET_FORMAT}"
|
||||
subheader2 = f"{COLOR_CYAN}UART:{RESET_FORMAT}"
|
||||
subheader3 = f"{COLOR_CYAN}USB DFU:{RESET_FORMAT}"
|
||||
subheader4 = f"{COLOR_CYAN}USB RP2040 Boot:{RESET_FORMAT}"
|
||||
subheader1 = Color.apply("USB:", Color.CYAN)
|
||||
subheader2 = Color.apply("UART:", Color.CYAN)
|
||||
subheader3 = Color.apply("USB DFU:", Color.CYAN)
|
||||
subheader4 = Color.apply("USB RP2040 Boot:", Color.CYAN)
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ {subheader1:<62} ║
|
||||
║ Selecting USB as the connection method will scan the ║
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -10,6 +10,7 @@ from __future__ import annotations
|
||||
|
||||
import textwrap
|
||||
import time
|
||||
from pathlib import Path
|
||||
from typing import Type
|
||||
|
||||
from components.klipper_firmware.firmware_utils import (
|
||||
@@ -36,10 +37,10 @@ from components.klipper_firmware.menus.klipper_flash_help_menu import (
|
||||
KlipperFlashMethodHelpMenu,
|
||||
KlipperMcuConnectionHelpMenu,
|
||||
)
|
||||
from core.constants import COLOR_CYAN, COLOR_RED, COLOR_YELLOW, RESET_FORMAT
|
||||
from core.logger import DialogType, Logger
|
||||
from core.menus import FooterType, Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.menus.base_menu import BaseMenu, MenuTitleStyle
|
||||
from core.types.color import Color
|
||||
from utils.input_utils import get_number_input
|
||||
|
||||
|
||||
@@ -48,6 +49,8 @@ from utils.input_utils import get_number_input
|
||||
class KlipperFlashMethodMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None):
|
||||
super().__init__()
|
||||
self.title = "MCU Flash Menu"
|
||||
self.title_color = Color.CYAN
|
||||
self.help_menu = KlipperFlashMethodHelpMenu
|
||||
self.input_label_txt = "Select flash method"
|
||||
self.footer_type = FooterType.BACK_HELP
|
||||
@@ -67,17 +70,13 @@ class KlipperFlashMethodMenu(BaseMenu):
|
||||
}
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = " [ MCU Flash Menu ] "
|
||||
subheader = f"{COLOR_YELLOW}ATTENTION:{RESET_FORMAT}"
|
||||
subline1 = f"{COLOR_YELLOW}Make sure to select the correct method for the MCU!{RESET_FORMAT}"
|
||||
subline2 = f"{COLOR_YELLOW}Not all MCUs support both methods!{RESET_FORMAT}"
|
||||
|
||||
color = COLOR_CYAN
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
subheader = Color.apply("ATTENTION:", Color.YELLOW)
|
||||
subline1 = Color.apply(
|
||||
"Make sure to select the correct method for the MCU!", Color.YELLOW
|
||||
)
|
||||
subline2 = Color.apply("Not all MCUs support both methods!", Color.YELLOW)
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ Select the flash method for flashing the MCU. ║
|
||||
║ ║
|
||||
@@ -112,6 +111,9 @@ class KlipperFlashMethodMenu(BaseMenu):
|
||||
class KlipperFlashCommandMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None):
|
||||
super().__init__()
|
||||
self.title = "Which flash command to use for flashing the MCU?"
|
||||
self.title_style = MenuTitleStyle.PLAIN
|
||||
self.title_color = Color.YELLOW
|
||||
self.help_menu = KlipperFlashCommandHelpMenu
|
||||
self.input_label_txt = "Select flash command"
|
||||
self.footer_type = FooterType.BACK_HELP
|
||||
@@ -132,8 +134,6 @@ class KlipperFlashCommandMenu(BaseMenu):
|
||||
def print_menu(self) -> None:
|
||||
menu = textwrap.dedent(
|
||||
"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ Which flash command to use for flashing the MCU? ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ 1) make flash (default) ║
|
||||
║ 2) make serialflash (stm32flash) ║
|
||||
@@ -161,6 +161,9 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
|
||||
self, previous_menu: Type[BaseMenu] | None = None, standalone: bool = False
|
||||
):
|
||||
super().__init__()
|
||||
self.title = "Make sure that the controller board is connected now!"
|
||||
self.title_style = MenuTitleStyle.PLAIN
|
||||
self.title_color = Color.YELLOW
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
self.__standalone = standalone
|
||||
self.help_menu = KlipperMcuConnectionHelpMenu
|
||||
@@ -182,13 +185,8 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
|
||||
}
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = "Make sure that the controller board is connected now!"
|
||||
color = COLOR_YELLOW
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:^{count}}{RESET_FORMAT} ║
|
||||
"""
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ How is the controller board connected to the host? ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
@@ -230,7 +228,9 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
|
||||
Logger.print_status("Identifying MCU connected via USB in DFU mode ...")
|
||||
self.flash_options.mcu_list = find_usb_dfu_device()
|
||||
elif conn_type is ConnectionType.USB_RP2040:
|
||||
Logger.print_status("Identifying MCU connected via USB in RP2 Boot mode ...")
|
||||
Logger.print_status(
|
||||
"Identifying MCU connected via USB in RP2 Boot mode ..."
|
||||
)
|
||||
self.flash_options.mcu_list = find_usb_rp2_boot_device()
|
||||
|
||||
if len(self.flash_options.mcu_list) < 1:
|
||||
@@ -241,7 +241,7 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
|
||||
if self.__standalone and len(self.flash_options.mcu_list) > 0:
|
||||
Logger.print_ok("The following MCUs were found:", prefix=False)
|
||||
for i, mcu in enumerate(self.flash_options.mcu_list):
|
||||
print(f" ● MCU #{i}: {COLOR_CYAN}{mcu}{RESET_FORMAT}")
|
||||
print(f" ● MCU #{i}: {Color.CYAN}{mcu}{Color.RST}")
|
||||
time.sleep(3)
|
||||
return
|
||||
|
||||
@@ -256,6 +256,9 @@ class KlipperSelectMcuConnectionMenu(BaseMenu):
|
||||
class KlipperSelectMcuIdMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None):
|
||||
super().__init__()
|
||||
self.title = "!!! ATTENTION !!!"
|
||||
self.title_style = MenuTitleStyle.PLAIN
|
||||
self.title_color = Color.RED
|
||||
self.flash_options = FlashOptions()
|
||||
self.mcu_list = self.flash_options.mcu_list
|
||||
self.input_label_txt = "Select MCU to flash"
|
||||
@@ -274,14 +277,9 @@ class KlipperSelectMcuIdMenu(BaseMenu):
|
||||
}
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = "!!! ATTENTION !!!"
|
||||
header2 = f"[{COLOR_CYAN}List of detected MCUs{RESET_FORMAT}]"
|
||||
color = COLOR_RED
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
header2 = f"[{Color.apply('List of detected MCUs', Color.CYAN)}]"
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:^{count}}{RESET_FORMAT} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ Make sure, to select the correct MCU! ║
|
||||
║ ONLY flash a firmware created for the respective MCU! ║
|
||||
@@ -293,7 +291,7 @@ class KlipperSelectMcuIdMenu(BaseMenu):
|
||||
|
||||
for i, mcu in enumerate(self.mcu_list):
|
||||
mcu = mcu.split("/")[-1]
|
||||
menu += f"║ {i}) {COLOR_CYAN}{mcu:<51}{RESET_FORMAT}║\n"
|
||||
menu += f"║ {i}) {Color.apply(f'{mcu:<51}', Color.CYAN)}║\n"
|
||||
|
||||
menu += textwrap.dedent(
|
||||
"""
|
||||
@@ -348,7 +346,6 @@ class KlipperSelectSDFlashBoardMenu(BaseMenu):
|
||||
else:
|
||||
menu = textwrap.dedent(
|
||||
"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ Please select the type of board that corresponds to ║
|
||||
║ the currently selected MCU ID you chose before. ║
|
||||
║ ║
|
||||
@@ -389,7 +386,7 @@ class KlipperSelectSDFlashBoardMenu(BaseMenu):
|
||||
self.flash_options.selected_baudrate = get_number_input(
|
||||
question="Please set the baud rate",
|
||||
default=250000,
|
||||
min_count=0,
|
||||
min_value=0,
|
||||
allow_go_back=True,
|
||||
)
|
||||
KlipperFlashOverviewMenu(previous_menu=self.__class__).run()
|
||||
@@ -400,6 +397,9 @@ class KlipperSelectSDFlashBoardMenu(BaseMenu):
|
||||
class KlipperFlashOverviewMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None):
|
||||
super().__init__()
|
||||
self.title = "!!! ATTENTION !!!"
|
||||
self.title_style = MenuTitleStyle.PLAIN
|
||||
self.title_color = Color.RED
|
||||
self.flash_options = FlashOptions()
|
||||
self.input_label_txt = "Perform action (default=Y)"
|
||||
|
||||
@@ -415,21 +415,17 @@ class KlipperFlashOverviewMenu(BaseMenu):
|
||||
self.default_option = Option(self.execute_flash)
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = "!!! ATTENTION !!!"
|
||||
color = COLOR_RED
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
|
||||
method = self.flash_options.flash_method.value
|
||||
command = self.flash_options.flash_command.value
|
||||
conn_type = self.flash_options.connection_type.value
|
||||
mcu = self.flash_options.selected_mcu.split("/")[-1]
|
||||
board = self.flash_options.selected_board
|
||||
baudrate = self.flash_options.selected_baudrate
|
||||
subheader = f"[{COLOR_CYAN}Overview{RESET_FORMAT}]"
|
||||
kconfig = Path(self.flash_options.selected_kconfig).name
|
||||
color = Color.CYAN
|
||||
subheader = f"[{Color.apply('Overview', color)}]"
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:^{count}}{RESET_FORMAT} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ Before contuining the flashing process, please check ║
|
||||
║ if all parameters were set correctly! Once you made ║
|
||||
@@ -443,18 +439,25 @@ class KlipperFlashOverviewMenu(BaseMenu):
|
||||
|
||||
menu += textwrap.dedent(
|
||||
f"""
|
||||
║ MCU: {COLOR_CYAN}{mcu:<48}{RESET_FORMAT} ║
|
||||
║ Connection: {COLOR_CYAN}{conn_type:<41}{RESET_FORMAT} ║
|
||||
║ Flash method: {COLOR_CYAN}{method:<39}{RESET_FORMAT} ║
|
||||
║ Flash command: {COLOR_CYAN}{command:<38}{RESET_FORMAT} ║
|
||||
║ MCU: {Color.apply(f"{mcu:<48}", color)} ║
|
||||
║ Connection: {Color.apply(f"{conn_type:<41}", color)} ║
|
||||
║ Flash method: {Color.apply(f"{method:<39}", color)} ║
|
||||
║ Flash command: {Color.apply(f"{command:<38}", color)} ║
|
||||
"""
|
||||
)[1:]
|
||||
|
||||
if self.flash_options.flash_method is FlashMethod.SD_CARD:
|
||||
menu += textwrap.dedent(
|
||||
f"""
|
||||
║ Board type: {COLOR_CYAN}{board:<41}{RESET_FORMAT} ║
|
||||
║ Baudrate: {COLOR_CYAN}{baudrate:<43}{RESET_FORMAT} ║
|
||||
║ Board type: {Color.apply(f"{board:<41}", color)} ║
|
||||
║ Baudrate: {Color.apply(f"{baudrate:<43}", color)} ║
|
||||
"""
|
||||
)[1:]
|
||||
|
||||
if self.flash_options.flash_method is FlashMethod.REGULAR:
|
||||
menu += textwrap.dedent(
|
||||
f"""
|
||||
║ Firmware config: {Color.apply(f"{kconfig:<36}", color)} ║
|
||||
"""
|
||||
)[1:]
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -30,7 +30,7 @@ from core.constants import SYSTEMD
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.settings.kiauh_settings import KiauhSettings
|
||||
from core.types import ComponentStatus
|
||||
from core.types.component_status import ComponentStatus
|
||||
from utils.common import (
|
||||
check_install_dependencies,
|
||||
get_install_status,
|
||||
@@ -126,7 +126,7 @@ def update_klipperscreen() -> None:
|
||||
if settings.kiauh.backup_before_update:
|
||||
backup_klipperscreen_dir()
|
||||
|
||||
git_pull_wrapper(KLIPPERSCREEN_REPO, KLIPPERSCREEN_DIR)
|
||||
git_pull_wrapper(KLIPPERSCREEN_DIR)
|
||||
|
||||
install_python_requirements(KLIPPERSCREEN_ENV_DIR, KLIPPERSCREEN_REQ_FILE)
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -12,16 +12,18 @@ import textwrap
|
||||
from typing import Type
|
||||
|
||||
from components.log_uploads.log_upload_utils import get_logfile_list, upload_logfile
|
||||
from core.constants import COLOR_YELLOW, RESET_FORMAT
|
||||
from core.logger import Logger
|
||||
from core.menus import Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.types.color import Color
|
||||
|
||||
|
||||
# noinspection PyMethodMayBeStatic
|
||||
class LogUploadMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None):
|
||||
super().__init__()
|
||||
self.title = "Log Upload"
|
||||
self.title_color = Color.YELLOW
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
self.logfile_list = get_logfile_list()
|
||||
|
||||
@@ -37,13 +39,8 @@ class LogUploadMenu(BaseMenu):
|
||||
}
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = " [ Log Upload ] "
|
||||
color = COLOR_YELLOW
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
"""
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ You can select the following logfiles for uploading: ║
|
||||
║ ║
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -13,6 +13,8 @@ from core.backup_manager import BACKUP_ROOT_DIR
|
||||
|
||||
MODULE_PATH = Path(__file__).resolve().parent
|
||||
|
||||
MOONRAKER_REPO_URL = "https://github.com/Arksine/moonraker.git"
|
||||
|
||||
# names
|
||||
MOONRAKER_CFG_NAME = "moonraker.conf"
|
||||
MOONRAKER_LOG_NAME = "moonraker.log"
|
||||
|
||||
@@ -10,6 +10,7 @@ trusted_clients:
|
||||
169.254.0.0/16
|
||||
172.16.0.0/12
|
||||
192.168.0.0/16
|
||||
FC00::/7
|
||||
FE80::/10
|
||||
::1/128
|
||||
cors_domains:
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -11,22 +11,29 @@ from __future__ import annotations
|
||||
import textwrap
|
||||
from typing import Type
|
||||
|
||||
from components.moonraker import moonraker_remove
|
||||
from core.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
|
||||
from core.menus import Option
|
||||
from components.moonraker.services.moonraker_setup_service import MoonrakerSetupService
|
||||
from core.menus import FooterType, Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.types.color import Color
|
||||
|
||||
|
||||
# noinspection PyUnusedLocal
|
||||
class MoonrakerRemoveMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None):
|
||||
super().__init__()
|
||||
|
||||
self.title = "Remove Moonraker"
|
||||
self.title_color = Color.RED
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
self.remove_moonraker_service = False
|
||||
self.remove_moonraker_dir = False
|
||||
self.remove_moonraker_env = False
|
||||
self.remove_moonraker_polkit = False
|
||||
self.selection_state = False
|
||||
self.footer_type = FooterType.BACK
|
||||
|
||||
self.rm_svc = False
|
||||
self.rm_dir = False
|
||||
self.rm_env = False
|
||||
self.rm_pk = False
|
||||
self.select_state = False
|
||||
|
||||
self.mrsvc = MoonrakerSetupService()
|
||||
|
||||
def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
|
||||
from core.menus.remove_menu import RemoveMenu
|
||||
@@ -44,24 +51,20 @@ class MoonrakerRemoveMenu(BaseMenu):
|
||||
}
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = " [ Remove Moonraker ] "
|
||||
color = COLOR_RED
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
checked = f"[{COLOR_CYAN}x{RESET_FORMAT}]"
|
||||
checked = f"[{Color.apply('x', Color.CYAN)}]"
|
||||
unchecked = "[ ]"
|
||||
o1 = checked if self.remove_moonraker_service else unchecked
|
||||
o2 = checked if self.remove_moonraker_dir else unchecked
|
||||
o3 = checked if self.remove_moonraker_env else unchecked
|
||||
o4 = checked if self.remove_moonraker_polkit else unchecked
|
||||
o1 = checked if self.rm_svc else unchecked
|
||||
o2 = checked if self.rm_dir else unchecked
|
||||
o3 = checked if self.rm_env else unchecked
|
||||
o4 = checked if self.rm_pk else unchecked
|
||||
sel_state = f"{'Select' if not self.select_state else 'Deselect'} everything"
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ Enter a number and hit enter to select / deselect ║
|
||||
║ the specific option for removal. ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ a) {self._get_selection_state_str():37} ║
|
||||
║ a) {sel_state:49} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ 1) {o1} Remove Service ║
|
||||
║ 2) {o2} Remove Local Repository ║
|
||||
@@ -75,54 +78,33 @@ class MoonrakerRemoveMenu(BaseMenu):
|
||||
print(menu, end="")
|
||||
|
||||
def toggle_all(self, **kwargs) -> None:
|
||||
self.selection_state = not self.selection_state
|
||||
self.remove_moonraker_service = self.selection_state
|
||||
self.remove_moonraker_dir = self.selection_state
|
||||
self.remove_moonraker_env = self.selection_state
|
||||
self.remove_moonraker_polkit = self.selection_state
|
||||
self.select_state = not self.select_state
|
||||
self.rm_svc = self.select_state
|
||||
self.rm_dir = self.select_state
|
||||
self.rm_env = self.select_state
|
||||
self.rm_pk = self.select_state
|
||||
|
||||
def toggle_remove_moonraker_service(self, **kwargs) -> None:
|
||||
self.remove_moonraker_service = not self.remove_moonraker_service
|
||||
self.rm_svc = not self.rm_svc
|
||||
|
||||
def toggle_remove_moonraker_dir(self, **kwargs) -> None:
|
||||
self.remove_moonraker_dir = not self.remove_moonraker_dir
|
||||
self.rm_dir = not self.rm_dir
|
||||
|
||||
def toggle_remove_moonraker_env(self, **kwargs) -> None:
|
||||
self.remove_moonraker_env = not self.remove_moonraker_env
|
||||
self.rm_env = not self.rm_env
|
||||
|
||||
def toggle_remove_moonraker_polkit(self, **kwargs) -> None:
|
||||
self.remove_moonraker_polkit = not self.remove_moonraker_polkit
|
||||
self.rm_pk = not self.rm_pk
|
||||
|
||||
def run_removal_process(self, **kwargs) -> None:
|
||||
if (
|
||||
not self.remove_moonraker_service
|
||||
and not self.remove_moonraker_dir
|
||||
and not self.remove_moonraker_env
|
||||
and not self.remove_moonraker_polkit
|
||||
):
|
||||
error = f"{COLOR_RED}Nothing selected! Select options to remove first.{RESET_FORMAT}"
|
||||
print(error)
|
||||
if not self.rm_svc and not self.rm_dir and not self.rm_env and not self.rm_pk:
|
||||
msg = "Nothing selected! Select options to remove first."
|
||||
print(Color.apply(msg, Color.RED))
|
||||
return
|
||||
|
||||
moonraker_remove.run_moonraker_removal(
|
||||
self.remove_moonraker_service,
|
||||
self.remove_moonraker_dir,
|
||||
self.remove_moonraker_env,
|
||||
self.remove_moonraker_polkit,
|
||||
)
|
||||
self.mrsvc.remove(self.rm_svc, self.rm_dir, self.rm_env, self.rm_pk)
|
||||
|
||||
self.remove_moonraker_service = False
|
||||
self.remove_moonraker_dir = False
|
||||
self.remove_moonraker_env = False
|
||||
self.remove_moonraker_polkit = False
|
||||
|
||||
self._go_back()
|
||||
|
||||
def _get_selection_state_str(self) -> str:
|
||||
return (
|
||||
"Select everything" if not self.selection_state else "Deselect everything"
|
||||
)
|
||||
|
||||
def _go_back(self, **kwargs) -> None:
|
||||
if self.previous_menu is not None:
|
||||
self.previous_menu().run()
|
||||
self.rm_svc = False
|
||||
self.rm_dir = False
|
||||
self.rm_env = False
|
||||
self.rm_pk = False
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -12,8 +12,8 @@ from typing import List
|
||||
|
||||
from components.klipper.klipper import Klipper
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from core.constants import COLOR_CYAN, COLOR_GREEN, COLOR_YELLOW, RESET_FORMAT
|
||||
from core.menus.base_menu import print_back_footer
|
||||
from core.types.color import Color
|
||||
|
||||
|
||||
def print_moonraker_overview(
|
||||
@@ -22,7 +22,7 @@ def print_moonraker_overview(
|
||||
show_index=False,
|
||||
show_select_all=False,
|
||||
):
|
||||
headline = f"{COLOR_GREEN}The following instances were found:{RESET_FORMAT}"
|
||||
headline = Color.apply("The following instances were found:", Color.GREEN)
|
||||
dialog = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
@@ -32,7 +32,7 @@ def print_moonraker_overview(
|
||||
)[1:]
|
||||
|
||||
if show_select_all:
|
||||
select_all = f"{COLOR_YELLOW}a) Select all{RESET_FORMAT}"
|
||||
select_all = Color.apply("a) Select all", Color.YELLOW)
|
||||
dialog += f"║ {select_all:<63}║\n"
|
||||
dialog += "║ ║\n"
|
||||
|
||||
@@ -48,12 +48,16 @@ def print_moonraker_overview(
|
||||
for i, k in enumerate(instance_map):
|
||||
mr_name = instance_map.get(k)
|
||||
m = f"<-> {mr_name}" if mr_name != "" else ""
|
||||
line = f"{COLOR_CYAN}{f'{i+1})' if show_index else '●'} {k} {m} {RESET_FORMAT}"
|
||||
line = Color.apply(f"{f'{i + 1})' if show_index else '●'} {k} {m}", Color.CYAN)
|
||||
dialog += f"║ {line:<63}║\n"
|
||||
|
||||
warn_l1 = f"{COLOR_YELLOW}PLEASE NOTE: {RESET_FORMAT}"
|
||||
warn_l2 = f"{COLOR_YELLOW}If you select an instance with an existing Moonraker{RESET_FORMAT}"
|
||||
warn_l3 = f"{COLOR_YELLOW}instance, that Moonraker instance will be re-created!{RESET_FORMAT}"
|
||||
warn_l1 = Color.apply("PLEASE NOTE:", Color.YELLOW)
|
||||
warn_l2 = Color.apply(
|
||||
"If you select an instance with an existing Moonraker", Color.YELLOW
|
||||
)
|
||||
warn_l3 = Color.apply(
|
||||
"instance, that Moonraker instance will be re-created!", Color.YELLOW
|
||||
)
|
||||
warning = textwrap.dedent(
|
||||
f"""
|
||||
║ ║
|
||||
|
||||
@@ -1,121 +0,0 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
from __future__ import annotations
|
||||
|
||||
from subprocess import DEVNULL, PIPE, CalledProcessError, run
|
||||
from typing import List
|
||||
|
||||
from components.klipper.klipper_dialogs import print_instance_overview
|
||||
from components.moonraker import MOONRAKER_DIR, MOONRAKER_ENV_DIR
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import Logger
|
||||
from utils.fs_utils import run_remove_routines
|
||||
from utils.input_utils import get_selection_input
|
||||
from utils.instance_utils import get_instances
|
||||
from utils.sys_utils import unit_file_exists
|
||||
|
||||
|
||||
def run_moonraker_removal(
|
||||
remove_service: bool,
|
||||
remove_dir: bool,
|
||||
remove_env: bool,
|
||||
remove_polkit: bool,
|
||||
) -> None:
|
||||
instances = get_instances(Moonraker)
|
||||
|
||||
if remove_service:
|
||||
Logger.print_status("Removing Moonraker instances ...")
|
||||
if instances:
|
||||
instances_to_remove = select_instances_to_remove(instances)
|
||||
remove_instances(instances_to_remove)
|
||||
else:
|
||||
Logger.print_info("No Moonraker Services installed! Skipped ...")
|
||||
|
||||
delete_remaining: bool = remove_polkit or remove_dir or remove_env
|
||||
if delete_remaining and unit_file_exists("moonraker", suffix="service"):
|
||||
Logger.print_info("There are still other Moonraker services installed")
|
||||
Logger.print_info(
|
||||
"● Moonraker PolicyKit rules were not removed.", prefix=False
|
||||
)
|
||||
Logger.print_info(f"● '{MOONRAKER_DIR}' was not removed.", prefix=False)
|
||||
Logger.print_info(f"● '{MOONRAKER_ENV_DIR}' was not removed.", prefix=False)
|
||||
else:
|
||||
if remove_polkit:
|
||||
Logger.print_status("Removing all Moonraker policykit rules ...")
|
||||
remove_polkit_rules()
|
||||
if remove_dir:
|
||||
Logger.print_status("Removing Moonraker local repository ...")
|
||||
run_remove_routines(MOONRAKER_DIR)
|
||||
if remove_env:
|
||||
Logger.print_status("Removing Moonraker Python environment ...")
|
||||
run_remove_routines(MOONRAKER_ENV_DIR)
|
||||
|
||||
|
||||
def select_instances_to_remove(
|
||||
instances: List[Moonraker],
|
||||
) -> List[Moonraker] | None:
|
||||
start_index = 1
|
||||
options = [str(i + start_index) for i in range(len(instances))]
|
||||
options.extend(["a", "b"])
|
||||
instance_map = {options[i]: instances[i] for i in range(len(instances))}
|
||||
|
||||
print_instance_overview(
|
||||
instances,
|
||||
start_index=start_index,
|
||||
show_index=True,
|
||||
show_select_all=True,
|
||||
)
|
||||
selection = get_selection_input("Select Moonraker instance to remove", options)
|
||||
|
||||
instances_to_remove = []
|
||||
if selection == "b":
|
||||
return None
|
||||
elif selection == "a":
|
||||
instances_to_remove.extend(instances)
|
||||
else:
|
||||
instances_to_remove.append(instance_map[selection])
|
||||
|
||||
return instances_to_remove
|
||||
|
||||
|
||||
def remove_instances(
|
||||
instance_list: List[Moonraker] | None,
|
||||
) -> None:
|
||||
if not instance_list:
|
||||
Logger.print_info("No Moonraker instances found. Skipped ...")
|
||||
return
|
||||
for instance in instance_list:
|
||||
Logger.print_status(f"Removing instance {instance.service_file_path.stem} ...")
|
||||
InstanceManager.remove(instance)
|
||||
delete_moonraker_env_file(instance)
|
||||
|
||||
|
||||
def remove_polkit_rules() -> None:
|
||||
if not MOONRAKER_DIR.exists():
|
||||
log = "Cannot remove policykit rules. Moonraker directory not found."
|
||||
Logger.print_warn(log)
|
||||
return
|
||||
|
||||
try:
|
||||
cmd = [f"{MOONRAKER_DIR}/scripts/set-policykit-rules.sh", "--clear"]
|
||||
run(cmd, stderr=PIPE, stdout=DEVNULL, check=True)
|
||||
except CalledProcessError as e:
|
||||
Logger.print_error(f"Error while removing policykit rules: {e}")
|
||||
|
||||
Logger.print_ok("Policykit rules successfully removed!")
|
||||
|
||||
|
||||
def delete_moonraker_env_file(instance: Moonraker):
|
||||
Logger.print_status(f"Remove '{instance.env_file}'")
|
||||
if not instance.env_file.exists():
|
||||
msg = f"Env file in {instance.base.sysd_dir} not found. Skipped ..."
|
||||
Logger.print_info(msg)
|
||||
return
|
||||
run_remove_routines(instance.env_file)
|
||||
@@ -1,219 +0,0 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import subprocess
|
||||
from typing import List
|
||||
|
||||
from components.klipper.klipper import Klipper
|
||||
from components.moonraker import (
|
||||
EXIT_MOONRAKER_SETUP,
|
||||
MOONRAKER_DEPS_JSON_FILE,
|
||||
MOONRAKER_DIR,
|
||||
MOONRAKER_ENV_DIR,
|
||||
MOONRAKER_INSTALL_SCRIPT,
|
||||
MOONRAKER_REQ_FILE,
|
||||
MOONRAKER_SPEEDUPS_REQ_FILE,
|
||||
POLKIT_FILE,
|
||||
POLKIT_LEGACY_FILE,
|
||||
POLKIT_SCRIPT,
|
||||
POLKIT_USR_FILE,
|
||||
)
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from components.moonraker.moonraker_dialogs import print_moonraker_overview
|
||||
from components.moonraker.moonraker_utils import (
|
||||
backup_moonraker_dir,
|
||||
create_example_moonraker_conf,
|
||||
)
|
||||
from components.webui_client.client_utils import (
|
||||
enable_mainsail_remotemode,
|
||||
get_existing_clients,
|
||||
)
|
||||
from components.webui_client.mainsail_data import MainsailData
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import Logger
|
||||
from core.settings.kiauh_settings import KiauhSettings
|
||||
from utils.common import check_install_dependencies
|
||||
from utils.fs_utils import check_file_exist
|
||||
from utils.git_utils import git_clone_wrapper, git_pull_wrapper
|
||||
from utils.input_utils import (
|
||||
get_confirm,
|
||||
get_selection_input,
|
||||
)
|
||||
from utils.instance_utils import get_instances
|
||||
from utils.sys_utils import (
|
||||
check_python_version,
|
||||
cmd_sysctl_manage,
|
||||
cmd_sysctl_service,
|
||||
create_python_venv,
|
||||
install_python_requirements,
|
||||
parse_packages_from_file,
|
||||
)
|
||||
|
||||
|
||||
def install_moonraker() -> None:
|
||||
klipper_list: List[Klipper] = get_instances(Klipper)
|
||||
|
||||
if not check_moonraker_install_requirements(klipper_list):
|
||||
return
|
||||
|
||||
moonraker_list: List[Moonraker] = get_instances(Moonraker)
|
||||
instances: List[Moonraker] = []
|
||||
selected_option: str | Klipper
|
||||
|
||||
if len(klipper_list) == 1:
|
||||
instances.append(Moonraker(klipper_list[0].suffix))
|
||||
else:
|
||||
print_moonraker_overview(
|
||||
klipper_list,
|
||||
moonraker_list,
|
||||
show_index=True,
|
||||
show_select_all=True,
|
||||
)
|
||||
options = {str(i + 1): k for i, k in enumerate(klipper_list)}
|
||||
additional_options = {"a": None, "b": None}
|
||||
options = {**options, **additional_options}
|
||||
question = "Select Klipper instance to setup Moonraker for"
|
||||
selected_option = get_selection_input(question, options)
|
||||
|
||||
if selected_option == "b":
|
||||
Logger.print_status(EXIT_MOONRAKER_SETUP)
|
||||
return
|
||||
|
||||
if selected_option == "a":
|
||||
instances.extend([Moonraker(k.suffix) for k in klipper_list])
|
||||
else:
|
||||
klipper_instance: Klipper | None = options.get(selected_option)
|
||||
if klipper_instance is None:
|
||||
raise Exception("Error selecting instance!")
|
||||
instances.append(Moonraker(klipper_instance.suffix))
|
||||
|
||||
create_example_cfg = get_confirm("Create example moonraker.conf?")
|
||||
|
||||
try:
|
||||
check_install_dependencies()
|
||||
setup_moonraker_prerequesites()
|
||||
install_moonraker_polkit()
|
||||
|
||||
used_ports_map = {m.suffix: m.port for m in moonraker_list}
|
||||
for instance in instances:
|
||||
instance.create()
|
||||
cmd_sysctl_service(instance.service_file_path.name, "enable")
|
||||
|
||||
if create_example_cfg:
|
||||
# if a webclient and/or it's config is installed, patch
|
||||
# its update section to the config
|
||||
clients = get_existing_clients()
|
||||
create_example_moonraker_conf(instance, used_ports_map, clients)
|
||||
|
||||
cmd_sysctl_service(instance.service_file_path.name, "start")
|
||||
|
||||
cmd_sysctl_manage("daemon-reload")
|
||||
|
||||
# if mainsail is installed, and we installed
|
||||
# multiple moonraker instances, we enable mainsails remote mode
|
||||
if MainsailData().client_dir.exists() and len(moonraker_list) > 1:
|
||||
enable_mainsail_remotemode()
|
||||
|
||||
except Exception as e:
|
||||
Logger.print_error(f"Error while installing Moonraker: {e}")
|
||||
return
|
||||
|
||||
|
||||
def check_moonraker_install_requirements(klipper_list: List[Klipper]) -> bool:
|
||||
def check_klipper_instances() -> bool:
|
||||
if len(klipper_list) >= 1:
|
||||
return True
|
||||
|
||||
Logger.print_warn("Klipper not installed!")
|
||||
Logger.print_warn("Moonraker cannot be installed! Install Klipper first.")
|
||||
return False
|
||||
|
||||
return check_python_version(3, 7) and check_klipper_instances()
|
||||
|
||||
|
||||
def setup_moonraker_prerequesites() -> None:
|
||||
settings = KiauhSettings()
|
||||
repo = settings.moonraker.repo_url
|
||||
branch = settings.moonraker.branch
|
||||
|
||||
git_clone_wrapper(repo, MOONRAKER_DIR, branch)
|
||||
|
||||
# install moonraker dependencies and create python virtualenv
|
||||
install_moonraker_packages()
|
||||
if create_python_venv(MOONRAKER_ENV_DIR):
|
||||
install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
|
||||
install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_SPEEDUPS_REQ_FILE)
|
||||
|
||||
|
||||
def install_moonraker_packages() -> None:
|
||||
moonraker_deps = []
|
||||
|
||||
if MOONRAKER_DEPS_JSON_FILE.exists():
|
||||
with open(MOONRAKER_DEPS_JSON_FILE, "r") as deps:
|
||||
moonraker_deps = json.load(deps).get("debian", [])
|
||||
elif MOONRAKER_INSTALL_SCRIPT.exists():
|
||||
moonraker_deps = parse_packages_from_file(MOONRAKER_INSTALL_SCRIPT)
|
||||
|
||||
if not moonraker_deps:
|
||||
raise ValueError("Error reading Moonraker dependencies!")
|
||||
|
||||
check_install_dependencies({*moonraker_deps})
|
||||
|
||||
|
||||
def install_moonraker_polkit() -> None:
|
||||
Logger.print_status("Installing Moonraker policykit rules ...")
|
||||
|
||||
legacy_file_exists = check_file_exist(POLKIT_LEGACY_FILE, True)
|
||||
polkit_file_exists = check_file_exist(POLKIT_FILE, True)
|
||||
usr_file_exists = check_file_exist(POLKIT_USR_FILE, True)
|
||||
|
||||
if legacy_file_exists or (polkit_file_exists and usr_file_exists):
|
||||
Logger.print_info("Moonraker policykit rules are already installed.")
|
||||
return
|
||||
|
||||
try:
|
||||
command = [POLKIT_SCRIPT, "--disable-systemctl"]
|
||||
result = subprocess.run(
|
||||
command,
|
||||
stderr=subprocess.PIPE,
|
||||
stdout=subprocess.DEVNULL,
|
||||
text=True,
|
||||
)
|
||||
if result.returncode != 0 or result.stderr:
|
||||
Logger.print_error(f"{result.stderr}", False)
|
||||
Logger.print_error("Installing Moonraker policykit rules failed!")
|
||||
return
|
||||
|
||||
Logger.print_ok("Moonraker policykit rules successfully installed!")
|
||||
except subprocess.CalledProcessError as e:
|
||||
log = f"Error while installing Moonraker policykit rules: {e.stderr.decode()}"
|
||||
Logger.print_error(log)
|
||||
|
||||
|
||||
def update_moonraker() -> None:
|
||||
if not get_confirm("Update Moonraker now?"):
|
||||
return
|
||||
|
||||
settings = KiauhSettings()
|
||||
if settings.kiauh.backup_before_update:
|
||||
backup_moonraker_dir()
|
||||
|
||||
instances = get_instances(Moonraker)
|
||||
InstanceManager.stop_all(instances)
|
||||
|
||||
git_pull_wrapper(repo=settings.moonraker.repo_url, target_dir=MOONRAKER_DIR)
|
||||
|
||||
# install possible new system packages
|
||||
install_moonraker_packages()
|
||||
# install possible new python dependencies
|
||||
install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
|
||||
|
||||
InstanceManager.start_all(instances)
|
||||
0
kiauh/components/moonraker/services/__init__.py
Normal file
0
kiauh/components/moonraker/services/__init__.py
Normal file
@@ -0,0 +1,49 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Dict, List
|
||||
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from utils.instance_utils import get_instances
|
||||
|
||||
|
||||
class MoonrakerInstanceService:
|
||||
__cls_instance = None
|
||||
__instances: List[Moonraker] = []
|
||||
|
||||
def __new__(cls) -> "MoonrakerInstanceService":
|
||||
if cls.__cls_instance is None:
|
||||
cls.__cls_instance = super(MoonrakerInstanceService, cls).__new__(cls)
|
||||
return cls.__cls_instance
|
||||
|
||||
def __init__(self) -> None:
|
||||
if not hasattr(self, "__initialized"):
|
||||
self.__initialized = False
|
||||
if self.__initialized:
|
||||
return
|
||||
self.__initialized = True
|
||||
|
||||
def load_instances(self) -> None:
|
||||
self.__instances = get_instances(Moonraker)
|
||||
|
||||
def create_new_instance(self, suffix: str) -> Moonraker:
|
||||
instance = Moonraker(suffix)
|
||||
self.__instances.append(instance)
|
||||
return instance
|
||||
|
||||
def get_all_instances(self) -> List[Moonraker]:
|
||||
return self.__instances
|
||||
|
||||
def get_instance_by_suffix(self, suffix: str) -> Moonraker | None:
|
||||
instances: List[Moonraker] = [i for i in self.__instances if i.suffix == suffix]
|
||||
return instances[0] if instances else None
|
||||
|
||||
def get_instance_port_map(self) -> Dict[str, int]:
|
||||
return {i.suffix: i.port for i in self.__instances}
|
||||
408
kiauh/components/moonraker/services/moonraker_setup_service.py
Normal file
408
kiauh/components/moonraker/services/moonraker_setup_service.py
Normal file
@@ -0,0 +1,408 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
from __future__ import annotations
|
||||
|
||||
from copy import copy
|
||||
from subprocess import DEVNULL, PIPE, CalledProcessError, run
|
||||
from typing import List
|
||||
|
||||
from components.klipper.klipper import Klipper
|
||||
from components.klipper.klipper_dialogs import print_instance_overview
|
||||
from components.klipper.services.klipper_instance_service import KlipperInstanceService
|
||||
from components.moonraker import (
|
||||
EXIT_MOONRAKER_SETUP,
|
||||
MOONRAKER_DIR,
|
||||
MOONRAKER_ENV_DIR,
|
||||
MOONRAKER_REPO_URL,
|
||||
MOONRAKER_REQ_FILE,
|
||||
MOONRAKER_SPEEDUPS_REQ_FILE,
|
||||
POLKIT_FILE,
|
||||
POLKIT_LEGACY_FILE,
|
||||
POLKIT_SCRIPT,
|
||||
POLKIT_USR_FILE,
|
||||
)
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from components.moonraker.moonraker_dialogs import print_moonraker_overview
|
||||
from components.moonraker.services.moonraker_instance_service import (
|
||||
MoonrakerInstanceService,
|
||||
)
|
||||
from components.moonraker.utils.utils import (
|
||||
backup_moonraker_dir,
|
||||
create_example_moonraker_conf,
|
||||
install_moonraker_packages,
|
||||
remove_polkit_rules,
|
||||
)
|
||||
from components.webui_client.client_utils import (
|
||||
enable_mainsail_remotemode,
|
||||
get_existing_clients,
|
||||
)
|
||||
from components.webui_client.mainsail_data import MainsailData
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.message_service import Message, MessageService
|
||||
from core.settings.kiauh_settings import KiauhSettings
|
||||
from core.types.color import Color
|
||||
from utils.common import check_install_dependencies
|
||||
from utils.fs_utils import check_file_exist, run_remove_routines
|
||||
from utils.git_utils import git_clone_wrapper, git_pull_wrapper
|
||||
from utils.input_utils import (
|
||||
get_confirm,
|
||||
get_selection_input,
|
||||
)
|
||||
from utils.sys_utils import (
|
||||
check_python_version,
|
||||
cmd_sysctl_manage,
|
||||
cmd_sysctl_service,
|
||||
create_python_venv,
|
||||
get_ipv4_addr,
|
||||
install_python_requirements,
|
||||
unit_file_exists,
|
||||
)
|
||||
|
||||
|
||||
# noinspection PyMethodMayBeStatic
|
||||
class MoonrakerSetupService:
|
||||
__cls_instance = None
|
||||
|
||||
kisvc: KlipperInstanceService
|
||||
misvc: MoonrakerInstanceService
|
||||
msgsvc = MessageService
|
||||
|
||||
settings: KiauhSettings
|
||||
klipper_list: List[Klipper]
|
||||
moonraker_list: List[Moonraker]
|
||||
|
||||
def __new__(cls) -> "MoonrakerSetupService":
|
||||
if cls.__cls_instance is None:
|
||||
cls.__cls_instance = super(MoonrakerSetupService, cls).__new__(cls)
|
||||
return cls.__cls_instance
|
||||
|
||||
def __init__(self) -> None:
|
||||
if not hasattr(self, "__initialized"):
|
||||
self.__initialized = False
|
||||
if self.__initialized:
|
||||
return
|
||||
self.__initialized = True
|
||||
self.__init_state()
|
||||
|
||||
def __init_state(self) -> None:
|
||||
self.settings = KiauhSettings()
|
||||
|
||||
self.kisvc = KlipperInstanceService()
|
||||
self.kisvc.load_instances()
|
||||
self.klipper_list = self.kisvc.get_all_instances()
|
||||
|
||||
self.misvc = MoonrakerInstanceService()
|
||||
self.misvc.load_instances()
|
||||
self.moonraker_list = self.misvc.get_all_instances()
|
||||
|
||||
self.msgsvc = MessageService()
|
||||
|
||||
def __refresh_state(self) -> None:
|
||||
self.kisvc.load_instances()
|
||||
self.klipper_list = self.kisvc.get_all_instances()
|
||||
|
||||
self.misvc.load_instances()
|
||||
self.moonraker_list = self.misvc.get_all_instances()
|
||||
|
||||
def install(self) -> None:
|
||||
self.__refresh_state()
|
||||
|
||||
if not self.__check_requirements(self.klipper_list):
|
||||
return
|
||||
|
||||
new_instances: List[Moonraker] = []
|
||||
selected_option: str | Klipper
|
||||
|
||||
if len(self.klipper_list) == 1:
|
||||
suffix: str = self.klipper_list[0].suffix
|
||||
new_inst = self.misvc.create_new_instance(suffix)
|
||||
new_instances.append(new_inst)
|
||||
|
||||
else:
|
||||
print_moonraker_overview(
|
||||
self.klipper_list,
|
||||
self.moonraker_list,
|
||||
show_index=True,
|
||||
show_select_all=True,
|
||||
)
|
||||
options = {str(i + 1): k for i, k in enumerate(self.klipper_list)}
|
||||
additional_options = {"a": None, "b": None}
|
||||
options = {**options, **additional_options}
|
||||
question = "Select Klipper instance to setup Moonraker for"
|
||||
selected_option = get_selection_input(question, options)
|
||||
|
||||
if selected_option == "b":
|
||||
Logger.print_status(EXIT_MOONRAKER_SETUP)
|
||||
return
|
||||
|
||||
if selected_option == "a":
|
||||
new_inst_list: List[Moonraker] = [
|
||||
self.misvc.create_new_instance(k.suffix) for k in self.klipper_list
|
||||
]
|
||||
new_instances.extend(new_inst_list)
|
||||
else:
|
||||
klipper_instance: Klipper | None = options.get(selected_option)
|
||||
if klipper_instance is None:
|
||||
raise Exception("Error selecting instance!")
|
||||
new_inst = self.misvc.create_new_instance(klipper_instance.suffix)
|
||||
new_instances.append(new_inst)
|
||||
|
||||
create_example_cfg = get_confirm("Create example moonraker.conf?")
|
||||
|
||||
try:
|
||||
self.__run_setup(new_instances, create_example_cfg)
|
||||
except Exception as e:
|
||||
Logger.print_error(f"Error while installing Moonraker: {e}")
|
||||
return
|
||||
|
||||
def update(self) -> None:
|
||||
Logger.print_dialog(
|
||||
DialogType.WARNING,
|
||||
[
|
||||
"Be careful if there are ongoing prints running!",
|
||||
"All Moonraker instances will be restarted during the update process and "
|
||||
"ongoing prints COULD FAIL.",
|
||||
],
|
||||
)
|
||||
|
||||
if not get_confirm("Update Moonraker now?"):
|
||||
return
|
||||
|
||||
self.__refresh_state()
|
||||
|
||||
if self.settings.kiauh.backup_before_update:
|
||||
backup_moonraker_dir()
|
||||
|
||||
InstanceManager.stop_all(self.moonraker_list)
|
||||
git_pull_wrapper(MOONRAKER_DIR)
|
||||
install_moonraker_packages()
|
||||
install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
|
||||
InstanceManager.start_all(self.moonraker_list)
|
||||
|
||||
def remove(
|
||||
self,
|
||||
remove_service: bool,
|
||||
remove_dir: bool,
|
||||
remove_env: bool,
|
||||
remove_polkit: bool,
|
||||
) -> None:
|
||||
self.__refresh_state()
|
||||
|
||||
completion_msg = Message(
|
||||
title="Moonraker Removal Process completed",
|
||||
color=Color.GREEN,
|
||||
)
|
||||
|
||||
if remove_service:
|
||||
Logger.print_status("Removing Moonraker instances ...")
|
||||
if self.moonraker_list:
|
||||
instances_to_remove = self.__get_instances_to_remove()
|
||||
self.__remove_instances(instances_to_remove)
|
||||
if instances_to_remove:
|
||||
instance_names = [
|
||||
i.service_file_path.stem for i in instances_to_remove
|
||||
]
|
||||
txt = f"● Moonraker instances removed: {', '.join(instance_names)}"
|
||||
completion_msg.text.append(txt)
|
||||
else:
|
||||
Logger.print_info("No Moonraker Services installed! Skipped ...")
|
||||
|
||||
if (remove_polkit or remove_dir or remove_env) and unit_file_exists(
|
||||
"moonraker", suffix="service"
|
||||
):
|
||||
completion_msg.text = [
|
||||
"Some Klipper services are still installed:",
|
||||
"● Moonraker PolicyKit rules were not removed, even though selected for removal.",
|
||||
f"● '{MOONRAKER_DIR}' was not removed, even though selected for removal.",
|
||||
f"● '{MOONRAKER_ENV_DIR}' was not removed, even though selected for removal.",
|
||||
]
|
||||
else:
|
||||
if remove_polkit:
|
||||
Logger.print_status("Removing all Moonraker policykit rules ...")
|
||||
if remove_polkit_rules():
|
||||
completion_msg.text.append("● Moonraker policykit rules removed")
|
||||
if remove_dir:
|
||||
Logger.print_status("Removing Moonraker local repository ...")
|
||||
if run_remove_routines(MOONRAKER_DIR):
|
||||
completion_msg.text.append("● Moonraker local repository removed")
|
||||
if remove_env:
|
||||
Logger.print_status("Removing Moonraker Python environment ...")
|
||||
if run_remove_routines(MOONRAKER_ENV_DIR):
|
||||
completion_msg.text.append("● Moonraker Python environment removed")
|
||||
|
||||
if completion_msg.text:
|
||||
completion_msg.text.insert(0, "The following actions were performed:")
|
||||
else:
|
||||
completion_msg.color = Color.YELLOW
|
||||
completion_msg.centered = True
|
||||
completion_msg.text = ["Nothing to remove."]
|
||||
|
||||
self.msgsvc.set_message(completion_msg)
|
||||
|
||||
def __run_setup(
|
||||
self, new_instances: List[Moonraker], create_example_cfg: bool
|
||||
) -> None:
|
||||
check_install_dependencies()
|
||||
self.__install_deps()
|
||||
|
||||
ports_map = self.misvc.get_instance_port_map()
|
||||
for i in new_instances:
|
||||
i.create()
|
||||
cmd_sysctl_service(i.service_file_path.name, "enable")
|
||||
|
||||
if create_example_cfg:
|
||||
# if a webclient and/or it's config is installed, patch
|
||||
# its update section to the config
|
||||
clients = get_existing_clients()
|
||||
create_example_moonraker_conf(i, ports_map, clients)
|
||||
|
||||
cmd_sysctl_service(i.service_file_path.name, "start")
|
||||
|
||||
cmd_sysctl_manage("daemon-reload")
|
||||
|
||||
# if mainsail is installed, and we installed
|
||||
# multiple moonraker instances, we enable mainsails remote mode
|
||||
if MainsailData().client_dir.exists() and len(self.moonraker_list) > 1:
|
||||
enable_mainsail_remotemode()
|
||||
|
||||
self.misvc.load_instances()
|
||||
new_instances = [
|
||||
self.misvc.get_instance_by_suffix(i.suffix) for i in new_instances
|
||||
]
|
||||
|
||||
ip: str = get_ipv4_addr()
|
||||
# noinspection HttpUrlsUsage
|
||||
url_list = [
|
||||
f"● {i.service_file_path.stem}: http://{ip}:{i.port}"
|
||||
for i in new_instances
|
||||
if i.port
|
||||
]
|
||||
dialog_content = []
|
||||
if url_list:
|
||||
dialog_content.append("You can access Moonraker via the following URL:")
|
||||
dialog_content.extend(url_list)
|
||||
|
||||
Logger.print_dialog(
|
||||
DialogType.CUSTOM,
|
||||
custom_title="Moonraker successfully installed!",
|
||||
custom_color=Color.GREEN,
|
||||
content=dialog_content,
|
||||
)
|
||||
|
||||
def __check_requirements(self, klipper_list: List[Klipper]) -> bool:
|
||||
is_klipper_installed = len(klipper_list) >= 1
|
||||
if not is_klipper_installed:
|
||||
Logger.print_warn("Klipper not installed!")
|
||||
Logger.print_warn("Moonraker cannot be installed! Install Klipper first.")
|
||||
|
||||
is_python_ok = check_python_version(3, 7)
|
||||
|
||||
return is_klipper_installed and is_python_ok
|
||||
|
||||
def __install_deps(self) -> None:
|
||||
default_repo = (MOONRAKER_REPO_URL, "master")
|
||||
repo = self.settings.moonraker.repositories
|
||||
# pull the first repo defined in kiauh.cfg or fallback to the official Moonraker repo
|
||||
repo, branch = (repo[0].url, repo[0].branch) if repo else default_repo
|
||||
git_clone_wrapper(repo, MOONRAKER_DIR, branch)
|
||||
|
||||
try:
|
||||
install_moonraker_packages()
|
||||
if create_python_venv(MOONRAKER_ENV_DIR, False, False, self.settings.moonraker.use_python_binary):
|
||||
install_python_requirements(MOONRAKER_ENV_DIR, MOONRAKER_REQ_FILE)
|
||||
if self.settings.moonraker.optional_speedups:
|
||||
install_python_requirements(
|
||||
MOONRAKER_ENV_DIR, MOONRAKER_SPEEDUPS_REQ_FILE
|
||||
)
|
||||
self.__install_polkit()
|
||||
except Exception:
|
||||
Logger.print_error("Error during installation of Moonraker requirements!")
|
||||
raise
|
||||
|
||||
def __install_polkit(self) -> None:
|
||||
Logger.print_status("Installing Moonraker policykit rules ...")
|
||||
|
||||
legacy_file_exists = check_file_exist(POLKIT_LEGACY_FILE, True)
|
||||
polkit_file_exists = check_file_exist(POLKIT_FILE, True)
|
||||
usr_file_exists = check_file_exist(POLKIT_USR_FILE, True)
|
||||
|
||||
if legacy_file_exists or (polkit_file_exists and usr_file_exists):
|
||||
Logger.print_info("Moonraker policykit rules are already installed.")
|
||||
return
|
||||
|
||||
try:
|
||||
command = [POLKIT_SCRIPT, "--disable-systemctl"]
|
||||
result = run(
|
||||
command,
|
||||
stderr=PIPE,
|
||||
stdout=DEVNULL,
|
||||
text=True,
|
||||
)
|
||||
if result.returncode != 0 or result.stderr:
|
||||
Logger.print_error(f"{result.stderr}", False)
|
||||
Logger.print_error("Installing Moonraker policykit rules failed!")
|
||||
return
|
||||
|
||||
Logger.print_ok("Moonraker policykit rules successfully installed!")
|
||||
except CalledProcessError as e:
|
||||
log = (
|
||||
f"Error while installing Moonraker policykit rules: {e.stderr.decode()}"
|
||||
)
|
||||
Logger.print_error(log)
|
||||
|
||||
def __get_instances_to_remove(self) -> List[Moonraker] | None:
|
||||
start_index = 1
|
||||
curr_instances: List[Moonraker] = self.moonraker_list
|
||||
instance_count = len(curr_instances)
|
||||
|
||||
options = [str(i + start_index) for i in range(instance_count)]
|
||||
options.extend(["a", "b"])
|
||||
instance_map = {
|
||||
options[i]: self.moonraker_list[i] for i in range(instance_count)
|
||||
}
|
||||
|
||||
print_instance_overview(
|
||||
self.moonraker_list,
|
||||
start_index=start_index,
|
||||
show_index=True,
|
||||
show_select_all=True,
|
||||
)
|
||||
selection = get_selection_input("Select Moonraker instance to remove", options)
|
||||
|
||||
if selection == "b":
|
||||
return None
|
||||
elif selection == "a":
|
||||
return copy(self.moonraker_list)
|
||||
|
||||
return [instance_map[selection]]
|
||||
|
||||
def __remove_instances(
|
||||
self,
|
||||
instance_list: List[Moonraker] | None,
|
||||
) -> None:
|
||||
if not instance_list:
|
||||
return
|
||||
|
||||
for instance in instance_list:
|
||||
Logger.print_status(
|
||||
f"Removing instance {instance.service_file_path.stem} ..."
|
||||
)
|
||||
InstanceManager.remove(instance)
|
||||
self.__delete_env_file(instance)
|
||||
|
||||
self.__refresh_state()
|
||||
|
||||
def __delete_env_file(self, instance: Moonraker):
|
||||
Logger.print_status(f"Remove '{instance.env_file}'")
|
||||
if not instance.env_file.exists():
|
||||
msg = f"Env file in {instance.base.sysd_dir} not found. Skipped ..."
|
||||
Logger.print_info(msg)
|
||||
return
|
||||
run_remove_routines(instance.env_file)
|
||||
0
kiauh/components/moonraker/utils/__init__.py
Normal file
0
kiauh/components/moonraker/utils/__init__.py
Normal file
173
kiauh/components/moonraker/utils/sysdeps_parser.py
Normal file
173
kiauh/components/moonraker/utils/sysdeps_parser.py
Normal file
@@ -0,0 +1,173 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# It was modified by Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# The original file is part of Moonraker: #
|
||||
# https://github.com/Arksine/moonraker #
|
||||
# Copyright (C) 2025 Eric Callahan <arksine.code@gmail.com> #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
import pathlib
|
||||
import re
|
||||
import shlex
|
||||
from typing import Any, Dict, List, Tuple
|
||||
|
||||
|
||||
def _get_distro_info() -> Dict[str, Any]:
|
||||
release_file = pathlib.Path("/etc/os-release")
|
||||
release_info: Dict[str, str] = {}
|
||||
with release_file.open("r") as f:
|
||||
lexer = shlex.shlex(f, posix=True)
|
||||
lexer.whitespace_split = True
|
||||
for item in list(lexer):
|
||||
if "=" in item:
|
||||
key, val = item.split("=", maxsplit=1)
|
||||
release_info[key] = val
|
||||
return dict(
|
||||
distro_id=release_info.get("ID", ""),
|
||||
distro_version=release_info.get("VERSION_ID", ""),
|
||||
aliases=release_info.get("ID_LIKE", "").split(),
|
||||
)
|
||||
|
||||
|
||||
def _convert_version(version: str) -> Tuple[str | int, ...]:
|
||||
version = version.strip()
|
||||
ver_match = re.match(r"\d+(\.\d+)*((?:-|\.).+)?", version)
|
||||
if ver_match is not None:
|
||||
return tuple(
|
||||
[
|
||||
int(part) if part.isdigit() else part
|
||||
for part in re.split(r"\.|-", version)
|
||||
]
|
||||
)
|
||||
return (version,)
|
||||
|
||||
|
||||
class SysDepsParser:
|
||||
def __init__(self, distro_info: Dict[str, Any] | None = None) -> None:
|
||||
if distro_info is None:
|
||||
distro_info = _get_distro_info()
|
||||
self.distro_id: str = distro_info.get("distro_id", "")
|
||||
self.aliases: List[str] = distro_info.get("aliases", [])
|
||||
self.distro_version: Tuple[int | str, ...] = tuple()
|
||||
version = distro_info.get("distro_version")
|
||||
if version:
|
||||
self.distro_version = _convert_version(version)
|
||||
|
||||
def _parse_spec(self, full_spec: str) -> str | None:
|
||||
parts = full_spec.split(";", maxsplit=1)
|
||||
if len(parts) == 1:
|
||||
return full_spec
|
||||
pkg_name = parts[0].strip()
|
||||
expressions = re.split(r"( and | or )", parts[1].strip())
|
||||
if not len(expressions) & 1:
|
||||
# There should always be an odd number of expressions. Each
|
||||
# expression is separated by an "and" or "or" operator
|
||||
logging.info(
|
||||
f"Requirement specifier is missing an expression "
|
||||
f"between logical operators : {full_spec}"
|
||||
)
|
||||
return None
|
||||
last_result: bool = True
|
||||
last_logical_op: str | None = "and"
|
||||
for idx, exp in enumerate(expressions):
|
||||
if idx & 1:
|
||||
if last_logical_op is not None:
|
||||
logging.info(
|
||||
"Requirement specifier contains sequential logical "
|
||||
f"operators: {full_spec}"
|
||||
)
|
||||
return None
|
||||
logical_op = exp.strip()
|
||||
if logical_op not in ("and", "or"):
|
||||
logging.info(
|
||||
f"Invalid logical operator {logical_op} in requirement "
|
||||
f"specifier: {full_spec}"
|
||||
)
|
||||
return None
|
||||
last_logical_op = logical_op
|
||||
continue
|
||||
elif last_logical_op is None:
|
||||
logging.info(
|
||||
f"Requirement specifier contains two seqential expressions "
|
||||
f"without a logical operator: {full_spec}"
|
||||
)
|
||||
return None
|
||||
dep_parts = re.split(r"(==|!=|<=|>=|<|>)", exp.strip())
|
||||
req_var = dep_parts[0].strip().lower()
|
||||
if len(dep_parts) != 3:
|
||||
logging.info(f"Invalid comparison, must be 3 parts: {full_spec}")
|
||||
return None
|
||||
elif req_var == "distro_id":
|
||||
left_op: str | Tuple[int | str, ...] = self.distro_id
|
||||
right_op = dep_parts[2].strip().strip("\"'")
|
||||
elif req_var == "distro_version":
|
||||
if not self.distro_version:
|
||||
logging.info(
|
||||
"Distro Version not detected, cannot satisfy requirement: "
|
||||
f"{full_spec}"
|
||||
)
|
||||
return None
|
||||
left_op = self.distro_version
|
||||
right_op = _convert_version(dep_parts[2].strip().strip("\"'"))
|
||||
else:
|
||||
logging.info(f"Invalid requirement specifier: {full_spec}")
|
||||
return None
|
||||
operator = dep_parts[1].strip()
|
||||
try:
|
||||
compfunc = {
|
||||
"<": lambda x, y: x < y,
|
||||
">": lambda x, y: x > y,
|
||||
"==": lambda x, y: x == y,
|
||||
"!=": lambda x, y: x != y,
|
||||
">=": lambda x, y: x >= y,
|
||||
"<=": lambda x, y: x <= y,
|
||||
}.get(operator, lambda x, y: False)
|
||||
result = compfunc(left_op, right_op)
|
||||
if last_logical_op == "and":
|
||||
last_result &= result
|
||||
else:
|
||||
last_result |= result
|
||||
last_logical_op = None
|
||||
except Exception:
|
||||
logging.exception(f"Error comparing requirements: {full_spec}")
|
||||
return None
|
||||
if last_result:
|
||||
return pkg_name
|
||||
return None
|
||||
|
||||
def parse_dependencies(self, sys_deps: Dict[str, List[str]]) -> List[str]:
|
||||
if not self.distro_id:
|
||||
logging.info(
|
||||
"Failed to detect current distro ID, cannot parse dependencies"
|
||||
)
|
||||
return []
|
||||
all_ids = [self.distro_id] + self.aliases
|
||||
for distro_id in all_ids:
|
||||
if distro_id in sys_deps:
|
||||
if not sys_deps[distro_id]:
|
||||
logging.info(
|
||||
f"Dependency data contains an empty package definition "
|
||||
f"for linux distro '{distro_id}'"
|
||||
)
|
||||
continue
|
||||
processed_deps: List[str] = []
|
||||
for dep in sys_deps[distro_id]:
|
||||
parsed_dep = self._parse_spec(dep)
|
||||
if parsed_dep is not None:
|
||||
processed_deps.append(parsed_dep)
|
||||
return processed_deps
|
||||
else:
|
||||
logging.info(
|
||||
f"Dependency data has no package definition for linux "
|
||||
f"distro '{self.distro_id}'"
|
||||
)
|
||||
return []
|
||||
@@ -1,13 +1,15 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
|
||||
import json
|
||||
import shutil
|
||||
from pathlib import Path
|
||||
from subprocess import DEVNULL, PIPE, CalledProcessError, run
|
||||
from typing import Dict, List, Optional
|
||||
|
||||
from components.moonraker import (
|
||||
@@ -15,21 +17,25 @@ from components.moonraker import (
|
||||
MOONRAKER_BACKUP_DIR,
|
||||
MOONRAKER_DB_BACKUP_DIR,
|
||||
MOONRAKER_DEFAULT_PORT,
|
||||
MOONRAKER_DEPS_JSON_FILE,
|
||||
MOONRAKER_DIR,
|
||||
MOONRAKER_ENV_DIR,
|
||||
MOONRAKER_INSTALL_SCRIPT,
|
||||
)
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from components.moonraker.utils.sysdeps_parser import SysDepsParser
|
||||
from components.webui_client.base_data import BaseWebClient
|
||||
from core.backup_manager.backup_manager import BackupManager
|
||||
from core.logger import Logger
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from core.types import ComponentStatus
|
||||
from utils.common import get_install_status
|
||||
from core.types.component_status import ComponentStatus
|
||||
from utils.common import check_install_dependencies, get_install_status
|
||||
from utils.instance_utils import get_instances
|
||||
from utils.sys_utils import (
|
||||
get_ipv4_addr,
|
||||
parse_packages_from_file,
|
||||
)
|
||||
|
||||
|
||||
@@ -37,6 +43,46 @@ def get_moonraker_status() -> ComponentStatus:
|
||||
return get_install_status(MOONRAKER_DIR, MOONRAKER_ENV_DIR, Moonraker)
|
||||
|
||||
|
||||
def install_moonraker_packages() -> None:
|
||||
Logger.print_status("Parsing Moonraker system dependencies ...")
|
||||
|
||||
moonraker_deps = []
|
||||
if MOONRAKER_DEPS_JSON_FILE.exists():
|
||||
Logger.print_info(
|
||||
f"Parsing system dependencies from {MOONRAKER_DEPS_JSON_FILE.name} ..."
|
||||
)
|
||||
parser = SysDepsParser()
|
||||
sysdeps = load_sysdeps_json(MOONRAKER_DEPS_JSON_FILE)
|
||||
moonraker_deps.extend(parser.parse_dependencies(sysdeps))
|
||||
|
||||
elif MOONRAKER_INSTALL_SCRIPT.exists():
|
||||
Logger.print_warn(f"{MOONRAKER_DEPS_JSON_FILE.name} not found!")
|
||||
Logger.print_info(
|
||||
f"Parsing system dependencies from {MOONRAKER_INSTALL_SCRIPT.name} ..."
|
||||
)
|
||||
moonraker_deps = parse_packages_from_file(MOONRAKER_INSTALL_SCRIPT)
|
||||
|
||||
if not moonraker_deps:
|
||||
raise ValueError("Error parsing Moonraker dependencies!")
|
||||
|
||||
check_install_dependencies({*moonraker_deps})
|
||||
|
||||
|
||||
def remove_polkit_rules() -> bool:
|
||||
if not MOONRAKER_DIR.exists():
|
||||
log = "Cannot remove policykit rules. Moonraker directory not found."
|
||||
Logger.print_warn(log)
|
||||
return False
|
||||
|
||||
try:
|
||||
cmd = [f"{MOONRAKER_DIR}/scripts/set-policykit-rules.sh", "--clear"]
|
||||
run(cmd, stderr=PIPE, stdout=DEVNULL, check=True)
|
||||
return True
|
||||
except CalledProcessError as e:
|
||||
Logger.print_error(f"Error while removing policykit rules: {e}")
|
||||
return False
|
||||
|
||||
|
||||
def create_example_moonraker_conf(
|
||||
instance: Moonraker,
|
||||
ports_map: Dict[str, int],
|
||||
@@ -80,7 +126,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))
|
||||
@@ -138,3 +184,13 @@ def backup_moonraker_db_dir() -> None:
|
||||
bm.backup_directory(
|
||||
name, source=instance.db_dir, target=MOONRAKER_DB_BACKUP_DIR
|
||||
)
|
||||
|
||||
|
||||
def load_sysdeps_json(file: Path) -> Dict[str, List[str]]:
|
||||
try:
|
||||
sysdeps: Dict[str, List[str]] = json.loads(file.read_bytes())
|
||||
except json.JSONDecodeError as e:
|
||||
Logger.print_error(f"Unable to parse {file.name}:\n{e}")
|
||||
return {}
|
||||
else:
|
||||
return sysdeps
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -37,6 +37,7 @@ class BaseWebClient(ABC):
|
||||
backup_dir: Path
|
||||
repo_path: str
|
||||
download_url: str
|
||||
nginx_config: Path
|
||||
nginx_access_log: Path
|
||||
nginx_error_log: Path
|
||||
client_config: BaseWebClientConfig
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -14,8 +14,11 @@ 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.message_service import Message
|
||||
from core.types.color import Color
|
||||
from utils.config_utils import remove_config_section
|
||||
from utils.fs_utils import run_remove_routines
|
||||
from utils.instance_type import InstanceType
|
||||
from utils.instance_utils import get_instances
|
||||
|
||||
|
||||
@@ -23,21 +26,66 @@ def run_client_config_removal(
|
||||
client_config: BaseWebClientConfig,
|
||||
kl_instances: List[Klipper],
|
||||
mr_instances: List[Moonraker],
|
||||
) -> None:
|
||||
remove_client_config_dir(client_config)
|
||||
remove_client_config_symlink(client_config)
|
||||
remove_config_section(f"update_manager {client_config.name}", mr_instances)
|
||||
remove_config_section(client_config.config_section, kl_instances)
|
||||
|
||||
|
||||
def remove_client_config_dir(client_config: BaseWebClientConfig) -> None:
|
||||
) -> Message:
|
||||
completion_msg = Message(
|
||||
title=f"{client_config.display_name} Removal Process completed",
|
||||
color=Color.GREEN,
|
||||
)
|
||||
Logger.print_status(f"Removing {client_config.display_name} ...")
|
||||
run_remove_routines(client_config.config_dir)
|
||||
if run_remove_routines(client_config.config_dir):
|
||||
completion_msg.text.append(f"● {client_config.display_name} removed")
|
||||
|
||||
completion_msg = remove_moonraker_config_section(
|
||||
completion_msg, client_config, mr_instances
|
||||
)
|
||||
|
||||
completion_msg = remove_printer_config_section(
|
||||
completion_msg, client_config, kl_instances
|
||||
)
|
||||
|
||||
if completion_msg.text:
|
||||
completion_msg.text.insert(0, "The following actions were performed:")
|
||||
else:
|
||||
completion_msg.color = Color.YELLOW
|
||||
completion_msg.centered = True
|
||||
completion_msg.text = ["Nothing to remove."]
|
||||
|
||||
return completion_msg
|
||||
|
||||
|
||||
def remove_client_config_symlink(client_config: BaseWebClientConfig) -> None:
|
||||
def remove_cfg_symlink(client_config: BaseWebClientConfig, message: Message) -> Message:
|
||||
instances: List[Klipper] = get_instances(Klipper)
|
||||
kl_instances = []
|
||||
for instance in instances:
|
||||
run_remove_routines(
|
||||
instance.base.cfg_dir.joinpath(client_config.config_filename)
|
||||
)
|
||||
cfg = instance.base.cfg_dir.joinpath(client_config.config_filename)
|
||||
if run_remove_routines(cfg):
|
||||
kl_instances.append(instance)
|
||||
text = f"{client_config.display_name} removed from instance"
|
||||
return update_msg(kl_instances, message, text)
|
||||
|
||||
|
||||
def remove_printer_config_section(
|
||||
message: Message, client_config: BaseWebClientConfig, kl_instances: List[Klipper]
|
||||
) -> Message:
|
||||
kl_section = client_config.config_section
|
||||
kl_instances = remove_config_section(kl_section, kl_instances)
|
||||
text = f"Klipper config section '{kl_section}' removed for instance"
|
||||
return update_msg(kl_instances, message, text)
|
||||
|
||||
|
||||
def remove_moonraker_config_section(
|
||||
message: Message, client_config: BaseWebClientConfig, mr_instances: List[Moonraker]
|
||||
) -> Message:
|
||||
mr_section = f"update_manager {client_config.name}"
|
||||
mr_instances = remove_config_section(mr_section, mr_instances)
|
||||
text = f"Moonraker config section '{mr_section}' removed for instance"
|
||||
return update_msg(mr_instances, message, text)
|
||||
|
||||
|
||||
def update_msg(instances: List[InstanceType], message: Message, text: str) -> Message:
|
||||
if not instances:
|
||||
return message
|
||||
|
||||
instance_names = [i.service_file_path.stem for i in instances]
|
||||
message.text.append(f"● {text}: {', '.join(instance_names)}")
|
||||
return message
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -106,7 +106,7 @@ def update_client_config(client: BaseWebClient) -> None:
|
||||
if settings.kiauh.backup_before_update:
|
||||
backup_client_config_data(client)
|
||||
|
||||
git_pull_wrapper(client_config.repo_url, client_config.config_dir)
|
||||
git_pull_wrapper(client_config.config_dir)
|
||||
|
||||
Logger.print_ok(f"Successfully updated {client_config.display_name}.")
|
||||
Logger.print_info("Restart Klipper to reload the configuration!")
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -19,6 +19,8 @@ from components.webui_client.client_config.client_config_remove import (
|
||||
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.message_service import Message
|
||||
from core.types.color import Color
|
||||
from utils.config_utils import remove_config_section
|
||||
from utils.fs_utils import (
|
||||
remove_with_sudo,
|
||||
@@ -32,54 +34,79 @@ def run_client_removal(
|
||||
remove_client: bool,
|
||||
remove_client_cfg: bool,
|
||||
backup_config: bool,
|
||||
) -> None:
|
||||
) -> Message:
|
||||
completion_msg = Message(
|
||||
title=f"{client.display_name} Removal Process completed",
|
||||
color=Color.GREEN,
|
||||
)
|
||||
mr_instances: List[Moonraker] = get_instances(Moonraker)
|
||||
kl_instances: List[Klipper] = get_instances(Klipper)
|
||||
|
||||
if backup_config:
|
||||
bm = BackupManager()
|
||||
bm.backup_file(client.config_file)
|
||||
if bm.backup_file(client.config_file):
|
||||
completion_msg.text.append(f"● {client.config_file.name} backup created")
|
||||
|
||||
if remove_client:
|
||||
client_name = client.name
|
||||
remove_client_dir(client)
|
||||
remove_client_nginx_config(client_name)
|
||||
remove_client_nginx_logs(client, kl_instances)
|
||||
if remove_client_dir(client):
|
||||
completion_msg.text.append(f"● {client.display_name} removed")
|
||||
if remove_client_nginx_config(client_name):
|
||||
completion_msg.text.append("● NGINX config removed")
|
||||
if remove_client_nginx_logs(client, kl_instances):
|
||||
completion_msg.text.append("● NGINX logs removed")
|
||||
|
||||
section = f"update_manager {client_name}"
|
||||
remove_config_section(section, mr_instances)
|
||||
handled_instances: List[Moonraker] = remove_config_section(
|
||||
section, mr_instances
|
||||
)
|
||||
if handled_instances:
|
||||
names = [i.service_file_path.stem for i in handled_instances]
|
||||
completion_msg.text.append(
|
||||
f"● Moonraker config section '{section}' removed for instance: {', '.join(names)}"
|
||||
)
|
||||
|
||||
if remove_client_cfg:
|
||||
run_client_config_removal(
|
||||
cfg_completion_msg = run_client_config_removal(
|
||||
client.client_config,
|
||||
kl_instances,
|
||||
mr_instances,
|
||||
)
|
||||
if cfg_completion_msg.color == Color.GREEN:
|
||||
completion_msg.text.extend(cfg_completion_msg.text[1:])
|
||||
|
||||
if not completion_msg.text:
|
||||
completion_msg.color = Color.YELLOW
|
||||
completion_msg.centered = True
|
||||
completion_msg.text.append("Nothing to remove.")
|
||||
else:
|
||||
completion_msg.text.insert(0, "The following actions were performed:")
|
||||
|
||||
return completion_msg
|
||||
|
||||
|
||||
def remove_client_dir(client: BaseWebClient) -> None:
|
||||
def remove_client_dir(client: BaseWebClient) -> bool:
|
||||
Logger.print_status(f"Removing {client.display_name} ...")
|
||||
run_remove_routines(client.client_dir)
|
||||
return run_remove_routines(client.client_dir)
|
||||
|
||||
|
||||
def remove_client_nginx_config(name: str) -> None:
|
||||
def remove_client_nginx_config(name: str) -> bool:
|
||||
Logger.print_status(f"Removing NGINX config for {name.capitalize()} ...")
|
||||
|
||||
remove_with_sudo(NGINX_SITES_AVAILABLE.joinpath(name))
|
||||
remove_with_sudo(NGINX_SITES_ENABLED.joinpath(name))
|
||||
return remove_with_sudo(
|
||||
[
|
||||
NGINX_SITES_AVAILABLE.joinpath(name),
|
||||
NGINX_SITES_ENABLED.joinpath(name),
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
def remove_client_nginx_logs(client: BaseWebClient, instances: List[Klipper]) -> None:
|
||||
def remove_client_nginx_logs(client: BaseWebClient, instances: List[Klipper]) -> bool:
|
||||
Logger.print_status(f"Removing NGINX logs for {client.display_name} ...")
|
||||
|
||||
remove_with_sudo(client.nginx_access_log)
|
||||
remove_with_sudo(client.nginx_error_log)
|
||||
files = [client.nginx_access_log, client.nginx_error_log]
|
||||
if instances:
|
||||
for instance in instances:
|
||||
files.append(instance.base.log_dir.joinpath(client.nginx_access_log.name))
|
||||
files.append(instance.base.log_dir.joinpath(client.nginx_error_log.name))
|
||||
|
||||
if not instances:
|
||||
return
|
||||
|
||||
for instance in instances:
|
||||
run_remove_routines(
|
||||
instance.base.log_dir.joinpath(client.nginx_access_log.name)
|
||||
)
|
||||
run_remove_routines(instance.base.log_dir.joinpath(client.nginx_error_log.name))
|
||||
return remove_with_sudo(files)
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -36,8 +36,9 @@ from components.webui_client.client_utils import (
|
||||
symlink_webui_nginx_log,
|
||||
)
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogCustomColor, DialogType, Logger
|
||||
from core.logger import DialogType, Logger
|
||||
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.config_utils import add_config_section
|
||||
from utils.fs_utils import unzip
|
||||
@@ -101,6 +102,7 @@ def install_client(
|
||||
section=f"update_manager {client.name}",
|
||||
instances=mr_instances,
|
||||
options=[
|
||||
("persistent_files", ["config.json"]),
|
||||
("type", "web"),
|
||||
("channel", "stable"),
|
||||
("repo", str(client.repo_path)),
|
||||
@@ -140,10 +142,10 @@ def install_client(
|
||||
Logger.print_dialog(
|
||||
DialogType.CUSTOM,
|
||||
custom_title=f"{client.display_name} installation complete!",
|
||||
custom_color=DialogCustomColor.GREEN,
|
||||
custom_color=Color.GREEN,
|
||||
center_content=True,
|
||||
content=[
|
||||
f"Open {client.display_name} now on: http://{get_ipv4_addr()}:{port}",
|
||||
f"Open {client.display_name} now on: http://{get_ipv4_addr()}{'' if port == 80 else f':{port}'}",
|
||||
],
|
||||
)
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -26,19 +26,17 @@ from components.webui_client.fluidd_data import FluiddData
|
||||
from components.webui_client.mainsail_data import MainsailData
|
||||
from core.backup_manager.backup_manager import BackupManager
|
||||
from core.constants import (
|
||||
COLOR_CYAN,
|
||||
COLOR_YELLOW,
|
||||
NGINX_CONFD,
|
||||
NGINX_SITES_AVAILABLE,
|
||||
NGINX_SITES_ENABLED,
|
||||
RESET_FORMAT,
|
||||
)
|
||||
from core.logger import Logger
|
||||
from core.settings.kiauh_settings import KiauhSettings, WebUiSettings
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from core.types import ComponentStatus
|
||||
from core.types.color import Color
|
||||
from core.types.component_status import ComponentStatus
|
||||
from utils.common import get_install_status
|
||||
from utils.fs_utils import create_symlink, remove_file
|
||||
from utils.git_utils import (
|
||||
@@ -79,10 +77,10 @@ def get_current_client_config() -> str:
|
||||
installed = [c for c in clients if c.client_config.config_dir.exists()]
|
||||
|
||||
if not installed:
|
||||
return f"{COLOR_CYAN}-{RESET_FORMAT}"
|
||||
return Color.apply("-", Color.CYAN)
|
||||
elif len(installed) == 1:
|
||||
cfg = installed[0].client_config
|
||||
return f"{COLOR_CYAN}{cfg.display_name}{RESET_FORMAT}"
|
||||
return Color.apply(cfg.display_name, Color.CYAN)
|
||||
|
||||
# at this point, both client config folders exists, so we need to check
|
||||
# which are actually included in the printer.cfg of all klipper instances
|
||||
@@ -101,18 +99,18 @@ def get_current_client_config() -> str:
|
||||
|
||||
# if both are included in the same file, we have a potential conflict
|
||||
if includes_mainsail and includes_fluidd:
|
||||
return f"{COLOR_YELLOW}Conflict!{RESET_FORMAT}"
|
||||
return Color.apply("Conflict", Color.YELLOW)
|
||||
|
||||
if not mainsail_includes and not fluidd_includes:
|
||||
# there are no includes at all, even though the client config folders exist
|
||||
return f"{COLOR_CYAN}-{RESET_FORMAT}"
|
||||
return Color.apply("-", Color.CYAN)
|
||||
elif len(fluidd_includes) > len(mainsail_includes):
|
||||
# there are more instances that include fluidd than mainsail
|
||||
return f"{COLOR_CYAN}{fluidd.client_config.display_name}{RESET_FORMAT}"
|
||||
return Color.apply(fluidd.client_config.display_name, Color.CYAN)
|
||||
else:
|
||||
# there are the same amount of non-conflicting includes for each config
|
||||
# or more instances include mainsail than fluidd
|
||||
return f"{COLOR_CYAN}{mainsail.client_config.display_name}{RESET_FORMAT}"
|
||||
return Color.apply(mainsail.client_config.display_name, Color.CYAN)
|
||||
|
||||
|
||||
def enable_mainsail_remotemode() -> None:
|
||||
@@ -121,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
|
||||
|
||||
@@ -338,36 +336,62 @@ def create_nginx_cfg(
|
||||
raise
|
||||
|
||||
|
||||
def get_nginx_config_list() -> List[Path]:
|
||||
"""
|
||||
Get a list of all NGINX config files in /etc/nginx/sites-enabled
|
||||
:return: List of NGINX config files
|
||||
"""
|
||||
configs: List[Path] = []
|
||||
for config in NGINX_SITES_ENABLED.iterdir():
|
||||
if not config.is_file():
|
||||
continue
|
||||
configs.append(config)
|
||||
return configs
|
||||
|
||||
|
||||
def get_nginx_listen_port(config: Path) -> int | None:
|
||||
"""
|
||||
Get the listen port from an NGINX config file
|
||||
:param config: The NGINX config file to read the port from
|
||||
:return: The listen port as int or None if not found/parsable
|
||||
"""
|
||||
|
||||
# noinspection HttpUrlsUsage
|
||||
pattern = r"default_server|http://|https://|[;\[\]]"
|
||||
port = ""
|
||||
with open(config, "r") as cfg:
|
||||
for line in cfg.readlines():
|
||||
line = re.sub(pattern, "", line.strip())
|
||||
if line.startswith("listen"):
|
||||
if ":" not in line:
|
||||
port = line.split()[-1]
|
||||
else:
|
||||
port = line.split(":")[-1]
|
||||
try:
|
||||
return int(port)
|
||||
except ValueError:
|
||||
Logger.print_error(
|
||||
f"Unable to parse listen port {port} from {config.name}!"
|
||||
)
|
||||
return None
|
||||
|
||||
|
||||
def read_ports_from_nginx_configs() -> List[int]:
|
||||
"""
|
||||
Helper function to iterate over all NGINX configs and read all ports defined for listen
|
||||
Helper function to iterate over all NGINX configs
|
||||
and read all ports defined for listen
|
||||
:return: A sorted list of listen ports
|
||||
"""
|
||||
if not NGINX_SITES_ENABLED.exists():
|
||||
return []
|
||||
|
||||
port_list = []
|
||||
for config in NGINX_SITES_ENABLED.iterdir():
|
||||
if not config.is_file():
|
||||
continue
|
||||
port_list: List[int] = []
|
||||
for config in get_nginx_config_list():
|
||||
port = get_nginx_listen_port(config)
|
||||
if port is not None:
|
||||
port_list.append(port)
|
||||
|
||||
with open(config, "r") as cfg:
|
||||
lines = cfg.readlines()
|
||||
|
||||
for line in lines:
|
||||
line = re.sub(
|
||||
r"default_server|http://|https://|[;\[\]]",
|
||||
"",
|
||||
line.strip(),
|
||||
)
|
||||
if line.startswith("listen"):
|
||||
if ":" not in line:
|
||||
port_list.append(line.split()[-1])
|
||||
else:
|
||||
port_list.append(line.split(":")[-1])
|
||||
|
||||
ports_to_ints_list = [int(port) for port in port_list]
|
||||
return sorted(ports_to_ints_list, key=lambda x: int(x))
|
||||
return sorted(port_list, key=lambda x: int(x))
|
||||
|
||||
|
||||
def get_client_port_selection(
|
||||
@@ -390,7 +414,7 @@ def get_client_port_selection(
|
||||
while True:
|
||||
_type = "Reconfigure" if reconfigure else "Configure"
|
||||
question = f"{_type} {client.display_name} for port"
|
||||
port_input = get_number_input(question, min_count=80, default=port)
|
||||
port_input = get_number_input(question, min_value=80, default=port)
|
||||
|
||||
if port_input not in ports_in_use:
|
||||
client_settings: WebUiSettings = settings[client.name]
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -19,6 +19,7 @@ from components.webui_client.base_data import (
|
||||
WebClientType,
|
||||
)
|
||||
from core.backup_manager import BACKUP_ROOT_DIR
|
||||
from core.constants import NGINX_SITES_AVAILABLE
|
||||
|
||||
|
||||
@dataclass()
|
||||
@@ -44,6 +45,7 @@ class FluiddData(BaseWebClient):
|
||||
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")
|
||||
nginx_error_log: Path = Path("/var/log/nginx/fluidd-error.log")
|
||||
client_config: BaseWebClientConfig = None
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -19,6 +19,7 @@ from components.webui_client.base_data import (
|
||||
WebClientType,
|
||||
)
|
||||
from core.backup_manager import BACKUP_ROOT_DIR
|
||||
from core.constants import NGINX_SITES_AVAILABLE
|
||||
|
||||
|
||||
@dataclass()
|
||||
@@ -44,6 +45,7 @@ class MainsailData(BaseWebClient):
|
||||
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")
|
||||
nginx_error_log: Path = Path("/var/log/nginx/mainsail-error.log")
|
||||
client_config: BaseWebClientConfig = None
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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,13 +15,15 @@ from components.webui_client.base_data import BaseWebClient
|
||||
from components.webui_client.client_setup import install_client
|
||||
from components.webui_client.client_utils import (
|
||||
get_client_port_selection,
|
||||
get_nginx_listen_port,
|
||||
set_listen_port,
|
||||
)
|
||||
from core.constants import COLOR_CYAN, COLOR_GREEN, RESET_FORMAT
|
||||
from core.logger import DialogCustomColor, DialogType, Logger
|
||||
from core.logger import Logger
|
||||
from core.menus import Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.services.message_service import Message
|
||||
from core.settings.kiauh_settings import KiauhSettings, WebUiSettings
|
||||
from core.types.color import Color
|
||||
from utils.sys_utils import cmd_sysctl_service, get_ipv4_addr
|
||||
|
||||
|
||||
@@ -31,6 +33,8 @@ class ClientInstallMenu(BaseMenu):
|
||||
self, client: BaseWebClient, previous_menu: Type[BaseMenu] | None = None
|
||||
):
|
||||
super().__init__()
|
||||
self.title = f"Installation Menu > {client.display_name}"
|
||||
self.title_color = Color.GREEN
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
self.client: BaseWebClient = client
|
||||
self.settings = KiauhSettings()
|
||||
@@ -49,15 +53,9 @@ class ClientInstallMenu(BaseMenu):
|
||||
|
||||
def print_menu(self) -> None:
|
||||
client_name = self.client.display_name
|
||||
|
||||
header = f" [ Installation Menu > {client_name} ] "
|
||||
color = COLOR_GREEN
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
port = f"(Current: {COLOR_CYAN}{int(self.client_settings.port)}{RESET_FORMAT})"
|
||||
port = f"(Current: {Color.apply(self._get_current_port(), Color.GREEN)})"
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ 1) Reinstall {client_name:16} ║
|
||||
║ 2) Reconfigure Listen Port {port:<34} ║
|
||||
@@ -70,7 +68,7 @@ class ClientInstallMenu(BaseMenu):
|
||||
install_client(self.client, settings=self.settings, reinstall=True)
|
||||
|
||||
def change_listen_port(self, **kwargs) -> None:
|
||||
curr_port = int(self.client_settings.port)
|
||||
curr_port = self._get_current_port()
|
||||
new_port = get_client_port_selection(
|
||||
self.client,
|
||||
self.settings,
|
||||
@@ -88,17 +86,20 @@ class ClientInstallMenu(BaseMenu):
|
||||
cmd_sysctl_service("nginx", "start")
|
||||
|
||||
# noinspection HttpUrlsUsage
|
||||
Logger.print_dialog(
|
||||
DialogType.CUSTOM,
|
||||
custom_title="Port reconfiguration complete!",
|
||||
custom_color=DialogCustomColor.GREEN,
|
||||
center_content=True,
|
||||
content=[
|
||||
message = Message(
|
||||
title="Port reconfiguration complete!",
|
||||
text=[
|
||||
f"Open {self.client.display_name} now on: "
|
||||
f"http://{get_ipv4_addr()}:{new_port}",
|
||||
],
|
||||
color=Color.GREEN,
|
||||
)
|
||||
self.message_service.set_message(message)
|
||||
|
||||
def _go_back(self, **kwargs) -> None:
|
||||
if self.previous_menu is not None:
|
||||
self.previous_menu().run()
|
||||
def _get_current_port(self) -> int:
|
||||
curr_port = get_nginx_listen_port(self.client.nginx_config)
|
||||
if curr_port is None:
|
||||
# if the port is not found in the config file we use
|
||||
# the default port from the kiauh settings as fallback
|
||||
return int(self.client_settings.port)
|
||||
return curr_port
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -13,9 +13,9 @@ from typing import Type
|
||||
|
||||
from components.webui_client import client_remove
|
||||
from components.webui_client.base_data import BaseWebClient
|
||||
from core.constants import COLOR_CYAN, COLOR_RED, RESET_FORMAT
|
||||
from core.menus import Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.types.color import Color
|
||||
|
||||
|
||||
# noinspection PyUnusedLocal
|
||||
@@ -24,12 +24,14 @@ class ClientRemoveMenu(BaseMenu):
|
||||
self, client: BaseWebClient, previous_menu: Type[BaseMenu] | None = None
|
||||
):
|
||||
super().__init__()
|
||||
self.title = f"Remove {client.display_name}"
|
||||
self.title_color = Color.RED
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
self.client: BaseWebClient = client
|
||||
self.remove_client: bool = False
|
||||
self.remove_client_cfg: bool = False
|
||||
self.backup_config_json: bool = False
|
||||
self.selection_state: bool = False
|
||||
self.select_state: bool = False
|
||||
|
||||
def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
|
||||
from core.menus.remove_menu import RemoveMenu
|
||||
@@ -50,23 +52,19 @@ class ClientRemoveMenu(BaseMenu):
|
||||
client_config = self.client.client_config
|
||||
client_config_name = client_config.display_name
|
||||
|
||||
header = f" [ Remove {client_name} ] "
|
||||
color = COLOR_RED
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
checked = f"[{COLOR_CYAN}x{RESET_FORMAT}]"
|
||||
checked = f"[{Color.apply('x', Color.CYAN)}]"
|
||||
unchecked = "[ ]"
|
||||
o1 = checked if self.remove_client else unchecked
|
||||
o2 = checked if self.remove_client_cfg else unchecked
|
||||
o3 = checked if self.backup_config_json else unchecked
|
||||
sel_state = f"{'Select' if not self.select_state else 'Deselect'} everything"
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ Enter a number and hit enter to select / deselect ║
|
||||
║ the specific option for removal. ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ a) {self._get_selection_state_str():37} ║
|
||||
║ a) {sel_state:49} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ 1) {o1} Remove {client_name:16} ║
|
||||
║ 2) {o2} Remove {client_config_name:24} ║
|
||||
@@ -79,10 +77,10 @@ class ClientRemoveMenu(BaseMenu):
|
||||
print(menu, end="")
|
||||
|
||||
def toggle_all(self, **kwargs) -> None:
|
||||
self.selection_state = not self.selection_state
|
||||
self.remove_client = self.selection_state
|
||||
self.remove_client_cfg = self.selection_state
|
||||
self.backup_config_json = self.selection_state
|
||||
self.select_state = not self.select_state
|
||||
self.remove_client = self.select_state
|
||||
self.remove_client_cfg = self.select_state
|
||||
self.backup_config_json = self.select_state
|
||||
|
||||
def toggle_rm_client(self, **kwargs) -> None:
|
||||
self.remove_client = not self.remove_client
|
||||
@@ -99,28 +97,18 @@ class ClientRemoveMenu(BaseMenu):
|
||||
and not self.remove_client_cfg
|
||||
and not self.backup_config_json
|
||||
):
|
||||
error = f"{COLOR_RED}Nothing selected ...{RESET_FORMAT}"
|
||||
print(error)
|
||||
print(Color.apply("Nothing selected ...", Color.RED))
|
||||
return
|
||||
|
||||
client_remove.run_client_removal(
|
||||
completion_msg = client_remove.run_client_removal(
|
||||
client=self.client,
|
||||
remove_client=self.remove_client,
|
||||
remove_client_cfg=self.remove_client_cfg,
|
||||
backup_config=self.backup_config_json,
|
||||
)
|
||||
self.message_service.set_message(completion_msg)
|
||||
|
||||
self.remove_client = False
|
||||
self.remove_client_cfg = False
|
||||
self.backup_config_json = False
|
||||
|
||||
self._go_back()
|
||||
|
||||
def _get_selection_state_str(self) -> str:
|
||||
return (
|
||||
"Select everything" if not self.selection_state else "Deselect everything"
|
||||
)
|
||||
|
||||
def _go_back(self, **kwargs) -> None:
|
||||
if self.previous_menu is not None:
|
||||
self.previous_menu().run()
|
||||
self.select_state = False
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -44,12 +44,14 @@ class BackupManager:
|
||||
def ignore_folders(self, value: List[str]):
|
||||
self._ignore_folders = value
|
||||
|
||||
def backup_file(self, file: Path, target: Path | None = None, custom_filename=None):
|
||||
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
|
||||
return False
|
||||
|
||||
target = self.backup_root_dir if target is None else target
|
||||
|
||||
@@ -62,10 +64,13 @@ class BackupManager:
|
||||
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
|
||||
@@ -74,14 +79,19 @@ class BackupManager:
|
||||
|
||||
if source is None or not Path(source).exists():
|
||||
Logger.print_info("Source directory does not exist! Skipping ...")
|
||||
return
|
||||
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)
|
||||
shutil.copytree(
|
||||
source,
|
||||
backup_target,
|
||||
ignore=self.ignore_folders_func,
|
||||
ignore_dangling_symlinks=True,
|
||||
)
|
||||
Logger.print_ok("Backup successful!")
|
||||
|
||||
return backup_target
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -13,15 +13,6 @@ from pathlib import Path
|
||||
|
||||
from core.backup_manager import BACKUP_ROOT_DIR
|
||||
|
||||
# text colors and formats
|
||||
COLOR_WHITE = "\033[37m" # white
|
||||
COLOR_MAGENTA = "\033[35m" # magenta
|
||||
COLOR_GREEN = "\033[92m" # bright green
|
||||
COLOR_YELLOW = "\033[93m" # bright yellow
|
||||
COLOR_RED = "\033[91m" # bright red
|
||||
COLOR_CYAN = "\033[96m" # bright cyan
|
||||
RESET_FORMAT = "\033[0m" # reset format
|
||||
|
||||
# global dependencies
|
||||
GLOBAL_DEPS = ["git", "wget", "curl", "unzip", "dfu-util", "python3-virtualenv"]
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -12,78 +12,57 @@ import textwrap
|
||||
from enum import Enum
|
||||
from typing import List
|
||||
|
||||
from core.constants import (
|
||||
COLOR_CYAN,
|
||||
COLOR_GREEN,
|
||||
COLOR_MAGENTA,
|
||||
COLOR_RED,
|
||||
COLOR_WHITE,
|
||||
COLOR_YELLOW,
|
||||
RESET_FORMAT,
|
||||
)
|
||||
from core.types.color import Color
|
||||
|
||||
|
||||
class DialogType(Enum):
|
||||
INFO = ("INFO", COLOR_WHITE)
|
||||
SUCCESS = ("SUCCESS", COLOR_GREEN)
|
||||
ATTENTION = ("ATTENTION", COLOR_YELLOW)
|
||||
WARNING = ("WARNING", COLOR_YELLOW)
|
||||
ERROR = ("ERROR", COLOR_RED)
|
||||
INFO = ("INFO", Color.WHITE)
|
||||
SUCCESS = ("SUCCESS", Color.GREEN)
|
||||
ATTENTION = ("ATTENTION", Color.YELLOW)
|
||||
WARNING = ("WARNING", Color.YELLOW)
|
||||
ERROR = ("ERROR", Color.RED)
|
||||
CUSTOM = (None, None)
|
||||
|
||||
|
||||
class DialogCustomColor(Enum):
|
||||
WHITE = COLOR_WHITE
|
||||
GREEN = COLOR_GREEN
|
||||
YELLOW = COLOR_YELLOW
|
||||
RED = COLOR_RED
|
||||
CYAN = COLOR_CYAN
|
||||
MAGENTA = COLOR_MAGENTA
|
||||
|
||||
|
||||
LINE_WIDTH = 53
|
||||
|
||||
|
||||
BORDER_TOP: str = "┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓"
|
||||
BORDER_BOTTOM: str = "┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛"
|
||||
BORDER_TITLE: str = "┠───────────────────────────────────────────────────────┨"
|
||||
BORDER_LEFT: str = "┃"
|
||||
BORDER_RIGHT: str = "┃"
|
||||
|
||||
|
||||
class Logger:
|
||||
@staticmethod
|
||||
def info(msg) -> None:
|
||||
# log to kiauh.log
|
||||
pass
|
||||
|
||||
@staticmethod
|
||||
def warn(msg) -> None:
|
||||
# log to kiauh.log
|
||||
pass
|
||||
|
||||
@staticmethod
|
||||
def error(msg) -> None:
|
||||
# log to kiauh.log
|
||||
pass
|
||||
|
||||
@staticmethod
|
||||
def print_info(msg, prefix=True, start="", end="\n") -> None:
|
||||
message = f"[INFO] {msg}" if prefix else msg
|
||||
print(f"{COLOR_WHITE}{start}{message}{RESET_FORMAT}", end=end)
|
||||
Logger.__print(Color.WHITE, start, message, end)
|
||||
|
||||
@staticmethod
|
||||
def print_ok(msg: str = "Success!", prefix=True, start="", end="\n") -> None:
|
||||
message = f"[OK] {msg}" if prefix else msg
|
||||
print(f"{COLOR_GREEN}{start}{message}{RESET_FORMAT}", end=end)
|
||||
Logger.__print(Color.GREEN, start, message, end)
|
||||
|
||||
@staticmethod
|
||||
def print_warn(msg, prefix=True, start="", end="\n") -> None:
|
||||
message = f"[WARN] {msg}" if prefix else msg
|
||||
print(f"{COLOR_YELLOW}{start}{message}{RESET_FORMAT}", end=end)
|
||||
Logger.__print(Color.YELLOW, start, message, end)
|
||||
|
||||
@staticmethod
|
||||
def print_error(msg, prefix=True, start="", end="\n") -> None:
|
||||
message = f"[ERROR] {msg}" if prefix else msg
|
||||
print(f"{COLOR_RED}{start}{message}{RESET_FORMAT}", end=end)
|
||||
Logger.__print(Color.RED, start, message, end)
|
||||
|
||||
@staticmethod
|
||||
def print_status(msg, prefix=True, start="", end="\n") -> None:
|
||||
message = f"\n###### {msg}" if prefix else msg
|
||||
print(f"{COLOR_MAGENTA}{start}{message}{RESET_FORMAT}", end=end)
|
||||
Logger.__print(Color.MAGENTA, start, message, end)
|
||||
|
||||
@staticmethod
|
||||
def __print(color: Color, start: str, message: str, end: str) -> None:
|
||||
print(Color.apply(f"{start}{message}", color), end=end)
|
||||
|
||||
@staticmethod
|
||||
def print_dialog(
|
||||
@@ -91,7 +70,7 @@ class Logger:
|
||||
content: List[str],
|
||||
center_content: bool = False,
|
||||
custom_title: str | None = None,
|
||||
custom_color: DialogCustomColor | None = None,
|
||||
custom_color: Color | None = None,
|
||||
margin_top: int = 0,
|
||||
margin_bottom: int = 0,
|
||||
) -> None:
|
||||
@@ -109,19 +88,32 @@ class Logger:
|
||||
:param margin_top: The number of empty lines to print before the dialog.
|
||||
:param margin_bottom: The number of empty lines to print after the dialog.
|
||||
"""
|
||||
dialog_color = Logger._get_dialog_color(title, custom_color)
|
||||
color = Logger._get_dialog_color(title, custom_color)
|
||||
dialog_title = Logger._get_dialog_title(title, custom_title)
|
||||
dialog_title_formatted = Logger._format_dialog_title(dialog_title)
|
||||
dialog_content = Logger.format_content(content, LINE_WIDTH, center_content)
|
||||
top = Logger._format_top_border(dialog_color)
|
||||
bottom = Logger._format_bottom_border()
|
||||
|
||||
print("\n" * margin_top)
|
||||
print(
|
||||
f"{top}{dialog_title_formatted}{dialog_content}{bottom}",
|
||||
end="",
|
||||
)
|
||||
print("\n" * margin_bottom)
|
||||
if margin_top > 0:
|
||||
print("\n" * margin_top, end="")
|
||||
|
||||
print(Color.apply(BORDER_TOP, color))
|
||||
|
||||
if dialog_title:
|
||||
print(Color.apply(f"┃ {dialog_title:^{LINE_WIDTH}} ┃", color))
|
||||
print(Color.apply(BORDER_TITLE, color))
|
||||
|
||||
if content:
|
||||
print(
|
||||
Logger.format_content(
|
||||
content,
|
||||
LINE_WIDTH,
|
||||
color,
|
||||
center_content,
|
||||
)
|
||||
)
|
||||
|
||||
print(Color.apply(BORDER_BOTTOM, color))
|
||||
|
||||
if margin_bottom > 0:
|
||||
print("\n" * margin_bottom, end="")
|
||||
|
||||
@staticmethod
|
||||
def _get_dialog_title(
|
||||
@@ -133,39 +125,20 @@ class Logger:
|
||||
|
||||
@staticmethod
|
||||
def _get_dialog_color(
|
||||
title: DialogType, custom_color: DialogCustomColor | None = None
|
||||
) -> str:
|
||||
title: DialogType, custom_color: Color | None = None
|
||||
) -> Color:
|
||||
if title == DialogType.CUSTOM and custom_color:
|
||||
return str(custom_color.value)
|
||||
return custom_color
|
||||
|
||||
color: str = title.value[1] if title.value[1] else DialogCustomColor.WHITE.value
|
||||
color: Color = title.value[1] if title.value[1] else Color.WHITE
|
||||
|
||||
return color
|
||||
|
||||
@staticmethod
|
||||
def _format_top_border(color: str) -> str:
|
||||
return f"{color}┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓"
|
||||
|
||||
@staticmethod
|
||||
def _format_bottom_border() -> str:
|
||||
return (
|
||||
f"\n┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛{RESET_FORMAT}"
|
||||
)
|
||||
|
||||
@staticmethod
|
||||
def _format_dialog_title(title: str | None) -> str:
|
||||
if title is not None:
|
||||
return textwrap.dedent(f"""
|
||||
┃ {title:^{LINE_WIDTH}} ┃
|
||||
┠───────────────────────────────────────────────────────┨
|
||||
""")
|
||||
else:
|
||||
return "\n"
|
||||
|
||||
@staticmethod
|
||||
def format_content(
|
||||
content: List[str],
|
||||
line_width: int,
|
||||
color: Color = Color.WHITE,
|
||||
center_content: bool = False,
|
||||
border_left: str = "┃",
|
||||
border_right: str = "┃",
|
||||
@@ -184,11 +157,13 @@ class Logger:
|
||||
|
||||
if not center_content:
|
||||
formatted_lines = [
|
||||
f"{border_left} {line:<{line_width}} {border_right}" for line in lines
|
||||
Color.apply(f"{border_left} {line:<{line_width}} {border_right}", color)
|
||||
for line in lines
|
||||
]
|
||||
else:
|
||||
formatted_lines = [
|
||||
f"{border_left} {line:^{line_width}} {border_right}" for line in lines
|
||||
Color.apply(f"{border_left} {line:^{line_width}} {border_right}", color)
|
||||
for line in lines
|
||||
]
|
||||
|
||||
return "\n".join(formatted_lines)
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -13,8 +13,10 @@ from typing import Type
|
||||
|
||||
from components.klipper import KLIPPER_DIR
|
||||
from components.klipper.klipper import Klipper
|
||||
from components.klipper.klipper_utils import install_input_shaper_deps
|
||||
from components.klipper_firmware.menus.klipper_build_menu import (
|
||||
KlipperBuildFirmwareMenu,
|
||||
KlipperKConfigMenu,
|
||||
)
|
||||
from components.klipper_firmware.menus.klipper_flash_menu import (
|
||||
KlipperFlashMethodMenu,
|
||||
@@ -22,9 +24,9 @@ from components.klipper_firmware.menus.klipper_flash_menu import (
|
||||
)
|
||||
from components.moonraker import MOONRAKER_DIR
|
||||
from components.moonraker.moonraker import Moonraker
|
||||
from core.constants import COLOR_YELLOW, RESET_FORMAT
|
||||
from core.menus import Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.types.color import Color
|
||||
from procedures.system import change_system_hostname
|
||||
from utils.git_utils import rollback_repository
|
||||
|
||||
@@ -34,6 +36,8 @@ from utils.git_utils import rollback_repository
|
||||
class AdvancedMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
|
||||
super().__init__()
|
||||
self.title = "Advanced Menu"
|
||||
self.title_color = Color.YELLOW
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
|
||||
def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
|
||||
@@ -47,26 +51,24 @@ class AdvancedMenu(BaseMenu):
|
||||
"2": Option(method=self.flash),
|
||||
"3": Option(method=self.build_flash),
|
||||
"4": Option(method=self.get_id),
|
||||
"5": Option(method=self.klipper_rollback),
|
||||
"6": Option(method=self.moonraker_rollback),
|
||||
"7": Option(method=self.change_hostname),
|
||||
"5": Option(method=self.input_shaper),
|
||||
"6": Option(method=self.klipper_rollback),
|
||||
"7": Option(method=self.moonraker_rollback),
|
||||
"8": Option(method=self.change_hostname),
|
||||
}
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = " [ Advanced Menu ] "
|
||||
color = COLOR_YELLOW
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
"""
|
||||
╟───────────────────────────┬───────────────────────────╢
|
||||
║ Klipper Firmware: │ Repository Rollback: ║
|
||||
║ 1) [Build] │ 5) [Klipper] ║
|
||||
║ 2) [Flash] │ 6) [Moonraker] ║
|
||||
║ 1) [Build] │ 6) [Klipper] ║
|
||||
║ 2) [Flash] │ 7) [Moonraker] ║
|
||||
║ 3) [Build + Flash] │ ║
|
||||
║ 4) [Get MCU ID] │ System: ║
|
||||
║ │ 7) [Change hostname] ║
|
||||
║ │ 8) [Change hostname] ║
|
||||
║ Extra Dependencies: │ ║
|
||||
║ 5) [Input Shaper] │ ║
|
||||
╟───────────────────────────┴───────────────────────────╢
|
||||
"""
|
||||
)[1:]
|
||||
@@ -79,12 +81,15 @@ class AdvancedMenu(BaseMenu):
|
||||
rollback_repository(MOONRAKER_DIR, Moonraker)
|
||||
|
||||
def build(self, **kwargs) -> None:
|
||||
KlipperKConfigMenu().run()
|
||||
KlipperBuildFirmwareMenu(previous_menu=self.__class__).run()
|
||||
|
||||
def flash(self, **kwargs) -> None:
|
||||
KlipperKConfigMenu().run()
|
||||
KlipperFlashMethodMenu(previous_menu=self.__class__).run()
|
||||
|
||||
def build_flash(self, **kwargs) -> None:
|
||||
KlipperKConfigMenu().run()
|
||||
KlipperBuildFirmwareMenu(previous_menu=KlipperFlashMethodMenu).run()
|
||||
KlipperFlashMethodMenu(previous_menu=self.__class__).run()
|
||||
|
||||
@@ -96,3 +101,6 @@ class AdvancedMenu(BaseMenu):
|
||||
|
||||
def change_hostname(self, **kwargs) -> None:
|
||||
change_system_hostname()
|
||||
|
||||
def input_shaper(self, **kwargs) -> None:
|
||||
install_input_shaper_deps()
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -13,7 +13,7 @@ from typing import Type
|
||||
|
||||
from components.klipper.klipper_utils import backup_klipper_dir
|
||||
from components.klipperscreen.klipperscreen import backup_klipperscreen_dir
|
||||
from components.moonraker.moonraker_utils import (
|
||||
from components.moonraker.utils.utils import (
|
||||
backup_moonraker_db_dir,
|
||||
backup_moonraker_dir,
|
||||
)
|
||||
@@ -23,9 +23,9 @@ from components.webui_client.client_utils import (
|
||||
)
|
||||
from components.webui_client.fluidd_data import FluiddData
|
||||
from components.webui_client.mainsail_data import MainsailData
|
||||
from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
|
||||
from core.menus import Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.types.color import Color
|
||||
from utils.common import backup_printer_config_dir
|
||||
|
||||
|
||||
@@ -34,6 +34,8 @@ from utils.common import backup_printer_config_dir
|
||||
class BackupMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
|
||||
super().__init__()
|
||||
self.title = "Backup Menu"
|
||||
self.title_color = Color.GREEN
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
|
||||
def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
|
||||
@@ -55,14 +57,11 @@ class BackupMenu(BaseMenu):
|
||||
}
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = " [ Backup Menu ] "
|
||||
line1 = f"{COLOR_YELLOW}INFO: Backups are located in '~/kiauh-backups'{RESET_FORMAT}"
|
||||
color = COLOR_CYAN
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
line1 = Color.apply(
|
||||
"INFO: Backups are located in '~/kiauh-backups'", Color.YELLOW
|
||||
)
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ {line1:^62} ║
|
||||
╟───────────────────────────┬───────────────────────────╢
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -14,17 +14,14 @@ import sys
|
||||
import textwrap
|
||||
import traceback
|
||||
from abc import abstractmethod
|
||||
from enum import Enum
|
||||
from typing import Dict, Type
|
||||
|
||||
from core.constants import (
|
||||
COLOR_CYAN,
|
||||
COLOR_GREEN,
|
||||
COLOR_RED,
|
||||
COLOR_YELLOW,
|
||||
RESET_FORMAT,
|
||||
)
|
||||
from core.logger import Logger
|
||||
from core.menus import FooterType, Option
|
||||
from core.services.message_service import MessageService
|
||||
from core.spinner import Spinner
|
||||
from core.types.color import Color
|
||||
from utils.input_utils import get_selection_input
|
||||
|
||||
|
||||
@@ -36,14 +33,14 @@ def print_header() -> None:
|
||||
line1 = " [ KIAUH ] "
|
||||
line2 = "Klipper Installation And Update Helper"
|
||||
line3 = ""
|
||||
color = COLOR_CYAN
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
color = Color.CYAN
|
||||
count = 62 - len(str(color)) - len(str(Color.RST))
|
||||
header = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{line1:~^{count}}{RESET_FORMAT} ║
|
||||
║ {color}{line2:^{count}}{RESET_FORMAT} ║
|
||||
║ {color}{line3:~^{count}}{RESET_FORMAT} ║
|
||||
║ {Color.apply(f"{line1:~^{count}}", color)} ║
|
||||
║ {Color.apply(f"{line2:^{count}}", color)} ║
|
||||
║ {Color.apply(f"{line3:~^{count}}", color)} ║
|
||||
╚═══════════════════════════════════════════════════════╝
|
||||
"""
|
||||
)[1:]
|
||||
@@ -52,11 +49,11 @@ def print_header() -> None:
|
||||
|
||||
def print_quit_footer() -> None:
|
||||
text = "Q) Quit"
|
||||
color = COLOR_RED
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
color = Color.RED
|
||||
count = 62 - len(str(color)) - len(str(Color.RST))
|
||||
footer = textwrap.dedent(
|
||||
f"""
|
||||
║ {color}{text:^{count}}{RESET_FORMAT} ║
|
||||
║ {color}{text:^{count}}{Color.RST} ║
|
||||
╚═══════════════════════════════════════════════════════╝
|
||||
"""
|
||||
)[1:]
|
||||
@@ -65,11 +62,11 @@ def print_quit_footer() -> None:
|
||||
|
||||
def print_back_footer() -> None:
|
||||
text = "B) « Back"
|
||||
color = COLOR_GREEN
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
color = Color.GREEN
|
||||
count = 62 - len(str(color)) - len(str(Color.RST))
|
||||
footer = textwrap.dedent(
|
||||
f"""
|
||||
║ {color}{text:^{count}}{RESET_FORMAT} ║
|
||||
║ {color}{text:^{count}}{Color.RST} ║
|
||||
╚═══════════════════════════════════════════════════════╝
|
||||
"""
|
||||
)[1:]
|
||||
@@ -79,12 +76,12 @@ def print_back_footer() -> None:
|
||||
def print_back_help_footer() -> None:
|
||||
text1 = "B) « Back"
|
||||
text2 = "H) Help [?]"
|
||||
color1 = COLOR_GREEN
|
||||
color2 = COLOR_YELLOW
|
||||
count = 34 - len(color1) - len(RESET_FORMAT)
|
||||
color1 = Color.GREEN
|
||||
color2 = Color.YELLOW
|
||||
count = 34 - len(str(color1)) - len(str(Color.RST))
|
||||
footer = textwrap.dedent(
|
||||
f"""
|
||||
║ {color1}{text1:^{count}}{RESET_FORMAT} │ {color2}{text2:^{count}}{RESET_FORMAT} ║
|
||||
║ {color1}{text1:^{count}}{Color.RST} │ {color2}{text2:^{count}}{Color.RST} ║
|
||||
╚═══════════════════════════╧═══════════════════════════╝
|
||||
"""
|
||||
)[1:]
|
||||
@@ -95,6 +92,11 @@ def print_blank_footer() -> None:
|
||||
print("╚═══════════════════════════════════════════════════════╝")
|
||||
|
||||
|
||||
class MenuTitleStyle(Enum):
|
||||
PLAIN = "plain"
|
||||
STYLED = "styled"
|
||||
|
||||
|
||||
class PostInitCaller(type):
|
||||
def __call__(cls, *args, **kwargs):
|
||||
obj = type.__call__(cls, *args, **kwargs)
|
||||
@@ -110,10 +112,20 @@ class BaseMenu(metaclass=PostInitCaller):
|
||||
default_option: Option = None
|
||||
input_label_txt: str = "Perform action"
|
||||
header: bool = False
|
||||
|
||||
loading_msg: str = ""
|
||||
spinner: Spinner | None = None
|
||||
|
||||
title: str = ""
|
||||
title_style: MenuTitleStyle = MenuTitleStyle.STYLED
|
||||
title_color: Color = Color.WHITE
|
||||
|
||||
previous_menu: Type[BaseMenu] | None = None
|
||||
help_menu: Type[BaseMenu] | None = None
|
||||
footer_type: FooterType = FooterType.BACK
|
||||
|
||||
message_service = MessageService()
|
||||
|
||||
def __init__(self, **kwargs) -> None:
|
||||
if type(self) is BaseMenu:
|
||||
raise NotImplementedError("BaseMenu cannot be instantiated directly.")
|
||||
@@ -160,7 +172,32 @@ class BaseMenu(metaclass=PostInitCaller):
|
||||
def print_menu(self) -> None:
|
||||
raise NotImplementedError
|
||||
|
||||
def print_footer(self) -> None:
|
||||
def is_loading(self, state: bool) -> None:
|
||||
if not self.spinner and state:
|
||||
self.spinner = Spinner(self.loading_msg)
|
||||
self.spinner.start()
|
||||
else:
|
||||
self.spinner.stop()
|
||||
self.spinner = None
|
||||
|
||||
def __print_menu_title(self) -> None:
|
||||
count = 62 - len(str(self.title_color)) - len(str(Color.RST))
|
||||
menu_title = "╔═══════════════════════════════════════════════════════╗\n"
|
||||
if self.title:
|
||||
title = (
|
||||
f" [ {self.title} ] "
|
||||
if self.title_style == MenuTitleStyle.STYLED
|
||||
else self.title
|
||||
)
|
||||
line = (
|
||||
f"{title:~^{count}}"
|
||||
if self.title_style == MenuTitleStyle.STYLED
|
||||
else f"{title:^{count}}"
|
||||
)
|
||||
menu_title += f"║ {Color.apply(line, self.title_color)} ║\n"
|
||||
print(menu_title, end="")
|
||||
|
||||
def __print_footer(self) -> None:
|
||||
if self.footer_type is FooterType.QUIT:
|
||||
print_quit_footer()
|
||||
elif self.footer_type is FooterType.BACK:
|
||||
@@ -172,16 +209,20 @@ class BaseMenu(metaclass=PostInitCaller):
|
||||
else:
|
||||
raise NotImplementedError("FooterType not correctly implemented!")
|
||||
|
||||
def display_menu(self) -> None:
|
||||
def __display_menu(self) -> None:
|
||||
self.message_service.display_message()
|
||||
|
||||
if self.header:
|
||||
print_header()
|
||||
|
||||
self.__print_menu_title()
|
||||
self.print_menu()
|
||||
self.print_footer()
|
||||
self.__print_footer()
|
||||
|
||||
def run(self) -> None:
|
||||
"""Start the menu lifecycle. When this function returns, the lifecycle of the menu ends."""
|
||||
try:
|
||||
self.display_menu()
|
||||
self.__display_menu()
|
||||
option = get_selection_input(self.input_label_txt, self.options)
|
||||
selected_option: Option = self.options.get(option)
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -12,9 +12,9 @@ import textwrap
|
||||
from typing import Type
|
||||
|
||||
from components.crowsnest.crowsnest import install_crowsnest
|
||||
from components.klipper import klipper_setup
|
||||
from components.klipper.services.klipper_setup_service import KlipperSetupService
|
||||
from components.klipperscreen.klipperscreen import install_klipperscreen
|
||||
from components.moonraker import moonraker_setup
|
||||
from components.moonraker.services.moonraker_setup_service import MoonrakerSetupService
|
||||
from components.webui_client.client_config.client_config_setup import (
|
||||
install_client_config,
|
||||
)
|
||||
@@ -22,10 +22,10 @@ from components.webui_client.client_setup import install_client
|
||||
from components.webui_client.fluidd_data import FluiddData
|
||||
from components.webui_client.mainsail_data import MainsailData
|
||||
from components.webui_client.menus.client_install_menu import ClientInstallMenu
|
||||
from core.constants import COLOR_GREEN, RESET_FORMAT
|
||||
from core.menus import Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.settings.kiauh_settings import KiauhSettings
|
||||
from core.types.color import Color
|
||||
|
||||
|
||||
# noinspection PyUnusedLocal
|
||||
@@ -33,7 +33,11 @@ from core.settings.kiauh_settings import KiauhSettings
|
||||
class InstallMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
|
||||
super().__init__()
|
||||
self.title = "Installation Menu"
|
||||
self.title_color = Color.GREEN
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
self.klsvc = KlipperSetupService()
|
||||
self.mrsvc = MoonrakerSetupService()
|
||||
|
||||
def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
|
||||
from core.menus.main_menu import MainMenu
|
||||
@@ -53,13 +57,8 @@ class InstallMenu(BaseMenu):
|
||||
}
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = " [ Installation Menu ] "
|
||||
color = COLOR_GREEN
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
"""
|
||||
╟───────────────────────────┬───────────────────────────╢
|
||||
║ Firmware & API: │ Touchscreen GUI: ║
|
||||
║ 1) [Klipper] │ 7) [KlipperScreen] ║
|
||||
@@ -78,10 +77,10 @@ class InstallMenu(BaseMenu):
|
||||
print(menu, end="")
|
||||
|
||||
def install_klipper(self, **kwargs) -> None:
|
||||
klipper_setup.install_klipper()
|
||||
self.klsvc.install()
|
||||
|
||||
def install_moonraker(self, **kwargs) -> None:
|
||||
moonraker_setup.install_moonraker()
|
||||
self.mrsvc.install()
|
||||
|
||||
def install_mainsail(self, **kwargs) -> None:
|
||||
client: MainsailData = MainsailData()
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -16,21 +16,13 @@ from components.crowsnest.crowsnest import get_crowsnest_status
|
||||
from components.klipper.klipper_utils import get_klipper_status
|
||||
from components.klipperscreen.klipperscreen import get_klipperscreen_status
|
||||
from components.log_uploads.menus.log_upload_menu import LogUploadMenu
|
||||
from components.moonraker.moonraker_utils import get_moonraker_status
|
||||
from components.moonraker.utils.utils import get_moonraker_status
|
||||
from components.webui_client.client_utils import (
|
||||
get_client_status,
|
||||
get_current_client_config,
|
||||
)
|
||||
from components.webui_client.fluidd_data import FluiddData
|
||||
from components.webui_client.mainsail_data import MainsailData
|
||||
from core.constants import (
|
||||
COLOR_CYAN,
|
||||
COLOR_GREEN,
|
||||
COLOR_MAGENTA,
|
||||
COLOR_RED,
|
||||
COLOR_YELLOW,
|
||||
RESET_FORMAT,
|
||||
)
|
||||
from core.logger import Logger
|
||||
from core.menus import FooterType
|
||||
from core.menus.advanced_menu import AdvancedMenu
|
||||
@@ -40,7 +32,8 @@ from core.menus.install_menu import InstallMenu
|
||||
from core.menus.remove_menu import RemoveMenu
|
||||
from core.menus.settings_menu import SettingsMenu
|
||||
from core.menus.update_menu import UpdateMenu
|
||||
from core.types import ComponentStatus, StatusMap, StatusText
|
||||
from core.types.color import Color
|
||||
from core.types.component_status import ComponentStatus, StatusMap, StatusText
|
||||
from extensions.extensions_menu import ExtensionsMenu
|
||||
from utils.common import get_kiauh_version, trunc_string
|
||||
|
||||
@@ -52,6 +45,8 @@ class MainMenu(BaseMenu):
|
||||
super().__init__()
|
||||
|
||||
self.header: bool = True
|
||||
self.title = "Main Menu"
|
||||
self.title_color = Color.CYAN
|
||||
self.footer_type: FooterType = FooterType.QUIT
|
||||
|
||||
self.version = ""
|
||||
@@ -83,7 +78,7 @@ class MainMenu(BaseMenu):
|
||||
setattr(
|
||||
self,
|
||||
f"{var}_status",
|
||||
f"{COLOR_RED}Not installed{RESET_FORMAT}",
|
||||
Color.apply("Not installed", Color.RED),
|
||||
)
|
||||
|
||||
def _fetch_status(self) -> None:
|
||||
@@ -109,34 +104,30 @@ class MainMenu(BaseMenu):
|
||||
count_txt = f": {instance_count}"
|
||||
|
||||
setattr(self, f"{name}_status", self._format_by_code(code, status, count_txt))
|
||||
setattr(self, f"{name}_owner", f"{COLOR_CYAN}{owner}{RESET_FORMAT}")
|
||||
setattr(self, f"{name}_repo", f"{COLOR_CYAN}{repo}{RESET_FORMAT}")
|
||||
setattr(self, f"{name}_owner", Color.apply(owner, Color.CYAN))
|
||||
setattr(self, f"{name}_repo", Color.apply(repo, Color.CYAN))
|
||||
|
||||
def _format_by_code(self, code: int, status: str, count: str) -> str:
|
||||
color = COLOR_RED
|
||||
color = Color.RED
|
||||
if code == 0:
|
||||
color = COLOR_RED
|
||||
color = Color.RED
|
||||
elif code == 1:
|
||||
color = COLOR_YELLOW
|
||||
color = Color.YELLOW
|
||||
elif code == 2:
|
||||
color = COLOR_GREEN
|
||||
color = Color.GREEN
|
||||
|
||||
return f"{color}{status}{count}{RESET_FORMAT}"
|
||||
return Color.apply(f"{status}{count}", color)
|
||||
|
||||
def print_menu(self) -> None:
|
||||
self._fetch_status()
|
||||
|
||||
header = " [ Main Menu ] "
|
||||
footer1 = f"{COLOR_CYAN}{self.version}{RESET_FORMAT}"
|
||||
footer2 = f"Changelog: {COLOR_MAGENTA}https://git.io/JnmlX{RESET_FORMAT}"
|
||||
color = COLOR_CYAN
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
footer1 = Color.apply(self.version, Color.CYAN)
|
||||
link = Color.apply("https://git.io/JnmlX", Color.MAGENTA)
|
||||
footer2 = f"Changelog: {link}"
|
||||
pad1 = 32
|
||||
pad2 = 26
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
╟──────────────────┬────────────────────────────────────╢
|
||||
║ 0) [Log-Upload] │ Klipper: {self.kl_status:<{pad1}} ║
|
||||
║ │ Owner: {self.kl_owner:<{pad1}} ║
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -20,9 +20,9 @@ from components.moonraker.menus.moonraker_remove_menu import (
|
||||
from components.webui_client.fluidd_data import FluiddData
|
||||
from components.webui_client.mainsail_data import MainsailData
|
||||
from components.webui_client.menus.client_remove_menu import ClientRemoveMenu
|
||||
from core.constants import COLOR_RED, RESET_FORMAT
|
||||
from core.menus import Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.types.color import Color
|
||||
|
||||
|
||||
# noinspection PyUnusedLocal
|
||||
@@ -30,6 +30,8 @@ from core.menus.base_menu import BaseMenu
|
||||
class RemoveMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
|
||||
super().__init__()
|
||||
self.title = "Remove Menu"
|
||||
self.title_color = Color.RED
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
|
||||
def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
|
||||
@@ -48,13 +50,8 @@ class RemoveMenu(BaseMenu):
|
||||
}
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = " [ Remove Menu ] "
|
||||
color = COLOR_RED
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
"""
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ INFO: Configurations and/or any backups will be kept! ║
|
||||
╟───────────────────────────┬───────────────────────────╢
|
||||
|
||||
162
kiauh/core/menus/repo_select_menu.py
Normal file
162
kiauh/core/menus/repo_select_menu.py
Normal file
@@ -0,0 +1,162 @@
|
||||
# ======================================================================= #
|
||||
# Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com> #
|
||||
# #
|
||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||
# https://github.com/dw-0/kiauh #
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import List, Literal, Type
|
||||
|
||||
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,
|
||||
name: Literal["klipper", "moonraker"],
|
||||
repos: List[Repository],
|
||||
previous_menu: Type[BaseMenu] | None = None,
|
||||
) -> None:
|
||||
super().__init__()
|
||||
self.title_color = Color.CYAN
|
||||
self.previous_menu = previous_menu
|
||||
self.settings = KiauhSettings()
|
||||
self.input_label_txt = "Select repository"
|
||||
self.name = name
|
||||
self.repos = repos
|
||||
|
||||
if self.name == "klipper":
|
||||
self.title = "Klipper Repository Selection Menu"
|
||||
|
||||
elif self.name == "moonraker":
|
||||
self.title = "Moonraker Repository Selection Menu"
|
||||
|
||||
def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
|
||||
from core.menus.settings_menu import SettingsMenu
|
||||
|
||||
self.previous_menu = (
|
||||
previous_menu if previous_menu is not None else SettingsMenu
|
||||
)
|
||||
|
||||
def set_options(self) -> None:
|
||||
self.options = {}
|
||||
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="")
|
||||
|
||||
def select_repository(self, **kwargs) -> None:
|
||||
repo: Repository = kwargs.get("opt_data")
|
||||
Logger.print_status(
|
||||
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()
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -9,17 +9,17 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import textwrap
|
||||
from typing import Literal, Tuple, Type
|
||||
from typing import Type
|
||||
|
||||
from components.klipper.klipper_utils import get_klipper_status
|
||||
from components.moonraker.moonraker_utils import get_moonraker_status
|
||||
from core.constants import COLOR_CYAN, COLOR_GREEN, RESET_FORMAT
|
||||
from components.moonraker.utils.utils import get_moonraker_status
|
||||
from core.logger import DialogType, Logger
|
||||
from core.menus import Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.settings.kiauh_settings import KiauhSettings, RepoSettings
|
||||
from procedures.switch_repo import run_switch_repo_routine
|
||||
from utils.input_utils import get_confirm, get_string_input
|
||||
from core.menus.repo_select_menu import RepoSelectMenu
|
||||
from core.settings.kiauh_settings import KiauhSettings
|
||||
from core.types.color import Color
|
||||
from core.types.component_status import ComponentStatus
|
||||
|
||||
|
||||
# noinspection PyUnusedLocal
|
||||
@@ -27,12 +27,20 @@ from utils.input_utils import get_confirm, get_string_input
|
||||
class SettingsMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
|
||||
super().__init__()
|
||||
self.title = "Settings Menu"
|
||||
self.title_color = Color.CYAN
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
self.klipper_status = get_klipper_status()
|
||||
self.moonraker_status = get_moonraker_status()
|
||||
|
||||
self.mainsail_unstable: bool | None = None
|
||||
self.fluidd_unstable: bool | None = None
|
||||
self.auto_backups_enabled: bool | None = None
|
||||
|
||||
na: str = "Not available!"
|
||||
self.kl_repo_url: str = Color.apply(na, Color.RED)
|
||||
self.kl_branch: str = Color.apply(na, Color.RED)
|
||||
self.mr_repo_url: str = Color.apply(na, Color.RED)
|
||||
self.mr_branch: str = Color.apply(na, Color.RED)
|
||||
|
||||
self._load_settings()
|
||||
|
||||
def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
|
||||
@@ -42,58 +50,39 @@ class SettingsMenu(BaseMenu):
|
||||
|
||||
def set_options(self) -> None:
|
||||
self.options = {
|
||||
"1": Option(method=self.set_klipper_repo),
|
||||
"2": Option(method=self.set_moonraker_repo),
|
||||
"1": Option(method=self.switch_klipper_repo),
|
||||
"2": Option(method=self.switch_moonraker_repo),
|
||||
"3": Option(method=self.toggle_mainsail_release),
|
||||
"4": Option(method=self.toggle_fluidd_release),
|
||||
"5": Option(method=self.toggle_backup_before_update),
|
||||
}
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = " [ KIAUH Settings ] "
|
||||
color, rst = COLOR_CYAN, RESET_FORMAT
|
||||
count = 62 - len(color) - len(rst)
|
||||
checked = f"[{COLOR_GREEN}x{rst}]"
|
||||
checked = f"[{Color.apply('x', Color.GREEN)}]"
|
||||
unchecked = "[ ]"
|
||||
|
||||
kl_repo: str = f"{color}{self.klipper_status.repo}{rst}"
|
||||
kl_branch: str = f"{color}{self.klipper_status.branch}{rst}"
|
||||
kl_owner: str = f"{color}{self.klipper_status.owner}{rst}"
|
||||
mr_repo: str = f"{color}{self.moonraker_status.repo}{rst}"
|
||||
mr_branch: str = f"{color}{self.moonraker_status.branch}{rst}"
|
||||
mr_owner: str = f"{color}{self.moonraker_status.owner}{rst}"
|
||||
o1 = checked if self.mainsail_unstable else unchecked
|
||||
o2 = checked if self.fluidd_unstable else unchecked
|
||||
o3 = checked if self.auto_backups_enabled else unchecked
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{rst} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ Klipper: ║
|
||||
║ ● Repo: {kl_repo:51} ║
|
||||
║ ● Owner: {kl_owner:51} ║
|
||||
║ ● Branch: {kl_branch:51} ║
|
||||
║ 1) Switch Klipper source repository ║
|
||||
║ ● Current repository: ║
|
||||
║ └► Repo: {self.kl_repo_url:50} ║
|
||||
║ └► Branch: {self.kl_branch:48} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ Moonraker: ║
|
||||
║ ● Repo: {mr_repo:51} ║
|
||||
║ ● Owner: {mr_owner:51} ║
|
||||
║ ● Branch: {mr_branch:51} ║
|
||||
║ 2) Switch Moonraker source repository ║
|
||||
║ ● Current repository: ║
|
||||
║ └► Repo: {self.mr_repo_url:50} ║
|
||||
║ └► Branch: {self.mr_branch:48} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ Install unstable releases: ║
|
||||
║ {o1} Mainsail ║
|
||||
║ {o2} Fluidd ║
|
||||
║ 3) {o1} Mainsail ║
|
||||
║ 4) {o2} Fluidd ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ Auto-Backup: ║
|
||||
║ {o3} Automatic backup before update ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ 1) Set Klipper source repository ║
|
||||
║ 2) Set Moonraker source repository ║
|
||||
║ ║
|
||||
║ 3) Toggle unstable Mainsail releases ║
|
||||
║ 4) Toggle unstable Fluidd releases ║
|
||||
║ ║
|
||||
║ 5) Toggle automatic backups before updates ║
|
||||
║ 5) {o3} Backup before update ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
"""
|
||||
)[1:]
|
||||
@@ -105,70 +94,35 @@ class SettingsMenu(BaseMenu):
|
||||
self.mainsail_unstable = self.settings.mainsail.unstable_releases
|
||||
self.fluidd_unstable = self.settings.fluidd.unstable_releases
|
||||
|
||||
def _gather_input(self) -> Tuple[str, str]:
|
||||
klipper_status: ComponentStatus = get_klipper_status()
|
||||
moonraker_status: ComponentStatus = get_moonraker_status()
|
||||
|
||||
def trim_repo_url(repo: str) -> str:
|
||||
return repo.replace(".git", "").replace("https://", "").replace("git@", "")
|
||||
|
||||
if not klipper_status.repo == "-":
|
||||
url = trim_repo_url(klipper_status.repo_url)
|
||||
self.kl_repo_url = Color.apply(url, Color.CYAN)
|
||||
self.kl_branch = Color.apply(klipper_status.branch, Color.CYAN)
|
||||
if not moonraker_status.repo == "-":
|
||||
url = trim_repo_url(moonraker_status.repo_url)
|
||||
self.mr_repo_url = Color.apply(url, Color.CYAN)
|
||||
self.mr_branch = Color.apply(moonraker_status.branch, Color.CYAN)
|
||||
|
||||
def _warn_no_repos(self, name: str) -> None:
|
||||
Logger.print_dialog(
|
||||
DialogType.ATTENTION,
|
||||
[
|
||||
"There is no input validation in place! Make sure your the input is "
|
||||
"valid and has no typos or invalid characters! For the change to take "
|
||||
"effect, the new repository will be cloned. A backup of the old "
|
||||
"repository will be created.",
|
||||
"\n\n",
|
||||
"Make sure you don't have any ongoing prints running, as the services "
|
||||
"will be restarted during this process! You will loose any ongoing print!",
|
||||
],
|
||||
)
|
||||
repo = get_string_input(
|
||||
"Enter new repository URL",
|
||||
allow_special_chars=True,
|
||||
)
|
||||
branch = get_string_input(
|
||||
"Enter new branch name",
|
||||
allow_special_chars=True,
|
||||
DialogType.WARNING,
|
||||
[f"No {name} repositories configured in kiauh.cfg!"],
|
||||
center_content=True,
|
||||
)
|
||||
|
||||
return repo, branch
|
||||
def switch_klipper_repo(self, **kwargs) -> None:
|
||||
repos = self.settings.klipper.repositories
|
||||
RepoSelectMenu("klipper", repos=repos, previous_menu=self.__class__).run()
|
||||
|
||||
def _set_repo(self, repo_name: Literal["klipper", "moonraker"]) -> None:
|
||||
repo_url, branch = self._gather_input()
|
||||
display_name = repo_name.capitalize()
|
||||
Logger.print_dialog(
|
||||
DialogType.CUSTOM,
|
||||
[
|
||||
f"New {display_name} repository URL:",
|
||||
f"● {repo_url}",
|
||||
f"New {display_name} repository branch:",
|
||||
f"● {branch}",
|
||||
],
|
||||
)
|
||||
|
||||
if get_confirm("Apply changes?", allow_go_back=True):
|
||||
repo: RepoSettings = self.settings[repo_name]
|
||||
repo.repo_url = repo_url
|
||||
repo.branch = branch
|
||||
|
||||
self.settings.save()
|
||||
self._load_settings()
|
||||
|
||||
Logger.print_ok("Changes saved!")
|
||||
else:
|
||||
Logger.print_info(
|
||||
f"Skipping change of {display_name} source repository ..."
|
||||
)
|
||||
return
|
||||
|
||||
Logger.print_status(f"Switching to {display_name}'s new source repository ...")
|
||||
self._switch_repo(repo_name)
|
||||
|
||||
def _switch_repo(self, name: Literal["klipper", "moonraker"]) -> None:
|
||||
repo: RepoSettings = self.settings[name]
|
||||
run_switch_repo_routine(name, repo)
|
||||
|
||||
def set_klipper_repo(self, **kwargs) -> None:
|
||||
self._set_repo("klipper")
|
||||
|
||||
def set_moonraker_repo(self, **kwargs) -> None:
|
||||
self._set_repo("moonraker")
|
||||
def switch_moonraker_repo(self, **kwargs) -> None:
|
||||
repos = self.settings.moonraker.repositories
|
||||
RepoSelectMenu("moonraker", repos=repos, previous_menu=self.__class__).run()
|
||||
|
||||
def toggle_mainsail_release(self, **kwargs) -> None:
|
||||
self.mainsail_unstable = not self.mainsail_unstable
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -12,16 +12,16 @@ import textwrap
|
||||
from typing import Callable, List, Type
|
||||
|
||||
from components.crowsnest.crowsnest import get_crowsnest_status, update_crowsnest
|
||||
from components.klipper.klipper_setup import update_klipper
|
||||
from components.klipper.klipper_utils import (
|
||||
get_klipper_status,
|
||||
)
|
||||
from components.klipper.services.klipper_setup_service import KlipperSetupService
|
||||
from components.klipperscreen.klipperscreen import (
|
||||
get_klipperscreen_status,
|
||||
update_klipperscreen,
|
||||
)
|
||||
from components.moonraker.moonraker_setup import update_moonraker
|
||||
from components.moonraker.moonraker_utils import get_moonraker_status
|
||||
from components.moonraker.services.moonraker_setup_service import MoonrakerSetupService
|
||||
from components.moonraker.utils.utils import get_moonraker_status
|
||||
from components.webui_client.client_config.client_config_setup import (
|
||||
update_client_config,
|
||||
)
|
||||
@@ -32,17 +32,11 @@ from components.webui_client.client_utils import (
|
||||
)
|
||||
from components.webui_client.fluidd_data import FluiddData
|
||||
from components.webui_client.mainsail_data import MainsailData
|
||||
from core.constants import (
|
||||
COLOR_GREEN,
|
||||
COLOR_RED,
|
||||
COLOR_YELLOW,
|
||||
RESET_FORMAT,
|
||||
)
|
||||
from core.logger import DialogType, Logger
|
||||
from core.menus import Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.spinner import Spinner
|
||||
from core.types import ComponentStatus
|
||||
from core.types.color import Color
|
||||
from core.types.component_status import ComponentStatus
|
||||
from utils.input_utils import get_confirm
|
||||
from utils.sys_utils import (
|
||||
get_upgradable_packages,
|
||||
@@ -56,6 +50,11 @@ from utils.sys_utils import (
|
||||
class UpdateMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None) -> None:
|
||||
super().__init__()
|
||||
self.loading_msg = "Loading update menu, please wait"
|
||||
self.is_loading(True)
|
||||
|
||||
self.title = "Update Menu"
|
||||
self.title_color = Color.GREEN
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
|
||||
self.packages: List[str] = []
|
||||
@@ -123,6 +122,9 @@ class UpdateMenu(BaseMenu):
|
||||
},
|
||||
}
|
||||
|
||||
self._fetch_update_status()
|
||||
self.is_loading(False)
|
||||
|
||||
def set_previous_menu(self, previous_menu: Type[BaseMenu] | None) -> None:
|
||||
from core.menus.main_menu import MainMenu
|
||||
|
||||
@@ -143,29 +145,16 @@ class UpdateMenu(BaseMenu):
|
||||
}
|
||||
|
||||
def print_menu(self) -> None:
|
||||
spinner = Spinner("Loading update menu, please wait", color="green")
|
||||
spinner.start()
|
||||
|
||||
self._fetch_update_status()
|
||||
|
||||
spinner.stop()
|
||||
|
||||
header = " [ Update Menu ] "
|
||||
color = COLOR_GREEN
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
|
||||
sysupgrades: str = "No upgrades available."
|
||||
padding = 29
|
||||
if self.package_count > 0:
|
||||
sysupgrades = (
|
||||
f"{COLOR_GREEN}{self.package_count} upgrades available!{RESET_FORMAT}"
|
||||
sysupgrades = Color.apply(
|
||||
f"{self.package_count} upgrades available!", Color.GREEN
|
||||
)
|
||||
padding = 38
|
||||
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
╟───────────────────────┬───────────────┬───────────────╢
|
||||
║ a) Update all │ │ ║
|
||||
║ │ Current: │ Latest: ║
|
||||
@@ -204,10 +193,12 @@ class UpdateMenu(BaseMenu):
|
||||
self.upgrade_system_packages()
|
||||
|
||||
def update_klipper(self, **kwargs) -> None:
|
||||
self._run_update_routine("klipper", update_klipper)
|
||||
klsvc = KlipperSetupService()
|
||||
self._run_update_routine("klipper", klsvc.update)
|
||||
|
||||
def update_moonraker(self, **kwargs) -> None:
|
||||
self._run_update_routine("moonraker", update_moonraker)
|
||||
mrsvc = MoonrakerSetupService()
|
||||
self._run_update_routine("moonraker", mrsvc.update)
|
||||
|
||||
def update_mainsail(self, **kwargs) -> None:
|
||||
self._run_update_routine(
|
||||
@@ -265,15 +256,15 @@ class UpdateMenu(BaseMenu):
|
||||
self.package_count = len(self.packages)
|
||||
|
||||
def _format_local_status(self, local_version, remote_version) -> str:
|
||||
color = COLOR_RED
|
||||
color = Color.RED
|
||||
if not local_version:
|
||||
color = COLOR_RED
|
||||
color = Color.RED
|
||||
elif local_version == remote_version:
|
||||
color = COLOR_GREEN
|
||||
color = Color.GREEN
|
||||
elif local_version != remote_version:
|
||||
color = COLOR_YELLOW
|
||||
color = Color.YELLOW
|
||||
|
||||
return f"{color}{local_version or '-'}{RESET_FORMAT}"
|
||||
return Color.apply(local_version or "-", color)
|
||||
|
||||
def _set_status_data(self, name: str, status_fn: Callable, *args) -> None:
|
||||
comp_status: ComponentStatus = status_fn(*args)
|
||||
@@ -288,9 +279,9 @@ class UpdateMenu(BaseMenu):
|
||||
local_status = self.status_data[name].get("local", None)
|
||||
remote_status = self.status_data[name].get("remote", None)
|
||||
|
||||
color = COLOR_GREEN if remote_status else COLOR_RED
|
||||
color = Color.GREEN if remote_status else Color.RED
|
||||
local_txt = self._format_local_status(local_status, remote_status)
|
||||
remote_txt = f"{color}{remote_status or '-'}{RESET_FORMAT}"
|
||||
remote_txt = Color.apply(remote_status or "-", color)
|
||||
|
||||
setattr(self, f"{name}_local", local_txt)
|
||||
setattr(self, f"{name}_remote", remote_txt)
|
||||
|
||||
0
kiauh/core/services/__init__.py
Normal file
0
kiauh/core/services/__init__.py
Normal file
61
kiauh/core/services/message_service.py
Normal file
61
kiauh/core/services/message_service.py
Normal file
@@ -0,0 +1,61 @@
|
||||
# ======================================================================= #
|
||||
# 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 typing import List
|
||||
|
||||
from core.logger import DialogType, Logger
|
||||
from core.types.color import Color
|
||||
|
||||
|
||||
@dataclass()
|
||||
class Message:
|
||||
title: str = field(default="")
|
||||
text: List[str] = field(default_factory=list)
|
||||
color: Color = field(default=Color.WHITE)
|
||||
centered: bool = field(default=False)
|
||||
|
||||
|
||||
class MessageService:
|
||||
__cls_instance = None
|
||||
__message: Message | None
|
||||
|
||||
def __new__(cls) -> "MessageService":
|
||||
if cls.__cls_instance is None:
|
||||
cls.__cls_instance = super(MessageService, cls).__new__(cls)
|
||||
return cls.__cls_instance
|
||||
|
||||
def __init__(self) -> None:
|
||||
if not hasattr(self, "__initialized"):
|
||||
self.__initialized = False
|
||||
if self.__initialized:
|
||||
return
|
||||
self.__initialized = True
|
||||
self.__message = None
|
||||
|
||||
def set_message(self, message: Message) -> None:
|
||||
self.__message = message
|
||||
|
||||
def display_message(self) -> None:
|
||||
if self.__message is None:
|
||||
return
|
||||
|
||||
Logger.print_dialog(
|
||||
title=DialogType.CUSTOM,
|
||||
content=self.__message.text,
|
||||
custom_title=self.__message.title,
|
||||
custom_color=self.__message.color,
|
||||
center_content=self.__message.centered,
|
||||
)
|
||||
|
||||
self.__clear_message()
|
||||
|
||||
def __clear_message(self) -> None:
|
||||
self.__message = None
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -8,15 +8,18 @@
|
||||
# ======================================================================= #
|
||||
from __future__ import annotations
|
||||
|
||||
import shutil
|
||||
from dataclasses import dataclass, field
|
||||
from typing import Any
|
||||
from typing import Any, Callable, List, TypeVar
|
||||
|
||||
from components.klipper import KLIPPER_REPO_URL
|
||||
from components.moonraker import MOONRAKER_REPO_URL
|
||||
from core.backup_manager.backup_manager import BackupManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
NoOptionError,
|
||||
NoSectionError,
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from utils.input_utils import get_confirm
|
||||
from utils.sys_utils import kill
|
||||
|
||||
from kiauh import PROJECT_ROOT
|
||||
@@ -24,6 +27,16 @@ from kiauh import PROJECT_ROOT
|
||||
DEFAULT_CFG = PROJECT_ROOT.joinpath("default.kiauh.cfg")
|
||||
CUSTOM_CFG = PROJECT_ROOT.joinpath("kiauh.cfg")
|
||||
|
||||
T = TypeVar("T")
|
||||
|
||||
|
||||
class InvalidValueError(Exception):
|
||||
"""Raised when a value is invalid for an option"""
|
||||
|
||||
def __init__(self, section: str, option: str, value: str):
|
||||
msg = f"Invalid value '{value}' for option '{option}' in section '{section}'"
|
||||
super().__init__(msg)
|
||||
|
||||
|
||||
@dataclass
|
||||
class AppSettings:
|
||||
@@ -31,26 +44,40 @@ class AppSettings:
|
||||
|
||||
|
||||
@dataclass
|
||||
class RepoSettings:
|
||||
repo_url: str | None = field(default=None)
|
||||
branch: str | None = field(default=None)
|
||||
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: str | None = field(default=None)
|
||||
port: int | None = field(default=None)
|
||||
unstable_releases: bool | None = field(default=None)
|
||||
|
||||
|
||||
# noinspection PyUnusedLocal
|
||||
# noinspection PyMethodMayBeStatic
|
||||
class KiauhSettings:
|
||||
_instance = None
|
||||
__instance = None
|
||||
__initialized = False
|
||||
|
||||
def __new__(cls, *args, **kwargs) -> "KiauhSettings":
|
||||
if cls._instance is None:
|
||||
cls._instance = super(KiauhSettings, cls).__new__(cls, *args, **kwargs)
|
||||
return cls._instance
|
||||
if cls.__instance is None:
|
||||
cls.__instance = super(KiauhSettings, cls).__new__(cls, *args, **kwargs)
|
||||
return cls.__instance
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return (
|
||||
@@ -63,20 +90,20 @@ 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 = RepoSettings()
|
||||
self.moonraker = RepoSettings()
|
||||
self.klipper = KlipperSettings()
|
||||
self.moonraker = MoonrakerSettings()
|
||||
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
|
||||
@@ -94,106 +121,294 @@ 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)
|
||||
|
||||
self._validate_cfg()
|
||||
self._apply_settings_from_file()
|
||||
|
||||
def _validate_cfg(self) -> None:
|
||||
try:
|
||||
self._validate_bool("kiauh", "backup_before_update")
|
||||
|
||||
self._validate_str("klipper", "repo_url")
|
||||
self._validate_str("klipper", "branch")
|
||||
|
||||
self._validate_int("mainsail", "port")
|
||||
self._validate_bool("mainsail", "unstable_releases")
|
||||
|
||||
self._validate_int("fluidd", "port")
|
||||
self._validate_bool("fluidd", "unstable_releases")
|
||||
|
||||
except ValueError:
|
||||
err = f"Invalid value for option '{self._v_option}' in section '{self._v_section}'"
|
||||
Logger.print_error(err)
|
||||
kill()
|
||||
except NoSectionError:
|
||||
err = f"Missing section '{self._v_section}' in config file"
|
||||
Logger.print_error(err)
|
||||
kill()
|
||||
except NoOptionError:
|
||||
err = f"Missing option '{self._v_option}' in section '{self._v_section}'"
|
||||
Logger.print_error(err)
|
||||
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()
|
||||
|
||||
def _validate_bool(self, section: str, option: str) -> None:
|
||||
self._v_section, self._v_option = (section, option)
|
||||
(bool(self.config.getboolean(section, option)))
|
||||
# copy default config to custom config if it does not exist
|
||||
if not CUSTOM_CFG.exists():
|
||||
shutil.copyfile(DEFAULT_CFG, CUSTOM_CFG)
|
||||
|
||||
def _validate_int(self, section: str, option: str) -> None:
|
||||
self._v_section, self._v_option = (section, option)
|
||||
int(self.config.getint(section, option))
|
||||
self.config.read_file(CUSTOM_CFG)
|
||||
|
||||
def _validate_str(self, section: str, option: str) -> None:
|
||||
self._v_section, self._v_option = (section, option)
|
||||
v = self.config.getval(section, option)
|
||||
if v.isdigit() or v.lower() == "true" or v.lower() == "false":
|
||||
raise ValueError
|
||||
# check if there are deprecated repo_url and branch options in the kiauh.cfg
|
||||
if self._check_deprecated_repo_config():
|
||||
self._prompt_migration_dialog()
|
||||
|
||||
def _apply_settings_from_file(self) -> None:
|
||||
self.kiauh.backup_before_update = self.config.getboolean(
|
||||
"kiauh", "backup_before_update"
|
||||
)
|
||||
self.klipper.repo_url = self.config.getval("klipper", "repo_url")
|
||||
self.klipper.branch = self.config.getval("klipper", "branch")
|
||||
self.moonraker.repo_url = self.config.getval("moonraker", "repo_url")
|
||||
self.moonraker.branch = self.config.getval("moonraker", "branch")
|
||||
self.mainsail.port = self.config.getint("mainsail", "port")
|
||||
self.mainsail.unstable_releases = self.config.getboolean(
|
||||
"mainsail", "unstable_releases"
|
||||
)
|
||||
self.fluidd.port = self.config.getint("fluidd", "port")
|
||||
self.fluidd.unstable_releases = self.config.getboolean(
|
||||
"fluidd", "unstable_releases"
|
||||
)
|
||||
self.__set_internal_state()
|
||||
|
||||
def _set_config_options_state(self) -> None:
|
||||
self.config.set_option(
|
||||
def __set_internal_state(self) -> None:
|
||||
# parse Kiauh options
|
||||
self.kiauh.backup_before_update = self.__read_from_cfg(
|
||||
"kiauh",
|
||||
"backup_before_update",
|
||||
str(self.kiauh.backup_before_update),
|
||||
)
|
||||
self.config.set_option("klipper", "repo_url", self.klipper.repo_url)
|
||||
self.config.set_option("klipper", "branch", self.klipper.branch)
|
||||
self.config.set_option("moonraker", "repo_url", self.moonraker.repo_url)
|
||||
self.config.set_option("moonraker", "branch", self.moonraker.branch)
|
||||
self.config.set_option("mainsail", "port", str(self.mainsail.port))
|
||||
self.config.set_option(
|
||||
"mainsail",
|
||||
"unstable_releases",
|
||||
str(self.mainsail.unstable_releases),
|
||||
)
|
||||
self.config.set_option("fluidd", "port", str(self.fluidd.port))
|
||||
self.config.set_option(
|
||||
"fluidd", "unstable_releases", str(self.fluidd.unstable_releases)
|
||||
self.config.getboolean,
|
||||
False,
|
||||
)
|
||||
|
||||
def _kill(self) -> None:
|
||||
# parse Klipper options
|
||||
self.klipper.use_python_binary = self.__read_from_cfg(
|
||||
"klipper",
|
||||
"use_python_binary",
|
||||
self.config.getval,
|
||||
None,
|
||||
True,
|
||||
)
|
||||
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,
|
||||
)
|
||||
|
||||
# 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 __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(
|
||||
"kiauh",
|
||||
"backup_before_update",
|
||||
str(self.kiauh.backup_before_update),
|
||||
)
|
||||
|
||||
# Handle repositories
|
||||
if self.klipper.repositories is not None:
|
||||
repos = [f"{repo.url}, {repo.branch}" for repo in self.klipper.repositories]
|
||||
self.config.set_option("klipper", "repositories", repos)
|
||||
|
||||
if self.moonraker.repositories is not None:
|
||||
repos = [
|
||||
f"{repo.url}, {repo.branch}" for repo in self.moonraker.repositories
|
||||
]
|
||||
self.config.set_option("moonraker", "repositories", repos)
|
||||
|
||||
# Handle Mainsail settings
|
||||
if self.mainsail.port is not None:
|
||||
self.config.set_option("mainsail", "port", str(self.mainsail.port))
|
||||
if self.mainsail.unstable_releases is not None:
|
||||
self.config.set_option(
|
||||
"mainsail",
|
||||
"unstable_releases",
|
||||
str(self.mainsail.unstable_releases),
|
||||
)
|
||||
|
||||
# Handle Fluidd settings
|
||||
if self.fluidd.port is not None:
|
||||
self.config.set_option("fluidd", "port", str(self.fluidd.port))
|
||||
if self.fluidd.unstable_releases is not None:
|
||||
self.config.set_option(
|
||||
"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"]:
|
||||
if self.config.has_option(section, "repo_url") or self.config.has_option(
|
||||
section, "branch"
|
||||
):
|
||||
return True
|
||||
return False
|
||||
|
||||
def _prompt_migration_dialog(self) -> None:
|
||||
migration_1: List[str] = [
|
||||
"Options 'repo_url' and 'branch' are now combined into a 'repositories' option.",
|
||||
"\n\n",
|
||||
"● Old format:",
|
||||
" [klipper]",
|
||||
" repo_url: https://github.com/Klipper3d/klipper",
|
||||
" branch: master",
|
||||
"\n\n",
|
||||
"● New format:",
|
||||
" [klipper]",
|
||||
" repositories:",
|
||||
" https://github.com/Klipper3d/klipper, master",
|
||||
]
|
||||
Logger.print_dialog(
|
||||
DialogType.ERROR,
|
||||
DialogType.ATTENTION,
|
||||
[
|
||||
"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",
|
||||
"Deprecated kiauh.cfg configuration found!",
|
||||
"KAIUH can now attempt to automatically migrate the configuration.",
|
||||
"\n\n",
|
||||
*migration_1,
|
||||
],
|
||||
)
|
||||
kill()
|
||||
if get_confirm("Migrate to the new format?"):
|
||||
self._migrate_repo_config()
|
||||
else:
|
||||
Logger.print_dialog(
|
||||
DialogType.ERROR,
|
||||
[
|
||||
"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):
|
||||
Logger.print_dialog(
|
||||
DialogType.ERROR,
|
||||
[
|
||||
"Failed to create backup of kiauh.cfg. Aborting migration. Please migrate manually."
|
||||
],
|
||||
)
|
||||
kill()
|
||||
|
||||
# run migrations
|
||||
try:
|
||||
# migrate deprecated repo_url and branch options - 2025.03.23
|
||||
for section in ["klipper", "moonraker"]:
|
||||
if not self.config.has_section(section):
|
||||
continue
|
||||
|
||||
repo_url = self.config.getval(section, "repo_url", fallback="")
|
||||
branch = self.config.getval(section, "branch", fallback="master")
|
||||
|
||||
if repo_url:
|
||||
# create repositories option with the old values
|
||||
repositories = [f"{repo_url}, {branch}\n"]
|
||||
self.config.set_option(section, "repositories", repositories)
|
||||
|
||||
# remove deprecated options
|
||||
self.config.remove_option(section, "repo_url")
|
||||
self.config.remove_option(section, "branch")
|
||||
|
||||
Logger.print_ok(f"Successfully migrated {section} configuration")
|
||||
|
||||
self.config.write_file(CUSTOM_CFG)
|
||||
self.config.read_file(CUSTOM_CFG) # reload config
|
||||
|
||||
except Exception as e:
|
||||
Logger.print_error(f"Error migrating configuration: {e}")
|
||||
Logger.print_error("Please migrate manually.")
|
||||
kill()
|
||||
|
||||
@@ -3,13 +3,7 @@ import threading
|
||||
import time
|
||||
from typing import List, Literal
|
||||
|
||||
from core.constants import (
|
||||
COLOR_GREEN,
|
||||
COLOR_RED,
|
||||
COLOR_WHITE,
|
||||
COLOR_YELLOW,
|
||||
RESET_FORMAT,
|
||||
)
|
||||
from core.types.color import Color
|
||||
|
||||
SpinnerColor = Literal["white", "red", "green", "yellow"]
|
||||
|
||||
@@ -18,21 +12,18 @@ class Spinner:
|
||||
def __init__(
|
||||
self,
|
||||
message: str = "Loading",
|
||||
color: SpinnerColor = "white",
|
||||
interval: float = 0.2,
|
||||
) -> None:
|
||||
self.message = f"{message} ..."
|
||||
self.interval = interval
|
||||
self._stop_event = threading.Event()
|
||||
self._thread = threading.Thread(target=self._animate)
|
||||
self._color = ""
|
||||
self._set_color(color)
|
||||
|
||||
def _animate(self) -> None:
|
||||
animation: List[str] = ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]
|
||||
while not self._stop_event.is_set():
|
||||
for char in animation:
|
||||
sys.stdout.write(f"\r{self._color}{char}{RESET_FORMAT} {self.message}")
|
||||
sys.stdout.write(f"\r{Color.GREEN}{char}{Color.RST} {self.message}")
|
||||
sys.stdout.flush()
|
||||
time.sleep(self.interval)
|
||||
if self._stop_event.is_set():
|
||||
@@ -40,16 +31,6 @@ class Spinner:
|
||||
sys.stdout.write("\r" + " " * (len(self.message) + 1) + "\r")
|
||||
sys.stdout.flush()
|
||||
|
||||
def _set_color(self, color: SpinnerColor) -> None:
|
||||
if color == "white":
|
||||
self._color = COLOR_WHITE
|
||||
elif color == "red":
|
||||
self._color = COLOR_RED
|
||||
elif color == "green":
|
||||
self._color = COLOR_GREEN
|
||||
elif color == "yellow":
|
||||
self._color = COLOR_YELLOW
|
||||
|
||||
def start(self) -> None:
|
||||
self._stop_event.clear()
|
||||
if not self._thread.is_alive():
|
||||
|
||||
@@ -3,4 +3,48 @@
|
||||
A custom config parser inspired by Python's configparser module.
|
||||
Specialized for handling Klipper style config files.
|
||||
|
||||
---
|
||||
|
||||
### When parsing a config file, it will be split into the following elements:
|
||||
- Header: All lines before the first section
|
||||
- Section: A section is defined by a line starting with a `[` and ending with a `]`
|
||||
- Option: A line starting with a word, followed by a `:` or `=` and a value
|
||||
- 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
|
||||
|
||||
---
|
||||
|
||||
### Internally, the config is stored as a dictionary of sections, each containing a header and a list of elements:
|
||||
```python
|
||||
config = {
|
||||
"section_name": {
|
||||
"header": "[section_name]\n",
|
||||
"elements": [
|
||||
{
|
||||
"type": "comment",
|
||||
"content": "# This is a comment\n"
|
||||
},
|
||||
{
|
||||
"type": "option",
|
||||
"name": "option1",
|
||||
"value": "value1",
|
||||
"raw": "option1: value1\n"
|
||||
},
|
||||
{
|
||||
"type": "blank",
|
||||
"content": "\n"
|
||||
},
|
||||
{
|
||||
"type": "option_block",
|
||||
"name": "option2",
|
||||
"value": [
|
||||
"value2",
|
||||
"value3"
|
||||
],
|
||||
"raw": "option2:"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -36,7 +36,7 @@ extend-select = ["I"]
|
||||
[tool.pytest.ini_options]
|
||||
minversion = "8.2.1"
|
||||
testpaths = ["tests/**/*.py"]
|
||||
addopts = "--cov --cov-config=pyproject.toml --cov-report=html"
|
||||
addopts = "-svvv --cov --cov-config=pyproject.toml --cov-report=html"
|
||||
|
||||
[tool.coverage.run]
|
||||
branch = true
|
||||
|
||||
@@ -6,6 +6,7 @@
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
import re
|
||||
from enum import Enum
|
||||
|
||||
# definition of section line:
|
||||
# - then line MUST start with an opening square bracket - it is the first section marker
|
||||
@@ -60,3 +61,11 @@ BOOLEAN_STATES = {
|
||||
}
|
||||
|
||||
HEADER_IDENT = "#_header"
|
||||
|
||||
INDENT = " " * 4
|
||||
|
||||
class LineType(Enum):
|
||||
OPTION = "option"
|
||||
OPTION_BLOCK = "option_block"
|
||||
COMMENT = "comment"
|
||||
BLANK = "blank"
|
||||
|
||||
@@ -8,8 +8,6 @@
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import secrets
|
||||
import string
|
||||
from pathlib import Path
|
||||
from typing import Callable, Dict, List
|
||||
|
||||
@@ -20,7 +18,7 @@ from ..simple_config_parser.constants import (
|
||||
LINE_COMMENT_RE,
|
||||
OPTION_RE,
|
||||
OPTIONS_BLOCK_START_RE,
|
||||
SECTION_RE,
|
||||
SECTION_RE, LineType, INDENT,
|
||||
)
|
||||
|
||||
_UNSET = object()
|
||||
@@ -49,6 +47,13 @@ class NoOptionError(Exception):
|
||||
msg = f"Option '{option}' in section '{section}' is not defined"
|
||||
super().__init__(msg)
|
||||
|
||||
class UnknownLineError(Exception):
|
||||
"""Raised when a line is not recognized as any known type"""
|
||||
|
||||
def __init__(self, line: str):
|
||||
msg = f"Unknown line: '{line}'"
|
||||
super().__init__(msg)
|
||||
|
||||
|
||||
# noinspection PyMethodMayBeStatic
|
||||
class SimpleConfigParser:
|
||||
@@ -59,7 +64,6 @@ class SimpleConfigParser:
|
||||
self.config: Dict = {}
|
||||
self.current_section: str | None = None
|
||||
self.current_opt_block: str | None = None
|
||||
self.current_collector: str | None = None
|
||||
self.in_option_block: bool = False
|
||||
|
||||
def _match_section(self, line: str) -> bool:
|
||||
@@ -85,28 +89,40 @@ class SimpleConfigParser:
|
||||
def _parse_line(self, line: str) -> None:
|
||||
"""Parses a line and determines its type"""
|
||||
if self._match_section(line):
|
||||
self.current_collector = None
|
||||
self.current_opt_block = None
|
||||
self.current_section = SECTION_RE.match(line).group(1)
|
||||
self.config[self.current_section] = {"_raw": line}
|
||||
self.config[self.current_section] = {
|
||||
"header": line,
|
||||
"elements": []
|
||||
}
|
||||
|
||||
elif self._match_option(line):
|
||||
self.current_collector = None
|
||||
self.current_opt_block = None
|
||||
option = OPTION_RE.match(line).group(1)
|
||||
value = OPTION_RE.match(line).group(2)
|
||||
self.config[self.current_section][option] = {"_raw": line, "value": value}
|
||||
self.config[self.current_section]["elements"].append({
|
||||
"type": LineType.OPTION.value,
|
||||
"name": option,
|
||||
"value": value,
|
||||
"raw": line
|
||||
})
|
||||
|
||||
elif self._match_options_block_start(line):
|
||||
self.current_collector = None
|
||||
option = OPTIONS_BLOCK_START_RE.match(line).group(1)
|
||||
self.current_opt_block = option
|
||||
self.config[self.current_section][option] = {"_raw": line, "value": []}
|
||||
self.config[self.current_section]["elements"].append({
|
||||
"type": LineType.OPTION_BLOCK.value,
|
||||
"name": option,
|
||||
"value": [],
|
||||
"raw": line
|
||||
})
|
||||
|
||||
elif self.current_opt_block is not None:
|
||||
self.config[self.current_section][self.current_opt_block]["value"].append(
|
||||
line
|
||||
)
|
||||
# we are in an option block, so we add the line to the option's value
|
||||
for element in reversed(self.config[self.current_section]["elements"]):
|
||||
if element["type"] == LineType.OPTION_BLOCK.value and element["name"] == self.current_opt_block:
|
||||
element["value"].append(line.strip()) # indentation is removed
|
||||
break
|
||||
|
||||
elif self._match_empty_line(line) or self._match_line_comment(line):
|
||||
self.current_opt_block = None
|
||||
@@ -116,15 +132,11 @@ class SimpleConfigParser:
|
||||
if not self.current_section:
|
||||
self.config.setdefault(HEADER_IDENT, []).append(line)
|
||||
else:
|
||||
section = self.config[self.current_section]
|
||||
|
||||
# set the current collector to a new value, so that continuous
|
||||
# empty lines or comments are collected into the same collector
|
||||
if not self.current_collector:
|
||||
self.current_collector = self._generate_rand_id()
|
||||
section[self.current_collector] = []
|
||||
|
||||
section[self.current_collector].append(line)
|
||||
element_type = LineType.BLANK.value if self._match_empty_line(line) else LineType.COMMENT.value
|
||||
self.config[self.current_section]["elements"].append({
|
||||
"type": element_type,
|
||||
"content": line
|
||||
})
|
||||
|
||||
def read_file(self, file: Path) -> None:
|
||||
"""Read and parse a config file"""
|
||||
@@ -132,41 +144,46 @@ class SimpleConfigParser:
|
||||
for line in file:
|
||||
self._parse_line(line)
|
||||
|
||||
# print(json.dumps(self.config, indent=4))
|
||||
def write_file(self, path: str | Path) -> None:
|
||||
"""Write the config to a file"""
|
||||
if path is None:
|
||||
raise ValueError("File path cannot be None")
|
||||
|
||||
def write_file(self, file: Path) -> None:
|
||||
"""Write the current config to the config file"""
|
||||
if not file:
|
||||
raise ValueError("No config file specified")
|
||||
with open(path, "w", encoding="utf-8") as f:
|
||||
if HEADER_IDENT in self.config:
|
||||
for line in self.config[HEADER_IDENT]:
|
||||
f.write(line)
|
||||
|
||||
with open(file, "w") as file:
|
||||
self._write_header(file)
|
||||
self._write_sections(file)
|
||||
sections = self.get_sections()
|
||||
for i, section in enumerate(sections):
|
||||
f.write(self.config[section]["header"])
|
||||
|
||||
def _write_header(self, file) -> None:
|
||||
"""Write the header to the config file"""
|
||||
for line in self.config.get(HEADER_IDENT, []):
|
||||
file.write(line)
|
||||
for element in self.config[section]["elements"]:
|
||||
if element["type"] == LineType.OPTION.value:
|
||||
f.write(element["raw"])
|
||||
elif element["type"] == LineType.OPTION_BLOCK.value:
|
||||
f.write(element["raw"])
|
||||
for line in element["value"]:
|
||||
f.write(INDENT + line.strip() + "\n")
|
||||
elif element["type"] in [LineType.COMMENT.value, LineType.BLANK.value]:
|
||||
f.write(element["content"])
|
||||
else:
|
||||
raise UnknownLineError(element["raw"])
|
||||
|
||||
def _write_sections(self, file) -> None:
|
||||
"""Write the sections to the config file"""
|
||||
for section in self.get_sections():
|
||||
for key, value in self.config[section].items():
|
||||
self._write_section_content(file, key, value)
|
||||
# Ensure file ends with a single newline
|
||||
if sections: # Only if we have any sections
|
||||
last_section = sections[-1]
|
||||
last_elements = self.config[last_section]["elements"]
|
||||
|
||||
def _write_section_content(self, file, key, value) -> None:
|
||||
"""Write the content of a section to the config file"""
|
||||
if key == "_raw":
|
||||
file.write(value)
|
||||
elif key.startswith("#_"):
|
||||
for line in value:
|
||||
file.write(line)
|
||||
elif isinstance(value["value"], list):
|
||||
file.write(value["_raw"])
|
||||
for line in value["value"]:
|
||||
file.write(line)
|
||||
else:
|
||||
file.write(value["_raw"])
|
||||
if last_elements:
|
||||
last_element = last_elements[-1]
|
||||
if "raw" in last_element:
|
||||
last_line = last_element["raw"]
|
||||
else: # comment or blank line
|
||||
last_line = last_element["content"]
|
||||
|
||||
if not last_line.endswith("\n"):
|
||||
f.write("\n")
|
||||
|
||||
def get_sections(self) -> List[str]:
|
||||
"""Return a list of all section names, but exclude any section starting with '#_'"""
|
||||
@@ -189,29 +206,40 @@ class SimpleConfigParser:
|
||||
if len(self.get_sections()) >= 1:
|
||||
self._check_set_section_spacing()
|
||||
|
||||
self.config[section] = {"_raw": f"[{section}]\n"}
|
||||
self.config[section] = {
|
||||
"header": f"[{section}]\n",
|
||||
"elements": []
|
||||
}
|
||||
|
||||
def _check_set_section_spacing(self):
|
||||
"""Check if there is a blank line between the last section and the new section"""
|
||||
prev_section_name: str = self.get_sections()[-1]
|
||||
prev_section_content: Dict = self.config[prev_section_name]
|
||||
last_option_name: str = list(prev_section_content.keys())[-1]
|
||||
prev_section = self.config[prev_section_name]
|
||||
prev_elements = prev_section["elements"]
|
||||
|
||||
if last_option_name.startswith("#_"):
|
||||
last_elem_value: str = prev_section_content[last_option_name][-1]
|
||||
if prev_elements:
|
||||
last_element = prev_elements[-1]
|
||||
|
||||
# if the last section is a collector, we first check if the last element
|
||||
# in the collector ends with a newline. if it does not, we append a newline.
|
||||
# this can happen if the config file does not end with a newline.
|
||||
if not last_elem_value.endswith("\n"):
|
||||
prev_section_content[last_option_name][-1] = f"{last_elem_value}\n"
|
||||
# If the last element is a comment or blank line
|
||||
if last_element["type"] in [LineType.COMMENT.value, LineType.BLANK.value]:
|
||||
last_content = last_element["content"]
|
||||
|
||||
# if the last item in a collector is not a newline, we append a newline, so
|
||||
# that the new section is seperated from the options of the previous section
|
||||
# by a newline
|
||||
if last_elem_value != "\n":
|
||||
prev_section_content[last_option_name].append("\n")
|
||||
else:
|
||||
prev_section_content[self._generate_rand_id()] = ["\n"]
|
||||
# If the last element doesn't end with a newline, add one
|
||||
if not last_content.endswith("\n"):
|
||||
last_element["content"] += "\n"
|
||||
|
||||
# If the last element is not a blank line, add a blank line
|
||||
if last_content.strip() != "":
|
||||
prev_elements.append({
|
||||
"type": "blank",
|
||||
"content": "\n"
|
||||
})
|
||||
else:
|
||||
# If the last element is an option, add a blank line
|
||||
prev_elements.append({
|
||||
"type": LineType.BLANK.value,
|
||||
"content": "\n"
|
||||
})
|
||||
|
||||
def remove_section(self, section: str) -> None:
|
||||
"""Remove a section from the config"""
|
||||
@@ -219,12 +247,12 @@ class SimpleConfigParser:
|
||||
|
||||
def get_options(self, section: str) -> List[str]:
|
||||
"""Return a list of all option names for a given section"""
|
||||
return list(
|
||||
filter(
|
||||
lambda option: option != "_raw" and not option.startswith("#_"),
|
||||
self.config[section].keys(),
|
||||
)
|
||||
)
|
||||
options = []
|
||||
if self.has_section(section):
|
||||
for element in self.config[section]["elements"]:
|
||||
if element["type"] in [LineType.OPTION.value, LineType.OPTION_BLOCK.value]:
|
||||
options.append(element["name"])
|
||||
return options
|
||||
|
||||
def has_option(self, section: str, option: str) -> bool:
|
||||
"""Check if an option exists in a section"""
|
||||
@@ -238,26 +266,55 @@ class SimpleConfigParser:
|
||||
if not self.has_section(section):
|
||||
self.add_section(section)
|
||||
|
||||
if not self.has_option(section, option):
|
||||
self.config[section][option] = {
|
||||
"_raw": f"{option}:\n"
|
||||
if isinstance(value, list)
|
||||
else f"{option}: {value}\n",
|
||||
# Check if option already exists
|
||||
for element in self.config[section]["elements"]:
|
||||
if element["type"] in [LineType.OPTION.value, LineType.OPTION_BLOCK.value] and element["name"] == option:
|
||||
# Update existing option
|
||||
if isinstance(value, list):
|
||||
element["type"] = LineType.OPTION_BLOCK.value
|
||||
element["value"] = value
|
||||
element["raw"] = f"{option}:\n"
|
||||
else:
|
||||
element["type"] = LineType.OPTION.value
|
||||
element["value"] = value
|
||||
element["raw"] = f"{option}: {value}\n"
|
||||
return
|
||||
|
||||
# Option doesn't exist, create new one
|
||||
if isinstance(value, list):
|
||||
new_element = {
|
||||
"type": LineType.OPTION_BLOCK.value,
|
||||
"name": option,
|
||||
"value": value,
|
||||
"raw": f"{option}:\n"
|
||||
}
|
||||
else:
|
||||
opt = self.config[section][option]
|
||||
if not isinstance(value, list):
|
||||
opt["_raw"] = opt["_raw"].replace(opt["value"], value)
|
||||
opt["value"] = value
|
||||
new_element = {
|
||||
"type": LineType.OPTION.value,
|
||||
"name": option,
|
||||
"value": value,
|
||||
"raw": f"{option}: {value}\n"
|
||||
}
|
||||
|
||||
# scan through elements to find the last option, after which we insert the new option
|
||||
insert_pos = 0
|
||||
elements = self.config[section]["elements"]
|
||||
for i, element in enumerate(elements):
|
||||
if element["type"] in [LineType.OPTION.value, LineType.OPTION_BLOCK.value]:
|
||||
insert_pos = i + 1
|
||||
|
||||
elements.insert(insert_pos, new_element)
|
||||
|
||||
def remove_option(self, section: str, option: str) -> None:
|
||||
"""Remove an option from a section"""
|
||||
self.config[section].pop(option, None)
|
||||
if self.has_section(section):
|
||||
elements = self.config[section]["elements"]
|
||||
for i, element in enumerate(elements):
|
||||
if element["type"] in [LineType.OPTION.value, LineType.OPTION_BLOCK.value] and element["name"] == option:
|
||||
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
|
||||
|
||||
@@ -269,7 +326,35 @@ class SimpleConfigParser:
|
||||
raise NoSectionError(section)
|
||||
if option not in self.get_options(section):
|
||||
raise NoOptionError(option, section)
|
||||
return self.config[section][option]["value"]
|
||||
|
||||
for element in self.config[section]["elements"]:
|
||||
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
|
||||
@@ -317,9 +402,3 @@ class SimpleConfigParser:
|
||||
raise ValueError(
|
||||
f"Cannot convert {self.getval(section, option)} to {conv.__name__}"
|
||||
) from e
|
||||
|
||||
def _generate_rand_id(self) -> str:
|
||||
"""Generate a random id with 6 characters"""
|
||||
chars = string.ascii_letters + string.digits
|
||||
rand_string = "".join(secrets.choice(chars) for _ in range(12))
|
||||
return f"#_{rand_string}"
|
||||
|
||||
@@ -25,8 +25,8 @@ option_4: value_4
|
||||
#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
|
||||
# these are multi-line values
|
||||
value_5_1
|
||||
value_5_2 ; here is a comment
|
||||
value_5_3
|
||||
option_5_1: value_5_1
|
||||
|
||||
@@ -25,9 +25,9 @@ option_4: value_4
|
||||
#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
|
||||
# these are multi-line values
|
||||
value_5_1
|
||||
value_5_2 ; here is a comment
|
||||
value_5_3
|
||||
option_5_1: value_5_1
|
||||
# config ending with a comment
|
||||
|
||||
@@ -25,22 +25,22 @@ option_4: value_4
|
||||
#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
|
||||
# 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 %}
|
||||
{% 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
|
||||
#
|
||||
@@ -48,47 +48,47 @@ gcode:
|
||||
[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
|
||||
# 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}
|
||||
{% if 'exclude_object' not in printer %}
|
||||
{action_raise_error("[exclude_object] is not enabled")}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
{% if 'U' in params %}
|
||||
EXCLUDE_OBJECT RESET=1 NAME={params.U}
|
||||
{% 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 %}
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
[section_1]
|
||||
# comment
|
||||
option_1: value_1
|
||||
option_2: value_2 ; comment
|
||||
new_option: new_value
|
||||
|
||||
[section_2]
|
||||
option_3: value_3
|
||||
@@ -0,0 +1,7 @@
|
||||
[section_1]
|
||||
# comment
|
||||
option_1: value_1
|
||||
option_2: value_2 ; comment
|
||||
|
||||
[section_2]
|
||||
option_3: value_3
|
||||
@@ -0,0 +1,7 @@
|
||||
[section_1]
|
||||
# comment
|
||||
option_1: value_1
|
||||
option_2: value_2 ; comment
|
||||
|
||||
[section_2]
|
||||
option_3: value_3
|
||||
@@ -0,0 +1,8 @@
|
||||
[section_1]
|
||||
# comment
|
||||
option_1: value_1
|
||||
option_to_remove: value_to_remove
|
||||
option_2: value_2 ; comment
|
||||
|
||||
[section_2]
|
||||
option_3: value_3
|
||||
@@ -0,0 +1,7 @@
|
||||
[section_1]
|
||||
option_1: value_1
|
||||
option_2: value_2
|
||||
|
||||
# comment
|
||||
[section_2]
|
||||
option_5: value_5
|
||||
@@ -0,0 +1,11 @@
|
||||
[section_1]
|
||||
option_1: value_1
|
||||
option_2: value_2
|
||||
|
||||
# comment
|
||||
[section_to_remove]
|
||||
option_3: value_3
|
||||
option_4: value_4
|
||||
|
||||
[section_2]
|
||||
option_5: value_5
|
||||
@@ -5,11 +5,12 @@
|
||||
# #
|
||||
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||
# ======================================================================= #
|
||||
import json
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.constants import HEADER_IDENT
|
||||
from src.simple_config_parser.constants import HEADER_IDENT, LineType
|
||||
from src.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from tests.utils import load_testdata_from_file
|
||||
|
||||
@@ -33,16 +34,17 @@ def test_section_parsing(parser):
|
||||
), f"Expected keys: {expected_keys}, got: {parser.config.keys()}"
|
||||
assert parser.in_option_block is False
|
||||
assert parser.current_section == parser.get_sections()[-1]
|
||||
assert parser.config["section_2"]["_raw"] == "[section_2] ; comment"
|
||||
assert parser.config["section_2"] is not None
|
||||
assert parser.config["section_2"]["header"] == "[section_2] ; comment"
|
||||
assert parser.config["section_2"]["elements"] is not None
|
||||
assert len(parser.config["section_2"]["elements"]) > 0
|
||||
|
||||
|
||||
def test_option_parsing(parser):
|
||||
assert parser.config["section_1"]["option_1"]["value"] == "value_1"
|
||||
assert parser.config["section_1"]["option_1"]["_raw"] == "option_1: value_1"
|
||||
assert parser.config["section_3"]["option_3"]["value"] == "value_3"
|
||||
assert (
|
||||
parser.config["section_3"]["option_3"]["_raw"] == "option_3: value_3 # comment"
|
||||
)
|
||||
assert parser.config["section_1"]["elements"][0]["type"] == LineType.OPTION.value
|
||||
assert parser.config["section_1"]["elements"][0]["name"] == "option_1"
|
||||
assert parser.config["section_1"]["elements"][0]["value"] == "value_1"
|
||||
assert parser.config["section_1"]["elements"][0]["raw"] == "option_1: value_1"
|
||||
|
||||
|
||||
def test_header_parsing(parser):
|
||||
@@ -51,12 +53,27 @@ def test_header_parsing(parser):
|
||||
assert len(header) > 0
|
||||
|
||||
|
||||
def test_collector_parsing(parser):
|
||||
section = "section_2"
|
||||
section_content = list(parser.config[section].keys())
|
||||
coll_name = [name for name in section_content if name.startswith("#_")][0]
|
||||
collector = parser.config[section][coll_name]
|
||||
assert collector is not None
|
||||
assert isinstance(collector, list)
|
||||
assert len(collector) > 0
|
||||
assert "; comment" in collector
|
||||
def test_option_block_parsing(parser):
|
||||
section = "section number 5"
|
||||
option_block = None
|
||||
for element in parser.config[section]["elements"]:
|
||||
if (element["type"] == LineType.OPTION_BLOCK.value and
|
||||
element["name"] == "multi_option"):
|
||||
option_block = element
|
||||
break
|
||||
|
||||
assert option_block is not None, "multi_option block not found"
|
||||
assert option_block["type"] == LineType.OPTION_BLOCK.value
|
||||
assert option_block["name"] == "multi_option"
|
||||
assert option_block["raw"] == "multi_option:"
|
||||
|
||||
expected_values = [
|
||||
"# these are multi-line values",
|
||||
"value_5_1",
|
||||
"value_5_2 ; here is a comment",
|
||||
"value_5_3"
|
||||
]
|
||||
assert option_block["value"] == expected_values, (
|
||||
f"Expected values: {expected_values}, "
|
||||
f"got: {option_block['value']}"
|
||||
)
|
||||
|
||||
@@ -8,6 +8,7 @@
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.constants import LineType
|
||||
from src.simple_config_parser.simple_config_parser import (
|
||||
NoOptionError,
|
||||
NoSectionError,
|
||||
@@ -50,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
|
||||
|
||||
@@ -148,13 +149,11 @@ def test_getfloat_fallback(parser):
|
||||
def test_set_existing_option(parser):
|
||||
parser.set_option("section_1", "new_option", "new_value")
|
||||
assert parser.getval("section_1", "new_option") == "new_value"
|
||||
assert parser.config["section_1"]["new_option"]["_raw"] == "new_option: new_value\n"
|
||||
|
||||
parser.set_option("section_1", "new_option", "new_value_2")
|
||||
assert parser.getval("section_1", "new_option") == "new_value_2"
|
||||
assert (
|
||||
parser.config["section_1"]["new_option"]["_raw"] == "new_option: new_value_2\n"
|
||||
)
|
||||
assert parser.config["section_1"]["elements"][4] is not None
|
||||
assert parser.config["section_1"]["elements"][4]["type"] == LineType.OPTION.value
|
||||
assert parser.config["section_1"]["elements"][4]["name"] == "new_option"
|
||||
assert parser.config["section_1"]["elements"][4]["value"] == "new_value"
|
||||
assert parser.config["section_1"]["elements"][4]["raw"] == "new_option: new_value\n"
|
||||
|
||||
|
||||
def test_set_new_option(parser):
|
||||
@@ -165,12 +164,21 @@ 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",
|
||||
]
|
||||
assert parser.config["section_2"]["array_option"]["_raw"] == "array_option:\n"
|
||||
|
||||
assert parser.config["section_2"]["elements"][1] is not None
|
||||
assert parser.config["section_2"]["elements"][1]["type"] == LineType.OPTION_BLOCK.value
|
||||
assert parser.config["section_2"]["elements"][1]["name"] == "array_option"
|
||||
assert parser.config["section_2"]["elements"][1]["value"] == [
|
||||
"value_1",
|
||||
"value_2",
|
||||
"value_3",
|
||||
]
|
||||
assert parser.config["section_2"]["elements"][1]["raw"] == "array_option:\n"
|
||||
|
||||
|
||||
def test_remove_option(parser):
|
||||
|
||||
@@ -41,16 +41,15 @@ def test_add_section(parser):
|
||||
|
||||
new_section = parser.config["new_section"]
|
||||
assert isinstance(new_section, dict)
|
||||
assert new_section["_raw"] == "[new_section]\n"
|
||||
|
||||
# this should be the collector, added by the parser before
|
||||
# then second section was added
|
||||
assert list(new_section.keys())[-1].startswith("#_")
|
||||
assert "\n" in new_section[list(new_section.keys())[-1]]
|
||||
assert new_section["header"] == "[new_section]\n"
|
||||
assert new_section["elements"] is not None
|
||||
assert new_section["elements"] == []
|
||||
|
||||
new_section2 = parser.config["new_section2"]
|
||||
assert isinstance(new_section2, dict)
|
||||
assert new_section2["_raw"] == "[new_section2]\n"
|
||||
assert new_section2["header"] == "[new_section2]\n"
|
||||
assert new_section2["elements"] is not None
|
||||
assert new_section2["elements"] == []
|
||||
|
||||
|
||||
def test_add_section_duplicate(parser):
|
||||
|
||||
@@ -39,3 +39,81 @@ def test_write_to_file(tmp_path):
|
||||
|
||||
with open(TEST_DATA_PATH, "r") as original, open(tmp_file, "r") as written:
|
||||
assert original.read() == written.read()
|
||||
|
||||
def test_remove_option_and_write(tmp_path):
|
||||
# Setup paths
|
||||
test_dir = BASE_DIR.joinpath("write_tests/remove_option")
|
||||
input_file = test_dir.joinpath("input.cfg")
|
||||
expected_file = test_dir.joinpath("expected.cfg")
|
||||
output_file = Path(tmp_path).joinpath("output.cfg")
|
||||
|
||||
# Read input file and remove option
|
||||
parser = SimpleConfigParser()
|
||||
parser.read_file(input_file)
|
||||
parser.remove_option("section_1", "option_to_remove")
|
||||
|
||||
# Write modified config
|
||||
parser.write_file(output_file)
|
||||
# parser.write_file(test_dir.joinpath("output.cfg"))
|
||||
|
||||
# Compare with expected output
|
||||
with open(expected_file, "r") as expected, open(output_file, "r") as actual:
|
||||
assert expected.read() == actual.read()
|
||||
|
||||
# Additional verification
|
||||
parser2 = SimpleConfigParser()
|
||||
parser2.read_file(output_file)
|
||||
assert not parser2.has_option("section_1", "option_to_remove")
|
||||
|
||||
def test_remove_section_and_write(tmp_path):
|
||||
# Setup paths
|
||||
test_dir = BASE_DIR.joinpath("write_tests/remove_section")
|
||||
input_file = test_dir.joinpath("input.cfg")
|
||||
expected_file = test_dir.joinpath("expected.cfg")
|
||||
output_file = Path(tmp_path).joinpath("output.cfg")
|
||||
|
||||
# Read input file and remove section
|
||||
parser = SimpleConfigParser()
|
||||
parser.read_file(input_file)
|
||||
parser.remove_section("section_to_remove")
|
||||
|
||||
# Write modified config
|
||||
parser.write_file(output_file)
|
||||
# parser.write_file(test_dir.joinpath("output.cfg"))
|
||||
|
||||
# Compare with expected output
|
||||
with open(expected_file, "r") as expected, open(output_file, "r") as actual:
|
||||
assert expected.read() == actual.read()
|
||||
|
||||
# Additional verification
|
||||
parser2 = SimpleConfigParser()
|
||||
parser2.read_file(output_file)
|
||||
assert not parser2.has_section("section_to_remove")
|
||||
assert "section_1" in parser2.get_sections()
|
||||
assert "section_2" in parser2.get_sections()
|
||||
|
||||
def test_add_option_and_write(tmp_path):
|
||||
# Setup paths
|
||||
test_dir = BASE_DIR.joinpath("write_tests/add_option")
|
||||
input_file = test_dir.joinpath("input.cfg")
|
||||
expected_file = test_dir.joinpath("expected.cfg")
|
||||
output_file = Path(tmp_path).joinpath("output.cfg")
|
||||
|
||||
# Read input file and add option
|
||||
parser = SimpleConfigParser()
|
||||
parser.read_file(input_file)
|
||||
parser.set_option("section_1", "new_option", "new_value")
|
||||
|
||||
# Write modified config
|
||||
parser.write_file(output_file)
|
||||
# parser.write_file(test_dir.joinpath("output.cfg"))
|
||||
|
||||
# Compare with expected output
|
||||
with open(expected_file, "r") as expected, open(output_file, "r") as actual:
|
||||
assert expected.read() == actual.read()
|
||||
|
||||
# Additional verification
|
||||
parser2 = SimpleConfigParser()
|
||||
parser2.read_file(output_file)
|
||||
assert parser2.has_option("section_1", "new_option")
|
||||
assert parser2.getval("section_1", "new_option") == "new_value"
|
||||
|
||||
0
kiauh/core/types/__init__.py
Normal file
0
kiauh/core/types/__init__.py
Normal file
29
kiauh/core/types/color.py
Normal file
29
kiauh/core/types/color.py
Normal file
@@ -0,0 +1,29 @@
|
||||
# ======================================================================= #
|
||||
# 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 enum import Enum
|
||||
|
||||
|
||||
class Color(Enum):
|
||||
WHITE = "\033[37m" # white
|
||||
MAGENTA = "\033[35m" # magenta
|
||||
GREEN = "\033[92m" # bright green
|
||||
YELLOW = "\033[93m" # bright yellow
|
||||
RED = "\033[91m" # bright red
|
||||
CYAN = "\033[96m" # bright cyan
|
||||
RST = "\033[0m" # reset format
|
||||
|
||||
def __str__(self):
|
||||
return self.value
|
||||
|
||||
@staticmethod
|
||||
def apply(text: str | int, color: "Color") -> str:
|
||||
"""Apply a given color to a given text string."""
|
||||
return f"{color}{text}{Color.RST}"
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -25,6 +25,7 @@ class ComponentStatus:
|
||||
status: StatusCode
|
||||
owner: str | None = None
|
||||
repo: str | None = None
|
||||
repo_url: str | None = None
|
||||
branch: str = ""
|
||||
local: str | None = None
|
||||
remote: str | None = None
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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,10 +15,10 @@ import textwrap
|
||||
from pathlib import Path
|
||||
from typing import Dict, List, Type
|
||||
|
||||
from core.constants import COLOR_CYAN, COLOR_YELLOW, RESET_FORMAT
|
||||
from core.logger import Logger
|
||||
from core.menus import Option
|
||||
from core.menus.base_menu import BaseMenu
|
||||
from core.types.color import Color
|
||||
from extensions import EXTENSION_ROOT
|
||||
from extensions.base_extension import BaseExtension
|
||||
|
||||
@@ -28,6 +28,8 @@ from extensions.base_extension import BaseExtension
|
||||
class ExtensionsMenu(BaseMenu):
|
||||
def __init__(self, previous_menu: Type[BaseMenu] | None = None):
|
||||
super().__init__()
|
||||
self.title = "Extensions Menu"
|
||||
self.title_color = Color.CYAN
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
self.extensions: Dict[str, BaseExtension] = self.discover_extensions()
|
||||
|
||||
@@ -82,14 +84,9 @@ class ExtensionsMenu(BaseMenu):
|
||||
ExtensionSubmenu(kwargs.get("opt_data"), self.__class__).run()
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = " [ Extensions Menu ] "
|
||||
color = COLOR_CYAN
|
||||
line1 = f"{COLOR_YELLOW}Available Extensions:{RESET_FORMAT}"
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
line1 = Color.apply("Available Extensions:", Color.YELLOW)
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
║ {line1:<62} ║
|
||||
║ ║
|
||||
@@ -112,6 +109,8 @@ class ExtensionSubmenu(BaseMenu):
|
||||
self, extension: BaseExtension, previous_menu: Type[BaseMenu] | None = None
|
||||
):
|
||||
super().__init__()
|
||||
self.title = extension.metadata.get("display_name")
|
||||
self.title_color = Color.YELLOW
|
||||
self.extension = extension
|
||||
self.previous_menu: Type[BaseMenu] | None = previous_menu
|
||||
|
||||
@@ -129,9 +128,6 @@ class ExtensionSubmenu(BaseMenu):
|
||||
self.options["2"] = Option(self.extension.remove_extension)
|
||||
|
||||
def print_menu(self) -> None:
|
||||
header = f" [ {self.extension.metadata.get('display_name')} ] "
|
||||
color = COLOR_YELLOW
|
||||
count = 62 - len(color) - len(RESET_FORMAT)
|
||||
line_width = 53
|
||||
description: List[str] = self.extension.metadata.get("description", [])
|
||||
description_text = Logger.format_content(
|
||||
@@ -142,13 +138,36 @@ class ExtensionSubmenu(BaseMenu):
|
||||
)
|
||||
|
||||
menu = textwrap.dedent(
|
||||
f"""
|
||||
╔═══════════════════════════════════════════════════════╗
|
||||
║ {color}{header:~^{count}}{RESET_FORMAT} ║
|
||||
"""
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
"""
|
||||
)[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: {website}")
|
||||
if repo:
|
||||
links_lines.append(f"- GitHub: {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(
|
||||
"""
|
||||
╟───────────────────────────────────────────────────────╢
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user