chrome_network_delegate.h revision f8ee788a64d60abd8f2d742a5fdedde054ecd910 
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 CHROME_BROWSER_NET_CHROME_NETWORK_DELEGATE_H_
6#define CHROME_BROWSER_NET_CHROME_NETWORK_DELEGATE_H_
7
8#include <string>
9
10#include "base/basictypes.h"
11#include "base/compiler_specific.h"
12#include "base/files/file_path.h"
13#include "base/memory/ref_counted.h"
14#include "base/memory/scoped_ptr.h"
15#include "base/values.h"
16#include "components/data_reduction_proxy/browser/data_reduction_proxy_metrics.h"
17#include "net/base/network_delegate.h"
18
19class ClientHints;
20class CookieSettings;
21class PrefService;
22template<class T> class PrefMember;
23
24typedef PrefMember<bool> BooleanPrefMember;
25
26namespace base {
27class Value;
28}
29
30namespace chrome_browser_net {
31class ConnectInterceptor;
32class Predictor;
33}
34
35namespace data_reduction_proxy {
36class DataReductionProxyParams;
37}
38
39namespace domain_reliability {
40class DomainReliabilityMonitor;
41}  // namespace domain_reliability
42
43namespace extensions {
44class EventRouterForwarder;
45class InfoMap;
46}
47
48namespace net {
49class URLRequest;
50}
51
52namespace policy {
53class URLBlacklistManager;
54}
55
56namespace prerender {
57class PrerenderTracker;
58}
59
60// ChromeNetworkDelegate is the central point from within the chrome code to
61// add hooks into the network stack.
62class ChromeNetworkDelegate : public net::NetworkDelegate {
63 public:
64  // |enable_referrers| (and all of the other optional PrefMembers) should be
65  // initialized on the UI thread (see below) beforehand. This object's owner is
66  // responsible for cleaning them up at shutdown.
67  ChromeNetworkDelegate(extensions::EventRouterForwarder* event_router,
68                        BooleanPrefMember* enable_referrers);
69  virtual ~ChromeNetworkDelegate();
70
71  // Not inlined because we assign a scoped_refptr, which requires us to include
72  // the header file.
73  void set_extension_info_map(extensions::InfoMap* extension_info_map);
74
75  void set_url_blacklist_manager(
76      const policy::URLBlacklistManager* url_blacklist_manager) {
77    url_blacklist_manager_ = url_blacklist_manager;
78  }
79
80  // If |profile| is NULL or not set, events will be broadcast to all profiles,
81  // otherwise they will only be sent to the specified profile.
82  void set_profile(void* profile) {
83    profile_ = profile;
84  }
85
86  // |profile_path| is used to locate the "Downloads" folder on Chrome OS. If it
87  // is set, the location of the Downloads folder for the profile is added to
88  // the whitelist for accesses via file: scheme.
89  void set_profile_path(const base::FilePath& profile_path) {
90    profile_path_ = profile_path;
91  }
92
93  // If |cookie_settings| is NULL or not set, all cookies are enabled,
94  // otherwise the settings are enforced on all observed network requests.
95  // Not inlined because we assign a scoped_refptr, which requires us to include
96  // the header file. Here we just forward-declare it.
97  void set_cookie_settings(CookieSettings* cookie_settings);
98
99  // Causes requested URLs to be fed to |predictor| via ConnectInterceptor.
100  void set_predictor(chrome_browser_net::Predictor* predictor);
101
102  void set_enable_do_not_track(BooleanPrefMember* enable_do_not_track) {
103    enable_do_not_track_ = enable_do_not_track;
104  }
105
106  void set_force_google_safe_search(
107      BooleanPrefMember* force_google_safe_search) {
108    force_google_safe_search_ = force_google_safe_search;
109  }
110
111  void set_domain_reliability_monitor(
112      domain_reliability::DomainReliabilityMonitor*
113          domain_reliability_monitor) {
114    domain_reliability_monitor_ = domain_reliability_monitor;
115  }
116
117  void set_prerender_tracker(prerender::PrerenderTracker* prerender_tracker) {
118    prerender_tracker_ = prerender_tracker;
119  }
120
121  void set_data_reduction_proxy_params(
122      data_reduction_proxy::DataReductionProxyParams* params) {
123    data_reduction_proxy_params_ = params;
124  }
125
126  // Adds the Client Hints header to HTTP requests.
127  void SetEnableClientHints();
128
129  // Causes |OnCanThrottleRequest| to always return false, for all
130  // instances of this object.
131  static void NeverThrottleRequests();
132
133  // Binds the pref members to |pref_service| and moves them to the IO thread.
134  // |enable_referrers| cannot be NULL, the others can.
135  // This method should be called on the UI thread.
136  static void InitializePrefsOnUIThread(
137      BooleanPrefMember* enable_referrers,
138      BooleanPrefMember* enable_do_not_track,
139      BooleanPrefMember* force_google_safe_search,
140      PrefService* pref_service);
141
142  // When called, all file:// URLs will now be accessible.  If this is not
143  // called, then some platforms restrict access to file:// paths.
144  static void AllowAccessToAllFiles();
145
146  // Creates a Value summary of the persistent state of the network session.
147  // The caller is responsible for deleting the returned value.
148  // Must be called on the UI thread.
149  static base::Value* HistoricNetworkStatsInfoToValue();
150
151  // Creates a Value summary of the state of the network session. The caller is
152  // responsible for deleting the returned value.
153  base::Value* SessionNetworkStatsInfoToValue() const;
154
155 private:
156  friend class ChromeNetworkDelegateTest;
157
158  // NetworkDelegate implementation.
159  virtual int OnBeforeURLRequest(net::URLRequest* request,
160                                 const net::CompletionCallback& callback,
161                                 GURL* new_url) OVERRIDE;
162  virtual int OnBeforeSendHeaders(net::URLRequest* request,
163                                  const net::CompletionCallback& callback,
164                                  net::HttpRequestHeaders* headers) OVERRIDE;
165  virtual void OnSendHeaders(net::URLRequest* request,
166                             const net::HttpRequestHeaders& headers) OVERRIDE;
167  virtual int OnHeadersReceived(
168      net::URLRequest* request,
169      const net::CompletionCallback& callback,
170      const net::HttpResponseHeaders* original_response_headers,
171      scoped_refptr<net::HttpResponseHeaders>* override_response_headers,
172      GURL* allowed_unsafe_redirect_url) OVERRIDE;
173  virtual void OnBeforeRedirect(net::URLRequest* request,
174                                const GURL& new_location) OVERRIDE;
175  virtual void OnResponseStarted(net::URLRequest* request) OVERRIDE;
176  virtual void OnRawBytesRead(const net::URLRequest& request,
177                              int bytes_read) OVERRIDE;
178  virtual void OnCompleted(net::URLRequest* request, bool started) OVERRIDE;
179  virtual void OnURLRequestDestroyed(net::URLRequest* request) OVERRIDE;
180  virtual void OnPACScriptError(int line_number,
181                                const base::string16& error) OVERRIDE;
182  virtual net::NetworkDelegate::AuthRequiredResponse OnAuthRequired(
183      net::URLRequest* request,
184      const net::AuthChallengeInfo& auth_info,
185      const AuthCallback& callback,
186      net::AuthCredentials* credentials) OVERRIDE;
187  virtual bool OnCanGetCookies(const net::URLRequest& request,
188                               const net::CookieList& cookie_list) OVERRIDE;
189  virtual bool OnCanSetCookie(const net::URLRequest& request,
190                              const std::string& cookie_line,
191                              net::CookieOptions* options) OVERRIDE;
192  virtual bool OnCanAccessFile(const net::URLRequest& request,
193                               const base::FilePath& path) const OVERRIDE;
194  virtual bool OnCanThrottleRequest(
195      const net::URLRequest& request) const OVERRIDE;
196  virtual bool OnCanEnablePrivacyMode(
197      const GURL& url,
198      const GURL& first_party_for_cookies) const OVERRIDE;
199  virtual int OnBeforeSocketStreamConnect(
200      net::SocketStream* stream,
201      const net::CompletionCallback& callback) OVERRIDE;
202
203  void AccumulateContentLength(
204      int64 received_payload_byte_count,
205      int64 original_payload_byte_count,
206      data_reduction_proxy::DataReductionProxyRequestType request_type);
207
208  scoped_refptr<extensions::EventRouterForwarder> event_router_;
209  void* profile_;
210  base::FilePath profile_path_;
211  scoped_refptr<CookieSettings> cookie_settings_;
212
213  scoped_refptr<extensions::InfoMap> extension_info_map_;
214
215  scoped_ptr<chrome_browser_net::ConnectInterceptor> connect_interceptor_;
216
217  // Weak, owned by our owner.
218  BooleanPrefMember* enable_referrers_;
219  BooleanPrefMember* enable_do_not_track_;
220  BooleanPrefMember* force_google_safe_search_;
221
222  // Weak, owned by our owner.
223  const policy::URLBlacklistManager* url_blacklist_manager_;
224  domain_reliability::DomainReliabilityMonitor* domain_reliability_monitor_;
225
226  // When true, allow access to all file:// URLs.
227  static bool g_allow_file_access_;
228
229  // True if OnCanThrottleRequest should always return false.
230  //
231  // Note: This needs to be static as the instance of
232  // ChromeNetworkDelegate used may change over time, and we need to
233  // set this variable once at start-up time.  It is effectively
234  // static anyway since it is based on a command-line flag.
235  static bool g_never_throttle_requests_;
236
237  // Total size of all content (excluding headers) that has been received
238  // over the network.
239  int64 received_content_length_;
240
241  // Total original size of all content before it was transferred.
242  int64 original_content_length_;
243
244  scoped_ptr<ClientHints> client_hints_;
245
246  bool first_request_;
247
248  prerender::PrerenderTracker* prerender_tracker_;
249
250  data_reduction_proxy::DataReductionProxyParams* data_reduction_proxy_params_;
251
252  DISALLOW_COPY_AND_ASSIGN(ChromeNetworkDelegate);
253};
254
255#endif  // CHROME_BROWSER_NET_CHROME_NETWORK_DELEGATE_H_
256