signal-bot/fake_signal/routes_control.py
Krzysztof kuhy Rudnicki aefffb2fd9
Some checks are pending
CI / check (push) Waiting to run
feat: add a photo to the album from the chat, tagged, stripped and verified
Send a photo captioned "!add_photo alfa wakacje" in one of the album's own
groups and it lands in the pack tagged with both, retrievable through !alfa
and the new !losowe immediately -- no restart, and no tagger session on the PC.
A label matching nobody becomes a custom tag, and !losowe is the only door to
one, which is what keeps a live swap a *data* swap: it can never register a
trigger or widen a command's groups.

No typed label travels. Labels become pseudonym keys in a new registry
arg_resolver, at the dispatcher, before the line that logs the command name --
so no handler, journal entry, command_uses row or reply body ever holds a word
somebody typed. The reply is counts and pseudonyms: "dodano · p1: 4 · t1: 1".

Stripping is exiftool with a *positive* check on the output, never an exit
code. ffmpeg was tried first and fails silently on photos: given a JPEG with a
real APP1 Exif segment it returned a byte-identical file, GPS intact, exit 0.
The surviving-tag allowlist is per tag *name* rather than per group, because
measurement showed a group-level "must be empty" rule rejects every format
except JPEG -- a valid PNG always reports its IHDR, an MP4 some fifty QuickTime
tags that are the container itself. Codec configuration (CompressorName,
VendorID, the HEVC parameter set) is on the list by decision: CompressorName
lives in the avc1 sample description and exiftool cannot write it at all, so
the alternative was refusing every video and every iPhone HEIC. Location and
identity tags are still refused, and the e2e run re-reads the stored files to
prove a QuickTime geotag did not survive.

.webm and .svg stay on the format allowlist and are stored *unstripped*:
exiftool 13.55 can write neither, and its SVG reader does not even surface
<metadata>. That is a deliberate, documented hole, not an oversight.

Two things this had to defuse along the way:
- personal_data_sources now reads custom.json, so "!add_photo kot <photo>"
  would have outlawed the word "kot" and refused every future commit, fixable
  only by hand-editing an album the committer cannot see. Minting now refuses
  a word that is already a command, and the gate subtracts the repo's own
  alias vocabulary from custom labels only -- curated people.json names are
  never excused.
- signal_bot/external.py is now the single subprocess site in the repository,
  so ruff's S603 needs exactly one scoped per-file-ignore instead of one per
  module that shells out. A test asserts nothing else imports subprocess.

A failed add changes nothing: media and the three manifests are written, the
album is reloaded, and only a load that succeeds is published; a load that
fails rolls all four back and keeps serving the pack that was already working,
without raising -- Restart=always would turn a ConfigError into a loop.

977 tests, 100% branch coverage, no omits and no suppressions. scripts/e2e.sh
gains 8 scenarios driven against the real exiftool on media generated at run
time, and asserts the invariants a reply cannot: that a refused upload is not
stored, that a message with no attachment leaves custom.json byte-identical,
and that signal-cli's own copy of every ingested attachment is gone.

Closes TODO-add-photo.md.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01JqqE22jp94B1ypwxppdr1o
2026-08-31 11:20:00 +02:00

112 lines
4.1 KiB
Python

# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
"""The injector's control plane. Not part of the real API."""
from __future__ import annotations
import base64
from typing import TYPE_CHECKING, Any
from fastapi import APIRouter, Request
if TYPE_CHECKING:
from fake_signal.state import State
def _state(request: Request) -> State:
"""Return the State attached to the running app."""
state: State = request.app.state.fake
return state
def build_control_router() -> APIRouter:
"""Build the router the scenario injector drives."""
router = APIRouter(prefix="/_control")
@router.post("/inject")
async def inject(request: Request, frame: dict[str, Any]) -> dict[str, int]:
delivered = 0
for socket in list(_state(request).sockets):
await socket.send_text(str(frame["raw"]))
delivered += 1
return {"delivered": delivered}
@router.post("/connection")
async def set_connection(request: Request, body: dict[str, Any]) -> dict[str, bool]:
"""Cut or restore signal-cli's connection to Signal."""
state = _state(request)
state.connection_alive = bool(body.get("alive", True))
return {"alive": state.connection_alive}
@router.post("/groups")
async def set_groups(request: Request, groups: list[dict[str, Any]]) -> dict[str, int]:
"""Replace the group list, so the group picker can be rehearsed offline."""
state = _state(request)
state.groups.clear()
state.groups.extend(groups)
return {"groups": len(state.groups)}
@router.post("/groups/add")
async def add_groups(request: Request, groups: list[dict[str, Any]]) -> dict[str, int]:
"""Add groups without disturbing the existing ones.
Additive on purpose. A scenario that declares only the group it
cares about would otherwise silently remove the others -- and with
the bot dropping a departed group's rows, that would delete state
every later scenario in the same process depends on.
"""
state = _state(request)
known = {group.get("id") for group in state.groups}
state.groups.extend(group for group in groups if group.get("id") not in known)
return {"groups": len(state.groups)}
@router.post("/accounts")
async def set_accounts(request: Request, accounts: list[str]) -> dict[str, int]:
"""Seed the registered accounts, so /v1/groups answers at all."""
state = _state(request)
state.accounts.clear()
state.accounts.extend(accounts)
return {"accounts": len(state.accounts)}
@router.get("/sent")
async def captured(request: Request) -> list[dict[str, Any]]:
return list(_state(request).sent)
@router.post("/reset")
async def reset(request: Request) -> dict[str, str]:
_state(request).reset()
return {"status": "ok"}
@router.get("/ready")
async def ready(request: Request) -> dict[str, int]:
return {"sockets": len(_state(request).sockets)}
_add_attachment_routes(router)
return router
def _add_attachment_routes(router: APIRouter) -> None:
"""Attach the inbound-attachment control endpoints.
Split out to keep the builder under the complexity cap.
"""
@router.post("/attachment")
async def put_attachment(request: Request, body: dict[str, Any]) -> dict[str, int]:
"""Put one inbound attachment into the container's store.
base64 rather than raw bytes so a scenario's fixture can be generated
at run time by scripts/e2e.sh -- no binary file enters this repo.
"""
state = _state(request)
attachment_id = str(body["id"])
state.stored[attachment_id] = base64.b64decode(str(body["base64"]))
if attachment_id not in state.attachments:
state.attachments.append(attachment_id)
return {"stored": len(state.stored)}
@router.get("/attachments")
async def stored_attachments(request: Request) -> list[str]:
"""Which attachment ids still have bytes behind them."""
return sorted(_state(request).stored)