Generalize the usage of referrer chain

chrome/browser/safe_browsing/safe_browsing_navigation_observer_manager.cc

 // Copyright 2016 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/safe_browsing/safe_browsing_navigation_observer_manager.h"
 
 #include "base/memory/ptr_util.h"
 #include "base/metrics/histogram_macros.h"
 #include "base/strings/stringprintf.h"
 #include "base/time/time.h"
@@ skipping 25 matching lines @@
   if (current_time_in_second <= event_time_in_second)
     return true;
   return current_time_in_second - event_time_in_second > ttl_in_second;
 }
 
 // Helper function to determine if the URL type should be LANDING_REFERRER or
 // LANDING_PAGE, and modify AttributionResult accordingly.
 ReferrerChainEntry::URLType GetURLTypeAndAdjustAttributionResult(
     bool at_user_gesture_limit,
     SafeBrowsingNavigationObserverManager::AttributionResult* out_result) {
-  // Landing page of a download refers to the page user directly interacts
-  // with to trigger this download (e.g. clicking on download button). Landing
-  // referrer page is the one user interacts with right before navigating to
-  // the landing page.
+  // Landing page refers to the page user directly interacts with to trigger
+  // this event (e.g. clicking on download button). Landing referrer page is the
+  // one user interacts with right before navigating to the landing page.
   // Since we are tracing navigations backwards, if we've reached
   // user gesture limit before this navigation event, this is a navigation
   // leading to the landing referrer page, otherwise it leads to landing page.
   if (at_user_gesture_limit) {
     *out_result =
         SafeBrowsingNavigationObserverManager::SUCCESS_LANDING_REFERRER;
     return ReferrerChainEntry::LANDING_REFERRER;
   } else {
     *out_result = SafeBrowsingNavigationObserverManager::SUCCESS_LANDING_PAGE;
     return ReferrerChainEntry::LANDING_PAGE;
@@ skipping 238 matching lines @@
 
 void SafeBrowsingNavigationObserverManager::CleanUpStaleNavigationFootprints() {
   CleanUpNavigationEvents();
   CleanUpUserGestures();
   CleanUpIpAddresses();
   ScheduleNextCleanUpAfterInterval(
       base::TimeDelta::FromSecondsD(kNavigationFootprintTTLInSecond));
 }
 
 SafeBrowsingNavigationObserverManager::AttributionResult
-SafeBrowsingNavigationObserverManager::IdentifyReferrerChainForDownload(
-    const GURL& target_url,
-    int target_tab_id,
+SafeBrowsingNavigationObserverManager::IdentifyReferrerChainByEventURL(
+    const GURL& event_url,
+    int event_tab_id,
     int user_gesture_count_limit,
     ReferrerChain* out_referrer_chain) {
-  if (!target_url.is_valid())
+  if (!event_url.is_valid())
     return INVALID_URL;
 
   NavigationEvent* nav_event = navigation_event_list_.FindNavigationEvent(
-      target_url, GURL(), target_tab_id);
+      event_url, GURL(), event_tab_id);
   if (!nav_event) {
-    // We cannot find a single navigation event related to this download.
+    // We cannot find a single navigation event related to this event.
     return NAVIGATION_EVENT_NOT_FOUND;
   }
   AttributionResult result = SUCCESS;
   AddToReferrerChain(out_referrer_chain, nav_event, GURL(),
-                     ReferrerChainEntry::DOWNLOAD_URL);
+                     ReferrerChainEntry::EVENT_URL);
   int user_gesture_count = 0;
   GetRemainingReferrerChain(
       nav_event,
       user_gesture_count,
       user_gesture_count_limit,
       out_referrer_chain,
       &result);
   return result;
 }
 
 SafeBrowsingNavigationObserverManager::AttributionResult
-SafeBrowsingNavigationObserverManager::
-    IdentifyReferrerChainByDownloadWebContent(
-        content::WebContents* web_contents,
-        int user_gesture_count_limit,
-        ReferrerChain* out_referrer_chain) {
+SafeBrowsingNavigationObserverManager::IdentifyReferrerChainByWebContents(
+    content::WebContents* web_contents,
+    int user_gesture_count_limit,
+    ReferrerChain* out_referrer_chain) {
   if (!web_contents || !web_contents->GetLastCommittedURL().is_valid())
     return INVALID_URL;
   bool has_user_gesture = HasUserGesture(web_contents);
   int tab_id = SessionTabHelper::IdForTab(web_contents);
-  return IdentifyReferrerChainForDownloadHostingPage(
+  return IdentifyReferrerChainByHostingPage(
       web_contents->GetLastCommittedURL(), GURL(), tab_id, has_user_gesture,
       user_gesture_count_limit, out_referrer_chain);
 }
 
 SafeBrowsingNavigationObserverManager::AttributionResult
-SafeBrowsingNavigationObserverManager::
-    IdentifyReferrerChainForDownloadHostingPage(
-        const GURL& initiating_frame_url,
-        const GURL& initiating_main_frame_url,
-        int tab_id,
-        bool has_user_gesture,
-        int user_gesture_count_limit,
-        ReferrerChain* out_referrer_chain) {
+SafeBrowsingNavigationObserverManager::IdentifyReferrerChainByHostingPage(
+    const GURL& initiating_frame_url,
+    const GURL& initiating_main_frame_url,
+    int tab_id,
+    bool has_user_gesture,
+    int user_gesture_count_limit,
+    ReferrerChain* out_referrer_chain) {
   if (!initiating_frame_url.is_valid())
     return INVALID_URL;
 
   NavigationEvent* nav_event = navigation_event_list_.FindNavigationEvent(
       initiating_frame_url, initiating_main_frame_url, tab_id);
   if (!nav_event) {
-    // We cannot find a single navigation event related to this download hosting
-    // page.
+    // We cannot find a single navigation event related to this hosting page.
     return NAVIGATION_EVENT_NOT_FOUND;
   }
 
   AttributionResult result = SUCCESS;
 
   int user_gesture_count = 0;
   // If this initiating_frame has user gesture, we consider this as the landing
-  // page of the PPAPI download.
+  // page of this event.
   if (has_user_gesture) {
     user_gesture_count = 1;
     AddToReferrerChain(
         out_referrer_chain, nav_event, initiating_main_frame_url,
         GetURLTypeAndAdjustAttributionResult(
             user_gesture_count == user_gesture_count_limit, &result));
   } else {
     AddToReferrerChain(out_referrer_chain, nav_event, initiating_main_frame_url,
                        ReferrerChainEntry::CLIENT_REDIRECT);
   }
@@ skipping 207 matching lines @@
             out_result));
     // Stop searching if the size of out_referrer_chain already reached its
     // limit.
     if (out_referrer_chain->size() == kReferrerChainMaxLength)
       return;
     last_main_frame_url_traced = last_nav_event_traced->source_main_frame_url;
   }
 }
 
 }  // namespace safe_browsing