Java tutorial
/* Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you 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. */ package io.github.xfally.cordova.plugin.ftp; import org.apache.cordova.CordovaPlugin; import org.apache.cordova.CallbackContext; import org.apache.cordova.PluginResult; import org.json.JSONArray; import org.json.JSONException; import org.json.JSONObject; import java.io.File; import java.io.FileInputStream; import java.io.InputStream; import java.text.SimpleDateFormat; import java.util.Date; import android.util.Log; import it.sauronsoftware.ftp4j.FTPClient; import it.sauronsoftware.ftp4j.FTPDataTransferListener; import it.sauronsoftware.ftp4j.FTPFile; public class CDVFtp extends CordovaPlugin { public static final String TAG = CDVFtp.class.getSimpleName(); private String rootPath = "/"; private FTPClient client = null; @Override public boolean execute(String action, final JSONArray args, final CallbackContext callbackContext) throws JSONException { if (action.equals("connect")) { cordova.getThreadPool().execute(new Runnable() { public void run() { try { connect(args.getString(0), args.getString(1), args.getString(2), callbackContext); } catch (Exception e) { callbackContext.error(e.toString()); } } }); } else if (action.equals("list")) { cordova.getThreadPool().execute(new Runnable() { public void run() { try { list(args.getString(0), callbackContext); } catch (Exception e) { callbackContext.error(e.toString()); } } }); } else if (action.equals("createDirectory")) { cordova.getThreadPool().execute(new Runnable() { public void run() { try { createDirectory(args.getString(0), callbackContext); } catch (Exception e) { callbackContext.error(e.toString()); } } }); } else if (action.equals("deleteDirectory")) { cordova.getThreadPool().execute(new Runnable() { public void run() { try { deleteDirectory(args.getString(0), callbackContext); } catch (Exception e) { callbackContext.error(e.toString()); } } }); } else if (action.equals("deleteFile")) { cordova.getThreadPool().execute(new Runnable() { public void run() { try { deleteFile(args.getString(0), callbackContext); } catch (Exception e) { callbackContext.error(e.toString()); } } }); } else if (action.equals("uploadFile")) { cordova.getThreadPool().execute(new Runnable() { public void run() { try { uploadFile(args.getString(0), args.getString(1), callbackContext); } catch (Exception e) { callbackContext.error(e.toString()); } } }); } else if (action.equals("downloadFile")) { cordova.getThreadPool().execute(new Runnable() { public void run() { try { downloadFile(args.getString(0), args.getString(1), callbackContext); } catch (Exception e) { callbackContext.error(e.toString()); } } }); } else if (action.equals("cancelAllRequests")) { cordova.getThreadPool().execute(new Runnable() { public void run() { try { cancelAllRequests(callbackContext); } catch (Exception e) { callbackContext.error(e.toString()); } } }); } else { // This action/cmd is not found/supported return false; } // This action/cmd is found/supported return true; } private void connect(String hostname, String username, String password, CallbackContext callbackContext) { if (hostname == null || hostname.length() <= 0) { callbackContext.error("Expected hostname."); } else { if (username == null && password == null) { username = "anonymous"; password = "anonymous@"; } try { this.client = new FTPClient(); this.client.connect(hostname); this.client.login(username, password); callbackContext.success("Connect and login ok."); } catch (Exception e) { callbackContext.error(e.toString()); } } } private void list(String path, CallbackContext callbackContext) { if (path == null) { callbackContext.error("Expected path."); } else { if (!path.endsWith("/")) { path = path.concat("/"); } try { this.client.changeDirectory(path); FTPFile[] list = client.list(); JSONArray fileList = new JSONArray(); for (FTPFile file : list) { String name = file.getName(); Number type = file.getType(); String link = file.getLink(); Number size = file.getSize(); Date modifiedDate = file.getModifiedDate(); String modifiedDateString = (new SimpleDateFormat("yyyy-MM-dd HH:mm:ss zzz")) .format(modifiedDate); String jsonStr = "{" + "name:\"" + name + "\",type:" + type + ",link:\"" + link + "\",size:" + size + ",modifiedDate:\"" + modifiedDateString + "\"}"; JSONObject jsonObj = new JSONObject(jsonStr); fileList.put(jsonObj); } callbackContext.success(fileList); } catch (Exception e) { callbackContext.error(e.toString()); } } } private void createDirectory(String path, CallbackContext callbackContext) { if (path == null) { callbackContext.error("Expected path."); } else { if (!path.endsWith("/")) { path = path.concat("/"); } try { this.client.changeDirectory(this.rootPath); this.client.createDirectory(path); callbackContext.success("Create directory OK"); } catch (Exception e) { callbackContext.error(e.toString()); } } } private void deleteDirectory(String path, CallbackContext callbackContext) { if (path == null) { callbackContext.error("Expected path."); } else { if (!path.endsWith("/")) { path = path.concat("/"); } try { this.client.changeDirectory(this.rootPath); this.client.deleteDirectory(path); callbackContext.success("Delete directory OK"); } catch (Exception e) { callbackContext.error(e.toString()); } } } private void deleteFile(String file, CallbackContext callbackContext) { if (file == null) { callbackContext.error("Expected file."); } else { try { this.client.changeDirectory(this.rootPath); this.client.deleteFile(file); callbackContext.success("Delete file OK"); } catch (Exception e) { callbackContext.error(e.toString()); } } } private void uploadFile(String localFile, String remoteFile, CallbackContext callbackContext) { if (localFile == null || remoteFile == null) { callbackContext.error("Expected localFile and remoteFile."); } else { try { String remoteFilePath = remoteFile.substring(0, remoteFile.lastIndexOf('/') + 1); String remoteFileName = remoteFile.substring(remoteFile.lastIndexOf('/') + 1); String localFilePath = localFile.substring(0, localFile.lastIndexOf('/') + 1); String localFileName = localFile.substring(localFile.lastIndexOf('/') + 1); this.client.changeDirectory(remoteFilePath); File file = new File(localFile); InputStream in = new FileInputStream(file); long size = file.length(); client.upload(remoteFileName, in, 0, 0, new CDVFtpTransferListener(size, callbackContext)); // refer to CDVFtpTransferListener for transfer percent and completed } catch (Exception e) { callbackContext.error(e.toString()); } } } private void downloadFile(String localFile, String remoteFile, CallbackContext callbackContext) { if (localFile == null || remoteFile == null) { callbackContext.error("Expected localFile and remoteFile."); } else { try { String remoteFilePath = remoteFile.substring(0, remoteFile.lastIndexOf('/') + 1); String remoteFileName = remoteFile.substring(remoteFile.lastIndexOf('/') + 1); this.client.changeDirectory(remoteFilePath); FTPFile[] list = client.list(); JSONArray fileList = new JSONArray(); for (FTPFile file : list) { String name = file.getName(); //Number type = file.getType(); //String link = file.getLink(); Number size = file.getSize(); if (remoteFileName.equals(name)) { client.download(remoteFileName, new File(localFile), new CDVFtpTransferListener(size.longValue(), callbackContext)); // refer to CDVFtpTransferListener for transfer percent and completed return; } } // should never reach here! } catch (Exception e) { callbackContext.error(e.toString()); } } } private void cancelAllRequests(CallbackContext callbackContext) { try { this.client.abortCurrentDataTransfer(true); callbackContext.success("Cancel request OK"); } catch (Exception e) { callbackContext.error(e.toString()); } } } class CDVFtpTransferListener implements FTPDataTransferListener { public static final String TAG = CDVFtpTransferListener.class.getSimpleName(); private long totalSize = 0; private long curSize = 0; private CallbackContext callbackContext = null; private PluginResult pluginResult = null; public CDVFtpTransferListener(long size, CallbackContext callbackContext) { this.totalSize = size; this.callbackContext = callbackContext; } public void started() { // Transfer started Log.i(TAG, "Transfer started"); this.curSize = 0; } public void transferred(int length) { // Yet other length bytes has been transferred since the last time this // method was called this.curSize += length; float percent = (float) this.curSize / (float) this.totalSize; Log.d(TAG, "Transferred, totalSize=" + this.totalSize + ", curSize=" + this.curSize + ", percent=" + percent); // Tip: just return if percent < 1, to prevent js:successCallback() invoked twice, as completed() will also return 1. if (percent >= 0 && percent < 1) { this.pluginResult = new PluginResult(PluginResult.Status.OK, percent); this.pluginResult.setKeepCallback(true); this.callbackContext.sendPluginResult(this.pluginResult); } } public void completed() { // Transfer completed Log.i(TAG, "Transfer completed"); this.pluginResult = new PluginResult(PluginResult.Status.OK, 1); this.pluginResult.setKeepCallback(false); this.callbackContext.sendPluginResult(this.pluginResult); } public void aborted() { // Transfer aborted Log.w(TAG, "Transfer aborted"); this.pluginResult = new PluginResult(PluginResult.Status.NO_RESULT); this.pluginResult.setKeepCallback(false); this.callbackContext.sendPluginResult(this.pluginResult); } public void failed() { // Transfer failed Log.e(TAG, "Transfer failed"); this.pluginResult = new PluginResult(PluginResult.Status.ERROR); this.pluginResult.setKeepCallback(false); this.callbackContext.sendPluginResult(this.pluginResult); } }