pallas-plugin-protocol 4.0.1__py3-none-any.whl

pallas_plugin_protocol/__init__.py

@@ -0,0 +1,93 @@
+# ruff: noqa: E501
+import logging
+
+from nonebot import get_app, get_driver, logger
+from nonebot.plugin import PluginMetadata
+
+from src.console.web import public_base_url
+from src.console.webui.console_login import prime_shared_console_login
+from src.features.cmd_perm.metadata_defaults import (
+    PLUGIN_EXTRA_VERSION,
+    PLUGIN_HOMEPAGE,
+    PLUGIN_MENU_TEMPLATE,
+)
+from src.features.cmd_perm.metadata_text import join_usage, usage_line
+from src.foundation.paths import plugin_data_dir
+
+from .config import Config, get_pallas_protocol_config, plugin_config, resolve_protocol_webui_base_path
+from .service import PallasProtocolService
+from .web import register_pallas_protocol_routes
+
+__plugin_meta__ = PluginMetadata(
+    name="协议端管理",
+    description="NapCat/SnowLuma 协议端账号管理与 Web 控制台。",
+    usage=join_usage(
+        usage_line("/protocol/console", "协议端管理页"),
+        usage_line("X-Pallas-Protocol-Token / ?token=", "API 鉴权"),
+    ),
+    type="application",
+    homepage=PLUGIN_HOMEPAGE,
+    supported_adapters={"~onebot.v11"},
+    extra={
+        "version": PLUGIN_EXTRA_VERSION,
+        "menu_template": PLUGIN_MENU_TEMPLATE,
+        "menu_data": [
+            {
+                "func": "协议端管理页",
+                "trigger_method": "http",
+                "help_audience": "maintainer",
+                "trigger_condition": "/protocol/console",
+                "brief_des": "管理协议账号与进程",
+                "detail_des": "可在页面执行创建账号、启动、停止、重启与日志查看。",
+            },
+            {
+                "func": "协议端 API",
+                "trigger_method": "http",
+                "help_audience": "maintainer",
+                "trigger_condition": "/protocol/*",
+                "brief_des": "提供协议管理接口",
+                "detail_des": "提供账号、配置、协议端发行包下载与状态查询接口。",
+            },
+        ],
+    },
+)
+
+app = get_app()
+driver = get_driver()
+manager = PallasProtocolService(plugin_data_dir("pallas_protocol"), get_pallas_protocol_config())
+
+register_pallas_protocol_routes(app, manager=manager, plugin_config=plugin_config)
+
+
+@driver.on_startup
+async def _pallas_protocol_prime_shared_console_login() -> None:
+    prime_shared_console_login()
+
+
+@driver.on_startup
+async def _startup() -> None:
+    if not plugin_config.pallas_protocol_enabled:
+        return
+    logging.getLogger("uvicorn.access").setLevel(logging.WARNING)
+    await manager.initialize()
+    if plugin_config.pallas_protocol_webui_enabled:
+        dconf = get_driver().config
+        base_u = public_base_url(
+            host=getattr(dconf, "host", None),
+            port=getattr(dconf, "port", None),
+        )
+        path = resolve_protocol_webui_base_path(plugin_config)
+        logger.info(f"Pallas-Bot 协议端 | WebUI={base_u}{path}/")
+    profile = manager.runtime_profile()
+    if bool(profile.get("follow_bot_lifecycle", True)):
+        await manager.start_all_enabled_accounts()
+
+
+@driver.on_shutdown
+async def _shutdown() -> None:
+    if not plugin_config.pallas_protocol_enabled:
+        return
+    profile = manager.runtime_profile()
+    if not bool(profile.get("follow_bot_lifecycle", True)):
+        return
+    await manager.stop_all_enabled_accounts()

pallas_plugin_protocol/backends/__init__.py

