/***************************************************************************
- * Copyright (C) 2005-2015 by the Quassel Project *
+ * Copyright (C) 2005-2018 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
***************************************************************************/
#include "abstractsqlstorage.h"
-#include "quassel.h"
-
-#include "logger.h"
#include <QMutexLocker>
#include <QSqlDriver>
#include <QSqlField>
#include <QSqlQuery>
+#include "logmessage.h"
+#include "quassel.h"
+
int AbstractSqlStorage::_nextConnectionId = 0;
AbstractSqlStorage::AbstractSqlStorage(QObject *parent)
- : Storage(parent),
- _schemaVersion(0)
+ : Storage(parent)
{
}
{
// disconnect the connections, so their deletion is no longer interessting for us
QHash<QThread *, Connection *>::iterator conIter;
- for (conIter = _connectionPool.begin(); conIter != _connectionPool.end(); conIter++) {
+ for (conIter = _connectionPool.begin(); conIter != _connectionPool.end(); ++conIter) {
QSqlDatabase::removeDatabase(conIter.value()->name());
- disconnect(conIter.value(), 0, this, 0);
+ disconnect(conIter.value(), nullptr, this, nullptr);
}
}
}
-Storage::State AbstractSqlStorage::init(const QVariantMap &settings)
+Storage::State AbstractSqlStorage::init(const QVariantMap &settings,
+ const QProcessEnvironment &environment,
+ bool loadFromEnvironment)
{
- setConnectionProperties(settings);
+ setConnectionProperties(settings, environment, loadFromEnvironment);
_debug = Quassel::isOptionSet("debug");
}
if (installedSchemaVersion() < schemaVersion()) {
- qWarning() << qPrintable(tr("Installed Schema (version %1) is not up to date. Upgrading to version %2...").arg(installedSchemaVersion()).arg(schemaVersion()));
- if (!upgradeDb()) {
+ quInfo() << 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()));
+ emit dbUpgradeInProgress(true);
+ auto upgradeResult = upgradeDb();
+ emit dbUpgradeInProgress(false);
+ if (!upgradeResult) {
qWarning() << qPrintable(tr("Upgrade failed..."));
return NotAvailable;
}
+ // 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()));
}
- quInfo() << qPrintable(displayName()) << "Storage Backend is ready. Quassel Schema Version:" << installedSchemaVersion();
+ quInfo() << qPrintable(displayName()) << "storage backend is ready. Schema version:" << installedSchemaVersion();
return IsReady;
}
QString AbstractSqlStorage::queryString(const QString &queryName, int version)
{
- if (version == 0)
- version = schemaVersion();
+ QFileInfo queryInfo;
+
+ // The current schema is stored in the root folder, while upgrade queries are stored in the
+ // 'versions/##' subfolders.
+ if (version == 0) {
+ // Use the current SQL schema, not a versioned request
+ queryInfo = QFileInfo(QString(":/SQL/%1/%2.sql").arg(displayName()).arg(queryName));
+ // If version is needed later, get it via version = schemaVersion();
+ } else {
+ // Use the specified schema version, not the general folder
+ queryInfo = QFileInfo(QString(":/SQL/%1/version/%2/%3.sql")
+ .arg(displayName()).arg(version).arg(queryName));
+ }
- QFileInfo queryInfo(QString(":/SQL/%1/%2/%3.sql").arg(displayName()).arg(version).arg(queryName));
if (!queryInfo.exists() || !queryInfo.isFile() || !queryInfo.isReadable()) {
qCritical() << "Unable to read SQL-Query" << queryName << "for engine" << displayName();
return QString();
QStringList AbstractSqlStorage::setupQueries()
{
QStringList queries;
- QDir dir = QDir(QString(":/SQL/%1/%2/").arg(displayName()).arg(schemaVersion()));
+ // 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());
}
}
-bool AbstractSqlStorage::setup(const QVariantMap &settings)
+bool AbstractSqlStorage::setup(const QVariantMap &settings, const QProcessEnvironment &environment,
+ bool loadFromEnvironment)
{
- setConnectionProperties(settings);
+ setConnectionProperties(settings, environment, loadFromEnvironment);
QSqlDatabase db = logDb();
if (!db.isOpen()) {
qCritical() << "Unable to setup Logging Backend!";
QStringList AbstractSqlStorage::upgradeQueries(int version)
{
QStringList queries;
- QDir dir = QDir(QString(":/SQL/%1/%2/").arg(displayName()).arg(version));
+ // 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);
}
QSqlDatabase db = logDb();
+ // TODO: For databases that support it (e.g. almost only PostgreSQL), wrap upgrades in a
+ // transaction. This will need careful testing of potential additional space requirements and
+ // any database modifications that might not be allowed in a transaction.
+
for (int ver = installedSchemaVersion() + 1; ver <= schemaVersion(); ver++) {
foreach(QString queryString, upgradeQueries(ver)) {
QSqlQuery query = db.exec(queryString);
if (!watchQuery(query)) {
- qCritical() << "Unable to upgrade Logging Backend!";
+ // Individual upgrade query failed, bail out
+ qCritical() << "Unable to upgrade Logging Backend! Upgrade query in schema version"
+ << ver << "failed.";
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.
+ //
+ // 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)) {
+ // 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;
}
- return updateSchemaVersion(schemaVersion());
+
+ // If we made it here, everything seems to have worked!
+ return true;
}
int version;
bool ok;
- QDir dir = QDir(":/SQL/" + displayName());
+ // Schema versions are stored in the 'version/##' subfolders.
+ QDir dir = QDir(QString(":/SQL/%1/version/").arg(displayName()));
foreach(QFileInfo fileInfo, dir.entryInfoList()) {
if (!fileInfo.isDir())
continue;
QVariantMap boundValues = query.boundValues();
QStringList valueStrings;
QVariantMap::const_iterator iter;
- for (iter = boundValues.constBegin(); iter != boundValues.constEnd(); iter++) {
+ for (iter = boundValues.constBegin(); iter != boundValues.constEnd(); ++iter) {
QString value;
QSqlField field;
if (query.driver()) {
// AbstractSqlMigrator
// ========================================
AbstractSqlMigrator::AbstractSqlMigrator()
- : _query(0)
{
}
void AbstractSqlMigrator::resetQuery()
{
delete _query;
- _query = 0;
+ _query = nullptr;
}
return "IrcServer";
case UserSetting:
return "UserSetting";
+ case CoreState:
+ return "CoreState";
};
return QString();
}
// AbstractSqlMigrationReader
// ========================================
AbstractSqlMigrationReader::AbstractSqlMigrationReader()
- : AbstractSqlMigrator(),
- _writer(0)
+ : AbstractSqlMigrator()
{
}
if (!transferMo(UserSetting, userSettingMo))
return false;
+ CoreStateMO coreStateMO;
+ if (!transferMo(CoreState, coreStateMO))
+ return false;
+
if (!_writer->postProcess())
abortMigration();
return finalizeMigration();
rollback();
_writer->rollback();
- _writer = 0;
+ _writer = nullptr;
}
commit();
if (!_writer->commit()) {
- _writer = 0;
+ _writer = nullptr;
return false;
}
- _writer = 0;
+ _writer = nullptr;
return true;
}
qDebug() << "Done.";
return true;
}
+
+uint qHash(const SenderData &key) {
+ return qHash(QString(key.sender + "\n" + key.realname + "\n" + key.avatarurl));
+}
+
+bool operator==(const SenderData &a, const SenderData &b) {
+ return a.sender == b.sender &&
+ a.realname == b.realname &&
+ a.avatarurl == b.avatarurl;
+}
projects / quassel.git / blobdiff