Move NetworkCache ownership from NetworkProcess to NetworkSession
[WebKit-https.git] / Source / WebKit / NetworkProcess / NetworkSession.h
1 /*
2  * Copyright (C) 2015-2019 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 "PrefetchCache.h"
29 #include "SandboxExtension.h"
30 #include "WebResourceLoadStatisticsStore.h"
31 #include <WebCore/AdClickAttribution.h>
32 #include <WebCore/RegistrableDomain.h>
33 #include <pal/SessionID.h>
34 #include <wtf/HashSet.h>
35 #include <wtf/Ref.h>
36 #include <wtf/RefCounted.h>
37 #include <wtf/Seconds.h>
38 #include <wtf/UniqueRef.h>
39 #include <wtf/WeakPtr.h>
40 #include <wtf/text/WTFString.h>
41
42 namespace WebCore {
43 class NetworkStorageSession;
44 class ResourceRequest;
45 enum class IncludeHttpOnlyCookies : bool;
46 enum class ShouldSample : bool;
47 }
48
49 namespace WebKit {
50
51 class AdClickAttributionManager;
52 class NetworkDataTask;
53 class NetworkProcess;
54 class NetworkResourceLoader;
55 class StorageManager;
56 class NetworkSocketChannel;
57 class WebResourceLoadStatisticsStore;
58 class WebSocketTask;
59 struct NetworkSessionCreationParameters;
60
61 enum class WebsiteDataType;
62
63 namespace NetworkCache {
64 class Cache;
65 }
66
67 class NetworkSession : public RefCounted<NetworkSession>, public CanMakeWeakPtr<NetworkSession> {
68 public:
69     static Ref<NetworkSession> create(NetworkProcess&, NetworkSessionCreationParameters&&);
70     virtual ~NetworkSession();
71
72     virtual void invalidateAndCancel();
73     virtual void clearCredentials() { };
74     virtual bool shouldLogCookieInformation() const { return false; }
75     virtual Seconds loadThrottleLatency() const { return { }; }
76
77     PAL::SessionID sessionID() const { return m_sessionID; }
78     NetworkProcess& networkProcess() { return m_networkProcess; }
79     WebCore::NetworkStorageSession* networkStorageSession() const;
80
81     void registerNetworkDataTask(NetworkDataTask& task) { m_dataTaskSet.add(&task); }
82     void unregisterNetworkDataTask(NetworkDataTask& task) { m_dataTaskSet.remove(&task); }
83
84     StorageManager& storageManager() { return m_storageManager.get(); }
85
86 #if ENABLE(RESOURCE_LOAD_STATISTICS)
87     WebResourceLoadStatisticsStore* resourceLoadStatistics() const { return m_resourceLoadStatistics.get(); }
88     void setResourceLoadStatisticsEnabled(bool);
89     void notifyResourceLoadStatisticsProcessed();
90     void deleteWebsiteDataForRegistrableDomains(OptionSet<WebsiteDataType>, HashMap<WebCore::RegistrableDomain, WebsiteDataToRemove>&&, bool shouldNotifyPage, CompletionHandler<void(const HashSet<WebCore::RegistrableDomain>&)>&&);
91     void registrableDomainsWithWebsiteData(OptionSet<WebsiteDataType>, bool shouldNotifyPage, CompletionHandler<void(HashSet<WebCore::RegistrableDomain>&&)>&&);
92     void logDiagnosticMessageWithValue(const String& message, const String& description, unsigned value, unsigned significantFigures, WebCore::ShouldSample);
93     void notifyPageStatisticsTelemetryFinished(unsigned totalPrevalentResources, unsigned totalPrevalentResourcesWithUserInteraction, unsigned top3SubframeUnderTopFrameOrigins);
94 #endif
95     void storeAdClickAttribution(WebCore::AdClickAttribution&&);
96     void handleAdClickAttributionConversion(WebCore::AdClickAttribution::Conversion&&, const URL& requestURL, const WebCore::ResourceRequest& redirectRequest);
97     void dumpAdClickAttribution(CompletionHandler<void(String)>&&);
98     void clearAdClickAttribution();
99     void clearAdClickAttributionForRegistrableDomain(WebCore::RegistrableDomain&&);
100     void setAdClickAttributionOverrideTimerForTesting(bool value);
101     void setAdClickAttributionConversionURLForTesting(URL&&);
102     void markAdClickAttributionsAsExpiredForTesting();
103
104     void addKeptAliveLoad(Ref<NetworkResourceLoader>&&);
105     void removeKeptAliveLoad(NetworkResourceLoader&);
106
107     NetworkCache::Cache* cache() { return m_cache.get(); }
108
109     PrefetchCache& prefetchCache() { return m_prefetchCache; }
110     void clearPrefetchCache() { m_prefetchCache.clear(); }
111
112     virtual std::unique_ptr<WebSocketTask> createWebSocketTask(NetworkSocketChannel&, const WebCore::ResourceRequest&, const String& protocol);
113     virtual void removeWebSocketTask(WebSocketTask&) { }
114     virtual void addWebSocketTask(WebSocketTask&) { }
115
116 protected:
117     NetworkSession(NetworkProcess&, const NetworkSessionCreationParameters&);
118
119     PAL::SessionID m_sessionID;
120     Ref<NetworkProcess> m_networkProcess;
121     HashSet<NetworkDataTask*> m_dataTaskSet;
122     String m_resourceLoadStatisticsDirectory;
123 #if ENABLE(RESOURCE_LOAD_STATISTICS)
124     RefPtr<WebResourceLoadStatisticsStore> m_resourceLoadStatistics;
125     ShouldIncludeLocalhost m_shouldIncludeLocalhostInResourceLoadStatistics { ShouldIncludeLocalhost::Yes };
126     EnableResourceLoadStatisticsDebugMode m_enableResourceLoadStatisticsDebugMode { EnableResourceLoadStatisticsDebugMode::No };
127     WebCore::RegistrableDomain m_resourceLoadStatisticsManualPrevalentResource;
128 #endif
129     UniqueRef<AdClickAttributionManager> m_adClickAttribution;
130
131     HashSet<Ref<NetworkResourceLoader>> m_keptAliveLoads;
132
133     PrefetchCache m_prefetchCache;
134
135     Ref<StorageManager> m_storageManager;
136 #if !ASSERT_DISABLED
137     bool m_isInvalidated { false };
138 #endif
139     RefPtr<NetworkCache::Cache> m_cache;
140 };
141
142 } // namespace WebKit