github/cordova-plugin-file-transfer
4
0
Fork 0
mirror of https://github.com/apache/cordova-plugin-file-transfer.git synced 2026-04-10 00:00:03 +08:00
Code Issues Projects Releases Wiki Activity

refactor(eslint): use cordova-eslint /w fix (#275)

Browse Source
This commit is contained in:
Tim Brust
2020-09-01 15:08:24 +00:00
committed by GitHub
parent b4a4c2a74e
commit cd15b50172
10 changed files with 2116 additions and 1809 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.eslintrc.yml
+23
View File
@@ -0,0 +1,23 @@
# 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.
root: true
extends: '@cordova/eslint-config/browser'
overrides:
- files: [tests/**/*.js]
extends: '@cordova/eslint-config/node-tests'
.jscsrc
-23
View File
@@ -1,23 +0,0 @@
{
"disallowMixedSpacesAndTabs": true,
"disallowTrailingWhitespace": true,
"validateIndentation": 4,
"requireLineFeedAtFileEnd": true,
"disallowSpaceAfterPrefixUnaryOperators": true,
"disallowSpaceBeforePostfixUnaryOperators": true,
"requireSpaceAfterLineComment": true,
"requireCapitalizedConstructors": true,
"disallowSpacesInNamedFunctionExpression": {
"beforeOpeningRoundBrace": true
},
"requireSpaceAfterKeywords": [
"if",
"else",
"for",
"while",
"do"
]
}
.jshintrc
-19
View File
@@ -1,19 +0,0 @@
{
"browser": true
, "devel": true
, "bitwise": true
, "undef": true
, "trailing": true
, "quotmark": false
, "indent": 4
, "unused": "vars"
, "latedef": "nofunc"
, "globals": {
"module": false,
"exports": false,
"require": false,
"FileTransferError": true,
"FileUploadResult": true,
"resolveLocalFileSystemURI": false
}
}
package.json
+3 -5
View File
@@ -13,9 +13,8 @@
] ]
}, },
"scripts": { "scripts": {
"test": "npm run lint && npm run style", "test": "npm run lint",
"lint": "jshint www && jshint src && jshint tests", "lint": "eslint ."
"style": "jscs tests/tests.js"
}, },
"repository": "github:apache/cordova-plugin-file-transfer", "repository": "github:apache/cordova-plugin-file-transfer",
"bugs": "https://github.com/apache/cordova-plugin-file-transfer/issues", "bugs": "https://github.com/apache/cordova-plugin-file-transfer/issues",
@@ -39,7 +38,6 @@
} }
}, },
"devDependencies": { "devDependencies": {
"jscs": "^2.6.0", "@cordova/eslint-config": "^3.0.0"
"jshint": "^2.8.0"
} }
} }
src/windows/FileTransferProxy.js
+84 -68
View File
@@ -19,26 +19,23 @@
* *
*/ */
/*jshint -W030 */
/* global Windows, WinJS */ /* global Windows, WinJS */
/*global module, require*/
var FTErr = require('./FileTransferError'), var FTErr = require('./FileTransferError');
ProgressEvent = require('cordova-plugin-file.ProgressEvent'), var ProgressEvent = require('cordova-plugin-file.ProgressEvent');
FileUploadResult = require('cordova-plugin-file.FileUploadResult'), var FileUploadResult = require('cordova-plugin-file.FileUploadResult');
FileProxy = require('cordova-plugin-file.FileProxy'); var FileProxy = require('cordova-plugin-file.FileProxy');
var appData = Windows.Storage.ApplicationData.current; var appData = Windows.Storage.ApplicationData.current;
var LINE_START = "--"; var LINE_START = '--';
var LINE_END = "\r\n"; var LINE_END = '\r\n';
var BOUNDARY = '+++++'; var BOUNDARY = '+++++';
var fileTransferOps = []; var fileTransferOps = [];
// Some private helper functions, hidden by the module // Some private helper functions, hidden by the module
function cordovaPathToNative (path) { function cordovaPathToNative (path) {
var cleanPath = String(path); var cleanPath = String(path);
// turn / into \\ // turn / into \\
cleanPath = cleanPath.replace(/\//g, '\\'); cleanPath = cleanPath.replace(/\//g, '\\');
@@ -157,7 +154,6 @@ FileTransferOperation.CANCELLED = 2;
var HTTP_E_STATUS_NOT_MODIFIED = -2145844944; var HTTP_E_STATUS_NOT_MODIFIED = -2145844944;
module.exports = { module.exports = {
/* /*
exec(win, fail, 'FileTransfer', 'upload', exec(win, fail, 'FileTransfer', 'upload',
[filePath, server, fileKey, fileName, mimeType, params, trustAllHosts, chunkedMode, headers, this._id, httpMethod]); [filePath, server, fileKey, fileName, mimeType, params, trustAllHosts, chunkedMode, headers, this._id, httpMethod]);
@@ -175,7 +171,7 @@ exec(win, fail, 'FileTransfer', 'upload',
var uploadId = options[9]; var uploadId = options[9];
var httpMethod = options[10]; var httpMethod = options[10];
var isMultipart = typeof headers["Content-Type"] === 'undefined'; var isMultipart = typeof headers['Content-Type'] === 'undefined';
function stringToByteArray (str) { function stringToByteArray (str) {
var byteCharacters = atob(str); var byteCharacters = atob(str);
@@ -186,21 +182,21 @@ exec(win, fail, 'FileTransfer', 'upload',
return new Uint8Array(byteNumbers); return new Uint8Array(byteNumbers);
} }
if (!filePath || (typeof filePath !== 'string')) { if (!filePath || typeof filePath !== 'string') {
errorCallback(new FTErr(FTErr.FILE_NOT_FOUND_ERR, null, server)); errorCallback(new FTErr(FTErr.FILE_NOT_FOUND_ERR, null, server));
return; return;
} }
if (filePath.indexOf("data:") === 0 && filePath.indexOf("base64") !== -1) { if (filePath.indexOf('data:') === 0 && filePath.indexOf('base64') !== -1) {
// First a DataWriter object is created, backed by an in-memory stream where // First a DataWriter object is created, backed by an in-memory stream where
// the data will be stored. // the data will be stored.
var writer = Windows.Storage.Streams.DataWriter(new Windows.Storage.Streams.InMemoryRandomAccessStream()); var writer = Windows.Storage.Streams.DataWriter(new Windows.Storage.Streams.InMemoryRandomAccessStream());
writer.unicodeEncoding = Windows.Storage.Streams.UnicodeEncoding.utf8; writer.unicodeEncoding = Windows.Storage.Streams.UnicodeEncoding.utf8;
writer.byteOrder = Windows.Storage.Streams.ByteOrder.littleEndian; writer.byteOrder = Windows.Storage.Streams.ByteOrder.littleEndian;
var commaIndex = filePath.indexOf(","); var commaIndex = filePath.indexOf(',');
if (commaIndex === -1) { if (commaIndex === -1) {
errorCallback(new FTErr(FTErr.INVALID_URL_ERR, fileName, server, null, null, "No comma in data: URI")); errorCallback(new FTErr(FTErr.INVALID_URL_ERR, fileName, server, null, null, 'No comma in data: URI'));
return; return;
} }
@@ -213,7 +209,7 @@ exec(win, fail, 'FileTransfer', 'upload',
var uploader = new Windows.Networking.BackgroundTransfer.BackgroundUploader(); var uploader = new Windows.Networking.BackgroundTransfer.BackgroundUploader();
uploader.method = httpMethod; uploader.method = httpMethod;
for (var header in headers) { for (var header in headers) {
if (headers.hasOwnProperty(header)) { if (Object.prototype.hasOwnProperty.call(headers, header)) {
uploader.setRequestHeader(header, headers[header]); uploader.setRequestHeader(header, headers[header]);
} }
} }
@@ -222,9 +218,9 @@ exec(win, fail, 'FileTransfer', 'upload',
// adding params supplied to request payload // adding params supplied to request payload
var multipartParams = ''; var multipartParams = '';
for (var key in params) { for (var key in params) {
if (params.hasOwnProperty(key)) { if (Object.prototype.hasOwnProperty.call(params, key)) {
multipartParams += LINE_START + BOUNDARY + LINE_END; multipartParams += LINE_START + BOUNDARY + LINE_END;
multipartParams += "Content-Disposition: form-data; name=\"" + key + "\""; multipartParams += 'Content-Disposition: form-data; name="' + key + '"';
multipartParams += LINE_END + LINE_END; multipartParams += LINE_END + LINE_END;
multipartParams += params[key]; multipartParams += params[key];
multipartParams += LINE_END; multipartParams += LINE_END;
@@ -232,13 +228,13 @@ exec(win, fail, 'FileTransfer', 'upload',
} }
var multipartFile = LINE_START + BOUNDARY + LINE_END; var multipartFile = LINE_START + BOUNDARY + LINE_END;
multipartFile += "Content-Disposition: form-data; name=\"file\";"; multipartFile += 'Content-Disposition: form-data; name="file";';
multipartFile += " filename=\"" + fileName + "\"" + LINE_END; multipartFile += ' filename="' + fileName + '"' + LINE_END;
multipartFile += "Content-Type: " + mimeType + LINE_END + LINE_END; multipartFile += 'Content-Type: ' + mimeType + LINE_END + LINE_END;
var bound = LINE_END + LINE_START + BOUNDARY + LINE_START + LINE_END; var bound = LINE_END + LINE_START + BOUNDARY + LINE_START + LINE_END;
uploader.setRequestHeader("Content-Type", "multipart/form-data; boundary=" + BOUNDARY); uploader.setRequestHeader('Content-Type', 'multipart/form-data; boundary=' + BOUNDARY);
writer.writeString(multipartParams); writer.writeString(multipartParams);
writer.writeString(multipartFile); writer.writeString(multipartFile);
writer.writeBytes(stringToByteArray(fileDataString)); writer.writeBytes(stringToByteArray(fileDataString));
@@ -251,11 +247,14 @@ exec(win, fail, 'FileTransfer', 'upload',
// The call to store async sends the actual contents of the writer // The call to store async sends the actual contents of the writer
// to the backing stream. // to the backing stream.
writer.storeAsync().then(function () { writer
.storeAsync()
.then(function () {
// For the in-memory stream implementation we are using, the flushAsync call // For the in-memory stream implementation we are using, the flushAsync call
// is superfluous, but other types of streams may require it. // is superfluous, but other types of streams may require it.
return writer.flushAsync(); return writer.flushAsync();
}).then(function () { })
.then(function () {
// We detach the stream to prolong its useful lifetime. Were we to fail // We detach the stream to prolong its useful lifetime. Were we to fail
// to detach the stream, the call to writer.close() would close the underlying // to detach the stream, the call to writer.close() would close the underlying
// stream, preventing its subsequent use by the DataReader below. Most clients // stream, preventing its subsequent use by the DataReader below. Most clients
@@ -298,20 +297,23 @@ exec(win, fail, 'FileTransfer', 'upload',
var errorObj = new FTErr(FTErr.INVALID_URL_ERR); var errorObj = new FTErr(FTErr.INVALID_URL_ERR);
errorObj.exception = err; errorObj.exception = err;
errorCallback(errorObj); errorCallback(errorObj);
}); }
);
}); });
return; return;
} }
if (filePath.substr(0, 8) === "file:///") { if (filePath.substr(0, 8) === 'file:///') {
filePath = appData.localFolder.path + filePath.substr(8).split("/").join("\\"); filePath = appData.localFolder.path + filePath.substr(8).split('/').join('\\');
} else if (filePath.indexOf('ms-appdata:///') === 0) { } else if (filePath.indexOf('ms-appdata:///') === 0) {
// Handle 'ms-appdata' scheme // Handle 'ms-appdata' scheme
filePath = filePath.replace('ms-appdata:///local', appData.localFolder.path) filePath = filePath
.replace('ms-appdata:///local', appData.localFolder.path)
.replace('ms-appdata:///temp', appData.temporaryFolder.path); .replace('ms-appdata:///temp', appData.temporaryFolder.path);
} else if (filePath.indexOf('cdvfile://') === 0) { } else if (filePath.indexOf('cdvfile://') === 0) {
filePath = filePath.replace('cdvfile://localhost/persistent', appData.localFolder.path) filePath = filePath
.replace('cdvfile://localhost/persistent', appData.localFolder.path)
.replace('cdvfile://localhost/temporary', appData.temporaryFolder.path); .replace('cdvfile://localhost/temporary', appData.temporaryFolder.path);
} }
@@ -321,9 +323,8 @@ exec(win, fail, 'FileTransfer', 'upload',
// Create internal download operation object // Create internal download operation object
fileTransferOps[uploadId] = new FileTransferOperation(FileTransferOperation.PENDING, null); fileTransferOps[uploadId] = new FileTransferOperation(FileTransferOperation.PENDING, null);
Windows.Storage.StorageFile.getFileFromPathAsync(filePath) Windows.Storage.StorageFile.getFileFromPathAsync(filePath).then(
.then(function (storageFile) { function (storageFile) {
if (!fileName) { if (!fileName) {
fileName = storageFile.name; fileName = storageFile.name;
} }
@@ -342,7 +343,7 @@ exec(win, fail, 'FileTransfer', 'upload',
var uploader = new Windows.Networking.BackgroundTransfer.BackgroundUploader(); var uploader = new Windows.Networking.BackgroundTransfer.BackgroundUploader();
uploader.method = httpMethod; uploader.method = httpMethod;
for (var header in headers) { for (var header in headers) {
if (headers.hasOwnProperty(header)) { if (Object.prototype.hasOwnProperty.call(headers, header)) {
uploader.setRequestHeader(header, headers[header]); uploader.setRequestHeader(header, headers[header]);
} }
} }
@@ -357,9 +358,14 @@ exec(win, fail, 'FileTransfer', 'upload',
var transferParts = []; var transferParts = [];
for (var key in params) { for (var key in params) {
// Create content part for params only if value is specified because CreateUploadAsync fails otherwise // Create content part for params only if value is specified because CreateUploadAsync fails otherwise
if (params.hasOwnProperty(key) && params[key] !== null && params[key] !== undefined && params[key].toString() !== "") { if (
Object.prototype.hasOwnProperty.call(params, key) &&
params[key] !== null &&
params[key] !== undefined &&
params[key].toString() !== ''
) {
var contentPart = new Windows.Networking.BackgroundTransfer.BackgroundTransferContentPart(); var contentPart = new Windows.Networking.BackgroundTransfer.BackgroundTransferContentPart();
contentPart.setHeader("Content-Disposition", "form-data; name=\"" + key + "\""); contentPart.setHeader('Content-Disposition', 'form-data; name="' + key + '"');
contentPart.setText(params[key]); contentPart.setText(params[key]);
transferParts.push(contentPart); transferParts.push(contentPart);
} }
@@ -367,7 +373,7 @@ exec(win, fail, 'FileTransfer', 'upload',
// Adding file to upload to request payload // Adding file to upload to request payload
var fileToUploadPart = new Windows.Networking.BackgroundTransfer.BackgroundTransferContentPart(fileKey, fileName); var fileToUploadPart = new Windows.Networking.BackgroundTransfer.BackgroundTransferContentPart(fileKey, fileName);
fileToUploadPart.setHeader("Content-Type", mimeType); fileToUploadPart.setHeader('Content-Type', mimeType);
fileToUploadPart.setFile(storageFile); fileToUploadPart.setFile(storageFile);
transferParts.push(fileToUploadPart); transferParts.push(fileToUploadPart);
@@ -390,9 +396,11 @@ exec(win, fail, 'FileTransfer', 'upload',
errorCallback(errorObj); errorCallback(errorObj);
} }
); );
}, function (err) { },
function (err) {
errorCallback(new FTErr(FTErr.FILE_NOT_FOUND_ERR, fileName, server, null, null, err)); errorCallback(new FTErr(FTErr.FILE_NOT_FOUND_ERR, fileName, server, null, null, err));
}); }
);
}, },
// [source, target, trustAllHosts, id, headers] // [source, target, trustAllHosts, id, headers]
@@ -406,20 +414,22 @@ exec(win, fail, 'FileTransfer', 'upload',
errorCallback(new FTErr(FTErr.FILE_NOT_FOUND_ERR)); errorCallback(new FTErr(FTErr.FILE_NOT_FOUND_ERR));
return; return;
} }
if (target.substr(0, 8) === "file:///") { if (target.substr(0, 8) === 'file:///') {
target = appData.localFolder.path + target.substr(8).split("/").join("\\"); target = appData.localFolder.path + target.substr(8).split('/').join('\\');
} else if (target.indexOf('ms-appdata:///') === 0) { } else if (target.indexOf('ms-appdata:///') === 0) {
// Handle 'ms-appdata' scheme // Handle 'ms-appdata' scheme
target = target.replace('ms-appdata:///local', appData.localFolder.path) target = target
.replace('ms-appdata:///local', appData.localFolder.path)
.replace('ms-appdata:///temp', appData.temporaryFolder.path); .replace('ms-appdata:///temp', appData.temporaryFolder.path);
} else if (target.indexOf('cdvfile://') === 0) { } else if (target.indexOf('cdvfile://') === 0) {
target = target.replace('cdvfile://localhost/persistent', appData.localFolder.path) target = target
.replace('cdvfile://localhost/persistent', appData.localFolder.path)
.replace('cdvfile://localhost/temporary', appData.temporaryFolder.path); .replace('cdvfile://localhost/temporary', appData.temporaryFolder.path);
} }
target = cordovaPathToNative(target); target = cordovaPathToNative(target);
var path = target.substr(0, target.lastIndexOf("\\")); var path = target.substr(0, target.lastIndexOf('\\'));
var fileName = target.substr(target.lastIndexOf("\\") + 1); var fileName = target.substr(target.lastIndexOf('\\') + 1);
if (path === null || fileName === null) { if (path === null || fileName === null) {
errorCallback(new FTErr(FTErr.FILE_NOT_FOUND_ERR)); errorCallback(new FTErr(FTErr.FILE_NOT_FOUND_ERR));
return; return;
@@ -434,8 +444,8 @@ exec(win, fail, 'FileTransfer', 'upload',
fileTransferOps[downloadId] = new FileTransferOperation(FileTransferOperation.PENDING, null); fileTransferOps[downloadId] = new FileTransferOperation(FileTransferOperation.PENDING, null);
var downloadCallback = function (storageFolder) { var downloadCallback = function (storageFolder) {
storageFolder.createFileAsync(tempFileName, Windows.Storage.CreationCollisionOption.replaceExisting).then(function (storageFile) { storageFolder.createFileAsync(tempFileName, Windows.Storage.CreationCollisionOption.replaceExisting).then(
function (storageFile) {
if (alreadyCancelled(downloadId)) { if (alreadyCancelled(downloadId)) {
errorCallback(new FTErr(FTErr.ABORT_ERR, source, target)); errorCallback(new FTErr(FTErr.ABORT_ERR, source, target));
return; return;
@@ -444,7 +454,7 @@ exec(win, fail, 'FileTransfer', 'upload',
// if download isn't cancelled, contunue with creating and preparing download operation // if download isn't cancelled, contunue with creating and preparing download operation
var downloader = new Windows.Networking.BackgroundTransfer.BackgroundDownloader(); var downloader = new Windows.Networking.BackgroundTransfer.BackgroundDownloader();
for (var header in headers) { for (var header in headers) {
if (headers.hasOwnProperty(header)) { if (Object.prototype.hasOwnProperty.call(headers, header)) {
downloader.setRequestHeader(header, headers[header]); downloader.setRequestHeader(header, headers[header]);
} }
} }
@@ -463,8 +473,8 @@ exec(win, fail, 'FileTransfer', 'upload',
// update internal TransferOperation object with newly created promise // update internal TransferOperation object with newly created promise
fileTransferOps[downloadId].promise = downloadOperation; fileTransferOps[downloadId].promise = downloadOperation;
downloadOperation.then(function () { downloadOperation.then(
function () {
// Update TransferOperation object with new state, delete promise property // Update TransferOperation object with new state, delete promise property
// since it is not actual anymore // since it is not actual anymore
var currentDownloadOp = fileTransferOps[downloadId]; var currentDownloadOp = fileTransferOps[downloadId];
@@ -473,19 +483,23 @@ exec(win, fail, 'FileTransfer', 'upload',
currentDownloadOp.promise = null; currentDownloadOp.promise = null;
} }
storageFile.renameAsync(fileName, Windows.Storage.CreationCollisionOption.replaceExisting).done(function () { storageFile.renameAsync(fileName, Windows.Storage.CreationCollisionOption.replaceExisting).done(
var nativeURI = storageFile.path.replace(appData.localFolder.path, 'ms-appdata:///local') function () {
var nativeURI = storageFile.path
.replace(appData.localFolder.path, 'ms-appdata:///local')
.replace(appData.temporaryFolder.path, 'ms-appdata:///temp') .replace(appData.temporaryFolder.path, 'ms-appdata:///temp')
.replace(/\\/g, '/'); .replace(/\\/g, '/');
// Passing null as error callback here because downloaded file should exist in any case // Passing null as error callback here because downloaded file should exist in any case
// otherwise the error callback will be hit during file creation in another place // otherwise the error callback will be hit during file creation in another place
FileProxy.resolveLocalFileSystemURI(successCallback, null, [nativeURI]); FileProxy.resolveLocalFileSystemURI(successCallback, null, [nativeURI]);
}, function(error) { },
function (error) {
errorCallback(new FTErr(FTErr.FILE_NOT_FOUND_ERR, source, target, null, null, error)); errorCallback(new FTErr(FTErr.FILE_NOT_FOUND_ERR, source, target, null, null, error));
}); }
}, function(error) { );
},
function (error) {
var getTransferError = new WinJS.Promise(function (resolve) { var getTransferError = new WinJS.Promise(function (resolve) {
// Handle download error here. If download was cancelled, // Handle download error here. If download was cancelled,
// message property will be specified // message property will be specified
@@ -506,13 +520,14 @@ exec(win, fail, 'FileTransfer', 'upload',
var reader = new Windows.Storage.Streams.DataReader(download.getResultStreamAt(0)); var reader = new Windows.Storage.Streams.DataReader(download.getResultStreamAt(0));
reader.loadAsync(download.progress.bytesReceived).then(function (bytesLoaded) { reader.loadAsync(download.progress.bytesReceived).then(function (bytesLoaded) {
var payload = reader.readString(bytesLoaded); var payload = reader.readString(bytesLoaded);
resolve(new FTErr(FTErr.FILE_NOT_FOUND_ERR, source, target, response.statusCode, payload, error)); resolve(
new FTErr(FTErr.FILE_NOT_FOUND_ERR, source, target, response.statusCode, payload, error)
);
}); });
} }
} }
}); });
getTransferError.then(function (fileTransferError) { getTransferError.then(function (fileTransferError) {
// Update TransferOperation object with new state, delete promise property // Update TransferOperation object with new state, delete promise property
// since it is not actual anymore // since it is not actual anymore
var currentDownloadOp = fileTransferOps[downloadId]; var currentDownloadOp = fileTransferOps[downloadId];
@@ -526,9 +541,8 @@ exec(win, fail, 'FileTransfer', 'upload',
errorCallback(fileTransferError); errorCallback(fileTransferError);
}); });
}); });
},
}, function(evt) { function (evt) {
var progressEvent = new ProgressEvent('progress', { var progressEvent = new ProgressEvent('progress', {
loaded: evt.progress.bytesReceived, loaded: evt.progress.bytesReceived,
total: evt.progress.totalBytesToReceive, total: evt.progress.totalBytesToReceive,
@@ -536,13 +550,16 @@ exec(win, fail, 'FileTransfer', 'upload',
}); });
// when bytesReceived == 0, BackgroundDownloader has not yet differentiated whether it could get file length or not, // when bytesReceived == 0, BackgroundDownloader has not yet differentiated whether it could get file length or not,
// when totalBytesToReceive == 0, BackgroundDownloader is unable to get file length // when totalBytesToReceive == 0, BackgroundDownloader is unable to get file length
progressEvent.lengthComputable = (evt.progress.bytesReceived > 0) && (evt.progress.totalBytesToReceive > 0); progressEvent.lengthComputable = evt.progress.bytesReceived > 0 && evt.progress.totalBytesToReceive > 0;
successCallback(progressEvent, { keepCallback: true }); successCallback(progressEvent, { keepCallback: true });
}); }
}, function(error) { );
},
function (error) {
errorCallback(new FTErr(FTErr.FILE_NOT_FOUND_ERR, source, target, null, null, error)); errorCallback(new FTErr(FTErr.FILE_NOT_FOUND_ERR, source, target, null, null, error));
}); }
);
}; };
var fileNotFoundErrorCallback = function (error) { var fileNotFoundErrorCallback = function (error) {
@@ -552,8 +569,8 @@ exec(win, fail, 'FileTransfer', 'upload',
Windows.Storage.StorageFolder.getFolderFromPathAsync(path).then(downloadCallback, function (error) { Windows.Storage.StorageFolder.getFolderFromPathAsync(path).then(downloadCallback, function (error) {
// Handle non-existent directory // Handle non-existent directory
if (error.number === -2147024894) { if (error.number === -2147024894) {
var parent = path.substr(0, path.lastIndexOf('\\')), var parent = path.substr(0, path.lastIndexOf('\\'));
folderNameToCreate = path.substr(path.lastIndexOf('\\') + 1); var folderNameToCreate = path.substr(path.lastIndexOf('\\') + 1);
Windows.Storage.StorageFolder.getFolderFromPathAsync(parent).then(function (parentFolder) { Windows.Storage.StorageFolder.getFolderFromPathAsync(parent).then(function (parentFolder) {
parentFolder.createFolderAsync(folderNameToCreate).then(downloadCallback, fileNotFoundErrorCallback); parentFolder.createFolderAsync(folderNameToCreate).then(downloadCallback, fileNotFoundErrorCallback);
@@ -577,7 +594,6 @@ exec(win, fail, 'FileTransfer', 'upload',
fileTransferOps[fileTransferOpId] = new FileTransferOperation(FileTransferOperation.CANCELLED, null); fileTransferOps[fileTransferOpId] = new FileTransferOperation(FileTransferOperation.CANCELLED, null);
} }
} }
}; };
require("cordova/exec/proxy").add("FileTransfer",module.exports); require('cordova/exec/proxy').add('FileTransfer', module.exports);
tests/hooks/after_prepare.js
+16 -5
View File
@@ -29,7 +29,9 @@ module.exports = function(context) {
// get the file transfer server address from the specified variables // get the file transfer server address from the specified variables
var fileTransferServerAddress = getFileTransferServerAddress(context) || getDefaultFileTransferServerAddress(context); var fileTransferServerAddress = getFileTransferServerAddress(context) || getDefaultFileTransferServerAddress(context);
console.log('Tests will use the following file transfer server address: ' + fileTransferServerAddress); console.log('Tests will use the following file transfer server address: ' + fileTransferServerAddress);
console.log('If you\'re using cordova@6.3.1 and the above address is wrong at "platform add", don\'t worry, it\'ll fix itself on "cordova run" or "cordova prepare".'); console.log(
'If you\'re using cordova@6.3.1 and the above address is wrong at "platform add", don\'t worry, it\'ll fix itself on "cordova run" or "cordova prepare".'
);
// pass it to the tests // pass it to the tests
writeFileTransferOptions(fileTransferServerAddress, context); writeFileTransferOptions(fileTransferServerAddress, context);
@@ -40,7 +42,7 @@ module.exports = function(context) {
var configNodes = context.opts.plugin.pluginInfo._et._root._children; var configNodes = context.opts.plugin.pluginInfo._et._root._children;
for (var node in configNodes) { for (var node in configNodes) {
if (configNodes[node].attrib.name == 'FILETRANSFER_SERVER_ADDRESS') { if (configNodes[node].attrib.name === 'FILETRANSFER_SERVER_ADDRESS') {
address = configNodes[node].attrib.default; address = configNodes[node].attrib.default;
} }
} }
@@ -49,10 +51,20 @@ module.exports = function(context) {
} }
function getFileTransferServerAddress (context) { function getFileTransferServerAddress (context) {
var platformJsonFile = path.join(context.opts.projectRoot, 'platforms', context.opts.platforms[0], context.opts.platforms[0] + '.json'); var platformJsonFile = path.join(
context.opts.projectRoot,
'platforms',
context.opts.platforms[0],
context.opts.platforms[0] + '.json'
);
var platformJson = JSON.parse(fs.readFileSync(platformJsonFile, 'utf8')); var platformJson = JSON.parse(fs.readFileSync(platformJsonFile, 'utf8'));
if (platformJson && platformJson.installed_plugins && platformJson.installed_plugins['cordova-plugin-file-transfer-tests'] && platformJson.installed_plugins['cordova-plugin-file-transfer-tests'].FILETRANSFER_SERVER_ADDRESS) { if (
platformJson &&
platformJson.installed_plugins &&
platformJson.installed_plugins['cordova-plugin-file-transfer-tests'] &&
platformJson.installed_plugins['cordova-plugin-file-transfer-tests'].FILETRANSFER_SERVER_ADDRESS
) {
return platformJson.installed_plugins['cordova-plugin-file-transfer-tests'].FILETRANSFER_SERVER_ADDRESS; return platformJson.installed_plugins['cordova-plugin-file-transfer-tests'].FILETRANSFER_SERVER_ADDRESS;
} else { } else {
return null; return null;
@@ -71,5 +83,4 @@ module.exports = function(context) {
} }
main(); main();
}; };
tests/tests.js
+634 -365
View File
File diff suppressed because it is too large Load Diff
www/FileTransfer.js
+42 -27
View File
@@ -21,10 +21,10 @@
/* global cordova, FileSystem */ /* global cordova, FileSystem */
var argscheck = require('cordova/argscheck'), var argscheck = require('cordova/argscheck');
exec = require('cordova/exec'), var exec = require('cordova/exec');
FileTransferError = require('./FileTransferError'), var FileTransferError = require('./FileTransferError');
ProgressEvent = require('cordova-plugin-file.ProgressEvent'); var ProgressEvent = require('cordova-plugin-file.ProgressEvent');
function newProgressEvent (result) { function newProgressEvent (result) {
var pe = new ProgressEvent(); var pe = new ProgressEvent();
@@ -35,8 +35,8 @@ function newProgressEvent(result) {
} }
function getUrlCredentials (urlString) { function getUrlCredentials (urlString) {
var credentialsPattern = /^https?\:\/\/(?:(?:(([^:@\/]*)(?::([^@\/]*))?)?@)?([^:\/?#]*)(?::(\d*))?).*$/, var credentialsPattern = /^https?:\/\/(?:(?:(([^:@/]*)(?::([^@/]*))?)?@)?([^:/?#]*)(?::(\d*))?).*$/;
credentials = credentialsPattern.exec(urlString); var credentials = credentialsPattern.exec(urlString);
return credentials && credentials[1]; return credentials && credentials[1];
} }
@@ -44,7 +44,6 @@ function getUrlCredentials(urlString) {
function getBasicAuthHeader (urlString) { function getBasicAuthHeader (urlString) {
var header = null; var header = null;
// This is changed due to MS Windows doesn't support credentials in http uris // This is changed due to MS Windows doesn't support credentials in http uris
// so we detect them by regexp and strip off from result url // so we detect them by regexp and strip off from result url
// Proof: http://social.msdn.microsoft.com/Forums/windowsapps/en-US/a327cf3c-f033-4a54-8b7f-03c56ba3203f/windows-foundation-uri-security-problem // Proof: http://social.msdn.microsoft.com/Forums/windowsapps/en-US/a327cf3c-f033-4a54-8b7f-03c56ba3203f/windows-foundation-uri-security-problem
@@ -52,8 +51,8 @@ function getBasicAuthHeader(urlString) {
if (window.btoa) { if (window.btoa) {
var credentials = getUrlCredentials(urlString); var credentials = getUrlCredentials(urlString);
if (credentials) { if (credentials) {
var authHeader = "Authorization"; var authHeader = 'Authorization';
var authHeaderValue = "Basic " + window.btoa(credentials); var authHeaderValue = 'Basic ' + window.btoa(credentials);
header = { header = {
name: authHeader, name: authHeader,
@@ -68,7 +67,7 @@ function getBasicAuthHeader(urlString) {
function convertHeadersToArray (headers) { function convertHeadersToArray (headers) {
var result = []; var result = [];
for (var header in headers) { for (var header in headers) {
if (headers.hasOwnProperty(header)) { if (Object.prototype.hasOwnProperty.call(headers, header)) {
var headerValue = headers[header]; var headerValue = headers[header];
result.push({ result.push({
name: header, name: header,
@@ -124,36 +123,37 @@ FileTransfer.prototype.upload = function(filePath, server, successCallback, erro
fileName = options.fileName; fileName = options.fileName;
mimeType = options.mimeType; mimeType = options.mimeType;
headers = options.headers; headers = options.headers;
httpMethod = options.httpMethod || "POST"; httpMethod = options.httpMethod || 'POST';
if (httpMethod.toUpperCase() == "PUT"){ if (httpMethod.toUpperCase() === 'PUT') {
httpMethod = "PUT"; httpMethod = 'PUT';
} else { } else {
httpMethod = "POST"; httpMethod = 'POST';
} }
if (options.chunkedMode !== null || typeof options.chunkedMode != "undefined") { if (options.chunkedMode !== null || typeof options.chunkedMode !== 'undefined') {
chunkedMode = options.chunkedMode; chunkedMode = options.chunkedMode;
} }
if (options.params) { if (options.params) {
params = options.params; params = options.params;
} } else {
else {
params = {}; params = {};
} }
} }
if (cordova.platformId === "windowsphone") { if (cordova.platformId === 'windowsphone') {
headers = headers && convertHeadersToArray(headers); headers = headers && convertHeadersToArray(headers);
params = params && convertHeadersToArray(params); params = params && convertHeadersToArray(params);
} }
var fail = errorCallback && function(e) { var fail =
errorCallback &&
function (e) {
var error = new FileTransferError(e.code, e.source, e.target, e.http_status, e.body, e.exception); var error = new FileTransferError(e.code, e.source, e.target, e.http_status, e.body, e.exception);
errorCallback(error); errorCallback(error);
}; };
var self = this; var self = this;
var win = function (result) { var win = function (result) {
if (typeof result.lengthComputable != "undefined") { if (typeof result.lengthComputable !== 'undefined') {
if (self.onprogress) { if (self.onprogress) {
self.onprogress(newProgressEvent(result)); self.onprogress(newProgressEvent(result));
} }
@@ -163,7 +163,19 @@ FileTransfer.prototype.upload = function(filePath, server, successCallback, erro
} }
} }
}; };
exec(win, fail, 'FileTransfer', 'upload', [filePath, server, fileKey, fileName, mimeType, params, trustAllHosts, chunkedMode, headers, this._id, httpMethod]); exec(win, fail, 'FileTransfer', 'upload', [
filePath,
server,
fileKey,
fileName,
mimeType,
params,
trustAllHosts,
chunkedMode,
headers,
this._id,
httpMethod
]);
}; };
/** /**
@@ -193,12 +205,12 @@ FileTransfer.prototype.download = function(source, target, successCallback, erro
headers = options.headers || null; headers = options.headers || null;
} }
if (cordova.platformId === "windowsphone" && headers) { if (cordova.platformId === 'windowsphone' && headers) {
headers = convertHeadersToArray(headers); headers = convertHeadersToArray(headers);
} }
var win = function (result) { var win = function (result) {
if (typeof result.lengthComputable != "undefined") { if (typeof result.lengthComputable !== 'undefined') {
if (self.onprogress) { if (self.onprogress) {
return self.onprogress(newProgressEvent(result)); return self.onprogress(newProgressEvent(result));
} }
@@ -206,21 +218,24 @@ FileTransfer.prototype.download = function(source, target, successCallback, erro
var entry = null; var entry = null;
if (result.isDirectory) { if (result.isDirectory) {
entry = new (require('cordova-plugin-file.DirectoryEntry'))(); entry = new (require('cordova-plugin-file.DirectoryEntry'))();
} } else if (result.isFile) {
else if (result.isFile) {
entry = new (require('cordova-plugin-file.FileEntry'))(); entry = new (require('cordova-plugin-file.FileEntry'))();
} }
entry.isDirectory = result.isDirectory; entry.isDirectory = result.isDirectory;
entry.isFile = result.isFile; entry.isFile = result.isFile;
entry.name = result.name; entry.name = result.name;
entry.fullPath = result.fullPath; entry.fullPath = result.fullPath;
entry.filesystem = new FileSystem(result.filesystemName || (result.filesystem == window.PERSISTENT ? 'persistent' : 'temporary')); entry.filesystem = new FileSystem(
result.filesystemName || (result.filesystem === window.PERSISTENT ? 'persistent' : 'temporary')
);
entry.nativeURL = result.nativeURL; entry.nativeURL = result.nativeURL;
successCallback(entry); successCallback(entry);
} }
}; };
var fail = errorCallback && function(e) { var fail =
errorCallback &&
function (e) {
var error = new FileTransferError(e.code, e.source, e.target, e.http_status, e.body, e.exception); var error = new FileTransferError(e.code, e.source, e.target, e.http_status, e.body, e.exception);
errorCallback(error); errorCallback(error);
}; };
www/browser/FileTransfer.js
+53 -36
View File
@@ -19,10 +19,10 @@
* *
*/ */
/*global module, require*/ /* global FileUploadResult */
var argscheck = require('cordova/argscheck'), var argscheck = require('cordova/argscheck');
FileTransferError = require('./FileTransferError'); var FileTransferError = require('./FileTransferError');
function getParentPath (filePath) { function getParentPath (filePath) {
var pos = filePath.lastIndexOf('/'); var pos = filePath.lastIndexOf('/');
@@ -35,8 +35,8 @@ function getFileName(filePath) {
} }
function getUrlCredentials (urlString) { function getUrlCredentials (urlString) {
var credentialsPattern = /^https?\:\/\/(?:(?:(([^:@\/]*)(?::([^@\/]*))?)?@)?([^:\/?#]*)(?::(\d*))?).*$/, var credentialsPattern = /^https?:\/\/(?:(?:(([^:@/]*)(?::([^@/]*))?)?@)?([^:/?#]*)(?::(\d*))?).*$/;
credentials = credentialsPattern.exec(urlString); var credentials = credentialsPattern.exec(urlString);
return credentials && credentials[1]; return credentials && credentials[1];
} }
@@ -44,7 +44,6 @@ function getUrlCredentials(urlString) {
function getBasicAuthHeader (urlString) { function getBasicAuthHeader (urlString) {
var header = null; var header = null;
// This is changed due to MS Windows doesn't support credentials in http uris // This is changed due to MS Windows doesn't support credentials in http uris
// so we detect them by regexp and strip off from result url // so we detect them by regexp and strip off from result url
// Proof: http://social.msdn.microsoft.com/Forums/windowsapps/en-US/a327cf3c-f033-4a54-8b7f-03c56ba3203f/windows-foundation-uri-security-problem // Proof: http://social.msdn.microsoft.com/Forums/windowsapps/en-US/a327cf3c-f033-4a54-8b7f-03c56ba3203f/windows-foundation-uri-security-problem
@@ -52,8 +51,8 @@ function getBasicAuthHeader(urlString) {
if (window.btoa) { if (window.btoa) {
var credentials = getUrlCredentials(urlString); var credentials = getUrlCredentials(urlString);
if (credentials) { if (credentials) {
var authHeader = "Authorization"; var authHeader = 'Authorization';
var authHeaderValue = "Basic " + window.btoa(credentials); var authHeaderValue = 'Basic ' + window.btoa(credentials);
header = { header = {
name: authHeader, name: authHeader,
@@ -66,7 +65,7 @@ function getBasicAuthHeader(urlString) {
} }
function checkURL (url) { function checkURL (url) {
return url.indexOf(' ') === -1 ? true : false; return url.indexOf(' ') === -1;
} }
var idCounter = 0; var idCounter = 0;
@@ -107,14 +106,14 @@ FileTransfer.prototype.upload = function(filePath, server, successCallback, erro
options = options || {}; options = options || {};
var fileKey = options.fileKey || "file"; var fileKey = options.fileKey || 'file';
var fileName = options.fileName || "image.jpg"; var fileName = options.fileName || 'image.jpg';
var mimeType = options.mimeType || "image/jpeg"; var mimeType = options.mimeType || 'image/jpeg';
var params = options.params || {}; var params = options.params || {};
var withCredentials = options.withCredentials || false; var withCredentials = options.withCredentials || false;
// var chunkedMode = !!options.chunkedMode; // Not supported // var chunkedMode = !!options.chunkedMode; // Not supported
var headers = options.headers || {}; var headers = options.headers || {};
var httpMethod = options.httpMethod && options.httpMethod.toUpperCase() === "PUT" ? "PUT" : "POST"; var httpMethod = options.httpMethod && options.httpMethod.toUpperCase() === 'PUT' ? 'PUT' : 'POST';
var basicAuthHeader = getBasicAuthHeader(server); var basicAuthHeader = getBasicAuthHeader(server);
if (basicAuthHeader) { if (basicAuthHeader) {
@@ -123,10 +122,12 @@ FileTransfer.prototype.upload = function(filePath, server, successCallback, erro
} }
var that = this; var that = this;
var xhr = transfers[this._id] = new XMLHttpRequest(); var xhr = (transfers[this._id] = new XMLHttpRequest());
xhr.withCredentials = withCredentials; xhr.withCredentials = withCredentials;
var fail = errorCallback && function(code, status, response) { var fail =
errorCallback &&
function (code, status, response) {
if (transfers[this._id]) { if (transfers[this._id]) {
delete transfers[this._id]; delete transfers[this._id];
} }
@@ -136,8 +137,11 @@ FileTransfer.prototype.upload = function(filePath, server, successCallback, erro
} }
}; };
window.resolveLocalFileSystemURL(filePath, function(entry) { window.resolveLocalFileSystemURL(
entry.file(function(file) { filePath,
function (entry) {
entry.file(
function (file) {
var reader = new FileReader(); var reader = new FileReader();
reader.onloadend = function () { reader.onloadend = function () {
var blob = new Blob([this.result], { type: mimeType }); var blob = new Blob([this.result], { type: mimeType });
@@ -146,7 +150,7 @@ FileTransfer.prototype.upload = function(filePath, server, successCallback, erro
var fd = new FormData(); var fd = new FormData();
fd.append(fileKey, blob, fileName); fd.append(fileKey, blob, fileName);
for (var prop in params) { for (var prop in params) {
if (params.hasOwnProperty(prop)) { if (Object.prototype.hasOwnProperty.call(params, prop)) {
fd.append(prop, params[prop]); fd.append(prop, params[prop]);
} }
} }
@@ -155,16 +159,15 @@ FileTransfer.prototype.upload = function(filePath, server, successCallback, erro
// Fill XHR headers // Fill XHR headers
for (var header in headers) { for (var header in headers) {
if (headers.hasOwnProperty(header)) { if (Object.prototype.hasOwnProperty.call(headers, header)) {
xhr.setRequestHeader(header, headers[header]); xhr.setRequestHeader(header, headers[header]);
} }
} }
xhr.onload = function () { xhr.onload = function () {
// 2xx codes are valid // 2xx codes are valid
if (this.status >= 200 && if (this.status >= 200 && this.status < 300) {
this.status < 300) { var result = new FileUploadResult();
var result = new FileUploadResult(); // jshint ignore:line
result.bytesSent = blob.size; result.bytesSent = blob.size;
result.responseCode = this.status; result.responseCode = this.status;
result.response = this.response; result.response = this.response;
@@ -204,12 +207,16 @@ FileTransfer.prototype.upload = function(filePath, server, successCallback, erro
} }
}; };
reader.readAsArrayBuffer(file); reader.readAsArrayBuffer(file);
}, function() { },
function () {
fail(FileTransferError.FILE_NOT_FOUND_ERR); fail(FileTransferError.FILE_NOT_FOUND_ERR);
}); }
}, function() { );
},
function () {
fail(FileTransferError.FILE_NOT_FOUND_ERR); fail(FileTransferError.FILE_NOT_FOUND_ERR);
}); }
);
}; };
/** /**
@@ -245,9 +252,11 @@ FileTransfer.prototype.download = function(source, target, successCallback, erro
} }
var that = this; var that = this;
var xhr = transfers[this._id] = new XMLHttpRequest(); var xhr = (transfers[this._id] = new XMLHttpRequest());
xhr.withCredentials = withCredentials; xhr.withCredentials = withCredentials;
var fail = errorCallback && function(code, status, response) { var fail =
errorCallback &&
function (code, status, response) {
if (transfers[that._id]) { if (transfers[that._id]) {
delete transfers[that._id]; delete transfers[that._id];
} }
@@ -267,7 +276,6 @@ FileTransfer.prototype.download = function(source, target, successCallback, erro
}; };
xhr.onload = function (e) { xhr.onload = function (e) {
var fileNotFound = function () { var fileNotFound = function () {
fail(FileTransferError.FILE_NOT_FOUND_ERR); fail(FileTransferError.FILE_NOT_FOUND_ERR);
}; };
@@ -275,8 +283,13 @@ FileTransfer.prototype.download = function(source, target, successCallback, erro
var req = e.target; var req = e.target;
// req.status === 0 is special case for local files with file:// URI scheme // req.status === 0 is special case for local files with file:// URI scheme
if ((req.status === 200 || req.status === 0) && req.response) { if ((req.status === 200 || req.status === 0) && req.response) {
window.resolveLocalFileSystemURL(getParentPath(target), function (dir) { window.resolveLocalFileSystemURL(
dir.getFile(getFileName(target), {create: true}, function writeFile(entry) { getParentPath(target),
function (dir) {
dir.getFile(
getFileName(target),
{ create: true },
function writeFile (entry) {
entry.createWriter(function (fileWriter) { entry.createWriter(function (fileWriter) {
fileWriter.onwriteend = function (evt) { fileWriter.onwriteend = function (evt) {
if (!evt.target.error) { if (!evt.target.error) {
@@ -294,8 +307,12 @@ FileTransfer.prototype.download = function(source, target, successCallback, erro
}; };
fileWriter.write(req.response); fileWriter.write(req.response);
}, fileNotFound); }, fileNotFound);
}, fileNotFound); },
}, fileNotFound); fileNotFound
);
},
fileNotFound
);
} else if (req.status === 404) { } else if (req.status === 404) {
fail(FileTransferError.INVALID_URL_ERR, req.status, req.response); fail(FileTransferError.INVALID_URL_ERR, req.status, req.response);
} else { } else {
@@ -317,15 +334,15 @@ FileTransfer.prototype.download = function(source, target, successCallback, erro
fail(FileTransferError.ABORT_ERR, this.status, this.response); fail(FileTransferError.ABORT_ERR, this.status, this.response);
}; };
xhr.open("GET", source, true); xhr.open('GET', source, true);
for (var header in headers) { for (var header in headers) {
if (headers.hasOwnProperty(header)) { if (Object.prototype.hasOwnProperty.call(headers, header)) {
xhr.setRequestHeader(header, headers[header]); xhr.setRequestHeader(header, headers[header]);
} }
} }
xhr.responseType = "blob"; xhr.responseType = 'blob';
xhr.send(); xhr.send();
}; };