Matthias Blankertz
aee5a48967
Merge defaults into config at load time to ensure that all config options show up in the configuration dialog, even if they were added after the local configuration was last changed. Also use the merge method to merge the local config with the new config in set_config, ensuring the config contains all keys even if the submitted config leaves some out. Signed-off-by: Matthias Blankertz <matthias@blankertz.org>
110 lines
3.5 KiB
Python
110 lines
3.5 KiB
Python
# SPDX-License-Identifier: MIT
|
|
# Copyright (c) 2025 Matthias Blankertz <matthias@blankertz.org>
|
|
|
|
from errno import ENOENT
|
|
import json
|
|
import os
|
|
try:
|
|
from typing import TYPE_CHECKING, Mapping, Any
|
|
except ImportError:
|
|
TYPE_CHECKING = False
|
|
|
|
|
|
class Configuration:
|
|
DEFAULT_CONFIG = {
|
|
'LED_COUNT': 1,
|
|
'IDLE_TIMEOUT_SECS': 60,
|
|
'TAG_TIMEOUT_SECS': 5,
|
|
'BUTTON_MAP': {
|
|
'PLAY_PAUSE': 4,
|
|
'VOLUP': 0,
|
|
'VOLDOWN': 2,
|
|
'PREV': None,
|
|
'NEXT': 1,
|
|
},
|
|
'TAGMODE': 'tagremains'
|
|
}
|
|
|
|
def __init__(self, config_path='/config.json'):
|
|
self.config_path = config_path
|
|
try:
|
|
with open(self.config_path, 'r') as conf_file:
|
|
self.config = json.load(conf_file)
|
|
self._merge_configs(self.DEFAULT_CONFIG, self.config)
|
|
except OSError as ex:
|
|
if ex.errno == ENOENT:
|
|
self.config = Configuration.DEFAULT_CONFIG
|
|
self._save()
|
|
else:
|
|
raise
|
|
except ValueError as ex:
|
|
print(f"Warning: Could not load configuration {self.config_path}:\n{ex}")
|
|
self._move_config_to_backup()
|
|
self.config = Configuration.DEFAULT_CONFIG
|
|
|
|
def _move_config_to_backup(self):
|
|
# Remove old backup
|
|
try:
|
|
os.remove(self.config_path + '.bup')
|
|
os.rename(self.config_path, self.config_path + '.bup')
|
|
except OSError as ex:
|
|
if ex.errno != ENOENT:
|
|
raise
|
|
os.sync()
|
|
|
|
def _merge_configs(self, default, config):
|
|
for k in default.keys():
|
|
if k not in config:
|
|
if isinstance(default[k], dict):
|
|
config[k] = default[k].copy()
|
|
else:
|
|
config[k] = default[k]
|
|
elif isinstance(default[k], dict):
|
|
self._merge_configs(default[k], config[k])
|
|
|
|
def _save(self):
|
|
with open(self.config_path + '.new', 'w') as conf_file:
|
|
json.dump(self.config, conf_file)
|
|
self._move_config_to_backup()
|
|
os.rename(self.config_path + '.new', self.config_path)
|
|
os.sync()
|
|
|
|
def _get(self, key):
|
|
return self.config[key]
|
|
|
|
def get_led_count(self) -> int:
|
|
return self._get('LED_COUNT')
|
|
|
|
def get_idle_timeout(self) -> int:
|
|
return self._get('IDLE_TIMEOUT_SECS')
|
|
|
|
def get_tag_timeout(self) -> int:
|
|
return self._get('TAG_TIMEOUT_SECS')
|
|
|
|
def get_button_map(self) -> Mapping[str, int | None]:
|
|
return self._get('BUTTON_MAP')
|
|
|
|
def get_tagmode(self) -> str:
|
|
return self._get('TAGMODE')
|
|
|
|
# For the web API
|
|
def get_config(self) -> Mapping[str, Any]:
|
|
return self.config
|
|
|
|
def _validate(self, default, config, path=''):
|
|
for k in config.keys():
|
|
if k not in default:
|
|
raise ValueError(f'Invalid config key {path}/{k}')
|
|
if isinstance(default[k], dict):
|
|
if not isinstance(config[k], dict):
|
|
raise ValueError(f'Invalid config: Value of {path}/{k} must be mapping')
|
|
self._validate(default[k], config[k], f'{path}/{k}')
|
|
|
|
def set_config(self, config):
|
|
self._validate(self.DEFAULT_CONFIG, config)
|
|
if 'TAGMODE' in config and config['TAGMODE'] not in ['tagremains', 'tagstartstop']:
|
|
raise ValueError("Invalid TAGMODE: Must be 'tagremains' or 'tagstartstop'")
|
|
self._merge_configs(self.config, config)
|
|
self.config = config
|
|
self._save()
|