Issue 5255 - Advanced tab (HTML, strings and functionality)

new-options.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2017 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 20 matching lines @@
     ["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"]
   ]);
 
+  const whitelistedDomainRegexp = /^@@\|\|([^/:]+)\^\$document$/;
+
   function Collection(details)
   {
     this.details = details;
     this.items = [];
   }
 
   Collection.prototype._setEmpty = function(table, text)
   {
     let placeholder = table.querySelector(".empty-placeholder");
     if (text && !placeholder)
@@ skipping 42 matching lines @@
       if (b.url == acceptableAdsUrl)
         return -1;
 
       let aTitle = this._getItemTitle(a, 0).toLowerCase();
       let bTitle = this._getItemTitle(b, 0).toLowerCase();
       return aTitle.localeCompare(bTitle);
     });
 
     for (let j = 0; j < this.details.length; j++)
     {
-      let table = E(this.details[j].id);
+      let detail = this.details[j];
+      let table = E(detail.id);
       let template = table.querySelector("template");
       let listItem = document.createElement("li");
       listItem.appendChild(document.importNode(template.content, true));
       listItem.setAttribute("aria-label", this._getItemTitle(item, j));
       listItem.setAttribute("data-access", item.url || item.text);
       listItem.setAttribute("role", "section");
 
       let label = listItem.querySelector(".display");
       if (item.recommended && label.hasAttribute("data-tooltip"))
       {
         let tooltipId = label.getAttribute("data-tooltip");
         tooltipId = tooltipId.replace("%value%", item.recommended);
         label.setAttribute("data-tooltip", tooltipId);
       }
 
       for (let control of listItem.querySelectorAll(".control"))
       {
         if (control.hasAttribute("title"))
         {
           let titleValue = getMessage(control.getAttribute("title"));
           control.setAttribute("title", titleValue);
         }
       }
 
       this._setEmpty(table, null);
-      if (table.hasChildNodes())
+      if (table.children.length > 0)
       {
-        table.insertBefore(listItem,
-            table.childNodes[this.items.indexOf(item)]);
+        let beforeIndex = this.items.indexOf(item) + (detail.useHeader == true);
+        table.insertBefore(listItem, table.children[beforeIndex]);
       }

[Thomas Greiner, 2017/07/07 13:01:09]

What's the reason for those changes? I didn't notice any header being added.

[saroyanm, 2017/07/10 11:38:00]

Header is column name. I used naming header from "<TH>" element.
beforeIndex is increased by one in case table have header column.

While this is specified in the HTML rather than generated dynamically it's easy
to use this solution. Anyway let's discuss this implementation.

[saroyanm, 2017/07/10 13:27:43]

I'll move the column names row out of the list for current review.

[saroyanm, 2017/07/12 15:29:02]

Done.

       else
+      {
         table.appendChild(listItem);
+      }
       this.updateItem(item);
     }
     return length;
   };
 
   Collection.prototype.removeItem = function(item)
   {
     let index = this.items.indexOf(item);
     if (index == -1)
       return;
@@ skipping 47 matching lines @@
       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 (item.url == acceptableAdsUrl && this == collections.filterLists)
           control.setAttribute("disabled", true);
       }
 
