Modern IDB: Basic createObjectStore implementation.
[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 "IDBObjectStoreImpl.h"
34 #include "IDBTransaction.h"
35 #include "IDBTransactionInfo.h"
36 #include "IndexedDB.h"
37 #include "Timer.h"
38 #include <wtf/Deque.h>
39 #include <wtf/HashMap.h>
40
41 namespace WebCore {
42
43 class IDBObjectStoreInfo;
44 class IDBResultData;
45
46 namespace IDBClient {
47
48 class IDBDatabase;
49 class TransactionOperation;
50
51 class IDBTransaction : public WebCore::IDBTransaction {
52 public:
53     static Ref<IDBTransaction> create(IDBDatabase&, const IDBTransactionInfo&);
54
55     virtual ~IDBTransaction() override final;
56
57     // IDBTransaction IDL
58     virtual const String& mode() const override final;
59     virtual WebCore::IDBDatabase* db() override final;
60     virtual RefPtr<DOMError> error() const override final;
61     virtual RefPtr<WebCore::IDBObjectStore> objectStore(const String& name, ExceptionCode&) override final;
62     virtual void abort(ExceptionCode&) override final;
63
64     virtual EventTargetInterface eventTargetInterface() const override final { return IDBTransactionEventTargetInterfaceType; }
65     virtual ScriptExecutionContext* scriptExecutionContext() const override final { return ActiveDOMObject::scriptExecutionContext(); }
66     virtual void refEventTarget() override final { ref(); }
67     virtual void derefEventTarget() override final { deref(); }
68     using EventTarget::dispatchEvent;
69     virtual bool dispatchEvent(PassRefPtr<Event>) override final;
70
71     virtual const char* activeDOMObjectName() const override final;
72     virtual bool canSuspendForPageCache() const override final;
73     virtual bool hasPendingActivity() const override final;
74
75     const IDBTransactionInfo info() const { return m_info; }
76     IDBDatabase& database() { return m_database.get(); }
77     const IDBDatabase& database() const { return m_database.get(); }
78     IDBDatabaseInfo* originalDatabaseInfo() const { return m_originalDatabaseInfo.get(); }
79
80     void didAbort(const IDBError&);
81     void didCommit(const IDBError&);
82
83     bool isVersionChange() const { return m_info.mode() == IndexedDB::TransactionMode::VersionChange; }
84     bool isActive() const;
85
86     Ref<IDBObjectStore> createObjectStore(const IDBObjectStoreInfo&);
87
88     IDBConnectionToServer& serverConnection();
89
90 private:
91     IDBTransaction(IDBDatabase&, const IDBTransactionInfo&);
92
93     bool isFinishedOrFinishing() const;
94
95     void commit();
96
97     void finishAbortOrCommit();
98
99     void scheduleOperation(RefPtr<TransactionOperation>&&);
100     void scheduleOperationTimer();
101     void operationTimerFired();
102     void activationTimerFired();
103
104     void fireOnComplete();
105     void fireOnAbort();
106     void enqueueEvent(Ref<Event>);
107
108     void createObjectStoreOnServer(TransactionOperation&, const IDBObjectStoreInfo&);
109     void didCreateObjectStoreOnServer(const IDBResultData&);
110
111     Ref<IDBDatabase> m_database;
112     IDBTransactionInfo m_info;
113     std::unique_ptr<IDBDatabaseInfo> m_originalDatabaseInfo;
114
115     IndexedDB::TransactionState m_state { IndexedDB::TransactionState::Unstarted };
116     IDBError m_idbError;
117
118     Timer m_operationTimer;
119     std::unique_ptr<Timer> m_activationTimer;
120
121     Deque<RefPtr<TransactionOperation>> m_transactionOperationQueue;
122     HashMap<IDBResourceIdentifier, RefPtr<TransactionOperation>> m_transactionOperationMap;
123 };
124
125 } // namespace IDBClient
126 } // namespace WebCore
127
128 #endif // ENABLE(INDEXED_DATABASE)
129 #endif // IDBTransactionImpl_h