Issue 2374 - Implemented Tweaks section in options page

options.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 570 matching lines @@
           {
             type: "filters.importRaw",
             text: E("custom-filters-raw").value
           });
           E("custom-filters").classList.remove("mode-edit");
           break;
         case "switch-tab":
           document.body.setAttribute("data-tab",
             element.getAttribute("data-tab"));
           break;
+        case "toggle-pref":
+          ext.backgroundPage.sendMessage(
+          {
+            type: "prefs.toggle",
+            key: element.getAttribute("data-pref")
+          });
+          break;
         case "update-all-subscriptions":
           ext.backgroundPage.sendMessage(
           {
             type: "subscriptions.update"
           });
           break;
         case "open-context-menu":
           var listItem = findParentData(element, "access", true);
           if (listItem != context)
             listItem.classList.add("show-context-menu");
@@ skipping 68 matching lines @@
     var placeholderValue  = getMessage("options_dialog_language_find");
     E("find-language").setAttribute("placeholder", placeholderValue);
     E("find-language").addEventListener("keyup", onFindLanguageKeyUp, false);
     E("whitelisting-textbox").addEventListener("keypress", function(e)
     {
       if (getKey(e) == "Enter")
         addWhitelistedDomain();
     }, false);
 
     // Advanced tab
+    var tweaks = document.querySelectorAll("#tweaks button[role='checkbox'][data-pref]");
+    tweaks = Array.prototype.map.call(tweaks, function(checkbox)
+    {
+      return checkbox.getAttribute("data-pref");
+    });
+    tweaks.forEach(function(name)
+    {
+      getPref(name, function(value)
+      {
+        onPrefMessage(name, value);
+      });
+    });
+
     var filterTextbox = document.querySelector("#custom-filters-add input");
     placeholderValue = getMessage("options_customFilters_textbox_placeholder");
     filterTextbox.setAttribute("placeholder", placeholderValue);
     function addCustomFilters()
     {
       var filterText = filterTextbox.value;
       ext.backgroundPage.sendMessage(
       {
         type: "filters.add",
         text: filterText
@@ skipping 133 matching lines @@
   {
     var customFilterItems = collections.customFilters.items;
     var filterTexts = [];
     for (var i = 0; i < customFilterItems.length; i++)
       filterTexts.push(customFilterItems[i].text);
     E("custom-filters-raw").value = filterTexts.join("\n");
   }
 
   function getAcceptableAdsURL(callback)
   {
-    ext.backgroundPage.sendMessage(
-    {
-      type: "prefs.get",
-      key: "subscriptions_exceptionsurl"
-    },
-    function(value)
+    getPref("subscriptions_exceptionsurl", function(value)
     {
       getAcceptableAdsURL = function(callback)
       {
         callback(value);
-      }
+      };
       getAcceptableAdsURL(callback);
     });
   }
 
   function addEnableSubscription(url, title, homepage)
   {
     var messageType = null;
     var knownSubscription = subscriptionsMap[url];
     if (knownSubscription && knownSubscription.disabled == true)
       messageType = "subscriptions.toggle"
@@ skipping 79 matching lines @@
           updateShareLink();
           collections.filterLists.removeItem(knownSubscription);
         });
         break;
       case "title":
         // TODO: NYI
         break;
     }
   }
 
+  function hidePref(key, value)
+  {
+    var element = document.querySelector("[data-pref='" + key + "']");
+    if (!element)
+      return;
+
+    var parent = findParentData(element, "optional", true);
+    parent.setAttribute("aria-hidden", value);
+  }
+
+  function getPref(key, callback)
+  {
+    var checkPref = getPref.checks[key] || getPref.checkNone;
+    checkPref(function(isActive)
+    {
+      if (!isActive)
+      {
+        hidePref(key, !isActive);
+        return;
+      }
+
+      ext.backgroundPage.sendMessage(
+      {
+        type: "prefs.get",
+        key: key
+      }, callback);
+    });
+  }
+  getPref.checkNone = function(callback)

[saroyanm, 2016/03/11 14:55:58]

Detail: I assume you grouped the functions for readability, but apparently it's
only place we do so in the code, don't have strong point about this grouping,
will leave decision up to you.

[Thomas Greiner, 2016/03/15 15:39:26]

Done.

+  {
+    callback(true);
+  };
+  getPref.checks =
+  {
+    notifications_ignoredcategories: function(callback)
+    {
+      getPref("notifications_showui", callback);
+    },
+    safari_contentblocker: function(callback)
+    {
+      ext.backgroundPage.sendMessage(
+      {
+        type: "app.get",
+        what: "features"
+      },
+      function(features)
+      {
+        callback(features.safariContentBlocker);
+      });
+    }
+  };
+
+  function onPrefMessage(key, value)
+  {
+    var checkbox = document.querySelector("[data-pref='" + key + "']");
+    if (checkbox)
+    {
+      if (key == "notifications_ignoredcategories")
+        value = (value.indexOf("*") == -1);
+      checkbox.setAttribute("aria-checked", value);
+    }
+    else if (key == "notifications_showui")
+      hidePref("notifications_ignoredcategories", !value);
+  }
+
   function onShareLinkClick(e)
   {
     e.preventDefault();
 
     getDocLink("share-general", function(link)
     {
       openSharePopup(link);
     });
   }
 
@@ skipping 42 matching lines @@
           openDialog("predefined");
         }
         else if (message.action == "error")
         {
           alert(message.args.join("\n"));
         }
         break;
       case "filters.listen":
         onFilterMessage(message.action, message.args[0]);
         break;
+      case "prefs.listen":
+        onPrefMessage(message.action, message.args[0]);
+        break;
       case "subscriptions.listen":
         onSubscriptionMessage(message.action, message.args[0]);
         break;
     }
   });
 
   ext.backgroundPage.sendMessage(
   {
     type: "app.listen",
     filter: ["addSubscription", "error"]
   });
   ext.backgroundPage.sendMessage(
   {
     type: "filters.listen",
     filter: ["added", "loaded", "removed"]
   });
   ext.backgroundPage.sendMessage(
   {
+    type: "prefs.listen",
+    filter: ["notifications_ignoredcategories", "notifications_showui",
+        "safari_contentblocker", "shouldShowBlockElementMenu"]
+  });
+  ext.backgroundPage.sendMessage(
+  {
     type: "subscriptions.listen",
     filter: ["added", "disabled", "homepage", "lastDownload", "removed", "title"]
   });
 
   window.addEventListener("DOMContentLoaded", onDOMLoaded, false);
 })();