Files
teknium1 9b1990583d refactor(gateway): adapters share helpers.cancel_task / MessageDeduplicator / bounded_put
Six adapters defined their own `_cancel_task` and nine more inlined the same
cancel + suppress(CancelledError) + await block; five kept a hand-rolled TTL-dict
`_is_duplicate` next to the existing `helpers.MessageDeduplicator`; three carried a
`_bounded_put`. Each copy fixed the same bugs on its own schedule (self-cancel deadlock,
done-task re-await, eviction under load).

- `helpers.cancel_task`: None/done no-op, never awaits the current task, swallows the
  task's own exception at teardown. Replaces qqbot/signal/yuanbao/buzz/photon/simplex
  definitions and the inline copies in weixin, discord, email, irc, line, mattermost,
  whatsapp and telegram.
- `helpers.MessageDeduplicator` replaces `_is_duplicate` in qqbot, ntfy, photon,
  wecom_callback and LINE's `_MessageDeduplicator`; every site keeps its own
  max_size/TTL (qqbot and ntfy 1000/300s, photon 4000/48h, wecom_callback 2000/300s,
  LINE 1000/no TTL).
- `helpers.bounded_put` replaces photon/wecom/whatsapp_cloud copies; a re-put now
  refreshes the key to the newest slot at every site.
- telegram gmail-triage scripts resolve under `get_hermes_home()` instead of a hard
  `~/.hermes`, so profiles with HERMES_HOME set find them.

Not changed: `get_chat_info` stays `@abstractmethod` because
tests/gateway/test_relay_capability_surface.py locks the abstract set to exactly
{connect, disconnect, send, get_chat_info} as a cross-repo contract, so the ~17 no-op
overrides remain.

Behavior change: whatsapp_cloud `_bounded_put` was a pure FIFO (no refresh on re-put);
it now refreshes like the other two sites. Task cancellation at the migrated sites
swallows a task's terminal exception where a few copies previously only suppressed
CancelledError (all are shutdown/disconnect paths).
2026-09-13 05:32:38 -07:00

1005 lines
54 KiB
Python

