feat: Implement bot mention detection and improve message parsing in Telegram adapter

Author: lss233

framework/im/message.py

@@ -111,8 +111,8 @@ def to_plain(self):
     def __repr__(self):
         return f"ImageMessage(url={self.url}, path={self.path}, format={self.format})"
 
-
 # 定义@消息元素
+# :deprecated
 class AtElement(MessageElement):
 
     def __init__(self, user_id: str, nickname: str = ""):
@@ -128,6 +128,19 @@ def to_plain(self):
     def __repr__(self):
         return f"AtElement(user_id={self.user_id}, nickname={self.nickname})"
 
+# 定义@消息元素
+class MentionElement(MessageElement):
+    def __init__(self, target: ChatSender):
+        self.target = target
+
+    def to_dict(self):
+        return {"type": "mention", "data": {"target": self.target}}
+
+    def to_plain(self):
+        return f"@{self.target.display_name or self.target.user_id}"
+    
+    def __repr__(self):
+        return f"MentionElement(target={self.target})"
 
 # 定义回复消息元素
 class ReplyElement(MessageElement):

framework/im/sender.py

@@ -17,7 +17,7 @@ class ChatSender:
     chat_type: ChatType
     group_id: Optional[str] = None
     raw_metadata: Dict[str, Any] = None
