node-karin 0.10.0 → 0.10.2

package/lib/utils/core/logger.js

@@ -0,0 +1,105 @@
+import fs from 'fs';
+import chalk from 'chalk';
+import log4js from 'log4js';
+import { config } from '../config/config.js';
+const logsDir = './logs';
+if (!fs.existsSync(logsDir))
+    fs.mkdirSync(logsDir);
+const { log_level, log_days_Keep, log4jsCfg } = config.Config;
+const level = log_level || log4jsCfg.level || 'info';
+const daysToKeep = log_days_Keep || log4jsCfg.daysToKeep || 7;
+const { overall, fragments, maxLogSize } = log4jsCfg;
+const defaultOptions = { appenders: ['console'], level, enableCallStack: process.env.KarinMode === 'dev' };
+const options = {
+    appenders: {
+        console: {
+            type: 'console',
+            layout: {
+                type: 'pattern',
+                pattern: `%[[Karin][%d{hh:mm:ss.SSS}][%4.4p]%] ${process.env.KarinMode === 'dev' ? '[%f{3}:%l] ' : ''}%m`,
+            },
+        },
+    },
+    categories: { default: defaultOptions },
+};
+if (overall) {
+    defaultOptions.appenders.unshift('overall');
+    options.appenders.overall = {
+        /** 输出到文件 */
+        type: 'file',
+        filename: 'logs/logger',
+        pattern: 'yyyy-MM-dd.log',
+        /** 日期后缀 */
+        keepFileExt: true,
+        /** 日志文件名中包含日期模式 */
+        alwaysIncludePattern: true,
+        /** 日志文件保留天数 */
+        daysToKeep,
+        /** 日志输出格式 */
+        layout: {
+            type: 'pattern',
+            pattern: '[%d{hh:mm:ss.SSS}][%4.4p] %m',
+        },
+    };
+}
+if (fragments) {
+    defaultOptions.appenders.unshift('fragments');
+    options.appenders.fragments = {
+        type: 'file',
+        filename: 'logs/app.log',
+        pattern: 'MM-dd.log',
+        keepFileExt: true,
+        alwaysIncludePattern: true,
+        daysToKeep,
+        maxLogSize: (maxLogSize || 30) * 1024 * 1024,
+        /** 最大文件数 */
+        numBackups: 9999999,
+        /** 日志输出格式 */
+        layout: {
+            type: 'pattern',
+            pattern: '[%d{hh:mm:ss.SSS}][%4.4p] %m',
+        },
+    };
+}
+log4js.configure(options);
+export const logger = log4js.getLogger('default');
+logger.chalk = chalk;
+logger.red = chalk.red;
+logger.green = chalk.green;
+logger.yellow = chalk.yellow;
+logger.blue = chalk.blue;
+logger.magenta = chalk.magenta;
+logger.cyan = chalk.cyan;
+logger.white = chalk.white;
+logger.gray = chalk.gray;
+logger.violet = chalk.hex('#868ECC');
+logger.fnc = chalk.hex(config.Config.log_color || '#FFFF00');
+logger.bot = (level, id, ...args) => {
+    switch (level) {
+        case 'trace':
+            logger.trace(logger.violet(`[Bot:${id}]`), ...args);
+            break;
+        case 'debug':
+            logger.debug(logger.violet(`[Bot:${id}]`), ...args);
+            break;
+        case 'mark':
+            logger.mark(logger.violet(`[Bot:${id}]`), ...args);
+            break;
+        case 'info':
+            logger.info(logger.violet(`[Bot:${id}]`), ...args);
+            break;
+        case 'warn':
+            logger.warn(logger.violet(`[Bot:${id}]`), ...args);
+            break;
+        case 'error':
+            logger.error(logger.violet(`[Bot:${id}]`), ...args);
+            break;
+        case 'fatal':
+            logger.fatal(logger.violet(`[Bot:${id}]`), ...args);
+            break;
+        default:
+            logger.info(logger.violet(`[Bot:${id}]`), ...args);
+    }
+};
+global.logger = logger;
+export default logger;

package/lib/utils/{segment.d.ts → core/segment.d.ts}

