RegistrationDatabase.cpp [plain text]
#include "config.h"
#include "RegistrationDatabase.h"
#if ENABLE(SERVICE_WORKER)
#include "Logging.h"
#include "RegistrationStore.h"
#include "SQLiteDatabase.h"
#include "SQLiteFileSystem.h"
#include "SQLiteStatement.h"
#include "SQLiteTransaction.h"
#include "SWServer.h"
#include "SecurityOrigin.h"
#include <wtf/CompletionHandler.h>
#include <wtf/CrossThreadCopier.h>
#include <wtf/FileSystem.h>
#include <wtf/MainThread.h>
#include <wtf/NeverDestroyed.h>
#include <wtf/Scope.h>
#include <wtf/persistence/PersistentCoders.h>
#include <wtf/persistence/PersistentDecoder.h>
#include <wtf/persistence/PersistentEncoder.h>
#include <wtf/text/StringConcatenateNumbers.h>
namespace WebCore {
static const uint64_t schemaVersion = 4;
static const String recordsTableSchema(const String& tableName)
{
return makeString("CREATE TABLE ", tableName, " (key TEXT NOT NULL ON CONFLICT FAIL UNIQUE ON CONFLICT REPLACE, origin TEXT NOT NULL ON CONFLICT FAIL, scopeURL TEXT NOT NULL ON CONFLICT FAIL, topOrigin TEXT NOT NULL ON CONFLICT FAIL, lastUpdateCheckTime DOUBLE NOT NULL ON CONFLICT FAIL, updateViaCache TEXT NOT NULL ON CONFLICT FAIL, scriptURL TEXT NOT NULL ON CONFLICT FAIL, script TEXT NOT NULL ON CONFLICT FAIL, workerType TEXT NOT NULL ON CONFLICT FAIL, contentSecurityPolicy BLOB NOT NULL ON CONFLICT FAIL, referrerPolicy TEXT NOT NULL ON CONFLICT FAIL, scriptResourceMap BLOB NOT NULL ON CONFLICT FAIL)");
}
static const String recordsTableSchema()
{
ASSERT(!isMainThread());
static NeverDestroyed<String> schema(recordsTableSchema("Records"));
return schema;
}
static const String recordsTableSchemaAlternate()
{
ASSERT(!isMainThread());
static NeverDestroyed<String> schema(recordsTableSchema("\"Records\""));
return schema;
}
static inline String databaseFilenameFromVersion(uint64_t version)
{
return makeString("ServiceWorkerRegistrations-", version, ".sqlite3");
}
static const String& databaseFilename()
{
ASSERT(isMainThread());
static NeverDestroyed<String> filename = databaseFilenameFromVersion(schemaVersion);
return filename;
}
String serviceWorkerRegistrationDatabaseFilename(const String& databaseDirectory)
{
return FileSystem::pathByAppendingComponent(databaseDirectory, databaseFilename());
}
static inline void cleanOldDatabases(const String& databaseDirectory)
{
for (uint64_t version = 1; version < schemaVersion; ++version)
SQLiteFileSystem::deleteDatabaseFile(FileSystem::pathByAppendingComponent(databaseDirectory, databaseFilenameFromVersion(version)));
}
RegistrationDatabase::RegistrationDatabase(RegistrationStore& store, String&& databaseDirectory)
: m_workQueue(WorkQueue::create("ServiceWorker I/O Thread", WorkQueue::Type::Serial))
, m_store(makeWeakPtr(store))
, m_databaseDirectory(WTFMove(databaseDirectory))
, m_databaseFilePath(FileSystem::pathByAppendingComponent(m_databaseDirectory, databaseFilename()))
{
ASSERT(isMainThread());
postTaskToWorkQueue([this] {
importRecordsIfNecessary();
});
}
RegistrationDatabase::~RegistrationDatabase()
{
ASSERT(isMainThread());
if (m_database)
m_workQueue->dispatch([database = WTFMove(m_database)] { });
}
void RegistrationDatabase::postTaskToWorkQueue(Function<void()>&& task)
{
ASSERT(isMainThread());
m_workQueue->dispatch([protectedThis = makeRef(*this), task = WTFMove(task)]() mutable {
task();
});
}
void RegistrationDatabase::openSQLiteDatabase(const String& fullFilename)
{
ASSERT(!isMainThread());
ASSERT(!m_database);
auto databaseDirectory = this->databaseDirectoryIsolatedCopy();
cleanOldDatabases(databaseDirectory);
LOG(ServiceWorker, "ServiceWorker RegistrationDatabase opening file %s", fullFilename.utf8().data());
SQLiteFileSystem::ensureDatabaseDirectoryExists(databaseDirectory);
m_database = makeUnique<SQLiteDatabase>();
if (!m_database->open(fullFilename)) {
RELEASE_LOG_ERROR(ServiceWorker, "Failed to open Service Worker registration database");
m_database = nullptr;
callOnMainThread([this, protectedThis = makeRef(*this)] {
databaseFailedToOpen();
});
return;
}
m_database->disableThreadingChecks();
auto doRecoveryAttempt = [&] {
m_database = nullptr;
SQLiteFileSystem::deleteDatabaseFile(fullFilename);
openSQLiteDatabase(fullFilename);
};
String errorMessage = ensureValidRecordsTable();
if (!errorMessage.isNull()) {
RELEASE_LOG_ERROR(ServiceWorker, "ensureValidRecordsTable failed, reason: %{public}s", errorMessage.utf8().data());
doRecoveryAttempt();
return;
}
errorMessage = importRecords();
if (!errorMessage.isNull()) {
RELEASE_LOG_ERROR(ServiceWorker, "importRecords failed, reason: %{public}s", errorMessage.utf8().data());
doRecoveryAttempt();
return;
}
}
void RegistrationDatabase::importRecordsIfNecessary()
{
ASSERT(!isMainThread());
if (FileSystem::fileExists(m_databaseFilePath))
openSQLiteDatabase(m_databaseFilePath);
callOnMainThread([protectedThis = makeRef(*this)] {
protectedThis->databaseOpenedAndRecordsImported();
});
}
String RegistrationDatabase::ensureValidRecordsTable()
{
ASSERT(!isMainThread());
ASSERT(m_database);
ASSERT(m_database->isOpen());
String currentSchema;
{
SQLiteStatement statement(*m_database, "SELECT type, sql FROM sqlite_master WHERE tbl_name='Records'");
if (statement.prepare() != SQLITE_OK)
return "Unable to prepare statement to fetch schema for the Records table.";
int sqliteResult = statement.step();
if (sqliteResult == SQLITE_DONE) {
if (!m_database->executeCommand(recordsTableSchema()))
return makeString("Could not create Records table in database (", m_database->lastError(), ") - ", m_database->lastErrorMsg());
return { };
}
if (sqliteResult != SQLITE_ROW)
return "Error executing statement to fetch schema for the Records table.";
currentSchema = statement.getColumnText(1);
}
ASSERT(!currentSchema.isEmpty());
if (currentSchema == recordsTableSchema() || currentSchema == recordsTableSchemaAlternate())
return { };
return makeString("Unexpected schema: ", currentSchema);
}
static String updateViaCacheToString(ServiceWorkerUpdateViaCache update)
{
switch (update) {
case ServiceWorkerUpdateViaCache::Imports:
return "Imports";
case ServiceWorkerUpdateViaCache::All:
return "All";
case ServiceWorkerUpdateViaCache::None:
return "None";
}
RELEASE_ASSERT_NOT_REACHED();
}
static Optional<ServiceWorkerUpdateViaCache> stringToUpdateViaCache(const String& update)
{
if (update == "Imports")
return ServiceWorkerUpdateViaCache::Imports;
if (update == "All")
return ServiceWorkerUpdateViaCache::All;
if (update == "None")
return ServiceWorkerUpdateViaCache::None;
return WTF::nullopt;
}
static String workerTypeToString(WorkerType workerType)
{
switch (workerType) {
case WorkerType::Classic:
return "Classic";
case WorkerType::Module:
return "Module";
}
RELEASE_ASSERT_NOT_REACHED();
}
static Optional<WorkerType> stringToWorkerType(const String& type)
{
if (type == "Classic")
return WorkerType::Classic;
if (type == "Module")
return WorkerType::Module;
return WTF::nullopt;
}
void RegistrationDatabase::pushChanges(const HashMap<ServiceWorkerRegistrationKey, Optional<ServiceWorkerContextData>>& changedRegistrations, CompletionHandler<void()>&& completionHandler)
{
Vector<ServiceWorkerContextData> updatedRegistrations;
Vector<ServiceWorkerRegistrationKey> removedRegistrations;
for (auto& keyValue : changedRegistrations) {
if (keyValue.value)
updatedRegistrations.append(keyValue.value->isolatedCopy());
else
removedRegistrations.append(keyValue.key.isolatedCopy());
}
postTaskToWorkQueue([this, updatedRegistrations = WTFMove(updatedRegistrations), removedRegistrations = WTFMove(removedRegistrations), completionHandler = WTFMove(completionHandler)]() mutable {
doPushChanges(updatedRegistrations, removedRegistrations);
if (!completionHandler)
return;
callOnMainThread(WTFMove(completionHandler));
});
}
void RegistrationDatabase::close(CompletionHandler<void()>&& completionHandler)
{
postTaskToWorkQueue([this, completionHandler = WTFMove(completionHandler)]() mutable {
m_database = nullptr;
callOnMainThread(WTFMove(completionHandler));
});
}
void RegistrationDatabase::clearAll(CompletionHandler<void()>&& completionHandler)
{
postTaskToWorkQueue([this, completionHandler = WTFMove(completionHandler)]() mutable {
m_database = nullptr;
SQLiteFileSystem::deleteDatabaseFile(m_databaseFilePath);
SQLiteFileSystem::deleteEmptyDatabaseDirectory(databaseDirectoryIsolatedCopy());
callOnMainThread(WTFMove(completionHandler));
});
}
void RegistrationDatabase::doPushChanges(const Vector<ServiceWorkerContextData>& updatedRegistrations, const Vector<ServiceWorkerRegistrationKey>& removedRegistrations)
{
if (!m_database) {
openSQLiteDatabase(m_databaseFilePath);
if (!m_database)
return;
}
SQLiteTransaction transaction(*m_database);
transaction.begin();
SQLiteStatement sql(*m_database, "INSERT INTO Records VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)"_s);
if (sql.prepare() != SQLITE_OK) {
RELEASE_LOG_ERROR(ServiceWorker, "Failed to prepare statement to store registration data into records table (%i) - %s", m_database->lastError(), m_database->lastErrorMsg());
return;
}
for (auto& registration : removedRegistrations) {
SQLiteStatement sql(*m_database, "DELETE FROM Records WHERE key = ?");
if (sql.prepare() != SQLITE_OK
|| sql.bindText(1, registration.toDatabaseKey()) != SQLITE_OK
|| sql.step() != SQLITE_DONE) {
RELEASE_LOG_ERROR(ServiceWorker, "Failed to remove registration data from records table (%i) - %s", m_database->lastError(), m_database->lastErrorMsg());
return;
}
}
for (auto& data : updatedRegistrations) {
WTF::Persistence::Encoder cspEncoder;
data.contentSecurityPolicy.encode(cspEncoder);
WTF::Persistence::Encoder scriptResourceMapEncoder;
scriptResourceMapEncoder.encode(data.scriptResourceMap);
if (sql.bindText(1, data.registration.key.toDatabaseKey()) != SQLITE_OK
|| sql.bindText(2, data.registration.scopeURL.protocolHostAndPort()) != SQLITE_OK
|| sql.bindText(3, data.registration.scopeURL.path()) != SQLITE_OK
|| sql.bindText(4, data.registration.key.topOrigin().databaseIdentifier()) != SQLITE_OK
|| sql.bindDouble(5, data.registration.lastUpdateTime.secondsSinceEpoch().value()) != SQLITE_OK
|| sql.bindText(6, updateViaCacheToString(data.registration.updateViaCache)) != SQLITE_OK
|| sql.bindText(7, data.scriptURL.string()) != SQLITE_OK
|| sql.bindText(8, data.script) != SQLITE_OK
|| sql.bindText(9, workerTypeToString(data.workerType)) != SQLITE_OK
|| sql.bindBlob(10, cspEncoder.buffer(), cspEncoder.bufferSize()) != SQLITE_OK
|| sql.bindText(11, data.referrerPolicy) != SQLITE_OK
|| sql.bindBlob(12, scriptResourceMapEncoder.buffer(), scriptResourceMapEncoder.bufferSize()) != SQLITE_OK
|| sql.step() != SQLITE_DONE) {
RELEASE_LOG_ERROR(ServiceWorker, "Failed to store registration data into records table (%i) - %s", m_database->lastError(), m_database->lastErrorMsg());
return;
}
}
transaction.commit();
LOG(ServiceWorker, "Updated ServiceWorker registration database (%zu added/updated registrations and %zu removed registrations", updatedRegistrations.size(), removedRegistrations.size());
}
String RegistrationDatabase::importRecords()
{
ASSERT(!isMainThread());
SQLiteStatement sql(*m_database, "SELECT * FROM Records;"_s);
if (sql.prepare() != SQLITE_OK)
return makeString("Failed to prepare statement to retrieve registrations from records table (", m_database->lastError(), ") - ", m_database->lastErrorMsg());
int result = sql.step();
for (; result == SQLITE_ROW; result = sql.step()) {
auto key = ServiceWorkerRegistrationKey::fromDatabaseKey(sql.getColumnText(0));
auto originURL = URL { URL(), sql.getColumnText(1) };
auto scopePath = sql.getColumnText(2);
auto topOrigin = SecurityOriginData::fromDatabaseIdentifier(sql.getColumnText(3));
auto lastUpdateCheckTime = WallTime::fromRawSeconds(sql.getColumnDouble(4));
auto updateViaCache = stringToUpdateViaCache(sql.getColumnText(5));
auto scriptURL = URL { URL(), sql.getColumnText(6) };
auto script = sql.getColumnText(7);
auto workerType = stringToWorkerType(sql.getColumnText(8));
Vector<uint8_t> contentSecurityPolicyData;
sql.getColumnBlobAsVector(9, contentSecurityPolicyData);
WTF::Persistence::Decoder cspDecoder(contentSecurityPolicyData.data(), contentSecurityPolicyData.size());
ContentSecurityPolicyResponseHeaders contentSecurityPolicy;
if (contentSecurityPolicyData.size() && !ContentSecurityPolicyResponseHeaders::decode(cspDecoder, contentSecurityPolicy))
continue;
auto referrerPolicy = sql.getColumnText(10);
Vector<uint8_t> scriptResourceMapData;
sql.getColumnBlobAsVector(11, scriptResourceMapData);
HashMap<URL, ServiceWorkerContextData::ImportedScript> scriptResourceMap;
WTF::Persistence::Decoder scriptResourceMapDecoder(scriptResourceMapData.data(), scriptResourceMapData.size());
if (scriptResourceMapData.size()) {
if (!scriptResourceMapDecoder.decode(scriptResourceMap))
continue;
}
if (!key || !originURL.isValid() || !topOrigin || !updateViaCache || !scriptURL.isValid() || !workerType)
continue;
auto workerIdentifier = ServiceWorkerIdentifier::generate();
auto registrationIdentifier = ServiceWorkerRegistrationIdentifier::generate();
auto serviceWorkerData = ServiceWorkerData { workerIdentifier, scriptURL, ServiceWorkerState::Activated, *workerType, registrationIdentifier };
auto registration = ServiceWorkerRegistrationData { WTFMove(*key), registrationIdentifier, URL(originURL, scopePath), *updateViaCache, lastUpdateCheckTime, WTF::nullopt, WTF::nullopt, WTFMove(serviceWorkerData) };
auto contextData = ServiceWorkerContextData { WTF::nullopt, WTFMove(registration), workerIdentifier, WTFMove(script), WTFMove(contentSecurityPolicy), WTFMove(referrerPolicy), WTFMove(scriptURL), *workerType, true, WTFMove(scriptResourceMap) };
callOnMainThread([protectedThis = makeRef(*this), contextData = contextData.isolatedCopy()]() mutable {
protectedThis->addRegistrationToStore(WTFMove(contextData));
});
}
if (result != SQLITE_DONE)
return makeString("Failed to import at least one registration from records table (", m_database->lastError(), ") - ", m_database->lastErrorMsg());
return { };
}
void RegistrationDatabase::addRegistrationToStore(ServiceWorkerContextData&& context)
{
if (m_store)
m_store->addRegistrationFromDatabase(WTFMove(context));
}
void RegistrationDatabase::databaseFailedToOpen()
{
if (m_store)
m_store->databaseFailedToOpen();
}
void RegistrationDatabase::databaseOpenedAndRecordsImported()
{
if (m_store)
m_store->databaseOpenedAndRecordsImported();
}
}
#endif // ENABLE(SERVICE_WORKER)