Changed storage to store last seen dates of buffers, server encoding
[quassel.git] / src / core / sqlitestorage.cpp
1 /***************************************************************************
2  *   Copyright (C) 2005-07 by the Quassel IRC Team                         *
3  *   devel@quassel-irc.org                                                 *
4  *                                                                         *
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.                                           *
9  *                                                                         *
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.                          *
14  *                                                                         *
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  ***************************************************************************/
20
21 #include "sqlitestorage.h"
22
23 #include <QCryptographicHash>
24 #include <QtSql>
25
26 #include "network.h"
27
28 SqliteStorage::SqliteStorage(QObject *parent)
29   : AbstractSqlStorage(parent)
30 {
31 }
32
33 SqliteStorage::~SqliteStorage() {
34 }
35
36 bool SqliteStorage::isAvailable() const {
37   if(!QSqlDatabase::isDriverAvailable("QSQLITE")) return false;
38   return true;
39 }
40
41 QString SqliteStorage::displayName() const {
42   return QString("SQLite");
43 }
44
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.");
49 }
50
51 int SqliteStorage::installedSchemaVersion() {
52   QSqlQuery query = logDb().exec("SELECT value FROM coreinfo WHERE key = 'schemaversion'");
53   if(query.first())
54     return query.value(0).toInt();
55
56   // maybe it's really old... (schema version 0)
57   query = logDb().exec("SELECT MAX(version) FROM coreinfo");
58   if(query.first())
59     return query.value(0).toInt();
60
61   return AbstractSqlStorage::installedSchemaVersion();
62 }
63
64 UserId SqliteStorage::addUser(const QString &user, const QString &password) {
65   QByteArray cryptopass = QCryptographicHash::hash(password.toUtf8(), QCryptographicHash::Sha1);
66   cryptopass = cryptopass.toHex();
67
68   QSqlQuery query(logDb());
69   query.prepare(queryString("insert_quasseluser"));
70   query.bindValue(":username", user);
71   query.bindValue(":password", cryptopass);
72   query.exec();
73   if(query.lastError().isValid() && query.lastError().number() == 19) { // user already exists - sadly 19 seems to be the general constraint violation error...
74     return 0;
75   }
76
77   query.prepare(queryString("select_userid"));
78   query.bindValue(":username", user);
79   query.exec();
80   query.first();
81   UserId uid = query.value(0).toInt();
82   emit userAdded(uid, user);
83   return uid;
84 }
85
86 void SqliteStorage::updateUser(UserId user, const QString &password) {
87   QByteArray cryptopass = QCryptographicHash::hash(password.toUtf8(), QCryptographicHash::Sha1);
88   cryptopass = cryptopass.toHex();
89
90   QSqlQuery query(logDb());
91   query.prepare(queryString("update_userpassword"));
92   query.bindValue(":userid", user.toInt());
93   query.bindValue(":password", cryptopass);
94   query.exec();
95 }
96
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);
102   query.exec();
103   emit userRenamed(user, newName);
104 }
105
106 UserId SqliteStorage::validateUser(const QString &user, const QString &password) {
107   QByteArray cryptopass = QCryptographicHash::hash(password.toUtf8(), QCryptographicHash::Sha1);
108   cryptopass = cryptopass.toHex();
109
110   QSqlQuery query(logDb());
111   query.prepare(queryString("select_authuser"));
112   query.bindValue(":username", user);
113   query.bindValue(":password", cryptopass);
114   query.exec();
115
116   if(query.first()) {
117     return query.value(0).toInt();
118   } else {
119     return 0;
120   }
121 }
122
123 void SqliteStorage::delUser(UserId user) {
124   QSqlQuery query(logDb());
125   query.prepare(queryString("delete_backlog_by_uid"));
126   query.bindValue(":userid", user.toInt());
127   query.exec();
128   
129   query.prepare(queryString("delete_buffers_by_uid"));
130   query.bindValue(":userid", user.toInt());
131   query.exec();
132   
133   query.prepare(queryString("delete_networks_by_uid"));
134   query.bindValue(":userid", user.toInt());
135   query.exec();
136   
137   query.prepare(queryString("delete_quasseluser"));
138   query.bindValue(":userid", user.toInt());
139   query.exec();
140   // I hate the lack of foreign keys and on delete cascade... :(
141   emit userRemoved(user);
142 }
143
144 NetworkId SqliteStorage::createNetwork(UserId user, const NetworkInfo &info) {
145   NetworkId networkId;
146   QSqlQuery query(logDb());
147   query.prepare(queryString("insert_network"));
148   query.bindValue(":userid", user.toInt());
149   query.bindValue(":networkname", info.networkName);
150   query.exec();
151   
152   networkId = getNetworkId(user, info.networkName);
153   if(!networkId.isValid()) {
154     watchQuery(&query);
155   } else {
156     updateNetwork(user, info);
157   }
158   return networkId;
159 }
160
161 bool SqliteStorage::updateNetwork(UserId user, const NetworkInfo &info) {
162   if(!isValidNetwork(user, info.networkId))
163      return false;
164   
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(":servercodec", QString(info.codecForServer));
173   updateQuery.bindValue(":userandomserver", info.useRandomServer ? 1 : 0);
174   updateQuery.bindValue(":perform", info.perform.join("\n"));
175   updateQuery.bindValue(":useautoidentify", info.useAutoIdentify ? 1 : 0);
176   updateQuery.bindValue(":autoidentifyservice", info.autoIdentifyService);
177   updateQuery.bindValue(":autoidentifypassword", info.autoIdentifyPassword);
178   updateQuery.bindValue(":useautoreconnect", info.useAutoReconnect ? 1 : 0);
179   updateQuery.bindValue(":autoreconnectinterval", info.autoReconnectInterval);
180   updateQuery.bindValue(":autoreconnectretries", info.autoReconnectRetries);
181   updateQuery.bindValue(":unlimitedconnectretries", info.unlimitedReconnectRetries ? 1 : 0);
182   updateQuery.bindValue(":rejoinchannels", info.rejoinChannels ? 1 : 0);
183   updateQuery.bindValue(":networkid", info.networkId.toInt());
184   updateQuery.exec();
185   if(!watchQuery(&updateQuery))
186     return false;
187
188   QSqlQuery dropServersQuery(logDb());
189   dropServersQuery.prepare("DELETE FROM ircserver WHERE networkid = :networkid");
190   dropServersQuery.bindValue(":networkid", info.networkId.toInt());
191   dropServersQuery.exec();
192   if(!watchQuery(&dropServersQuery))
193     return false;
194
195   QSqlQuery insertServersQuery(logDb());
196   insertServersQuery.prepare(queryString("insert_server"));
197   foreach(QVariant server_, info.serverList) {
198     QVariantMap server = server_.toMap();
199     insertServersQuery.bindValue(":hostname", server["Host"]);
200     insertServersQuery.bindValue(":port", server["Port"].toInt());
201     insertServersQuery.bindValue(":password", server["Password"]);
202     insertServersQuery.bindValue(":ssl", server["UseSSL"].toBool() ? 1 : 0);
203     insertServersQuery.bindValue(":userid", user.toInt());
204     insertServersQuery.bindValue(":networkid", info.networkId.toInt());
205
206     insertServersQuery.exec();
207     if(!watchQuery(&insertServersQuery))
208       return false;
209   }
210   
211   return true;
212 }
213
214 bool SqliteStorage::removeNetwork(UserId user, const NetworkId &networkId) {
215   if(!isValidNetwork(user, networkId))
216      return false;
217
218   bool withTransaction = logDb().driver()->hasFeature(QSqlDriver::Transactions);
219   if(withTransaction) {
220     sync();
221     if(!logDb().transaction()) {
222       qWarning() << "SqliteStorage::removeNetwork(): cannot start transaction. continuing with out rollback support!";
223       withTransaction = false;
224     }
225   }
226   
227   QSqlQuery deleteBacklogQuery(logDb());
228   deleteBacklogQuery.prepare(queryString("delete_backlog_for_network"));
229   deleteBacklogQuery.bindValue(":networkid", networkId.toInt());
230   deleteBacklogQuery.exec();
231   if(!watchQuery(&deleteBacklogQuery)) {
232     if(withTransaction)
233       logDb().rollback();
234     return false;
235   }
236   
237   QSqlQuery deleteBuffersQuery(logDb());
238   deleteBuffersQuery.prepare(queryString("delete_buffers_for_network"));
239   deleteBuffersQuery.bindValue(":networkid", networkId.toInt());
240   deleteBuffersQuery.exec();
241   if(!watchQuery(&deleteBuffersQuery)) {
242     if(withTransaction)
243       logDb().rollback();
244     return false;
245   }
246   
247   QSqlQuery deleteServersQuery(logDb());
248   deleteServersQuery.prepare(queryString("delete_ircservers_for_network"));
249   deleteServersQuery.bindValue(":networkid", networkId.toInt());
250   deleteServersQuery.exec();
251   if(!watchQuery(&deleteServersQuery)) {
252     if(withTransaction)
253       logDb().rollback();
254     return false;
255   }
256   
257   QSqlQuery deleteNetworkQuery(logDb());
258   deleteNetworkQuery.prepare(queryString("delete_network"));
259   deleteNetworkQuery.bindValue(":networkid", networkId.toInt());
260   deleteNetworkQuery.exec();
261   if(!watchQuery(&deleteNetworkQuery)) {
262     if(withTransaction)
263       logDb().rollback();
264     return false;
265   }
266
267   logDb().commit();
268   return true;
269 }
270
271 QList<NetworkInfo> SqliteStorage::networks(UserId user) {
272   QList<NetworkInfo> nets;
273
274   QSqlQuery networksQuery(logDb());
275   networksQuery.prepare(queryString("select_networks_for_user"));
276   networksQuery.bindValue(":userid", user.toInt());
277   
278   QSqlQuery serversQuery(logDb());
279   serversQuery.prepare(queryString("select_servers_for_network"));
280
281   networksQuery.exec();
282   if(!watchQuery(&networksQuery))
283     return nets;
284
285   while(networksQuery.next()) {
286     NetworkInfo net;
287     net.networkId = networksQuery.value(0).toInt();
288     net.networkName = networksQuery.value(1).toString();
289     net.identity = networksQuery.value(2).toInt();
290     net.codecForServer = networksQuery.value(3).toString().toAscii();
291     net.codecForEncoding = networksQuery.value(4).toString().toAscii();
292     net.codecForDecoding = networksQuery.value(5).toString().toAscii();
293     net.useRandomServer = networksQuery.value(6).toInt() == 1 ? true : false;
294     net.perform = networksQuery.value(7).toString().split("\n");
295     net.useAutoIdentify = networksQuery.value(8).toInt() == 1 ? true : false;
296     net.autoIdentifyService = networksQuery.value(9).toString();
297     net.autoIdentifyPassword = networksQuery.value(10).toString();
298     net.useAutoReconnect = networksQuery.value(11).toInt() == 1 ? true : false;
299     net.autoReconnectInterval = networksQuery.value(12).toUInt();
300     net.autoReconnectRetries = networksQuery.value(13).toInt();
301     net.unlimitedReconnectRetries = networksQuery.value(14).toInt() == 1 ? true : false;
302     net.rejoinChannels = networksQuery.value(15).toInt() == 1 ? true : false;
303
304     serversQuery.bindValue(":networkid", net.networkId.toInt());
305     serversQuery.exec();
306     if(!watchQuery(&serversQuery))
307       return nets;
308
309     QVariantList servers;
310     while(serversQuery.next()) {
311       QVariantMap server;
312       server["Host"] = serversQuery.value(0).toString();
313       server["Port"] = serversQuery.value(1).toInt();
314       server["Password"] = serversQuery.value(2).toString();
315       server["UseSSL"] = serversQuery.value(3).toInt() == 1 ? true : false;
316       servers << server;
317     }
318     net.serverList = servers;
319     nets << net;
320   }
321   return nets;
322 }
323
324 bool SqliteStorage::isValidNetwork(UserId user, const NetworkId &networkId) {
325   QSqlQuery query(logDb());
326   query.prepare(queryString("select_networkExists"));
327   query.bindValue(":userid", user.toInt());
328   query.bindValue(":networkid", networkId.toInt());
329   query.exec();
330
331   watchQuery(&query); // there should not occur any errors
332   if(!query.first())
333     return false;
334   
335   Q_ASSERT(!query.next());
336   return true;
337 }
338
339 NetworkId SqliteStorage::getNetworkId(UserId user, const QString &network) {
340   QSqlQuery query(logDb());
341   query.prepare("SELECT networkid FROM network "
342                 "WHERE userid = :userid AND networkname = :networkname");
343   query.bindValue(":userid", user.toInt());
344   query.bindValue(":networkname", network);
345   query.exec();
346   
347   if(query.first())
348     return query.value(0).toInt();
349   else
350     return NetworkId();
351 }
352
353 void SqliteStorage::createBuffer(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer) {
354   QSqlQuery *query = cachedQuery("insert_buffer");
355   query->bindValue(":userid", user.toInt());
356   query->bindValue(":networkid", networkId.toInt());
357   query->bindValue(":buffertype", (int)type);
358   query->bindValue(":buffername", buffer);
359   query->bindValue(":buffercname", buffer.toLower());
360   query->exec();
361
362   watchQuery(query);
363 }
364
365 BufferInfo SqliteStorage::getBufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer) {
366   QSqlQuery *query = cachedQuery("select_bufferByName");
367   query->bindValue(":networkid", networkId.toInt());
368   query->bindValue(":userid", user.toInt());
369   query->bindValue(":buffercname", buffer.toLower());
370   query->exec();
371
372   if(!query->first()) {
373     createBuffer(user, networkId, type, buffer);
374     query->exec();
375     if(!query->first()) {
376       watchQuery(query);
377       qWarning() << "unable to create BufferInfo for:" << user << networkId << buffer;
378       return BufferInfo();
379     }
380   }
381
382   BufferInfo bufferInfo = BufferInfo(query->value(0).toInt(), networkId, (BufferInfo::Type)query->value(1).toInt(), 0, buffer);
383   if(query->next()) {
384     qWarning() << "SqliteStorage::getBufferInfo(): received more then one Buffer!";
385     qWarning() << "         Query:" << query->lastQuery();
386     qWarning() << "  bound Values:" << query->boundValues();
387     Q_ASSERT(false);
388   }
389
390   return bufferInfo;
391 }
392
393 QList<BufferInfo> SqliteStorage::requestBuffers(UserId user, QDateTime since) {
394   uint time = 0;
395   if(since.isValid())
396     time = since.toTime_t();
397   
398   QList<BufferInfo> bufferlist;
399   QSqlQuery query(logDb());
400   query.prepare(queryString("select_buffers"));
401   query.bindValue(":userid", user.toInt());
402   query.bindValue(":time", time);
403   
404   query.exec();
405   watchQuery(&query);
406   while(query.next()) {
407     bufferlist << BufferInfo(query.value(0).toInt(), query.value(1).toInt(), (BufferInfo::Type)query.value(2).toInt(), query.value(3).toInt(), query.value(4).toString());
408   }
409   return bufferlist;
410 }
411
412 void SqliteStorage::setBufferLastSeen(UserId user, const BufferId &bufferId, const QDateTime &seenDate) {
413   QSqlQuery *query = cachedQuery("update_buffer_lastseen");
414   query->bindValue(":userid", user.toInt());
415   query->bindValue(":bufferid", bufferId.toInt());
416   query->bindValue(":lastseen", seenDate.toTime_t());
417   query->exec();
418   watchQuery(query);
419 }
420
421 QHash<BufferId, QDateTime> SqliteStorage::bufferLastSeenDates(UserId user) {
422   QHash<BufferId, QDateTime> lastSeenHash;
423   QSqlQuery query(logDb());
424   query.prepare(queryString("select_buffer_lastseen_dates"));
425   query.bindValue(":userid", user.toInt());
426   query.exec();
427   if(!watchQuery(&query))
428     return lastSeenHash;
429
430   while(query.next()) {
431     lastSeenHash[query.value(0).toInt()] = QDateTime::fromTime_t(query.value(1).toUInt());
432   }
433   return lastSeenHash;
434 }
435
436 MsgId SqliteStorage::logMessage(Message msg) {
437   QSqlQuery *logMessageQuery = cachedQuery("insert_message");
438   logMessageQuery->bindValue(":time", msg.timestamp().toTime_t());
439   logMessageQuery->bindValue(":bufferid", msg.bufferInfo().bufferId().toInt());
440   logMessageQuery->bindValue(":type", msg.type());
441   logMessageQuery->bindValue(":flags", msg.flags());
442   logMessageQuery->bindValue(":sender", msg.sender());
443   logMessageQuery->bindValue(":message", msg.text());
444   logMessageQuery->exec();
445   
446   if(logMessageQuery->lastError().isValid()) {
447     // constraint violation - must be NOT NULL constraint - probably the sender is missing...
448     if(logMessageQuery->lastError().number() == 19) {
449       QSqlQuery *addSenderQuery = cachedQuery("insert_sender");
450       addSenderQuery->bindValue(":sender", msg.sender());
451       addSenderQuery->exec();
452       watchQuery(addSenderQuery);
453       logMessageQuery->exec();
454       if(!watchQuery(logMessageQuery))
455         return 0;
456     } else {
457       watchQuery(logMessageQuery);
458     }
459   }
460
461   QSqlQuery *getLastMessageIdQuery = cachedQuery("select_lastMessage");
462   getLastMessageIdQuery->bindValue(":time", msg.timestamp().toTime_t());
463   getLastMessageIdQuery->bindValue(":bufferid", msg.bufferInfo().bufferId().toInt());
464   getLastMessageIdQuery->bindValue(":type", msg.type());
465   getLastMessageIdQuery->bindValue(":sender", msg.sender());
466   getLastMessageIdQuery->exec();
467
468   if(getLastMessageIdQuery->first()) {
469     return getLastMessageIdQuery->value(0).toInt();
470   } else { // somethin went wrong... :(
471     qDebug() << getLastMessageIdQuery->lastQuery() << "time/bufferid/type/sender:" << msg.timestamp().toTime_t() << msg.bufferInfo().bufferId() << msg.type() << msg.sender();
472     Q_ASSERT(false);
473     return 0;
474   }
475 }
476
477 QList<Message> SqliteStorage::requestMsgs(BufferInfo buffer, int lastmsgs, int offset) {
478   QList<Message> messagelist;
479   // we have to determine the real offset first
480   QSqlQuery *offsetQuery = cachedQuery("select_messagesOffset");
481   offsetQuery->bindValue(":bufferid", buffer.bufferId().toInt());
482   offsetQuery->bindValue(":messageid", offset);
483   offsetQuery->exec();
484   offsetQuery->first();
485   offset = offsetQuery->value(0).toInt();
486
487   // now let's select the messages
488   QSqlQuery *msgQuery = cachedQuery("select_messages");
489   msgQuery->bindValue(":bufferid", buffer.bufferId().toInt());
490   msgQuery->bindValue(":limit", lastmsgs);
491   msgQuery->bindValue(":offset", offset);
492   msgQuery->exec();
493   
494   watchQuery(msgQuery);
495   
496   while(msgQuery->next()) {
497     Message msg(QDateTime::fromTime_t(msgQuery->value(1).toInt()),
498                 buffer,
499                 (Message::Type)msgQuery->value(2).toUInt(),
500                 msgQuery->value(5).toString(),
501                 msgQuery->value(4).toString(),
502                 msgQuery->value(3).toUInt());
503     msg.setMsgId(msgQuery->value(0).toInt());
504     messagelist << msg;
505   }
506   return messagelist;
507 }
508
509
510 QList<Message> SqliteStorage::requestMsgs(BufferInfo buffer, QDateTime since, int offset) {
511   QList<Message> messagelist;
512   // we have to determine the real offset first
513   QSqlQuery *offsetQuery = cachedQuery("select_messagesSinceOffset");
514   offsetQuery->bindValue(":bufferid", buffer.bufferId().toInt());
515   offsetQuery->bindValue(":since", since.toTime_t());
516   offsetQuery->exec();
517   offsetQuery->first();
518   offset = offsetQuery->value(0).toInt();
519
520   // now let's select the messages
521   QSqlQuery *msgQuery = cachedQuery("select_messagesSince");
522   msgQuery->bindValue(":bufferid", buffer.bufferId().toInt());
523   msgQuery->bindValue(":since", since.toTime_t());
524   msgQuery->bindValue(":offset", offset);
525   msgQuery->exec();
526
527   watchQuery(msgQuery);
528   
529   while(msgQuery->next()) {
530     Message msg(QDateTime::fromTime_t(msgQuery->value(1).toInt()),
531                 buffer,
532                 (Message::Type)msgQuery->value(2).toUInt(),
533                 msgQuery->value(5).toString(),
534                 msgQuery->value(4).toString(),
535                 msgQuery->value(3).toUInt());
536     msg.setMsgId(msgQuery->value(0).toInt());
537     messagelist << msg;
538   }
539
540   return messagelist;
541 }
542
543
544 QList<Message> SqliteStorage::requestMsgRange(BufferInfo buffer, int first, int last) {
545   QList<Message> messagelist;
546   QSqlQuery *rangeQuery = cachedQuery("select_messageRange");
547   rangeQuery->bindValue(":bufferid", buffer.bufferId().toInt());
548   rangeQuery->bindValue(":firstmsg", first);
549   rangeQuery->bindValue(":lastmsg", last);
550   rangeQuery->exec();
551
552   watchQuery(rangeQuery);
553   
554   while(rangeQuery->next()) {
555     Message msg(QDateTime::fromTime_t(rangeQuery->value(1).toInt()),
556                 buffer,
557                 (Message::Type)rangeQuery->value(2).toUInt(),
558                 rangeQuery->value(5).toString(),
559                 rangeQuery->value(4).toString(),
560                 rangeQuery->value(3).toUInt());
561     msg.setMsgId(rangeQuery->value(0).toInt());
562     messagelist << msg;
563   }
564
565   return messagelist;
566 }
567
568 QString SqliteStorage::backlogFile() {
569   // kinda ugly, but I currently see no other way to do that
570 #ifdef Q_OS_WIN32
571   QString quasselDir = QDir::homePath() + qgetenv("APPDATA") + "\\quassel\\";
572 #else
573   QString quasselDir = QDir::homePath() + "/.quassel/";
574 #endif
575
576   QDir qDir(quasselDir);
577   if(!qDir.exists(quasselDir))
578     qDir.mkpath(quasselDir);
579   
580   return quasselDir + "quassel-storage.sqlite";  
581 }
582