node-red/red/api/editor/settings.js

/**
 * 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 theme = require("../editor/theme");
var util = require('util');
var runtime;
var settings;
var log;

module.exports = {
    init: function(_runtime) {
        runtime = _runtime;
        settings = runtime.settings;
        log = runtime.log;
    },
    runtimeSettings: function(req,res) {
        var safeSettings = {
            httpNodeRoot: settings.httpNodeRoot||"/",
            version: settings.version
        }
        if (req.user) {
            safeSettings.user = {}
            var props = ["anonymous","username","image","permissions"];
            props.forEach(prop => {
                if (req.user.hasOwnProperty(prop)) {
                    safeSettings.user[prop] = req.user[prop];
                }
            })
        }

        var themeSettings = theme.settings();
        if (themeSettings) {
            safeSettings.editorTheme = themeSettings;
        }

        if (util.isArray(settings.paletteCategories)) {
            safeSettings.paletteCategories = settings.paletteCategories;
        }

        if (settings.flowFilePretty) {
            safeSettings.flowFilePretty = settings.flowFilePretty;
        }

        if (!runtime.nodes.paletteEditorEnabled()) {
            safeSettings.editorTheme = safeSettings.editorTheme || {};
            safeSettings.editorTheme.palette = safeSettings.editorTheme.palette || {};
            safeSettings.editorTheme.palette.editable = false;
        }
        if (runtime.storage.projects) {
            var activeProject = runtime.storage.projects.getActiveProject();
            if (activeProject) {
                safeSettings.project = activeProject;
            } else if (runtime.storage.projects.flowFileExists()) {
                safeSettings.files = {
                    flow: runtime.storage.projects.getFlowFilename(),
                    credentials: runtime.storage.projects.getCredentialsFilename()
                }
            }
            safeSettings.git = {
                globalUser: runtime.storage.projects.getGlobalGitUser()
            }
        }

        safeSettings.flowEncryptionType = runtime.nodes.getCredentialKeyType();

        settings.exportNodeSettings(safeSettings);
        res.json(safeSettings);
    },
    userSettings: function(req, res) {
        var username;
        if (!req.user || req.user.anonymous) {
            username = '_';
        } else {
            username = req.user.username;
        }
        res.json(settings.getUserSettings(username)||{});
    },
    updateUserSettings: function(req,res) {
        var username;
        if (!req.user || req.user.anonymous) {
            username = '_';
        } else {
            username = req.user.username;
        }
        var currentSettings = settings.getUserSettings(username)||{};
        currentSettings = extend(currentSettings, req.body);
        try {
            settings.setUserSettings(username, currentSettings).then(function() {
                log.audit({event: "settings.update",username:username},req);
                res.status(204).end();
            }).catch(function(err) {
                log.audit({event: "settings.update",username:username,error:err.code||"unexpected_error",message:err.toString()},req);
                res.status(400).json({error:err.code||"unexpected_error", message:err.toString()});
            });
        } catch(err) {
            log.warn(log._("settings.user-not-available",{message:log._("settings.not-available")}));
            log.audit({event: "settings.update",username:username,error:err.code||"unexpected_error",message:err.toString()},req);
            res.status(400).json({error:err.code||"unexpected_error", message:err.toString()});
        }
    }
}

function extend(target, source) {
    var keys = Object.keys(source);
    var i = keys.length;
    while(i--) {
        var value = source[keys[i]]
        var type = typeof value;
        if (type === 'string' || type === 'number' || type === 'boolean' || Array.isArray(value)) {
            target[keys[i]] = value;
        } else if (value === null) {
            if (target.hasOwnProperty(keys[i])) {
                delete target[keys[i]];
            }
        } else {
            // Object
            if (target.hasOwnProperty(keys[i])) {
                target[keys[i]] = extend(target[keys[i]],value);
            } else {
                target[keys[i]] = value;
            }
        }
    }
    return target;
}