Skip to content

Latest commit

 

History

History
341 lines (220 loc) · 10.4 KB

es_AR.rst

File metadata and controls

341 lines (220 loc) · 10.4 KB
Raw

EFB WeChat Slave Channel

PyPI release Tests status Downloads per month Translate this project

Banner

This project proudly supports #SayNoToWeChat campaign.

README in other languages.

Channel ID: blueset.wechat

EWS is an EFB Slave Channel for WeChat, based on reversed engineered WeChat Web API, modified wxpy, and itchat.

Some source code in this repository was adapted from youfou/wxpy and littlecodersh/ItChat.

Read before use

Since mid-2017, we have received feedback where some users’ access to Web WeChat was banned. Most of the users were unbanned within 1 day to 3 months. When a user is banned for Web WeChat access, a pop up would be shown when they try to use it, stating that they “cannot use Web WeChat temporary”, and are recommended to use mobile app or Windows/macOS instead. By observation, only less than 10% of the users are being banned from Web WeChat during their usage.

Meanwhile, it is reported that WeChat accounts registered after mid-2017 cannot use Web WeChat “for security reason”. Please confirm that you can use Web WeChat with your account before setting up EWS.

The ban will NOT affect your access to any other client. The cause of such ban is not clear.

Please proceed with caution, and avoid using this Channel if you have special need of Web WeChat access. More details are available in issue #7.

Dependencies

  • Python >= 3.6
  • EH Forwarder Bot >= 2.0.0
  • ffmpeg
  • libmagic
  • pillow

Install and Enable

  1. Install all binary dependencies stated above

  2. Install

    ::

    pip3 install efb-wechat-slave

  3. Enable EWS using the EFB configuration wizard or in

    config.yaml of the current profile.

    The config directory may vary based on your settings.

    (In EFB 2, the default configuration directory is ~/.ehforwarderbot/profiles/default )

Alternative installation methods

ETM also has other alternative installation methods contributed by the community, including:

Optional configuration

You can enable experimental features by creating a configuration file, which is located at <directory to current profile>/blueset.wechat/config.yaml.

Example configuration file

# Experimental flags
# This section can be used to enable experimental functionality.
# However, those features may be changed or removed at any time.
# Options in this section is explained afterward.
flags:
    option_one: 10
    option_two: false
    option_three: "foobar"

FAQ

  • How to switch to another WeChat account? Please log out from your phone, and log in again with another one.
  • How to log in with multiple WeChat accounts? Please indicate different Instance ID in the profile’s config file.
  • Is EWS stable? EWS depends on ItChat project and Web WeChat protocol. According to ItChat FAQ a stable session that lasts over months is possible when you:
    • have a stable internet connection on your server, and
    • keep your WeChat app always online.

Known Issues

  • Due to the design of Web WeChat, chats with no name or identical name might be identified as the same chat, which might lead to misdelivery of messages.
  • Similarly, in limited situations, a chat will be seen as a «new chat» when its name is changed, and the «old chat» is thus disappeared.
  • Only features supported by Web WeChat are supported by EWS, which means: - No «Moments» - No money transfers - Cannot send voice messages - Cannot send locations - etc.
  • Some multimedia files (pictures, stickers, files, etc.) might be blocked by Web WeChat, and no data is received, especially for stickers. In such cases, you will be reminded to check your phone.

Experimental features

The following flags are experimental features, may change, break, or disappear at any time. Use at your own risk.

  • refresh_friends (bool) [Default: false]

    Force refresh the entire chat list every time when queried.

  • first_link_only (bool) [Default: false]

    Send only the first article link when a message contains multiple articles.

  • max_quote_length (int) [Default: -1]

    Length limit of quoted message. Set to 0 to disable quotation. Set to -1 to include the full quoted message

  • qr_reload (str) [Default: "master_qr_code"]

    Method to log in when you are logged out while EWS is running. Options:

    • "console_qr_code": Send QR code to standard output (stdout).
    • "master_qr_code": Send QR code to master channel. Note: QR code might change frequently.

  • on_log_out (str) [Default: "command"]

    Behavior when WeChat server logged your account out. Options:

    • "idle": Only notify the user.
    • "reauth": Notify the user and start log in immediately.
    • "command": Notify the user, and wait for user to start log in manually.

  • imgcat_qr (bool) [Default: false]

    Use iTerm2 image protocol to show QR code. This is only applicable to iTerm 2 users.

  • delete_on_edit (bool) [Default: false]

    Turn on to edit message by recall and resend. Edit message is disabled by default.

  • app_shared_link_mode (str) [Default: "ignore"]

    Behavior to deal with thumbnails when a message shared by 3rd party apps is received.

    • "ignore": Ignore thumbnail
    • "upload": Upload to public image hosting (https://sm.ms ), and output its delete link to the log.
    • "image": Send thumbnail as image (not recommended).

  • puid_logs (str) [Default: null]

    Output PUID related log to the path indicated. Please use absolute path. In case of high volume of messages and chats, PUID log may occupy a large amount of space.

  • send_stickers_and_gif_as_jpeg (bool) [Default: false]

    Send stickers and GIF images as JPEG to bypass Web WeChat custom sticker limits as a workaround. See #48 for details.

  • system_chats_to_include (list of str)* [Default: [filehelper]]

    List of system chats to show in the default chat list. It must be zero to four of the following: filehelper (File Helper), fmessage (Friend suggestions), newsapp (Tencent News) and, weixin (WeChat Team).

  • user_agent (str) [Default: null]

    Choose the User Agent string to use when accessing Web Wechat. Leave undefined to use the default value provided by itchat.

  • text_post_processing (bool) [Default: true]

    Determine whether to post-process text of messages received from WeChat.

vendor_specific

Chat from EWS provides the following vendor_specific items:

  • is_mp (bool) If the chat is an «Official Account».
  • is_contact (bool) Unknown. Extracted from API.
  • is_blacklist_contact (bool) If the chat is blacklisted.
  • is_conversation_contact (bool) Unknown. Extracted from API.
  • is_room_contact_del (bool) Unknown. Extracted from API.
  • is_room_owner (bool) If the member is the creator of a group chat.
  • is_brand_contact (bool) Unknown. Extracted from API.
  • is_sp_contact (bool) Unknown. Extracted from API.
  • is_shield_user (bool) Unknown. Extracted from API.
  • is_muted (bool) If the chat is muted by the user from WeChat.
  • is_top (bool) If the chat is pinned to top by the user from WeChat.
  • has_photo_album (bool) Unknown. Extracted from API.

License

EWS is licensed under GNU Affero General Public License 3.0 or later versions:

EFB WeChat Slave Channel: A slave channel for EH Forwarder Bot.
Copyright (C) 2016 - 2020 Eana Hufwe, and the EFB WeChat Slave Channel contributors
All rights reserved.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Translation support

EWS supports translated user interface prompts, by setting the locale environmental variable (LANGUAGE, LC_ALL, LC_MESSAGES or LANG) to one of our supported languages. Meanwhile, you can help to translate this project into your languages on our Crowdin page.

Nota: If your are installing from source code, you will not get
translations of the user interface without manual compile of message catalogs (.mo) prior to installation.