/ucas-covid19

ucas疫情防控每日填报助手

Primary LanguagePython

ucas-covid19

国科大疫情防控每日填报助手，用于解决忘记填写企业微信中身体状况每日打卡的问题。

注意

本人不对因为滥用此程序造成的后果负责，请在合理且合法的范围内使用本程序。

本程序仅用于解决忘记打卡这一问题，如果填报表中任意情况发生变化，比如地点发生变化，处在居家隔离阶段等情况，请务必在程序运行之前手动打卡。由于各种已知的或未知的原因可能造成打卡信息不一定总是准确的，请经常人工查看企业微信里面的填报表信息是否正确

本程序仅供 14 日内没有离京并且没有任何异常情况的同学使用，请 14 日内有离京经历或者异常情况的同学认真且如实手工填写每日健康信息。如果 14 日内有离京经历，程序将会直接退出拒绝打卡。 --2021/8/1

打卡网站可能会经常更新，因此代码会做更改。如果在使用过程中遇到问题或者发现 bug，可以提 issue 或者加入 Telegram 交流，代码更新也会在此处通知。 如果想要即时得知代码的更新请 watch 本仓库。

有特殊需求的同学可以修改本代码，但请遵守CC BY-NC-SA 3.0 许可协议。

方法一： 使用自己的服务器运行

用法

  1. 点击右上角star :)
  2. 安装方式一
    • 直接将项目下载到服务器上，推荐使用git clone 或者wget的方式
    • 进入到项目文件夹中，使用pip3 install -r requirement.txt命令一键安装依赖或者手动安装。依赖库为requests和pytz
    • 修改项目文件夹里面sub.py代码里面的sep账号和密码
  3. 安装方式二
    • 下载本项目到本地
    • 修改本地项目里面sub.py代码里面的sep账号和密码
    • 将sub.py上传到服务器上，安装依赖requests库和pytz库
  4. 安装方式三(偷懒版)
    • 在服务器中创建sub.py文件，然后复制本仓库sub.py中的代码到服务器sub.py文件。随后，修改服务器中sub.py代码里面的sep账号和密码。最后安装依赖。
  5. （可选）填写server酱的api，填写之后可以在程序完成打卡之后通知到微信，如果不填写不影响使用(注意：微信消息模板可能在2021年4月下线，服务可能失效)
  6. 修改crontab，设定为每天八点半运行。

具体修改：

$ crontab -e # 进入crontab的文本模式
30 8 * * * /usr/bin/python3  /root/ucas-covid19/sub.py >>/tmp/yqfk.log # 在文本最后一行添加,注意修改为实际路径，大约2分钟后生效，重启服务直接生效。请注意这里使用是python3不是python2

建议

  1. 定时时间设定到8:30，每天如果记起来了就手工填写，如果忘记了就由程序定时填写。填写的内容会和昨天的一致，地点也会保持昨天的地点不变。
  2. 脚本运行所在的服务器的地理位置不会影响打卡的位置。
  3. 如果手工完成了打卡，程序会显示今日已经打卡，不会影响之前手工打卡的结果。

注意

  1. crontab会读取/etc/localtime的时区，而不是当前用户的时区，所以crontab里面的定时八点可能并不是UTC+8的早晨八点，解决方案是设置系统时区为UTC+8即可
TZ=Asia/Shanghai
ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone

方法二： 使用 GitHub Actions（推荐使用）

没有服务器的同学可以使用 GitHub Action 来进行运行此程序。

请勿直接修改sub.py内的登录账号和密码，Github的公开仓库的内容可以被所有人查看。

Github提供了一个secret功能，用于存储密钥等敏感信息，请按照以下步骤操作。

