Issue 394 - hit statistics tool data collection (core)

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.
  */
 
+"use strict";
+
 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 {CSSRules} = require("cssRules");
 let {defaultMatcher} = require("matcher");
 let {ActiveFilter, RegExpFilter, ElemHideBase, CSSPropertyFilter} =
     require("filterClasses");
 let {Prefs} = require("prefs");
-let {FilterHits} = require("filterHits");

[Wladimir Palant, 2016/02/29 14:40:30]

This needs to be included conditionally - this file will be used on all kind of
platforms, the filterHits module is currently Firefox-only however. I guess
something like that:

let FilterHits = null;
try
{
  ({FilterHits} = require("filterHits"));
}
catch (e) {}

You can then use it conditionally below.

[saroyanm, 2016/03/18 18:24:47]

Done.

+let FilterHits = null;
+try
+{
+  ({FilterHits} = require("filterHits"));
+}
+catch (e) {}
 
 /**
  * Value of the FilterListener.batchMode property.
  * @type Boolean
  */
 let batchMode = false;
 
 /**
  * Increases on filter changes, filters will be saved if it exceeds 1.
  * @type Integer
@@ skipping 44 matching lines @@
  * Observer listening to history purge actions.
  * @class
  */
 let HistoryPurgeObserver =
 {
   observe: function(subject, topic, data)
   {
     if (topic == "browser:purge-session-history" && Prefs.clearStatsOnHistoryPurge)
     {
       FilterStorage.resetHitCounts();
-      FilterHits.resetFilterHits();
       FilterListener.setDirty(0); // Force saving to disk
+      if (FilterHits)
+        FilterHits.resetFilterHits();
 
       Prefs.recentReports = [];
     }
   },
   QueryInterface: XPCOMUtils.generateQI([Ci.nsISupportsWeakReference, Ci.nsIObserver])
 };
 
 /**
  * Initializes filter listener on startup, registers the necessary hooks.
  */
 function init()
 {
-  FilterNotifier.addListener(function(action, item, newValue, oldValue)
-  {
-    let match = /^(\w+)\.(.*)/.exec(action);
-    if (match && match[1] == "filter")
-      onFilterChange(match[2], item, newValue, oldValue);
-    else if (match && match[1] == "subscription")
-      onSubscriptionChange(match[2], item, newValue, oldValue);
-    else
-      onGenericChange(action, item);
-  });
+  FilterNotifier.on("filter.hitCount", onFilterHitCount);
+  FilterNotifier.on("filter.lastHit", onFilterLastHit);
+  FilterNotifier.on("filter.added", onFilterAdded);
+  FilterNotifier.on("filter.removed", onFilterRemoved);
+  FilterNotifier.on("filter.disabled", onFilterDisabled);
+  FilterNotifier.on("filter.moved", onGenericChange);
+
+  FilterNotifier.on("subscription.added", onSubscriptionAdded);
+  FilterNotifier.on("subscription.removed", onSubscriptionRemoved);
+  FilterNotifier.on("subscription.disabled", onSubscriptionDisabled);
+  FilterNotifier.on("subscription.updated", onSubscriptionUpdated);
+  FilterNotifier.on("subscription.moved", onGenericChange);
+  FilterNotifier.on("subscription.title", onGenericChange);
+  FilterNotifier.on("subscription.fixedTitle", onGenericChange);
+  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);
+
 
   if ("nsIStyleSheetService" in Ci)
     ElemHide.init();
   else
     flushElemHide = function() {};    // No global stylesheet in Chrome & Co.
   FilterStorage.loadFromDisk();
 
   Services.obs.addObserver(HistoryPurgeObserver, "browser:purge-session-history", true);
   onShutdown.add(function()
   {
@@ skipping 63 matching lines @@
     defaultMatcher.remove(filter);
   else if (filter instanceof ElemHideBase)
   {
     if (filter instanceof CSSPropertyFilter)
       CSSRules.remove(filter);
     else
       ElemHide.remove(filter);
   }
 }
 
-/**
- * Subscription change listener
- */
-function onSubscriptionChange(action, subscription, newValue, oldValue)
-{
-  FilterListener.setDirty(1);
-
-  if (action != "added" && action != "removed" && action != "disabled" && action != "updated")
-    return;
-
-  if (action != "removed" && !(subscription.url in FilterStorage.knownSubscriptions))
-  {
-    // Ignore updates for subscriptions not in the list
-    return;
-  }
-
-  if ((action == "added" || action == "removed" || action == "updated") && subscription.disabled)
-  {
-    // Ignore adding/removing/updating of disabled subscriptions
-    return;
-  }
-
-  if (action == "added" || action == "removed" || action == "disabled")
-  {
-    let method = (action == "added" || (action == "disabled" && newValue == false) ? addFilter : removeFilter);
-    if (subscription.filters)
-      subscription.filters.forEach(method);
-  }
-  else if (action == "updated")
+function onSubscriptionAdded(subscription)
+{
+  FilterListener.setDirty(1);
+
+  if (!subscription.disabled)
+  {
+    subscription.filters.forEach(addFilter);
+    flushElemHide();
+  }
+}
+
+function onSubscriptionRemoved(subscription)
+{
+  FilterListener.setDirty(1);
+
+  if (!subscription.disabled)
+  {
+    subscription.filters.forEach(removeFilter);
+    flushElemHide();
+  }
+}
+
+function onSubscriptionDisabled(subscription, newValue)
+{
+  FilterListener.setDirty(1);
+
+  if (subscription.url in FilterStorage.knownSubscriptions)
+  {
+    if (newValue == false)
+      subscription.filters.forEach(addFilter);
+    else
+      subscription.filters.forEach(removeFilter);
+    flushElemHide();
+  }
+}
+
+function onSubscriptionUpdated(subscription)
+{
+  FilterListener.setDirty(1);
+
+  if (subscription.url in FilterStorage.knownSubscriptions &&
+      !subscription.disabled)
   {
     subscription.oldFilters.forEach(removeFilter);
     subscription.filters.forEach(addFilter);
-  }
-
-  flushElemHide();
-}
-
-/**
- * Filter change listener
- */
-function onFilterChange(action, filter, newValue, oldValue)
-{
-  if (action == "hitCount" && newValue == 0)
-  {
-    // Filter hits are being reset, make sure these changes are saved.
+    flushElemHide();
+  }
+}
+
+function onFilterHitCount(filter, newValue)
+{
+  if (newValue == 0)
     FilterListener.setDirty(0);
-  }
-  else if (action == "hitCount" || action == "lastHit")
+  else
     FilterListener.setDirty(0.002);
-  else
-    FilterListener.setDirty(1);
-
-  if (action != "added" && action != "removed" && action != "disabled")
-    return;
-
-  if ((action == "added" || action == "removed") && filter.disabled)
-  {
-    // Ignore adding/removing of disabled filters
-    return;
-  }
-
-  if (action == "added" || (action == "disabled" && newValue == false))
+}
+
+function onFilterLastHit()
+{
+  FilterListener.setDirty(0.002);
+}
+
+function onFilterAdded(filter)
+{
+  FilterListener.setDirty(1);
+
+  if (!filter.disabled)
+  {
+    addFilter(filter);
+    flushElemHide();
+  }
+}
+
+function onFilterRemoved(filter)
+{
+  FilterListener.setDirty(1);
+
+  if (!filter.disabled)
+  {
+    removeFilter(filter);
+    flushElemHide();
+  }
+}
+
+function onFilterDisabled(filter, newValue)
+{
+  FilterListener.setDirty(1);
+
+  if (newValue == false)
     addFilter(filter);
   else
     removeFilter(filter);
   flushElemHide();
 }
 
-/**
- * Generic notification listener
- */
-function onGenericChange(action)
-{
-  if (action == "load")
-  {
-    isDirty = 0;
-
-    defaultMatcher.clear();
-    ElemHide.clear();
-    CSSRules.clear();
-    for (let subscription of FilterStorage.subscriptions)
-      if (!subscription.disabled)
-        subscription.filters.forEach(addFilter);
-    flushElemHide();
-  }
-  else if (action == "save")
-    isDirty = 0;
-}
+function onGenericChange()
+{
+  FilterListener.setDirty(1);
+}
+
+function onLoad()
+{
+  isDirty = 0;
+
+  defaultMatcher.clear();
+  ElemHide.clear();
+  CSSRules.clear();
+  for (let subscription of FilterStorage.subscriptions)
+    if (!subscription.disabled)
+      subscription.filters.forEach(addFilter);
+  flushElemHide();
+}
+
+function onSave()
+{
+  isDirty = 0;
+}