/***************************************************************************
- * Copyright (C) 2005-08 by the Quassel Project *
+ * Copyright (C) 2005-2016 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
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);
+ virtual ~SqliteStorage();
+
+ virtual std::unique_ptr<AbstractSqlMigrationReader> createMigrationReader();
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<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 getBufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "");
- virtual BufferInfo getBufferInfo(UserId user, const BufferId &bufferId);
- virtual QList<BufferInfo> requestBuffers(UserId user, QDateTime since = QDateTime());
- virtual bool removeBuffer(const UserId &user, const BufferId &bufferId);
- virtual BufferId renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName);
- virtual void setBufferLastSeen(UserId user, const BufferId &bufferId, const QDateTime &seenDate);
- virtual QHash<BufferId, QDateTime> bufferLastSeenDates(UserId user);
-
- /* Message handling */
-
- virtual MsgId logMessage(Message msg);
- virtual QList<Message> requestMsgs(BufferInfo buffer, int lastmsgs = -1, int offset = -1);
- virtual QList<Message> requestMsgs(BufferInfo buffer, QDateTime since, int offset = -1);
- virtual QList<Message> requestMsgRange(BufferInfo buffer, int first, int last);
+ /* General */
+
+ bool isAvailable() const;
+ QString backendId() const;
+ QString displayName() const;
+ virtual inline QVariantList setupData() const { return {}; }
+ 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, const QString &authenticator = "Database");
+ 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 QString getUserAuthenticator(const UserId userid);
+ 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);
+
+ /* 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<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);
+ virtual void setBufferMarkerLineMsg(UserId user, const BufferId &bufferId, const MsgId &msgId);
+ virtual QHash<BufferId, MsgId> bufferMarkerLineMsgIds(UserId user);
+ virtual void setBufferActivity(UserId id, const BufferId &bufferId, const Message::Types &type);
+ virtual QHash<BufferId, Message::Types> bufferActivities(UserId id) override;
+ virtual Message::Types bufferActivity(BufferId &bufferId, const MsgId &lastSeenMsgId);
+
+ /* Message handling */
+ virtual bool logMessage(Message &msg);
+ virtual bool logMessages(MessageList &msgs);
+ 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);
+
+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);
+
+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();
+
+ 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);
+
+ inline int stepSize() { return 50000; }
protected:
- inline virtual QString driverName() { return "QSQLITE"; }
- inline virtual QString databaseName() { return backlogFile(); }
- virtual int installedSchemaVersion();
+ virtual inline bool transaction() { return logDb().transaction(); }
+ virtual inline void rollback() { logDb().rollback(); }
+ virtual inline bool commit() { return logDb().commit(); }
- virtual bool init(const QVariantMap &settings = QVariantMap()); // only needed for migration
-
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);
+ void setMaxId(MigrationObject mo);
+ int _maxId;
};
+
+inline std::unique_ptr<AbstractSqlMigrationReader> SqliteStorage::createMigrationReader()
+{
+ return std::unique_ptr<AbstractSqlMigrationReader>{new SqliteMigrationReader()};
+}
+
+
#endif
projects / quassel.git / blobdiff