@@ -1,4 +1,4 @@
-import { TextElement, AtElement, ImageElement, FaceElement, BubbleFaceElement, ReplyElement, VideoElement, BasketballElement, DiceElement, RpsElement, PokeElement, MusicElement, WeatherElement, LocationElement, ShareElement, GiftElement, MarketFaceElement, ForwardElement, ContactElement, JsonElement, XmlElement, FileElement, ButtonElement, CustomMusicElemen, TplMarkdownElement, RawMarkdownElement, NodeElement, KarinElement, LongMsgElement, RecordElement } from '../types/index.js';
+import { TextElement, AtElement, ImageElement, FaceElement, BubbleFaceElement, ReplyElement, VideoElement, BasketballElement, DiceElement, RpsElement, PokeElement, MusicElement, WeatherElement, LocationElement, ShareElement, GiftElement, MarketFaceElement, ForwardElement, ContactElement, JsonElement, XmlElement, FileElement, ButtonElement, CustomMusicElemen, TplMarkdownElement, RawMarkdownElement, NodeElement, KarinElement, LongMsgElement, RecordElement } from '../../types/index.js';
 export declare const segment: {
     /**
      * 纯文本

package/lib/utils/core/segment.js

@@ -0,0 +1,441 @@
+export const segment = new (class Segment {
+    /**
+     * 纯文本
+     * @param text - 文本内容
+     * @returns {TextElement} 纯文本元素
+     */
+    text(text) {
+        return {
+            type: 'text',
+            text: text + '',
+        };
+    }
+    /**
+     * 提及
+     * 提供一个uid即可
+     * @param uid - uid
+     * @param uin - uin
+     * @param name - 名称
+     * @returns {AtElement} 提及元素
+     */
+    at(uid, uin, name) {
+        return {
+            type: 'at',
+            uid: uid + '',
+            uin: (uin || '') + '',
+            name,
+        };
+    }
+    /**
+     * 表情
+     * @param id - 表情ID
+     * @param is_big - 是否大表情，默认不是
+     * @returns {FaceElement} 表情元素
+     */
+    face(id, is_big = false) {
+        return {
+            type: 'face',
+            id: Number(id),
+            is_big,
+        };
+    }
+    /**
+     * 弹射表情
+     * @param id - 表情ID
+     * @param count - 数量
+     * @returns {BubbleFaceElement} 弹射表情元素
+     */
+    bubble_face(id, count = 1) {
+        return {
+            type: 'bubble_face',
+            id: Number(id),
+            count: Number(count),
+        };
+    }
+    /**
+     * 引用回复
+     * @param message_id - 消息ID
+     * @returns {ReplyElement} 引用回复元素
+     */
+    reply(message_id) {
+        return {
+            type: 'reply',
+            message_id: message_id + '',
+        };
+    }
+    /**
+     * 图片
+     * - 一般情况提供一个file参数即可，其他参数一般为收到的消息中的参数
+     * @param file - 图片URL或路径、Base64
+     * @param options - 图片类型、名称、MD5、子类型、宽度、高度
+     * @returns {ImageElement} 图片元素
+     */
+    image(file, options = {}) {
+        const file_type = options.file_type || 'original';
+        const name = options.name || '';
+        const md5 = options.md5 || '';
+        const sub_type = options.sub_type || '';
+        const width = options.width || 0;
+        const height = options.height || 0;
+        return {
+            type: 'image',
+            file,
+            file_type,
+            name,
+            md5,
+            sub_type,
+            width,
+            height,
+        };
+    }
+    /**
+     * 语音
+     * @description 即将废弃，请使用voice
+     * @param file - 语音URL或路径、Base64
+     * @param magic - 是否魔法语音，默认为 false
+     * @param md5 - 语音md5
+     * @param name - 语音名称
+     * @returns {VoiceElement} 语音元素
+     */
+    record(file, magic = false, md5 = '', name = '') {
+        return {
+            type: 'record',
+            file,
+            magic,
+            md5,
+            name,
+        };
+    }
+    /**
+     * 语音 即将废弃 请使用segment.record
+     * @param file - 语音URL或路径、Base64
+     * @param magic - 是否魔法语音，默认为 false
+     * @param md5 - 语音md5
+     * @param name - 语音名称
+     * @returns {VoiceElement} 语音元素
+     * @deprecated 即将废弃 请使用segment.record
+     */
+    voice(file, magic = false, md5 = '', name = '') {
+        return {
+            type: 'record',
+            file,
+            magic,
+            md5,
+            name,
+        };
+    }
+    /**
+     * 视频
+     * @param file - 视频URL或路径、Base64
+     * @param md5  - 视频md5
+     * @param name - 视频名称
+     * @returns {VideoElement} 视频元素
+     */
+    video(file, md5 = '', name = '') {
+        return {
+            type: 'video',
+            file,
+            md5,
+            name,
+        };
+    }
+    /**
+     * 篮球
+     * @param id - 篮球ID
+     * @returns {BasketballElement} 篮球元素
+     */
+    basketball(id) {
+        return {
+            type: 'basketball',
+            id,
+        };
+    }
+    /**
+     * 骰子
+     * @param id - 骰子ID
+     * @returns {DiceElement} 骰子元素
+     */
+    dice(id) {
+        return {
+            type: 'dice',
+            id,
+        };
+    }
+    /**
+     * 石头剪刀布
+     * @param id - 石头剪刀布ID
+     * @returns {RpsElement} 石头剪刀布元素
+     */
+    rps(id) {
+        return {
+            type: 'rps',
+            id,
+        };
+    }
+    /**
+     * 戳一戳
+     * @param id - 戳一戳ID
+     * @param poke_type - 戳一戳类型
+     * @param strength - 戳一戳强度(1-5 默认1)
+     * @returns {PokeElement} 戳一戳元素
+     */
+    poke(id, poke_type, strength = 1) {
+        return {
+            type: 'poke',
+            id,
+            poke_type,
+            strength,
+        };
+    }
+    /**
+     * 自定义音乐
+     * @param url - 跳转链接
+     * @param audio - 音乐音频链接
+     * @param title - 标题
+     * @param author - 歌手
+     * @param pic - 封面
+     * @returns {CustomMusicElemen} 自定义音乐元素
+     */
+    customMusic(url, audio, title, author, pic, id) {
+        return {
+            type: 'music',
+            platform: 'custom',
+            url,
+            audio,
+            title,
+            author,
+            pic,
+            id,
+        };
+    }
+    /**
+     * 音乐
+     * @param platform - 音乐平台
+     * @param id - 音乐ID
+     * @returns {MusicElement} 音乐元素
+     */
+    music(platform, id) {
+        return {
+            type: 'music',
+            platform,
+            id,
+        };
+    }
+    /**
+     * 天气
+     * @param city - 城市名称
+     * @param code - 城市代码
+     * @returns {WeatherElement} 天气元素
+     */
+    weather(city, code) {
+        return {
+            type: 'weather',
+            city,
+            code,
+        };
+    }
+    /**
+     * 位置
+     * @param lat - 纬度
+     * @param lon - 经度
+     * @param title - 标题
+     * @param address - 地址
+     * @returns {LocationElement} 位置元素
+     */
+    location(lat, lon, title, address) {
+        return {
+            type: 'location',
+            lat,
+            lon,
+            title,
+            address,
+        };
+    }
+    /**
+     * 分享
+     * @param url - 分享链接
+     * @param title - 分享标题
+     * @param content - 分享内容
+     * @param image - 分享图片
+     * @returns {ShareElement} 分享元素
+     */
+    share(url, title, content, image) {
+        return {
+            type: 'share',
+            url,
+            title,
+            content,
+            image,
+        };
+    }
+    /**
+     * 礼物
+     * @param qq - QQ 号
+     * @param id - 礼物ID
+     * @returns {GiftElement} 礼物元素
+     */
+    gift(qq, id) {
+        return {
+            type: 'gift',
+            qq,
+            id,
+        };
+    }
+    /**
+     * 商城表情
+     * @param id - 表情ID
+     * @returns {MarketFaceElement} 商城表情元素
+     */
+    marketFace(id) {
+        return {
+            type: 'market_face',
+            id,
+        };
+    }
+    /**
+     * 转发
+     * @param res_id - 资源ID
+     * @param uniseq - 序列号(可能不对?)
+     * @param summary - 摘要
+     * @param description - 描述
+     * @returns {ForwardElement} 转发元素
+     */
+    forward(res_id, uniseq, summary, description) {
+        return {
+            type: 'forward',
+            res_id,
+            uniseq: uniseq || '',
+            summary: summary || '',
+            description: description || '',
+        };
+    }
+    /**
+     * 分享名片
+     * @param scene - 分享类型
+     * @param peer - 被推荐人的QQ号或者被推荐群的群号
+     * @returns {ContactElement} 分享名片元素
+     */
+    contact(scene, peer) {
+        return {
+            type: 'contact',
+            scene,
+            peer,
+        };
+    }
+    /**
+     * JSON
+     * @param data - JSON序列化过的字符串
+     * @returns {JsonElement} JSON元素
+     */
+    json(data) {
+        return {
+            type: 'json',
+            data,
+        };
+    }
+    /**
+     * XML
+     * @param data - XML字符串
+     * @returns {XmlElement} XML元素
+     */
+    xml(data) {
+        return {
+            type: 'xml',
+            data,
+        };
+    }
+    /**
+     * 文件
+     */
+    file(options) {
+        return {
+            type: 'file',
+            file: options.url,
+            name: options.name || '',
+            size: options.size || 0,
+            expire_time: options.expire_time || 0,
+            id: options.id || '',
+            url: options.url,
+            biz: options.biz || 0,
+            sub_id: options.sub_id || '',
+            md5: options.md5 || '',
+        };
+    }
+    /**
+     * 长消息
+     * @param id - ID
+     */
+    long_msg(id) {
+        return {
+            type: 'long_msg',
+            id,
+        };
+    }
+    /**
+     * Markdown
+     * @param content - 原生markdown内容
+     * @param config - 未知的参数
+     */
+    markdown(content, config) {
+        return {
+            type: 'markdown',
+            content,
+            config,
+        };
+    }
+    /**
+     * 构建模板Markdown
+     * @param custom_template_id - 模板ID
+     * @param params - 模板markdown参数
+     */
+    markdown_tpl(
+    /**
+     * - 模板ID
+     */
+    custom_template_id, 
+    /**
+     * - 模板markdown参数
+     */
+    params) {
+        return {
+            type: 'markdown_tpl',
+            custom_template_id,
+            params,
+        };
+    }
+    /**
+     * 按钮
+     * @param data - 按钮数据
+     * @returns {ButtonElement} 按钮元素
+     */
+    button(data) {
+        return {
+            type: 'button',
+            data,
+        };
+    }
+    rows(data) {
+        const rows = [];
+        if (!Array.isArray(data))
+            data = [data];
+        for (const i of data) {
+            rows.push(this.button(i));
+            continue;
+        }
+        return { type: 'rows', rows };
+    }
+    /**
+     * 转发自定义节点
+     * @param user_id - 用户ID
+     * @param nickname - 用户昵称
+     * @param content - 节点内容
+     */
+    node(user_id, nickname, content) {
+        return {
+            type: 'node',
+            user_id,
+            nickname,
+            content,
+        };
+    }
+})();

