fix(common): return default version if no tags exist in get_kiauh_version

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

README_zh.md

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

kiauh/core/menus/repo_select_menu.py

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

kiauh/core/menus/settings_menu.py

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

kiauh/extensions/extensions_menu.py

@@ -143,6 +143,31 @@ class ExtensionSubmenu(BaseMenu):
             """
         )[1:]
         menu += f"{description_text}\n"
+
+        # add links if available
+        website: str = (self.extension.metadata.get("website") or "").strip()
+        repo: str = (self.extension.metadata.get("repo") or "").strip()
+        if website or repo:
+            links_lines: List[str] = ["Links:"]
+            if website:
+                links_lines.append(f"- Website: {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(
             """
             ╟───────────────────────────────────────────────────────╢

kiauh/extensions/octoprint/__init__.py

@@ -0,0 +1,22 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2025 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from pathlib import Path
+
+# Constants
+OP_DEFAULT_PORT = 5000
+
+# OctoPrint instance naming/prefixes
+OP_ENV_PREFIX = "OctoPrint"
+OP_BASEDIR_PREFIX = ".octoprint"
+
+# Service/log filenames
+OP_LOG_NAME = "octoprint.log"
+
+# Files/paths (computed per-instance where applicable)
+OP_SUDOERS_FILE = Path("/etc/sudoers.d/octoprint-shutdown")

kiauh/extensions/octoprint/metadata.json

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

kiauh/extensions/octoprint/octoprint.py

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

kiauh/extensions/octoprint/octoprint_extension.py

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

kiauh/utils/common.py

@@ -42,10 +42,13 @@ from utils.sys_utils import (
 def get_kiauh_version() -> str:
     """
     Helper method to get the current KIAUH version by reading the latest tag
-    :return: string of the latest tag
+    :return: string of the latest tag or a default value if no tags exist
     """
-    lastest_tag: str = get_local_tags(Path(__file__).parent.parent)[-1]
-    return lastest_tag
+    tags = get_local_tags(Path(__file__).parent.parent)
+    if tags:
+        return tags[-1]
+    else:
+        return "v?.?.?"
 
 
 def convert_camelcase_to_kebabcase(name: str) -> str:

kiauh/utils/instance_type.py

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