refactor(KIAUH): full refactor of client and client-config installation

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

kiauh/components/webui_client/__init__.py

@@ -0,0 +1,77 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+from typing import Literal, TypedDict, Set
+
+from core.backup_manager import BACKUP_ROOT_DIR
+
+MODULE_PATH = Path(__file__).resolve().parent
+
+###########
+# MAINSAIL
+###########
+MAINSAIL_DIR = Path.home().joinpath("mainsail")
+MAINSAIL_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("mainsail-backups")
+MAINSAIL_CONFIG_DIR = Path.home().joinpath("mainsail-config")
+MAINSAIL_CONFIG_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("mainsail-config-backups")
+MAINSAIL_CONFIG_REPO_URL = "https://github.com/mainsail-crew/mainsail-config.git"
+MAINSAIL_CONFIG_JSON = MAINSAIL_DIR.joinpath("config.json")
+MAINSAIL_URL = (
+    "https://github.com/mainsail-crew/mainsail/releases/latest/download/mainsail.zip"
+)
+MAINSAIL_PRE_RLS_URL = (
+    "https://github.com/mainsail-crew/mainsail/releases/download/%TAG%/mainsail.zip"
+)
+MAINSAIL_TAGS_URL = "https://api.github.com/repos/mainsail-crew/mainsail/tags"
+
+#########
+# FLUIDD
+#########
+FLUIDD_DIR = Path.home().joinpath("fluidd")
+FLUIDD_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("fluidd-backups")
+FLUIDD_CONFIG_DIR = Path.home().joinpath("fluidd-config")
+FLUIDD_CONFIG_BACKUP_DIR = BACKUP_ROOT_DIR.joinpath("fluidd-config-backups")
+FLUIDD_CONFIG_REPO_URL = "https://github.com/fluidd-core/fluidd-config.git"
+FLUIDD_URL = "https://github.com/fluidd-core/fluidd/releases/latest/download/fluidd.zip"
+FLUIDD_PRE_RLS_URL = (
+    "https://github.com/fluidd-core/fluidd/releases/download/%TAG%/fluidd.zip"
+)
+FLUIDD_TAGS_URL = "https://api.github.com/repos/fluidd-core/fluidd/tags"
+
+ClientName = Literal["mainsail", "fluidd"]
+ClientConfigName = Literal["mainsail-config", "fluidd-config"]
+
+
+class ClientData(TypedDict):
+    name: ClientName
+    display_name: str
+    dir: Path
+    backup_dir: Path
+    url: str
+    pre_release_url: str
+    tags_url: str
+    remote_mode: bool  # required only for Mainsail
+    mr_conf_repo: str
+    mr_conf_path: str
+    client_config: "ClientConfigData"
+
+
+class ClientConfigData(TypedDict):
+    name: ClientConfigName
+    display_name: str
+    cfg_filename: str
+    dir: Path
+    backup_dir: Path
+    url: str
+    printer_cfg_section: str
+    mr_conf_path: str
+    mr_conf_origin: str

kiauh/components/webui_client/client_config/client_config_remove.py

@@ -0,0 +1,64 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+
+import shutil
+import subprocess
+from typing import List
+
+from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from components.webui_client import ClientConfigData
+from core.instance_manager.instance_manager import InstanceManager
+from utils.filesystem_utils import remove_file, remove_config_section
+from utils.logger import Logger
+
+
+def run_client_config_removal(
+    client_config: ClientConfigData,
+    remove_moonraker_conf_section: bool,
+    remove_printer_cfg_include: bool,
+    kl_instances: List[Klipper],
+    mr_instances: List[Moonraker],
+) -> None:
+    remove_client_config_dir(client_config)
+    remove_client_config_symlink(client_config)
+    if remove_moonraker_conf_section:
+        remove_config_section(
+            f"update_manager {client_config.get('name')}", mr_instances
+        )
+    if remove_printer_cfg_include:
+        remove_config_section(client_config.get("printer_cfg_section"), kl_instances)
+
+
+def remove_client_config_dir(client_config: ClientConfigData) -> None:
+    Logger.print_status(f"Removing {client_config.get('name')} ...")
+    client_config_dir = client_config.get("dir")
+    if not client_config_dir.exists():
+        Logger.print_info(f"'{client_config_dir}' does not exist. Skipping ...")
+        return
+
+    try:
+        shutil.rmtree(client_config_dir)
+    except OSError as e:
+        Logger.print_error(f"Unable to delete '{client_config_dir}':\n{e}")
+
+
+def remove_client_config_symlink(client_config: ClientConfigData) -> None:
+    Logger.print_status(f"Removing {client_config.get('cfg_filename')} symlinks ...")
+    im = InstanceManager(Klipper)
+    instances: List[Klipper] = im.instances
+    for instance in instances:
+        Logger.print_status(f"Removing symlink from '{instance.cfg_file}' ...")
+        try:
+            remove_file(instance.cfg_dir.joinpath(client_config.get("cfg_filename")))
+        except subprocess.CalledProcessError:
+            Logger.print_error("Failed to remove symlink!")

