modernize: Reformat ALL the source... again!
[quassel.git] / src / core / abstractsqlstorage.h
index e894555..7075db9 100644 (file)
 
 #pragma once
 
-#include "storage.h"
-
 #include <memory>
 
 #include <QSqlDatabase>
-#include <QSqlQuery>
 #include <QSqlError>
+#include <QSqlQuery>
+
+#include "storage.h"
 
 class AbstractSqlMigrationReader;
 class AbstractSqlMigrationWriter;
@@ -36,18 +36,22 @@ class AbstractSqlStorage : public Storage
     Q_OBJECT
 
 public:
-    AbstractSqlStorage(QObject *parent = 0);
-    virtual ~AbstractSqlStorage();
+    AbstractSqlStorage(QObject* parent = nullptr);
+    ~AbstractSqlStorage() override;
 
     virtual std::unique_ptr<AbstractSqlMigrationReader> createMigrationReader() { return {}; }
     virtual std::unique_ptr<AbstractSqlMigrationWriter> createMigrationWriter() { return {}; }
 
 public slots:
-    virtual State init(const QVariantMap &settings = QVariantMap());
-    virtual bool setup(const QVariantMap &settings = QVariantMap());
+    State init(const QVariantMap& settings = QVariantMap(),
+               const QProcessEnvironment& environment = {},
+               bool loadFromEnvironment = false) override;
+    bool setup(const QVariantMap& settings = QVariantMap(),
+               const QProcessEnvironment& environment = {},
+               bool loadFromEnvironment = false) override;
 
 protected:
-    inline virtual void sync() {};
+    inline void sync() override{};
 
     QSqlDatabase logDb();
 
@@ -68,21 +72,21 @@ protected:
      * @endparblock
      * @return String with the requested SQL query, ready for parameter substitution
      */
-    QString queryString(const QString &queryName, int version = 0);
+    QString queryString(const QStringqueryName, int version = 0);
 
     QStringList setupQueries();
 
     QStringList upgradeQueries(int ver);
     bool upgradeDb();
 
-    bool watchQuery(QSqlQuery &query);
+    bool watchQuery(QSqlQueryquery);
 
     int schemaVersion();
     virtual int installedSchemaVersion() { return -1; };
     virtual bool updateSchemaVersion(int newVersion) = 0;
     virtual bool setupSchemaVersion(int version) = 0;
 
-    virtual void setConnectionProperties(const QVariantMap &properties) = 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; }
@@ -97,16 +101,16 @@ protected:
      *  When reimplementing this method, don't use logDB() inside this function as
      *  this would cause as we're just about to initialize that DB connection.
      */
-    inline virtual bool initDbSession(QSqlDatabase & /* db */) { return true; }
+    inline virtual bool initDbSession(QSqlDatabase& /* db */) { return true; }
 
 private slots:
     void connectionDestroyed();
 
 private:
     void addConnectionToPool();
-    void dbConnect(QSqlDatabase &db);
+    void dbConnect(QSqlDatabasedb);
 
-    int _schemaVersion;
+    int _schemaVersion{0};
     bool _debug;
 
     static int _nextConnectionId;
@@ -115,16 +119,17 @@ private:
     // those objects reside in the thread the connection belongs to
     // which allows us thread safe termination of a connection
     class Connection;
-    QHash<QThread *, Connection *> _connectionPool;
+    QHash<QThread*, Connection*> _connectionPool;
 };
 
-struct SenderData {
+struct SenderData
+{
     QString sender;
     QString realname;
     QString avatarurl;
 
-    friend uint qHash(const SenderData &key);
-    friend bool operator==(const SenderData &a, const SenderData &b);
+    friend uint qHash(const SenderDatakey);
+    friend bool operator==(const SenderData& a, const SenderData& b);
 };
 
 // ========================================
@@ -135,8 +140,8 @@ class AbstractSqlStorage::Connection : public QObject
     Q_OBJECT
 
 public:
-    Connection(const QString &name, QObject *parent = 0);
-    ~Connection();
+    Connection(const QString& name, QObject* parent = nullptr);
+    ~Connection() override;
 
     inline QLatin1String name() const { return QLatin1String(_name); }
 
@@ -144,7 +149,6 @@ private:
     QByteArray _name;
 };
 
