Issue 3687 - Add experimental support for Safari content blockers

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 66 matching lines @@
 var addFilter = wrapper({type: "filters.add"}, "text");
 var getFilters = wrapper({type: "filters.get"}, "subscriptionUrl");
 var removeFilter = wrapper({type: "filters.remove"}, "text");
 
 var i18n = ext.i18n;
 var whitelistedDomainRegexp = /^@@\|\|([^\/:]+)\^\$document$/;
 var delayedSubscriptionSelection = null;
 
 var acceptableAdsUrl;
 
-// Loads options and sets UI elements accordingly
+// Loads options from localStorage and sets UI elements accordingly
 function loadOptions()
 {
   // Set page title to i18n version of "Adblock Plus Options"
   document.title = i18n.getMessage("options");
 
   // Set links
   getPref("subscriptions_exceptionsurl", function(url)
   {
     acceptableAdsUrl = url;
     $("#acceptableAdsLink").attr("href", acceptableAdsUrl);
@@ skipping 36 matching lines @@
   // Display jQuery UI elements
   $("#tabs").tabs();
   $("button").button();
   $(".refreshButton").button("option", "icons", {primary: "ui-icon-refresh"});
   $(".addButton").button("option", "icons", {primary: "ui-icon-plus"});
   $(".removeButton").button("option", "icons", {primary: "ui-icon-minus"});
 
   // Popuplate option checkboxes
   initCheckbox("shouldShowBlockElementMenu");
   initCheckbox("show_devtools_panel");
-  initCheckbox("shouldShowNotifications", {
-    key: "notifications_ignoredcategories",
-    get: function(ignoredcategories)
-    {
-      return ignoredcategories.indexOf("*") == -1;
-    }
-  });
+  initCheckbox("shouldShowNotifications", "notifications_ignoredcategories");
+  initCheckbox("safariContentBlocker");
 
   getInfo("features", function(features)
   {
     if (!features.devToolsPanel)
       document.getElementById("showDevtoolsPanelContainer").hidden = true;
+
+    // Only show the option for Safari content blocking API if the user is
+    // running Safari and both the legacy and content blocking APIs are
+    // available.
+    document.getElementById("safariContentBlockerContainer").hidden = !(
+      features.safariContentBlocker &&
+      typeof safari != "undefined" &&
+      "canLoad" in safari.self.tab &&
+      "onbeforeload" in Element.prototype
+    );
   });
   getPref("notifications_showui", function(notifications_showui)
   {
     if (!notifications_showui)
       document.getElementById("shouldShowNotificationsContainer").hidden = true;
   });
 
   // Register listeners in the background message responder
   ext.backgroundPage.sendMessage({
     type: "app.listen",
     filter: ["addSubscription", "focusSection"]
   });
   ext.backgroundPage.sendMessage(
   {
     type: "filters.listen",
     filter: ["added", "loaded", "removed"]
   });
   ext.backgroundPage.sendMessage(
   {
     type: "prefs.listen",
     filter: ["notifications_ignoredcategories", "notifications_showui",
-             "safari_contentblocker", "show_devtools_panel",
+             "safariContentBlocker", "show_devtools_panel",
              "shouldShowBlockElementMenu"]
   });
   ext.backgroundPage.sendMessage(
   {
     type: "subscriptions.listen",
     filter: ["added", "disabled", "homepage", "lastDownload", "removed",
              "title", "downloadStatus", "downloading"]
   });
 
   // Load recommended subscriptions
@@ skipping 43 matching lines @@
   getSubscriptions(false, true, function(subscriptions)
   {
     clearListBox("userFiltersBox");
     clearListBox("excludedDomainsBox");
 
     for (var i = 0; i < subscriptions.length; i++)
       convertSpecialSubscription(subscriptions[i]);
   });
 }
 
-function initCheckbox(id, descriptor)
+function initCheckbox(id, key)
 {
+  key = key || id;

[Sebastian Noack, 2016/05/18 11:16:32]

Note that when we retrieve the checkbox later in onPrefMessage() we assume the
key and id to be the same, which will fail for
"notifications_ignoredcategories". So perhaps remove that logic here as well and
just rename the ID in the HTML?

[kzar, 2016/05/18 11:32:07]

Actually onPrefMessage already handles that, changing the key to
shouldShowNotifications.

[Sebastian Noack, 2016/05/18 11:36:45]

Hm, seems that logic could be simplified altogether then, by just adapting the
HTML ID. But up to you, as it's not directly related to your changes.

   var checkbox = document.getElementById(id);
-  var key = descriptor && descriptor.key || id;
+
   getPref(key, function(value)
   {
-    if (descriptor && descriptor.get)
-      checkbox.checked = descriptor.get(value);
-    else
-      checkbox.checked = value;
+    onPrefMessage(key, value);
   });
 
   checkbox.addEventListener("click", function()
   {
-    if (descriptor && descriptor.toggle)
-      checkbox.checked = descriptor.toggle();
     togglePref(key);
   }, false);
 }
 
 function loadRecommendations()
 {
   fetch("subscriptions.xml")
     .then(function(response)
     {
       return response.text();
@@ skipping 227 matching lines @@
 {
   switch (key)
   {
     case "notifications_showui":
       document.getElementById("shouldShowNotificationsContainer").hidden = !value;
       return;
     case "notifications_ignoredcategories":
       key = "shouldShowNotifications";
       value = value.indexOf("*") == -1;
       break;
+    case "safariContentBlocker":
+      var restartMessage = document.getElementById("restart-safari");
+      restartMessage.hidden = true;
+      // When the user has chosen to use the legacy APIs but Safari has disabled
+      // them we need to show a "Please restart Safari" message.
+      if (!value)
+      {
+        ext.backgroundPage.sendMessage({type: "safari.contentBlockingActive"},
+        function (contentBlockingActive)

[Sebastian Noack, 2016/05/18 11:16:32]

Nit: Redundant space before arguments list.

[kzar, 2016/05/18 11:32:07]

Done.

+        {
+          if (contentBlockingActive)
+            restartMessage.hidden = false;
+        });
+      }
   }
-
   var checkbox = document.getElementById(key);
   if (checkbox)
     checkbox.checked = value;
 }
 
 function onFilterMessage(action, filter)
 {
   switch (action)
   {
     case "loaded":
@@ skipping 232 matching lines @@
       onFilterMessage(message.action, message.args[0]);
       break;
     case "prefs.respond":
       onPrefMessage(message.action, message.args[0]);
       break;
     case "subscriptions.respond":
       onSubscriptionMessage(message.action, message.args[0]);
       break;
   }
 });