// 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_CONTEXT_H_ #define SHELL_BROWSER_ELECTRON_BROWSER_CONTEXT_H_ #include #include #include #include #include "base/memory/weak_ptr.h" #include "chrome/browser/predictors/preconnect_manager.h" #include "content/public/browser/browser_context.h" #include "content/public/browser/resource_context.h" #include "electron/buildflags/buildflags.h" #include "mojo/public/cpp/bindings/remote.h" #include "services/network/public/mojom/network_context.mojom.h" #include "services/network/public/mojom/url_loader_factory.mojom.h" #include "shell/browser/media/media_device_id_salt.h" class PrefService; class ValueMapPrefStore; namespace network { class SharedURLLoaderFactory; } namespace storage { class SpecialStoragePolicy; } #if BUILDFLAG(ENABLE_ELECTRON_EXTENSIONS) namespace extensions { class ElectronExtensionSystem; } #endif namespace electron { class ElectronBrowserContext; class ElectronDownloadManagerDelegate; class ElectronPermissionManager; class CookieChangeNotifier; class ResolveProxyHelper; class WebViewManager; class ProtocolRegistry; // Preference keys for device apis extern const char kSerialGrantedDevicesPref[]; class ElectronBrowserContext : public content::BrowserContext { public: // partition_id => browser_context struct PartitionKey { std::string partition; bool in_memory; PartitionKey(const std::string& partition, bool in_memory) : partition(partition), in_memory(in_memory) {} bool operator<(const PartitionKey& other) const { if (partition == other.partition) return in_memory < other.in_memory; return partition < other.partition; } bool operator==(const PartitionKey& other) const { return (partition == other.partition) && (in_memory == other.in_memory); } }; using BrowserContextMap = std::map>; // Get or create the BrowserContext according to its |partition| and // |in_memory|. The |options| will be passed to constructor when there is no // existing BrowserContext. static ElectronBrowserContext* From( const std::string& partition, bool in_memory, base::DictionaryValue options = base::DictionaryValue()); static BrowserContextMap& browser_context_map(); void SetUserAgent(const std::string& user_agent); std::string GetUserAgent() const; bool CanUseHttpCache() const; int GetMaxCacheSize() const; ResolveProxyHelper* GetResolveProxyHelper(); predictors::PreconnectManager* GetPreconnectManager(); scoped_refptr GetURLLoaderFactory(); // content::BrowserContext: base::FilePath GetPath() override; bool IsOffTheRecord() override; content::ResourceContext* GetResourceContext() override; std::unique_ptr CreateZoomLevelDelegate( const base::FilePath& partition_path) override; content::PushMessagingService* GetPushMessagingService() override; content::SSLHostStateDelegate* GetSSLHostStateDelegate() override; content::BackgroundFetchDelegate* GetBackgroundFetchDelegate() override; content::BackgroundSyncController* GetBackgroundSyncController() override; content::BrowsingDataRemoverDelegate* GetBrowsingDataRemoverDelegate() override; std::string GetMediaDeviceIDSalt() override; content::DownloadManagerDelegate* GetDownloadManagerDelegate() override; content::BrowserPluginGuestManager* GetGuestManager() override; content::PermissionControllerDelegate* GetPermissionControllerDelegate() override; storage::SpecialStoragePolicy* GetSpecialStoragePolicy() override; content::ClientHintsControllerDelegate* GetClientHintsControllerDelegate() override; content::StorageNotificationService* GetStorageNotificationService() override; CookieChangeNotifier* cookie_change_notifier() const { return cookie_change_notifier_.get(); } PrefService* prefs() const { return prefs_.get(); } void set_in_memory_pref_store(ValueMapPrefStore* pref_store) { in_memory_pref_store_ = pref_store; } ValueMapPrefStore* in_memory_pref_store() const { return in_memory_pref_store_; } base::WeakPtr GetWeakPtr() { return weak_factory_.GetWeakPtr(); } #if BUILDFLAG(ENABLE_ELECTRON_EXTENSIONS) extensions::ElectronExtensionSystem* extension_system() { // Guard usages of extension_system() with !IsOffTheRecord() // There is no extension system for in-memory sessions DCHECK(!IsOffTheRecord()); return extension_system_; } #endif ProtocolRegistry* protocol_registry() const { return protocol_registry_.get(); } void SetSSLConfig(network::mojom::SSLConfigPtr config); network::mojom::SSLConfigPtr GetSSLConfig(); void SetSSLConfigClient(mojo::Remote client); // Grants |origin| access to |object| by writing it into the browser context. // To be used in place of ObjectPermissionContextBase::GrantObjectPermission. void GrantObjectPermission(const url::Origin& origin, base::Value object, const std::string& pref_key); // Returns the list of objects that |origin| has been granted permission to // access. To be used in place of // ObjectPermissionContextBase::GetGrantedObjects. std::vector> GetGrantedObjects( const url::Origin& origin, const std::string& pref_key); ~ElectronBrowserContext() override; private: ElectronBrowserContext(const std::string& partition, bool in_memory, base::DictionaryValue options); // Initialize pref registry. void InitPrefs(); ValueMapPrefStore* in_memory_pref_store_ = nullptr; std::unique_ptr resource_context_; std::unique_ptr cookie_change_notifier_; std::unique_ptr prefs_; std::unique_ptr download_manager_delegate_; std::unique_ptr guest_manager_; std::unique_ptr permission_manager_; std::unique_ptr media_device_id_salt_; scoped_refptr resolve_proxy_helper_; scoped_refptr storage_policy_; std::unique_ptr preconnect_manager_; std::unique_ptr protocol_registry_; std::string user_agent_; base::FilePath path_; bool in_memory_ = false; bool use_cache_ = true; int max_cache_size_ = 0; #if BUILDFLAG(ENABLE_ELECTRON_EXTENSIONS) // Owned by the KeyedService system. extensions::ElectronExtensionSystem* extension_system_; #endif // Shared URLLoaderFactory. scoped_refptr url_loader_factory_; network::mojom::SSLConfigPtr ssl_config_; mojo::Remote ssl_config_client_; base::WeakPtrFactory weak_factory_{this}; DISALLOW_COPY_AND_ASSIGN(ElectronBrowserContext); }; } // namespace electron #endif // SHELL_BROWSER_ELECTRON_BROWSER_CONTEXT_H_