gardel/Mofox-Core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

更新示例

Browse Source
This commit is contained in:
雅诺狐
2025-08-28 13:00:32 +08:00
parent 57c16bae38
commit f320d1f576
4 changed files with 279 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@@ -325,7 +325,7 @@ run_pet.bat
!/plugins/set_emoji_like
!/plugins/permission_example
!/plugins/hello_world_plugin
!/plugins/take_picture_plugin
!/plugins/echo_example
config.toml

53
plugins/echo_example/_manifest.json Normal file
View File

@@ -0,0 +1,53 @@
{
"manifest_version": 1,
"format_version": "1.0.0",
"name": "Echo 示例插件",
"description": "展示增强命令系统的Echo命令示例插件",
"version": "1.0.0",
"author": {
"name": "MoFox"
},
"license": "MIT",
"keywords": ["echo", "example", "command"],
"categories": ["utility", "example"],
"host_application": {
"name": "MaiBot",
"min_version": "0.10.0"
},
"entry_points": {
"main": "plugin.py"
},
"plugin_info": {
"is_built_in": false,
"plugin_type": "example",
"components": [
{
"type": "command",
"name": "echo",
"description": "回显命令，支持别名 say, repeat"
},
{
"type": "command",
"name": "hello",
"description": "问候命令，支持别名 hi, greet"
},
{
"type": "command",
"name": "info",
"description": "显示插件信息，支持别名 about"
},
{
"type": "command",
"name": "test",
"description": "测试命令，展示参数解析功能"
}
],
"features": [
"增强命令系统示例",
"无需正则表达式的命令定义",
"命令别名支持",
"参数解析功能",
"聊天类型限制"
]
}
}

203
plugins/echo_example/plugin.py Normal file
View File

