Resource Load Statistics: Grandfather domains for existing data records
[WebKit-https.git] / Source / WebCore / loader / ResourceLoadObserver.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 "ResourceLoadStatisticsStore.h"
29 #include <wtf/HashMap.h>
30 #include <wtf/text/WTFString.h>
31
32 namespace WebCore {
33
34 class Document;
35 class Frame;
36 class Page;
37 class ResourceRequest;
38 class ResourceResponse;
39 class URL;
40
41 struct ResourceLoadStatistics;
42
43 class ResourceLoadObserver {
44     friend class NeverDestroyed<ResourceLoadObserver>;
45 public:
46     WEBCORE_EXPORT static ResourceLoadObserver& sharedObserver();
47     
48     void logFrameNavigation(const Frame& frame, const Frame& topFrame, const ResourceRequest& newRequest, const ResourceResponse& redirectResponse);
49     void logSubresourceLoading(const Frame*, const ResourceRequest& newRequest, const ResourceResponse& redirectResponse);
50     void logWebSocketLoading(const Frame*, const URL&);
51     void logUserInteractionWithReducedTimeResolution(const Document&);
52
53     WEBCORE_EXPORT void logUserInteraction(const URL&);
54     WEBCORE_EXPORT bool hasHadUserInteraction(const URL&);
55     WEBCORE_EXPORT void clearUserInteraction(const URL&);
56
57     WEBCORE_EXPORT void setPrevalentResource(const URL&);
58     WEBCORE_EXPORT bool isPrevalentResource(const URL&);
59     WEBCORE_EXPORT void clearPrevalentResource(const URL&);
60     WEBCORE_EXPORT void setGrandfathered(const URL&, bool value);
61     WEBCORE_EXPORT bool isGrandfathered(const URL&);
62     
63     WEBCORE_EXPORT void setSubframeUnderTopFrameOrigin(const URL& subframe, const URL& topFrame);
64     WEBCORE_EXPORT void setSubresourceUnderTopFrameOrigin(const URL& subresource, const URL& topFrame);
65     WEBCORE_EXPORT void setSubresourceUniqueRedirectTo(const URL& subresource, const URL& hostNameRedirectedTo);
66
67     WEBCORE_EXPORT void setTimeToLiveUserInteraction(double seconds);
68     WEBCORE_EXPORT void setTimeToLiveCookiePartitionFree(double seconds);
69     WEBCORE_EXPORT void setMinimumTimeBetweeenDataRecordsRemoval(double seconds);
70     WEBCORE_EXPORT void setReducedTimestampResolution(double seconds);
71     WEBCORE_EXPORT void setGrandfatheringTime(double seconds);
72     
73     WEBCORE_EXPORT void fireDataModificationHandler();
74     WEBCORE_EXPORT void fireShouldPartitionCookiesHandler();
75     WEBCORE_EXPORT void fireShouldPartitionCookiesHandler(const Vector<String>& domainsToRemove, const Vector<String>& domainsToAdd, bool clearFirst);
76
77     WEBCORE_EXPORT void setStatisticsStore(Ref<ResourceLoadStatisticsStore>&&);
78     WEBCORE_EXPORT void clearInMemoryStore();
79     WEBCORE_EXPORT void clearInMemoryAndPersistentStore();
80     WEBCORE_EXPORT void clearInMemoryAndPersistentStore(std::chrono::system_clock::time_point modifiedSince);
81
82     WEBCORE_EXPORT String statisticsForOrigin(const String&);
83
84 private:
85     bool shouldLog(Page*);
86     static String primaryDomain(const URL&);
87     static String primaryDomain(const String& host);
88
89     RefPtr<ResourceLoadStatisticsStore> m_store;
90     HashMap<String, size_t> m_originsVisitedMap;
91 };
92     
93 } // namespace WebCore