onebots 0.2.6 → 0.4.0

package/lib/config.sample.yaml

@@ -0,0 +1,33 @@
+port: 6727 # 监听端口
+log_level: info # 日志等级
+platform: 5 # 机器人客户端协议（1:Android 2:APad 3:Watch 4:IMac 5:IPad）
+timeout: 30 #登录超时时间(秒)
+general: # 通用配置，在单个配置省略时的默认值
+  V11: # oneBotV11的通用配置
+    heartbeat: 3 # 心跳间隔 (秒)
+    access_token: '' # 访问api的token
+    post_timeout: 15 # 上报超时时间，(秒)
+    secret: '' # 上报数据的sha1签名密钥
+    rate_limit_interval: 4 # ws心跳间隔(秒)
+    post_message_format: string # "string"或"array"
+    reconnect_interval: 3 # 重连间隔 (秒)
+    use_http: true # 是否使用 http
+    enable_cors: true # 是否允许跨域
+    use_ws: true # 是否使用websocket
+    http_reverse: [ ] # http上报地址
+    ws_reverse: [ ] # 反向ws连接地址
+  V12: # oneBotV12的通用配置
+    heartbeat: 3 # 心跳间隔 (秒)
+    access_token: '' # 访问api的token
+    request_timeout: 15 # 上报超时时间 (秒)
+    reconnect_interval: 3 # 重连间隔 (秒)
+    enable_cors: true # 是否允许跨域
+    use_http: true # 是否启用http
+    use_ws: true # 是否启用 websocket
+    webhook: [ ] # http 上报地址
+    ws_reverse: [ ] # 反向ws连接地址
+# 每个账号的单独配置(用于覆盖通用配置)
+123456789:
+  version: V11 # 使用的oneBot版本
+  password: abcedfghi # 账号密码，未配置则扫码登陆
+  # 。。。其他配置项参见上方对应oneBot版本的通用配置

package/lib/db.d.ts

