signal-bot/DOCS-commands.md
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

2.9 KiB

Commands

The copy that matters is not this file: !pomoc prints the same list in the group, in Polish, one line of description per command. That version is built from the command registry at run time and cannot drift, because CommandRegistry.register takes the description as a required argument and help_command.render_help prints any command its GROUPS table forgot to file anyway, under no heading.

This file is the trigger reference — every spelling that resolves, which !pomoc deliberately does not print.

Command Aliases
cat !kot !koty !kots !cat !cats !meow !miau + styled variants
dog !pies !psy !dog !dogs !woof !szczek + styled variants
gecko !gekon !gekony !geko !gecko !geckon !geckos
pope !papież !papiez !papieze !papieża !papa !pope !popes !pontifex + styled variants
stats_today !staty !statystyki !stats !dziś !dzis
stats_yesterday !wczoraj !yesterday
stats_week !tydzień !tydzien !week
stats_month !miesiąc !miesiac !month
stats_year !rok !year
stats_records !rekordy !rekord !records
stats_crown !korona !crown
stats_weekdays !dni !days
stats_me !ja !moje !mnie
help !pomoc !pomocy !help !komendy !commands
add_photo !dodaj !dodaj_zdjecie !dodajzdjecie !add_photo !addphoto
random !losowe !losuj !random !rand

Aliases live in signal_bot/aliases.json, not in source, because they are data: adding one should never mean touching Python.

add_photo and random exist only in the photo album's own groups, and only on an installation that has an album at all — everywhere else they are not commands, not refused and never logged. Both take arguments, and those arguments are resolved to pseudonym keys by the registry before any handler, log line or command_uses row sees them. See DOCS-photo-pack.md.

Why !pomoc shows the first alias and not a trigger

Command.triggers is a frozenset of folded skeletons — folding.py runs NFKC, strips diacritics and maps Cyrillic/Greek/small-caps/leet lookalikes onto ASCII, so that !gecko typed on a Russian keyboard still resolves. Everything that makes those triggers robust also makes them unprintable: the set has no order, !papież survives only as !papiez, and the styled variants come out as zalgo.

So Command.primary holds the first raw trigger instead, which aliases.json lists as the canonical Polish spelling for every command.

Two consequences worth remembering, both from folding.py:

  • A command name can never contain a digit — fold maps 0134578 onto letters, so !7dni would resolve as !tdni.
  • The styled Unicode aliases in the table above are redundant now; folding covers them. They are kept because removing an alias can only take something away.