✨ Support Ignore unbound user command in group

alembic/versions/369fb74daad9_groups_ignore.py

@@ -0,0 +1,26 @@
+"""groups_ignore
+Revision ID: 369fb74daad9
+Revises: cb37027ecae8
+Create Date: 2024-03-25 17:29:35.378726
+"""
+
+from alembic import op
+import sqlalchemy as sa
+
+# revision identifiers, used by Alembic.
+revision = "369fb74daad9"
+down_revision = "cb37027ecae8"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column("groups", sa.Column("is_ignore", sa.Integer(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("groups", "is_ignore")
+    # ### end Alembic commands ###

core/handler/hookhandler.py

@@ -0,0 +1,3 @@
+from gram_core.handler.hookhandler import HookHandler
+
+__all__ = ("HookHandler",)

core/plugin/__init__.py

@@ -1,6 +1,13 @@
 """插件"""
 
-from gram_core.plugin._handler import conversation, error_handler, handler
+from gram_core.plugin._handler import (
+    conversation,
+    error_handler,
+    handler,
+    ConversationDataType,
+    ConversationData,
+    HandlerData,
+)
 from gram_core.plugin._job import TimeType, job
 from gram_core.plugin._plugin import Plugin, PluginType, get_all_plugins
 
@@ -11,6 +18,9 @@ __all__ = (
     "handler",
     "error_handler",
     "conversation",
+    "ConversationDataType",
+    "ConversationData",
+    "HandlerData",
     "job",
     "TimeType",
 )

gram_core

@@ -1 +1 @@
-Subproject commit 3057fba7a6e84be60ece1ab98e6cd012aba37e78
+Subproject commit 4c2eac29b1529ddffc94f9e22f6735b6d213a4bb

plugins/group/ignore_unbound_user.py

@@ -0,0 +1,101 @@
+from typing import TYPE_CHECKING
+
+from telegram.constants import ChatType
+from telegram.ext import ApplicationHandlerStop, filters
+
+from gram_core.dependence.redisdb import RedisDB
+from gram_core.plugin import Plugin, handler, HandlerData
+from gram_core.services.groups.services import GroupService
+from gram_core.services.players import PlayersService
+from gram_core.services.users.services import UserAdminService
+from plugins.tools.chat_administrators import ChatAdministrators
+from utils.log import logger
+
+if TYPE_CHECKING:
+    from telegram import Update, Message
+    from telegram.ext import ContextTypes
+
+IGNORE_UNBOUND_USER_OPEN = """成功开启 忽略未绑定用户触发部分命令 功能，彦卿将不会响应未绑定用户的部分命令
+
+- 此功能开启后，将会导致新用户无法快速绑定账号，请在群规则中注明 绑定链接 https://t.me/{}?start=setcookies 或者其他使用说明。
+"""
+IGNORE_UNBOUND_USER_CLOSE = """成功关闭 忽略未绑定用户触发部分命令 功能，彦卿将开始响应未绑定用户的部分命令"""
+
+
+class IgnoreUnboundUser(Plugin):
+    def __init__(
+        self,
+        players_service: PlayersService,
+        group_service: GroupService,
+        user_admin_service: UserAdminService,
+        redis: RedisDB,
+    ):
+        self.players_service = players_service
+        self.group_service = group_service
+        self.user_admin_service = user_admin_service
+        self.cache = redis.client
+
+    async def initialize(self) -> None:
+        self.application.run_preprocessor(self.check_update)
+
+    async def check_account(self, user_id: int) -> bool:
+        return bool(await self.players_service.get_player(user_id))
+
+    async def check_group(self, group_id: int) -> bool:
+        return await self.group_service.is_ignore(group_id)
+
+    async def check_update(self, update: "Update", _, __, context: "ContextTypes.DEFAULT_TYPE", data: "HandlerData"):
+        if not isinstance(data, HandlerData):
+            return
+        if not data.player:
+            return
+        chat = update.effective_chat
+        if (not chat) or chat.type not in [ChatType.SUPERGROUP, ChatType.GROUP]:
+            return
+        if not await self.check_group(chat.id):
+            # 未开启此功能
+            return
+        message = update.effective_message
+        if message:
+            text = message.text or message.caption
+            if text and context.bot.username in text:
+                # 机器人被提及
+                return
+        uid = await self.get_real_user_id(update)
+        if await self.check_account(uid):
+            # 已绑定账号
+            return
+        self.log_user(update, logger.info, "群组 %s[%s] 拦截了未绑定用户触发命令", chat.title, chat.id)
+        raise ApplicationHandlerStop
+
+    async def check_permission(self, chat_id: int, user_id: int, context: "ContextTypes.DEFAULT_TYPE") -> bool:
+        if await self.user_admin_service.is_admin(user_id):
+            return True
+        admins = await ChatAdministrators.get_chat_administrators(self.cache, context, chat_id)
+        return ChatAdministrators.is_admin(admins, user_id)
+
+    async def reply_and_delete(self, message: "Message", text: str):
+        reply = await message.reply_text(text)
+        self.add_delete_message_job(message)
+        self.add_delete_message_job(reply)
+
+    @handler.command("ignore_unbound_user", filters=filters.ChatType.SUPERGROUP | filters.ChatType.GROUP, block=False)
+    async def ignore_unbound_user(self, update: "Update", context: "ContextTypes.DEFAULT_TYPE"):
+        user_id = await self.get_real_user_id(update)
+        message = update.effective_message
+        chat_id = update.effective_chat.id
+        if not await self.check_permission(chat_id, user_id, context):
+            await self.reply_and_delete(message, "您没有权限执行此操作")
+            return
+        self.log_user(update, logger.info, "更改群组 未绑定用户触发命令 功能状态")
+        group = await self.group_service.get_group_by_id(chat_id)
+        if not group:
+            await self.reply_and_delete(message, "群组信息出现错误，请尝试重新添加机器人到群组")
+            return
+        group.is_ignore = not group.is_ignore
+        await self.group_service.update_group(group)
+        if group.is_ignore:
+            text = IGNORE_UNBOUND_USER_OPEN.format(context.bot.username)
+        else:
+            text = IGNORE_UNBOUND_USER_CLOSE
+        await message.reply_text(text)

plugins/starrail/avatar_list.py

@@ -143,8 +143,8 @@ class AvatarListPlugin(Plugin):
                 logger.warning("未找到角色 %s[%s] 的资源: %s", character.name, character.id, e)
         return data
 
-    @handler.command("avatars", block=False)
-    @handler.message(filters.Regex(r"^(全部)?练度统计$"), block=False)
+    @handler.command("avatars", cookie=True, block=False)
+    @handler.message(filters.Regex(r"^(全部)?练度统计$"), cookie=True, block=False)
     async def avatar_list(self, update: "Update", _: "ContextTypes.DEFAULT_TYPE"):
         user_id = await self.get_real_user_id(update)
         message = update.effective_message

plugins/starrail/daily_note.py

@@ -87,8 +87,8 @@ class DailyNotePlugin(Plugin):
             [[InlineKeyboardButton(">> 设置状态提醒 <<", url=create_deep_linked_url(bot_username, "daily_note_tasks"))]]
         )
 
-    @handler.command("dailynote", block=False)
-    @handler.message(filters.Regex("^当前状态(.*)"), block=False)
+    @handler.command("dailynote", cookie=True, block=False)
+    @handler.message(filters.Regex("^当前状态(.*)"), cookie=True, block=False)
     async def command_start(self, update: Update, context: CallbackContext) -> Optional[int]:
         user_id = await self.get_real_user_id(update)
         message = update.effective_message

plugins/starrail/ledger.py

@@ -74,7 +74,7 @@ class LedgerPlugin(Plugin):
         )
         return render_result
 
-    @handler.command(command="ledger", block=False)
+    @handler.command(command="ledger", cookie=True, block=False)
     @handler.message(filters=filters.Regex("^开拓月历查询(.*)"), block=False)
     async def command_start(self, update: Update, context: CallbackContext) -> None:
         user_id = await self.get_real_user_id(update)

plugins/starrail/player_cards.py

@@ -108,8 +108,8 @@ class PlayerCards(Plugin):
                     uid = player_info.player_id
         return uid, ch_name
 
-    @handler.command(command="player_card", block=False)
-    @handler.message(filters=filters.Regex("^角色卡片查询(.*)"), block=False)
+    @handler.command(command="player_card", player=True, block=False)
+    @handler.message(filters=filters.Regex("^角色卡片查询(.*)"), player=True, block=False)
     async def player_cards(self, update: "Update", context: "ContextTypes.DEFAULT_TYPE") -> None:
         user_id = await self.get_real_user_id(update)
         message = update.effective_message

plugins/starrail/redeem.py

@@ -40,8 +40,8 @@ class Redeem(Plugin):
             msg = e.message
         return msg
 
-    @handler.command(command="redeem", block=False)
-    @handler.message(filters=filters.Regex("^兑换码兑换(.*)"), block=False)
+    @handler.command(command="redeem", cookie=True, block=False)
+    @handler.message(filters=filters.Regex("^兑换码兑换(.*)"), cookie=True, block=False)
     async def command_start(self, update: Update, context: CallbackContext) -> None:
         user_id = await self.get_real_user_id(update)
         message = update.effective_message

plugins/starrail/sign.py

@@ -58,8 +58,8 @@ class Sign(Plugin):
             await self.sign_service.add(user)
             return "开启自动签到成功"
 
-    @handler.command(command="sign", block=False)
-    @handler.message(filters=filters.Regex("^每日签到(.*)"), block=False)
+    @handler.command(command="sign", cookie=True, block=False)
+    @handler.message(filters=filters.Regex("^每日签到(.*)"), cookie=True, block=False)
     @handler.command(command="start", filters=filters.Regex("sign$"), block=False)
     async def command_start(self, update: Update, context: CallbackContext) -> None:
         user_id = await self.get_real_user_id(update)

plugins/starrail/stats.py

@@ -54,8 +54,8 @@ class PlayerStatsPlugins(Plugin):
                     uid = player_info.player_id
         return uid
 
-    @handler.command("stats", block=False)
-    @handler.message(filters.Regex("^玩家统计查询(.*)"), block=False)
+    @handler.command("stats", player=True, block=False)
+    @handler.message(filters.Regex("^玩家统计查询(.*)"), player=True, block=False)
     async def command_start(self, update: Update, context: CallbackContext) -> Optional[int]:
         user_id = await self.get_real_user_id(update)
         message = update.effective_message

plugins/tools/chat_administrators.py

@@ -0,0 +1,41 @@
+from typing import Union, Tuple, TYPE_CHECKING, List, Any
+
+from telegram import ChatMember
+
+try:
+    import ujson as jsonlib
+except ImportError:
+    import json as jsonlib
+
+
+if TYPE_CHECKING:
+    from redis import Redis
+
+    from telegram.ext import ContextTypes
+
+
+class ChatAdministrators:
+    QNAME = "plugin:group_captcha:chat_administrators"
+    TTL = 1 * 60 * 60
+
+    @staticmethod
+    async def get_chat_administrators(
+        cache: "Redis",
+        context: "ContextTypes.DEFAULT_TYPE",
+        chat_id: Union[str, int],
+    ) -> Union[Tuple[ChatMember, ...], Any]:
+        qname = f"{ChatAdministrators.QNAME}:{chat_id}"
+        result: "List[bytes]" = await cache.lrange(qname, 0, -1)
+        if len(result) > 0:
+            return ChatMember.de_list([jsonlib.loads(str(_data, encoding="utf-8")) for _data in result], context.bot)
+        chat_administrators = await context.bot.get_chat_administrators(chat_id)
+        async with cache.pipeline(transaction=True) as pipe:
+            for chat_administrator in chat_administrators:
+                await pipe.lpush(qname, chat_administrator.to_json())
+            await pipe.expire(qname, ChatAdministrators.TTL)
+            await pipe.execute()
+        return chat_administrators
+
+    @staticmethod
+    def is_admin(chat_administrators: Tuple[ChatMember], user_id: int) -> bool:
+        return any(admin.user.id == user_id for admin in chat_administrators)