Skip to content
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

Add timeout option to plugin. #49

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add timeout option to plugin. #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 17 additions & 5 deletions src/Scripts/jquery.fileDownload.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,11 @@ $.extend({
//Note that some browsers will POST the string htmlentity-encoded whilst others will decode it before POSTing.
//It is recommended that on the server, htmlentity decoding is done irrespective.
//
encodeHTMLEntities: true

encodeHTMLEntities: true,

// timeout -- In milliseconds, time to wait for the file to download, after which failCallback is called.
// By default (null), timeout is not enabled.
timeout: null,
}, options);

var deferred = new $.Deferred();
Expand All @@ -136,6 +139,7 @@ $.extend({
var isIos; //has full support of features in iOS 4.0+, uses a new window to accomplish this.
var isAndroid; //has full support of GET features in 4.0+ by using a new window. Non-GET is completely unsupported by the browser. See above for specifying a message.
var isOtherMobileBrowser; //there is no way to reliably guess here so all other mobile devices will GET and POST to the current window.
var timePassed = 0;

if (/ip(ad|hone|od)/.test(userAgent)) {

Expand Down Expand Up @@ -377,9 +381,18 @@ $.extend({
}
}

timePassed += settings.checkInterval;
if (settings.timeout == null || (timePassed < settings.timeout)) {
//no timeout defined. continue checking...
setTimeout(checkFileDownloadComplete, settings.checkInterval);
} else {
//oops -- timed out.
internalCallbacks.onFail('', fileUrl);

cleanUp(true);

//keep checking...
setTimeout(checkFileDownloadComplete, settings.checkInterval);
return;
}
}

//gets an iframes document in a cross browser compatible manner
Expand Down Expand Up @@ -408,7 +421,6 @@ $.extend({
}
}
}

//iframe cleanup appears to randomly cause the download to fail
//not doing it seems better than failure...
//if ($iframe) {
Expand Down