Resource Load Statistics: Grandfather domains for existing data records
[WebKit-https.git] / Source / WebCore / loader / ResourceLoadStatisticsStore.h
1 /*
2  * Copyright (C) 2016-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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "ResourceLoadStatistics.h"
29 #include <wtf/HashSet.h>
30
31 namespace WebCore {
32
33 class KeyedDecoder;
34 class KeyedEncoder;
35 class URL;
36
37 struct ResourceLoadStatistics;
38
39 class ResourceLoadStatisticsStore : public RefCounted<ResourceLoadStatisticsStore> {
40 public:
41     WEBCORE_EXPORT static Ref<ResourceLoadStatisticsStore> create();
42
43     WEBCORE_EXPORT std::unique_ptr<KeyedEncoder> createEncoderFromData();
44     WEBCORE_EXPORT void readDataFromDecoder(KeyedDecoder&);
45
46     WEBCORE_EXPORT String statisticsForOrigin(const String&);
47
48     bool isEmpty() const { return m_resourceStatisticsMap.isEmpty(); }
49     size_t size() const { return m_resourceStatisticsMap.size(); }
50     WEBCORE_EXPORT void clearInMemory();
51     void clearInMemoryAndPersistent();
52
53     ResourceLoadStatistics& ensureResourceStatisticsForPrimaryDomain(const String&);
54     void setResourceStatisticsForPrimaryDomain(const String&, ResourceLoadStatistics&&);
55
56     bool isPrevalentResource(const String&) const;
57     
58     WEBCORE_EXPORT void mergeStatistics(const Vector<ResourceLoadStatistics>&);
59     WEBCORE_EXPORT Vector<ResourceLoadStatistics> takeStatistics();
60
61     WEBCORE_EXPORT void setNotificationCallback(std::function<void()>);
62     WEBCORE_EXPORT void setShouldPartitionCookiesCallback(std::function<void(const Vector<String>& domainsToRemove, const Vector<String>& domainsToAdd, bool clearFirst)>&&);
63     WEBCORE_EXPORT void setWritePersistentStoreCallback(std::function<void()>&&);
64     WEBCORE_EXPORT void setGrandfatherExistingWebsiteDataCallback(std::function<void()>&&);
65
66     void fireDataModificationHandler();
67     void setTimeToLiveUserInteraction(double seconds);
68     void setTimeToLiveCookiePartitionFree(double seconds);
69     void setMinimumTimeBetweeenDataRecordsRemoval(double seconds);
70     void setGrandfatheringTime(double seconds);    
71     WEBCORE_EXPORT void fireShouldPartitionCookiesHandler();
72     void fireShouldPartitionCookiesHandler(const Vector<String>& domainsToRemove, const Vector<String>& domainsToAdd, bool clearFirst);
73
74     WEBCORE_EXPORT void processStatistics(std::function<void(ResourceLoadStatistics&)>&&);
75
76     WEBCORE_EXPORT bool hasHadRecentUserInteraction(ResourceLoadStatistics&);
77     WEBCORE_EXPORT Vector<String> topPrivatelyControlledDomainsToRemoveWebsiteDataFor();
78     WEBCORE_EXPORT void updateStatisticsForRemovedDataRecords(const Vector<String>& prevalentResourceDomains);
79
80     WEBCORE_EXPORT void handleFreshStartWithEmptyOrNoStore(HashSet<String>&& topPrivatelyControlledDomainsToGrandfather);
81     WEBCORE_EXPORT bool shouldRemoveDataRecords();
82     WEBCORE_EXPORT void dataRecordsBeingRemoved();
83     WEBCORE_EXPORT void dataRecordsWereRemoved();
84 private:
85     ResourceLoadStatisticsStore() = default;
86
87     HashMap<String, ResourceLoadStatistics> m_resourceStatisticsMap;
88     std::function<void()> m_dataAddedHandler;
89     std::function<void(const Vector<String>&, const Vector<String>&, bool clearFirst)> m_shouldPartitionCookiesForDomainsHandler;
90     std::function<void()> m_writePersistentStoreHandler;
91     std::function<void()> m_grandfatherExistingWebsiteDataHandler;
92
93     double m_endOfGrandfatheringTimestamp { 0 };
94     double m_lastTimeDataRecordsWereRemoved { 0 };
95     bool m_dataRecordsRemovalPending { false };
96 };
97     
98 } // namespace WebCore