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
@@ skipping 380 matching lines @@
 
       if (this.overlay.all.length)
         this.overlay.all[0].appendChild(menuSource);
       if ("abp-toolbarbutton" in this.overlay)
         this.overlay["abp-toolbarbutton"].appendChild(fixId(menuSource.cloneNode(true), "abp-toolbar"));
       if ("abp-menuitem" in this.overlay)
         this.overlay["abp-menuitem"].appendChild(fixId(menuSource.cloneNode(true), "abp-menuitem"));
     }
   },
 
-  initAntiAdblockNotification: function()

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

Shouldn't this be "private"?

[Thomas Greiner, 2014/02/12 18:28:02]

Done.

+  _initAntiAdblockNotification: function()
   {
     let notification = {

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

I think we should move this into addAntiAdblockNotification since it's only used
there. Similarly, I think we should register the listener in
addAntiAdblockNotification.

[Thomas Greiner, 2014/02/12 18:28:02]

No, it's also used to remove the notification (see line 449). I moved the
removal code into its own function now to make it clearer (and also added a call
to Notification.removeQuestionListener in there).

[Felix Dahlke, 2014/02/13 10:22:04]

Oh, right.

       id: "antiadblock",
-      severity: "question",
+      type: "question",
       title: Utils.getString("notification_antiadblock_title"),
       message: Utils.getString("notification_antiadblock_message"),
       urlFilters: []
     };
+
+    function notificationListener(approved)
+    {
+      let subscription = Subscription.fromURL(Prefs.subscriptions_antiadblockurl);
+      if (subscription.url in FilterStorage.knownSubscriptions)
+        subscription.disabled = !approved;
+    }
 
     function addAntiAdblockNotification(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);
       notification.urlFilters = urlFilters;
       Notification.addNotification(notification);
+      Notification.addQuestionListener(notification.id, notificationListener);
+    }
+
+    function removeAntiAdblockNotification()
+    {
+      Notification.removeNotification(notification);
+      Notification.removeQuestionListener(notification.id, notificationListener);
     }
 
     let subscription = Subscription.fromURL(Prefs.subscriptions_antiadblockurl);
     if (subscription.lastDownload && subscription.disabled)
-    {
       addAntiAdblockNotification(subscription);
-    }
-
-    function notificationListener(id, approved)
-    {
-      if (id !== notification.id)
-        return;
-
-      let subscription = Subscription.fromURL(Prefs.subscriptions_antiadblockurl);
-      if (subscription.url in FilterStorage.knownSubscriptions)
-        subscription.disabled = !approved;
-    }
-    Notification.addListener(notificationListener);
 
     FilterNotifier.addListener(function(action, value, newItem, oldItem)
     {
       if (!/^subscription\.(updated|removed|disabled)$/.test(action) || value.url != Prefs.subscriptions_antiadblockurl)
         return;
 
       if (action == "subscription.updated")
         addAntiAdblockNotification(value);
       else if (action == "subscription.removed" || (action == "subscription.disabled" && !value.disabled))
-      {
-        Notification.removeNotification(notification);
-      }
+        removeAntiAdblockNotification();
     });
 
     var documentCreationObserver = {
       observe: function(subject, topic, data) 
       {
         if (!(subject instanceof Ci.nsIDOMWindow))
           return;
         
         this._showNextNotification(subject.location.href);
       }.bind(this)
@@ skipping 131 matching lines @@
       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
-    this.initAntiAdblockNotification();
+    this._initAntiAdblockNotification();
 
     // First-run actions?
     if (!this.firstRunDone)
     {
       this.firstRunDone = true;
 
       let {addonVersion} = require("info");
       let prevVersion = Prefs.currentVersion;
       if (prevVersion != addonVersion)
       {
@@ skipping 1299 matching lines @@
       let link = event.target;
       while (link && link !== messageElement && link.localName !== "a")
         link = link.parentNode;
       if (!link || link.localName !== "a")
         return;
       event.preventDefault();
       event.stopPropagation();
       this.loadInBrowser(link.href, window);
     }.bind(this));
 
-    if (notification.severity === "question")
+    if (notification.type === "question")
     {
       function buttonHandler(approved, event)
       {
         event.preventDefault();
         event.stopPropagation();
         panel.hidePopup();
-        Notification.triggerListeners(notification.id, approved)
+        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);
     }
 
-    panel.setAttribute("class", "abp-" + notification.severity);
-    panel.setAttribute("noautohide", notification.severity === "question");
+    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
@@ 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);
 });