mirror of
				https://github.com/node-red/node-red.git
				synced 2025-03-01 10:36:34 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			142 lines
		
	
	
		
			6.2 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			142 lines
		
	
	
		
			6.2 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
 | 
						|
<script type="text/x-red" data-template-name="file">
 | 
						|
    <div class="form-row node-input-filename">
 | 
						|
         <label for="node-input-filename"><i class="fa fa-file"></i> <span data-i18n="file.label.filename"></span></label>
 | 
						|
         <input id="node-input-filename" type="text">
 | 
						|
    </div>
 | 
						|
    <div class="form-row">
 | 
						|
        <label for="node-input-overwriteFile"><i class="fa fa-random"></i> <span data-i18n="file.label.action"></span></label>
 | 
						|
        <select type="text" id="node-input-overwriteFile" style="display: inline-block; width: 250px; vertical-align: top;">
 | 
						|
            <option value="false" data-i18n="file.action.append"></option>
 | 
						|
            <option value="true" data-i18n="file.action.overwrite"></option>
 | 
						|
            <option value="delete" data-i18n="file.action.delete"></option>
 | 
						|
        </select>
 | 
						|
    </div>
 | 
						|
    <div class="form-row" id="node-appline">
 | 
						|
        <label> </label>
 | 
						|
        <input type="checkbox" id="node-input-appendNewline" style="display: inline-block; width: auto; vertical-align: top;">
 | 
						|
        <label for="node-input-appendNewline" style="width: 70%;"><span data-i18n="file.label.addnewline"></span></label>
 | 
						|
    </div>
 | 
						|
    <div class="form-row">
 | 
						|
        <label> </label>
 | 
						|
        <input type="checkbox" id="node-input-createDir" style="display: inline-block; width: auto; vertical-align: top;">
 | 
						|
        <label for="node-input-createDir" style="width: 70%;"><span data-i18n="file.label.createdir"></span></label>
 | 
						|
    </div>
 | 
						|
    <div class="form-row">
 | 
						|
        <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="common.label.name"></span></label>
 | 
						|
        <input type="text" id="node-input-name" data-i18n="[placeholder]common.label.name">
 | 
						|
    </div>
 | 
						|
    <div class="form-tips"><span data-i18n="file.tip"></span></div>
 | 
						|
</script>
 | 
						|
 | 
						|
<script type="text/x-red" data-help-name="file">
 | 
						|
    <p>Writes <code>msg.payload</code> to the file specified, for example to create a log.</p>
 | 
						|
    <h3>Inputs</h3>
 | 
						|
    <dl class="message-properties">
 | 
						|
        <dt class="optional">filename <span class="property-type">string</span></dt>
 | 
						|
        <dd>If not configured in the node the filename can be set using the filename property.</dd>
 | 
						|
    </dl>
 | 
						|
    <h3>Details</h3>
 | 
						|
    <p>By default a newline is added to every message. This can be turned off if required, for example,
 | 
						|
    to allow binary files to be written.</p>
 | 
						|
    <p>The default behaviour is to append to the file. This can be changed to overwrite the file
 | 
						|
    each time, for example if you want to output a "static" web page or report.</p>
 | 
						|
    <p>This node can also be configured to delete a file if required.</p>
 | 
						|
</script>
 | 
						|
 | 
						|
<script type="text/x-red" data-template-name="file in">
 | 
						|
    <div class="form-row">
 | 
						|
         <label for="node-input-filename"><i class="fa fa-file"></i> <span data-i18n="file.label.filename"></span></label>
 | 
						|
         <input id="node-input-filename" type="text" data-i18n="[placeholder]file.label.filename">
 | 
						|
    </div>
 | 
						|
    <div class="form-row">
 | 
						|
        <label for="node-input-format"><i class="fa fa-sign-out"></i> <span data-i18n="file.label.outputas"></span></label>
 | 
						|
        <select id="node-input-format">
 | 
						|
            <option value="utf8" data-i18n="file.output.utf8"></option>
 | 
						|
            <option value="" data-i18n="file.output.buffer"></option>
 | 
						|
        </select>
 | 
						|
    </div>
 | 
						|
    <div class="form-row">
 | 
						|
        <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="common.label.name"></span></label>
 | 
						|
        <input type="text" id="node-input-name" data-i18n="[placeholder]common.label.name">
 | 
						|
    </div>
 | 
						|
    <div class="form-tips"><span data-i18n="file.tip"></span></div>
 | 
						|
