node-karin 0.0.3

package/lib/event/review.handler.js

@@ -0,0 +1,382 @@
+import Config from '../utils/config.js'
+import logger from '../utils/logger.js'
+/**
+ * 事件拦截器
+ * 利用可执行函数的特性，热更新所有拦截器
+ * 所有拦截器返回的都是布尔值 为true说明通过 为false则未通过
+ */
+export default new (class Review {
+  GroupCD
+  GroupUserCD
+  App = Config['App']
+  Config = Config['Config']
+  CD
+  mode
+  alias
+  GroupEnable
+  UserEnable
+  GroupMsgPrint
+  PluginEnable
+  constructor () {
+    /** 群聊所有消息cd */
+    this.GroupCD = {}
+    /** 群聊个人cd */
+    this.GroupUserCD = {}
+    /** 事件cd */
+    this.CD = (e, config) => true
+    /** 响应模式 */
+    this.mode = (e, config) => true
+    /** 前缀、别名 */
+    this.alias = (e, config) => true
+    /** 群聊黑白名单 哪个群可以触发事件 */
+    this.GroupEnable = e => true
+    /** 用户黑白名单 谁可以触发事件 */
+    this.UserEnable = e => true
+    /** 群聊事件日志 哪个群可以打印日志 */
+    this.GroupMsgPrint = e => true
+    /** 插件黑白名单 哪个插件可以被触发 */
+    this.PluginEnable = (app, config) => true
+    // 延迟1秒执行
+    setTimeout(() => {
+      this.main()
+    }, 1000)
+  }
+
+  main () {
+    this.App = Config.App
+    this.Config = Config.Config
+    this.#CD()
+    this.#mode()
+    this.#alias()
+    this.#GroupEnable()
+    this.#UserEnable()
+    this.#GroupMsgPrint()
+    this.#PluginEnable()
+  }
+
+  /**
+     * 群聊黑白名单 允许哪个群触发事件
+     */
+  #GroupEnable () {
+    /** 同时启用 */
+    if (this.App.WhiteList.groups && this.App.BlackList.groups) {
+      this.GroupEnable = e => {
+        /** 白名单不为空 */
+        if (Array.isArray(this.Config.WhiteList.groups) && this.Config.WhiteList.groups.length) {
+          const group_id = (Number(e.group_id) || String(e.group_id))
+          return this.Config.WhiteList.groups.includes(group_id)
+        }
+        /** 白名单为空 检查黑名单是否为空 */
+        if (Array.isArray(this.Config.BlackList.groups) && this.Config.BlackList.groups.length) {
+          const group_id = (Number(e.group_id) || String(e.group_id))
+          return !this.Config.BlackList.groups.includes(group_id)
+        }
+        /** 黑白名单都为空 */
+        return true
+      }
+      return true
+    }
+    /** 白名单启用 */
+    if (this.App.WhiteList.groups) {
+      this.GroupEnable = e => {
+        if (Array.isArray(this.Config.WhiteList.groups) && this.Config.WhiteList.groups.length) {
+          const group_id = (Number(e.group_id) || String(e.group_id))
+          return this.Config.WhiteList.groups.includes(group_id)
+        }
+        return true
+      }
+      return true
+    }
+    /** 黑名单启用 */
+    if (this.App.BlackList.groups) {
+      this.GroupEnable = e => {
+        if (Array.isArray(this.Config.BlackList.groups) && this.Config.BlackList.groups.length) {
+          const group_id = (Number(e.group_id) || String(e.group_id))
+          return !this.Config.BlackList.groups.includes(group_id)
+        }
+        return true
+      }
+      return true
+    }
+    /** 都没有启用 */
+    this.GroupEnable = () => true
+  }
+
+  /**
+     * 用户黑白名单 允许那个用户触发事件
+     */
+  #UserEnable () {
+    /** 同时启用 */
+    if (this.App.WhiteList.users && this.App.BlackList.users) {
+      this.UserEnable = e => {
+        /** 白名单不为空 */
+        if (Array.isArray(this.Config.WhiteList.users) && this.Config.WhiteList.users.length) {
+          const user_id = (Number(e.user_id) || String(e.user_id))
+          return this.Config.WhiteList.users.includes(user_id)
+        }
+        /** 白名单为空 检查黑名单是否为空 */
+        if (Array.isArray(this.Config.BlackList.users) && this.Config.BlackList.users.length) {
+          const user_id = (Number(e.user_id) || String(e.user_id))
+          return !this.Config.BlackList.users.includes(user_id)
+        }
+        /** 黑白名单都为空 */
+        return true
+      }
+      return true
+    }
+    /** 白名单启用 */
+    if (this.App.WhiteList.users) {
+      this.UserEnable = e => {
+        if (Array.isArray(this.Config.WhiteList.users) && this.Config.WhiteList.users.length) {
+          const user_id = (Number(e.user_id) || String(e.user_id))
+          return this.Config.WhiteList.users.includes(user_id)
+        }
+        return true
+      }
+      return true
+    }
+    /** 黑名单启用 */
+    if (this.App.BlackList.users) {
+      this.UserEnable = e => {
+        if (Array.isArray(this.Config.BlackList.users) && this.Config.BlackList.users.length) {
+          const user_id = (Number(e.user_id) || String(e.user_id))
+          return !this.Config.BlackList.users.includes(user_id)
+        }
+        return true
+      }
+      return true
+    }
+    /** 都没有启用 */
+    this.UserEnable = () => true
+  }
+
+  /**
+     * 群聊事件日志 是否打印
+     */
+  #GroupMsgPrint () {
+    /** 同时启用 */
+    if (this.App.WhiteList.GroupMsgLog && this.App.BlackList.GroupMsgLog) {
+      this.GroupMsgPrint = e => {
+        /** 白名单不为空 */
+        if (Array.isArray(this.Config.WhiteList.GroupMsgLog) && this.Config.WhiteList.GroupMsgLog.length) {
+          const group_id = (Number(e.group_id) || String(e.group_id))
+          return this.Config.WhiteList.GroupMsgLog.includes(group_id)
+        }
+        /** 白名单为空 检查黑名单是否为空 */
+        if (Array.isArray(this.Config.BlackList.GroupMsgLog) && this.Config.BlackList.GroupMsgLog.length) {
+          const group_id = (Number(e.group_id) || String(e.group_id))
+          return !this.Config.BlackList.GroupMsgLog.includes(group_id)
+        }
+        /** 黑白名单都为空 */
+        return true
+      }
+      return true
+    }
+    /** 白名单启用 */
+    if (this.App.WhiteList.GroupMsgLog) {
+      this.GroupMsgPrint = e => {
+        if (Array.isArray(this.Config.WhiteList.GroupMsgLog) && this.Config.WhiteList.GroupMsgLog.length) {
+          const group_id = (Number(e.group_id) || String(e.group_id))
+          return this.Config.WhiteList.GroupMsgLog.includes(group_id)
+        }
+        return true
+      }
+      return true
+    }
+    /** 黑名单启用 */
+    if (this.App.BlackList.GroupMsgLog) {
+      this.GroupMsgPrint = e => {
+        if (Array.isArray(this.Config.BlackList.GroupMsgLog) && this.Config.BlackList.GroupMsgLog.length) {
+          const group_id = (Number(e.group_id) || String(e.group_id))
+          return !this.Config.BlackList.GroupMsgLog.includes(group_id)
+        }
+        return true
+      }
+      return true
+    }
+    /** 都没有启用 */
+    this.GroupMsgPrint = () => true
+  }
+
+  /**
+     * 黑白名单插件 哪个插件可以被触发
+     */
+  #PluginEnable () {
+    /** 同时启用 */
+    if (this.App.GroupConfig.enable && this.App.GroupConfig.disable) {
+      this.PluginEnable = (app, config) => {
+        /** 白名单不为空 */
+        if (Array.isArray(config.enable) && config.enable.length) {
+          /** 插件包是否处于功能白名单 */
+          if (config.enable.includes(app.file.dir)) { return true }
+          /** 插件是否处于功能白名单 */
+          if (config.enable.includes(`${app.file.dir}/${app.file.name}`)) { return true }
+          /** 插件名称是否处于功能白名单 */
+          if (config.enable.includes(app.name)) { return true }
+          logger.debug(logger.green(`[功能白名单] 插件名称 [${app.name}] 不存在功能白名单中`))
+          return false
+        }
+        /** 白名单为空 检查黑名单是否为空 */
+        if (Array.isArray(config.disable) && config.disable.length) {
+          /** 插件包是否处于功能黑名单 */
+          if (config.disable.includes(app.file.dir)) {
+            logger.debug(logger.red(`[功能黑名单] 插件包 [${app.file.dir}] 处于功能黑名单`))
+            return false
+          }
+          /** 插件是否处于功能黑名单 */
+          if (config.disable.includes(`${app.file.dir}/${app.file.name}`)) {
+            logger.debug(logger.red(`[功能黑名单] 插件 [${app.file.dir}/${app.file.name}] 处于功能黑名单`))
+            return false
+          }
+          /** 插件名称是否处于功能黑名单 */
+          if (config.disable.includes(app.name)) {
+            logger.debug(logger.red(`[功能黑名单] 插件名称 [${app.name}] 处于功能黑名单`))
+            return false
+          }
+          return true
+        }
+        /** 黑白名单都为空 */
+        return true
+      }
+      return true
+    }
+    /** 白名单启用 */
+    if (this.App.GroupConfig.enable) {
+      this.PluginEnable = (app, config) => {
+        if (Array.isArray(config.enable) && config.enable.length) {
+          if (config.enable.includes(app.file.dir)) { return true }
+          if (config.enable.includes(`${app.file.dir}/${app.file.name}`)) { return true }
+          if (config.enable.includes(app.name)) { return true }
+          logger.debug(logger.green(`[功能白名单] 插件名称 [${app.name}] 不存在功能白名单中`))
+          return false
+        }
+        return true
+      }
+      return true
+    }
+    /** 黑名单启用 */
+    if (this.App.GroupConfig.disable) {
+      this.PluginEnable = (app, config) => {
+        if (Array.isArray(config.disable) && config.disable.length) {
+          if (config.disable.includes(app.file.dir)) {
+            logger.debug(logger.red(`[功能黑名单] 插件包 [${app.file.dir}] 处于功能黑名单`))
+            return false
+          }
+          if (config.disable.includes(`${app.file.dir}/${app.file.name}`)) {
+            logger.debug(logger.red(`[功能黑名单] 插件 [${app.file.dir}/${app.file.name}] 处于功能黑名单`))
+            return false
+          }
+          if (config.disable.includes(app.name)) {
+            logger.debug(logger.red(`[功能黑名单] 插件名称 [${app.name}] 处于功能黑名单`))
+            return false
+          }
+          return true
+        }
+        return true
+      }
+      return true
+    }
+    /** 都没有启用 */
+    this.PluginEnable = () => true
+    return true
+  }
+
+  /** 群聊cd */
+  #CD () {
+    /** 同时启用 */
+    if (this.App.GroupConfig.GroupCD && this.App.GroupConfig.GroupUserCD) {
+      this.CD = (e, config) => {
+        const key = `${e.group_id}.${e.user_id}`
+        /** cd中... */
+        if (this.GroupCD[e.group_id] || this.GroupUserCD[key]) { return false }
+        /** 全局 */
+        this.GroupCD[e.group_id] = true
+        setTimeout(() => delete this.GroupCD[e.group_id], config.GroupCD * 1000)
+        /** 个人 */
+        this.GroupUserCD[key] = true
+        setTimeout(() => delete this.GroupUserCD[key], config.GroupUserCD * 1000)
+        return true
+      }
+      return true
+    }
+    /** 启用单个群聊所有消息冷却时间 */
+    if (this.App.GroupConfig.GroupCD) {
+      this.CD = (e, config) => {
+        /** cd中... */
+        if (this.GroupCD[e.group_id]) { return false }
+        /** 全局 */
+        this.GroupCD[e.group_id] = true
+        setTimeout(() => delete this.GroupCD[e.group_id], config.GroupCD * 1000)
+        return true
+      }
+      return true
+    }
+    /** 启用单个群聊个人消息冷却时间 */
+    if (this.App.GroupConfig.GroupUserCD) {
+      this.CD = (e, config) => {
+        const key = `${e.group_id}.${e.user_id}`
+        /** cd中... */
+        if (this.GroupUserCD[key]) { return false }
+        /** 个人 */
+        this.GroupUserCD[key] = true
+        setTimeout(() => delete this.GroupUserCD[key], config.GroupUserCD * 1000)
+        return true
+      }
+      return true
+    }
+    /** 都没有启用 */
+    this.CD = () => true
+  }
+
+  /**
+     * 响应模式
+     */
+  #mode () {
+    /** 启用 */
+    if (this.App.GroupConfig.mode) {
+      this.mode = (e, config) => {
+        const modeMap = {
+          0: () => true,
+          1: () => e.atBot,
+          2: () => e.isMaster,
+          3: () => !!e.alias,
+          4: () => {
+            if (e.atBot) { return true }
+            return !!e.alias
+          },
+          5: () => {
+            if (e.isMaster) { return true }
+            if (e.atBot) { return true }
+            return !!e.alias
+          },
+        }
+        return modeMap[Number(config.mode) || 0]()
+      }
+      return true
+    }
+    /** 未启用 */
+    this.mode = () => true
+  }
+
+  /**
+     * 前缀、别名
+     */
+  #alias () {
+    /** 启用 */
+    if (this.App.GroupConfig.alias) {
+      this.alias = (e, config) => {
+        const aliasRegex = new RegExp(`^(${config.alias.join('|')})`)
+        const match = e.msg.match(aliasRegex)
+        if (match) {
+          e.msg = e.msg.replace(aliasRegex, '').trim()
+          e.alias = match[1]
+          return true
+        }
+        return false
+      }
+      return true
+    }
+    /** 未启用 */
+    this.alias = () => true
+  }
+})()

