Giters

suddy / ExpressBot

一个可以帮你订阅、查询快递物流、跟你闲聊Telegram机器人

Home Page:https://www.bennythink.com/expressbot.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ExpressBot Build Status

帮你查快递、自动追踪快递最新状态的Telegram机器人！成品可戳：

@bennyblog_bot（此机器人由俺长期维护，但是不提供任何保证）

这个机器人不只是能聊天、查快递哦！信不信发语音给它也可以！还能搜美剧日剧！详细信息可以看功能和TODO

由于数据库中记录的未完成订单数量比较大，为了避免再次被快递100封IP，目前可能随时停止轮询推送功能。对您造成的不便敬请谅解！

关于

由于最近机器人使用量突然飙升，使用轮询模式很容易导致快递100的免费API使用量超过2000次/天而导致被封IP，所以目前打算更换API。 暂时只发现了这么一个比较好的选择：

  • 快递鸟：支持物流更新推送，只要这边写好就可以了；缺点是需要实名认证，又要多一个配置项。

欢迎各位有能力的人提交PR或者其他快递API的建议！感激不尽 现在顺丰的查询依旧存在问题，不知道哪个API能够用

功能

  • 查快递
  • 列出历史查询
  • 聊天（包含语音、文字）
  • 群组聊天（使用/开头、回复机器人消息来呼叫机器人）：由于开启了隐私模式，所以只好这样啦~
  • 美剧/日剧/电影查询
  • 广播 命令列表：

start - 输入快递单号来查询

help - 帮助

list - 查看我的查询历史记录

delete - 删除某个单号查询记录

quickdel - 回复某条查询消息来快速删除单号查询记录

query - 查询美剧、电影

yyets - 查询下载链接

weather - 查询指定城市近期天气预报

截图

使用方法1：查快递

添加机器人，直接发送运单编号即可查询（并添加到追踪中）； 如果你的单号带有字母，请使用/start danhao123； 如果你需要一次性追踪多个单号，请/start 123,123，使用英文半角逗号分隔（当然了，更新了就惨了)

使用方法2：闲聊

直接发送消息即可，也可以发送语音（中文普通话）

使用方法3：查美剧

  • 查询美剧/日剧/电影：/query 蝙蝠侠
  • 获得下载链接：/yyets 神盾局，之后点击按钮操作

部署环境

需要部署在可以访问Telegram API的服务器上（或者设置代理），同时支持Python 2和Python 3 Python 3的支持可能存在一些问题！！ 已经在以下平台测试通过（目前主要测试于Windows/Ubuntu的Python 2.7：

Windows 10： Python 2.7.13 32bit Python 3.6.3 32bit

Ubuntu 16.04/14.04、CentOS 7、Debian 9： Python 2.7

关于Centos：
BennyThink:反正我是测试通过了
johnpoint：反正我这边没有成功过
     ——————各位自便

部署方法1.自动脚本（配置文件/环境变量模式)

一键脚本在systemd的情况下运行会更好，一键脚本仅测试于Ubuntu 16.04： 先切换到root用户：

wget -N --no-check-certificate https://raw.githubusercontent.com/BennyThink/ExpressBot/master/install.sh && bash install.sh

然后按照提示操作。支持systemd的系统会同时安装为systemd服务，其他系统可以使用对应的init手动配置或使用supervisor 快捷操作

# 启动服务 
bash install.sh start
# 停止服务 
bash install.sh stop

注：CentOS下如果提示wget: command not found请先安装wget yum install wget

部署方法2.手动配置

如果一键脚本失败，可以试试手动配置

(1). 克隆代码

git clone https://github.com/BennyThink/ExpressBot
cd ExpressBot

(2). 准备环境

Arch Linux

pacman -S python python-pip python-certifi python-chardet python-future python-idna python-requests python-six python-urllib3
然后从 AUR 安装  python-pytelegrambotapi .

其他发行版、macOS

Python3 请使用pip3替换pip

pip install setuptools
pip install -r requirements.txt

Windows

从Python官网下载并安装Python，切换到项目目录，如果是 Python 2:

pip install -r requirements.txt

如果是 Python 3，执行如下命令：

pip3 install -r requirements.txt

(3). 准备ffmpeg

