plugin-jm-server 0.1.24__tar.gz → 0.2.1__tar.gz

{plugin_jm_server-0.1.24 → plugin_jm_server-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plugin_jm_server
-Version: 0.1.24
+Version: 0.2.1
 Summary: plugin_jm_server, a plugin for jmcomic that can be used to view comics in a web browser.
 Home-page: https://github.com/hect0x7/plugin-jm-server
 Author: hect0x7
@@ -44,20 +44,33 @@ Dynamic: summary
 
 * 双页阅读插件：https://sleazyfork.org/zh-CN/scripts/374903-comicread
 
-#  想法起源
+# 效果图（文件浏览、整章看图）
 
-想法起源：https://github.com/hect0x7/JMComic-Crawler-Python/issues/192
+## 1. 电脑浏览器访问
 
-基于原项目：https://github.com/AiCorein/Flask-Files-Server
+### 登录页
+![](images/3.png)
 
-为了方便修改，将原项目中的文件复制到本项目中，然后进行修改
+### 文件夹列表页
+![](images/4.png)
+![](images/9.png)
 
+### 看本模式
+![](images/5.png)
 
-# 可优化点
+### 文件夹&看本 二合一模式
+![](images/8.png)
 
-1. 前端优化。目前项目架构是`前后端不分离架构`，前端使用原始的html三件套。可以优化为前后端分离架构，基于Vue等开发框架，复用组件库，优化界面。
+## 2. 手机浏览器访问
 
-2. 后端优化。支持提供调用jmcomic功能的后端接口。
+### 登录页
+![](images/1.jpeg)
+
+### 文件夹列表页
+![](images/2.png)
+
+### 看本模式
+![](images/7.jpeg)
 
 
 # 使用方式
@@ -70,7 +83,6 @@ pip install plugin_jm_server
 ```
 
 
-
 ## 2. 运行代码
 
 * **HTTP版**
@@ -135,15 +147,41 @@ op.wait_all_plugins_finish()
 ```
 
 
-# 效果图（文件浏览、整章看图）
+## 前端页面与功能介绍
+
+本项目提供了一套完整的 Web 前端界面，用于管理和浏览本地图片资源。主要包含以下三个核心页面及其功能：
+
+### 1. 登录页
+为了保护个人隐私，系统提供了简单的访问控制。
+*   **密码验证**：启动时可配置密码，访问时需校验通过。
+*   **设备自适应**：根据访问设备（手机/电脑）自动适配最佳的登录布局。
+
+### 2. 文件夹浏览页（主页）
+这是资源管理的核心入口，支持高效的文件查找与导航。目前最新版本采用了 SPA（单页应用）架构进行全面增强：
+*   **智能路径导航**：
+    *   **路径补全**：输入路径时自动联想下级文件夹，支持键盘上下键选择及回车跳转。
+    *   **层级跳转**：输入框支持“..”快速返回上一级，并提供“确认”按钮进行精准跳转。
+*   **可视化展示**：
+    *   **文件夹预览**：鼠标悬停在文件夹上时，会自动展示该文件夹内的首张图片作为封面预览。
+    *   **类型区分**：通过文件夹角标（图标）清晰区分普通文件夹与特殊资源文件夹。
+*   **辅助功能**：
+    *   **书签管理**：支持将常看目录加入左侧书签栏，方便下次快速访问。
+    *   **本地交互**：支持通过网页菜单直接打开服务器端对应的本地文件夹窗口（Explorer）。
+
+### 3. 图片阅读页（看本模式）
+专为漫画阅读优化的沉浸式浏览页面。
+*   **加载优化**：采用图片懒加载机制，流畅浏览含有数百张图片的大型章节，节省系统资源。
+*   **多端适配**：
+    *   **PC端**：适合大屏浏览，支持浮动工具栏进行页面跳转、全屏切换等。
+    *   **移动端**：适配触摸操作，提供更好的手机阅读体验。
+*   **阅读辅助**：
+    *   **浮动菜单**：提供“回到顶部”、“加载全部图片”及“在资源管理器打开”等便捷操作。
+    *   **键盘支持**：支持常用快捷键进行页面滚动和翻页。
 
-## 1. 电脑浏览器访问
-![](images/3.png)
-![](images/4.png)
-![](images/5.png)
+#  想法起源
 
-## 2. 手机浏览器访问
-![](images/1.jpeg)
-![](images/2.jpeg)
-![](images/7.jpeg)
+想法起源：https://github.com/hect0x7/JMComic-Crawler-Python/issues/192
 
+基于原项目：https://github.com/AiCorein/Flask-Files-Server
+
+为了方便修改，将原项目中的文件复制到本项目中，然后进行修改

plugin_jm_server-0.2.1/README.md

@@ -0,0 +1,151 @@
+# plugin-jm-server
+
+“离线版”禁漫天堂
+
+该项目会在本地起一个`文件服务器`，支持用浏览器查看文件夹内的图片，界面模仿禁漫的章节观看页面，并适配手机端。
+
+用浏览器的好处就是支持很多浏览器插件和脚本，例如：
+
+* 双页阅读插件：https://sleazyfork.org/zh-CN/scripts/374903-comicread
+
+# 效果图（文件浏览、整章看图）
+
+## 1. 电脑浏览器访问
+
+### 登录页
+![](images/3.png)
+
+### 文件夹列表页
+![](images/4.png)
+![](images/9.png)
+
+### 看本模式
+![](images/5.png)
+
+### 文件夹&看本 二合一模式
+![](images/8.png)
+
+## 2. 手机浏览器访问
+
+### 登录页
+![](images/1.jpeg)
+
+### 文件夹列表页
+![](images/2.png)
+
+### 看本模式
+![](images/7.jpeg)
+
+
+# 使用方式
+
+
+## 1. pip安装
+
+```shell
+pip install plugin_jm_server
+```
+
+
+## 2. 运行代码
+
+* **HTTP版**
+
+```python
+from plugin_jm_server import *
+
+# http
+server = JmServer(
+    'D:/',
+    'password',
+)
+server.run(
+    host='0.0.0.0',
+    port=80,
+)
+```
+
+* **HTTPS版**
+
+```python
+from plugin_jm_server import *
+
+# https
+server = JmServer(
+    'D:/',
+    'password',
+)
+server.run(
+    host='0.0.0.0',
+    port=443,
+    ssl_context='adhoc',
+)
+```
+
+* 作为jmcomic的插件
+
+```yml
+# 配置文件
+plugins:
+  after_init: 
+#  after_album:
+    - plugin: jm_server
+      kwargs:
+        password: ''
+
+```
+
+```python
+# 代码
+from jmcomic import *
+
+op = create_option('op.yml')
+op.download_album(123)
+# 运行到这里，虽然主线程代码执行完毕，但程序不会退出，因为服务器线程还没有结束。
+# 控制台会输出提示信息如下（atexit时输出的）：
+# “主线程执行完毕，但插件jm_server的服务器线程仍运行中，可按下ctrl+c结束程序”
+# 此时需要你主动按下ctrl+c终止程序。
+
+# python 3.12 特别注意：需要插入下面这行代码，服务器才能继续处理请求
+op.wait_all_plugins_finish()
+```
+
+
+## 前端页面与功能介绍
+
+本项目提供了一套完整的 Web 前端界面，用于管理和浏览本地图片资源。主要包含以下三个核心页面及其功能：
+
+### 1. 登录页
+为了保护个人隐私，系统提供了简单的访问控制。
+*   **密码验证**：启动时可配置密码，访问时需校验通过。
+*   **设备自适应**：根据访问设备（手机/电脑）自动适配最佳的登录布局。
+
+### 2. 文件夹浏览页（主页）
+这是资源管理的核心入口，支持高效的文件查找与导航。目前最新版本采用了 SPA（单页应用）架构进行全面增强：
+*   **智能路径导航**：
+    *   **路径补全**：输入路径时自动联想下级文件夹，支持键盘上下键选择及回车跳转。
+    *   **层级跳转**：输入框支持“..”快速返回上一级，并提供“确认”按钮进行精准跳转。
+*   **可视化展示**：
+    *   **文件夹预览**：鼠标悬停在文件夹上时，会自动展示该文件夹内的首张图片作为封面预览。
+    *   **类型区分**：通过文件夹角标（图标）清晰区分普通文件夹与特殊资源文件夹。
+*   **辅助功能**：
+    *   **书签管理**：支持将常看目录加入左侧书签栏，方便下次快速访问。
+    *   **本地交互**：支持通过网页菜单直接打开服务器端对应的本地文件夹窗口（Explorer）。
+
+### 3. 图片阅读页（看本模式）
+专为漫画阅读优化的沉浸式浏览页面。
+*   **加载优化**：采用图片懒加载机制，流畅浏览含有数百张图片的大型章节，节省系统资源。
+*   **多端适配**：
+    *   **PC端**：适合大屏浏览，支持浮动工具栏进行页面跳转、全屏切换等。
+    *   **移动端**：适配触摸操作，提供更好的手机阅读体验。
+*   **阅读辅助**：
+    *   **浮动菜单**：提供“回到顶部”、“加载全部图片”及“在资源管理器打开”等便捷操作。
+    *   **键盘支持**：支持常用快捷键进行页面滚动和翻页。
+
+#  想法起源
+
+想法起源：https://github.com/hect0x7/JMComic-Crawler-Python/issues/192
+
+基于原项目：https://github.com/AiCorein/Flask-Files-Server
+
+为了方便修改，将原项目中的文件复制到本项目中，然后进行修改

plugin_jm_server-0.2.1/src/plugin_jm_server/__init__.py

@@ -0,0 +1,3 @@
+__version__ = '0.2.1'
+
+from .app import *

{plugin_jm_server-0.1.24 → plugin_jm_server-0.2.1}/src/plugin_jm_server/app.py

@@ -8,7 +8,7 @@ from typing import Optional
 import common
 from flask import Flask, abort, Response, stream_with_context
 from flask import render_template, send_from_directory
-from flask import request, session, redirect, flash
+from flask import request, session, redirect, flash, jsonify
 
 from .files import FileManager
 
@@ -22,10 +22,12 @@ class JmServer:
     def __init__(self,
                  default_path,
                  password,
+                 *,
                  jm_option=None,
                  ip_whitelist=None,
                  current_path=None,
                  img_overwrite: Optional[dict] = None,
+                 env=None,
                  **extra,
                  ):
         """
@@ -59,6 +61,9 @@ class JmServer:
             import queue
             self.jm_log_msg_queue = queue.Queue()
             self.__hook_jm_logging()
+        if env:
+            for k, v in env.items():
+                os.environ[k] = v
 
     def __hook_jm_logging(self):
         import jmcomic
@@ -77,7 +82,7 @@ class JmServer:
         """
         验证登录状态
         """
-        if session.get('password', None) == self.password:
+        if (self.password == '') or session.get('password', None) == self.password:
             return True
         else:
             return False
@@ -112,9 +117,88 @@ class JmServer:
         """
         url添加一个随机参数，防止浏览器缓存
         """
-        # from random import randint
-        # return randint(100000, 1000000)
-        return 0
+        from random import randint
+        return randint(100000, 1000000)
+
+    def spa_view(self):
+        """
+        [New] V2 SPA Interface (PC Only)
+        """
+        if not self.verify():
+            return redirect('/login')
+
+        # 获取路径参数，如果为空则使用默认路径
+        path = request.args.get('path', None)
+        if path is None:
+            path = self.file_manager.default_path
+
+        path = os.path.abspath(path)
+        path = common.fix_filepath(path)
+
+        if common.file_not_exists(path):
+            return abort(404)
+
+        return render_template('index_spa.html',
+                               data={
+                                   'currentPath': path,
+                                   'defaultPath': self.file_manager.default_path,
+                                   'drivers': self.file_manager.DRIVERS_LIST
+                               },
+                               randomArg=self.url_random_arg())
+
+    def api_list_files(self):
+        """
+        [New] API: List files in directory
+        """
+        if not self.verify():
+            return abort(403)
+
+        path = request.args.get('path', self.file_manager.default_path)
+        path = os.path.abspath(path)
+        path = common.fix_filepath(path)
+
+        if common.file_not_exists(path):
+            return jsonify({'error': 'Path not found'}), 404
+
+        files_data = self.file_manager.get_files_data(path)
+        return jsonify({
+            'currentPath': path,
+            'files': files_data
+        })
+
+    def api_album_images(self):
+        """
+        [New] API: Get images for an album
+        """
+        if not self.verify():
+            return abort(403)
+
+        path = request.args.get('path', None)
+        if not path:
+            return jsonify({'error': 'Path required'}), 400
+
+        path = os.path.abspath(path)
+        if common.file_not_exists(path):
+            return jsonify({'error': 'Path not found'}), 404
+
+        images = self.file_manager.get_jm_view_images(path)
+        return jsonify({
+            'title': common.of_file_name(path),
+            'images': images
+        })
+
+    def api_open_file(self):
+        """
+        [New] API: Open file/folder in Explorer
+        """
+        if not self.verify():
+            return abort(403)
+            
+        path = request.args.get('path', None)
+        if not path:
+           return jsonify({'error': 'Path required'}), 400
+           
+        return self.open_directory(path) or jsonify({'status': 'ok'})
 
     def jm_view(self):
         """
@@ -189,6 +273,7 @@ class JmServer:
                                    "files": self.file_manager.get_files_data(path),
                                    "drivers": self.file_manager.DRIVERS_LIST,
                                    "currentPath": path,
+                                   "defaultPath": self.file_manager.default_path
                                },
                                randomArg=self.url_random_arg())
 