</script>
 | 
						|
 | 
						|
<script type="text/x-red" data-help-name="file in">
 | 
						|
    <p>Reads the specified file and sends the content as <code>msg.payload</code>,
 | 
						|
    and the filename as <code>msg.filename</code>.</p>
 | 
						|
    <h3>Inputs</h3>
 | 
						|
    <dl class="message-properties">
 | 
						|
        <dt class="optional">filename <span class="property-type">string</span></dt>
 | 
						|
        <dd>if not set in the node configuration the filename to read can be passed in.</dd>
 | 
						|
    </dl>
 | 
						|
    <h3>Outputs</h3>
 | 
						|
    <dl class="message-properties">
 | 
						|
        <dt>payload <span class="property-type">string | buffer</span></dt>
 | 
						|
        <dd>the contents of the file as either a string or binary buffer.</dd>
 | 
						|
        <dt>filename <span class="property-type">string</span></dt>
 | 
						|
        <dd>the filename of the read file.</dd>
 | 
						|
    </dl>
 | 
						|
    <h3>Details</h3>
 | 
						|
    <p>It is advisable to fully specify the required file path and name.
 | 
						|
    On Windows you may need to use \\ to specify the path separator.</p>
 | 
						|
</script>
 | 
						|
 | 
						|
<script type="text/javascript">
 | 
						|
    RED.nodes.registerType('file',{
 | 
						|
        category: 'storage-output',
 | 
						|
        defaults: {
 | 
						|
            name: {value:""},
 | 
						|
            filename: {value:""},
 | 
						|
            appendNewline: {value:true},
 | 
						|
            createDir: {value:false},
 | 
						|
            overwriteFile: {value:"false"}
 | 
						|
        },
 | 
						|
        color:"BurlyWood",
 | 
						|
        inputs:1,
 | 
						|
        outputs:0,
 | 
						|
        icon: "file.png",
 | 
						|
        align: "right",
 | 
						|
        label: function() {
 | 
						|
            if (this.overwriteFile === "delete") {
 | 
						|
                return this.name||this._("file.label.deletelabel",{file:this.filename});
 | 
						|
            } else {
 | 
						|
                return this.name||this.filename||this._("file.label.filelabel");
 | 
						|
            }
 | 
						|
        },
 | 
						|
        labelStyle: function() {
 | 
						|
            return this.name?"node_label_italic":"";
 | 
						|
        },
 | 
						|
        oneditprepare: function() {
 | 
						|
            $("#node-input-overwriteFile").on("change",function() {
 | 
						|
                if (this.value === "delete") { $("#node-appline").hide(); }
 | 
						|
                else { $("#node-appline").show(); }
 | 
						|
            });
 | 
						|
        }
 | 
						|
    });
 | 
						|
 | 
						|
    RED.nodes.registerType('file in',{
 | 
						|
        category: 'storage-input',
 | 
						|
        defaults: {
 | 
						|
            name: {value:""},
 | 
						|
            filename: {value:""},
 | 
						|
            format: {value:"utf8"},
 | 
						|
        },
 | 
						|
        color:"BurlyWood",
 | 
						|
        inputs:1,
 | 
						|
        outputs:1,
 | 
						|
        outputLabels: function(i) {
 | 
						|
            return (this.format === "utf8") ? "UTF8 string" : "binary buffer";
 | 
						|
        },
 | 
						|
        icon: "file.png",
 | 
						|
        label: function() {
 | 
						|
            return this.name||this.filename||this._("file.label.filelabel");
 | 
						|
        },
 | 
						|
        labelStyle: function() {
 | 
						|
            return this.name?"node_label_italic":"";
 | 
						|
        }
 | 
						|
    });
 | 
						|
 | 
						|
</script>
 |