From ed72d9934dc15901617e9c4431faa4a32e320521 Mon Sep 17 00:00:00 2001 From: Codex Date: Tue, 7 Jul 2026 00:55:08 +0800 Subject: [PATCH] =?UTF-8?q?S-18=20JM=20=E4=BB=A3=E7=90=86=E4=B8=8E?= =?UTF-8?q?=E7=99=BB=E5=BD=95=E9=85=8D=E7=BD=AE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 6 ++++ _conf_schema.json | 33 ++++++++++++++++++ docs/DEPLOYMENT.md | 46 +++++++++++++++++++++++-- main.py | 2 ++ services/download.py | 24 ++++++++++--- services/settings.py | 45 +++++++++++++++++++++++++ tests/test_jmcomic_config.py | 65 ++++++++++++++++++++++++++++++++++++ 7 files changed, 213 insertions(+), 8 deletions(-) create mode 100644 tests/test_jmcomic_config.py diff --git a/README.md b/README.md index 78a0704..3648bb2 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,12 @@ 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_avs_cookie`,只填浏览器 Cookie 中 `AVS` 的值。 + ## 测试 ```bash diff --git a/_conf_schema.json b/_conf_schema.json index cfeb0f1..50f37b9 100644 --- a/_conf_schema.json +++ b/_conf_schema.json @@ -65,6 +65,39 @@ "type": "int", "default": 20 }, + "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_avs_cookie": { + "description": "可选 JM 登录 Cookie,只填写 AVS 的值。大部分本子不需要登录,敏感题材可能需要。", + "type": "string", + "default": "", + "invisible": true + }, "jm_domains": { "description": "jmcomic 域名列表,按优先级排序。", "type": "list", diff --git a/docs/DEPLOYMENT.md b/docs/DEPLOYMENT.md index fc6fdcf..0487348 100644 --- a/docs/DEPLOYMENT.md +++ b/docs/DEPLOYMENT.md @@ -78,7 +78,45 @@ komga.password POST /api/v1/libraries/{libraryId}/scan ``` -## 4. 命令 +## 4. 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 下载大部分本子不需要登录。少部分敏感题材可能需要登录态,此时只需要配置 `jm_avs_cookie`,填写浏览器 Cookie 中 `AVS` 的值即可。 + +注意:AVS Cookie 和访问域名有关,使用的 JM 域名要和 Cookie 来源域名一致。 + +## 5. 命令 ```text /jm download @@ -88,15 +126,17 @@ POST /api/v1/libraries/{libraryId}/scan /jm cleanup ``` -## 5. 故障排查 +## 6. 故障排查 - 插件无法加载:检查 `requirements.txt` 是否安装成功。 - 下载后没有文件:检查 `jm_domains` 是否可用,或降低 `jm_batch_count`。 +- 代理未生效:检查 `jm_proxy.mode`,custom 模式下确认代理端口可用。 +- 登录后仍不可下载:确认 `jm_avs_cookie` 来自当前实际访问的 JM 域名。 - Komga 没有识别:确认 `archive_root` 是 Komga library 根目录,并手动执行 `/jm scan`。 - 文件发送失败:不同平台对文件消息支持不同;归档仍会保存在 `archive_root`。 - PDF 转换失败:确认 `PyPDF2` 已安装,或改用默认 `cbz`。 -## 6. 本地测试 +## 7. 本地测试 ```bash python -m unittest discover -s tests diff --git a/main.py b/main.py index 2a77bad..93ebc26 100644 --- a/main.py +++ b/main.py @@ -97,6 +97,8 @@ class JMDownloadPlugin(Star): f"并发任务数:{self.settings.max_concurrent_tasks}", f"下载重试次数:{self.settings.download_retry_count}", f"进度提示间隔:{self.settings.progress_interval_seconds} 秒", + f"JM 代理模式:{self.settings.jm_proxy.mode}", + 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}", diff --git a/services/download.py b/services/download.py index dee9817..a6f2127 100644 --- a/services/download.py +++ b/services/download.py @@ -228,6 +228,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 +256,14 @@ 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} + + return config diff --git a/services/settings.py b/services/settings.py index 2d9c3de..2b4443e 100644 --- a/services/settings.py +++ b/services/settings.py @@ -14,6 +14,43 @@ DEFAULT_JM_DOMAINS = [ ] +@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 KomgaSettings: enabled: bool = False @@ -62,6 +99,8 @@ class PluginSettings: progress_interval_seconds: int = 30 max_concurrent_tasks: int = 1 jm_batch_count: int = 20 + jm_proxy: JmProxySettings = JmProxySettings() + jm_avs_cookie: str = "" jm_domains: list[str] | None = None komga: KomgaSettings = KomgaSettings() @@ -82,6 +121,10 @@ 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 = {} + komga_config = config.get("komga", {}) if not isinstance(komga_config, dict): komga_config = {} @@ -119,6 +162,8 @@ class PluginSettings: _int_value(config.get("max_concurrent_tasks"), 1), ), jm_batch_count=max(1, _int_value(config.get("jm_batch_count"), 20)), + jm_proxy=JmProxySettings.from_config(jm_proxy_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), ) diff --git a/tests/test_jmcomic_config.py b/tests/test_jmcomic_config.py new file mode 100644 index 0000000..b6025a1 --- /dev/null +++ b/tests/test_jmcomic_config.py @@ -0,0 +1,65 @@ +from __future__ import annotations + +import tempfile +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"}) + + +if __name__ == "__main__": + unittest.main()