diff --git a/README.md b/README.md index 4499df5..89acac5 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ https://github.com/itxiaohui66/astrbot_plugin_tixing ``` -也可以从 [GitHub Releases](https://github.com/itxiaohui66/astrbot_plugin_tixing/releases/latest) 下载 `astrbot_plugin_tixing-v1.2.2.zip`,在插件页上传安装。手动安装时,把 ZIP 中的 `astrbot_plugin_tixing` 文件夹解压到 AstrBot 的 `data/plugins/` 下,然后重启或重载插件。运行文件 `main.py`、`metadata.yaml` 和 `_conf_schema.json` 必须直接位于该插件文件夹中。 +也可以从 [GitHub Releases](https://github.com/itxiaohui66/astrbot_plugin_tixing/releases/latest) 下载 `astrbot_plugin_tixing-v1.3.0.zip`,在插件页上传安装。手动安装时,把 ZIP 中的 `astrbot_plugin_tixing` 文件夹解压到 AstrBot 的 `data/plugins/` 下,然后重启或重载插件。运行文件 `main.py`、`metadata.yaml` 和 `_conf_schema.json` 必须直接位于该插件文件夹中。 安装时 AstrBot 会读取 `requirements.txt` 安装 `tzdata`。配置默认采用北京时间 `Asia/Shanghai`;每人在每个群或私聊最多 10 个活跃提醒,每 30 秒扫描一次。确认机器人已经接入 QQ 官方适配器,群内使用 `@机器人 /tx help` 查看帮助。 @@ -84,17 +84,21 @@ https://github.com/itxiaohui66/astrbot_plugin_tixing ## 官方 QQ 的对象和发送权限 -官方 QQ 下发 `group_openid`、`member_openid`、`user_openid`;普通 QQ 号、群号不能直接代替它们。提醒他人优先解析真实 @ 消息段或平台提供的 mentions。若官方事件没有提供被 @ 成员的标识,让对方先在本群 `@机器人 /tx identity`,再使用: +**提醒别人直接 @ 对方的名字,无需填写或复制长串 ID。** 在 QQ 输入 `@` 后,从群成员列表选中对方,例如: ```text -/tx 30分钟 开会 @对方的用户标识 +@机器人 /tx 30分钟 开会 @小明 ``` v1.2.2 修复 SDK 的非空 `mentions` 列表丢失成员字段时覆盖完整原始数据,导致“提醒别人”退回提醒发起人的情况。解析会合并原始 QQ payload 和 SDK 信息,并从当前消息的原始正文恢复被适配器省略的真实 @,包括命令前的 @;不从引用消息中选取接收者。已知机器人及其别名始终排除在提醒对象之外。收到无法解析的额外 @ 元数据时会提示“未创建提醒”,不静默改成提醒自己。 -创建回复始终显示“提醒对象”:自己显示“你自己”,他人显示昵称或成员标识。发起人仍管理该任务,到期只 @ 保存的接收者。旧版已错误保存为提醒自己的任务无法从数据库还原原定接收者,请 `/tx cancel 编号` 后重新设置,并检查创建回复中的提醒对象。 +机器人从实际 @ 的消息段、原始正文和 mentions 自动读取并保存对方的本群 ID,到期用 QQ 原生 @ 提醒对方。用户看到的是名字,ID 由插件内部处理。QQ 未提供昵称时,创建确认显示“你选中的群成员”,不把长串 ID 当作人名。 -插件会记住本群里机器人实际收到的成员消息,名字唯一且官方提供昵称时也支持 `@昵称`。不同群里的成员记录不会混用,重名时要求明确标识。OneBot 模式会查询目标是否是本群成员。私聊只能提醒自己。 +v1.3.0 会从机器人收到的成员消息和真实 @ 中学习用户名、群名片及昵称,按平台和群保存,重启后仍可使用。已识别成员也支持直接输入 `@小明`;带空格的名字支持 `@"小 明"` 或 `@小 明`(后者需名字已被识别)。同名时请从 QQ 的 @ 列表选择具体成员,实际选择优先于昵称缓存。收到新名字时更新记录,不继续按旧昵称匹配。 + +仅手打一个机器人从未收到过的昵称时,插件无法凭空获得该成员 ID;请从 QQ 的 @ 列表选择对方。若平台连实际 @ 的成员信息也没有下发,可让对方先在本群 `@机器人` 发一条消息;平台提供昵称后即可按昵称匹配。解析失败会明确提示“未创建提醒”,不会退回提醒发起人,也不会要求复制 OpenID。官方群事件的基础字段及其成员标识见 [腾讯事件文档](https://github.com/tencent-connect/bot-docs/blob/main/docs/develop/api-v2/server-inter/message/send-receive/event.md)。 + +创建回复始终显示“提醒对象”。发起人仍管理该任务,到期只 @ 保存的接收者。旧版已错误保存为提醒自己的任务无法从数据库还原原定接收者,请 `/tx cancel 编号` 后重新设置,并检查创建回复中的提醒对象。不同群里的成员记录不会混用。OneBot 模式会查询目标是否是本群成员。私聊只能提醒自己。 v1.2.0 默认采用 **主动发送**。新群的 `GROUP_ADD_ROBOT` 事件到来时,插件使用该真实事件的 `event_id` 回复管理员开启说明;若事件缺失、发送失败或插件是后来才安装的,则在首次提醒命令回复中附加说明。提示按平台和群持久化,成功提示后不会在每次命令中重复。 @@ -155,7 +159,7 @@ python tools/package.py 1. 首次命令或入群时确认收到权限开启提示;管理员开启“允许机器人主动发送消息”后,`@机器人 /tx permission check` 确认主动验证成功。 2. `@机器人 /tx 1分钟 测试提醒`,确认返回任务编号,到期收到真正 @ 的通知;`/tx history` 检查状态,失败时查看原因和日志。 3. `/tx 5分钟 重启测试`,重载插件后用 `/tx list` 确认仍在,再 `/tx cancel 编号` 确认取消。 -4. `@机器人 /tx 1分钟 他人提醒测试 @另一成员`,确认创建回复中的提醒对象是对方;到期只 @ 对方,不 @ 发起人。若平台缺少标识,让对方先 `/tx identity` 再使用本群用户标识。 +4. `@机器人 /tx 1分钟 他人提醒测试 @另一成员`,从 QQ 的 @ 列表选择对方,确认创建回复中的提醒对象;到期只 @ 对方,不 @ 发起人。成员名字被识别后,再测试手打 `@昵称` 以及重载后的昵称匹配。 5. `@机器人 /tx 6分钟 主动提醒测试`,期间不再 @机器人,确认到期仍收到提醒。若因权限不足显示等待,开好权限并再次验证;旧版已自动取消的任务需先 `/tx retry 编号` 恢复。 ## 来源 diff --git a/main.py b/main.py index 1184b07..3efd569 100644 --- a/main.py +++ b/main.py @@ -26,7 +26,7 @@ from .services.delivery import ( ) from .services.permissions import NOTICE, PermissionBridge from .services.storage import ReminderStore, scope_key -from .services.targets import MARKUP, resolve_target +from .services.targets import MARKUP, observe_members, resolve_target from .services.time_parser import describe, next_occurrence, parse_time HELP = """⏰ 栗子提醒 @@ -50,7 +50,8 @@ HELP = """⏰ 栗子提醒 /cxzd 管理员重启提醒调度器 命令别名:/提醒、/remind 群内官方 QQ 需要 @机器人;时间按配置时区计算。 -官方 QQ 提醒他人须使用本群 OpenID 或真实 @;普通 QQ 号不可转换。 +提醒他人:输入 @ 后从 QQ 群成员列表选中对方,机器人自动识别,无需填 ID。 +已识别的本群成员也支持 @昵称;昵称带空格可用 @"小 明"。 默认到点主动提醒;群主/管理员需开启“允许机器人主动发送消息”。 管理员可 /tx list all 和 /tx cancel 编号 管理当前群提醒。""" @@ -398,7 +399,7 @@ class ReminderPlugin(Star): raise ValueError("当前插件支持 QQ 官方 WebSocket、Webhook 和 OneBot。") scope = self._scope(event) user = str(event.get_sender_id()) - await self.store.observe(scope, user, event.get_sender_name()) + await observe_members(event, self.store, scope) parts = args.split(maxsplit=1) action = parts[0].lower() tail = parts[1].strip() if len(parts) == 2 else "" @@ -475,7 +476,7 @@ class ReminderPlugin(Star): reminder_id = await self.store.add(record, self.limit) message = f"⏰ 提醒已设置 #{reminder_id}\n时间:{describe(record['remind_at'], parsed.repeat, self.timezone)}\n时区:{self.timezone}\n内容:{parsed.content}" if target != user: - message += f"\n提醒对象:{target_name or target}" + message += f"\n提醒对象:{target_name or '你选中的群成员'}" else: message += "\n提醒对象:你自己" if event.get_platform_name() in OFFICIAL: @@ -503,7 +504,7 @@ class ReminderPlugin(Star): ) text = f"#{rem['id']} [{status}] {describe(rem['remind_at'], rem['repeat_type'], rem['timezone'])}\n{content}" if rem["target_id"] != rem["creator_id"]: - text += f"\n对象:{rem['target_name'] or rem['target_id']}" + text += f"\n对象:{rem['target_name'] or '你选中的群成员'}" if detail: text += f"\n创建者:{rem['creator_name'] or rem['creator_id']}\n时区:{rem['timezone']}\n失败次数:{rem['failure_count']}" if rem["last_error"]: @@ -636,9 +637,7 @@ class ReminderPlugin(Star): await self.initialize() await self._remember_incoming(event) if event.get_group_id(): - await self.store.observe( - self._scope(event), str(event.get_sender_id()), event.get_sender_name() - ) + await observe_members(event, self.store, self._scope(event)) except Exception: logger.exception("[Reminder] 记录本群成员标识失败") diff --git a/metadata.yaml b/metadata.yaml index d6c8a70..a361889 100644 --- a/metadata.yaml +++ b/metadata.yaml @@ -1,7 +1,7 @@ name: astrbot_plugin_tixing display_name: 栗子提醒 desc: 完整移植栗子 QQ 机器人的单次、每日、每周和他人提醒,支持列表、取消、持久化恢复及投递失败重试。 -version: v1.2.2 +version: v1.3.0 author: itxiaohui repo: https://github.com/itxiaohui66/astrbot_plugin_tixing support_platforms: diff --git a/services/storage.py b/services/storage.py index 9a67caf..260267b 100644 --- a/services/storage.py +++ b/services/storage.py @@ -64,6 +64,13 @@ class ReminderStore: nickname TEXT NOT NULL DEFAULT '', seen_at REAL NOT NULL, PRIMARY KEY(scope, user_id) ); + CREATE TABLE IF NOT EXISTS member_names ( + scope TEXT NOT NULL, user_id TEXT NOT NULL, name TEXT NOT NULL, + PRIMARY KEY(scope, user_id, name) + ); + CREATE INDEX IF NOT EXISTS member_names_lookup ON member_names(scope, name); + INSERT OR IGNORE INTO member_names + SELECT scope,user_id,nickname FROM members WHERE nickname!=''; CREATE TABLE IF NOT EXISTS reply_contexts ( platform_id TEXT NOT NULL, scene TEXT NOT NULL, destination TEXT NOT NULL, msg_id TEXT NOT NULL, received_at REAL NOT NULL, @@ -178,29 +185,56 @@ class ReminderStore: ) ) - async def observe(self, scope, user_id, nickname=""): - await self._run( - lambda db: ( + async def observe(self, scope, user_id, nickname="", names=()): + await self.observe_members(scope, [(user_id, nickname, names)]) + + async def observe_members(self, scope, members): + def write(db): + for user_id, nickname, names in members: + if nickname == user_id: + nickname = "" + names = list(dict.fromkeys(n for n in (nickname, *names) if n and n != user_id)) db.execute( "INSERT INTO members VALUES (?,?,?,?) ON CONFLICT(scope,user_id) DO UPDATE SET " "nickname=CASE WHEN excluded.nickname!='' THEN excluded.nickname ELSE members.nickname END, " "seen_at=excluded.seen_at", (scope, user_id, nickname or "", time.time()), - ).rowcount - ) + ) + if names: + # Keep current names, rather than matching a nickname after a rename. + db.execute( + "DELETE FROM member_names WHERE scope=? AND user_id=?", (scope, user_id) + ) + db.executemany( + "INSERT INTO member_names VALUES (?,?,?)", + [(scope, user_id, name) for name in names], + ) + + await self._run(write) + + async def member_names(self, scope): + return await self._run( + lambda db: [ + r[0] + for r in db.execute( + "SELECT DISTINCT name FROM member_names WHERE scope=?", (scope,) + ) + ] ) async def member(self, scope, value): def read(db): rows = db.execute( - "SELECT * FROM members WHERE scope=? AND (user_id=? OR nickname=?)", + "SELECT DISTINCT m.* FROM members m LEFT JOIN member_names n " + "ON m.scope=n.scope AND m.user_id=n.user_id " + "WHERE m.scope=? AND (m.user_id=? OR n.name=?)", (scope, value, value), ).fetchall() exact = [r for r in rows if r["user_id"] == value] if exact: return dict(exact[0]) if len(rows) > 1: - raise ValueError("本群有重名用户,请使用真实 @ 或 /tx identity 获取的用户标识。") + raise ValueError("本群有重名用户,请在 QQ 的 @ 群成员列表中选中对方后发送。") return dict(rows[0]) if rows else None return await self._run(read) diff --git a/services/targets.py b/services/targets.py index 0274753..ea994f3 100644 --- a/services/targets.py +++ b/services/targets.py @@ -7,12 +7,20 @@ from .delivery import OFFICIAL, field MARKUP = re.compile( r"|<@!?([^>]+)>|\[CQ:at,qq=([^,\]]+)[^\]]*\]" ) -TEXT_AT = re.compile(r"(? 1: - raise ValueError("被 @ 成员重名,请使用用户标识。") - member = await store.member(scope, value) + matching = [user for user in trusted if value in names.get(user, [])] + if len(matching) > 1: + raise ValueError("被 @ 成员重名,请在 QQ 的 @ 群成员列表中只选中一个人。") + # A real QQ selection identifies the member even when cached names collide. + member = None if matching else await store.member(scope, value) + if ( + not matching + and not member + and aliases.get(value, value) not in trusted + and event.get_platform_name() in OFFICIAL + ): + raise ValueError( + f"还未识别本群成员“{value}”,未创建提醒。请输入 @ 后从 QQ 群成员列表中选中对方;" + "也可以让对方先在本群 @机器人发一条消息,再用 @昵称。无需填写 OpenID。" + ) candidates.append( - names[0] if names else member["user_id"] if member else aliases.get(value, value) + matching[0] if matching else member["user_id"] if member else aliases.get(value, value) ) - args = TEXT_AT.sub(" ", args).strip() + args = pattern.sub(" ", args).strip() candidates = list(dict.fromkeys(candidates)) if not candidates: unknown = [ @@ -110,7 +182,7 @@ async def resolve_target(event, args, store, scope): if unknown or (not payload_mentions and sdk_unknown and len(sdk_mentions) > 1): raise ValueError( "收到 @ 成员信息,但无法识别提醒对象,未创建提醒。" - "请重新真实 @ 对方,或让对方先 /tx identity 后使用 @本群用户标识。" + "请输入 @ 后从 QQ 群成员列表中选中对方,或让对方先 @机器人发一条消息再用 @昵称。" ) if len(candidates) > 1: raise ValueError("一次提醒只能指定一个成员。") @@ -124,8 +196,8 @@ async def resolve_target(event, args, store, scope): if event.get_platform_name() in OFFICIAL: if target not in trusted and not member: raise ValueError( - "无法确认该用户的本群 OpenID。请真实 @ 对方;若官方未提供成员标识," - "让对方先在本群 @ 机器人发送 /tx identity,再用 @用户标识。普通 QQ 号不能转换成 OpenID。" + "无法识别本群提醒对象,未创建提醒。请输入 @ 后从 QQ 群成员列表中选中对方," + "或让对方先 @机器人发一条消息再用 @昵称。无需填写 OpenID。" ) elif event.get_platform_name() == "aiocqhttp": try: diff --git a/tests/test_member_names.py b/tests/test_member_names.py new file mode 100644 index 0000000..b11c810 --- /dev/null +++ b/tests/test_member_names.py @@ -0,0 +1,167 @@ +import time +from types import SimpleNamespace + +import pytest +from test_reminders import plugin as plugin +from test_reminders import record + +from services.storage import ReminderStore +from services.targets import observe_members, resolve_target + + +@pytest.mark.parametrize("platform_name", ["qq_official", "qq_official_webhook"]) +@pytest.mark.parametrize("name", ["小明", "群名片", "小 明", '"小 明"', "“小 明”"]) +async def test_nickname_creation_persists_and_mentions_other_on_delivery( + plugin, plugin_class, event_factory, platform_name, name +): + instance, platform = plugin + platform.meta = lambda: SimpleNamespace(id="platform_1", name=platform_name) + # Learn a member's actual group name and username from a received message. + member_event = event_factory( + "你好", + user="target_member", + platform=platform_name, + raw=SimpleNamespace( + group_openid="group_1", + author=SimpleNamespace(member_openid="target_member"), + raw_data={ + "author": {"member_openid": "target_member", "username": "小明"}, + "member": {"nick": "群名片", "card": "小 明"}, + }, + ), + ) + await instance.observe_member(member_event) + # The directory must survive plugin updates/restarts before creation too. + await instance.store.initialize() + event = event_factory(f"/tx 1分钟 开会 @{name}", platform=platform_name) + await instance.tx(event) + rows = await instance.store.list(record()["scope"]) + assert len(rows) == 1 + rem = rows[0] + assert rem["target_id"] == "target_member" and rem["creator_id"] == "user_1" + assert rem["content"] == "开会" + assert "target_member" not in event.replies[0] + await instance.store._run( + lambda db: db.execute( + "UPDATE reminders SET remind_at=? WHERE id=?", (time.time() - 1, rem["id"]) + ) + ) + await instance.terminate() + restored = plugin_class(instance.context, {}) + await restored.store.initialize() + try: + await restored._check_due() + body = platform.get_client().api.post_group_message.call_args.kwargs["markdown"]["content"] + assert body.startswith('') + assert body.count("qqbot-at-user") == 1 and 'id="user_1"' not in body + finally: + await restored.terminate() + + +async def test_native_selection_wins_over_duplicate_cached_nickname(plugin, event_factory): + instance, _ = plugin + scope = record()["scope"] + await instance.store.observe(scope, "another_member", "小明") + event = event_factory( + "/tx 1分钟 开会 @小明", + raw={ + "group_openid": "group_1", + "mentions": [ + {"id": "generic_target", "member_openid": "target_member", "username": "小明"} + ], + }, + ) + await instance.tx(event) + assert (await instance.store.list(scope))[0]["target_id"] == "target_member" + + +async def test_mentions_are_learned_even_if_member_has_never_spoken(plugin, event_factory): + instance, _ = plugin + event = event_factory( + "普通消息", + raw=SimpleNamespace( + group_openid="group_1", + mentions=[SimpleNamespace(member_openid=None)], + raw_data={ + "mentions": [ + { + "id": "generic_target", + "member_openid": "target_member", + "username": "小明", + "nickname": "群名片", + } + ] + }, + ), + ) + await instance.observe_member(event) + assert not event.stopped + for name in ("小明", "群名片"): + _, target, _ = await resolve_target( + event_factory(), f"1分钟 开会 @{name}", instance.store, record()["scope"] + ) + assert target == "target_member" + + +async def test_unknown_or_cross_group_nickname_never_creates_self_reminder(plugin, event_factory): + instance, _ = plugin + await instance.store.observe("another_scope", "target_member", "小明") + event = event_factory("/tx 1分钟 开会 @小明") + await instance.tx(event) + assert "未创建提醒" in event.replies[0] and "群成员列表" in event.replies[0] + assert "/tx identity" not in event.replies[0] + assert not await instance.store.list(record()["scope"]) + + +async def test_rename_removes_old_alias_and_empty_payload_keeps_current_names( + tmp_path, event_factory +): + store = ReminderStore(tmp_path / "members.db") + await store.initialize() + scope = record()["scope"] + await store.observe(scope, "target_member", "旧名", ["旧名片"]) + await store.observe(scope, "target_member", "新名", ["新名片"]) + await store.observe(scope, "target_member", "") + await store.initialize() + assert await store.member(scope, "旧名") is None + assert await store.member(scope, "旧名片") is None + assert (await store.member(scope, "新名片"))["user_id"] == "target_member" + + +async def test_existing_database_nicknames_upgrade_without_losing_tasks(tmp_path): + store = ReminderStore(tmp_path / "members.db") + await store.initialize() + reminder_id = await store.add(record(), 10) + await store._run( + lambda db: db.execute( + "INSERT INTO members VALUES (?,?,?,?)", + (record()["scope"], "target_member", "原昵称", time.time()), + ) + ) + await store.initialize() + assert (await store.member(record()["scope"], "原昵称"))["user_id"] == "target_member" + assert (await store.get(reminder_id, record()["scope"]))["content"] == "吃饭" + + +async def test_bot_display_name_is_not_a_recipient(plugin, event_factory): + instance, _ = plugin + event = event_factory( + "/tx 1分钟 开会 @小明 @栗子", + raw={ + "group_openid": "group_1", + "mentions": [ + {"id": "bot_id", "is_you": True, "username": "栗子"}, + {"id": "target_member", "username": "小明"}, + ], + }, + ) + await instance.tx(event) + assert (await instance.store.list(record()["scope"]))[0]["target_id"] == "target_member" + + +async def test_at_component_name_is_learned(plugin, event_factory): + instance, _ = plugin + event = event_factory("普通消息") + event.messages = [SimpleNamespace(qq="target_member", name="小明", type="At")] + await observe_members(event, instance.store, record()["scope"]) + assert (await instance.store.member(record()["scope"], "小明"))["user_id"] == "target_member"