Issue 3869 - Use the new FilterNotifier API

messageResponder.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 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 36 matching lines @@
       result[keys[i]] = obj[keys[i]];
     return result;
   }
 
   var convertSubscription = convertObject.bind(null, ["disabled",
     "downloadStatus", "homepage", "lastDownload", "title", "url"]);
   var convertFilter = convertObject.bind(null, ["text"]);
 
   var changeListeners = new global.ext.PageMap();
   var listenedPreferences = [];
+  var listenedFilterChanges = [];
   var messageTypes = {
     "app": "app.listen",
     "filter": "filters.listen",
     "pref": "prefs.listen",
     "subscription": "subscriptions.listen"
   };
 
-  function sendMessage(type, action, args)
+  function sendMessage(type, action)
   {
     var pages = changeListeners.keys();
-    for (var i = 0; i < pages.length; i++)
-    {
-      var filters = changeListeners.get(pages[i]);
-      var actions = filters[type];
-      if (actions && actions.indexOf(action) != -1)
-      {
-        pages[i].sendMessage({
-          type:  messageTypes[type],
-          action: action,
-          args: args
-        });
-      }
-    }
-  }
-
-  function onFilterChange(action)
-  {
-    var type;
-    if (action == "load")
-    {
-      type = "filter";
-      action = "loaded";
-    }
-    else
-    {
-      var parts = action.split(".");
-      type = parts[0];
-      action = parts[1];
-    }
-
-    if (!(type in messageTypes))
+    if (pages.length == 0)
       return;
 
     var args = [];
-    for (var i = 1; i < arguments.length; i++)
+    for (var i = 2; i < arguments.length; i++)
     {
       var arg = arguments[i];
       if (arg instanceof Subscription)
         args.push(convertSubscription(arg));
       else if (arg instanceof Filter)
         args.push(convertFilter(arg));
       else
         args.push(arg);
     }
 
-    sendMessage(type, action, args);
+    for (var j = 0; j < pages.length; j++)
+    {
+      var page = pages[j];
+      var filters = changeListeners.get(page);
+      var actions = filters[type];
+      if (actions && actions.indexOf(action) != -1)
+      {
+        page.sendMessage({
+          type: messageTypes[type],
+          action: action,
+          args: args
+        });
+      }
+    }
+  }
+
+  function addFilterListeners(type, actions)
+  {
+    actions.forEach(function(action)
+    {
+      var name;
+      if (type == "filter" && action == "loaded")
+        name = "load";
+      else
+        name = type + "." + action;
+
+      if (listenedFilterChanges.indexOf(name) == -1)
+      {
+        listenedFilterChanges.push(name);
+        FilterNotifier.on(name, function()
+        {
+          var args = [type, action];
+          for (var i = 0; i < arguments.length; i++)
+            args.push(arguments[i]);
+          sendMessage.apply(null, args);
+        });
+      }
+    });
   }
 
   function getListenerFilters(page)
   {
     var listenerFilters = changeListeners.get(page);
     if (!listenerFilters)
     {
       listenerFilters = Object.create(null);
       changeListeners.set(page, listenerFilters);
     }
@@ skipping 47 matching lines @@
             devToolsPanel: info.platform == "chromium",
             safariContentBlocker: "safari" in global
                 && "extension" in global.safari
                 && "setContentBlocker" in global.safari.extension
           });
         }
         else
           callback(null);
         break;
       case "app.listen":
-        var listenerFilters = getListenerFilters(sender.page);
-        if (message.filter)
-          listenerFilters.app = message.filter;
-        else
-          delete listenerFilters.app;
+        getListenerFilters(sender.page).app = message.filter;
         break;
       case "app.open":
         if (message.what == "options")
           ext.showOptions();
         break;
       case "filters.add":
         var result = require("filterValidation").parseFilter(message.text);
         var errors = [];
         if (result.error)
           errors.push(result.error.toString());
@@ skipping 76 matching lines @@
             var filter = subscription.filters[j];
             if (/^@@\|\|([^\/:]+)\^\$document$/.test(filter.text))
               continue;
 
             if (!(filter.text in seenFilter))
               FilterStorage.removeFilter(filter);
           }
         }
         break;
       case "filters.listen":
