Issue 3839 - Adapt for Prefs event changes

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 34 matching lines @@
     var result = {};
     for (var i = 0; i < keys.length; i++)
       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 = null;
+  var changeListeners = new global.ext.PageMap();
+  var listenedPreferences = [];
   var messageTypes = {
     "app": "app.listen",
     "filter": "filters.listen",
     "pref": "prefs.listen",
     "subscription": "subscriptions.listen"
   };
 
-  function sendMessage(type, action, args, page)
+  function sendMessage(type, action, args)
   {
-    var pages = page ? [page] : changeListeners.keys();
+    var pages = changeListeners.keys();
     for (var i = 0; i < pages.length; i++)
     {
       var filters = changeListeners.get(pages[i]);
-      if (filters[type] && filters[type].indexOf(action) >= 0)
+      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")
-      action = "filter.loaded";
-
-    var parts = action.split(".", 2);
-    var type;
-    if (parts.length == 1)

[Thomas Greiner, 2016/03/22 13:29:40]

What about other events dispatched by `FilterNotifier`? e.g. "elemhideupdate"
and "save"

So far we've been converting them to "app.*" to ensure that all event names have
two parts. However, we could simply throw them away if you think that's more
reasonable.

[Sebastian Noack, 2016/03/22 14:24:11]

Currently "app.addSubscription" is the only "app.*" event the UI is interested
in. And it might be cleaner to leave that namespace to events not coming from
FilterNotifier. As for "saved" I think it should rather be "filters.saved" for
consistency with "filters.loaded" but as long as we don't need it in the UI, I'd
prefer to ingore that case and bail out early here.

     {
-      type = "app";
-      action = parts[0];
+      type = "filter";
+      action = "loaded";
     }
     else
     {
+      var parts = action.split(".", 2);

[Sebastian Noack, 2016/03/22 14:24:10]

I just realized that the second argument is redundant as .split(".", 2) is just
a shorthand for .split(".").slice(0,2) in JavaScript.

       type = parts[0];
       action = parts[1];
     }
 
-    if (!messageTypes.hasOwnProperty(type))
+    if (!(type in messageTypes))
       return;
 
-    var args = Array.prototype.slice.call(arguments, 1).map(function(arg)
+    var args = [];
+    for (var i = 1; i < arguments.length; i++)

[Sebastian Noack, 2016/03/22 07:29:56]

Note that passing arguments to other functions will cause this function from
beeing deoptimized in V8. So while cleaning up here, I fixed that as well.

     {
+      var arg = arguments[i];
       if (arg instanceof Subscription)
-        return convertSubscription(arg);
+        args.push(convertSubscription(arg));
       else if (arg instanceof Filter)
-        return convertFilter(arg);
+        args.push(convertFilter(arg));
       else
-        return arg;
-    });
+        args.push(arg);
+    }
+
     sendMessage(type, action, args);
   }
 
-  function onPrefChange(name)
+  function getListenerFilters(page)
   {
-    sendMessage("pref", name, [Prefs[name]]);
+    var listenerFilters = changeListeners.get(page);
+    if (!listenerFilters)
+    {
+      listenerFilters = Object.create(null);
+      changeListeners.set(page, listenerFilters);
+    }
+    return listenerFilters;
   }
 
   global.ext.onMessage.addListener(function(message, sender, callback)
   {
-    var listenerFilters = null;
-    if (/\.listen$/.test(message.type))
-    {
-      if (!changeListeners)
-      {
-        changeListeners = new global.ext.PageMap();
-        FilterNotifier.addListener(onFilterChange);
-        Prefs.onChanged.addListener(onPrefChange);
-      }
-
-      listenerFilters = changeListeners.get(sender.page);
-      if (!listenerFilters)
-      {
-        listenerFilters = Object.create(null);
-        changeListeners.set(sender.page, listenerFilters);
-      }
-    }
-
     switch (message.type)
     {
       case "app.get":
         if (message.what == "issues")
         {
           var subscriptionInit;
           try
           {
             subscriptionInit = require("subscriptionInit");
           }
@@ skipping 32 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;
         break;
       case "app.open":
         if (message.what == "options")
           ext.showOptions();
         break;
       case "filters.add":
@@ skipping 80 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);

[Sebastian Noack, 2016/03/22 07:29:56]

Since FilterNotifier.addListener() only adds the listener if it hasn't been
added before, we can just add onFilterChange when we need it, without bothering
whether we added it before.

           listenerFilters.filter = message.filter;
+        }
         else
           delete listenerFilters.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)
+        {
+          message.filter.forEach(function(preference)
+          {
+            if (listenedPreferences.indexOf(preference) == -1)
+            {
+              listenedPreferences.push(preference);
+              Prefs.on(preference, function()
+              {
+                sendMessage("pref", preference, [Prefs[preference]]);
+              });
+            }
+          });
           listenerFilters.pref = message.filter;
+        }
         else
           delete listenerFilters.pref;
         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()
           {
-            onFilterChange("addSubscription", subscription);
+            sendMessage("app", "addSubscription", [convertSubscription(subscription)]);

[Sebastian Noack, 2016/03/22 07:29:56]

Sorry for the unrelated change, but it seems inappropriate to call
onFilterChange() here. Also if we don't the logic of onFilterChange() can be
simplified a little.

           });
         }
         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;
         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);
@@ skipping 27 matching lines @@
           if (subscription instanceof DownloadableSubscription)
             Synchronizer.execute(subscription, true);
         }
         break;
       case "subscriptions.isDownloading":
         callback(Synchronizer.isExecuting(message.url));
         break;
     }
   });
 })(this);