1 /***************************************************************************
2 * Copyright (C) 2005-07 by the Quassel IRC Team *
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 #include "abstractsqlstorage.h"
25 #include <QMutexLocker>
29 AbstractSqlStorage::AbstractSqlStorage(QObject *parent)
36 AbstractSqlStorage::~AbstractSqlStorage() {
37 // disconnect the connections, so their deletion is no longer interessting for us
38 QHash<QThread *, Connection *>::iterator conIter;
39 for(conIter = _connectionPool.begin(); conIter != _connectionPool.end(); conIter++) {
40 disconnect(conIter.value(), 0, this, 0);
44 QSqlDatabase AbstractSqlStorage::logDb() {
45 if(!_connectionPool.contains(QThread::currentThread()))
46 addConnectionToPool();
48 qDebug() << "using logDb" << _connectionPool[QThread::currentThread()]->name() << QThread::currentThread();
49 return QSqlDatabase::database(_connectionPool[QThread::currentThread()]->name());
52 void AbstractSqlStorage::addConnectionToPool() {
53 QMutexLocker locker(&_connectionPoolMutex);
54 // we have to recheck if the connection pool already contains a connection for
55 // this thread. Since now (after the lock) we can only tell for sure
56 if(_connectionPool.contains(QThread::currentThread()))
59 QThread *currentThread = QThread::currentThread();
61 int connectionId = _nextConnectionId++;
63 Connection *connection = new Connection(QLatin1String(QString("quassel_connection_%1").arg(connectionId).toLatin1()), this);
64 qDebug() << "new connection" << connection->name() << currentThread << QLatin1String(QString("quassel_connection_%1").arg(connectionId).toLatin1());
65 connection->moveToThread(currentThread);
66 connect(this, SIGNAL(syncCachedQueries()), connection, SLOT(syncCachedQueries()));
67 connect(this, SIGNAL(destroyed()), connection, SLOT(deleteLater()));
68 connect(currentThread, SIGNAL(destroyed()), connection, SLOT(deleteLater()));
69 connect(connection, SIGNAL(destroyed()), this, SLOT(connectionDestroyed()));
70 _connectionPool[currentThread] = connection;
72 QSqlDatabase db = QSqlDatabase::addDatabase(driverName(), connection->name());
73 db.setDatabaseName(databaseName());
75 if(!hostName().isEmpty())
76 db.setHostName(hostName());
78 if(!userName().isEmpty()) {
79 db.setUserName(userName());
80 db.setPassword(password());
84 qWarning() << "Unable to open database" << displayName() << "for thread" << QThread::currentThread();
85 qWarning() << "-" << db.lastError().text();
89 bool AbstractSqlStorage::init(const QVariantMap &settings) {
91 QSqlDatabase db = logDb();
92 if(!db.isValid() || !db.isOpen())
95 if(installedSchemaVersion() == -1) {
96 qCritical() << "Storage Schema is missing!";
100 if(installedSchemaVersion() > schemaVersion()) {
101 qCritical() << "Installed Schema is newer then any known Version.";
105 if(installedSchemaVersion() < schemaVersion()) {
106 qWarning() << "Installed Schema is not up to date. Upgrading...";
111 quInfo() << "Storage Backend is ready. Quassel Schema Version:" << installedSchemaVersion();
115 void AbstractSqlStorage::sync() {
116 emit syncCachedQueries();
119 QString AbstractSqlStorage::queryString(const QString &queryName, int version) {
121 version = schemaVersion();
123 QFileInfo queryInfo(QString(":/SQL/%1/%2/%3.sql").arg(displayName()).arg(version).arg(queryName));
124 if(!queryInfo.exists() || !queryInfo.isFile() || !queryInfo.isReadable()) {
125 qCritical() << "Unable to read SQL-Query" << queryName << "for engine" << displayName();
129 QFile queryFile(queryInfo.filePath());
130 if(!queryFile.open(QIODevice::ReadOnly | QIODevice::Text))
132 QString query = QTextStream(&queryFile).readAll();
135 return query.trimmed();
138 QSqlQuery &AbstractSqlStorage::cachedQuery(const QString &queryName, int version) {
139 Q_ASSERT(_connectionPool.contains(QThread::currentThread()));
140 qDebug() << "cached query" << queryName << "using" << _connectionPool[QThread::currentThread()]->name() << QThread::currentThread();
141 return _connectionPool[QThread::currentThread()]->cachedQuery(queryName, version);
144 QStringList AbstractSqlStorage::setupQueries() {
146 QDir dir = QDir(QString(":/SQL/%1/%2/").arg(displayName()).arg(schemaVersion()));
147 foreach(QFileInfo fileInfo, dir.entryInfoList(QStringList() << "setup*", QDir::NoFilter, QDir::Name)) {
148 queries << queryString(fileInfo.baseName());
153 bool AbstractSqlStorage::setup(const QVariantMap &settings) {
155 QSqlDatabase db = logDb();
157 qCritical() << "Unable to setup Logging Backend!";
161 foreach(QString queryString, setupQueries()) {
162 QSqlQuery query = db.exec(queryString);
163 if(!watchQuery(query)) {
164 qCritical() << "Unable to setup Logging Backend!";
171 QStringList AbstractSqlStorage::upgradeQueries(int version) {
173 QDir dir = QDir(QString(":/SQL/%1/%2/").arg(displayName()).arg(version));
174 foreach(QFileInfo fileInfo, dir.entryInfoList(QStringList() << "upgrade*", QDir::NoFilter, QDir::Name)) {
175 queries << queryString(fileInfo.baseName(), version);
180 bool AbstractSqlStorage::upgradeDb() {
181 if(schemaVersion() <= installedSchemaVersion())
184 QSqlDatabase db = logDb();
186 for(int ver = installedSchemaVersion() + 1; ver <= schemaVersion(); ver++) {
187 foreach(QString queryString, upgradeQueries(ver)) {
188 QSqlQuery query = db.exec(queryString);
189 if(!watchQuery(query)) {
190 qCritical() << "Unable to upgrade Logging Backend!";
199 int AbstractSqlStorage::schemaVersion() {
200 // returns the newest Schema Version!
201 // not the currently used one! (though it can be the same)
202 if(_schemaVersion > 0)
203 return _schemaVersion;
207 QDir dir = QDir(":/SQL/" + displayName());
208 foreach(QFileInfo fileInfo, dir.entryInfoList()) {
209 if(!fileInfo.isDir())
212 version = fileInfo.fileName().toInt(&ok);
216 if(version > _schemaVersion)
217 _schemaVersion = version;
219 return _schemaVersion;
222 bool AbstractSqlStorage::watchQuery(QSqlQuery &query) {
223 if(query.lastError().isValid()) {
224 qCritical() << "unhandled Error in QSqlQuery!";
225 qCritical() << " last Query:\n" << query.lastQuery();
226 qCritical() << " executed Query:\n" << query.executedQuery();
227 qCritical() << " bound Values:";
228 QList<QVariant> list = query.boundValues().values();
229 for (int i = 0; i < list.size(); ++i)
230 qCritical() << i << ": " << list.at(i).toString().toAscii().data();
231 qCritical() << " Error Number:" << query.lastError().number();
232 qCritical() << " Error Message:" << query.lastError().text();
233 qCritical() << " Driver Message:" << query.lastError().driverText();
234 qCritical() << " DB Message:" << query.lastError().databaseText();
241 void AbstractSqlStorage::connectionDestroyed() {
242 QMutexLocker locker(&_connectionPoolMutex);
243 _connectionPool.remove(sender()->thread());
246 // ========================================
247 // AbstractSqlStorage::Connection
248 // ========================================
249 AbstractSqlStorage::Connection::Connection(const QString &name, AbstractSqlStorage *storage, QObject *parent)
251 _name(name.toLatin1()),
252 _storageEngine(storage)
256 AbstractSqlStorage::Connection::~Connection() {
257 QHash<QPair<QString, int>, QSqlQuery *>::iterator iter = _queryCache.begin();
258 while(iter != _queryCache.end()) {
260 iter = _queryCache.erase(iter);
263 QSqlDatabase db = QSqlDatabase::database(name(), false);
269 QSqlDatabase::removeDatabase(name());
272 QSqlQuery &AbstractSqlStorage::Connection::cachedQuery(const QString &queryName, int version) {
273 QPair<QString, int> queryId = qMakePair(queryName, version);
274 if(_queryCache.contains(queryId)) {
275 return *(_queryCache[queryId]);
278 QSqlQuery *query = new QSqlQuery(QSqlDatabase::database(name()));
279 query->prepare(_storageEngine->queryString(queryName, version));
280 _queryCache[queryId] = query;
284 void AbstractSqlStorage::Connection::syncCachedQueries() {
285 QHash<QPair<QString, int>, QSqlQuery *>::iterator iter = _queryCache.begin();
286 while(iter != _queryCache.end()) {
288 iter = _queryCache.erase(iter);
290 QSqlDatabase db = QSqlDatabase::database(name(), false);