1 /***************************************************************************
2 * Copyright (C) 2005-2016 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
21 #ifndef SQLITESTORAGE_H
22 #define SQLITESTORAGE_H
24 #include "abstractsqlstorage.h"
26 #include <QSqlDatabase>
30 class SqliteStorage : public AbstractSqlStorage
35 SqliteStorage(QObject *parent = 0);
36 virtual ~SqliteStorage();
38 virtual std::unique_ptr<AbstractSqlMigrationReader> createMigrationReader();
43 bool isAvailable() const;
44 QString backendId() const;
45 QString displayName() const;
46 virtual inline QVariantList setupData() const { return {}; }
47 QString description() const;
49 // TODO: Add functions for configuring the backlog handling, i.e. defining auto-cleanup settings etc
52 virtual UserId addUser(const QString &user, const QString &password, const QString &authenticator = "Database");
53 virtual bool updateUser(UserId user, const QString &password);
54 virtual void renameUser(UserId user, const QString &newName);
55 virtual UserId validateUser(const QString &user, const QString &password);
56 virtual UserId getUserId(const QString &username);
57 virtual QString getUserAuthenticator(const UserId userid);
58 virtual UserId internalUser();
59 virtual void delUser(UserId user);
60 virtual void setUserSetting(UserId userId, const QString &settingName, const QVariant &data);
61 virtual QVariant getUserSetting(UserId userId, const QString &settingName, const QVariant &defaultData = QVariant());
63 /* Identity handling */
64 virtual IdentityId createIdentity(UserId user, CoreIdentity &identity);
65 virtual bool updateIdentity(UserId user, const CoreIdentity &identity);
66 virtual void removeIdentity(UserId user, IdentityId identityId);
67 virtual QList<CoreIdentity> identities(UserId user);
69 /* Network handling */
70 virtual NetworkId createNetwork(UserId user, const NetworkInfo &info);
71 virtual bool updateNetwork(UserId user, const NetworkInfo &info);
72 virtual bool removeNetwork(UserId user, const NetworkId &networkId);
73 virtual QList<NetworkInfo> networks(UserId user);
74 virtual QList<NetworkId> connectedNetworks(UserId user);
75 virtual void setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected);
77 /* persistent channels */
78 virtual QHash<QString, QString> persistentChannels(UserId user, const NetworkId &networkId);
79 virtual void setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined);
80 virtual void setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key);
82 /* persistent user states */
83 virtual QString awayMessage(UserId user, NetworkId networkId);
84 virtual void setAwayMessage(UserId user, NetworkId networkId, const QString &awayMsg);
85 virtual QString userModes(UserId user, NetworkId networkId);
86 virtual void setUserModes(UserId user, NetworkId networkId, const QString &userModes);
89 virtual BufferInfo bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer = "", bool create = true);
90 virtual BufferInfo getBufferInfo(UserId user, const BufferId &bufferId);
91 virtual QList<BufferInfo> requestBuffers(UserId user);
92 virtual QList<BufferId> requestBufferIdsForNetwork(UserId user, NetworkId networkId);
93 virtual bool removeBuffer(const UserId &user, const BufferId &bufferId);
94 virtual bool renameBuffer(const UserId &user, const BufferId &bufferId, const QString &newName);
95 virtual bool mergeBuffersPermanently(const UserId &user, const BufferId &bufferId1, const BufferId &bufferId2);
96 virtual void setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId);
97 virtual QHash<BufferId, MsgId> bufferLastSeenMsgIds(UserId user);
98 virtual void setBufferMarkerLineMsg(UserId user, const BufferId &bufferId, const MsgId &msgId);
99 virtual QHash<BufferId, MsgId> bufferMarkerLineMsgIds(UserId user);
100 virtual void setBufferActivity(UserId id, BufferId bufferId, Message::Types type);
101 QHash<BufferId, Message::Types> bufferActivities(UserId id) override;
102 Message::Types bufferActivity(BufferId bufferId, MsgId lastSeenMsgId) override;
104 /* Message handling */
105 virtual bool logMessage(Message &msg);
106 virtual bool logMessages(MessageList &msgs);
107 virtual QList<Message> requestMsgs(UserId user, BufferId bufferId, MsgId first = -1, MsgId last = -1, int limit = -1);
108 virtual QList<Message> requestAllMsgs(UserId user, MsgId first = -1, MsgId last = -1, int limit = -1);
111 inline virtual void setConnectionProperties(const QVariantMap & /* properties */) {}
112 inline virtual QString driverName() { return "QSQLITE"; }
113 inline virtual QString databaseName() { return backlogFile(); }
114 virtual int installedSchemaVersion();
115 virtual bool updateSchemaVersion(int newVersion);
116 virtual bool setupSchemaVersion(int version);
117 bool safeExec(QSqlQuery &query, int retryCount = 0);
120 static QString backlogFile();
121 void bindNetworkInfo(QSqlQuery &query, const NetworkInfo &info);
122 void bindServerInfo(QSqlQuery &query, const Network::Server &server);
124 inline void lockForRead() { _dbLock.lockForRead(); }
125 inline void lockForWrite() { _dbLock.lockForWrite(); }
126 inline void unlock() { _dbLock.unlock(); }
127 QReadWriteLock _dbLock;
128 static int _maxRetryCount;
132 // ========================================
134 // ========================================
135 class SqliteMigrationReader : public SqliteStorage, public AbstractSqlMigrationReader
140 SqliteMigrationReader();
142 virtual bool readMo(QuasselUserMO &user);
143 virtual bool readMo(SenderMO &sender);
144 virtual bool readMo(IdentityMO &identity);
145 virtual bool readMo(IdentityNickMO &identityNick);
146 virtual bool readMo(NetworkMO &network);
147 virtual bool readMo(BufferMO &buffer);
148 virtual bool readMo(BacklogMO &backlog);
149 virtual bool readMo(IrcServerMO &ircserver);
150 virtual bool readMo(UserSettingMO &userSetting);
152 virtual bool prepareQuery(MigrationObject mo);
154 inline int stepSize() { return 50000; }
157 virtual inline bool transaction() { return logDb().transaction(); }
158 virtual inline void rollback() { logDb().rollback(); }
159 virtual inline bool commit() { return logDb().commit(); }
162 void setMaxId(MigrationObject mo);
167 inline std::unique_ptr<AbstractSqlMigrationReader> SqliteStorage::createMigrationReader()
169 return std::unique_ptr<AbstractSqlMigrationReader>{new SqliteMigrationReader()};