Issue 3885 - Disable the checkbox to toggle the Acceptable Ads list on the 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
  * 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/>.
  */
 
 "use strict";
 
 (function()
 {
   var subscriptionsMap = Object.create(null);
   var recommendationsMap = Object.create(null);
   var filtersMap = Object.create(null);
   var collections = Object.create(null);
+  var acceptableAdsUrl = null;
   var maxLabelId = 0;
   var getMessage = ext.i18n.getMessage;
   var filterErrors =
   {
     "synchronize_invalid_url": "options_filterList_lastDownload_invalidURL",
     "synchronize_connection_error": "options_filterList_lastDownload_connectionError",
     "synchronize_invalid_data": "options_filterList_lastDownload_invalidData",
     "synchronize_checksum_mismatch": "options_filterList_lastDownload_checksumMismatch"
   };
 
@@ skipping 17 matching lines @@
       table.removeChild(placeholder);
   }
 
   Collection.prototype._createElementQuery = function(item)
   {
     var access = (item.url || item.text).replace(/'/g, "\\'");
     return function(container)
     {
       return container.querySelector("[data-access='" + access + "']");
     };
-  };
-
-  Collection.prototype._isControlDisabled = function(item, i)
-  {
-    return item.disableable == false &&
-           this.details[i].onClick == toggleDisableSubscription;
   };
 
   Collection.prototype._getItemTitle = function(item, i)
   {
     var title = null;
     if (this.details[i].useOriginalTitle)
       title = item.originalTitle;
     if (!title)
       title = item.title || item.url || item.text;
     return title;
   };
 
   Collection.prototype.addItems = function() 
   {
     var length = Array.prototype.push.apply(this.items, arguments);
     if (length == 0)
       return;
 
     this.items.sort(function(a, b)
     {
-      var aDisabled = this._isControlDisabled(a, 0);

[Sebastian Noack, 2016/04/01 18:26:43]

This makes sure that items with disabled checkboxes (i.e. the Acceptable Ads
list on the Advanced tab) goes last. Given that we already have the the "Own
filter list" item below, which checkbox is disabled too, it makes sense and
looks much nicer if we group those special cases. Moreover, these items are the
least likely the user want to mess with here.

-      var bDisabled = this._isControlDisabled(b, 0);
-      if (aDisabled != bDisabled)
-        return aDisabled - bDisabled;
+      // Make sure that Acceptable Ads is always last, since it cannot be
+      // disabled, but only be removed. That way it's grouped together with
+      // the "Own filter list" which cannot be disabled either at the bottom
+      // of the filter lists in the Advanced tab.
+      if (a.url == acceptableAdsUrl)
+        return 1;
+      if (b.url == acceptableAdsUrl)
+        return -1;
 
       var aTitle = this._getItemTitle(a, 0).toLowerCase();

[Sebastian Noack, 2016/04/01 18:26:43]

This was missed on the previous review, where we started to show the original
subscription title on the Advanced tab. Since items are sorted by their shown
title, we have to consider the original title here as well.

       var bTitle = this._getItemTitle(b, 0).toLowerCase();
       return aTitle.localeCompare(bTitle);
     }.bind(this));
 
     for (var j = 0; j < this.details.length; j++) 
     {
       var table = E(this.details[j].id);
       var template = table.querySelector("template");
       for (var i = 0; i < arguments.length; i++) 
       {
@@ skipping 85 matching lines @@
         continue;
 
       var title = this._getItemTitle(item, i);
       element.querySelector(".display").textContent = title;
       if (title)
         element.setAttribute("data-search", title.toLowerCase());
       var control = element.querySelector(".control[role='checkbox']");
       if (control)
       {
         control.setAttribute("aria-checked", item.disabled == false);
-        if (this._isControlDisabled(item, i))
+        if (item.url == acceptableAdsUrl && this.details[i].onClick ==
+                                            toggleDisableSubscription)
           control.setAttribute("disabled", true);
       }
 
-      var downloadStatus = item.downloadStatus;
       var dateElement = element.querySelector(".date");
       var timeElement = element.querySelector(".time");
-      if(dateElement && timeElement)
+      if (dateElement && timeElement)
       {
         var message = element.querySelector(".message");
-        ext.backgroundPage.sendMessage(
-        {
-          type: "subscriptions.isDownloading",
-          url: item.url
-        },
-        function(isDownloading)
-        {
-          if (isDownloading)
-          {
-            var text = getMessage("options_filterList_lastDownload_inProgress");
-            message.textContent = text;
-            element.classList.add("show-message");
-          }
-          else if (downloadStatus && downloadStatus != "synchronize_ok")
-          {
-            if (downloadStatus in filterErrors)
-              message.textContent = getMessage(filterErrors[downloadStatus]);
-            else
-              message.textContent = item.downloadStatus;
-            element.classList.add("show-message");
-          }
-          else if (item.lastDownload > 0)
-          {
-            var dateTime = i18n_formatDateTime(item.lastDownload * 1000);
-            dateElement.textContent = dateTime[0];
-            timeElement.textContent = dateTime[1];
-            element.classList.remove("show-message");
-          }
-        });
-      }
+        if (item.isDownloading)
+        {
+          var text = getMessage("options_filterList_lastDownload_inProgress");
+          message.textContent = text;
+          element.classList.add("show-message");
+        }
+        else if (item.downloadStatus != "synchronize_ok")
+        {
+          var error = filterErrors[item.downloadStatus];
+          if (error)
+            message.textContent = getMessage(error);
+          else
+            message.textContent = item.downloadStatus;
+          element.classList.add("show-message");
+        }
+        else if (item.lastDownload > 0)
+        {
+          var dateTime = i18n_formatDateTime(item.lastDownload * 1000);
+          dateElement.textContent = dateTime[0];
+          timeElement.textContent = dateTime[1];
+          element.classList.remove("show-message");
+        }
+      }
+
       var websiteElement = element.querySelector(".context-menu .website");
       var sourceElement = element.querySelector(".context-menu .source");
       if (websiteElement && item.homepage)
         websiteElement.setAttribute("href", item.homepage);
       if (sourceElement)
         sourceElement.setAttribute("href", item.url);
     }
   };
 
   Collection.prototype.clearAll = function()
@@ skipping 154 matching lines @@
               collections.allLangs.removeItem(subscription);
               collections.langs.addItems(subscription);
             }
             else
             {
               collections.allLangs.addItems(subscription);
               collections.langs.removeItem(subscription);
             }
           }
         }
