feat: KIAUH v6 - full rewrite of KIAUH in Python (#428)

kiauh/utils/config_utils.py

@@ -0,0 +1,89 @@
+# ======================================================================= #
+#  Copyright (C) 2020 - 2024 Dominik Willner <th33xitus@gmail.com>        #
+#                                                                         #
+#  This file is part of KIAUH - Klipper Installation And Update Helper    #
+#  https://github.com/dw-0/kiauh                                          #
+#                                                                         #
+#  This file may be distributed under the terms of the GNU GPLv3 license  #
+# ======================================================================= #
+from __future__ import annotations
+
+import tempfile
+from pathlib import Path
+from typing import List, Tuple
+
+from core.instance_type import InstanceType
+from core.logger import Logger
+from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
+    SimpleConfigParser,
+)
+
+ConfigOption = Tuple[str, str]
+
+
+def add_config_section(
+    section: str,
+    instances: List[InstanceType],
+    options: List[ConfigOption] | None = None,
+) -> None:
+    for instance in instances:
+        cfg_file = instance.cfg_file
+        Logger.print_status(f"Add section '[{section}]' to '{cfg_file}' ...")
+
+        if not Path(cfg_file).exists():
+            Logger.print_warn(f"'{cfg_file}' not found!")
+            continue
+
+        scp = SimpleConfigParser()
+        scp.read(cfg_file)
+        if scp.has_section(section):
+            Logger.print_info("Section already exist. Skipped ...")
+            continue
+
+        scp.add_section(section)
+
+        if options is not None:
+            for option in reversed(options):
+                scp.set(section, option[0], option[1])
+
+        scp.write(cfg_file)
+
+
+def add_config_section_at_top(section: str, instances: List[InstanceType]) -> None:
+    # TODO: this could be implemented natively in SimpleConfigParser
+    for instance in instances:
+        tmp_cfg = tempfile.NamedTemporaryFile(mode="w", delete=False)
+        tmp_cfg_path = Path(tmp_cfg.name)
+        scp = SimpleConfigParser()
+        scp.read(tmp_cfg_path)
+        scp.add_section(section)
+        scp.write(tmp_cfg_path)
+        tmp_cfg.close()
+
+        cfg_file = instance.cfg_file
+        with open(cfg_file, "r") as org:
+            org_content = org.readlines()
+        with open(tmp_cfg_path, "a") as tmp:
+            tmp.writelines(org_content)
+
+        cfg_file.unlink()
+        tmp_cfg_path.rename(cfg_file)
+
+
+def remove_config_section(section: str, instances: List[InstanceType]) -> None:
+    for instance in instances:
+        cfg_file = instance.cfg_file
+        Logger.print_status(f"Remove section '[{section}]' from '{cfg_file}' ...")
+
+        if not Path(cfg_file).exists():
+            Logger.print_warn(f"'{cfg_file}' not found!")
+            continue
+
+        scp = SimpleConfigParser()
+        scp.read(cfg_file)
+        if not scp.has_section(section):
+            Logger.print_info("Section does not exist. Skipped ...")
+            continue
+
+        scp.remove_section(section)
+        scp.write(cfg_file)