1
0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00
node-red/red/runtime/nodes/context/localfilesystem.js

273 lines
9.0 KiB
JavaScript
Raw Normal View History

2018-03-15 21:52:17 +01:00
/**
* 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.
**/
2018-07-02 23:32:20 +02:00
/**
* Local file-system based context storage
*
* Configuration options:
* {
* base: "contexts", // the base directory to use
* // default: "contexts"
* dir: "/path/to/storage", // the directory to create the base directory in
* // default: settings.userDir
* cache: true // whether to cache contents in memory
* // default: true
* }
*
*
* $HOME/.node-red/contexts
* global
* global_context.json
* <id of Flow 1>
* flow_context.json
* <id of Node a>.json
* <id of Node b>.json
* <id of Flow 2>
* flow_context.json
* <id of Node x>.json
* <id of Node y>.json
*/
2018-03-15 21:52:17 +01:00
var fs = require('fs-extra');
var path = require("path");
2018-06-07 13:17:51 +02:00
var util = require("../../util");
2018-03-15 21:52:17 +01:00
2018-07-02 23:32:20 +02:00
var MemoryStore = require("./memory");
2018-06-07 13:17:51 +02:00
function getStoragePath(storageBaseDir, scope) {
2018-05-30 03:24:27 +02:00
if(scope.indexOf(":") === -1){
if(scope === "global"){
2018-06-08 12:26:07 +02:00
return path.join(storageBaseDir,"global",scope);
}else{ // scope:flow
2018-06-07 13:17:51 +02:00
return path.join(storageBaseDir,scope,"flow");
}
}else{ // scope:local
var ids = scope.split(":")
2018-06-07 13:17:51 +02:00
return path.join(storageBaseDir,ids[1],ids[0]);
}
2018-03-15 21:52:17 +01:00
}
2018-06-07 13:17:51 +02:00
function getBasePath(config) {
var base = config.base || "contexts";
var storageBaseDir;
if (!config.dir) {
if(config.settings && config.settings.userDir){
storageBaseDir = path.join(config.settings.userDir, base);
}else{
try {
fs.statSync(path.join(process.env.NODE_RED_HOME,".config.json"));
storageBaseDir = path.join(process.env.NODE_RED_HOME, base);
} catch(err) {
2018-03-15 21:52:17 +01:00
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", base);
}
} catch(err) {
}
if (!storageBaseDir) {
storageBaseDir = path.join(process.env.HOME || process.env.USERPROFILE || process.env.HOMEPATH || process.env.NODE_RED_HOME,".node-red", base);
2018-03-15 21:52:17 +01:00
}
}
2018-03-15 21:52:17 +01:00
}
}else{
storageBaseDir = path.join(config.dir, base);
}
return storageBaseDir;
}
2018-03-15 21:52:17 +01:00
2018-06-07 13:17:51 +02:00
function loadFile(storagePath){
return fs.pathExists(storagePath).then(function(exists){
if(exists === true){
return fs.readFile(storagePath, "utf8");
}else{
2018-06-20 12:50:55 +02:00
return Promise.resolve(undefined);
2018-06-07 13:17:51 +02:00
}
}).catch(function(err){
2018-06-20 12:50:55 +02:00
throw Promise.reject(err);
2018-06-07 13:17:51 +02:00
});
}
function LocalFileSystem(config){
this.config = config;
2018-06-07 13:17:51 +02:00
this.storageBaseDir = getBasePath(this.config);
2018-07-02 23:32:20 +02:00
if (config.hasOwnProperty('cache')?config.cache:true) {
this.cache = MemoryStore({});
}
}
2018-05-30 03:24:27 +02:00
LocalFileSystem.prototype.open = function(){
2018-07-02 23:32:20 +02:00
var self = this;
if (this.cache) {
var scopes = [];
var promises = [];
var subdirs = [];
var subdirPromises = [];
return fs.readdir(self.storageBaseDir).then(function(dirs){
dirs.forEach(function(fn) {
var p = getStoragePath(self.storageBaseDir ,fn)+".json";
scopes.push(fn);
promises.push(loadFile(p));
subdirs.push(path.join(self.storageBaseDir,fn));
subdirPromises.push(fs.readdir(path.join(self.storageBaseDir,fn)));
})
return Promise.all(subdirPromises);
}).then(function(dirs) {
dirs.forEach(function(files,i) {
files.forEach(function(fn) {
if (fn !== 'flow.json' && fn !== 'global.json') {
scopes.push(fn.substring(0,fn.length-5)+":"+scopes[i]);
promises.push(loadFile(path.join(subdirs[i],fn)))
}
});
})
return Promise.all(promises);
}).then(function(res) {
scopes.forEach(function(scope,i) {
var data = res[i]?JSON.parse(res[i]):{};
Object.keys(data).forEach(function(key) {
self.cache.set(scope,key,data[key]);
})
});
}).catch(function(err){
if(err.code == 'ENOENT') {
return fs.ensureDir(self.storageBaseDir);
}else{
return Promise.reject(err);
}
});
2018-07-02 23:32:20 +02:00
} else {
return Promise.resolve();
}
2018-05-30 03:24:27 +02:00
}
LocalFileSystem.prototype.close = function(){
2018-06-20 12:50:55 +02:00
return Promise.resolve();
2018-05-30 03:24:27 +02:00
}
LocalFileSystem.prototype.get = function(scope, key, callback) {
2018-07-02 23:32:20 +02:00
if (this.cache) {
return this.cache.get(scope,key,callback);
}
if(typeof callback !== "function"){
throw new Error("Callback must be a function");
}
2018-06-07 13:17:51 +02:00
var storagePath = getStoragePath(this.storageBaseDir ,scope);
loadFile(storagePath + ".json").then(function(data){
2018-06-07 13:17:51 +02:00
if(data){
callback(null, util.getMessageProperty(JSON.parse(data),key));
}else{
callback(null, undefined);
2018-03-15 21:52:17 +01:00
}
2018-06-07 13:17:51 +02:00
}).catch(function(err){
callback(err);
2018-06-07 13:17:51 +02:00
});
};
2018-07-02 23:32:20 +02:00
LocalFileSystem.prototype._set = function(scope, key, value, callback) {
2018-06-07 13:17:51 +02:00
var storagePath = getStoragePath(this.storageBaseDir ,scope);
loadFile(storagePath + ".json").then(function(data){
2018-06-07 13:17:51 +02:00
var obj = data ? JSON.parse(data) : {}
util.setMessageProperty(obj,key,value);
return fs.outputFile(storagePath + ".json", JSON.stringify(obj, undefined, 4), "utf8");
}).then(function(){
if(typeof callback === "function"){
callback(null);
}
2018-06-07 13:17:51 +02:00
}).catch(function(err){
if(typeof callback === "function"){
callback(err);
}
2018-06-07 13:17:51 +02:00
});
2018-07-02 23:32:20 +02:00
}
LocalFileSystem.prototype.set = function(scope, key, value, callback) {
if (this.cache) {
this.cache.set(scope,key,value,callback);
// With cache enabled, no need to re-read the file prior to writing.
var newContext = this.cache._export()[scope];
var storagePath = getStoragePath(this.storageBaseDir ,scope);
fs.outputFile(storagePath + ".json", JSON.stringify(newContext, undefined, 4), "utf8").catch(function(err) {
2018-07-02 23:32:20 +02:00
});
} else {
this._set(scope,key,value,callback);
}
};
LocalFileSystem.prototype.keys = function(scope, callback){
2018-07-02 23:32:20 +02:00
if (this.cache) {
return this.cache.keys(scope,callback);
}
if(typeof callback !== "function"){
throw new Error("Callback must be a function");
}
2018-06-07 13:17:51 +02:00
var storagePath = getStoragePath(this.storageBaseDir ,scope);
loadFile(storagePath + ".json").then(function(data){
2018-06-07 13:17:51 +02:00
if(data){
callback(null, Object.keys(JSON.parse(data)));
2018-06-07 13:17:51 +02:00
}else{
callback(null, []);
2018-06-07 13:17:51 +02:00
}
}).catch(function(err){
callback(err);
2018-06-07 13:17:51 +02:00
});
};
LocalFileSystem.prototype.delete = function(scope){
2018-07-02 23:32:20 +02:00
var cachePromise;
if (this.cache) {
cachePromise = this.cache.delete(scope);
} else {
cachePromise = Promise.resolve();
}
var that = this;
return cachePromise.then(function() {
var storagePath = getStoragePath(that.storageBaseDir,scope);
return fs.remove(storagePath + ".json");
});
}
LocalFileSystem.prototype.clean = function(activeNodes){
var self = this;
2018-07-02 23:32:20 +02:00
var cachePromise;
if (this.cache) {
cachePromise = this.cache.clean(activeNodes);
} else {
cachePromise = Promise.resolve();
}
return cachePromise.then(function() {
return fs.readdir(self.storageBaseDir).then(function(dirs){
return Promise.all(dirs.reduce(function(result, item){
if(item !== "global" && activeNodes.indexOf(item) === -1){
result.push(fs.remove(path.join(self.storageBaseDir,item)));
}
return result;
},[]));
}).catch(function(err){
if(err.code == 'ENOENT') {
return Promise.resolve();
}else{
return Promise.reject(err);
}
2018-07-02 23:32:20 +02:00
});
});
2018-06-08 12:26:07 +02:00
}
module.exports = function(config){
return new LocalFileSystem(config);
2018-03-15 21:52:17 +01:00
};