chrome/browser/net/chrome_network_delegate.h

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