mirror of
https://github.com/agessaman/meshcore-bot.git
synced 2026-11-01 18:42:56 +00:00
agessaman
7aba432b54
S4. BaseCommand and the 40 bundled overrides that took no argument now take `message: MeshMessage | None = None`, matching joke and rain, which already use the message. None of the 40 bodies read it, so their help text is unchanged. help and command_manager keep their TypeError retry, since local plugins may still implement get_help_text(self). For bundled commands the retry no longer runs: `help <command>` calls get_help_text(message) once instead of failing and calling it again. A new test pins the signature for every bundled command class. The offline smoke run against the real config produces the same help text for all 46 commands.
104 lines
3.3 KiB
Python
104 lines
3.3 KiB
Python
#!/usr/bin/env python3
|
|
"""
|
|
Contact command for the MeshCore Bot
|
|
Adds the bot contact info to the current channel
|
|
"""
|
|
|
|
import re
|
|
from typing import Any, Optional
|
|
|
|
from modules.commands.base_command import BaseCommand
|
|
from modules.models import MeshMessage
|
|
|
|
PUBLIC_KEY_RE = re.compile(r'^[0-9a-fA-F]{64}$')
|
|
|
|
|
|
class ContactCommand(BaseCommand):
|
|
"""Handles contact command"""
|
|
|
|
# Plugin metadata
|
|
name = "contact"
|
|
enabled_attr = "enabled"
|
|
keywords = ['contact']
|
|
description = "Display the bot's contact information"
|
|
category = "basic"
|
|
|
|
# Documentation
|
|
short_description = "Display the bot's contact information"
|
|
usage = "contact"
|
|
examples = [
|
|
"contact"
|
|
]
|
|
|
|
def __init__(self, bot):
|
|
"""Initialize the contact command.
|
|
|
|
Args:
|
|
bot: The bot instance.
|
|
"""
|
|
super().__init__(bot)
|
|
self.enabled = self.get_config_value('Contact_Command', 'enabled', fallback=True, value_type='bool')
|
|
|
|
def get_help_text(self, message: MeshMessage | None = None) -> str:
|
|
"""Get help text for the contact command.
|
|
|
|
Returns:
|
|
str: Help text string.
|
|
"""
|
|
return self.translate('commands.contact.help')
|
|
|
|
def matches_keyword(self, message: MeshMessage) -> bool:
|
|
"""Match ``contact`` (or a configured alias) on its own, with no arguments.
|
|
|
|
Args:
|
|
message: The received message.
|
|
|
|
Returns:
|
|
bool: True if the message is a contact command, False otherwise.
|
|
"""
|
|
def _matches(content_lower: str) -> bool:
|
|
return any(content_lower == keyword.lower() for keyword in self.keywords)
|
|
|
|
return self._cleaned_content_matches(message, _matches)
|
|
|
|
def _self_info_value(self, key: str) -> Optional[str]:
|
|
"""Read a field from the radio's self_info, which may be a dict or an object.
|
|
|
|
Args:
|
|
key: The self_info field name.
|
|
|
|
Returns:
|
|
str: The field value, or None if unavailable.
|
|
"""
|
|
meshcore: Any = getattr(self.bot, 'meshcore', None)
|
|
self_info = getattr(meshcore, 'self_info', None) if meshcore else None
|
|
if not self_info:
|
|
return None
|
|
if isinstance(self_info, dict):
|
|
value = self_info.get(key)
|
|
else:
|
|
value = getattr(self_info, key, None)
|
|
return str(value).strip() if value else None
|
|
|
|
async def execute(self, message: MeshMessage) -> bool:
|
|
"""Execute the contact command.
|
|
|
|
Args:
|
|
message: The message triggering the command.
|
|
|
|
Returns:
|
|
bool: True if executed successfully, False otherwise.
|
|
"""
|
|
public_key = self._self_info_value('public_key')
|
|
name = self._self_info_value('name') or self._self_info_value('adv_name')
|
|
|
|
if not public_key or not PUBLIC_KEY_RE.match(public_key):
|
|
self.logger.warning("Contact command: no usable public key in self_info")
|
|
return await self.send_response(message, self.translate('commands.contact.unavailable'))
|
|
|
|
if not name:
|
|
self.logger.warning("Contact command: no device name in self_info")
|
|
return await self.send_response(message, self.translate('commands.contact.unavailable'))
|
|
|
|
return await self.send_response(message, f"<{public_key.lower()}:1:{name}>")
|