Merge pull request #2932 from node-red/file-cwd-setting

File node: Add fileWorkingDirectory to customise how relative paths are resolved
This commit is contained in:
Nick O'Leary
2021-04-27 10:49:02 +01:00
committed by GitHub
3 changed files with 75 additions and 10 deletions

View File

@@ -51,6 +51,10 @@ module.exports = function(RED) {
function processMsg(msg,nodeSend, done) {
var filename = node.filename || msg.filename || "";
var fullFilename = filename;
if (filename && RED.settings.fileWorkingDirectory && !path.isAbsolute(filename)) {
fullFilename = path.resolve(path.join(RED.settings.fileWorkingDirectory,filename));
}
if ((!node.filename) && (!node.tout)) {
node.tout = setTimeout(function() {
node.status({fill:"grey",shape:"dot",text:filename});
@@ -62,7 +66,7 @@ module.exports = function(RED) {
node.warn(RED._("file.errors.nofilename"));
done();
} else if (node.overwriteFile === "delete") {
fs.unlink(filename, function (err) {
fs.unlink(fullFilename, function (err) {
if (err) {
node.error(RED._("file.errors.deletefail",{error:err.toString()}),msg);
} else {
@@ -74,7 +78,7 @@ module.exports = function(RED) {
done();
});
} else if (msg.hasOwnProperty("payload") && (typeof msg.payload !== "undefined")) {
var dir = path.dirname(filename);
var dir = path.dirname(fullFilename);
if (node.createDir) {
try {
fs.ensureDirSync(dir);
@@ -94,7 +98,7 @@ module.exports = function(RED) {
if ((node.appendNewline) && (!Buffer.isBuffer(data))) { data += os.EOL; }
var buf = encode(data, node.encoding);
if (node.overwriteFile === "true") {
var wstream = fs.createWriteStream(filename, { encoding:'binary', flags:'w', autoClose:true });
var wstream = fs.createWriteStream(fullFilename, { encoding:'binary', flags:'w', autoClose:true });
node.wstream = wstream;
wstream.on("error", function(err) {
node.error(RED._("file.errors.writefail",{error:err.toString()}),msg);
@@ -116,7 +120,7 @@ module.exports = function(RED) {
// of the file. Check the file hasn't been deleted
// or deleted and recreated.
try {
var stat = fs.statSync(filename);
var stat = fs.statSync(fullFilename);
// File exists - check the inode matches
if (stat.ino !== node.wstreamIno) {
// The file has been recreated. Close the current
@@ -135,10 +139,10 @@ module.exports = function(RED) {
}
}
if (recreateStream) {
node.wstream = fs.createWriteStream(filename, { encoding:'binary', flags:'a', autoClose:true });
node.wstream = fs.createWriteStream(fullFilename, { encoding:'binary', flags:'a', autoClose:true });
node.wstream.on("open", function(fd) {
try {
var stat = fs.statSync(filename);
var stat = fs.statSync(fullFilename);
node.wstreamIno = stat.ino;
} catch(err) {
}
@@ -258,6 +262,10 @@ module.exports = function(RED) {
this.on("input",function(msg, nodeSend, nodeDone) {
var filename = (node.filename || msg.filename || "").replace(/\t|\r|\n/g,'');
var fullFilename = filename;
if (filename && RED.settings.fileWorkingDirectory && !path.isAbsolute(filename)) {
fullFilename = path.resolve(path.join(RED.settings.fileWorkingDirectory,filename));
}
if (!node.filename) {
node.status({fill:"grey",shape:"dot",text:filename});
}
@@ -279,7 +287,7 @@ module.exports = function(RED) {
var hwm;
var getout = false;
var rs = fs.createReadStream(filename)
var rs = fs.createReadStream(fullFilename)
.on('readable', function () {
var chunk;
var hwm = rs._readableState.highWaterMark;

View File

@@ -53,6 +53,10 @@ module.exports = {
// defaults to 10Mb
//execMaxBufferSize: 10000000,
// The working directory to handle relative file paths from within the File nodes
// defaults to the working directory of the Node-RED process.
//fileWorkingDirectory: "",
// The maximum length, in characters, of any message sent to the debug sidebar tab
debugMaxLength: 1000,