使用步骤:

  • 点击右上角 star :)
  • 克隆这个仓库到你名下
  • fork的仓库默认禁用了workflow，需要手动打开：点击 actions选项卡，点击I understand my workflows, go ahead and run them。
  • 在仓库设置里面, 设置 secrets 如下
    • SEP_USER_NAME: 你的 SEP 用户名(邮箱)
    • SEP_PASSWD: 你的 SEP 密码
    • server酱通知设置（需要server酱通知时设置）：
      • API_KEY: 你的通知server酱的api key，填写之后可以在程序完成打卡之后通知到微信，如果不填写不影响使用
    • 邮件通知设置（需要邮件通知时设置）：
      • SMTP_PORT: 邮件服务器端口，不设置即为qq邮件服务器端口：465
      • SMTP_SERVER: 邮件服务器地址，不设置即为qq邮件服务器：smtp.qq.com
      • SENDER_EMAIL: 发送通知打卡通知邮件的邮箱，必须设置
      • SENDER_EMAIL_PASSWD: 发送通知打卡通知邮件的邮箱密码，需要开启邮箱smtp服务，此处可能不为邮箱的登录密码，如：qq邮箱为授权码，需要在设置中生成，必须设置
      • RECEIVER_EMAIL: 接收打卡通知邮件的邮箱，必须设置
  • 测试actions是否可以正常工作：编辑本项目内任意文件，推荐修改README.md，比如添加一个空行，并提交以触发action运行，提交后的一分钟左右可以在action选项卡中看到运行记录

参考截图设定以上三个secrets，API_KEY可选。

完成之后, 每天 UTC 0:10 (北京时间 8:10) 自动触发 github actions 进行填报 。

如果 fork 之后想更新至本仓库最新代码，请参考此教程 。

方法三：使用Windows的任务计划程序（适合每天需要打开电脑来学习的同学）

不需要服务器，不需要了解github actions, 本地运行，不需担心sep账号密码泄露。

需要本地电脑安装python3，并且安装依赖库pytz和requests，可以使用命令pip install -r requirements.txt 来进行一键安装，并设置好环境变量。 使用步骤：

  • git clone 本仓库
  • 修改sub.py中的SEP账号密码
  • 创建一个autosubWin.bat文件，写入以下内容
@echo off
python3 \path\to\sub.py %具体路径替换成sub.py的路径%
%py -3 \path\to\sub.py 如果电脑同时装了python3和python2的话就使用这个。%
pause

  • 搜索打开任务计划程序，按照下图在Windows目录下创建任务，事件设为执行autosubWin.bat,触发器设为每天早上固定时间就行

  • 有一个需要注意的点，在条件那儿要注意看是否勾选了“只有在计算机使用交流电源时才启动此任务”，勾选了记得取消，不然电脑没在充电状态就不会执行这个任务

    任务计划程序的设置会很直观，你还可以设置如果任务执行失败后多长时间再次尝试执行。需要注意的一点是，设定的时间最好能切合自己常打开电脑的时间。任务执行的时候，会弹出一个DOS窗口，执行完成之后关掉即可。

方案四：使用MacOS的crontab定时任务（适合每天需要打开电脑来学习的同学）

MacOS和Linux服务器操作类似，也是基于crontab。基本操作见方案一。与方案一稍微有点区别：①是需要创建一个文件，②是需要手动开启crontab服务，③是无需做时区调整操作。

  1. 下载本项目到本地

  2. 修改本地项目里面sub.py代码里面的sep账号和密码

  3. （可选）填写server酱的api，填写之后可以在程序完成打卡之后通知到微信，如果不填写不影响使用

  4. 创建 /etc/crontab

    查看com.vix.cron启动项的配置，注意里面有个KeepAlive的条件是 /etc/crontab 是否存在，存在才会执行。检查发现不存在，要手动创建：

$ sudo touch /etc/crontab
  1. 启动crontab服务
$ sudo /usr/sbin/cron start

# 注：MacOS中crontab服务的启动、重启、关闭
#sudo /usr/sbin/cron start
#sudo /usr/sbin/cron restart
#sudo /usr/sbin/cron stop
  1. 修改crontab，设定为每天8:30、14:10、20:15运行，注意需要修改以下命令的路径为实际路径。(考虑到定时执行时可能正好电脑休眠或者没有网络，单次可能失败，故多次重复确保成功率)