"""Signal messenger platform adapter for a signal-cli daemon in HTTP mode (``signal-cli daemon
--http 127.0.0.1:8080``): inbound via SSE, outbound via JSON-RPC 2.0. Requires SIGNAL_HTTP_URL
and SIGNAL_ACCOUNT."""
import asyncio
import base64
import itertools
import json
import logging
import os
import random
import shutil
import subprocess
import tempfile
import time
import uuid
from collections import OrderedDict
from contextlib import suppress
from datetime import datetime, timezone
from pathlib import Path
from typing import Any, Dict, List, Optional, Tuple
from urllib.parse import quote, unquote
import httpx
from gateway.config import Platform, PlatformConfig
from gateway.platforms.base import (
BasePlatformAdapter, SendResult, cache_image_from_bytes_async,
cache_audio_from_bytes_async, cache_document_from_bytes_async, cache_image_from_url, utf16_len,
)
from gateway.platforms.event import MessageEvent, MessageType, ProcessingOutcome
from gateway.platforms.helpers import redact_phone
from gateway.platforms.helpers import cancel_task
from gateway.platforms.media_cache import mime_for_ext
from tools.audio_container import CONTAINER_TO_EXT, sniff_container
from gateway.platforms.signal_format import markdown_to_signal
from gateway.platforms.signal_rate_limit import (
SIGNAL_BATCH_PACING_NOTICE_THRESHOLD, SIGNAL_MAX_ATTACHMENTS_PER_MSG, SIGNAL_RATE_LIMIT_MAX_ATTEMPTS,
SignalRateLimitError, _extract_retry_after_seconds, _format_wait, _is_signal_rate_limit_error,
_signal_send_timeout, get_scheduler)
from gateway.platforms._shared import get_scoped_secret as _sig_secret
from utils import TRUTHY_STRINGS
logger = logging.getLogger(__name__)
SIGNAL_MAX_ATTACHMENT_SIZE = 100 * 1024 * 1024 # 100 MB
MAX_MESSAGE_LENGTH = 8000 # Signal message size limit
SSE_RETRY_DELAY_INITIAL = 2.0
SSE_RETRY_DELAY_MAX = 60.0
HEALTH_CHECK_INTERVAL = 30.0 # seconds between health checks
HEALTH_CHECK_STALE_THRESHOLD = 120.0 # seconds without SSE activity before concern
# Magic-byte prefixes checked before delegating to the shared audio/AV sniffer.
_MAGIC_EXTENSIONS = ((b"\x89PNG", ".png"), (b"\xff\xd8", ".jpg"), (b"GIF8", ".gif"), (b"%PDF", ".pdf"))
_MEDIA_TYPE_BY_MIME_PREFIX = (
("audio/", MessageType.VOICE), ("image/", MessageType.PHOTO), ("video/", MessageType.VIDEO))
_OUTCOME_REACTION = {ProcessingOutcome.SUCCESS: "✅", ProcessingOutcome.FAILURE: "❌"}
# send_multiple_images skip reasons → logger.warning args (url, detail).
_SKIP_IMAGE_LOG = {
"download": lambda url, detail: ("Signal: failed to download image %s: %s", url, detail),
"missing": lambda url, detail: ("Signal: image file not found for %s", url),
"oversize": lambda url, detail: ("Signal: image too large (%d bytes), skipping %s", detail, url)}
_QUOTE_AUTHOR_KEYS = (
"author", "authorNumber", "authorUuid", "authorAci", "authorServiceId", "authorServiceIdString")
def _parse_comma_list(value: str) -> List[str]:
"""Split a comma-separated string into a list, stripping whitespace."""
return [v.strip() for v in value.split(",") if v.strip()]
def _guess_extension(data: bytes) -> str:
"""Guess file extension from magic bytes. WEBP is claimed before the shared audio/AV sniffer
(it shares RIFF with WAVE); tools/audio_container.py owns MP3-vs-ADTS-AAC disambiguation."""
for magic, ext in _MAGIC_EXTENSIONS:
if data.startswith(magic):
return ext
if len(data) >= 12 and data[:4] == b"RIFF" and data[8:12] == b"WEBP":
return ".webp"
if (container := sniff_container(data)) is not None:
return CONTAINER_TO_EXT[container]
return ".zip" if data[:2] == b"PK" else ".bin"
def _is_image_ext(ext: str) -> bool:
return ext.lower() in {".jpg", ".jpeg", ".png", ".gif", ".webp"}
def _is_audio_ext(ext: str) -> bool:
return ext.lower() in {".mp3", ".wav", ".ogg", ".m4a", ".aac"}
def _ext_to_mime(ext: str) -> str:
"""Map file extension to MIME type (shared table matches Signal's historical map)."""
return mime_for_ext(ext, fallback="application/octet-stream")
def _remux_aac_to_m4a(aac_data: bytes) -> Optional[Tuple[bytes, str]]:
"""Losslessly remux raw ADTS AAC (Android voice notes, rejected by most STT APIs) to .m4a.
Returns ``(m4a_bytes, ".m4a")``, or ``None`` when ffmpeg is missing/fails (caller keeps the input)."""
# Fall back to common Homebrew/local prefixes on macOS dev hosts.
ffmpeg = shutil.which("ffmpeg") or next(
(p for p in ("/opt/homebrew/bin/ffmpeg", "/usr/local/bin/ffmpeg")
if os.path.isfile(p) and os.access(p, os.X_OK)), None)
if not ffmpeg:
logger.debug("Signal: ffmpeg not found, skipping AAC→M4A remux")
return None
try:
with tempfile.NamedTemporaryFile(suffix=".aac", delete=False) as src:
src.write(aac_data)
src_path = src.name
dst_path = src_path[:-4] + ".m4a"
try:
proc = subprocess.run([ffmpeg, "-y", "-loglevel", "error", "-i", src_path, "-c:a", "copy", "-movflags",
"+faststart", dst_path], capture_output=True, timeout=10)
if proc.returncode != 0:
logger.warning("Signal: AAC→M4A remux failed (ffmpeg exit %d): %s",
proc.returncode, proc.stderr.decode("utf-8", "replace")[:300])
return None
with open(dst_path, "rb") as f:
return f.read(), ".m4a"
finally:
for p in (src_path, dst_path):
with suppress(OSError):
os.unlink(p)
except subprocess.TimeoutExpired:
logger.warning("Signal: AAC→M4A remux timed out (>10s)")
return None
except Exception:
logger.exception("Signal: AAC→M4A remux error")
return None
def _render_mentions(text: str, mentions: list) -> str:
"""Replace \\uFFFC mention placeholders with readable @identifiers (from the end so indices hold)."""
if not mentions or "\uFFFC" not in text:
return text
for mention in sorted(mentions, key=lambda m: m.get("start", 0), reverse=True):
start, length = mention.get("start", 0), mention.get("length", 1)
identifier = mention.get("number") or mention.get("uuid") or "user"
text = text[:start] + f"@{identifier}" + text[start + length:]
return text
def _is_signal_service_id(value: str) -> bool:
"""Return True if *value* already looks like a Signal service identifier (PNI:/u: prefix or UUID)."""
if not value:
return False
if value.startswith(("PNI:", "u:")):
return True
with suppress(ValueError, AttributeError, TypeError):
uuid.UUID(value)
return True
return False
def _looks_like_e164_number(value: str) -> bool:
"""Return True for a plausible E.164 phone number."""
return bool(value) and value.startswith("+") and value[1:].isdigit() and 7 <= len(value) - 1 <= 15
def check_signal_requirements() -> bool:
"""Check if Signal runtime dependencies are available."""
return True
def validate_signal_config(config: PlatformConfig) -> bool:
"""Check if Signal has enough config to connect."""
extra = getattr(config, "extra", {}) or {}
http_url = (extra.get("http_url", "") or _sig_secret("SIGNAL_HTTP_URL", "")).strip()
account = (extra.get("account", "") or _sig_secret("SIGNAL_ACCOUNT", "")).strip()
return bool(http_url and account)
class SignalAdapter(BasePlatformAdapter):
"""Signal messenger adapter using signal-cli HTTP daemon."""
platform = Platform.SIGNAL
MAX_MESSAGE_LENGTH = MAX_MESSAGE_LENGTH
splits_long_messages = True # send() chunks after markdown → Signal formatting conversion
# No real edit API; declaring it lets streaming suppress the cursor instead of a stale tofu square.
SUPPORTS_MESSAGE_EDITING = False
def __init__(self, config: PlatformConfig):
super().__init__(config, Platform.SIGNAL)
extra = config.extra or {}
self.http_url = extra.get("http_url", "http://127.0.0.1:8080").rstrip("/")
self.account = extra.get("account", "")
self.ignore_stories = extra.get("ignore_stories", True)
# Allowlists are per-profile (scoped reads); group policy derives from the group allowlist's
# presence. The DM allowlist mirrors run.py's SIGNAL_ALLOWED_USERS so reaction hooks (which
# fire before run.py's auth gate) can skip unauthorized senders; "*" = open.
self.group_allow_from = set(_parse_comma_list(_sig_secret("SIGNAL_GROUP_ALLOWED_USERS", "")))
_rm_cfg = extra.get("require_mention")
self.require_mention = (bool(_rm_cfg) if _rm_cfg is not None
else (_sig_secret("SIGNAL_REQUIRE_MENTION", "false") or "false").lower() in TRUTHY_STRINGS)
self.dm_allow_from = set(_parse_comma_list(_sig_secret("SIGNAL_ALLOWED_USERS", "*")))
self.client: Optional[httpx.AsyncClient] = None
self._sse_task: Optional[asyncio.Task] = None
self._health_monitor_task: Optional[asyncio.Task] = None
self._typing_tasks: Dict[str, asyncio.Task] = {}
# Per-chat typing backoff: on NETWORK_FAILURE base.py's _keep_typing would hammer sendTyping every ~2s.
self._typing_failures: Dict[str, int] = {}
self._typing_skip_until: Dict[str, float] = {}
self._running = False
self._last_sse_activity = 0.0
self._sse_response: Optional[httpx.Response] = None
self._account_normalized = self.account.strip()
# Recently sent timestamps filter echo-backs (Note to Self / linked-device sync-sents); LRU + TTL
# so a pending echo in a chatty group isn't evicted by many outbounds.
self._recent_sent_timestamps: "OrderedDict[int, float]" = OrderedDict()
self._max_recent_timestamps = 512
self._recent_sent_ttl_seconds = 300.0
# Separate FIFO of outbound timestamps: Signal quote.id is the quoted message's timestamp, so
# replies to this bot are recognised after the echo was consumed.
self._sent_message_timestamps: "OrderedDict[str, None]" = OrderedDict()
self._max_sent_message_timestamps = 500
# Best-effort number↔ACI/PNI UUID mapping so sends can upgrade a number to the UUID signal-cli prefers.
self._recipient_uuid_by_number: Dict[str, str] = {}
self._recipient_number_by_uuid: Dict[str, str] = {}
self._recipient_cache_lock = asyncio.Lock()
logger.info("Signal adapter initialized: url=%s account=%s groups=%s", self.http_url,
redact_phone(self.account), "enabled" if self.group_allow_from else "disabled")
async def connect(self, *, is_reconnect: bool = False) -> bool:
"""Connect to signal-cli daemon and start SSE listener."""
if not self.http_url or not self.account:
logger.error("Signal: SIGNAL_HTTP_URL and SIGNAL_ACCOUNT are required")
return False
lock_acquired = False # scoped lock prevents duplicate Signal listeners for the same phone
try:
if not self._acquire_platform_lock('signal-phone', self.account, 'Signal account'):
return False
lock_acquired = True
except Exception as e:
logger.warning("Signal: Could not acquire phone lock (non-fatal): %s", e)
# Tighter keepalive so idle CLOSE_WAIT drains promptly.
# See #18451.
from gateway.platforms._http_client_limits import platform_httpx_limits
self.client = httpx.AsyncClient(timeout=30.0, limits=platform_httpx_limits())
try:
try:
resp = await self.client.get(f"{self.http_url}/api/v1/check", timeout=10.0)
except Exception as e:
logger.error("Signal: cannot reach signal-cli at %s: %s", self.http_url, e)
return False
if resp.status_code != 200:
logger.error("Signal: health check failed (status %d)", resp.status_code)
return False
self._running = True
self._last_sse_activity = time.time()
self._sse_task = asyncio.create_task(self._sse_listener())
self._health_monitor_task = asyncio.create_task(self._health_monitor())
logger.info("Signal: connected to %s", self.http_url)
# Plugin-registered native handlers (ctx.register_platform_handler).
self._wire_plugin_handlers(None)
return True
finally:
if not self._running:
await self._close_client()
if lock_acquired:
self._release_platform_lock()
async def _close_client(self) -> None:
if self.client:
await self.client.aclose()
self.client = None
async def disconnect(self) -> None:
"""Stop SSE listener and clean up."""
self._running = False
for task in (self._sse_task, self._health_monitor_task):
await cancel_task(task)
for task in self._typing_tasks.values():
task.cancel()
self._typing_tasks.clear()
await self._close_client()
self._release_platform_lock()
logger.info("Signal: disconnected")
async def _handle_sse_line(self, line: str) -> None:
"""Dispatch one SSE line; keepalive comments (":") count as activity so the health monitor stays quiet."""
if line.startswith(":"):
self._last_sse_activity = time.time()
elif line.startswith("data:") and (data_str := line[5:].strip()):
self._last_sse_activity = time.time()
try:
await self._handle_envelope(json.loads(data_str))
except json.JSONDecodeError:
logger.debug("Signal SSE: invalid JSON: %s", data_str[:100])
except Exception:
logger.exception("Signal SSE: error handling event")
async def _sse_listener(self) -> None:
"""Listen for SSE events from signal-cli daemon, reconnecting with jittered backoff."""
url = f"{self.http_url}/api/v1/events?account={quote(self.account, safe='')}"
backoff = SSE_RETRY_DELAY_INITIAL
while self._running:
try:
logger.debug("Signal SSE: connecting to %s", url)
async with self.client.stream("GET", url, headers={"Accept": "text/event-stream"},
timeout=None) as response:
self._sse_response = response
backoff = SSE_RETRY_DELAY_INITIAL # Reset on successful connection
self._last_sse_activity = time.time()
logger.info("Signal SSE: connected")
buffer = ""
async for chunk in response.aiter_text():
if not self._running:
break
buffer += chunk
while "\n" in buffer:
line, buffer = buffer.split("\n", 1)
if line := line.strip():
await self._handle_sse_line(line)
except asyncio.CancelledError:
break
except httpx.HTTPError as e:
if self._running:
logger.warning("Signal SSE: HTTP error: %s (reconnecting in %.0fs)", e, backoff)
except Exception as e:
if self._running:
logger.warning("Signal SSE: error: %s (reconnecting in %.0fs)", e, backoff)
if self._running:
await asyncio.sleep(backoff + backoff * 0.2 * random.random()) # 20% jitter vs thundering herd
backoff = min(backoff * 2, SSE_RETRY_DELAY_MAX)
self._sse_response = None
async def _health_monitor(self) -> None:
"""Monitor SSE connection health and force reconnect if stale."""
while self._running:
await asyncio.sleep(HEALTH_CHECK_INTERVAL)
if not self._running:
break
if (elapsed := time.time() - self._last_sse_activity) <= HEALTH_CHECK_STALE_THRESHOLD:
continue
logger.warning("Signal: SSE idle for %.0fs, checking daemon health", elapsed)
try:
resp = await self.client.get(f"{self.http_url}/api/v1/check", timeout=10.0)
except Exception as e:
logger.warning("Signal: health check error: %s, forcing reconnect", e)
self._force_reconnect()
continue
if resp.status_code == 200: # daemon alive but SSE quiet — reset activity to avoid repeated warnings
self._last_sse_activity = time.time()
logger.debug("Signal: daemon healthy, SSE idle")
else:
logger.warning("Signal: health check failed (%d), forcing reconnect", resp.status_code)
self._force_reconnect()
def _force_reconnect(self) -> None:
"""Force SSE reconnection by closing the current response."""
if self._sse_response and not self._sse_response.is_stream_consumed:
with suppress(Exception):
task = asyncio.create_task(self._sse_response.aclose())
self._background_tasks.add(task)
task.add_done_callback(self._background_tasks.discard)
self._sse_response = None
def _unwrap_sync_message(self, envelope_data: dict) -> Optional[dict]:
"""Promote a "Note to Self" / group sync-sent to a dataMessage envelope; None for other
sync events (read receipts, typing, our own outbound echoes)."""
sync_msg = envelope_data.get("syncMessage")
sent_msg = sync_msg.get("sentMessage") if isinstance(sync_msg, dict) else None
if not sent_msg or not isinstance(sent_msg, dict):
return None
dest = sent_msg.get("destinationNumber") or sent_msg.get("destination")
if dest != self._account_normalized and not (sent_msg.get("groupInfo") or {}).get("groupId"):
return None
if self._consume_sent_timestamp(sent_msg.get("timestamp")):
return None # echo of our own outbound reply
return {**envelope_data, "dataMessage": sent_msg}
def _apply_group_mention_rules(self, text: str, data_message: dict) -> Tuple[bool, str]:
"""Gate on require_mention (False = drop) and strip the bot's own @mention from every group
message, so the agent doesn't read "@+155****4567 say hello" as a directive to contact that number."""
account_norm = self._account_normalized
if self.require_mention:
mentioned_in_text = account_norm and (f"@{account_norm}" in (text or ""))
mentioned_in_metadata = any(account_norm in (m.get("number"), m.get("uuid"))
for m in (data_message.get("mentions") or []))
if not mentioned_in_text and not mentioned_in_metadata:
logger.debug("Signal: ignoring group message (require_mention=true, bot not mentioned)")
return False, text
if text and account_norm:
text = text.replace(f"@{account_norm}", "")
if bot_uuid := self._recipient_uuid_by_number.get(account_norm):
text = text.replace(f"@{bot_uuid}", "")
text = text.replace(" ", " ").strip() # collapse only the doubled space; newlines preserved
return True, text
async def _collect_attachments(self, attachments_data: list) -> Tuple[List[str], List[str]]:
"""Fetch + cache inbound attachments; returns (media_urls, media_types)."""
media_urls: List[str] = []
media_types: List[str] = []
for att in attachments_data:
att_id, att_size = att.get("id"), att.get("size", 0)
if not att_id:
continue
if att_size > SIGNAL_MAX_ATTACHMENT_SIZE:
logger.warning("Signal: attachment too large (%d bytes), skipping", att_size)
continue
try:
cached_path, ext = await self._fetch_attachment(att_id)
if cached_path:
media_urls.append(cached_path)
media_types.append(att.get("contentType") or _ext_to_mime(ext))
except Exception:
logger.exception("Signal: failed to fetch attachment %s", att_id)
return media_urls, media_types
async def _handle_envelope(self, envelope: dict) -> None:
"""Process an incoming signal-cli envelope."""
envelope_data = envelope.get("envelope", envelope)
is_note_to_self = "syncMessage" in envelope_data
if is_note_to_self:
envelope_data = self._unwrap_sync_message(envelope_data)
if envelope_data is None:
return
sender = (envelope_data.get("sourceNumber") or envelope_data.get("sourceUuid")
or envelope_data.get("source"))
sender_name = envelope_data.get("sourceName", "")
sender_uuid = envelope_data.get("sourceUuid", "")
self._remember_recipient_identifiers(sender, sender_uuid)
if not sender:
logger.debug("Signal: ignoring envelope with no sender")
return
# Self-message filtering prevents reply loops (Note to Self is allowed)
if self._account_normalized and sender == self._account_normalized and not is_note_to_self:
return
if self.ignore_stories and envelope_data.get("storyMessage"):
return
# Edited messages carry their updated dataMessage inside editMessage
data_message = (envelope_data.get("dataMessage")
or (envelope_data.get("editMessage") or {}).get("dataMessage"))
if not data_message:
return
group_info = data_message.get("groupInfo")
group_id = group_info.get("groupId") if group_info else None
is_group = bool(group_id)
if is_group and not self._group_allowed(group_id):
return
chat_id = f"group:{group_id}" if is_group else sender
text = data_message.get("message", "")
if text and (mentions := data_message.get("mentions", [])):
text = _render_mentions(text, mentions)
if is_group:
mentioned, text = self._apply_group_mention_rules(text, data_message)
if not mentioned:
return
# quote.id is the quoted message's timestamp, quote.author the quoted sender —
# both are preserved so the gateway can tell the agent which message was replied to.
quote_data = data_message.get("quote") or {}
reply_to_id = str(quote_data.get("id")) if quote_data.get("id") else None
reply_to_author = self._extract_quote_author(quote_data)
attachments_data = data_message.get("attachments", [])
media_urls, media_types = [], []
if attachments_data and not getattr(self, "ignore_attachments", False):
media_urls, media_types = await self._collect_attachments(attachments_data)
# Skip contentless envelopes (profile key updates, empty messages) that still carry a
# dataMessage wrapper — otherwise msg='' triggers a full agent turn.
if (not text or not text.strip()) and not media_urls:
logger.debug("Signal: skipping contentless envelope from %s (%d attachments)", redact_phone(sender),
len(media_urls) if media_urls else 0)
return
source = self.build_source(
chat_id=chat_id, chat_name=group_info.get("groupName") if group_info else sender_name,
chat_type="group" if is_group else "dm", user_id=sender,
user_name=sender_name or sender, user_id_alt=sender_uuid if sender_uuid else None,
chat_id_alt=group_id if is_group else None)
# First matching MIME prefix wins; everything else (application/*, text/*, unknown) is a DOCUMENT
# so run.py's document-context injection surfaces the cached path.
msg_type = MessageType.TEXT if not media_types else next(
(mt for prefix, mt in _MEDIA_TYPE_BY_MIME_PREFIX if any(m.startswith(prefix) for m in media_types)),
MessageType.DOCUMENT)
ts_ms = envelope_data.get("timestamp", 0) # milliseconds since epoch
timestamp = datetime.now(tz=timezone.utc)
if ts_ms:
with suppress(ValueError, OSError):
timestamp = datetime.fromtimestamp(ts_ms / 1000, tz=timezone.utc)
# raw_message keeps sender + timestamp_ms so processing hooks can build sendReaction targets.
event = MessageEvent(
source=source, text=text or "", message_type=msg_type, media_urls=media_urls,
media_types=media_types, timestamp=timestamp,
raw_message={"sender": sender, "timestamp_ms": ts_ms, "quote": quote_data if quote_data else None},
reply_to_message_id=reply_to_id, reply_to_text=quote_data.get("text"),
reply_to_author_id=reply_to_author,
reply_to_author_name=quote_data.get("authorName") or quote_data.get("authorProfileName"),
reply_to_is_own_message=self._quote_references_own_message(reply_to_id, reply_to_author),
)
logger.debug("Signal: message from %s in %s: %s", redact_phone(sender), chat_id[:20], (text or "")[:50])
await self.handle_message(event)
def _group_allowed(self, group_id: str) -> bool:
"""Group policy from SIGNAL_GROUP_ALLOWED_USERS: unset → groups disabled; IDs → only those
groups; "*" → all. DM auth is run.py's (_is_user_authorized)."""
if not self.group_allow_from:
logger.debug("Signal: ignoring group message (no SIGNAL_GROUP_ALLOWED_USERS)")
return False
if "*" not in self.group_allow_from and group_id not in self.group_allow_from:
logger.debug("Signal: group %s not in allowlist", group_id[:8] if group_id else "?")
return False
return True
def _remember_recipient_identifiers(self, number: Optional[str], service_id: Optional[str]) -> None:
"""Cache any number↔UUID mapping observed from Signal envelopes."""
if number and service_id and _is_signal_service_id(service_id):
self._recipient_uuid_by_number[number] = service_id
self._recipient_number_by_uuid[service_id] = number
@staticmethod
def _extract_quote_author(quote_data: Any) -> Optional[str]:
"""Return the best available Signal sender identifier from quote metadata."""
keys = _QUOTE_AUTHOR_KEYS if isinstance(quote_data, dict) else ()
return next((str(quote_data[k]) for k in keys if quote_data.get(k)), None)
def _quote_references_own_message(self, reply_to_id: Optional[str], reply_to_author: Optional[str]) -> bool:
"""True when a Signal quote points at this adapter's outbound message."""
if reply_to_id and str(reply_to_id) in self._sent_message_timestamps:
return True
if not reply_to_author:
return False
author, acct = str(reply_to_author).strip(), self._account_normalized
# Cached number↔UUID mappings are only ever stored with truthy keys and values.
return bool(acct) and (author == acct or author == self._recipient_uuid_by_number.get(acct)
or self._recipient_number_by_uuid.get(author) == acct)
def _remember_sent_message_timestamp(self, timestamp: Any) -> None:
"""Keep a bounded cache of outbound Signal timestamps for quote matching."""
if timestamp is None:
return
key = str(timestamp)
self._sent_message_timestamps.pop(key, None) # re-insert as most-recently-used so eviction drops old ones
self._sent_message_timestamps[key] = None
while len(self._sent_message_timestamps) > self._max_sent_message_timestamps:
self._sent_message_timestamps.popitem(last=False)
def _extract_contact_uuid(self, contact: Any, phone_number: str) -> Optional[str]:
"""Best-effort extraction of a Signal service ID from listContacts output."""
if not isinstance(contact, dict):
return None
service_id = contact.get("uuid") or contact.get("serviceId")
profile = contact.get("profile")
if not service_id and isinstance(profile, dict):
service_id = profile.get("serviceId") or profile.get("uuid")
if service_id and _is_signal_service_id(service_id) and phone_number in (
contact.get("number"), contact.get("recipient")):
return service_id
return None
async def _resolve_recipient(self, chat_id: str) -> str:
"""Return the preferred Signal recipient identifier for a direct chat."""
if not chat_id or chat_id.startswith("group:") or not _looks_like_e164_number(chat_id):
return chat_id
if cached := self._recipient_uuid_by_number.get(chat_id):
return cached
async with self._recipient_cache_lock:
if cached := self._recipient_uuid_by_number.get(chat_id):
return cached
contacts = await self._rpc("listContacts", {"account": self.account, "allRecipients": True})
for contact in contacts if isinstance(contacts, list) else ():
number = contact.get("number") if isinstance(contact, dict) else None
service_id = self._extract_contact_uuid(contact, chat_id)
if number and service_id:
self._remember_recipient_identifiers(number, service_id)
return self._recipient_uuid_by_number.get(chat_id, chat_id)
async def _with_target(self, params: Dict[str, Any], chat_id: str, *, resolve: bool = True) -> Dict[str, Any]:
"""Add the groupId / recipient routing key for *chat_id* to *params* (in place)."""
if chat_id.startswith("group:"):
params["groupId"] = chat_id[6:]
else:
params["recipient"] = [await self._resolve_recipient(chat_id) if resolve else chat_id]
return params
async def _fetch_attachment(self, attachment_id: str) -> tuple:
"""Fetch an attachment via JSON-RPC and cache it. Returns (path, ext)."""
result = await self._rpc("getAttachment", {"account": self.account, "id": attachment_id})
if not result:
return None, ""
if isinstance(result, dict): # signal-cli returns {"data": "base64..."}
result = result.get("data")
if not result:
logger.warning("Signal: attachment response missing 'data' key")
return None, ""
raw_data = base64.b64decode(result)
ext = _guess_extension(raw_data)
# Android voice notes are raw ADTS AAC, which Whisper-style STT rejects; remux losslessly
# to .m4a. Without ffmpeg the raw file is cached as-is (no downstream remux fallback).
if ext == ".aac":
raw_data, ext = (await asyncio.to_thread(_remux_aac_to_m4a, raw_data)) or (raw_data, ext)
cache = (cache_image_from_bytes_async if _is_image_ext(ext)
else cache_audio_from_bytes_async if _is_audio_ext(ext) else cache_document_from_bytes_async)
return await cache(raw_data, ext), ext
async def _rpc(self, method: str, params: dict, rpc_id: str = None, *, log_failures: bool = True,
raise_on_rate_limit: bool = False, timeout: float = 30.0) -> Any:
"""Send a JSON-RPC 2.0 request to signal-cli. ``log_failures=False`` logs failures at DEBUG (typing
path: silence NETWORK_FAILURE spam); ``raise_on_rate_limit=True`` raises ``SignalRateLimitError``
on a 429 / RateLimitException instead of swallowing it."""
if not self.client:
logger.warning("Signal: RPC called but client not connected")
return None
payload = {"jsonrpc": "2.0", "method": method, "params": params,
"id": rpc_id if rpc_id is not None else f"{method}_{int(time.time() * 1000)}"}
fail_level = logging.WARNING if log_failures else logging.DEBUG
try:
resp = await self.client.post(f"{self.http_url}/api/v1/rpc", json=payload, timeout=timeout)
resp.raise_for_status()
data = resp.json()
if "error" in data:
err = data["error"]
if raise_on_rate_limit and _is_signal_rate_limit_error(err):
err_msg = str(err.get("message", "")) if isinstance(err, dict) else str(err)
raise SignalRateLimitError(err_msg, retry_after=_extract_retry_after_seconds(err))
logger.log(fail_level, "Signal RPC error (%s): %s", method, err)
return None
result = data.get("result")
if isinstance(result, dict) and raise_on_rate_limit:
for r in result.get("results") if isinstance(result.get("results"), list) else ():
if isinstance(r, dict) and r.get("type") == "RATE_LIMIT_FAILURE":
raise SignalRateLimitError("Rate limit exceeded for recipient",
retry_after=r.get("retryAfterSeconds"))
return result
except SignalRateLimitError:
raise
except Exception as e:
logger.log(fail_level, "Signal RPC %s failed: %s", method, e)
return None
def format_message(self, content: str) -> str:
"""Plain-text fallback for the base-class send path; send() applies rich styles itself."""
return content
def _validate_send_result(self, result: Any) -> tuple[bool, Optional[str]]:
"""Validate signal-cli send response results. Returns (success, error_message)."""
results = result.get("results") if isinstance(result, dict) else None
for r in results if isinstance(results, list) else ():
if not isinstance(r, dict):
continue
rtype = r.get("type")
if rtype and rtype != "SUCCESS":
return False, str(rtype)
if "success" in r and not r.get("success"):
return False, str(r.get("failure") or "Recipient delivery failed")
return True, None
@staticmethod
def _utf16_offsets(text: str) -> list[int]:
"""Return cumulative UTF-16 offsets for every Python character boundary."""
return [0, *itertools.accumulate(utf16_len(char) for char in text)]
@staticmethod
def _styles_for_chunk(text_styles: list[str], chunk_start: int, chunk_end: int) -> list[str]:
"""Translate full-message Signal styles into a chunk-local range list."""
adjusted: list[str] = []
for style_string in text_styles:
try:
start_s, length_s, style_type = style_string.split(":", 2)
style_start, style_end = int(start_s), int(start_s) + int(length_s)
except (TypeError, ValueError):
logger.debug("[Signal] Ignoring malformed textStyle range: %r", style_string)
continue
overlap_start, overlap_end = max(style_start, chunk_start), min(style_end, chunk_end)
if overlap_start < overlap_end:
adjusted.append(f"{overlap_start - chunk_start}:{overlap_end - overlap_start}:{style_type}")
return adjusted
@classmethod
def _split_signal_formatted_message(
cls, plain_text: str, text_styles: list[str], max_length: int) -> list[tuple[str, list[str]]]:
"""Split converted Signal text into chunks, translating body ranges per chunk. Splitting after
conversion keeps styles that cross a chunk boundary intact instead of leaking Markdown markers."""
if utf16_len(plain_text) <= max_length:
return [(plain_text, text_styles)]
body_limit = max(1, max_length - 10) # 10 = indicator reserve, mirrors truncate_message().
offsets = cls._utf16_offsets(plain_text)
chunks: list[tuple[str, list[str]]] = []
start_idx, total_u16 = 0, offsets[-1]
while offsets[start_idx] < total_u16:
end_budget = min(total_u16, offsets[start_idx] + body_limit)
end_idx = start_idx + 1
while end_idx < len(offsets) and offsets[end_idx] <= end_budget:
end_idx += 1
end_idx = max(end_idx - 1, start_idx + 1)
chunk_styles = cls._styles_for_chunk(text_styles, offsets[start_idx], offsets[end_idx])
chunks.append((plain_text[start_idx:end_idx], chunk_styles))
start_idx = end_idx
if len(chunks) == 1:
return chunks
return [(f"{txt} ({idx}/{len(chunks)})", st) for idx, (txt, st) in enumerate(chunks, start=1)]
async def _rpc_send(self, params: Dict[str, Any], fail_error: str) -> Tuple[Any, Optional[SendResult]]:
"""Run a ``send`` RPC, validate and track it; ``(result, None)`` or ``(None, failed SendResult)``."""
if (result := await self._rpc("send", params)) is None:
return None, SendResult(success=False, error=fail_error)
success, err_msg = self._validate_send_result(result)
if not success:
return None, SendResult(success=False, error=err_msg, raw_response=result)
self._track_sent_timestamp(result)
return result, None
async def send(self, chat_id: str, content: str, reply_to: Optional[str] = None,
metadata: Optional[Dict[str, Any]] = None) -> SendResult:
"""Send a text message with native Signal formatting."""
await self._stop_typing_indicator(chat_id)
if not content or not content.strip():
return SendResult(success=True, message_id=None)
base_params = await self._with_target({"account": self.account}, chat_id)
chunks = self._split_signal_formatted_message(*markdown_to_signal(content), self.MAX_MESSAGE_LENGTH)
last_result = None
for idx, (plain_text, text_styles) in enumerate(chunks, start=1):
params: Dict[str, Any] = dict(base_params, message=plain_text)
if len(text_styles) == 1:
params["textStyle"] = text_styles[0]
elif text_styles:
params["textStyles"] = text_styles
logger.info("[Signal] Sending response chunk %d/%d (%d chars) to %s", idx, len(chunks), len(plain_text),
chat_id)
last_result, err = await self._rpc_send(params, "RPC send failed")
if err:
return err
# No editable message identifier; message_id=None keeps the stream consumer on the non-edit path.
return SendResult(success=True, message_id=None, raw_response=last_result)
def _track_sent_timestamp(self, rpc_result) -> None:
"""Record outbound message timestamp for echo-back filtering."""
ts = rpc_result.get("timestamp") if isinstance(rpc_result, dict) else None
if not ts:
return
self._remember_sent_message_timestamp(ts)
now, recent = time.monotonic(), self._recent_sent_timestamps
recent.pop(ts, None) # re-insert to mark as most-recently-used
recent[ts] = now
# Drop entries older than TTL first, then enforce the hard cap.
cutoff = now - self._recent_sent_ttl_seconds
while recent and next(iter(recent.values())) < cutoff:
recent.popitem(last=False)
while len(recent) > self._max_recent_timestamps:
recent.popitem(last=False)
def _consume_sent_timestamp(self, ts) -> bool:
"""Pop a timestamp if it matches one we sent. Returns True on echo."""
return bool(ts) and self._recent_sent_timestamps.pop(ts, None) is not None
async def send_typing(self, chat_id: str, metadata=None) -> None:
"""Typing indicator (called every ~2s by base.py's ``_keep_typing``). Only the first consecutive
failure logs at WARNING; after three, the RPC is skipped for an exponential cooldown; success resets."""
now = time.monotonic()
if now < self._typing_skip_until.get(chat_id, 0.0):
return
params = await self._with_target({"account": self.account}, chat_id)
fails = self._typing_failures.get(chat_id, 0)
if await self._rpc("sendTyping", params, rpc_id="typing", log_failures=(fails == 0)) is not None:
self._typing_failures.pop(chat_id, None)
self._typing_skip_until.pop(chat_id, None)
return
fails = self._typing_failures[chat_id] = fails + 1
if fails >= 3: # exponential backoff: 16s, 32s, 60s cap
self._typing_skip_until[chat_id] = now + min(60.0, 16.0 * (2 ** (fails - 3)))
async def _resolve_image_path(self, image_url: str) -> Tuple[Optional[str], Optional[str], Any]:
"""``(path, None, None)`` or ``(None, reason, detail)``: reason download (exc) / missing / oversize (size)."""
if image_url.startswith("file://"):
file_path = unquote(image_url[7:])
else:
try:
file_path = await cache_image_from_url(image_url)
except Exception as e:
return None, "download", e
if not file_path or not Path(file_path).exists():
return None, "missing", None
if (file_size := Path(file_path).stat().st_size) > SIGNAL_MAX_ATTACHMENT_SIZE:
return None, "oversize", file_size
return file_path, None, None
async def send_multiple_images(self, chat_id: str, images: List[Tuple[str, str]],
metadata: Optional[Dict[str, Any]] = None, human_delay: float = 0.0) -> SendResult:
"""Send a batch of images via chunked Signal RPC calls. Alt texts are dropped (one shared body
per send); bad images are skipped with a warning; ``human_delay`` is ignored (scheduler paces).
Returns success when at least one batch was accepted, so media-only turns report SUCCESS."""
if not images:
return SendResult(success=False, error="no images to send")
scheduler = get_scheduler()
logger.info("Signal send_multiple_images: received %d image(s) for %s — scheduler state: %s", len(images),
chat_id[:30], scheduler.state())
await self._stop_typing_indicator(chat_id)
attachments: List[str] = []
skipped = {"download": 0, "missing": 0, "oversize": 0}
for image_url, _alt_text in images:
file_path, reason, detail = await self._resolve_image_path(image_url)
if not reason:
attachments.append(file_path)
continue
skipped[reason] += 1
logger.warning(*_SKIP_IMAGE_LOG[reason](image_url, detail))
if not attachments:
logger.error("Signal: no valid images in batch of %d (download=%d missing=%d oversize=%d)", len(images),
skipped["download"], skipped["missing"], skipped["oversize"])
return SendResult(success=False, error="no valid images in batch")
logger.info("Signal send_multiple_images: %d/%d images valid, sending in chunks", len(attachments), len(images))
base_params = await self._with_target({"account": self.account, "message": ""}, chat_id)
per = SIGNAL_MAX_ATTACHMENTS_PER_MSG
att_batches = [attachments[i:i + per] for i in range(0, len(attachments), per)]
n_batches = len(att_batches)
delivered = False
for idx, att_batch in enumerate(att_batches, start=1):
n = len(att_batch)
estimated = scheduler.estimate_wait(n)
logger.debug("Signal batch %d/%d: %d attachments, estimated wait=%.1fs", idx, n_batches, n, estimated)
if estimated >= SIGNAL_BATCH_PACING_NOTICE_THRESHOLD:
await self._notify_batch_pacing(chat_id, idx, n_batches, estimated)
if await self._send_attachment_batch(scheduler, dict(base_params, attachments=att_batch), n,
f"{idx}/{n_batches}"):
delivered = True
return SendResult(
success=delivered,
error=None if delivered else "all Signal attachment batches failed")
async def _send_attachment_batch(self, scheduler, params: Dict[str, Any], n: int, label: str) -> bool:
"""Send one attachment batch with rate-limit pacing and a single transient retry. Tokens are
deducted only on validated success (None = server never accepted it); 429s feed the scheduler.
Returns True when the server accepted the batch."""
send_timeout, max_attempts = _signal_send_timeout(n), SIGNAL_RATE_LIMIT_MAX_ATTEMPTS
for attempt in range(1, max_attempts + 1):
await scheduler.acquire(n)
t0 = time.monotonic()
try:
result = await self._rpc("send", params, raise_on_rate_limit=True, timeout=send_timeout)
except SignalRateLimitError as e:
scheduler.feedback(e.retry_after, n)
retry_after = f"{e.retry_after:.0f}s" if e.retry_after else "unknown"
if attempt >= max_attempts:
logger.error("Signal: rate-limit retries exhausted on batch %s (%d attachments lost, "
"server retry_after=%s)", label, n, retry_after)
return False
logger.warning("Signal: rate-limited on batch %s (attempt %d/%d, server retry_after=%s); "
"scheduler will pace the retry", label, attempt, max_attempts, retry_after)
continue
duration = time.monotonic() - t0
success, err_msg = self._validate_send_result(result) if result is not None else (False, None)
if success:
self._track_sent_timestamp(result)
await scheduler.report_rpc_duration(duration, n)
logger.info("Signal batch %s: %d attachments sent in %.1fs (attempt %d/%d)", label, n, duration,
attempt, max_attempts)
return True
logger.error("Signal: RPC send failed for batch %s (%d attachments, attempt %d/%d, rpc_duration=%.1fs)%s",
label, n, attempt, max_attempts, duration, f": {err_msg}" if result is not None else "")
if attempt >= max_attempts:
return False
logger.info("Signal: retrying batch %s after %.1fs backoff", label, 2.0 ** attempt)
await asyncio.sleep(2.0 ** attempt)
return False
async def _notify_batch_pacing(self, chat_id: str, next_batch_idx: int, total_batches: int, wait_s: float) -> None:
"""Tell the user about an inter-batch pacing wait over the notice threshold (best-effort)."""
try:
await self.send(chat_id, f"(More images coming — pausing ~{_format_wait(wait_s)} for Signal rate limit, "
f"batch {next_batch_idx}/{total_batches}.)")
except Exception as e:
logger.warning("Signal: failed to send pacing notice: %s", e)
async def send_image(self, chat_id: str, image_url: str, caption: Optional[str] = None, **kwargs) -> SendResult:
"""Send an image. Supports http(s):// and file:// URLs."""
await self._stop_typing_indicator(chat_id)
file_path, reason, detail = await self._resolve_image_path(image_url)
if reason == "download":
logger.warning("Signal: failed to download image: %s", detail)
if reason:
return SendResult(success=False, error={
"download": str(detail), "missing": "Image file not found",
"oversize": f"Image too large ({detail} bytes)"}[reason])
return await self._send_file(chat_id, file_path, caption, "RPC send with attachment failed")
async def _send_file(self, chat_id: str, file_path: str, caption: Optional[str], fail_error: str) -> SendResult:
"""Send one local file as a Signal attachment via the ``send`` RPC."""
params = await self._with_target(
{"account": self.account, "message": caption or "", "attachments": [file_path]}, chat_id)
_, err = await self._rpc_send(params, fail_error)
return err or SendResult(success=True)
async def _send_attachment(self, chat_id: str, file_path: str, media_label: str,
caption: Optional[str] = None) -> SendResult:
"""Send any local file as a Signal attachment (shared by send_document/image_file/voice/video)."""
await self._stop_typing_indicator(chat_id)
try:
file_size = Path(file_path).stat().st_size
except FileNotFoundError:
return SendResult(success=False, error=f"{media_label} file not found: {file_path}")
if file_size > SIGNAL_MAX_ATTACHMENT_SIZE:
return SendResult(success=False, error=f"{media_label} too large ({file_size} bytes)")
return await self._send_file(chat_id, file_path, caption, f"RPC send {media_label.lower()} failed")
async def send_document(self, chat_id, file_path, caption=None, filename=None, **kwargs) -> SendResult:
return await self._send_attachment(chat_id, file_path, "File", caption)
async def send_image_file(self, chat_id, image_path, caption=None, reply_to=None, **kwargs) -> SendResult:
"""Native Signal attachment for the gateway MEDIA: delivery path."""
return await self._send_attachment(chat_id, image_path, "Image", caption)
async def send_voice(self, chat_id, audio_path, caption=None, reply_to=None, **kwargs) -> SendResult:
"""Audio attachment — Signal has no distinct voice-message API."""
return await self._send_attachment(chat_id, audio_path, "Audio", caption)
async def send_video(self, chat_id, video_path, caption=None, reply_to=None, **kwargs) -> SendResult:
return await self._send_attachment(chat_id, video_path, "Video", caption)
async def _stop_typing_indicator(self, chat_id: str) -> None:
"""Stop a typing indicator loop for a chat."""
await cancel_task(self._typing_tasks.pop(chat_id, None))
# Explicit stop-typing RPC so the recipient drops the indicator now instead of after
# Signal's ~5s timeout. Best-effort: failures must not prevent the backoff cleanup below.
with suppress(Exception):
params = await self._with_target({"account": self.account}, chat_id)
params["stop"] = True
await self._rpc("sendTyping", params, rpc_id="typing-stop", log_failures=False)
self._typing_failures.pop(chat_id, None)
self._typing_skip_until.pop(chat_id, None)
async def stop_typing(self, chat_id: str) -> None:
"""Public stop-typing hook called from the base adapter's _keep_typing finally block."""
await self._stop_typing_indicator(chat_id)
async def _send_reaction_rpc(self, chat_id: str, params: Dict[str, Any]) -> bool:
"""Route a ``sendReaction`` RPC to *chat_id* (no UUID upgrade — author IDs come from the envelope)."""
await self._with_target(params, chat_id, resolve=False)
return await self._rpc("sendReaction", params) is not None
async def send_reaction(self, chat_id: str, emoji: str, target_author: str, target_timestamp: int) -> bool:
"""React to the message (author number/UUID, Signal ms timestamp) via signal-cli RPC."""
ok = await self._send_reaction_rpc(chat_id, {
"account": self.account, "emoji": emoji, "targetAuthor": target_author,
"targetTimestamp": target_timestamp})
if not ok:
logger.debug("Signal: sendReaction failed (chat=%s, emoji=%s)", chat_id[:20], emoji)
return ok
async def remove_reaction(self, chat_id: str, target_author: str, target_timestamp: int) -> bool:
"""Remove a reaction by sending an empty-string emoji."""
return await self._send_reaction_rpc(chat_id, {
"account": self.account, "emoji": "", "targetAuthor": target_author, "targetTimestamp": target_timestamp,
"remove": True})
def _extract_reaction_target(self, event: MessageEvent) -> Optional[tuple]:
"""Extract (target_author, target_timestamp) from a MessageEvent, or None."""
raw = event.raw_message
ok = isinstance(raw, dict) and raw.get("sender") and raw.get("timestamp_ms")
return (raw["sender"], raw["timestamp_ms"]) if ok else None
def _reactions_enabled(self, event: "MessageEvent" = None) -> bool:
"""SIGNAL_REACTIONS env gate, then the DM allowlist: reactions fire before run.py's auth gate,
so an unauthorized contact's 👀 would otherwise reveal a listening bot."""
if str(_sig_secret("SIGNAL_REACTIONS", "true")).lower() in {"false", "0", "no"}:
return False
sender = getattr(getattr(event, "source", None), "user_id", None) if event is not None else None
return not (sender and "*" not in self.dm_allow_from and sender not in self.dm_allow_from)
async def on_processing_start(self, event: MessageEvent) -> None:
"""React with 👀 when processing begins."""
if self._reactions_enabled(event) and (target := self._extract_reaction_target(event)):
await self.send_reaction(event.source.chat_id, "👀", *target)
async def on_processing_complete(self, event: MessageEvent, outcome: "ProcessingOutcome") -> None:
"""Swap 👀 for ✅/❌; on CANCELLED the 👀 stays to keep reflecting "in progress" (matches Telegram)."""
if outcome == ProcessingOutcome.CANCELLED or not self._reactions_enabled(event):
return
if not (target := self._extract_reaction_target(event)):
return
await self.remove_reaction(event.source.chat_id, *target)
if emoji := _OUTCOME_REACTION.get(outcome):
await self.send_reaction(event.source.chat_id, emoji, *target)
async def get_chat_info(self, chat_id: str) -> Dict[str, Any]:
"""Get information about a chat/contact."""
if chat_id.startswith("group:"):
return {"name": chat_id, "type": "group", "chat_id": chat_id}
result = await self._rpc("getContact", {"account": self.account, "contactAddress": chat_id})
name = (result.get("name") or result.get("profileName")) if isinstance(result, dict) else None
return {"name": name or chat_id, "type": "dm", "chat_id": chat_id}
# ---- BEGIN PLUGIN-COMPAT (revert-scheduled; see COMPAT_MANIFEST.md) ----
# Names external plugins imported from this module before the Sep 2026 decomposition.
# Internal code MUST NOT use these (scripts/check_compat_pointers.py fails CI if it does).
# The whole block is removed by reverting the commit that added it.
TYPING_INTERVAL = 8.0 # seconds between typing indicator refreshes
_PLUGIN_COMPAT_LAZY = {
'DEFAULT_EXT_TO_MIME': ('gateway.platforms.media_cache', 'DEFAULT_EXT_TO_MIME'),
}
def __getattr__(name): # PEP 562 — lazy so no import cycles
target = _PLUGIN_COMPAT_LAZY.get(name)
if target is None:
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
import importlib
from hermes_cli.plugin_compat import warn_once
warn_once(__name__, name, *target)
return getattr(importlib.import_module(target[0]), target[1])
# ---- END PLUGIN-COMPAT ----