nonebot-plugin-git-poller 0.1.5__py3-none-any.whl

nonebot_plugin_git_poller/__init__.py

@@ -0,0 +1,449 @@
+from __future__ import annotations
+
+import asyncio
+from datetime import datetime, timedelta
+
+from nonebot import get_bots, logger, on_command, require
+from nonebot.adapters.onebot.v11 import Bot, GroupMessageEvent, Message
+from nonebot.exception import FinishedException
+from nonebot.matcher import Matcher
+from nonebot.params import ArgPlainText, CommandArg
+from nonebot.plugin import PluginMetadata
+
+require("nonebot_plugin_apscheduler")
+require("nonebot_plugin_localstore")
+
+from nonebot_plugin_apscheduler import scheduler
+
+from .command_args import parse_repo_command_args
+from .config import Config, plugin_config
+from .file_server import register_archive_file_route
+from .message import (
+    ArchiveUploadUriError,
+    build_archive_delivery_text,
+    send_update_to_group,
+    upload_archive_to_group,
+)
+from .mirror import GitPollerService
+from .schedule import parse_schedule
+
+__plugin_meta__ = PluginMetadata(
+    name="Git Poller",
+    description="按群订阅 Git 仓库更新，支持多仓库、多分支定时拉取",
+    usage=(
+        "/关注仓库 仓库url [--分支名]\n"
+        "/取关仓库 仓库url [--分支名]\n"
+        "/设置仓库 仓库url [--分支名]\n"
+        "/仓库列表\n"
+        "/拉取仓库 仓库url [--分支名]\n"
+        "/仓库摘要 仓库url [--分支名]"
+    ),
+    type="application",
+    config=Config,
+    supported_adapters={"~onebot.v11"},
+)
+
+service = GitPollerService(plugin_config)
+COMMAND_PRIORITY = 10
+
+follow_repo = on_command(
+    "关注仓库",
+    priority=COMMAND_PRIORITY,
+    block=True,
+)
+unfollow_repo = on_command(
+    "取关仓库",
+    priority=COMMAND_PRIORITY,
+    block=True,
+)
+configure_repo = on_command(
+    "设置仓库",
+    priority=COMMAND_PRIORITY,
+    block=True,
+)
+list_repos = on_command(
+    "仓库列表",
+    priority=COMMAND_PRIORITY,
+    block=True,
+)
+pull_repo = on_command(
+    "拉取仓库",
+    priority=COMMAND_PRIORITY,
+    block=True,
+)
+summarize_repo = on_command(
+    "仓库摘要",
+    priority=COMMAND_PRIORITY,
+    block=True,
+)
+
+
+@follow_repo.handle()
+async def _(event: GroupMessageEvent, matcher: Matcher, args: Message = CommandArg()) -> None:
+    try:
+        parsed = _repo_args(args)
+    except ValueError as exc:
+        await matcher.finish(f"用法：/关注仓库 仓库url [--分支名]\n{exc}")
+    if parsed is None:
+        await matcher.finish("用法：/关注仓库 仓库url [--分支名]")
+    group_id = int(event.group_id)
+    try:
+        result = await service.follow_repo(group_id, parsed.url, parsed.branch)
+        if result.already_following:
+            await matcher.finish(
+                f"本群已经关注：{result.identity.display_name}\n"
+                f"分支：{result.subscription.branch}\n"
+                f"定时：{result.subscription.schedule}"
+            )
+        await matcher.finish(
+            f"已关注：{result.identity.display_name}\n"
+            f"分支：{result.subscription.branch}\n"
+            f"定时：{result.subscription.schedule}\n"
+            f"当前 commit 已记录，后续有新提交时推送。"
+        )
+    except FinishedException:
+        raise
+    except Exception as exc:
+        logger.exception("git poller follow command failed")
+        await matcher.finish(f"关注仓库失败：{exc}")
+
+
+@unfollow_repo.handle()
+async def _(event: GroupMessageEvent, matcher: Matcher, args: Message = CommandArg()) -> None:
+    try:
+        parsed = _repo_args(args)
+    except ValueError as exc:
+        await matcher.finish(f"用法：/取关仓库 仓库url [--分支名]\n{exc}")
+    if parsed is None:
+        await matcher.finish("用法：/取关仓库 仓库url [--分支名]")
+    try:
+        identity, removed = service.unfollow_repo(
+            int(event.group_id),
+            parsed.url,
+            parsed.branch,
+        )
+        if removed:
+            _schedule_repo_cleanup(identity.key)
+            await matcher.finish(f"已取关：{identity.display_name}")
+        await matcher.finish(f"本群没有关注：{identity.display_name}")
+    except FinishedException:
+        raise
+    except Exception as exc:
+        logger.exception("git poller unfollow command failed")
+        await matcher.finish(f"取关仓库失败：{exc}")
+
+
+@configure_repo.handle()
+async def _(
+    event: GroupMessageEvent,
+    matcher: Matcher,
+    args: Message = CommandArg(),
+) -> None:
+    try:
+        parsed = _repo_args(args)
+    except ValueError as exc:
+        await matcher.finish(f"用法：/设置仓库 仓库url [--分支名]\n{exc}")
+    if parsed is None:
+        await matcher.finish("用法：/设置仓库 仓库url [--分支名]")
+    try:
+        identity, subscription = service.get_repo_subscription(
+            int(event.group_id),
+            parsed.url,
+            parsed.branch,
+        )
+    except Exception as exc:
+        logger.exception("git poller configure command failed")
+        await matcher.finish(f"设置仓库失败：{exc}")
+    matcher.state["repo_url"] = parsed.url
+    matcher.state["repo_branch"] = subscription.branch
+    matcher.state["repo_identity_name"] = identity.display_name
+    matcher.state["repo_subscription_branch"] = subscription.branch
+    matcher.state["repo_config_group_id"] = int(event.group_id)
+    matcher.state["repo_config_user_id"] = int(event.user_id)
+    await matcher.send(
+        "输入设置数字选项\n"
+        "1. 修改当前仓库推送抓取时间\n"
+        "2. 修改当前仓库上传压缩包密码（选择后输入无则清除当前仓库密码回到全局默认）"
+    )
+
+
+@configure_repo.got("setting_choice")
+async def _(
+    event: GroupMessageEvent,
+    matcher: Matcher,
+    choice: str = ArgPlainText("setting_choice"),
+) -> None:
+    if not _same_config_session(event, matcher):
+        await matcher.finish("输入非法，已取消设置。")
+    choice = choice.strip()
+    if choice not in {"1", "2"}:
+        await matcher.finish("输入非法，已取消设置。")
+    matcher.state["setting_choice"] = choice
+    if choice == "1":
+        await matcher.send("请输入新的推送抓取时间，例如：每日04:00、每3天04:00、周一04:00")
+    else:
+        await matcher.send("请输入新的压缩包密码。输入 无 则清除当前仓库密码回到全局默认。")
+
+
+@configure_repo.got("setting_value")
+async def _(
+    event: GroupMessageEvent,
+    matcher: Matcher,
+    value: str = ArgPlainText("setting_value"),
+) -> None:
+    if not _same_config_session(event, matcher):
+        await matcher.finish("输入非法，已取消设置。")
+    group_id = int(event.group_id)
+    url = str(matcher.state["repo_url"])
+    branch = matcher.state.get("repo_branch")
+    if branch is not None:
+        branch = str(branch)
+    choice = str(matcher.state["setting_choice"])
+    value = value.strip()
+    if not value:
+        await matcher.finish("输入非法，已取消设置。")
+
+    if choice == "1":
+        try:
+            parse_schedule(value, plugin_config.git_poller_timezone)
+            identity, subscription = service.update_repo_schedule(
+                group_id,
+                url,
+                branch,
+                value,
+            )
+            _register_schedule(subscription.schedule)
+        except Exception as exc:
+            logger.exception("git poller schedule setting failed")
+            await matcher.finish(f"输入非法，已取消设置：{exc}")
+        await matcher.finish(
+            f"设置成功：{identity.display_name}\n"
+            f"分支：{subscription.branch}\n"
+            f"推送抓取时间：{subscription.schedule}"
+        )
+
+    password = None if value in {"无", "none", "None", "NONE", "clear", "Clear", "CLEAR"} else value
+    try:
+        identity, subscription = service.update_repo_archive_password(
+            group_id,
+            url,
+            branch,
+            password,
+        )
+    except Exception as exc:
+        logger.exception("git poller archive password setting failed")
+        await matcher.finish(f"输入非法，已取消设置：{exc}")
+    status = "回到全局默认" if subscription.archive_password is None else "已设置当前仓库密码"
+    await matcher.finish(
+        f"设置成功：{identity.display_name}\n"
+        f"分支：{subscription.branch}\n"
+        f"压缩包密码：{status}"
+    )
+
+
+@list_repos.handle()
+async def _(event: GroupMessageEvent, matcher: Matcher) -> None:
+    subscriptions = service.list_group_subscriptions(int(event.group_id))
+    if not subscriptions:
+        await matcher.finish("本群还没有关注任何仓库。")
+    lines = ["本群关注的仓库："]
+    for index, (repo_key, subscription) in enumerate(subscriptions.items(), start=1):
+        status = "启用" if subscription.enabled else "停用"
+        last_sha = subscription.last_success_sha[:8] if subscription.last_success_sha else "未记录"
+        password_status = "仓库密码" if subscription.archive_password else "全局默认"
+        lines.append(
+            f"{index}. {subscription.url}\n"
+            f"   key: {repo_key}\n"
+            f"   branch: {subscription.branch} / schedule: {subscription.schedule} / {status}\n"
+            f"   last_success_sha: {last_sha}\n"
+            f"   archive_password: {password_status}"
+        )
+    await matcher.finish("\n".join(lines))
+
+
+@pull_repo.handle()
+async def _(bot: Bot, event: GroupMessageEvent, matcher: Matcher, args: Message = CommandArg()) -> None:
+    try:
+        parsed = _repo_args(args)
+    except ValueError as exc:
+        await matcher.finish(f"用法：/拉取仓库 仓库url [--分支名]\n{exc}")
+    if parsed is None:
+        await matcher.finish("用法：/拉取仓库 仓库url [--分支名]")
+    group_id = int(event.group_id)
+    try:
+        result = await service.pull_repo(group_id, parsed.url, parsed.branch)
+        await upload_archive_to_group(
+            bot,
+            group_id,
+            result.archive,
+            config=plugin_config,
+        )
+        service.mark_pull_success(group_id, result.identity.key, result.target_sha)
+        await matcher.finish(
+            build_archive_delivery_text(
+                result.payload,
+                result.archive,
+                title="拉取完成",
+            )
+        )
+    except FinishedException:
+        raise
+    except Exception as exc:
+        logger.exception("git poller pull command failed")
+        await matcher.finish(f"拉取仓库失败：{exc}")
+
+
+@summarize_repo.handle()
+async def _(bot: Bot, event: GroupMessageEvent, matcher: Matcher, args: Message = CommandArg()) -> None:
+    try:
+        parsed = _repo_args(args)
+    except ValueError as exc:
+        await matcher.finish(f"用法：/仓库摘要 仓库url [--分支名]\n{exc}")
+    if parsed is None:
+        await matcher.finish("用法：/仓库摘要 仓库url [--分支名]")
+    group_id = int(event.group_id)
+    try:
+        summary = await service.summarize_repo(group_id, parsed.url, parsed.branch)
+        payload = summary.result.payload
+        if payload.previous_sha == payload.target_sha:
+            await matcher.finish(
+                f"仓库摘要：{payload.repo_name}\n"
+                f"分支：{payload.branch}\n"
+                f"本地与远程相同：{payload.target_short_sha}"
+            )
+        await send_update_to_group(bot, group_id, payload)
+        behind_text = (
+            f"本地记录落后远程 {summary.behind_count} 个 commit。"
+            if summary.behind_count is not None
+            else "本地记录与远程存在差异。"
+        )
+        await matcher.finish(
+            f"仓库摘要已发送：{payload.repo_name}\n"
+            f"分支：{payload.branch}\n"
+            f"{behind_text}\n"
+            f"本地记录未更新。"
+        )
+    except FinishedException:
+        raise
+    except Exception as exc:
+        logger.exception("git poller summary command failed")
+        await matcher.finish(f"仓库摘要失败：{exc}")
+
+
+async def run_scheduled_check(schedule: str) -> None:
+    bots = get_bots()
+    if not bots:
+        logger.warning("git poller scheduled check skipped: no bot is connected")
+        return
+    bot = next(iter(bots.values()))
+    try:
+        async for result in service.poll_schedule(schedule):
+            try:
+                await upload_archive_to_group(
+                    bot,
+                    result.result.group_id,
+                    result.archive,
+                    config=plugin_config,
+                )
+                await bot.send_group_msg(
+                    group_id=int(result.result.group_id),
+                    message=build_archive_delivery_text(
+                        result.result.payload,
+                        result.archive,
+                        title="拉取完成",
+                    ),
+                )
+                service.mark_success(result.result)
+            except ArchiveUploadUriError as exc:
+                logger.exception(
+                    f"git poller scheduled archive upload URI failed: "
+                    f"group={result.result.group_id}, repo={result.result.repo_key}"
+                )
+                try:
+                    await bot.send_group_msg(
+                        group_id=int(result.result.group_id),
+                        message=str(exc),
+                    )
+                except Exception:
+                    logger.exception(
+                        f"git poller scheduled upload error notification failed: "
+                        f"group={result.result.group_id}, repo={result.result.repo_key}"
+                    )
+                continue
+            except Exception:
+                logger.exception(
+                    f"git poller scheduled push failed: "
+                    f"group={result.result.group_id}, repo={result.result.repo_key}"
+                )
+                continue
+    except Exception:
+        logger.exception(f"git poller scheduled check failed: {schedule}")
+
+
+async def cleanup_unsubscribed_repo(repo_key: str) -> None:
+    try:
+        await asyncio.to_thread(service.cleanup_unsubscribed_repo, repo_key)
+    except Exception:
+        logger.exception(f"git poller delayed cleanup failed: repo={repo_key}")
+
+
+def _register_schedules() -> None:
+    for schedule_rule in sorted(service.scheduled_rules()):
+        _register_schedule(schedule_rule)
+
+
+def _cleanup_orphaned_storage_on_startup() -> None:
+    try:
+        service.cleanup_orphaned_storage()
+    except Exception:
+        logger.exception("git poller startup orphan cleanup failed")
+
+
+def _register_schedule(schedule_rule: str) -> None:
+    try:
+        spec = parse_schedule(schedule_rule, plugin_config.git_poller_timezone)
+    except ValueError:
+        logger.exception(f"git poller skipped invalid schedule: {schedule_rule}")
+        return
+    if spec is None:
+        return
+    scheduler.add_job(
+        run_scheduled_check,
+        spec.trigger,
+        args=[schedule_rule],
+        id=f"git_poller:{schedule_rule}",
+        max_instances=1,
+        coalesce=True,
+        replace_existing=True,
+        **spec.trigger_kwargs,
+    )
+    logger.info(f"git poller scheduler registered: {spec.description}")
+
+
+def _schedule_repo_cleanup(repo_key: str) -> None:
+    run_at = datetime.now() + timedelta(hours=1)
+    scheduler.add_job(
+        cleanup_unsubscribed_repo,
+        "date",
+        args=[repo_key],
+        id=f"git_poller:cleanup:{repo_key}",
+        run_date=run_at,
+        replace_existing=True,
+    )
+    logger.info(f"git poller delayed cleanup scheduled: repo={repo_key}, run_at={run_at}")
+
+
+def _repo_args(args: Message):
+    return parse_repo_command_args(str(args))
+
+
+def _same_config_session(event: GroupMessageEvent, matcher: Matcher) -> bool:
+    return (
+        int(event.group_id) == int(matcher.state.get("repo_config_group_id", -1))
+        and int(event.user_id) == int(matcher.state.get("repo_config_user_id", -1))
+    )
+
+
+_register_schedules()
+_cleanup_orphaned_storage_on_startup()
+register_archive_file_route(plugin_config)

