nonebot-plugin-botui 0.1.0__py3-none-any.whl

nonebot_plugin_botui/models.py

@@ -0,0 +1,221 @@
+"""记录用的数据结构与序列化工具。"""
+
+from __future__ import annotations
+
+import time
+from typing import Any
+from dataclasses import field, dataclass
+
+# 会话类型：多聊场景统一为 group，单聊为 private
+KIND_GROUP = 'group'
+KIND_PRIVATE = 'private'
+
+# 消息方向：机器人收到 / 机器人发出
+DIR_IN = 'in'
+DIR_OUT = 'out'
+
+# 各消息段在聊天列表里的简写
+SEGMENT_LABELS: dict[str, str] = {
+    'image': '[图片]',
+    'voice': '[语音]',
+    'audio': '[音频]',
+    'video': '[视频]',
+    'file': '[文件]',
+    'at': '@',
+    'face': '[表情]',
+    'reply': '[回复]',
+    'json': '[卡片]',
+    'xml': '[卡片]',
+    'forward': '[合并转发]',
+    'music': '[音乐]',
+    'poke': '[戳一戳]',
+    'button': '[按钮]',
+    'unknown': '[消息]',
+}
+
+
+def now_ts() -> float:
+    """当前时间戳（秒）"""
+    return time.time()
+
+
+def chat_key(kind: str, chat_id: str, self_id: str) -> str:
+    """会话在数据库中的唯一键，形如 ``12345678:group_123456``。
+
+    会话里内嵌机器人 ID，同一平台上的不同机器人各自维护一份会话，互不混淆。
+    """
+    return f'{self_id}:{kind}_{chat_id}'
+
+
+def split_chat_key_parts(key: str) -> tuple[str, str, str]:
+    """把 ``12345678:group_123456`` 拆成 ``('12345678', 'group', '123456')``。
+
+    会话 ID 本身可能含下划线（如 ``group_abc_def``），所以只按**第一个**
+    冒号切分前缀、按**第一个**下划线切分会话类型。
+    """
+    self_id, _, body = key.partition(':')
+    kind, _, chat_id = body.partition('_')
+    return self_id, (kind or KIND_GROUP), chat_id
+
+
+def split_chat_key(key: str) -> tuple[str, str]:
+    """把 ``12345678:group_123456`` 拆成 ``('group', '123456')``（丢掉机器人前缀）"""
+    _, kind, chat_id = split_chat_key_parts(key)
+    return kind, chat_id
+
+
+def self_id_of(key: str) -> str:
+    """取出会话 key 里内嵌的机器人 ID"""
+    return split_chat_key_parts(key)[0]
+
+
+def describe_segments(segments: list[dict[str, Any]]) -> str:
+    """把消息段概括成一行文本，用于聊天列表预览"""
+    parts: list[str] = []
+    for seg in segments:
+        stype = str(seg.get('type') or '')
+        if stype == 'text':
+            parts.append(str(seg.get('text') or ''))
+        elif stype == 'at':
+            target = str(seg.get('target') or '')
+            if target == 'all':
+                parts.append('@全体成员')
+            else:
+                parts.append(f'@{seg.get("name") or target}')
+        else:
+            parts.append(SEGMENT_LABELS.get(stype, '[消息]'))
+    text = ''.join(parts).strip()
+    return ' '.join(text.split())
+
+
+@dataclass(slots=True)
+class BotRecord:
+    """一个连接过的机器人账号（WebUI 右上角的切换器用它列机器人）"""
+
+    self_id: str
+    adapter: str = ''
+    scope: str = ''
+    name: str = ''
+    alias: str = ''
+    avatar: str = ''
+    online: bool = False
+    first_seen: float = 0.0
+    last_seen: float = 0.0
+
+    def to_dict(self) -> dict[str, Any]:
+        return {
+            'self_id': self.self_id,
+            'adapter': self.adapter or None,
+            'scope': self.scope or None,
+            # name 是**展示名**（用户备注优先），raw_name 才是适配器给的名称
+            'name': self.alias or self.name or self.self_id,
+            'alias': self.alias or None,
+            'raw_name': self.name or None,
+            'avatar': self.avatar or None,
+            'online': bool(self.online),
+            'first_seen': self.first_seen,
+            'last_seen': self.last_seen,
+        }
+
+
+@dataclass(slots=True)
+class ChatRecord:
+    """一个会话（群聊或私聊）"""
+
+    key: str
+    kind: str
+    chat_id: str
+    adapter: str = ''
+    scope: str = ''
+    self_id: str = ''
+    parent_id: str = ''
+    name: str = ''
+    alias: str = ''
+    avatar: str = ''
+    member_count: int | None = None
+    last_text: str = ''
+    last_at: float = 0.0
+    last_direction: str = ''
+    message_count: int = 0
+
+    def to_dict(self) -> dict[str, Any]:
+        return {
+            'key': self.key,
+            'kind': self.kind,
+            'id': self.chat_id,
+            # name 是**展示名**（用户备注优先）：适配器拿不到真实群名/昵称时，
+            # 用户手动设置的备注就顶上来；raw_name 保留适配器给的原始名称。
+            'name': self.alias or self.name or self.chat_id,
+            'alias': self.alias or None,
+            'raw_name': self.name or None,
+            'avatar': self.avatar or None,
+            'adapter': self.adapter or None,
+            'self_id': self.self_id or None,
+            'parent_id': self.parent_id or None,
+            'member_count': self.member_count,
+            'last_text': self.last_text,
+            'last_at': self.last_at,
+            'last_direction': self.last_direction,
+            'unread': 0,
+            'message_count': self.message_count,
+        }
+
+
+@dataclass(slots=True)
+class MessageRecord:
+    """一条消息（机器人收到的或发出的）"""
+
+    chat_key: str
+    chat_kind: str
+    chat_id: str
+    direction: str
+    ts: float
+    adapter: str = ''
+    scope: str = ''
+    self_id: str = ''
+    parent_id: str = ''
+    chat_name: str = ''
+    chat_avatar: str = ''
+    member_count: int | None = None
+    user_id: str = ''
+    user_name: str = ''
+    user_avatar: str = ''
+    role: str | None = None
+    is_self: bool = False
+    text: str = ''
+    segments: list[dict[str, Any]] = field(default_factory=list)
+    message_id: str = ''
+    # 默认不可撤回：只有机器人自己发出、且拿到了消息 ID 的才可撤回
+    recallable: bool = False
+    api: str = ''
+    recalled: bool = False
+    row_id: int = 0
+
+    def __post_init__(self) -> None:
+        # 机器人自己发出、且拿到了消息 ID 的记录才算可撤回
+        if self.direction == DIR_OUT and self.message_id:
+            self.recallable = True
+
+    @property
+    def preview(self) -> str:
+        """用于聊天列表的预览文本"""
+        return self.text.strip() or describe_segments(self.segments)
+
+    def to_dict(self) -> dict[str, Any]:
+        return {
+            'id': self.row_id,
+            'chat': self.chat_key,
+            'direction': self.direction,
+            'time': self.ts,
+            'user_id': self.user_id,
+            'user_name': self.user_name or self.user_id,
+            'user_avatar': self.user_avatar or None,
+            'role': self.role,
+            'self': self.is_self,
+            'text': self.text,
+            'message_id': self.message_id or None,
+            'recallable': bool(self.recallable and self.direction == DIR_OUT),
+            'recalled': self.recalled,
+            'segments': self.segments,
+            'adapter': self.adapter or None,
+        }

