mirror of
https://github.com/agessaman/meshcore-bot.git
synced 2026-05-21 06:45:24 +00:00
agessaman
4a0b989f5a
Parse channel:#scope:body in [Scheduled_Messages], pass scope to send_channel_message; extend schedule list and docs.
135 lines
5.0 KiB
Python
135 lines
5.0 KiB
Python
#!/usr/bin/env python3
|
|
"""
|
|
Schedule command for the MeshCore Bot
|
|
Lists upcoming scheduled messages and interval advertising settings.
|
|
"""
|
|
|
|
from typing import Any, Optional
|
|
|
|
from ..models import MeshMessage
|
|
from .base_command import BaseCommand
|
|
|
|
|
|
class ScheduleCommand(BaseCommand):
|
|
"""Show scheduled messages and advertising interval configured for the bot.
|
|
|
|
Responds to ``schedule`` or ``schedule list``. The output is kept compact
|
|
so it fits within typical MeshCore message limits (~200 chars).
|
|
|
|
Config section ``[Schedule_Command]``:
|
|
enabled = true # enable/disable this command
|
|
dm_only = true # restrict to DMs (default true — exposes config)
|
|
"""
|
|
|
|
name = "schedule"
|
|
keywords = ["schedule"]
|
|
description = "List upcoming scheduled messages and advertising interval."
|
|
category = "admin"
|
|
|
|
short_description = "Show scheduled messages and advertising interval"
|
|
usage = "schedule [list]"
|
|
examples = ["schedule", "schedule list"]
|
|
|
|
def __init__(self, bot: Any) -> None:
|
|
super().__init__(bot)
|
|
self._enabled = self.get_config_value(
|
|
"Schedule_Command", "enabled", fallback=True, value_type="bool"
|
|
)
|
|
self._dm_only = self.get_config_value(
|
|
"Schedule_Command", "dm_only", fallback=True, value_type="bool"
|
|
)
|
|
|
|
# ------------------------------------------------------------------
|
|
# BaseCommand interface
|
|
# ------------------------------------------------------------------
|
|
|
|
def can_execute(self, message: MeshMessage, skip_channel_check: bool = False) -> bool:
|
|
if not self._enabled:
|
|
return False
|
|
if self._dm_only and not message.is_dm:
|
|
return False
|
|
return super().can_execute(message)
|
|
|
|
def get_help_text(self) -> str:
|
|
return "schedule [list] — show scheduled messages and advert interval"
|
|
|
|
async def execute(self, message: MeshMessage) -> bool:
|
|
response = self._build_response()
|
|
return await self.send_response(message, response)
|
|
|
|
# ------------------------------------------------------------------
|
|
# Internal helpers
|
|
# ------------------------------------------------------------------
|
|
|
|
def _build_response(self) -> str:
|
|
lines: list[str] = []
|
|
|
|
# --- Scheduled messages ---
|
|
scheduled = self._get_scheduled_messages()
|
|
if scheduled:
|
|
lines.append(f"Scheduled ({len(scheduled)}):")
|
|
for sched_display, channel, preview, scope in scheduled:
|
|
scope_part = f" ({scope})" if scope else ""
|
|
lines.append(f" {sched_display} #{channel}{scope_part}: {preview}")
|
|
else:
|
|
lines.append("No scheduled messages configured.")
|
|
|
|
# --- Interval advertising ---
|
|
advert_info = self._get_advert_info()
|
|
if advert_info:
|
|
lines.append(advert_info)
|
|
|
|
return "\n".join(lines)
|
|
|
|
def _get_scheduled_messages(self) -> list[tuple[str, str, str, str | None]]:
|
|
"""Return sorted list of (schedule_display, channel, preview, scope) tuples."""
|
|
scheduler = getattr(self.bot, "scheduler", None)
|
|
if scheduler is None:
|
|
return []
|
|
|
|
scheduled = getattr(scheduler, "scheduled_messages", {})
|
|
rows: list[tuple[str, str, str, str, str | None]] = []
|
|
for schedule_key, payload in scheduled.items():
|
|
if len(payload) >= 4:
|
|
channel, message, display_label, scope = (
|
|
payload[0],
|
|
payload[1],
|
|
payload[2],
|
|
payload[3],
|
|
)
|
|
elif len(payload) == 3:
|
|
channel, message, display_label = payload
|
|
scope = None
|
|
else:
|
|
channel, message = payload[0], payload[1]
|
|
scope = None
|
|
sk = schedule_key
|
|
display_label = (
|
|
f"{sk[:2]}:{sk[2:]}"
|
|
if len(sk) == 4 and sk.isdigit()
|
|
else sk
|
|
)
|
|
# Truncate long messages so response stays compact
|
|
# Strip control characters that could corrupt the response
|
|
safe_message = "".join(
|
|
c if c.isprintable() or c == " " else "?" for c in message
|
|
)
|
|
preview = (
|
|
safe_message if len(safe_message) <= 40 else safe_message[:37] + "..."
|
|
)
|
|
rows.append((display_label, schedule_key, channel, preview, scope))
|
|
rows.sort(key=lambda r: (r[0].lower(), r[1]))
|
|
return [(r[0], r[2], r[3], r[4]) for r in rows]
|
|
|
|
def _get_advert_info(self) -> Optional[str]:
|
|
"""Return a one-line advert interval summary, or None if disabled."""
|
|
try:
|
|
interval_hours = self.bot.config.getint(
|
|
"Bot", "advert_interval_hours", fallback=0
|
|
)
|
|
if interval_hours > 0:
|
|
return f"Advert interval: every {interval_hours}h"
|
|
except Exception:
|
|
pass
|
|
return None
|