1.3.2-dev.reauth.1: EWS — WeChat Reauth Concept

EWS New flags: "qr_reload", "on_log_out"

Author: blueset

docs/EWS.md

@@ -104,8 +104,16 @@ eh_wechat_slave = {
   List out all other messages (more than first one) for link messages with more than one link from MPS accounts.
 * `max_quote_length` _(int)_  [Default: `-1`]  
   Maximum length of text for quotation messages. Set to 0 to fully disable quotation. Set to -1 to always quote full message.
-* `qr_target` _(string)_ [Default: `"console"`]
-  The target channel which should receive a QR code to login the Wechat account.
+* `qr_reload` _(str)_  [Default: `"master_qr_code"`]  
+  Method to display QR code during reauthentication.  
   Available values:
-    * `"console"`: the command line interface
-    * `"master"`: the master channel
+    * `"console_qr_code"`: QR code is printed to the console or log, depend on the logger setting.
+    * `"master_qr_code"`: QR code is sent to the master channel as system message.
+  !!! note
+      The QR code refreshes every 5 to 10 seconds, be aware that sending system messages may lead to flood of message in your conversation.
+* `on_log_out` _(str)_  [Default: `"command"`]  
+  Behavior when WeChat server logs out the user.  
+    Available values:
+    * `"idle"`: Notify the user, then do nothing.
+    * `"reauth"`: Notify the user, then immediately start reauthentication.
+    * `"command"`: Notify the user, then send the user a command message to trigger reauthentication process.

docs/channel.md

@@ -34,17 +34,17 @@ Methods below are required to be implemented for respective channel types noted,
 
 **__init__(self, queue)** _(for slave channels)_  
 **__init__(self, queue, slaves)** _(for master channels)_  
-Initialize the channel and log in the account (if necessary) with in this method. `super().__init__(queue)` must always be called in the beginning.
+Initialize the channel with in this method. `super().__init__(queue)` must always be called in the beginning.
 
 Args:
 
 * `queue` (queue.Queue): Global message queue, used for message delivery from slave channels to the master channel.
 * `slaves` (dict): All enabled slave channel objects. Format: `"channel_id": channel_object`.
 
 **poll(self)** _(for both types)_  
-Message polling from your chat platform should be done in this method. When all channels are initialized, `poll` from all enabled channels are called in separated threads, and run concurrently. While polling for messages, the channel should always check for `self.stop_polling` (bool). When the user gracefully stops EFB, `self.stop_polling` will turn to `True`, and immediately the channel should stop polling and clean up everything necessary.
+Messages from your chat platform should be polled in this method. When all channels are initialized, `poll` from all enabled channels are called in separated threads, and ran concurrently. While polling for messages, the channel should always check for `self.stop_polling` (bool). When the user gracefully stops EFB, `self.stop_polling` will turn to `True`, and immediately the channel should stop polling and clean up everything necessary.
 
-Method of getting messages which requires extra set up by the user or which may reduce compatibility, including Webhooks, shall be avoided or used as an alternative method.
+Method of getting messages which requires extra set up by the user or which may reduce compatibility, including Webhooks, shall be avoided or only used as an alternative method.
 
 **get_extra_functions(self)** _(ready implemented, for slave channels)_  
 Returns a `dict` of all extra functions of the slave channel, in the format of `"callable_name": callable`.

main.py

@@ -10,7 +10,7 @@
 if sys.version_info.major < 3:
     raise Exception("Python 3.x is required. Your version is %s." % sys.version)
 
-__version__ = "1.3.2-dev.6"
+__version__ = "1.3.2-dev.reauth.1"
 
 parser = argparse.ArgumentParser(description="EH Forwarder Bot is an extensible chat tunnel framework which allows "
                                              "users to contact people from other chat platforms, and ultimately "

plugins/eh_telegram_master/__init__.py

@@ -189,7 +189,7 @@ def _reply_error(bot, update, errmsg):
         Returns:
             telegram.Message: Message sent
         """
-        return bot.sendMessage(update.message.chat.id, errmsg, reply_to_message_id=update.message.message_id)
+        return bot.send_message(update.message.chat.id, errmsg, reply_to_message_id=update.message.message_id)
 
     def process_msg(self, msg):
         """
@@ -247,7 +247,10 @@ def process_msg(self, msg):
                     else "%s (%s)" % (msg.origin["alias"], msg.origin["name"])
                 msg_template = "%s %s [%s]:\n%s" % (emoji_prefix, msg_prefix, name_prefix, "%s")
             elif msg.source == MsgSource.System:
-                msg_template = "System Message: %s"
+                emoji_prefix = msg.channel_emoji + utils.Emojis.get_source_emoji(msg.source)
+                name_prefix = msg.origin["name"] if msg.origin["alias"] == msg.origin["name"] or not msg.origin['alias'] \
+                    else "%s (%s)" % (msg.origin["alias"], msg.origin["name"])
+                msg_template = "%s %s:\n%s" % (emoji_prefix, name_prefix, "%s")
 
             # Type dispatching
             self.logger.debug("%s, process_msg_step_2", xid)
@@ -287,9 +290,9 @@ def process_msg(self, msg):
                 else:
                     self.logger.debug("%s, process_msg_step_3_0_3", xid)
                     try:
-                        tg_msg = self.bot.bot.sendMessage(tg_dest, text=msg_template % msg.text, parse_mode=parse_mode)
+                        tg_msg = self.bot.bot.send_message(tg_dest, text=msg_template % msg.text, parse_mode=parse_mode)
                     except telegram.error.BadRequest:
-                        tg_msg = self.bot.bot.sendMessage(tg_dest, text=msg_template % msg.text)
+                        tg_msg = self.bot.bot.send_message(tg_dest, text=msg_template % msg.text)
                     self.logger.debug("%s, process_msg_step_3_0_4, tg_msg = %s", xid, tg_msg)
                 self.logger.debug("%s, process_msg_step_3_1", xid)
             elif msg.type == MsgType.Link:
@@ -299,21 +302,21 @@ def process_msg(self, msg):
                 if msg.text:
                     text += "\n\n" + msg.text
                 try:
-                    tg_msg = self.bot.bot.sendMessage(tg_dest, text=msg_template % text, parse_mode="HTML")
+                    tg_msg = self.bot.bot.send_message(tg_dest, text=msg_template % text, parse_mode="HTML")
                 except telegram.error.BadRequest:
                     text = "🔗 %s\n%s\n\n%s" % (html.escape(msg.attributes["title"] or ""),
                                                 html.escape(msg.attributes["description"] or ""),
                                                 urllib.parse.quote(msg.attributes["url"] or "", safe="?=&#:/"))
                     if msg.text:
                         text += "\n\n" + msg.text
-                    tg_msg = self.bot.bot.sendMessage(tg_dest, text=msg_template % msg.text)
+                    tg_msg = self.bot.bot.send_message(tg_dest, text=msg_template % msg.text)
             elif msg.type in [MsgType.Image, MsgType.Sticker]:
                 self.logger.debug("%s, process_msg_step_3_2", xid)
-                self.logger.info("Received %s \nPath: %s\nSize: %s\nMIME: %s", msg.type, msg.path,
-                                 os.stat(msg.path).st_size, msg.mime)
+                self.logger.debug("Received %s\nPath: %s\nMIME: %s", msg.type, msg.path, msg.mime)
+                self.logger.debug("Path: %s\nSize: %s", msg.path, os.stat(msg.path).st_size)
                 if os.stat(msg.path).st_size == 0:
                     os.remove(msg.path)
-                    tg_msg = self.bot.bot.sendMessage(tg_dest,
+                    tg_msg = self.bot.bot.send_message(tg_dest,
                                                     msg_template % ("Error: Empty %s received. (MS01)" % msg.type))
                 else:
                     if not msg.text:
@@ -333,21 +336,21 @@ def process_msg(self, msg):
             elif msg.type == MsgType.File:
                 if os.stat(msg.path).st_size == 0:
                     os.remove(msg.path)
-                    tg_msg = self.bot.bot.sendMessage(tg_dest,
+                    tg_msg = self.bot.bot.send_message(tg_dest,
                                                     msg_template % ("Error: Empty %s received. (MS02)" % msg.type))
                 else:
                     if not msg.text:
                         file_name = os.path.basename(msg.path)
                         msg.text = "sent a file."
                     else:
                         file_name = msg.text
-                    tg_msg = self.bot.bot.sendDocument(tg_dest, msg.file, caption=msg_template % msg.text,
+                    tg_msg = self.bot.bot.send_document(tg_dest, msg.file, caption=msg_template % msg.text,
                                                        filename=file_name)
                     os.remove(msg.path)
             elif msg.type == MsgType.Audio:
                 if os.stat(msg.path).st_size == 0:
                     os.remove(msg.path)
-                    return self.bot.bot.sendMessage(tg_dest,
+                    return self.bot.bot.send_message(tg_dest,
                                                     msg_template % ("Error: Empty %s received. (MS03)" % msg.type))
                 msg.text = msg.text or ''
                 self.logger.debug("%s, process_msg_step_4_1, no_conversion = %s", xid,
@@ -359,7 +362,11 @@ def process_msg(self, msg):
                     else:
                         tg_msg = self.bot.bot.sendDocument(tg_dest, msg.file, caption=msg_template % msg.text)
                 else:
-                    pydub.AudioSegment.from_file(msg.file).export("%s.ogg" % msg.path, format="ogg", codec="libopus")
+                    pydub.AudioSegment.from_file(msg.file).export("%s.ogg" % msg.path,
+                                                                  format="ogg",
+                                                                  codec="libopus",
+                                                                  bitrate=65536,
+                                                                  parameters=["-vbr", "on", "-compression_level", "10"])
                     ogg_file = open("%s.ogg" % msg.path, 'rb')
                     tg_msg = self.bot.bot.sendVoice(tg_dest, ogg_file, caption=msg_template % msg.text)
                     os.remove("%s.ogg" % msg.path)
@@ -373,7 +380,7 @@ def process_msg(self, msg):
             elif msg.type == MsgType.Video:
                 if os.stat(msg.path).st_size == 0:
                     os.remove(msg.path)
-                    return self.bot.bot.sendMessage(tg_dest, msg_template % ("Error: Empty %s recieved" % msg.type))
+                    return self.bot.bot.send_message(tg_dest, msg_template % ("Error: Empty %s recieved" % msg.type))
                 if not msg.text:
                     msg.text = "sent a video."
                 tg_msg = self.bot.bot.sendVideo(tg_dest, video=msg.file, caption=msg_template % msg.text)
@@ -389,7 +396,7 @@ def process_msg(self, msg):
                                                                             "text": msg_template % msg.text,
                                                                             "commands": msg.attributes['commands']}
             else:
-                tg_msg = self.bot.bot.sendMessage(tg_dest, msg_template % "Unsupported incoming message type. (UT01)")
+                tg_msg = self.bot.bot.send_message(tg_dest, msg_template % "Unsupported incoming message type. (UT01)")
             self.logger.debug("%s, process_msg_step_4", xid)
             if msg.source in (MsgSource.User, MsgSource.Group):
                 msg_log = {"master_msg_id": "%s.%s" % (tg_msg.chat.id, tg_msg.message_id),
@@ -523,7 +530,7 @@ def link_chat_gen_list(self, bot, chat_id, message_id=None, offset=0, filter="")
             offset: Offset for pagination.
         """
         if not message_id:
-            message_id = bot.sendMessage(chat_id, "Processing...").message_id
+            message_id = bot.send_message(chat_id, "Processing...").message_id
 
         msg_text = "Please choose the chat you want to link with ...\n\nLegend:\n"
         legend, chat_btn_list = self.slave_chats_pagination("%s.%s" % (chat_id, message_id), offset, filter=filter)
@@ -633,17 +640,17 @@ def link_chat_exec(self, bot, tg_chat_id, tg_msg_id, callback_uid):
 
     def unlink_all(self, bot, update):
         if update.message.chat.id == update.message.from_user.id:
-            return bot.sendMessage(update.message.chat.id, "Send `/unlink_all` to a group to unlink all remote chats "
+            return bot.send_message(update.message.chat.id, "Send `/unlink_all` to a group to unlink all remote chats "
                                                            "from it.",
                                    parse_mode=telegram.ParseMode.MARKDOWN,
                                    reply_to_message_id=update.message.message_id)
         assocs = db.get_chat_assoc(master_uid="%s.%s" % (self.channel_id, update.message.chat.id))
         if len(assocs) < 1:
-            return bot.sendMessage(update.message.chat.id, "No chat is linked to the group.",
+            return bot.send_message(update.message.chat.id, "No chat is linked to the group.",
                                    reply_to_message_id=update.message.message_id)
         else:
             db.remove_chat_assoc(master_uid="%s.%s" % (self.channel_id, update.message.chat.id))
-            return bot.sendMessage(update.message.chat.id, "All chats has been unlinked from this group. (%s)" % len(assocs),
+            return bot.send_message(update.message.chat.id, "All chats has been unlinked from this group. (%s)" % len(assocs),
                                    reply_to_message_id=update.message.message_id)
 
     def start_chat_list(self, bot, update, args=None):
@@ -672,7 +679,7 @@ def chat_head_req_generate(self, bot, chat_id, message_id=None, offset=0, filter
             filter: Regex String used as a filter.
         """
         if not message_id:
-            message_id = bot.sendMessage(chat_id, text="Processing...").message_id
+            message_id = bot.send_message(chat_id, text="Processing...").message_id
 
         legend, chat_btn_list = self.slave_chats_pagination("%s.%s" % (chat_id, message_id), offset, filter=filter)
         msg_text = "Choose a chat you want to start with...\n\nLegend:\n"
@@ -784,7 +791,7 @@ def extra_help(self, bot, update):
                     fn_name, xfns[j].name, xfns[j].desc.format(function_name=fn_name))
             else:
                 msg += "No command found."
-        bot.sendMessage(update.message.chat.id, msg, parse_mode="HTML")
+        bot.send_message(update.message.chat.id, msg, parse_mode="HTML")
 
     def extra_call(self, bot, update, groupdict=None):
         """
@@ -802,7 +809,7 @@ def extra_call(self, bot, update, groupdict=None):
         if groupdict['command'] not in fns:
             return self._reply_error(bot, update, "Command not found in selected channel. (XC02)")
         header = "%s %s: %s\n-------\n" % (ch.channel_emoji, ch.channel_name, fns[groupdict['command']].name)
-        msg = bot.sendMessage(update.message.chat.id, header + "Please wait...")
+        msg = bot.send_message(update.message.chat.id, header + "Please wait...")
         result = fns[groupdict['command']](" ".join(update.message.text.split(' ', 1)[1:]))
         bot.editMessageText(text=header + result, chat_id=update.message.chat.id, message_id=msg.message_id)
 
@@ -1061,7 +1068,7 @@ def start(self, bot, update, args=[]):
                 txt = "Chat '%s' is now linked." % chat_display_name
                 unlink_btn = telegram.InlineKeyboardMarkup(
                     [[telegram.InlineKeyboardButton("Unlink", callback_data="unlink 0")]])
-                new_msg = bot.sendMessage(update.message.chat.id, text=txt, reply_markup=unlink_btn)
+                new_msg = bot.send_message(update.message.chat.id, text=txt, reply_markup=unlink_btn)
                 self.msg_status[args[0]] = \
                     self.msg_status["%s.%s" % (update.message.chat.id, new_msg.message_id)] = \
                     Flags.EXEC_LINK
@@ -1076,7 +1083,7 @@ def start(self, bot, update, args=[]):
         else:
             txt = "Welcome to EH Forwarder Bot: EFB Telegram Master Channel.\n\n" \
                   "To learn more, please visit https://github.com/blueset/ehForwarderBot ."
-            bot.sendMessage(update.message.from_user.id, txt)
+            bot.send_message(update.message.from_user.id, txt)
 
     def recognize_speech(self, bot, update, args=[]):
         """
@@ -1150,7 +1157,7 @@ def recognize(self, *args, **kwargs):
             for j in results[i]:
                 msg += "%s\n" % j
         msg = "Results:\n%s" % msg
-        bot.sendMessage(update.message.reply_to_message.chat.id, msg,
+        bot.send_message(update.message.reply_to_message.chat.id, msg,
                         reply_to_message_id=update.message.reply_to_message.message_id,
                         parse_mode=telegram.ParseMode.MARKDOWN)
         os.remove(path)
@@ -1187,9 +1194,9 @@ def error(self, bot, update, error):
         if "Conflict: terminated by other long poll or webhook (409)" in str(error):
             msg = 'Please immediately turn off all EFB instances.\nAnother bot instance or web-hook detected.'
             self.logger.error(msg)
-            bot.sendMessage(getattr(config, self.channel_id)['admins'][0], msg)
+            bot.send_message(getattr(config, self.channel_id)['admins'][0], msg)
         else:
-            bot.sendMessage(getattr(config, self.channel_id)['admins'][0],
+            bot.send_message(getattr(config, self.channel_id)['admins'][0],
                             "EFB Telegram Master channel encountered error <code>%s</code> "
                             "caused by update <code>%s</code>.\n\n"
                             "Report issue: <a href=\"https://github.com/blueset/ehForwarderBot/issues/new\">GitHub Issue Page</a>" %