iamt 1.1.27__py3-none-any.whl

iamt/modules/_utils/github.py

@@ -0,0 +1,123 @@
+"""GitHub 相关的通用辅助函数
+
+包含从 GitHub 下载文件和解析版本号的功能。
+"""
+
+import json
+import os
+import urllib.request
+from pathlib import Path
+from typing import Callable
+
+
+# region 文件下载
+
+
+def download_file(
+    url: str,
+    dest_dir: str | Path,
+    filename: str | None = None,
+    skip_existing: bool = True,
+    progress_callback: Callable[[int, int, int], None] | None = None,
+) -> str:
+    """下载文件到本地目录
+
+    通用的文件下载函数，支持进度显示和跳过已存在文件。
+
+    Args:
+        url: 下载 URL
+        dest_dir: 下载目标目录
+        filename: 保存的文件名，默认从 URL 中提取
+        skip_existing: 是否跳过已存在的文件，默认为 True
+        progress_callback: 自定义进度回调函数，签名为 (block_num, block_size, total_size)
+
+    Returns:
+        下载后的文件完整路径
+    """
+    dest_dir = Path(dest_dir)
+    dest_dir.mkdir(parents=True, exist_ok=True)
+
+    if filename is None:
+        filename = url.rsplit("/", 1)[-1]
+
+    dest_path = dest_dir / filename
+
+    if skip_existing and dest_path.exists():
+        print(f"  文件已存在: {dest_path}")
+        return str(dest_path)
+
+    print(f"  正在下载: {url}")
+
+    def default_progress_hook(block_num: int, block_size: int, total_size: int) -> None:
+        if total_size > 0:
+            percent = min(100, block_num * block_size * 100 // total_size)
+            print(f"\r  下载进度: {percent}%", end="", flush=True)
+
+    hook = progress_callback or default_progress_hook
+    urllib.request.urlretrieve(url, str(dest_path), hook)
+    print(f"\n  下载完成: {dest_path}")
+
+    return str(dest_path)
+
+
+# endregion
+
+
+# region 版本解析
+
+
+def resolve_version(version: str, latest_release_url: str, strip_v: bool = True) -> str:
+    """解析版本号，返回实际的版本号
+
+    通过 GitHub releases/latest 重定向 URL 获取最新版本号，
+    适用于大多数 GitHub 项目的版本获取。
+
+    Args:
+        version: 版本号，可以是 "latest" 或具体版本号如 "0.40.1"
+        latest_release_url: 用于获取最新版本号的重定向 URL，
+                           例如 "https://github.com/nvm-sh/nvm/releases/latest"
+        strip_v: 是否移除版本号的 v 前缀，默认为 True
+
+    Returns:
+        实际的版本号，例如 "0.40.1"
+    """
+    if version == "latest":
+        # 通过 HTTP 重定向获取最新版本号
+        req = urllib.request.Request(latest_release_url, method="HEAD")
+        req.add_header("User-Agent", "Mozilla/5.0")
+        with urllib.request.urlopen(req) as response:
+            # 重定向后的 URL 格式: https://github.com/xxx/releases/tag/v0.40.1 或 /tag/7.16.6
+            final_url = response.geturl()
+            tag = final_url.rsplit("/", 1)[-1]
+            return tag.lstrip("v") if strip_v else tag
+
+    # 根据 strip_v 参数决定是否移除 'v' 前缀
+    return version.lstrip("v") if strip_v else version
+
+
+def resolve_version_via_api(version: str, api_url: str, strip_v: bool = True) -> str:
+    """通过 GitHub API 解析版本号
+
+    适用于某些项目的 releases/latest 重定向不可用的情况。
+
+    Args:
+        version: 版本号，可以是 "latest" 或具体版本号如 "5.12.1"
+        api_url: GitHub API URL，
+                例如 "https://api.github.com/repos/v2fly/v2ray-core/releases/latest"
+        strip_v: 是否移除版本号的 v 前缀，默认为 True
+
+    Returns:
+        实际的版本号，例如 "5.12.1"
+    """
+    if version == "latest":
+        req = urllib.request.Request(api_url)
+        req.add_header("User-Agent", "Mozilla/5.0")
+        with urllib.request.urlopen(req) as response:
+            data = json.loads(response.read().decode())
+            tag = data["tag_name"]
+            return tag.lstrip("v") if strip_v else tag
+
+    return version.lstrip("v") if strip_v else version
+
+
+# endregion

iamt/modules/_utils/setup_apt_sources.py

@@ -0,0 +1,94 @@
+import questionary
+from fabric import Connection, task
+
+
+# 可用镜像源
+MIRRORS: dict[str, str] = {
+    "cernet": "https://mirrors.cernet.edu.cn",
+    "tuna": "https://mirrors.tuna.tsinghua.edu.cn",
+    "aliyun": "https://mirrors.aliyun.com",
+    "ustc": "https://mirrors.ustc.edu.cn",
+}
+
+# Ubuntu sources.list 模板
+UBUNTU_SOURCES_TEMPLATE = """deb {mirror}/ubuntu/ {codename} main restricted universe multiverse
+deb {mirror}/ubuntu/ {codename}-updates main restricted universe multiverse
+deb {mirror}/ubuntu/ {codename}-backports main restricted universe multiverse
+deb {mirror}/ubuntu/ {codename}-security main restricted universe multiverse
+"""
+
+# Debian sources.list 模板
+DEBIAN_SOURCES_TEMPLATE = """deb {mirror}/debian/ {codename} main contrib non-free non-free-firmware
+deb {mirror}/debian/ {codename}-updates main contrib non-free non-free-firmware
+deb {mirror}/debian/ {codename}-backports main contrib non-free non-free-firmware
+deb {mirror}/debian-security/ {codename}-security main contrib non-free non-free-firmware
+"""
+
+
+@task
+def setup_apt_sources(conn: Connection, mirror: str = "cernet") -> None:
+    """更换软件源
+    
+    Args:
+        conn: Fabric 连接对象
+        mirror: 镜像源名称或 URL，默认为 cernet
+    """
+    
+    # region 获取系统信息
+    dist_info: dict = conn.hostvars["distribution"]
+    dist_id: str = dist_info.get("id", "").lower()
+    codename: str = dist_info.get("codename", "")
+    
+    if dist_id not in ("ubuntu", "debian"):
+        print(f"不支持的发行版: {dist_id}，仅支持 Ubuntu 和 Debian")
+        return
+    
+    if not codename:
+        print("无法获取系统代号 (codename)，请检查系统信息")
+        return
+    # endregion
+    
+    # region 选择镜像源
+    selected_mirror = MIRRORS.get(mirror, mirror)
+    # endregion
+    
+    # region 生成 sources.list 内容
+    if dist_id == "ubuntu":
+        sources_content = UBUNTU_SOURCES_TEMPLATE.format(mirror=selected_mirror, codename=codename)
+    else:
+        sources_content = DEBIAN_SOURCES_TEMPLATE.format(mirror=selected_mirror, codename=codename)
+    # endregion
+    
+    # region 备份并写入新配置
+    print(f"正在为 {dist_id.capitalize()} {codename} 配置镜像源: {selected_mirror}")
+    
+    # 备份原配置
+    conn.sudo("cp /etc/apt/sources.list /etc/apt/sources.list.bak", hide=True, warn=True)
+    
+    # 写入新配置：先写入临时文件，再移动到目标位置
+    escaped_content = sources_content.replace("'", "'\\''")
+    conn.run(f"echo '{escaped_content}' > /tmp/sources.list.tmp")
+    conn.sudo("mv /tmp/sources.list.tmp /etc/apt/sources.list")
+    
+    # 更新软件包索引
+    print("正在更新软件包索引...")
+    result = conn.sudo("apt-get update", hide=True, warn=True)
+    if result.ok:
+        print("软件源配置完成")
+    else:
+        print("软件包索引更新失败，请检查网络连接或镜像源可用性")
+    # endregion
+
+
+@task
+def select_apt_sources(conn: Connection) -> None:
+    """交互式选择并更换软件源"""
+    choices = [
+        questionary.Choice(title=f"{name} ({url})", value=name)
+        for name, url in MIRRORS.items()
+    ]
+    selected = questionary.select("请选择镜像源:", choices=choices).ask()
+    if selected is None:
+        print("已取消选择")
+        return
+    setup_apt_sources(conn, mirror=selected)

iamt/modules/_utils/steps.py

@@ -0,0 +1,26 @@
+from typing import Callable
+
+from rich.console import Console
+
+console = Console()
+
+# region Step 定义与执行
+type Step = tuple[str, Callable] | tuple[str, Callable, tuple] | tuple[str, Callable, tuple, dict]
+"""
+Step 类型定义，支持以下格式:
+- (desc, func)                    # 仅描述和函数
+- (desc, func, args)              # 带位置参数
+- (desc, func, args, kwargs)      # 带位置参数和关键字参数
+"""
+
+
+def run_steps(c, steps: list[Step]):
+    """执行步骤列表"""
+    total = len(steps)
+    for i, step in enumerate(steps, 1):
+        desc, func = step[0], step[1]
+        args = step[2] if len(step) > 2 else ()
+        kwargs = step[3] if len(step) > 3 else {}
+        console.print(f"[cyan][{i}/{total}][/cyan] [yellow]{desc}[/yellow]...")
+        func(c, *args, **kwargs)
+# endregion

iamt/modules/dcdtask/dcdtask.py

@@ -0,0 +1,164 @@
+"""DCD Task 模块 - Docker Compose 部署任务函数
+
+提供将本地 docker compose 模块部署到远程服务器的 task 函数
+"""
+
+import tarfile
+import tempfile
+from pathlib import Path
+
+from fabric import Connection, task
+
+
+# region 常量配置
+
+ENV_LANG_C = {"LANG": "C", "LC_ALL": "C"}
+
+# endregion
+
+
+# region Task 函数
+
+@task
+def deploy_compose_module(conn: Connection, local_path: str, remote_dir: str, force: bool = False) -> tuple[bool, str]:
+    """部署 docker compose 模块到远程服务器
+
+    Args:
+        conn: Fabric 连接对象
+        local_path: 本地 compose 模块路径
+        remote_dir: 远程部署目录
+        force: 强制执行，若远程目录已存在且有 compose 项目运行，会先停止并删除
+
+    Returns:
+        tuple[bool, str]: (是否成功, 结果消息)
+    """
+    local_dir = Path(local_path)
+    if not local_dir.exists():
+        msg = f"本地路径不存在: {local_path}"
+        print(f"[ERROR] {msg}")
+        return False, msg
+
+    # region 检查远程目录
+    check_result = conn.run(f"test -d {remote_dir} && ls -A {remote_dir} | head -1", warn=True, hide=True, env=ENV_LANG_C)
+    dir_exists_and_has_content = check_result.ok and check_result.stdout.strip()
+
+    if dir_exists_and_has_content:
+        if not force:
+            msg = f"远程目录已存在且不为空: {remote_dir}"
+            print(f"[ERROR] {msg}")
+            print("[HINT] 使用 force=True 参数可强制覆盖部署")
+            return False, msg
+
+        # 强制模式：检查是否有 docker-compose 文件并停止项目
+        compose_check = conn.run(f"test -f {remote_dir}/docker-compose.yml -o -f {remote_dir}/docker-compose.yaml -o -f {remote_dir}/compose.yml -o -f {remote_dir}/compose.yaml", warn=True, hide=True)
+        if compose_check.ok:
+            print(f"[INFO] 检测到 compose 文件，正在停止 docker compose 项目...")
+            conn.sudo(f"bash -c 'cd {remote_dir} && docker compose down'", warn=True, env=ENV_LANG_C, timeout=300)
+            print(f"[OK] docker compose 项目已停止")
+
+        print(f"[INFO] 正在删除远程目录: {remote_dir}")
+        conn.sudo(f"rm -rf {remote_dir}", env=ENV_LANG_C)
+        print(f"[OK] 远程目录已删除")
+    # endregion
+
+    # region 创建远程目录
+    conn.sudo(f"mkdir -p {remote_dir}", env=ENV_LANG_C)
+    print(f"[OK] 远程目录已创建: {remote_dir}")
+    # endregion
+
+    # region 打包上传解压
+    with tempfile.NamedTemporaryFile(suffix=".tar.gz", delete=False) as tmp_file:
+        tar_path = tmp_file.name
+
+    # 本地打包
+    files_count = 0
+    with tarfile.open(tar_path, "w:gz") as tar:
+        for local_file in local_dir.rglob("*"):
+            if local_file.is_file():
+                arcname = local_file.relative_to(local_dir)
+                tar.add(local_file, arcname=arcname)
+                files_count += 1
+                print(f"  [+] {arcname}")
+
+    # 上传并解压
+    remote_tar = f"/tmp/{local_dir.name}.tar.gz"
+    conn.put(tar_path, remote_tar)
+    conn.sudo(f"tar -xzf {remote_tar} -C {remote_dir}", env=ENV_LANG_C)
+    conn.run(f"rm -f {remote_tar}")
+
+    # 清理本地临时文件
+    Path(tar_path).unlink()
+    # endregion
+
+    msg = f"成功部署 {files_count} 个文件到 {remote_dir}"
+    print(f"[OK] {msg}")
+    return True, msg
+
+
+
+
+@task
+def remove_compose_module(conn: Connection, remote_dir: str) -> None:
+    """删除远程服务器上的 compose 模块目录
+
+    Args:
+        conn: Fabric 连接对象
+        remote_dir: 远程目录路径
+    """
+    conn.sudo(f"rm -rf {remote_dir}", env=ENV_LANG_C)
+    print(f"[OK] 已删除远程目录: {remote_dir}")
+
+
+@task
+def compose_up(conn: Connection, remote_dir: str, detach: bool = True) -> None:
+    """在远程服务器上启动 docker compose
+
+    Args:
+        conn: Fabric 连接对象
+        remote_dir: compose 模块所在的远程目录
+        detach: 是否后台运行，默认 True
+    """
+    detach_flag = "-d" if detach else ""
+    conn.sudo(f"bash -c 'cd {remote_dir} && docker compose up {detach_flag}'", env=ENV_LANG_C)
+    print(f"[OK] docker compose up 执行完成")
+
+
+@task
+def compose_down(conn: Connection, remote_dir: str, volumes: bool = False) -> None:
+    """在远程服务器上停止 docker compose
+
+    Args:
+        conn: Fabric 连接对象
+        remote_dir: compose 模块所在的远程目录
+        volumes: 是否同时删除 volumes，默认 False
+    """
+    volumes_flag = "-v" if volumes else ""
+    conn.sudo(f"bash -c 'cd {remote_dir} && docker compose down {volumes_flag}'", env=ENV_LANG_C)
+    print(f"[OK] docker compose down 执行完成")
+
+
+@task
+def compose_ps(conn: Connection, remote_dir: str) -> None:
+    """查看远程服务器上 compose 容器状态
+
+    Args:
+        conn: Fabric 连接对象
+        remote_dir: compose 模块所在的远程目录
+    """
+    conn.sudo(f"bash -c 'cd {remote_dir} && docker compose ps'", env=ENV_LANG_C)
+
+
+@task
+def compose_logs(conn: Connection, remote_dir: str, follow: bool = False, tail: int = 100) -> None:
+    """查看远程服务器上 compose 容器日志
+
+    Args:
+        conn: Fabric 连接对象
+        remote_dir: compose 模块所在的远程目录
+        follow: 是否持续跟踪日志，默认 False
+        tail: 显示最后多少行，默认 100
+    """
+    follow_flag = "-f" if follow else ""
+    conn.sudo(f"bash -c 'cd {remote_dir} && docker compose logs {follow_flag} --tail {tail}'", env=ENV_LANG_C)
+
+# endregion