2e2fd90497
为事件系统添加权限控制功能，包括： - 在BaseEvent中新增allowed_subscribers和allowed_triggers白名单字段 - 事件管理器触发和订阅时进行白名单验证 - 为所有系统默认事件设置仅允许SYSTEM插件触发 - 在所有事件触发调用处显式传递plugin_name="SYSTEM"参数 确保只有授权插件可以触发特定事件和订阅处理器，增强系统安全性。
142 lines
5.7 KiB
Python
142 lines
5.7 KiB
Python
import asyncio
|
||
from typing import List, Dict, Any, Optional
|
||
from src.common.logger import get_logger
|
||
|
||
logger = get_logger("base_event")
|
||
|
||
class HandlerResult:
|
||
"""事件处理器执行结果
|
||
|
||
所有事件处理器必须返回此类的实例
|
||
"""
|
||
def __init__(self, success: bool, continue_process: bool, message: Any = {}, handler_name: str = ""):
|
||
self.success = success
|
||
self.continue_process = continue_process
|
||
self.message = message
|
||
self.handler_name = handler_name
|
||
|
||
def __repr__(self):
|
||
return f"HandlerResult(success={self.success}, continue_process={self.continue_process}, message='{self.message}', handler_name='{self.handler_name}')"
|
||
|
||
class HandlerResultsCollection:
|
||
"""HandlerResult集合，提供便捷的查询方法"""
|
||
|
||
def __init__(self, results: List[HandlerResult]):
|
||
self.results = results
|
||
|
||
def all_continue_process(self) -> bool:
|
||
"""检查是否所有handler的continue_process都为True"""
|
||
return all(result.continue_process for result in self.results)
|
||
|
||
def get_all_results(self) -> List[HandlerResult]:
|
||
"""获取所有HandlerResult"""
|
||
return self.results
|
||
|
||
def get_failed_handlers(self) -> List[HandlerResult]:
|
||
"""获取执行失败的handler结果"""
|
||
return [result for result in self.results if not result.success]
|
||
|
||
def get_stopped_handlers(self) -> List[HandlerResult]:
|
||
"""获取continue_process为False的handler结果"""
|
||
return [result for result in self.results if not result.continue_process]
|
||
|
||
def get_handler_result(self, handler_name: str) -> Optional[HandlerResult]:
|
||
"""获取指定handler的结果"""
|
||
for result in self.results:
|
||
if result.handler_name == handler_name:
|
||
return result
|
||
return None
|
||
|
||
def get_success_count(self) -> int:
|
||
"""获取成功执行的handler数量"""
|
||
return sum(1 for result in self.results if result.success)
|
||
|
||
def get_failure_count(self) -> int:
|
||
"""获取执行失败的handler数量"""
|
||
return sum(1 for result in self.results if not result.success)
|
||
|
||
def get_summary(self) -> Dict[str, Any]:
|
||
"""获取执行摘要"""
|
||
return {
|
||
"total_handlers": len(self.results),
|
||
"success_count": self.get_success_count(),
|
||
"failure_count": self.get_failure_count(),
|
||
"continue_process": self.all_continue_process(),
|
||
"failed_handlers": [r.handler_name for r in self.get_failed_handlers()],
|
||
"stopped_handlers": [r.handler_name for r in self.get_stopped_handlers()]
|
||
}
|
||
|
||
class BaseEvent:
|
||
def __init__(
|
||
self,
|
||
name: str,
|
||
allowed_subscribers: List[str]=[],
|
||
allowed_triggers: List[str]=[]
|
||
):
|
||
self.name = name
|
||
self.enabled = True
|
||
self.allowed_subscribers = allowed_subscribers # 记录事件处理器名
|
||
self.allowed_triggers = allowed_triggers # 记录插件名
|
||
|
||
from src.plugin_system.base.base_events_handler import BaseEventHandler
|
||
self.subscribers: List["BaseEventHandler"] = [] # 订阅该事件的事件处理器列表
|
||
|
||
self.event_handle_lock = asyncio.Lock()
|
||
|
||
def __name__(self):
|
||
return self.name
|
||
|
||
async def activate(self, params: dict) -> HandlerResultsCollection:
|
||
"""激活事件，执行所有订阅的处理器
|
||
|
||
Args:
|
||
params: 传递给处理器的参数
|
||
|
||
Returns:
|
||
HandlerResultsCollection: 所有处理器的执行结果集合
|
||
"""
|
||
if not self.enabled:
|
||
return HandlerResultsCollection([])
|
||
|
||
# 使用锁确保同一个事件不能同时激活多次
|
||
async with self.event_handle_lock:
|
||
# 按权重从高到低排序订阅者
|
||
# 使用直接属性访问，-1代表自动权重
|
||
sorted_subscribers = sorted(self.subscribers, key=lambda h: h.weight if hasattr(h, 'weight') and h.weight != -1 else 0, reverse=True)
|
||
|
||
# 并行执行所有订阅者
|
||
tasks = []
|
||
for subscriber in sorted_subscribers:
|
||
# 为每个订阅者创建执行任务
|
||
task = self._execute_subscriber(subscriber, params)
|
||
tasks.append(task)
|
||
|
||
# 等待所有任务完成
|
||
results = await asyncio.gather(*tasks, return_exceptions=True)
|
||
|
||
# 处理执行结果
|
||
processed_results = []
|
||
for i, result in enumerate(results):
|
||
subscriber = sorted_subscribers[i]
|
||
handler_name = subscriber.handler_name if hasattr(subscriber, 'handler_name') else subscriber.__class__.__name__
|
||
|
||
if isinstance(result, Exception):
|
||
# 处理执行异常
|
||
logger.error(f"事件处理器 {handler_name} 执行失败: {result}")
|
||
processed_results.append(HandlerResult(False, True, str(result), handler_name))
|
||
else:
|
||
# 正常执行结果
|
||
if not result.handler_name:
|
||
# 补充handler_name
|
||
result.handler_name = handler_name
|
||
processed_results.append(result)
|
||
|
||
return HandlerResultsCollection(processed_results)
|
||
|
||
async def _execute_subscriber(self, subscriber, params: dict) -> HandlerResult:
|
||
"""执行单个订阅者处理器"""
|
||
try:
|
||
return await subscriber.execute(params)
|
||
except Exception as e:
|
||
# 异常会在 gather 中捕获，这里直接抛出让 gather 处理
|
||
raise e |