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::createNetworkId(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   }
 156   return networkId;
 157 }
 158
 159 NetworkId SqliteStorage::getNetworkId(UserId user, const QString &network) {
 160   QSqlQuery query(logDb());
 161   query.prepare("SELECT networkid FROM network "
 162                 "WHERE userid = :userid AND networkname = :networkname");
 163   query.bindValue(":userid", user.toInt());
 164   query.bindValue(":networkname", network);
 165   query.exec();
 166
 167   if(query.first())
 168     return query.value(0).toInt();
 169   else
 170     return NetworkId();
 171 }
 172
 173 void SqliteStorage::createBuffer(UserId user, const NetworkId &networkId, const QString &buffer) {
 174   QSqlQuery *query = cachedQuery("insert_buffer");
 175   query->bindValue(":userid", user.toInt());
 176   query->bindValue(":networkid", networkId.toInt());
 177   query->bindValue(":buffername", buffer);
 178   query->exec();
 179
 180   watchQuery(query);
 181 }
 182
 183 BufferInfo SqliteStorage::getBufferInfo(UserId user, const NetworkId &networkId, const QString &buffer) {
 184   QSqlQuery *query = cachedQuery("select_bufferByName");
 185   query->bindValue(":networkid", networkId.toInt());
 186   query->bindValue(":userid", user.toInt());
 187   query->bindValue(":buffername", buffer);
 188   query->exec();
 189
 190   if(!query->first()) {
 191     createBuffer(user, networkId, buffer);
 192     query->exec();
 193     if(!query->first()) {
 194       watchQuery(query);
 195       qWarning() << "unable to create BufferInfo for:" << user << networkId << buffer;
 196       return BufferInfo();
 197     }
 198   }
 199
 200   BufferInfo bufferInfo = BufferInfo(query->value(0).toInt(), networkId, 0, buffer);
 201   if(query->next()) {
 202     qWarning() << "SqliteStorage::getBufferInfo(): received more then one Buffer!";
 203     qWarning() << "         Query:" << query->lastQuery();
 204     qWarning() << "  bound Values:" << query->boundValues();
 205     Q_ASSERT(false);
 206   }
 207
 208   return bufferInfo;
 209 }
 210
 211 QList<BufferInfo> SqliteStorage::requestBuffers(UserId user, QDateTime since) {
 212   uint time = 0;
 213   if(since.isValid())
 214     time = since.toTime_t();
 215
 216   QList<BufferInfo> bufferlist;
 217   QSqlQuery query(logDb());
 218   query.prepare(queryString("select_buffers"));
 219   query.bindValue(":userid", user.toInt());
 220   query.bindValue(":time", time);
 221
 222   query.exec();
 223   watchQuery(&query);
 224   while(query.next()) {
 225     bufferlist << BufferInfo(query.value(0).toInt(), query.value(2).toInt(), 0, query.value(1).toString());
 226   }
 227   return bufferlist;
 228 }
 229
 230 MsgId SqliteStorage::logMessage(Message msg) {
 231   QSqlQuery *logMessageQuery = cachedQuery("insert_message");
 232   logMessageQuery->bindValue(":time", msg.timestamp().toTime_t());
 233   logMessageQuery->bindValue(":bufferid", msg.bufferInfo().bufferId().toInt());
 234   logMessageQuery->bindValue(":type", msg.type());
 235   logMessageQuery->bindValue(":flags", msg.flags());
 236   logMessageQuery->bindValue(":sender", msg.sender());
 237   logMessageQuery->bindValue(":message", msg.text());
 238   logMessageQuery->exec();
 239
 240   if(logMessageQuery->lastError().isValid()) {
 241     // constraint violation - must be NOT NULL constraint - probably the sender is missing...
 242     if(logMessageQuery->lastError().number() == 19) {
 243       QSqlQuery *addSenderQuery = cachedQuery("insert_sender");
 244       addSenderQuery->bindValue(":sender", msg.sender());
 245       addSenderQuery->exec();
 246       watchQuery(addSenderQuery);
 247       logMessageQuery->exec();
 248       if(!watchQuery(logMessageQuery))
 249         return 0;
 250     } else {
 251       watchQuery(logMessageQuery);
 252     }
 253   }
 254
 255   QSqlQuery *getLastMessageIdQuery = cachedQuery("select_lastMessage");
 256   getLastMessageIdQuery->bindValue(":time", msg.timestamp().toTime_t());
 257   getLastMessageIdQuery->bindValue(":bufferid", msg.bufferInfo().bufferId().toInt());
 258   getLastMessageIdQuery->bindValue(":type", msg.type());
 259   getLastMessageIdQuery->bindValue(":sender", msg.sender());
 260   getLastMessageIdQuery->exec();
 261
 262   if(getLastMessageIdQuery->first()) {
 263     return getLastMessageIdQuery->value(0).toInt();
 264   } else { // somethin went wrong... :(
 265     qDebug() << getLastMessageIdQuery->lastQuery() << "time/bufferid/type/sender:" << msg.timestamp().toTime_t() << msg.bufferInfo().bufferId() << msg.type() << msg.sender();
 266     Q_ASSERT(false);
 267     return 0;
 268   }
 269 }
 270
 271 QList<Message> SqliteStorage::requestMsgs(BufferInfo buffer, int lastmsgs, int offset) {
 272   QList<Message> messagelist;
 273   // we have to determine the real offset first
 274   QSqlQuery *offsetQuery = cachedQuery("select_messagesOffset");
 275   offsetQuery->bindValue(":bufferid", buffer.bufferId().toInt());
 276   offsetQuery->bindValue(":messageid", offset);
 277   offsetQuery->exec();
 278   offsetQuery->first();
 279   offset = offsetQuery->value(0).toInt();
 280
 281   // now let's select the messages
 282   QSqlQuery *msgQuery = cachedQuery("select_messages");
 283   msgQuery->bindValue(":bufferid", buffer.bufferId().toInt());
 284   msgQuery->bindValue(":limit", lastmsgs);
 285   msgQuery->bindValue(":offset", offset);
 286   msgQuery->exec();
 287
 288   watchQuery(msgQuery);
 289
 290   while(msgQuery->next()) {
 291     Message msg(QDateTime::fromTime_t(msgQuery->value(1).toInt()),
 292                 buffer,
 293                 (Message::Type)msgQuery->value(2).toUInt(),
 294                 msgQuery->value(5).toString(),
 295                 msgQuery->value(4).toString(),
 296                 msgQuery->value(3).toUInt());
 297     msg.setMsgId(msgQuery->value(0).toInt());
 298     messagelist << msg;
 299   }
 300   return messagelist;
 301 }
 302
 303
 304 QList<Message> SqliteStorage::requestMsgs(BufferInfo buffer, QDateTime since, int offset) {
 305   QList<Message> messagelist;
 306   // we have to determine the real offset first
 307   QSqlQuery *offsetQuery = cachedQuery("select_messagesSinceOffset");
 308   offsetQuery->bindValue(":bufferid", buffer.bufferId().toInt());
 309   offsetQuery->bindValue(":since", since.toTime_t());
 310   offsetQuery->exec();
 311   offsetQuery->first();
 312   offset = offsetQuery->value(0).toInt();
 313
 314   // now let's select the messages
 315   QSqlQuery *msgQuery = cachedQuery("select_messagesSince");
 316   msgQuery->bindValue(":bufferid", buffer.bufferId().toInt());
 317   msgQuery->bindValue(":since", since.toTime_t());
 318   msgQuery->bindValue(":offset", offset);
 319   msgQuery->exec();
 320
 321   watchQuery(msgQuery);
 322
 323   while(msgQuery->next()) {
 324     Message msg(QDateTime::fromTime_t(msgQuery->value(1).toInt()),
 325                 buffer,
 326                 (Message::Type)msgQuery->value(2).toUInt(),
 327                 msgQuery->value(5).toString(),
 328                 msgQuery->value(4).toString(),
 329                 msgQuery->value(3).toUInt());
 330     msg.setMsgId(msgQuery->value(0).toInt());
 331     messagelist << msg;
 332   }
 333
 334   return messagelist;
 335 }
 336
 337
 338 QList<Message> SqliteStorage::requestMsgRange(BufferInfo buffer, int first, int last) {
 339   QList<Message> messagelist;
 340   QSqlQuery *rangeQuery = cachedQuery("select_messageRange");
 341   rangeQuery->bindValue(":bufferid", buffer.bufferId().toInt());
 342   rangeQuery->bindValue(":firstmsg", first);
 343   rangeQuery->bindValue(":lastmsg", last);
 344   rangeQuery->exec();
 345
 346   watchQuery(rangeQuery);
 347
 348   while(rangeQuery->next()) {
 349     Message msg(QDateTime::fromTime_t(rangeQuery->value(1).toInt()),
 350                 buffer,
 351                 (Message::Type)rangeQuery->value(2).toUInt(),
 352                 rangeQuery->value(5).toString(),
 353                 rangeQuery->value(4).toString(),
 354                 rangeQuery->value(3).toUInt());
 355     msg.setMsgId(rangeQuery->value(0).toInt());
 356     messagelist << msg;
 357   }
 358
 359   return messagelist;
 360 }
 361
 362 QString SqliteStorage::backlogFile() {
 363   // kinda ugly, but I currently see no other way to do that
 364 #ifdef Q_OS_WIN32
 365   QString quasselDir = QDir::homePath() + qgetenv("APPDATA") + "\\quassel\\";
 366 #else
 367   QString quasselDir = QDir::homePath() + "/.quassel/";
 368 #endif
 369
 370   QDir qDir(quasselDir);
 371   if(!qDir.exists(quasselDir))
 372     qDir.mkpath(quasselDir);
 373
 374   return quasselDir + "quassel-storage.sqlite";
 375 }
 376