Skip to content

Latest commit

 

History

History
133 lines (114 loc) · 5.77 KB

README.md

File metadata and controls

133 lines (114 loc) · 5.77 KB
Raw

SFTP Upload/Download Plugin

Cordova plugin to Download and Upload files from a SFTP server.

This plugin is build on top of:

  • JSch library for Android.
  • NMSSH framework for iOS.

Contributors are welcome.

Platforms supported

  • Android
  • iOS (Partial)

Installation

cordova plugin add cordova-sftp-plugin

Easy Use

There is a base Object JJsftp expose in window that should be initialized with the host, user and password for the server

var mySftp = new JJsftp("host", "user", "password");

Methods

  • download(serverPath, localPath [, createIfNotExists, successCallback, errorCallback]) Allow to download a single file.
    • serverPath - Path/To/File/In/Server
    • localPath - Path/To/File/In/Device
    • createIfNotExists - Create the folder path if not exist
    • successCallback - Function to call in plugin success
    • errorCallback - Function to call in plugin error
  • downloadList(list [, successCallback, errorCallback]) Allow to download a list of files
    • list - Object array of files, has the follow attributes:
      • remote - Path/To/File/In/Server
      • local - Local/Path/To/File
      • [create] - default to: false - Create the folder path if not exist
    • successCallback - Function to call in plugin success
    • errorCallback - Function to call in plugin error
  • upload(serverPath, localPath [, successCallback, errorCallback]) Allow to download a single file.
    • serverPath - Path/To/File/In/Server
    • localPath - Path/To/File/In/Device
    • successCallback - Function to call in plugin success
    • errorCallback - Function to call in plugin error
  • uploadList(list [, successCallback, errorCallback]) Allow to download a list of files
    • list - Object array of files, has the follow attributes
      • remote - Path/To/File/In/Server
      • local - Local/Path/To/Fil
    • successCallback - Function to call in plugin success
    • errorCallback - Function to call in plugin error
  • cancel([successCallback, errorCallback]) Allow to cancel the asyn process that make the connection
    • successCallback - Function to call in plugin success
    • errorCallback - Function to call in plugin error
Important

Every callback (success or error) will response for the action of add the elements downloads/upload list, if you wanna know when a file or all the files are donwloaded, you should listen to the events fires over document.

Events

There are several events that fire during the process, all of it give one arg, the cordova event with few extra attributes

  • SFTPActionConnected
    • Desc: Fire on sftp channel connect
    • Extra event attributes: none
  • SFTPActionStart
    • Desc: Fire when an action is about to start in a file
    • Extra event attributes:
      • from- string : Path of the source
      • to - string : Path of the target
      • size - long : Size of the element
  • SFTPActionProgress
    • Desc: fire to inform the % of down/up load in the ACTUAL file
    • Extra event attributes:
      • percent - int : % of actual file progress
  • SFTPActionEnd
    • Desc: fire whe the ACTUAL action over a file end
    • Extra event attributes: none
  • SFTPActionListProgress
    • Desc: Fire after an action (Up/Down) is executed over a file, giving the actual file (index in list) and total files in list
    • Extra event attributes:
      • progress - int : Actual element index in list
      • total - int : Total count of elements in list
  • SFTPActionListEnd
    • Desc: Fire at end of action list to inform the # of file rech it
    • Extra event attributes:
      • all - boolean : true if all action were made it
  • SFTPActionDisconnected
    • Desc: Fire on sftp channel disconnect
    • Extra event attributes: none
  • SFTPActionCancell
    • Desc: Fire on cancel async action
    • Extra event attributes: none

Use Example

To Download

var sftp        = new JJsftp("host", "user", "password"),
    localPath   = "String/Path/To/Place/The/Download"
    filelist    = [{
          remote    : "/Path/To/Remote/File.*"
        , local     : localPath+"file.*"
    },{
          remote    : "/Path/To/Another/Remote/File.*"
        , local     : localPath+"anotherFile.*"
    }];

    sftp.downloadList(filelist, function(data){
        /* Wow everything goes good, but just in case verify data.success */
    }, function(error){
        /* Wow something goes wrong, check the error.message */       
    });

To Upload is the same but calling upload or uploadList and by default will override a file if exists in server

Of course if you want, you could add any of the JJsftp events to document and listen the progress of the download by example

#### Know Issues

  • upload does not work on iOS (Yet)
  • cancel does not work on iOS (Yet), therefore SFTPActionCancell is never trigger.

There is a big TODO list, but in resume

  • Bug Resolve =>
    • No Connection Break The App (Should The plugin warning the user or just don't do anything)
    • Only receive the absolute platfomr path (Without file://), should be replace in plugin don't force the user to replace it
    • Events just send a simple string object, need to be parse by user, should be the as many as need witouth the need to parse it
  • Write a better documentation
  • Propose new utils features (I think maybe in a fetch directory will be util) without lose the perspective of the plugin (Upload - Download via SFTP)
  • Add iOS Support (Be Patient) (Partial done, download now available)
  • Improve Uploading and Downloading feature