| OLD | NEW |
| 1 // Copyright 2015 The Chromium Authors. All rights reserved. | 1 // Copyright 2015 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef CONTENT_BROWSER_FRAME_HOST_NAVIGATION_HANDLE_IMPL_H_ | 5 #ifndef CONTENT_BROWSER_FRAME_HOST_NAVIGATION_HANDLE_IMPL_H_ |
| 6 #define CONTENT_BROWSER_FRAME_HOST_NAVIGATION_HANDLE_IMPL_H_ | 6 #define CONTENT_BROWSER_FRAME_HOST_NAVIGATION_HANDLE_IMPL_H_ |
| 7 | 7 |
| 8 #include "content/public/browser/navigation_handle.h" | 8 #include "content/public/browser/navigation_handle.h" |
| 9 | 9 |
| 10 #include "base/macros.h" | 10 #include "base/macros.h" |
| 11 #include "base/memory/scoped_ptr.h" | 11 #include "base/memory/scoped_ptr.h" |
| 12 #include "base/memory/scoped_vector.h" |
| 12 #include "content/common/content_export.h" | 13 #include "content/common/content_export.h" |
| 14 #include "content/public/browser/navigation_throttle.h" |
| 13 #include "url/gurl.h" | 15 #include "url/gurl.h" |
| 14 | 16 |
| 15 namespace content { | 17 namespace content { |
| 16 | 18 |
| 17 class NavigatorDelegate; | 19 class NavigatorDelegate; |
| 18 struct NavigationRequestInfo; | 20 struct NavigationRequestInfo; |
| 19 | 21 |
| 20 // This class keeps track of a single navigation. It is created upon receipt of | 22 // This class keeps track of a single navigation. It is created upon receipt of |
| 21 // a DidStartProvisionalLoad IPC in a RenderFrameHost. The RenderFrameHost owns | 23 // a DidStartProvisionalLoad IPC in a RenderFrameHost. The RenderFrameHost owns |
| 22 // the newly created NavigationHandleImpl as long as the navigation is ongoing. | 24 // the newly created NavigationHandleImpl as long as the navigation is ongoing. |
| (...skipping 22 matching lines...) Expand all Loading... |
| 45 // NavigationRequest. It is then owned by the NavigationRequest until the | 47 // NavigationRequest. It is then owned by the NavigationRequest until the |
| 46 // navigation is ready to commit. The NavigationHandleImpl ownership is then | 48 // navigation is ready to commit. The NavigationHandleImpl ownership is then |
| 47 // transferred to the RenderFrameHost in which the navigation will commit. | 49 // transferred to the RenderFrameHost in which the navigation will commit. |
| 48 // | 50 // |
| 49 // When PlzNavigate is enabled, the NavigationHandleImpl will never be reset | 51 // When PlzNavigate is enabled, the NavigationHandleImpl will never be reset |
| 50 // following the receipt of a DidStartProvisionalLoad IPC. There are also no | 52 // following the receipt of a DidStartProvisionalLoad IPC. There are also no |
| 51 // transferring navigations. The other causes of NavigationHandleImpl reset in | 53 // transferring navigations. The other causes of NavigationHandleImpl reset in |
| 52 // the RenderFrameHost still apply. | 54 // the RenderFrameHost still apply. |
| 53 class CONTENT_EXPORT NavigationHandleImpl : public NavigationHandle { | 55 class CONTENT_EXPORT NavigationHandleImpl : public NavigationHandle { |
| 54 public: | 56 public: |
| 55 static scoped_ptr<NavigationHandleImpl> Create(const GURL& url, | |
| 56 const bool is_main_frame, | |
| 57 NavigatorDelegate* delegate); | |
| 58 | |
| 59 ~NavigationHandleImpl() override; | 57 ~NavigationHandleImpl() override; |
| 60 | 58 |
| 61 // NavigationHandle implementation: | 59 // NavigationHandle implementation: |
| 62 const GURL& GetURL() const override; | 60 const GURL& GetURL() const override; |
| 61 const GURL& GetValidatedURL() const override; |
| 62 WebContents* GetWebContents() const override; |
| 63 bool IsInMainFrame() const override; |
| 64 bool IsPost() const override; |
| 65 const Referrer& GetReferrer() const override; |
| 66 bool HasUserGesture() const override; |
| 67 ui::PageTransition GetPageTransition() const override; |
| 68 bool IsExternalProtocol() const override; |
| 63 net::Error GetNetErrorCode() const override; | 69 net::Error GetNetErrorCode() const override; |
| 64 bool IsInMainFrame() const override; | |
| 65 bool HasCommittedDocument() const override; | 70 bool HasCommittedDocument() const override; |
| 66 bool HasCommittedErrorPage() const override; | 71 bool HasCommittedErrorPage() const override; |
| 72 void RegisterThrottleForTesting( |
| 73 scoped_ptr<NavigationThrottle> navigation_throttle) override; |
| 67 | 74 |
| 68 void set_net_error_code(net::Error net_error_code) { | 75 void set_net_error_code(net::Error net_error_code) { |
| 69 net_error_code_ = net_error_code; | 76 net_error_code_ = net_error_code; |
| 70 } | 77 } |
| 71 | 78 |
| 72 // Returns whether the navigation is currently being transferred from one | 79 // Returns whether the navigation is currently being transferred from one |
| 73 // RenderFrameHost to another. In particular, a DidStartProvisionalLoad IPC | 80 // RenderFrameHost to another. In particular, a DidStartProvisionalLoad IPC |
| 74 // for the navigation URL, received in the new RenderFrameHost, should not | 81 // for the navigation URL, received in the new RenderFrameHost, should not |
| 75 // indicate the start of a new navigation in that case. | 82 // indicate the start of a new navigation in that case. |
| 76 bool is_transferring() const { return is_transferring_; } | 83 bool is_transferring() const { return is_transferring_; } |
| 77 void set_is_transferring(bool is_transferring) { | 84 void set_is_transferring(bool is_transferring) { |
| 78 is_transferring_ = is_transferring; | 85 is_transferring_ = is_transferring; |
| 79 } | 86 } |
| 80 | 87 |
| 88 void set_web_contents(WebContents* web_contents) { |
| 89 web_contents_ = web_contents; |
| 90 } |
| 91 |
| 92 // Called when the URLRequest will start in the network stack. |
| 93 NavigationThrottle::ThrottleCheckResult WillStartRequest( |
| 94 bool is_post, |
| 95 const Referrer& sanitized_referrer, |
| 96 bool has_user_gesture, |
| 97 ui::PageTransition transition, |
| 98 bool is_external_protocol); |
| 99 |
| 100 // Called when the URLRequest will be redirected in the network stack. |
| 101 NavigationThrottle::ThrottleCheckResult WillRedirectRequest( |
| 102 const GURL& new_url, |
| 103 const GURL& new_validated_url, |
| 104 bool new_method_is_post, |
| 105 const GURL& new_referrer_url, |
| 106 bool new_is_external_protocol); |
| 107 |
| 81 // Called when the navigation was redirected. This will update the |url_| and | 108 // Called when the navigation was redirected. This will update the |url_| and |
| 82 // inform the delegate. | 109 // inform the delegate. |
| 83 void DidRedirectNavigation(const GURL& new_url); | 110 void DidRedirectNavigation(const GURL& new_url); |
| 84 | 111 |
| 85 // Called when the navigation was committed. This will update the |state_| | 112 // Called when the navigation was committed. This will update the |state_| |
| 86 // and inform the delegate, | 113 // and inform the delegate, |
| 87 void DidCommitNavigation(); | 114 void DidCommitNavigation(); |
| 88 | 115 |
| 89 private: | 116 private: |
| 117 friend class NavigationHandleFactory; |
| 118 friend class TestNavigationHandle; |
| 119 |
| 90 // Used to track the state the navigation is currently in. | 120 // Used to track the state the navigation is currently in. |
| 91 enum State { | 121 enum State { |
| 92 DID_START = 0, | 122 DID_START = 0, |
| 123 WILL_SEND_REQUEST, |
| 93 DID_COMMIT, | 124 DID_COMMIT, |
| 94 DID_COMMIT_ERROR_PAGE, | 125 DID_COMMIT_ERROR_PAGE, |
| 95 }; | 126 }; |
| 96 | 127 |
| 97 NavigationHandleImpl(const GURL& url, | 128 NavigationHandleImpl(const GURL& url, |
| 129 const GURL& validated_url, |
| 98 const bool is_main_frame, | 130 const bool is_main_frame, |
| 99 NavigatorDelegate* delegate); | 131 NavigatorDelegate* delegate); |
| 100 | 132 |
| 101 // See NavigationHandle for a description of those member variables. | 133 // See NavigationHandle for a description of those member variables. |
| 102 GURL url_; | 134 GURL url_; |
| 135 GURL validated_url_; |
| 136 const bool is_main_frame_; |
| 137 bool is_post_; |
| 138 Referrer sanitized_referrer_; |
| 139 bool has_user_gesture_; |
| 140 ui::PageTransition transition_; |
| 141 bool is_external_protocol_; |
| 103 net::Error net_error_code_; | 142 net::Error net_error_code_; |
| 143 |
| 144 // The state the navigation is in. |
| 104 State state_; | 145 State state_; |
| 105 const bool is_main_frame_; | |
| 106 | 146 |
| 107 // Whether the navigation is in the middle of a transfer. Set to false when | 147 // Whether the navigation is in the middle of a transfer. Set to false when |
| 108 // the DidStartProvisionalLoad is received from the new renderer. | 148 // the DidStartProvisionalLoad is received from the new renderer. |
| 109 bool is_transferring_; | 149 bool is_transferring_; |
| 110 | 150 |
| 111 // The delegate that should be notified about events related to this | 151 // The delegate that should be notified about events related to this |
| 112 // navigation. | 152 // navigation. |
| 113 NavigatorDelegate* delegate_; | 153 NavigatorDelegate* delegate_; |
| 114 | 154 |
| 155 // A pointer to the WebContents the navigation is taking place in. |
| 156 WebContents* web_contents_; |
| 157 |
| 158 // A list of Throttles registered for this navigation. |
| 159 ScopedVector<NavigationThrottle> throttles_; |
| 160 |
| 115 DISALLOW_COPY_AND_ASSIGN(NavigationHandleImpl); | 161 DISALLOW_COPY_AND_ASSIGN(NavigationHandleImpl); |
| 116 }; | 162 }; |
| 117 | 163 |
| 118 } // namespace content | 164 } // namespace content |
| 119 | 165 |
| 120 #endif // CONTENT_BROWSER_FRAME_HOST_NAVIGATION_HANDLE_IMPL_H_ | 166 #endif // CONTENT_BROWSER_FRAME_HOST_NAVIGATION_HANDLE_IMPL_H_ |
| OLD | NEW |