ueberdb2 4.1.23 → 4.1.26

package/dist/databases/redis_db.js

@@ -1,120 +0,0 @@
-'use strict';
-
-var AbstractDatabase = require('../lib/AbstractDatabase.js');
-var redis = require('redis');
-
-/**
- * 2011 Peter 'Pita' Martischka
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS-IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-const Database = class RedisDB extends AbstractDatabase {
-    _client;
-    constructor(settings) {
-        super();
-        this._client = null;
-        this.settings = settings || {};
-    }
-    get isAsync() { return true; }
-    async init() {
-        if (this.settings.url) {
-            this._client = redis.createClient({ url: this.settings.url });
-        }
-        else if (this.settings.host) {
-            const options = {
-                socket: {
-                    host: this.settings.host,
-                    port: Number(this.settings.port),
-                }
-            };
-            if (this.settings.password) {
-                options.password = this.settings.password;
-            }
-            if (this.settings.user) {
-                options.username = this.settings.user;
-            }
-            this._client = redis.createClient(options);
-        }
-        if (this._client) {
-            await this._client.connect();
-            await this._client.ping();
-        }
-    }
-    async get(key) {
-        if (this._client == null)
-            return null;
-        return await this._client.get(key);
-    }
-    async findKeys(key, notKey) {
-        if (this._client == null)
-            return null;
-        const [type] = /^([^:*]+):\*$/.exec(key) || [];
-        if (type != null && ['*:*:*', `${key}:*`].includes(notKey)) {
-            // Performance optimization for a common Etherpad case.
-            return await this._client.sMembers(`ueberDB:keys:${type}`);
-        }
-        let keys = await this._client.keys(key.replace(/[?[\]\\]/g, '\\$&'));
-        if (notKey != null) {
-            const regex = this.createFindRegex(key, notKey);
-            keys = keys.filter((k) => regex.test(k));
-        }
-        return keys;
-    }
-    async set(key, value) {
-        if (this._client == null)
-            return null;
-        const matches = /^([^:]+):([^:]+)$/.exec(key);
-        await Promise.all([
-            matches && this._client.sAdd(`ueberDB:keys:${matches[1]}`, matches[0]),
-            this._client.set(key, value),
-        ]);
-    }
-    async remove(key) {
-        if (this._client == null)
-            return null;
-        const matches = /^([^:]+):([^:]+)$/.exec(key);
-        await Promise.all([
-            matches && this._client.sRem(`ueberDB:keys:${matches[1]}`, matches[0]),
-            this._client.del(key),
-        ]);
-    }
-    async doBulk(bulk) {
-        if (this._client == null)
-            return null;
-        const multi = this._client.multi();
-        for (const { key, type, value } of bulk) {
-            const matches = /^([^:]+):([^:]+)$/.exec(key);
-            if (type === 'set') {
-                if (matches) {
-                    multi.sAdd(`ueberDB:keys:${matches[1]}`, matches[0]);
-                }
-                multi.set(key, value);
-            }
-            else if (type === 'remove') {
-                if (matches) {
-                    multi.sRem(`ueberDB:keys:${matches[1]}`, matches[0]);
-                }
-                multi.del(key);
-            }
-        }
-        await multi.exec();
-    }
-    async close() {
-        if (this._client == null)
-            return null;
-        await this._client.quit();
-        this._client = null;
-    }
-};
-
-exports.Database = Database;

package/dist/databases/rethink_db.js

@@ -1,121 +0,0 @@
-'use strict';
-
-var AbstractDatabase = require('../lib/AbstractDatabase.js');
-var r = require('rethinkdb');
-var async = require('async');
-
-/**
- * 2016 Remi Arnaud
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS-IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-const Database = class extends AbstractDatabase {
-    host;
-    db;
-    port;
-    table;
-    connection;
-    constructor(settings) {
-        super();
-        if (!settings)
-            settings = {};
-        if (!settings.host) {
-            settings.host = 'localhost';
-        }
-        if (!settings.port) {
-            settings.port = 28015;
-        }
-        if (!settings.db) {
-            settings.db = 'test';
-        }
-        if (!settings.table) {
-            settings.table = 'test';
-        }
-        this.host = settings.host;
-        this.db = settings.db;
-        this.port = settings.port;
-        this.table = settings.table;
-        this.connection = null;
-    }
-    init(callback) {
-        // @ts-ignore
-        r.connect(this, (err, conn) => {
-            if (err)
-                throw err;
-            this.connection = conn;
-            r.table(this.table).run(this.connection, (err, cursor) => {
-                if (err) {
-                    // assuming table does not exists
-                    // @ts-ignore
-                    r.tableCreate(this.table).run(this.connection, callback);
-                }
-                else if (callback) {
-                    callback(null, cursor);
-                }
-            });
-        });
-    }
-    get(key, callback) {
-        // @ts-ignore
-        r.table(this.table).get(key).run(this.connection, (err, item) => {
-            // @ts-ignore
-            callback(err, (item ? item.content : item));
-        });
-    }
-    findKeys(key, notKey, callback) {
-        const keys = [];
-        const regex = this.createFindRegex(key, notKey);
-        // @ts-ignore
-        r.filter((item) => {
-            if (item.id.search(regex) !== -1) {
-                keys.push(item.id);
-            }
-        }).run(this.connection, callback);
-    }
-    set(key, value, callback) {
-        r.table(this.table)
-            .insert({ id: key, content: value }, { conflict: 'replace' })
-            .run(this.connection, callback);
-    }
-    doBulk(bulk, callback) {
-        const _in = [];
-        const _out = [];
-        for (const i in bulk) {
-            if (bulk[i].type === 'set') {
-                _in.push({ id: bulk[i].key, content: bulk[i].value });
-            }
-            else if (bulk[i].type === 'remove') {
-                _out.push(bulk[i].key);
-            }
-        }
-        async.parallel([
-            (cb) => {
-                r.table(this.table).insert(_in, { conflict: 'replace' }).run(this.connection, cb);
-            },
-            (cb) => {
-                r.table(this.table).getAll(_out).delete().run(this.connection, cb);
-            },
-        ], callback);
-    }
-    remove(key, callback) {
-        // @ts-ignore
-        r.table(this.table).get(key).delete().run(this.connection, callback);
-    }
-    close(callback) {
-        if (this.connection) {
-            this.connection.close(callback);
-        }
-    }
-};
-
-exports.Database = Database;

package/dist/databases/sqlite_db.js

@@ -1,138 +0,0 @@
-'use strict';
-
-var AbstractDatabase = require('../lib/AbstractDatabase.js');
-var util = require('util');
-
-/**
- * 2011 Peter 'Pita' Martischka
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS-IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-let SQDB;
-try {
-    SQDB = require('sqlite3').Database;
-}
-catch (err) {
-    throw new Error('sqlite3 not found. It was removed from ueberdb\'s dependencies because it requires ' +
-        'compilation which fails on several systems. If you still want to use sqlite, run ' +
-        '"npm install sqlite3" in your etherpad-lite ./src directory.');
-}
-const escape = (val) => `'${val.replace(/'/g, "''")}'`;
-const Database = class SQLiteDB extends AbstractDatabase {
-    db;
-    constructor(settings) {
-        super();
-        this.db = null;
-        if (!settings || !settings.filename) {
-            settings = { filename: ':memory:' };
-        }
-        this.settings = settings;
-        // set settings for the dbWrapper
-        if (settings.filename === ':memory:') {
-            this.settings.cache = 0;
-            this.settings.writeInterval = 0;
-            this.settings.json = true;
-        }
-        else {
-            this.settings.cache = 1000;
-            this.settings.writeInterval = 100;
-            this.settings.json = true;
-        }
-    }
-    init(callback) {
-        util.callbackify(async () => {
-            this.db = new SQDB(this.settings.filename);
-            await this._query('CREATE TABLE IF NOT EXISTS store (key TEXT PRIMARY KEY, value TEXT)');
-            // @ts-ignore
-        })(callback);
-    }
-    async _query(sql, params = []) {
-        // It is unclear how util.promisify() deals with variadic functions, so it is not used here.
-        return await new Promise((resolve, reject) => {
-            // According to sqlite3's documentation, .run() method (and maybe .all() and .get(); the
-            // documentation is unclear) might call the callback multiple times. That's OK -- ECMAScript
-            // guarantees that it is safe to call a Promise executor's resolve and reject functions
-            // multiple times. The subsequent calls are ignored, except Node.js's 'process' object emits a
-            // 'multipleResolves' event to aid in debugging.
-            this.db && this.db.all(sql, params, (err, rows) => {
-                if (err != null)
-                    return reject(err);
-                resolve(rows);
-            });
-        });
-    }
-    // Temporary callbackified version of _query. This will be removed once all database objects are
-    // asyncified.
-    _queryCb(sql, params, callback) {
-        // It is unclear how util.callbackify() handles optional parameters, so it is not used here.
-        const p = this._query(sql, params);
-        if (callback)
-            p.then((rows) => callback(null, rows), (err) => callback(err || new Error(err)));
-    }
-    get(key, callback) {
-        this._queryCb('SELECT value FROM store WHERE key = ?', [key], (err, rows) => callback(err, err == null && rows && rows.length ? rows[0].value : null));
-    }
-    findKeys(key, notKey, callback) {
-        let query = 'SELECT key FROM store WHERE key LIKE ?';
-        const params = [];
-        // desired keys are %key:%, e.g. pad:%
-        key = key.replace(/\*/g, '%');
-        params.push(key);
-        if (notKey != null) {
-            // not desired keys are notKey:%, e.g. %:%:%
-            notKey = notKey.replace(/\*/g, '%');
-            query += ' AND key NOT LIKE ?';
-            params.push(notKey);
-        }
-        this._queryCb(query, params, (err, results) => {
-            const value = [];
-            if (!err && Object.keys(results).length > 0) {
-                results.forEach((val) => {
-                    value.push(val.key);
-                });
-            }
-            callback(err, value);
-        });
-    }
-    set(key, value, callback) {
-        this._queryCb('REPLACE INTO store VALUES (?,?)', [key, value], callback);
-    }
-    remove(key, callback) {
-        this._queryCb('DELETE FROM store WHERE key = ?', [key], callback);
-    }
-    doBulk(bulk, callback) {
-        let sql = 'BEGIN TRANSACTION;\n';
-        for (const i in bulk) {
-            if (bulk[i].type === 'set') {
-                sql += `REPLACE INTO store VALUES (${escape(bulk[i].key)}, ${escape(bulk[i].value)});\n`;
-            }
-            else if (bulk[i].type === 'remove') {
-                sql += `DELETE FROM store WHERE key = ${escape(bulk[i].key)};\n`;
-            }
-        }
-        sql += 'END TRANSACTION;';
-        this.db && this.db.exec(sql, (err) => {
-            if (err) {
-                console.error('ERROR WITH SQL: ');
-                console.error(sql);
-            }
-            callback(err);
-        });
-    }
-    close(callback) {
-        callback();
-        this.db && this.db.close((err) => callback(err));
-    }
-};
-
-exports.Database = Database;

