Initial Commit

unshackle/core/config.py

@@ -0,0 +1,117 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Any, Optional
+
+import yaml
+from appdirs import AppDirs
+
+
+class Config:
+    class _Directories:
+        # default directories, do not modify here, set via config
+        app_dirs = AppDirs("unshackle", False)
+        core_dir = Path(__file__).resolve().parent
+        namespace_dir = core_dir.parent
+        commands = namespace_dir / "commands"
+        services = namespace_dir / "services"
+        vaults = namespace_dir / "vaults"
+        fonts = namespace_dir / "fonts"
+        user_configs = core_dir.parent
+        data = core_dir.parent
+        downloads = core_dir.parent.parent / "downloads"
+        temp = core_dir.parent.parent / "temp"
+        cache = data / "cache"
+        cookies = data / "cookies"
+        logs = data / "logs"
+        wvds = data / "WVDs"
+        prds = data / "PRDs"
+        dcsl = data / "DCSL"
+
+    class _Filenames:
+        # default filenames, do not modify here, set via config
+        log = "unshackle_{name}_{time}.log"  # Directories.logs
+        config = "config.yaml"  # Directories.services / tag
+        root_config = "unshackle.yaml"  # Directories.user_configs
+        chapters = "Chapters_{title}_{random}.txt"  # Directories.temp
+        subtitle = "Subtitle_{id}_{language}.srt"  # Directories.temp
+
+    def __init__(self, **kwargs: Any):
+        self.dl: dict = kwargs.get("dl") or {}
+        self.aria2c: dict = kwargs.get("aria2c") or {}
+        self.n_m3u8dl_re: dict = kwargs.get("n_m3u8dl_re") or {}
+        self.cdm: dict = kwargs.get("cdm") or {}
+        self.chapter_fallback_name: str = kwargs.get("chapter_fallback_name") or ""
+        self.curl_impersonate: dict = kwargs.get("curl_impersonate") or {}
+        self.remote_cdm: list[dict] = kwargs.get("remote_cdm") or []
+        self.credentials: dict = kwargs.get("credentials") or {}
+
+        self.directories = self._Directories()
+        for name, path in (kwargs.get("directories") or {}).items():
+            if name.lower() in ("app_dirs", "core_dir", "namespace_dir", "user_configs", "data"):
+                # these must not be modified by the user
+                continue
+            setattr(self.directories, name, Path(path).expanduser())
+
+        downloader_cfg = kwargs.get("downloader") or "requests"
+        if isinstance(downloader_cfg, dict):
+            self.downloader_map = {k.upper(): v for k, v in downloader_cfg.items()}
+            self.downloader = self.downloader_map.get("DEFAULT", "requests")
+        else:
+            self.downloader_map = {}
+            self.downloader = downloader_cfg
+
+        self.filenames = self._Filenames()
+        for name, filename in (kwargs.get("filenames") or {}).items():
+            setattr(self.filenames, name, filename)
+
+        self.headers: dict = kwargs.get("headers") or {}
+        self.key_vaults: list[dict[str, Any]] = kwargs.get("key_vaults", [])
+        self.muxing: dict = kwargs.get("muxing") or {}
+        self.nordvpn: dict = kwargs.get("nordvpn") or {}
+        self.proxy_providers: dict = kwargs.get("proxy_providers") or {}
+        self.serve: dict = kwargs.get("serve") or {}
+        self.services: dict = kwargs.get("services") or {}
+        self.set_terminal_bg: bool = kwargs.get("set_terminal_bg", True)
+        self.tag: str = kwargs.get("tag") or ""
+        self.tmdb_api_key: str = kwargs.get("tmdb_api_key") or ""
+
+    @classmethod
+    def from_yaml(cls, path: Path) -> Config:
+        if not path.exists():
+            raise FileNotFoundError(f"Config file path ({path}) was not found")
+        if not path.is_file():
+            raise FileNotFoundError(f"Config file path ({path}) is not to a file.")
+        return cls(**yaml.safe_load(path.read_text(encoding="utf8")) or {})
+
+
+# noinspection PyProtectedMember
+POSSIBLE_CONFIG_PATHS = (
+    # The unshackle Namespace Folder (e.g., %appdata%/Python/Python311/site-packages/unshackle)
+    Config._Directories.namespace_dir / Config._Filenames.root_config,
+    # The Parent Folder to the unshackle Namespace Folder (e.g., %appdata%/Python/Python311/site-packages)
+    Config._Directories.namespace_dir.parent / Config._Filenames.root_config,
+    # The AppDirs User Config Folder (e.g., %localappdata%/unshackle)
+    Config._Directories.user_configs / Config._Filenames.root_config,
+)
+
+
+def get_config_path() -> Optional[Path]:
+    """
+    Get Path to Config from any one of the possible locations.
+
+    Returns None if no config file could be found.
+    """
+    for path in POSSIBLE_CONFIG_PATHS:
+        if path.exists():
+            return path
+    return None
+
+
+config_path = get_config_path()
+if config_path:
+    config = Config.from_yaml(config_path)
+else:
+    config = Config()
+
+__all__ = ("config",)