node-karin 0.0.3

package/lib/event/message.handler.js

@@ -0,0 +1,240 @@
+import lodash from 'lodash'
+import Config from '../utils/config.js'
+import logger from '../utils/logger.js'
+import Review from './review.handler.js'
+import Listener from '../core/listener.js'
+import { stateArr } from '../core/plugin.js'
+import EventHandler from './event.handler.js'
+import PluginLoader from '../core/plugin.loader.js'
+/**
+ * 消息事件
+ */
+export default class Message extends EventHandler {
+  e
+  /**
+     * - 是否打印群消息日志
+     */
+  GroupMsgPrint = false
+  constructor (e) {
+    super(e)
+    this.e = e
+    Listener.emit('karin:count:recv', 1)
+    /** 处理消息 保证日志的打印 */
+    this.dealMsg()
+    /** 事件处理 */
+    if (this.review()) { return }
+    /** 响应模式 */
+    if (this.e.group_id && 'mode' in this.config && this.config.mode && !Review.mode(this.e, this.config)) {
+      logger.debug('[消息拦截] 响应模式不匹配')
+      return
+    }
+    this.GroupMsgPrint = false
+    /** 处理回复 */
+    this.reply()
+    /** 处理消息 */
+    this.deal()
+  }
+
+  /**
+     * 处理消息
+     */
+  async deal () {
+    /** 上下文 */
+    if (await this.context()) { return }
+    /* eslint-disable no-labels */
+    a: for (const index of PluginLoader.rule) {
+      const app = PluginLoader.PluginList[index]
+      /** 判断事件 */
+      if (app.event && !this.filtEvent(app.event)) { continue }
+      /** 正则匹配 */
+      for (const v of app.rule) {
+        /** 这里的lastIndex是为了防止正则无法从头开始匹配 */
+        v.reg.lastIndex = 0
+        if (v.reg.test(this.e.msg)) {
+          /** 检查黑白名单插件 */
+          if ('GroupCD' in this.config && !Review.PluginEnable(app, this.config)) { continue }
+          /** 判断子事件 */
+          if (v.event && !this.filtEvent(v.event)) { continue }
+          this.e.logFnc = `[${app.file.dir}][${app.name}][${v.fnc}]`
+          const logFnc = logger.fnc(`[${app.name}][${v.fnc}]`)
+          this.GroupMsgPrint && typeof v.log === 'function' && v.log(this.e.self_id, `${logFnc}${this.e.logText} ${lodash.truncate(this.e.msg, { length: 80 })}`)
+          /** 判断权限 */
+          if (!this.filterPermission(v.permission)) { break a }
+          try {
+            let res
+            if (app.file.type === 'function' && typeof v.fnc === 'function') {
+              res = v.fnc(this.e)
+            } else {
+              const cla = new app.file.Fnc()
+              cla.e = this.e
+              res = cla[v.fnc](this.e)
+            }
+            /** 计算插件处理时间 */
+            const start = Date.now()
+            Listener.emit('karin:count:fnc', this.e.logFnc)
+            res = await res
+            this.GroupMsgPrint && typeof v.log === 'function' && v.log(this.e.self_id, `${logFnc} ${lodash.truncate(this.e.msg, { length: 80 })} 处理完成 ${logger.green(Date.now() - start + 'ms')}`)
+            if (res !== false) { break a }
+          } catch (error) {
+            logger.error(`${this.e.logFnc}`)
+            logger.error(error.stack || error.message || JSON.stringify(error))
+            break a
+          }
+        }
+      }
+    }
+  }
+
+  /**
+     * 处理消息体
+     */
+  dealMsg () {
+    const logs = []
+    for (const val of this.e.elements) {
+      switch (val.type) {
+        case 'text': {
+          const msg = (val.text || '')
+            .replace(/^\s*[＃井#]+\s*/, '#')
+            .replace(/^\s*[\\*※＊]+\s*/, '*')
+            .trim()
+          this.e.msg += msg
+          /** 美观一点... */
+          logs.push(msg)
+          break
+        }
+        case 'face':
+          logs.push(`[face:${val.id}]`)
+          break
+        case 'video':
+        case 'record':
+          logs.push(`[${val.type}:${val.file}]`)
+          break
+        case 'image':
+          this.e.image.push(val.file)
+          logs.push(`[image:${val.file}]`)
+          break
+        case 'file':
+          this.e.file = val
+          logs.push(`[file:${val.file}]`)
+          break
+        case 'at':
+          /** atBot不计入e.at */
+          // eslint-disable-next-line eqeqeq
+          if (val.uid && val.uid == this.e.bot.account.uid) {
+            this.e.atBot = true
+            // eslint-disable-next-line eqeqeq
+          } else if (val.uin == this.e.bot.account.uin) {
+            this.e.atBot = true
+          } else if (val.uid && val.uid === 'all') {
+            this.e.atAll = true
+          } else {
+            const id = (val.uid || val.uin)
+            this.e.at.push(id)
+          }
+          logs.push(`[at:${val.uid || val.uin}]`)
+          break
+        case 'rps':
+          logs.push(`[rps:${val.id}]`)
+          break
+        case 'dice':
+          logs.push(`[dice:${val.id}]`)
+          break
+        case 'poke':
+          logs.push(`[poke:${val.id}]`)
+          break
+        case 'share':
+          logs.push(`[share:${val.url}]`)
+          break
+        case 'contact':
+          logs.push(`[contact:${val.peer}]`)
+          break
+        case 'location':
+          logs.push(`[location:${val.lat}-${val.lon}]`)
+          break
+        case 'music':
+          logs.push(`[music:${JSON.stringify(val)}]`)
+          break
+        case 'reply':
+          this.e.reply_id = val.message_id
+          logs.push(`[reply:${val.message_id}]`)
+          break
+        case 'forward':
+          logs.push(`[forward:${val.res_id}]`)
+          break
+        case 'xml':
+          this.e.msg += val.data
+          logs.push(`[xml:${val.data}]`)
+          break
+        case 'json':
+          this.e.msg += val.data
+          logs.push(`[json:${JSON.stringify(val.data)}]`)
+          break
+        case 'markdown': {
+          if (val.content) {
+            logs.push(`[markdown:${val.content}]`)
+          } else {
+            const content = { id: val.custom_template_id }
+            for (const v of val.params) { content[v.key] = v.values[0] }
+            logs.push(`[markdown:${JSON.stringify(content)}]`)
+          }
+          break
+        }
+        case 'rows': {
+          const rows = []
+          for (const v of val.rows) { rows.push(JSON.stringify(v.data)) }
+          logs.push(`[rows:${JSON.stringify(rows)}]`)
+          break
+        }
+        case 'button':
+          logs.push(`[button:${JSON.stringify(val.data)}]`)
+          break
+        default:
+          logs.push(`[未知:${JSON.stringify(val)}]`)
+      }
+    }
+    this.e.raw_message = logs.join('')
+    /** 前缀处理 */
+    this.e.group_id && 'GroupCD' in this.config && Review.alias(this.e, this.config)
+    /** 主人 这里强制是因为yaml在自动保存QQ号的时候会强制化为数字 */
+    const masterId = (Number(this.e.user_id) || String(this.e.user_id))
+    if (Config.master.includes(masterId)) {
+      this.e.isMaster = true
+      this.e.isAdmin = true
+    } else if (Config.admin.includes(masterId)) {
+      /** 管理员 */
+      this.e.isAdmin = true
+    }
+    this.GroupMsgPrint = false
+    if (this.e.contact.scene === 'private') {
+      this.e.isPrivate = true
+      this.e.logText = `[Private:${this.e.sender.nick || ''}(${this.e.user_id})]`
+      logger.bot('info', this.e.self_id, `私聊：[${this.e.user_id}(${this.e.sender.nick || ''})] ${this.e.raw_message}`)
+    } else if (this.e.contact.scene === 'group') {
+      this.e.isGroup = true
+      this.e.logText = `[Group:${this.e.group_id}-${this.e.user_id}(${this.e.sender.nick || ''})]`
+      this.GroupMsgPrint = Review.GroupMsgPrint(this.e)
+      this.GroupMsgPrint && logger.bot('info', this.e.self_id, `群消息：[${this.e.group_id}-${this.e.user_id}(${this.e.sender.nick || ''})] ${this.e.raw_message}`)
+    } else {
+      logger.bot('info', this.e.self_id, `未知消息：${JSON.stringify(this.e)}`)
+    }
+  }
+
+  /**
+     * 处理上下文
+     */
+  async context () {
+    const key = this.e.isGroup ? `${this.e.group_id}.${this.e.user_id}` : this.e.user_id
+    const App = stateArr[key]
+    if (App) {
+      const { plugin, fnc } = App
+      this.e.logFnc = `[${plugin.name}][${fnc}]`
+      /** 计算插件处理时间 */
+      const start = Date.now()
+      plugin.e = this.e
+      await plugin[fnc]()
+      logger.bot('mark', this.e.self_id, `${this.e.logFnc} 上下文处理完成 ${Date.now() - start}ms`)
+      return true
+    }
+    return false
+  }
+}

package/lib/event/message.js

@@ -0,0 +1,70 @@
+import { KarinEvent } from './event.js'
+/**
+ * - 消息事件基类
+ */
+export class KarinMessage extends KarinEvent {
+  constructor ({ event = 'message', self_id, user_id, time, message_id, message_seq = '', raw_message = '', contact, sender, elements, group_id = '' }) {
+    super({ event, event_id: message_id, self_id, user_id, group_id, time, contact, sender, sub_event: contact.scene === 'group' ? 'group_message' : 'friend_message' })
+    this.message_id = message_id
+    this.message_seq = message_seq
+    this.raw_message = raw_message
+    this.elements = elements
+    this.msg = ''
+    this.at = []
+    this.image = []
+    this.file = {}
+    this.reply_id = ''
+    this.atBot = false
+    this.atAll = false
+    this.alias = ''
+  }
+
+  /**
+     * - 消息ID
+     */
+  message_id
+  /**
+     * - 消息序列号
+     */
+  message_seq
+  /**
+     * - 原始消息文本
+     */
+  raw_message
+  /**
+     * - 消息体元素
+     */
+  elements
+  /**
+     * - 框架处理后的文本
+     */
+  msg
+  /**
+     * - 图片数组
+     */
+  image
+  /**
+     * - AT数组
+     */
+  at
+  /**
+     * - 是否AT机器人
+     */
+  atBot
+  /**
+     * - 是否AT全体
+     */
+  atAll
+  /**
+     * - 文件元素
+     */
+  file
+  /**
+     * - 引用消息ID
+     */
+  reply_id
+  /**
+     * - 消息别名
+     */
+  alias
+}

package/lib/event/notice.d.ts

@@ -0,0 +1,49 @@
+import { KarinEvent } from './event.js';
+import { contact, Sender, SubEventForEvent, NoticeEvent } from '../types/types.js';
+/**
+ * - 通知事件基类
+ */
+export declare class KarinNotice extends KarinEvent {
+    constructor({ self_id, event_id, user_id, time, contact, sender, sub_event, content, group_id, }: {
+        /**
+         * - 机器人ID 请尽量使用UID
+         */
+        self_id: string;
+        /**
+         * - 事件ID
+         */
+        event_id: string;
+        /**
+         * - 用户ID
+         */
+        user_id: string;
+        /**
+         * - 事件触发时间戳
+         */
+        time: number;
+        /**
+         * 事件联系人信息
+         */
+        contact: contact;
+        /**
+         * 事件发送者信息
+         */
+        sender: Sender;
+        /**
+         * 事件子类型
+         */
+        sub_event: SubEventForEvent<'notice'>;
+        /**
+         * 事件对应的内容参数
+         */
+        content: NoticeEvent<SubEventForEvent<'notice'>>;
+        /**
+         * 群ID
+         */
+        group_id?: string;
+    });
+    /**
+     * - 事件对应的内容参数
+     */
+    content: NoticeEvent<SubEventForEvent<'notice'>>;
+}

package/lib/event/notice.js

@@ -0,0 +1,15 @@
+import { KarinEvent } from './event.js'
+/**
+ * - 通知事件基类
+ */
+export class KarinNotice extends KarinEvent {
+  constructor ({ self_id, event_id, user_id, time, contact, sender, sub_event, content, group_id = '' }) {
+    super({ event: 'notice', event_id, self_id, user_id, group_id, time, contact, sender, sub_event })
+    this.content = content
+  }
+
+  /**
+     * - 事件对应的内容参数
+     */
+  content
+}

package/lib/event/request.d.ts

@@ -0,0 +1,49 @@
+import { KarinEvent } from './event.js';
+import { contact, Sender, SubEventForEvent, RequestEvent } from '../types/types.js';
+/**
+ * - 请求事件基类
+ */
+export declare class KarinRequest extends KarinEvent {
+    constructor({ self_id, event_id, user_id, time, contact, sender, sub_event, content, group_id, }: {
+        /**
+         * - 机器人ID 请尽量使用UID
+         */
+        self_id: string;
+        /**
+         * - 事件ID
+         */
+        event_id: string;
+        /**
+         * - 用户ID
+         */
+        user_id: string;
+        /**
+         * - 事件触发时间戳
+         */
+        time: number;
+        /**
+         * 事件联系人信息
+         */
+        contact: contact;
+        /**
+         * 事件发送者信息
+         */
+        sender: Sender;
+        /**
+         * 事件子类型
+         */
+        sub_event: SubEventForEvent<'request'>;
+        /**
+         * 事件对应的内容参数
+         */
+        content: RequestEvent<SubEventForEvent<'request'>>;
+        /**
+         * 群ID
+         */
+        group_id?: string;
+    });
+    /**
+     * - 事件对应的内容参数
+     */
+    content: RequestEvent<SubEventForEvent<'request'>>;
+}

package/lib/event/request.js

@@ -0,0 +1,15 @@
+import { KarinEvent } from './event.js'
+/**
+ * - 请求事件基类
+ */
+export class KarinRequest extends KarinEvent {
+  constructor ({ self_id, event_id, user_id, time, contact, sender, sub_event, content, group_id = '' }) {
+    super({ event: 'request', event_id, self_id, user_id, group_id, time, contact, sender, sub_event })
+    this.content = content
+  }
+
+  /**
+     * - 事件对应的内容参数
+     */
+  content
+}

package/lib/event/review.handler.d.ts

@@ -0,0 +1,54 @@
+import { E } from '../types/types.js';
+import { PluginApps } from '../types/plugin.js';
+import { GroupCfg } from '../types/config.js';
+import { KarinMessage } from '../event/message.js';
+/**
+ * 事件拦截器
+ * 利用可执行函数的特性，热更新所有拦截器
+ * 所有拦截器返回的都是布尔值 为true说明通过 为false则未通过
+ */
+declare const _default: {
+    GroupCD: {
+        [key: string]: boolean;
+    };
+    GroupUserCD: {
+        [key: string]: boolean;
+    };
+    App: import("../types/config.js").App;
+    Config: import("../types/config.js").Config;
+    CD: (e: E, config: GroupCfg) => boolean;
+    mode: (e: KarinMessage, config: GroupCfg) => boolean;
+    alias: (e: KarinMessage, config: GroupCfg) => boolean;
+    GroupEnable: (e: E) => boolean;
+    UserEnable: (e: E) => boolean;
+    GroupMsgPrint: (e: E) => boolean;
+    PluginEnable: (app: PluginApps, config: GroupCfg) => boolean;
+    main(): void;
+    /**
+     * 群聊黑白名单 允许哪个群触发事件
+     */
+    "__#2@#GroupEnable"(): true | undefined;
+    /**
+     * 用户黑白名单 允许那个用户触发事件
+     */
+    "__#2@#UserEnable"(): true | undefined;
+    /**
+     * 群聊事件日志 是否打印
+     */
+    "__#2@#GroupMsgPrint"(): true | undefined;
+    /**
+     * 黑白名单插件 哪个插件可以被触发
+     */
+    "__#2@#PluginEnable"(): boolean;
+    /** 群聊cd */
+    "__#2@#CD"(): true | undefined;
+    /**
+     * 响应模式
+     */
+    "__#2@#mode"(): true | undefined;
+    /**
+     * 前缀、别名
+     */
+    "__#2@#alias"(): true | undefined;
+};
+export default _default;