AstrBot 3.5.6__py3-none-any.whl → 4.7.0__py3-none-any.whl

astrbot/core/platform/sources/slack/slack_adapter.py

@@ -0,0 +1,416 @@
+import asyncio
+import base64
+import re
+import time
+import uuid
+from collections.abc import Awaitable
+from typing import Any
+
+import aiohttp
+from slack_sdk.socket_mode.request import SocketModeRequest
+from slack_sdk.web.async_client import AsyncWebClient
+
+from astrbot.api import logger
+from astrbot.api.event import MessageChain
+from astrbot.api.message_components import *
+from astrbot.api.platform import (
+    AstrBotMessage,
+    MessageMember,
+    MessageType,
+    Platform,
+    PlatformMetadata,
+)
+from astrbot.core.platform.astr_message_event import MessageSesion
+
+from ...register import register_platform_adapter
+from .client import SlackSocketClient, SlackWebhookClient
+from .slack_event import SlackMessageEvent
+
+
+@register_platform_adapter(
+    "slack",
+    "适用于 Slack 的消息平台适配器，支持 Socket Mode 和 Webhook Mode。",
+    support_streaming_message=False,
+)
+class SlackAdapter(Platform):
+    def __init__(
+        self,
+        platform_config: dict,
+        platform_settings: dict,
+        event_queue: asyncio.Queue,
+    ) -> None:
+        super().__init__(event_queue)
+
+        self.config = platform_config
+        self.settings = platform_settings
+        self.unique_session = platform_settings.get("unique_session", False)
+
+        self.bot_token = platform_config.get("bot_token")
+        self.app_token = platform_config.get("app_token")
+        self.signing_secret = platform_config.get("signing_secret")
+        self.connection_mode = platform_config.get("slack_connection_mode", "socket")
+        self.webhook_host = platform_config.get("slack_webhook_host", "0.0.0.0")
+        self.webhook_port = platform_config.get("slack_webhook_port", 3000)
+        self.webhook_path = platform_config.get(
+            "slack_webhook_path",
+            "/astrbot-slack-webhook/callback",
+        )
+
+        if not self.bot_token:
+            raise ValueError("Slack bot_token 是必需的")
+
+        if self.connection_mode == "socket" and not self.app_token:
+            raise ValueError("Socket Mode 需要 app_token")
+
+        if self.connection_mode == "webhook" and not self.signing_secret:
+            raise ValueError("Webhook Mode 需要 signing_secret")
+
+        self.metadata = PlatformMetadata(
+            name="slack",
+            description="适用于 Slack 的消息平台适配器，支持 Socket Mode 和 Webhook Mode。",
+            id=self.config.get("id"),
+            support_streaming_message=False,
+        )
+
+        # 初始化 Slack Web Client
+        self.web_client = AsyncWebClient(token=self.bot_token, logger=logger)
+        self.socket_client = None
+        self.webhook_client = None
+
+        self.bot_self_id = None
+
+    async def send_by_session(
+        self,
+        session: MessageSesion,
+        message_chain: MessageChain,
+    ):
+        blocks, text = await SlackMessageEvent._parse_slack_blocks(
+            message_chain=message_chain,
+            web_client=self.web_client,
+        )
+
+        try:
+            if session.message_type == MessageType.GROUP_MESSAGE:
+                # 发送到频道
+                channel_id = (
+                    session.session_id.split("_")[-1]
+                    if "_" in session.session_id
+                    else session.session_id
+                )
+                await self.web_client.chat_postMessage(
+                    channel=channel_id,
+                    text=text,
+                    blocks=blocks if blocks else None,
+                )
+            else:
+                # 发送私信
+                await self.web_client.chat_postMessage(
+                    channel=session.session_id,
+                    text=text,
+                    blocks=blocks if blocks else None,
+                )
+        except Exception as e:
+            logger.error(f"Slack 发送消息失败: {e}")
+
+        await super().send_by_session(session, message_chain)
+
+    async def convert_message(self, event: dict) -> AstrBotMessage:
+        logger.debug(f"[slack] RawMessage {event}")
+
+        abm = AstrBotMessage()
+        abm.self_id = self.bot_self_id
+
+        # 获取用户信息
+        user_id = event.get("user", "")
+        try:
+            user_info = await self.web_client.users_info(user=user_id)
+            user_data = user_info["user"]
+            user_name = user_data.get("real_name") or user_data.get("name", user_id)
+        except Exception:
+            user_name = user_id
+
+        abm.sender = MessageMember(user_id=user_id, nickname=user_name)
+
+        # 判断消息类型
+        channel_id = event.get("channel", "")
+        try:
+            channel_info = await self.web_client.conversations_info(channel=channel_id)
+            is_im = channel_info["channel"]["is_im"]
+
+            if is_im:
+                abm.type = MessageType.FRIEND_MESSAGE
+            else:
+                abm.type = MessageType.GROUP_MESSAGE
+                abm.group_id = channel_id
+        except Exception:
+            # 默认作为群组消息处理
+            abm.type = MessageType.GROUP_MESSAGE
+            abm.group_id = channel_id
+
+        # 设置会话ID
+        if self.unique_session and abm.type == MessageType.GROUP_MESSAGE:
+            abm.session_id = f"{user_id}_{channel_id}"
+        else:
+            abm.session_id = (
+                channel_id if abm.type == MessageType.GROUP_MESSAGE else user_id
+            )
+
+        abm.message_id = event.get("client_msg_id", uuid.uuid4().hex)
+        abm.timestamp = int(float(event.get("ts", time.time())))
+
+        # 处理消息内容
+        message_text = event.get("text", "")
+        abm.message_str = message_text
+        abm.message = []
+
+        # 优先使用 blocks 字段解析消息
+        if event.get("blocks"):
+            abm.message = self._parse_blocks(event["blocks"])
+            # 更新 message_str
+            abm.message_str = ""
+            for component in abm.message:
+                if isinstance(component, Plain):
+                    abm.message_str += component.text
+        elif message_text:
+            # 处理传统的文本消息
+            if "<@" in message_text:
+                mentions = re.findall(r"<@([^>]+)>", message_text)
+                for mention in mentions:
+                    try:
+                        mentioned_user = await self.web_client.users_info(user=mention)
+                        user_data = mentioned_user["user"]
+                        user_name = user_data.get("real_name") or user_data.get(
+                            "name",
+                            mention,
+                        )
+                        abm.message.append(At(qq=mention, name=user_name))
+                    except Exception:
+                        abm.message.append(At(qq=mention, name=""))
+
+                # 清理消息文本中的@标记
+                if clean_text := re.sub(r"<@[^>]+>", "", message_text).strip():
+                    abm.message.append(Plain(text=clean_text))
+            else:
+                abm.message.append(Plain(text=message_text))
+
+        # 处理文件附件
+        if "files" in event:
+            for file_info in event["files"]:
+                file_name = file_info.get("name", "unknown")
+                file_url = file_info.get("url_private", "")
+                if file_info.get("mimetype", "").startswith("image/"):
+                    file_url = await self.get_file_base64(file_url)
+                    abm.message.append(Image.fromBase64(base64=file_url))
+                else:
+                    # TODO: 下载鉴权
+                    abm.message.append(
+                        File(name=file_name, file=file_url, url=file_url),
+                    )
+
+        abm.raw_message = event
+        return abm
+
+    def _parse_blocks(self, blocks: list) -> list:
+        """解析 Slack blocks 格式的消息内容"""
+        message_components = []
+
+        for block in blocks:
+            block_type = block.get("type", "")
+
+            if block_type == "rich_text":
+                # 处理富文本块
+                elements = block.get("elements", [])
+                for element in elements:
+                    if element.get("type") == "rich_text_section":
+                        # 处理富文本段落
+                        section_elements = element.get("elements", [])
+                        text_parts = []
+                        for section_element in section_elements:
+                            element_type = section_element.get("type", "")
+
+                            if element_type == "text":
+                                # 普通文本
+                                text_parts.append(section_element.get("text", ""))
+                            elif element_type == "user":
+                                # @用户提及
+                                user_id = section_element.get("user_id", "")
+                                if user_id:
+                                    # 将之前的文本内容先添加到组件中
+                                    text_content = "".join(text_parts)
+                                    if text_content.strip():
+                                        message_components.append(
+                                            Plain(text=text_content),
+                                        )
+                                    text_parts = []
+                                    # 添加@提及组件
+                                    message_components.append(At(qq=user_id, name=""))
+                            elif element_type == "channel":
+                                # #频道提及
+                                channel_id = section_element.get("channel_id", "")
+                                text_parts.append(f"#{channel_id}")
+                            elif element_type == "link":
+                                # 链接
+                                url = section_element.get("url", "")
+                                link_text = section_element.get("text", url)
+                                text_parts.append(f"[{link_text}]({url})")
+                            elif element_type == "emoji":
+                                # 表情符号
+                                emoji_name = section_element.get("name", "")
+                                text_parts.append(f":{emoji_name}:")
+
+                        text_content = "".join(text_parts)
+
+                        if text_content.strip():
+                            message_components.append(Plain(text=text_content))
+
+                    elif element.get("type") == "rich_text_list":
+                        # 处理列表
+                        list_items = element.get("elements", [])
+                        list_text = ""
+                        for item in list_items:
+                            if item.get("type") == "rich_text_section":
+                                item_elements = item.get("elements", [])
+                                item_text = ""
+                                for item_element in item_elements:
+                                    if item_element.get("type") == "text":
+                                        item_text += item_element.get("text", "")
+                                list_text += f"• {item_text}\n"
+
+                        if list_text.strip():
+                            message_components.append(Plain(text=list_text.strip()))
+
+            elif block_type == "section":
+                # 处理段落块
+                if "text" in block:
+                    text_obj = block["text"]
+                    if text_obj.get("type") == "mrkdwn":
+                        text_content = text_obj.get("text", "")
+                        message_components.append(Plain(text=text_content))
+
+        return message_components
+
+    async def _handle_socket_event(self, req: SocketModeRequest):
+        """处理 Socket Mode 事件"""
+        if req.type == "events_api":
+            # 事件 API
+            event = req.payload.get("event", {})
+
+            # 忽略机器人自己的消息和消息编辑
+            if event.get("subtype") in [
+                "bot_message",
+                "message_changed",
+                "message_deleted",
+            ]:
+                return
+
+            if event.get("bot_id"):
+                return
+
+            if event.get("type") in ["message", "app_mention"]:
+                abm = await self.convert_message(event)
+                if abm:
+                    await self.handle_msg(abm)
+
+    async def get_bot_user_id(self):
+        auth_info = await self.web_client.auth_test()
+        return auth_info.get("user_id")
+
+    async def get_file_base64(self, url: str) -> str:
+        """下载 Slack 文件并返回 Base64 编码的内容"""
+        headers = {"Authorization": f"Bearer {self.bot_token}"}
+        async with aiohttp.ClientSession() as session:
+            async with session.get(url, headers=headers) as resp:
+                if resp.status == 200:
+                    content = await resp.read()
+                    base64_content = base64.b64encode(content).decode("utf-8")
+                    return base64_content
+                logger.error(
+                    f"Failed to download slack file: {resp.status} {await resp.text()}",
+                )
+                raise Exception(f"下载文件失败: {resp.status}")
+
+    async def run(self) -> Awaitable[Any]:
+        self.bot_self_id = await self.get_bot_user_id()
+        logger.info(f"Slack auth test OK. Bot ID: {self.bot_self_id}")
+
+        if self.connection_mode == "socket":
+            if not self.app_token:
+                raise ValueError("Socket Mode 需要 app_token")
+
+            # 创建 Socket 客户端
+            self.socket_client = SlackSocketClient(
+                self.web_client,
+                self.app_token,
+                self._handle_socket_event,
+            )
+
+            logger.info("Slack 适配器 (Socket Mode) 启动中...")
+            await self.socket_client.start()
+
+        elif self.connection_mode == "webhook":
+            if not self.signing_secret:
+                raise ValueError("Webhook Mode 需要 signing_secret")
+
+            # 创建 Webhook 客户端
+            self.webhook_client = SlackWebhookClient(
+                self.web_client,
+                self.signing_secret,
+                self.webhook_host,
+                self.webhook_port,
+                self.webhook_path,
+                self._handle_webhook_event,
+            )
+
+            logger.info(
+                f"Slack 适配器 (Webhook Mode) 启动中，监听 {self.webhook_host}:{self.webhook_port}{self.webhook_path}...",
+            )
+            await self.webhook_client.start()
+
+        else:
+            raise ValueError(
+                f"不支持的连接模式: {self.connection_mode}，请使用 'socket' 或 'webhook'",
+            )
+
+    async def _handle_webhook_event(self, event_data: dict):
+        """处理 Webhook 事件"""
+        event = event_data.get("event", {})
+
+        # 忽略机器人自己的消息和消息编辑
+        if event.get("subtype") in [
+            "bot_message",
+            "message_changed",
+            "message_deleted",
+        ]:
+            return
+
+        if event.get("bot_id"):
+            return
+
+        if event.get("type") in ["message", "app_mention"]:
+            abm = await self.convert_message(event)
+            if abm:
+                await self.handle_msg(abm)
+
+    async def terminate(self):
+        if self.socket_client:
+            await self.socket_client.stop()
+        if self.webhook_client:
+            await self.webhook_client.stop()
+        logger.info("Slack 适配器已被优雅地关闭")
+
+    def meta(self) -> PlatformMetadata:
+        return self.metadata
+
+    async def handle_msg(self, message: AstrBotMessage):
+        message_event = SlackMessageEvent(
+            message_str=message.message_str,
+            message_obj=message,
+            platform_meta=self.meta(),
+            session_id=message.session_id,
+            web_client=self.web_client,
+        )
+
+        self.commit_event(message_event)
+
+    def get_client(self):
+        return self.web_client

