Modern IDB: Add basic transaction aborting.
[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 commitTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
69     void abortTransaction(UniqueIDBDatabaseTransaction&, ErrorCallback);
70     void transactionDestroyed(UniqueIDBDatabaseTransaction&);
71     void connectionClosedFromClient(UniqueIDBDatabaseConnection&);
72
73 private:
74     UniqueIDBDatabase(IDBServer&, const IDBDatabaseIdentifier&);
75     
76     void handleOpenDatabaseOperations();
77     void addOpenDatabaseConnection(Ref<UniqueIDBDatabaseConnection>&&);
78     bool hasAnyOpenConnections() const;
79
80     void startVersionChangeTransaction();
81     void notifyConnectionsOfVersionChange();
82
83     uint64_t storeCallback(ErrorCallback);
84     
85     // Database thread operations
86     void openBackingStore(const IDBDatabaseIdentifier&);
87     void performCommitTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
88     void performAbortTransaction(uint64_t callbackIdentifier, const IDBResourceIdentifier& transactionIdentifier);
89     void beginTransactionInBackingStore(const IDBTransactionInfo&);
90
91     // Main thread callbacks
92     void didOpenBackingStore(const IDBDatabaseInfo&);
93     void didPerformCommitTransaction(uint64_t callbackIdentifier, const IDBError&);
94     void didPerformAbortTransaction(uint64_t callbackIdentifier, const IDBError&);
95
96     void performErrorCallback(uint64_t callbackIdentifier, const IDBError&);
97
98     void invokeTransactionScheduler();
99     void transactionSchedulingTimerFired();
100
101     IDBServer& m_server;
102     IDBDatabaseIdentifier m_identifier;
103     
104     Deque<Ref<IDBServerOperation>> m_pendingOpenDatabaseOperations;
105
106     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_openDatabaseConnections;
107     HashSet<RefPtr<UniqueIDBDatabaseConnection>> m_closePendingDatabaseConnections;
108
109     RefPtr<IDBServerOperation> m_versionChangeOperation;
110     RefPtr<UniqueIDBDatabaseConnection> m_versionChangeDatabaseConnection;
111     UniqueIDBDatabaseTransaction* m_versionChangeTransaction { nullptr };
112
113     std::unique_ptr<IDBBackingStore> m_backingStore;
114     std::unique_ptr<IDBDatabaseInfo> m_databaseInfo;
115
116     HashMap<uint64_t, ErrorCallback> m_errorCallbacks;
117
118     Timer m_transactionSchedulingTimer;
119 };
120
121 } // namespace IDBServer
122 } // namespace WebCore
123
124 #endif // ENABLE(INDEXED_DATABASE)
125 #endif // UniqueIDBDatabase_h