You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by st...@apache.org on 2013/06/11 01:04:36 UTC
[03/16] js commit: [CB-3415][BlackBerry10] FileTransfer core plugin
[CB-3415][BlackBerry10] FileTransfer core plugin
Project: http://git-wip-us.apache.org/repos/asf/cordova-js/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-js/commit/b3bb0aae
Tree: http://git-wip-us.apache.org/repos/asf/cordova-js/tree/b3bb0aae
Diff: http://git-wip-us.apache.org/repos/asf/cordova-js/diff/b3bb0aae
Branch: refs/heads/3.0.0
Commit: b3bb0aae392dc8ffe9886200f26dde2ca04bf5e5
Parents: 5485a4c
Author: Hasan Ahmad <ha...@blackberry.com>
Authored: Tue May 7 14:22:23 2013 -0400
Committer: Bryan Higgins <bh...@blackberry.com>
Committed: Tue May 21 16:13:33 2013 -0400
----------------------------------------------------------------------
lib/blackberry10/plugin/FileTransfer.js | 187 +++++++++++++++++++
.../plugin/blackberry10/fileTransfer.js | 51 +++--
2 files changed, 212 insertions(+), 26 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-js/blob/b3bb0aae/lib/blackberry10/plugin/FileTransfer.js
----------------------------------------------------------------------
diff --git a/lib/blackberry10/plugin/FileTransfer.js b/lib/blackberry10/plugin/FileTransfer.js
new file mode 100644
index 0000000..09b9d5f
--- /dev/null
+++ b/lib/blackberry10/plugin/FileTransfer.js
@@ -0,0 +1,187 @@
+/*
+ *
+ * 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.
+ *
+*/
+
+var argscheck = require('cordova/argscheck'),
+ exec = require('cordova/exec'),
+ FileTransferError = require('cordova/plugin/FileTransferError');
+
+function getBasicAuthHeader(urlString) {
+ var header = null;
+
+ if (window.btoa) {
+ // parse the url using the Location object
+ var url = document.createElement('a');
+ url.href = urlString;
+
+ var credentials = null;
+ var protocol = url.protocol + "//";
+ var origin = protocol + url.host;
+
+ // check whether there are the username:password credentials in the url
+ if (url.href.indexOf(origin) !== 0) { // credentials found
+ var atIndex = url.href.indexOf("@");
+ credentials = url.href.substring(protocol.length, atIndex);
+ }
+
+ if (credentials) {
+ var authHeader = "Authorization";
+ var authHeaderValue = "Basic " + window.btoa(credentials);
+
+ header = {
+ name : authHeader,
+ value : authHeaderValue
+ };
+ }
+ }
+
+ return header;
+}
+
+var idCounter = 0;
+
+/**
+ * FileTransfer uploads a file to a remote server.
+ * @constructor
+ */
+var FileTransfer = function() {
+ this._id = ++idCounter;
+ this.onprogress = null; // optional callback
+};
+
+/**
+* Given an absolute file path, uploads a file on the device to a remote server
+* using a multipart HTTP request.
+* @param filePath {String} Full path of the file on the device
+* @param server {String} URL of the server to receive the file
+* @param successCallback (Function} Callback to be invoked when upload has completed
+* @param errorCallback {Function} Callback to be invoked upon error
+* @param options {FileUploadOptions} Optional parameters such as file name and mimetype
+* @param trustAllHosts {Boolean} Optional trust all hosts (e.g. for self-signed certs), defaults to false
+*/
+FileTransfer.prototype.upload = function(filePath, server, successCallback, errorCallback, options, trustAllHosts) {
+ argscheck.checkArgs('ssFFO*', 'FileTransfer.upload', arguments);
+ // check for options
+ var fileKey = null;
+ var fileName = null;
+ var mimeType = null;
+ var params = null;
+ var chunkedMode = true;
+ var headers = null;
+ var httpMethod = null;
+ var basicAuthHeader = getBasicAuthHeader(server);
+ if (basicAuthHeader) {
+ options = options || {};
+ options.headers = options.headers || {};
+ options.headers[basicAuthHeader.name] = basicAuthHeader.value;
+ }
+
+ if (options) {
+ fileKey = options.fileKey;
+ fileName = options.fileName;
+ mimeType = options.mimeType;
+ headers = options.headers;
+ httpMethod = options.httpMethod || "POST";
+ if (httpMethod.toUpperCase() == "PUT"){
+ httpMethod = "PUT";
+ } else {
+ httpMethod = "POST";
+ }
+ if (options.chunkedMode !== null || typeof options.chunkedMode != "undefined") {
+ chunkedMode = options.chunkedMode;
+ }
+ if (options.params) {
+ params = options.params;
+ }
+ else {
+ params = {};
+ }
+ }
+
+ var fail = errorCallback && function(e) {
+ var error = new FileTransferError(e.code, e.source, e.target, e.http_status, e.body);
+ errorCallback(error);
+ };
+
+ var self = this;
+ var win = function(result) {
+ if (typeof result.lengthComputable != "undefined") {
+ if (self.onprogress) {
+ self.onprogress(result);
+ }
+ } else {
+ successCallback && successCallback(result);
+ }
+ };
+ exec(win, fail, 'FileTransfer', 'upload', [filePath, server, fileKey, fileName, mimeType, params, trustAllHosts, chunkedMode, headers, this._id, httpMethod]);
+};
+
+/**
+ * Downloads a file form a given URL and saves it to the specified directory.
+ * @param source {String} URL of the server to receive the file
+ * @param target {String} Full path of the file on the device
+ * @param successCallback (Function} Callback to be invoked when upload has completed
+ * @param errorCallback {Function} Callback to be invoked upon error
+ * @param trustAllHosts {Boolean} Optional trust all hosts (e.g. for self-signed certs), defaults to false
+ * @param options {FileDownloadOptions} Optional parameters such as headers
+ */
+FileTransfer.prototype.download = function(source, target, successCallback, errorCallback, trustAllHosts, options) {
+ argscheck.checkArgs('ssFF*', 'FileTransfer.download', arguments);
+ var self = this;
+
+ var basicAuthHeader = getBasicAuthHeader(source);
+ if (basicAuthHeader) {
+ options = options || {};
+ options.headers = options.headers || {};
+ options.headers[basicAuthHeader.name] = basicAuthHeader.value;
+ }
+
+ var headers = null;
+ if (options) {
+ headers = options.headers || null;
+ }
+
+ var win = function(result) {
+ if (typeof result.lengthComputable != "undefined") {
+ if (self.onprogress) {
+ return self.onprogress(result);
+ }
+ } else if (successCallback) {
+ successCallback(result);
+ }
+ };
+
+ var fail = errorCallback && function(e) {
+ var error = new FileTransferError(e.code, e.source, e.target, e.http_status, e.body);
+ errorCallback(error);
+ };
+
+ exec(win, fail, 'FileTransfer', 'download', [source, target, trustAllHosts, this._id, headers]);
+};
+
+/**
+ * Aborts the ongoing file transfer on this object. The original error
+ * callback for the file transfer will be called if necessary.
+ */
+FileTransfer.prototype.abort = function() {
+ exec(null, null, 'FileTransfer', 'abort', [this._id]);
+};
+
+module.exports = FileTransfer;
http://git-wip-us.apache.org/repos/asf/cordova-js/blob/b3bb0aae/lib/blackberry10/plugin/blackberry10/fileTransfer.js
----------------------------------------------------------------------
diff --git a/lib/blackberry10/plugin/blackberry10/fileTransfer.js b/lib/blackberry10/plugin/blackberry10/fileTransfer.js
index c225433..b4756b3 100644
--- a/lib/blackberry10/plugin/blackberry10/fileTransfer.js
+++ b/lib/blackberry10/plugin/blackberry10/fileTransfer.js
@@ -21,12 +21,11 @@
/*global Blob:false */
var cordova = require('cordova'),
- ProgressEvent = require('cordova/plugin/ProgressEvent'),
nativeResolveLocalFileSystemURI = function(uri, success, fail) {
if (uri.substring(0,11) !== "filesystem:") {
uri = "filesystem:" + uri;
}
- window.webkitResolveLocalFileSystemURL(uri, success, fail);
+ resolveLocalFileSystemURI(uri, success, fail);
},
xhr;
@@ -40,11 +39,6 @@ function getFileName(filePath) {
return filePath.substring(pos + 1);
}
-function cleanUpPath(filePath) {
- var pos = filePath.lastIndexOf('/');
- return filePath.substring(0, pos) + filePath.substring(pos + 1, filePath.length);
-}
-
function checkURL(url) {
return url.indexOf(' ') === -1 ? true : false;
}
@@ -66,7 +60,7 @@ module.exports = {
headers = args[8];
if (!checkURL(server)) {
- fail(new window.FileTransferError(window.FileTransferError.INVALID_URL_ERR));
+ fail(new FileTransferError(FileTransferError.INVALID_URL_ERR, server, filePath));
}
nativeResolveLocalFileSystemURI(filePath, function(entry) {
@@ -84,23 +78,23 @@ module.exports = {
xhr = new XMLHttpRequest();
xhr.open("POST", server);
xhr.onload = function(evt) {
- if (xhr.status == 200) {
- var result = new window.FileUploadResult();
+ if (xhr.status === 200) {
+ var result = new FileUploadResult();
result.bytesSent = file.size;
result.responseCode = xhr.status;
result.response = xhr.response;
win(result);
- } else if (xhr.status == 404) {
- fail(new window.FileTransferError(window.FileTransferError.INVALID_URL_ERR, server, filePath, xhr.status));
+ } else if (xhr.status === 404) {
+ fail(new FileTransferError(FileTransferError.INVALID_URL_ERR, server, filePath, xhr.status, xhr.response));
} else {
- fail(new window.FileTransferError(window.FileTransferError.CONNECTION_ERR, server, filePath, xhr.status));
+ fail(new FileTransferError(FileTransferError.CONNECTION_ERR, server, filePath, xhr.status, xhr.response));
}
};
xhr.ontimeout = function(evt) {
- fail(new window.FileTransferError(window.FileTransferError.CONNECTION_ERR, server, filePath, xhr.status));
+ fail(new FileTransferError(FileTransferError.CONNECTION_ERR, server, filePath, xhr.status, xhr.response));
};
xhr.onerror = function () {
- fail(new window.FileTransferError(window.FileTransferError.CONNECTION_ERR, server, filePath, this.status));
+ fail(new FileTransferError(FileTransferError.CONNECTION_ERR, server, filePath, this.status, xhr.response));
};
xhr.onprogress = function (evt) {
win(evt);
@@ -130,10 +124,10 @@ module.exports = {
end = start + bytesPerChunk;
}
}, function(error) {
- fail(new window.FileTransferError(window.FileTransferError.FILE_NOT_FOUND_ERR));
+ fail(new FileTransferError(FileTransferError.FILE_NOT_FOUND_ERR, server, filePath));
});
}, function(error) {
- fail(new window.FileTransferError(window.FileTransferError.FILE_NOT_FOUND_ERR));
+ fail(new FileTransferError(FileTransferError.FILE_NOT_FOUND_ERR, server, filePath));
});
return { "status" : cordova.callbackStatus.NO_RESULT, "message" : "async"};
@@ -141,11 +135,12 @@ module.exports = {
download: function (args, win, fail) {
var source = args[0],
- target = cleanUpPath(args[1]),
+ target = args[1],
+ headers = args[4],
fileWriter;
if (!checkURL(source)) {
- fail(new window.FileTransferError(window.FileTransferError.INVALID_URL_ERR));
+ fail(new FileTransferError(FileTransferError.INVALID_URL_ERR, source, target));
}
xhr = new XMLHttpRequest();
@@ -155,7 +150,7 @@ module.exports = {
fileWriter = writer;
fileWriter.onwriteend = function (evt) {
if (!evt.target.error) {
- win(new window.FileEntry(entry.name, entry.toURL()));
+ win(entry);
} else {
fail(evt.target.error);
}
@@ -170,7 +165,7 @@ module.exports = {
}
xhr.onerror = function (e) {
- fail(new window.FileTransferError(window.FileTransferError.CONNECTION_ERR, source, target, xhr.status));
+ fail(new FileTransferError(FileTransferError.CONNECTION_ERR, source, target, xhr.status, xhr.response));
};
xhr.onload = function () {
@@ -178,15 +173,15 @@ module.exports = {
if (xhr.status === 200 && xhr.response) {
nativeResolveLocalFileSystemURI(getParentPath(target), function (dir) {
dir.getFile(getFileName(target), {create: true}, writeFile, function (error) {
- fail(new window.FileTransferError(window.FileTransferError.FILE_NOT_FOUND_ERR));
+ fail(new FileTransferError(FileTransferError.FILE_NOT_FOUND_ERR, source, target, xhr.status, xhr.response));
});
}, function (error) {
- fail(new window.FileTransferError(window.FileTransferError.FILE_NOT_FOUND_ERR));
+ fail(new FileTransferError(FileTransferError.FILE_NOT_FOUND_ERR, source, target, xhr.status, xhr.response));
});
} else if (xhr.status === 404) {
- fail(new window.FileTransferError(window.FileTransferError.INVALID_URL_ERR, source, target, xhr.status));
+ fail(new FileTransferError(FileTransferError.INVALID_URL_ERR, source, target, xhr.status, xhr.response));
} else {
- fail(new window.FileTransferError(window.FileTransferError.CONNECTION_ERR, source, target, xhr.status));
+ fail(new FileTransferError(FileTransferError.CONNECTION_ERR, source, target, xhr.status, xhr.response));
}
}
};
@@ -194,8 +189,12 @@ module.exports = {
win(evt);
};
- xhr.responseType = "blob";
xhr.open("GET", source, true);
+ for (var header in headers) {
+ if (headers.hasOwnProperty(header)) {
+ xhr.setRequestHeader(header, headers[header]);
+ }
+ }
xhr.send();
return { "status" : cordova.callbackStatus.NO_RESULT, "message" : "async"};
}