7087c657e06686c17d15b36d88c69249d23e9b59
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBTransaction.cpp
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 #include "config.h"
27 #include "IDBTransaction.h"
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "EventException.h"
32 #include "EventQueue.h"
33 #include "IDBDatabase.h"
34 #include "IDBDatabaseException.h"
35 #include "IDBEventDispatcher.h"
36 #include "IDBIndex.h"
37 #include "IDBObjectStore.h"
38 #include "IDBObjectStoreBackendInterface.h"
39 #include "IDBPendingTransactionMonitor.h"
40 #include "IDBTracing.h"
41
42 namespace WebCore {
43
44 PassRefPtr<IDBTransaction> IDBTransaction::create(ScriptExecutionContext* context, PassRefPtr<IDBTransactionBackendInterface> backend, IDBTransaction::Mode mode, IDBDatabase* db)
45 {
46     RefPtr<IDBTransaction> transaction(adoptRef(new IDBTransaction(context, backend, mode, db)));
47     transaction->suspendIfNeeded();
48     return transaction.release();
49 }
50
51 const AtomicString& IDBTransaction::modeReadOnly()
52 {
53     DEFINE_STATIC_LOCAL(AtomicString, readonly, ("readonly"));
54     return readonly;
55 }
56
57 const AtomicString& IDBTransaction::modeReadWrite()
58 {
59     DEFINE_STATIC_LOCAL(AtomicString, readwrite, ("readwrite"));
60     return readwrite;
61 }
62
63 const AtomicString& IDBTransaction::modeVersionChange()
64 {
65     DEFINE_STATIC_LOCAL(AtomicString, versionchange, ("versionchange"));
66     return versionchange;
67 }
68
69 const AtomicString& IDBTransaction::modeReadOnlyLegacy()
70 {
71     DEFINE_STATIC_LOCAL(AtomicString, readonly, ("0"));
72     return readonly;
73 }
74
75 const AtomicString& IDBTransaction::modeReadWriteLegacy()
76 {
77     DEFINE_STATIC_LOCAL(AtomicString, readwrite, ("1"));
78     return readwrite;
79 }
80
81
82 IDBTransaction::IDBTransaction(ScriptExecutionContext* context, PassRefPtr<IDBTransactionBackendInterface> backend, IDBTransaction::Mode mode, IDBDatabase* db)
83     : ActiveDOMObject(context, this)
84     , m_backend(backend)
85     , m_database(db)
86     , m_mode(mode)
87     , m_transactionFinished(false)
88     , m_contextStopped(false)
89 {
90     ASSERT(m_backend);
91     ASSERT(m_mode == m_backend->mode());
92     IDBPendingTransactionMonitor::addPendingTransaction(m_backend.get());
93     // We pass a reference of this object before it can be adopted.
94     relaxAdoptionRequirement();
95     m_database->transactionCreated(this);
96 }
97
98 IDBTransaction::~IDBTransaction()
99 {
100 }
101
102 IDBTransactionBackendInterface* IDBTransaction::backend() const
103 {
104     return m_backend.get();
105 }
106
107 bool IDBTransaction::isFinished() const
108 {
109     return m_transactionFinished;
110 }
111
112 const String& IDBTransaction::mode() const
113 {
114     ExceptionCode ec = 0;
115     const AtomicString& mode = modeToString(m_mode, ec);
116     ASSERT(!ec);
117     return mode;
118 }
119
120 IDBDatabase* IDBTransaction::db() const
121 {
122     return m_database.get();
123 }
124
125 PassRefPtr<DOMError> IDBTransaction::error(ExceptionCode& ec) const
126 {
127     if (!m_transactionFinished) {
128         ec = IDBDatabaseException::IDB_INVALID_STATE_ERR;
129         return 0;
130     }
131     return m_error;
132 }
133
134 void IDBTransaction::setError(PassRefPtr<DOMError> error)
135 {
136     ASSERT(!m_transactionFinished);
137     ASSERT(error);
138
139     // The first error to be set is the true cause of the
140     // transaction abort.
141     if (!m_error)
142         m_error = error;
143 }
144
145 PassRefPtr<IDBObjectStore> IDBTransaction::objectStore(const String& name, ExceptionCode& ec)
146 {
147     if (m_transactionFinished) {
148         ec = IDBDatabaseException::IDB_INVALID_STATE_ERR;
149         return 0;
150     }
151
152     IDBObjectStoreMap::iterator it = m_objectStoreMap.find(name);
153     if (it != m_objectStoreMap.end())
154         return it->second;
155
156     RefPtr<IDBObjectStoreBackendInterface> objectStoreBackend = m_backend->objectStore(name, ec);
157     ASSERT(!objectStoreBackend != !ec); // If we didn't get a store, we should have gotten an exception code. And vice versa.
158     if (ec)
159         return 0;
160
161     const IDBDatabaseMetadata& metadata = m_database->metadata();
162     IDBDatabaseMetadata::ObjectStoreMap::const_iterator mdit = metadata.objectStores.find(name);
163     ASSERT(mdit != metadata.objectStores.end());
164
165     RefPtr<IDBObjectStore> objectStore = IDBObjectStore::create(mdit->second, objectStoreBackend, this);
166     objectStoreCreated(name, objectStore);
167     return objectStore.release();
168 }
169
170 void IDBTransaction::objectStoreCreated(const String& name, PassRefPtr<IDBObjectStore> prpObjectStore)
171 {
172     ASSERT(!m_transactionFinished);
173     RefPtr<IDBObjectStore> objectStore = prpObjectStore;
174     m_objectStoreMap.set(name, objectStore);
175     if (isVersionChange())
176         m_objectStoreCleanupMap.set(objectStore, objectStore->metadata());
177 }
178
179 void IDBTransaction::objectStoreDeleted(const String& name)
180 {
181     ASSERT(!m_transactionFinished);
182     ASSERT(isVersionChange());
183     IDBObjectStoreMap::iterator it = m_objectStoreMap.find(name);
184     if (it != m_objectStoreMap.end()) {
185         RefPtr<IDBObjectStore> objectStore = it->second;
186         m_objectStoreMap.remove(name);
187         objectStore->markDeleted();
188         m_objectStoreCleanupMap.set(objectStore, objectStore->metadata());
189     }
190 }
191
192 void IDBTransaction::abort()
193 {
194     if (m_transactionFinished)
195         return;
196     RefPtr<IDBTransaction> selfRef = this;
197     if (m_backend)
198         m_backend->abort();
199 }
200
201 IDBTransaction::OpenCursorNotifier::OpenCursorNotifier(PassRefPtr<IDBTransaction> transaction, IDBCursor* cursor)
202     : m_transaction(transaction),
203       m_cursor(cursor)
204 {
205     m_transaction->registerOpenCursor(m_cursor);
206 }
207
208 IDBTransaction::OpenCursorNotifier::~OpenCursorNotifier()
209 {
210     m_transaction->unregisterOpenCursor(m_cursor);
211 }
212
213 void IDBTransaction::registerOpenCursor(IDBCursor* cursor)
214 {
215     m_openCursors.add(cursor);
216 }
217
218 void IDBTransaction::unregisterOpenCursor(IDBCursor* cursor)
219 {
220     m_openCursors.remove(cursor);
221 }
222
223 void IDBTransaction::closeOpenCursors()
224 {
225     HashSet<IDBCursor*> cursors;
226     cursors.swap(m_openCursors);
227     for (HashSet<IDBCursor*>::iterator i = cursors.begin(); i != cursors.end(); ++i)
228         (*i)->close();
229 }
230
231 void IDBTransaction::registerRequest(IDBRequest* request)
232 {
233     m_childRequests.add(request);
234 }
235
236 void IDBTransaction::unregisterRequest(IDBRequest* request)
237 {
238     // If we aborted the request, it will already have been removed.
239     m_childRequests.remove(request);
240 }
241
242 void IDBTransaction::onAbort()
243 {
244     ASSERT(!m_transactionFinished);
245     while (!m_childRequests.isEmpty()) {
246         IDBRequest* request = *m_childRequests.begin();
247         m_childRequests.remove(request);
248         request->abort();
249     }
250
251     if (isVersionChange()) {
252         for (IDBObjectStoreMetadataMap::iterator it = m_objectStoreCleanupMap.begin(); it != m_objectStoreCleanupMap.end(); ++it)
253             it->first->setMetadata(it->second);
254     }
255     m_objectStoreCleanupMap.clear();
256     closeOpenCursors();
257     m_database->transactionFinished(this);
258
259     if (m_contextStopped || !scriptExecutionContext())
260         return;
261
262     enqueueEvent(Event::create(eventNames().abortEvent, true, false));
263 }
264
265 void IDBTransaction::onComplete()
266 {
267     ASSERT(!m_transactionFinished);
268     m_objectStoreCleanupMap.clear();
269     closeOpenCursors();
270     m_database->transactionFinished(this);
271
272     if (m_contextStopped || !scriptExecutionContext())
273         return;
274
275     enqueueEvent(Event::create(eventNames().completeEvent, false, false));
276 }
277
278 bool IDBTransaction::hasPendingActivity() const
279 {
280     // FIXME: In an ideal world, we should return true as long as anyone has a or can
281     //        get a handle to us or any child request object and any of those have
282     //        event listeners. This is  in order to handle user generated events properly.
283     return !m_transactionFinished || ActiveDOMObject::hasPendingActivity();
284 }
285
286 IDBTransaction::Mode IDBTransaction::stringToMode(const String& modeString, ExceptionCode& ec)
287 {
288     if (modeString.isNull()
289         || modeString == IDBTransaction::modeReadOnly())
290         return IDBTransaction::READ_ONLY;
291     if (modeString == IDBTransaction::modeReadWrite())
292         return IDBTransaction::READ_WRITE;
293     ec = IDBDatabaseException::IDB_TYPE_ERR;
294     return IDBTransaction::READ_ONLY;
295 }
296
297 const AtomicString& IDBTransaction::modeToString(IDBTransaction::Mode mode, ExceptionCode& ec)
298 {
299     switch (mode) {
300     case IDBTransaction::READ_ONLY:
301         return IDBTransaction::modeReadOnly();
302         break;
303
304     case IDBTransaction::READ_WRITE:
305         return IDBTransaction::modeReadWrite();
306         break;
307
308     case IDBTransaction::VERSION_CHANGE:
309         return IDBTransaction::modeVersionChange();
310         break;
311
312     default:
313         ec = IDBDatabaseException::IDB_TYPE_ERR;
314         return IDBTransaction::modeReadOnly();
315     }
316 }
317
318 const AtomicString& IDBTransaction::interfaceName() const
319 {
320     return eventNames().interfaceForIDBTransaction;
321 }
322
323 ScriptExecutionContext* IDBTransaction::scriptExecutionContext() const
324 {
325     return ActiveDOMObject::scriptExecutionContext();
326 }
327
328 bool IDBTransaction::dispatchEvent(PassRefPtr<Event> event)
329 {
330     IDB_TRACE("IDBTransaction::dispatchEvent");
331     ASSERT(!m_transactionFinished);
332     ASSERT(scriptExecutionContext());
333     ASSERT(event->target() == this);
334     m_transactionFinished = true;
335
336     // Break reference cycles.
337     for (IDBObjectStoreMap::iterator it = m_objectStoreMap.begin(); it != m_objectStoreMap.end(); ++it)
338         it->second->transactionFinished();
339     m_objectStoreMap.clear();
340
341     Vector<RefPtr<EventTarget> > targets;
342     targets.append(this);
343     targets.append(db());
344
345     // FIXME: When we allow custom event dispatching, this will probably need to change.
346     ASSERT(event->type() == eventNames().completeEvent || event->type() == eventNames().abortEvent);
347     return IDBEventDispatcher::dispatch(event.get(), targets);
348 }
349
350 bool IDBTransaction::canSuspend() const
351 {
352     // FIXME: Technically we can suspend before the first request is schedule
353     //        and after the complete/abort event is enqueued.
354     return m_transactionFinished;
355 }
356
357 void IDBTransaction::stop()
358 {
359     ActiveDOMObject::stop();
360     m_contextStopped = true;
361
362     abort();
363 }
364
365 void IDBTransaction::enqueueEvent(PassRefPtr<Event> event)
366 {
367     ASSERT_WITH_MESSAGE(!m_transactionFinished, "A finished transaction tried to enqueue an event of type %s.", event->type().string().utf8().data());
368     if (m_contextStopped || !scriptExecutionContext())
369         return;
370
371     EventQueue* eventQueue = scriptExecutionContext()->eventQueue();
372     event->setTarget(this);
373     eventQueue->enqueueEvent(event);
374 }
375
376 EventTargetData* IDBTransaction::eventTargetData()
377 {
378     return &m_eventTargetData;
379 }
380
381 EventTargetData* IDBTransaction::ensureEventTargetData()
382 {
383     return &m_eventTargetData;
384 }
385
386 }
387
388 #endif // ENABLE(INDEXED_DATABASE)