NCU Human Sys Auto Sign

中央人事系統自動簽到退小工具

這是一支用於中央大學人事系統自動簽到退的小工具，能在排定的時間自動打卡，免除需要設定鬧鐘手動簽到退的惡夢。

目前程式開發的進度為，

• 模擬簽到退請求並進行簽到退作業
• 排程執行
• 簽到結果推播通知 (例如 Discord 或 Slack)
• Web Server版 - 供多人同時使用

此工具主要使用透過 Portal 記住我功能獲取的30天有效登入狀態 Cookie，模擬使用者登入 Portal 並從選單點選人事系統選項登入人事系統，最後對指定人事系統簽到頁面進行簽到退之動作。

30天有效登入狀態 Cookie 須由使用者自行先到 Portal 頁面使用記住我功能進行登入操作後，自行複製登入後的 Portal Cookie 狀態。

目前功能基本完成，等待實際使用測試，待測試完再就發現的問題進一步修正。

未來希望能夠改為 Web Server 版，提供網頁介面讓多人同時使用。

若想要執行簽到流程測試，使用步驟如下，

1. 安裝專案所需的 python 相依套件

   pip install -r requirements.txt

2. 使用者自行透過 Portal 頁面記住我功能進行登入，並複製 Portal Cookie 內容

3. 使用者自行進入到人事系統目標簽到頁面，並複製網址上的頁面 ID (ParttimeUsuallyId)

4. 在 ncu_hsys 資料夾下創建 .env 檔案，可參考 .env.example 進行設定，將上述複製的內容設置於 .env 內

   PORTAL_TOKEN={Portal Cookie}
   PARTTIME_USUALLY_ID={ParttimeUsuallyId}
   

5. 在專案根目錄執行 ncu_hsys.sign_bot 可進行簽到退流程測試

   python -m "ncu_hsys.sign_bot"

若要執行排程自動簽到，則使用步驟如下，

1. 安裝專案所需的 python 相依套件

   pip install -r requirements.txt

2. 使用者自行透過 Portal 頁面記住我功能進行登入，並複製 Portal Cookie 內容

3. 使用者自行進入到人事系統目標簽到頁面，並複製網址上的頁面 ID (ParttimeUsuallyId)

4. (Optional) 使用者自行至想要接收通知的 Discord 頻道，產生 Webhook 網址 (對頻道按右鍵點選編輯頻道，進到整合頁面新增)。

5. 在專案根目錄資料夾下創建 .env 檔案，可參考 .env.example 進行設定，將上述複製的內容設置於 .env 內，並設定簽到與簽退的排程時間，可使用crontab.guru小工具進行輔助

   DISCORD_WEBHOOK_URL={Discord Webhook URL} (Optional)
   PORTAL_TOKEN={Portal Cookie}
   PARTTIME_USUALLY_ID={ParttimeUsuallyId}
   SIGNING_DAY={Signing days at each month}
   SIGN_IN_HOUR={Sign-in hour each day}
   SIGN_IN_MINUTES={Sign-in minutes at each hour}
   SIGN_OUT_HOUR={Sign-out hour each day}
   SIGN_OUT_MINUTES={Sign-out minutes at each hour}
   

   環境變數 DISCORD_WEBHOOK_URL 可忽略不設定或留空。若該環境變數未被設定或留空，則 Discord 通知通功能將自動停用。

6. 在專案根目錄執行 main.py 可進行排程自動簽到

   python main.py

7. 執行程式後，可從程式訊息輸出窗口與 logs 目錄底下查看執行日誌

   

若要使用 Docker 執行排程自動簽到，則使用步驟如下，

此專案在 Release 時會自動建構最新版本的映像至此 Docker Hub Repository

1. 啟動容器執行自動簽到作業，可以參考下方指令啟動

   docker run -d --rm --env-file .env --name <自訂名稱> ares30841167/ncu-human-sys-auto-sign:v*.*.*

   docker run -d --restart always --env-file .env --name <自訂名稱> ares30841167/ncu-human-sys-auto-sign:v*.*.*

2. (Optional) 可將 Logs 目錄進行映射至卷(Volume)上，以保存日誌檔案。若要映射請使用此步驟指令啟動容器，跳過步驟一。

   docker run -d --rm --env-file .env -v ncu-hsys-auto-sign-logs:/app/logs --name <自訂名稱> ares30841167/ncu-human-sys-auto-sign:v*.*.*

   docker run -d --restart always --env-file .env -v ncu-hsys-auto-sign-logs:/app/logs --name <自訂名稱> ares30841167/ncu-human-sys-auto-sign:v*.*.*

1. 建構 Docker Image

   docker build . -t <Tag名稱>

2. 啟動容器執行自動簽到作業，可以參考下方指令啟動

   docker run -d --rm --env-file .env --name <自訂名稱> <Tag名稱>

   docker run -d --restart always --env-file .env --name <自訂名稱> <Tag名稱>

3. (Optional) 可將 Logs 目錄進行映射至卷(Volume)上，以保存日誌檔案。若要映射請使用此步驟指令啟動容器，跳過步驟二。

   docker run -d --rm --env-file .env -v ncu-hsys-auto-sign-logs:/app/logs --name <自訂名稱> <Tag名稱>

   docker run -d --restart always --env-file .env -v ncu-hsys-auto-sign-logs:/app/logs --name <自訂名稱> <Tag名稱>

• Notes icons created by Freepik - Flaticon