package/dist/index.js

@@ -1,193 +0,0 @@
-'use strict';
-
-var CacheAndBufferLayer = require('./lib/CacheAndBufferLayer.js');
-var logging = require('./lib/logging.js');
-var util = require('util');
-
-const cbDb = {
-    init: () => { },
-    flush: () => { },
-    get: () => { },
-    remove: () => { },
-    findKeys: () => { },
-    close: () => { },
-    getSub: () => { },
-    setSub: () => { },
-};
-const fns = ['close', 'findKeys', 'flush', 'get', 'getSub', 'init', 'remove', 'set', 'setSub'];
-for (const fn of fns) {
-    // @ts-ignore
-    cbDb[fn] = util.callbackify(CacheAndBufferLayer.Database.prototype[fn]);
-}
-const makeDoneCallback = (callback, deprecated) => (err) => {
-    if (callback)
-        callback(err);
-    if (deprecated)
-        deprecated(err);
-    if (err != null && callback == null && deprecated == null)
-        throw err;
-};
-const Database = class {
-    type;
-    dbModule;
-    dbSettings;
-    wrapperSettings;
-    logger;
-    db;
-    metrics;
-    /**
-     * @param type The type of the database
-     * @param dbSettings The settings for that specific database type
-     * @param wrapperSettings
-     * @param logger Optional logger object. If no logger object is provided no logging will occur.
-     *     The logger object is expected to be a log4js logger object or `console`. A logger object
-     *     from another logging library should also work, but performance may be reduced if the logger
-     *     object does not have is${Level}Enabled() methods (isDebugEnabled(), etc.).
-     */
-    constructor(type, dbSettings, wrapperSettings, logger = null) {
-        if (!type) {
-            type = 'sqlite';
-            dbSettings = null;
-            wrapperSettings = null;
-        }
-        // saves all settings and require the db module
-        this.type = type;
-        this.dbSettings = dbSettings;
-        this.wrapperSettings = wrapperSettings;
-        this.logger = logging.normalizeLogger(logger);
-    }
-    /**
-     * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-     */
-    async init(callback = null) {
-        this.dbModule = await import(`./databases/${this.type}_db`);
-        const db = new this.dbModule.Database(this.dbSettings);
-        db.logger = this.logger;
-        this.db = new CacheAndBufferLayer.Database(db, this.wrapperSettings, this.logger);
-        this.metrics = this.db.metrics;
-        if (callback != null) {
-            return cbDb.init.call(this.db);
-        }
-        return this.db.init();
-    }
-    /**
-     * Wrapper functions
-     */
-    /**
-     * Deprecated synonym of flush().
-     *
-     * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-     */
-    doShutdown(callback = null) {
-        return this.flush(callback);
-    }
-    /**
-     * Writes any unsaved changes to the underlying database.
-     *
-     * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-     */
-    flush(callback = null) {
-        if (!cbDb || !cbDb.flush === undefined)
-            return null;
-        if (callback != null) { // @ts-ignore
-            return cbDb.flush.call(this.db, callback);
-        }
-        return this.db.flush();
-    }
-    /**
-     * @param key
-     * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-     */
-    get(key, callback = null) {
-        if (callback != null) { // @ts-ignore
-            return cbDb.get.call(this.db, key, callback);
-        }
-        return this.db.get(key);
-    }
-    /**
-     * @param key
-     * @param notKey
-     * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-     */
-    findKeys(key, notKey, callback = null) {
-        if (callback != null) { // @ts-ignore
-            return cbDb.findKeys.call(this.db, key, notKey, callback);
-        }
-        return this.db.findKeys(key, notKey);
-    }
-    /**
-     * Removes an entry from the database if present.
-     *
-     * @param key
-     * @param cb Deprecated. Node-style callback. Called when the write has been committed to the
-     *     underlying database driver. If null, a Promise is returned.
-     * @param deprecated Deprecated callback that is called just after cb. Ignored if cb is null.
-     */
-    remove(key, cb = null, deprecated = null) {
-        if (cb != null) { // @ts-ignore
-            return cbDb.remove.call(this.db, key, makeDoneCallback(cb, deprecated));
-        }
-        return this.db.remove(key);
-    }
-    /**
-     * Adds or changes the value of an entry.
-     *
-     * @param key
-     * @param value
-     * @param cb Deprecated. Node-style callback. Called when the write has been committed to the
-     *     underlying database driver. If null, a Promise is returned.
-     * @param deprecated Deprecated callback that is called just after cb. Ignored if cb is null.
-     */
-    set(key, value, cb = null, deprecated = null) {
-        if (cb != null) { // @ts-ignore
-            return cbDb.get.call(this.db, key, value, makeDoneCallback(cb, deprecated));
-        }
-        return this.db.set(key, value);
-    }
-    /**
-     * @param key
-     * @param sub
-     * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-     */
-    getSub(key, sub, callback = null) {
-        if (callback != null) { // @ts-ignore
-            return cbDb.getSub.call(this.db, key, sub, callback);
-        }
-        return this.db.getSub(key, sub);
-    }
-    /**
-     * Adds or changes a subvalue of an entry.
-     *
-     * @param key
-     * @param sub
-     * @param value
-     * @param cb Deprecated. Node-style callback. Called when the write has been committed to the
-     *     underlying database driver. If null, a Promise is returned.
-     * @param deprecated Deprecated callback that is called just after cb. Ignored if cb is null.
-     */
-    setSub(key, sub, value, cb = null, deprecated = null) {
-        if (cb != null) {
-            // @ts-ignore
-            return cbDb.setSub.call(this.db, key, sub, value, makeDoneCallback(cb, deprecated));
-        }
-        return this.db.setSub(key, sub, value);
-    }
-    /**
-     * Flushes unwritten changes then closes the connection to the underlying database. After this
-     * returns, any future call to a method on this object may result in an error.
-     *
-     * @param callback - Deprecated. Node-style callback. If null, a Promise is returned.
-     */
-    close(callback = null) {
-        if (callback != null) { // @ts-ignore
-            return cbDb.close.call(this.db, callback);
-        }
-        return this.db.close();
-    }
-};
-/**
- * Deprecated synonym of Database.
- */
-exports.database = exports.Database;
-
-exports.Database = Database;

