@maiyunnet/kebab 2.0.0

package/lib/scan.ts

@@ -0,0 +1,364 @@
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2022-09-24 15:23:25
+ * Last: 2022-09-24 15:23:25, 2022-9-26 12:37:01, 2022-12-29 00:11:16
+ */
+
+/*
+CREATE TABLE IF NOT EXISTS `scan` (
+    `id` bigint NOT NULL AUTO_INCREMENT,
+    `token` char (32) CHARACTER SET ascii COLLATE ascii_bin NOT NULL,
+    `data` text NOT NULL,
+    `time_update` bigint NOT NULL,
+    `time_add` bigint NOT NULL,
+    `time_exp` bigint NOT NULL,
+    PRIMARY KEY (`id`),
+    UNIQUE KEY `token` (`token`) USING btree
+    KEY `time_update` (`time_update`),
+    KEY `time_exp` (`time_exp`)
+) ENGINE = InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci
+*/
+import * as lCore from '~/lib/core';
+import * as lDb from '~/lib/db';
+import * as lKv from '~/lib/kv';
+import * as lSql from '~/lib/sql';
+import * as lTime from '~/lib/time';
+import * as lText from '~/lib/text';
+import * as sCtr from '~/sys/ctr';
+
+/** --- Scan 设置的选项 --- */
+export interface IOptions {
+    'ttl'?: number;
+    'sqlPre'?: sCtr.Ctr | string;
+    'name'?: string;
+}
+
+/** --- scanned 函数的选项 --- */
+export interface IStaticOptions {
+    'sqlPre'?: sCtr.Ctr | string;
+    'name'?: string;
+}
+
+export class Scan {
+
+    private readonly _link: lDb.Pool | lKv.Pool;
+
+    private readonly _sql: lSql.Sql | null = null;
+
+    /** --- 表名或者 kv 里 key 的前缀 --- */
+    private readonly _name: string = 'scan';
+
+    private _token: string | null = null;
+
+    /** --- 有效期，默认 5 分钟 --- */
+    private _ttl = 60 * 5;
+
+    public constructor(link: lDb.Pool | lKv.Pool, token?: string, opt: IOptions = {}) {
+        if (opt.ttl !== undefined) {
+            this._ttl = opt.ttl;
+        }
+        if (opt.name) {
+            this._name = opt.name;
+        }
+        this._link = link;
+        if (link instanceof lDb.Pool) {
+            this._sql = lSql.get(opt.sqlPre);
+        }
+        if (token) {
+            this._token = token;
+        }
+    }
+
+    /** --- 二维码剩余有效时间 --- */
+    private _timeLeft: number | null = null;
+
+    /**
+     * --- 生成二维码处的轮询，检查是否被扫码、被录入数据 ---
+     * @returns -3 系统错误 -2 token 不存在或已过期 -1 无操作, 0 已扫码, 其他返回为存的数据并结束轮询
+     */
+    public async poll(): Promise<any> {
+        if (!this._token) {
+            return -3;
+        }
+        const time = lTime.stamp();
+        if (this._link instanceof lDb.Pool) {
+            // --- Db ---
+            this._sql!.select('*', this._name).where([
+                { 'token': this._token },
+                ['time_exp', '>', time]
+            ]);
+            const r = await this._link.query(this._sql!.getSql(), this._sql!.getData());
+            if (r.error) {
+                // --- 出错 ---
+                return -3;
+            }
+            const data = r.rows?.[0];
+            if (!data) {
+                // --- 不存在或过期 ---
+                return -2;
+            }
+            // --- 存在，判断是否被扫码，以及是否被写入数据 ---
+            this._timeLeft = data['time_exp'] - time;
+            if (data['data'] !== '') {
+                // --- 已经写入数据了，删除数据库条目并返回写入的数据内容 ---
+                this._sql!.delete(this._name).where({
+                    'id': data['id']
+                });
+                const r = lText.parseJson(data['data']);
+                return r === false ? -3 : r;
+            }
+            else if (data['time_update'] > 0) {
+                // --- 已被扫描 ---
+                return 0;
+            }
+            else {
+                // --- 未扫描 ---
+                return -1;
+            }
+        }
+        else {
+            // --- Kv ---
+            const data = await this._link.getJson('scan-' + this._name + '_' + this._token);
+            if (data === null) {
+                // --- 不存在或过期 ---
+                return -2;
+            }
+            const ttl = await this._link.ttl('scan-' + this._name + '_' + this._token);
+            if (ttl === null) {
+                return -3;
+            }
+            this._timeLeft = ttl;
+            if (data['data'] !== null) {
+                // --- 已经写入数据了，删除数据库条目并返回写入的数据内容 ---
+                await this._link.del('scan-' + this._name + '_' + this._token);
+                return data;
+            }
+            else if (data['time_update'] > 0) {
+                // --- 已被扫描 ---
+                return 0;
+            }
+            else {
+                // --- 未扫描 ---
+                return -1;
+            }
+        }
+    }
+
+    /**
+     * --- 创建 token，直接应用到本类 ---
+     */
+    public async createToken(): Promise<boolean> {
+        await this._gc();
+        const time = lTime.stamp();
+        let count = 0;
+        while (true) {
+            if (count === 5) {
+                return false;
+            }
+            this._token = lCore.random(32, lCore.RANDOM_LUN);
+            if (this._link instanceof lDb.Pool) {
+                // --- Db ---
+                this._sql!.insert(this._name).values({
+                    'token': this._token,
+                    'data': '',
+                    'time_update': '0',
+                    'time_add': time,
+                    'time_exp': time + this._ttl
+                });
+                const r = await this._link.execute(this._sql!.getSql(), this._sql!.getData());
+                if (r.error) {
+                    if (r.error.errno !== 1062) {
+                        return false;
+                    }
+                }
+                else {
+                    break;
+                }
+            }
+            else {
+                // --- Kv ---
+                if (await this._link.set('scan-' + this._name + '_' + this._token, {
+                    'time_update': 0,
+                    'data': null
+                }, this._ttl, 'nx')) {
+                    break;
+                }
+            }
+            ++count;
+        }
+        return true;
+    }
+
+    /**
+     * --- 获取当前 token ---
+     */
+    public getToken(): string | null {
+        return this._token;
+    }
+
+    /**
+     * --- 设置有效期，设置后的新 token 被创建有效 ---
+     * @param ttl
+     */
+    public setTTL(ttl: number): void {
+        this._ttl = ttl;
+    }
+
+    /**
+     * --- 获取设置的有效期 ---
+     */
+    public getTTL(): number {
+        return this._ttl;
+    }
+
+    /**
+     * --- 获取当前 token 可扫剩余有效期 ---
+     */
+    public getTimeLeft(): number | null {
+        return this._timeLeft;
+    }
+
+    /**
+     * --- 根据情况清空 Db 状态下的 scan 表垃圾数据 ---
+     */
+    private async _gc(): Promise<void> {
+        if (this._link instanceof lKv.Pool) {
+            return;
+        }
+        if (lCore.rand(0, 10) !== 5) {
+            return;
+        }
+        this._sql!.delete(this._name).where([
+            ['time_exp', '<', lTime.stamp()]
+        ]);
+        await this._link.execute(this._sql!.getSql(), this._sql!.getData());
+    }
+
+}
+
+/**
+ * -- 创建 Scan 对象 ---
+ * @param link
+ * @param token Token
+ * @param opt
+ */
+export async function get(link: lDb.Pool | lKv.Pool, token?: string, opt: IOptions = {}): Promise<Scan> {
+    const scan = new Scan(link, token, opt);
+    if (!token) {
+        await scan.createToken();
+    }
+    return scan;
+}
+
+/**
+ * --- 对 token 执行访问操作，通常用户扫码后展示的网页所调用，代表已扫码 ---
+ * @param link
+ * @patam token 必填
+ * @param opt
+ */
+export async function scanned(
+    link: lDb.Pool | lKv.Pool,
+    token: string,
+    opt: IStaticOptions = {}
+): Promise<boolean> {
+    const time = lTime.stamp();
+    const name = opt.name ?? 'scan';
+    if (link instanceof lDb.Pool) {
+        // --- Db ---
+        const sql = lSql.get(opt.sqlPre);
+        sql.update(name, {
+            'time_update': time
+        }).where([
+            {
+                'token': token,
+                'time_update': '0'
+            },
+            ['time_exp', '>', time]
+        ]);
+        const r = await link.execute(sql.getSql(), sql.getData());
+        if (r.error) {
+            return false;
+        }
+        if (r.packet?.affectedRows && r.packet.affectedRows > 0) {
+            return true;
+        }
+    }
+    else {
+        // --- Kv ---
+        const ldata = await link.getJson('scan-' + name + '_' + token);
+        if (ldata === null) {
+            return false;
+        }
+        if (ldata['time_update'] > 0) {
+            // --- 已经被扫码过了 ---
+            return false;
+        }
+        ldata['time_update'] = time;
+        const ttl = await link.ttl('scan-' + name + '_' + token);
+        if (ttl === null) {
+            return false;
+        }
+        return link.set('scan-' + name + '_' + token, ldata, ttl + 1, 'xx');
+    }
+    return false;
+}
+
+/**
+ * --- 将数据写入 token，通常在客户的逻辑下去写，服务器会 poll 到 ---
+ * @param link
+ * @param token
+ * @param data
+ * @param opt
+ */
+export async function setData(
+    link: lDb.Pool | lKv.Pool,
+    token: string,
+    data: Record<string, any> | string | number,
+    opt: IStaticOptions = {}
+): Promise<boolean> {
+    if (typeof data === 'number' && Number.isInteger(data)) {
+        if (data >= -3 && data <= 1) {
+            return false;
+        }
+    }
+    const time = lTime.stamp();
+    const name = opt.name ?? 'scan';
+    if (link instanceof lDb.Pool) {
+        // --- Db ---
+        const sql = lSql.get(opt.sqlPre);
+        sql.update(name, {
+            'data': lText.stringifyJson(data)
+        }).where([
+            {
+                'token': token,
+            },
+            ['time_update', '>', '0'],
+            ['time_exp', '>', time]
+        ]);
+        const r = await link.execute(sql.getSql(), sql.getData());
+        if (r.error) {
+            return false;
+        }
+        if (r.packet?.affectedRows && r.packet?.affectedRows > 0) {
+            return true;
+        }
+    }
+    else {
+        // --- Kv ---
+        const ldata = await link.getJson('scan-' + name + '_' + token);
+        if (ldata === null) {
+            return false;
+        }
+        if (ldata['time_update'] === 0) {
+            // --- 还未被扫码，无法操作 ---
+            return false;
+        }
+        const ttl = await link.ttl('scan-' + name + '_' + token);
+        if (ttl === null) {
+            return false;
+        }
+        ldata['data'] = data;
+        return link.set('scan-' + name + '_' + token, ldata, ttl + 1, 'xx');
+    }
+    return false;
+}

