mirror of
https://github.com/agessaman/meshcore-bot.git
synced 2026-09-02 09:03:58 +00:00
agessaman
b0148506a6
A scheduled message can now embed the reply of any bot command:
[Scheduled_Messages]
0 6,12,18 * * * = Public:{cmd:wx Seattle}
The schedule side was never the missing piece — [Scheduled_Messages]
keys have been 5-field cron with @presets for a while, so multiple
times, intervals and @hourly were all already expressible. What was
missing was any way to get a service's output into a scheduled message:
placeholders were limited to mesh info (contact counts). That gap is
why services were growing their own schedule parsers.
CommandManager.render_command_output runs a command for its text alone.
MeshMessage.capture_sink makes that safe: when set, send_response
collects the reply and transmits nothing, checked before the
_last_response bookkeeping so a background render cannot overwrite the
response captured for a real user's command.
Degrades quietly in every failure mode — unknown, disabled, admin-only,
non-renderable, timed out or silent commands expand to nothing, so raw
{cmd:...} text is never put on the air, and a message left empty is not
sent at all. Command output is not re-scanned, so a reply containing
{cmd:...} cannot recurse. Commands that transmit directly rather than
returning text (announcements) are refused outright, since rendering
them would broadcast for real.
Bounded by [Bot] scheduled_command_timeout_seconds (default 30).
75 lines
3.3 KiB
Python
75 lines
3.3 KiB
Python
#!/usr/bin/env python3
|
|
"""
|
|
Data models for the MeshCore Bot
|
|
Contains shared data structures used across modules
|
|
"""
|
|
|
|
from dataclasses import dataclass
|
|
from typing import Any, Optional
|
|
|
|
# Firmware reserves extra bytes for regional (non-global) TC_FLOOD scope on channel text.
|
|
CHANNEL_REGIONAL_FLOOD_SCOPE_BODY_OVERHEAD = 10
|
|
|
|
|
|
@dataclass
|
|
class MeshMessage:
|
|
"""Simplified message structure for our bot"""
|
|
content: str
|
|
sender_id: Optional[str] = None
|
|
sender_pubkey: Optional[str] = None
|
|
channel: Optional[str] = None
|
|
hops: Optional[int] = None
|
|
path: Optional[str] = None
|
|
is_dm: bool = False
|
|
timestamp: Optional[int] = None
|
|
snr: Optional[float] = None
|
|
rssi: Optional[int] = None
|
|
elapsed: Optional[str] = None
|
|
# When set from RF routing: path_nodes, path_hex, bytes_per_hop, path_length, route_type, etc.
|
|
routing_info: Optional[dict[str, Any]] = None
|
|
# Matched flood scope for the reply (e.g. "#west"), None means global flood
|
|
reply_scope: Optional[str] = None
|
|
# Lowercased content set by base_command.cleanup_message_for_matching
|
|
content_lower: str = ""
|
|
# Transient flag: True once CommandManager.check_keywords has stripped the
|
|
# configured command prefix (and legacy "!") from content. Prevents per-command
|
|
# cleanup_message_for_matching from re-stripping/re-rejecting an already-normalized
|
|
# message, which previously broke matching for all-but-the-first command.
|
|
prefix_normalized: bool = False
|
|
# Transient: when not None, CommandManager.send_response appends the reply here
|
|
# and transmits nothing. Set by CommandManager.render_command_output so a command
|
|
# can be run for its text alone (e.g. a {cmd:...} placeholder in a scheduled
|
|
# message) without spending airtime. A synthetic message only.
|
|
capture_sink: Optional[list[str]] = None
|
|
|
|
def effective_outgoing_flood_scope(self, bot: Any) -> str:
|
|
"""Resolve outbound flood scope the same way as ``CommandManager.send_channel_message``.
|
|
|
|
For channel replies: ``reply_scope`` when set, else per-channel
|
|
``[Channels] flood_scope.<channel>``, else ``[Channels] outgoing_flood_scope_override``.
|
|
Empty string means global flood. DMs return ``""`` (not applicable).
|
|
"""
|
|
if self.is_dm:
|
|
return ""
|
|
if self.reply_scope is not None:
|
|
return (self.reply_scope or "").strip()
|
|
if self.channel and bot.config.has_section("Channels"):
|
|
channel_key = self.channel.strip().removeprefix("#").lower()
|
|
for key, value in bot.config.items("Channels"):
|
|
if not key.startswith("flood_scope."):
|
|
continue
|
|
configured_channel = key[len("flood_scope."):].strip().removeprefix("#").lower()
|
|
if configured_channel == channel_key:
|
|
return (value or "").strip()
|
|
scope_cfg = ""
|
|
if bot.config.has_section("Channels") and bot.config.has_option(
|
|
"Channels", "outgoing_flood_scope_override"
|
|
):
|
|
scope_cfg = (bot.config.get("Channels", "outgoing_flood_scope_override") or "").strip()
|
|
return scope_cfg
|
|
|
|
@staticmethod
|
|
def is_global_flood_scope(scope: str) -> bool:
|
|
"""Match ``send_channel_message`` global markers (before ``_normalize_scope_name``)."""
|
|
return scope in ("", "*", "0", "None") or scope.lower() == "none"
|