1.4.4-dev.7: Introduced new parameter for EFBMsg object: filename

Author: blueset

channel.py

@@ -101,7 +101,7 @@ class EFBMsg:
         channel_id (str): ID for the source channel
         channel_name (str): Name of the source channel
         destination (dict): Destination (may be a user or a group)
-        member (dict): Author of this msg in a group. `None` for priv msgs.
+        member (dict): Author of this msg in a group. `None` for private messages.
         origin (dict): Origin (may be a user or a group)
         source (MsgSource): Source of message: User/Group/System
         target (dict): Target (refers to @ messages and "reply to" messages.)
@@ -110,8 +110,9 @@ class EFBMsg:
         uid (str): Unique ID of message
         url (str): URL of multimedia file/Link share. `None` if N/A
         path (str): Local path of multimedia file. `None` if N/A
-        file (file): File object to multimedia object, type "ra". `None` if N/A
+        file (file): File object to multimedia file, type "ra". `None` if N/A
         mime (str): MIME type of the file. `None` if N/A
+        filename (str): File name of the multimedia file. `None` if N/A
 
     `target`:
         There are 3 types of targets: `Member`, `Message`, and `Substitution`
@@ -247,6 +248,7 @@ class EFBMsg:
     path = None
     file = None
     mime = None
+    filename = None
     attributes = {}
 
     def __init__(self, channel=None):

docs/message.md

@@ -130,33 +130,34 @@ Picture type, may include GIF images. Stickers are not included. `text` for capt
 * `path`: Relative path to the image, e.g. `storage/my_slave_channel/picture_1234567890.png`
 * `mime`: MIME type string of the file, e.g. `image/png`
 * `file`: File object of the image, done by `open(msg.path, 'rb')`
+* `filename` (_optional_): Original filename, `None` if not available.
 
 > Definition for `path`, `mime`, `file` is similar for other multimedia files.
 
 ### Stickers
 **Type**: MsgType.Sticker  
-**Additional Parameters**: path, mime, file
+**Additional Parameters**: path, mime, file, filename
 
 Sticker messages.
 Specification for `path`, `mime`, `file` refer to `MsgType.Image`.
 
 ### Audio/Music/Voice
 **Type**: MsgType.Audio  
-**Additional Parameters**: path, mime, file
+**Additional Parameters**: path, mime, file, filename
 
 Audio message, including music file and voice message.
 Specification for `path`, `mime`, `file` refer to `MsgType.Image`.
 
 ### Video
 **Type**: MsgType.Video  
-**Additional Parameters**: path, mime, file
+**Additional Parameters**: path, mime, file, filename
 
 Video message.
 Specification for `path`, `mime`, `file` refer to `MsgType.Image`.
 
 ### File
 **Type**: MsgType.File  
-**Additional Parameters**: path, mime, file
+**Additional Parameters**: path, mime, file, filename
 
 File message.
 Specification for `path`, `mime`, `file` refer to `MsgType.Image`.

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.4.4-dev.6"
+__version__ = "1.4.4-dev.7"
 
 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

@@ -339,11 +339,11 @@ def process_msg(self, msg):
                     tg_msg = self.bot.bot.send_message(tg_dest,
                                                     msg_template % ("Error: Empty %s received. (MS02)" % msg.type))
                 else:
-                    if not msg.text:
+                    if not msg.filename:
                         file_name = os.path.basename(msg.path)
                         msg.text = "sent a file."
                     else:
-                        file_name = msg.text
+                        file_name = msg.filename
                     tg_msg = self.bot.bot.send_document(tg_dest, msg.file, caption=msg_template % msg.text,
                                                        filename=file_name)
                     os.remove(msg.path)
@@ -955,12 +955,14 @@ def msg(self, bot, update):
                 tg_file_id = update.message.document.file_id
                 self.logger.debug("tg: Document file received")
                 if update.message.document.mime_type == "video/mp4":
-                    self.logger.debug("tg: GIF received")
+                    self.logger.debug("tg: Telegram GIF received")
                     m.type = MsgType.Image
                     m.path, m.mime = self._download_gif(update.message, tg_file_id, m.type)
                 else:
                     m.type = MsgType.File
                     m.path, m.mime = self._download_file(update.message, tg_file_id, m.type)
+                    m.mime = update.message.document.mime_type or m.mime
+                    m.filename = getattr(update.message.document, "file_name", None) or None
                 m.file = open(m.path, "rb")
             elif mtype == TGMsgType.Video:
                 m.type = MsgType.Video
@@ -1026,8 +1028,11 @@ def _download_file(self, tg_msg, file_id, msg_type):
         mime = magic.from_file(fullpath, mime=True)
         if type(mime) is bytes:
             mime = mime.decode()
-        ext = mimetypes.guess_extension(mime).split(".")[-1]
-        os.rename(fullpath, "%s.%s" % (fullpath, ext))
+        guess_ext = mimetypes.guess_extension(mime) or ".unknown"
+        if guess_ext == ".unknown":
+            self.logger.warning("File %s with mime %s has no matching extensions.", fullpath, mime)
+        ext = ".jpeg" if mime == "image/jpeg" else guess_ext
+        os.rename(fullpath, "%s%s" % (fullpath, ext))
         fullpath = "%s.%s" % (fullpath, ext)
         return fullpath, mime
 

plugins/eh_wechat_slave.py

@@ -535,6 +535,7 @@ def fileMsg(self, msg, isGroupChat=False):
         mobj.type = MsgType.File
         mobj.path, mobj.mime = self.save_file(msg, mobj.type)
         mobj.text = msg['FileName']
+        mobj.filename = msg['FileName'] or None
         mobj.file = open(mobj.path, "rb")
         return mobj
 
@@ -625,10 +626,10 @@ def save_file(self, msg, msg_type):
         if type(mime) is bytes:
             mime = mime.decode()
         guess_ext = mimetypes.guess_extension(mime) or ".unknown"
-        if guess_ext == "unknown":
+        if guess_ext == ".unknown":
             self.logger.warning("File %s with mime %s has no matching extensions.", fullpath, mime)
-        ext = "jpg" if mime == "image/jpeg" else guess_ext[1:]
-        os.rename(fullpath, "%s.%s" % (fullpath, ext))
+        ext = ".jpeg" if mime == "image/jpeg" else guess_ext
+        os.rename(fullpath, "%s%s" % (fullpath, ext))
         fullpath = "%s.%s" % (fullpath, ext)
         self.logger.info("File saved from WeChat\nFull path: %s\nMIME: %s", fullpath, mime)
         return fullpath, mime
@@ -714,8 +715,8 @@ def send_message(self, msg):
                 except FileNotFoundError:
                     pass
         elif msg.type in (MsgType.File, MsgType.Audio):
-            self.logger.info("Sending %s to WeChat\nFileName: %s\nPath: %s", msg.type, msg.text, msg.path)
-            r = self._itchat_send_file(msg.path, UserName)
+            self.logger.info("Sending %s to WeChat\nFileName: %s\nPath: %s\nFilename: %s", msg.type, msg.text, msg.path, msg.filename)
+            r = self._itchat_send_file(msg.path, UserName, filename=msg.filename)
             if msg.text:
                 self._itchat_send_msg(msg.text, UserName)
             os.remove(msg.path)