Transition most IDB interfaces from ScriptExecutionContext to ExecState.
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBCursor.cpp
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 #include "config.h"
27 #include "IDBCursor.h"
28
29 #if ENABLE(INDEXED_DATABASE)
30
31 #include "ExceptionCode.h"
32 #include "IDBBindingUtilities.h"
33 #include "IDBDatabase.h"
34 #include "IDBDatabaseException.h"
35 #include "IDBGetResult.h"
36 #include "IDBIndex.h"
37 #include "IDBObjectStore.h"
38 #include "IDBRequest.h"
39 #include "IDBTransaction.h"
40 #include "Logging.h"
41 #include "ScriptExecutionContext.h"
42 #include <heap/StrongInlines.h>
43 #include <runtime/JSCJSValueInlines.h>
44 #include <wtf/NeverDestroyed.h>
45
46 using namespace JSC;
47
48 namespace WebCore {
49
50 const AtomicString& IDBCursor::directionNext()
51 {
52     static NeverDestroyed<AtomicString> next("next", AtomicString::ConstructFromLiteral);
53     return next;
54 }
55
56 const AtomicString& IDBCursor::directionNextUnique()
57 {
58     static NeverDestroyed<AtomicString> nextunique("nextunique", AtomicString::ConstructFromLiteral);
59     return nextunique;
60 }
61
62 const AtomicString& IDBCursor::directionPrev()
63 {
64     static NeverDestroyed<AtomicString> prev("prev", AtomicString::ConstructFromLiteral);
65     return prev;
66 }
67
68 const AtomicString& IDBCursor::directionPrevUnique()
69 {
70     static NeverDestroyed<AtomicString> prevunique("prevunique", AtomicString::ConstructFromLiteral);
71     return prevunique;
72 }
73
74 IndexedDB::CursorDirection IDBCursor::stringToDirection(const String& directionString, ExceptionCode& ec)
75 {
76     if (directionString == directionNext())
77         return IndexedDB::CursorDirection::Next;
78     if (directionString == directionNextUnique())
79         return IndexedDB::CursorDirection::NextNoDuplicate;
80     if (directionString == directionPrev())
81         return IndexedDB::CursorDirection::Prev;
82     if (directionString == directionPrevUnique())
83         return IndexedDB::CursorDirection::PrevNoDuplicate;
84
85     ec = TypeError;
86     return IndexedDB::CursorDirection::Next;
87 }
88
89 const AtomicString& IDBCursor::directionToString(IndexedDB::CursorDirection direction)
90 {
91     switch (direction) {
92     case IndexedDB::CursorDirection::Next:
93         return directionNext();
94
95     case IndexedDB::CursorDirection::NextNoDuplicate:
96         return directionNextUnique();
97
98     case IndexedDB::CursorDirection::Prev:
99         return directionPrev();
100
101     case IndexedDB::CursorDirection::PrevNoDuplicate:
102         return directionPrevUnique();
103
104     default:
105         ASSERT_NOT_REACHED();
106         return directionNext();
107     }
108 }
109
110 Ref<IDBCursor> IDBCursor::create(IDBTransaction& transaction, IDBIndex& index, const IDBCursorInfo& info)
111 {
112     return adoptRef(*new IDBCursor(transaction, index, info));
113 }
114
115 IDBCursor::IDBCursor(IDBTransaction& transaction, IDBObjectStore& objectStore, const IDBCursorInfo& info)
116     : ActiveDOMObject(transaction.scriptExecutionContext())
117     , m_info(info)
118     , m_objectStore(&objectStore)
119 {
120     ASSERT(currentThread() == effectiveObjectStore().modernTransaction().database().originThreadID());
121
122     suspendIfNeeded();
123 }
124
125 IDBCursor::IDBCursor(IDBTransaction& transaction, IDBIndex& index, const IDBCursorInfo& info)
126     : ActiveDOMObject(transaction.scriptExecutionContext())
127     , m_info(info)
128     , m_index(&index)
129 {
130     ASSERT(currentThread() == effectiveObjectStore().modernTransaction().database().originThreadID());
131
132     suspendIfNeeded();
133 }
134
135 IDBCursor::~IDBCursor()
136 {
137     ASSERT(currentThread() == effectiveObjectStore().modernTransaction().database().originThreadID());
138 }
139
140 bool IDBCursor::sourcesDeleted() const
141 {
142     ASSERT(currentThread() == effectiveObjectStore().modernTransaction().database().originThreadID());
143
144     if (m_objectStore)
145         return m_objectStore->isDeleted();
146
147     ASSERT(m_index);
148     return m_index->isDeleted() || m_index->modernObjectStore().isDeleted();
149 }
150
151 IDBObjectStore& IDBCursor::effectiveObjectStore() const
152 {
153     if (m_objectStore)
154         return *m_objectStore;
155
156     ASSERT(m_index);
157     return m_index->modernObjectStore();
158 }
159
160 IDBTransaction& IDBCursor::transaction() const
161 {
162     ASSERT(currentThread() == effectiveObjectStore().modernTransaction().database().originThreadID());
163     return effectiveObjectStore().modernTransaction();
164 }
165
166 const String& IDBCursor::direction() const
167 {
168     ASSERT(currentThread() == effectiveObjectStore().modernTransaction().database().originThreadID());
169     return directionToString(m_info.cursorDirection());
170 }
171
172 RefPtr<WebCore::IDBRequest> IDBCursor::update(ExecState& exec, JSValue value, ExceptionCodeWithMessage& ec)
173 {
174     LOG(IndexedDB, "IDBCursor::update");
175     ASSERT(currentThread() == effectiveObjectStore().modernTransaction().database().originThreadID());
176
177     if (sourcesDeleted()) {
178         ec.code = IDBDatabaseException::InvalidStateError;
179         ec.message = ASCIILiteral("Failed to execute 'update' on 'IDBCursor': The cursor's source or effective object store has been deleted.");
180         return nullptr;
181     }
182
183     if (!transaction().isActive()) {
184         ec.code = IDBDatabaseException::TransactionInactiveError;
185         ec.message = ASCIILiteral("Failed to execute 'update' on 'IDBCursor': The transaction is inactive or finished.");
186         return nullptr;
187     }
188
189     if (transaction().isReadOnly()) {
190         ec.code = IDBDatabaseException::ReadOnlyError;
191         ec.message = ASCIILiteral("Failed to execute 'update' on 'IDBCursor': The record may not be updated inside a read-only transaction.");
192         return nullptr;
193     }
194
195     if (!m_gotValue) {
196         ec.code = IDBDatabaseException::InvalidStateError;
197         ec.message = ASCIILiteral("Failed to execute 'update' on 'IDBCursor': The cursor is being iterated or has iterated past its end.");
198         return nullptr;
199     }
200
201     if (!isKeyCursorWithValue()) {
202         ec.code = IDBDatabaseException::InvalidStateError;
203         ec.message = ASCIILiteral("Failed to execute 'update' on 'IDBCursor': The cursor is a key cursor.");
204         return nullptr;
205     }
206
207     auto& objectStore = effectiveObjectStore();
208     auto& keyPath = objectStore.info().keyPath();
209     const bool usesInLineKeys = !keyPath.isNull();
210     if (usesInLineKeys) {
211         RefPtr<IDBKey> keyPathKey = maybeCreateIDBKeyFromScriptValueAndKeyPath(exec, value, keyPath);
212         IDBKeyData keyPathKeyData(keyPathKey.get());
213         if (!keyPathKey || keyPathKeyData != m_currentPrimaryKeyData) {
214             ec.code = IDBDatabaseException::DataError;
215             ec.message = ASCIILiteral("Failed to execute 'update' on 'IDBCursor': The effective object store of this cursor uses in-line keys and evaluating the key path of the value parameter results in a different value than the cursor's effective key.");
216             return nullptr;
217         }
218     }
219
220     auto request = effectiveObjectStore().putForCursorUpdate(exec, value, m_currentPrimaryKey.get(), ec);
221     if (ec.code)
222         return nullptr;
223
224     ASSERT(request);
225     request->setSource(*this);
226     ++m_outstandingRequestCount;
227
228     return request;
229 }
230
231 void IDBCursor::advance(unsigned count, ExceptionCodeWithMessage& ec)
232 {
233     LOG(IndexedDB, "IDBCursor::advance");
234     ASSERT(currentThread() == effectiveObjectStore().modernTransaction().database().originThreadID());
235
236     if (!m_request) {
237         ec.code = IDBDatabaseException::InvalidStateError;
238         return;
239     }
240     
241     if (!count) {
242         ec.code = TypeError;
243         ec.message = ASCIILiteral("Failed to execute 'advance' on 'IDBCursor': A count argument with value 0 (zero) was supplied, must be greater than 0.");
244         return;
245     }
246
247     if (sourcesDeleted()) {
248         ec.code = IDBDatabaseException::InvalidStateError;
249         ec.message = ASCIILiteral("Failed to execute 'advance' on 'IDBCursor': The cursor's source or effective object store has been deleted.");
250         return;
251     }
252
253     if (!transaction().isActive()) {
254         ec.code = IDBDatabaseException::TransactionInactiveError;
255         ec.message = ASCIILiteral("Failed to execute 'advance' on 'IDBCursor': The transaction is inactive or finished.");
256         return;
257     }
258
259     if (!m_gotValue) {
260         ec.code = IDBDatabaseException::InvalidStateError;
261         ec.message = ASCIILiteral("Failed to execute 'advance' on 'IDBCursor': The cursor is being iterated or has iterated past its end.");
262         return;
263     }
264
265     m_gotValue = false;
266
267     uncheckedIterateCursor(IDBKeyData(), count);
268 }
269
270 void IDBCursor::continueFunction(ExecState& execState, JSValue keyValue, ExceptionCodeWithMessage& ec)
271 {
272     RefPtr<IDBKey> key;
273     if (!keyValue.isUndefined())
274         key = scriptValueToIDBKey(execState, keyValue);
275
276     continueFunction(key.get(), ec);
277 }
278
279 void IDBCursor::continueFunction(const IDBKeyData& key, ExceptionCodeWithMessage& ec)
280 {
281     LOG(IndexedDB, "IDBCursor::continueFunction (to key %s)", key.loggingString().utf8().data());
282     ASSERT(currentThread() == effectiveObjectStore().modernTransaction().database().originThreadID());
283
284     if (!m_request) {
285         ec.code = IDBDatabaseException::InvalidStateError;
286         return;
287     }
288
289     if (sourcesDeleted()) {
290         ec.code = IDBDatabaseException::InvalidStateError;
291         ec.message = ASCIILiteral("Failed to execute 'continue' on 'IDBCursor': The cursor's source or effective object store has been deleted.");
292         return;
293     }
294
295     if (!transaction().isActive()) {
296         ec.code = IDBDatabaseException::TransactionInactiveError;
297         ec.message = ASCIILiteral("Failed to execute 'continue' on 'IDBCursor': The transaction is inactive or finished.");
298         return;
299     }
300
301     if (!m_gotValue) {
302         ec.code = IDBDatabaseException::InvalidStateError;
303         ec.message = ASCIILiteral("Failed to execute 'continue' on 'IDBCursor': The cursor is being iterated or has iterated past its end.");
304         return;
305     }
306
307     if (!key.isNull() && !key.isValid()) {
308         ec.code = IDBDatabaseException::DataError;
309         ec.message = ASCIILiteral("Failed to execute 'continue' on 'IDBCursor': The parameter is not a valid key.");
310         return;
311     }
312
313     if (m_info.isDirectionForward()) {
314         if (!key.isNull() && key.compare(m_currentKeyData) <= 0) {
315             ec.code = IDBDatabaseException::DataError;
316             ec.message = ASCIILiteral("Failed to execute 'continue' on 'IDBCursor': The parameter is less than or equal to this cursor's position.");
317             return;
318         }
319     } else if (!key.isNull() && key.compare(m_currentKeyData) >= 0) {
320         ec.code = IDBDatabaseException::DataError;
321         ec.message = ASCIILiteral("Failed to execute 'continue' on 'IDBCursor': The parameter is greater than or equal to this cursor's position.");
322         return;
323     }
324
325     m_gotValue = false;
326
327     uncheckedIterateCursor(key, 0);
328 }
329
330 void IDBCursor::uncheckedIterateCursor(const IDBKeyData& key, unsigned count)
331 {
332     ASSERT(currentThread() == effectiveObjectStore().modernTransaction().database().originThreadID());
333
334     ++m_outstandingRequestCount;
335
336     m_request->willIterateCursor(*this);
337     transaction().iterateCursor(*this, key, count);
338 }
339
340 RefPtr<WebCore::IDBRequest> IDBCursor::deleteFunction(ExecState& execState, ExceptionCodeWithMessage& ec)
341 {
342     LOG(IndexedDB, "IDBCursor::deleteFunction");
343     ASSERT(currentThread() == effectiveObjectStore().modernTransaction().database().originThreadID());
344
345     if (sourcesDeleted()) {
346         ec.code = IDBDatabaseException::InvalidStateError;
347         ec.message = ASCIILiteral("Failed to execute 'delete' on 'IDBCursor': The cursor's source or effective object store has been deleted.");
348         return nullptr;
349     }
350
351     if (!transaction().isActive()) {
352         ec.code = IDBDatabaseException::TransactionInactiveError;
353         ec.message = ASCIILiteral("Failed to execute 'delete' on 'IDBCursor': The transaction is inactive or finished.");
354         return nullptr;
355     }
356
357     if (transaction().isReadOnly()) {
358         ec.code = IDBDatabaseException::ReadOnlyError;
359         ec.message = ASCIILiteral("Failed to execute 'delete' on 'IDBCursor': The record may not be deleted inside a read-only transaction.");
360         return nullptr;
361     }
362
363     if (!m_gotValue) {
364         ec.code = IDBDatabaseException::InvalidStateError;
365         ec.message = ASCIILiteral("Failed to execute 'delete' on 'IDBCursor': The cursor is being iterated or has iterated past its end.");
366         return nullptr;
367     }
368
369     if (!isKeyCursorWithValue()) {
370         ec.code = IDBDatabaseException::InvalidStateError;
371         ec.message = ASCIILiteral("Failed to execute 'delete' on 'IDBCursor': The cursor is a key cursor.");
372         return nullptr;
373     }
374
375     auto request = effectiveObjectStore().modernDelete(execState, m_currentPrimaryKey.get(), ec);
376     if (ec.code)
377         return nullptr;
378
379     ASSERT(request);
380     request->setSource(*this);
381     ++m_outstandingRequestCount;
382
383     return request;
384 }
385
386 void IDBCursor::setGetResult(IDBRequest& request, const IDBGetResult& getResult)
387 {
388     LOG(IndexedDB, "IDBCursor::setGetResult - current key %s", getResult.keyData().loggingString().substring(0, 100).utf8().data());
389     ASSERT(currentThread() == effectiveObjectStore().modernTransaction().database().originThreadID());
390
391     auto* context = request.scriptExecutionContext();
392     if (!context)
393         return;
394
395     auto* exec = context->execState();
396     if (!exec)
397         return;
398
399     if (!getResult.isDefined()) {
400         m_currentKey = { };
401         m_currentKeyData = { };
402         m_currentPrimaryKey = { };
403         m_currentPrimaryKeyData = { };
404         m_currentValue = { };
405
406         m_gotValue = false;
407         return;
408     }
409
410     auto& vm = context->vm();
411
412     m_currentKey = { vm, idbKeyDataToScriptValue(*exec, getResult.keyData()) };
413     m_currentKeyData = getResult.keyData();
414     m_currentPrimaryKey = { vm, idbKeyDataToScriptValue(*exec, getResult.primaryKeyData()) };
415     m_currentPrimaryKeyData = getResult.primaryKeyData();
416
417     if (isKeyCursorWithValue())
418         m_currentValue = { vm, deserializeIDBValueToJSValue(*exec, getResult.value()) };
419     else
420         m_currentValue = { };
421
422     m_gotValue = true;
423 }
424
425 const char* IDBCursor::activeDOMObjectName() const
426 {
427     return "IDBCursor";
428 }
429
430 bool IDBCursor::canSuspendForDocumentSuspension() const
431 {
432     return false;
433 }
434
435 bool IDBCursor::hasPendingActivity() const
436 {
437     return m_outstandingRequestCount;
438 }
439
440 void IDBCursor::decrementOutstandingRequestCount()
441 {
442     ASSERT(m_outstandingRequestCount);
443     --m_outstandingRequestCount;
444 }
445
446 } // namespace WebCore
447
448 #endif // ENABLE(INDEXED_DATABASE)