blob: c3820fa9fd782abbce4610acdd66a00b4d03f392 [file] [log] [blame]
/*
* Copyright (C) 2015, 2016 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.
*/
#pragma once
#include "EventTarget.h"
#include "ExceptionOr.h"
#include "IDBActiveDOMObject.h"
#include "IDBError.h"
#include "IDBGetAllResult.h"
#include "IDBGetResult.h"
#include "IDBKeyData.h"
#include "IDBResourceIdentifier.h"
#include "IDBValue.h"
#include "IndexedDB.h"
#include "JSValueInWrappedObject.h"
#include <JavaScriptCore/Strong.h>
#include <wtf/Function.h>
#include <wtf/IsoMalloc.h>
#include <wtf/Scope.h>
#include <wtf/ThreadSafeRefCounted.h>
#include <wtf/WeakPtr.h>
namespace WebCore {
class DOMException;
class Event;
class IDBCursor;
class IDBDatabase;
class IDBIndex;
class IDBObjectStore;
class IDBResultData;
class IDBTransaction;
class ThreadSafeDataBuffer;
class WebCoreOpaqueRoot;
namespace IDBClient {
class IDBConnectionProxy;
class IDBConnectionToServer;
}
class IDBRequest : public EventTargetWithInlineData, public IDBActiveDOMObject, public ThreadSafeRefCounted<IDBRequest> {
WTF_MAKE_ISO_ALLOCATED(IDBRequest);
public:
enum class NullResultType {
Empty,
Undefined
};
static Ref<IDBRequest> create(ScriptExecutionContext&, IDBObjectStore&, IDBTransaction&);
static Ref<IDBRequest> create(ScriptExecutionContext&, IDBCursor&, IDBTransaction&);
static Ref<IDBRequest> create(ScriptExecutionContext&, IDBIndex&, IDBTransaction&);
static Ref<IDBRequest> createObjectStoreGet(ScriptExecutionContext&, IDBObjectStore&, IndexedDB::ObjectStoreRecordType, IDBTransaction&);
static Ref<IDBRequest> createIndexGet(ScriptExecutionContext&, IDBIndex&, IndexedDB::IndexRecordType, IDBTransaction&);
const IDBResourceIdentifier& resourceIdentifier() const { return m_resourceIdentifier; }
virtual ~IDBRequest();
using Result = std::variant<RefPtr<IDBCursor>, RefPtr<IDBDatabase>, IDBKeyData, Vector<IDBKeyData>, IDBGetResult, IDBGetAllResult, uint64_t, NullResultType>;
ExceptionOr<Result> result() const;
JSValueInWrappedObject& resultWrapper() { return m_resultWrapper; }
using Source = std::variant<RefPtr<IDBObjectStore>, RefPtr<IDBIndex>, RefPtr<IDBCursor>>;
const std::optional<Source>& source() const { return m_source; }
ExceptionOr<DOMException*> error() const;
RefPtr<IDBTransaction> transaction() const;
enum class ReadyState { Pending, Done };
ReadyState readyState() const { return m_readyState; }
bool isDone() const { return m_readyState == ReadyState::Done; }
uint64_t sourceObjectStoreIdentifier() const;
uint64_t sourceIndexIdentifier() const;
IndexedDB::ObjectStoreRecordType requestedObjectStoreRecordType() const;
IndexedDB::IndexRecordType requestedIndexRecordType() const;
ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
using ThreadSafeRefCounted::ref;
using ThreadSafeRefCounted::deref;
void completeRequestAndDispatchEvent(const IDBResultData&);
void setResult(const IDBKeyData&);
void setResult(const Vector<IDBKeyData>&);
void setResultToStructuredClone(const IDBGetResult&);
void setResult(const IDBGetAllResult&);
void setResult(uint64_t);
void setResultToUndefined();
void willIterateCursor(IDBCursor&);
void didOpenOrIterateCursor(const IDBResultData&);
IDBCursor* pendingCursor() const { return m_pendingCursor ? m_pendingCursor.get() : nullptr; }
void setSource(IDBCursor&);
void setVersionChangeTransaction(IDBTransaction&);
IndexedDB::RequestType requestType() const { return m_requestType; }
void setTransactionOperationID(uint64_t transactionOperationID) { m_currentTransactionOperationID = transactionOperationID; }
bool willAbortTransactionAfterDispatchingEvent() const;
protected:
IDBRequest(ScriptExecutionContext&, IDBClient::IDBConnectionProxy&, IndexedDB::RequestType);
void enqueueEvent(Ref<Event>&&);
void dispatchEvent(Event&) override;
void setResult(Ref<IDBDatabase>&&);
void setReadyState(ReadyState state) { m_readyState = state; }
void setShouldExposeTransactionToDOM(bool shouldExposeTransactionToDOM) { m_shouldExposeTransactionToDOM = shouldExposeTransactionToDOM; }
IDBClient::IDBConnectionProxy& connectionProxy() { return m_connectionProxy.get(); }
private:
IDBRequest(ScriptExecutionContext&, IDBObjectStore&, IDBTransaction&);
IDBRequest(ScriptExecutionContext&, IDBCursor&, IDBTransaction&);
IDBRequest(ScriptExecutionContext&, IDBIndex&, IDBTransaction&);
IDBRequest(ScriptExecutionContext&, IDBObjectStore&, IndexedDB::ObjectStoreRecordType, IDBTransaction&);
IDBRequest(ScriptExecutionContext&, IDBIndex&, IndexedDB::IndexRecordType, IDBTransaction&);
EventTargetInterface eventTargetInterface() const override;
// ActiveDOMObject.
bool virtualHasPendingActivity() const final;
const char* activeDOMObjectName() const final;
void stop() final;
virtual void cancelForStop();
void refEventTarget() final { ref(); }
void derefEventTarget() final { deref(); }
void uncaughtExceptionInEventHandler() final;
virtual bool isOpenDBRequest() const { return false; }
void onError();
void onSuccess();
void clearWrappers();
protected:
// FIXME: Protected data members aren't great for maintainability.
// Consider adding protected helper functions and making these private.
RefPtr<IDBTransaction> m_transaction;
RefPtr<DOMException> m_domError;
Event* m_openDatabaseSuccessEvent { nullptr };
private:
IDBCursor* resultCursor();
IDBError m_idbError;
IDBResourceIdentifier m_resourceIdentifier;
JSValueInWrappedObject m_resultWrapper;
uint64_t m_currentTransactionOperationID { 0 };
Result m_result;
std::optional<Source> m_source;
RefPtr<IDBCursor> m_pendingCursor;
Ref<IDBClient::IDBConnectionProxy> m_connectionProxy;
ReadyState m_readyState { ReadyState::Pending };
IndexedDB::RequestType m_requestType { IndexedDB::RequestType::Other };
IndexedDB::ObjectStoreRecordType m_requestedObjectStoreRecordType { IndexedDB::ObjectStoreRecordType::ValueOnly };
IndexedDB::IndexRecordType m_requestedIndexRecordType { IndexedDB::IndexRecordType::Key };
bool m_shouldExposeTransactionToDOM { true };
bool m_hasPendingActivity { true };
bool m_hasUncaughtException { false };
RefPtr<Event> m_eventBeingDispatched;
};
WebCoreOpaqueRoot root(IDBRequest*);
} // namespace WebCore