From c37949869647bad28ff897fec7084665c3f38f46 Mon Sep 17 00:00:00 2001
From: check <137591557+yifenliwu@users.noreply.github.com>
Date: Fri, 11 Sep 2026 15:18:41 +0800
Subject: [PATCH 01/14] =?UTF-8?q?feat(plugin):=20=E6=96=B0=E5=A2=9E=20cali?=
=?UTF-8?q?bre=5Fmetadata=20=E6=8F=92=E4=BB=B6=EF=BC=8C=E4=B8=BA=20Calibre?=
=?UTF-8?q?=20=E7=94=A8=E6=88=B7=E7=94=9F=E6=88=90=20metadata.opf=20(#576)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
src/jmcomic/jm_plugin.py | 114 +++++++++++++++++++++++++++
tests/test_jmcomic/test_jm_plugin.py | 108 +++++++++++++++++++++++++
2 files changed, 222 insertions(+)
diff --git a/src/jmcomic/jm_plugin.py b/src/jmcomic/jm_plugin.py
index 203036776..b99479368 100644
--- a/src/jmcomic/jm_plugin.py
+++ b/src/jmcomic/jm_plugin.py
@@ -1846,3 +1846,117 @@ def invoke(self,
self.log(f'album-{album_id}的封面已存在，跳过下载: [{save_path}]', 'skip')
return
downloader.client.download_album_cover(album_id, save_path, size)
+
+
+class CalibreMetadataPlugin(JmOptionPlugin):
+ """
+ 功能：为本子生成 Calibre 可识别的元数据文件 metadata.opf。
+
+ 通常挂在 after_album 上，每个本子在其目录下生成一份 metadata.opf，
+ Calibre 导入（从 OPF 读元数据）时可以自动带上书名、作者、标签、简介和封面。
+
+ 配置示例：
+
+ ```yml
+ plugins:
+ after_album:
+ - plugin: calibre_metadata
+ kwargs:
+ dir_rule:
+ rule: "Bd/Aid/metadata.opf"
+ base_dir: "./"
+ include_cover: true
+ fields: # 追加静态字段
+ language: "zh"
+ ```
+
+ 说明：
+ - identifier 固定写为 jmcomic:{album_id}，可在 Calibre 中反查回禁漫的 album_id
+ - fields 中的 title/author 可覆盖默认取值，其余键值对须为 Dublin Core 元素名（如 language/publisher/date），按 dc:{key} 写入，不支持的键会忽略并告警
+ - include_cover 依赖 downloader（after_album 阶段自动传入）
+ """
+ plugin_key = 'calibre_metadata'
+
+ # fields 允许的 Dublin Core 元素名（核心15元素），避免非法元素名生成无效 XML
+ DUBLIN_CORE_ELEMENTS = frozenset({
+ 'title', 'creator', 'subject', 'description', 'publisher', 'contributor',
+ 'date', 'type', 'format', 'identifier', 'source', 'language', 'relation',
+ 'coverage', 'rights',
+ })
+
+ def invoke(self,
+ dir_rule: dict,
+ album: JmAlbumDetail = None,
+ photo: JmPhotoDetail = None,
+ downloader=None,
+ include_cover=False,
+ fields=None,
+ **kwargs) -> None:
+ from xml.sax.saxutils import escape
+
+ self.require_param(album, '本插件需在after_album阶段使用，需要album参数')
+ opf_path = self.decide_filepath(album, photo, None, None, None, dir_rule)
+ opf_dir = os.path.dirname(opf_path)
+
+ fields = dict(fields or {})
+
+ # 标题与作者，允许通过 fields 覆盖；作者为空时由 album.author 兜底为 DEFAULT_AUTHOR
+ title = str(fields.pop('title', album.title))
+ author = str(fields.pop('author', album.author))
+
+ # 封面：与 metadata.opf 同目录存放 cover.jpg，并在 OPF 中引用
+ cover_line = ''
+ manifest_line = ''
+ if include_cover:
+ cover_path = os.path.join(opf_dir, 'cover.jpg')
+ self.download_cover_if_needed(album.id, cover_path, downloader)
+ manifest_line = (
+ ' \n'
+ ' ]*?id="total_video_comments">(\d+)
'), 0
+ # 是否已收藏 (HTML端通过主本子收藏按钮带有 btn-primary 判定)
+ pattern_html_album_is_favorite = compile(
+ r']*?(id="album_favorite_\d+"[^>]*?class="[^"]*?'
+ r'\bbtn-primary\b|class="[^"]*?\bbtn-primary\b[^>]*?id="album_favorite_\d+)[^>]*?>'), False
+ # 是否已点赞/喜欢 (HTML端通过顶栏爱心按钮带有 style="color:red" 判定)
+ pattern_html_album_liked = compile(
+ r'id=[\'"]love_likes_\d+[\'"][^>]*>\s*]+style=[\'"][^\'"]*color:\s*(red)[^\'"]*[\'"]'), False
# 提取接口返回值信息
pattern_ajax_favorite_msg = compile(r'(.*?)')
@@ -68,6 +76,8 @@ class JmcomicText:
pattern_api_response_json_object = compile(r'\{[\s\S]*?}')
pattern_html_comment_next_page = compile(r'id=["\']p_album_comments_\d+_(\d+)["\']')
+ # 网页端签到活动ID (data-dailyid)
+ pattern_html_daily_id = compile(r'data-dailyid="(\d+)"')
@classmethod
def parse_to_jm_domain(cls, text: str):
@@ -140,6 +150,19 @@ def analyse_jm_album_html(cls, html: str) -> JmAlbumDetail:
JmModuleConfig.album_class()
)
+ @classmethod
+ def parse_daily_id(cls, html: str, default=None) -> Optional[str]:
+ """
+ 从网页文本（如禁漫首页）中提取每日签到活动 ID（data-dailyid）
+ """
+ return PatternTool.match_or_default(
+ html,
+ cls.pattern_html_daily_id,
+ default,
+ )
+
+ parse_html_daily_id = parse_daily_id
+
@classmethod
def reflect_new_instance(cls, html: str, cls_field_prefix: str, clazz: type):
@@ -948,6 +971,8 @@ class JmApiAdaptTool:
'related_list',
'name',
'description',
+ 'is_favorite',
+ 'liked',
('id', 'album_id'),
('author', 'authors'),
('total_views', 'views'),
@@ -1003,7 +1028,10 @@ def post_adapt_album(cls, data: dict, _clazz: type, fields: dict):
(chapter.id, chapter.sort, chapter.name)
)
fields['episode_list'] = episode_list
- for it in 'scramble_id', 'page_count', 'pub_date', 'update_date':
+ fields['page_count'] = int(data['total_photos'])
+ fields['pub_date'] = datetime.fromtimestamp(int(data['addtime'])).strftime('%Y-%m-%d')
+
+ for it in 'scramble_id', 'update_date':
fields[it] = '0'
@classmethod
diff --git a/tests/test_jmcomic/test_jm_album_favorite.py b/tests/test_jmcomic/test_jm_album_favorite.py
new file mode 100644
index 000000000..09ee6ac24
--- /dev/null
+++ b/tests/test_jmcomic/test_jm_album_favorite.py
@@ -0,0 +1,146 @@
+import unittest
+from jmcomic import (
+ JmAlbumDetail,
+ JmcomicText,
+ JmApiAdaptTool,
+)
+
+
+class Test_Album_Favorite(unittest.TestCase):
+
+ def test_entity_defaults(self):
+ album = JmAlbumDetail(
+ album_id=123,
+ scramble_id=220980,
+ name="测试本子",
+ episode_list=[],
+ page_count=10,
+ pub_date="2026-01-01",
+ update_date="2026-01-02",
+ likes="100",
+ views="1000",
+ comment_count=5,
+ works=[],
+ actors=[],
+ authors=["作者A"],
+ tags=["标签1"],
+ )
+ self.assertIs(album.is_favorite, False)
+ self.assertIs(album.liked, False)
+ self.assertEqual(album.page_count, 10)
+ self.assertEqual(album.pub_date, "2026-01-01")
+
+ # Explicit True
+ album2 = JmAlbumDetail(
+ album_id=123,
+ scramble_id=220980,
+ name="测试本子",
+ episode_list=[],
+ page_count=10,
+ pub_date="2026-01-01",
+ update_date="2026-01-02",
+ likes="100",
+ views="1000",
+ comment_count=5,
+ works=[],
+ actors=[],
+ authors=["作者A"],
+ tags=["标签1"],
+ is_favorite=True,
+ liked=True,
+ )
+ self.assertIs(album2.is_favorite, True)
+ self.assertIs(album2.liked, True)
+
+ def test_html_reflect_is_favorite_and_liked(self):
+ # 模拟包含已收藏(btn-primary)和已点赞(style="color:red")的HTML
+ html_favorited_and_liked = '''
+
+ 作品編號：JM1133603
+ var scramble_id = 220980;
+ 测试本子
+ 叙述：这是一本测试
+ 頁數:50
+ 上架日期 : 2025-04-22
+ 更新日期 : 2025-04-23
+ 2K
+ 78K
+ 次觀看
+
+ 作品A
+ 人物A
+ 作者A
+ 标签A
+ 已收藏
+
+
+
+
+ '''
+ album = JmcomicText.analyse_jm_album_html(html_favorited_and_liked)
+ self.assertIs(album.is_favorite, True)
+ self.assertIs(album.liked, True)
+ self.assertEqual(album.page_count, 50)
+ self.assertEqual(album.pub_date, "2025-04-22")
+
+ # 模拟未收藏(未带btn-primary)和未点赞(无style="color:red")的HTML
+ html_unfavorited_and_unliked = '''
+
+ 作品編號：JM1133603
+ var scramble_id = 220980;
+ 测试本子
+ 叙述：这是一本测试
+ 頁數:50
+ 上架日期 : 2025-04-22
+ 更新日期 : 2025-04-23
+ 2K
+ 78K
+ 次觀看
+
+ 作品A
+ 人物A
+ 作者A
+ 标签A
+ 收藏
+
+
+
+
+ '''
+ album2 = JmcomicText.analyse_jm_album_html(html_unfavorited_and_unliked)
+ self.assertIs(album2.is_favorite, False)
+ self.assertIs(album2.liked, False)
+
+ def test_api_adapt_album_fields(self):
+ api_data = {
+ 'id': 1133603,
+ 'name': 'API本子',
+ 'author': ['测试作者'],
+ 'total_views': '12345',
+ 'likes': '678',
+ 'comment_total': '9',
+ 'tags': ['Tag1'],
+ 'works': [],
+ 'actors': [],
+ 'related_list': [],
+ 'series': [],
+ 'total_photos': 120,
+ 'addtime': 1745337600,
+ 'is_favorite': True,
+ 'liked': True,
+ 'description': '测试描述',
+ }
+ album: JmAlbumDetail = JmApiAdaptTool.parse_entity(api_data, JmAlbumDetail)
+ self.assertIs(album.is_favorite, True)
+ self.assertIs(album.liked, True)
+ self.assertEqual(album.page_count, 120)
+ self.assertEqual(album.id, '1133603')
+ self.assertEqual(album.name, 'API本子')
+
+ # 验证 False 场景
+ api_data_false = dict(api_data)
+ api_data_false['is_favorite'] = False
+ api_data_false['liked'] = False
+ album_false = JmApiAdaptTool.parse_entity(api_data_false, JmAlbumDetail)
+ self.assertIs(album_false.is_favorite, False)
+ self.assertIs(album_false.liked, False)
diff --git a/tests/test_jmcomic/test_jm_checkin.py b/tests/test_jmcomic/test_jm_checkin.py
new file mode 100644
index 000000000..807f15ef7
--- /dev/null
+++ b/tests/test_jmcomic/test_jm_checkin.py
@@ -0,0 +1,331 @@
+import asyncio
+import unittest
+from types import SimpleNamespace
+from unittest.mock import AsyncMock, Mock
+
+from jmcomic import (
+ AsyncJmApiClient,
+ JmApiClient,
+ JmHtmlClient,
+ JmcomicText,
+ JmDailyCheckinResp,
+)
+from jmcomic.jm_exception import JmcomicException
+
+
+class Test_CheckIn(unittest.TestCase):
+
+ def test_html_client_get_daily(self):
+ client = object.__new__(JmHtmlClient)
+ client.get_jm_html = Mock(return_value=SimpleNamespace(
+ text='