mirror of https://github.com/EstrellaXD/Auto_Bangumi.git synced 2026-10-29 03:36:15 +08:00

Files

Estrella Pan 396a92787e fix: 回滚后再升级时重新备份 3.x 数据库，单个下载器重命名出错不拖垮其它实例

- version_check: 数据库仍是 3.x 结构（schema ≤ 24）时备份并原子替换 data.db.v3.bak，
  回滚 3.3 后再升级也会刷新备份；只留一份，迁移失败的重启循环不会堆积
- rename_all: 实例内的异常记录后继续下一个实例
- 文档：回滚步骤删除 data.db-wal/-shm、还原编号最大的配置备份；schema v28
- 插件 skill 改用 httpx2、补全示例列表；示例 README 先安装 SDK 轮子再测试
- 准备 4.0.0-beta.9

2026-10-24 11:00:56 +02:00

3.5 KiB

Raw Permalink Blame History

运行外部命令（示例插件）

种子整理完成（torrent.organized）或文件被重命名（file.renamed）后运行一条外部命令，例如自己的清理脚本、FileBot、hlink。演示：

@subscribe("*", timeout=...) 订阅全部事件，按配置过滤；处理超时放宽到命令超时之上
asyncio.create_subprocess_exec 直接执行参数列表，不经过 shell
命令超时被杀掉，退出码非 0 时记录 stderr 的最后 2000 字节（边读边丢，输出再多也不占满内存）；命令退出后插件即关闭 stderr，留在后台的进程需自行重定向输出。失败只记日志，不让插件被熔断

配置

字段	说明
命令	程序及其参数，每项一个，如 `/config/scripts/link.sh`、`{files}`。不经过 shell，管道、重定向、`$变量` 都不会展开；需要时把命令写成脚本
事件	在哪些事件后运行，默认只有 `torrent.organized`
超时（秒）	默认 300，最大 3600。超时后杀掉命令

传给命令的字段

每个字段都是环境变量。参数列表里某一项整项写成占位符（环境变量名去掉 AB_ 后的小写，如 {torrent_hash}）时，这一项替换为字段值；{files} 展开为每个文件一个参数。只替换整项：--hash={torrent_hash}、sh -c "echo {new_path}" 这类夹在参数里的占位符不替换，原样传给程序；未知的占位符也原样保留。

文件名来自 RSS，可能含有 ;、$()、引号。不要把占位符写进 sh -c 的脚本文本，脚本里从 AB_* 环境变量读取事件数据，并给变量加双引号：

#!/bin/sh
# /config/scripts/on-rename.sh，命令填 ["/config/scripts/on-rename.sh"]
ln -f "$AB_NEW_PATH" "/media/links/$(basename "$AB_NEW_PATH")"

环境变量	事件	内容
`AB_EVENT`	全部	事件名
`AB_BANGUMI_ID`	全部	番剧 id；旧种子没有 `ab:<id>` 标签时为空
`AB_DOWNLOADER_ID`	全部	下载器实例 id
`AB_TORRENT_HASH`	`torrent.organized`	种子 hash
`AB_FILES`	`torrent.organized`	正片与字幕的最终路径，每行一个。路径本身含换行时无法按行区分，需要准确的路径请用 `{files}` 参数
`AB_OLD_PATH` / `AB_NEW_PATH`	`file.renamed`	重命名前后的路径
`AB_FILE_KIND`	`file.renamed`	`media` 或 `subtitle`

命令继承 AutoBangumi 的环境变量，但 AutoBangumi 自己的 AB_*（如下载器密码）不传给命令。事件里没有种子的保存目录，需要时从 AB_FILES 取。路径是下载器视角，AutoBangumi 与下载器的挂载不同时，脚本要自己换算。命令按事件顺序逐个运行，一个命令运行时后面的事件排队。

torrent.organized 的投递是「至少一次」：每次 AutoBangumi 重启，已整理的种子会再发布一次。脚本必须幂等。

安装

cp -r examples/plugins/run-command config/plugins/local/

在「设置 → 插件」中开启「允许未签名插件」，启用并填写命令。Docker 中命令在 AutoBangumi 的容器里运行，只能使用镜像里有的程序和挂载进来的脚本。

测试

cd examples/plugins/run-command
uv add ../autobangumi_sdk-0.6.0-py3-none-any.whl   # SDK 不在 PyPI：换成下载的轮子的实际路径
uv run pytest

对应 issue：#897、#668

3.5 KiB Raw Permalink Blame History Unescape Escape

运行外部命令（示例插件）

配置

传给命令的字段

安装

测试

3.5 KiB

Raw Permalink Blame History