Bug 248970 - Private Browsing mode (global toggle for saving/caching everything) [contentprefs part]; r=mconnor
authorEhsan Akhgari <ehsan.akhgari@gmail.com>
Mon, 20 Oct 2008 00:46:22 +0330
changeset 20638 81e6937843a7
parent 20637 e9b859357547
child 20639 ee936d0fd358
push id3021
push userehsan.akhgari@gmail.com
push date2008-10-19 21:18 +0000
treeherdermozilla-central@ee936d0fd358 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersmconnor
bugs248970
milestone1.9.1b2pre
Bug 248970 - Private Browsing mode (global toggle for saving/caching everything) [contentprefs part]; r=mconnor
toolkit/components/contentprefs/src/nsContentPrefService.js
toolkit/components/contentprefs/tests/unit/test_bug248970.js
--- a/toolkit/components/contentprefs/src/nsContentPrefService.js
+++ b/toolkit/components/contentprefs/src/nsContentPrefService.js
@@ -14,16 +14,17 @@
  * The Original Code is Content Preferences (cpref).
  *
  * The Initial Developer of the Original Code is Mozilla.
  * Portions created by the Initial Developer are Copyright (C) 2006
  * the Initial Developer. All Rights Reserved.
  *
  * Contributor(s):
  *   Myk Melez <myk@mozilla.org>
+ *   Ehsan Akhgari <ehsan.akhgari@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
  * 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
@@ -133,18 +134,31 @@ ContentPrefService.prototype = {
     }
 
     return this._selectGlobalPref(aName);
   },
 
   setPref: function ContentPrefService_setPref(aURI, aName, aValue) {
     // If the pref is already set to the value, there's nothing more to do.
     var currentValue = this.getPref(aURI, aName);
-    if (typeof currentValue != "undefined" && currentValue == aValue)
-      return;
+    if (typeof currentValue != "undefined") {
+      if (currentValue == aValue)
+        return;
+    }
+    else {
+      // If we are in private browsing mode, refuse to set new prefs
+      var inPrivateBrowsing = false;
+      try { // The Private Browsing service might not be available.
+        var pbs = Cc["@mozilla.org/privatebrowsing;1"].
+                  getService(Ci.nsIPrivateBrowsingService);
+        inPrivateBrowsing = pbs.privateBrowsingEnabled;
+      } catch (e) {}
+      if (inPrivateBrowsing)
+        return;
+    }
 
     var settingID = this._selectSettingID(aName) || this._insertSetting(aName);
     var group, groupID, prefID;
     if (aURI) {
       group = this.grouper.group(aURI);
       groupID = this._selectGroupID(group) || this._insertGroup(group);
       prefID = this._selectPrefID(groupID, settingID);
     }
new file mode 100644
--- /dev/null
+++ b/toolkit/components/contentprefs/tests/unit/test_bug248970.js
@@ -0,0 +1,115 @@
+/* ***** 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 ***** */
+
+var _PBSvc = null;
+function get_PBSvc() {
+  if (_PBSvc)
+    return _PBSvc;
+
+  try {
+    _PBSvc = Cc["@mozilla.org/privatebrowsing;1"].
+             getService(Ci.nsIPrivateBrowsingService);
+    if (_PBSvc) {
+      var observer = {
+        QueryInterface: function (iid) {
+          const interfaces = [Ci.nsIObserver,
+                              Ci.nsISupports];
+          if (!interfaces.some(function(v) iid.equals(v)))
+            throw Components.results.NS_ERROR_NO_INTERFACE;
+          return this;
+        },
+        observe: function (subject, topic, data) {
+          subject.QueryInterface(Ci.nsISupportsPRUint32);
+          subject.data = 0;
+        }
+      };
+      var os = Cc["@mozilla.org/observer-service;1"].
+               getService(Ci.nsIObserverService);
+      os.addObserver(observer, "private-browsing-enter", false);
+    }
+    return _PBSvc;
+  } catch (e) {}
+  return null;
+}
+
+var _CMSvc = null;
+function get_ContentPrefs() {
+  if (_CMSvc)
+    return _CMSvc;
+
+  return Cc["@mozilla.org/content-pref/service;1"].
+         createInstance(Ci.nsIContentPrefService);
+}
+
+function run_test() {
+  var pb = get_PBSvc();
+  if (pb) { // Private Browsing might not be available
+    ContentPrefTest.deleteDatabase();
+    var cp = get_ContentPrefs();
+    do_check_neq(cp, null, "Retrieving the content prefs service failed");
+
+    try {
+      const uri1 = ContentPrefTest.getURI("http://www.example.com/");
+      const uri2 = ContentPrefTest.getURI("http://www.anotherexample.com/");
+      const pref_name = "browser.content.full-zoom";
+      const zoomA = 1.5, zoomA_new = 0.8, zoomB = 1.3;
+      // save Zoom-A
+      cp.setPref(uri1, pref_name, zoomA);
+      // make sure Zoom-A is retrievable
+      do_check_eq(cp.getPref(uri1, pref_name), zoomA);
+      // enter private browsing mode
+      pb.privateBrowsingEnabled = true;
+      // make sure Zoom-A is retrievable
+      do_check_eq(cp.getPref(uri1, pref_name), zoomA);
+      // save Zoom-B
+      cp.setPref(uri2, pref_name, zoomB);
+      // make sure Zoom-B is not retrievable
+      do_check_eq(cp.getPref(uri2, pref_name), undefined);
+      // update Zoom-A
+      cp.setPref(uri1, pref_name, zoomA_new);
+      // make sure Zoom-A has changed
+      do_check_eq(cp.getPref(uri1, pref_name), zoomA_new);
+      // exit private browsing mode
+      pb.privateBrowsingEnabled = false;
+      // make sure Zoom-A change has persisted
+      do_check_eq(cp.getPref(uri1, pref_name), zoomA_new);
+    } catch (e) {
+      do_throw("Unexpected exception: " + e);
+    }
+  }
+  do_test_finished();
+}