michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
michael@0:  * You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: "use strict";
michael@0: 
michael@0: const {utils: Cu, interfaces: Ci} = Components;
michael@0: 
michael@0: Cu.import("resource://gre/modules/Services.jsm");
michael@0: Cu.import("resource://gre/modules/XPCOMUtils.jsm");
michael@0: 
michael@0: const NS_PREFBRANCH_PREFCHANGE_TOPIC_ID = "nsPref:changed";
michael@0: const BROWSER_FRAMES_ENABLED_PREF = "dom.mozBrowserFramesEnabled";
michael@0: 
michael@0: XPCOMUtils.defineLazyModuleGetter(this, "BrowserElementParentBuilder",
michael@0:                                   "resource://gre/modules/BrowserElementParent.jsm",
michael@0:                                   "BrowserElementParentBuilder");
michael@0: 
michael@0: function debug(msg) {
michael@0:   //dump("BrowserElementParent.js - " + msg + "\n");
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * BrowserElementParent implements one half of <iframe mozbrowser>.  (The other
michael@0:  * half is, unsurprisingly, BrowserElementChild.)
michael@0:  *
michael@0:  * BrowserElementParentFactory detects when we create a windows or docshell
michael@0:  * contained inside a <iframe mozbrowser> and creates a BrowserElementParent
michael@0:  * object for that window.
michael@0:  *
michael@0:  * It creates a BrowserElementParent that injects script to listen for
michael@0:  * certain event.
michael@0:  */
michael@0: 
michael@0: function BrowserElementParentFactory() {
michael@0:   this._initialized = false;
michael@0: }
michael@0: 
michael@0: BrowserElementParentFactory.prototype = {
michael@0:   classID: Components.ID("{ddeafdac-cb39-47c4-9cb8-c9027ee36d26}"),
michael@0:   QueryInterface: XPCOMUtils.generateQI([Ci.nsIObserver,
michael@0:                                          Ci.nsISupportsWeakReference]),
michael@0: 
michael@0:   /**
michael@0:    * Called on app startup, and also when the browser frames enabled pref is
michael@0:    * changed.
michael@0:    */
michael@0:   _init: function() {
michael@0:     if (this._initialized) {
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     // If the pref is disabled, do nothing except wait for the pref to change.
michael@0:     // (This is important for tests, if nothing else.)
michael@0:     if (!this._browserFramesPrefEnabled()) {
michael@0:       Services.prefs.addObserver(BROWSER_FRAMES_ENABLED_PREF, this, /* ownsWeak = */ true);
michael@0:       return;
michael@0:     }
michael@0: 
michael@0:     debug("_init");
michael@0:     this._initialized = true;
michael@0: 
michael@0:     // Maps frame elements to BrowserElementParent objects.  We never look up
michael@0:     // anything in this map; the purpose is to keep the BrowserElementParent
michael@0:     // alive for as long as its frame element lives.
michael@0:     this._bepMap = new WeakMap();
michael@0: 
michael@0:     Services.obs.addObserver(this, 'remote-browser-pending', /* ownsWeak = */ true);
michael@0:     Services.obs.addObserver(this, 'inprocess-browser-shown', /* ownsWeak = */ true);
michael@0:   },
michael@0: 
michael@0:   _browserFramesPrefEnabled: function() {
michael@0:     try {
michael@0:       return Services.prefs.getBoolPref(BROWSER_FRAMES_ENABLED_PREF);
michael@0:     }
michael@0:     catch(e) {
michael@0:       return false;
michael@0:     }
michael@0:   },
michael@0: 
michael@0:   _observeInProcessBrowserFrameShown: function(frameLoader) {
michael@0:     // Ignore notifications that aren't from a BrowserOrApp
michael@0:     if (!frameLoader.QueryInterface(Ci.nsIFrameLoader).ownerIsBrowserOrAppFrame) {
michael@0:       return;
michael@0:     }
michael@0:     debug("In-process browser frame shown " + frameLoader);
michael@0:     this._createBrowserElementParent(frameLoader,
michael@0:                                      /* hasRemoteFrame = */ false,
michael@0:                                      /* pending frame */ false);
michael@0:   },
michael@0: 
michael@0:   _observeRemoteBrowserFramePending: function(frameLoader) {
michael@0:     // Ignore notifications that aren't from a BrowserOrApp
michael@0:     if (!frameLoader.QueryInterface(Ci.nsIFrameLoader).ownerIsBrowserOrAppFrame) {
michael@0:       return;
michael@0:     }
michael@0:     debug("Remote browser frame shown " + frameLoader);
michael@0:     this._createBrowserElementParent(frameLoader,
michael@0:                                      /* hasRemoteFrame = */ true,
michael@0:                                      /* pending frame */ true);
michael@0:   },
michael@0: 
michael@0:   _createBrowserElementParent: function(frameLoader, hasRemoteFrame, isPendingFrame) {
michael@0:     let frameElement = frameLoader.QueryInterface(Ci.nsIFrameLoader).ownerElement;
michael@0:     this._bepMap.set(frameElement, BrowserElementParentBuilder.create(
michael@0:       frameLoader, hasRemoteFrame, isPendingFrame));
michael@0:   },
michael@0: 
michael@0:   observe: function(subject, topic, data) {
michael@0:     switch(topic) {
michael@0:     case 'app-startup':
michael@0:       this._init();
michael@0:       break;
michael@0:     case NS_PREFBRANCH_PREFCHANGE_TOPIC_ID:
michael@0:       if (data == BROWSER_FRAMES_ENABLED_PREF) {
michael@0:         this._init();
michael@0:       }
michael@0:       break;
michael@0:     case 'remote-browser-pending':
michael@0:       this._observeRemoteBrowserFramePending(subject);
michael@0:       break;
michael@0:     case 'inprocess-browser-shown':
michael@0:       this._observeInProcessBrowserFrameShown(subject);
michael@0:       break;
michael@0:     }
michael@0:   },
michael@0: };
michael@0: 
michael@0: this.NSGetFactory = XPCOMUtils.generateNSGetFactory([BrowserElementParentFactory]);