Bug 464199 - Forget About this Site doesn't forget about recently closed tabs. r=gavin.sharp

browser/components/privatebrowsing/src/nsPrivateBrowsingService.js

@@ -20,6 +20,7 @@
 #
 # Contributor(s):
 #  Ehsan Akhgari <ehsan.akhgari@gmail.com> (Original Author)
+#  Simon Bünzli <zeniko@gmail.com>
 #
 # 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
@@ -400,7 +401,7 @@ PrivateBrowsingService.prototype = {
       }
       // XXXehsan: is there a better way to do this rather than this
       // hacky comparison?
-      catch (ex if ex == "User canceled Master Password entry") {}
+      catch (ex if ex.message.indexOf("User canceled Master Password entry") != -1) { }
 
       // Clear any "do not save for this site" for this domain
       let disabledHosts = lm.getAllDisabledHosts({});
@@ -455,6 +456,9 @@ PrivateBrowsingService.prototype = {
         }
       }
     }
+
+    // Everybody else (including extensions)
+    this._obs.notifyObservers(null, "browser:purge-domain-data", aDomain);
   }
 };
 

browser/components/sessionstore/src/nsSessionStore.js

@@ -73,7 +73,7 @@ const OBSERVING = [
   "domwindowopened", "domwindowclosed",
   "quit-application-requested", "quit-application-granted",
   "quit-application", "browser:purge-session-history",
-  "private-browsing"
+  "private-browsing", "browser:purge-domain-data"
 ];
 
 /*
@@ -348,6 +348,27 @@ SessionStoreService.prototype = {
       if ("_stateBackup" in this)
         delete this._stateBackup;
       break;
+    case "browser:purge-domain-data":
+      // does a session history entry contain a url for the given domain?
+      function containsDomain(aEntry) {
+        try {
+          if (this._getURIFromString(aEntry.url).host.hasRootDomain(aData))
+            return true;
+        }
+        catch (ex) { /* url had no host at all */ }
+        return aEntry.children && aEntry.children.some(containsDomain, this);
+      }
+      // remove all closed tabs containing a reference to the given domain
+      for (let ix in this._windows) {
+        let closedTabs = this._windows[ix]._closedTabs;
+        for (let i = closedTabs.length - 1; i >= 0; i--) {
+          if (closedTabs[i].state.entries.some(containsDomain, this))
+            closedTabs.splice(i, 1);
+        }
+      }
+      if (this._loadState == STATE_RUNNING)
+        this.saveState(true);
+      break;
     case "nsPref:changed": // catch pref changes
       switch (aData) {
       // if the user decreases the max number of closed tabs they want
@@ -2640,5 +2661,20 @@ let XPathHelper = {
   }
 };
 
+// see nsPrivateBrowsingService.js
+String.prototype.hasRootDomain = function hasRootDomain(aDomain)
+{
+  let index = this.indexOf(aDomain);
+  if (index == -1)
+    return false;
+
+  if (this == aDomain)
+    return true;
+
+  let prevChar = this[index - 1];
+  return (index == (this.length - aDomain.length)) &&
+         (prevChar == "." || prevChar == "/");
+}
+
 function NSGetModule(aComMgr, aFileSpec)
   XPCOMUtils.generateModule([SessionStoreService]);

browser/components/sessionstore/test/browser/Makefile.in

@@ -65,6 +65,7 @@ _BROWSER_TEST_FILES = \
 	browser_456342_sample.xhtml \
 	browser_463206.js \
 	browser_463206_sample.html \
+	browser_464199.js \
 	browser_465215.js \
 	browser_465223.js \
 	browser_466937.js \

browser/components/sessionstore/test/browser/browser_464199.js

