node-karin 0.11.14 → 0.12.0

package/lib/utils/tools/exec.js

@@ -6,41 +6,43 @@ import { exec as execCmd } from 'child_process';
  * @param log 是否打印日志
  * @param options 选项
  */
-export const exec = (cmd, log = true, options = { cwd: process.cwd(), encoding: 'utf-8' }) => {
+export const exec = async (cmd, log = true, options = { cwd: process.cwd() }) => {
+    const logType = (status) => ({
+        start: '[exec][开始执行]',
+        ok: '[exec][执行成功]',
+        failed: '[exec][执行失败]',
+    })[status];
+    const logMessage = (status, details = '') => {
+        if (log) {
+            const colorFunc = {
+                start: logger.yellow,
+                ok: logger.green,
+                failed: logger.red,
+            }[status];
+            logger.info([
+                colorFunc(logType(status)),
+                `cmd: ${cmd}`,
+                `cwd: ${options.cwd}`,
+                details,
+                '--------',
+            ].join('\n'));
+        }
+    };
+    logMessage('start');
     return new Promise(resolve => {
-        const logMessage = (level, message) => {
-            if (log)
-                logger[level](message);
-        };
-        const logType = (status) => {
-            switch (status) {
-                case '开始执行':
-                    return logger.yellow('[exec][开始执行]');
-                case 'ok':
-                    return logger.green('[exec][执行成功]');
-                case 'failed':
-                    return logger.red('[exec][执行失败]');
-            }
-        };
-        const formatMessage = (status, details) => [logType(status), `cmd: ${cmd}`, `cwd: ${options.cwd || process.cwd()}`, details, '--------'].join('\n');
-        logMessage('info', formatMessage('开始执行', ''));
-        execCmd(cmd, options, (error, stdout, stderr) => {
-            if (error) {
-                logMessage('error', formatMessage('failed', `Error: ${error.message || error.stack || error.toString()}`));
-                return resolve({ status: 'failed', error, stdout, stderr });
-            }
-            logMessage('mark', formatMessage('ok', `stdout: ${stdout}\nstderr: ${stderr}`));
-            resolve({ status: 'ok', error, stdout, stderr });
+        execCmd(cmd, options, (error, stdout = '', stderr = '') => {
+            const status = error ? 'failed' : 'ok';
+            logMessage(status, error ? `Error: ${error.message}` : `stdout: ${stdout}\nstderr: ${stderr}`);
+            resolve({ status, error, stdout, stderr });
         });
     });
 };
 /**
  * 执行 shell 命令
  * @param cmd 命令
- * @param log 是否打印日志
  * @param options 选项
  */
-export const execs = (cmd, options = { cwd: process.cwd(), encoding: 'utf-8' }) => {
+export const execs = (cmd, options = { cwd: process.cwd() }) => {
     return new Promise((resolve, reject) => {
         execCmd(cmd, options, (error, stdout) => {
             if (error)

package/lib/utils/tools/ffmpeg.d.ts

@@ -7,6 +7,6 @@ export declare function ffmpeg(): Promise<false | ((cmd: string, log?: boolean,
 }) => Promise<{
     status: "ok" | "failed";
     error: Error | null;
-    stdout: string | "";
-    stderr: string | "";
+    stdout: string;
+    stderr: string;
 }>)>;

package/lib/utils/tools/restart.d.ts

@@ -0,0 +1,15 @@
+import { Contact } from '../../types/index.js';
+/**
+ * 重启Bot
+ * @param self_id - 机器人的id 传e.self_id
+ * @param contact - 事件联系人信息 也就是从哪来的这条消息 传e.contact即可
+ * @param message_id - 消息id 传e.message_id
+ * @param isFront - 是否为前台重启 默认是
+ */
+export declare const restart: (self_id: string, contact: Contact, message_id: string, isFront?: boolean) => Promise<{
+    status: string;
+    data: string;
+} | {
+    status: string;
+    data: Error | null;
+}>;

package/lib/utils/tools/restart.js

@@ -0,0 +1,39 @@
+import exec from './exec.js';
+import { level } from '../../db/index.js';
+import { config } from '../config/config.js';
+/**
+ * 重启Bot
+ * @param self_id - 机器人的id 传e.self_id
+ * @param contact - 事件联系人信息 也就是从哪来的这条消息 传e.contact即可
+ * @param message_id - 消息id 传e.message_id
+ * @param isFront - 是否为前台重启 默认是
+ */
+export const restart = async (self_id, contact, message_id, isFront = true) => {
+    const options = {
+        id: self_id,
+        contact,
+        message_id,
+        time: Date.now(),
+    };
+    const key = `karin:restart:${options.id}`;
+    await level.set(key, options);
+    if (isFront) {
+        if (!process.send)
+            return { status: 'failed', data: '前台重启失败，当前环境不支持，仅支持【npx karin start】启动的环境' };
+        process.send({ action: 'result', env: process.env });
+        process.exit();
+    }
+    if (!config.Config.pm2Restart)
+        process.exit();
+    if (process.env.pm_id) {
+        const pm2 = await exec('npx karin rs');
+        if (pm2.status === 'ok')
+            process.exit();
+        return { status: 'failed', data: pm2.error };
+    }
+    /** 调用pm2启动 */
+    const pm2 = await exec('npx karin pm2');
+    if (pm2.status === 'ok')
+        process.exit();
+    return { status: 'failed', data: pm2.error };
+};

package/lib/utils/tools/stop.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 停止Bot
+ */
+export declare const stop: () => Promise<{
+    status: string;
+    data: Error | null;
+}>;

package/lib/utils/tools/stop.js

@@ -0,0 +1,13 @@
+import exec from './exec.js';
+/**
+ * 停止Bot
+ */
+export const stop = async () => {
+    if (process.env.pm_id) {
+        const pm2 = await exec('pm2 delete ' + process.env.pm_id);
+        if (pm2.status === 'ok')
+            process.exit();
+        return { status: 'failed', data: pm2.error };
+    }
+    process.exit();
+};

package/lib/utils/tools/update.d.ts

@@ -1,75 +1,22 @@
-import fs from 'fs';
-export declare const update: {
+export declare class Updates {
     dir: string;
+    constructor();
     /**
-     * 更新框架或插件
-     * @param path - 插件相对路径
-     * @param cmd - 更新命令 默认git pull
-     * @param time - 超时时间 默认120s
-     */
-    update(path: string, cmd?: string, time?: number): Promise<{
-        status: string;
-        data: string;
-    }>;
-    /**
-     * 获取指定仓库最后一次提交时间日期
-     * @param path - 插件相对路径
-     */
-    getTime(path: string): Promise<string>;
-    /**
-     * 获取指定仓库最后一次提交哈希值
-     * @param {string} path - 插件相对路径
-     * @param {boolean} [short] - 是否获取短哈希 默认true
-     * @returns {Promise<string>}
-     */
-    getHash(path: string, short?: boolean): Promise<string>;
-    /**
-     * 获取指定仓库的提交记录
-     * @param {{
-     *  path: string,
-     *  count?: number,
-     *  hash?: string
-     * }} options - 参数
-     * @param {string} options.path - 插件相对路径
-     * @param {number} [options.count] - 获取日志条数 默认1条
-     * @param {string} [options.hash] - 指定HEAD
-     * @returns {Promise<string>}
+     * 更新npm包
+     * @param name - 包名
+     * @param timeout - 超时时间 默认120s
      */
-    getCommit(options: {
-        path: any;
-        count?: any;
-        hash?: any;
-        branch?: any;
-    }): Promise<string>;
-    /**
-     * 检查插件是否有更新
-     * @param {string} path - 插件相对路径
-     * @param {number} [time] - 超时时间 默认120s
-     * @returns {Promise<{status: 'ok'|'failed', data: string|boolean}>}
-     */
-    checkUpdate(path: fs.PathLike, time?: number): Promise<{
-        status: string;
-        data: string | undefined;
-        count?: undefined;
-    } | {
-        status: string;
-        data: boolean;
-        count?: undefined;
-    } | {
-        status: string;
+    updatePkg(name: string, timeout?: number): Promise<{
+        status: boolean;
         data: string;
-        count: string | number;
     }>;
-};
-export declare const Update: {
-    dir: string;
     /**
      * 更新框架或插件
      * @param path - 插件相对路径
      * @param cmd - 更新命令 默认git pull
-     * @param time - 超时时间 默认120s
+     * @param timeout - 超时时间 默认120s
      */
-    update(path: string, cmd?: string, time?: number): Promise<{
+    update(path: string, cmd?: string, timeout?: number): Promise<{
         status: string;
         data: string;
     }>;
@@ -80,36 +27,29 @@ export declare const Update: {
     getTime(path: string): Promise<string>;
     /**
      * 获取指定仓库最后一次提交哈希值
-     * @param {string} path - 插件相对路径
-     * @param {boolean} [short] - 是否获取短哈希 默认true
-     * @returns {Promise<string>}
+     * @param path - 插件相对路径
+     * @param short - 是否获取短哈希 默认true
      */
     getHash(path: string, short?: boolean): Promise<string>;
     /**
      * 获取指定仓库的提交记录
-     * @param {{
-     *  path: string,
-     *  count?: number,
-     *  hash?: string
-     * }} options - 参数
-     * @param {string} options.path - 插件相对路径
-     * @param {number} [options.count] - 获取日志条数 默认1条
-     * @param {string} [options.hash] - 指定HEAD
-     * @returns {Promise<string>}
      */
     getCommit(options: {
-        path: any;
-        count?: any;
-        hash?: any;
-        branch?: any;
+        /** 指令命令路径 */
+        path: string;
+        /** 获取几次提交 默认1次 */
+        count?: number;
+        /** 指定哈希 */
+        hash?: string;
+        /** 指定分支 */
+        branch?: string;
     }): Promise<string>;
     /**
      * 检查插件是否有更新
-     * @param {string} path - 插件相对路径
-     * @param {number} [time] - 超时时间 默认120s
-     * @returns {Promise<{status: 'ok'|'failed', data: string|boolean}>}
+     * @param path - 插件相对路径
+     * @param time - 超时时间 默认120s
      */
-    checkUpdate(path: fs.PathLike, time?: number): Promise<{
+    checkUpdate(path: string, time?: number): Promise<{
         status: string;
         data: string | undefined;
         count?: undefined;
@@ -120,6 +60,8 @@ export declare const Update: {
     } | {
         status: string;
         data: string;
-        count: string | number;
+        count: number;
     }>;
-};
+}
+export declare const update: Updates;
+export declare const Update: Updates;

package/lib/utils/tools/update.js

@@ -1,17 +1,39 @@
 import fs from 'fs';
 import exec from './exec.js';
-export const update = new (class Update {
+import { KarinCli } from '../../cli/index.js';
+import { getRegistry } from '../../cli/pkg.js';
+export class Updates {
     dir;
     constructor() {
         this.dir = './plugins';
     }
+    /**
+     * 更新npm包
+     * @param name - 包名
+     * @param timeout - 超时时间 默认120s
+     */
+    async updatePkg(name, timeout = 120) {
+        const pkg = getRegistry();
+        const cmd = (pkg === 'yarn' ? 'yarn upgrade' : `${pkg} update`) + `${name}@latest`;
+        /** 检查是否已经是最新版本 */
+        const tools = new KarinCli();
+        const local = await tools.getLocalVersion(name, pkg);
+        const remote = await tools.getRemoteVersion(name, pkg);
+        logger.info(`[依赖更新] ${name} 当前版本: ${local} 最新版本: ${remote}`);
+        if (local === remote)
+            return { status: true, data: `${name} 已经是最新版本~` };
+        const npm = await exec(cmd, true, { cwd: process.cwd(), timeout: timeout * 1000 });
+        if (npm.status === 'ok')
+            return { status: true, data: `${name} 更新完成~` };
+        return { status: false, data: `${name} 更新失败: ${npm.error?.message}` };
+    }
     /**
      * 更新框架或插件
      * @param path - 插件相对路径
      * @param cmd - 更新命令 默认git pull
-     * @param time - 超时时间 默认120s
+     * @param timeout - 超时时间 默认120s
      */
-    async update(path, cmd = 'git pull', time = 120) {
+    async update(path, cmd = 'git pull', timeout = 120) {
         /** 检查一下路径是否存在 */
         if (!fs.existsSync(path))
             return { status: 'failed', data: '路径不存在' };
@@ -21,7 +43,7 @@ export const update = new (class Update {
         /** 设置超时时间 */
         const timer = setTimeout(() => {
             return { status: 'failed', data: '执行超时' };
-        }, time * 1000);
+        }, timeout * 1000);
         const options = { env: process.env, cwd: path, encoding: 'utf-8' };
         /** 记录当前短哈希 */
         const hash = await this.getHash(path);
@@ -36,17 +58,17 @@ export const update = new (class Update {
                 const time = await this.getTime(path);
                 return {
                     status: 'ok',
-                    data: ['\n当前版本已是最新版本', `Hash: ${hash}`, `最后更新：${await this.getCommit({ path, count: 1 })}`, `最后提交时间：${time}`].join('\n'),
+                    data: `\n当前版本已是最新版本\n最后更新时间：${time}\n更新详情：${await this.getCommit({ path, count: 1 })}`,
                 };
             }
             const Commit = await this.getCommit({ path, hash });
             return {
                 status: 'ok',
-                data: ['\n更新成功', `当前Hash: ${newHash}`, `更新日志：\n${Commit}`].join('\n'),
+                data: `\n更新成功\n更新日志：\n${Commit}`,
             };
         }
-        const msg = ['\n更新失败', `当前Hash: ${hash}`, `错误信息：${error?.message?.toString() || error?.stack?.toString() || error?.toString()}`, '请解决错误后重试或执行【#强制更新】'];
-        return { status: 'failed', data: msg.join('\n') };
+        const data = `\n更新失败\n错误信息：${error?.stack?.toString() || error?.message?.toString() || error?.toString() || error}\n请解决错误后重试或执行【#强制更新】`;
+        return { status: 'failed', data };
     }
     /**
      * 获取指定仓库最后一次提交时间日期
@@ -54,20 +76,19 @@ export const update = new (class Update {
      */
     async getTime(path) {
         const cmd = 'git log -1 --format=%cd --date=format:"%Y-%m-%d %H:%M:%S"';
-        const data = await exec(cmd, false, { cwd: path, encoding: 'utf-8' });
+        const data = await exec(cmd, false, { cwd: path });
         if (data.status === 'failed')
             return '获取时间失败，请重试或更新Git~';
         return data.stdout.trim();
     }
     /**
      * 获取指定仓库最后一次提交哈希值
-     * @param {string} path - 插件相对路径
-     * @param {boolean} [short] - 是否获取短哈希 默认true
-     * @returns {Promise<string>}
+     * @param path - 插件相对路径
+     * @param short - 是否获取短哈希 默认true
      */
     async getHash(path, short = true) {
         const cmd = short ? 'git rev-parse --short HEAD' : 'git rev-parse HEAD';
-        const data = await exec(cmd, false, { cwd: path, encoding: 'utf-8' });
+        const data = await exec(cmd, false, { cwd: path });
         if (data.status === 'failed') {
             const text = data.error;
             throw new Error(text);
@@ -76,15 +97,6 @@ export const update = new (class Update {
     }
     /**
      * 获取指定仓库的提交记录
-     * @param {{
-     *  path: string,
-     *  count?: number,
-     *  hash?: string
-     * }} options - 参数
-     * @param {string} options.path - 插件相对路径
-     * @param {number} [options.count] - 获取日志条数 默认1条
-     * @param {string} [options.hash] - 指定HEAD
-     * @returns {Promise<string>}
      */
     async getCommit(options) {
         const { path, count = 1, hash, branch } = options;
@@ -95,7 +107,7 @@ export const update = new (class Update {
         /** 指定分支 */
         if (branch)
             cmd = `git log -${count} ${branch} --format="[%ad] %s %n" --date="format:%m-%d %H:%M"`;
-        const data = await exec(cmd, false, { cwd: path, encoding: 'utf-8' });
+        const data = await exec(cmd, false, { cwd: path });
         if (data.status === 'failed') {
             const text = data.error;
             throw new Error(text);
@@ -104,9 +116,8 @@ export const update = new (class Update {
     }
     /**
      * 检查插件是否有更新
-     * @param {string} path - 插件相对路径
-     * @param {number} [time] - 超时时间 默认120s
-     * @returns {Promise<{status: 'ok'|'failed', data: string|boolean}>}
+     * @param path - 插件相对路径
+     * @param time - 超时时间 默认120s
      */
     async checkUpdate(path, time = 120) {
         /** 检查一下路径是否存在 */
@@ -131,9 +142,10 @@ export const update = new (class Update {
         if (stdout.includes('Your branch is up to date with'))
             return { status: 'ok', data: false };
         /** 获取落后几次更新 */
-        const count = stdout.match(/Your branch is behind '.*' by (\d+) commits/)?.[1] || 1;
+        const count = Number(stdout.match(/Your branch is behind '.*' by (\d+) commits/)?.[1]) || 1;
         const data = await this.getCommit({ path, count, branch: 'origin' });
         return { status: 'ok', data, count };
     }
-})();
+}
+export const update = new Updates();
 export const Update = update;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-karin",
-  "version": "0.11.14",
+  "version": "0.12.0",
   "private": false,
   "description": "基于 Kritor 进行开发的nodejs机器人框架",
   "homepage": "https://github.com/KarinJS/Karin",
@@ -133,7 +133,7 @@
   ],
   "scripts": {
     ".": "node lib/cli/start.js .",
-    "build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json",
+    "build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json && npm run fix:all",
     "build:npm": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json",
     "dev": "node lib/cli/start.js dev",
     "fix": "eslint lib/**/*.js --fix",
@@ -143,12 +143,18 @@
     "start": "node lib/cli/start.js start"
   },
   "dependencies": {
+    "@types/express": "^4.17.21",
+    "@types/lodash": "^4.17.7",
+    "@types/node": "^22.5.0",
+    "@types/node-schedule": "^2.1.7",
+    "@types/ws": "^8.5.12",
     "art-template": "4.13.2",
-    "axios": "1.7.3",
+    "axios": "1.7.5",
     "chalk": "5.3.0",
     "chokidar": "3.6.0",
     "commander": "^12.1.0",
     "express": "4.19.2",
+    "jimp": "^0.22.12",
     "level": "8.0.1",
     "lodash": "4.17.21",
     "log4js": "6.9.1",

package/lib/render/client_even.d.ts

@@ -1,30 +0,0 @@
-import WebSocket from 'ws';
-import { RenderBase } from './base.js';
-import { KarinRenderType, RenderResult } from '../types/index.js';
-export declare class RenderClientEven extends RenderBase {
-    url: string;
-    type: string;
-    id: string;
-    index: number;
-    retry: number;
-    reg: RegExp;
-    ws: WebSocket;
-    constructor(url: string);
-    /**
-     * 初始化
-     */
-    start(): Promise<void>;
-    /**
-     * 创建连接
-     */
-    link(): Promise<void>;
-    /**
-     * 接受消息
-     */
-    message(str: string): Promise<void>;
-    /**
-     * 渲染标准方法
-     * @param options 渲染参数
-     */
-    render<T extends KarinRenderType>(options: T): Promise<RenderResult<T>>;
-}

package/lib/render/client_even.js

@@ -1,156 +0,0 @@
-import fs from 'fs';
-import axios from 'axios';
-import WebSocket from 'ws';
-import { render } from './app.js';
-import { RenderBase } from './base.js';
-import { createHash, randomUUID } from 'crypto';
-import { listener } from '../core/index.js';
-import { logger } from '../utils/index.js';
-export class RenderClientEven extends RenderBase {
-    url;
-    type;
-    id;
-    index;
-    retry;
-    reg;
-    ws;
-    constructor(url) {
-        super();
-        this.url = url;
-        this.type = 'image';
-        this.id = 'puppeteer';
-        this.index = 0;
-        this.retry = 0;
-        this.reg = new RegExp(`(${process.cwd().replace(/\\/g, '\\\\')}|${process.cwd().replace(/\\/g, '/')})`, 'g');
-    }
-    /**
-     * 初始化
-     */
-    async start() {
-        try {
-            const response = await axios.head(this.url);
-            if (response.status === 200) {
-                logger.mark(`[渲染器:${this.id}][WebSocket] 注册渲染器：${logger.green(this.url)}`);
-                try {
-                    this.index = render.app({ id: this.id, type: this.type, render: this.render.bind(this) });
-                }
-                catch (error) {
-                    logger.error(`[渲染器:${this.id}] 注册渲染器失败：`, error);
-                }
-            }
-            else {
-                logger.error(`[渲染器:${this.id}] 注册渲染器失败：渲染器发生错误`);
-            }
-        }
-        catch (error) {
-            logger.error(`[渲染器:${this.id}] 注册渲染器失败：`, error);
-        }
-    }
-    /**
-     * 创建连接
-     */
-    async link() {
-        return new Promise((resolve, reject) => {
-            if (this.ws && this.ws.readyState === WebSocket.OPEN) {
-                return resolve();
-            }
-            /** 连接ws */
-            this.ws = new WebSocket(this.url);
-            /** 建立连接 */
-            this.ws.on('open', () => {
-                logger.mark(`[渲染器:${this.id}][WebSocket] 建立连接：${logger.green(this.url)}`);
-                /** 监听消息 */
-                this.ws.on('message', data => this.message(data.toString()));
-                resolve();
-            });
-            /** 监听断开 */
-            this.ws.once('close', async () => {
-                /** 停止监听 */
-                this.ws.removeAllListeners();
-            });
-            /** 监听错误 */
-            this.ws.on('error', async (e) => {
-                this.ws.close();
-            });
-        });
-    }
-    /**
-     * 接受消息
-     */
-    async message(str) {
-        const data = JSON.parse(str);
-        switch (data.action) {
-            /** 静态文件 */
-            case 'static': {
-                const filePath = decodeURIComponent(data.params.file);
-                logger.debug(`[渲染器:${this.id}][正向WS] 访问静态文件：${filePath}`);
-                const file = fs.readFileSync('.' + filePath);
-                const md5 = createHash('md5').update(file).digest('hex');
-                const params = data.params.md5?.includes(md5)
-                    ? { echo: data.echo, action: 'static', status: 'ok', data: { verifiedMd5: md5 } }
-                    : { echo: data.echo, action: 'static', status: 'ok', data: { file } };
-                return this.ws.send(JSON.stringify(params));
-            }
-            /** 渲染结果 */
-            case 'renderRes': {
-                listener.emit(data.echo, data);
-                break;
-            }
-            /** 超时 */
-            case 'timeout': {
-                logger.debug(`[渲染器:${this.id}][正向WS] 处理超时`);
-                break;
-            }
-            /** 未知数据 */
-            default: {
-                logger.warn(`[渲染器:${this.id}] 收到未知数据：`, data);
-            }
-        }
-    }
-    /**
-     * 渲染标准方法
-     * @param options 渲染参数
-     */
-    async render(options) {
-        /** 渲染模板 */
-        let file = options.file;
-        let action = 'renderHtml';
-        if (options.file.includes('http') || options.vue) {
-            action = 'render';
-        }
-        else {
-            file = this.dealTpl(options);
-            /** 判断是本地karin-puppeteer还是远程 */
-            if (!/127\.0\.0\.1|localhost/.test(this.url)) {
-                file = fs.readFileSync(file, 'utf-8').replace(this.reg, '');
-            }
-            else {
-                action = 'render';
-                file = 'file://' + file;
-            }
-        }
-        if (!file) {
-            logger.error(`[渲染器:${this.id}:${this.index}] 渲染文件不存在：${options.file}`);
-            return '';
-        }
-        /** 编码 */
-        file = encodeURIComponent(file);
-        const data = options;
-        const echo = randomUUID();
-        /** 移除掉模板参数 */
-        if (data.data)
-            delete data.data;
-        data.file = file;
-        const req = JSON.stringify({ echo, action, data });
-        logger.debug(`[渲染器:${this.id}:${this.index}][正向WS] 请求：${this.url} \nhtml: ${options.file} \ndata: ${JSON.stringify(data)}`);
-        await this.link();
-        this.ws.send(req);
-        return new Promise((resolve, reject) => {
-            listener.once(echo, (data) => {
-                if (data.ok)
-                    return resolve(data.data);
-                reject(new Error(JSON.stringify(data)));
-            });
-        });
-    }
-}