Separate library api and runtime components

This commit is contained in:
Nick O'Leary
2018-04-18 17:09:31 +01:00
parent e8e8f70c27
commit 7409cb3abb
9 changed files with 263 additions and 160 deletions

View File

@@ -18,6 +18,7 @@ var when = require('when');
var redNodes = require("./nodes");
var storage = require("./storage");
var library = require("./library");
var log = require("./log");
var i18n = require("./i18n");
var events = require("./events");
@@ -65,6 +66,7 @@ function init(userSettings,_adminApi) {
adminApi = _adminApi;
}
redNodes.init(runtime);
library.init(runtime);
}
var version;
@@ -245,6 +247,7 @@ var runtime = module.exports = {
storage: storage,
events: events,
nodes: redNodes,
library: library,
util: require("./util"),
get adminApi() { return adminApi },
get nodeApp() { return nodeApp },

View File

@@ -0,0 +1,100 @@
/**
* 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 fs = require('fs');
var fspath = require('path');
var runtime;
var knownTypes = {};
var storage;
function init(_runtime) {
runtime = _runtime;
storage = runtime.storage;
knownTypes = {};
}
function registerType(id,type) {
if (knownTypes.hasOwnProperty(type)) {
throw new Error(`Library type '${type}' already registerd by ${id}'`)
}
knownTypes[type] = id;
}
function getAllEntries(type) {
if (!knownTypes.hasOwnProperty(type)) {
throw new Error(`Unknown library type '${type}'`);
}
}
function getEntry(type,path) {
if (type !== 'flows') {
if (!knownTypes.hasOwnProperty(type)) {
throw new Error(`Unknown library type '${type}'`);
}
return storage.getLibraryEntry(type,path);
} else {
return new Promise(function(resolve,reject) {
if (path.indexOf("_examples_/") === 0) {
var m = /^_examples_\/(@.*?\/[^\/]+|[^\/]+)\/(.*)$/.exec(path);
if (m) {
var module = m[1];
var entryPath = m[2];
var fullPath = runtime.nodes.getNodeExampleFlowPath(module,entryPath);
if (fullPath) {
try {
fs.readFile(fullPath,'utf8',function(err, data) {
runtime.log.audit({event: "library.get",type:"flow",path:path});
if (err) {
return reject(err);
}
return resolve(data);
})
} catch(err) {
return reject(err);
}
}
} else {
// IF we get here, we didn't find the file
var error = new Error("not_found");
error.code = "not_found";
return reject(error);
}
} else {
resolve(storage.getFlow(path));
}
});
}
}
function saveEntry(type,path,meta,body) {
if (type !== 'flows') {
if (!knownTypes.hasOwnProperty(type)) {
throw new Error(`Unknown library type '${type}'`);
}
return storage.saveLibraryEntry(type,path,meta,body);
} else {
return storage.saveFlow(path,body);
}
}
module.exports = {
init: init,
registerType: registerType,
getAllEntries: getAllEntries,
getEntry: getEntry,
saveEntry: saveEntry
}

View File

@@ -80,7 +80,11 @@ function createNodeApi(node) {
copyObjectProperties(runtime.settings,red.settings,null,["init","load","reset"]);
if (runtime.adminApi) {
red.comms = runtime.adminApi.comms;
red.library = runtime.adminApi.library;
red.library = {
register: function(type) {
return runtime.library.registerType(node.id,type);
}
};
red.auth = runtime.adminApi.auth;
red.httpAdmin = runtime.adminApi.adminApp;
red.httpNode = runtime.nodeApp;
@@ -377,7 +381,7 @@ function addModule(module) {
function loadNodeHelp(node,lang) {
var base = path.basename(node.template);
var localePath = undefined;
var localePath;
if (node.module === 'node-red') {
var cat_dir = path.dirname(node.template);
var cat = path.basename(cat_dir);