# all files / red/runtime/ settings.js

90% Statements 72/80
78.57% Branches 33/42
94.12% Functions 16/17
89.74% Lines 70/78
1 branch Ignored

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155

    1×
    1×
    1×
    1×
    1×

    1×
    1×
    1×
    1×
    1×

    1×

    12×
    12×

    34×

    30×
    30×
    39×
    30×

    12×
    12×
    12×

    6×
    6×
    6×

    9×
    4×

    5×
    2×

    3×

    6×
    2×

    4×
    1×

    3×
    3×
    3×
    3×
    1×

    2×

    4×

    8×

    12×
    12×

    8×
    8×
    8×

    17×
    17×
    20×
    20×
    4×

    13×

    6×
    19×
    16×
    16×
    19×
    19×
    19×
    17×

    17×
    1×
    16×
    15×

    6×

    1×
    1×

    1×
    2×

    1×
     /**
     * Copyright JS Foundation and other contributors, http://js.foundation
     *
     * 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.
     **/

    var when = require("when");
    var clone = require("clone");
    var assert = require("assert");
    var log = require("./log");
    var util = require("./util");

    var userSettings = null;
    var globalSettings = null;
    var nodeSettings = null;
    var disableNodeSettings = null;
    var storage = null;

    var persistentSettings = {
        init: function(settings) {
            userSettings = settings;
            for (var i in settings) {
                /* istanbul ignore else */
                if (settings.hasOwnProperty(i) && i !== 'load' && i !== 'get' && i !== 'set' && i !== 'available' && i !== 'reset') {
                    // Don't allow any of the core functions get replaced via settings
                    (function() {
                        var j = i;
                        persistentSettings.__defineGetter__(j,function() { return userSettings[j]; });
                        persistentSettings.__defineSetter__(j,function() { throw new Error("Property '"+j+"' is read-only"); });
                    })();
                }
            }
            globalSettings = null;
            nodeSettings = {};
            disableNodeSettings = {};
        },
        load: function(_storage) {
            storage = _storage;
            return storage.getSettings().then(function(_settings) {
                globalSettings = _settings;
            });
        },
        get: function(prop) {
            if (userSettings.hasOwnProperty(prop)) {
                return clone(userSettings[prop]);
            }
            if (globalSettings === null) {
                throw new Error(log._("settings.not-available"));
            }
            return clone(globalSettings[prop]);
        },

        set: function(prop,value) {
            if (userSettings.hasOwnProperty(prop)) {
                throw new Error(log._("settings.property-read-only", {prop:prop}));
            }
            if (globalSettings === null) {
                throw new Error(log._("settings.not-available"));
            }
            var current = globalSettings[prop];
            globalSettings[prop] = value;
            try {
                assert.deepEqual(current,value);
                return when.resolve();
            } catch(err) {
                return storage.saveSettings(globalSettings);
            }
        },
        delete: function(prop) {
            if (userSettings.hasOwnProperty(prop)) {
                throw new Error(log._("settings.property-read-only", {prop:prop}));
            }
            if (globalSettings === null) {
                throw new Error(log._("settings.not-available"));
            }
            if (globalSettings.hasOwnProperty(prop)) {
                delete globalSettings[prop];
                return storage.saveSettings(globalSettings);
            }
            return when.resolve();
        },

        available: function() {
            return (globalSettings !== null);
        },

        reset: function() {
            for (var i in userSettings) {
                /* istanbul ignore else */
                Eif (userSettings.hasOwnProperty(i)) {
                    delete persistentSettings[i];
                }
            }
            userSettings = null;
            globalSettings = null;
            storage = null;
        },
        registerNodeSettings: function(type, opts) {
            var normalisedType = util.normaliseNodeTypeName(type);
            for (var property in opts) {
                Eif (opts.hasOwnProperty(property)) {
                    if (!property.startsWith(normalisedType)) {
                        throw new Error("Registered invalid property name '"+property+"'. Properties for this node must start with '"+normalisedType+"'");
                    }
                }
            }
            nodeSettings[type] = opts;
        },
        exportNodeSettings: function(safeSettings) {
            for (var type in nodeSettings) {
                if (nodeSettings.hasOwnProperty(type) && !disableNodeSettings[type]) {
                    var nodeTypeSettings = nodeSettings[type];
                    for (var property in nodeTypeSettings) {
                        Eif (nodeTypeSettings.hasOwnProperty(property)) {
                            var setting = nodeTypeSettings[property];
                            if (setting.exportable) {
                                Iif (safeSettings.hasOwnProperty(property)) {
                                    // Cannot overwrite existing setting
                                } else if (userSettings.hasOwnProperty(property)) {
                                    safeSettings[property] = userSettings[property];
                                } else if (setting.hasOwnProperty('value')) {
                                    safeSettings[property] = setting.value;
                                }
                            }
                        }
                    }
                }
            }

            return safeSettings;
        },
        enableNodeSettings: function(types) {
            types.forEach(function(type) {
                disableNodeSettings[type] = false;
            });
        },
        disableNodeSettings: function(types) {
            types.forEach(function(type) {
                disableNodeSettings[type] = true;
            });
        }
    }

    module.exports = persistentSettings;