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 ABSTRACTSQLSTORAGE_H
22 #define ABSTRACTSQLSTORAGE_H
26 #include <QSqlDatabase>
30 class AbstractSqlMigrationReader;
31 class AbstractSqlMigrationWriter;
33 class AbstractSqlStorage : public Storage
38 AbstractSqlStorage(QObject *parent = 0);
39 virtual ~AbstractSqlStorage();
41 virtual inline AbstractSqlMigrationReader *createMigrationReader() { return 0; }
42 virtual inline AbstractSqlMigrationWriter *createMigrationWriter() { return 0; }
45 virtual State init(const QVariantMap &settings = QVariantMap());
46 virtual bool setup(const QVariantMap &settings = QVariantMap());
49 inline virtual void sync() {};
53 QString queryString(const QString &queryName, int version);
54 inline QString queryString(const QString &queryName) { return queryString(queryName, 0); }
56 QStringList setupQueries();
58 QStringList upgradeQueries(int ver);
61 bool watchQuery(QSqlQuery &query);
64 virtual int installedSchemaVersion() { return -1; };
65 virtual bool updateSchemaVersion(int newVersion) = 0;
66 virtual bool setupSchemaVersion(int version) = 0;
68 virtual void setConnectionProperties(const QVariantMap &properties) = 0;
69 virtual QString driverName() = 0;
70 inline virtual QString hostName() { return QString(); }
71 inline virtual int port() { return -1; }
72 virtual QString databaseName() = 0;
73 inline virtual QString userName() { return QString(); }
74 inline virtual QString password() { return QString(); }
76 //! Initialize db specific features on connect
77 /** This is called every time a connection to a specific SQL backend is established
78 * the default implementation does nothing.
80 * When reimplementing this method, don't use logDB() inside this function as
81 * this would cause as we're just about to initialize that DB connection.
83 inline virtual bool initDbSession(QSqlDatabase & /* db */) { return true; }
86 void connectionDestroyed();
89 void addConnectionToPool();
90 void dbConnect(QSqlDatabase &db);
95 static int _nextConnectionId;
96 QMutex _connectionPoolMutex;
97 // we let a Connection Object manage each actual db connection
98 // those objects reside in the thread the connection belongs to
99 // which allows us thread safe termination of a connection
101 QHash<QThread *, Connection *> _connectionPool;
105 // ========================================
106 // AbstractSqlStorage::Connection
107 // ========================================
108 class AbstractSqlStorage::Connection : public QObject
113 Connection(const QString &name, QObject *parent = 0);
116 inline QLatin1String name() const { return QLatin1String(_name); }
123 // ========================================
124 // AbstractSqlMigrator
125 // ========================================
126 class AbstractSqlMigrator
130 struct QuasselUserMO {
140 SenderMO() : senderId(0) {}
146 QString identityname;
149 bool awayNickEnabled;
151 bool awayReasonEnabled;
152 bool autoAwayEnabled;
154 QString autoAwayReason;
155 bool autoAwayReasonEnabled;
156 bool detachAwayEnabled;
157 QString detachAwayReason;
158 bool detchAwayReasonEnabled;
167 struct IdentityNickMO {
169 IdentityId identityId;
177 IdentityId identityid;
178 QString encodingcodec;
179 QString decodingcodec;
181 bool userandomserver;
183 bool useautoidentify;
184 QString autoidentifyservice;
185 QString autoidentifypassword;
186 bool useautoreconnect;
187 int autoreconnectinterval;
188 int autoreconnectretries;
189 bool unlimitedconnectretries;
191 // Custom rate limiting
192 bool usecustommessagerate;
193 int messagerateburstsize;
194 int messageratedelay;
195 bool unlimitedmessagerate;
200 QString attachperform;
201 QString detachperform;
204 QString saslpassword;
223 QDateTime time; // has to be in UTC!
239 bool sslverify; /// If true, validate SSL certificates
249 struct UserSettingMO {
252 QByteArray settingvalue;
255 enum MigrationObject {
267 AbstractSqlMigrator();
268 virtual ~AbstractSqlMigrator() {}
270 static QString migrationObject(MigrationObject moType);
273 void newQuery(const QString &query, QSqlDatabase db);
274 virtual void resetQuery();
275 virtual bool prepareQuery(MigrationObject mo) = 0;
277 inline bool next() { return _query->next(); }
278 inline QVariant value(int index) { return _query->value(index); }
279 inline void bindValue(const QString &placeholder, const QVariant &val) { _query->bindValue(placeholder, val); }
280 inline void bindValue(int pos, const QVariant &val) { _query->bindValue(pos, val); }
282 inline QSqlError lastError() { return _query ? _query->lastError() : QSqlError(); }
284 inline QString executedQuery() { return _query ? _query->executedQuery() : QString(); }
285 inline QVariantList boundValues();
287 virtual bool transaction() = 0;
288 virtual void rollback() = 0;
289 virtual bool commit() = 0;
296 class AbstractSqlMigrationReader : public AbstractSqlMigrator
299 AbstractSqlMigrationReader();
301 virtual bool readMo(QuasselUserMO &user) = 0;
302 virtual bool readMo(IdentityMO &identity) = 0;
303 virtual bool readMo(IdentityNickMO &identityNick) = 0;
304 virtual bool readMo(NetworkMO &network) = 0;
305 virtual bool readMo(BufferMO &buffer) = 0;
306 virtual bool readMo(SenderMO &sender) = 0;
307 virtual bool readMo(BacklogMO &backlog) = 0;
308 virtual bool readMo(IrcServerMO &ircserver) = 0;
309 virtual bool readMo(UserSettingMO &userSetting) = 0;
311 bool migrateTo(AbstractSqlMigrationWriter *writer);
314 void abortMigration(const QString &errorMsg = QString());
315 bool finalizeMigration();
317 template<typename T> bool transferMo(MigrationObject moType, T &mo);
319 AbstractSqlMigrationWriter *_writer;
323 class AbstractSqlMigrationWriter : public AbstractSqlMigrator
326 virtual bool writeMo(const QuasselUserMO &user) = 0;
327 virtual bool writeMo(const IdentityMO &identity) = 0;
328 virtual bool writeMo(const IdentityNickMO &identityNick) = 0;
329 virtual bool writeMo(const NetworkMO &network) = 0;
330 virtual bool writeMo(const BufferMO &buffer) = 0;
331 virtual bool writeMo(const SenderMO &sender) = 0;
332 virtual bool writeMo(const BacklogMO &backlog) = 0;
333 virtual bool writeMo(const IrcServerMO &ircserver) = 0;
334 virtual bool writeMo(const UserSettingMO &userSetting) = 0;
336 inline bool migrateFrom(AbstractSqlMigrationReader *reader) { return reader->migrateTo(this); }
338 // called after migration process
339 virtual inline bool postProcess() { return true; }
340 friend class AbstractSqlMigrationReader;