1 /***************************************************************************
2 * Copyright (C) 2005-09 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
21 #ifndef POSTGRESQLSTORAGE_H
22 #define POSTGRESQLSTORAGE_H
24 #include "abstractsqlstorage.h"
26 #include <QSqlDatabase>
29 class PostgreSqlStorage : public AbstractSqlStorage {
33 PostgreSqlStorage(QObject *parent = 0);
34 virtual ~PostgreSqlStorage();
36 virtual AbstractSqlMigrationWriter *createMigrationWriter();
40 virtual bool isAvailable() const;
41 virtual QString displayName() const;
42 virtual QString description() const;
43 virtual QVariantMap setupKeys() const;
44 virtual bool setup(const QVariantMap &settings = QVariantMap());
46 // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
50 virtual UserId addUser(const QString &user, const QString &password);
51 virtual void 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 internalUser();
55 virtual void delUser(UserId user);
56 virtual void setUserSetting(UserId userId, const QString &settingName, const QVariant &data);
57 virtual QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &defaultData = QVariant());
59 /* Identity handling */
60 virtual IdentityId createIdentity(UserId user, CoreIdentity &identity);
61 virtual bool updateIdentity(UserId user, const CoreIdentity &identity);
62 virtual void removeIdentity(UserId user, IdentityId identityId);
63 virtual QList<CoreIdentity> identities(UserId user);
65 /* Network handling */
66 virtual NetworkId createNetwork(UserId user, const NetworkInfo &info);
67 virtual bool updateNetwork(UserId user, const NetworkInfo &info);
68 virtual bool removeNetwork(UserId user, const NetworkId &networkId);
69 virtual QList<NetworkInfo> networks(UserId user);
70 virtual QList<NetworkId> connectedNetworks(UserId user);
71 virtual void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected);
73 /* persistent channels */
74 virtual QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId);
75 virtual void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined);
76 virtual void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key);
78 /* persistent user states */
79 virtual QString awayMessage(UserId user, NetworkId networkId);
80 virtual void setAwayMessage(UserId user, NetworkId networkId, const QString &awayMsg);
81 virtual QString userModes(UserId user, NetworkId networkId);
82 virtual void setUserModes(UserId user, NetworkId networkId, const QString &userModes);
85 virtual BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "", bool create = true);
86 virtual BufferInfo getBufferInfo(UserId user, const BufferId &bufferId);
87 virtual QList<BufferInfo> requestBuffers(UserId user);
88 virtual QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId);
89 virtual bool removeBuffer(const UserId &user, const BufferId &bufferId);
90 virtual bool renameBuffer(const UserId &user, const BufferId &bufferId, const QString &newName);
91 virtual bool mergeBuffersPermanently(const UserId &user, const BufferId &bufferId1, const BufferId &bufferId2);
92 virtual void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId);
93 virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user);
95 /* Message handling */
96 virtual bool logMessage(Message &msg);
97 virtual bool logMessages(MessageList &msgs);
98 virtual QList<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1);
99 virtual QList<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1);
102 virtual void setConnectionProperties(const QVariantMap &properties);
103 inline virtual QString driverName() { return "QPSQL"; }
104 inline virtual QString hostName() { return _hostName; }
105 inline virtual int port() { return _port; }
106 inline virtual QString databaseName() { return _databaseName; }
107 inline virtual QString userName() { return _userName; }
108 inline virtual QString password() { return _password; }
109 virtual int installedSchemaVersion();
110 virtual bool updateSchemaVersion(int newVersion);
111 virtual bool setupSchemaVersion(int version);
112 void safeExec(QSqlQuery &query);
114 bool beginReadOnlyTransaction(QSqlDatabase &db);
116 bool prepareQuery(const QString &handle, const QString &query, const QSqlDatabase &db);
117 QSqlQuery executePreparedQuery(const QString &handle, const QVariantList ¶ms, const QSqlDatabase &db);
118 QSqlQuery executePreparedQuery(const QString &handle, const QVariant ¶m, const QSqlDatabase &db);
119 void deallocateQuery(const QString &handle, const QSqlDatabase &db);
121 inline void savePoint(const QString &handle, const QSqlDatabase &db) { db.exec(QString("SAVEPOINT %1").arg(handle)); }
122 inline void rollbackSavePoint(const QString &handle, const QSqlDatabase &db) { db.exec(QString("ROLLBACK TO SAVEPOINT %1").arg(handle)); }
123 inline void releaseSavePoint(const QString &handle, const QSqlDatabase &db) { db.exec(QString("RELEASE SAVEPOINT %1").arg(handle)); }
126 void bindNetworkInfo(QSqlQuery &query, const NetworkInfo &info);
127 void bindServerInfo(QSqlQuery &query, const Network::Server &server);
131 QString _databaseName;
135 typedef QHash<QString, QString> QueryHash;
136 QHash<QString, QueryHash> _preparedQueries; // one query hash per db connection
137 QMutex _queryHashMutex;
141 inline void PostgreSqlStorage::safeExec(QSqlQuery &query) { query.exec(); }
144 // ========================================
145 // PostgreSqlMigration
146 // ========================================
147 class PostgreSqlMigrationWriter : public PostgreSqlStorage, public AbstractSqlMigrationWriter {
151 PostgreSqlMigrationWriter();
153 virtual bool writeMo(const QuasselUserMO &user);
154 virtual bool writeMo(const SenderMO &sender);
155 virtual bool writeMo(const IdentityMO &identity);
156 virtual bool writeMo(const IdentityNickMO &identityNick);
157 virtual bool writeMo(const NetworkMO &network);
158 virtual bool writeMo(const BufferMO &buffer);
159 virtual bool writeMo(const BacklogMO &backlog);
160 virtual bool writeMo(const IrcServerMO &ircserver);
161 virtual bool writeMo(const UserSettingMO &userSetting);
163 bool prepareQuery(MigrationObject mo);
165 virtual bool postProcess();
168 virtual inline bool transaction() { return logDb().transaction(); }
169 virtual inline void rollback() { logDb().rollback(); }
170 virtual inline bool commit() { return logDb().commit(); }
177 Sequence(const char *table, const char *field) : table(table), field(field) {}
180 QSet<int> _validIdentities;