Issue 3880 - Improve behavior of Safari content blocker option

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 689 matching lines @@
     // Advanced tab
     var tweaks = document.querySelectorAll("#tweaks li[data-pref]");
     tweaks = Array.prototype.map.call(tweaks, function(checkbox)
     {
       return checkbox.getAttribute("data-pref");
     });
     tweaks.forEach(function(key)
     {
       getPref(key, function(value)
       {
-        onPrefMessage(key, value);
+        onPrefMessage(key, value, true);
       });
     });
     ext.backgroundPage.sendMessage(
     {
       type: "app.get",
       what: "features"
     },
     function(features)
     {
       hidePref("show_devtools_panel", !features.devToolsPanel);
@@ skipping 300 matching lines @@
   };
 
   getPref.checks =
   {
     notifications_ignoredcategories: function(callback)
     {
       getPref("notifications_showui", callback);
     }
   };
 
-  function onPrefMessage(key, value)
-  {
+  function onPrefMessage(key, value, initial)
+  {
+    switch (key)
+    {
+      case "notifications_ignoredcategories":
+        value = value.indexOf("*") == -1;
+        break;
+
+      case "notifications_showui":
+        hidePref("notifications_ignoredcategories", !value);
+        break;
+
+      case "safari_contentblocker":
+        E("restart-safari").setAttribute("aria-hidden", value || initial);
+        break;
+    }
+
     var checkbox = document.querySelector("[data-pref='" + key + "'] button[role='checkbox']");
     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 28 matching lines @@
 
     for (var i = 0; i < shareResources.length; i++)
       checkShareResource(shareResources[i], onResult);
   }
 
   ext.onMessage.addListener(function(message)
   {
     switch (message.type)
     {
       case "app.respond":
-        switch (message.action)
-        {
-          case "addSubscription":
-            var subscription = message.args[0];
-            var dialog = E("dialog-content-predefined");
-            dialog.querySelector("h3").textContent = subscription.title || "";
-            dialog.querySelector(".url").textContent = subscription.url;
-            openDialog("predefined");
-            break;
-          case "safariRestartRequired":
-            E("restart-safari").setAttribute("aria-hidden", !message.args[0]);

[Thomas Greiner, 2016/03/31 14:24:57]

Why do we even need the background page for that? The options page already gets
notified whenever the preference changes so it can do the check itself.

[Sebastian Noack, 2016/03/31 14:45:37]

We should only indicate that restarting Safari is necessary, if Content Blockers
got disabled after the extension got loaded. However, without any persistence in
the background page we cannot distinguish whether it has been disabled since the
last restart, or whether it was already disabled when the extension was loaded.

[Sebastian Noack, 2016/03/31 15:14:31]

Frankly, I don't have a strong opinion here. Patch set #3 removed the persistent
logic. Hence when reloading or opening a new instance of the options page we
don't indicate to restart Safari, anymore. I'm not sure which is better. Let me
know what you think.

[Thomas Greiner, 2016/03/31 16:29:17]

I do agree that we should somehow indicate to the user that Adblock Plus is
broken until they restart Safari since that's quite significant. It might be
more effective to do that elsewhere though (e.g. in the icon popup?). What do
you think?

Not sure how common or helpful it might be considering that the user already
ignored the message and closed the options page but, in general, I see your
point.

[Sebastian Noack, 2016/03/31 17:09:24]

FWIW, I just begun to prefer the new patch set without the persistence, only
showing a message to restart Safari once after Content Blockers got disabled, if
it's just because it's way simpler. Also, AFAIK, that is what Dave has
implemented for the old options page.

Please let's not overthink the problem for now. We are talking about an edge
case, that is Safari 9 users, that use the options page to disable an
experimental feature they have previously turned on. And even those will restart
Safari sooner or later anyway, and everything will be fine again. Not to mention
that even before the new options page is release, Safari 10 might be released
and might not have the old mechanism anyway anymore.

[Thomas Greiner, 2016/03/31 17:17:06]

You're right.

-            break;
+        if (message.action == "addSubscription")
+        {
+          var subscription = message.args[0];
+          var dialog = E("dialog-content-predefined");
+          dialog.querySelector("h3").textContent = subscription.title || "";
+          dialog.querySelector(".url").textContent = subscription.url;
+          openDialog("predefined");
         }
         break;
       case "filters.respond":
         onFilterMessage(message.action, message.args[0]);
         break;
       case "prefs.respond":
-        onPrefMessage(message.action, message.args[0]);
+        onPrefMessage(message.action, message.args[0], false);
         break;
       case "subscriptions.respond":
         onSubscriptionMessage(message.action, message.args[0]);
         break;
     }
   });
 
   ext.backgroundPage.sendMessage(
   {
     type: "app.listen",
-    filter: ["addSubscription", "safariRestartRequired"]
+    filter: ["addSubscription"]
   });
   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",
         "shouldShowBlockElementMenu"]
   });
   ext.backgroundPage.sendMessage(
   {
     type: "subscriptions.listen",
     filter: ["added", "disabled", "homepage", "lastDownload", "removed",
         "title"]
   });
 
   window.addEventListener("DOMContentLoaded", onDOMLoaded, false);
 })();