package/lib/utils/index.d.ts

@@ -1,11 +1,11 @@
-export * from './button.js';
-export * from './common.js';
-export * from './config.js';
-export * from './ffmpeg.js';
-export * from './handler.js';
-export * from './exec.js';
-export * from './segment.js';
-export * from './update.js';
-export * from './yamlEditor.js';
-export * from './logger.js';
-export * from './updateVersion.js';
+export * from './tools/button.js';
+export * from './common/common.js';
+export * from './config/config.js';
+export * from './tools/ffmpeg.js';
+export * from './core/handler.js';
+export * from './tools/exec.js';
+export * from './core/segment.js';
+export * from './tools/update.js';
+export * from './config/yamlEditor.js';
+export * from './core/logger.js';
+export * from './config/updateVersion.js';

package/lib/utils/index.js

@@ -1,11 +1,11 @@
-export * from './button.js'
-export * from './common.js'
-export * from './config.js'
-export * from './ffmpeg.js'
-export * from './handler.js'
-export * from './exec.js'
-export * from './segment.js'
-export * from './update.js'
-export * from './yamlEditor.js'
-export * from './logger.js'
-export * from './updateVersion.js'
+export * from './tools/button.js'
+export * from './common/common.js'
+export * from './config/config.js'
+export * from './tools/ffmpeg.js'
+export * from './core/handler.js'
+export * from './tools/exec.js'
+export * from './core/segment.js'
+export * from './tools/update.js'
+export * from './config/yamlEditor.js'
+export * from './core/logger.js'
+export * from './config/updateVersion.js'