@@ -1,15 +1,14 @@
-export declare class Db {
+import { Keys, Value } from "@zhinjs/shared";
+export declare class Database<T extends object = object> {
     private readonly path;
     private data;
-    private raw_data;
-    constructor(path: string, force_create?: boolean);
-    get(key: string, escape?: boolean): any;
-    set(key: string, value: any, escape?: boolean): any;
-    has(key: string, escape?: boolean): boolean;
-    delete(key: string, escape?: boolean): boolean;
-    write(): void;
+    constructor(path: string);
+    sync(defaultValue: T): void;
+    get<K extends Keys<T>>(key: K): Value<T, K>;
+    delete<K extends Keys<T>>(key: K): boolean;
+    set<K extends Keys<T>>(key: K, value: Value<T, K>): void;
 }
-export declare namespace Db {
+export declare namespace Database {
     interface Config {
         path: string;
         force?: boolean;

package/lib/db.js

@@ -1,76 +1,58 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Db = void 0;
+exports.Database = void 0;
 const fs_1 = require("fs");
-class Db {
-    constructor(path, force_create = true) {
+const shared_1 = require("@zhinjs/shared");
+class Database {
+    constructor(path) {
         this.path = path;
         this.data = {};
-        this.raw_data = '{}';
         if (!this.path.toLowerCase().endsWith('.json'))
             this.path = this.path + '.json';
-        if (!(0, fs_1.existsSync)(this.path) && force_create) {
-            (0, fs_1.writeFileSync)(this.path, this.raw_data);
-        }
-        try {
-            const raw_data = (0, fs_1.readFileSync)(this.path, 'utf8');
-            this.raw_data = raw_data || this.raw_data;
-            this.data = JSON.parse(this.raw_data);
-        }
-        catch (error) {
-            const { message } = error;
-            if (!message.includes('ENOENT: no such file or directory')) {
-                throw error;
-            }
+        if (!(0, fs_1.existsSync)(this.path)) {
+            (0, fs_1.writeFileSync)(this.path, "", "utf-8");
         }
     }
-    get(key, escape = true) {
-        const func = new Function(`return this.data.${key}`);
-        const _this = this;
-        let result;
+    sync(defaultValue) {
         try {
-            result = escape ? func.apply(this) : this.data[key];
+            this.data = JSON.parse((0, fs_1.readFileSync)(this.path, 'utf-8'));
         }
         catch {
-            throw new Error('不可达的位置:' + key.toString());
+            this.data = defaultValue;
+            (0, fs_1.writeFileSync)(this.path, JSON.stringify(defaultValue, null, 2), "utf-8");
         }
-        return result && typeof result === 'object' ? new Proxy(result, {
-            get(target, p, receiver) {
-                return Reflect.get(target, p, receiver);
+    }
+    get(key) {
+        const value = (0, shared_1.getValue)(this.data, key);
+        if (typeof value !== 'object')
+            return value;
+        const saveValue = () => {
+            this.set(key, value);
+        };
+        return new Proxy(value, {
+            set(target, k, v) {
+                const res = Reflect.set(target, k, v);
+                saveValue();
+                return res;
+            },
+            deleteProperty(target, p) {
+                const res = Reflect.deleteProperty(target, p);
+                saveValue();
+                return res;
             },
-            set(target, p, value, receiver) {
-                const res = Reflect.set(target, p, value, receiver);
-                _this.set(key, result);
+            defineProperty(target, p, r) {
+                const res = Reflect.defineProperty(target, p, r);
+                saveValue();
                 return res;
             }
-        }) : result;
-    }
-    set(key, value, escape = true) {
-        const func = new Function('value', `return this.data.${key}=value`);
-        let result = escape ? func.apply(this, [value]) : this.data[key] = value;
-        this.write();
-        return result;
+        });
     }
-    has(key, escape = true) {
-        return escape ? new Function(`return !!this.data.${key}`).apply(this) : !!this.data[key];
+    delete(key) {
+        return (0, shared_1.deleteValue)(this.data, key);
     }
-    delete(key, escape = true) {
-        const result = escape ? new Function(`return delete this.data.${key}`).apply(this) : delete this.data[key];
-        this.write();
-        return result;
-    }
-    write() {
-        try {
-            const raw_data = JSON.stringify(this.data);
-            if (raw_data !== this.raw_data) {
-                (0, fs_1.writeFileSync)(this.path, raw_data);
-                this.raw_data = raw_data;
-            }
-        }
-        catch (error) {
-            this.data = JSON.parse(this.raw_data);
-            throw error;
-        }
+    set(key, value) {
+        (0, shared_1.setValue)(this.data, key, value);
+        return (0, fs_1.writeFileSync)(this.path, JSON.stringify(this.data, null, 2), 'utf-8');
     }
 }
-exports.Db = Db;
+exports.Database = Database;

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

@@ -1,6 +1,5 @@
 import { V12 } from '../../../service/V12';
 import { Action } from "./";
-import { V11 } from "../../../service/V11";
 export declare class CommonAction {
     sendMessage(): void;
     /**
@@ -18,7 +17,7 @@ export declare class CommonAction {
      * 获取 Cookies
      * @param domain {string} 域名
      */
-    getCookies(this: V11, domain: string): string;
+    getCookies(this: V12, domain: string): string;
     getStatus(this: V12): {
         good: boolean;
         bots: {
@@ -40,4 +39,7 @@ export declare class CommonAction {
     login(this: V12, password?: string): Promise<unknown>;
     logout(this: V12, keepalive?: boolean): Promise<unknown>;
     getSupportedActions(this: V12): string[];
+    uploadFile(this: V12, type: 'url' | 'path' | 'data', name: string, url?: string, path?: string, data?: string, sha256?: string, headers?: Record<string, any>): string;
+    uploadFileFragmented(this: V12, stage: 'prepare' | 'transfer' | 'finish', name?: string, total_size?: number, file_id?: string, offset?: number, data?: string, sha256?: string): string | true;
+    getFile(this: V12, file_id: string): V12.FileInfo;
 }

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

@@ -5,6 +5,8 @@ const icqq_1 = require("icqq");
 const utils_1 = require("../../../utils");
 const onebot_1 = require("../../../onebot");
 const utils_2 = require("../../../utils");
+const crypto_1 = require("crypto");
+const sha = (data) => (0, crypto_1.createHash)("sha1").update(data).digest();
 class CommonAction {
     sendMessage() { }
     /**
@@ -119,5 +121,53 @@ class CommonAction {
             return key !== 'constructor';
         }).map(utils_2.toLine);
     }
+    uploadFile(type, name, url, path, data, sha256, headers) {
+        const fileInfo = {
+            name,
+            url,
+            type,
+            path,
+            data,
+            sha256,
+            headers
+        };
+        return this.saveFile(fileInfo);
+    }
+    uploadFileFragmented(stage, name, total_size, file_id, offset, data, sha256) {
+        switch (stage) {
+            case "prepare": {
+                if (!name || !total_size)
+                    throw new Error('请输入name和total_size');
+                return this.saveFile({
+                    name,
+                    type: 'data',
+                    total_size,
+                    data: Buffer.alloc(0).toString('base64')
+                });
+            }
+            case "transfer": {
+                if (!file_id || !offset || !data)
+                    throw new Error('请输入file_id、offset和data');
+                const fileInfo = this.getFile(file_id);
+                fileInfo.data = Buffer.concat([
+                    Buffer.from(fileInfo.data),
+                    Buffer.from(data)
+                ]).toString('base64');
+                return true;
+            }
+            case "finish": {
+                if (!file_id || sha256)
+                    throw new Error('请输入file_id和sha256');
+                const fileInfo = this.getFile(file_id);
+                if (sha(Buffer.from(fileInfo.data)).toString('hex') === sha256)
+                    return file_id;
+                this.delFile(file_id);
+                throw new Error('文件已被篡改');
+            }
+        }
+    }
+    getFile(file_id) {
+        return this.getFile(file_id);
+    }
 }
 exports.CommonAction = CommonAction;

package/lib/service/V12/action/friend.js

@@ -16,7 +16,7 @@ class FriendAction {
      * @param source {import('onebots/lib/service/v12').SegmentElem<'reply'>} 引用内容
      */
     async sendPrivateMsg(user_id, message, source) {
-        let { element, quote, music, share } = await utils_1.processMessage.apply(this.client, [message, source]);
+        let { element, quote, music, share } = await utils_1.processMessage.apply(this, [message, source]);
         if (music)
             await this.client.pickFriend(user_id).shareMusic(music.data.platform, music.data.id);
         if (share)

package/lib/service/V12/action/group.js

@@ -10,7 +10,7 @@ class GroupAction {
      * @param source {import('onebots/lib/service/v12').SegmentElem<'reply'>} 引用内容
      */
     async sendGroupMsg(group_id, message, source) {
-        let { element, quote, music, share } = await utils_1.processMessage.apply(this.client, [message, source]);
+        let { element, quote, music, share } = await utils_1.processMessage.apply(this, [message, source]);
         if (music)
             await this.client.pickGroup(group_id).shareMusic(music.data.platform, music.data.id);
         if (share)

package/lib/service/V12/action/guild.js

@@ -19,7 +19,7 @@ class GuildAction {
      * @param message {import('icqq/lib/service').Sendable} 消息
      */
     async sendGuildMsg(guild_id, channel_id, message) {
-        const { element } = await utils_1.processMessage.apply(this.client, [message]);
+        const { element } = await utils_1.processMessage.apply(this, [message]);
         if (!element.length)
             return;
         return await this.client.sendGuildMsg(guild_id, channel_id, element);

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

@@ -22,7 +22,13 @@ export declare class V12 extends EventEmitter implements OneBot.Base {
     private db;
     constructor(oneBot: OneBot<'V12'>, client: Client, config: V12.Config);
     get history(): V12.Payload<keyof Action>[];
-    set history(value: V12.Payload<keyof Action>[]);
+    getFile(file_id: string): V12.FileInfo;
+    delFile(file_id: string): boolean;
+    saveFile(fileInfo: V12.FileInfo): string;
+    get files(): ({
+        file_id: string;
+    } & V12.FileInfo)[];
+    set history(value: any[]);
     start(path?: string): void;
     private startHttp;
     private startWebhook;
@@ -220,4 +226,14 @@ export declare namespace V12 {
         params: Record<string, any>;
         echo?: number;
     };
+    type FileInfo = {
+        type: 'url' | 'path' | 'data';
+        name: string;
+        url?: string;
+        headers?: Record<string, any>;
+        path?: string;
+        data?: string;
+        sha256?: string;
+        total_size?: number;
+    };
 }

package/lib/service/V12/index.js

@@ -28,15 +28,35 @@ class V12 extends events_1.EventEmitter {
         this.version = 'V12';
         this.timestamp = Date.now();
         this.wsr = new Set();
-        this.db = new db_1.Db((0, path_1.join)(app_1.App.configDir, 'data', this.oneBot.uin + '.json'));
-        if (!this.history)
-            this.history = [];
+        this.db = new db_1.Database((0, path_1.join)(app_1.App.configDir, 'data', this.oneBot.uin + '.json'));
+        this.db.sync({ eventBuffer: [], files: {} });
         this.action = new action_1.Action();
         this.logger = this.oneBot.app.getLogger(this.oneBot.uin, this.version);
     }
     get history() {
         return this.db.get('eventBuffer');
     }
+    getFile(file_id) {
+        return this.db.get(`files.${file_id}`);
+    }
+    delFile(file_id) {
+        const files = this.db.get(`files`);
+        return delete files[file_id];
+    }
+    saveFile(fileInfo) {
+        const file_id = (0, utils_2.uuid)();
+        this.db.set(`files.${file_id}`, fileInfo);
+        return file_id;
+    }
+    get files() {
+        const files = this.db.get('files');
+        return Object.keys(files).map((file_id) => {
+            return {
+                file_id,
+                ...files[file_id]
+            };
+        });
+    }
     set history(value) {
         this.db.set('eventBuffer', value);
     }

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

@@ -1,6 +1,6 @@
-import { Client, MessageElem } from "icqq";
+import { MessageElem } from "icqq";
 import { V12 } from "../../service/V12";
-export declare function processMessage(this: Client, message: V12.Sendable, source?: V12.SegmentElem<'reply'>): Promise<{
+export declare function processMessage(this: V12, message: V12.Sendable, source?: V12.SegmentElem<'reply'>): Promise<{
     element: MessageElem[];
     music?: V12.SegmentElem<'music'>;
     share?: V12.SegmentElem<'share'>;

package/lib/service/V12/utils.js

@@ -25,6 +25,14 @@ async function processMessage(message, source) {
         'forward', 'node',
         'music', 'share', 'xml', 'json', 'location', // 分享类
     ].includes(n.type));
+    segments.forEach(seg => {
+        if (['image', 'video', 'audio'].includes(seg.type)) {
+            const { file_id } = seg.data;
+            const fileInfo = this.getFile(file_id);
+            if (fileInfo)
+                seg.data['file_id'] = fileInfo.url || fileInfo.path || `base64://${fileInfo.data}`;
+        }
+    });
     const element = V12_1.V12.fromSegment(segments);
     return { element, quote: quote || source, share, music };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onebots",
-  "version": "0.2.6",
+  "version": "0.4.0",
   "description": "基于icqq的多例oneBot实现",
   "engines": {
     "node": ">=16"
@@ -11,7 +11,7 @@
   },
   "scripts": {
     "start": "node .",
-    "build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json",
+    "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",
     "docs:dev": "vitepress dev docs --port 8989",
@@ -54,6 +54,7 @@
   ],
   "dependencies": {
     "@koa/router": "^10.1.1",
+    "@zhinjs/shared": "^0.0.9",
     "icqq": "^0.3.6",
     "icqq-cq-enable": "^1.0.0",
     "js-yaml": "^4.1.0",