@@ -314,8 +399,14 @@ class JmServer:
         finally:
             self.jm_log_msg_queue.put(end)
 
-    def run(self, **kwargs):
-        kwargs.setdefault('port', self.DEFAULT_PORT)
+    def open_directory(self, directory):
+        path = os.path.abspath(directory)
+        # os.startfile(path)  # Windows特有，打开文件夹
+        import subprocess
+        subprocess.Popen(f'explorer /select,"{path}"')
+        return ''
+
+    def register_routes(self):
         # 添加路由
         self.app.add_url_rule('/jm_view', 'jm_view', self.jm_view, methods=['GET'])
         self.app.add_url_rule("/view_file/", 'view_file', self.view_file, methods=['GET'], strict_slashes=False)
@@ -323,8 +414,19 @@ class JmServer:
         self.app.add_url_rule('/login', 'login', self.login, methods=['GET', 'POST'])
         self.app.add_url_rule('/logout', 'logout', self.logout, methods=['GET', 'POST'])
         self.app.add_url_rule("/download_file/<filename>", 'file_content', self.file_content)
+        self.app.add_url_rule('/open/<path:directory>', 'open_directory', self.open_directory)
         self.app.add_url_rule("/upload_file", 'upload', self.upload, methods=['GET', 'POST'])
         self.app.add_url_rule("/stream", 'stream', self.stream, methods=['GET', 'POST'])