-        for (var i in collections)
-          collections[i].updateItem(subscription);
-      }
+      }
+
+      for (var name in collections)
+        collections[name].updateItem(subscription);
     }
 
     if (!Object.observe)
     {
-      ["disabled", "lastDownload"].forEach(function(property)
-      {
-        subscription["$" + property] = subscription[property];
+      Object.keys(subscription).forEach(function(property)
+      {
+        var value = subscription[property];
         Object.defineProperty(subscription, property,
         {
           get: function()
           {
-            return this["$" + property];
+            return value;
           },
           set: function(newValue)
           {
-            var oldValue = this["$" + property];
-            if (oldValue != newValue)
+            if (value != newValue)
             {
-              this["$" + property] = newValue;
-              var change = Object.create(null);
-              change.name = property;
-              onObjectChanged([change]);
+              value = newValue;
+              onObjectChanged([{name: property}]);
             }
           }
         });
       });
     }
     else
     {
       Object.observe(subscription, onObjectChanged);
     }
   }
 
   function updateSubscription(subscription)
   {
     var subscriptionUrl = subscription.url;
     var knownSubscription = subscriptionsMap[subscriptionUrl];
     if (knownSubscription)
     {
       for (var property in subscription)
-        if (property != "title")
+      {
+        if (property == "title" && subscriptionUrl in recommendationsMap)
+          knownSubscription.originalTitle = subscription.title;
+        else
           knownSubscription[property] = subscription[property];
+      }
     }
     else
     {
       observeSubscription(subscription);
-      getAcceptableAdsURL(function(acceptableAdsUrl)
-      {
-        var collection = null;
-        if (subscriptionUrl in recommendationsMap)
-        {
-          var recommendation = recommendationsMap[subscriptionUrl];
-          if (recommendation.type != "ads")
-            collection = collections.popular;
-          else if (subscription.disabled == false)
-            collection = collections.langs;
-          else
-            collection = collections.allLangs;
-        }
-        else if (subscriptionUrl == acceptableAdsUrl)
-        {
-          collection = collections.acceptableAds;
-          subscription.disableable = false;
-        }
+
+      var collection;
+      if (subscriptionUrl in recommendationsMap)
+      {
+        var recommendation = recommendationsMap[subscriptionUrl];
+        if (recommendation.type != "ads")
+          collection = collections.popular;
+        else if (subscription.disabled == false)
+          collection = collections.langs;
         else
-          collection = collections.custom;
-
-        collection.addItems(subscription);
-        subscriptionsMap[subscriptionUrl] = subscription;
-      });
+          collection = collections.allLangs;
+      }
+      else if (subscriptionUrl == acceptableAdsUrl)
+        collection = collections.acceptableAds;
+      else
+        collection = collections.custom;
+
+      collection.addItems(subscription);
+      subscriptionsMap[subscriptionUrl] = subscription;
     }
   }
 
   function updateFilter(filter)
   {
     var match = filter.text.match(/^@@\|\|([^\/:]+)\^\$document$/);
     if (match && !filtersMap[filter.text])
     {
       filter.title = match[1];
       collections.whitelist.addItems(filter);
@@ skipping 368 matching lines @@
           subscriptionUrl: subscriptions[i].url
         }, 
         function(filters)
         {
           for (var i = 0; i < filters.length; i++)
             updateFilter(filters[i]);
         });
       }
     });
     loadRecommendations();
