content_browser_client.h revision a36e5920737c6adbddd3e43b760e5de8431db6e0
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 CONTENT_PUBLIC_BROWSER_CONTENT_BROWSER_CLIENT_H_ 6#define CONTENT_PUBLIC_BROWSER_CONTENT_BROWSER_CLIENT_H_ 7 8#include <map> 9#include <string> 10#include <utility> 11#include <vector> 12 13#include "base/callback_forward.h" 14#include "base/memory/linked_ptr.h" 15#include "base/memory/scoped_ptr.h" 16#include "base/memory/scoped_vector.h" 17#include "base/values.h" 18#include "content/public/browser/certificate_request_result_type.h" 19#include "content/public/browser/file_descriptor_info.h" 20#include "content/public/common/content_client.h" 21#include "content/public/common/socket_permission_request.h" 22#include "content/public/common/window_container_type.h" 23#include "net/base/mime_util.h" 24#include "net/cookies/canonical_cookie.h" 25#include "net/url_request/url_request_job_factory.h" 26#include "third_party/WebKit/public/web/WebNotificationPresenter.h" 27#include "ui/base/window_open_disposition.h" 28#include "webkit/common/resource_type.h" 29 30#if defined(OS_POSIX) && !defined(OS_MACOSX) 31#include "base/posix/global_descriptors.h" 32#endif 33 34class CommandLine; 35class GURL; 36struct WebPreferences; 37 38namespace WebKit { 39struct WebWindowFeatures; 40} 41 42namespace base { 43class DictionaryValue; 44class FilePath; 45} 46namespace crypto { 47class CryptoModuleBlockingPasswordDelegate; 48} 49 50namespace gfx { 51class ImageSkia; 52} 53 54namespace net { 55class CookieOptions; 56class HttpNetworkSession; 57class NetLog; 58class SSLCertRequestInfo; 59class SSLInfo; 60class URLRequest; 61class URLRequestContext; 62class URLRequestContextGetter; 63class X509Certificate; 64} 65 66namespace sandbox { 67class TargetPolicy; 68} 69 70namespace ui { 71class SelectFilePolicy; 72} 73 74namespace fileapi { 75class ExternalMountPoints; 76class FileSystemBackend; 77} 78 79namespace content { 80 81class AccessTokenStore; 82class BrowserChildProcessHost; 83class BrowserContext; 84class BrowserMainParts; 85class BrowserPluginGuestDelegate; 86class BrowserPpapiHost; 87class BrowserURLHandler; 88class LocationProvider; 89class MediaObserver; 90class QuotaPermissionContext; 91class RenderProcessHost; 92class RenderViewHost; 93class RenderViewHostDelegateView; 94class ResourceContext; 95class SiteInstance; 96class SpeechRecognitionManagerDelegate; 97class WebContents; 98class WebContentsViewDelegate; 99class WebContentsViewPort; 100struct MainFunctionParams; 101struct Referrer; 102struct ShowDesktopNotificationHostMsgParams; 103 104// A mapping from the scheme name to the protocol handler that services its 105// content. 106typedef std::map< 107 std::string, linked_ptr<net::URLRequestJobFactory::ProtocolHandler> > 108 ProtocolHandlerMap; 109 110// Embedder API (or SPI) for participating in browser logic, to be implemented 111// by the client of the content browser. See ChromeContentBrowserClient for the 112// principal implementation. The methods are assumed to be called on the UI 113// thread unless otherwise specified. Use this "escape hatch" sparingly, to 114// avoid the embedder interface ballooning and becoming very specific to Chrome. 115// (Often, the call out to the client can happen in a different part of the code 116// that either already has a hook out to the embedder, or calls out to one of 117// the observer interfaces.) 118class CONTENT_EXPORT ContentBrowserClient { 119 public: 120 virtual ~ContentBrowserClient() {} 121 122 // Allows the embedder to set any number of custom BrowserMainParts 123 // implementations for the browser startup code. See comments in 124 // browser_main_parts.h. 125 virtual BrowserMainParts* CreateBrowserMainParts( 126 const MainFunctionParams& parameters); 127 128 // Allows an embedder to return their own WebContentsViewPort implementation. 129 // Return NULL to let the default one for the platform be created. Otherwise 130 // |render_view_host_delegate_view| also needs to be provided, and it is 131 // owned by the embedder. 132 virtual WebContentsViewPort* OverrideCreateWebContentsView( 133 WebContents* web_contents, 134 RenderViewHostDelegateView** render_view_host_delegate_view); 135 136 // If content creates the WebContentsView implementation, it will ask the 137 // embedder to return an (optional) delegate to customize it. The view will 138 // own the delegate. 139 virtual WebContentsViewDelegate* GetWebContentsViewDelegate( 140 WebContents* web_contents); 141 142 // Notifies that a guest WebContents has been created. A guest WebContents 143 // represents a renderer that's hosted within a BrowserPlugin. Creation can 144 // occur an arbitrary length of time before attachment. If the new guest has 145 // an |opener_web_contents|, then it's a new window created by that opener. 146 // If the guest was created via navigation, then |extra_params| will be 147 // non-NULL. |extra_params| are parameters passed to the BrowserPlugin object 148 // element by the content embedder. These parameters may include the API to 149 // enable for the given guest. |guest_delegate| is a return parameter of 150 // the delegate in the content embedder that will service the guest in the 151 // content layer. The content layer takes ownership of the |guest_delegate|. 152 virtual void GuestWebContentsCreated( 153 WebContents* guest_web_contents, 154 WebContents* opener_web_contents, 155 BrowserPluginGuestDelegate** guest_delegate, 156 scoped_ptr<base::DictionaryValue> extra_params) {} 157 158 // Notifies that a guest WebContents has been attached to a BrowserPlugin. 159 // A guest is attached to a BrowserPlugin when the guest has acquired an 160 // embedder WebContents. This happens on initial navigation or when a new 161 // window is attached to a BrowserPlugin. |extra_params| are params sent 162 // from javascript. 163 virtual void GuestWebContentsAttached( 164 WebContents* guest_web_contents, 165 WebContents* embedder_web_contents, 166 int browser_plugin_instance_id, 167 const base::DictionaryValue& extra_params) {} 168 169 // Notifies that a RenderProcessHost has been created. This is called before 170 // the content layer adds its own BrowserMessageFilters, so that the 171 // embedder's IPC filters have priority. 172 virtual void RenderProcessHostCreated(RenderProcessHost* host) {} 173 174 // Notifies that a BrowserChildProcessHost has been created. 175 virtual void BrowserChildProcessHostCreated(BrowserChildProcessHost* host) {} 176 177 // Get the effective URL for the given actual URL, to allow an embedder to 178 // group different url schemes in the same SiteInstance. 179 virtual GURL GetEffectiveURL(BrowserContext* browser_context, 180 const GURL& url); 181 182 // Returns whether all instances of the specified effective URL should be 183 // rendered by the same process, rather than using process-per-site-instance. 184 virtual bool ShouldUseProcessPerSite(BrowserContext* browser_context, 185 const GURL& effective_url); 186 187 // Returns a list additional WebUI schemes, if any. These additional schemes 188 // act as aliases to the chrome: scheme. The additional schemes may or may 189 // not serve specific WebUI pages depending on the particular URLDataSource 190 // and its override of URLDataSource::ShouldServiceRequest. 191 virtual void GetAdditionalWebUISchemes( 192 std::vector<std::string>* additional_schemes) {} 193 194 // Creates the main net::URLRequestContextGetter. Should only be called once 195 // per ContentBrowserClient object. 196 // TODO(ajwong): Remove once http://crbug.com/159193 is resolved. 197 virtual net::URLRequestContextGetter* CreateRequestContext( 198 BrowserContext* browser_context, 199 ProtocolHandlerMap* protocol_handlers); 200 201 // Creates the net::URLRequestContextGetter for a StoragePartition. Should 202 // only be called once per partition_path per ContentBrowserClient object. 203 // TODO(ajwong): Remove once http://crbug.com/159193 is resolved. 204 virtual net::URLRequestContextGetter* CreateRequestContextForStoragePartition( 205 BrowserContext* browser_context, 206 const base::FilePath& partition_path, 207 bool in_memory, 208 ProtocolHandlerMap* protocol_handlers); 209 210 // Returns whether a specified URL is handled by the embedder's internal 211 // protocol handlers. 212 virtual bool IsHandledURL(const GURL& url); 213 214 // Returns whether the given process is allowed to commit |url|. This is a 215 // more conservative check than IsSuitableHost, since it is used after a 216 // navigation has committed to ensure that the process did not exceed its 217 // authority. 218 virtual bool CanCommitURL(RenderProcessHost* process_host, const GURL& url); 219 220 // Returns whether a new view for a given |site_url| can be launched in a 221 // given |process_host|. 222 virtual bool IsSuitableHost(RenderProcessHost* process_host, 223 const GURL& site_url); 224 225 // Returns whether a new process should be created or an existing one should 226 // be reused based on the URL we want to load. This should return false, 227 // unless there is a good reason otherwise. 228 virtual bool ShouldTryToUseExistingProcessHost( 229 BrowserContext* browser_context, const GURL& url); 230 231 // Called when a site instance is first associated with a process. 232 virtual void SiteInstanceGotProcess(SiteInstance* site_instance) {} 233 234 // Called from a site instance's destructor. 235 virtual void SiteInstanceDeleting(SiteInstance* site_instance) {} 236 237 // Returns true if for the navigation from |current_url| to |new_url| 238 // in |site_instance|, the process should be swapped (even if we are in a 239 // process model that doesn't usually swap). 240 virtual bool ShouldSwapProcessesForNavigation(SiteInstance* site_instance, 241 const GURL& current_url, 242 const GURL& new_url); 243 244 // Returns true if the given navigation redirect should cause a renderer 245 // process swap. 246 // This is called on the IO thread. 247 virtual bool ShouldSwapProcessesForRedirect(ResourceContext* resource_context, 248 const GURL& current_url, 249 const GURL& new_url); 250 251 // Returns true if the passed in URL should be assigned as the site of the 252 // current SiteInstance, if it does not yet have a site. 253 virtual bool ShouldAssignSiteForURL(const GURL& url); 254 255 // See CharacterEncoding's comment. 256 virtual std::string GetCanonicalEncodingNameByAliasName( 257 const std::string& alias_name); 258 259 // Allows the embedder to pass extra command line flags. 260 // switches::kProcessType will already be set at this point. 261 virtual void AppendExtraCommandLineSwitches(CommandLine* command_line, 262 int child_process_id) {} 263 264 // Returns the locale used by the application. 265 // This is called on the UI and IO threads. 266 virtual std::string GetApplicationLocale(); 267 268 // Returns the languages used in the Accept-Languages HTTP header. 269 // (Not called GetAcceptLanguages so it doesn't clash with win32). 270 virtual std::string GetAcceptLangs(BrowserContext* context); 271 272 // Returns the default favicon. The callee doesn't own the given bitmap. 273 virtual gfx::ImageSkia* GetDefaultFavicon(); 274 275 // Allow the embedder to control if an AppCache can be used for the given url. 276 // This is called on the IO thread. 277 virtual bool AllowAppCache(const GURL& manifest_url, 278 const GURL& first_party, 279 ResourceContext* context); 280 281 // Allow the embedder to control if the given cookie can be read. 282 // This is called on the IO thread. 283 virtual bool AllowGetCookie(const GURL& url, 284 const GURL& first_party, 285 const net::CookieList& cookie_list, 286 ResourceContext* context, 287 int render_process_id, 288 int render_view_id); 289 290 // Allow the embedder to control if the given cookie can be set. 291 // This is called on the IO thread. 292 virtual bool AllowSetCookie(const GURL& url, 293 const GURL& first_party, 294 const std::string& cookie_line, 295 ResourceContext* context, 296 int render_process_id, 297 int render_view_id, 298 net::CookieOptions* options); 299 300 // This is called on the IO thread. 301 virtual bool AllowSaveLocalState(ResourceContext* context); 302 303 // Allow the embedder to control if access to web database by a shared worker 304 // is allowed. |render_views| is a vector of pairs of 305 // RenderProcessID/RenderViewID of RenderViews that are using this worker. 306 // This is called on the IO thread. 307 virtual bool AllowWorkerDatabase( 308 const GURL& url, 309 const string16& name, 310 const string16& display_name, 311 unsigned long estimated_size, 312 ResourceContext* context, 313 const std::vector<std::pair<int, int> >& render_views); 314 315 // Allow the embedder to control if access to file system by a shared worker 316 // is allowed. 317 // This is called on the IO thread. 318 virtual bool AllowWorkerFileSystem( 319 const GURL& url, 320 ResourceContext* context, 321 const std::vector<std::pair<int, int> >& render_views); 322 323 // Allow the embedder to control if access to IndexedDB by a shared worker 324 // is allowed. 325 // This is called on the IO thread. 326 virtual bool AllowWorkerIndexedDB( 327 const GURL& url, 328 const string16& name, 329 ResourceContext* context, 330 const std::vector<std::pair<int, int> >& render_views); 331 332 // Allow the embedder to override the request context based on the URL for 333 // certain operations, like cookie access. Returns NULL to indicate the 334 // regular request context should be used. 335 // This is called on the IO thread. 336 virtual net::URLRequestContext* OverrideRequestContextForURL( 337 const GURL& url, ResourceContext* context); 338 339 // Allow the embedder to specify a string version of the storage partition 340 // config with a site. 341 virtual std::string GetStoragePartitionIdForSite( 342 content::BrowserContext* browser_context, 343 const GURL& site); 344 345 // Allows the embedder to provide a validation check for |partition_id|s. 346 // This domain of valid entries should match the range of outputs for 347 // GetStoragePartitionIdForChildProcess(). 348 virtual bool IsValidStoragePartitionId(BrowserContext* browser_context, 349 const std::string& partition_id); 350 351 // Allows the embedder to provide a storage parititon configuration for a 352 // site. A storage partition configuration includes a domain of the embedder's 353 // choice, an optional name within that domain, and whether the partition is 354 // in-memory only. 355 // 356 // If |can_be_default| is false, the caller is telling the embedder that the 357 // |site| is known to not be in the default partition. This is useful in 358 // some shutdown situations where the bookkeeping logic that maps sites to 359 // their partition configuration are no longer valid. 360 // 361 // The |partition_domain| is [a-z]* UTF-8 string, specifying the domain in 362 // which partitions live (similar to namespace). Within a domain, partitions 363 // can be uniquely identified by the combination of |partition_name| and 364 // |in_memory| values. When a partition is not to be persisted, the 365 // |in_memory| value must be set to true. 366 virtual void GetStoragePartitionConfigForSite( 367 content::BrowserContext* browser_context, 368 const GURL& site, 369 bool can_be_default, 370 std::string* partition_domain, 371 std::string* partition_name, 372 bool* in_memory); 373 374 // Create and return a new quota permission context. 375 virtual QuotaPermissionContext* CreateQuotaPermissionContext(); 376 377 // Informs the embedder that a certificate error has occured. If 378 // |overridable| is true and if |strict_enforcement| is false, the user 379 // can ignore the error and continue. The embedder can call the callback 380 // asynchronously. If |result| is not set to 381 // CERTIFICATE_REQUEST_RESULT_TYPE_CONTINUE, the request will be cancelled 382 // or denied immediately, and the callback won't be run. 383 virtual void AllowCertificateError( 384 int render_process_id, 385 int render_view_id, 386 int cert_error, 387 const net::SSLInfo& ssl_info, 388 const GURL& request_url, 389 ResourceType::Type resource_type, 390 bool overridable, 391 bool strict_enforcement, 392 const base::Callback<void(bool)>& callback, 393 CertificateRequestResultType* result) {} 394 395 // Selects a SSL client certificate and returns it to the |callback|. If no 396 // certificate was selected NULL is returned to the |callback|. 397 virtual void SelectClientCertificate( 398 int render_process_id, 399 int render_view_id, 400 const net::HttpNetworkSession* network_session, 401 net::SSLCertRequestInfo* cert_request_info, 402 const base::Callback<void(net::X509Certificate*)>& callback) {} 403 404 // Adds a new installable certificate or private key. 405 // Typically used to install an X.509 user certificate. 406 // Note that it's up to the embedder to verify that the data is 407 // well-formed. |cert_data| will be NULL if file_size is 0. 408 virtual void AddCertificate( 409 net::URLRequest* request, 410 net::CertificateMimeType cert_type, 411 const void* cert_data, 412 size_t cert_size, 413 int render_process_id, 414 int render_view_id) {} 415 416 // Returns a class to get notifications about media event. The embedder can 417 // return NULL if they're not interested. 418 virtual MediaObserver* GetMediaObserver(); 419 420 // Asks permission to show desktop notifications. 421 virtual void RequestDesktopNotificationPermission( 422 const GURL& source_origin, 423 int callback_context, 424 int render_process_id, 425 int render_view_id) {} 426 427 // Checks if the given page has permission to show desktop notifications. 428 // This is called on the IO thread. 429 virtual WebKit::WebNotificationPresenter::Permission 430 CheckDesktopNotificationPermission( 431 const GURL& source_url, 432 ResourceContext* context, 433 int render_process_id); 434 435 // Show a desktop notification. If |worker| is true, the request came from an 436 // HTML5 web worker, otherwise, it came from a renderer. 437 virtual void ShowDesktopNotification( 438 const ShowDesktopNotificationHostMsgParams& params, 439 int render_process_id, 440 int render_view_id, 441 bool worker) {} 442 443 // Cancels a displayed desktop notification. 444 virtual void CancelDesktopNotification( 445 int render_process_id, 446 int render_view_id, 447 int notification_id) {} 448 449 // Returns true if the given page is allowed to open a window of the given 450 // type. If true is returned, |no_javascript_access| will indicate whether 451 // the window that is created should be scriptable/in the same process. 452 // This is called on the IO thread. 453 virtual bool CanCreateWindow(const GURL& opener_url, 454 const GURL& source_origin, 455 WindowContainerType container_type, 456 const GURL& target_url, 457 const content::Referrer& referrer, 458 WindowOpenDisposition disposition, 459 const WebKit::WebWindowFeatures& features, 460 bool user_gesture, 461 bool opener_suppressed, 462 content::ResourceContext* context, 463 int render_process_id, 464 bool is_guest, 465 int opener_id, 466 bool* no_javascript_access); 467 468 // Returns a title string to use in the task manager for a process host with 469 // the given URL, or the empty string to fall back to the default logic. 470 // This is called on the IO thread. 471 virtual std::string GetWorkerProcessTitle(const GURL& url, 472 ResourceContext* context); 473 474 // Notifies the embedder that the ResourceDispatcherHost has been created. 475 // This is when it can optionally add a delegate. 476 virtual void ResourceDispatcherHostCreated() {} 477 478 // Allows the embedder to return a delegate for the SpeechRecognitionManager. 479 // The delegate will be owned by the manager. It's valid to return NULL. 480 virtual SpeechRecognitionManagerDelegate* 481 GetSpeechRecognitionManagerDelegate(); 482 483 // Getters for common objects. 484 virtual net::NetLog* GetNetLog(); 485 486 // Creates a new AccessTokenStore for gelocation. 487 virtual AccessTokenStore* CreateAccessTokenStore(); 488 489 // Returns true if fast shutdown is possible. 490 virtual bool IsFastShutdownPossible(); 491 492 // Called by WebContents to override the WebKit preferences that are used by 493 // the renderer. The content layer will add its own settings, and then it's up 494 // to the embedder to update it if it wants. 495 virtual void OverrideWebkitPrefs(RenderViewHost* render_view_host, 496 const GURL& url, 497 WebPreferences* prefs) {} 498 499 // Inspector setting was changed and should be persisted. 500 virtual void UpdateInspectorSetting(RenderViewHost* rvh, 501 const std::string& key, 502 const std::string& value) {} 503 504 // Notifies that BrowserURLHandler has been created, so that the embedder can 505 // optionally add their own handlers. 506 virtual void BrowserURLHandlerCreated(BrowserURLHandler* handler) {} 507 508 // Clears browser cache. 509 virtual void ClearCache(RenderViewHost* rvh) {} 510 511 // Clears browser cookies. 512 virtual void ClearCookies(RenderViewHost* rvh) {} 513 514 // Returns the default download directory. 515 // This can be called on any thread. 516 virtual base::FilePath GetDefaultDownloadDirectory(); 517 518 // Returns the default filename used in downloads when we have no idea what 519 // else we should do with the file. 520 virtual std::string GetDefaultDownloadName(); 521 522 // Notification that a pepper plugin has just been spawned. This allows the 523 // embedder to add filters onto the host to implement interfaces. 524 // This is called on the IO thread. 525 virtual void DidCreatePpapiPlugin(BrowserPpapiHost* browser_host) {} 526 527 // Gets the host for an external out-of-process plugin. 528 virtual content::BrowserPpapiHost* GetExternalBrowserPpapiHost( 529 int plugin_child_id); 530 531 // Returns true if the given browser_context and site_url support hosting 532 // BrowserPlugins. 533 virtual bool SupportsBrowserPlugin(BrowserContext* browser_context, 534 const GURL& site_url); 535 536 // Returns true if the socket operation specified by |params| is allowed 537 // from the given |browser_context| and |url|. |private_api| indicates whether 538 // this permission check is for the private Pepper socket API or the public 539 // one. 540 virtual bool AllowPepperSocketAPI(BrowserContext* browser_context, 541 const GURL& url, 542 bool private_api, 543 const SocketPermissionRequest& params); 544 545 // Returns an implementation of a file selecition policy. Can return NULL. 546 virtual ui::SelectFilePolicy* CreateSelectFilePolicy( 547 WebContents* web_contents); 548 549 // Returns additional allowed scheme set which can access files in 550 // FileSystem API. 551 virtual void GetAdditionalAllowedSchemesForFileSystem( 552 std::vector<std::string>* additional_schemes) {} 553 554 // Returns additional file system backends for FileSystem API. 555 // |browser_context| is needed in the additional FileSystemBackends. 556 // It has mount points to create objects returned by additional 557 // FileSystemBackends, and SpecialStoragePolicy for permission granting. 558 virtual void GetAdditionalFileSystemBackends( 559 BrowserContext* browser_context, 560 const base::FilePath& storage_partition_path, 561 ScopedVector<fileapi::FileSystemBackend>* additional_backends) {} 562 563 // Allows an embedder to return its own LocationProvider implementation. 564 // Return NULL to use the default one for the platform to be created. 565 virtual LocationProvider* OverrideSystemLocationProvider(); 566 567#if defined(OS_POSIX) && !defined(OS_MACOSX) 568 // Populates |mappings| with all files that need to be mapped before launching 569 // a child process. 570 virtual void GetAdditionalMappedFilesForChildProcess( 571 const CommandLine& command_line, 572 int child_process_id, 573 std::vector<FileDescriptorInfo>* mappings) {} 574#endif 575 576#if defined(OS_WIN) 577 // Returns the name of the dll that contains cursors and other resources. 578 virtual const wchar_t* GetResourceDllName(); 579 580 // This is called on the PROCESS_LAUNCHER thread before the renderer process 581 // is launched. It gives the embedder a chance to add loosen the sandbox 582 // policy. 583 virtual void PreSpawnRenderer(sandbox::TargetPolicy* policy, 584 bool* success) {} 585#endif 586 587#if defined(USE_NSS) 588 // Return a delegate to authenticate and unlock |module|. 589 // This is called on a worker thread. 590 virtual 591 crypto::CryptoModuleBlockingPasswordDelegate* GetCryptoPasswordDelegate( 592 const GURL& url); 593#endif 594}; 595 596} // namespace content 597 598#endif // CONTENT_PUBLIC_BROWSER_CONTENT_BROWSER_CLIENT_H_ 599