mirror of
https://github.com/node-red/node-red.git
synced 2025-03-01 10:36:34 +00:00
update external context
- Implement `delete` function - Swap default easily - Change memory context as a plugin - Update localfilesystem plugin - Change file/folder structure
This commit is contained in:
Hiroki Uchikawa
committed by
HirokiUchikawa
HirokiUchikawa
parent
b4b70a988e
commit
e33ec0cf50
@@ -1,133 +0,0 @@
|
||||
/**
|
||||
* 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 log = require("../../log");
|
||||
|
||||
var re = /^(\$.*?)\.(.+)|^(\$.*)/;
|
||||
var externalContexts;
|
||||
|
||||
function parseKey(key){
|
||||
var keys = null;
|
||||
var temp = re.exec(key);
|
||||
if(temp){
|
||||
keys = [];
|
||||
if(temp[3]){
|
||||
keys[0] = temp[3];
|
||||
keys[1] = null;
|
||||
} else {
|
||||
keys[0] = temp[1];
|
||||
keys[1] = temp[2];
|
||||
}
|
||||
keys[0] = keys[0] === "$" ? "default" : keys[0].substring(1);
|
||||
}
|
||||
return keys;
|
||||
}
|
||||
|
||||
function hasContextStorage(plugin) {
|
||||
return externalContexts.hasOwnProperty(plugin);
|
||||
}
|
||||
|
||||
var contextModuleInterface ={
|
||||
init: function (settings) {
|
||||
var plugins = settings.contextStorage;
|
||||
externalContexts = {};
|
||||
if (plugins) {
|
||||
for(var pluginName in plugins){
|
||||
var plugin;
|
||||
if(plugins[pluginName].hasOwnProperty("module") && plugins[pluginName].hasOwnProperty("config")) {
|
||||
if(typeof plugins[pluginName].module === "string") {
|
||||
try{
|
||||
plugin = require(plugins[pluginName].module);
|
||||
}catch(err){
|
||||
log.error(err);
|
||||
continue;
|
||||
}
|
||||
} else {
|
||||
plugin = plugins[pluginName].module;
|
||||
}
|
||||
plugin.init(plugins[pluginName].config);
|
||||
externalContexts[pluginName] = plugin;
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
get: function(key, flowId) {
|
||||
var result = parseKey(key);
|
||||
if(!result){
|
||||
throw new Error("Invalid key");
|
||||
}
|
||||
if(hasContextStorage(result[0])){
|
||||
return externalContexts[result[0]].get(result[1], flowId);
|
||||
}else if(hasContextStorage("default")) {
|
||||
// log.warn(result[1] " is got from default context storage");
|
||||
return externalContexts["default"].get(result[1], flowId);
|
||||
}else{
|
||||
throw new Error(result[0] + " is not defined in setting.js");
|
||||
}
|
||||
|
||||
},
|
||||
set: function(key, value, flowId) {
|
||||
var result = parseKey(key);
|
||||
if(!result){
|
||||
throw new Error("Invalid key");
|
||||
}
|
||||
if(hasContextStorage(result[0])){
|
||||
externalContexts[result[0]].set(result[1], value, flowId);
|
||||
}else if(hasContextStorage("default")) {
|
||||
// log.warn(result[1] " is set to default context storage");
|
||||
externalContexts["default"].set(result[1], value, flowId);
|
||||
}else{
|
||||
throw new Error(result[0] + " is not defined in setting.js");
|
||||
}
|
||||
},
|
||||
keys: function(key, flowId) {
|
||||
var result = parseKey(key);
|
||||
if(!result){
|
||||
throw new Error("Invalid key");
|
||||
}
|
||||
if(hasContextStorage(result[0])){
|
||||
return externalContexts[result[0]].keys(flowId);
|
||||
}else if(hasContextStorage("default")) {
|
||||
// log.warn("keys are got from default context storage");
|
||||
externalContexts["default"].keys(flowId);
|
||||
}else{
|
||||
throw new Error(result[0] + " is not defined in setting.js");
|
||||
}
|
||||
},
|
||||
// run: function(command,key,value,flowId) {
|
||||
// //todo: run custom method in plugin
|
||||
// },
|
||||
// close: function(){
|
||||
// //todo: close connections, streams, etc...
|
||||
// },
|
||||
canUse: function(key){
|
||||
var result = parseKey(key);
|
||||
if(!result){
|
||||
return false;
|
||||
}else{
|
||||
if(hasContextStorage(result[0]) || hasContextStorage("default")){
|
||||
return true;
|
||||
}else{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
},
|
||||
hasContextStorage: hasContextStorage,
|
||||
parseKey: parseKey
|
||||
};
|
||||
|
||||
module.exports = contextModuleInterface;
|
||||
@@ -14,57 +14,110 @@
|
||||
* limitations under the License.
|
||||
**/
|
||||
|
||||
var clone = require("clone");
|
||||
var util = require("../../util");
|
||||
var log = require("../../log");
|
||||
var externalContext = require("./external");
|
||||
|
||||
var settings;
|
||||
var contexts = {};
|
||||
var globalContext = null;
|
||||
var externalContexts = {};
|
||||
|
||||
var re = /^(\$.*?)\.(.+)|^(\$.*)/;
|
||||
function init(_settings) {
|
||||
settings = _settings;
|
||||
externalContexts = {};
|
||||
|
||||
function createContext(id,seed) {
|
||||
var flowId = id;
|
||||
var data = seed || {};
|
||||
var obj = seed || {};
|
||||
// init meomory plugin
|
||||
externalContexts["_"] = require("./memory");
|
||||
externalContexts["_"].init();
|
||||
globalContext = createContext("global",settings.functionGlobalContext || {});
|
||||
}
|
||||
|
||||
function get(key) {
|
||||
return util.getMessageProperty(data,key);
|
||||
};
|
||||
function set(key, value) {
|
||||
util.setMessageProperty(data,key,value);
|
||||
};
|
||||
function keys() {
|
||||
var keysData = Object.keys(data);
|
||||
if (seed == null) {
|
||||
return keysData;
|
||||
} else {
|
||||
return keysData.filter(function (key) {
|
||||
return key !== "set" && key !== "get" && key !== "keys";
|
||||
});
|
||||
function load() {
|
||||
// load & init plugins in settings.contextStorage
|
||||
var plugins = settings.contextStorage;
|
||||
var alias = null;
|
||||
if (plugins) {
|
||||
for(var pluginName in plugins){
|
||||
if(pluginName === "_"){
|
||||
continue;
|
||||
}
|
||||
if(pluginName === "default" && typeof plugins[pluginName] === "string"){
|
||||
alias = plugins[pluginName];
|
||||
continue;
|
||||
}
|
||||
var plugin;
|
||||
if(plugins[pluginName].hasOwnProperty("module")){
|
||||
var config = plugins[pluginName].config || {};
|
||||
copySettings(config, settings);
|
||||
try{
|
||||
plugin = require("./"+plugins[pluginName].module);
|
||||
}catch(err){
|
||||
throw new Error(plugins[pluginName].module + " could not be loaded");
|
||||
}
|
||||
plugin.init(config);
|
||||
externalContexts[pluginName] = plugin;
|
||||
}else{
|
||||
throw new Error("module is is not defined in settings.contextStorage." + plugins[pluginName] );
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
obj.get = function(key) {
|
||||
if(externalContext.canUse(key)) {
|
||||
return externalContext.get(key, flowId);
|
||||
}else{
|
||||
return get(key);
|
||||
}
|
||||
};
|
||||
obj.set = function(key, value) {
|
||||
if(externalContext.canUse(key)) {
|
||||
externalContext.set(key, value, flowId);
|
||||
}else{
|
||||
set(key, value);
|
||||
if(alias){
|
||||
if(externalContexts.hasOwnProperty(alias)){
|
||||
externalContexts["default"] = externalContexts[alias];
|
||||
}else{
|
||||
throw new Error("default is invalid" + plugins["default"])
|
||||
}
|
||||
}
|
||||
}
|
||||
obj.keys = function(key) {
|
||||
if(externalContext.canUse(key)) {
|
||||
return externalContext.keys(key, flowId);
|
||||
}else{
|
||||
return keys();
|
||||
}
|
||||
|
||||
function copySettings(config, settings){
|
||||
var copy = ["userDir"]
|
||||
config.settings = {};
|
||||
copy.forEach(function(setting){
|
||||
config.settings[setting] = clone(settings[setting]);
|
||||
});
|
||||
}
|
||||
|
||||
function createContext(id,seed) {
|
||||
var scope = id;
|
||||
var obj = seed || {};
|
||||
|
||||
obj.get = function(key) {
|
||||
var result = parseKey(key);
|
||||
if(!result){
|
||||
return externalContexts["_"].get(key, scope);
|
||||
}
|
||||
if(externalContexts.hasOwnProperty(result[0])){
|
||||
return externalContexts[result[0]].get(result[1], scope);
|
||||
}else if(externalContexts.hasOwnProperty("defalut")){
|
||||
return externalContexts["defalut"].get(result[1], scope);
|
||||
}else{
|
||||
throw new Error(result[0] + " is not defined in setting.js");
|
||||
}
|
||||
};
|
||||
obj.set = function(key, value) {
|
||||
var result = parseKey(key);
|
||||
if(!result){
|
||||
return externalContexts["_"].set(key, value, scope);
|
||||
}
|
||||
if(externalContexts.hasOwnProperty(result[0])){
|
||||
externalContexts[result[0]].set(result[1], value, scope);
|
||||
}else if(externalContexts.hasOwnProperty("defalut")){
|
||||
externalContexts["defalut"].set(result[1], value, scope);
|
||||
}else{
|
||||
throw new Error(result[0] + " is not defined in setting.js");
|
||||
}
|
||||
};
|
||||
obj.keys = function() {
|
||||
//TODO: discuss about keys() behavior
|
||||
var keys = [];
|
||||
for(var plugin in externalContexts){
|
||||
keys.concat(externalContexts[plugin].keys(scope));
|
||||
}
|
||||
return keys;
|
||||
};
|
||||
if(id === "global"){
|
||||
externalContexts["_"].setGlobalContext(seed);
|
||||
}
|
||||
return obj;
|
||||
}
|
||||
@@ -72,7 +125,7 @@ function createContext(id,seed) {
|
||||
function getContext(localId,flowId) {
|
||||
var contextId = localId;
|
||||
if (flowId) {
|
||||
contextId = localId+"_"+flowId;
|
||||
contextId = localId+":"+flowId;
|
||||
}
|
||||
if (contexts.hasOwnProperty(contextId)) {
|
||||
return contexts[contextId];
|
||||
@@ -91,7 +144,10 @@ function getContext(localId,flowId) {
|
||||
function deleteContext(id,flowId) {
|
||||
var contextId = id;
|
||||
if (flowId) {
|
||||
contextId = id+"_"+flowId;
|
||||
contextId = id+":"+flowId;
|
||||
}
|
||||
for(var plugin in externalContexts){
|
||||
externalContexts[plugin].delete(contextId);
|
||||
}
|
||||
delete contexts[contextId];
|
||||
}
|
||||
@@ -102,19 +158,36 @@ function clean(flowConfig) {
|
||||
var node;
|
||||
for (var id in contexts) {
|
||||
if (contexts.hasOwnProperty(id)) {
|
||||
var idParts = id.split("_");
|
||||
var idParts = id.split(":");
|
||||
if (!flowConfig.allNodes.hasOwnProperty(idParts[0])) {
|
||||
for(var plugin in externalContexts){
|
||||
externalContexts[plugin].delete(id);
|
||||
}
|
||||
delete contexts[id];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function parseKey(key){
|
||||
var keys = null;
|
||||
if(!key){
|
||||
return null;
|
||||
}
|
||||
var index_$ = key.indexOf("$");
|
||||
var index_dot = key.indexOf(".", 1);
|
||||
if(index_$ === 0 && index_dot){
|
||||
keys = [];
|
||||
keys[0] = key.substring(1,index_dot);
|
||||
keys[1] = key.substring(index_dot + 1);
|
||||
keys[0] = keys[0] || "default";
|
||||
}
|
||||
return keys;
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
init: function(settings) {
|
||||
globalContext = createContext("global",settings.functionGlobalContext || {});
|
||||
externalContext.init(settings);
|
||||
},
|
||||
init: init,
|
||||
load: load,
|
||||
get: getContext,
|
||||
delete: deleteContext,
|
||||
clean:clean
|
||||
|
||||
@@ -14,67 +14,105 @@
|
||||
* limitations under the License.
|
||||
**/
|
||||
|
||||
var storage = require('node-persist');
|
||||
var JsonDB = require('node-json-db');
|
||||
var fs = require('fs-extra');
|
||||
var fspath = require("path");
|
||||
var path = require("path");
|
||||
|
||||
var configs;
|
||||
var storagePath;
|
||||
var fileStorages;
|
||||
var storageBaseDir;
|
||||
var storages;
|
||||
|
||||
function createStorage(path) {
|
||||
var fileStorage = storage.create({dir: fspath.join(storagePath,path)});
|
||||
fileStorage.initSync();
|
||||
fileStorages[path] = fileStorage;
|
||||
function createStorage(scope) {
|
||||
var i = scope.indexOf(":")
|
||||
|
||||
if(i === -1){
|
||||
if(scope === "global"){
|
||||
storages[scope] = new JsonDB(path.join(storageBaseDir,"global",scope), true, true);
|
||||
}else{ // scope:flow
|
||||
storages[scope] = new JsonDB(path.join(storageBaseDir,scope,"flow"), true, true);
|
||||
}
|
||||
}else{ // scope:local
|
||||
var ids = scope.split(":")
|
||||
storages[scope] = new JsonDB(path.join(storageBaseDir,ids[1],ids[0]), true, true);
|
||||
}
|
||||
}
|
||||
|
||||
var localfilesystem = {
|
||||
init: function(_configs) {
|
||||
configs = _configs;
|
||||
fileStorages = {};
|
||||
storages = {};
|
||||
if (!configs.dir) {
|
||||
try {
|
||||
fs.statSync(fspath.join(process.env.NODE_RED_HOME,".config.json"));
|
||||
storagePath = fspath.join(process.env.NODE_RED_HOME,"contexts");
|
||||
} catch(err) {
|
||||
if(configs.settings && configs.settings.userDir){
|
||||
storageBaseDir = path.join(configs.settings.userDir,"contexts");
|
||||
}else{
|
||||
try {
|
||||
// Consider compatibility for older versions
|
||||
if (process.env.HOMEPATH) {
|
||||
fs.statSync(fspath.join(process.env.HOMEPATH,".node-red",".config.json"));
|
||||
storagePath = fspath.join(process.env.HOMEPATH,".node-red","contexts");
|
||||
}
|
||||
fs.statSync(path.join(process.env.NODE_RED_HOME,".config.json"));
|
||||
storageBaseDir = path.join(process.env.NODE_RED_HOME,"contexts");
|
||||
} catch(err) {
|
||||
}
|
||||
if (!configs.dir) {
|
||||
storagePath = fspath.join(process.env.HOME || process.env.USERPROFILE || process.env.HOMEPATH || process.env.NODE_RED_HOME,".node-red","contexts");
|
||||
try {
|
||||
// Consider compatibility for older versions
|
||||
if (process.env.HOMEPATH) {
|
||||
fs.statSync(path.join(process.env.HOMEPATH,".node-red",".config.json"));
|
||||
storageBaseDir = path.join(process.env.HOMEPATH,".node-red","contexts");
|
||||
}
|
||||
} catch(err) {
|
||||
}
|
||||
if (!storageBaseDir) {
|
||||
storageBaseDir = path.join(process.env.HOME || process.env.USERPROFILE || process.env.HOMEPATH || process.env.NODE_RED_HOME,".node-red","contexts");
|
||||
}
|
||||
}
|
||||
}
|
||||
}else{
|
||||
storagePath = configs.dir;
|
||||
storageBaseDir = configs.dir;
|
||||
}
|
||||
|
||||
},
|
||||
stop: function() {
|
||||
return when.resolve();
|
||||
},
|
||||
get: function (key, flowId) {
|
||||
if(!fileStorages[flowId]){
|
||||
createStorage(flowId);
|
||||
get: function (key, scope) {
|
||||
if(!storages[scope]){
|
||||
createStorage(scope);
|
||||
}
|
||||
try{
|
||||
storages[scope].reload();
|
||||
return storages[scope].getData("/" + key.replace(/\./g,"/"));
|
||||
}catch(err){
|
||||
if(err.name === "DataError"){
|
||||
return undefined;
|
||||
}else{
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
return fileStorages[flowId].getItemSync(key);
|
||||
},
|
||||
|
||||
set: function (key, value, flowId) {
|
||||
if(!fileStorages[flowId]){
|
||||
createStorage(flowId);
|
||||
set: function (key, value, scope) {
|
||||
if(!storages[scope]){
|
||||
createStorage(scope);
|
||||
}
|
||||
if(value){
|
||||
storages[scope].push("/" + key.replace(/\./g,"/"), value);
|
||||
}else{
|
||||
storages[scope].delete("/" + key.replace(/\./g,"/"));
|
||||
}
|
||||
fileStorages[flowId].setItemSync(key, value);
|
||||
},
|
||||
keys: function (flowId) {
|
||||
if(!fileStorages[flowId]){
|
||||
createStorage(flowId);
|
||||
keys: function (scope) {
|
||||
if(!storages[scope]){
|
||||
return [];
|
||||
}
|
||||
return Object.keys(storages[scope].getData("/"));
|
||||
},
|
||||
delete: function(scope){
|
||||
if(storages[scope]){
|
||||
storages[scope].delete("/");
|
||||
if(scope.indexOf(":") === -1){
|
||||
fs.removeSync(path.dirname(storages[scope].filename));
|
||||
}else{
|
||||
try{
|
||||
fs.statSync(storages[scope].filename);
|
||||
fs.unlinkSync(storages[scope].filename);
|
||||
}catch(err){
|
||||
console.log("deleted");
|
||||
}
|
||||
}
|
||||
delete storages[scope];
|
||||
}
|
||||
return fileStorages[flowId].keys();
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
59
red/runtime/nodes/context/memory.js
Normal file
59
red/runtime/nodes/context/memory.js
Normal file
@@ -0,0 +1,59 @@
|
||||
/**
|
||||
* 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 util = require("../../util");
|
||||
|
||||
var data;
|
||||
var seedFlg = false;
|
||||
|
||||
var memory = {
|
||||
init: function(config) {
|
||||
data = {};
|
||||
},
|
||||
get: function(key, scope) {
|
||||
if(!data[scope]){
|
||||
data[scope] = {};
|
||||
}
|
||||
return util.getMessageProperty(data[scope],key);
|
||||
},
|
||||
set: function(key, value, scope) {
|
||||
if(!data[scope]){
|
||||
data[scope] = {};
|
||||
}
|
||||
util.setMessageProperty(data[scope],key,value);
|
||||
},
|
||||
keys: function(scope){
|
||||
if(!data[scope]){
|
||||
data[scope] = {};
|
||||
}
|
||||
var keysData = Object.keys(data[scope]);
|
||||
if (scope !== "global") {
|
||||
return keysData;
|
||||
} else {
|
||||
return keysData.filter(function (key) {
|
||||
return key !== "set" && key !== "get" && key !== "keys";
|
||||
});
|
||||
}
|
||||
},
|
||||
delete: function(scope){
|
||||
delete data[scope];
|
||||
},
|
||||
setGlobalContext: function(seed){
|
||||
data["global"] = seed;
|
||||
}
|
||||
};
|
||||
|
||||
module.exports = memory;
|
||||
Reference in New Issue
Block a user