refactor(core): 优化权限管理和事件模型
- 重构 AdminManager 和 PermissionManager 以 Redis 为主要数据源 - 为所有事件模型添加 slots=True 提升性能 - 更新文档说明 Mypyc 编译注意事项 - 清理测试和调试文件 - 移动静态资源到 web_static 目录
This commit is contained in:
@@ -2,14 +2,7 @@
|
||||
权限管理器模块
|
||||
|
||||
该模块负责管理用户权限，支持 admin、op、user 三个权限级别。
|
||||
权限数据存储在 `permissions.json` 文件中，格式为：
|
||||
{
|
||||
"users": {
|
||||
"123456": "admin",
|
||||
"789012": "op",
|
||||
"345678": "user"
|
||||
}
|
||||
}
|
||||
以 Redis Hash 作为主要数据源，文件仅用作备份和首次数据迁移。
|
||||
"""
|
||||
import json
|
||||
import os
|
||||
@@ -18,6 +11,7 @@ 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
|
||||
|
||||
|
||||
@@ -31,176 +25,167 @@ 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"
|
||||
)
|
||||
|
||||
# 确保数据目录存在
|
||||
data_dir = os.path.dirname(self.data_file)
|
||||
os.makedirs(data_dir, exist_ok=True)
|
||||
|
||||
# 权限数据存储结构：{"users": {"user_id": "level_name"}}
|
||||
self._data: Dict[str, Dict[str, str]] = {"users": {}}
|
||||
|
||||
# 加载现有数据
|
||||
self.load()
|
||||
|
||||
|
||||
os.makedirs(os.path.dirname(self.data_file), exist_ok=True)
|
||||
logger.info("权限管理器初始化完成")
|
||||
super().__init__()
|
||||
|
||||
def load(self) -> None:
|
||||
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)
|
||||
# 兼容旧格式
|
||||
if "users" in data:
|
||||
self._data["users"] = data["users"]
|
||||
else:
|
||||
self._data["users"] = {}
|
||||
logger.debug(f"权限数据已从 {self.data_file} 加载")
|
||||
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:
|
||||
# 文件不存在，创建空文件
|
||||
self.save()
|
||||
logger.debug(f"创建空的权限数据文件: {self.data_file}")
|
||||
except json.JSONDecodeError as e:
|
||||
logger.error(f"权限数据文件格式错误: {e}")
|
||||
# 文件损坏，重置为空数据
|
||||
self._data["users"] = {}
|
||||
self.save()
|
||||
except Exception as e:
|
||||
logger.error(f"加载权限数据失败: {e}")
|
||||
self._data["users"] = {}
|
||||
logger.info("permissions.json 文件为空或不存在，无需迁移。")
|
||||
|
||||
def save(self) -> None:
|
||||
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(self._data, f, indent=2, ensure_ascii=False)
|
||||
logger.debug(f"权限数据已保存到 {self.data_file}")
|
||||
json.dump({"users": users_data}, f, indent=2, ensure_ascii=False)
|
||||
logger.debug(f"权限数据已备份到 {self.data_file}")
|
||||
except Exception as e:
|
||||
logger.error(f"保存权限数据失败: {e}")
|
||||
logger.error(f"备份权限数据到 permissions.json 失败: {e}")
|
||||
|
||||
async def get_user_permission(self, user_id: int) -> Permission:
|
||||
"""
|
||||
获取指定用户的权限对象
|
||||
|
||||
Args:
|
||||
user_id (int): 用户 QQ 号
|
||||
|
||||
Returns:
|
||||
Permission: 用户的权限对象，如果用户不存在则返回默认级别 USER
|
||||
优先检查是否为机器人管理员，然后从 Redis 查询。
|
||||
"""
|
||||
# 首先，通过 AdminManager 检查是否为管理员
|
||||
if await admin_manager.is_admin(user_id):
|
||||
return Permission.ADMIN
|
||||
|
||||
# 如果不是管理员，则从 permissions.json 中查找
|
||||
user_id_str = str(user_id)
|
||||
level_name = self._data["users"].get(user_id_str, Permission.USER.value)
|
||||
return _PERMISSIONS.get(level_name, Permission.USER)
|
||||
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
|
||||
|
||||
def set_user_permission(self, user_id: int, permission: Permission) -> None:
|
||||
async def set_user_permission(self, user_id: int, permission: Permission) -> None:
|
||||
"""
|
||||
设置指定用户的权限级别
|
||||
|
||||
Args:
|
||||
user_id (int): 用户 QQ 号
|
||||
permission (Permission): 权限对象
|
||||
|
||||
Raises:
|
||||
ValueError: 如果权限对象无效
|
||||
在 Redis 中设置指定用户的权限级别，并更新文件备份
|
||||
"""
|
||||
if not isinstance(permission, Permission):
|
||||
raise ValueError(f"无效的权限对象: {permission}")
|
||||
|
||||
user_id_str = str(user_id)
|
||||
self._data["users"][user_id_str] = permission.value
|
||||
self.save()
|
||||
logger.info(f"设置用户 {user_id} 的权限级别为 {permission.value}")
|
||||
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}")
|
||||
|
||||
def remove_user(self, user_id: int) -> None:
|
||||
async def remove_user(self, user_id: int) -> None:
|
||||
"""
|
||||
移除指定用户的权限设置，恢复为默认级别
|
||||
|
||||
Args:
|
||||
user_id (int): 用户 QQ 号
|
||||
从 Redis 中移除指定用户的权限设置，并更新文件备份
|
||||
"""
|
||||
user_id_str = str(user_id)
|
||||
if user_id_str in self._data["users"]:
|
||||
del self._data["users"][user_id_str]
|
||||
self.save()
|
||||
logger.info(f"移除用户 {user_id} 的权限设置")
|
||||
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:
|
||||
"""
|
||||
检查用户是否具有指定权限级别
|
||||
|
||||
Args:
|
||||
user_id (int): 用户 QQ 号
|
||||
required_permission (Permission): 所需的权限对象
|
||||
|
||||
Returns:
|
||||
bool: 如果用户权限 >= 所需权限，返回 True，否则返回 False
|
||||
"""
|
||||
user_permission = await self.get_user_permission(user_id)
|
||||
return user_permission >= required_permission
|
||||
|
||||
async def get_all_user_permissions(self) -> Dict[str, str]:
|
||||
"""
|
||||
获取所有已配置的用户权限（包括 AdminManager 中的管理员）
|
||||
|
||||
:return: 一个包含所有用户权限的字典
|
||||
获取所有已配置的用户权限（合并 Redis 和 AdminManager）
|
||||
"""
|
||||
permissions = self._data["users"].copy()
|
||||
|
||||
# 合并 AdminManager 中的管理员
|
||||
admins = await admin_manager.get_all_admins()
|
||||
for admin_id in admins:
|
||||
permissions[str(admin_id)] = Permission.ADMIN.value
|
||||
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
|
||||
|
||||
def get_all_users(self) -> Dict[str, str]:
|
||||
async def clear_all(self) -> None:
|
||||
"""
|
||||
获取所有设置了权限的用户及其级别名称
|
||||
|
||||
Returns:
|
||||
Dict[str, str]: 用户ID到权限级别名称的映射
|
||||
清空 Redis 中的所有权限设置，并更新备份文件
|
||||
"""
|
||||
return self._data["users"].copy()
|
||||
|
||||
def clear_all(self) -> None:
|
||||
"""
|
||||
清空所有权限设置
|
||||
"""
|
||||
self._data["users"].clear()
|
||||
self.save()
|
||||
logger.info("已清空所有权限设置")
|
||||
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):
|
||||
|
||||
Reference in New Issue
Block a user