node-red-sftpco.html

<!-- CREDENTIALS -->

<script type="text/html" data-template-name="SFTP-credentials">
	<div class="form-row">
        <label for="node-config-input-host"><i class="fa fa-globe"></i> Host</label>
        <input type="text" id="node-config-input-host">
    </div>
	<div class="form-row">
        <label for="node-config-input-port"><i class="fa fa-globe"></i> Port</label>
        <input type="text" id="node-config-input-port">
    </div>
    <div class="form-row">
        <label for="node-config-input-username"><i class="fa fa-user"></i> Username</label>
        <input type="text" id="node-config-input-username">
    </div>
    <div class="form-row">
        <label for="node-config-input-password"><i class="fa fa-user"></i> Password</label>
        <input type="password" id="node-config-input-password">
    </div>
</script>

<script type="text/javascript">
    RED.nodes.registerType('SFTP-credentials',{
        category: 'config',
        defaults: {
            host:     { value:"127.0.0.1" },
            port:     { value:"22" },
            username:     { value:"" },
            password:  { value:"" }
        },
        label: function() {
            return this.username+"@"+this.host || "";
        }
    });

	
    RED.nodes.registerType('SFTP-main',{
        category: 'storage',
        color:    '#E9967A',
		paletteLabel: "SFTP",
        defaults: {
            path:  { value:"/" },
            method:  { value:"" },
            remoteFilePath:  { 
                value:"", 
                validate: () => {
                    if($("#node-input-remoteFilePath").parent().is(':hidden')) return true
                    return RED.validators.typedInput("remoteFilePathType")
                }
            },  
            remoteFilePathType: { value:"msg" },
            localFilePath:   { 
                value:"", 
                validate: () => {
                    if($("#node-input-localFilePath").parent().is(':hidden')) return true
                    return RED.validators.typedInput("localFilePathType")
                }
            },
            
            localFilePathType: { value:"msg" },
            server:  { type:"SFTP-credentials", required:true },
            outputs: {value:1},
            debug: {value:false},
            name: {value:""}
        },
        inputs:  1,
        outputs: 1,
        outputLabels: [null,'debug output'],
        icon: "white-globe.png",
        label: function() {
            return this.name || this.server.host || "SFTP";
        },
		oneditprepare: function() {

            $("#node-input-remoteFilePath").typedInput({
                default:this.remoteFilePathType||'msg',
                types:['msg','flow','global','str','jsonata','env'],
                typeField: $("#node-input-remoteFilePathType")})

            $("#node-input-localFilePath").typedInput({
                default:this.localFilePathType||'msg',
                types:['msg','flow','global','str','jsonata','env'],
                typeField: $("#node-input-localFilePathType")})

			$("#node-input-method").change(function() {
                $("#node-input-remoteFilePath").parent().hide();
                $("#node-input-localFilePath").parent().hide();
                $("#node-input-debug").parent().show();

                if ($("#node-input-method").val() === "list") {
                    $("#node-input-remoteFilePath").parent().show();
                } else if ($("#node-input-method").val() === "get") {
                    $("#node-input-remoteFilePath").parent().show();
                    $("#node-input-localFilePath").parent().show();
                } else if ($("#node-input-method").val() === "put") {
                    $("#node-input-remoteFilePath").parent().show();
                    $("#node-input-localFilePath").parent().show();
                } else if ($("#node-input-method").val() === "delete") {
                    $("#node-input-remoteFilePath").parent().show();
                }

            });
        },
        oneditsave: function() { 
            this.remoteFilePathType = $("#node-input-remoteFilePathType").val()
            this.localFilePathType = $("#node-input-localFilePathType").val()               
            if ($("#node-input-debug").is(':checked')) {
                this.outputs = 2
            } else {
                this.outputs = 1
            }
        }
    });
</script>

<script type="text/html" data-template-name="SFTP-main">
    <div class="form-row">
        <label for="node-input-server"><i class="fa fa-globe"></i> Server</label>
        <input type="text" id="node-input-server">
    </div>
	
	<div class="form-row">
        <label for="node-input-method"><i class="fa fa-rss"></i> Method</label>
        <select id="node-input-method" >
            <option value='list'>List</option>
            <option value='get'>Get</option>
            <option value='put'>Put</option>
            <option value='delete'>Delete</option>
        </select>
    </div>

    <div class="form-row">
        <label for="node-input-remoteFilePath"><i class="fa fa-dot-circle-o"></i> Remote Path</label>
        <input type="text" id="node-input-remoteFilePath" placeholder="Remote File Path">
        <input type="hidden" id="node-input-remoteFilePathType">
    </div>

    <div class="form-row">
        <label for="node-input-localFilePath"><i class="fa fa-folder-open"></i> Local Path</label>
        <input type="text" id="node-input-localFilePath" placeholder="Local File Path">
        <input type="hidden" id="node-input-localFilePathType">
    </div>

    <div class="form-row">
        <label for="node-input-debug">&nbsp;</label>        
         <input type="checkbox" id="node-input-debug" style="display: inline-block; width: auto; vertical-align: top;">
         <label for="node-input-debug" style="width: auto"><i class="fa fa-bug"></i> Activate second output for debug</label>
    </div>

    <div class="form-row">
        <label for="node-input-name"><i class="fa fa-tag"></i> <span>Name</span></label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>

