/* This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/**

 * This file contains metrics data providers for the Firefox Health

 * Report. Ideally each provider in this file exists in separate modules

 * and lives close to the code it is querying. However, because of the

 * overhead of JS compartments (which are created for each module), we

 * currently have all the code in one file. When the overhead of

 * compartments reaches a reasonable level, this file should be split

 * up.

 */

#ifndef MERGED_COMPARTMENT

"use strict";

this.EXPORTED_SYMBOLS = [

  "AddonsProvider",

  "AppInfoProvider",

#ifdef MOZ_CRASHREPORTER

  "CrashesProvider",

#endif

  "HealthReportProvider",

  "HotfixProvider",

  "PlacesProvider",

  "SearchesProvider",

  "SessionsProvider",

  "SysInfoProvider",

];

const {classes: Cc, interfaces: Ci, utils: Cu} = Components;

Cu.import("resource://gre/modules/Metrics.jsm");

#endif

Cu.import("resource://gre/modules/Promise.jsm");

Cu.import("resource://gre/modules/osfile.jsm");

Cu.import("resource://gre/modules/Preferences.jsm");

Cu.import("resource://gre/modules/Services.jsm");

Cu.import("resource://gre/modules/Task.jsm");

Cu.import("resource://gre/modules/XPCOMUtils.jsm");

Cu.import("resource://services-common/utils.js");

XPCOMUtils.defineLazyModuleGetter(this, "AddonManager",

                                  "resource://gre/modules/AddonManager.jsm");

XPCOMUtils.defineLazyModuleGetter(this, "UpdateChannel",

                                  "resource://gre/modules/UpdateChannel.jsm");

XPCOMUtils.defineLazyModuleGetter(this, "PlacesDBUtils",

                                  "resource://gre/modules/PlacesDBUtils.jsm");

const LAST_NUMERIC_FIELD = {type: Metrics.Storage.FIELD_LAST_NUMERIC};

const LAST_TEXT_FIELD = {type: Metrics.Storage.FIELD_LAST_TEXT};

const DAILY_DISCRETE_NUMERIC_FIELD = {type: Metrics.Storage.FIELD_DAILY_DISCRETE_NUMERIC};

const DAILY_LAST_NUMERIC_FIELD = {type: Metrics.Storage.FIELD_DAILY_LAST_NUMERIC};

const DAILY_LAST_TEXT_FIELD = {type: Metrics.Storage.FIELD_DAILY_LAST_TEXT};

const DAILY_COUNTER_FIELD = {type: Metrics.Storage.FIELD_DAILY_COUNTER};

const TELEMETRY_PREF = "toolkit.telemetry.enabled";

function isTelemetryEnabled(prefs) {

  return prefs.get(TELEMETRY_PREF, false);

}

/**

 * Represents basic application state.

 *

 * This is roughly a union of nsIXULAppInfo, nsIXULRuntime, with a few extra

 * pieces thrown in.

 */

function AppInfoMeasurement() {

  Metrics.Measurement.call(this);

}

AppInfoMeasurement.prototype = Object.freeze({

  __proto__: Metrics.Measurement.prototype,

  name: "appinfo",

  version: 2,

  fields: {

    vendor: LAST_TEXT_FIELD,

    name: LAST_TEXT_FIELD,

    id: LAST_TEXT_FIELD,

    version: LAST_TEXT_FIELD,

    appBuildID: LAST_TEXT_FIELD,

    platformVersion: LAST_TEXT_FIELD,

    platformBuildID: LAST_TEXT_FIELD,

    os: LAST_TEXT_FIELD,

    xpcomabi: LAST_TEXT_FIELD,

    updateChannel: LAST_TEXT_FIELD,

    distributionID: LAST_TEXT_FIELD,

    distributionVersion: LAST_TEXT_FIELD,

    hotfixVersion: LAST_TEXT_FIELD,

    locale: LAST_TEXT_FIELD,

    isDefaultBrowser: {type: Metrics.Storage.FIELD_DAILY_LAST_NUMERIC},

    isTelemetryEnabled: {type: Metrics.Storage.FIELD_DAILY_LAST_NUMERIC},

    isBlocklistEnabled: {type: Metrics.Storage.FIELD_DAILY_LAST_NUMERIC},

  },

});

/**

 * Legacy version of app info before Telemetry was added.

 *

 * The "last" fields have all been removed. We only report the longitudinal

 * field.

 */

