src/core/postgresqlstorage.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2020 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #pragma once
  22
  23 #include <QSqlDatabase>
  24 #include <QSqlQuery>
  25
  26 #include "abstractsqlstorage.h"
  27
  28 class PostgreSqlStorage : public AbstractSqlStorage
  29 {
  30     Q_OBJECT
  31
  32 public:
  33     PostgreSqlStorage(QObject* parent = nullptr);
  34
  35     std::unique_ptr<AbstractSqlMigrationWriter> createMigrationWriter() override;
  36
  37 public slots:
  38     /* General */
  39     bool isAvailable() const override;
  40     QString backendId() const override;
  41     QString displayName() const override;
  42     QString description() const override;
  43     QVariantList setupData() const override;
  44
  45     // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
  46
  47     /* User handling */
  48
  49     UserId addUser(const QString& user, const QString& password, const QString& authenticator = "Database") override;
  50     bool updateUser(UserId user, const QString& password) override;
  51     void renameUser(UserId user, const QString& newName) override;
  52     UserId validateUser(const QString& user, const QString& password) override;
  53     UserId getUserId(const QString& username) override;
  54     QString getUserAuthenticator(const UserId userid) override;
  55     UserId internalUser() override;
  56     void delUser(UserId user) override;
  57     void setUserSetting(UserId userId, const QString& settingName, const QVariant& data) override;
  58     QVariant getUserSetting(UserId userId, const QString& settingName, const QVariant& defaultData = QVariant()) override;
  59     void setCoreState(const QVariantList& data) override;
  60     QVariantList getCoreState(const QVariantList& data) override;
  61
  62     /* Identity handling */
  63     IdentityId createIdentity(UserId user, CoreIdentity& identity) override;
  64     bool updateIdentity(UserId user, const CoreIdentity& identity) override;
  65     void removeIdentity(UserId user, IdentityId identityId) override;
  66     std::vector<CoreIdentity> identities(UserId user) override;
  67
  68     /* Network handling */
  69     NetworkId createNetwork(UserId user, const NetworkInfo& info) override;
  70     bool updateNetwork(UserId user, const NetworkInfo& info) override;
  71     bool removeNetwork(UserId user, const NetworkId& networkId) override;
  72     std::vector<NetworkInfo> networks(UserId user) override;
  73     std::vector<NetworkId> connectedNetworks(UserId user) override;
  74     void setNetworkConnected(UserId user, const NetworkId& networkId, bool isConnected) override;
  75
  76     /* persistent channels */
  77     QHash<QString, QString> persistentChannels(UserId user, const NetworkId& networkId) override;
  78     void setChannelPersistent(UserId user, const NetworkId& networkId, const QString& channel, bool isJoined) override;
  79     void setPersistentChannelKey(UserId user, const NetworkId& networkId, const QString& channel, const QString& key) override;
  80
  81     /* persistent user states */
  82     QString awayMessage(UserId user, NetworkId networkId) override;
  83     void setAwayMessage(UserId user, NetworkId networkId, const QString& awayMsg) override;
  84     QString userModes(UserId user, NetworkId networkId) override;
  85     void setUserModes(UserId user, NetworkId networkId, const QString& userModes) override;
  86
  87     /* Buffer handling */
  88     BufferInfo bufferInfo(UserId user, const NetworkId& networkId, BufferInfo::Type type, const QString& buffer = "", bool create = true) override;
  89     BufferInfo getBufferInfo(UserId user, const BufferId& bufferId) override;
  90     std::vector<BufferInfo> requestBuffers(UserId user) override;
  91     std::vector<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId) override;
  92     bool removeBuffer(const UserId& user, const BufferId& bufferId) override;
  93     bool renameBuffer(const UserId& user, const BufferId& bufferId, const QString& newName) override;
  94     bool mergeBuffersPermanently(const UserId& user, const BufferId& bufferId1, const BufferId& bufferId2) override;
  95     QHash<BufferId, MsgId> bufferLastMsgIds(UserId user) override;
  96     void setBufferLastSeenMsg(UserId user, const BufferId& bufferId, const MsgId& msgId) override;
  97     QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user) override;
  98     void setBufferMarkerLineMsg(UserId user, const BufferId& bufferId, const MsgId& msgId) override;
  99     QHash<BufferId, MsgId> bufferMarkerLineMsgIds(UserId user) override;
 100     void setBufferActivity(UserId id, BufferId bufferId, Message::Types type) override;
 101     QHash<BufferId, Message::Types> bufferActivities(UserId id) override;
 102     Message::Types bufferActivity(BufferId bufferId, MsgId lastSeenMsgId) override;
 103     void setHighlightCount(UserId id, BufferId bufferId, int count) override;
 104     QHash<BufferId, int> highlightCounts(UserId id) override;
 105     int highlightCount(BufferId bufferId, MsgId lastSeenMsgId) override;
 106     QHash<QString, QByteArray> bufferCiphers(UserId user, const NetworkId& networkId) override;
 107     void setBufferCipher(UserId user, const NetworkId& networkId, const QString& bufferName, const QByteArray& cipher) override;
 108
 109     /* Message handling */
 110     bool logMessage(Message& msg) override;
 111     bool logMessages(MessageList& msgs) override;
 112     std::vector<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) override;
 113     std::vector<Message> requestMsgsFiltered(UserId user,
 114                                              BufferId bufferId,
 115                                              MsgId first = -1,
 116                                              MsgId last = -1,
 117                                              int limit = -1,
 118                                              Message::Types type = Message::Types{-1},
 119                                              Message::Flags flags = Message::Flags{-1}) override;
 120     std::vector<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) override;
 121     std::vector<Message> requestAllMsgsFiltered(UserId user,
 122                                                 MsgId first = -1,
 123                                                 MsgId last = -1,
 124                                                 int limit = -1,
 125                                                 Message::Types type = Message::Types{-1},
 126                                                 Message::Flags flags = Message::Flags{-1}) override;
 127
 128     /* Sysident handling */
 129     QMap<UserId, QString> getAllAuthUserNames() override;
 130
 131 protected:
 132     bool initDbSession(QSqlDatabase& db) override;
 133     void setConnectionProperties(const QVariantMap& properties, const QProcessEnvironment& environment, bool loadFromEnvironment) override;
 134     QString driverName() override { return "QPSQL"; }
 135     QString hostName() override { return _hostName; }
 136     int port() override { return _port; }
 137     QString databaseName() override { return _databaseName; }
 138     QString userName() override { return _userName; }
 139     QString password() override { return _password; }
 140     int installedSchemaVersion() override;
 141     bool updateSchemaVersion(int newVersion, bool clearUpgradeStep) override;
 142     bool setupSchemaVersion(int version) override;
 143
 144     /**
 145      * Gets the last successful schema upgrade step, or an empty string if no upgrade is in progress
 146      *
 147      * @return Filename of last successful schema upgrade query, or empty string if not upgrading
 148      */
 149     QString schemaVersionUpgradeStep() override;
 150
 151     /**
 152      * Sets the last successful schema upgrade step
 153      *
 154      * @param upgradeQuery  The filename of the last successful schema upgrade query
 155      * @return True if successfully set, otherwise false
 156      */
 157     virtual bool setSchemaVersionUpgradeStep(QString upgradeQuery) override;
 158
 159     void safeExec(QSqlQuery& query);
 160
 161     bool beginTransaction(QSqlDatabase& db);
 162     bool beginReadOnlyTransaction(QSqlDatabase& db);
 163
 164     QSqlQuery executePreparedQuery(const QString& queryname, const QVariantList& params, QSqlDatabase& db);
 165     QSqlQuery executePreparedQuery(const QString& queryname, const QVariant& param, QSqlDatabase& db);
 166     void deallocateQuery(const QString& queryname, const QSqlDatabase& db);
 167
 168     void savePoint(const QString& handle, const QSqlDatabase& db) { db.exec(QString("SAVEPOINT %1").arg(handle)); }
 169     void rollbackSavePoint(const QString& handle, const QSqlDatabase& db) { db.exec(QString("ROLLBACK TO SAVEPOINT %1").arg(handle)); }
 170     void releaseSavePoint(const QString& handle, const QSqlDatabase& db) { db.exec(QString("RELEASE SAVEPOINT %1").arg(handle)); }
 171
 172 private:
 173     void bindNetworkInfo(QSqlQuery& query, const NetworkInfo& info);
 174     void bindServerInfo(QSqlQuery& query, const Network::Server& server);
 175     QSqlQuery prepareAndExecuteQuery(const QString& queryname, const QString& paramstring, QSqlDatabase& db);
 176     QSqlQuery prepareAndExecuteQuery(const QString& queryname, QSqlDatabase& db)
 177     {
 178         return prepareAndExecuteQuery(queryname, QString(), db);
 179     }
 180
 181     QString _hostName;
 182     int _port{-1};
 183     QString _databaseName;
 184     QString _userName;
 185     QString _password;
 186 };
 187
 188 // ========================================
 189 //  PostgreSqlMigration
 190 // ========================================
 191 class PostgreSqlMigrationWriter : public PostgreSqlStorage, public AbstractSqlMigrationWriter
 192 {
 193     Q_OBJECT
 194
 195 public:
 196     PostgreSqlMigrationWriter();
 197
 198     bool writeMo(const QuasselUserMO& user) override;
 199     bool writeMo(const SenderMO& sender) override;
 200     bool writeMo(const IdentityMO& identity) override;
 201     bool writeMo(const IdentityNickMO& identityNick) override;
 202     bool writeMo(const NetworkMO& network) override;
 203     bool writeMo(const BufferMO& buffer) override;
 204     bool writeMo(const BacklogMO& backlog) override;
 205     bool writeMo(const IrcServerMO& ircserver) override;
 206     bool writeMo(const UserSettingMO& userSetting) override;
 207     bool writeMo(const CoreStateMO& coreState) override;
 208
 209     bool prepareQuery(MigrationObject mo) override;
 210
 211     bool postProcess() override;
 212
 213 protected:
 214     inline bool transaction() override { return logDb().transaction(); }
 215     inline void rollback() override { logDb().rollback(); }
 216     inline bool commit() override { return logDb().commit(); }
 217
 218 private:
 219     // helper struct
 220     struct Sequence
 221     {
 222         QLatin1String table;
 223         QLatin1String field;
 224         Sequence(const char* table, const char* field)
 225             : table(table)
 226             , field(field)
 227         {}
 228     };
 229
 230     QSet<int> _validIdentities;
 231 };