Issue 394 - hit statistics tool data collection (core)

lib/downloader.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
@@ skipping 13 matching lines @@
 let MILLIS_IN_SECOND = exports.MILLIS_IN_SECOND = 1000;
 let MILLIS_IN_MINUTE = exports.MILLIS_IN_MINUTE = 60 * MILLIS_IN_SECOND;
 let MILLIS_IN_HOUR = exports.MILLIS_IN_HOUR = 60 * MILLIS_IN_MINUTE;
 let MILLIS_IN_DAY = exports.MILLIS_IN_DAY = 24 * MILLIS_IN_HOUR;
 
 /**
  * Creates a new downloader instance.
  * @param {Function} dataSource  Function that will yield downloadable objects on each check
  * @param {Integer} initialDelay  Number of milliseconds to wait before the first check
  * @param {Integer} checkInterval  Interval between the checks
+ * @param {function} downloadCallback optional function that's being called when something needs to be downloaded
  * @constructor
  */
-let Downloader = exports.Downloader = function Downloader(dataSource, initialDelay, checkInterval)
+let Downloader = exports.Downloader = function Downloader(dataSource, initialDelay, checkInterval, downloadCallback)
 {
   this.dataSource = dataSource;
+  this.downloadCallback = downloadCallback || this._download;
   this._timer = Cc["@mozilla.org/timer;1"].createInstance(Ci.nsITimer);
   this._timer.initWithCallback(function()
   {
     this._timer.delay = checkInterval;
     this._doCheck();
   }.bind(this), initialDelay, Ci.nsITimer.TYPE_REPEATING_SLACK);
   this._downloading = Object.create(null);
 }
 Downloader.prototype =
 {
   /**
    * Timer triggering the downloads.
    * @type nsITimer
    */
   _timer: null,
 
   /**
    * Map containing the URLs of objects currently being downloaded as its keys.
    */
   _downloading: null,
 
   /**
    * Function that will yield downloadable objects on each check.
    * @type Function
    */
   dataSource: null,
 
   /**
+   * Function that's being called when something needs to be downloaded.
+   * @type Function
+   */
+  downloadCallback: null,
+
+  /**
    * Maximal time interval that the checks can be left out until the soft
    * expiration interval increases.
    * @type Integer
    */
   maxAbsenceInterval: 1 * MILLIS_IN_DAY,
 
   /**
    * Minimal time interval before retrying a download after an error.
    * @type Integer
    */
@@ skipping 66 matching lines @@
         this.onExpirationChange(downloadable);
 
       // Does that object need downloading?
       if (downloadable.softExpiration > now && downloadable.hardExpiration > now)
         continue;
 
       // Do not retry downloads too often
       if (downloadable.lastError && now - downloadable.lastError < this.minRetryInterval)
         continue;
 
-      this._download(downloadable, 0);
+      this.downloadCallback(downloadable, 0);
     }
   },
 
   /**
    * Stops the periodic checks.
    */
   cancel: function()
   {
     this._timer.cancel();
   },
@@ skipping 221 matching lines @@
    * @type Integer
    */
   hardExpiration: 0,
   
   /**
    * Number indicating how often the object was downloaded.
    * @type Integer
    */
   downloadCount: 0,
 };