Experience sampling instrumentation for dangerous downloads warnings

chrome/browser/ui/views/download/download_item_view.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/browser/ui/views/download/download_item_view.h"
 
 #include <algorithm>
 #include <vector>
 
 #include "base/bind.h"
 #include "base/callback.h"
 #include "base/files/file_path.h"
 #include "base/i18n/break_iterator.h"
 #include "base/i18n/rtl.h"
 #include "base/metrics/histogram.h"
 #include "base/prefs/pref_service.h"
 #include "base/strings/string_util.h"
 #include "base/strings/stringprintf.h"
 #include "base/strings/sys_string_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/download/chrome_download_manager_delegate.h"
 #include "chrome/browser/download/download_item_model.h"
 #include "chrome/browser/download/download_stats.h"
 #include "chrome/browser/download/drag_download_item.h"
+#include "chrome/browser/extensions/api/experience_sampling_private/experience_sampling.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/safe_browsing/download_feedback_service.h"
 #include "chrome/browser/safe_browsing/download_protection_service.h"
 #include "chrome/browser/safe_browsing/safe_browsing_service.h"
 #include "chrome/browser/themes/theme_properties.h"
 #include "chrome/browser/ui/views/download/download_feedback_dialog_view.h"
 #include "chrome/browser/ui/views/download/download_shelf_context_menu_view.h"
 #include "chrome/browser/ui/views/download/download_shelf_view.h"
 #include "chrome/browser/ui/views/frame/browser_view.h"
 #include "content/public/browser/download_danger_type.h"
@@ skipping 11 matching lines @@
 #include "ui/gfx/image/image.h"
 #include "ui/gfx/text_elider.h"
 #include "ui/gfx/text_utils.h"
 #include "ui/views/controls/button/label_button.h"
 #include "ui/views/controls/label.h"
 #include "ui/views/mouse_constants.h"
 #include "ui/views/widget/root_view.h"
 #include "ui/views/widget/widget.h"
 
 using content::DownloadItem;
+using extensions::ExperienceSamplingEvent;
 
 // TODO(paulg): These may need to be adjusted when download progress
 //              animation is added, and also possibly to take into account
 //              different screen resolutions.
 static const int kTextWidth = 140;            // Pixels
 static const int kDangerousTextWidth = 200;   // Pixels
 static const int kVerticalPadding = 3;        // Pixels
 static const int kVerticalTextPadding = 2;    // Pixels
 static const int kTooltipMaxWidth = 800;      // Pixels
 
@@ skipping 156 matching lines @@
 
   SetAccessibilityFocusable(true);
 
   OnDownloadUpdated(download());
   UpdateDropDownButtonPosition();
 }
 
 DownloadItemView::~DownloadItemView() {
   StopDownloadProgress();
   download()->RemoveObserver(this);
+
+  // ExperienceSampling: If the user took no action to remove the warning
+  // before it disappeared, then the user effectively dismissed the download
+  // without keeping it.
+  if (sampling_event_.get())
+    sampling_event_->CreateUserDecisionEvent(ExperienceSamplingEvent::kIgnore);
 }
 
 // Progress animation handlers.
 
 void DownloadItemView::UpdateDownloadProgress() {
   progress_angle_ =
       (progress_angle_ + DownloadShelf::kUnknownIncrementDegrees) %
       DownloadShelf::kMaxDegrees;
   SchedulePaint();
 }
