src/core/postgresqlstorage.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 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 "abstractsqlstorage.h"
  24
  25 #include <QSqlDatabase>
  26 #include <QSqlQuery>
  27
  28 class PostgreSqlStorage : public AbstractSqlStorage
  29 {
  30     Q_OBJECT
  31
  32 public:
  33     PostgreSqlStorage(QObject *parent = 0);
  34     ~PostgreSqlStorage() override;
  35
  36     std::unique_ptr<AbstractSqlMigrationWriter> createMigrationWriter() override;
  37
  38 public slots:
  39     /* General */
  40     bool isAvailable() const override;
  41     QString backendId() const override;
  42     QString displayName() const override;
  43     QString description() const override;
  44     QVariantList setupData() const override;
  45
  46     // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
  47
  48     /* User handling */
  49
  50     UserId addUser(const QString &user, const QString &password, const QString &authenticator = "Database") override;
  51     bool updateUser(UserId user, const QString &password) override;
  52     void renameUser(UserId user, const QString &newName) override;
  53     UserId validateUser(const QString &user, const QString &password) override;
  54     UserId getUserId(const QString &username) override;
  55     QString getUserAuthenticator(const UserId userid) override;
  56     UserId internalUser() override;
  57     void delUser(UserId user) override;
  58     void setUserSetting(UserId userId, const QString &settingName, const QVariant &data) override;
  59     QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &defaultData = QVariant()) override;
  60
  61     /* Identity handling */
  62     IdentityId createIdentity(UserId user, CoreIdentity &identity) override;
  63     bool updateIdentity(UserId user, const CoreIdentity &identity) override;
  64     void removeIdentity(UserId user, IdentityId identityId) override;
  65     QList<CoreIdentity> identities(UserId user) override;
  66
  67     /* Network handling */
  68     NetworkId createNetwork(UserId user, const NetworkInfo &info) override;
  69     bool updateNetwork(UserId user, const NetworkInfo &info) override;
  70     bool removeNetwork(UserId user, const NetworkId &networkId) override;
  71     QList<NetworkInfo> networks(UserId user) override;
  72     QList<NetworkId> connectedNetworks(UserId user) override;
  73     void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected) override;
  74
  75     /* persistent channels */
  76     QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId) override;
  77     void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined) override;
  78     void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key) override;
  79
  80     /* persistent user states */
  81     QString awayMessage(UserId user, NetworkId networkId) override;
  82     void setAwayMessage(UserId user, NetworkId networkId, const QString &awayMsg) override;
  83     QString userModes(UserId user, NetworkId networkId) override;
  84     void setUserModes(UserId user, NetworkId networkId, const QString &userModes) override;
  85
  86     /* Buffer handling */
  87     BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "", bool create = true) override;
  88     BufferInfo getBufferInfo(UserId user, const BufferId &bufferId) override;
  89     QList<BufferInfo> requestBuffers(UserId user) override;
  90     QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId) override;
  91     bool removeBuffer(const UserId &user, const BufferId &bufferId) override;
  92     bool renameBuffer(const UserId &user, const BufferId &bufferId, const QString &newName) override;
  93     bool mergeBuffersPermanently(const UserId &user, const BufferId &bufferId1, const BufferId &bufferId2) override;
  94     void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) override;
  95     QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user) override;
  96     void setBufferMarkerLineMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) override;
  97     QHash<BufferId, MsgId> bufferMarkerLineMsgIds(UserId user) override;
  98     void setBufferActivity(UserId id, BufferId bufferId, Message::Types type) override;
  99     QHash<BufferId, Message::Types> bufferActivities(UserId id) override;
 100     Message::Types bufferActivity(BufferId bufferId, MsgId lastSeenMsgId) override;
 101     void setHighlightCount(UserId id, BufferId bufferId, int count) override;
 102     QHash<BufferId, int> highlightCounts(UserId id) override;
 103     int highlightCount(BufferId bufferId, MsgId lastSeenMsgId) override;
 104     QHash<QString, QByteArray> bufferCiphers(UserId user, const NetworkId &networkId) override;
 105     void setBufferCipher(UserId user, const NetworkId &networkId, const QString &bufferName, const QByteArray &cipher) override;
 106
 107     /* Message handling */
 108     bool logMessage(Message &msg) override;
 109     bool logMessages(MessageList &msgs) override;
 110     QList<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) override;
 111     QList<Message> requestMsgsFiltered(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1,
 112                                        int limit = -1, Message::Types type = Message::Types{-1},
 113                                        Message::Flags flags = Message::Flags{-1}) override;
 114     QList<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) override;
 115     QList<Message> requestAllMsgsFiltered(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1,
 116                                           Message::Types type = Message::Types{-1},
 117                                           Message::Flags flags = Message::Flags{-1}) override;
 118
 119     /* Sysident handling */
 120     QMap<UserId, QString> getAllAuthUserNames() override;
 121     QString getAuthUserName(UserId user) override;
 122
 123 protected:
 124     bool initDbSession(QSqlDatabase &db) override;
 125     void setConnectionProperties(const QVariantMap &properties) override;
 126     QString driverName()  override { return "QPSQL"; }
 127     QString hostName()  override { return _hostName; }
 128     int port()  override { return _port; }
 129     QString databaseName()  override { return _databaseName; }
 130     QString userName()  override { return _userName; }
 131     QString password()  override { return _password; }
 132     int installedSchemaVersion() override;
 133     bool updateSchemaVersion(int newVersion) override;
 134     bool setupSchemaVersion(int version) override;
 135     void safeExec(QSqlQuery &query);
 136
 137     bool beginTransaction(QSqlDatabase &db);
 138     bool beginReadOnlyTransaction(QSqlDatabase &db);
 139
 140     QSqlQuery executePreparedQuery(const QString &queryname, const QVariantList &params, QSqlDatabase &db);
 141     QSqlQuery executePreparedQuery(const QString &queryname, const QVariant &param, QSqlDatabase &db);
 142     void deallocateQuery(const QString &queryname, const QSqlDatabase &db);
 143
 144     void savePoint(const QString &handle, const QSqlDatabase &db) { db.exec(QString("SAVEPOINT %1").arg(handle)); }
 145     void rollbackSavePoint(const QString &handle, const QSqlDatabase &db) { db.exec(QString("ROLLBACK TO SAVEPOINT %1").arg(handle)); }
 146     void releaseSavePoint(const QString &handle, const QSqlDatabase &db) { db.exec(QString("RELEASE SAVEPOINT %1").arg(handle)); }
 147
 148 private:
 149     void bindNetworkInfo(QSqlQuery &query, const NetworkInfo &info);
 150     void bindServerInfo(QSqlQuery &query, const Network::Server &server);
 151     QSqlQuery prepareAndExecuteQuery(const QString &queryname, const QString &paramstring, QSqlDatabase &db);
 152     QSqlQuery prepareAndExecuteQuery(const QString &queryname, QSqlDatabase &db) { return prepareAndExecuteQuery(queryname, QString(), db); }
 153
 154     QString _hostName;
 155     int _port;
 156     QString _databaseName;
 157     QString _userName;
 158     QString _password;
 159 };
 160
 161
 162 // ========================================
 163 //  PostgreSqlMigration
 164 // ========================================
 165 class PostgreSqlMigrationWriter : public PostgreSqlStorage, public AbstractSqlMigrationWriter
 166 {
 167     Q_OBJECT
 168
 169 public:
 170     PostgreSqlMigrationWriter();
 171
 172     bool writeMo(const QuasselUserMO &user) override;
 173     bool writeMo(const SenderMO &sender) override;
 174     bool writeMo(const IdentityMO &identity) override;
 175     bool writeMo(const IdentityNickMO &identityNick) override;
 176     bool writeMo(const NetworkMO &network) override;
 177     bool writeMo(const BufferMO &buffer) override;
 178     bool writeMo(const BacklogMO &backlog) override;
 179     bool writeMo(const IrcServerMO &ircserver) override;
 180     bool writeMo(const UserSettingMO &userSetting) override;
 181
 182     bool prepareQuery(MigrationObject mo) override;
 183
 184     bool postProcess() override;
 185
 186 protected:
 187     inline bool transaction()  override { return logDb().transaction(); }
 188     inline void rollback()  override { logDb().rollback(); }
 189     inline bool commit()  override { return logDb().commit(); }
 190
 191 private:
 192     // helper struct
 193     struct Sequence {
 194         QLatin1String table;
 195         QLatin1String field;
 196         Sequence(const char *table, const char *field) : table(table), field(field) {}
 197     };
 198
 199     QSet<int> _validIdentities;
 200 };