package/lib/session.js

@@ -0,0 +1,177 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Session = void 0;
+const core = __importStar(require("~/lib/core"));
+const time = __importStar(require("~/lib/time"));
+const db = __importStar(require("~/lib/db"));
+const kv = __importStar(require("~/lib/kv"));
+const sql = __importStar(require("~/lib/sql"));
+const text = __importStar(require("~/lib/text"));
+class Session {
+    constructor() {
+        this._token = '';
+        this._ttl = 0;
+    }
+    async init(ctr, link, auth = false, opt = {}) {
+        const config = ctr.getPrototype('_config');
+        const ssl = opt.ssl ?? config.session.ssl;
+        const pre = opt.sqlPre ?? null;
+        this._name = opt.name ?? config.session.name;
+        this._ttl = opt.ttl ?? config.session.ttl;
+        const tim = time.stamp();
+        this._ctr = ctr;
+        if (auth) {
+            const a = ctr.getAuthorization();
+            if (a && typeof a !== 'string' && (a.user === 'token')) {
+                this._token = a.pwd;
+            }
+        }
+        const cookie = ctr.getPrototype('_cookie');
+        if ((this._token === '') && cookie[this._name]) {
+            this._token = cookie[this._name];
+        }
+        this._link = link;
+        if (link instanceof db.Pool) {
+            this._sql = sql.get(pre ? pre : ctr);
+            await this._gc();
+        }
+        let session = {};
+        let needInsert = false;
+        if (this._token !== '') {
+            if (this._link instanceof kv.Pool) {
+                let data;
+                if ((data = await this._link.getJson(this._name + '_' + this._token)) === null) {
+                    needInsert = true;
+                }
+                else {
+                    session = data;
+                }
+            }
+            else {
+                this._sql.select('*', 'session').where([
+                    ['time_update', '>=', tim - this._ttl],
+                    { 'token': this._token }
+                ]);
+                const data = await this._link.query(this._sql.getSql(), this._sql.getData());
+                if (data.rows?.[0]) {
+                    session = text.parseJson(data.rows[0].data);
+                }
+                else {
+                    needInsert = true;
+                }
+            }
+            ctr.setPrototype('_session', session);
+        }
+        else {
+            needInsert = true;
+        }
+        if (needInsert) {
+            if (this._link instanceof kv.Pool) {
+                let count = 0;
+                do {
+                    if (count === 5) {
+                        return false;
+                    }
+                    this._token = core.random(16, core.RANDOM_LUN);
+                    ++count;
+                } while (!await this._link.set(this._name + '_' + this._token, [], this._ttl, 'nx'));
+            }
+            else {
+                let count = 0;
+                while (true) {
+                    if (count === 5) {
+                        return false;
+                    }
+                    this._token = core.random(16, core.RANDOM_LUN);
+                    this._sql.insert('session').values({
+                        'token': this._token,
+                        'data': '{}',
+                        'time_update': tim,
+                        'time_add': tim
+                    });
+                    ++count;
+                    const r = await this._link.execute(this._sql.getSql(), this._sql.getData());
+                    if (r.error) {
+                        if (r.error.errno !== 1062) {
+                            return false;
+                        }
+                    }
+                    else {
+                        break;
+                    }
+                }
+            }
+        }
+        core.setCookie(ctr, this._name, this._token, {
+            'ttl': this._ttl,
+            'ssl': ssl
+        });
+        return true;
+    }
+    getToken() {
+        return this._token;
+    }
+    getName() {
+        return this._name;
+    }
+    async update() {
+        if (this._link instanceof kv.Pool) {
+            await this._link.set(this._name + '_' + this._token, this._ctr.getPrototype('_session'), this._ttl);
+        }
+        else {
+            this._sql.update('session', [{
+                    'data': text.stringifyJson(this._ctr.getPrototype('_session')),
+                    'time_update': time.stamp()
+                }]).where([{
+                    'token': this._token
+                }]);
+            await this._link.execute(this._sql.getSql(), this._sql.getData());
+        }
+    }
+    async _gc() {
+        if (!(this._link instanceof db.Pool)) {
+            return;
+        }
+        if (core.rand(0, 20) !== 10) {
+            return;
+        }
+        this._sql.delete('session').where([
+            ['time_update', '<', time.stamp() - this._ttl]
+        ]);
+        await this._link.execute(this._sql.getSql(), this._sql.getData());
+    }
+}
+exports.Session = Session;