nonebot_plugin_git_poller/archive.py

@@ -0,0 +1,145 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+import hashlib
+from pathlib import Path
+import re
+import tempfile
+
+from nonebot import logger
+from nonebot_plugin_localstore import get_plugin_cache_dir
+import py7zr
+
+from .models import Subscription, UpdatePayload
+
+
+@dataclass(frozen=True)
+class ArchiveFile:
+    path: Path
+    name: str
+    sha256: str
+    password: str | None
+    password_used: bool
+
+
+class ArchiveBuilder:
+    def __init__(self, default_password: str | None = None) -> None:
+        self.default_password = _clean_password(default_password)
+        self.archive_dir = get_plugin_cache_dir() / "archives"
+        self.archive_dir.mkdir(parents=True, exist_ok=True)
+
+    def build(
+        self,
+        payload: UpdatePayload,
+        subscription: Subscription,
+        source_dir: Path,
+    ) -> ArchiveFile:
+        password = _clean_password(subscription.archive_password) or self.default_password
+        archive_name = _archive_name(payload)
+        archive_path = _unique_archive_path(self.archive_dir, payload.repo_key, archive_name)
+
+        logger.info(
+            f"git poller building archive: repo={payload.repo_key}, "
+            f"target={payload.target_short_sha}, password={password is not None}"
+        )
+        with py7zr.SevenZipFile(archive_path, "w", password=password) as archive:
+            archive.writeall(source_dir, arcname=source_dir.name)
+        return ArchiveFile(
+            path=archive_path,
+            name=archive_name,
+            sha256=_sha256_file(archive_path),
+            password=password,
+            password_used=password is not None,
+        )
+
+    def source_root(self, payload: UpdatePayload) -> Path:
+        name = _source_root_name(payload)
+        return Path(tempfile.mkdtemp(prefix=f"{name}-", dir=str(self.archive_dir))) / name
+
+    def remove_archive(self, path: str | Path | None) -> bool:
+        if not path:
+            return False
+        archive_path = Path(path)
+        try:
+            archive_path.resolve().relative_to(self.archive_dir.resolve())
+        except ValueError:
+            logger.warning(f"git poller refused to remove archive outside cache: {archive_path}")
+            return False
+        try:
+            archive_path.unlink()
+        except FileNotFoundError:
+            return False
+        logger.info(f"git poller removed archive: {archive_path}")
+        return True
+
+    def remove_archives_for_repo(self, repo_key: str) -> int:
+        count = 0
+        prefix = f"{_safe_name(repo_key)}-"
+        for path in self.archive_dir.glob(f"{prefix}*.7z"):
+            try:
+                if path.is_file():
+                    path.unlink()
+                    count += 1
+            except OSError:
+                logger.exception(f"git poller failed to remove archive: {path}")
+        if count:
+            logger.info(f"git poller removed {count} archives for repo: {repo_key}")
+        return count
+
+    def remove_archives_except(self, active_repo_keys: set[str]) -> int:
+        active_prefixes = {f"{_safe_name(repo_key)}-" for repo_key in active_repo_keys}
+        count = 0
+        for path in self.archive_dir.glob("*.7z"):
+            if not path.is_file():
+                continue
+            if any(path.name.startswith(prefix) for prefix in active_prefixes):
+                continue
+            try:
+                path.unlink()
+                count += 1
+            except OSError:
+                logger.exception(f"git poller failed to remove orphan archive: {path}")
+        if count:
+            logger.info(f"git poller removed {count} orphan archives")
+        return count
+
+
+def _archive_name(payload: UpdatePayload) -> str:
+    return f"{_source_root_name(payload)}.7z"
+
+
+def _unique_archive_path(archive_dir: Path, repo_key: str, archive_name: str) -> Path:
+    stem = Path(archive_name).stem
+    with tempfile.NamedTemporaryFile(
+        prefix=f"{_safe_name(repo_key)}-{_safe_name(stem)}-",
+        suffix=".7z",
+        dir=archive_dir,
+        delete=False,
+    ) as file:
+        return Path(file.name)
+
+
+def _source_root_name(payload: UpdatePayload) -> str:
+    repo = _safe_name(payload.repo_name)
+    branch = _safe_name(payload.branch)
+    return f"{repo}-{branch}-{payload.target_short_sha}"
+
+
+def _safe_name(value: str) -> str:
+    cleaned = re.sub(r"[^A-Za-z0-9._-]+", "-", value.strip()).strip(".-")
+    return cleaned[:80] or "repository"
+
+
+def _clean_password(value: str | None) -> str | None:
+    if value is None:
+        return None
+    cleaned = value.strip()
+    return cleaned or None
+
+
+def _sha256_file(path: Path) -> str:
+    digest = hashlib.sha256()
+    with path.open("rb") as file:
+        for chunk in iter(lambda: file.read(1024 * 1024), b""):
+            digest.update(chunk)
+    return digest.hexdigest()

