src/core/postgresqlstorage.h

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