@wahaha216/koishi-plugin-jmcomic 0.1.0 → 0.1.1

package/lib/index.js

@@ -33,14 +33,14 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/locales/zh-CN.yml
 var require_zh_CN = __commonJS({
   "src/locales/zh-CN.yml"(exports2, module2) {
-    module2.exports = { commands: { jm: { description: "下载JM漫画，无需python！", examples: "jm album 本子数字ID\njm album info 本子数字ID\njm photo 本子章节数字ID", album: { examples: "jm album 数字ID", messages: { addedToQueue: "已将 {id} 添加到处理队列，请稍候。", notExistError: "找不到该ID对应的本子", mysqlError: "已尝试所有备用地址，但是JM坏掉了" }, info: { examples: "jm album info 本子数字ID", messages: { notExistError: "找不到该ID对应的本子", mysqlError: "已尝试所有备用地址，但是JM坏掉了" } } }, photo: { examples: "jm photo 本子章节数字ID", messages: { addedToQueue: "已将 {id} 添加到处理队列，请稍候。", notExistError: "找不到该ID对应的章节", mysqlError: "已尝试所有备用地址，但是JM坏掉了" } }, queue: { examples: "jm queue", messages: { emptyQueue: "当前没有正在处理或者等待处理的任务", msgFormat: "ID: {id}, 类型: {type}, 状态: {status}\n", task: { pending: "等待中...", processing: "处理中...", failed: "发生未知错误", completed: "已完成", unknown: "未定义状态" }, type: { album: "本子", photo: "章节" } } } } }, _config: [{ $desc: "基础设置", sendMethod: "发送方式", fileMethod: "文件获取方式<br>`buffer`: 读取成buffer后发送给bot实现端<br>`file`: 以`file:///` 本地路径形式发送，如docker环境，请在bot实现端同时映射/koishi目录", password: "密码，留空则不加密", fileName: "文件名定义<br>`{{name}}`：标题<br>`{{id}}`：章节或者本子ID<br>`{{index}}`：多章节本子自动填充`1` 、 `2`" }, { level: "压缩级别，0~9，0为仅存储" }, { $desc: "限制相关设置", retryCount: "重试次数限制", concurrentDownloadLimit: "同时下载数量限制", concurrentDecodeLimit: "同时解密数量限制", concurrentQueueLimit: "同时处理数量限制" }, { $desc: "缓存设置", cache: "缓存文件" }, { autoDelete: "自动删除缓存，**依赖cron服务**" }, { cron: "5位cron表达式", deleteInStart: "启动时检测", keepDays: "缓存保留时间（天）" }, { $desc: "开发者选项", debug: "调试模式，输出更多信息" }] };
+    module2.exports = { commands: { jm: { description: "下载JM漫画，无需python！", examples: "jm album 本子数字ID\njm album info 本子数字ID\njm photo 本子章节数字ID", album: { examples: "jm album 数字ID", messages: { addedToQueue: "已将 {id} 添加到处理队列，请稍候。", queueFirst: "已将 {id} 添加到处理队列，即将开始处理", queuePosition: "已将 {id} 添加到处理队列\n前面还有 {ahead} 个任务等待或正在处理", queueProcessing: "已将 {id} 添加到处理队列\n当前任务状态：{status}", notExistError: "找不到该ID对应的本子", mysqlError: "已尝试所有备用地址，但是JM坏掉了" }, info: { examples: "jm album info 本子数字ID", messages: { notExistError: "找不到该ID对应的本子", mysqlError: "已尝试所有备用地址，但是JM坏掉了" } } }, photo: { examples: "jm photo 本子章节数字ID", messages: { addedToQueue: "已将 {id} 添加到处理队列，请稍候。", queueFirst: "已将 {id} 添加到处理队列，即将开始处理", queuePosition: "已将 {id} 添加到处理队列\n前面还有 {ahead} 个任务等待或正在处理", queueProcessing: "已将 {id} 添加到处理队列\n当前任务状态：{status}", notExistError: "找不到该ID对应的章节", mysqlError: "已尝试所有备用地址，但是JM坏掉了" } }, queue: { examples: "jm queue", messages: { emptyQueue: "当前没有正在处理或者等待处理的任务", msgFormat: "ID: {id}, 类型: {type}, 状态: {status}\n", task: { pending: "等待中...", processing: "处理中...", failed: "发生未知错误", completed: "已完成", unknown: "未定义状态" }, type: { album: "本子", photo: "章节" } } } } }, _config: [{ $desc: "基础设置", sendMethod: "发送方式", fileMethod: "文件获取方式<br>`buffer`: 读取成buffer后发送给bot实现端<br>`file`: 以`file:///` 本地路径形式发送，如docker环境，请在bot实现端同时映射/koishi目录", password: "密码，留空则不加密", fileName: "文件名定义<br>`{{name}}`：标题<br>`{{id}}`：章节或者本子ID<br>`{{index}}`：多章节本子自动填充`1` 、 `2`" }, { level: "压缩级别，0~9，0为仅存储" }, { $desc: "限制相关设置", retryCount: "重试次数限制", concurrentDownloadLimit: "同时下载数量限制", concurrentDecodeLimit: "同时解密数量限制", concurrentQueueLimit: "同时处理数量限制" }, { $desc: "缓存设置", cache: "缓存文件" }, { autoDelete: "自动删除缓存，**依赖cron服务**" }, { cron: "5位cron表达式", deleteInStart: "启动时检测", keepDays: "缓存保留时间（天）" }, { $desc: "开发者选项", debug: "调试模式，输出更多信息" }] };
   }
 });
 
 // src/locales/en-US.yml
 var require_en_US = __commonJS({
   "src/locales/en-US.yml"(exports2, module2) {
-    module2.exports = { commands: { jm: { description: "Download JM comics without python!", examples: "jm album albumID\njm album info albumID\njm photo photoID", album: { examples: "jm album albumID", messages: { addedToQueue: "Album {id} has been added to the processing queue. Please wait.", notExistError: "albumID not found", mysqlError: "All alternate addresses have been tried. But no response." }, info: { examples: "jm album info albumID", messages: { notExistError: "albumID not found", mysqlError: "All alternate addresses have been tried. But no response." } } }, photo: { examples: "jm photo photoID", messages: { addedToQueue: "Photo {id} has been added to the processing queue. Please wait.", notExistError: "photoID not found", mysqlError: "All alternate addresses have been tried. But no response." } }, queue: { examples: "jm queue", messages: { emptyQueue: "There are currently no tasks being processed or waiting.", msgFormat: "ID: {id}, type: {type}, status: {status}\n", task: { Pending: "Pending...", Processing: "Processing...", failed: "Failed (Unknown Error)", completed: "Completed", unknown: "Unknown Status" }, type: { album: "Album", photo: "Photo" } } } } }, _config: [{ $desc: "Basic settings", sendMethod: "Send method", fileMethod: "File acquisition method<br>`buffer`: Read as buffer and send it to the bot implementation.<br>`file`: Send it in the local path of `file:///`. For example, if in the docker environment, please map the `/koishi` directory at the bot implementation.", retryCount: "Retry limit", password: "Password, leave blank without encryption", fileName: "File name definition<br>`{{name}}`: Title<br>`{{id}}`: Chapter or Book ID<br>`{{index}}`: Multi-chapter book auto-filling `_1` `_2`" }, { $desc: "Limit settings", retryCount: "Retry limit", concurrentDownloadLimit: "Concurrent Download Limit", concurrentDecodeLimit: "Concurrent Decode Limit", concurrentQueueLimit: "Concurrent Queue Limit" }, { level: "Compression level, 0~9, 0 is only stores" }, { $desc: "Cache settings", cache: "Cache files" }, { autoDelete: "Automatically delete cache, **need cron services**" }, { cron: "5-bit cron expression", deleteInStart: "Detection on startup", keepDays: "Cache retention time (days)" }, { $desc: "Developer Options", debug: "Debug mode, output more information" }] };
+    module2.exports = { commands: { jm: { description: "Download JM comics without python!", examples: "jm album albumID\njm album info albumID\njm photo photoID", album: { examples: "jm album albumID", messages: { addedToQueue: "Album {id} has been added to the processing queue. Please wait.", queueFirst: "Added {id} to the processing queue, starting shortly.", queuePosition: "Added {id} to the processing queue.\nThere are {ahead} tasks ahead or currently processing.", queueProcessing: "Added {id} to the processing queue.\nCurrent task status: {status}", notExistError: "albumID not found", mysqlError: "All alternate addresses have been tried. But no response." }, info: { examples: "jm album info albumID", messages: { notExistError: "albumID not found", mysqlError: "All alternate addresses have been tried. But no response." } } }, photo: { examples: "jm photo photoID", messages: { addedToQueue: "Photo {id} has been added to the processing queue. Please wait.", queueFirst: "Added {id} to the processing queue, starting shortly.", queuePosition: "Added {id} to the processing queue.\nThere are {ahead} tasks ahead or currently processing.", queueProcessing: "Added {id} to the processing queue.\nCurrent task status: {status}", notExistError: "photoID not found", mysqlError: "All alternate addresses have been tried. But no response." } }, queue: { examples: "jm queue", messages: { emptyQueue: "There are currently no tasks being processed or waiting.", msgFormat: "ID: {id}, type: {type}, status: {status}\n", task: { Pending: "Pending...", Processing: "Processing...", failed: "Failed (Unknown Error)", completed: "Completed", unknown: "Unknown Status" }, type: { album: "Album", photo: "Photo" } } } } }, _config: [{ $desc: "Basic settings", sendMethod: "Send method", fileMethod: "File acquisition method<br>`buffer`: Read as buffer and send it to the bot implementation.<br>`file`: Send it in the local path of `file:///`. For example, if in the docker environment, please map the `/koishi` directory at the bot implementation.", retryCount: "Retry limit", password: "Password, leave blank without encryption", fileName: "File name definition<br>`{{name}}`: Title<br>`{{id}}`: Chapter or Book ID<br>`{{index}}`: Multi-chapter book auto-filling `_1` `_2`" }, { $desc: "Limit settings", retryCount: "Retry limit", concurrentDownloadLimit: "Concurrent Download Limit", concurrentDecodeLimit: "Concurrent Decode Limit", concurrentQueueLimit: "Concurrent Queue Limit" }, { level: "Compression level, 0~9, 0 is only stores" }, { $desc: "Cache settings", cache: "Cache files" }, { autoDelete: "Automatically delete cache, **need cron services**" }, { cron: "5-bit cron expression", deleteInStart: "Detection on startup", keepDays: "Cache retention time (days)" }, { $desc: "Developer Options", debug: "Debug mode, output more information" }] };
   }
 });
 