kiauh/components/webui_client/client_config/client_config_setup.py

@@ -0,0 +1,145 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import shutil
+import subprocess
+from pathlib import Path
+from typing import List, get_args
+
+from kiauh import KIAUH_CFG
+from components.klipper.klipper import Klipper
+from components.moonraker.moonraker import Moonraker
+from components.webui_client import ClientConfigData, ClientName, ClientData
+from components.webui_client.client_dialogs import print_client_already_installed_dialog
+from components.webui_client.client_utils import (
+    load_client_data,
+    backup_client_config_data,
+)
+from core.config_manager.config_manager import ConfigManager
+
+from core.instance_manager.instance_manager import InstanceManager
+from core.repo_manager.repo_manager import RepoManager
+from utils.filesystem_utils import (
+    create_symlink,
+    add_config_section,
+)
+from utils.input_utils import get_confirm
+from utils.logger import Logger
+
+
+def install_client_config(client_name: ClientName) -> None:
+    client: ClientData = load_client_data(client_name)
+    client_config: ClientConfigData = client.get("client_config")
+    d_name = client_config.get("display_name")
+
+    if check_existing_client_config_install(client_name):
+        Logger.print_info("Another Client-Config is already installed! Skipped ...")
+        return
+
+    if client_config.get("dir").exists():
+        print_client_already_installed_dialog(d_name)
+        if get_confirm(f"Re-install {d_name}?", allow_go_back=True):
+            shutil.rmtree(client_config.get("dir"))
+        else:
+            return
+
+    mr_im = InstanceManager(Moonraker)
+    mr_instances: List[Moonraker] = mr_im.instances
+    kl_im = InstanceManager(Klipper)
+    kl_instances = kl_im.instances
+
+    try:
+        download_client_config(client_config)
+        create_client_config_symlink(client_config, kl_instances)
+        add_config_section(
+            section=f"update_manager {client_config.get('name')}",
+            instances=mr_instances,
+            options=[
+                ("type", "git_repo"),
+                ("primary_branch", "master"),
+                ("path", client_config.get("mr_conf_path")),
+                ("origin", client_config.get("mr_conf_origin")),
+                ("managed_services", "klipper"),
+            ],
+        )
+        add_config_section(client_config.get("printer_cfg_section"), kl_instances)
+        kl_im.restart_all_instance()
+
+    except Exception as e:
+        Logger.print_error(f"{d_name} installation failed!\n{e}")
+        return
+
+    Logger.print_ok(f"{d_name} installation complete!", start="\n")
+
+
+def check_existing_client_config_install(client_name: ClientName) -> bool:
+    # check if any other client-configs are present
+    # as they can conflict each other, or are at least
+    # redundant to have, so we skip the installation
+    client_list = list(get_args(ClientName))
+    client_list.remove(client_name)
+    for c in client_list:
+        c_data: ClientData = load_client_data(c)
+        c_config_data: ClientConfigData = c_data.get("client_config")
+        if c_config_data.get("dir").exists():
+            return True
+
+    return False
+
+
+def download_client_config(client_config: ClientConfigData) -> None:
+    try:
+        Logger.print_status(f"Downloading {client_config.get('display_name')} ...")
+        rm = RepoManager(
+            client_config.get("url"), target_dir=str(client_config.get("dir"))
+        )
+        rm.clone_repo()
+    except Exception:
+        Logger.print_error(f"Downloading {client_config.get('display_name')} failed!")
+        raise
+
+
+def update_client_config(client: ClientData) -> None:
+    client_config: ClientConfigData = client.get("client_config")
+
+    Logger.print_status(f"Updating {client_config.get('display_name')} ...")
+
+    cm = ConfigManager(cfg_file=KIAUH_CFG)
+    if cm.get_value("kiauh", "backup_before_update"):
+        backup_client_config_data(client)
+
+    repo_manager = RepoManager(
+        repo=client_config.get("url"),
+        branch="master",
+        target_dir=str(client_config.get("dir")),
+    )
+    repo_manager.pull_repo()
+
+    Logger.print_ok(f"Successfully updated {client_config.get('display_name')}.")
+    Logger.print_warn("Remember to restart Klipper to reload the configurations!")
+
+
+def create_client_config_symlink(
+    client_config: ClientConfigData, klipper_instances: List[Klipper] = None
+) -> None:
+    if klipper_instances is None:
+        kl_im = InstanceManager(Klipper)
+        klipper_instances = kl_im.instances
+
+    Logger.print_status(f"Create symlink for {client_config.get('cfg_filename')} ...")
+    source = Path(client_config.get("dir"), client_config.get("cfg_filename"))
+    for instance in klipper_instances:
+        target = instance.cfg_dir
+        Logger.print_status(f"Linking {source} to {target}")
+        try:
+            create_symlink(source, target)
+        except subprocess.CalledProcessError:
+            Logger.print_error("Creating symlink failed!")

