1 files changed, 297 insertions, 0 deletions
diff --git a/toolkit/components/resistfingerprinting/nsUserCharacteristics.cpp b/toolkit/components/resistfingerprinting/nsUserCharacteristics.cpp
new file mode 100644
index 0000000000..9bce616f81
--- /dev/null
+++ b/toolkit/components/resistfingerprinting/nsUserCharacteristics.cpp
@@ -0,0 +1,297 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* 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/. */
+
+#include "nsUserCharacteristics.h"
+
+#include "nsID.h"
+#include "nsIUUIDGenerator.h"
+#include "nsServiceManagerUtils.h"
+
+#include "mozilla/Logging.h"
+#include "mozilla/glean/GleanPings.h"
+#include "mozilla/glean/GleanMetrics.h"
+
+#include "mozilla/StaticPrefs_media.h"
+
+#include "mozilla/LookAndFeel.h"
+#include "mozilla/PreferenceSheet.h"
+#include "mozilla/RelativeLuminanceUtils.h"
+#include "mozilla/ServoStyleConsts.h"
+#include "mozilla/dom/ScreenBinding.h"
+#include "mozilla/intl/TimeZone.h"
+#include "mozilla/widget/ScreenManager.h"
+
+#include "gfxPlatformFontList.h"
+#include "prsystem.h"
+#if defined(XP_WIN)
+#  include "WinUtils.h"
+#elif defined(MOZ_WIDGET_ANDROID)
+#  include "mozilla/java/GeckoAppShellWrappers.h"
+#elif defined(XP_MACOSX)
+#  include "nsMacUtilsImpl.h"
+#endif
+
+static mozilla::LazyLogModule gUserCharacteristicsLog("UserCharacteristics");
+
+// ==================================================================
+namespace testing {
+extern "C" {
+
+int MaxTouchPoints() {
+#if defined(XP_WIN)
+  return mozilla::widget::WinUtils::GetMaxTouchPoints();
+#elif defined(MOZ_WIDGET_ANDROID)
+  return mozilla::java::GeckoAppShell::GetMaxTouchPoints();
+#else
+  return 0;
+#endif
+}
+
+}  // extern "C"
+};  // namespace testing
+
+// ==================================================================
+void PopulateCSSProperties() {
+  mozilla::glean::characteristics::video_dynamic_range.Set(
+      mozilla::LookAndFeel::GetInt(
+          mozilla::LookAndFeel::IntID::VideoDynamicRange));
+  mozilla::glean::characteristics::prefers_reduced_transparency.Set(
+      mozilla::LookAndFeel::GetInt(
+          mozilla::LookAndFeel::IntID::PrefersReducedTransparency));
+  mozilla::glean::characteristics::prefers_reduced_motion.Set(
+      mozilla::LookAndFeel::GetInt(
+          mozilla::LookAndFeel::IntID::PrefersReducedMotion));
+  mozilla::glean::characteristics::inverted_colors.Set(
+      mozilla::LookAndFeel::GetInt(
+          mozilla::LookAndFeel::IntID::InvertedColors));
+  mozilla::glean::characteristics::color_scheme.Set(
+      (int)mozilla::PreferenceSheet::ContentPrefs().mColorScheme);
+
+  mozilla::StylePrefersContrast prefersContrast = [] {
+    // Replicates Gecko_MediaFeatures_PrefersContrast but without a Document
+    if (!mozilla::PreferenceSheet::ContentPrefs().mUseAccessibilityTheme &&
+        mozilla::PreferenceSheet::ContentPrefs().mUseDocumentColors) {
+      return mozilla::StylePrefersContrast::NoPreference;
+    }
+
+    const auto& colors = mozilla::PreferenceSheet::ContentPrefs().ColorsFor(
+        mozilla::ColorScheme::Light);
+    float ratio = mozilla::RelativeLuminanceUtils::ContrastRatio(
+        colors.mDefaultBackground, colors.mDefault);
+    // https://www.w3.org/TR/WCAG21/#contrast-minimum
+    if (ratio < 4.5f) {
+      return mozilla::StylePrefersContrast::Less;
+    }
+    // https://www.w3.org/TR/WCAG21/#contrast-enhanced
+    if (ratio >= 7.0f) {
+      return mozilla::StylePrefersContrast::More;
+    }
+    return mozilla::StylePrefersContrast::Custom;
+  }();
+  mozilla::glean::characteristics::prefers_contrast.Set((int)prefersContrast);
+}
+
+void PopulateScreenProperties() {
+  auto& screenManager = mozilla::widget::ScreenManager::GetSingleton();
+  RefPtr<mozilla::widget::Screen> screen = screenManager.GetPrimaryScreen();
+  MOZ_ASSERT(screen);
+
+  mozilla::dom::ScreenColorGamut colorGamut;
+  screen->GetColorGamut(&colorGamut);
+  mozilla::glean::characteristics::color_gamut.Set((int)colorGamut);
+
+  int32_t colorDepth;
+  screen->GetColorDepth(&colorDepth);
+  mozilla::glean::characteristics::color_depth.Set(colorDepth);
+
+  mozilla::glean::characteristics::color_gamut.Set((int)colorGamut);
+  mozilla::glean::characteristics::color_depth.Set(colorDepth);
+  const mozilla::LayoutDeviceIntRect rect = screen->GetRect();
+  mozilla::glean::characteristics::screen_height.Set(rect.Height());
+  mozilla::glean::characteristics::screen_width.Set(rect.Width());
+}
+
+void PopulateMissingFonts() {
+  nsCString aMissingFonts;
+  gfxPlatformFontList::PlatformFontList()->GetMissingFonts(aMissingFonts);
+
+  mozilla::glean::characteristics::missing_fonts.Set(aMissingFonts);
+}
+
+void PopulatePrefs() {
+  nsAutoCString acceptLang;
+  mozilla::Preferences::GetLocalizedCString("intl.accept_languages",
+                                            acceptLang);
+  mozilla::glean::characteristics::prefs_intl_accept_languages.Set(acceptLang);
+
+  mozilla::glean::characteristics::prefs_media_eme_enabled.Set(
+      mozilla::StaticPrefs::media_eme_enabled());
+
+  mozilla::glean::characteristics::prefs_zoom_text_only.Set(
+      !mozilla::Preferences::GetBool("browser.zoom.full"));
+}
+
+// ==================================================================
+// The current schema of the data. Anytime you add a metric, or change how a
+// metric is set, this variable should be incremented. It'll be a lot. It's
+// okay. We're going to need it to know (including during development) what is
+// the source of the data we are looking at.
+const int kSubmissionSchema = 0;
+
+/* static */
+void nsUserCharacteristics::MaybeSubmitPing() {
+  MOZ_LOG(gUserCharacteristicsLog, mozilla::LogLevel::Debug,
+          ("In MaybeSubmitPing()"));
+  MOZ_ASSERT(XRE_IsParentProcess());
+
+  /**
+   * There are two preferences at play here:
+   *  - Last Version Sent - preference containing the last version sent by the
+   * user to Mozilla
+   *  - Current Version - preference containing the version Mozilla would like
+   * the user to send
+   *
+   * A point of complexity arises in that these two values _may_ be changed
+   * by the user, even though neither is intended to be.
+   *
+   * When Current Version > Last Version Sent, we intend for the user to submit
+   * a new ping, which will include the schema version. Then update Last Version
+   * Sent = Current Version.
+   *
+   */
+  const auto* const kLastVersionPref =
+      "toolkit.telemetry.user_characteristics_ping.last_version_sent";
+  const auto* const kCurrentVersionPref =
+      "toolkit.telemetry.user_characteristics_ping.current_version";
+
+  auto lastSubmissionVersion =
+      mozilla::Preferences::GetInt(kLastVersionPref, 0);
+  auto currentVersion = mozilla::Preferences::GetInt(kCurrentVersionPref, 0);
+
+  MOZ_ASSERT(currentVersion == -1 || lastSubmissionVersion <= currentVersion,
+             "lastSubmissionVersion is somehow greater than currentVersion "
+             "- did you edit prefs improperly?");
+
+  if (lastSubmissionVersion < 0) {
+    // This is a way for users to opt out of this ping specifically.
+    MOZ_LOG(gUserCharacteristicsLog, mozilla::LogLevel::Debug,
+            ("Returning, User Opt-out"));
+    return;
+  }
+  if (currentVersion == 0) {
+    // Do nothing. We do not want any pings.
+    MOZ_LOG(gUserCharacteristicsLog, mozilla::LogLevel::Debug,
+            ("Returning, currentVersion == 0"));
+    return;
+  }
+  if (currentVersion == -1) {
+    // currentVersion = -1 is a development value to force a ping submission
+    MOZ_LOG(gUserCharacteristicsLog, mozilla::LogLevel::Debug,
+            ("Force-Submitting Ping"));
+    if (NS_SUCCEEDED(PopulateData())) {
+      SubmitPing();
+    }
+    return;
+  }
+  if (lastSubmissionVersion > currentVersion) {
+    // This is an unexpected scneario that indicates something is wrong. We
+    // asserted against it (in debug, above) We will try to sanity-correct
+    // ourselves by setting it to the current version.
+    mozilla::Preferences::SetInt(kLastVersionPref, currentVersion);
+    MOZ_LOG(gUserCharacteristicsLog, mozilla::LogLevel::Warning,
+            ("Returning, lastSubmissionVersion > currentVersion"));
+    return;
+  }
+  if (lastSubmissionVersion == currentVersion) {
+    // We are okay, we've already submitted the most recent ping
+    MOZ_LOG(gUserCharacteristicsLog, mozilla::LogLevel::Warning,
+            ("Returning, lastSubmissionVersion == currentVersion"));
+    return;
+  }
+  if (lastSubmissionVersion < currentVersion) {
+    if (NS_SUCCEEDED(PopulateData())) {
+      if (NS_SUCCEEDED(SubmitPing())) {
+        mozilla::Preferences::SetInt(kLastVersionPref, currentVersion);
+      }
+    }
+  } else {
+    MOZ_ASSERT_UNREACHABLE("Should never reach here");
+  }
+}
+
+const auto* const kUUIDPref =
+    "toolkit.telemetry.user_characteristics_ping.uuid";
+
+/* static */
+nsresult nsUserCharacteristics::PopulateData(bool aTesting /* = false */) {
+  MOZ_LOG(gUserCharacteristicsLog, mozilla::LogLevel::Warning,
+          ("Populating Data"));
+  MOZ_ASSERT(XRE_IsParentProcess());
+  mozilla::glean::characteristics::submission_schema.Set(kSubmissionSchema);
+
+  nsAutoCString uuidString;
+  nsresult rv = mozilla::Preferences::GetCString(kUUIDPref, uuidString);
+  if (NS_FAILED(rv) || uuidString.Length() == 0) {
+    nsCOMPtr<nsIUUIDGenerator> uuidgen =
+        do_GetService("@mozilla.org/uuid-generator;1", &rv);
+    NS_ENSURE_SUCCESS(rv, rv);
+
+    nsIDToCString id(nsID::GenerateUUID());
+    uuidString = id.get();
+    mozilla::Preferences::SetCString(kUUIDPref, uuidString);
+  }
+  mozilla::glean::characteristics::client_identifier.Set(uuidString);
+
+  mozilla::glean::characteristics::max_touch_points.Set(
+      testing::MaxTouchPoints());
+
+  if (aTesting) {
+    // Many of the later peices of data do not work in a gtest
+    // so just populate something, and return
+    return NS_OK;
+  }
+
+  PopulateMissingFonts();
+  PopulateCSSProperties();
+  PopulateScreenProperties();
+  PopulatePrefs();
+
+  mozilla::glean::characteristics::target_frame_rate.Set(
+      gfxPlatform::TargetFrameRate());
+
+  int32_t processorCount = 0;
+#if defined(XP_MACOSX)
+  if (nsMacUtilsImpl::IsTCSMAvailable()) {
+    // On failure, zero is returned from GetPhysicalCPUCount()
+    // and we fallback to PR_GetNumberOfProcessors below.
+    processorCount = nsMacUtilsImpl::GetPhysicalCPUCount();
+  }
+#endif
+  if (processorCount == 0) {
+    processorCount = PR_GetNumberOfProcessors();
+  }
+  mozilla::glean::characteristics::processor_count.Set(processorCount);
+
+  AutoTArray<char16_t, 128> tzBuffer;
+  auto result = mozilla::intl::TimeZone::GetDefaultTimeZone(tzBuffer);
+  if (result.isOk()) {
+    NS_ConvertUTF16toUTF8 timeZone(
+        nsDependentString(tzBuffer.Elements(), tzBuffer.Length()));
+    mozilla::glean::characteristics::timezone.Set(timeZone);
+  } else {
+    mozilla::glean::characteristics::timezone.Set("<error>"_ns);
+  }
+
+  return NS_OK;
+}
+
+/* static */
+nsresult nsUserCharacteristics::SubmitPing() {
+  MOZ_LOG(gUserCharacteristicsLog, mozilla::LogLevel::Warning,
+          ("Submitting Ping"));
+  mozilla::glean_pings::UserCharacteristics.Submit();
+
+  return NS_OK;
+}