Experience sampling instrumentation for dangerous downloads warnings

chrome/browser/ui/cocoa/download/download_item_controller.mm

 // 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.
 
 #import "chrome/browser/ui/cocoa/download/download_item_controller.h"
 
 #include "base/mac/bundle_locations.h"
 #include "base/mac/mac_util.h"
 #include "base/metrics/histogram.h"
 #include "base/strings/string16.h"
 #include "base/strings/string_util.h"
 #include "base/strings/sys_string_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "chrome/browser/download/chrome_download_manager_delegate.h"
 #include "chrome/browser/download/download_item_model.h"
 #include "chrome/browser/download/download_shelf_context_menu.h"
+#include "chrome/browser/extensions/api/experience_sampling_private/experience_sampling.h"
 #import "chrome/browser/themes/theme_properties.h"
 #import "chrome/browser/themes/theme_service.h"
 #import "chrome/browser/ui/cocoa/download/download_item_button.h"
 #import "chrome/browser/ui/cocoa/download/download_item_cell.h"
 #include "chrome/browser/ui/cocoa/download/download_item_mac.h"
 #import "chrome/browser/ui/cocoa/download/download_shelf_context_menu_controller.h"
 #import "chrome/browser/ui/cocoa/download/download_shelf_controller.h"
 #import "chrome/browser/ui/cocoa/themed_window.h"
 #import "chrome/browser/ui/cocoa/ui_localizer.h"
 #include "content/public/browser/download_item.h"
 #include "content/public/browser/page_navigator.h"
 #include "grit/generated_resources.h"
 #include "grit/theme_resources.h"
 #include "third_party/google_toolbox_for_mac/src/AppKit/GTMUILocalizerAndLayoutTweaker.h"
 #include "ui/base/l10n/l10n_util_mac.h"
 #include "ui/base/resource/resource_bundle.h"
 #include "ui/gfx/text_elider.h"
 #include "ui/gfx/font.h"
 #include "ui/gfx/image/image.h"
 
 using content::DownloadItem;
+using extensions::ExperienceSamplingEvent;
 
 namespace {
 
+// Constants for Experience Sampling.
+const char kEventNameMalicious[] = "download_warning_malicious";
+const char kEventNameDangerous[] = "download_warning_dangerous";
+
 // NOTE: Mac currently doesn't use this like Windows does.  Mac uses this to
 // control the min size on the dangerous download text.  TVL sent a query off to
 // UX to fully spec all the the behaviors of download items and truncations
 // rules so all platforms can get inline in the future.
 const int kTextWidth = 140;            // Pixels
 
 // The maximum width in pixels for the file name tooltip.
 const int kToolTipMaxWidth = 900;
 
 
@@ skipping 59 matching lines @@
     state_ = kNormal;
     creationTime_ = base::Time::Now();
     font_list_.reset(new gfx::FontList(
         ui::ResourceBundle::GetSharedInstance().GetFontList(
             ui::ResourceBundle::BaseFont)));
   }
   return self;
 }
 
 - (void)dealloc {
+  if (sampling_event_.get())
+    sampling_event_->CreateUserDecisionEvent(ExperienceSamplingEvent::kDeny);
   [[NSNotificationCenter defaultCenter] removeObserver:self];
   [progressView_ setController:nil];
   [[self view] removeFromSuperview];
   [super dealloc];
 }
 
 - (void)awakeFromNib {
   [progressView_ setController:self];
 
   GTMUILocalizerAndLayoutTweaker* localizerAndLayoutTweaker =
       [[[GTMUILocalizerAndLayoutTweaker alloc] init] autorelease];
   [localizerAndLayoutTweaker applyLocalizer:localizer_ tweakingUI:[self view]];
 
   [self setStateFromDownload:bridge_->download_model()];
 
   bridge_->LoadIcon();
   [self updateToolTip];
 }
 
 - (void)showDangerousWarning:(DownloadItemModel*)downloadModel {
   // The transition from safe -> dangerous should only happen once. The code
   // assumes that the danger type of the download doesn't change once it's set.
   if ([self isDangerousMode])
     return;
 
   [self setState:kDangerous];
 
+  // 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 = downloadModel->MightBeMalicious() ?
+      kEventNameMalicious
+      : kEventNameDangerous;
+  sampling_event_.reset(new ExperienceSamplingEvent(
+      event_name,
+      downloadModel->download()->GetURL(),
+      downloadModel->download()->GetReferrerUrl(),
+      downloadModel->download()->GetBrowserContext()));
+
   ui::ResourceBundle& rb = ui::ResourceBundle::GetSharedInstance();
   NSImage* alertIcon;
 
   NSString* dangerousWarning = base::SysUTF16ToNSString(
       downloadModel->GetWarningText(*font_list_, kTextWidth));
   DCHECK(dangerousWarning);
   [dangerousDownloadLabel_ setStringValue:dangerousWarning];
   CGFloat labelWidthChange =
       [GTMUILocalizerAndLayoutTweaker
         sizeToFitFixedHeightTextField:dangerousDownloadLabel_
@@ skipping 156 matching lines @@
 
   NSColor* color = themeProvider->GetNSColor(ThemeProperties::COLOR_TAB_TEXT);
   [dangerousDownloadLabel_ setTextColor:color];
 }
 
 - (IBAction)saveDownload:(id)sender {
   // The user has confirmed a dangerous download.  We record how quickly the
   // user did this to detect whether we're being clickjacked.
   UMA_HISTOGRAM_LONG_TIMES("clickjacking.save_download",
                            base::Time::Now() - creationTime_);
+  // ExperienceSampling: User chose to proceed with dangerous download.
+  if (sampling_event_.get()) {
+    sampling_event_->CreateUserDecisionEvent(ExperienceSamplingEvent::kProceed);
+    sampling_event_.reset(NULL);
+  }
   // This will change the state and notify us.
   bridge_->download_model()->download()->ValidateDangerousDownload();
 }
 
 - (IBAction)discardDownload:(id)sender {
   UMA_HISTOGRAM_LONG_TIMES("clickjacking.discard_download",
                            base::Time::Now() - creationTime_);
   DownloadItem* download = bridge_->download_model()->download();
   download->Remove();
   // WARNING: we are deleted at this point.  Don't access 'this'.
 }
 
 - (IBAction)dismissMaliciousDownload:(id)sender {
+  // ExperienceSampling: User dismissed the dangerous download.
+  if (sampling_event_.get()) {
+    sampling_event_->CreateUserDecisionEvent(ExperienceSamplingEvent::kDeny);
+    sampling_event_.reset(NULL);
+  }
   [self remove];
   // WARNING: we are deleted at this point.
 }
 
 - (IBAction)showContextMenu:(id)sender {
   base::scoped_nsobject<DownloadShelfContextMenuController> menuController(
       [[DownloadShelfContextMenuController alloc]
         initWithItemController:self
                   withDelegate:nil]);
   [NSMenu popUpContextMenu:[menuController menu]
                  withEvent:[NSApp currentEvent]
                    forView:[self view]];
 }
 
 @end