Resource Load Statistics: Grandfather domains for existing data records
[WebKit-https.git] / Source / WebKit2 / UIProcess / WebResourceLoadStatisticsStore.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. 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 "APIObject.h"
29 #include "Connection.h"
30 #include "ResourceLoadStatisticsClassifier.h"
31 #include "WebsiteDataRecord.h"
32 #include <WebCore/ResourceLoadStatisticsStore.h>
33 #include <wtf/Vector.h>
34 #include <wtf/text/WTFString.h>
35
36 #if HAVE(CORE_PREDICTION)
37 #include "ResourceLoadStatisticsClassifierCocoa.h"
38 #endif
39
40 namespace WTF {
41 class WorkQueue;
42 }
43
44 namespace WebCore {
45 class KeyedDecoder;
46 class KeyedEncoder;
47 struct ResourceLoadStatistics;
48 }
49
50 namespace WebKit {
51
52 class WebProcessPool;
53 class WebProcessProxy;
54
55 class WebResourceLoadStatisticsStore : public IPC::Connection::WorkQueueMessageReceiver {
56 public:
57     static Ref<WebResourceLoadStatisticsStore> create(const String&);
58     static void setNotifyPagesWhenDataRecordsWereScanned(bool);
59     static void setShouldClassifyResourcesBeforeDataRecordsRemoval(bool);
60     static void setMinimumTimeBetweeenDataRecordsRemoval(double);
61     virtual ~WebResourceLoadStatisticsStore();
62     
63     void setResourceLoadStatisticsEnabled(bool);
64     bool resourceLoadStatisticsEnabled() const;
65     void registerSharedResourceLoadObserver();
66     void registerSharedResourceLoadObserver(std::function<void(const Vector<String>& domainsToRemove, const Vector<String>& domainsToAdd, bool clearFirst)>&& shouldPartitionCookiesForDomainsHandler);
67     
68     void resourceLoadStatisticsUpdated(const Vector<WebCore::ResourceLoadStatistics>& origins);
69
70     void processWillOpenConnection(WebProcessProxy&, IPC::Connection&);
71     void processDidCloseConnection(WebProcessProxy&, IPC::Connection&);
72     void applicationWillTerminate();
73
74     void readDataFromDiskIfNeeded();
75
76     WebCore::ResourceLoadStatisticsStore& coreStore() { return m_resourceLoadStatisticsStore.get(); }
77     const WebCore::ResourceLoadStatisticsStore& coreStore() const { return m_resourceLoadStatisticsStore.get(); }
78
79 private:
80     explicit WebResourceLoadStatisticsStore(const String&);
81
82     void processStatisticsAndDataRecords();
83
84     void classifyResource(WebCore::ResourceLoadStatistics&);
85     void removeDataRecords();
86
87     String persistentStoragePath(const String& label) const;
88
89     // IPC::MessageReceiver
90     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
91
92     void grandfatherExistingWebsiteData();
93
94     void writeStoreToDisk();
95     void writeEncoderToDisk(WebCore::KeyedEncoder&, const String& label) const;
96     std::unique_ptr<WebCore::KeyedDecoder> createDecoderFromDisk(const String& label) const;
97     void platformExcludeFromBackup() const;
98
99     Ref<WebCore::ResourceLoadStatisticsStore> m_resourceLoadStatisticsStore;
100 #if HAVE(CORE_PREDICTION)
101     ResourceLoadStatisticsClassifierCocoa m_resourceLoadStatisticsClassifier;
102 #else
103     ResourceLoadStatisticsClassifier m_resourceLoadStatisticsClassifier;
104 #endif
105     Ref<WTF::WorkQueue> m_statisticsQueue;
106     String m_statisticsStoragePath;
107     bool m_resourceLoadStatisticsEnabled { false };
108 };
109
110 } // namespace WebKit