Issue 394 - hit statistics tool data collection

lib/filterHits.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
+ * 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/>.
+ */
+
+let {Services} = Cu.import("resource://gre/modules/Services.jsm", null);
+let {FileUtils} = Cu.import("resource://gre/modules/FileUtils.jsm", null);
+
+let {Prefs} = require("prefs");
+let {Utils} = require("utils");
+let {MILLIS_IN_DAY} = require("downloader");
+let {FilterNotifier} = require("filterNotifier");
+let {DownloadableSubscription} = require("subscriptionClasses");
+
+/**
+ * This class reads filter hits statistics from SQLite database,
+ * manages them in memory and writes them back.
+ * @class
+ */
+let FilterHits = exports.FilterHits =
+{
+  /**
+   * Data that shoud be sent to the server
+   * @type Object
+   */
+  filters: Object.create(null),
+  

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

[saroyanm, 2015/04/07 15:23:09]

Done.

+  /**
+   * Time since last push
+   * @type Number
+   */
+  _lastPush: 0,
+
+  /**
+   * Indicates the timeframe between pushes
+   * @type Number
+   */
+  _pushInterval: MILLIS_IN_DAY * 7,

[kzar, 2015/03/23 13:11:05]

I set this to 60000 (number of milliseconds in one minute) and I found that the
data was not submitted once a minute. I kept it running for a couple of hours
and I got POST requests at these times:

[23/Mar/2015 11:09:56]
[23/Mar/2015 11:57:25]
[23/Mar/2015 12:09:56]

Any idea the post requests were not made once a minute as I expected?

[saroyanm, 2015/03/24 10:42:40]

Yes because we are saving the data to database and same time check whether we
need to send the data to server only after some amount of items are being
blocked, as you can see from filterListener.js current weight of filterHit is
set to 0.002, so we will call saveFilterHitsToDatabase method each time after
500 ads being blocked.

[kzar, 2015/03/24 10:51:14]

If the data submission interval is too variable it will effect the geometrical
mean calculations on the server. I suppose with larger values for _pushInterval
it wont be so much of a problem, what do you think Wladimir?

+
+  /**
+   * Indicates whether the data are being loaded from storage

[kzar, 2015/03/23 13:11:05]

Nit: These three comments should start with "Indicates whether the data is..."
instead of "Indicates whether the data are..."

[saroyanm, 2015/04/07 15:23:09]

Done.

+   * @type Boolean
+   */
+  _loading: false,
+
+  /**
+   * Indicates whether the data are being saved to storage
+   * @type Boolean
+   */
+  _saving: false,
+
+  /**
+   * Indicates whether the data are being sent to the server
+   * @type Boolean
+   */
+  _sending: false,
+
+  /**
+   * Increases the filter hit count
+   * @param {Filter} filter
+   * @param {Window} window  Window that the match originated in (required to get host)
+   */
+  increaseFilterHits: function(filter, wnd)
+  {
+    let subscriptions = filter.subscriptions;
+    let inDownloadableSubscription = false;
+    for (let i = 0; i < subscriptions.length; i++)
+    {
+      if (subscriptions[i] instanceof DownloadableSubscription)
+      {
+        inDownloadableSubscription = true;
+        break;
+      }
+    }
+
+    if (!inDownloadableSubscription)
+      return;
+
+    if (!(filter.text in this.filters))
+      this.filters[filter.text] = Object.create(null);
+
+    let statFilter = this.filters[filter.text];
+    let filterType = filter.thirdParty ? "thirdParty" : "firstParty";
+
+    if (!(filterType in statFilter))
+      statFilter[filterType] = Object.create(null);
+
+    if (!("subscriptions" in statFilter))
+      statFilter.subscriptions = [];
+
+    for (let i = 0; i < subscriptions.length; i++)
+    {
+      if (subscriptions[i] instanceof DownloadableSubscription
+          && statFilter.subscriptions.indexOf(subscriptions[i].url) == -1)
+        statFilter.subscriptions.push(subscriptions[i].url);
+    }
+
+    let wndLocation = Utils.getOriginWindow(wnd).location.href;
+    let host = Utils.unwrapURL(wndLocation).host;
+    

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

+    if (!(host in statFilter[filterType]))
+      statFilter[filterType][host] = {hits: 1, latest: filter.lastHit};
+    else
+    {
+      statFilter[filterType][host].hits++;
+      statFilter[filterType][host].latest = filter.lastHit;
+    }
+  },
+  

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

+  resetFilterHits: function()
+  {
+    this.filters = Object.create(null);
+    this.saveFilterHitsToDatabase();
+  },
+  

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

+  sendFilterHitsToServer: function()
+  {
+    if (!Prefs.sendstats)
+      return;
+
+    let request = new XMLHttpRequest();
+    request.open("POST", Prefs.sendstats_url);
+    request.setRequestHeader("Content-Type", "application/json");
+    request.addEventListener("load", function(event)
+    {
+      FilterHits._sending = false;
+      if (request.status == 200)
+      {
+        FilterHits._lastPush = new Date().getTime();
+        FilterHits.resetFilterHits();
+      }
+      else
+        Cu.reportError("Could not send filter hit statistics to Adblock Plus server.");
+    }, false);
+
+    let {addonName, addonVersion, application, applicationVersion, platform, platformVersion} = require("info");
+    let data = {
+      version: 1,
+      timeSincePush: this._lastPush,
+      addonName: addonName,
+      addonVersion: addonVersion,
+      application: application,
+      applicationVersion: applicationVersion,
+      platform: platform,
+      platformVersion: platformVersion,
+      filters: this.filters
+    };
+
+    this._sending = true;
+    request.send(JSON.stringify(data));
+  },
+  

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

+  getStorageFile: function()
+  {
+    return FileUtils.getFile("ProfD", ["adblockplus.sqlite"]);
+  },
+  

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

+  checkCreateTable: function(connection)
+  {
+    if (!connection.tableExists("filterhits"))
+      connection.executeSimpleSQL("CREATE TABLE filterhits (id INTEGER PRIMARY KEY, filters TEXT, date INTEGER)");
+  },
+  

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

+  /**
+   * Load Filter hits from database
+   */
+  loadFilterHitsFromDatabase: function()
+  {
+    let storageFile = this.getStorageFile();
+    if (!storageFile)
+      return;
+
+    let connection = Services.storage.openDatabase(storageFile);
+    this.checkCreateTable(connection);
+    

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

+    let statement = connection.createStatement("SELECT * FROM filterhits");
+    if (!this._loading)
+    {
+      this._loading = true;
+      statement.executeAsync(
+      {
+        handleResult: function(results)
+        {
+          let row = results.getNextRow();
+          if (row)
+          {
+            let filters = row.getResultByName("filters");
+            let lastDate = row.getResultByName("date");
+            FilterHits.filters = JSON.parse(filters);
+            FilterHits._lastPush = lastDate;
+          }
+        },
+      

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

+        handleError: function(error)
+        {
+          Cu.reportError(error.message);
+        },
+      

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

+        handleCompletion: function(reason)
+        {
+          if (reason != Ci.mozIStorageStatementCallback.REASON_FINISHED)
+            Cu.reportError("Loading of filter hits canceled or aborted.");
+          FilterHits._loading = false;
+        }
+      });
+    }
+    

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

+    connection.asyncClose();
+  },
+  

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

+  /**
+   * Save Filter hits to database
+   */
+  saveFilterHitsToDatabase: function()
+  {
+    let now = new Date().getTime();
+    if (!this._lastPush)
+      this._lastPush = now;
+    

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

+    if (!this._sending && now - this._lastPush > this._pushInterval)
+    {
+      this.sendFilterHitsToServer();
+      return;
+    }
+
+    let storageFile = this.getStorageFile();
+    if (!storageFile)
+      return;
+
+    let connection = Services.storage.openDatabase(storageFile);
+    this.checkCreateTable(connection);
+    

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

+    let statement = connection.createStatement("INSERT OR REPLACE INTO filterhits (id, filters, date) VALUES(0, :filters, :date)");
+    statement.params.filters = JSON.stringify(this.filters);
+    statement.params.date = this._lastPush;
+    if (!this._saving)
+    {
+      this._saving = true;
+      statement.executeAsync(
+      {
+        handleError: function(aError)
+        {
+          Cu.reportError(aError.message);
+        },
+      

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

+        handleCompletion: function(aReason) 

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

+        {
+          if (aReason != Components.interfaces.mozIStorageStatementCallback.REASON_FINISHED)
+            Cu.reportError("Writing of filter hits canceled or aborted.");
+          FilterHits._saving = false;
+        }
+      });
+    }
+    

[kzar, 2015/03/23 13:11:05]

Nit: Trailing whitespace

+    connection.asyncClose();
+  }
+};
+
+FilterNotifier.addListener(function(action)
+{
+  if (action == "load" && Prefs.sendstats)
+    FilterHits.loadFilterHitsFromDatabase();
+});