Issue 5326 - General tab (HTML, strings and functionality)

new-options.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
- * Copyright (C) 2006-2017 eyeo GmbH
+ * Copyright (C) 2006-present 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.
  *
@@ skipping 121 matching lines @@
 
       let tooltip = listItem.querySelector("[data-tooltip]");
       if (tooltip)
       {
         let tooltipId = tooltip.getAttribute("data-tooltip");
         tooltipId = tooltipId.replace("%value%", item.recommended);
         if (getMessage(tooltipId))
         {
           tooltip.setAttribute("data-tooltip", tooltipId);
         }
-        else
-        {
-          tooltip.parentNode.removeChild(tooltip);
-        }
       }
 
       for (let control of listItem.querySelectorAll(".control"))
       {
         if (control.hasAttribute("title"))
         {
           let titleValue = getMessage(control.getAttribute("title"));
           control.setAttribute("title", titleValue);
         }
       }
@@ skipping 54 matching lines @@
     this._sortItems();
     let access = (item.url || item.text).replace(/'/g, "\\'");
     for (let i = 0; i < this.details.length; i++)
     {
       let table = E(this.details[i].id);
       let element = table.querySelector("[data-access='" + access + "']");
       if (!element)
         continue;
 
       let title = this._getItemTitle(item, i);
-      for (let displayElement of element.querySelectorAll(".display"))

[Thomas Greiner, 2017/08/16 17:57:09]

According to
https://developer.mozilla.org/en-US/docs/Web/API/NodeList#Browser_compatibility
`NodeList` wasn't iterable yet in Chrome 49 which is the oldest version we still
support. Therefore we shouldn't use a for-of loop here.

[saroyanm, 2017/08/17 11:21:17]

well spotted.

[saroyanm, 2017/08/17 21:24:07]

Done.

-        displayElement.textContent = title;
+      let displays = element.querySelectorAll(".display");
+      for (let j = 0; j < displays.length; j++)
+        displays[j].textContent = title;
 
       element.setAttribute("aria-label", title);
       if (this.details[i].searchable)
         element.setAttribute("data-search", title.toLowerCase());
       let control = element.querySelector(".control[role='checkbox']");
       if (control)
       {
         control.setAttribute("aria-checked", item.disabled == false);
         if (isAcceptableAds(item.url) && this == collections.filterLists)
           control.disabled = true;
@@ skipping 96 matching lines @@
     index += (index == focusables.length - 1) ? -1 : 1;
 
     let nextElement = focusables[index];
     if (!nextElement)
       return false;
 
     nextElement.focus();
     return true;
   }
 
-  collections.security = new Collection([
-    {
-      id: "recommend-security-list-table"
+  collections.protection = new Collection([
+    {
+      id: "recommend-protection-list-table"
     }
   ]);
   collections.langs = new Collection([
     {
       id: "blocking-languages-table",
       emptyText: ["options_language_empty"]
     }
   ]);
   collections.allLangs = new Collection([
     {
@@ skipping 17 matching lines @@
       id: "all-filter-lists-table",
       useOriginalTitle: true
     }
   ]);
 
   function addSubscription(subscription)
   {
     let collection = null;
     if (subscription.recommended)
     {
-      if (isProtection(subscription.recommended))
-      {
-        collection = collections.security;

[Thomas Greiner, 2017/08/16 17:57:10]

Detail: The previous comments for this still applies.

See
https://codereview.adblockplus.org/29478597/diff/29498701/new-options.js#newc...

[saroyanm, 2017/08/17 21:24:07]

Done.

-      }
-      else if (subscription.recommended == "ads")
+      if (subscription.recommended == "ads")
       {
         if (subscription.disabled == false)
           collection = collections.langs;
 
         collections.allLangs.addItem(subscription);
       }
-      else if (subscription.disabled == false)
-      {
-        collection = collections.custom;

[Thomas Greiner, 2017/08/16 17:57:10]

So we're still putting recommended subscriptions into the "More Filters"
section?

See
https://codereview.adblockplus.org/29478597/diff/29498701/new-options.js#newc...

[saroyanm, 2017/08/17 11:21:19]

Yes, because according to the subscription.xml "Malware Domains" and "Adblock
Warning Removal List" are also in the recommendation, but not recommended in the
specifications. So currently we show in More Filters section the filters as
specified below:
* Recommended subscriptions that aren't "Protecting filters" and Adblocking
filters
* Subscriptions that aren't recommended and aren't "AcceptableAds"
subscriptions.

[Thomas Greiner, 2017/08/17 12:06:05]

If they are in subscriptions.xml but are not supposed to be recommended then
let's simply not include them in subscriptions.xml and adapt
https://issues.adblockplus.org/ticket/2825 accordingly.

[saroyanm, 2017/08/17 12:32:08]

Is it the decision that we can make ? 

If so I'm fine and will change the implementation accordingly, but on other hand
what about other locations where we recommend them (ex.:
https://adblockplus.org/subscriptions) ?  Isn't the idea to have 1
subscriptions.xml in the end shared across products/websites and etc ?

[Thomas Greiner, 2017/08/17 12:49:06]

We are the ones who added them in the first place so those are not being used
anywhere (see https://issues.adblockplus.org/ticket/2825). No need to worry. :)

Ensuring that introducing those new non-ads subscription types doesn't cause any
negative side effects is what https://issues.adblockplus.org/ticket/2821 is for.

Also note that the subscriptions.xml in the adblockplusui repository is only
being used for the development environment so changes to that one don't affect
anything else. The extensions bundle their own version of subscriptions.xml.
No, that's what we have https://hg.adblockplus.org/subscriptionlist for. It
provides a single source for generating subscriptions.xml, subscriptions2.xml
and adblockplus.org/subscriptions.

[saroyanm, 2017/08/17 14:06:18]

Thanks for clarifying that, in this case whole logic should be supper simple in
general:
Privacy and Security subscriptions = recommendation which are not ads type.
More subscriptions = Not a recommendation and not Acceptable Ads subscription.

Saying that I think we even can close ->
https://issues.adblockplus.org/ticket/2825 because we will need to distinguish
between Ads type and non Ads type recommendation. What you think ?

[saroyanm, 2017/08/17 21:24:05]

Done.

-      }
       else

[Thomas Greiner, 2017/08/16 17:57:09]

This part of the if-statement is redundant because that's what's happening at
the end of the function anyway.

[saroyanm, 2017/08/17 11:21:18]

agree.

[saroyanm, 2017/08/17 21:24:05]

Done.

       {
-        subscriptionsMap[subscription.url] = subscription;
-        return;
+        collection = collections.protection;
       }
     }
     else if (!isAcceptableAds(subscription.url))
     {
       collection = collections.custom;
     }
 
     if (collection)
       collection.addItem(subscription);
 
     subscriptionsMap[subscription.url] = subscription;
     updateTooltips();
   }
 
   function updateSubscription(subscription)
   {
     for (let name in collections)
       collections[name].updateItem(subscription);
 
     if (subscription.recommended == "ads")
     {
       if (subscription.disabled)
         collections.langs.removeItem(subscription);
       else
         collections.langs.addItem(subscription);
     }
-    else if (!isProtection(subscription.recommended) &&
-      !isAcceptableAds(subscription.url))
+    else if (!subscription.recommended && !isAcceptableAds(subscription.url))
     {
       if (subscription.disabled == false)
       {
         collections.custom.addItem(subscription);

[Thomas Greiner, 2017/08/16 17:57:09]

Again, it seems like we're still putting recommended subscriptions into the
"More Filters" section.

See
https://codereview.adblockplus.org/29478597/diff/29498701/new-options.js#newc...

[saroyanm, 2017/08/17 11:21:17]

As, same as the comment above, the definition of the recommended in the specs is
"not recommended within the Privacy & Security and Language sections".

[saroyanm, 2017/08/17 21:24:05]

Done.

         updateTooltips();
       }
       else
       {
         collections.custom.removeItem(subscription);
       }
     }
   }
 
   function updateFilter(filter)
@@ skipping 142 matching lines @@
           if (subscriptionType == "ads" && subscription.disabled == false)
           {
             ext.backgroundPage.sendMessage({
               type: "subscriptions.remove",
               url: subscription.url
             });
             ext.backgroundPage.sendMessage({
               type: "subscriptions.add",
               url: findParentData(element, "access", false)
             });
+            break;
           }

[Thomas Greiner, 2017/08/16 17:57:10]

Detail: Let's exit the loop as soon as we find the filter list we've been
searching for.

[saroyanm, 2017/08/17 21:24:06]

Done.

         }
         break;
       case "close-dialog":
         closeDialog();
         break;
       case "edit-custom-filters":
         setCustomFiltersView("write");
         break;
       case "import-subscription": {
         let url = E("blockingList-textbox").value;
@@ skipping 33 matching lines @@
         sendMessageHandleErrors({
           type: "filters.importRaw",
           text: E("custom-filters-raw").value,
           removeExisting: true
         },
         () =>
         {
           setCustomFiltersView("read");
         });
         break;
       case "switch-acceptable-ads":

[Thomas Greiner, 2017/08/16 17:57:10]

It's great that the code has been made more consistent but this is not what I
meant with my comment at
https://codereview.adblockplus.org/29478597/diff/29498701/new-options.html#ne....

Here's an example code to clarify what I was thinking of:

case "switch-acceptable-ads":
  let values = new Set(element.value.split(","));
  ext.backgroundPage.sendMessage({
    type: (values.has("privacy")) ? "subscriptions.add" :
"subscriptions.remove",
    url: acceptableAdsPrivacyUrl
  });
  ext.backgroundPage.sendMessage({
    type: (values.has("ads")) ? "subscriptions.add" : "subscriptions.remove"
  });
  break;

[saroyanm, 2017/08/17 11:21:18]

I think I missed the part of combining them into one message, I agree with you,
but we don't have the case for "ads,privacy", also not sure if we should allow
that case and having value="" is still have the issue of selecting with CSS.
What if we will still use your solution, but the way it matches the case ?

let value = element.value;
ext.backgroundPage.sendMessage({
  type: value == "privacy" ? "subscriptions.add" :
  "subscriptions.remove",
  url: acceptableAdsPrivacyUrl
});
ext.backgroundPage.sendMessage({
  type: value == "ads" ? "subscriptions.add" : "subscriptions.remove"
});

And values in HTML will be "ads", "privacy" and "none".
<input data-action="switch-acceptable-ads" type="radio" name="acceptable-ads"
value="ads">
<input data-action="switch-acceptable-ads" type="radio" name="acceptable-ads"
value="privacy">
<input data-action="switch-acceptable-ads" type="radio" name="acceptable-ads"
value="none">

Let me know what you think about this and thanks for clarification.

[Thomas Greiner, 2017/08/17 12:06:05]

Your proposal is perfectly fine. :)

[saroyanm, 2017/08/17 21:24:04]

Done.

+        let {value} = element;
         ext.backgroundPage.sendMessage({
-          type: "subscriptions.remove",
+          type: value == "privacy" ? "subscriptions.add" :
+            "subscriptions.remove",
           url: acceptableAdsPrivacyUrl
         });
         ext.backgroundPage.sendMessage({
-          type: "subscriptions.add",
-          url: acceptableAdsUrl
-        });
-        break;
-      case "switch-privacy-acceptable-ads":
-        ext.backgroundPage.sendMessage({
-          type: "subscriptions.remove",
-          url: acceptableAdsUrl
-        });
-        ext.backgroundPage.sendMessage({
-          type: "subscriptions.add",
-          url: acceptableAdsPrivacyUrl
-        });
-        break;
-      case "switch-no-acceptable-ads":
-        ext.backgroundPage.sendMessage({
-          type: "subscriptions.remove",
-          url: acceptableAdsPrivacyUrl
-        });
-        ext.backgroundPage.sendMessage({
-          type: "subscriptions.remove",
+          type: value == "ads" ? "subscriptions.add" : "subscriptions.remove",
           url: acceptableAdsUrl
         });
         break;
       case "switch-tab":
         let tabId = findParentData(element, "tab", false);
         switchTab(tabId);
         break;
       case "toggle-disable-subscription":
         ext.backgroundPage.sendMessage({
           type: "subscriptions.toggle",
@@ skipping 331 matching lines @@
 
   function closeDialog()
   {
     let dialog = E("dialog");
     dialog.setAttribute("aria-hidden", true);
     dialog.removeAttribute("aria-labelledby");
     document.body.removeAttribute("data-dialog");
     focusedBeforeDialog.focus();
   }
 
-  function setDntNotification(state)
-  {
-    if (state)
-      E("acceptable-ads").classList.add("show-dnt-notification");
-    else
-      E("acceptable-ads").classList.remove("show-dnt-notification");
-  }
-
-  function setAcceptableAds(option)
-  {
-    let optionsContainer = E("acceptable-ads");
-    switch (option)
-    {
-      case "default":
-        optionsContainer.querySelector("[value='ads']").checked = true;
-        break;
-      case "privacy":
-        optionsContainer.querySelector("[value='ads,privacy']").checked = true;
-        break;
-      case "none":
-        optionsContainer.querySelector("[value='none']").checked = true;
-        break;
-    }
+  function setAcceptableAds()
+  {
+    let option = "none";
+    document.forms["acceptable-ads"].classList.remove("show-dnt-notification");
+    if (acceptableAdsUrl in subscriptionsMap)
+    {
+      option = "ads";
+    }
+    else if (acceptableAdsPrivacyUrl in subscriptionsMap)
+    {
+      option = "privacy";
+
+      if (!navigator.doNotTrack)
+        document.forms["acceptable-ads"].classList.add("show-dnt-notification");
+    }
+    document.forms["acceptable-ads"]["acceptable-ads"].value = option;
   }
 
   function isAcceptableAds(url)
   {
     return url == acceptableAdsUrl || url == acceptableAdsPrivacyUrl;
-  }
-
-  function isProtection(type)
-  {
-    return type == "privacy" || type == "social";
   }
 
   function populateLists()
   {
     subscriptionsMap = Object.create(null);
     filtersMap = Object.create(null);
 
     // Empty collections and lists
     for (let property in collections)
       collections[property].clearAll();
@@ skipping 152 matching lines @@
       case "lastDownload":
       case "title":
         updateSubscription(subscription);
         break;
       case "added":
         if (subscription.url in subscriptionsMap)
           updateSubscription(subscription);
         else
           addSubscription(subscription);
 
-        if (subscription.url == acceptableAdsUrl)
-          setAcceptableAds("default");

[Thomas Greiner, 2017/08/16 17:57:10]

We cannot determine the current state based on which filter list got added last
because the other one could still be present.

Therefore I'd recommend checking which of the two filters lists are installed
and enabled each time any of them gets added, removed, enabled or disabled (e.g.
`if (isAcceptable(subscription.url) refreshAcceptableAds()`).

My suggestion for the states:
- aa:false + aa-privacy:false = all ads blocked
- aa:true + aa-privacy:false = all Acceptable Ads unblocked
- aa:false + aa-privacy:true = only privacy-friendly Acceptable Ads unblocked
- aa:true + aa-privacy:true = all Acceptable Ads unblocked

Because since the privacy-friendly list is only a subset of the  regular one,
having both enabled at the same time is equivalent to only having the regular
one enabled.

[saroyanm, 2017/08/17 11:21:18]

I agree. I'll update accordingly.

[saroyanm, 2017/08/17 21:24:04]

Done.

-
-        if (subscription.url == acceptableAdsPrivacyUrl)
-        {
-          setAcceptableAds("privacy");
-          if (!navigator.doNotTrack)
-            setDntNotification(true);
-        }
+        if (isAcceptableAds(subscription.url))
+          setAcceptableAds();
 
         collections.filterLists.addItem(subscription);
         break;
       case "removed":
-        if (subscription.recommended == "ads" ||
-            isProtection(subscription.recommended))
+        if (subscription.recommended)
         {
           subscription.disabled = true;
           onSubscriptionMessage("disabled", subscription);
         }
-        if (isAcceptableAds(subscription.url))
-        {
-          setAcceptableAds("none");
-          if (subscription.url == acceptableAdsPrivacyUrl)
+        else
+        {
+          delete subscriptionsMap[subscription.url];
+          if (isAcceptableAds(subscription.url))
           {
-            setDntNotification(false);
+            setAcceptableAds();
           }
-        }
-        else
-        {
-          collections.custom.removeItem(subscription);

[Thomas Greiner, 2017/08/16 17:57:09]

Detail: Recommended subscriptions should not be in the "More Filters" section
anyway.

[saroyanm, 2017/08/17 21:24:06]

Done.

-          delete subscriptionsMap[subscription.url];

[Thomas Greiner, 2017/08/16 17:57:10]

In `addSubscription()` we're adding Acceptable Ads subscriptions to
`subscriptionsMap` so why aren't we removing them here?

[saroyanm, 2017/08/17 11:21:17]

I tried to be consistent with old implementation here I think... 
But I do agree that we should remove it, I'll check if that will couse any sort
of unexpected behavior, but I think we should be safe here, also same should
apply to some recommended subscriptions that are not "ads" and "protection"
type.

[Thomas Greiner, 2017/08/17 12:06:06]

Sounds good.

[saroyanm, 2017/08/17 21:24:07]

With current implementation is more understandable,actually we shouldn't delete
"knownSubscription"(subscriptionsMap) for recommended subscriptions, otherwise
they will stop being "recommended" and this will lead to being added into the
"more subscriptions" section and lead to unexpected behaviors. On another hand
we check URL for Acceptable Ads and we can remove it from "knownSubscription"
and that what I did. 

[Thomas Greiner, 2017/08/22 16:08:57]

I don't think not removing recommended subscriptions is a good idea because
we'll mark subscriptions as disabled even though they aren't which may cause
inconsistencies in how they're displayed and how they can be interacted with as
well as errors when trying to change the state of a subscription (e.g. trying to
enable a subscription that is not even installed).

Nevertheless, as you pointed out, we need to know whether a subscription is
recommended and which type of subscription it is. We don't need to keep
subscriptions in `subscriptionsMap` for that though but store that information
separately.

+          else
+          {
+            collections.custom.removeItem(subscription);
+          }
         }
         collections.filterLists.removeItem(subscription);
         break;
     }
 
     updateShareLink();
   }
 
   function hidePref(key, value)
   {
@@ skipping 146 matching lines @@
   });
   ext.backgroundPage.sendMessage({
     type: "subscriptions.listen",
     filter: ["added", "disabled", "homepage", "lastDownload", "removed",
              "title", "downloadStatus", "downloading"]
   });
 
   window.addEventListener("DOMContentLoaded", onDOMLoaded, false);
   window.addEventListener("hashchange", onHashChange, false);
 }