src/core/postgresqlstorage.h

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