1 /***************************************************************************
2 * Copyright (C) 2005-07 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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
21 #ifndef ABSTRACTSQLSTORAGE_H
22 #define ABSTRACTSQLSTORAGE_H
26 #include <QSqlDatabase>
30 class AbstractSqlMigrationReader;
31 class AbstractSqlMigrationWriter;
33 class AbstractSqlStorage : public Storage {
37 AbstractSqlStorage(QObject *parent = 0);
38 virtual ~AbstractSqlStorage();
40 virtual inline AbstractSqlMigrationReader *createMigrationReader() { return 0; }
41 virtual inline AbstractSqlMigrationWriter *createMigrationWriter() { return 0; }
44 virtual State init(const QVariantMap &settings = QVariantMap());
45 virtual bool setup(const QVariantMap &settings = QVariantMap());
48 inline virtual void sync() {};
52 QString queryString(const QString &queryName, int version);
53 inline QString queryString(const QString &queryName) { return queryString(queryName, 0); }
55 QStringList setupQueries();
57 QStringList upgradeQueries(int ver);
60 bool watchQuery(QSqlQuery &query);
63 virtual int installedSchemaVersion() { return -1; };
64 virtual bool updateSchemaVersion(int newVersion) = 0;
65 virtual bool setupSchemaVersion(int version) = 0;
67 virtual void setConnectionProperties(const QVariantMap &properties) = 0;
68 virtual QString driverName() = 0;
69 inline virtual QString hostName() { return QString(); }
70 inline virtual int port() { return -1; }
71 virtual QString databaseName() = 0;
72 inline virtual QString userName() { return QString(); }
73 inline virtual QString password() { return QString(); }
76 void connectionDestroyed();
79 void addConnectionToPool();
83 static int _nextConnectionId;
84 QMutex _connectionPoolMutex;
85 // we let a Connection Object manage each actual db connection
86 // those objects reside in the thread the connection belongs to
87 // which allows us thread safe termination of a connection
89 QHash<QThread *, Connection *> _connectionPool;
92 // ========================================
93 // AbstractSqlStorage::Connection
94 // ========================================
95 class AbstractSqlStorage::Connection : public QObject {
99 Connection(const QString &name, QObject *parent = 0);
102 inline QLatin1String name() const { return QLatin1String(_name); }
109 // ========================================
110 // AbstractSqlMigrator
111 // ========================================
112 class AbstractSqlMigrator {
115 struct QuasselUserMO {
124 SenderMO() : senderId(0) {}
130 QString identityname;
133 bool awayNickEnabled;
135 bool awayReasonEnabled;
136 bool autoAwayEnabled;
138 QString autoAwayReason;
139 bool autoAwayReasonEnabled;
140 bool detachAwayEnabled;
141 QString detachAwayReason;
142 bool detchAwayReasonEnabled;
151 struct IdentityNickMO {
153 IdentityId identityId;
161 IdentityId identityid;
162 QString encodingcodec;
163 QString decodingcodec;
165 bool userandomserver;
167 bool useautoidentify;
168 QString autoidentifyservice;
169 QString autoidentifypassword;
170 bool useautoreconnect;
171 int autoreconnectinterval;
172 int autoreconnectretries;
173 bool unlimitedconnectretries;
178 QString attachperform;
179 QString detachperform;
197 QDateTime time; // has to be in UTC!
222 struct UserSettingMO {
225 QByteArray settingvalue;
228 enum MigrationObject {
240 AbstractSqlMigrator();
241 virtual ~AbstractSqlMigrator() {}
243 static QString migrationObject(MigrationObject moType);
246 void newQuery(const QString &query, QSqlDatabase db);
247 virtual void resetQuery();
248 virtual bool prepareQuery(MigrationObject mo) = 0;
250 inline bool next() { return _query->next(); }
251 inline QVariant value(int index) { return _query->value(index); }
252 inline void bindValue(const QString &placeholder, const QVariant &val) { _query->bindValue(placeholder, val); }
253 inline void bindValue(int pos, const QVariant &val) { _query->bindValue(pos, val); }
255 inline QSqlError lastError() { return _query ? _query->lastError() : QSqlError(); }
257 inline QString executedQuery() { return _query ? _query->executedQuery() : QString(); }
258 inline QVariantList boundValues();
260 virtual bool transaction() = 0;
261 virtual void rollback() = 0;
262 virtual bool commit() = 0;
268 class AbstractSqlMigrationReader : public AbstractSqlMigrator {
270 AbstractSqlMigrationReader();
272 virtual bool readMo(QuasselUserMO &user) = 0;
273 virtual bool readMo(IdentityMO &identity) = 0;
274 virtual bool readMo(IdentityNickMO &identityNick) = 0;
275 virtual bool readMo(NetworkMO &network) = 0;
276 virtual bool readMo(BufferMO &buffer) = 0;
277 virtual bool readMo(SenderMO &sender) = 0;
278 virtual bool readMo(BacklogMO &backlog) = 0;
279 virtual bool readMo(IrcServerMO &ircserver) = 0;
280 virtual bool readMo(UserSettingMO &userSetting) = 0;
282 bool migrateTo(AbstractSqlMigrationWriter *writer);
285 void abortMigration(const QString &errorMsg = QString());
286 bool finalizeMigration();
288 template<typename T> bool transferMo(MigrationObject moType, T &mo);
290 AbstractSqlMigrationWriter *_writer;
293 class AbstractSqlMigrationWriter : public AbstractSqlMigrator {
295 virtual bool writeMo(const QuasselUserMO &user) = 0;
296 virtual bool writeMo(const IdentityMO &identity) = 0;
297 virtual bool writeMo(const IdentityNickMO &identityNick) = 0;
298 virtual bool writeMo(const NetworkMO &network) = 0;
299 virtual bool writeMo(const BufferMO &buffer) = 0;
300 virtual bool writeMo(const SenderMO &sender) = 0;
301 virtual bool writeMo(const BacklogMO &backlog) = 0;
302 virtual bool writeMo(const IrcServerMO &ircserver) = 0;
303 virtual bool writeMo(const UserSettingMO &userSetting) = 0;
305 inline bool migrateFrom(AbstractSqlMigrationReader *reader) { return reader->migrateTo(this); }
307 // called after migration process
308 virtual inline bool postProcess() { return true; }
309 friend class AbstractSqlMigrationReader;