X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fsqlitestorage.h;h=618d5dd07c9bd7805b3877d1e8c1c65966d7ef1c;hp=3f213067a1b860e36e8b69a9dedc5f39c7093778;hb=8961f348947fc55cc4bc769563684af3f2ea7ccc;hpb=698bd631332040f9a988ae8f31a80688893ca6f3 diff --git a/src/core/sqlitestorage.h b/src/core/sqlitestorage.h index 3f213067..618d5dd0 100644 --- a/src/core/sqlitestorage.h +++ b/src/core/sqlitestorage.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-09 by the Quassel Project * + * Copyright (C) 2005-2019 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -15,144 +15,201 @@ * 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 SQLITESTORAGE_H -#define SQLITESTORAGE_H +#pragma once -#include "abstractsqlstorage.h" +#include +#include #include +#include "abstractsqlstorage.h" + class QSqlQuery; -class SqliteStorage : public AbstractSqlStorage { - Q_OBJECT +class SqliteStorage : public AbstractSqlStorage +{ + Q_OBJECT public: - SqliteStorage(QObject *parent = 0); - virtual ~SqliteStorage(); + SqliteStorage(QObject* parent = nullptr); + + std::unique_ptr createMigrationReader() override; public slots: - /* General */ - - bool isAvailable() const; - QString displayName() const; - inline QVariantMap setupKeys() const { return QVariantMap(); } - QString description() const; - - // 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 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 networks(UserId user); - virtual QList connectedNetworks(UserId user); - virtual void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected); - - /* 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); - - /* 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 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); - - /* 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); + /* General */ + + bool isAvailable() const override; + QString backendId() const override; + QString displayName() const override; + QVariantList setupData() const override { return {}; } + QString description() 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; + QList 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; + QList networks(UserId user) override; + QList connectedNetworks(UserId user) override; + void setNetworkConnected(UserId user, const NetworkId& networkId, bool isConnected) override; + + /* persistent channels */ + 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 */ + 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; + QList requestBuffers(UserId user) override; + QList 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; + 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 */ + bool logMessage(Message& msg) override; + bool logMessages(MessageList& msgs) override; + QList requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1) override; + QList 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; + QList requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1) override; + QList 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: - inline virtual void setConnectionProperties(const QVariantMap & /* properties */) {} - inline virtual QString driverName() { return "QSQLITE"; } - inline virtual QString databaseName() { return backlogFile(); } - virtual int installedSchemaVersion(); - virtual bool updateSchemaVersion(int newVersion); - virtual bool setupSchemaVersion(int version); - bool safeExec(QSqlQuery &query, int retryCount = 0); + void setConnectionProperties(const QVariantMap& properties, const QProcessEnvironment& environment, bool loadFromEnvironment) override + { + Q_UNUSED(properties); + Q_UNUSED(environment); + Q_UNUSED(loadFromEnvironment); + } + // SQLite does not have any connection properties to set + QString driverName() override { return "QSQLITE"; } + QString databaseName() override { return backlogFile(); } + 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; + + bool safeExec(QSqlQuery& query, int retryCount = 0); private: - static QString backlogFile(); - bool isValidNetwork(UserId user, const NetworkId &networkId); - bool isValidBuffer(const UserId &user, const BufferId &bufferId); - NetworkId getNetworkId(UserId user, const QString &network); - void createBuffer(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer); - - static int _maxRetryCount; + static QString backlogFile(); + void bindNetworkInfo(QSqlQuery& query, const NetworkInfo& info); + void bindServerInfo(QSqlQuery& query, const Network::Server& server); + + inline void lockForRead() { _dbLock.lockForRead(); } + inline void lockForWrite() { _dbLock.lockForWrite(); } + inline void unlock() { _dbLock.unlock(); } + QReadWriteLock _dbLock; + static int _maxRetryCount; }; // ======================================== // SqliteMigration // ======================================== -class SqliteMigrationReader : public SqliteStorage, public AbstractSqlMigrationReader { - Q_OBJECT +class SqliteMigrationReader : public SqliteStorage, public AbstractSqlMigrationReader +{ + Q_OBJECT public: - SqliteMigrationReader(); - -// virtual bool readUser(QuasselUserMO &user); -// virtual bool readSender(SenderMO &sender); -// virtual bool readIdentity(IdentityMO &identity); -// virtual bool readIdentityNick(IdentityNickMO &identityNick); -// virtual bool readNetwork(NetworkMO &network); -// virtual bool readBuffer(BufferMO &buffer); -// virtual bool readBacklog(BacklogMO &backlog); -// virtual bool readIrcServer(IrcServerMO &ircserver); -// virtual bool readUserSetting(UserSettingMO &userSetting); - - virtual bool readMo(QuasselUserMO &user); - virtual bool readMo(SenderMO &sender); - virtual bool readMo(IdentityMO &identity); - virtual bool readMo(IdentityNickMO &identityNick); - virtual bool readMo(NetworkMO &network); - virtual bool readMo(BufferMO &buffer); - virtual bool readMo(BacklogMO &backlog); - virtual bool readMo(IrcServerMO &ircserver); - virtual bool readMo(UserSettingMO &userSetting); - - virtual bool prepareQuery(MigrationObject mo); + SqliteMigrationReader(); -protected: - virtual inline bool transaction() { return logDb().transaction(); } - virtual inline void rollback() { logDb().rollback(); } - virtual inline bool commit() { return logDb().commit(); } -}; + bool readMo(QuasselUserMO& user) override; + bool readMo(SenderMO& sender) override; + bool readMo(IdentityMO& identity) override; + bool readMo(IdentityNickMO& identityNick) override; + bool readMo(NetworkMO& network) override; + bool readMo(BufferMO& buffer) override; + bool readMo(BacklogMO& backlog) override; + bool readMo(IrcServerMO& ircserver) override; + bool readMo(UserSettingMO& userSetting) override; + bool readMo(CoreStateMO& coreState) override; + + bool prepareQuery(MigrationObject mo) override; + + qint64 stepSize() { return 50000; } +protected: + bool transaction() override { return logDb().transaction(); } + void rollback() override { logDb().rollback(); } + bool commit() override { return logDb().commit(); } +private: + void setMaxId(MigrationObject mo); + qint64 _maxId{0}; +}; -#endif +inline std::unique_ptr SqliteStorage::createMigrationReader() +{ + return std::unique_ptr{new SqliteMigrationReader()}; +}