gecko-dev/toolkit/components/downloads/test/unit/test_privatebrowsing.js

345 lines
16 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 Private Browsing Tests.
*
* The Initial Developer of the Original Code is
* Ehsan Akhgari.
* Portions created by the Initial Developer are Copyright (C) 2008
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Ehsan Akhgari <ehsan.akhgari@gmail.com> (Original Author)
*
* Alternatively, the contents of this file may be used under the terms of
* either of 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 download manager's interaction with the private browsing service.
An overview of what this test does follows:
* Create a download (Download-A) with specific details.
* Check that Download-A is retrievable.
* Enter private browsing mode.
* Check that Download-A is not accessible.
* Create another download (Download-B) with specific and different details.
* Check that Download-B is retrievable.
* Exit private browsing mode.
* Check that Download-A is retrievable.
* Check that Download-B is not accessible.
* Create a new download (Download-C) with specific details.
Start it and enter private browsing mode immediately after.
* Check that Download-C has been paused.
* Exit the private browsing mode.
* Verify that Download-C resumes and finishes correctly now.
**/
this.__defineGetter__("pb", function () {
delete this.pb;
try {
return this.pb = Cc["@mozilla.org/privatebrowsing;1"].
getService(Ci.nsIPrivateBrowsingService);
} catch (e) {}
return this.pb = null;
});
this.__defineGetter__("dm", function() {
delete this.dm;
return this.dm = Cc["@mozilla.org/download-manager;1"].
getService(Ci.nsIDownloadManager);
});
/**
* Try to see if an active download is available using the |activeDownloads|
* property.
*/
function is_active_download_available(aID, aSrc, aDst, aName) {
let enumerator = dm.activeDownloads;
while (enumerator.hasMoreElements()) {
let download = enumerator.getNext();
if (download.id == aID &&
download.source.spec == aSrc &&
download.targetFile.path == aDst.path &&
download.displayName == aName)
return true;
}
return false;
}
/**
* Try to see if a download is available using the |getDownload| method. The
* download can both be active or inactive.
*/
function is_download_available(aID, aSrc, aDst, aName) {
let download;
try {
download = dm.getDownload(aID);
} catch (ex) {
return false;
}
return (download.id == aID &&
download.source.spec == aSrc &&
download.targetFile.path == aDst.path &&
download.displayName == aName);
}
function run_test() {
if (!pb) // Private Browsing might not be available
return;
let prefBranch = Cc["@mozilla.org/preferences-service;1"].
getService(Ci.nsIPrefBranch);
prefBranch.setBoolPref("browser.privatebrowsing.keep_current_session", true);
do_test_pending();
let httpserv = new nsHttpServer();
httpserv.registerDirectory("/", do_get_cwd());
let tmpDir = Cc["@mozilla.org/file/directory_service;1"].
getService(Ci.nsIProperties).
get("TmpD", Ci.nsIFile);
const nsIWBP = Ci.nsIWebBrowserPersist;
// make sure we're starting with an empty DB
do_check_eq(dm.activeDownloadCount, 0);
let listener = {
phase: 1,
handledC: false,
onDownloadStateChange: function(aState, aDownload)
{
switch (aDownload.state) {
case dm.DOWNLOAD_FAILED:
case dm.DOWNLOAD_CANCELED:
case dm.DOWNLOAD_DIRTY:
case dm.DOWNLOAD_BLOCKED_POLICY:
// Fail!
if (aDownload.targetFile.exists())
aDownload.targetFile.remove(false);
dm.removeListener(this);
do_throw("Download failed (name: " + aDownload.displayName + ", state: " + aDownload.state + ")");
do_test_finished();
break;
// We need to wait until Download-C has started, because otherwise it
// won't be resumable, so the private browsing mode won't correctly pause it.
case dm.DOWNLOAD_DOWNLOADING:
if (aDownload.id == downloadC && !this.handledC && this.phase == 2) {
// Sanity check: Download-C must be resumable
do_check_true(dlC.resumable);
// Enter private browsing mode immediately
pb.privateBrowsingEnabled = true;
do_check_true(pb.privateBrowsingEnabled);
// Check that Download-C is paused and not accessible
do_check_eq(dlC.state, dm.DOWNLOAD_PAUSED);
do_check_eq(dm.activeDownloadCount, 0);
do_check_false(is_download_available(downloadC, downloadCSource,
fileC, downloadCName));
// Exit private browsing mode
pb.privateBrowsingEnabled = false;
do_check_false(pb.privateBrowsingEnabled);
// Check that Download-A is accessible
do_check_true(is_download_available(downloadA, downloadASource,
fileA, downloadAName));
// Check that Download-B is not accessible
do_check_false(is_download_available(downloadB, downloadBSource,
fileB, downloadBName));
// Check that Download-C is accessible
do_check_true(is_download_available(downloadC, downloadCSource,
fileC, downloadCName));
// only perform these checks the first time that Download-C is started
this.handledC = true;
}
break;
case dm.DOWNLOAD_FINISHED:
do_check_true(aDownload.targetFile.exists());
aDownload.targetFile.remove(false);
this.onDownloadFinished();
break;
}
},
onStateChange: function(a, b, c, d, e) { },
onProgressChange: function(a, b, c, d, e, f, g) { },
onSecurityChange: function(a, b, c, d) { },
onDownloadFinished: function () {
switch (this.phase) {
case 1: {
do_check_eq(dm.activeDownloadCount, 0);
// Enter private browsing mode
pb.privateBrowsingEnabled = true;
do_check_true(pb.privateBrowsingEnabled);
// Check that Download-A is not accessible
do_check_false(is_download_available(downloadA, downloadASource,
fileA, downloadAName));
// Create Download-B
let dlB = addDownload({
targetFile: fileB,
sourceURI: downloadBSource,
downloadName: downloadBName,
runBeforeStart: function (aDownload) {
// Check that Download-B is retrievable
do_check_eq(dm.activeDownloadCount, 1);
do_check_true(is_active_download_available(aDownload.id,
downloadBSource, fileB, downloadBName));
do_check_true(is_download_available(aDownload.id,
downloadBSource, fileB, downloadBName));
}
});
downloadB = dlB.id;
// wait for Download-B to finish
++this.phase;
}
break;
case 2: {
do_check_eq(dm.activeDownloadCount, 0);
// Exit private browsing mode
pb.privateBrowsingEnabled = false;
do_check_false(pb.privateBrowsingEnabled);
// Check that Download-A is accessible
do_check_true(is_download_available(downloadA, downloadASource,
fileA, downloadAName));
// Check that Download-B is not accessible
do_check_false(is_download_available(downloadB, downloadBSource,
fileB, downloadBName));
// Create Download-C
httpserv.start(4444);
dlC = addDownload({
targetFile: fileC,
sourceURI: downloadCSource,
downloadName: downloadCName,
runBeforeStart: function (aDownload) {
// Check that Download-C is retrievable
do_check_eq(dm.activeDownloadCount, 1);
do_check_true(is_active_download_available(aDownload.id,
downloadCSource, fileC, downloadCName));
do_check_true(is_download_available(aDownload.id,
downloadCSource, fileC, downloadCName));
}
});
downloadC = dlC.id;
// wait for Download-C to finish
++this.phase;
}
break;
case 3: {
do_check_eq(dm.activeDownloadCount, 0);
// Check that Download-A is accessible
do_check_true(is_download_available(downloadA, downloadASource,
fileA, downloadAName));
// Check that Download-B is not accessible
do_check_false(is_download_available(downloadB, downloadBSource,
fileB, downloadBName));
// Check that Download-C is accessible
do_check_true(is_download_available(downloadC, downloadCSource,
fileC, downloadCName));
// cleanup
prefBranch.clearUserPref("browser.privatebrowsing.keep_current_session");
dm.removeListener(this);
httpserv.stop(do_test_finished);
}
break;
default:
do_throw("Unexpected phase: " + this.phase);
break;
}
}
};
dm.addListener(listener);
dm.addListener(getDownloadListener());
// properties of Download-A
let downloadA = -1;
const downloadASource = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAAAXNSR0IArs4c6QAAAAZiS0dEAP8A/wD/oL2nkwAAAAlwSFlzAAALEwAACxMBAJqcGAAAAAd0SU1FB9gKHhQaLFEVkXsAAAAIdEVYdENvbW1lbnQA9syWvwAABXZJREFUaN7VmnuIVUUcxz/3uma5ZJJmrZGVuZWupGSZsVNwTRYJYk8vRzd6o0kglgpm9q/ZEhlBUEssUpTtqMixl6LlURtDwyzCWmLxkZZL6qZRi/nc/tjf2Ybjufd6797HOrDM7NzfmfP9zfzm9zxwkbdEIRYxyhsCTAYmAWOBkcAwYBBwFugEDgN7gd3AdmCTtn5HWRkwynsamA7U5bnEBqBFW395SRkwylsIzAWqnOnvgTVAG3AIOA4cAwYAlwFDgZuAUcB4YApQIc+2A29p6zcWlQGjvEeBJUC1TO0BmoAPtfXbc1yrH/AwMB+YKNNtwGJt/VUFZ8Ao713gOfn3O2CBtv7mAt2hUcAi4BmZatLWn10QBozyRgArgFoRixe09d8vhkYxypsKfAwMBrYBDdr6B/JmwChvNLBWRCYA6rX1/y6mWjTKqwQ+BVIiUvXa+q3p6JNZdj4E3wJMKTZ4AG39TuA+oFnevVaw5MaAiE01sEJbf4a2/rlSGSdt/S5gJrAqxJATA3Jha4GdwFPlsLDChBZbUSuYst8BUZUr5cKOyVU9FuFODAZagWuAaVEVG3cCS6SfWW7wchLHgcci2OIZEAtbDWzR1l/dVxw2bf1N4X0QjD2tIkI7V/oF7qQyqa40a58Rd6EVWA+8Z3VwNI4wwxqIs/e7OHnNVgdbY2gWAQ8JxsbzTkAcsyog0NbfeYGbUwFcBdwLvAq0KpNK5bHJlcDNwBPAFmVS7yiTSkZOYQ+wGqgSrOeJ0HTpmzO9yeogEf6JozZOrCfisK1VJjUihzWSwNXiRhwTktnA8zGPNkewdjMg/nwdcBr45EK3zerglNXBj1YHDSKjAJdHRTDLGl1WB4etDpYDs5yfZsWQfwUcAeoEc88JTA4JemFtX3fG+cYH651xdcxlPgd84WIOGZgk/Te9UBa7nfF1ea7hXvR/09BsdzGHDIyV/ucya8ypzvjrNDS7XMyhGh0p/S+9ePlYZ3zwQh9SJpUAhgD3A8tk+i/g5TSP7HcxhwwMk/5ILxiY74w3ZgGdziYclQiv0epgXxqaDhG1YS4DlY5hIofd6w/cAiwUxwvgH+CNPDdhKHAnMAHYl8YqnzXKOxFirsj1DVksagcw3epgfzY7EFmzUkRwLjADWKVM6k2rg3lplhgQNWSd0g/KkZ8zAtoCrwCjrQ6+zHVTrA46rQ52iD35SKZfVCZVH+OdDgT6hZjDEzgs4G9Md3Tpdq8IbZnjfc6RqNBtwx3MPSewV/pRfcD5dFX5HTG/17iYkxEjNIG+1S6NmRvvYk5GrFtdHwBd44x/i/l9sos5ZGCT9DcY5Y0pMwOuPVkXucBXSqzegzkpurVDgmeAhlIjViY1UJnUXcqkWkSNIq710qgZEA20Icxsu3agRURojlHeEm39E0UE3JWF5FfgEauDQ87uJ5yIseW8gEZS3O2iTp8s8SGcpDujvU4CmRqrg2hU+IBY/XY3HZ+ICepfk8VGauuf7AuqyCivQtRrNfCSm4aPxp2Nko8cLoz0lTZPwLdFawhxeaHFYYbCKK+2D+z+bU4+aHHW1KJkvppEvNYY5VWVOSv3mSibprjCRyLDw1Z07i5gkrb+6RKDvwTYDNwNbNPWV3F0mbLTDXIfbges5O1LBf4K4FsB35bJNiUzpPMOAPWywETgJ6O860sA/lpxE8bxf4EjbZUm1xLTn8CD2vpbiwA8IdpmKdCfQpSYIi9wi3yfA89q6/9RIPC3Ah9IOAmFLPJFXuSWWbskenpbW39HnsZpGvC4k04pXpk1xmK7he6DdKckNwI/AAejJSkJBWvorn/dI35XaQvdMYxk+tTgEHBKsgeDRa6jrTyfGsQwUraPPS769h+G3Ox+KOb9iAAAAABJRU5ErkJggg==";
const downloadADest = "download-file-A";
const downloadAName = "download-A";
// properties of Download-B
let downloadB = -1;
const downloadBSource = "data:application/octet-stream;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAAAXNSR0IArs4c6QAAAAZiS0dEAP8A/wD/oL2nkwAAAAlwSFlzAAALEwAACxMBAJqcGAAAAAd0SU1FB9gKHhQaLFEVkXsAAAAIdEVYdENvbW1lbnQA9syWvwAABXZJREFUaN7VmnuIVUUcxz/3uma5ZJJmrZGVuZWupGSZsVNwTRYJYk8vRzd6o0kglgpm9q/ZEhlBUEssUpTtqMixl6LlURtDwyzCWmLxkZZL6qZRi/nc/tjf2Ybjufd6797HOrDM7NzfmfP9zfzm9zxwkbdEIRYxyhsCTAYmAWOBkcAwYBBwFugEDgN7gd3AdmCTtn5HWRkwynsamA7U5bnEBqBFW395SRkwylsIzAWqnOnvgTVAG3AIOA4cAwYAlwFDgZuAUcB4YApQIc+2A29p6zcWlQGjvEeBJUC1TO0BmoAPtfXbc1yrH/AwMB+YKNNtwGJt/VUFZ8Ao713gOfn3O2CBtv7mAt2hUcAi4BmZatLWn10QBozyRgArgFoRixe09d8vhkYxypsKfAwMBrYBDdr6B/JmwChvNLBWRCYA6rX1/y6mWjTKqwQ+BVIiUvXa+q3p6JNZdj4E3wJMKTZ4AG39TuA+oFnevVaw5MaAiE01sEJbf4a2/rlSGSdt/S5gJrAqxJATA3Jha4GdwFPlsLDChBZbUSuYst8BUZUr5cKOyVU9FuFODAZagWuAaVEVG3cCS6SfWW7wchLHgcci2OIZEAtbDWzR1l/dVxw2bf1N4X0QjD2tIkI7V/oF7qQyqa40a58Rd6EVWA+8Z3VwNI4wwxqIs/e7OHnNVgdbY2gWAQ8JxsbzTkAcsyog0NbfeYGbUwFcBdwLvAq0KpNK5bHJlcDNwBPAFmVS7yiTSkZOYQ+wGqgSrOeJ0HTpmzO9yeogEf6JozZOrCfisK1VJjUihzWSwNXiRhwTktnA8zGPNkewdjMg/nwdcBr45EK3zerglNXBj1YHDSKjAJdHRTDLGl1WB4etDpYDs5yfZsWQfwUcAeoEc88JTA4JemFtX3fG+cYH651xdcxlPgd84WIOGZgk/Te9UBa7nfF1ea7hXvR/09BsdzGHDIyV/ucya8ypzvjrNDS7XMyhGh0p/S+9ePlYZ3zwQh9SJpUAhgD3A8tk+i/g5TSP7HcxhwwMk/5ILxiY74w3ZgGdziYclQiv0epgXxqaDhG1YS4DlY5hIofd6w/cAiwUxwvgH+CNPDdhKHAnMAHYl8YqnzXKOxFirsj1DVksagcw3epgfzY7EFmzUkRwLjADWKVM6k2rg3lplhgQNWSd0g/KkZ8zAtoCrwCjrQ6+zHVTrA46rQ52iD35SKZfVCZVH+OdDgT6hZjDEzgs4G9Md3Tpdq8IbZnjfc6RqNBtwx3MPSewV/pRfcD5dFX5HTG/17iYkxEjNIG+1S6NmRvvYk5GrFtdHwBd44x/i/l9sos5ZGCT9DcY5Y0pMwOuPVkXucBXSqzegzkpurVDgmeAhlIjViY1UJnUXcqkWkSNIq710qgZEA20Icxsu3agRURojlHeEm39E0UE3JWF5FfgEauDQ87uJ5yIseW8gEZS3O2iTp8s8SGcpDujvU4CmRqrg2hU+IBY/XY3HZ+ICepfk8VGauuf7AuqyCivQtRrNfCSm4aPxp2Nko8cLoz0lTZPwLdFawhxeaHFYYbCKK+2D+z+bU4+aHHW1KJkvppEvNYY5VWVOSv3mSibprjCRyLDw1Z07i5gkrb+6RKDvwTYDNwNbNPWV3F0mbLTDXIfbges5O1LBf4K4FsB35bJNiUzpPMOAPWywETgJ6O860sA/lpxE8bxf4EjbZUm1xLTn8CD2vpbiwA8IdpmKdCfQpSYIi9wi3yfA89q6/9RIPC3Ah9IOAmFLPJFXuSWWbskenpbW39HnsZpGvC4k04pXpk1xmK7he6DdKckNwI/AAejJSkJBWvorn/dI35XaQvdMYxk+tTgEHBKsgeDRa6jrTyfGsQwUraPPS769h+G3Ox+KOb9iAAAAABJRU5ErkJggg==";
const downloadBDest = "download-file-B";
const downloadBName = "download-B";
// properties of Download-C
let downloadC = -1;
const downloadCSource = "http://localhost:4444/head_download_manager.js";
const downloadCDest = "download-file-C";
const downloadCName = "download-C";
// Create all target files
let fileA = tmpDir.clone();
fileA.append(downloadADest);
fileA.createUnique(Ci.nsIFile.NORMAL_FILE_TYPE, 0666);
let fileB = tmpDir.clone();
fileB.append(downloadBDest);
fileB.createUnique(Ci.nsIFile.NORMAL_FILE_TYPE, 0666);
let fileC = tmpDir.clone();
fileC.append(downloadCDest);
fileC.createUnique(Ci.nsIFile.NORMAL_FILE_TYPE, 0666);
// use js closures to access dlC
let dlC;
// Create Download-A
let dlA = addDownload({
targetFile: fileA,
sourceURI: downloadASource,
downloadName: downloadAName,
runBeforeStart: function (aDownload) {
// Check that Download-A is retrievable
do_check_eq(dm.activeDownloadCount, 1);
do_check_true(is_active_download_available(aDownload.id, downloadASource, fileA, downloadAName));
do_check_true(is_download_available(aDownload.id, downloadASource, fileA, downloadAName));
}
});
downloadA = dlA.id;
// wait for Download-A to finish
}