Issue 3870 - Rewrite legacy options page to use async messages

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 64 matching lines @@
 var importRawFilters = wrapper({type: "filters.importRaw"},
                                "text", "removeExisting");
 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
 function loadOptions()
 {
   // Set page title to i18n version of "Adblock Plus Options"
   document.title = i18n.getMessage("options");
 
   // Set links
   getPref("subscriptions_exceptionsurl", function(url)
   {
-    $("#acceptableAdsLink").attr("href", url);
+    acceptableAdsUrl = url;
+    $("#acceptableAdsLink").attr("href", acceptableAdsUrl);
   });
   getDocLink("acceptable_ads", function(url)
   {
     $("#acceptableAdsDocs").attr("href", url);
   });
   getDocLink("filterdoc", function(url)
   {
     setLinks("filter-must-follow-syntax", url);
   });
   getInfo("application", function(application)
@@ skipping 48 matching lines @@
   });
   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", "switchToOptionsSection"]
+    filter: ["addSubscription", "focusSection"]
   });
   ext.backgroundPage.sendMessage(
   {
     type: "filters.listen",
     filter: ["added", "loaded", "removed"]
   });
   ext.backgroundPage.sendMessage(
   {
     type: "prefs.listen",
     filter: ["notifications_ignoredcategories", "notifications_showui",
@@ skipping 16 matching lines @@
 $(loadOptions);
 
 // Reloads the displayed subscriptions and filters
 function reloadFilters()
 {
   // Load user filter URLs
   var container = document.getElementById("filterLists");
   while (container.lastChild)
     container.removeChild(container.lastChild);
 
-  getPref("subscriptions_exceptionsurl", function(acceptableAdsUrl)
-  {
-    getSubscriptions(true, false, function(subscriptions)
-    {
-      for (var i = 0; i < subscriptions.length; i++)
-      {
-        var subscription = subscriptions[i];
-        if (subscription.url == acceptableAdsUrl)
-          $("#acceptableAds").prop("checked", !subscription.disabled);
-        else
-          addSubscriptionEntry(subscription);
-      }
-    });
+  getSubscriptions(true, false, function(subscriptions)
+  {
+    for (var i = 0; i < subscriptions.length; i++)
+    {
+      var subscription = subscriptions[i];
+      if (subscription.url == acceptableAdsUrl)
+        $("#acceptableAds").prop("checked", !subscription.disabled);
+      else
+        addSubscriptionEntry(subscription);
+    }
   });
 
   // User-entered filters
   getSubscriptions(false, true, function(subscriptions)
   {
     clearListBox("userFiltersBox");
     clearListBox("excludedDomainsBox");
 
     for (var i = 0; i < subscriptions.length; i++)
       getFilters(subscriptions[i].url, function(filters)
@@ skipping 162 matching lines @@
     addSubscription(url, title, null);
   }
 
   $("#addSubscriptionContainer").hide();
   $("#customSubscriptionContainer").hide();
   $("#addSubscriptionButton").show();
 }
 
 function toggleAcceptableAds()
 {
-  getPref("subscriptions_exceptionsurl", function(url)
-  {
-    toggleSubscription(url, true);
-  });
+  toggleSubscription(acceptableAdsUrl, true);
 }
 
 function findSubscriptionElement(subscription)
 {
   var children = document.getElementById("filterLists").childNodes;
   for (var i = 0; i < children.length; i++)
     if (children[i]._subscription.url == subscription.url)
       return children[i];
   return null;
 }
 
-function updateSubscriptionInfo(element, subscription, downloading)
+function updateSubscriptionInfo(element, subscription)
 {
   if (subscription)
     element._subscription = subscription;
   else
     subscription = element._subscription;
 
   var title = element.getElementsByClassName("subscriptionTitle")[0];
   title.textContent = subscription.title;
   title.setAttribute("title", subscription.url);
   if (subscription.homepage)
     title.href = subscription.homepage;
   else
     title.href = subscription.url;
 
   var enabled = element.getElementsByClassName("subscriptionEnabled")[0];
   enabled.checked = !subscription.disabled;
 
   var lastUpdate = element.getElementsByClassName("subscriptionUpdate")[0];
   lastUpdate.classList.remove("error");
 
   var downloadStatus = subscription.downloadStatus;
-  if (downloading)
+  if (subscription.isDownloading)
   {
     lastUpdate.textContent = i18n.getMessage("filters_subscription_lastDownload_inProgress");
   }
   else if (downloadStatus && downloadStatus != "synchronize_ok")
   {
      var map =
      {
        "synchronize_invalid_url": "filters_subscription_lastDownload_invalidURL",
        "synchronize_connection_error": "filters_subscription_lastDownload_connectionError",
        "synchronize_invalid_data": "filters_subscription_lastDownload_invalidData",
        "synchronize_checksum_mismatch": "filters_subscription_lastDownload_checksumMismatch"
      };
      if (downloadStatus in map)
        lastUpdate.textContent = i18n.getMessage(map[downloadStatus]);
      else
        lastUpdate.textContent = downloadStatus;
      lastUpdate.classList.add("error");
   }
   else if (subscription.lastDownload > 0)
   {
     var timeDate = i18n_timeDateStrings(subscription.lastDownload * 1000);
     var messageID = (timeDate[1] ? "last_updated_at" : "last_updated_at_today");
     lastUpdate.textContent = i18n.getMessage(messageID, timeDate);
   }
 }
 
 function onSubscriptionMessage(action, subscription)
 {
   var element = findSubscriptionElement(subscription);
-  var downloading = false;
 
   switch (action)
   {
+    case "disabled":
     case "downloading":
-      downloading = true;

[Sebastian Noack, 2016/04/06 08:50:17]

What if the subscription is already/still downloading when the options page is
loaded, or when another subscription change occurs while it's still downloading?
You have to always check whether the subscription is downloading regardless of
the occurred event when updating it.

[kzar, 2016/04/06 09:33:20]

Done.

-    case "title":
-    case "disabled":
+    case "downloadStatus":
     case "homepage":
     case "lastDownload":
-    case "downloadStatus":
+    case "title":
       if (element)
-        updateSubscriptionInfo(element, subscription, downloading);
+        updateSubscriptionInfo(element, subscription);
       break;
     case "added":
-      getPref("subscriptions_exceptionsurl", function(acceptableAdsUrl)
-      {
-        if (subscription.url == acceptableAdsUrl)
-          $("#acceptableAds").prop("checked", true);
-        else if (!element)
-          addSubscriptionEntry(subscription);
-      });
+      if (subscription.url == acceptableAdsUrl)
+        $("#acceptableAds").prop("checked", true);
+      else if (!element)
+        addSubscriptionEntry(subscription);
       break;
     case "removed":
-      getPref("subscriptions_exceptionsurl", function(acceptableAdsUrl)
-      {
-        if (subscription.url == acceptableAdsUrl)
-          $("#acceptableAds").prop("checked", false);
-        else if (element)
-          element.parentNode.removeChild(element);
-      });
+      if (subscription.url == acceptableAdsUrl)
+        $("#acceptableAds").prop("checked", false);
+      else if (element)
+        element.parentNode.removeChild(element);
       break;
   }
 }
 
 function onPrefMessage(key, value)
 {
   switch (key)
   {
     case "notifications_showui":
       document.getElementById("shouldShowNotificationsContainer").hidden = !value;
@@ skipping 217 matching lines @@
 {
   switch (message.type)
   {
     case "app.respond":
       switch (message.action)
       {
         case "addSubscription":
           var subscription = message.args[0];
           startSubscriptionSelection(subscription.title, subscription.url);
           break;
-        case "switchToOptionsSection":
+        case "focusSection":
           var tabs = document.getElementsByClassName("ui-tabs-panel");
           for (var i = 0; i < tabs.length; i++)
           {
             var found = tabs[i].querySelector(
               "[data-section='" + message.args[0] + "']"
             );
             if (!found)
               continue;
 
             var previous = document.getElementsByClassName("focused");
@@ skipping 11 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;
   }
 });