Framework updates

- Return EFBMsg object with message UID when message is sent
- Channel property: `supported_message_type`
- New exception: `EFBMessageError`

Author: blueset

channel.py

@@ -38,6 +38,7 @@ class EFBChannel:
     channel_id = "emptyChannel"
     channel_type = ChannelType.Slave
     queue = None
+    supported_message_types = set()
 
     def __init__(self, queue):
         self.queue = queue

channelExceptions.py

@@ -8,3 +8,7 @@ class EFBMessageNotFound(Exception):
 
 class EFBMessageTypeNotSupported(Exception):
     pass
+
+
+class EFBMessageError(Exception):
+    pass

docs/channel.md

@@ -23,6 +23,9 @@ Type of the channel, choose between
 * `ChannelType.Master`
 * `ChannelType.Slave`
 
+**supported_message_types** (`set` of `MsgType` constant)  
+A list of supported message types to send **to** the channel.
+
 **queue** (queue.Queue)  
 Global message queue initialized by the parental `__init__` method. This queue is used to deliver messages from slave channels to the master channel.
 
@@ -58,6 +61,10 @@ Raises:
 * `EFBChatNotFound`
 * `EFBMessageNotFound`
 * `EFBMessageTypeNotSupported`
+* `EFBMessageError`
+
+Returns:  
+The original EFBMsg object `msg` with `uid` property defined.
 
 **get_chats(self)** _(for slave channels)_
 Returns a `list` of `dict`s for available chats in the channel. Each `dict` should be like:

docs/exceptions.md

@@ -9,4 +9,7 @@ Raised by a slave channel when the recipient channel is not found when a message
 Raised when an incoming message is in a type not supported by the recipient channel. Applicable to both master and slave channels.
 
 ## `EFBMessageNotFound`
-Raised when a message is trying to "direct reply" to another message which couldn't be found. 
+Raised when a message is trying to "direct reply" to another message which couldn't be found.
+
+## `EFBMessageError`
+Raised when a message is failed to send for any other reason.

main.py

@@ -8,7 +8,7 @@
 if sys.version_info.major < 3:
     raise Exception("Python 3.x is required. Your version is %s." % sys.version)
 
-__version__ = "1.2 build 20170114"
+__version__ = "1.2 build 20170115"
 
 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

@@ -18,7 +18,7 @@
 from . import db, speech
 from .whitelisthandler import WhitelistHandler
 from channel import EFBChannel, EFBMsg, MsgType, MsgSource, TargetType, ChannelType
-from channelExceptions import EFBChatNotFound, EFBMessageTypeNotSupported
+from channelExceptions import EFBChatNotFound, EFBMessageTypeNotSupported, EFBMessageError
 from .msgType import get_msg_type, TGMsgType
 from moviepy.editor import VideoFileClip
 
@@ -65,6 +65,9 @@ class TelegramChannel(EFBChannel):
     channel_emoji = "✈"
     channel_id = "eh_telegram_master"
     channel_type = ChannelType.Master
+    supported_message_types = {MsgType.Text, MsgType.File, MsgType.Audio,
+                               MsgType.Command, MsgType.Image, MsgType.Link, MsgType.Location,
+                               MsgType.Sticker, MsgType.Video}
 
     # Data
     slaves = None
@@ -73,6 +76,19 @@ class TelegramChannel(EFBChannel):
     msg_storage = {}
     me = None
 
