content_browser_client.h revision 58537e28ecd584eab876aee8be7156509866d23a
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 const base::DictionaryValue& extra_params) {} 167 168 // Notifies that a RenderProcessHost has been created. This is called before 169 // the content layer adds its own BrowserMessageFilters, so that the 170 // embedder's IPC filters have priority. 171 virtual void RenderProcessHostCreated(RenderProcessHost* host) {} 172 173 // Notifies that a BrowserChildProcessHost has been created. 174 virtual void BrowserChildProcessHostCreated(BrowserChildProcessHost* host) {} 175 176 // Get the effective URL for the given actual URL, to allow an embedder to 177 // group different url schemes in the same SiteInstance. 178 virtual GURL GetEffectiveURL(BrowserContext* browser_context, 179 const GURL& url); 180 181 // Returns whether all instances of the specified effective URL should be 182 // rendered by the same process, rather than using process-per-site-instance. 183 virtual bool ShouldUseProcessPerSite(BrowserContext* browser_context, 184 const GURL& effective_url); 185 186 // Returns a list additional WebUI schemes, if any. These additional schemes 187 // act as aliases to the chrome: scheme. The additional schemes may or may 188 // not serve specific WebUI pages depending on the particular URLDataSource 189 // and its override of URLDataSource::ShouldServiceRequest. 190 virtual void GetAdditionalWebUISchemes( 191 std::vector<std::string>* additional_schemes) {} 192 193 // Creates the main net::URLRequestContextGetter. Should only be called once 194 // per ContentBrowserClient object. 195 // TODO(ajwong): Remove once http://crbug.com/159193 is resolved. 196 virtual net::URLRequestContextGetter* CreateRequestContext( 197 BrowserContext* browser_context, 198 ProtocolHandlerMap* protocol_handlers); 199 200 // Creates the net::URLRequestContextGetter for a StoragePartition. Should 201 // only be called once per partition_path per ContentBrowserClient object. 202 // TODO(ajwong): Remove once http://crbug.com/159193 is resolved. 203 virtual net::URLRequestContextGetter* CreateRequestContextForStoragePartition( 204 BrowserContext* browser_context, 205 const base::FilePath& partition_path, 206 bool in_memory, 207 ProtocolHandlerMap* protocol_handlers); 208 209 // Returns whether a specified URL is handled by the embedder's internal 210 // protocol handlers. 211 virtual bool IsHandledURL(const GURL& url); 212 213 // Returns whether the given process is allowed to commit |url|. This is a 214 // more conservative check than IsSuitableHost, since it is used after a 215 // navigation has committed to ensure that the process did not exceed its 216 // authority. 217 virtual bool CanCommitURL(RenderProcessHost* process_host, const GURL& url); 218 219 // Returns whether a URL should be allowed to open from a specific context. 220 // This also applies in cases where the new URL will open in another process. 221 virtual bool ShouldAllowOpenURL(SiteInstance* site_instance, const GURL& url); 222 223 // Returns whether a new view for a given |site_url| can be launched in a 224 // given |process_host|. 225 virtual bool IsSuitableHost(RenderProcessHost* process_host, 226 const GURL& site_url); 227 228 // Returns whether a new process should be created or an existing one should 229 // be reused based on the URL we want to load. This should return false, 230 // unless there is a good reason otherwise. 231 virtual bool ShouldTryToUseExistingProcessHost( 232 BrowserContext* browser_context, const GURL& url); 233 234 // Called when a site instance is first associated with a process. 235 virtual void SiteInstanceGotProcess(SiteInstance* site_instance) {} 236 237 // Called from a site instance's destructor. 238 virtual void SiteInstanceDeleting(SiteInstance* site_instance) {} 239 240 // Returns true if for the navigation from |current_url| to |new_url| 241 // in |site_instance|, the process should be swapped (even if we are in a 242 // process model that doesn't usually swap). 243 virtual bool ShouldSwapProcessesForNavigation(SiteInstance* site_instance, 244 const GURL& current_url, 245 const GURL& new_url); 246 247 // Returns true if the given navigation redirect should cause a renderer 248 // process swap. 249 // This is called on the IO thread. 250 virtual bool ShouldSwapProcessesForRedirect(ResourceContext* resource_context, 251 const GURL& current_url, 252 const GURL& new_url); 253 254 // Returns true if the passed in URL should be assigned as the site of the 255 // current SiteInstance, if it does not yet have a site. 256 virtual bool ShouldAssignSiteForURL(const GURL& url); 257 258 // See CharacterEncoding's comment. 259 virtual std::string GetCanonicalEncodingNameByAliasName( 260 const std::string& alias_name); 261 262 // Allows the embedder to pass extra command line flags. 263 // switches::kProcessType will already be set at this point. 264 virtual void AppendExtraCommandLineSwitches(CommandLine* command_line, 265 int child_process_id) {} 266 267 // Returns the locale used by the application. 268 // This is called on the UI and IO threads. 269 virtual std::string GetApplicationLocale(); 270 271 // Returns the languages used in the Accept-Languages HTTP header. 272 // (Not called GetAcceptLanguages so it doesn't clash with win32). 273 virtual std::string GetAcceptLangs(BrowserContext* context); 274 275 // Returns the default favicon. The callee doesn't own the given bitmap. 276 virtual gfx::ImageSkia* GetDefaultFavicon(); 277 278 // Allow the embedder to control if an AppCache can be used for the given url. 279 // This is called on the IO thread. 280 virtual bool AllowAppCache(const GURL& manifest_url, 281 const GURL& first_party, 282 ResourceContext* context); 283 284 // Allow the embedder to control if the given cookie can be read. 285 // This is called on the IO thread. 286 virtual bool AllowGetCookie(const GURL& url, 287 const GURL& first_party, 288 const net::CookieList& cookie_list, 289 ResourceContext* context, 290 int render_process_id, 291 int render_view_id); 292 293 // Allow the embedder to control if the given cookie can be set. 294 // This is called on the IO thread. 295 virtual bool AllowSetCookie(const GURL& url, 296 const GURL& first_party, 297 const std::string& cookie_line, 298 ResourceContext* context, 299 int render_process_id, 300 int render_view_id, 301 net::CookieOptions* options); 302 303 // This is called on the IO thread. 304 virtual bool AllowSaveLocalState(ResourceContext* context); 305 306 // Allow the embedder to control if access to web database by a shared worker 307 // is allowed. |render_views| is a vector of pairs of 308 // RenderProcessID/RenderViewID of RenderViews that are using this worker. 309 // This is called on the IO thread. 310 virtual bool AllowWorkerDatabase( 311 const GURL& url, 312 const string16& name, 313 const string16& display_name, 314 unsigned long estimated_size, 315 ResourceContext* context, 316 const std::vector<std::pair<int, int> >& render_views); 317 318 // Allow the embedder to control if access to file system by a shared worker 319 // is allowed. 320 // This is called on the IO thread. 321 virtual bool AllowWorkerFileSystem( 322 const GURL& url, 323 ResourceContext* context, 324 const std::vector<std::pair<int, int> >& render_views); 325 326 // Allow the embedder to control if access to IndexedDB by a shared worker 327 // is allowed. 328 // This is called on the IO thread. 329 virtual bool AllowWorkerIndexedDB( 330 const GURL& url, 331 const string16& name, 332 ResourceContext* context, 333 const std::vector<std::pair<int, int> >& render_views); 334 335 // Allow the embedder to override the request context based on the URL for 336 // certain operations, like cookie access. Returns NULL to indicate the 337 // regular request context should be used. 338 // This is called on the IO thread. 339 virtual net::URLRequestContext* OverrideRequestContextForURL( 340 const GURL& url, ResourceContext* context); 341 342 // Allow the embedder to specify a string version of the storage partition 343 // config with a site. 344 virtual std::string GetStoragePartitionIdForSite( 345 content::BrowserContext* browser_context, 346 const GURL& site); 347 348 // Allows the embedder to provide a validation check for |partition_id|s. 349 // This domain of valid entries should match the range of outputs for 350 // GetStoragePartitionIdForChildProcess(). 351 virtual bool IsValidStoragePartitionId(BrowserContext* browser_context, 352 const std::string& partition_id); 353 354 // Allows the embedder to provide a storage parititon configuration for a 355 // site. A storage partition configuration includes a domain of the embedder's 356 // choice, an optional name within that domain, and whether the partition is 357 // in-memory only. 358 // 359 // If |can_be_default| is false, the caller is telling the embedder that the 360 // |site| is known to not be in the default partition. This is useful in 361 // some shutdown situations where the bookkeeping logic that maps sites to 362 // their partition configuration are no longer valid. 363 // 364 // The |partition_domain| is [a-z]* UTF-8 string, specifying the domain in 365 // which partitions live (similar to namespace). Within a domain, partitions 366 // can be uniquely identified by the combination of |partition_name| and 367 // |in_memory| values. When a partition is not to be persisted, the 368 // |in_memory| value must be set to true. 369 virtual void GetStoragePartitionConfigForSite( 370 content::BrowserContext* browser_context, 371 const GURL& site, 372 bool can_be_default, 373 std::string* partition_domain, 374 std::string* partition_name, 375 bool* in_memory); 376 377 // Create and return a new quota permission context. 378 virtual QuotaPermissionContext* CreateQuotaPermissionContext(); 379 380 // Informs the embedder that a certificate error has occured. If 381 // |overridable| is true and if |strict_enforcement| is false, the user 382 // can ignore the error and continue. The embedder can call the callback 383 // asynchronously. If |result| is not set to 384 // CERTIFICATE_REQUEST_RESULT_TYPE_CONTINUE, the request will be cancelled 385 // or denied immediately, and the callback won't be run. 386 virtual void AllowCertificateError( 387 int render_process_id, 388 int render_view_id, 389 int cert_error, 390 const net::SSLInfo& ssl_info, 391 const GURL& request_url, 392 ResourceType::Type resource_type, 393 bool overridable, 394 bool strict_enforcement, 395 const base::Callback<void(bool)>& callback, 396 CertificateRequestResultType* result) {} 397 398 // Selects a SSL client certificate and returns it to the |callback|. If no 399 // certificate was selected NULL is returned to the |callback|. 400 virtual void SelectClientCertificate( 401 int render_process_id, 402 int render_view_id, 403 const net::HttpNetworkSession* network_session, 404 net::SSLCertRequestInfo* cert_request_info, 405 const base::Callback<void(net::X509Certificate*)>& callback) {} 406 407 // Adds a new installable certificate or private key. 408 // Typically used to install an X.509 user certificate. 409 // Note that it's up to the embedder to verify that the data is 410 // well-formed. |cert_data| will be NULL if file_size is 0. 411 virtual void AddCertificate( 412 net::URLRequest* request, 413 net::CertificateMimeType cert_type, 414 const void* cert_data, 415 size_t cert_size, 416 int render_process_id, 417 int render_view_id) {} 418 419 // Returns a class to get notifications about media event. The embedder can 420 // return NULL if they're not interested. 421 virtual MediaObserver* GetMediaObserver(); 422 423 // Asks permission to show desktop notifications. 424 virtual void RequestDesktopNotificationPermission( 425 const GURL& source_origin, 426 int callback_context, 427 int render_process_id, 428 int render_view_id) {} 429 430 // Checks if the given page has permission to show desktop notifications. 431 // This is called on the IO thread. 432 virtual WebKit::WebNotificationPresenter::Permission 433 CheckDesktopNotificationPermission( 434 const GURL& source_url, 435 ResourceContext* context, 436 int render_process_id); 437 438 // Show a desktop notification. If |worker| is true, the request came from an 439 // HTML5 web worker, otherwise, it came from a renderer. 440 virtual void ShowDesktopNotification( 441 const ShowDesktopNotificationHostMsgParams& params, 442 int render_process_id, 443 int render_view_id, 444 bool worker) {} 445 446 // Cancels a displayed desktop notification. 447 virtual void CancelDesktopNotification( 448 int render_process_id, 449 int render_view_id, 450 int notification_id) {} 451 452 // Returns true if the given page is allowed to open a window of the given 453 // type. If true is returned, |no_javascript_access| will indicate whether 454 // the window that is created should be scriptable/in the same process. 455 // This is called on the IO thread. 456 virtual bool CanCreateWindow(const GURL& opener_url, 457 const GURL& opener_top_level_frame_url, 458 const GURL& source_origin, 459 WindowContainerType container_type, 460 const GURL& target_url, 461 const content::Referrer& referrer, 462 WindowOpenDisposition disposition, 463 const WebKit::WebWindowFeatures& features, 464 bool user_gesture, 465 bool opener_suppressed, 466 content::ResourceContext* context, 467 int render_process_id, 468 bool is_guest, 469 int opener_id, 470 bool* no_javascript_access); 471 472 // Returns a title string to use in the task manager for a process host with 473 // the given URL, or the empty string to fall back to the default logic. 474 // This is called on the IO thread. 475 virtual std::string GetWorkerProcessTitle(const GURL& url, 476 ResourceContext* context); 477 478 // Notifies the embedder that the ResourceDispatcherHost has been created. 479 // This is when it can optionally add a delegate. 480 virtual void ResourceDispatcherHostCreated() {} 481 482 // Allows the embedder to return a delegate for the SpeechRecognitionManager. 483 // The delegate will be owned by the manager. It's valid to return NULL. 484 virtual SpeechRecognitionManagerDelegate* 485 GetSpeechRecognitionManagerDelegate(); 486 487 // Getters for common objects. 488 virtual net::NetLog* GetNetLog(); 489 490 // Creates a new AccessTokenStore for gelocation. 491 virtual AccessTokenStore* CreateAccessTokenStore(); 492 493 // Returns true if fast shutdown is possible. 494 virtual bool IsFastShutdownPossible(); 495 496 // Called by WebContents to override the WebKit preferences that are used by 497 // the renderer. The content layer will add its own settings, and then it's up 498 // to the embedder to update it if it wants. 499 virtual void OverrideWebkitPrefs(RenderViewHost* render_view_host, 500 const GURL& url, 501 WebPreferences* prefs) {} 502 503 // Inspector setting was changed and should be persisted. 504 virtual void UpdateInspectorSetting(RenderViewHost* rvh, 505 const std::string& key, 506 const std::string& value) {} 507 508 // Notifies that BrowserURLHandler has been created, so that the embedder can 509 // optionally add their own handlers. 510 virtual void BrowserURLHandlerCreated(BrowserURLHandler* handler) {} 511 512 // Clears browser cache. 513 virtual void ClearCache(RenderViewHost* rvh) {} 514 515 // Clears browser cookies. 516 virtual void ClearCookies(RenderViewHost* rvh) {} 517 518 // Returns the default download directory. 519 // This can be called on any thread. 520 virtual base::FilePath GetDefaultDownloadDirectory(); 521 522 // Returns the default filename used in downloads when we have no idea what 523 // else we should do with the file. 524 virtual std::string GetDefaultDownloadName(); 525 526 // Notification that a pepper plugin has just been spawned. This allows the 527 // embedder to add filters onto the host to implement interfaces. 528 // This is called on the IO thread. 529 virtual void DidCreatePpapiPlugin(BrowserPpapiHost* browser_host) {} 530 531 // Gets the host for an external out-of-process plugin. 532 virtual content::BrowserPpapiHost* GetExternalBrowserPpapiHost( 533 int plugin_child_id); 534 535 // Returns true if the given browser_context and site_url support hosting 536 // BrowserPlugins. 537 virtual bool SupportsBrowserPlugin(BrowserContext* browser_context, 538 const GURL& site_url); 539 540 // Returns true if the socket operation specified by |params| is allowed 541 // from the given |browser_context| and |url|. |private_api| indicates whether 542 // this permission check is for the private Pepper socket API or the public 543 // one. 544 virtual bool AllowPepperSocketAPI(BrowserContext* browser_context, 545 const GURL& url, 546 bool private_api, 547 const SocketPermissionRequest& params); 548 549 // Returns an implementation of a file selecition policy. Can return NULL. 550 virtual ui::SelectFilePolicy* CreateSelectFilePolicy( 551 WebContents* web_contents); 552 553 // Returns additional allowed scheme set which can access files in 554 // FileSystem API. 555 virtual void GetAdditionalAllowedSchemesForFileSystem( 556 std::vector<std::string>* additional_schemes) {} 557 558 // Returns additional file system backends for FileSystem API. 559 // |browser_context| is needed in the additional FileSystemBackends. 560 // It has mount points to create objects returned by additional 561 // FileSystemBackends, and SpecialStoragePolicy for permission granting. 562 virtual void GetAdditionalFileSystemBackends( 563 BrowserContext* browser_context, 564 const base::FilePath& storage_partition_path, 565 ScopedVector<fileapi::FileSystemBackend>* additional_backends) {} 566 567 // Allows an embedder to return its own LocationProvider implementation. 568 // Return NULL to use the default one for the platform to be created. 569 virtual LocationProvider* OverrideSystemLocationProvider(); 570 571#if defined(OS_POSIX) && !defined(OS_MACOSX) 572 // Populates |mappings| with all files that need to be mapped before launching 573 // a child process. 574 virtual void GetAdditionalMappedFilesForChildProcess( 575 const CommandLine& command_line, 576 int child_process_id, 577 std::vector<FileDescriptorInfo>* mappings) {} 578#endif 579 580#if defined(OS_WIN) 581 // Returns the name of the dll that contains cursors and other resources. 582 virtual const wchar_t* GetResourceDllName(); 583 584 // This is called on the PROCESS_LAUNCHER thread before the renderer process 585 // is launched. It gives the embedder a chance to add loosen the sandbox 586 // policy. 587 virtual void PreSpawnRenderer(sandbox::TargetPolicy* policy, 588 bool* success) {} 589#endif 590 591#if defined(USE_NSS) 592 // Return a delegate to authenticate and unlock |module|. 593 // This is called on a worker thread. 594 virtual 595 crypto::CryptoModuleBlockingPasswordDelegate* GetCryptoPasswordDelegate( 596 const GURL& url); 597#endif 598}; 599 600} // namespace content 601 602#endif // CONTENT_PUBLIC_BROWSER_CONTENT_BROWSER_CLIENT_H_ 603