@@ -1287,8 +1287,9 @@ var Queue = class {
       this.logger.info(
         `[任务添加] 任务ID: ${payload} 类型: ${payload.type} ID: ${payload.id}`
       );
+    const { pendingAhead, queuePosition } = this.getTaskQueuePosition(task.id);
     setTimeout(() => this._processQueue(), 0);
-    return task;
+    return { task, pendingAhead, queuePosition };
   }
   /**
    * 获取任务状态
@@ -1302,15 +1303,42 @@ var Queue = class {
   getAllTasks() {
     return this.tasks;
   }
+  /**
+   * 获取指定任务在队列中的位置信息
+   * @param taskId 任务ID
+   * @returns {pendingAhead: number, queuePosition: number}
+   * pendingAhead: 在此任务之前有多少个待处理任务
+   * queuePosition: 此任务在所有待处理任务中的位置（从1开始）
+   */
+  getTaskQueuePosition(taskId) {
+    let pendingAhead = 0;
+    let queuePosition = 0;
+    let found = false;
+    for (let i = 0; i < this.tasks.length; i++) {
+      const currentTask = this.tasks[i];
+      if (currentTask.id === taskId) {
+        found = true;
+        if (currentTask.status === "pending" || currentTask.status === "processing") {
+          queuePosition = pendingAhead + 1;
+        }
+        break;
+      }
+      if (currentTask.status === "pending" || currentTask.status === "processing") {
+        pendingAhead++;
+      }
+    }
+    if (!found) {
+      return { pendingAhead: -1, queuePosition: -1 };
+    }
+    return { pendingAhead, queuePosition };
+  }
   /**
    * 检查并处理队列中的任务
    */
   _processQueue() {
     while (this.activeTasks < this.concurrency) {
       const task = this.tasks.find((t) => t.status === "pending");
-      if (!task) {
-        break;
-      }
+      if (!task) break;
       this.activeTasks++;
       task.status = "processing";
       if (this.config.debug)
@@ -1443,35 +1471,42 @@ async function apply(ctx, config) {
     config,
     logger
   );
-  ctx.command("jm.album <albumId:string>").alias("本子").action(async ({ session, options }, albumId) => {
+  const handleAlbumOrPhoto = /* @__PURE__ */ __name(async (session, id) => {
     const messageId = session.messageId;
-    if (!/^\d+$/.test(albumId)) {
+    if (!/^\d+$/.test(id)) {
       await session.send([
         import_koishi2.h.quote(messageId),
         import_koishi2.h.text("输入的ID不合法，请检查")
       ]);
       return;
     }
-    queue.add({ type: "album", id: albumId, session, messageId });
-    await session.send([
-      import_koishi2.h.quote(messageId),
-      import_koishi2.h.text(session.text(".addedToQueue", { id: albumId }))
-    ]);
+    const { task, pendingAhead, queuePosition } = queue.add({
+      type: "album",
+      id,
+      session,
+      messageId
+    });
+    const params = {
+      id,
+      ahead: pendingAhead,
+      pos: queuePosition,
+      status: task.status
+    };
+    const msg = [import_koishi2.h.quote(messageId)];
+    if (pendingAhead === 0 && queuePosition === 1) {
+      msg.push(import_koishi2.h.text(session.text(".queueFirst", params)));
+    } else if (pendingAhead > 0) {
+      msg.push(import_koishi2.h.text(session.text(".queuePosition", params)));
+    } else {
+      msg.push(import_koishi2.h.text(session.text(".queueProcessing", params)));
+    }
+    await session.send(msg);
+  }, "handleAlbumOrPhoto");
+  ctx.command("jm.album <albumId:string>").alias("本子").action(async ({ session, options }, albumId) => {
+    await handleAlbumOrPhoto(session, albumId);
   });
   ctx.command("jm.photo <photoId:string>").alias("本子章节").action(async ({ session }, photoId) => {
-    const messageId = session.messageId;
-    if (!/^\d+$/.test(photoId)) {
-      await session.send([
-        import_koishi2.h.quote(messageId),
-        import_koishi2.h.text("输入的ID不合法，请检查")
-      ]);
-      return;
-    }
-    queue.add({ type: "album", id: photoId, session, messageId });
-    await session.send([
-      import_koishi2.h.quote(messageId),
-      import_koishi2.h.text(session.text(".addedToQueue", { id: photoId }))
-    ]);
+    await handleAlbumOrPhoto(session, photoId);
   });
   ctx.command("jm.album.info <albumId:string>").alias("本子信息").action(async ({ session, options }, albumId) => {
     const messageId = session.messageId;

package/lib/utils/Queue.d.ts

@@ -21,6 +21,11 @@ type TaskProcessor = (payload: JmTaskPayload) => Promise<void>;
 interface QueueOptions {
     concurrency?: number;
 }
+interface AddTaskResult {
+    task: Task;
+    pendingAhead: number;
+    queuePosition: number;
+}
 export declare class Queue {
     private tasks;
     private processor;
@@ -38,7 +43,7 @@ export declare class Queue {
     /**
      * 向队列添加一个新任务
      */
-    add(payload: JmTaskPayload): Task;
+    add(payload: JmTaskPayload): AddTaskResult;
     /**
      * 获取任务状态
      */
@@ -47,6 +52,17 @@ export declare class Queue {
      * 获取所有任务的只读列表
      */
     getAllTasks(): Readonly<Task[]>;
+    /**
+     * 获取指定任务在队列中的位置信息
+     * @param taskId 任务ID
+     * @returns {pendingAhead: number, queuePosition: number}
+     * pendingAhead: 在此任务之前有多少个待处理任务
+     * queuePosition: 此任务在所有待处理任务中的位置（从1开始）
+     */
+    getTaskQueuePosition(taskId: string): {
+        pendingAhead: number;
+        queuePosition: number;
+    };
     /**
      * 检查并处理队列中的任务
      */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@wahaha216/koishi-plugin-jmcomic",
   "description": "下载JM本子，无需python。支持pdf、zip加密。",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "files": [

package/readme.md

@@ -10,6 +10,7 @@
 jm album xxxxxx
 jm album info xxxxxx
 jm photo xxxxxx
+jm queue
 ```
 
 可在配置中配置是发送 PDF 还是 ZIP 压缩包，支持加密。
@@ -17,18 +18,22 @@ jm photo xxxxxx
 ## 更新日志
 
 <details>
-<summary>0.1.0</summary>
-1.队列系统
-
-2.下载并发与解密并发限制
+<summary>0.1.1</summary>
 
-3.修改配置页面顺序、分类
+1. 添加队列时返回队列信息
+2. 提取代码
 
-4.不再直接暴露变量，改为逐级传递
+</details>
 
-5.统一暴露Error类
+<details>
+<summary>0.1.0</summary>
 
-6.添加域名切换条件
+1. 队列系统
+2. 下载并发与解密并发限制
+3. 修改配置页面顺序、分类
+4. 不再直接暴露变量，改为逐级传递
+5. 统一暴露Error类
+6. 添加域名切换条件
 
 </details>
 
@@ -44,9 +49,9 @@ jm photo xxxxxx
 
 <details>
 <summary>0.0.4</summary>
-1.文件名移除前后空格
 
-2.新增文件发送配置，用于配置文件是以 buffer 读取后发送还是以本地地址的形式发送。docker 中使用 file 形式需要在 bot 实现端同时映射/koishi 目录
+1. 文件名移除前后空格
+2. 新增文件发送配置，用于配置文件是以 buffer 读取后发送还是以本地地址的形式发送。docker 中使用 file 形式需要在 bot 实现端同时映射/koishi 目录
 
 </details>