1 /***************************************************************************
2 * Copyright (C) 2005-2018 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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
23 #include "abstractsqlstorage.h"
25 #include <QSqlDatabase>
28 class PostgreSqlStorage : public AbstractSqlStorage
33 PostgreSqlStorage(QObject *parent = 0);
34 ~PostgreSqlStorage() override;
36 std::unique_ptr<AbstractSqlMigrationWriter> createMigrationWriter() override;
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;
46 // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
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;
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;
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;
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;
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;
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;
102 /* Message handling */
103 bool logMessage(Message &msg) override;
104 bool logMessages(MessageList &msgs) override;
105 QList<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) override;
106 QList<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) override;
109 bool initDbSession(QSqlDatabase &db) override;
110 void setConnectionProperties(const QVariantMap &properties) override;
111 QString driverName() override { return "QPSQL"; }
112 QString hostName() override { return _hostName; }
113 int port() override { return _port; }
114 QString databaseName() override { return _databaseName; }
115 QString userName() override { return _userName; }
116 QString password() override { return _password; }
117 int installedSchemaVersion() override;
118 bool updateSchemaVersion(int newVersion) override;
119 bool setupSchemaVersion(int version) override;
120 void safeExec(QSqlQuery &query);
122 bool beginTransaction(QSqlDatabase &db);
123 bool beginReadOnlyTransaction(QSqlDatabase &db);
125 QSqlQuery executePreparedQuery(const QString &queryname, const QVariantList ¶ms, QSqlDatabase &db);
126 QSqlQuery executePreparedQuery(const QString &queryname, const QVariant ¶m, QSqlDatabase &db);
127 void deallocateQuery(const QString &queryname, const QSqlDatabase &db);
129 void savePoint(const QString &handle, const QSqlDatabase &db) { db.exec(QString("SAVEPOINT %1").arg(handle)); }
130 void rollbackSavePoint(const QString &handle, const QSqlDatabase &db) { db.exec(QString("ROLLBACK TO SAVEPOINT %1").arg(handle)); }
131 void releaseSavePoint(const QString &handle, const QSqlDatabase &db) { db.exec(QString("RELEASE SAVEPOINT %1").arg(handle)); }
134 void bindNetworkInfo(QSqlQuery &query, const NetworkInfo &info);
135 void bindServerInfo(QSqlQuery &query, const Network::Server &server);
136 QSqlQuery prepareAndExecuteQuery(const QString &queryname, const QString ¶mstring, QSqlDatabase &db);
137 QSqlQuery prepareAndExecuteQuery(const QString &queryname, QSqlDatabase &db) { return prepareAndExecuteQuery(queryname, QString(), db); }
141 QString _databaseName;
147 // ========================================
148 // PostgreSqlMigration
149 // ========================================
150 class PostgreSqlMigrationWriter : public PostgreSqlStorage, public AbstractSqlMigrationWriter
155 PostgreSqlMigrationWriter();
157 bool writeMo(const QuasselUserMO &user) override;
158 bool writeMo(const SenderMO &sender) override;
159 bool writeMo(const IdentityMO &identity) override;
160 bool writeMo(const IdentityNickMO &identityNick) override;
161 bool writeMo(const NetworkMO &network) override;
162 bool writeMo(const BufferMO &buffer) override;
163 bool writeMo(const BacklogMO &backlog) override;
164 bool writeMo(const IrcServerMO &ircserver) override;
165 bool writeMo(const UserSettingMO &userSetting) override;
167 bool prepareQuery(MigrationObject mo) override;
169 bool postProcess() override;
172 inline bool transaction() override { return logDb().transaction(); }
173 inline void rollback() override { logDb().rollback(); }
174 inline bool commit() override { return logDb().commit(); }
181 Sequence(const char *table, const char *field) : table(table), field(field) {}
184 QSet<int> _validIdentities;