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)
   {
     var pages = changeListeners.keys();

[Sebastian Noack, 2016/03/19 19:17:29]

This is unrelated, but since page is never specified, I used the chance to get
rid of the dead code here.

     for (var i = 0; i < pages.length; i++)
     {
       var filters = changeListeners.get(pages[i]);
       var actions = filters[type];
-      if (actions && !(actions instanceof Array && actions.indexOf(action) == -1))

[Sebastian Noack, 2016/03/19 19:17:29]

filters.pref is an object now, not an array anymore. And filtering is done by
Prefs.on, so it can/must be skipped here.

+      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)
-    {
-      type = "app";
-      action = parts[0];
+    {
+      type = "filter";
+      action = "loaded";
     }
     else
     {
+      var parts = action.split(".");
       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++)
+    {
+      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 getListenerFilters(page)
+  {
+    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);
-      }
-
-      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);
           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":
-        for (var preference in listenerFilters.pref)
-          Prefs.off(preference, listenerFilters.pref[preference]);
-
+        var listenerFilters = getListenerFilters(sender.page);
         if (message.filter)
         {
-          listenerFilters.pref = Object.create(null);
           message.filter.forEach(function(preference)
           {
-            function callback()
+            if (listenedPreferences.indexOf(preference) == -1)
             {
-              sendMessage("prefs", preference, [Prefs[preference]]);
+              listenedPreferences.push(preference);
+              Prefs.on(preference, function()
+              {
+                sendMessage("pref", preference, [Prefs[preference]]);
+              });
             }
-
-            listenerFilters.pref[preference] = callback;
-            Prefs.on(preference, callback);
           });
+          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)]);
           });
         }
         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);