diff --git a/README.md b/README.md index 3648bb2..b419fd0 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,8 @@ 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` 的值。 +- 账号登录:默认不需要。少部分敏感题材可能需要登录,此时可启用 `jm_login.enabled` 并填写 `jm_login.username` / `jm_login.password`,插件会调用 jmcomic 的 `login` 插件自动获取 Cookie。 +- 手动 Cookie:如果不想保存账号密码,也可以填写 `jm_avs_cookie`,只填浏览器 Cookie 中 `AVS` 的值。 ## 测试 diff --git a/_conf_schema.json b/_conf_schema.json index 50f37b9..109114d 100644 --- a/_conf_schema.json +++ b/_conf_schema.json @@ -92,6 +92,34 @@ } } }, + "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", diff --git a/docs/DEPLOYMENT.md b/docs/DEPLOYMENT.md index 0487348..a82336b 100644 --- a/docs/DEPLOYMENT.md +++ b/docs/DEPLOYMENT.md @@ -112,7 +112,26 @@ jm_proxy.http_proxy: 127.0.0.1:7890 jm_proxy.https_proxy: 127.0.0.1:7890 ``` -JM 下载大部分本子不需要登录。少部分敏感题材可能需要登录态,此时只需要配置 `jm_avs_cookie`,填写浏览器 Cookie 中 `AVS` 的值即可。 +JM 下载大部分本子不需要登录。少部分敏感题材可能需要登录态,可以选择账号密码登录或手动 Cookie。 + +账号密码登录: + +```text +jm_login.enabled: true +jm_login.username: +jm_login.password: +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 来源域名一致。 @@ -131,7 +150,7 @@ JM 下载大部分本子不需要登录。少部分敏感题材可能需要登 - 插件无法加载:检查 `requirements.txt` 是否安装成功。 - 下载后没有文件:检查 `jm_domains` 是否可用,或降低 `jm_batch_count`。 - 代理未生效:检查 `jm_proxy.mode`,custom 模式下确认代理端口可用。 -- 登录后仍不可下载:确认 `jm_avs_cookie` 来自当前实际访问的 JM 域名。 +- 登录后仍不可下载:账号密码方式可切换 `jm_login.impl` 为 `html` 试试;手动 Cookie 方式需确认 `jm_avs_cookie` 来自当前实际访问的 JM 域名。 - Komga 没有识别:确认 `archive_root` 是 Komga library 根目录,并手动执行 `/jm scan`。 - 文件发送失败:不同平台对文件消息支持不同;归档仍会保存在 `archive_root`。 - PDF 转换失败:确认 `PyPDF2` 已安装,或改用默认 `cbz`。 diff --git a/main.py b/main.py index 93ebc26..7c4cf7b 100644 --- a/main.py +++ b/main.py @@ -98,6 +98,7 @@ class JMDownloadPlugin(Star): f"下载重试次数:{self.settings.download_retry_count}", f"进度提示间隔:{self.settings.progress_interval_seconds} 秒", 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} 天", diff --git a/services/download.py b/services/download.py index a6f2127..256a8a9 100644 --- a/services/download.py +++ b/services/download.py @@ -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) @@ -265,5 +268,19 @@ class JMDownloadService: 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}") diff --git a/services/settings.py b/services/settings.py index 2b4443e..56859f9 100644 --- a/services/settings.py +++ b/services/settings.py @@ -51,6 +51,40 @@ class JmProxySettings: 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 @@ -100,6 +134,7 @@ class PluginSettings: max_concurrent_tasks: int = 1 jm_batch_count: int = 20 jm_proxy: JmProxySettings = JmProxySettings() + jm_login: JmLoginSettings = JmLoginSettings() jm_avs_cookie: str = "" jm_domains: list[str] | None = None komga: KomgaSettings = KomgaSettings() @@ -125,6 +160,10 @@ class PluginSettings: 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 = {} + komga_config = config.get("komga", {}) if not isinstance(komga_config, dict): komga_config = {} @@ -163,6 +202,7 @@ class PluginSettings: ), jm_batch_count=max(1, _int_value(config.get("jm_batch_count"), 20)), 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), diff --git a/tests/test_jmcomic_config.py b/tests/test_jmcomic_config.py index b6025a1..5444ef3 100644 --- a/tests/test_jmcomic_config.py +++ b/tests/test_jmcomic_config.py @@ -1,6 +1,8 @@ from __future__ import annotations +import sys import tempfile +import types import unittest from pathlib import Path @@ -60,6 +62,73 @@ class JmComicConfigTest(unittest.TestCase): 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()