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"
27 SqliteStorage::SqliteStorage(QObject *parent)
28 : AbstractSqlStorage(parent)
32 SqliteStorage::~SqliteStorage() {
35 bool SqliteStorage::isAvailable() const {
36 if(!QSqlDatabase::isDriverAvailable("QSQLITE")) return false;
40 QString SqliteStorage::displayName() const {
41 return QString("SQLite");
44 QString SqliteStorage::description() const {
45 return tr("SQLite is a file-based database engine that does not require any setup. It is suitable for small and medium-sized "
46 "databases that do not require access via network. Use SQLite if your Quassel Core should store its data on the same machine "
47 "it is running on, and if you only expect a few users to use your core.");
50 int SqliteStorage::installedSchemaVersion() {
51 QSqlQuery query = logDb().exec("SELECT value FROM coreinfo WHERE key = 'schemaversion'");
53 return query.value(0).toInt();
55 // maybe it's really old... (schema version 0)
56 query = logDb().exec("SELECT MAX(version) FROM coreinfo");
58 return query.value(0).toInt();
60 return AbstractSqlStorage::installedSchemaVersion();
63 UserId SqliteStorage::addUser(const QString &user, const QString &password) {
64 QSqlQuery query(logDb());
65 query.prepare(queryString("insert_quasseluser"));
66 query.bindValue(":username", user);
67 query.bindValue(":password", cryptedPassword(password));
69 if(query.lastError().isValid() && query.lastError().number() == 19) { // user already exists - sadly 19 seems to be the general constraint violation error...
73 query.prepare(queryString("select_userid"));
74 query.bindValue(":username", user);
77 UserId uid = query.value(0).toInt();
78 emit userAdded(uid, user);
82 void SqliteStorage::updateUser(UserId user, const QString &password) {
83 QSqlQuery query(logDb());
84 query.prepare(queryString("update_userpassword"));
85 query.bindValue(":userid", user.toInt());
86 query.bindValue(":password", cryptedPassword(password));
90 void SqliteStorage::renameUser(UserId user, const QString &newName) {
91 QSqlQuery query(logDb());
92 query.prepare(queryString("update_username"));
93 query.bindValue(":userid", user.toInt());
94 query.bindValue(":username", newName);
96 emit userRenamed(user, newName);
99 UserId SqliteStorage::validateUser(const QString &user, const QString &password) {
100 QSqlQuery query(logDb());
101 query.prepare(queryString("select_authuser"));
102 query.bindValue(":username", user);
103 query.bindValue(":password", cryptedPassword(password));
107 return query.value(0).toInt();
113 void SqliteStorage::delUser(UserId user) {
114 QSqlQuery query(logDb());
115 query.prepare(queryString("delete_backlog_by_uid"));
116 query.bindValue(":userid", user.toInt());
119 query.prepare(queryString("delete_buffers_by_uid"));
120 query.bindValue(":userid", user.toInt());
123 query.prepare(queryString("delete_networks_by_uid"));
124 query.bindValue(":userid", user.toInt());
127 query.prepare(queryString("delete_quasseluser"));
128 query.bindValue(":userid", user.toInt());
130 // I hate the lack of foreign keys and on delete cascade... :(
131 emit userRemoved(user);
134 NetworkId SqliteStorage::createNetwork(UserId user, const NetworkInfo &info) {
136 QSqlQuery query(logDb());
137 query.prepare(queryString("insert_network"));
138 query.bindValue(":userid", user.toInt());
139 query.bindValue(":networkname", info.networkName);
142 networkId = getNetworkId(user, info.networkName);
143 if(!networkId.isValid()) {
146 updateNetwork(user, info);
151 bool SqliteStorage::updateNetwork(UserId user, const NetworkInfo &info) {
152 if(!isValidNetwork(user, info.networkId))
155 QSqlQuery updateQuery(logDb());
156 updateQuery.prepare(queryString("update_network"));
157 updateQuery.bindValue(":networkname", info.networkName);
158 updateQuery.bindValue(":identityid", info.identity.toInt());
159 updateQuery.bindValue(":usecustomencoding", info.useCustomEncodings ? 1 : 0);
160 updateQuery.bindValue(":encodingcodec", QString(info.codecForEncoding));
161 updateQuery.bindValue(":decodingcodec", QString(info.codecForDecoding));
162 updateQuery.bindValue(":servercodec", QString(info.codecForServer));
163 updateQuery.bindValue(":userandomserver", info.useRandomServer ? 1 : 0);
164 updateQuery.bindValue(":perform", info.perform.join("\n"));
165 updateQuery.bindValue(":useautoidentify", info.useAutoIdentify ? 1 : 0);
166 updateQuery.bindValue(":autoidentifyservice", info.autoIdentifyService);
167 updateQuery.bindValue(":autoidentifypassword", info.autoIdentifyPassword);
168 updateQuery.bindValue(":useautoreconnect", info.useAutoReconnect ? 1 : 0);
169 updateQuery.bindValue(":autoreconnectinterval", info.autoReconnectInterval);
170 updateQuery.bindValue(":autoreconnectretries", info.autoReconnectRetries);
171 updateQuery.bindValue(":unlimitedconnectretries", info.unlimitedReconnectRetries ? 1 : 0);
172 updateQuery.bindValue(":rejoinchannels", info.rejoinChannels ? 1 : 0);
173 updateQuery.bindValue(":networkid", info.networkId.toInt());
175 if(!watchQuery(&updateQuery))
178 QSqlQuery dropServersQuery(logDb());
179 dropServersQuery.prepare("DELETE FROM ircserver WHERE networkid = :networkid");
180 dropServersQuery.bindValue(":networkid", info.networkId.toInt());
181 dropServersQuery.exec();
182 if(!watchQuery(&dropServersQuery))
185 QSqlQuery insertServersQuery(logDb());
186 insertServersQuery.prepare(queryString("insert_server"));
187 foreach(QVariant server_, info.serverList) {
188 QVariantMap server = server_.toMap();
189 insertServersQuery.bindValue(":hostname", server["Host"]);
190 insertServersQuery.bindValue(":port", server["Port"].toInt());
191 insertServersQuery.bindValue(":password", server["Password"]);
192 insertServersQuery.bindValue(":ssl", server["UseSSL"].toBool() ? 1 : 0);
193 insertServersQuery.bindValue(":userid", user.toInt());
194 insertServersQuery.bindValue(":networkid", info.networkId.toInt());
196 insertServersQuery.exec();
197 if(!watchQuery(&insertServersQuery))
204 bool SqliteStorage::removeNetwork(UserId user, const NetworkId &networkId) {
205 if(!isValidNetwork(user, networkId))
208 bool withTransaction = logDb().driver()->hasFeature(QSqlDriver::Transactions);
209 if(withTransaction) {
211 if(!logDb().transaction()) {
212 qWarning() << "SqliteStorage::removeNetwork(): cannot start transaction. continuing with out rollback support!";
213 withTransaction = false;
217 QSqlQuery deleteBacklogQuery(logDb());
218 deleteBacklogQuery.prepare(queryString("delete_backlog_for_network"));
219 deleteBacklogQuery.bindValue(":networkid", networkId.toInt());
220 deleteBacklogQuery.exec();
221 if(!watchQuery(&deleteBacklogQuery)) {
227 QSqlQuery deleteBuffersQuery(logDb());
228 deleteBuffersQuery.prepare(queryString("delete_buffers_for_network"));
229 deleteBuffersQuery.bindValue(":networkid", networkId.toInt());
230 deleteBuffersQuery.exec();
231 if(!watchQuery(&deleteBuffersQuery)) {
237 QSqlQuery deleteServersQuery(logDb());
238 deleteServersQuery.prepare(queryString("delete_ircservers_for_network"));
239 deleteServersQuery.bindValue(":networkid", networkId.toInt());
240 deleteServersQuery.exec();
241 if(!watchQuery(&deleteServersQuery)) {
247 QSqlQuery deleteNetworkQuery(logDb());
248 deleteNetworkQuery.prepare(queryString("delete_network"));
249 deleteNetworkQuery.bindValue(":networkid", networkId.toInt());
250 deleteNetworkQuery.exec();
251 if(!watchQuery(&deleteNetworkQuery)) {
261 QList<NetworkInfo> SqliteStorage::networks(UserId user) {
262 QList<NetworkInfo> nets;
264 QSqlQuery networksQuery(logDb());
265 networksQuery.prepare(queryString("select_networks_for_user"));
266 networksQuery.bindValue(":userid", user.toInt());
268 QSqlQuery serversQuery(logDb());
269 serversQuery.prepare(queryString("select_servers_for_network"));
271 networksQuery.exec();
272 if(!watchQuery(&networksQuery))
275 while(networksQuery.next()) {
277 net.networkId = networksQuery.value(0).toInt();
278 net.networkName = networksQuery.value(1).toString();
279 net.identity = networksQuery.value(2).toInt();
280 net.codecForServer = networksQuery.value(3).toString().toAscii();
281 net.codecForEncoding = networksQuery.value(4).toString().toAscii();
282 net.codecForDecoding = networksQuery.value(5).toString().toAscii();
283 net.useRandomServer = networksQuery.value(6).toInt() == 1 ? true : false;
284 net.perform = networksQuery.value(7).toString().split("\n");
285 net.useAutoIdentify = networksQuery.value(8).toInt() == 1 ? true : false;
286 net.autoIdentifyService = networksQuery.value(9).toString();
287 net.autoIdentifyPassword = networksQuery.value(10).toString();
288 net.useAutoReconnect = networksQuery.value(11).toInt() == 1 ? true : false;
289 net.autoReconnectInterval = networksQuery.value(12).toUInt();
290 net.autoReconnectRetries = networksQuery.value(13).toInt();
291 net.unlimitedReconnectRetries = networksQuery.value(14).toInt() == 1 ? true : false;
292 net.rejoinChannels = networksQuery.value(15).toInt() == 1 ? true : false;
294 serversQuery.bindValue(":networkid", net.networkId.toInt());
296 if(!watchQuery(&serversQuery))
299 QVariantList servers;
300 while(serversQuery.next()) {
302 server["Host"] = serversQuery.value(0).toString();
303 server["Port"] = serversQuery.value(1).toInt();
304 server["Password"] = serversQuery.value(2).toString();
305 server["UseSSL"] = serversQuery.value(3).toInt() == 1 ? true : false;
308 net.serverList = servers;
314 bool SqliteStorage::isValidNetwork(UserId user, const NetworkId &networkId) {
315 QSqlQuery query(logDb());
316 query.prepare(queryString("select_networkExists"));
317 query.bindValue(":userid", user.toInt());
318 query.bindValue(":networkid", networkId.toInt());
321 watchQuery(&query); // there should not occur any errors
325 Q_ASSERT(!query.next());
329 bool SqliteStorage::isValidBuffer(const UserId &user, const BufferId &bufferId) {
330 QSqlQuery query(logDb());
331 query.prepare(queryString("select_bufferExists"));
332 query.bindValue(":userid", user.toInt());
333 query.bindValue(":bufferid", bufferId.toInt());
340 Q_ASSERT(!query.next());
344 NetworkId SqliteStorage::getNetworkId(UserId user, const QString &network) {
345 QSqlQuery query(logDb());
346 query.prepare("SELECT networkid FROM network "
347 "WHERE userid = :userid AND networkname = :networkname");
348 query.bindValue(":userid", user.toInt());
349 query.bindValue(":networkname", network);
353 return query.value(0).toInt();
358 void SqliteStorage::createBuffer(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer) {
359 QSqlQuery *query = cachedQuery("insert_buffer");
360 query->bindValue(":userid", user.toInt());
361 query->bindValue(":networkid", networkId.toInt());
362 query->bindValue(":buffertype", (int)type);
363 query->bindValue(":buffername", buffer);
364 query->bindValue(":buffercname", buffer.toLower());
370 BufferInfo SqliteStorage::getBufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer) {
371 QSqlQuery *query = cachedQuery("select_bufferByName");
372 query->bindValue(":networkid", networkId.toInt());
373 query->bindValue(":userid", user.toInt());
374 query->bindValue(":buffercname", buffer.toLower());
377 if(!query->first()) {
378 createBuffer(user, networkId, type, buffer);
380 if(!query->first()) {
382 qWarning() << "unable to create BufferInfo for:" << user << networkId << buffer;
387 BufferInfo bufferInfo = BufferInfo(query->value(0).toInt(), networkId, (BufferInfo::Type)query->value(1).toInt(), 0, buffer);
389 qWarning() << "SqliteStorage::getBufferInfo(): received more then one Buffer!";
390 qWarning() << " Query:" << query->lastQuery();
391 qWarning() << " bound Values:" << query->boundValues();
398 BufferInfo SqliteStorage::getBufferInfo(UserId user, const BufferId &bufferId) {
399 QSqlQuery query(logDb());
400 query.prepare(queryString("select_buffer_by_id"));
401 query.bindValue(":userid", user.toInt());
402 query.bindValue(":bufferid", bufferId.toInt());
404 if(!watchQuery(&query))
410 BufferInfo bufferInfo(query.value(0).toInt(), query.value(1).toInt(), (BufferInfo::Type)query.value(2).toInt(), 0, query.value(4).toString());
411 Q_ASSERT(!query.next());
416 QList<BufferInfo> SqliteStorage::requestBuffers(UserId user, QDateTime since) {
419 time = since.toTime_t();
421 QList<BufferInfo> bufferlist;
422 QSqlQuery query(logDb());
423 query.prepare(queryString("select_buffers"));
424 query.bindValue(":userid", user.toInt());
425 query.bindValue(":time", time);
429 while(query.next()) {
430 bufferlist << BufferInfo(query.value(0).toInt(), query.value(1).toInt(), (BufferInfo::Type)query.value(2).toInt(), query.value(3).toInt(), query.value(4).toString());
435 bool SqliteStorage::removeBuffer(const UserId &user, const BufferId &bufferId) {
436 if(!isValidBuffer(user, bufferId))
439 QSqlQuery delBacklogQuery(logDb());
440 delBacklogQuery.prepare(queryString("delete_backlog_for_buffer"));
441 delBacklogQuery.bindValue(":bufferid", bufferId.toInt());
442 delBacklogQuery.exec();
443 if(!watchQuery(&delBacklogQuery))
446 QSqlQuery delBufferQuery(logDb());
447 delBufferQuery.prepare(queryString("delete_buffer_for_bufferid"));
448 delBufferQuery.bindValue(":bufferid", bufferId.toInt());
449 delBufferQuery.exec();
450 if(!watchQuery(&delBufferQuery))
456 BufferId SqliteStorage::renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName) {
457 // check if such a buffer exists...
458 QSqlQuery existsQuery(logDb());
459 existsQuery.prepare(queryString("select_bufferByName"));
460 existsQuery.bindValue(":networkid", networkId.toInt());
461 existsQuery.bindValue(":userid", user.toInt());
462 existsQuery.bindValue(":buffercname", oldName.toLower());
464 if(!watchQuery(&existsQuery))
467 if(!existsQuery.first())
470 const int bufferid = existsQuery.value(0).toInt();
472 Q_ASSERT(!existsQuery.next());
474 // ... and if the new name is still free.
475 existsQuery.bindValue(":networkid", networkId.toInt());
476 existsQuery.bindValue(":userid", user.toInt());
477 existsQuery.bindValue(":buffercname", newName.toLower());
479 if(!watchQuery(&existsQuery))
482 if(existsQuery.first())
485 QSqlQuery renameBufferQuery(logDb());
486 renameBufferQuery.prepare(queryString("update_buffer_name"));
487 renameBufferQuery.bindValue(":buffername", newName);
488 renameBufferQuery.bindValue(":buffercname", newName.toLower());
489 renameBufferQuery.bindValue(":bufferid", bufferid);
490 renameBufferQuery.exec();
491 if(watchQuery(&existsQuery))
492 return BufferId(bufferid);
497 void SqliteStorage::setBufferLastSeen(UserId user, const BufferId &bufferId, const QDateTime &seenDate) {
498 QSqlQuery *query = cachedQuery("update_buffer_lastseen");
499 query->bindValue(":userid", user.toInt());
500 query->bindValue(":bufferid", bufferId.toInt());
501 query->bindValue(":lastseen", seenDate.toTime_t());
506 QHash<BufferId, QDateTime> SqliteStorage::bufferLastSeenDates(UserId user) {
507 QHash<BufferId, QDateTime> lastSeenHash;
508 QSqlQuery query(logDb());
509 query.prepare(queryString("select_buffer_lastseen_dates"));
510 query.bindValue(":userid", user.toInt());
512 if(!watchQuery(&query))
515 while(query.next()) {
516 lastSeenHash[query.value(0).toInt()] = QDateTime::fromTime_t(query.value(1).toUInt());
521 MsgId SqliteStorage::logMessage(Message msg) {
522 QSqlQuery *logMessageQuery = cachedQuery("insert_message");
523 logMessageQuery->bindValue(":time", msg.timestamp().toTime_t());
524 logMessageQuery->bindValue(":bufferid", msg.bufferInfo().bufferId().toInt());
525 logMessageQuery->bindValue(":type", msg.type());
526 logMessageQuery->bindValue(":flags", msg.flags());
527 logMessageQuery->bindValue(":sender", msg.sender());
528 logMessageQuery->bindValue(":message", msg.text());
529 logMessageQuery->exec();
531 if(logMessageQuery->lastError().isValid()) {
532 // constraint violation - must be NOT NULL constraint - probably the sender is missing...
533 if(logMessageQuery->lastError().number() == 19) {
534 QSqlQuery *addSenderQuery = cachedQuery("insert_sender");
535 addSenderQuery->bindValue(":sender", msg.sender());
536 addSenderQuery->exec();
537 watchQuery(addSenderQuery);
538 logMessageQuery->exec();
539 if(!watchQuery(logMessageQuery))
542 watchQuery(logMessageQuery);
546 MsgId msgId = logMessageQuery->lastInsertId().toInt();
547 Q_ASSERT(msgId.isValid());
551 QList<Message> SqliteStorage::requestMsgs(BufferInfo buffer, int lastmsgs, int offset) {
552 QList<Message> messagelist;
553 // we have to determine the real offset first
554 QSqlQuery *offsetQuery = cachedQuery("select_messagesOffset");
555 offsetQuery->bindValue(":bufferid", buffer.bufferId().toInt());
556 offsetQuery->bindValue(":messageid", offset);
558 offsetQuery->first();
559 offset = offsetQuery->value(0).toInt();
561 // now let's select the messages
562 QSqlQuery *msgQuery = cachedQuery("select_messages");
563 msgQuery->bindValue(":bufferid", buffer.bufferId().toInt());
564 msgQuery->bindValue(":limit", lastmsgs);
565 msgQuery->bindValue(":offset", offset);
568 watchQuery(msgQuery);
570 while(msgQuery->next()) {
571 Message msg(QDateTime::fromTime_t(msgQuery->value(1).toInt()),
573 (Message::Type)msgQuery->value(2).toUInt(),
574 msgQuery->value(5).toString(),
575 msgQuery->value(4).toString(),
576 msgQuery->value(3).toUInt());
577 msg.setMsgId(msgQuery->value(0).toInt());
584 QList<Message> SqliteStorage::requestMsgs(BufferInfo buffer, QDateTime since, int offset) {
585 QList<Message> messagelist;
586 // we have to determine the real offset first
587 QSqlQuery *offsetQuery = cachedQuery("select_messagesSinceOffset");
588 offsetQuery->bindValue(":bufferid", buffer.bufferId().toInt());
589 offsetQuery->bindValue(":since", since.toTime_t());
591 offsetQuery->first();
592 offset = offsetQuery->value(0).toInt();
594 // now let's select the messages
595 QSqlQuery *msgQuery = cachedQuery("select_messagesSince");
596 msgQuery->bindValue(":bufferid", buffer.bufferId().toInt());
597 msgQuery->bindValue(":since", since.toTime_t());
598 msgQuery->bindValue(":offset", offset);
601 watchQuery(msgQuery);
603 while(msgQuery->next()) {
604 Message msg(QDateTime::fromTime_t(msgQuery->value(1).toInt()),
606 (Message::Type)msgQuery->value(2).toUInt(),
607 msgQuery->value(5).toString(),
608 msgQuery->value(4).toString(),
609 msgQuery->value(3).toUInt());
610 msg.setMsgId(msgQuery->value(0).toInt());
618 QList<Message> SqliteStorage::requestMsgRange(BufferInfo buffer, int first, int last) {
619 QList<Message> messagelist;
620 QSqlQuery *rangeQuery = cachedQuery("select_messageRange");
621 rangeQuery->bindValue(":bufferid", buffer.bufferId().toInt());
622 rangeQuery->bindValue(":firstmsg", first);
623 rangeQuery->bindValue(":lastmsg", last);
626 watchQuery(rangeQuery);
628 while(rangeQuery->next()) {
629 Message msg(QDateTime::fromTime_t(rangeQuery->value(1).toInt()),
631 (Message::Type)rangeQuery->value(2).toUInt(),
632 rangeQuery->value(5).toString(),
633 rangeQuery->value(4).toString(),
634 rangeQuery->value(3).toUInt());
635 msg.setMsgId(rangeQuery->value(0).toInt());
642 QString SqliteStorage::backlogFile() {
643 // kinda ugly, but I currently see no other way to do that
645 QString quasselDir = QDir::homePath() + qgetenv("APPDATA") + "\\quassel\\";
647 QString quasselDir = QDir::homePath() + "/.quassel/";
650 QDir qDir(quasselDir);
651 if(!qDir.exists(quasselDir))
652 qDir.mkpath(quasselDir);
654 return quasselDir + "quassel-storage.sqlite";
658 // ONLY NEEDED FOR MIGRATION
659 bool SqliteStorage::init(const QVariantMap &settings) {
660 if(!AbstractSqlStorage::init(settings))
663 QSqlQuery checkMigratedQuery(logDb());
664 checkMigratedQuery.prepare("SELECT DISTINCT typeOf(password) FROM quasseluser");
665 checkMigratedQuery.exec();
666 if(!watchQuery(&checkMigratedQuery))
669 if(!checkMigratedQuery.first())
672 QString passType = checkMigratedQuery.value(0).toString().toLower();
673 if(passType == "text")
674 return true; // allready migrated
676 Q_ASSERT(passType == "blob");
678 QSqlQuery getPasswordsQuery(logDb());
679 getPasswordsQuery.prepare("SELECT userid, password FROM quasseluser");
680 getPasswordsQuery.exec();
682 if(!watchQuery(&getPasswordsQuery)) {
683 qWarning() << "unable to migrate to new password format!";
687 QHash<int, QByteArray> passHash;
688 while(getPasswordsQuery.next()) {
689 passHash[getPasswordsQuery.value(0).toInt()] = getPasswordsQuery.value(1).toByteArray();
692 QSqlQuery setPasswordsQuery(logDb());
693 setPasswordsQuery.prepare("UPDATE quasseluser SET password = :password WHERE userid = :userid");
694 foreach(int userId, passHash.keys()) {
695 setPasswordsQuery.bindValue(":password", QString(passHash[userId]));
696 setPasswordsQuery.bindValue(":userid", userId);
697 setPasswordsQuery.exec();
698 watchQuery(&setPasswordsQuery);
701 qDebug() << "successfully migrated passwords!";