Issue 2211 - Implemented subscribe.adblockplus.org subscription links

lib/ui.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 107 matching lines @@
         return;
       }
 
       setChecked("adblockplus-savestats", Prefs.savestats);
       addCommandHandler("adblockplus-savestats", function()
       {
         UI.toggleSaveStats(doc.defaultView);
         this.value = Prefs.savestats;
       });
 
+      hideElement("adblockplus-shownotifications", !Prefs.notifications_showui);
+      setChecked("adblockplus-shownotifications", Prefs.notifications_ignoredcategories.indexOf("*") == -1);
+      addCommandHandler("adblockplus-shownotifications", function()
+      {
+        Notification.toggleIgnoreCategory("*");
+        this.value = (Prefs.notifications_ignoredcategories.indexOf("*") == -1);
+      });
+
       let hasAcceptableAds = FilterStorage.subscriptions.some((subscription) => subscription instanceof DownloadableSubscription &&
         subscription.url == Prefs.subscriptions_exceptionsurl);
       setChecked("adblockplus-acceptableAds", hasAcceptableAds);
       addCommandHandler("adblockplus-acceptableAds", function()
       {
         this.value = UI.toggleAcceptableAds();
       });
 
       setChecked("adblockplus-sync", syncEngine && syncEngine.enabled);
       addCommandHandler("adblockplus-sync", function()
@@ skipping 14 matching lines @@
         // Load subscriptions data
         let request = new XMLHttpRequest();
         request.mozBackgroundRequest = true;
         request.open("GET", "chrome://adblockplus/content/ui/subscriptions.xml");
         request.addEventListener("load", function()
         {
           if (onShutdown.done)
             return;
 
           let currentSubscription = FilterStorage.subscriptions.filter((subscription) => subscription instanceof DownloadableSubscription &&
-            subscription.url != Prefs.subscriptions_exceptionsurl && 
+            subscription.url != Prefs.subscriptions_exceptionsurl &&
             subscription.url != Prefs.subscriptions_antiadblockurl);
           currentSubscription = (currentSubscription.length ? currentSubscription[0] : null);
 
           let subscriptions =request.responseXML.getElementsByTagName("subscription");
           for (let i = 0; i < subscriptions.length; i++)
           {
             let item = subscriptions[i];
             let url = item.getAttribute("url");
             if (!url)
               continue;
@@ skipping 229 matching lines @@
     // The icon might be added already, make sure its state is correct
     this.updateState();
 
     // Listen for pref and filters changes
     Prefs.addListener(function(name)
     {
       if (name == "enabled" || name == "defaulttoolbaraction" || name == "defaultstatusbaraction")
         this.updateState();
       else if (name == "showinstatusbar")
       {
-        for (let window in this.applicationWindows)
+        for (let window of this.applicationWindows)
           this.updateStatusbarIcon(window);
       }
     }.bind(this));
     FilterNotifier.addListener(function(action)
     {
       if (/^(filter|subscription)\.(added|removed|disabled|updated)$/.test(action) || action == "load")
         this.updateState();
     }.bind(this));
 
-    notificationTimer = Cc["@mozilla.org/timer;1"].createInstance(Ci.nsITimer);
-    notificationTimer.initWithCallback(this.showNextNotification.bind(this),
-                                       3 * 60 * 1000, Ci.nsITimer.TYPE_ONE_SHOT);
-    onShutdown.add(() => notificationTimer.cancel());
+    Notification.addShowListener(notification =>
+    {
+      let window = this.currentWindow;
+      if (!window)
+        return;
+
+      let button = window.document.getElementById("abp-toolbarbutton")
+          || window.document.getElementById("abp-status");
+      if (!button)
+        return;
+
+      this._showNotification(window, button, notification);
+    });
 
     // Add "anti-adblock messages" notification
     initAntiAdblockNotification();
 
     let documentCreationObserver = {
       observe: function(subject, topic, data)
       {
         if (!(subject instanceof Ci.nsIDOMWindow))
           return;
 
-        this.showNextNotification(subject.location.href);
+        Notification.showNext(subject.location.href);
       }.bind(UI)
     };
     Services.obs.addObserver(documentCreationObserver, "content-document-global-created", false);
     onShutdown.add(function()
     {
       Services.obs.removeObserver(documentCreationObserver, "content-document-global-created", false);
     });
 
     // Execute first-run actions if a window is open already, otherwise it
     // will happen in applyToWindow() when a window is opened.
     this.firstRunActions(this.currentWindow);
   },
 
   addToolbarButton: function()
   {
     let {WindowObserver} = require("windowObserver");
     new WindowObserver(this);
 
     let {defaultToolbarPosition} = require("appSupport");
     if ("abp-toolbarbutton" in this.overlay && defaultToolbarPosition)
     {
       try
       {
-        ({CustomizableUI}) = Cu.import("resource:///modules/CustomizableUI.jsm", null);
+        ({CustomizableUI} = Cu.import("resource:///modules/CustomizableUI.jsm", null));
       }
       catch (e)
       {
         // No built-in CustomizableUI API, use our own implementation.
-        ({CustomizableUI}) = require("customizableUI");
+        ({CustomizableUI} = require("customizableUI"));
       }
 
       CustomizableUI.createWidget({
         id: "abp-toolbarbutton",
         type: "custom",
         positionAttribute: "abp-iconposition",        // For emulation only
         defaultArea: defaultToolbarPosition.parent,
         defaultBefore: defaultToolbarPosition.before, // For emulation only
         defaultAfter: defaultToolbarPosition.after,   // For emulation only
         removable: true,
@@ skipping 95 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();
+    let notificationPanel = window.document.getElementById("abp-notification");
+    notificationPanel.addEventListener("command", function(event)
+    {
+      switch (event.target.id)
+      {
+        case "abp-notification-close":
+          notificationPanel.classList.add("abp-closing");
+          break;
+        case "abp-notification-optout":
+          Notification.toggleIgnoreCategory("*", true);
+          /* FALL THROUGH */
+        case "abp-notification-hide":
+          notificationPanel.hidePopup();
+          break;
+      }
     }, false);
 
     // First-run actions?
     this.firstRunActions(window);
 
     // Some people actually switch off browser.frames.enabled and are surprised
     // that things stop working...
     window.QueryInterface(Ci.nsIInterfaceRequestor)
           .getInterface(Ci.nsIWebNavigation)
           .QueryInterface(Ci.nsIDocShell)
@@ skipping 294 matching lines @@
         }
       }, false);
       request.send();
     }
     else
       notifyUser();
   },
 
   /**
    * Handles clicks inside the browser's content area, will intercept clicks on
-   * abp: links as well as links to subscribe.adblockplus.org. This can be called
-   * either with an event object or with the link target (if it is the former then

[Wladimir Palant, 2015/04/01 17:49:31]

Nit: Please stick to the 80 characters line limit.

[Thomas Greiner, 2015/04/02 14:26:43]

Done. I also added a preference to my editor to notice that in the future. :)

-   * link target will be retrieved from event target).
-   */
-  onBrowserClick: function (/**Window*/ window, /**Event*/ event, /**String*/ linkTarget)

[Wladimir Palant, 2015/04/01 17:49:31]

It seems that the linkTarget parameter is no longer used. I traced that
parameter back to https://hg.adblockplus.org/adblockplus/rev/96ef08f7d6ea - it
was added to support E10S in Firefox Mobile. With the click being intercepted by
a content script there was no event object.

While we might have to add something like this again eventually, for now it
should be better to remove dead code and simplify the logic. Particularly given
that there is currently no way to test this code path...

[Thomas Greiner, 2015/04/02 14:26:43]

Done.

-  {
-    let link = null;
-    if (linkTarget)
-    {
-      try
-      {
-        link = new URL(linkTarget);
-      }
-      catch(ex)
-      {
-        // Don't handle links with invalid URLs
+   * abp: links as well as links to subscribe.adblockplus.org.
+   */
+  onBrowserClick: function (/**Window*/ window, /**Event*/ event)
+  {
+    // Ignore right-clicks
+    if (event.button == 2)
+      return;
+
+    // Search the link associated with the click
+    let link = event.target;
+    while (!(link instanceof Ci.nsIDOMHTMLAnchorElement))
+    {
+      link = link.parentNode;
+
+      if (!link)
         return;
-      }
-    }
-
-    if (event)
-    {
-      // Ignore right-clicks
-      if (event.button == 2)
-        return;
-
-      // Search the link associated with the click
-      link = event.target;
-      while (!(link instanceof Ci.nsIDOMHTMLAnchorElement))
-      {
-        link = link.parentNode;
-
-        if (!link)
-          return;
-      }
     }
 
     let queryString = null;
     if (link.protocol == "http:" || link.protocol == "https:")
     {
-      if (link.host == "subscribe.adblockplus.org" || link.pathname == "/")
+      if (link.host == "subscribe.adblockplus.org" && link.pathname == "/")
         queryString = link.search.substr(1);
     }
     else
     {
       // Firefox doesn't populate the "search" property for links with
       // non-standard URL schemes so we need to extract the query string
       // manually
       let match = /^abp:\/*subscribe\/*\?(.*)/i.exec(link.href);
       if (match)
         queryString = match[1];
     }
 
     if (!queryString)
       return;
 
-    if (event)
-    {
-      // This is our link - make sure the browser doesn't handle it
-      event.preventDefault();
-      event.stopPropagation();
-    }
+    // This is our link - make sure the browser doesn't handle it
+    event.preventDefault();
+    event.stopPropagation();
 
     // Decode URL parameters
     let title = null;
     let url = null;
     let mainSubscriptionTitle = null;
     let mainSubscriptionURL = null;
     for (let param of queryString.split("&"))
     {
       let parts = param.split("=", 2);
       if (parts.length != 2 || !/\S/.test(parts[1]))
@@ skipping 140 matching lines @@
       let {defaultToolbarPosition} = require("appSupport");
       CustomizableUI.addWidgetToArea("abp-toolbarbutton", defaultToolbarPosition.parent);
     }
   },
 
   /**
    * Updates Adblock Plus icon state for all windows.
    */
   updateState: function()
   {
-    for (let window in this.applicationWindows)
+    for (let window of this.applicationWindows)
     {
       this.updateIconState(window, window.document.getElementById("abp-status"));
       this.updateIconState(window, window.document.getElementById("abp-toolbarbutton"));
     }
   },
 
   /**
    * Updates Adblock Plus icon state for a single application window.
    */
   updateIconState: function(/**Window*/ window, /**Element*/ icon)
@@ skipping 448 matching lines @@
 
     setChecked(prefix + "disabled", !Prefs.enabled);
     setChecked(prefix + "frameobjects", Prefs.frameobjects);
     setChecked(prefix + "savestats", Prefs.savestats);
 
     let {defaultToolbarPosition, statusbarPosition} = require("appSupport");
     let hasToolbar = defaultToolbarPosition;
     let hasStatusBar = statusbarPosition;
     hideElement(prefix + "showintoolbar", !hasToolbar || prefix == "abp-toolbar-");
     hideElement(prefix + "showinstatusbar", !hasStatusBar);
+    hideElement(prefix + "shownotifications", !Prefs.notifications_showui);
     hideElement(prefix + "iconSettingsSeparator", (prefix == "abp-toolbar-" || !hasToolbar) && !hasStatusBar);
 
     setChecked(prefix + "showintoolbar", this.isToolbarIconVisible());
     setChecked(prefix + "showinstatusbar", Prefs.showinstatusbar);
+    setChecked(prefix + "shownotifications", Prefs.notifications_ignoredcategories.indexOf("*") == -1);
 
     let {Sync} = require("sync");
     let syncEngine = Sync.getEngine();
     hideElement(prefix + "sync", !syncEngine);
     setChecked(prefix + "sync", syncEngine && syncEngine.enabled);
 
     let defAction = (!window.document.popupNode || window.document.popupNode.id == "abp-toolbarbutton" ?
                      Prefs.defaulttoolbaraction :
                      Prefs.defaultstatusbaraction);
     setDefault(prefix + "openbottombar", defAction == 1);
@@ skipping 271 matching lines @@
     Prefs.hideContributeButton = true;
 
     for (let id of ["abp-status-contributebutton", "abp-toolbar-contributebutton", "abp-menuitem-contributebutton"])
     {
       let button = window.document.getElementById(id);
       if (button)
         button.hidden = true;
     }
   },
 
-  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(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)
@@ skipping 45 matching lines @@
       {
         event.preventDefault();
         event.stopPropagation();
         panel.hidePopup();
         Notification.triggerQuestionListeners(notification.id, approved)
         Notification.markAsShown(notification.id);
       }
       window.document.getElementById("abp-notification-yes").onclick = buttonHandler.bind(null, true);
       window.document.getElementById("abp-notification-no").onclick = buttonHandler.bind(null, false);
     }
+    else
+      Notification.markAsShown(notification.id);
 
     panel.setAttribute("class", "abp-" + notification.type);
     panel.setAttribute("noautohide", notification.type === "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
  * handler the element ID, event and the actual event handler are listed.
  * @type Array
  */
 let eventHandlers = [
   ["abp-command-sendReport", "command", UI.openReportDialog.bind(UI)],
   ["abp-command-filters", "command", UI.openFiltersDialog.bind(UI)],
   ["abp-command-sidebar", "command", UI.toggleBottombar.bind(UI)],
   ["abp-command-togglesitewhitelist", "command", function() { UI.toggleFilter(siteWhitelist); }],
   ["abp-command-togglepagewhitelist", "command", function() { UI.toggleFilter(pageWhitelist); }],
   ["abp-command-toggleobjtabs", "command", UI.togglePref.bind(UI, "frameobjects")],
   ["abp-command-togglesavestats", "command", UI.toggleSaveStats.bind(UI)],
   ["abp-command-togglesync", "command", UI.toggleSync.bind(UI)],
   ["abp-command-toggleshowintoolbar", "command", UI.toggleToolbarIcon.bind(UI)],
   ["abp-command-toggleshowinstatusbar", "command", UI.togglePref.bind(UI, "showinstatusbar")],
   ["abp-command-enable", "command", UI.togglePref.bind(UI, "enabled")],
   ["abp-command-contribute", "command", UI.openContributePage.bind(UI)],
-  ["abp-command-contribute-hide", "command", UI.hideContributeButton.bind(UI)]
+  ["abp-command-contribute-hide", "command", UI.hideContributeButton.bind(UI)],
+  ["abp-command-toggleshownotifications", "command", Notification.toggleIgnoreCategory.bind(Notification, "*", null)]
 ];
 
 onShutdown.add(function()
 {
-  for (let window in UI.applicationWindows)
+  for (let window of UI.applicationWindows)
     if (UI.isBottombarOpen(window))
       UI.toggleBottombar(window);
 });