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 23 matching lines...) Expand all Loading... | |
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, | 57 static scoped_ptr<NavigationHandleImpl> Create(const GURL& url, |
56 const bool is_main_frame, | 58 bool is_main_frame, |
57 NavigatorDelegate* delegate); | 59 NavigatorDelegate* delegate); |
58 | |
59 ~NavigationHandleImpl() override; | 60 ~NavigationHandleImpl() override; |
60 | 61 |
61 // NavigationHandle implementation: | 62 // NavigationHandle implementation: |
62 const GURL& GetURL() const override; | 63 const GURL& GetURL() override; |
63 net::Error GetNetErrorCode() const override; | 64 bool IsInMainFrame() override; |
64 bool IsInMainFrame() const override; | 65 bool IsPost() override; |
65 bool HasCommittedDocument() const override; | 66 const Referrer& GetReferrer() override; |
66 bool HasCommittedErrorPage() const override; | 67 bool HasUserGesture() override; |
68 ui::PageTransition GetPageTransition() override; | |
69 bool IsExternalProtocol() override; | |
70 net::Error GetNetErrorCode() override; | |
71 bool HasCommittedDocument() override; | |
72 bool HasCommittedErrorPage() override; | |
73 void RegisterThrottleForTesting( | |
74 scoped_ptr<NavigationThrottle> navigation_throttle) override; | |
75 NavigationThrottle::ThrottleCheckResult CallWillStartRequestForTesting( | |
76 bool is_post, | |
77 const Referrer& sanitized_referrer, | |
78 bool has_user_gesture, | |
79 ui::PageTransition transition, | |
80 bool is_external_protocol) override; | |
81 NavigationThrottle::ThrottleCheckResult CallWillRedirectRequestForTesting( | |
82 const GURL& new_url, | |
83 bool new_method_is_post, | |
84 const GURL& new_referrer_url, | |
85 bool new_is_external_protocol) override; | |
86 | |
87 NavigatorDelegate* delegate() const { | |
88 return delegate_; | |
89 } | |
67 | 90 |
68 void set_net_error_code(net::Error net_error_code) { | 91 void set_net_error_code(net::Error net_error_code) { |
69 net_error_code_ = net_error_code; | 92 net_error_code_ = net_error_code; |
70 } | 93 } |
71 | 94 |
72 // Returns whether the navigation is currently being transferred from one | 95 // Returns whether the navigation is currently being transferred from one |
73 // RenderFrameHost to another. In particular, a DidStartProvisionalLoad IPC | 96 // RenderFrameHost to another. In particular, a DidStartProvisionalLoad IPC |
74 // for the navigation URL, received in the new RenderFrameHost, should not | 97 // for the navigation URL, received in the new RenderFrameHost, should not |
75 // indicate the start of a new navigation in that case. | 98 // indicate the start of a new navigation in that case. |
76 bool is_transferring() const { return is_transferring_; } | 99 bool is_transferring() const { return is_transferring_; } |
77 void set_is_transferring(bool is_transferring) { | 100 void set_is_transferring(bool is_transferring) { |
78 is_transferring_ = is_transferring; | 101 is_transferring_ = is_transferring; |
79 } | 102 } |
80 | 103 |
104 // Called when the URLRequest will start in the network stack. | |
105 NavigationThrottle::ThrottleCheckResult WillStartRequest( | |
106 bool is_post, | |
107 const Referrer& sanitized_referrer, | |
108 bool has_user_gesture, | |
109 ui::PageTransition transition, | |
110 bool is_external_protocol); | |
111 | |
112 // Called when the URLRequest will be redirected in the network stack. | |
113 NavigationThrottle::ThrottleCheckResult WillRedirectRequest( | |
114 const GURL& new_url, | |
115 bool new_method_is_post, | |
116 const GURL& new_referrer_url, | |
117 bool new_is_external_protocol); | |
118 | |
81 // Called when the navigation was redirected. This will update the |url_| and | 119 // Called when the navigation was redirected. This will update the |url_| and |
82 // inform the delegate. | 120 // inform the delegate. |
83 void DidRedirectNavigation(const GURL& new_url); | 121 void DidRedirectNavigation(const GURL& new_url); |
84 | 122 |
85 // Called when the navigation was committed. This will update the |state_| | 123 // Called when the navigation was committed. This will update the |state_| |
86 // and inform the delegate, | 124 // and inform the delegate, |
87 void DidCommitNavigation(); | 125 void DidCommitNavigation(); |
88 | 126 |
89 private: | 127 private: |
128 friend class NavigationHandleFactory; | |
129 friend class TestNavigationHandle; | |
Charlie Reis
2015/09/18 05:40:02
Don't forget to remove these.
clamy
2015/09/18 17:35:39
Done.
| |
130 | |
90 // Used to track the state the navigation is currently in. | 131 // Used to track the state the navigation is currently in. |
91 enum State { | 132 enum State { |
92 DID_START = 0, | 133 DID_START = 0, |
134 WILL_SEND_REQUEST, | |
93 DID_COMMIT, | 135 DID_COMMIT, |
94 DID_COMMIT_ERROR_PAGE, | 136 DID_COMMIT_ERROR_PAGE, |
95 }; | 137 }; |
96 | 138 |
97 NavigationHandleImpl(const GURL& url, | 139 NavigationHandleImpl(const GURL& url, |
98 const bool is_main_frame, | 140 const bool is_main_frame, |
99 NavigatorDelegate* delegate); | 141 NavigatorDelegate* delegate); |
100 | 142 |
101 // See NavigationHandle for a description of those member variables. | 143 // See NavigationHandle for a description of those member variables. |
102 GURL url_; | 144 GURL url_; |
145 const bool is_main_frame_; | |
146 bool is_post_; | |
147 Referrer sanitized_referrer_; | |
148 bool has_user_gesture_; | |
149 ui::PageTransition transition_; | |
150 bool is_external_protocol_; | |
103 net::Error net_error_code_; | 151 net::Error net_error_code_; |
152 | |
153 // The state the navigation is in. | |
104 State state_; | 154 State state_; |
105 const bool is_main_frame_; | |
106 | 155 |
107 // Whether the navigation is in the middle of a transfer. Set to false when | 156 // Whether the navigation is in the middle of a transfer. Set to false when |
108 // the DidStartProvisionalLoad is received from the new renderer. | 157 // the DidStartProvisionalLoad is received from the new renderer. |
109 bool is_transferring_; | 158 bool is_transferring_; |
110 | 159 |
111 // The delegate that should be notified about events related to this | 160 // The delegate that should be notified about events related to this |
112 // navigation. | 161 // navigation. |
113 NavigatorDelegate* delegate_; | 162 NavigatorDelegate* delegate_; |
114 | 163 |
164 // A list of Throttles registered for this navigation. | |
165 ScopedVector<NavigationThrottle> throttles_; | |
166 | |
115 DISALLOW_COPY_AND_ASSIGN(NavigationHandleImpl); | 167 DISALLOW_COPY_AND_ASSIGN(NavigationHandleImpl); |
116 }; | 168 }; |
117 | 169 |
118 } // namespace content | 170 } // namespace content |
119 | 171 |
120 #endif // CONTENT_BROWSER_FRAME_HOST_NAVIGATION_HANDLE_IMPL_H_ | 172 #endif // CONTENT_BROWSER_FRAME_HOST_NAVIGATION_HANDLE_IMPL_H_ |
OLD | NEW |