mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-04 06:15:09 +00:00
* fix(sports): share the ESPN rejected-range memo with the background service BackgroundDataService always sent a season range first and, on a 400, fell back to chunks without recording the rejection, so every background season fetch spent a doomed request and live scoreboards learned nothing from it (or it from them). The worker now consults and sets the same 6-hour memo fetch_espn_scoreboard() uses: a known rejection goes straight to month/day chunks, and if every chunk fails the range is asked once for a real error without re-spending the chunks. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(web): keep plugin asset and action routes inside their directories POST /plugins/assets/upload, GET /plugins/assets/list and POST /plugins/assets/delete joined the request's plugin_id onto assets/plugins unchecked, so '../../config' created, wrote, listed and deleted outside it. #561 guarded only the route that serves the files. All three now go through path_safety.resolve_under and answer 400 for anything but a plain name, and delete only unlinks a metadata path that resolves into that plugin's uploads directory. PluginManager.get_plugin_directory refuses ids that are not one plain path segment, so /plugins/action (which runs a manifest script from the returned directory) and every other caller get the guard; the action route also rejects such ids up front, covering its no-manager fallback. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(web): report a no-op plugin update as already up to date update_plugin() returns True both for a real update and for "nothing to do" (a ZIP-installed monorepo plugin already at the registry version, a bundled plugin). With no git commit to compare, POST /plugins/update called every such success "updated successfully", so Check & Update All counted most official plugins as updated on every run. The route now reads what changed off the plugin itself (commit, else manifest version, else last_updated) and returns data.update_status (updated / up_to_date / local_only). The update-all toast is summarised by PluginInstallManager.summarizeUpdateResults from that status, falling back to the message for older servers. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(sports): scoreboard scroll speed no longer follows target_fps sports_scroll computed the crisp speed ladder against the global target_fps whenever limit_refresh_rate_hz was the 100 Hz default. Since frame-locked presentation (#545) the helper steps a fixed number of whole pixels per presented frame and the panel presents at its real refresh, so the General tab's "Scroll Frame Rate" became a speed multiplier: 60 ran a 50 px/s scoreboard at 100 px/s, 200 ran it at 25 px/s. The ladder now uses the display manager's refresh_hz, then display.hardware.limit_refresh_rate_hz, then the default. target_fps is not consulted. Docstrings now say scroll_delay is ignored for pacing (no behaviour change there) and describe the fixed-step model. Tests: replace the tests that pinned target_fps as the ladder refresh and described time-based stepping; assert speed independence from target_fps (unit and end-to-end presented px/s against the real helper), that the fixed per-frame step is applied, and that scroll_delay does not change speed. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(web): escape registry and upload values in plugin manager inline handlers The store, saved-repository and custom-registry buttons built onclick='...(${JSON.stringify(id)})...'. JSON.stringify leaves ' alone, so a custom registry entry whose id contained ' closed the attribute and added its own handler. One helper, jsStringAttr(), now HTML-escapes the JSON literal for every one of those handlers, and the store View button opens only http(s) repo links. The live window.updateImageList (plugins_manager.js loads last, so its copy wins over the file-upload widget's) wrote the uploaded file's original name, path and ids into markup raw; they are escaped now. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(changelog): note plugin asset, action and inline handler guards Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(update): let the root pip wrapper install web_interface/requirements.txt Update Code, the automatic update's health check and Install Base Requirements install web_interface/requirements.txt through safe_pip_install.sh, which only allowed the root requirements.txt. The first commit changing that file would fail its dependency install, and the automatic updater rolls back any update whose dependencies did not install -- on every device, for every newer commit. The wrapper now lists both core requirement files. Only their folders are resolved, so a requirements.txt symlinked out of the project is compared by its target and refused (previously the root file's own symlink target was what got allowed). The updater's file list is a named constant, and a test runs the real wrapper (pip stubbed) on every file Update Code and the rollback install. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(web): do not retry plugin requests that got an HTTP answer PluginAPI.request wrapped everything that was not a structured error as NETWORK_ERROR: a proxy's 502 HTML page (response.json() throws) and a JSON error without error_code included. Check & Update All retries NETWORK_ERROR, so those updates were re-sent five more times with backoff, contrary to the #587 contract that an HTTP error response is the server's answer. NETWORK_ERROR now means only that fetch() rejected. Any HTTP response without an error_code, or with a body that is not JSON, is API_ERROR with the HTTP status attached. Tested against the shipped api_client.js. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(scroll): restart the stats window when an idle gap is dropped by size #582 dropped an idle gap from the frame stats two ways: the reset_scroll() sentinel, which also restarts the 5s window timer, and a size guard for scrollers that never call reset_scroll(), which did not. On that path the first real frame after the gap found the boundary overdue and logged a stats line for a one-frame window. Both paths now share one seeding helper. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(update): leave plugins alone when update_core's own rollback fails update_core returns rollback_failed directly when a partial pull or an update whose health check never started cannot be rolled back. run() only held plugins back for 'verifying', so those devices still got new plugin versions and a display restart on top of a core in an unknown state -- the opposite of what the health-check path does, and of the 3.4.0 changelog (plugins are left alone if the rollback fails). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(api): make the REST reference match the api_v3 package Every documented request body, query parameter and response shape was re-checked against the handlers in web_interface/blueprints/api_v3/. Fixes calls that failed as documented (repo_url, action_id/params, files/image_id, font_file+font_family, ?font=, cache key, auto_enable_ap_mode, plugin limit keys), removes the font-override endpoints dropped in #566, corrects response shapes (plugins/config, plugins/schema, health, metrics, operation history, github-status, fonts/catalog, cache/list, logs, wifi, on-demand, SSE streams), and adds the 26 routes it omitted (backup, system auto-update/git, wifi radio, starlark editor, MQTT bridge, status endpoints, skins). Documents the merge semantics of partial JSON saves to /config/main and /plugins/config and the dim-schedule POST accepting GET's days shape, which land in the same change set. Replaces app.py line numbers and the removed api_v3.py path with file and function names. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(web): remove the General-tab plugin system toggles that did nothing plugin_system.auto_discover, auto_load_enabled and development_mode had General-tab toggles whose help tips promised dormant plugins and verbose logging, but nothing reads them: every enabled plugin is discovered and loaded regardless. Remove the three toggles. The keys stay tolerated in stored configs. The save handler now stores a flag only when a client sends it; treating a missing key as an unchecked box would otherwise rewrite all three to false on every General-tab save, which still posts plugins_directory. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * refactor(scroll): remove dead code left by #523/#570 - Drop the optional scipy.ndimage import and HAS_SCIPY; nothing read them since the numpy blend replaced the scipy path. - Drop ScrollHelper._last_integer_position and frame_time_target, which were written but never read. - Keep target_fps and set_target_fps() but document them as informational: nothing paces off them, yet ledmatrix-elections' test_scroll_pacing.py reads helper.target_fps back and third-party plugins may call the setter. - Fix stale comments: fixed_pixels_per_frame's "use scroll_delay to throttle", set_sub_pixel_scrolling's "default: True", and set_frame_based_scrolling's claim that it steps. The plugins monorepo was grepped for every removed name; none is used. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(fonts): point plugins at plugin_manager.font_manager; drop removed overrides UI FONT_MANAGER.md told plugins to read display_manager.font_manager, which does not exist, so a plugin following it failed to load with AttributeError. The shared FontManager lives on the PluginManager and BasePlugin._get_font_manager() returns it (with a fallback for harnesses). Also removes the Fonts-tab override workflow and element-override panels that #566 deleted, from FONT_MANAGER.md and WEB_INTERFACE_GUIDE.md. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(store): search via /plugins/store/list?query=; send Content-Type on registry curls /plugins/store/search does not exist (404) and the list endpoint reads query, not q. The registry guide's curl examples omitted the JSON Content-Type, so the handlers saw an empty body and answered 400. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(config): use the shared core-key list in the last three private copies StartupValidator warned "Plugin 'auto_update' is enabled but not found" on every display start with auto-update or a dim schedule on; the reserved plugin-id check missed auto_update, sync, location and the rest; and ConfigManager's (uncalled) orphan cleanup would have deleted display, schedule and auto_update. All three now read src/core_config_keys.py, which also gains CORE_SECRETS_KEYS for the github/youtube secrets sections. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(web): partial JSON saves to /config/main change only what they send A JSON body with one field reset every checkbox in the sections it touched: the MQTT bridge's brightness slider turned off disable_hardware_pulsing, inverse_colors, show_refresh_rate and use_short_date_format, and a timezone-only save turned off web-UI autostart and weekly auto-updates. Missing-means-unchecked now applies only to form posts: form-encoded bodies and the v3 forms, which mark themselves with a hidden __form_section input. Also on the config routes: - vegas_min/max_cycle_duration no longer match the generic *_duration rule, so they stop landing in display_durations and a blank one no longer rejects the whole Display save; - saving from the Raw JSON editor calls start_setup_if_needed like the General form, so enabling auto-update there finishes its setup; - the schedule and dim-schedule POSTs accept the per-day days.<day> shape their GETs return, as well as the flat form keys. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(scripts): install plugin dependencies from the configured plugins directory install_plugin_dependencies.sh scanned only plugins/, but the Plugin Store installs into plugin_system.plugins_directory (default plugin-repos), so the documented "Recommended" fix found 0 plugins on every store install. It now reads plugins_directory from config/config.json (relative to the project root or absolute, default plugin-repos) and also scans plugins/ for dev symlinks, installing a plugin reached through both only once. With set -e alone, `pip ... | tee` took tee's exit status, so a failed pip install was reported as success; set -o pipefail. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs: replace stale API names, line numbers and the api_v3.py path - ADVANCED_FEATURES: StreamManager methods that exist (get_next_segment, take_next_group, refresh, advance_cycle, ...), and the real on-demand status envelope ({status, data: {state, service}}) - app.py:199 / :144 / :607-619 line citations and web_interface/blueprints/api_v3.py (now a package) replaced with file and function names in ADVANCED_FEATURES, CONFIG_DEBUGGING, PLUGIN_ARCHITECTURE_SPEC, PLUGIN_QUICK_REFERENCE, PLUGIN_CONFIGURATION_TABS, TROUBLESHOOTING and web_interface/README - CONFIG_DEBUGGING: partial /config/main saves change only sent keys; use /config/raw/main to replace the file; describe where validation runs - TROUBLESHOOTING: clear_cache.py needs --clear-all (no args only prints usage) Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(scripts): verify the web interface that actually ships, on port 5000 verify_installation.sh failed every healthy install: it required the long-removed web_interface_v2.py and looked for a listener on port 5001, while the web interface binds 5000 (web_interface/start.py). It now checks the files ledmatrix-web.service runs (start_web_conditionally.py, web_interface/start.py, app.py) and port 5000. verify_web_ui.sh had the same 5001 port in its listen check, HTTP probe and printed URLs. Port matches are anchored so :50001 no longer counts as :5000. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(plugins): one display-size contract: display_manager.width/height CLAUDE.md (#580) says to read display_manager.width/height because matrix is None when hardware init fails; the development guide, the safety-harness doc and two DisplayManager docstrings still recommended matrix.width/height. The bundled starlark-apps plugin read matrix.width unguarded, so its magnify recommendation and frame scaling raised in fallback mode (e.g. after the Pi 5 hardware refusal). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(install): make install_service.sh --help print usage instead of installing install_service.sh parsed no arguments, so `sudo ./scripts/install/ install_service.sh --help` (presented as harmless in MIGRATION_GUIDE.md) rewrote ledmatrix.service, ledmatrix-web.service and both update-verify units and enabled/started them. It now handles -h/--help (usage, exit 0, no changes) and rejects any other argument with exit 2 before doing anything. Running it with no arguments, as first_time_install.sh does, is unchanged. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(scroll): describe the fixed-step model and document frame_hold Since #545 a crisp speed from scroll_config.configure() makes the helper advance a fixed whole-pixel step per presented frame with no clock, and the display manager's frame hold is part of the speed. The docs still described the removed wall-clock model: - scroll_config's module and configure() docstrings said speed is applied in time-based mode and that omitting the hold "falls back to fractional pixels"; omitting it actually runs the scroll frame_hold times too fast. - SCROLL_PERFORMANCE.md said ScrollHelper accumulates elapsed time in both modes, and read a 20 ms stats median as missed refreshes although that is a healthy 50 px/s (hold 2) scroll. It now explains the fixed step, the hold-dependent healthy median, that target_fps plays no part, and that a hand-added scroll_pixels_per_second loses to a schema-default pair. - PLUGIN_API_REFERENCE.md documented set_scrolling_state(is_scrolling) without frame_hold; it now documents the parameter (core 3.4.0) with a configure() + set_scrolling_state example. - update_scroll_position/set_scroll_speed and set_scrolling_state docstrings say the same. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(config): mark target_fps legacy; describe what Vegas scroll_delay does - General tab "Scroll Frame Rate" (target_fps) is labelled legacy: after the sports_scroll fix nothing in core scrolling reads it. The field and its API validation stay so saved configs and plugins that read global_config['target_fps'] keep working. CONFIG_REFERENCE says the same. - Vegas frame_based_scrolling/scroll_delay were described as frame-count stepping at ~50 FPS. Neither steps nor sets a frame rate: frame-based mode converts the speed to px per scroll_delay, clamps it to 0.1-5, and still advances by elapsed time, so the applied speed is clamp(scroll_speed * scroll_delay, 0.1, 5) / scroll_delay px/s. The config comments, render_pipeline comment and CONFIG_REFERENCE rows now say so. No behaviour change. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(deps): describe how plugin dependencies are really installed The guides said the web service runs as root, that installs pick --user from os.geteuid(), and quoted a warning and a PluginManager._install_plugin_dependencies() method that don't exist. The web unit runs as the installing user; store installs go through install_requirements_file() and sudo safe_pip_install.sh (root), with a user-level fallback that says so, and load-time installs run in the display service's own (root) interpreter. Manual paths now use the configured plugins directory (plugin-repos/ by default) instead of plugins/, which store installs no longer use, and install_plugin_dependencies.sh is described as scanning that directory. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(update): count local changes one way for the preflight and the pull The automatic update's preflight ignored mode-only changes and anything whose status line contained plugins/ or plugin-repos/, then promised "Automatic updates will not stash your changes". perform_core_update used plain git status (modes count) and ignored only 'plugins/', then ran 'git stash push -- :!plugins', which nothing ever pops. So an edit to a bundled plugin under plugin-repos/, or the installer's chmods on tracked scripts, passed the preflight and was stashed away for good. - auto_update.local_changes() is the one predicate both use: core.fileMode=false, porcelain -z, and plugins/ and plugin-repos/ excluded by leading folder rather than substring (a core file under web_interface/static/v3/js/plugins/ now counts). - Update Code's explicit stash leaves out both plugin folders; the pull's --autostash carries their edits and mode changes across and reapplies them. - The automatic updater calls perform_core_update(stash_local_changes= False), which refuses instead of stashing edits that appeared after the preflight; update_core reports that as 'blocked'. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(scripts): diagnostics follow the web autostart default and api_v3 package #556 made a missing web_display_autostart mean "start" (only an explicit false/off keeps the web interface down), but the diagnostics still said otherwise: diagnose_web_ui.sh reported a missing key as "defaults to false", diagnose_web_interface.sh said the web interface "will not start unless this is set to true" and recommended enabling it, and debug_web_manual.py printed False. Troubleshooting a down web UI pointed users at a non-cause. Both shell scripts now evaluate the setting with the launcher's own autostart_enabled() (inline fallback if it cannot be imported) and report on / off / not set (on) / unparseable config; debug_web_manual.py uses the same function. They also check web_interface/blueprints/api_v3/ __init__.py: api_v3.py became a package in #553, so every healthy checkout was reported as missing a file. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(install): what install_service.sh installs; verify script port; no sudo for --help install_service.sh installs and starts ledmatrix, ledmatrix-web and the update-verify units, not only ledmatrix.service (systemd/README.md, README.md). MIGRATION_GUIDE presented 'sudo install_service.sh --help' as a harmless check; it now shows --help without sudo and warns what a real run does. SSH_UNAVAILABLE_AFTER_INSTALL: verify_installation.sh checks the web interface on port 5000. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(changelog): note update-all, plugin system settings and script fixes Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(display): size the preview after orientation and pixel mappers display_geometry.physical_size claimed to give DisplayManager's answer but only computed cols*chain x rows*parallel. RGBMatrix.width/height are measured after the library's pixel mappers, so a Rotate:90 / orientation 90 chain previewed 128x32 for a 32x128 panel and a U-mapper chain of four 256x32 for 128x64. Model the built-in mappers' size effect as the pinned lib/pixel-mapper.cc does (Rotate, U-mapper, V-mapper, StackToRow, Remap; Mirror and unknown names leave it alone), and move the orientation composition here so DisplayManager and the preview share it. The module docstring no longer claims the sync handshake uses it; that imports only DEFAULT_CHAIN_LENGTH. Audit finding F18. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(display): refuse settings the rgbmatrix library aborts on, on every board The library answers several settings with a NULL matrix or abort() rather than an error, so the display service crash-looped (Restart=on-failure) instead of reaching fallback mode: rows above 64, chain_length above 255 (uint8_t binding setter, documented as "no upper limit"), a misspelled hardware_mapping, and parallel 2-3 on a single-output mapping, reachable from the Display form on the default adafruit-hat(-pwm) mapping. #586 only guarded the Pi 5 subset. - src/matrix_support.py holds the rules for every board (Options::Validate ranges, binding integer types, mapping names and outputs from lib/hardware-mapping.c) plus the Pi 5 ones, and is the one source of the API's numeric ranges. - DisplayManager checks them before building options and raises MatrixSettingsRefused, so a hand-edited config falls back with a logged, reported reason. Emulator mode only warns. - The config API refuses them with a 400 naming the setting; combinations are checked against stored values but reported only when the request sets a field involved. - The hardware status file gains "cause" (settings/library/forced). The fallback log and Display banner give the Pi 5 rebuild hint only for a library failure instead of rebuild + gpio_slowdown advice for every failure; one Pi 5 slowdown recommendation (1-3, start at 1). - The Display form offers classic/classic-pi1 and orientation 90/270 and renders any other stored mapping selected with a warning, so an unrelated save no longer rewrites them; the API accepts 90/270. Audit findings F03, F16, F19, F21. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(display): library limits, template defaults and Pi 5 slowdown - rows 8-64, chain_length 1-255, parallel limited by the mapping's outputs, classic/classic-pi1 mappings and orientation 90/270 documented. - Defaults are the config.template.json values: config migration adds missing keys from the template, so the listed "code defaults" never applied. - One Raspberry Pi 5 gpio_slowdown recommendation: 1-3 in PIO mode, starting at 1. - Troubleshooting describes the refused-settings fallback, and CHANGELOG corrects the Unreleased "no upper limit" entry. Audit findings F19, F20, F21. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(scripts): scroll_speeds.py opens the panel with the service's options --measure and --demo built RGBMatrixOptions from a private copy of the display service's builder that had drifted: gpio_slowdown came from display.hardware (default 2) instead of display.runtime (default 3), and rp1_rio, panel_type, disable_hardware_pulsing, inverse_colors, pixel_mapper_config and orientation were skipped, with different defaults (hardware_mapping "regular", pwm_bits 11). A panel needing a high slowdown was measured -- or garbled -- in a setup the service never drives. The option filling in DisplayManager._setup_matrix moves, unchanged, into DisplayManager.apply_matrix_options(options, config), which _setup_matrix calls and the script reuses (overriding only limit_refresh_rate_hz for --measure). The script now loads the whole config rather than the hardware block. Tests pin the script's options to the service's attribute for attribute. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(scripts): scroll_speeds.py recommends keys the resolver honours The ladder ended by telling users to set display_options.scroll_pixels_per_second. scroll_config ranks that key below the scroll_speed + scroll_delay pair, deliberately, and several plugin schemas default the pair into config, so the advised key was silently ignored (a schema-default 1/0.02 pair plus an advised 66 still resolved to 50 px/s). The advice is now the pair that selects the crisp speed exactly (pixels_per_frame every frame_hold/refresh seconds), explains that the pair outranks scroll_pixels_per_second, and gives the scoreboards' per-league scroll_settings.scroll_speed (px/s) form. Tests resolve the printed pair over a schema-default pair and check it lands on the advertised speed and hold. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs: withdraw the target_fps claim for sports_scroll; fix the Vegas speed formula - SPORTS_UNIFICATION.md still presented honouring global target_fps as sports_scroll's added behaviour and its one user-visible gain; note that it was withdrawn because it had become a speed multiplier. - ADVANCED_FEATURES.md gave Vegas scrolling as (scroll_speed / target_fps) * elapsed; the real rule is scroll_speed px/s by elapsed time, through a 0.1-5 px per scroll_delay clamp when frame_based_scrolling is on. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(changelog): scroll model fixes Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(dev): link-github links plugins from the ledmatrix-plugins monorepo link-github <name> cloned https://github.com/ChuckBuilds/ledmatrix-<name>.git, and those per-plugin repositories no longer exist: official plugins are directories in the ledmatrix-plugins monorepo. It now clones (or pulls) the monorepo once into the dev directory, finds plugins/<name>, plugins/ledmatrix-<name> or the plugin whose manifest id is <name>, and links it under its manifest id. With an explicit repo URL it still links a single-repository plugin as before. dev_plugins.json: github_user is honoured again (monorepo owner, e.g. a fork), plus plugins_repo and plugins_branch; github_pattern, which was documented but never read, is dropped and warned about. Ships dev_plugins.json.example and git-ignores dev_plugins.json, both of which the guide promised. Reading JSON falls back to python3 when jq is missing (get_plugin_id silently returned nothing without jq). update/status/list find the git checkout above a monorepo plugin directory (its .git is not in the plugin dir), and update pulls a shared checkout once. status no longer exits 1 when nothing is broken. Docs: PLUGIN_DEVELOPMENT_GUIDE (quick start, link-github, configuration, workflow, store integration, hello-world link, submission), and the nonexistent scripts/git-hooks/pre-push-plugin-version and scripts/bump_plugin_version.py replaced with the real rule: bump the manifest version and run update_registry.py. scripts/dev/README.md and CLAUDE.md updated to match. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(scripts): monorepo workspace layout; fix_perms and install READMEs MULTI_ROOT_WORKSPACE_SETUP described one sibling repository per plugin; setup_plugin_repos.py links ../ledmatrix-plugins/plugins/* into plugin-repos/ and update_plugin_repos.py pulls only the monorepo, and the workspace file opens LEDMatrix plus ../ledmatrix-plugins. scripts/fix_perms/README.md listed cache directories fix_cache_permissions.sh never touches and a 'ledmatrix' service user that doesn't exist (also in scripts/install/README.md); adds safe_pip_install.sh. install/README: install_service.sh installs the web and update-verify units too. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(update): keep the rollback's pip retries inside the unit time limit The health check reinstalled the previous requirements by trying the next bash path after any failure, including a 600 s pip timeout. Two files, two paths: up to 40 minutes of pip alone, while systemd stops ledmatrix-update-verify.service at TimeoutStartSec=30min -- killing the rollback half-way and leaving the update 'verifying' until the web UI calls it lost. - Like permission_utils.install_requirements_file, only a sudo refusal moves on to the next bash; a pip that ran and failed or timed out is not repeated. The refusal wording is one list (permission_utils.SUDO_REFUSAL_PHRASES), mirrored in the stdlib-only verifier and pinned equal by a test. - All reinstalls in one rollback share a 600 s budget. - WORST_CASE_SECONDS adds up every timeout on the longest path (27.5 min); a test holds it under the unit's TimeoutStartSec and that under the web UI's VERIFY_LOST_SECONDS. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(plugins): prepare plugin configs one way for load, saves, GET, hot reload and dev tools Plugin config was prepared differently depending on how it arrived: - JSON POST /plugins/config built a partial body on schema defaults, so {"enabled": true} reset every other setting of the plugin. It now merges onto the stored section first, as the form path already did. - Legacy-boolean normalization (#588) ran only at load: GET /plugins/config returned the raw boolean, posting it back failed validation, and hot reload handed plugins the raw section (a legacy dynamic_duration: true came back as a boolean). schema_manager.prepare_plugin_config (normalize, then defaults) is now used by PluginManager.load_plugin, both save paths, GET, the save notifications and DisplayController's hot-reload callback. - The JSON save's filter kept only enabled/display_duration/live_priority and dropped a submitted skin, skin_options or vegas_* tuning key. There is now one core-owned per-plugin list, schema_manager.CORE_PLUGIN_PROPERTIES, used by validation and by the save filter; PluginManager's CORE_OWNED_CONFIG_KEYS is its vegas subset. - Plugin sections posted to /config/main were stored verbatim, including values /plugins/config rejects. They now go through the same preparation (_prepare_plugin_config_for_save, extracted from save_plugin_config), and a failing section rejects the whole save before anything is written. - dev_server read only top-level defaults and let a schema enabled:false win; build_full_config shallow-merged overrides, dropping sibling defaults; the harness extracted defaults differently from the device. loading.build_config now uses the device's extraction and preparation, and dev_server, check_plugin, render_plugin and the harness all use it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(mqtt-bridge): brightness changes apply live and touch nothing else The display service's hot reload applies a saved brightness within a few seconds, and /config/main no longer resets other display settings on a brightness-only JSON body. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(changelog): automatic update hardening Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(config): rewrite PLUGIN_CONFIG_ARCHITECTURE for the v3 web UI It described web_interface_v2.py and index_v2.html (both gone), client-side form generation, one POST per field with {key, value}, and 'no nested objects'. The v3 UI renders plugin forms server-side from the schema (pages_v3 partial + plugin_config.html macros, nested sections and x-widgets), posts the whole form once, and save_plugin_config() merges onto the stored section, validates, splits x-secret fields and notifies the plugin. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(mqtt): brightness saves apply via hot reload and leave other settings alone The bridge README said brightness is applied on the display's next restart; the display controller's config hot reload applies it within seconds. It also now states that the bridge's partial JSON save changes only brightness (the /config/main merge fix in this change set). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(update): don't log pip's output from the health check's reinstall pip can echo a private index URL with embedded credentials; permission_utils redacts it, the stdlib-only verifier cannot, so it logs the exit code only. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(config): mark the plugin_system toggles as unused legacy keys auto_discover, auto_load_enabled and development_mode are read by nothing and leave the General tab in this change set (F40). CONFIG_REFERENCE said they were read by the plugin loader; PLUGIN_CONFIGURATION_GUIDE and the REST reference listed them as live settings. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(changelog): docs and developer tools group Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(web): legacy plugin-system toggles no longer count as a General save auto_discover, auto_load_enabled and development_mode have left the General form, so a post carrying only one of them is not a general-settings save and must not treat web_display_autostart and auto_update as unchecked. The plugin_system block itself is left as on main for the branch that reworks it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(changelog): config-save and plugin-config preparation fixes Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * docs(claude): re-check matrix_support.py rules when the library submodule is bumped Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix: address Codacy findings on the core audit PR - plugin_manager.prepare_plugin_config: when the fallback legacy-boolean pass also fails, log a warning instead of a bare except/pass. - api_client.js: request() refuses any endpoint that is not a plain path under /api/v3 ("//host", backslashes, ".." or "." segments, whitespace, control characters) with INVALID_ENDPOINT before calling fetch(), and plugin ids are URL-encoded wherever they are put into a URL (also in the app-shell batch load). - test_update_all.js: pins both against the shipped client. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(web): check endpoint control characters without a control-character regex Codacy (ESLint no-control-regex, Biome noControlCharactersInRegex) flags the \x00-\x1f range in checkEndpoint's regex. Test the char codes instead; the endpoints refused are unchanged. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * test(auto-update): make the seed script executable on disk, not only in the index On Linux Repo.publish() commits with -a, which recorded scripts/run.sh as 100644 upstream because the seed file was never chmod +x. The pull then brought in the same mode the installer chmod had made locally, so installer_chmod saw no mode change left to check. The updater was fine: with the upstream commit at 100755 the --autostash carries the device's chmod across. Verified under Linux (WSL, git 2.43): the old helper fails exactly as CI did, the fixed one passes all 63 tests in the file. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
842 lines
39 KiB
Python
842 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.core_config_keys import CORE_CONFIG_KEYS, CORE_SECRETS_KEYS
|
|
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. Core sections (display,
|
|
# schedule, auto_update, ...) are not plugins and never orphans.
|
|
main_plugins = set(main_config.keys()) - CORE_CONFIG_KEYS
|
|
orphaned_main = main_plugins - valid_set
|
|
|
|
# Find orphaned plugins in secrets config
|
|
secrets_plugins = set(secrets_config.keys()) - CORE_CONFIG_KEYS - CORE_SECRETS_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 core config sections
|
|
if plugin_id in CORE_CONFIG_KEYS:
|
|
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 |