1 /***************************************************************************
2 * Copyright (C) 2005-2020 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 <QSqlDatabase>
26 #include "abstractsqlstorage.h"
28 class PostgreSqlStorage : public AbstractSqlStorage
33 PostgreSqlStorage(QObject* parent = nullptr);
35 std::unique_ptr<AbstractSqlMigrationWriter> createMigrationWriter() override;
38 bool isAvailable() const override;
39 QString backendId() const override;
40 QString displayName() const override;
41 QString description() const override;
42 QVariantList setupData() const override;
44 // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
48 UserId addUser(const QString& user, const QString& password, const QString& authenticator = "Database") override;
49 bool updateUser(UserId user, const QString& password) override;
50 void renameUser(UserId user, const QString& newName) override;
51 UserId validateUser(const QString& user, const QString& password) override;
52 UserId getUserId(const QString& username) override;
53 QString getUserAuthenticator(const UserId userid) override;
54 UserId internalUser() override;
55 void delUser(UserId user) override;
56 void setUserSetting(UserId userId, const QString& settingName, const QVariant& data) override;
57 QVariant getUserSetting(UserId userId, const QString& settingName, const QVariant& defaultData = QVariant()) override;
58 void setCoreState(const QVariantList& data) override;
59 QVariantList getCoreState(const QVariantList& data) 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 std::vector<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 std::vector<NetworkInfo> networks(UserId user) override;
72 std::vector<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 std::vector<BufferInfo> requestBuffers(UserId user) override;
90 std::vector<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 QHash<BufferId, MsgId> bufferLastMsgIds(UserId user) override;
95 void setBufferLastSeenMsg(UserId user, const BufferId& bufferId, const MsgId& msgId) override;
96 QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user) override;
97 void setBufferMarkerLineMsg(UserId user, const BufferId& bufferId, const MsgId& msgId) override;
98 QHash<BufferId, MsgId> bufferMarkerLineMsgIds(UserId user) override;
99 void setBufferActivity(UserId id, BufferId bufferId, Message::Types type) override;
100 QHash<BufferId, Message::Types> bufferActivities(UserId id) override;
101 Message::Types bufferActivity(BufferId bufferId, MsgId lastSeenMsgId) override;
102 void setHighlightCount(UserId id, BufferId bufferId, int count) override;
103 QHash<BufferId, int> highlightCounts(UserId id) override;
104 int highlightCount(BufferId bufferId, MsgId lastSeenMsgId) override;
105 QHash<QString, QByteArray> bufferCiphers(UserId user, const NetworkId& networkId) override;
106 void setBufferCipher(UserId user, const NetworkId& networkId, const QString& bufferName, const QByteArray& cipher) override;
108 /* Message handling */
109 bool logMessage(Message& msg) override;
110 bool logMessages(MessageList& msgs) override;
111 std::vector<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) override;
112 std::vector<Message> requestMsgsFiltered(UserId user,
117 Message::Types type = Message::Types{-1},
118 Message::Flags flags = Message::Flags{-1}) override;
119 std::vector<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) override;
120 std::vector<Message> requestAllMsgsFiltered(UserId user,
124 Message::Types type = Message::Types{-1},
125 Message::Flags flags = Message::Flags{-1}) override;
127 /* Sysident handling */
128 QMap<UserId, QString> getAllAuthUserNames() override;
131 bool initDbSession(QSqlDatabase& db) override;
132 void setConnectionProperties(const QVariantMap& properties, const QProcessEnvironment& environment, bool loadFromEnvironment) override;
133 QString driverName() override { return "QPSQL"; }
134 QString hostName() override { return _hostName; }
135 int port() override { return _port; }
136 QString databaseName() override { return _databaseName; }
137 QString userName() override { return _userName; }
138 QString password() override { return _password; }
139 int installedSchemaVersion() override;
140 bool updateSchemaVersion(int newVersion, bool clearUpgradeStep) override;
141 bool setupSchemaVersion(int version) override;
144 * Gets the last successful schema upgrade step, or an empty string if no upgrade is in progress
146 * @return Filename of last successful schema upgrade query, or empty string if not upgrading
148 QString schemaVersionUpgradeStep() override;
151 * Sets the last successful schema upgrade step
153 * @param upgradeQuery The filename of the last successful schema upgrade query
154 * @return True if successfully set, otherwise false
156 virtual bool setSchemaVersionUpgradeStep(QString upgradeQuery) override;
158 void safeExec(QSqlQuery& query);
160 bool beginTransaction(QSqlDatabase& db);
161 bool beginReadOnlyTransaction(QSqlDatabase& db);
163 QSqlQuery executePreparedQuery(const QString& queryname, const QVariantList& params, QSqlDatabase& db);
164 QSqlQuery executePreparedQuery(const QString& queryname, const QVariant& param, QSqlDatabase& db);
165 void deallocateQuery(const QString& queryname, const QSqlDatabase& db);
167 void savePoint(const QString& handle, const QSqlDatabase& db) { db.exec(QString("SAVEPOINT %1").arg(handle)); }
168 void rollbackSavePoint(const QString& handle, const QSqlDatabase& db) { db.exec(QString("ROLLBACK TO SAVEPOINT %1").arg(handle)); }
169 void releaseSavePoint(const QString& handle, const QSqlDatabase& db) { db.exec(QString("RELEASE SAVEPOINT %1").arg(handle)); }
172 void bindNetworkInfo(QSqlQuery& query, const NetworkInfo& info);
173 void bindServerInfo(QSqlQuery& query, const Network::Server& server);
174 QSqlQuery prepareAndExecuteQuery(const QString& queryname, const QString& paramstring, QSqlDatabase& db);
175 QSqlQuery prepareAndExecuteQuery(const QString& queryname, QSqlDatabase& db)
177 return prepareAndExecuteQuery(queryname, QString(), db);
182 QString _databaseName;
187 // ========================================
188 // PostgreSqlMigration
189 // ========================================
190 class PostgreSqlMigrationWriter : public PostgreSqlStorage, public AbstractSqlMigrationWriter
195 PostgreSqlMigrationWriter();
197 bool writeMo(const QuasselUserMO& user) override;
198 bool writeMo(const SenderMO& sender) override;
199 bool writeMo(const IdentityMO& identity) override;
200 bool writeMo(const IdentityNickMO& identityNick) override;
201 bool writeMo(const NetworkMO& network) override;
202 bool writeMo(const BufferMO& buffer) override;
203 bool writeMo(const BacklogMO& backlog) override;
204 bool writeMo(const IrcServerMO& ircserver) override;
205 bool writeMo(const UserSettingMO& userSetting) override;
206 bool writeMo(const CoreStateMO& coreState) override;
208 bool prepareQuery(MigrationObject mo) override;
210 bool postProcess() override;
213 inline bool transaction() override { return logDb().transaction(); }
214 inline void rollback() override { logDb().rollback(); }
215 inline bool commit() override { return logDb().commit(); }
223 Sequence(const char* table, const char* field)
229 QSet<int> _validIdentities;