mirror of
https://github.com/kuhyx/signal-bot.git
synced 2026-11-11 14:27:50 +01:00
Some checks are pending
CI / check (push) Waiting to run
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
135 lines
4.7 KiB
Python
135 lines
4.7 KiB
Python
# Copyright (c) 2026 Krzysztof Rudnicki. MIT licence.
|
|
"""Turning the attachments on one message into files inside the album.
|
|
|
|
Split out of pack_add.py at the 250-line cap, along the seam that was already
|
|
there: that half decides *whether* a command runs and what it answers, this
|
|
half does the reading, the stripping and the writing.
|
|
|
|
The order here is the load-bearing part. Media and manifests are written
|
|
first, the album is reloaded second, and only a reload that succeeds is
|
|
published. A reload that fails rolls all four files back and leaves the bot
|
|
serving the pack it was already serving -- and never raises, because
|
|
``Restart=always`` turns a startup-time ConfigError into a restart loop.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
from typing import TYPE_CHECKING
|
|
|
|
from signal_bot.media_sniff import sniff
|
|
from signal_bot.pack_custom import write as write_custom
|
|
from signal_bot.pack_replies import ADDED, ALREADY_THERE, FAILED, NEW_TAG_HINT
|
|
from signal_bot.pack_store import (
|
|
content_name,
|
|
record_adds,
|
|
restore,
|
|
snapshot,
|
|
write_media,
|
|
write_tags,
|
|
)
|
|
|
|
if TYPE_CHECKING:
|
|
from signal_bot.media_strip import Stripper
|
|
from signal_bot.pack_add import AddResolver
|
|
from signal_bot.pack_holder import PackHolder
|
|
from signal_bot.registry import CommandContext
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
async def ingest(
|
|
ctx: CommandContext, holder: PackHolder, stripper: Stripper
|
|
) -> tuple[dict[str, bytes], int]:
|
|
"""Fetch, sniff, strip and name every attachment on the message.
|
|
|
|
Returns:
|
|
The files that are new to the album, and how many were already in it.
|
|
"""
|
|
fresh: dict[str, bytes] = {}
|
|
duplicates = 0
|
|
known = set(holder.pack.tags)
|
|
for attachment_id in ctx.message.attachment_ids:
|
|
payload = await _fetch(ctx, attachment_id)
|
|
cleaned = _clean(payload, stripper)
|
|
if cleaned is not None:
|
|
name, body = cleaned
|
|
if name in known or name in fresh:
|
|
duplicates += 1
|
|
else:
|
|
fresh[name] = body
|
|
return fresh, duplicates
|
|
|
|
|
|
async def _fetch(ctx: CommandContext, attachment_id: str) -> bytes | None:
|
|
"""Read one attachment, then delete signal-cli's own copy of it.
|
|
|
|
Deleted whether the upload is accepted or refused: the point is that no
|
|
copy survives outside the album, and a refused file is exactly the one
|
|
nobody wants left lying in the container.
|
|
"""
|
|
try:
|
|
payload = await ctx.transport.fetch_attachment(attachment_id)
|
|
except Exception:
|
|
logger.exception("could not fetch an attachment")
|
|
payload = None
|
|
try:
|
|
await ctx.transport.delete_attachment(attachment_id)
|
|
except Exception:
|
|
logger.exception("could not delete the server-side attachment copy")
|
|
return payload
|
|
|
|
|
|
def _clean(payload: bytes | None, stripper: Stripper) -> tuple[str, bytes] | None:
|
|
"""Sniff and strip one upload, or None when it is not storable."""
|
|
if payload is None:
|
|
return None
|
|
kind = sniff(payload)
|
|
if kind is None:
|
|
logger.warning("refusing an upload whose format is not on the allowlist")
|
|
return None
|
|
cleaned = stripper.strip(payload, kind)
|
|
if cleaned is None:
|
|
return None
|
|
return content_name(cleaned, kind.suffix), cleaned
|
|
|
|
|
|
async def commit(
|
|
ctx: CommandContext,
|
|
holder: PackHolder,
|
|
resolver: AddResolver,
|
|
keys: tuple[str, ...],
|
|
fresh: dict[str, bytes],
|
|
duplicates: int,
|
|
) -> None:
|
|
"""Write the files and manifests, swap the album, or roll it all back."""
|
|
pack = holder.pack
|
|
directory = pack.directory
|
|
previous = snapshot(directory)
|
|
tags = {name: frozenset(existing) for name, existing in pack.tags.items()}
|
|
for name, body in fresh.items():
|
|
write_media(directory, name, body)
|
|
tags[name] = frozenset(keys)
|
|
write_tags(directory, tags)
|
|
write_custom(directory, resolver.committed(pack.custom))
|
|
record_adds(
|
|
directory,
|
|
{name: {"by": ctx.message.source_uuid, "at": int(ctx.now)} for name in fresh},
|
|
)
|
|
if not holder.reload():
|
|
restore(directory, previous, tuple(fresh))
|
|
await ctx.reply(FAILED)
|
|
return
|
|
await ctx.reply(_receipt(holder, keys, duplicates, minted=bool(resolver.pending)))
|
|
|
|
|
|
def _receipt(holder: PackHolder, keys: tuple[str, ...], duplicates: int, *, minted: bool) -> str:
|
|
"""Counts and pseudonyms only -- never a label, never a filename."""
|
|
pack = holder.pack
|
|
parts = [ADDED]
|
|
parts.extend(f"{key}: {len(pack.matching(frozenset({key})))}" for key in keys)
|
|
if duplicates:
|
|
parts.append(ALREADY_THERE.format(count=duplicates))
|
|
line = " · ".join(parts)
|
|
return f"{line}\n{NEW_TAG_HINT}" if minted else line
|