node-karin 0.10.0 → 0.10.2

package/lib/utils/tools/ffmpeg.js

@@ -0,0 +1,25 @@
+import exec from './exec.js';
+import logger from '../core/logger.js';
+import { config } from '../config/config.js';
+/**
+ * 执行 ffmpeg 命令
+ */
+export async function ffmpeg() {
+    let ffmpeg = 'ffmpeg';
+    const { status } = await exec('ffmpeg -version', false);
+    if (status !== 'ok') {
+        logger.debug('ffmpeg 未安装，开始尝试读取配置文件是否存在ffmpeg路径');
+        const ffmpegPath = config.Config.ffmpeg_path;
+        if (!ffmpegPath) {
+            logger.warn('ffmpeg 未安装，请安装 ffmpeg 或手动配置 ffmpeg 路径后重启');
+            return false;
+        }
+        ffmpeg = `"${ffmpegPath}"`;
+    }
+    // 返回函数
+    return async (cmd, log = true, options = { cwd: process.cwd(), encoding: 'utf-8' }) => {
+        cmd = cmd.replace(/^ffmpeg/, '').trim();
+        cmd = `${ffmpeg} ${cmd}`;
+        return await exec(cmd, log, options);
+    };
+}

package/lib/utils/tools/update.js

@@ -0,0 +1,139 @@
+import fs from 'fs';
+import exec from './exec.js';
+export const update = new (class Update {
+    dir;
+    constructor() {
+        this.dir = './plugins';
+    }
+    /**
+     * 更新框架或插件
+     * @param path - 插件相对路径
+     * @param cmd - 更新命令 默认git pull
+     * @param time - 超时时间 默认120s
+     */
+    async update(path, cmd = 'git pull', time = 120) {
+        /** 检查一下路径是否存在 */
+        if (!fs.existsSync(path))
+            return { status: 'failed', data: '路径不存在' };
+        /** 检查是否有.git文件夹 */
+        if (!fs.existsSync(`${path}/.git`))
+            return { status: 'failed', data: '该路径不是一个git仓库' };
+        /** 设置超时时间 */
+        const timer = setTimeout(() => {
+            return { status: 'failed', data: '执行超时' };
+        }, time * 1000);
+        const options = { env: process.env, cwd: path, encoding: 'utf-8' };
+        /** 记录当前短哈希 */
+        const hash = await this.getHash(path);
+        /** 执行更新 */
+        const { status, error } = await exec(cmd, true, options);
+        /** 执行成功 */
+        if (status === 'ok') {
+            clearTimeout(timer);
+            /** 再次获取短哈希 查看是否有更新 */
+            const newHash = await this.getHash(path);
+            if (hash === newHash) {
+                const time = await this.getTime(path);
+                return {
+                    status: 'ok',
+                    data: ['\n当前版本已是最新版本', `Hash: ${hash}`, `最后更新：${await this.getCommit({ path, count: 1 })}`, `最后提交时间：${time}`].join('\n'),
+                };
+            }
+            const Commit = await this.getCommit({ path, hash });
+            return {
+                status: 'ok',
+                data: ['\n更新成功', `当前Hash: ${newHash}`, `更新日志：\n${Commit}`].join('\n'),
+            };
+        }
+        const msg = ['\n更新失败', `当前Hash: ${hash}`, `错误信息：${error?.message?.toString() || error?.stack?.toString() || error?.toString()}`, '请解决错误后重试或执行【#强制更新】'];
+        return { status: 'failed', data: msg.join('\n') };
+    }
+    /**
+     * 获取指定仓库最后一次提交时间日期
+     * @param path - 插件相对路径
+     */
+    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' });
+        if (data.status === 'failed')
+            return '获取时间失败，请重试或更新Git~';
+        return data.stdout.trim();
+    }
+    /**
+     * 获取指定仓库最后一次提交哈希值
+     * @param {string} path - 插件相对路径
+     * @param {boolean} [short] - 是否获取短哈希 默认true
+     * @returns {Promise<string>}
+     */
+    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' });
+        if (data.status === 'failed') {
+            const text = data.error;
+            throw new Error(text);
+        }
+        return data.stdout.trim();
+    }
+    /**
+     * 获取指定仓库的提交记录
+     * @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;
+        let cmd = `git log -${count} --format="[%ad]%s %n" --date="format:%m-%d %H:%M"`;
+        /** 键入HEAD */
+        if (hash)
+            cmd = `git log ${hash}..HEAD --format="[%ad] %s %n" --date="format:%m-%d %H:%M"`;
+        /** 指定分支 */
+        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' });
+        if (data.status === 'failed') {
+            const text = data.error;
+            throw new Error(text);
+        }
+        return data.stdout.trim();
+    }
+    /**
+     * 检查插件是否有更新
+     * @param {string} path - 插件相对路径
+     * @param {number} [time] - 超时时间 默认120s
+     * @returns {Promise<{status: 'ok'|'failed', data: string|boolean}>}
+     */
+    async checkUpdate(path, time = 120) {
+        /** 检查一下路径是否存在 */
+        if (!fs.existsSync(path))
+            return { status: 'failed', data: '路径不存在' };
+        /** 检查是否有.git文件夹 */
+        if (!fs.existsSync(`${path}/.git`))
+            return { status: 'failed', data: '该路径不是一个git仓库' };
+        /** 设置超时时间 */
+        const timer = setTimeout(() => {
+            return { status: 'failed', data: '执行超时' };
+        }, time * 1000);
+        const options = { env: process.env, cwd: path, encoding: 'utf-8' };
+        /** git fetch origin */
+        const { status, error } = await exec('git fetch origin', false, options);
+        if (status === 'failed')
+            return { status: 'failed', data: error?.message };
+        /** git status -uno */
+        const { stdout } = await exec('git status -uno', false, options);
+        clearTimeout(timer);
+        /** 检查是否有更新 没更新直接返回 */
+        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 data = await this.getCommit({ path, count, branch: 'origin' });
+        return { status: 'ok', data, count };
+    }
+})();
+export const Update = update;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-karin",
-  "version": "0.10.0",
+  "version": "0.10.2",
   "private": false,
   "description": "基于 Kritor 进行开发的nodejs机器人框架",
   "homepage": "https://github.com/KarinJS/Karin",

