feat: scaffold OE installer

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

kiauh/components/octoeverywhere/__init__.py

@@ -0,0 +1,29 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from pathlib import Path
+
+# repo
+OE_REPO = "https://github.com/QuinnDamerell/OctoPrint-OctoEverywhere.git"
+
+# directories
+OE_DIR = Path.home().joinpath("octoeverywhere")
+OE_ENV_DIR = Path.home().joinpath("octoeverywhere-env")
+OE_STORE_DIR = OE_DIR.joinpath("octoeverywhere-store")
+
+# files
+OE_REQ_FILE = OE_DIR.joinpath("requirements.txt")
+OE_DEPS_JSON_FILE = OE_DIR.joinpath("moonraker-system-dependencies.json")
+OE_INSTALL_SCRIPT = OE_DIR.joinpath("install.sh")
+OE_UPDATE_SCRIPT = OE_DIR.joinpath("update.sh")
+OE_REMOVE_SCRIPT = OE_DIR.joinpath("uninstall.sh")
+
+# filenames
+OE_CFG_NAME = "octoeverywhere.conf"
+OE_LOG_NAME = "octoeverywhere.log"
+OE_SYS_CFG_NAME = "octoeverywhere-system.cfg"

kiauh/components/octoeverywhere/octoeverywhere.py

@@ -0,0 +1,72 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+from subprocess import CalledProcessError, run
+from typing import List
+
+from components.octoeverywhere import (
+    OE_CFG_NAME,
+    OE_DIR,
+    OE_ENV_DIR,
+    OE_INSTALL_SCRIPT,
+    OE_LOG_NAME,
+    OE_STORE_DIR,
+    OE_SYS_CFG_NAME,
+)
+from core.instance_manager.base_instance import BaseInstance
+from utils.logger import Logger
+
+MODULE_PATH = Path(__file__).resolve().parent
+
+
+# noinspection PyMethodMayBeStatic
+class Octoeverywhere(BaseInstance):
+    @classmethod
+    def blacklist(cls) -> List[str]:
+        return ["None", "mcu"]
+
+    def __init__(self, suffix: str = ""):
+        super().__init__(instance_type=self, suffix=suffix)
+        self.dir: Path = OE_DIR
+        self.env_dir: Path = OE_ENV_DIR
+        self.store_dir: Path = OE_STORE_DIR
+        self._cfg_file = self.cfg_dir.joinpath(OE_CFG_NAME)
+        self._sys_cfg_file = self.cfg_dir.joinpath(OE_SYS_CFG_NAME)
+        self._log = self.log_dir.joinpath(OE_LOG_NAME)
+
+    @property
+    def cfg_file(self) -> Path:
+        return self._cfg_file
+
+    @property
+    def log(self) -> Path:
+        return self._log
+
+    def create(self) -> None:
+        Logger.print_status("Creating OctoEverywhere for Klipper Instance ...")
+
+        try:
+            cmd = f"{OE_INSTALL_SCRIPT} {self.cfg_dir}/moonraker.conf"
+            print(cmd)
+            run(cmd, check=True, shell=True)
+
+        except CalledProcessError as e:
+            Logger.print_error(f"Error creating instance: {e}")
+            raise
+
+    def delete(self) -> None:
+        Logger.print_status("Removing OctoEverywhere for Klipper Instance ...")
+
+        try:
+            cmd = f"OE_REMOVE_SCRIPT {self.cfg_dir}/moonraker.conf"
+            run(cmd, check=True, shell=True)
+        except CalledProcessError as e:
+            Logger.print_error(f"Error deleting instance: {e}")
+            raise

kiauh/components/octoeverywhere/octoeverywhere_setup.py

