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