/***************************************************************************
- * Copyright (C) 2005-09 by the Quassel Project *
+ * Copyright (C) 2005-2020 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
-#ifndef POSTGRESQLSTORAGE_H
-#define POSTGRESQLSTORAGE_H
-
-#include "abstractsqlstorage.h"
+#pragma once
#include <QSqlDatabase>
#include <QSqlQuery>
-class PostgreSqlStorage : public AbstractSqlStorage {
- Q_OBJECT
+#include "abstractsqlstorage.h"
+
+class PostgreSqlStorage : public AbstractSqlStorage
+{
+ Q_OBJECT
public:
- PostgreSqlStorage(QObject *parent = 0);
- virtual ~PostgreSqlStorage();
-
- virtual AbstractSqlMigrationWriter *createMigrationWriter();
-
-public slots:
- /* General */
- virtual bool isAvailable() const;
- virtual QString displayName() const;
- virtual QString description() const;
- virtual QVariantMap setupKeys() const;
- virtual bool setup(const QVariantMap &settings = QVariantMap());
-
- // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
-
- /* User handling */
-
- virtual UserId addUser(const QString &user, const QString &password);
- virtual void updateUser(UserId user, const QString &password);
- virtual void renameUser(UserId user, const QString &newName);
- virtual UserId validateUser(const QString &user, const QString &password);
- virtual UserId internalUser();
- virtual void delUser(UserId user);
- virtual void setUserSetting(UserId userId, const QString &settingName, const QVariant &data);
- virtual QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &defaultData = QVariant());
-
- /* Identity handling */
- virtual IdentityId createIdentity(UserId user, CoreIdentity &identity);
- virtual bool updateIdentity(UserId user, const CoreIdentity &identity);
- virtual void removeIdentity(UserId user, IdentityId identityId);
- virtual QList<CoreIdentity> identities(UserId user);
-
- /* Network handling */
- virtual NetworkId createNetwork(UserId user, const NetworkInfo &info);
- virtual bool updateNetwork(UserId user, const NetworkInfo &info);
- virtual bool removeNetwork(UserId user, const NetworkId &networkId);
- virtual QList<NetworkInfo> networks(UserId user);
- virtual QList<NetworkId> connectedNetworks(UserId user);
- virtual void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected);
-
- /* persistent channels */
- virtual QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId);
- virtual void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined);
- virtual void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key);
-
- /* persistent user states */
- virtual QString awayMessage(UserId user, NetworkId networkId);
- virtual void setAwayMessage(UserId user, NetworkId networkId, const QString &awayMsg);
- virtual QString userModes(UserId user, NetworkId networkId);
- virtual void setUserModes(UserId user, NetworkId networkId, const QString &userModes);
-
- /* Buffer handling */
- virtual BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "", bool create = true);
- virtual BufferInfo getBufferInfo(UserId user, const BufferId &bufferId);
- virtual QList<BufferInfo> requestBuffers(UserId user);
- virtual QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId);
- virtual bool removeBuffer(const UserId &user, const BufferId &bufferId);
- virtual bool renameBuffer(const UserId &user, const BufferId &bufferId, const QString &newName);
- virtual bool mergeBuffersPermanently(const UserId &user, const BufferId &bufferId1, const BufferId &bufferId2);
- virtual void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId);
- virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user);
-
- /* Message handling */
- virtual bool logMessage(Message &msg);
- virtual bool logMessages(MessageList &msgs);
- virtual QList<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1);
- virtual QList<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1);
+ PostgreSqlStorage(QObject* parent = nullptr);
+
+ std::unique_ptr<AbstractSqlMigrationWriter> createMigrationWriter() override;
+
+ /* General */
+ bool isAvailable() const override;
+ QString backendId() const override;
+ QString displayName() const override;
+ QString description() const override;
+ QVariantList setupData() const override;
+
+ // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
+
+ /* User handling */
+
+ UserId addUser(const QString& user, const QString& password, const QString& authenticator = "Database") override;
+ bool updateUser(UserId user, const QString& password) override;
+ void renameUser(UserId user, const QString& newName) override;
+ UserId validateUser(const QString& user, const QString& password) override;
+ UserId getUserId(const QString& username) override;
+ QString getUserAuthenticator(const UserId userid) override;
+ UserId internalUser() override;
+ void delUser(UserId user) override;
+ void setUserSetting(UserId userId, const QString& settingName, const QVariant& data) override;
+ QVariant getUserSetting(UserId userId, const QString& settingName, const QVariant& defaultData = QVariant()) override;
+ void setCoreState(const QVariantList& data) override;
+ QVariantList getCoreState(const QVariantList& data) override;
+
+ /* Identity handling */
+ IdentityId createIdentity(UserId user, CoreIdentity& identity) override;
+ bool updateIdentity(UserId user, const CoreIdentity& identity) override;
+ void removeIdentity(UserId user, IdentityId identityId) override;
+ std::vector<CoreIdentity> identities(UserId user) override;
+
+ /* Network handling */
+ NetworkId createNetwork(UserId user, const NetworkInfo& info) override;
+ bool updateNetwork(UserId user, const NetworkInfo& info) override;
+ bool removeNetwork(UserId user, const NetworkId& networkId) override;
+ std::vector<NetworkInfo> networks(UserId user) override;
+ std::vector<NetworkId> connectedNetworks(UserId user) override;
+ void setNetworkConnected(UserId user, const NetworkId& networkId, bool isConnected) override;
+
+ /* persistent channels */
+ QHash<QString, QString> persistentChannels(UserId user, const NetworkId& networkId) override;
+ void setChannelPersistent(UserId user, const NetworkId& networkId, const QString& channel, bool isJoined) override;
+ void setPersistentChannelKey(UserId user, const NetworkId& networkId, const QString& channel, const QString& key) override;
+
+ /* persistent user states */
+ QString awayMessage(UserId user, NetworkId networkId) override;
+ void setAwayMessage(UserId user, NetworkId networkId, const QString& awayMsg) override;
+ QString userModes(UserId user, NetworkId networkId) override;
+ void setUserModes(UserId user, NetworkId networkId, const QString& userModes) override;
+
+ /* Buffer handling */
+ BufferInfo bufferInfo(UserId user, const NetworkId& networkId, BufferInfo::Type type, const QString& buffer = "", bool create = true) override;
+ BufferInfo getBufferInfo(UserId user, const BufferId& bufferId) override;
+ std::vector<BufferInfo> requestBuffers(UserId user) override;
+ std::vector<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId) override;
+ bool removeBuffer(const UserId& user, const BufferId& bufferId) override;
+ bool renameBuffer(const UserId& user, const BufferId& bufferId, const QString& newName) override;
+ bool mergeBuffersPermanently(const UserId& user, const BufferId& bufferId1, const BufferId& bufferId2) override;
+ QHash<BufferId, MsgId> bufferLastMsgIds(UserId user) override;
+ void setBufferLastSeenMsg(UserId user, const BufferId& bufferId, const MsgId& msgId) override;
+ QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user) override;
+ void setBufferMarkerLineMsg(UserId user, const BufferId& bufferId, const MsgId& msgId) override;
+ QHash<BufferId, MsgId> bufferMarkerLineMsgIds(UserId user) override;
+ void setBufferActivity(UserId id, BufferId bufferId, Message::Types type) override;
+ QHash<BufferId, Message::Types> bufferActivities(UserId id) override;
+ Message::Types bufferActivity(BufferId bufferId, MsgId lastSeenMsgId) override;
+ void setHighlightCount(UserId id, BufferId bufferId, int count) override;
+ QHash<BufferId, int> highlightCounts(UserId id) override;
+ int highlightCount(BufferId bufferId, MsgId lastSeenMsgId) override;
+ QHash<QString, QByteArray> bufferCiphers(UserId user, const NetworkId& networkId) override;
+ void setBufferCipher(UserId user, const NetworkId& networkId, const QString& bufferName, const QByteArray& cipher) override;
+
+ /* Message handling */
+ bool logMessage(Message& msg) override;
+ bool logMessages(MessageList& msgs) override;
+ std::vector<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) override;
+ std::vector<Message> requestMsgsFiltered(UserId user,
+ BufferId bufferId,
+ MsgId first = -1,
+ MsgId last = -1,
+ int limit = -1,
+ Message::Types type = Message::Types{-1},
+ Message::Flags flags = Message::Flags{-1}) override;
+ std::vector<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) override;
+ std::vector<Message> requestAllMsgsFiltered(UserId user,
+ MsgId first = -1,
+ MsgId last = -1,
+ int limit = -1,
+ Message::Types type = Message::Types{-1},
+ Message::Flags flags = Message::Flags{-1}) override;
+
+ /* Sysident handling */
+ QMap<UserId, QString> getAllAuthUserNames() override;
protected:
- virtual void setConnectionProperties(const QVariantMap &properties);
- inline virtual QString driverName() { return "QPSQL"; }
- inline virtual QString hostName() { return _hostName; }
- inline virtual int port() { return _port; }
- inline virtual QString databaseName() { return _databaseName; }
- inline virtual QString userName() { return _userName; }
- inline virtual QString password() { return _password; }
- virtual int installedSchemaVersion();
- virtual bool updateSchemaVersion(int newVersion);
- virtual bool setupSchemaVersion(int version);
- void safeExec(QSqlQuery &query);
-
- bool beginReadOnlyTransaction(QSqlDatabase &db);
-
- bool prepareQuery(const QString &handle, const QString &query, const QSqlDatabase &db);
- QSqlQuery executePreparedQuery(const QString &handle, const QVariantList ¶ms, const QSqlDatabase &db);
- QSqlQuery executePreparedQuery(const QString &handle, const QVariant ¶m, const QSqlDatabase &db);
- void deallocateQuery(const QString &handle, const QSqlDatabase &db);
-
- inline void savePoint(const QString &handle, const QSqlDatabase &db) { db.exec(QString("SAVEPOINT %1").arg(handle)); }
- inline void rollbackSavePoint(const QString &handle, const QSqlDatabase &db) { db.exec(QString("ROLLBACK TO SAVEPOINT %1").arg(handle)); }
- inline void releaseSavePoint(const QString &handle, const QSqlDatabase &db) { db.exec(QString("RELEASE SAVEPOINT %1").arg(handle)); }
+ bool initDbSession(QSqlDatabase& db) override;
+ void setConnectionProperties(const QVariantMap& properties, const QProcessEnvironment& environment, bool loadFromEnvironment) override;
+ QString driverName() override { return "QPSQL"; }
+ QString hostName() override { return _hostName; }
+ int port() override { return _port; }
+ QString databaseName() override { return _databaseName; }
+ QString userName() override { return _userName; }
+ QString password() override { return _password; }
+ int installedSchemaVersion() override;
+ bool updateSchemaVersion(int newVersion, bool clearUpgradeStep) override;
+ bool setupSchemaVersion(int version) override;
+
+ /**
+ * Gets the last successful schema upgrade step, or an empty string if no upgrade is in progress
+ *
+ * @return Filename of last successful schema upgrade query, or empty string if not upgrading
+ */
+ QString schemaVersionUpgradeStep() override;
+
+ /**
+ * Sets the last successful schema upgrade step
+ *
+ * @param upgradeQuery The filename of the last successful schema upgrade query
+ * @return True if successfully set, otherwise false
+ */
+ virtual bool setSchemaVersionUpgradeStep(QString upgradeQuery) override;
+
+ void safeExec(QSqlQuery& query);
+
+ bool beginTransaction(QSqlDatabase& db);
+ bool beginReadOnlyTransaction(QSqlDatabase& db);
+
+ QSqlQuery executePreparedQuery(const QString& queryname, const QVariantList& params, QSqlDatabase& db);
+ QSqlQuery executePreparedQuery(const QString& queryname, const QVariant& param, QSqlDatabase& db);
+ void deallocateQuery(const QString& queryname, const QSqlDatabase& db);
+
+ void savePoint(const QString& handle, const QSqlDatabase& db) { db.exec(QString("SAVEPOINT %1").arg(handle)); }
+ void rollbackSavePoint(const QString& handle, const QSqlDatabase& db) { db.exec(QString("ROLLBACK TO SAVEPOINT %1").arg(handle)); }
+ void releaseSavePoint(const QString& handle, const QSqlDatabase& db) { db.exec(QString("RELEASE SAVEPOINT %1").arg(handle)); }
private:
- void bindNetworkInfo(QSqlQuery &query, const NetworkInfo &info);
- void bindServerInfo(QSqlQuery &query, const Network::Server &server);
-
- QString _hostName;
- int _port;
- QString _databaseName;
- QString _userName;
- QString _password;
-
- typedef QHash<QString, QString> QueryHash;
- QHash<QString, QueryHash> _preparedQueries; // one query hash per db connection
- QMutex _queryHashMutex;
-
+ void bindNetworkInfo(QSqlQuery& query, const NetworkInfo& info);
+ void bindServerInfo(QSqlQuery& query, const Network::Server& server);
+ QSqlQuery prepareAndExecuteQuery(const QString& queryname, const QString& paramstring, QSqlDatabase& db);
+ QSqlQuery prepareAndExecuteQuery(const QString& queryname, QSqlDatabase& db)
+ {
+ return prepareAndExecuteQuery(queryname, QString(), db);
+ }
+
+ QString _hostName;
+ int _port{-1};
+ QString _databaseName;
+ QString _userName;
+ QString _password;
};
-inline void PostgreSqlStorage::safeExec(QSqlQuery &query) { query.exec(); }
-
-
// ========================================
// PostgreSqlMigration
// ========================================
-class PostgreSqlMigrationWriter : public PostgreSqlStorage, public AbstractSqlMigrationWriter {
- Q_OBJECT
+class PostgreSqlMigrationWriter : public PostgreSqlStorage, public AbstractSqlMigrationWriter
+{
+ Q_OBJECT
public:
- PostgreSqlMigrationWriter();
+ PostgreSqlMigrationWriter();
- virtual bool writeMo(const QuasselUserMO &user);
- virtual bool writeMo(const SenderMO &sender);
- virtual bool writeMo(const IdentityMO &identity);
- virtual bool writeMo(const IdentityNickMO &identityNick);
- virtual bool writeMo(const NetworkMO &network);
- virtual bool writeMo(const BufferMO &buffer);
- virtual bool writeMo(const BacklogMO &backlog);
- virtual bool writeMo(const IrcServerMO &ircserver);
- virtual bool writeMo(const UserSettingMO &userSetting);
+ bool writeMo(const QuasselUserMO& user) override;
+ bool writeMo(const SenderMO& sender) override;
+ bool writeMo(const IdentityMO& identity) override;
+ bool writeMo(const IdentityNickMO& identityNick) override;
+ bool writeMo(const NetworkMO& network) override;
+ bool writeMo(const BufferMO& buffer) override;
+ bool writeMo(const BacklogMO& backlog) override;
+ bool writeMo(const IrcServerMO& ircserver) override;
+ bool writeMo(const UserSettingMO& userSetting) override;
+ bool writeMo(const CoreStateMO& coreState) override;
- bool prepareQuery(MigrationObject mo);
+ bool prepareQuery(MigrationObject mo) override;
- virtual bool postProcess();
+ bool postProcess() override;
protected:
- virtual inline bool transaction() { return logDb().transaction(); }
- virtual inline void rollback() { logDb().rollback(); }
- virtual inline bool commit() { return logDb().commit(); }
+ inline bool transaction() override { return logDb().transaction(); }
+ inline void rollback() override { logDb().rollback(); }
+ inline bool commit() override { return logDb().commit(); }
private:
- // helper struct
- struct Sequence {
- QLatin1String table;
- QLatin1String field;
- Sequence(const char *table, const char *field) : table(table), field(field) {}
- };
+ // helper struct
+ struct Sequence
+ {
+ QLatin1String table;
+ QLatin1String field;
+ Sequence(const char* table, const char* field)
+ : table(table)
+ , field(field)
+ {}
+ };
+
+ QSet<int> _validIdentities;
};
-
-inline AbstractSqlMigrationWriter *PostgreSqlStorage::createMigrationWriter() {
- return new PostgreSqlMigrationWriter();
-}
-
-
-
-#endif
projects / quassel.git / blobdiff