Issue 4871 - Start using ESLint for adblockplusui

new-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/>.
  */
 
-/* globals checkShareResource, getDocLink, i18n_formatDateTime, openSharePopup,
+/* globals checkShareResource, getDocLink, i18nFormatDateTime, openSharePopup,
            E */
 
 "use strict";
 
 {
   let subscriptionsMap = Object.create(null);
   let filtersMap = Object.create(null);
   let collections = Object.create(null);
   let acceptableAdsUrl = null;
   let {getMessage} = ext.i18n;
@@ skipping 79 matching lines @@
       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);
       }
 
-      let controls = listItem.querySelectorAll(".control");
-      for (let k = 0; k < controls.length; k++)
-      {
-        if (controls[k].hasAttribute("title"))
+      for (let control of listItem.querySelectorAll(".control"))
+      {
+        if (control.hasAttribute("title"))
         {
-          let titleValue = getMessage(controls[k].getAttribute("title"));
-          controls[k].setAttribute("title", titleValue);
+          let titleValue = getMessage(control.getAttribute("title"));
+          control.setAttribute("title", titleValue);
         }
       }
 
       this._setEmpty(table, null);
       if (table.hasChildNodes())
       {
         table.insertBefore(listItem,
             table.childNodes[this.items.indexOf(item)]);
       }
       else
         table.appendChild(listItem);
       this.updateItem(item);
     }
     return length;
   };
 
   Collection.prototype.removeItem = function(item)
   {
     let index = this.items.indexOf(item);
     if (index == -1)
       return;
 
     this.items.splice(index, 1);
     let getListElement = this._createElementQuery(item);
-    for (let i = 0; i < this.details.length; i++)
-    {
-      let table = E(this.details[i].id);
+    for (let detail of this.details)
+    {
+      let table = E(detail.id);
       let element = getListElement(table);
 
       // Element gets removed so make sure to handle focus appropriately
       let control = element.querySelector(".control");
       if (control && control == document.activeElement)
       {
         if (!focusNextElement(element.parentElement, control))
         {
           // Fall back to next focusable element within same tab or dialog
           let focusableElement = element.parentElement;
           while (focusableElement)
           {
             if (focusableElement.classList.contains("tab-content") ||
                 focusableElement.classList.contains("dialog-content"))
               break;
 
             focusableElement = focusableElement.parentElement;
           }
           focusNextElement(focusableElement || document, control);
         }
       }
 
       element.parentElement.removeChild(element);
       if (this.items.length == 0)
-        this._setEmpty(table, this.details[i].emptyText);
+        this._setEmpty(table, detail.emptyText);
     }
   };
 
   Collection.prototype.updateItem = function(item)
   {
     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 + "']");
@@ skipping 28 matching lines @@
         {
           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 = i18n_formatDateTime(item.lastDownload * 1000);
+          let dateTime = i18nFormatDateTime(item.lastDownload * 1000);
           dateElement.textContent = dateTime[0];
           timeElement.textContent = dateTime[1];
           element.classList.remove("show-message");
         }
       }
 
       let websiteElement = element.querySelector(".context-menu .website");
       if (websiteElement)
       {
         if (item.homepage)
           websiteElement.setAttribute("href", item.homepage);
         else
           websiteElement.setAttribute("aria-hidden", true);
       }
 
       let sourceElement = element.querySelector(".context-menu .source");
       if (sourceElement)
         sourceElement.setAttribute("href", item.url);
     }
   };
 
   Collection.prototype.clearAll = function()
   {
     this.items = [];
-    for (let i = 0; i < this.details.length; i++)
-    {
-      let table = E(this.details[i].id);
+    for (let detail of this.details)
+    {
+      let table = E(detail.id);
       let element = table.firstChild;
       while (element)
       {
         if (element.tagName == "LI" && !element.classList.contains("static"))
           table.removeChild(element);
         element = element.nextElementSibling;
       }
 
-      this._setEmpty(table, this.details[i].emptyText);
+      this._setEmpty(table, detail.emptyText);
     }
   };
 
   function focusNextElement(container, currentElement)
   {
     let focusables = container.querySelectorAll("a, button, input, .control");
     focusables = Array.prototype.slice.call(focusables);
     let index = focusables.indexOf(currentElement);
     index += (index == focusables.length - 1) ? -1 : 1;
 
@@ skipping 114 matching lines @@
     }
     else
       collections.customFilters.addItem(filter);
 
     filtersMap[filter.text] = filter;
   }
 
   function loadRecommendations()
   {
     fetch("subscriptions.xml")
-      .then(response =>
+      .then((response) =>
       {
         return response.text();
       })
-      .then(text =>
+      .then((text) =>
       {
         let doc = new DOMParser().parseFromString(text, "application/xml");
         let elements = doc.documentElement.getElementsByTagName("subscription");
-        for (let i = 0; i < elements.length; i++)
+        for (let element of elements)
         {
-          let element = elements[i];
           let type = element.getAttribute("type");
           let subscription = {
             disabled: true,
             downloadStatus: null,
             homepage: null,
             originalTitle: element.getAttribute("title"),
             recommended: type,
             url: element.getAttribute("url")
           };
 
@@ skipping 26 matching lines @@
         return element.getAttribute("data-" + dataName);
       }
 
       element = element.parentElement;
     }
     return null;
   }
 
   function sendMessageHandleErrors(message, onSuccess)
   {
-    ext.backgroundPage.sendMessage(message, errors =>
+    ext.backgroundPage.sendMessage(message, (errors) =>
     {
       if (errors.length > 0)
         alert(errors.join("\n"));
       else if (onSuccess)
         onSuccess();
     });
   }
 
   function openDocLink(id)
   {
-    getDocLink(id, link =>
+    getDocLink(id, (link) =>
     {
       if (id == "share-general")
         openSharePopup(link);
       else
         location.href = link;
     });
   }
 
   function switchTab(id)
   {
     location.hash = id;
   }
 
   function onClick(e)
   {
     let context = document.querySelector(".show-context-menu");
     if (context)
       context.classList.remove("show-context-menu");
 
-    let element = e.target;
-    while (element && !element.hasAttribute("data-action"))
-      element = element.parentElement;
-
-    element = findParentData(e.target, "action", true);
+    let element = findParentData(e.target, "action", true);
+    if (!element)
+      return;
+
     let actions = element.getAttribute("data-action").split(",");
-    for (let i = 0; i < actions.length; i++)
-    {
-      switch (actions[i])
+    for (let action of actions)
+    {
+      switch (action)
       {
         case "add-domain-exception":
           addWhitelistedDomain();
           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");
           break;
         case "cancel-domain-exception":
           E("whitelisting-textbox").value = "";
-          document.querySelector("#whitelisting .controls").classList.
-            remove("mode-edit");
+          document.querySelector("#whitelisting .controls").classList
+            .remove("mode-edit");
           break;
         case "close-dialog":
           closeDialog();
           break;
         case "edit-custom-filters":
           E("custom-filters").classList.add("mode-edit");
           editCustomFilters();
           break;
         case "edit-domain-exception":
-          document.querySelector("#whitelisting .controls").classList.
-            add("mode-edit");
+          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();
           break;
         }
         case "open-dialog": {
           let dialog = findParentData(element, "dialog", false);
@@ skipping 212 matching lines @@
         searchStyle.innerHTML = "#all-lang-table li:not([data-search*=\"" +
           this.value.toLowerCase() + "\"]) { display: none; }";
       }
     }
 
     // Initialize navigation sidebar
     ext.backgroundPage.sendMessage({
       type: "app.get",
       what: "addonVersion"
     },
-    addonVersion =>
+    (addonVersion) =>
     {
       E("abp-version").textContent = addonVersion;
     });
-    getDocLink("releases", link =>
+    getDocLink("releases", (link) =>
     {
       E("link-version").setAttribute("href", link);
     });
 
     updateShareLink();
     updateTooltips();
 
     // Initialize interactive UI elements
     document.body.addEventListener("click", onClick, false);
     document.body.addEventListener("keyup", onKeyUp, false);
     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 =>
+    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 =>
+    tweaks = Array.prototype.map.call(tweaks, (checkbox) =>
     {
       return checkbox.getAttribute("data-pref");
     });
-    tweaks.forEach(key =>

[Sebastian Noack, 2017/02/21 12:21:21]

According to our coding pracitces, for..of loops shoud be used instead of the
forEach() method. (Please check other calls to forEach() as well.)

[kzar, 2017/03/01 05:36:21]

Done.

-    {
-      getPref(key, value =>
+    for (let key of tweaks)
+    {
+      getPref(key, (value) =>
       {
         onPrefMessage(key, value, true);
       });
-    });
+    }
     ext.backgroundPage.sendMessage({
       type: "app.get",
       what: "features"
     },
-    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()
     {
       let filterText = filterTextbox.value;
       sendMessageHandleErrors({
         type: "filters.add",
         text: filterText
       },
       () =>
       {
         filterTextbox.value = "";
       });
     }
-    E("custom-filters-add").addEventListener("submit", e =>
+    E("custom-filters-add").addEventListener("submit", (e) =>
     {
       e.preventDefault();
       addCustomFilters();
     }, false);
+
+    // Help tab
+    getDocLink("faq", (link) =>
+    {
+      E("link-faq").setAttribute("href", link);
+    });
+    getDocLink("social_twitter", (link) =>
+    {
+      E("link-twitter").setAttribute("href", link);
+    });
+    getDocLink("social_facebook", (link) =>
+    {
+      E("link-facebook").setAttribute("href", link);
+    });
+    getDocLink("social_gplus", (link) =>
+    {
+      E("link-gplus").setAttribute("href", link);
+    });
+    getDocLink("social_renren", (link) =>
+    {
+      E("link-renren").setAttribute("href", link);
+    });
+    getDocLink("social_weibo", (link) =>
+    {
+      E("link-weibo").setAttribute("href", link);
+    });
+
+    // Set forum link
+    ext.backgroundPage.sendMessage({
+      type: "app.get",
+      what: "platform"
+    },
+    (platform) =>
+    {
+      ext.backgroundPage.sendMessage({
+        type: "app.get",
+        what: "application"
+      },
+      (application) =>
+      {
+        if (platform == "chromium" && application != "opera")
+          application = "chrome";
+
+        getDocLink(application + "_support", (link) =>
+        {
+          E("link-forum").setAttribute("href", link);
+        });
+      });
+    });
 
     E("dialog").addEventListener("keydown", function(e)
     {
       switch (getKey(e))
       {
         case "Escape":
           closeDialog();
           break;
         case "Tab":
           if (e.shiftKey)
@@ skipping 48 matching lines @@
     filtersMap = Object.create(null);
 
     // Empty collections and lists
     for (let property in collections)
       collections[property].clearAll();
 
     ext.backgroundPage.sendMessage({
       type: "subscriptions.get",
       special: true
     },
-    subscriptions =>
+    (subscriptions) =>
     {
       // Load filters
-      for (let i = 0; i < subscriptions.length; i++)

[Sebastian Noack, 2017/02/21 12:21:21]

Can't this be a for..of loop instead? (Please check other loops as well.)

[kzar, 2017/03/01 05:36:20]

Done.

+      for (let subscription of subscriptions)
       {
         ext.backgroundPage.sendMessage({
           type: "filters.get",
-          subscriptionUrl: subscriptions[i].url
+          subscriptionUrl: subscription.url
         },
-        filters =>
+        (filters) =>
         {
           for (let filter of filters)
             updateFilter(filter);
         });
       }
     });
     loadRecommendations();
     ext.backgroundPage.sendMessage({
       type: "prefs.get",
       key: "subscriptions_exceptionsurl"
     },
-    url =>
+    (url) =>
     {
       acceptableAdsUrl = url;
       addSubscription({
         url: acceptableAdsUrl,
         disabled: true
       });
 
       // Load user subscriptions
       ext.backgroundPage.sendMessage({
         type: "subscriptions.get",
         downloadable: true
       },
-      subscriptions =>
-      {
-        for (let i = 0; i < subscriptions.length; i++)
-          onSubscriptionMessage("added", subscriptions[i]);
+      (subscriptions) =>
+      {
+        for (let subscription of subscriptions)
+          onSubscriptionMessage("added", subscription);
       });
     });
   }
 
   function addWhitelistedDomain()
   {
     let domain = E("whitelisting-textbox");
     if (domain.value)
     {
       sendMessageHandleErrors({
         type: "filters.add",
         text: "@@||" + domain.value.toLowerCase() + "^$document"
       });
     }
 
     domain.value = "";
-    document.querySelector("#whitelisting .controls").
-      classList.remove("mode-edit");
+    document.querySelector("#whitelisting .controls")
+      .classList.remove("mode-edit");
   }
 
   function editCustomFilters()
   {
-    let customFilterItems = collections.customFilters.items;
     let filterTexts = [];
-    for (let i = 0; i < customFilterItems.length; i++)
-      filterTexts.push(customFilterItems[i].text);
+    for (let customFilterItem of collections.customFilters.items)
+      filterTexts.push(customFilterItem.text);
     E("custom-filters-raw").value = filterTexts.join("\n");
   }
 
   function addEnableSubscription(url, title, homepage)
   {
     let messageType = null;
     let knownSubscription = subscriptionsMap[url];
     if (knownSubscription && knownSubscription.disabled == true)
       messageType = "subscriptions.toggle";
     else
@@ skipping 87 matching lines @@
   function hidePref(key, value)
   {
     let element = document.querySelector("[data-pref='" + key + "']");
     if (element)
       element.setAttribute("aria-hidden", value);
   }
 
   function getPref(key, callback)
   {
     let checkPref = getPref.checks[key] || getPref.checkNone;
-    checkPref(isActive =>
+    checkPref((isActive) =>
     {
       if (!isActive)
       {
         hidePref(key, !isActive);
         return;
       }
 
       ext.backgroundPage.sendMessage({
         type: "prefs.get",
         key
@@ skipping 47 matching lines @@
     function onResult(isBlocked)
     {
       isAnyBlocked |= isBlocked;
       if (!--checksRemaining)
       {
         // Hide the share tab if a script on the share page would be blocked
         E("tab-share").hidden = isAnyBlocked;
       }
     }
 
-    for (let i = 0; i < shareResources.length; i++)
-      checkShareResource(shareResources[i], onResult);
+    for (let sharedResource of shareResources)
+      checkShareResource(sharedResource, onResult);
   }
 
   function getMessages(id)
   {
     let messages = [];
-    for (let i = 1, message = ext.i18n.getMessage(id + "_" + i); message; i++)
+    for (let i = 1; true; i++)
+    {
+      let message = ext.i18n.getMessage(id + "_" + i);
+      if (!message)
+        break;
+
       messages.push(message);
+    }
     return messages;
   }
 
   function updateTooltips()
   {
     let anchors = document.querySelectorAll(":not(.tooltip) > [data-tooltip]");
-    for (let i = 0; i < anchors.length; i++)
-    {
-      let anchor = anchors[i];
+    for (let anchor of anchors)
+    {
       let id = anchor.getAttribute("data-tooltip");
 
       let wrapper = document.createElement("div");
       wrapper.className = "tooltip";
       anchor.parentNode.replaceChild(wrapper, anchor);
       wrapper.appendChild(anchor);
 
       let topTexts = getMessages(id);
       let bottomTexts = getMessages(id + "_notes");
 
@@ skipping 15 matching lines @@
 
       let imageSource = anchor.getAttribute("data-tooltip-image");
       if (imageSource)
       {
         let image = document.createElement("img");
         image.src = imageSource;
         image.alt = "";
         tooltip.appendChild(image);
       }
 
-      for (let j = 0; j < topTexts.length; j++)
+      for (let topText of topTexts)
       {
         let paragraph = document.createElement("p");
-        paragraph.innerHTML = topTexts[j];
+        paragraph.innerHTML = topText;
         tooltip.appendChild(paragraph);
       }
       if (bottomTexts.length > 0)
       {
         let notes = document.createElement("div");
         notes.className = "notes";
-        for (let j = 0; j < bottomTexts.length; j++)
+        for (let bottomText of bottomTexts)
         {
           let paragraph = document.createElement("p");
-          paragraph.innerHTML = bottomTexts[j];
+          paragraph.innerHTML = bottomText;
           notes.appendChild(paragraph);
         }
         tooltip.appendChild(notes);
       }
 
       wrapper.appendChild(tooltip);
     }
   }
 
-  ext.onMessage.addListener(message =>
+  ext.onMessage.addListener((message) =>
   {
     switch (message.type)
     {
       case "app.respond":
         switch (message.action)
         {
           case "addSubscription":
             let subscription = message.args[0];
             let dialog = E("dialog-content-predefined");
             dialog.querySelector("h3").textContent = subscription.title || "";
@@ skipping 32 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);
 }