@@ -0,0 +1,235 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+import json
+import shutil
+from typing import List
+
+from components.moonraker.moonraker import Moonraker
+from components.octoeverywhere import (
+    OE_DEPS_JSON_FILE,
+    OE_DIR,
+    OE_ENV_DIR,
+    OE_INSTALL_SCRIPT,
+    OE_LOG_NAME,
+    OE_REPO,
+    OE_REQ_FILE,
+    OE_SYS_CFG_NAME,
+)
+from components.octoeverywhere.octoeverywhere import Octoeverywhere
+from core.instance_manager.instance_manager import InstanceManager
+from utils.common import check_install_dependencies, moonraker_exists
+from utils.config_utils import (
+    add_config_section,
+    remove_config_section,
+)
+from utils.fs_utils import remove_file
+from utils.git_utils import git_clone_wrapper, git_pull_wrapper
+from utils.input_utils import get_confirm
+from utils.logger import DialogType, Logger
+from utils.sys_utils import (
+    cmd_sysctl_manage,
+    create_python_venv,
+    install_python_requirements,
+    parse_packages_from_file,
+)
+
+
+def install_octoeverywhere() -> None:
+    Logger.print_status("Installing OctoEverywhere for Klipper ...")
+
+    # check if moonraker is installed. if not, notify the user and exit
+    if not moonraker_exists():
+        return
+
+    # if obico is already installed, ask if the user wants to repair an
+    # incomplete installation or link to the obico server
+    oe_im = InstanceManager(Octoeverywhere)
+    oe_instances: List[Octoeverywhere] = oe_im.instances
+    if oe_instances:
+        Logger.print_dialog(
+            DialogType.INFO,
+            [
+                "OctoEverywhere is already installed!",
+                "It is save to run the installer again to link your "
+                "printer or repair any issues.",
+            ],
+            end="",
+        )
+        if not get_confirm("Re-run OctoEverywhere installation?"):
+            Logger.print_info("Exiting OctoEverywhere for Klipper installation ...")
+            return
+        else:
+            Logger.print_status("Re-Installing OctoEverywhere for Klipper ...")
+
+    mr_im = InstanceManager(Moonraker)
+    mr_instances: List[Moonraker] = mr_im.instances
+
+    mr_names = [f"● {moonraker.data_dir_name}" for moonraker in mr_instances]
+    if len(mr_names) > 1:
+        Logger.print_dialog(
+            DialogType.INFO,
+            [
+                "The following Moonraker instances were found:",
+                *mr_names,
+                "\n\n",
+                "The setup will apply the same names to OctoEverywhere!",
+            ],
+            end="",
+        )
+
+    if not get_confirm(
+        "Continue OctoEverywhere for Klipper installation?",
+        default_choice=True,
+        allow_go_back=True,
+    ):
+        Logger.print_info("Exiting OctoEverywhere for Klipper installation ...")
+        return
+
+    try:
+        git_clone_wrapper(OE_REPO, OE_DIR)
+        install_oe_dependencies()
+
+        for moonraker in mr_instances:
+            oe_im.current_instance = Octoeverywhere(suffix=moonraker.suffix)
+            oe_im.create_instance()
+            oe_im.enable_instance()
+            oe_im.start_instance()
+
+        cmd_sysctl_manage("daemon-reload")
+
+        # TODO: probably done by OE already?
+        # add to moonraker update manager
+        patch_moonraker_conf(mr_instances)
+        mr_im.restart_all_instance()
+
+        Logger.print_dialog(
+            DialogType.SUCCESS,
+            ["OctoEverywhere for Klipper successfully installed!"],
+            center_content=True,
+        )
+
+    except Exception as e:
+        Logger.print_error(
+            f"Error during OctoEverywhere for Klipper installation:\n{e}"
+        )
+
+
+def update_octoeverywhere() -> None:
+    Logger.print_status("Updating OctoEverywhere for Klipper ...")
+    try:
+        oe_im = InstanceManager(Octoeverywhere)
+        oe_im.stop_all_instance()
+
+        git_pull_wrapper(OE_REPO, OE_DIR)
+        install_oe_dependencies()
+
+        oe_im.start_all_instance()
+        Logger.print_ok("OctoEverywhere for Klipper successfully updated!")
+
+    except Exception as e:
+        Logger.print_error(f"Error during OctoEverywhere for Klipper update:\n{e}")
+
+
+def remove_octoeverywhere() -> None:
+    Logger.print_status("Removing OctoEverywhere for Klipper ...")
+    mr_im = InstanceManager(Moonraker)
+    mr_instances: List[Moonraker] = mr_im.instances
+    ob_im = InstanceManager(Octoeverywhere)
+    ob_instances: List[Octoeverywhere] = ob_im.instances
+
+    try:
+        remove_oe_instances(ob_im, ob_instances)
+        remove_oe_dir()
+        remove_oe_env()
+        remove_config_section(f"include {OE_SYS_CFG_NAME}", mr_instances)
+        delete_oe_logs(ob_instances)
+        Logger.print_dialog(
+            DialogType.SUCCESS,
+            ["OctoEverywhere for Klipper successfully removed!"],
+            center_content=True,
+        )
+
+    except Exception as e:
+        Logger.print_error(f"Error during OctoEverywhere for Klipper removal:\n{e}")
+
+
+def install_oe_dependencies() -> None:
+    oe_deps = []
+    if OE_DEPS_JSON_FILE.exists():
+        with open(OE_DEPS_JSON_FILE, "r") as deps:
+            oe_deps = json.load(deps).get("debian", [])
+    elif OE_INSTALL_SCRIPT.exists():
+        oe_deps = parse_packages_from_file(OE_INSTALL_SCRIPT)
+
+    if not oe_deps:
+        raise ValueError("Error reading OctoEverywhere dependencies!")
+
+    check_install_dependencies(oe_deps)
+
+    # create virtualenv
+    create_python_venv(OE_ENV_DIR)
+    install_python_requirements(OE_ENV_DIR, OE_REQ_FILE)
+
+
+def patch_moonraker_conf(instances: List[Moonraker]) -> None:
+    add_config_section(section=f"include {OE_SYS_CFG_NAME}", instances=instances)
+
+
+def remove_oe_instances(
+    instance_manager: InstanceManager,
+    instance_list: List[Octoeverywhere],
+) -> None:
+    if not instance_list:
+        Logger.print_info("No OctoEverywhere instances found. Skipped ...")
+        return
+
+    for instance in instance_list:
+        Logger.print_status(f"Removing instance {instance.get_service_file_name()} ...")
+        instance_manager.current_instance = instance
+        instance_manager.stop_instance()
+        instance_manager.disable_instance()
+        instance_manager.delete_instance()
+
+    cmd_sysctl_manage("daemon-reload")
+
+
+def remove_oe_dir() -> None:
+    if not OE_DIR.exists():
+        Logger.print_info(f"'{OE_DIR}' does not exist. Skipped ...")
+        return
+
+    try:
+        shutil.rmtree(OE_DIR)
+    except OSError as e:
+        Logger.print_error(f"Unable to delete '{OE_DIR}':\n{e}")
+
+
+def remove_oe_env() -> None:
+    if not OE_ENV_DIR.exists():
+        Logger.print_info(f"'{OE_ENV_DIR}' does not exist. Skipped ...")
+        return
+
+    try:
+        shutil.rmtree(OE_ENV_DIR)
+    except OSError as e:
+        Logger.print_error(f"Unable to delete '{OE_ENV_DIR}':\n{e}")
+
+
+def delete_oe_logs(instances: List[Octoeverywhere]) -> None:
+    Logger.print_status("Removing OctoEverywhere logs ...")
+    all_logfiles = []
+    for instance in instances:
+        all_logfiles = list(instance.log_dir.glob(f"{OE_LOG_NAME}*"))
+    if not all_logfiles:
+        Logger.print_info("No OctoEverywhere logs found. Skipped ...")
+        return
+
+    for log in all_logfiles:
+        Logger.print_status(f"Remove '{log}'")
+        remove_file(log)