@@ -0,0 +1,203 @@
"""
Echo 示例插件
展示增强命令系统的使用方法
"""
from typing import List, Tuple, Type, Optional, Union
from src.plugin_system import (
BasePlugin,
PlusCommand,
CommandArgs,
PlusCommandInfo,
ConfigField,
ChatType,
register_plugin,
)
from src.plugin_system.base.component_types import PythonDependency
class EchoCommand(PlusCommand):
"""Echo命令示例"""
command_name = "echo"
command_description = "回显命令"
command_aliases = ["say", "repeat"]
priority = 5
chat_type_allow = ChatType.ALL
intercept_message = True
async def execute(self, args: CommandArgs) -> Tuple[bool, Optional[str], bool]:
"""执行echo命令"""
if args.is_empty():
await self.send_text("❓ 请提供要回显的内容\n用法: /echo <内容>")
return True, "参数不足", True
content = args.get_raw()
# 检查内容长度限制
max_length = self.get_config("commands.max_content_length", 500)
if len(content) > max_length:
await self.send_text(f"❌ 内容过长，最大允许 {max_length} 字符")
return True, "内容过长", True
await self.send_text(f"🔊 {content}")
return True, "Echo命令执行成功", True
class HelloCommand(PlusCommand):
"""Hello命令示例"""
command_name = "hello"
command_description = "问候命令"
command_aliases = ["hi", "greet"]
priority = 3
chat_type_allow = ChatType.ALL
intercept_message = True
async def execute(self, args: CommandArgs) -> Tuple[bool, Optional[str], bool]:
"""执行hello命令"""
if args.is_empty():
await self.send_text("👋 Hello! 很高兴见到你！")
else:
name = args.get_first()
await self.send_text(f"👋 Hello, {name}! 很高兴见到你！")
return True, "Hello命令执行成功", True
class InfoCommand(PlusCommand):
"""信息命令示例"""
command_name = "info"
command_description = "显示插件信息"
command_aliases = ["about"]
priority = 1
chat_type_allow = ChatType.ALL
intercept_message = True
async def execute(self, args: CommandArgs) -> Tuple[bool, Optional[str], bool]:
"""执行info命令"""
info_text = (
"📋 Echo 示例插件信息\n"
"版本: 1.0.0\n"
"作者: MaiBot Team\n"
"描述: 展示增强命令系统的使用方法\n\n"
"🎯 可用命令:\n"
"• /echo|/say|/repeat <内容> - 回显内容\n"
"• /hello|/hi|/greet [名字] - 问候\n"
"• /info|/about - 显示此信息\n"
"• /test <子命令> [参数] - 测试各种功能"
)
await self.send_text(info_text)
return True, "Info命令执行成功", True
class TestCommand(PlusCommand):
"""测试命令示例，展示参数解析功能"""
command_name = "test"
command_description = "测试命令，展示参数解析功能"
command_aliases = ["t"]
priority = 2
chat_type_allow = ChatType.ALL
intercept_message = True
async def execute(self, args: CommandArgs) -> Tuple[bool, Optional[str], bool]:
"""执行test命令"""
if args.is_empty():
help_text = (
"🧪 测试命令帮助\n"
"用法: /test <子命令> [参数]\n\n"
"可用子命令:\n"
"• args - 显示参数解析结果\n"
"• flags - 测试标志参数\n"
"• count - 计算参数数量\n"
"• join - 连接所有参数"
)
await self.send_text(help_text)
return True, "显示帮助", True
subcommand = args.get_first().lower()
if subcommand == "args":
result = (
f"🔍 参数解析结果:\n"
f"原始字符串: '{args.get_raw()}'\n"
f"解析后参数: {args.get_args()}\n"
f"参数数量: {args.count()}\n"
f"第一个参数: '{args.get_first()}'\n"
f"剩余参数: '{args.get_remaining()}'"
)
await self.send_text(result)
elif subcommand == "flags":
result = (
f"🏴 标志测试结果:\n"
f"包含 --verbose: {args.has_flag('--verbose')}\n"
f"包含 -v: {args.has_flag('-v')}\n"
f"--output 的值: '{args.get_flag_value('--output', '未设置')}'\n"
f"--name 的值: '{args.get_flag_value('--name', '未设置')}'"
)
await self.send_text(result)
elif subcommand == "count":
count = args.count() - 1 # 减去子命令本身
await self.send_text(f"📊 除子命令外的参数数量: {count}")
elif subcommand == "join":
remaining = args.get_remaining()
if remaining:
await self.send_text(f"🔗 连接结果: {remaining}")
else:
await self.send_text("❌ 没有可连接的参数")
else:
await self.send_text(f"❓ 未知的子命令: {subcommand}")
return True, "Test命令执行成功", True
@register_plugin
class EchoExamplePlugin(BasePlugin):
"""Echo 示例插件"""
plugin_name: str = "echo_example_plugin"
enable_plugin: bool = True
dependencies: List[str] = []
python_dependencies: List[Union[str, "PythonDependency"]] = []
config_file_name: str = "config.toml"
config_schema = {
"plugin": {
"enabled": ConfigField(bool, default=True, description="是否启用插件"),
"config_version": ConfigField(str, default="1.0.0", description="配置文件版本"),
},
"commands": {
"echo_enabled": ConfigField(bool, default=True, description="是否启用 Echo 命令"),
"cooldown": ConfigField(int, default=0, description="命令冷却时间（秒）"),
"max_content_length": ConfigField(int, default=500, description="最大回显内容长度"),
},
}
config_section_descriptions = {
"plugin": "插件基本配置",
"commands": "命令相关配置",
}
def get_plugin_components(self) -> List[Tuple[PlusCommandInfo, Type]]:
"""获取插件组件"""
components = []
if self.get_config("plugin.enabled", True):
# 添加所有命令，直接使用PlusCommand类
if self.get_config("commands.echo_enabled", True):
components.append((EchoCommand.get_plus_command_info(), EchoCommand))
components.append((HelloCommand.get_plus_command_info(), HelloCommand))
components.append((InfoCommand.get_plus_command_info(), InfoCommand))
components.append((TestCommand.get_plus_command_info(), TestCommand))
return components