package/lib/index.d.ts

@@ -0,0 +1,23 @@
+import './core/init.js';
+import config from './utils/config.js';
+import logger from './utils/logger.js';
+import listener from './core/listener.js';
+import server from './core/server.js';
+import Plugin from './core/plugin.js';
+import PluginLoader from './core/plugin.loader.js';
+import common from './utils/common.js';
+import segment from './utils/segment.js';
+import handler from './utils/handler.js';
+import ffmpeg from './utils/ffmpeg.js';
+import exec from './utils/exec.js';
+import button from './utils/button.js';
+import update from './utils/update.js';
+import YamlEditor from './utils/YamlEditor.js';
+import render from './renderer/app.js';
+import { KarinMessage } from './event/message.js';
+import level from './db/level.js';
+import { RedisClientType } from 'redis';
+import { kritor } from 'kritor-proto';
+export * as types from './types/index.js';
+declare const redis: RedisClientType;
+export { config, config as Cfg, common, listener, logger, Plugin, PluginLoader, server, Plugin as plugin, listener as Bot, segment, handler, ffmpeg, exec, button, level, redis, update, render, kritor, YamlEditor, render as Renderer, update as Update, KarinMessage, };

package/lib/index.js

@@ -0,0 +1,40 @@
+// 基本模块
+import './core/init.js'
+import config from './utils/config.js'
+import logger from './utils/logger.js'
+// 核心模块
+import listener from './core/listener.js'
+import server from './core/server.js'
+import Plugin from './core/plugin.js'
+import PluginLoader from './core/plugin.loader.js'
+// 工具类
+import common from './utils/common.js'
+import segment from './utils/segment.js'
+import handler from './utils/handler.js'
+import ffmpeg from './utils/ffmpeg.js'
+import exec from './utils/exec.js'
+import button from './utils/button.js'
+import update from './utils/update.js'
+import YamlEditor from './utils/YamlEditor.js'
+import render from './renderer/app.js'
+import { KarinMessage } from './event/message.js'
+// 适配器
+import Puppeteer from './renderer/server.js'
+import OneBot11 from './adapter/onebot/onebot11.js'
+// 数据库
+import level from './db/level.js'
+import Redis from './db/redis.js'
+// proto
+import { kritor } from 'kritor-proto'
+export * as types from './types/index.js'
+// 初始化
+server.init()
+const redis = (await new Redis().start())
+PluginLoader.load()
+listener.emit('adapter', Puppeteer)
+listener.emit('adapter', OneBot11)
+// Exporting Modules
+export {
+// 基本模块
+  config, config as Cfg, common, listener, logger, Plugin, PluginLoader, server, Plugin as plugin, listener as Bot, segment, handler, ffmpeg, exec, button, level, redis, update, render, kritor, YamlEditor, render as Renderer, update as Update, KarinMessage,
+}

