SQLiteIDBCursor.cpp [plain text]
#include "config.h"
#include "SQLiteIDBCursor.h"
#if ENABLE(INDEXED_DATABASE) && ENABLE(DATABASE_PROCESS)
#include "IDBSerialization.h"
#include "Logging.h"
#include "SQLiteIDBTransaction.h"
#include <WebCore/SQLiteStatement.h>
#include <WebCore/SQLiteTransaction.h>
#include <sqlite3.h>
using namespace WebCore;
namespace WebKit {
std::unique_ptr<SQLiteIDBCursor> SQLiteIDBCursor::maybeCreate(SQLiteIDBTransaction* transaction, const IDBIdentifier& cursorIdentifier, int64_t objectStoreID, int64_t indexID, IndexedDB::CursorDirection cursorDirection, IndexedDB::CursorType cursorType, IDBDatabaseBackend::TaskType taskType, const IDBKeyRangeData& keyRange)
{
auto cursor = std::unique_ptr<SQLiteIDBCursor>(new SQLiteIDBCursor(transaction, cursorIdentifier, objectStoreID, indexID, cursorDirection, cursorType, taskType, keyRange));
if (!cursor->establishStatement())
return nullptr;
if (!cursor->advance(1))
return nullptr;
return cursor;
}
SQLiteIDBCursor::SQLiteIDBCursor(SQLiteIDBTransaction* transaction, const IDBIdentifier& cursorIdentifier, int64_t objectStoreID, int64_t indexID, IndexedDB::CursorDirection cursorDirection, IndexedDB::CursorType, IDBDatabaseBackend::TaskType, const IDBKeyRangeData& keyRange)
: m_transaction(transaction)
, m_cursorIdentifier(cursorIdentifier)
, m_objectStoreID(objectStoreID)
, m_indexID(indexID)
, m_cursorDirection(cursorDirection)
, m_keyRange(keyRange)
, m_currentRecordID(-1)
, m_statementNeedsReset(false)
, m_boundID(0)
, m_completed(false)
, m_errored(false)
{
ASSERT(m_objectStoreID);
}
static const String& getIndexStatement(bool hasLowerKey, bool isLowerOpen, bool hasUpperKey, bool isUpperOpen, bool descending, bool unique)
{
DEPRECATED_DEFINE_STATIC_LOCAL(Vector<String>, indexStatements, ());
if (indexStatements.isEmpty()) {
indexStatements.reserveInitialCapacity(12);
indexStatements.uncheckedAppend(ASCIILiteral("SELECT rowid, key, value FROM IndexRecords WHERE indexID = ? AND key > CAST(? AS TEXT) AND key < CAST(? AS TEXT) ORDER BY key, value;"));
indexStatements.uncheckedAppend(ASCIILiteral("SELECT rowid, key, value FROM IndexRecords WHERE indexID = ? AND key > CAST(? AS TEXT) AND key < CAST(? AS TEXT) ORDER BY key DESC, value DESC;"));
indexStatements.uncheckedAppend(ASCIILiteral("SELECT rowid, key, value FROM IndexRecords WHERE indexID = ? AND key > CAST(? AS TEXT) AND key < CAST(? AS TEXT) ORDER BY key DESC, value;"));
indexStatements.uncheckedAppend(ASCIILiteral("SELECT rowid, key, value FROM IndexRecords WHERE indexID = ? AND key > CAST(? AS TEXT) AND key <= CAST(? AS TEXT) ORDER BY key, value;"));
indexStatements.uncheckedAppend(ASCIILiteral("SELECT rowid, key, value FROM IndexRecords WHERE indexID = ? AND key > CAST(? AS TEXT) AND key <= CAST(? AS TEXT) ORDER BY key DESC, value DESC;"));
indexStatements.uncheckedAppend(ASCIILiteral("SELECT rowid, key, value FROM IndexRecords WHERE indexID = ? AND key > CAST(? AS TEXT) AND key <= CAST(? AS TEXT) ORDER BY key DESC, value;"));
indexStatements.uncheckedAppend(ASCIILiteral("SELECT rowid, key, value FROM IndexRecords WHERE indexID = ? AND key >= CAST(? AS TEXT) AND key < CAST(? AS TEXT) ORDER BY key, value;"));
indexStatements.uncheckedAppend(ASCIILiteral("SELECT rowid, key, value FROM IndexRecords WHERE indexID = ? AND key >= CAST(? AS TEXT) AND key < CAST(? AS TEXT) ORDER BY key DESC, value DESC;"));
indexStatements.uncheckedAppend(ASCIILiteral("SELECT rowid, key, value FROM IndexRecords WHERE indexID = ? AND key >= CAST(? AS TEXT) AND key < CAST(? AS TEXT) ORDER BY key DESC, value;"));
indexStatements.uncheckedAppend(ASCIILiteral("SELECT rowid, key, value FROM IndexRecords WHERE indexID = ? AND key >= CAST(? AS TEXT) AND key <= CAST(? AS TEXT) ORDER BY key, value;"));
indexStatements.uncheckedAppend(ASCIILiteral("SELECT rowid, key, value FROM IndexRecords WHERE indexID = ? AND key >= CAST(? AS TEXT) AND key <= CAST(? AS TEXT) ORDER BY key DESC, value DESC;"));
indexStatements.uncheckedAppend(ASCIILiteral("SELECT rowid, key, value FROM IndexRecords WHERE indexID = ? AND key >= CAST(? AS TEXT) AND key <= CAST(? AS TEXT) ORDER BY key DESC, value;"));
}
size_t i = 0;
if (hasLowerKey && !isLowerOpen)
i += 6;
if (hasUpperKey && !isUpperOpen)
i += 3;
if (descending) {
if (!unique)
i += 1;
else
i += 2;
}
return indexStatements[i];
}
static const String& getObjectStoreStatement(bool hasLowerKey, bool isLowerOpen, bool hasUpperKey, bool isUpperOpen, bool descending)
{
DEPRECATED_DEFINE_STATIC_LOCAL(Vector<String>, statements, ());
if (statements.isEmpty()) {
statements.reserveCapacity(8);
statements.append(ASCIILiteral("SELECT rowid, key, value FROM Records WHERE objectStoreID = ? AND key > CAST(? AS TEXT) AND key < CAST(? AS TEXT) ORDER BY key;"));
statements.append(ASCIILiteral("SELECT rowid, key, value FROM Records WHERE objectStoreID = ? AND key > CAST(? AS TEXT) AND key < CAST(? AS TEXT) ORDER BY key DESC;"));
statements.append(ASCIILiteral("SELECT rowid, key, value FROM Records WHERE objectStoreID = ? AND key > CAST(? AS TEXT) AND key <= CAST(? AS TEXT) ORDER BY key;"));
statements.append(ASCIILiteral("SELECT rowid, key, value FROM Records WHERE objectStoreID = ? AND key > CAST(? AS TEXT) AND key <= CAST(? AS TEXT) ORDER BY key DESC;"));
statements.append(ASCIILiteral("SELECT rowid, key, value FROM Records WHERE objectStoreID = ? AND key >= CAST(? AS TEXT) AND key < CAST(? AS TEXT) ORDER BY key;"));
statements.append(ASCIILiteral("SELECT rowid, key, value FROM Records WHERE objectStoreID = ? AND key >= CAST(? AS TEXT) AND key < CAST(? AS TEXT) ORDER BY key DESC;"));
statements.append(ASCIILiteral("SELECT rowid, key, value FROM Records WHERE objectStoreID = ? AND key >= CAST(? AS TEXT) AND key <= CAST(? AS TEXT) ORDER BY key;"));
statements.append(ASCIILiteral("SELECT rowid, key, value FROM Records WHERE objectStoreID = ? AND key >= CAST(? AS TEXT) AND key <= CAST(? AS TEXT) ORDER BY key DESC;"));
}
size_t i = 0;
if (hasLowerKey && !isLowerOpen)
i += 4;
if (hasUpperKey && !isUpperOpen)
i += 2;
if (descending)
i += 1;
return statements[i];
}
bool SQLiteIDBCursor::establishStatement()
{
ASSERT(!m_statement);
String sql;
if (m_indexID != IDBIndexMetadata::InvalidId) {
sql = getIndexStatement(!m_keyRange.lowerKey.isNull, m_keyRange.lowerOpen, !m_keyRange.upperKey.isNull, m_keyRange.upperOpen, m_cursorDirection == IndexedDB::CursorDirection::Prev || m_cursorDirection == IndexedDB::CursorDirection::PrevNoDuplicate, m_cursorDirection == IndexedDB::CursorDirection::NextNoDuplicate || m_cursorDirection == IndexedDB::CursorDirection::PrevNoDuplicate);
m_boundID = m_indexID;
} else {
sql = getObjectStoreStatement(!m_keyRange.lowerKey.isNull, m_keyRange.lowerOpen, !m_keyRange.upperKey.isNull, m_keyRange.upperOpen, m_cursorDirection == IndexedDB::CursorDirection::Prev || m_cursorDirection == IndexedDB::CursorDirection::PrevNoDuplicate);
m_boundID = m_objectStoreID;
}
m_currentLowerKey = m_keyRange.lowerKey.isNull ? IDBKeyData::minimum() : m_keyRange.lowerKey;
m_currentUpperKey = m_keyRange.upperKey.isNull ? IDBKeyData::maximum() : m_keyRange.upperKey;
return createSQLiteStatement(sql);
}
bool SQLiteIDBCursor::createSQLiteStatement(const String& sql)
{
LOG(IDB, "Creating cursor with SQL query: \"%s\"", sql.utf8().data());
ASSERT(!m_currentLowerKey.isNull);
ASSERT(!m_currentUpperKey.isNull);
ASSERT(m_transaction->sqliteTransaction());
m_statement = std::make_unique<SQLiteStatement>(m_transaction->sqliteTransaction()->database(), sql);
if (m_statement->prepare() != SQLResultOk) {
LOG_ERROR("Could not create cursor statement (prepare/id) - '%s'", m_transaction->sqliteTransaction()->database().lastErrorMsg());
return false;
}
return bindArguments();
}
void SQLiteIDBCursor::objectStoreRecordsChanged()
{
m_statementNeedsReset = true;
}
void SQLiteIDBCursor::resetAndRebindStatement()
{
ASSERT(!m_currentLowerKey.isNull);
ASSERT(!m_currentUpperKey.isNull);
ASSERT(m_transaction->sqliteTransaction());
ASSERT(m_statement);
ASSERT(m_statementNeedsReset);
m_statementNeedsReset = false;
if (m_currentKey.isNull)
return;
if (m_cursorDirection == IndexedDB::CursorDirection::Next || m_cursorDirection == IndexedDB::CursorDirection::NextNoDuplicate)
m_currentLowerKey = m_currentKey;
else
m_currentUpperKey = m_currentKey;
if (m_statement->reset() != SQLResultOk) {
LOG_ERROR("Could not reset cursor statement to respond to object store changes");
return;
}
bindArguments();
}
bool SQLiteIDBCursor::bindArguments()
{
if (m_statement->bindInt64(1, m_boundID) != SQLResultOk) {
LOG_ERROR("Could not bind id argument (bound ID)");
return false;
}
RefPtr<SharedBuffer> buffer = serializeIDBKeyData(m_currentLowerKey);
if (m_statement->bindBlob(2, buffer->data(), buffer->size()) != SQLResultOk) {
LOG_ERROR("Could not create cursor statement (lower key)");
return false;
}
buffer = serializeIDBKeyData(m_currentUpperKey);
if (m_statement->bindBlob(3, buffer->data(), buffer->size()) != SQLResultOk) {
LOG_ERROR("Could not create cursor statement (upper key)");
return false;
}
return true;
}
bool SQLiteIDBCursor::advance(uint64_t count)
{
bool isUnique = m_cursorDirection == IndexedDB::CursorDirection::NextNoDuplicate || m_cursorDirection == IndexedDB::CursorDirection::PrevNoDuplicate;
for (uint64_t i = 0; i < count; ++i) {
if (!isUnique) {
if (!advanceOnce())
return false;
} else {
if (!advanceUnique())
return false;
}
}
return true;
}
bool SQLiteIDBCursor::advanceUnique()
{
IDBKeyData currentKey = m_currentKey;
while (!m_completed) {
if (!advanceOnce())
return false;
if (currentKey.compare(m_currentKey))
return true;
}
return false;
}
bool SQLiteIDBCursor::advanceOnce()
{
if (m_statementNeedsReset)
resetAndRebindStatement();
AdvanceResult result;
do {
result = internalAdvanceOnce();
} while (result == AdvanceResult::ShouldAdvanceAgain);
return result == AdvanceResult::Success;
}
SQLiteIDBCursor::AdvanceResult SQLiteIDBCursor::internalAdvanceOnce()
{
ASSERT(m_transaction->sqliteTransaction());
ASSERT(m_statement);
if (m_completed) {
LOG_ERROR("Attempt to advance a completed cursor");
return AdvanceResult::Failure;
}
int result = m_statement->step();
if (result == SQLResultDone) {
m_completed = true;
m_currentKey = IDBKeyData();
m_currentPrimaryKey = IDBKeyData();
m_currentValueBuffer.clear();
return AdvanceResult::Success;
}
if (result != SQLResultRow) {
LOG_ERROR("Error advancing cursor - (%i) %s", result, m_transaction->sqliteTransaction()->database().lastErrorMsg());
m_completed = true;
m_errored = true;
return AdvanceResult::Failure;
}
int64_t recordID = m_statement->getColumnInt64(0);
if (recordID == m_currentRecordID)
return AdvanceResult::ShouldAdvanceAgain;
m_currentRecordID = recordID;
Vector<uint8_t> keyData;
m_statement->getColumnBlobAsVector(1, keyData);
if (!deserializeIDBKeyData(keyData.data(), keyData.size(), m_currentKey)) {
LOG_ERROR("Unable to deserialize key data from database while advancing cursor");
m_completed = true;
m_errored = true;
return AdvanceResult::Failure;
}
m_statement->getColumnBlobAsVector(2, keyData);
m_currentValueBuffer = keyData;
if (m_indexID == IDBIndexMetadata::InvalidId)
m_currentPrimaryKey = m_currentKey;
else {
if (!deserializeIDBKeyData(keyData.data(), keyData.size(), m_currentPrimaryKey)) {
LOG_ERROR("Unable to deserialize value data from database while advancing index cursor");
m_completed = true;
m_errored = true;
return AdvanceResult::Failure;
}
SQLiteStatement objectStoreStatement(*m_statement->database(), "SELECT value FROM Records WHERE key = CAST(? AS TEXT) and objectStoreID = ?;");
if (objectStoreStatement.prepare() != SQLResultOk
|| objectStoreStatement.bindBlob(1, m_currentValueBuffer.data(), m_currentValueBuffer.size()) != SQLResultOk
|| objectStoreStatement.bindInt64(2, m_objectStoreID) != SQLResultOk) {
LOG_ERROR("Could not create index cursor statement into object store records (%i) '%s'", m_statement->database()->lastError(), m_statement->database()->lastErrorMsg());
m_completed = true;
m_errored = true;
return AdvanceResult::Failure;
}
int result = objectStoreStatement.step();
if (result == SQLResultRow)
objectStoreStatement.getColumnBlobAsVector(0, m_currentValueBuffer);
else if (result == SQLResultDone) {
return AdvanceResult::ShouldAdvanceAgain;
} else {
LOG_ERROR("Could not step index cursor statement into object store records (%i) '%s'", m_statement->database()->lastError(), m_statement->database()->lastErrorMsg());
m_completed = true;
m_errored = true;
return AdvanceResult::Failure;
}
}
return AdvanceResult::Success;
}
bool SQLiteIDBCursor::iterate(const WebCore::IDBKeyData& targetKey)
{
ASSERT(m_transaction->sqliteTransaction());
ASSERT(m_statement);
bool result = advance(1);
if (targetKey.isNull || !result)
return result;
while (!m_completed) {
if (!result)
return false;
if (m_cursorDirection == IndexedDB::CursorDirection::Next || m_cursorDirection == IndexedDB::CursorDirection::NextNoDuplicate) {
if (m_currentKey.compare(targetKey) >= 0)
break;
} else if (m_currentKey.compare(targetKey) <= 0)
break;
result = advance(1);
}
return result;
}
}
#endif // ENABLE(INDEXED_DATABASE) && ENABLE(DATABASE_PROCESS)