X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fabstractsqlstorage.h;h=63d00c5180b39aa386cddd09e2b5cfb6b31d5606;hp=7f8e38f4b439e813a9256329c33ef7a9b139857f;hb=dd8c9291dd3308e7307a40ccb2a5d123e09b0915;hpb=3cf5c49e7753be48a994917fe898730add4292b1 diff --git a/src/core/abstractsqlstorage.h b/src/core/abstractsqlstorage.h index 7f8e38f4..63d00c51 100644 --- a/src/core/abstractsqlstorage.h +++ b/src/core/abstractsqlstorage.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2016 by the Quassel Project * + * Copyright (C) 2005-2019 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -18,11 +18,13 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#ifndef ABSTRACTSQLSTORAGE_H -#define ABSTRACTSQLSTORAGE_H +#pragma once #include "storage.h" +#include + +#include #include #include #include @@ -38,12 +40,28 @@ public: AbstractSqlStorage(QObject *parent = 0); virtual ~AbstractSqlStorage(); - virtual inline AbstractSqlMigrationReader *createMigrationReader() { return 0; } - virtual inline AbstractSqlMigrationWriter *createMigrationWriter() { return 0; } + virtual std::unique_ptr createMigrationReader() { return {}; } + virtual std::unique_ptr createMigrationWriter() { return {}; } + + /** + * An SQL query with associated resource filename + */ + struct SqlQueryResource { + QString queryString; ///< SQL query string + QString queryFilename; ///< Path to the resource file providing this query + + SqlQueryResource(const QString& queryString, const QString& queryFilename) + : queryString(std::move(queryString)), + queryFilename(std::move(queryFilename)) {} + }; public slots: - virtual State init(const QVariantMap &settings = QVariantMap()); - virtual bool setup(const QVariantMap &settings = QVariantMap()); + virtual State init(const QVariantMap &settings = QVariantMap(), + const QProcessEnvironment &environment = {}, + bool loadFromEnvironment = false); + virtual bool setup(const QVariantMap &settings = QVariantMap(), + const QProcessEnvironment &environment = {}, + bool loadFromEnvironment = false); protected: inline virtual void sync() {}; @@ -71,17 +89,48 @@ protected: QStringList setupQueries(); - QStringList upgradeQueries(int ver); + /** + * Gets the collection of SQL upgrade queries and filenames for a given schema version + * + * @param ver SQL schema version + * @return List of SQL query strings and filenames + */ + QList upgradeQueries(int ver); bool upgradeDb(); bool watchQuery(QSqlQuery &query); int schemaVersion(); virtual int installedSchemaVersion() { return -1; }; - virtual bool updateSchemaVersion(int newVersion) = 0; + + /** + * Update the stored schema version number, optionally clearing the record of mid-schema steps + * + * @param newVersion New schema version number + * @param clearUpgradeStep If true, clear the record of any in-progress schema upgrades + * @return + */ + virtual bool updateSchemaVersion(int newVersion, bool clearUpgradeStep = true) = 0; + virtual bool setupSchemaVersion(int version) = 0; - virtual void setConnectionProperties(const QVariantMap &properties) = 0; + /** + * Gets the last successful schema upgrade step, or an empty string if no upgrade is in progress + * + * @return Filename of last successful schema upgrade query, or empty string if not upgrading + */ + virtual QString schemaVersionUpgradeStep(); + + /** + * Sets the last successful schema upgrade step + * + * @param upgradeQuery The filename of the last successful schema upgrade query + * @return True if successfully set, otherwise false + */ + virtual bool setSchemaVersionUpgradeStep(QString upgradeQuery) = 0; + virtual void setConnectionProperties(const QVariantMap &properties, + const QProcessEnvironment &environment, + bool loadFromEnvironment) = 0; virtual QString driverName() = 0; inline virtual QString hostName() { return QString(); } inline virtual int port() { return -1; } @@ -117,6 +166,14 @@ private: QHash _connectionPool; }; +struct SenderData { + QString sender; + QString realname; + QString avatarurl; + + friend uint qHash(const SenderData &key); + friend bool operator==(const SenderData &a, const SenderData &b); +}; // ======================================== // AbstractSqlStorage::Connection @@ -148,11 +205,14 @@ public: QString username; QString password; int hashversion; + QString authenticator; }; struct SenderMO { - int senderId; + qint64 senderId; QString sender; + QString realname; + QString avatarurl; SenderMO() : senderId(0) {} }; @@ -171,7 +231,7 @@ public: bool autoAwayReasonEnabled; bool detachAwayEnabled; QString detachAwayReason; - bool detchAwayReasonEnabled; + bool detachAwayReasonEnabled; QString ident; QString kickReason; QString partReason; @@ -187,37 +247,35 @@ public: }; struct NetworkMO { - NetworkId networkid; UserId userid; QString networkname; - IdentityId identityid; - QString encodingcodec; - QString decodingcodec; - QString servercodec; - bool userandomserver; QString perform; - bool useautoidentify; QString autoidentifyservice; QString autoidentifypassword; - bool useautoreconnect; + QString saslaccount; + QString saslpassword; + QString servercodec; + QString encodingcodec; + QString decodingcodec; + QString usermode; + QString awaymessage; + QString attachperform; + QString detachperform; + NetworkId networkid; + IdentityId identityid; + int messagerateburstsize; + int messageratedelay; int autoreconnectinterval; int autoreconnectretries; - bool unlimitedconnectretries; bool rejoinchannels; - // Custom rate limiting + bool userandomserver; + bool useautoidentify; + bool usesasl; + bool useautoreconnect; + bool unlimitedconnectretries; bool usecustommessagerate; - int messagerateburstsize; - int messageratedelay; bool unlimitedmessagerate; - // ... bool connected; - QString usermode; - QString awaymessage; - QString attachperform; - QString detachperform; - bool usesasl; - QString saslaccount; - QString saslpassword; }; struct BufferMO { @@ -228,11 +286,14 @@ public: QString buffername; QString buffercname; int buffertype; - int lastmsgid; - int lastseenmsgid; - int markerlinemsgid; + qint64 lastmsgid; + qint64 lastseenmsgid; + qint64 markerlinemsgid; + int bufferactivity; + int highlightcount; QString key; bool joined; + QString cipher; }; struct BacklogMO { @@ -241,7 +302,8 @@ public: BufferId bufferid; int type; int flags; - int senderid; + qint64 senderid; + QString senderprefixes; QString message; }; @@ -269,6 +331,11 @@ public: QByteArray settingvalue; }; + struct CoreStateMO { + QString key; + QByteArray value; + }; + enum MigrationObject { QuasselUser, Sender, @@ -278,7 +345,8 @@ public: Buffer, Backlog, IrcServer, - UserSetting + UserSetting, + CoreState }; AbstractSqlMigrator(); @@ -324,6 +392,7 @@ public: virtual bool readMo(BacklogMO &backlog) = 0; virtual bool readMo(IrcServerMO &ircserver) = 0; virtual bool readMo(UserSettingMO &userSetting) = 0; + virtual bool readMo(CoreStateMO &coreState) = 0; bool migrateTo(AbstractSqlMigrationWriter *writer); @@ -349,6 +418,7 @@ public: virtual bool writeMo(const BacklogMO &backlog) = 0; virtual bool writeMo(const IrcServerMO &ircserver) = 0; virtual bool writeMo(const UserSettingMO &userSetting) = 0; + virtual bool writeMo(const CoreStateMO &coreState) = 0; inline bool migrateFrom(AbstractSqlMigrationReader *reader) { return reader->migrateTo(this); } @@ -356,6 +426,3 @@ public: virtual inline bool postProcess() { return true; } friend class AbstractSqlMigrationReader; }; - - -#endif