package/lib/renderer/app.d.ts

@@ -0,0 +1,53 @@
+import { KarinRender, KarinRenderApp, KarinRenderType } from '../types/render.js';
+/**
+ * 渲染器管理器
+ */
+declare const _default: {
+    index: number;
+    Apps: Array<KarinRenderApp>;
+    /**
+     * 注册渲染器
+     * @param {object} data 渲染器数据
+     * @param {string} data.id 渲染器ID
+     * @param {'image'|string} data.type 渲染器类型
+     * @param {RenderBase.render} data.render 渲染器标准方法
+     * @returns {number} 渲染器索引
+     */
+    app(data: {
+        /**
+         * 渲染器ID
+         */
+        id: string;
+        /**
+         * 渲染器类型
+         */
+        type?: 'image' | string;
+        /**
+         * 渲染器标准方法
+         */
+        render: KarinRender['render'];
+    }): number;
+    /**
+     * 卸载渲染器
+     * @param index 渲染器索引
+     * @returns 是否卸载成功
+     */
+    unapp(index: number): boolean;
+    /**
+     * 返回渲染器实例 未键入id返回第一个
+     * @param id 渲染器ID
+     * @returns 渲染器实例
+     */
+    App(id?: string): KarinRenderApp;
+    /**
+     * 调用标准渲染器
+     */
+    render(options: KarinRenderType, id: string): Promise<string | string[]>;
+    /**
+     * 快速渲染
+     * @param data html路径、http地址
+     * @returns 返回图片base64或数组
+     */
+    renderHtml(data: string): Promise<string | string[]>;
+};
+export default _default;