ffmpeg是为了支持音频识别（使用ffmpe进行音频文件的转码）。

如果你是Windows，从这里下载ffmpeg的二进制exe文件，放到PATH中； 如果你是Linux发行版，直接用包管理器安装就可以（编译或者下载二进制也行），Debian系可以使用sudo apt install ffmpeg，RHEL可以使用yum install ffmpeg

(4). 配置

为了方便更新，推荐在环境变量中设置的TOKEN，这样可以随时更新而不用考虑merge，不过配置文件模式也简单好用呢。

配置文件版本

修改config.py进行配置，TOKEN为Bot的API，TURING_KEY若不配置则不启用机器人功能，DEBUG为设置是否在控制台输出debug信息，0为不输出；DB_PATH为数据库文件的绝对路径

TOKEN = 'Your TOKEN'
TURING_KEY = 'Your Key'
DB_PATH = '/home/ExpressBot/expressbot/bot.db'
DEBUG = 0

systemd 版本

systemd无法直接使用.bashrc等文件的环境变量，第一种方法是编辑对应的service配置文件（强烈推荐也把DB_PATH和TOKEN写入到.bashrc中，这样后续的一些小工具可以直接应用）： 创建单元文件：vim /lib/systemd/system/expressbot.service 自行替换输入如下信息

[Unit]
Description=A Telegram Bot for querying expresses
After=network.target network-online.target nss-lookup.target

[Service]
Environment="TOKEN=12345"
Environment="DB_PATH=/home/ExpressBot/expressbot/bot.db"
Environment="TURING_KEY=111111"
Environment="DEBUG=0"
Restart=on-failure
Type=simple
ExecStart=/usr/bin/python /home/ExpressBot/expressbot/main.py

[Install]
WantedBy=multi-user.target

重新载入daemon、自启、启动

systemctl daemon-reload
systemctl enable expressbot.service
systemctl start expressbot.service

我使用了restart=on-failure参数，失败退出会重启。如果设置成always就意味着无论因为什么原因，只要进程不在了，systemd就会立刻帮我们重启。详情可以参见systemd.service手册。

第二种是运行systemctl --user import-environment导入，运行systemctl --user show-environment查看。 更多资料参考Arch Linux Systemd wiki

(5). 运行

测试目的的话，以nohub或screen运行main.py，Python 3请用python3替换为python

cd /home/ExpressBot/expressbot
nohup python main.py
# 或者
cd /ExpressBot/expressbot
screen -S tgbot
python main.py

(6). 计划任务

如果需要追踪更新并推送，那么咱需要定期轮询。

目前使用的定时器是apscheduler，原先的cron已经被弃用了（但是脚本依旧保留没有删除）。main.py的参数表示间隔时间，python main.py 60表示60分钟轮询一次，不加则默认为120分钟。

如果有特殊需要，可以自行修改这个参数。systemd用户需要编辑/lib/systemd/system/expressbot.service更改如下行参数：

ExecStart=/usr/bin/python /home/ExpressBot/expressbot/main.py 60

(7). 检查运行状态

  • systemd 控制命令：
# 查看运行状态
sudo systemctl status expressbot.service
# 启动
sudo systemctl start expressbot.service
# 停止
sudo systemctl stop expressbot.service
# 重启
sudo systemctl restart expressbot.service
  • 其他系统 可以考虑使用对应系统的init，或者使用supervisor

隐私

首先，请允许我大力的打击你，所有发往此机器人的消息都可能被记录下来。 但是实际上，此机器人比较良心，默认只会在数据库中记录查询成功之后的以下信息，使用/list命令可以看到：

  • message_id 每条消息的id，用于任务计划跟踪物流发送回复
  • chat_id 也是用户ID，用于标记回复给谁
  • type 快递公司名称
  • track_id 运单编号
  • content 最新的物流信息
  • status 快递状态
  • date 最新物流更新时间

如果你发送了语音，那么语音文件会被放到/tmp目录下 我不保证我能够有节操不去查看数据库，但是我保证我会妥善保护数据库、不外泄。

所以，你要是不想用，就不用吧；或者，查完就删掉也是可以的。

另类用法1：消息记录机器人

