# all files / red/runtime/nodes/ index.js

90.32% Statements 56/62
77.78% Branches 14/18
80% Functions 4/5
90.32% Lines 56/62

    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
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180

    1×
    1×
    1×
    1×

    1×
    1×
    1×
    1×
    1×
    1×
    1×
    1×

    1×

    1×

    1×
    10×

    1×
    1×
    1×
    1×
    1×

    10×
    4×
    1×

    4×
    2×
    2×

    1×

    10×

    1×
    2×
    2×
    2×
    1×

    2×
    2×
    1×

    1×
    3×
    3×

    1×
    1×
    1×

    1×
    11×
    11×
    11×
    11×
    11×
    11×
    11×

    1×
    2×
    1×

    1×

    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 path = require("path");
    var fs = require("fs");
    var clone = require("clone");

    var registry = require("./registry");
    var credentials = require("./credentials");
    var flows = require("./flows");
    var flowUtil = require("./flows/util")
    var context = require("./context");
    var Node = require("./Node");
    var log = null;
    var library = require("./library");

    var events = require("../events");

    var settings;

    /**
     * Registers a node constructor
     * @param nodeSet - the nodeSet providing the node (module/set)
     * @param type - the string type name
     * @param constructor - the constructor function for this node type
     * @param opts - optional additional options for the node
     */
    function registerType(nodeSet,type,constructor,opts) {
        if (typeof type !== "string") {
            // This is someone calling the api directly, rather than via the
            // RED object provided to a node. Log a warning
            log.warn("["+nodeSet+"] Deprecated call to RED.runtime.nodes.registerType - node-set name must be provided as first argument");
            opts = constructor;
            constructor = type;
            type = nodeSet;
            nodeSet = "";
        }
        if (opts) {
            if (opts.credentials) {
                credentials.register(type,opts.credentials);
            }
            if (opts.settings) {
                try {
                    settings.registerNodeSettings(type,opts.settings);
                } catch(err) {
                    log.warn("["+type+"] "+err.message);
                }
            }
        }
        registry.registerType(nodeSet,type,constructor);
    }

    /**
     * Called from a Node's constructor function, invokes the super-class
     * constructor and attaches any credentials to the node.
     * @param node the node object being created
     * @param def the instance definition for the node
     */
    function createNode(node,def) {
        Node.call(node,def);
        var id = node.id;
        if (def._alias) {
            id = def._alias;
        }
        var creds = credentials.get(id);
        if (creds) {
            creds = clone(creds);
            //console.log("Attaching credentials to ",node.id);
            // allow $(foo) syntax to substitute env variables for credentials also...
            for (var p in creds) {
                Eif (creds.hasOwnProperty(p)) {
                    flowUtil.mapEnvVarProperties(creds,p);
                }
            }
            node.credentials = creds;
        } else Eif (credentials.getDefinition(node.type)) {
            node.credentials = {};
        }
    }

    function init(runtime) {
        settings = runtime.settings;
        log = runtime.log;
        credentials.init(runtime);
        flows.init(runtime);
        registry.init(runtime);
        context.init(runtime.settings);
        library.init(runtime);
    }

    function disableNode(id) {
        flows.checkTypeInUse(id);
        return registry.disableNode(id);
    }

    function uninstallModule(module) {
        var info = registry.getModuleInfo(module);
        if (!info) {
            throw new Error(log._("nodes.index.unrecognised-module", {module:module}));
        } else {
            for (var i=0;i<info.nodes.length;i++) {
                flows.checkTypeInUse(module+"/"+info.nodes[i].name);
            }
            return registry.uninstallModule(module);
        }
    }

    module.exports = {
        // Lifecycle
        init: init,
        load: registry.load,

        // Node registry
        createNode: createNode,
        getNode: flows.get,
        eachNode: flows.eachNode,

        paletteEditorEnabled: registry.paletteEditorEnabled,
        installModule: registry.installModule,
        uninstallModule: uninstallModule,

        enableNode: registry.enableNode,
        disableNode: disableNode,

        // Node type registry
        registerType: registerType,
        getType: registry.get,

        getNodeInfo: registry.getNodeInfo,
        getNodeList: registry.getNodeList,

        getModuleInfo: registry.getModuleInfo,

        getNodeConfigs: registry.getNodeConfigs,
        getNodeConfig: registry.getNodeConfig,
        getNodeIconPath: registry.getNodeIconPath,
        getNodeExampleFlows: library.getExampleFlows,
        getNodeExampleFlowPath: library.getExampleFlowPath,

        clearRegistry: registry.clear,
        cleanModuleList: registry.cleanModuleList,

        // Flow handling
        loadFlows:  flows.load,
        startFlows: flows.startFlows,
        stopFlows:  flows.stopFlows,
        setFlows:   flows.setFlows,
        getFlows:   flows.getFlows,

        addFlow:     flows.addFlow,
        getFlow:     flows.getFlow,
        updateFlow:  flows.updateFlow,
        removeFlow:  flows.removeFlow,
        // disableFlow: flows.disableFlow,
        // enableFlow:  flows.enableFlow,

        // Credentials
        addCredentials: credentials.add,
        getCredentials: credentials.get,
        deleteCredentials: credentials.delete,
        getCredentialDefinition: credentials.getDefinition,
        setCredentialSecret: credentials.setKey,
        clearCredentials: credentials.clear,
        exportCredentials: credentials.export
    };