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