Cleanup lifetime issues of UniqueIDBDatabase and IDBBackingStore.
[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 "UniqueIDBDatabase.h"
33 #include "UniqueIDBDatabaseConnection.h"
34 #include <wtf/CrossThreadQueue.h>
35 #include <wtf/CrossThreadTask.h>
36 #include <wtf/HashMap.h>
37 #include <wtf/Lock.h>
38 #include <wtf/Ref.h>
39 #include <wtf/RefCounted.h>
40 #include <wtf/RefPtr.h>
41
42 namespace WebCore {
43
44 class IDBCursorInfo;
45 class IDBRequestData;
46 class IDBValue;
47
48 struct IDBGetRecordData;
49
50 namespace IDBServer {
51
52 class IDBBackingStoreTemporaryFileHandler;
53
54 class IDBServer : public RefCounted<IDBServer> {
55 public:
56     static Ref<IDBServer> create(IDBBackingStoreTemporaryFileHandler&);
57     WEBCORE_EXPORT static Ref<IDBServer> create(const String& databaseDirectoryPath, IDBBackingStoreTemporaryFileHandler&);
58
59     WEBCORE_EXPORT void registerConnection(IDBConnectionToClient&);
60     WEBCORE_EXPORT void unregisterConnection(IDBConnectionToClient&);
61
62     // Operations requested by the client.
63     WEBCORE_EXPORT void openDatabase(const IDBRequestData&);
64     WEBCORE_EXPORT void deleteDatabase(const IDBRequestData&);
65     WEBCORE_EXPORT void abortTransaction(const IDBResourceIdentifier&);
66     WEBCORE_EXPORT void commitTransaction(const IDBResourceIdentifier&);
67     WEBCORE_EXPORT void didFinishHandlingVersionChangeTransaction(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier&);
68     WEBCORE_EXPORT void createObjectStore(const IDBRequestData&, const IDBObjectStoreInfo&);
69     WEBCORE_EXPORT void renameObjectStore(const IDBRequestData&, uint64_t objectStoreIdentifier, const String& newName);
70     WEBCORE_EXPORT void deleteObjectStore(const IDBRequestData&, const String& objectStoreName);
71     WEBCORE_EXPORT void clearObjectStore(const IDBRequestData&, uint64_t objectStoreIdentifier);
72     WEBCORE_EXPORT void createIndex(const IDBRequestData&, const IDBIndexInfo&);
73     WEBCORE_EXPORT void deleteIndex(const IDBRequestData&, uint64_t objectStoreIdentifier, const String& indexName);
74     WEBCORE_EXPORT void renameIndex(const IDBRequestData&, uint64_t objectStoreIdentifier, uint64_t indexIdentifier, const String& newName);
75     WEBCORE_EXPORT void putOrAdd(const IDBRequestData&, const IDBKeyData&, const IDBValue&, IndexedDB::ObjectStoreOverwriteMode);
76     WEBCORE_EXPORT void getRecord(const IDBRequestData&, const IDBGetRecordData&);
77     WEBCORE_EXPORT void getAllRecords(const IDBRequestData&, const IDBGetAllRecordsData&);
78     WEBCORE_EXPORT void getCount(const IDBRequestData&, const IDBKeyRangeData&);
79     WEBCORE_EXPORT void deleteRecord(const IDBRequestData&, const IDBKeyRangeData&);
80     WEBCORE_EXPORT void openCursor(const IDBRequestData&, const IDBCursorInfo&);
81     WEBCORE_EXPORT void iterateCursor(const IDBRequestData&, const IDBIterateCursorData&);
82
83     WEBCORE_EXPORT void establishTransaction(uint64_t databaseConnectionIdentifier, const IDBTransactionInfo&);
84     WEBCORE_EXPORT void databaseConnectionPendingClose(uint64_t databaseConnectionIdentifier);
85     WEBCORE_EXPORT void databaseConnectionClosed(uint64_t databaseConnectionIdentifier);
86     WEBCORE_EXPORT void abortOpenAndUpgradeNeeded(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier& transactionIdentifier);
87     WEBCORE_EXPORT void didFireVersionChangeEvent(uint64_t databaseConnectionIdentifier, const IDBResourceIdentifier& requestIdentifier);
88     WEBCORE_EXPORT void openDBRequestCancelled(const IDBRequestData&);
89     WEBCORE_EXPORT void confirmDidCloseFromServer(uint64_t databaseConnectionIdentifier);
90
91     WEBCORE_EXPORT void getAllDatabaseNames(uint64_t serverConnectionIdentifier, const SecurityOriginData& mainFrameOrigin, const SecurityOriginData& openingOrigin, uint64_t callbackID);
92
93     void postDatabaseTask(CrossThreadTask&&);
94     void postDatabaseTaskReply(CrossThreadTask&&);
95
96     void registerDatabaseConnection(UniqueIDBDatabaseConnection&);
97     void unregisterDatabaseConnection(UniqueIDBDatabaseConnection&);
98     void registerTransaction(UniqueIDBDatabaseTransaction&);
99     void unregisterTransaction(UniqueIDBDatabaseTransaction&);
100
101     std::unique_ptr<UniqueIDBDatabase> closeAndTakeUniqueIDBDatabase(UniqueIDBDatabase&);
102
103     std::unique_ptr<IDBBackingStore> createBackingStore(const IDBDatabaseIdentifier&);
104
105     WEBCORE_EXPORT void closeAndDeleteDatabasesModifiedSince(std::chrono::system_clock::time_point, Function<void ()>&& completionHandler);
106     WEBCORE_EXPORT void closeAndDeleteDatabasesForOrigins(const Vector<SecurityOriginData>&, Function<void ()>&& completionHandler);
107
108 private:
109     IDBServer(IDBBackingStoreTemporaryFileHandler&);
110     IDBServer(const String& databaseDirectoryPath, IDBBackingStoreTemporaryFileHandler&);
111
112     UniqueIDBDatabase& getOrCreateUniqueIDBDatabase(const IDBDatabaseIdentifier&);
113
114     void performGetAllDatabaseNames(uint64_t serverConnectionIdentifier, const SecurityOriginData& mainFrameOrigin, const SecurityOriginData& openingOrigin, uint64_t callbackID);
115     void didGetAllDatabaseNames(uint64_t serverConnectionIdentifier, uint64_t callbackID, const Vector<String>& databaseNames);
116
117     void performCloseAndDeleteDatabasesModifiedSince(std::chrono::system_clock::time_point, uint64_t callbackID);
118     void performCloseAndDeleteDatabasesForOrigins(const Vector<SecurityOriginData>&, uint64_t callbackID);
119     void didPerformCloseAndDeleteDatabases(uint64_t callbackID);
120
121     void databaseRunLoop();
122     void handleTaskRepliesOnMainThread();
123
124     HashMap<uint64_t, RefPtr<IDBConnectionToClient>> m_connectionMap;
125     HashMap<IDBDatabaseIdentifier, std::unique_ptr<UniqueIDBDatabase>> m_uniqueIDBDatabaseMap;
126
127     RefPtr<Thread> m_thread { nullptr };
128     Lock m_databaseThreadCreationLock;
129     Lock m_mainThreadReplyLock;
130     bool m_mainThreadReplyScheduled { false };
131
132     CrossThreadQueue<CrossThreadTask> m_databaseQueue;
133     CrossThreadQueue<CrossThreadTask> m_databaseReplyQueue;
134
135     HashMap<uint64_t, UniqueIDBDatabaseConnection*> m_databaseConnections;
136     HashMap<IDBResourceIdentifier, UniqueIDBDatabaseTransaction*> m_transactions;
137
138     HashMap<uint64_t, Function<void ()>> m_deleteDatabaseCompletionHandlers;
139
140     String m_databaseDirectoryPath;
141     IDBBackingStoreTemporaryFileHandler& m_backingStoreTemporaryFileHandler;
142 };
143
144 } // namespace IDBServer
145 } // namespace WebCore
146
147 #endif // ENABLE(INDEXED_DATABASE)