Skip to content

Added progress callback for uploadFile #466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Added progress callback for uploadFile #466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
81eafaf
Added progress callback for uploadFile
brunolau Apr 6, 2022
07004af
Merge branch 'silkimen:master' into uploadfile-progress
brunolau Dec 20, 2022
b39230f
Lambda removed
brunolau Dec 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,8 @@ cordova.plugin.http.uploadFile("https://google.com/", {
console.log(response.status);
}, function(response) {
console.error(response.error);
}, function(progressData) {
console.log((progressData.transferred / progressData.total * 100) + ' percent complete')
});
```

Expand Down
3 changes: 2 additions & 1 deletion src/android/com/silkimen/cordovahttp/CordovaHttpPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,11 +164,12 @@ private boolean uploadFiles(final JSONArray args, final CallbackContext callback
boolean followRedirect = args.getBoolean(6);
String responseType = args.getString(7);
Integer reqId = args.getInt(8);
boolean hasProgressCallback = args.getBoolean(9);

CordovaObservableCallbackContext observableCallbackContext = new CordovaObservableCallbackContext(callbackContext, reqId);

CordovaHttpUpload upload = new CordovaHttpUpload(url, headers, filePaths, uploadNames, connectTimeout, readTimeout, followRedirect,
responseType, this.tlsConfiguration, this.cordova.getActivity().getApplicationContext(), observableCallbackContext);
hasProgressCallback, responseType, this.tlsConfiguration, this.cordova.getActivity().getApplicationContext(), observableCallbackContext);

startRequest(reqId, observableCallbackContext, upload);

Expand Down
26 changes: 25 additions & 1 deletion src/android/com/silkimen/cordovahttp/CordovaHttpUpload.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import android.database.Cursor;
import android.net.Uri;
import android.provider.OpenableColumns;
import android.util.Log;
import android.webkit.MimeTypeMap;

import com.silkimen.http.HttpRequest;
Expand All @@ -17,22 +18,26 @@
import javax.net.ssl.HostnameVerifier;
import javax.net.ssl.SSLSocketFactory;

import org.apache.cordova.PluginResult;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;

class CordovaHttpUpload extends CordovaHttpBase {
private JSONArray filePaths;
private JSONArray uploadNames;
private Context applicationContext;
private boolean hasProgressHandler;

public CordovaHttpUpload(String url, JSONObject headers, JSONArray filePaths, JSONArray uploadNames, int connectTimeout, int readTimeout,
boolean followRedirects, String responseType, TLSConfiguration tlsConfiguration,
boolean followRedirects, boolean hasProgressHandler, String responseType, TLSConfiguration tlsConfiguration,
Context applicationContext, CordovaObservableCallbackContext callbackContext) {

super("POST", url, headers, connectTimeout, readTimeout, followRedirects, responseType, tlsConfiguration, callbackContext);
this.filePaths = filePaths;
this.uploadNames = uploadNames;
this.applicationContext = applicationContext;
this.hasProgressHandler = hasProgressHandler;
}

@Override
Expand Down Expand Up @@ -60,6 +65,25 @@ protected void sendBody(HttpRequest request) throws Exception {

request.part(uploadName, fileName, mimeType, inputStream);
}

if (hasProgressHandler) {
request.progress(new HttpRequest.UploadProgress() {
public void onUpload(long transferred, long total) {
JSONObject json = new JSONObject();
try {
json.put("isProgress", true);
json.put("transferred", transferred);
json.put("total", total);

PluginResult result = new PluginResult(PluginResult.Status.OK, json);
result.setKeepCallback(true);
callbackContext.getCallbackContext().sendPluginResult(result);
} catch (JSONException e) {
Log.e(TAG, "onUpload progress error", e);
}
}
});
}
}
}

Expand Down
12 changes: 11 additions & 1 deletion src/ios/CordovaHttpPlugin.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,13 +494,22 @@ - (void)uploadFiles:(CDVInvokedUrlCommand*)command {
[[SDNetworkActivityIndicator sharedActivityIndicator] stopActivity];
return;
}
} progress:nil success:^(NSURLSessionTask *task, id responseObject) {
} progress:^(NSProgress *progress) {
NSMutableDictionary *dictionary = [NSMutableDictionary dictionary];
[dictionary setValue:[NSNumber numberWithBool:YES] forKey:@"isProgress"];
[dictionary setValue:[NSNumber numberWithLongLong:progress.completedUnitCount] forKey:@"transferred"];
[dictionary setValue:[NSNumber numberWithLongLong:progress.totalUnitCount] forKey:@"total"];
CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:dictionary];
[pluginResult setKeepCallback:[NSNumber numberWithBool:YES]];
[weakSelf.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
} success:^(NSURLSessionTask *task, id responseObject) {
[weakSelf removeRequest:reqId];

NSMutableDictionary *dictionary = [NSMutableDictionary dictionary];
[self handleSuccess:dictionary withResponse:(NSHTTPURLResponse*)task.response andData:responseObject];

CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsDictionary:dictionary];
[pluginResult setKeepCallback:[NSNumber numberWithBool:NO]];
[weakSelf.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
[[SDNetworkActivityIndicator sharedActivityIndicator] stopActivity];
} failure:^(NSURLSessionTask *task, NSError *error) {
Expand All @@ -510,6 +519,7 @@ - (void)uploadFiles:(CDVInvokedUrlCommand*)command {
[self handleError:dictionary withResponse:(NSHTTPURLResponse*)task.response error:error];

CDVPluginResult *pluginResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_ERROR messageAsDictionary:dictionary];
[pluginResult setKeepCallback:[NSNumber numberWithBool:NO]];
[weakSelf.commandDelegate sendPluginResult:pluginResult callbackId:command.callbackId];
[[SDNetworkActivityIndicator sharedActivityIndicator] stopActivity];
}];
Expand Down
3 changes: 2 additions & 1 deletion www/helpers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,8 @@ module.exports = function init(global, jsUtil, cookieHandler, messages, base64,
serializer: checkSerializer(options.serializer || globals.serializer),
connectTimeout: checkTimeoutValue(options.connectTimeout || globals.connectTimeout),
readTimeout: checkTimeoutValue(options.readTimeout || globals.readTimeout),
timeout: checkTimeoutValue(options.timeout || globals.timeout)
timeout: checkTimeoutValue(options.timeout || globals.timeout),
onProgress: options.onProgress
};
}
};
13 changes: 10 additions & 3 deletions www/public-interface.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,14 @@ module.exports = function init(exec, cookieHandler, urlUtil, helpers, globalConf
break;
case 'upload':
var fileOptions = helpers.checkUploadFileOptions(options.filePath, options.name);
exec(onSuccess, onFail, 'CordovaHttpPlugin', 'uploadFiles', [url, headers, fileOptions.filePaths, fileOptions.names, options.connectTimeout, options.readTimeout, options.followRedirect, options.responseType, reqId]);
var hasProgressCallback = options.onProgress != null;
Copy link
Owner

@silkimen silkimen May 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to check for falsey value here not for null, because it will be undefined if not provided.

Suggested change
var hasProgressCallback = options.onProgress != null;
var hasProgressCallback = !!options.onProgress;

exec(function(resp) {
if (resp != null && resp.isProgress) {
options.onProgress(resp);
} else {
onSuccess(resp);
}
Comment on lines +185 to +189
Copy link
Owner

@silkimen silkimen May 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please extract this inline handler into a function expression in lines 183ff for making it more readable.

}, onFail, 'CordovaHttpPlugin', 'uploadFiles', [url, headers, fileOptions.filePaths, fileOptions.names, options.connectTimeout, options.readTimeout, options.followRedirect, options.responseType, reqId, hasProgressCallback]);
break;
case 'download':
var filePath = helpers.checkDownloadFilePath(options.filePath);
Expand Down Expand Up @@ -223,8 +230,8 @@ module.exports = function init(exec, cookieHandler, urlUtil, helpers, globalConf
return publicInterface.sendRequest(url, { method: 'options', params: params, headers: headers }, success, failure);
};

function uploadFile(url, params, headers, filePath, name, success, failure) {
return publicInterface.sendRequest(url, { method: 'upload', params: params, headers: headers, filePath: filePath, name: name }, success, failure);
function uploadFile(url, params, headers, filePath, name, success, failure, progress) {
Copy link
Owner

@silkimen silkimen May 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this work for the https://github.com/danielsogl/awesome-cordova-plugins/ wrapper? I think it could be a problem but not sure, because usually the last two arguments are meant to be success and fail handlers. Would you please check?
If it causes problems we can keep the short-hand function uploadFile and make this functionality available only via sendRequest.

return publicInterface.sendRequest(url, { method: 'upload', params: params, headers: headers, filePath: filePath, name: name, onProgress: progress }, success, failure);
}

function downloadFile(url, params, headers, filePath, success, failure) {
Expand Down