Adds the NewTabPage.SuggestedSitesAction stat.

chrome/browser/ui/webui/ntp/suggestions_page_handler.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/webui/ntp/suggestions_page_handler.h"
 
 #include <set>
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/md5.h"
 #include "base/memory/scoped_vector.h"
 #include "base/memory/singleton.h"
+#include "base/metrics/histogram.h"
 #include "base/string16.h"
 #include "base/string_number_conversions.h"
 #include "base/threading/thread.h"
 #include "base/utf_string_conversions.h"
 #include "base/values.h"
 #include "chrome/browser/history/page_usage_data.h"
 #include "chrome/browser/history/top_sites.h"
 #include "chrome/browser/history/visit_filter.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/ui/webui/chrome_url_data_manager.h"
 #include "chrome/browser/ui/webui/favicon_source.h"
 #include "chrome/browser/ui/webui/ntp/new_tab_ui.h"
 #include "chrome/browser/ui/webui/ntp/thumbnail_source.h"
 #include "chrome/common/chrome_notification_types.h"
 #include "chrome/common/url_constants.h"
 #include "content/public/browser/browser_thread.h"
+#include "content/public/browser/navigation_controller.h"
+#include "content/public/browser/navigation_entry.h"
 #include "content/public/browser/notification_source.h"
 #include "content/public/browser/user_metrics.h"
+#include "content/public/browser/web_contents.h"
 #include "content/public/browser/web_ui.h"
+#include "content/public/common/page_transition_types.h"
 #include "googleurl/src/gurl.h"
 
 using content::UserMetricsAction;
 
+namespace {
+
+// Those values are defined in histograms.xml. These represent the action that
+// the user has taken to leave the Suggested pane, given that they have viewed
+// that pane on the NTP.
+enum SuggestedSitesActions {
+  // Values 0 to 10 are the core values from PageTransition (see
+  // page_transition_types.h).
+
+  // The user has clicked on a Suggested tile.
+  SUGGESTED_SITES_ACTION_CLICKED_SUGGESTED_TILE = 11,
+  // The user has moved to another pane within the NTP.
+  SUGGESTED_SITES_ACTION_CLICKED_OTHER_NTP_PANE,
+  // Any action other than what is listed here (e.g. closing the tab, etc.).
+  SUGGESTED_SITES_ACTION_OTHER
+};
+
+}  // namespace
+
 SuggestionsHandler::SuggestionsHandler()
-    : got_first_suggestions_request_(false) {
+    : got_first_suggestions_request_(false),
+      suggestions_viewed_(false),
+      valid_user_action_(false) {
 }
 
 SuggestionsHandler::~SuggestionsHandler() {
+  // TODO(macourteau): ensure that |suggestions_viewed_| gets set correctly,
+  // once the Suggestions pane gets statically included into the NTP (e.g.,
+  // if the Suggestions pane is the one shown by default, the
+  // |suggestions_viewed_| flag might not get set).
+  if (!valid_user_action_ && suggestions_viewed_) {
+    const GURL ntp_url = GURL(chrome::kChromeUINewTabURL);
+    int action_id = SUGGESTED_SITES_ACTION_OTHER;
+    content::NavigationEntry* entry =
+        web_ui()->GetWebContents()->GetController().GetActiveEntry();
+    if (entry && (entry->GetURL() != ntp_url)) {
+      action_id =
+        content::PageTransitionStripQualifier(entry->GetTransitionType());

[Evan Stade, 2012/04/12 03:30:53]

2 more spaces indent

[macourteau, 2012/04/12 13:59:43]

Done.

+    }
+
+    UMA_HISTOGRAM_ENUMERATION("NewTabPage.SuggestedSitesAction", action_id, 4);

[Evan Stade, 2012/04/12 03:30:53]

4?

[macourteau, 2012/04/12 13:59:43]

Done.

+  }
 }
 
 void SuggestionsHandler::RegisterMessages() {
   Profile* profile = Profile::FromWebUI(web_ui());
   // Set up our sources for thumbnail and favicon data.
   profile->GetChromeURLDataManager()->AddDataSource(
       new ThumbnailSource(profile));
   profile->GetChromeURLDataManager()->AddDataSource(
       new FaviconSource(profile, FaviconSource::FAVICON));
 
@@ skipping 22 matching lines @@
   // Register ourselves for any suggestions item blacklisting.
   web_ui()->RegisterMessageCallback("blacklistURLFromSuggestions",
       base::Bind(&SuggestionsHandler::HandleBlacklistURL,
                  base::Unretained(this)));
   web_ui()->RegisterMessageCallback("removeURLsFromSuggestionsBlacklist",
       base::Bind(&SuggestionsHandler::HandleRemoveURLsFromBlacklist,
                  base::Unretained(this)));
   web_ui()->RegisterMessageCallback("clearSuggestionsURLsBlacklist",
       base::Bind(&SuggestionsHandler::HandleClearBlacklist,
                  base::Unretained(this)));
+  web_ui()->RegisterMessageCallback("suggestedSitesAction",
+      base::Bind(&SuggestionsHandler::HandleSuggestedSitesAction,
+                 base::Unretained(this)));
+  web_ui()->RegisterMessageCallback("suggestedSitesSelected",
+      base::Bind(&SuggestionsHandler::HandleSuggestedSitesSelected,
+                 base::Unretained(this)));
 }
 
 void SuggestionsHandler::HandleGetSuggestions(const ListValue* args) {
   if (!got_first_suggestions_request_) {
     // If our initial data is already here, return it.
     SendPagesValue();
     got_first_suggestions_request_ = true;
   } else {
     StartQueryForSuggestions();
   }
@@ skipping 34 matching lines @@
 
 void SuggestionsHandler::HandleRemoveURLsFromBlacklist(const ListValue* args) {
   DCHECK_GT(args->GetSize(), 0U);
   // TODO(georgey) remove URLs from blacklist.
 }
 
 void SuggestionsHandler::HandleClearBlacklist(const ListValue* args) {
   // TODO(georgey) clear blacklist.
 }
 
+void SuggestionsHandler::HandleSuggestedSitesAction(
+    const base::ListValue* args) {
+  DCHECK(args);
+
+  double action_id;
+  if (!args->GetDouble(0, &action_id))
+    NOTREACHED();
+
+  UMA_HISTOGRAM_ENUMERATION("NewTabPage.SuggestedSitesAction",
+                            static_cast<int>(action_id), 4);

[Evan Stade, 2012/04/12 03:30:53]

4?

[macourteau, 2012/04/12 13:59:43]

Done.

+  suggestions_viewed_ = true;
+  valid_user_action_ = true;
+}
+
+void SuggestionsHandler::HandleSuggestedSitesSelected(
+    const base::ListValue* args) {
+  suggestions_viewed_ = true;
+}
+
 void SuggestionsHandler::SetPagesValueFromTopSites(
     const history::MostVisitedURLList& data) {
   pages_value_.reset(new ListValue());
   for (size_t i = 0; i < data.size(); i++) {
     const history::MostVisitedURL& suggested_url = data[i];
     if (suggested_url.url.is_empty())
       continue;
 
     DictionaryValue* page_value = new DictionaryValue();
     NewTabUI::SetURLTitleAndDirection(page_value,
@@ skipping 25 matching lines @@
 }
 
 std::string SuggestionsHandler::GetDictionaryKeyForURL(const std::string& url) {
   return base::MD5String(url);
 }
 
 // static
 void SuggestionsHandler::RegisterUserPrefs(PrefService* prefs) {
   // TODO(georgey) add user preferences (such as own blacklist) as needed.
 }