Modern IDB: Basic createObjectStore implementation.
[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 "Timer.h"
36 #include "UniqueIDBDatabaseConnection.h"
37 #include "UniqueIDBDatabaseTransaction.h"
38 #include <wtf/Deque.h>
39 #include <wtf/HashSet.h>
40 #include <wtf/Ref.h>
41 #include <wtf/ThreadSafeRefCounted.h>
42
43 namespace WebCore {
44
45 class IDBError;
46 class IDBRequestData;
47 class IDBTransactionInfo;
48
49 namespace IDBServer {
50
51 class IDBConnectionToClient;
52 class IDBServer;
53
54 typedef std::function<void(const IDBError&)> ErrorCallback;
55
56 class UniqueIDBDatabase : public ThreadSafeRefCounted<UniqueIDBDatabase> {
57 public:
58     static Ref<UniqueIDBDatabase> create(IDBServer& server, const IDBDatabaseIdentifier& identifier)
59     {
60         return adoptRef(*new UniqueIDBDatabase(server, identifier));
61     }
62
63     void openDatabaseConnection(IDBConnectionToClient&, const IDBRequestData&);
64
65     const IDBDatabaseInfo& info() const;
66     IDBServer& server() { return m_server; }
67
68     void createObjectStore(UniqueIDBDatabaseTransaction&, const IDBObjectStoreInfo&, ErrorCallback);
69     void commitTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
70     void abortTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
71     void transactionDestroyed(UniqueIDBDatabaseTransaction&);
72     void connectionClosedFromClient(UniqueIDBDatabaseConnection&);
73
74 private:
75     UniqueIDBDatabase(IDBServer&, const IDBDatabaseIdentifier&);
76     
77     void handleOpenDatabaseOperations();
78     void addOpenDatabaseConnection(Ref<UniqueIDBDatabaseConnection>&&);
79     bool hasAnyOpenConnections() const;
80
81     void startVersionChangeTransaction();
82     void notifyConnectionsOfVersionChange();
83
84     uint64_t storeCallback(ErrorCallback);
85     
86     // Database thread operations
87     void openBackingStore(const IDBDatabaseIdentifier&);
88     void performCommitTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
89     void performAbortTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
90     void beginTransactionInBackingStore(const IDBTransactionInfo&);
91     void performCreateObjectStore(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier, const IDBObjectStoreInfo&);
92
93     // Main thread callbacks
94     void didOpenBackingStore(const IDBDatabaseInfo&);
95     void didPerformCreateObjectStore(uint64_t callbackIdentifier, const IDBError&, const IDBObjectStoreInfo&);
96     void didPerformCommitTransaction(uint64_t callbackIdentifier, const IDBError&);
97     void didPerformAbortTransaction(uint64_t callbackIdentifier, const IDBError&, const IDBResourceIdentifier& transactionIdentifier);
98
99     void performErrorCallback(uint64_t callbackIdentifier, const IDBError&);
100
101     void invokeTransactionScheduler();
102     void transactionSchedulingTimerFired();
103
104     IDBServer& m_server;
105     IDBDatabaseIdentifier m_identifier;
106     
107     Deque<Ref<IDBServerOperation>> m_pendingOpenDatabaseOperations;
108
109     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_openDatabaseConnections;
110     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_closePendingDatabaseConnections;
111
112     RefPtr<IDBServerOperation> m_versionChangeOperation;
113     RefPtr<UniqueIDBDatabaseConnection> m_versionChangeDatabaseConnection;
114     UniqueIDBDatabaseTransaction* m_versionChangeTransaction { nullptr };
115
116     std::unique_ptr<IDBBackingStore> m_backingStore;
117     std::unique_ptr<IDBDatabaseInfo> m_databaseInfo;
118
119     HashMap<uint64_t, ErrorCallback> m_errorCallbacks;
120
121     Timer m_transactionSchedulingTimer;
122 };
123
124 } // namespace IDBServer
125 } // namespace WebCore
126
127 #endif // ENABLE(INDEXED_DATABASE)
128 #endif // UniqueIDBDatabase_h