Issue 4878 - Start using ESLint for adblockpluscore

lib/filterListener.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/>.
  */
 
-/**
- * @fileOverview Component synchronizing filter storage with Matcher instances and ElemHide.
- */
+/* globals Services, XPCOMUtils */

[Sebastian Noack, 2017/02/20 13:14:51]

Aren't these universally available? If so, please put them in .eslintrc.json.

[kzar, 2017/02/21 06:13:59]

Done.

 
 "use strict";
 
+/**
+ * @fileOverview Component synchronizing filter storage with Matcher
+ *               instances and ElemHide.
+ */
+
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 Cu.import("resource://gre/modules/Services.jsm");
 
 let {FilterStorage} = require("filterStorage");
 let {FilterNotifier} = require("filterNotifier");
 let {ElemHide} = require("elemHide");
 let {ElemHideEmulation} = require("elemHideEmulation");
 let {defaultMatcher} = require("matcher");
 let {ActiveFilter, RegExpFilter, ElemHideBase, ElemHideEmulationFilter} =
     require("filterClasses");
 let {Prefs} = require("prefs");
 
 /**
  * Increases on filter changes, filters will be saved if it exceeds 1.
- * @type Integer
+ * @type {Integer}
  */
 let isDirty = 0;
 
 /**
  * This object can be used to change properties of the filter change listeners.
  * @class
  */
-let FilterListener =
-{
+let FilterListener = {
   /**
-   * Increases "dirty factor" of the filters and calls FilterStorage.saveToDisk()
-   * if it becomes 1 or more. Save is executed delayed to prevent multiple
-   * subsequent calls. If the parameter is 0 it forces saving filters if any
-   * changes were recorded after the previous save.
+   * Increases "dirty factor" of the filters and calls
+   * FilterStorage.saveToDisk() if it becomes 1 or more. Save is
+   * executed delayed to prevent multiple subsequent calls. If the
+   * parameter is 0 it forces saving filters if any changes were
+   * recorded after the previous save.
+   * @param {Integer} factor
    */
-  setDirty: function(/**Integer*/ factor)
+  setDirty(factor)
   {
     if (factor == 0 && isDirty > 0)
       isDirty = 1;
     else
       isDirty += factor;
     if (isDirty >= 1)
     {
       isDirty = 0;
       FilterStorage.saveToDisk();
     }
   }
 };
 
 /**
  * Observer listening to history purge actions.
  * @class
  */
-let HistoryPurgeObserver =
-{
-  observe: function(subject, topic, data)
+let HistoryPurgeObserver = {
+  observe(subject, topic, data)
   {
-    if (topic == "browser:purge-session-history" && Prefs.clearStatsOnHistoryPurge)
+    if (topic == "browser:purge-session-history" &&
+        Prefs.clearStatsOnHistoryPurge)
     {
       FilterStorage.resetHitCounts();
       FilterListener.setDirty(0); // Force saving to disk
 
       Prefs.recentReports = [];
     }
   },
-  QueryInterface: XPCOMUtils.generateQI([Ci.nsISupportsWeakReference, Ci.nsIObserver])
+  QueryInterface: XPCOMUtils.generateQI(
+    [Ci.nsISupportsWeakReference, Ci.nsIObserver]
+  )
 };
 
 /**
  * Initializes filter listener on startup, registers the necessary hooks.
  */
 function init()
 {
   FilterNotifier.on("filter.hitCount", onFilterHitCount);
   FilterNotifier.on("filter.lastHit", onFilterLastHit);
   FilterNotifier.on("filter.added", onFilterAdded);
@@ skipping 11 matching lines @@
   FilterNotifier.on("subscription.homepage", onGenericChange);
   FilterNotifier.on("subscription.downloadStatus", onGenericChange);
   FilterNotifier.on("subscription.lastCheck", onGenericChange);
   FilterNotifier.on("subscription.errors", onGenericChange);
 
   FilterNotifier.on("load", onLoad);
   FilterNotifier.on("save", onSave);
 
   FilterStorage.loadFromDisk();
 
-  Services.obs.addObserver(HistoryPurgeObserver, "browser:purge-session-history", true);
-  onShutdown.add(function()
+  Services.obs.addObserver(HistoryPurgeObserver,
+                           "browser:purge-session-history", true);
+  onShutdown.add(() =>
   {
-    Services.obs.removeObserver(HistoryPurgeObserver, "browser:purge-session-history");
+    Services.obs.removeObserver(HistoryPurgeObserver,
+                                "browser:purge-session-history");
   });
 }
 init();
 
 /**
  * Notifies Matcher instances or ElemHide object about a new filter
  * if necessary.
  * @param {Filter} filter filter that has been added
  */
 function addFilter(filter)
 {
   if (!(filter instanceof ActiveFilter) || filter.disabled)
     return;
 
   let hasEnabled = false;
   for (let i = 0; i < filter.subscriptions.length; i++)
+  {
     if (!filter.subscriptions[i].disabled)
       hasEnabled = true;
+  }
   if (!hasEnabled)
     return;
 
   if (filter instanceof RegExpFilter)
     defaultMatcher.add(filter);
   else if (filter instanceof ElemHideBase)
   {
     if (filter instanceof ElemHideEmulationFilter)
       ElemHideEmulation.add(filter);
     else
       ElemHide.add(filter);
   }
 }
 
 /**
  * Notifies Matcher instances or ElemHide object about removal of a filter
  * if necessary.
  * @param {Filter} filter filter that has been removed
  */
 function removeFilter(filter)
 {
   if (!(filter instanceof ActiveFilter))
     return;
 
   if (!filter.disabled)
   {
     let hasEnabled = false;
     for (let i = 0; i < filter.subscriptions.length; i++)
+    {
       if (!filter.subscriptions[i].disabled)
         hasEnabled = true;
+    }
     if (hasEnabled)
       return;
   }
 
   if (filter instanceof RegExpFilter)
     defaultMatcher.remove(filter);
   else if (filter instanceof ElemHideBase)
   {
     if (filter instanceof ElemHideEmulationFilter)
       ElemHideEmulation.remove(filter);
@@ skipping 12 matching lines @@
   // filters applying there. We have ten prime numbers to use as iteration step,
   // any of those can be chosen as long as the array length isn't divisible by
   // it.
   let len = filters.length;
   if (!len)
     return;
 
   let current = (Math.random() * len) | 0;
   let step;
   do
-  {
     step = primes[(Math.random() * primes.length) | 0];
-  } while (len % step == 0);
+  while (len % step == 0);
 
   for (let i = 0; i < len; i++, current = (current + step) % len)
     addFilter(filters[current]);
 }
 
 function onSubscriptionAdded(subscription)
 {
   FilterListener.setDirty(1);
 
   if (!subscription.disabled)
@@ skipping 78 matching lines @@
 }
 
 function onLoad()
 {
   isDirty = 0;
 
   defaultMatcher.clear();
   ElemHide.clear();
   ElemHideEmulation.clear();
   for (let subscription of FilterStorage.subscriptions)
+  {
     if (!subscription.disabled)
       addFilters(subscription.filters);
+  }
 }
 
 function onSave()
 {
   isDirty = 0;
 }