gecko/toolkit/components/downloads/test/unit/test_sleep_wake.js

185 lines
6.7 KiB
JavaScript

/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Download Manager Test Code.
*
* The Initial Developer of the Original Code is
* Edward Lee <edward.lee@engineering.uiuc.edu>.
* Portions created by the Initial Developer are Copyright (C) 2008
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/**
* Test bug 335418 by making sure the download manager responds to sleep and
* wake notifications by pausing and resuming downloads.
*/
/**
* Used to indicate if we should error out or not. See bug 431745 for more
* details.
*/
let doNotError = false;
const nsIF = Ci.nsIFile;
const nsIDM = Ci.nsIDownloadManager;
const nsIWBP = Ci.nsIWebBrowserPersist;
const nsIWPL = Ci.nsIWebProgressListener;
const dm = Cc["@mozilla.org/download-manager;1"].getService(nsIDM);
dm.cleanUp();
function notify(aTopic)
{
Cc["@mozilla.org/observer-service;1"].
getService(Ci.nsIObserverService).
notifyObservers(null, aTopic, null);
}
function run_test()
{
/**
* 0. Speed up the resume on wake delay from 10 seconds
*/
Cc["@mozilla.org/preferences-service;1"].
getService(Ci.nsIPrefBranch).
setIntPref("browser.download.manager.resumeOnWakeDelay", 1000);
/**
* 1. Create data for http server to send
*/
// data starts at 10 bytes
let data = "1234567890";
// data * 10^4 = 100,000 bytes (actually 101,111 bytes with newline)
for (let i = 0; i < 4; i++)
data = [data,data,data,data,data,data,data,data,data,data,"\n"].join("");
/**
* 2. Start the http server that can handle resume
*/
let httpserv = new nsHttpServer();
let didResumeServer = false;
httpserv.registerPathHandler("/resume", function(meta, resp) {
let body = data;
resp.setHeader("Content-Type", "text/html", false);
if (meta.hasHeader("Range")) {
// track that we resumed for testing
didResumeServer = true;
// Syntax: bytes=[from]-[to] (we don't support multiple ranges)
let matches = meta.getHeader("Range").match(/^\s*bytes=(\d+)?-(\d+)?\s*$/);
let from = (matches[1] === undefined) ? 0 : matches[1];
let to = (matches[2] === undefined) ? data.length - 1 : matches[2];
if (from >= data.length) {
resp.setStatusLine(meta.httpVersion, 416, "Start pos too high");
resp.setHeader("Content-Range", "*/" + data.length);
dump("Returning early - from >= data.length. Not an error (bug 431745)\n");
doNotError = true;
return;
}
body = body.substring(from, to + 1);
// always respond to successful range requests with 206
resp.setStatusLine(meta.httpVersion, 206, "Partial Content");
resp.setHeader("Content-Range", from + "-" + to + "/" + data.length);
}
resp.bodyOutputStream.write(body, body.length);
});
httpserv.start(4444);
/**
* 3. Perform various actions for certain download states
*/
let didPause = false;
let didResumeDownload = false;
dm.addListener({
onDownloadStateChange: function(a, aDl) {
if (aDl.state == nsIDM.DOWNLOAD_DOWNLOADING && !didPause) {
/**
* (1) queued -> downloading = pause the download with sleep
*/
notify("sleep_notification");
} else if (aDl.state == nsIDM.DOWNLOAD_PAUSED) {
/**
* (2) downloading -> paused
*/
didPause = true;
} else if (aDl.state == nsIDM.DOWNLOAD_FINISHED) {
/**
* (4) downloading (resumed) -> finished = check tests
*/
// did we pause at all?
do_check_true(didPause);
// did we real-resume and not fake-resume?
do_check_true(didResumeDownload);
// extra real-resume check for the server
do_check_true(didResumeServer);
aDl.targetFile.remove(false);
httpserv.stop(do_test_finished);
}
else if (aDl.state == nsIDM.DOWNLOAD_FAILED) {
// this is only ok if we are not supposed to fail
do_check_true(doNotError);
httpserv.stop(do_test_finished);
}
},
onStateChange: function(a, b, aState, d, aDl) {
if ((aState & nsIWPL.STATE_STOP) && didPause && !didResumeServer &&
!didResumeDownload) {
/**
* (3) paused -> stopped = resume the download by waking
*/
notify("wake_notification");
didResumeDownload = true;
}
},
onProgressChange: function(a, b, c, d, e, f, g) { },
onSecurityChange: function(a, b, c, d) { }
});
dm.addListener(getDownloadListener());
/**
* 4. Start the download
*/
let destFile = dirSvc.get("ProfD", nsIF);
destFile.append("sleep_wake");
if (destFile.exists())
destFile.remove(false);
let persist = Cc["@mozilla.org/embedding/browser/nsWebBrowserPersist;1"].
createInstance(nsIWBP);
persist.persistFlags = nsIWBP.PERSIST_FLAGS_REPLACE_EXISTING_FILES |
nsIWBP.PERSIST_FLAGS_BYPASS_CACHE |
nsIWBP.PERSIST_FLAGS_AUTODETECT_APPLY_CONVERSION;
let dl = dm.addDownload(nsIDM.DOWNLOAD_TYPE_DOWNLOAD,
createURI("http://localhost:4444/resume"),
createURI(destFile), null, null,
Math.round(Date.now() * 1000), null, persist);
persist.progressListener = dl.QueryInterface(nsIWPL);
persist.saveURI(dl.source, null, null, null, null, dl.targetFile);
// Mark as pending, so clear this when we actually finish the download
do_test_pending();
}