mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-08-12 14:18:06 +00:00
* refactor(web): use canonical secret helpers in api_v3; make ConfigManager secret strip/merge array-aware
api_v3.py carried three inline nested copies of find_secret_fields/
separate_secrets (main-config save, plugin-config save, plugin-config
reset). They drifted from each other (one lacked isinstance guards) and
none supported the canonical module's array-item secrets
(accounts[].token). All three endpoints now import from
src/web_interface/secret_helpers.
Adopting the canonical behavior makes array-item secrets reachable, and
their parallel-placeholder shape ([{'token': ...}, {}] alongside the
regular list) was not survivable by ConfigManager's round-trip:
_strip_secrets_recursive dropped the whole key (losing the regular
fields from config.json) and _deep_merge replaced the regular list
wholesale on load. Both are now array-aware:
- strip removes the secret fields from each item and ALWAYS keeps the
list so indices survive for merge-on-load; whole-key secrets (scalar
lists, shape mismatches) still drop the key entirely — never leak.
- merge folds each secrets item into the config item at the same index,
skipping {} placeholders. The regular list's length is authoritative
in both directions: a user deleting an array item never has it
resurrected from a stale secrets entry (extras warn and are ignored).
api_v3's own deep_merge intentionally still replaces lists wholesale —
form posts carry complete arrays and index-merging would resurrect
deleted items; a comment now documents that.
Tests: the parity guard flips from 'exactly 3 inline copies' to 'zero,
and the canonical import must exist'; TestArraySecretStripAndMerge
covers the new strip/merge semantics incl. length-mismatch contracts;
new test_api_v3_secret_roundtrip.py drives all three endpoints through
a Flask client with a REAL ConfigManager+SchemaManager over tmp_path,
proving secrets land in config_secrets.json, config.json stays clean,
and a fresh load merges them back into the right array items.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
* fix: repair broken helper paths across display, cache, odds, logging, resolver, repos, config, validator
Nine fixes for bugs surfaced while writing coverage for previously
untested modules (plus the bool-duration quirk pinned in PR #441):
- base_plugin.get_display_duration: exclude bools from both numeric
branches — display_duration=True no longer reads as a 1-second slot;
it falls through to config, then the 15.0 default.
- display_helper: draw_error_message/draw_no_data_message called
_draw_centered_text with the wrong arguments and crashed with
AttributeError — both now delegate to draw_centered_text.
draw_scorebug_layout drew status and clock at the same y, overprinting
each other — they now share one combined top line.
draw_ticker_layout drew its text starting at x=display_width (fully
off-canvas), returning a blank frame every time — now draws at x=0;
scroll_speed stays accepted-but-unused and is documented as such.
- api_helper.clear_cache guarded on a nonexistent CacheManager.clear()
method, silently never clearing anything; it now uses the real surface
(clear_cache/delete/list_cache_files) and no-ops safely otherwise.
- base_odds_manager._extract_espn_data raised AttributeError when ESPN
sent explicit JSON nulls ("homeTeamOdds": null) — every level now
null-safes with 'or {}'. format_odds_summary gated on
is_odds_available, which deliberately ignores money lines, so
ML-only odds formatted as "No odds available" — it now gates only on
empty/no_odds data and formats money lines.
- logging_config.ContextualFormatter mutated record.msg in place, so a
second handler prepended the context prefix twice; it now formats a
copy. log_error hardcoded exc_info=True and raised TypeError when the
caller passed exc_info — now kwargs.setdefault.
- dynamic_team_resolver wrote its "shared" class cache through self,
creating instance shadows — the cache was per-instance and every
scoreboard refetched rankings. Writes now go through the class.
- saved_repositories cleaned URLs with an unanchored .replace('.git','')
that mangled URLs merely containing '.git' (my.github.io -> myhub.io);
now strips only a trailing suffix. add/remove also roll back the
in-memory list when the save fails, so memory always matches disk.
- config_helper.merge_configs shallow-copied the base, aliasing every
un-overridden nested dict into the result — now deep-copies.
- startup_validator.validate_all accumulated errors/warnings across
calls — now resets both lists per run.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
* test: cover the previously untested modules
Nine new suites plus an extension, asserting the Phase-1b fixed behavior
and pinning the quirks deliberately left alone:
- test_logging_config.py: formatters (JSON shape, no record mutation,
single prefix through two handlers), PluginLoggerAdapter precedence,
setup_logging handler hygiene and LEDMATRIX_DEBUG, log_error exc_info.
- test_startup_validator.py: exact messages, error-vs-warning split,
accessor split (load_config vs get_config), cache-dir branches with
os.access monkeypatched (root can write anything in CI), idempotence,
raise_on_errors classification precedence.
- test_config_helper.py (full): load/save round trips, dot-notation
get/set incl. silent-failure contract, post-fix no-aliasing merge,
schema validation branches, the '{id}_config' key pin, default-enabled
pin.
- test_saved_repositories.py: three load shapes, bare-list rewrite pin,
trailing-only .git strip (my.github.io regression), save-failure
rollback, type-classification case-sensitivity pin.
- test_api_helper.py: rate-limit math, cache-hit short circuit, ESPN
URL/key formats, exact User-Agent guard, retry adapter, post-fix
clear_cache against the real CacheManager surface, ttl-dropped pin.
- test_base_odds_manager.py: cache-key/URL construction, no_odds
sentinel round trip, stale-cache fallback, null-safe extraction,
ML-only formatting, is_odds_available truth table (ML-blind by
contract), config key/attr mismatch pin.
- test_dynamic_team_resolver.py: expansion/dedup/slicing, dropped
unknown-dynamic names (TOP_ substring hazard pinned), genuinely
shared class cache (second instance: zero HTTP), TTL expiry,
failure degradation without raising.
- test_display_helper.py (full): the fixed error/no-data renders,
combined scorebug top line, non-blank ticker with scroll_speed
no-op pin, composite upconversion, logo bleed positions, square
orientation pin.
- test_skin_runtime_cache.py: discovery-cache hit/invalidation
semantics (manifest mtime, .py edits pinned as non-invalidating),
sys.modules namespacing contract incl. bare-name restore and stdlib
shadowing, entry-module execute-once, API minor-version tolerance,
skin_matches_target table.
- test_sports_capabilities.py (extended): _draw_celebration_layout
executed for real (flash window, matrix-dims fallback, highlight
alternation, logo-failure isolation), _should_celebrate_for direct,
strict duration boundary, score_to_int edges, both-teams-score
precedence, expired-coalesce refire, disabled-win baseline
preservation, id-less prune.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
* test: real schedule/dim coverage for DisplayController; fix two vacuous schedule tests
New test_display_controller_schedule.py drives _check_schedule and
_check_dim_schedule on a bare controller stub: same-day and
midnight-crossing windows with inclusive boundaries, global vs per-day vs
legacy-inferred modes (and dim's global-only default — no legacy
inference), per-day disabled days, invalid %H:%M fallbacks, unknown
timezone -> UTC, dim_brightness default 30, inactive-display short
circuit, and the _was_display_active/_was_dimmed transition flags.
test_display_controller.py's test_schedule_disabled and
test_active_hours patched config_service.get_config — which
_check_schedule never reads — so both asserted the init-default value
and could not fail. Rewritten on the test_inactive_hours pattern
(inject controller.config['schedule'], reset the minute gate, flip the
flag to the opposite state first so the assertion has teeth).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
* ci: raise coverage floor to 48%
Measured 50% with the new suites in place (was 47% baseline when the
gate was introduced at 45); floor stays two points under measured.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
* fix: address CodeQL alert and review findings
- config_manager: the "secrets list longer than config list" warning now
interpolates only config-side data (no key name or secrets-derived
values), resolving the CodeQL clear-text-logging alert.
- base_plugin: validate_config rejects bool display_duration, matching
get_display_duration (bool is an int subclass and would otherwise pass
as a positive number).
- config_helper: merge_configs deep-copies override values in the
non-recursive branch so mutating the merged result cannot reach back
into override_config.
- saved_repositories: saves are atomic (temp file + fsync + os.replace),
so a failed write can no longer truncate saved_repositories.json.
- tests: regression cases for each fix, plus a pin that whole-item
array secrets (key[] + key[].field both marked) strip to empty {}
skeletons — no secret values can reach config.json.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NohXi78cwsAKtN1sCfxjUh
---------
Co-authored-by: Claude <noreply@anthropic.com>
840 lines
39 KiB
Python
840 lines
39 KiB
Python
"""
|
|
Config Manager — reads, writes, and validates ``config/config.json``.
|
|
|
|
:class:`ConfigManager` is the single owner of the on-disk configuration
|
|
files:
|
|
|
|
* ``config/config.json`` — main user-editable configuration.
|
|
* ``config/config_secrets.json`` — sensitive values (API keys, tokens).
|
|
|
|
All writes go through :class:`~src.config_manager_atomic.AtomicConfigManager`
|
|
which performs a backup before overwriting, validates the result, and rolls
|
|
back on error. This makes config corruption essentially impossible.
|
|
|
|
Plugin configuration
|
|
--------------------
|
|
Plugin configs are stored inside ``config.json`` under the plugin's ID key
|
|
and survive plugin reinstalls. Use :meth:`ConfigManager.update_plugin_config`
|
|
to write plugin settings; never write directly to the plugin directory.
|
|
|
|
Hot-reload
|
|
----------
|
|
:class:`~src.config_service.ConfigService` wraps ``ConfigManager`` and
|
|
detects file changes, broadcasting the new config to registered listeners
|
|
without requiring a restart.
|
|
"""
|
|
|
|
import json
|
|
import os
|
|
import logging
|
|
from pathlib import Path
|
|
from typing import Dict, Any, Optional, List
|
|
from src.exceptions import ConfigError
|
|
from src.logging_config import get_logger
|
|
from src.config_manager_atomic import (
|
|
AtomicConfigManager, SaveResult, SaveResultStatus,
|
|
BackupInfo, ValidationResult
|
|
)
|
|
from src.common.permission_utils import (
|
|
ensure_directory_permissions,
|
|
ensure_file_permissions,
|
|
ensure_shared_group_ownership,
|
|
get_config_file_mode,
|
|
get_config_dir_mode
|
|
)
|
|
|
|
class ConfigManager:
|
|
"""
|
|
Reads and writes the main application configuration files.
|
|
|
|
Wraps :class:`~src.config_manager_atomic.AtomicConfigManager` for safe
|
|
atomic writes with automatic backup and rollback. Also exposes helpers
|
|
for plugin configuration persistence and secret-field masking.
|
|
"""
|
|
def __init__(self, config_path: Optional[str] = None, secrets_path: Optional[str] = None) -> None:
|
|
# Use current working directory as base
|
|
self.config_path: str = config_path or "config/config.json"
|
|
self.secrets_path: str = secrets_path or "config/config_secrets.json"
|
|
self.template_path: str = "config/config.template.json"
|
|
self.config: Dict[str, Any] = {}
|
|
# (mtime_ns, size) signature of (config, secrets, template) at the
|
|
# last successful load. load_config() skips the full re-read (3 file
|
|
# parses + recursive template migration) when nothing changed —
|
|
# ~30 web request handlers call it, some 2-3x per request. Cross-
|
|
# process freshness is preserved: another process's save bumps the
|
|
# mtime, so the next load here re-reads.
|
|
self._loaded_sig: Optional[tuple] = None
|
|
self.logger: logging.Logger = get_logger(__name__)
|
|
|
|
# Initialize atomic config manager
|
|
self._atomic_manager: Optional[AtomicConfigManager] = None
|
|
|
|
def get_config_path(self) -> str:
|
|
"""Return the path to the main config file (``config/config.json``)."""
|
|
return self.config_path
|
|
|
|
def get_secrets_path(self) -> str:
|
|
"""Return the path to the secrets file (``config/config_secrets.json``)."""
|
|
return self.secrets_path
|
|
|
|
def _get_atomic_manager(self) -> AtomicConfigManager:
|
|
"""Get or create atomic config manager instance."""
|
|
if self._atomic_manager is None:
|
|
self._atomic_manager = AtomicConfigManager(
|
|
config_path=self.config_path,
|
|
secrets_path=self.secrets_path
|
|
)
|
|
return self._atomic_manager
|
|
|
|
def save_config_atomic(
|
|
self,
|
|
new_config_data: Dict[str, Any],
|
|
create_backup: bool = True,
|
|
validate_after_write: bool = True
|
|
) -> SaveResult:
|
|
"""
|
|
Save configuration atomically with backup and rollback support.
|
|
|
|
This method provides atomic file operations to prevent corruption
|
|
and enables recovery from failed saves.
|
|
|
|
Args:
|
|
new_config_data: New configuration data to save
|
|
create_backup: Whether to create backup before saving (default: True)
|
|
validate_after_write: Whether to validate after writing (default: True)
|
|
|
|
Returns:
|
|
SaveResult with status and details
|
|
"""
|
|
# Load current secrets to preserve them (raises if unreadable — see
|
|
# _load_secrets_for_save)
|
|
secrets_content = self._load_secrets_for_save()
|
|
|
|
# Strip secrets from main config before saving
|
|
config_to_write = self._strip_secrets_recursive(new_config_data, secrets_content)
|
|
|
|
# Use atomic manager to save
|
|
atomic_mgr = self._get_atomic_manager()
|
|
result = atomic_mgr.save_config_atomic(
|
|
new_config=config_to_write,
|
|
new_secrets=secrets_content if secrets_content else None,
|
|
create_backup=create_backup,
|
|
validate_after_write=validate_after_write
|
|
)
|
|
|
|
# Update in-memory config if save was successful
|
|
if result.status == SaveResultStatus.SUCCESS:
|
|
self.config = new_config_data
|
|
# In-memory config now matches what was just written; refresh
|
|
# the load signature so the fast path stays valid. NOTE: the
|
|
# in-memory copy includes merged secrets; the on-disk file has
|
|
# them stripped — the fast path returning self.config preserves
|
|
# exactly the pre-cache behavior (load-after-save also returned
|
|
# the secret-merged self.config only after re-reading secrets;
|
|
# here secrets file is unchanged, so contents are equivalent).
|
|
self._loaded_sig = self._files_signature()
|
|
self.logger.info(f"Configuration successfully saved atomically to {os.path.abspath(self.config_path)}")
|
|
elif result.status == SaveResultStatus.ROLLED_BACK:
|
|
# Reload config from file after rollback
|
|
try:
|
|
self.load_config()
|
|
except Exception as e:
|
|
self.logger.error(f"Error reloading config after rollback: {e}")
|
|
|
|
return result
|
|
|
|
def rollback_config(self, backup_version: Optional[str] = None) -> bool:
|
|
"""
|
|
Rollback configuration to a previous backup.
|
|
|
|
Args:
|
|
backup_version: Specific backup version to restore (timestamp string).
|
|
If None, restores most recent backup.
|
|
|
|
Returns:
|
|
True if rollback successful, False otherwise
|
|
"""
|
|
atomic_mgr = self._get_atomic_manager()
|
|
success = atomic_mgr.rollback_config(backup_version)
|
|
|
|
if success:
|
|
# Reload config after rollback
|
|
try:
|
|
self.load_config()
|
|
except Exception as e:
|
|
self.logger.error(f"Error reloading config after rollback: {e}")
|
|
return False
|
|
|
|
return success
|
|
|
|
def list_backups(self) -> List[BackupInfo]:
|
|
"""
|
|
List all available configuration backups.
|
|
|
|
Returns:
|
|
List of BackupInfo objects, sorted by timestamp (newest first)
|
|
"""
|
|
atomic_mgr = self._get_atomic_manager()
|
|
return atomic_mgr.list_backups()
|
|
|
|
def validate_config_file(self, config_path: Optional[str] = None) -> ValidationResult:
|
|
"""
|
|
Validate a configuration file.
|
|
|
|
Args:
|
|
config_path: Path to config file. If None, validates current config_path.
|
|
|
|
Returns:
|
|
ValidationResult with validation status and errors
|
|
"""
|
|
atomic_mgr = self._get_atomic_manager()
|
|
return atomic_mgr.validate_config_file(config_path)
|
|
|
|
def _files_signature(self) -> tuple:
|
|
"""(mtime_ns, size) of config/secrets/template, None for missing —
|
|
cheap staleness probe (3 stats) for the load_config fast path."""
|
|
sig = []
|
|
for path in (self.config_path, self.secrets_path, self.template_path):
|
|
try:
|
|
st = os.stat(path)
|
|
sig.append((st.st_mtime_ns, st.st_size))
|
|
except OSError:
|
|
sig.append(None)
|
|
return tuple(sig)
|
|
|
|
def load_config(self) -> Dict[str, Any]:
|
|
"""Load configuration from JSON files.
|
|
|
|
Fast path: when config.json, config_secrets.json and the template
|
|
are all unchanged since the last successful load (mtime_ns + size),
|
|
the already-parsed self.config is returned without touching the
|
|
files — same aliasing semantics as the full path, which also
|
|
returns self.config.
|
|
"""
|
|
try:
|
|
current_sig = self._files_signature()
|
|
if self.config and self._loaded_sig == current_sig:
|
|
return self.config
|
|
|
|
# Check if config file exists, if not create from template
|
|
if not os.path.exists(self.config_path):
|
|
self._create_config_from_template()
|
|
|
|
# Load main config
|
|
self.logger.info(f"Attempting to load config from: {os.path.abspath(self.config_path)}")
|
|
with open(self.config_path, 'r') as f:
|
|
self.config = json.load(f)
|
|
|
|
# Migrate config to add any new items from template
|
|
self._migrate_config()
|
|
|
|
# Load and merge secrets if they exist (be permissive on errors)
|
|
if os.path.exists(self.secrets_path):
|
|
# Self-heal stale group ownership (e.g. the root-run display
|
|
# service wrote this file before the web user was granted
|
|
# group access) before every load attempt; no-op unless
|
|
# running as root and the group is already wrong.
|
|
ensure_shared_group_ownership(Path(self.secrets_path))
|
|
try:
|
|
with open(self.secrets_path, 'r') as f:
|
|
secrets = json.load(f)
|
|
# Deep merge secrets into config
|
|
self._deep_merge(self.config, secrets)
|
|
except PermissionError as e:
|
|
self.logger.warning(f"Secrets file not readable ({self.secrets_path}): {e}. Continuing without secrets.")
|
|
except (json.JSONDecodeError, OSError) as e:
|
|
self.logger.warning(f"Error reading secrets file ({self.secrets_path}): {e}. Continuing without secrets.")
|
|
|
|
# Signature taken AFTER load + migration (migration may write the
|
|
# config back), so it reflects exactly what was read/written.
|
|
self._loaded_sig = self._files_signature()
|
|
return self.config
|
|
|
|
except FileNotFoundError as e:
|
|
if str(e).find('config_secrets.json') == -1: # Only raise if main config is missing
|
|
error_msg = f"Configuration file not found at {os.path.abspath(self.config_path)}"
|
|
self.logger.error(error_msg, exc_info=True)
|
|
raise ConfigError(error_msg, config_path=self.config_path) from e
|
|
return self.config
|
|
except json.JSONDecodeError as e:
|
|
error_msg = f"Error parsing configuration file {os.path.abspath(self.config_path)}"
|
|
self.logger.error(error_msg, exc_info=True)
|
|
raise ConfigError(error_msg, config_path=self.config_path) from e
|
|
except (IOError, OSError, PermissionError) as e:
|
|
error_msg = f"Error loading configuration from {os.path.abspath(self.config_path)}"
|
|
self.logger.error(error_msg, exc_info=True)
|
|
raise ConfigError(error_msg, config_path=self.config_path) from e
|
|
except Exception as e:
|
|
error_msg = f"Unexpected error loading configuration: {str(e)}"
|
|
self.logger.error(error_msg, exc_info=True)
|
|
raise ConfigError(error_msg, config_path=self.config_path) from e
|
|
|
|
@staticmethod
|
|
def _is_parallel_secrets_list(value: Any) -> bool:
|
|
"""True for the parallel-placeholder list shape emitted by
|
|
``secret_helpers.separate_secrets`` for array-item secrets: a
|
|
non-empty list whose elements are ALL dicts (``{}`` marks an item
|
|
with no secrets). Any other list-shaped secrets value is a
|
|
whole-key secret (e.g. a list of secret scalars)."""
|
|
return (isinstance(value, list) and bool(value)
|
|
and all(isinstance(item, dict) for item in value))
|
|
|
|
def _strip_secrets_recursive(self, data_to_filter: Dict[str, Any], secrets: Dict[str, Any]) -> Dict[str, Any]:
|
|
"""Recursively remove secret keys from a dictionary."""
|
|
result = {}
|
|
for key, value in data_to_filter.items():
|
|
if key not in secrets:
|
|
# This key is not in secrets, so we keep it
|
|
result[key] = value
|
|
continue
|
|
sec = secrets[key]
|
|
if isinstance(value, dict) and isinstance(sec, dict):
|
|
# This key is a shared group, recurse
|
|
stripped_sub_dict = self._strip_secrets_recursive(value, sec)
|
|
if stripped_sub_dict: # Only add if there's non-secret data left
|
|
result[key] = stripped_sub_dict
|
|
elif isinstance(value, list) and self._is_parallel_secrets_list(sec):
|
|
# Parallel-list shape from separate_secrets: sec[i] holds the
|
|
# secret fields of value[i] ({} = item i has none). Strip each
|
|
# item and ALWAYS keep the list — indices must survive so the
|
|
# merge-on-load can realign secrets with their items. The
|
|
# regular list's length is authoritative: extra secrets
|
|
# entries are ignored.
|
|
stripped_items = []
|
|
for i, item in enumerate(value):
|
|
s_item = sec[i] if i < len(sec) else {}
|
|
if isinstance(item, dict) and s_item:
|
|
stripped_items.append(self._strip_secrets_recursive(item, s_item))
|
|
else:
|
|
stripped_items.append(item)
|
|
result[key] = stripped_items
|
|
# Else: whole-key secret (scalar, list of secret scalars, or a
|
|
# shape mismatch) -> drop the key entirely. Never leak.
|
|
return result
|
|
|
|
def _load_secrets_for_save(self) -> Dict[str, Any]:
|
|
"""Load config_secrets.json for stripping before a save.
|
|
|
|
A missing secrets file is fine (nothing to strip). But a file that
|
|
EXISTS and cannot be read or parsed means stripping is impossible —
|
|
and the in-memory config being saved has secrets deep-merged into it,
|
|
so proceeding would write them into config.json in plaintext. That
|
|
was the historical behavior; it is now a hard refusal. The save
|
|
raises so the caller (and user) fixes the secrets file instead of
|
|
silently leaking its contents into the world-readable main config.
|
|
"""
|
|
if not os.path.exists(self.secrets_path):
|
|
return {}
|
|
try:
|
|
with open(self.secrets_path, 'r') as f_secrets:
|
|
return json.load(f_secrets)
|
|
# Only the expected read/parse failures — an unexpected implementation
|
|
# error should propagate as itself, not masquerade as a secrets-file
|
|
# problem. (JSONDecodeError and UnicodeDecodeError are ValueErrors.)
|
|
except (OSError, ValueError, RecursionError) as e:
|
|
error_msg = (
|
|
f"Refusing to save config: secrets file {self.secrets_path} exists "
|
|
f"but could not be loaded ({e}). Saving without it would write "
|
|
f"merged secret values into config.json in plaintext. Fix or "
|
|
f"remove the secrets file, then retry."
|
|
)
|
|
self.logger.error("[Config] %s", error_msg, exc_info=True)
|
|
raise ConfigError(error_msg, config_path=self.secrets_path) from e
|
|
|
|
def save_config(self, new_config_data: Dict[str, Any]) -> None:
|
|
"""Save configuration to the main JSON file, stripping out secrets.
|
|
|
|
Raises ConfigError when the secrets file exists but cannot be loaded,
|
|
because stripping would be impossible and secrets would leak into
|
|
config.json.
|
|
"""
|
|
secrets_content = self._load_secrets_for_save()
|
|
|
|
config_to_write = self._strip_secrets_recursive(new_config_data, secrets_content)
|
|
|
|
try:
|
|
with open(self.config_path, 'w') as f:
|
|
json.dump(config_to_write, f, indent=4)
|
|
|
|
# Update the in-memory config to the new state (which includes secrets for runtime)
|
|
self.config = new_config_data
|
|
self._loaded_sig = self._files_signature()
|
|
self.logger.info(f"Configuration successfully saved to {os.path.abspath(self.config_path)}")
|
|
if secrets_content:
|
|
self.logger.info("Secret values were preserved in memory and not written to the main config file.")
|
|
|
|
except (IOError, OSError, PermissionError) as e:
|
|
error_msg = f"Error writing configuration to file {os.path.abspath(self.config_path)}"
|
|
self.logger.error(error_msg, exc_info=True)
|
|
raise ConfigError(error_msg, config_path=self.config_path) from e
|
|
except Exception as e:
|
|
error_msg = f"Unexpected error occurred while saving configuration: {str(e)}"
|
|
self.logger.error(error_msg, exc_info=True)
|
|
raise ConfigError(error_msg, config_path=self.config_path) from e
|
|
|
|
def get_secret(self, key: str) -> Optional[Any]:
|
|
"""Get a secret value by key."""
|
|
try:
|
|
if not os.path.exists(self.secrets_path):
|
|
return None
|
|
with open(self.secrets_path, 'r') as f:
|
|
secrets = json.load(f)
|
|
return secrets.get(key)
|
|
except (json.JSONDecodeError, IOError) as e:
|
|
self.logger.error(f"Error reading secrets file: {e}")
|
|
return None
|
|
|
|
def _deep_merge(self, target: Dict[str, Any], source: Dict[str, Any]) -> None:
|
|
"""Deep merge source dict into target dict.
|
|
|
|
Sole call site: merging config_secrets.json into the loaded config.
|
|
Understands the parallel-list shape separate_secrets emits for
|
|
array-item secrets (see _is_parallel_secrets_list): each secrets
|
|
list item is merged into the config list item at the same index
|
|
({} placeholders skipped). The config list's length is
|
|
authoritative — a user deleting an array item from config.json
|
|
must not have it resurrected from a stale secrets entry."""
|
|
for key, value in source.items():
|
|
if key in target and isinstance(target[key], dict) and isinstance(value, dict):
|
|
self._deep_merge(target[key], value)
|
|
elif (key in target and isinstance(target[key], list)
|
|
and self._is_parallel_secrets_list(value)):
|
|
tlist = target[key]
|
|
for i, s_item in enumerate(value):
|
|
if i >= len(tlist):
|
|
# Interpolate only config-side data here — nothing
|
|
# iterated out of the secrets dict (not even the key
|
|
# name) may reach the log.
|
|
self.logger.warning(
|
|
"A secrets list is longer than the config list it "
|
|
"parallels (config has %d item(s)); ignoring the "
|
|
"extra entries", len(tlist))
|
|
break
|
|
if not s_item:
|
|
continue # {} placeholder: item i has no secrets
|
|
if isinstance(tlist[i], dict):
|
|
self._deep_merge(tlist[i], s_item)
|
|
else:
|
|
tlist[i] = s_item # shape drift; the secret wins
|
|
else:
|
|
# Scalars AND whole-secret scalar arrays: replace (legacy).
|
|
target[key] = value
|
|
|
|
def _create_config_from_template(self) -> None:
|
|
"""Create config.json from template if it doesn't exist."""
|
|
if not os.path.exists(self.template_path):
|
|
error_msg = f"Template file not found at {os.path.abspath(self.template_path)}"
|
|
self.logger.error(error_msg)
|
|
raise ConfigError(error_msg, config_path=self.template_path)
|
|
|
|
self.logger.info(f"Creating config.json from template at {os.path.abspath(self.template_path)}")
|
|
|
|
# Ensure config directory exists with proper permissions
|
|
config_dir = Path(self.config_path).parent
|
|
ensure_directory_permissions(config_dir, get_config_dir_mode())
|
|
|
|
# Copy template to config
|
|
with open(self.template_path, 'r') as template_file:
|
|
template_data = json.load(template_file)
|
|
|
|
with open(self.config_path, 'w') as config_file:
|
|
json.dump(template_data, config_file, indent=4)
|
|
|
|
# Set proper file permissions after creation
|
|
config_path_obj = Path(self.config_path)
|
|
ensure_file_permissions(config_path_obj, get_config_file_mode(config_path_obj))
|
|
ensure_shared_group_ownership(config_path_obj)
|
|
|
|
self.logger.info(f"Created config.json from template at {os.path.abspath(self.config_path)}")
|
|
|
|
def _migrate_config(self) -> None:
|
|
"""Migrate config to add new items from template with defaults."""
|
|
if not os.path.exists(self.template_path):
|
|
self.logger.warning(f"Template file not found at {os.path.abspath(self.template_path)}, skipping migration")
|
|
return
|
|
|
|
try:
|
|
with open(self.template_path, 'r') as f:
|
|
template_config = json.load(f)
|
|
|
|
# Check if migration is needed
|
|
if self._config_needs_migration(self.config, template_config):
|
|
self.logger.info("Config migration needed - adding new configuration items with defaults")
|
|
|
|
# Create backup of current config
|
|
backup_path = f"{self.config_path}.backup"
|
|
with open(backup_path, 'w') as backup_file:
|
|
json.dump(self.config, backup_file, indent=4)
|
|
self.logger.info(f"Created backup of current config at {os.path.abspath(backup_path)}")
|
|
|
|
# Merge template defaults into current config
|
|
self._merge_template_defaults(self.config, template_config)
|
|
|
|
# Save migrated config using atomic save to preserve permissions
|
|
# Use atomic save to preserve file permissions
|
|
# Note: save_config_atomic handles secrets internally
|
|
result = self.save_config_atomic(
|
|
new_config_data=self.config,
|
|
create_backup=False, # Already created backup above
|
|
validate_after_write=False # Skip validation for migration
|
|
)
|
|
|
|
if result.status.value == "success":
|
|
self.logger.info(f"Config migration completed and saved to {os.path.abspath(self.config_path)}")
|
|
else:
|
|
self.logger.warning(f"Config migration completed but save had issues: {result.message}")
|
|
else:
|
|
self.logger.debug("Config is up to date, no migration needed")
|
|
|
|
except Exception as e:
|
|
self.logger.error(f"Error during config migration: {e}")
|
|
# Don't raise - continue with current config
|
|
|
|
def _config_needs_migration(self, current_config: Dict[str, Any], template_config: Dict[str, Any]) -> bool:
|
|
"""Check if config needs migration by comparing with template."""
|
|
return self._has_new_keys(current_config, template_config)
|
|
|
|
def _has_new_keys(self, current: Dict[str, Any], template: Dict[str, Any]) -> bool:
|
|
"""Recursively check if template has keys not in current config."""
|
|
for key, value in template.items():
|
|
if key not in current:
|
|
return True
|
|
if isinstance(value, dict) and isinstance(current[key], dict):
|
|
if self._has_new_keys(current[key], value):
|
|
return True
|
|
return False
|
|
|
|
def _merge_template_defaults(self, current: Dict[str, Any], template: Dict[str, Any]) -> None:
|
|
"""Recursively merge template defaults into current config."""
|
|
for key, value in template.items():
|
|
if key not in current:
|
|
# Add new key with template value
|
|
current[key] = value
|
|
self.logger.debug(f"Added new config key: {key}")
|
|
elif isinstance(value, dict) and isinstance(current[key], dict):
|
|
# Recursively merge nested dictionaries
|
|
self._merge_template_defaults(current[key], value)
|
|
|
|
def get_timezone(self) -> str:
|
|
"""Get the configured timezone."""
|
|
return self.config.get('timezone', 'UTC')
|
|
|
|
def get_display_config(self) -> Dict[str, Any]:
|
|
"""Get display configuration."""
|
|
return self.config.get('display', {})
|
|
|
|
def get_config(self) -> Dict[str, Any]:
|
|
"""Get the full configuration dictionary.
|
|
|
|
Returns:
|
|
The complete configuration dictionary. If config hasn't been loaded yet,
|
|
it will be loaded first.
|
|
"""
|
|
if not self.config:
|
|
self.load_config()
|
|
return self.config
|
|
|
|
def get_raw_file_content(self, file_type: str) -> Dict[str, Any]:
|
|
"""Load raw content of 'main' config or 'secrets' config file."""
|
|
path_to_load = ""
|
|
if file_type == "main":
|
|
path_to_load = self.config_path
|
|
elif file_type == "secrets":
|
|
path_to_load = self.secrets_path
|
|
else:
|
|
raise ValueError("Invalid file_type specified. Must be 'main' or 'secrets'.")
|
|
|
|
if not os.path.exists(path_to_load):
|
|
# If a secrets file doesn't exist, it's not an error, just return empty
|
|
if file_type == "secrets":
|
|
return {}
|
|
error_msg = f"{file_type.capitalize()} configuration file not found at {os.path.abspath(path_to_load)}"
|
|
self.logger.error(error_msg)
|
|
raise ConfigError(error_msg, config_path=path_to_load)
|
|
|
|
if file_type == "secrets":
|
|
# Best-effort self-heal: no-op unless running as root and the
|
|
# group is stale (see load_config for why this can happen).
|
|
ensure_shared_group_ownership(Path(path_to_load))
|
|
|
|
try:
|
|
with open(path_to_load, 'r') as f:
|
|
return json.load(f)
|
|
except json.JSONDecodeError as e:
|
|
error_msg = f"Error parsing {file_type} configuration file: {path_to_load}"
|
|
self.logger.error(error_msg, exc_info=True)
|
|
raise ConfigError(error_msg, config_path=path_to_load) from e
|
|
except PermissionError as e:
|
|
if file_type == "secrets":
|
|
# Match load_config()'s tolerance: a secrets file the web
|
|
# process can't read (e.g. written 0640 by the root-run
|
|
# display service before the group was fixed up) shouldn't
|
|
# 500 the settings page — degrade to "no secrets" instead.
|
|
self.logger.warning(f"Secrets file not readable ({path_to_load}): {e}. Returning empty secrets.")
|
|
return {}
|
|
error_msg = f"Error loading {file_type} configuration file {path_to_load}: {str(e)}"
|
|
self.logger.error(error_msg, exc_info=True)
|
|
raise ConfigError(error_msg, config_path=path_to_load) from e
|
|
except (IOError, OSError) as e:
|
|
error_msg = f"Error loading {file_type} configuration file {path_to_load}: {str(e)}"
|
|
self.logger.error(error_msg, exc_info=True)
|
|
raise ConfigError(error_msg, config_path=path_to_load) from e
|
|
except Exception as e:
|
|
error_msg = f"Unexpected error loading {file_type} configuration file {path_to_load}: {str(e)}"
|
|
self.logger.error(error_msg, exc_info=True)
|
|
raise ConfigError(error_msg, config_path=path_to_load) from e
|
|
|
|
def save_raw_file_content(self, file_type: str, data: Dict[str, Any]) -> None:
|
|
"""Save data directly to 'main' config or 'secrets' config file."""
|
|
path_to_save = ""
|
|
if file_type == "main":
|
|
path_to_save = self.config_path
|
|
elif file_type == "secrets":
|
|
path_to_save = self.secrets_path
|
|
else:
|
|
raise ValueError("Invalid file_type specified. Must be 'main' or 'secrets'.")
|
|
|
|
try:
|
|
# Create directory if it doesn't exist, especially for config/
|
|
path_obj = Path(path_to_save)
|
|
ensure_directory_permissions(path_obj.parent, get_config_dir_mode())
|
|
|
|
# Use atomic write: write to temp file first, then move atomically
|
|
# This works even if the existing file isn't writable (as long as directory is writable)
|
|
import tempfile
|
|
file_mode = get_config_file_mode(path_obj)
|
|
|
|
# Create temp file in same directory to ensure atomic move works
|
|
temp_fd, temp_path = tempfile.mkstemp(
|
|
suffix='.json',
|
|
dir=str(path_obj.parent),
|
|
text=True
|
|
)
|
|
|
|
try:
|
|
# Write to temp file
|
|
with os.fdopen(temp_fd, 'w', encoding='utf-8') as f:
|
|
json.dump(data, f, indent=4)
|
|
f.flush()
|
|
os.fsync(f.fileno())
|
|
|
|
# Set permissions on temp file before moving
|
|
try:
|
|
os.chmod(temp_path, file_mode)
|
|
except OSError:
|
|
pass # Non-critical if chmod fails
|
|
|
|
# Atomically move temp file to final location
|
|
# This works even if target file exists and isn't writable
|
|
os.replace(temp_path, str(path_obj))
|
|
temp_path = None # Mark as moved so we don't try to clean it up
|
|
|
|
# Ensure final file has correct permissions
|
|
try:
|
|
ensure_file_permissions(path_obj, file_mode)
|
|
ensure_shared_group_ownership(path_obj)
|
|
except OSError as perm_error:
|
|
# If we can't set permissions but file was written, log warning but don't fail
|
|
self.logger.warning(
|
|
f"File {path_to_save} was written successfully but could not set permissions: {perm_error}. "
|
|
f"This may cause issues if the file needs to be accessible by other users."
|
|
)
|
|
finally:
|
|
# Clean up temp file if it still exists (move failed)
|
|
if temp_path and os.path.exists(temp_path):
|
|
try:
|
|
os.remove(temp_path)
|
|
except OSError:
|
|
pass
|
|
|
|
self.logger.info(f"{file_type.capitalize()} configuration successfully saved to {os.path.abspath(path_to_save)}")
|
|
|
|
# If we just saved the main config or secrets, the merged self.config might be stale.
|
|
# Reload it to reflect the new state.
|
|
# Note: We wrap this in try-except because reload failures (e.g., migration errors)
|
|
# should not cause the save operation to fail - the file was saved successfully.
|
|
if file_type == "main" or file_type == "secrets":
|
|
try:
|
|
self.load_config()
|
|
except Exception as reload_error:
|
|
# Log the reload error but don't fail the save operation
|
|
# The file was saved successfully, reload is just for in-memory consistency
|
|
self.logger.warning(
|
|
f"Configuration file saved successfully, but reload failed: {reload_error}. "
|
|
f"The file on disk is valid, but in-memory config may be stale."
|
|
)
|
|
|
|
except PermissionError as e:
|
|
# Provide helpful error message with fix instructions
|
|
import stat
|
|
try:
|
|
import pwd
|
|
if path_obj.exists():
|
|
file_stat = path_obj.stat()
|
|
current_mode = stat.filemode(file_stat.st_mode)
|
|
try:
|
|
file_owner = pwd.getpwuid(file_stat.st_uid).pw_name
|
|
except (ImportError, KeyError):
|
|
file_owner = f"UID {file_stat.st_uid}"
|
|
error_msg = (
|
|
f"Cannot write to {file_type} configuration file {os.path.abspath(path_to_save)}. "
|
|
f"File is owned by {file_owner} with permissions {current_mode}. "
|
|
f"To fix, run: sudo chown $USER:$(id -gn) {path_to_save} && sudo chmod 664 {path_to_save}"
|
|
)
|
|
else:
|
|
# File doesn't exist - check directory permissions
|
|
dir_stat = path_obj.parent.stat()
|
|
dir_mode = stat.filemode(dir_stat.st_mode)
|
|
try:
|
|
dir_owner = pwd.getpwuid(dir_stat.st_uid).pw_name
|
|
except (ImportError, KeyError):
|
|
dir_owner = f"UID {dir_stat.st_uid}"
|
|
error_msg = (
|
|
f"Cannot create {file_type} configuration file {os.path.abspath(path_to_save)}. "
|
|
f"Directory is owned by {dir_owner} with permissions {dir_mode}. "
|
|
f"To fix, run: sudo chown $USER:$(id -gn) {path_obj.parent} && sudo chmod 775 {path_obj.parent}"
|
|
)
|
|
except Exception:
|
|
# Fallback to generic message if we can't get file info
|
|
error_msg = f"Error writing {file_type} configuration to file {os.path.abspath(path_to_save)}: {str(e)}"
|
|
self.logger.error(error_msg, exc_info=True)
|
|
raise ConfigError(error_msg, config_path=path_to_save) from e
|
|
except (IOError, OSError) as e:
|
|
error_msg = f"Error writing {file_type} configuration to file {os.path.abspath(path_to_save)}: {str(e)}"
|
|
self.logger.error(error_msg, exc_info=True)
|
|
raise ConfigError(error_msg, config_path=path_to_save) from e
|
|
except Exception as e:
|
|
error_msg = f"Unexpected error occurred while saving {file_type} configuration: {str(e)}"
|
|
self.logger.error(error_msg, exc_info=True)
|
|
raise ConfigError(error_msg, config_path=path_to_save) from e
|
|
|
|
def cleanup_plugin_config(self, plugin_id: str, remove_secrets: bool = True) -> None:
|
|
"""
|
|
Remove plugin configuration from both main config and secrets config.
|
|
|
|
Args:
|
|
plugin_id: Plugin identifier to remove
|
|
remove_secrets: If True, also remove plugin secrets
|
|
"""
|
|
try:
|
|
# Load current configs
|
|
main_config = self.get_raw_file_content('main')
|
|
secrets_config = self.get_raw_file_content('secrets') if os.path.exists(self.secrets_path) else {}
|
|
|
|
# Remove plugin from main config
|
|
if plugin_id in main_config:
|
|
del main_config[plugin_id]
|
|
self.save_raw_file_content('main', main_config)
|
|
self.logger.info(f"Removed plugin {plugin_id} from main configuration")
|
|
|
|
# Remove plugin from secrets config if requested
|
|
if remove_secrets and plugin_id in secrets_config:
|
|
del secrets_config[plugin_id]
|
|
self.save_raw_file_content('secrets', secrets_config)
|
|
self.logger.info(f"Removed plugin {plugin_id} from secrets configuration")
|
|
|
|
except Exception as e:
|
|
error_msg = f"Error cleaning up plugin config for {plugin_id}"
|
|
self.logger.error(error_msg, exc_info=True)
|
|
raise ConfigError(error_msg, config_path=self.config_path, field=plugin_id) from e
|
|
|
|
def cleanup_orphaned_plugin_configs(self, valid_plugin_ids: List[str]) -> List[str]:
|
|
"""
|
|
Remove configuration sections for plugins that are no longer installed.
|
|
|
|
Args:
|
|
valid_plugin_ids: List of currently installed plugin IDs
|
|
|
|
Returns:
|
|
List of plugin IDs that were removed
|
|
"""
|
|
removed = []
|
|
try:
|
|
# Load current configs
|
|
main_config = self.get_raw_file_content('main')
|
|
secrets_config = self.get_raw_file_content('secrets') if os.path.exists(self.secrets_path) else {}
|
|
|
|
valid_set = set(valid_plugin_ids)
|
|
|
|
# Find orphaned plugins in main config
|
|
main_plugins = set(main_config.keys())
|
|
orphaned_main = main_plugins - valid_set
|
|
|
|
# Find orphaned plugins in secrets config
|
|
secrets_plugins = set(secrets_config.keys())
|
|
orphaned_secrets = secrets_plugins - valid_set
|
|
|
|
all_orphaned = orphaned_main | orphaned_secrets
|
|
|
|
if all_orphaned:
|
|
# Remove from main config
|
|
for plugin_id in orphaned_main:
|
|
del main_config[plugin_id]
|
|
removed.append(plugin_id)
|
|
|
|
# Remove from secrets config
|
|
for plugin_id in orphaned_secrets:
|
|
del secrets_config[plugin_id]
|
|
|
|
# Save updated configs
|
|
if orphaned_main:
|
|
self.save_raw_file_content('main', main_config)
|
|
if orphaned_secrets:
|
|
self.save_raw_file_content('secrets', secrets_config)
|
|
|
|
self.logger.info(f"Cleaned up orphaned plugin configs: {', '.join(all_orphaned)}")
|
|
|
|
return removed
|
|
|
|
except Exception as e:
|
|
self.logger.error(f"Error cleaning up orphaned plugin configs: {e}")
|
|
return removed
|
|
|
|
def validate_all_plugin_configs(self, plugin_schema_manager=None) -> Dict[str, Dict[str, Any]]:
|
|
"""
|
|
Validate all plugin configurations against their schemas.
|
|
|
|
Args:
|
|
plugin_schema_manager: Optional SchemaManager instance for validation
|
|
|
|
Returns:
|
|
Dict mapping plugin_id to validation results: {
|
|
'valid': bool,
|
|
'errors': list of error messages
|
|
}
|
|
"""
|
|
results = {}
|
|
|
|
if not plugin_schema_manager:
|
|
return results
|
|
|
|
try:
|
|
main_config = self.get_raw_file_content('main')
|
|
|
|
for plugin_id, plugin_config in main_config.items():
|
|
if not isinstance(plugin_config, dict):
|
|
continue
|
|
|
|
# Skip non-plugin config sections
|
|
if plugin_id in ['display', 'schedule', 'timezone', 'plugin_system']:
|
|
continue
|
|
|
|
schema = plugin_schema_manager.load_schema(plugin_id, use_cache=True)
|
|
if schema:
|
|
is_valid, errors = plugin_schema_manager.validate_config_against_schema(
|
|
plugin_config, schema, plugin_id
|
|
)
|
|
results[plugin_id] = {
|
|
'valid': is_valid,
|
|
'errors': errors
|
|
}
|
|
else:
|
|
results[plugin_id] = {
|
|
'valid': True, # No schema = can't validate, but not an error
|
|
'errors': []
|
|
}
|
|
|
|
except Exception as e:
|
|
self.logger.error(f"Error validating plugin configs: {e}")
|
|
|
|
return results |