global.LocalStorageNode.js Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of libjoynr-js Show documentation
JOYnr JavaScript libjoynr-js
There is a newer version: 1.4.0
/*eslint global-require: "off"*/
/*
 * #%L
 * %%
 * Copyright (C) 2011 - 2017 BMW Car IT GmbH
 * %%
 * 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.
 * #L%
 */
/**
 * @returns constructor for a localStorage object
 */

const path = require("path");
const fs = require("fs");

if (global.window !== undefined) {
    module.exports = require("./LocalStorage");
} else {
    const Typing = require("../joynr/util/Typing");
    const storage = require("node-persist");
    /**
     * LocalStorage constructor (node wrapper for LocalStorage)
     * @constructor LocalStorageWrapper
     * @classdesc node wrapper for LocalStorage
     *
     * @param {Object}
     *            settings the settings object
     * @param {Boolean}
     *            settings.clearPersistency localStorage is cleared if set to true
     * @param {String}
     *            settings.location optional, passed on to node-persist LocalStorage constructor
     */
    const LocalStorageWrapper = function(settings) {
        settings = settings || {};
        //the local storage wrapper uses the optionally given location
        const location = settings.location || "./localStorageStorage";

        try {
            this._myStorage = storage.create({
                dir: location,
                ttl: false,
                forgiveParseErrors: true
            });

            this._myStorage.initSync();

            Typing.checkPropertyIfDefined(settings.clearPersistency, "Boolean", "settings.clearPersistency");
            if (settings.clearPersistency) {
                this._myStorage.clearSync();
            }
        } catch (error) {
            if (error.message.includes("EISDIR: illegal operation on a directory, read")) {
                const locationPath = path.isAbsolute(location) ? location : path.join(process.cwd(), location);
                const files = fs.readdirSync(locationPath);
                const subDirectories = files.filter(file => {
                    const filePath = path.join(locationPath, file);
                    return fs.lstatSync(filePath).isDirectory();
                });
                throw new Error(
                    "joynr configuration error: Persistency subdirectory must not include other subdirectories. Directories found: " +
                        JSON.stringify(subDirectories)
                );
            }
            throw error;
        }
    };
    LocalStorageWrapper.prototype.setItem = function(key, value) {
        return this._myStorage.setItemSync(key, value);
    };
    LocalStorageWrapper.prototype.getItem = function(key) {
        const item = this._myStorage.getItemSync(key);
        if (item === undefined) {
            return null;
        }
        return item;
    };
    LocalStorageWrapper.prototype.removeItem = function(key) {
        return this._myStorage.removeItemSync(key);
    };
    LocalStorageWrapper.prototype.clear = function() {
        return this._myStorage.clearSync();
    };

    module.exports = LocalStorageWrapper;
}