Modern IDB: Support IDBObjectStore.put/get support.
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / server / UniqueIDBDatabase.h
1 /*
2  * Copyright (C) 2015 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 UniqueIDBDatabase_h
27 #define UniqueIDBDatabase_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "IDBBackingStore.h"
32 #include "IDBDatabaseIdentifier.h"
33 #include "IDBDatabaseInfo.h"
34 #include "IDBServerOperation.h"
35 #include "ThreadSafeDataBuffer.h"
36 #include "Timer.h"
37 #include "UniqueIDBDatabaseConnection.h"
38 #include "UniqueIDBDatabaseTransaction.h"
39 #include <wtf/Deque.h>
40 #include <wtf/HashSet.h>
41 #include <wtf/Ref.h>
42 #include <wtf/ThreadSafeRefCounted.h>
43
44 namespace WebCore {
45
46 class IDBError;
47 class IDBRequestData;
48 class IDBTransactionInfo;
49
50 namespace IDBServer {
51
52 class IDBConnectionToClient;
53 class IDBServer;
54
55 typedef std::function<void(const IDBError&)> ErrorCallback;
56 typedef std::function<void(const IDBError&, const IDBKeyData&)> KeyDataCallback;
57 typedef std::function<void(const IDBError&, const ThreadSafeDataBuffer&)> ValueDataCallback;
58
59 class UniqueIDBDatabase : public ThreadSafeRefCounted<UniqueIDBDatabase> {
60 public:
61     static Ref<UniqueIDBDatabase> create(IDBServer& server, const IDBDatabaseIdentifier& identifier)
62     {
63         return adoptRef(*new UniqueIDBDatabase(server, identifier));
64     }
65
66     void openDatabaseConnection(IDBConnectionToClient&, const IDBRequestData&);
67
68     const IDBDatabaseInfo& info() const;
69     IDBServer& server() { return m_server; }
70
71     void createObjectStore(UniqueIDBDatabaseTransaction&, const IDBObjectStoreInfo&, ErrorCallback);
72     void putOrAdd(const IDBRequestData&, const IDBKeyData&, const ThreadSafeDataBuffer& valueData, IndexedDB::ObjectStoreOverwriteMode, KeyDataCallback);
73     void getRecord(const IDBRequestData&, const IDBKeyData&, ValueDataCallback);
74     void commitTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
75     void abortTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
76     void transactionDestroyed(UniqueIDBDatabaseTransaction&);
77     void connectionClosedFromClient(UniqueIDBDatabaseConnection&);
78
79 private:
80     UniqueIDBDatabase(IDBServer&, const IDBDatabaseIdentifier&);
81     
82     void handleOpenDatabaseOperations();
83     void addOpenDatabaseConnection(Ref<UniqueIDBDatabaseConnection>&&);
84     bool hasAnyOpenConnections() const;
85
86     void startVersionChangeTransaction();
87     void notifyConnectionsOfVersionChange();
88
89     // Database thread operations
90     void openBackingStore(const IDBDatabaseIdentifier&);
91     void performCommitTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
92     void performAbortTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
93     void beginTransactionInBackingStore(const IDBTransactionInfo&);
94     void performCreateObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBObjectStoreInfo&);
95     void performPutOrAdd(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyData&, const ThreadSafeDataBuffer& valueData, IndexedDB::ObjectStoreOverwriteMode);
96     void performGetRecord(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, uint64_t objectStoreIdentifier, const IDBKeyData&);
97
98     // Main thread callbacks
99     void didOpenBackingStore(const IDBDatabaseInfo&);
100     void didPerformCreateObjectStore(uint64_t callbackIdentifier, const IDBError&, const IDBObjectStoreInfo&);
101     void didPerformPutOrAdd(uint64_t callbackIdentifier, const IDBError&, const IDBKeyData&);
102     void didPerformGetRecord(uint64_t callbackIdentifier, const IDBError&, const ThreadSafeDataBuffer&);
103     void didPerformCommitTransaction(uint64_t callbackIdentifier, const IDBError&);
104     void didPerformAbortTransaction(uint64_t callbackIdentifier, const IDBError&, const IDBResourceIdentifier& transactionIdentifier);
105
106     uint64_t storeCallback(ErrorCallback);
107     uint64_t storeCallback(KeyDataCallback);
108     uint64_t storeCallback(ValueDataCallback);
109
110     void performErrorCallback(uint64_t callbackIdentifier, const IDBError&);
111     void performKeyDataCallback(uint64_t callbackIdentifier, const IDBError&, const IDBKeyData&);
112     void performValueDataCallback(uint64_t callbackIdentifier, const IDBError&, const ThreadSafeDataBuffer&);
113
114     void invokeTransactionScheduler();
115     void transactionSchedulingTimerFired();
116
117     IDBServer& m_server;
118     IDBDatabaseIdentifier m_identifier;
119     
120     Deque<Ref<IDBServerOperation>> m_pendingOpenDatabaseOperations;
121
122     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_openDatabaseConnections;
123     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_closePendingDatabaseConnections;
124
125     RefPtr<IDBServerOperation> m_versionChangeOperation;
126     RefPtr<UniqueIDBDatabaseConnection> m_versionChangeDatabaseConnection;
127     UniqueIDBDatabaseTransaction* m_versionChangeTransaction { nullptr };
128
129     std::unique_ptr<IDBBackingStore> m_backingStore;
130     std::unique_ptr<IDBDatabaseInfo> m_databaseInfo;
131
132     HashMap<uint64_t, ErrorCallback> m_errorCallbacks;
133     HashMap<uint64_t, KeyDataCallback> m_keyDataCallbacks;
134     HashMap<uint64_t, ValueDataCallback> m_valueDataCallbacks;
135
136     Timer m_transactionSchedulingTimer;
137 };
138
139 } // namespace IDBServer
140 } // namespace WebCore
141
142 #endif // ENABLE(INDEXED_DATABASE)
143 #endif // UniqueIDBDatabase_h