announcer/config.py
Kent c4a15799dd Mesh: én sentral fordeler til flere soner
Flere anlegg – hovedscene, resepsjon, crew – og ett sted å sende fra, med
avkryssing for hvilke soner meldingen skal til.

Sentralen er en vanlig announcer med [zones] i config. En sone er en vanlig
announcer med ANNOUNCER_MESH_SECRET. Samme image, ingen mode, og en sone kan
brukes alene hvis sentralen faller ut. Hver avhengighet med C-kode har
aarch64-wheel i uv.lock, så det samme bildet går på en Raspberry Pi uten å
kompilere noe.

Sentralen syntetiserer én gang og sender ferdig WAV (POST /api/play,
multipart). Sonen trenger da verken nett, edge-tts eller Pipers 670 MB for
det den får – Item.wav er hele endringen i avspillingen. Køene forblir per
sone: dispatcheren har egen tråd og egen kø, leverer til hver sone i hver sin
tråd med timeout, og går videre. En opptatt hovedscene holder ikke igjen
resepsjonen, og en sone som er nede feiler alene – synlig per sone i UI og
revisjonslogg.

Auth gjenbrukes: ny leverandør mesh på header X-Mesh-Key (ikke Bearer – den
leses av JWT-leverandøren, som avviser alt som ikke er et JWT før neste får
prøve), med én handling, play. To regler som fulgte med:

- play følger aldri med «alt åpent». Uten det kunne hvem som helst POSTe en
  WAV til en åpen sone og få den spilt. Testen for åpen modus fanget det.
- En legitimasjon som vises fram og er feil gir 401 også der gjester ellers
  har lov. Før slapp en feil PIN i åpen modus stille gjennom som gjest.

mesh teller ikke som innlogging for folk: en sone med bare nøkkelen har
fortsatt åpen side lokalt.

Planlagte sendinger husker sonene sine og fordeles gjennom dispatcheren;
planen ender som sent hvis minst én sone tok imot, med «hovedscene: kø #3,
crew: nede» som note.

Hodeløs Pi: install.sh kjører loginctl enable-linger, ellers finnes ikke
lydsocketen når ingen logger inn. docs/mesh.md tar også raspi-config for
jack framfor HDMI.

38 nye tester, 148 totalt. Fordelingen testes uten nett med stubbet
transport; selve HTTP-en testes mot en levende werkzeug-server, så den
håndrullede multiparten møter Flask sin parser. Verifisert i compose med
sentral og to soner: til alle, bare til én, og én sone stoppet.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
2026-10-09 02:22:05 +02:00

307 lines
11 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

