Bug 731779: Integrate the Add-on SDK loader and API libraries into Firefox (uplifting from addon-sdk a16bbd5772880b578a939eeb65102bca6560d494)

2013-02-01 13:17:34 -08:00
parent 5d070e859e
commit 03380d9942
790 changed files with 96215 additions and 0 deletions
--- a/addon-sdk/source/lib/sdk/private-browsing/utils.js
+++ b/addon-sdk/source/lib/sdk/private-browsing/utils.js
@@ -0,0 +1,97 @@
+/* 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';
+
+module.metadata = {
+  "stability": "unstable"
+};
+
+const { Cc, Ci, Cu } = require('chrome');
+const { defer } = require('../lang/functional');
+const { emit, on, once, off } = require('../event/core');
+const { when: unload } = require('../system/unload');
+const { getWindowLoadingContext, windows } = require('../window/utils');
+const { WindowTracker } = require("../deprecated/window-utils");
+const events = require('../system/events');
+const { deprecateFunction } = require('../util/deprecate');
+
+let deferredEmit = defer(emit);
+let pbService;
+let PrivateBrowsingUtils;
+
+// Private browsing is only supported in Fx
+if (require("../system/xul-app").is("Firefox")) {
+  // get the nsIPrivateBrowsingService if it exists
+  try {
+    pbService = Cc["@mozilla.org/privatebrowsing;1"].
+                getService(Ci.nsIPrivateBrowsingService);
+
+    // a dummy service exists for the moment (Fx20 atleast), but will be removed eventually
+    // ie: the service will exist, but it won't do anything and the global private browing
+    //     feature is not really active.  See Bug 818800 and Bug 826037
+    if (!('privateBrowsingEnabled' in pbService))
+      pbService = undefined;
+  } catch(e) { /* Private Browsing Service has been removed (Bug 818800) */ }
+
+  try {
+    PrivateBrowsingUtils = Cu.import('resource://gre/modules/PrivateBrowsingUtils.jsm', {}).PrivateBrowsingUtils;
+  }
+  catch(e) { /* if this file DNE then an error will be thrown */ }
+}
+
+function isWindowPrivate(win) {
+  // if the pbService is undefined, the PrivateBrowsingUtils.jsm is available,
+  // and the app is Firefox, then assume per-window private browsing is
+  // enabled.
+  return win instanceof Ci.nsIDOMWindow &&
+         isWindowPBSupported &&
+         PrivateBrowsingUtils.isWindowPrivate(win);
+}
+exports.isWindowPrivate = isWindowPrivate;
+
+// checks that global private browsing is implemented
+let isGlobalPBSupported = exports.isGlobalPBSupported =  !!pbService;
+
+// checks that per-window private browsing is implemented
+let isWindowPBSupported = exports.isWindowPBSupported = !isGlobalPBSupported && !!PrivateBrowsingUtils;
+
+function onChange() {
+  // Emit event with in next turn of event loop.
+  deferredEmit(exports, pbService.privateBrowsingEnabled ? 'start' : 'stop');
+}
+
+// Currently, only Firefox implements the private browsing service.
+if (isGlobalPBSupported) {
+  // set up an observer for private browsing switches.
+  events.on('private-browsing-transition-complete', onChange);
+}
+
+// We toggle private browsing mode asynchronously in order to work around
+// bug 659629.  Since private browsing transitions are asynchronous
+// anyway, this doesn't significantly change the behavior of the API.
+let setMode = defer(function setMode(value) {
+  value = !!value;  // Cast to boolean.
+
+  // default
+  return pbService && (pbService.privateBrowsingEnabled = value);
+});
+exports.setMode = deprecateFunction(
+  setMode,
+  'require("private-browsing").activate and require("private-browsing").deactivate ' +
+  'is deprecated.'
+);
+
+let getMode = function getMode(chromeWin) {
+  if (isWindowPrivate(chromeWin))
+    return true;
+
+  // default
+  return pbService ? pbService.privateBrowsingEnabled : false;
+};
+exports.getMode = getMode;
+
+exports.on = on.bind(null, exports);
+
+// Make sure listeners are cleaned up.
+unload(function() off(exports));