Added command support.

Author: blueset

README.md

@@ -9,17 +9,19 @@ A (extensible) tunnel bot between chat protocols
     - [x] Inter-channel communication
     - [x] Queue processing
     - [x] Multimedia
-    - [ ] Inter-channel commands
+    - [x] Inter-channel commands
+    - [ ] Extra functions from slave channels
 - [ ] Telgeram Master Channel
     - [x] Basic Text processing
     - [ ] Controlling slaves by command
     - [x] Chat association
     - [x] Multimedia
     - [x] Generate chat head
-- [ ] Wechat Slave Channel
+- [ ] WeChat Slave Channel
     - [x] Basic Text/Link processing
     - [x] Multimedia
-    - [ ] Add friends (Cards & Requests)
+    - [x] Add friends (Cards & Requests)
+    - [ ] Other actions
 - [ ] WhatsApp Slave Channel
 - [ ] Line Slave Channel
 - [ ] QQ Slave Channel

docs/message.md

@@ -182,7 +182,41 @@ Shared links.
   "url": URL in the message.
 
 ### Command
-> TODO: Command message documentation.
+**Type**: MsgType.Command
+**Additional Parameters**: attributes
+
+This message is sent when a message from **slave** channel provides action options to the user. E.g.: Friend request,
+money transfer, etc.
+
+`text` should include all necessary information for the user understand the situation and take action.
+
+`attributes` is a dict with one item: `commands`, whose value is a list of commands with structure described below:
+
+```python
+msg.attributes = {
+    "commands": [
+        {
+            "name": "A human-readable name for the command",
+            "callable": "name to the callable function in your channel object",
+            "args": [
+                "a list of positional parameters passed to your function"
+            ],
+            "kwargs": {
+                "desc": "a dict of keyword parameters passed to your function"
+            }
+        },
+        {
+            "name": "Greet @blueset on Telegram",
+            "callable": "send_message_by_username",
+            "args": [
+                "blueset",
+                "Hello!"
+            ],
+            "kwargs": {}
+        }
+    ]
+}
+```
 
 ### Unsupported message
 > TODO: Unsupported message documentation.

docs/slave-channel.md

@@ -83,3 +83,10 @@ Each `dict` item should have:
 ### `get_group_members(self, group_uid)`
 
 > TODO: Documentation for `get_group_members`
+
+## Command message
+Slave channels can send messages that offer the user options to take action. This can be used in situations such as friend request, fund transfer and Telegram Inline Buttons.
+
+Aside from sending a message with "Command" type (refer to the specification in "Message" documentation), the slave channel have to also provide a method for the command to be issued.
+
+The method can take any argument of Python's standard data structure, and returns a string which is shown to the user as the result of the action.

docs/workflow.md

@@ -41,4 +41,9 @@ To deliver user's message to a slave channel, you should first gather all the in
 ## Slave Channel
 Slave channel has rather less things to do, get and enqueue incoming message, and send message to the platform. Also you may need to generate a list of possible recipients for the Master channel. That should be most of it.
 
-> In the future, I may also come out with a protocol for command delivery. This includes some common ones like adding or accepting new contacts to slave channel, or even customizable ones. See when can I finish it. :P
+# Commands
+Once there's any message from a slave channel that allows the user to take action, the slave channel will enclose detail of actions (namely method names and arguments) into an `EFBMsg` object and send it to the master channel.
+
+Master channel will use it's own method to ask the user to make a decision, and with the decision, the master channel will call the respective method of the slave channel with the argument given.
+
+The method of slave channel returns a string as the result which is then reflected back to the user.

plugins/tg/__init__.py

@@ -25,7 +25,8 @@ class Flags:
     EXEC_LINK = 0x12
     # Start a chat
     START_CHOOSE_CHAT = 0x21
-    pass
+    # Command
+    COMMAND_PENDING = 0x31
 
 
 class TelegramChannel(EFBChannel):
@@ -128,6 +129,8 @@ def callback_query_dispatcher(self, bot, update):
             self.link_chat_exec(bot, chat_id, msg_id, text)
         elif msg_status == Flags.START_CHOOSE_CHAT:
             self.make_chat_head(bot, chat_id, msg_id, text)
