#include "config.h"
#include "Database.h"
#include "ChangeVersionData.h"
#include "ChangeVersionWrapper.h"
#include "DOMWindow.h"
#include "DatabaseAuthorizer.h"
#include "DatabaseCallback.h"
#include "DatabaseContext.h"
#include "DatabaseManager.h"
#include "DatabaseTask.h"
#include "DatabaseThread.h"
#include "DatabaseTracker.h"
#include "Document.h"
#include "ExceptionCode.h"
#include "JSDOMWindow.h"
#include "Logging.h"
#include "SQLError.h"
#include "SQLTransaction.h"
#include "SQLTransactionCallback.h"
#include "SQLTransactionErrorCallback.h"
#include "SQLiteDatabaseTracker.h"
#include "SQLiteStatement.h"
#include "SQLiteTransaction.h"
#include "ScriptExecutionContext.h"
#include "SecurityOrigin.h"
#include "VoidCallback.h"
#include <wtf/NeverDestroyed.h>
#include <wtf/RefPtr.h>
#include <wtf/StdLibExtras.h>
#include <wtf/text/CString.h>
namespace WebCore {
static const char versionKey[] = "WebKitDatabaseVersionKey";
static const char unqualifiedInfoTableName[] = "__WebKitDatabaseInfoTable__";
static const char* fullyQualifiedInfoTableName()
{
static const char qualifier[] = "main.";
static char qualifiedName[sizeof(qualifier) + sizeof(unqualifiedInfoTableName) - 1];
static std::once_flag onceFlag;
std::call_once(onceFlag, [] {
snprintf(qualifiedName, sizeof(qualifiedName), "%s%s", qualifier, unqualifiedInfoTableName);
});
return qualifiedName;
}
static String formatErrorMessage(const char* message, int sqliteErrorCode, const char* sqliteErrorMessage)
{
return String::format("%s (%d %s)", message, sqliteErrorCode, sqliteErrorMessage);
}
static bool setTextValueInDatabase(SQLiteDatabase& db, const String& query, const String& value)
{
SQLiteStatement statement(db, query);
int result = statement.prepare();
if (result != SQLITE_OK) {
LOG_ERROR("Failed to prepare statement to set value in database (%s)", query.ascii().data());
return false;
}
statement.bindText(1, value);
result = statement.step();
if (result != SQLITE_DONE) {
LOG_ERROR("Failed to step statement to set value in database (%s)", query.ascii().data());
return false;
}
return true;
}
static bool retrieveTextResultFromDatabase(SQLiteDatabase& db, const String& query, String& resultString)
{
SQLiteStatement statement(db, query);
int result = statement.prepare();
if (result != SQLITE_OK) {
LOG_ERROR("Error (%i) preparing statement to read text result from database (%s)", result, query.ascii().data());
return false;
}
result = statement.step();
if (result == SQLITE_ROW) {
resultString = statement.getColumnText(0);
return true;
}
if (result == SQLITE_DONE) {
resultString = String();
return true;
}
LOG_ERROR("Error (%i) reading text result from database (%s)", result, query.ascii().data());
return false;
}
static StaticLock guidMutex;
static HashMap<DatabaseGUID, String>& guidToVersionMap()
{
static NeverDestroyed<HashMap<DatabaseGUID, String>> map;
return map;
}
static inline void updateGUIDVersionMap(DatabaseGUID guid, const String& newVersion)
{
guidToVersionMap().set(guid, newVersion.isEmpty() ? String() : newVersion.isolatedCopy());
}
static HashMap<DatabaseGUID, HashSet<Database*>>& guidToDatabaseMap()
{
static NeverDestroyed<HashMap<DatabaseGUID, HashSet<Database*>>> map;
return map;
}
static inline DatabaseGUID guidForOriginAndName(const String& origin, const String& name)
{
static NeverDestroyed<HashMap<String, DatabaseGUID>> map;
return map.get().ensure(makeString(origin, '/', name), [] {
static DatabaseGUID lastUsedGUID;
return ++lastUsedGUID;
}).iterator->value;
}
Database::Database(DatabaseContext& context, const String& name, const String& expectedVersion, const String& displayName, unsigned estimatedSize)
: m_scriptExecutionContext(*context.scriptExecutionContext())
, m_contextThreadSecurityOrigin(m_scriptExecutionContext->securityOrigin()->isolatedCopy())
, m_databaseThreadSecurityOrigin(m_scriptExecutionContext->securityOrigin()->isolatedCopy())
, m_databaseContext(context)
, m_name((name.isNull() ? emptyString() : name).isolatedCopy())
, m_expectedVersion(expectedVersion.isolatedCopy())
, m_displayName(displayName.isolatedCopy())
, m_estimatedSize(estimatedSize)
, m_filename(DatabaseManager::singleton().fullPathForDatabase(*m_scriptExecutionContext->securityOrigin(), m_name))
, m_databaseAuthorizer(DatabaseAuthorizer::create(unqualifiedInfoTableName))
{
{
std::lock_guard<StaticLock> locker(guidMutex);
m_guid = guidForOriginAndName(securityOrigin().securityOrigin()->toString(), name);
guidToDatabaseMap().ensure(m_guid, [] {
return HashSet<Database*>();
}).iterator->value.add(this);
}
m_databaseContext->databaseThread();
ASSERT(m_databaseContext->existingDatabaseThread());
}
DatabaseThread& Database::databaseThread()
{
ASSERT(m_databaseContext->existingDatabaseThread());
return *m_databaseContext->existingDatabaseThread();
}
Database::~Database()
{
if (!m_scriptExecutionContext->isContextThread()) {
auto passedContext = WTFMove(m_scriptExecutionContext);
auto& contextRef = passedContext.get();
contextRef.postTask({ScriptExecutionContext::Task::CleanupTask, [passedContext = WTFMove(passedContext), databaseContext = WTFMove(m_databaseContext)] (ScriptExecutionContext& context) {
ASSERT_UNUSED(context, &context == passedContext.ptr());
}});
}
ASSERT(!m_opened);
}
ExceptionOr<void> Database::openAndVerifyVersion(bool setVersionInNewDatabase)
{
DatabaseTaskSynchronizer synchronizer;
auto& thread = databaseThread();
if (thread.terminationRequested(&synchronizer))
return Exception { INVALID_STATE_ERR };
ExceptionOr<void> result;
auto task = std::make_unique<DatabaseOpenTask>(*this, setVersionInNewDatabase, synchronizer, result);
thread.scheduleImmediateTask(WTFMove(task));
synchronizer.waitForTaskCompletion();
return result;
}
void Database::interrupt()
{
m_sqliteDatabase.interrupt();
}
void Database::close()
{
auto& thread = databaseThread();
DatabaseTaskSynchronizer synchronizer;
if (thread.terminationRequested(&synchronizer)) {
LOG(StorageAPI, "Database handle %p is on a terminated DatabaseThread, cannot be marked for normal closure\n", this);
return;
}
thread.scheduleImmediateTask(std::make_unique<DatabaseCloseTask>(*this, synchronizer));
synchronizer.waitForTaskCompletion();
}
void Database::performClose()
{
ASSERT(currentThread() == databaseThread().getThreadID());
{
LockHolder locker(m_transactionInProgressMutex);
while (!m_transactionQueue.isEmpty())
m_transactionQueue.takeFirst()->notifyDatabaseThreadIsShuttingDown();
m_isTransactionQueueEnabled = false;
m_transactionInProgress = false;
}
closeDatabase();
Ref<Database> protectedThis(*this);
auto& thread = databaseThread();
thread.recordDatabaseClosed(*this);
thread.unscheduleDatabaseTasks(*this);
}
class DoneCreatingDatabaseOnExitCaller {
public:
DoneCreatingDatabaseOnExitCaller(Database& database)
: m_database(database)
{
}
~DoneCreatingDatabaseOnExitCaller()
{
DatabaseTracker::singleton().doneCreatingDatabase(m_database);
}
private:
Database& m_database;
};
ExceptionOr<void> Database::performOpenAndVerify(bool shouldSetVersionInNewDatabase)
{
DoneCreatingDatabaseOnExitCaller onExitCaller(*this);
const int maxSqliteBusyWaitTime = 30000;
#if PLATFORM(IOS)
{
LockHolder locker(DatabaseTracker::openDatabaseMutex());
}
#endif
SQLiteTransactionInProgressAutoCounter transactionCounter;
if (!m_sqliteDatabase.open(m_filename, true))
return Exception { INVALID_STATE_ERR, formatErrorMessage("unable to open database", m_sqliteDatabase.lastError(), m_sqliteDatabase.lastErrorMsg()) };
if (!m_sqliteDatabase.turnOnIncrementalAutoVacuum())
LOG_ERROR("Unable to turn on incremental auto-vacuum (%d %s)", m_sqliteDatabase.lastError(), m_sqliteDatabase.lastErrorMsg());
m_sqliteDatabase.setBusyTimeout(maxSqliteBusyWaitTime);
String currentVersion;
{
std::lock_guard<StaticLock> locker(guidMutex);
auto entry = guidToVersionMap().find(m_guid);
if (entry != guidToVersionMap().end()) {
currentVersion = entry->value.isNull() ? emptyString() : entry->value.isolatedCopy();
LOG(StorageAPI, "Current cached version for guid %i is %s", m_guid, currentVersion.ascii().data());
} else {
LOG(StorageAPI, "No cached version for guid %i", m_guid);
SQLiteTransaction transaction(m_sqliteDatabase);
transaction.begin();
if (!transaction.inProgress()) {
String message = formatErrorMessage("unable to open database, failed to start transaction", m_sqliteDatabase.lastError(), m_sqliteDatabase.lastErrorMsg());
m_sqliteDatabase.close();
return Exception { INVALID_STATE_ERR, WTFMove(message) };
}
String tableName(unqualifiedInfoTableName);
if (!m_sqliteDatabase.tableExists(tableName)) {
m_new = true;
if (!m_sqliteDatabase.executeCommand("CREATE TABLE " + tableName + " (key TEXT NOT NULL ON CONFLICT FAIL UNIQUE ON CONFLICT REPLACE,value TEXT NOT NULL ON CONFLICT FAIL);")) {
String message = formatErrorMessage("unable to open database, failed to create 'info' table", m_sqliteDatabase.lastError(), m_sqliteDatabase.lastErrorMsg());
transaction.rollback();
m_sqliteDatabase.close();
return Exception { INVALID_STATE_ERR, WTFMove(message) };
}
} else if (!getVersionFromDatabase(currentVersion, false)) {
String message = formatErrorMessage("unable to open database, failed to read current version", m_sqliteDatabase.lastError(), m_sqliteDatabase.lastErrorMsg());
transaction.rollback();
m_sqliteDatabase.close();
return Exception { INVALID_STATE_ERR, WTFMove(message) };
}
if (currentVersion.length()) {
LOG(StorageAPI, "Retrieved current version %s from database %s", currentVersion.ascii().data(), databaseDebugName().ascii().data());
} else if (!m_new || shouldSetVersionInNewDatabase) {
LOG(StorageAPI, "Setting version %s in database %s that was just created", m_expectedVersion.ascii().data(), databaseDebugName().ascii().data());
if (!setVersionInDatabase(m_expectedVersion, false)) {
String message = formatErrorMessage("unable to open database, failed to write current version", m_sqliteDatabase.lastError(), m_sqliteDatabase.lastErrorMsg());
transaction.rollback();
m_sqliteDatabase.close();
return Exception { INVALID_STATE_ERR, WTFMove(message) };
}
currentVersion = m_expectedVersion;
}
updateGUIDVersionMap(m_guid, currentVersion);
transaction.commit();
}
}
if (currentVersion.isNull()) {
LOG(StorageAPI, "Database %s does not have its version set", databaseDebugName().ascii().data());
currentVersion = emptyString();
}
if ((!m_new || shouldSetVersionInNewDatabase) && m_expectedVersion.length() && m_expectedVersion != currentVersion) {
m_sqliteDatabase.close();
return Exception { INVALID_STATE_ERR, "unable to open database, version mismatch, '" + m_expectedVersion + "' does not match the currentVersion of '" + currentVersion + "'" };
}
m_sqliteDatabase.setAuthorizer(m_databaseAuthorizer.get());
DatabaseTracker::singleton().addOpenDatabase(*this);
m_opened = true;
if (m_new && !shouldSetVersionInNewDatabase)
m_expectedVersion = emptyString();
databaseThread().recordDatabaseOpen(*this);
return { };
}
void Database::closeDatabase()
{
if (!m_opened)
return;
m_sqliteDatabase.close();
m_opened = false;
DatabaseTracker::singleton().removeOpenDatabase(*this);
{
std::lock_guard<StaticLock> locker(guidMutex);
auto it = guidToDatabaseMap().find(m_guid);
ASSERT(it != guidToDatabaseMap().end());
ASSERT(it->value.contains(this));
it->value.remove(this);
if (it->value.isEmpty()) {
guidToDatabaseMap().remove(it);
guidToVersionMap().remove(m_guid);
}
}
}
bool Database::getVersionFromDatabase(String& version, bool shouldCacheVersion)
{
String query(String("SELECT value FROM ") + fullyQualifiedInfoTableName() + " WHERE key = '" + versionKey + "';");
m_databaseAuthorizer->disable();
bool result = retrieveTextResultFromDatabase(m_sqliteDatabase, query, version);
if (result) {
if (shouldCacheVersion)
setCachedVersion(version);
} else
LOG_ERROR("Failed to retrieve version from database %s", databaseDebugName().ascii().data());
m_databaseAuthorizer->enable();
return result;
}
bool Database::setVersionInDatabase(const String& version, bool shouldCacheVersion)
{
String query(String("INSERT INTO ") + fullyQualifiedInfoTableName() + " (key, value) VALUES ('" + versionKey + "', ?);");
m_databaseAuthorizer->disable();
bool result = setTextValueInDatabase(m_sqliteDatabase, query, version);
if (result) {
if (shouldCacheVersion)
setCachedVersion(version);
} else
LOG_ERROR("Failed to set version %s in database (%s)", version.ascii().data(), query.ascii().data());
m_databaseAuthorizer->enable();
return result;
}
void Database::setExpectedVersion(const String& version)
{
m_expectedVersion = version.isolatedCopy();
}
String Database::getCachedVersion() const
{
std::lock_guard<StaticLock> locker(guidMutex);
return guidToVersionMap().get(m_guid).isolatedCopy();
}
void Database::setCachedVersion(const String& actualVersion)
{
std::lock_guard<StaticLock> locker(guidMutex);
updateGUIDVersionMap(m_guid, actualVersion);
}
bool Database::getActualVersionForTransaction(String &actualVersion)
{
ASSERT(m_sqliteDatabase.transactionInProgress());
return getVersionFromDatabase(actualVersion, true);
}
void Database::scheduleTransaction()
{
ASSERT(!m_transactionInProgressMutex.tryLock());
if (!m_isTransactionQueueEnabled || m_transactionQueue.isEmpty()) {
m_transactionInProgress = false;
return;
}
m_transactionInProgress = true;
auto transaction = m_transactionQueue.takeFirst();
auto task = std::make_unique<DatabaseTransactionTask>(WTFMove(transaction));
LOG(StorageAPI, "Scheduling DatabaseTransactionTask %p for transaction %p\n", task.get(), task->transaction());
databaseThread().scheduleTask(WTFMove(task));
}
void Database::scheduleTransactionStep(SQLTransaction& transaction)
{
auto& thread = databaseThread();
auto task = std::make_unique<DatabaseTransactionTask>(&transaction);
LOG(StorageAPI, "Scheduling DatabaseTransactionTask %p for the transaction step\n", task.get());
thread.scheduleTask(WTFMove(task));
}
void Database::inProgressTransactionCompleted()
{
LockHolder locker(m_transactionInProgressMutex);
m_transactionInProgress = false;
scheduleTransaction();
}
bool Database::hasPendingTransaction()
{
LockHolder locker(m_transactionInProgressMutex);
return m_transactionInProgress || !m_transactionQueue.isEmpty();
}
SQLTransactionCoordinator* Database::transactionCoordinator()
{
return databaseThread().transactionCoordinator();
}
String Database::version() const
{
if (m_deleted)
return String();
return getCachedVersion();
}
void Database::markAsDeletedAndClose()
{
if (m_deleted)
return;
LOG(StorageAPI, "Marking %s (%p) as deleted", stringIdentifier().ascii().data(), this);
m_deleted = true;
close();
}
void Database::changeVersion(const String& oldVersion, const String& newVersion, RefPtr<SQLTransactionCallback>&& callback, RefPtr<SQLTransactionErrorCallback>&& errorCallback, RefPtr<VoidCallback>&& successCallback)
{
runTransaction(WTFMove(callback), WTFMove(errorCallback), WTFMove(successCallback), ChangeVersionWrapper::create(oldVersion, newVersion), false);
}
void Database::transaction(RefPtr<SQLTransactionCallback>&& callback, RefPtr<SQLTransactionErrorCallback>&& errorCallback, RefPtr<VoidCallback>&& successCallback)
{
runTransaction(WTFMove(callback), WTFMove(errorCallback), WTFMove(successCallback), nullptr, false);
}
void Database::readTransaction(RefPtr<SQLTransactionCallback>&& callback, RefPtr<SQLTransactionErrorCallback>&& errorCallback, RefPtr<VoidCallback>&& successCallback)
{
runTransaction(WTFMove(callback), WTFMove(errorCallback), WTFMove(successCallback), nullptr, true);
}
String Database::stringIdentifier() const
{
return m_name.isolatedCopy();
}
String Database::displayName() const
{
return m_displayName.isolatedCopy();
}
unsigned Database::estimatedSize() const
{
return m_estimatedSize;
}
String Database::fileName() const
{
return m_filename.isolatedCopy();
}
DatabaseDetails Database::details() const
{
return DatabaseDetails(stringIdentifier(), displayName(), estimatedSize(), 0, 0, 0);
}
void Database::disableAuthorizer()
{
m_databaseAuthorizer->disable();
}
void Database::enableAuthorizer()
{
m_databaseAuthorizer->enable();
}
void Database::setAuthorizerPermissions(int permissions)
{
m_databaseAuthorizer->setPermissions(permissions);
}
bool Database::lastActionChangedDatabase()
{
return m_databaseAuthorizer->lastActionChangedDatabase();
}
bool Database::lastActionWasInsert()
{
return m_databaseAuthorizer->lastActionWasInsert();
}
void Database::resetDeletes()
{
m_databaseAuthorizer->resetDeletes();
}
bool Database::hadDeletes()
{
return m_databaseAuthorizer->hadDeletes();
}
void Database::resetAuthorizer()
{
m_databaseAuthorizer->reset();
}
void Database::runTransaction(RefPtr<SQLTransactionCallback>&& callback, RefPtr<SQLTransactionErrorCallback>&& errorCallback, RefPtr<VoidCallback>&& successCallback, RefPtr<SQLTransactionWrapper>&& wrapper, bool readOnly)
{
LockHolder locker(m_transactionInProgressMutex);
if (!m_isTransactionQueueEnabled) {
if (errorCallback) {
RefPtr<SQLTransactionErrorCallback> errorCallbackProtector = WTFMove(errorCallback);
m_scriptExecutionContext->postTask([errorCallbackProtector](ScriptExecutionContext&) {
errorCallbackProtector->handleEvent(SQLError::create(SQLError::UNKNOWN_ERR, "database has been closed"));
});
}
return;
}
m_transactionQueue.append(SQLTransaction::create(*this, WTFMove(callback), WTFMove(successCallback), errorCallback.copyRef(), WTFMove(wrapper), readOnly));
if (!m_transactionInProgress)
scheduleTransaction();
}
void Database::scheduleTransactionCallback(SQLTransaction* transaction)
{
RefPtr<SQLTransaction> transactionProtector(transaction);
m_scriptExecutionContext->postTask([transactionProtector] (ScriptExecutionContext&) {
transactionProtector->performPendingCallback();
});
}
Vector<String> Database::performGetTableNames()
{
disableAuthorizer();
SQLiteStatement statement(sqliteDatabase(), "SELECT name FROM sqlite_master WHERE type='table';");
if (statement.prepare() != SQLITE_OK) {
LOG_ERROR("Unable to retrieve list of tables for database %s", databaseDebugName().ascii().data());
enableAuthorizer();
return Vector<String>();
}
Vector<String> tableNames;
int result;
while ((result = statement.step()) == SQLITE_ROW) {
String name = statement.getColumnText(0);
if (name != unqualifiedInfoTableName)
tableNames.append(name);
}
enableAuthorizer();
if (result != SQLITE_DONE) {
LOG_ERROR("Error getting tables for database %s", databaseDebugName().ascii().data());
return Vector<String>();
}
return tableNames;
}
void Database::incrementalVacuumIfNeeded()
{
SQLiteTransactionInProgressAutoCounter transactionCounter;
int64_t freeSpaceSize = m_sqliteDatabase.freeSpaceSize();
int64_t totalSize = m_sqliteDatabase.totalSize();
if (totalSize <= 10 * freeSpaceSize) {
int result = m_sqliteDatabase.runIncrementalVacuumCommand();
if (result != SQLITE_OK)
logErrorMessage(formatErrorMessage("error vacuuming database", result, m_sqliteDatabase.lastErrorMsg()));
}
}
void Database::logErrorMessage(const String& message)
{
m_scriptExecutionContext->addConsoleMessage(MessageSource::Storage, MessageLevel::Error, message);
}
Vector<String> Database::tableNames()
{
Vector<String> result;
DatabaseTaskSynchronizer synchronizer;
auto& thread = databaseThread();
if (thread.terminationRequested(&synchronizer))
return result;
auto task = std::make_unique<DatabaseTableNamesTask>(*this, synchronizer, result);
thread.scheduleImmediateTask(WTFMove(task));
synchronizer.waitForTaskCompletion();
return result;
}
SecurityOriginData Database::securityOrigin()
{
if (m_scriptExecutionContext->isContextThread())
return SecurityOriginData::fromSecurityOrigin(m_contextThreadSecurityOrigin.get());
if (currentThread() == databaseThread().getThreadID())
return SecurityOriginData::fromSecurityOrigin(m_databaseThreadSecurityOrigin.get());
RELEASE_ASSERT_NOT_REACHED();
}
unsigned long long Database::maximumSize()
{
return DatabaseTracker::singleton().maximumSize(*this);
}
void Database::didCommitWriteTransaction()
{
DatabaseTracker::singleton().scheduleNotifyDatabaseChanged(securityOrigin(), stringIdentifier());
}
bool Database::didExceedQuota()
{
ASSERT(databaseContext().scriptExecutionContext()->isContextThread());
auto& tracker = DatabaseTracker::singleton();
auto oldQuota = tracker.quota(securityOrigin());
databaseContext().databaseExceededQuota(stringIdentifier(), details());
return tracker.quota(securityOrigin()) > oldQuota;
}
#if !LOG_DISABLED || !ERROR_DISABLED
String Database::databaseDebugName() const
{
return m_contextThreadSecurityOrigin->toString() + "::" + m_name;
}
#endif
}