package/lib/core/dir.js

@@ -1,7 +0,0 @@
-import path from 'path'
-import { fileURLToPath } from 'url'
-const filename = fileURLToPath(import.meta.url)
-/**
- * - 获取当前npm包的根目录
- */
-export const karinDir = path.resolve(filename, '../../../').replace(/\\/g, '/').replace(/\/$/, '')

package/lib/core/init.js

@@ -1,42 +0,0 @@
-import { logger } from '../utils/index.js'
-/**
- * 启动日志
- */
-logger.mark('Karin 启动中...')
-logger.mark('https://github.com/KarinJS/Karin')
-/**
- * 设置标题
- */
-process.title = 'Karin'
-/**
- * 设置时区
- */
-process.env.TZ = 'Asia/Shanghai'
-const init = () => {
-  if (!process.env.karin_app_lang) { process.env.karin_app_lang = 'js' }
-  if (!process.env.karin_app_mode) { process.env.karin_app_mode = 'prod' }
-  if (!process.env.karin_app_runner) { process.env.karin_app_runner = 'node' }
-  if (!process.env.karin_app_start_count) { process.env.karin_app_start_count = '0' }
-  /** 正常启动 */
-  if (process.env.karin_app_runner === 'node' && process.env.karin_app_lang === 'js' && process.env.karin_app_mode === 'prod') {
-    logger.debug('当前为 JavaScript 生产模式')
-    return
-  }
-  /** pm2 */
-  if (process.env.karin_app_runner === 'pm2') {
-    logger.info('当前为 PM2 模式')
-    return
-  }
-  /** js开发模式 */
-  if (process.env.karin_app_lang === 'js' && process.env.karin_app_mode === 'dev') {
-    logger.info('当前为 JavaScript 开发模式')
-    return
-  }
-  /** ts开发模式 */
-  if (process.env.karin_app_lang === 'ts' && process.env.karin_app_mode === 'dev') {
-    logger.info('当前为 TypeScript 开发模式')
-    return
-  }
-  logger.error('未知的启动模式')
-}
-init()

package/lib/core/karin.js

