Remove "virtual" from all lines that have both "virtual" and "override".
[WebKit-https.git] / Source / WebKit2 / UIProcess / WebsiteData / WebsiteDataStore.h
1 /*
2  * Copyright (C) 2014 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 WebsiteDataStore_h
27 #define WebsiteDataStore_h
28
29 #include "WebProcessLifetimeObserver.h"
30 #include <WebCore/SecurityOriginHash.h>
31 #include <WebCore/SessionID.h>
32 #include <functional>
33 #include <wtf/HashSet.h>
34 #include <wtf/OptionSet.h>
35 #include <wtf/RefCounted.h>
36 #include <wtf/RefPtr.h>
37 #include <wtf/WorkQueue.h>
38 #include <wtf/text/WTFString.h>
39
40 namespace WebCore {
41 class SecurityOrigin;
42 }
43
44 namespace WebKit {
45
46 class StorageManager;
47 class WebPageProxy;
48 class WebProcessPool;
49 enum class WebsiteDataFetchOption;
50 enum class WebsiteDataType;
51 struct WebsiteDataRecord;
52
53 #if ENABLE(NETSCAPE_PLUGIN_API)
54 struct PluginModuleInfo;
55 #endif
56
57 class WebsiteDataStore : public RefCounted<WebsiteDataStore>, public WebProcessLifetimeObserver {
58 public:
59     struct Configuration {
60         String networkCacheDirectory;
61         String applicationCacheDirectory;
62
63         String webSQLDatabaseDirectory;
64         String localStorageDirectory;
65         String mediaKeysStorageDirectory;
66     };
67     static Ref<WebsiteDataStore> createNonPersistent();
68     static Ref<WebsiteDataStore> create(Configuration);
69     virtual ~WebsiteDataStore();
70
71     uint64_t identifier() const { return m_identifier; }
72
73     bool isPersistent() const { return !m_sessionID.isEphemeral(); }
74     WebCore::SessionID sessionID() const { return m_sessionID; }
75
76     static void cloneSessionData(WebPageProxy& sourcePage, WebPageProxy& newPage);
77
78     void fetchData(OptionSet<WebsiteDataType>, OptionSet<WebsiteDataFetchOption>, std::function<void (Vector<WebsiteDataRecord>)> completionHandler);
79     void removeData(OptionSet<WebsiteDataType>, std::chrono::system_clock::time_point modifiedSince, std::function<void ()> completionHandler);
80     void removeData(OptionSet<WebsiteDataType>, const Vector<WebsiteDataRecord>&, std::function<void ()> completionHandler);
81
82     StorageManager* storageManager() { return m_storageManager.get(); }
83
84 private:
85     explicit WebsiteDataStore(WebCore::SessionID);
86     explicit WebsiteDataStore(Configuration);
87
88     // WebProcessLifetimeObserver.
89     void webPageWasAdded(WebPageProxy&) override;
90     void webPageWasRemoved(WebPageProxy&) override;
91     void webProcessWillOpenConnection(WebProcessProxy&, IPC::Connection&) override;
92     void webPageWillOpenConnection(WebPageProxy&, IPC::Connection&) override;
93     void webPageDidCloseConnection(WebPageProxy&, IPC::Connection&) override;
94     void webProcessDidCloseConnection(WebProcessProxy&, IPC::Connection&) override;
95
96     void platformInitialize();
97     void platformDestroy();
98     static void platformRemoveRecentSearches(std::chrono::system_clock::time_point);
99
100     HashSet<RefPtr<WebProcessPool>> processPools() const;
101
102 #if ENABLE(NETSCAPE_PLUGIN_API)
103     Vector<PluginModuleInfo> plugins() const;
104 #endif
105
106     static Vector<RefPtr<WebCore::SecurityOrigin>> mediaKeyOrigins(const String& mediaKeysStorageDirectory);
107     static void removeMediaKeys(const String& mediaKeysStorageDirectory, std::chrono::system_clock::time_point modifiedSince);
108     static void removeMediaKeys(const String& mediaKeysStorageDirectory, const HashSet<RefPtr<WebCore::SecurityOrigin>>&);
109
110     const uint64_t m_identifier;
111     const WebCore::SessionID m_sessionID;
112
113     const String m_networkCacheDirectory;
114     const String m_applicationCacheDirectory;
115
116     const String m_webSQLDatabaseDirectory;
117     const String m_mediaKeysStorageDirectory;
118     const RefPtr<StorageManager> m_storageManager;
119
120     Ref<WorkQueue> m_queue;
121 };
122
123 }
124
125 #endif // WebsiteDataStore_h