7b7def7d1e
* feat: set app.enableRendererProcessReuse to true by default * chore: add context aware info to breaking changes doc * spec: fix nodeIntegration in child windows test for rendererprocessreuse * spec: fix remote listeners in destroyed renderers spec as the error is now async * Update api-browser-window-spec.ts * chore: deprecate affinity * chore: fix docs * spec: handle tests crashing without an exist code * spec: update tests for new rendererprocessreuse default * spec: with renderer process re-use we get to destroy less views
323 lines
14 KiB
C++
323 lines
14 KiB
C++
// 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 SHELL_BROWSER_ELECTRON_BROWSER_CLIENT_H_
|
|
#define SHELL_BROWSER_ELECTRON_BROWSER_CLIENT_H_
|
|
|
|
#include <map>
|
|
#include <memory>
|
|
#include <set>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "base/files/file_path.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"
|
|
|
|
namespace content {
|
|
class ClientCertificateDelegate;
|
|
class QuotaPermissionContext;
|
|
} // namespace content
|
|
|
|
namespace net {
|
|
class SSLCertRequestInfo;
|
|
}
|
|
|
|
namespace electron {
|
|
|
|
class NotificationPresenter;
|
|
class PlatformNotificationService;
|
|
|
|
class ElectronBrowserClient : public content::ContentBrowserClient,
|
|
public content::RenderProcessHostObserver {
|
|
public:
|
|
static ElectronBrowserClient* Get();
|
|
static void SetApplicationLocale(const std::string& locale);
|
|
|
|
ElectronBrowserClient();
|
|
~ElectronBrowserClient() override;
|
|
|
|
using Delegate = content::ContentBrowserClient;
|
|
void set_delegate(Delegate* delegate) { delegate_ = delegate; }
|
|
|
|
// Returns the WebContents for pending render processes.
|
|
content::WebContents* GetWebContentsFromProcessID(int process_id);
|
|
|
|
// Don't force renderer process to restart for once.
|
|
static void SuppressRendererProcessRestartForOnce();
|
|
|
|
NotificationPresenter* GetNotificationPresenter();
|
|
|
|
void WebNotificationAllowed(int render_process_id,
|
|
base::OnceCallback<void(bool, bool)> callback);
|
|
|
|
// content::NavigatorDelegate
|
|
std::vector<std::unique_ptr<content::NavigationThrottle>>
|
|
CreateThrottlesForNavigation(content::NavigationHandle* handle) override;
|
|
|
|
// content::ContentBrowserClient:
|
|
std::string GetApplicationLocale() override;
|
|
base::FilePath GetFontLookupTableCacheDir() override;
|
|
bool ShouldEnableStrictSiteIsolation() override;
|
|
void BindHostReceiverForRenderer(
|
|
content::RenderProcessHost* render_process_host,
|
|
mojo::GenericPendingReceiver receiver) override;
|
|
void RegisterBrowserInterfaceBindersForFrame(
|
|
content::RenderFrameHost* render_frame_host,
|
|
service_manager::BinderMapWithContext<content::RenderFrameHost*>* map)
|
|
override;
|
|
|
|
std::string GetUserAgent() override;
|
|
void SetUserAgent(const std::string& user_agent);
|
|
|
|
void SetCanUseCustomSiteInstance(bool should_disable);
|
|
bool CanUseCustomSiteInstance() override;
|
|
|
|
protected:
|
|
void RenderProcessWillLaunch(content::RenderProcessHost* host) override;
|
|
content::SpeechRecognitionManagerDelegate*
|
|
CreateSpeechRecognitionManagerDelegate() override;
|
|
content::TtsControllerDelegate* GetTtsControllerDelegate() override;
|
|
void OverrideWebkitPrefs(content::RenderViewHost* render_view_host,
|
|
content::WebPreferences* prefs) override;
|
|
SiteInstanceForNavigationType ShouldOverrideSiteInstanceForNavigation(
|
|
content::RenderFrameHost* current_rfh,
|
|
content::RenderFrameHost* speculative_rfh,
|
|
content::BrowserContext* browser_context,
|
|
const GURL& url,
|
|
bool has_navigation_started,
|
|
bool has_request_started,
|
|
content::SiteInstance** affinity_site_instance) const 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;
|
|
scoped_refptr<content::QuotaPermissionContext> CreateQuotaPermissionContext()
|
|
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<void(content::CertificateRequestResultType)> callback)
|
|
override;
|
|
base::OnceClosure SelectClientCertificate(
|
|
content::WebContents* web_contents,
|
|
net::SSLCertRequestInfo* cert_request_info,
|
|
net::ClientCertIdentityList client_certs,
|
|
std::unique_ptr<content::ClientCertificateDelegate> 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::vector<std::string>& additional_features,
|
|
const scoped_refptr<network::ResourceRequestBody>& body,
|
|
bool user_gesture,
|
|
bool opener_suppressed,
|
|
bool* no_javascript_access) override;
|
|
#if BUILDFLAG(ENABLE_PICTURE_IN_PICTURE)
|
|
std::unique_ptr<content::OverlayWindow> CreateWindowForPictureInPicture(
|
|
content::PictureInPictureWindowController* controller) override;
|
|
#endif
|
|
void GetAdditionalAllowedSchemesForFileSystem(
|
|
std::vector<std::string>* additional_schemes) override;
|
|
void GetAdditionalWebUISchemes(
|
|
std::vector<std::string>* additional_schemes) override;
|
|
void SiteInstanceDeleting(content::SiteInstance* site_instance) override;
|
|
std::unique_ptr<net::ClientCertStore> CreateClientCertStore(
|
|
content::BrowserContext* browser_context) override;
|
|
std::unique_ptr<device::LocationProvider> OverrideSystemLocationProvider()
|
|
override;
|
|
mojo::Remote<network::mojom::NetworkContext> CreateNetworkContext(
|
|
content::BrowserContext* browser_context,
|
|
bool in_memory,
|
|
const base::FilePath& relative_partition_path) override;
|
|
network::mojom::NetworkContext* GetSystemNetworkContext() override;
|
|
base::Optional<service_manager::Manifest> GetServiceManifestOverlay(
|
|
base::StringPiece name) override;
|
|
content::MediaObserver* GetMediaObserver() override;
|
|
content::DevToolsManagerDelegate* GetDevToolsManagerDelegate() override;
|
|
content::PlatformNotificationService* GetPlatformNotificationService(
|
|
content::BrowserContext* browser_context) override;
|
|
std::unique_ptr<content::BrowserMainParts> CreateBrowserMainParts(
|
|
const content::MainFunctionParams&) override;
|
|
base::FilePath GetDefaultDownloadDirectory() override;
|
|
scoped_refptr<network::SharedURLLoaderFactory>
|
|
GetSystemSharedURLLoaderFactory() override;
|
|
void OnNetworkServiceCreated(
|
|
network::mojom::NetworkService* network_service) override;
|
|
std::vector<base::FilePath> GetNetworkContextsParentDirectory() override;
|
|
std::string GetProduct() override;
|
|
void RegisterNonNetworkNavigationURLLoaderFactories(
|
|
int frame_tree_node_id,
|
|
NonNetworkURLLoaderFactoryMap* factories) override;
|
|
void RegisterNonNetworkSubresourceURLLoaderFactories(
|
|
int render_process_id,
|
|
int render_frame_id,
|
|
NonNetworkURLLoaderFactoryMap* factories) override;
|
|
void CreateWebSocket(
|
|
content::RenderFrameHost* frame,
|
|
WebSocketFactory factory,
|
|
const GURL& url,
|
|
const net::SiteForCookies& site_for_cookies,
|
|
const base::Optional<std::string>& user_agent,
|
|
mojo::PendingRemote<network::mojom::WebSocketHandshakeClient>
|
|
handshake_client) override;
|
|
bool WillInterceptWebSocket(content::RenderFrameHost*) override;
|
|
bool WillCreateURLLoaderFactory(
|
|
content::BrowserContext* browser_context,
|
|
content::RenderFrameHost* frame,
|
|
int render_process_id,
|
|
URLLoaderFactoryType type,
|
|
const url::Origin& request_initiator,
|
|
base::Optional<int64_t> navigation_id,
|
|
mojo::PendingReceiver<network::mojom::URLLoaderFactory>* factory_receiver,
|
|
mojo::PendingRemote<network::mojom::TrustedURLLoaderHeaderClient>*
|
|
header_client,
|
|
bool* bypass_redirect_checks,
|
|
bool* disable_secure_dns,
|
|
network::mojom::URLLoaderFactoryOverridePtr* factory_override) override;
|
|
bool ShouldTreatURLSchemeAsFirstPartyWhenTopLevel(
|
|
base::StringPiece 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;
|
|
#if defined(OS_WIN)
|
|
bool PreSpawnRenderer(sandbox::TargetPolicy* policy,
|
|
RendererSpawnFlags flags) override;
|
|
#endif
|
|
bool BindAssociatedReceiverFromFrame(
|
|
content::RenderFrameHost* render_frame_host,
|
|
const std::string& interface_name,
|
|
mojo::ScopedInterfaceEndpointHandle* handle) override;
|
|
|
|
bool HandleExternalProtocol(
|
|
const GURL& url,
|
|
content::WebContents::OnceGetter web_contents_getter,
|
|
int child_id,
|
|
content::NavigationUIData* navigation_data,
|
|
bool is_main_frame,
|
|
ui::PageTransition page_transition,
|
|
bool has_user_gesture,
|
|
const base::Optional<url::Origin>& initiating_origin,
|
|
mojo::PendingRemote<network::mojom::URLLoaderFactory>* out_factory)
|
|
override;
|
|
std::unique_ptr<content::LoginDelegate> CreateLoginDelegate(
|
|
const net::AuthChallengeInfo& auth_info,
|
|
content::WebContents* web_contents,
|
|
const content::GlobalRequestID& request_id,
|
|
bool is_main_frame,
|
|
const GURL& url,
|
|
scoped_refptr<net::HttpResponseHeaders> response_headers,
|
|
bool first_auth_attempt,
|
|
LoginAuthRequiredCallback auth_required_callback) override;
|
|
void SiteInstanceGotProcess(content::SiteInstance* site_instance) override;
|
|
std::vector<std::unique_ptr<blink::URLLoaderThrottle>>
|
|
CreateURLLoaderThrottles(
|
|
const network::ResourceRequest& request,
|
|
content::BrowserContext* browser_context,
|
|
const base::RepeatingCallback<content::WebContents*()>& wc_getter,
|
|
content::NavigationUIData* navigation_ui_data,
|
|
int frame_tree_node_id) override;
|
|
base::flat_set<std::string> 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;
|
|
|
|
// 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:
|
|
struct ProcessPreferences {
|
|
bool sandbox = false;
|
|
bool native_window_open = false;
|
|
bool disable_popups = false;
|
|
bool web_security = true;
|
|
content::BrowserContext* browser_context = nullptr;
|
|
};
|
|
|
|
bool ShouldForceNewSiteInstance(content::RenderFrameHost* current_rfh,
|
|
content::RenderFrameHost* speculative_rfh,
|
|
content::BrowserContext* browser_context,
|
|
const GURL& dest_url,
|
|
bool has_request_started) const;
|
|
bool NavigationWasRedirectedCrossSite(
|
|
content::BrowserContext* browser_context,
|
|
content::SiteInstance* current_instance,
|
|
content::SiteInstance* speculative_instance,
|
|
const GURL& dest_url,
|
|
bool has_request_started) const;
|
|
void AddProcessPreferences(int process_id, ProcessPreferences prefs);
|
|
void RemoveProcessPreferences(int process_id);
|
|
bool IsProcessObserved(int process_id) const;
|
|
bool IsRendererSandboxed(int process_id) const;
|
|
bool RendererUsesNativeWindowOpen(int process_id) const;
|
|
bool RendererDisablesPopups(int process_id) const;
|
|
std::string GetAffinityPreference(content::RenderFrameHost* rfh) const;
|
|
content::SiteInstance* GetSiteInstanceFromAffinity(
|
|
content::BrowserContext* browser_context,
|
|
const GURL& url,
|
|
content::RenderFrameHost* rfh) const;
|
|
void ConsiderSiteInstanceForAffinity(content::RenderFrameHost* rfh,
|
|
content::SiteInstance* site_instance);
|
|
|
|
bool IsRendererSubFrame(int process_id) const;
|
|
|
|
// pending_render_process => web contents.
|
|
std::map<int, content::WebContents*> pending_processes_;
|
|
|
|
std::map<int, base::ProcessId> render_process_host_pids_;
|
|
|
|
std::set<int> renderer_is_subframe_;
|
|
|
|
// list of site per affinity. weak_ptr to prevent instance locking
|
|
std::map<std::string, content::SiteInstance*> site_per_affinities_;
|
|
|
|
std::unique_ptr<PlatformNotificationService> notification_service_;
|
|
std::unique_ptr<NotificationPresenter> notification_presenter_;
|
|
|
|
Delegate* delegate_ = nullptr;
|
|
|
|
std::map<int, ProcessPreferences> process_preferences_;
|
|
|
|
std::string user_agent_override_ = "";
|
|
|
|
bool disable_process_restart_tricks_ = true;
|
|
|
|
// Simple shared ID generator, used by ProxyingURLLoaderFactory and
|
|
// ProxyingWebSocket classes.
|
|
uint64_t next_id_ = 0;
|
|
|
|
DISALLOW_COPY_AND_ASSIGN(ElectronBrowserClient);
|
|
};
|
|
|
|
} // namespace electron
|
|
|
|
#endif // SHELL_BROWSER_ELECTRON_BROWSER_CLIENT_H_
|