+    # Constants
+    TYPE_DICT = {
+        TGMsgType.Text: MsgType.Text,
+        TGMsgType.Audio: MsgType.Audio,
+        TGMsgType.Document: MsgType.File,
+        TGMsgType.Photo: MsgType.Image,
+        TGMsgType.Sticker: MsgType.Sticker,
+        TGMsgType.Video: MsgType.Video,
+        TGMsgType.Voice: MsgType.Audio,
+        TGMsgType.Location: MsgType.Location,
+        TGMsgType.Venue: MsgType.Location,
+    }
+
     def __init__(self, queue, slaves):
         """
         Initialization.
@@ -269,7 +285,7 @@ def process_msg(self, msg):
                     os.remove(msg.path)
                     return self.bot.bot.sendMessage(tg_dest, msg_template % ("Error: Empty %s received. (MS01)" % msg.type))
                 if not msg.text:
-                    if MsgType.Image:
+                    if msg.type == MsgType.Image:
                         msg.text = "sent a picture."
                     elif msg.type == MsgType.Sticker:
                         msg.text = "sent a sticker."
@@ -342,7 +358,8 @@ def process_msg(self, msg):
                            "slave_origin_uid": "%s.%s" % (msg.channel_id, msg.origin['uid']),
                            "slave_origin_display_name": msg.origin['alias'],
                            "slave_member_uid": msg.member['uid'],
-                           "slave_member_display_name": msg.member['alias']}
+                           "slave_member_display_name": msg.member['alias'],
+                           "slave_message_uid": msg.uid}
                 if tg_chat_assoced and append_last_msg:
                     msg_log['update'] = True
                 db.add_msg_log(**msg_log)
@@ -801,6 +818,14 @@ def msg(self, bot, update):
             # Type specific stuff
             self.logger.debug("Msg type: %s", mtype)
 
+            if self.TYPE_DICT.get(mtype, None):
+                m.type = self.TYPE_DICT[mtype]
+            else:
+                raise EFBMessageTypeNotSupported()
+
+            if m.type not in self.slaves[channel].supported_message_types:
+                raise EFBMessageTypeNotSupported()
+
             if mtype == TGMsgType.Text:
                 m.type = MsgType.Text
                 m.text = update.message.text
@@ -812,12 +837,12 @@ def msg(self, bot, update):
                 m.file = open(m.path, "rb")
             elif mtype == TGMsgType.Sticker:
                 m.type = MsgType.Sticker
-                m.text = update.message.sticker.emoji
+                m.text = ""
                 tg_file_id = update.message.sticker.file_id
                 m.path, m.mime = self._download_file(update.message, tg_file_id, m.type)
                 m.file = open(m.path, "rb")
             elif mtype == TGMsgType.Document:
-                m.text = update.message.document.file_name
+                m.text = update.message.document.file_name + "\n" + update.message.caption
                 tg_file_id = update.message.document.file_id
                 self.logger.debug("tg: Document file received")
                 if update.message.document.mime_type == "video/mp4":
@@ -830,18 +855,18 @@ def msg(self, bot, update):
                 m.file = open(m.path, "rb")
             elif mtype == TGMsgType.Video:
                 m.type = MsgType.Video
-                m.text = update.message.document.file_name
+                m.text = update.message.caption
                 tg_file_id = update.message.document.file_id
                 m.path, m.mime = self._download_file(update.message, tg_file_id, m.type)
                 m.file = open(m.path, "rb")
             elif mtype == TGMsgType.Audio:
                 m.type = MsgType.Audio
-                m.text = "%s - %s" % (update.message.audio.title, update.message.audio.perfomer)
+                m.text = "%s - %s\n%s" % (update.message.audio.title, update.message.audio.perfomer, update.message.caption)
                 tg_file_id = update.message.audio.file_id
                 m.path, m.mime = self._download_file(update.message, tg_file_id, m.type)
             elif mtype == TGMsgType.Voice:
                 m.type = MsgType.Audio
-                m.text = ""
+                m.text = update.message.caption
                 tg_file_id = update.message.voice.file_id
                 m.path, m.mime = self._download_file(update.message, tg_file_id, m.type)
             elif mtype == TGMsgType.Location:
@@ -866,6 +891,8 @@ def msg(self, bot, update):
             return self._reply_error(bot, update, "Internal error: Chat not found in channel. (CN01)")
         except EFBMessageTypeNotSupported:
             return self._reply_error(bot, update, "Message type not supported. (MN01)")
+        except EFBMessageError as e:
+            return self._reply_error(bot, update, "Message is not sent. (MN01)\n\n%s" % str(e))
 
     def _download_file(self, tg_msg, file_id, msg_type):
         """

plugins/eh_telegram_master/db.py

@@ -163,6 +163,7 @@ def add_msg_log(**kwargs):
     slave_origin_display_name = kwargs.get('slave_origin_display_name', None)
     slave_member_uid = kwargs.get('slave_member_uid', None)
     slave_member_display_name = kwargs.get('slave_member_display_name', None)
