Reorganise red/api layout to better componentise

red/api/admin/index.js

@@ -0,0 +1,62 @@
+/**
+ * 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 express = require("express");
+
+var nodes = require("./nodes");
+var flows = require("./flows");
+var flow = require("./flow");
+var info = require("./info");
+var auth = require("../auth");
+
+var apiUtil = require("../util");
+
+module.exports = {
+    init: function(runtime) {
+        flows.init(runtime);
+        flow.init(runtime);
+        info.init(runtime);
+        nodes.init(runtime);
+
+        var needsPermission = auth.needsPermission;
+
+        var adminApp = express();
+
+        // Flows
+        adminApp.get("/flows",needsPermission("flows.read"),flows.get,apiUtil.errorHandler);
+        adminApp.post("/flows",needsPermission("flows.write"),flows.post,apiUtil.errorHandler);
+
+        // Flow
+        adminApp.get("/flow/:id",needsPermission("flows.read"),flow.get,apiUtil.errorHandler);
+        adminApp.post("/flow",needsPermission("flows.write"),flow.post,apiUtil.errorHandler);
+        adminApp.delete("/flow/:id",needsPermission("flows.write"),flow.delete,apiUtil.errorHandler);
+        adminApp.put("/flow/:id",needsPermission("flows.write"),flow.put,apiUtil.errorHandler);
+
+        // Nodes
+        adminApp.get("/nodes",needsPermission("nodes.read"),nodes.getAll,apiUtil.errorHandler);
+        adminApp.post("/nodes",needsPermission("nodes.write"),nodes.post,apiUtil.errorHandler);
+        adminApp.get(/\/nodes\/((@[^\/]+\/)?[^\/]+)$/,needsPermission("nodes.read"),nodes.getModule,apiUtil.errorHandler);
+        adminApp.put(/\/nodes\/((@[^\/]+\/)?[^\/]+)$/,needsPermission("nodes.write"),nodes.putModule,apiUtil.errorHandler);
+        adminApp.delete(/\/nodes\/((@[^\/]+\/)?[^\/]+)$/,needsPermission("nodes.write"),nodes.delete,apiUtil.errorHandler);
+        adminApp.get(/\/nodes\/((@[^\/]+\/)?[^\/]+)\/([^\/]+)$/,needsPermission("nodes.read"),nodes.getSet,apiUtil.errorHandler);
+        adminApp.put(/\/nodes\/((@[^\/]+\/)?[^\/]+)\/([^\/]+)$/,needsPermission("nodes.write"),nodes.putSet,apiUtil.errorHandler);
+
+        // Settings
+        adminApp.get("/settings",needsPermission("settings.read"),info.settings,apiUtil.errorHandler);
+
+        return adminApp;
+    }
+}

red/api/admin/info.js

@@ -13,13 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  **/
-var theme = require("./theme");
+var theme = require("../editor/theme");
 var util = require('util');
 var runtime;
 var settings;
 
 module.exports = {
     init: function(_runtime) {
+        console.log("info.init");
         runtime = _runtime;
         settings = runtime.settings;
     },
@@ -50,7 +51,6 @@ module.exports = {
         }
 
         settings.exportNodeSettings(safeSettings);
-
         res.json(safeSettings);
     }
 }

red/api/admin/nodes.js

@@ -15,7 +15,7 @@
  **/
 
 var when = require("when");
-var locales = require("./locales");
+var apiUtils = require("../util");
 var redNodes;
 var log;
 var i18n;
@@ -35,7 +35,7 @@ module.exports = {
             log.audit({event: "nodes.list.get"},req);
             res.json(redNodes.getNodeList());
         } else {
-            var lang = locales.determineLangFromHeaders(req.acceptsLanguages());
+            var lang = apiUtils.determineLangFromHeaders(req.acceptsLanguages());
             log.audit({event: "nodes.configs.get"},req);
             res.send(redNodes.getNodeConfigs(lang));
         }
