IndexedDB: Implement spec updates to IDBTransaction.error
[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_active(true)
88     , m_state(Unused)
89     , m_contextStopped(false)
90 {
91     ASSERT(m_backend);
92
93     if (mode == VERSION_CHANGE) {
94         // Not active until the callback.
95         m_active = false;
96         // Implicitly used by the version change itself.
97         m_state = Used;
98     }
99
100     // We pass a reference of this object before it can be adopted.
101     relaxAdoptionRequirement();
102     if (m_active)
103         IDBPendingTransactionMonitor::addNewTransaction(this);
104     m_database->transactionCreated(this);
105 }
106
107 IDBTransaction::~IDBTransaction()
108 {
109     ASSERT(m_state == Finished);
110 }
111
112 IDBTransactionBackendInterface* IDBTransaction::backend() const
113 {
114     return m_backend.get();
115 }
116
117 const String& IDBTransaction::mode() const
118 {
119     ExceptionCode ec = 0;
120     const AtomicString& mode = modeToString(m_mode, ec);
121     ASSERT(!ec);
122     return mode;
123 }
124
125 void IDBTransaction::setError(PassRefPtr<DOMError> error)
126 {
127     ASSERT(m_state != Finished);
128     ASSERT(error);
129
130     // The first error to be set is the true cause of the
131     // transaction abort.
132     if (!m_error)
133         m_error = error;
134 }
135
136 PassRefPtr<IDBObjectStore> IDBTransaction::objectStore(const String& name, ExceptionCode& ec)
137 {
138     if (m_state == Finished) {
139         ec = IDBDatabaseException::IDB_INVALID_STATE_ERR;
140         return 0;
141     }
142
143     IDBObjectStoreMap::iterator it = m_objectStoreMap.find(name);
144     if (it != m_objectStoreMap.end())
145         return it->second;
146
147     RefPtr<IDBObjectStoreBackendInterface> objectStoreBackend = m_backend->objectStore(name, ec);
148     ASSERT(!objectStoreBackend != !ec); // If we didn't get a store, we should have gotten an exception code. And vice versa.
149     if (ec)
150         return 0;
151
152     const IDBDatabaseMetadata& metadata = m_database->metadata();
153     IDBDatabaseMetadata::ObjectStoreMap::const_iterator mdit = metadata.objectStores.find(name);
154     ASSERT(mdit != metadata.objectStores.end());
155
156     RefPtr<IDBObjectStore> objectStore = IDBObjectStore::create(mdit->second, objectStoreBackend, this);
157     objectStoreCreated(name, objectStore);
158     return objectStore.release();
159 }
160
161 void IDBTransaction::objectStoreCreated(const String& name, PassRefPtr<IDBObjectStore> prpObjectStore)
162 {
163     ASSERT(m_state != Finished);
164     RefPtr<IDBObjectStore> objectStore = prpObjectStore;
165     m_objectStoreMap.set(name, objectStore);
166     if (isVersionChange())
167         m_objectStoreCleanupMap.set(objectStore, objectStore->metadata());
168 }
169
170 void IDBTransaction::objectStoreDeleted(const String& name)
171 {
172     ASSERT(m_state != Finished);
173     ASSERT(isVersionChange());
174     IDBObjectStoreMap::iterator it = m_objectStoreMap.find(name);
175     if (it != m_objectStoreMap.end()) {
176         RefPtr<IDBObjectStore> objectStore = it->second;
177         m_objectStoreMap.remove(name);
178         objectStore->markDeleted();
179         m_objectStoreCleanupMap.set(objectStore, objectStore->metadata());
180     }
181 }
182
183 void IDBTransaction::setActive(bool active)
184 {
185     ASSERT(m_state != Finished);
186     if (m_state == Finishing)
187         return;
188     ASSERT(m_state == Unused || m_state == Used);
189     ASSERT(active != m_active);
190     m_active = active;
191
192     if (!active && m_state == Unused)
193         m_backend->commit();
194 }
195
196 void IDBTransaction::abort()
197 {
198     if (m_state == Finishing || m_state == Finished)
199         return;
200     m_state = Finishing;
201     m_active = false;
202
203     while (!m_requestList.isEmpty()) {
204         IDBRequest* request = *m_requestList.begin();
205         m_requestList.remove(request);
206         request->abort();
207     }
208
209     RefPtr<IDBTransaction> selfRef = this;
210     if (m_backend)
211         m_backend->abort();
212 }
213
214 IDBTransaction::OpenCursorNotifier::OpenCursorNotifier(PassRefPtr<IDBTransaction> transaction, IDBCursor* cursor)
215     : m_transaction(transaction),
216       m_cursor(cursor)
217 {
218     m_transaction->registerOpenCursor(m_cursor);
219 }
220
221 IDBTransaction::OpenCursorNotifier::~OpenCursorNotifier()
222 {
223     m_transaction->unregisterOpenCursor(m_cursor);
224 }
225
226 void IDBTransaction::registerOpenCursor(IDBCursor* cursor)
227 {
228     m_openCursors.add(cursor);
229 }
230
231 void IDBTransaction::unregisterOpenCursor(IDBCursor* cursor)
232 {
233     m_openCursors.remove(cursor);
234 }
235
236 void IDBTransaction::closeOpenCursors()
237 {
238     HashSet<IDBCursor*> cursors;
239     cursors.swap(m_openCursors);
240     for (HashSet<IDBCursor*>::iterator i = cursors.begin(); i != cursors.end(); ++i)
241         (*i)->close();
242 }
243
244 void IDBTransaction::registerRequest(IDBRequest* request)
245 {
246     ASSERT(request);
247     ASSERT(m_state == Unused || m_state == Used);
248     ASSERT(m_active);
249     m_requestList.add(request);
250     m_state = Used;
251 }
252
253 void IDBTransaction::unregisterRequest(IDBRequest* request)
254 {
255     ASSERT(request);
256     // If we aborted the request, it will already have been removed.
257     m_requestList.remove(request);
258 }
259
260 void IDBTransaction::onAbort()
261 {
262     ASSERT(m_state != Finished);
263
264     if (m_state != Finishing) {
265         // FIXME: Propagate true cause from back end (e.g. QuotaError, UnknownError, etc.)
266         setError(DOMError::create(IDBDatabaseException::getErrorName(IDBDatabaseException::UNKNOWN_ERR)));
267
268         // Abort was not triggered by front-end, so outstanding requests must
269         // be aborted now.
270         while (!m_requestList.isEmpty()) {
271             IDBRequest* request = *m_requestList.begin();
272             m_requestList.remove(request);
273             request->abort();
274         }
275         m_state = Finishing;
276     }
277
278     if (isVersionChange()) {
279         for (IDBObjectStoreMetadataMap::iterator it = m_objectStoreCleanupMap.begin(); it != m_objectStoreCleanupMap.end(); ++it)
280             it->first->setMetadata(it->second);
281     }
282     m_objectStoreCleanupMap.clear();
283     closeOpenCursors();
284     m_database->transactionFinished(this);
285
286     if (m_contextStopped || !scriptExecutionContext())
287         return;
288
289     enqueueEvent(Event::create(eventNames().abortEvent, true, false));
290 }
291
292 void IDBTransaction::onComplete()
293 {
294     ASSERT(m_state != Finished);
295     m_state = Finishing;
296     m_objectStoreCleanupMap.clear();
297     closeOpenCursors();
298     m_database->transactionFinished(this);
299
300     if (m_contextStopped || !scriptExecutionContext())
301         return;
302
303     enqueueEvent(Event::create(eventNames().completeEvent, false, false));
304 }
305
306 bool IDBTransaction::hasPendingActivity() const
307 {
308     // FIXME: In an ideal world, we should return true as long as anyone has a or can
309     //        get a handle to us or any child request object and any of those have
310     //        event listeners. This is  in order to handle user generated events properly.
311     return m_state != Finished || ActiveDOMObject::hasPendingActivity();
312 }
313
314 IDBTransaction::Mode IDBTransaction::stringToMode(const String& modeString, ExceptionCode& ec)
315 {
316     if (modeString.isNull()
317         || modeString == IDBTransaction::modeReadOnly())
318         return IDBTransaction::READ_ONLY;
319     if (modeString == IDBTransaction::modeReadWrite())
320         return IDBTransaction::READ_WRITE;
321     ec = IDBDatabaseException::IDB_TYPE_ERR;
322     return IDBTransaction::READ_ONLY;
323 }
324
325 const AtomicString& IDBTransaction::modeToString(IDBTransaction::Mode mode, ExceptionCode& ec)
326 {
327     switch (mode) {
328     case IDBTransaction::READ_ONLY:
329         return IDBTransaction::modeReadOnly();
330         break;
331
332     case IDBTransaction::READ_WRITE:
333         return IDBTransaction::modeReadWrite();
334         break;
335
336     case IDBTransaction::VERSION_CHANGE:
337         return IDBTransaction::modeVersionChange();
338         break;
339
340     default:
341         ec = IDBDatabaseException::IDB_TYPE_ERR;
342         return IDBTransaction::modeReadOnly();
343     }
344 }
345
346 const AtomicString& IDBTransaction::interfaceName() const
347 {
348     return eventNames().interfaceForIDBTransaction;
349 }
350
351 ScriptExecutionContext* IDBTransaction::scriptExecutionContext() const
352 {
353     return ActiveDOMObject::scriptExecutionContext();
354 }
355
356 bool IDBTransaction::dispatchEvent(PassRefPtr<Event> event)
357 {
358     IDB_TRACE("IDBTransaction::dispatchEvent");
359     ASSERT(m_state != Finished);
360     ASSERT(scriptExecutionContext());
361     ASSERT(event->target() == this);
362     m_state = Finished;
363
364     // Break reference cycles.
365     for (IDBObjectStoreMap::iterator it = m_objectStoreMap.begin(); it != m_objectStoreMap.end(); ++it)
366         it->second->transactionFinished();
367     m_objectStoreMap.clear();
368
369     Vector<RefPtr<EventTarget> > targets;
370     targets.append(this);
371     targets.append(db());
372
373     // FIXME: When we allow custom event dispatching, this will probably need to change.
374     ASSERT(event->type() == eventNames().completeEvent || event->type() == eventNames().abortEvent);
375     return IDBEventDispatcher::dispatch(event.get(), targets);
376 }
377
378 bool IDBTransaction::canSuspend() const
379 {
380     // FIXME: Technically we can suspend before the first request is schedule
381     //        and after the complete/abort event is enqueued.
382     return m_state == Finished;
383 }
384
385 void IDBTransaction::stop()
386 {
387     ActiveDOMObject::stop();
388     m_contextStopped = true;
389
390     abort();
391 }
392
393 void IDBTransaction::enqueueEvent(PassRefPtr<Event> event)
394 {
395     ASSERT_WITH_MESSAGE(m_state != Finished, "A finished transaction tried to enqueue an event of type %s.", event->type().string().utf8().data());
396     if (m_contextStopped || !scriptExecutionContext())
397         return;
398
399     EventQueue* eventQueue = scriptExecutionContext()->eventQueue();
400     event->setTarget(this);
401     eventQueue->enqueueEvent(event);
402 }
403
404 EventTargetData* IDBTransaction::eventTargetData()
405 {
406     return &m_eventTargetData;
407 }
408
409 EventTargetData* IDBTransaction::ensureEventTargetData()
410 {
411     return &m_eventTargetData;
412 }
413
414 }
415
416 #endif // ENABLE(INDEXED_DATABASE)