Issue 2374 - Implemented Tweaks section in options page

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
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 (function(global)
 {
   if (!global.ext)
     global.ext = require("ext_background");
 
   var Prefs = require("prefs").Prefs;
   var Utils = require("utils").Utils;
   var FilterStorage = require("filterStorage").FilterStorage;
   var FilterNotifier = require("filterNotifier").FilterNotifier;
   var defaultMatcher = require("matcher").defaultMatcher;
   var CSSRules = require("cssRules").CSSRules;
+  var NotificationStorage = require("notification").Notification;
 
   var filterClasses = require("filterClasses");
   var Filter = filterClasses.Filter;
   var BlockingFilter = filterClasses.BlockingFilter;
   var RegExpFilter = filterClasses.RegExpFilter;
   var Synchronizer = require("synchronizer").Synchronizer;
 
   var subscriptionClasses = require("subscriptionClasses");
   var Subscription = subscriptionClasses.Subscription;
   var DownloadableSubscription = subscriptionClasses.DownloadableSubscription;
   var SpecialSubscription = subscriptionClasses.SpecialSubscription;
 
   function convertObject(keys, obj)
   {
     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 messageTypes = {
     "app": "app.listen",
     "filter": "filters.listen",
+    "pref": "prefs.listen",
     "subscription": "subscriptions.listen"
   };
 
   function sendMessage(type, action, args, page)
   {
     var pages = page ? [page] : changeListeners.keys();
     for (var i = 0; i < pages.length; i++)
     {
       var filters = changeListeners.get(pages[i]);
       if (filters[type] && filters[type].indexOf(action) >= 0)
@@ skipping 33 matching lines @@
       if (arg instanceof Subscription)
         return convertSubscription(arg);
       else if (arg instanceof Filter)
         return convertFilter(arg);
       else
         return arg;
     });
     sendMessage(type, action, args);
   }
 
+  function onPrefChange(name)
+  {
+    sendMessage("pref", name, [Prefs[name]]);
+  }
+
   global.ext.onMessage.addListener(function(message, sender, callback)
   {
     var listenerFilters = null;
-    switch (message.type)
+    if (/\.listen$/.test(message.type))
     {
-      case "app.listen":
-      case "filters.listen":
-      case "subscriptions.listen":
-        if (!changeListeners)
-        {
-          changeListeners = new global.ext.PageMap();
-          FilterNotifier.addListener(onFilterChange);
-        }
+      if (!changeListeners)
+      {
+        changeListeners = new global.ext.PageMap();
+        FilterNotifier.addListener(onFilterChange);
+        Prefs.addListener(onPrefChange);
+      }
 
-        listenerFilters = changeListeners.get(sender.page);
-        if (!listenerFilters)
-        {
-          listenerFilters = Object.create(null);
-          changeListeners.set(sender.page, listenerFilters);
-        }
-        break;
+      listenerFilters = changeListeners.get(sender.page);
+      if (!listenerFilters)
+      {
+        listenerFilters = Object.create(null);
+        changeListeners.set(sender.page, listenerFilters);
+      }
     }
 
     switch (message.type)
     {
       case "add-subscription":
         ext.showOptions(function()
         {
           var subscription = Subscription.fromURL(message.url);
           subscription.title = message.title;
           onFilterChange("addSubscription", subscription);
@@ skipping 21 matching lines @@
             bidiDir = Utils.chromeRegistry.isLocaleRTL("adblockplus") ? "rtl" : "ltr";
           else
             bidiDir = ext.i18n.getMessage("@@bidi_dir");
 
           callback({locale: Utils.appLocale, bidiDir: bidiDir});
         }
         else if (message.what == "addonVersion")
         {
           callback(require("info").addonVersion);
         }
+        else if (message.what == "features")
+        {
+          callback({
+            safariContentBlocker: "safari" in global
+                && "extension" in global.safari
+                && "setContentBlocker" in global.safari.extension
+          });
+        }
         else
           callback(null);
         break;
       case "app.listen":
         if (message.filter)
           listenerFilters.app = message.filter;
         else
           delete listenerFilters.app;
         break;
       case "app.open":
@@ skipping 100 matching lines @@
           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":
+        if (message.filter)
+          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];

[saroyanm, 2016/02/29 14:34:38]

Shouldn't we also trigger the listener ? 
The listeners are not reacting on the Preference change when I trying to test
with ABP.

[Thomas Greiner, 2016/02/29 17:32:43]

Done.

The listener is automatically triggered by the setter on `Prefs`.

Interestingly, adblockpluschrome uses `Prefs.onChanged.addListener()` while
adblockplus uses `Prefs.addListener()`. That's why it wasn't working with
adblockpluschrome so I fixed that.

+        break;
       case "subscriptions.add":
         if (message.url in FilterStorage.knownSubscriptions)
           return;
 
         var subscription = Subscription.fromURL(message.url);
         if (!subscription)
           return;
 
         subscription.disabled = false;
         if ("title" in message)
@@ skipping 61 matching lines @@
           if (subscription instanceof DownloadableSubscription)
             Synchronizer.execute(subscription, true);
         }
         break;
       case "subscriptions.isDownloading":
         callback(Synchronizer.isExecuting(message.url));
         break;
     }
   });
 })(this);