The Tor Browser / file revision

 // -*- Mode: js2; tab-width: 2; indent-tabs-mode: nil; js2-basic-offset: 2; js2-skip-preprocessor-directives: t; -*-

 /* This Source Code Form is subject to the terms of the Mozilla Public

  * License, v. 2.0. If a copy of the MPL was not distributed with this

  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

 "use strict";

 const Ci = Components.interfaces;

 const Cm = Components.manager;

 const Cc = Components.classes;

 const CONTRACT_ID = "@mozilla.org/xre/runtime;1";

 function MockAppInfo() {

 }

 MockAppInfo.prototype = {

   QueryInterface: XPCOMUtils.generateQI([Ci.nsIXULRuntime]),

 }

 let newFactory = {

   createInstance: function(aOuter, aIID) {

     if (aOuter)

       throw Components.results.NS_ERROR_NO_AGGREGATION;

     return new MockAppInfo().QueryInterface(aIID);

   },

   lockFactory: function(aLock) {

     throw Components.results.NS_ERROR_NOT_IMPLEMENTED;

   },

   QueryInterface: XPCOMUtils.generateQI([Ci.nsIFactory])

 };

 var SanitizeHelper = {

   _originalSanitizer: null,

   MockSanitizer: {

     clearCalled: [],

     clearItem: function clearItem(aItemName) {

       info("Clear item called for: " + aItemName);

       this.clearCalled.push(aItemName);

     }

   },

   setUp: function setUp() {

     SanitizeHelper._originalSanitizer = SanitizeUI._sanitizer;

     SanitizeUI._sanitizer = SanitizeHelper.MockSanitizer;

     let registrar = Cm.QueryInterface(Ci.nsIComponentRegistrar);

     this.gAppInfoClassID = registrar.contractIDToCID(CONTRACT_ID);

     this.gIncOldFactory = Cm.getClassObject(Cc[CONTRACT_ID], Ci.nsIFactory);

     registrar.unregisterFactory(this.gAppInfoClassID, this.gIncOldFactory);

     let components = [MockAppInfo];

     registrar.registerFactory(this.gAppInfoClassID, "", CONTRACT_ID, newFactory);

     this.gIncOldFactory = Cm.getClassObject(Cc[CONTRACT_ID], Ci.nsIFactory);

     this.oldPrompt = Services.prompt;

   },

   tearDown: function tearDown() {

     SanitizeUI._sanitizer = SanitizeHelper._originalSanitizer;

     if (this.gIncOldFactory) {

       var registrar = Cm.QueryInterface(Ci.nsIComponentRegistrar);

       registrar.unregisterFactory(this.gAppInfoClassID, newFactory);

       registrar.registerFactory(this.gAppInfoClassID, "", CONTRACT_ID, this.gIncOldFactory);

     }

     this.gIncOldFactory = null;

     Services.prompt = this.oldPrompt;

   },

 };

 function getAllSelected() {

   return document.getElementById("prefs-privdata").querySelectorAll(

     "#prefs-privdata-history[checked], " +

       "#prefs-privdata-other[checked] + #prefs-privdata-subitems .privdata-subitem-item[checked]");

 }

 gTests.push({

   setUp: SanitizeHelper.setUp,

   tearDown: SanitizeHelper.tearDown,

   desc: "Test sanitizer UI",

   run: function testSanitizeUI() {

     // We want to be able to simulate that a specific button

     // of the 'clear private data' prompt was pressed.

     Services.prompt = {

       confirmEx: function() {

         return this.retVal;

       }

     };

     // Show options flyout

     let promise = waitForEvent(FlyoutPanelsUI.PrefsFlyoutPanel._topmostElement, "PopupChanged", 2000);

     FlyoutPanelsUI.show('PrefsFlyoutPanel');

     yield promise;

     // Make sure it's opened

     yield waitForEvent(FlyoutPanelsUI.PrefsFlyoutPanel._topmostElement, "transitionend", 1000);

     SanitizeHelper.setUp();

     // Test initial state

     let allSelected = getAllSelected();

     // Only  history should be selected

     ok(allSelected.length === 1 && allSelected[0].getAttribute("itemName") === "history", "History is initially selected.");

     let othersCheck = document.getElementById("prefs-privdata-other");

     othersCheck.setAttribute("checked", "true");

     let othersSubitems = document.getElementById("prefs-privdata-subitems");

     yield waitForCondition(function (){

       return othersSubitems.style.display !== "none";

     }, 500);

     allSelected = getAllSelected();

     // History and all checkboxes under othersSubitems should be selected

     ok(allSelected.length === 1 + othersSubitems.querySelectorAll("checkbox").length,

       "All checkboxes are selected.");

     // Select only downloads and passwords

     let callItems = ["downloads", "passwords"];

     for (let checkbox of allSelected) {

       if (callItems.indexOf(checkbox.getAttribute("itemName")) === -1) {

         checkbox.removeAttribute("checked");

       }

     }

     // Simulate clicking "button 1", cancel.

     Services.prompt.retVal = 1;

     let clearButton = document.getElementById("prefs-clear-data");

     clearButton.doCommand();

     ok(SanitizeHelper.MockSanitizer.clearCalled.length == 0, "Nothing was cleared");

     // We will simulate that "button 0" (which should be the clear button)

     // was pressed

     Services.prompt.retVal = 0;

     clearButton.doCommand();

     let clearNotificationDeck = document.getElementById("clear-notification");

     let clearNotificationDone = document.getElementById("clear-notification-done");

     // Wait until command is done.

     yield waitForCondition(function (){

       return clearNotificationDeck.selectedPanel == clearNotificationDone;

     }, 1000);

     ok(SanitizeHelper.MockSanitizer.clearCalled.length === callItems.length, "All expected items were called");

     SanitizeHelper.MockSanitizer.clearCalled.forEach(function(item) {

       ok(callItems.indexOf(item) >= 0, "Sanitized " + item);

     });

     // hide options flyout

     let promise = waitForEvent(FlyoutPanelsUI.PrefsFlyoutPanel._topmostElement, "PopupChanged", 2000);

     FlyoutPanelsUI.hide();

     yield promise;

   }

 });

 function checkDNTPrefs(aExpectedEnabled, aExpectedValue) {

   let currentEnabled = Services.prefs.getBoolPref("privacy.donottrackheader.enabled");

   let currentValue = Services.prefs.getIntPref("privacy.donottrackheader.value");

   let enabledTestMsg = "testing privacy.donottrackheader.enabled, expected "

     + aExpectedEnabled + " got " + currentEnabled;

   ok(aExpectedEnabled === currentEnabled, enabledTestMsg);

   let valueTestMsg = "testing privacy.donottrackheader.value, expected "

     + aExpectedValue + " got " + currentValue;

   ok(aExpectedValue === currentValue, valueTestMsg);

 }

 gTests.push({

   desc: "Test do not track settings",

   run: function testDNT() {

     let noTrack = document.getElementById("prefs-dnt-notrack");

     let noPref = document.getElementById("prefs-dnt-nopref");

     let okTrack = document.getElementById("prefs-dnt-oktrack");

     // Show options flyout

     let promise = waitForEvent(FlyoutPanelsUI.PrefsFlyoutPanel._topmostElement, "PopupChanged", 2000);

     FlyoutPanelsUI.show('PrefsFlyoutPanel');

     yield promise;

     noPref.click();

     // See https://mxr.mozilla.org/mozilla-central/source/modules/libpref/src/init/all.js?rev=0aab2bb76b45#755

     // -1 - tell sites nothing about preferences

     yield waitForCondition(() => Services.prefs.getIntPref("privacy.donottrackheader.value") === -1);

     checkDNTPrefs(false, -1);

     noTrack.click();

     // 1 - tell sites tracking is unacceptable

     yield waitForCondition(() => Services.prefs.getIntPref("privacy.donottrackheader.value") === 1);

     checkDNTPrefs(true, 1);

     okTrack.click();

     // 0 - tell sites tracking is acceptable

     yield waitForCondition(() => Services.prefs.getIntPref("privacy.donottrackheader.value") === 0);

     checkDNTPrefs(true, 0);

     // hide options flyout

     let promise = waitForEvent(FlyoutPanelsUI.PrefsFlyoutPanel._topmostElement, "PopupChanged", 2000);

     FlyoutPanelsUI.hide();

     yield promise;

   }

 });

 function test() {

   runTests();

 }