Rollout r231818, as it introduced regression on tickets.com.
[WebKit-https.git] / Source / WebKit / UIProcess / ResourceLoadStatisticsPersistentStorage.h
1 /*
2  * Copyright (C) 2017-2018 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 <wtf/Forward.h>
29 #include <wtf/MonotonicTime.h>
30 #include <wtf/RunLoop.h>
31 #include <wtf/WallTime.h>
32 #include <wtf/text/WTFString.h>
33
34 namespace WebCore {
35 class FileMonitor;
36 }
37
38 namespace WebKit {
39
40 class WebResourceLoadStatisticsStore;
41
42 class ResourceLoadStatisticsPersistentStorage {
43 public:
44     enum class IsReadOnly { No, Yes };
45     ResourceLoadStatisticsPersistentStorage(WebResourceLoadStatisticsStore&, const String& storageDirectoryPath, IsReadOnly);
46     ~ResourceLoadStatisticsPersistentStorage();
47
48     void initialize();
49     void clear();
50
51     void finishAllPendingWorkSynchronously();
52
53     void ref();
54     void deref();
55
56     enum class ForceImmediateWrite {
57         No,
58         Yes,
59     };
60     void scheduleOrWriteMemoryStore(ForceImmediateWrite);
61
62 private:
63     String storageDirectoryPath() const;
64     String resourceLogFilePath() const;
65
66     void startMonitoringDisk();
67     void stopMonitoringDisk();
68     void monitorDirectoryForNewStatistics();
69
70     void writeMemoryStoreToDisk();
71     void populateMemoryStoreFromDisk();
72     void excludeFromBackup() const;
73     void refreshMemoryStoreFromDisk();
74     void asyncWriteTimerFired();
75
76     WebResourceLoadStatisticsStore& m_memoryStore;
77     const String m_storageDirectoryPath;
78     RunLoop::Timer<ResourceLoadStatisticsPersistentStorage> m_asyncWriteTimer;
79     std::unique_ptr<WebCore::FileMonitor> m_fileMonitor;
80     WallTime m_lastStatisticsFileSyncTime;
81     MonotonicTime m_lastStatisticsWriteTime;
82     IsReadOnly m_isReadOnly { IsReadOnly::No };
83     bool m_hasPendingWrite { false };
84 };
85
86 }