e3cli 0.3.1__py3-none-any.whl

e3cli/i18n.py

@@ -0,0 +1,233 @@
+"""
+雙語支援 — 根據系統語言自動切換中文/英文。
+
+使用者可透過環境變數 E3CLI_LANG=en 或 E3CLI_LANG=zh 手動指定。
+"""
+
+from __future__ import annotations
+
+import locale
+import os
+
+_STRINGS: dict[str, dict[str, str]] = {
+    # === CLI help ===
+    "cli.help": {
+        "zh": "NYCU E3 Moodle 自動化工具",
+        "en": "NYCU E3 Moodle automation tool",
+    },
+    "cli.login": {"zh": "登入取得 token", "en": "Login and get token"},
+    "cli.logout": {"zh": "清除認證資料", "en": "Clear credentials"},
+    "cli.courses": {"zh": "列出修課清單", "en": "List enrolled courses"},
+    "cli.assignments": {"zh": "列出作業與截止日期", "en": "List assignments and deadlines"},
+    "cli.download": {"zh": "下載課程教材", "en": "Download course materials"},
+    "cli.submit": {"zh": "提交作業", "en": "Submit assignment"},
+    "cli.sync": {"zh": "全量同步", "en": "Full sync"},
+    "cli.schedule": {"zh": "管理定時同步排程", "en": "Manage sync schedule"},
+    "cli.setup": {"zh": "重新執行初始設定引導", "en": "Re-run setup wizard"},
+    "cli.version": {"zh": "顯示版本", "en": "Show version"},
+
+    # === Login ===
+    "login.prompt_user": {"zh": "帳號", "en": "Username"},
+    "login.prompt_pass": {"zh": "密碼: ", "en": "Password: "},
+    "login.connecting": {"zh": "正在連線 {url} ...", "en": "Connecting to {url} ..."},
+    "login.success": {"zh": "✓ 登入成功！Token 已儲存。", "en": "✓ Login successful! Token saved."},
+    "login.success_saved": {
+        "zh": "✓ 登入成功！Token 已儲存，帳密已加密保存。",
+        "en": "✓ Login successful! Token saved, credentials encrypted.",
+    },
+    "login.hint_save": {
+        "zh": "提示: 加上 --save 可記住帳密，下次用 --refresh 自動重新登入。",
+        "en": "Tip: use --save to remember credentials, --refresh to auto-login next time.",
+    },
+    "login.no_saved": {
+        "zh": "找不到已儲存的帳密，請先用 e3cli login --save 登入。",
+        "en": "No saved credentials found. Run e3cli login --save first.",
+    },
+    "login.use_saved": {
+        "zh": "使用已儲存的帳號 ({user}) 登入？",
+        "en": "Login with saved account ({user})?",
+    },
+    "login.refreshing": {
+        "zh": "使用已儲存的帳密重新取得 token ({user}) ...",
+        "en": "Refreshing token with saved credentials ({user}) ...",
+    },
+    "login.opt_username": {"zh": "學號/帳號", "en": "Student ID / Username"},
+    "login.opt_save": {"zh": "加密儲存帳密，下次自動登入", "en": "Save credentials (encrypted) for auto-login"},
+    "login.opt_refresh": {"zh": "使用已儲存的帳密重新取得 token", "en": "Refresh token using saved credentials"},
+
+    # === Logout ===
+    "logout.done": {"zh": "✓ 所有認證資料已安全清除。", "en": "✓ All credentials securely erased."},
+
+    # === Courses ===
+    "courses.title": {"zh": "修課清單", "en": "Enrolled Courses"},
+    "courses.col_id": {"zh": "ID", "en": "ID"},
+    "courses.col_code": {"zh": "課程代碼", "en": "Code"},
+    "courses.col_name": {"zh": "課程名稱", "en": "Course Name"},
+    "courses.empty": {"zh": "找不到任何課程。", "en": "No courses found."},
+
+    # === Assignments ===
+    "assign.title": {"zh": "作業列表", "en": "Assignments"},
+    "assign.col_course": {"zh": "課程", "en": "Course"},
+    "assign.col_name": {"zh": "作業名稱", "en": "Assignment"},
+    "assign.col_due": {"zh": "截止日期", "en": "Due Date"},
+    "assign.col_status": {"zh": "狀態", "en": "Status"},
+    "assign.no_deadline": {"zh": "無截止日", "en": "No deadline"},
+    "assign.expired": {"zh": "已過期", "en": "Expired"},
+    "assign.days_left": {"zh": "{n}天後", "en": "in {n} days"},
+    "assign.empty": {"zh": "沒有符合條件的作業。", "en": "No matching assignments."},
+    "assign.opt_due_soon": {"zh": "只顯示 N 天內到期的作業", "en": "Show assignments due within N days"},
+
+    # === Download ===
+    "dl.need_flag": {"zh": "請指定 --course 或 --all", "en": "Specify --course or --all"},
+    "dl.no_match": {"zh": "找不到符合 '{q}' 的課程", "en": "No course matching '{q}'"},
+    "dl.no_new": {"zh": "沒有新檔案", "en": "No new files"},
+    "dl.progress": {"zh": "下載中...", "en": "Downloading..."},
+    "dl.done": {
+        "zh": "✓ 完成！下載 {new} 個新檔案，略過 {skip} 個已存在的檔案。",
+        "en": "✓ Done! Downloaded {new} new files, skipped {skip} existing.",
+    },
+    "dl.opt_course": {"zh": "只下載特定課程 (課程代碼或名稱的子字串)", "en": "Download specific course (substring match)"},
+    "dl.opt_all": {"zh": "下載所有課程的教材", "en": "Download all course materials"},
+
+    # === Submit ===
+    "submit.not_found": {"zh": "檔案不存在: {f}", "en": "File not found: {f}"},
+    "submit.checking": {"zh": "檢查作業 #{id} 狀態...", "en": "Checking assignment #{id} status..."},
+    "submit.check_fail": {"zh": "✗ 無法取得作業資訊: {e}", "en": "✗ Cannot get assignment info: {e}"},
+    "submit.past_due": {
+        "zh": "✗ 作業已於 {dt} 截止。使用 --force 可強制提交。",
+        "en": "✗ Assignment was due {dt}. Use --force to submit anyway.",
+    },
+    "submit.uploading": {"zh": "上傳 {n} 個檔案...", "en": "Uploading {n} file(s)..."},
+    "submit.submitting": {"zh": "提交作業中...", "en": "Submitting..."},
+    "submit.ok": {"zh": "✓ 作業提交成功！", "en": "✓ Assignment submitted!"},
+    "submit.draft": {
+        "zh": "⚠ 作業已儲存為草稿，可能需要到 Moodle 手動確認提交。",
+        "en": "⚠ Saved as draft. You may need to confirm on Moodle.",
+    },
+    "submit.opt_text": {"zh": "線上文字內容 (可選)", "en": "Online text content (optional)"},
+    "submit.opt_force": {"zh": "強制提交（即使已過截止日）", "en": "Force submit (even past deadline)"},
+
+    # === Sync ===
+    "sync.syncing": {"zh": "同步中 — {name}", "en": "Syncing — {name}"},
+    "sync.new_assign": {"zh": "★ 新作業: [{course}] {name}", "en": "★ New: [{course}] {name}"},
+    "sync.assign_fail": {"zh": "取得作業資訊失敗: {e}", "en": "Failed to get assignments: {e}"},
+    "sync.done": {
+        "zh": "✓ 同步完成 — {files} 個新檔案, {assigns} 個新作業",
+        "en": "✓ Sync done — {files} new files, {assigns} new assignments",
+    },
+    "sync.opt_quiet": {"zh": "安靜模式（適用排程）", "en": "Quiet mode (for cron)"},
+
+    # === Schedule ===
+    "sched.enabled": {"zh": "✓ 已啟用定時同步，每 {m} 分鐘執行一次。", "en": "✓ Auto-sync enabled, every {m} minutes."},
+    "sched.disabled": {"zh": "✓ 已停用定時同步。", "en": "✓ Auto-sync disabled."},
+    "sched.status_on": {"zh": "✓ 排程已啟用", "en": "✓ Schedule active"},
+    "sched.status_off": {
+        "zh": "排程未啟用。使用 e3cli schedule enable 來啟用。",
+        "en": "Schedule not active. Run e3cli schedule enable to activate.",
+    },
+    "sched.opt_interval": {"zh": "同步間隔 (分鐘)", "en": "Sync interval (minutes)"},
+
+    # === Setup wizard ===
+    "setup.welcome": {"zh": "首次使用，讓我們快速完成設定！", "en": "First time? Let's set things up!"},
+    "setup.step_url": {"zh": "Moodle 網址", "en": "Moodle URL"},
+    "setup.step_url_hint": {
+        "zh": "預設為 NYCU E3 平台，直接按 Enter 使用預設值",
+        "en": "Default is NYCU E3. Press Enter to use default.",
+    },
+    "setup.step_dir": {"zh": "教材下載目錄", "en": "Download directory"},
+    "setup.step_dir_hint": {"zh": "課程教材會下載到這個資料夾", "en": "Course materials will be saved here"},
+    "setup.step_save": {"zh": "儲存設定", "en": "Save config"},
+    "setup.config_saved": {"zh": "✓ 設定已儲存至 {path}", "en": "✓ Config saved to {path}"},
+    "setup.step_login": {"zh": "登入帳號", "en": "Login"},
+    "setup.want_login": {"zh": "現在要登入嗎？", "en": "Login now?"},
+    "setup.prompt_id": {"zh": "帳號 (學號)", "en": "Username (Student ID)"},
+    "setup.want_save_creds": {"zh": "記住帳密？(加密儲存，下次自動登入)", "en": "Remember credentials? (encrypted, auto-login)"},
+    "setup.login_fail_hint": {
+        "zh": "沒關係，之後可以用 e3cli login 重新登入。",
+        "en": "No worries, run e3cli login later.",
+    },
+    "setup.done_title": {"zh": "設定完成！", "en": "Setup complete!"},
+    "setup.done_body": {
+        "zh": (
+            "接下來你可以：\n"
+            "  [cyan]e3cli courses[/cyan]        列出修課清單\n"
+            "  [cyan]e3cli assignments[/cyan]    查看作業與截止日期\n"
+            "  [cyan]e3cli download --all[/cyan] 下載所有教材\n"
+            "  [cyan]e3cli sync[/cyan]           一鍵同步所有內容\n"
+            "  [cyan]e3cli --help[/cyan]         查看所有指令"
+        ),
+        "en": (
+            "You can now:\n"
+            "  [cyan]e3cli courses[/cyan]        List enrolled courses\n"
+            "  [cyan]e3cli assignments[/cyan]    View assignments & deadlines\n"
+            "  [cyan]e3cli download --all[/cyan] Download all materials\n"
+            "  [cyan]e3cli sync[/cyan]           Sync everything\n"
+            "  [cyan]e3cli --help[/cyan]         Show all commands"
+        ),
+    },
+
+    # === Common ===
+    "common.not_logged_in": {
+        "zh": "尚未登入，請先執行 e3cli login",
+        "en": "Not logged in. Run e3cli login first.",
+    },
+    "common.no_courses": {"zh": "沒有課程。", "en": "No courses."},
+}
+
+
+def _detect_lang() -> str:
+    """偵測語言，優先順序：E3CLI_LANG 環境變數 > config.toml > 系統語言。"""
+    # 1. 環境變數最優先
+    env_lang = os.environ.get("E3CLI_LANG", "").lower()
+    if env_lang in ("en", "zh"):
+        return env_lang
+
+    # 2. 讀取 config.toml 裡的 lang 設定
+    try:
+        from e3cli.config import CONFIG_FILE
+        if CONFIG_FILE.exists():
+            import tomllib
+            with open(CONFIG_FILE, "rb") as f:
+                data = tomllib.load(f)
+            cfg_lang = data.get("general", {}).get("lang", "").lower()
+            if cfg_lang in ("en", "zh"):
+                return cfg_lang
+    except Exception:
+        pass
+
+    # 3. 系統語言
+    try:
+        sys_lang = locale.getdefaultlocale()[0] or ""
+    except Exception:
+        sys_lang = ""
+
+    if sys_lang.startswith("zh"):
+        return "zh"
+    return "en"
+
+
+_current_lang: str | None = None
+
+
+def get_lang() -> str:
+    global _current_lang
+    if _current_lang is None:
+        _current_lang = _detect_lang()
+    return _current_lang
+
+
+def set_lang(lang: str) -> None:
+    global _current_lang
+    _current_lang = lang
+
+
+def t(key: str, **kwargs) -> str:
+    """取得翻譯字串，支援 format 變數。"""
+    entry = _STRINGS.get(key)
+    if entry is None:
+        return key
+    lang = get_lang()
+    text = entry.get(lang, entry.get("en", key))
+    if kwargs:
+        text = text.format(**kwargs)
+    return text

