e5fba7cbe3e1e89e9c9b6be430f7e98a16c6153a
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBTransaction.h
1 /*
2  * Copyright (C) 2010 Google 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef IDBTransaction_h
27 #define IDBTransaction_h
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "ActiveDOMObject.h"
32 #include "DOMError.h"
33 #include "DOMStringList.h"
34 #include "Event.h"
35 #include "EventListener.h"
36 #include "EventNames.h"
37 #include "EventTarget.h"
38 #include "IDBMetadata.h"
39 #include "IDBTransactionBackendInterface.h"
40 #include "IDBTransactionCallbacks.h"
41 #include <wtf/HashSet.h>
42 #include <wtf/RefCounted.h>
43
44 namespace WebCore {
45
46 class IDBCursor;
47 class IDBDatabase;
48 class IDBObjectStore;
49
50 class IDBTransaction : public IDBTransactionCallbacks, public EventTarget, public ActiveDOMObject {
51 public:
52     enum Mode {
53         READ_ONLY = 0,
54         READ_WRITE = 1,
55         VERSION_CHANGE = 2
56     };
57
58     static PassRefPtr<IDBTransaction> create(ScriptExecutionContext*, PassRefPtr<IDBTransactionBackendInterface>, Mode, IDBDatabase*);
59     virtual ~IDBTransaction();
60
61     static const AtomicString& modeReadOnly();
62     static const AtomicString& modeReadWrite();
63     static const AtomicString& modeVersionChange();
64     static const AtomicString& modeReadOnlyLegacy();
65     static const AtomicString& modeReadWriteLegacy();
66
67     static Mode stringToMode(const String&, ExceptionCode&);
68     static const AtomicString& modeToString(Mode, ExceptionCode&);
69
70     IDBTransactionBackendInterface* backend() const;
71     bool isActive() const { return m_active; }
72     bool isFinished() const { return m_state == Finished; }
73     bool isReadOnly() const { return m_mode == READ_ONLY; }
74     bool isVersionChange() const { return m_mode == VERSION_CHANGE; }
75
76     // Implement the IDBTransaction IDL
77     const String& mode() const;
78     IDBDatabase* db() const;
79     PassRefPtr<DOMError> error(ExceptionCode&) const;
80     void setError(PassRefPtr<DOMError>);
81
82     PassRefPtr<IDBObjectStore> objectStore(const String& name, ExceptionCode&);
83     void abort();
84
85     class OpenCursorNotifier {
86     public:
87         OpenCursorNotifier(PassRefPtr<IDBTransaction>, IDBCursor*);
88         ~OpenCursorNotifier();
89     private:
90         RefPtr<IDBTransaction> m_transaction;
91         IDBCursor* m_cursor;
92     };
93
94     void registerRequest(IDBRequest*);
95     void unregisterRequest(IDBRequest*);
96     void objectStoreCreated(const String&, PassRefPtr<IDBObjectStore>);
97     void objectStoreDeleted(const String&);
98     void setActive(bool);
99
100     DEFINE_ATTRIBUTE_EVENT_LISTENER(abort);
101     DEFINE_ATTRIBUTE_EVENT_LISTENER(complete);
102     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
103
104     // IDBTransactionCallbacks
105     virtual void onAbort();
106     virtual void onComplete();
107
108     // EventTarget
109     virtual const AtomicString& interfaceName() const;
110     virtual ScriptExecutionContext* scriptExecutionContext() const;
111     virtual bool dispatchEvent(PassRefPtr<Event>);
112     bool dispatchEvent(PassRefPtr<Event> event, ExceptionCode& ec) { return EventTarget::dispatchEvent(event, ec); }
113
114     // ActiveDOMObject
115     virtual bool hasPendingActivity() const OVERRIDE;
116     virtual bool canSuspend() const OVERRIDE;
117     virtual void stop() OVERRIDE;
118
119     using RefCounted<IDBTransactionCallbacks>::ref;
120     using RefCounted<IDBTransactionCallbacks>::deref;
121
122 private:
123     IDBTransaction(ScriptExecutionContext*, PassRefPtr<IDBTransactionBackendInterface>, Mode, IDBDatabase*);
124
125     void enqueueEvent(PassRefPtr<Event>);
126     void closeOpenCursors();
127
128     void registerOpenCursor(IDBCursor*);
129     void unregisterOpenCursor(IDBCursor*);
130
131     // EventTarget
132     virtual void refEventTarget() { ref(); }
133     virtual void derefEventTarget() { deref(); }
134     virtual EventTargetData* eventTargetData();
135     virtual EventTargetData* ensureEventTargetData();
136
137     enum State {
138         Unused, // No requests have been made.
139         Used, // At least one request has been made.
140         Finishing, // In the process of aborting or completing.
141         Finished, // No more events will fire and no new requests may be filed.
142     };
143
144     RefPtr<IDBTransactionBackendInterface> m_backend;
145     RefPtr<IDBDatabase> m_database;
146     const Mode m_mode;
147     bool m_active;
148     State m_state;
149     bool m_contextStopped;
150     RefPtr<DOMError> m_error;
151
152     ListHashSet<IDBRequest*> m_requestList;
153
154     typedef HashMap<String, RefPtr<IDBObjectStore> > IDBObjectStoreMap;
155     IDBObjectStoreMap m_objectStoreMap;
156
157     typedef HashMap<RefPtr<IDBObjectStore>, IDBObjectStoreMetadata> IDBObjectStoreMetadataMap;
158     IDBObjectStoreMetadataMap m_objectStoreCleanupMap;
159
160     HashSet<IDBCursor*> m_openCursors;
161
162     EventTargetData m_eventTargetData;
163 };
164
165 } // namespace WebCore
166
167 #endif // ENABLE(INDEXED_DATABASE)
168
169 #endif // IDBTransaction_h