function AppInfoMeasurement1() {

  Metrics.Measurement.call(this);

}

AppInfoMeasurement1.prototype = Object.freeze({

  __proto__: Metrics.Measurement.prototype,

  name: "appinfo",

  version: 1,

  fields: {

    isDefaultBrowser: {type: Metrics.Storage.FIELD_DAILY_LAST_NUMERIC},

  },

});

function AppVersionMeasurement1() {

  Metrics.Measurement.call(this);

}

AppVersionMeasurement1.prototype = Object.freeze({

  __proto__: Metrics.Measurement.prototype,

  name: "versions",

  version: 1,

  fields: {

    version: {type: Metrics.Storage.FIELD_DAILY_DISCRETE_TEXT},

  },

});

// Version 2 added the build ID.

function AppVersionMeasurement2() {

  Metrics.Measurement.call(this);

}

AppVersionMeasurement2.prototype = Object.freeze({

  __proto__: Metrics.Measurement.prototype,

  name: "versions",

  version: 2,

  fields: {

    appVersion: {type: Metrics.Storage.FIELD_DAILY_DISCRETE_TEXT},

    platformVersion: {type: Metrics.Storage.FIELD_DAILY_DISCRETE_TEXT},

    appBuildID: {type: Metrics.Storage.FIELD_DAILY_DISCRETE_TEXT},

    platformBuildID: {type: Metrics.Storage.FIELD_DAILY_DISCRETE_TEXT},

  },

});

/**

 * Holds data on the application update functionality.

 */

function AppUpdateMeasurement1() {

  Metrics.Measurement.call(this);

}

AppUpdateMeasurement1.prototype = Object.freeze({

  __proto__: Metrics.Measurement.prototype,

  name: "update",

  version: 1,

  fields: {

    enabled: {type: Metrics.Storage.FIELD_DAILY_LAST_NUMERIC},

    autoDownload: {type: Metrics.Storage.FIELD_DAILY_LAST_NUMERIC},

  },

});

this.AppInfoProvider = function AppInfoProvider() {

  Metrics.Provider.call(this);

  this._prefs = new Preferences({defaultBranch: null});

}