48
src/plugins/built_in/permission_management/plugin.py
View File

@@ -2,6 +2,7 @@
权限管理插件
提供权限系统的管理命令，包括权限授权、撤销、查询等功能。
使用新的PlusCommand系统重构。
"""
import re
@@ -9,23 +10,25 @@ from typing import List, Optional, Tuple, Type
from src.plugin_system.apis.plugin_register_api import register_plugin
from src.plugin_system.base.base_plugin import BasePlugin
from src.plugin_system.base.base_command import BaseCommand
from src.plugin_system.base.plus_command import PlusCommand
from src.plugin_system.base.command_args import CommandArgs
from src.plugin_system.apis.permission_api import permission_api
from src.plugin_system.apis.logging_api import get_logger
from src.plugin_system.base.component_types import CommandInfo
from src.plugin_system.base.component_types import PlusCommandInfo, ChatType
from src.plugin_system.base.config_types import ConfigField
logger = get_logger("Permission")
class PermissionCommand(BaseCommand):
"""权限管理命令"""
class PermissionCommand(PlusCommand):
"""权限管理命令 - 使用PlusCommand系统"""
command_name = "permission"
command_description = "权限管理命令"
command_pattern = r"^/permission(?:\s|$)"
command_help = "/permission <子命令> [参数...]"
command_description = "权限管理命令，支持授权、撤销、查询等功能"
command_aliases = ["perm", "权限"]
priority = 10
chat_type_allow = ChatType.ALL
intercept_message = True
def __init__(self, *args, **kwargs):
@@ -44,26 +47,16 @@ class PermissionCommand(BaseCommand):
True
)
def can_execute(self) -> bool:
"""检查命令是否可以执行"""
# 基本权限检查由权限系统处理
return True
async def execute(self) -> Tuple[bool, Optional[str], bool]:
async def execute(self, args: CommandArgs) -> Tuple[bool, Optional[str], bool]:
"""执行权限管理命令"""
# 从消息中解析命令和参数
message_text = self.message.processed_plain_text.strip()
# 移除 /permission 前缀，获取后续参数
args_text = message_text[11:].strip() # "/permission" 是11个字符
if not args_text:
if args.is_empty():
await self._show_help()
return True, "显示帮助信息", True
args = args_text.split()
subcommand = args[0].lower()
remaining_args = args[1:]
subcommand = args.get_first().lower()
remaining_args = args.get_args()[1:] # 获取除第一个参数外的所有参数
chat_stream = self.message.chat_stream
# 检查基本查看权限
can_view = permission_api.check_permission(
chat_stream.platform,
@@ -149,7 +142,9 @@ class PermissionCommand(BaseCommand):
• /permission grant @张三 plugin.example.command
• /permission list 123456789
• /permission nodes example_plugin
• /permission allnodes"""
• /permission allnodes
🔄 别名：可以使用 /perm 或 /权限 代替 /permission"""
await self.send_text(help_text)
@@ -166,7 +161,7 @@ class PermissionCommand(BaseCommand):
return None
async def _grant_permission(self, chat_stream , args: List[str]):
async def _grant_permission(self, chat_stream, args: List[str]):
"""授权用户权限"""
if len(args) < 2:
await self.send_text("❌ 用法: /permission grant <@用户|QQ号> <权限节点>")
@@ -387,5 +382,6 @@ class PermissionManagerPlugin(BasePlugin):
}
}
def get_plugin_components(self) -> List[Tuple[CommandInfo, Type[BaseCommand]]]:
return [(PermissionCommand.get_command_info(), PermissionCommand)]
def get_plugin_components(self) -> List[Tuple[PlusCommandInfo, Type[PlusCommand]]]:
"""返回插件的PlusCommand组件"""
return [(PermissionCommand.get_plus_command_info(), PermissionCommand)]