-
 // ========================================
 //  AbstractSqlMigrator
 // ========================================
@@ -152,7 +156,8 @@ class AbstractSqlMigrator
 {
 public:
     // migration objects
-    struct QuasselUserMO {
+    struct QuasselUserMO
+    {
         UserId id;
         QString username;
         QString password;
@@ -160,15 +165,16 @@ public:
         QString authenticator;
     };
 
-    struct SenderMO {
-        int senderId;
+    struct SenderMO
+    {
+        qint64 senderId{0};
         QString sender;
         QString realname;
         QString avatarurl;
-        SenderMO() : senderId(0) {}
     };
 
-    struct IdentityMO {
+    struct IdentityMO
+    {
         IdentityId id;
         UserId userid;
         QString identityname;
@@ -183,7 +189,7 @@ public:
         bool autoAwayReasonEnabled;
         bool detachAwayEnabled;
         QString detachAwayReason;
-        bool detchAwayReasonEnabled;
+        bool detachAwayReasonEnabled;
         QString ident;
         QString kickReason;
         QString partReason;
@@ -192,47 +198,48 @@ public:
         QByteArray sslKey;
     };
 
-    struct IdentityNickMO {
+    struct IdentityNickMO
+    {
         int nickid;
         IdentityId identityId;
         QString nick;
     };
 
-    struct NetworkMO {
-        NetworkId networkid;
+    struct NetworkMO
+    {
         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 {
+    struct BufferMO
+    {
         BufferId bufferid;
         UserId userid;
         int groupid;
@@ -240,9 +247,9 @@ 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;
@@ -250,18 +257,20 @@ public:
         QString cipher;
     };
 
-    struct BacklogMO {
+    struct BacklogMO
+    {
         MsgId messageid;
-        QDateTime time; // has to be in UTC!
+        QDateTime time;  // has to be in UTC!
         BufferId bufferid;
         int type;
         int flags;
-        int senderid;
+        qint64 senderid;
         QString senderprefixes;
         QString message;
     };
 
-    struct IrcServerMO {
+    struct IrcServerMO
+    {
         int serverid;
         UserId userid;
         NetworkId networkid;
@@ -269,7 +278,7 @@ public:
         int port;
         QString password;
         bool ssl;
-        bool sslverify;     /// If true, validate SSL certificates
+        bool sslverify;  /// If true, validate SSL certificates
         int sslversion;
         bool useproxy;
         int proxytype;
@@ -279,18 +288,21 @@ public:
         QString proxypass;
     };
 
-    struct UserSettingMO {
+    struct UserSettingMO
+    {
         UserId userid;
         QString settingname;
         QByteArray settingvalue;
     };
 
-    struct CoreStateMO {
+    struct CoreStateMO
+    {
         QString key;
         QByteArray value;
     };
 
-    enum MigrationObject {
+    enum MigrationObject
+    {
         QuasselUser,
         Sender,
         Identity,
@@ -303,20 +315,19 @@ public:
         CoreState
     };
 
-    AbstractSqlMigrator();
-    virtual ~AbstractSqlMigrator() {}
+    virtual ~AbstractSqlMigrator() = default;
 
     static QString migrationObject(MigrationObject moType);
 
 protected:
-    void newQuery(const QString &query, QSqlDatabase db);
+    void newQuery(const QStringquery, QSqlDatabase db);
     virtual void resetQuery();
     virtual bool prepareQuery(MigrationObject mo) = 0;
     bool exec();
     inline bool next() { return _query->next(); }
     inline QVariant value(int index) { return _query->value(index); }
-    inline void bindValue(const QString &placeholder, const QVariant &val) { _query->bindValue(placeholder, val); }
-    inline void bindValue(int pos, const QVariant &val) { _query->bindValue(pos, val); }
+    inline void bindValue(const QString& placeholder, const QVariant& val) { _query->bindValue(placeholder, val); }
+    inline void bindValue(int pos, const QVariantval) { _query->bindValue(pos, val); }
 
     inline QSqlError lastError() { return _query ? _query->lastError() : QSqlError(); }
     void dumpStatus();
@@ -328,53 +339,52 @@ protected:
     virtual bool commit() = 0;
 
 private:
-    QSqlQuery *_query;
+    QSqlQuery* _query{nullptr};
 };
 
-
 class AbstractSqlMigrationReader : public AbstractSqlMigrator
 {
 public:
     AbstractSqlMigrationReader();
 
-    virtual bool readMo(QuasselUserMO &user) = 0;
-    virtual bool readMo(IdentityMO &identity) = 0;
-    virtual bool readMo(IdentityNickMO &identityNick) = 0;
-    virtual bool readMo(NetworkMO &network) = 0;
-    virtual bool readMo(BufferMO &buffer) = 0;
-    virtual bool readMo(SenderMO &sender) = 0;
-    virtual bool readMo(BacklogMO &backlog) = 0;
-    virtual bool readMo(IrcServerMO &ircserver) = 0;
-    virtual bool readMo(UserSettingMO &userSetting) = 0;
-    virtual bool readMo(CoreStateMO &coreState) = 0;
+    virtual bool readMo(QuasselUserMOuser) = 0;
+    virtual bool readMo(IdentityMOidentity) = 0;
+    virtual bool readMo(IdentityNickMOidentityNick) = 0;
+    virtual bool readMo(NetworkMOnetwork) = 0;
+    virtual bool readMo(BufferMObuffer) = 0;
+    virtual bool readMo(SenderMOsender) = 0;
+    virtual bool readMo(BacklogMObacklog) = 0;
+    virtual bool readMo(IrcServerMOircserver) = 0;
+    virtual bool readMo(UserSettingMOuserSetting) = 0;
+    virtual bool readMo(CoreStateMOcoreState) = 0;
 
-    bool migrateTo(AbstractSqlMigrationWriter *writer);
+    bool migrateTo(AbstractSqlMigrationWriterwriter);
 
 private:
-    void abortMigration(const QString &errorMsg = QString());
+    void abortMigration(const QStringerrorMsg = QString());
     bool finalizeMigration();
 
-    template<typename T> bool transferMo(MigrationObject moType, T &mo);
+    template<typename T>
+    bool transferMo(MigrationObject moType, T& mo);
 
-    AbstractSqlMigrationWriter *_writer;
+    AbstractSqlMigrationWriter* _writer{nullptr};
 };
 
-
 class AbstractSqlMigrationWriter : public AbstractSqlMigrator
 {
 public:
-    virtual bool writeMo(const QuasselUserMO &user) = 0;
-    virtual bool writeMo(const IdentityMO &identity) = 0;
-    virtual bool writeMo(const IdentityNickMO &identityNick) = 0;
-    virtual bool writeMo(const NetworkMO &network) = 0;
-    virtual bool writeMo(const BufferMO &buffer) = 0;
-    virtual bool writeMo(const SenderMO &sender) = 0;
-    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); }
+    virtual bool writeMo(const QuasselUserMOuser) = 0;
+    virtual bool writeMo(const IdentityMOidentity) = 0;
+    virtual bool writeMo(const IdentityNickMOidentityNick) = 0;
+    virtual bool writeMo(const NetworkMOnetwork) = 0;
+    virtual bool writeMo(const BufferMObuffer) = 0;
+    virtual bool writeMo(const SenderMOsender) = 0;
+    virtual bool writeMo(const BacklogMObacklog) = 0;
+    virtual bool writeMo(const IrcServerMOircserver) = 0;
+    virtual bool writeMo(const UserSettingMOuserSetting) = 0;
+    virtual bool writeMo(const CoreStateMOcoreState) = 0;
+
+    inline bool migrateFrom(AbstractSqlMigrationReaderreader) { return reader->migrateTo(this); }
 
     // called after migration process
     virtual inline bool postProcess() { return true; }