Cordova plugin file und file-transfer geadded

This commit is contained in:
2016-01-08 00:06:37 +01:00
parent 23a833a31b
commit 36c7e2c8e2
234 changed files with 49402 additions and 81 deletions

View File

@@ -0,0 +1,188 @@
/*
*
* 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'),
FileTransferError = require('./FileTransferError');
xhrImpl = require('./BB10XHRImplementation');
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);
}
};
xhrImpl.upload(win, fail, [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);
};
xhrImpl.download(win, fail, [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() {
xhrImpl.abort(null, null, [this._id]);
};
module.exports = FileTransfer;

View File

@@ -0,0 +1,36 @@
/*
*
* 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.
*
*/
/*
* FileTransferProxy
*
* Register all FileTransfer exec calls to be handled by proxy
*/
var xhrFileTransfer = require('cordova-plugin-file-transfer.xhrFileTransfer');
module.exports = {
abort: xhrFileTransfer.abort,
download: xhrFileTransfer.download,
upload: xhrFileTransfer.upload
};
require('cordova/exec/proxy').add('FileTransfer', module.exports);

View File

@@ -0,0 +1,259 @@
/*
*
* 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.
*
*/
/*global Blob:false */
var cordova = require('cordova'),
resolve = cordova.require('cordova-plugin-file.resolveLocalFileSystemURIProxy'),
requestAnimationFrame = cordova.require('cordova-plugin-file.bb10RequestAnimationFrame'),
xhr = {};
function getParentPath(filePath) {
var pos = filePath.lastIndexOf('/');
return filePath.substring(0, pos + 1);
}
function getFileName(filePath) {
var pos = filePath.lastIndexOf('/');
return filePath.substring(pos + 1);
}
function checkURL(url) {
return url.indexOf(' ') === -1 ? true : false;
}
module.exports = {
abort: function (win, fail, args) {
var id = args[0];
if (xhr[id]) {
xhr[id].abort();
if (typeof(win) === 'function') {
win();
}
} else if (typeof(fail) === 'function') {
fail();
}
},
upload: function(win, fail, args) {
var filePath = args[0],
server = args[1],
fileKey = args[2],
fileName = args[3],
mimeType = args[4],
params = args[5],
/*trustAllHosts = args[6],*/
chunkedMode = args[7],
headers = args[8],
onSuccess = function (data) {
if (typeof(win) === 'function') {
win(data);
}
},
onFail = function (code) {
delete xhr[fileKey];
if (typeof(fail) === 'function') {
fail(code);
}
};
if (!checkURL(server)) {
onFail(new FileTransferError(FileTransferError.INVALID_URL_ERR, server, filePath));
}
xhr[fileKey] = new XMLHttpRequest();
xhr[fileKey].onabort = function () {
onFail(new FileTransferError(FileTransferError.ABORT_ERR, server, filePath, this.status, xhr[fileKey].response));
};
resolve(function(entry) {
requestAnimationFrame(function () {
entry.nativeEntry.file(function(file) {
function uploadFile(blobFile) {
var fd = new FormData();
fd.append(fileKey, blobFile, fileName);
for (var prop in params) {
if(params.hasOwnProperty(prop)) {
fd.append(prop, params[prop]);
}
}
xhr[fileKey].open("POST", server);
xhr[fileKey].onload = function(evt) {
if (xhr[fileKey].status === 200) {
var result = new FileUploadResult();
result.bytesSent = file.size;
result.responseCode = xhr[fileKey].status;
result.response = xhr[fileKey].response;
delete xhr[fileKey];
onSuccess(result);
} else if (xhr[fileKey].status === 404) {
onFail(new FileTransferError(FileTransferError.INVALID_URL_ERR, server, filePath, xhr[fileKey].status, xhr[fileKey].response));
} else {
onFail(new FileTransferError(FileTransferError.CONNECTION_ERR, server, filePath, xhr[fileKey].status, xhr[fileKey].response));
}
};
xhr[fileKey].ontimeout = function(evt) {
onFail(new FileTransferError(FileTransferError.CONNECTION_ERR, server, filePath, xhr[fileKey].status, xhr[fileKey].response));
};
xhr[fileKey].onerror = function () {
onFail(new FileTransferError(FileTransferError.CONNECTION_ERR, server, filePath, this.status, xhr[fileKey].response));
};
xhr[fileKey].upload.onprogress = function (evt) {
if (evt.loaded > 0) {
onSuccess(evt);
}
};
for (var header in headers) {
if (headers.hasOwnProperty(header)) {
xhr[fileKey].setRequestHeader(header, headers[header]);
}
}
requestAnimationFrame(function () {
xhr[fileKey].send(fd);
});
}
var bytesPerChunk;
if (chunkedMode === true) {
bytesPerChunk = 1024 * 1024; // 1MB chunk sizes.
} else {
bytesPerChunk = file.size;
}
var start = 0;
var end = bytesPerChunk;
while (start < file.size) {
var chunk = file.slice(start, end, mimeType);
uploadFile(chunk);
start = end;
end = start + bytesPerChunk;
}
}, function(error) {
onFail(new FileTransferError(FileTransferError.FILE_NOT_FOUND_ERR, server, filePath));
});
});
}, function(error) {
onFail(new FileTransferError(FileTransferError.FILE_NOT_FOUND_ERR, server, filePath));
}, [filePath]);
},
download: function (win, fail, args) {
var source = args[0],
target = args[1],
id = args[3],
headers = args[4],
fileWriter,
onSuccess = function (entry) {
if (typeof(win) === 'function') {
win(entry);
}
},
onFail = function (error) {
var reader;
delete xhr[id];
if (typeof(fail) === 'function') {
if (error && error.body && typeof(error.body) === 'object') {
reader = new FileReader()._realReader;
reader.onloadend = function () {
error.body = this.result;
fail(error);
};
reader.onerror = function () {
fail(error);
};
reader.readAsText(error.body);
} else {
fail(error);
}
}
};
if (!checkURL(source)) {
onFail(new FileTransferError(FileTransferError.INVALID_URL_ERR, source, target));
}
xhr[id] = new XMLHttpRequest();
function writeFile(entry) {
entry.createWriter(function (writer) {
fileWriter = writer;
fileWriter.onwriteend = function (evt) {
if (!evt.target.error) {
entry.filesystemName = entry.filesystem.name;
delete xhr[id];
onSuccess(entry);
} else {
onFail(evt.target.error);
}
};
fileWriter.onerror = function (evt) {
onFail(evt.target.error);
};
fileWriter.write(new Blob([xhr[id].response]));
}, function (error) {
onFail(error);
});
}
xhr[id].onerror = function (e) {
onFail(new FileTransferError(FileTransferError.CONNECTION_ERR, source, target, xhr[id].status, xhr[id].response));
};
xhr[id].onabort = function (e) {
onFail(new FileTransferError(FileTransferError.ABORT_ERR, source, target, xhr[id].status, xhr[id].response));
}
xhr[id].onload = function () {
if (xhr[id].readyState === xhr[id].DONE) {
if (xhr[id].status === 200 && xhr[id].response) {
resolveLocalFileSystemURI(getParentPath(target), function (dir) {
dir.getFile(getFileName(target), {create: true}, writeFile, function (error) {
onFail(new FileTransferError(FileTransferError.FILE_NOT_FOUND_ERR, source, target, xhr[id].status, xhr[id].response));
});
}, function (error) {
onFail(new FileTransferError(FileTransferError.FILE_NOT_FOUND_ERR, source, target, xhr[id].status, xhr[id].response));
});
} else if (xhr[id].status === 404) {
onFail(new FileTransferError(FileTransferError.INVALID_URL_ERR, source, target, xhr[id].status, xhr[id].response));
} else {
onFail(new FileTransferError(FileTransferError.CONNECTION_ERR, source, target, xhr[id].status, xhr[id].response));
}
}
};
xhr[id].onprogress = function (evt) {
onSuccess(evt);
};
xhr[id].open("GET", source, true);
for (var header in headers) {
if (headers.hasOwnProperty(header)) {
xhr[id].setRequestHeader(header, headers[header]);
}
}
xhr[id].responseType = "blob";
requestAnimationFrame(function () {
if (xhr[id]) {
xhr[id].send();
}
});
}
};