feat✨: 新增Web UI功能及数据库、日志等API接口

zhenxun/plugins/web_ui/api/logs/__init__.py

@@ -0,0 +1 @@
+from .logs import *

zhenxun/plugins/web_ui/api/logs/log_manager.py

@@ -0,0 +1,35 @@
+import asyncio
+from typing import Awaitable, Callable, Generic, TypeVar
+
+PATTERN = r"\x1b(\[.*?[@-~]|\].*?(\x07|\x1b\\))"
+
+_T = TypeVar("_T")
+LogListener = Callable[[_T], Awaitable[None]]
+
+
+class LogStorage(Generic[_T]):
+    """
+    日志存储
+    """
+
+    def __init__(self, rotation: float = 5 * 60):
+        self.count, self.rotation = 0, rotation
+        self.logs: dict[int, str] = {}
+        self.listeners: set[LogListener[str]] = set()
+
+    async def add(self, log: str):
+        seq = self.count = self.count + 1
+        self.logs[seq] = log
+        asyncio.get_running_loop().call_later(self.rotation, self.remove, seq)
+        await asyncio.gather(
+            *map(lambda listener: listener(log), self.listeners),
+            return_exceptions=True,
+        )
+        return seq
+
+    def remove(self, seq: int):
+        del self.logs[seq]
+        return
+
+
+LOG_STORAGE: LogStorage[str] = LogStorage[str]()

zhenxun/plugins/web_ui/api/logs/logs.py

@@ -0,0 +1,40 @@
+from fastapi import APIRouter, WebSocket
+from loguru import logger
+from nonebot.utils import escape_tag
+from starlette.websockets import WebSocket, WebSocketDisconnect, WebSocketState
+
+from .log_manager import LOG_STORAGE
+
+router = APIRouter()
+
+
+@router.get("/logs", response_model=list[str])
+async def system_logs_history(reverse: bool = False):
+    """历史日志
+
+    参数:
+        reverse: 反转顺序.
+    """
+    return LOG_STORAGE.list(reverse=reverse)  # type: ignore
+
+
+@router.websocket("/logs")
+async def system_logs_realtime(websocket: WebSocket):
+    await websocket.accept()
+
+    async def log_listener(log: str):
+        await websocket.send_text(log)
+
+    LOG_STORAGE.listeners.add(log_listener)
+    try:
+        while websocket.client_state == WebSocketState.CONNECTED:
+            recv = await websocket.receive()
+            logger.trace(
+                f"{system_logs_realtime.__name__!r} received "
+                f"<e>{escape_tag(repr(recv))}</e>"
+            )
+    except WebSocketDisconnect:
+        pass
+    finally:
+        LOG_STORAGE.listeners.remove(log_listener)
+    return