+
+        # [New] SPA Routes
+        self.app.add_url_rule("/spa", 'spa_view', self.spa_view, methods=['GET'])
+        self.app.add_url_rule("/api/list_files", 'api_list_files', self.api_list_files, methods=['GET'])
+        self.app.add_url_rule("/api/album_images", 'api_album_images', self.api_album_images, methods=['GET'])
+        self.app.add_url_rule("/api/open_file", 'api_open_file', self.api_open_file, methods=['GET'])
+
+    def run(self, **kwargs):
+        kwargs.setdefault('port', self.DEFAULT_PORT)
+        self.register_routes()
         # 监听在所有 IP 地址上
         self.app.run(**kwargs)
 

plugin_jm_server-0.2.1/src/plugin_jm_server/files.py

@@ -0,0 +1,170 @@
+from urllib.parse import quote
+import os
+import time
+import re
+
+import common
+
+
+class FileManager:
+    def __init__(self, default_path, current_path):
+        self.default_path = default_path
+        self.current_path = current_path
+
+    @property
+    def DRIVERS_LIST(self):
+        # 判断如果是windows系统
+        if os.name == 'nt':
+            from .driver import get_winDriver
+            return get_winDriver()
+        else:
+            return ['/']
+
+    def get_jm_view_images(self, path):
+        images_data = []
+
+        give_up_sort = False
+
+        for f in self.files_of_dir_safe(path):
+            if not self.is_image_file(f):
+                continue
+            f = quote(f)
+            name = common.of_file_name(f)
+            try:
+                index = int(name[:name.index('.')])
+            except ValueError:
+                give_up_sort = True
+                index = None
+
+            images_data.append({
+                'filename': name,
+                'data_original': f'/view_file?path={f}',
+                'index': index,
+            })
+
+        if give_up_sort is False:
+            images_data.sort(key=lambda item: item['index'])
+
+        return images_data
+
+    @staticmethod
+    def is_image_file(filename):
+        file_extension = filename.lower().split('.')[-1]
+        image_extensions = ['jpg', 'jpeg', 'png', 'gif', 'bmp', 'tiff', 'webp']
+        return file_extension in image_extensions
+
+    @staticmethod
+    def files_of_dir_safe(dir_path):
+        try:
+            return common.files_of_dir(dir_path)
+        except OSError:
+            return []
+
+    def check_dir_can_open_jm_view(self, dirpath):
+        return any(f for f in self.files_of_dir_safe(dirpath) if self.is_image_file(f))
+
+    def build_one_path_info(self, file_path, dtype=''):
+        jm_view, the_type = self.get_file_type(file_path)
+
+        name = common.of_file_name(file_path)
+
+        try:
+            size = os.path.getsize(file_path)
+        except OSError:
+            return
+
+        size = dtype if dtype != '' else self.file_size_format(size, the_type)
+
+        try:
+            getctime = os.path.getctime(file_path)
+            ctime = time.localtime(getctime)
+            time_str = time.strftime("%Y-%m-%d %H:%M:%S", ctime)
+        except OSError:
+            return
+
+        first_img_url = ''
+        if jm_view and the_type == 'dir':
+            imgs = self.get_jm_view_images(file_path)
+            if imgs:
+                first_img_url = imgs[0]
+
+        if name.endswith('.lnk'):
+            target_path = self.get_target_path(file_path)
+            return self.build_one_path_info(target_path, 'Link')
+
+        return {
+            "name": name,
+            'path': file_path,
+            'href': f'/?path={file_path}' if the_type == 'dir' else f'./download_file/{name}',
+            "size": size,
+            "ctime": time_str,
+            "type": the_type,
+            'jm_view': jm_view,
+            'first_img_url': first_img_url
+        }
+
+    def get_files_data(self, path):
+        files = list(filter(bool, map(self.build_one_path_info, self.files_of_dir_safe(path))))
+        self.current_path = path
+        files = self.sort_files(files)
+        return files
+
+    def sort_files(self, files: list):
+        def natural_key(item):
+            return [int(text) if text.isdigit() else text.lower()
+                    for text in re.split(r'(\d+)', item['name'])]
+
+        # Split into groups
+        jm_albums = []
+        other_dirs = []
+        other_files = []
+
+        for f in files:
+            if f['jm_view']:
+                jm_albums.append(f)
+            elif f['type'] == 'dir':
+                other_dirs.append(f)
+            else:
+                other_files.append(f)
+
+        # Sort each group
+        jm_albums.sort(key=natural_key)
+        other_dirs.sort(key=natural_key)
+        other_files.sort(key=natural_key)
+
+        return jm_albums + other_dirs + other_files
+
+    def get_file_type(self, file_path):
+        if os.path.isfile(file_path):
+            the_type = 'file'
+            jm_view = self.check_dir_can_open_jm_view(common.of_dir_path(file_path))
+        else:
+            the_type = 'dir'
+            jm_view = self.check_dir_can_open_jm_view(file_path)
+        return jm_view, the_type
+
+    @staticmethod
+    def get_target_path(lnk_path: str) -> str:
+        try:
+            import pylnk3
+            lnk = pylnk3.parse(lnk_path)
+            return lnk.path.replace("\\", '/').replace("//", '/')  # 获取目标文件/文件夹路径
+        except Exception as e:
+            return lnk_path
+
+    @staticmethod
+    def file_size_format(size, the_type):
+        if the_type == 'dir':
+            return '<DIR>'
+        else:
+            if size < 1024:
+                return '%i' % size + ' B'
+            elif 1024 < size <= 1048576:
+                return '%.1f' % float(size / 1024) + ' KB'
+            elif 1048576 < size <= 1073741824:
+                return '%.1f' % float(size / 1048576) + ' MB'
+            elif 1073741824 < size <= 1099511627776:
+                return '%.1f' % float(size / 1073741824) + ' GB'
+
+    def get_current_path(self):
+        return self.current_path