package/lib/renderer/app.js

@@ -0,0 +1,93 @@
+import logger from '../utils/logger.js'
+/**
+ * 渲染器管理器
+ */
+export default new (class Renderer {
+  index
+  Apps
+  constructor () {
+    /** 索引 */
+    this.index = 0
+    /**
+         * 渲染器列表
+         * @type {APP[]}
+         */
+    this.Apps = []
+  }
+
+  /**
+     * 注册渲染器
+     * @param {object} data 渲染器数据
+     * @param {string} data.id 渲染器ID
+     * @param {'image'|string} data.type 渲染器类型
+     * @param {RenderBase.render} data.render 渲染器标准方法
+     * @returns {number} 渲染器索引
+     */
+  app (data) {
+    this.index++
+    const index = this.index
+    const { id, type = 'image', render } = data
+    if (!id) { throw new Error('[注册渲染器失败] 缺少渲染器ID') }
+    if (!type) { throw new Error('[注册渲染器失败] 缺少渲染器类型') }
+    if (!render) { throw new Error('[注册渲染器失败] 缺少渲染器标准方法') }
+    const time = Date.now()
+    const options = { index, id, type, render, time }
+    this.Apps.push(options)
+    logger.mark(`${logger.violet(`[渲染器:${index}]`)} 注册成功: ` + logger.green(id))
+    return index
+  }
+
+  /**
+     * 卸载渲染器
+     * @param index 渲染器索引
+     * @returns 是否卸载成功
+     */
+  unapp (index) {
+    const app = this.Apps.find(app => app.index === index)
+    if (!app) {
+      logger.error(`[卸载渲染器失败] 未找到渲染器索引：${index}`)
+      return false
+    }
+    this.Apps = this.Apps.filter(app => app.index !== index)
+    logger.mark(`[卸载渲染器] ${app.id}`)
+    return true
+  }
+
+  /**
+     * 返回渲染器实例 未键入id返回第一个
+     * @param id 渲染器ID
+     * @returns 渲染器实例
+     */
+  App (id = '') {
+    if (this.Apps.length === 0) { throw new Error('[调用渲染器失败] 渲染器列表为空') }
+    if (!id) { return this.Apps[0] }
+    /** 筛选出id一致的渲染器 */
+    const app = this.Apps.find(app => app.id === id)
+    if (!app) { throw new Error(`[调用渲染器失败] 未找到渲染器：${id}`) }
+    return app
+  }
+
+  /**
+     * 调用标准渲染器
+     */
+  async render (options, id) {
+    const res = this.App(id)
+    return res.render(options)
+  }
+
+  /**
+     * 快速渲染
+     * @param data html路径、http地址
+     * @returns 返回图片base64或数组
+     */
+  async renderHtml (data) {
+    const app = this.App()
+    return app.render({
+      file: data,
+      name: 'render',
+      pageGotoParams: {
+        waitUntil: 'networkidle2',
+      },
+    })
+  }
+})()

