mirror of
https://github.com/jxxghp/MoviePilot.git
synced 2026-03-20 12:08:09 +08:00
352 lines
16 KiB
Python
352 lines
16 KiB
Python
import threading
|
||
import time
|
||
import uuid
|
||
from queue import PriorityQueue, Empty
|
||
from typing import Callable, Dict, List, Union, Optional
|
||
|
||
from app.helper.thread import ThreadHelper
|
||
from app.log import logger
|
||
from app.schemas.types import EventType, ChainEventType
|
||
from app.utils.singleton import Singleton
|
||
|
||
DEFAULT_EVENT_PRIORITY = 10 # 事件的默认优先级
|
||
MIN_EVENT_CONSUMER_THREADS = 1 # 最小事件消费者线程数
|
||
MAX_EVENT_WORKER_POOL_SIZE = 50 # 最大事件工作线程池大小
|
||
EVENT_QUEUE_IDLE_TIMEOUT_SECONDS = 60 # 事件队列空闲时的超时时间(秒)
|
||
|
||
|
||
class Event:
|
||
"""
|
||
事件类,封装事件的基本信息
|
||
"""
|
||
|
||
def __init__(self, event_type: Union[EventType, ChainEventType], event_data: Optional[Dict] = None,
|
||
priority: int = DEFAULT_EVENT_PRIORITY):
|
||
"""
|
||
:param event_type: 事件的类型,支持 EventType 或 ChainEventType
|
||
:param event_data: 可选,事件携带的数据,默认为空字典
|
||
:param priority: 可选,事件的优先级,默认为 10
|
||
"""
|
||
self.event_id = str(uuid.uuid4()) # 事件ID
|
||
self.event_type = event_type # 事件类型
|
||
self.event_data = event_data or {} # 事件数据
|
||
self.priority = priority # 事件优先级
|
||
|
||
def __repr__(self) -> str:
|
||
"""
|
||
重写 __repr__ 方法,用于返回事件的详细信息,包括事件类型、事件ID和优先级
|
||
"""
|
||
event_kind = Event.get_event_kind(self.event_type)
|
||
return f"<{event_kind}: {self.event_type.value}, ID: {self.event_id}, Priority: {self.priority}>"
|
||
|
||
@staticmethod
|
||
def get_event_kind(event_type: Union[EventType, ChainEventType]) -> str:
|
||
"""
|
||
根据事件类型判断事件是广播事件还是链式事件
|
||
:param event_type: 事件类型,支持 EventType 或 ChainEventType
|
||
:return: 返回 Broadcast Event 或 Chain Event
|
||
"""
|
||
return "Broadcast Event" if isinstance(event_type, EventType) else "Chain Event"
|
||
|
||
|
||
class EventManager(metaclass=Singleton):
|
||
"""
|
||
EventManager 负责管理和调度广播事件和链式事件,包括订阅、发送和处理事件
|
||
"""
|
||
|
||
def __init__(self, max_workers: int = MAX_EVENT_WORKER_POOL_SIZE):
|
||
"""
|
||
:param max_workers: 线程池最大工作线程数
|
||
"""
|
||
self.__executor = ThreadHelper(max_workers=max_workers) # 动态线程池,用于消费事件
|
||
self.__event_queue = PriorityQueue() # 优先级队列
|
||
self.__broadcast_subscribers: Dict[EventType, List[Callable[[Dict], None]]] = {} # 广播事件的订阅者
|
||
self.__chain_subscribers: Dict[
|
||
ChainEventType, List[tuple[int, Callable[[Dict], None]]]] = {} # 链式事件的订阅者(优先级+处理器)
|
||
self.__disabled_handlers = set() # 禁用的事件处理器集合
|
||
self.__disabled_classes = set() # 禁用的事件处理器类集合
|
||
self.__lock = threading.Lock() # 线程锁
|
||
self.__condition = threading.Condition(self.__lock) # 条件变量
|
||
|
||
# 启动消费者线程用于处理广播事件
|
||
for _ in range(MIN_EVENT_CONSUMER_THREADS):
|
||
threading.Thread(target=self.__fixed_broadcast_consumer, daemon=True).start()
|
||
|
||
def send_event(self, etype: Union[EventType, ChainEventType], data: Optional[Dict] = None,
|
||
priority: int = DEFAULT_EVENT_PRIORITY) -> Optional[Dict]:
|
||
"""
|
||
发送事件,根据事件类型决定是广播事件还是链式事件
|
||
:param etype: 事件类型 (EventType 或 ChainEventType)
|
||
:param data: 可选,事件数据
|
||
:param priority: 广播事件的优先级,默认为 10
|
||
:return: 如果是链式事件,返回处理后的事件数据;否则返回 None
|
||
"""
|
||
event = Event(etype, data, priority)
|
||
if isinstance(etype, EventType):
|
||
self.__trigger_broadcast_event(event)
|
||
with self.__condition:
|
||
self.__condition.notify()
|
||
elif isinstance(etype, ChainEventType):
|
||
return self.__trigger_chain_event(event)
|
||
else:
|
||
logger.error(f"Unknown event type: {etype}")
|
||
|
||
def add_event_listener(self, event_type: Union[EventType, ChainEventType], handler: Callable[[Dict], None],
|
||
priority: int = DEFAULT_EVENT_PRIORITY):
|
||
"""
|
||
注册事件处理器,将处理器添加到对应的事件订阅列表中
|
||
:param event_type: 事件类型 (EventType 或 ChainEventType)
|
||
:param handler: 处理器
|
||
:param priority: 可选,事件的优先级,默认为 10
|
||
"""
|
||
with self.__lock:
|
||
if isinstance(event_type, ChainEventType):
|
||
# 链式事件,按优先级排序
|
||
if event_type not in self.__chain_subscribers:
|
||
self.__chain_subscribers[event_type] = []
|
||
self.__chain_subscribers[event_type].append((priority, handler))
|
||
self.__chain_subscribers[event_type].sort(key=lambda x: x[0]) # 按优先级排序
|
||
logger.debug(
|
||
f"Subscribed to chain event: {event_type.value}, Handler: {handler.__name__}, Priority: {priority}")
|
||
else:
|
||
# 广播事件
|
||
if event_type not in self.__broadcast_subscribers:
|
||
self.__broadcast_subscribers[event_type] = []
|
||
self.__broadcast_subscribers[event_type].append(handler)
|
||
logger.debug(f"Subscribed to broadcast event: {event_type.value}, Handler: {handler.__name__}")
|
||
|
||
def remove_event_listener(self, event_type: Union[EventType, ChainEventType], handler: Callable[[Dict], None]):
|
||
"""
|
||
移除事件处理器,将处理器从对应事件的订阅列表中删除
|
||
:param event_type: 事件类型 (EventType 或 ChainEventType)
|
||
:param handler: 要移除的处理器
|
||
"""
|
||
with self.__lock:
|
||
if isinstance(event_type, ChainEventType) and event_type in self.__chain_subscribers:
|
||
self.__chain_subscribers[event_type] = [h for h in self.__chain_subscribers[event_type] if
|
||
h[1] != handler]
|
||
logger.debug(f"Unsubscribed from chain event: {event_type.value}, Handler: {handler.__name__}")
|
||
elif event_type in self.__broadcast_subscribers:
|
||
self.__broadcast_subscribers[event_type].remove(handler)
|
||
logger.debug(f"Unsubscribed from broadcast event: {event_type.value}, Handler: {handler.__name__}")
|
||
|
||
def disable_event_handler(self, handler_name: str, class_name: Optional[str] = None):
|
||
"""
|
||
禁用指定名称的事件处理器或事件处理类,防止其响应事件
|
||
:param handler_name: 要禁用的事件处理器名称
|
||
:param class_name: 可选,要禁用的事件处理器类名称。如果提供,将禁用该类的所有处理器
|
||
"""
|
||
if class_name:
|
||
self.__disabled_classes.add(class_name)
|
||
logger.debug(f"Disabled event handler class: {class_name}")
|
||
else:
|
||
self.__disabled_handlers.add(handler_name)
|
||
logger.debug(f"Disabled event handler: {handler_name}")
|
||
|
||
def enable_event_handler(self, handler_name: str, class_name: Optional[str] = None):
|
||
"""
|
||
启用指定名称的事件处理器或事件处理类,使其可以继续响应事件
|
||
:param handler_name: 要启用的事件处理器名称
|
||
:param class_name: 可选,要启用的事件处理器类名称。如果提供,将启用该类的所有处理器
|
||
"""
|
||
if class_name:
|
||
self.__disabled_classes.discard(class_name)
|
||
logger.debug(f"Enabled event handler class: {class_name}")
|
||
else:
|
||
self.__disabled_handlers.discard(handler_name)
|
||
logger.debug(f"Enabled event handler: {handler_name}")
|
||
|
||
def check(self, etype: Union[EventType, ChainEventType]) -> bool:
|
||
"""
|
||
检查是否有启用的事件处理器可以响应某个事件类型
|
||
:param etype: 事件类型 (EventType 或 ChainEventType)
|
||
:return: 返回是否存在可用的处理器
|
||
"""
|
||
if isinstance(etype, ChainEventType):
|
||
handlers = self.__chain_subscribers.get(etype, [])
|
||
return any(
|
||
handler.__name__ not in self.__disabled_handlers and
|
||
handler.__qualname__.split(".")[0] not in self.__disabled_classes
|
||
for _, handler in handlers
|
||
)
|
||
else:
|
||
handlers = self.__broadcast_subscribers.get(etype, [])
|
||
return any(
|
||
handler.__name__ not in self.__disabled_handlers and
|
||
handler.__qualname__.split(".")[0] not in self.__disabled_classes
|
||
for handler in handlers
|
||
)
|
||
|
||
def visualize_handlers(self) -> List[Dict[str, str]]:
|
||
"""
|
||
可视化所有事件处理器,包括是否被禁用的状态
|
||
:return: 处理器列表,包含处理器名称、类名和状态
|
||
"""
|
||
handler_info = []
|
||
with self.__lock:
|
||
for event_type, handlers in self.__broadcast_subscribers.items():
|
||
for handler in handlers:
|
||
class_name = handler.__qualname__.split(".")[0]
|
||
status = (
|
||
"disabled" if handler.__name__ in self.__disabled_handlers or class_name in self.__disabled_classes else "enabled"
|
||
)
|
||
handler_info.append({
|
||
"event_type": event_type.value,
|
||
"handler_name": handler.__name__,
|
||
"class_name": class_name,
|
||
"status": status
|
||
})
|
||
for event_type, handlers in self.__chain_subscribers.items():
|
||
for priority, handler in handlers:
|
||
class_name = handler.__qualname__.split(".")[0]
|
||
status = (
|
||
"disabled" if handler.__name__ in self.__disabled_handlers or class_name in self.__disabled_classes else "enabled"
|
||
)
|
||
handler_info.append({
|
||
"event_type": event_type.value,
|
||
"handler_name": handler.__name__,
|
||
"class_name": class_name,
|
||
"priority": priority,
|
||
"status": status
|
||
})
|
||
return handler_info
|
||
|
||
def __trigger_chain_event(self, event: Event) -> Dict:
|
||
"""
|
||
触发链式事件,按顺序调用订阅的处理器
|
||
:param event: 要处理的事件对象
|
||
:return: 返回处理后的事件数据
|
||
"""
|
||
logger.debug(f"Triggering synchronous chain event: {event}")
|
||
self.__dispatch_chain_event(event)
|
||
return event.event_data
|
||
|
||
def __trigger_broadcast_event(self, event: Event):
|
||
"""
|
||
触发广播事件,将事件插入到优先级队列中
|
||
:param event: 要处理的事件对象
|
||
"""
|
||
logger.debug(f"Triggering broadcast event: {event}")
|
||
self.__event_queue.put((event.priority, event))
|
||
|
||
def __dispatch_chain_event(self, event: Event):
|
||
"""
|
||
同步方式调度链式事件,按优先级顺序逐个调用事件处理器
|
||
:param event: 要调度的事件对象
|
||
"""
|
||
handlers = self.__chain_subscribers.get(event.event_type, [])
|
||
self.__log_event_lifecycle(event, "started")
|
||
for priority, handler in handlers:
|
||
class_name = handler.__qualname__.split(".")[0]
|
||
if handler.__name__ not in self.__disabled_handlers and class_name not in self.__disabled_classes:
|
||
start_time = time.time()
|
||
try:
|
||
handler(event.event_data)
|
||
logger.debug(
|
||
f"Handler {handler.__qualname__} (Priority: {priority}) "
|
||
f"completed in {time.time() - start_time:.3f}s")
|
||
except Exception as e:
|
||
self.__handle_event_error(event, handler, e)
|
||
self.__log_event_lifecycle(event, "completed")
|
||
|
||
def __dispatch_broadcast_event(self, event: Event):
|
||
"""
|
||
异步方式调度广播事件,通过线程池逐个调用事件处理器
|
||
:param event: 要调度的事件对象
|
||
"""
|
||
handlers = self.__broadcast_subscribers.get(event.event_type, [])
|
||
for handler in handlers:
|
||
class_name = handler.__qualname__.split(".")[0]
|
||
if handler.__name__ not in self.__disabled_handlers and class_name not in self.__disabled_classes:
|
||
self.__executor.submit(self.__safe_invoke_handler, handler, event)
|
||
|
||
def __safe_invoke_handler(self, handler: Callable[[Dict], None], event: Event):
|
||
"""
|
||
安全调用事件处理器,捕获异常并记录日志
|
||
:param handler: 要调用的处理器
|
||
:param event: 事件对象
|
||
"""
|
||
try:
|
||
handler(event.event_data)
|
||
except Exception as e:
|
||
self.__handle_event_error(event, handler, e)
|
||
|
||
def __fixed_broadcast_consumer(self):
|
||
"""
|
||
固定的后台广播消费者线程,持续从队列中提取事件
|
||
"""
|
||
while True:
|
||
# 使用 Condition 优化队列的等待机制,避免频繁触发超时
|
||
with self.__condition:
|
||
# 当队列为空时,线程进入等待状态,直到有新事件到来
|
||
while self.__event_queue.empty():
|
||
# 阻塞等待,直到有事件插入
|
||
self.__condition.wait()
|
||
|
||
try:
|
||
priority, event = self.__event_queue.get(timeout=EVENT_QUEUE_IDLE_TIMEOUT_SECONDS)
|
||
logger.debug(f"Fixed consumer processing event: {event}")
|
||
self.__dispatch_broadcast_event(event)
|
||
except Empty:
|
||
logger.debug("Queue is empty, waiting for new events.")
|
||
|
||
@staticmethod
|
||
def __log_event_lifecycle(event: Event, stage: str):
|
||
"""
|
||
记录事件的生命周期日志
|
||
"""
|
||
logger.debug(f"{stage} - {event}")
|
||
|
||
@staticmethod
|
||
def __handle_event_error(event: Event, handler: Callable, error: Exception):
|
||
"""
|
||
全局错误处理器,用于处理事件处理中的异常
|
||
"""
|
||
logger.error(
|
||
f"Global error handler: Event {event.event_type.value} failed in handler {handler.__name__}: {str(error)}")
|
||
# 可以将错误事件重新发送到事件队列或执行其他逻辑
|
||
# eventmanager.send_event(EventType.SystemError, {"error": str(error), "event_id": event.event_id})
|
||
|
||
def register(self, etype: Union[EventType, ChainEventType, List[Union[EventType, ChainEventType]], type]):
|
||
"""
|
||
事件注册装饰器,用于将函数注册为事件的处理器
|
||
:param etype:
|
||
- 单个事件类型成员 (如 EventType.MetadataScrape, ChainEventType.PluginAction)
|
||
- 事件类型类 (EventType, ChainEventType)
|
||
- 或事件类型成员的列表
|
||
"""
|
||
|
||
def decorator(f: Callable[[Dict], None]):
|
||
event_list = []
|
||
|
||
# 如果传入的是列表,处理每个事件类型
|
||
if isinstance(etype, list):
|
||
for et in etype:
|
||
if isinstance(et, (EventType, ChainEventType)):
|
||
event_list.append(et)
|
||
else:
|
||
raise ValueError(f"列表中无效的事件类型: {et}")
|
||
|
||
# 如果传入的是 EventType 或 ChainEventType 类,提取该类中的所有成员
|
||
elif isinstance(etype, type) and issubclass(etype, (EventType, ChainEventType)):
|
||
event_list.extend(etype.__members__.values())
|
||
|
||
# 如果传入的是单个事件类型成员 (EventType.MetadataScrape 或 ChainEventType.PluginAction)
|
||
elif isinstance(etype, (EventType, ChainEventType)):
|
||
event_list.append(etype)
|
||
|
||
else:
|
||
raise ValueError(f"无效的事件类型: {etype}")
|
||
|
||
# 统一注册事件
|
||
for event in event_list:
|
||
self.add_event_listener(event, f)
|
||
|
||
return f
|
||
|
||
return decorator
|
||
|
||
|
||
# 全局实例定义
|
||
eventmanager = EventManager()
|