Update Resource Load Statistics
[WebKit-https.git] / Source / WebKit2 / UIProcess / WebResourceLoadStatisticsStore.h
1 /*
2  * Copyright (C) 2016 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 "WebsiteDataRecord.h"
32 #include <WebCore/ResourceLoadStatisticsStore.h>
33 #include <wtf/Vector.h>
34 #include <wtf/text/WTFString.h>
35
36 namespace WTF {
37 class WorkQueue;
38 }
39
40 namespace WebCore {
41 class KeyedDecoder;
42 class KeyedEncoder;
43 struct ResourceLoadStatistics;
44 }
45
46 namespace WebKit {
47
48 class WebProcessPool;
49 class WebProcessProxy;
50
51 class WebResourceLoadStatisticsStore : public IPC::Connection::WorkQueueMessageReceiver {
52 public:
53     static Ref<WebResourceLoadStatisticsStore> create(const String&);
54     virtual ~WebResourceLoadStatisticsStore();
55     
56     void setResourceLoadStatisticsEnabled(bool);
57     bool resourceLoadStatisticsEnabled() const;
58     
59     void resourceLoadStatisticsUpdated(const Vector<WebCore::ResourceLoadStatistics>& origins);
60
61     void processWillOpenConnection(WebProcessProxy&, IPC::Connection&);
62     void processDidCloseConnection(WebProcessProxy&, IPC::Connection&);
63     void applicationWillTerminate();
64
65     void readDataFromDiskIfNeeded();
66
67     void mergeStatistics(const Vector<WebCore::ResourceLoadStatistics>&);
68
69     WebCore::ResourceLoadStatisticsStore& coreStore() { return m_resourceStatisticsStore.get(); }
70     const WebCore::ResourceLoadStatisticsStore& coreStore() const { return m_resourceStatisticsStore.get(); }
71
72 private:
73     explicit WebResourceLoadStatisticsStore(const String&);
74
75     bool hasPrevalentResourceCharacteristics(const WebCore::ResourceLoadStatistics&);
76     void classifyResource(WebCore::ResourceLoadStatistics&);
77     void clearDataRecords();
78
79     String persistentStoragePath(const String& label) const;
80
81     // IPC::MessageReceiver
82     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
83
84     void writeEncoderToDisk(WebCore::KeyedEncoder&, const String& label) const;
85     std::unique_ptr<WebCore::KeyedDecoder> createDecoderFromDisk(const String& label) const;
86
87     Ref<WebCore::ResourceLoadStatisticsStore> m_resourceStatisticsStore;
88     Ref<WTF::WorkQueue> m_statisticsQueue;
89     String m_storagePath;
90     bool m_resourceLoadStatisticsEnabled { false };
91
92     double m_lastTimeDataRecordsWereCleared { 0 };
93     bool m_dataStoreClearPending { false };
94 };
95
96 } // namespace WebKit
97
98 #endif // WebResourceLoadStatisticsStore_h