比较提交
4 提交
S-17-后续增强规
...
main
| 作者 | SHA1 | 提交日期 | |
|---|---|---|---|
|
|
bae1381480 | ||
|
|
b6144d7625 | ||
|
|
36af501aa9 | ||
|
|
ed72d9934d |
共有 11 个文件被更改,包括 1842 次插入 和 17 次删除
19
README.md
19
README.md
|
|
@ -9,6 +9,16 @@
|
|||
- `/jm scan`:手动触发一次 Komga 扫描。
|
||||
- `/jm cleanup`:清理超过 `cleanup_retention_days` 的临时工作目录。
|
||||
|
||||
## 访问控制
|
||||
|
||||
插件默认启用白名单:只有 `access_control` 白名单中的群聊或私聊账号可以触发命令。黑名单优先于白名单。
|
||||
|
||||
- OneBot v11 / aiocqhttp 群聊:`allow_group_ids` 填群号,例如 `123456789`。
|
||||
- OneBot v11 / aiocqhttp 私聊:`allow_private_user_ids` 填 QQ 号,例如 `10001`。
|
||||
- OneBot v11 / aiocqhttp 机器人自身账号:`allow_self_ids` 填机器人 QQ 号,可用于多账号场景。
|
||||
- 多平台实例:可写 `平台ID:群号` 或 `平台ID:QQ号`,也可用完整 UMO:`平台ID:GroupMessage:群号`、`平台ID:FriendMessage:QQ号`。
|
||||
- 平台 ID:来自 AstrBot 平台实例 ID,`/jm status` 会显示当前事件的 `平台 ID`、`机器人自身 ID`、`群聊 ID`、`发送者 ID` 和 `UMO`。
|
||||
|
||||
## 归档结构
|
||||
|
||||
默认归档为 `cbz`,目录结构如下:
|
||||
|
|
@ -46,6 +56,13 @@ CBZ 内部会包含:
|
|||
POST /api/v1/libraries/{libraryId}/scan
|
||||
```
|
||||
|
||||
## 代理与登录
|
||||
|
||||
- 代理:配置 `jm_proxy.mode`。常用值是 `system`、`clash`、`v2ray`、`custom`。
|
||||
- 自定义代理:`jm_proxy.mode=custom`,再填写 `jm_proxy.proxy_url`,例如 `127.0.0.1:7890`。
|
||||
- 账号登录:默认不需要。少部分敏感题材可能需要登录,此时可启用 `jm_login.enabled` 并填写 `jm_login.username` / `jm_login.password`,插件会调用 jmcomic 的 `login` 插件自动获取 Cookie。
|
||||
- 手动 Cookie:如果不想保存账号密码,也可以填写 `jm_avs_cookie`,只填浏览器 Cookie 中 `AVS` 的值。
|
||||
|
||||
## 测试
|
||||
|
||||
```bash
|
||||
|
|
@ -54,4 +71,6 @@ python -m unittest discover -s tests
|
|||
|
||||
详细部署步骤见 [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md)。
|
||||
|
||||
项目迁移和 Codex 账号交接见 [docs/MIGRATION_HANDOFF.md](docs/MIGRATION_HANDOFF.md)。
|
||||
|
||||
后续增强计划见 [docs/ROADMAP.md](docs/ROADMAP.md)。
|
||||
|
|
|
|||
|
|
@ -65,6 +65,138 @@
|
|||
"type": "int",
|
||||
"default": 20
|
||||
},
|
||||
"access_control": {
|
||||
"description": "JMDownload 触发访问控制。黑名单优先;默认只有白名单中的群聊或私聊账号可以触发。",
|
||||
"type": "object",
|
||||
"items": {
|
||||
"enabled": {
|
||||
"description": "启用插件级白名单/黑名单。",
|
||||
"type": "bool",
|
||||
"default": true
|
||||
},
|
||||
"require_whitelist": {
|
||||
"description": "是否要求命令来源必须命中白名单。默认开启;关闭后仅黑名单生效。",
|
||||
"type": "bool",
|
||||
"default": true
|
||||
},
|
||||
"allow_platform_ids": {
|
||||
"description": "允许触发的 AstrBot 平台 ID 列表。命中后该平台全部群聊/私聊允许触发。",
|
||||
"type": "list",
|
||||
"default": []
|
||||
},
|
||||
"allow_self_ids": {
|
||||
"description": "允许触发的机器人自身 ID 列表。OneBot v11 中是机器人 QQ 号;可写 123456 或 平台ID:123456。",
|
||||
"type": "list",
|
||||
"default": []
|
||||
},
|
||||
"allow_group_ids": {
|
||||
"description": "允许触发的群聊 ID 列表。OneBot v11 使用群号;可写 123456 或 平台ID:123456。",
|
||||
"type": "list",
|
||||
"default": []
|
||||
},
|
||||
"allow_private_user_ids": {
|
||||
"description": "允许触发的私聊账号 ID 列表。OneBot v11 使用 QQ 号;可写 123456 或 平台ID:123456。",
|
||||
"type": "list",
|
||||
"default": []
|
||||
},
|
||||
"allow_unified_origins": {
|
||||
"description": "允许触发的完整 AstrBot UMO,例如 aiocqhttp:GroupMessage:123456 或 平台ID:FriendMessage:123456。",
|
||||
"type": "list",
|
||||
"default": []
|
||||
},
|
||||
"deny_platform_ids": {
|
||||
"description": "禁止触发的 AstrBot 平台 ID 列表。黑名单优先于白名单。",
|
||||
"type": "list",
|
||||
"default": []
|
||||
},
|
||||
"deny_self_ids": {
|
||||
"description": "禁止触发的机器人自身 ID 列表。OneBot v11 中是机器人 QQ 号;可写 123456 或 平台ID:123456。",
|
||||
"type": "list",
|
||||
"default": []
|
||||
},
|
||||
"deny_group_ids": {
|
||||
"description": "禁止触发的群聊 ID 列表。可写 123456 或 平台ID:123456。",
|
||||
"type": "list",
|
||||
"default": []
|
||||
},
|
||||
"deny_private_user_ids": {
|
||||
"description": "禁止触发的私聊账号 ID 列表。可写 123456 或 平台ID:123456。",
|
||||
"type": "list",
|
||||
"default": []
|
||||
},
|
||||
"deny_unified_origins": {
|
||||
"description": "禁止触发的完整 AstrBot UMO。黑名单优先于白名单。",
|
||||
"type": "list",
|
||||
"default": []
|
||||
},
|
||||
"deny_message": {
|
||||
"description": "拒绝触发时回复的文本。留空则静默拒绝。",
|
||||
"type": "string",
|
||||
"default": ""
|
||||
}
|
||||
}
|
||||
},
|
||||
"jm_proxy": {
|
||||
"description": "JM 下载代理配置。",
|
||||
"type": "object",
|
||||
"items": {
|
||||
"mode": {
|
||||
"description": "代理模式:inherit=不写入配置,none=禁用代理,system=系统代理,clash/v2ray=jmcomic 内置快捷代理,custom=自定义代理。",
|
||||
"type": "string",
|
||||
"default": "inherit",
|
||||
"options": ["inherit", "none", "system", "clash", "v2ray", "custom"]
|
||||
},
|
||||
"proxy_url": {
|
||||
"description": "custom 模式下的统一代理,例如 127.0.0.1:7890 或 http://127.0.0.1:7890。",
|
||||
"type": "string",
|
||||
"default": ""
|
||||
},
|
||||
"http_proxy": {
|
||||
"description": "custom 模式下单独指定 HTTP 代理;留空时使用 proxy_url。",
|
||||
"type": "string",
|
||||
"default": ""
|
||||
},
|
||||
"https_proxy": {
|
||||
"description": "custom 模式下单独指定 HTTPS 代理;留空时使用 proxy_url。",
|
||||
"type": "string",
|
||||
"default": ""
|
||||
}
|
||||
}
|
||||
},
|
||||
"jm_login": {
|
||||
"description": "可选 JM 账号密码登录配置。启用后下载前会调用 jmcomic 登录插件自动获取登录 Cookie。",
|
||||
"type": "object",
|
||||
"items": {
|
||||
"enabled": {
|
||||
"description": "启用 JM 账号密码登录。大部分本子不需要登录,受限内容再开启。",
|
||||
"type": "bool",
|
||||
"default": false
|
||||
},
|
||||
"username": {
|
||||
"description": "JM 用户名。",
|
||||
"type": "string",
|
||||
"default": ""
|
||||
},
|
||||
"password": {
|
||||
"description": "JM 密码。会写入本次下载的临时 jmcomic 配置,初始化后插件会尽量删除该临时配置文件。",
|
||||
"type": "string",
|
||||
"default": "",
|
||||
"invisible": true
|
||||
},
|
||||
"impl": {
|
||||
"description": "jmcomic 登录客户端实现。默认 api;如登录异常可尝试 html。",
|
||||
"type": "string",
|
||||
"default": "api",
|
||||
"options": ["api", "html"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"jm_avs_cookie": {
|
||||
"description": "可选 JM 登录 Cookie,只填写 AVS 的值。大部分本子不需要登录,敏感题材可能需要。",
|
||||
"type": "string",
|
||||
"default": "",
|
||||
"invisible": true
|
||||
},
|
||||
"jm_domains": {
|
||||
"description": "jmcomic 域名列表,按优先级排序。",
|
||||
"type": "list",
|
||||
|
|
|
|||
|
|
@ -78,7 +78,148 @@ komga.password
|
|||
POST /api/v1/libraries/{libraryId}/scan
|
||||
```
|
||||
|
||||
## 4. 命令
|
||||
## 4. 访问控制
|
||||
|
||||
插件默认启用访问控制,并且要求命令来源命中白名单:
|
||||
|
||||
```text
|
||||
access_control.enabled: true
|
||||
access_control.require_whitelist: true
|
||||
```
|
||||
|
||||
OneBot v11 / aiocqhttp 的 ID 识别方式:
|
||||
|
||||
```text
|
||||
群聊消息:event.get_group_id() 是群号,event.get_sender_id() 是发送者 QQ 号
|
||||
私聊消息:event.get_group_id() 为空,event.get_sender_id() 是对方 QQ 号
|
||||
机器人自身 ID:event.get_self_id() 是机器人 QQ 号
|
||||
平台 ID:event.get_platform_id() 是 AstrBot 平台实例 ID
|
||||
UMO:event.unified_msg_origin,格式为 平台ID:消息类型:会话ID
|
||||
```
|
||||
|
||||
允许某个群触发:
|
||||
|
||||
```text
|
||||
access_control.allow_group_ids:
|
||||
- 123456789
|
||||
```
|
||||
|
||||
允许某个私聊账号触发:
|
||||
|
||||
```text
|
||||
access_control.allow_private_user_ids:
|
||||
- 10001
|
||||
```
|
||||
|
||||
允许某个 OneBot 机器人账号下的全部会话触发:
|
||||
|
||||
```text
|
||||
access_control.allow_self_ids:
|
||||
- 30003
|
||||
```
|
||||
|
||||
多个 OneBot / aiocqhttp 实例并存时,建议带上平台 ID:
|
||||
|
||||
```text
|
||||
access_control.allow_group_ids:
|
||||
- qq-main:123456789
|
||||
access_control.allow_private_user_ids:
|
||||
- qq-main:10001
|
||||
access_control.allow_self_ids:
|
||||
- qq-main:30003
|
||||
```
|
||||
|
||||
也可以使用完整 UMO:
|
||||
|
||||
```text
|
||||
access_control.allow_unified_origins:
|
||||
- qq-main:GroupMessage:123456789
|
||||
- qq-main:FriendMessage:10001
|
||||
```
|
||||
|
||||
黑名单优先于白名单:
|
||||
|
||||
```text
|
||||
access_control.deny_group_ids:
|
||||
- 987654321
|
||||
access_control.deny_private_user_ids:
|
||||
- 20002
|
||||
access_control.deny_self_ids:
|
||||
- 30003
|
||||
```
|
||||
|
||||
如果想只使用黑名单,不要求白名单:
|
||||
|
||||
```text
|
||||
access_control.require_whitelist: false
|
||||
```
|
||||
|
||||
拒绝时默认静默处理。需要提示时可配置:
|
||||
|
||||
```text
|
||||
access_control.deny_message: 当前会话不在 JMDownload 白名单内。
|
||||
```
|
||||
|
||||
首次配置时如果不知道 ID,可以临时设置 `access_control.require_whitelist: false`,执行 `/jm status` 查看当前事件的 `平台 ID`、`机器人自身 ID`、`群聊 ID`、`发送者 ID` 和 `UMO`,复制完成后再重新开启白名单。
|
||||
|
||||
## 5. JM 代理与登录
|
||||
|
||||
jmcomic 的代理配置位于 `client.postman.meta_data.proxies`。本插件在 WebUI 中提供 `jm_proxy`:
|
||||
|
||||
```text
|
||||
jm_proxy.mode: inherit
|
||||
```
|
||||
|
||||
可选值:
|
||||
|
||||
```text
|
||||
inherit 不写入代理配置,沿用 jmcomic 默认行为
|
||||
none 写入 proxies: null,禁用代理
|
||||
system 使用系统代理
|
||||
clash 使用 jmcomic 内置 clash 快捷代理
|
||||
v2ray 使用 jmcomic 内置 v2ray 快捷代理
|
||||
custom 使用自定义代理
|
||||
```
|
||||
|
||||
自定义代理示例:
|
||||
|
||||
```text
|
||||
jm_proxy.mode: custom
|
||||
jm_proxy.proxy_url: 127.0.0.1:7890
|
||||
```
|
||||
|
||||
如果 HTTP 和 HTTPS 代理不同:
|
||||
|
||||
```text
|
||||
jm_proxy.mode: custom
|
||||
jm_proxy.http_proxy: 127.0.0.1:7890
|
||||
jm_proxy.https_proxy: 127.0.0.1:7890
|
||||
```
|
||||
|
||||
JM 下载大部分本子不需要登录。少部分敏感题材可能需要登录态,可以选择账号密码登录或手动 Cookie。
|
||||
|
||||
账号密码登录:
|
||||
|
||||
```text
|
||||
jm_login.enabled: true
|
||||
jm_login.username: <JM 用户名>
|
||||
jm_login.password: <JM 密码>
|
||||
jm_login.impl: api
|
||||
```
|
||||
|
||||
插件会把账号密码写入本次下载的临时 `jmcomic.yml`,通过 jmcomic 的 `login` 插件自动获取 Cookie。jmcomic 初始化完成后,本插件会尽量删除该临时配置文件,减少密码残留。
|
||||
|
||||
如果 `api` 登录异常,可尝试:
|
||||
|
||||
```text
|
||||
jm_login.impl: html
|
||||
```
|
||||
|
||||
不想保存账号密码时,也可以只配置 `jm_avs_cookie`,填写浏览器 Cookie 中 `AVS` 的值即可。
|
||||
|
||||
注意:AVS Cookie 和访问域名有关,使用的 JM 域名要和 Cookie 来源域名一致。
|
||||
|
||||
## 6. 命令
|
||||
|
||||
```text
|
||||
/jm download <id>
|
||||
|
|
@ -88,15 +229,18 @@ POST /api/v1/libraries/{libraryId}/scan
|
|||
/jm cleanup
|
||||
```
|
||||
|
||||
## 5. 故障排查
|
||||
## 7. 故障排查
|
||||
|
||||
- 插件无法加载:检查 `requirements.txt` 是否安装成功。
|
||||
- 命令没有反应:默认需要命中 `access_control` 白名单;先确认当前群号、QQ 号或 UMO 已配置。
|
||||
- 下载后没有文件:检查 `jm_domains` 是否可用,或降低 `jm_batch_count`。
|
||||
- 代理未生效:检查 `jm_proxy.mode`,custom 模式下确认代理端口可用。
|
||||
- 登录后仍不可下载:账号密码方式可切换 `jm_login.impl` 为 `html` 试试;手动 Cookie 方式需确认 `jm_avs_cookie` 来自当前实际访问的 JM 域名。
|
||||
- Komga 没有识别:确认 `archive_root` 是 Komga library 根目录,并手动执行 `/jm scan`。
|
||||
- 文件发送失败:不同平台对文件消息支持不同;归档仍会保存在 `archive_root`。
|
||||
- PDF 转换失败:确认 `PyPDF2` 已安装,或改用默认 `cbz`。
|
||||
|
||||
## 6. 本地测试
|
||||
## 8. 本地测试
|
||||
|
||||
```bash
|
||||
python -m unittest discover -s tests
|
||||
|
|
|
|||
810
docs/MIGRATION_HANDOFF.md
普通文件
810
docs/MIGRATION_HANDOFF.md
普通文件
|
|
@ -0,0 +1,810 @@
|
|||
# JMDownload 项目迁移交接文档
|
||||
|
||||
更新日期:2026-07-18
|
||||
|
||||
本文用于在迁移项目路径、迁移 Forgejo 仓库地址、或更换 Codex 账号后继续开发 `astrbot_plugin_jmdownload`。内容尽量保留当前对话中已经确定的背景、设计决策、版本状态和后续注意事项。
|
||||
|
||||
## 1. 当前项目定位
|
||||
|
||||
这是一个 AstrBot 插件,用于把原 NoneBot 插件 `QuickLAW/nonebot_plugin_JMDownload` 的核心功能迁移到 AstrBot,并在此基础上增强:
|
||||
|
||||
```text
|
||||
JM ID -> jmcomic 下载 -> CBZ/PDF 归档 -> Komga 扫描 -> AstrBot 消息反馈
|
||||
```
|
||||
|
||||
当前目标不是做一个网页或独立服务,而是一个可放入 AstrBot `data/plugins` 目录的插件。
|
||||
|
||||
## 2. 当前本地路径
|
||||
|
||||
当前 Windows 桌面开发路径:
|
||||
|
||||
```text
|
||||
E:\Codex\JMDownload
|
||||
```
|
||||
|
||||
注意:`E:\Codex\JMDownload` 只是工作父目录,不是 Git 仓库。真正的插件仓库在:
|
||||
|
||||
```text
|
||||
E:\Codex\JMDownload\astrbot_plugin_jmdownload
|
||||
```
|
||||
|
||||
同级目录中还有原参考仓库源码:
|
||||
|
||||
```text
|
||||
E:\Codex\JMDownload\nonebot_plugin_JMDownload
|
||||
```
|
||||
|
||||
原仓库只作为迁移参考,不是当前插件的主仓库。
|
||||
|
||||
## 3. 当前远端仓库
|
||||
|
||||
当前插件仓库 Git remote:
|
||||
|
||||
```text
|
||||
origin ssh://forgejo-codex/YokiiroBW/astrbot_plugin_jmdowloads.git
|
||||
```
|
||||
|
||||
历史上曾使用过 HTTP 地址:
|
||||
|
||||
```text
|
||||
http://192.168.31.210:18085/YokiiroBW/astrbot_plugin_jmdowloads.git
|
||||
```
|
||||
|
||||
仓库名里有一个历史拼写:`jmdowloads`,少了 `n`。本地插件目录仍然是正确拼写:
|
||||
|
||||
```text
|
||||
astrbot_plugin_jmdownload
|
||||
```
|
||||
|
||||
`metadata.yaml` 里的 `repo` 字段目前仍写的是 HTTP 地址。如果迁移到新 Forgejo 地址,建议同步更新:
|
||||
|
||||
```yaml
|
||||
repo: "新的仓库地址"
|
||||
```
|
||||
|
||||
## 4. 当前 Git 状态
|
||||
|
||||
截至本文写入前,最新功能基线为:
|
||||
|
||||
```text
|
||||
branch: main
|
||||
feature baseline: b6144d7 S-20 访问控制白名单黑名单
|
||||
tracking: main...origin/main
|
||||
workspace: clean
|
||||
```
|
||||
|
||||
如果本文档被提交为后续版本,`git log -1` 可能显示文档提交,例如 `S-21 迁移交接文档`;功能代码仍以上述 S-20 为当前完成基线。
|
||||
|
||||
当前已存在的版本 TAG:
|
||||
|
||||
```text
|
||||
S-01-插件骨架固化
|
||||
S-04-jmcomic配置接入修正
|
||||
S-03-下载器核心迁移
|
||||
S-08-CBZ归档完善
|
||||
S-10-Komga扫描联动
|
||||
S-11-AstrBot文件发送
|
||||
S-09-PDF输出兼容
|
||||
S-12-错误模型统一
|
||||
S-13-清理策略
|
||||
S-14-单元测试
|
||||
S-15-集成测试
|
||||
S-16-部署文档
|
||||
S-17-后续增强规划
|
||||
S-18-JM代理与登录配置
|
||||
S-19-JM账号登录自动Cookie
|
||||
S-20-访问控制白名单黑名单
|
||||
```
|
||||
|
||||
用户要求:每个版本都要提交、推送到局域网 Forgejo,并使用中文 TAG。
|
||||
|
||||
推荐后续版本命名继续使用:
|
||||
|
||||
```text
|
||||
commit: S-21 <中文说明>
|
||||
tag: S-21-<中文说明>
|
||||
```
|
||||
|
||||
## 5. 已完成版本概要
|
||||
|
||||
### S-01 插件骨架固化
|
||||
|
||||
建立 AstrBot 插件最小骨架:
|
||||
|
||||
- `main.py`
|
||||
- `metadata.yaml`
|
||||
- `requirements.txt`
|
||||
- `_conf_schema.json`
|
||||
- 基础服务目录 `services/`
|
||||
|
||||
### S-03 下载器核心迁移
|
||||
|
||||
接入 `jmcomic` 下载:
|
||||
|
||||
- 使用 `jmcomic.create_option_by_file(...)`
|
||||
- 使用 `jmcomic.download_album(...)`
|
||||
- 下载任务放入插件工作目录
|
||||
- 提取下载结果标题
|
||||
- 收集图片文件
|
||||
|
||||
### S-04 jmcomic 配置接入修正
|
||||
|
||||
修正 jmcomic 配置文件生成方式,保证下载目录、域名和批次配置可以通过插件设置写入。
|
||||
|
||||
### S-08 CBZ 归档完善
|
||||
|
||||
实现 Komga 友好的 CBZ 结构:
|
||||
|
||||
```text
|
||||
<archive_root>/
|
||||
<series_name>/
|
||||
<series_name> [<JM ID>].cbz
|
||||
```
|
||||
|
||||
CBZ 内包含:
|
||||
|
||||
- `ComicInfo.xml`
|
||||
- `0001.jpg`
|
||||
- `0002.jpg`
|
||||
- 后续页面
|
||||
|
||||
### S-09 PDF 输出兼容
|
||||
|
||||
保留 PDF 输出能力:
|
||||
|
||||
- `archive_format=pdf`
|
||||
- `pdf_chunk_size`
|
||||
- 使用临时 PDF 分块降低大本子转换时的内存占用
|
||||
|
||||
### S-10 Komga 扫描联动
|
||||
|
||||
归档后可自动请求 Komga 扫描:
|
||||
|
||||
```text
|
||||
POST /api/v1/libraries/{libraryId}/scan
|
||||
```
|
||||
|
||||
支持:
|
||||
|
||||
- `komga.api_key`
|
||||
- 或 `komga.username` + `komga.password`
|
||||
|
||||
### S-11 AstrBot 文件发送
|
||||
|
||||
支持在平台允许时,把生成的归档文件发送回聊天:
|
||||
|
||||
```text
|
||||
send_archive_file: true
|
||||
```
|
||||
|
||||
不同平台对文件消息支持不一致;即使发送失败,归档文件仍会保存在 `archive_root`。
|
||||
|
||||
### S-12 错误模型统一
|
||||
|
||||
统一插件内可预期错误模型:
|
||||
|
||||
- 配置错误
|
||||
- 下载错误
|
||||
- 归档错误
|
||||
- Komga 扫描错误
|
||||
|
||||
### S-13 清理策略
|
||||
|
||||
支持临时下载目录清理:
|
||||
|
||||
- 归档成功后默认删除本次工作目录
|
||||
- `/jm cleanup` 清理历史临时目录
|
||||
- `cleanup_retention_days=0` 表示清理全部历史工作目录
|
||||
|
||||
### S-14 单元测试
|
||||
|
||||
建立基础单元测试:
|
||||
|
||||
- 配置解析
|
||||
- 归档生成
|
||||
- 图片排序/收集
|
||||
- 清理安全边界
|
||||
|
||||
### S-15 集成测试
|
||||
|
||||
补充归档与 Komga 扫描的集成测试。
|
||||
|
||||
### S-16 部署文档
|
||||
|
||||
新增 `docs/DEPLOYMENT.md`,记录安装、配置、Komga 联动、命令和故障排查。
|
||||
|
||||
### S-17 后续增强规划
|
||||
|
||||
新增 `docs/ROADMAP.md`,规划批量下载、任务状态、元数据增强、Komga 健康检查、去重策略、权限审计和真实环境联调。
|
||||
|
||||
### S-18 JM 代理与登录配置
|
||||
|
||||
新增 JM 下载代理配置:
|
||||
|
||||
```text
|
||||
jm_proxy.mode: inherit | none | system | clash | v2ray | custom
|
||||
jm_proxy.proxy_url
|
||||
jm_proxy.http_proxy
|
||||
jm_proxy.https_proxy
|
||||
```
|
||||
|
||||
代理写入 jmcomic:
|
||||
|
||||
```text
|
||||
client.postman.meta_data.proxies
|
||||
```
|
||||
|
||||
新增手动 AVS Cookie:
|
||||
|
||||
```text
|
||||
jm_avs_cookie
|
||||
```
|
||||
|
||||
大部分 JM 下载不需要登录;少量敏感或受限内容可能需要登录态。
|
||||
|
||||
### S-19 JM 账号登录自动 Cookie
|
||||
|
||||
新增账号密码登录:
|
||||
|
||||
```text
|
||||
jm_login.enabled
|
||||
jm_login.username
|
||||
jm_login.password
|
||||
jm_login.impl: api | html
|
||||
```
|
||||
|
||||
实现方式:
|
||||
|
||||
- 使用 jmcomic 自带 `plugins.after_init -> login` 插件
|
||||
- 登录后由 jmcomic 更新请求 Cookie
|
||||
- 插件在 jmcomic 初始化完成后尽量删除含账号密码或 AVS 的临时 `jmcomic.yml`
|
||||
|
||||
安全注意:
|
||||
|
||||
- 不建议通过聊天命令输入密码
|
||||
- 密码应放 AstrBot 插件配置
|
||||
- 配置文件中的 `password` 字段已设为 `invisible`
|
||||
|
||||
### S-20 访问控制白名单黑名单
|
||||
|
||||
新增插件级访问控制,默认启用并要求白名单:
|
||||
|
||||
```text
|
||||
access_control.enabled: true
|
||||
access_control.require_whitelist: true
|
||||
```
|
||||
|
||||
支持:
|
||||
|
||||
- 平台 ID 白/黑名单
|
||||
- OneBot v11 机器人自身 ID 白/黑名单
|
||||
- 群聊 ID 白/黑名单
|
||||
- 私聊账号 ID 白/黑名单
|
||||
- 完整 UMO 白/黑名单
|
||||
- 黑名单优先于白名单
|
||||
- 拒绝时可静默,也可配置拒绝提示
|
||||
|
||||
## 6. 当前文件结构
|
||||
|
||||
```text
|
||||
astrbot_plugin_jmdownload/
|
||||
_conf_schema.json
|
||||
main.py
|
||||
metadata.yaml
|
||||
requirements.txt
|
||||
README.md
|
||||
docs/
|
||||
DEPLOYMENT.md
|
||||
MIGRATION_HANDOFF.md
|
||||
ROADMAP.md
|
||||
services/
|
||||
__init__.py
|
||||
access.py
|
||||
archive.py
|
||||
download.py
|
||||
errors.py
|
||||
images.py
|
||||
komga.py
|
||||
settings.py
|
||||
tests/
|
||||
helpers.py
|
||||
test_access_control.py
|
||||
test_archive.py
|
||||
test_cleanup.py
|
||||
test_images.py
|
||||
test_integration_archive_komga.py
|
||||
test_jmcomic_config.py
|
||||
test_settings.py
|
||||
```
|
||||
|
||||
## 7. 关键代码说明
|
||||
|
||||
### `main.py`
|
||||
|
||||
AstrBot 插件入口:
|
||||
|
||||
- 注册 `/jm` 命令组
|
||||
- `/jm download <id>` 下载、归档、Komga 扫描、可选发送文件
|
||||
- `/jm status` 显示配置状态和当前事件 ID
|
||||
- `/jm scan` 手动触发 Komga 扫描
|
||||
- `/jm cleanup` 清理临时工作目录
|
||||
- `_deny_request(...)` 统一访问控制和管理员校验
|
||||
|
||||
### `services/settings.py`
|
||||
|
||||
解析 AstrBot WebUI 插件配置:
|
||||
|
||||
- `PluginSettings`
|
||||
- `AccessControlSettings`
|
||||
- `JmProxySettings`
|
||||
- `JmLoginSettings`
|
||||
- `KomgaSettings`
|
||||
|
||||
### `services/access.py`
|
||||
|
||||
插件级白名单/黑名单:
|
||||
|
||||
- `EventIdentity.from_event(event)` 提取 AstrBot 事件身份
|
||||
- `AccessControl.check(event)` 返回允许/拒绝和原因
|
||||
- 支持 `平台ID:ID` scoped 写法
|
||||
- 支持完整 `unified_msg_origin`
|
||||
|
||||
### `services/download.py`
|
||||
|
||||
jmcomic 下载:
|
||||
|
||||
- 动态生成 `jmcomic.yml`
|
||||
- 写入下载目录、JM 域名、批次大小
|
||||
- 写入代理 `client.postman.meta_data.proxies`
|
||||
- 写入手动 `cookies.AVS`
|
||||
- 写入账号登录插件 `plugins.after_init`
|
||||
- 初始化后尽量删除敏感临时配置
|
||||
|
||||
### `services/archive.py`
|
||||
|
||||
归档输出:
|
||||
|
||||
- CBZ
|
||||
- PDF
|
||||
- `ComicInfo.xml`
|
||||
- Komga 友好的目录结构
|
||||
|
||||
### `services/komga.py`
|
||||
|
||||
Komga library scan:
|
||||
|
||||
- API Key
|
||||
- Basic Auth
|
||||
- 扫描超时
|
||||
|
||||
## 8. AstrBot / OneBot v11 ID 识别
|
||||
|
||||
AstrBot 开发摘要来源:
|
||||
|
||||
```text
|
||||
E:\Codex\Astrbot\ASTRBOT_PLUGIN_DEVELOPMENT_SUMMARY.md
|
||||
```
|
||||
|
||||
事件对象常用字段:
|
||||
|
||||
```python
|
||||
event.get_sender_id()
|
||||
event.get_group_id()
|
||||
event.get_self_id()
|
||||
event.get_platform_name()
|
||||
event.get_platform_id()
|
||||
event.unified_msg_origin
|
||||
event.is_private_chat()
|
||||
event.is_admin()
|
||||
```
|
||||
|
||||
AstrBot `unified_msg_origin` 格式:
|
||||
|
||||
```text
|
||||
平台ID:消息类型:会话ID
|
||||
```
|
||||
|
||||
OneBot v11 / aiocqhttp 识别方式:
|
||||
|
||||
```text
|
||||
群聊消息:
|
||||
get_group_id() -> 群号
|
||||
get_sender_id() -> 发送者 QQ 号
|
||||
get_self_id() -> 机器人 QQ 号
|
||||
UMO -> 平台ID:GroupMessage:群号
|
||||
|
||||
私聊消息:
|
||||
get_group_id() -> 空字符串
|
||||
get_sender_id() -> 对方 QQ 号
|
||||
get_self_id() -> 机器人 QQ 号
|
||||
UMO -> 平台ID:FriendMessage:QQ号
|
||||
```
|
||||
|
||||
白名单配置示例:
|
||||
|
||||
```text
|
||||
access_control.allow_group_ids:
|
||||
- 123456789
|
||||
- qq-main:123456789
|
||||
|
||||
access_control.allow_private_user_ids:
|
||||
- 10001
|
||||
- qq-main:10001
|
||||
|
||||
access_control.allow_self_ids:
|
||||
- 30003
|
||||
- qq-main:30003
|
||||
|
||||
access_control.allow_unified_origins:
|
||||
- qq-main:GroupMessage:123456789
|
||||
- qq-main:FriendMessage:10001
|
||||
```
|
||||
|
||||
首次迁移时如果不知道平台 ID 或群号,可以临时配置:
|
||||
|
||||
```text
|
||||
access_control.require_whitelist: false
|
||||
```
|
||||
|
||||
然后在目标会话里执行:
|
||||
|
||||
```text
|
||||
/jm status
|
||||
```
|
||||
|
||||
查看输出中的:
|
||||
|
||||
- 当前平台 ID
|
||||
- 当前机器人自身 ID
|
||||
- 当前群聊 ID
|
||||
- 当前私聊/发送者 ID
|
||||
- 当前 UMO
|
||||
|
||||
复制到白名单后,再重新开启:
|
||||
|
||||
```text
|
||||
access_control.require_whitelist: true
|
||||
```
|
||||
|
||||
## 9. 当前配置项总览
|
||||
|
||||
来自 `_conf_schema.json`。
|
||||
|
||||
基础配置:
|
||||
|
||||
```text
|
||||
archive_root
|
||||
archive_format: cbz | pdf
|
||||
pdf_chunk_size
|
||||
admin_only
|
||||
send_archive_file
|
||||
overwrite_existing
|
||||
delete_work_dir_after_archive
|
||||
cleanup_retention_days
|
||||
download_timeout_seconds
|
||||
download_retry_count
|
||||
progress_interval_seconds
|
||||
max_concurrent_tasks
|
||||
jm_batch_count
|
||||
jm_domains
|
||||
```
|
||||
|
||||
访问控制:
|
||||
|
||||
```text
|
||||
access_control.enabled
|
||||
access_control.require_whitelist
|
||||
access_control.allow_platform_ids
|
||||
access_control.allow_self_ids
|
||||
access_control.allow_group_ids
|
||||
access_control.allow_private_user_ids
|
||||
access_control.allow_unified_origins
|
||||
access_control.deny_platform_ids
|
||||
access_control.deny_self_ids
|
||||
access_control.deny_group_ids
|
||||
access_control.deny_private_user_ids
|
||||
access_control.deny_unified_origins
|
||||
access_control.deny_message
|
||||
```
|
||||
|
||||
JM 代理:
|
||||
|
||||
```text
|
||||
jm_proxy.mode
|
||||
jm_proxy.proxy_url
|
||||
jm_proxy.http_proxy
|
||||
jm_proxy.https_proxy
|
||||
```
|
||||
|
||||
JM 登录:
|
||||
|
||||
```text
|
||||
jm_login.enabled
|
||||
jm_login.username
|
||||
jm_login.password
|
||||
jm_login.impl
|
||||
jm_avs_cookie
|
||||
```
|
||||
|
||||
Komga:
|
||||
|
||||
```text
|
||||
komga.enabled
|
||||
komga.base_url
|
||||
komga.library_id
|
||||
komga.username
|
||||
komga.password
|
||||
komga.api_key
|
||||
komga.scan_timeout_seconds
|
||||
```
|
||||
|
||||
## 10. 敏感配置迁移注意事项
|
||||
|
||||
以下值不应该写入 Git:
|
||||
|
||||
- JM 密码:`jm_login.password`
|
||||
- JM AVS Cookie:`jm_avs_cookie`
|
||||
- Komga 密码:`komga.password`
|
||||
- Komga API Key:`komga.api_key`
|
||||
- 真实代理地址如果不方便公开,也不要写入仓库文档
|
||||
|
||||
迁移 Codex 账号或迁移机器时,需要在 AstrBot WebUI 里重新填写这些值。
|
||||
|
||||
如果迁移的是 AstrBot 整体数据目录,可以检查 AstrBot 的插件配置存储位置;本插件仓库本身不保存运行时配置。
|
||||
|
||||
## 11. 安装到 AstrBot
|
||||
|
||||
推荐安装路径:
|
||||
|
||||
```text
|
||||
AstrBot/
|
||||
data/
|
||||
plugins/
|
||||
astrbot_plugin_jmdownload/
|
||||
```
|
||||
|
||||
使用 Git:
|
||||
|
||||
```bash
|
||||
cd AstrBot/data/plugins
|
||||
git clone <新的仓库地址> astrbot_plugin_jmdownload
|
||||
```
|
||||
|
||||
如果继续使用当前 Forgejo SSH alias:
|
||||
|
||||
```bash
|
||||
git clone ssh://forgejo-codex/YokiiroBW/astrbot_plugin_jmdowloads.git astrbot_plugin_jmdownload
|
||||
```
|
||||
|
||||
如果使用 HTTP:
|
||||
|
||||
```bash
|
||||
git clone http://192.168.31.210:18085/YokiiroBW/astrbot_plugin_jmdowloads.git astrbot_plugin_jmdownload
|
||||
```
|
||||
|
||||
安装依赖:
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
依赖列表:
|
||||
|
||||
```text
|
||||
jmcomic>=0.3.0
|
||||
PyYAML>=6.0
|
||||
Pillow>=9.0.0
|
||||
httpx>=0.27.0
|
||||
PyPDF2>=2.0.0
|
||||
```
|
||||
|
||||
然后在 AstrBot WebUI 中重载插件。
|
||||
|
||||
## 12. 迁移 Git 远端地址
|
||||
|
||||
如果只是迁移项目路径,不换仓库地址:
|
||||
|
||||
```powershell
|
||||
git clone ssh://forgejo-codex/YokiiroBW/astrbot_plugin_jmdowloads.git astrbot_plugin_jmdownload
|
||||
```
|
||||
|
||||
如果要迁移到新 Forgejo 仓库:
|
||||
|
||||
```powershell
|
||||
cd E:\Codex\JMDownload\astrbot_plugin_jmdownload
|
||||
git remote -v
|
||||
git remote set-url origin <新的仓库地址>
|
||||
git push origin HEAD:main
|
||||
git push origin --tags
|
||||
```
|
||||
|
||||
如果想保留旧远端并新增新远端:
|
||||
|
||||
```powershell
|
||||
git remote rename origin old-origin
|
||||
git remote add origin <新的仓库地址>
|
||||
git push origin HEAD:main
|
||||
git push origin --tags
|
||||
```
|
||||
|
||||
推荐推送分支时使用显式 ref:
|
||||
|
||||
```powershell
|
||||
git push origin HEAD:main
|
||||
```
|
||||
|
||||
之前 HTTP remote 曾出现凭据问题:
|
||||
|
||||
```text
|
||||
remote: 凭据不正确或已过期
|
||||
fatal: Authentication failed
|
||||
```
|
||||
|
||||
解决方式:
|
||||
|
||||
- 使用 SSH remote,例如 `ssh://forgejo-codex/...`
|
||||
- 或使用 Forgejo Personal Access Token 作为 HTTP 密码
|
||||
- 或清理 Windows Git Credential Manager 中旧凭据后重试
|
||||
|
||||
## 13. Codex 账号迁移注意事项
|
||||
|
||||
迁移 Codex 账号后,新账号通常不会继承旧账号的:
|
||||
|
||||
- 本地审批规则
|
||||
- SSH agent 状态
|
||||
- Forgejo SSH host alias
|
||||
- Git credential cache
|
||||
- Codex 线程上下文
|
||||
- 本地运行时缓存
|
||||
|
||||
建议新账号接手后先做:
|
||||
|
||||
```powershell
|
||||
cd <新的工作目录>\astrbot_plugin_jmdownload
|
||||
git status --short --branch
|
||||
git remote -v
|
||||
git log -1 --oneline --decorate
|
||||
git tag --points-at HEAD
|
||||
```
|
||||
|
||||
如果 remote 是:
|
||||
|
||||
```text
|
||||
ssh://forgejo-codex/YokiiroBW/astrbot_plugin_jmdowloads.git
|
||||
```
|
||||
|
||||
需要确认新系统或新账号的 SSH 配置里有 `forgejo-codex` host alias。否则可以改成明确地址,例如:
|
||||
|
||||
```powershell
|
||||
git remote set-url origin ssh://<user>@192.168.31.210:<ssh-port>/YokiiroBW/astrbot_plugin_jmdowloads.git
|
||||
```
|
||||
|
||||
具体 SSH 端口以 Forgejo 部署为准。如果不确定,先在旧账号里查看:
|
||||
|
||||
```powershell
|
||||
Get-Content $env:USERPROFILE\.ssh\config
|
||||
```
|
||||
|
||||
不要把私钥或 token 写入仓库。
|
||||
|
||||
## 14. 测试命令
|
||||
|
||||
当前使用 bundled Python 跑过测试:
|
||||
|
||||
```powershell
|
||||
& "C:\Users\Administrator\.cache\codex-runtimes\codex-primary-runtime\dependencies\python\python.exe" -m unittest discover -s tests
|
||||
```
|
||||
|
||||
也可以在正常 Python 环境中运行:
|
||||
|
||||
```bash
|
||||
python -m unittest discover -s tests
|
||||
```
|
||||
|
||||
当前测试数量:
|
||||
|
||||
```text
|
||||
22 tests
|
||||
```
|
||||
|
||||
额外检查:
|
||||
|
||||
```powershell
|
||||
python -c "import json, pathlib; json.loads(pathlib.Path('_conf_schema.json').read_text(encoding='utf-8')); print('json ok')"
|
||||
python -m compileall -q .
|
||||
```
|
||||
|
||||
注意:`compileall` 会生成 `__pycache__`,这些文件被 Git 忽略,不应提交。
|
||||
|
||||
## 15. 当前已知限制
|
||||
|
||||
- 默认启用白名单且白名单为空时,任何会话都会被拒绝,包括 `/jm status`。首次部署不知道 ID 时,临时关闭 `access_control.require_whitelist`。
|
||||
- `admin_only=true` 时,下载、扫描、清理仍要求 AstrBot 管理员身份;访问白名单通过后还要过管理员校验。
|
||||
- jmcomic 下载是同步库调用,超时后底层线程无法强杀,只能停止后续归档流程。
|
||||
- 部分平台不支持文件消息,`send_archive_file=true` 也可能发送失败,但归档仍会落盘。
|
||||
- PDF 归档只是兼容输出;Komga 推荐使用 CBZ。
|
||||
- jmcomic 域名、代理和登录状态可能受目标环境网络影响,迁移后要重新验证。
|
||||
- JM 账号密码登录依赖 jmcomic 的 `login` 插件行为;如果 `api` 不可用,可改 `jm_login.impl=html`。
|
||||
|
||||
## 16. 推荐迁移后验证流程
|
||||
|
||||
1. 克隆仓库或移动目录。
|
||||
2. 确认 `git status --short --branch` 干净。
|
||||
3. 安装依赖。
|
||||
4. 在 AstrBot WebUI 重载插件。
|
||||
5. 临时配置:
|
||||
|
||||
```text
|
||||
access_control.require_whitelist: false
|
||||
admin_only: false
|
||||
```
|
||||
|
||||
6. 在目标 OneBot v11 群聊或私聊执行:
|
||||
|
||||
```text
|
||||
/jm status
|
||||
```
|
||||
|
||||
7. 复制输出中的平台 ID、机器人自身 ID、群聊 ID、私聊/发送者 ID、UMO。
|
||||
8. 填入白名单。
|
||||
9. 恢复:
|
||||
|
||||
```text
|
||||
access_control.require_whitelist: true
|
||||
admin_only: true
|
||||
```
|
||||
|
||||
10. 配置 Komga:
|
||||
|
||||
```text
|
||||
archive_root
|
||||
komga.enabled
|
||||
komga.base_url
|
||||
komga.library_id
|
||||
komga.api_key
|
||||
```
|
||||
|
||||
11. 如果目标网络需要代理,配置:
|
||||
|
||||
```text
|
||||
jm_proxy.mode: custom
|
||||
jm_proxy.proxy_url: 127.0.0.1:7890
|
||||
```
|
||||
|
||||
12. 用一个小 JM ID 做真实下载测试。
|
||||
13. 确认归档文件落在 Komga library 根目录。
|
||||
14. 确认 Komga 自动扫描后能识别新书。
|
||||
|
||||
## 17. 后续开发建议
|
||||
|
||||
`docs/ROADMAP.md` 中还保留以下可推进项:
|
||||
|
||||
- 批量下载 `/jm batch`
|
||||
- 任务队列查看 `/jm queue`
|
||||
- 未开始任务取消 `/jm cancel <task_id>`
|
||||
- 更完整的 JM 元数据写入 `ComicInfo.xml`
|
||||
- Komga 健康检查 `/jm komga`
|
||||
- 按 JM ID 去重与重命名模板
|
||||
- 下载请求审计日志
|
||||
- 真实 AstrBot + OneBot v11 + Komga 环境联调
|
||||
|
||||
建议下一版优先做:
|
||||
|
||||
```text
|
||||
S-21 真实环境联调修正
|
||||
```
|
||||
|
||||
原因:S-18 到 S-20 已经引入代理、登录、访问控制,最好先在真实 AstrBot 会话中验证命令触发、ID 识别、jmcomic 下载和 Komga 扫描,再继续做批量任务系统。
|
||||
|
||||
## 18. 给新 Codex 会话的起始提示
|
||||
|
||||
迁移后可以把下面这段交给新的 Codex 会话:
|
||||
|
||||
```text
|
||||
当前项目是 AstrBot 插件 astrbot_plugin_jmdownload,仓库路径为 <你的新路径>\astrbot_plugin_jmdownload。
|
||||
请先阅读 docs/MIGRATION_HANDOFF.md、README.md、docs/DEPLOYMENT.md、docs/ROADMAP.md。
|
||||
当前最新功能基线应为 S-20 访问控制白名单黑名单,提交 b6144d7,TAG 为 S-20-访问控制白名单黑名单;如果 docs/MIGRATION_HANDOFF.md 已提交,则可能还有 S-21 迁移交接文档提交。
|
||||
开发规则:每个完成版本都要 commit、推送到 Forgejo,并使用中文 TAG。
|
||||
不要提交任何 JM 密码、AVS Cookie、Komga API Key 或本地代理敏感配置。
|
||||
下一步建议做真实 AstrBot + OneBot v11 + Komga 联调,或按用户新需求继续开发。
|
||||
```
|
||||
69
main.py
69
main.py
|
|
@ -9,6 +9,7 @@ import astrbot.api.message_components as Comp
|
|||
from astrbot.api.star import Context, Star, StarTools
|
||||
|
||||
from .services.archive import ArchiveResult, ArchiveService
|
||||
from .services.access import AccessControl, AccessDecision, EventIdentity
|
||||
from .services.download import DownloadProgress, JMDownloadService
|
||||
from .services.errors import JMDownloadError
|
||||
from .services.komga import KomgaClient, KomgaScanResult
|
||||
|
|
@ -25,6 +26,7 @@ class JMDownloadPlugin(Star):
|
|||
self.downloader = JMDownloadService(self.settings)
|
||||
self.archiver = ArchiveService(self.settings)
|
||||
self.komga = KomgaClient(self.settings.komga)
|
||||
self.access_control = AccessControl(self.settings.access_control)
|
||||
self.task_semaphore = asyncio.Semaphore(self.settings.max_concurrent_tasks)
|
||||
|
||||
async def initialize(self) -> None:
|
||||
|
|
@ -45,8 +47,10 @@ class JMDownloadPlugin(Star):
|
|||
@jm.command("download", alias={"下载"})
|
||||
async def download(self, event: AstrMessageEvent, comic_id: str):
|
||||
"""Download a JM album, archive it, and optionally ask Komga to scan."""
|
||||
if self._deny_non_admin(event):
|
||||
yield event.plain_result("JMDownload is admin-only in the current config.")
|
||||
deny_message = self._deny_request(event, require_admin=True)
|
||||
if deny_message is not None:
|
||||
if deny_message:
|
||||
yield event.plain_result(deny_message)
|
||||
event.stop_event()
|
||||
return
|
||||
|
||||
|
|
@ -89,6 +93,14 @@ class JMDownloadPlugin(Star):
|
|||
@jm.command("status")
|
||||
async def status(self, event: AstrMessageEvent):
|
||||
"""Show current JMDownload archive and Komga settings."""
|
||||
deny_message = self._deny_request(event, require_admin=False)
|
||||
if deny_message is not None:
|
||||
if deny_message:
|
||||
yield event.plain_result(deny_message)
|
||||
event.stop_event()
|
||||
return
|
||||
|
||||
identity = EventIdentity.from_event(event)
|
||||
lines = [
|
||||
"JMDownload 状态",
|
||||
f"归档目录:{self.settings.archive_root}",
|
||||
|
|
@ -97,6 +109,18 @@ class JMDownloadPlugin(Star):
|
|||
f"并发任务数:{self.settings.max_concurrent_tasks}",
|
||||
f"下载重试次数:{self.settings.download_retry_count}",
|
||||
f"进度提示间隔:{self.settings.progress_interval_seconds} 秒",
|
||||
f"访问控制:{'启用' if self.settings.access_control.enabled else '关闭'}",
|
||||
f"需要白名单:{self.settings.access_control.require_whitelist}",
|
||||
f"当前平台类型:{identity.platform_name or '未知'}",
|
||||
f"当前平台 ID:{identity.platform_id or '未知'}",
|
||||
f"当前机器人自身 ID:{identity.self_id or '未知'}",
|
||||
f"当前会话类型:{identity.message_type or '未知'}",
|
||||
f"当前群聊 ID:{identity.group_id or '无'}",
|
||||
f"当前私聊/发送者 ID:{identity.sender_id or '未知'}",
|
||||
f"当前 UMO:{identity.unified_msg_origin or '未知'}",
|
||||
f"JM 代理模式:{self.settings.jm_proxy.mode}",
|
||||
f"JM 账号登录:{'已启用' if self.settings.jm_login.can_login else '未配置'}",
|
||||
f"JM 登录 Cookie:{'已配置' if self.settings.jm_avs_cookie else '未配置'}",
|
||||
f"发送归档文件:{self.settings.send_archive_file}",
|
||||
f"临时目录保留:{self.settings.cleanup_retention_days} 天",
|
||||
f"Komga 自动扫描:{self.settings.komga.enabled}",
|
||||
|
|
@ -110,8 +134,10 @@ class JMDownloadPlugin(Star):
|
|||
@jm.command("scan")
|
||||
async def scan(self, event: AstrMessageEvent):
|
||||
"""Trigger a Komga scan for the configured library."""
|
||||
if self._deny_non_admin(event):
|
||||
yield event.plain_result("JMDownload is admin-only in the current config.")
|
||||
deny_message = self._deny_request(event, require_admin=True)
|
||||
if deny_message is not None:
|
||||
if deny_message:
|
||||
yield event.plain_result(deny_message)
|
||||
event.stop_event()
|
||||
return
|
||||
|
||||
|
|
@ -123,8 +149,10 @@ class JMDownloadPlugin(Star):
|
|||
@jm.command("cleanup")
|
||||
async def cleanup(self, event: AstrMessageEvent):
|
||||
"""Cleanup old JMDownload work directories."""
|
||||
if self._deny_non_admin(event):
|
||||
yield event.plain_result("JMDownload 当前配置仅允许管理员执行清理命令。")
|
||||
deny_message = self._deny_request(event, require_admin=True)
|
||||
if deny_message is not None:
|
||||
if deny_message:
|
||||
yield event.plain_result(deny_message)
|
||||
event.stop_event()
|
||||
return
|
||||
|
||||
|
|
@ -137,8 +165,33 @@ class JMDownloadPlugin(Star):
|
|||
yield event.plain_result(f"清理完成:删除 {removed} 个临时工作目录。")
|
||||
event.stop_event()
|
||||
|
||||
def _deny_non_admin(self, event: AstrMessageEvent) -> bool:
|
||||
return bool(self.settings.admin_only and not event.is_admin())
|
||||
def _deny_request(
|
||||
self,
|
||||
event: AstrMessageEvent,
|
||||
*,
|
||||
require_admin: bool,
|
||||
) -> str | None:
|
||||
decision = self.access_control.check(event)
|
||||
if not decision.allowed:
|
||||
self._log_access_denied(decision)
|
||||
return self.settings.access_control.deny_message
|
||||
if require_admin and self.settings.admin_only and not event.is_admin():
|
||||
return "JMDownload 当前配置仅允许 AstrBot 管理员执行此命令。"
|
||||
return None
|
||||
|
||||
def _log_access_denied(self, decision: AccessDecision) -> None:
|
||||
identity = decision.identity
|
||||
logger.info(
|
||||
"JMDownload access denied: "
|
||||
f"reason={decision.reason}, "
|
||||
f"platform_id={identity.platform_id}, "
|
||||
f"platform_name={identity.platform_name}, "
|
||||
f"self_id={identity.self_id}, "
|
||||
f"target_kind={identity.target_kind}, "
|
||||
f"target_id={identity.target_id}, "
|
||||
f"sender_id={identity.sender_id}, "
|
||||
f"umo={identity.unified_msg_origin}",
|
||||
)
|
||||
|
||||
def _format_success(
|
||||
self,
|
||||
|
|
|
|||
221
services/access.py
普通文件
221
services/access.py
普通文件
|
|
@ -0,0 +1,221 @@
|
|||
from __future__ import annotations
|
||||
|
||||
from dataclasses import dataclass
|
||||
from typing import Any
|
||||
|
||||
from .settings import AccessControlSettings
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class EventIdentity:
|
||||
platform_id: str
|
||||
platform_name: str
|
||||
message_type: str
|
||||
session_id: str
|
||||
unified_msg_origin: str
|
||||
self_id: str
|
||||
group_id: str
|
||||
sender_id: str
|
||||
is_private: bool
|
||||
|
||||
@classmethod
|
||||
def from_event(cls, event: Any) -> "EventIdentity":
|
||||
group_id = _call_string(event, "get_group_id")
|
||||
sender_id = _call_string(event, "get_sender_id")
|
||||
message_type = _message_type(event)
|
||||
is_private = _is_private(event, message_type, group_id)
|
||||
return cls(
|
||||
platform_id=_platform_id(event),
|
||||
platform_name=_platform_name(event),
|
||||
message_type=message_type,
|
||||
session_id=_session_id(event),
|
||||
unified_msg_origin=_unified_origin(event),
|
||||
self_id=_call_string(event, "get_self_id"),
|
||||
group_id=group_id,
|
||||
sender_id=sender_id,
|
||||
is_private=is_private,
|
||||
)
|
||||
|
||||
@property
|
||||
def target_kind(self) -> str:
|
||||
return "private" if self.is_private else "group"
|
||||
|
||||
@property
|
||||
def target_id(self) -> str:
|
||||
return self.sender_id if self.is_private else self.group_id
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class AccessDecision:
|
||||
allowed: bool
|
||||
reason: str
|
||||
identity: EventIdentity
|
||||
|
||||
|
||||
class AccessControl:
|
||||
def __init__(self, settings: AccessControlSettings) -> None:
|
||||
self.settings = settings
|
||||
|
||||
def check(self, event: Any) -> AccessDecision:
|
||||
identity = EventIdentity.from_event(event)
|
||||
if not self.settings.enabled:
|
||||
return AccessDecision(True, "access control disabled", identity)
|
||||
|
||||
if _contains(
|
||||
self.settings.deny_platform_ids,
|
||||
identity.platform_id,
|
||||
identity.platform_name,
|
||||
):
|
||||
return AccessDecision(False, "platform is blacklisted", identity)
|
||||
if _contains_scoped(
|
||||
self.settings.deny_self_ids,
|
||||
identity.self_id,
|
||||
identity.platform_id,
|
||||
identity.platform_name,
|
||||
):
|
||||
return AccessDecision(False, "self id is blacklisted", identity)
|
||||
if _contains_exact(self.settings.deny_unified_origins, identity.unified_msg_origin):
|
||||
return AccessDecision(False, "unified origin is blacklisted", identity)
|
||||
|
||||
if identity.is_private:
|
||||
if _contains_scoped(
|
||||
self.settings.deny_private_user_ids,
|
||||
identity.sender_id,
|
||||
identity.platform_id,
|
||||
identity.platform_name,
|
||||
):
|
||||
return AccessDecision(False, "private user is blacklisted", identity)
|
||||
elif _contains_scoped(
|
||||
self.settings.deny_group_ids,
|
||||
identity.group_id,
|
||||
identity.platform_id,
|
||||
identity.platform_name,
|
||||
):
|
||||
return AccessDecision(False, "group is blacklisted", identity)
|
||||
|
||||
if not self.settings.require_whitelist:
|
||||
return AccessDecision(True, "whitelist not required", identity)
|
||||
|
||||
if _contains(
|
||||
self.settings.allow_platform_ids,
|
||||
identity.platform_id,
|
||||
identity.platform_name,
|
||||
):
|
||||
return AccessDecision(True, "platform is whitelisted", identity)
|
||||
if _contains_scoped(
|
||||
self.settings.allow_self_ids,
|
||||
identity.self_id,
|
||||
identity.platform_id,
|
||||
identity.platform_name,
|
||||
):
|
||||
return AccessDecision(True, "self id is whitelisted", identity)
|
||||
if _contains_exact(self.settings.allow_unified_origins, identity.unified_msg_origin):
|
||||
return AccessDecision(True, "unified origin is whitelisted", identity)
|
||||
|
||||
if identity.is_private:
|
||||
if _contains_scoped(
|
||||
self.settings.allow_private_user_ids,
|
||||
identity.sender_id,
|
||||
identity.platform_id,
|
||||
identity.platform_name,
|
||||
):
|
||||
return AccessDecision(True, "private user is whitelisted", identity)
|
||||
elif _contains_scoped(
|
||||
self.settings.allow_group_ids,
|
||||
identity.group_id,
|
||||
identity.platform_id,
|
||||
identity.platform_name,
|
||||
):
|
||||
return AccessDecision(True, "group is whitelisted", identity)
|
||||
|
||||
return AccessDecision(False, "not in whitelist", identity)
|
||||
|
||||
|
||||
def _contains(values: list[str] | None, *candidates: str) -> bool:
|
||||
normalized_values = {value.strip() for value in values or [] if value.strip()}
|
||||
return any(candidate and candidate in normalized_values for candidate in candidates)
|
||||
|
||||
|
||||
def _contains_exact(values: list[str] | None, candidate: str) -> bool:
|
||||
normalized_values = {value.strip() for value in values or [] if value.strip()}
|
||||
return bool(candidate and candidate in normalized_values)
|
||||
|
||||
|
||||
def _contains_scoped(
|
||||
values: list[str] | None,
|
||||
raw_id: str,
|
||||
platform_id: str,
|
||||
platform_name: str,
|
||||
) -> bool:
|
||||
if not raw_id:
|
||||
return False
|
||||
candidates = {raw_id}
|
||||
if platform_id:
|
||||
candidates.add(f"{platform_id}:{raw_id}")
|
||||
if platform_name:
|
||||
candidates.add(f"{platform_name}:{raw_id}")
|
||||
return _contains(values, *candidates)
|
||||
|
||||
|
||||
def _call_string(event: Any, method_name: str) -> str:
|
||||
method = getattr(event, method_name, None)
|
||||
if not callable(method):
|
||||
return ""
|
||||
try:
|
||||
value = method()
|
||||
except Exception:
|
||||
return ""
|
||||
return _string_value(value)
|
||||
|
||||
|
||||
def _call_bool(event: Any, method_name: str) -> bool | None:
|
||||
method = getattr(event, method_name, None)
|
||||
if not callable(method):
|
||||
return None
|
||||
try:
|
||||
return bool(method())
|
||||
except Exception:
|
||||
return None
|
||||
|
||||
|
||||
def _string_value(value: Any) -> str:
|
||||
if value is None:
|
||||
return ""
|
||||
raw = getattr(value, "value", value)
|
||||
return str(raw).strip()
|
||||
|
||||
|
||||
def _message_type(event: Any) -> str:
|
||||
value = _call_string(event, "get_message_type")
|
||||
return value or _string_value(getattr(getattr(event, "session", None), "message_type", ""))
|
||||
|
||||
|
||||
def _session_id(event: Any) -> str:
|
||||
return (
|
||||
_call_string(event, "get_session_id")
|
||||
or _string_value(getattr(event, "session_id", ""))
|
||||
or _string_value(getattr(getattr(event, "session", None), "session_id", ""))
|
||||
)
|
||||
|
||||
|
||||
def _is_private(event: Any, message_type: str, group_id: str) -> bool:
|
||||
explicit = _call_bool(event, "is_private_chat")
|
||||
if explicit is not None:
|
||||
return explicit
|
||||
if message_type:
|
||||
return message_type == "FriendMessage"
|
||||
return not bool(group_id)
|
||||
|
||||
|
||||
def _unified_origin(event: Any) -> str:
|
||||
return _string_value(getattr(event, "unified_msg_origin", ""))
|
||||
|
||||
|
||||
def _platform_id(event: Any) -> str:
|
||||
return _call_string(event, "get_platform_id") or _string_value(
|
||||
getattr(getattr(event, "session", None), "platform_id", ""),
|
||||
)
|
||||
|
||||
|
||||
def _platform_name(event: Any) -> str:
|
||||
return _call_string(event, "get_platform_name")
|
||||
|
|
@ -158,7 +158,10 @@ class JMDownloadService:
|
|||
raise DownloadError("缺少 jmcomic 依赖,请检查插件 requirements.txt") from exc
|
||||
|
||||
logger.info(f"JMDownload: downloading album {comic_id} with {config_path}")
|
||||
option = jmcomic.create_option_by_file(str(config_path))
|
||||
try:
|
||||
option = jmcomic.create_option_by_file(str(config_path))
|
||||
finally:
|
||||
self._remove_sensitive_config(config_path)
|
||||
result = jmcomic.download_album(comic_id, option=option, check_exception=True)
|
||||
return self._extract_album_title(result)
|
||||
|
||||
|
|
@ -228,6 +231,14 @@ class JMDownloadService:
|
|||
return str(title).strip()
|
||||
|
||||
def _write_jmcomic_config(self, config_path: Path, download_dir: Path) -> None:
|
||||
config = self._build_jmcomic_config(download_dir)
|
||||
config_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
config_path.write_text(
|
||||
yaml.safe_dump(config, allow_unicode=True, sort_keys=False),
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
def _build_jmcomic_config(self, download_dir: Path) -> dict:
|
||||
config = {
|
||||
"version": "1.0",
|
||||
"dir_rule": {
|
||||
|
|
@ -248,8 +259,28 @@ class JMDownloadService:
|
|||
},
|
||||
},
|
||||
}
|
||||
config_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
config_path.write_text(
|
||||
yaml.safe_dump(config, allow_unicode=True, sort_keys=False),
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
meta_data = {}
|
||||
should_write_proxy, proxy_value = self.settings.jm_proxy.to_jmcomic_value()
|
||||
if should_write_proxy:
|
||||
meta_data["proxies"] = proxy_value
|
||||
if self.settings.jm_avs_cookie:
|
||||
meta_data["cookies"] = {"AVS": self.settings.jm_avs_cookie}
|
||||
if meta_data:
|
||||
config["client"]["postman"] = {"meta_data": meta_data}
|
||||
if self.settings.jm_login.can_login:
|
||||
config["plugins"] = {
|
||||
"after_init": [
|
||||
self.settings.jm_login.to_jmcomic_plugin(),
|
||||
],
|
||||
}
|
||||
|
||||
return config
|
||||
|
||||
def _remove_sensitive_config(self, config_path: Path) -> None:
|
||||
if not (self.settings.jm_avs_cookie or self.settings.jm_login.can_login):
|
||||
return
|
||||
try:
|
||||
config_path.unlink(missing_ok=True)
|
||||
except Exception as exc:
|
||||
logger.warning(f"JMDownload: failed to remove sensitive config {config_path}: {exc}")
|
||||
|
|
|
|||
|
|
@ -14,6 +14,83 @@ DEFAULT_JM_DOMAINS = [
|
|||
]
|
||||
|
||||
|
||||
def _list_value(value: Any) -> list[str]:
|
||||
if not isinstance(value, list):
|
||||
return []
|
||||
return [str(item).strip() for item in value if str(item).strip()]
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class JmProxySettings:
|
||||
mode: str = "inherit"
|
||||
proxy_url: str = ""
|
||||
http_proxy: str = ""
|
||||
https_proxy: str = ""
|
||||
|
||||
@classmethod
|
||||
def from_config(cls, config: dict[str, Any]) -> "JmProxySettings":
|
||||
mode = str(config.get("mode", "inherit")).strip().lower()
|
||||
if mode not in {"inherit", "none", "system", "clash", "v2ray", "custom"}:
|
||||
mode = "inherit"
|
||||
return cls(
|
||||
mode=mode,
|
||||
proxy_url=str(config.get("proxy_url", "")).strip(),
|
||||
http_proxy=str(config.get("http_proxy", "")).strip(),
|
||||
https_proxy=str(config.get("https_proxy", "")).strip(),
|
||||
)
|
||||
|
||||
def to_jmcomic_value(self) -> tuple[bool, str | dict[str, str] | None]:
|
||||
if self.mode == "inherit":
|
||||
return False, None
|
||||
if self.mode == "none":
|
||||
return True, None
|
||||
if self.mode in {"system", "clash", "v2ray"}:
|
||||
return True, self.mode
|
||||
|
||||
http_proxy = self.http_proxy or self.proxy_url
|
||||
https_proxy = self.https_proxy or self.proxy_url
|
||||
if http_proxy and https_proxy and http_proxy != https_proxy:
|
||||
return True, {"http": http_proxy, "https": https_proxy}
|
||||
proxy = http_proxy or https_proxy
|
||||
if not proxy:
|
||||
return False, None
|
||||
return True, proxy
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class JmLoginSettings:
|
||||
enabled: bool = False
|
||||
username: str = ""
|
||||
password: str = ""
|
||||
impl: str = "api"
|
||||
|
||||
@classmethod
|
||||
def from_config(cls, config: dict[str, Any]) -> "JmLoginSettings":
|
||||
impl = str(config.get("impl", "api")).strip().lower()
|
||||
if impl not in {"api", "html"}:
|
||||
impl = "api"
|
||||
return cls(
|
||||
enabled=bool(config.get("enabled", False)),
|
||||
username=str(config.get("username", "")).strip(),
|
||||
password=str(config.get("password", "")),
|
||||
impl=impl,
|
||||
)
|
||||
|
||||
@property
|
||||
def can_login(self) -> bool:
|
||||
return bool(self.enabled and self.username and self.password)
|
||||
|
||||
def to_jmcomic_plugin(self) -> dict:
|
||||
return {
|
||||
"plugin": "login",
|
||||
"kwargs": {
|
||||
"username": self.username,
|
||||
"password": self.password,
|
||||
"impl": self.impl,
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class KomgaSettings:
|
||||
enabled: bool = False
|
||||
|
|
@ -45,6 +122,41 @@ class KomgaSettings:
|
|||
return bool(self.enabled and self.base_url and self.library_id and has_auth)
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class AccessControlSettings:
|
||||
enabled: bool = True
|
||||
require_whitelist: bool = True
|
||||
allow_platform_ids: list[str] | None = None
|
||||
allow_self_ids: list[str] | None = None
|
||||
allow_group_ids: list[str] | None = None
|
||||
allow_private_user_ids: list[str] | None = None
|
||||
allow_unified_origins: list[str] | None = None
|
||||
deny_platform_ids: list[str] | None = None
|
||||
deny_self_ids: list[str] | None = None
|
||||
deny_group_ids: list[str] | None = None
|
||||
deny_private_user_ids: list[str] | None = None
|
||||
deny_unified_origins: list[str] | None = None
|
||||
deny_message: str = ""
|
||||
|
||||
@classmethod
|
||||
def from_config(cls, config: dict[str, Any]) -> "AccessControlSettings":
|
||||
return cls(
|
||||
enabled=bool(config.get("enabled", True)),
|
||||
require_whitelist=bool(config.get("require_whitelist", True)),
|
||||
allow_platform_ids=_list_value(config.get("allow_platform_ids", [])),
|
||||
allow_self_ids=_list_value(config.get("allow_self_ids", [])),
|
||||
allow_group_ids=_list_value(config.get("allow_group_ids", [])),
|
||||
allow_private_user_ids=_list_value(config.get("allow_private_user_ids", [])),
|
||||
allow_unified_origins=_list_value(config.get("allow_unified_origins", [])),
|
||||
deny_platform_ids=_list_value(config.get("deny_platform_ids", [])),
|
||||
deny_self_ids=_list_value(config.get("deny_self_ids", [])),
|
||||
deny_group_ids=_list_value(config.get("deny_group_ids", [])),
|
||||
deny_private_user_ids=_list_value(config.get("deny_private_user_ids", [])),
|
||||
deny_unified_origins=_list_value(config.get("deny_unified_origins", [])),
|
||||
deny_message=str(config.get("deny_message", "")).strip(),
|
||||
)
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class PluginSettings:
|
||||
data_dir: Path
|
||||
|
|
@ -62,6 +174,10 @@ class PluginSettings:
|
|||
progress_interval_seconds: int = 30
|
||||
max_concurrent_tasks: int = 1
|
||||
jm_batch_count: int = 20
|
||||
access_control: AccessControlSettings = AccessControlSettings()
|
||||
jm_proxy: JmProxySettings = JmProxySettings()
|
||||
jm_login: JmLoginSettings = JmLoginSettings()
|
||||
jm_avs_cookie: str = ""
|
||||
jm_domains: list[str] | None = None
|
||||
komga: KomgaSettings = KomgaSettings()
|
||||
|
||||
|
|
@ -82,6 +198,18 @@ class PluginSettings:
|
|||
if not isinstance(jm_domains, list) or not jm_domains:
|
||||
jm_domains = DEFAULT_JM_DOMAINS
|
||||
|
||||
jm_proxy_config = config.get("jm_proxy", {})
|
||||
if not isinstance(jm_proxy_config, dict):
|
||||
jm_proxy_config = {}
|
||||
|
||||
jm_login_config = config.get("jm_login", {})
|
||||
if not isinstance(jm_login_config, dict):
|
||||
jm_login_config = {}
|
||||
|
||||
access_control_config = config.get("access_control", {})
|
||||
if not isinstance(access_control_config, dict):
|
||||
access_control_config = {}
|
||||
|
||||
komga_config = config.get("komga", {})
|
||||
if not isinstance(komga_config, dict):
|
||||
komga_config = {}
|
||||
|
|
@ -119,6 +247,10 @@ class PluginSettings:
|
|||
_int_value(config.get("max_concurrent_tasks"), 1),
|
||||
),
|
||||
jm_batch_count=max(1, _int_value(config.get("jm_batch_count"), 20)),
|
||||
access_control=AccessControlSettings.from_config(access_control_config),
|
||||
jm_proxy=JmProxySettings.from_config(jm_proxy_config),
|
||||
jm_login=JmLoginSettings.from_config(jm_login_config),
|
||||
jm_avs_cookie=str(config.get("jm_avs_cookie", "")).strip(),
|
||||
jm_domains=[str(domain).strip() for domain in jm_domains if str(domain).strip()],
|
||||
komga=KomgaSettings.from_config(komga_config),
|
||||
)
|
||||
|
|
|
|||
147
tests/test_access_control.py
普通文件
147
tests/test_access_control.py
普通文件
|
|
@ -0,0 +1,147 @@
|
|||
from __future__ import annotations
|
||||
|
||||
import unittest
|
||||
|
||||
from services.access import AccessControl, EventIdentity
|
||||
from services.settings import AccessControlSettings
|
||||
|
||||
|
||||
class FakeEvent:
|
||||
def __init__(
|
||||
self,
|
||||
*,
|
||||
platform_id: str = "aiocqhttp",
|
||||
platform_name: str = "aiocqhttp",
|
||||
self_id: str = "30003",
|
||||
message_type: str = "GroupMessage",
|
||||
group_id: str = "10001",
|
||||
sender_id: str = "20002",
|
||||
) -> None:
|
||||
self._platform_id = platform_id
|
||||
self._platform_name = platform_name
|
||||
self._self_id = self_id
|
||||
self._message_type = message_type
|
||||
self._group_id = group_id
|
||||
self._sender_id = sender_id
|
||||
self.session_id = sender_id if message_type == "FriendMessage" else group_id
|
||||
self.unified_msg_origin = f"{platform_id}:{message_type}:{self.session_id}"
|
||||
|
||||
def get_platform_id(self) -> str:
|
||||
return self._platform_id
|
||||
|
||||
def get_platform_name(self) -> str:
|
||||
return self._platform_name
|
||||
|
||||
def get_message_type(self) -> str:
|
||||
return self._message_type
|
||||
|
||||
def get_self_id(self) -> str:
|
||||
return self._self_id
|
||||
|
||||
def get_session_id(self) -> str:
|
||||
return self.session_id
|
||||
|
||||
def get_group_id(self) -> str:
|
||||
return self._group_id
|
||||
|
||||
def get_sender_id(self) -> str:
|
||||
return self._sender_id
|
||||
|
||||
def is_private_chat(self) -> bool:
|
||||
return self._message_type == "FriendMessage"
|
||||
|
||||
|
||||
class AccessControlTest(unittest.TestCase):
|
||||
def test_default_requires_whitelist(self) -> None:
|
||||
decision = AccessControl(AccessControlSettings()).check(FakeEvent())
|
||||
|
||||
self.assertFalse(decision.allowed)
|
||||
self.assertEqual(decision.reason, "not in whitelist")
|
||||
|
||||
def test_group_whitelist_allows_onebot_group_id(self) -> None:
|
||||
decision = AccessControl(
|
||||
AccessControlSettings(allow_group_ids=["10001"]),
|
||||
).check(FakeEvent())
|
||||
|
||||
self.assertTrue(decision.allowed)
|
||||
self.assertEqual(decision.reason, "group is whitelisted")
|
||||
|
||||
def test_platform_scoped_group_whitelist(self) -> None:
|
||||
settings = AccessControlSettings(allow_group_ids=["bot-qq:10001"])
|
||||
|
||||
allowed = AccessControl(settings).check(FakeEvent(platform_id="bot-qq"))
|
||||
denied = AccessControl(settings).check(FakeEvent(platform_id="other-qq"))
|
||||
|
||||
self.assertTrue(allowed.allowed)
|
||||
self.assertFalse(denied.allowed)
|
||||
|
||||
def test_private_whitelist_allows_onebot_user_id(self) -> None:
|
||||
event = FakeEvent(message_type="FriendMessage", group_id="", sender_id="20002")
|
||||
decision = AccessControl(
|
||||
AccessControlSettings(allow_private_user_ids=["20002"]),
|
||||
).check(event)
|
||||
|
||||
self.assertTrue(decision.allowed)
|
||||
self.assertEqual(decision.identity.target_kind, "private")
|
||||
self.assertEqual(decision.identity.target_id, "20002")
|
||||
|
||||
def test_blacklist_overrides_whitelist(self) -> None:
|
||||
settings = AccessControlSettings(
|
||||
allow_group_ids=["10001"],
|
||||
deny_group_ids=["10001"],
|
||||
)
|
||||
decision = AccessControl(settings).check(FakeEvent())
|
||||
|
||||
self.assertFalse(decision.allowed)
|
||||
self.assertEqual(decision.reason, "group is blacklisted")
|
||||
|
||||
def test_platform_whitelist_allows_any_session_on_platform(self) -> None:
|
||||
event = FakeEvent(platform_id="qq-main", group_id="999")
|
||||
decision = AccessControl(
|
||||
AccessControlSettings(allow_platform_ids=["qq-main"]),
|
||||
).check(event)
|
||||
|
||||
self.assertTrue(decision.allowed)
|
||||
self.assertEqual(decision.reason, "platform is whitelisted")
|
||||
|
||||
def test_self_id_whitelist_allows_any_session_for_bot_account(self) -> None:
|
||||
event = FakeEvent(platform_id="qq-main", self_id="30003", group_id="999")
|
||||
decision = AccessControl(
|
||||
AccessControlSettings(allow_self_ids=["qq-main:30003"]),
|
||||
).check(event)
|
||||
|
||||
self.assertTrue(decision.allowed)
|
||||
self.assertEqual(decision.reason, "self id is whitelisted")
|
||||
|
||||
def test_self_id_blacklist_overrides_group_whitelist(self) -> None:
|
||||
settings = AccessControlSettings(
|
||||
allow_group_ids=["10001"],
|
||||
deny_self_ids=["30003"],
|
||||
)
|
||||
decision = AccessControl(settings).check(FakeEvent(self_id="30003"))
|
||||
|
||||
self.assertFalse(decision.allowed)
|
||||
self.assertEqual(decision.reason, "self id is blacklisted")
|
||||
|
||||
def test_unified_origin_can_be_whitelisted(self) -> None:
|
||||
event = FakeEvent(platform_id="qq-main", group_id="10001")
|
||||
decision = AccessControl(
|
||||
AccessControlSettings(allow_unified_origins=["qq-main:GroupMessage:10001"]),
|
||||
).check(event)
|
||||
|
||||
self.assertTrue(decision.allowed)
|
||||
|
||||
def test_identity_extracts_astrbot_ids(self) -> None:
|
||||
event = FakeEvent(platform_id="qq-main", platform_name="aiocqhttp")
|
||||
identity = EventIdentity.from_event(event)
|
||||
|
||||
self.assertEqual(identity.platform_id, "qq-main")
|
||||
self.assertEqual(identity.platform_name, "aiocqhttp")
|
||||
self.assertEqual(identity.self_id, "30003")
|
||||
self.assertEqual(identity.group_id, "10001")
|
||||
self.assertEqual(identity.sender_id, "20002")
|
||||
self.assertEqual(identity.unified_msg_origin, "qq-main:GroupMessage:10001")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
134
tests/test_jmcomic_config.py
普通文件
134
tests/test_jmcomic_config.py
普通文件
|
|
@ -0,0 +1,134 @@
|
|||
from __future__ import annotations
|
||||
|
||||
import sys
|
||||
import tempfile
|
||||
import types
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
|
||||
from tests.helpers import install_runtime_stubs
|
||||
|
||||
install_runtime_stubs()
|
||||
|
||||
from services.download import JMDownloadService # noqa: E402
|
||||
from services.settings import JmProxySettings, PluginSettings # noqa: E402
|
||||
|
||||
|
||||
class JmComicConfigTest(unittest.TestCase):
|
||||
def test_default_proxy_is_not_written(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as temp_dir:
|
||||
settings = PluginSettings.from_config({}, Path(temp_dir) / "data")
|
||||
config = JMDownloadService(settings)._build_jmcomic_config(Path(temp_dir) / "downloads")
|
||||
|
||||
self.assertNotIn("postman", config["client"])
|
||||
|
||||
def test_proxy_modes_convert_to_jmcomic_values(self) -> None:
|
||||
self.assertEqual(JmProxySettings(mode="none").to_jmcomic_value(), (True, None))
|
||||
self.assertEqual(JmProxySettings(mode="system").to_jmcomic_value(), (True, "system"))
|
||||
self.assertEqual(JmProxySettings(mode="clash").to_jmcomic_value(), (True, "clash"))
|
||||
self.assertEqual(JmProxySettings(mode="v2ray").to_jmcomic_value(), (True, "v2ray"))
|
||||
self.assertEqual(JmProxySettings(mode="custom").to_jmcomic_value(), (False, None))
|
||||
self.assertEqual(
|
||||
JmProxySettings(mode="custom", proxy_url="127.0.0.1:7890").to_jmcomic_value(),
|
||||
(True, "127.0.0.1:7890"),
|
||||
)
|
||||
self.assertEqual(
|
||||
JmProxySettings(
|
||||
mode="custom",
|
||||
http_proxy="http://127.0.0.1:7890",
|
||||
https_proxy="http://127.0.0.1:7891",
|
||||
).to_jmcomic_value(),
|
||||
(
|
||||
True,
|
||||
{
|
||||
"http": "http://127.0.0.1:7890",
|
||||
"https": "http://127.0.0.1:7891",
|
||||
},
|
||||
),
|
||||
)
|
||||
|
||||
def test_proxy_and_avs_cookie_are_written_to_postman_metadata(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as temp_dir:
|
||||
settings = PluginSettings.from_config(
|
||||
{
|
||||
"jm_proxy": {"mode": "custom", "proxy_url": "127.0.0.1:7890"},
|
||||
"jm_avs_cookie": "avs-token",
|
||||
},
|
||||
Path(temp_dir) / "data",
|
||||
)
|
||||
config = JMDownloadService(settings)._build_jmcomic_config(Path(temp_dir) / "downloads")
|
||||
|
||||
meta_data = config["client"]["postman"]["meta_data"]
|
||||
self.assertEqual(meta_data["proxies"], "127.0.0.1:7890")
|
||||
self.assertEqual(meta_data["cookies"], {"AVS": "avs-token"})
|
||||
|
||||
def test_account_login_is_written_as_after_init_plugin(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as temp_dir:
|
||||
settings = PluginSettings.from_config(
|
||||
{
|
||||
"jm_login": {
|
||||
"enabled": True,
|
||||
"username": "user",
|
||||
"password": "pass",
|
||||
"impl": "html",
|
||||
},
|
||||
},
|
||||
Path(temp_dir) / "data",
|
||||
)
|
||||
config = JMDownloadService(settings)._build_jmcomic_config(Path(temp_dir) / "downloads")
|
||||
|
||||
login_plugin = config["plugins"]["after_init"][0]
|
||||
self.assertEqual(login_plugin["plugin"], "login")
|
||||
self.assertEqual(
|
||||
login_plugin["kwargs"],
|
||||
{"username": "user", "password": "pass", "impl": "html"},
|
||||
)
|
||||
|
||||
def test_sensitive_config_is_removed_after_option_load(self) -> None:
|
||||
with tempfile.TemporaryDirectory() as temp_dir:
|
||||
config_path = Path(temp_dir) / "jmcomic.yml"
|
||||
config_path.write_text("secret", encoding="utf-8")
|
||||
settings = PluginSettings.from_config(
|
||||
{
|
||||
"jm_login": {
|
||||
"enabled": True,
|
||||
"username": "user",
|
||||
"password": "pass",
|
||||
},
|
||||
},
|
||||
Path(temp_dir) / "data",
|
||||
)
|
||||
service = JMDownloadService(settings)
|
||||
old_jmcomic = sys.modules.get("jmcomic")
|
||||
fake_jmcomic = types.ModuleType("jmcomic")
|
||||
|
||||
class Album:
|
||||
title = "Title"
|
||||
|
||||
class Result:
|
||||
album = Album()
|
||||
|
||||
def create_option_by_file(path: str) -> object:
|
||||
self.assertTrue(Path(path).exists())
|
||||
return object()
|
||||
|
||||
def download_album(comic_id: str, option: object, check_exception: bool) -> Result:
|
||||
self.assertEqual(comic_id, "123456")
|
||||
self.assertTrue(check_exception)
|
||||
self.assertFalse(config_path.exists())
|
||||
return Result()
|
||||
|
||||
fake_jmcomic.create_option_by_file = create_option_by_file
|
||||
fake_jmcomic.download_album = download_album
|
||||
sys.modules["jmcomic"] = fake_jmcomic
|
||||
try:
|
||||
self.assertEqual(service._download_sync("123456", config_path), "Title")
|
||||
finally:
|
||||
if old_jmcomic is None:
|
||||
sys.modules.pop("jmcomic", None)
|
||||
else:
|
||||
sys.modules["jmcomic"] = old_jmcomic
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
|
|
@ -26,6 +26,8 @@ class SettingsTest(unittest.TestCase):
|
|||
self.assertEqual(settings.download_timeout_seconds, 3600)
|
||||
self.assertEqual(settings.jm_batch_count, 20)
|
||||
self.assertEqual(settings.komga.scan_timeout_seconds, 30)
|
||||
self.assertTrue(settings.access_control.enabled)
|
||||
self.assertTrue(settings.access_control.require_whitelist)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
|
|
|||
正在加载…
添加表格
在新工单中引用