XMU-Daily-Reporter 项目使用教程

XMU-Daily-Reporter 项目使用教程

1. 项目的目录结构及介绍

XMU-Daily-Reporter/
├── bin/
│   └── github_action/
├── include/
├── src/
├── github/
│   └── workflows/
├── CMakeLists.txt
├── LICENSE
├── README.md
└── report_setting.json

• bin/: 存放与GitHub Action相关的脚本文件。
• include/: 存放项目的头文件。
• src/: 存放项目的源代码文件。
• github/workflows/: 存放GitHub Action的工作流配置文件。
• CMakeLists.txt: CMake构建文件，用于编译项目。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• report_setting.json: 项目的配置文件，用于设置打卡的相关参数。

2. 项目的启动文件介绍

项目的启动文件主要位于src/目录下，具体文件包括但不限于：

• main.cpp: 主程序入口文件，负责初始化程序并启动打卡流程。
• report.cpp: 负责具体的打卡操作，包括与服务器通信、提交打卡数据等。
• email_notification.cpp: 负责发送邮件通知，通知用户打卡结果。

3. 项目的配置文件介绍

项目的配置文件为report_setting.json，该文件包含了程序运行所需的各种配置参数。以下是配置文件的主要内容及解释：

{
  "form_data": "blablaaaaaaaaa",  // 每次打卡时POST的表单信息，如果生病了记得修改
  "mail": {
    "address": "1000000@qq.com",  // 填入你的邮箱地址，如果不想发送通知邮件，填入一个空字符串("")即可
    "reporter_name": "HAL-9000",  // 汇报机器人的名字，会在通知邮件中显示
    "smtp_password": "123456"     // 你的邮箱的SMTP服务的密码
  },
  "report_retry": {
    "counts": 20,                 // 打卡失败时重试的次数
    "duration": 10                // 打卡失败时每次重试间隔的秒数
  },
  "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)",  // 浏览器信息
  "xmu": {
    "ID": "23320779999999",       // 你的学号
    "password": "123456"          // 你的密码
  }
}

• form_data: 每次打卡时提交的表单信息，如果身体状况有变化，需要手动修改。
• mail: 邮件通知相关的配置，包括邮箱地址、发送人名字和SMTP密码。
• report_retry: 打卡失败时的重试策略，包括重试次数和每次重试的间隔时间。
• user_agent: 模拟的浏览器信息，用于与服务器通信。
• xmu: 学生的个人信息，包括学号和密码。

通过以上配置，用户可以自定义打卡行为，包括是否发送邮件通知、打卡失败时的重试策略等。