signal-bot/DOCS-commands.md
Krzysztof kuhy Rudnicki 6ec746fad2 feat: a word the bot does not know gets an answer, and gets kept
An unrecognised "!word" was dropped in silence, which made a typo
indistinguishable from the bot being down and threw away the best available
list of commands worth writing. Three things now happen at the one place in
dispatcher.py that used to be a bare `return`.

A near miss is corrected -- "!cta" asks whether you meant "!kot". The
distance is optimal string alignment rather than difflib's ratio: a
transposition is the typo people actually make, it costs one edit here, and
it shreds the matching blocks a ratio counts ("!cta"/"!cat" scores 0.75 but
"!cta"/"!kot" scores 0.50, so no cutoff separates them on principle).

A word with no near miss points at !zaproponuj, which files an idea from
inside the group. Either way the word and the message are recorded, and the
management page grows an Ideas tab that lists them.

Three things stay silent, each for its own reason. "!kot ladny" is a real
trigger with words after it and always has been silent. "!!" is punctuation.
And a command claimed in some *other* group is neither answered nor recorded
-- the album's triggers are real people's names, and pack_scoping.yaml says
it out loud: a refusal would itself announce that the album exists. The
existence check is therefore global, which is what pack_add already asks.

Measured rather than guessed, against the shipped aliases.json:

- a minimum candidate length, because "!ja" is one edit from ~40 of the 676
  two-letter words somebody could type; 69 of them got a suggestion before
  the rule and 18 after.
- the two-edit budget starts at six characters, not five. At five it put
  four pairs of *different* commands within reach of each other --
  !pies/!popes, !days/!cats, !dzis/!dni, !mnie/!dni -- and costs nothing to
  give up, because every real typo this was written for is one edit away.
  test_no_two_commands_are_within_reach_of_each_other fails if a future
  alias reopens the gap.

Both new tables are keyed on the envelope's own sent_at_ms, never the wall
clock: signal-cli replays undelivered frames on reconnect, and a clock-keyed
table collects a duplicate row per reconnect instead of ignoring one.

The branch is gated on should_count -- which excludes the bot's own envelope,
and that is the loop guard, since handle() checks is_own nowhere else -- and
wrapped in its own try/except, because it runs above the one that wraps a
handler and Bot.listen has no exception handling of its own.

Suggestions live in SQLite, not in a tracked file, and the export goes to the
state directory. check_personal_data learns the names it refuses from the
live database, so it catches a name somebody has typed and cannot catch a
misspelling of one -- and an unrecognised-command corpus is made of
misspellings. A group-writable file in a public tree is both a leak and a
wedge. The export therefore carries
deliberate !zaproponuj notes in full and unrecognised words as counts only;
bodies stay on the loopback-only page.

Verified on the live bot: restarted, both tables created with every existing
row count unchanged, !cta and !zaproponuj !pogoda delivered through
/_selftest, both rows read back out of the live database, and the journal
names neither the word nor the body.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01416TegJ3sa8xL5qGGgrygP
2026-08-31 16:48:26 +02:00

4.3 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
suggest !zaproponuj !propozycja !sugestia !suggest !pomysl

Aliases live in signal_bot/aliases.json, not in source, because they are data: adding one should never mean touching Python. Two constraints on a new one. It is subtracted from the personal-data gate's word list by _repo_vocabulary(), so it must not be name-shaped; and tests/test_nearest.py fails if it lands within edit distance of a different command's trigger, because the near-miss suggestion below would then be a coin toss.

A word nothing claims

An unrecognised !word used to be dropped in silence, which made a typo indistinguishable from the bot being down. Now it is answered, and kept:

  • within one edit (two, from six characters up) of a real trigger, the bot asks whether that is what you meant — !cta → chodziło o !kot? The distance is optimal string alignment rather than difflib's ratio, because a transposition costs one edit there and shreds the matching blocks a ratio counts.
  • otherwise it points at !zaproponuj, which files the idea.
  • either way the word and the message go into unknown_commands, which the management page shows. That is the list of commands worth writing next.

Three things stay silent, and each for its own reason. !kot ładny is a real trigger with words after it, and always has been silent. !! and !? are punctuation, not a mistyped command. And a command scoped to some other group — the album's, whose triggers are real people's names — is neither answered nor recorded, because a refusal would announce that the album exists.

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 and DOCS-add-photo.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.