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 <QSqlDatabase>
26 #include "abstractsqlstorage.h"
28 class PostgreSqlStorage : public AbstractSqlStorage
33 PostgreSqlStorage(QObject* parent = nullptr);
35 std::unique_ptr<AbstractSqlMigrationWriter> createMigrationWriter() override;
39 bool isAvailable() const override;
40 QString backendId() const override;
41 QString displayName() const override;
42 QString description() const override;
43 QVariantList setupData() const override;
45 // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
49 UserId addUser(const QString& user, const QString& password, const QString& authenticator = "Database") override;
50 bool updateUser(UserId user, const QString& password) override;
51 void renameUser(UserId user, const QString& newName) override;
52 UserId validateUser(const QString& user, const QString& password) override;
53 UserId getUserId(const QString& username) override;
54 QString getUserAuthenticator(const UserId userid) override;
55 UserId internalUser() override;
56 void delUser(UserId user) override;
57 void setUserSetting(UserId userId, const QString& settingName, const QVariant& data) override;
58 QVariant getUserSetting(UserId userId, const QString& settingName, const QVariant& defaultData = QVariant()) override;
59 void setCoreState(const QVariantList& data) override;
60 QVariantList getCoreState(const QVariantList& data) override;
62 /* Identity handling */
63 IdentityId createIdentity(UserId user, CoreIdentity& identity) override;
64 bool updateIdentity(UserId user, const CoreIdentity& identity) override;
65 void removeIdentity(UserId user, IdentityId identityId) override;
66 QList<CoreIdentity> identities(UserId user) override;
68 /* Network handling */
69 NetworkId createNetwork(UserId user, const NetworkInfo& info) override;
70 bool updateNetwork(UserId user, const NetworkInfo& info) override;
71 bool removeNetwork(UserId user, const NetworkId& networkId) override;
72 QList<NetworkInfo> networks(UserId user) override;
73 QList<NetworkId> connectedNetworks(UserId user) override;
74 void setNetworkConnected(UserId user, const NetworkId& networkId, bool isConnected) override;
76 /* persistent channels */
77 QHash<QString, QString> persistentChannels(UserId user, const NetworkId& networkId) override;
78 void setChannelPersistent(UserId user, const NetworkId& networkId, const QString& channel, bool isJoined) override;
79 void setPersistentChannelKey(UserId user, const NetworkId& networkId, const QString& channel, const QString& key) override;
81 /* persistent user states */
82 QString awayMessage(UserId user, NetworkId networkId) override;
83 void setAwayMessage(UserId user, NetworkId networkId, const QString& awayMsg) override;
84 QString userModes(UserId user, NetworkId networkId) override;
85 void setUserModes(UserId user, NetworkId networkId, const QString& userModes) override;
88 BufferInfo bufferInfo(UserId user, const NetworkId& networkId, BufferInfo::Type type, const QString& buffer = "", bool create = true) override;
89 BufferInfo getBufferInfo(UserId user, const BufferId& bufferId) override;
90 QList<BufferInfo> requestBuffers(UserId user) override;
91 QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId) override;
92 bool removeBuffer(const UserId& user, const BufferId& bufferId) override;
93 bool renameBuffer(const UserId& user, const BufferId& bufferId, const QString& newName) override;
94 bool mergeBuffersPermanently(const UserId& user, const BufferId& bufferId1, const BufferId& bufferId2) 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 QList<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) override;
112 QList<Message> requestMsgsFiltered(UserId user,
117 Message::Types type = Message::Types{-1},
118 Message::Flags flags = Message::Flags{-1}) override;
119 QList<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) override;
120 QList<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) override;
141 bool setupSchemaVersion(int version) override;
142 void safeExec(QSqlQuery& query);
144 bool beginTransaction(QSqlDatabase& db);
145 bool beginReadOnlyTransaction(QSqlDatabase& db);
147 QSqlQuery executePreparedQuery(const QString& queryname, const QVariantList& params, QSqlDatabase& db);
148 QSqlQuery executePreparedQuery(const QString& queryname, const QVariant& param, QSqlDatabase& db);
149 void deallocateQuery(const QString& queryname, const QSqlDatabase& db);
151 void savePoint(const QString& handle, const QSqlDatabase& db) { db.exec(QString("SAVEPOINT %1").arg(handle)); }
152 void rollbackSavePoint(const QString& handle, const QSqlDatabase& db) { db.exec(QString("ROLLBACK TO SAVEPOINT %1").arg(handle)); }
153 void releaseSavePoint(const QString& handle, const QSqlDatabase& db) { db.exec(QString("RELEASE SAVEPOINT %1").arg(handle)); }
156 void bindNetworkInfo(QSqlQuery& query, const NetworkInfo& info);
157 void bindServerInfo(QSqlQuery& query, const Network::Server& server);
158 QSqlQuery prepareAndExecuteQuery(const QString& queryname, const QString& paramstring, QSqlDatabase& db);
159 QSqlQuery prepareAndExecuteQuery(const QString& queryname, QSqlDatabase& db)
161 return prepareAndExecuteQuery(queryname, QString(), db);
166 QString _databaseName;
171 // ========================================
172 // PostgreSqlMigration
173 // ========================================
174 class PostgreSqlMigrationWriter : public PostgreSqlStorage, public AbstractSqlMigrationWriter
179 PostgreSqlMigrationWriter();
181 bool writeMo(const QuasselUserMO& user) override;
182 bool writeMo(const SenderMO& sender) override;
183 bool writeMo(const IdentityMO& identity) override;
184 bool writeMo(const IdentityNickMO& identityNick) override;
185 bool writeMo(const NetworkMO& network) override;
186 bool writeMo(const BufferMO& buffer) override;
187 bool writeMo(const BacklogMO& backlog) override;
188 bool writeMo(const IrcServerMO& ircserver) override;
189 bool writeMo(const UserSettingMO& userSetting) override;
190 bool writeMo(const CoreStateMO& coreState) override;
192 bool prepareQuery(MigrationObject mo) override;
194 bool postProcess() override;
197 inline bool transaction() override { return logDb().transaction(); }
198 inline void rollback() override { logDb().rollback(); }
199 inline bool commit() override { return logDb().commit(); }
207 Sequence(const char* table, const char* field)
213 QSet<int> _validIdentities;