Source/WebKit/UIProcess/WebsiteData/WebsiteDataStore.h

   1 /*
   2  * Copyright (C) 2014-2017 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #pragma once
  27
  28 #include "NetworkSessionCreationParameters.h"
  29 #include "WebProcessLifetimeObserver.h"
  30 #include <WebCore/Cookie.h>
  31 #include <WebCore/SecurityOriginData.h>
  32 #include <WebCore/SecurityOriginHash.h>
  33 #include <pal/SessionID.h>
  34 #include <wtf/Function.h>
  35 #include <wtf/HashSet.h>
  36 #include <wtf/Identified.h>
  37 #include <wtf/OptionSet.h>
  38 #include <wtf/RefCounted.h>
  39 #include <wtf/RefPtr.h>
  40 #include <wtf/WorkQueue.h>
  41 #include <wtf/text/WTFString.h>
  42
  43 #if PLATFORM(COCOA)
  44 #include <pal/spi/cf/CFNetworkSPI.h>
  45 #endif
  46
  47 namespace WebCore {
  48 class SecurityOrigin;
  49 }
  50
  51 namespace WebKit {
  52
  53 class StorageManager;
  54 class WebPageProxy;
  55 class WebProcessPool;
  56 class WebResourceLoadStatisticsStore;
  57 enum class WebsiteDataFetchOption;
  58 enum class WebsiteDataType;
  59 struct StorageProcessCreationParameters;
  60 struct WebsiteDataRecord;
  61 struct WebsiteDataStoreParameters;
  62
  63 #if ENABLE(NETSCAPE_PLUGIN_API)
  64 struct PluginModuleInfo;
  65 #endif
  66
  67 enum class ShouldClearFirst { No, Yes };
  68
  69 class WebsiteDataStore : public RefCounted<WebsiteDataStore>, public WebProcessLifetimeObserver, public Identified<WebsiteDataStore>  {
  70 public:
  71     constexpr static uint64_t defaultCacheStoragePerOriginQuota = 20 * 1024 * 1024;
  72
  73     struct Configuration {
  74         String cacheStorageDirectory;
  75         uint64_t cacheStoragePerOriginQuota { defaultCacheStoragePerOriginQuota };
  76         String networkCacheDirectory;
  77         String applicationCacheDirectory;
  78         String applicationCacheFlatFileSubdirectoryName;
  79
  80         String mediaCacheDirectory;
  81         String indexedDBDatabaseDirectory;
  82         String serviceWorkerRegistrationDirectory;
  83         String webSQLDatabaseDirectory;
  84         String localStorageDirectory;
  85         String mediaKeysStorageDirectory;
  86         String resourceLoadStatisticsDirectory;
  87         String javaScriptConfigurationDirectory;
  88         String cookieStorageFile;
  89     };
  90     static Ref<WebsiteDataStore> createNonPersistent();
  91     static Ref<WebsiteDataStore> create(Configuration, PAL::SessionID);
  92     virtual ~WebsiteDataStore();
  93
  94     static WebsiteDataStore* existingNonDefaultDataStoreForSessionID(PAL::SessionID);
  95
  96     bool isPersistent() const { return !m_sessionID.isEphemeral(); }
  97     PAL::SessionID sessionID() const { return m_sessionID; }
  98
  99     bool resourceLoadStatisticsEnabled() const;
 100     void setResourceLoadStatisticsEnabled(bool);
 101
 102     uint64_t cacheStoragePerOriginQuota() const { return m_resolvedConfiguration.cacheStoragePerOriginQuota; }
 103     void setCacheStoragePerOriginQuota(uint64_t quota) { m_resolvedConfiguration.cacheStoragePerOriginQuota = quota; }
 104     const String& cacheStorageDirectory() const { return m_resolvedConfiguration.cacheStorageDirectory; }
 105     void setCacheStorageDirectory(String&& directory) { m_resolvedConfiguration.cacheStorageDirectory = WTFMove(directory); }
 106
 107     WebResourceLoadStatisticsStore* resourceLoadStatistics() const { return m_resourceLoadStatistics.get(); }
 108     void clearResourceLoadStatisticsInWebProcesses();
 109
 110     static void cloneSessionData(WebPageProxy& sourcePage, WebPageProxy& newPage);
 111
 112     void fetchData(OptionSet<WebsiteDataType>, OptionSet<WebsiteDataFetchOption>, Function<void(Vector<WebsiteDataRecord>)>&& completionHandler);
 113     void fetchDataForTopPrivatelyControlledDomains(OptionSet<WebsiteDataType>, OptionSet<WebsiteDataFetchOption>, const Vector<String>& topPrivatelyControlledDomains, Function<void(Vector<WebsiteDataRecord>&&, HashSet<String>&&)>&& completionHandler);
 114     void topPrivatelyControlledDomainsWithWebsiteData(OptionSet<WebsiteDataType> dataTypes, OptionSet<WebsiteDataFetchOption> fetchOptions, Function<void(HashSet<String>&&)>&& completionHandler);
 115     void removeData(OptionSet<WebsiteDataType>, std::chrono::system_clock::time_point modifiedSince, Function<void()>&& completionHandler);
 116     void removeData(OptionSet<WebsiteDataType>, const Vector<WebsiteDataRecord>&, Function<void()>&& completionHandler);
 117     void removeDataForTopPrivatelyControlledDomains(OptionSet<WebsiteDataType>, OptionSet<WebsiteDataFetchOption>, const Vector<String>& topPrivatelyControlledDomains, Function<void(HashSet<String>&&)>&& completionHandler);
 118
 119 #if HAVE(CFNETWORK_STORAGE_PARTITIONING)
 120     void updatePrevalentDomainsToPartitionOrBlockCookies(const Vector<String>& domainsToPartition, const Vector<String>& domainsToBlock, const Vector<String>& domainsToNeitherPartitionNorBlock, ShouldClearFirst);
 121     void updateStorageAccessForPrevalentDomainsHandler(const String& resourceDomain, const String& firstPartyDomain, uint64_t frameID, uint64_t pageID, bool value, WTF::CompletionHandler<void(bool wasGranted)>&& callback);
 122     void removePrevalentDomains(const Vector<String>& domains);
 123 #endif
 124     void networkProcessDidCrash();
 125     void resolveDirectoriesIfNecessary();
 126     const String& resolvedApplicationCacheDirectory() const { return m_resolvedConfiguration.applicationCacheDirectory; }
 127     const String& resolvedMediaCacheDirectory() const { return m_resolvedConfiguration.mediaCacheDirectory; }
 128     const String& resolvedMediaKeysDirectory() const { return m_resolvedConfiguration.mediaKeysStorageDirectory; }
 129     const String& resolvedDatabaseDirectory() const { return m_resolvedConfiguration.webSQLDatabaseDirectory; }
 130     const String& resolvedJavaScriptConfigurationDirectory() const { return m_resolvedConfiguration.javaScriptConfigurationDirectory; }
 131     const String& resolvedCookieStorageFile() const { return m_resolvedConfiguration.cookieStorageFile; }
 132     const String& resolvedIndexedDatabaseDirectory() const { return m_resolvedConfiguration.indexedDBDatabaseDirectory; }
 133     const String& resolvedServiceWorkerRegistrationDirectory() const { return m_resolvedConfiguration.serviceWorkerRegistrationDirectory; }
 134
 135     StorageManager* storageManager() { return m_storageManager.get(); }
 136
 137     WebProcessPool* processPoolForCookieStorageOperations();
 138     bool isAssociatedProcessPool(WebProcessPool&) const;
 139
 140     WebsiteDataStoreParameters parameters();
 141     StorageProcessCreationParameters storageProcessParameters();
 142
 143     Vector<WebCore::Cookie> pendingCookies() const;
 144     void addPendingCookie(const WebCore::Cookie&);
 145     void removePendingCookie(const WebCore::Cookie&);
 146
 147     void enableResourceLoadStatisticsAndSetTestingCallback(Function<void (const String&)>&& callback);
 148
 149     void hasStorageAccess(String&& subFrameHost, String&& topFrameHost, WTF::CompletionHandler<void (bool)>&& callback);
 150     void requestStorageAccess(String&& subFrameHost, String&& topFrameHost, uint64_t frameID, uint64_t pageID, WTF::CompletionHandler<void (bool)>&& callback);
 151
 152     void setBoundInterfaceIdentifier(String&& identifier) { m_boundInterfaceIdentifier = WTFMove(identifier); }
 153     const String& boundInterfaceIdentifier() { return m_boundInterfaceIdentifier; }
 154
 155     void setAllowsCellularAccess(AllowsCellularAccess allows) { m_allowsCellularAccess = allows; }
 156     AllowsCellularAccess allowsCellularAccess() { return m_allowsCellularAccess; }
 157
 158 private:
 159     explicit WebsiteDataStore(PAL::SessionID);
 160     explicit WebsiteDataStore(Configuration, PAL::SessionID);
 161
 162     void fetchDataAndApply(OptionSet<WebsiteDataType>, OptionSet<WebsiteDataFetchOption>, RefPtr<WorkQueue>&&, Function<void(Vector<WebsiteDataRecord>)>&& apply);
 163
 164     // WebProcessLifetimeObserver.
 165     void webPageWasAdded(WebPageProxy&) override;
 166     void webPageWasRemoved(WebPageProxy&) override;
 167     void webProcessWillOpenConnection(WebProcessProxy&, IPC::Connection&) override;
 168     void webPageWillOpenConnection(WebPageProxy&, IPC::Connection&) override;
 169     void webPageDidCloseConnection(WebPageProxy&, IPC::Connection&) override;
 170     void webProcessDidCloseConnection(WebProcessProxy&, IPC::Connection&) override;
 171
 172     void platformInitialize();
 173     void platformDestroy();
 174     static void platformRemoveRecentSearches(std::chrono::system_clock::time_point);
 175
 176     HashSet<RefPtr<WebProcessPool>> processPools(size_t count = std::numeric_limits<size_t>::max(), bool ensureAPoolExists = true) const;
 177
 178 #if ENABLE(NETSCAPE_PLUGIN_API)
 179     Vector<PluginModuleInfo> plugins() const;
 180 #endif
 181
 182     static Vector<WebCore::SecurityOriginData> mediaKeyOrigins(const String& mediaKeysStorageDirectory);
 183     static void removeMediaKeys(const String& mediaKeysStorageDirectory, std::chrono::system_clock::time_point modifiedSince);
 184     static void removeMediaKeys(const String& mediaKeysStorageDirectory, const HashSet<WebCore::SecurityOriginData>&);
 185
 186     void maybeRegisterWithSessionIDMap();
 187
 188     const PAL::SessionID m_sessionID;
 189
 190     const Configuration m_configuration;
 191     Configuration m_resolvedConfiguration;
 192     bool m_hasResolvedDirectories { false };
 193
 194     const RefPtr<StorageManager> m_storageManager;
 195     RefPtr<WebResourceLoadStatisticsStore> m_resourceLoadStatistics;
 196
 197     Ref<WorkQueue> m_queue;
 198
 199 #if PLATFORM(COCOA)
 200     Vector<uint8_t> m_uiProcessCookieStorageIdentifier;
 201     RetainPtr<CFHTTPCookieStorageRef> m_cfCookieStorage;
 202 #endif
 203     HashSet<WebCore::Cookie> m_pendingCookies;
 204
 205     String m_boundInterfaceIdentifier;
 206     AllowsCellularAccess m_allowsCellularAccess { AllowsCellularAccess::Yes };
 207 };
 208
 209 }