kiauh/core/menus/install_menu.py

@@ -15,6 +15,7 @@ from components.klipper import klipper_setup
 from components.klipperscreen.klipperscreen import install_klipperscreen
 from components.mobileraker.mobileraker import install_mobileraker
 from components.moonraker import moonraker_setup
+from components.octoeverywhere.octoeverywhere_setup import install_octoeverywhere
 from components.webui_client import client_setup
 from components.webui_client.client_config import client_config_setup
 from components.webui_client.fluidd_data import FluiddData
@@ -49,6 +50,7 @@ class InstallMenu(BaseMenu):
             "7": Option(method=self.install_klipperscreen, menu=False),
             "8": Option(method=self.install_mobileraker, menu=False),
             "9": Option(method=self.install_crowsnest, menu=False),
+            "10": Option(method=self.install_octoeverywhere, menu=False),
         }
 
     def print_menu(self):
@@ -69,8 +71,8 @@ class InstallMenu(BaseMenu):
             ║  4) [Fluidd]              │ Webcam Streamer:          ║
             ║                           │  9) [Crowsnest]           ║
             ║ Client-Config:            │                           ║
-            ║  5) [Mainsail-Config]     │                           ║
+            ║  5) [Mainsail-Config]     │ Remote Access:            ║
-            ║  6) [Fluidd-Config]       │                           ║
+            ║  6) [Fluidd-Config]       │ 10) [OctoEverywhere]      ║
             ║                           │                           ║
             ╟───────────────────────────┴───────────────────────────╢
             """
@@ -103,3 +105,6 @@ class InstallMenu(BaseMenu):
 
     def install_crowsnest(self, **kwargs):
         install_crowsnest()
+
+    def install_octoeverywhere(self, **kwargs):
+        install_octoeverywhere()

kiauh/core/menus/main_menu.py

@@ -54,7 +54,7 @@ class MainMenu(BaseMenu):
 
         self.kl_status = self.kl_repo = self.mr_status = self.mr_repo = ""
         self.ms_status = self.fl_status = self.ks_status = self.mb_status = ""
-        self.cn_status = self.cc_status = ""
+        self.cn_status = self.cc_status = self.oe_status = ""
         self.init_status()
 
     def set_previous_menu(self, previous_menu: Optional[Type[BaseMenu]]) -> None:
@@ -74,12 +74,12 @@ class MainMenu(BaseMenu):
         }
 
     def init_status(self) -> None:
-        status_vars = ["kl", "mr", "ms", "fl", "ks", "mb", "cn"]
+        status_vars = ["kl", "mr", "ms", "fl", "ks", "mb", "cn", "oe"]
         for var in status_vars:
             setattr(
                 self,
                 f"{var}_status",
-                f"{COLOR_RED}Not installed!{RESET_FORMAT}",
+                f"{COLOR_RED}Not installed{RESET_FORMAT}",
             )
 
     def fetch_status(self) -> None:
@@ -141,6 +141,7 @@ class MainMenu(BaseMenu):
             ║                  │                                    ║
             ║ Community:       │   KlipperScreen: {self.ks_status:<{pad2}} ║
             ║  E) [Extensions] │     Mobileraker: {self.mb_status:<{pad2}} ║
+            ║                  │  OctoEverywhere: {self.oe_status:<{pad2}} ║
             ║                  │       Crowsnest: {self.cn_status:<{pad2}} ║
             ╟──────────────────┼────────────────────────────────────╢
             ║ {footer1:^25} │ {footer2:^43} ║

kiauh/core/menus/remove_menu.py

@@ -17,6 +17,7 @@ from components.mobileraker.mobileraker import remove_mobileraker
 from components.moonraker.menus.moonraker_remove_menu import (
     MoonrakerRemoveMenu,
 )
+from components.octoeverywhere.octoeverywhere_setup import remove_octoeverywhere
 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
@@ -48,6 +49,7 @@ class RemoveMenu(BaseMenu):
             "5": Option(method=self.remove_klipperscreen, menu=True),
             "6": Option(method=self.remove_mobileraker, menu=True),
             "7": Option(method=self.remove_crowsnest, menu=True),
+            "8": Option(method=self.remove_octoeverywhere, menu=True),
         }
 
     def print_menu(self):
@@ -61,14 +63,16 @@ class RemoveMenu(BaseMenu):
             ╟───────────────────────────────────────────────────────╢
             ║ INFO: Configurations and/or any backups will be kept! ║
             ╟───────────────────────────┬───────────────────────────╢
-            ║ Firmware & API:           │ Touchscreen GUI:          ║
+            ║ Firmware & API:           │ Android / iOS:            ║
-            ║  1) [Klipper]             │  5) [KlipperScreen]       ║
+            ║  1) [Klipper]             │  6) [Mobileraker]         ║
             ║  2) [Moonraker]           │                           ║
-            ║                           │ Android / iOS:            ║
+            ║                           │ Webcam Streamer:          ║
-            ║ Klipper Webinterface:     │  6) [Mobileraker]         ║
+            ║ Klipper Webinterface:     │  7) [Crowsnest]           ║
             ║  3) [Mainsail]            │                           ║
-            ║  4) [Fluidd]              │ Webcam Streamer:          ║
+            ║  4) [Fluidd]              │ Remote Access:            ║
-            ║                           │  7) [Crowsnest]           ║
+            ║                           │  8) [OctoEverywhere]      ║
+            ║ Touchscreen GUI:          │                           ║
+            ║  5) [KlipperScreen]       │                           ║
             ╟───────────────────────────┴───────────────────────────╢
             """
         )[1:]
@@ -94,3 +98,6 @@ class RemoveMenu(BaseMenu):
 
     def remove_crowsnest(self, **kwargs):
         remove_crowsnest()
+
+    def remove_octoeverywhere(self, **kwargs):
+        remove_octoeverywhere()