// Copyright (c) 2013 GitHub, Inc. // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. #ifndef ELECTRON_SHELL_BROWSER_ELECTRON_BROWSER_CLIENT_H_ #define ELECTRON_SHELL_BROWSER_ELECTRON_BROWSER_CLIENT_H_ #include #include #include #include #include #include "base/containers/flat_map.h" #include "base/containers/flat_set.h" #include "base/files/file_path.h" #include "base/memory/raw_ptr.h" #include "base/synchronization/lock.h" #include "content/public/browser/content_browser_client.h" #include "content/public/browser/render_process_host_observer.h" #include "content/public/browser/web_contents.h" #include "electron/buildflags/buildflags.h" #include "net/ssl/client_cert_identity.h" #include "services/metrics/public/cpp/ukm_source_id.h" #include "shell/browser/bluetooth/electron_bluetooth_delegate.h" #include "shell/browser/hid/electron_hid_delegate.h" #include "shell/browser/serial/electron_serial_delegate.h" #include "shell/browser/usb/electron_usb_delegate.h" #include "third_party/blink/public/mojom/badging/badging.mojom-forward.h" namespace content { class ClientCertificateDelegate; class PlatformNotificationService; class QuotaPermissionContext; } // namespace content namespace net { class SSLCertRequestInfo; } namespace electron { class ElectronBrowserMainParts; class NotificationPresenter; class PlatformNotificationService; class ElectronWebAuthenticationDelegate; class ElectronBrowserClient : public content::ContentBrowserClient, private content::RenderProcessHostObserver { public: static ElectronBrowserClient* Get(); static void SetApplicationLocale(const std::string& locale); ElectronBrowserClient(); ~ElectronBrowserClient() override; // disable copy ElectronBrowserClient(const ElectronBrowserClient&) = delete; ElectronBrowserClient& operator=(const ElectronBrowserClient&) = delete; using Delegate = content::ContentBrowserClient; void set_delegate(Delegate* delegate) { delegate_ = delegate; } // Returns the WebContents for pending render processes. content::WebContents* GetWebContentsFromProcessID(int process_id); NotificationPresenter* GetNotificationPresenter(); void WebNotificationAllowed(content::RenderFrameHost* rfh, base::OnceCallback callback); // content::NavigatorDelegate std::vector> CreateThrottlesForNavigation(content::NavigationHandle* handle) override; // content::ContentBrowserClient: std::string GetApplicationLocale() override; bool ShouldEnableStrictSiteIsolation() override; void BindHostReceiverForRenderer( content::RenderProcessHost* render_process_host, mojo::GenericPendingReceiver receiver) override; void ExposeInterfacesToRenderer( service_manager::BinderRegistry* registry, blink::AssociatedInterfaceRegistry* associated_registry, content::RenderProcessHost* render_process_host) override; void RegisterBrowserInterfaceBindersForFrame( content::RenderFrameHost* render_frame_host, mojo::BinderMapWithContext* map) override; void RegisterBrowserInterfaceBindersForServiceWorker( content::BrowserContext* browser_context, const content::ServiceWorkerVersionBaseInfo& service_worker_version_info, mojo::BinderMapWithContext* map) override; #if BUILDFLAG(IS_LINUX) void GetAdditionalMappedFilesForChildProcess( const base::CommandLine& command_line, int child_process_id, content::PosixFileDescriptorInfo* mappings) override; #endif std::string GetUserAgent() override; void SetUserAgent(const std::string& user_agent); blink::UserAgentMetadata GetUserAgentMetadata() override; content::SerialDelegate* GetSerialDelegate() override; content::BluetoothDelegate* GetBluetoothDelegate() override; content::HidDelegate* GetHidDelegate() override; content::UsbDelegate* GetUsbDelegate() override; content::WebAuthenticationDelegate* GetWebAuthenticationDelegate() override; #if BUILDFLAG(IS_MAC) device::GeolocationSystemPermissionManager* GetGeolocationSystemPermissionManager() override; #endif content::PlatformNotificationService* GetPlatformNotificationService(); protected: void RenderProcessWillLaunch(content::RenderProcessHost* host) override; content::SpeechRecognitionManagerDelegate* CreateSpeechRecognitionManagerDelegate() override; content::TtsPlatform* GetTtsPlatform() override; void OverrideWebkitPrefs(content::WebContents* web_contents, blink::web_pref::WebPreferences* prefs) override; void RegisterPendingSiteInstance( content::RenderFrameHost* render_frame_host, content::SiteInstance* pending_site_instance) override; void AppendExtraCommandLineSwitches(base::CommandLine* command_line, int child_process_id) override; void DidCreatePpapiPlugin(content::BrowserPpapiHost* browser_host) override; std::string GetGeolocationApiKey() override; content::GeneratedCodeCacheSettings GetGeneratedCodeCacheSettings( content::BrowserContext* context) override; void AllowCertificateError( content::WebContents* web_contents, int cert_error, const net::SSLInfo& ssl_info, const GURL& request_url, bool is_main_frame_request, bool strict_enforcement, base::OnceCallback callback) override; base::OnceClosure SelectClientCertificate( content::BrowserContext* browser_context, int process_id, content::WebContents* web_contents, net::SSLCertRequestInfo* cert_request_info, net::ClientCertIdentityList client_certs, std::unique_ptr delegate) override; bool CanCreateWindow(content::RenderFrameHost* opener, const GURL& opener_url, const GURL& opener_top_level_frame_url, const url::Origin& source_origin, content::mojom::WindowContainerType container_type, const GURL& target_url, const content::Referrer& referrer, const std::string& frame_name, WindowOpenDisposition disposition, const blink::mojom::WindowFeatures& features, const std::string& raw_features, const scoped_refptr& body, bool user_gesture, bool opener_suppressed, bool* no_javascript_access) override; std::unique_ptr CreateWindowForVideoPictureInPicture( content::VideoPictureInPictureWindowController* controller) override; void GetAdditionalAllowedSchemesForFileSystem( std::vector* additional_schemes) override; void GetAdditionalWebUISchemes( std::vector* additional_schemes) override; std::unique_ptr CreateClientCertStore( content::BrowserContext* browser_context) override; std::unique_ptr OverrideSystemLocationProvider() override; void ConfigureNetworkContextParams( content::BrowserContext* browser_context, bool in_memory, const base::FilePath& relative_partition_path, network::mojom::NetworkContextParams* network_context_params, cert_verifier::mojom::CertVerifierCreationParams* cert_verifier_creation_params) override; network::mojom::NetworkContext* GetSystemNetworkContext() override; content::MediaObserver* GetMediaObserver() override; std::unique_ptr CreateDevToolsManagerDelegate() override; std::unique_ptr CreateBrowserMainParts( bool /* is_integration_test */) override; base::FilePath GetDefaultDownloadDirectory() override; scoped_refptr GetSystemSharedURLLoaderFactory() override; void OnNetworkServiceCreated( network::mojom::NetworkService* network_service) override; std::vector GetNetworkContextsParentDirectory() override; std::string GetProduct() override; mojo::PendingRemote CreateNonNetworkNavigationURLLoaderFactory(const std::string& scheme, int frame_tree_node_id) override; void RegisterNonNetworkWorkerMainResourceURLLoaderFactories( content::BrowserContext* browser_context, NonNetworkURLLoaderFactoryMap* factories) override; void RegisterNonNetworkSubresourceURLLoaderFactories( int render_process_id, int render_frame_id, const std::optional& request_initiator_origin, NonNetworkURLLoaderFactoryMap* factories) override; void RegisterNonNetworkServiceWorkerUpdateURLLoaderFactories( content::BrowserContext* browser_context, NonNetworkURLLoaderFactoryMap* factories) override; void CreateWebSocket( content::RenderFrameHost* frame, WebSocketFactory factory, const GURL& url, const net::SiteForCookies& site_for_cookies, const std::optional& user_agent, mojo::PendingRemote handshake_client) override; bool WillInterceptWebSocket(content::RenderFrameHost*) override; void WillCreateURLLoaderFactory( content::BrowserContext* browser_context, content::RenderFrameHost* frame, int render_process_id, URLLoaderFactoryType type, const url::Origin& request_initiator, const net::IsolationInfo& isolation_info, std::optional navigation_id, ukm::SourceIdObj ukm_source_id, network::URLLoaderFactoryBuilder& factory_builder, mojo::PendingRemote* header_client, bool* bypass_redirect_checks, bool* disable_secure_dns, network::mojom::URLLoaderFactoryOverridePtr* factory_override, scoped_refptr navigation_response_task_runner) override; std::vector> WillCreateURLLoaderRequestInterceptors( content::NavigationUIData* navigation_ui_data, int frame_tree_node_id, int64_t navigation_id, bool force_no_https_upgrade, scoped_refptr navigation_response_task_runner) override; bool ShouldTreatURLSchemeAsFirstPartyWhenTopLevel( std::string_view scheme, bool is_embedded_origin_secure) override; void OverrideURLLoaderFactoryParams( content::BrowserContext* browser_context, const url::Origin& origin, bool is_for_isolated_world, network::mojom::URLLoaderFactoryParams* factory_params) override; void RegisterAssociatedInterfaceBindersForRenderFrameHost( content::RenderFrameHost& render_frame_host, blink::AssociatedInterfaceRegistry& associated_registry) override; void RegisterAssociatedInterfaceBindersForServiceWorker( const content::ServiceWorkerVersionBaseInfo& service_worker_version_info, blink::AssociatedInterfaceRegistry& associated_registry) override; bool HandleExternalProtocol( const GURL& url, content::WebContents::Getter web_contents_getter, int frame_tree_node_id, content::NavigationUIData* navigation_data, bool is_primary_main_frame, bool is_in_fenced_frame_tree, network::mojom::WebSandboxFlags sandbox_flags, ui::PageTransition page_transition, bool has_user_gesture, const std::optional& initiating_origin, content::RenderFrameHost* initiator_document, mojo::PendingRemote* out_factory) override; std::unique_ptr CreateLoginDelegate( const net::AuthChallengeInfo& auth_info, content::WebContents* web_contents, content::BrowserContext* browser_context, const content::GlobalRequestID& request_id, bool is_main_frame, const GURL& url, scoped_refptr response_headers, bool first_auth_attempt, LoginAuthRequiredCallback auth_required_callback) override; void SiteInstanceGotProcessAndSite( content::SiteInstance* site_instance) override; std::vector> CreateURLLoaderThrottles( const network::ResourceRequest& request, content::BrowserContext* browser_context, const base::RepeatingCallback& wc_getter, content::NavigationUIData* navigation_ui_data, int frame_tree_node_id, std::optional navigation_id) override; base::flat_set GetPluginMimeTypesWithExternalHandlers( content::BrowserContext* browser_context) override; bool IsSuitableHost(content::RenderProcessHost* process_host, const GURL& site_url) override; bool ShouldUseProcessPerSite(content::BrowserContext* browser_context, const GURL& effective_url) override; void GetMediaDeviceIDSalt( content::RenderFrameHost* rfh, const net::SiteForCookies& site_for_cookies, const blink::StorageKey& storage_key, base::OnceCallback callback) override; base::FilePath GetLoggingFileName(const base::CommandLine& cmd_line) override; // content::RenderProcessHostObserver: void RenderProcessHostDestroyed(content::RenderProcessHost* host) override; void RenderProcessReady(content::RenderProcessHost* host) override; void RenderProcessExited( content::RenderProcessHost* host, const content::ChildProcessTerminationInfo& info) override; private: content::SiteInstance* GetSiteInstanceFromAffinity( content::BrowserContext* browser_context, const GURL& url, content::RenderFrameHost* rfh) const; bool IsRendererSubFrame(int process_id) const; // pending_render_process => web contents. base::flat_map pending_processes_; base::flat_set renderer_is_subframe_; std::unique_ptr notification_service_; std::unique_ptr notification_presenter_; raw_ptr delegate_ = nullptr; std::string user_agent_override_ = ""; // Simple shared ID generator, used by ProxyingURLLoaderFactory and // ProxyingWebSocket classes. uint64_t next_id_ = 0; std::unique_ptr serial_delegate_; std::unique_ptr bluetooth_delegate_; std::unique_ptr usb_delegate_; std::unique_ptr hid_delegate_; std::unique_ptr web_authentication_delegate_; }; } // namespace electron #endif // ELECTRON_SHELL_BROWSER_ELECTRON_BROWSER_CLIENT_H_