e3cli/scheduler/cron.py

@@ -0,0 +1,54 @@
+"""Crontab 排程管理。"""
+
+from __future__ import annotations
+
+import shutil
+import subprocess
+import sys
+
+CRON_MARKER = "# e3cli-sync"
+
+
+def _get_e3cli_cmd() -> str:
+    """取得 e3cli 的完整路徑。"""
+    path = shutil.which("e3cli")
+    if path:
+        return path
+    return f"{sys.executable} -m e3cli"
+
+
+def _get_current_crontab() -> list[str]:
+    result = subprocess.run(["crontab", "-l"], capture_output=True, text=True)
+    if result.returncode != 0:
+        return []
+    return [line for line in result.stdout.strip().split("\n") if line]
+
+
+def install(interval_minutes: int = 60) -> None:
+    """安裝 cron job 定時執行 e3cli sync。"""
+    lines = [entry for entry in _get_current_crontab() if CRON_MARKER not in entry]
+    cmd = _get_e3cli_cmd()
+    lines.append(f"*/{interval_minutes} * * * * {cmd} sync --quiet {CRON_MARKER}")
+    subprocess.run(["crontab", "-"], input="\n".join(lines) + "\n", text=True, check=True)
+
+
+def uninstall() -> None:
+    """移除 e3cli 的 cron job。"""
+    lines = [entry for entry in _get_current_crontab() if CRON_MARKER not in entry]
+    if lines:
+        subprocess.run(["crontab", "-"], input="\n".join(lines) + "\n", text=True, check=True)
+    else:
+        subprocess.run(["crontab", "-r"], capture_output=True)
+
+
+def is_installed() -> bool:
+    """檢查 cron job 是否已安裝。"""
+    return any(CRON_MARKER in entry for entry in _get_current_crontab())
+
+
+def get_schedule_line() -> str | None:
+    """取得目前的排程設定行。"""
+    for entry in _get_current_crontab():
+        if CRON_MARKER in entry:
+            return entry
+    return None

