X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fpostgresqlstorage.h;h=78ddc9da4ff99711c530a4a6dad0db1e3f36f6ba;hp=73b16dccc100caa90119a979d51f0b54a2e0277e;hb=b134e777b822b929a78455fd92146bf7443e9aa1;hpb=9c5fd60f6264898a7c0287e3f7d47e181ef39f84 diff --git a/src/core/postgresqlstorage.h b/src/core/postgresqlstorage.h index 73b16dcc..78ddc9da 100644 --- a/src/core/postgresqlstorage.h +++ b/src/core/postgresqlstorage.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2014 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 * @@ -18,129 +18,173 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#ifndef POSTGRESQLSTORAGE_H -#define POSTGRESQLSTORAGE_H - -#include "abstractsqlstorage.h" +#pragma once #include #include +#include "abstractsqlstorage.h" + class PostgreSqlStorage : public AbstractSqlStorage { Q_OBJECT public: - PostgreSqlStorage(QObject *parent = 0); - virtual ~PostgreSqlStorage(); + PostgreSqlStorage(QObject* parent = nullptr); - virtual AbstractSqlMigrationWriter *createMigrationWriter(); + std::unique_ptr createMigrationWriter() override; public slots: /* General */ - virtual bool isAvailable() const; - virtual QString displayName() const; - virtual QString description() const; - virtual QStringList setupKeys() const; - virtual QVariantMap setupDefaults() const; + 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 */ - virtual UserId addUser(const QString &user, const QString &password); - virtual bool 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 getUserId(const QString &username); - 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()); + 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 */ - virtual IdentityId createIdentity(UserId user, CoreIdentity &identity); - virtual bool updateIdentity(UserId user, const CoreIdentity &identity); - virtual void removeIdentity(UserId user, IdentityId identityId); - virtual QList identities(UserId user); + IdentityId createIdentity(UserId user, CoreIdentity& identity) override; + bool updateIdentity(UserId user, const CoreIdentity& identity) override; + void removeIdentity(UserId user, IdentityId identityId) override; + std::vector identities(UserId user) override; /* 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 networks(UserId user); - virtual QList connectedNetworks(UserId user); - virtual void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected); + 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 networks(UserId user) override; + std::vector connectedNetworks(UserId user) override; + void setNetworkConnected(UserId user, const NetworkId& networkId, bool isConnected) override; /* persistent channels */ - virtual QHash 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); + QHash 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 */ - 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); + 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 */ - 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 requestBuffers(UserId user); - virtual QList 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 bufferLastSeenMsgIds(UserId user); - virtual void setBufferMarkerLineMsg(UserId user, const BufferId &bufferId, const MsgId &msgId); - virtual QHash bufferMarkerLineMsgIds(UserId user); + 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 requestBuffers(UserId user) override; + std::vector 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 bufferLastMsgIds(UserId user) override; + void setBufferLastSeenMsg(UserId user, const BufferId& bufferId, const MsgId& msgId) override; + QHash bufferLastSeenMsgIds(UserId user) override; + void setBufferMarkerLineMsg(UserId user, const BufferId& bufferId, const MsgId& msgId) override; + QHash bufferMarkerLineMsgIds(UserId user) override; + void setBufferActivity(UserId id, BufferId bufferId, Message::Types type) override; + QHash bufferActivities(UserId id) override; + Message::Types bufferActivity(BufferId bufferId, MsgId lastSeenMsgId) override; + void setHighlightCount(UserId id, BufferId bufferId, int count) override; + QHash highlightCounts(UserId id) override; + int highlightCount(BufferId bufferId, MsgId lastSeenMsgId) override; + QHash bufferCiphers(UserId user, const NetworkId& networkId) override; + void setBufferCipher(UserId user, const NetworkId& networkId, const QString& bufferName, const QByteArray& cipher) override; /* Message handling */ - virtual bool logMessage(Message &msg); - virtual bool logMessages(MessageList &msgs); - virtual QList requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1); - virtual QList requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1); + bool logMessage(Message& msg) override; + bool logMessages(MessageList& msgs) override; + std::vector requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) override; + std::vector 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 requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) override; + std::vector 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 getAllAuthUserNames() override; protected: - virtual bool initDbSession(QSqlDatabase &db); - 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 beginTransaction(QSqlDatabase &db); - bool beginReadOnlyTransaction(QSqlDatabase &db); - - QSqlQuery executePreparedQuery(const QString &queryname, const QVariantList ¶ms, QSqlDatabase &db); - QSqlQuery executePreparedQuery(const QString &queryname, const QVariant ¶m, QSqlDatabase &db); - void deallocateQuery(const QString &queryname, 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); - QSqlQuery prepareAndExecuteQuery(const QString &queryname, const QString ¶mstring, QSqlDatabase &db); - inline QSqlQuery prepareAndExecuteQuery(const QString &queryname, QSqlDatabase &db) { return prepareAndExecuteQuery(queryname, QString(), db); } + 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; + int _port{-1}; QString _databaseName; QString _userName; QString _password; }; - // ======================================== // PostgreSqlMigration // ======================================== @@ -151,35 +195,37 @@ class PostgreSqlMigrationWriter : public PostgreSqlStorage, public AbstractSqlMi public: 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 { + struct Sequence + { QLatin1String table; QLatin1String field; - Sequence(const char *table, const char *field) : table(table), field(field) {} + Sequence(const char* table, const char* field) + : table(table) + , field(field) + {} }; QSet _validIdentities; }; - - -#endif