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 "sqlitestorage.h"
23 #include <QCryptographicHash>
28 SqliteStorage::SqliteStorage(QObject *parent)
29 : AbstractSqlStorage(parent)
33 SqliteStorage::~SqliteStorage() {
36 bool SqliteStorage::isAvailable() const {
37 if(!QSqlDatabase::isDriverAvailable("QSQLITE")) return false;
41 QString SqliteStorage::displayName() const {
42 return QString("SQLite");
45 QString SqliteStorage::description() const {
46 return tr("SQLite is a file-based database engine that does not require any setup. It is suitable for small and medium-sized "
47 "databases that do not require access via network. Use SQLite if your Quassel Core should store its data on the same machine "
48 "it is running on, and if you only expect a few users to use your core.");
51 int SqliteStorage::installedSchemaVersion() {
52 QSqlQuery query = logDb().exec("SELECT value FROM coreinfo WHERE key = 'schemaversion'");
54 return query.value(0).toInt();
56 // maybe it's really old... (schema version 0)
57 query = logDb().exec("SELECT MAX(version) FROM coreinfo");
59 return query.value(0).toInt();
61 return AbstractSqlStorage::installedSchemaVersion();
64 UserId SqliteStorage::addUser(const QString &user, const QString &password) {
65 QByteArray cryptopass = QCryptographicHash::hash(password.toUtf8(), QCryptographicHash::Sha1);
66 cryptopass = cryptopass.toHex();
68 QSqlQuery query(logDb());
69 query.prepare(queryString("insert_quasseluser"));
70 query.bindValue(":username", user);
71 query.bindValue(":password", cryptopass);
73 if(query.lastError().isValid() && query.lastError().number() == 19) { // user already exists - sadly 19 seems to be the general constraint violation error...
77 query.prepare(queryString("select_userid"));
78 query.bindValue(":username", user);
81 UserId uid = query.value(0).toInt();
82 emit userAdded(uid, user);
86 void SqliteStorage::updateUser(UserId user, const QString &password) {
87 QByteArray cryptopass = QCryptographicHash::hash(password.toUtf8(), QCryptographicHash::Sha1);
88 cryptopass = cryptopass.toHex();
90 QSqlQuery query(logDb());
91 query.prepare(queryString("update_userpassword"));
92 query.bindValue(":userid", user.toInt());
93 query.bindValue(":password", cryptopass);
97 void SqliteStorage::renameUser(UserId user, const QString &newName) {
98 QSqlQuery query(logDb());
99 query.prepare(queryString("update_username"));
100 query.bindValue(":userid", user.toInt());
101 query.bindValue(":username", newName);
103 emit userRenamed(user, newName);
106 UserId SqliteStorage::validateUser(const QString &user, const QString &password) {
107 QByteArray cryptopass = QCryptographicHash::hash(password.toUtf8(), QCryptographicHash::Sha1);
108 cryptopass = cryptopass.toHex();
110 QSqlQuery query(logDb());
111 query.prepare(queryString("select_authuser"));
112 query.bindValue(":username", user);
113 query.bindValue(":password", cryptopass);
117 return query.value(0).toInt();
123 void SqliteStorage::delUser(UserId user) {
124 QSqlQuery query(logDb());
125 query.prepare(queryString("delete_backlog_by_uid"));
126 query.bindValue(":userid", user.toInt());
129 query.prepare(queryString("delete_buffers_by_uid"));
130 query.bindValue(":userid", user.toInt());
133 query.prepare(queryString("delete_networks_by_uid"));
134 query.bindValue(":userid", user.toInt());
137 query.prepare(queryString("delete_quasseluser"));
138 query.bindValue(":userid", user.toInt());
140 // I hate the lack of foreign keys and on delete cascade... :(
141 emit userRemoved(user);
144 NetworkId SqliteStorage::createNetwork(UserId user, const NetworkInfo &info) {
146 QSqlQuery query(logDb());
147 query.prepare(queryString("insert_network"));
148 query.bindValue(":userid", user.toInt());
149 query.bindValue(":networkname", info.networkName);
152 networkId = getNetworkId(user, info.networkName);
153 if(!networkId.isValid()) {
156 updateNetwork(user, info);
161 bool SqliteStorage::updateNetwork(UserId user, const NetworkInfo &info) {
162 if(!isValidNetwork(user, info.networkId))
165 QSqlQuery updateQuery(logDb());
166 updateQuery.prepare(queryString("update_network"));
167 updateQuery.bindValue(":networkname", info.networkName);
168 updateQuery.bindValue(":identityid", info.identity.toInt());
169 updateQuery.bindValue(":usecustomencoding", info.useCustomEncodings ? 1 : 0);
170 updateQuery.bindValue(":encodingcodec", QString(info.codecForEncoding));
171 updateQuery.bindValue(":decodingcodec", QString(info.codecForDecoding));
172 updateQuery.bindValue(":userandomserver", info.useRandomServer ? 1 : 0);
173 updateQuery.bindValue(":perform", info.perform.join("\n"));
174 updateQuery.bindValue(":useautoidentify", info.useAutoIdentify ? 1 : 0);
175 updateQuery.bindValue(":autoidentifyservice", info.autoIdentifyService);
176 updateQuery.bindValue(":autoidentifypassword", info.autoIdentifyPassword);
177 updateQuery.bindValue(":useautoreconnect", info.useAutoReconnect ? 1 : 0);
178 updateQuery.bindValue(":autoreconnectinterval", info.autoReconnectInterval);
179 updateQuery.bindValue(":autoreconnectretries", info.autoReconnectRetries);
180 updateQuery.bindValue(":rejoinchannels", info.rejoinChannels ? 1 : 0);
181 updateQuery.bindValue(":networkid", info.networkId.toInt());
183 if(!watchQuery(&updateQuery))
186 QSqlQuery dropServersQuery(logDb());
187 dropServersQuery.prepare("DELETE FROM ircserver WHERE networkid = :networkid");
188 dropServersQuery.bindValue(":networkid", info.networkId.toInt());
189 dropServersQuery.exec();
190 if(!watchQuery(&dropServersQuery))
193 QSqlQuery insertServersQuery(logDb());
194 insertServersQuery.prepare(queryString("insert_server"));
195 foreach(QVariant server_, info.serverList) {
196 QVariantMap server = server_.toMap();
197 insertServersQuery.bindValue(":hostname", server["Host"]);
198 insertServersQuery.bindValue(":port", server["Port"].toInt());
199 insertServersQuery.bindValue(":password", server["Password"]);
200 insertServersQuery.bindValue(":ssl", server["UseSSL"].toBool() ? 1 : 0);
201 insertServersQuery.bindValue(":userid", user.toInt());
202 insertServersQuery.bindValue(":networkid", info.networkId.toInt());
204 insertServersQuery.exec();
205 if(!watchQuery(&insertServersQuery))
212 bool SqliteStorage::removeNetwork(UserId user, const NetworkId &networkId) {
213 if(!isValidNetwork(user, networkId))
216 bool withTransaction = logDb().driver()->hasFeature(QSqlDriver::Transactions);
217 if(withTransaction) {
219 if(!logDb().transaction()) {
220 qWarning() << "SqliteStorage::removeNetwork(): cannot start transaction. continuing with out rollback support!";
221 withTransaction = false;
225 QSqlQuery deleteBacklogQuery(logDb());
226 deleteBacklogQuery.prepare(queryString("delete_backlog_for_network"));
227 deleteBacklogQuery.bindValue(":networkid", networkId.toInt());
228 deleteBacklogQuery.exec();
229 if(!watchQuery(&deleteBacklogQuery)) {
235 QSqlQuery deleteBuffersQuery(logDb());
236 deleteBuffersQuery.prepare(queryString("delete_buffers_for_network"));
237 deleteBuffersQuery.bindValue(":networkid", networkId.toInt());
238 deleteBuffersQuery.exec();
239 if(!watchQuery(&deleteBuffersQuery)) {
245 QSqlQuery deleteServersQuery(logDb());
246 deleteServersQuery.prepare(queryString("delete_ircservers_for_network"));
247 deleteServersQuery.bindValue(":networkid", networkId.toInt());
248 deleteServersQuery.exec();
249 if(!watchQuery(&deleteServersQuery)) {
255 QSqlQuery deleteNetworkQuery(logDb());
256 deleteNetworkQuery.prepare(queryString("delete_network"));
257 deleteNetworkQuery.bindValue(":networkid", networkId.toInt());
258 deleteNetworkQuery.exec();
259 if(!watchQuery(&deleteNetworkQuery)) {
269 QList<NetworkInfo> SqliteStorage::networks(UserId user) {
270 QList<NetworkInfo> nets;
272 QSqlQuery networksQuery(logDb());
273 networksQuery.prepare(queryString("select_networks_for_user"));
274 networksQuery.bindValue(":userid", user.toInt());
276 QSqlQuery serversQuery(logDb());
277 serversQuery.prepare(queryString("select_servers_for_network"));
279 networksQuery.exec();
280 if(!watchQuery(&networksQuery))
283 while(networksQuery.next()) {
285 net.networkId = networksQuery.value(0).toInt();
286 net.networkName = networksQuery.value(1).toString();
287 net.identity = networksQuery.value(2).toInt();
288 net.useCustomEncodings = networksQuery.value(3).toInt() == 1 ? true : false;
289 net.codecForEncoding = networksQuery.value(4).toString().toAscii();
290 net.codecForDecoding = networksQuery.value(5).toString().toAscii();
291 net.useRandomServer = networksQuery.value(6).toInt() == 1 ? true : false;
292 net.perform = networksQuery.value(7).toString().split("\n");
293 net.useAutoIdentify = networksQuery.value(8).toInt() == 1 ? true : false;
294 net.autoIdentifyService = networksQuery.value(9).toString();
295 net.autoIdentifyPassword = networksQuery.value(10).toString();
296 net.useAutoReconnect = networksQuery.value(11).toInt() == 1 ? true : false;
297 net.autoReconnectInterval = networksQuery.value(12).toUInt();
298 net.autoReconnectRetries = networksQuery.value(13).toInt();
299 net.rejoinChannels = networksQuery.value(14).toInt() == 1 ? true : false;
301 serversQuery.bindValue(":networkid", net.networkId.toInt());
303 if(!watchQuery(&serversQuery))
306 QVariantList servers;
307 while(serversQuery.next()) {
309 server["Host"] = serversQuery.value(0).toString();
310 server["Port"] = serversQuery.value(1).toInt();
311 server["Password"] = serversQuery.value(2).toString();
312 server["UseSSL"] = serversQuery.value(3).toInt() == 1 ? true : false;
315 net.serverList = servers;
321 bool SqliteStorage::isValidNetwork(UserId user, const NetworkId &networkId) {
322 QSqlQuery query(logDb());
323 query.prepare(queryString("select_networkExists"));
324 query.bindValue(":userid", user.toInt());
325 query.bindValue(":networkid", networkId.toInt());
328 watchQuery(&query); // there should not occur any errors
332 Q_ASSERT(!query.next());
336 NetworkId SqliteStorage::getNetworkId(UserId user, const QString &network) {
337 QSqlQuery query(logDb());
338 query.prepare("SELECT networkid FROM network "
339 "WHERE userid = :userid AND networkname = :networkname");
340 query.bindValue(":userid", user.toInt());
341 query.bindValue(":networkname", network);
345 return query.value(0).toInt();
350 void SqliteStorage::createBuffer(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer) {
351 QSqlQuery *query = cachedQuery("insert_buffer");
352 query->bindValue(":userid", user.toInt());
353 query->bindValue(":networkid", networkId.toInt());
354 query->bindValue(":buffertype", (int)type);
355 query->bindValue(":buffername", buffer);
356 query->bindValue(":buffercname", buffer.toLower());
362 BufferInfo SqliteStorage::getBufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer) {
363 QSqlQuery *query = cachedQuery("select_bufferByName");
364 query->bindValue(":networkid", networkId.toInt());
365 query->bindValue(":userid", user.toInt());
366 query->bindValue(":buffercname", buffer.toLower());
369 if(!query->first()) {
370 createBuffer(user, networkId, type, buffer);
372 if(!query->first()) {
374 qWarning() << "unable to create BufferInfo for:" << user << networkId << buffer;
379 BufferInfo bufferInfo = BufferInfo(query->value(0).toInt(), networkId, (BufferInfo::Type)query->value(1).toInt(), 0, buffer);
381 qWarning() << "SqliteStorage::getBufferInfo(): received more then one Buffer!";
382 qWarning() << " Query:" << query->lastQuery();
383 qWarning() << " bound Values:" << query->boundValues();
390 QList<BufferInfo> SqliteStorage::requestBuffers(UserId user, QDateTime since) {
393 time = since.toTime_t();
395 QList<BufferInfo> bufferlist;
396 QSqlQuery query(logDb());
397 query.prepare(queryString("select_buffers"));
398 query.bindValue(":userid", user.toInt());
399 query.bindValue(":time", time);
403 while(query.next()) {
404 bufferlist << BufferInfo(query.value(0).toInt(), query.value(1).toInt(), (BufferInfo::Type)query.value(2).toInt(), query.value(3).toInt(), query.value(4).toString());
409 MsgId SqliteStorage::logMessage(Message msg) {
410 QSqlQuery *logMessageQuery = cachedQuery("insert_message");
411 logMessageQuery->bindValue(":time", msg.timestamp().toTime_t());
412 logMessageQuery->bindValue(":bufferid", msg.bufferInfo().bufferId().toInt());
413 logMessageQuery->bindValue(":type", msg.type());
414 logMessageQuery->bindValue(":flags", msg.flags());
415 logMessageQuery->bindValue(":sender", msg.sender());
416 logMessageQuery->bindValue(":message", msg.text());
417 logMessageQuery->exec();
419 if(logMessageQuery->lastError().isValid()) {
420 // constraint violation - must be NOT NULL constraint - probably the sender is missing...
421 if(logMessageQuery->lastError().number() == 19) {
422 QSqlQuery *addSenderQuery = cachedQuery("insert_sender");
423 addSenderQuery->bindValue(":sender", msg.sender());
424 addSenderQuery->exec();
425 watchQuery(addSenderQuery);
426 logMessageQuery->exec();
427 if(!watchQuery(logMessageQuery))
430 watchQuery(logMessageQuery);
434 QSqlQuery *getLastMessageIdQuery = cachedQuery("select_lastMessage");
435 getLastMessageIdQuery->bindValue(":time", msg.timestamp().toTime_t());
436 getLastMessageIdQuery->bindValue(":bufferid", msg.bufferInfo().bufferId().toInt());
437 getLastMessageIdQuery->bindValue(":type", msg.type());
438 getLastMessageIdQuery->bindValue(":sender", msg.sender());
439 getLastMessageIdQuery->exec();
441 if(getLastMessageIdQuery->first()) {
442 return getLastMessageIdQuery->value(0).toInt();
443 } else { // somethin went wrong... :(
444 qDebug() << getLastMessageIdQuery->lastQuery() << "time/bufferid/type/sender:" << msg.timestamp().toTime_t() << msg.bufferInfo().bufferId() << msg.type() << msg.sender();
450 QList<Message> SqliteStorage::requestMsgs(BufferInfo buffer, int lastmsgs, int offset) {
451 QList<Message> messagelist;
452 // we have to determine the real offset first
453 QSqlQuery *offsetQuery = cachedQuery("select_messagesOffset");
454 offsetQuery->bindValue(":bufferid", buffer.bufferId().toInt());
455 offsetQuery->bindValue(":messageid", offset);
457 offsetQuery->first();
458 offset = offsetQuery->value(0).toInt();
460 // now let's select the messages
461 QSqlQuery *msgQuery = cachedQuery("select_messages");
462 msgQuery->bindValue(":bufferid", buffer.bufferId().toInt());
463 msgQuery->bindValue(":limit", lastmsgs);
464 msgQuery->bindValue(":offset", offset);
467 watchQuery(msgQuery);
469 while(msgQuery->next()) {
470 Message msg(QDateTime::fromTime_t(msgQuery->value(1).toInt()),
472 (Message::Type)msgQuery->value(2).toUInt(),
473 msgQuery->value(5).toString(),
474 msgQuery->value(4).toString(),
475 msgQuery->value(3).toUInt());
476 msg.setMsgId(msgQuery->value(0).toInt());
483 QList<Message> SqliteStorage::requestMsgs(BufferInfo buffer, QDateTime since, int offset) {
484 QList<Message> messagelist;
485 // we have to determine the real offset first
486 QSqlQuery *offsetQuery = cachedQuery("select_messagesSinceOffset");
487 offsetQuery->bindValue(":bufferid", buffer.bufferId().toInt());
488 offsetQuery->bindValue(":since", since.toTime_t());
490 offsetQuery->first();
491 offset = offsetQuery->value(0).toInt();
493 // now let's select the messages
494 QSqlQuery *msgQuery = cachedQuery("select_messagesSince");
495 msgQuery->bindValue(":bufferid", buffer.bufferId().toInt());
496 msgQuery->bindValue(":since", since.toTime_t());
497 msgQuery->bindValue(":offset", offset);
500 watchQuery(msgQuery);
502 while(msgQuery->next()) {
503 Message msg(QDateTime::fromTime_t(msgQuery->value(1).toInt()),
505 (Message::Type)msgQuery->value(2).toUInt(),
506 msgQuery->value(5).toString(),
507 msgQuery->value(4).toString(),
508 msgQuery->value(3).toUInt());
509 msg.setMsgId(msgQuery->value(0).toInt());
517 QList<Message> SqliteStorage::requestMsgRange(BufferInfo buffer, int first, int last) {
518 QList<Message> messagelist;
519 QSqlQuery *rangeQuery = cachedQuery("select_messageRange");
520 rangeQuery->bindValue(":bufferid", buffer.bufferId().toInt());
521 rangeQuery->bindValue(":firstmsg", first);
522 rangeQuery->bindValue(":lastmsg", last);
525 watchQuery(rangeQuery);
527 while(rangeQuery->next()) {
528 Message msg(QDateTime::fromTime_t(rangeQuery->value(1).toInt()),
530 (Message::Type)rangeQuery->value(2).toUInt(),
531 rangeQuery->value(5).toString(),
532 rangeQuery->value(4).toString(),
533 rangeQuery->value(3).toUInt());
534 msg.setMsgId(rangeQuery->value(0).toInt());
541 QString SqliteStorage::backlogFile() {
542 // kinda ugly, but I currently see no other way to do that
544 QString quasselDir = QDir::homePath() + qgetenv("APPDATA") + "\\quassel\\";
546 QString quasselDir = QDir::homePath() + "/.quassel/";
549 QDir qDir(quasselDir);
550 if(!qDir.exists(quasselDir))
551 qDir.mkpath(quasselDir);
553 return quasselDir + "quassel-storage.sqlite";