Source/WebKit2/DatabaseProcess/IndexedDB/DatabaseProcessIDBConnection.cpp

/*
 * Copyright (C) 2013 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 "DatabaseProcessIDBConnection.h"

#if ENABLE(INDEXED_DATABASE) && ENABLE(DATABASE_PROCESS)

#include "DataReference.h"
#include "DatabaseProcess.h"
#include "DatabaseToWebProcessConnection.h"
#include "IDBIdentifier.h"
#include "Logging.h"
#include "UniqueIDBDatabase.h"
#include "WebCoreArgumentCoders.h"
#include "WebIDBServerConnectionMessages.h"
#include <WebCore/IDBDatabaseMetadata.h>
#include <WebCore/IDBIndexMetadata.h>
#include <WebCore/IDBObjectStoreMetadata.h>
#include <WebCore/IDBServerConnection.h>
#include <WebCore/IndexedDB.h>

using namespace WebCore;

namespace WebKit {

DatabaseProcessIDBConnection::DatabaseProcessIDBConnection(DatabaseToWebProcessConnection& connection, uint64_t serverConnectionIdentifier)
    : m_connection(connection)
    , m_serverConnectionIdentifier(serverConnectionIdentifier)
{
}

DatabaseProcessIDBConnection::~DatabaseProcessIDBConnection()
{
    ASSERT(!m_uniqueIDBDatabase);
}

void DatabaseProcessIDBConnection::disconnectedFromWebProcess()
{
    // It's possible that the m_uniqueIDBDatabase pointer has already been cleared
    // if the represented database was deleted, or if it was closed between delete
    // and the delete callback
    if (!m_uniqueIDBDatabase)
        return;

    m_uniqueIDBDatabase->unregisterConnection(*this);
    m_uniqueIDBDatabase = nullptr;
}

void DatabaseProcessIDBConnection::establishConnection(const String& databaseName, const SecurityOriginData& openingOrigin, const SecurityOriginData& mainFrameOrigin)
{
    m_uniqueIDBDatabase = DatabaseProcess::singleton().getOrCreateUniqueIDBDatabase(UniqueIDBDatabaseIdentifier(databaseName, openingOrigin, mainFrameOrigin));
    m_uniqueIDBDatabase->registerConnection(*this);
}

void DatabaseProcessIDBConnection::getOrEstablishIDBDatabaseMetadata(uint64_t requestID)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess getOrEstablishIDBDatabaseMetadata request ID %" PRIu64 " (connection %p)", requestID, this);

    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->getOrEstablishIDBDatabaseMetadata([connection, requestID](bool success, const IDBDatabaseMetadata& metadata) {
        connection->send(Messages::WebIDBServerConnection::DidGetOrEstablishIDBDatabaseMetadata(requestID, success, metadata));
    });
}

void DatabaseProcessIDBConnection::deleteDatabase(uint64_t requestID, const String& databaseName)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess deleteDatabase request ID %" PRIu64 " (connection %p)", requestID, this);

    if (databaseName != m_uniqueIDBDatabase->identifier().databaseName()) {
        LOG_ERROR("Request to delete database name that doesn't match with this database connection's database name");
        send(Messages::WebIDBServerConnection::DidDeleteDatabase(requestID, false));
    }

    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->deleteDatabase([connection, this, requestID](bool success) {
        if (success)
            disconnectedFromWebProcess();

        connection->send(Messages::WebIDBServerConnection::DidDeleteDatabase(requestID, success));
    });
}

void DatabaseProcessIDBConnection::openTransaction(uint64_t requestID, int64_t transactionID, const Vector<int64_t>& objectStoreIDs, uint64_t intMode)
{
    ASSERT(m_uniqueIDBDatabase);

#ifndef NDEBUG
    const char* modeString = nullptr;
    switch (static_cast<IndexedDB::TransactionMode>(intMode)) {
    case IndexedDB::TransactionMode::ReadOnly:
        modeString = "readonly";
        break;
    case IndexedDB::TransactionMode::ReadWrite:
        modeString = "readwrite";
        break;
    case IndexedDB::TransactionMode::VersionChange:
        modeString = "versionchange";
        break;
    }

    LOG(IDB, "DatabaseProcess openTransaction id %" PRIu64 " in mode '%s', request ID %" PRIu64, transactionID, modeString, requestID);
#endif

    if (intMode > IndexedDB::TransactionModeMaximum) {
        send(Messages::WebIDBServerConnection::DidOpenTransaction(requestID, false));
        return;
    }

    IndexedDB::TransactionMode mode = static_cast<IndexedDB::TransactionMode>(intMode);
    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->openTransaction(IDBIdentifier(*this, transactionID), objectStoreIDs, mode, [connection, requestID](bool success) {
        connection->send(Messages::WebIDBServerConnection::DidOpenTransaction(requestID, success));
    });
}

void DatabaseProcessIDBConnection::beginTransaction(uint64_t requestID, int64_t transactionID)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess beginTransaction request ID %" PRIu64, requestID);

    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->beginTransaction(IDBIdentifier(*this, transactionID), [connection, requestID](bool success) {
        connection->send(Messages::WebIDBServerConnection::DidBeginTransaction(requestID, success));
    });
}

void DatabaseProcessIDBConnection::commitTransaction(uint64_t requestID, int64_t transactionID)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess commitTransaction request ID %" PRIu64, requestID);

    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->commitTransaction(IDBIdentifier(*this, transactionID), [connection, requestID](bool success) {
        connection->send(Messages::WebIDBServerConnection::DidCommitTransaction(requestID, success));
    });
}

void DatabaseProcessIDBConnection::resetTransaction(uint64_t requestID, int64_t transactionID)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess resetTransaction request ID %" PRIu64, requestID);

    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->resetTransaction(IDBIdentifier(*this, transactionID), [connection, requestID](bool success) {
        connection->send(Messages::WebIDBServerConnection::DidResetTransaction(requestID, success));
    });
}

void DatabaseProcessIDBConnection::rollbackTransaction(uint64_t requestID, int64_t transactionID)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess rollbackTransaction request ID %" PRIu64, requestID);

    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->rollbackTransaction(IDBIdentifier(*this, transactionID), [connection, requestID](bool success) {
        connection->send(Messages::WebIDBServerConnection::DidRollbackTransaction(requestID, success));
    });
}

void DatabaseProcessIDBConnection::resetTransactionSync(int64_t transactionID, PassRefPtr<Messages::DatabaseProcessIDBConnection::ResetTransactionSync::DelayedReply> prpReply)
{
    RefPtr<Messages::DatabaseProcessIDBConnection::ResetTransactionSync::DelayedReply> reply(prpReply);
    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->resetTransaction(IDBIdentifier(*this, transactionID), [connection, reply](bool success) {
        reply->send(success);
    });
}

void DatabaseProcessIDBConnection::rollbackTransactionSync(int64_t transactionID, PassRefPtr<Messages::DatabaseProcessIDBConnection::RollbackTransactionSync::DelayedReply> prpReply)
{
    RefPtr<Messages::DatabaseProcessIDBConnection::RollbackTransactionSync::DelayedReply> reply(prpReply);
    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->rollbackTransaction(IDBIdentifier(*this, transactionID), [connection, reply](bool success) {
        reply->send(success);
    });
}

void DatabaseProcessIDBConnection::changeDatabaseVersion(uint64_t requestID, int64_t transactionID, uint64_t newVersion)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess changeDatabaseVersion request ID %" PRIu64 ", new version %" PRIu64, requestID, newVersion);

    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->changeDatabaseVersion(IDBIdentifier(*this, transactionID), newVersion, [connection, requestID](bool success) {
        connection->send(Messages::WebIDBServerConnection::DidChangeDatabaseVersion(requestID, success));
    });
}

void DatabaseProcessIDBConnection::createObjectStore(uint64_t requestID, int64_t transactionID, IDBObjectStoreMetadata metadata)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess createObjectStore request ID %" PRIu64 ", object store name '%s'", requestID, metadata.name.utf8().data());
    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->createObjectStore(IDBIdentifier(*this, transactionID), metadata, [connection, requestID](bool success) {
        connection->send(Messages::WebIDBServerConnection::DidCreateObjectStore(requestID, success));
    });
}

void DatabaseProcessIDBConnection::deleteObjectStore(uint64_t requestID, int64_t transactionID, int64_t objectStoreID)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess deleteObjectStore request ID %" PRIu64 ", object store id %" PRIi64, requestID, objectStoreID);
    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->deleteObjectStore(IDBIdentifier(*this, transactionID), objectStoreID, [connection, requestID](bool success) {
        connection->send(Messages::WebIDBServerConnection::DidDeleteObjectStore(requestID, success));
    });
}

void DatabaseProcessIDBConnection::clearObjectStore(uint64_t requestID, int64_t transactionID, int64_t objectStoreID)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess clearObjectStore request ID %" PRIu64 ", object store id %" PRIi64, requestID, objectStoreID);
    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->clearObjectStore(IDBIdentifier(*this, transactionID), objectStoreID, [connection, requestID](bool success) {
        connection->send(Messages::WebIDBServerConnection::DidClearObjectStore(requestID, success));
    });
}

void DatabaseProcessIDBConnection::createIndex(uint64_t requestID, int64_t transactionID, int64_t objectStoreID, const IDBIndexMetadata& metadata)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess createIndex request ID %" PRIu64 ", object store id %" PRIi64, requestID, objectStoreID);
    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->createIndex(IDBIdentifier(*this, transactionID), objectStoreID, metadata, [connection, requestID](bool success) {
        connection->send(Messages::WebIDBServerConnection::DidCreateIndex(requestID, success));
    });
}

void DatabaseProcessIDBConnection::deleteIndex(uint64_t requestID, int64_t transactionID, int64_t objectStoreID, int64_t indexID)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess deleteIndex request ID %" PRIu64 ", object store id %" PRIi64, requestID, objectStoreID);
    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->deleteIndex(IDBIdentifier(*this, transactionID), objectStoreID, indexID, [connection, requestID](bool success) {
        connection->send(Messages::WebIDBServerConnection::DidDeleteIndex(requestID, success));
    });
}

void DatabaseProcessIDBConnection::putRecord(uint64_t requestID, int64_t transactionID, int64_t objectStoreID, const IDBKeyData& key, const IPC::DataReference& value, int64_t putMode, const Vector<int64_t>& indexIDs, const Vector<Vector<IDBKeyData>>& indexKeys)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess putRecord request ID %" PRIu64 ", object store id %" PRIi64, requestID, objectStoreID);
    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->putRecord(IDBIdentifier(*this, transactionID), objectStoreID, key, value, putMode, indexIDs, indexKeys, [connection, requestID](const IDBKeyData& keyData, uint32_t errorCode, const String& errorMessage) {
        connection->send(Messages::WebIDBServerConnection::DidPutRecord(requestID, keyData, errorCode, errorMessage));
    });
}

void DatabaseProcessIDBConnection::getRecord(uint64_t requestID, int64_t transactionID, int64_t objectStoreID, int64_t indexID, const IDBKeyRangeData& keyRange, int64_t cursorType)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess getRecord request ID %" PRIu64 ", object store id %" PRIi64, requestID, objectStoreID);
    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->getRecord(IDBIdentifier(*this, transactionID), objectStoreID, indexID, keyRange, static_cast<IndexedDB::CursorType>(cursorType), [connection, requestID](const IDBGetResult& getResult, uint32_t errorCode, const String& errorMessage) {
        connection->send(Messages::WebIDBServerConnection::DidGetRecord(requestID, getResult, errorCode, errorMessage));
    });
}

void DatabaseProcessIDBConnection::count(uint64_t requestID, int64_t transactionID, int64_t objectStoreID, int64_t indexID, const IDBKeyRangeData& keyRangeData)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess count request ID %" PRIu64 ", object store id %" PRIi64, requestID, objectStoreID);

    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->count(IDBIdentifier(*this, transactionID), objectStoreID, indexID, keyRangeData, [connection, requestID](int64_t count, uint32_t errorCode, const String& errorMessage) {
        connection->send(Messages::WebIDBServerConnection::DidCount(requestID, count, errorCode, errorMessage));
    });
}

void DatabaseProcessIDBConnection::deleteRange(uint64_t requestID, int64_t transactionID, int64_t objectStoreID, const IDBKeyRangeData& keyRangeData)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess deleteRange request ID %" PRIu64 ", object store id %" PRIi64, requestID, objectStoreID);

    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->deleteRange(IDBIdentifier(*this, transactionID), objectStoreID, keyRangeData, [connection, requestID](uint32_t errorCode, const String& errorMessage) {
        connection->send(Messages::WebIDBServerConnection::DidDeleteRange(requestID, errorCode, errorMessage));
    });
}

void DatabaseProcessIDBConnection::openCursor(uint64_t requestID, int64_t transactionID, int64_t objectStoreID, int64_t indexID, int64_t cursorDirection, int64_t cursorType, int64_t taskType, const IDBKeyRangeData& keyRangeData)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess openCursor request ID %" PRIu64 ", object store id %" PRIi64, requestID, objectStoreID);
    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->openCursor(IDBIdentifier(*this, transactionID), objectStoreID, indexID, static_cast<IndexedDB::CursorDirection>(cursorDirection), static_cast<IndexedDB::CursorType>(cursorType), static_cast<IDBDatabaseBackend::TaskType>(taskType), keyRangeData, [connection, requestID](int64_t cursorID, const IDBKeyData& resultKey, const IDBKeyData& primaryKey, PassRefPtr<SharedBuffer> value, uint32_t errorCode, const String& errorMessage) {
        IPC::DataReference data = value ? IPC::DataReference(reinterpret_cast<const uint8_t*>(value->data()), value->size()) : IPC::DataReference();
        connection->send(Messages::WebIDBServerConnection::DidOpenCursor(requestID, cursorID, resultKey, primaryKey, data, errorCode, errorMessage));
    });
}

void DatabaseProcessIDBConnection::cursorAdvance(uint64_t requestID, int64_t cursorID, uint64_t count)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess cursorAdvance request ID %" PRIu64 ", cursor id %" PRIi64, requestID, cursorID);
    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->cursorAdvance(IDBIdentifier(*this, cursorID), count, [connection, requestID](const IDBKeyData& resultKey, const IDBKeyData& primaryKey, PassRefPtr<SharedBuffer> value, uint32_t errorCode, const String& errorMessage) {
        IPC::DataReference data = value ? IPC::DataReference(reinterpret_cast<const uint8_t*>(value->data()), value->size()) : IPC::DataReference();
        connection->send(Messages::WebIDBServerConnection::DidAdvanceCursor(requestID, resultKey, primaryKey, data, errorCode, errorMessage));
    });
}

void DatabaseProcessIDBConnection::cursorIterate(uint64_t requestID, int64_t cursorID, const IDBKeyData& key)
{
    ASSERT(m_uniqueIDBDatabase);

    LOG(IDB, "DatabaseProcess cursorIterate request ID %" PRIu64 ", cursor id %" PRIi64, requestID, cursorID);
    RefPtr<DatabaseProcessIDBConnection> connection(this);
    m_uniqueIDBDatabase->cursorIterate(IDBIdentifier(*this, cursorID), key, [connection, requestID](const IDBKeyData& resultKey, const IDBKeyData& primaryKey, PassRefPtr<SharedBuffer> value, uint32_t errorCode, const String& errorMessage) {
        IPC::DataReference data = value ? IPC::DataReference(reinterpret_cast<const uint8_t*>(value->data()), value->size()) : IPC::DataReference();
        connection->send(Messages::WebIDBServerConnection::DidIterateCursor(requestID, resultKey, primaryKey, data, errorCode, errorMessage));
    });
}

void DatabaseProcessIDBConnection::close()
{
    LOG(IDB, "DatabaseProcessIDBConnection close");

    disconnectedFromWebProcess();
}

IPC::Connection* DatabaseProcessIDBConnection::messageSenderConnection()
{
    return m_connection->connection();
}

} // namespace WebKit

#endif // ENABLE(INDEXED_DATABASE) && ENABLE(DATABASE_PROCESS)