#!/usr/bin/env python3
"""Konfigurasjon: valgfri config.toml pluss miljøvariabler.
Appen virker helt uten config.toml – da gjelder DEFAULTS, som er den gamle
oppførselen: ingen innlogging, norsk tekst, samme mapper som før.
Tre lag, der det siste vinner:
DEFAULTS -> config.toml -> ANNOUNCER_*-miljøvariabler
Hemmeligheter (PIN, JWT-nøkkel, OIDC-client_secret) hører hjemme i det siste
laget, så de kan stå i systemd-enheten istedenfor i en fil som ligger i repoet.
Egen modul fordi både announcer.py og auth.py trenger den; ville blitt en
import-sirkel om den bodde i announcer.py.
"""
from __future__ import annotations
import copy
import os
import tomllib
from pathlib import Path
from typing import Any, Callable
HERE = Path(__file__).resolve().parent
# Alt man kan få lov til å gjøre. Roller er navngitte knipper av disse.
# «play» er bare for mesh: en sentral som leverer en ferdig WAV til en sone.
ACTIONS = ("view", "preview", "announce", "schedule", "stop", "clear", "play")
DEFAULTS: dict[str, Any] = {
"app": {
"title": "Announcer",
"subtitle": "Skriv meldingen, forhåndslytt, og send den ut på anlegget.",
"accent": "#4fd1c5",
"idle_text": "Stille · ingenting i kø",
"message_placeholder": "Skriv meldingen som skal leses opp …",
"max_chars": 600,
"quick_phrases": [],
"default_voice": "finn",
"default_chime": "dingdong",
},
"paths": {
"voices": str(HERE / "voices"),
"cache": str(HERE / "cache"),
"chimes": str(HERE / "chimes"),
"log": str(HERE / "logs" / "announcements.jsonl"),
"state": str(HERE / "instance"),
"schedule": str(HERE / "data" / "scheduled.json"),
},
"audio": {
# pw-play --target / paplay --device. Tom = systemets standardutgang.
"sink": "",
},
"server": {
"host": "0.0.0.0",
"port": 8090,
# Settes bare når appen står bak HTTPS. Styrer Secure-flagget på
# sesjonscookien; på i rå HTTP betyr ingen innlogging i det hele tatt.
"behind_tls": False,
"secret_key": "",
# Full URL utenfra, trengs for OIDC redirect_uri bak en proxy.
"public_url": "",
},
"schedule": {
# Slingringsmonn etter planlagt tid. Tråden våkner med noen sekunders
# mellomrom, og en kjapp omstart skal ikke miste en sending. Mer enn
# dette for sent regnes som gått glipp av, og sendes ikke – et utrop
# om noe som skjedde for en time siden er feil å spille.
"grace_seconds": 120,
"max_days_ahead": 30,
# Hvor ofte vi ser etter forfalte sendinger.
"tick_seconds": 20,
},
# Mesh: én sentral som fordeler til flere soner. [zones] settes bare på
# sentralen (navn -> URL, eller "local" for eget anlegg); hemmeligheten
# settes på sentralen OG hver sone. Begge tomme = ingen mesh, alt som før.
"zones": {},
"mesh": {
"secret": "",
"timeout_seconds": 5,
"poll_seconds": 2,
},
"auth": {
# Tom liste = alt åpent. Se active_providers(): en leverandør er også
# aktiv når den er ferdig konfigurert, så det holder å sette
# ANNOUNCER_PIN eller ANNOUNCER_JWT_SECRET.
"providers": [],
},
"auth.pin": {
"pin": "",
# admin, så dagens PIN-brukere beholder stopp og tøm kø.
"role": "admin",
"label": "PIN",
"hint": "",
},
"auth.jwt": {
"issuer": "",
"audience": "",
"secret": "",
"jwks_url": "",
"algorithms": ["HS256"],
"role_claim": "roles",
"name_claim": "",
"default_role": "",
# Hvor lenge en sesjon fra /auth/token varer, i sekunder.
"session_seconds": 43200,
"leeway": 30,
},
"auth.oidc": {
"issuer": "",
"client_id": "",
"client_secret": "",
"scopes": ["openid", "profile", "email"],
"role_claim": "roles",
"name_claim": "",
"default_role": "",
# Settes bare hvis panelet mangler discovery.
"authorization_endpoint": "",
"token_endpoint": "",
"jwks_url": "",
"end_session_endpoint": "",
"label": "Logg inn",
},
"roles": {
"anonymous": [],
"crew": ["view", "preview", "announce", "schedule"],
"admin": ["*"],
# Sentralen når den snakker med en sone. view er for statuspollingen.
"mesh": ["play", "view"],
},
}
def _bool(v: str) -> bool:
return v.strip().lower() in ("1", "true", "yes", "on", "ja")
def _list(v: str) -> list[str]:
return [p.strip() for p in v.replace(",", " ").split() if p.strip()]
# Miljøvariabel -> (sti i konfigtreet, konvertering).
ENV: dict[str, tuple[tuple[str, str], Callable[[str], Any]]] = {
"ANNOUNCER_TITLE": (("app", "title"), str),
"ANNOUNCER_SUBTITLE": (("app", "subtitle"), str),
"ANNOUNCER_ACCENT": (("app", "accent"), str),
"ANNOUNCER_MAX_CHARS": (("app", "max_chars"), int),
"ANNOUNCER_DEFAULT_VOICE": (("app", "default_voice"), str),
"ANNOUNCER_DEFAULT_CHIME": (("app", "default_chime"), str),
"ANNOUNCER_VOICES": (("paths", "voices"), str),
"ANNOUNCER_CACHE": (("paths", "cache"), str),
"ANNOUNCER_CHIMES": (("paths", "chimes"), str),
"ANNOUNCER_LOG": (("paths", "log"), str),
"ANNOUNCER_SCHEDULE": (("paths", "schedule"), str),
"ANNOUNCER_STATE": (("paths", "state"), str),
"ANNOUNCER_SINK": (("audio", "sink"), str),
"ANNOUNCER_HOST": (("server", "host"), str),
"ANNOUNCER_PORT": (("server", "port"), int),
"ANNOUNCER_BEHIND_TLS": (("server", "behind_tls"), _bool),
"ANNOUNCER_SECRET_KEY": (("server", "secret_key"), str),
"ANNOUNCER_PUBLIC_URL": (("server", "public_url"), str),
"ANNOUNCER_AUTH": (("auth", "providers"), _list),
"ANNOUNCER_MESH_SECRET": (("mesh", "secret"), str),
"ANNOUNCER_PIN": (("auth.pin", "pin"), str),
"ANNOUNCER_PIN_ROLE": (("auth.pin", "role"), str),
"ANNOUNCER_JWT_ISSUER": (("auth.jwt", "issuer"), str),
"ANNOUNCER_JWT_AUDIENCE": (("auth.jwt", "audience"), str),
"ANNOUNCER_JWT_SECRET": (("auth.jwt", "secret"), str),
"ANNOUNCER_JWT_JWKS_URL": (("auth.jwt", "jwks_url"), str),
"ANNOUNCER_JWT_ALGORITHMS": (("auth.jwt", "algorithms"), _list),
"ANNOUNCER_JWT_ROLE_CLAIM": (("auth.jwt", "role_claim"), str),
"ANNOUNCER_JWT_DEFAULT_ROLE": (("auth.jwt", "default_role"), str),
"ANNOUNCER_OIDC_ISSUER": (("auth.oidc", "issuer"), str),
"ANNOUNCER_OIDC_CLIENT_ID": (("auth.oidc", "client_id"), str),
"ANNOUNCER_OIDC_CLIENT_SECRET": (("auth.oidc", "client_secret"), str),
"ANNOUNCER_OIDC_SCOPES": (("auth.oidc", "scopes"), _list),
"ANNOUNCER_OIDC_ROLE_CLAIM": (("auth.oidc", "role_claim"), str),
"ANNOUNCER_OIDC_DEFAULT_ROLE": (("auth.oidc", "default_role"), str),
}
def _merge(base: dict, over: dict) -> dict:
"""Dyp fletting. Lister erstattes, de slås ikke sammen."""
out = dict(base)
for k, v in over.items():
if isinstance(v, dict) and isinstance(out.get(k), dict):
out[k] = _merge(out[k], v)
else:
out[k] = v
return out
def _flatten_tables(raw: dict) -> dict:
"""[auth.pin] i TOML blir {"auth": {"pin": …}}; vi vil ha "auth.pin" flatt.
Det gjør oppslag i resten av koden kjedelig enkelt, og det er bare auth
som har undertabeller.
"""
out = dict(raw)
auth = out.get("auth")
if isinstance(auth, dict):
rest = {}
for k, v in auth.items():
if isinstance(v, dict):
out[f"auth.{k}"] = _merge(out.get(f"auth.{k}", {}), v)
else:
rest[k] = v
out["auth"] = rest
return out
class Config:
def __init__(self, data: dict[str, Any], source: Path | None = None) -> None:
self.data = data
self.source = source
# -- oppslag ----------------------------------------------------------
def section(self, name: str) -> dict[str, Any]:
return self.data.get(name, {})
def get(self, section: str, key: str, default: Any = None) -> Any:
return self.data.get(section, {}).get(key, default)
@property
def app(self) -> dict[str, Any]:
return self.section("app")
@property
def roles(self) -> dict[str, list[str]]:
return self.section("roles")
def path(self, key: str) -> Path:
return Path(self.get("paths", key)).expanduser()
# -- auth -------------------------------------------------------------
def active_providers(self) -> list[str]:
"""Hvilke innloggingsmetoder som gjelder, i rekkefølge.
En metode er aktiv når den er nevnt i auth.providers *eller* når den er
ferdig konfigurert. Den siste halvdelen er det som gjør at
ANNOUNCER_PIN=1234 alene fortsatt slår på PIN, slik det har virket før,
og at et JWT-oppsett ikke må nevnes to steder.
"""
listed = [str(p).strip().lower() for p in self.get("auth", "providers", [])]
out: list[str] = []
for name in ("mesh", "pin", "jwt", "oidc"):
if name in listed or self.configured(name):
out.append(name)
# Rekkefølgen i config vinner for de som er nevnt der.
out.sort(key=lambda n: listed.index(n) if n in listed else len(listed))
return out
def configured(self, provider: str) -> bool:
s = self.section(f"auth.{provider}")
if provider == "pin":
return bool(str(s.get("pin", "")).strip())
if provider == "jwt":
return bool(s.get("secret") or s.get("jwks_url"))
if provider == "oidc":
return bool(s.get("client_id") and (s.get("issuer") or s.get("authorization_endpoint")))
if provider == "mesh":
return bool(str(self.get("mesh", "secret", "")).strip())
return False
@property
def zones(self) -> dict[str, str]:
"""Sonene på en sentral, i konfigurert rekkefølge. Tom = ingen mesh."""
raw = self.section("zones")
return {str(k): str(v).strip() for k, v in raw.items() if str(v).strip()}
def permissions(self, roles: tuple[str, ...]) -> frozenset[str]:
"""Rollenavn -> handlinger. "*" betyr alt."""
out: set[str] = set()
for role in roles:
for action in self.roles.get(role, []):
if action == "*":
return frozenset(ACTIONS)
if action in ACTIONS:
out.add(action)
return frozenset(out)
def load(path: str | Path | None = None) -> Config:
"""Leser konfigurasjonen. Manglende config.toml er helt greit."""
if path is None:
path = os.environ.get("ANNOUNCER_CONFIG", HERE / "config.toml")
path = Path(path).expanduser()
data = copy.deepcopy(DEFAULTS)
source: Path | None = None
if path.is_file():
with path.open("rb") as fh:
data = _merge(data, _flatten_tables(tomllib.load(fh)))
source = path
for env, ((section, key), cast) in ENV.items():
raw = os.environ.get(env)
if raw is None or not raw.strip():
continue
try:
data[section][key] = cast(raw.strip())
except (TypeError, ValueError) as e:
raise SystemExit(f"{env}: ugyldig verdi {raw!r} ({e})") from e
return Config(data, source)