@@ -141,7 +141,7 @@ module.exports = {
                 res.status(404).end();
             }
         } else {
-            var lang = locales.determineLangFromHeaders(req.acceptsLanguages());
+            var lang = apiUtils.determineLangFromHeaders(req.acceptsLanguages());
             result = redNodes.getNodeConfig(id,lang);
             if (result) {
                 log.audit({event: "nodes.config.get",id:id},req);

red/api/auth/index.js

@@ -22,7 +22,7 @@ var Tokens = require("./tokens");
 var Users = require("./users");
 var permissions = require("./permissions");
 
-var theme = require("../theme");
+var theme = require("../editor/theme");
 
 var settings = null;
 var log = null

red/api/editor/comms.js

@@ -48,9 +48,9 @@ function init(_server,runtime) {
 }
 
 function start() {
-    var Tokens = require("./auth/tokens");
-    var Users = require("./auth/users");
-    var Permissions = require("./auth/permissions");
+    var Tokens = require("../auth/tokens");
+    var Users = require("../auth/users");
+    var Permissions = require("../auth/permissions");
     if (!settings.disableEditor) {
         Users.default().then(function(anonymousUser) {
             var webSocketKeepAliveTime = settings.webSocketKeepAliveTime || 15000;

red/api/editor/index.js

@@ -0,0 +1,108 @@
+/**
+ * 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 express = require("express");
+var path = require('path');
+
+var comms = require("./comms");
+var library = require("./library");
+
+var auth = require("../auth");
+var needsPermission = auth.needsPermission;
+var runtime;
+var log;
+var apiUtil = require("../util");
+
+var ensureRuntimeStarted = function(req,res,next) {
+    if (!runtime.isStarted()) {
+        log.error("Node-RED runtime not started");
+        res.status(503).send("Not started");
+    } else {
+        next();
+    }
+}
+
+module.exports = {
+    init: function(server, _runtime) {
+        runtime = _runtime;
+        log = runtime.log;
+        var settings = runtime.settings;
+        if (!settings.disableEditor) {
+
+            comms.init(server,runtime);
+
+            var ui = require("./ui");
+            ui.init(runtime);
+            var editorApp = express();
+            if (settings.requireHttps === true) {
+                editorApp.enable('trust proxy');
+                editorApp.use(function (req, res, next) {
+                    if (req.secure) {
+                        next();
+                    } else {
+                        res.redirect('https://' + req.headers.host + req.originalUrl);
+                    }
+                });
+            }
+            editorApp.get("/",ensureRuntimeStarted,ui.ensureSlash,ui.editor);
+            editorApp.get("/icons/:module/:icon",ui.icon);
+            editorApp.get("/icons/:scope/:module/:icon",ui.icon);
+
+            var theme = require("./theme");
+            theme.init(runtime);
+            editorApp.use("/theme",theme.app());
+            editorApp.use("/",ui.editorResources);
+
+            // //Projects
+            // var projects = require("./projects");
+            // projects.init(runtime);
+            // editorApp.get("/projects",projects.app());
+
+            // Locales
+            var locales = require("./locales");
+            locales.init(runtime);
+            editorApp.get('/locales/nodes',locales.getAllNodes,apiUtil.errorHandler);
+            editorApp.get(/locales\/(.+)\/?$/,locales.get,apiUtil.errorHandler);
+
+            // Library
+            var library = require("./library");
+            library.init(editorApp,runtime);
+            editorApp.post(new RegExp("/library/flows\/(.*)"),needsPermission("library.write"),library.post,apiUtil.errorHandler);
+            editorApp.get("/library/flows",needsPermission("library.read"),library.getAll,apiUtil.errorHandler);
+            editorApp.get(new RegExp("/library/flows\/(.*)"),needsPermission("library.read"),library.get,apiUtil.errorHandler);
+
+            // Credentials
+            var credentials = require("./credentials");
+            credentials.init(runtime);
+            editorApp.get('/credentials/:type/:id', needsPermission("credentials.read"),credentials.get,apiUtil.errorHandler);
+
+            return editorApp;
+        }
+    },
+    start: function() {
+        var catalogPath = path.resolve(path.join(__dirname,"locales"));
+        return runtime.i18n.registerMessageCatalogs([
+            {namespace: "editor",   dir: catalogPath, file:"editor.json"},
+            {namespace: "jsonata",  dir: catalogPath, file:"jsonata.json"},
+            {namespace: "infotips", dir: catalogPath, file:"infotips.json"}
+        ]).then(function(){
+            comms.start();
+        });
+    },
+    stop: comms.stop,
+    publish: comms.publish,
+    registerLibrary: library.register
+}

red/api/editor/library.js

@@ -21,7 +21,7 @@ var redApp = null;
 var storage;
 var log;
 var redNodes;
-var needsPermission = require("./auth").needsPermission;
+var needsPermission = require("../auth").needsPermission;
 
 function createLibrary(type) {
     if (redApp) {

red/api/editor/locales.js

@@ -15,17 +15,10 @@
  **/
 var fs = require('fs');
 var path = require('path');
+//var apiUtil = require('../util');
 var i18n;
 var redNodes;
 
-function determineLangFromHeaders(acceptedLanguages){
-    var lang = i18n.defaultLang;
-    acceptedLanguages = acceptedLanguages || [];
-    if (acceptedLanguages.length >= 1) {
-        lang = acceptedLanguages[0];
-    }
-    return lang;
-}
 module.exports = {
     init: function(runtime) {
         i18n = runtime.i18n;
@@ -35,7 +28,7 @@ module.exports = {
         var namespace = req.params[0];
         var lngs = req.query.lng;
         namespace = namespace.replace(/\.json$/,"");
-        var lang = req.query.lng; //determineLangFromHeaders(req.acceptsLanguages() || []);
+        var lang = req.query.lng; //apiUtil.determineLangFromHeaders(req.acceptsLanguages() || []);
         var prevLang = i18n.i.lng();
         // Trigger a load from disk of the language if it is not the default
         i18n.i.setLng(lang, function(){
@@ -55,6 +48,5 @@ module.exports = {
             }
         });
         res.json(result);
-    },
-    determineLangFromHeaders: determineLangFromHeaders
+    }
 }

red/api/editor/ui.js

@@ -22,7 +22,7 @@ var theme = require("./theme");
 
 var redNodes;
 
-var templateDir = path.resolve(__dirname+"/../../editor/templates");
+var templateDir = path.resolve(__dirname+"/../../../editor/templates");
 var editorTemplate;
 
 module.exports = {
@@ -52,5 +52,5 @@ module.exports = {
     editor: function(req,res) {
         res.send(Mustache.render(editorTemplate,theme.context()));
     },
-    editorResources: express.static(__dirname + '/../../public')
+    editorResources: express.static(__dirname + '/../../../public')
 };

red/api/index.js

@@ -17,49 +17,19 @@
 var express = require("express");
 var bodyParser = require("body-parser");
 var util = require('util');
-var path = require('path');
 var passport = require('passport');
 var when = require('when');
 var cors = require('cors');
 
-var ui = require("./ui");
-var nodes = require("./nodes");
-var flows = require("./flows");
-var flow = require("./flow");
-var library = require("./library");
-var info = require("./info");
-var theme = require("./theme");
-var locales = require("./locales");
-var credentials = require("./credentials");
-var comms = require("./comms");
-
 var auth = require("./auth");
-var needsPermission = auth.needsPermission;
+var apiUtil = require("./util");
 
 var i18n;
 var log;
 var adminApp;
 var server;
 var runtime;
-
-var errorHandler = function(err,req,res,next) {
-    if (err.message === "request entity too large") {
-        log.error(err);
-    } else {
-        console.log(err.stack);
-    }
-    log.audit({event: "api.error",error:err.code||"unexpected_error",message:err.toString()},req);
-    res.status(400).json({error:"unexpected_error", message:err.toString()});
-};
-
-var ensureRuntimeStarted = function(req,res,next) {
-    if (!runtime.isStarted()) {
-        log.error("Node-RED runtime not started");
-        res.status(503).send("Not started");
-    } else {
-        next();
-    }
-}
+var editor;
 
 function init(_server,_runtime) {
     server = _server;
@@ -68,45 +38,22 @@ function init(_server,_runtime) {
     i18n = runtime.i18n;
     log = runtime.log;
     if (settings.httpAdminRoot !== false) {
-        comms.init(server,runtime);
+        apiUtil.init(runtime);
         adminApp = express();
         auth.init(runtime);
-        credentials.init(runtime);
-        flows.init(runtime);
-        flow.init(runtime);
-        info.init(runtime);
-        library.init(adminApp,runtime);
-        locales.init(runtime);
-        nodes.init(runtime);
 
-        // Editor
-        if (!settings.disableEditor) {
-            ui.init(runtime);
-            var editorApp = express();
-            if (settings.requireHttps === true) {
-                editorApp.enable('trust proxy');
-                editorApp.use(function (req, res, next) {
-                    if (req.secure) {
-                        next();
-                    } else {
-                        res.redirect('https://' + req.headers.host + req.originalUrl);
-                    }
-                });
-            }
-            editorApp.get("/",ensureRuntimeStarted,ui.ensureSlash,ui.editor);
-            editorApp.get("/icons/:module/:icon",ui.icon);
-            editorApp.get("/icons/:scope/:module/:icon",ui.icon);            
-            theme.init(runtime);
-            editorApp.use("/theme",theme.app());
-            editorApp.use("/",ui.editorResources);
-            adminApp.use(editorApp);
-        }
         var maxApiRequestSize = settings.apiMaxLength || '5mb';
         adminApp.use(bodyParser.json({limit:maxApiRequestSize}));
         adminApp.use(bodyParser.urlencoded({limit:maxApiRequestSize,extended:true}));
 
-        adminApp.get("/auth/login",auth.login,errorHandler);
+        // Editor
+        if (!settings.disableEditor) {
+            editor = require("./editor");
+            var editorApp = editor.init(server, runtime);
+            adminApp.use(editorApp);
+        }
 
+        adminApp.get("/auth/login",auth.login,apiUtil.errorHandler);
         if (settings.adminAuth) {
             if (settings.adminAuth.type === "strategy") {
                 auth.genericStrategy(adminApp,settings.adminAuth.strategy);
@@ -119,62 +66,31 @@ function init(_server,_runtime) {
                     auth.errorHandler
                 );
             }
-            adminApp.post("/auth/revoke",needsPermission(""),auth.revoke,errorHandler);
+            adminApp.post("/auth/revoke",auth.needsPermission(""),auth.revoke,apiUtil.errorHandler);
         }
+
         if (settings.httpAdminCors) {
             var corsHandler = cors(settings.httpAdminCors);
             adminApp.use(corsHandler);
         }
 
-        // Flows
-        adminApp.get("/flows",needsPermission("flows.read"),flows.get,errorHandler);
-        adminApp.post("/flows",needsPermission("flows.write"),flows.post,errorHandler);
-
-        adminApp.get("/flow/:id",needsPermission("flows.read"),flow.get,errorHandler);
-        adminApp.post("/flow",needsPermission("flows.write"),flow.post,errorHandler);
-        adminApp.delete("/flow/:id",needsPermission("flows.write"),flow.delete,errorHandler);
-        adminApp.put("/flow/:id",needsPermission("flows.write"),flow.put,errorHandler);
-
-        // Nodes
-        adminApp.get("/nodes",needsPermission("nodes.read"),nodes.getAll,errorHandler);
-        adminApp.post("/nodes",needsPermission("nodes.write"),nodes.post,errorHandler);
-
-        adminApp.get(/\/nodes\/((@[^\/]+\/)?[^\/]+)$/,needsPermission("nodes.read"),nodes.getModule,errorHandler);
-        adminApp.put(/\/nodes\/((@[^\/]+\/)?[^\/]+)$/,needsPermission("nodes.write"),nodes.putModule,errorHandler);
-        adminApp.delete(/\/nodes\/((@[^\/]+\/)?[^\/]+)$/,needsPermission("nodes.write"),nodes.delete,errorHandler);
-
-        adminApp.get(/\/nodes\/((@[^\/]+\/)?[^\/]+)\/([^\/]+)$/,needsPermission("nodes.read"),nodes.getSet,errorHandler);
-        adminApp.put(/\/nodes\/((@[^\/]+\/)?[^\/]+)\/([^\/]+)$/,needsPermission("nodes.write"),nodes.putSet,errorHandler);
-
-        adminApp.get('/credentials/:type/:id', needsPermission("credentials.read"),credentials.get,errorHandler);
-
-        adminApp.get('/locales/nodes',locales.getAllNodes,errorHandler);
-        adminApp.get(/locales\/(.+)\/?$/,locales.get,errorHandler);
-
-        // Library
-        adminApp.post(new RegExp("/library/flows\/(.*)"),needsPermission("library.write"),library.post,errorHandler);
-        adminApp.get("/library/flows",needsPermission("library.read"),library.getAll,errorHandler);
-        adminApp.get(new RegExp("/library/flows\/(.*)"),needsPermission("library.read"),library.get,errorHandler);
-
-        // Settings
-        adminApp.get("/settings",needsPermission("settings.read"),info.settings,errorHandler);
-
-        // Error Handler
-        //adminApp.use(errorHandler);
+        var adminApiApp = require("./admin").init(runtime);
+        adminApp.use(adminApiApp);
+    } else {
+        adminApp = null;
     }
 }
 function start() {
-    var catalogPath = path.resolve(path.join(__dirname,"locales"));
-    return i18n.registerMessageCatalogs([
-        {namespace: "editor",   dir: catalogPath, file:"editor.json"},
-        {namespace: "jsonata",  dir: catalogPath, file:"jsonata.json"},
-        {namespace: "infotips", dir: catalogPath, file:"infotips.json"}
-    ]).then(function(){
-        comms.start();
-    });
+    if (editor) {
+        return editor.start();
+    } else {
+        return when.resolve();
+    }
 }
 function stop() {
-    comms.stop();
+    if (editor) {
+        editor.stop();
+    }
     return when.resolve();
 }
 module.exports = {
@@ -182,13 +98,21 @@ module.exports = {
     start: start,
     stop: stop,
     library: {
-        register: library.register
+        register: function(type) {
+            if (editor) {
+                editor.registerLibrary(type);
+            }
+        }
     },
     auth: {
         needsPermission: auth.needsPermission
     },
     comms: {
-        publish: comms.publish
+        publish: function(topic,data,retain) {
+            if (editor) {
+                editor.publish(topic,data,retain);
+            }
+        }
     },
     get adminApp() { return adminApp; },
     get server() { return server; }

red/api/util.js

@@ -0,0 +1,47 @@
+/**
+ * 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 i18n;
+var log;
+
+module.exports = {
+    init: function(_runtime) {
+        log = _runtime.log;
+        i18n = _runtime.i18n;
+    },
+    errorHandler: function(err,req,res,next) {
+        if (err.message === "request entity too large") {
+            log.error(err);
+        } else {
+            log.error(err.stack);
+        }
+        log.audit({event: "api.error",error:err.code||"unexpected_error",message:err.toString()},req);
+        res.status(400).json({error:"unexpected_error", message:err.toString()});
+    },
+
+    determineLangFromHeaders: function(acceptedLanguages){
+        console.log("GOT",acceptedLanguages)
+        var lang = i18n.defaultLang;
+        acceptedLanguages = acceptedLanguages || [];
+        if (acceptedLanguages.length >= 1) {
+            console.log("WE HAVE SOMETHING");
+            lang = acceptedLanguages[0];
+        }
+        console.log("RETURNING",lang);
+        return lang;
+    }
+}