@@ -0,0 +1,109 @@
+/* ***** 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 sessionstore test code.
+ *
+ * The Initial Developer of the Original Code is
+ * Simon Bünzli <zeniko@gmail.com>.
+ * 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 ***** */
+
+function test() {
+  /** Test for Bug 464199 **/
+  
+  // test setup
+  let ss = Cc["@mozilla.org/browser/sessionstore;1"].getService(Ci.nsISessionStore);
+  waitForExplicitFinish();
+  
+  const REMEMBER = Date.now(), FORGET = Math.random();
+  let test_state = { windows: [{ "tabs": [{ "entries": [] }], _closedTabs: [
+    { state: { entries: [{ url: "http://www.example.net/" }] }, title: FORGET },
+    { state: { entries: [{ url: "http://www.example.org/" }] }, title: REMEMBER },
+    { state: { entries: [{ url: "http://www.example.net/" },
+                         { url: "http://www.example.org/" }] }, title: FORGET },
+    { state: { entries: [{ url: "http://example.net/" }] }, title: FORGET },
+    { state: { entries: [{ url: "http://sub.example.net/" }] }, title: FORGET },
+    { state: { entries: [{ url: "http://www.example.net:8080/" }] }, title: FORGET },
+    { state: { entries: [{ url: "about:license" }] }, title: REMEMBER },
+    { state: { entries: [{ url: "http://www.example.org/frameset",
+                           children: [
+                             { url: "http://www.example.org/frame" },
+                             { url: "http://www.example.org:8080/frame2" }
+                           ] }] }, title: REMEMBER },
+    { state: { entries: [{ url: "http://www.example.org/frameset",
+                           children: [
+                             { url: "http://www.example.org/frame" },
+                             { url: "http://www.example.net/frame" }
+                           ] }] }, title: FORGET },
+    { state: { entries: [{ url: "http://www.example.org/form",
+                           formdata: { "#url": "http://www.example.net/" }
+                         }] }, title: REMEMBER },
+    { state: { entries: [{ url: "http://www.example.org/form" }],
+               extData: { "setTabValue": "http://example.net:80" } }, title: REMEMBER }
+  ] }] };
+  let remember_count = 5;
+  
+  function countByTitle(aClosedTabList, aTitle)
+    aClosedTabList.filter(function(aData) aData.title == aTitle).length;
+  
+  // open a window and add the above closed tab list
+  let newWin = openDialog(location, "_blank", "chrome,all,dialog=no");
+  newWin.addEventListener("load", function(aEvent) {
+    let max_tabs_undo = gPrefService.getIntPref("browser.sessionstore.max_tabs_undo");
+    gPrefService.setIntPref("browser.sessionstore.max_tabs_undo",
+                            test_state.windows[0]._closedTabs.length);
+    ss.setWindowState(newWin, JSON.stringify(test_state), true);
+    
+    let closedTabs = eval("(" + ss.getClosedTabData(newWin) + ")");
+    is(closedTabs.length, test_state.windows[0]._closedTabs.length,
+       "Closed tab list has the expected length");
+    is(countByTitle(closedTabs, FORGET),
+       test_state.windows[0]._closedTabs.length - remember_count,
+       "The correct amout of tabs are to be forgotten");
+    is(countByTitle(closedTabs, REMEMBER), remember_count,
+       "Everything is set up.");
+    
+    let pb = Cc["@mozilla.org/privatebrowsing;1"].
+             getService(Ci.nsIPrivateBrowsingService);
+    pb.removeDataFromDomain("example.net");
+    
+    closedTabs = eval("(" + ss.getClosedTabData(newWin) + ")");
+    is(closedTabs.length, remember_count,
+       "The correct amout of tabs was removed");
+    is(countByTitle(closedTabs, FORGET), 0,
+       "All tabs to be forgotten were indeed removed");
+    is(countByTitle(closedTabs, REMEMBER), remember_count,
+       "... and tabs to be remembered weren't.");
+    
+    // clean up
+    newWin.close();
+    gPrefService.setIntPref("browser.sessionstore.max_tabs_undo", max_tabs_undo);
+    finish();
+  }, false);
+}