2008ed8b4fcbcbb573364da97ea80d09bddb183a
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBDatabase.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 "IDBDatabase.h"
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "EventQueue.h"
32 #include "ExceptionCode.h"
33 #include "IDBAny.h"
34 #include "IDBDatabaseCallbacksImpl.h"
35 #include "IDBDatabaseError.h"
36 #include "IDBDatabaseException.h"
37 #include "IDBEventDispatcher.h"
38 #include "IDBFactoryBackendInterface.h"
39 #include "IDBIndex.h"
40 #include "IDBKeyPath.h"
41 #include "IDBObjectStore.h"
42 #include "IDBTracing.h"
43 #include "IDBTransaction.h"
44 #include "IDBVersionChangeEvent.h"
45 #include "IDBVersionChangeRequest.h"
46 #include "ScriptExecutionContext.h"
47 #include <limits>
48
49 namespace WebCore {
50
51 PassRefPtr<IDBDatabase> IDBDatabase::create(ScriptExecutionContext* context, PassRefPtr<IDBDatabaseBackendInterface> database)
52 {
53     RefPtr<IDBDatabase> idbDatabase(adoptRef(new IDBDatabase(context, database)));
54     idbDatabase->suspendIfNeeded();
55     return idbDatabase.release();
56 }
57
58 IDBDatabase::IDBDatabase(ScriptExecutionContext* context, PassRefPtr<IDBDatabaseBackendInterface> backend)
59     : ActiveDOMObject(context, this)
60     , m_backend(backend)
61     , m_closePending(false)
62     , m_contextStopped(false)
63 {
64     // We pass a reference of this object before it can be adopted.
65     relaxAdoptionRequirement();
66     m_databaseCallbacks = IDBDatabaseCallbacksImpl::create(this);
67 }
68
69 IDBDatabase::~IDBDatabase()
70 {
71     close();
72     m_databaseCallbacks->unregisterDatabase(this);
73 }
74
75 void IDBDatabase::transactionCreated(IDBTransaction* transaction)
76 {
77     ASSERT(transaction);
78     ASSERT(!m_transactions.contains(transaction));
79     m_transactions.add(transaction);
80
81     if (transaction->isVersionChange()) {
82         ASSERT(!m_versionChangeTransaction);
83         m_versionChangeTransaction = transaction;
84     }
85 }
86
87 void IDBDatabase::transactionFinished(IDBTransaction* transaction)
88 {
89     ASSERT(transaction);
90     ASSERT(m_transactions.contains(transaction));
91     m_transactions.remove(transaction);
92
93     if (transaction->isVersionChange()) {
94         ASSERT(m_versionChangeTransaction == transaction);
95         m_versionChangeTransaction = 0;
96     }
97
98     if (m_closePending && m_transactions.isEmpty())
99         closeConnection();
100 }
101
102 PassRefPtr<IDBObjectStore> IDBDatabase::createObjectStore(const String& name, const Dictionary& options, ExceptionCode& ec)
103 {
104     if (!m_versionChangeTransaction) {
105         ec = IDBDatabaseException::IDB_INVALID_STATE_ERR;
106         return 0;
107     }
108
109     IDBKeyPath keyPath;
110     if (!options.isUndefinedOrNull()) {
111         String keyPathString;
112         Vector<String> keyPathArray;
113         if (options.get("keyPath", keyPathArray))
114             keyPath = IDBKeyPath(keyPathArray);
115         else if (options.getWithUndefinedOrNullCheck("keyPath", keyPathString))
116             keyPath = IDBKeyPath(keyPathString);
117     }
118
119     if (!keyPath.isNull() && !keyPath.isValid()) {
120         ec = IDBDatabaseException::IDB_SYNTAX_ERR;
121         return 0;
122     }
123
124     bool autoIncrement = false;
125     if (!options.isUndefinedOrNull())
126         options.get("autoIncrement", autoIncrement);
127
128     if (autoIncrement && ((keyPath.type() == IDBKeyPath::StringType && keyPath.string().isEmpty()) || keyPath.type() == IDBKeyPath::ArrayType)) {
129         ec = IDBDatabaseException::IDB_INVALID_ACCESS_ERR;
130         return 0;
131     }
132
133     RefPtr<IDBObjectStoreBackendInterface> objectStoreBackend = m_backend->createObjectStore(name, keyPath, autoIncrement, m_versionChangeTransaction->backend(), ec);
134     if (!objectStoreBackend) {
135         ASSERT(ec);
136         return 0;
137     }
138
139     RefPtr<IDBObjectStore> objectStore = IDBObjectStore::create(objectStoreBackend.release(), m_versionChangeTransaction.get());
140     m_versionChangeTransaction->objectStoreCreated(name, objectStore);
141     return objectStore.release();
142 }
143
144 void IDBDatabase::deleteObjectStore(const String& name, ExceptionCode& ec)
145 {
146     if (!m_versionChangeTransaction) {
147         ec = IDBDatabaseException::IDB_INVALID_STATE_ERR;
148         return;
149     }
150
151     m_backend->deleteObjectStore(name, m_versionChangeTransaction->backend(), ec);
152     if (!ec)
153         m_versionChangeTransaction->objectStoreDeleted(name);
154 }
155
156 PassRefPtr<IDBVersionChangeRequest> IDBDatabase::setVersion(ScriptExecutionContext* context, const String& version, ExceptionCode& ec)
157 {
158     if (version.isNull()) {
159         ec = IDBDatabaseException::IDB_TYPE_ERR;
160         return 0;
161     }
162
163     if (m_versionChangeTransaction) {
164         ec = IDBDatabaseException::IDB_INVALID_STATE_ERR;
165         return 0;
166     }
167
168     RefPtr<IDBVersionChangeRequest> request = IDBVersionChangeRequest::create(context, IDBAny::create(this), version);
169     m_backend->setVersion(version, request, m_databaseCallbacks, ec);
170     return request;
171 }
172
173 PassRefPtr<IDBTransaction> IDBDatabase::transaction(ScriptExecutionContext* context, PassRefPtr<DOMStringList> prpStoreNames, const String& modeString, ExceptionCode& ec)
174 {
175     RefPtr<DOMStringList> storeNames = prpStoreNames;
176     if (!storeNames || storeNames->isEmpty()) {
177         ec = IDBDatabaseException::IDB_INVALID_ACCESS_ERR;
178         return 0;
179     }
180
181     IDBTransaction::Mode mode = IDBTransaction::stringToMode(modeString, ec);
182     if (ec)
183         return 0;
184
185     if (m_versionChangeTransaction || m_closePending) {
186         ec = IDBDatabaseException::IDB_INVALID_STATE_ERR;
187         return 0;
188     }
189
190     // We need to create a new transaction synchronously. Locks are acquired asynchronously. Operations
191     // can be queued against the transaction at any point. They will start executing as soon as the
192     // appropriate locks have been acquired.
193     // Also note that each backend object corresponds to exactly one IDBTransaction object.
194     RefPtr<IDBTransactionBackendInterface> transactionBackend = m_backend->transaction(storeNames.get(), mode, ec);
195     if (!transactionBackend) {
196         ASSERT(ec);
197         return 0;
198     }
199     RefPtr<IDBTransaction> transaction = IDBTransaction::create(context, transactionBackend, mode, this);
200     transactionBackend->setCallbacks(transaction.get());
201     return transaction.release();
202 }
203
204 PassRefPtr<IDBTransaction> IDBDatabase::transaction(ScriptExecutionContext* context, const String& storeName, const String& mode, ExceptionCode& ec)
205 {
206     RefPtr<DOMStringList> storeNames = DOMStringList::create();
207     storeNames->append(storeName);
208     return transaction(context, storeNames, mode, ec);
209 }
210
211 PassRefPtr<IDBTransaction> IDBDatabase::transaction(ScriptExecutionContext* context, const String& storeName, unsigned short mode, ExceptionCode& ec)
212 {
213     RefPtr<DOMStringList> storeNames = DOMStringList::create();
214     storeNames->append(storeName);
215     return transaction(context, storeNames, mode, ec);
216 }
217
218 PassRefPtr<IDBTransaction> IDBDatabase::transaction(ScriptExecutionContext* context, PassRefPtr<DOMStringList> prpStoreNames, unsigned short mode, ExceptionCode& ec)
219 {
220     DEFINE_STATIC_LOCAL(String, consoleMessage, ("Numeric transaction modes are deprecated in IDBDatabase.transaction. Use \"readonly\" or \"readwrite\"."));
221     context->addConsoleMessage(JSMessageSource, LogMessageType, WarningMessageLevel, consoleMessage);
222     AtomicString modeString = IDBTransaction::modeToString(IDBTransaction::Mode(mode), ec);
223     if (ec)
224         return 0;
225
226     return transaction(context, prpStoreNames, modeString, ec);
227 }
228
229 void IDBDatabase::close()
230 {
231     if (m_closePending)
232         return;
233
234     m_closePending = true;
235
236     if (m_transactions.isEmpty())
237         closeConnection();
238 }
239
240 void IDBDatabase::closeConnection()
241 {
242     ASSERT(m_closePending);
243     ASSERT(m_transactions.isEmpty());
244
245     m_backend->close(m_databaseCallbacks);
246
247     if (m_contextStopped || !scriptExecutionContext())
248         return;
249
250     EventQueue* eventQueue = scriptExecutionContext()->eventQueue();
251     // Remove any pending versionchange events scheduled to fire on this
252     // connection. They would have been scheduled by the backend when another
253     // connection called setVersion, but the frontend connection is being
254     // closed before they could fire.
255     for (size_t i = 0; i < m_enqueuedEvents.size(); ++i) {
256         bool removed = eventQueue->cancelEvent(m_enqueuedEvents[i].get());
257         ASSERT_UNUSED(removed, removed);
258     }
259 }
260
261 void IDBDatabase::onVersionChange(const String& version)
262 {
263     if (m_contextStopped || !scriptExecutionContext())
264         return;
265
266     enqueueEvent(IDBVersionChangeEvent::create(version, eventNames().versionchangeEvent));
267 }
268
269 void IDBDatabase::registerFrontendCallbacks()
270 {
271     m_backend->registerFrontendCallbacks(m_databaseCallbacks);
272 }
273
274 void IDBDatabase::enqueueEvent(PassRefPtr<Event> event)
275 {
276     ASSERT(!m_contextStopped);
277     ASSERT(scriptExecutionContext());
278     EventQueue* eventQueue = scriptExecutionContext()->eventQueue();
279     event->setTarget(this);
280     eventQueue->enqueueEvent(event.get());
281     m_enqueuedEvents.append(event);
282 }
283
284 bool IDBDatabase::dispatchEvent(PassRefPtr<Event> event)
285 {
286     IDB_TRACE("IDBDatabase::dispatchEvent");
287     ASSERT(event->type() == eventNames().versionchangeEvent);
288     for (size_t i = 0; i < m_enqueuedEvents.size(); ++i) {
289         if (m_enqueuedEvents[i].get() == event.get())
290             m_enqueuedEvents.remove(i);
291     }
292     return EventTarget::dispatchEvent(event.get());
293 }
294
295 void IDBDatabase::stop()
296 {
297     ActiveDOMObject::stop();
298     // Stop fires at a deterministic time, so we need to call close in it.
299     close();
300
301     m_contextStopped = true;
302 }
303
304 const AtomicString& IDBDatabase::interfaceName() const
305 {
306     return eventNames().interfaceForIDBDatabase;
307 }
308
309 ScriptExecutionContext* IDBDatabase::scriptExecutionContext() const
310 {
311     return ActiveDOMObject::scriptExecutionContext();
312 }
313
314 EventTargetData* IDBDatabase::eventTargetData()
315 {
316     return &m_eventTargetData;
317 }
318
319 EventTargetData* IDBDatabase::ensureEventTargetData()
320 {
321     return &m_eventTargetData;
322 }
323
324 } // namespace WebCore
325
326 #endif // ENABLE(INDEXED_DATABASE)