-        var listenerFilters = getListenerFilters(sender.page);
-        if (message.filter)
-        {
-          FilterNotifier.addListener(onFilterChange);
-          listenerFilters.filter = message.filter;
-        }
-        else
-          delete listenerFilters.filter;
+        getListenerFilters(sender.page).filter = message.filter;
+        addFilterListeners("filter", message.filter);
         break;
       case "filters.remove":
         var filter = Filter.fromText(message.text);
         var subscription = null;
         if (message.subscriptionUrl)
           subscription = Subscription.fromURL(message.subscriptionUrl);
 
         if (!subscription)
           FilterStorage.removeFilter(filter);
         else
           FilterStorage.removeFilter(filter, subscription, message.index);
         break;
       case "prefs.get":
         callback(Prefs[message.key]);
         break;
       case "prefs.listen":
-        var listenerFilters = getListenerFilters(sender.page);
-        if (message.filter)
+        getListenerFilters(sender.page).pref = message.filter;
+        message.filter.forEach(function(preference)
         {
-          message.filter.forEach(function(preference)
+          if (listenedPreferences.indexOf(preference) == -1)
           {
-            if (listenedPreferences.indexOf(preference) == -1)
+            listenedPreferences.push(preference);
+            Prefs.on(preference, function()
             {
-              listenedPreferences.push(preference);
-              Prefs.on(preference, function()
-              {
-                sendMessage("pref", preference, [Prefs[preference]]);
-              });
-            }
-          });
-          listenerFilters.pref = message.filter;
-        }
-        else
-          delete listenerFilters.pref;
+              sendMessage("pref", preference, Prefs[preference]);
+            });
+          }
+        });
         break;
       case "prefs.toggle":
         if (message.key == "notifications_ignoredcategories")
           NotificationStorage.toggleIgnoreCategory("*");
         else
           Prefs[message.key] = !Prefs[message.key];
         break;
       case "subscriptions.add":
         var subscription = Subscription.fromURL(message.url);
         if ("title" in message)
           subscription.title = message.title;
         if ("homepage" in message)
           subscription.homepage = message.homepage;
 
         if (message.confirm)
         {
           ext.showOptions(function()
           {
-            sendMessage("app", "addSubscription", [convertSubscription(subscription)]);
+            sendMessage("app", "addSubscription", subscription);
           });
         }
         else
         {
           subscription.disabled = false;
           FilterStorage.addSubscription(subscription);
 
           if (subscription instanceof DownloadableSubscription && !subscription.lastDownload)
             Synchronizer.execute(subscription);
         }
         break;
       case "subscriptions.get":
         var subscriptions = FilterStorage.subscriptions.filter(function(s)
         {
           if (message.ignoreDisabled && s.disabled)
             return false;
           if (s instanceof DownloadableSubscription && message.downloadable)
             return true;
           if (s instanceof SpecialSubscription && message.special)
             return true;
           return false;
         });
         callback(subscriptions.map(convertSubscription));
         break;
       case "subscriptions.listen":
-        var listenerFilters = getListenerFilters(sender.page);
-        if (message.filter)
-        {
-          FilterNotifier.addListener(onFilterChange);
-          listenerFilters.subscription = message.filter;
-        }
-        else
-          delete listenerFilters.subscription;
+        getListenerFilters(sender.page).subscription = message.filter;
+        addFilterListeners("subscription", message.filter);
         break;
       case "subscriptions.remove":
         var subscription = Subscription.fromURL(message.url);
         if (subscription.url in FilterStorage.knownSubscriptions)
           FilterStorage.removeSubscription(subscription);
         break;
       case "subscriptions.toggle":
         var subscription = Subscription.fromURL(message.url);
         if (subscription.url in FilterStorage.knownSubscriptions)
         {
           if (subscription.disabled || message.keepInstalled)
-          {
             subscription.disabled = !subscription.disabled;
-            FilterNotifier.triggerListeners("subscription.disabled",
-                                            subscription);
-          }
           else
             FilterStorage.removeSubscription(subscription);
         }
         else
         {
           subscription.disabled = false;
           subscription.title = message.title;
           subscription.homepage = message.homepage;
           FilterStorage.addSubscription(subscription);
           if (!subscription.lastDownload)
             Synchronizer.execute(subscription);
         }
         break;
       case "subscriptions.update":
         var subscriptions = message.url ? [Subscription.fromURL(message.url)] :
                             FilterStorage.subscriptions;
         for (var i = 0; i < subscriptions.length; i++)
         {
           var subscription = subscriptions[i];
           if (subscription instanceof DownloadableSubscription)
             Synchronizer.execute(subscription, true);
         }
         break;
       case "subscriptions.isDownloading":
         callback(Synchronizer.isExecuting(message.url));
         break;
     }
   });
 })(this);