+        elif msg_status == Flags.COMMAND_PENDING:
+            self.command_exec(bot, chat_id, msg_id, text)
         else:
             bot.editMessageText(text="Session expired. Please try again.",
                                 chat_id=chat_id,
@@ -191,11 +194,11 @@ def process_msg(self, msg):
             else:
                 tg_msg = self.bot.bot.sendMessage(tg_dest, text=msg_template % msg.text)
         elif msg.type in [MsgType.Image, MsgType.Sticker]:
-            self.logger.info("recieved Image/Sticker \nPath: %s\nSize: %s\nMIME: %s", msg.path,
+            self.logger.info("Received Image/Sticker \nPath: %s\nSize: %s\nMIME: %s", msg.path,
                              os.stat(msg.path).st_size, msg.mime)
             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.sendMessage(tg_dest, msg_template % ("Error: Empty %s received. (MS01)" % msg.type))
             if not msg.text:
                 if msg.type == MsgType.Image:
                     msg.text = "sent a picture."
@@ -209,7 +212,7 @@ def process_msg(self, msg):
         elif msg.type == MsgType.File:
             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.sendMessage(tg_dest, msg_template % ("Error: Empty %s received. (MS02)" % msg.type))
             if not msg.text:
                 file_name = os.path.basename(msg.path)
                 msg.text = "sent a file."
@@ -220,7 +223,7 @@ def process_msg(self, msg):
         elif msg.type == MsgType.Audio:
             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.sendMessage(tg_dest, msg_template % ("Error: Empty %s received. (MS03)" % msg.type))
             pydub.AudioSegment.from_file(msg.file).export("%s.ogg" % msg.path, format="ogg", codec="libopus")
             ogg_file = open("%s.ogg" % msg.path, 'rb')
             if not msg.text:
@@ -241,6 +244,13 @@ def process_msg(self, msg):
                 msg.text = "sent a video."
             tg_msg = self.bot.bot.sendVideo(tg_dest, video=msg.file, caption=msg_template % msg.text)
             os.remove(msg.path)
+        elif msg.type == MsgType.Command:
+            buttons = []
+            for i, ival in enumerate(msg.attributes['commands']):
+                buttons.append([telegram.InlineKeyboardButton(ival['name'], callback_data=str(i))])
+            tg_msg = self.bot.bot.send_message(tg_dest, msg_template % msg.text, reply_markup=telegram.InlineKeyboardMarkup(buttons))
+            self.msg_status[tg_msg.message_id] = Flags.COMMAND_PENDING
+            self.msg_storage[tg_msg.message_id] = {"channel": msg.channel_id, "commands": msg.attributes['commands']}
         else:
             tg_msg = self.bot.bot.sendMessage(tg_dest, msg_template % "Unsupported incoming message type. (UT01)")
         msg_log = {"master_msg_id": "%s.%s" % (tg_msg.chat.id, tg_msg.message_id),
@@ -361,7 +371,7 @@ def link_chat_gen_list(self, bot, chat_id, message_id=None, offset=0):
         for i in legend:
             msg_text += "%s\n" % i
 
-        msg = bot.editmMessageText(chat_id=chat_id, message_id=message_id, text=msg_text,
+        msg = bot.editMessageText(chat_id=chat_id, message_id=message_id, text=msg_text,
                                    reply_markup=telegram.InlineKeyboardMarkup(chat_btn_list))
         self.msg_status[msg.message_id] = Flags.CONFIRM_LINK
 
@@ -473,6 +483,20 @@ def make_chat_head(self, bot, tg_chat_id, tg_msg_id, callback_uid):
         db.add_msg_log(**msg_log)
         bot.editMessageText(text=txt, chat_id=tg_chat_id, message_id=tg_msg_id)
 
+    def command_exec(self, bot, chat_id, message_id, callback):
+        if not callback.isdecimal():
+            msg = "Invalid parameter: %s. (CE01)" % callback
+            return bot.editMessageText(text=msg, chat_id=chat_id, message_id=message_id)
+        elif not (0 <= int(msg) < len(self.msg_storage[message_id])):
+            msg = "Index out of bound: %s. (CE02)" % callback
+            return bot.editMessageText(text=msg, chat_id=chat_id, message_id=message_id)
+
+        callback = int(callback)
+        channel_id = self.msg_storage[message_id]['channel']
+        command = self.msg_storage[message_id]['comamnds'][callback]
+        msg = getattr(self.slaves[channel_id], command['callable'])(*command['args'], **command['kwargs'])
+        return bot.editMessageText(text=msg, chat_id=chat_id, message_id=message_id)
+
     def msg(self, bot, update):
         target = None
         if not (update.message.chat.id == update.message.from_user.id):  # from group

plugins/wechat.py

@@ -148,6 +148,22 @@ def wcVideo(msg):
         def wcVideoGroup(msg):
             self.videoMsg(msg, True)
 
+        @itchat.msg_register(['Card'])
+        def wcCard(msg):
+            self.cardMsg(msg)
+
+        @itchat.msg_register(['Card'], isGroupChat=True)
+        def wcCardGroup(msg):
+            self.cardMsg(msg, True)
+
+        @itchat.msg_register(['Friends'])
+        def wcFriends(msg):
+            self.friendMsg(msg)
+
+        @itchat.msg_register(['Friends'], isGroupChat=True)
+        def wcFriendsGroup(msg):
+            self.friendMsg(msg, True)
+
         itchat.run()
         while True:
             if not itchat.client().status:
@@ -251,6 +267,63 @@ def videoMsg(self, msg, isGroupChat=False):
         mobj.file = open(mobj.path, "rb")
         return mobj
 
+    @incomeMsgMeta
+    def cardMsg(self, msg, isGroupChat=False):
+        mobj = EFBMsg(self)
+        msg = """Name card: {NickName}
+From: {Province}, {City}
+QQ: {QQNum}
+ID: {Alias}
+Signature: {Signature}
+Gender: {Sex}"""
+        msg = msg.format(**msg['Text'])
+        mobj.text = msg
+        mobj.type = MsgType.Command
+        mobj.attributes = {
+            "commands": [
+                {
+                    "name": "Send friend request",
+                    "callable": "addFriend",
+                    "args": [],
+                    "kwargs": {
+                        "userName": msg['Text']['UserName'],
+                        "status": 2,
+                        "ticket": ""
+                    }
+                }
+            ]
+        }
+        return mobj
+
+    @incomeMsgMeta
+    def friendMsg(self, msg, isGroupChat=False):
+        mobj = EFBMsg(self)
+        msg = """Friend request: {NickName}
+Status: {Status}
+From: {Province}, {City}
+QQ: {QQNum}
+ID: {Alias}
+Signature: {Signature}
+Gender: {Sex}"""
+        msg = msg.format(**{**msg['Text'], **msg['Text']['userInfo']})
+        mobj.text = msg
+        mobj.type = MsgType.Command
+        mobj.attributes = {
+            "commands": [
+                {
+                    "name": "Send friend request",
+                    "callable": "addFriend",
+                    "args": [],
+                    "kwargs": {
+                        "userName": msg['Text']['userInfo']['UserName'],
+                        "status": 3,
+                        "ticket": msg['Ticket']
+                    }
+                }
+            ]
+        }
+        return mobj
+
     def save_file(self, msg, msg_type):
         path = os.path.join("storage", self.channel_id)
         if not os.path.exists(path):
@@ -259,11 +332,11 @@ def save_file(self, msg, msg_type):
         fullpath = os.path.join(path, filename)
         msg['Text'](fullpath)
         mime = magic.from_file(fullpath, mime=True).decode()
-        ext = mimetypes.guess_extension(mime)
+        ext = "jpg" if mime == "image/jpeg" else mimetypes.guess_extension(mime)
         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)
+        return fullpath, mime
 
     def send_message(self, msg):
         """Send a message to WeChat.
@@ -318,9 +391,21 @@ def send_message(self, msg):
         else:
             raise EFBMessageTypeNotSupported()
 
+    # Extra functions
+
     @extra(name="Refresh Contacts and Groups list", desc="Refresh the list of contacts when unidentified contacts found.", emoji="🔁")
     def refresh_contacts(self):
-        itchat.get_contract(true)
+        itchat.get_contract(True)
+
+    # Command functions
+    def add_friend(self, userName=None, status=2, ticket="", userInfo={}):
+        if not userName:
+            return "Username is empty. (UE01)"
+        try:
+            itchat.add_friend(userName, status, ticket, userInfo)
+            return "Success."
+        except:
+            return "Error occurred during the process. (AF01)"
 
     def get_chats(self, group=True, user=True):
         r = []