| /* |
| * Copyright (C) 2015 Apple Inc. All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in the |
| * documentation and/or other materials provided with the distribution. |
| * |
| * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, |
| * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
| * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS |
| * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF |
| * THE POSSIBILITY OF SUCH DAMAGE. |
| */ |
| |
| #include "config.h" |
| #include "IDBIndex.h" |
| |
| #include "IDBBindingUtilities.h" |
| #include "IDBCursor.h" |
| #include "IDBDatabase.h" |
| #include "IDBKeyRangeData.h" |
| #include "IDBObjectStore.h" |
| #include "IDBRequest.h" |
| #include "IDBTransaction.h" |
| #include "Logging.h" |
| #include <JavaScriptCore/HeapInlines.h> |
| #include <wtf/IsoMallocInlines.h> |
| |
| namespace WebCore { |
| using namespace JSC; |
| |
| WTF_MAKE_ISO_ALLOCATED_IMPL(IDBIndex); |
| |
| UniqueRef<IDBIndex> IDBIndex::create(ScriptExecutionContext& context, const IDBIndexInfo& info, IDBObjectStore& objectStore) |
| { |
| auto result = UniqueRef(*new IDBIndex(context, info, objectStore)); |
| result->suspendIfNeeded(); |
| return result; |
| } |
| |
| IDBIndex::IDBIndex(ScriptExecutionContext& context, const IDBIndexInfo& info, IDBObjectStore& objectStore) |
| : ActiveDOMObject(&context) |
| , m_info(info) |
| , m_originalInfo(info) |
| , m_objectStore(objectStore) |
| { |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| } |
| |
| IDBIndex::~IDBIndex() |
| { |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| } |
| |
| const char* IDBIndex::activeDOMObjectName() const |
| { |
| return "IDBIndex"; |
| } |
| |
| bool IDBIndex::virtualHasPendingActivity() const |
| { |
| return m_objectStore.hasPendingActivity(); |
| } |
| |
| const String& IDBIndex::name() const |
| { |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| return m_info.name(); |
| } |
| |
| ExceptionOr<void> IDBIndex::setName(const String& name) |
| { |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| |
| if (m_deleted) |
| return Exception { InvalidStateError, "Failed set property 'name' on 'IDBIndex': The index has been deleted."_s }; |
| |
| if (m_objectStore.isDeleted()) |
| return Exception { InvalidStateError, "Failed set property 'name' on 'IDBIndex': The index's object store has been deleted."_s }; |
| |
| if (!m_objectStore.transaction().isVersionChange()) |
| return Exception { InvalidStateError, "Failed set property 'name' on 'IDBIndex': The index's transaction is not a version change transaction."_s }; |
| |
| if (!m_objectStore.transaction().isActive()) |
| return Exception { TransactionInactiveError, "Failed set property 'name' on 'IDBIndex': The index's transaction is not active."_s }; |
| |
| if (m_info.name() == name) |
| return { }; |
| |
| if (m_objectStore.info().hasIndex(name)) |
| return Exception { ConstraintError, makeString("Failed set property 'name' on 'IDBIndex': The owning object store already has an index named '", name, "'.") }; |
| |
| m_objectStore.transaction().database().renameIndex(*this, name); |
| m_info.rename(name); |
| |
| return { }; |
| } |
| |
| IDBObjectStore& IDBIndex::objectStore() |
| { |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| return m_objectStore; |
| } |
| |
| const IDBKeyPath& IDBIndex::keyPath() const |
| { |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| return m_info.keyPath(); |
| } |
| |
| bool IDBIndex::unique() const |
| { |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| return m_info.unique(); |
| } |
| |
| bool IDBIndex::multiEntry() const |
| { |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| return m_info.multiEntry(); |
| } |
| |
| void IDBIndex::rollbackInfoForVersionChangeAbort() |
| { |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| |
| // Only rollback to the original info if this index still exists in the rolled-back database info. |
| auto* objectStoreInfo = m_objectStore.transaction().database().info().infoForExistingObjectStore(m_objectStore.info().identifier()); |
| if (!objectStoreInfo) |
| return; |
| |
| if (!objectStoreInfo->hasIndex(m_info.identifier())) { |
| m_deleted = true; |
| return; |
| } |
| |
| m_info = m_originalInfo; |
| m_deleted = false; |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::doOpenCursor(IDBCursorDirection direction, Function<ExceptionOr<RefPtr<IDBKeyRange>>()>&& function) |
| { |
| LOG(IndexedDB, "IDBIndex::openCursor"); |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| |
| if (m_deleted || m_objectStore.isDeleted()) |
| return Exception { InvalidStateError, "Failed to execute 'openCursor' on 'IDBIndex': The index or its object store has been deleted."_s }; |
| |
| if (!m_objectStore.transaction().isActive()) |
| return Exception { TransactionInactiveError, "Failed to execute 'openCursor' on 'IDBIndex': The transaction is inactive or finished."_s }; |
| |
| auto keyRange = function(); |
| if (keyRange.hasException()) |
| return keyRange.releaseException(); |
| |
| IDBKeyRangeData rangeData = keyRange.returnValue().get(); |
| if (rangeData.lowerKey.isNull()) |
| rangeData.lowerKey = IDBKeyData::minimum(); |
| if (rangeData.upperKey.isNull()) |
| rangeData.upperKey = IDBKeyData::maximum(); |
| |
| auto info = IDBCursorInfo::indexCursor(m_objectStore.transaction(), m_objectStore.info().identifier(), m_info.identifier(), rangeData, direction, IndexedDB::CursorType::KeyAndValue); |
| return m_objectStore.transaction().requestOpenCursor(*this, info); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::openCursor(RefPtr<IDBKeyRange>&& range, IDBCursorDirection direction) |
| { |
| return doOpenCursor(direction, [range = WTFMove(range)]() { |
| return range; |
| }); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::openCursor(JSGlobalObject& execState, JSValue key, IDBCursorDirection direction) |
| { |
| return doOpenCursor(direction, [state = &execState, key]() { |
| auto onlyResult = IDBKeyRange::only(*state, key); |
| if (onlyResult.hasException()) |
| return ExceptionOr<RefPtr<IDBKeyRange>>{ Exception(DataError, "Failed to execute 'openCursor' on 'IDBIndex': The parameter is not a valid key."_s) }; |
| |
| return ExceptionOr<RefPtr<IDBKeyRange>> { onlyResult.releaseReturnValue() }; |
| }); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::doOpenKeyCursor(IDBCursorDirection direction, Function<ExceptionOr<RefPtr<IDBKeyRange>>()>&& function) |
| { |
| LOG(IndexedDB, "IDBIndex::openKeyCursor"); |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| |
| if (m_deleted || m_objectStore.isDeleted()) |
| return Exception { InvalidStateError, "Failed to execute 'openKeyCursor' on 'IDBIndex': The index or its object store has been deleted."_s }; |
| |
| if (!m_objectStore.transaction().isActive()) |
| return Exception { TransactionInactiveError, "Failed to execute 'openKeyCursor' on 'IDBIndex': The transaction is inactive or finished."_s }; |
| |
| auto keyRange = function(); |
| if (keyRange.hasException()) |
| return keyRange.releaseException(); |
| |
| auto* keyRangePointer = keyRange.returnValue().get(); |
| auto info = IDBCursorInfo::indexCursor(m_objectStore.transaction(), m_objectStore.info().identifier(), m_info.identifier(), keyRangePointer, direction, IndexedDB::CursorType::KeyOnly); |
| return m_objectStore.transaction().requestOpenCursor(*this, info); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::openKeyCursor(RefPtr<IDBKeyRange>&& range, IDBCursorDirection direction) |
| { |
| return doOpenKeyCursor(direction, [range = WTFMove(range)]() { |
| return range; |
| }); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::openKeyCursor(JSGlobalObject& execState, JSValue key, IDBCursorDirection direction) |
| { |
| return doOpenKeyCursor(direction, [state = &execState, key]() { |
| auto onlyResult = IDBKeyRange::only(*state, key); |
| if (onlyResult.hasException()) |
| return ExceptionOr<RefPtr<IDBKeyRange>>{ Exception(DataError, "Failed to execute 'openKeyCursor' on 'IDBIndex': The parameter is not a valid key."_s) }; |
| |
| return ExceptionOr<RefPtr<IDBKeyRange>> { onlyResult.releaseReturnValue() }; |
| }); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::count(IDBKeyRange* range) |
| { |
| LOG(IndexedDB, "IDBIndex::count"); |
| |
| return doCount(range ? IDBKeyRangeData(range) : IDBKeyRangeData::allKeys()); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::count(JSGlobalObject& execState, JSValue key) |
| { |
| LOG(IndexedDB, "IDBIndex::count"); |
| |
| auto idbKey = scriptValueToIDBKey(execState, key); |
| auto* idbKeyPointer = idbKey->isValid() ? idbKey.ptr() : nullptr; |
| |
| return doCount(IDBKeyRangeData(idbKeyPointer)); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::doCount(const IDBKeyRangeData& range) |
| { |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| |
| if (m_deleted || m_objectStore.isDeleted()) |
| return Exception { InvalidStateError, "Failed to execute 'count' on 'IDBIndex': The index or its object store has been deleted."_s }; |
| |
| auto& transaction = m_objectStore.transaction(); |
| if (!transaction.isActive()) |
| return Exception { TransactionInactiveError, "Failed to execute 'count' on 'IDBIndex': The transaction is inactive or finished."_s }; |
| |
| if (!range.isValid()) |
| return Exception { DataError, "Failed to execute 'count' on 'IDBIndex': The parameter is not a valid key."_s }; |
| |
| return transaction.requestCount(*this, range); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::get(IDBKeyRange* range) |
| { |
| LOG(IndexedDB, "IDBIndex::get"); |
| |
| return doGet(IDBKeyRangeData(range)); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::get(JSGlobalObject& execState, JSValue key) |
| { |
| LOG(IndexedDB, "IDBIndex::get"); |
| |
| auto idbKey = scriptValueToIDBKey(execState, key); |
| if (!idbKey->isValid()) |
| return doGet(Exception(DataError, "Failed to execute 'get' on 'IDBIndex': The parameter is not a valid key."_s)); |
| |
| return doGet(IDBKeyRangeData(idbKey.ptr())); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::doGet(ExceptionOr<IDBKeyRangeData> range) |
| { |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| |
| if (m_deleted || m_objectStore.isDeleted()) |
| return Exception { InvalidStateError, "Failed to execute 'get' on 'IDBIndex': The index or its object store has been deleted."_s }; |
| |
| auto& transaction = m_objectStore.transaction(); |
| if (!transaction.isActive()) |
| return Exception { TransactionInactiveError, "Failed to execute 'get' on 'IDBIndex': The transaction is inactive or finished."_s }; |
| |
| if (range.hasException()) |
| return range.releaseException(); |
| auto keyRange = range.releaseReturnValue(); |
| |
| if (keyRange.isNull) |
| return Exception { DataError }; |
| |
| return transaction.requestGetValue(*this, keyRange); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::getKey(IDBKeyRange* range) |
| { |
| LOG(IndexedDB, "IDBIndex::getKey"); |
| |
| return doGetKey(IDBKeyRangeData(range)); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::getKey(JSGlobalObject& execState, JSValue key) |
| { |
| LOG(IndexedDB, "IDBIndex::getKey"); |
| |
| auto idbKey = scriptValueToIDBKey(execState, key); |
| if (!idbKey->isValid()) |
| return doGetKey(Exception(DataError, "Failed to execute 'getKey' on 'IDBIndex': The parameter is not a valid key."_s)); |
| |
| return doGetKey(IDBKeyRangeData(idbKey.ptr())); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::doGetKey(ExceptionOr<IDBKeyRangeData> range) |
| { |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| |
| if (m_deleted || m_objectStore.isDeleted()) |
| return Exception { InvalidStateError, "Failed to execute 'getKey' on 'IDBIndex': The index or its object store has been deleted."_s }; |
| |
| auto& transaction = m_objectStore.transaction(); |
| if (!transaction.isActive()) |
| return Exception { TransactionInactiveError, "Failed to execute 'getKey' on 'IDBIndex': The transaction is inactive or finished."_s }; |
| |
| if (range.hasException()) |
| return range.releaseException(); |
| auto keyRange = range.releaseReturnValue(); |
| |
| if (keyRange.isNull) |
| return Exception { DataError }; |
| |
| return transaction.requestGetKey(*this, keyRange); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::doGetAll(std::optional<uint32_t> count, Function<ExceptionOr<RefPtr<IDBKeyRange>>()>&& function) |
| { |
| LOG(IndexedDB, "IDBIndex::getAll"); |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| |
| if (m_deleted || m_objectStore.isDeleted()) |
| return Exception { InvalidStateError, "Failed to execute 'getAll' on 'IDBIndex': The index or its object store has been deleted."_s }; |
| |
| if (!m_objectStore.transaction().isActive()) |
| return Exception { TransactionInactiveError, "Failed to execute 'getAll' on 'IDBIndex': The transaction is inactive or finished."_s }; |
| |
| auto keyRange = function(); |
| if (keyRange.hasException()) |
| return keyRange.releaseException(); |
| |
| auto keyRangePointer = keyRange.returnValue().get(); |
| return m_objectStore.transaction().requestGetAllIndexRecords(*this, keyRangePointer, IndexedDB::GetAllType::Values, count); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::getAll(RefPtr<IDBKeyRange>&& range, std::optional<uint32_t> count) |
| { |
| return doGetAll(count, [range = WTFMove(range)]() { |
| return range; |
| }); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::getAll(JSGlobalObject& execState, JSValue key, std::optional<uint32_t> count) |
| { |
| return doGetAll(count, [state = &execState, key]() { |
| auto onlyResult = IDBKeyRange::only(*state, key); |
| if (onlyResult.hasException()) |
| return ExceptionOr<RefPtr<IDBKeyRange>>{ Exception(DataError, "Failed to execute 'getAll' on 'IDBIndex': The parameter is not a valid key."_s) }; |
| |
| return ExceptionOr<RefPtr<IDBKeyRange>> { onlyResult.releaseReturnValue() }; |
| }); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::doGetAllKeys(std::optional<uint32_t> count, Function<ExceptionOr<RefPtr<IDBKeyRange>>()>&& function) |
| { |
| LOG(IndexedDB, "IDBIndex::getAllKeys"); |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| |
| if (m_deleted || m_objectStore.isDeleted()) |
| return Exception { InvalidStateError, "Failed to execute 'getAllKeys' on 'IDBIndex': The index or its object store has been deleted."_s }; |
| |
| if (!m_objectStore.transaction().isActive()) |
| return Exception { TransactionInactiveError, "Failed to execute 'getAllKeys' on 'IDBIndex': The transaction is inactive or finished."_s }; |
| |
| auto keyRange = function(); |
| if (keyRange.hasException()) |
| return keyRange.releaseException(); |
| |
| auto* keyRangePointer = keyRange.returnValue().get(); |
| return m_objectStore.transaction().requestGetAllIndexRecords(*this, keyRangePointer, IndexedDB::GetAllType::Keys, count); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::getAllKeys(RefPtr<IDBKeyRange>&& range, std::optional<uint32_t> count) |
| { |
| return doGetAllKeys(count, [range = WTFMove(range)]() { |
| return range; |
| }); |
| } |
| |
| ExceptionOr<Ref<IDBRequest>> IDBIndex::getAllKeys(JSGlobalObject& execState, JSValue key, std::optional<uint32_t> count) |
| { |
| return doGetAllKeys(count, [state = &execState, key]() { |
| auto onlyResult = IDBKeyRange::only(*state, key); |
| if (onlyResult.hasException()) |
| return ExceptionOr<RefPtr<IDBKeyRange>>{ Exception(DataError, "Failed to execute 'getAllKeys' on 'IDBIndex': The parameter is not a valid key."_s) }; |
| |
| return ExceptionOr<RefPtr<IDBKeyRange>> { onlyResult.releaseReturnValue() }; |
| }); |
| } |
| |
| void IDBIndex::markAsDeleted() |
| { |
| ASSERT(canCurrentThreadAccessThreadLocalData(m_objectStore.transaction().database().originThread())); |
| |
| ASSERT(!m_deleted); |
| m_deleted = true; |
| } |
| |
| void IDBIndex::ref() |
| { |
| m_objectStore.ref(); |
| } |
| |
| void IDBIndex::deref() |
| { |
| m_objectStore.deref(); |
| } |
| |
| } // namespace WebCore |