nonebot_plugin_git_poller/command_args.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class RepoCommandArgs:
+    url: str
+    branch: str | None = None
+
+
+def parse_repo_command_args(text: str) -> RepoCommandArgs | None:
+    value = text.strip()
+    if not value:
+        return None
+
+    parts = value.split()
+    url = parts[0]
+    branch: str | None = None
+    index = 1
+
+    if index < len(parts) and parts[index].startswith("--"):
+        branch = parts[index][2:].strip()
+        if not branch:
+            raise ValueError("分支名不能为空。")
+        index += 1
+
+    if index < len(parts):
+        raise ValueError("参数格式错误，请使用：仓库url [--分支名]")
+
+    return RepoCommandArgs(url=url, branch=branch)

nonebot_plugin_git_poller/config.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+
+from pydantic import BaseModel, Field
+from nonebot import get_plugin_config
+
+
+class Config(BaseModel):
+    git_poller_default_schedule: str = "每日04:00"
+    git_poller_timezone: str = "Asia/Shanghai"
+
+    git_poller_proxy: str | None = None
+    git_poller_timeout: float = Field(default=60.0, gt=0)
+    git_poller_archive_password: str | None = None
+    git_poller_file_base_url: str | None = None
+
+
+plugin_config = get_plugin_config(Config)