e3cli/storage/db.py

@@ -0,0 +1,124 @@
+"""SQLite 資料庫管理 — 追蹤已下載的檔案和作業狀態。"""
+
+from __future__ import annotations
+
+import sqlite3
+from pathlib import Path
+
+_SCHEMA = """
+CREATE TABLE IF NOT EXISTS courses (
+    id          INTEGER PRIMARY KEY,
+    shortname   TEXT NOT NULL,
+    fullname    TEXT NOT NULL,
+    last_synced INTEGER
+);
+
+CREATE TABLE IF NOT EXISTS downloaded_files (
+    id            INTEGER PRIMARY KEY AUTOINCREMENT,
+    course_id     INTEGER NOT NULL,
+    module_id     INTEGER NOT NULL,
+    filename      TEXT NOT NULL,
+    fileurl       TEXT NOT NULL,
+    filesize      INTEGER,
+    time_modified INTEGER NOT NULL,
+    local_path    TEXT NOT NULL,
+    downloaded_at INTEGER NOT NULL,
+    UNIQUE(course_id, module_id, filename)
+);
+
+CREATE TABLE IF NOT EXISTS assignments (
+    id            INTEGER PRIMARY KEY,
+    course_id     INTEGER NOT NULL,
+    course_name   TEXT NOT NULL DEFAULT '',
+    name          TEXT NOT NULL,
+    duedate       INTEGER,
+    status        TEXT DEFAULT 'new',
+    last_checked  INTEGER,
+    notified      INTEGER DEFAULT 0
+);
+"""
+
+
+class Database:
+    def __init__(self, db_path: Path):
+        db_path.parent.mkdir(parents=True, exist_ok=True)
+        self.conn = sqlite3.connect(str(db_path))
+        self.conn.row_factory = sqlite3.Row
+        self._init_schema()
+
+    def _init_schema(self) -> None:
+        self.conn.executescript(_SCHEMA)
+        self.conn.commit()
+
+    def close(self) -> None:
+        self.conn.close()
+
+    # --- 課程 ---
+
+    def upsert_course(self, course_id: int, shortname: str, fullname: str) -> None:
+        self.conn.execute(
+            "INSERT INTO courses (id, shortname, fullname) VALUES (?, ?, ?) "
+            "ON CONFLICT(id) DO UPDATE SET shortname=excluded.shortname, fullname=excluded.fullname",
+            (course_id, shortname, fullname),
+        )
+        self.conn.commit()
+
+    def get_courses(self) -> list[sqlite3.Row]:
+        return self.conn.execute("SELECT * FROM courses ORDER BY id").fetchall()
+
+    # --- 已下載檔案 ---
+
+    def is_downloaded(self, course_id: int, module_id: int, filename: str, time_modified: int) -> bool:
+        """檢查檔案是否已下載且未更新。"""
+        row = self.conn.execute(
+            "SELECT time_modified FROM downloaded_files "
+            "WHERE course_id=? AND module_id=? AND filename=?",
+            (course_id, module_id, filename),
+        ).fetchone()
+        return row is not None and row["time_modified"] >= time_modified
+
+    def record_download(
+        self, course_id: int, module_id: int, filename: str,
+        fileurl: str, filesize: int, time_modified: int,
+        local_path: str, downloaded_at: int,
+    ) -> None:
+        self.conn.execute(
+            "INSERT INTO downloaded_files "
+            "(course_id, module_id, filename, fileurl, filesize, time_modified, local_path, downloaded_at) "
+            "VALUES (?, ?, ?, ?, ?, ?, ?, ?) "
+            "ON CONFLICT(course_id, module_id, filename) DO UPDATE SET "
+            "fileurl=excluded.fileurl, filesize=excluded.filesize, "
+            "time_modified=excluded.time_modified, local_path=excluded.local_path, "
+            "downloaded_at=excluded.downloaded_at",
+            (course_id, module_id, filename, fileurl, filesize, time_modified, local_path, downloaded_at),
+        )
+        self.conn.commit()
+
+    # --- 作業 ---
+
+    def upsert_assignment(
+        self, assign_id: int, course_id: int, course_name: str,
+        name: str, duedate: int, last_checked: int,
+    ) -> bool:
+        """更新或新增作業，回傳是否為新作業。"""
+        existing = self.conn.execute("SELECT id FROM assignments WHERE id=?", (assign_id,)).fetchone()
+        self.conn.execute(
+            "INSERT INTO assignments (id, course_id, course_name, name, duedate, last_checked) "
+            "VALUES (?, ?, ?, ?, ?, ?) "
+            "ON CONFLICT(id) DO UPDATE SET "
+            "name=excluded.name, duedate=excluded.duedate, last_checked=excluded.last_checked",
+            (assign_id, course_id, course_name, name, duedate, last_checked),
+        )
+        self.conn.commit()
+        return existing is None
+
+    def get_assignments(self) -> list[sqlite3.Row]:
+        return self.conn.execute(
+            "SELECT * FROM assignments ORDER BY duedate ASC"
+        ).fetchall()
+
+    def update_assignment_status(self, assign_id: int, status: str) -> None:
+        self.conn.execute(
+            "UPDATE assignments SET status=? WHERE id=?", (status, assign_id)
+        )
+        self.conn.commit()

e3cli/storage/models.py

@@ -0,0 +1,32 @@
+"""資料模型。"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+
+@dataclass
+class Course:
+    id: int
+    shortname: str
+    fullname: str
+
+
+@dataclass
+class Assignment:
+    id: int
+    course_id: int
+    course_name: str
+    name: str
+    duedate: int  # Unix timestamp, 0 = 無截止日
+    status: str = "new"  # new, draft, submitted
+
+
+@dataclass
+class CourseFile:
+    course_id: int
+    module_id: int
+    filename: str
+    fileurl: str
+    filesize: int
+    time_modified: int

e3cli/storage/tracking.py

@@ -0,0 +1,11 @@
+"""追蹤邏輯的高階封裝。"""
+
+from __future__ import annotations
+
+from e3cli.storage.db import Database
+
+
+def get_pending_assignments(db: Database) -> list:
+    """取得尚未提交的作業。"""
+    rows = db.get_assignments()
+    return [r for r in rows if r["status"] not in ("submitted",) and r["duedate"] != 0]