-
+    
     @classmethod
     def from_group_chat(
         cls,
@@ -61,3 +61,13 @@ def __str__(self) -> str:
             return f"{self.group_id}:{self.user_id}"
         else:
             return f"c2c:{self.user_id}"
+        
+    def __eq__(self, other: Any) -> bool:
+        if isinstance(other, ChatSender):
+            return self.user_id == other.user_id and \
+                self.chat_type == other.chat_type and \
+                self.group_id == other.group_id
+        return False
+    
+    def __hash__(self) -> int:
+        return hash((self.user_id, self.chat_type, self.group_id))

framework/workflow/core/dispatch/registry.py

@@ -9,7 +9,7 @@
 
 from .models.dispatch_rules import CombinedDispatchRule, RuleGroup, SimpleDispatchRule
 from .rules.base import DispatchRule
-from .rules.message_rules import KeywordMatchRule, PrefixMatchRule, RegexMatchRule
+from .rules.message_rules import BotMentionMatchRule, KeywordMatchRule, PrefixMatchRule, RegexMatchRule
 from .rules.sender_rules import ChatSenderMatchRule, ChatSenderMismatchRule
 from .rules.system_rules import FallbackMatchRule, RandomChanceMatchRule
 
@@ -176,6 +176,7 @@ def save_rules(self, rules_dir: Optional[str] = None):
 DispatchRule.register_rule_type(RegexMatchRule)
 DispatchRule.register_rule_type(PrefixMatchRule)
 DispatchRule.register_rule_type(KeywordMatchRule)
+DispatchRule.register_rule_type(BotMentionMatchRule)
 DispatchRule.register_rule_type(RandomChanceMatchRule)
 DispatchRule.register_rule_type(ChatSenderMatchRule)
 DispatchRule.register_rule_type(ChatSenderMismatchRule)

framework/workflow/core/dispatch/rules/message_rules.py

@@ -4,6 +4,7 @@
 from pydantic import Field
 
 from framework.im.message import IMMessage
+from framework.im.sender import ChatSender
 from framework.workflow.core.workflow.registry import WorkflowRegistry
 
 from .base import DispatchRule, RuleConfig
@@ -77,4 +78,23 @@ def get_config(self) -> KeywordRuleConfig:
 
     @classmethod
     def from_config(cls, config: KeywordRuleConfig, workflow_registry: WorkflowRegistry, workflow_id: str) -> "KeywordMatchRule":
-        return cls(config.keywords, workflow_registry, workflow_id) 
+        return cls(config.keywords, workflow_registry, workflow_id)
+    
+class BotMentionMatchRule(DispatchRule):
+    """根据机器人被提及匹配的规则"""
+    config_class = RuleConfig
+    type_name = "bot_mention"
+
+    def __init__(self, workflow_registry: WorkflowRegistry, workflow_id: str):
+        super().__init__(workflow_registry, workflow_id)
+
+    def match(self, message: IMMessage) -> bool:
+        bot_sender = ChatSender.get_bot_sender()
+        return any(element.type == "mention" and element.target == bot_sender for element in message.message_elements)
+
+    def get_config(self) -> RuleConfig: 
+        return RuleConfig()
+
+    @classmethod
+    def from_config(cls, config: RuleConfig, workflow_registry: WorkflowRegistry, workflow_id: str) -> "BotMentionMatchRule":
+        return cls(workflow_registry, workflow_id)

plugins/im_telegram_adapter/adapter.py

@@ -4,11 +4,11 @@
 
 import telegramify_markdown
 from pydantic import BaseModel, ConfigDict, Field
-from telegram import Update, User
+from telegram import Bot, Update, User
 from telegram.ext import Application, CommandHandler, ContextTypes, MessageHandler, filters
 
 from framework.im.adapter import EditStateAdapter, IMAdapter, UserProfileAdapter
-from framework.im.message import ImageMessage, IMMessage, TextMessage, VoiceMessage
+from framework.im.message import ImageMessage, IMMessage, MentionElement, TextMessage, VoiceMessage
 from framework.im.profile import Gender, UserProfile
 from framework.im.sender import ChatSender, ChatType
 from framework.logger import get_logger
@@ -46,17 +46,17 @@ class TelegramAdapter(IMAdapter, UserProfileAdapter, EditStateAdapter):
     def __init__(self, config: TelegramConfig):
         self.config = config
         self.application = Application.builder().token(config.token).build()
-
+        self.bot = Bot(token=config.token)
         # 注册命令处理器和消息处理器
-        self.application.add_handler(CommandHandler("start", self.start))
+        self.application.add_handler(CommandHandler("start", self.command_start))
         self.application.add_handler(
             MessageHandler(
                 filters.TEXT | filters.VOICE | filters.PHOTO, self.handle_message
             )
         )
         self.logger = get_logger("Telegram-Adapter")
 
-    async def start(self, update: Update, context: ContextTypes.DEFAULT_TYPE):
+    async def command_start(self, update: Update, context: ContextTypes.DEFAULT_TYPE):
         """处理 /start 命令"""
         await update.message.reply_text("Welcome! I am ready to receive your messages.")
 
@@ -94,11 +94,41 @@ def convert_to_message(self, raw_message: Update) -> IMMessage:
 
         message_elements = []
         raw_message_dict = raw_message.message.to_dict()
-
         # 处理文本消息
         if raw_message.message.text:
-            text_element = TextMessage(text=raw_message.message.text)
-            message_elements.append(text_element)
+            text = raw_message.message.text
+            offset = 0
+            for entity in raw_message.message.entities or []:
+                if entity.type in ("mention", "text_mention"):
+                    # Extract mention text
+                    mention_text = text[entity.offset:entity.offset + entity.length]
+
+                    # Add preceding text as TextMessage
+                    if entity.offset > offset:
+                        message_elements.append(TextMessage(text=text[offset:entity.offset]))
+
+                    # Create ChatSender for MentionElement
+                    if entity.type == "text_mention" and entity.user:
+                        if entity.user.id == self.me.id:
+                            mention_element = MentionElement(target=ChatSender.get_bot_sender())
+                        else:
+                            mention_element = MentionElement(target=ChatSender.from_c2c_chat(user_id=entity.user.id, display_name=mention_text))
+                    elif entity.type == "mention":
+                        # 这里需要从 adapter 实例中获取 bot 的 username
+                        if mention_text == f'@{self.me.username}':
+                            mention_element = MentionElement(target=ChatSender.get_bot_sender())
+                        else:
+                            mention_element = MentionElement(target=ChatSender.from_c2c_chat(user_id=f'unknown_id:{mention_text}', display_name=mention_text))
+                    else:
+                        # Fallback in case of unknown entity type
+                        mention_element = TextMessage(text=mention_text)  # Or handle as needed
+                    message_elements.append(mention_element)
+
+                    offset = entity.offset + entity.length
+
+            # Add remaining text as TextMessage
+            if offset < len(text):
+                message_elements.append(TextMessage(text=text[offset:]))
 
         # 处理语音消息
         if raw_message.message.voice:
@@ -115,13 +145,14 @@ def convert_to_message(self, raw_message: Update) -> IMMessage:
             photo_url = photo_file.file_path
             photo_element = ImageMessage(url=photo_url)
             message_elements.append(photo_element)
-
+            
         # 创建 Message 对象
         message = IMMessage(
             sender=sender,
             message_elements=message_elements,
             raw_message=raw_message_dict,
         )
+        print(message)
         return message
 
     async def send_message(self, message: IMMessage, recipient: ChatSender):
@@ -171,6 +202,7 @@ async def start(self):
         """启动 Bot"""
         await self.application.initialize()
         await self.application.start()
+        self.me = await self.bot.get_me()
         await self.application.updater.start_polling(drop_pending_updates=True)
 
     async def stop(self):

tests/workflow_executor/test_workflow_basic.py

@@ -1,6 +1,5 @@
 
-from framework.workflow.core.block import Block
-from framework.workflow.core.block.input_output import Input, Output
+from framework.workflow.core.block import Block, Input, Output
 from framework.workflow.core.workflow import Wire, Workflow
 
 # Define test blocks