Implemented anti-adblock message notification

lib/ui.js

 /*
  * This file is part of Adblock Plus <http://adblockplus.org/>,
  * Copyright (C) 2006-2013 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/>.
  */
 
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 Cu.import("resource://gre/modules/Services.jsm");
 
 let {Utils} = require("utils");
 let {Prefs} = require("prefs");
 let {Policy} = require("contentPolicy");
 let {FilterListener} = require("filterListener");
 let {FilterStorage} = require("filterStorage");
 let {FilterNotifier} = require("filterNotifier");
 let {RequestNotifier} = require("requestNotifier");
-let {Filter} = require("filterClasses");
+let {Filter, ActiveFilter} = require("filterClasses");
 let {Subscription, SpecialSubscription, DownloadableSubscription} = require("subscriptionClasses");
 let {Synchronizer} = require("synchronizer");
 let {KeySelector} = require("keySelector");
 let {Notification} = require("notification");
 
 let CustomizableUI;
 try
 {
   ({CustomizableUI}) = Cu.import("resource:///modules/CustomizableUI.jsm", null);
 }
@@ skipping 479 matching lines @@
     window.addEventListener("popupshowing", this.onPopupShowing, false);
     window.addEventListener("keypress", this.onKeyPress, false);
 
     addBrowserLocationListener(window, function()
     {
       this.updateIconState(window, window.document.getElementById("abp-status"));
       this.updateIconState(window, window.document.getElementById("abp-toolbarbutton"));
     }.bind(this));
     addBrowserClickListener(window, this.onBrowserClick.bind(this, window));
 
+    window.document.getElementById("abp-notification-close").addEventListener("command", function(event)
+    {
+      window.document.getElementById("abp-notification").hidePopup();
+    }, false);
+
+    // Add "anti-adblock messages" notification

[Felix Dahlke, 2014/02/11 17:57:17]

I think all the anti adblock message specific code should go to its own function
(initAntiAdblockMessageBlocking?) - it's a lot of code.

[Thomas Greiner, 2014/02/12 11:58:49]

Done.

