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 //! 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 void initDbSession(QSqlDatabase & /* db */) {}
86 void connectionDestroyed();
89 void addConnectionToPool();
94 static int _nextConnectionId;
95 QMutex _connectionPoolMutex;
96 // we let a Connection Object manage each actual db connection
97 // those objects reside in the thread the connection belongs to
98 // which allows us thread safe termination of a connection
100 QHash<QThread *, Connection *> _connectionPool;
103 // ========================================
104 // AbstractSqlStorage::Connection
105 // ========================================
106 class AbstractSqlStorage::Connection : public QObject {
110 Connection(const QString &name, QObject *parent = 0);
113 inline QLatin1String name() const { return QLatin1String(_name); }
120 // ========================================
121 // AbstractSqlMigrator
122 // ========================================
123 class AbstractSqlMigrator {
126 struct QuasselUserMO {
135 SenderMO() : senderId(0) {}
141 QString identityname;
144 bool awayNickEnabled;
146 bool awayReasonEnabled;
147 bool autoAwayEnabled;
149 QString autoAwayReason;
150 bool autoAwayReasonEnabled;
151 bool detachAwayEnabled;
152 QString detachAwayReason;
153 bool detchAwayReasonEnabled;
162 struct IdentityNickMO {
164 IdentityId identityId;
172 IdentityId identityid;
173 QString encodingcodec;
174 QString decodingcodec;
176 bool userandomserver;
178 bool useautoidentify;
179 QString autoidentifyservice;
180 QString autoidentifypassword;
181 bool useautoreconnect;
182 int autoreconnectinterval;
183 int autoreconnectretries;
184 bool unlimitedconnectretries;
189 QString attachperform;
190 QString detachperform;
193 QString saslpassword;
212 QDateTime time; // has to be in UTC!
237 struct UserSettingMO {
240 QByteArray settingvalue;
243 enum MigrationObject {
255 AbstractSqlMigrator();
256 virtual ~AbstractSqlMigrator() {}
258 static QString migrationObject(MigrationObject moType);
261 void newQuery(const QString &query, QSqlDatabase db);
262 virtual void resetQuery();
263 virtual bool prepareQuery(MigrationObject mo) = 0;
265 inline bool next() { return _query->next(); }
266 inline QVariant value(int index) { return _query->value(index); }
267 inline void bindValue(const QString &placeholder, const QVariant &val) { _query->bindValue(placeholder, val); }
268 inline void bindValue(int pos, const QVariant &val) { _query->bindValue(pos, val); }
270 inline QSqlError lastError() { return _query ? _query->lastError() : QSqlError(); }
272 inline QString executedQuery() { return _query ? _query->executedQuery() : QString(); }
273 inline QVariantList boundValues();
275 virtual bool transaction() = 0;
276 virtual void rollback() = 0;
277 virtual bool commit() = 0;
283 class AbstractSqlMigrationReader : public AbstractSqlMigrator {
285 AbstractSqlMigrationReader();
287 virtual bool readMo(QuasselUserMO &user) = 0;
288 virtual bool readMo(IdentityMO &identity) = 0;
289 virtual bool readMo(IdentityNickMO &identityNick) = 0;
290 virtual bool readMo(NetworkMO &network) = 0;
291 virtual bool readMo(BufferMO &buffer) = 0;
292 virtual bool readMo(SenderMO &sender) = 0;
293 virtual bool readMo(BacklogMO &backlog) = 0;
294 virtual bool readMo(IrcServerMO &ircserver) = 0;
295 virtual bool readMo(UserSettingMO &userSetting) = 0;
297 bool migrateTo(AbstractSqlMigrationWriter *writer);
300 void abortMigration(const QString &errorMsg = QString());
301 bool finalizeMigration();
303 template<typename T> bool transferMo(MigrationObject moType, T &mo);
305 AbstractSqlMigrationWriter *_writer;
308 class AbstractSqlMigrationWriter : public AbstractSqlMigrator {
310 virtual bool writeMo(const QuasselUserMO &user) = 0;
311 virtual bool writeMo(const IdentityMO &identity) = 0;
312 virtual bool writeMo(const IdentityNickMO &identityNick) = 0;
313 virtual bool writeMo(const NetworkMO &network) = 0;
314 virtual bool writeMo(const BufferMO &buffer) = 0;
315 virtual bool writeMo(const SenderMO &sender) = 0;
316 virtual bool writeMo(const BacklogMO &backlog) = 0;
317 virtual bool writeMo(const IrcServerMO &ircserver) = 0;
318 virtual bool writeMo(const UserSettingMO &userSetting) = 0;
320 inline bool migrateFrom(AbstractSqlMigrationReader *reader) { return reader->migrateTo(this); }
322 // called after migration process
323 virtual inline bool postProcess() { return true; }
324 friend class AbstractSqlMigrationReader;