X-Git-Url: https://git.quassel-irc.org/?a=blobdiff_plain;f=src%2Fcore%2Fabstractsqlstorage.cpp;h=0cd04032a2659d57f74c011372fe064f9ea57d75;hb=48017b680ede0dbfb121d1184dfbd13536cfc53f;hp=f87ac1d6fb2c452394cbe1562225445c77a1233e;hpb=c1cf157116de7fc3da96203aa6f03c38c7ebb650;p=quassel.git diff --git a/src/core/abstractsqlstorage.cpp b/src/core/abstractsqlstorage.cpp index f87ac1d6..0cd04032 100644 --- a/src/core/abstractsqlstorage.cpp +++ b/src/core/abstractsqlstorage.cpp @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2018 by the Quassel Project * + * Copyright (C) 2005-2020 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -20,13 +20,15 @@ #include "abstractsqlstorage.h" +#include +#include #include #include #include #include #include +#include -#include "logmessage.h" #include "quassel.h" int AbstractSqlStorage::_nextConnectionId = 0; @@ -99,12 +101,12 @@ void AbstractSqlStorage::addConnectionToPool() void AbstractSqlStorage::dbConnect(QSqlDatabase& db) { if (!db.open()) { - quWarning() << "Unable to open database" << displayName() << "for thread" << QThread::currentThread(); - quWarning() << "-" << db.lastError().text(); + qWarning() << "Unable to open database" << displayName() << "for thread" << QThread::currentThread(); + qWarning() << "-" << db.lastError().text(); } else { if (!initDbSession(db)) { - quWarning() << "Unable to initialize database" << displayName() << "for thread" << QThread::currentThread(); + qWarning() << "Unable to initialize database" << displayName() << "for thread" << QThread::currentThread(); db.close(); } } @@ -131,7 +133,7 @@ Storage::State AbstractSqlStorage::init(const QVariantMap& settings, const QProc } if (installedSchemaVersion() < schemaVersion()) { - quInfo() << qPrintable(tr("Installed database schema (version %1) is not up to date. Upgrading to " + qInfo() << qPrintable(tr("Installed database schema (version %1) is not up to date. Upgrading to " "version %2... This may take a while for major upgrades.") .arg(installedSchemaVersion()) .arg(schemaVersion())); @@ -144,10 +146,10 @@ Storage::State AbstractSqlStorage::init(const QVariantMap& settings, const QProc } // Add a message when migration succeeds to avoid confusing folks by implying the schema upgrade failed if // later functionality does not work. - quInfo() << qPrintable(tr("Installed database schema successfully upgraded to version %1.").arg(schemaVersion())); + qInfo() << qPrintable(tr("Installed database schema successfully upgraded to version %1.").arg(schemaVersion())); } - quInfo() << qPrintable(displayName()) << "storage backend is ready. Schema version:" << installedSchemaVersion(); + qInfo() << qPrintable(displayName()) << "storage backend is ready. Schema version:" << installedSchemaVersion(); return IsReady; } @@ -181,13 +183,13 @@ QString AbstractSqlStorage::queryString(const QString& queryName, int version) return query.trimmed(); } -QStringList AbstractSqlStorage::setupQueries() +std::vector AbstractSqlStorage::setupQueries() { - QStringList queries; + std::vector queries; // The current schema is stored in the root folder, including setup scripts. QDir dir = QDir(QString(":/SQL/%1/").arg(displayName())); foreach (QFileInfo fileInfo, dir.entryInfoList(QStringList() << "setup*", QDir::NoFilter, QDir::Name)) { - queries << queryString(fileInfo.baseName()); + queries.emplace_back(queryString(fileInfo.baseName()), fileInfo.baseName()); } return queries; } @@ -202,10 +204,11 @@ bool AbstractSqlStorage::setup(const QVariantMap& settings, const QProcessEnviro } db.transaction(); - foreach (QString queryString, setupQueries()) { - QSqlQuery query = db.exec(queryString); + foreach (auto queryResource, setupQueries()) { + QSqlQuery query = db.exec(queryResource.queryString); if (!watchQuery(query)) { - qCritical() << "Unable to setup Logging Backend!"; + qCritical() << qPrintable(QString("Unable to setup Logging Backend! Setup query failed (step: %1).") + .arg(queryResource.queryFilename)); db.rollback(); return false; } @@ -218,13 +221,13 @@ bool AbstractSqlStorage::setup(const QVariantMap& settings, const QProcessEnviro return success; } -QStringList AbstractSqlStorage::upgradeQueries(int version) +std::vector AbstractSqlStorage::upgradeQueries(int version) { - QStringList queries; + std::vector queries; // Upgrade queries are stored in the 'version/##' subfolders. QDir dir = QDir(QString(":/SQL/%1/version/%2/").arg(displayName()).arg(version)); foreach (QFileInfo fileInfo, dir.entryInfoList(QStringList() << "upgrade*", QDir::NoFilter, QDir::Name)) { - queries << queryString(fileInfo.baseName(), version); + queries.emplace_back(queryString(fileInfo.baseName(), version), fileInfo.baseName()); } return queries; } @@ -240,38 +243,75 @@ bool AbstractSqlStorage::upgradeDb() // transaction. This will need careful testing of potential additional space requirements and // any database modifications that might not be allowed in a transaction. + // Check if we're resuming an interrupted multi-step upgrade: is an upgrade step stored? + const QString previousLaunchUpgradeStep = schemaVersionUpgradeStep(); + bool resumingUpgrade = !previousLaunchUpgradeStep.isEmpty(); + for (int ver = installedSchemaVersion() + 1; ver <= schemaVersion(); ver++) { - foreach (QString queryString, upgradeQueries(ver)) { - QSqlQuery query = db.exec(queryString); + foreach (auto queryResource, upgradeQueries(ver)) { + if (resumingUpgrade) { + // An upgrade was interrupted. Check if this matches the the last successful query. + if (previousLaunchUpgradeStep == queryResource.queryFilename) { + // Found the matching query! + qInfo() << qPrintable(QString("Resuming interrupted upgrade for schema version %1 (last step: %2)") + .arg(QString::number(ver), previousLaunchUpgradeStep)); + + // Stop searching for queries + resumingUpgrade = false; + // Continue past the previous query with the next not-yet-tried query + continue; + } + else { + // Not yet matched, keep looking + continue; + } + } + + // Run the upgrade query + QSqlQuery query = db.exec(queryResource.queryString); if (!watchQuery(query)) { // Individual upgrade query failed, bail out - qCritical() << "Unable to upgrade Logging Backend! Upgrade query in schema version" << ver << "failed."; + qCritical() << qPrintable(QString("Unable to upgrade Logging Backend! Upgrade query in schema version %1 failed (step: %2).") + .arg(QString::number(ver), queryResource.queryFilename)); return false; } + else { + // Mark as successful + setSchemaVersionUpgradeStep(queryResource.queryFilename); + } + } + + if (resumingUpgrade) { + // Something went wrong and the last successful SQL query to resume from couldn't be + // found. + // 1. The storage of successful query glitched, or the database was manually changed + // 2. Quassel changed the filenames of upgrade queries, and the local Quassel core + // version was replaced during an interrupted schema upgrade + // + // Both are unlikely, but it's a good idea to handle it anyways. + + qCritical() << qPrintable(QString("Unable to resume interrupted upgrade in Logging " + "Backend! Missing upgrade step in schema version %1 " + "(expected step: %2)") + .arg(QString::number(ver), previousLaunchUpgradeStep)); + return false; } - // Update the schema version for each intermediate step. This ensures that any interrupted - // upgrades have a greater chance of resuming correctly after core restart. + // Update the schema version for each intermediate step and mark the step as done. This + // ensures that any interrupted upgrades have a greater chance of resuming correctly after + // core restart. // // Almost all databases make single queries atomic (fully works or fully fails, no partial), // and with many of the longest migrations being a single query, this makes upgrade // interruptions much more likely to leave the database in a valid intermediate schema // version. - if (!updateSchemaVersion(ver)) { + if (!updateSchemaVersion(ver, true)) { // Updating the schema version failed, bail out qCritical() << "Unable to upgrade Logging Backend! Setting schema version" << ver << "failed."; return false; } } - // Update the schema version for the final step. Split this out to offer more informative - // logging (though setting schema version really should not fail). - if (!updateSchemaVersion(schemaVersion())) { - // Updating the final schema version failed, bail out - qCritical() << "Unable to upgrade Logging Backend! Setting final schema version" << schemaVersion() << "failed."; - return false; - } - // If we made it here, everything seems to have worked! return true; } @@ -301,6 +341,14 @@ int AbstractSqlStorage::schemaVersion() return _schemaVersion; } + +QString AbstractSqlStorage::schemaVersionUpgradeStep() +{ + // By default, assume there's no pending upgrade + return {}; +} + + bool AbstractSqlStorage::watchQuery(QSqlQuery& query) { bool queryError = query.lastError().isValid(); @@ -339,7 +387,7 @@ bool AbstractSqlStorage::watchQuery(QSqlQuery& query) valueStrings << QString("%1=%2").arg(iter.key(), value); } qCritical() << " bound Values:" << qPrintable(valueStrings.join(", ")); - qCritical() << " Error Number:" << query.lastError().number(); + qCritical() << " Error Code:" << qPrintable(query.lastError().nativeErrorCode()); qCritical() << " Error Message:" << qPrintable(query.lastError().text()); qCritical() << " Driver Message:" << qPrintable(query.lastError().driverText()); qCritical() << " DB Message:" << qPrintable(query.lastError().databaseText()); @@ -447,7 +495,7 @@ void AbstractSqlMigrator::dumpStatus() QList list = boundValues(); for (int i = 0; i < list.size(); ++i) qWarning() << i << ": " << list.at(i).toString().toLatin1().data(); - qWarning() << " Error Number:" << lastError().number(); + qWarning() << " Error Code:" << qPrintable(lastError().nativeErrorCode()); qWarning() << " Error Message:" << lastError().text(); }