buaalogin-cli 0.1.0__py3-none-any.whl

buaalogin_cli/__init__.py

@@ -0,0 +1 @@
+"""北航校园网自动登录工具"""

buaalogin_cli/__main__.py

@@ -0,0 +1,12 @@
+"""Allow running as `python -m buaalogin_cli`."""
+
+from buaalogin_cli.cli import app
+
+
+def main() -> None:
+    """程序主入口函数。"""
+    app()
+
+
+if __name__ == "__main__":
+    main()

buaalogin_cli/cli.py

@@ -0,0 +1,227 @@
+"""BUAA 校园网自动登录 CLI 工具"""
+
+import typer
+
+from . import service
+from .config import config
+from .constants import CONFIG_FILE, LOG_FILE
+from .log import setup_console
+
+app = typer.Typer(
+    help="BUAA 校园网自动登录工具",
+    add_completion=False,
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+
+
+@app.callback(invoke_without_command=True)
+def callback(ctx: typer.Context):
+    """BUAA 校园网登录工具。
+
+    在任何子命令执行前调用，加载配置文件并设置默认参数值。
+    如果未指定子命令则显示帮助信息。
+    """
+    # 这些值会覆盖子命令中的参数默认值
+    file_config = config.to_dict()
+
+    # 子命令会继承配置文件的值（如果命令行未显式指定参数）
+    ctx.default_map = {
+        "login": file_config,
+        "run": file_config,
+    }
+
+    # 若未指定子命令，显示帮助信息后退出
+    if ctx.invoked_subcommand is None:
+        typer.echo(ctx.get_help())
+        raise typer.Exit()
+
+
+@app.command("login")
+def login_cmd(
+    username: str | None = typer.Option(
+        None,
+        "--user",
+        "-u",
+        envvar="BUAA_USERNAME",
+        metavar="学号",
+        help="校园网账号",
+        show_default=False,
+    ),
+    password: str | None = typer.Option(
+        None,
+        "--pass",
+        "-p",
+        envvar="BUAA_PASSWORD",
+        metavar="密码",
+        help="校园网密码",
+        show_default=False,
+    ),
+    headless: bool = typer.Option(
+        True,
+        "--headless/--headed",
+        help="是否使用无头模式运行浏览器",
+    ),
+    verbose: bool = typer.Option(False, "--verbose", "-v", help="显示详细调试信息"),
+):
+    """执行单次登录。"""
+    setup_console(verbose=verbose)
+    _do_login_cmd(username, password, headless)
+
+
+@app.command("run")
+def run_cmd(
+    username: str | None = typer.Option(
+        None,
+        "--user",
+        "-u",
+        envvar="BUAA_USERNAME",
+        metavar="学号",
+        help="校园网账号",
+        show_default=False,
+    ),
+    password: str | None = typer.Option(
+        None,
+        "--pass",
+        "-p",
+        envvar="BUAA_PASSWORD",
+        metavar="密码",
+        help="校园网密码",
+        show_default=False,
+    ),
+    interval: int = typer.Option(
+        5,
+        "--interval",
+        "-i",
+        envvar="BUAA_CHECK_INTERVAL",
+        metavar="分钟",
+        min=1,
+        help="检测间隔",
+    ),
+    headless: bool = typer.Option(
+        True,
+        "--headless/--headed",
+        help="是否使用无头模式运行浏览器",
+    ),
+    verbose: bool = typer.Option(False, "--verbose", "-v", help="显示详细调试信息"),
+):
+    """持续保持在线，定期检测并自动重连。"""
+    setup_console(verbose=verbose)
+
+    passwd = password
+
+    if username is None or passwd is None:
+        typer.secho("❌ 缺少账号或密码", fg=typer.colors.RED)
+        typer.echo("\n请通过以下方式之一提供凭据：")
+        typer.echo("  1. 运行 `buaalogin config` 配置")
+        typer.echo("  2. 使用命令行参数: --user <账号> --pass <密码>")
+        typer.echo("  3. 设置环境变量: BUAA_USERNAME, BUAA_PASSWORD")
+        raise typer.Exit(1)
+
+    service.keep_alive(username, passwd, interval, headless=headless)
+
+
+@app.command("config")
+def config_cmd(
+    username: str | None = typer.Option(
+        None, "--user", "-u", metavar="学号", help="校园网账号"
+    ),
+    password: str | None = typer.Option(
+        None, "--pass", "-p", metavar="密码", help="校园网密码"
+    ),
+    interval: int | None = typer.Option(
+        None, "--interval", "-i", metavar="分钟", min=1, help="保活检测间隔"
+    ),
+    show: bool = typer.Option(
+        False, "--show", "-s", is_flag=True, help="仅显示当前配置", show_default=True
+    ),
+):
+    """配置账户信息。"""
+    if show:
+        typer.secho(f"配置文件: {CONFIG_FILE}", fg=typer.colors.CYAN)
+        saved = config.to_dict()
+        if saved:
+            for key, value in saved.items():
+                typer.echo(f"  {key} = {value}")
+        else:
+            typer.echo("  （尚未配置）")
+        return
+
+    # 交互式输入
+    if not username:
+        username = typer.prompt("请输入 BUAA 学号")
+        while not username:
+            typer.secho("学号不能为空", fg=typer.colors.RED)
+            username = typer.prompt("请输入 BUAA 学号")
+    if not password:
+        password = typer.prompt("请输入密码")
+        while not password:
+            typer.secho("密码不能为空", fg=typer.colors.RED)
+            password = typer.prompt("请输入密码")
+
+    # 更新配置并保存
+    config.username = username
+    config.password = password
+    if interval is not None:
+        config.interval = interval
+    config.save_to_json(CONFIG_FILE)
+    typer.secho("✅ 配置已保存!", fg=typer.colors.GREEN)
+    typer.echo(f"   位置: {CONFIG_FILE}")
+
+
+@app.command("status")
+def status_cmd():
+    """检查当前网络连接状态。退出码：已登录=0，未登录=1。"""
+    if service.get_status() == service.NetworkStatus.LOGGED_IN:
+        typer.secho("✅ 网络正常", fg=typer.colors.GREEN)
+        raise typer.Exit(0)
+    else:
+        typer.secho("❌ 未登录或无法访问外网", fg=typer.colors.RED)
+        raise typer.Exit(1)
+
+
+@app.command("info")
+def info_cmd():
+    """显示配置文件和日志文件的存储位置。"""
+    config_file = CONFIG_FILE
+
+    typer.echo("配置文件:")
+    typer.echo(f"  {config_file}")
+    if config_file.exists():
+        typer.secho("  ✅ 已存在", fg=typer.colors.GREEN)
+    else:
+        typer.secho("  ⚠️ 未配置", fg=typer.colors.YELLOW)
+
+    typer.echo()
+    typer.echo("日志文件:")
+    typer.echo(f"  {LOG_FILE}")
+    if LOG_FILE.exists():
+        size = LOG_FILE.stat().st_size
+        typer.secho(f"  ✅ 文件大小: {size / 1024:.1f} KB", fg=typer.colors.GREEN)
+    else:
+        typer.secho("  📝 尚未生成", fg=typer.colors.BLUE)
+
+
+def _do_login_cmd(
+    cli_username: str | None,
+    cli_pass: str | None,
+    headless: bool = True,
+):
+    """执行单次登录的 CLI 逻辑（含错误提示）。"""
+    if cli_username is None or cli_pass is None:
+        typer.secho("❌ 缺少账号或密码", fg=typer.colors.RED)
+        typer.echo("\n请通过以下方式之一提供凭据：")
+        typer.echo("  1. 运行 `buaalogin config` 配置")
+        typer.echo("  2. 使用命令行参数: --user <账号> --pass <密码>")
+        typer.echo("  3. 设置环境变量: BUAA_USERNAME, BUAA_PASSWORD")
+        raise typer.Exit(1)
+
+    try:
+        service.login(cli_username, cli_pass, headless=headless)
+        typer.secho("✅ 登录成功", fg=typer.colors.GREEN)
+    except service.LoginError as e:
+        typer.secho(f"❌ 登录失败: {e}", fg=typer.colors.RED)
+        raise typer.Exit(1) from None
+
+
+if __name__ == "__main__":
+    app()

buaalogin_cli/config.py

@@ -0,0 +1,47 @@
+"""配置管理模块：配置加载/保存、优先级合并"""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Any
+
+from msgspec import UNSET, Struct, UnsetType, structs
+from msgspec import json as msgjson
+
+from .constants import CONFIG_FILE
+
+
+class Config(Struct, omit_defaults=True):
+    """用户配置，保存到配置文件。
+
+    Attributes:
+        username: 校园网账号。
+        password: 校园网密码。
+        interval: 检测间隔（分钟）。
+    """
+
+    username: str | UnsetType = UNSET
+    password: str | UnsetType = UNSET
+    interval: int | UnsetType = UNSET
+
+    @classmethod
+    def load_from_json(cls, file_path: str | Path) -> Config:
+        """从 JSON 文件加载配置，文件不存在时返回空配置。"""
+        try:
+            bytes = Path(file_path).read_bytes()
+            return msgjson.decode(bytes, type=Config)
+        except FileNotFoundError:
+            return cls()
+
+    def save_to_json(self, file_path: Path | str) -> int:
+        """保存当前配置到 JSON 文件。"""
+        bytes = msgjson.encode(self) + b"\n"
+        return Path(file_path).write_bytes(bytes)
+
+    def to_dict(self) -> dict[str, Any]:
+        """导出为字典（过滤 UNSET 值）。"""
+        return {k: v for k, v in structs.asdict(self).items() if v is not UNSET}
+
+
+# 全局配置实例
+config = Config.load_from_json(CONFIG_FILE)

buaalogin_cli/constants.py

@@ -0,0 +1,15 @@
+"""常量模块：路径、URL"""
+
+from pathlib import Path
+
+from platformdirs import user_config_dir, user_log_dir
+
+APP_NAME = "buaalogin-cli"
+
+# 文件路径
+CONFIG_FILE = Path(user_config_dir(APP_NAME, ensure_exists=True)) / "config.json"
+LOG_FILE = Path(user_log_dir(APP_NAME, ensure_exists=True)) / f"{APP_NAME}.log"
+
+# URL
+GATEWAY_URL = "https://gw.buaa.edu.cn"
+LOGIN_URL = GATEWAY_URL

buaalogin_cli/log.py

@@ -0,0 +1,67 @@
+"""日志配置模块：集中管理日志设置，供所有模块导入使用"""
+
+import sys
+
+from loguru import logger
+
+from .constants import LOG_FILE
+
+# 移除 loguru 默认的 stderr handler，稍后重新配置
+logger.remove()
+
+# 日志格式
+LOG_FORMAT_CONSOLE = (
+    "<green>{time:YYYY-MM-DD HH:mm:ss}</green> | "
+    "<level>{level:<8}</level> | "
+    "<cyan>[{extra[trigger]}]</cyan> "
+    "<level>{message}</level>"
+)
+
+LOG_FORMAT_FILE = (
+    "{time:YYYY-MM-DD HH:mm:ss} | {level:<8} | [{extra[trigger]:<8}] | "
+    "{name}:{function}:{line} - {message}"
+)
+
+# 配置默认 trigger（防止 KeyError）
+logger.configure(extra={"trigger": "unknown"})
+
+# 文件输出：永远记录 DEBUG 级别（带轮转和压缩）
+logger.add(
+    LOG_FILE,
+    format=LOG_FORMAT_FILE,
+    level="DEBUG",  # 文件永远记录全量日志
+    encoding="utf-8",
+    rotation="10 MB",
+    retention="7 days",
+    compression="zip",
+)
+
+# 控制台 handler ID，用于动态切换级别
+_console_handler_id: int | None = None
+
+
+def setup_console(verbose: bool = False) -> None:
+    """配置输出级别
+
+    Args:
+        verbose: True 时输出 DEBUG 级别，否则输出 INFO 级别
+    """
+    global _console_handler_id
+
+    # 移除旧的控制台 handler
+    if _console_handler_id is not None:
+        logger.remove(_console_handler_id)
+
+    level = "DEBUG" if verbose else "INFO"
+    _console_handler_id = logger.add(
+        sys.stderr,
+        format=LOG_FORMAT_CONSOLE,
+        level=level,
+        colorize=True,
+    )
+
+
+# 默认 INFO 级别控制台输出
+setup_console(verbose=False)
+
+__all__ = ["logger", "setup_console"]

buaalogin_cli/service.py

@@ -0,0 +1,203 @@
+"""网络状态检测、登录、持续保活"""
+
+import sys
+import time
+from enum import Enum, auto
+
+import requests
+from playwright.sync_api import TimeoutError as PlaywrightTimeout
+from playwright.sync_api import sync_playwright
+
+from .constants import GATEWAY_URL, LOG_FILE, LOGIN_URL
+from .log import logger
+
+
+class LoginError(Exception):
+    """登录失败异常。"""
+
+    pass
+
+
+class NetworkStatus(Enum):
+    """网络状态枚举。"""
+
+    UNKNOWN_NETWORK = auto()  # 非校园网环境（DNS 解析失败或超时）
+    LOGGED_OUT = auto()  # 校园网环境，未登录
+    LOGGED_IN = auto()  # 校园网环境，已登录
+
+
+# region 网络状态检测
+
+
+def get_status() -> NetworkStatus:
+    """获取当前网络状态。
+
+    通过访问校园网网关 (https://gw.buaa.edu.cn/) 检测：
+    - 请求失败（DNS/超时）→ UNKNOWN_NETWORK
+    - URL 包含 "success" → LOGGED_IN
+    - 其他情况 → LOGGED_OUT
+
+    Returns:
+        NetworkStatus 枚举值。
+    """
+    log = logger.bind(trigger="status")
+    log.debug("正在检测网络状态...")
+
+    try:
+        response = requests.get(
+            GATEWAY_URL,
+            headers={"User-Agent": "Mozilla/5.0"},
+            timeout=5,
+            allow_redirects=True,
+        )
+        final_url = response.url
+
+        if "success" in final_url.lower():
+            log.debug(f"网络状态: 已登录 (URL: {final_url})")
+            return NetworkStatus.LOGGED_IN
+        else:
+            log.debug(f"网络状态: 未登录 (URL: {final_url})")
+            return NetworkStatus.LOGGED_OUT
+
+    except requests.RequestException as e:
+        log.debug(f"网络状态: 非校园网环境 ({e})")
+        return NetworkStatus.UNKNOWN_NETWORK
+
+
+# endregion
+
+
+# region 登录
+
+
+def login(username: str, password: str, *, headless: bool = True) -> None:
+    """使用 Playwright 模拟浏览器登录校园网。
+
+    Args:
+        username: 用户名。
+        password: 密码。
+        headless: 是否使用无头模式。
+
+    Raises:
+        LoginError: 登录失败时抛出，包含错误信息。
+    """
+    log = logger.bind(trigger="login")
+
+    # 先快速检查状态，避免不必要地启动浏览器
+    status = get_status()
+    if status == NetworkStatus.LOGGED_IN:
+        log.info("已经处于登录状态")
+        return
+    if status == NetworkStatus.UNKNOWN_NETWORK:
+        raise LoginError("未检测到校园网环境")
+
+    # 只有 LOGGED_OUT 时才启动浏览器
+    with sync_playwright() as p:
+        browser_path = p.chromium.executable_path
+        log.debug(f"使用浏览器: {browser_path}")
+
+        browser = p.chromium.launch(headless=headless, executable_path=browser_path)
+        context = browser.new_context()
+        page = context.new_page()
+
+        try:
+            log.info("正在打开登录页面...")
+            page.goto(LOGIN_URL, timeout=30000)
+            page.wait_for_load_state("networkidle", timeout=10000)
+
+            # 填写用户名和密码
+            log.debug("正在填写登录信息...")
+            page.locator("#username:visible").fill(username)
+            page.locator("#password:visible").fill(password)
+
+            # 点击登录按钮
+            log.info("正在提交登录...")
+            page.locator("#login").click()
+
+            page.wait_for_timeout(3000)
+
+            # 检查登录结果
+            if "success" in page.url.lower():
+                log.success("登录成功！")
+                return
+            else:
+                error_msg = _get_error_message(page)
+                log.warning(f"登录失败：{error_msg}")
+                raise LoginError(error_msg)
+
+        except PlaywrightTimeout as e:
+            log.error(f"页面加载超时：{e}")
+            raise LoginError(f"页面加载超时：{e}") from e
+        except LoginError:
+            raise
+        except Exception as e:
+            log.error(f"登录过程出错：{e}")
+            raise LoginError(f"{e}") from e
+        finally:
+            log.debug("正在关闭浏览器...")
+            browser.close()
+            log.debug("浏览器已关闭")
+
+
+def _get_error_message(page) -> str:
+    """获取登录错误信息。"""
+    try:
+        # layer.js 弹窗错误信息
+        elem = page.locator(".layui-layer-content").first
+        if elem.is_visible(timeout=1000):
+            return elem.text_content() or "未知错误"
+        return "未知错误"
+    except Exception:
+        return "无法获取错误信息"
+
+
+# endregion
+
+
+# region 持续保活
+
+
+def keep_alive(
+    username: str, password: str, check_interval_min: int, *, headless: bool = True
+):
+    """持续保持在线，检查登录状态并自动重连。
+
+    Args:
+        username: 校园网用户名。
+        password: 校园网密码。
+        check_interval_min: 检查间隔（分钟）。
+        headless: 是否使用无头模式运行浏览器。
+    """
+    log = logger.bind(trigger="run")
+    check_interval_sec = check_interval_min * 60
+
+    log.info(f"保活服务已启动，检查间隔: {check_interval_min} 分钟")
+    log.info(f"使用账户: {username}")
+    log.info(f"日志文件: {LOG_FILE}")
+
+    while True:
+        try:
+            status = get_status()
+
+            if status == NetworkStatus.UNKNOWN_NETWORK:
+                log.warning("未检测到校园网环境，等待下次检查...")
+            elif status == NetworkStatus.LOGGED_IN:
+                log.info("已登录，无需操作")
+            else:  # LOGGED_OUT
+                log.warning("未登录，正在启动浏览器登录...")
+                try:
+                    login(username, password, headless=headless)
+                    log.success("登录成功")
+                except LoginError as e:
+                    log.warning(f"登录未成功: {e}")
+
+            time.sleep(check_interval_sec)
+        except KeyboardInterrupt:
+            log.info("User Exit.")
+            sys.exit(0)
+        except Exception as e:
+            log.error(f"发生错误: {e}")
+            time.sleep(10)
+
+
+# endregion

buaalogin_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,11 @@
+Metadata-Version: 2.3
+Name: buaalogin-cli
+Version: 0.1.0
+Requires-Dist: playwright>=1.40.0
+Requires-Dist: typer>=0.9.0
+Requires-Dist: platformdirs>=4.0.0
+Requires-Dist: loguru>=0.7.0
+Requires-Dist: msgspec>=0.18.0
+Requires-Dist: requests>=2.31.0
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/Misty02600/buaalogin-cli

buaalogin_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+buaalogin_cli/__init__.py,sha256=xJgs3LxemEaP9JsJ-BA9OhDJ78LozOw8i3HmHjDM9b0,40
+buaalogin_cli/__main__.py,sha256=tlTuBxuEzJKIPa5Js84z86QLffGdkt0gI7ZG9SzbpTI,192
+buaalogin_cli/cli.py,sha256=2pYLu7-vu5cyOpsXNiApxuHO5YLt8JN6Co40rsw2A9s,7019
+buaalogin_cli/config.py,sha256=9c4ATq7qTuOMnNbt9JkvlSrRvOLWxKvRHK7ghmzBuJs,1414
+buaalogin_cli/constants.py,sha256=Z7X0gF92Vr9lbCU3vMoFBU2S1OgHzuUg3rD5BNqQES4,392
+buaalogin_cli/log.py,sha256=PkaBWkYbikqraOAxN5JHHuSi-M7_qI55oQCX84qGm5Q,1632
+buaalogin_cli/service.py,sha256=PTQM-vKjXcxTyTmahnpTm9-kuDRt9OTJ-g7MW4aKmcU,6083
+buaalogin_cli-0.1.0.dist-info/WHEEL,sha256=e_m4S054HL0hyR3CpOk-b7Q7fDX6BuFkgL5OjAExXas,80
+buaalogin_cli-0.1.0.dist-info/entry_points.txt,sha256=saYSPX9fiGodsJR_0BNpG3SYj7fH5iEYF92172dHTjA,59
+buaalogin_cli-0.1.0.dist-info/METADATA,sha256=hKFeoNe9xeSyfqDIF3ui7xgmu5loXW7zyjl8eF9sRtM,337
+buaalogin_cli-0.1.0.dist-info/RECORD,,

buaalogin_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.27
+Root-Is-Purelib: true
+Tag: py3-none-any

buaalogin_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+buaalogin = buaalogin_cli.__main__:main
+