Add a NavigationThrottle to the public content/ interface

content/browser/frame_host/navigation_handle_impl.h

 // Copyright 2015 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 CONTENT_BROWSER_FRAME_HOST_NAVIGATION_HANDLE_IMPL_H_
 #define CONTENT_BROWSER_FRAME_HOST_NAVIGATION_HANDLE_IMPL_H_
 
 #include "content/public/browser/navigation_handle.h"
 
 #include "base/macros.h"
 #include "base/memory/scoped_ptr.h"
+#include "base/memory/scoped_vector.h"
 #include "content/common/content_export.h"
+#include "content/public/browser/navigation_throttle.h"
 #include "url/gurl.h"
 
 namespace content {
 
 class NavigatorDelegate;
 struct NavigationRequestInfo;
 
 // This class keeps track of a single navigation. It is created upon receipt of
 // a DidStartProvisionalLoad IPC in a RenderFrameHost. The RenderFrameHost owns
 // the newly created NavigationHandleImpl as long as the navigation is ongoing.
@@ skipping 22 matching lines @@
 // NavigationRequest. It is then owned by the NavigationRequest until the
 // navigation is ready to commit. The NavigationHandleImpl ownership is then
 // transferred to the RenderFrameHost in which the navigation will commit.
 //
 // When PlzNavigate is enabled, the NavigationHandleImpl will never be reset
 // following the receipt of a DidStartProvisionalLoad IPC. There are also no
 // transferring navigations. The other causes of NavigationHandleImpl reset in
 // the RenderFrameHost still apply.
 class CONTENT_EXPORT NavigationHandleImpl : public NavigationHandle {
  public:
+  // This is used by the NavigationHandleFactory to create NavigationHandles
+  // in the regular case. Other callers should use
+  // NavigationHandleFactory::Create, which will ensure that test versions of
+  // NavigationHandles are properly created in unit tests.

[nasko, 2015/09/04 00:01:52]

Why not make this method private then? If it is not meant to be called by anyone
other than the factory, it can be private with the factory being a friend to it.

[clamy, 2015/09/04 12:59:14]

Ha I wasn't sure about making non-test classes friend of other classes. Will do
so in the next patch set.

[clamy, 2015/09/08 16:27:18]

I removed it entirely, and have NavigationHandleFactory a friend of
NavigationHandleImpl, to call the constructor directly.

   static scoped_ptr<NavigationHandleImpl> Create(const GURL& url,
+                                                 const GURL& validated_url,
                                                  const bool is_main_frame,
                                                  NavigatorDelegate* delegate);
 
   ~NavigationHandleImpl() override;
 
   // NavigationHandle implementation:
   const GURL& GetURL() const override;
+  const GURL& GetValidatedURL() const override;
+  bool IsInMainFrame() const override;
+  bool IsPost() const override;
+  const Referrer& GetReferrer() const override;
+  bool HasUserGesture() const override;
+  ui::PageTransition GetPageTransition() const override;
+  bool IsExternalProtocol() const override;
   net::Error GetNetErrorCode() const override;
-  bool IsInMainFrame() const override;
   bool HasCommittedDocument() const override;
   bool HasCommittedErrorPage() const override;
+  void RegisterThrottleForTesting(
+      scoped_ptr<NavigationThrottle> navigation_throttle) override;
 
   void set_net_error_code(net::Error net_error_code) {
     net_error_code_ = net_error_code;
   }
 
   // Returns whether the navigation is currently being transferred from one
   // RenderFrameHost to another. In particular, a DidStartProvisionalLoad IPC
   // for the navigation URL, received in the new RenderFrameHost, should not
   // indicate the start of a new navigation in that case.
   bool is_transferring() const { return is_transferring_; }
   void set_is_transferring(bool is_transferring) {
     is_transferring_ = is_transferring;
   }
 
+  // Called when the URLRequest will start in the network stack.
+  NavigationThrottle::ThrottleCheckResult WillStartRequest(
+      bool is_post,
+      const Referrer& sanitized_referrer,
+      bool has_user_gesture,
+      ui::PageTransition transition,
+      bool is_external_protocol);
+
+  // Called when the URLRequest will be redirected in the network stack.
+  NavigationThrottle::ThrottleCheckResult WillRedirectRequest(
+      const GURL& new_url,
+      const GURL& new_validated_url,
+      bool new_method_is_post,
+      const GURL& new_referrer_url,
+      bool new_is_external_protocol);
+
   // Called when the navigation was redirected. This will update the |url_| and
   // inform the delegate.
   void DidRedirectNavigation(const GURL& new_url);
 
   // Called when the navigation was committed. This will update the |state_|
   // and inform the delegate,
   void DidCommitNavigation();
 
  private:
+  friend class TestNavigationHandle;
+
   // Used to track the state the navigation is currently in.
   enum State {
     DID_START = 0,
+    WILL_SEND_REQUEST,
     DID_COMMIT,
     DID_COMMIT_ERROR_PAGE,
   };
 
   NavigationHandleImpl(const GURL& url,
+                       const GURL& validated_url,
                        const bool is_main_frame,
                        NavigatorDelegate* delegate);
 
   // See NavigationHandle for a description of those member variables.
   GURL url_;
+  GURL validated_url_;
+  const bool is_main_frame_;
+  bool is_post_;
+  Referrer sanitized_referrer_;
+  bool has_user_gesture_;
+  ui::PageTransition transition_;
+  bool is_external_protocol_;
   net::Error net_error_code_;
+
+  // The state the navigation is in.
   State state_;
-  const bool is_main_frame_;
 
   // Whether the navigation is in the middle of a transfer. Set to false when
   // the DidStartProvisionalLoad is received from the new renderer.
   bool is_transferring_;
 
   // The delegate that should be notified about events related to this
   // navigation.
   NavigatorDelegate* delegate_;
 
+  // A list of Throttles registered for this navigation.
+  ScopedVector<NavigationThrottle> throttles_;
+
   DISALLOW_COPY_AND_ASSIGN(NavigationHandleImpl);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_FRAME_HOST_NAVIGATION_HANDLE_IMPL_H_