@@ -0,0 +1,55 @@
+"""协议端运行时注册表：按账号 `protocol_backend` 字段分派。"""
+
+# 新协议栈：实现 ProtocolRuntimeBackend 后在此 register；kind 与账号里存的字符串同形且小写匹配。
+
+from __future__ import annotations
+
+from collections.abc import Callable
+from typing import Any
+
+from ..contract import DEFAULT_PROTOCOL_BACKEND
+from .napcat import NapcatRuntimeBackend
+from .protocol import ProtocolRuntimeBackend
+from .snowluma import SnowlumaRuntimeBackend
+
+ProtocolRuntimeBackendFactory = Callable[[Any], ProtocolRuntimeBackend]
+
+_PROTOCOL_RUNTIME_FACTORIES: dict[str, ProtocolRuntimeBackendFactory] = {}
+
+
+def register_protocol_runtime_backend(kind: str, factory: ProtocolRuntimeBackendFactory) -> None:
+    """登记一种实现；factory 接收 PallasProtocolService，返回该后端的 RuntimeBackend 实例。应在插件加载阶段调用。"""
+    key = (kind or "").strip().lower()
+    if not key:
+        msg = "协议端 backend 注册名不能为空"
+        raise ValueError(msg)
+    _PROTOCOL_RUNTIME_FACTORIES[key] = factory
+
+
+def registered_protocol_runtime_backends() -> tuple[str, ...]:
+    return tuple(sorted(_PROTOCOL_RUNTIME_FACTORIES.keys()))
+
+
+def make_protocol_runtime_backend(service: Any, kind: str) -> ProtocolRuntimeBackend:
+    """按 kind 取工厂；空串回退到 contract.DEFAULT_PROTOCOL_BACKEND。未登记则 ValueError。"""
+    raw = (kind or "").strip().lower() or DEFAULT_PROTOCOL_BACKEND
+    factory = _PROTOCOL_RUNTIME_FACTORIES.get(raw)
+    if factory is None:
+        known = ", ".join(registered_protocol_runtime_backends()) or "(empty)"
+        msg = f"未注册的协议端实现: {raw!r}；已注册: {known}"
+        raise ValueError(msg)
+    return factory(service)
+
+
+# 内置：与 DEFAULT_PROTOCOL_BACKEND 一致
+register_protocol_runtime_backend("napcat", lambda s: NapcatRuntimeBackend(s))
+register_protocol_runtime_backend("snowluma", lambda s: SnowlumaRuntimeBackend(s))
+
+__all__ = [
+    "NapcatRuntimeBackend",
+    "SnowlumaRuntimeBackend",
+    "ProtocolRuntimeBackend",
+    "make_protocol_runtime_backend",
+    "register_protocol_runtime_backend",
+    "registered_protocol_runtime_backends",
+]

pallas_plugin_protocol/backends/napcat.py

@@ -0,0 +1,54 @@
+"""NapCat 协议栈：委托现有 LaunchManager / AccountConfigManager。"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+    from ..service import PallasProtocolService
+
+
+class NapcatRuntimeBackend:
+    """当前默认协议端实现，行为与抽出抽象前一致。"""
+
+    kind = "napcat"
+
+    def __init__(self, service: PallasProtocolService) -> None:
+        self._service = service
+
+    def apply_defaults(self, account: dict, resolve_qq: Callable[[dict], str]) -> None:
+        self._service._launch.apply_defaults(account, resolve_qq)
+
+    def prepare_dirs(self, account: dict) -> None:
+        self._service._launch.prepare_dirs(account)
+
+    def sync_all_configs(self, account: dict, resolve_qq: Callable[[dict], str]) -> None:
+        self._service._configs.sync_onebot(account, resolve_qq)
+        self._service._configs.sync_napcat_core(account, resolve_qq)
+        self._service._configs.sync_webui(account, resolve_qq)
+
+    def sync_onebot(self, account: dict, resolve_qq: Callable[[dict], str]) -> None:
+        self._service._configs.sync_onebot(account, resolve_qq)
+
+    def sync_webui(self, account: dict, resolve_qq: Callable[[dict], str]) -> None:
+        self._service._configs.sync_webui(account, resolve_qq)
+
+    def read_webui_into_account(self, account: dict) -> bool:
+        return self._service._configs.read_webui_into_account(account)
+
+    def get_account_configs(self, account: dict, resolve_qq: Callable[[dict], str]) -> dict[str, Any]:
+        return self._service._configs.get_account_configs(account, resolve_qq)
+
+    def update_account_configs(self, account: dict, payload: dict, resolve_qq: Callable[[dict], str]) -> dict[str, Any]:
+        return self._service._configs.update_account_configs(account, payload, resolve_qq)
+
+    def check_launch_issues(self, account: dict, resolve_qq: Callable[[dict], str]) -> list[str]:
+        return self._service._launch.check_launch_issues(account, resolve_qq)
+
+    def describe_account_data_paths(self, account: dict) -> dict[str, object]:
+        return self._service._launch.describe_account_data_paths(account)
+
+
+__all__ = ["NapcatRuntimeBackend"]

pallas_plugin_protocol/backends/protocol.py

@@ -0,0 +1,46 @@
+"""协议端运行时抽象：新栈实现 ``ProtocolRuntimeBackend``，并用 ``register_protocol_runtime_backend`` 登记。"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, Protocol, runtime_checkable
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+
+@runtime_checkable
+class ProtocolRuntimeBackend(Protocol):
+    """单账号协议栈的配置准备与校验"""
+
+    kind: str
+
+    def apply_defaults(self, account: dict, resolve_qq: Callable[[dict], str]) -> None:
+        """补齐 command/args/program_dir/account_data_dir 等默认值。"""
+        ...
+
+    def prepare_dirs(self, account: dict) -> None:
+        """创建账号数据目录等。"""
+        ...
+
+    def sync_all_configs(self, account: dict, resolve_qq: Callable[[dict], str]) -> None:
+        """写入协议栈所需的全部配置文件。"""
+        ...
+
+    def sync_onebot(self, account: dict, resolve_qq: Callable[[dict], str]) -> None: ...
+
+    def sync_webui(self, account: dict, resolve_qq: Callable[[dict], str]) -> None: ...
+
+    def read_webui_into_account(self, account: dict) -> bool: ...
+
+    def get_account_configs(self, account: dict, resolve_qq: Callable[[dict], str]) -> dict[str, Any]: ...
+
+    def update_account_configs(
+        self, account: dict, payload: dict, resolve_qq: Callable[[dict], str]
+    ) -> dict[str, Any]: ...
+
+    def check_launch_issues(self, account: dict, resolve_qq: Callable[[dict], str]) -> list[str]: ...
+
+    def describe_account_data_paths(self, account: dict) -> dict[str, object]: ...
+
+
+__all__ = ["ProtocolRuntimeBackend"]

