signal-bot/signal_bot/pack_holder.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

62 lines
2.4 KiB
Python

# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
"""The one mutable box the pack lives in, so a new photo is visible at once.
``pack_command.pack_handler`` used to close over a frozen ``Pack``. That was
right while the only writer was ``tool/tagger.py`` and a restart followed
every change; with ``!add_photo`` it means a photo somebody just added stays
invisible to their own command until the unit is restarted. Every pack
handler therefore reads ``holder.pack`` at call time instead of capturing it.
What a swap may and may not change is the load-bearing part. Custom tags
never become commands, so a swap only ever replaces *Pack data* -- it never
re-registers a trigger and never recomputes ``Command.groups``. That is what
makes immediate availability cheap, and it is the property to preserve: the
moment a swap could add a command, it could also add one to the wrong group.
``reload`` never raises. A handler that raised here would take the exception
to the dispatcher, which logs and moves on -- but the album would already be
half-swapped, and ``Restart=always`` turns a startup-time ConfigError into a
loop. Failing back onto the pack that was already working is the only
behaviour that degrades safely.
"""
from __future__ import annotations
import logging
from dataclasses import dataclass
from typing import TYPE_CHECKING
from signal_bot.groups import ConfigError
from signal_bot.pack_load import load
if TYPE_CHECKING:
from signal_bot.pack import Pack
logger = logging.getLogger(__name__)
@dataclass(slots=True)
class PackHolder:
"""A mutable reference to the album every handler reads through."""
pack: Pack
def reload(self) -> bool:
"""Re-read the album from disk and publish it if it is servable.
Returns:
True when the new pack is live, False when the old one is still
being served because the directory no longer loads.
"""
directory = self.pack.directory
try:
fresh = load(directory)
except ConfigError:
# The path that keeps the bot alive after a bad write: the files
# are rolled back by the caller and the album in memory is the
# one that was already answering.
logger.exception("photo pack %s no longer loads; keeping the previous one", directory)
return False
self.pack = fresh
return True