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