@@ skipping 300 matching lines @@
 void DownloadItemView::ButtonPressed(views::Button* sender,
                                      const ui::Event& event) {
   base::TimeDelta warning_duration;
   if (!time_download_warning_shown_.is_null())
     warning_duration = base::Time::Now() - time_download_warning_shown_;
 
   if (save_button_ && sender == save_button_) {
     // The user has confirmed a dangerous download.  We'd record how quickly the
     // user did this to detect whether we're being clickjacked.
     UMA_HISTOGRAM_LONG_TIMES("clickjacking.save_download", warning_duration);
+    // ExperienceSampling: User chose to proceed with a dangerous download.
+    if (sampling_event_.get()) {

[msw, 2014/08/14 17:56:44]

nit q: Should this be a DCHECK instead?

[Chris Thompson, 2014/08/14 20:00:03]

Given the possible flows of dangerous downloads UI, I'd rather not assume that
sampling_event_ can't get NULL here. In a way, this is gating on the first path
that triggers a decision event wins, but that doesn't necessarily prevent other
paths that could also trigger the event from happening (or I'm not sure enough
about all possible execution paths).

[msw, 2014/08/14 20:46:42]

Acknowledged; it's fine as-is, but DCHECKs could expose unexpected  execution
paths, which could yield experience sampling (and actual UI) improvements.

+      sampling_event_->CreateUserDecisionEvent(
+          ExperienceSamplingEvent::kProceed);
+      sampling_event_.reset(NULL);
+    }
     // This will change the state and notify us.
     download()->ValidateDangerousDownload();
     return;
   }
 
   // WARNING: all end states after this point delete |this|.
   DCHECK_EQ(discard_button_, sender);
   if (model_.IsMalicious()) {
     UMA_HISTOGRAM_LONG_TIMES("clickjacking.dismiss_download", warning_duration);
+    // ExperienceSampling: User chose to dismiss the dangerous download.
+    if (sampling_event_.get()) {

[msw, 2014/08/14 17:56:44]

ditto nit q: Should this be a DCHECK instead?

+      sampling_event_->CreateUserDecisionEvent(ExperienceSamplingEvent::kDeny);
+      sampling_event_.reset(NULL);
+    }
     shelf_->RemoveDownloadView(this);
     return;
   }
   UMA_HISTOGRAM_LONG_TIMES("clickjacking.discard_download", warning_duration);
   if (model_.ShouldAllowDownloadFeedback() &&
       !shelf_->browser()->profile()->IsOffTheRecord()) {
     if (!shelf_->browser()->profile()->GetPrefs()->HasPrefPath(
         prefs::kSafeBrowsingExtendedReportingEnabled)) {
       // Show dialog, because the dialog hasn't been shown before.
       DownloadFeedbackDialogView::Show(
@@ skipping 548 matching lines @@
 
 void DownloadItemView::ClearWarningDialog() {
   DCHECK(download()->GetDangerType() ==
          content::DOWNLOAD_DANGER_TYPE_USER_VALIDATED);
   DCHECK(mode_ == DANGEROUS_MODE || mode_ == MALICIOUS_MODE);
 
   mode_ = NORMAL_MODE;
   body_state_ = NORMAL;
   drop_down_state_ = NORMAL;
 
+  // ExperienceSampling: User proceeded through the warning.
+  if (sampling_event_.get()) {

[msw, 2014/08/14 17:56:44]

ditto nit q: Should this be a DCHECK instead?

+    sampling_event_->CreateUserDecisionEvent(ExperienceSamplingEvent::kProceed);
+    sampling_event_.reset(NULL);
+  }
   // Remove the views used by the warning dialog.
   if (save_button_) {
     RemoveChildView(save_button_);
     delete save_button_;
     save_button_ = NULL;
   }
   RemoveChildView(discard_button_);
   delete discard_button_;
   discard_button_ = NULL;
   RemoveChildView(dangerous_download_label_);
@@ skipping 23 matching lines @@
   content::DownloadDangerType danger_type = download()->GetDangerType();
   RecordDangerousDownloadWarningShown(danger_type);
 #if defined(FULL_SAFE_BROWSING)
   if (model_.ShouldAllowDownloadFeedback()) {
     safe_browsing::DownloadFeedbackService::RecordEligibleDownloadShown(
         danger_type);
   }
 #endif
   mode_ = model_.MightBeMalicious() ? MALICIOUS_MODE : DANGEROUS_MODE;
 
+  // ExperienceSampling: Dangerous or malicious download warning is being shown
+  // to the user, so we start a new SamplingEvent and track it.
+  std::string event_name =
+      model_.MightBeMalicious()
+          ? ExperienceSamplingEvent::kEventNameMaliciousDownload
+          : ExperienceSamplingEvent::kEventNameDangerousDownload;
+  sampling_event_.reset(
+      new ExperienceSamplingEvent(event_name,
+                                  download()->GetURL(),
+                                  download()->GetReferrerUrl(),
+                                  download()->GetBrowserContext()));
+
   body_state_ = NORMAL;
   drop_down_state_ = NORMAL;
   if (mode_ == DANGEROUS_MODE) {
     save_button_ = new views::LabelButton(
         this, model_.GetWarningConfirmButtonText());
     save_button_->SetStyle(views::Button::STYLE_BUTTON);
     AddChildView(save_button_);
   }
   int discard_button_message = model_.IsMalicious() ?
       IDS_DISMISS_DOWNLOAD : IDS_DISCARD_DOWNLOAD;
@@ skipping 173 matching lines @@
 void DownloadItemView::AnimateStateTransition(State from, State to,
                                               gfx::SlideAnimation* animation) {
   if (from == NORMAL && to == HOT) {
     animation->Show();
   } else if (from == HOT && to == NORMAL) {
     animation->Hide();
   } else if (from != to) {
     animation->Reset((to == HOT) ? 1.0 : 0.0);
   }
 }