</script>

<script type="text/html" data-help-name="SFTP-main">
<p>An SFTP client for node-red, a wrapper for <a href="https://github.com/jyu213/ssh2-sftp-client">ssh2-sftp-client</a></p>

<dt>server
        <span class="property-type">string</span>
</dt>
<dd>the name of the file, with extension</dd> 
<dt>method
        <span class="property-type">string</span>
</dt>
<dd>the name of the file, with extension</dd> 
<dt>remoteFilePath
        <span class="property-type">string</span>
</dt>
<dd>the name of the file, with extension</dd> 
<dt>localFilePath
        <span class="property-type">string</span>
</dt>
<dd>the name of the file, with extension</dd> 
<dt>debug
        <span class="property-type">string</span>
</dt>
<dd>the name of the file, with extension</dd> 


<p>Retrieves a directory listing.</p>
<pre><code>sftp.list(remoteFilePath)
</code></pre>
<p>directory info:</p>
<pre><code>type: // file type(-, d, l)
name: // file name
size: // file size
modifyTime: // file timestamp of modified time
accessTime: // file timestamp of access time
rights: {
    user:
    group:
    other:
},
owner: // user ID
group: // group ID
</code></pre>
<h3><a id="user-content-get" class="anchor" href="https://github.com/jyu213/ssh2-sftp-client#get" aria-hidden="true"></a>Get</h3>
<p>get a new readable stream for path. The encoding is passed to Node Stream (<a href="https://nodejs.org/api/stream.html" rel="nofollow">https://nodejs.org/api/stream.html</a>) and it controls how the content is encoded. For example, when downloading binary data, 'null' should be passed (check node stream documentation). Defaults to 'utf8'.</p>
<pre><code>sftp.get(remoteFilePath, [useCompression], [encoding], [addtionalOptions]);
</code></pre>
<h3><a id="user-content-put" class="anchor" href="https://github.com/jyu213/ssh2-sftp-client#put" aria-hidden="true"></a>Put</h3>
<p>upload a file. it can be <code>localPath</code> or <code>Buffer</code> or <code>Stream</code>.</p>
<pre><code>sftp.put(localFilePath, remoteFilePath, [useCompression], [encoding], [addtionalOptions]);
sftp.put(Buffer, remoteFilePath, [useCompression], [encoding], [addtionalOptions]);
sftp.put(Stream, remoteFilePath, [useCompression], [encoding], [addtionalOptions]);
</code></pre>
<h3><a id="user-content-mkdir" class="anchor" href="https://github.com/jyu213/ssh2-sftp-client#mkdir" aria-hidden="true"></a>Mkdir</h3>
<p>create a new directory.</p>
<pre><code>// recursive default is false, if true, it will create directory recursive
sftp.mkdir(remoteFilePath, recursive);
</code></pre>
<h3><a id="user-content-rmdir" class="anchor" href="https://github.com/jyu213/ssh2-sftp-client#rmdir" aria-hidden="true"></a>Rmdir</h3>
<p>remove the directory or file.</p>
<pre><code>// recursive default is false, if true, it will remove directory recursive even if is not empty
sftp.rmdir(localPath, recursive);
</code></pre>
<h3><a id="user-content-delete" class="anchor" href="https://github.com/jyu213/ssh2-sftp-client#delete" aria-hidden="true"></a>Delete</h3>
<p>delete file.</p>
<pre><code>sftp.delete(remoteFilePath);
</code></pre>
<h3><a id="user-content-rename" class="anchor" href="https://github.com/jyu213/ssh2-sftp-client#rename" aria-hidden="true"></a>Rename</h3>
<p>rename remoteSourcePath to remoteDestPath (removes remoteSourcePath).</p>
<pre><code>sftp.rename(remoteSourcePath, remoteDestPath);
</code></pre>
<h3><a id="user-content-chmod" class="anchor" href="https://github.com/jyu213/ssh2-sftp-client#chmod" aria-hidden="true"></a>Chmod</h3>
<p>modify rights to remoteDestPath file</p>
<pre><code>sftp.chmod(remoteDestPath, mode);
</code></pre>

</script>