chrome_network_delegate.h revision 5821806d5e7f356e8fa4b058a389a808ea183019
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CHROME_BROWSER_NET_CHROME_NETWORK_DELEGATE_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_BROWSER_NET_CHROME_NETWORK_DELEGATE_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/ref_counted.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/values.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/base/network_delegate.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class CookieSettings; 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ExtensionInfoMap; 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ManagedModeURLFilter; 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class PrefService; 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)template<class T> class PrefMember; 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef PrefMember<bool> BooleanPrefMember; 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base { 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Value; 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace chrome_browser_net { 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class LoadTimeStats; 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace extensions { 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class EventRouterForwarder; 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace net { 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class URLRequest; 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace policy { 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class URLBlacklistManager; 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ChromeNetworkDelegate is the central point from within the chrome code to 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// add hooks into the network stack. 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ChromeNetworkDelegate : public net::NetworkDelegate { 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If |profile| is NULL, events will be broadcasted to all profiles, 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // otherwise they will only be sent to the specified profile. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |enable_referrers| and |enable_do_not_track| should be initialized on the 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // UI thread (see below) beforehand. This object's owner is responsible for 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // cleaning it up at shutdown. |enable_do_not_track| can be NULL. 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If |cookie_settings| is NULL, all cookies are enabled, otherwise, the 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // settings are enforced on all observed network requests. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ChromeNetworkDelegate( 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) extensions::EventRouterForwarder* event_router, 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExtensionInfoMap* extension_info_map, 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const policy::URLBlacklistManager* url_blacklist_manager, 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ManagedModeURLFilter* managed_mode_url_filter, 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void* profile, 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) CookieSettings* cookie_settings, 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BooleanPrefMember* enable_referrers, 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BooleanPrefMember* enable_do_not_track, 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BooleanPrefMember* force_google_safe_search, 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) chrome_browser_net::LoadTimeStats* load_time_stats); 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~ChromeNetworkDelegate(); 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Causes |OnCanThrottleRequest| to always return false, for all 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // instances of this object. 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void NeverThrottleRequests(); 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Binds the pref members to |pref_service| and moves them to the IO thread. 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |enable_do_not_track| can be NULL. 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This method should be called on the UI thread. 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void InitializePrefsOnUIThread( 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BooleanPrefMember* enable_referrers, 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BooleanPrefMember* enable_do_not_track, 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BooleanPrefMember* force_google_safe_search, 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PrefService* pref_service); 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // When called, all file:// URLs will now be accessible. If this is not 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // called, then some platforms restrict access to file:// paths. 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void AllowAccessToAllFiles(); 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a Value summary of the persistent state of the network session. 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The caller is responsible for deleting the returned value. 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Must be called on the UI thread. 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static Value* HistoricNetworkStatsInfoToValue(); 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a Value summary of the state of the network session. The caller is 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // responsible for deleting the returned value. 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Value* SessionNetworkStatsInfoToValue() const; 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class ChromeNetworkDelegateTest; 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NetworkDelegate implementation. 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int OnBeforeURLRequest(net::URLRequest* request, 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const net::CompletionCallback& callback, 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GURL* new_url) OVERRIDE; 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int OnBeforeSendHeaders(net::URLRequest* request, 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const net::CompletionCallback& callback, 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) net::HttpRequestHeaders* headers) OVERRIDE; 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnSendHeaders(net::URLRequest* request, 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const net::HttpRequestHeaders& headers) OVERRIDE; 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int OnHeadersReceived( 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) net::URLRequest* request, 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const net::CompletionCallback& callback, 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const net::HttpResponseHeaders* original_response_headers, 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_refptr<net::HttpResponseHeaders>* override_response_headers) 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) OVERRIDE; 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnBeforeRedirect(net::URLRequest* request, 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const GURL& new_location) OVERRIDE; 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnResponseStarted(net::URLRequest* request) OVERRIDE; 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnRawBytesRead(const net::URLRequest& request, 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int bytes_read) OVERRIDE; 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnCompleted(net::URLRequest* request, bool started) OVERRIDE; 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnURLRequestDestroyed(net::URLRequest* request) OVERRIDE; 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnPACScriptError(int line_number, 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string16& error) OVERRIDE; 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual net::NetworkDelegate::AuthRequiredResponse OnAuthRequired( 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) net::URLRequest* request, 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const net::AuthChallengeInfo& auth_info, 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const AuthCallback& callback, 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) net::AuthCredentials* credentials) OVERRIDE; 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OnCanGetCookies(const net::URLRequest& request, 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const net::CookieList& cookie_list) OVERRIDE; 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OnCanSetCookie(const net::URLRequest& request, 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& cookie_line, 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) net::CookieOptions* options) OVERRIDE; 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OnCanAccessFile(const net::URLRequest& request, 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const FilePath& path) const OVERRIDE; 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OnCanThrottleRequest( 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const net::URLRequest& request) const OVERRIDE; 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual int OnBeforeSocketStreamConnect( 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) net::SocketStream* stream, 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const net::CompletionCallback& callback) OVERRIDE; 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnRequestWaitStateChange(const net::URLRequest& request, 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) RequestWaitState state) OVERRIDE; 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AccumulateContentLength( 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 received_payload_byte_count, int64 original_payload_byte_count); 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_refptr<extensions::EventRouterForwarder> event_router_; 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void* profile_; 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_refptr<CookieSettings> cookie_settings_; 1475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_refptr<ExtensionInfoMap> extension_info_map_; 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Weak, owned by our owner. 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BooleanPrefMember* enable_referrers_; 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BooleanPrefMember* enable_do_not_track_; 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) BooleanPrefMember* force_google_safe_search_; 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Weak, owned by our owner. 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const policy::URLBlacklistManager* url_blacklist_manager_; 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Weak pointer. The owner of this object needs to make sure that the 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |managed_mode_url_filter_| outlives it. 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ManagedModeURLFilter* managed_mode_url_filter_; 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // When true, allow access to all file:// URLs. 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool g_allow_file_access_; 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // True if OnCanThrottleRequest should always return false. 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Note: This needs to be static as the instance of 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ChromeNetworkDelegate used may change over time, and we need to 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // set this variable once at start-up time. It is effectively 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // static anyway since it is based on a command-line flag. 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool g_never_throttle_requests_; 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Pointer to IOThread global, should outlive ChromeNetworkDelegate. 1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) chrome_browser_net::LoadTimeStats* load_time_stats_; 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Total size of all content (excluding headers) that has been received 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // over the network. 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 received_content_length_; 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Total original size of all content before it was transferred. 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int64 original_content_length_; 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(ChromeNetworkDelegate); 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_BROWSER_NET_CHROME_NETWORK_DELEGATE_H_ 187