Issue 394 - hit statistics tool data collection

lib/filterStorage.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 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 11 matching lines @@
 Cu.import("resource://gre/modules/Services.jsm");
 Cu.import("resource://gre/modules/FileUtils.jsm");
 Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 
 let {IO} = require("io");
 let {Prefs} = require("prefs");
 let {Filter, ActiveFilter} = require("filterClasses");
 let {Subscription, SpecialSubscription, ExternalSubscription} = require("subscriptionClasses");
 let {FilterNotifier} = require("filterNotifier");
 let {Utils} = require("utils");
+let {FilterHits} = require("filterHits");
 
 /**
  * Version number of the filter storage file format.
  * @type Integer
  */
 let formatVersion = 4;
 
 /**
  * This class reads user's filters from disk, manages them in memory and writes them back.
  * @class
@@ skipping 286 matching lines @@
    */
   increaseHitCount: function(filter, wnd)
   {
     if (!Prefs.savestats || PrivateBrowsing.enabledForWindow(wnd) ||
         PrivateBrowsing.enabled || !(filter instanceof ActiveFilter))
     {
       return;
     }
 
     filter.hitCount++;
     filter.lastHit = Date.now();

[saroyanm, 2015/02/17 17:05:51]

@Dave here is where we are setting the lastHit for the filterObject and we use
same value for filters hit calculation. 
According to ->
http://people.mozilla.org/~jorendorff/es6-draft.html#sec-date.now 
Date.now(); should return UTC time. 
So I guess we are Okey here.

+    if (Prefs.sendstats)
+      FilterHits.increaseFilterHits(filter, wnd);    

[Thomas Greiner, 2015/02/23 18:43:05]

`FilterNotifier` allows you to listen to the "filter.hitCount" event which is
fired whenever `filter.lastHit` changes. That means that the filter hits can be
increased from within the `FilterHits` module itself.

[saroyanm, 2015/02/28 15:24:30]

I also need the window object where the match has been occurred so I can get the
Domain and we are not passing the window of the occurrence to trigger function
as one of the param with current filterClasses implementation.

[Thomas Greiner, 2015/03/06 11:29:19]

Ah, right. We also cannot add it to the `FilterNotifier.triggerListeners` call
because that one also doesn't have access to the Window. Unfortunately, seems
like we need to do it like this then.

   },
 
   /**
    * Resets hit count for some filters
    * @param {Array of Filter} filters  filters to be reset, if null all filters will be reset
    */
   resetHitCounts: function(filters)
   {
     if (!filters)
     {
@@ skipping 87 matching lines @@
           let filter = Filter.fromText(parser.userFilters[i]);
           this.addFilter(filter, null, undefined, true);
         }
       }
 
       this._loading = false;
       FilterNotifier.triggerListeners("load");
 
       if (sourceFile != this.sourceFile)
         this.saveToDisk();
-
+      
+      if (Prefs.sendstats)
+        FilterHits.loadFilterHitsFromDatabase();

[Thomas Greiner, 2015/02/23 18:43:05]

`FilterNotifier` allows you to listen to the "load" event which is fired
whenever filters were loaded into memory. That means that the loading of filter
hits can be triggered from within the `FilterHits` module itself.

[saroyanm, 2015/02/28 15:24:30]

Good point, done.

     }.bind(this);
 
     let explicitFile;
     if (sourceFile)
     {
       explicitFile = true;
       readFile(sourceFile, 0);
     }
     else
     {
@@ skipping 406 matching lines @@
       Subscription.knownSubscriptions = origKnownSubscriptions;
     }
 
     // Allow events to be processed every now and then.
     // Note: IO.readFromFile() will deal with the potential reentrance here.
     this.linesProcessed++;
     if (this.linesProcessed % 1000 == 0)
       Utils.yield();
   }
 };