Resource Load Statistics: Add alternate classification method
[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 #ifndef WebResourceLoadStatisticsStore_h
27 #define WebResourceLoadStatisticsStore_h
28
29 #include "APIObject.h"
30 #include "Connection.h"
31 #include "ResourceLoadStatisticsClassifier.h"
32 #include "WebsiteDataRecord.h"
33 #include <WebCore/ResourceLoadStatisticsStore.h>
34 #include <wtf/Vector.h>
35 #include <wtf/text/WTFString.h>
36
37 namespace WTF {
38 class WorkQueue;
39 }
40
41 namespace WebCore {
42 class KeyedDecoder;
43 class KeyedEncoder;
44 struct ResourceLoadStatistics;
45 }
46
47 namespace WebKit {
48
49 class WebProcessPool;
50 class WebProcessProxy;
51
52 class WebResourceLoadStatisticsStore : public IPC::Connection::WorkQueueMessageReceiver {
53 public:
54     static Ref<WebResourceLoadStatisticsStore> create(const String&);
55     static void setNotifyPagesWhenDataRecordsWereScanned(bool);
56     static void setShouldClassifyResourcesBeforeDataRecordsRemoval(bool);
57     static void setMinimumTimeBetweeenDataRecordsRemoval(double);
58     virtual ~WebResourceLoadStatisticsStore();
59     
60     void setResourceLoadStatisticsEnabled(bool);
61     bool resourceLoadStatisticsEnabled() const;
62     void registerSharedResourceLoadObserver();
63     
64     void resourceLoadStatisticsUpdated(const Vector<WebCore::ResourceLoadStatistics>& origins);
65
66     void processWillOpenConnection(WebProcessProxy&, IPC::Connection&);
67     void processDidCloseConnection(WebProcessProxy&, IPC::Connection&);
68     void applicationWillTerminate();
69
70     void readDataFromDiskIfNeeded();
71
72     WebCore::ResourceLoadStatisticsStore& coreStore() { return m_resourceLoadStatisticsStore.get(); }
73     const WebCore::ResourceLoadStatisticsStore& coreStore() const { return m_resourceLoadStatisticsStore.get(); }
74
75 private:
76     explicit WebResourceLoadStatisticsStore(const String&);
77
78     void processStatisticsAndDataRecords();
79
80     void classifyResource(WebCore::ResourceLoadStatistics&);
81     void removeDataRecords();
82
83     String persistentStoragePath(const String& label) const;
84
85     // IPC::MessageReceiver
86     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
87
88     void writeEncoderToDisk(WebCore::KeyedEncoder&, const String& label) const;
89     std::unique_ptr<WebCore::KeyedDecoder> createDecoderFromDisk(const String& label) const;
90
91     Ref<WebCore::ResourceLoadStatisticsStore> m_resourceLoadStatisticsStore;
92     ResourceLoadStatisticsClassifier m_resourceLoadStatisticsClassifier;
93     Ref<WTF::WorkQueue> m_statisticsQueue;
94     String m_statisticsStoragePath;
95     bool m_resourceLoadStatisticsEnabled { false };
96
97     double m_lastTimeDataRecordsWereRemoved { 0 };
98     bool m_dataRecordsRemovalPending { false };
99 };
100
101 } // namespace WebKit
102
103 #endif // WebResourceLoadStatisticsStore_h