onebots 0.4.21 → 0.4.22

package/README.md

@@ -63,6 +63,7 @@ general: # 通用配置，在单个配置省略时的默认值
     reconnect_interval: 3 # 重连间隔 (秒)
     use_http: true # 是否使用 http
     enable_cors: true # 是否允许跨域
+    filters: {} # 过滤器配置
     use_ws: true # 是否使用websocket
     http_reverse: [ ] # http上报地址
     ws_reverse: [ ] # 反向ws连接地址
@@ -74,6 +75,7 @@ general: # 通用配置，在单个配置省略时的默认值
     enable_cors: true # 是否允许跨域
     use_http: true # 是否启用http
     use_ws: true # 是否启用 websocket
+    filters: {} # 过滤器配置
     webhook: [ ] # http 上报地址
     ws_reverse: [ ] # 反向ws连接地址
   protocol:
@@ -119,6 +121,7 @@ general: # 通用配置，在单个配置省略时的默认值
 | reconnect_interval  | number   | 3      | 重连间隔 单位：秒  |
 | use_http            | boolean  | false  | 是否使用http协议 |
 | enable_cors         | boolean  | false  | 是否允许跨域     |
+| filters             | Filters  | {}     | 事件过滤器配置    |
 | use_ws              | boolean  | false  | 是否使用ws协议   |
 | http_reverse_url    | string[] | -      | http上报地址地址 |
 | ws_reverse_url      | string[] | -      | 反向ws连接地址   |
@@ -130,10 +133,74 @@ general: # 通用配置，在单个配置省略时的默认值
 | request_timeout     | number   | 15    | 请求超时 单位：秒   |
 | reconnect_interval  | number   | 3     | 重连间隔 单位：秒   |
 | enable_cors         | boolean  | false | 是否允许跨域      |
+| filters             | Filters  | {}     | 事件过滤器配置    |
 | use_http            | boolean  | false | 是否使用http协议  |
 | use_ws              | boolean  | false | 是否使用ws协议    |
 | webhook_reverse_url | string[] | -     | webhook上报地址 |
 | ws_reverse_url      | string[] | -     | 反向ws连接地址    |
+# 事件过滤器
+## 语法说明
+- `onebots` 的事件过滤器最外层是一个JSON对象，其中的键是键如果是运算法，则值作为运算符的参数，如果不是运算符，则表示对事件数据对象相应 `key` 进行过滤。
+- 过滤规则中任何一个对象, 只有在它的所有项都匹配的情况下, 才会让事件通过（等价于一个 and 运算），如果值为一个数组，则表示事件对应 `key` 值需满足其中一个。
+- 可用逻辑运算符有：`$and` (逻辑与) 、`$or` (逻辑或) 、 `$not` (逻辑非)、`$nor` (逻辑异或)、`$regexp` (文本正则匹配)、`$like` (文本模糊匹配)、`$gt` (数值大于比较)、`$gte` (数值大于等于比较)、`$lt` (数值小于比较)、`$lte` (数值小于等于比较)、`$between` (数值范围比较)
+## 示例
+### 1. 仅上报私聊事件
+```yaml
+filters:
+  message_type: private
+```
+### 2. 私聊或指定群聊
+```yaml
+filters:
+  $or:
+    message_type: private
+    group_id: 
+      - 123456789
+        987654321
+```
+### 3. 私聊事件且不是指定用户
+```yaml
+filters:
+  message_type: private
+  $not:
+    user_id:
+      - 123456789
+        987654321
+```
+### 4. 私聊事件(排除指定用户的事件)或指定群聊事件
+```yaml
+filters:
+  $or:
+    - message_type: private
+      $not:
+        user_id: 123456789
+    -  
+      message_type: group
+      group_id: 987654321
+```
+### 5. 仅上报消息事件且用户年龄大于18岁
+```yaml
+filters:
+  type: message
+  sender:
+    age:
+      $gt: 18
+```
+### 6. 仅上报消息事件且消息内容以！开头的消息
+```yaml
+filters:
+  type: message
+  raw_message:
+    .regexp: '^！|\!'
+```
+### 7. 不上报消息内容包含`cnm`的消息
+```yaml
+filters:
+  $not:
+    type: message
+    raw_message:
+      $like: cnm
+```
 # 使用API管理oneBot
 
 | url     | method | params          | desc                           |
