@karinjs/adapter-qqbot 1.2.9 → 1.2.10

package/lib/utils/common.js

@@ -1,210 +1,198 @@
-import fs from 'fs';
-import Jimp from 'jimp';
+import fs from 'node:fs';
 import qrcode from 'qrcode';
-import { basename } from './dir.js';
-import { encode, isSilk } from 'silk-wasm';
+import size from 'image-size';
 import lodash from 'node-karin/lodash';
+import EventEmitter from 'node:events';
 import GetUrls from '@karinjs/geturls';
-import { config, execs, logger, common as karinCommon, segment } from 'node-karin';
-import path from 'path';
-class Common {
-    /** ffmpeg */
-    ffmpeg;
-    constructor() {
-        this.ffmpeg = '';
-        this.initFfmpeg();
-    }
-    random(min, max) {
-        return lodash.random(min, max);
-    }
-    /**
-       * 语音转silk
-       * @param voice - 语音文件
-       * @returns silk buffer
-       */
-    async voiceToSilk(voice) {
-        if (!this.ffmpeg)
-            throw TypeError('ffmpeg未安装，请安装 ffmpeg 或者 配置ffmpeg_path');
-        const time = Date.now();
-        const dir = `${process.cwd()}/temp/${basename}/${Date.now()}`;
-        let voicePath = dir;
-        /** 传入的是路径 则直接使用 */
-        if (fs.existsSync(voice)) {
-            const buffer = fs.readFileSync(voice);
-            if (isSilk(buffer))
-                return `base64://${Buffer.from(buffer).toString('base64')}`;
-            voicePath = path.resolve(voice);
-        }
-        else {
-            /** 保存到本地 */
-            const buffer = await karinCommon.buffer(voice);
-            if (isSilk(buffer))
-                return `base64://${Buffer.from(buffer).toString('base64')}`;
-            fs.writeFileSync(dir, buffer);
-        }
-        const pcmPath = `${dir}.pcm`;
-        const silkPath = `${dir}.silk`;
-        const command = `${this.ffmpeg} -i ${voicePath} -f s16le -ar 48000 -ac 1 ${pcmPath}`;
-        await execs(command);
-        logger.info('pcm文件转换成功 开始转码为silk文件');
-        const buffer = await fs.promises.readFile(pcmPath);
-        const silk = await encode(buffer, 48000);
-        logger.info(`silk文件转码成功 音频时长: ${logger.yellow(silk.duration + 'ms')} 转码耗时: ${logger.yellow(Date.now() - time + 'ms')}`);
-        /** dev模式下生成silk文件并保留 */
-        if (process.env.karin_app_mode === 'dev') {
-            await fs.promises.writeFile(silkPath, Buffer.from(silk.data));
-            logger.info(`silk文件已生成: ${logger.yellow(silkPath)}`);
-        }
-        else {
-            /** 非dev删除文件 */
-            fs.promises.unlink(voicePath);
-            fs.promises.unlink(pcmPath);
-        }
-        return `base64://${Buffer.from(silk.data).toString('base64')}`;
-    }
-    /**
-       * 初始化ffmpeg
-       */
-    async initFfmpeg() {
-        try {
-            /** 环境变量 */
-            await execs('ffmpeg -version');
-            this.ffmpeg = 'ffmpeg';
-        }
-        catch {
-            /** 环境变量没有读配置 */
-            const ffmpeg_path = config.Config.ffmpeg_path;
-            if (!ffmpeg_path)
-                return logger.error(logger.red('ffmpeg未安装，请安装 ffmpeg 或者 配置ffmpeg_path'));
-            /** 检查文件是否存在 */
-            if (!fs.existsSync(ffmpeg_path))
-                return logger.error(logger.red('ffmpeg_path配置错误，请检查文件是否存在'));
-            this.ffmpeg = `"${ffmpeg_path}"`;
-        }
-    }
-    /**
-       * 处理URL
-       * @param url - URL
-       * @param exclude - 排除的URL
-       */
-    getUrls(url, exclude = []) {
-        /** 中文不符合url规范 */
-        url = url.replace(/[\u4e00-\u9fa5]/g, '|');
-        const urls = GetUrls.getUrls(url, {
-            exclude,
-            /** 去除 WWW */
-            stripWWW: false,
-            /** 规范化协议 */
-            normalizeProtocol: false,
-            /** 移除查询参数 */
-            removeQueryParameters: false,
-            /** 移除唯一斜杠 */
-            removeSingleSlash: false,
-            /** 查询参数排序 */
-            sortQueryParameters: false,
-            /** 去除认证信息 */
-            stripAuthentication: false,
-            /** 去除文本片段 */
-            stripTextFragment: false,
-            /** 移除末尾斜杠 */
-            removeTrailingSlash: false,
-            /** 不进行标准处理url */
-            normalize: false,
-        });
-        return urls;
+import { encode, isSilk } from 'silk-wasm';
+import { common, ffmpeg, logger, segment, tempPath } from 'node-karin';
+/**
+ * 事件总线
+ */
+export const event = new EventEmitter();
+/**
+ * 睡眠函数
+ * @param ms - 毫秒
+ */
+export const sleep = (ms) => new Promise(resolve => setTimeout(resolve, ms));
+/**
+ * 生成随机数
+ * @param min - 最小值
+ * @param max - 最大值
+ */
+export const random = (min, max) => lodash.random(min, max);
+/**
+ * 调整express中间件和路由的顺序，将路由提升到中间件前面
+ * @param stack - express实例的stack
+ * @param path - 路由名称
+ * @param method - 请求方法
+ * @param middlewareName - 中间件名称
+ */
+export const expressStack = (stack, path, method, middlewareName) => {
+    const routeIndex = stack.findIndex((layer) => layer.route?.path === path && layer.route?.methods?.[method]);
+    const middlewareIndex = stack.findIndex((layer) => layer.name === middlewareName);
+    if (routeIndex !== -1 && middlewareIndex !== -1 && routeIndex > middlewareIndex) {
+        const [route] = stack.splice(routeIndex, 1);
+        stack.splice(middlewareIndex, 0, route);
     }
-    /**
-       * 传入URL数组，转为二维码base64
-       * @param urls - URL数组
-       */
-    async getQrCode(urls) {
-        const list = await Promise.all(urls.map(url => qrcode.toDataURL(url)));
-        /** 转为jimp图像对象 */
-        const Jimps = await Promise.all(list.map(url => {
-            return Jimp.read(Buffer.from(url.split(',')[1], 'base64'));
-        }));
-        /** 获取最长的宽高 */
-        const QRwidth = lodash.max(Jimps.map(j => j.bitmap.width)) || Jimps[0].bitmap.width;
-        const Qrheight = lodash.sum(Jimps.map(j => j.bitmap.height));
-        /** 空白区域高度 */
-        const padding = 0;
-        /** 二维码图像加上文字 */
-        const qrImagesWithText = await Promise.all(Jimps.map(async (qrImage) => {
-            /** 增加空白区域 */
-            const newImage = new Jimp(QRwidth, Qrheight + padding, 0xffffffff);
-            /** 将二维码图像放在空白区域下方 */
-            newImage.composite(qrImage, 0, padding);
-            return newImage;
-        }));
-        /** 动态计算每行二维码的数量 */
-        const qrPerRow = Math.ceil(Math.sqrt(urls.length));
-        /** 计算总行数和合并后图像的总宽度和总高度 */
-        const totalRows = Math.ceil(qrImagesWithText.length / qrPerRow);
-        const combinedWidth = QRwidth * qrPerRow;
-        const combinedHeight = (Qrheight + padding) * totalRows;
-        /** 创建合并后的图像对象 */
-        const combinedQRImage = new Jimp(combinedWidth, combinedHeight, 0xffffffff);
-        /** 将二维码图像合并到合并后的图像对象中 */
-        qrImagesWithText.forEach((qrImage, index) => {
-            const x = (index % qrPerRow) * QRwidth;
-            const y = Math.floor(index / qrPerRow) * (Qrheight + padding);
-            combinedQRImage.composite(qrImage, x, y);
-        });
-        /** 转为base64 */
-        const base64 = await combinedQRImage.getBase64Async(Jimp.MIME_PNG);
-        /** 宽高 */
-        const width = combinedQRImage.bitmap.width;
-        const height = combinedQRImage.bitmap.height;
-        return {
-            base64,
-            width,
-            height,
-        };
+};
+/**
+ * 调整express路由的顺序 使其在`expressInit`之后
+ * @param stack - express实例的stack
+ * @param path - 路由名称
+ * @param method - 请求方法
+ */
+export const expressAfterInit = (stack, path, method) => {
+    const routeIndex = stack.findIndex((layer) => layer.route?.path === path && layer.route?.methods?.[method]);
+    const initIndex = stack.findIndex((layer) => layer.name === 'expressInit');
+    if (routeIndex !== -1 && initIndex !== -1 && (initIndex + 1) < routeIndex) {
+        const [route] = stack.splice(routeIndex, 1);
+        stack.splice(initIndex + 1, 0, route);
     }
-    /**
-       * 传入文本 返回处理后的文本、图片
-       * @param text - 文本
-       */
-    async getQQBotText(text) {
-        const urls = this.getUrls(text);
-        const data = urls.length ? (await this.getQrCode(urls)) : undefined;
-        /** 使用for循环来替换字符串 保证一致性 */
-        for (const url of urls) {
-            text = text.replace(url, '[请扫码查看]');
-        }
-        return {
-            text,
-            data,
-        };
+};
+/**
+ * 虚假事件
+ * @param log 日志
+ */
+export const fakeEvent = (log) => {
+    logger.fatal(`${logger.red('[QQBot][虚假事件]')} ${log.replace(/\n/g, '\\n')}`);
+};
+/**
+ * 处理url
+ * @param text - 文本
+ * @param exclude - 排除的URL
+ * @returns url列表
+ */
+export const handleUrl = (text, exclude = []) => {
+    /** 中文不符合url规范 */
+    text = text.replace(/[\u4e00-\u9fa5]/g, '|');
+    const urls = GetUrls.getUrls(text, {
+        exclude,
+        /** 去除 WWW */
+        stripWWW: false,
+        /** 规范化协议 */
+        normalizeProtocol: false,
+        /** 移除查询参数 */
+        removeQueryParameters: false,
+        /** 移除唯一斜杠 */
+        removeSingleSlash: false,
+        /** 查询参数排序 */
+        sortQueryParameters: false,
+        /** 去除认证信息 */
+        stripAuthentication: false,
+        /** 去除文本片段 */
+        stripTextFragment: false,
+        /** 移除末尾斜杠 */
+        removeTrailingSlash: false,
+        /** 不进行标准处理url */
+        normalize: false,
+    });
+    return urls;
+};
+/**
+ * 生成二维码
+ * @param urls - url列表
+ * @returns 返回带`base64://`前缀的二维码列表
+ */
+export const qrs = async (urls) => {
+    const list = await Promise.all(urls.map((url) => qrcode.toDataURL(url)));
+    return list.map((item) => `base64://${item.split(',')[1]}`);
+};
+/**
+ * 语音文件转silk
+ * @param file 文件路径 base64 buffer
+ * @returns silk文件buffer
+ */
+export const silkEncode = async (file) => {
+    const buffer = await common.buffer(file);
+    if (isSilk(buffer))
+        return buffer;
+    const start = Date.now();
+    const root = `${tempPath}/recordToSilk`;
+    const temp = `${root}/${start}`;
+    const src = `${temp}/${start}`;
+    const pcm = `${temp}/${start}.pcm`;
+    // const silk = `${temp}/${start}.silk`
+    fs.mkdirSync(temp, { recursive: true });
+    fs.writeFileSync(src, buffer);
+    const { status, error } = await ffmpeg(` -i ${src} -f s16le -ar 48000 -ac 1 ${pcm}`);
+    if (!status)
+        throw error;
+    const pamBuffer = await fs.promises.readFile(pcm);
+    const { data, duration } = await encode(pamBuffer, 48000);
+    setTimeout(() => {
+        // TODO: 缓存silk文件 提升性能
+        const ms = logger.yellow(duration + 'ms');
+        const end = logger.yellow((Date.now() - start) + 'ms');
+        logger.info(`[QQBot] silk文件转码成功 音频时长: ${ms} 转码耗时: ${end}`);
+        fs.rmSync(temp, { recursive: true, force: true });
+    }, 100);
+    return Buffer.from(data);
+};
+/**
+ * 处理文本 提取其中的url转为按钮
+ * @param text - 文本
+ * @param isC2C - 是否为C2C消息
+ */
+export const textToButton = (text, isC2C = false) => {
+    text = text.replace(/@everyone/g, 'everyone').replace(/\n/g, '\r');
+    if (isC2C)
+        text = text.replace(/<qqbot-at-user id=".+" \/>/gm, '').replace(/<@.+>/gm, '');
+    const urls = handleUrl(text);
+    if (urls.length === 0) {
+        return { text, buttons: [] };
     }
+    const buttons = [];
+    urls.forEach((url, index) => {
+        text = text.replace(new RegExp(url, 'g'), `[请点击 按钮${index} 查看]`);
+        buttons.push(segment.button({ text: `${index}. ${url}`, link: url }));
+    });
+    // 最多只有5个长度
+    return { text, buttons: buttons.length > 5 ? buttons.slice(0, 5) : buttons };
+};
+/**
+ * 传入一个图片链接，获取图片的宽高
+ * @param url - 图片链接
+ * @returns 图片的宽高
+ */
+export const getImageSize = async (url) => {
+    const buffer = await common.buffer(url);
+    const { width = 100, height = 100 } = size(buffer);
+    return { width, height };
+};
+/**
+ * 处理模板文本，对不能直接发送的 Markdown 语法进行转义
+ * @param text - 文本
+ * @returns 转义后的文本
+ */
+export const escapeMarkdown = (text) => {
     /**
-     * 传入文本 处理文本 返回的按钮为多行按钮
-     * @param text - 文本
+     * @example
+     * ```md
+     * # 标题
+     * **加粗**
+     * __下划线加粗__
+     * _斜体_
+     * *星号斜体*
+     * ***加粗斜体***
+     * ~~删除线~~
+     * ```
      */
-    getQQBotButton(text) {
-        const urls = this.getUrls(text);
-        const data = [];
-        /** 使用for循环来替换字符串 保证一致性 */
-        for (const url of urls) {
-            text = text.replace(url, '[请点击按钮查看]');
-            data.push(segment.button({ text: url, link: url }));
-        }
-        return {
-            text,
-            data,
-        };
-    }
-    /**
-     * 传入文本 将文本一些特殊字符转义去除 用于处理markdown
-     * @param text - 文本
-     * @param isC2C - 是否是C2C
-     * @returns 处理后的文本
-     */
-    formatText(text, isC2C = false) {
-        text = text.replace(/everyone/g, '').replace(/\n/g, '\r');
-        if (isC2C)
-            text = text.replace(/<qqbot-at-user id=".+" \/>/gm, '').replace(/<@.+>/gm, '');
-        return text;
-    }
-}
-export const common = new Common();
+    // 转义标题(仅行首的 #)
+    text = text.replace(/^(\s*)#(?!#)/gm, '$1\r#');
+    // 转义加粗斜体(排除已经转义的情况)
+    text = text.replace(/(?<!\\)\*\*\*(.+?)(?<!\\)\*\*\*/g, '\\*\\*\\*$1\\*\\*\\*');
+    // 转义加粗(星号加粗，排除已转义)
+    text = text.replace(/(?<!\\)\*\*(.+?)(?<!\\)\*\*/g, '\\*\\*$1\\*\\*');
+    // 转义下划线加粗(排除已转义)
+    text = text.replace(/(?<!\\)__(.+?)(?<!\\)__/g, '\\__\\__$1\\__\\__');
+    // 转义斜体(星号斜体，排除已转义)
+    text = text.replace(/(?<!\\)\*(.+?)(?<!\\)\*/g, '\\*$1\\*');
+    // 转义斜体(下划线斜体，排除已转义)
+    text = text.replace(/(?<!\\)_(.+?)(?<!\\)_/g, '\\_$1\\_');
+    // 转义删除线(排除已转义)
+    text = text.replace(/(?<!\\)~~(.+?)(?<!\\)~~/g, '\\~\\~$1\\~\\~');
+    // 转义其他特殊字符 这里先不管。
+    // text = text.replace(/(?<!\\)([\\`*_{}\[\]()#+\-.!])/g, '\\$1')
+    return text;
+};

package/lib/utils/config.d.ts

@@ -1,134 +1,9 @@
-/** 机器人发送模式
- * - 0: 直接发送
- * - 1: 原生 Markdown
- * - 3: 旧图文模板 Markdown
- * - 4: 纯文模板 Markdown
- * - 5: 自定义处理
- */
-export type SendMode = 0 | 1 | 3 | 4 | 5;
-/**
- * 全局配置类型定义
- */
-export interface GlobalCfgType {
-    /** 获取调用凭证的 API 地址 */
-    accessTokenApi: string;
-    /** 沙盒环境 API 地址 */
-    sandBoxApi: string;
-    /** 正式环境 API 地址 */
-    qqBotApi: string;
-    /** 是否开启沙盒环境 */
-    sandBox: boolean;
-    /** 机器人发送模式
-     * - 0: 直接发送
-     * - 1: 原生 Markdown
-     * - 3: 旧图文模板 Markdown
-     * - 4: 纯文模板 Markdown
-     * - 5: 自定义处理
-     */
-    sendMode: SendMode;
-    /** 是否开启频道消息 */
-    guild: boolean;
-    /** 频道机器人模式 0-公域机器人 1-私域机器人 */
-    guildMode: 0 | 1;
-    /** 机器人 Markdown 模板 ID，仅在 sendMode 为 3 或 4 时有效 */
-    templateId: string;
-    /** 机器人旧图文模板 Markdown 配置 */
-    oldTemplate: {
-        /** 开头文字的键 */
-        textStartKey: string;
-        /** 图片描述的键 */
-        imgDescKey: string;
-        /** 图片地址的键 */
-        imgUrlKey: string;
-        /** 结尾文字的键 */
-        textEndKey: string;
-    };
-    /** 机器人纯文模板 Markdown 配置，10个文本键 */
-    textTemplate: string[];
-    /** 文本中的 URL 转二维码白名单，配置后将不转换这些 URL 为二维码 */
-    exclude: string[];
-    /** 接受到消息后对文本进行表达式处理，优先级高于全局配置 */
-    regex: Array<{
-        /** 匹配的正则表达式 */
-        reg: RegExp;
-        /** 替换为的内容 */
-        rep: string;
-    }>;
-}
-/**
- * 账号配置类型定义
- */
-export interface AccountCfgType extends GlobalCfgType {
-    /** 机器人 AppID */
-    appId: string;
-    /** 机器人 AppSecret */
-    secret: string;
-}
+import type { Config } from '@/types/config';
 /**
- * 配置类型定义
+ * @description package.json
  */
-export interface ConfigType {
-    /**
-     * 全局默认配置
-     */
-    default: GlobalCfgType;
-    /** 账号配置列表 */
-    accounts: Record<string, AccountCfgType>;
-}
-declare class Cfg {
-    /** 配置文件跟路径 */
-    dir: string;
-    /** 默认配置文件根路径 */
-    defdir: string;
-    /** 缓存 不经常用的不建议缓存 */
-    change: Map<string, any>;
-    /** 监听文件 */
-    watcher: Map<string, any>;
-    constructor();
-    /** 初始化配置 */
-    initCfg(): Promise<void>;
-    /**
-   * 更新yaml文件
-   * @param filePath - 文件路径
-   * @param settings - 设置项
-   */
-    updateYaml(filePath: string, settings: {
-        /** 键路径 */
-        key: string;
-        /** 要写入的 */
-        val: any;
-        /** 需要写入的注释 */
-        comment: string;
-        /** 是否添加到顶部 否则添加到同一行 */
-        type: boolean;
-    }[]): void;
-    /**
-     * 基本配置
-     */
-    get Config(): ConfigType;
-    /**
-     * 获取指定Bot配置
-     * @param {string} appID - Bot的AppID
-     */
-    getBotConfig(appID: string): AccountCfgType | null;
-    /**
-     * package
-     */
-    get package(): any;
-    /**
-     * 获取配置yaml
-     */
-    getYaml(type: 'defSet' | 'config', name: string, isWatch?: boolean): any;
-    /**
-     * 监听配置文件
-     * @param {'defSet'|'config'} type 类型
-     * @param {string} name 文件名称 不带后缀
-     * @param {string} file 文件路径
-     */
-    watch(type: 'defSet' | 'config', name: string, file: string): Promise<true | undefined>;
-}
+export declare const pkg: () => any;
 /**
- * 配置文件
+ * @description 配置文件
  */
-export declare const config: Cfg;
-export {};
+export declare const config: () => Config;