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.
5 #ifndef CHROME_BROWSER_PROFILES_PROFILE_IO_DATA_H_
6 #define CHROME_BROWSER_PROFILES_PROFILE_IO_DATA_H_
10 #include "base/basictypes.h"
11 #include "base/callback_forward.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/memory/weak_ptr.h"
16 #include "base/prefs/pref_member.h"
17 #include "base/synchronization/lock.h"
18 #include "chrome/browser/custom_handlers/protocol_handler_registry.h"
19 #include "chrome/browser/io_thread.h"
20 #include "chrome/browser/net/chrome_url_request_context.h"
21 #include "chrome/browser/profiles/storage_partition_descriptor.h"
22 #include "chrome/common/content_settings_types.h"
23 #include "content/public/browser/content_browser_client.h"
24 #include "content/public/browser/resource_context.h"
25 #include "net/cookies/cookie_monster.h"
26 #include "net/http/http_network_session.h"
27 #include "net/url_request/url_request_job_factory.h"
29 class ChromeHttpUserAgentSettings;
30 class ChromeNetworkDelegate;
32 class HostContentSettingsMap;
33 class ManagedModeURLFilter;
34 class MediaDeviceIDSalt;
36 class ProtocolHandlerRegistry;
37 class SigninNamesOnIOThread;
39 namespace extensions {
45 class FraudulentCertificateReporter;
46 class FtpTransactionFactory;
47 class HttpServerProperties;
48 class HttpTransactionFactory;
49 class ServerBoundCertService;
50 class ProxyConfigService;
52 class SSLConfigService;
53 class TransportSecurityPersister;
54 class TransportSecurityState;
55 class URLRequestJobFactoryImpl;
59 class PolicyCertVerifier;
60 class PolicyHeaderIOHelper;
61 class URLBlacklistManager;
64 // Conceptually speaking, the ProfileIOData represents data that lives on the IO
65 // thread that is owned by a Profile, such as, but not limited to, network
66 // objects like CookieMonster, HttpTransactionFactory, etc. Profile owns
67 // ProfileIOData, but will make sure to delete it on the IO thread (except
68 // possibly in unit tests where there is no IO thread).
71 virtual ~ProfileIOData();
73 static ProfileIOData* FromResourceContext(content::ResourceContext* rc);
75 // Returns true if |scheme| is handled in Chrome, or by default handlers in
77 static bool IsHandledProtocol(const std::string& scheme);
79 // Returns true if |url| is handled in Chrome, or by default handlers in
81 static bool IsHandledURL(const GURL& url);
83 // Utility to install additional WebUI handlers into the |job_factory|.
84 // Ownership of the handlers is transfered from |protocol_handlers|
85 // to the |job_factory|.
86 static void InstallProtocolHandlers(
87 net::URLRequestJobFactoryImpl* job_factory,
88 content::ProtocolHandlerMap* protocol_handlers);
91 content::ResourceContext* GetResourceContext() const;
93 // Initializes the ProfileIOData object and primes the RequestContext
94 // generation. Must be called prior to any of the Get*() methods other than
95 // GetResouceContext or GetMetricsEnabledStateOnIOThread.
96 void Init(content::ProtocolHandlerMap* protocol_handlers) const;
98 ChromeURLRequestContext* GetMainRequestContext() const;
99 ChromeURLRequestContext* GetMediaRequestContext() const;
100 ChromeURLRequestContext* GetExtensionsRequestContext() const;
101 ChromeURLRequestContext* GetIsolatedAppRequestContext(
102 ChromeURLRequestContext* main_context,
103 const StoragePartitionDescriptor& partition_descriptor,
104 scoped_ptr<ProtocolHandlerRegistry::JobInterceptorFactory>
105 protocol_handler_interceptor,
106 content::ProtocolHandlerMap* protocol_handlers) const;
107 ChromeURLRequestContext* GetIsolatedMediaRequestContext(
108 ChromeURLRequestContext* app_context,
109 const StoragePartitionDescriptor& partition_descriptor) const;
111 // These are useful when the Chrome layer is called from the content layer
112 // with a content::ResourceContext, and they want access to Chrome data for
114 extensions::InfoMap* GetExtensionInfoMap() const;
115 CookieSettings* GetCookieSettings() const;
116 HostContentSettingsMap* GetHostContentSettingsMap() const;
118 IntegerPrefMember* session_startup_pref() const {
119 return &session_startup_pref_;
122 SigninNamesOnIOThread* signin_names() const {
123 return signin_names_.get();
126 StringPrefMember* google_services_account_id() const {
127 return &google_services_user_account_id_;
130 StringPrefMember* google_services_username() const {
131 return &google_services_username_;
134 StringPrefMember* google_services_username_pattern() const {
135 return &google_services_username_pattern_;
138 BooleanPrefMember* reverse_autologin_enabled() const {
139 return &reverse_autologin_enabled_;
142 const std::string& reverse_autologin_pending_email() const {
143 return reverse_autologin_pending_email_;
146 void set_reverse_autologin_pending_email(const std::string& email) {
147 reverse_autologin_pending_email_ = email;
150 StringListPrefMember* one_click_signin_rejected_email_list() const {
151 return &one_click_signin_rejected_email_list_;
154 ChromeURLRequestContext* extensions_request_context() const {
155 return extensions_request_context_.get();
158 BooleanPrefMember* safe_browsing_enabled() const {
159 return &safe_browsing_enabled_;
162 BooleanPrefMember* printing_enabled() const {
163 return &printing_enabled_;
166 BooleanPrefMember* sync_disabled() const {
167 return &sync_disabled_;
170 BooleanPrefMember* signin_allowed() const {
171 return &signin_allowed_;
174 BooleanPrefMember* network_prediction_enabled() const {
175 return &network_prediction_enabled_;
178 content::ResourceContext::SaltCallback GetMediaDeviceIDSalt() const;
180 net::TransportSecurityState* transport_security_state() const {
181 return transport_security_state_.get();
184 #if defined(OS_CHROMEOS)
185 std::string username_hash() const {
186 return username_hash_;
190 bool is_incognito() const {
191 return is_incognito_;
194 #if defined(ENABLE_CONFIGURATION_POLICY)
195 policy::PolicyHeaderIOHelper* policy_header_helper() const {
196 return policy_header_helper_.get();
200 #if defined(ENABLE_MANAGED_USERS)
201 const ManagedModeURLFilter* managed_mode_url_filter() const {
202 return managed_mode_url_filter_.get();
206 // Initialize the member needed to track the metrics enabled state. This is
207 // only to be called on the UI thread.
208 void InitializeMetricsEnabledStateOnUIThread();
210 // Returns whether or not metrics reporting is enabled in the browser instance
211 // on which this profile resides. This is safe for use from the IO thread, and
212 // should only be called from there.
213 bool GetMetricsEnabledStateOnIOThread() const;
215 void set_client_cert_store_factory_for_testing(
216 const base::Callback<scoped_ptr<net::ClientCertStore>()>& factory) {
217 client_cert_store_factory_ = factory;
221 // A URLRequestContext for media that owns its HTTP factory, to ensure
223 class MediaRequestContext : public ChromeURLRequestContext {
225 MediaRequestContext();
227 void SetHttpTransactionFactory(
228 scoped_ptr<net::HttpTransactionFactory> http_factory);
231 virtual ~MediaRequestContext();
233 scoped_ptr<net::HttpTransactionFactory> http_factory_;
236 // A URLRequestContext for apps that owns its cookie store and HTTP factory,
237 // to ensure they are deleted.
238 class AppRequestContext : public ChromeURLRequestContext {
242 void SetCookieStore(net::CookieStore* cookie_store);
243 void SetHttpTransactionFactory(
244 scoped_ptr<net::HttpTransactionFactory> http_factory);
245 void SetJobFactory(scoped_ptr<net::URLRequestJobFactory> job_factory);
248 virtual ~AppRequestContext();
250 scoped_refptr<net::CookieStore> cookie_store_;
251 scoped_ptr<net::HttpTransactionFactory> http_factory_;
252 scoped_ptr<net::URLRequestJobFactory> job_factory_;
255 // Created on the UI thread, read on the IO thread during ProfileIOData lazy
257 struct ProfileParams {
263 scoped_refptr<CookieSettings> cookie_settings;
264 scoped_refptr<HostContentSettingsMap> host_content_settings_map;
265 scoped_refptr<net::SSLConfigService> ssl_config_service;
266 scoped_refptr<net::CookieMonster::Delegate> cookie_monster_delegate;
267 scoped_refptr<extensions::InfoMap> extension_info_map;
269 // This pointer exists only as a means of conveying a url job factory
270 // pointer from the protocol handler registry on the UI thread to the
271 // the URLRequestContext on the IO thread. The consumer MUST take
272 // ownership of the object by calling release() on this pointer.
273 scoped_ptr<ProtocolHandlerRegistry::JobInterceptorFactory>
274 protocol_handler_interceptor;
276 // We need to initialize the ProxyConfigService from the UI thread
277 // because on linux it relies on initializing things through gconf,
278 // and needs to be on the main thread.
279 scoped_ptr<net::ProxyConfigService> proxy_config_service;
281 #if defined(ENABLE_MANAGED_USERS)
282 scoped_refptr<const ManagedModeURLFilter> managed_mode_url_filter;
285 #if defined(OS_CHROMEOS)
286 std::string username_hash;
289 // The profile this struct was populated from. It's passed as a void* to
290 // ensure it's not accidently used on the IO thread. Before using it on the
291 // UI thread, call ProfileManager::IsValidProfile to ensure it's alive.
295 explicit ProfileIOData(bool is_incognito);
297 static std::string GetSSLSessionCacheShard();
299 void InitializeOnUIThread(Profile* profile);
300 void ApplyProfileParamsToContext(ChromeURLRequestContext* context) const;
302 scoped_ptr<net::URLRequestJobFactory> SetUpJobFactoryDefaults(
303 scoped_ptr<net::URLRequestJobFactoryImpl> job_factory,
304 scoped_ptr<ProtocolHandlerRegistry::JobInterceptorFactory>
305 protocol_handler_interceptor,
306 net::NetworkDelegate* network_delegate,
307 net::FtpTransactionFactory* ftp_transaction_factory) const;
309 // Called when the profile is destroyed.
310 void ShutdownOnUIThread();
312 // A ServerBoundCertService object is created by a derived class of
313 // ProfileIOData, and the derived class calls this method to set the
314 // server_bound_cert_service_ member and transfers ownership to the base
316 void set_server_bound_cert_service(
317 net::ServerBoundCertService* server_bound_cert_service) const;
319 ChromeNetworkDelegate* network_delegate() const {
320 return network_delegate_.get();
323 net::FraudulentCertificateReporter* fraudulent_certificate_reporter() const {
324 return fraudulent_certificate_reporter_.get();
327 net::ProxyService* proxy_service() const {
328 return proxy_service_.get();
331 base::WeakPtr<net::HttpServerProperties> http_server_properties() const;
333 void set_http_server_properties(
334 scoped_ptr<net::HttpServerProperties> http_server_properties) const;
336 ChromeURLRequestContext* main_request_context() const {
337 return main_request_context_.get();
340 bool initialized() const {
344 // Destroys the ResourceContext first, to cancel any URLRequests that are
345 // using it still, before we destroy the member variables that those
346 // URLRequests may be accessing.
347 void DestroyResourceContext();
349 // Fills in fields of params using values from main_request_context_ and the
350 // IOThread associated with profile_params.
351 void PopulateNetworkSessionParams(
352 const ProfileParams* profile_params,
353 net::HttpNetworkSession::Params* params) const;
355 void SetCookieSettingsForTesting(CookieSettings* cookie_settings);
357 void set_signin_names_for_testing(SigninNamesOnIOThread* signin_names);
360 class ResourceContext : public content::ResourceContext {
362 explicit ResourceContext(ProfileIOData* io_data);
363 virtual ~ResourceContext();
365 // ResourceContext implementation:
366 virtual net::HostResolver* GetHostResolver() OVERRIDE;
367 virtual net::URLRequestContext* GetRequestContext() OVERRIDE;
368 virtual scoped_ptr<net::ClientCertStore> CreateClientCertStore() OVERRIDE;
369 virtual void CreateKeygenHandler(
370 uint32 key_size_in_bits,
371 const std::string& challenge_string,
373 const base::Callback<void(scoped_ptr<net::KeygenHandler>)>& callback)
375 virtual bool AllowMicAccess(const GURL& origin) OVERRIDE;
376 virtual bool AllowCameraAccess(const GURL& origin) OVERRIDE;
377 virtual SaltCallback GetMediaDeviceIDSalt() OVERRIDE;
380 friend class ProfileIOData;
382 // Helper method that returns true if |type| is allowed for |origin|, false
384 bool AllowContentAccess(const GURL& origin, ContentSettingsType type);
386 ProfileIOData* const io_data_;
388 net::HostResolver* host_resolver_;
389 net::URLRequestContext* request_context_;
392 typedef std::map<StoragePartitionDescriptor,
393 ChromeURLRequestContext*,
394 StoragePartitionDescriptorLess>
395 URLRequestContextMap;
397 // --------------------------------------------
398 // Virtual interface for subtypes to implement:
399 // --------------------------------------------
401 // Does the actual initialization of the ProfileIOData subtype. Subtypes
402 // should use the static helper functions above to implement this.
403 virtual void InitializeInternal(
404 ProfileParams* profile_params,
405 content::ProtocolHandlerMap* protocol_handlers) const = 0;
407 // Initializes the RequestContext for extensions.
408 virtual void InitializeExtensionsRequestContext(
409 ProfileParams* profile_params) const = 0;
410 // Does an on-demand initialization of a RequestContext for the given
412 virtual ChromeURLRequestContext* InitializeAppRequestContext(
413 ChromeURLRequestContext* main_context,
414 const StoragePartitionDescriptor& details,
415 scoped_ptr<ProtocolHandlerRegistry::JobInterceptorFactory>
416 protocol_handler_interceptor,
417 content::ProtocolHandlerMap* protocol_handlers) const = 0;
419 // Does an on-demand initialization of a media RequestContext for the given
421 virtual ChromeURLRequestContext* InitializeMediaRequestContext(
422 ChromeURLRequestContext* original_context,
423 const StoragePartitionDescriptor& details) const = 0;
425 // These functions are used to transfer ownership of the lazily initialized
426 // context from ProfileIOData to the URLRequestContextGetter.
427 virtual ChromeURLRequestContext*
428 AcquireMediaRequestContext() const = 0;
429 virtual ChromeURLRequestContext*
430 AcquireIsolatedAppRequestContext(
431 ChromeURLRequestContext* main_context,
432 const StoragePartitionDescriptor& partition_descriptor,
433 scoped_ptr<ProtocolHandlerRegistry::JobInterceptorFactory>
434 protocol_handler_interceptor,
435 content::ProtocolHandlerMap* protocol_handlers) const = 0;
436 virtual ChromeURLRequestContext*
437 AcquireIsolatedMediaRequestContext(
438 ChromeURLRequestContext* app_context,
439 const StoragePartitionDescriptor& partition_descriptor) const = 0;
441 // The order *DOES* matter for the majority of these member variables, so
442 // don't move them around unless you know what you're doing!
444 // * ResourceContext references the URLRequestContexts, so
445 // URLRequestContexts must outlive ResourceContext, hence ResourceContext
446 // should be destroyed first.
447 // * URLRequestContexts reference a whole bunch of members, so
448 // URLRequestContext needs to be destroyed before them.
449 // * Therefore, ResourceContext should be listed last, and then the
450 // URLRequestContexts, and then the URLRequestContext members.
451 // * Note that URLRequestContext members have a directed dependency graph
452 // too, so they must themselves be ordered correctly.
454 // Tracks whether or not we've been lazily initialized.
455 mutable bool initialized_;
457 // Data from the UI thread from the Profile, used to initialize ProfileIOData.
458 // Deleted after lazy initialization.
459 mutable scoped_ptr<ProfileParams> profile_params_;
461 // Provides access to the email addresses of all signed in profiles.
462 mutable scoped_ptr<SigninNamesOnIOThread> signin_names_;
465 mutable base::Callback<scoped_ptr<net::ClientCertStore>()>
466 client_cert_store_factory_;
468 mutable StringPrefMember google_services_user_account_id_;
469 mutable StringPrefMember google_services_username_;
470 mutable StringPrefMember google_services_username_pattern_;
471 mutable BooleanPrefMember reverse_autologin_enabled_;
473 // During the reverse autologin request chain processing, this member saves
474 // the email of the google account that is being signed into.
475 std::string reverse_autologin_pending_email_;
477 mutable StringListPrefMember one_click_signin_rejected_email_list_;
479 mutable scoped_refptr<MediaDeviceIDSalt> media_device_id_salt_;
481 // Member variables which are pointed to by the various context objects.
482 mutable BooleanPrefMember enable_referrers_;
483 mutable BooleanPrefMember enable_do_not_track_;
484 mutable BooleanPrefMember force_safesearch_;
485 mutable BooleanPrefMember safe_browsing_enabled_;
486 mutable BooleanPrefMember printing_enabled_;
487 mutable BooleanPrefMember sync_disabled_;
488 mutable BooleanPrefMember signin_allowed_;
489 mutable BooleanPrefMember network_prediction_enabled_;
490 // TODO(marja): Remove session_startup_pref_ if no longer needed.
491 mutable IntegerPrefMember session_startup_pref_;
492 mutable BooleanPrefMember quick_check_enabled_;
494 // The state of metrics reporting in the browser that this profile runs on.
495 // Unfortunately, since ChromeOS has a separate representation of this state,
496 // we need to make one available based on the platform.
497 #if defined(OS_CHROMEOS)
498 bool enable_metrics_;
500 BooleanPrefMember enable_metrics_;
503 #if defined(ENABLE_CONFIGURATION_POLICY)
504 // Pointed to by NetworkDelegate.
505 mutable scoped_ptr<policy::URLBlacklistManager> url_blacklist_manager_;
506 mutable scoped_ptr<policy::PolicyHeaderIOHelper> policy_header_helper_;
509 // Pointed to by URLRequestContext.
510 mutable scoped_refptr<extensions::InfoMap> extension_info_map_;
511 mutable scoped_ptr<net::ServerBoundCertService> server_bound_cert_service_;
512 mutable scoped_ptr<ChromeNetworkDelegate> network_delegate_;
513 mutable scoped_ptr<net::FraudulentCertificateReporter>
514 fraudulent_certificate_reporter_;
515 mutable scoped_ptr<net::ProxyService> proxy_service_;
516 mutable scoped_ptr<net::TransportSecurityState> transport_security_state_;
517 mutable scoped_ptr<net::HttpServerProperties>
518 http_server_properties_;
519 #if defined(OS_CHROMEOS)
520 mutable scoped_ptr<policy::PolicyCertVerifier> cert_verifier_;
521 mutable std::string username_hash_;
524 mutable scoped_ptr<net::TransportSecurityPersister>
525 transport_security_persister_;
527 // These are only valid in between LazyInitialize() and their accessor being
529 mutable scoped_ptr<ChromeURLRequestContext> main_request_context_;
530 mutable scoped_ptr<ChromeURLRequestContext> extensions_request_context_;
531 // One URLRequestContext per isolated app for main and media requests.
532 mutable URLRequestContextMap app_request_context_map_;
533 mutable URLRequestContextMap isolated_media_request_context_map_;
535 mutable scoped_ptr<ResourceContext> resource_context_;
537 mutable scoped_refptr<CookieSettings> cookie_settings_;
539 mutable scoped_refptr<HostContentSettingsMap> host_content_settings_map_;
541 mutable scoped_ptr<ChromeHttpUserAgentSettings>
542 chrome_http_user_agent_settings_;
544 #if defined(ENABLE_MANAGED_USERS)
545 mutable scoped_refptr<const ManagedModeURLFilter> managed_mode_url_filter_;
548 // TODO(jhawkins): Remove once crbug.com/102004 is fixed.
549 bool initialized_on_UI_thread_;
553 DISALLOW_COPY_AND_ASSIGN(ProfileIOData);
556 #endif // CHROME_BROWSER_PROFILES_PROFILE_IO_DATA_H_