@@ -1,194 +0,0 @@
-import { server } from './server.js'
-import { stateArr } from './plugin.js'
-import PluginApp from './plugin.app.js'
-import { common } from '../utils/index.js'
-import { listener } from './listener.js'
-import onebot11 from '../adapter/onebot/11/index.js'
-import { render, RenderServer } from '../render/index.js'
-export class Karin {
-  start
-  constructor () {
-    this.start = false
-    this.run()
-  }
-
-  /**
-     * - 快速构建命令
-     * @param reg - 正则表达式
-     * @param second - 函数或者字符串或者KarinElement、KarinElement数组
-     * @param options - 选项
-     * @returns - 返回插件对象
-     */
-  command (reg, second, options = {}) {
-    reg = typeof reg === 'string' ? new RegExp(reg) : reg
-    const fnc = typeof second === 'function'
-      ? second
-      : async (e) => {
-        const element = typeof second === 'number' ? String(second) : second
-        if ('delay' in options && options.delay) { await common.sleep(options.delay) }
-        await e.reply(element, {
-          at: ('at' in options && options.at) || false,
-          reply: ('reply' in options && options.reply) || false,
-          recallMsg: ('recallMsg' in options && Number(options.recallMsg)) || 0,
-        })
-        return !('stop' in options && !options.stop)
-      }
-    const data = {
-      name: options.name || 'function',
-      priority: options.priority,
-      rule: [
-        {
-          reg,
-          fnc,
-          permission: options.permission || 'all',
-          log: options.log ?? true,
-        },
-      ],
-    }
-    return PluginApp(data)
-  }
-
-  /**
-     * - 构建定时任务
-     * @param name - 任务名称
-     * @param cron - cron表达式
-     * @param fnc - 执行函数
-     * @param options - 选项
-     */
-  task (name, cron, fnc, options) {
-    if (!name) { throw new Error('[task]: 缺少参数[name]') }
-    if (!cron) { throw new Error('[task]: 缺少参数[cron]') }
-    if (!fnc) { throw new Error('[task]: 缺少参数[fnc]') }
-    const data = {
-      name: options?.name || 'task',
-      priority: options?.priority,
-      task: [
-        {
-          name,
-          cron,
-          fnc,
-          log: options?.log ?? true,
-        },
-      ],
-    }
-    return PluginApp(data)
-  }
-
-  /**
-     * - 构建handler
-     * @param key - 事件key
-     * @param fnc - 函数实现
-     * @param options - 选项
-     */
-  handler (key, fnc, options) {
-    if (!key) { throw new Error('[handler]: 缺少参数[key]') }
-    if (!fnc) { throw new Error('[handler]: 缺少参数[fnc]') }
-    const priority = options?.priority || 10000
-    const data = {
-      name: options?.name || 'handler',
-      priority,
-      handler: [
-        {
-          key,
-          fnc,
-          priority,
-        },
-      ],
-    }
-    return PluginApp(data)
-  }
-
-  /**
-     * 构建contact
-     * @param peer - 群号或者id
-     * @param isGroup - 是否是群聊
-     * @param sub_peer - 子id
-     */
-  contact (peer, isGroup = true, sub_peer) {
-    if (isGroup) {
-      return {
-        scene: 'group' /* Scene.Group */,
-        peer,
-        sub_peer: sub_peer || '',
-      }
-    }
-    return {
-      scene: 'friend' /* Scene.Private */,
-      peer,
-      sub_peer: sub_peer || '',
-    }
-  }
-
-  /**
-     * - 渲染
-     * @param data - 渲染参数
-     * @param multiPage - 分片高度
-     * @returns - 返回图片base64或数组
-     */
-  render (data, multiPage) {
-    if (typeof data === 'string') {
-      /** 分片 */
-      if (typeof multiPage === 'number' || multiPage === true) {
-        return render.renderMultiHtml(data, multiPage)
-      }
-      /** 快速渲染 */
-      return render.renderHtml(data)
-    }
-    /** 正常渲染 */
-    return render.render(data)
-  }
-
-  /**
-     * 上下文
-     * @param e - 消息事件
-     * @param options - 上下文选项
-     */
-  async ctx (e, options) {
-    const time = options?.time || 120
-    const userId = options?.userId || e.user_id
-    const key = e.group_id ? `${e.group_id}.${userId}` : userId
-    stateArr[key] = { type: 'ctx' }
-    // 返回promise 设置超时时间
-    return new Promise((resolve, reject) => {
-      setTimeout(() => {
-        if (stateArr[key]) {
-          delete stateArr[key]
-          if (options?.reply) { e.reply(options.replyMsg || '操作超时已取消') }
-          reject(new Error('操作超时已取消'))
-          return true
-        }
-      }, time * 1000)
-      listener.once(`ctx:${key}`, (e) => resolve(e))
-    })
-  }
-
-  /**
-     * accept
-     * @param event - 监听事件
-     * @param fnc - 实现函数
-     */
-  accept (event, fnc, options) {
-    const data = {
-      name: options?.name || 'accept',
-      priority: options?.priority,
-      event,
-      accept: fnc,
-      log: options?.log,
-    }
-    return PluginApp(data)
-  }
-
-  /**
-     * - 启动
-     */
-  run () {
-    if (this.start) { return }
-    this.start = true
-    server.init()
-    listener.emit('load.plugin')
-    listener.emit('adapter', RenderServer)
-    listener.emit('adapter', onebot11)
-  }
-}
-export const karin = new Karin()
-export default karin

