/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* vim: set ts=8 sts=2 et sw=2 tw=80: */ /* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ #include "IDBObjectStore.h" #include "FileInfo.h" #include "IDBCursor.h" #include "IDBDatabase.h" #include "IDBEvents.h" #include "IDBFactory.h" #include "IDBIndex.h" #include "IDBKeyRange.h" #include "IDBMutableFile.h" #include "IDBRequest.h" #include "IDBTransaction.h" #include "IndexedDatabase.h" #include "IndexedDatabaseInlines.h" #include "IndexedDatabaseManager.h" #include "js/Class.h" #include "js/Date.h" #include "js/StructuredClone.h" #include "KeyPath.h" #include "mozilla/Endian.h" #include "mozilla/ErrorResult.h" #include "mozilla/Move.h" #include "mozilla/dom/BindingUtils.h" #include "mozilla/dom/ContentChild.h" #include "mozilla/dom/ContentParent.h" #include "mozilla/dom/DOMStringList.h" #include "mozilla/dom/File.h" #include "mozilla/dom/IDBMutableFileBinding.h" #include "mozilla/dom/BlobBinding.h" #include "mozilla/dom/IDBObjectStoreBinding.h" #include "mozilla/dom/StructuredCloneTags.h" #include "mozilla/dom/indexedDB/PBackgroundIDBSharedTypes.h" #include "mozilla/dom/ipc/BlobChild.h" #include "mozilla/dom/ipc/BlobParent.h" #include "mozilla/dom/ipc/nsIRemoteBlob.h" #include "mozilla/ipc/BackgroundChild.h" #include "mozilla/ipc/PBackgroundSharedTypes.h" #include "nsCOMPtr.h" #include "nsQueryObject.h" #include "ProfilerHelpers.h" #include "ReportInternalError.h" #include "WorkerPrivate.h" #include "WorkerScope.h" // Include this last to avoid path problems on Windows. #include "ActorsChild.h" namespace mozilla { namespace dom { namespace indexedDB { using namespace mozilla::dom::quota; using namespace mozilla::dom::workers; using namespace mozilla::ipc; struct IDBObjectStore::StructuredCloneWriteInfo { struct BlobOrFileInfo { nsRefPtr mBlob; nsRefPtr mFileInfo; bool operator==(const BlobOrFileInfo& aOther) const { return this->mBlob == aOther.mBlob && this->mFileInfo == aOther.mFileInfo; } }; JSAutoStructuredCloneBuffer mCloneBuffer; nsTArray mBlobOrFileInfos; IDBDatabase* mDatabase; uint64_t mOffsetToKeyProp; explicit StructuredCloneWriteInfo(IDBDatabase* aDatabase) : mDatabase(aDatabase) , mOffsetToKeyProp(0) { MOZ_ASSERT(aDatabase); MOZ_COUNT_CTOR(StructuredCloneWriteInfo); } StructuredCloneWriteInfo(StructuredCloneWriteInfo&& aCloneWriteInfo) : mCloneBuffer(Move(aCloneWriteInfo.mCloneBuffer)) , mDatabase(aCloneWriteInfo.mDatabase) , mOffsetToKeyProp(aCloneWriteInfo.mOffsetToKeyProp) { MOZ_ASSERT(mDatabase); MOZ_COUNT_CTOR(StructuredCloneWriteInfo); mBlobOrFileInfos.SwapElements(aCloneWriteInfo.mBlobOrFileInfos); aCloneWriteInfo.mOffsetToKeyProp = 0; } ~StructuredCloneWriteInfo() { MOZ_COUNT_DTOR(StructuredCloneWriteInfo); } bool operator==(const StructuredCloneWriteInfo& aOther) const { return this->mCloneBuffer.nbytes() == aOther.mCloneBuffer.nbytes() && this->mCloneBuffer.data() == aOther.mCloneBuffer.data() && this->mBlobOrFileInfos == aOther.mBlobOrFileInfos && this->mDatabase == aOther.mDatabase && this->mOffsetToKeyProp == aOther.mOffsetToKeyProp; } bool SetFromSerialized(const SerializedStructuredCloneWriteInfo& aOther) { if (aOther.data().IsEmpty()) { mCloneBuffer.clear(); } else { auto* aOtherBuffer = reinterpret_cast( const_cast(aOther.data().Elements())); if (!mCloneBuffer.copy(aOtherBuffer, aOther.data().Length())) { return false; } } mBlobOrFileInfos.Clear(); mOffsetToKeyProp = aOther.offsetToKeyProp(); return true; } }; namespace { struct MOZ_STACK_CLASS MutableFileData final { nsString type; nsString name; MutableFileData() { MOZ_COUNT_CTOR(MutableFileData); } ~MutableFileData() { MOZ_COUNT_DTOR(MutableFileData); } }; struct MOZ_STACK_CLASS BlobOrFileData final { uint32_t tag; uint64_t size; nsString type; nsString name; int64_t lastModifiedDate; BlobOrFileData() : tag(0) , size(0) , lastModifiedDate(INT64_MAX) { MOZ_COUNT_CTOR(BlobOrFileData); } ~BlobOrFileData() { MOZ_COUNT_DTOR(BlobOrFileData); } }; struct MOZ_STACK_CLASS GetAddInfoClosure final { IDBObjectStore::StructuredCloneWriteInfo& mCloneWriteInfo; JS::Handle mValue; GetAddInfoClosure(IDBObjectStore::StructuredCloneWriteInfo& aCloneWriteInfo, JS::Handle aValue) : mCloneWriteInfo(aCloneWriteInfo) , mValue(aValue) { MOZ_COUNT_CTOR(GetAddInfoClosure); } ~GetAddInfoClosure() { MOZ_COUNT_DTOR(GetAddInfoClosure); } }; already_AddRefed GenerateRequest(IDBObjectStore* aObjectStore) { MOZ_ASSERT(aObjectStore); aObjectStore->AssertIsOnOwningThread(); IDBTransaction* transaction = aObjectStore->Transaction(); nsRefPtr request = IDBRequest::Create(aObjectStore, transaction->Database(), transaction); MOZ_ASSERT(request); return request.forget(); } bool StructuredCloneWriteCallback(JSContext* aCx, JSStructuredCloneWriter* aWriter, JS::Handle aObj, void* aClosure) { MOZ_ASSERT(aCx); MOZ_ASSERT(aWriter); MOZ_ASSERT(aClosure); auto* cloneWriteInfo = static_cast(aClosure); if (JS_GetClass(aObj) == IDBObjectStore::DummyPropClass()) { MOZ_ASSERT(!cloneWriteInfo->mOffsetToKeyProp); cloneWriteInfo->mOffsetToKeyProp = js::GetSCOffset(aWriter); uint64_t value = 0; // Omit endian swap return JS_WriteBytes(aWriter, &value, sizeof(value)); } IDBMutableFile* mutableFile; if (NS_SUCCEEDED(UNWRAP_OBJECT(IDBMutableFile, aObj, mutableFile))) { IDBDatabase* database = mutableFile->Database(); MOZ_ASSERT(database); // Throw when trying to store IDBMutableFile objects that live in a // different database. if (database != cloneWriteInfo->mDatabase) { MOZ_ASSERT(!SameCOMIdentity(database, cloneWriteInfo->mDatabase)); if (database->Name() != cloneWriteInfo->mDatabase->Name()) { return false; } nsCString fileOrigin, databaseOrigin; PersistenceType filePersistenceType, databasePersistenceType; if (NS_WARN_IF(NS_FAILED(database->GetQuotaInfo(fileOrigin, &filePersistenceType)))) { return false; } if (NS_WARN_IF(NS_FAILED(cloneWriteInfo->mDatabase->GetQuotaInfo( databaseOrigin, &databasePersistenceType)))) { return false; } if (filePersistenceType != databasePersistenceType || fileOrigin != databaseOrigin) { return false; } } nsRefPtr fileInfo = mutableFile->GetFileInfo(); MOZ_ASSERT(fileInfo); if (cloneWriteInfo->mBlobOrFileInfos.Length() > size_t(UINT32_MAX)) { MOZ_ASSERT(false, "Fix the structured clone data to use a bigger type!"); return false; } const uint32_t index = uint32_t(cloneWriteInfo->mBlobOrFileInfos.Length()); NS_ConvertUTF16toUTF8 convType(mutableFile->Type()); uint32_t convTypeLength = NativeEndian::swapToLittleEndian(convType.Length()); NS_ConvertUTF16toUTF8 convName(mutableFile->Name()); uint32_t convNameLength = NativeEndian::swapToLittleEndian(convName.Length()); if (!JS_WriteUint32Pair(aWriter, SCTAG_DOM_MUTABLEFILE, uint32_t(index)) || !JS_WriteBytes(aWriter, &convTypeLength, sizeof(uint32_t)) || !JS_WriteBytes(aWriter, convType.get(), convType.Length()) || !JS_WriteBytes(aWriter, &convNameLength, sizeof(uint32_t)) || !JS_WriteBytes(aWriter, convName.get(), convName.Length())) { return false; } IDBObjectStore::StructuredCloneWriteInfo::BlobOrFileInfo* newBlobOrFileInfo = cloneWriteInfo->mBlobOrFileInfos.AppendElement(); newBlobOrFileInfo->mFileInfo.swap(fileInfo); return true; } { Blob* blob = nullptr; if (NS_SUCCEEDED(UNWRAP_OBJECT(Blob, aObj, blob))) { ErrorResult rv; uint64_t size = blob->GetSize(rv); MOZ_ASSERT(!rv.Failed()); size = NativeEndian::swapToLittleEndian(size); nsString type; blob->GetType(type); NS_ConvertUTF16toUTF8 convType(type); uint32_t convTypeLength = NativeEndian::swapToLittleEndian(convType.Length()); if (cloneWriteInfo->mBlobOrFileInfos.Length() > size_t(UINT32_MAX)) { MOZ_ASSERT(false, "Fix the structured clone data to use a bigger type!"); return false; } const uint32_t index = uint32_t(cloneWriteInfo->mBlobOrFileInfos.Length()); if (!JS_WriteUint32Pair(aWriter, blob->IsFile() ? SCTAG_DOM_FILE : SCTAG_DOM_BLOB, index) || !JS_WriteBytes(aWriter, &size, sizeof(size)) || !JS_WriteBytes(aWriter, &convTypeLength, sizeof(convTypeLength)) || !JS_WriteBytes(aWriter, convType.get(), convType.Length())) { return false; } nsRefPtr file = blob->ToFile(); if (file) { ErrorResult rv; int64_t lastModifiedDate = file->GetLastModified(rv); MOZ_ALWAYS_TRUE(!rv.Failed()); lastModifiedDate = NativeEndian::swapToLittleEndian(lastModifiedDate); nsString name; file->GetName(name); NS_ConvertUTF16toUTF8 convName(name); uint32_t convNameLength = NativeEndian::swapToLittleEndian(convName.Length()); if (!JS_WriteBytes(aWriter, &lastModifiedDate, sizeof(lastModifiedDate)) || !JS_WriteBytes(aWriter, &convNameLength, sizeof(convNameLength)) || !JS_WriteBytes(aWriter, convName.get(), convName.Length())) { return false; } } IDBObjectStore::StructuredCloneWriteInfo::BlobOrFileInfo* newBlobOrFileInfo = cloneWriteInfo->mBlobOrFileInfos.AppendElement(); newBlobOrFileInfo->mBlob = blob; return true; } } // Try using the runtime callbacks const JSStructuredCloneCallbacks* runtimeCallbacks = js::GetContextStructuredCloneCallbacks(aCx); if (runtimeCallbacks) { return runtimeCallbacks->write(aCx, aWriter, aObj, nullptr); } return false; } nsresult GetAddInfoCallback(JSContext* aCx, void* aClosure) { static const JSStructuredCloneCallbacks kStructuredCloneCallbacks = { nullptr /* read */, StructuredCloneWriteCallback /* write */, nullptr /* reportError */, nullptr /* readTransfer */, nullptr /* writeTransfer */, nullptr /* freeTransfer */ }; MOZ_ASSERT(aCx); auto* data = static_cast(aClosure); MOZ_ASSERT(data); data->mCloneWriteInfo.mOffsetToKeyProp = 0; if (!data->mCloneWriteInfo.mCloneBuffer.write(aCx, data->mValue, &kStructuredCloneCallbacks, &data->mCloneWriteInfo)) { return NS_ERROR_DOM_DATA_CLONE_ERR; } return NS_OK; } BlobChild* ActorFromRemoteBlobImpl(BlobImpl* aImpl) { MOZ_ASSERT(aImpl); nsCOMPtr remoteBlob = do_QueryInterface(aImpl); if (remoteBlob) { BlobChild* actor = remoteBlob->GetBlobChild(); MOZ_ASSERT(actor); if (actor->GetContentManager()) { return nullptr; } MOZ_ASSERT(actor->GetBackgroundManager()); MOZ_ASSERT(BackgroundChild::GetForCurrentThread()); MOZ_ASSERT(actor->GetBackgroundManager() == BackgroundChild::GetForCurrentThread(), "Blob actor is not bound to this thread!"); return actor; } return nullptr; } bool ResolveMysteryFile(BlobImpl* aImpl, const nsString& aName, const nsString& aContentType, uint64_t aSize, uint64_t aLastModifiedDate) { BlobChild* actor = ActorFromRemoteBlobImpl(aImpl); if (actor) { return actor->SetMysteryBlobInfo(aName, aContentType, aSize, aLastModifiedDate, BlobDirState::eUnknownIfDir); } return true; } bool ResolveMysteryBlob(BlobImpl* aImpl, const nsString& aContentType, uint64_t aSize) { BlobChild* actor = ActorFromRemoteBlobImpl(aImpl); if (actor) { return actor->SetMysteryBlobInfo(aContentType, aSize); } return true; } bool StructuredCloneReadString(JSStructuredCloneReader* aReader, nsCString& aString) { uint32_t length; if (!JS_ReadBytes(aReader, &length, sizeof(uint32_t))) { NS_WARNING("Failed to read length!"); return false; } length = NativeEndian::swapFromLittleEndian(length); if (!aString.SetLength(length, fallible)) { NS_WARNING("Out of memory?"); return false; } char* buffer = aString.BeginWriting(); if (!JS_ReadBytes(aReader, buffer, length)) { NS_WARNING("Failed to read type!"); return false; } return true; } bool ReadFileHandle(JSStructuredCloneReader* aReader, MutableFileData* aRetval) { static_assert(SCTAG_DOM_MUTABLEFILE == 0xFFFF8004, "Update me!"); MOZ_ASSERT(aReader && aRetval); nsCString type; if (!StructuredCloneReadString(aReader, type)) { return false; } CopyUTF8toUTF16(type, aRetval->type); nsCString name; if (!StructuredCloneReadString(aReader, name)) { return false; } CopyUTF8toUTF16(name, aRetval->name); return true; } bool ReadBlobOrFile(JSStructuredCloneReader* aReader, uint32_t aTag, BlobOrFileData* aRetval) { static_assert(SCTAG_DOM_BLOB == 0xffff8001 && SCTAG_DOM_FILE_WITHOUT_LASTMODIFIEDDATE == 0xffff8002 && SCTAG_DOM_FILE == 0xffff8005, "Update me!"); MOZ_ASSERT(aReader); MOZ_ASSERT(aTag == SCTAG_DOM_FILE || aTag == SCTAG_DOM_FILE_WITHOUT_LASTMODIFIEDDATE || aTag == SCTAG_DOM_BLOB); MOZ_ASSERT(aRetval); aRetval->tag = aTag; uint64_t size; if (NS_WARN_IF(!JS_ReadBytes(aReader, &size, sizeof(uint64_t)))) { return false; } aRetval->size = NativeEndian::swapFromLittleEndian(size); nsCString type; if (NS_WARN_IF(!StructuredCloneReadString(aReader, type))) { return false; } CopyUTF8toUTF16(type, aRetval->type); // Blobs are done. if (aTag == SCTAG_DOM_BLOB) { return true; } MOZ_ASSERT(aTag == SCTAG_DOM_FILE || aTag == SCTAG_DOM_FILE_WITHOUT_LASTMODIFIEDDATE); int64_t lastModifiedDate; if (aTag == SCTAG_DOM_FILE_WITHOUT_LASTMODIFIEDDATE) { lastModifiedDate = INT64_MAX; } else { if (NS_WARN_IF(!JS_ReadBytes(aReader, &lastModifiedDate, sizeof(lastModifiedDate)))) { return false; } lastModifiedDate = NativeEndian::swapFromLittleEndian(lastModifiedDate); } aRetval->lastModifiedDate = lastModifiedDate; nsCString name; if (NS_WARN_IF(!StructuredCloneReadString(aReader, name))) { return false; } CopyUTF8toUTF16(name, aRetval->name); return true; } class ValueDeserializationHelper { public: static bool CreateAndWrapMutableFile(JSContext* aCx, IDBDatabase* aDatabase, StructuredCloneFile& aFile, const MutableFileData& aData, JS::MutableHandle aResult) { MOZ_ASSERT(aDatabase); MOZ_ASSERT(aFile.mFileInfo); if (!IndexedDatabaseManager::IsMainProcess() || !NS_IsMainThread()) { return false; } nsRefPtr mutableFile = IDBMutableFile::Create(aDatabase, aData.name, aData.type, aFile.mFileInfo.forget()); MOZ_ASSERT(mutableFile); JS::Rooted result(aCx, mutableFile->WrapObject(aCx, nullptr)); if (NS_WARN_IF(!result)) { return false; } aResult.set(result); return true; } static bool CreateAndWrapBlobOrFile(JSContext* aCx, IDBDatabase* aDatabase, StructuredCloneFile& aFile, const BlobOrFileData& aData, JS::MutableHandle aResult) { MOZ_ASSERT(aData.tag == SCTAG_DOM_FILE || aData.tag == SCTAG_DOM_FILE_WITHOUT_LASTMODIFIEDDATE || aData.tag == SCTAG_DOM_BLOB); MOZ_ASSERT(aFile.mBlob); // It can happen that this IDB is chrome code, so there is no parent, but // still we want to set a correct parent for the new File object. nsCOMPtr parent; if (NS_IsMainThread()) { if (aDatabase && aDatabase->GetParentObject()) { parent = aDatabase->GetParentObject(); } else { parent = xpc::NativeGlobal(JS::CurrentGlobalOrNull(aCx)); } } else { WorkerPrivate* workerPrivate = GetCurrentThreadWorkerPrivate(); MOZ_ASSERT(workerPrivate); WorkerGlobalScope* globalScope = workerPrivate->GlobalScope(); MOZ_ASSERT(globalScope); parent = do_QueryObject(globalScope); } MOZ_ASSERT(parent); if (aData.tag == SCTAG_DOM_BLOB) { if (NS_WARN_IF(!ResolveMysteryBlob(aFile.mBlob->Impl(), aData.type, aData.size))) { return false; } MOZ_ASSERT(!aFile.mBlob->IsFile()); JS::Rooted wrappedBlob(aCx); if (!ToJSValue(aCx, aFile.mBlob, &wrappedBlob)) { return false; } aResult.set(&wrappedBlob.toObject()); return true; } if (NS_WARN_IF(!ResolveMysteryFile(aFile.mBlob->Impl(), aData.name, aData.type, aData.size, aData.lastModifiedDate))) { return false; } MOZ_ASSERT(aFile.mBlob->IsFile()); nsRefPtr file = aFile.mBlob->ToFile(); MOZ_ASSERT(file); JS::Rooted wrappedFile(aCx); if (!ToJSValue(aCx, file, &wrappedFile)) { return false; } aResult.set(&wrappedFile.toObject()); return true; } }; class IndexDeserializationHelper { public: static bool CreateAndWrapMutableFile(JSContext* aCx, IDBDatabase* aDatabase, StructuredCloneFile& aFile, const MutableFileData& aData, JS::MutableHandle aResult) { MOZ_ASSERT(!aDatabase); // MutableFile can't be used in index creation, so just make a dummy object. JS::Rooted obj(aCx, JS_NewPlainObject(aCx)); if (NS_WARN_IF(!obj)) { return false; } aResult.set(obj); return true; } static bool CreateAndWrapBlobOrFile(JSContext* aCx, IDBDatabase* aDatabase, StructuredCloneFile& aFile, const BlobOrFileData& aData, JS::MutableHandle aResult) { MOZ_ASSERT(aData.tag == SCTAG_DOM_FILE || aData.tag == SCTAG_DOM_FILE_WITHOUT_LASTMODIFIEDDATE || aData.tag == SCTAG_DOM_BLOB); // The following properties are available for use in index creation // Blob.size // Blob.type // File.name // File.lastModifiedDate JS::Rooted obj(aCx, JS_NewPlainObject(aCx)); if (NS_WARN_IF(!obj)) { return false; } // Technically these props go on the proto, but this detail won't change // the results of index creation. JS::Rooted type(aCx, JS_NewUCStringCopyN(aCx, aData.type.get(), aData.type.Length())); if (NS_WARN_IF(!type)) { return false; } if (NS_WARN_IF(!JS_DefineProperty(aCx, obj, "size", double(aData.size), 0))) { return false; } if (NS_WARN_IF(!JS_DefineProperty(aCx, obj, "type", type, 0))) { return false; } if (aData.tag == SCTAG_DOM_BLOB) { aResult.set(obj); return true; } JS::Rooted name(aCx, JS_NewUCStringCopyN(aCx, aData.name.get(), aData.name.Length())); if (NS_WARN_IF(!name)) { return false; } JS::ClippedTime time = JS::TimeClip(aData.lastModifiedDate); JS::Rooted date(aCx, JS::NewDateObject(aCx, time)); if (NS_WARN_IF(!date)) { return false; } if (NS_WARN_IF(!JS_DefineProperty(aCx, obj, "name", name, 0))) { return false; } if (NS_WARN_IF(!JS_DefineProperty(aCx, obj, "lastModifiedDate", date, 0))) { return false; } aResult.set(obj); return true; } }; template JSObject* CommonStructuredCloneReadCallback(JSContext* aCx, JSStructuredCloneReader* aReader, uint32_t aTag, uint32_t aData, void* aClosure) { // We need to statically assert that our tag values are what we expect // so that if people accidentally change them they notice. static_assert(SCTAG_DOM_BLOB == 0xffff8001 && SCTAG_DOM_FILE_WITHOUT_LASTMODIFIEDDATE == 0xffff8002 && SCTAG_DOM_MUTABLEFILE == 0xffff8004 && SCTAG_DOM_FILE == 0xffff8005, "You changed our structured clone tag values and just ate " "everyone's IndexedDB data. I hope you are happy."); if (aTag == SCTAG_DOM_FILE_WITHOUT_LASTMODIFIEDDATE || aTag == SCTAG_DOM_BLOB || aTag == SCTAG_DOM_FILE || aTag == SCTAG_DOM_MUTABLEFILE) { auto* cloneReadInfo = static_cast(aClosure); if (aData >= cloneReadInfo->mFiles.Length()) { MOZ_ASSERT(false, "Bad index value!"); return nullptr; } StructuredCloneFile& file = cloneReadInfo->mFiles[aData]; JS::Rooted result(aCx); if (aTag == SCTAG_DOM_MUTABLEFILE) { MutableFileData data; if (NS_WARN_IF(!ReadFileHandle(aReader, &data))) { return nullptr; } if (NS_WARN_IF(!Traits::CreateAndWrapMutableFile(aCx, cloneReadInfo->mDatabase, file, data, &result))) { return nullptr; } return result; } BlobOrFileData data; if (NS_WARN_IF(!ReadBlobOrFile(aReader, aTag, &data))) { return nullptr; } if (NS_WARN_IF(!Traits::CreateAndWrapBlobOrFile(aCx, cloneReadInfo->mDatabase, file, data, &result))) { return nullptr; } return result; } const JSStructuredCloneCallbacks* runtimeCallbacks = js::GetContextStructuredCloneCallbacks(aCx); if (runtimeCallbacks) { return runtimeCallbacks->read(aCx, aReader, aTag, aData, nullptr); } return nullptr; } // static void ClearStructuredCloneBuffer(JSAutoStructuredCloneBuffer& aBuffer) { if (aBuffer.data()) { aBuffer.clear(); } } } // namespace const JSClass IDBObjectStore::sDummyPropJSClass = { "IDBObjectStore Dummy", 0 /* flags */ }; IDBObjectStore::IDBObjectStore(IDBTransaction* aTransaction, const ObjectStoreSpec* aSpec) : mTransaction(aTransaction) , mCachedKeyPath(JS::UndefinedValue()) , mSpec(aSpec) , mId(aSpec->metadata().id()) , mRooted(false) { MOZ_ASSERT(aTransaction); aTransaction->AssertIsOnOwningThread(); MOZ_ASSERT(aSpec); } IDBObjectStore::~IDBObjectStore() { AssertIsOnOwningThread(); if (mRooted) { mCachedKeyPath.setUndefined(); mozilla::DropJSObjects(this); } } // static already_AddRefed IDBObjectStore::Create(IDBTransaction* aTransaction, const ObjectStoreSpec& aSpec) { MOZ_ASSERT(aTransaction); aTransaction->AssertIsOnOwningThread(); nsRefPtr objectStore = new IDBObjectStore(aTransaction, &aSpec); return objectStore.forget(); } // static nsresult IDBObjectStore::AppendIndexUpdateInfo( int64_t aIndexID, const KeyPath& aKeyPath, bool aUnique, bool aMultiEntry, JSContext* aCx, JS::Handle aVal, nsTArray& aUpdateInfoArray) { nsresult rv; if (!aMultiEntry) { Key key; rv = aKeyPath.ExtractKey(aCx, aVal, key); // If an index's keyPath doesn't match an object, we ignore that object. if (rv == NS_ERROR_DOM_INDEXEDDB_DATA_ERR || key.IsUnset()) { return NS_OK; } if (NS_FAILED(rv)) { return rv; } IndexUpdateInfo* updateInfo = aUpdateInfoArray.AppendElement(); updateInfo->indexId() = aIndexID; updateInfo->value() = key; return NS_OK; } JS::Rooted val(aCx); if (NS_FAILED(aKeyPath.ExtractKeyAsJSVal(aCx, aVal, val.address()))) { return NS_OK; } if (JS_IsArrayObject(aCx, val)) { JS::Rooted array(aCx, &val.toObject()); uint32_t arrayLength; if (NS_WARN_IF(!JS_GetArrayLength(aCx, array, &arrayLength))) { IDB_REPORT_INTERNAL_ERR(); return NS_ERROR_DOM_INDEXEDDB_UNKNOWN_ERR; } for (uint32_t arrayIndex = 0; arrayIndex < arrayLength; arrayIndex++) { JS::Rooted arrayItem(aCx); if (NS_WARN_IF(!JS_GetElement(aCx, array, arrayIndex, &arrayItem))) { IDB_REPORT_INTERNAL_ERR(); return NS_ERROR_DOM_INDEXEDDB_UNKNOWN_ERR; } Key value; if (NS_FAILED(value.SetFromJSVal(aCx, arrayItem)) || value.IsUnset()) { // Not a value we can do anything with, ignore it. continue; } IndexUpdateInfo* updateInfo = aUpdateInfoArray.AppendElement(); updateInfo->indexId() = aIndexID; updateInfo->value() = value; } } else { Key value; if (NS_FAILED(value.SetFromJSVal(aCx, val)) || value.IsUnset()) { // Not a value we can do anything with, ignore it. return NS_OK; } IndexUpdateInfo* updateInfo = aUpdateInfoArray.AppendElement(); updateInfo->indexId() = aIndexID; updateInfo->value() = value; } return NS_OK; } // static void IDBObjectStore::ClearCloneReadInfo(StructuredCloneReadInfo& aReadInfo) { // This is kind of tricky, we only want to release stuff on the main thread, // but we can end up being called on other threads if we have already been // cleared on the main thread. if (!aReadInfo.mCloneBuffer.data() && !aReadInfo.mFiles.Length()) { return; } ClearStructuredCloneBuffer(aReadInfo.mCloneBuffer); aReadInfo.mFiles.Clear(); } // static bool IDBObjectStore::DeserializeValue(JSContext* aCx, StructuredCloneReadInfo& aCloneReadInfo, JS::MutableHandle aValue) { MOZ_ASSERT(aCx); if (aCloneReadInfo.mData.IsEmpty()) { aValue.setUndefined(); return true; } auto* data = reinterpret_cast(aCloneReadInfo.mData.Elements()); size_t dataLen = aCloneReadInfo.mData.Length(); MOZ_ASSERT(!(dataLen % sizeof(*data))); JSAutoRequest ar(aCx); static const JSStructuredCloneCallbacks callbacks = { CommonStructuredCloneReadCallback, nullptr, nullptr, nullptr, nullptr, nullptr }; if (!JS_ReadStructuredClone(aCx, data, dataLen, JS_STRUCTURED_CLONE_VERSION, aValue, &callbacks, &aCloneReadInfo)) { return false; } return true; } // static bool IDBObjectStore::DeserializeIndexValue(JSContext* aCx, StructuredCloneReadInfo& aCloneReadInfo, JS::MutableHandle aValue) { MOZ_ASSERT(!NS_IsMainThread()); MOZ_ASSERT(aCx); if (aCloneReadInfo.mData.IsEmpty()) { aValue.setUndefined(); return true; } size_t dataLen = aCloneReadInfo.mData.Length(); uint64_t* data = const_cast(reinterpret_cast( aCloneReadInfo.mData.Elements())); MOZ_ASSERT(!(dataLen % sizeof(*data))); JSAutoRequest ar(aCx); static const JSStructuredCloneCallbacks callbacks = { CommonStructuredCloneReadCallback, nullptr, nullptr }; if (!JS_ReadStructuredClone(aCx, data, dataLen, JS_STRUCTURED_CLONE_VERSION, aValue, &callbacks, &aCloneReadInfo)) { return false; } return true; } #ifdef DEBUG void IDBObjectStore::AssertIsOnOwningThread() const { MOZ_ASSERT(mTransaction); mTransaction->AssertIsOnOwningThread(); } #endif // DEBUG nsresult IDBObjectStore::GetAddInfo(JSContext* aCx, JS::Handle aValue, JS::Handle aKeyVal, StructuredCloneWriteInfo& aCloneWriteInfo, Key& aKey, nsTArray& aUpdateInfoArray) { // Return DATA_ERR if a key was passed in and this objectStore uses inline // keys. if (!aKeyVal.isUndefined() && HasValidKeyPath()) { return NS_ERROR_DOM_INDEXEDDB_DATA_ERR; } bool isAutoIncrement = AutoIncrement(); nsresult rv; if (!HasValidKeyPath()) { // Out-of-line keys must be passed in. rv = aKey.SetFromJSVal(aCx, aKeyVal); if (NS_FAILED(rv)) { return rv; } } else if (!isAutoIncrement) { rv = GetKeyPath().ExtractKey(aCx, aValue, aKey); if (NS_FAILED(rv)) { return rv; } } // Return DATA_ERR if no key was specified this isn't an autoIncrement // objectStore. if (aKey.IsUnset() && !isAutoIncrement) { return NS_ERROR_DOM_INDEXEDDB_DATA_ERR; } // Figure out indexes and the index values to update here. const nsTArray& indexes = mSpec->indexes(); const uint32_t idxCount = indexes.Length(); aUpdateInfoArray.SetCapacity(idxCount); // Pretty good estimate for (uint32_t idxIndex = 0; idxIndex < idxCount; idxIndex++) { const IndexMetadata& metadata = indexes[idxIndex]; rv = AppendIndexUpdateInfo(metadata.id(), metadata.keyPath(), metadata.unique(), metadata.multiEntry(), aCx, aValue, aUpdateInfoArray); if (NS_WARN_IF(NS_FAILED(rv))) { return rv; } } GetAddInfoClosure data(aCloneWriteInfo, aValue); if (isAutoIncrement && HasValidKeyPath()) { MOZ_ASSERT(aKey.IsUnset()); rv = GetKeyPath().ExtractOrCreateKey(aCx, aValue, aKey, &GetAddInfoCallback, &data); } else { rv = GetAddInfoCallback(aCx, &data); } return rv; } already_AddRefed IDBObjectStore::AddOrPut(JSContext* aCx, JS::Handle aValue, JS::Handle aKey, bool aOverwrite, bool aFromCursor, ErrorResult& aRv) { AssertIsOnOwningThread(); MOZ_ASSERT(aCx); MOZ_ASSERT_IF(aFromCursor, aOverwrite); if (mDeletedSpec) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_NOT_ALLOWED_ERR); return nullptr; } if (!mTransaction->IsOpen()) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_TRANSACTION_INACTIVE_ERR); return nullptr; } if (!mTransaction->IsWriteAllowed()) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_READ_ONLY_ERR); return nullptr; } JS::Rooted value(aCx, aValue); Key key; StructuredCloneWriteInfo cloneWriteInfo(mTransaction->Database()); nsTArray updateInfo; aRv = GetAddInfo(aCx, value, aKey, cloneWriteInfo, key, updateInfo); if (aRv.Failed()) { return nullptr; } FallibleTArray cloneData; if (NS_WARN_IF(!cloneData.SetLength(cloneWriteInfo.mCloneBuffer.nbytes(), fallible))) { aRv = NS_ERROR_OUT_OF_MEMORY; return nullptr; } // XXX Remove this memcpy(cloneData.Elements(), cloneWriteInfo.mCloneBuffer.data(), cloneWriteInfo.mCloneBuffer.nbytes()); cloneWriteInfo.mCloneBuffer.clear(); ObjectStoreAddPutParams commonParams; commonParams.objectStoreId() = Id(); commonParams.cloneInfo().data().SwapElements(cloneData); commonParams.cloneInfo().offsetToKeyProp() = cloneWriteInfo.mOffsetToKeyProp; commonParams.key() = key; commonParams.indexUpdateInfos().SwapElements(updateInfo); // Convert any blobs or fileIds into DatabaseFileOrMutableFileId. nsTArray& blobOrFileInfos = cloneWriteInfo.mBlobOrFileInfos; FallibleTArray> fileInfosToKeepAlive; if (!blobOrFileInfos.IsEmpty()) { const uint32_t count = blobOrFileInfos.Length(); FallibleTArray fileActorOrMutableFileIds; if (NS_WARN_IF(!fileActorOrMutableFileIds.SetCapacity(count, fallible))) { aRv = NS_ERROR_OUT_OF_MEMORY; return nullptr; } IDBDatabase* database = mTransaction->Database(); for (uint32_t index = 0; index < count; index++) { StructuredCloneWriteInfo::BlobOrFileInfo& blobOrFileInfo = blobOrFileInfos[index]; MOZ_ASSERT((blobOrFileInfo.mBlob && !blobOrFileInfo.mFileInfo) || (!blobOrFileInfo.mBlob && blobOrFileInfo.mFileInfo)); if (blobOrFileInfo.mBlob) { PBackgroundIDBDatabaseFileChild* fileActor = database->GetOrCreateFileActorForBlob(blobOrFileInfo.mBlob); if (NS_WARN_IF(!fileActor)) { IDB_REPORT_INTERNAL_ERR(); aRv = NS_ERROR_DOM_INDEXEDDB_UNKNOWN_ERR; return nullptr; } MOZ_ALWAYS_TRUE(fileActorOrMutableFileIds.AppendElement(fileActor, fallible)); } else { const int64_t fileId = blobOrFileInfo.mFileInfo->Id(); MOZ_ASSERT(fileId > 0); MOZ_ALWAYS_TRUE(fileActorOrMutableFileIds.AppendElement(fileId, fallible)); nsRefPtr* newFileInfo = fileInfosToKeepAlive.AppendElement(fallible); if (NS_WARN_IF(!newFileInfo)) { aRv = NS_ERROR_OUT_OF_MEMORY; return nullptr; } newFileInfo->swap(blobOrFileInfo.mFileInfo); } } commonParams.files().SwapElements(fileActorOrMutableFileIds); } RequestParams params; if (aOverwrite) { params = ObjectStorePutParams(commonParams); } else { params = ObjectStoreAddParams(commonParams); } nsRefPtr request = GenerateRequest(this); MOZ_ASSERT(request); if (!aFromCursor) { if (aOverwrite) { IDB_LOG_MARK("IndexedDB %s: Child Transaction[%lld] Request[%llu]: " "database(%s).transaction(%s).objectStore(%s).put(%s)", "IndexedDB %s: C T[%lld] R[%llu]: IDBObjectStore.put()", IDB_LOG_ID_STRING(), mTransaction->LoggingSerialNumber(), request->LoggingSerialNumber(), IDB_LOG_STRINGIFY(mTransaction->Database()), IDB_LOG_STRINGIFY(mTransaction), IDB_LOG_STRINGIFY(this), IDB_LOG_STRINGIFY(key)); } else { IDB_LOG_MARK("IndexedDB %s: Child Transaction[%lld] Request[%llu]: " "database(%s).transaction(%s).objectStore(%s).add(%s)", "IndexedDB %s: C T[%lld] R[%llu]: IDBObjectStore.add()", IDB_LOG_ID_STRING(), mTransaction->LoggingSerialNumber(), request->LoggingSerialNumber(), IDB_LOG_STRINGIFY(mTransaction->Database()), IDB_LOG_STRINGIFY(mTransaction), IDB_LOG_STRINGIFY(this), IDB_LOG_STRINGIFY(key)); } } BackgroundRequestChild* actor = mTransaction->StartRequest(request, params); MOZ_ASSERT(actor); if (!fileInfosToKeepAlive.IsEmpty()) { nsTArray> fileInfos; fileInfosToKeepAlive.SwapElements(fileInfos); actor->HoldFileInfosUntilComplete(fileInfos); MOZ_ASSERT(fileInfos.IsEmpty()); } return request.forget(); } already_AddRefed IDBObjectStore::GetAllInternal(bool aKeysOnly, JSContext* aCx, JS::Handle aKey, const Optional& aLimit, ErrorResult& aRv) { AssertIsOnOwningThread(); if (mDeletedSpec) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_NOT_ALLOWED_ERR); return nullptr; } if (!mTransaction->IsOpen()) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_TRANSACTION_INACTIVE_ERR); return nullptr; } nsRefPtr keyRange; aRv = IDBKeyRange::FromJSVal(aCx, aKey, getter_AddRefs(keyRange)); if (NS_WARN_IF(aRv.Failed())) { return nullptr; } const int64_t id = Id(); OptionalKeyRange optionalKeyRange; if (keyRange) { SerializedKeyRange serializedKeyRange; keyRange->ToSerialized(serializedKeyRange); optionalKeyRange = serializedKeyRange; } else { optionalKeyRange = void_t(); } const uint32_t limit = aLimit.WasPassed() ? aLimit.Value() : 0; RequestParams params; if (aKeysOnly) { params = ObjectStoreGetAllKeysParams(id, optionalKeyRange, limit); } else { params = ObjectStoreGetAllParams(id, optionalKeyRange, limit); } nsRefPtr request = GenerateRequest(this); MOZ_ASSERT(request); if (aKeysOnly) { IDB_LOG_MARK("IndexedDB %s: Child Transaction[%lld] Request[%llu]: " "database(%s).transaction(%s).objectStore(%s)." "getAllKeys(%s, %s)", "IndexedDB %s: C T[%lld] R[%llu]: IDBObjectStore.getAllKeys()", IDB_LOG_ID_STRING(), mTransaction->LoggingSerialNumber(), request->LoggingSerialNumber(), IDB_LOG_STRINGIFY(mTransaction->Database()), IDB_LOG_STRINGIFY(mTransaction), IDB_LOG_STRINGIFY(this), IDB_LOG_STRINGIFY(keyRange), IDB_LOG_STRINGIFY(aLimit)); } else { IDB_LOG_MARK("IndexedDB %s: Child Transaction[%lld] Request[%llu]: " "database(%s).transaction(%s).objectStore(%s)." "getAll(%s, %s)", "IndexedDB %s: C T[%lld] R[%llu]: IDBObjectStore.getAll()", IDB_LOG_ID_STRING(), mTransaction->LoggingSerialNumber(), request->LoggingSerialNumber(), IDB_LOG_STRINGIFY(mTransaction->Database()), IDB_LOG_STRINGIFY(mTransaction), IDB_LOG_STRINGIFY(this), IDB_LOG_STRINGIFY(keyRange), IDB_LOG_STRINGIFY(aLimit)); } mTransaction->StartRequest(request, params); return request.forget(); } already_AddRefed IDBObjectStore::Clear(ErrorResult& aRv) { AssertIsOnOwningThread(); if (mDeletedSpec) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_NOT_ALLOWED_ERR); return nullptr; } if (!mTransaction->IsOpen()) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_TRANSACTION_INACTIVE_ERR); return nullptr; } if (!mTransaction->IsWriteAllowed()) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_READ_ONLY_ERR); return nullptr; } ObjectStoreClearParams params; params.objectStoreId() = Id(); nsRefPtr request = GenerateRequest(this); MOZ_ASSERT(request); IDB_LOG_MARK("IndexedDB %s: Child Transaction[%lld] Request[%llu]: " "database(%s).transaction(%s).objectStore(%s).clear()", "IndexedDB %s: C T[%lld] R[%llu]: IDBObjectStore.clear()", IDB_LOG_ID_STRING(), mTransaction->LoggingSerialNumber(), request->LoggingSerialNumber(), IDB_LOG_STRINGIFY(mTransaction->Database()), IDB_LOG_STRINGIFY(mTransaction), IDB_LOG_STRINGIFY(this)); mTransaction->StartRequest(request, params); return request.forget(); } already_AddRefed IDBObjectStore::Index(const nsAString& aName, ErrorResult &aRv) { AssertIsOnOwningThread(); if (mTransaction->IsCommittingOrDone() || mDeletedSpec) { aRv.Throw(NS_ERROR_DOM_INVALID_STATE_ERR); return nullptr; } const nsTArray& indexes = mSpec->indexes(); const IndexMetadata* metadata = nullptr; for (uint32_t idxCount = indexes.Length(), idxIndex = 0; idxIndex < idxCount; idxIndex++) { const IndexMetadata& index = indexes[idxIndex]; if (index.name() == aName) { metadata = &index; break; } } if (!metadata) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_NOT_FOUND_ERR); return nullptr; } const int64_t desiredId = metadata->id(); nsRefPtr index; for (uint32_t idxCount = mIndexes.Length(), idxIndex = 0; idxIndex < idxCount; idxIndex++) { nsRefPtr& existingIndex = mIndexes[idxIndex]; if (existingIndex->Id() == desiredId) { index = existingIndex; break; } } if (!index) { index = IDBIndex::Create(this, *metadata); MOZ_ASSERT(index); mIndexes.AppendElement(index); } return index.forget(); } NS_IMPL_CYCLE_COLLECTION_CLASS(IDBObjectStore) NS_IMPL_CYCLE_COLLECTION_TRACE_BEGIN(IDBObjectStore) NS_IMPL_CYCLE_COLLECTION_TRACE_PRESERVED_WRAPPER NS_IMPL_CYCLE_COLLECTION_TRACE_JSVAL_MEMBER_CALLBACK(mCachedKeyPath) NS_IMPL_CYCLE_COLLECTION_TRACE_END NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN(IDBObjectStore) NS_IMPL_CYCLE_COLLECTION_TRAVERSE_SCRIPT_OBJECTS NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mTransaction) NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mIndexes); NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(IDBObjectStore) NS_IMPL_CYCLE_COLLECTION_UNLINK_PRESERVED_WRAPPER // Don't unlink mTransaction! NS_IMPL_CYCLE_COLLECTION_UNLINK(mIndexes); tmp->mCachedKeyPath.setUndefined(); if (tmp->mRooted) { mozilla::DropJSObjects(tmp); tmp->mRooted = false; } NS_IMPL_CYCLE_COLLECTION_UNLINK_END NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(IDBObjectStore) NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY NS_INTERFACE_MAP_ENTRY(nsISupports) NS_INTERFACE_MAP_END NS_IMPL_CYCLE_COLLECTING_ADDREF(IDBObjectStore) NS_IMPL_CYCLE_COLLECTING_RELEASE(IDBObjectStore) JSObject* IDBObjectStore::WrapObject(JSContext* aCx, JS::Handle aGivenProto) { return IDBObjectStoreBinding::Wrap(aCx, this, aGivenProto); } nsPIDOMWindow* IDBObjectStore::GetParentObject() const { return mTransaction->GetParentObject(); } void IDBObjectStore::GetKeyPath(JSContext* aCx, JS::MutableHandle aResult, ErrorResult& aRv) { if (!mCachedKeyPath.isUndefined()) { JS::ExposeValueToActiveJS(mCachedKeyPath); aResult.set(mCachedKeyPath); return; } aRv = GetKeyPath().ToJSVal(aCx, mCachedKeyPath); if (NS_WARN_IF(aRv.Failed())) { return; } if (mCachedKeyPath.isGCThing()) { mozilla::HoldJSObjects(this); mRooted = true; } JS::ExposeValueToActiveJS(mCachedKeyPath); aResult.set(mCachedKeyPath); } already_AddRefed IDBObjectStore::IndexNames() { AssertIsOnOwningThread(); const nsTArray& indexes = mSpec->indexes(); nsRefPtr list = new DOMStringList(); if (!indexes.IsEmpty()) { nsTArray& listNames = list->StringArray(); listNames.SetCapacity(indexes.Length()); for (uint32_t index = 0; index < indexes.Length(); index++) { listNames.InsertElementSorted(indexes[index].name()); } } return list.forget(); } already_AddRefed IDBObjectStore::Get(JSContext* aCx, JS::Handle aKey, ErrorResult& aRv) { AssertIsOnOwningThread(); if (mDeletedSpec) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_NOT_ALLOWED_ERR); return nullptr; } if (!mTransaction->IsOpen()) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_TRANSACTION_INACTIVE_ERR); return nullptr; } nsRefPtr keyRange; aRv = IDBKeyRange::FromJSVal(aCx, aKey, getter_AddRefs(keyRange)); if (aRv.Failed()) { return nullptr; } if (!keyRange) { // Must specify a key or keyRange for get(). aRv.Throw(NS_ERROR_DOM_INDEXEDDB_DATA_ERR); return nullptr; } ObjectStoreGetParams params; params.objectStoreId() = Id(); keyRange->ToSerialized(params.keyRange()); nsRefPtr request = GenerateRequest(this); MOZ_ASSERT(request); IDB_LOG_MARK("IndexedDB %s: Child Transaction[%lld] Request[%llu]: " "database(%s).transaction(%s).objectStore(%s).get(%s)", "IndexedDB %s: C T[%lld] R[%llu]: IDBObjectStore.get()", IDB_LOG_ID_STRING(), mTransaction->LoggingSerialNumber(), request->LoggingSerialNumber(), IDB_LOG_STRINGIFY(mTransaction->Database()), IDB_LOG_STRINGIFY(mTransaction), IDB_LOG_STRINGIFY(this), IDB_LOG_STRINGIFY(keyRange)); mTransaction->StartRequest(request, params); return request.forget(); } already_AddRefed IDBObjectStore::DeleteInternal(JSContext* aCx, JS::Handle aKey, bool aFromCursor, ErrorResult& aRv) { AssertIsOnOwningThread(); if (mDeletedSpec) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_NOT_ALLOWED_ERR); return nullptr; } if (!mTransaction->IsOpen()) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_TRANSACTION_INACTIVE_ERR); return nullptr; } if (!mTransaction->IsWriteAllowed()) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_READ_ONLY_ERR); return nullptr; } nsRefPtr keyRange; aRv = IDBKeyRange::FromJSVal(aCx, aKey, getter_AddRefs(keyRange)); if (NS_WARN_IF((aRv.Failed()))) { return nullptr; } if (!keyRange) { // Must specify a key or keyRange for delete(). aRv.Throw(NS_ERROR_DOM_INDEXEDDB_DATA_ERR); return nullptr; } ObjectStoreDeleteParams params; params.objectStoreId() = Id(); keyRange->ToSerialized(params.keyRange()); nsRefPtr request = GenerateRequest(this); MOZ_ASSERT(request); if (!aFromCursor) { IDB_LOG_MARK("IndexedDB %s: Child Transaction[%lld] Request[%llu]: " "database(%s).transaction(%s).objectStore(%s).delete(%s)", "IndexedDB %s: C T[%lld] R[%llu]: IDBObjectStore.delete()", IDB_LOG_ID_STRING(), mTransaction->LoggingSerialNumber(), request->LoggingSerialNumber(), IDB_LOG_STRINGIFY(mTransaction->Database()), IDB_LOG_STRINGIFY(mTransaction), IDB_LOG_STRINGIFY(this), IDB_LOG_STRINGIFY(keyRange)); } mTransaction->StartRequest(request, params); return request.forget(); } already_AddRefed IDBObjectStore::CreateIndex(const nsAString& aName, const nsAString& aKeyPath, const IDBIndexParameters& aOptionalParameters, ErrorResult& aRv) { AssertIsOnOwningThread(); KeyPath keyPath(0); if (NS_FAILED(KeyPath::Parse(aKeyPath, &keyPath)) || !keyPath.IsValid()) { aRv.Throw(NS_ERROR_DOM_SYNTAX_ERR); return nullptr; } return CreateIndexInternal(aName, keyPath, aOptionalParameters, aRv); } already_AddRefed IDBObjectStore::CreateIndex(const nsAString& aName, const Sequence& aKeyPath, const IDBIndexParameters& aOptionalParameters, ErrorResult& aRv) { AssertIsOnOwningThread(); KeyPath keyPath(0); if (aKeyPath.IsEmpty() || NS_FAILED(KeyPath::Parse(aKeyPath, &keyPath)) || !keyPath.IsValid()) { aRv.Throw(NS_ERROR_DOM_SYNTAX_ERR); return nullptr; } return CreateIndexInternal(aName, keyPath, aOptionalParameters, aRv); } already_AddRefed IDBObjectStore::CreateIndexInternal( const nsAString& aName, const KeyPath& aKeyPath, const IDBIndexParameters& aOptionalParameters, ErrorResult& aRv) { AssertIsOnOwningThread(); if (mTransaction->GetMode() != IDBTransaction::VERSION_CHANGE || mDeletedSpec) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_NOT_ALLOWED_ERR); return nullptr; } IDBTransaction* transaction = IDBTransaction::GetCurrent(); if (!transaction || transaction != mTransaction) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_TRANSACTION_INACTIVE_ERR); return nullptr; } MOZ_ASSERT(transaction->IsOpen()); auto& indexes = const_cast&>(mSpec->indexes()); for (uint32_t count = indexes.Length(), index = 0; index < count; index++) { if (aName == indexes[index].name()) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_CONSTRAINT_ERR); return nullptr; } } if (aOptionalParameters.mMultiEntry && aKeyPath.IsArray()) { aRv.Throw(NS_ERROR_DOM_INVALID_ACCESS_ERR); return nullptr; } #ifdef DEBUG for (uint32_t count = mIndexes.Length(), index = 0; index < count; index++) { MOZ_ASSERT(mIndexes[index]->Name() != aName); } #endif const IndexMetadata* oldMetadataElements = indexes.IsEmpty() ? nullptr : indexes.Elements(); IndexMetadata* metadata = indexes.AppendElement( IndexMetadata(transaction->NextIndexId(), nsString(aName), aKeyPath, aOptionalParameters.mUnique, aOptionalParameters.mMultiEntry)); if (oldMetadataElements && oldMetadataElements != indexes.Elements()) { MOZ_ASSERT(indexes.Length() > 1); // Array got moved, update the spec pointers for all live indexes. RefreshSpec(/* aMayDelete */ false); } transaction->CreateIndex(this, *metadata); nsRefPtr index = IDBIndex::Create(this, *metadata); MOZ_ASSERT(index); mIndexes.AppendElement(index); // Don't do this in the macro because we always need to increment the serial // number to keep in sync with the parent. const uint64_t requestSerialNumber = IDBRequest::NextSerialNumber(); IDB_LOG_MARK("IndexedDB %s: Child Transaction[%lld] Request[%llu]: " "database(%s).transaction(%s).objectStore(%s).createIndex(%s)", "IndexedDB %s: C T[%lld] R[%llu]: IDBObjectStore.createIndex()", IDB_LOG_ID_STRING(), mTransaction->LoggingSerialNumber(), requestSerialNumber, IDB_LOG_STRINGIFY(mTransaction->Database()), IDB_LOG_STRINGIFY(mTransaction), IDB_LOG_STRINGIFY(this), IDB_LOG_STRINGIFY(index)); return index.forget(); } void IDBObjectStore::DeleteIndex(const nsAString& aName, ErrorResult& aRv) { AssertIsOnOwningThread(); if (mTransaction->GetMode() != IDBTransaction::VERSION_CHANGE || mDeletedSpec) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_NOT_ALLOWED_ERR); return; } IDBTransaction* transaction = IDBTransaction::GetCurrent(); if (!transaction || transaction != mTransaction) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_TRANSACTION_INACTIVE_ERR); return; } MOZ_ASSERT(transaction->IsOpen()); auto& metadataArray = const_cast&>(mSpec->indexes()); int64_t foundId = 0; for (uint32_t metadataCount = metadataArray.Length(), metadataIndex = 0; metadataIndex < metadataCount; metadataIndex++) { const IndexMetadata& metadata = metadataArray[metadataIndex]; MOZ_ASSERT(metadata.id()); if (aName == metadata.name()) { foundId = metadata.id(); // Must do this before altering the metadata array! for (uint32_t indexCount = mIndexes.Length(), indexIndex = 0; indexIndex < indexCount; indexIndex++) { nsRefPtr& index = mIndexes[indexIndex]; if (index->Id() == foundId) { index->NoteDeletion(); mIndexes.RemoveElementAt(indexIndex); break; } } metadataArray.RemoveElementAt(metadataIndex); RefreshSpec(/* aMayDelete */ false); break; } } if (!foundId) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_NOT_FOUND_ERR); return; } // Don't do this in the macro because we always need to increment the serial // number to keep in sync with the parent. const uint64_t requestSerialNumber = IDBRequest::NextSerialNumber(); IDB_LOG_MARK("IndexedDB %s: Child Transaction[%lld] Request[%llu]: " "database(%s).transaction(%s).objectStore(%s)." "deleteIndex(\"%s\")", "IndexedDB %s: C T[%lld] R[%llu]: IDBObjectStore.deleteIndex()", IDB_LOG_ID_STRING(), mTransaction->LoggingSerialNumber(), requestSerialNumber, IDB_LOG_STRINGIFY(mTransaction->Database()), IDB_LOG_STRINGIFY(mTransaction), IDB_LOG_STRINGIFY(this), NS_ConvertUTF16toUTF8(aName).get()); transaction->DeleteIndex(this, foundId); } already_AddRefed IDBObjectStore::Count(JSContext* aCx, JS::Handle aKey, ErrorResult& aRv) { AssertIsOnOwningThread(); if (mDeletedSpec) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_NOT_ALLOWED_ERR); return nullptr; } if (!mTransaction->IsOpen()) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_TRANSACTION_INACTIVE_ERR); return nullptr; } nsRefPtr keyRange; aRv = IDBKeyRange::FromJSVal(aCx, aKey, getter_AddRefs(keyRange)); if (aRv.Failed()) { return nullptr; } ObjectStoreCountParams params; params.objectStoreId() = Id(); if (keyRange) { SerializedKeyRange serializedKeyRange; keyRange->ToSerialized(serializedKeyRange); params.optionalKeyRange() = serializedKeyRange; } else { params.optionalKeyRange() = void_t(); } nsRefPtr request = GenerateRequest(this); MOZ_ASSERT(request); IDB_LOG_MARK("IndexedDB %s: Child Transaction[%lld] Request[%llu]: " "database(%s).transaction(%s).objectStore(%s).count(%s)", "IndexedDB %s: C T[%lld] R[%llu]: IDBObjectStore.count()", IDB_LOG_ID_STRING(), mTransaction->LoggingSerialNumber(), request->LoggingSerialNumber(), IDB_LOG_STRINGIFY(mTransaction->Database()), IDB_LOG_STRINGIFY(mTransaction), IDB_LOG_STRINGIFY(this), IDB_LOG_STRINGIFY(keyRange)); mTransaction->StartRequest(request, params); return request.forget(); } already_AddRefed IDBObjectStore::OpenCursorInternal(bool aKeysOnly, JSContext* aCx, JS::Handle aRange, IDBCursorDirection aDirection, ErrorResult& aRv) { AssertIsOnOwningThread(); if (mDeletedSpec) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_NOT_ALLOWED_ERR); return nullptr; } if (!mTransaction->IsOpen()) { aRv.Throw(NS_ERROR_DOM_INDEXEDDB_TRANSACTION_INACTIVE_ERR); return nullptr; } nsRefPtr keyRange; aRv = IDBKeyRange::FromJSVal(aCx, aRange, getter_AddRefs(keyRange)); if (NS_WARN_IF(aRv.Failed())) { return nullptr; } int64_t objectStoreId = Id(); OptionalKeyRange optionalKeyRange; if (keyRange) { SerializedKeyRange serializedKeyRange; keyRange->ToSerialized(serializedKeyRange); optionalKeyRange = Move(serializedKeyRange); } else { optionalKeyRange = void_t(); } IDBCursor::Direction direction = IDBCursor::ConvertDirection(aDirection); OpenCursorParams params; if (aKeysOnly) { ObjectStoreOpenKeyCursorParams openParams; openParams.objectStoreId() = objectStoreId; openParams.optionalKeyRange() = Move(optionalKeyRange); openParams.direction() = direction; params = Move(openParams); } else { ObjectStoreOpenCursorParams openParams; openParams.objectStoreId() = objectStoreId; openParams.optionalKeyRange() = Move(optionalKeyRange); openParams.direction() = direction; params = Move(openParams); } nsRefPtr request = GenerateRequest(this); MOZ_ASSERT(request); if (aKeysOnly) { IDB_LOG_MARK("IndexedDB %s: Child Transaction[%lld] Request[%llu]: " "database(%s).transaction(%s).objectStore(%s)." "openKeyCursor(%s, %s)", "IndexedDB %s: C T[%lld] R[%llu]: " "IDBObjectStore.openKeyCursor()", IDB_LOG_ID_STRING(), mTransaction->LoggingSerialNumber(), request->LoggingSerialNumber(), IDB_LOG_STRINGIFY(mTransaction->Database()), IDB_LOG_STRINGIFY(mTransaction), IDB_LOG_STRINGIFY(this), IDB_LOG_STRINGIFY(keyRange), IDB_LOG_STRINGIFY(direction)); } else { IDB_LOG_MARK("IndexedDB %s: Child Transaction[%lld] Request[%llu]: " "database(%s).transaction(%s).objectStore(%s)." "openCursor(%s, %s)", "IndexedDB %s: C T[%lld] R[%llu]: IDBObjectStore.openCursor()", IDB_LOG_ID_STRING(), mTransaction->LoggingSerialNumber(), request->LoggingSerialNumber(), IDB_LOG_STRINGIFY(mTransaction->Database()), IDB_LOG_STRINGIFY(mTransaction), IDB_LOG_STRINGIFY(this), IDB_LOG_STRINGIFY(keyRange), IDB_LOG_STRINGIFY(direction)); } BackgroundCursorChild* actor = new BackgroundCursorChild(request, this, direction); mTransaction->OpenCursor(actor, params); return request.forget(); } void IDBObjectStore::RefreshSpec(bool aMayDelete) { AssertIsOnOwningThread(); MOZ_ASSERT_IF(mDeletedSpec, mSpec == mDeletedSpec); const DatabaseSpec* dbSpec = mTransaction->Database()->Spec(); MOZ_ASSERT(dbSpec); const nsTArray& objectStores = dbSpec->objectStores(); bool found = false; for (uint32_t objCount = objectStores.Length(), objIndex = 0; objIndex < objCount; objIndex++) { const ObjectStoreSpec& objSpec = objectStores[objIndex]; if (objSpec.metadata().id() == Id()) { mSpec = &objSpec; for (uint32_t idxCount = mIndexes.Length(), idxIndex = 0; idxIndex < idxCount; idxIndex++) { mIndexes[idxIndex]->RefreshMetadata(aMayDelete); } found = true; break; } } MOZ_ASSERT_IF(!aMayDelete && !mDeletedSpec, found); if (found) { MOZ_ASSERT(mSpec != mDeletedSpec); mDeletedSpec = nullptr; } else { NoteDeletion(); } } const ObjectStoreSpec& IDBObjectStore::Spec() const { AssertIsOnOwningThread(); MOZ_ASSERT(mSpec); return *mSpec; } void IDBObjectStore::NoteDeletion() { AssertIsOnOwningThread(); MOZ_ASSERT(mSpec); MOZ_ASSERT(Id() == mSpec->metadata().id()); if (mDeletedSpec) { MOZ_ASSERT(mDeletedSpec == mSpec); return; } // Copy the spec here. mDeletedSpec = new ObjectStoreSpec(*mSpec); mDeletedSpec->indexes().Clear(); mSpec = mDeletedSpec; if (!mIndexes.IsEmpty()) { for (uint32_t count = mIndexes.Length(), index = 0; index < count; index++) { mIndexes[index]->NoteDeletion(); } } } const nsString& IDBObjectStore::Name() const { AssertIsOnOwningThread(); MOZ_ASSERT(mSpec); return mSpec->metadata().name(); } bool IDBObjectStore::AutoIncrement() const { AssertIsOnOwningThread(); MOZ_ASSERT(mSpec); return mSpec->metadata().autoIncrement(); } const KeyPath& IDBObjectStore::GetKeyPath() const { AssertIsOnOwningThread(); MOZ_ASSERT(mSpec); return mSpec->metadata().keyPath(); } bool IDBObjectStore::HasValidKeyPath() const { AssertIsOnOwningThread(); MOZ_ASSERT(mSpec); return GetKeyPath().IsValid(); } } // namespace indexedDB } // namespace dom } // namespace mozilla