#ifndef WebContext_h
#define WebContext_h
#include "APIObject.h"
#include "DownloadProxyMap.h"
#include "GenericCallback.h"
#include "ImmutableDictionary.h"
#include "MessageReceiver.h"
#include "MessageReceiverMap.h"
#include "PlugInAutoStartProvider.h"
#include "PluginInfoStore.h"
#include "ProcessModel.h"
#include "StatisticsRequest.h"
#include "StorageManager.h"
#include "VisitedLinkProvider.h"
#include "WebContextClient.h"
#include "WebContextConnectionClient.h"
#include "WebContextInjectedBundleClient.h"
#include "WebProcessProxy.h"
#include <WebCore/LinkHash.h>
#include <WebCore/SessionID.h>
#include <wtf/Forward.h>
#include <wtf/HashMap.h>
#include <wtf/HashSet.h>
#include <wtf/PassRefPtr.h>
#include <wtf/RefPtr.h>
#include <wtf/text/StringHash.h>
#include <wtf/text/WTFString.h>
#if ENABLE(DATABASE_PROCESS)
#include "DatabaseProcessProxy.h"
#endif
#if ENABLE(NETWORK_PROCESS)
#include "NetworkProcessProxy.h"
#endif
#if PLATFORM(COCOA)
OBJC_CLASS NSMutableDictionary;
OBJC_CLASS NSObject;
OBJC_CLASS NSString;
#endif
namespace API {
class DownloadClient;
class HistoryClient;
}
namespace WebKit {
class DownloadProxy;
class WebContextSupplement;
class WebIconDatabase;
class WebPageGroup;
class WebPageProxy;
struct StatisticsData;
struct WebPageConfiguration;
struct WebProcessCreationParameters;
typedef GenericCallback<ImmutableDictionary*> DictionaryCallback;
#if ENABLE(NETWORK_PROCESS)
struct NetworkProcessCreationParameters;
#endif
#if PLATFORM(COCOA)
int networkProcessLatencyQOS();
int networkProcessThroughputQOS();
int webProcessLatencyQOS();
int webProcessThroughputQOS();
#endif
struct WebContextConfiguration {
String injectedBundlePath;
String localStorageDirectory;
String webSQLDatabaseDirectory;
String indexedDBDatabaseDirectory;
};
class WebContext : public API::ObjectImpl<API::Object::Type::Context>, private IPC::MessageReceiver
#if ENABLE(NETSCAPE_PLUGIN_API)
, private PluginInfoStoreClient
#endif
{
public:
static void applyPlatformSpecificConfigurationDefaults(WebContextConfiguration&);
WebContext(WebContextConfiguration);
static PassRefPtr<WebContext> create(WebContextConfiguration);
virtual ~WebContext();
static const Vector<WebContext*>& allContexts();
template <typename T>
T* supplement()
{
return static_cast<T*>(m_supplements.get(T::supplementName()));
}
template <typename T>
void addSupplement()
{
m_supplements.add(T::supplementName(), T::create(this));
}
void addMessageReceiver(IPC::StringReference messageReceiverName, IPC::MessageReceiver&);
void addMessageReceiver(IPC::StringReference messageReceiverName, uint64_t destinationID, IPC::MessageReceiver&);
void removeMessageReceiver(IPC::StringReference messageReceiverName, uint64_t destinationID);
bool dispatchMessage(IPC::Connection*, IPC::MessageDecoder&);
bool dispatchSyncMessage(IPC::Connection*, IPC::MessageDecoder&, std::unique_ptr<IPC::MessageEncoder>&);
void initializeClient(const WKContextClientBase*);
void initializeInjectedBundleClient(const WKContextInjectedBundleClientBase*);
void initializeConnectionClient(const WKContextConnectionClientBase*);
void setHistoryClient(std::unique_ptr<API::HistoryClient>);
void setDownloadClient(std::unique_ptr<API::DownloadClient>);
void setProcessModel(ProcessModel); ProcessModel processModel() const { return m_processModel; }
void setMaximumNumberOfProcesses(unsigned); unsigned maximumNumberOfProcesses() const { return m_webProcessCountLimit; }
const Vector<RefPtr<WebProcessProxy>>& processes() const { return m_processes; }
IPC::Connection* networkingProcessConnection();
template<typename T> void sendToAllProcesses(const T& message);
template<typename T> void sendToAllProcessesRelaunchingThemIfNecessary(const T& message);
template<typename T> void sendToOneProcess(T&& message);
template<typename T> void sendToNetworkingProcess(T&& message);
template<typename T> void sendToNetworkingProcessRelaunchingIfNecessary(T&& message);
void processWillOpenConnection(WebProcessProxy*);
void processWillCloseConnection(WebProcessProxy*);
void processDidFinishLaunching(WebProcessProxy*);
void applicationWillTerminate();
void disconnectProcess(WebProcessProxy*);
StorageManager& storageManager() const { return *m_storageManager; }
PassRefPtr<WebPageProxy> createWebPage(PageClient&, WebPageConfiguration);
const String& injectedBundlePath() const { return m_injectedBundlePath; }
DownloadProxy* download(WebPageProxy* initiatingPage, const WebCore::ResourceRequest&);
void setInjectedBundleInitializationUserData(PassRefPtr<API::Object> userData) { m_injectedBundleInitializationUserData = userData; }
void postMessageToInjectedBundle(const String&, API::Object*);
void didReceiveMessageFromInjectedBundle(const String&, API::Object*);
void didReceiveSynchronousMessageFromInjectedBundle(const String&, API::Object*, RefPtr<API::Object>& returnData);
void populateVisitedLinks();
#if ENABLE(NETSCAPE_PLUGIN_API)
void setAdditionalPluginsDirectory(const String&);
PluginInfoStore& pluginInfoStore() { return m_pluginInfoStore; }
#endif
void setAlwaysUsesComplexTextCodePath(bool);
void setShouldUseFontSmoothing(bool);
void registerURLSchemeAsEmptyDocument(const String&);
void registerURLSchemeAsSecure(const String&);
void setDomainRelaxationForbiddenForURLScheme(const String&);
void registerURLSchemeAsLocal(const String&);
void registerURLSchemeAsNoAccess(const String&);
void registerURLSchemeAsDisplayIsolated(const String&);
void registerURLSchemeAsCORSEnabled(const String&);
#if ENABLE(CACHE_PARTITIONING)
void registerURLSchemeAsCachePartitioned(const String&);
#endif
VisitedLinkProvider& visitedLinkProvider() { return *m_visitedLinkProvider; }
virtual void didReceiveMessage(IPC::Connection*, IPC::MessageDecoder&) override;
virtual void didReceiveSyncMessage(IPC::Connection*, IPC::MessageDecoder&, std::unique_ptr<IPC::MessageEncoder>&) override;
void setCacheModel(CacheModel);
CacheModel cacheModel() const { return m_cacheModel; }
void setDefaultRequestTimeoutInterval(double);
void startMemorySampler(const double interval);
void stopMemorySampler();
#if USE(SOUP)
void setInitialHTTPCookieAcceptPolicy(HTTPCookieAcceptPolicy policy) { m_initialHTTPCookieAcceptPolicy = policy; }
#endif
void setEnhancedAccessibility(bool);
DownloadProxy* createDownloadProxy();
API::DownloadClient& downloadClient() { return *m_downloadClient; }
API::HistoryClient& historyClient() { return *m_historyClient; }
WebContextClient& client() { return m_client; }
WebIconDatabase* iconDatabase() const { return m_iconDatabase.get(); }
#if ENABLE(NETSCAPE_PLUGIN_API)
WebPluginSiteDataManager* pluginSiteDataManager() const { return m_pluginSiteDataManager.get(); }
#endif
struct Statistics {
unsigned wkViewCount;
unsigned wkPageCount;
unsigned wkFrameCount;
};
static Statistics& statistics();
void setApplicationCacheDirectory(const String& dir) { m_overrideApplicationCacheDirectory = dir; }
void setIconDatabasePath(const String&);
String iconDatabasePath() const;
void setDiskCacheDirectory(const String& dir) { m_overrideDiskCacheDirectory = dir; }
void setCookieStorageDirectory(const String& dir) { m_overrideCookieStorageDirectory = dir; }
void useTestingNetworkSession();
void allowSpecificHTTPSCertificateForHost(const WebCertificateInfo*, const String& host);
WebProcessProxy& ensureSharedWebProcess();
WebProcessProxy& createNewWebProcessRespectingProcessCountLimit(); void warmInitialProcess();
bool shouldTerminate(WebProcessProxy*);
void disableProcessTermination() { m_processTerminationEnabled = false; }
void enableProcessTermination();
void setHTTPPipeliningEnabled(bool);
bool httpPipeliningEnabled() const;
void getStatistics(uint32_t statisticsMask, std::function<void (ImmutableDictionary*, CallbackBase::Error)>);
void garbageCollectJavaScriptObjects();
void setJavaScriptGarbageCollectorTimerEnabled(bool flag);
#if PLATFORM(COCOA)
static bool omitPDFSupport();
#endif
void fullKeyboardAccessModeChanged(bool fullKeyboardAccessEnabled);
void textCheckerStateChanged();
PassRefPtr<ImmutableDictionary> plugInAutoStartOriginHashes() const;
void setPlugInAutoStartOriginHashes(ImmutableDictionary&);
void setPlugInAutoStartOrigins(API::Array&);
void setPlugInAutoStartOriginsFilteringOutEntriesAddedAfterTime(ImmutableDictionary&, double time);
void setUsesNetworkProcess(bool);
bool usesNetworkProcess() const;
#if ENABLE(NETWORK_PROCESS)
void ensureNetworkProcess();
NetworkProcessProxy* networkProcess() { return m_networkProcess.get(); }
void networkProcessCrashed(NetworkProcessProxy*);
void getNetworkProcessConnection(PassRefPtr<Messages::WebProcessProxy::GetNetworkProcessConnection::DelayedReply>);
#endif
#if ENABLE(DATABASE_PROCESS)
void ensureDatabaseProcess();
void getDatabaseProcessConnection(PassRefPtr<Messages::WebProcessProxy::GetDatabaseProcessConnection::DelayedReply>);
void databaseProcessCrashed(DatabaseProcessProxy*);
template<typename T> void sendToDatabaseProcessRelaunchingIfNecessary(T&& message);
#endif
#if PLATFORM(COCOA)
bool processSuppressionEnabled() const;
static bool processSuppressionIsEnabledForAllContexts();
static bool processSuppressionPreferenceIsEnabledForAllContexts();
#endif
void windowServerConnectionStateChanged();
static void willStartUsingPrivateBrowsing();
static void willStopUsingPrivateBrowsing();
static bool isEphemeralSession(WebCore::SessionID);
#if USE(SOUP)
void setIgnoreTLSErrors(bool);
bool ignoreTLSErrors() const { return m_ignoreTLSErrors; }
#endif
static void setInvalidMessageCallback(void (*)(WKStringRef));
static void didReceiveInvalidMessage(const IPC::StringReference& messageReceiverName, const IPC::StringReference& messageName);
void processDidCachePage(WebProcessProxy*);
bool isURLKnownHSTSHost(const String& urlString, bool privateBrowsingEnabled) const;
void resetHSTSHosts();
#if ENABLE(CUSTOM_PROTOCOLS)
void registerSchemeForCustomProtocol(const String&);
void unregisterSchemeForCustomProtocol(const String&);
static HashSet<String>& globalURLSchemesWithCustomProtocolHandlers();
static void registerGlobalURLSchemeAsHavingCustomProtocolHandlers(const String&);
static void unregisterGlobalURLSchemeAsHavingCustomProtocolHandlers(const String&);
#endif
#if PLATFORM(COCOA)
void updateProcessSuppressionState() const;
NSMutableDictionary *ensureBundleParameters();
NSMutableDictionary *bundleParameters() { return m_bundleParameters.get(); }
#endif
void setMemoryCacheDisabled(bool);
#if ENABLE(SERVICE_CONTROLS)
void refreshExistingServices();
#endif
private:
void platformInitialize();
void platformInitializeWebProcess(WebProcessCreationParameters&);
void platformInvalidateContext();
WebProcessProxy& createNewWebProcess();
void requestWebContentStatistics(StatisticsRequest*);
void requestNetworkingStatistics(StatisticsRequest*);
#if ENABLE(NETWORK_PROCESS)
void platformInitializeNetworkProcess(NetworkProcessCreationParameters&);
#endif
#if PLATFORM(IOS)
void writeWebContentToPasteboard(const WebCore::PasteboardWebContent&);
void writeImageToPasteboard(const WebCore::PasteboardImage&);
void writeStringToPasteboard(const String& pasteboardType, const String&);
void readStringFromPasteboard(uint64_t index, const String& pasteboardType, WTF::String&);
void readURLFromPasteboard(uint64_t index, const String& pasteboardType, String&);
void readBufferFromPasteboard(uint64_t index, const String& pasteboardType, SharedMemory::Handle&, uint64_t& size);
void getPasteboardItemsCount(uint64_t& itemsCount);
#endif
#if PLATFORM(COCOA)
void getPasteboardTypes(const String& pasteboardName, Vector<String>& pasteboardTypes);
void getPasteboardPathnamesForType(const String& pasteboardName, const String& pasteboardType, Vector<String>& pathnames);
void getPasteboardStringForType(const String& pasteboardName, const String& pasteboardType, String&);
void getPasteboardBufferForType(const String& pasteboardName, const String& pasteboardType, SharedMemory::Handle&, uint64_t& size);
void pasteboardCopy(const String& fromPasteboard, const String& toPasteboard, uint64_t& newChangeCount);
void getPasteboardChangeCount(const String& pasteboardName, uint64_t& changeCount);
void getPasteboardUniqueName(String& pasteboardName);
void getPasteboardColor(const String& pasteboardName, WebCore::Color&);
void getPasteboardURL(const String& pasteboardName, WTF::String&);
void addPasteboardTypes(const String& pasteboardName, const Vector<String>& pasteboardTypes, uint64_t& newChangeCount);
void setPasteboardTypes(const String& pasteboardName, const Vector<String>& pasteboardTypes, uint64_t& newChangeCount);
void setPasteboardPathnamesForType(const String& pasteboardName, const String& pasteboardType, const Vector<String>& pathnames, uint64_t& newChangeCount);
void setPasteboardStringForType(const String& pasteboardName, const String& pasteboardType, const String&, uint64_t& newChangeCount);
void setPasteboardBufferForType(const String& pasteboardName, const String& pasteboardType, const SharedMemory::Handle&, uint64_t size, uint64_t& newChangeCount);
#endif
#if !PLATFORM(COCOA)
void dummy(bool&);
#endif
void didGetStatistics(const StatisticsData&, uint64_t callbackID);
void didReceiveWebContextMessage(IPC::Connection*, IPC::MessageDecoder&);
void didReceiveSyncWebContextMessage(IPC::Connection*, IPC::MessageDecoder&, std::unique_ptr<IPC::MessageEncoder>&);
static void languageChanged(void* context);
void languageChanged();
String applicationCacheDirectory() const;
String platformDefaultApplicationCacheDirectory() const;
String platformDefaultIconDatabasePath() const;
static String platformDefaultLocalStorageDirectory();
static String platformDefaultIndexedDBDatabaseDirectory();
static String platformDefaultWebSQLDatabaseDirectory();
String diskCacheDirectory() const;
String platformDefaultDiskCacheDirectory() const;
String cookieStorageDirectory() const;
String platformDefaultCookieStorageDirectory() const;
String openGLCacheDirectory() const;
String platformDefaultOpenGLCacheDirectory() const;
String networkingHSTSDatabasePath() const;
String platformDefaultNetworkingHSTSDatabasePath() const;
#if PLATFORM(IOS)
String parentBundleDirectory() const;
String webContentHSTSDatabasePath() const;
#endif
String containerTemporaryDirectory() const;
#if PLATFORM(COCOA)
void registerNotificationObservers();
void unregisterNotificationObservers();
#endif
void addPlugInAutoStartOriginHash(const String& pageOrigin, unsigned plugInOriginHash, WebCore::SessionID);
void plugInDidReceiveUserInteraction(unsigned plugInOriginHash, WebCore::SessionID);
void setAnyPageGroupMightHavePrivateBrowsingEnabled(bool);
#if ENABLE(NETSCAPE_PLUGIN_API)
virtual void pluginInfoStoreDidLoadPlugins(PluginInfoStore*) override;
#endif
IPC::MessageReceiverMap m_messageReceiverMap;
ProcessModel m_processModel;
unsigned m_webProcessCountLimit;
Vector<RefPtr<WebProcessProxy>> m_processes;
bool m_haveInitialEmptyProcess;
WebProcessProxy* m_processWithPageCache;
Ref<WebPageGroup> m_defaultPageGroup;
RefPtr<API::Object> m_injectedBundleInitializationUserData;
String m_injectedBundlePath;
WebContextInjectedBundleClient m_injectedBundleClient;
WebContextClient m_client;
WebContextConnectionClient m_connectionClient;
std::unique_ptr<API::DownloadClient> m_downloadClient;
std::unique_ptr<API::HistoryClient> m_historyClient;
#if ENABLE(NETSCAPE_PLUGIN_API)
PluginInfoStore m_pluginInfoStore;
#endif
RefPtr<VisitedLinkProvider> m_visitedLinkProvider;
bool m_visitedLinksPopulated;
PlugInAutoStartProvider m_plugInAutoStartProvider;
HashSet<String> m_schemesToRegisterAsEmptyDocument;
HashSet<String> m_schemesToRegisterAsSecure;
HashSet<String> m_schemesToSetDomainRelaxationForbiddenFor;
HashSet<String> m_schemesToRegisterAsLocal;
HashSet<String> m_schemesToRegisterAsNoAccess;
HashSet<String> m_schemesToRegisterAsDisplayIsolated;
HashSet<String> m_schemesToRegisterAsCORSEnabled;
#if ENABLE(CACHE_PARTITIONING)
HashSet<String> m_schemesToRegisterAsCachePartitioned;
#endif
bool m_alwaysUsesComplexTextCodePath;
bool m_shouldUseFontSmoothing;
Vector<std::pair<String, RefPtr<API::Object>>> m_messagesToInjectedBundlePostedToEmptyContext;
CacheModel m_cacheModel;
bool m_memorySamplerEnabled;
double m_memorySamplerInterval;
RefPtr<WebIconDatabase> m_iconDatabase;
#if ENABLE(NETSCAPE_PLUGIN_API)
RefPtr<WebPluginSiteDataManager> m_pluginSiteDataManager;
#endif
RefPtr<StorageManager> m_storageManager;
typedef HashMap<const char*, RefPtr<WebContextSupplement>, PtrHash<const char*>> WebContextSupplementMap;
WebContextSupplementMap m_supplements;
#if USE(SOUP)
HTTPCookieAcceptPolicy m_initialHTTPCookieAcceptPolicy;
#endif
#if PLATFORM(MAC)
RetainPtr<NSObject> m_enhancedAccessibilityObserver;
RetainPtr<NSObject> m_automaticTextReplacementNotificationObserver;
RetainPtr<NSObject> m_automaticSpellingCorrectionNotificationObserver;
#if __MAC_OS_X_VERSION_MIN_REQUIRED >= 1090
RetainPtr<NSObject> m_automaticQuoteSubstitutionNotificationObserver;
RetainPtr<NSObject> m_automaticDashSubstitutionNotificationObserver;
#endif
#endif
String m_overrideApplicationCacheDirectory;
String m_overrideIconDatabasePath;
String m_overrideDiskCacheDirectory;
String m_overrideCookieStorageDirectory;
String m_overrideOpenGLCacheDirectory;
String m_webSQLDatabaseDirectory;
String m_indexedDBDatabaseDirectory;
bool m_shouldUseTestingNetworkSession;
bool m_processTerminationEnabled;
#if ENABLE(NETWORK_PROCESS)
bool m_usesNetworkProcess;
RefPtr<NetworkProcessProxy> m_networkProcess;
#endif
#if ENABLE(DATABASE_PROCESS)
RefPtr<DatabaseProcessProxy> m_databaseProcess;
#endif
HashMap<uint64_t, RefPtr<DictionaryCallback>> m_dictionaryCallbacks;
HashMap<uint64_t, RefPtr<StatisticsRequest>> m_statisticsRequests;
#if USE(SOUP)
bool m_ignoreTLSErrors;
#endif
bool m_memoryCacheDisabled;
#if PLATFORM(COCOA)
RetainPtr<NSMutableDictionary> m_bundleParameters;
#endif
};
template<typename T>
void WebContext::sendToNetworkingProcess(T&& message)
{
switch (m_processModel) {
case ProcessModelSharedSecondaryProcess:
#if ENABLE(NETWORK_PROCESS)
if (m_usesNetworkProcess) {
if (m_networkProcess && m_networkProcess->canSendMessage())
m_networkProcess->send(std::forward<T>(message), 0);
return;
}
#endif
if (!m_processes.isEmpty() && m_processes[0]->canSendMessage())
m_processes[0]->send(std::forward<T>(message), 0);
return;
case ProcessModelMultipleSecondaryProcesses:
#if ENABLE(NETWORK_PROCESS)
if (m_networkProcess && m_networkProcess->canSendMessage())
m_networkProcess->send(std::forward<T>(message), 0);
return;
#else
break;
#endif
}
ASSERT_NOT_REACHED();
}
template<typename T>
void WebContext::sendToNetworkingProcessRelaunchingIfNecessary(T&& message)
{
switch (m_processModel) {
case ProcessModelSharedSecondaryProcess:
#if ENABLE(NETWORK_PROCESS)
if (m_usesNetworkProcess) {
ensureNetworkProcess();
m_networkProcess->send(std::forward<T>(message), 0);
return;
}
#endif
ensureSharedWebProcess();
m_processes[0]->send(std::forward<T>(message), 0);
return;
case ProcessModelMultipleSecondaryProcesses:
#if ENABLE(NETWORK_PROCESS)
ensureNetworkProcess();
m_networkProcess->send(std::forward<T>(message), 0);
return;
#else
break;
#endif
}
ASSERT_NOT_REACHED();
}
#if ENABLE(DATABASE_PROCESS)
template<typename T>
void WebContext::sendToDatabaseProcessRelaunchingIfNecessary(T&& message)
{
ensureDatabaseProcess();
m_databaseProcess->send(std::forward<T>(message), 0);
}
#endif
template<typename T>
void WebContext::sendToAllProcesses(const T& message)
{
size_t processCount = m_processes.size();
for (size_t i = 0; i < processCount; ++i) {
WebProcessProxy* process = m_processes[i].get();
if (process->canSendMessage())
process->send(T(message), 0);
}
}
template<typename T>
void WebContext::sendToAllProcessesRelaunchingThemIfNecessary(const T& message)
{
if (m_processModel == ProcessModelSharedSecondaryProcess)
ensureSharedWebProcess();
sendToAllProcesses(message);
}
template<typename T>
void WebContext::sendToOneProcess(T&& message)
{
if (m_processModel == ProcessModelSharedSecondaryProcess)
ensureSharedWebProcess();
bool messageSent = false;
size_t processCount = m_processes.size();
for (size_t i = 0; i < processCount; ++i) {
WebProcessProxy* process = m_processes[i].get();
if (process->canSendMessage()) {
process->send(std::forward<T>(message), 0);
messageSent = true;
break;
}
}
if (!messageSent && m_processModel == ProcessModelMultipleSecondaryProcesses) {
warmInitialProcess();
RefPtr<WebProcessProxy> process = m_processes.last();
if (process->canSendMessage())
process->send(std::forward<T>(message), 0);
}
}
}
#endif // WebContext_h