Issue 3486 - Issue reporter: don`t access content window to reload the page

chrome/content/ui/sendReport.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
@@ skipping 11 matching lines @@
 let {Services} = Cu.import("resource://gre/modules/Services.jsm", {});
 let {FileUtils} = Cu.import("resource://gre/modules/FileUtils.jsm", {});
 let {PrivateBrowsingUtils} = Cu.import("resource://gre/modules/PrivateBrowsingUtils.jsm", {});
 
 const MILLISECONDS_IN_SECOND = 1000;
 const SECONDS_IN_MINUTE = 60;
 const SECONDS_IN_HOUR = 60 * SECONDS_IN_MINUTE;
 const SECONDS_IN_DAY = 24 * SECONDS_IN_HOUR;
 
 let contentWindow = window.arguments[0];
-let windowURI = (window.arguments[1] instanceof Ci.nsIURI ? window.arguments[1] : null);
+let windowURI = window.arguments[1];
+if (typeof windowURI == "string")
+  windowURI = Services.newURI(windowURI, null, null);
+let browser = window.arguments[2];
 
 let reportData = new DOMParser().parseFromString("<report></report>", "text/xml");
 
 // Some helper functions to work with the report data
 function reportElement(tag)
 {
   for (let child = reportData.documentElement.firstChild; child; child = child.nextSibling)
     if (child.nodeType == Node.ELEMENT_NODE && child.tagName == tag)
       return child;
   let element = reportData.createElement(tag);
@@ skipping 59 matching lines @@
 };
 
 //
 // Data collectors
 //
 
 var reportsListDataSource =
 {
   list: [],
 
-  collectData: function(wnd, windowURI, callback)
+  collectData: function(wnd, windowURI, browser, callback)
   {
     let data = Prefs.recentReports;
     if (data && "length" in data)
     {
       for (let i = 0; i < data.length; i++)
       {
         let entry = data[i];
         if (typeof entry.reportURL == "string" && entry.reportURL &&
             typeof entry.time == "number" && Date.now() - entry.time < 30*24*60*60*1000)
         {
@@ skipping 62 matching lines @@
 };
 
 var requestsDataSource =
 {
   requests: reportElement("requests"),
   origRequests: [],
   requestNotifier: null,
   callback: null,
   nodeByKey: Object.create(null),
 
-  collectData: function(wnd, windowURI, callback)
+  collectData: function(wnd, windowURI, browser, callback)
   {
     let outerWindowID = wnd.QueryInterface(Ci.nsIInterfaceRequestor)
                            .getInterface(Ci.nsIDOMWindowUtils)
                            .outerWindowID;
     this.callback = callback;
     this.requestNotifier = new RequestNotifier(outerWindowID, this.onRequestFound, this);
   },
 
   onRequestFound: function(entry, scanComplete)
   {
@@ skipping 33 matching lines @@
       this.requestNotifier = null;
       this.callback();
     }
   }
 };
 
 var filtersDataSource =
 {
   origFilters: [],
 
-  collectData: function(wnd, windowURI, callback)
+  collectData: function(wnd, windowURI, browser, callback)
   {
     let outerWindowID = wnd.QueryInterface(Ci.nsIInterfaceRequestor)
                            .getInterface(Ci.nsIDOMWindowUtils)
                            .outerWindowID;
     RequestNotifier.getWindowStatistics(outerWindowID, (wndStats) =>
     {
       if (wndStats)
       {
         let filters = reportElement("filters");
         for (let f in wndStats.filters)
@@ skipping 17 matching lines @@
 {
   subscriptionFilter: function(s)
   {
     if (s.disabled || !(s instanceof RegularSubscription))
       return false;
     if (s instanceof DownloadableSubscription && !/^(http|https|ftp):/i.test(s.url))
       return false;
     return true;
   },
 
-  collectData: function(wnd, windowURI, callback)
+  collectData: function(wnd, windowURI, browser, callback)
   {
     let subscriptions = reportElement("subscriptions");
     let now = Math.round(Date.now() / 1000);
     for (let i = 0; i < FilterStorage.subscriptions.length; i++)
     {
       let subscription = FilterStorage.subscriptions[i];
       if (!this.subscriptionFilter(subscription))
         continue;
 
       let subscriptionXML = appendElement(subscriptions, "subscription", {
@@ skipping 14 matching lines @@
           subscriptionXML.setAttribute("hardExpiration", subscription.expires - now);
         subscriptionXML.setAttribute("downloadStatus", subscription.downloadStatus);
       }
     }
     callback();
   }
 };
 
 var remoteDataSource =
 {
-  collectData: function(wnd, windowURI, callback)
+  collectData: function(wnd, windowURI, browser, callback)
   {
     let outerWindowID = wnd.QueryInterface(Ci.nsIInterfaceRequestor)
                            .getInterface(Ci.nsIDOMWindowUtils)
                            .outerWindowID;
     let dataCollector = require("dataCollector");
     let screenshotWidth = screenshotDataSource.getWidth();
     dataCollector.collectData(outerWindowID, screenshotWidth, data => {
       screenshotDataSource.setData(data && data.screenshot);
       framesDataSource.setData(windowURI, data && data.opener, data && data.referrer, data && data.frames);
       callback();
@@ skipping 240 matching lines @@
       let frameXML = appendElement(xmlList, "frame", {
         url: censorURL(frame.url)
       });
       this.addFrames(frame.frames, frameXML);
     }
   }
 };
 
 var errorsDataSource =
 {
-  collectData: function(wnd, windowURI, callback)
+  collectData: function(wnd, windowURI, browser, callback)
   {
     let {addonID} = require("info");
     addonID = addonID.replace(/[\{\}]/g, "");
 
     // See https://bugzilla.mozilla.org/show_bug.cgi?id=664695 - starting with
     // Gecko 19 this function returns the result, before that it wrote to a
     // parameter.
     let outparam = {};
     let messages = Cc["@mozilla.org/consoleservice;1"].getService(Ci.nsIConsoleService).getMessageArray(outparam, {});
     messages = messages || outparam.value || [];
@@ skipping 54 matching lines @@
     }
 
     callback();
   }
 };
 
 var extensionsDataSource =
 {
   data: reportData.createElement("extensions"),
 
-  collectData: function(wnd, windowURI, callback)
+  collectData: function(wnd, windowURI, browser, callback)
   {
     try
     {
       let AddonManager = Cu.import("resource://gre/modules/AddonManager.jsm", null).AddonManager;
       AddonManager.getAddonsByTypes(["extension", "plugin"], function(items)
       {
         for (let i = 0; i < items.length; i++)
         {
           let item = items[i];
           if (!item.isActive)
@@ skipping 19 matching lines @@
   {
     if (doExport)
       reportData.documentElement.appendChild(this.data);
     else if (this.data.parentNode)
       this.data.parentNode.removeChild(this.data);
   }
 };
 
 var subscriptionUpdateDataSource =
 {
-  contentWnd: null,
+  browser: null,
   type: null,
   outdated: null,
   needUpdate: null,
 
   subscriptionFilter: function(s)
   {
     if (s instanceof DownloadableSubscription)
       return subscriptionsDataSource.subscriptionFilter(s);
     else
       return false;
   },
 
-  collectData: function(wnd, windowURI, callback)
+  collectData: function(wnd, windowURI, browser, callback)
   {
-    this.contentWnd = wnd;
+    this.browser = browser;
     let now = Date.now() / MILLISECONDS_IN_SECOND;
     let outdatedThreshold = now - 14 * SECONDS_IN_DAY;
     let needUpdateThreshold = now - 1 * SECONDS_IN_HOUR;
 
     this.outdated = [];
     this.needUpdate = [];
 
     let subscriptions = FilterStorage.subscriptions.filter(this.subscriptionFilter);
     for (let i = 0; i < subscriptions.length; i++)
     {
@@ skipping 70 matching lines @@
         }
 
         if (filtersRemoved)
         {
           // Force the user to reload the page
           E("updateFixedIssue").hidden = false;
           document.documentElement.canAdvance = true;
 
           let nextButton = document.documentElement.getButton("next");
           [nextButton.label, nextButton.accessKey] = Utils.splitLabel(E("updatePage").getAttribute("reloadButtonLabel"));
-          document.documentElement.addEventListener("wizardnext", function(event)
+          document.documentElement.addEventListener("wizardnext", event =>
           {
             event.preventDefault();
             event.stopPropagation();
             window.close();
-            this.contentWnd.location.reload();
-          }.bind(this), true);
+            this.browser.reload();

[Erik, 2016/01/08 04:00:45]

the only problem I see with this is that the current tab might change and this
would reload a different window than previously.  Also it might be better to
avoid holding a ref to browser somehow, but I don't see an issue with it for
now.

[Wladimir Palant, 2016/01/08 13:46:20]

Given that it is a specific <browser> element rather than <tabbrowser> - we will
always reload the right tab. It might be that a different page was loaded into
this tab but reloading it isn't a big issue IMHO.
You mean - going through the opener's tabs looking for the browser with a
specific outerWindowID? That would be a possibility but hard to implement across
apps (in particular on Thunderbird - we will have <tabmail> there). This use
case doesn't seem to justify the complexity.

+          }, true);
         }
         else
         {
-          this.collectData(null, null, function() {});
+          this.collectData(null, null, null, function() {});
           this.needUpdate = [];
           if (this.outdated.length)
           {
             document.documentElement.canRewind = true;
 
             this.updatePage(this.type);
             this.showPage();
           }
           else
           {
@@ skipping 21 matching lines @@
 
   updateOutdated: function()
   {
     for (let i = 0; i < this.outdated.length; i++)
       Synchronizer.execute(this.outdated[i], true);
   }
 }
 
 var issuesDataSource =
 {
-  contentWnd: null,
+  browser: null,
   isEnabled: Prefs.enabled,
   whitelistFilter: null,
   disabledFilters: [],
   disabledSubscriptions: [],
   ownFilters: [],
   numSubscriptions: 0,
   numAppliedFilters: Infinity,
 
   subscriptionFilter: function(s)
   {
     if (s instanceof DownloadableSubscription &&
         s.url != Prefs.subscriptions_exceptionsurl &&
         s.url != Prefs.subscriptions_antiadblockurl)
     {
       return subscriptionsDataSource.subscriptionFilter(s);
     }
     else
       return false;
   },
 
-  collectData: function(wnd, windowURI, callback)
+  collectData: function(wnd, windowURI, browser, callback)
   {
-    this.contentWnd = wnd;
+    this.browser = browser;
     this.whitelistFilter = Policy.isWhitelisted(windowURI.spec);
 
     if (!this.whitelistFilter && this.isEnabled)
     {
       // Find disabled filters in active subscriptions matching any of the requests
       let disabledMatcher = new CombinedMatcher();
       for (let subscription of FilterStorage.subscriptions)
       {
         if (subscription.disabled)
           continue;
@@ skipping 156 matching lines @@
 
   forceReload: function()
   {
     // User changed configuration, don't allow sending report now - page needs
     // to be reloaded
     E("issuesOverride").hidden = true;
     E("issuesChangeMessage").hidden = false;
     document.documentElement.canRewind = false;
     document.documentElement.canAdvance = true;
 
-    let contentWnd = this.contentWnd;
     let nextButton = document.documentElement.getButton("next");
     [nextButton.label, nextButton.accessKey] = Utils.splitLabel(E("updatePage").getAttribute("reloadButtonLabel"));
-    document.documentElement.addEventListener("wizardnext", function(event)
+    document.documentElement.addEventListener("wizardnext", event =>
     {
       event.preventDefault();
       event.stopPropagation();
       window.close();
-      contentWnd.location.reload();
+      this.browser.reload();
     }, true);
   },
 
   removeWhitelist: function()
   {
     if (this.whitelistFilter && this.whitelistFilter.subscriptions.length)
       this.whitelistFilter.disabled = true;
     E("issuesWhitelistBox").hidden = true;
     this.forceReload();
   },
@@ skipping 151 matching lines @@
     {
       let progressMeter = E("dataCollectorProgress");
       progressMeter.mode = "determined";
       progressMeter.value = progress;
     }
 
     // Continue with the next data source, asynchronously to allow progress meter to update
     let dataSource = dataCollectors.shift();
     Utils.runAsync(function()
     {
-      dataSource.collectData(contentWindow, windowURI, initNextDataSource);
+      dataSource.collectData(contentWindow, windowURI, browser, initNextDataSource);
     });
   };
 
   initNextDataSource();
 }
 
 function initTypeSelectorPage()
 {
   E("progressBar").activeItem = E("typeSelectorHeader");
   let header = document.getAnonymousElementByAttribute(document.documentElement, "class", "wizard-header");
@@ skipping 302 matching lines @@
 
 function censorURL(url)
 {
   return url.replace(/([?;&\/#][^?;&\/#]+?=)[^?;&\/#]+/g, "$1*");
 }
 
 function encodeHTML(str)
 {
   return str.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
 }