node-karin 0.7.2 → 0.8.0

package/config/defSet/App.yaml

@@ -35,3 +35,8 @@ GroupConfig:
 
   # 黑名单插件、功能，黑名单中的插件、功能不会响应
   disable: false
+
+# 私聊
+PrivateConfig:
+  # 是否开启私聊
+  enable: false

package/config/defSet/config.yaml

@@ -17,6 +17,13 @@ multi_progress: false
 # 控制台触发插件日志颜色 十六进制 默认#FFFF00 不支持热更新
 log_color: "#E1D919"
 
+# 私聊设置
+private:
+  # 关闭私聊后回复的提示词 为空则不回复
+  tips: ""
+  # 关闭私聊后的用户白名单
+  white_list: []
+
 # input适配器配置 以下所有配置均不支持热更新
 AdapterInput:
   # 是否启用

package/config/view/App.yaml

@@ -1,74 +1,67 @@
 name: 应用配置
 view:
-  -
-    key: 黑名单
+  - key: 黑名单
     comment: 黑名单相关
-    path: 'BlackList'
-    type: 'group'
+    path: "BlackList"
+    type: "group"
     part:
-        -
-          key: 黑名单用户
-          path: 'BlackList.users'
-          type: 'boolean'
-        -
-          key: 黑名单群聊
-          path: 'BlackList.groups'
-          type: 'boolean'
-        -
-          key: 消息日志黑名单群聊
-          comment: 设置后不会打印该群的消息日志
-          path: 'BlackList.GroupMsgLog'
-          type: 'boolean'
-  -
-    key: 白名单
+      - key: 黑名单用户
+        path: "BlackList.users"
+        type: "boolean"
+      - key: 黑名单群聊
+        path: "BlackList.groups"
+        type: "boolean"
+      - key: 消息日志黑名单群聊
+        comment: 设置后不会打印该群的消息日志
+        path: "BlackList.GroupMsgLog"
+        type: "boolean"
+  - key: 白名单
     comment: 白名单相关
-    path: 'WhiteList'
-    type: 'group'
+    path: "WhiteList"
+    type: "group"
     part:
-        -
-          key: 白名单用户
-          path: 'WhiteList.users'
-          type: 'boolean'
-        -
-          key: 白名单群聊
-          path: 'WhiteList.groups'
-          type: 'boolean'
-        -
-          key: 消息日志白名单群聊
-          comment: 消息日志白名单群聊 设置后只会打印该群的消息日志
-          path: 'WhiteList.GroupMsgLog'
-          type: 'boolean'
-  -
-    key: 群聊
-    path: 'GroupConfig'
-    type: 'group'
+      - key: 白名单用户
+        path: "WhiteList.users"
+        type: "boolean"
+      - key: 白名单群聊
+        path: "WhiteList.groups"
+        type: "boolean"
+      - key: 消息日志白名单群聊
+        comment: 消息日志白名单群聊 设置后只会打印该群的消息日志
+        path: "WhiteList.GroupMsgLog"
+        type: "boolean"
+  - key: 群聊
+    path: "GroupConfig"
+    type: "group"
     part:
-        -
-          key: 消息冷却时间
-          comment: 群聊中所有消息冷却时间
-          path: 'GroupConfig.GroupCD'
-          type: 'boolean'
-        -
-          key: 个人消息冷却时间
-          comment: 群聊中 每个人的消息冷却时间
-          path: 'GroupConfig.GroupUserCD'
-          type: 'boolean'
-        -
-          key: 机器人响应模式
-          path: 'GroupConfig.mode'
-          type: 'boolean'
-        -
-          key: 机器人前缀
-          comment: 机器人前缀 设置后前缀+指令触发机器人
-          path: 'GroupConfig.alias'
-          type: 'boolean'
-        -
-          key: 白名单插件、功能
-          comment: 白名单插件、功能，只有在白名单中的插件、功能才会响应
-          path: 'GroupConfig.enable'
-          type: 'boolean'
-        -
-          key: 黑名单插件、功能
-          comment: 黑名单插件、功能，黑名单中的插件、功能不会响应
-          path: 'GroupConfig.disable'
-          type: 'boolean'
+      - key: 消息冷却时间
+        comment: 群聊中所有消息冷却时间
+        path: "GroupConfig.GroupCD"
+        type: "boolean"
+      - key: 个人消息冷却时间
+        comment: 群聊中 每个人的消息冷却时间
+        path: "GroupConfig.GroupUserCD"
+        type: "boolean"
+      - key: 机器人响应模式
+        path: "GroupConfig.mode"
+        type: "boolean"
+      - key: 机器人前缀
+        comment: 机器人前缀 设置后前缀+指令触发机器人
+        path: "GroupConfig.alias"
+        type: "boolean"
+      - key: 白名单插件、功能
+        comment: 白名单插件、功能，只有在白名单中的插件、功能才会响应
+        path: "GroupConfig.enable"
+        type: "boolean"
+      - key: 黑名单插件、功能
+        comment: 黑名单插件、功能，黑名单中的插件、功能不会响应
+        path: "GroupConfig.disable"
+        type: "boolean"
+  - key: 私聊
+    path: "PrivateConfig"
+    type: "group"
+    part:
+      - key: 是否开启私聊
+        comment: 是否开启私聊
+        path: "PrivateConfig.enable"
+        type: "boolean"

