From a661f24ae006189db106eb946b1d0fc4f53d577e Mon Sep 17 00:00:00 2001 From: Junyan Qin Date: Wed, 29 Jan 2025 16:53:09 +0800 Subject: [PATCH 1/4] doc: add contributors graph --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index c434c574..4a797659 100644 --- a/README.md +++ b/README.md @@ -100,3 +100,12 @@ | [Dify](https://dify.ai) | ✅ | LLMOps 平台 | | [Ollama](https://ollama.com/) | ✅ | 本地大模型管理平台 | | [GiteeAI](https://ai.gitee.com/) | ✅ | 大模型接口聚合平台 | + +## 😘 社区贡献 + +LangBot 离不开以下贡献者和社区内所有人的贡献，我们欢迎任何形式的贡献和反馈。 + + + + + \ No newline at end of file From ea254d57d236f2f3ecdbba0af7bb20b811ca1af1 Mon Sep 17 00:00:00 2001 From: Junyan Qin Date: Wed, 29 Jan 2025 23:31:40 +0800 Subject: [PATCH 2/4] feat: lark adapter --- pkg/core/bootutils/deps.py | 3 +- pkg/platform/manager.py | 2 +- pkg/platform/sources/lark.py | 404 ++++++++++++++++++++++++++++++++++ pkg/platform/types/message.py | 4 +- requirements.txt | 1 + 5 files changed, 410 insertions(+), 4 deletions(-) create mode 100644 pkg/platform/sources/lark.py diff --git a/pkg/core/bootutils/deps.py b/pkg/core/bootutils/deps.py index 9eed13d8..a31441bc 100644 --- a/pkg/core/bootutils/deps.py +++ b/pkg/core/bootutils/deps.py @@ -25,7 +25,8 @@ required_deps = { "aioshutil": "aioshutil", "argon2": "argon2-cffi", "jwt": "pyjwt", - "Crypto": "pycryptodome" + "Crypto": "pycryptodome", + "lark_oapi": "lark-oapi" } diff --git a/pkg/platform/manager.py b/pkg/platform/manager.py index f8809750..b68f1f43 100644 --- a/pkg/platform/manager.py +++ b/pkg/platform/manager.py @@ -37,7 +37,7 @@ class PlatformManager: async def initialize(self): - from .sources import nakuru, aiocqhttp, qqbotpy,wecom + from .sources import nakuru, aiocqhttp, qqbotpy, wecom, lark async def on_friend_message(event: platform_events.FriendMessage, adapter: msadapter.MessageSourceAdapter): diff --git a/pkg/platform/sources/lark.py b/pkg/platform/sources/lark.py new file mode 100644 index 00000000..4d630ae9 --- /dev/null +++ b/pkg/platform/sources/lark.py @@ -0,0 +1,404 @@ +from __future__ import annotations + +import lark_oapi + +import typing +import asyncio +import traceback +import time +import re +import base64 +import uuid +import json +import datetime + +import aiohttp +import lark_oapi.ws.exception +from lark_oapi.api.im.v1 import * + +from .. import adapter +from ...pipeline.longtext.strategies import forward +from ...core import app +from ..types import message as platform_message +from ..types import events as platform_events +from ..types import entities as platform_entities +from ...utils import image + + +class LarkMessageConverter(adapter.MessageConverter): + + @staticmethod + async def yiri2target( + message_chain: platform_message.MessageChain, api_client: lark_oapi.Client + ) -> typing.Tuple[list]: + message_elements = [] + + pending_paragraph = [] + + for msg in message_chain: + if isinstance(msg, platform_message.Plain): + pending_paragraph.append({"tag": "md", "text": msg.text}) + elif isinstance(msg, platform_message.At): + pending_paragraph.append( + {"tag": "at", "user_id": msg.target, "style": []} + ) + elif isinstance(msg, platform_message.AtAll): + pending_paragraph.append({"tag": "at", "user_id": "all", "style": []}) + elif isinstance(msg, platform_message.Image): + + image_bytes = None + + if msg.base64: + image_bytes = base64.b64decode(msg.base64) + elif msg.url: + async with aiohttp.ClientSession() as session: + async with session.get(msg.url) as response: + image_bytes = await response.read() + elif msg.path: + with open(msg.path, "rb") as f: + image_bytes = f.read() + + request: CreateImageRequest = ( + CreateImageRequest.builder() + .request_body( + CreateImageRequestBody.builder() + .image_type("message") + .image(image_bytes) + .build() + ) + .build() + ) + + response: CreateImageResponse = await api_client.im.v1.image.acreate( + request + ) + + if not response.success(): + raise Exception( + f"client.im.v1.image.create failed, code: {response.code}, msg: {response.msg}, log_id: {response.get_log_id()}, resp: \n{json.dumps(json.loads(response.raw.content), indent=4, ensure_ascii=False)}" + ) + + image_key = response.data.image_key + + message_elements.append(pending_paragraph) + message_elements.append( + [ + { + "tag": "img", + "image_key": image_key, + } + ] + ) + pending_paragraph = [] + + if pending_paragraph: + message_elements.append(pending_paragraph) + + return message_elements + + @staticmethod + async def target2yiri( + message: lark_oapi.api.im.v1.model.event_message.EventMessage, + api_client: lark_oapi.Client, + ) -> platform_message.MessageChain: + message_content = json.loads(message.content) + + lb_msg_list = [] + + msg_create_time = datetime.datetime.fromtimestamp( + int(message.create_time) / 1000 + ) + + lb_msg_list.append( + platform_message.Source(id=message.message_id, time=msg_create_time) + ) + + if message.message_type == "text": + element_list = [] + + def text_element_recur(text_ele: dict) -> list[dict]: + if text_ele["text"] == "": + return [] + + at_pattern = re.compile(r"@_user_[\d]+") + at_matches = at_pattern.findall(text_ele["text"]) + + name_mapping = {} + for mathc in at_matches: + for mention in message.mentions: + if mention.key == mathc: + name_mapping[mathc] = mention.name + break + + if len(name_mapping.keys()) == 0: + return [text_ele] + + # 只处理第一个，剩下的递归处理 + text_split = text_ele["text"].split(list(name_mapping.keys())[0]) + + new_list = [] + + left_text = text_split[0] + right_text = text_split[1] + + new_list.extend( + text_element_recur({"tag": "text", "text": left_text, "style": []}) + ) + + new_list.append( + { + "tag": "at", + "user_id": list(name_mapping.keys())[0], + "user_name": name_mapping[list(name_mapping.keys())[0]], + "style": [], + } + ) + + new_list.extend( + text_element_recur({"tag": "text", "text": right_text, "style": []}) + ) + + return new_list + + element_list = text_element_recur( + {"tag": "text", "text": message_content["text"], "style": []} + ) + + message_content = {"title": "", "content": element_list} + + elif message.message_type == "post": + new_list = [] + + for ele in message_content["content"]: + if type(ele) is dict: + new_list.append(ele) + elif type(ele) is list: + new_list.extend(ele) + + message_content["content"] = new_list + elif message.message_type == "image": + message_content["content"] = [ + {"tag": "img", "image_key": message_content["image_key"], "style": []} + ] + + for ele in message_content["content"]: + if ele["tag"] == "text": + lb_msg_list.append(platform_message.Plain(text=ele["text"])) + elif ele["tag"] == "at": + lb_msg_list.append(platform_message.At(target=ele["user_name"])) + elif ele["tag"] == "img": + image_key = ele["image_key"] + + request: GetMessageResourceRequest = ( + GetMessageResourceRequest.builder() + .message_id(message.message_id) + .file_key(image_key) + .type("image") + .build() + ) + + response: GetMessageResourceResponse = ( + await api_client.im.v1.message_resource.aget(request) + ) + + if not response.success(): + raise Exception( + f"client.im.v1.message_resource.get failed, code: {response.code}, msg: {response.msg}, log_id: {response.get_log_id()}, resp: \n{json.dumps(json.loads(response.raw.content), indent=4, ensure_ascii=False)}" + ) + + image_bytes = response.file.read() + image_base64 = base64.b64encode(image_bytes).decode() + + image_format = response.raw.headers["content-type"] + + lb_msg_list.append( + platform_message.Image( + base64=f"data:{image_format};base64,{image_base64}" + ) + ) + + return platform_message.MessageChain(lb_msg_list) + + +class LarkEventConverter(adapter.EventConverter): + + @staticmethod + async def yiri2target( + event: platform_events.MessageEvent, + ) -> lark_oapi.im.v1.P2ImMessageReceiveV1: + pass + + @staticmethod + async def target2yiri( + event: lark_oapi.im.v1.P2ImMessageReceiveV1, api_client: lark_oapi.Client + ) -> platform_events.Event: + message_chain = await LarkMessageConverter.target2yiri( + event.event.message, api_client + ) + + if event.event.message.chat_type == "p2p": + return platform_events.FriendMessage( + sender=platform_entities.Friend( + id=event.event.sender.sender_id.open_id, + nickname=event.event.sender.sender_id.union_id, + remark="", + ), + message_chain=message_chain, + time=event.event.message.create_time, + ) + elif event.event.message.chat_type == "group": + return platform_events.GroupMessage( + sender=platform_entities.GroupMember( + id=event.event.sender.sender_id.open_id, + member_name=event.event.sender.sender_id.union_id, + permission=platform_entities.Permission.Member, + group=platform_entities.Group( + id=event.event.message.chat_id, + name="", + permission=platform_entities.Permission.Member, + ), + special_title="", + join_timestamp=0, + last_speak_timestamp=0, + mute_time_remaining=0, + ), + message_chain=message_chain, + time=event.event.message.create_time, + ) + + +@adapter.adapter_class("lark") +class LarkMessageSourceAdapter(adapter.MessageSourceAdapter): + + bot: lark_oapi.ws.Client + api_client: lark_oapi.Client + + bot_account_id: str # 用于在流水线中识别at是否是本bot，直接以bot_name作为标识 + lark_tenant_key: str # 飞书企业key + + message_converter: LarkMessageConverter = LarkMessageConverter() + event_converter: LarkEventConverter = LarkEventConverter() + + listeners: typing.Dict[ + typing.Type[platform_events.Event], + typing.Callable[[platform_events.Event, adapter.MessageSourceAdapter], None], + ] = {} + + config: dict + + ap: app.Application + + def __init__(self, config: dict, ap: app.Application): + self.config = config + self.ap = ap + + async def on_message(event: lark_oapi.im.v1.P2ImMessageReceiveV1): + + lb_event = await self.event_converter.target2yiri(event, self.api_client) + + await self.listeners[type(lb_event)](lb_event, self) + + def sync_on_message(event: lark_oapi.im.v1.P2ImMessageReceiveV1): + asyncio.create_task(on_message(event)) + + event_handler = ( + lark_oapi.EventDispatcherHandler.builder("", "") + .register_p2_im_message_receive_v1(sync_on_message) + .build() + ) + + self.bot_account_id = config["bot_name"] + + self.bot = lark_oapi.ws.Client( + config["app_id"], config["app_secret"], event_handler=event_handler + ) + self.api_client = ( + lark_oapi.Client.builder() + .app_id(config["app_id"]) + .app_secret(config["app_secret"]) + .build() + ) + + async def send_message( + self, target_type: str, target_id: str, message: platform_message.MessageChain + ): + pass + + async def reply_message( + self, + message_source: platform_events.MessageEvent, + message: platform_message.MessageChain, + quote_origin: bool = False, + ): + + # 不再需要了，因为message_id已经被包含到message_chain中 + # lark_event = await self.event_converter.yiri2target(message_source) + lark_message = await self.message_converter.yiri2target( + message, self.api_client + ) + + final_content = { + "zh_cn": { + "title": "", + "content": lark_message, + }, + } + + request: ReplyMessageRequest = ( + ReplyMessageRequest.builder() + .message_id(message_source.message_chain.message_id) + .request_body( + ReplyMessageRequestBody.builder() + .content(json.dumps(final_content)) + .msg_type("post") + .reply_in_thread(False) + .uuid(str(uuid.uuid4())) + .build() + ) + .build() + ) + + response: ReplyMessageResponse = await self.api_client.im.v1.message.areply( + request + ) + + if not response.success(): + raise Exception( + f"client.im.v1.message.reply failed, code: {response.code}, msg: {response.msg}, log_id: {response.get_log_id()}, resp: \n{json.dumps(json.loads(response.raw.content), indent=4, ensure_ascii=False)}" + ) + + async def is_muted(self, group_id: int) -> bool: + return False + + def register_listener( + self, + event_type: typing.Type[platform_events.Event], + callback: typing.Callable[ + [platform_events.Event, adapter.MessageSourceAdapter], None + ], + ): + self.listeners[event_type] = callback + + def unregister_listener( + self, + event_type: typing.Type[platform_events.Event], + callback: typing.Callable[ + [platform_events.Event, adapter.MessageSourceAdapter], None + ], + ): + self.listeners.pop(event_type) + + async def run_async(self): + try: + await self.bot._connect() + except lark_oapi.ws.exception.ClientException as e: + raise e + except Exception as e: + await self.bot._disconnect() + if self.bot._auto_reconnect: + await self.bot._reconnect() + else: + raise e + + async def kill(self) -> bool: + return False diff --git a/pkg/platform/types/message.py b/pkg/platform/types/message.py index 45d37a41..aad239d8 100644 --- a/pkg/platform/types/message.py +++ b/pkg/platform/types/message.py @@ -460,7 +460,7 @@ class Source(MessageComponent): """源。包含消息的基本信息。""" type: str = "Source" """消息组件类型。""" - id: int + id: typing.Union[int, str] """消息的识别号，用于引用回复（Source 类型永远为 MessageChain 的第一个元素）。""" time: datetime """消息时间。""" @@ -503,7 +503,7 @@ class At(MessageComponent): """At某人。""" type: str = "At" """消息组件类型。""" - target: int + target: typing.Union[int, str] """群员 QQ 号。""" display: typing.Optional[str] = None """At时显示的文字，发送消息时无效，自动使用群名片。""" diff --git a/requirements.txt b/requirements.txt index 845ae48c..fe75198d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -25,6 +25,7 @@ aioshutil argon2-cffi pyjwt pycryptodome +lark-oapi # indirect taskgroup==0.0.0a4 \ No newline at end of file From ac9cef82cc32f1963d1381d2d52d02f92a9979e9 Mon Sep 17 00:00:00 2001 From: Junyan Qin Date: Wed, 29 Jan 2025 23:41:29 +0800 Subject: [PATCH 3/4] chore: migrations --- README.md | 3 +- pkg/core/migrations/m021_lark_config.py | 29 ++++++++ templates/platform.json | 7 ++ templates/schema/platform.json | 92 +++++++++++++++++++++++++ 4 files changed, 130 insertions(+), 1 deletion(-) create mode 100644 pkg/core/migrations/m021_lark_config.py diff --git a/README.md b/README.md index 4a797659..c7fb4d43 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ ## ✨ Features -- 💬 大模型对话、Agent：支持多种大模型，适配群聊和私聊；具有多轮对话、工具调用、多模态能力，并深度适配 [Dify](https://dify.ai)。目前支持 QQ、QQ频道、企业微信，后续还将支持微信、WhatsApp、Discord等平台。 +- 💬 大模型对话、Agent：支持多种大模型，适配群聊和私聊；具有多轮对话、工具调用、多模态能力，并深度适配 [Dify](https://dify.ai)。目前支持 QQ、QQ频道、企业微信、飞书，后续还将支持微信、WhatsApp、Discord等平台。 - 🛠️ 高稳定性、功能完备：原生支持访问控制、限速、敏感词过滤等机制；配置简单，支持多种部署方式。 - 🧩 插件扩展、活跃社区：支持事件驱动、组件扩展等插件机制；丰富生态，目前已有数十个[插件](https://docs.langbot.app/plugin/plugin-intro.html) - 😻 [New] Web 管理面板：支持通过浏览器管理 LangBot 实例，具体支持功能，查看[文档](https://docs.langbot.app/webui/intro.html) @@ -83,6 +83,7 @@ | QQ 个人号 | ✅ | QQ 个人号私聊、群聊 | | QQ 官方机器人 | ✅ | QQ 频道机器人，支持频道、私聊、群聊 | | 企业微信 | ✅ | | +| 飞书 | ✅ | | | 钉钉 | 🚧 | | 🚧: 正在开发中 diff --git a/pkg/core/migrations/m021_lark_config.py b/pkg/core/migrations/m021_lark_config.py new file mode 100644 index 00000000..04c83caf --- /dev/null +++ b/pkg/core/migrations/m021_lark_config.py @@ -0,0 +1,29 @@ +from __future__ import annotations + +from .. import migration + + +@migration.migration_class("lark-config", 21) +class LarkConfigMigration(migration.Migration): + """迁移""" + + async def need_migrate(self) -> bool: + """判断当前环境是否需要运行此迁移""" + + for adapter in self.ap.platform_cfg.data['platform-adapters']: + if adapter['adapter'] == 'lark': + return False + + return True + + async def run(self): + """执行迁移""" + self.ap.platform_cfg.data['platform-adapters'].append({ + "adapter": "lark", + "enable": False, + "app_id": "cli_abcdefgh", + "app_secret": "XXXXXXXXXX", + "bot_name": "LangBot" + }) + + await self.ap.platform_cfg.dump_config() diff --git a/templates/platform.json b/templates/platform.json index 299656fd..b440264b 100644 --- a/templates/platform.json +++ b/templates/platform.json @@ -35,6 +35,13 @@ "token": "", "EncodingAESKey": "", "contacts_secret": "" + }, + { + "adapter": "lark", + "enable": false, + "app_id": "cli_abcdefgh", + "app_secret": "XXXXXXXXXX", + "bot_name": "LangBot" } ], "track-function-calls": true, diff --git a/templates/schema/platform.json b/templates/schema/platform.json index 074c9ae2..900623b8 100644 --- a/templates/schema/platform.json +++ b/templates/schema/platform.json @@ -121,6 +121,98 @@ ] } } + }, + { + "title": "企业微信适配器", + "description": "用于接入企业微信", + "properties": { + "adapter": { + "type": "string", + "const": "wecom" + }, + "enable": { + "type": "boolean", + "default": false, + "description": "是否启用此适配器", + "layout": { + "comp": "switch", + "props": { + "color": "primary" + } + } + }, + "host": { + "type": "string", + "default": "0.0.0.0", + "description": "监听的IP地址" + }, + "port": { + "type": "integer", + "default": 2290, + "description": "监听的端口" + }, + "corpid": { + "type": "string", + "default": "", + "description": "企业微信的corpid" + }, + "secret": { + "type": "string", + "default": "", + "description": "企业微信的secret" + }, + "token": { + "type": "string", + "default": "", + "description": "企业微信的token" + }, + "EncodingAESKey": { + "type": "string", + "default": "", + "description": "企业微信的EncodingAESKey" + }, + "contacts_secret": { + "type": "string", + "default": "", + "description": "企业微信的contacts_secret" + } + } + }, + { + "title": "飞书适配器", + "description": "用于接入飞书", + "properties": { + "adapter": { + "type": "string", + "const": "lark" + }, + "enable": { + "type": "boolean", + "default": false, + "description": "是否启用此适配器", + "layout": { + "comp": "switch", + "props": { + "color": "primary" + } + } + }, + "app_id": { + "type": "string", + "default": "", + "description": "飞书的app_id" + }, + "app_secret": { + "type": "string", + "default": "", + "description": "飞书的app_secret" + }, + "bot_name": { + "type": "string", + "default": "", + "description": "飞书的bot_name" + } + } } ] } From c326e72758d0636cfa5db96a24e7dcd586ffedf9 Mon Sep 17 00:00:00 2001 From: Junyan Qin Date: Wed, 29 Jan 2025 23:43:32 +0800 Subject: [PATCH 4/4] fix: migration not imported --- pkg/core/stages/migrate.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg/core/stages/migrate.py b/pkg/core/stages/migrate.py index 5d96d6da..0b0d8c3c 100644 --- a/pkg/core/stages/migrate.py +++ b/pkg/core/stages/migrate.py @@ -8,7 +8,7 @@ from ..migrations import m001_sensitive_word_migration, m002_openai_config_migra from ..migrations import m005_deepseek_cfg_completion, m006_vision_config, m007_qcg_center_url, m008_ad_fixwin_config_migrate, m009_msg_truncator_cfg from ..migrations import m010_ollama_requester_config, m011_command_prefix_config, m012_runner_config, m013_http_api_config, m014_force_delay_config from ..migrations import m015_gitee_ai_config, m016_dify_service_api, m017_dify_api_timeout_params, m018_xai_config, m019_zhipuai_config -from ..migrations import m020_wecom_config +from ..migrations import m020_wecom_config, m021_lark_config @stage.stage_class("MigrationStage")