2ce656f2c6c3fbfda2902bd00dd70fc4e4a8bff1
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / server / IDBServer.h
1 /*
2  * Copyright (C) 2015, 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 #pragma once
27
28 #if ENABLE(INDEXED_DATABASE)
29
30 #include "IDBConnectionToClient.h"
31 #include "IDBDatabaseIdentifier.h"
32 #include "StorageQuotaManager.h"
33 #include "StorageQuotaUser.h"
34 #include "UniqueIDBDatabase.h"
35 #include "UniqueIDBDatabaseConnection.h"
36 #include <pal/HysteresisActivity.h>
37 #include <pal/SessionID.h>
38 #include <wtf/CrossThreadTaskHandler.h>
39 #include <wtf/HashMap.h>
40 #include <wtf/Lock.h>
41 #include <wtf/Ref.h>
42 #include <wtf/RefCounted.h>
43 #include <wtf/RefPtr.h>
44
45 namespace WebCore {
46
47 class IDBCursorInfo;
48 class IDBRequestData;
49 class IDBValue;
50 class StorageQuotaManager;
51
52 struct IDBGetRecordData;
53
54 namespace IDBServer {
55
56 const uint64_t defaultPerOriginQuota = 500 * MB;
57
58 class IDBBackingStoreTemporaryFileHandler;
59
60 class IDBServer : public RefCounted<IDBServer>, public CrossThreadTaskHandler {
61 public:
62     using QuotaManagerGetter = WTF::Function<StorageQuotaManager*(PAL::SessionID, const ClientOrigin&)>;
63     static Ref<IDBServer> create(PAL::SessionID, IDBBackingStoreTemporaryFileHandler&, QuotaManagerGetter&&, WTF::Function<void(bool)>&& isClosingDatabaseCallback = [](bool) { });
64     WEBCORE_EXPORT static Ref<IDBServer> create(PAL::SessionID, const String& databaseDirectoryPath, IDBBackingStoreTemporaryFileHandler&, QuotaManagerGetter&&, WTF::Function<void(bool)>&& isClosingDatabaseCallback = [](bool) { });
65
66     WEBCORE_EXPORT void registerConnection(IDBConnectionToClient&);
67     WEBCORE_EXPORT void unregisterConnection(IDBConnectionToClient&);
68
69     // Operations requested by the client.
70     WEBCORE_EXPORT void openDatabase(const IDBRequestData&);
71     WEBCORE_EXPORT void deleteDatabase(const IDBRequestData&);
72     WEBCORE_EXPORT void abortTransaction(const IDBResourceIdentifier&);
73     WEBCORE_EXPORT void commitTransaction(const IDBResourceIdentifier&);
74     WEBCORE_EXPORT void didFinishHandlingVersionChangeTransaction(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier&);
75     WEBCORE_EXPORT void createObjectStore(const IDBRequestData&, const IDBObjectStoreInfo&);
76     WEBCORE_EXPORT void renameObjectStore(const IDBRequestData&, uint64_t objectStoreIdentifier, const String& newName);
77     WEBCORE_EXPORT void deleteObjectStore(const IDBRequestData&, const String& objectStoreName);
78     WEBCORE_EXPORT void clearObjectStore(const IDBRequestData&, uint64_t objectStoreIdentifier);
79     WEBCORE_EXPORT void createIndex(const IDBRequestData&, const IDBIndexInfo&);
80     WEBCORE_EXPORT void deleteIndex(const IDBRequestData&, uint64_t objectStoreIdentifier, const String& indexName);
81     WEBCORE_EXPORT void renameIndex(const IDBRequestData&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName);
82     WEBCORE_EXPORT void putOrAdd(const IDBRequestData&, const IDBKeyData&, const IDBValue&, IndexedDB::ObjectStoreOverwriteMode);
83     WEBCORE_EXPORT void getRecord(const IDBRequestData&, const IDBGetRecordData&);
84     WEBCORE_EXPORT void getAllRecords(const IDBRequestData&, const IDBGetAllRecordsData&);
85     WEBCORE_EXPORT void getCount(const IDBRequestData&, const IDBKeyRangeData&);
86     WEBCORE_EXPORT void deleteRecord(const IDBRequestData&, const IDBKeyRangeData&);
87     WEBCORE_EXPORT void openCursor(const IDBRequestData&, const IDBCursorInfo&);
88     WEBCORE_EXPORT void iterateCursor(const IDBRequestData&, const IDBIterateCursorData&);
89
90     WEBCORE_EXPORT void establishTransaction(uint64_t databaseConnectionIdentifier, const IDBTransactionInfo&);
91     WEBCORE_EXPORT void databaseConnectionPendingClose(uint64_t databaseConnectionIdentifier);
92     WEBCORE_EXPORT void databaseConnectionClosed(uint64_t databaseConnectionIdentifier);
93     WEBCORE_EXPORT void abortOpenAndUpgradeNeeded(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier& transactionIdentifier);
94     WEBCORE_EXPORT void didFireVersionChangeEvent(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier& requestIdentifier);
95     WEBCORE_EXPORT void openDBRequestCancelled(const IDBRequestData&);
96     WEBCORE_EXPORT void confirmDidCloseFromServer(uint64_t databaseConnectionIdentifier);
97
98     WEBCORE_EXPORT void getAllDatabaseNames(uint64_t serverConnectionIdentifier, const SecurityOriginData& mainFrameOrigin, const SecurityOriginData& openingOrigin, uint64_t callbackID);
99
100     void postDatabaseTask(CrossThreadTask&&);
101     void postDatabaseTaskReply(CrossThreadTask&&);
102
103     void registerDatabaseConnection(UniqueIDBDatabaseConnection&);
104     void unregisterDatabaseConnection(UniqueIDBDatabaseConnection&);
105     void registerTransaction(UniqueIDBDatabaseTransaction&);
106     void unregisterTransaction(UniqueIDBDatabaseTransaction&);
107
108     std::unique_ptr<UniqueIDBDatabase> closeAndTakeUniqueIDBDatabase(UniqueIDBDatabase&);
109
110     std::unique_ptr<IDBBackingStore> createBackingStore(const IDBDatabaseIdentifier&);
111
112     WEBCORE_EXPORT void closeAndDeleteDatabasesModifiedSince(WallTime, Function<void ()>&& completionHandler);
113     WEBCORE_EXPORT void closeAndDeleteDatabasesForOrigins(const Vector<SecurityOriginData>&, Function<void ()>&& completionHandler);
114
115     uint64_t perOriginQuota() const { return m_perOriginQuota; }
116     WEBCORE_EXPORT void setPerOriginQuota(uint64_t);
117
118     void closeDatabase(UniqueIDBDatabase*);
119     void didCloseDatabase(UniqueIDBDatabase*);
120     void hysteresisUpdated(PAL::HysteresisState);
121
122     void requestSpace(const ClientOrigin&, uint64_t taskSize, CompletionHandler<void(StorageQuotaManager::Decision)>&&);
123     void increasePotentialSpaceUsed(const ClientOrigin&, uint64_t taskSize);
124     void decreasePotentialSpaceUsed(const ClientOrigin&, uint64_t taskSize);
125     void setSpaceUsed(const ClientOrigin&, uint64_t spaceUsed);
126     void resetSpaceUsed(const ClientOrigin&);
127
128 private:
129     IDBServer(PAL::SessionID, IDBBackingStoreTemporaryFileHandler&, QuotaManagerGetter&&, WTF::Function<void(bool)>&&);
130     IDBServer(PAL::SessionID, const String& databaseDirectoryPath, IDBBackingStoreTemporaryFileHandler&, QuotaManagerGetter&&, WTF::Function<void(bool)>&&);
131
132     UniqueIDBDatabase& getOrCreateUniqueIDBDatabase(const IDBDatabaseIdentifier&);
133
134     void performGetAllDatabaseNames(uint64_t serverConnectionIdentifier, const SecurityOriginData& mainFrameOrigin, const SecurityOriginData& openingOrigin, uint64_t callbackID);
135     void didGetAllDatabaseNames(uint64_t serverConnectionIdentifier, uint64_t callbackID, const Vector<String>& databaseNames);
136
137     void performCloseAndDeleteDatabasesModifiedSince(WallTime, uint64_t callbackID);
138     void performCloseAndDeleteDatabasesForOrigins(const Vector<SecurityOriginData>&, uint64_t callbackID);
139     void didPerformCloseAndDeleteDatabases(uint64_t callbackID);
140
141     void upgradeFilesIfNecessary();
142     void removeDatabasesModifiedSinceForVersion(WallTime, const String&);
143     void removeDatabasesWithOriginsForVersion(const Vector<SecurityOriginData>&, const String&);
144
145     class QuotaUser final : public StorageQuotaUser {
146         WTF_MAKE_FAST_ALLOCATED;
147     public:
148         QuotaUser(IDBServer&, StorageQuotaManager*, ClientOrigin&&);
149         ~QuotaUser();
150
151         StorageQuotaManager* manager() { return m_manager.get(); }
152
153         void setSpaceUsed(uint64_t spaceUsed) { m_spaceUsed = spaceUsed; }
154         void resetSpaceUsed();
155
156         void increasePotentialSpaceUsed(uint64_t increase) { m_estimatedSpaceIncrease += increase; }
157         void decreasePotentialSpaceUsed(uint64_t decrease)
158         {
159             ASSERT(m_estimatedSpaceIncrease >= decrease);
160             m_estimatedSpaceIncrease -= decrease;
161         }
162
163         void initializeSpaceUsed(uint64_t spaceUsed);
164
165     private:
166         uint64_t spaceUsed() const final { return m_spaceUsed + m_estimatedSpaceIncrease; }
167         void whenInitialized(CompletionHandler<void()>&&) final;
168
169         IDBServer& m_server;
170         WeakPtr<StorageQuotaManager> m_manager;
171         ClientOrigin m_origin;
172         bool m_isInitialized { false };
173         uint64_t m_spaceUsed { 0 };
174         uint64_t m_estimatedSpaceIncrease { 0 };
175         CompletionHandler<void()> m_initializationCallback;
176     };
177
178     QuotaUser& quotaUser(const ClientOrigin&);
179     void startComputingSpaceUsedForOrigin(const ClientOrigin&);
180     void computeSpaceUsedForOrigin(const ClientOrigin&);
181     void finishComputingSpaceUsedForOrigin(const ClientOrigin&, uint64_t spaceUsed);
182
183     PAL::SessionID m_sessionID;
184     HashMap<uint64_t, RefPtr<IDBConnectionToClient>> m_connectionMap;
185     HashMap<IDBDatabaseIdentifier, std::unique_ptr<UniqueIDBDatabase>> m_uniqueIDBDatabaseMap;
186     HashSet<UniqueIDBDatabase*> m_uniqueIDBDatabasesInClose;
187
188     HashMap<uint64_t, UniqueIDBDatabaseConnection*> m_databaseConnections;
189     HashMap<IDBResourceIdentifier, UniqueIDBDatabaseTransaction*> m_transactions;
190
191     HashMap<uint64_t, Function<void ()>> m_deleteDatabaseCompletionHandlers;
192
193     String m_databaseDirectoryPath;
194     IDBBackingStoreTemporaryFileHandler& m_backingStoreTemporaryFileHandler;
195
196     uint64_t m_perOriginQuota { defaultPerOriginQuota };
197
198     WTF::Function<void(bool)> m_isClosingDatabaseCallback;
199     PAL::HysteresisActivity m_isClosingDatabaseHysteresis;
200
201     HashMap<ClientOrigin, std::unique_ptr<QuotaUser>> m_quotaUsers;
202     QuotaManagerGetter m_quotaManagerGetter;
203 };
204
205 } // namespace IDBServer
206 } // namespace WebCore
207
208 #endif // ENABLE(INDEXED_DATABASE)