| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462 |
- """Standalone per-platform senders and error helpers for send_message."""
- from pm import install_hint
- import asyncio
- import contextlib
- import logging
- import os
- import re
- import time
- from agent.redact import redact_sensitive_text
- logger = logging.getLogger("tools.send_message_tool")
- _IMAGE_EXTS = {".jpg", ".jpeg", ".png", ".webp", ".gif"}
- _VIDEO_EXTS = {".mp4", ".mov", ".avi", ".mkv", ".webm", ".3gp"}
- _AUDIO_EXTS = {".ogg", ".opus", ".mp3", ".m2a", ".wav", ".m4a", ".flac"}
- _VOICE_EXTS = {".ogg", ".opus"}
- _TELEGRAM_SEND_AUDIO_EXTS = {".mp3", ".m4a"} # sendAudio accepts only these; other audio -> sendVoice / document
- # Captionable on the media bubble; voice/audio notes excluded (a caption there reads as a separate label).
- _CAPTIONABLE_EXTS = _IMAGE_EXTS | _VIDEO_EXTS | {".pdf", ".doc", ".docx", ".txt", ".md", ".csv", ".xlsx", ".zip"}
- # Native caption limits (chars): Telegram caps photo/video at 1024; one conservative shared ceiling elsewhere.
- _TELEGRAM_CAPTION_LIMIT = 1024
- _DEFAULT_CAPTION_LIMIT = 4096
- def _media_caption_split(text, media_files, *, max_caption_len):
- """Single chokepoint deciding whether text rides on the media bubble as its caption:
- ``(caption, "")`` only for exactly one captionable file (not a voice/audio note) whose
- text fits ``max_caption_len``, else ``(None, text)`` — multi-file caption→file association
- is ambiguous. Length is codepoints (never under-counts Telegram's UTF-16 units for BMP
- text); the Telegram sender re-checks the *formatted* caption since escaping inflates it."""
- stripped = (text or "").strip()
- media = media_files or []
- if (not stripped or len(media) != 1 or len(stripped) > max_caption_len or media[0][1]
- or os.path.splitext(media[0][0])[1].lower() not in _CAPTIONABLE_EXTS):
- return None, text
- return stripped, ""
- _URL_SECRET_QUERY_RE = re.compile(
- r"([?&](?:access_token|api[_-]?key|auth[_-]?token|token|signature|sig)=)([^&#\s]+)", re.IGNORECASE)
- _GENERIC_SECRET_ASSIGN_RE = re.compile(
- r"\b(access_token|api[_-]?key|auth[_-]?token|signature|sig)\s*=\s*([^\s,;]+)", re.IGNORECASE)
- def _sanitize_error_text(text) -> str:
- """Redact secrets from error text before surfacing it to users/models."""
- redacted = _URL_SECRET_QUERY_RE.sub(lambda m: f"{m.group(1)}***", redact_sensitive_text(text))
- return _GENERIC_SECRET_ASSIGN_RE.sub(lambda m: f"{m.group(1)}=***", redacted)
- def _error(message: str) -> dict:
- """Build a standardized error payload with redacted content."""
- return {"error": _sanitize_error_text(message)}
- def _success(platform: str, chat_id, warnings=None, **fields) -> dict:
- """Standard success payload; ``warnings`` is only included when non-empty."""
- return {"success": True, "platform": platform, "chat_id": chat_id, **fields,
- **({"warnings": warnings} if warnings else {})}
- _NO_DELIVERABLE = "No deliverable text or media remained after processing MEDIA tags"
- _TELEGRAM_TRANSIENT_MARKERS = ("bad gateway", "502", "too many requests", "429", "service unavailable", "503",
- "gateway timeout", "504")
- def _telegram_retry_delay(exc: Exception, attempt: int) -> float | None:
- """Retry delay in seconds, or None when final: honours ``retry_after``; timeouts are
- never retried (the send may have gone through); 5xx/429 back off exponentially."""
- retry_after = getattr(exc, "retry_after", None)
- if retry_after is not None:
- try:
- return max(float(retry_after), 0.0)
- except (TypeError, ValueError):
- return 1.0
- text = str(exc).lower()
- if "timed out" in text or "timeout" in text:
- return None
- return float(2 ** attempt) if any(marker in text for marker in _TELEGRAM_TRANSIENT_MARKERS) else None
- async def _send_telegram_message_with_retry(bot, *, attempts: int = 3, **kwargs):
- """``bot.send_message`` with bounded retries on transient failures."""
- for attempt in range(attempts):
- try:
- return await bot.send_message(**kwargs)
- except Exception as exc:
- delay = _telegram_retry_delay(exc, attempt)
- if delay is None or attempt >= attempts - 1:
- raise
- logger.warning("Transient Telegram send failure (attempt %d/%d), retrying in %.1fs: %s",
- attempt + 1, attempts, delay, _sanitize_error_text(exc))
- await asyncio.sleep(delay)
- def _is_telegram_thread_not_found(error: Exception) -> bool:
- """Mirror of the gateway adapter's ``_is_thread_not_found_error``.
- Matches the gateway adapter's ``_is_thread_not_found_error`` for the standalone ``_send_telegram`` path
- (issue #27012).
- """
- return "thread not found" in str(error).lower()
- def _telegram_bot(token):
- """Bot honouring TELEGRAM_PROXY (standalone sends time out where api.telegram.org is
- blocked); falls back to a direct connection."""
- from telegram import Bot
- try:
- from gateway.platforms.base import resolve_proxy_url
- proxy = resolve_proxy_url("TELEGRAM_PROXY", target_hosts=["api.telegram.org"])
- if not proxy:
- return Bot(token=token)
- from telegram.request import HTTPXRequest
- logger.info("send_message: standalone Telegram send routed through proxy %s", proxy)
- return Bot(token=token, request=HTTPXRequest(proxy=proxy), get_updates_request=HTTPXRequest(proxy=proxy))
- except Exception as proxy_err:
- logger.warning("send_message: failed to attach Telegram proxy (%s), falling back to direct connection", proxy_err)
- return Bot(token=token)
- def _telegram_thread_kwargs(thread_id):
- """Topic id -> ``message_thread_id`` kwargs. Forum "General" is thread "1" inbound but
- the Bot API rejects message_thread_id=1, so it maps to no thread — same as the adapter."""
- if thread_id is None:
- return {}
- try:
- from plugins.platforms.telegram.adapter import TelegramAdapter
- effective = TelegramAdapter._message_thread_id_for_send(str(thread_id))
- except Exception: # adapter import failed (python-telegram-bot missing): explicit mapping
- effective = None if str(thread_id) == "1" else int(thread_id)
- return {} if effective is None else {"message_thread_id": effective}
- def _strip_mdv2_safe(text):
- """Strip MarkdownV2 escapes for the plain-text fallback; identity if unavailable."""
- try:
- from plugins.platforms.telegram.adapter import _strip_mdv2
- return _strip_mdv2(text)
- except Exception:
- return text
- def _adapter_media_method(ext, voice, force_document=False):
- """``(adapter method, kind)``: document when forced, else image / video / voice by
- extension (``voice`` already folds in the caller's audio rule)."""
- if force_document:
- return "send_document", "document"
- if ext in _IMAGE_EXTS:
- return "send_image_file", "image"
- if ext in _VIDEO_EXTS:
- return "send_video", "video"
- return ("send_voice", "audio") if voice else ("send_document", "document")
- async def _telegram_send_media(bot, chat_id, f, ext, is_voice, force_document, **kwargs):
- """Bot API media method by extension: photo (unless forced document), video, voice note,
- sendAudio (MP3/M4A only), else document."""
- kind = next((k for exts, k in ((() if force_document else _IMAGE_EXTS, "photo"), (_VIDEO_EXTS, "video"),
- (_VOICE_EXTS if is_voice else (), "voice"), (_TELEGRAM_SEND_AUDIO_EXTS, "audio"))
- if ext in exts), "document")
- return await getattr(bot, f"send_{kind}")(chat_id=chat_id, **{kind: f}, **kwargs)
- async def _telegram_send_text_chunk(bot, chat_id, chunk, parse_mode, has_html, text_kwargs):
- """One text chunk with adapter-matching fallbacks: thread-not-found -> retry without
- ``message_thread_id`` (dropped from ``text_kwargs`` for later chunks too); parse failure
- -> plain text."""
- async def send(text, mode):
- return await _send_telegram_message_with_retry(bot, chat_id=chat_id, text=text, parse_mode=mode, **text_kwargs)
- try:
- return await send(chunk, parse_mode)
- except Exception as md_error:
- # Thread not found — retry without message_thread_id so the message still delivers (matching the
- # gateway adapter's fallback behaviour, issue #27012).
- if _is_telegram_thread_not_found(md_error) and text_kwargs.get("message_thread_id") is not None:
- logger.warning("Thread %s not found in _send_telegram, retrying without message_thread_id",
- text_kwargs.pop("message_thread_id"))
- return await send(chunk, parse_mode)
- err_text = str(md_error).lower()
- if "parse" in err_text or "markdown" in err_text or "html" in err_text:
- logger.warning("Parse mode %s failed in _send_telegram, falling back to plain text: %s",
- parse_mode, _sanitize_error_text(md_error))
- return await send(chunk if has_html else _strip_mdv2_safe(chunk), None)
- raise
- async def _telegram_send_one_media(bot, chat_id, media_path, is_voice, *, caption, parse_mode, has_html,
- thread_kwargs, force_document):
- """Upload one file with adapter-matching fallbacks (thread-not-found -> no
- ``message_thread_id``; caption parse failure -> plain caption); retries re-seek the file."""
- ext = os.path.splitext(media_path)[1].lower()
- voice_note = ext in _VOICE_EXTS and is_voice
- # ``caption`` is only set for a single captionable file, so this never double-captions
- # a multi-file send or a voice note.
- media_kwargs = {**thread_kwargs, **({"caption": caption, "parse_mode": parse_mode}
- if caption is not None and not voice_note else {})}
- if voice_note or ext in _TELEGRAM_SEND_AUDIO_EXTS:
- with contextlib.suppress(Exception):
- from plugins.platforms.telegram.adapter import _probe_voice_duration_seconds
- duration = await asyncio.to_thread(_probe_voice_duration_seconds, media_path)
- if duration is not None:
- media_kwargs["duration"] = duration
- thumb_path = None
- if ext in _VIDEO_EXTS:
- # Telegram processes only small video uploads itself; past that the message carries no
- # geometry and no thumbnail, so clients draw a square tile (see the adapter helpers).
- # Keyed on the extension because ``_telegram_send_media`` routes every video extension to
- # ``sendVideo`` regardless of ``force_document`` (which only forces images to documents).
- with contextlib.suppress(Exception):
- from plugins.platforms.telegram.adapter import _probe_video_geometry, _video_thumbnail_jpeg
- geometry = await asyncio.to_thread(_probe_video_geometry, media_path)
- if geometry:
- media_kwargs.update(geometry)
- thumb_path = await asyncio.to_thread(_video_thumbnail_jpeg, media_path, geometry.get("duration"))
- if thumb_path:
- media_kwargs["thumbnail"] = thumb_path
- try:
- with open(media_path, "rb") as f: # noqa: ASYNC230 -- file handle is streamed to the upload; a local open() is non-blocking in practice
- try:
- return await _telegram_send_media(bot, chat_id, f, ext, is_voice, force_document, **media_kwargs)
- except Exception as media_err:
- err_text = str(media_err).lower()
- if _is_telegram_thread_not_found(media_err) and media_kwargs.get("message_thread_id"):
- logger.warning("Thread %s not found for media send, retrying without message_thread_id",
- media_kwargs.pop("message_thread_id"))
- elif media_kwargs.get("parse_mode") and ("parse" in err_text or "caption" in err_text):
- logger.warning("Caption parse failed for media send, retrying plain: %s",
- _sanitize_error_text(media_err))
- media_kwargs.pop("parse_mode", None)
- if not has_html and media_kwargs.get("caption"):
- media_kwargs["caption"] = _strip_mdv2_safe(media_kwargs["caption"])
- else:
- raise
- f.seek(0)
- return await _telegram_send_media(bot, chat_id, f, ext, is_voice, force_document, **media_kwargs)
- finally:
- if thumb_path:
- with contextlib.suppress(OSError):
- os.remove(thumb_path)
- def _telegram_format(message):
- """``(formatted, parse_mode, has_html)``: text already containing HTML tags is sent as
- HTML; otherwise Markdown -> MarkdownV2 via the adapter's ``format_message``."""
- from telegram.constants import ParseMode
- if re.search(r'<[a-zA-Z/][^>]*>', message):
- return message, ParseMode.HTML, True
- try:
- from plugins.platforms.telegram.adapter import TelegramAdapter
- return TelegramAdapter.__new__(TelegramAdapter).format_message(message), ParseMode.MARKDOWN_V2, False
- except Exception:
- return message, ParseMode.MARKDOWN_V2, False # formatting unavailable: send as-is
- async def _send_telegram(token, chat_id, message, media_files=None, thread_id=None, disable_link_previews=False, force_document=False):
- """One-shot Telegram Bot API send; parse failures fall back to plain text."""
- try:
- formatted, send_parse_mode, _has_html = _telegram_format(message)
- bot = _telegram_bot(token)
- from plugins.platforms.telegram.telegram_ids import normalize_telegram_chat_id
- from gateway.platforms.base import BasePlatformAdapter, utf16_len
- # Telegram accepts a numeric chat_id OR an @username string; never force-int.
- # See #13206.
- int_chat_id = normalize_telegram_chat_id(chat_id)
- media_files = media_files or []
- thread_kwargs = _telegram_thread_kwargs(thread_id)
- # disable_web_page_preview is only valid for send_message, not media sends.
- text_kwargs = {**thread_kwargs, **({"disable_web_page_preview": True} if disable_link_previews else {})}
- last_msg, warnings, _tg_caption = None, [], None
- # MEDIA caption rides on the bubble as its *formatted* caption; formatting can inflate a
- # raw <1024 string past Telegram's cap, so re-check in UTF-16 units.
- _cap, _ = _media_caption_split(message, media_files, max_caption_len=_TELEGRAM_CAPTION_LIMIT)
- if _cap is not None and utf16_len(formatted) <= _TELEGRAM_CAPTION_LIMIT:
- _tg_caption, formatted = formatted, "" # suppress the separate text send below
- # Chunk *after* formatting, in UTF-16 units: escaping can push a raw-<4096 message over.
- for chunk in BasePlatformAdapter.truncate_message(formatted, 4096, len_fn=utf16_len) if formatted.strip() else ():
- last_msg = await _telegram_send_text_chunk(bot, int_chat_id, chunk, send_parse_mode, _has_html, text_kwargs)
- for media_path, is_voice in media_files:
- if not os.path.exists(media_path):
- warnings.append(f"Media file not found, skipping: {media_path}")
- logger.warning(warnings[-1])
- # Caption mode suppressed the text send; the file is gone, so deliver the words alone.
- if _tg_caption is not None and last_msg is None:
- try:
- last_msg = await _send_telegram_message_with_retry(
- bot, chat_id=int_chat_id, text=_tg_caption, parse_mode=send_parse_mode, **text_kwargs)
- _tg_caption = None # delivered — don't re-caption a later file
- except Exception as _cap_err:
- logger.warning("Telegram caption-fallback send failed for missing media: %s",
- _sanitize_error_text(_cap_err))
- continue
- try:
- last_msg = await _telegram_send_one_media(
- bot, int_chat_id, media_path, is_voice, caption=_tg_caption, parse_mode=send_parse_mode,
- has_html=_has_html, thread_kwargs=thread_kwargs, force_document=force_document)
- except Exception as e:
- warnings.append(_sanitize_error_text(f"Failed to send media {media_path}: {e}"))
- logger.error(warnings[-1])
- if last_msg is None:
- return {"error": _NO_DELIVERABLE, **({"warnings": warnings} if warnings else {})}
- return _success("telegram", chat_id, warnings, message_id=str(last_msg.message_id))
- except ImportError:
- return {"error": "python-telegram-bot not installed. Run: "
- f"{install_hint('telegram')}"}
- except Exception as e:
- return _error(f"Telegram send failed: {e}")
- def _live_adapter(platform, *, lookup_failed_warning=None):
- """``(runner, adapter)`` for the in-process gateway; ``(None, None)`` standalone (cron);
- ``(runner, None)`` when the lookup fails — logged when a warning is given, never silently
- swallowed (a silent fall-through could recreate a reconnect storm).
- Multiplex: the adapter is the ACTIVE PROFILE's (``_profile_adapters[profile]``), never a bare
- ``runner.adapters`` hit — that map holds the default profile's bots, so a secondary profile's turn
- would post/react with the default bot's identity. A profile with no adapter for the platform
- yields ``None`` (fail closed → the caller's scoped standalone sender or an error), never the
- default bot. Same resolver shape as ``hermes_cli/platform_actions.py::_resolve_adapter``."""
- try:
- from gateway.run import _gateway_runner_ref
- runner = _gateway_runner_ref()
- except Exception:
- runner = None
- if runner is None:
- return None, None
- try:
- resolve = getattr(runner, "_authorization_adapter", None)
- if not callable(resolve): # bare runner stubs without the authz mixin
- return runner, runner.adapters.get(platform)
- from hermes_cli.profiles import get_active_profile_name
- return runner, resolve(platform, get_active_profile_name())
- except Exception:
- if lookup_failed_warning:
- logger.warning(lookup_failed_warning, exc_info=True)
- return runner, None
- def _plugin_standalone_sender(platform_name, *, label=None, discover=True):
- """``(standalone_sender_fn, None)`` for a registered plugin or ``(None, error_dict)``;
- ``discover`` runs the idempotent plugin scan first."""
- from gateway.platform_registry import platform_registry
- if discover:
- from hermes_cli.plugins import discover_plugins
- discover_plugins()
- entry = platform_registry.get(platform_name)
- if entry is None or entry.standalone_sender_fn is None:
- return None, {"error": f"{label or platform_name} plugin not registered or missing standalone_sender_fn"}
- return entry.standalone_sender_fn, None
- async def _registry_standalone_send(platform_name, pconfig, chat_id, message, thread_id=None):
- """One-shot text send through a plugin's ``standalone_sender_fn``."""
- sender, err = _plugin_standalone_sender(platform_name)
- return err or await sender(pconfig, chat_id, message, thread_id=thread_id)
- async def _resolve_slack_user_target(token, chat_id):
- """Resolve ``user:U...`` / ``user_name:<handle>`` to a D... DM conversation (chat.postMessage
- needs a conversation ID); ``user_name:`` goes through users.list first (stable handle match
- only); other ids pass through. ``(chat_id, None)`` or ``(None, error_dict)``."""
- if not (chat_id.startswith("user:") or chat_id.startswith("user_name:")):
- return chat_id, None
- try:
- import aiohttp
- except ImportError:
- return None, {"error": "aiohttp not installed. Run: "
- f"{install_hint('messaging')}"}
- try:
- from gateway.platforms.base import resolve_proxy_url, proxy_kwargs_for_aiohttp
- _sess_kw, _req_kw = proxy_kwargs_for_aiohttp(resolve_proxy_url())
- headers = {"Authorization": f"Bearer {token}", "Content-Type": "application/json"}
- async with aiohttp.ClientSession(timeout=aiohttp.ClientTimeout(total=30), **_sess_kw) as session:
- async def post_api(method, payload):
- async with session.post(f"https://slack.com/api/{method}", headers=headers, json=payload,
- **_req_kw) as resp:
- return await resp.json()
- if chat_id.startswith("user_name:"):
- name = chat_id[len("user_name:"):]
- query = name.strip().lstrip("@").lower()
- matches, cursor = [], None
- for _page in range(20):
- data = await post_api("users.list", {"limit": 200, **({"cursor": cursor} if cursor else {})})
- if not data.get("ok"):
- return None, _error(f"Slack users.list error: {data.get('error', 'unknown')}")
- # Stable handle only: display/real names are mutable and non-unique.
- matches += [m for m in data.get("members", []) if not (m.get("deleted") or m.get("is_bot"))
- and str(m.get("name", "")).strip().lower() == query]
- cursor = (data.get("response_metadata") or {}).get("next_cursor")
- if not cursor:
- break
- if not matches:
- return None, _error(f"Could not resolve Slack user '@{name}'.")
- if len(matches) > 1:
- return None, _error(f"Slack user '@{name}' matched multiple Slack users. Use a Slack user ID instead.")
- chat_id = f"user:{matches[0].get('id')}"
- opened = await post_api("conversations.open", {"users": chat_id[len("user:"):]})
- if not opened.get("ok"):
- return None, _error(f"Slack conversations.open error: {opened.get('error', 'unknown')}. "
- "Check bot permissions (im:write).")
- dm_id = (opened.get("channel") or {}).get("id")
- return (dm_id, None) if dm_id else (None, _error("Slack conversations.open did not return a DM channel ID"))
- except Exception as e:
- return None, _error(f"Slack DM resolution failed: {e}")
- # "ephemeral connect (may re-init E2EE per send, see #46310)",
- async def _send_matrix_via_adapter(pconfig, chat_id, message, media_files=None, thread_id=None):
- """Matrix adapter send (native media preserved). Prefer the live gateway adapter's persistent
- olm/megolm session: ephemeral per-send connects re-init E2EE and claim one-time keys, which
- under bursts exhausts recipient OTKs and silently drops messages — ephemeral is cron-only.
- When a live gateway adapter is available (i.e. the tool runs inside a running gateway), the persistent
- connection is reused — one olm/megolm session for all sends. This avoids per-message E2EE re-init storms
- that exhaust recipient OTKs and silently drop messages (issue #46310).
- """
- media_files = media_files or []
- metadata = {"thread_id": thread_id} if thread_id else None
- from gateway.config import Platform
- _, live_adapter = _live_adapter(Platform.MATRIX, lookup_failed_warning=(
- "Matrix: live gateway adapter lookup failed; falling back to an "
- "ephemeral connect (may re-init E2EE per send)"))
- if live_adapter is not None:
- # Owned by the gateway — must NOT be disconnected (return before the ephemeral ``finally``).
- return await _matrix_send_core(live_adapter, chat_id, message, media_files, metadata)
- try:
- from plugins.platforms.matrix.adapter import MatrixAdapter
- except ImportError:
- return {"error": "Matrix dependencies not installed. Run: "
- f"{install_hint('matrix')}"}
- adapter = MatrixAdapter(pconfig)
- try:
- if not await adapter.connect():
- return _error("Matrix connect failed")
- return await _matrix_send_core(adapter, chat_id, message, media_files, metadata)
- except Exception as e:
- return _error(f"Matrix send failed: {e}")
- finally:
- with contextlib.suppress(Exception):
- await adapter.disconnect()
- async def _matrix_send_core(adapter, chat_id, message, media_files, metadata):
- """Core send logic shared by live and ephemeral Matrix adapters."""
- last_result = None
- if message.strip():
- last_result = await adapter.send(chat_id, message, metadata=metadata)
- if not last_result.success:
- return _error(f"Matrix send failed: {last_result.error}")
- for media_path, is_voice in media_files:
- if not os.path.exists(media_path):
- return _error(f"Media file not found: {media_path}")
- ext = os.path.splitext(media_path)[1].lower()
- method, _ = _adapter_media_method(ext, (ext in _VOICE_EXTS and is_voice) or ext in _AUDIO_EXTS)
- last_result = await getattr(adapter, method)(chat_id, media_path, metadata=metadata)
- if not last_result.success:
- return _error(f"Matrix media send failed: {last_result.error}")
- return {"error": _NO_DELIVERABLE} if last_result is None else _success("matrix", chat_id, message_id=last_result.message_id)
|