package/lib/utils/{button.d.ts → tools/button.d.ts}

@@ -1,2 +1,2 @@
-import { KarinMessageType } from '../types/index.js';
+import { KarinMessageType } from '../../types/index.js';
 export declare const button: (e: KarinMessageType) => Promise<any>;

package/lib/utils/tools/button.js

@@ -0,0 +1,38 @@
+import logger from '../core/logger.js';
+import { pluginLoader as loader } from '../../core/index.js';
+export const button = async (e) => {
+    const button = [];
+    for (const v of loader.buttonIds) {
+        const info = loader.PluginList[v];
+        for (const v of info.button) {
+            const reg = v.reg;
+            if (reg.test(e.msg)) {
+                try {
+                    let res;
+                    let done = true;
+                    /**
+                     * 标记函数 如果调用则继续执行 循环下一个按钮插件处理
+                     */
+                    const reject = () => { done = false; };
+                    if (typeof v.fnc === 'function') {
+                        res = await v.fnc(e, reject);
+                    }
+                    else {
+                        const cla = new info.file.Fnc();
+                        cla.e = e;
+                        res = await cla[v.fnc](e, reject);
+                    }
+                    if (res)
+                        button.push(res);
+                    if (done)
+                        return res;
+                }
+                catch (error) {
+                    logger.error(error);
+                }
+            }
+        }
+    }
+    /** 理论上不会走到这里，但是还是要稳一手，不排除有所有插件都false... */
+    return button;
+};

package/lib/utils/tools/exec.js

@@ -0,0 +1,37 @@
+import logger from '../core/logger.js';
+import { exec as execCmd } from 'child_process';
+/**
+ * 执行 shell 命令
+ * @param cmd 命令
+ * @param log 是否打印日志
+ * @param options 选项
+ */
+export const exec = (cmd, log = true, options = { cwd: process.cwd(), encoding: 'utf-8' }) => {
+    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 });
+        });
+    });
+};
+export default exec;