-      let dateElement = element.querySelector(".date");
-      let timeElement = element.querySelector(".time");
-      if (dateElement && timeElement)
+      let lastUpdateElem = element.querySelector(".last-update");
+      if (lastUpdateElem)
       {
         let message = element.querySelector(".message");
         if (item.isDownloading)
         {
           let text = getMessage("options_filterList_lastDownload_inProgress");
           message.textContent = text;
           element.classList.add("show-message");
         }
         else if (item.downloadStatus != "synchronize_ok")
         {
           let error = filterErrors.get(item.downloadStatus);
           if (error)
             message.textContent = getMessage(error);
           else
             message.textContent = item.downloadStatus;
           element.classList.add("show-message");
         }
         else if (item.lastDownload > 0)
         {
-          let dateTime = i18nFormatDateTime(item.lastDownload * 1000);
-          dateElement.textContent = dateTime[0];
-          timeElement.textContent = dateTime[1];
+          let timer = setInterval(lastUpdateLive, 60000);

[Thomas Greiner, 2017/07/07 13:01:09]

As far as I see, the spec doesn't say that this time is supposed to be kept
up-to-date while the page is open.

Furthermore, here are some optional improvements in case it turns out that this
feature is required:
- No need to update it every minute if `lastUpdate > 1 hour`
- The next minute might be reached even before the 60 seconds have passed since
it's unlikely that we set the interval at exactly zero seconds.
- The interval seems to continue even after the item gets removed.

[saroyanm, 2017/07/10 11:38:02]

I do remember that this was discussed during our meetings and the outcome was to
update this live. Anyway this should end up in the specs as well, if it's not
yet. I'll take care of it.
agree
agree
Good point, I'll remove it.

[saroyanm, 2017/07/12 15:29:01]

Removed live update

+          let lastUpdate = item.lastDownload * 1000;
+          function lastUpdateLive()
+          {
+            let sinceUpdate = Date.now() - lastUpdate;
+            if(sinceUpdate > 86400000)

[Thomas Greiner, 2017/07/07 13:01:10]

Detail: Usually, we create constants to make it more obvious what all those
different numbers are supposed to represent.

See
- https://hg.adblockplus.org/adblockpluscore/file/tip/lib/synchronizer.js#l33
- https://hg.adblockplus.org/adblockpluscore/file/tip/lib/downloader.js#l25

[saroyanm, 2017/07/10 11:38:01]

Agree

[saroyanm, 2017/07/12 15:29:02]

Done.

+            {
+              let lastUpdateDate = new Date(item.lastDownload * 1000);
+              let monthName = lastUpdateDate.toLocaleString(
+                document.documentElement.lang, { month: "short" });

[Thomas Greiner, 2017/07/07 13:01:10]

Actually, while reviewing #5278 I noticed that we could simply pass `undefined`
for the locale value to use the current value. If you remember we did try
passing `null` and omitting the first parameter to achieve that but neither one
worked.

On another note, we could even go as far as to use

new Intl.DateTimeFormat(undefined, {year: "numeric", month: "short", day:
"2-digit"}).format(new Date())

instead to format the date but it doesn't seem like we could get the format "DD
MMM YYYY" out of it so it doesn't seem too useful for what we need here.

[Thomas Greiner, 2017/07/07 13:01:10]

Coding style: This violates the rule "object-curly-spacing" from
eslint-config-eyeo.

See
-
https://hg.adblockplus.org/codingtools/file/tip/eslint-config-eyeo/index.js#l84
- http://eslint.org/docs/rules/object-curly-spacing

[saroyanm, 2017/07/10 11:38:00]

Good point, I'll run eslint before uploading next patch.

[saroyanm, 2017/07/10 11:38:01]

Acknowledged, checked specifications as well I think we good to go with
undefined. Undefined suppose to the value if "locale" parameter is missing.

[saroyanm, 2017/07/12 15:29:01]

Done.

[saroyanm, 2017/07/12 15:29:01]

Done.

+              let day = lastUpdateDate.getDate();
+              day = day < 10 ? "0" + day : day;
+              lastUpdateElem.textContent = day + " " + monthName + " " + 
+                lastUpdateDate.getFullYear();
+              clearInterval(timer);
+              return;
+            }
+            else if (sinceUpdate > 3600000)
+            {
+              lastUpdateElem.textContent = Math.round(sinceUpdate / 3600000) + 
+                " " + getMessage("options_filterList_hours");
+            }
+            else if (sinceUpdate > 60000)
+            {
+              lastUpdateElem.textContent = Math.round(sinceUpdate / 60000) + 
+                " " + getMessage("options_filterList_minutes");
+            }
+            else
+            {
+              lastUpdateElem.textContent = 
+                getMessage("options_filterList_just");
+            }
+          }
+          lastUpdateLive();
           element.classList.remove("show-message");
         }
       }
 
       let websiteElement = element.querySelector(".context-menu .website");
       if (websiteElement)
       {
         if (item.homepage)
           websiteElement.setAttribute("href", item.homepage);
         else
@@ skipping 70 matching lines @@
     {
       id: "custom-list-table"
     }
   ]);
   collections.whitelist = new Collection([
     {
       id: "whitelisting-table",
       emptyText: "options_whitelisted_empty"
     }
   ]);