pallas_plugin_protocol/backends/snowluma.py

@@ -0,0 +1,72 @@
+"""SnowLuma 协议栈：扁平 OneBot、runtime.json；启动由 LaunchManager 的 snowluma 分支处理。"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+    from ..service import PallasProtocolService
+
+
+class SnowlumaRuntimeBackend:
+    kind = "snowluma"
+
+    def __init__(self, service: PallasProtocolService) -> None:
+        self._service = service
+
+    def apply_defaults(self, account: dict, resolve_qq: Callable[[dict], str]) -> None:
+        self._service._launch.apply_defaults(account, resolve_qq)
+
+    def prepare_dirs(self, account: dict) -> None:
+        self._service._launch.prepare_dirs(account)
+
+    def sync_all_configs(self, account: dict, resolve_qq: Callable[[dict], str]) -> None:
+        from ..snowluma_config import sync_snowluma_onebot, sync_snowluma_runtime_json
+
+        cfg = self._service._configs
+        wmin = int(getattr(self._service._config, "pallas_protocol_webui_port_min", 6099) or 6099)
+        pc = self._service._config
+        sync_snowluma_runtime_json(account, webui_port_fallback_min=wmin, plugin_config=pc)
+        sync_snowluma_onebot(cfg, account, resolve_qq, plugin_config=pc)
+
+    def sync_onebot(self, account: dict, resolve_qq: Callable[[dict], str]) -> None:
+        from ..snowluma_config import sync_snowluma_onebot
+
+        sync_snowluma_onebot(
+            self._service._configs,
+            account,
+            resolve_qq,
+            plugin_config=self._service._config,
+        )
+
+    def sync_webui(self, account: dict, resolve_qq: Callable[[dict], str]) -> None:
+        from ..snowluma_config import sync_snowluma_runtime_json
+
+        wmin = int(getattr(self._service._config, "pallas_protocol_webui_port_min", 6099) or 6099)
+        sync_snowluma_runtime_json(account, webui_port_fallback_min=wmin, plugin_config=self._service._config)
+
+    def read_webui_into_account(self, account: dict) -> bool:
+        from ..snowluma_config import read_snowluma_runtime_into_account
+
+        return read_snowluma_runtime_into_account(account)
+
+    def get_account_configs(self, account: dict, resolve_qq: Callable[[dict], str]) -> dict[str, Any]:
+        from ..snowluma_config import get_snowluma_account_configs
+
+        return get_snowluma_account_configs(self._service._configs, account, resolve_qq)
+
+    def update_account_configs(self, account: dict, payload: dict, resolve_qq: Callable[[dict], str]) -> dict[str, Any]:
+        from ..snowluma_config import update_snowluma_account_configs
+
+        return update_snowluma_account_configs(self._service._configs, account, payload, resolve_qq)
+
+    def check_launch_issues(self, account: dict, resolve_qq: Callable[[dict], str]) -> list[str]:
+        return self._service._launch.check_launch_issues(account, resolve_qq)
+
+    def describe_account_data_paths(self, account: dict) -> dict[str, object]:
+        return self._service._launch.describe_account_data_paths(account)
+
+
+__all__ = ["SnowlumaRuntimeBackend"]