-    getAcceptableAdsURL(function(acceptableAdsUrl)
-    {
-      var subscription = Object.create(null);
-      subscription.url = acceptableAdsUrl;
-      subscription.disabled = true;
-      subscription.title = getMessage("options_acceptableAds_description");
-      updateSubscription(subscription);
+    ext.backgroundPage.sendMessage(
+    {
+      type: "prefs.get",
+      key: "subscriptions_exceptionsurl"
+    },
+    function(url)
+    {
+      acceptableAdsUrl = url;
+      updateSubscription({
+        url: acceptableAdsUrl,
+        disabled: true,
+        title: getMessage("options_acceptableAds_description")
+      });
 
       // Load user subscriptions
       ext.backgroundPage.sendMessage(
       {
         type: "subscriptions.get",
         downloadable: true
       }, 
       function(subscriptions)
       {
         for (var i = 0; i < subscriptions.length; i++)
@@ skipping 18 matching lines @@
     document.querySelector("#whitelisting .controls").classList.remove("mode-edit");
   }
 
   function editCustomFilters()
   {
     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)
-  {
-    getPref("subscriptions_exceptionsurl", callback);
   }
 
   function addEnableSubscription(url, title, homepage)
   {
     var messageType = null;
     var knownSubscription = subscriptionsMap[url];
     if (knownSubscription && knownSubscription.disabled == true)
       messageType = "subscriptions.toggle"
     else
       messageType = "subscriptions.add"
@@ skipping 42 matching lines @@
         var knownSubscription = subscriptionsMap[subscription.url];
         if (knownSubscription)
           collections.filterLists.addItems(knownSubscription);
         else
           collections.filterLists.addItems(subscription);
         break;
       case "disabled":
         updateSubscription(subscription);
         updateShareLink();
         break;
-      case "lastDownload":
-        updateSubscription(subscription);
-        break;
-      case "homepage":
-        // TODO: NYI
-        break;
       case "removed":
         var knownSubscription = subscriptionsMap[subscription.url];
-        getAcceptableAdsURL(function(acceptableAdsUrl)
-        {
-          if (subscription.url == acceptableAdsUrl)
-          {
-            subscription.disabled = true;
-            updateSubscription(subscription);
+        if (subscription.url == acceptableAdsUrl)
+        {
+          subscription.disabled = true;
+          updateSubscription(subscription);
+        }
+        else
+        {
+          if (subscription.url in recommendationsMap)
+            knownSubscription.disabled = true;
+          else
+          {
+            collections.custom.removeItem(knownSubscription);
+            delete subscriptionsMap[subscription.url];
           }
-          else
-          {
-            if (subscription.url in recommendationsMap)
-              knownSubscription.disabled = true;
-            else
-            {
-              collections.custom.removeItem(knownSubscription);
-              delete subscriptionsMap[subscription.url];
-            }
-          }
-          updateShareLink();
-          collections.filterLists.removeItem(knownSubscription);
-        });
-        break;
-      case "title":
-        // TODO: NYI
+        }
+        updateShareLink();
+        collections.filterLists.removeItem(knownSubscription);
+        break;
+      default:
+        updateSubscription(subscription);
         break;
     }
   }
 
   function hidePref(key, value)
   {
     var element = document.querySelector("[data-pref='" + key + "']");
     if (element)
       element.setAttribute("aria-hidden", value);
   }
@@ skipping 91 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":
-        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");
+        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 "focusSection":
+            document.body.setAttribute("data-tab", message.args[0]);
+            break;
         }
         break;
       case "filters.respond":
         onFilterMessage(message.action, message.args[0]);
         break;
       case "prefs.respond":
         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"]
+    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",
         "shouldShowBlockElementMenu"]
   });
   ext.backgroundPage.sendMessage(
   {
     type: "subscriptions.listen",
     filter: ["added", "disabled", "homepage", "lastDownload", "removed",
-        "title"]
+        "title", "downloadStatus", "downloading"]
   });
 
   window.addEventListener("DOMContentLoaded", onDOMLoaded, false);
 })();