Support command and search history in 'per-window private mode'

In non-private mode commands and searches are stored in global
'history-command' and 'history-search' stores respectively.

Since Firefox 20 the private browsing mode is on per window basis.

To support command and search history in per-window private mode:

    - Save command and search entries for each private (incognito)
      window opened in
            'private-XXX-history-command' or
            'private-XXX-history-search'
      store, where XXX is the private window's unique id.

    - When the last private window is closed or Firefox itself is closed
      delete all existing 'private-XXX-*' private stores.

    - Note: There's no reliable way of detecting when a private window
      is being closed, Firefox only notifies addons when the last private
      window is being closed. This is a reason why the private stores
      are only deleted when the 'last private window close' event is
      caught.

Fixes #137

Author: zklinger

common/content/commandline.js

@@ -19,29 +19,42 @@ const CommandLine = Module("commandline", {
 
         this._callbacks = {};
 
-        storage.newArray("history-search", { store: true, privateData: true });
-        storage.newArray("history-command", { store: true, privateData: true });
+        ["search", "command"].forEach(function (mode) {
+            let isPrivate = liberator.isPrivateWindow();
+            storage.newArray(liberator.storeName(mode, isPrivate), { store: !isPrivate});
+        }, this);
 
         // Really inideal.
         let services = modules.services; // Storage objects are global to all windows, 'modules' isn't.
         storage.newObject("sanitize", function () {
             ({
                 CLEAR: "browser:purge-session-history",
                 QUIT:  "quit-application",
+                PRIVATE_END: "last-pb-context-exited",
+
                 init: function () {
                     services.get("obs").addObserver(this, this.CLEAR, false);
                     services.get("obs").addObserver(this, this.QUIT, false);
+                    services.get("obs").addObserver(this, this.PRIVATE_END, false);
                 },
                 observe: function (subject, topic, data) {
                     switch (topic) {
                     case this.CLEAR:
                         ["search", "command"].forEach(function (mode) {
-                            CommandLine.History(null, mode).sanitize();
-                        });
+                            CommandLine.History(null, mode, liberator.isPrivateWindow()).sanitize();
+                        }, this);
+                        break;
+                    case this.PRIVATE_END:
+                        for (let [key, obj] in Iterator(storage)) {
+                            if (key.match(/^private-[0-9]/)) {
+                                    delete storage[key];
+                                }
+                        }
                         break;
                     case this.QUIT:
                         services.get("obs").removeObserver(this, this.CLEAR);
                         services.get("obs").removeObserver(this, this.QUIT);
+                        services.get("obs").removeObserver(this, this.PRIVATE_END);
                         break;
                     }
                 }
@@ -471,7 +484,9 @@ const CommandLine = Module("commandline", {
 
         this.show();
 
-        this._history = CommandLine.History(this._commandWidget.inputField, (modes.extended == modes.EX) ? "command" : "search");
+        this._history = CommandLine.History(this._commandWidget.inputField,
+                (modes.extended == modes.EX) ? "command" : "search",
+                liberator.isPrivateWindow());
         this._completions = CommandLine.Completions(this._commandWidget.inputField);
 
         // open the completion list automatically if wanted
@@ -662,7 +677,9 @@ const CommandLine = Module("commandline", {
         this.show();
         this._commandWidget.focus();
 
-        this._history = CommandLine.History(this._commandWidget.inputField, (modes.extended == modes.EX) ? "command" : "search");
+        this._history = CommandLine.History(this._commandWidget.inputField,
+                (modes.extended == modes.EX) ? "command" : "search",
+                liberator.isPrivateWindow());
         this._completions = CommandLine.Completions(this._commandWidget.inputField);
     },
 
@@ -1032,10 +1049,11 @@ const CommandLine = Module("commandline", {
      * @param {string} mode The mode for which we need history.
      */
     History: Class("History", {
-        init: function (inputField, mode) {
+        init: function (inputField, mode, privateBrowsing) {
             this.mode = mode;
             this.input = inputField;
-            this.store = storage["history-" + mode];
+            this.storeName = liberator.storeName(mode, privateBrowsing);
+            this.store = storage[this.storeName];
             this.reset();
         },
         /**

common/content/liberator.js

@@ -254,6 +254,25 @@ const Liberator = Module("liberator", {
         window.dump(msg.replace(/^./gm, ("config" in modules && config.name.toLowerCase()) + ": $&"));
     },
 
+    isPrivateWindow: function () {
+        return window.QueryInterface(Ci.nsIInterfaceRequestor)
+                     .getInterface(Ci.nsIWebNavigation)
+                     .QueryInterface(Ci.nsILoadContext)
+                     .usePrivateBrowsing;
+    },
+
+    windowID: function() {
+        return window.QueryInterface(Components.interfaces.nsIInterfaceRequestor)
+                     .getInterface(Components.interfaces.nsIDOMWindowUtils)
+                     .outerWindowID;
+
+    },
+
+    storeName: function(mode, isPrivate) {
+        let prefix = isPrivate ? "private-" + this.windowID() + "-" : "";
+        return prefix + "history-" + mode ;
+    },
+
     /**
      * Outputs a plain message to the command line.
      *
@@ -1171,10 +1190,7 @@ const Liberator = Module("liberator", {
                         win.setAttribute("titlemodifier_normal", value);
                         win.setAttribute("titlemodifier_privatebrowsing", value + suffix);
 
-                        if (window.QueryInterface(Ci.nsIInterfaceRequestor)
-                                  .getInterface(Ci.nsIWebNavigation)
-                                  .QueryInterface(Ci.nsILoadContext)
-                                  .usePrivateBrowsing) {
+                        if (liberator.isPrivateWindow()) {
                             win.setAttribute("titlemodifier", value + suffix);
                         }
                         else

common/content/sanitizer.js

@@ -74,7 +74,7 @@ const Sanitizer = Module("sanitizer", {
         commands.add(["sa[nitize]"],
             "Clear private data",
             function (args) {
-                liberator.assert(!options['private'], "Cannot sanitize items in private mode");
+                liberator.assert(!liberator.isPrivateWindow(), "Cannot sanitize items in private mode");
 
                 let timespan = args["-timespan"] == undefined ? options["sanitizetimespan"] : args["-timespan"];
 

common/modules/storage.jsm

@@ -151,8 +151,6 @@ function loadPref(name, store, type) {
 }
 
 function savePref(obj) {
-    if (obj.privateData)
-        return;
     if (obj.store && storage.infoPath)
         writeFile(getFile(obj.name), obj.serial);
 }

vimperator/NEWS

@@ -6,6 +6,7 @@
     * Make <Ctrl-[> key always behave like <Esc> key (was missing from the command line handler)
     * Add support for :set hintmatching=fuzzy as a new, alternative way for hintmatching.
     * Don't display help message in command line for a normal click.
+    * Keep search history and command line history private in 'Private Browsing' mode.
 
 2014-11-09
     * Version 3.8.3