$ crontab -e
30 8 * * * /usr/bin/python3  /root/ucas-covid19/sub.py >>/tmp/yqfk.log
10 14 * * * /usr/bin/python3  /root/ucas-covid19/sub.py >>/tmp/yqfk.log
15 20* * * /usr/bin/python3  /root/ucas-covid19/sub.py >>/tmp/yqfk.log

跋

只接受PR，不接受需求。

changelog

  • 2020年4月15日 添加了随机等待10-600秒之后再进行填报
  • 2020年4月15日 添加了user-agent
  • 2020年4月15日 更新了README，添加了设定secrets页面的截图
  • 2020年6月12日 更新了README，提醒同学请勿直接在代码中填写密码
  • 2020年6月14日 更新了README，添加有关触发action运行的说明
  • 2020年6月24日 适配了网站的字段的更新；添加了 debug模式隐藏打卡信息；github action直接输出打卡结果；移除了 serverless 方式的支持
  • 2020年9月16日 适配了网站的字段的更新
  • 2020年9月26日 更新了README，添加了使用windows计划任务的操作步骤
  • 2020年11月3日 更新了README，添加了 MacOS系统中 crontab 的配置方法
  • 2020年11月6日 添加了 Telegram Group
  • 2020年11月7日 使用环境变量传递口令，解决密码中存在特殊字符导致 sed 截断的问题
  • 2020年11月9日 bugfix: 修复环境变量传递口令中存在的 bug， 经过测试已经 work 了，面壁思过中 :(
  • 2020年12月2日 网站证书配置有误导致打卡失败，修改代码为不验证证书
  • 2020年12月22日 添加邮件通知
  • 2021年1月21日 判断所在地点是不是国内，如果不是国内，则提示手动打卡
  • 2021年1月25日 添加 去往何处等字段
  • 2021年1月25日 缓存了 cookies 到文件中，避免登录失败导致无法打卡
  • 2021年1月25日 重构了检查提交信息的代码
  • 2021年1月25日 重构了发送通知的代码
  • 2021年1月25日 添加了 github actions 缓存 cookies 的配置
  • 2021年1月27日 优化了取 github 环境变量的方式，减少未设置变量导致出错的概率；兼容 python 3.5 的 pathlib
  • 2021年1月29日 解决接触时间 1970-01-01的问题， 见 issue 36
  • 2021年8月2日 只允许 14 天内未离京的同学使用该程序，删除非必要的键，如果 14 天内有异动，提示手动打卡; 修改了方糖通知的 api 调用的 url；网站证书配置的问题似乎已经修复，目前设置为正常的验证 ssl 证书
  • 2021年8月15日 添加了 tg bot 消息推送；修复了 sender_email 默认不为空导致未配置邮件发送也会发送邮件的 bug，见 PR#44

致谢

  • 感谢 karuboniru 提供的github actions 支持
  • 感谢 tyfulcrum 对文档的完善工作
  • 感谢 HsimWong 对文档的完善工作
  • 感谢 spwpun 添加了使用 windows 计划任务的操作步骤
  • 感谢 PrimeMHD 添加了使用 MacOS 的 crontab 的配置步骤
  • 感谢 T-winkle 添加了邮件通知打卡结果的功能
  • 感谢 lizard1998myx 修复了提交信息缺少去往何处等字段的问题
  • 感谢 elfisworking 添加了依赖文件和完善了服务器部署说明
  • 感谢 waruto210 添加了对 tg 通知的支持和修复了 smtp 邮件发送者默认不为空的 bug

知识共享许可协议
本作品采用知识共享署名-非商业性使用-相同方式共享 3.0 未本地化版本许可协议进行许可。

Les1ie

2020-4-5 23:56:52