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 ***************************************************************************/
27 #include <QSqlDatabase>
31 class AbstractSqlMigrationReader;
32 class AbstractSqlMigrationWriter;
34 class AbstractSqlStorage : public Storage
39 AbstractSqlStorage(QObject *parent = 0);
40 virtual ~AbstractSqlStorage();
42 virtual std::unique_ptr<AbstractSqlMigrationReader> createMigrationReader() { return {}; }
43 virtual std::unique_ptr<AbstractSqlMigrationWriter> createMigrationWriter() { return {}; }
46 virtual State init(const QVariantMap &settings = QVariantMap());
47 virtual bool setup(const QVariantMap &settings = QVariantMap());
50 inline virtual void sync() {};
55 * Fetch an SQL query string by name and optional schema version
57 * Loads the named SQL query from the built-in SQL resource collection, returning it as a
58 * string. If a version is specified, it'll be loaded from the schema version-specific folder
61 * @see schemaVersion()
63 * @param[in] queryName File name of the SQL query, minus the .sql extension
66 * SQL schema version; if 0, fetches from current version, otherwise loads from the specified
67 * schema version instead of the current schema files.
69 * @return String with the requested SQL query, ready for parameter substitution
71 QString queryString(const QString &queryName, int version = 0);
73 QStringList setupQueries();
75 QStringList upgradeQueries(int ver);
78 bool watchQuery(QSqlQuery &query);
81 virtual int installedSchemaVersion() { return -1; };
82 virtual bool updateSchemaVersion(int newVersion) = 0;
83 virtual bool setupSchemaVersion(int version) = 0;
85 virtual void setConnectionProperties(const QVariantMap &properties) = 0;
86 virtual QString driverName() = 0;
87 inline virtual QString hostName() { return QString(); }
88 inline virtual int port() { return -1; }
89 virtual QString databaseName() = 0;
90 inline virtual QString userName() { return QString(); }
91 inline virtual QString password() { return QString(); }
93 //! Initialize db specific features on connect
94 /** This is called every time a connection to a specific SQL backend is established
95 * the default implementation does nothing.
97 * When reimplementing this method, don't use logDB() inside this function as
98 * this would cause as we're just about to initialize that DB connection.
100 inline virtual bool initDbSession(QSqlDatabase & /* db */) { return true; }
103 void connectionDestroyed();
106 void addConnectionToPool();
107 void dbConnect(QSqlDatabase &db);
112 static int _nextConnectionId;
113 QMutex _connectionPoolMutex;
114 // we let a Connection Object manage each actual db connection
115 // those objects reside in the thread the connection belongs to
116 // which allows us thread safe termination of a connection
118 QHash<QThread *, Connection *> _connectionPool;
122 // ========================================
123 // AbstractSqlStorage::Connection
124 // ========================================
125 class AbstractSqlStorage::Connection : public QObject
130 Connection(const QString &name, QObject *parent = 0);
133 inline QLatin1String name() const { return QLatin1String(_name); }
140 // ========================================
141 // AbstractSqlMigrator
142 // ========================================
143 class AbstractSqlMigrator
147 struct QuasselUserMO {
152 QString authenticator;
158 SenderMO() : senderId(0) {}
164 QString identityname;
167 bool awayNickEnabled;
169 bool awayReasonEnabled;
170 bool autoAwayEnabled;
172 QString autoAwayReason;
173 bool autoAwayReasonEnabled;
174 bool detachAwayEnabled;
175 QString detachAwayReason;
176 bool detchAwayReasonEnabled;
185 struct IdentityNickMO {
187 IdentityId identityId;
195 IdentityId identityid;
196 QString encodingcodec;
197 QString decodingcodec;
199 bool userandomserver;
201 bool useautoidentify;
202 QString autoidentifyservice;
203 QString autoidentifypassword;
204 bool useautoreconnect;
205 int autoreconnectinterval;
206 int autoreconnectretries;
207 bool unlimitedconnectretries;
209 // Custom rate limiting
210 bool usecustommessagerate;
211 int messagerateburstsize;
212 int messageratedelay;
213 bool unlimitedmessagerate;
218 QString attachperform;
219 QString detachperform;
222 QString saslpassword;
242 QDateTime time; // has to be in UTC!
258 bool sslverify; /// If true, validate SSL certificates
268 struct UserSettingMO {
271 QByteArray settingvalue;
274 enum MigrationObject {
286 AbstractSqlMigrator();
287 virtual ~AbstractSqlMigrator() {}
289 static QString migrationObject(MigrationObject moType);
292 void newQuery(const QString &query, QSqlDatabase db);
293 virtual void resetQuery();
294 virtual bool prepareQuery(MigrationObject mo) = 0;
296 inline bool next() { return _query->next(); }
297 inline QVariant value(int index) { return _query->value(index); }
298 inline void bindValue(const QString &placeholder, const QVariant &val) { _query->bindValue(placeholder, val); }
299 inline void bindValue(int pos, const QVariant &val) { _query->bindValue(pos, val); }
301 inline QSqlError lastError() { return _query ? _query->lastError() : QSqlError(); }
303 inline QString executedQuery() { return _query ? _query->executedQuery() : QString(); }
304 inline QVariantList boundValues();
306 virtual bool transaction() = 0;
307 virtual void rollback() = 0;
308 virtual bool commit() = 0;
315 class AbstractSqlMigrationReader : public AbstractSqlMigrator
318 AbstractSqlMigrationReader();
320 virtual bool readMo(QuasselUserMO &user) = 0;
321 virtual bool readMo(IdentityMO &identity) = 0;
322 virtual bool readMo(IdentityNickMO &identityNick) = 0;
323 virtual bool readMo(NetworkMO &network) = 0;
324 virtual bool readMo(BufferMO &buffer) = 0;
325 virtual bool readMo(SenderMO &sender) = 0;
326 virtual bool readMo(BacklogMO &backlog) = 0;
327 virtual bool readMo(IrcServerMO &ircserver) = 0;
328 virtual bool readMo(UserSettingMO &userSetting) = 0;
330 bool migrateTo(AbstractSqlMigrationWriter *writer);
333 void abortMigration(const QString &errorMsg = QString());
334 bool finalizeMigration();
336 template<typename T> bool transferMo(MigrationObject moType, T &mo);
338 AbstractSqlMigrationWriter *_writer;
342 class AbstractSqlMigrationWriter : public AbstractSqlMigrator
345 virtual bool writeMo(const QuasselUserMO &user) = 0;
346 virtual bool writeMo(const IdentityMO &identity) = 0;
347 virtual bool writeMo(const IdentityNickMO &identityNick) = 0;
348 virtual bool writeMo(const NetworkMO &network) = 0;
349 virtual bool writeMo(const BufferMO &buffer) = 0;
350 virtual bool writeMo(const SenderMO &sender) = 0;
351 virtual bool writeMo(const BacklogMO &backlog) = 0;
352 virtual bool writeMo(const IrcServerMO &ircserver) = 0;
353 virtual bool writeMo(const UserSettingMO &userSetting) = 0;
355 inline bool migrateFrom(AbstractSqlMigrationReader *reader) { return reader->migrateTo(this); }
357 // called after migration process
358 virtual inline bool postProcess() { return true; }
359 friend class AbstractSqlMigrationReader;