feat: 更新鉴权方式，并增加群和好友发消息接口。 (#156)

* feat: 更新鉴权方式，并增加群和好友发送消息、富媒体消息接口
1. 更新鉴权方式：采用appid + 密钥
2. 增加群和好友发送消息(包括富媒体消息) 接口。
3. 修复发现的缩进问题

Author: MrLsz

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/ambv/black
-    rev: 21.12b0
+    rev: 23.11.0
     hooks:
       - id: black
         args: [-l 120]

botpy/api.py

@@ -22,7 +22,6 @@
     forum,
 )
 
-
 class BotAPI:
     """
     机器人相关的API接口类
@@ -195,11 +194,11 @@ async def get_guild_member(self, guild_id: str, user_id: str) -> user.Member:
         return await self._http.request(route)
 
     async def get_delete_member(
-            self,
-            guild_id: str,
-            user_id: str,
-            add_blacklist: bool = False,
-            delete_history_msg_days: int = 0
+        self,
+        guild_id: str,
+        user_id: str,
+        add_blacklist: bool = False,
+        delete_history_msg_days: int = 0
     ) -> str:
         """
         删除频道成员
@@ -248,8 +247,8 @@ async def get_guild_members(self, guild_id: str, after: str = "0", limit: int =
         )
         return await self._http.request(route, params=params)
 
