| OLD | NEW |
|---|
| (Empty) |
| 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | |
| 2 // Use of this source code is governed by a BSD-style license that can be | |
| 3 // found in the LICENSE file. | |
| 4 | |
| 5 #ifndef NET_BASE_NETWORK_DELEGATE_H_ | |
| 6 #define NET_BASE_NETWORK_DELEGATE_H_ | |
| 7 | |
| 8 #include <string> | |
| 9 | |
| 10 #include "base/callback.h" | |
| 11 #include "base/strings/string16.h" | |
| 12 #include "base/threading/non_thread_safe.h" | |
| 13 #include "net/base/auth.h" | |
| 14 #include "net/base/completion_callback.h" | |
| 15 #include "net/cookies/canonical_cookie.h" | |
| 16 | |
| 17 class GURL; | |
| 18 | |
| 19 namespace base { | |
| 20 class FilePath; | |
| 21 } | |
| 22 | |
| 23 namespace net { | |
| 24 | |
| 25 // NOTE: Layering violations! | |
| 26 // We decided to accept these violations (depending | |
| 27 // on other net/ submodules from net/base/), because otherwise NetworkDelegate | |
| 28 // would have to be broken up into too many smaller interfaces targeted to each | |
| 29 // submodule. Also, since the lower levels in net/ may callback into higher | |
| 30 // levels, we may encounter dangerous casting issues. | |
| 31 // | |
| 32 // NOTE: It is not okay to add any compile-time dependencies on symbols outside | |
| 33 // of net/base here, because we have a net_base library. Forward declarations | |
| 34 // are ok. | |
| 35 class CookieOptions; | |
| 36 class HttpRequestHeaders; | |
| 37 class HttpResponseHeaders; | |
| 38 class ProxyInfo; | |
| 39 class ProxyServer; | |
| 40 class ProxyService; | |
| 41 class URLRequest; | |
| 42 | |
| 43 class NET_EXPORT NetworkDelegate : public base::NonThreadSafe { | |
| 44 public: | |
| 45 // AuthRequiredResponse indicates how a NetworkDelegate handles an | |
| 46 // OnAuthRequired call. It's placed in this file to prevent url_request.h | |
| 47 // from having to include network_delegate.h. | |
| 48 enum AuthRequiredResponse { | |
| 49 AUTH_REQUIRED_RESPONSE_NO_ACTION, | |
| 50 AUTH_REQUIRED_RESPONSE_SET_AUTH, | |
| 51 AUTH_REQUIRED_RESPONSE_CANCEL_AUTH, | |
| 52 AUTH_REQUIRED_RESPONSE_IO_PENDING, | |
| 53 }; | |
| 54 typedef base::Callback<void(AuthRequiredResponse)> AuthCallback; | |
| 55 | |
| 56 virtual ~NetworkDelegate() {} | |
| 57 | |
| 58 // Notification interface called by the network stack. Note that these | |
| 59 // functions mostly forward to the private virtuals. They also add some sanity | |
| 60 // checking on parameters. See the corresponding virtuals for explanations of | |
| 61 // the methods and their arguments. | |
| 62 int NotifyBeforeURLRequest(URLRequest* request, | |
| 63 const CompletionCallback& callback, | |
| 64 GURL* new_url); | |
| 65 void NotifyResolveProxy(const GURL& url, | |
| 66 int load_flags, | |
| 67 const ProxyService& proxy_service, | |
| 68 ProxyInfo* result); | |
| 69 void NotifyProxyFallback(const ProxyServer& bad_proxy, | |
| 70 int net_error); | |
| 71 int NotifyBeforeSendHeaders(URLRequest* request, | |
| 72 const CompletionCallback& callback, | |
| 73 HttpRequestHeaders* headers); | |
| 74 void NotifyBeforeSendProxyHeaders(URLRequest* request, | |
| 75 const ProxyInfo& proxy_info, | |
| 76 HttpRequestHeaders* headers); | |
| 77 void NotifySendHeaders(URLRequest* request, | |
| 78 const HttpRequestHeaders& headers); | |
| 79 int NotifyHeadersReceived( | |
| 80 URLRequest* request, | |
| 81 const CompletionCallback& callback, | |
| 82 const HttpResponseHeaders* original_response_headers, | |
| 83 scoped_refptr<HttpResponseHeaders>* override_response_headers, | |
| 84 GURL* allowed_unsafe_redirect_url); | |
| 85 void NotifyBeforeRedirect(URLRequest* request, | |
| 86 const GURL& new_location); | |
| 87 void NotifyResponseStarted(URLRequest* request); | |
| 88 void NotifyRawBytesRead(const URLRequest& request, int bytes_read); | |
| 89 void NotifyCompleted(URLRequest* request, bool started); | |
| 90 void NotifyURLRequestDestroyed(URLRequest* request); | |
| 91 void NotifyPACScriptError(int line_number, const base::string16& error); | |
| 92 AuthRequiredResponse NotifyAuthRequired(URLRequest* request, | |
| 93 const AuthChallengeInfo& auth_info, | |
| 94 const AuthCallback& callback, | |
| 95 AuthCredentials* credentials); | |
| 96 bool CanGetCookies(const URLRequest& request, | |
| 97 const CookieList& cookie_list); | |
| 98 bool CanSetCookie(const URLRequest& request, | |
| 99 const std::string& cookie_line, | |
| 100 CookieOptions* options); | |
| 101 bool CanAccessFile(const URLRequest& request, | |
| 102 const base::FilePath& path) const; | |
| 103 bool CanThrottleRequest(const URLRequest& request) const; | |
| 104 bool CanEnablePrivacyMode(const GURL& url, | |
| 105 const GURL& first_party_for_cookies) const; | |
| 106 | |
| 107 bool CancelURLRequestWithPolicyViolatingReferrerHeader( | |
| 108 const URLRequest& request, | |
| 109 const GURL& target_url, | |
| 110 const GURL& referrer_url) const; | |
| 111 | |
| 112 private: | |
| 113 // This is the interface for subclasses of NetworkDelegate to implement. These | |
| 114 // member functions will be called by the respective public notification | |
| 115 // member function, which will perform basic sanity checking. | |
| 116 | |
| 117 // Called before a request is sent. Allows the delegate to rewrite the URL | |
| 118 // being fetched by modifying |new_url|. If set, the URL must be valid. The | |
| 119 // reference fragment from the original URL is not automatically appended to | |
| 120 // |new_url|; callers are responsible for copying the reference fragment if | |
| 121 // desired. | |
| 122 // |callback| and |new_url| are valid only until OnURLRequestDestroyed is | |
| 123 // called for this request. Returns a net status code, generally either OK to | |
| 124 // continue with the request or ERR_IO_PENDING if the result is not ready yet. | |
| 125 // A status code other than OK and ERR_IO_PENDING will cancel the request and | |
| 126 // report the status code as the reason. | |
| 127 // | |
| 128 // The default implementation returns OK (continue with request). | |
| 129 virtual int OnBeforeURLRequest(URLRequest* request, | |
| 130 const CompletionCallback& callback, | |
| 131 GURL* new_url) = 0; | |
| 132 | |
| 133 // Called as the proxy is being resolved for |url|. Allows the delegate to | |
| 134 // override the proxy resolution decision made by ProxyService. The delegate | |
| 135 // may override the decision by modifying the ProxyInfo |result|. | |
| 136 virtual void OnResolveProxy(const GURL& url, | |
| 137 int load_flags, | |
| 138 const ProxyService& proxy_service, | |
| 139 ProxyInfo* result) = 0; | |
| 140 | |
| 141 // Called when use of |bad_proxy| fails due to |net_error|. |net_error| is | |
| 142 // the network error encountered, if any, and OK if the fallback was | |
| 143 // for a reason other than a network error (e.g. the proxy service was | |
| 144 // explicitly directed to skip a proxy). | |
| 145 virtual void OnProxyFallback(const ProxyServer& bad_proxy, int net_error) = 0; | |
| 146 | |
| 147 // Called right before the HTTP headers are sent. Allows the delegate to | |
| 148 // read/write |headers| before they get sent out. |callback| and |headers| are | |
| 149 // valid only until OnCompleted or OnURLRequestDestroyed is called for this | |
| 150 // request. | |
| 151 // See OnBeforeURLRequest for return value description. Returns OK by default. | |
| 152 virtual int OnBeforeSendHeaders(URLRequest* request, | |
| 153 const CompletionCallback& callback, | |
| 154 HttpRequestHeaders* headers) = 0; | |
| 155 | |
| 156 // Called after a proxy connection. Allows the delegate to read/write | |
| 157 // |headers| before they get sent out. |headers| is valid only until | |
| 158 // OnCompleted or OnURLRequestDestroyed is called for this request. | |
| 159 virtual void OnBeforeSendProxyHeaders(URLRequest* request, | |
| 160 const ProxyInfo& proxy_info, | |
| 161 HttpRequestHeaders* headers) = 0; | |
| 162 | |
| 163 // Called right before the HTTP request(s) are being sent to the network. | |
| 164 // |headers| is only valid until OnCompleted or OnURLRequestDestroyed is | |
| 165 // called for this request. | |
| 166 virtual void OnSendHeaders(URLRequest* request, | |
| 167 const HttpRequestHeaders& headers) = 0; | |
| 168 | |
| 169 // Called for HTTP requests when the headers have been received. | |
| 170 // |original_response_headers| contains the headers as received over the | |
| 171 // network, these must not be modified. |override_response_headers| can be set | |
| 172 // to new values, that should be considered as overriding | |
| 173 // |original_response_headers|. | |
| 174 // If the response is a redirect, and the Location response header value is | |
| 175 // identical to |allowed_unsafe_redirect_url|, then the redirect is never | |
| 176 // blocked and the reference fragment is not copied from the original URL | |
| 177 // to the redirection target. | |
| 178 // | |
| 179 // |callback|, |original_response_headers|, and |override_response_headers| | |
| 180 // are only valid until OnURLRequestDestroyed is called for this request. | |
| 181 // See OnBeforeURLRequest for return value description. Returns OK by default. | |
| 182 virtual int OnHeadersReceived( | |
| 183 URLRequest* request, | |
| 184 const CompletionCallback& callback, | |
| 185 const HttpResponseHeaders* original_response_headers, | |
| 186 scoped_refptr<HttpResponseHeaders>* override_response_headers, | |
| 187 GURL* allowed_unsafe_redirect_url) = 0; | |
| 188 | |
| 189 // Called right after a redirect response code was received. | |
| 190 // |new_location| is only valid until OnURLRequestDestroyed is called for this | |
| 191 // request. | |
| 192 virtual void OnBeforeRedirect(URLRequest* request, | |
| 193 const GURL& new_location) = 0; | |
| 194 | |
| 195 // This corresponds to URLRequestDelegate::OnResponseStarted. | |
| 196 virtual void OnResponseStarted(URLRequest* request) = 0; | |
| 197 | |
| 198 // Called every time we read raw bytes. | |
| 199 virtual void OnRawBytesRead(const URLRequest& request, int bytes_read) = 0; | |
| 200 | |
| 201 // Indicates that the URL request has been completed or failed. | |
| 202 // |started| indicates whether the request has been started. If false, | |
| 203 // some information like the socket address is not available. | |
| 204 virtual void OnCompleted(URLRequest* request, bool started) = 0; | |
| 205 | |
| 206 // Called when an URLRequest is being destroyed. Note that the request is | |
| 207 // being deleted, so it's not safe to call any methods that may result in | |
| 208 // a virtual method call. | |
| 209 virtual void OnURLRequestDestroyed(URLRequest* request) = 0; | |
| 210 | |
| 211 // Corresponds to ProxyResolverJSBindings::OnError. | |
| 212 virtual void OnPACScriptError(int line_number, | |
| 213 const base::string16& error) = 0; | |
| 214 | |
| 215 // Called when a request receives an authentication challenge | |
| 216 // specified by |auth_info|, and is unable to respond using cached | |
| 217 // credentials. |callback| and |credentials| must be non-NULL, and must | |
| 218 // be valid until OnURLRequestDestroyed is called for |request|. | |
| 219 // | |
| 220 // The following return values are allowed: | |
| 221 // - AUTH_REQUIRED_RESPONSE_NO_ACTION: |auth_info| is observed, but | |
| 222 // no action is being taken on it. | |
| 223 // - AUTH_REQUIRED_RESPONSE_SET_AUTH: |credentials| is filled in with | |
| 224 // a username and password, which should be used in a response to | |
| 225 // |auth_info|. | |
| 226 // - AUTH_REQUIRED_RESPONSE_CANCEL_AUTH: The authentication challenge | |
| 227 // should not be attempted. | |
| 228 // - AUTH_REQUIRED_RESPONSE_IO_PENDING: The action will be decided | |
| 229 // asynchronously. |callback| will be invoked when the decision is made, | |
| 230 // and one of the other AuthRequiredResponse values will be passed in with | |
| 231 // the same semantics as described above. | |
| 232 virtual AuthRequiredResponse OnAuthRequired( | |
| 233 URLRequest* request, | |
| 234 const AuthChallengeInfo& auth_info, | |
| 235 const AuthCallback& callback, | |
| 236 AuthCredentials* credentials) = 0; | |
| 237 | |
| 238 // Called when reading cookies to allow the network delegate to block access | |
| 239 // to the cookie. This method will never be invoked when | |
| 240 // LOAD_DO_NOT_SEND_COOKIES is specified. | |
| 241 virtual bool OnCanGetCookies(const URLRequest& request, | |
| 242 const CookieList& cookie_list) = 0; | |
| 243 | |
| 244 // Called when a cookie is set to allow the network delegate to block access | |
| 245 // to the cookie. This method will never be invoked when | |
| 246 // LOAD_DO_NOT_SAVE_COOKIES is specified. | |
| 247 virtual bool OnCanSetCookie(const URLRequest& request, | |
| 248 const std::string& cookie_line, | |
| 249 CookieOptions* options) = 0; | |
| 250 | |
| 251 // Called when a file access is attempted to allow the network delegate to | |
| 252 // allow or block access to the given file path. Returns true if access is | |
| 253 // allowed. | |
| 254 virtual bool OnCanAccessFile(const URLRequest& request, | |
| 255 const base::FilePath& path) const = 0; | |
| 256 | |
| 257 // Returns true if the given request may be rejected when the | |
| 258 // URLRequestThrottlerManager believes the server servicing the | |
| 259 // request is overloaded or down. | |
| 260 virtual bool OnCanThrottleRequest(const URLRequest& request) const = 0; | |
| 261 | |
| 262 // Returns true if the given |url| has to be requested over connection that | |
| 263 // is not tracked by the server. Usually is false, unless user privacy | |
| 264 // settings block cookies from being get or set. | |
| 265 virtual bool OnCanEnablePrivacyMode( | |
| 266 const GURL& url, | |
| 267 const GURL& first_party_for_cookies) const = 0; | |
| 268 | |
| 269 // Called when the |referrer_url| for requesting |target_url| during handling | |
| 270 // of the |request| is does not comply with the referrer policy (e.g. a | |
| 271 // secure referrer for an insecure initial target). | |
| 272 // Returns true if the request should be cancelled. Otherwise, the referrer | |
| 273 // header is stripped from the request. | |
| 274 virtual bool OnCancelURLRequestWithPolicyViolatingReferrerHeader( | |
| 275 const URLRequest& request, | |
| 276 const GURL& target_url, | |
| 277 const GURL& referrer_url) const = 0; | |
| 278 }; | |
| 279 | |
| 280 } // namespace net | |
| 281 | |
| 282 #endif // NET_BASE_NETWORK_DELEGATE_H_ | |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 992733002:
Remove //net (except for Android test stuff) and sdch (Closed)
Base URL: git@github.com:domokit/mojo.git@master