refactor(Moonraker): refactor example moonraker.conf creation

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

kiauh/modules/moonraker/moonraker_setup.py

@@ -9,7 +9,6 @@
 #  This file may be distributed under the terms of the GNU GPLv3 license  #
 # ======================================================================= #
 
-import os
 import subprocess
 import sys
 from pathlib import Path
@@ -35,11 +34,10 @@ from kiauh.modules.moonraker import (
     POLKIT_FILE,
     POLKIT_USR_FILE,
     POLKIT_SCRIPT,
-    DEFAULT_MOONRAKER_PORT,
-    MODULE_PATH,
 )
 from kiauh.modules.moonraker.moonraker import Moonraker
 from kiauh.modules.moonraker.moonraker_dialogs import print_moonraker_overview
+from kiauh.modules.moonraker.moonraker_utils import create_example_moonraker_conf
 from kiauh.utils.input_utils import (
     get_confirm,
     get_selection_input,
@@ -52,7 +50,6 @@ from kiauh.utils.system_utils import (
     update_system_package_lists,
     install_system_packages,
     check_file_exists,
-    get_ipv4_addr,
 )
 
 
@@ -133,9 +130,9 @@ def install_moonraker(
     setup_moonraker_prerequesites()
     install_moonraker_polkit()
 
-    ports_in_use = [
+    used_ports_map = {
-        instance.port for instance in moonraker_instances if instance.port is not None
+        instance.suffix: instance.port for instance in moonraker_instances
-    ]
+    }
     for name in instance_names:
         current_instance = Moonraker(suffix=name)
 
@@ -144,13 +141,7 @@ def install_moonraker(
         instance_manager.enable_instance()
 
         if create_example_cfg:
-            cfg_dir = current_instance.cfg_dir
+            create_example_moonraker_conf(current_instance, used_ports_map)
-            Logger.print_status(f"Creating example moonraker.conf in '{cfg_dir}'")
-            if current_instance.cfg_file is None:
-                create_example_moonraker_conf(current_instance, ports_in_use)
-                Logger.print_ok(f"Example moonraker.conf created in '{cfg_dir}'")
-            else:
-                Logger.print_info(f"moonraker.conf in '{cfg_dir}' already exists.")
 
         instance_manager.start_instance()
 
@@ -324,33 +315,3 @@ def update_moonraker() -> None:
     )
     repo_manager.pull_repo()
     instance_manager.start_all_instance()
-
-
-def create_example_moonraker_conf(instance: Moonraker, ports: List[int]) -> None:
-    port = max(ports) + 1 if ports else DEFAULT_MOONRAKER_PORT
-    ports.append(port)
-    instance.port = port
-    example_cfg_path = os.path.join(MODULE_PATH, "res", "moonraker.conf")
-
-    with open(f"{instance.cfg_dir}/moonraker.conf", "w") as cfg:
-        cfg.write(_prep_example_moonraker_conf(instance, example_cfg_path))
-
-
-def _prep_example_moonraker_conf(instance: Moonraker, example_cfg_path: str) -> str:
-    try:
-        with open(example_cfg_path, "r") as cfg:
-            example_cfg_content = cfg.read()
-    except FileNotFoundError:
-        Logger.print_error(f"Unable to open {example_cfg_path} - File not found")
-        raise
-
-    example_cfg_content = example_cfg_content.replace("%PORT%", str(instance.port))
-    example_cfg_content = example_cfg_content.replace(
-        "%UDS%", f"{instance.comms_dir}/klippy.sock"
-    )
-
-    ip = get_ipv4_addr().split(".")[:2]
-    ip.extend(["0", "0/16"])
-    example_cfg_content = example_cfg_content.replace("%LAN%", ".".join(ip))
-
-    return example_cfg_content

kiauh/modules/moonraker/moonraker_utils.py

@@ -0,0 +1,75 @@
+#!/usr/bin/env python3
+
+# ======================================================================= #
+#  Copyright (C) 2020 - 2023 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 os
+import shutil
+from typing import List, Dict
+
+from kiauh.core.config_manager.config_manager import ConfigManager
+from kiauh.modules.moonraker import (
+    DEFAULT_MOONRAKER_PORT,
+    MODULE_PATH,
+)
+from kiauh.modules.moonraker.moonraker import Moonraker
+from kiauh.utils.logger import Logger
+from kiauh.utils.system_utils import (
+    get_ipv4_addr,
+)
+
+
+def create_example_moonraker_conf(
+    instance: Moonraker, ports_map: Dict[str, int]
+) -> None:
+    Logger.print_status(f"Creating example moonraker.conf in '{instance.cfg_dir}'")
+    if instance.cfg_file is not None:
+        Logger.print_info(f"moonraker.conf in '{instance.cfg_dir}' already exists.")
+        return
+
+    source = os.path.join(MODULE_PATH, "res", "moonraker.conf")
+    target = os.path.join(instance.cfg_dir, "moonraker.conf")
+    try:
+        shutil.copy(source, target)
+    except OSError as e:
+        Logger.print_error(f"Unable to create example moonraker.conf:\n{e}")
+        return
+
+    cm = ConfigManager(target)
+    cm.read_config()
+
+    ports = [
+        ports_map.get(instance)
+        for instance in ports_map
+        if ports_map.get(instance) is not None
+    ]
+    if ports_map.get(instance.suffix) is None:
+        # this could be improved to not increment the max value of the ports list and assign it as the port
+        # as it can lead to situation where the port for e.g. instance moonraker-2 becomes 7128 if the port
+        # of moonraker-1 is 7125 and moonraker-3 is 7127 and there are moonraker.conf files for moonraker-1
+        # and moonraker-3 already. though, there does not seem to be a very reliable way of always assigning
+        # the correct port to each instance and the user will likely be required to correct the value manually.
+        port = max(ports) + 1 if ports else DEFAULT_MOONRAKER_PORT
+    else:
+        port = ports_map.get(instance.suffix)
+
+    ports_map[instance.suffix] = port
+
+    uds = f"{instance.comms_dir}/klippy.sock"
+    ip = get_ipv4_addr().split(".")[:2]
+    ip.extend(["0", "0/16"])
+    trusted_clients = f"\n{'.'.join(ip)}"
+    trusted_clients += cm.get_value("authorization", "trusted_clients")
+
+    cm.set_value("server", "port", str(port))
+    cm.set_value("server", "klippy_uds_address", uds)
+    cm.set_value("authorization", "trusted_clients", trusted_clients)
+
+    cm.write_config()
+    Logger.print_ok(f"Example moonraker.conf created in '{instance.cfg_dir}'")

kiauh/modules/moonraker/res/moonraker.conf

@@ -5,7 +5,6 @@ klippy_uds_address: %UDS%
 
 [authorization]
 trusted_clients:
-    %LAN%
     10.0.0.0/8
     127.0.0.0/8
     169.254.0.0/16