The Tor Browser: addon-sdk/source/lib/sdk/frame/hidden-frame.js@b8a032363ba2 (annotated)

addon-sdk/source/lib/sdk/frame/hidden-frame.js@b8a032363ba2 (annotated)

addon-sdk/source/lib/sdk/frame/hidden-frame.js

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /* 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": "experimental"
 };
 const { Cc, Ci } = require("chrome");
 const errors = require("../deprecated/errors");
 const { Class } = require("../core/heritage");
 const { List, addListItem, removeListItem } = require("../util/list");
 const { EventTarget } = require("../event/target");
 const { emit } = require("../event/core");
 const { create: makeFrame } = require("./utils");
 const { defer } = require("../core/promise");
 const { when: unload } = require("../system/unload");
 const { validateOptions, getTypeOf } = require("../deprecated/api-utils");
 const { window } = require("../addon/window");
 const { fromIterator } = require("../util/array");
 // This cache is used to access friend properties between functions
 // without exposing them on the public API.
 let cache = new Set();
 let elements = new WeakMap();
 function contentLoaded(target) {
   var deferred = defer();
   target.addEventListener("DOMContentLoaded", function DOMContentLoaded(event) {
     // "DOMContentLoaded" events from nested frames propagate up to target,
     // ignore events unless it's DOMContentLoaded for the given target.
     if (event.target === target || event.target === target.contentDocument) {
       target.removeEventListener("DOMContentLoaded", DOMContentLoaded, false);
       deferred.resolve(target);
     }
   }, false);
   return deferred.promise;
 }
 function FrameOptions(options) {
   options = options || {}
   return validateOptions(options, FrameOptions.validator);
 }
 FrameOptions.validator = {
   onReady: {
     is: ["undefined", "function", "array"],
     ok: function(v) {
       if (getTypeOf(v) === "array") {
         // make sure every item is a function
         return v.every(function (item) typeof(item) === "function")
       }
       return true;
     }
   },
   onUnload: {
     is: ["undefined", "function"]
   }
 };
 var HiddenFrame = Class({
   extends: EventTarget,
   initialize: function initialize(options) {
     options = FrameOptions(options);
     EventTarget.prototype.initialize.call(this, options);
   },
   get element() {
     return elements.get(this);
   },
   toString: function toString() {
     return "[object Frame]"
   }
 });
 exports.HiddenFrame = HiddenFrame
 function addHidenFrame(frame) {
   if (!(frame instanceof HiddenFrame))
     throw Error("The object to be added must be a HiddenFrame.");
   // This instance was already added.
   if (cache.has(frame)) return frame;
   else cache.add(frame);
   let element = makeFrame(window.document, {
     nodeName: "iframe",
     type: "content",
     allowJavascript: true,
     allowPlugins: true,
     allowAuth: true,
   });
   elements.set(frame, element);
   contentLoaded(element).then(function onFrameReady(element) {
     emit(frame, "ready");
   }, console.exception);
   return frame;
 }
 exports.add = addHidenFrame
 function removeHiddenFrame(frame) {
   if (!(frame instanceof HiddenFrame))
     throw Error("The object to be removed must be a HiddenFrame.");
   if (!cache.has(frame)) return;
   // Remove from cache before calling in order to avoid loop
   cache.delete(frame);
   emit(frame, "unload")
   let element = frame.element
   if (element) element.parentNode.removeChild(element)
 }
 exports.remove = removeHiddenFrame;
 unload(function() fromIterator(cache).forEach(removeHiddenFrame));