nonebot_plugin_botui/paths.py

@@ -0,0 +1,36 @@
+"""插件用到的全部文件路径，统一由 nonebot-plugin-localstore 提供。
+
+为什么单独放一个模块：localstore 的 ``get_plugin_data_dir()`` 是靠**调用栈**
+反查「哪个插件在要目录」的（见它的 ``_get_caller_plugin``：逐层向上找帧，
+按模块名查到已注册的插件为止）。这带来两点麻烦：
+
+1. 只有栈上**存在**插件自己的帧时才查得到；从 ``__main__``、别名模块名或
+   完全外部的回调里调用，会抛 ``RuntimeError: Cannot detect caller plugin``；
+2. 每次调用都要走一遍栈，结果取决于「谁在调」，属于隐式上下文依赖。
+
+把路径在**插件模块导入时**解析一次并存成常量，就绕开了这两点：插件加载时
+栈上必然是插件自己的帧，之后全项目只读这几个常量，行为稳定。
+
+存储位置完全交给 localstore 决定，可用它的配置项覆盖，例如::
+
+    LOCALSTORE_DATA_DIR=/srv/nonebot/data
+    LOCALSTORE_PLUGIN_DATA_DIR={"nonebot_plugin_botui": "/srv/botui/data"}
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from nonebot_plugin_localstore import (
+    get_plugin_data_dir,
+    get_plugin_data_file,
+)
+
+#: 插件数据目录（localstore 的目录函数自带 mkdir，这里不必再补）
+DATA_DIR: Path = get_plugin_data_dir()
+#: SQLite 数据库文件
+DB_FILE: Path = get_plugin_data_file('botui.sqlite3')
+#: 自动生成的访问令牌文件
+TOKEN_FILE: Path = get_plugin_data_file('token.txt')
+#: 媒体库目录：机器人收到的、WebUI 上传的图片/文件都在这里（见 mediastore.py）
+BLOB_DIR: Path = DATA_DIR / 'blobs'