/***************************************************************************
- * 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 SQLITESTORAGE_H
-#define SQLITESTORAGE_H
+#pragma once
-#include "abstractsqlstorage.h"
+#include <memory>
+#include <QReadWriteLock>
#include <QSqlDatabase>
+#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<AbstractSqlMigrationReader> 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 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);
-
- /* 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 MsgId logMessage(Message msg);
- 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);
+ /* 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;
+ 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:
- 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 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 readMo(CoreStateMO& coreState) override;
+
+ bool prepareQuery(MigrationObject mo) override;
+
+ qint64 stepSize() { return 50000; }
- static int _maxRetryCount;
+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<AbstractSqlMigrationReader> SqliteStorage::createMigrationReader()
+{
+ return std::unique_ptr<AbstractSqlMigrationReader>{new SqliteMigrationReader()};
+}
projects / quassel.git / blobdiff