-  collections.customFilters = new Collection([
-    {
-      id: "custom-filters-table",
-      emptyText: "options_customFilters_empty"
-    }
-  ]);
   collections.filterLists = new Collection([
     {
       id: "all-filter-lists-table",
-      useOriginalTitle: true
+      useOriginalTitle: true,
+      useHeader: true
     }
   ]);
 
   function toggleShowLanguage(subscription)
   {
     if (subscription.recommended == "ads")
     {
       if (subscription.disabled)
       {
         collections.allLangs.addItem(subscription);
@@ skipping 33 matching lines @@
   function updateSubscription(subscription)
   {
     for (let name in collections)
       collections[name].updateItem(subscription);
 
     toggleShowLanguage(subscription);
   }
 
   function updateFilter(filter)
   {
-    let match = filter.text.match(/^@@\|\|([^/:]+)\^\$document$/);
+    let match = filter.text.match(whitelistedDomainRegexp);
     if (match && !filtersMap[filter.text])
     {
       filter.title = match[1];
       collections.whitelist.addItem(filter);
     }
     else
-      collections.customFilters.addItem(filter);
+      addCustomFilter(filter);
 
     filtersMap[filter.text] = filter;
   }
 
+  function addCustomFilter(filter)
+  {
+    customFiltersView("read");

[Thomas Greiner, 2017/07/07 13:01:10]

Detail: The name is ambiguous because it doesn't say what happens with the
custom filters view. Names such as "setCustomFiltersView" or
"switchCustomFiltersView" would clarify that.

[saroyanm, 2017/07/10 11:38:01]

Agree.

[saroyanm, 2017/07/12 15:29:01]

Done.

+
+    E("custom-filters-box").appendChild(new Option(filter.text, filter.text));
+  }
+
+  function removeCustomFilter(text)
+  {
+    let list = E("custom-filters-box");
+    let selector = "option[value=" + CSS.escape(text) + "]";
+    for (let option of list.querySelectorAll(selector))
+      list.removeChild(option);
+
+    if (E("custom-filters-box").options.length == 0)
+      customFiltersView("empty")
+  }
+
+  function convertToRawFormat(event)
+  {
+    let filters = [];
+
+    for (let option of E("custom-filters-box").options)
+      filters.push(option.value);
+
+    document.getElementById("custom-filters-raw").value = filters.join("\n");
+  }
+
   function loadRecommendations()
   {
     fetch("subscriptions.xml")
       .then((response) =>
       {
         return response.text();
       })
       .then((text) =>
       {
         let doc = new DOMParser().parseFromString(text, "application/xml");
@@ skipping 64 matching lines @@
       else
         location.href = link;
     });
   }
 
   function switchTab(id)
   {
     location.hash = id;
   }
 
-  function execAction(action, element)
+  function execAction(action, element, event)
   {
+    if (element.getAttribute("href") == "#")

[Thomas Greiner, 2017/07/07 13:01:10]

Detail: Why do you even set the "href" attribute in the first place?

[saroyanm, 2017/07/10 11:38:00]

Good question, I think we don't need href attribute, at all, I thought it's some
kind of common practice to specify href attribute, but I think we can remove it.

[saroyanm, 2017/07/12 15:29:02]

Done.

+      event.preventDefault();
+
     switch (action)
     {
       case "add-domain-exception":
         addWhitelistedDomain();
         break;
       case "add-language-subscription":
         addEnableSubscription(findParentData(element, "access", false));
         break;
       case "add-predefined-subscription": {
         let dialog = E("dialog-content-predefined");
         let title = dialog.querySelector("h3").textContent;
         let url = dialog.querySelector(".url").textContent;
         addEnableSubscription(url, title);
         closeDialog();
         break;
       }
       case "cancel-custom-filters":
-        E("custom-filters").classList.remove("mode-edit");
+        customFiltersView("read");
         break;
       case "cancel-domain-exception":
         E("whitelisting-textbox").value = "";
         document.querySelector("#whitelisting .controls").classList
           .remove("mode-edit");
         break;
       case "close-dialog":
         closeDialog();
         break;
       case "edit-custom-filters":
-        editCustomFilters();
+        customFiltersView("write");
         break;
       case "edit-domain-exception":
         document.querySelector("#whitelisting .controls").classList
           .add("mode-edit");
         E("whitelisting-textbox").focus();
         break;
       case "import-subscription": {
         let url = E("blockingList-textbox").value;
         addEnableSubscription(url);
         closeDialog();
@@ skipping 28 matching lines @@
         });
         break;
       case "save-custom-filters":
         sendMessageHandleErrors({
           type: "filters.importRaw",
           text: E("custom-filters-raw").value,
           removeExisting: true
         },
         () =>
         {
-          E("custom-filters").classList.remove("mode-edit");
+          customFiltersView("read");
         });
         break;
       case "switch-tab":
         let tabId = findParentData(element, "tab", false);
         switchTab(tabId);
         break;
       case "toggle-disable-subscription":
         ext.backgroundPage.sendMessage({
           type: "subscriptions.toggle",
           keepInstalled: true,
@@ skipping 25 matching lines @@
         break;
       case "update-subscription":
         ext.backgroundPage.sendMessage({
           type: "subscriptions.update",
           url: findParentData(element, "access", false)
         });
         break;
     }
   }
 
+  function customFiltersView(mode)

[Thomas Greiner, 2017/07/07 13:01:09]

Detail: I noticed that you've call `E("custom-filters")` quite often and
unconditionally so let's introduce a variable for that.

[Thomas Greiner, 2017/07/07 13:01:09]

You're trying to switch between three modes but each class can only represent
two values. The simplest solutions for this scenario would be to either not use
classes (e.g. `data-mode="view"`) or to use two classes (e.g. `.empty.view`).

[saroyanm, 2017/07/10 11:38:00]

".mode-edit" Will be consistent with other implementation we already introduced,
previously. But I agree that data-mode="view" is more clear implementation. I
think that we are safe to switch to using data attributes, that will be
consistent with how we are switching between tabs. And inconsistency between
using class attribute will be removed after #5391 is resolved.

[saroyanm, 2017/07/10 11:38:00]

Agree.

[saroyanm, 2017/07/12 15:29:02]

Done.

[saroyanm, 2017/07/12 15:29:02]

Done.

+  {
+    switch (mode)
+    {
+      case "read":
+        if (E("custom-filters-box").options.length == 0)
+        {
+          customFiltersView("empty");
+        }
+        else
+        {
+          E("custom-filters").classList.add("mode-view");

[Thomas Greiner, 2017/07/07 13:01:10]

Detail: Why the different naming? I do like that you chose to go with "read" and
"write" instead of "view" and "edit" but why not use them consistently
throughout?

[saroyanm, 2017/07/10 11:38:00]

Acknowledged, will make them consistent

[saroyanm, 2017/07/12 15:29:02]

Done.

+          E("custom-filters").classList.remove("mode-edit");
+          E("custom-filters").classList.remove("mode-empty");

[Thomas Greiner, 2017/07/07 13:01:09]

Detail: Note that you can pass multiple arguments to
`HTMLElement.classList.add()` and `HTMLElement.classList.remove()` so no need to
call them multiple times.

[saroyanm, 2017/07/10 11:38:01]

Acknowledged.

+        }
+        break;
+      case "write":
+        convertToRawFormat();
+        E("custom-filters").classList.remove("mode-view");
+        E("custom-filters").classList.add("mode-edit");
+        E("custom-filters").classList.remove("mode-empty");
+        break;
+      case "empty":
+        E("custom-filters").classList.remove("mode-view");
+        E("custom-filters").classList.remove("mode-edit");
+        E("custom-filters").classList.add("mode-empty");
+        break;
+    }
+  }
+
   function onClick(e)
   {
     let context = document.querySelector(".show-context-menu");
     if (context)
       context.classList.remove("show-context-menu");
 
     let actions = findParentData(e.target, "action", false);
     if (!actions)
       return;
 
     actions = actions.split(",");
     for (let action of actions)
     {
-      execAction(action, e.target);
+      execAction(action, e.target, e);
     }
   }
 
   function getKey(e)
   {
     // e.keyCode has been deprecated so we attempt to use e.key
     if ("key" in e)
       return e.key;
     return getKey.keys[e.keyCode];
   }
@@ skipping 26 matching lines @@
     {
       if (key == "ArrowLeft" || key == "ArrowUp")
         element = element.previousElementSibling || container.lastElementChild;
       else if (key == "ArrowRight" || key == "ArrowDown")
         element = element.nextElementSibling || container.firstElementChild;
     }
 
     let actions = container.getAttribute("data-action").split(",");
     for (let action of actions)
     {
-      execAction(action, element);
+      execAction(action, element, e);
     }
   }
 
   function selectTabItem(tabId, container, focus)
   {
     // Show tab content
     document.body.setAttribute("data-tab", tabId);
 
     // Select tab
     let tabList = container.querySelector("[role='tablist']");
     if (!tabList)
       return null;
 
     let previousTab = tabList.querySelector("[aria-selected]");
     previousTab.removeAttribute("aria-selected");
     previousTab.setAttribute("tabindex", -1);
 
     let tab = tabList.querySelector("li[data-tab='" + tabId + "']");
     tab.setAttribute("aria-selected", true);
     tab.setAttribute("tabindex", 0);
 
     let tabContentId = tab.getAttribute("aria-controls");
     let tabContent = document.getElementById(tabContentId);
 
-    // Select sub tabs
-    if (tab.hasAttribute("data-subtab"))
-      selectTabItem(tab.getAttribute("data-subtab"), tabContent, false);
-
     if (tab && focus)
       tab.focus();
 
     return tabContent;
   }
 
   function onHashChange()
   {
     let hash = location.hash.substr(1);
     if (!hash)
@@ skipping 49 matching lines @@
     let placeholderValue = getMessage("options_dialog_language_find");
     E("find-language").setAttribute("placeholder", placeholderValue);
     E("find-language").addEventListener("keyup", onFindLanguageKeyUp, false);
     E("whitelisting-textbox").addEventListener("keypress", (e) =>
     {
       if (getKey(e) == "Enter")
         addWhitelistedDomain();
     }, false);
 
     // Advanced tab
-    let tweaks = document.querySelectorAll("#tweaks li[data-pref]");
-    tweaks = Array.prototype.map.call(tweaks, (checkbox) =>
+    let customize = document.querySelectorAll("#customize li[data-pref]");
+    customize = Array.prototype.map.call(customize, (checkbox) =>
     {
       return checkbox.getAttribute("data-pref");
     });
-    for (let key of tweaks)
+    for (let key of customize)
     {
       getPref(key, (value) =>
       {
         onPrefMessage(key, value, true);
       });
     }
     ext.backgroundPage.sendMessage({
       type: "app.get",
       what: "features"
     },
     (features) =>
     {
       hidePref("show_devtools_panel", !features.devToolsPanel);
     });
 
-    let filterTextbox = document.querySelector("#custom-filters-add input");
-    placeholderValue = getMessage("options_customFilters_textbox_placeholder");
-    filterTextbox.setAttribute("placeholder", placeholderValue);
-    function addCustomFilters()
+    getDocLink("filterdoc", (link) =>
     {
-      let filterText = filterTextbox.value;
-      sendMessageHandleErrors({
-        type: "filters.add",
-        text: filterText
-      },
-      () =>
-      {
-        filterTextbox.value = "";
-      });
-    }
-    E("custom-filters-add").addEventListener("submit", (e) =>
+      E("link-filters").setAttribute("href", link);
+    });
+
+    getDocLink("subscriptions", (link) =>
     {
-      e.preventDefault();
-      addCustomFilters();
-    }, false);
+      setLinks("filter-lists-description", link);
+    });
+
+    E("custom-filters-raw").setAttribute("placeholder",
+      getMessage("options_customFilters_edit_placeholder", ["/ads/track/*"]));
 
     // Help tab
     getDocLink("faq", (link) =>
     {
       E("link-faq").setAttribute("href", link);
     });
     getDocLink("social_twitter", (link) =>
     {
       E("link-twitter").setAttribute("href", link);
     });
@@ skipping 206 matching lines @@
     {
       case "added":
         updateFilter(filter);
         updateShareLink();
         break;
       case "loaded":
         populateLists();
         break;
       case "removed":
         let knownFilter = filtersMap[filter.text];
-        collections.whitelist.removeItem(knownFilter);
-        collections.customFilters.removeItem(knownFilter);
+        if (whitelistedDomainRegexp.test(knownFilter.text))
+          collections.whitelist.removeItem(knownFilter);
+        else
+          removeCustomFilter(filter.text);
+
         delete filtersMap[filter.text];
         updateShareLink();
         break;
     }
   }
 
   function onSubscriptionMessage(action, subscription)
   {
     if (subscription.url in subscriptionsMap)
     {
@@ skipping 250 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);
 }