Files
meshcore-bot/modules/commands/webviewer_command.py
agessaman cc3fffeb54 feat: Add command enable/disable configuration for various commands
- Implemented a configuration option for enabling or disabling commands across multiple command classes.
- Each command now checks its enabled state before execution, improving control over command availability.
- Updated the configuration loading mechanism to retrieve the enabled state from the config file for commands like Advert, AQI, Catfact, and others.
2026-01-10 09:33:15 -08:00

170 lines
6.0 KiB
Python

#!/usr/bin/env python3
"""
Web Viewer Command
Provides commands to manage the web viewer integration
"""
from .base_command import BaseCommand
from ..models import MeshMessage
class WebViewerCommand(BaseCommand):
"""Command for managing web viewer integration"""
# Plugin metadata
name = "webviewer"
keywords = ["webviewer", "web", "viewer", "wv"]
description = "Manage web viewer integration (DM only)"
requires_dm = True
cooldown_seconds = 0
category = "management"
def __init__(self, bot):
"""Initialize the webviewer command.
Args:
bot: The bot instance.
"""
super().__init__(bot)
self.webviewer_enabled = self.get_config_value('WebViewer_Command', 'enabled', fallback=True, value_type='bool')
def can_execute(self, message: MeshMessage) -> bool:
"""Check if this command can be executed with the given message.
Args:
message: The message triggering the command.
Returns:
bool: True if command is enabled and checks pass, False otherwise.
"""
if not self.webviewer_enabled:
return False
return super().can_execute(message)
def get_help_text(self) -> str:
"""Get help text for the webviewer command.
Returns:
str: The help text for this command.
"""
return "Usage: webviewer <subcommand>\nSubcommands: status, reset, restart"
def matches_keyword(self, message: MeshMessage) -> bool:
"""Check if message starts with 'webviewer' keyword.
Args:
message: The received message.
Returns:
bool: True if matches, False otherwise.
"""
content = message.content.strip()
# Handle exclamation prefix
if content.startswith('!'):
content = content[1:].strip()
# Check if message starts with any of our keywords
content_lower = content.lower()
for keyword in self.keywords:
if content_lower.startswith(keyword + ' '):
return True
return False
async def execute(self, message: MeshMessage) -> bool:
"""Execute the webviewer command.
Args:
message: The message triggering the command.
Returns:
bool: True if executed successfully, False otherwise.
"""
content = message.content.strip()
# Handle exclamation prefix
if content.startswith('!'):
content = content[1:].strip()
# Parse subcommand
parts = content.split()
if len(parts) < 2:
await self.bot.send_response("Usage: webviewer <subcommand>\nSubcommands: status, reset, restart")
return True
subcommand = parts[1].lower()
if subcommand == "status":
await self._handle_status(message)
elif subcommand == "reset":
await self._handle_reset(message)
elif subcommand == "restart":
await self._handle_restart(message)
else:
await self.bot.send_response("Unknown subcommand. Use: status, reset, restart")
return True
async def _handle_status(self, message: MeshMessage) -> None:
"""Handle status subcommand.
Args:
message: The message that triggered the detailed status request.
"""
if not hasattr(self.bot, 'web_viewer_integration') or not self.bot.web_viewer_integration:
await self.bot.send_response("Web viewer integration not available")
return
integration = self.bot.web_viewer_integration
status = {
'enabled': integration.enabled,
'running': integration.running,
'url': f"http://{integration.host}:{integration.port}" if integration.running else None
}
if hasattr(integration, 'bot_integration') and integration.bot_integration:
bot_integration = integration.bot_integration
status.update({
'circuit_breaker_open': bot_integration.circuit_breaker_open,
'circuit_breaker_failures': bot_integration.circuit_breaker_failures,
'shutdown': getattr(bot_integration, 'is_shutting_down', False)
})
status_text = "Web Viewer Status:\n"
for key, value in status.items():
status_text += f"{key}: {value}\n"
await self.bot.send_response(status_text)
async def _handle_reset(self, message: MeshMessage) -> None:
"""Handle reset subcommand.
Args:
message: The message that triggered the reset request.
"""
if not hasattr(self.bot, 'web_viewer_integration') or not self.bot.web_viewer_integration:
await self.bot.send_response("Web viewer integration not available")
return
if hasattr(self.bot.web_viewer_integration, 'bot_integration') and self.bot.web_viewer_integration.bot_integration:
self.bot.web_viewer_integration.bot_integration.reset_circuit_breaker()
await self.bot.send_response("Circuit breaker reset")
else:
await self.bot.send_response("Bot integration not available")
async def _handle_restart(self, message: MeshMessage) -> None:
"""Handle restart subcommand.
Args:
message: The message that triggered the restart request.
"""
if not hasattr(self.bot, 'web_viewer_integration') or not self.bot.web_viewer_integration:
await self.bot.send_response("Web viewer integration not available")
return
try:
self.bot.web_viewer_integration.restart_viewer()
await self.bot.send_response("Web viewer restart initiated")
except Exception as e:
await self.bot.send_response(f"Failed to restart web viewer: {e}")