* 滚木 * feat: 重构核心架构,增强类型安全与插件管理 本次提交对核心模块进行了深度重构,引入 Pydantic 增强配置管理的类型安全性,并全面优化了插件管理系统。 主要变更详情: 1. 核心架构与配置 - 重构配置加载模块:引入 Pydantic 模型 (`core/config_models.py`),提供严格的配置项类型检查、验证及默认值管理。 - 统一模块结构:规范化模块导入路径,移除冗余的 `__init__.py` 文件,提升项目结构的清晰度。 - 性能优化:集成 Redis 缓存支持 (`RedisManager`),有效降低高频 API 调用开销,提升响应速度。 2. 插件系统升级 - 实现热重载机制:新增插件文件变更监听功能,支持开发过程中自动重载插件,提升开发效率。 - 优化生命周期管理:改进插件加载与卸载逻辑,支持精确卸载指定插件及其关联的命令、事件处理器和定时任务。 3. 功能特性增强 - 新增媒体 API:引入 `MediaAPI` 模块,封装图片、语音等富媒体资源的获取与处理接口。 - 完善权限体系:重构权限管理系统,实现管理员与操作员的分级控制,支持更细粒度的命令权限校验。 4. 代码质量与稳定性 - 全面类型修复:解决 `mypy` 静态类型检查发现的大量类型错误(包括 `CommandManager`、`EventFactory` 及 `Bot` API 签名不匹配问题)。 - 增强错误处理:优化消息处理管道的异常捕获机制,完善关键路径的日志记录,提升系统运行稳定性。 * feat: 添加测试用例并优化代码结构 refactor(permission_manager): 调整初始化顺序和逻辑 fix(admin_manager): 修复初始化逻辑和目录创建问题 feat(ws): 优化Bot实例初始化条件 feat(message): 增强MessageSegment功能并添加测试 feat(events): 支持字符串格式的消息解析 test: 添加核心功能测试用例 refactor(plugin_manager): 改进插件路径处理 style: 清理无用导入和代码 chore: 更新依赖项 * refactor(handler): 移除TYPE_CHECKING并直接导入Bot类 简化类型注解,直接导入Bot类而非使用TYPE_CHECKING条件导入,提高代码可读性和维护性 * fix(command_manager): 修复插件卸载时元信息移除不精确的问题 修复 CommandManager 中 unload_plugin 方法移除插件元信息时使用 startswith 导致可能误删其他插件的问题,改为精确匹配 同时调整相关测试用例验证精确匹配行为 * refactor: 清理未使用的导入和更新文档结构 docs: 添加config_models.py到项目结构文档 docs: 调整数据目录位置到core/data下 docs: 更新权限管理器文档描述 * 文档更新 * 更新thpic插件 支持一次返回多张图 * feat: 添加测试覆盖率并修复相关问题 refactor(redis_manager): 移除冗余的ConnectionError处理 refactor(event_handler): 优化Bot类型注解 refactor(factory): 移除未使用的GroupCardNoticeEvent test: 添加全面的单元测试覆盖 - 添加test_import.py测试模块导入 - 添加test_debug.py测试插件加载调试 - 添加test_plugin_error.py测试错误处理 - 添加test_config_loader.py测试配置加载 - 添加test_redis_manager.py测试Redis管理 - 添加test_bot.py测试Bot功能 - 扩展test_models.py测试消息模型 - 添加test_plugin_manager_coverage.py测试插件管理 - 添加test_executor.py测试代码执行器 - 添加test_ws.py测试WebSocket - 添加test_api.py测试API接口 - 添加test_core_managers.py测试核心管理模块 fix(plugin_manager): 修复插件加载日志变量问题 覆盖率已到达86%(忽略插件) * 更新/help指令,现在会发送图片 * feat(help): 重构帮助系统为图片渲染模式 添加浏览器管理器和图片管理器,用于通过 Playwright 渲染帮助菜单为图片 重构命令管理器以支持图片缓存和同步功能 添加 HTML 模板用于帮助菜单渲染 * build: 更新依赖文件 requirements.txt * build: 更新依赖文件 * feat: 添加性能优化和架构文档,更新依赖和核心模块 refactor(browser_manager): 实现页面池机制以提升性能 refactor(image_manager): 添加模板缓存并集成页面池 refactor(bili_parser): 迁移到异步HTTP请求并实现会话复用 docs: 新增性能优化、架构设计和最佳实践文档 chore: 更新requirements.txt添加新依赖 * docs: 更新文档内容并优化语言风格 重构所有文档内容,使用更简洁直接的语言风格 更新架构、插件开发、部署等核心文档 优化代码示例和图表说明 统一术语和格式规范 * docs: 更新文档内容,简化语言并修正格式 - 简化插件开发指南中的描述,移除冗余内容 - 调整部署文档中的Python版本说明 - 优化最佳实践文档的措辞和格式 - 更新性能优化文档,删除不准确的数据 - 重构核心概念文档,使用更简洁的语言 - 修正README中的项目描述和技术栈说明 - 更新快速上手文档,简化安装步骤 - 调整事件流转文档的描述方式 - 简化架构文档内容 - 更新指令处理文档,添加参数注入示例 - 优化单例管理器文档的表述 * refactor(core): 优化权限管理和事件模型 - 重构 AdminManager 和 PermissionManager 以 Redis 为主要数据源 - 为所有事件模型添加 slots=True 提升性能 - 更新文档说明 Mypyc 编译注意事项 - 清理测试和调试文件 - 移动静态资源到 web_static 目录 --------- Co-authored-by: baby20162016 <2185823427@qq.com>
210 lines
8.1 KiB
Python
210 lines
8.1 KiB
Python
"""
|
||
权限管理器模块
|
||
|
||
该模块负责管理用户权限,支持 admin、op、user 三个权限级别。
|
||
以 Redis Hash 作为主要数据源,文件仅用作备份和首次数据迁移。
|
||
"""
|
||
import json
|
||
import os
|
||
from typing import Dict
|
||
|
||
from ..utils.logger import logger
|
||
from ..utils.singleton import Singleton
|
||
from .admin_manager import admin_manager
|
||
from .redis_manager import redis_manager
|
||
from ..permission import Permission
|
||
|
||
|
||
# 用于从字符串名称查找权限对象的字典
|
||
_PERMISSIONS: Dict[str, Permission] = {
|
||
p.value: p for p in Permission
|
||
}
|
||
|
||
|
||
class PermissionManager(Singleton):
|
||
"""
|
||
权限管理器类
|
||
|
||
以 Redis Hash 作为权限数据的唯一真实来源,提供高速的读写能力。
|
||
文件 (permissions.json) 仅用于首次启动时的数据迁移和作为灾备。
|
||
"""
|
||
_REDIS_KEY = "neobot:permissions" # 用于存储用户权限的 Redis Hash 键
|
||
|
||
def __init__(self):
|
||
"""
|
||
初始化权限管理器
|
||
"""
|
||
if hasattr(self, '_initialized') and self._initialized:
|
||
return
|
||
|
||
# 权限数据文件路径,主要用于备份和首次迁移
|
||
self.data_file = os.path.join(
|
||
os.path.dirname(os.path.abspath(__file__)),
|
||
"..",
|
||
"data",
|
||
"permissions.json"
|
||
)
|
||
|
||
os.makedirs(os.path.dirname(self.data_file), exist_ok=True)
|
||
logger.info("权限管理器初始化完成")
|
||
super().__init__()
|
||
|
||
async def initialize(self):
|
||
"""
|
||
异步初始化,检查 Redis 数据,如果为空则尝试从文件迁移
|
||
"""
|
||
try:
|
||
if not await redis_manager.redis.exists(self._REDIS_KEY):
|
||
logger.info("Redis 中未找到权限数据,尝试从 permissions.json 文件迁移...")
|
||
await self._migrate_from_file_to_redis()
|
||
else:
|
||
perm_count = await redis_manager.redis.hlen(self._REDIS_KEY)
|
||
logger.info(f"Redis 中已存在权限数据,共 {perm_count} 条。")
|
||
except Exception as e:
|
||
logger.error(f"初始化权限数据时发生错误: {e}")
|
||
|
||
async def _migrate_from_file_to_redis(self):
|
||
"""
|
||
从 permissions.json 加载权限数据并存入 Redis Hash
|
||
"""
|
||
perms_to_migrate = {}
|
||
try:
|
||
if os.path.exists(self.data_file):
|
||
with open(self.data_file, "r", encoding="utf-8") as f:
|
||
data = json.load(f)
|
||
perms_to_migrate = data.get("users", {})
|
||
|
||
if perms_to_migrate:
|
||
# 使用 pipeline 批量写入,提高效率
|
||
async with redis_manager.redis.pipeline(transaction=True) as pipe:
|
||
for user_id, level_name in perms_to_migrate.items():
|
||
pipe.hset(self._REDIS_KEY, user_id, level_name)
|
||
await pipe.execute()
|
||
logger.success(f"成功从文件迁移 {len(perms_to_migrate)} 条权限数据到 Redis。")
|
||
else:
|
||
logger.info("permissions.json 文件为空或不存在,无需迁移。")
|
||
|
||
except (json.JSONDecodeError, ValueError) as e:
|
||
logger.error(f"解析 permissions.json 失败,无法迁移: {e}")
|
||
except Exception as e:
|
||
logger.error(f"迁移权限数据到 Redis 失败: {e}")
|
||
|
||
async def _save_to_file_backup(self):
|
||
"""
|
||
将 Redis 中的权限数据完整备份到 permissions.json
|
||
"""
|
||
try:
|
||
all_perms = await redis_manager.redis.hgetall(self._REDIS_KEY)
|
||
# Redis 返回的是 bytes,需要解码
|
||
users_data = {k.decode('utf-8'): v.decode('utf-8') for k, v in all_perms.items()}
|
||
with open(self.data_file, "w", encoding="utf-8") as f:
|
||
json.dump({"users": users_data}, f, indent=2, ensure_ascii=False)
|
||
logger.debug(f"权限数据已备份到 {self.data_file}")
|
||
except Exception as e:
|
||
logger.error(f"备份权限数据到 permissions.json 失败: {e}")
|
||
|
||
async def get_user_permission(self, user_id: int) -> Permission:
|
||
"""
|
||
获取指定用户的权限对象
|
||
|
||
优先检查是否为机器人管理员,然后从 Redis 查询。
|
||
"""
|
||
if await admin_manager.is_admin(user_id):
|
||
return Permission.ADMIN
|
||
|
||
try:
|
||
level_name_bytes = await redis_manager.redis.hget(self._REDIS_KEY, str(user_id))
|
||
if level_name_bytes:
|
||
level_name = level_name_bytes.decode('utf-8')
|
||
return _PERMISSIONS.get(level_name, Permission.USER)
|
||
except Exception as e:
|
||
logger.error(f"从 Redis 获取用户 {user_id} 权限失败: {e}")
|
||
|
||
return Permission.USER
|
||
|
||
async def set_user_permission(self, user_id: int, permission: Permission) -> None:
|
||
"""
|
||
在 Redis 中设置指定用户的权限级别,并更新文件备份
|
||
"""
|
||
if not isinstance(permission, Permission):
|
||
raise ValueError(f"无效的权限对象: {permission}")
|
||
|
||
try:
|
||
await redis_manager.redis.hset(self._REDIS_KEY, str(user_id), permission.value)
|
||
await self._save_to_file_backup()
|
||
logger.info(f"已在 Redis 中设置用户 {user_id} 的权限为 {permission.value}")
|
||
except Exception as e:
|
||
logger.error(f"在 Redis 中设置用户 {user_id} 权限失败: {e}")
|
||
|
||
async def remove_user(self, user_id: int) -> None:
|
||
"""
|
||
从 Redis 中移除指定用户的权限设置,并更新文件备份
|
||
"""
|
||
try:
|
||
if await redis_manager.redis.hdel(self._REDIS_KEY, str(user_id)):
|
||
await self._save_to_file_backup()
|
||
logger.info(f"已从 Redis 中移除用户 {user_id} 的权限设置")
|
||
except Exception as e:
|
||
logger.error(f"从 Redis 移除用户 {user_id} 权限失败: {e}")
|
||
|
||
async def check_permission(self, user_id: int, required_permission: Permission) -> bool:
|
||
"""
|
||
检查用户是否具有指定权限级别
|
||
"""
|
||
user_permission = await self.get_user_permission(user_id)
|
||
return user_permission >= required_permission
|
||
|
||
async def get_all_user_permissions(self) -> Dict[str, str]:
|
||
"""
|
||
获取所有已配置的用户权限(合并 Redis 和 AdminManager)
|
||
"""
|
||
permissions = {}
|
||
try:
|
||
# 从 Redis 获取基础权限
|
||
all_perms = await redis_manager.redis.hgetall(self._REDIS_KEY)
|
||
permissions = {k.decode('utf-8'): v.decode('utf-8') for k, v in all_perms.items()}
|
||
except Exception as e:
|
||
logger.error(f"从 Redis 获取所有权限失败: {e}")
|
||
|
||
# 合并 AdminManager 中的管理员,ADMIN 权限覆盖一切
|
||
try:
|
||
admins = await admin_manager.get_all_admins()
|
||
for admin_id in admins:
|
||
permissions[str(admin_id)] = Permission.ADMIN.value
|
||
except Exception as e:
|
||
logger.error(f"获取管理员列表以合并权限时失败: {e}")
|
||
|
||
return permissions
|
||
|
||
async def clear_all(self) -> None:
|
||
"""
|
||
清空 Redis 中的所有权限设置,并更新备份文件
|
||
"""
|
||
try:
|
||
await redis_manager.redis.delete(self._REDIS_KEY)
|
||
await self._save_to_file_backup()
|
||
logger.info("已清空 Redis 中的所有权限设置")
|
||
except Exception as e:
|
||
logger.error(f"清空 Redis 权限数据失败: {e}")
|
||
|
||
|
||
def require_admin(func):
|
||
"""
|
||
一个装饰器,用于限制命令只能由管理员执行。
|
||
"""
|
||
from functools import wraps
|
||
from models.events.message import MessageEvent
|
||
from core.managers import permission_manager
|
||
|
||
@wraps(func)
|
||
async def wrapper(event: MessageEvent, *args, **kwargs):
|
||
user_id = event.user_id
|
||
if await permission_manager.check_permission(user_id, Permission.ADMIN):
|
||
return await func(event, *args, **kwargs)
|
||
else:
|
||
# 假设 event 对象有 reply 方法
|
||
if hasattr(event, "reply"):
|
||
await event.reply("抱歉,您没有权限执行此命令。")
|
||
return None
|
||
return wrapper
|