@@ -144,7 +211,6 @@ general: # 通用配置，在单个配置省略时的默认值
 | /add    | POST   | {uin,...config} | 添加机器人 config 为机器人配置            |
 | /edit   | POST   | {uin,...config} | 修改机器人配置 config 为机器人配置          |
 | /remove | get    | uin,force       | 移除机器人,force为true时，将删除机器人data目录 |
-
 # 鸣谢
 1. [icqqjs/icqq](https://github.com/icqqjs/icqq) 底层服务支持
 2. [takayama-lily/onebot](https://github.com/takayama-lily/node-onebot) oneBot V11 原先版本

package/lib/config.sample.yaml

@@ -31,7 +31,7 @@ general: # 通用配置，在单个配置省略时的默认值
 # 每个账号的单独配置(用于覆盖通用配置)
 123456789:
   version: V11 # 使用的oneBot版本
-  password:'' # 账号密码，未配置则扫码登陆
+  password: '' # 账号密码，未配置则扫码登陆
   group_whitelist: [] # 群消息派发白名单，只有数组中的群号才派发，为空则全部派发
   protocol: # 将会覆盖通用配置中的protocol
     platform: 1

package/lib/onebot.d.ts

@@ -7,6 +7,7 @@ import { Config as IcqqConfig } from 'icqq';
 import { V11 } from "./service/V11";
 import { V12 } from "./service/V12";
 import { MayBeArray } from "./types";
+import { Service } from "./service";
 export declare class NotFoundError extends Error {
     message: string;
 }
@@ -31,11 +32,13 @@ export declare enum OneBotStatus {
 }
 export type OneBotConfig = OneBot.Config<OneBot.Version>;
 export declare namespace OneBot {
+    type Filters = {};
     type Version = 'V11' | 'V12';
     type Config<V extends Version = 'V11'> = ({
         version?: V;
         password?: string;
         group_whitelist?: number[];
+        filters?: Service.Filters;
         protocol?: IcqqConfig;
     } & (V extends 'V11' ? V11.Config : V12.Config));
     interface Base {

package/lib/service/V11/action/common.d.ts

@@ -10,9 +10,9 @@ export declare class CommonAction {
     };
     /**
      * 撤回消息
-     * @param message_id {string} 消息id
+     * @param message_id {number} 消息id
      */
-    deleteMsg(this: V11, message_id: string): Promise<boolean>;
+    deleteMsg(this: V11, message_id: number): Promise<boolean>;
     /**
      * 获取消息
      * @param message_id {string} 消息id

package/lib/service/V11/action/common.js

@@ -15,10 +15,15 @@ class CommonAction {
     }
     /**
      * 撤回消息
-     * @param message_id {string} 消息id
+     * @param message_id {number} 消息id
      */
-    deleteMsg(message_id) {
-        return this.client.deleteMsg(message_id);
+    async deleteMsg(message_id) {
+        if (message_id == 0)
+            throw new Error('getMsg: message_id[0] is invalid');
+        let msg_entry = await this.db.getMsgById(message_id);
+        if (!msg_entry)
+            throw new Error(`getMsg: can not find msg[${message_id}] in db`);
+        return this.client.deleteMsg(msg_entry.base64_id);
     }
     /**
      * 获取消息

package/lib/service/V11/db_sqlite.js

@@ -15,7 +15,7 @@ class Database {
         this.logger = logger;
         this.dbLock = new types_1.AsyncLock();
         this.dataSource = new typeorm_1.DataSource({
-            type: "better-sqlite3",
+            type: "sqlite",
             database: dbPath,
             entities: [db_entities_1.MsgEntry],
         });
@@ -47,7 +47,7 @@ class Database {
             if (msgDataExists) {
                 // send_msg() 返回值和同步的 message 消息哪个先来不确定，send_msg 返回值后来时不允许更新数据库
                 if (msgData.content.length == 0) {
-                    return;
+                    return msgDataExists.id;
                 }
                 msgData.id = msgDataExists.id;
                 await this.msgRepo.update({ id: msgData.id }, msgData);

package/lib/service/V11/index.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-/// <reference types="node" />
 import { Client } from "icqq";
 import { Config } from "./config";
 import { Action } from "./action";
@@ -7,12 +6,11 @@ import { OneBot } from "../../onebot";
 import { Logger } from "log4js";
 import { WebSocket, WebSocketServer } from "ws";
 import { Dispose } from "../../types";
-import { EventEmitter } from "events";
 import { Database } from "./db_sqlite";
-export declare class V11 extends EventEmitter implements OneBot.Base {
+import { Service } from "../../service";
+export declare class V11 extends Service<'V11'> implements OneBot.Base {
     oneBot: OneBot<'V11'>;
     client: Client;
-    config: V11.Config;
     action: Action;
     version: string;
     protected timestamp: number;
@@ -28,7 +26,7 @@ export declare class V11 extends EventEmitter implements OneBot.Base {
     logger: Logger;
     wss?: WebSocketServer;
     wsr: Set<WebSocket>;
-    constructor(oneBot: OneBot<'V11'>, client: Client, config: V11.Config);
+    constructor(oneBot: OneBot<'V11'>, client: Client, config: OneBot.Config<'V11'>);
     start(path?: string): void;
     private startHttp;
     private startHttpReverse;

package/lib/service/V11/index.js

@@ -14,18 +14,17 @@ const icqq_cq_enable_1 = require("icqq-cq-enable");
 const onebot_2 = require("../../onebot");
 const http_1 = __importDefault(require("http"));
 const https_1 = __importDefault(require("https"));
-const events_1 = require("events");
 const fs_1 = require("fs");
 const db_sqlite_1 = require("./db_sqlite");
 const path_1 = require("path");
 const app_1 = require("../../server/app");
 const db_entities_1 = require("./db_entities");
-class V11 extends events_1.EventEmitter {
+const service_1 = require("../../service");
+class V11 extends service_1.Service {
     constructor(oneBot, client, config) {
-        super();
+        super(config);
         this.oneBot = oneBot;
         this.client = client;
-        this.config = config;
         this.version = 'V11';
         this.timestamp = Date.now();
         this._queue = [];
@@ -327,6 +326,7 @@ class V11 extends events_1.EventEmitter {
         msg.user_id = user_id;
         msg.nickname = '';
         msg.group_id = group_id;
+        msg.group_name = '';
         msg.content = '';
         return await this.db.addOrUpdateMsg(msg);
     }

package/lib/service/V12/index.d.ts

@@ -1,16 +1,14 @@
 /// <reference types="node" />
-/// <reference types="node" />
 import { Client, EventMap, MessageElem, Sendable as IcqqCanSend } from "icqq";
 import { Config } from './config';
 import { OneBot } from "../../onebot";
 import { Action } from "./action";
-import { EventEmitter } from "events";
 import { Logger } from "log4js";
 import { WebSocket, WebSocketServer } from "ws";
-export declare class V12 extends EventEmitter implements OneBot.Base {
+import { Service } from "../../service";
+export declare class V12 extends Service<'V12'> implements OneBot.Base {
     oneBot: OneBot<'V12'>;
     client: Client;
-    config: V12.Config;
     version: string;
     action: Action;
     protected timestamp: number;
@@ -20,7 +18,7 @@ export declare class V12 extends EventEmitter implements OneBot.Base {
     wss?: WebSocketServer;
     wsr: Set<WebSocket>;
     private db;
-    constructor(oneBot: OneBot<'V12'>, client: Client, config: V12.Config);
+    constructor(oneBot: OneBot<'V12'>, client: Client, config: OneBot.Config<'V12'>);
     get history(): V12.Payload<keyof Action>[];
     getFile(file_id: string): V12.FileInfo;
     delFile(file_id: string): boolean;

package/lib/service/V12/index.js

@@ -9,7 +9,6 @@ const utils_1 = require("../../utils");
 const path_1 = require("path");
 const onebot_1 = require("../../onebot");
 const action_1 = require("./action");
-const events_1 = require("events");
 const url_1 = require("url");
 const http_1 = __importDefault(require("http"));
 const https_1 = __importDefault(require("https"));
@@ -19,12 +18,12 @@ const db_1 = require("../../db");
 const app_1 = require("../../server/app");
 const fs_1 = require("fs");
 const message_1 = require("icqq/lib/message");
-class V12 extends events_1.EventEmitter {
+const service_1 = require("../../service");
+class V12 extends service_1.Service {
     constructor(oneBot, client, config) {
-        super();
+        super(config);
         this.oneBot = oneBot;
         this.client = client;
-        this.config = config;
         this.version = 'V12';
         this.timestamp = Date.now();
         this.wsr = new Set();
@@ -369,6 +368,8 @@ class V12 extends events_1.EventEmitter {
                 return value + '';
             }),
         };
+        if (!this.filterFn(payload))
+            return;
         this.emit('dispatch', payload);
     }
     async apply(req) {

package/lib/service/shareMusicCustom.js

@@ -17,8 +17,8 @@ async function buildMusic(target, bu, music) {
         let { singer = null, title = null, jumpUrl = null, musicUrl = null, preview = null } = music.id ? await getMusicInfo(music.id) : {};
         singer = music['content'] || music.singer || singer; // 自定义参数优先级高于默认值(gocq的参数名与icqq有区别，做下兼容)
         title = music.title || title;
-        jumpUrl = music.jumpUrl || jumpUrl;
-        musicUrl = music['url'] || music['voice'] || music.musicUrl || musicUrl;
+        jumpUrl = music.jumpUrl || music['url'] || jumpUrl;
+        musicUrl = music['voice'] || music['url'] || music.musicUrl || musicUrl;
         preview = music['image'] || music.preview || preview;
         if (!musicUrl)
             style = 0;

package/lib/service.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="node" />
+import { EventEmitter } from "events";
+import { OneBot } from "./onebot";
+import { Dict } from "@zhinjs/shared";
+export interface Service<V extends OneBot.Version> {
+    filterFn(event: Dict): boolean;
+}
+export declare class Service<V extends OneBot.Version> extends EventEmitter {
+    config: OneBot.Config<V>;
+    constructor(config: OneBot.Config<V>);
+}
+export declare namespace Service {
+    type MaybeArray<T = any> = T | T[];
+    type AttrFilter = {
+        [P in keyof Dict]?: MaybeArray | boolean;
+    };
+    export type Filters = AttrFilter | WithFilter | UnionFilter | ExcludeFilter;
+    export type WithFilter = {
+        $and: Filters;
+    };
+    export type UnionFilter = {
+        $or: Filters;
+    };
+    export type ExcludeFilter = {
+        $not: Filters;
+    };
+    export function createFilterFunction(filters: Filters): (event: Dict) => any;
+    export {};
+}

package/lib/service.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Service = void 0;
+const events_1 = require("events");
+class Service extends events_1.EventEmitter {
+    constructor(config) {
+        super();
+        this.config = config;
+        this.filterFn = Service.createFilterFunction(config.filters || {});
+    }
+}
+exports.Service = Service;
+(function (Service) {
+    function createFilterFunction(filters) {
+        const isLogicKey = (key) => {
+            return [
+                '$and',
+                '$or',
+                '$not',
+                '$nor',
+                '$regexp',
+                '$like',
+                '$gt',
+                '$gte',
+                '$lt',
+                '$lte',
+                '$between',
+            ].includes(key);
+        };
+        const filterFn = (event, key, value) => {
+            // 如果 key 为 $and、$or、$not、$nor 则递归调用
+            if (key === "$and" || key === "$or" || key === "$not" || key === '$nor') {
+                if (!value || typeof value !== 'object')
+                    throw new Error("invalid filter");
+                switch (key) {
+                    case "$and":
+                        return Array.isArray(value) ? value.every((item) => filterFn(event, key, item)) :
+                            Object.entries(value).every(([key, value]) => filterFn(event, key, value));
+                    case "$or":
+                        return Array.isArray(value) ? value.some((item) => filterFn(event, key, item)) :
+                            Object.entries(value).some(([key, value]) => filterFn(event, key, value));
+                    case "$nor":
+                        return !filterFn(event, '$or', value);
+                    case "$not":
+                        return !filterFn(event, '$and', value);
+                }
+            }
+            if (typeof value === "boolean" && typeof event[key] !== "boolean") {
+                return value;
+            }
+            if (typeof value !== "object") {
+                if (key === '$regex' && typeof value === 'string')
+                    return new RegExp(value).test(String(event));
+                if (key === '$like' && typeof value === 'string')
+                    return String(event).includes(value);
+                if (key === '$gt' && typeof value === 'number')
+                    return Number(event) > value;
+                if (key === '$gte' && typeof value === 'number')
+                    return Number(event) >= value;
+                if (key === '$lt' && typeof value === 'number')
+                    return Number(event) < value;
+                if (key === '$lte' && typeof value === 'number')
+                    return Number(event) <= value;
+                return value === event[key];
+            }
+            if (key === '$between' &&
+                Array.isArray(value) &&
+                value.length === 2 &&
+                value.every((item) => typeof item === 'number')) {
+                const [start, end] = value;
+                return event >= start && event <= end;
+            }
+            if (Array.isArray(value)) {
+                return value.includes(event[key]);
+            }
+            return createFilterFunction(value)(isLogicKey(key) ? event : event[key]);
+        };
+        return (event) => {
+            return Object.entries(filters).every(([key, value]) => filterFn(event, key, value));
+        };
+    }
+    Service.createFilterFunction = createFilterFunction;
+})(Service || (exports.Service = Service = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onebots",
-  "version": "0.4.21",
+  "version": "0.4.22",
   "description": "基于icqq的多例oneBot实现",
   "engines": {
     "node": ">=16"
@@ -14,10 +14,10 @@
     "build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json && cp -r src/config.sample.yaml lib/config.sample.yaml",
     "dev": "ts-node-dev -r tsconfig-paths/register ./src/bin.ts -c config.yaml",
     "pub": "npm publish --access public",
+    "test": "ts-node-dev -r tsconfig-paths/register ./src/test.ts",
     "docs:dev": "vitepress dev docs --port 8989",
     "docs:build": "vitepress build docs",
-    "docs:preview": "vitepress preview docs",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "docs:preview": "vitepress preview docs"
   },
   "repository": {
     "type": "git",
@@ -64,9 +64,9 @@
     "koa-bodyparser": "^4.3.0",
     "log4js": "^6.5.2",
     "mime-types": "^2.1.35",
-    "ws": "^8.8.0",
-    "better-sqlite3": "^8.6.0",
     "reflect-metadata": "^0.1.13",
-    "typeorm": "^0.3.17"
+    "sqlite3": "^5.1.6",
+    "typeorm": "^0.3.17",
+    "ws": "^8.8.0"
   }
 }