v1.3.20170119

Author: blueset

CONTRIBUTING.md

@@ -20,6 +20,7 @@ If you need help, or want to talk to the authors, feel free to chat with us at o
 * **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
 * **Explain which behavior you expected to see instead and why.**
 * **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
+* **Provide log related to the issue.** Use `python3 main.py -vv` to start the logging process, and submit the entire log from the first step you performed.
 
 Provide more context by answering these questions:
 
@@ -32,6 +33,9 @@ Include details about your configuration and environment:
 * **What's the name and version of the OS you're using?**
 * **Which channel caused the problem?** Or did the framework cause it?
 
+!!! attention
+    When submitting your log, please remember to hide your private information.
+
 ## Suggesting enhancements
 
 If you have any suggestions, feel free to raise it up in the issue list. Please try to provide as much details as you can, that includes:

README.md

@@ -1,9 +1,11 @@
 # EH Forwarder Bot
 
-![Python ≥ 3.5](https://img.shields.io/badge/Python-≥_3.5-blue.svg)
+![Python 3.x](https://img.shields.io/badge/Python-3.x-blue.svg)
 [![Gitter](https://img.shields.io/gitter/room/blueset/ehForwarderBot.svg)](https://gitter.im/blueset/ehForwarderBot)
 [![Telegram support group](https://img.shields.io/badge/Chat-on%20Telegram-blue.svg)](https://telegram.me/efbsupport)
-[![license](https://img.shields.io/github/license/blueset/ehforwarderbot.svg)](LICENSE)
+[![Docs: Stable version](https://readthedocs.org/projects/ehforwarderbot/badge/?version=latest)](https://ehforwarderbot.readthedocs.io/en/latest/)
+[![Docs: Development version version](https://readthedocs.org/projects/ehforwarderbot/badge/?version=dev)](https://ehforwarderbot.readthedocs.io/en/dev/)
+[![tag](https://img.shields.io/github/tag/blueset/ehforwarderbot.svg)](https://github.com/blueset/ehForwarderBot/releases)
 
 
 ![EFB](https://images.1a23.com/upload/images/SPET.png)
@@ -26,8 +28,9 @@ _Codename_ **EH Forwarder Bot** (EFB) is an extensible chat tunnel framework whi
 ## Feel like contributing?
 Anyone is welcomed to raise an issue or submit a pull request, just remember to read through and understand the [contribution guideline](CONTRIBUTING.md) before you do so.
 
-## Special thanks
-* @clairvoyantegg for documentation refine.
+## Related articles
+* [EFB How-to: Send and Receive Messages from WeChat on Telegram (zh-CN)](https://blog.1a23.com/2017/01/09/EFB-How-to-Send-and-Receive-Messages-from-WeChat-on-Telegram-zh-CN/)  
+  _(安装并使用 EFB：在 Telegram 收发微信消息)_
 
 ## License
 EFB framework is licensed under [GNU General Public License 3.0](https://www.gnu.org/licenses/gpl-3.0.txt).

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

daemon.py

@@ -17,7 +17,6 @@
 from datetime import datetime
 from functools import partial
 import time
-import argparse
 import signal
 import fcntl
 import subprocess
@@ -27,9 +26,8 @@
 except ImportError:
     import pickle
 
-if sys.version_info.major == 3:
-    raw_input = input
-
+if sys.version_info.major < 3:
+    raise Exception("Python 3.x is required. Your version is %s." % sys.version)
 
 user_home = os.path.expanduser('~')
 dm_home = os.path.join(user_home, '.dm')
@@ -220,7 +218,7 @@ def kill(self, name=None, group=None, quiet=False, sigkill=False):
             notify = 'Stopping EFB Daemon (%d)\n' % len(daemons)
             if quiet is False:
                 notify += 'are you sure? [Y/n]'
-                yn = raw_input(notify)
+                yn = input(notify)
             else:
                 yn = 'Y'
                 print(notify)
@@ -245,7 +243,7 @@ def restart(self, name=None, group=None, cmd=None,
             notify = 'Restarting EFB daemon (%d)' % len(daemons)
             if quiet is False:
                 notify += 'are you sure? [Y/n]'
-                yn = raw_input(notify)
+                yn = input(notify)
             else:
                 yn = 'Y'
                 print(notify)
@@ -277,7 +275,7 @@ def help():
     print("EFB Daemon Process\n"
           "Usage: %s {start|stop|restart|status|transcript|help} [args_to_EFB]\n\n" % sys.argv[0] +
           "EFB help:")
-    subprocess.call(["python3", "main.py", "-h"])
+    subprocess.call([sys.executable, "main.py", "-h"])
 
 
 def transcript(path, reset=False):
@@ -289,7 +287,7 @@ def transcript(path, reset=False):
          "Press ^C (Control+C on Mac, Ctrl+C otherwise) to hide."]
     w = int(max(len(i) for i in l))
     for i in l:
-        print("\x1b[0;37;41m   %s  \x1b[0m" % i.ljust(w))
+        print("\x1b[0;37;46m   %s  \x1b[0m" % i.ljust(w))
     print()
     try:
         subprocess.call(["tail", "-f", path])
@@ -307,7 +305,7 @@ def main():
     dm = DM()
     efb_args = " ".join(sys.argv[2:])
     if sys.argv[1] == "start":
-        dm.run(cmdline=" ".join(("python3 main.py", efb_args)),
+        dm.run(cmdline=" ".join((sys.executable + " main.py", efb_args)),
                name="EFB",
                logfile="EFB.log")
         transcript(transcript_path, True)
@@ -318,7 +316,7 @@ def main():
     elif sys.argv[1] == "restart":
         kwargs = {"name": "EFB", "quiet": True, "sigkill": True}
         if len(sys.argv) > 2:
-            kwargs["cmd"] = " ".join(("python3 main.py", efb_args))
+            kwargs["cmd"] = " ".join((sys.executable + " main.py", efb_args))
         dm.restart(**kwargs)
         transcript(transcript_path, True)
     elif sys.argv[1] == "transcript":

docs/CONTRIBUTING.md

@@ -20,6 +20,7 @@ If you need help, or want to talk to the authors, feel free to chat with us at o
 * **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
 * **Explain which behavior you expected to see instead and why.**
 * **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
+* **Provide log related to the issue.** Use `python3 main.py -vv` to start the logging process, and submit the entire log from the first step you performed.
 
 Provide more context by answering these questions:
 

docs/ETM.md

@@ -78,6 +78,7 @@ In a nutshell, ETM offers the following commands, you can also send it to BotFat
 
 ```
 link - Link a remote chat to a group.
+unlink_all - Unlink all remote chats from a group.
 chat - Generate a chat head.
 recog - Recognize a speech by replying to it.
 extra - Access extra functionalities.
@@ -99,6 +100,8 @@ extra - Access extra functionalities.
     * Can read all messages send from the related remote chat;
     * May NOT send message on your behalf.
 
+Also, you can send `/unlink_all` to a group to unlink all remote chats from it.
+
 ### Send a message
 #### Send to a linked chat
 You can send message as you do in a normal Telegram chat.
@@ -193,7 +196,8 @@ it-IT | - | Italian
 sv-SE | - | Swedish
 
 ## Known issues
-* In rare cases, some messages may take 20 to 35 minutes to be delivered to user. (Upstream library [python-telegram-bot#364](https://github.com/python-telegram-bot/python-telegram-bot/issues/364))
+* In rare cases, some messages may take 20 to 35 minutes to be delivered to user. (Upstream library [python-telegram-bot#364](https://github.com/python-telegram-bot/python-telegram-bot/issues/364), said to be fixed in version 6.)
+* Too often invitation of the bot to groups will trigger Telegram's anti-spam mechanism. If you see "Could not add user, please try again later", you really need to "try again later". No joking.
 
 ## Experimental flags
 The following flags are experimental features, may change, break, or disappear at any time. Use at your own risk.
@@ -209,10 +213,14 @@ eh_telegram_master = {
 }
 ```
 
-* `no_conversion` _(bool)_  [Default: False]
+* `no_conversion` _(bool)_  [Default: `False`]
   Disable audio conversion, send all audio file as is, and let Telegram to handle it.
-* `join_msg_threshold_secs` _(int)_ [Default: 15]  
+* `join_msg_threshold_secs` _(int)_ [Default: `15`]  
   Threshold in seconds for message joining. Messages sent from the same person from the same chat between the threshold time will be joined together.  
   _Only works in linked chats._
-* `chats_per_page` _(int)_ [Default: 10]  
+* `chats_per_page` _(int)_ [Default: `10`]  
   Number of chats shown in when choosing for `/chat` and `/link` command. An overly large value may lead to malfunction of such commands.
+* `text_as_html` _(bool)_ [Default: `False`]  
+  Parse all text messages as Telegram HTML. Tags supported: `a`, `b`, `strong`, `i`, `em`, `code`, `pre`.
+* `multiple_slave_chats` _(bool)_  [Default: `False`]  
+  Link more than one remote chat to one Telegram group. Send and reply as you do with an unlinked chat.

docs/EWS.md

@@ -1,6 +1,6 @@
 # EFB WeChat Slave Channel
 
-EFB WeChat Slave Channel is a slave channel for EFB based on [ItChat](https://github.com/littlecodersh/ItChat) and WeChat Web <span style="font-size: 0.5em;">(rev.eng.)</span> API.
+EFB WeChat Slave (EWS) is a slave channel for EFB based on [ItChat](https://github.com/littlecodersh/ItChat) and WeChat Web <span style="font-size: 0.5em;">(rev.eng.)</span> API.
 
 ## Specs
 * Unique name: `eh_wechat_slave`
@@ -92,5 +92,15 @@ eh_wechat_slave = {
 }
 ```
 
-* `refresh_friends` _(bool)_  [Default: False]
+* `refresh_friends` _(bool)_  [Default: `False`]  
   Always refresh chat lists when asked. (Except from the extra function.)
+* `uid_order` _(list of str)_  [Default: `["NickName"]`]  
+  Fallback order of resolving `uid` from WeChat user info. Highest priority goes to index 0. The list **MUST** be non empty with only values below, and the last element associate to a rather stable and available value for most chats, if not all of them.  
+  Available values: _(U, G, M means the value is available to users, groups, and group members respectively)_
+    * `"NickName"`: [UGM] Name of the user/group
+    * `"alias"`: [UM] Alias of the user
+    * `"uin"`: [UG] WeChat Unique Identifier for all chats, **Not always available**.
+* `extra_links_on_message` _(bool)_  [Default: `False`]  
+  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.

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.

docs/index.md

@@ -1,9 +1,9 @@
 # EH Forwarder Bot
 
-![Python ≥ 3.5](https://img.shields.io/badge/Python-≥_3.5-blue.svg) [![Gitter](https://img.shields.io/gitter/room/blueset/ehForwarderBot.svg)](https://gitter.im/blueset/ehForwarderBot)
+![Python 3.x](https://img.shields.io/badge/Python-3.x-blue.svg) [![Gitter](https://img.shields.io/gitter/room/blueset/ehForwarderBot.svg)](https://gitter.im/blueset/ehForwarderBot)
 [![Telegram support group](https://img.shields.io/badge/Chat-on%20Telegram-blue.svg)](https://telegram.me/efbsupport)
-[![license](https://img.shields.io/github/license/blueset/ehforwarderbot.svg)](LICENSE)
-
+[![Docs: Stable version](https://readthedocs.org/projects/ehforwarderbot/badge/?version=latest)](https://ehforwarderbot.readthedocs.io/en/latest/)
+[![Docs: Development version version](https://readthedocs.org/projects/ehforwarderbot/badge/?version=dev)](https://ehforwarderbot.readthedocs.io/en/dev/)
 
 ![EFB](https://images.1a23.com/upload/images/SPET.png)
 
@@ -36,8 +36,9 @@ _Codename_ **EH Forwarder Bot** (EFB) is an extensible chat tunnel framework whi
 ## Feel like contributing?
 Anyone is welcomed to raise an issue or submit a pull request, just remember to read through and understand the [contribution guideline](CONTRIBUTING.md) before you do so.
 
-## Special thanks
-* @clairvoyantegg for documentation refine.
+## Related articles
+* [EFB How-to: Send and Receive Messages from WeChat on Telegram (zh-CN)](https://blog.1a23.com/2017/01/09/EFB-How-to-Send-and-Receive-Messages-from-WeChat-on-Telegram-zh-CN/)  
+  _(安装并使用 EFB：在 Telegram 收发微信消息)_
 
 ## License
 EFB framework is licensed under [GNU General Public License 3.0](https://www.gnu.org/licenses/gpl-3.0.txt).

docs/message.md

@@ -178,7 +178,7 @@ Location messages.
 
 Shared links.
 
-* `text`: Structured text with at least the URL in the message.
+* `text`: Any extra information for the link.
 * `attributes`: a `dict` with 4 items: _(None if not available)_  
     * **"title"**: Title of the linked article,  
     * **"description"**: Brief description of the article,  

main.py

@@ -3,8 +3,12 @@
 import threading
 import logging
 import argparse
+import sys
 
-__version__ = "1.2 build 20170112"
+if sys.version_info.major < 3:
+    raise Exception("Python 3.x is required. Your version is %s." % sys.version)
+
+__version__ = "1.3 build 20170119"
 
 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 "
@@ -52,13 +56,19 @@ def init():
     q = queue.Queue()
     # Initialize Plug-ins Library
     # (Load libraries and modules and init them with Queue `q`)
+    l = logging.getLogger("ehForwarderBot")
     slaves = {}
     for i in config.slave_channels:
+        l.critical("\x1b[0;37;46m Initializing slave %s... \x1b[0m" % i)
         obj = getattr(__import__(i[0], fromlist=i[1]), i[1])
         slaves[obj.channel_id] = obj(q)
+        l.critical("\x1b[0;37;42m Slave channel %s (%s) initialized. \x1b[0m" % (obj.channel_name, obj.channel_id))
+    l.critical("\x1b[0;37;46m Initializing master %s... \x1b[0m" % config.master_channel)
     master = getattr(__import__(config.master_channel[0], fromlist=config.master_channel[1]), config.master_channel[1])(
         q, slaves)
+    l.critical("\x1b[0;37;42m Master channel %s (%s) initialized. \x1b[0m" % (master.channel_name, master.channel_id))
 
+    l.critical("\x1b[0;37;42m All channels initialized. \x1b[0m")
     master_thread = threading.Thread(target=master.poll)
     slave_threads = {key: threading.Thread(target=slaves[key].poll) for key in slaves}