node-karin 0.11.4 → 0.11.5

package/lib/cli/karin.js

@@ -175,14 +175,12 @@ class KarinCli {
   async update () {
     /** 屏蔽的依赖包列表 */
     const pkgdependencies = [
-      '@grpc/grpc-js',
-      '@grpc/proto-loader',
       'art-template',
       'axios',
       'chalk',
       'chokidar',
+      'commander',
       'express',
-      'kritor-proto',
       'level',
       'lodash',
       'log4js',
@@ -192,38 +190,23 @@ class KarinCli {
       'ws',
       'yaml',
     ]
-    let cmd = ''
     const list = Object.keys(this.pkg(false).dependencies).filter(key => !pkgdependencies.includes(key))
     /** 获取包管理器 */
     const pkg = new KarinCfgInit().getRegistry()
-    switch (pkg) {
-      case 'pnpm': {
-        cmd = 'pnpm update'
-        break
-      }
-      case 'yarn': {
-        cmd = 'yarn upgrade'
-        break
-      }
-      case 'npm': {
-        cmd = 'npm update'
-        break
-      }
-      case 'cnpm': {
-        cmd = 'cnpm update'
-        break
-      }
-    }
+    const cmd = pkg === 'yarn' ? 'yarn upgrade' : `${pkg} update`
     /** 异步并发更新依赖 */
     await Promise.all(list.map(async (item) => {
       try {
-        const res = await this.exec(`${cmd} ${item}@latest`)
-        /** 已经是最新 */
-        if (res.includes('is up to date')) {
+        /** 检查是否已经是最新版本 */
+        const local = await this.getLocalVersion(item, pkg)
+        const remote = await this.getRemoteVersion(item, pkg)
+        if (local === remote) {
           console.log(`[依赖更新] ${item} 已经是最新~`)
-        } else {
-          console.log(`[依赖更新] ${item} 更新完成~`)
+          return
         }
+        console.log(`[依赖更新] ${item} 当前版本: ${local} 最新版本: ${remote}`)
+        await this.exec(`${cmd} ${item}@latest`)
+        console.log(`[依赖更新] ${item} 更新完成~`)
       } catch (error) {
         console.error(`[依赖更新] ${item} 更新失败:`)
         console.error(`error.stack: ${error.stack}`)
@@ -233,6 +216,43 @@ class KarinCli {
     console.log('所有依赖已更新完成~')
   }
 
+  /**
+     * 获取指定包的本地版本
+     * @param name - 包名
+     * @param pkg - 包管理器
+     * @returns - 版本号
+     */
+  async getLocalVersion (name, pkg) {
+    const cmd = pkg === 'yarn' ? `yarn list --pattern ${name}` : `${pkg} list ${name} --depth=0`
+    const text = await this.exec(cmd)
+    /** pnpm特殊处理 */
+    if (pkg === 'pnpm') {
+      const reg = new RegExp(`${name}\\s+([\\d.]+)`, 'gm')
+      const res = reg.exec(text)
+      return res?.[1] || '0.0.0'
+    }
+    const reg = new RegExp(`${name}@(\\d+\\.\\d+\\.\\d+)`, 'gm')
+    const res = reg.exec(text)
+    return res?.[1] || '0.0.0'
+  }
+
+  /**
+     * 获取指定包的最新版本
+     * @param name - 包名
+     * @param pkg - 包管理器
+     */
+  async getRemoteVersion (name, pkg) {
+    const cmd = `${pkg} info ${name} version`
+    const text = await this.exec(cmd)
+    /** yarn特殊处理 */
+    if (pkg === 'yarn') {
+      const lines = text.split('\n').map(line => line.trim())
+      const ver = lines.find(line => /^\d+\.\d+\.\d+$/.test(line))
+      return ver || ''
+    }
+    return text.trim()
+  }
+
   /**
      * 封装exec
      * @param cmd - 命令
@@ -240,7 +260,7 @@ class KarinCli {
   exec (cmd) {
     return new Promise((resolve, reject) => {
       execCmd(cmd, (error, stdout, stderr) => {
-        if (stdout) { return resolve(stdout) }
+        if (stdout) { return resolve(stdout.trim()) }
         if (error) { return reject(error) }
         return reject(stderr)
       })

package/lib/core/init/config.js

@@ -154,7 +154,7 @@ export class KarinCfgInit {
             console.log('检测到已安装pnpm，开始安装依赖...');
         }
         /** 安装依赖 */
-        if (!(await this.shell(`${type} -P --force`))) {
+        if (!(await this.shell(`${type} install -P --force`))) {
             console.log('安装依赖失败，请手动安装依赖！');
             console.log(`可尝试手动执行 【 ${type} install -P 】 安装依赖~`);
             console.log('如中国大陆用户安装失败，请尝试执行换源 【 npm config set registry https://registry.npmmirror.com 】后再安装依赖~');

package/lib/core/karin/karin.d.ts

@@ -1,6 +1,9 @@
 import { Contact, KarinElement, KarinMessage, KarinRenderType, PermissionType, RenderResult, KarinNoticeType, KarinRequestType, KarinMessageType, AllMessageSubType, CommandInfo, TaskInfo, HandlerInfo, AcceptInfo, UseInfo, AllNoticeSubType, AllRequestSubType } from '../../types/index.js';
 type FncFunction = (e: KarinMessage) => Promise<boolean>;
 type FncElement = string | KarinElement | Array<KarinElement>;
+type UseReceive = (e: KarinMessageType, next: Function, exit: Function) => Promise<void>;
+type UseReply = (e: KarinMessageType, element: KarinElement[], next: Function, exit: Function) => Promise<void>;
+type UseRecord = (uid: string, contact: Contact, elements: KarinElement[], next: Function, exit: Function) => Promise<void>;
 /**
  * 中间件类型
  */
@@ -156,9 +159,9 @@ export declare class Karin {
      * @param fn - 实现函数
      */
     accept(event: AllNoticeSubType | AllRequestSubType, fn: (e: KarinNoticeType | KarinRequestType) => Promise<boolean>, options?: Options): AcceptInfo;
-    use(type: `${MiddlewareType.ReceiveMsg}`, fn: (e: KarinMessageType, next: Function) => Promise<void>, options: Omit<Options, 'log'>): UseInfo;
-    use(type: `${MiddlewareType.ReplyMsg}`, fn: (e: KarinMessageType, element: KarinElement[], next: Function) => Promise<void>, options: Omit<Options, 'log'>): UseInfo;
-    use(type: `${MiddlewareType.SendMsg}`, fn: (uid: string, contact: Contact, elements: KarinElement[]) => Promise<void>, options: Omit<Options, 'log'>): UseInfo;
+    use(type: `${MiddlewareType.ReceiveMsg}`, fn: UseReceive, options?: Omit<Options, 'log'>): UseInfo;
+    use(type: `${MiddlewareType.ReplyMsg}`, fn: UseReply, options?: Omit<Options, 'log'>): UseInfo;
+    use(type: `${MiddlewareType.SendMsg}`, fn: UseRecord, options?: Omit<Options, 'log'>): UseInfo;
     /**
      * - 启动
      */

package/lib/core/listener/listener.js

@@ -176,12 +176,21 @@ export class Listeners extends EventEmitter {
      * @param options.retry_count - 重试次数
      */
     async sendMsg(uid, contact, elements, options = { recallMsg: 0, retry_count: 1 }) {
+        /** 结果 */
+        let result = {};
         /** 先调用中间件 */
         for (const info of pluginLoader.use.sendMsg) {
             try {
                 let next = false;
+                let exit = false;
                 const nextFn = () => { next = true; };
-                await info.fn(uid, contact, elements, nextFn);
+                const exitFn = () => { exit = true; };
+                await info.fn(uid, contact, elements, nextFn, exitFn);
+                if (exit) {
+                    const plugin = pluginLoader.plugin.get(info.key);
+                    logger.debug(`[消息中间件][${plugin.plugin}][${plugin.file}] 主动操作退出`);
+                    return result;
+                }
                 if (!next)
                     break;
             }
@@ -196,8 +205,6 @@ export class Listeners extends EventEmitter {
         const { recallMsg, retry_count } = options;
         /** 标准化 */
         const NewElements = common.makeMessage(elements);
-        /** 结果 */
-        let result = {};
         const reply_log = common.makeMessageLog(NewElements);
         const self_id = bot.account.uid || bot.account.uin;
         if (contact.scene === 'group') {

package/lib/core/plugin/loader.d.ts

@@ -55,7 +55,7 @@ declare class PluginLoader {
         [key: string]: PluginHandlerInfoType[];
     };
     /** plugin基本信息 */
-    plugin: PluginInfoType;
+    plugin: Map<number, PluginInfoType>;
     /** task定时任务信息 */
     task: PluginTaskInfoType[];
     /** 中间件 */

package/lib/core/plugin/loader.js

@@ -49,7 +49,7 @@ class PluginLoader {
         this.button = [];
         this.command = [];
         this.handler = {};
-        this.plugin = {};
+        this.plugin = new Map();
         this.task = [];
         this.use = {
             recvMsg: [],
@@ -312,7 +312,7 @@ class PluginLoader {
         try {
             const index = ++this.index;
             /** 缓存基本信息 */
-            this.plugin[index] = { type, plugin, path: _path, file };
+            this.plugin.set(index, { type, plugin, path: _path, file });
             const list = [];
             let rootPath = 'file://' + path.join(process.cwd(), type === 'npm' ? 'node_modules' : 'plugins', plugin, _path, file);
             if (isOrderBy)
@@ -422,7 +422,7 @@ class PluginLoader {
                     name: info.name,
                     event: info.event,
                     fn: info.fn,
-                    key: index + '',
+                    key: index,
                     log: info.log,
                     rank: info.rank,
                 });
@@ -433,7 +433,7 @@ class PluginLoader {
                     name: info.name,
                     reg: info.reg,
                     fn: info.fn,
-                    key: index + '',
+                    key: index,
                     rank: info.rank,
                 });
                 return true;
@@ -444,7 +444,7 @@ class PluginLoader {
                 this.handler[info.key].push({
                     name: info.name,
                     fn: info.fn,
-                    key: index + '',
+                    key: index,
                     rank: info.rank,
                 });
                 return true;
@@ -456,7 +456,7 @@ class PluginLoader {
                     event: info.event,
                     fn: info.fn,
                     fnname: info.fnname,
-                    key: index + '',
+                    key: index,
                     log: info.log,
                     perm: info.perm,
                     rank: info.rank,
@@ -470,7 +470,7 @@ class PluginLoader {
                     name: info.name,
                     cron: info.cron,
                     fn: info.fn,
-                    key: index + '',
+                    key: index,
                     taskname: info.fnname,
                     data: App,
                     log: info.log,
@@ -498,7 +498,7 @@ class PluginLoader {
                 this.use[info.key].push({
                     name: info.name,
                     fn: info.fn,
-                    key: index + '',
+                    key: index,
                     rank: info.rank,
                 });
                 return true;
@@ -530,11 +530,10 @@ class PluginLoader {
      * 卸载插件
      */
     uninstallApp(plugin, _path, file) {
-        Object.keys(this.plugin).forEach(key => {
-            const info = this.plugin[key];
+        this.plugin.forEach((info, key) => {
             if (info.plugin === plugin && info.path === _path && info.file === file) {
                 /** 删除缓存 */
-                delete this.plugin[key];
+                this.plugin.delete(key);
                 this.accept = this.accept.filter(val => val.key !== key);
                 this.button = this.button.filter(val => val.key !== key);
                 this.command = this.command.filter(val => val.key !== key);

package/lib/event/handler/base.js

@@ -132,13 +132,27 @@ export class EventBaseHandler {
          * @param options 回复选项
          */
         this.e.reply = async (elements = '', options = { reply: false, recallMsg: 0, at: false, retry_count: 1 }) => {
+            const request = {
+                message_id: '',
+                message_time: 0,
+                raw_data: undefined,
+            };
             const message = common.makeMessage(elements);
             /** 先调用中间件 */
             for (const info of pluginLoader.use.replyMsg) {
                 try {
                     let next = false;
+                    let exit = false;
                     const nextFn = () => { next = true; };
-                    await info.fn(this.e, message, nextFn);
+                    const exitFn = () => { exit = true; };
+                    await info.fn(this.e, message, nextFn, exitFn);
+                    if (exit) {
+                        const plugin = pluginLoader.plugin.get(info.key);
+                        logger.debug(`[消息中间件][${plugin.plugin}][${plugin.file}] 主动操作退出`);
+                        return request;
+                    }
+                    if (!next)
+                        break;
                     if (!next)
                         break;
                 }
@@ -162,11 +176,6 @@ export class EventBaseHandler {
             else {
                 this.e.self_id !== 'input' && logger.bot('info', this.e.self_id, `${logger.green(`Send private ${this.e.user_id}: `)}${ReplyLog}`);
             }
-            const request = {
-                message_id: '',
-                message_time: 0,
-                raw_data: undefined,
-            };
             try {
                 listener.emit('karin:count:send', 1);
                 /** 取结果 */

package/lib/event/handler/message.js

@@ -199,8 +199,15 @@ export class MessageHandler extends EventBaseHandler {
         for (const info of pluginLoader.use.recvMsg) {
             try {
                 let next = false;
+                let exit = false;
                 const nextFn = () => { next = true; };
-                await info.fn(this.e, nextFn);
+                const exitFn = () => { exit = true; };
+                await info.fn(this.e, nextFn, exitFn);
+                if (exit) {
+                    const plugin = pluginLoader.plugin.get(info.key);
+                    logger.debug(`[消息中间件][${plugin.plugin}][${plugin.file}] 主动操作退出`);
+                    return;
+                }
                 if (!next)
                     break;
             }

package/lib/event/handler/review.js

@@ -194,7 +194,7 @@ export const review = new (class Handler {
         /** 同时启用 */
         if (this.App.GroupConfig.enable && this.App.GroupConfig.disable) {
             this.PluginEnable = (app, config) => {
-                const plugin = pluginLoader.plugin[app.key];
+                const plugin = pluginLoader.plugin.get(app.key);
                 /** 白名单不为空 */
                 if (Array.isArray(config.enable) && config.enable.length) {
                     /** 插件包是否处于功能白名单 */
@@ -229,7 +229,7 @@ export const review = new (class Handler {
         /** 白名单启用 */
         if (this.App.GroupConfig.enable) {
             this.PluginEnable = (app, config) => {
-                const plugin = pluginLoader.plugin[app.key];
+                const plugin = pluginLoader.plugin.get(app.key);
                 if (Array.isArray(config.enable) && config.enable.length) {
                     for (const key of config.enable) {
                         if (key.plugin === plugin.plugin)
@@ -247,7 +247,7 @@ export const review = new (class Handler {
         /** 黑名单启用 */
         if (this.App.GroupConfig.disable) {
             this.PluginEnable = (app, config) => {
-                const plugin = pluginLoader.plugin[app.key];
+                const plugin = pluginLoader.plugin.get(app.key);
                 if (Array.isArray(config.disable) && config.disable.length) {
                     for (const key of config.disable) {
                         if (key.plugin === plugin.plugin) {

package/lib/types/plugin/plugin.d.ts

@@ -40,23 +40,21 @@ export declare const enum MethodType {
  * plugin基本信息
  */
 export interface PluginInfoType {
-    [key: string]: {
-        /** 插件包类型 */
-        type: `${AppsType}`;
-        /** 插件包名称 例: `karin-plugin-example` `@karinjs/adapter-qqbot` */
-        plugin: string;
-        /** 插件路径 在type为js下，path为空 */
-        path: string;
-        /** 插件文件名称 index.js index.ts */
-        file: string;
-    };
+    /** 插件包类型 */
+    type: `${AppsType}`;
+    /** 插件包名称 例: `karin-plugin-example` `@karinjs/adapter-qqbot` */
+    plugin: string;
+    /** 插件路径 在type为js下，path为空 */
+    path: string;
+    /** 插件文件名称 index.js index.ts */
+    file: string;
 }
 /**
  * Command规则集信息
  */
 export interface PluginCommandInfoType {
     /** 插件基本信息的映射key */
-    key: string;
+    key: number;
     /** 插件包名称 */
     name: string;
     /** 插件正则 */
@@ -83,7 +81,7 @@ export interface PluginCommandInfoType {
  */
 export interface PluginAcceptInfoType {
     /** 插件基本信息的映射key */
-    key: string;
+    key: number;
     /** 插件包名称 */
     name: string;
     /** 插件执行方法 */
@@ -100,7 +98,7 @@ export interface PluginAcceptInfoType {
  */
 export interface PluginTaskInfoType {
     /** 插件基本信息的映射key */
-    key: string;
+    key: number;
     /** 插件包名称 */
     name: string;
     /** 任务名称 */
@@ -121,7 +119,7 @@ export interface PluginTaskInfoType {
  */
 export interface PluginButtonInfoType {
     /** 插件基本信息的映射key */
-    key: string;
+    key: number;
     /** 插件包名称 */
     name: string;
     /** 插件正则 */
@@ -136,7 +134,7 @@ export interface PluginButtonInfoType {
  */
 export interface PluginHandlerInfoType {
     /** 插件基本信息的映射key */
-    key: string;
+    key: number;
     /** 插件包名称 */
     name: string;
     /** handler的处理方法 */
@@ -151,22 +149,24 @@ export interface PluginMiddlewareInfoType {
     /** 初始化消息前 */
     recvMsg: Array<{
         /** 插件基本信息的映射key */
-        key: string;
+        key: number;
         /** 插件包名称 */
         name: string;
         /** 插件执行方法 */
         fn: (
         /** 消息事件方法 */
         e: KarinMessageType, 
-        /** 是否继续执行插件 */
-        next: Function) => Promise<boolean>;
+        /** 是否继续执行下一个中间件 */
+        next: Function, 
+        /** 是否退出此条消息 不再执行匹配插件 */
+        exit: Function) => Promise<boolean>;
         /** 优先级 */
         rank: number;
     }>;
     /** 回复消息前 */
     replyMsg: Array<{
         /** 插件基本信息的映射key */
-        key: string;
+        key: number;
         /** 插件包名称 */
         name: string;
         /** 插件执行方法 */
@@ -175,15 +175,17 @@ export interface PluginMiddlewareInfoType {
         e: KarinMessageType, 
         /** 回复的消息体 */
         element: KarinElement[], 
-        /** 是否继续执行插件 */
-        next: Function) => Promise<boolean>;
+        /** 是否继续执行下一个中间件 */
+        next: Function, 
+        /** 是否不发送此条消息 */
+        exit: Function) => Promise<boolean>;
         /** 优先级 */
         rank: number;
     }>;
     /** 发送主动消息前 */
     sendMsg: Array<{
         /** 插件基本信息的映射key */
-        key: string;
+        key: number;
         /** 插件包名称 */
         name: string;
         /** 插件执行方法 */
@@ -194,8 +196,10 @@ export interface PluginMiddlewareInfoType {
         contact: Contact, 
         /** 发送的消息体 */
         element: KarinElement[], 
-        /** 是否继续执行插件 */
-        next: Function) => Promise<boolean>;
+        /** 是否继续执行下一个中间件 */
+        next: Function, 
+        /** 是否不发送此条消息 */
+        exit: Function) => Promise<boolean>;
         /** 优先级 */
         rank: number;
     }>;

package/lib/utils/common/common.d.ts

@@ -85,6 +85,16 @@ declare class Common {
      * - 写入yaml文件
      */
     writeYaml(file: string, data: any): boolean;
+    /**
+     * 输入包名 返回包根目录的绝对路径 仅简单查找
+     * @param name - 包名
+     * @param _path - 导入包的路径 此项适用于在插件中读取插件的依赖包
+     * @returns - 包根目录的绝对路径
+     * @example
+     * common.pkgroot('axios')
+     * common.pkgroot('axios', import.meta.url)
+     */
+    pkgroot(name: string, _path?: string): string;
     /**
      * 根据文件后缀名从指定路径下读取符合要求的文件
      * @param path - 路径

package/lib/utils/common/common.js

@@ -5,6 +5,7 @@ import axios from 'axios';
 import lodash from 'lodash';
 import { promisify } from 'util';
 import { fileURLToPath } from 'url';
+import { createRequire } from 'module';
 import { pipeline, Readable } from 'stream';
 import { logger, segment, YamlEditor } from '../../utils/index.js';
 /**
@@ -190,6 +191,32 @@ class Common {
             return false;
         }
     }
+    /**
+     * 输入包名 返回包根目录的绝对路径 仅简单查找
+     * @param name - 包名
+     * @param _path - 导入包的路径 此项适用于在插件中读取插件的依赖包
+     * @returns - 包根目录的绝对路径
+     * @example
+     * common.pkgroot('axios')
+     * common.pkgroot('axios', import.meta.url)
+     */
+    pkgroot(name, _path) {
+        const require = createRequire(_path || import.meta.url);
+        let dir = require.resolve(name);
+        if (fs.existsSync(path.join(dir, 'package.json')))
+            return path.resolve(dir);
+        /** 递归查找 如果跳过了node_modules 则返回null */
+        while (true) {
+            /** 向上 */
+            dir = path.dirname(dir);
+            if (fs.existsSync(path.join(dir, 'package.json')))
+                return path.resolve(dir);
+            /** 加个处理 防止无线递归 */
+            if (dir === path.dirname(dir)) {
+                throw new Error(`[common] 未找到包${name}的根目录`);
+            }
+        }
+    }
     /**
      * 根据文件后缀名从指定路径下读取符合要求的文件
      * @param path - 路径
@@ -204,7 +231,6 @@ class Common {
         const list = [];
         if (!Array.isArray(ext))
             ext = [ext];
-        // 排除文件夹 和不符合后缀名的文件
         files.forEach(v => {
             if (v.isDirectory())
                 return;
@@ -380,7 +406,7 @@ class Common {
      */
     async getNpmPlugins(showDetails) {
         /** 屏蔽的依赖包列表 */
-        const exclude = ['art-template', 'axios', 'chalk', 'chokidar', 'express', 'level', 'lodash', 'log4js', 'moment', 'node-karin', 'node-schedule', 'redis', 'ws', 'yaml'];
+        const exclude = ['art-template', 'axios', 'chalk', 'chokidar', 'commander', 'express', 'level', 'lodash', 'log4js', 'moment', 'node-karin', 'node-schedule', 'redis', 'ws', 'yaml'];
         const pkg = this.readJson('./package.json');
         const dependencies = Object.keys(pkg.dependencies).filter((name) => !exclude.includes(name));
         if (!showDetails) {

package/lib/utils/core/handler.js

@@ -12,7 +12,7 @@ export const handler = new (class EventHandler {
     async call(key, args) {
         let res;
         for (const info of loader.handler[key] || []) {
-            const plugin = loader.plugin[info.key];
+            const plugin = loader.plugin.get(info.key);
             try {
                 let done = true;
                 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-karin",
-  "version": "0.11.4",
+  "version": "0.11.5",
   "private": false,
   "description": "基于 Kritor 进行开发的nodejs机器人框架",
   "homepage": "https://github.com/KarinJS/Karin",
@@ -140,7 +140,7 @@
   },
   "dependencies": {
     "art-template": "4.13.2",
-    "axios": "1.7.2",
+    "axios": "1.7.3",
     "chalk": "5.3.0",
     "chokidar": "3.6.0",
     "commander": "^12.1.0",
@@ -150,9 +150,9 @@
     "log4js": "6.9.1",
     "moment": "2.30.1",
     "node-schedule": "2.1.1",
-    "redis": "4.6.15",
+    "redis": "4.7.0",
     "ws": "8.18.0",
-    "yaml": "2.4.5"
+    "yaml": "2.5.0"
   },
   "devDependencies": {
     "@types/express": "^4.17.21",