1
0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
node-red/packages/node_modules/@node-red/runtime/lib/storage/index.js

241 lines
8.3 KiB
JavaScript
Raw Normal View History

/**
* 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.
**/
2014-07-23 16:15:20 +02:00
var when = require('when');
var Path = require('path');
var crypto = require('crypto');
2018-08-04 23:23:06 +02:00
var log = require("@node-red/util").log; // TODO: separate module
var runtime;
2014-07-23 16:15:20 +02:00
var storageModule;
var settingsAvailable;
var sessionsAvailable;
2014-07-23 16:15:20 +02:00
var libraryFlowsCachedResult = null;
2014-07-23 16:15:20 +02:00
function moduleSelector(aSettings) {
var toReturn;
if (aSettings.storageModule) {
if (typeof aSettings.storageModule === "string") {
// TODO: allow storage modules to be specified by absolute path
toReturn = require("./"+aSettings.storageModule);
} else {
toReturn = aSettings.storageModule;
}
} else {
2014-07-23 16:15:20 +02:00
toReturn = require("./localfilesystem");
}
2014-07-23 16:15:20 +02:00
return toReturn;
}
function is_malicious(path) {
return path.indexOf('../') != -1 || path.indexOf('..\\') != -1;
}
2014-07-23 16:15:20 +02:00
var storageModuleInterface = {
init: function(_runtime) {
runtime = _runtime;
2014-07-23 16:15:20 +02:00
try {
storageModule = moduleSelector(runtime.settings);
settingsAvailable = storageModule.hasOwnProperty("getSettings") && storageModule.hasOwnProperty("saveSettings");
sessionsAvailable = storageModule.hasOwnProperty("getSessions") && storageModule.hasOwnProperty("saveSessions");
2014-07-23 16:15:20 +02:00
} catch (e) {
return when.reject(e);
}
if (!!storageModule.projects) {
2018-01-23 00:14:38 +01:00
var projectsEnabled = false;
if (runtime.settings.hasOwnProperty("editorTheme") && runtime.settings.editorTheme.hasOwnProperty("projects")) {
2018-01-23 00:14:38 +01:00
projectsEnabled = runtime.settings.editorTheme.projects.enabled === true;
}
if (projectsEnabled) {
storageModuleInterface.projects = storageModule.projects;
}
2017-09-20 11:30:07 +02:00
}
2017-12-07 15:11:24 +01:00
if (storageModule.sshkeys) {
storageModuleInterface.sshkeys = storageModule.sshkeys;
}
2017-09-20 11:30:07 +02:00
return storageModule.init(runtime.settings,runtime);
2014-07-23 16:15:20 +02:00
},
getFlows: function() {
return storageModule.getFlows().then(function(flows) {
return storageModule.getCredentials().then(function(creds) {
var result = {
flows: flows,
credentials: creds
};
result.rev = crypto.createHash('md5').update(JSON.stringify(result.flows)).digest("hex");
return result;
})
});
2014-07-23 16:15:20 +02:00
},
saveFlows: function(config) {
var flows = config.flows;
var credentials = config.credentials;
var credentialSavePromise;
if (config.credentialsDirty) {
credentialSavePromise = storageModule.saveCredentials(credentials);
} else {
credentialSavePromise = when.resolve();
}
delete config.credentialsDirty;
return credentialSavePromise.then(function() {
return storageModule.saveFlows(flows).then(function() {
return crypto.createHash('md5').update(JSON.stringify(config.flows)).digest("hex");
})
});
2014-07-23 16:15:20 +02:00
},
// getCredentials: function() {
// return storageModule.getCredentials();
// },
saveCredentials: function(credentials) {
return storageModule.saveCredentials(credentials);
},
getSettings: function() {
if (settingsAvailable) {
return storageModule.getSettings();
} else {
return when.resolve(null);
}
},
saveSettings: function(settings) {
if (settingsAvailable) {
return storageModule.saveSettings(settings);
} else {
return when.resolve();
}
},
getSessions: function() {
if (sessionsAvailable) {
return storageModule.getSessions();
} else {
return when.resolve(null);
}
},
saveSessions: function(sessions) {
if (sessionsAvailable) {
return storageModule.saveSessions(sessions);
} else {
return when.resolve();
}
},
/* Library Functions */
getLibraryEntry: function(type, path) {
if (is_malicious(path)) {
var err = new Error();
err.code = "forbidden";
return when.reject(err);
}
return storageModule.getLibraryEntry(type, path);
},
saveLibraryEntry: function(type, path, meta, body) {
if (is_malicious(path)) {
var err = new Error();
err.code = "forbidden";
return when.reject(err);
}
return storageModule.saveLibraryEntry(type, path, meta, body);
},
/* Deprecated functions */
getAllFlows: function() {
if (storageModule.hasOwnProperty("getAllFlows")) {
return storageModule.getAllFlows();
} else {
if (libraryFlowsCachedResult) {
return Promise.resolve(libraryFlowsCachedResult);
} else {
return listFlows("/").then(function(result) {
libraryFlowsCachedResult = result;
return result;
});
}
}
2014-07-23 16:15:20 +02:00
},
getFlow: function(fn) {
if (is_malicious(fn)) {
var err = new Error();
err.code = "forbidden";
return when.reject(err);
}
if (storageModule.hasOwnProperty("getFlow")) {
return storageModule.getFlow(fn);
} else {
return storageModule.getLibraryEntry("flows",fn);
}
2014-07-23 16:15:20 +02:00
},
saveFlow: function(fn, data) {
if (is_malicious(fn)) {
var err = new Error();
err.code = "forbidden";
return when.reject(err);
}
libraryFlowsCachedResult = null;
if (storageModule.hasOwnProperty("saveFlow")) {
return storageModule.saveFlow(fn, data);
} else {
return storageModule.saveLibraryEntry("flows",fn,{},data);
}
2014-07-23 16:15:20 +02:00
}
/* End deprecated functions */
2014-07-23 16:15:20 +02:00
}
function listFlows(path) {
return storageModule.getLibraryEntry("flows",path).then(function(res) {
return when.promise(function(resolve) {
var promises = [];
res.forEach(function(r) {
if (typeof r === "string") {
promises.push(listFlows(Path.join(path,r)));
} else {
promises.push(when.resolve(r));
}
});
var i=0;
when.settle(promises).then(function(res2) {
var result = {};
res2.forEach(function(r) {
// TODO: name||fn
if (r.value.fn) {
var name = r.value.name;
if (!name) {
name = r.value.fn.replace(/\.json$/, "");
}
result.f = result.f || [];
result.f.push(name);
} else {
result.d = result.d || {};
result.d[res[i]] = r.value;
//console.log(">",r.value);
}
i++;
});
resolve(result);
});
});
});
}
2014-07-23 16:15:20 +02:00
module.exports = storageModuleInterface;