+    function getURLFiltersFromSubscription(subscription)
+    {
+      let urlFilters = [];
+      for each (let filter in subscription.filters)
+        if (filter instanceof ActiveFilter)
+          for (let domain in filter.domains)
+            if (domain && urlFilters.indexOf(domain) == -1)
+              urlFilters.push(domain);
+      return urlFilters;
+    }
+
+    let antiadblockNotification = {
+      id: "antiadblock",
+      severity: "question",
+      title: Utils.getString("notification_antiadblock_title"),
+      message: Utils.getString("notification_antiadblock_message"),
+      urlFilters: [],
+      onApproved: function()

[Felix Dahlke, 2014/02/11 17:57:17]

I really don't think we should be able to put code directly into the
notification - it's a huge security issue.

How about this: We put a map of notification listeners in notification.js, and
add addListener/removeListener functions, maybe like this:

Notification.addListener("antiadblock", function(approved)
{
  ...
});

[Thomas Greiner, 2014/02/12 11:58:49]

You cannot include functions in JSON so they can only be added locally. But I
prefer your approach so I changed it.

[Felix Dahlke, 2014/02/12 15:09:27]

Oh that's right of course, wouldn't work anyway.

+      {
+        let subscription = Subscription.fromURL(Prefs.subscriptions_antiadblockurl);
+        if (subscription.url in FilterStorage.knownSubscriptions)
+          subscription.disabled = false;
+      },
+      onDeclined: function()
+      {
+        let subscription = Subscription.fromURL(Prefs.subscriptions_antiadblockurl);
+        if (subscription.url in FilterStorage.knownSubscriptions)
+          subscription.disabled = true;
+      }
+    };
+    let antiadblockSubscription = Subscription.fromURL(Prefs.subscriptions_antiadblockurl);
+    if (antiadblockSubscription.lastDownload && antiadblockSubscription.disabled)
+    {
+      antiadblockNotification.urlFilters = getURLFiltersFromSubscription(antiadblockSubscription);
+      Notification.addNotification(antiadblockNotification);
+    }
+    FilterNotifier.addListener(function(action, value, newItem, oldItem)
+    {
+      if (!/^subscription\.(updated|removed|disabled)$/.test(action) || value.url != Prefs.subscriptions_antiadblockurl)
+        return;
+
+      if (action == "subscription.updated")
+      {
+        antiadblockNotification.urlFilters = getURLFiltersFromSubscription(value);

[Felix Dahlke, 2014/02/11 17:57:17]

This is repeated above. How about having a
createAntiAdblockBlockingNotification(subscription) function instead?

[Thomas Greiner, 2014/02/12 11:58:49]

Done.

+        Notification.addNotification(antiadblockNotification);
+      }
+      else if (action == "subscription.removed" || (action == "subscription.disabled" && !value.disabled))
+      {
+        Notification.removeNotification(antiadblockNotification);
+      }
+    });
+
+    var httpRequestObserver = {

[Felix Dahlke, 2014/02/11 17:57:17]

Shouldn't it be called documentCreatingObserver or something? This reacts to a
page being loaded effectively, not individual HTTP requests, doesn't it?

[Thomas Greiner, 2014/02/12 11:58:49]

Done.

+      observe: function(subject, topic, data) 
+      {
+        if (!(subject instanceof Ci.nsIDOMWindow))
+          return;
+        
+        this._showNextNotification(subject.location.href);
+      }.bind(this)
+    };
+    Services.obs.addObserver(httpRequestObserver, "content-document-global-created", false);
+    onShutdown.add(function()
+    {
+      Services.obs.removeObserver(httpRequestObserver, "content-document-global-created", false);
+    });
+
     // First-run actions?
     if (!this.firstRunDone)
     {
       this.firstRunDone = true;
 
       let {addonVersion} = require("info");
       let prevVersion = Prefs.currentVersion;
       if (prevVersion != addonVersion)
       {
         Prefs.currentVersion = addonVersion;
@@ skipping 225 matching lines @@
       {
         subscription.title = "Allow non-intrusive advertising";
         FilterStorage.addSubscription(subscription);
         if (subscription instanceof DownloadableSubscription && !subscription.lastDownload)
           Synchronizer.execute(subscription);
       }
       else
         addAcceptable = false;
     }
 
+    // Add "anti-adblock messages" subscription for new users and users updating from old ABP versions.
+    if (Services.vc.compare(prevVersion, "2.5") < 0)

[Felix Dahlke, 2014/02/11 17:57:17]

I think we should do this for everyone, no matter what version.

[Thomas Greiner, 2014/02/12 11:58:49]

Done.

+    {
+      let subscription = Subscription.fromURL(Prefs.subscriptions_antiadblockurl);
+      if (subscription)
+      {
+        subscription.disabled = true;
+        FilterStorage.addSubscription(subscription);
+        if (subscription instanceof DownloadableSubscription && !subscription.lastDownload)
+          Synchronizer.execute(subscription);
+      }
+    }
+
     if (!addSubscription && !addAcceptable)
       return;
 
     function notifyUser()
     {
       let {addTab} = require("appSupport");
       if (addTab)
       {
         addTab(window, "chrome://adblockplus/content/ui/firstRun.html");
       }
@@ skipping 975 matching lines @@
     Prefs.hideContributeButton = true;
 
     for each (let id in ["abp-status-contributebutton", "abp-toolbar-contributebutton", "abp-menuitem-contributebutton"])
     {
       let button = window.document.getElementById(id);
       if (button)
         button.hidden = true;
     }
   },
 
-  _showNextNotification: function()
+  _showNextNotification: function(url)
   {
     let window = this.currentWindow;
     if (!window)
       return;
 
     let button = window.document.getElementById("abp-toolbarbutton")
       || window.document.getElementById("abp-status");
     if (!button)
       return;
 
-    let notification = Notification.getNextToShow();
+    let notification = Notification.getNextToShow(url);
     if (!notification)
       return;
 
     this._showNotification(window, button, notification);
   },
 
   _showNotification: function(window, button, notification)
   {
+    let panel = window.document.getElementById("abp-notification");
+    if (panel.state !== "closed")
+      return;
+
     function insertMessage(element, text, links)
     {
       let match = /^(.*?)<(a|strong)>(.*?)<\/\2>(.*)$/.exec(text);
       if (!match)
       {
         element.appendChild(window.document.createTextNode(text));
         return;
       }
 
       let [_, before, tagName, value, after] = match;
 
       insertMessage(element, before, links);
 
       let newElement = window.document.createElementNS("http://www.w3.org/1999/xhtml", tagName);
       if (tagName === "a" && links && links.length)
         newElement.setAttribute("href", links.shift());
       insertMessage(newElement, value, links);
       element.appendChild(newElement);
 
       insertMessage(element, after, links);
     }
 
     let texts = Notification.getLocalizedTexts(notification);
     let titleElement = window.document.getElementById("abp-notification-title");
     titleElement.setAttribute("value", texts.title);
     let messageElement = window.document.getElementById("abp-notification-message");
+    messageElement.innerHTML = "";
     let docLinks = [];
     for each (let link in notification.links)
       docLinks.push(Utils.getDocLink(link));
     insertMessage(messageElement, texts.message, docLinks);
 
     messageElement.addEventListener("click", function(event)
     {
       let link = event.target;
-      while (link && link !== messageElement && link.localName !== "a")
-        link = link.parentNode;
-      if (!link)
+      while (!link || link === messageElement || link.localName !== "a")

[Felix Dahlke, 2014/02/11 17:57:17]

Shouldn't this be an "if"?

Anyway, why aren't we bubbling up anymore?

[Thomas Greiner, 2014/02/12 11:58:49]

Done.

The bubbling lead to the link opening no matter where you clicked on the panel.
I fixed it now in a different way to allow bubbling again.

         return;
       event.preventDefault();
       event.stopPropagation();
       this.loadInBrowser(link.href, window);
     }.bind(this));
 
-    let panel = window.document.getElementById("abp-notification");
+    if (notification.severity === "question")
+    {
+      function buttonHandler(event)
+      {
+        event.preventDefault();
+        event.stopPropagation();
+        panel.hidePopup();
+
+        let action = notification[event.target.getAttribute("action")];
+        if (typeof action === "function")
+          action();
+        Notification.markAsShown(notification.id);
+      }
+      window.document.getElementById("abp-notification-yes").oncommand = buttonHandler;
+      window.document.getElementById("abp-notification-no").oncommand = buttonHandler;
+    }
+
+    panel.setAttribute("class", "abp-" + notification.severity);
+    panel.setAttribute("noautohide", notification.severity === "question");
     panel.openPopup(button, "bottomcenter topcenter", 0, 0, false, false, null);
   }
 };
 UI.onPopupShowing = UI.onPopupShowing.bind(UI);
 UI.onKeyPress = UI.onKeyPress.bind(UI);
 UI.onIconClick = UI.onIconClick.bind(UI);
 UI.init();
 
 /**
  * List of event handers to be registered for each window. For each event
@@ skipping 16 matching lines @@
   ["abp-command-contribute", "command", UI.openContributePage.bind(UI)],
   ["abp-command-contribute-hide", "command", UI.hideContributeButton.bind(UI)]
 ];
 
 onShutdown.add(function()
 {
   for (let window in UI.applicationWindows)
     if (UI.isBottombarOpen(window))
       UI.toggleBottombar(window);
 });