-        async def get_guild_role_members(
-            self, guild_id: str, role_id: str, start_index: str = "0", limit: int = 1
+    async def get_guild_role_members(
+        self, guild_id: str, role_id: str, start_index: str = "0", limit: int = 1
     ) -> Dict[str, Union[List[user.Member], str]]:
         """
         获取频道身份组成员列表。
@@ -459,7 +458,7 @@ async def update_channel_role_permissions(
         Returns:
           成功执行返回`None`。
         """
-        payload = {"add": str(add.value)  if add else None, "remove": str(remove.value)  if remove else None}
+        payload = {"add": str(add.value) if add else None, "remove": str(remove.value) if remove else None}
 
         route = Route(
             "PUT", "/channels/{channel_id}/roles/{role_id}/permissions", channel_id=channel_id, role_id=role_id
@@ -1313,3 +1312,133 @@ async def delete_thread(self, channel_id: str, thread_id: str) -> str:
             "DELETE", "/channels/{channel_id}/threads/{thread_id}", channel_id=channel_id, thread_id=thread_id
         )
         return await self._http.request(route)
+    
+    async def post_group_message(
+        self,
+        group_openid: str,
+        msg_type: int = 0,
+        content: str = None,
+        embed: message.Embed = None,
+        ark: message.Ark = None,
+        message_reference: message.Reference = None,
+        media: message.Media = None,
+        msg_id: str = None,
+        event_id: str = None,
+        markdown: message.MarkdownPayload = None,
+        keyboard: message.Keyboard = None,
+    ) -> message.Message:
+        """
+        发送消息。
+
+        注意:
+        - 要求操作人在该群具有发送消息的权限。
+        - 发送成功之后，会触发一个创建消息的事件。
+        - 被动回复消息有效期为 5 分钟
+        - 发送消息接口要求机器人接口需要链接到websocket gateway 上保持在线状态
+
+        Args:
+          group_openid (str): 您要将消息发送到的群的 ID。
+          msg_type (int): 消息类型：0 是文本，1 图文混排，2 是 markdown，3 ark，4 embed，7 media 富媒体
+          content (str): 消息的文本内容。
+          embed (message.Embed): embed 消息，一种特殊的 ark
+          ark (message.Ark): ark 模版消息
+          message_reference (message.Reference): 对消息的引用。
+          media (message.Media): 富媒体消息
+          msg_id (str): 您要回复的消息的 ID。
+          event_id (str): 您要回复的消息的事件 ID。
+          markdown (message.MarkdownPayload): markdown 消息
+          keyboard (message.Keyboard): keyboard 消息
+
+        Returns:
+          message.Message: 一个消息字典对象。
+        """
+        payload = locals()
+        payload.pop("self", None)
+        route = Route("POST", "/v2/groups/{group_openid}/messages", group_openid=group_openid)
+        return await self._http.request(route, json=payload)
+
+    async def post_c2c_message(
+        self,
+        openid: str,
+        msg_type: int = 0,
+        content: str = None,
+        embed: message.Embed = None,
+        ark: message.Ark = None,
+        message_reference: message.Reference = None,
+        media: message.Media = None,
+        msg_id: str = None,
+        event_id: str = None,
+        markdown: message.MarkdownPayload = None,
+        keyboard: message.Keyboard = None,
+    ) -> message.Message:
+        """
+        发送消息。
+
+        注意:
+        - 要求操作人具有发送消息的权限。
+        - 发送成功之后，会触发一个创建消息的事件。
+        - 被动回复消息有效期为 5 分钟
+        - 发送消息接口要求机器人接口需要链接到websocket gateway 上保持在线状态
+
+        Args:
+          openid (str): 您要将消息发送到的用户的 ID。
+          msg_type (int): 消息类型：0 是文本，1 图文混排，2 是 markdown，3 ark，4 embed，7 media 富媒体
+          content (str): 消息的文本内容。
+          embed (message.Embed): embed 消息，一种特殊的 ark
+          ark (message.Ark): ark 模版消息
+          message_reference (message.Reference): 对消息的引用。
+          media (message.Media): 富媒体消息
+          msg_id (str): 您要回复的消息的 ID。
+          event_id (str): 您要回复的消息的事件 ID。
+          markdown (message.MarkdownPayload): markdown 消息
+          keyboard (message.Keyboard): keyboard 消息
+
+        Returns:
+          message.Message: 一个消息字典对象。
+        """
+        payload = locals()
+        payload.pop("self", None)
+        route = Route("POST", "/v2/users/{openid}/messages", openid=openid)
+        return await self._http.request(route, json=payload)
+
+    async def post_group_file(
+        self,
+        group_openid: str,
+        file_type: int,
+        url: str,
+        srv_send_msg: bool = False,
+    ) -> message.Media:
+        """
+        上传/发送群聊图片
+
+        Args:
+          file_type (int): 媒体类型：1 图片png/jpg，2 视频mp4，3 语音silk，4 文件（暂不开放）
+          url (str): 需要发送媒体资源的url
+          srv_send_msg (bool): 设置 true 会直接发送消息到目标端，且会占用主动消息频次
+        """
+        payload = locals()
+        payload.pop("self", None)
+        route = Route("POST", "/v2/groups/{group_openid}/files", group_openid=group_openid)
+        return await self._http.request(route, json=payload)
+
+    async def post_c2c_file(
+        self,
+        openid: str,
+        file_type: int,
+        url: str,
+        srv_send_msg: bool = False,
+    ) -> message.Media:
+        """
+        上传/发送c2c图片
+
+        Args:
+          file_type (int): 媒体类型：1 图片png/jpg，2 视频mp4，3 语音silk，4 文件（暂不开放）
+          url (str): 需要发送媒体资源的url
+          srv_send_msg (bool): 设置 true 会直接发送消息到目标端，且会占用主动消息频次
+        """
+        payload = locals()
+        payload.pop("self", None)
+        route = Route("POST", "/v2/users/{openid}/files", openid=openid)
+        return await self._http.request(route, json=payload)
+    
+

botpy/client.py

@@ -133,20 +133,20 @@ async def runner():
         except KeyboardInterrupt:
             return
 
-    async def start(self, appid: str, token: str, ret_coro: bool = False) -> Optional[Coroutine]:
+    async def start(self, appid: str, secret: str, ret_coro: bool = False) -> Optional[Coroutine]:
         """机器人开始执行
 
         参数
         ------------
         appid: :class:`str`
             机器人 appid
-        token: :class:`str`
-            机器人 token
+        secret: :class:`str`
+            机器人 secret
         ret_coro: :class:`bool`
             是否需要返回协程对象
         """
         # login后再进行后面的操作
-        token = Token(appid, token)
+        token = Token(appid, secret)
         self.ret_coro = ret_coro
 
         if self.loop is _loop:

botpy/connection.py

@@ -5,7 +5,7 @@
 from .channel import Channel
 from .guild import Guild
 from .interaction import Interaction
-from .message import Message, DirectMessage, MessageAudit
+from .message import C2CMessage, GroupMessage, Message, DirectMessage, MessageAudit
 from .user import Member
 from .reaction import Reaction
 from .audio import Audio, PublicAudio
@@ -200,6 +200,15 @@ def parse_public_message_delete(self, payload):
         _message = Message(self.api, payload.get('id', None), payload.get('d', {}))
         self._dispatch("public_message_delete", _message)
 
+     # botpy.flags.Intents.public_messages
+    def parse_group_at_message_create(self, payload):
+        _message = GroupMessage(self.api, payload.get("id", None), payload.get("d", {}))
+        self._dispatch("group_at_message_create", _message)
+
+    def parse_c2c_message_create(self, payload):
+        _message = C2CMessage(self.api, payload.get("id", None), payload.get("d", {}))
+        self._dispatch("c2c_message_create", _message)
+
     # botpy.flags.Intents.forums
     def parse_forum_thread_create(self, payload):
         _forum = Thread(self.api, payload.get('id', None), payload.get('d', {}))

botpy/ext/command_util.py

@@ -1,39 +1,30 @@
 # -*- coding: utf-8 -*-
 from functools import wraps
-from typing import Union
-
-from botpy import BotAPI
-from botpy.message import Message
+from botpy.message import BaseMessage
 
 
 class Commands:
     """
     指令装饰器
 
     Args:
-      name (Union[tuple, str]): 字符串元组或单个字符串。
+      args (tuple): 字符串元组。
     """
 
-    def __init__(self, name: Union[tuple, str]):
-        self.commands = name
+    def __init__(self, *args):
+        self.commands = args
 
     def __call__(self, func):
         @wraps(func)
         async def decorated(*args, **kwargs):
-            api: BotAPI = kwargs["api"]
-            message: Message = kwargs["message"]
-            if isinstance(self.commands, tuple):
-                for command in self.commands:
-                    if command in message.content:
-                        # 分割指令后面的指令参数
-                        params = message.content.split(command)[1].strip()
-                        return await func(api=api, message=message, params=params)
-            elif self.commands in message.content:
-                # 分割指令后面的指令参数
-                params = message.content.split(self.commands)[1].strip()
-                return await func(api=api, message=message, params=params)
-            else:
-                return False
+            message: BaseMessage = kwargs["message"]
+            for command in self.commands:
+                if command in message.content:
+                    # 分割指令后面的指令参数
+                    params = message.content.split(command)[1].strip()
+                    kwargs["params"] = params
+                    return await func(*args, **kwargs)
+            return False
 
         return decorated
 

botpy/flags.py

@@ -104,6 +104,7 @@ def __repr__(self) -> str:
 @fill_with_flags()
 class Intents(BaseFlags):
     """
+    public_messages 群/C2C公域消息事件
     public_guild_messages	公域消息事件
     guild_messages	消息事件 (仅 私域 机器人能够设置此 intents)
     direct_message	私信事件
@@ -139,6 +140,7 @@ def all(cls):
         self.guild_message_reactions = True
         self.direct_message = True
         self.message_audit = True
+        self.public_messages = True
         self.public_guild_messages = True
         self.audio_or_live_channel_member = True
         self.open_forum_event = True
@@ -315,7 +317,18 @@ def open_forum_event(self):
 
         """
         return 1 << 18
+    
+    @Flag
+    def public_messages(self):
+        """:class:`bool`: 是否打开公域群/C2C消息事件的监听.
+
+        通过增加`client`的`on_xx`事件可以获取事件下发的数据:
 
+        - :func:`on_group_at_message_create`            // 当收到群@机器人的消息时
+        - :func:`on_c2c_message_create`                 // 当收到c2c的消息时
+
+        """
+        return 1 << 25
 
 @fill_with_flags()
 class Permission(BaseFlags):

botpy/gateway.py

@@ -45,13 +45,17 @@ def __init__(self, session: Session, _connection: ConnectionSession):
         self._parser = _connection.parser
         self._can_reconnect = True
         self._INVALID_RECONNECT_CODE = [9001, 9005]
+        self._AUTH_FAIL_CODE = [4004]
 
     async def on_error(self, exception: BaseException):
         _log.error("[botpy] websocket连接: %s, 异常信息 : %s" % (self._conn, exception))
         traceback.print_exc()
 
     async def on_closed(self, close_status_code, close_msg):
         _log.info("[botpy] 关闭, 返回码: %s" % close_status_code + ", 返回信息: %s" % close_msg)
+        if close_status_code in self._AUTH_FAIL_CODE:
+            _log.info("[botpy] 鉴权失败，重置token...")
+            self._session["token"].access_token = None
         # 这种不能重新链接
         if close_status_code in self._INVALID_RECONNECT_CODE or not self._can_reconnect:
             _log.info("[botpy] 无法重连，创建新连接!")
@@ -134,7 +138,7 @@ async def ws_identify(self):
             self._session["intent"] = 1
 
         _log.info("[botpy] 鉴权中...")
-
+        await self._session["token"].check_token()
         payload = {
             "op": self.WS_IDENTITY,
             "d": {
@@ -167,7 +171,7 @@ async def ws_resume(self):
         websocket重连
         """
         _log.info("[botpy] 重连启动...")
-
+        await self._session["token"].check_token()
         payload = {
             "op": self.WS_RESUME,
             "d": {