+    slave_message_uid = kwargs.get('slave_message_uid', None)
     update = kwargs.get('update', False)
     if update:
         msg_log = MsgLog.get(MsgLog.master_msg_id == master_msg_id)
@@ -173,10 +174,12 @@ def add_msg_log(**kwargs):
         msg_log.slave_origin_display_name = slave_origin_display_name
         msg_log.slave_member_uid = slave_member_uid
         msg_log.slave_member_display_name = slave_member_display_name
+        # msg_log.slave_message_uid = slave_message_uid
         msg_log.save()
         return msg_log
     else:
         return MsgLog.create(master_msg_id=master_msg_id,
+                             # slave_message_uid=slave_message_uid
                              text=text,
                              slave_origin_uid=slave_origin_uid,
                              msg_type=msg_type,

plugins/eh_wechat_slave.py

@@ -13,7 +13,7 @@
 
 import config
 from channel import EFBChannel, EFBMsg, MsgType, MsgSource, TargetType, ChannelType
-from channelExceptions import EFBMessageTypeNotSupported
+from channelExceptions import EFBMessageTypeNotSupported, EFBMessageError
 from utils import extra
 
 
@@ -94,6 +94,7 @@ class WeChatChannel(EFBChannel):
     channel_emoji = "💬"
     channel_id = "eh_wechat_slave"
     channel_type = ChannelType.Slave
+    supported_message_types = {MsgType.Text, MsgType.Sticker, MsgType.Image, MsgType.File, MsgType.Video, MsgType.Link}
     users = {}
     logger = logging.getLogger("plugins.eh_wechat_slave.WeChatChannel")
 
@@ -575,20 +576,18 @@ def send_message(self, msg):
                          "Type: %s\n"
                          "Text: %s"
                          % (msg.destination['uid'], UserName, msg.destination['name'], msg.type, msg.text))
-        if msg.type == MsgType.Text:
+        if msg.type in [MsgType.Text, MsgType.Link]:
             if msg.target:
                 if msg.target['type'] == TargetType.Member:
                     msg.text = "@%s\u2005 %s" % (msg.target['target'].member['alias'], msg.text)
                 elif msg.target['type'] == TargetType.Message:
                     msg.text = "@%s\u2005 「%s」\n\n%s" % (msg.target['target'].member['alias'], msg.target['target'].text, msg.text)
             r = itchat.send(msg.text, UserName)
-            return r
         elif msg.type in [MsgType.Image, MsgType.Sticker]:
             self.logger.info("Image/Sticker %s", msg.type)
             if msg.mime in ["image/gif", "image/jpeg"]:
                 r = itchat.send_image(msg.path, UserName)
                 os.remove(msg.path)
-                return r
             else:  # Convert Image format
                 img = Image.open(msg.path)
                 try:
@@ -601,21 +600,29 @@ def send_message(self, msg):
                 img.save("%s.gif" % msg.path, transparency=255)
                 msg.path = "%s.gif" % msg.path
                 self.logger.info('Image converted to GIF: %s', msg.path)
-            self.logger.info('Sending Image...')
-            r = itchat.send_image(msg.path, UserName)
+                self.logger.info('Sending Image...')
+                r = itchat.send_image(msg.path, UserName)
+                if msg.text:
+                    itchat.send_msg(msg.text, UserName)
             self.logger.info('Image sent with result %s', r)
             os.remove(msg.path)
             if not msg.mime == "image/gif":
                 os.remove(msg.path[:-4])
-            return r
         elif msg.type in [MsgType.File, MsgType.Video]:
             self.logger.info("Sending file to WeChat\nFileName: %s\nPath: %s", msg.text, msg.path)
             r = itchat.send_file(msg.path, UserName)
+            if msg.text:
+                itchat.send_msg(msg.text, UserName)
             os.remove(msg.path)
-            return r
         else:
             raise EFBMessageTypeNotSupported()
 
+        if r.get('BaseResponse', []).get('Ret', -1) != 0:
+            raise EFBMessageError(str(r))
+        else:
+            msg.uid = r.get("MsgId", None)
+            return msg
+
     # Extra functions
 
     @extra(name="Show chat list",