X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fsqlitestorage.h;h=618d5dd07c9bd7805b3877d1e8c1c65966d7ef1c;hp=aaf2d69abd456558340469a5dc1318c85268c3c6;hb=8961f348947fc55cc4bc769563684af3f2ea7ccc;hpb=6422c61b11d97f905b6a27f2d280e9ec0d8bb3e2 diff --git a/src/core/sqlitestorage.h b/src/core/sqlitestorage.h index aaf2d69a..618d5dd0 100644 --- a/src/core/sqlitestorage.h +++ b/src/core/sqlitestorage.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2018 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 * @@ -20,10 +20,13 @@ #pragma once -#include "abstractsqlstorage.h" +#include +#include #include +#include "abstractsqlstorage.h" + class QSqlQuery; class SqliteStorage : public AbstractSqlStorage @@ -31,98 +34,138 @@ class SqliteStorage : public AbstractSqlStorage Q_OBJECT public: - SqliteStorage(QObject *parent = 0); - ~SqliteStorage() override; + SqliteStorage(QObject* parent = nullptr); std::unique_ptr createMigrationReader() override; public slots: /* General */ - bool isAvailable() const override; + bool isAvailable() const override; QString backendId() const override; QString displayName() const override; - QVariantList setupData() const override { return {}; } + 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; + 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 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; + 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; + 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; + 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; + 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; + 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; + 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; + 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; + 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; + 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; + 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; - QString getAuthUserName(UserId user) override; protected: - void setConnectionProperties(const QVariantMap & /* properties */) override {} - QString driverName() override { return "QSQLITE"; } - QString databaseName() override { return backlogFile(); } + 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) override; + bool updateSchemaVersion(int newVersion, bool clearUpgradeStep) override; bool setupSchemaVersion(int version) override; - bool safeExec(QSqlQuery &query, int retryCount = 0); + + /** + * 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(); - void bindNetworkInfo(QSqlQuery &query, const NetworkInfo &info); - void bindServerInfo(QSqlQuery &query, const Network::Server &server); + 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(); } @@ -131,7 +174,6 @@ private: static int _maxRetryCount; }; - // ======================================== // SqliteMigration // ======================================== @@ -142,31 +184,31 @@ class SqliteMigrationReader : public SqliteStorage, public AbstractSqlMigrationR public: SqliteMigrationReader(); - 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(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; - int stepSize() { return 50000; } + qint64 stepSize() { return 50000; } protected: - bool transaction() override { return logDb().transaction(); } - void rollback() override { logDb().rollback(); } - bool commit() override { return logDb().commit(); } + bool transaction() override { return logDb().transaction(); } + void rollback() override { logDb().rollback(); } + bool commit() override { return logDb().commit(); } private: void setMaxId(MigrationObject mo); - int _maxId; + qint64 _maxId{0}; }; - inline std::unique_ptr SqliteStorage::createMigrationReader() { return std::unique_ptr{new SqliteMigrationReader()};