| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468 |
- """Chatto Platform Adapter for Hermes Agent.
- A plugin-based gateway adapter that connects to a Chatto server
- (self-hosted team chat) and relays messages to/from the Hermes agent.
- The adapter uses the chattolib library for all Chatto API interactions,
- including both outbound messaging and realtime WebSocket connections.
- """
- from __future__ import annotations
- import json
- import random
- # Put the vendored dependencies for THIS platform on sys.path before importing
- # anything from chattolib. Imported relatively as part of the plugin package and
- # absolutely when this module is loaded standalone (e.g. by the tests).
- try:
- from .vendor_path import setup_vendor_path
- except ImportError: # pragma: no cover - depends on how the module is loaded
- from vendor_path import setup_vendor_path
- setup_vendor_path()
- import asyncio
- import hashlib
- import logging
- import mimetypes
- import os
- import re
- import tempfile
- from collections import deque
- from collections.abc import AsyncIterator, Callable
- from contextlib import asynccontextmanager
- from dataclasses import dataclass, field
- from datetime import UTC, datetime
- from difflib import SequenceMatcher
- from enum import StrEnum
- from typing import Any, Final, NamedTuple
- from urllib.parse import unquote, urlsplit
- import httpx
- logger = logging.getLogger(__name__)
- from gateway.config import Platform, PlatformConfig
- from gateway.platforms.base import (
- BasePlatformAdapter,
- MessageEvent,
- MessageType,
- ProcessingOutcome,
- SendResult,
- cache_media_bytes,
- get_inbound_media_max_bytes,
- validate_inbound_media_size,
- )
- from gateway.session import build_session_key
- # Chattolib imports (vendored)
- # Using vendored chattolib from vendor/chattolib/
- # See vendor_chattolib.sh for how to update the vendored copy
- # Absolute imports — vendor/ is on sys.path (see above) and chattolib's own
- # modules import each other absolutely. Mixing in relative ".vendor.chattolib"
- # imports would load a second, distinct copy of every module, so isinstance()
- # checks across the two copies would silently fail.
- try:
- from chattolib._pb.chatto.realtime.v1 import ( # noqa: F401 — importability probe
- realtime_pb2,
- )
- from chattolib._pb.chatto.realtime.v1.events_pb2 import (
- MessagePostedEvent, # type: ignore[import-untyped]
- )
- from chattolib.client import (
- ChattoClient,
- )
- from chattolib.exceptions import (
- ChattoAuthError,
- ChattoError,
- )
- from chattolib.realtime import (
- ChattoRealtimeCloseError,
- ChattoRealtimeError,
- RealtimeEvent,
- stream_events,
- )
- from chattolib.types import (
- Message,
- MessageAttachment,
- PresenceStatus,
- Room,
- RoomKind,
- RoomWithViewerState,
- User,
- )
- except ImportError as e:
- # Fail loudly: continuing here only defers the failure to a confusing
- # NameError somewhere deep in the adapter.
- logger.error("Chatto: failed to import vendored chattolib: %s", e)
- raise
- try:
- from .platform_config import (
- ChattoConfiguration,
- ChattoConstants,
- )
- except ImportError: # pragma: no cover - loaded as a top-level module (tests)
- from platform_config import (
- ChattoConfiguration,
- ChattoConstants,
- )
- # --------------------------------------------------------------------------- #
- # Chat types
- # --------------------------------------------------------------------------- #
- class HermesChatType(StrEnum):
- """The ``chat_type`` vocabulary the Hermes gateway understands.
- Declared in ``gateway/session.py:161`` as ``"dm", "group", "channel",
- "thread"`` and consumed as a bare string all over the gateway:
- ``SessionSource.description`` (session.py:239) and the PII-redacting
- description in ``build_session_context_prompt`` (session.py:537) both
- branch on these exact values and fall back to a nameless generic case for
- anything else, and ``build_session_key`` puts the value straight into the
- session key. Passing a chattolib ``RoomKind`` (``"ROOM_KIND_CHANNEL"``)
- therefore does not fail loudly — it just quietly degrades what the agent is
- told about where it is.
- A StrEnum so it stays a drop-in ``str`` at every one of those call sites.
- GROUP vs CHANNEL
- ----------------
- There is no strict contract between the two, and the adapters disagree in
- practice: Slack labels every non-DM conversation ``"group"`` (including real
- channels), Discord uses both, and Telegram reserves ``"channel"`` for actual
- broadcast channels. The intended reading is ``group`` = ordinary
- multi-participant chat, ``channel`` = broadcast surface.
- The distinction only changes behaviour in three places:
- 1. Authorization (``gateway/authz_mixin.py``) — the only security-relevant
- one. The group-scoped env allowlists apply to ``{"group", "forum"}``
- ONLY, never to ``"channel"``: ``{PLATFORM}_GROUP_ALLOWED_USERS`` /
- ``_GROUP_ALLOWED_CHATS`` (:616), the chat-id allowlist (:708) and the
- Telegram legacy shim (:724). The adapter-delegation paths in turn treat
- all three alike (:461, :649, :674, :694), where the value only picks
- ``group_allow_from`` over ``allow_from`` from ``config.extra``.
- For Chatto both choices are equivalent today: those group env maps hold
- Telegram and QQBot only (:535-541), and our own allowlist runs through
- ``CHATTO_ALLOWED_USERS``, which is chat_type-independent.
- 2. What the agent is told — ``SessionSource.description`` renders
- ``"group: Name"`` vs ``"channel: Name"`` (session.py:239-246), likewise
- the PII-redacted variant (session.py:537-544).
- 3. The session key, which embeds the literal (session.py:1192). Changing
- the value for a room re-buckets its existing sessions.
- Explicitly NOT affected: ``is_shared_multi_user_session`` (session.py:1063)
- only looks at ``"dm"`` and ``thread_id``, so sender prefixes, the multi-user
- prompt line and ``group_sessions_per_user`` treat group and channel
- identically.
- """
- DM = "dm"
- GROUP = "group"
- CHANNEL = "channel"
- # Emitted by adapters whose thread events are their own chat type (Slack,
- # Discord). We don't: a Chatto thread keeps its room's chat_type and is
- # identified by ``thread_id`` on the source instead. Listed for the record,
- # because build_session_key rewrites the slot to "thread" itself
- # (session.py:1190).
- THREAD = "thread"
- # Not declared in session.py:161 but real: Telegram forum topics travel as
- # "forum", and the authz group allowlists above accept it alongside "group".
- # Chatto has no equivalent, so we never emit it.
- # Chatto only distinguishes DMs from channels. UNSPECIFIED means the server
- # sent a kind this vendored chattolib doesn't know: map it to the generic
- # multi-user bucket rather than guessing "channel", and never to "dm" — that
- # value drives session isolation (is_shared_multi_user_session, session.py:1063)
- # and would silently turn a room into a private conversation.
- #
- # CHANNEL for RoomKind.CHANNEL is the descriptive choice and carries no
- # behavioural cost (see the GROUP vs CHANNEL note above). Switching to GROUP for
- # Slack parity would be this one line — plus the re-bucketing of existing
- # sessions that point 3 of that note describes.
- _ROOM_KIND_TO_CHAT_TYPE: dict[RoomKind, HermesChatType] = {
- RoomKind.DM: HermesChatType.DM,
- RoomKind.CHANNEL: HermesChatType.CHANNEL,
- RoomKind.UNSPECIFIED: HermesChatType.GROUP,
- }
- def chat_type_for_room_kind(kind: RoomKind | None) -> HermesChatType:
- """Map a chattolib RoomKind onto the gateway's chat_type vocabulary.
- An unknown or missing kind becomes ``GROUP`` — see ``_ROOM_KIND_TO_CHAT_TYPE``.
- """
- if kind is None:
- return HermesChatType.GROUP
- return _ROOM_KIND_TO_CHAT_TYPE.get(kind, HermesChatType.GROUP)
- class RoomPolicy(StrEnum):
- """How a channel-kind room treats an inbound message.
- Derived per room from ``CHATTO_REQUIRE_MENTION_ROOMS`` /
- ``CHATTO_OPTIONAL_MENTION_ROOMS`` — see ``_room_policy``. A StrEnum
- so the values log readably without a formatting dance.
- """
- # Listed for unaddressed answers: every message is dispatched, and one
- # aimed at a named colleague gets a 🫥 acknowledgement instead of a reply.
- OPEN = "open"
- # Listed for addressed-only participation: dispatches only messages that
- # mention the bot (@name or a broadcast handle); others are dropped.
- REQUIRE_MENTION = "require_mention"
- # Listed in neither config: the room is silent — not dispatched at all,
- # read-only like any unlisted membership.
- SILENT = "silent"
- # Blocking filesystem/network helpers. The adapter runs on the shared gateway
- # event loop, so file reads and HTTP downloads are pushed to a worker thread
- # via asyncio.to_thread — a slow disk or dead image URL must not stall every
- # platform's message processing.
- def _read_file_bytes(path: str) -> bytes:
- """Read a whole file synchronously (run via asyncio.to_thread)."""
- with open(path, "rb") as f:
- return f.read()
- def _write_file_bytes(path: str, data: bytes) -> None:
- """Write bytes to a file synchronously (run via asyncio.to_thread)."""
- with open(path, "wb") as f:
- f.write(data)
- def _normalise_outbound_text(content: str) -> str:
- """Normalise outgoing text for Chatto.
- Chatto renders Markdown natively, so there is nothing to escape or
- translate — the only transformations here are the ones that measurably
- render wrong: CRLF line endings (which show up as stray blank lines)
- and runs of more than two blank lines. Shared by the adapter's
- ``format_message`` and the standalone cron sender, so both paths render
- identically.
- """
- if not content:
- return content
- normalised = content.replace("\r\n", "\n").replace("\r", "\n")
- while "\n\n\n\n" in normalised:
- normalised = normalised.replace("\n\n\n\n", "\n\n\n")
- return normalised
- # --------------------------------------------------------------------------- #
- # Adapter
- # --------------------------------------------------------------------------- #
- # Presence as the roster block spells it. UNSPECIFIED gets no label: a server
- # that never tracked presence should not have the roster claim anything.
- _PRESENCE_LABELS = {
- PresenceStatus.ONLINE: "online",
- PresenceStatus.AWAY: "away",
- PresenceStatus.DO_NOT_DISTURB: "do not disturb",
- PresenceStatus.OFFLINE: "offline",
- }
- @dataclass
- class _RoomRoster:
- """One announced room's roster projection.
- A miniature of the server's room membership: which user IDs belong to
- the room (the users themselves live in the shared ``_user_cache``) and
- how many directory entries were beyond the fetch limit, rendered as
- ``… and N more``. Presence changes patch the cached users in place;
- only a membership change or reconnect discards this and refetches.
- """
- member_ids: set[str] = field(default_factory=set)
- unfetched: int = 0
- _UNSEEDED: Final = object()
- """Sentinel: this process has delivered nothing for that thread yet.
- Distinct from a recorded ``None``, which means an *earlier* process seeded the
- thread and its cursor is unknowable here.
- """
- def _messages_after(history: list[Message], cursor_id: str) -> list[Message] | None:
- """The messages ordered after ``cursor_id``, or ``None`` if it is not there.
- ``None`` means the cursor fell out of the fetched window — the thread grew
- past the limit this lookup fetches. The caller must not then re-seed from
- the top: that repeats context the session already holds, which is exactly
- what the cursor exists to prevent.
- """
- for index, message in enumerate(history):
- if message.id == cursor_id:
- return history[index + 1 :]
- return None
- def hermes_adapter_factory(config: PlatformConfig):
- """Construct a ChattoAdapter from a PlatformConfig."""
- return ChattoAdapter(config)
- class ChattoAdapter(BasePlatformAdapter):
- """Chatto platform adapter.
- Receives messages via WebSocket realtime, sends via ConnectRPC.
- """
- # Read by BasePlatformAdapter.max_message_length_for_chat(), which the
- # gateway and the stream consumer use to chunk outgoing messages. Without
- # it they fall back to 4096 and split Chatto messages far earlier than
- # necessary — send() itself already truncates at SPLIT_THRESHOLD.
- MAX_MESSAGE_LENGTH = ChattoConstants.MAX_MESSAGE_LENGTH
- splits_long_messages = True
- supports_code_blocks: bool = True
- supports_status_text: bool = True # client.update_custom_status
- def __init__(self, pconfig: PlatformConfig):
- """Signature needs to be compatible with BasePlatformAdapter.__init__."""
- super().__init__(
- config=pconfig, platform=Platform(ChattoConstants.PLATFORM_NAME)
- )
- # "extra" has been pre-populated by Hermes from config.yaml's extra block.
- # --- Configuration from our configuration data class with some logic ---
- self.chatto_config: ChattoConfiguration = ChattoConfiguration(pconfig)
- # ------ State -------
- # Our own user, filled in by connect(). Events arriving before connect()
- # completes must not blow up on an undefined attribute.
- self.me: User | None = None
- # --- Runtime state ---
- self._room_names: dict[str, str] = {}
- self._room_kinds: dict[str, RoomKind] = {}
- # Event IDs already processed — chattolib may redeliver events across
- # reconnects, so every inbound event is checked against this list.
- # Bounded deques: appending past the cap drops the oldest ID on its own.
- self._seen: deque[str] = deque(maxlen=ChattoConstants.SEEN_CAP)
- # Message IDs this adapter has handed to the gateway (posted or
- # edit-re-dispatched). Edits of anything on this list never start a
- # fresh turn — that is the lock against re-answering settled
- # conversations by editing old messages.
- self._dispatched_ids: deque[str] = deque(maxlen=ChattoConstants.SEEN_CAP)
- # Rooms whose member roster has been projected from the directory —
- # the roster is room-scoped and rides on every channel turn (threads
- # hold isolated sessions, so each turn needs its own copy). Together
- # with _rosters this is our miniature projection of server state:
- # presence changes patch the cached users in place; membership events
- # and reconnects discard a room so its next turn refetches once.
- self._roster_announced: deque[str] = deque(maxlen=ChattoConstants.SEEN_CAP)
- # Announced rooms' membership projection (see _RoomRoster).
- self._rosters: dict[str, _RoomRoster] = {}
- # Thread roots whose history has been handed to their session, mapped to
- # the last message ID that was delivered. Thread sessions start empty, so
- # the first turn into a thread seeds what came before it — a cron message
- # whose echo we filtered as a self-event, or chatter that predates the
- # bot joining. A None value means an earlier process seeded it and this
- # one cannot tell how far it got.
- #
- # The cursor is what makes later turns safe to seed again: the agent's
- # own messages never reach a session (their echo is filtered as a
- # self-event), so a reply it posts into a live thread via
- # chatto_send_room is invisible to that thread forever unless the tail
- # after the cursor is delivered. Re-delivering everything instead would
- # duplicate context on every turn. Insertion-ordered and capped like the
- # seen-ring; unlike the roster this is deliberately NOT discarded on
- # reconnect, since thread history is immutable.
- self._seeded_threads: dict[str, str | None] = {}
- # session_key -> message ID currently being processed there. Written
- # by on_processing_start, cleared by on_processing_complete; an edit
- # landing on the recorded ID is a mid-run correction.
- self._processing: dict[str, str] = {}
- self._joined_room_ids: list[str] = []
- # Rooms the server force-joined everyone into (Room.universal) — used
- # only for [universal] tags in the joined-rooms log line, never for
- # gating.
- self._universal_room_ids: set[str] = set()
- # DM room ID -> chat partner's login, resolved once via the member
- # directory so the joined-rooms summary can name who a DM is with.
- self._dm_partners: dict[str, str] = {}
- # One-shot guard for the unjoined-home-channel warning in _refresh_rooms.
- self._home_warning_logged = False
- self._ws_task: asyncio.Task | None = None
- self._presence_task: asyncio.Task | None = None
- # Persistent typing indicator loops per room
- self._typing_tasks: dict[str, asyncio.Task] = {}
- # Member directory cache: user_id -> user info dict
- self._user_cache: dict[str, User] = {}
- # Handle -> does a user hold it. Cached both ways; see _mentions_someone_else.
- self._known_handles: dict[str, bool] = {}
- # Chattolib client cache and lock for async access.
- self._chatto_client: ChattoClient | None = None
- self._chatto_client_lock: asyncio.Lock = asyncio.Lock()
- # ------------------------------------------------------------------ #
- # Auth
- # ------------------------------------------------------------------ #
- async def _get_chatto_client(self: ChattoAdapter) -> ChattoClient | None:
- """Return the shared ChattoClient, creating and logging in on first use.
- The default way to get a client. The fast path is a plain attribute
- read; first creation runs under a lock so concurrent callers log in
- exactly once. Returns ``None`` when no client exists yet or creation
- failed (bad credentials, unreachable server) — a normal state during
- startup, shutdown and reconnects, not an exceptional one. Callers
- decide what "no client" means for them, as a guard clause:
- client = await self._get_chatto_client()
- if client is None:
- logger.warning("Chatto: dropping X - no client available")
- return
- """
- if self._chatto_client is not None:
- return self._chatto_client
- async with self._chatto_client_lock:
- if self._chatto_client is not None:
- return self._chatto_client
- try:
- client = await self._open_client(
- base_url=self.chatto_config.base_url.value,
- token=self.chatto_config.token.value,
- )
- self._chatto_client = client
- logger.info(
- "Chatto: authenticated via token to '%s'",
- self.chatto_config.base_url.value,
- )
- return client
- except ChattoAuthError as e:
- logger.error("Chatto: authentication failed: %s", e)
- return None
- except (ChattoError, ValueError) as e:
- logger.error("Chatto: failed to create client: %s", e)
- return None
- async def _require_chatto_client(self) -> ChattoClient:
- """Return a ChattoClient or raise RuntimeError if unavailable.
- The exception-flavoured variant of :meth:`_get_chatto_client`, for
- callers whose surrounding machinery already routes exceptions.
- Currently that is only the realtime event loop, whose except chain
- turns the raise into a logged warning plus a backed-off reconnect —
- no special "no client" branch needed there. Everywhere else, prefer
- the ``is None`` guard shown in :meth:`_get_chatto_client`.
- """
- client = await self._get_chatto_client()
- if client is None:
- raise RuntimeError("Chatto client unavailable")
- return client
- # ------------------------------------------------------------------ #
- # Connection
- # ------------------------------------------------------------------ #
- async def _open_client(
- self,
- *,
- base_url: str,
- token: str | None = None,
- ) -> ChattoClient:
- """Return a connected ``ChattoClient`` using a bearer token.
- Raises ValueError when no token is configured — caught upstream as a
- normal creation failure, so misconfiguration reads as a logged error
- instead of a crash.
- """
- if not token:
- raise ValueError("Chatto: CHATTO_TOKEN not configured")
- return ChattoClient(token=token, base_url=base_url)
- async def connect(self, *, is_reconnect: bool = False) -> bool:
- """Connect to Chatto and start the realtime event stream.
- BasePlatformAdapter override
- """
- logger.info("Chatto: connecting...")
- client = await self._get_chatto_client()
- if client is None:
- self._set_fatal_error(
- "connect_failed", "Chatto client not available", retryable=True
- )
- return False
- # Get our first own user info
- try:
- self.me = await client.me()
- except Exception as exc:
- logger.error("Chatto: failed to get user info: %s", exc)
- self._set_fatal_error(
- "chatto_auth_failed",
- f"Chatto auth failed: {exc}",
- retryable=False,
- )
- try:
- if self._chatto_client is not None:
- await self._chatto_client.close()
- finally:
- self._chatto_client = None
- return False
- # Announce online presence so the bot appears online in the member list.
- # The server treats this as a TTL, so _presence_refresh_loop below has to
- # keep re-announcing it — a single call here lapses back to offline.
- await self._announce_online()
- self._closing = False
- # Start background realtime WS event stream loop.
- self._ws_task = asyncio.create_task(
- self._chattolib_event_loop(),
- name="chatto-event-stream",
- )
- self._presence_task = asyncio.create_task(
- self._presence_refresh_loop(),
- name="chatto-presence-refresh",
- )
- self._mark_connected()
- logger.info(
- "Chatto: connected to %s as '%s' (display_name: '%s' id: '%s')",
- self.chatto_config.base_url.value,
- self.me.login,
- self.me.display_name,
- self.me.id,
- )
- return True
- async def _announce_online(self) -> bool:
- """Tell the server we are online. Returns whether the call got through.
- Logged at warning level on failure: a silently dropped presence call is
- indistinguishable from a bot that is simply not running.
- """
- client = await self._get_chatto_client()
- if client is None:
- logger.warning(
- "Chatto: presence refresh failed, bot may appear offline: no client"
- )
- return False
- try:
- await client.set_presence(status=PresenceStatus.ONLINE)
- return True
- except Exception as exc:
- logger.warning(
- "Chatto: presence refresh failed, bot may appear offline: %s", exc
- )
- return False
- async def _presence_refresh_loop(self) -> None:
- """Re-announce ONLINE until disconnect, since presence expires server-side.
- Failures are not fatal — the next tick tries again, so a blip in the
- presence endpoint costs at most one interval of visible offline time.
- """
- while not self._closing:
- await self._sleep_interruptible(ChattoConstants.PRESENCE_REFRESH_INTERVAL)
- if self._closing:
- return
- await self._announce_online()
- async def disconnect(self) -> None:
- """Stop WebSocket, presence refresh, typing tasks, and clear state.
- BasePlatformAdapter override
- """
- # No explicit offline broadcast: chattolib rejects OFFLINE outright
- # ("stop refreshing to go offline"), so cancelling the refresh loop
- # below is what actually takes the bot offline.
- self._closing = True
- # Cancel all typing tasks
- for chat_id in list(self._typing_tasks.keys()):
- await self.stop_typing(chat_id)
- if self._ws_task and not self._ws_task.done():
- self._ws_task.cancel()
- try:
- await self._ws_task
- except (asyncio.CancelledError, Exception):
- logger.debug(
- "Chatto: websocket task ended during disconnect", exc_info=True
- )
- self._ws_task = None
- if self._presence_task and not self._presence_task.done():
- self._presence_task.cancel()
- try:
- await self._presence_task
- except (asyncio.CancelledError, Exception):
- logger.debug(
- "Chatto: presence task ended during disconnect", exc_info=True
- )
- self._presence_task = None
- if self._chatto_client:
- try:
- await self._chatto_client.close()
- except Exception:
- logger.exception("Chatto: error closing client")
- finally:
- self._chatto_client = None
- logger.info("Chatto: disconnected")
- self._mark_disconnected()
- async def _seed_room(self, room_id: str) -> None:
- """Seed high-water mark from the newest events so a restart doesn't replay history."""
- try:
- client = await self._get_chatto_client()
- if client is None:
- logger.debug(
- "Chatto: _seed_room aborted - no client available for %s", room_id
- )
- return
- timeline_page = await client.get_room_events(room_id)
- for ev in timeline_page.events:
- if ev.id:
- self._mark_seen(ev.id)
- logger.debug(
- "Chatto: seeded room %s with %d events",
- room_id,
- len(timeline_page.events),
- )
- except Exception as e:
- logger.warning("Chatto: get room events failed for %s: %s", room_id, e)
- # ------------------------------------------------------------------ #
- # Realtime Event List
- # ------------------------------------------------------------------ #
- def _mark_seen(self, event_id: str) -> None:
- # The deque's maxlen evicts the oldest ID — no manual trimming.
- self._seen.append(event_id)
- def _is_seen(self, event_id: str) -> bool:
- return event_id in self._seen
- # ------------------------------------------------------------------ #
- # WebSocket Realtime Transport
- # ------------------------------------------------------------------ #
- def _own_handles(self) -> set[str]:
- """The handles that address this bot, lowercased for comparison.
- Chatto resolves mentions case-insensitively (FDR-006), so ``@Hermes_Bot``
- and ``@hermes_bot`` are the same handle everywhere in our gates.
- """
- if not self.me:
- return set()
- return {
- handle.lower() for handle in (self.me.login, self.me.display_name) if handle
- }
- def _mention_candidates(self, body: str) -> list[str]:
- """Candidate @-handles in a message body, in order of appearance.
- Mirrors the Chatto web frontend's extraction (apps/frontend/src/lib/
- mentions.ts upstream): candidates come from ``ChattoConstants.
- MENTION_RE`` outside code regions. Mentions inside fenced code blocks
- and inline code spans do not resolve upstream either, so a ``@bob``
- quoted in a snippet must not gate our behaviour.
- """
- without_fences = re.sub(r"(?s)(```|~~~).*?(\1|$)", " ", body)
- without_code = re.sub(r"`[^`\n]*`", " ", without_fences)
- return ChattoConstants.MENTION_RE.findall(without_code)
- def _mentions_me(self, body: str) -> bool:
- """Whether the message addresses this bot.
- By login, by display name, or by a broadcast handle — ``@here`` speaks
- to everyone present and the bot is one of them, so naming a colleague
- alongside it does not take the bot out of the audience. Matching is
- case-insensitive, like every mention resolution in Chatto.
- """
- own = self._own_handles()
- for handle in self._mention_candidates(body):
- lowered = handle.lower()
- if lowered in own or lowered in ChattoConstants.BROADCAST_MENTIONS:
- return True
- return False
- async def _handle_belongs_to_a_user(self, handle: str) -> bool:
- """Whether ``handle`` is the login of a real Chatto user.
- The API carries no mention entities — ``mention_confirmation_token`` is
- reserved in the message descriptor — so an @-token is only a candidate
- until the directory confirms it. Results are cached both ways under the
- lowercased handle (the mention namespace is case-insensitive per
- FDR-006), since the same handles recur and a miss is as reusable as a
- hit. Only logins are looked up: matching another user's display name,
- as the web frontend does against its room member list, has no directory
- equivalent here.
- """
- cache_key = handle.lower()
- known = self._known_handles.get(cache_key)
- if known is not None:
- return known
- client = await self._get_chatto_client()
- if client is None:
- # Unresolved means "not confirmed", so the message goes through.
- return False
- try:
- member = await client.admin_get_member(login=handle)
- except Exception as exc:
- logger.debug("Chatto: could not resolve handle @%s: %s", handle, exc)
- return False
- # admin_get_member returns pb_to_dict(GetMemberResponse):
- # {"member": {"user": {...}, ...}, "roles": [...]} when found,
- # or {} when not found.
- if not member.get("member"):
- self._known_handles[cache_key] = False
- return False
- from chattolib.types import User
- user = User.parse(member["member"].get("user"))
- self._known_handles[cache_key] = user is not None
- return user is not None
- async def _mentions_someone_else(self, body: str) -> bool:
- """Whether the message @-mentions a person who is not this bot.
- Broadcast handles are not a person — they address everyone present,
- the bot included, so they do not count as someone else. A handle no
- user holds is not a mention at all: someone writing *about* mentioning
- ("per @-mention", "@nonexistent") is talking to us, and staying silent
- on a false positive is worse than answering one.
- """
- own = self._own_handles()
- for handle in self._mention_candidates(body):
- lowered = handle.lower()
- if lowered in ChattoConstants.BROADCAST_MENTIONS:
- continue
- if lowered in own:
- continue
- if await self._handle_belongs_to_a_user(handle):
- return True
- return False
- def _check_auth(self, user: User) -> bool:
- """Whether this Chatto user may talk to the agent.
- Deliberately our own gate instead of the gateway's authz_mixin: its
- group allowlists key on chat_type and per-platform env vars
- (``{PLATFORM}_GROUP_ALLOWED_USERS``), none of which fit Chatto's one
- flat member directory. ``CHATTO_ALLOWED_USERS`` matches login and id,
- ``CHATTO_ALLOW_ALL_USERS`` overrides both — the gate stays
- chat_type-independent by design.
- """
- if self._is_authorized(user.id, user.login):
- return True
- logger.warning(
- "Chatto: rejecting message from unauthorized user '%s' (%s)",
- user.login,
- user.id,
- )
- return False
- # ------------------------------------------------------------------ #
- # Room management over DM (/join, /leave)
- # ------------------------------------------------------------------ #
- _DM_COMMANDS = ("/join", "/leave")
- async def _handle_dm_command(self, room_id: str, body: str) -> bool:
- """Run a ``/join`` or ``/leave`` admin command sent as a direct message.
- Returns True when ``body`` is one of the commands — whether it
- succeeded or not — so the caller keeps it out of the agent pipeline.
- Membership lives on the Chatto server: a joined room reappears in
- every future ``list_rooms()`` and therefore survives restarts.
- """
- verb, _, argument = body.strip().partition(" ")
- if verb.lower() not in self._DM_COMMANDS:
- return False
- client = await self._get_chatto_client()
- if client is None:
- await self.send(chat_id=room_id, content="Chatto client is not connected.")
- return True
- argument = argument.strip()
- if not argument:
- await self.send(
- chat_id=room_id,
- content="Usage: /join <room-id or #name> | /leave <room-id or #name>",
- )
- return True
- error, target = await self._resolve_room_target(client, argument)
- if error or target is None:
- await self.send(chat_id=room_id, content=error or "Room lookup failed.")
- return True
- if verb.lower() == "/join":
- reply = await self._run_join(client, target)
- else:
- reply = await self._run_leave(client, target)
- await self.send(chat_id=room_id, content=reply)
- return True
- async def _resolve_room_target(
- self,
- client: ChattoClient,
- argument: str,
- ) -> tuple[str | None, RoomWithViewerState | None]:
- """Resolve a ``/join`` or ``/leave`` argument to a room.
- ``#name`` is looked up case-insensitively in a fresh directory scan
- (which also refreshes our name/kind caches); anything else is treated
- as a room ID and verified via GetRoom. An ambiguous name comes back as
- an error naming the candidates, so the admin can retry with an ID.
- """
- if not argument.startswith("#"):
- state = await client.get_room(argument)
- if state is None or state.room is None:
- return f"No room with ID '{argument}'.", None
- return None, state
- wanted = argument[1:].strip().casefold()
- # (state, room) pairs: a listed match's room is already narrowed here,
- # so the candidate listing below needs no fresh Optional dance.
- matches: list[tuple[RoomWithViewerState, Room]] = []
- for state in await client.list_rooms() or []:
- room_obj = state.room if state else None
- if room_obj and (room_obj.name or "").strip().casefold() == wanted:
- matches.append((state, room_obj))
- self._room_names[room_obj.id] = room_obj.name
- self._room_kinds[room_obj.id] = room_obj.kind
- if not matches:
- return f"No room named '{argument}'.", None
- if len(matches) > 1:
- candidates = "\n".join(f"• {room.name} ({room.id})" for _, room in matches)
- return (
- f"Several rooms are named '{argument}' — pick one by ID:\n{candidates}"
- ), None
- return None, matches[0][0]
- async def _run_join(self, client: ChattoClient, state: RoomWithViewerState) -> str:
- """Join a room via RoomService/JoinRoom and track it as joined.
- An account that already holds membership (invited natively in Chatto)
- needs no JoinRoom call — it only gets seeded and added to the list.
- Channel-kind rooms additionally report their mention-list status,
- because a channel on neither list stays silent and this reply is
- where users copy the room ID from (see ``_room_join_hint``).
- """
- room_obj = state.room
- if room_obj is None:
- # Unreachable via _resolve_room_target: both of its paths only
- # return states whose room they already inspected.
- return "Chatto returned an empty room record — try again."
- label = f"'{room_obj.name}' ({room_obj.id})"
- joined_room = room_obj
- if not state.viewer_state.is_member:
- try:
- joined_room = await client.join_room(room_obj.id) or room_obj
- except ChattoError as exc:
- logger.warning("Chatto: /join failed for %s (%s)", room_obj.id, exc)
- return f"Could not join {label}: {exc}"
- self._room_names[joined_room.id] = joined_room.name
- self._room_kinds[joined_room.id] = joined_room.kind
- if joined_room.id not in self._joined_room_ids:
- # Same rule as _refresh_rooms: silent rooms are joined read-only
- # — seeding history nothing will ever answer would be waste.
- if self._answers_in_room(joined_room.id):
- await self._seed_room(joined_room.id)
- else:
- logger.info(
- "Chatto: %s is on neither mention list - joined read-only",
- label,
- )
- self._joined_room_ids.append(joined_room.id)
- if room_obj.kind != RoomKind.DM:
- head = (
- f"Already a member of {label}."
- if state.viewer_state.is_member
- else f"Joined {label}."
- )
- return f"{head}\n{self._room_join_hint(room_obj.id)}"
- if state.viewer_state.is_member:
- return f"Already a member of {label} — listening there."
- return f"Joined {label}."
- async def _run_leave(self, client: ChattoClient, state: RoomWithViewerState) -> str:
- """Leave a room via RoomService/LeaveRoom and drop it from the joined list.
- Two rooms are refused: a DM conversation cannot be left, and leaving
- the configured home channel would silently break cron/notification
- delivery, which posts there through the standalone sender.
- """
- room_obj = state.room
- if room_obj is None:
- # Same invariant as _run_join: _resolve_room_target pre-inspects.
- return "Chatto returned an empty room record — try again."
- label = f"'{room_obj.name}' ({room_obj.id})"
- if room_obj.kind == RoomKind.DM:
- return "Direct messages cannot be left."
- home_id = (self.chatto_config.home_channel.value or "").strip()
- if home_id == room_obj.id:
- return (
- f"{label} is the configured home channel "
- "(CHATTO_HOME_CHANNEL); leaving it would break cron and "
- "notification delivery. Point CHATTO_HOME_CHANNEL elsewhere first."
- )
- try:
- left = await client.leave_room(room_obj.id)
- except ChattoError as exc:
- logger.warning("Chatto: /leave failed for %s (%s)", room_obj.id, exc)
- return f"Could not leave {label}: {exc}"
- if not left:
- return f"Chatto refused to leave {label}."
- if room_obj.id in self._joined_room_ids:
- self._joined_room_ids.remove(room_obj.id)
- # We are no longer part of this audience; keep no roster for it.
- self._evict_roster(room_obj.id)
- return f"Left {label}."
- def _room_join_hint(self, room_id: str) -> str:
- """The mention-list status appended to a channel-kind /join reply.
- Users do not know their room IDs by heart — this reply is where they
- copy them from, so a silent channel names both env vars verbatim,
- ready to paste into ~/.hermes/.env. Configuration resolves once at
- gateway startup, hence the restart note.
- """
- policy = self._room_policy(room_id)
- if policy == RoomPolicy.REQUIRE_MENTION:
- return (
- "This channel answers only @mentions "
- "(listed in CHATTO_REQUIRE_MENTION_ROOMS)."
- )
- if policy == RoomPolicy.OPEN:
- return (
- "This channel answers every message "
- "(listed in CHATTO_OPTIONAL_MENTION_ROOMS)."
- )
- return (
- "This channel stays silent until you list its ID in"
- " ~/.hermes/.env (then restart the gateway):\n"
- f" CHATTO_REQUIRE_MENTION_ROOMS={room_id} <- answer only @mentions\n"
- f" CHATTO_OPTIONAL_MENTION_ROOMS={room_id} <- answer every message"
- )
- # ------------------------------------------------------------------ #
- # Inbound attachments
- # ------------------------------------------------------------------ #
- async def _download_attachment_bytes(self, url: str) -> bytes:
- """Download an attachment, refusing to buffer more than the gateway cap.
- The Content-Length header is checked first so an oversized asset is
- rejected before a single chunk is read; the running total is re-checked
- as chunks arrive, because a missing or lying header must not smuggle an
- unbounded body past the cap.
- """
- max_bytes = get_inbound_media_max_bytes()
- chunks: list[bytes] = []
- total = 0
- async with (
- httpx.AsyncClient(
- timeout=ChattoConstants.HTTP_TIMEOUT,
- follow_redirects=True,
- ) as http,
- http.stream("GET", url) as resp,
- ):
- resp.raise_for_status()
- declared = resp.headers.get("content-length")
- if declared:
- try:
- declared_size = int(declared)
- except ValueError:
- logger.debug("Chatto: ignoring invalid Content-Length %r", declared)
- else:
- validate_inbound_media_size(
- declared_size,
- media_type="attachment",
- max_bytes=max_bytes,
- )
- async for chunk in resp.aiter_bytes():
- total += len(chunk)
- validate_inbound_media_size(
- total,
- media_type="attachment",
- max_bytes=max_bytes,
- )
- chunks.append(chunk)
- return b"".join(chunks)
- async def _cache_attachments(
- self,
- attachments: list[MessageAttachment],
- ) -> tuple[list[str], list[str], list[str]]:
- """Download message attachments into the gateway media cache.
- Returns ``(media_urls, media_types, media_kinds)`` — the paths are
- agent-visible cache paths, exactly what ``cache_media_bytes`` yields for
- every other platform. A failing attachment is logged and skipped: the
- message itself still reaches the agent.
- """
- media_urls: list[str] = []
- media_types: list[str] = []
- media_kinds: list[str] = []
- for att in attachments:
- url = att.asset_url.url if att.asset_url else ""
- filename = att.filename
- content_type = att.content_type
- if not url:
- # Videos are announced before transcoding finishes, so the
- # signed URL can legitimately be missing on arrival.
- logger.debug(
- "Chatto: attachment '%s' has no asset URL yet, skipping",
- filename,
- )
- continue
- try:
- data = await self._download_attachment_bytes(url)
- cached = cache_media_bytes(
- data,
- filename=filename,
- mime_type=content_type,
- )
- except Exception as e:
- logger.warning(
- "Chatto: failed to cache attachment '%s' (%s): %s",
- filename,
- content_type,
- e,
- )
- continue
- if cached is None:
- logger.warning(
- "Chatto: attachment '%s' (%s) could not be cached, skipping",
- filename,
- content_type,
- )
- continue
- media_urls.append(cached.path)
- media_types.append(cached.media_type)
- media_kinds.append(cached.kind)
- return media_urls, media_types, media_kinds
- @staticmethod
- def _message_type_for_media_kinds(media_kinds: list[str]) -> MessageType:
- """Pick the MessageType for a set of cached attachment kinds."""
- if "document" in media_kinds:
- return MessageType.DOCUMENT
- if "image" in media_kinds:
- return MessageType.PHOTO
- if "video" in media_kinds:
- return MessageType.VIDEO
- if "audio" in media_kinds:
- return MessageType.AUDIO
- return MessageType.TEXT
- async def _room_kind_for(
- self, client: ChattoClient, room_id: str
- ) -> RoomKind | None:
- """The room's kind, from cache or a fresh GetRoom lookup.
- Returns ``None`` when the room cannot be resolved — the caller treats
- that as "not dispatchable" rather than guessing a kind.
- """
- kind = self._room_kinds.get(room_id)
- if kind is not None:
- return kind
- room_viewer_state = await client.get_room(room_id)
- if room_viewer_state is None or room_viewer_state.room is None:
- return None
- kind = room_viewer_state.room.kind or RoomKind.UNSPECIFIED
- self._room_kinds[room_id] = kind
- return kind
- def _room_policy(self, room_id: str) -> RoomPolicy:
- """Which of the mention lists a channel-kind room is on.
- The two lists are mutually exclusive (enforced by
- ``hermes_validate_config``), so membership decides: optional beats
- require in the face of contradictory runtime config, and a room on
- neither list stays silent. Callers that only need yes/no ask
- ``_answers_in_room``, which delegates to the shared ``_room_answers_in``
- the send tools use.
- """
- if room_id in self.chatto_config.optional_mention_rooms.value:
- return RoomPolicy.OPEN
- if room_id in self.chatto_config.require_mention_rooms.value:
- return RoomPolicy.REQUIRE_MENTION
- return RoomPolicy.SILENT
- def _answers_in_room(self, room_id: str) -> bool:
- """Whether inbound messages from this room reach the agent pipeline.
- Delegates to the shared ``_room_answers_in``, which the send tools gate
- on too — see there for the rule and why it exists only once. A room
- that answers is never read-only (its policy is not SILENT), and an
- unknown kind falls through to the mention lists rather than being
- mistaken for a DM.
- """
- return _room_answers_in(
- self.chatto_config, room_id, self._room_kinds.get(room_id)
- )
- async def _room_roster_context(
- self, client: ChattoClient, room_id: str
- ) -> _RoomRoster | None:
- """Fetch the room's member roster as a fresh projection.
- The agent only ever sees its prompt: without this block it cannot know
- who else is in a channel, because unaddressed messages are dropped by
- mention gating long before they could teach it a name. Fetched users go
- into _user_cache so presence patching and mention resolution share one
- store. Returns ``None`` on failure or when nothing renderable remains —
- best-effort by design, a directory hiccup must never cost the turn.
- """
- try:
- # list_room_members() in 0.5.0b4 returns member IDs only;
- # batch_get_room_members() hydrates them into DirectoryMember.
- member_id_list, page = await client.list_room_members(
- room_id, limit=ChattoConstants.ROSTER_MEMBER_LIMIT
- )
- if not member_id_list:
- return None
- members = await client.batch_get_room_members(room_id, member_id_list)
- except Exception:
- logger.debug(
- "Chatto: could not list members of room %s", room_id, exc_info=True
- )
- return None
- logger.debug(
- "Chatto: roster for room %s: %d members fetched, total_count=%d",
- room_id,
- len(members),
- page.total_count,
- )
- member_ids: set[str] = set()
- users: list[User] = []
- for member in members:
- user = member.user
- if user is None or user.deleted:
- continue
- member_ids.add(user.id)
- self._user_cache[user.id] = user
- users.append(user)
- entries = [
- entry for entry in (self._roster_entry(user) for user in users) if entry
- ]
- if not entries:
- logger.debug(
- "Chatto: roster for room %s empty after filtering "
- "(%d fetched, all deleted/self/without user)",
- room_id,
- len(members),
- )
- return None
- logger.debug("Chatto: roster for room %s: %d entries", room_id, len(entries))
- unfetched = max(0, page.total_count - len(members))
- return _RoomRoster(member_ids=member_ids, unfetched=unfetched)
- def _roster_entry(self, user: User) -> str:
- """One roster entry, e.g. ``@bob (Bob Example, online)``.
- Skips deleted users and our own account (the agent knows itself);
- display name and presence are optional parts of the parenthetical.
- """
- if user.deleted:
- return ""
- if self.me is not None and user.id == self.me.id:
- return ""
- entry = f"@{user.login}"
- details = [
- part
- for part in (
- user.display_name,
- _PRESENCE_LABELS.get(user.presence_status, ""),
- )
- if part
- ]
- if details:
- entry += f" ({', '.join(details)})"
- return entry
- def _roster_line(self, room_id: str) -> str:
- """Render the room's roster line from its cached projection."""
- roster = self._rosters.get(room_id)
- if roster is None:
- return ""
- users = [self._user_cache.get(member_id) for member_id in roster.member_ids]
- entries = [
- entry
- for entry in (
- self._roster_entry(user) for user in users if user is not None
- )
- if entry
- ]
- more = f" … and {roster.unfetched} more" if roster.unfetched else ""
- return ", ".join(entries) + more
- def _announce_roster(self, room_id: str, roster: _RoomRoster) -> None:
- """Record a freshly fetched roster as the room's projection.
- Bounded like _dispatched_ids: appending past the cap drops the oldest
- room's projection alongside its deque entry.
- """
- if room_id not in self._roster_announced:
- oldest = (
- self._roster_announced.popleft()
- if len(self._roster_announced) == self._roster_announced.maxlen
- else None
- )
- self._roster_announced.append(room_id)
- if oldest is not None:
- self._rosters.pop(oldest, None)
- self._rosters[room_id] = roster
- async def _thread_context_for(
- self,
- client: ChattoClient,
- *,
- room_id: str,
- thread_root_event_id: str,
- current_message_id: str,
- source: Any,
- ) -> str:
- """The thread's earlier messages, delivered once per thread.
- A Hermes thread session is keyed on the thread root and starts empty,
- so the turn that opens a thread is answered with nothing but the reply
- itself. The reported case: a cron job posts into a channel, its echo
- is filtered as a self-event and never reaches a session, and a human
- replies — rooting a thread whose root the agent has never seen. Without
- this block the agent answers a message it cannot read.
- Gated on ``thread_root_event_id``, not on the resolved ``thread_id``:
- a fresh room message is anchored to itself (see _admit_and_build), and
- that thread does not exist yet, so there is nothing to fetch. DMs never
- thread and never seed.
- Seeding is asked of the session store, not just the in-memory deque:
- the marker is process-local and dies on every restart, while the
- thread's session lives in state.db — so a restart would otherwise
- re-seed every thread in the room and duplicate a context the session
- already holds. The deque remains as a cheap timing pre-check for two
- turns racing before the first session is written.
- Best-effort by design, like the roster: a failed lookup leaves the
- thread unseeded so the next turn retries.
- """
- if not thread_root_event_id:
- return ""
- delivered_to = self._seeded_threads.get(thread_root_event_id, _UNSEEDED)
- if delivered_to is _UNSEEDED and self._thread_session_exists(source):
- # An earlier process seeded this thread and its session is still
- # there, so that session already holds the history. Recording it
- # keeps a later turn from re-asking — but the cursor died with that
- # process, so later turns deliver no tail rather than guess at one
- # and duplicate a block the session already has.
- self._record_thread_seeded(thread_root_event_id, None)
- return ""
- history = await self._thread_history(
- client, room_id=room_id, thread_root_event_id=thread_root_event_id
- )
- if history is None:
- logger.debug(
- "Chatto: dispatching into thread %s without history (lookup failed)",
- thread_root_event_id,
- )
- return ""
- if isinstance(delivered_to, str) or delivered_to is None:
- return self._seed_thread_tail(
- thread_root_event_id, history, delivered_to, current_message_id
- )
- earlier = [m for m in history if m.id != current_message_id]
- self._record_thread_seeded(
- thread_root_event_id, earlier[-1].id if earlier else current_message_id
- )
- return self._thread_context_block(earlier)
- def _seed_thread_tail(
- self,
- thread_root_event_id: str,
- history: list[Message],
- delivered_to: str | None | object,
- current_message_id: str,
- ) -> str:
- """Deliver only what landed in an already-seeded thread since the cursor.
- This is the agent's own output the session never saw: a message it posted
- into the thread through a tool, whose realtime echo is filtered as a
- self-event. Without it the next human message in that thread is answered
- by an agent that does not know what it said.
- """
- if not isinstance(delivered_to, str):
- return ""
- tail = _messages_after(history, delivered_to)
- if tail is None:
- # The cursor is no longer in the fetched window, so the thread grew
- # past it and this process cannot tell what the session already has.
- # Delivering nothing repeats the old behaviour; re-seeding from the
- # top would duplicate history the session holds.
- logger.debug(
- "Chatto: thread %s grew past the seeded cursor %s; no tail delivered",
- thread_root_event_id,
- delivered_to,
- )
- return ""
- unseen = [m for m in tail if m.id != current_message_id]
- if not unseen:
- return ""
- self._record_thread_seeded(thread_root_event_id, unseen[-1].id)
- return self._thread_context_block(unseen)
- async def _thread_history(
- self, client: ChattoClient, *, room_id: str, thread_root_event_id: str
- ) -> list[Message] | None:
- """Fetch a thread's messages oldest-first, or ``None`` if the lookup failed.
- The thread root is fetched explicitly when the timeline omits it: a
- cron message is a plain room message until someone replies to it, and
- whether the server lists it back as the thread's first event is not
- something the client signature promises.
- """
- try:
- page = await client.get_thread_events(
- room_id,
- thread_root_event_id,
- limit=ChattoConstants.THREAD_CONTEXT_MESSAGE_LIMIT,
- )
- except Exception:
- logger.debug(
- "Chatto: get thread events failed for %s/%s",
- room_id,
- thread_root_event_id,
- exc_info=True,
- )
- return None
- messages = [ev.message for ev in page.events if ev.message is not None]
- if not any(m.id == thread_root_event_id for m in messages):
- messages = (
- await self._thread_root_message(
- client, room_id=room_id, thread_root_event_id=thread_root_event_id
- )
- + messages
- )
- # The server's ordering is not a contract we build on — sort by the
- # timestamp each message carries, so the block reads like the thread.
- return sorted(
- messages,
- key=lambda m: m.created_at or datetime.min.replace(tzinfo=UTC),
- )
- async def _thread_root_message(
- self, client: ChattoClient, *, room_id: str, thread_root_event_id: str
- ) -> list[Message]:
- """The thread root as a list, so a miss concatenates cleanly.
- Best-effort: an unknown root costs nothing but the missing root line.
- """
- try:
- root = await client.get_message(
- room_id=room_id, event_id=thread_root_event_id
- )
- except Exception:
- logger.debug(
- "Chatto: get thread root failed for %s/%s",
- room_id,
- thread_root_event_id,
- exc_info=True,
- )
- return []
- return [root] if root is not None and not root.deleted_at else []
- def _record_thread_seeded(
- self, thread_root_event_id: str, last_delivered_id: str | None
- ) -> None:
- """Note that this thread's session holds its history up to that message.
- ``None`` when an earlier process seeded the thread: the cursor died with
- it, so later turns must deliver nothing rather than re-seed blindly.
- Re-inserting keeps the map insertion-ordered, which is what the cap below
- evicts from — the least recently touched thread.
- """
- self._seeded_threads.pop(thread_root_event_id, None)
- self._seeded_threads[thread_root_event_id] = last_delivered_id
- while len(self._seeded_threads) > ChattoConstants.SEEN_CAP:
- self._seeded_threads.pop(next(iter(self._seeded_threads)))
- def _thread_session_exists(self, source: Any) -> bool:
- """Whether the gateway already has a session for this source.
- The gateway's own routing index is the authority on "does this thread's
- conversation already exist" — it is persistent (state.db), so unlike
- the in-memory deque it answers correctly after a restart. Returns False
- when no store is wired (tests, or a startup path before
- ``set_session_store`` runs) so we fail open and seed.
- """
- store = getattr(self, "_session_store", None)
- if store is None:
- return False
- return store.peek_session_id(self._session_key_for(source)) is not None
- def _thread_context_block(self, messages: list[Message]) -> str:
- """Render earlier thread messages as the agent's reference block.
- Empty when there is nothing to say — a brand-new thread has no earlier
- messages, and that is not worth a header. Over budget, the oldest
- messages go first: the reply's immediate predecessors are what the
- turn is about.
- """
- entries: list[str] = []
- for message in messages:
- entry = self._thread_message_entry(message)
- if entry:
- entries.append(entry)
- if not entries:
- return ""
- dropped = 0
- while (
- entries
- and len("\n".join(entries)) > ChattoConstants.THREAD_CONTEXT_CHAR_LIMIT
- ):
- entries.pop(0)
- dropped += 1
- if not entries:
- return ""
- body = "\n".join(entries)
- omitted = f"… {dropped} earlier message(s) omitted\n" if dropped else ""
- return f"{omitted}[Earlier in this thread]\n{body}"
- def _thread_message_entry(self, message: Message) -> str:
- """One rendered thread message, or ``""`` for one with no body.
- Attachment-only messages render empty: the block is text context, and
- inventing a placeholder for a picture the agent cannot see here would
- be noise.
- """
- body = (message.body or "").strip()
- if not body:
- return ""
- me = self.me
- user = self._user_cache.get(message.actor_id)
- if me is not None and message.actor_id == me.id:
- # The agent's own output — often a cron message it never saw
- # arrive. Labelling it keeps "I said this" distinguishable from a
- # third party talking.
- return f"{me.login} (this bot): {body}"
- author = f"@{user.login}" if user else f"@{message.actor_id}"
- if not self._is_authorized(message.actor_id, user.login if user else None):
- # Auth gates the trigger message only; the rest of a shared thread
- # is reference text from people who may not be on the allowlist,
- # so it is marked as unverified rather than presented as trusted
- # input. An unknown author lands here too — fail closed.
- return f"{author} (unverified): {body}"
- return f"{author}: {body}"
- def _is_authorized(self, actor_id: str, login: str | None = None) -> bool:
- """Whether a Chatto user may talk to the agent, by id or login.
- The allowlist test itself, without the logging _check_auth adds: a
- rendering path asks the same question about someone quoted into the
- prompt, where denial is a normal sight rather than an event worth a
- warning. Callers pass the login when they already hold the User;
- otherwise it is read from the user cache.
- """
- if self.chatto_config.allow_all_users.value:
- return True
- allowed = self.chatto_config.allowed_users.value
- if actor_id in allowed:
- return True
- if login is None:
- user = self._user_cache.get(actor_id)
- login = user.login if user else None
- return login is not None and login in allowed
- def _evict_roster(self, room_id: str) -> None:
- """Drop all roster state for a room.
- Called on membership changes (user_joined/left_room), when we leave a
- room ourselves, and on reconnect. The subscribe snapshot carries the
- room and user directory but no presence, and the adapter does not
- request it — so a discarded cache is what forces one honest refetch.
- """
- try:
- self._roster_announced.remove(room_id)
- except ValueError:
- pass
- self._rosters.pop(room_id, None)
- async def _roster_for_room(self, client: ChattoClient, *, room_id: str) -> str:
- """The room's roster line for this turn — delivered on every turn.
- Threads hold isolated sessions and the agent only sees
- channel_context per dispatch, so each channel turn carries the current
- audience rather than deduplicating it. The projection exists to spare
- the directory, not the prompt: presence patches land in _user_cache
- in place, membership events or a reconnect evict the room so its next
- turn refetches once. An unprojected room retries on its next turn
- until a lookup succeeds.
- """
- if room_id not in self._roster_announced:
- fetched = await self._room_roster_context(client, room_id)
- if fetched is None:
- return ""
- self._announce_roster(room_id, fetched)
- return self._roster_line(room_id)
- async def _dispatch_message_posted(
- self, payload: MessagePostedEvent, event_id: str
- ) -> None:
- # Respond-room gate first: read-only memberships must not cost a
- # single API call, so this runs before fetch_message and _get_chatto_client.
- if not self._answers_in_room(payload.room_id):
- logger.debug(
- "Chatto: message from read-only room %s ignored", payload.room_id
- )
- return
- client = await self._get_chatto_client()
- if client is None:
- logger.warning("Chatto: dropping message - no client available")
- return
- logger.debug("Chatto WS: 'message_posted' payload:%s", payload)
- message = await client.get_message(room_id=payload.room_id, event_id=event_id)
- if message is None or message.deleted_at:
- return
- message_body = message.body or ""
- logger.debug("message: %s", message)
- # A message carrying only an image/PDF has an empty body — dropping it
- # here is what made attachments sent to Hermes disappear silently.
- if not message_body and not message.attachments:
- return
- event = await self._admit_and_build(
- client,
- room_id=payload.room_id,
- message=message,
- source_message_id=event_id,
- thread_root_event_id=payload.thread_root_event_id or None,
- )
- if event is None:
- return
- self._remember_dispatched(event.message_id or "")
- logger.info("Chatto: dispatching message to Hermes")
- await self.handle_message(event)
- return
- def _remember_dispatched(self, message_id: str) -> None:
- """Record a message ID as handed to the gateway, capped like _seen."""
- if not message_id:
- return
- self._dispatched_ids.append(message_id)
- def _edit_is_fresh(self, message: Message) -> bool:
- """Whether this edit is young enough to still be processed.
- Age is measured against the posting time, so an edit to an hours-old
- message cannot resurrect a settled conversation even when it arrives
- right now.
- """
- if message.created_at is None or message.updated_at is None:
- return True
- age_seconds = (message.updated_at - message.created_at).total_seconds()
- return age_seconds <= self.chatto_config.edit_window.value
- def _session_key_for(self, source) -> str:
- """The gateway's own session key for this source.
- Built with exactly the inputs ``handle_message`` uses, so lookups in
- ``_processing`` and calls to ``cancel_session_processing`` hit the
- same session the gateway is running.
- """
- return build_session_key(
- source,
- group_sessions_per_user=self.config.extra.get(
- "group_sessions_per_user", True
- ),
- thread_sessions_per_user=self.config.extra.get(
- "thread_sessions_per_user", False
- ),
- )
- async def _dispatch_message_edited(self, payload: Any) -> None:
- """Route an inbound edit according to the edit-dispatch contract.
- Three outcomes for the edited message:
- - currently being processed → cancel that turn and re-dispatch with
- the corrected text (the cancelled turn reports 🚫 via its
- CANCELLED outcome hook),
- - never dispatched (e.g. a forgotten @mention added later) → re-run
- the admission gates against the new body and answer for real,
- - already answered → stay answered.
- Edits whose text parses as a DM membership command are dropped: the
- command ran when the message was posted and must not run again.
- """
- if not self.chatto_config.edit_dispatch.value:
- return
- # Read-only memberships cost no API call, mirroring the posted path.
- if not self._answers_in_room(payload.room_id):
- logger.debug("Chatto: edit from read-only room %s ignored", payload.room_id)
- return
- client = await self._get_chatto_client()
- if client is None:
- logger.warning("Chatto: dropping edit - no client available")
- return
- logger.debug("Chatto WS: 'message_edited' payload:%s", payload)
- message = await client.get_message(
- room_id=payload.room_id, event_id=payload.message_event_id
- )
- if message is None or message.deleted_at:
- return
- message_body = message.body or ""
- if not message_body and not message.attachments:
- return
- if not self._edit_is_fresh(message):
- logger.debug(
- "Chatto: edit of msg %s outside the edit window",
- payload.message_event_id,
- )
- return
- # Cheap triage before the admission pipeline: an edit to an
- # already-settled message (dispatched, neither running nor queued)
- # must not cost get_room/media calls or re-fire acknowledgements.
- was_dispatched = payload.message_event_id in self._dispatched_ids
- if (
- was_dispatched
- and payload.message_event_id not in self._processing.values()
- and not any(
- pending.message_id == payload.message_event_id
- for pending in self._pending_messages.values()
- )
- ):
- logger.debug(
- "Chatto: edit of already-answered msg %s ignored",
- payload.message_event_id,
- )
- return
- event = await self._admit_and_build(
- client,
- room_id=payload.room_id,
- message=message,
- source_message_id=payload.message_event_id,
- thread_root_event_id=message.thread_root_event_id or None,
- allow_dm_commands=False,
- )
- if event is None:
- return
- session_key = self._session_key_for(event.source)
- if self._processing.get(session_key) == payload.message_event_id:
- logger.info(
- "Chatto: msg %s edited mid-run - restarting the turn",
- payload.message_event_id,
- )
- # The cancelled task's completion hook clears _processing and
- # reports 🚫 before this coroutine moves on, because cancel
- # awaits the task. Queued follow-ups must survive.
- await self.cancel_session_processing(
- session_key, release_guard=True, discard_pending=False
- )
- elif not was_dispatched:
- logger.info(
- "Chatto: msg %s was never dispatched - edit starts a fresh turn",
- payload.message_event_id,
- )
- else:
- pending = self._pending_messages.get(session_key)
- if pending is not None and pending.message_id == payload.message_event_id:
- # Still queued behind the running turn: correct it in place
- # instead of answering stale wording later.
- pending.text = event.text
- logger.info(
- "Chatto: queued msg %s updated to its edited text",
- payload.message_event_id,
- )
- return
- logger.debug(
- "Chatto: edit of already-answered msg %s ignored",
- payload.message_event_id,
- )
- return
- self._remember_dispatched(event.message_id or "")
- logger.info("Chatto: dispatching edited message to Hermes")
- await self.handle_message(event)
- async def _admit_and_build(
- self,
- client: ChattoClient,
- *,
- room_id: str,
- message: Message,
- source_message_id: str,
- thread_root_event_id: str | None,
- allow_dm_commands: bool = True,
- ) -> MessageEvent | None:
- """Run one hydrated inbound message through the admission pipeline.
- Shared by the posted and the edited path: user resolution, auth,
- mention gates, thread anchoring and media caching all behave
- identically for both. Returns ``None`` for anything that must not
- reach the agent. DM membership commands are executed here (side
- effect) unless ``allow_dm_commands`` is False — edits pass False so
- a corrected command line neither runs twice nor leaks to the agent.
- A dispatch that opens a channel thread additionally carries the
- member roster in ``channel_context`` (side effect: once the roster
- was fetched, the thread root is recorded as announced).
- The caller owns dispatching: a non-None result still needs
- ``handle_message()``.
- """
- user = self._user_cache.get(message.actor_id)
- if user is None:
- logger.debug("Chatto: resolving user %s", message.actor_id)
- member = await client.get_room_member(
- room_id=message.room_id, user_id=message.actor_id
- )
- if member is None or member.user is None:
- logger.debug(
- "Chatto: dropping message from unknown user %s",
- message.actor_id,
- )
- return None
- user = member.user
- self._user_cache[user.id] = user
- if not self._check_auth(user):
- logger.debug(
- "Chatto: dropping message from user %s (auth denied)",
- message.actor_id,
- )
- return None
- room_kind = await self._room_kind_for(client, message.room_id)
- if room_kind is None:
- logger.debug(
- "Chatto: dropping message from room %s (room_kind lookup failed)",
- message.room_id,
- )
- return None
- message_body = message.body or ""
- logger.debug("message_body: %s room_kind: %s", message_body, room_kind)
- # Membership commands ride in over DMs only: they change what the bot
- # listens to and must never reach the agent pipeline or the mention
- # gates.
- if room_kind == RoomKind.DM:
- if allow_dm_commands:
- if await self._handle_dm_command(room_id, message_body):
- return None
- elif message_body.startswith("/"):
- logger.debug("Chatto: edited DM command %r not re-run", message_body)
- return None
- # Mention gating deliberately covers everything but DMs: in a channel
- # the bot is one of many listeners and must be addressed, whereas a DM
- # is already addressed at it. Chatto has no group rooms — any
- # multi-participant surface is a channel, and a room whose kind the
- # server never set counts as one too (see _answers_in_room). The
- # shared _mentions_me gate keeps this path and the someone-else check
- # below on one definition of "addressed", broadcast handles included.
- if room_kind != RoomKind.DM:
- policy = self._room_policy(room_id)
- if policy == RoomPolicy.REQUIRE_MENTION and not self._mentions_me(
- message_body
- ):
- logger.debug(
- "Chatto: dropping unaddressed message from %s (policy %s)",
- room_id,
- policy.value,
- )
- return None
- # In an open channel we see every message, including ones plainly
- # aimed at a named colleague. Answering those would be barging in,
- # so acknowledge that we read it and stay quiet. Checked after the
- # bot-mention test above, so a message naming us *and* someone
- # else still counts as ours.
- if (
- policy == RoomPolicy.OPEN
- and not self._mentions_me(message_body)
- and await self._mentions_someone_else(message_body)
- ):
- logger.info(
- "Chatto: message addresses someone else, acknowledging only"
- )
- if self.chatto_config.reactions.value:
- await self.add_reaction(message.room_id, message.id, "🫥")
- return None
- # Thread anchoring — if the incoming message is inside a Chatto thread, we
- # keep that thread by default; otherwise leave thread_id unset so
- # replies land at the root.
- thread_id = (
- thread_root_event_id or None
- ) # we could also take the room id but then, we're in a thread already.
- if not thread_id and room_kind != RoomKind.DM:
- thread_id = message.id
- logger.debug(
- "Chatto: thread anchoring for msg %s: incoming thread_root_event_id=%r, "
- "room_kind=%s, anchored thread_id=%r",
- message.id,
- message.thread_root_event_id,
- room_kind.name,
- thread_id,
- )
- # Every channel turn carries the room's roster: threads hold isolated
- # sessions and the agent only sees channel_context per dispatch, so a
- # repeat is not deduplication but the point (see _roster_for_room).
- # The gateway prepends channel_context above the message text, so the
- # roster never mingles with what the user actually wrote.
- source = self.build_source(
- chat_id=room_id,
- chat_name=self._room_names.get(message.room_id),
- chat_type=chat_type_for_room_kind(room_kind),
- user_id=message.actor_id,
- user_name=user.login, # use login, because display_name is changeable by anyone.
- thread_id=thread_id,
- message_id=source_message_id,
- role_authorized=True,
- )
- # Channel context rides ahead of the message text as read-only
- # reference: the roster names the audience, the thread block carries
- # what the thread already said. DMs get neither — there is no audience
- # to name and no thread to catch up on. Built after the source, because
- # the thread block asks the session store whether this thread's session
- # already has the history (see _thread_context_for).
- context_blocks: list[str] = []
- if room_kind != RoomKind.DM:
- logger.debug(
- "Chatto: fetching roster for room %s",
- room_id,
- )
- roster = await self._roster_for_room(client, room_id=room_id)
- if roster:
- context_blocks.append(roster)
- else:
- logger.debug(
- "Chatto: dispatching channel message without roster "
- "(lookup failed or empty)"
- )
- thread_context = await self._thread_context_for(
- client,
- room_id=room_id,
- thread_root_event_id=thread_root_event_id or "",
- current_message_id=message.id,
- source=source,
- )
- if thread_context:
- context_blocks.append(thread_context)
- # prepare a MessageEvent
- message_event = MessageEvent(
- text=message_body,
- source=source,
- message_id=message.id,
- timestamp=message.created_at or datetime.now(UTC),
- raw_message=message,
- reply_to_message_id=message.in_reply_to,
- channel_context="\n\n".join(context_blocks) or None,
- )
- if message_event.is_command():
- message_event.message_type = MessageType.COMMAND
- # Attachments — download and hand the local cache paths to the gateway,
- # which runs vision enrichment / document extraction off media_urls.
- (
- message_event.media_urls,
- message_event.media_types,
- media_kinds,
- ) = await self._cache_attachments(list(message.attachments))
- if media_kinds:
- # Same precedence as the Teams/Signal adapters: document-context
- # injection gates strictly on DOCUMENT, image handling keys off the
- # per-path image/* MIME regardless of message_type.
- message_event.message_type = self._message_type_for_media_kinds(media_kinds)
- else:
- message_event.message_type = MessageType.TEXT
- logger.debug("Chatto: MessageEvent: %s", message_event)
- return message_event
- async def _forward_reaction(
- self,
- event: RealtimeEvent,
- payload: Any,
- *,
- removed: bool,
- ) -> None:
- """Forward a human reaction to the gateway's reaction hook surface.
- The handler is registered by the gateway via ``set_reaction_handler``
- and fans out as ``reaction:added`` / ``reaction:removed`` through the
- HookRegistry. The dict shape mirrors the Slack adapter's — hook
- consumers are written against that contract, not against a per-platform
- one. Our own lifecycle reactions (👀/✅/❌) are dropped: forwarding them
- would feed the agent its own markers.
- """
- actor_id = event.actor_id
- if actor_id and self.me and actor_id == self.me.id:
- return
- if not payload.room_id or not payload.message_event_id or not actor_id:
- return
- handler = self._reaction_handler
- if handler is None:
- return
- action = "removed" if removed else "added"
- try:
- await handler(
- {
- "platform": ChattoConstants.PLATFORM_NAME,
- "event_name": f"reaction:{action}",
- "reaction": payload.emoji,
- "user_id": actor_id,
- "item_user_id": None,
- "item_type": "message",
- "channel_id": payload.room_id,
- "message_ts": payload.message_event_id,
- "event_ts": event.id,
- "raw_event": event,
- },
- )
- except Exception: # pragma: no cover - the hook contract is non-blocking
- logger.debug("Chatto: reaction hook forwarding failed", exc_info=True)
- async def _handle_realtime_event(self, event: RealtimeEvent) -> None:
- if self._is_seen(event.id):
- return
- if event.actor_id is None:
- return
- logger.debug("EVENT happened: '%s' from %s", event.kind, event.actor_id)
- # Self-event filter — the actor_id on the envelope is authoritative.
- actor_id = event.actor_id
- if actor_id and self.me and actor_id == self.me.id:
- return
- if event.kind == "message_posted":
- await self._dispatch_message_posted(event.payload, event.id)
- elif event.kind == "message_edited":
- await self._dispatch_message_edited(event.payload)
- elif event.kind in ("reaction_added", "reaction_removed"):
- await self._forward_reaction(
- event,
- event.payload,
- removed=event.kind == "reaction_removed",
- )
- elif event.kind == "presence_changed":
- # A participant's presence changed — patch the cached user in place.
- if (user := self._user_cache.get(event.payload.user_id)) is not None:
- user.presence_status = event.payload.status
- logger.debug(
- "Chatto: patched presence of %s to %s",
- event.payload.user_id,
- event.payload.status.name,
- )
- elif event.kind in ("user_joined_room", "user_left_room"):
- # Membership moved — the room's roster projection is now wrong, so
- # discard it; the next turn there refetches once and re-delivers.
- if event.payload.room_id in self._roster_announced:
- logger.debug(
- "Chatto: %s invalidated the roster of room %s",
- event.kind,
- event.payload.room_id,
- )
- self._evict_roster(event.payload.room_id)
- # confirmed:
- # NOTE: "projection_event" (and "caught_up") belong to realtime protocol
- # v2 on unreleased Chatto main — chattolib speaks v1 and can never
- # deliver them here. Revisit when vendored chattolib gains v2 typing.
- elif event.kind in (
- "mention_notification",
- "notification_dismissed",
- "room_marked_as_read",
- "user_typing",
- "notification_created",
- "new_direct_message_notification",
- "message_retracted",
- "thread_created",
- "thread_follow_changed",
- "room_updated",
- "room_groups_updated",
- ):
- logger.debug(
- "Chatto: '%s' event received. Not yet implemented or not needed.",
- event.kind,
- )
- else:
- logger.warning("Chatto: unknown event kind: '%s'", event.kind)
- async def _chattolib_event_loop(self) -> None:
- """Event loop using chattolib's stream_events.
- This replaces the manual WebSocket loop with chattolib's high-level
- stream_events() which provides pre-decoded RealtimeEvent objects.
- """
- delay = ChattoConstants.WS_RECONNECT_INITIAL_BACKOFF
- while not self._closing:
- try:
- client = await self._require_chatto_client()
- await self._refresh_rooms()
- logger.info(
- "Chatto: starting chattolib event stream with %d rooms",
- len(self._joined_room_ids),
- )
- async for event in stream_events(client):
- if self._closing:
- return
- if isinstance(event, RealtimeEvent):
- await self._handle_realtime_event(event)
- # Iterator exited cleanly — treat as a normal close and reconnect
- # with the local backoff (no server hint available).
- logger.info("Chatto: realtime stream ended, reconnecting")
- except asyncio.CancelledError:
- return
- except ChattoRealtimeCloseError as exc:
- if not exc.reconnect:
- logger.error(
- "Chatto: realtime closed by server (%s: %s), not reconnecting",
- exc.code,
- exc.message,
- )
- return
- wait = max(
- exc.retry_after_ms / 1000.0,
- ChattoConstants.WS_RECONNECT_INITIAL_BACKOFF,
- )
- logger.warning(
- "Chatto: realtime closed by server (%s), reconnecting in %.1fs",
- exc.code,
- wait,
- )
- delay = (
- ChattoConstants.WS_RECONNECT_INITIAL_BACKOFF
- ) # server hint supersedes local backoff
- await self._sleep_interruptible(wait)
- continue
- except ChattoRealtimeError as exc:
- if exc.fatal:
- logger.error(
- "Chatto: fatal realtime error (%s): %s", exc.code, exc.message
- )
- return
- logger.warning(
- "Chatto: realtime error (%s: %s), reconnecting in %.1fs",
- exc.code,
- exc.message,
- delay,
- )
- except Exception as exc:
- cause = exc.__cause__
- if cause is not None and isinstance(cause, TypeError):
- logger.warning(
- "Chatto: realtime wire corruption (%s), reconnecting in %.1fs",
- cause,
- delay,
- )
- else:
- logger.warning(
- "Chatto: unexpected realtime error: %s, reconnecting in %.1fs",
- exc,
- delay,
- )
- if self._closing:
- return
- jitter = delay * 0.2 * random.random()
- await self._sleep_interruptible(delay + jitter)
- delay = min(delay * 2, ChattoConstants.WS_RECONNECT_MAX_BACKOFF)
- async def _sleep_interruptible(self, seconds: float) -> None:
- """Sleep in short slices so disconnect() cancels promptly."""
- end = asyncio.get_running_loop().time() + seconds
- while not self._closing:
- remaining = end - asyncio.get_running_loop().time()
- if remaining <= 0:
- return
- await asyncio.sleep(min(remaining, 0.5))
- def _warn_if_home_channel_unjoined(self, member_ids: set[str]) -> None:
- """Warn once when CHATTO_HOME_CHANNEL names a room the bot is not in.
- Standalone cron delivery posts straight into that room with a fresh
- client and no join logic of its own — without server-side membership
- every proactive send fails there.
- """
- home_id = (self.chatto_config.home_channel.value or "").strip()
- if (
- not home_id
- or home_id in member_ids
- or home_id in self._joined_room_ids
- or self._home_warning_logged
- ):
- return
- self._home_warning_logged = True
- logger.warning(
- "Chatto: CHATTO_HOME_CHANNEL '%s' is not a joined room - cron and "
- "notification delivery will fail until the bot joins it (invite "
- "the account natively in Chatto, or DM it '/join').",
- home_id,
- )
- async def _resolve_dm_partner(self, client: ChattoClient, room_id: str) -> None:
- """Cache the chat partner's login for a DM room, best-effort.
- DM rooms carry no usable name of their own, so the joined-rooms
- summary names the other side instead. Resolved once per room and
- session; without our own user (pre-connect) or on a directory error
- the raw room name stays in place.
- """
- if room_id in self._dm_partners or self.me is None:
- return
- try:
- member_ids, _page = await client.list_room_members(room_id)
- if not member_ids:
- return
- members = await client.batch_get_room_members(room_id, member_ids)
- except Exception:
- logger.debug(
- "Chatto: could not list members of DM %s", room_id, exc_info=True
- )
- return
- for member in members:
- user = member.user
- if user and user.id != self.me.id:
- self._dm_partners[room_id] = user.login or user.display_name
- return
- def _joined_room_label(self, room_id: str) -> str:
- """One entry for the joined-rooms summary, with how-we-answer tags.
- The tag names the room's participation mode at a glance: DMs answer
- unconditionally, listed channels answer on mentions or every message,
- and an unlisted channel is read-only. A DM is labelled with its chat
- partner's login rather than its (empty) room name, and names are
- quoted so empty strings and spaces stay visible.
- """
- name = self._room_names.get(room_id, room_id)
- if self._room_kinds.get(room_id) == RoomKind.DM:
- tags = "[dm]"
- name = self._dm_partners.get(room_id) or name
- else:
- policy = self._room_policy(room_id)
- if policy == RoomPolicy.REQUIRE_MENTION:
- tags = "[on-mention]"
- elif policy == RoomPolicy.OPEN:
- tags = "[every-message]"
- else:
- tags = "[read-only]"
- if room_id in self._universal_room_ids:
- tags += " [universal]"
- return f'"{name}" ({room_id}) {tags}'
- def _log_joined_rooms(self) -> None:
- """Log the joined rooms and how the bot answers in each of them."""
- labels = [self._joined_room_label(rid) for rid in self._joined_room_ids]
- logger.info(
- "Chatto WS: currently joined in %d room(s): %s",
- len(labels),
- ", ".join(labels),
- )
- async def _refresh_rooms(self) -> None:
- """Refresh room list via ConnectRPC, join and seed any newly discovered rooms.
- Runs once per (re)connect, so this is also the bootstrap point for the
- roster projection: nothing on the wire reports presence at connect
- time (the subscribe snapshot has no presence field; presence arrives
- as its own events), so cached presence could only heal on the next
- random change. Discarding it makes each announced room's first turn
- refetch fresh data — lazily, so quiet rooms stay free of API calls.
- """
- client = await self._get_chatto_client()
- if client is None:
- logger.warning("Chatto WS: _refresh_rooms aborted - no client available")
- return
- for announced in list(self._roster_announced):
- self._evict_roster(announced)
- try:
- rooms_list = await client.list_rooms()
- member_ids: set[str] = set()
- new_room_ids: list[str] = []
- for room_with_state in rooms_list:
- if not room_with_state:
- continue
- room_obj = room_with_state.room or None
- if not room_obj:
- continue
- self._room_names[room_obj.id] = room_obj.name
- self._room_kinds[room_obj.id] = room_obj.kind
- if room_obj.kind == RoomKind.DM:
- await self._resolve_dm_partner(client, room_obj.id)
- if room_obj.universal:
- self._universal_room_ids.add(room_obj.id)
- if not room_with_state.viewer_state.is_member:
- continue
- member_ids.add(room_obj.id)
- if room_obj.id not in self._joined_room_ids:
- new_room_ids.append(room_obj.id)
- # Left via /leave, kicked, deleted: rooms we no longer belong
- # to drop out here — otherwise the next refresh would quietly
- # re-add what /leave just removed.
- stale_room_ids = [
- rid for rid in self._joined_room_ids if rid not in member_ids
- ]
- for rid in stale_room_ids:
- self._joined_room_ids.remove(rid)
- self._evict_roster(rid)
- if stale_room_ids:
- logger.info(
- "Chatto WS: no longer a member of %d room(s): %s",
- len(stale_room_ids),
- stale_room_ids,
- )
- self._warn_if_home_channel_unjoined(member_ids)
- if new_room_ids:
- logger.info(
- "Chatto WS: discovered %d new room(s): %s",
- len(new_room_ids),
- new_room_ids,
- )
- for rid in new_room_ids:
- # Membership came straight from the directory scan
- # (viewer_state.is_member); natively invited rooms need no
- # JoinRoom call — same rule as _run_join.
- if self._answers_in_room(rid):
- await self._seed_room(rid)
- else:
- logger.info(
- "Chatto WS: %s (%s) is on neither mention list -"
- " joined read-only",
- self._room_names.get(rid, rid),
- rid,
- )
- self._joined_room_ids.append(rid)
- self._log_joined_rooms()
- except Exception:
- logger.warning("Chatto WS: _refresh_rooms failed", exc_info=True)
- # ------------------------------------------------------------------ #
- # Read state (best-effort, Chatto-unique)
- # ------------------------------------------------------------------ #
- # Deliberately outside the try block above: this sweep runs on every
- # refresh — including refreshes that discovered no new rooms. The
- # old early return starved it to "only when something changed",
- # leaving silent rooms unmarked for whole connection lifetimes.
- # Best-effort: mark all joined rooms as read (room_id may be undefined here)
- for _rid in list(self._joined_room_ids):
- try:
- await client.mark_room_as_read(room_id=_rid)
- except Exception:
- logger.debug(
- "Chatto: mark_room_as_read failed for %s", _rid, exc_info=True
- )
- # ------------------------------------------------------------------ #
- # Sending (ConnectRPC — unchanged from polling version)
- # ------------------------------------------------------------------ #
- def _resolve_outbound_thread(
- self,
- chat_id: str,
- reply_to: str | None,
- metadata: dict[str, Any] | None,
- ) -> str | None:
- """The thread an outbound message belongs in, or ``None`` for the room.
- One definition for every outbound path (text and attachments):
- ``metadata["thread_id"]`` wins — it names the thread root to stay in;
- otherwise ``reply_to`` anchors a thread under the incoming message,
- but only with ``auto_thread`` enabled. DMs never thread.
- Deliberately does NOT open an auto-thread of its own — only the
- chunked text path in :meth:`send` does that, because only there do
- further chunks follow into the freshly created thread.
- """
- thread_id = (metadata or {}).get("thread_id")
- if reply_to and self.chatto_config.auto_thread.value and not thread_id:
- thread_id = reply_to
- if self._room_kinds.get(chat_id) == RoomKind.DM:
- return None
- return str(thread_id) if thread_id else None
- async def send(
- self,
- chat_id: str,
- content: str,
- reply_to: str | None = None,
- metadata: dict[str, Any] | None = None,
- ) -> SendResult:
- """Send a message to a Chatto room.
- Long messages are split into chunks via ``truncate_message`` and
- each chunk is sent as a separate CreateMessage call. The first
- chunk's message ID is returned as ``message_id``.
- When ``auto_thread`` is enabled and the incoming message was a
- regular room message (not already in a thread), the first chunk is
- sent as a room message and its ID becomes the thread root. Subsequent
- chunks are sent in that thread. This mirrors Discord's auto_thread
- behavior.
- BasePlatformAdapter override
- """
- if not content:
- return SendResult(success=False, error="Empty message")
- thread_id = self._resolve_outbound_thread(chat_id, reply_to, metadata)
- room_kind = self._room_kinds.get(chat_id)
- is_dm = room_kind == RoomKind.DM
- # Auto-thread: by default, Chatto creates a thread for replies to room
- # messages (not DMs, not already in a thread). This keeps conversations
- # organized in the room. Can be disabled via extra.auto_thread=false.
- use_auto_thread = (
- self.chatto_config.auto_thread.value and not thread_id and not is_dm
- )
- client = await self._get_chatto_client()
- if client is None:
- return SendResult(
- success=False, error="Chatto client not available", retryable=True
- )
- # The split, the routing and the stop-at-first-failure all live in
- # _deliver_chunks, shared with the plugin tools: a long answer must
- # reach the room the same way whoever sent it.
- delivery = await _deliver_chunks(
- client,
- chat_id,
- content,
- thread_root_event_id=str(thread_id) if thread_id else "",
- create_thread=use_auto_thread,
- on_posted=self._mark_seen,
- )
- message_ids = delivery.message_ids
- if use_auto_thread and message_ids and not thread_id:
- thread_id = delivery.root_event_id
- # Nothing got through at all — report the failure instead of a phantom success.
- if not message_ids:
- # Only server-side failures count as retryable; a bug in our own
- # code must not read as a transient network blip.
- return SendResult(
- success=False,
- error=(
- str(delivery.error)
- if delivery.error
- else "Chatto: message could not be sent"
- ),
- retryable=isinstance(delivery.error, ChattoError),
- )
- first_id = message_ids[0]
- # ------------------------------------------------------------------ #
- # Thread following (best-effort, Chatto-unique)
- # ------------------------------------------------------------------ #
- if thread_id:
- try:
- await client.follow_thread(chat_id, thread_id)
- except Exception:
- logger.debug(
- "Chatto: follow_thread failed for %s/%s",
- chat_id,
- thread_id,
- exc_info=True,
- )
- # A later chunk failed after earlier ones went out: partial delivery.
- if delivery.error is not None:
- logger.warning(
- "Chatto: sent %d/%d chunk(s) to %s before failing: %s",
- len(message_ids),
- delivery.chunks_total,
- chat_id,
- delivery.error,
- )
- # raw_response stays unset (dict-shaped per the SendResult contract):
- # gateway consumers such as the cron scheduler call .get() on it, so a
- # chattolib Message here would crash delivery bookkeeping *after* the
- # send already succeeded — the job then falls back to the standalone
- # path and the room sees the message twice.
- return SendResult(success=True, message_id=first_id)
- def format_message(self, content: str) -> str:
- """Normalise outgoing text for Chatto.
- The transformations live in :func:`_normalise_outbound_text`, shared
- with the standalone cron sender.
- BasePlatformAdapter override
- """
- return _normalise_outbound_text(content)
- async def edit_message(
- self,
- chat_id: str,
- message_id: str,
- content: str,
- *,
- finalize: bool = False,
- ) -> SendResult:
- """Edit a message we previously sent, via MessageService/UpdateMessage.
- The stream consumer drives streaming replies through this: without the
- override the base class reports "Not supported" and every incremental
- update arrives as a *new* message.
- ``finalize`` is a no-op for Chatto — an edit is an edit here, there is
- no in-progress card state to close out (hence no
- ``REQUIRES_EDIT_FINALIZE``).
- Content that exceeds the per-message limit is refused rather than
- silently truncated, so the caller falls back to ``send()``, which
- splits across messages.
- BasePlatformAdapter override
- """
- if not message_id:
- return SendResult(success=False, error="Chatto: no message id to edit")
- if not content:
- return SendResult(success=False, error="Empty message")
- formatted = self.format_message(content)
- if len(formatted) > ChattoConstants.MAX_MESSAGE_LENGTH:
- # Refuse instead of truncating: the caller's fallback path splits.
- return SendResult(
- success=False,
- error=(
- f"Chatto: edit exceeds {ChattoConstants.MAX_MESSAGE_LENGTH} "
- f"chars ({len(formatted)})"
- ),
- )
- client = await self._get_chatto_client()
- if client is None:
- return SendResult(
- success=False, error="Chatto client not available", retryable=True
- )
- try:
- msg = await client.update_message(
- room_id=str(chat_id),
- event_id=str(message_id),
- body=formatted,
- )
- except ChattoError as e:
- logger.warning("Chatto: UpdateMessage failed for %s: %s", message_id, e)
- return SendResult(success=False, error=str(e), retryable=True)
- except Exception as e:
- logger.warning("Chatto: UpdateMessage error for %s: %s", message_id, e)
- return SendResult(success=False, error=str(e), retryable=False)
- # Our own edit comes back as a message_edited event; mark it seen so it
- # is never mistaken for inbound traffic.
- edited_id = msg.id or str(message_id)
- self._mark_seen(edited_id)
- return SendResult(success=True, message_id=edited_id)
- async def delete_message(self, chat_id: str, message_id: str) -> bool:
- """Delete a message via MessageService/DeleteMessage.
- Used by the stream consumer's fresh-final cleanup (removing a preview
- message once the completed reply has been sent) and by the ephemeral
- reply TTL.
- BasePlatformAdapter override
- """
- if not chat_id or not message_id:
- return False
- client = await self._get_chatto_client()
- if client is None:
- logger.warning("Chatto: DeleteMessage — client unavailable")
- return False
- try:
- return bool(
- await client.delete_message(
- room_id=str(chat_id),
- event_id=str(message_id),
- )
- )
- except ChattoError as e:
- logger.warning("Chatto: DeleteMessage failed for %s: %s", message_id, e)
- return False
- except Exception as e:
- logger.warning("Chatto: DeleteMessage error for %s: %s", message_id, e)
- return False
- async def create_handoff_thread(
- self,
- parent_chat_id: str,
- name: str,
- ) -> str | None:
- """Anchor a session handoff in a fresh thread under *parent_chat_id*.
- Chatto threads hang off a message, not off the room, so we post a seed
- message and hand its ID back as the thread root — the same shape the
- Slack adapter uses. DMs don't support threads, so they get ``None``
- and the watcher keeps delivering into the DM itself.
- BasePlatformAdapter override
- """
- if not parent_chat_id:
- return None
- if self._room_kinds.get(parent_chat_id) == RoomKind.DM:
- logger.debug("Chatto: handoff thread skipped — %s is a DM", parent_chat_id)
- return None
- client = await self._get_chatto_client()
- if client is None:
- logger.warning("Chatto: handoff thread — client unavailable")
- return None
- try:
- msg = await client.post_message(
- room_id=str(parent_chat_id),
- body=f"🧵 Hermes handoff — **{(name or 'session').strip()[:80]}**",
- )
- except Exception as e:
- logger.warning(
- "Chatto: handoff thread seed-post failed for room %s: %s",
- parent_chat_id,
- e,
- )
- return None
- seed_id = msg.id
- if not seed_id:
- logger.warning("Chatto: handoff thread seed-post returned no message id")
- return None
- self._mark_seen(seed_id)
- try:
- await client.follow_thread(str(parent_chat_id), seed_id)
- except Exception:
- logger.debug(
- "Chatto: follow_thread failed for handoff %s/%s",
- parent_chat_id,
- seed_id,
- exc_info=True,
- )
- return seed_id
- # Overridden from BaseAdapter:
- async def send_typing(self, chat_id: str, metadata=None) -> None:
- """Start a persistent typing indicator for a room.
- Sends a typing ping every 10 seconds (Chatto's indicator likely
- lasts ~8-10s). The background loop runs until ``stop_typing()``
- is called or the task is cancelled.
- BasePlatformAdapter override
- """
- if chat_id in self._typing_tasks:
- return # already running
- async def _typing_loop() -> None:
- try:
- while True:
- try:
- client = await self._get_chatto_client()
- if client is None:
- return
- await client.refresh_typing_indicator(room_id=str(chat_id))
- except asyncio.CancelledError:
- return
- except Exception:
- logger.debug(
- "Chatto: typing indicator refresh failed for %s",
- chat_id,
- exc_info=True,
- )
- await asyncio.sleep(10)
- except asyncio.CancelledError:
- pass
- finally:
- self._typing_tasks.pop(chat_id, None)
- self._typing_tasks[chat_id] = asyncio.create_task(_typing_loop())
- async def stop_typing(self, chat_id: str) -> None:
- """Stop the persistent typing indicator for a room.
- BasePlatformAdapter override
- """
- task = self._typing_tasks.pop(chat_id, None)
- if task:
- task.cancel()
- try:
- await task
- except (asyncio.CancelledError, Exception):
- logger.debug("Chatto: typing task ended for %s", chat_id, exc_info=True)
- async def get_chat_info(self, chat_id: str) -> dict[str, Any]:
- """Get information about a chat/room.
- BasePlatformAdapter override
- """
- name = self._room_names.get(chat_id, chat_id)
- kind = self._room_kinds.get(chat_id)
- return {
- "name": name,
- "type": chat_type_for_room_kind(kind).value,
- }
- # ------------------------------------------------------------------ #
- # Reactions
- # ------------------------------------------------------------------ #
- @staticmethod
- def _emoji_to_shortcode(emoji: str) -> str:
- """Convert a unicode emoji to a Chatto shortcode name.
- If the emoji is already a shortcode (no unicode mapping found),
- return it as-is.
- """
- shortcode = ChattoConstants.EMOJI_TO_SHORTCODE.get(emoji)
- if shortcode:
- return shortcode
- # Already a shortcode like "thumbsup" — return as-is
- return emoji
- async def add_reaction(self, room_id: str, message_id: str, emoji: str) -> bool:
- """Add a reaction to a message via MessageService/AddReaction.
- BasePlatformAdapter override
- """
- shortcode = self._emoji_to_shortcode(emoji)
- client = await self._get_chatto_client()
- if client is None:
- logger.warning("Chatto: AddReaction — client unavailable")
- return False
- try:
- result = await client.add_reaction(
- room_id=room_id,
- message_event_id=message_id,
- emoji=shortcode,
- )
- return result
- except ChattoError as e:
- logger.warning("Chatto: AddReaction failed: %s", e)
- return False
- except Exception as e:
- logger.warning("Chatto: AddReaction error: %s", e)
- return False
- async def remove_reaction(self, chat_id: str, message_id: str, emoji: str) -> bool:
- """Remove a reaction from a message via MessageService/RemoveReaction.
- BasePlatformAdapter override
- """
- shortcode = self._emoji_to_shortcode(emoji)
- client = await self._get_chatto_client()
- if client is None:
- logger.warning("Chatto: RemoveReaction — client unavailable")
- return False
- try:
- result = await client.remove_reaction(
- room_id=str(chat_id),
- message_event_id=str(message_id),
- emoji=shortcode,
- )
- return result
- except ChattoError as e:
- logger.warning("Chatto: RemoveReaction failed: %s", e)
- return False
- except Exception as e:
- logger.warning("Chatto: RemoveReaction error: %s", e)
- return False
- # NOTE: there is deliberately no start_dm(). On Chatto only a person can
- # start a DM ("Only people can start a DM... A bot cannot start a DM, even
- # with message.post", dev-docs/guides/operations/permissions), and nothing
- # in Hermes calls such a method — BasePlatformAdapter does not even declare
- # one. An earlier version had it and advertised "DM initiation" in the
- # capability banner, but it could only ever fail: the vendored chattolib's
- # start_dm() calls a service stub that does not exist, so the AttributeError
- # was swallowed into a silent None. DMs become usable the moment the other
- # person writes to the bot; /join and the chatto_send_dm tool both say so.
- # ------------------------------------------------------------------ #
- # Room creation (Chatto-unique)
- # ------------------------------------------------------------------ #
- async def create_room(
- self,
- name: str,
- description: str = "",
- group_id: str = "",
- universal: bool = True,
- ) -> str | None:
- """Create an ad-hoc room via RoomService/CreateRoom.
- Returns the room ID on success, or None on failure.
- BasePlatformAdapter override
- """
- client = await self._get_chatto_client()
- if client is None:
- return None
- try:
- room = await client.create_room(
- name=name,
- group_id=group_id or "",
- description=description,
- universal=universal,
- )
- rid = str(room.id) if room else ""
- if rid:
- self._room_names[rid] = room.name
- self._room_kinds[rid] = room.kind
- return rid
- logger.debug("Chatto: CreateRoom returned no room id")
- return None
- except ChattoError as e:
- logger.debug("Chatto: CreateRoom failed: %s", e)
- return None
- except Exception as e:
- logger.debug("Chatto: CreateRoom error: %s", e)
- return None
- # ------------------------------------------------------------------ #
- # Processing lifecycle hooks (reactions-based, like Discord)
- # ------------------------------------------------------------------ #
- def _event_room_and_message_id(self, event: MessageEvent) -> tuple[str, str]:
- """Extract room_id and message_id from a MessageEvent."""
- message_id = event.message_id or ""
- return event.source.chat_id, message_id
- async def on_processing_start(self, event: MessageEvent) -> None:
- """Record the turn as open, then add an 👀 (eyes) reaction.
- The record is what lets an edit of this very message be recognized as
- a mid-run correction. It must be maintained even when reactions are
- disabled — tracking and decorating are independent concerns.
- BasePlatformAdapter override
- """
- session_key = (
- self._session_key_for(event.source) if event.source is not None else ""
- )
- if session_key and event.message_id:
- self._processing[session_key] = str(event.message_id)
- if not self.chatto_config.reactions.value:
- return
- chat_id, message_id = self._event_room_and_message_id(event)
- if not chat_id or not message_id:
- # Routine, not a fault: the gateway runs agent-initiated turns
- # (heartbeat polls, goal continuations) through the same pipeline
- # with message_id=None, and there is no inbound message to mark.
- logger.debug(
- "Chatto: nothing to react to (chat_id=%r, message_id=%r)",
- chat_id,
- message_id,
- )
- return
- await self.add_reaction(chat_id, message_id, "👀")
- async def on_processing_complete(
- self,
- event: MessageEvent,
- outcome: ProcessingOutcome,
- ) -> None:
- """Close the turn's record, then swap 👀 for ✅/❌/🚫.
- Fires for every outcome, including CANCELLED (mid-run edit
- correction) — this is what re-arms `_processing` before the corrected
- turn is dispatched.
- BasePlatformAdapter override
- """
- session_key = (
- self._session_key_for(event.source) if event.source is not None else ""
- )
- if session_key and event.message_id:
- self._processing.pop(session_key, None)
- if not self.chatto_config.reactions.value:
- return
- chat_id, message_id = self._event_room_and_message_id(event)
- if not chat_id or not message_id:
- return
- # Remove the processing eyes reaction
- await self.remove_reaction(chat_id, message_id, "👀")
- # Add the outcome reaction
- if outcome == ProcessingOutcome.SUCCESS:
- await self.add_reaction(chat_id, message_id, "✅")
- elif outcome == ProcessingOutcome.FAILURE:
- await self.add_reaction(chat_id, message_id, "❌")
- elif outcome == ProcessingOutcome.CANCELLED:
- await self.add_reaction(chat_id, message_id, "🚫")
- # ------------------------------------------------------------------ #
- # Asset upload (chunked)
- # ------------------------------------------------------------------ #
- async def _upload_asset(self, room_id: str, file_path: str) -> str | None:
- """Upload a file via the chunked AssetUploadService.
- Returns the asset ID on success, or None on failure.
- """
- try:
- file_data = await asyncio.to_thread(_read_file_bytes, file_path)
- except Exception as e:
- logger.error("Chatto: failed to read file %s — %s", file_path, e)
- return None
- if not file_data:
- logger.error("Chatto: file %s is empty", file_path)
- return None
- file_size = len(file_data)
- file_name = os.path.basename(file_path)
- mime_type = mimetypes.guess_type(file_path)[0] or "application/octet-stream"
- sha256_hash = hashlib.sha256(file_data).hexdigest()
- client = await self._get_chatto_client()
- if client is None:
- logger.error("Chatto: upload aborted - no client available")
- return None
- try:
- # Step 1: Create upload session
- upload = await client.create_upload(
- room_id=room_id,
- filename=file_name,
- size=file_size,
- sha256=sha256_hash,
- content_type=mime_type,
- )
- # AssetUpload names this upload_id, not id — reading it through an
- # untyped getattr default is what let the mismatch reach production.
- upload_id = upload.upload_id
- if not upload_id:
- logger.error("Chatto: CreateUpload returned no upload ID")
- return None
- # Step 2: Upload chunks
- offset = 0
- while offset < file_size:
- chunk = file_data[offset : offset + ChattoConstants.UPLOAD_CHUNK_SIZE]
- chunk_sha256 = hashlib.sha256(chunk).hexdigest()
- await client.upload_chunk(
- upload_id=upload_id,
- offset=offset,
- content=chunk,
- chunk_sha256=chunk_sha256,
- )
- offset += len(chunk)
- # Step 3: Complete upload
- upload, asset = await client.complete_upload(upload_id=upload_id)
- if not asset:
- logger.error("Chatto: CompleteUpload returned no asset")
- return None
- logger.info(
- "Chatto: uploaded %s as asset %s (%d bytes)",
- file_name,
- asset.id,
- file_size,
- )
- return asset.id
- except ChattoError as e:
- logger.error("Chatto: upload failed: %s", e)
- return None
- except Exception as e:
- logger.error("Chatto: upload error: %s", e)
- return None
- async def _post_attachment_message(
- self,
- chat_id: str,
- asset_ids: list[str],
- caption: str | None,
- reply_to: str | None,
- metadata: dict[str, Any] | None,
- ) -> SendResult:
- """Post one message carrying already-uploaded assets.
- Threading follows the same rules as a text send
- (:meth:`_resolve_outbound_thread`), so with ``auto_thread`` disabled an
- attachment reply lands in the room like its text counterpart instead of
- quietly opening a thread.
- """
- thread_id = self._resolve_outbound_thread(chat_id, reply_to, metadata)
- client = await self._get_chatto_client()
- if client is None:
- return SendResult(
- success=False, error="Chatto client not available", retryable=True
- )
- try:
- msg = await client.post_message(
- room_id=str(chat_id),
- body=self.format_message(caption) if caption else "",
- attachment_asset_ids=asset_ids,
- thread_root_event_id=thread_id or "",
- )
- self._mark_seen(msg.id)
- return SendResult(success=True, message_id=msg.id)
- except ChattoError as e:
- # Same classification as the chunked text path: server-side
- # failures retry, anything else is ours and must not loop.
- return SendResult(success=False, error=str(e), retryable=True)
- except Exception as e:
- return SendResult(success=False, error=str(e), retryable=False)
- async def _send_local_file_as_attachment(
- self,
- chat_id: str,
- file_path: str,
- caption: str | None,
- reply_to: str | None,
- metadata: dict[str, Any] | None,
- *,
- kind: str,
- ) -> SendResult:
- """Upload a local file and post it as a native Chatto attachment.
- Shared by ``send_image_file``/``send_document``/``send_video``/
- ``send_voice`` — the upload mechanics are identical, only the wording of
- the failure notice differs. On failure we send that notice as text and
- never the host path (it leaks the Hermes home layout).
- """
- notice = f"⚠️ Couldn't deliver the {kind} attachment."
- safe_path = self.validate_media_delivery_path(file_path)
- if not safe_path:
- logger.warning(
- "[%s] send %s: unsafe path %s",
- self.name,
- kind,
- file_path,
- )
- text = f"{caption}\n{notice}" if caption else notice
- return await self.send(chat_id, text, reply_to=reply_to, metadata=metadata)
- asset_id = await self._upload_asset(str(chat_id), safe_path)
- if not asset_id:
- logger.warning(
- "[%s] send %s: upload failed for %s",
- self.name,
- kind,
- safe_path,
- )
- text = f"{caption}\n{notice}" if caption else notice
- return await self.send(chat_id, text, reply_to=reply_to, metadata=metadata)
- return await self._post_attachment_message(
- chat_id,
- [asset_id],
- caption,
- reply_to,
- metadata,
- )
- async def send_image_file(
- self,
- chat_id: str,
- image_path: str,
- caption: str | None = None,
- reply_to: str | None = None,
- metadata: dict[str, Any] | None = None,
- **kwargs,
- ) -> SendResult:
- """Send a local image file via the chunked upload API.
- The parameter is ``image_path``, not ``file_path``: every caller passes
- it by keyword (``gateway/run.py:22354``, ``:22470``, and the base class's
- own ``send_multiple_images`` file:// branch), so a renamed parameter
- makes each of those raise TypeError and silently degrade to a text
- notice.
- BasePlatformAdapter override
- """
- return await self._send_local_file_as_attachment(
- chat_id,
- image_path,
- caption,
- reply_to,
- metadata,
- kind="image",
- )
- async def send_document(
- self,
- chat_id: str,
- file_path: str,
- caption: str | None = None,
- file_name: str | None = None,
- reply_to: str | None = None,
- metadata: dict[str, Any] | None = None,
- **kwargs,
- ) -> SendResult:
- """Send a local file as a native Chatto attachment.
- ``file_name`` exists in the base-class signature and is accepted for
- compatibility, but Chatto takes the recipient-visible filename from
- the upload session (derived from the local path); failures are logged
- and noticed by ``_send_local_file_as_attachment`` itself.
- BasePlatformAdapter override
- """
- return await self._send_local_file_as_attachment(
- chat_id,
- file_path,
- caption,
- reply_to,
- metadata,
- kind="file",
- )
- async def send_video(
- self,
- chat_id: str,
- video_path: str,
- caption: str | None = None,
- reply_to: str | None = None,
- metadata: dict[str, Any] | None = None,
- **kwargs,
- ) -> SendResult:
- """Send a local video as a native Chatto attachment.
- Chatto transcodes and plays it inline.
- BasePlatformAdapter override
- """
- return await self._send_local_file_as_attachment(
- chat_id,
- video_path,
- caption,
- reply_to,
- metadata,
- kind="video",
- )
- async def send_voice(
- self,
- chat_id: str,
- audio_path: str,
- caption: str | None = None,
- reply_to: str | None = None,
- metadata: dict[str, Any] | None = None,
- **kwargs,
- ) -> SendResult:
- """Send a local audio file as a native Chatto attachment.
- Chatto has no dedicated voice-bubble type, so this is an ordinary audio
- attachment — still far better than the base class's text notice.
- BasePlatformAdapter override
- """
- return await self._send_local_file_as_attachment(
- chat_id,
- audio_path,
- caption,
- reply_to,
- metadata,
- kind="audio",
- )
- async def send_image(
- self,
- chat_id: str,
- image_url: str,
- caption: str | None = None,
- reply_to: str | None = None,
- metadata: dict[str, Any] | None = None,
- ) -> SendResult:
- """Send an image to a Chatto room.
- Materialises the URL (size-capped download, like every inbound
- attachment) and uploads it as a native attachment. Falls back to the
- plain URL as a link — Chatto renders link previews — when the URL
- cannot be materialised or the post after a successful upload fails.
- An upload failure needs no fallback on top: the text notice of
- ``_send_local_file_as_attachment`` has already gone out.
- BasePlatformAdapter override
- """
- link_text = f"{caption}\n{image_url}" if caption else image_url
- path, is_temp = await self._materialise_image(image_url)
- if path is not None:
- try:
- result = await self._send_local_file_as_attachment(
- chat_id, path, caption, reply_to, metadata, kind="image"
- )
- finally:
- if is_temp:
- try:
- os.unlink(path)
- except OSError:
- pass
- if result.success:
- return result
- return await self.send(chat_id, link_text, reply_to=reply_to, metadata=metadata)
- async def _materialise_image(self, image_url: str) -> tuple[str | None, bool]:
- """Resolve one ``send_multiple_images`` entry to a local file path.
- Accepts ``http(s)://`` URLs (downloaded to a temp file), ``file://``
- URIs and bare paths. Returns ``(path, is_temp)`` — the caller unlinks
- when ``is_temp``. ``(None, False)`` means the entry is unusable.
- """
- if image_url.startswith(("http://", "https://")):
- ext = os.path.splitext(urlsplit(image_url).path)[1] or ".png"
- tmp_fd, tmp_path = tempfile.mkstemp(suffix=ext, prefix="chatto_img_")
- os.close(tmp_fd)
- try:
- data = await self._download_attachment_bytes(image_url)
- await asyncio.to_thread(_write_file_bytes, tmp_path, data)
- except Exception as e:
- logger.warning("Chatto: image download failed for %s: %s", image_url, e)
- try:
- os.unlink(tmp_path)
- except OSError:
- pass
- return None, False
- return tmp_path, True
- local = image_url
- if local.startswith("file://"):
- local = unquote(urlsplit(local).path)
- return self.validate_media_delivery_path(local), False
- async def send_multiple_images(
- self,
- chat_id: str,
- images: list[tuple[str, str]],
- metadata: dict[str, Any] | None = None,
- human_delay: float = 0.0,
- ) -> SendResult:
- """Send a batch of images as ONE message with several attachments.
- The base implementation posts each image separately; a Chatto message
- carries a list of attachment assets, so a batch belongs in a single
- message (and a single notification).
- ``human_delay`` is ignored deliberately — there is only one outbound
- call to pace. Entries that can't be fetched are dropped with a warning;
- if nothing survives, we fall back to the base class so the user still
- gets the links.
- BasePlatformAdapter override
- """
- if len(images or []) < 2:
- return await super().send_multiple_images(
- chat_id,
- images,
- metadata=metadata,
- human_delay=human_delay,
- )
- asset_ids: list[str] = []
- captions: list[str] = []
- for image_url, alt_text in images:
- path, is_temp = await self._materialise_image(image_url)
- if not path:
- logger.warning("Chatto: skipping unusable image %s", image_url)
- continue
- try:
- asset_id = await self._upload_asset(str(chat_id), path)
- finally:
- if is_temp:
- try:
- os.unlink(path)
- except OSError:
- pass
- if not asset_id:
- logger.warning("Chatto: upload failed for image %s", image_url)
- continue
- asset_ids.append(asset_id)
- if alt_text:
- captions.append(alt_text)
- if not asset_ids:
- logger.warning(
- "Chatto: no image survived upload, falling back to per-image delivery",
- )
- return await super().send_multiple_images(
- chat_id,
- images,
- metadata=metadata,
- human_delay=human_delay,
- )
- if len(asset_ids) < len(images):
- logger.warning(
- "Chatto: sending %d of %d images — the rest could not be uploaded",
- len(asset_ids),
- len(images),
- )
- return await self._post_attachment_message(
- chat_id,
- asset_ids,
- "\n".join(captions) or None,
- None,
- metadata,
- )
- # ---------------------------------------------------------------------------
- # Cron / out-of-process delivery
- # ---------------------------------------------------------------------------
- async def hermes_standalone_sender_fn(
- pconfig: PlatformConfig,
- chat_id: str,
- message: str,
- *,
- thread_id=None,
- media_files=None,
- force_document=False,
- ) -> SendResult:
- """Deliver a message to Chatto without a running gateway adapter. Do not modify signature.
- Used by cron / scheduled routines that run out-of-process. Creates a
- short-lived chattolib client, posts, and closes. Long messages are
- normalised and split like ``send()`` does, so cron output cannot die on
- the server's per-message limit.
- """
- chatto_config: ChattoConfiguration = ChattoConfiguration(pconfig=pconfig)
- # Create a temporary client for standalone sending — needs a base URL and token.
- has_token = bool(chatto_config.token.value)
- if not chatto_config.base_url.value or not has_token:
- return SendResult(success=False, error="Chatto: base URL or token missing")
- client = ChattoClient(
- base_url=chatto_config.base_url.value, token=chatto_config.token.value
- )
- try:
- kwargs: dict[str, Any] = {}
- if chatto_config.auto_thread.value and thread_id:
- kwargs["thread_root_event_id"] = thread_id
- if media_files and media_files.get("attachment_asset_ids"):
- kwargs["attachment_asset_ids"] = list(media_files["attachment_asset_ids"])
- formatted = _normalise_outbound_text(message)
- chunks = BasePlatformAdapter.truncate_message(
- formatted, ChattoConstants.SPLIT_THRESHOLD
- )
- message_ids: list[str] = []
- try:
- for chunk in chunks:
- posted = await client.post_message(chat_id, chunk, **kwargs)
- message_ids.append(posted.id)
- except Exception as exc:
- if message_ids:
- logger.warning(
- "Chatto standalone: sent %d/%d chunk(s) to %s before failing: %s",
- len(message_ids),
- len(chunks),
- chat_id,
- exc,
- )
- # Same classification as the adapter's send paths: only
- # server-side failures read as retryable.
- return SendResult(
- success=False,
- error=str(exc),
- retryable=isinstance(exc, ChattoError),
- )
- return SendResult(success=True, message_id=message_ids[0])
- finally:
- try:
- await client.close()
- except Exception as exc:
- logger.warning(
- "Chatto standalone: error closing short-lived client (perhaps already closed): %s",
- exc,
- )
- # Resolved Chatto configuration — populated by ``hermes_validate_config`` so
- # plugin tools can access it without re-reading env vars or duplicating
- # ``ChattoConfiguration`` logic.
- #
- # Keyed by the profile the snapshot was validated for, not stored in one slot:
- # Hermes multiplexes several profiles through a single gateway process and runs
- # every profile's own validate_config (run_adapters.py, one _create_adapter per
- # profile), so a single global would be whichever profile validated last — and a
- # routed cron fire or turn for another profile would then send with the wrong
- # profile's bot token. The key is the same home key the platform registry scopes
- # its own entries by, so both agree on what "the serving profile" means.
- _resolved_chatto_configs: dict[str, ChattoConfiguration] = {}
- def _profile_scope_key() -> str:
- """Registry key of the profile being served right now.
- Falls back to a constant when ``hermes_constants`` is unavailable (a bare
- standalone sender process): one profile there, so one key loses nothing.
- """
- try:
- from hermes_constants import hermes_home_key
- return hermes_home_key()
- except Exception:
- logger.debug("Chatto: no profile scope key available", exc_info=True)
- return ""
- # How similar an ``extra`` key must be to a declared config_key before the
- # unknown-key check reads it as a likely typo or renamed field.
- _NEAR_MISS_RATIO = 0.75
- def _warn_on_unknown_extra_keys(config: PlatformConfig) -> None:
- """Warn about ``extra`` keys that look like misspelled config fields.
- A typo'd key silently resolves to the default otherwise — the warning is
- the only thing telling the user their ``require_mention_channles`` never
- reached us. Only near-matches against our declared config_keys are
- flagged (difflib similarity): keys that resemble nothing of ours are
- either placed there by the Hermes gateway itself (the shared-key loop in
- load_gateway_config() bridges reply_in_thread & co. into every platform's
- extra, hardcoded inline upstream — nothing to import) or are deliberate
- pass-throughs, and flagging those would just train users to ignore us.
- Internal markers (``_enabled_explicit``) are skipped outright.
- """
- extra: dict[str, Any] = getattr(config, "extra", None) or {}
- known = [field.config_key for field in ChattoConfiguration.fields()]
- for key in sorted(extra):
- if key.startswith("_") or key in known:
- continue
- best = max(known, key=lambda k: SequenceMatcher(None, key, k).ratio())
- if SequenceMatcher(None, key, best).ratio() >= _NEAR_MISS_RATIO:
- logger.warning(
- "Chatto: 'extra' key '%s' matches no config field — did you mean '%s'?",
- key,
- best,
- )
- def hermes_validate_config(config: PlatformConfig) -> bool:
- """Check whether Chatto Plugin is configured.
- Function name should be the same as register argument name with "hermes_" prefix, so we
- know that it is needed for plugin register(). Do not change signature.
- Takes ``config``. Compare to hermes_is_connected().
- """
- resolved = ChattoConfiguration(pconfig=config)
- _warn_on_unknown_extra_keys(config)
- if len(resolved.allowed_users.value) > 0 and resolved.allow_all_users.value:
- logger.error(
- "Chatto: Conflicting configuration. Either use 'allowed_users' or 'allow_all_users' but not both."
- )
- return False
- require_rooms = set(resolved.require_mention_rooms.value)
- optional_rooms = set(resolved.optional_mention_rooms.value)
- overlap = sorted(require_rooms & optional_rooms)
- if overlap:
- logger.error(
- "Chatto: Conflicting configuration. Room(s) %s are on both "
- "'require_mention_rooms' and 'optional_mention_rooms' — "
- "each room must appear in at most one of them.",
- ", ".join(overlap),
- )
- return False
- # base_url always resolves (it defaults to ChattoHQ), so the only real
- # question is whether a token came in.
- if resolved.token.value is None:
- logger.error("Chatto: CHATTO_TOKEN must be set.")
- return False
- # Publish for the plugin tools only now: a config we just rejected is not
- # one they should send with, and a rejected call must not overwrite a
- # snapshot an earlier, accepted call left behind.
- _resolved_chatto_configs[_profile_scope_key()] = resolved
- return True
- def hermes_check_fn() -> bool:
- """Report whether the vendored chattolib dependency can be imported."""
- try:
- from chattolib import (
- client, # noqa: F401 — vendored dependency probe
- )
- return True
- except ImportError:
- return False
- # ---------------------------------------------------------------------------
- # is_connected probe
- # ---------------------------------------------------------------------------
- def hermes_is_connected(config: PlatformConfig) -> bool:
- """Report whether the Chatto platform is configured and enabled.
- The name is fixed by the register() contract, but despite what it
- suggests this does not open a connection — it validates configuration
- only (see :func:`hermes_validate_config`); the gateway probes real
- connectivity through ``connect()``.
- """
- return bool(hermes_validate_config(config) and config.enabled)
- def hermes_setup_fn() -> None:
- """Interactive setup wizard for Chatto. Is called by and only works in Hermes CLI context.
- Function name should be the same as register argument name with "hermes_" prefix, so we
- know that it is needed for plugin register().
- """
- from hermes_cli.setup import (
- print_success,
- prompt,
- prompt_yes_no,
- save_env_value,
- )
- url = prompt(
- "Chatto server URL (e.g. https://chat.example.com) or leave blank for default ChattoHQ on chat.chatto.run:"
- )
- if url:
- save_env_value(ChattoConfiguration.base_url.env_name, url)
- token = prompt("Chatto bot token (cht_BK_...):", password=True)
- if token:
- save_env_value(ChattoConfiguration.token.env_name, token)
- home = prompt("Home room ID for notifications (or empty):")
- if home:
- save_env_value(ChattoConfiguration.home_channel.env_name, home)
- allow_all = prompt_yes_no("Allow all users to talk? (true/false):")
- if allow_all:
- save_env_value(ChattoConfiguration.allow_all_users.env_name, str(allow_all))
- print_success("\n✓ Chatto configured. Restart the gateway to activate.")
- def hermes_env_enablement_fn() -> dict:
- """Seed PlatformConfig.extra from the CHATTO_* environment variables.
- Returns a dict compatible with the PlatformConfig merge hook, holding
- exactly the values that are actually set via env — never fabricated
- defaults. Called by the platform registry during load_gateway_config(),
- which commits this dict onto the platform's ``extra`` verbatim; seeding a
- value that was not configured would overwrite what the user set in
- config.yaml (e.g. a YAML base_url clobbered by the ChattoHQ default).
- "Nothing set" therefore stays the adapter's business: every ConfigField
- falls back to its declared default (base_url to ChattoHQ) on its own.
- Seed keys are the config.yaml "extra" keys (config_key), NOT the env var
- names — ChattoConfiguration reads extra[config_key]. The special
- 'home_channel' key is extracted by the gateway and becomes a proper
- HomeChannel dataclass on the PlatformConfig; every other key is merged
- into PlatformConfig.extra.
- Function name should be the same as register argument name with "hermes_" prefix, so we
- know that it is needed for plugin register().
- """
- seed: dict[str, Any] = {}
- for config_field in ChattoConfiguration.fields():
- env_value = os.getenv(config_field.env_name)
- if env_value:
- seed[config_field.config_key] = env_value.strip()
- logger.debug("seed: %s", {k: v for k, v in seed.items() if k != "token"})
- return seed
- # ---------------------------------------------------------------------------
- # Plugin registration entry point
- # ---------------------------------------------------------------------------
- # What each capability is called in the startup banner, keyed by the method
- # that implements it. Derived from real overrides rather than hard-coded, so
- # dropping a method drops its claim from the log instead of leaving a lie.
- _CAPABILITY_LABELS = {
- "send": "text",
- "send_image_file": "images",
- "send_multiple_images": "image batches (bundled into one message)",
- "send_video": "video",
- "send_voice": "voice messages",
- "send_document": "documents",
- "add_reaction": "reactions",
- "edit_message": "message editing",
- "delete_message": "message deletion",
- "send_typing": "typing indicators",
- "create_handoff_thread": "threads",
- "create_room": "room creation",
- }
- def _capabilities() -> list[str]:
- """Name the things this adapter genuinely implements itself.
- A capability counts only when ChattoAdapter overrides the base method —
- inheriting BasePlatformAdapter's fallback means the feature is not
- natively supported, and announcing it would mislead.
- """
- found = [
- label
- for name, label in _CAPABILITY_LABELS.items()
- if getattr(ChattoAdapter, name, None)
- is not getattr(BasePlatformAdapter, name, None)
- ]
- if ChattoAdapter.supports_code_blocks:
- found.append("code blocks")
- if ChattoAdapter.supports_status_text:
- found.append("custom status text")
- found.append("presence (refreshed while connected)")
- return found
- # --------------------------------------------------------------------------- #
- # Plugin tools: send DM to a user, or send to a room
- # --------------------------------------------------------------------------- #
- class _ToolRefusal(Exception):
- """A tool step that ends the call with a result for the model.
- The rendered JSON travels on the exception, so every early exit reads the
- same to Hermes and none of them escapes as an unhandled error.
- """
- def __init__(self, result_json: str) -> None:
- super().__init__(result_json)
- self.result_json = result_json
- def _refuse(error: str, **extra: Any) -> _ToolRefusal:
- """Build a refusal result, so every early exit agrees on the shape."""
- return _ToolRefusal(json.dumps({"success": False, "error": error, **extra}))
- @asynccontextmanager
- async def _tool_client(cfg: ChattoConfiguration | None) -> AsyncIterator[ChattoClient]:
- """A short-lived client for one tool call, closed however the call ends.
- Credentials come from the resolved configuration and from nowhere else. A
- tool argument carrying ``base_url`` would send the configured bot token to
- whatever host the caller named, and every message the bot reads is
- something a caller could talk it into repeating.
- """
- if cfg is None:
- raise _refuse("Chatto configuration unavailable")
- token = cfg.token.value or ""
- if not token:
- raise _refuse("Chatto token not configured")
- try:
- client = ChattoClient(
- base_url=cfg.base_url.value or ChattoClient.DEFAULT_BASE_URL, token=token
- )
- except Exception as exc:
- raise _refuse(f"Failed to create Chatto client: {exc}") from exc
- try:
- yield client
- finally:
- try:
- await client.close()
- except Exception as exc: # pragma: no cover — close is best-effort
- logger.debug("Chatto tools: client close failed: %s", exc)
- CHATTO_LIST_ROOMS_SCHEMA = {
- "name": "chatto_list_rooms",
- "description": (
- "List the Chatto rooms visible to the bot (channels and DM rooms), with "
- "their room IDs and whether the bot is a member. Check `is_member` before "
- "posting: the bot can see rooms it has not joined, and cannot post in "
- "them. Use this to resolve a channel name to its room ID — e.g. to find "
- "the 'platform:chat_id' address for a cron job's `deliver` target. "
- "Optional `name` filters case-insensitively by substring."
- ),
- "parameters": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": (
- "Optional: case-insensitive substring filter on the room name "
- "(e.g. 'liv' matches 'Liv' and 'Liv-Dev'). Empty lists all rooms."
- ),
- },
- },
- "required": [],
- "additionalProperties": False,
- },
- }
- CHATTO_SEND_DM_SCHEMA = {
- "name": "chatto_send_dm",
- "description": (
- "Send a text message as a **Direct Message** to another Chatto user. "
- "Looks up the user by `user_login` or `user_id` and posts into the DM "
- "room you already have with them. Returns success with the room_id "
- "and message_ids, or an error."
- ),
- "parameters": {
- "type": "object",
- "properties": {
- "user_login": {
- "type": "string",
- "description": (
- "The Chatto login name of the recipient "
- "(e.g. 'nickk'). Exactly one of `user_login` or `user_id` is required."
- ),
- },
- "user_id": {
- "type": "string",
- "description": (
- "The Chatto user ID of the recipient "
- "(e.g. 'Uxxxxxxxx'). Exactly one of `user_login` or `user_id` is required."
- ),
- },
- "message": {
- "type": "string",
- "description": "The message text to send (markdown supported).",
- },
- },
- "required": ["message"],
- "additionalProperties": False,
- },
- }
- CHATTO_SEND_ROOM_SCHEMA = {
- "name": "chatto_send_room",
- "description": (
- "Send a text message to a Chatto **room** (channel or DM room) "
- "by its room ID or room name. Channels the bot is configured to "
- "answer in only — a room on neither mention list stays read-only. "
- "Returns success with the message_ids, or an error."
- ),
- "parameters": {
- "type": "object",
- "properties": {
- "room_id": {
- "type": "string",
- "description": (
- "The Chatto room ID of the destination "
- "(e.g. 'RbmwiHk4vs9a3Ql'). Exactly one of `room_id` or `room_name` is required."
- ),
- },
- "room_name": {
- "type": "string",
- "description": (
- "The display name of the room (case-insensitive). Exactly one "
- "of `room_id` or `room_name` is required. If several rooms "
- "share the name, the call returns their IDs instead of guessing."
- ),
- },
- "message": {
- "type": "string",
- "description": "The message text to send (markdown supported).",
- },
- "thread_root_event_id": {
- "type": "string",
- "description": (
- "Optional: event ID of the thread-root message. When given, "
- "this message is posted INSIDE that thread, which has to be "
- "a thread root of the destination room. Mutually exclusive "
- "with `create_thread`."
- ),
- },
- "create_thread": {
- "type": "boolean",
- "description": (
- "Optional: post this message as the ROOT of a new thread "
- "(default false = normal message). Only for channel rooms. "
- "Mutually exclusive with `thread_root_event_id`."
- ),
- },
- },
- "required": ["message"],
- "additionalProperties": False,
- },
- }
- def _chatto_config_for_tools() -> ChattoConfiguration | None:
- """Resolve the Chatto configuration for plugin tool handlers.
- Two tiers, most specific first:
- 1. The snapshot ``hermes_validate_config`` published for *this* profile — the
- authoritative one in a running gateway.
- 2. A fresh read of config.yaml plus the serving profile's own secrets, for
- the cron and standalone sessions where the gateway load hooks never ran
- and the dotenv residue has been stripped from ``os.environ``. Mirrors how
- the built-in send_message tool resolves its pconfig
- (tools/send_message_tool.py).
- Both tiers are keyed by the serving profile, so a multiplexed gateway hands
- each profile its own credentials rather than whichever one was served last.
- Returns ``None`` when neither tier yields a configuration; the caller
- reports that rather than guessing at credentials.
- """
- scope_key = _profile_scope_key()
- snapshot = _resolved_chatto_configs.get(scope_key)
- if snapshot is not None:
- return snapshot
- # config.yaml's own ``extra`` block, so a deployment configured there — and
- # nowhere in .env — is honoured outside the gateway process too.
- try:
- from gateway.config import Platform as GatewayPlatform
- from gateway.config import load_gateway_config
- pconfig = load_gateway_config().platforms.get(
- GatewayPlatform(ChattoConstants.PLATFORM_NAME)
- )
- resolved = ChattoConfiguration(pconfig=_pconfig_or_empty(pconfig))
- except Exception as exc:
- logger.warning("Chatto tools: could not read gateway config: %s", exc)
- return None
- # In a fresh cron scope the dotenv residue is stripped from os.environ, so
- # ChattoConfiguration's env layer sees nothing. The secrets then come from
- # the scope Hermes installed for the profile being served when there is one —
- # that mapping is that profile's authoritative secret set, and rebuilding
- # one from the launch home would answer with another profile's credentials.
- # With no scope installed (CLI, bare standalone sender) the profile's own
- # .env is the right source, and build_profile_secret_scope reads it
- # directly in gateway, cron and CLI contexts alike.
- try:
- from agent.secret_scope import current_secret_scope
- profile_secrets = current_secret_scope()
- if profile_secrets is None:
- from agent.secret_scope import build_profile_secret_scope
- from hermes_constants import get_hermes_home
- profile_secrets = dict(build_profile_secret_scope(get_hermes_home()))
- except Exception as exc:
- logger.warning("Chatto tools: profile secret scope build failed: %s", exc)
- profile_secrets = {}
- resolved.overlay_profile_secrets(profile_secrets)
- _resolved_chatto_configs[scope_key] = resolved
- return resolved
- def _room_answers_in(
- cfg: ChattoConfiguration | None, room_id: str, kind: RoomKind | None
- ) -> bool:
- """Whether the bot takes part in this room: answers there, and may post.
- The single definition of that question, on purpose. It answers for two
- callers whose disagreement would be a bug the user cannot see:
- - ``ChattoAdapter._answers_in_room``, the *inbound* gate — whether a
- message here reaches the agent at all
- - ``_room_is_writable``, the *outbound* gate on the send tools, so a tool
- cannot post into a room that would never have answered
- Chatto knows only DMs and channels, so the split is ``kind == DM``: a DM
- always answers (``/join`` must stay reachable), and every other kind —
- channel, an unknown kind (which is how servers that never set ``kind`` show
- up), or a room the adapter has not resolved yet, so ``kind`` is None —
- opts in through one of the two mention lists. The lists are mutually
- exclusive by validation; should contradictory config reach a running adapter
- anyway, optional beats require, because answering a room is safer than
- muting it. A ``cfg`` of None means no configuration could be resolved at
- all, and then nothing but a DM qualifies.
- """
- if kind == RoomKind.DM:
- return True
- if cfg is None:
- return False
- if room_id in cfg.optional_mention_rooms.value:
- return True
- return room_id in cfg.require_mention_rooms.value
- def _pconfig_or_empty(pconfig: PlatformConfig | None) -> PlatformConfig:
- """The Chatto PlatformConfig from config.yaml, or an empty stand-in."""
- if pconfig is not None:
- return pconfig
- from gateway.config import PlatformConfig as GatewayPlatformConfig
- return GatewayPlatformConfig(enabled=True, extra={})
- def _room_is_writable(
- cfg: ChattoConfiguration | None, room: Room, room_id: str
- ) -> bool:
- """Whether the bot may post into this room on its own initiative.
- Delegates to ``_room_answers_in`` so the outbound gate is the *same*
- function as the inbound one: a room that would never be answered must not
- be postable, and two copies of that rule would drift apart until the send
- tool became a way around the read-only promise.
- """
- return _room_answers_in(cfg, room_id, room.kind)
- def _read_only_room_refusal(room_label: str) -> _ToolRefusal:
- """The refusal a read-only room earns, naming where to opt it in.
- This reply is where an operator copies the room ID from, so it spells both
- env vars out verbatim.
- """
- return _refuse(
- f"Room '{room_label}' is configured read-only: the bot neither answers "
- "there nor posts to it on its own initiative. To allow that, add the "
- f"room ID to {ChattoConfiguration.require_mention_rooms.env_name} (only "
- f"answers when addressed) or {ChattoConfiguration.optional_mention_rooms.env_name} "
- "(answers everything) in ~/.hermes/.env, and restart the gateway."
- )
- class _ChunkDelivery(NamedTuple):
- """What a split send actually put into a room.
- ``error`` is the exception that stopped the batch, if any: the chunks in
- ``message_ids`` did go out and must not be resent. Each caller shapes this
- into its own result contract — a ``SendResult`` for the adapter, a refusal
- for the tools — because those are genuinely different contracts; the
- *sending* is not. ``chunks_total`` counts what the split produced, so a
- caller can report "got 1 of 3 out" without re-deriving the split.
- """
- message_ids: list[str]
- root_event_id: str
- error: Exception | None
- chunks_total: int
- async def _deliver_chunks(
- client: ChattoClient,
- room_id: str,
- message: str,
- *,
- thread_root_event_id: str = "",
- create_thread: bool = False,
- on_posted: Callable[[str], None] | None = None,
- ) -> _ChunkDelivery:
- """Post a message split at the server limit, stopping at the first failure.
- One implementation for both send paths, because the decisions are the same
- and a copy of each drifts: split at ``SPLIT_THRESHOLD`` like every other
- send, and route a split answer as *one* answer — chunk 1 opens a thread
- (``create_thread``) or joins the one passed in, and every later chunk
- carries that root, so a long reply does not scatter across the timeline.
- ``on_posted`` is the adapter's ``_mark_seen``: the tools have no dedup state
- to keep, the adapter must not treat its own output as unread input. The
- first failure stops the batch and is returned rather than raised — the
- caller knows better than this function what a partial send means to it, and
- what to call the exception (``ChattoError`` is a server failure, anything
- else is a bug here).
- """
- normalised = _normalise_outbound_text(message)
- chunks = BasePlatformAdapter.truncate_message(
- normalised, ChattoConstants.SPLIT_THRESHOLD
- )
- message_ids: list[str] = []
- root_id = thread_root_event_id
- for chunk in chunks:
- try:
- posted = await client.post_message(
- room_id=room_id, body=chunk, thread_root_event_id=root_id
- )
- except Exception as exc:
- return _ChunkDelivery(message_ids, root_id, exc, len(chunks))
- message_ids.append(posted.id)
- if on_posted is not None:
- on_posted(posted.id)
- if create_thread and not root_id:
- root_id = posted.id
- return _ChunkDelivery(message_ids, root_id, None, len(chunks))
- async def _post_chunks(
- client: ChattoClient,
- room_id: str,
- message: str,
- *,
- thread_root_event_id: str = "",
- create_thread: bool = False,
- ) -> tuple[list[str], str]:
- """Post a message through ``_deliver_chunks`` as a tool result. ``(ids, root)``.
- A chunk that fails leaves the earlier ones delivered, so this refuses with
- exactly what went out: calling a half-delivered send a plain failure
- invites an agent to retry and duplicate what the room already has.
- """
- delivery = await _deliver_chunks(
- client,
- room_id,
- message,
- thread_root_event_id=thread_root_event_id,
- create_thread=create_thread,
- )
- if delivery.error is not None:
- # Blame the server only for a server error. chattolib maps every
- # transport failure to ChattoError, so anything else is a bug on our
- # side — calling that "Chatto API error" would send an operator hunting
- # the wrong component.
- cause = (
- "Chatto API error"
- if isinstance(delivery.error, ChattoError)
- else "Internal plugin error"
- )
- raise _refuse(
- f"{cause}: {delivery.error}",
- # partial marks a half-delivered send; the caller must not
- # resend it from the top without knowing about these chunks.
- partial=bool(delivery.message_ids),
- room_id=room_id,
- message_ids=delivery.message_ids,
- chunks_sent=len(delivery.message_ids),
- chunks_total=delivery.chunks_total,
- ) from delivery.error
- return delivery.message_ids, delivery.root_event_id
- async def _find_user_by_login(client: ChattoClient, user_login: str) -> tuple[str, str]:
- """Find a user among the members of our DM rooms, ``(user_id, login)``.
- Both are empty when no room yields the login. Only a person can start a DM,
- so a DM room is the only place a deliverable recipient can be — scanning
- the channels the bot sits in would cost one member RPC per room and could
- resolve a login whose DM does not exist yet. A bot cannot read the
- server-wide user directory either: that needs admin rights.
- Every DM room is searched, including one whose membership the directory
- left unreported — that field is optional, and skipping such a room would
- make its login unfindable while the DM room sits right there.
- """
- for rws in await client.list_rooms():
- room = rws.room
- if room is None or room.kind != RoomKind.DM:
- continue
- try:
- member_ids, _ = await client.list_room_members(room.id, search=user_login)
- except ChattoError as exc:
- # A room we cannot enumerate must not abort the search over the
- # remaining ones.
- logger.debug("Chatto tools: member search in %s failed: %s", room.id, exc)
- continue
- if not member_ids:
- continue
- for member in await client.batch_get_room_members(room.id, member_ids):
- user = member.user
- if (
- user is not None
- and user.login
- and user.login.casefold() == user_login.casefold()
- ):
- return user.id, user.login
- return "", ""
- async def _find_dm_room(
- client: ChattoClient, our_id: str, other_id: str
- ) -> Room | None:
- """The DM room between two users, or None when there is none yet.
- Membership is read from the room object the directory already returned, and
- only falls back to a ListMembers RPC when that came back empty:
- ``member_user_ids`` is not among the fields the ListRooms documentation
- lists for ``RoomWithViewerState``, so a server is free to leave it
- unpopulated — and a DM room we can see plainly exists, whatever the
- directory said about who is in it. The fallback costs one RPC per DM room
- and only on servers that need it.
- """
- for rws in await client.list_rooms():
- room = rws.room
- if room is None or room.kind != RoomKind.DM:
- continue
- if rws.member_user_ids:
- if other_id in rws.member_user_ids and our_id in rws.member_user_ids:
- return room
- continue
- try:
- member_ids, _page = await client.list_room_members(room.id)
- except ChattoError as exc:
- # An unreadable room cannot be the one we want, but it must not
- # abort the search over the remaining ones.
- logger.debug("Chatto tools: members of DM %s unreadable: %s", room.id, exc)
- continue
- if other_id in member_ids and our_id in member_ids:
- return room
- return None
- class _ResolvedRoom(NamedTuple):
- """A room the send path resolved, plus whether the bot belongs to it.
- Membership travels with the room because the directory answers a broader
- question than the send path can use: a room the bot can *see* is not one it
- can *post in* (ListRooms returns visible channels, membership or room.list
- permission). Splitting that into two lookups would be a second chance to
- disagree with the state the first one already carried.
- """
- room: Room
- is_member: bool
- async def _resolve_room(
- client: ChattoClient, room_id: str, room_name: str
- ) -> _ResolvedRoom:
- """The destination room, by ID or by name.
- A name is not unique on Chatto — two room groups may both hold an "Ops" —
- and delivering to whichever the directory listed first is not a choice
- anyone made, so an ambiguous name asks for the ID instead.
- """
- if room_id:
- room_viewer_state = await client.get_room(room_id)
- if room_viewer_state is None or room_viewer_state.room is None:
- raise _refuse(
- f"Room {room_id} was not found, or the bot cannot see it. "
- "Use chatto_list_rooms to look up a room ID."
- )
- return _ResolvedRoom(
- room_viewer_state.room, room_viewer_state.viewer_state.is_member
- )
- matches = [
- rws
- for rws in await client.list_rooms()
- if rws.room is not None
- and (rws.room.name or "").casefold() == room_name.casefold()
- ]
- if not matches:
- raise _refuse(
- f"Room not found: {room_name}. Use chatto_list_rooms to see the available names."
- )
- if len(matches) > 1:
- candidates = ", ".join(
- f"{rws.room.id} ('{rws.room.name}')" # type: ignore[union-attr]
- for rws in matches
- )
- raise _refuse(
- f"Room name '{room_name}' is ambiguous — {len(matches)} rooms carry it: "
- f"{candidates}. Pass the room_id instead."
- )
- only = matches[0]
- assert only.room is not None # the filter above guarantees a room
- return _ResolvedRoom(only.room, only.viewer_state.is_member)
- async def _send_dm(args: dict) -> str:
- """Resolve the recipient, find the DM room, post. See _handle_chatto_send_dm."""
- user_login = args.get("user_login") or ""
- user_id = args.get("user_id") or ""
- message = args.get("message") or ""
- if not message:
- raise _refuse("message is required")
- if not user_login and not user_id:
- raise _refuse("Exactly one of user_login or user_id is required")
- async with _tool_client(_chatto_config_for_tools()) as client:
- # A bot cannot read the server-wide user directory (that needs admin
- # rights), so a login is resolved among the members of shared rooms.
- target_user_id = user_id
- target_login = user_login
- if not target_user_id:
- target_user_id, target_login = await _find_user_by_login(client, user_login)
- if not target_user_id:
- raise _refuse(f"User not found: {user_login} shares no DM with the bot")
- # Only people may start a DM (Chatto permissions guide), so a recipient
- # who has never written to the bot has no room to post into — say so
- # instead of guessing at a server rejection later.
- dm_room = await _find_dm_room(client, (await client.me()).id, target_user_id)
- if dm_room is None:
- raise _refuse(
- f"No DM with {user_login or user_id} exists yet: on Chatto only a "
- "person can start a DM, so they have to send the bot a message "
- "once before it can message them"
- )
- message_ids, _root_id = await _post_chunks(client, dm_room.id, message)
- return json.dumps(
- {
- "success": True,
- "dm_room_id": dm_room.id,
- "recipient": target_login,
- "recipient_user_id": target_user_id,
- "message_ids": message_ids,
- "chunks_sent": len(message_ids),
- }
- )
- async def _send_room(args: dict) -> str:
- """Resolve the room, check the gates, post. See _handle_chatto_send_room."""
- room_id = args.get("room_id") or ""
- room_name = args.get("room_name") or ""
- message = args.get("message") or ""
- thread_root_event_id = args.get("thread_root_event_id") or ""
- create_thread = bool(args.get("create_thread", False))
- if not message:
- raise _refuse("message is required")
- if not room_id and not room_name:
- raise _refuse("Exactly one of room_id or room_name is required")
- if thread_root_event_id and create_thread:
- raise _refuse("thread_root_event_id and create_thread are mutually exclusive")
- cfg = _chatto_config_for_tools()
- async with _tool_client(cfg) as client:
- resolved = await _resolve_room(client, room_id, room_name)
- room = resolved.room
- # Posting into a room the plugin treats as read-only would break a
- # promise the README makes about unlisted rooms staying silent.
- if not _room_is_writable(cfg, room, room.id):
- raise _read_only_room_refusal(room.name or room.id)
- if create_thread and room.kind == RoomKind.DM:
- raise _refuse(
- "A DM has no threads: drop create_thread and send it as a normal message."
- )
- # The directory lists rooms the bot can see but has not joined, and
- # posting into one fails server-side with an error that names neither
- # the room nor the fix.
- if not resolved.is_member:
- raise _refuse(
- f"Room '{room.name or room.id}' ({room.id}) is not one the bot "
- "has joined, so it cannot post there. Have someone invite the bot "
- "natively in Chatto, or send it a direct message, and try again."
- )
- # A thread root has to belong to the room we post into, or the message
- # attaches to a thread somewhere else entirely. And it has to BE a root:
- # passing a reply's ID would attach to a thread nobody can follow.
- if thread_root_event_id:
- root = await client.get_message(room.id, thread_root_event_id)
- if root is None:
- raise _refuse(
- f"No message {thread_root_event_id} in room {room.id}. "
- "Send without thread_root_event_id to post to the room itself."
- )
- if root.thread_root_event_id:
- raise _refuse(
- f"Message {thread_root_event_id} is a reply inside thread "
- f"{root.thread_root_event_id}, not a thread root. Pass that "
- "thread's root ID, or send without thread_root_event_id."
- )
- message_ids, root_event_id = await _post_chunks(
- client,
- room.id,
- message,
- thread_root_event_id=thread_root_event_id,
- create_thread=create_thread,
- )
- # Any thread the bot posts into is followed, not only one it opened:
- # Chatto delivers a thread's replies to an account that follows it (or
- # was mentioned in it directly), so replying into someone else's thread
- # without following it can end the conversation the agent just joined.
- # Mirrors the adapter's own send(), which follows every thread it uses.
- if root_event_id:
- try:
- await client.follow_thread(room.id, root_event_id)
- except Exception as exc:
- # Follow is best-effort: the thread exists and the message was
- # delivered, so a hiccup here is not a failed send.
- logger.debug(
- "Chatto tools: follow_thread(%s) failed: %s", root_event_id, exc
- )
- return json.dumps(
- {
- "success": True,
- "room_id": room.id,
- "room_name": room.name,
- "message_ids": message_ids,
- "chunks_sent": len(message_ids),
- "thread_root_event_id": root_event_id,
- "created_thread": bool(create_thread),
- }
- )
- async def _list_rooms(args: dict) -> str:
- """List the rooms visible to the bot. See _handle_chatto_list_rooms."""
- name_filter = (args.get("name") or "").strip().casefold()
- async with _tool_client(_chatto_config_for_tools()) as client:
- rooms_out = []
- for rws in await client.list_rooms():
- room = rws.room
- if room is None:
- continue
- # A filter implies named rooms: skip DMs (empty name) and
- # non-matching names alike.
- if name_filter and not (room.name and name_filter in room.name.casefold()):
- continue
- rooms_out.append(
- {
- "room_id": room.id,
- "name": room.name or "",
- "kind": room.kind.value,
- "threading_mode": room.threading_mode.value,
- "archived": room.archived,
- "is_member": rws.viewer_state.is_member,
- # DM rooms carry no name, so they are labelled by their ID
- # instead of leaving the model with a blank to match on.
- "label": room.name or f"(DM room {room.id})",
- }
- )
- return json.dumps(
- {
- "success": True,
- "count": len(rooms_out),
- "rooms": rooms_out,
- "hint": (
- "Use room_id in chatto_send_room, or as the chat_id part of a "
- "cron deliver target like 'chatto-platform:<room_id>'."
- ),
- }
- )
- async def _handle_chatto_send_dm(args: dict) -> str:
- """Tool handler for chatto_send_dm.
- Returns a JSON string: Hermes' tool contract accepts no other type, and a
- dict (or an unflagged coroutine) fails at dispatch with "unsupported result
- type". Every early exit arrives here as a _ToolRefusal and leaves as that
- refusal's own JSON, so no path escapes as an unhandled error.
- """
- try:
- return await _send_dm(args)
- except _ToolRefusal as refusal:
- return refusal.result_json
- except ChattoAuthError as exc:
- return json.dumps({"success": False, "error": f"Authentication error: {exc}"})
- except ChattoError as exc:
- return json.dumps({"success": False, "error": f"Chatto API error: {exc}"})
- async def _handle_chatto_send_room(args: dict) -> str:
- """Tool handler for chatto_send_room.
- Returns a JSON string: Hermes' tool contract accepts no other type, and a
- dict (or an unflagged coroutine) fails at dispatch with "unsupported result
- type". Every early exit arrives here as a _ToolRefusal and leaves as that
- refusal's own JSON, so no path escapes as an unhandled error.
- """
- try:
- return await _send_room(args)
- except _ToolRefusal as refusal:
- return refusal.result_json
- except ChattoAuthError as exc:
- return json.dumps({"success": False, "error": f"Authentication error: {exc}"})
- except ChattoError as exc:
- return json.dumps({"success": False, "error": f"Chatto API error: {exc}"})
- async def _handle_chatto_list_rooms(args: dict) -> str:
- """Tool handler for chatto_list_rooms.
- Returns a JSON string: Hermes' tool contract accepts no other type, and a
- dict (or an unflagged coroutine) fails at dispatch with "unsupported result
- type".
- """
- try:
- return await _list_rooms(args)
- except _ToolRefusal as refusal:
- return refusal.result_json
- except ChattoAuthError as exc:
- return json.dumps({"success": False, "error": f"Authentication error: {exc}"})
- except ChattoError as exc:
- return json.dumps({"success": False, "error": f"Chatto API error: {exc}"})
- def _register_bundled_skills(ctx) -> None:
- """Register the skills shipped in ``skills/``, each with its own description.
- ``register_skill`` stores the description verbatim and never reads the
- SKILL.md frontmatter, so passing none leaves the skill listed in
- ``<available_skills>`` with nothing explaining when to load it — which is
- the only place an agent learns it exists.
- """
- from pathlib import Path
- from agent.skill_utils import parse_frontmatter
- skills_dir = Path(__file__).parent / "skills"
- if not skills_dir.is_dir():
- logger.debug("Chatto: no bundled skills directory at %s", skills_dir)
- return
- for child in sorted(skills_dir.iterdir()):
- skill_md = child / "SKILL.md"
- if not (child.is_dir() and skill_md.exists()):
- continue
- frontmatter, _ = parse_frontmatter(skill_md.read_text(encoding="utf-8"))
- ctx.register_skill(
- child.name,
- str(skill_md),
- description=str(frontmatter.get("description") or ""),
- frontmatter=frontmatter,
- )
- logger.info("Chatto plugin skill registered: %s", child.name)
- # The plugin's outbound tools: (tool name, JSON schema, handler). One list, so
- # the two registration entry points below cannot disagree about what exists.
- _PLUGIN_TOOLS = (
- ("chatto_send_dm", CHATTO_SEND_DM_SCHEMA, _handle_chatto_send_dm),
- ("chatto_send_room", CHATTO_SEND_ROOM_SCHEMA, _handle_chatto_send_room),
- ("chatto_list_rooms", CHATTO_LIST_ROOMS_SCHEMA, _handle_chatto_list_rooms),
- )
- def register_plugin_tools(ctx) -> None:
- """Register the plugin's outbound tools in the ``chatto-platform`` toolset.
- Reached through two doors: ``register()`` in a gateway/web process, which
- materializes the platform, and ``tools.register_tools`` in a CLI/TUI one,
- which never does. A tool list written out twice would mean tools that exist
- in only half the sessions, so both doors call this.
- """
- for name, schema, handler in _PLUGIN_TOOLS:
- ctx.register_tool(
- name=name,
- toolset="chatto-platform",
- schema=schema,
- handler=handler,
- is_async=True,
- description=schema["description"],
- )
- def register(ctx) -> None:
- """Plugin entry point — called by the Hermes plugin system."""
- logger.info("Registering Chatto platform plugin on Hermes Agent")
- # --- Plugin tools ---
- register_plugin_tools(ctx)
- # --- Bundled skills ---
- # Ship the plugin's own usage/development knowledge with the code, so any
- # agent using this plugin knows when/how to use its tools and how to
- # extend it. Loaded via skill_view("chatto-platform:chatto-platform-plugin").
- _register_bundled_skills(ctx)
- for capability in _capabilities():
- logger.info("Chatto capability: %s", capability)
- ctx.register_platform(
- name=ChattoConstants.PLATFORM_NAME, # this will be the config.yaml key.
- label=ChattoConstants.PLATFORM_LABEL,
- adapter_factory=hermes_adapter_factory,
- check_fn=hermes_check_fn,
- validate_config=hermes_validate_config,
- is_connected=hermes_is_connected,
- install_hint=ChattoConstants.INSTALL_HINT,
- env_enablement_fn=hermes_env_enablement_fn,
- setup_fn=hermes_setup_fn,
- cron_deliver_env_var=ChattoConfiguration.home_channel.env_name,
- standalone_sender_fn=hermes_standalone_sender_fn,
- allowed_users_env=ChattoConfiguration.allowed_users.env_name,
- allow_all_env=ChattoConfiguration.allow_all_users.env_name,
- max_message_length=ChattoConstants.MAX_MESSAGE_LENGTH,
- emoji="😺",
- allow_update_command=True,
- pii_safe=False,
- platform_hint=(
- "Using the 'Hermes Chatto Platform Plugin' you connect to a Chatto server. "
- "Authorized admins and users will contact you and call you his Hermes Agent. They are "
- "natural persons and thus responsible for what they do in terms of rights. You compute "
- "on their behalf. They _may_ address you by @-mentioning your name. If configured, "
- "you also react without a @-mention. Direct messages reach you without a mention."
- "Keep responses conversational. Markdown is supported. "
- "Include MEDIA:/absolute/path/to/file in your response to refer to our local files. Images "
- "(.png, .jpg, .gif, .webp) arrive as inline pictures, videos (.mp4, .mov, .webm) as "
- "video attachments, audio as a voice bubble, anything else as a downloadable document. "
- "Do NOT use markdown image syntax for local files. Local files always go through MEDIA:. "
- "Several images in one response are bundled into a single message. "
- "You can also talk to Chatto unprompted: the plugin tools chatto_list_rooms, "
- "chatto_send_room and chatto_send_dm post to a channel or a person's DM on your "
- "behalf. Only send into a channel that the bot answers in, and reach a person by DM "
- "only once they have written to the bot themselves. "
- ),
- )
|