package/config/view/config.yaml

@@ -1,102 +1,170 @@
 name: 通用配置
 view:
-  - key: 日志等级
-    comment: 日志等级:trace,debug,info,warn,fatal,mark,error,off
-    path: "log_level"
-    type: "select"
-    multiple: false
-    item:
-      - name: Trace
-        value: trace
-      - name: Debug
-        value: ebug
-      - name: Info
-        value: info
-      - name: Warn
-        value: warn
-      - name: Fatal
-        value: fatal
-      - name: Mark
-        value: mark
-      - name: Error
-        value: error
-      - name: Off
-        value: off
-  - key: 日志保留天数
-    path: "log_days_Keep"
-    type: "number"
+  - key: 日志配置
+    comment: log4js日志配置
+    path: log4jsCfg
+    type: group
+    part:
+      - key: 日志等级
+        comment: 日志等级:trace,debug,info,warn,fatal,mark,error,off
+        path: log_level
+        type: select
+        multiple: false
+        item:
+          - name: Trace
+            value: trace
+          - name: Debug
+            value: ebug
+          - name: Info
+            value: info
+          - name: Warn
+            value: warn
+          - name: Fatal
+            value: fatal
+          - name: Mark
+            value: mark
+          - name: Error
+            value: error
+          - name: Off
+            value: off
+      - key: 日志保留天数
+        path: log_days_Keep
+        type: number
+      - key: 整体化
+        comment: 将日志输出到一个文件(一天为一个文件) 日志较多的情况下不建议与碎片化同时开启
+        path: overall
+        type: boolean
+      - key: 碎片化
+        comment: 将日志分片，达到指定大小后自动切割 日志较多的情况下不建议与整体化同时开启
+        path: fragments
+        type: boolean
+      - key: 日志文件最大大小
+        comment: 日志文件最大大小 MB
+        path: maxLogSize
+        type: number
+
+  - key: 后台进程
+    comment: 关闭后台进程失败后是否继续启动 继续启动会导致多进程
+    path: multi_progress
+    type: boolean
+
+  - key: 控制台插件日志颜色
+    comment: 控制台触发插件日志颜色 十六进制 默认#FFFF00 不支持热更新
+    path: log_color
+    type: text
+
+  - key: 私聊设置
+    comment: 私聊设置
+    path: private
+    type: group
+    part:
+      - key: 关闭私聊提示词
+        comment: 关闭私聊后回复的提示词 为空则不回复
+        path: tips
+        type: text
+      - key: 关闭私聊白名单
+        comment: 关闭私聊后的用户白名单
+        path: white_list
+        type: array
+
+  - key: input适配器配置
+    comment: input适配器配置 以下所有配置均不支持热更新
+    path: AdapterInput
+    type: group
+    part:
+      - key: 是否启用
+        comment: 是否启动input适配器
+        path: enable
+        type: boolean
+      - key: 是否转为文件
+        comment: 是否将语音、图片、视频消息转为文件 转为文件后可通过url访问
+        path: msgToFile
+        type: boolean
+      - key: url访问token
+        comment: url访问token 如果为 AdapterInput 每次启动后会重新生成
+        path: token
+        type: text
+      - key: 访问ip
+        comment: 访问ip
+        path: ip
+        type: text
+
   - key: ffmpeg路径
     comment: ffmpeg配置 用于音视频处理
-    path: "ffmpeg_path"
-    type: "text"
+    path: ffmpeg_path
+    type: text
+
   - key: ffprobe路径
     comment: ffmpeg配置 用于音视频处理
-    path: "ffprobe_path"
-    type: "text"
+    path: ffprobe_path
+    type: text
+
   - key: 主人列表
     comment: 主人列表 主权限