package/dist/lib/AbstractDatabase.js

@@ -1,40 +0,0 @@
-'use strict';
-
-var logging = require('./logging.js');
-
-const nullLogger = logging.normalizeLogger(null);
-// Format: All characters match themselves except * matches any zero or more characters. No
-// backslash escaping is supported, so it is impossible to create a pattern that matches only the
-// '*' character.
-const simpleGlobToRegExp = (s) => s.replace(/[.+?^${}()|[\]\\]/g, '\\$&').replace(/\*/g, '.*');
-class AbstractDatabase {
-    logger;
-    // @ts-ignore
-    settings;
-    constructor() {
-        if (new.target === module.exports) {
-            throw new TypeError('cannot instantiate Abstract Database directly');
-        }
-        for (const fn of ['init', 'close', 'get', 'findKeys', 'remove', 'set']) {
-            // @ts-ignore
-            if (typeof this[fn] !== 'function')
-                throw new TypeError(`method ${fn} not defined`);
-        }
-        this.logger = nullLogger;
-    }
-    /**
-     * For findKey regex. Used by document dbs like mongodb or dirty.
-     */
-    createFindRegex(key, notKey) {
-        let regex = `^(?=${simpleGlobToRegExp(key)}$)`;
-        if (notKey != null)
-            regex += `(?!${simpleGlobToRegExp(notKey)}$)`;
-        return new RegExp(regex);
-    }
-    doBulk(operations, cb) {
-        throw new Error('the doBulk method must be implemented if write caching is enabled');
-    }
-    get isAsync() { return false; }
-}
-
-module.exports = AbstractDatabase;