package/lib/core/listener.js

@@ -1,217 +0,0 @@
-import { EventEmitter } from 'events'
-import { pluginLoader } from './plugin.loader.js'
-import { common, logger, config, segment } from '../utils/index.js'
-import NoticeHandler from '../event/notice.handler.js'
-import RequestHandler from '../event/request.handler.js'
-import { MessageHandler } from '../event/message.handler.js'
-import { level } from '../db/index.js'
-/**
- * 监听器管理
- */
-class Listeners extends EventEmitter {
-  /**
-     * Bot索引
-     * @type - Bot索引
-     */
-  index
-  /**
-     * 框架名称
-     */
-  name
-  list
-  adapter
-  constructor () {
-    super()
-    this.index = 0
-    this.name = 'Karin'
-    this.list = []
-    this.adapter = []
-    this.on('error', data => logger.error(data))
-    this.on('load.plugin', () => pluginLoader.load())
-    this.on('adapter', data => {
-      let path = data.path || '无'
-      if (path && data.type !== 'grpc') { path = `ws://127.0.0.1:${config.Server.http.port}${data.path}` }
-      path = logger.green(path)
-      logger.info(`[适配器][注册][${data.type}]: ` + path)
-      this.addAdapter(data)
-    })
-    this.on('message', data => new MessageHandler(data))
-    this.on('notice', data => new NoticeHandler(data))
-    this.on('request', data => new RequestHandler(data))
-  }
-
-  /**
-     * 注册Bot 返回索引id
-     */
-  addBot (data) {
-    this.index++
-    const index = this.index
-    if (!data.bot) {
-      logger.error('[Bot管理][注册] 注册失败: Bot实例不能为空', JSON.stringify(data))
-      return false
-    }
-    this.list.push({ index, type: data.type, bot: data.bot })
-    logger.info(`[机器人][注册][${data.type}] ` + logger.green(`[account:${data.bot.account.uid || data.bot.account.uin}(${data.bot.account.name})]`))
-    this.#online(data.bot.account.uid || data.bot.account.uin)
-    logger.debug('注册', this.list)
-    return index
-  }
-
-  /**
-   * 发送上线通知
-   */
-  async #online (uid) {
-    /** 重启 */
-    const key = `karin:restart:${uid}`
-    const options = await level.get(key)
-    if (!options) { return }
-    const { id, contact, time, message_id } = options
-    /** 重启花费时间 保留2位小数 */
-    const restartTime = ((Date.now() - time) / 1000).toFixed(2)
-    /** 超过2分钟不发 */
-    if (Number(restartTime) > 120) {
-      await level.del(key)
-      return false
-    }
-    const element = [
-      segment.reply(message_id),
-      segment.text(`Karin 重启成功：${restartTime}秒`),
-    ]
-    await this.sendMsg(id, contact, element)
-    await level.del(key)
-    return true
-  }
-
-  /**
-     * 卸载Bot
-     * @param index - Bot的索引id
-     */
-  delBot (index) {
-    this.list = this.list.filter(item => item.index !== index)
-    logger.debug('[机器人][卸载] ', this.list)
-  }
-
-  /**
-     * 通过Bot uid 获取Bot
-     * @param uid - Bot的uid 未传入则返回第一个Bot
-     */
-  getBot (uid = '') {
-    uid = String(uid)
-    if (this.list.length === 0) {
-      logger.error('[Bot管理][UID] 当前Bot列表为空')
-      return undefined
-    }
-    if (!uid) { return this.list[0].bot }
-    const index = this.list.findIndex(item => String(item.bot.account.uid) === uid)
-    if (index === -1) {
-      logger.error('[Bot管理][UID] 无法找到对应的 Bot 实例')
-      return undefined
-    }
-    return this.list[index].bot
-  }
-
-  /**
-     * 根据索引获取Bot
-     * @param index - Bot的索引id
-     */
-  getBotByIndex (index) {
-    index = this.list.findIndex(item => item.index === index)
-    if (index === -1) {
-      throw new Error('[Bot管理][索引] 无法找到对应的 Bot 实例')
-    }
-    return this.list[index].bot
-  }
-
-  /**
-     * 获取当前已注册Bot数量
-     */
-  getBotCount () {
-    return this.list.length
-  }
-
-  /**
-     * 获取所有Bot列表
-     * @param isIndex - 是否返回包含的索引列表 默认返回Bot实例列表
-     */
-  getBotAll (isIndex = false) {
-    if (isIndex) { return this.list }
-    return this.list.map(item => item.bot)
-  }
-
-  /**
-     * 注册适配器
-     * @param data - 适配器信息
-     * @param data.type - 适配器类型
-     * @param data.adapter - 适配器实例
-     * @param data.path - 适配器路径
-     */
-  addAdapter (data) {
-    const adapter = { type: data.type, adapter: data.adapter, path: '' }
-    if (data.path) { adapter.path = data.path }
-    this.adapter.push(adapter)
-  }
-
-  /**
-     * 通过path获取适配器 仅适用于反向WS适配器
-     * @param path - 适配器路径
-     */
-  getAdapter (path = '') {
-    const index = this.adapter.findIndex(item => item?.path === path)
-    if (index === -1) {
-      logger.error('[适配器管理] 无法找到对应的适配器实例')
-      return undefined
-    }
-    return this.adapter[index].adapter
-  }
-
-  /**
-     * 获取适配器列表
-     * @param isType - 是否返回包含的类型列表 默认返回适配器实例列表
-     */
-  getAdapterAll (isType = false) {
-    if (isType) { return this.adapter }
-    return this.adapter.map(item => item.adapter)
-  }
-
-  /**
-     * 发送主动消息
-     * @param uid - Bot的uid
-     * @param contact - 目标信息
-     * @param elements - 消息内容
-     * @param options - 消息选项
-     * @param options.recallMsg - 发送成功后撤回消息时间
-     * @param options.retry_count - 重试次数
-     */
-  async sendMsg (uid, contact, elements, options = { recallMsg: 0, retry_count: 1 }) {
-    const bot = this.getBot(uid)
-    if (!bot) { throw new Error('发送消息失败: 未找到对应Bot实例') }
-    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') {
-      logger.bot('info', self_id, `${logger.green('Send Proactive Group')} ${contact.peer}: ${reply_log}`)
-    } else {
-      logger.bot('info', self_id, `${logger.green('Send Proactive private')} ${contact.peer}: ${reply_log}`)
-    }
-    try {
-      this.emit('karin:count:send', 1)
-      /** 取结果 */
-      result = await bot.SendMessage(contact, NewElements, retry_count)
-      logger.bot('debug', self_id, `主动消息结果:${JSON.stringify(result, null, 2)}`)
-    } catch (error) {
-      logger.bot('error', self_id, `主动消息发送失败:${reply_log}`)
-      logger.bot('error', self_id, error)
-    }
-    /** 快速撤回 */
-    if (recallMsg && bot.RecallMessage && recallMsg > 0 && result?.message_id) {
-      setTimeout(() => bot.RecallMessage(contact, result.message_id), recallMsg * 1000)
-    }
-    return result
-  }
-}
-export const listener = new Listeners()
-export const Bot = listener

package/lib/core/plugin.app.js

@@ -1,19 +0,0 @@
-export default function PluginApp (options) {
-  return {
-    file: {
-      dir: options?.file?.dir || '',
-      name: options?.file?.name || '',
-      type: options?.file?.type || 'function',
-      Fnc: options?.file?.fnc || '',
-    },
-    name: options.name || '',
-    event: options.event || 'message' /* EventType.Message */,
-    priority: options.priority || 10000,
-    accept: options.accept ?? false,
-    log: options.log ?? true,
-    rule: options.rule || [],
-    task: options.task || [],
-    handler: options.handler || [],
-    button: options.button || [],
-  }
-}