mirror of
https://github.com/dw-0/kiauh.git
synced 2026-02-10 11:17:04 +05:00
feat: allow configuration of multiple repos in kiauh.cfg (#668)
* remove existing simple_config_parser directory * Squashed 'kiauh/core/submodules/simple_config_parser/' content from commit da22e6a git-subtree-dir: kiauh/core/submodules/simple_config_parser git-subtree-split: da22e6ad9ca4bc121c39dc3bc6c63175a72e78a2 * Squashed 'kiauh/core/submodules/simple_config_parser/' changes from da22e6a..9ae5749 9ae5749 fix: comment out file writing in test 1ac4e3d refactor: improve section writing git-subtree-dir: kiauh/core/submodules/simple_config_parser git-subtree-split: 9ae574930dfe82107a3712c7c72b3aa777588996 * Squashed 'kiauh/core/submodules/simple_config_parser/' changes from 9ae5749..53e8408 53e8408 fix: do not add a blank line before writing a section header dc77569 test: add test for removing option before writing git-subtree-dir: kiauh/core/submodules/simple_config_parser git-subtree-split: 53e840853f12318dcac68196fb74c1843cb75808 * Squashed 'kiauh/core/submodules/simple_config_parser/' changes from 53e8408..4a6e5f2 4a6e5f2 refactor: full rework of the internal storage of the parsed config git-subtree-dir: kiauh/core/submodules/simple_config_parser git-subtree-split: 4a6e5f23cb1f298f0a3efbf042186b16c91763c7 * refactor!: switching repos now offers list of repositories to choose from this rework aligns more with the feature provided in kiauh v5. Signed-off-by: Dominik Willner <th33xitus@gmail.com> --------- Signed-off-by: Dominik Willner <th33xitus@gmail.com>
This commit is contained in:
dw-0
GitHub
@@ -9,14 +9,16 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from dataclasses import dataclass, field
|
||||
from typing import Any
|
||||
from typing import Any, List
|
||||
|
||||
from core.backup_manager.backup_manager import BackupManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
NoOptionError,
|
||||
NoSectionError,
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from utils.input_utils import get_confirm
|
||||
from utils.sys_utils import kill
|
||||
|
||||
from kiauh import PROJECT_ROOT
|
||||
@@ -25,32 +27,53 @@ DEFAULT_CFG = PROJECT_ROOT.joinpath("default.kiauh.cfg")
|
||||
CUSTOM_CFG = PROJECT_ROOT.joinpath("kiauh.cfg")
|
||||
|
||||
|
||||
class NoValueError(Exception):
|
||||
"""Raised when a required value is not defined for an option"""
|
||||
|
||||
def __init__(self, section: str, option: str):
|
||||
msg = f"Missing value for option '{option}' in section '{section}'"
|
||||
super().__init__(msg)
|
||||
|
||||
|
||||
class InvalidValueError(Exception):
|
||||
"""Raised when a value is invalid for an option"""
|
||||
|
||||
def __init__(self, section: str, option: str, value: str):
|
||||
msg = f"Invalid value '{value}' for option '{option}' in section '{section}'"
|
||||
super().__init__(msg)
|
||||
|
||||
|
||||
@dataclass
|
||||
class AppSettings:
|
||||
backup_before_update: bool | None = field(default=None)
|
||||
|
||||
|
||||
@dataclass
|
||||
class Repository:
|
||||
url: str
|
||||
branch: str
|
||||
|
||||
|
||||
@dataclass
|
||||
class RepoSettings:
|
||||
repo_url: str | None = field(default=None)
|
||||
branch: str | None = field(default=None)
|
||||
repositories: List[Repository] | None = field(default=None)
|
||||
|
||||
|
||||
@dataclass
|
||||
class WebUiSettings:
|
||||
port: str | None = field(default=None)
|
||||
port: int | None = field(default=None)
|
||||
unstable_releases: bool | None = field(default=None)
|
||||
|
||||
|
||||
# noinspection PyUnusedLocal
|
||||
# noinspection PyMethodMayBeStatic
|
||||
class KiauhSettings:
|
||||
_instance = None
|
||||
__instance = None
|
||||
|
||||
def __new__(cls, *args, **kwargs) -> "KiauhSettings":
|
||||
if cls._instance is None:
|
||||
cls._instance = super(KiauhSettings, cls).__new__(cls, *args, **kwargs)
|
||||
return cls._instance
|
||||
if cls.__instance is None:
|
||||
cls.__instance = super(KiauhSettings, cls).__new__(cls, *args, **kwargs)
|
||||
return cls.__instance
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return (
|
||||
@@ -100,20 +123,30 @@ class KiauhSettings:
|
||||
|
||||
def _load_config(self) -> None:
|
||||
if not CUSTOM_CFG.exists() and not DEFAULT_CFG.exists():
|
||||
self._kill()
|
||||
self.__kill()
|
||||
|
||||
cfg = CUSTOM_CFG if CUSTOM_CFG.exists() else DEFAULT_CFG
|
||||
self.config.read_file(cfg)
|
||||
|
||||
self._validate_cfg()
|
||||
self._apply_settings_from_file()
|
||||
needs_migration = self._check_deprecated_repo_config()
|
||||
if needs_migration:
|
||||
self._prompt_migration_dialog()
|
||||
return
|
||||
else:
|
||||
# Only validate if no migration was needed
|
||||
self._validate_cfg()
|
||||
self.__set_internal_state()
|
||||
|
||||
def _validate_cfg(self) -> None:
|
||||
def __err_and_kill(error: str) -> None:
|
||||
Logger.print_error(f"Error validating kiauh.cfg: {error}")
|
||||
kill()
|
||||
|
||||
try:
|
||||
self._validate_bool("kiauh", "backup_before_update")
|
||||
|
||||
self._validate_str("klipper", "repo_url")
|
||||
self._validate_str("klipper", "branch")
|
||||
self._validate_repositories("klipper", "repositories")
|
||||
self._validate_repositories("moonraker", "repositories")
|
||||
|
||||
self._validate_int("mainsail", "port")
|
||||
self._validate_bool("mainsail", "unstable_releases")
|
||||
@@ -123,16 +156,16 @@ class KiauhSettings:
|
||||
|
||||
except ValueError:
|
||||
err = f"Invalid value for option '{self._v_option}' in section '{self._v_section}'"
|
||||
Logger.print_error(err)
|
||||
kill()
|
||||
__err_and_kill(err)
|
||||
except NoSectionError:
|
||||
err = f"Missing section '{self._v_section}' in config file"
|
||||
Logger.print_error(err)
|
||||
kill()
|
||||
__err_and_kill(err)
|
||||
except NoOptionError:
|
||||
err = f"Missing option '{self._v_option}' in section '{self._v_section}'"
|
||||
Logger.print_error(err)
|
||||
kill()
|
||||
__err_and_kill(err)
|
||||
except NoValueError:
|
||||
err = f"Missing value for option '{self._v_option}' in section '{self._v_section}'"
|
||||
__err_and_kill(err)
|
||||
|
||||
def _validate_bool(self, section: str, option: str) -> None:
|
||||
self._v_section, self._v_option = (section, option)
|
||||
@@ -149,14 +182,38 @@ class KiauhSettings:
|
||||
if not v:
|
||||
raise ValueError
|
||||
|
||||
def _apply_settings_from_file(self) -> None:
|
||||
def _validate_repositories(self, section: str, option: str) -> None:
|
||||
self._v_section, self._v_option = (section, option)
|
||||
repos = self.config.getval(section, option)
|
||||
if not repos:
|
||||
raise NoValueError(section, option)
|
||||
|
||||
for repo in repos:
|
||||
if repo.strip().startswith("#") or repo.strip().startswith(";"):
|
||||
continue
|
||||
try:
|
||||
if "," in repo:
|
||||
url, branch = repo.strip().split(",")
|
||||
if not url:
|
||||
raise InvalidValueError(section, option, repo)
|
||||
else:
|
||||
url = repo.strip()
|
||||
if not url:
|
||||
raise InvalidValueError(section, option, repo)
|
||||
except ValueError:
|
||||
raise InvalidValueError(section, option, repo)
|
||||
|
||||
def __set_internal_state(self) -> None:
|
||||
self.kiauh.backup_before_update = self.config.getboolean(
|
||||
"kiauh", "backup_before_update"
|
||||
)
|
||||
self.klipper.repo_url = self.config.getval("klipper", "repo_url")
|
||||
self.klipper.branch = self.config.getval("klipper", "branch")
|
||||
self.moonraker.repo_url = self.config.getval("moonraker", "repo_url")
|
||||
self.moonraker.branch = self.config.getval("moonraker", "branch")
|
||||
|
||||
kl_repos = self.config.getval("klipper", "repositories")
|
||||
self.klipper.repositories = self.__set_repo_state(kl_repos)
|
||||
|
||||
mr_repos = self.config.getval("moonraker", "repositories")
|
||||
self.moonraker.repositories = self.__set_repo_state(mr_repos)
|
||||
|
||||
self.mainsail.port = self.config.getint("mainsail", "port")
|
||||
self.mainsail.unstable_releases = self.config.getboolean(
|
||||
"mainsail", "unstable_releases"
|
||||
@@ -166,28 +223,147 @@ class KiauhSettings:
|
||||
"fluidd", "unstable_releases"
|
||||
)
|
||||
|
||||
def _set_config_options_state(self) -> None:
|
||||
self.config.set_option(
|
||||
"kiauh",
|
||||
"backup_before_update",
|
||||
str(self.kiauh.backup_before_update),
|
||||
)
|
||||
self.config.set_option("klipper", "repo_url", self.klipper.repo_url)
|
||||
self.config.set_option("klipper", "branch", self.klipper.branch)
|
||||
self.config.set_option("moonraker", "repo_url", self.moonraker.repo_url)
|
||||
self.config.set_option("moonraker", "branch", self.moonraker.branch)
|
||||
self.config.set_option("mainsail", "port", str(self.mainsail.port))
|
||||
self.config.set_option(
|
||||
"mainsail",
|
||||
"unstable_releases",
|
||||
str(self.mainsail.unstable_releases),
|
||||
)
|
||||
self.config.set_option("fluidd", "port", str(self.fluidd.port))
|
||||
self.config.set_option(
|
||||
"fluidd", "unstable_releases", str(self.fluidd.unstable_releases)
|
||||
)
|
||||
def __set_repo_state(self, repos: List[str]) -> List[Repository]:
|
||||
_repos: List[Repository] = []
|
||||
for repo in repos:
|
||||
if repo.strip().startswith("#") or repo.strip().startswith(";"):
|
||||
continue
|
||||
if "," in repo:
|
||||
url, branch = repo.strip().split(",")
|
||||
if not branch:
|
||||
branch = "master"
|
||||
else:
|
||||
url = repo.strip()
|
||||
branch = "master"
|
||||
_repos.append(Repository(url.strip(), branch.strip()))
|
||||
return _repos
|
||||
|
||||
def _kill(self) -> None:
|
||||
def _set_config_options_state(self) -> None:
|
||||
"""Updates the config with current settings, preserving values that haven't been modified"""
|
||||
if self.kiauh.backup_before_update is not None:
|
||||
self.config.set_option(
|
||||
"kiauh",
|
||||
"backup_before_update",
|
||||
str(self.kiauh.backup_before_update),
|
||||
)
|
||||
|
||||
# Handle repositories
|
||||
if self.klipper.repositories is not None:
|
||||
repos = [f"{repo.url}, {repo.branch}" for repo in self.klipper.repositories]
|
||||
self.config.set_option("klipper", "repositories", repos)
|
||||
|
||||
if self.moonraker.repositories is not None:
|
||||
repos = [
|
||||
f"{repo.url}, {repo.branch}" for repo in self.moonraker.repositories
|
||||
]
|
||||
self.config.set_option("moonraker", "repositories", repos)
|
||||
|
||||
# Handle Mainsail settings
|
||||
if self.mainsail.port is not None:
|
||||
self.config.set_option("mainsail", "port", str(self.mainsail.port))
|
||||
if self.mainsail.unstable_releases is not None:
|
||||
self.config.set_option(
|
||||
"mainsail",
|
||||
"unstable_releases",
|
||||
str(self.mainsail.unstable_releases),
|
||||
)
|
||||
|
||||
# Handle Fluidd settings
|
||||
if self.fluidd.port is not None:
|
||||
self.config.set_option("fluidd", "port", str(self.fluidd.port))
|
||||
if self.fluidd.unstable_releases is not None:
|
||||
self.config.set_option(
|
||||
"fluidd", "unstable_releases", str(self.fluidd.unstable_releases)
|
||||
)
|
||||
|
||||
def _check_deprecated_repo_config(self) -> bool:
|
||||
# repo_url and branch are deprecated - 2025.03.23
|
||||
for section in ["klipper", "moonraker"]:
|
||||
if self.config.has_option(section, "repo_url") or self.config.has_option(
|
||||
section, "branch"
|
||||
):
|
||||
return True
|
||||
return False
|
||||
|
||||
def _prompt_migration_dialog(self) -> None:
|
||||
migration_1: List[str] = [
|
||||
"The old 'repo_url' and 'branch' options are now combined under 'repositories'.",
|
||||
"\n\n",
|
||||
"Example format:",
|
||||
"[klipper]",
|
||||
"repositories:",
|
||||
" https://github.com/Klipper3d/klipper, master",
|
||||
"\n\n",
|
||||
"[moonraker]",
|
||||
"repositories:",
|
||||
" https://github.com/Arksine/moonraker, master",
|
||||
]
|
||||
Logger.print_dialog(
|
||||
DialogType.ATTENTION,
|
||||
[
|
||||
"Deprecated repository configuration found!",
|
||||
"KAIUH can now attempt to automatically migrate your configuration.",
|
||||
"\n\n",
|
||||
*migration_1,
|
||||
],
|
||||
)
|
||||
if get_confirm("Migrate to the new format?"):
|
||||
self._migrate_repo_config()
|
||||
else:
|
||||
Logger.print_dialog(
|
||||
DialogType.ERROR,
|
||||
[
|
||||
"Please update your configuration file manually.",
|
||||
],
|
||||
center_content=True,
|
||||
)
|
||||
kill()
|
||||
|
||||
def _migrate_repo_config(self) -> None:
|
||||
bm = BackupManager()
|
||||
if not bm.backup_file(CUSTOM_CFG):
|
||||
Logger.print_dialog(
|
||||
DialogType.ERROR,
|
||||
[
|
||||
"Failed to create backup of kiauh.cfg. Aborting migration. Please migrate manually."
|
||||
],
|
||||
)
|
||||
kill()
|
||||
|
||||
# run migrations
|
||||
try:
|
||||
# migrate deprecated repo_url and branch options - 2025.03.23
|
||||
for section in ["klipper", "moonraker"]:
|
||||
if not self.config.has_section(section):
|
||||
continue
|
||||
|
||||
repo_url = self.config.getval(section, "repo_url", fallback="")
|
||||
branch = self.config.getval(section, "branch", fallback="master")
|
||||
|
||||
if repo_url:
|
||||
# create repositories option with the old values
|
||||
repositories = [f"{repo_url}, {branch}\n"]
|
||||
self.config.set_option(section, "repositories", repositories)
|
||||
|
||||
# remove deprecated options
|
||||
self.config.remove_option(section, "repo_url")
|
||||
self.config.remove_option(section, "branch")
|
||||
|
||||
Logger.print_ok(f"Successfully migrated {section} configuration")
|
||||
|
||||
self.config.write_file(CUSTOM_CFG)
|
||||
self.config.read_file(CUSTOM_CFG) # reload config
|
||||
|
||||
# Validate the migrated config
|
||||
self._validate_cfg()
|
||||
self.__set_internal_state()
|
||||
|
||||
except Exception as e:
|
||||
Logger.print_error(f"Error migrating configuration: {e}")
|
||||
Logger.print_error("Please migrate manually.")
|
||||
kill()
|
||||
|
||||
def __kill(self) -> None:
|
||||
Logger.print_dialog(
|
||||
DialogType.ERROR,
|
||||
[
|
||||
|
||||
Reference in New Issue
Block a user