Adopt WebCore::RegistrableDomain in WebCore::ResourceLoadStatistics and WebKit::Netwo...
[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 <WebCore/RegistrableDomain.h>
29 #include <pal/SessionID.h>
30 #include <wtf/HashSet.h>
31 #include <wtf/Ref.h>
32 #include <wtf/RefCounted.h>
33 #include <wtf/Seconds.h>
34 #include <wtf/UniqueRef.h>
35 #include <wtf/WeakPtr.h>
36 #include <wtf/text/WTFString.h>
37
38 namespace WebCore {
39 class AdClickAttribution;
40 class NetworkStorageSession;
41 enum class ShouldSample : bool;
42 }
43
44 namespace WebKit {
45
46 class NetworkAdClickAttribution;
47 class NetworkDataTask;
48 class NetworkProcess;
49 class WebResourceLoadStatisticsStore;
50 struct NetworkSessionCreationParameters;
51
52 enum class WebsiteDataType;
53     
54 class NetworkSession : public RefCounted<NetworkSession>, public CanMakeWeakPtr<NetworkSession> {
55 public:
56     static Ref<NetworkSession> create(NetworkProcess&, NetworkSessionCreationParameters&&);
57     virtual ~NetworkSession();
58
59     virtual void invalidateAndCancel();
60     virtual void clearCredentials() { };
61     virtual bool shouldLogCookieInformation() const { return false; }
62     virtual Seconds loadThrottleLatency() const { return { }; }
63
64     PAL::SessionID sessionID() const { return m_sessionID; }
65     NetworkProcess& networkProcess() { return m_networkProcess; }
66     WebCore::NetworkStorageSession& networkStorageSession() const;
67
68     void registerNetworkDataTask(NetworkDataTask& task) { m_dataTaskSet.add(&task); }
69     void unregisterNetworkDataTask(NetworkDataTask& task) { m_dataTaskSet.remove(&task); }
70
71 #if ENABLE(RESOURCE_LOAD_STATISTICS)
72     WebResourceLoadStatisticsStore* resourceLoadStatistics() const { return m_resourceLoadStatistics.get(); }
73     void setResourceLoadStatisticsEnabled(bool);
74     void notifyResourceLoadStatisticsProcessed();
75     void deleteWebsiteDataForRegistrableDomainsInAllPersistentDataStores(OptionSet<WebsiteDataType>, Vector<WebCore::RegistrableDomain>&&, bool shouldNotifyPage, CompletionHandler<void(const HashSet<WebCore::RegistrableDomain>&)>&&);
76     void registrableDomainsWithWebsiteData(OptionSet<WebsiteDataType>, bool shouldNotifyPage, CompletionHandler<void(HashSet<WebCore::RegistrableDomain>&&)>&&);
77     void logDiagnosticMessageWithValue(const String& message, const String& description, unsigned value, unsigned significantFigures, WebCore::ShouldSample);
78     void notifyPageStatisticsTelemetryFinished(unsigned totalPrevalentResources, unsigned totalPrevalentResourcesWithUserInteraction, unsigned top3SubframeUnderTopFrameOrigins);
79 #endif
80     void storeAdClickAttribution(WebCore::AdClickAttribution&&);
81     void dumpAdClickAttribution(CompletionHandler<void(String)>&&);
82     void clearAdClickAttribution(CompletionHandler<void()>&&);
83
84 protected:
85     NetworkSession(NetworkProcess&, PAL::SessionID);
86
87     PAL::SessionID m_sessionID;
88     Ref<NetworkProcess> m_networkProcess;
89     HashSet<NetworkDataTask*> m_dataTaskSet;
90     String m_resourceLoadStatisticsDirectory;
91 #if ENABLE(RESOURCE_LOAD_STATISTICS)
92     RefPtr<WebResourceLoadStatisticsStore> m_resourceLoadStatistics;
93 #endif
94     UniqueRef<NetworkAdClickAttribution> m_adClickAttribution;
95 };
96
97 } // namespace WebKit