-    path: "master"
-    type: "array"
-    arrayType: "number"
+    path: master
+    type: array
+    arrayType: number
+
   - key: 管理员列表
     comment: 管理员列表 子权限
-    path: "admin"
-    type: "array"
-    arrayType: "number"
+    path: admin
+    type: array
+    arrayType: number
+
   - key: 黑名单
     comment: 黑名单相关
-    path: "BlackList"
-    type: "group"
+    path: BlackList
+    type: group
     part:
       - key: 黑名单用户
-        path: "BlackList.users"
-        type: "array"
-        arrayType: "number"
+        path: BlackList.users
+        type: array
+        arrayType: number
         associated:
           - file: App
-            path: "BlackList.users"
+            path: BlackList.users
             requirement: true
       - key: 黑名单群聊
-        path: "BlackList.groups"
-        type: "array"
-        arrayType: "number"
+        path: BlackList.groups
+        type: array
+        arrayType: number
         associated:
           - file: App
-            path: "BlackList.groups"
+            path: BlackList.groups
             requirement: true
       - key: 消息日志黑名单群聊
         comment: 设置后不会打印该群的消息日志
-        path: "BlackList.GroupMsgLog"
-        type: "array"
-        arrayType: "number"
+        path: BlackList.GroupMsgLog
+        type: array
+        arrayType: number
         associated:
           - file: App
-            path: "BlackList.GroupMsgLog"
+            path: BlackList.GroupMsgLog
             requirement: true
   - key: 白名单
     comment: 白名单相关
-    path: "WhiteList"
-    type: "group"
+    path: WhiteList
+    type: group
     part:
       - key: 白名单用户
-        path: "WhiteList.users"
-        type: "boolean"
+        path: WhiteList.users
+        type: boolean
         associated:
           - file: App
-            path: "WhiteList.users"
+            path: WhiteList.users
             requirement: true
       - key: 白名单群聊
-        path: "WhiteList.groups"
-        type: "boolean"
+        path: WhiteList.groups
+        type: boolean
         associated:
           - file: App
-            path: "WhiteList.groups"
+            path: WhiteList.groups
             requirement: true
       - key: 消息日志白名单群聊
         comment: 消息日志白名单群聊 设置后只会打印该群的消息日志
-        path: "WhiteList.GroupMsgLog"
-        type: "boolean"
+        path: WhiteList.GroupMsgLog
+        type: boolean
         associated:
           - file: App
-            path: "WhiteList.GroupMsgLog"
+            path: WhiteList.GroupMsgLog
             requirement: true

package/config/view/redis.yaml

@@ -1,25 +1,20 @@
 name: 数据库配置
 view:
-  -
-    key: redis地址
-    path: 'host'
-    type: 'text'
-  -
-    key: redis端口
-    path: 'port'
-    type: 'number'
-  -
-    key: redis用户名
+  - key: redis地址
+    path: "host"
+    type: "text"
+  - key: redis端口
+    path: "port"
+    type: "number"
+  - key: redis用户名
     comment: redis用户名，可以为空
-    path: 'username'
-    type: 'text'
-  -
-    key: redis密码
+    path: "username"
+    type: "text"
+  - key: redis密码
     comment: redis密码，没有密码可以为空
-    path: 'password'
-    type: 'password'
-  -
-    key: 数据库
+    path: "password"
+    type: "password"
+  - key: 数据库
     comment: 运行中第几个redis数据库
-    path: 'db'
-    type: 'number'
+    path: "db"
+    type: "number"

package/config/view/server.yaml

@@ -1,93 +1,73 @@
 name: 服务配置
 view:
-  -
-    key: 热更新是否重启服务
+  - key: 热更新是否重启服务
     comment: 当前文件热更新是否重启http、grpc服务
-    path: 'HotUpdate'
-    type: 'boolean'
-  -
-    key: http 服务器配置
-    path: 'http'
-    type: 'group'
+    path: "HotUpdate"
+    type: "boolean"
+  - key: http 服务器配置
+    path: "http"
+    type: "group"
     part:
-        -
-          key: 监听地址
-          path: 'http.host'
-          type: 'text'
-        -
-          key: 端口
-          path: 'http.port'
-          type: 'number'
-  -
-    key: grpc 服务器配置
-    path: 'grpc'
-    type: 'group'
+      - key: 监听地址
+        path: "http.host"
+        type: "text"
+      - key: 端口
+        path: "http.port"
+        type: "number"
+  - key: grpc 服务器配置
+    path: "grpc"
+    type: "group"
     part:
-        -
-          key: 监听地址
-          path: 'grpc.host'
-          type: 'text'
-        -
-          key: Api请求超时时间
-          path: 'grpc.timeout'
-          type: 'number'
-          suffix: 秒
-  -
-    key: websocket 服务器配置
-    path: 'websocket'
-    type: 'group'
+      - key: 监听地址
+        path: "grpc.host"
+        type: "text"
+      - key: Api请求超时时间
+        path: "grpc.timeout"
+        type: "number"
+        suffix: 秒
+  - key: websocket 服务器配置
+    path: "websocket"
+    type: "group"
     part:
-        -
-          key: API请求超时时间
-          path: 'websocket.timeout'
-          type: 'number'
-          suffix: 秒
-        -
-          key: websocket 渲染器地址
-          comment: ws://127.0.0.1:7005/ws/render
-          path: 'websocket.render'
-          type: 'array'
-          arrayType: 'text'
-        -
-          key: onebot11 正向WebSocket地址
-          path: 'websocket.OneBot11Host'
-          type: 'array'
-          arrayType: 'text'
-        -
-          key: onebot12 正向WebSocket地址
-          path: 'websocket.OneBot12Host'
-          type: 'array'
-          arrayType: 'text'
-  -
-    key: HTTP渲染器配置
-    path: 'HttpRender'
-    type: 'group'
+      - key: API请求超时时间
+        path: "websocket.timeout"
+        type: "number"
+        suffix: 秒
+      - key: websocket 渲染器地址
+        comment: ws://127.0.0.1:7005/ws/render
+        path: "websocket.render"
+        type: "array"
+        arrayType: "text"
+      - key: onebot11 正向WebSocket地址
+        path: "websocket.OneBot11Host"
+        type: "array"
+        arrayType: "text"
+      - key: onebot12 正向WebSocket地址
+        path: "websocket.OneBot12Host"
+        type: "array"
+        arrayType: "text"
+  - key: HTTP渲染器配置
+    path: "HttpRender"
+    type: "group"
     part:
-        -
-          key: 是否开启http渲染
-          path: 'HttpRender.enable'
-          type: 'boolean'
-        -
-          key: karin端Api地址
-          comment: 公网 > 局域网 > 127
-          path: 'HttpRender.host'
-          type: 'url'
-        -
-          key: karin-puppeteer渲染器 post请求地址
-          path: 'HttpRender.post'
-          type: 'url'
-        -
-          key: karin-puppeteer渲染器 post请求token
-          path: 'HttpRender.token'
-          type: 'text'
-        -
-          key: 请求的非html或非有效路径的返回内容
-          comment: 可以填http地址 例如：https://ys.mihoyo.com
-          path: 'HttpRender.not_found'
-          type: 'text'
-        -
-          key: Wormhole代理地址
-          comment: 无公网IP环境的情况下使用
-          path: 'HttpRender.WormholeClient'
-          type: 'text'
-
+      - key: 是否开启http渲染
+        path: "HttpRender.enable"
+        type: "boolean"
+      - key: karin端Api地址
+        comment: 公网 > 局域网 > 127
+        path: "HttpRender.host"
+        type: "url"
+      - key: karin-puppeteer渲染器 post请求地址
+        path: "HttpRender.post"
+        type: "url"
+      - key: karin-puppeteer渲染器 post请求token
+        path: "HttpRender.token"
+        type: "text"
+      - key: 请求的非html或非有效路径的返回内容
+        comment: 可以填http地址 例如：https://ys.mihoyo.com
+        path: "HttpRender.not_found"
+        type: "text"
+      - key: Wormhole代理地址
+        comment: 无公网IP环境的情况下使用
+        path: "HttpRender.WormholeClient"
+        type: "text"

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

@@ -14,6 +14,10 @@ export default class EventHandler {
      * 事件处理
      */
     review(): boolean;
+    /**
+     * 处理私聊功能 功能开启返回true
+     */
+    private(): boolean;
     /**
      * 根据事件类型过滤事件
      */

package/lib/event/event.handler.js

@@ -43,6 +43,22 @@ export default class EventHandler {
     return false
   }
 
+  /**
+     * 处理私聊功能 功能开启返回true
+     */
+  private () {
+    /** 检查私聊是否开启 */
+    if (this.e.user_id !== 'input' && this.e.isPrivate && !review.Private()) {
+      /** 用户处于白名单 */
+      if (config.Config?.private?.white_list?.includes(String(this.e.user_id))) { return true }
+      /** 不处于白名单 检查是否存在提示词 */
+      if (config.Config?.private?.tips) { this.e.reply(config.Config.private.tips) }
+      logger.debug('[消息拦截] 私聊功能未开启')
+      return false
+    }
+    return true
+  }
+
   /**
      * 根据事件类型过滤事件
      */

package/lib/event/message.handler.js

@@ -27,6 +27,8 @@ export class MessageHandler extends EventHandler {
     }
     /** 处理回复 */
     this.reply()
+    /** 处理私聊 */
+    if (!this.private()) { return }
     /** 处理消息 */
     this.deal()
   }

