f0493292af
- Add configurable title caching with fallback support - Cache titles for 30 minutes by default, with 24-hour fallback on API failures - Add --no-cache and --reset-cache CLI flags for cache control - Implement region-aware caching to handle geo-restricted content - Use SHA256 hashing for cache keys to handle complex title IDs - Add cache configuration variables to config system - Document new caching options in example config This caching system significantly reduces redundant API calls when debugging or modifying CLI parameters, improving both performance and reliability.
136 lines
5.7 KiB
Python
136 lines
5.7 KiB
Python
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.subtitle: dict = kwargs.get("subtitle") 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
|
|
if name == "services" and isinstance(path, list):
|
|
setattr(self.directories, name, [Path(p).expanduser() for p in path])
|
|
else:
|
|
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.proxy_providers: dict = kwargs.get("proxy_providers") or {}
|
|
self.serve: dict = kwargs.get("serve") or {}
|
|
self.services: dict = kwargs.get("services") or {}
|
|
decryption_cfg = kwargs.get("decryption") or {}
|
|
if isinstance(decryption_cfg, dict):
|
|
self.decryption_map = {k.upper(): v for k, v in decryption_cfg.items()}
|
|
self.decryption = self.decryption_map.get("DEFAULT", "shaka")
|
|
else:
|
|
self.decryption_map = {}
|
|
self.decryption = decryption_cfg or "shaka"
|
|
|
|
self.set_terminal_bg: bool = kwargs.get("set_terminal_bg", False)
|
|
self.tag: str = kwargs.get("tag") or ""
|
|
self.tmdb_api_key: str = kwargs.get("tmdb_api_key") or ""
|
|
self.update_checks: bool = kwargs.get("update_checks", True)
|
|
self.update_check_interval: int = kwargs.get("update_check_interval", 24)
|
|
self.scene_naming: bool = kwargs.get("scene_naming", True)
|
|
|
|
self.title_cache_time: int = kwargs.get("title_cache_time", 1800) # 30 minutes default
|
|
self.title_cache_max_retention: int = kwargs.get("title_cache_max_retention", 86400) # 24 hours default
|
|
self.title_cache_enabled: bool = kwargs.get("title_cache_enabled", True)
|
|
|
|
@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",)
|