X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fsqlitestorage.h;h=367c644d4bf04a925659c08b5d6fc957e3497bb7;hp=253d3eab7e32798dc9dd8db428d1223f1a58246c;hb=092e6b212637ffbf68800584b7c1f32d1931b602;hpb=5b560ec1a01349562ac58051ca7e7fa899d4b994 diff --git a/src/core/sqlitestorage.h b/src/core/sqlitestorage.h index 253d3eab..367c644d 100644 --- a/src/core/sqlitestorage.h +++ b/src/core/sqlitestorage.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-08 by the Quassel Project * + * Copyright (C) 2005-2018 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -15,11 +15,10 @@ * 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" @@ -27,57 +26,153 @@ class QSqlQuery; -class SqliteStorage : public AbstractSqlStorage { - Q_OBJECT +class SqliteStorage : public AbstractSqlStorage +{ + Q_OBJECT public: - SqliteStorage(QObject *parent = 0); - virtual ~SqliteStorage(); + SqliteStorage(QObject *parent = 0); + ~SqliteStorage() override; + + std::unique_ptr createMigrationReader() override; public slots: - /* General */ - - bool isAvailable() const; - QString displayName() const; - 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 void delUser(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); - - /* Buffer handling */ - virtual BufferInfo getBufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = ""); - virtual QList requestBuffers(UserId user, QDateTime since = QDateTime()); - - /* Message handling */ - - virtual MsgId logMessage(Message msg); - virtual QList requestMsgs(BufferInfo buffer, int lastmsgs = -1, int offset = -1); - virtual QList requestMsgs(BufferInfo buffer, QDateTime since, int offset = -1); - virtual QList requestMsgRange(BufferInfo buffer, int first, int last); + /* 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; + + /* 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 requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -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(); } + int installedSchemaVersion() override; + bool updateSchemaVersion(int newVersion) override; + bool setupSchemaVersion(int version) 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); + + 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 + +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 prepareQuery(MigrationObject mo) override; + + int stepSize() { return 50000; } protected: - inline virtual QString driverName() { return "QSQLITE"; } - inline virtual QString databaseName() { return backlogFile(); } - virtual int installedSchemaVersion(); - + bool transaction() override { return logDb().transaction(); } + void rollback() override { logDb().rollback(); } + bool commit() override { return logDb().commit(); } + private: - static QString backlogFile(); - bool isValidNetwork(UserId user, const NetworkId &networkId); - NetworkId getNetworkId(UserId user, const QString &network); - void createBuffer(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer); + void setMaxId(MigrationObject mo); + int _maxId; }; -#endif + +inline std::unique_ptr SqliteStorage::createMigrationReader() +{ + return std::unique_ptr{new SqliteMigrationReader()}; +}