package/lib/renderer/base.d.ts

@@ -0,0 +1,30 @@
+import chokidar from 'chokidar';
+import { KarinRender, KarinRenderType } from '../types/render.js';
+/**
+ * 渲染器基类 所有渲染器都应该继承这个类
+ */
+export default class RenderBase implements KarinRender {
+    dir: './temp/html';
+    html: {
+        [key: string]: string;
+    };
+    watcher: {
+        [key: string]: chokidar.FSWatcher;
+    };
+    constructor();
+    /**
+     * 模板渲染
+     * @param options 模板名称
+     * @param isAbs 是否返回绝对路径
+     */
+    dealTpl(options: KarinRenderType, isAbs?: boolean): string;
+    /**
+     * 监听模板文件
+     * @param tplFile 模板文件路径
+     */
+    watch(tplFile: string): void;
+    /**
+     * 渲染标准方法
+     */
+    render(options: KarinRenderType): Promise<string | Array<string>>;
+}

package/lib/renderer/base.js

@@ -0,0 +1,71 @@
+import fs from 'fs'
+import chokidar from 'chokidar'
+import template from 'art-template'
+import common from '../utils/common.js'
+import logger from '../utils/logger.js'
+/**
+ * 渲染器基类 所有渲染器都应该继承这个类
+ */
+export default class RenderBase {
+  dir
+  html
+  watcher
+  constructor () {
+    this.dir = './temp/html'
+    this.html = {}
+    this.watcher = {}
+    common.mkdir(this.dir)
+  }
+
+  /**
+     * 模板渲染
+     * @param options 模板名称
+     * @param isAbs 是否返回绝对路径
+     */
+  dealTpl (options, isAbs = true) {
+    let { name, fileID, file: tplFile } = options
+    fileID = fileID || name
+    const filePath = `./temp/html/${name}/${fileID}.html`
+    /** 读取html模板 */
+    if (!this.html[tplFile]) {
+      common.mkdir(`./temp/html/${name}`)
+      try {
+        this.html[tplFile] = fs.readFileSync(tplFile, 'utf8')
+      } catch (error) {
+        logger.error(`加载html错误：${tplFile}`)
+        return ''
+      }
+      this.watch(tplFile)
+    }
+    /** 替换模板 */
+    const tmpHtml = template.render(this.html[tplFile], options.data)
+    /** 保存模板 */
+    fs.writeFileSync(filePath, tmpHtml)
+    logger.debug(`[图片生成][使用模板] ${filePath}`)
+    /** 是否返回绝对路径 */
+    if (isAbs) { return `${process.cwd()}/temp/html/${name}/${fileID}.html` }
+    return filePath
+  }
+
+  /**
+     * 监听模板文件
+     * @param tplFile 模板文件路径
+     */
+  watch (tplFile) {
+    if (this.watcher[tplFile]) { return }
+    const watcher = chokidar.watch(tplFile)
+    watcher.on('change', () => {
+      delete this.html[tplFile]
+      logger.mark(`[修改html模板] ${tplFile}`)
+    })
+    this.watcher[tplFile] = watcher
+  }
+
+  /**
+     * 渲染标准方法
+     */
+  async render (options) {
+    logger.error('未实现渲染方法')
+    return ''
+  }
+}