kiauh/components/webui_client/client_dialogs.py

@@ -0,0 +1,111 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import textwrap
+from typing import List
+
+from components.webui_client import ClientData
+from core.menus.base_menu import print_back_footer
+from utils.constants import RESET_FORMAT, COLOR_YELLOW, COLOR_CYAN
+
+
+def print_moonraker_not_found_dialog():
+    line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
+    line2 = f"{COLOR_YELLOW}No local Moonraker installation was found!{RESET_FORMAT}"
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        | {line1:<63}|
+        | {line2:<63}|
+        |-------------------------------------------------------|
+        | It is possible to install Mainsail without a local    |
+        | Moonraker installation. If you continue, you need to  |
+        | make sure, that Moonraker is installed on another     |
+        | machine in your network. Otherwise Mainsail will NOT  |
+        | work correctly.                                       |
+        """
+    )[1:]
+
+    print(dialog, end="")
+    print_back_footer()
+
+
+def print_client_already_installed_dialog(name: str):
+    line1 = f"{COLOR_YELLOW}WARNING:{RESET_FORMAT}"
+    line2 = f"{COLOR_YELLOW}{name} seems to be already installed!{RESET_FORMAT}"
+    line3 = f"If you continue, your current {name}"
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        | {line1:<63}|
+        | {line2:<63}|
+        |-------------------------------------------------------|
+        | {line3:<54}|
+        | installation will be overwritten.                     |
+        """
+    )[1:]
+
+    print(dialog, end="")
+    print_back_footer()
+
+
+def print_client_port_select_dialog(name: str, port: str, ports_in_use: List[str]):
+    port = f"{COLOR_CYAN}{port}{RESET_FORMAT}"
+    line1 = f"Please select the port, {name} should be served on."
+    line2 = f"In case you need {name} to be served on a specific"
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        | {line1:<54}|
+        | If you are unsure what to select, hit Enter to apply  |
+        | the suggested value of: {port:38} |
+        |                                                       |
+        | {line2:<54}|
+        | port, you can set it now. Make sure the port is not   |
+        | used by any other application on your system!         |
+        \\=======================================================/
+        """
+    )[1:]
+
+    if len(ports_in_use) > 0:
+        dialog += "|-------------------------------------------------------|\n"
+        dialog += "| The following ports were found to be in use already:  |\n"
+        for port in ports_in_use:
+            port = f"{COLOR_CYAN}● {port}{RESET_FORMAT}"
+            dialog += f"|  {port:60}  |\n"
+
+    dialog += "\\=======================================================/\n"
+
+    print(dialog, end="")
+
+
+def print_install_client_config_dialog(client: ClientData):
+    name = client.get("display_name")
+    url = client.get("client_config").get("url").replace(".git", "")
+    line1 = f"have {name} fully functional and working."
+    line2 = f"The recommended macros for {name} can be seen here:"
+    dialog = textwrap.dedent(
+        f"""
+        /=======================================================\\
+        | It is recommended to use special macros in order to   |
+        | {line1:<54}|
+        |                                                       |
+        | {line2:<54}|
+        | {url:<54}|
+        |                                                       |
+        | If you already use these macros skip this step.       |
+        | Otherwise you should consider to answer with 'Y' to   |
+        | download the recommended macros.                      |
+        \\=======================================================/
+        """
+    )[1:]
+
+    print(dialog, end="")

kiauh/components/webui_client/client_remove.py

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

kiauh/components/webui_client/client_setup.py

@@ -0,0 +1,207 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+from pathlib import Path
+from typing import List
+
+from components.klipper.klipper import Klipper
+from components.webui_client import (
+    ClientName,
+    ClientData,
+)
+
+from components.moonraker.moonraker import Moonraker
+from components.webui_client.client_config.client_config_setup import (
+    install_client_config,
+    check_existing_client_config_install,
+)
+from components.webui_client.client_dialogs import (
+    print_moonraker_not_found_dialog,
+    print_client_port_select_dialog,
+    print_install_client_config_dialog,
+)
+from components.webui_client.client_utils import (
+    backup_mainsail_config_json,
+    restore_mainsail_config_json,
+    enable_mainsail_remotemode,
+    symlink_webui_nginx_log,
+    load_client_data,
+)
+from core.config_manager.config_manager import ConfigManager
+from core.instance_manager.instance_manager import InstanceManager
+from kiauh import KIAUH_CFG
+from utils import NGINX_SITES_AVAILABLE, NGINX_SITES_ENABLED
+from utils.common import check_install_dependencies
+from utils.filesystem_utils import (
+    unzip,
+    copy_upstream_nginx_cfg,
+    copy_common_vars_nginx_cfg,
+    create_nginx_cfg,
+    create_symlink,
+    remove_file,
+    add_config_section,
+    read_ports_from_nginx_configs,
+    is_valid_port,
+    get_next_free_port,
+)
+from utils.input_utils import get_confirm, get_number_input
+from utils.logger import Logger
+from utils.system_utils import (
+    download_file,
+    set_nginx_permissions,
+    get_ipv4_addr,
+    control_systemd_service,
+)
+
+
+def install_client(client_name: ClientName) -> None:
+    client: ClientData = load_client_data(client_name)
+    d_name = client.get("display_name")
+
+    if client is None:
+        Logger.print_error("Missing parameter client_name!")
+        return
+
+    if client.get("dir").exists():
+        Logger.print_info(
+            f"{client.get('display_name')} seems to be already installed! Skipped ..."
+        )
+        return
+
+    mr_im = InstanceManager(Moonraker)
+    mr_instances: List[Moonraker] = mr_im.instances
+
+    enable_remotemode = False
+    if not mr_instances:
+        print_moonraker_not_found_dialog()
+        if not get_confirm(
+            f"Continue {d_name} installation?",
+            allow_go_back=True,
+        ):
+            return
+
+    # if moonraker is not installed or multiple instances
+    # are installed we enable mainsails remote mode
+    if client.get("remote_mode") and not mr_instances or len(mr_instances) > 1:
+        enable_remotemode = True
+
+    kl_im = InstanceManager(Klipper)
+    kl_instances = kl_im.instances
+    install_client_cfg = False
+    client_config = client.get("client_config")
+    if (
+        kl_instances
+        and not client_config.get("dir").exists()
+        and not check_existing_client_config_install(client.get("name"))
+    ):
+        print_install_client_config_dialog(client)
+        question = f"Download the recommended {client_config.get('display_name')}?"
+        install_client_cfg = get_confirm(question, allow_go_back=False)
+
+    cm = ConfigManager(cfg_file=KIAUH_CFG)
+    client_port = cm.get_value(client.get("name"), "port")
+    ports_in_use = read_ports_from_nginx_configs()
+
+    # check if configured port is a valid number and not in use already
+    valid_port = is_valid_port(client_port, ports_in_use)
+    while not valid_port:
+        next_port = get_next_free_port(ports_in_use)
+        print_client_port_select_dialog(d_name, next_port, ports_in_use)
+        client_port = str(
+            get_number_input(
+                f"Configure {d_name} for port",
+                min_count=int(next_port),
+                default=next_port,
+            )
+        )
+        valid_port = is_valid_port(client_port, ports_in_use)
+
+    check_install_dependencies(["nginx"])
+
+    try:
+        download_client(client)
+        if enable_remotemode and client.get("name") == "mainsail":
+            enable_mainsail_remotemode()
+        if mr_instances:
+            add_config_section(
+                section=f"update_manager {client.get('name')}",
+                instances=mr_instances,
+                options=[
+                    ("type", "web"),
+                    ("channel", "stable"),
+                    ("repo", client.get("mr_conf_repo")),
+                    ("path", client.get("mr_conf_path")),
+                ],
+            )
+            mr_im.restart_all_instance()
+        if install_client_cfg and kl_instances:
+            install_client_config(client.get("name"))
+
+        copy_upstream_nginx_cfg()
+        copy_common_vars_nginx_cfg()
+        create_client_nginx_cfg(client, client_port)
+        if kl_instances:
+            symlink_webui_nginx_log(kl_instances)
+        control_systemd_service("nginx", "restart")
+
+    except Exception as e:
+        Logger.print_error(f"{d_name} installation failed!\n{e}")
+        return
+
+    log = f"Open {d_name} now on: http://{get_ipv4_addr()}:{client_port}"
+    Logger.print_ok(f"{d_name} installation complete!", start="\n")
+    Logger.print_ok(log, prefix=False, end="\n\n")
+
+
+def download_client(client: ClientData) -> None:
+    zipfile = f"{client.get('name').lower()}.zip"
+    target = Path().home().joinpath(zipfile)
+    try:
+        Logger.print_status(f"Downloading {zipfile} ...")
+        download_file(client.get("url"), target, True)
+        Logger.print_ok("Download complete!")
+
+        Logger.print_status(f"Extracting {zipfile} ...")
+        unzip(target, client.get("dir"))
+        target.unlink(missing_ok=True)
+        Logger.print_ok("OK!")
+
+    except Exception:
+        Logger.print_error(f"Downloading {zipfile} failed!")
+        raise
+
+
+def update_client(client: ClientData) -> None:
+    Logger.print_status(f"Updating {client.get('display_name')} ...")
+    if client.get("name") == "mainsail":
+        backup_mainsail_config_json(is_temp=True)
+
+    download_client(client)
+
+    if client.get("name") == "mainsail":
+        restore_mainsail_config_json()
+
+
+def create_client_nginx_cfg(client: ClientData, port: int) -> None:
+    d_name = client.get("display_name")
+    root_dir = client.get("dir")
+    source = NGINX_SITES_AVAILABLE.joinpath(client.get("name"))
+    target = NGINX_SITES_ENABLED.joinpath(client.get("name"))
+    try:
+        Logger.print_status(f"Creating NGINX config for {d_name} ...")
+        remove_file(Path("/etc/nginx/sites-enabled/default"), True)
+        create_nginx_cfg(client.get("name"), port, root_dir)
+        create_symlink(source, target, True)
+        set_nginx_permissions()
+        Logger.print_ok(f"NGINX config for {d_name} successfully created.")
+    except Exception:
+        Logger.print_error(f"Creating NGINX config for {d_name} failed!")
+        raise

kiauh/components/webui_client/client_utils.py

@@ -0,0 +1,237 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import json
+import shutil
+from json import JSONDecodeError
+from pathlib import Path
+from typing import List, Optional, Dict, Literal, Union
+
+import urllib.request
+
+from components.klipper.klipper import Klipper
+from components.webui_client import (
+    MAINSAIL_CONFIG_JSON,
+    MAINSAIL_DIR,
+    MAINSAIL_BACKUP_DIR,
+    FLUIDD_PRE_RLS_URL,
+    FLUIDD_BACKUP_DIR,
+    FLUIDD_URL,
+    FLUIDD_DIR,
+    ClientData,
+    FLUIDD_CONFIG_REPO_URL,
+    FLUIDD_CONFIG_DIR,
+    ClientConfigData,
+    MAINSAIL_PRE_RLS_URL,
+    MAINSAIL_URL,
+    MAINSAIL_CONFIG_REPO_URL,
+    MAINSAIL_CONFIG_DIR,
+    ClientName,
+    MAINSAIL_TAGS_URL,
+    FLUIDD_TAGS_URL,
+    FLUIDD_CONFIG_BACKUP_DIR,
+    MAINSAIL_CONFIG_BACKUP_DIR,
+)
+from core.backup_manager.backup_manager import BackupManager
+from core.repo_manager.repo_manager import RepoManager
+from utils import NGINX_SITES_AVAILABLE, NGINX_CONFD
+from utils.common import get_install_status_webui, get_install_status_common
+from utils.constants import COLOR_CYAN, RESET_FORMAT, COLOR_YELLOW
+from utils.logger import Logger
+
+
+def load_client_data(client_name: ClientName) -> Optional[ClientData]:
+    client_data = None
+
+    if client_name == "mainsail":
+        client_config_data = ClientConfigData(
+            name="mainsail-config",
+            display_name="Mainsail-Config",
+            cfg_filename="mainsail.cfg",
+            dir=MAINSAIL_CONFIG_DIR,
+            backup_dir=MAINSAIL_CONFIG_BACKUP_DIR,
+            url=MAINSAIL_CONFIG_REPO_URL,
+            printer_cfg_section="include mainsail.cfg",
+            mr_conf_path="~/mainsail-config",
+            mr_conf_origin=MAINSAIL_CONFIG_REPO_URL,
+        )
+        client_data = ClientData(
+            name=client_name,
+            display_name=client_name.capitalize(),
+            dir=MAINSAIL_DIR,
+            backup_dir=MAINSAIL_BACKUP_DIR,
+            url=MAINSAIL_URL,
+            pre_release_url=MAINSAIL_PRE_RLS_URL,
+            tags_url=MAINSAIL_TAGS_URL,
+            remote_mode=True,
+            mr_conf_repo="mainsail-crew/mainsail",
+            mr_conf_path="~/mainsail",
+            client_config=client_config_data,
+        )
+    elif client_name == "fluidd":
+        client_config_data = ClientConfigData(
+            name="fluidd-config",
+            display_name="Fluidd-Config",
+            cfg_filename="fluidd.cfg",
+            dir=FLUIDD_CONFIG_DIR,
+            backup_dir=FLUIDD_CONFIG_BACKUP_DIR,
+            url=FLUIDD_CONFIG_REPO_URL,
+            printer_cfg_section="include fluidd.cfg",
+            mr_conf_path="~/fluidd-config",
+            mr_conf_origin=FLUIDD_CONFIG_REPO_URL,
+        )
+        client_data = ClientData(
+            name=client_name,
+            display_name=client_name.capitalize(),
+            dir=FLUIDD_DIR,
+            backup_dir=FLUIDD_BACKUP_DIR,
+            url=FLUIDD_URL,
+            pre_release_url=FLUIDD_PRE_RLS_URL,
+            tags_url=FLUIDD_TAGS_URL,
+            remote_mode=False,
+            mr_conf_repo="fluidd-core/fluidd",
+            mr_conf_path="~/fluidd",
+            client_config=client_config_data,
+        )
+
+    return client_data
+
+
+def get_client_status(client: ClientData) -> str:
+    return get_install_status_webui(
+        client.get("dir"),
+        NGINX_SITES_AVAILABLE.joinpath(client.get("name")),
+        NGINX_CONFD.joinpath("upstreams.conf"),
+        NGINX_CONFD.joinpath("common_vars.conf"),
+    )
+
+
+def get_client_config_status(client: ClientData) -> Dict[
+    Literal["repo", "local", "remote"],
+    Union[str, int],
+]:
+    client_config = client.get("client_config")
+    client_config = client_config.get("dir")
+
+    return {
+        "repo": RepoManager.get_repo_name(client_config),
+        "local": RepoManager.get_local_commit(client_config),
+        "remote": RepoManager.get_remote_commit(client_config),
+    }
+
+
+def get_current_client_config(clients: List[ClientData]) -> str:
+    installed = []
+    for client in clients:
+        client_config = client.get("client_config")
+        if client_config.get("dir").exists():
+            installed.append(client)
+
+    if len(installed) > 1:
+        return f"{COLOR_YELLOW}Conflict!{RESET_FORMAT}"
+    elif len(installed) == 1:
+        cfg = installed[0].get("client_config")
+        return f"{COLOR_CYAN}{cfg.get('display_name')}{RESET_FORMAT}"
+
+    return f"{COLOR_CYAN}-{RESET_FORMAT}"
+
+
+def backup_mainsail_config_json(is_temp=False) -> None:
+    Logger.print_status(f"Backup '{MAINSAIL_CONFIG_JSON}' ...")
+    bm = BackupManager()
+    if is_temp:
+        fn = Path.home().joinpath("config.json.kiauh.bak")
+        bm.backup_file(MAINSAIL_CONFIG_JSON, custom_filename=fn)
+    else:
+        bm.backup_file(MAINSAIL_CONFIG_JSON)
+
+
+def restore_mainsail_config_json() -> None:
+    try:
+        Logger.print_status(f"Restore '{MAINSAIL_CONFIG_JSON}' ...")
+        source = Path.home().joinpath("config.json.kiauh.bak")
+        shutil.copy(source, MAINSAIL_CONFIG_JSON)
+    except OSError:
+        Logger.print_info("Unable to restore config.json. Skipped ...")
+
+
+def enable_mainsail_remotemode() -> None:
+    Logger.print_status("Enable Mainsails remote mode ...")
+    with open(MAINSAIL_CONFIG_JSON, "r") as f:
+        config_data = json.load(f)
+
+    if config_data["instancesDB"] == "browser":
+        Logger.print_info("Remote mode already configured. Skipped ...")
+        return
+
+    Logger.print_status("Setting instance storage location to 'browser' ...")
+    config_data["instancesDB"] = "browser"
+
+    with open(MAINSAIL_CONFIG_JSON, "w") as f:
+        json.dump(config_data, f, indent=4)
+    Logger.print_ok("Mainsails remote mode enabled!")
+
+
+def symlink_webui_nginx_log(klipper_instances: List[Klipper]) -> None:
+    Logger.print_status("Link NGINX logs into log directory ...")
+    access_log = Path("/var/log/nginx/mainsail-access.log")
+    error_log = Path("/var/log/nginx/mainsail-error.log")
+
+    for instance in klipper_instances:
+        desti_access = instance.log_dir.joinpath("mainsail-access.log")
+        if not desti_access.exists():
+            desti_access.symlink_to(access_log)
+
+        desti_error = instance.log_dir.joinpath("mainsail-error.log")
+        if not desti_error.exists():
+            desti_error.symlink_to(error_log)
+
+
+def get_local_client_version(client: ClientData) -> str:
+    relinfo_file = client.get("dir").joinpath("release_info.json")
+    if not relinfo_file.is_file():
+        return "-"
+
+    with open(relinfo_file, "r") as f:
+        return json.load(f)["version"]
+
+
+def get_remote_client_version(client: ClientData) -> str:
+    try:
+        with urllib.request.urlopen(client.get("tags_url")) as response:
+            data = json.loads(response.read())
+        return data[0]["name"]
+    except (JSONDecodeError, TypeError):
+        return "ERROR"
+
+
+def backup_client_data(client: ClientData) -> None:
+    name = client.get("name")
+    src = client.get("dir")
+    dest = client.get("backup_dir")
+
+    with open(src.joinpath(".version"), "r") as v:
+        version = v.readlines()[0]
+
+    bm = BackupManager()
+    bm.backup_directory(f"{name}-{version}", src, dest)
+    if name == "mainsail":
+        bm.backup_file(MAINSAIL_CONFIG_JSON, dest)
+    bm.backup_file(NGINX_SITES_AVAILABLE.joinpath(name), dest)
+
+
+def backup_client_config_data(client: ClientData) -> None:
+    client_config = client.get("client_config")
+    name = client_config.get("name")
+    source = client_config.get("dir")
+    target = client_config.get("backup_dir")
+    bm = BackupManager()
+    bm.backup_directory(name, source, target)

kiauh/components/webui_client/menus/client_remove_menu.py

@@ -0,0 +1,149 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+
+import textwrap
+from typing import Callable, Dict
+
+from components.webui_client import client_remove, ClientData
+from core.menus import BACK_HELP_FOOTER
+from core.menus.base_menu import BaseMenu
+from utils.constants import RESET_FORMAT, COLOR_RED, COLOR_CYAN
+
+
+# noinspection PyUnusedLocal
+class ClientRemoveMenu(BaseMenu):
+    def __init__(self, client: ClientData):
+        self.client = client
+        self.rm_client = False
+        self.rm_client_config = False
+        self.backup_mainsail_config_json = False
+        self.rm_moonraker_conf_section = False
+        self.rm_printer_cfg_section = False
+
+        super().__init__(
+            header=False,
+            options=self.get_options(),
+            footer_type=BACK_HELP_FOOTER,
+        )
+
+    def get_options(self) -> Dict[str, Callable]:
+        options = {
+            "0": self.toggle_all,
+            "1": self.toggle_rm_client,
+            "2": self.toggle_rm_client_config,
+            "3": self.toggle_rm_printer_cfg_section,
+            "4": self.toggle_rm_moonraker_conf_section,
+            "c": self.run_removal_process,
+        }
+        if self.client.get("name") == "mainsail":
+            options["5"] = self.toggle_backup_mainsail_config_json
+
+        return options
+
+    def print_menu(self) -> None:
+        client_name = self.client.get("display_name")
+        client_config = self.client.get("client_config")
+        client_config_name = client_config.get("display_name")
+
+        header = f" [ Remove {client_name} ] "
+        color = COLOR_RED
+        count = 62 - len(color) - len(RESET_FORMAT)
+        checked = f"[{COLOR_CYAN}x{RESET_FORMAT}]"
+        unchecked = "[ ]"
+        o1 = checked if self.rm_client else unchecked
+        o2 = checked if self.rm_client_config else unchecked
+        o3 = checked if self.rm_printer_cfg_section else unchecked
+        o4 = checked if self.rm_moonraker_conf_section else unchecked
+        menu = textwrap.dedent(
+            f"""
+            /=======================================================\\
+            | {color}{header:~^{count}}{RESET_FORMAT} |
+            |-------------------------------------------------------|
+            | Enter a number and hit enter to select / deselect     |
+            | the specific option for removal.                      |
+            |-------------------------------------------------------|
+            |  0) Select everything                                 |
+            |-------------------------------------------------------|
+            |  1) {o1} Remove {client_name:16}                       |
+            |  2) {o2} Remove {client_config_name:24}               |
+            |                                                       |
+            | printer.cfg & moonraker.conf                          |
+            |  3) {o3} Remove printer.cfg include                    |
+            |  4) {o4} Remove Moonraker update section               |
+            """
+        )[1:]
+
+        if self.client.get("name") == "mainsail":
+            o5 = checked if self.backup_mainsail_config_json else unchecked
+            menu += textwrap.dedent(
+                f"""
+                |                                                       |
+                | Mainsail config.json                                  |
+                |  5) {o5} Backup config.json                            |
+                """
+            )[1:]
+
+        menu += textwrap.dedent(
+            """
+            |-------------------------------------------------------|
+            |  C) Continue                                          |
+            """
+        )[1:]
+        print(menu, end="")
+
+    def toggle_all(self, **kwargs) -> None:
+        self.rm_client = True
+        self.rm_client_config = True
+        self.backup_mainsail_config_json = True
+        self.rm_moonraker_conf_section = True
+        self.rm_printer_cfg_section = True
+
+    def toggle_rm_client(self, **kwargs) -> None:
+        self.rm_client = not self.rm_client
+
+    def toggle_rm_client_config(self, **kwargs) -> None:
+        self.rm_client_config = not self.rm_client_config
+
+    def toggle_backup_mainsail_config_json(self, **kwargs) -> None:
+        self.backup_mainsail_config_json = not self.backup_mainsail_config_json
+
+    def toggle_rm_moonraker_conf_section(self, **kwargs) -> None:
+        self.rm_moonraker_conf_section = not self.rm_moonraker_conf_section
+
+    def toggle_rm_printer_cfg_section(self, **kwargs) -> None:
+        self.rm_printer_cfg_section = not self.rm_printer_cfg_section
+
+    def run_removal_process(self, **kwargs) -> None:
+        if (
+            not self.rm_client
+            and not self.rm_client_config
+            and not self.backup_mainsail_config_json
+            and not self.rm_moonraker_conf_section
+            and not self.rm_printer_cfg_section
+        ):
+            error = f"{COLOR_RED}Nothing selected ...{RESET_FORMAT}"
+            print(error)
+            return
+
+        client_remove.run_client_removal(
+            client=self.client,
+            rm_client=self.rm_client,
+            rm_client_config=self.rm_client_config,
+            backup_ms_config_json=self.backup_mainsail_config_json,
+            rm_moonraker_conf_section=self.rm_moonraker_conf_section,
+            rm_printer_cfg_section=self.rm_printer_cfg_section,
+        )
+
+        self.rm_client = False
+        self.rm_client_config = False
+        self.backup_mainsail_config_json = False
+        self.rm_moonraker_conf_section = False
+        self.rm_printer_cfg_section = False