astrbot/core/platform/sources/slack/slack_event.py

@@ -0,0 +1,253 @@
+import asyncio
+import re
+from collections.abc import AsyncGenerator
+
+from slack_sdk.web.async_client import AsyncWebClient
+
+from astrbot.api import logger
+from astrbot.api.event import AstrMessageEvent, MessageChain
+from astrbot.api.message_components import (
+    BaseMessageComponent,
+    File,
+    Image,
+    Plain,
+)
+from astrbot.api.platform import Group, MessageMember
+
+
+class SlackMessageEvent(AstrMessageEvent):
+    def __init__(
+        self,
+        message_str,
+        message_obj,
+        platform_meta,
+        session_id,
+        web_client: AsyncWebClient,
+    ):
+        super().__init__(message_str, message_obj, platform_meta, session_id)
+        self.web_client = web_client
+
+    @staticmethod
+    async def _from_segment_to_slack_block(
+        segment: BaseMessageComponent,
+        web_client: AsyncWebClient,
+    ) -> dict:
+        """将消息段转换为 Slack 块格式"""
+        if isinstance(segment, Plain):
+            return {"type": "section", "text": {"type": "mrkdwn", "text": segment.text}}
+        if isinstance(segment, Image):
+            # upload file
+            url = segment.url or segment.file
+            if url.startswith("http"):
+                return {
+                    "type": "image",
+                    "image_url": url,
+                    "alt_text": "图片",
+                }
+            path = await segment.convert_to_file_path()
+            response = await web_client.files_upload_v2(
+                file=path,
+                filename="image.jpg",
+            )
+            if not response["ok"]:
+                logger.error(f"Slack file upload failed: {response['error']}")
+                return {
+                    "type": "section",
+                    "text": {"type": "mrkdwn", "text": "图片上传失败"},
+                }
+            image_url = response["files"][0]["url_private"]
+            logger.debug(f"Slack file upload response: {response}")
+            return {
+                "type": "image",
+                "slack_file": {
+                    "url": image_url,
+                },
+                "alt_text": "图片",
+            }
+        if isinstance(segment, File):
+            # upload file
+            url = segment.url or segment.file
+            response = await web_client.files_upload_v2(
+                file=url,
+                filename=segment.name or "file",
+            )
+            if not response["ok"]:
+                logger.error(f"Slack file upload failed: {response['error']}")
+                return {
+                    "type": "section",
+                    "text": {"type": "mrkdwn", "text": "文件上传失败"},
+                }
+            file_url = response["files"][0]["permalink"]
+            return {
+                "type": "section",
+                "text": {
+                    "type": "mrkdwn",
+                    "text": f"文件: <{file_url}|{segment.name or '文件'}>",
+                },
+            }
+        return {"type": "section", "text": {"type": "mrkdwn", "text": str(segment)}}
+
+    @staticmethod
+    async def _parse_slack_blocks(
+        message_chain: MessageChain,
+        web_client: AsyncWebClient,
+    ):
+        """解析成 Slack 块格式"""
+        blocks = []
+        text_content = ""
+
+        for segment in message_chain.chain:
+            if isinstance(segment, Plain):
+                text_content += segment.text
+            else:
+                # 如果有文本内容，先添加文本块
+                if text_content.strip():
+                    blocks.append(
+                        {
+                            "type": "section",
+                            "text": {"type": "mrkdwn", "text": text_content},
+                        },
+                    )
+                    text_content = ""
+
+                # 添加其他类型的块
+                block = await SlackMessageEvent._from_segment_to_slack_block(
+                    segment,
+                    web_client,
+                )
+                blocks.append(block)
+
+        # 如果最后还有文本内容
+        if text_content.strip():
+            blocks.append(
+                {"type": "section", "text": {"type": "mrkdwn", "text": text_content}},
+            )
+
+        return blocks, "" if blocks else text_content
+
+    async def send(self, message: MessageChain):
+        blocks, text = await SlackMessageEvent._parse_slack_blocks(
+            message,
+            self.web_client,
+        )
+
+        try:
+            if self.get_group_id():
+                # 发送到频道
+                await self.web_client.chat_postMessage(
+                    channel=self.get_group_id(),
+                    text=text,
+                    blocks=blocks or None,
+                )
+            else:
+                # 发送私信
+                await self.web_client.chat_postMessage(
+                    channel=self.get_sender_id(),
+                    text=text,
+                    blocks=blocks or None,
+                )
+        except Exception:
+            # 如果块发送失败，尝试只发送文本
+            parts = []
+            for segment in message.chain:
+                if isinstance(segment, Plain):
+                    parts.append(segment.text)
+                elif isinstance(segment, File):
+                    parts.append(f" [文件: {segment.name}] ")
+                elif isinstance(segment, Image):
+                    parts.append(" [图片] ")
+            fallback_text = "".join(parts)
+
+            if self.get_group_id():
+                await self.web_client.chat_postMessage(
+                    channel=self.get_group_id(),
+                    text=fallback_text,
+                )
+            else:
+                await self.web_client.chat_postMessage(
+                    channel=self.get_sender_id(),
+                    text=fallback_text,
+                )
+
+        await super().send(message)
+
+    async def send_streaming(
+        self,
+        generator: AsyncGenerator,
+        use_fallback: bool = False,
+    ):
+        if not use_fallback:
+            buffer = None
+            async for chain in generator:
+                if not buffer:
+                    buffer = chain
+                else:
+                    buffer.chain.extend(chain.chain)
+            if not buffer:
+                return None
+            buffer.squash_plain()
+            await self.send(buffer)
+            return await super().send_streaming(generator, use_fallback)
+
+        buffer = ""
+        pattern = re.compile(r"[^。？！~…]+[。？！~…]+")
+
+        async for chain in generator:
+            if isinstance(chain, MessageChain):
+                for comp in chain.chain:
+                    if isinstance(comp, Plain):
+                        buffer += comp.text
+                        if any(p in buffer for p in "。？！~…"):
+                            buffer = await self.process_buffer(buffer, pattern)
+                    else:
+                        await self.send(MessageChain(chain=[comp]))
+                        await asyncio.sleep(1.5)  # 限速
+
+        if buffer.strip():
+            await self.send(MessageChain([Plain(buffer)]))
+        return await super().send_streaming(generator, use_fallback)
+
+    async def get_group(self, group_id=None, **kwargs):
+        if group_id:
+            channel_id = group_id
+        elif self.get_group_id():
+            channel_id = self.get_group_id()
+        else:
+            return None
+
+        try:
+            # 获取频道信息
+            channel_info = await self.web_client.conversations_info(channel=channel_id)
+
+            # 获取频道成员
+            members_response = await self.web_client.conversations_members(
+                channel=channel_id,
+            )
+
+            members = []
+            for member_id in members_response["members"]:
+                try:
+                    user_info = await self.web_client.users_info(user=member_id)
+                    user_data = user_info["user"]
+                    members.append(
+                        MessageMember(
+                            user_id=member_id,
+                            nickname=user_data.get("real_name")
+                            or user_data.get("name", member_id),
+                        ),
+                    )
+                except Exception:
+                    # 如果获取用户信息失败，使用默认信息
+                    members.append(MessageMember(user_id=member_id, nickname=member_id))
+
+            channel_data = channel_info["channel"]
+            return Group(
+                group_id=channel_id,
+                group_name=channel_data.get("name", ""),
+                group_avatar="",
+                group_admins=[],  # Slack 的管理员信息需要特殊权限获取
+                group_owner=channel_data.get("creator", ""),
+                members=members,
+            )
+        except Exception:
+            return None