package/lib/event/notice.handler.js

@@ -36,6 +36,7 @@ export default class NoticeHandler extends EventHandler {
       this.e.isPrivate = true
       this.e.logText = `[Private:${this.e.sender.nick || ''}(${this.e.user_id})]`
       logger.bot('info', this.e.self_id, `${logger.green('私聊通知: ')}[${this.e.user_id}(${this.e.sender.nick || ''})] ${this.e.raw_message}`)
+      if (!this.private()) { return }
     } 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 || ''})]`

package/lib/event/request.handler.js

@@ -36,6 +36,7 @@ export default class RequestHandler extends EventHandler {
       this.e.isPrivate = true
       this.e.logText = `[Private:${this.e.sender.nick || ''}(${this.e.user_id})]`
       logger.bot('info', this.e.self_id, `${logger.green('私聊请求: ')}[${this.e.user_id}(${this.e.sender.nick || ''})] ${this.e.raw_message}`)
+      if (!this.private()) { return }
     } 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 || ''})]`

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

@@ -20,6 +20,7 @@ export declare const review: {
     UserEnable: (e: KarinEventTypes) => boolean;
     GroupMsgPrint: (e: KarinEventTypes) => boolean;
     PluginEnable: (app: PluginApps, config: GroupCfg) => boolean;
+    Private: () => boolean;
     main(): void;
     /**
      * 群聊黑白名单 允许哪个群触发事件
@@ -47,4 +48,8 @@ export declare const review: {
      * 前缀、别名
      */
     "__#1@#alias"(): true | undefined;
+    /**
+     * 私聊功能
+     */
+    "__#1@#Private"(): true | undefined;
 };

package/lib/event/review.handler.js

@@ -16,6 +16,7 @@ export const review = new (class Handler {
   UserEnable
   GroupMsgPrint
   PluginEnable
+  Private
   constructor () {
     /** 群聊所有消息cd */
     this.GroupCD = {}
@@ -35,6 +36,8 @@ export const review = new (class Handler {
     this.GroupMsgPrint = e => true
     /** 插件黑白名单 哪个插件可以被触发 */
     this.PluginEnable = (app, config) => true
+    /** 私聊功能 */
+    this.Private = () => false
     // 延迟1秒执行
     setTimeout(() => {
       this.main()
@@ -51,6 +54,7 @@ export const review = new (class Handler {
     this.#UserEnable()
     this.#GroupMsgPrint()
     this.#PluginEnable()
+    this.#Private()
   }
 
   /**
@@ -366,4 +370,17 @@ export const review = new (class Handler {
     /** 未启用 */
     this.alias = () => true
   }
+
+  /**
+     * 私聊功能
+     */
+  #Private () {
+    /** 启用 */
+    if (this.App.PrivateConfig?.enable) {
+      this.Private = () => true
+      return true
+    }
+    /** 未启用 */
+    this.Private = () => false
+  }
 })()

package/lib/types/config.d.ts

@@ -97,6 +97,13 @@ export interface App {
          */
         disable: boolean;
     };
+    /**
+     * 私聊
+     */
+    PrivateConfig: {
+        /** 是否开启私聊 */
+        enable: boolean;
+    };
 }
 export interface Config {
     /**
@@ -210,6 +217,14 @@ export interface Config {
          */
         maxLogSize: number;
     };
+    private: {
+        /** 是否开启私聊 */
+        enable: boolean;
+        /** 关闭私聊后回复的提示词 为空则不回复 */
+        tips: string;
+        /** 关闭私聊后的用户白名单 */
+        white_list: string[];
+    };
 }
 export interface Server {
     /**

package/lib/utils/config.js

@@ -181,6 +181,10 @@ export const config = new (class Cfg {
       },
       master: data.master.map((i) => String(i)),
       admin: data.admin.map((i) => String(i)),
+      private: {
+        white_list: data.private.white_list.map((i) => String(i)),
+        tips: data.private.tips,
+      },
     }
     /** 缓存 */
     this.change.set(key, Config)

package/package.json

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