有一个文件叫msg.py，如果为了debug等需求（比如说journalctl发现抛异常了，此时如果能够找到造成此次异常的聊天消息那就是最好的了），或者想记录、备份群组消息，可以将开头的ENABLE = os.environ.get('logger')改成ENABLE = True（或加入环境变量）。

这样和机器人之间的消息会被记录到logger.db中（懒得设置，所以可能直接存在/）。 当然了，群组中你就不能设置图灵API了（甚至应该将查询快递的功能也废掉免得机器人乱说话）。 另外，群组中需要开启机器人的隐私模式。

另类用法2：广播所有用户

如果用户曾经使用机器人查询过快递，那么我们可以这样来给所有用户发送广播信息：

python /home/Expressbot/expressbot/broadcast.py 大家好

将“最新公告”替换为数字0为查看目前总计未完成任务列表。

FAQ

服务器错误

唔，可能是快递100的接口炸了吧；稍后重试。

SSL InsecurePlatform error

哦，你可能用的是 Python 3.5 吧，我也不太了解具体原因。试试 Python 2.7 或者Python 3.6吧。

查询不到结果

可能是刚刚生成单号，快递100还没有数据

顺丰

目前暂时没有找到可靠的REST API的顺丰快递查询接口。

查询失败

目前正打算更换快递api，看样子好像快递鸟是个比较好的选择（支持推送），但是需要实名认证……

query和yyets的区别

yyets用于通过点击InlineKeyboardButton获取到正确的下载链接，但是前提要求是只能有一个检索结果（多个结果只返回第一个）；query则是用于检索全部信息。 比如说我想下载诺兰的黑暗骑士崛起，我就可以通过query找到唯一的名字，然后使用/yyets 《蝙蝠侠：黑暗骑士崛起》(The Dark Knight Rises)获取到唯一的结果。

timer.py, broadcast.py

在某些系统下，运行python timer.py会报错，大致内容如下：

Exception in thread WorkerThread2 (most likely raised during interpreter shutdown):Exception in thread WorkerThread1 (most likely raised during interpreter shutdown):
Traceback (most recent call last):
  File "/usr/lib/python2.7/threading.py", line 801, in __bootstrap_inner
  File "/usr/local/lib/python2.7/dist-packages/telebot/util.py", line 61, in run
<type 'exceptions.AttributeError'>: 'NoneType' object has no attribute 'Empty'

Traceback (most recent call last):
  File "/usr/lib/python2.7/threading.py", line 801, in __bootstrap_inner
  File "/usr/local/lib/python2.7/dist-packages/telebot/util.py", line 61, in run
<type 'exceptions.AttributeError'>: 'NoneType' object has no attribute 'Empty'

目前的测试有： Windows 下 Python 2/3 无此问题； Linux下（Ubuntu 16.04）Python 2，TeleBot实例必须要执行一个操作（比如说bot.get_me(),bot.send_message())，否则会导致抛出如上异常；Python 3 无此问题。 所以目前，timer.py与broadcast.py采取独立引入 TeleBot 的设计，只要数据库中存在对应的条目、会执行一个操作，那么就不会抛异常了。

致谢

TODO

按完成状态、优先级排列

  • 这个机器人可以跟你聊天扯淡呢~
  • Python 3 支持
  • Bug 修复：不显示最新
  • 一键脚本支持环境变量安装模式：在安装时选择环境变量模式还是配置模式，仅支持systemd
  • 单消息多单号处理：/start 123,123 英文半角逗号
  • 语音识别
  • 使用requests，抛弃pycurl
  • 即使订单刚刚生成，也可以加入到追踪列表中而不是报错（已移除）
  • 搜索电影（目前准备使用人人影视的接口）
  • SSL 证书问题：目前暂时禁用了InsecureRequestWarning
  • 给全体用户发送广播：管理员专用
  • 改用apscheduler 测试中
  • TravisCI 测试用例 部分完成
  • 人人影视 Access Key
  • 添加其他聊天机器人支持ref
  • systemd与bash相爱相杀：真的有必要写两次吗
  • 更换快递api，放弃轮询模式

License

GPL v2

About

一个可以帮你订阅、查询快递物流、跟你闲聊Telegram机器人

https://www.bennythink.com/expressbot.html

License:GNU General Public License v2.0

Languages

Language:Python 87.4%Language:Shell 12.6%