Add SafeBrowsingNavigationObserver to listen to navigation events

chrome/browser/safe_browsing/safe_browsing_navigation_observer.h

+// 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.
+
+#ifndef CHROME_BROWSER_SAFE_BROWSING_SAFE_BROWSING_NAVIGATION_OBSERVER_H_
+#define CHROME_BROWSER_SAFE_BROWSING_SAFE_BROWSING_NAVIGATION_OBSERVER_H_
+
+#include "base/supports_user_data.h"
+#include "content/public/browser/web_contents_observer.h"
+#include "url/gurl.h"
+
+namespace content {
+class NavigationHandle;
+struct ResourceRedirectDetails;
+}
+
+namespace safe_browsing {
+class SafeBrowsingNavigationObserverManager;
+
+// Struct to record the details of a navigation event for any frames.
+// This information will be used to fill |url_chain| field in safe browsing
+// download pings.
+struct NavigationEvent {
+  NavigationEvent();
+  NavigationEvent(NavigationEvent&& nav_event);
+  NavigationEvent& operator=(NavigationEvent&& nav_event);
+  ~NavigationEvent();
+
+  GURL source_url;  // URL that caused this navigation to occur.
+  int source_tab_id;  // Which tab the above source_url is in. Tab ID is
+                      // returned by SessionTabHelper::IdForTab. This ID is
+                      // immutable for a given tab and unique across Chrome
+                      // within the current session.
+
+  GURL target_url;  // The original request URL of this navigation.
+  int target_tab_id;  // Which tab this target url is in.
+
+  int frame_id;  // Frame tree node ID of the frame where this navigation takes
+                 // place.
+  GURL main_frame_url;  // Main frame url of the source_url. Can be the same
+                        // as source url, if source_url was loaded in main
+                        // frame.
+
+  base::Time timestamp;  // Timestamp of last time this object is updated.
+
+  bool is_user_initiated;  // browser_initiated || has_user_gesture.
+  bool has_committed;
+  bool has_server_redirect;
+  GURL server_redirect_url;  // Last server redirect url in server redirect
+                             // chain. In the absence of server redirect, this
+                             // field will be empty.
+};
+
+// Observes the navigation events for a single WebContents (both main-frame
+// and sub-frame navigations)
+class SafeBrowsingNavigationObserver : public base::SupportsUserData::Data,
+                                       public content::WebContentsObserver {
+ public:
+  static void MaybeCreateForWebContents(content::WebContents* web_contents);
+  static SafeBrowsingNavigationObserver* FromWebContents(
+      content::WebContents* web_contents);
+
+  SafeBrowsingNavigationObserver(
+      content::WebContents* contents,
+      const scoped_refptr<SafeBrowsingNavigationObserverManager>& manager);
+
+  ~SafeBrowsingNavigationObserver() override;
+
+ private:
+  typedef std::unordered_map<content::NavigationHandle*, NavigationEvent>
+      NavigationHandleMap;
+
+  // content::WebContentsObserver:
+  void DidStartNavigation(
+      content::NavigationHandle* navigation_handle) override;
+  void DidRedirectNavigation(
+      content::NavigationHandle* navigation_handle) override;
+  void DidFinishNavigation(
+      content::NavigationHandle* navigation_handle) override;
+  void DidGetUserInteraction(const blink::WebInputEvent::Type type) override;
+  void WebContentsDestroyed() override;
+
+  // Map keyed on NavigationHandle* to keep track of all the ongoing navigation
+  // events. NavigationHandle pointers are owned by RenderFrameHost. Since a
+  // NavigationHandle object will be destructed after navigation is done,
+  // corresponding entry in this map will be removed from navigation_handle_map_
+  // and added to navigation_map_ at the end of DidFinishNavigation(...).
+  NavigationHandleMap navigation_handle_map_;
+  scoped_refptr<SafeBrowsingNavigationObserverManager> manager_;
+  // If the observed WebContents just got an user gesture.
+  bool has_user_gesture_;
+  base::Time last_user_gesture_timestamp_;
+  DISALLOW_COPY_AND_ASSIGN(SafeBrowsingNavigationObserver);
+};
+
+}  // namespace safe_browsing
+
+#endif  // CHROME_BROWSER_SAFE_BROWSING_SAFE_BROWSING_NAVIGATION_OBSERVER_H_