adapter.py 83 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129
  1. """
  2. Chatto Platform Adapter for Hermes Agent.
  3. A plugin-based gateway adapter that connects to a Chatto server
  4. (self-hosted team chat) and relays messages to/from the Hermes agent.
  5. The adapter uses the chattolib library for all Chatto API interactions,
  6. including both outbound messaging and realtime WebSocket connections.
  7. """
  8. from __future__ import annotations
  9. import random
  10. from gateway.platforms.helpers import MessageDeduplicator
  11. # Put the vendored dependencies for THIS platform on sys.path before importing
  12. # anything from chattolib. Imported relatively as part of the plugin package and
  13. # absolutely when this module is loaded standalone (e.g. by the tests).
  14. try:
  15. from .vendor_path import setup_vendor_path
  16. except ImportError: # pragma: no cover - depends on how the module is loaded
  17. from vendor_path import setup_vendor_path
  18. setup_vendor_path()
  19. import asyncio
  20. import hashlib
  21. import logging
  22. import mimetypes
  23. import os
  24. from datetime import datetime, timezone
  25. from enum import StrEnum
  26. from typing import Any, Dict, List, Literal, Optional, Tuple, cast
  27. from urllib.parse import urlsplit
  28. logger = logging.getLogger(__name__)
  29. from gateway.platforms.base import (
  30. BasePlatformAdapter,
  31. SendResult,
  32. MessageEvent,
  33. MessageType,
  34. ProcessingOutcome,
  35. cache_media_bytes,
  36. get_inbound_media_max_bytes,
  37. validate_inbound_media_size,
  38. )
  39. from gateway.config import Platform, PlatformConfig
  40. # Chattolib imports (vendored)
  41. # Using vendored chattolib from vendor/chattolib/
  42. # See vendor_chattolib.sh for how to update the vendored copy
  43. # Absolute imports — vendor/ is on sys.path (see above) and chattolib's own
  44. # modules import each other absolutely. Mixing in relative ".vendor.chattolib"
  45. # imports would load a second, distinct copy of every module, so isinstance()
  46. # checks across the two copies would silently fail.
  47. try:
  48. from chattolib.client import (
  49. ChattoClient,
  50. )
  51. from chattolib.exceptions import (
  52. ChattoAuthError,
  53. ChattoError,
  54. )
  55. from chattolib.realtime import (
  56. ChattoRealtimeError,
  57. ChattoRealtimeCloseError, RealtimeEvent,
  58. stream_events
  59. )
  60. from chattolib.realtime_types import (
  61. MessagePostedPayload,
  62. ReactionPayload,
  63. )
  64. from chattolib.types import (
  65. PresenceStatus, RoomKind, User
  66. )
  67. except ImportError as e:
  68. # Fail loudly: continuing here only defers the failure to a confusing
  69. # NameError somewhere deep in the adapter.
  70. logger.error("Chatto: failed to import vendored chattolib: %s", e)
  71. raise
  72. try:
  73. from .platform_config import (
  74. ChattoConfiguration, ChattoConstants,
  75. )
  76. except ImportError: # pragma: no cover - loaded as a top-level module (tests)
  77. from platform_config import (
  78. ChattoConfiguration, ChattoConstants,
  79. )
  80. # --------------------------------------------------------------------------- #
  81. # Chat types
  82. # --------------------------------------------------------------------------- #
  83. class HermesChatType(StrEnum):
  84. """The ``chat_type`` vocabulary the Hermes gateway understands.
  85. Declared in ``gateway/session.py:161`` as ``"dm", "group", "channel",
  86. "thread"`` and consumed as a bare string all over the gateway:
  87. ``SessionSource.description`` (session.py:239) and the PII-redacting
  88. description in ``build_session_context_prompt`` (session.py:537) both
  89. branch on these exact values and fall back to a nameless generic case for
  90. anything else, and ``build_session_key`` puts the value straight into the
  91. session key. Passing a chattolib ``RoomKind`` (``"ROOM_KIND_CHANNEL"``)
  92. therefore does not fail loudly — it just quietly degrades what the agent is
  93. told about where it is.
  94. A StrEnum so it stays a drop-in ``str`` at every one of those call sites.
  95. GROUP vs CHANNEL
  96. ----------------
  97. There is no strict contract between the two, and the adapters disagree in
  98. practice: Slack labels every non-DM conversation ``"group"`` (including real
  99. channels), Discord uses both, and Telegram reserves ``"channel"`` for actual
  100. broadcast channels. The intended reading is ``group`` = ordinary
  101. multi-participant chat, ``channel`` = broadcast surface.
  102. The distinction only changes behaviour in three places:
  103. 1. Authorization (``gateway/authz_mixin.py``) — the only security-relevant
  104. one. The group-scoped env allowlists apply to ``{"group", "forum"}``
  105. ONLY, never to ``"channel"``: ``{PLATFORM}_GROUP_ALLOWED_USERS`` /
  106. ``_GROUP_ALLOWED_CHATS`` (:616), the chat-id allowlist (:708) and the
  107. Telegram legacy shim (:724). The adapter-delegation paths in turn treat
  108. all three alike (:461, :649, :674, :694), where the value only picks
  109. ``group_allow_from`` over ``allow_from`` from ``config.extra``.
  110. For Chatto both choices are equivalent today: those group env maps hold
  111. Telegram and QQBot only (:535-541), and our own allowlist runs through
  112. ``CHATTO_ALLOWED_USERS``, which is chat_type-independent.
  113. 2. What the agent is told — ``SessionSource.description`` renders
  114. ``"group: Name"`` vs ``"channel: Name"`` (session.py:239-246), likewise
  115. the PII-redacted variant (session.py:537-544).
  116. 3. The session key, which embeds the literal (session.py:1192). Changing
  117. the value for a room re-buckets its existing sessions.
  118. Explicitly NOT affected: ``is_shared_multi_user_session`` (session.py:1063)
  119. only looks at ``"dm"`` and ``thread_id``, so sender prefixes, the multi-user
  120. prompt line and ``group_sessions_per_user`` treat group and channel
  121. identically.
  122. """
  123. DM = "dm"
  124. GROUP = "group"
  125. CHANNEL = "channel"
  126. # Emitted by adapters whose thread events are their own chat type (Slack,
  127. # Discord). We don't: a Chatto thread keeps its room's chat_type and is
  128. # identified by ``thread_id`` on the source instead. Listed for the record,
  129. # because build_session_key rewrites the slot to "thread" itself
  130. # (session.py:1190).
  131. THREAD = "thread"
  132. # Not declared in session.py:161 but real: Telegram forum topics travel as
  133. # "forum", and the authz group allowlists above accept it alongside "group".
  134. # Chatto has no equivalent, so we never emit it.
  135. # Chatto only distinguishes DMs from channels. UNSPECIFIED means the server
  136. # sent a kind this vendored chattolib doesn't know: map it to the generic
  137. # multi-user bucket rather than guessing "channel", and never to "dm" — that
  138. # value drives session isolation (is_shared_multi_user_session, session.py:1063)
  139. # and would silently turn a room into a private conversation.
  140. #
  141. # CHANNEL for RoomKind.CHANNEL is the descriptive choice and carries no
  142. # behavioural cost (see the GROUP vs CHANNEL note above). Switching to GROUP for
  143. # Slack parity would be this one line — plus the re-bucketing of existing
  144. # sessions that point 3 of that note describes.
  145. _ROOM_KIND_TO_CHAT_TYPE: Dict[RoomKind, HermesChatType] = {
  146. RoomKind.DM: HermesChatType.DM,
  147. RoomKind.CHANNEL: HermesChatType.CHANNEL,
  148. RoomKind.UNSPECIFIED: HermesChatType.GROUP,
  149. }
  150. def chat_type_for_room_kind(kind: Optional[RoomKind]) -> HermesChatType:
  151. """Map a chattolib RoomKind onto the gateway's chat_type vocabulary.
  152. An unknown or missing kind becomes ``GROUP`` — see ``_ROOM_KIND_TO_CHAT_TYPE``.
  153. """
  154. if kind is None:
  155. return HermesChatType.GROUP
  156. return _ROOM_KIND_TO_CHAT_TYPE.get(kind, HermesChatType.GROUP)
  157. # --------------------------------------------------------------------------- #
  158. # Adapter
  159. # --------------------------------------------------------------------------- #
  160. def hermes_adapter_factory(config: PlatformConfig):
  161. """Factory wrapper that constructs ChattoAdapter from a PlatformConfig."""
  162. return ChattoAdapter(config)
  163. class ChattoAdapter(BasePlatformAdapter):
  164. """Chatto platform adapter — receives messages via WebSocket realtime,
  165. sends via ConnectRPC."""
  166. _SPLIT_THRESHOLD = 9900
  167. # Read by BasePlatformAdapter.max_message_length_for_chat(), which the
  168. # gateway and the stream consumer use to chunk outgoing messages. Without
  169. # it they fall back to 4096 and split Chatto messages far earlier than
  170. # necessary — send() itself already truncates at 10000.
  171. MAX_MESSAGE_LENGTH = ChattoConstants.MAX_MESSAGE_LENGTH
  172. splits_long_messages = True
  173. supports_code_blocks: bool = True
  174. supports_status_text: bool = True # client.update_custom_status
  175. def __init__(self, pconfig: PlatformConfig):
  176. """Signature needs to be compatible with BasePlatformAdapter.__init__ """
  177. super().__init__(config=pconfig, platform=Platform(ChattoConstants.PLATFORM_NAME))
  178. # "extra" has been pre-processed by Hermes-Framework to be a dict of extra config values insode PlatformConfig.
  179. # --- Configuration from our configuration data class with some logic ---
  180. self.chatto_config: ChattoConfiguration = ChattoConfiguration(pconfig)
  181. # ------ State -------
  182. # SDK runtime handle (injected by Hermes); annotate for Pylance
  183. self.sdk: Any = getattr(self, "sdk", None)
  184. # Our own user, filled in by connect(). Events arriving before connect()
  185. # completes must not blow up on an undefined attribute.
  186. self.me: Optional[User] = None
  187. # --- Runtime state ---
  188. self._user_id: str = ""
  189. self._user_display: str = ""
  190. self._room_names: Dict[str, str] = {}
  191. self._room_kinds: Dict[str, RoomKind] = {}
  192. self._our_thread_roots: set = set() # thread root event IDs we created
  193. self._our_message_ids: set = set() # message IDs we sent (for thread root detection)
  194. self._seen: list[str] = [] # Plain RealtimeEvent-id list
  195. self._resume_cursor: Optional[str] = None
  196. self._watch_room_ids: List[str] = []
  197. self._ws_task: Optional[asyncio.Task] = None
  198. self._presence_task: Optional[asyncio.Task] = None
  199. self._ws_ready: Optional[asyncio.Event] = None
  200. self._ws_active = False
  201. self._ws_ref = None # reference to open websocket for dynamic resubscribe
  202. # Persistent typing indicator loops per room
  203. self._typing_tasks: Dict[str, asyncio.Task] = {}
  204. # Member directory cache: user_id -> user info dict
  205. self._user_cache: Dict[str, User] = {}
  206. # Chattolib client cache and lock for async access.
  207. self._chatto_client: Optional[ChattoClient] = None
  208. self._chatto_client_lock: asyncio.Lock = asyncio.Lock()
  209. # Dedup — chattolib may redeliver events across reconnects.
  210. self._dedup = MessageDeduplicator()
  211. # ------------------------------------------------------------------ #
  212. # Auth
  213. # ------------------------------------------------------------------ #
  214. async def _get_chatto_client(self: ChattoAdapter) -> Optional[ChattoClient]:
  215. """Get or create a ChattoClient instance."""
  216. if self._chatto_client is not None:
  217. return self._chatto_client
  218. async with self._chatto_client_lock:
  219. if self._chatto_client is not None:
  220. return self._chatto_client
  221. try:
  222. assert(self.chatto_config.login.value) # now we can assume, _login is available.
  223. client = await self._open_client(
  224. base_url=self.chatto_config.base_url.value,
  225. login=self.chatto_config.login.value,
  226. password=self.chatto_config.password.value,
  227. token=self.chatto_config.token.value,
  228. )
  229. self._chatto_client = client
  230. self._token = client.token
  231. logger.info("Chatto: logged in as '%s' via chattolib", self.chatto_config.login.value)
  232. return client
  233. except ChattoAuthError as e:
  234. logger.error("Chatto: authentication failed: %s", e)
  235. return None
  236. except (ChattoError, ValueError) as e:
  237. logger.error("Chatto: failed to create client: %s", e)
  238. return None
  239. async def _require_client(self) -> ChattoClient:
  240. """Return a ChattoClient or raise RuntimeError if unavailable.
  241. Use this helper when the caller expects a client to exist and
  242. wants a single canonical failure path. Methods that prefer a
  243. soft-fail can catch RuntimeError and return gracefully.
  244. """
  245. client = await self._get_chatto_client()
  246. if client is None:
  247. raise RuntimeError("Chatto client unavailable")
  248. return client
  249. async def _ensure_token(self) -> bool:
  250. """Ensure we have a logged-in Chatto client and token."""
  251. if self.chatto_config.token.value and isinstance(self._chatto_client, ChattoClient):
  252. return True
  253. client = await self._get_chatto_client()
  254. return client is not None
  255. # ------------------------------------------------------------------ #
  256. # Connection
  257. # ------------------------------------------------------------------ #
  258. async def _open_client(
  259. self,
  260. *,
  261. base_url: str,
  262. login: str,
  263. password: str,
  264. token: Optional[str] = None,
  265. ) -> ChattoClient:
  266. """Return a connected ``ChattoClient`` using token or login/password."""
  267. if token:
  268. return ChattoClient(token=token, base_url=base_url)
  269. return await ChattoClient.login(login, password, base_url=base_url)
  270. async def connect(self, *, is_reconnect: bool = False) -> bool:
  271. """Connect to Chatto and start the realtime event stream.
  272. BasePlatformAdapter override
  273. """
  274. logger.info("Chatto: connecting...")
  275. if not await self._ensure_token():
  276. return False
  277. try:
  278. client = await self._require_client()
  279. except RuntimeError:
  280. self._set_fatal_error("connect_failed", "Chatto client not available", retryable=True)
  281. return False
  282. # Get our first own user info
  283. try:
  284. self.me = await client.me()
  285. except Exception as exc:
  286. logger.error("Chatto: failed to get user info: %s", exc)
  287. self._set_fatal_error(
  288. "chatto_auth_failed",
  289. f"Chatto auth failed: {exc}",
  290. retryable=False,
  291. )
  292. try:
  293. assert(self._chatto_client)
  294. await self._chatto_client.close()
  295. finally:
  296. self._chatto_client = None
  297. return False
  298. # Announce online presence so the bot appears online in the member list.
  299. # The server treats this as a TTL, so _presence_refresh_loop below has to
  300. # keep re-announcing it — a single call here lapses back to offline.
  301. await self._announce_online()
  302. self._closing = False
  303. # Start background realtime WS event stream loop.
  304. self._ws_ready = asyncio.Event()
  305. self._ws_task = asyncio.create_task(
  306. self._chattolib_event_loop(), name="chatto-event-stream",
  307. )
  308. self._presence_task = asyncio.create_task(
  309. self._presence_refresh_loop(), name="chatto-presence-refresh",
  310. )
  311. self._mark_connected()
  312. logger.info(
  313. "Chatto: connected and authentiated to %s using login:'%s' (display_name:'%s' id: '%s')",
  314. self.chatto_config.base_url.value,
  315. self.me.login, self.me.display_name, self.me.id
  316. )
  317. return True
  318. async def _announce_online(self) -> bool:
  319. """Tell the server we are online. Returns whether the call got through.
  320. Logged at warning level on failure: a silently dropped presence call is
  321. indistinguishable from a bot that is simply not running.
  322. """
  323. try:
  324. client = await self._require_client()
  325. await client.update_presence(status=PresenceStatus.ONLINE)
  326. return True
  327. except Exception as exc:
  328. logger.warning("Chatto: presence refresh failed, bot may appear offline: %s", exc)
  329. return False
  330. async def _presence_refresh_loop(self) -> None:
  331. """Re-announce ONLINE until disconnect, since presence expires server-side.
  332. Failures are not fatal — the next tick tries again, so a blip in the
  333. presence endpoint costs at most one interval of visible offline time.
  334. """
  335. while not self._closing:
  336. await self._sleep_interruptible(ChattoConstants.PRESENCE_REFRESH_INTERVAL)
  337. if self._closing:
  338. return
  339. await self._announce_online()
  340. async def disconnect(self) -> None:
  341. """Stop WebSocket, presence refresh, typing tasks, and clear state.
  342. BasePlatformAdapter override
  343. """
  344. # No explicit offline broadcast: chattolib rejects OFFLINE outright
  345. # ("stop refreshing to go offline"), so cancelling the refresh loop
  346. # below is what actually takes the bot offline.
  347. self._ws_active = False
  348. self._closing = True
  349. # Cancel all typing tasks
  350. for chat_id in list(self._typing_tasks.keys()):
  351. await self.stop_typing(chat_id)
  352. if self._ws_task and not self._ws_task.done():
  353. self._ws_task.cancel()
  354. try:
  355. await self._ws_task
  356. except (asyncio.CancelledError, Exception):
  357. pass
  358. self._ws_task = None
  359. if self._presence_task and not self._presence_task.done():
  360. self._presence_task.cancel()
  361. try:
  362. await self._presence_task
  363. except (asyncio.CancelledError, Exception):
  364. pass
  365. self._presence_task = None
  366. if self._chatto_client:
  367. try:
  368. await self._chatto_client.close()
  369. except Exception:
  370. logger.exception("Chatto: error closing client")
  371. finally:
  372. self._chatto_client = None
  373. self._token = None
  374. logger.info("Chatto: disconnected")
  375. self._mark_disconnected()
  376. async def _seed_room(self, room_id: str) -> None:
  377. """Seed high-water mark from the newest events so a restart doesn't replay history."""
  378. try:
  379. try:
  380. client = await self._require_client()
  381. timeline_page = await client.get_room_events(room_id)
  382. except RuntimeError:
  383. logger.debug("Chatto: _seed_room aborted - no client available for %s", room_id)
  384. return
  385. for ev in timeline_page.events:
  386. if ev.id:
  387. self._mark_seen(ev.id)
  388. logger.debug("Chatto: seeded room %s with %d events", room_id, len(timeline_page.events))
  389. except Exception as e:
  390. logger.debug("Chatto: get room events failed for %s: %s", room_id, e)
  391. # ------------------------------------------------------------------ #
  392. # Realtime Event List
  393. # ------------------------------------------------------------------ #
  394. def _mark_seen(self, event_id: str) -> None:
  395. self._seen.append(event_id)
  396. while len(self._seen) > ChattoConstants.SEEN_CAP:
  397. self._seen.remove(self._seen[0]) # fastest removal of first item in a list.
  398. def _is_seen(self, event_id: str) -> bool:
  399. return event_id in self._seen
  400. # ------------------------------------------------------------------ #
  401. # WebSocket Realtime Transport
  402. # ------------------------------------------------------------------ #
  403. def _check_auth(self, user: User) -> bool:
  404. """We roll our own auth-systen on the against the chatto_config'ured allowed_users etc.
  405. because.. Hermes authz_mixin.py IS NOT SANE.
  406. """
  407. if self.chatto_config.allow_all_users.value:
  408. return True
  409. if user.login in self.chatto_config.allowed_users.value:
  410. return True
  411. if user.id in self.chatto_config.allowed_users.value:
  412. return True
  413. logger.info("Chatto: rejecting message from unauthorized user '%s' (%s)", user.login, user.id)
  414. return False
  415. # ------------------------------------------------------------------ #
  416. # Inbound attachments
  417. # ------------------------------------------------------------------ #
  418. async def _download_attachment_bytes(self, url: str) -> bytes:
  419. """Download an attachment, refusing to buffer more than the gateway cap.
  420. The Content-Length header is checked first so an oversized asset is
  421. rejected before a single chunk is read; the running total is re-checked
  422. as chunks arrive, because a missing or lying header must not smuggle an
  423. unbounded body past the cap.
  424. """
  425. import httpx
  426. max_bytes = get_inbound_media_max_bytes()
  427. chunks: List[bytes] = []
  428. total = 0
  429. async with httpx.AsyncClient(
  430. timeout=ChattoConstants.HTTP_TIMEOUT, follow_redirects=True,
  431. ) as http:
  432. async with http.stream("GET", url) as resp:
  433. resp.raise_for_status()
  434. declared = resp.headers.get("content-length")
  435. if declared:
  436. try:
  437. declared_size = int(declared)
  438. except ValueError:
  439. logger.debug("Chatto: ignoring invalid Content-Length %r", declared)
  440. else:
  441. validate_inbound_media_size(
  442. declared_size, media_type="attachment", max_bytes=max_bytes,
  443. )
  444. async for chunk in resp.aiter_bytes():
  445. total += len(chunk)
  446. validate_inbound_media_size(
  447. total, media_type="attachment", max_bytes=max_bytes,
  448. )
  449. chunks.append(chunk)
  450. return b"".join(chunks)
  451. async def _cache_attachments(
  452. self, room_id: str, attachments: List[Any],
  453. ) -> Tuple[List[str], List[str], List[str]]:
  454. """Download message attachments into the gateway media cache.
  455. Returns ``(media_urls, media_types, media_kinds)`` — the paths are
  456. agent-visible cache paths, exactly what ``cache_media_bytes`` yields for
  457. every other platform. A failing attachment is logged and skipped: the
  458. message itself still reaches the agent.
  459. """
  460. media_urls: List[str] = []
  461. media_types: List[str] = []
  462. media_kinds: List[str] = []
  463. for att in attachments or []:
  464. asset_url = getattr(att, "asset_url", None)
  465. url = getattr(asset_url, "url", "") if asset_url else ""
  466. filename = getattr(att, "filename", "") or ""
  467. content_type = getattr(att, "content_type", "") or ""
  468. if not url:
  469. # Videos are announced before transcoding finishes, so the
  470. # signed URL can legitimately be missing on arrival.
  471. logger.info(
  472. "Chatto: attachment '%s' has no asset URL yet, skipping", filename,
  473. )
  474. continue
  475. try:
  476. data = await self._download_attachment_bytes(url)
  477. cached = cache_media_bytes(
  478. data, filename=filename, mime_type=content_type,
  479. )
  480. except Exception as e:
  481. logger.warning(
  482. "Chatto: failed to cache attachment '%s' (%s): %s",
  483. filename, content_type, e,
  484. )
  485. continue
  486. if cached is None:
  487. logger.warning(
  488. "Chatto: attachment '%s' (%s) could not be cached, skipping",
  489. filename, content_type,
  490. )
  491. continue
  492. media_urls.append(cached.path)
  493. media_types.append(cached.media_type)
  494. media_kinds.append(cached.kind)
  495. return media_urls, media_types, media_kinds
  496. @staticmethod
  497. def _message_type_for_media_kinds(media_kinds: List[str]) -> MessageType:
  498. """Pick the MessageType for a set of cached attachment kinds."""
  499. if "document" in media_kinds:
  500. return MessageType.DOCUMENT
  501. if "image" in media_kinds:
  502. return MessageType.PHOTO
  503. if "video" in media_kinds:
  504. return MessageType.VIDEO
  505. if "audio" in media_kinds:
  506. return MessageType.AUDIO
  507. return MessageType.TEXT
  508. async def _dispatch_message_posted(self, payload: MessagePostedPayload) -> None:
  509. try:
  510. client = await self._require_client()
  511. except RuntimeError:
  512. logger.warning("Chatto: chattolib event loop aborted - no client available")
  513. return
  514. logger.info("Chatto WS: 'message_posted' event_payload:%s", payload)
  515. message = await payload.fetch_message(client=client)
  516. if message is None or message.deleted_at:
  517. return
  518. message_body = message.body or ""
  519. attachments = list(message.attachments or [])
  520. # A message carrying only an image/PDF has an empty body — dropping it
  521. # here is what made attachments sent to Hermes disappear silently.
  522. if not message_body and not attachments:
  523. return
  524. if message.actor_id in self._user_cache:
  525. # try the user cache.
  526. user = self._user_cache.get(message.actor_id)
  527. else:
  528. # get the user and update cache.
  529. directory_member = await client.get_user(user_id=message.actor_id)
  530. if directory_member is None:
  531. return
  532. user = directory_member.user
  533. if user is None:
  534. return
  535. self._user_cache[user.id] = user
  536. if user is None:
  537. return
  538. if not self._check_auth(user):
  539. return
  540. # Todo: use a function that either reads from cache or gets room kind again.
  541. if self._room_kinds.get(message.room_id) is None:
  542. room_viewer_state = await client.get_room(message.room_id)
  543. if room_viewer_state is None:
  544. return
  545. if room_viewer_state.room is None:
  546. return
  547. self._room_kinds[message.room_id] = room_viewer_state.room.kind or RoomKind.UNSPECIFIED
  548. room_kind = self._room_kinds.get(message.room_id)
  549. logger.info("message_body: %s room_kind: %s", message_body, room_kind)
  550. # require_mention deliberately gates channels only: in a channel the bot
  551. # is one of many listeners and must be addressed, whereas a DM is already
  552. # addressed at it — so DMs are always answered, mention or not.
  553. mentioned = False
  554. if (room_kind == RoomKind.CHANNEL and self.chatto_config.require_mention.value and self.me):
  555. if self.me.login and not mentioned:
  556. mentioned = bool(f"@{self.me.login}" in message_body)
  557. if self.me.display_name and not mentioned:
  558. mentioned = bool(f"@{self.me.display_name}" in message_body)
  559. if mentioned is False:
  560. logger.debug("Discarding message. Bot was not mentionend but require_mention is '%s'.", self.chatto_config.require_mention.value)
  561. return
  562. logger.info("mentioned: %s", mentioned)
  563. # Thread anchoring — if the incoming message is inside a thread, we
  564. # keep that thread by default; otherwise leave thread_id unset so
  565. # replies land at the root.
  566. thread_id = payload.thread_root_event_id or None
  567. if not thread_id and room_kind != RoomKind.DM and self.chatto_config.auto_thread.value:
  568. thread_id = message.id
  569. source = self.build_source(
  570. chat_id=payload.room_id,
  571. chat_name=self._room_names.get(message.room_id),
  572. chat_type=chat_type_for_room_kind(room_kind),
  573. user_id=message.actor_id,
  574. user_name=user.login, # use login, because display_name is changeable by anyone.
  575. thread_id=thread_id,
  576. message_id=payload.message_event_id,
  577. role_authorized=True,
  578. )
  579. msg_type = MessageType.COMMAND if (message_body.lstrip().startswith("/")) else MessageType.TEXT
  580. my_body = message_body.lstrip() if msg_type == MessageType.COMMAND else message_body
  581. # Attachments — download and hand the local cache paths to the gateway,
  582. # which runs vision enrichment / document extraction off media_urls.
  583. media_urls, media_types, media_kinds = await self._cache_attachments(
  584. payload.room_id, attachments,
  585. )
  586. if media_kinds and msg_type != MessageType.COMMAND:
  587. # Same precedence as the Teams/Signal adapters: document-context
  588. # injection gates strictly on DOCUMENT, image handling keys off the
  589. # per-path image/* MIME regardless of message_type.
  590. msg_type = self._message_type_for_media_kinds(media_kinds)
  591. message_event = MessageEvent(
  592. text=my_body,
  593. source=source,
  594. message_id=message.id,
  595. message_type=msg_type,
  596. media_urls=media_urls,
  597. media_types=media_types,
  598. timestamp=message.created_at or datetime.now(timezone.utc),
  599. raw_message=message,
  600. reply_to_message_id=message.id,
  601. reply_to_text=message_body,
  602. reply_to_author_id=user.id,
  603. reply_to_author_name=user.login,
  604. )
  605. logger.info("Chatto: Dispatching MessageEvent to Hermes: %s", message_event)
  606. await self.handle_message(message_event)
  607. return
  608. async def _forward_reaction(
  609. self, event: RealtimeEvent, payload: ReactionPayload, *, removed: bool,
  610. ) -> None:
  611. """Forward a human reaction to the gateway's reaction hook surface.
  612. The handler is registered by the gateway via ``set_reaction_handler``
  613. and fans out as ``reaction:added`` / ``reaction:removed`` through the
  614. HookRegistry. The dict shape mirrors the Slack adapter's — hook
  615. consumers are written against that contract, not against a per-platform
  616. one. Our own lifecycle reactions (👀/✅/❌) are dropped: forwarding them
  617. would feed the agent its own markers.
  618. """
  619. actor_id = event.actor_id
  620. if actor_id and self.me and actor_id == self.me.id:
  621. return
  622. if not payload.room_id or not payload.message_event_id or not actor_id:
  623. return
  624. handler = getattr(self, "_reaction_handler", None)
  625. if handler is None:
  626. return
  627. action = "removed" if removed else "added"
  628. try:
  629. await handler(
  630. {
  631. "platform": ChattoConstants.PLATFORM_NAME,
  632. "event_name": f"reaction:{action}",
  633. "reaction": payload.emoji,
  634. "user_id": actor_id,
  635. "item_user_id": None,
  636. "item_type": "message",
  637. "channel_id": payload.room_id,
  638. "message_ts": payload.message_event_id,
  639. "event_ts": event.id,
  640. "raw_event": event,
  641. }
  642. )
  643. except Exception: # pragma: no cover - the hook contract is non-blocking
  644. logger.debug("Chatto: reaction hook forwarding failed", exc_info=True)
  645. async def _handle_realtime_event(self, event: RealtimeEvent) -> None:
  646. if self._is_seen(event.id):
  647. return
  648. if event.actor_id is None:
  649. return
  650. logger.info("EVENT happened: '%s' from %s", event.kind, event.actor_id)
  651. if (event_payload := event.get("message_posted")) is not None:
  652. # Self-event filter — the actor_id on the envelope is authoritative
  653. # (chattolib does NOT filter this itself; see chatto-bridge notes).
  654. actor_id = event.actor_id
  655. if actor_id and self.me and actor_id == self.me.id:
  656. return
  657. await self._dispatch_message_posted(event_payload)
  658. elif event.kind in ("reaction_added", "reaction_removed"):
  659. reaction_payload = event.get(event.kind)
  660. if reaction_payload is not None:
  661. await self._forward_reaction(
  662. event,
  663. cast(ReactionPayload, reaction_payload),
  664. removed=event.kind == "reaction_removed",
  665. )
  666. # confirmed:
  667. elif event.kind in ("mention_notification", "projection_event", "presence_changed", "notification_dismissed",
  668. "room_marked_as_read", "user_typing", "notification_created", "new_direct_message_notification",
  669. "message_edited", "message_retracted"):
  670. logger.debug("Chatto: '%s' event received. Not yet implemented or not needed.", event.kind)
  671. else:
  672. logger.error("Chatto: unknown event kind: '%s'", event.kind)
  673. async def _chattolib_event_loop(self) -> None:
  674. """Event loop using chattolib's stream_events.
  675. This replaces the manual WebSocket loop with chattolib's high-level
  676. stream_events() which provides pre-decoded RealtimeEvent objects.
  677. """
  678. delay = ChattoConstants.WS_RECONNECT_INITIAL_BACKOFF
  679. while not self._closing:
  680. try:
  681. client = await self._require_client()
  682. await self._refresh_rooms()
  683. logger.info("Chatto: starting chattolib event stream with %d rooms", len(self._watch_room_ids))
  684. async for event in stream_events(client):
  685. if self._closing:
  686. return
  687. await self._handle_realtime_event(event)
  688. # Iterator exited cleanly — treat as a normal close and reconnect
  689. # with the local backoff (no server hint available).
  690. logger.info("Chatto: realtime stream ended, reconnecting")
  691. except asyncio.CancelledError:
  692. return
  693. except ChattoRealtimeCloseError as exc:
  694. if not exc.reconnect:
  695. logger.error(
  696. "Chatto: realtime closed by server (%s: %s), not reconnecting",
  697. exc.code, exc.message,
  698. )
  699. return
  700. wait = max(exc.retry_after_ms / 1000.0, ChattoConstants.WS_RECONNECT_INITIAL_BACKOFF)
  701. logger.warning(
  702. "Chatto: realtime closed by server (%s), reconnecting in %.1fs",
  703. exc.code, wait,
  704. )
  705. delay = ChattoConstants.WS_RECONNECT_INITIAL_BACKOFF # server hint supersedes local backoff
  706. await self._sleep_interruptible(wait)
  707. continue
  708. except ChattoRealtimeError as exc:
  709. if getattr(exc, "fatal", False):
  710. logger.error("Chatto: fatal realtime error (%s): %s", exc.code, exc.message)
  711. return
  712. logger.warning(
  713. "Chatto: realtime error (%s: %s), reconnecting in %.1fs",
  714. exc.code, exc.message, delay,
  715. )
  716. except Exception as exc:
  717. logger.warning(
  718. "Chatto: unexpected realtime error: %s, reconnecting in %.1fs",
  719. exc, delay,
  720. )
  721. if self._closing:
  722. return
  723. jitter = delay * 0.2 * random.random()
  724. await self._sleep_interruptible(delay + jitter)
  725. delay = min(delay * 2, ChattoConstants.WS_RECONNECT_MAX_BACKOFF)
  726. async def _sleep_interruptible(self, seconds: float) -> None:
  727. """Sleep in short slices so disconnect() cancels promptly."""
  728. end = asyncio.get_running_loop().time() + seconds
  729. while not self._closing:
  730. remaining = end - asyncio.get_running_loop().time()
  731. if remaining <= 0:
  732. return
  733. await asyncio.sleep(min(remaining, 0.5))
  734. async def _refresh_rooms(self) -> None:
  735. """Refresh room list via ConnectRPC, join and seed any newly discovered rooms."""
  736. try:
  737. client = await self._require_client()
  738. except RuntimeError:
  739. logger.warning("Chatto WS: _refresh_rooms aborted - no client available")
  740. return
  741. try:
  742. rooms_list = await client.list_rooms()
  743. new_room_ids: List[str] = []
  744. for room_with_state in rooms_list:
  745. if not room_with_state:
  746. continue
  747. room_obj = room_with_state.room or None
  748. if not room_obj:
  749. continue
  750. self._room_names[room_obj.id] = room_obj.name
  751. self._room_kinds[room_obj.id] = room_obj.kind
  752. if room_with_state.viewer_state.is_member and room_obj.id not in self._watch_room_ids:
  753. new_room_ids.append(room_obj.id)
  754. if not new_room_ids:
  755. return
  756. logger.info("Chatto WS: discovered %d new room(s): %s", len(new_room_ids), new_room_ids)
  757. for rid in new_room_ids:
  758. if self._room_kinds.get(rid) != RoomKind.DM:
  759. await client.join_room(rid) # but list_rooms() would not return any if we were not already joined?!
  760. await self._seed_room(rid)
  761. self._watch_room_ids.append(rid)
  762. watch_room_names: list[str] = []
  763. for rid in self._watch_room_ids:
  764. watch_room_names.append(self._room_names[rid] + " (" + rid + ")")
  765. logger.info("Chatto WS: Watching %d room(s): %s", len(self._watch_room_ids), ", ".join(watch_room_names))
  766. except Exception:
  767. logger.warning("Chatto WS: _refresh_rooms failed", exc_info=True)
  768. # ------------------------------------------------------------------ #
  769. # Read state & notification dismissal (best-effort, Chatto-unique)
  770. # ------------------------------------------------------------------ #
  771. # Best-effort: mark all watched rooms as read (room_id may be undefined here)
  772. for _rid in list(self._watch_room_ids):
  773. try:
  774. await client.mark_room_as_read(room_id=_rid)
  775. await client.dismiss_all_notifications()
  776. except Exception:
  777. logger.debug("Chatto: mark_room_as_read failed for %s", _rid, exc_info=True)
  778. # ------------------------------------------------------------------ #
  779. # Sending (ConnectRPC — unchanged from polling version)
  780. # ------------------------------------------------------------------ #
  781. async def send(
  782. self,
  783. chat_id: str,
  784. content: str,
  785. reply_to: Optional[str] = None,
  786. metadata: Optional[Dict[str, Any]] = None,
  787. ) -> SendResult:
  788. """Send a message to a Chatto room.
  789. Long messages are split into chunks via ``truncate_message`` and
  790. each chunk is sent as a separate CreateMessage call. The first
  791. chunk's message ID is returned as ``message_id``.
  792. When ``auto_thread`` is enabled and the incoming message was a
  793. regular room message (not already in a thread), the first chunk is
  794. sent as a room message and its ID becomes the thread root. Subsequent
  795. chunks are sent in that thread. This mirrors Discord's auto_thread
  796. behavior.
  797. BasePlatformAdapter override
  798. """
  799. if not content:
  800. return SendResult(success=False, error="Empty message")
  801. formatted = self.format_message(content)
  802. chunks = self.truncate_message(formatted, ChattoConstants.MAX_MESSAGE_LENGTH)
  803. # Thread support — resolve thread_id once
  804. # DM rooms don't support threads, so skip threading for DMs
  805. thread_id = (metadata or {}).get("thread_id")
  806. # Only use reply_to as thread_id if auto_thread is enabled.
  807. # When auto_thread=false, responses go directly in the room
  808. # without threading under the incoming message.
  809. if reply_to and self.chatto_config.auto_thread.value:
  810. # reply_to might be the incoming message ID. If we already have
  811. # thread_id from metadata, keep it (it's the thread root).
  812. # Only use reply_to as thread_id if we don't already have one.
  813. if not thread_id:
  814. thread_id = reply_to
  815. # Check if this is a DM room — DMs don't support threads
  816. room_kind = self._room_kinds.get(chat_id)
  817. is_dm = room_kind == RoomKind.DM
  818. if is_dm:
  819. thread_id = None
  820. # Auto-thread: by default, Chatto creates a thread for replies to room
  821. # messages (not DMs, not already in a thread). This keeps conversations
  822. # organized in the room. Can be disabled via extra.auto_thread=false.
  823. use_auto_thread = self.chatto_config.auto_thread.value and not thread_id and not is_dm
  824. message_ids: List[str] = []
  825. last_resp: Optional[Any] = None
  826. last_error: Optional[str] = None
  827. retryable = False
  828. try:
  829. client = await self._require_client()
  830. except RuntimeError:
  831. return SendResult(success=False, error="Chatto client not available", retryable=True)
  832. for i, chunk in enumerate(chunks):
  833. try:
  834. msg_obj = await client.post_message(
  835. room_id=chat_id,
  836. body=chunk,
  837. thread_root_event_id=str(thread_id) if thread_id else "",
  838. )
  839. except ChattoError as e:
  840. last_error = str(e)
  841. retryable = True
  842. break
  843. except Exception as e:
  844. last_error = str(e)
  845. retryable = True
  846. break
  847. last_resp = msg_obj
  848. self._mark_seen(msg_obj.id)
  849. message_ids.append(msg_obj.id)
  850. self._our_message_ids.add(msg_obj.id)
  851. # If we sent a message WITHOUT a thread_id, this message could
  852. # become a thread root if someone replies to it
  853. if not thread_id:
  854. self._our_thread_roots.add(msg_obj.id)
  855. # Auto-thread: first chunk becomes the thread root,
  856. # subsequent chunks go in the thread
  857. if use_auto_thread and i == 0 and not thread_id:
  858. thread_id = msg_obj.id
  859. # Nothing got through at all — report the failure instead of a phantom success.
  860. if not message_ids:
  861. return SendResult(
  862. success=False,
  863. error=last_error or "Chatto: message could not be sent",
  864. retryable=retryable,
  865. )
  866. first_id = message_ids[0]
  867. # ------------------------------------------------------------------ #
  868. # Thread following (best-effort, Chatto-unique)
  869. # ------------------------------------------------------------------ #
  870. if thread_id:
  871. try:
  872. await client.follow_thread(chat_id, thread_id)
  873. except Exception:
  874. logger.debug("Chatto: follow_thread failed for %s/%s", chat_id, thread_id, exc_info=True)
  875. # A later chunk failed after earlier ones went out: partial delivery.
  876. if last_error:
  877. logger.warning(
  878. "Chatto: sent %d/%d chunk(s) to %s before failing: %s",
  879. len(message_ids), len(chunks), chat_id, last_error,
  880. )
  881. return SendResult(success=True, message_id=first_id, raw_response=last_resp)
  882. def format_message(self, content: str) -> str:
  883. """Normalise outgoing text for Chatto.
  884. Chatto renders Markdown natively, so there is nothing to escape or
  885. translate — the only transformations here are the ones that measurably
  886. render wrong: CRLF line endings (which show up as stray blank lines)
  887. and runs of more than two blank lines.
  888. BasePlatformAdapter override
  889. """
  890. if not content:
  891. return content
  892. normalised = content.replace("\r\n", "\n").replace("\r", "\n")
  893. while "\n\n\n\n" in normalised:
  894. normalised = normalised.replace("\n\n\n\n", "\n\n\n")
  895. return normalised
  896. async def edit_message(
  897. self,
  898. chat_id: str,
  899. message_id: str,
  900. content: str,
  901. *,
  902. finalize: bool = False,
  903. ) -> SendResult:
  904. """Edit a message we previously sent, via MessageService/UpdateMessage.
  905. The stream consumer drives streaming replies through this: without the
  906. override the base class reports "Not supported" and every incremental
  907. update arrives as a *new* message.
  908. ``finalize`` is a no-op for Chatto — an edit is an edit here, there is
  909. no in-progress card state to close out (hence no
  910. ``REQUIRES_EDIT_FINALIZE``).
  911. Content that exceeds the per-message limit is refused rather than
  912. silently truncated, so the caller falls back to ``send()``, which
  913. splits across messages.
  914. BasePlatformAdapter override
  915. """
  916. if not message_id:
  917. return SendResult(success=False, error="Chatto: no message id to edit")
  918. if not content:
  919. return SendResult(success=False, error="Empty message")
  920. formatted = self.format_message(content)
  921. if len(formatted) > ChattoConstants.MAX_MESSAGE_LENGTH:
  922. # Refuse instead of truncating: the caller's fallback path splits.
  923. return SendResult(
  924. success=False,
  925. error=(
  926. f"Chatto: edit exceeds {ChattoConstants.MAX_MESSAGE_LENGTH} "
  927. f"chars ({len(formatted)})"
  928. ),
  929. )
  930. try:
  931. client = await self._require_client()
  932. except RuntimeError:
  933. return SendResult(success=False, error="Chatto client not available", retryable=True)
  934. try:
  935. msg = await client.update_message(
  936. room_id=str(chat_id),
  937. event_id=str(message_id),
  938. body=formatted,
  939. )
  940. except ChattoError as e:
  941. logger.warning("Chatto: UpdateMessage failed for %s: %s", message_id, e)
  942. return SendResult(success=False, error=str(e), retryable=True)
  943. except Exception as e:
  944. logger.warning("Chatto: UpdateMessage error for %s: %s", message_id, e)
  945. return SendResult(success=False, error=str(e), retryable=False)
  946. # Our own edit comes back as a message_edited event; mark it seen so it
  947. # is never mistaken for inbound traffic.
  948. edited_id = getattr(msg, "id", "") or str(message_id)
  949. self._mark_seen(edited_id)
  950. return SendResult(success=True, message_id=edited_id, raw_response=msg)
  951. async def delete_message(self, chat_id: str, message_id: str) -> bool:
  952. """Delete a message via MessageService/DeleteMessage.
  953. Used by the stream consumer's fresh-final cleanup (removing a preview
  954. message once the completed reply has been sent) and by the ephemeral
  955. reply TTL.
  956. BasePlatformAdapter override
  957. """
  958. if not chat_id or not message_id:
  959. return False
  960. try:
  961. client = await self._require_client()
  962. except RuntimeError:
  963. logger.warning("Chatto: DeleteMessage — client unavailable")
  964. return False
  965. try:
  966. return bool(await client.delete_message(
  967. room_id=str(chat_id), event_id=str(message_id),
  968. ))
  969. except ChattoError as e:
  970. logger.warning("Chatto: DeleteMessage failed for %s: %s", message_id, e)
  971. return False
  972. except Exception as e:
  973. logger.warning("Chatto: DeleteMessage error for %s: %s", message_id, e)
  974. return False
  975. async def create_handoff_thread(
  976. self, parent_chat_id: str, name: str,
  977. ) -> Optional[str]:
  978. """Anchor a session handoff in a fresh thread under *parent_chat_id*.
  979. Chatto threads hang off a message, not off the room, so we post a seed
  980. message and hand its ID back as the thread root — the same shape the
  981. Slack adapter uses. DMs don't support threads, so they get ``None``
  982. and the watcher keeps delivering into the DM itself.
  983. BasePlatformAdapter override
  984. """
  985. if not parent_chat_id:
  986. return None
  987. if self._room_kinds.get(parent_chat_id) == RoomKind.DM:
  988. logger.debug("Chatto: handoff thread skipped — %s is a DM", parent_chat_id)
  989. return None
  990. try:
  991. client = await self._require_client()
  992. except RuntimeError:
  993. logger.warning("Chatto: handoff thread — client unavailable")
  994. return None
  995. seed_text = f"🧵 Hermes handoff — **{(name or 'session').strip()[:80]}**"
  996. try:
  997. msg = await client.post_message(room_id=str(parent_chat_id), body=seed_text)
  998. except Exception as e:
  999. logger.warning(
  1000. "Chatto: handoff thread seed-post failed for room %s: %s",
  1001. parent_chat_id, e,
  1002. )
  1003. return None
  1004. seed_id = getattr(msg, "id", "") or ""
  1005. if not seed_id:
  1006. logger.warning("Chatto: handoff thread seed-post returned no message id")
  1007. return None
  1008. self._mark_seen(seed_id)
  1009. self._our_message_ids.add(seed_id)
  1010. self._our_thread_roots.add(seed_id)
  1011. try:
  1012. await client.follow_thread(str(parent_chat_id), seed_id)
  1013. except Exception:
  1014. logger.debug(
  1015. "Chatto: follow_thread failed for handoff %s/%s",
  1016. parent_chat_id, seed_id, exc_info=True,
  1017. )
  1018. return seed_id
  1019. # Overridden from BaseAdapter:
  1020. async def send_typing(self, chat_id: str, metadata=None) -> None:
  1021. """Start a persistent typing indicator for a room.
  1022. Sends a typing ping every 10 seconds (Chatto's indicator likely
  1023. lasts ~8-10s). The background loop runs until ``stop_typing()``
  1024. is called or the task is cancelled.
  1025. BasePlatformAdapter override
  1026. """
  1027. if chat_id in self._typing_tasks:
  1028. return # already running
  1029. async def _typing_loop() -> None:
  1030. try:
  1031. while True:
  1032. try:
  1033. try:
  1034. client = await self._require_client()
  1035. except RuntimeError:
  1036. return
  1037. await client.update_typing_indicator(room_id=str(chat_id))
  1038. except asyncio.CancelledError:
  1039. return
  1040. except Exception:
  1041. pass
  1042. await asyncio.sleep(10)
  1043. except asyncio.CancelledError:
  1044. pass
  1045. finally:
  1046. self._typing_tasks.pop(chat_id, None)
  1047. self._typing_tasks[chat_id] = asyncio.create_task(_typing_loop())
  1048. async def stop_typing(self, chat_id: str) -> None:
  1049. """Stop the persistent typing indicator for a room.
  1050. BasePlatformAdapter override
  1051. """
  1052. task = self._typing_tasks.pop(chat_id, None)
  1053. if task:
  1054. task.cancel()
  1055. try:
  1056. await task
  1057. except (asyncio.CancelledError, Exception):
  1058. pass
  1059. async def get_chat_info(self, chat_id: str) -> Dict[str, Any]:
  1060. """Get information about a chat/room.
  1061. BasePlatformAdapter override
  1062. """
  1063. name = self._room_names.get(chat_id, chat_id)
  1064. kind = self._room_kinds.get(chat_id)
  1065. return {
  1066. "name": name,
  1067. "type": chat_type_for_room_kind(kind).value,
  1068. }
  1069. # ------------------------------------------------------------------ #
  1070. # Reactions
  1071. # ------------------------------------------------------------------ #
  1072. @staticmethod
  1073. def _emoji_to_shortcode(emoji: str) -> str:
  1074. """Convert a unicode emoji to a Chatto shortcode name.
  1075. If the emoji is already a shortcode (no unicode mapping found),
  1076. return it as-is.
  1077. """
  1078. shortcode = ChattoConstants.EMOJI_TO_SHORTCODE.get(emoji)
  1079. if shortcode:
  1080. return shortcode
  1081. # Already a shortcode like "thumbsup" — return as-is
  1082. return emoji
  1083. async def add_reaction(self, room_id: str, message_id: str, emoji: str) -> bool:
  1084. """Add a reaction to a message via MessageService/AddReaction."""
  1085. shortcode = self._emoji_to_shortcode(emoji)
  1086. try:
  1087. try:
  1088. client = await self._require_client()
  1089. except RuntimeError:
  1090. logger.warning("Chatto: AddReaction — client unavailable")
  1091. return False
  1092. result = await client.add_reaction(
  1093. room_id=room_id,
  1094. message_event_id=message_id,
  1095. emoji=shortcode,
  1096. )
  1097. return result
  1098. except ChattoError as e:
  1099. logger.warning("Chatto: AddReaction failed: %s", e)
  1100. return False
  1101. except Exception as e:
  1102. logger.warning("Chatto: AddReaction error: %s", e)
  1103. return False
  1104. async def remove_reaction(self, chat_id: str, message_id: str, emoji: str) -> bool:
  1105. """Remove a reaction from a message via MessageService/RemoveReaction."""
  1106. shortcode = self._emoji_to_shortcode(emoji)
  1107. try:
  1108. try:
  1109. client = await self._require_client()
  1110. except RuntimeError:
  1111. logger.warning("Chatto: RemoveReaction — client unavailable")
  1112. return False
  1113. result = await client.remove_reaction(
  1114. room_id=str(chat_id),
  1115. message_event_id=str(message_id),
  1116. emoji=shortcode,
  1117. )
  1118. return result
  1119. except ChattoError as e:
  1120. logger.warning("Chatto: RemoveReaction failed: %s", e)
  1121. return False
  1122. except Exception as e:
  1123. logger.warning("Chatto: RemoveReaction error: %s", e)
  1124. return False
  1125. # ------------------------------------------------------------------ #
  1126. # DM initiation (Chatto-unique)
  1127. # ------------------------------------------------------------------ #
  1128. async def start_dm(self, user_id: str) -> Optional[str]:
  1129. """Start a direct message with a user via RoomService/StartDM.
  1130. Returns the room ID on success, or None on failure.
  1131. """
  1132. if not user_id:
  1133. return None
  1134. try:
  1135. try:
  1136. client = await self._require_client()
  1137. except RuntimeError:
  1138. return None
  1139. room = await client.start_dm(participant_ids=[str(user_id)])
  1140. self._room_names[room.id] = room.name
  1141. self._room_kinds[room.id] = room.kind
  1142. return room.id
  1143. except ChattoError as e:
  1144. logger.debug("Chatto: StartDM failed: %s", e)
  1145. return None
  1146. except Exception as e:
  1147. logger.debug("Chatto: StartDM error: %s", e)
  1148. return None
  1149. # ------------------------------------------------------------------ #
  1150. # Room creation (Chatto-unique)
  1151. # ------------------------------------------------------------------ #
  1152. async def create_room(
  1153. self,
  1154. name: str,
  1155. description: str = "",
  1156. group_id: str = "",
  1157. universal: bool = True,
  1158. ) -> Optional[str]:
  1159. """Create an ad-hoc room via RoomService/CreateRoom.
  1160. Returns the room ID on success, or None on failure.
  1161. """
  1162. try:
  1163. try:
  1164. client = await self._require_client()
  1165. except RuntimeError:
  1166. return None
  1167. room = await client.create_room(
  1168. name=name,
  1169. group_id=group_id or "",
  1170. description=description,
  1171. universal=universal,
  1172. )
  1173. rid = str(room.id) if room else ""
  1174. if rid:
  1175. self._room_names[rid] = room.name
  1176. self._room_kinds[rid] = room.kind
  1177. return rid
  1178. logger.debug("Chatto: CreateRoom returned no room id")
  1179. return None
  1180. except ChattoError as e:
  1181. logger.debug("Chatto: CreateRoom failed: %s", e)
  1182. return None
  1183. except Exception as e:
  1184. logger.debug("Chatto: CreateRoom error: %s", e)
  1185. return None
  1186. # ------------------------------------------------------------------ #
  1187. # Processing lifecycle hooks (reactions-based, like Discord)
  1188. # ------------------------------------------------------------------ #
  1189. def _event_room_and_message_id(self, event: MessageEvent) -> Tuple[str, str]:
  1190. """Extract room_id and message_id from a MessageEvent."""
  1191. message_id = event.message_id or ""
  1192. chat_id = event.source.chat_id
  1193. return chat_id, message_id
  1194. async def on_processing_start(self, event: MessageEvent) -> None:
  1195. """Add an 👀 (eyes) reaction to the incoming message.
  1196. BasePlatformAdapter override
  1197. """
  1198. if not self.chatto_config.reactions.value:
  1199. return
  1200. chat_id, message_id = self._event_room_and_message_id(event)
  1201. if not chat_id or not message_id:
  1202. # Routine, not a fault: the gateway runs agent-initiated turns
  1203. # (heartbeat polls, goal continuations) through the same pipeline
  1204. # with message_id=None, and there is no inbound message to mark.
  1205. logger.debug(
  1206. "Chatto: nothing to react to (chat_id=%r, message_id=%r)",
  1207. chat_id, message_id,
  1208. )
  1209. return
  1210. await self.add_reaction(chat_id, message_id, "👀")
  1211. async def on_processing_complete(
  1212. self, event: MessageEvent, outcome: ProcessingOutcome
  1213. ) -> None:
  1214. """Swap the 👀 reaction for ✅ (success) or ❌ (failure).
  1215. BasePlatformAdapter override
  1216. """
  1217. if not self.chatto_config.reactions.value:
  1218. return
  1219. chat_id, message_id = self._event_room_and_message_id(event)
  1220. if not chat_id or not message_id:
  1221. return
  1222. # Remove the processing eyes reaction
  1223. await self.remove_reaction(chat_id, message_id, "👀")
  1224. # Add the outcome reaction
  1225. if outcome == ProcessingOutcome.SUCCESS:
  1226. await self.add_reaction(chat_id, message_id, "✅")
  1227. elif outcome == ProcessingOutcome.FAILURE:
  1228. await self.add_reaction(chat_id, message_id, "❌")
  1229. # ------------------------------------------------------------------ #
  1230. # Asset upload (chunked)
  1231. # ------------------------------------------------------------------ #
  1232. async def _upload_asset(self, room_id: str, file_path: str) -> Optional[str]:
  1233. """Upload a file via the chunked AssetUploadService.
  1234. Returns the asset ID on success, or None on failure.
  1235. """
  1236. try:
  1237. with open(file_path, "rb") as f:
  1238. file_data = f.read()
  1239. except Exception as e:
  1240. logger.error("Chatto: failed to read file %s — %s", file_path, e)
  1241. return None
  1242. if not file_data:
  1243. logger.error("Chatto: file %s is empty", file_path)
  1244. return None
  1245. file_size = len(file_data)
  1246. file_name = os.path.basename(file_path)
  1247. mime_type = mimetypes.guess_type(file_path)[0] or "application/octet-stream"
  1248. sha256_hash = hashlib.sha256(file_data).hexdigest()
  1249. try:
  1250. try:
  1251. client = await self._require_client()
  1252. except RuntimeError:
  1253. logger.error("Chatto: upload aborted - no client available")
  1254. return None
  1255. # Step 1: Create upload session
  1256. upload = await client.create_upload(
  1257. room_id=room_id,
  1258. filename=file_name,
  1259. size=file_size,
  1260. sha256=sha256_hash,
  1261. content_type=mime_type,
  1262. )
  1263. # AssetUpload names this upload_id, not id — reading it through an
  1264. # untyped getattr default is what let the mismatch reach production.
  1265. upload_id = upload.upload_id
  1266. if not upload_id:
  1267. logger.error("Chatto: CreateUpload returned no upload ID")
  1268. return None
  1269. # Step 2: Upload chunks
  1270. offset = 0
  1271. while offset < file_size:
  1272. chunk = file_data[offset:offset + ChattoConstants.UPLOAD_CHUNK_SIZE]
  1273. chunk_sha256 = hashlib.sha256(chunk).hexdigest()
  1274. await client.upload_chunk(
  1275. upload_id=upload_id,
  1276. offset=offset,
  1277. content=chunk,
  1278. chunk_sha256=chunk_sha256,
  1279. )
  1280. offset += len(chunk)
  1281. # Step 3: Complete upload
  1282. upload, asset = await client.complete_upload(upload_id=upload_id)
  1283. if not asset:
  1284. logger.error("Chatto: CompleteUpload returned no asset")
  1285. return None
  1286. asset_id = str(getattr(cast(Any, asset), "id", ""))
  1287. logger.info("Chatto: uploaded %s as asset %s (%d bytes)", file_name, asset_id, file_size)
  1288. return asset_id
  1289. except ChattoError as e:
  1290. logger.error("Chatto: upload failed: %s", e)
  1291. return None
  1292. except Exception as e:
  1293. logger.error("Chatto: upload error: %s", e)
  1294. return None
  1295. async def _post_attachment_message(
  1296. self,
  1297. chat_id: str,
  1298. asset_ids: List[str],
  1299. caption: Optional[str],
  1300. reply_to: Optional[str],
  1301. metadata: Optional[Dict[str, Any]],
  1302. ) -> SendResult:
  1303. """Post one message carrying already-uploaded assets."""
  1304. thread_id = (metadata or {}).get("thread_id")
  1305. if reply_to:
  1306. thread_id = reply_to
  1307. try:
  1308. try:
  1309. client = await self._require_client()
  1310. except RuntimeError:
  1311. return SendResult(success=False, error="Chatto client not available", retryable=True)
  1312. msg = await client.post_message(
  1313. room_id=str(chat_id),
  1314. body=self.format_message(caption) if caption else "",
  1315. attachment_asset_ids=asset_ids,
  1316. thread_root_event_id=str(thread_id) if thread_id else "",
  1317. )
  1318. self._mark_seen(msg.id)
  1319. self._our_message_ids.add(msg.id)
  1320. return SendResult(success=True, message_id=msg.id, raw_response=msg)
  1321. except ChattoError as e:
  1322. return SendResult(success=False, error=str(e), retryable=True)
  1323. except Exception as e:
  1324. return SendResult(success=False, error=str(e), retryable=False)
  1325. async def _send_local_attachment(
  1326. self,
  1327. chat_id: str,
  1328. file_path: str,
  1329. caption: Optional[str],
  1330. reply_to: Optional[str],
  1331. metadata: Optional[Dict[str, Any]],
  1332. *,
  1333. kind: str,
  1334. ) -> SendResult:
  1335. """Upload a local file and post it as a native Chatto attachment.
  1336. Shared by ``send_image_file``/``send_document``/``send_video``/
  1337. ``send_voice`` — the upload mechanics are identical, only the wording of
  1338. the failure notice differs. On failure we send that notice as text and
  1339. never the host path (it leaks the Hermes home layout).
  1340. """
  1341. notice = f"⚠️ Couldn't deliver the {kind} attachment."
  1342. safe_path = self.validate_media_delivery_path(file_path)
  1343. if not safe_path:
  1344. logger.warning(
  1345. "[%s] send %s: unsafe path %s", self.name, kind, file_path,
  1346. )
  1347. text = f"{caption}\n{notice}" if caption else notice
  1348. return await self.send(chat_id, text, reply_to=reply_to, metadata=metadata)
  1349. asset_id = await self._upload_asset(str(chat_id), safe_path)
  1350. if not asset_id:
  1351. logger.warning(
  1352. "[%s] send %s: upload failed for %s", self.name, kind, safe_path,
  1353. )
  1354. text = f"{caption}\n{notice}" if caption else notice
  1355. return await self.send(chat_id, text, reply_to=reply_to, metadata=metadata)
  1356. return await self._post_attachment_message(
  1357. chat_id, [asset_id], caption, reply_to, metadata,
  1358. )
  1359. async def send_image_file(
  1360. self,
  1361. chat_id: str,
  1362. image_path: str,
  1363. caption: Optional[str] = None,
  1364. reply_to: Optional[str] = None,
  1365. metadata: Optional[Dict[str, Any]] = None,
  1366. **kwargs,
  1367. ) -> SendResult:
  1368. """Send a local image file via the chunked upload API.
  1369. The parameter is ``image_path``, not ``file_path``: every caller passes
  1370. it by keyword (``gateway/run.py:22354``, ``:22470``, and the base class's
  1371. own ``send_multiple_images`` file:// branch), so a renamed parameter
  1372. makes each of those raise TypeError and silently degrade to a text
  1373. notice.
  1374. BasePlatformAdapter override
  1375. """
  1376. return await self._send_local_attachment(
  1377. chat_id, image_path, caption, reply_to, metadata, kind="image",
  1378. )
  1379. async def send_document(
  1380. self,
  1381. chat_id: str,
  1382. file_path: str,
  1383. caption: Optional[str] = None,
  1384. file_name: Optional[str] = None,
  1385. reply_to: Optional[str] = None,
  1386. metadata: Optional[Dict[str, Any]] = None,
  1387. **kwargs,
  1388. ) -> SendResult:
  1389. """Send a local file as a native Chatto attachment.
  1390. ``file_name`` is the user-facing name the agent chose; Chatto takes the
  1391. filename from the upload session, so it only matters for the failure
  1392. notice.
  1393. BasePlatformAdapter override
  1394. """
  1395. result = await self._send_local_attachment(
  1396. chat_id, file_path, caption, reply_to, metadata, kind="file",
  1397. )
  1398. if not result.success and file_name:
  1399. logger.debug("Chatto: document delivery failed for %s", file_name)
  1400. return result
  1401. async def send_video(
  1402. self,
  1403. chat_id: str,
  1404. video_path: str,
  1405. caption: Optional[str] = None,
  1406. reply_to: Optional[str] = None,
  1407. metadata: Optional[Dict[str, Any]] = None,
  1408. **kwargs,
  1409. ) -> SendResult:
  1410. """Send a local video as a native Chatto attachment (Chatto transcodes
  1411. and plays it inline).
  1412. BasePlatformAdapter override
  1413. """
  1414. return await self._send_local_attachment(
  1415. chat_id, video_path, caption, reply_to, metadata, kind="video",
  1416. )
  1417. async def send_voice(
  1418. self,
  1419. chat_id: str,
  1420. audio_path: str,
  1421. caption: Optional[str] = None,
  1422. reply_to: Optional[str] = None,
  1423. metadata: Optional[Dict[str, Any]] = None,
  1424. **kwargs,
  1425. ) -> SendResult:
  1426. """Send a local audio file as a native Chatto attachment.
  1427. Chatto has no dedicated voice-bubble type, so this is an ordinary audio
  1428. attachment — still far better than the base class's text notice.
  1429. BasePlatformAdapter override
  1430. """
  1431. return await self._send_local_attachment(
  1432. chat_id, audio_path, caption, reply_to, metadata, kind="audio",
  1433. )
  1434. async def send_image(
  1435. self,
  1436. chat_id: str,
  1437. image_url: str,
  1438. caption: Optional[str] = None,
  1439. reply_to: Optional[str] = None,
  1440. metadata: Optional[Dict[str, Any]] = None,
  1441. ) -> SendResult:
  1442. """Send an image to a Chatto room.
  1443. Tries to download the image from the URL and upload it as a native
  1444. attachment. Falls back to sending the URL as a link (Chatto renders
  1445. link previews) if the download fails.
  1446. BasePlatformAdapter override
  1447. """
  1448. # Try downloading and uploading as attachment
  1449. try:
  1450. import tempfile
  1451. import urllib.request as _urllib_request
  1452. # Download to a temp file
  1453. parsed = urlsplit(image_url)
  1454. url_path = parsed.path
  1455. ext = os.path.splitext(url_path)[1] or ".png"
  1456. tmp_fd, tmp_path = tempfile.mkstemp(suffix=ext, prefix="chatto_img_")
  1457. try:
  1458. os.close(tmp_fd)
  1459. req = _urllib_request.Request(image_url, headers={"User-Agent": "Hermes/1.0"})
  1460. try:
  1461. import ssl
  1462. ctx = ssl.create_default_context()
  1463. except Exception:
  1464. ctx = None
  1465. with _urllib_request.urlopen(req, timeout=ChattoConstants.HTTP_TIMEOUT, context=ctx) as resp:
  1466. with open(tmp_path, "wb") as f:
  1467. f.write(resp.read())
  1468. # Upload as attachment
  1469. result = await self.send_image_file(
  1470. chat_id, tmp_path, caption=caption,
  1471. reply_to=reply_to, metadata=metadata,
  1472. )
  1473. if result.success:
  1474. return result
  1475. finally:
  1476. try:
  1477. os.unlink(tmp_path)
  1478. except OSError:
  1479. pass
  1480. except Exception as e:
  1481. logger.debug("Chatto: send_image download/upload failed, falling back to link: %s", e)
  1482. # Fallback: send as link (Chatto renders link previews)
  1483. text = image_url
  1484. if caption:
  1485. text = f"{caption}\n{image_url}"
  1486. return await self.send(chat_id, text, reply_to=reply_to, metadata=metadata)
  1487. async def _materialise_image(self, image_url: str) -> Tuple[Optional[str], bool]:
  1488. """Resolve one ``send_multiple_images`` entry to a local file path.
  1489. Accepts ``http(s)://`` URLs (downloaded to a temp file), ``file://``
  1490. URIs and bare paths. Returns ``(path, is_temp)`` — the caller unlinks
  1491. when ``is_temp``. ``(None, False)`` means the entry is unusable.
  1492. """
  1493. import tempfile
  1494. from urllib.parse import unquote as _unquote
  1495. if image_url.startswith(("http://", "https://")):
  1496. parsed = urlsplit(image_url)
  1497. ext = os.path.splitext(parsed.path)[1] or ".png"
  1498. tmp_fd, tmp_path = tempfile.mkstemp(suffix=ext, prefix="chatto_img_")
  1499. os.close(tmp_fd)
  1500. try:
  1501. data = await self._download_attachment_bytes(image_url)
  1502. with open(tmp_path, "wb") as f:
  1503. f.write(data)
  1504. except Exception as e:
  1505. logger.warning("Chatto: image download failed for %s: %s", image_url, e)
  1506. try:
  1507. os.unlink(tmp_path)
  1508. except OSError:
  1509. pass
  1510. return None, False
  1511. return tmp_path, True
  1512. local = image_url
  1513. if local.startswith("file://"):
  1514. local = _unquote(urlsplit(local).path)
  1515. return self.validate_media_delivery_path(local), False
  1516. async def send_multiple_images(
  1517. self,
  1518. chat_id: str,
  1519. images: List[Tuple[str, str]],
  1520. metadata: Optional[Dict[str, Any]] = None,
  1521. human_delay: float = 0.0,
  1522. ) -> None:
  1523. """Send a batch of images as ONE message with several attachments.
  1524. The base implementation posts each image separately; a Chatto message
  1525. carries a list of attachment assets, so a batch belongs in a single
  1526. message (and a single notification).
  1527. ``human_delay`` is ignored deliberately — there is only one outbound
  1528. call to pace. Entries that can't be fetched are dropped with a warning;
  1529. if nothing survives, we fall back to the base class so the user still
  1530. gets the links.
  1531. BasePlatformAdapter override
  1532. """
  1533. if len(images or []) < 2:
  1534. await super().send_multiple_images(
  1535. chat_id, images, metadata=metadata, human_delay=human_delay,
  1536. )
  1537. return
  1538. asset_ids: List[str] = []
  1539. captions: List[str] = []
  1540. for image_url, alt_text in images:
  1541. path, is_temp = await self._materialise_image(image_url)
  1542. if not path:
  1543. logger.warning("Chatto: skipping unusable image %s", image_url)
  1544. continue
  1545. try:
  1546. asset_id = await self._upload_asset(str(chat_id), path)
  1547. finally:
  1548. if is_temp:
  1549. try:
  1550. os.unlink(path)
  1551. except OSError:
  1552. pass
  1553. if not asset_id:
  1554. logger.warning("Chatto: upload failed for image %s", image_url)
  1555. continue
  1556. asset_ids.append(asset_id)
  1557. if alt_text:
  1558. captions.append(alt_text)
  1559. if not asset_ids:
  1560. logger.warning(
  1561. "Chatto: no image survived upload, falling back to per-image delivery",
  1562. )
  1563. await super().send_multiple_images(
  1564. chat_id, images, metadata=metadata, human_delay=human_delay,
  1565. )
  1566. return
  1567. if len(asset_ids) < len(images):
  1568. logger.warning(
  1569. "Chatto: sending %d of %d images — the rest could not be uploaded",
  1570. len(asset_ids), len(images),
  1571. )
  1572. await self._post_attachment_message(
  1573. chat_id, asset_ids, "\n".join(captions) or None, None, metadata,
  1574. )
  1575. # ---------------------------------------------------------------------------
  1576. # Cron / out-of-process delivery
  1577. # ---------------------------------------------------------------------------
  1578. async def hermes_standalone_sender_fn(
  1579. pconfig,
  1580. chat_id,
  1581. message,
  1582. *,
  1583. thread_id=None,
  1584. media_files=None,
  1585. force_document=False,
  1586. ) -> SendResult:
  1587. """Deliver a message to Chatto without a running gateway adapter. Do not modify signature.
  1588. Used by cron / scheduled routines that run out-of-process. Creates a
  1589. short-lived chattolib client, posts, and closes.
  1590. """
  1591. chatto_config: ChattoConfiguration = ChattoConfiguration(pconfig=pconfig)
  1592. # Create a temporary client for standalone sending — we need a base URL plus
  1593. # either a token or a full login/password pair.
  1594. has_credentials = bool(
  1595. chatto_config.token.value
  1596. or (chatto_config.login.value and chatto_config.password.value)
  1597. )
  1598. if not chatto_config.base_url.value or not has_credentials:
  1599. return SendResult(success=False, error="Chatto: base URL or credentials missing")
  1600. client: ChattoClient
  1601. try:
  1602. if chatto_config.token.value:
  1603. client = ChattoClient(base_url=chatto_config.base_url.value, token=chatto_config.token.value)
  1604. else:
  1605. client = await ChattoClient.login(
  1606. base_url=chatto_config.base_url.value,
  1607. login=chatto_config.login.value,
  1608. password=chatto_config.password.value,
  1609. )
  1610. except Exception as exc:
  1611. return SendResult(success=False, error=f"Chatto login failed: {exc}")
  1612. try:
  1613. kwargs: Dict[str, Any] = {}
  1614. if chatto_config.auto_thread.value and thread_id:
  1615. kwargs["in_reply_to"] = thread_id
  1616. if media_files and media_files.get("attachment_asset_ids"):
  1617. kwargs["attachment_asset_ids"] = list(media_files["attachment_asset_ids"])
  1618. try:
  1619. posted = await client.post_message(chat_id, message, **kwargs)
  1620. except Exception as exc:
  1621. return SendResult(success=False, error=str(exc))
  1622. return SendResult(success=True, message_id=getattr(posted, "id", "") or None)
  1623. finally:
  1624. try:
  1625. await client.close()
  1626. except Exception as exc:
  1627. logger.error(
  1628. "Chatto standalone: error closing short-lived client (perhaps already closed): %s", exc,
  1629. )
  1630. def hermes_validate_config(config: PlatformConfig) -> bool:
  1631. """"
  1632. Function name should be the same as register argument name with "hermes_" prefix, so we
  1633. know that it is needed for plugin register(). Do not change signature.
  1634. - config
  1635. Check whether Chatto Plugin is configured. Compare to hermes_is_connected()."""
  1636. chatto_config = ChattoConfiguration(pconfig=config)
  1637. if len(chatto_config.allowed_users.value) > 0 and chatto_config.allow_all_users.value:
  1638. logger.info("Chatto: Conflicting configuration. Either use 'allowed_users' or 'allow_all_users' but not both.")
  1639. return False
  1640. if chatto_config.base_url.value:
  1641. if (chatto_config.token.value is not None) or (chatto_config.login.value and chatto_config.password.value):
  1642. return True
  1643. else:
  1644. logger.error("Chatto: Minimally, either token or login/password must be set.")
  1645. else:
  1646. logger.error("Chatto: base_url must be set.")
  1647. return False
  1648. def hermes_check_fn() -> bool:
  1649. """Check if Chatto is configured and dependencies are available.
  1650. Add real logic?! Or just .. there are no dependencies.. always return true. Really. Docs suck."""
  1651. try:
  1652. import chattolib.client # noqa: F401 — vendored dependency probe
  1653. return True
  1654. except ImportError:
  1655. return False
  1656. # ---------------------------------------------------------------------------
  1657. # is_connected probe
  1658. # ---------------------------------------------------------------------------
  1659. def hermes_is_connected(config: PlatformConfig) -> bool:
  1660. """Check whether Chatto Plugin is connected. But where to? To the Hermes Agent? To Chatto Server?
  1661. The Hermes Agent plugin docs suck and it seems there are many functions to do the same."""
  1662. return bool(hermes_validate_config(config) and config.enabled)
  1663. def hermes_setup_fn() -> None:
  1664. """Interactive setup wizard for Chatto. Is called by and only works in Hermes CLI context.
  1665. Function name should be the same as register argument name with "hermes_" prefix, so we
  1666. know that it is needed for plugin register().
  1667. """
  1668. from hermes_cli.setup import (
  1669. prompt,
  1670. prompt_yes_no,
  1671. save_env_value,
  1672. get_env_value,
  1673. print_header,
  1674. print_info,
  1675. print_warning,
  1676. print_success,
  1677. )
  1678. url = prompt(
  1679. "Chatto server URL (e.g. https://chat.example.com) or leave blank for default ChattoHQ on chat.chatto.run:")
  1680. if url:
  1681. save_env_value(ChattoConfiguration.base_url.env_name, url)
  1682. login = prompt("Chatto login (username):")
  1683. if login:
  1684. save_env_value(ChattoConfiguration.login.env_name, login)
  1685. password = prompt("Chatto password:", password=True)
  1686. if password:
  1687. save_env_value(ChattoConfiguration.password.env_name, password)
  1688. channels = prompt("Room IDs to watch (comma-separated, or empty for all):")
  1689. if channels:
  1690. save_env_value(ChattoConfiguration.channels_list.env_name, channels)
  1691. home = prompt("Home room ID for notifications (or empty):")
  1692. if home:
  1693. save_env_value(ChattoConfiguration.home_channel.env_name, home)
  1694. allow_all = prompt_yes_no("Allow all users to talk? (true/false):")
  1695. if allow_all:
  1696. save_env_value(ChattoConfiguration.allow_all_users.env_name, str(allow_all))
  1697. print_success("\n✓ Chatto configured. Restart the gateway to activate.")
  1698. def hermes_env_enablement_fn() -> Optional[dict]:
  1699. """Seed PlatformConfig.extra from env vars.
  1700. Returns a dict compatible with the PlatformConfig merge hook (or None
  1701. when no env-provided values are present).
  1702. Called by the platform registry during load_gateway_config().
  1703. Return None when the platform isn't minimally configured — the
  1704. caller then skips auto-enabling. Return a dict to seed extras.
  1705. The special 'home_channel' key is extracted and becomes a proper
  1706. HomeChannel dataclass on the PlatformConfig; every other key is
  1707. merged into PlatformConfig.extra.
  1708. Function name should be the same as register argument name with "hermes_" prefix, so we
  1709. know that it is needed for plugin register().
  1710. """
  1711. # Seed keys must be the config.yaml "extra" keys (config_key), NOT the env
  1712. # var names — ChattoConfiguration reads extra[config_key].
  1713. seed: Dict[str, Any] = {
  1714. ChattoConfiguration.base_url.config_key: (
  1715. os.getenv(ChattoConfiguration.base_url.env_name) or ChattoClient.DEFAULT_BASE_URL
  1716. ).strip(),
  1717. }
  1718. for field in ChattoConfiguration.fields():
  1719. if field.field_name == ChattoConfiguration.base_url.field_name:
  1720. continue
  1721. env_value = os.getenv(field.env_name)
  1722. if env_value:
  1723. seed[field.config_key] = env_value.strip()
  1724. logger.debug("seed: %s", {k: v for k, v in seed.items() if k not in ("token", "password")})
  1725. return seed
  1726. # ---------------------------------------------------------------------------
  1727. # Plugin registration entry point
  1728. # ---------------------------------------------------------------------------
  1729. # What each capability is called in the startup banner, keyed by the method
  1730. # that implements it. Derived from real overrides rather than hard-coded, so
  1731. # dropping a method drops its claim from the log instead of leaving a lie.
  1732. _CAPABILITY_LABELS = {
  1733. "send": "text",
  1734. "send_image_file": "images",
  1735. "send_multiple_images": "image batches (bundled into one message)",
  1736. "send_video": "video",
  1737. "send_voice": "voice messages",
  1738. "send_document": "documents",
  1739. "add_reaction": "reactions",
  1740. "edit_message": "message editing",
  1741. "delete_message": "message deletion",
  1742. "send_typing": "typing indicators",
  1743. "create_handoff_thread": "threads",
  1744. "start_dm": "direct messages",
  1745. "create_room": "room creation",
  1746. }
  1747. def _capabilities() -> List[str]:
  1748. """Name the things this adapter genuinely implements itself.
  1749. A capability counts only when ChattoAdapter overrides the base method —
  1750. inheriting BasePlatformAdapter's fallback means the feature is not
  1751. natively supported, and announcing it would mislead.
  1752. """
  1753. found = [
  1754. label
  1755. for name, label in _CAPABILITY_LABELS.items()
  1756. if getattr(ChattoAdapter, name, None) is not getattr(BasePlatformAdapter, name, None)
  1757. ]
  1758. if ChattoAdapter.supports_code_blocks:
  1759. found.append("code blocks")
  1760. if ChattoAdapter.supports_status_text:
  1761. found.append("custom status text")
  1762. found.append("presence (refreshed while connected)")
  1763. return found
  1764. def register(ctx) -> None:
  1765. """Plugin entry point — called by the Hermes plugin system."""
  1766. logger.info("Registering Chatto platform plugin on Hermes Agent")
  1767. for capability in _capabilities():
  1768. logger.info("Chatto capability: %s", capability)
  1769. logger.info("ChattoConfiguration.allowed_users.env_name: %s", ChattoConfiguration.allowed_users.env_name)
  1770. ctx.register_platform(
  1771. name=ChattoConstants.PLATFORM_NAME, # this will be the config.yaml key.
  1772. label=ChattoConstants.PLATFORM_LABEL,
  1773. adapter_factory=hermes_adapter_factory,
  1774. check_fn=hermes_check_fn,
  1775. validate_config=hermes_validate_config,
  1776. is_connected=hermes_is_connected,
  1777. install_hint=ChattoConstants.INSTALL_HINT,
  1778. env_enablement_fn=hermes_env_enablement_fn,
  1779. setup_fn=hermes_setup_fn,
  1780. cron_deliver_env_var=ChattoConfiguration.home_channel.env_name,
  1781. standalone_sender_fn=hermes_standalone_sender_fn,
  1782. allowed_users_env=ChattoConfiguration.allowed_users.env_name,
  1783. allow_all_env=ChattoConfiguration.allow_all_users.env_name,
  1784. max_message_length=ChattoConstants.MAX_MESSAGE_LENGTH,
  1785. emoji="💬",
  1786. allow_update_command=True,
  1787. pii_safe=False,
  1788. platform_hint=(
  1789. "Using the 'Hermes Chatto Platform Plugin' you connect to a Chatto server. "
  1790. "Authorized admins and users will contact you and call you his Hermes Agent. They are "
  1791. "natural persons and thus responsible for what they do in terms of rights. You compute "
  1792. "on their behalf. They _may_ address you by @-mentioning your name. If configured, "
  1793. "you also react without a @-mention. Direct messages reach you without a mention."
  1794. "Keep responses conversational. Markdown is supported. "
  1795. "Include MEDIA:/absolute/path/to/file in your response to refer to our local files. Images "
  1796. "(.png, .jpg, .gif, .webp) arrive as inline pictures, videos (.mp4, .mov, .webm) as "
  1797. "video attachments, audio as a voice bubble, anything else as a downloadable document. "
  1798. "Do NOT use markdown image syntax for local files. Local files always go through MEDIA:. "
  1799. "Several images in one response are bundled into a single message. "
  1800. ),
  1801. )