AppInfoProvider.prototype = Object.freeze({

  __proto__: Metrics.Provider.prototype,

  name: "org.mozilla.appInfo",

  measurementTypes: [

    AppInfoMeasurement,

    AppInfoMeasurement1,

    AppUpdateMeasurement1,

    AppVersionMeasurement1,

    AppVersionMeasurement2,

  ],

  pullOnly: true,

  appInfoFields: {

    // From nsIXULAppInfo.

    vendor: "vendor",

    name: "name",

    id: "ID",

    version: "version",

    appBuildID: "appBuildID",

    platformVersion: "platformVersion",

    platformBuildID: "platformBuildID",

    // From nsIXULRuntime.

    os: "OS",

    xpcomabi: "XPCOMABI",

  },

  postInit: function () {

    return Task.spawn(this._postInit.bind(this));

  },

  _postInit: function () {

    let recordEmptyAppInfo = function () {

      this._setCurrentAppVersion("");

      this._setCurrentPlatformVersion("");

      this._setCurrentAppBuildID("");

      return this._setCurrentPlatformBuildID("");

    }.bind(this);

    // Services.appInfo should always be defined for any reasonably behaving

    // Gecko app. If it isn't, we insert a empty string sentinel value.

    let ai;

    try {

      ai = Services.appinfo;

    } catch (ex) {

      this._log.error("Could not obtain Services.appinfo: " +

                     CommonUtils.exceptionStr(ex));

      yield recordEmptyAppInfo();

      return;

    }

    if (!ai) {

      this._log.error("Services.appinfo is unavailable.");

      yield recordEmptyAppInfo();

      return;

    }

    let currentAppVersion = ai.version;

    let currentPlatformVersion = ai.platformVersion;

    let currentAppBuildID = ai.appBuildID;

    let currentPlatformBuildID = ai.platformBuildID;

    // State's name doesn't contain "app" for historical compatibility.

    let lastAppVersion = yield this.getState("lastVersion");

    let lastPlatformVersion = yield this.getState("lastPlatformVersion");

    let lastAppBuildID = yield this.getState("lastAppBuildID");

    let lastPlatformBuildID = yield this.getState("lastPlatformBuildID");

    if (currentAppVersion != lastAppVersion) {

      yield this._setCurrentAppVersion(currentAppVersion);

    }

    if (currentPlatformVersion != lastPlatformVersion) {

      yield this._setCurrentPlatformVersion(currentPlatformVersion);

    }

    if (currentAppBuildID != lastAppBuildID) {

      yield this._setCurrentAppBuildID(currentAppBuildID);

    }

    if (currentPlatformBuildID != lastPlatformBuildID) {

      yield this._setCurrentPlatformBuildID(currentPlatformBuildID);

    }

  },

  _setCurrentAppVersion: function (version) {

    this._log.info("Recording new application version: " + version);

    let m = this.getMeasurement("versions", 2);

    m.addDailyDiscreteText("appVersion", version);

    // "app" not encoded in key for historical compatibility.

    return this.setState("lastVersion", version);

  },

  _setCurrentPlatformVersion: function (version) {

    this._log.info("Recording new platform version: " + version);

    let m = this.getMeasurement("versions", 2);

    m.addDailyDiscreteText("platformVersion", version);

    return this.setState("lastPlatformVersion", version);

  },

  _setCurrentAppBuildID: function (build) {

    this._log.info("Recording new application build ID: " + build);

    let m = this.getMeasurement("versions", 2);

    m.addDailyDiscreteText("appBuildID", build);

    return this.setState("lastAppBuildID", build);

  },

  _setCurrentPlatformBuildID: function (build) {

    this._log.info("Recording new platform build ID: " + build);

    let m = this.getMeasurement("versions", 2);

    m.addDailyDiscreteText("platformBuildID", build);

    return this.setState("lastPlatformBuildID", build);

  },

  collectConstantData: function () {

    return this.storage.enqueueTransaction(this._populateConstants.bind(this));

  },

  _populateConstants: function () {

    let m = this.getMeasurement(AppInfoMeasurement.prototype.name,

                                AppInfoMeasurement.prototype.version);

    let ai;

    try {

      ai = Services.appinfo;

    } catch (ex) {

      this._log.warn("Could not obtain Services.appinfo: " +

                     CommonUtils.exceptionStr(ex));

      throw ex;

    }

    if (!ai) {

      this._log.warn("Services.appinfo is unavailable.");

      throw ex;

    }

    for (let [k, v] in Iterator(this.appInfoFields)) {

      try {

        yield m.setLastText(k, ai[v]);

      } catch (ex) {

        this._log.warn("Error obtaining Services.appinfo." + v);

      }

    }

    try {

      yield m.setLastText("updateChannel", UpdateChannel.get());

    } catch (ex) {

      this._log.warn("Could not obtain update channel: " +

                     CommonUtils.exceptionStr(ex));

    }

    yield m.setLastText("distributionID", this._prefs.get("distribution.id", ""));

    yield m.setLastText("distributionVersion", this._prefs.get("distribution.version", ""));

    yield m.setLastText("hotfixVersion", this._prefs.get("extensions.hotfix.lastVersion", ""));

    try {

      let locale = Cc["@mozilla.org/chrome/chrome-registry;1"]

                     .getService(Ci.nsIXULChromeRegistry)

                     .getSelectedLocale("global");

      yield m.setLastText("locale", locale);

    } catch (ex) {

      this._log.warn("Could not obtain application locale: " +

                     CommonUtils.exceptionStr(ex));

    }

    // FUTURE this should be retrieved periodically or at upload time.

    yield this._recordIsTelemetryEnabled(m);

    yield this._recordIsBlocklistEnabled(m);

    yield this._recordDefaultBrowser(m);

  },

  _recordIsTelemetryEnabled: function (m) {

    let enabled = isTelemetryEnabled(this._prefs);

    this._log.debug("Recording telemetry enabled (" + TELEMETRY_PREF + "): " + enabled);

    yield m.setDailyLastNumeric("isTelemetryEnabled", enabled ? 1 : 0);

  },

  _recordIsBlocklistEnabled: function (m) {

    let enabled = this._prefs.get("extensions.blocklist.enabled", false);

    this._log.debug("Recording blocklist enabled: " + enabled);

    yield m.setDailyLastNumeric("isBlocklistEnabled", enabled ? 1 : 0);

  },

  _recordDefaultBrowser: function (m) {