Issue 3208 - Generalize getFrames() function to return the effective frame structure

lib/child/utils.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 "use strict";
 
 let {PrivateBrowsingUtils} = Cu.import("resource://gre/modules/PrivateBrowsingUtils.jsm", {});
 
+let {Utils} = require("utils");
+
+/**
+ * Retrieves the effective location of a window.
+ */
+let getWindowLocation = exports.getWindowLocation = function(/**Window*/ window) /**String*/
+{
+  let result = null;
+
+  // Crazy Thunderbird stuff
+  if ("name" in window && window.name == "messagepane")
+  {
+    try
+    {
+      let mailWnd = window.QueryInterface(Ci.nsIInterfaceRequestor)
+                          .getInterface(Ci.nsIWebNavigation)
+                          .QueryInterface(Ci.nsIDocShellTreeItem)
+                          .rootTreeItem
+                          .QueryInterface(Ci.nsIInterfaceRequestor)
+                          .getInterface(Ci.nsIDOMWindow);
+
+      // Typically we get a wrapped mail window here, need to unwrap
+      try
+      {
+        mailWnd = mailWnd.wrappedJSObject;
+      } catch(e) {}
+
+      if ("currentHeaderData" in mailWnd && "content-base" in mailWnd.currentHeaderData)
+      {
+        result = mailWnd.currentHeaderData["content-base"].headerValue;
+      }
+      else if ("currentHeaderData" in mailWnd && "from" in mailWnd.currentHeaderData)
+      {
+        let emailAddress = Utils.headerParser.extractHeaderAddressMailboxes(mailWnd.currentHeaderData.from.headerValue);
+        if (emailAddress)
+          result = 'mailto:' + emailAddress.replace(/^[\s"]+/, "").replace(/[\s"]+$/, "").replace(/\s/g, '%20');
+      }
+    } catch(e) {}
+  }
+
+  // Sane branch
+  if (!result)
+    result = window.location.href;
+
+  // Remove the anchor if any
+  let index = result.indexOf("#");
+  if (index >= 0)
+    result = result.substring(0, index);
+
+  return result;
+}
+
 /**
  * Retrieves the frame hierarchy for a window. Returns an array containing
  * the information for all frames, starting with the window itself up to its
  * top-level window. Each entry has a location and a sitekey entry.
  * @return {Array}
  */
 let getFrames = exports.getFrames = function(/**Window*/ window)
 {
   let frames = [];
   while (window)
   {
     let frame = {
-      location: window.location.href,
+      location: getWindowLocation(window),
       sitekey: null
     };
 
     let documentElement = window.document && window.document.documentElement;
     if (documentElement)
       frame.sitekey = documentElement.getAttribute("data-adblockkey")
 
     frames.push(frame);
     window = (window != window.parent ? window.parent : null);
   }
+
+  // URLs like about:blank inherit their security context from upper-level

[Thomas Greiner, 2015/11/10 18:41:23]

So with "URLs like about:blank" you mean "about:blank" and
"moz-safe-about:blank" or are those only the ones you're aware of?

[Wladimir Palant, 2015/11/11 08:01:28]

No, normally that's protocol-dependent - data:, javascript: and wyciwig:
protocols implement URI_INHERITS_SECURITY_CONTEXT flag which is also checked.

+  // frames, resolve their URLs accordingly.
+  for (let i = frames.length - 2; i >= 0; i--)
+  {
+    let frame = frames[i];
+    if (frame.location == "about:blank" || frame.location == "moz-safe-about:blank" ||
+        Utils.netUtils.URIChainHasFlags(Utils.makeURI(frame.location), Ci.nsIProtocolHandler.URI_INHERITS_SECURITY_CONTEXT))
+    {
+      frames[i].location = frames[i + 1].location;

[Thomas Greiner, 2015/11/10 18:41:23]

Detail: You already have a reference to `frame[i]` in the variable `frame` so
you can get rid of `s[i]` here.

[Wladimir Palant, 2015/11/11 08:01:28]

Done.

+    }
+  }
+
   return frames;
 };
 
 /**
  * Checks whether Private Browsing mode is enabled for a content window.
  * @return {Boolean}
  */
 let isPrivate = exports.isPrivate = function(/**Window*/ window)
 {
   return PrivateBrowsingUtils.isWindowPrivate(window);
 };