toolkit/components/antitracking/imageinputmetadatastripper/ImageInputTelemetry.cpp

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   5  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "ImageInputTelemetry.h"
   8
   9 #include "mozilla/ContentEvents.h"
  10 #include "mozilla/MouseEvents.h"
  11 #include "mozilla/dom/Blob.h"
  12 #include "mozilla/dom/DataTransfer.h"
  13 #include "mozilla/dom/FileList.h"
  14 #include "mozilla/glean/AntitrackingImageinputmetadatastripperMetrics.h"
  15 #include "nsIPrincipal.h"
  16
  17 namespace mozilla {
  18
  19 // Known MIME types as listed in nsMimeTypes.h + HEIC types
  20 static constexpr nsLiteralCString kKnownImageMIMETypes[] = {
  21     "image/gif"_ns,
  22     "image/jpeg"_ns,
  23     "image/jpg"_ns,
  24     "image/pjpeg"_ns,
  25     "image/png"_ns,
  26     "image/apng"_ns,
  27     "image/x-png"_ns,
  28     "image/x-portable-pixmap"_ns,
  29     "image/x-xbitmap"_ns,
  30     "image/x-xbm"_ns,
  31     "image/xbm"_ns,
  32     "image/x-jg"_ns,
  33     "image/tiff"_ns,
  34     "image/bmp"_ns,
  35     "image/x-ms-bmp"_ns,
  36     "image/x-ms-clipboard-bmp"_ns,
  37     "image/x-icon"_ns,
  38     "image/vnd.microsoft.icon"_ns,
  39     "image/icon"_ns,  // "video/x-mng"_ns, - This is checked in
  40                       // ImageInputTelemetry::IsKnownImageMIMEType()
  41     "image/x-jng"_ns,
  42     "image/svg+xml"_ns,
  43     "image/webp"_ns,
  44     "image/avif"_ns,
  45     "image/jxl"_ns,
  46     // Additionally added HEIC image formats due to mobile popularity
  47     "image/heic"_ns,
  48     "image/heif"_ns,
  49 };
  50
  51 /* private static */ bool ImageInputTelemetry::IsKnownImageMIMEType(
  52     const nsCString& aInputFileType) {
  53   if (aInputFileType.Find("video/x-mng"_ns) != kNotFound) {
  54     return true;
  55   }
  56   if (aInputFileType.Find("image/"_ns) != kNotFound) {
  57     for (const nsCString& knownImageMIMEType : kKnownImageMIMETypes) {
  58       if (aInputFileType.Equals(knownImageMIMEType)) {
  59         return true;
  60       }
  61     }
  62   }
  63   return false;
  64 }
  65
  66 /* private static */ bool ImageInputTelemetry::IsContentPrincipal(
  67     nsIPrincipal* aContentPrincipal) {
  68   bool isSystemPrincipal;
  69   aContentPrincipal->GetIsSystemPrincipal(&isSystemPrincipal);
  70   return !(isSystemPrincipal || aContentPrincipal->SchemeIs("about"));
  71 }
  72
  73 /* private static */ void ImageInputTelemetry::RecordImageInputTelemetry(
  74     const nsCString& aImageType, ImageInputType aInputType) {
  75   nsAutoCString inputType;
  76   switch (aInputType) {
  77     case ImageInputType::Drop:
  78       inputType = "Drop"_ns;
  79       break;
  80     case ImageInputType::Paste:
  81       inputType = "Paste"_ns;
  82       break;
  83     case ImageInputType::FilePicker:
  84       inputType = "FilePicker"_ns;
  85       break;
  86   }
  87   glean::image_input_telemetry::ImageInputExtra extra = {
  88       .imageType = Some(aImageType),
  89       .inputType = Some(inputType),
  90   };
  91   glean::image_input_telemetry::image_input.Record(Some(extra));
  92 }
  93
  94 /* private static */ void ImageInputTelemetry::MaybeRecordImageInputTelemetry(
  95     ImageInputType aInputType, dom::DataTransfer* aDataTransfer) {
  96   // Check if input datatransfers contains files.
  97   RefPtr<dom::FileList> files =
  98       aDataTransfer->GetFiles(*nsContentUtils::GetSystemPrincipal());
  99   if (!files) {
 100     return;
 101   }
 102
 103   nsAutoString fileType;
 104   nsCString fileTypeC;
 105   for (uint32_t i = 0; i < files->Length(); i++) {
 106     dom::File* file = files->Item(i);
 107     if (!file) {
 108       continue;
 109     }
 110
 111     file->GetType(fileType);
 112     fileTypeC = NS_ConvertUTF16toUTF8(fileType);
 113     if (IsKnownImageMIMEType(fileTypeC)) {
 114       ImageInputTelemetry::RecordImageInputTelemetry(fileTypeC, aInputType);
 115     }
 116   }
 117 }
 118
 119 /* static */ void ImageInputTelemetry::MaybeRecordDropImageInputTelemetry(
 120     WidgetDragEvent* aDragEvent, nsIPrincipal* aContentPrincipal) {
 121   MOZ_ASSERT(aDragEvent);
 122   MOZ_ASSERT(aContentPrincipal);
 123
 124   // Only collect telemetry when drag data is accessed on drop.
 125   if (aDragEvent->mMessage != eDrop || !aDragEvent->mDataTransfer) {
 126     return;
 127   }
 128
 129   // Only process events on content, not about pages, e.g. default drop
 130   // handler displays dropped file.
 131   if (!IsContentPrincipal(aContentPrincipal)) {
 132     return;
 133   }
 134
 135   ImageInputTelemetry::MaybeRecordImageInputTelemetry(
 136       ImageInputType::Drop, aDragEvent->mDataTransfer);
 137 }
 138
 139 /* static */ void ImageInputTelemetry::MaybeRecordPasteImageInputTelemetry(
 140     InternalClipboardEvent* aClipboardEvent, nsIPrincipal* aContentPrincipal) {
 141   MOZ_ASSERT(aClipboardEvent);
 142   MOZ_ASSERT(aContentPrincipal);
 143
 144   // Only collect telemetry when clipboard data is accessed on paste.
 145   if (aClipboardEvent->mMessage != ePaste || !aClipboardEvent->mClipboardData) {
 146     return;
 147   }
 148
 149   // Only process events on content, neither system (e.g. URL bar) nor
 150   // about pages (e.g. searchbar in about:preferences).
 151   if (!IsContentPrincipal(aContentPrincipal)) {
 152     return;
 153   }
 154
 155   ImageInputTelemetry::MaybeRecordImageInputTelemetry(
 156       ImageInputType::Paste, aClipboardEvent->mClipboardData);
 157 }
 158
 159 /* static */ void ImageInputTelemetry::MaybeRecordFilePickerImageInputTelemetry(
 160     dom::Blob* aFilePickerBlob) {
 161   MOZ_ASSERT(aFilePickerBlob);
 162
 163   nsAutoString fileType;
 164   nsCString fileTypeC;
 165   aFilePickerBlob->GetType(fileType);
 166   fileTypeC = NS_ConvertUTF16toUTF8(fileType);
 167   if (IsKnownImageMIMEType(fileTypeC)) {
 168     ImageInputTelemetry::RecordImageInputTelemetry(fileTypeC,
 169                                                    ImageInputType::FilePicker);
 170   }
 171 }
 172
 173 }  // namespace mozilla