feat: add telegram topics support

README.rst

@@ -565,6 +565,10 @@ e.g.:
     Enable this option if the bot API is running in ``--local`` mode and
     is using the same file system with ETM.
 
+-   ``topic_group`` *(str)* [Default: ``null``]
+
+    Send message to this topic group, per chat per topic
+
 Network configuration: timeout tweaks
 -------------------------------------
 

efb_telegram_master/__init__.py

@@ -128,6 +128,7 @@ def __init__(self, instance_id: InstanceID = None):
         self.commands: CommandsManager = CommandsManager(self)
         self.chat_binding: ChatBindingManager = ChatBindingManager(self)
         self.slave_messages: SlaveMessageProcessor = SlaveMessageProcessor(self)
+        self.topic_group: Optional[TelegramChatID] = TelegramChatID(self.flag('topic_group'))
 
         if not self.flag('auto_locale'):
             self.translator = translation("efb_telegram_master",
@@ -204,14 +205,47 @@ def info(self, update: Update, context: CallbackContext):
         assert isinstance(update, Update)
         assert isinstance(update.effective_message, Message)
         if update.effective_message.chat.type != telegram.Chat.PRIVATE:  # Group message
-            msg = self.info_group(update)
+            if update.effective_chat.is_forum:
+                msg = self.info_topic(update)
+            else:
+                msg = self.info_group(update)
         elif update.effective_message.forward_from_chat and \
                 update.effective_message.forward_from_chat.type == 'channel':  # Forwarded channel command.
             msg = self.info_channel(update)
         else:  # Talking to the bot.
             msg = self.info_general()
 
-        update.effective_message.reply_text(msg)
+        if len(msg) > 4095:
+            for x in range(0, len(msg), 4095):
+                update.effective_message.reply_text(msg[x:x+4095])
+        else:
+            update.effective_message.reply_text(msg)
+
+    def info_topic(self, update: Update):
+        """Generate string for chat linking info of a topic."""
+        assert isinstance(update, Update)
+        assert isinstance(update.effective_message, Message)
+
+        links = self.db.get_topic_slaves(topic_chat_id=update.effective_message.chat_id)
+        thread_id = update.effective_message.message_thread_id
+        if thread_id:
+            chat = None
+            for (dest, topic_id) in links:
+                if topic_id == thread_id:
+                    chat = dest
+                    break
+            if chat is None:
+                return "This chat is not managed by this bot"
+            else:
+                links = [chat]
+        else:
+            links = [c for c, t in links]
+
+        msg = self._("The topic {topic_name} ({topic_id}) is linked to:").format(
+            topic_name=update.effective_message.chat.title,
+            topic_id=update.effective_message.chat_id)
+        msg += self.build_link_chats_info_str(links)
+        return msg
 
     def info_general(self):
         """Generate string for information of the current running EFB instance."""
@@ -322,9 +356,10 @@ def start(self, update: Update, context: CallbackContext):
         assert isinstance(update.effective_message, telegram.Message)
         assert isinstance(update.effective_chat, telegram.Chat)
         if context.args:  # Group binding command
-            if update.effective_message.chat.type != telegram.Chat.PRIVATE or \
+            if (update.effective_message.chat.type != telegram.Chat.PRIVATE and update.effective_chat.id != self.topic_group) or \
                     (update.effective_message.forward_from_chat and
-                     update.effective_message.forward_from_chat.type == telegram.Chat.CHANNEL):
+                     update.effective_message.forward_from_chat.type == telegram.Chat.CHANNEL and
+                     update.effective_message.forward_from_chat.id != self.topic_group):
                 self.chat_binding.link_chat(update, context.args)
             else:
                 self.bot_manager.send_message(update.effective_chat.id,

efb_telegram_master/bot_manager.py

@@ -10,7 +10,7 @@
 import telegram.constants
 import telegram.error
 from retrying import retry
-from telegram import Update, InputFile, User, File
+from telegram import Update, InputFile, User, File, ForumTopic
 from telegram.ext import CallbackContext, Filters, MessageHandler, Updater, Dispatcher
 
 from .locale_handler import LocaleHandler
@@ -122,6 +122,28 @@ def caption_affix(self, *args, **kwargs):
 
             return caption_affix
 
+        @classmethod
+        def retry_on_topic_closed(cls, fn: Callable):
+            @wraps(fn)
+            def wrap(self: 'TelegramBotManager', *args, **kwargs):
+                try:
+                    return fn(self, *args, **kwargs)
+                except telegram.error.BadRequest as e:
+                    if "Topic_closed" in e.message:
+                        if 'chat_id' in kwargs:
+                            chat_id = kwargs['chat_id']
+                        else:
+                            chat_id = args[0]
+                        message_thread_id = kwargs.get('message_thread_id', None)
+                        self.reopen_forum_topic(
+                            chat_id=chat_id,
+                            message_thread_id=message_thread_id
+                        )
+                        return fn(self, *args, **kwargs)
+                    else:
+                        raise e
+            return wrap
+
         @classmethod
         def retry_on_chat_migration(cls, fn: Callable):
             @wraps(fn)
@@ -182,6 +204,7 @@ def __init__(self, channel: 'TelegramChannel'):
 
     @Decorators.retry_on_timeout
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def send_message(self, *args, prefix: str = '', suffix: str = '', **kwargs):
         """
         Send text message.
@@ -232,6 +255,7 @@ def send_message(self, *args, prefix: str = '', suffix: str = '', **kwargs):
 
     @Decorators.retry_on_timeout
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def edit_message_text(self, prefix='', suffix='', **kwargs):
         """
         Edit text message.
@@ -313,6 +337,7 @@ def _bot_edit_message_text_fallback(self, *args, **kwargs):
     @Decorators.retry_on_timeout
     @Decorators.caption_affix_decorator
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def send_audio(self, *args, **kwargs):
         """
         Send an audio file.
@@ -337,6 +362,7 @@ def send_audio(self, *args, **kwargs):
     @Decorators.retry_on_timeout
     @Decorators.caption_affix_decorator
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def send_voice(self, *args, **kwargs):
         """
         Send an voice message.
@@ -361,6 +387,7 @@ def send_voice(self, *args, **kwargs):
     @Decorators.retry_on_timeout
     @Decorators.caption_affix_decorator
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def send_video(self, *args, **kwargs):
         """
         Send an voice message.
@@ -385,6 +412,7 @@ def send_video(self, *args, **kwargs):
     @Decorators.retry_on_timeout
     @Decorators.caption_affix_decorator
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def send_document(self, *args, **kwargs):
         """
         Send a document.
@@ -404,6 +432,7 @@ def send_document(self, *args, **kwargs):
     @Decorators.retry_on_timeout
     @Decorators.caption_affix_decorator
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def send_animation(self, *args, **kwargs):
         """
         Send a document.
@@ -423,6 +452,7 @@ def send_animation(self, *args, **kwargs):
     @Decorators.retry_on_timeout
     @Decorators.caption_affix_decorator
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def send_photo(self, *args, **kwargs):
         """
         Send a document.
@@ -444,31 +474,40 @@ def send_photo(self, *args, **kwargs):
 
     @Decorators.retry_on_timeout
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def send_chat_action(self, *args, **kwargs):
+        message_thread_id = kwargs.pop('message_thread_id', None)
+        if message_thread_id != None:
+            kwargs['api_kwargs'] = { "message_thread_id":  message_thread_id}
         return self.updater.bot.send_chat_action(*args, **kwargs)
 
     @Decorators.retry_on_timeout
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def edit_message_reply_markup(self, *args, **kwargs):
         return self.updater.bot.edit_message_reply_markup(*args, **kwargs)
 
     @Decorators.retry_on_timeout
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def send_location(self, *args, **kwargs):
         return self.updater.bot.send_location(*args, **kwargs)
 
     @Decorators.retry_on_timeout
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def send_venue(self, *args, **kwargs):
         return self.updater.bot.send_venue(*args, **kwargs)
 
     @Decorators.retry_on_timeout
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def send_sticker(self, *args, **kwargs):
         return self.updater.bot.send_sticker(*args, **kwargs)
 
     @Decorators.retry_on_timeout
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def get_me(self, *args, **kwargs):
         return self.updater.bot.get_me(*args, **kwargs)
 
@@ -485,11 +524,13 @@ def session_expired(self, update: Update, context: CallbackContext):
     @Decorators.retry_on_timeout
     @Decorators.caption_affix_decorator
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def edit_message_caption(self, *args, **kwargs):
         return self.updater.bot.edit_message_caption(*args, **kwargs)
 
     @Decorators.retry_on_timeout
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def edit_message_media(self, *args, **kwargs):
         return self.updater.bot.edit_message_media(*args, **kwargs)
 
@@ -505,16 +546,19 @@ def reply_error(self, update, errmsg):
 
     @Decorators.retry_on_timeout
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def get_file(self, file_id: str) -> File:
         return self.updater.bot.get_file(file_id)
 
     @Decorators.retry_on_timeout
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def delete_message(self, chat_id, message_id):
         return self.updater.bot.delete_message(chat_id, message_id)
 
     @Decorators.retry_on_timeout
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def answer_callback_query(self, *args, prefix="", suffix="", text=None,
                               message_id=None, **kwargs):
         if text is None:
@@ -545,16 +589,41 @@ def answer_callback_query(self, *args, prefix="", suffix="", text=None,
 
     @Decorators.retry_on_timeout
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
+    def get_chat_info(self, *args, **kwargs):
+        return self.updater.bot.get_chat(*args, **kwargs)
+
+    @Decorators.retry_on_timeout
+    @Decorators.retry_on_chat_migration
+    def create_forum_topic(self, *args, **kwargs) -> ForumTopic:
+        return self.updater.bot.create_forum_topic(*args, **kwargs)
+
+    @Decorators.retry_on_timeout
+    @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
+    def edit_forum_topic(self, *args, **kwargs):
+        return self.updater.bot.edit_forum_topic(*args, **kwargs)
+
+    @Decorators.retry_on_timeout
+    @Decorators.retry_on_chat_migration
+    def reopen_forum_topic(self, *args, **kwargs) -> bool:
+        return self.updater.bot.reopen_forum_topic(*args, **kwargs)
+
+    @Decorators.retry_on_timeout
+    @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def set_chat_title(self, *args, **kwargs):
         return self.updater.bot.set_chat_title(*args, **kwargs)
 
     @Decorators.retry_on_timeout
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def set_chat_photo(self, *args, **kwargs):
         return self.updater.bot.set_chat_photo(*args, **kwargs)
 
     @Decorators.retry_on_timeout
     @Decorators.retry_on_chat_migration
+    @Decorators.retry_on_topic_closed
     def set_chat_description(self, *args, **kwargs):
         return self.updater.bot.set_chat_description(*args, **kwargs)