重构插件的文件生成路径规则 (#437)

Author: hect0x7

src/jmcomic/jm_config.py

@@ -380,7 +380,7 @@ def disable_jm_log(cls):
 
     @classmethod
     def new_postman(cls, session=False, **kwargs):
-        kwargs.setdefault('impersonate', 'chrome110')
+        kwargs.setdefault('impersonate', 'chrome')
         kwargs.setdefault('headers', JmModuleConfig.new_html_headers())
         kwargs.setdefault('proxies', JmModuleConfig.DEFAULT_PROXIES)
 
@@ -416,7 +416,7 @@ def new_postman(cls, session=False, **kwargs):
             'postman': {
                 'type': 'curl_cffi',
                 'meta_data': {
-                    'impersonate': 'chrome110',
+                    'impersonate': 'chrome',
                     'headers': None,
                     'proxies': None,
                 }

src/jmcomic/jm_option.py

@@ -70,12 +70,12 @@ def decide_image_save_dir(self,
                               album: JmAlbumDetail,
                               photo: JmPhotoDetail,
                               ) -> str:
-        return self._build_path_from_rules(album, photo)
+        return self.apply_rule_to_path(album, photo)
 
     def decide_album_root_dir(self, album: JmAlbumDetail) -> str:
-        return self._build_path_from_rules(album, None, True)
+        return self.apply_rule_to_path(album, None, True)
 
-    def _build_path_from_rules(self, album, photo, only_album_rules=False) -> str:
+    def apply_rule_to_path(self, album, photo, only_album_rules=False) -> str:
         path_ls = []
         for rule, parser in self.parser_list:
             if only_album_rules and not (rule == self.RULE_BASE_DIR or rule.startswith('A')):
@@ -92,7 +92,7 @@ def _build_path_from_rules(self, album, photo, only_album_rules=False) -> str:
 
             path_ls.append(path)
 
-        return fix_filepath('/'.join(path_ls), is_dir=True)
+        return fix_filepath('/'.join(path_ls))
 
     def get_rule_parser_list(self, rule_dsl: str):
         """
@@ -103,7 +103,6 @@ def get_rule_parser_list(self, rule_dsl: str):
         parser_list: list = []
 
         for rule in rule_list:
-            rule = rule.strip()
             if rule == self.RULE_BASE_DIR:
                 parser_list.append((rule, self.parse_bd_rule))
                 continue
@@ -135,17 +134,21 @@ def parse_detail_rule(cls, album, photo, rule: str):
         return str(DetailEntity.get_dirname(detail, rule[1:]))
 
     # noinspection PyMethodMayBeStatic
-    def split_rule_dsl(self, rule_dsl: str):
-        if rule_dsl == self.RULE_BASE_DIR:
-            return [rule_dsl]
-
+    def split_rule_dsl(self, rule_dsl: str) -> list[str]:
         if '/' in rule_dsl:
-            return rule_dsl.split('/')
+            rule_list = rule_dsl.split('/')
+        elif '_' in rule_dsl:
+            rule_list = rule_dsl.split('_')
+        else:
+            rule_list = [rule_dsl]
+
+        for i, e in enumerate(rule_list):
+            rule_list[i] = e.strip()
 
-        if '_' in rule_dsl:
-            return rule_dsl.split('_')
+        if rule_list[0] != self.RULE_BASE_DIR:
+            rule_list.insert(0, self.RULE_BASE_DIR)
 
-        ExceptionTool.raises(f'不支持的rule配置: "{rule_dsl}"')
+        return rule_list
 
     @classmethod
     def get_rule_parser(cls, rule: str):
@@ -158,7 +161,7 @@ def get_rule_parser(cls, rule: str):
         ExceptionTool.raises(f'不支持的rule配置: "{rule}"')
 
     @classmethod
-    def apply_rule_directly(cls, album, photo, rule: str) -> str:
+    def apply_rule_to_filename(cls, album, photo, rule: str) -> str:
         if album is None:
             album = photo.from_album
         # noinspection PyArgumentList

src/jmcomic/jm_plugin.py

@@ -1,7 +1,6 @@
 """
 该文件存放的是option插件
 """
-import os.path
 
 from .jm_option import *
 
@@ -76,6 +75,9 @@ def execute_deletion(self, paths: List[str]):
                 continue
 
             if os.path.isdir(p):
+                if os.listdir(p):
+                    self.log(f'文件夹中存在非本次下载的文件，请手动删除文件夹内的文件: {p}', 'remove.ignore')
+                    continue
                 os.rmdir(p)
                 self.log(f'删除文件夹: {p}', 'remove')
             else:
@@ -104,6 +106,33 @@ def leave_wait_list(self):
     def wait_until_finish(self):
         pass
 
+    # noinspection PyMethodMayBeStatic
+    def decide_filepath(self,
+                        album: Optional[JmAlbumDetail],
+                        photo: Optional[JmPhotoDetail],
+                        filename_rule: str, suffix: str, base_dir: Optional[str],
+                        dir_rule_dict: Optional[dict]
+                        ):
+        """
+        根据规则计算一个文件的全路径
+
+        参数 dir_rule_dict 优先级最高，
+        如果 dir_rule_dict 不为空，优先用 dir_rule_dict
+        否则使用 base_dir + filename_rule + suffix
+        """
+        filepath: str
+        base_dir: str
+        if dir_rule_dict is not None:
+            dir_rule = DirRule(**dir_rule_dict)
+            filepath = dir_rule.apply_rule_to_path(album, photo)
+            base_dir = os.path.dirname(filepath)
+        else:
+            base_dir = base_dir or os.getcwd()
+            filepath = os.path.join(base_dir, DirRule.apply_rule_to_filename(album, photo, filename_rule) + fix_suffix(suffix))
+
+        mkdir_if_not_exists(base_dir)
+        return filepath
+
 
 class JmLoginPlugin(JmOptionPlugin):
     """
@@ -285,7 +314,8 @@ def invoke(self,
                level='photo',
                filename_rule='Ptitle',
                suffix='zip',
-               zip_dir='./'
+               zip_dir='./',
+               dir_rule=None,
                ) -> None:
 
         from .jm_downloader import JmDownloader
@@ -302,12 +332,12 @@ def invoke(self,
         photo_dict = self.get_downloaded_photo(downloader, album, photo)
 
         if level == 'album':
-            zip_path = self.get_zip_path(album, None, filename_rule, suffix, zip_dir)
+            zip_path = self.decide_filepath(album, None, filename_rule, suffix, zip_dir, dir_rule)
             self.zip_album(album, photo_dict, zip_path, path_to_delete)
 
         elif level == 'photo':
             for photo, image_list in photo_dict.items():
-                zip_path = self.get_zip_path(photo.from_album, photo, filename_rule, suffix, zip_dir)
+                zip_path = self.decide_filepath(photo.from_album, photo, filename_rule, suffix, zip_dir, dir_rule)
                 self.zip_photo(photo, image_list, zip_path, path_to_delete)
 
         else:
@@ -371,18 +401,6 @@ def after_zip(self, path_to_delete: List[str]):
         self.execute_deletion(image_paths)
         self.execute_deletion(dirs)
 
-    # noinspection PyMethodMayBeStatic
-    def get_zip_path(self, album, photo, filename_rule, suffix, zip_dir):
-        """
-        计算zip文件的路径
-        """
-        filename = DirRule.apply_rule_directly(album, photo, filename_rule)
-        from os.path import join
-        return join(
-            zip_dir,
-            filename + fix_suffix(suffix),
-        )
-
 
 class ClientProxyPlugin(JmOptionPlugin):
     plugin_key = 'client_proxy'
@@ -649,95 +667,6 @@ def zip_with_password(self):
         self.execute_multi_line_cmd(cmd_list)
 
 
-class ConvertJpgToPdfPlugin(JmOptionPlugin):
-    plugin_key = 'j2p'
-
-    def check_image_suffix_is_valid(self, std_suffix):
-        """
-        检查option配置的图片后缀转换，目前限制使用Magick时只能搭配jpg
-        暂不探究Magick是否支持更多图片格式
-        """
-        cur_suffix: Optional[str] = self.option.download.image.suffix
-
-        ExceptionTool.require_true(
-            cur_suffix is not None and cur_suffix.endswith(std_suffix),
-            '请把图片的后缀转换配置为jpg，不然无法使用Magick！'
-            f'（当前配置是[{cur_suffix}]）\n'
-            f'配置模板如下: \n'
-            f'```\n'
-            f'download:\n'
-            f'  image:\n'
-            f'    suffix: {std_suffix} # 当前配置是{cur_suffix}\n'
-            f'```'
-        )
-
-    def invoke(self,
-               photo: JmPhotoDetail,
-               downloader=None,
-               pdf_dir=None,
-               filename_rule='Pid',
-               quality=100,
-               delete_original_file=False,
-               override_cmd=None,
-               override_jpg=None,
-               **kwargs,
-               ):
-        self.delete_original_file = delete_original_file
-
-        # 检查图片后缀配置
-        suffix = override_jpg or '.jpg'
-        self.check_image_suffix_is_valid(suffix)
-
-        # 处理文件夹配置
-        filename = DirRule.apply_rule_directly(None, photo, filename_rule)
-        photo_dir = self.option.decide_image_save_dir(photo)
-
-        # 处理生成的pdf文件的路径
-        if pdf_dir is None:
-            pdf_dir = photo_dir
-        else:
-            pdf_dir = fix_filepath(pdf_dir, True)
-            mkdir_if_not_exists(pdf_dir)
-
-        pdf_filepath = os.path.join(pdf_dir, f'{filename}.pdf')
-
-        # 生成命令
-        def generate_cmd():
-            return (
-                    override_cmd or
-                    'magick convert -quality {quality} "{photo_dir}*{suffix}" "{pdf_filepath}"'
-            ).format(
-                quality=quality,
-                photo_dir=photo_dir,
-                suffix=suffix,
-                pdf_filepath=pdf_filepath,
-            )
-
-        cmd = generate_cmd()
-        self.log(f'Execute Command: [{cmd}]')
-        code = self.execute_cmd(cmd)
-
-        ExceptionTool.require_true(
-            code == 0,
-            'jpg图片合并为pdf失败！'
-            '请确认你是否安装了magick，安装网站: [https://www.imagemagick.org/]',
-        )
-
-        self.log(f'Convert Successfully: JM{photo.id} → {pdf_filepath}')
-
-        if downloader is not None:
-            from .jm_downloader import JmDownloader
-            downloader: JmDownloader
-
-            paths = [
-                path
-                for path, image in downloader.download_success_dict[photo.from_album][photo]
-            ]
-
-            paths.append(self.option.decide_image_save_dir(photo, ensure_exists=False))
-            self.execute_deletion(paths)
-
-
 class Img2pdfPlugin(JmOptionPlugin):
     plugin_key = 'img2pdf'
 
@@ -747,6 +676,7 @@ def invoke(self,
                downloader=None,
                pdf_dir=None,
                filename_rule='Pid',
+               dir_rule=None,
                delete_original_file=False,
                **kwargs,
                ):
@@ -762,13 +692,7 @@ def invoke(self,
         self.delete_original_file = delete_original_file
 
         # 处理生成的pdf文件的路径
-        pdf_dir = self.ensure_make_pdf_dir(pdf_dir)
-
-        # 处理pdf文件名
-        filename = DirRule.apply_rule_directly(album, photo, filename_rule)
-
-        # pdf路径
-        pdf_filepath = os.path.join(pdf_dir, f'{filename}.pdf')
+        pdf_filepath = self.decide_filepath(album, photo, filename_rule, 'pdf', pdf_dir, dir_rule)
 
         # 调用 img2pdf 把 photo_dir 下的所有图片转为pdf
         img_path_ls, img_dir_ls = self.write_img_2_pdf(pdf_filepath, album, photo)
@@ -794,18 +718,14 @@ def write_img_2_pdf(self, pdf_filepath, album: JmAlbumDetail, photo: JmPhotoDeta
                 continue
             img_path_ls += imgs
 
+        if len(img_path_ls) == 0:
+            self.log(f'所有文件夹都不存在图片，无法生成pdf：{img_dir_ls}', 'error')
+
         with open(pdf_filepath, 'wb') as f:
             f.write(img2pdf.convert(img_path_ls))
 
         return img_path_ls, img_dir_ls
 
-    @staticmethod
-    def ensure_make_pdf_dir(pdf_dir: str):
-        pdf_dir = pdf_dir or os.getcwd()
-        pdf_dir = fix_filepath(pdf_dir, True)
-        mkdir_if_not_exists(pdf_dir)
-        return pdf_dir
-
 
 class LongImgPlugin(JmOptionPlugin):
     plugin_key = 'long_img'
@@ -817,6 +737,7 @@ def invoke(self,
                img_dir=None,
                filename_rule='Pid',
                delete_original_file=False,
+               dir_rule=None,
                **kwargs,
                ):
         if photo is None and album is None:
@@ -830,14 +751,8 @@ def invoke(self,
 
         self.delete_original_file = delete_original_file
 
-        # 处理文件夹配置
-        img_dir = self.get_img_dir(img_dir)
-
         # 处理生成的长图文件的路径
-        filename = DirRule.apply_rule_directly(album, photo, filename_rule)
-
-        # 长图路径
-        long_img_path = os.path.join(img_dir, f'{filename}.png')
+        long_img_path = self.decide_filepath(album, photo, filename_rule, 'png', img_dir, dir_rule)
 
         # 调用 PIL 把 photo_dir 下的所有图片合并为长图
         img_path_ls = self.write_img_2_long_img(long_img_path, album, photo)
@@ -856,7 +771,7 @@ def write_img_2_long_img(self, long_img_path, album: JmAlbumDetail, photo: JmPho
             img_dir_items = [self.option.decide_image_save_dir(photo) for photo in album]
 
         img_paths = itertools.chain(*map(files_of_dir, img_dir_items))
-        img_paths = filter(lambda x: not x.startswith('.'), img_paths)  # 过滤系统文件
+        img_paths = list(filter(lambda x: not x.startswith('.'), img_paths))  # 过滤系统文件
 
         images = self.open_images(img_paths)
 
@@ -895,12 +810,6 @@ def open_images(self, img_paths: List[str]):
                 self.log(f"Failed to open image {img_path}: {e}", 'error')
         return images
 
-    @staticmethod
-    def get_img_dir(img_dir: Optional[str]) -> str:
-        img_dir = fix_filepath(img_dir or os.getcwd())
-        mkdir_if_not_exists(img_dir)
-        return img_dir
-
 
 class JmServerPlugin(JmOptionPlugin):
     plugin_key = 'jm_server'