043619590c267141a07735d5c1d7b1910276937f
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / client / IDBTransactionImpl.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 IDBTransactionImpl_h
27 #define IDBTransactionImpl_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "IDBDatabaseInfo.h"
32 #include "IDBError.h"
33 #include "IDBIndexImpl.h"
34 #include "IDBObjectStoreImpl.h"
35 #include "IDBTransaction.h"
36 #include "IDBTransactionInfo.h"
37 #include "IndexedDB.h"
38 #include "Timer.h"
39 #include <wtf/Deque.h>
40 #include <wtf/HashMap.h>
41
42 namespace WebCore {
43
44 class IDBIndexInfo;
45 class IDBObjectStoreInfo;
46 class IDBResultData;
47
48 struct IDBKeyRangeData;
49
50 namespace IDBClient {
51
52 class IDBDatabase;
53 class IDBIndex;
54 class TransactionOperation;
55
56 class IDBTransaction : public WebCore::IDBTransaction {
57 public:
58     static Ref<IDBTransaction> create(IDBDatabase&, const IDBTransactionInfo&);
59
60     virtual ~IDBTransaction() override final;
61
62     // IDBTransaction IDL
63     virtual const String& mode() const override final;
64     virtual WebCore::IDBDatabase* db() override final;
65     virtual RefPtr<DOMError> error() const override final;
66     virtual RefPtr<WebCore::IDBObjectStore> objectStore(const String& name, ExceptionCode&) override final;
67     virtual void abort(ExceptionCode&) override final;
68
69     virtual EventTargetInterface eventTargetInterface() const override final { return IDBTransactionEventTargetInterfaceType; }
70     virtual ScriptExecutionContext* scriptExecutionContext() const override final { return ActiveDOMObject::scriptExecutionContext(); }
71     virtual void refEventTarget() override final { ref(); }
72     virtual void derefEventTarget() override final { deref(); }
73     using EventTarget::dispatchEvent;
74     virtual bool dispatchEvent(Event&) override final;
75
76     virtual const char* activeDOMObjectName() const override final;
77     virtual bool canSuspendForPageCache() const override final;
78     virtual bool hasPendingActivity() const override final;
79
80     const IDBTransactionInfo info() const { return m_info; }
81     IDBDatabase& database() { return m_database.get(); }
82     const IDBDatabase& database() const { return m_database.get(); }
83     IDBDatabaseInfo* originalDatabaseInfo() const { return m_originalDatabaseInfo.get(); }
84
85     void didStart(const IDBError&);
86     void didAbort(const IDBError&);
87     void didCommit(const IDBError&);
88
89     bool isVersionChange() const { return m_info.mode() == IndexedDB::TransactionMode::VersionChange; }
90     bool isReadOnly() const { return m_info.mode() == IndexedDB::TransactionMode::ReadOnly; }
91     bool isActive() const;
92
93     Ref<IDBObjectStore> createObjectStore(const IDBObjectStoreInfo&);
94     Ref<IDBIndex> createIndex(IDBObjectStore&, const IDBIndexInfo&);
95
96     Ref<IDBRequest> requestPutOrAdd(ScriptExecutionContext&, IDBObjectStore&, IDBKey*, SerializedScriptValue&, IndexedDB::ObjectStoreOverwriteMode);
97     Ref<IDBRequest> requestGetRecord(ScriptExecutionContext&, IDBObjectStore&, const IDBKeyRangeData&);
98     Ref<IDBRequest> requestDeleteRecord(ScriptExecutionContext&, IDBObjectStore&, const IDBKeyRangeData&);
99     Ref<IDBRequest> requestClearObjectStore(ScriptExecutionContext&, IDBObjectStore&);
100     Ref<IDBRequest> requestCount(ScriptExecutionContext&, IDBObjectStore&, const IDBKeyRangeData&);
101     Ref<IDBRequest> requestCount(ScriptExecutionContext&, IDBIndex&, const IDBKeyRangeData&);
102     Ref<IDBRequest> requestGetValue(ScriptExecutionContext&, IDBIndex&, const IDBKeyRangeData&);
103     Ref<IDBRequest> requestGetKey(ScriptExecutionContext&, IDBIndex&, const IDBKeyRangeData&);
104
105     void deleteObjectStore(const String& objectStoreName);
106
107     void addRequest(IDBRequest&);
108     void removeRequest(IDBRequest&);
109
110     IDBConnectionToServer& serverConnection();
111
112     void activate();
113     void deactivate();
114
115     void operationDidComplete(TransactionOperation&);
116
117 private:
118     IDBTransaction(IDBDatabase&, const IDBTransactionInfo&);
119
120     bool isFinishedOrFinishing() const;
121
122     void commit();
123
124     void finishAbortOrCommit();
125
126     void scheduleOperation(RefPtr<TransactionOperation>&&);
127     void operationTimerFired();
128
129     void fireOnComplete();
130     void fireOnAbort();
131     void enqueueEvent(Ref<Event>&&);
132
133     Ref<IDBRequest> requestIndexRecord(ScriptExecutionContext&, IDBIndex&, IndexedDB::IndexRecordType, const IDBKeyRangeData&);
134
135     void commitOnServer(TransactionOperation&);
136     void abortOnServer(TransactionOperation&);
137
138     void createObjectStoreOnServer(TransactionOperation&, const IDBObjectStoreInfo&);
139     void didCreateObjectStoreOnServer(const IDBResultData&);
140
141     void createIndexOnServer(TransactionOperation&, const IDBIndexInfo&);
142     void didCreateIndexOnServer(const IDBResultData&);
143
144     void clearObjectStoreOnServer(TransactionOperation&, const uint64_t& objectStoreIdentifier);
145     void didClearObjectStoreOnServer(IDBRequest&, const IDBResultData&);
146
147     void putOrAddOnServer(TransactionOperation&, RefPtr<IDBKey>, RefPtr<SerializedScriptValue>, const IndexedDB::ObjectStoreOverwriteMode&);
148     void didPutOrAddOnServer(IDBRequest&, const IDBResultData&);
149
150     void getRecordOnServer(TransactionOperation&, const IDBKeyRangeData&);
151     void didGetRecordOnServer(IDBRequest&, const IDBResultData&);
152
153     void getCountOnServer(TransactionOperation&, const IDBKeyRangeData&);
154     void didGetCountOnServer(IDBRequest&, const IDBResultData&);
155
156     void deleteRecordOnServer(TransactionOperation&, const IDBKeyRangeData&);
157     void didDeleteRecordOnServer(IDBRequest&, const IDBResultData&);
158
159     void deleteObjectStoreOnServer(TransactionOperation&, const String& objectStoreName);
160     void didDeleteObjectStoreOnServer(const IDBResultData&);
161
162     void establishOnServer();
163
164     void scheduleOperationTimer();
165
166     Ref<IDBDatabase> m_database;
167     IDBTransactionInfo m_info;
168     std::unique_ptr<IDBDatabaseInfo> m_originalDatabaseInfo;
169
170     IndexedDB::TransactionState m_state { IndexedDB::TransactionState::Inactive };
171     bool m_startedOnServer { false };
172
173     IDBError m_idbError;
174
175     Timer m_operationTimer;
176     std::unique_ptr<Timer> m_activationTimer;
177
178     Deque<RefPtr<TransactionOperation>> m_transactionOperationQueue;
179     HashMap<IDBResourceIdentifier, RefPtr<TransactionOperation>> m_transactionOperationMap;
180
181     HashMap<String, RefPtr<IDBObjectStore>> m_referencedObjectStores;
182
183     HashSet<RefPtr<IDBRequest>> m_openRequests;
184 };
185
186 class TransactionActivator {
187     WTF_MAKE_NONCOPYABLE(TransactionActivator);
188 public:
189     TransactionActivator(IDBTransaction* transaction)
190         : m_transaction(transaction)
191     {
192         if (m_transaction)
193             m_transaction->activate();
194     }
195
196     ~TransactionActivator()
197     {
198         if (m_transaction)
199             m_transaction->deactivate();
200     }
201
202 private:
203     IDBTransaction* m_transaction;
204 };
205
206 } // namespace IDBClient
207 } // namespace WebCore
208
209 #endif // ENABLE(INDEXED_DATABASE)
210 #endif // IDBTransactionImpl_h