src/core/core.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 by the Quassel Project                          *
   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 <QMetaObject>
  22 #include <QMetaMethod>
  23 #include <QMutexLocker>
  24 #include <QCoreApplication>
  25
  26 #include "core.h"
  27 #include "coresession.h"
  28 #include "coresettings.h"
  29 #include "signalproxy.h"
  30 #include "sqlitestorage.h"
  31 #include "network.h"
  32
  33 #include "util.h"
  34
  35 Core *Core::instanceptr = 0;
  36 QMutex Core::mutex;
  37
  38 Core *Core::instance() {
  39   if(instanceptr) return instanceptr;
  40   instanceptr = new Core();
  41   instanceptr->init();
  42   return instanceptr;
  43 }
  44
  45 void Core::destroy() {
  46   delete instanceptr;
  47   instanceptr = 0;
  48 }
  49
  50 Core::Core() : storage(0) {
  51   startTime = QDateTime::currentDateTime();  // for uptime :)
  52
  53   // Register storage backends here!
  54   registerStorageBackend(new SqliteStorage(this));
  55
  56   if(!_storageBackends.count()) {
  57     qWarning() << qPrintable(tr("Could not initialize any storage backend! Exiting..."));
  58     exit(1); // TODO make this less brutal (especially for mono client -> popup)
  59   }
  60   connect(&_storageSyncTimer, SIGNAL(timeout()), this, SLOT(syncStorage()));
  61   _storageSyncTimer.start(10 * 60 * 1000); // in msecs
  62 }
  63
  64 void Core::init() {
  65   configured = false;
  66
  67   CoreSettings cs;
  68
  69   if(!(configured = initStorage(cs.storageSettings().toMap()))) {
  70     qWarning("Core is currently not configured! Please connect with a Quassel Client for basic setup.");
  71
  72     // try to migrate old settings
  73     QVariantMap old = cs.oldDbSettings().toMap();
  74     if(old.count() && old["Type"].toString().toUpper() == "SQLITE") {
  75       QVariantMap newSettings;
  76       newSettings["Backend"] = "SQLite";
  77       if((configured = initStorage(newSettings))) {
  78         qWarning("...but thankfully I found some old settings to migrate!");
  79         cs.setStorageSettings(newSettings);
  80       }
  81     }
  82   }
  83
  84   connect(&server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
  85   if(!startListening(cs.port())) exit(1); // TODO make this less brutal
  86 }
  87
  88 Core::~Core() {
  89   foreach(QTcpSocket *socket, blocksizes.keys()) { qDebug() << "disconnecting" << socket << blocksizes.keys();
  90     socket->disconnectFromHost();  // disconnect local (i.e. non-authed) clients
  91   }
  92   qDeleteAll(sessions);
  93   qDeleteAll(_storageBackends);
  94 }
  95
  96 /*** Session Restore ***/
  97
  98 void Core::saveState() {
  99   CoreSettings s;
 100   QVariantMap state;
 101   QVariantList activeSessions;
 102   foreach(UserId user, instance()->sessions.keys()) activeSessions << QVariant::fromValue<UserId>(user);
 103   state["CoreStateVersion"] = 1;
 104   state["ActiveSessions"] = activeSessions;
 105   s.setCoreState(state);
 106 }
 107
 108 void Core::restoreState() {
 109   if(!instance()->configured) {
 110     // qWarning() << qPrintable(tr("Cannot restore a state for an unconfigured core!"));
 111     return;
 112   }
 113   if(instance()->sessions.count()) {
 114     qWarning() << qPrintable(tr("Calling restoreState() even though active sessions exist!"));
 115     return;
 116   }
 117   CoreSettings s;
 118   /* We don't check, since we are at the first version since switching to Git
 119   uint statever = s.coreState().toMap()["CoreStateVersion"].toUInt();
 120   if(statever < 1) {
 121     qWarning() << qPrintable(tr("Core state too old, ignoring..."));
 122     return;
 123   }
 124   */
 125   QVariantList activeSessions = s.coreState().toMap()["ActiveSessions"].toList();
 126   if(activeSessions.count() > 0) {
 127     qDebug() << "Restoring previous core state...";
 128     foreach(QVariant v, activeSessions) {
 129       UserId user = v.value<UserId>();
 130       instance()->createSession(user, true);
 131     }
 132   }
 133 }
 134
 135 /*** Core Setup ***/
 136
 137 QString Core::setupCore(const QVariant &setupData_) {
 138   QVariantMap setupData = setupData_.toMap();
 139   QString user = setupData.take("AdminUser").toString();
 140   QString password = setupData.take("AdminPasswd").toString();
 141   if(user.isEmpty() || password.isEmpty()) {
 142     return tr("Admin user or password not set.");
 143   }
 144   if(!initStorage(setupData, true)) {
 145     return tr("Could not setup storage!");
 146   }
 147   CoreSettings s;
 148   s.setStorageSettings(setupData);
 149   qDebug() << qPrintable(tr("Creating admin user..."));
 150   mutex.lock();
 151   storage->addUser(user, password);
 152   mutex.unlock();
 153   startListening();  // TODO check when we need this
 154   return QString();
 155 }
 156
 157 /*** Storage Handling ***/
 158
 159 bool Core::registerStorageBackend(Storage *backend) {
 160   if(backend->isAvailable()) {
 161     _storageBackends[backend->displayName()] = backend;
 162     return true;
 163   } else {
 164     backend->deleteLater();
 165     return false;
 166   }
 167 }
 168
 169 void Core::unregisterStorageBackend(Storage *backend) {
 170   _storageBackends.remove(backend->displayName());
 171   backend->deleteLater();
 172 }
 173
 174 // old db settings:
 175 // "Type" => "sqlite"
 176 bool Core::initStorage(QVariantMap dbSettings, bool setup) {
 177   QString backend = dbSettings["Backend"].toString();
 178   if(backend.isEmpty()) {
 179     //qWarning() << "No storage backend selected!";
 180     return configured = false;
 181   }
 182
 183   if(_storageBackends.contains(backend)) {
 184     storage = _storageBackends[backend];
 185   } else {
 186     qWarning() << "Selected storage backend is not available:" << backend;
 187     return configured = false;
 188   }
 189   if(!storage->init(dbSettings)) {
 190     if(!setup || !(storage->setup(dbSettings) && storage->init(dbSettings))) {
 191       qWarning() << "Could not init storage!";
 192       storage = 0;
 193       return configured = false;
 194     }
 195   }
 196   // delete all other backends
 197   foreach(Storage *s, _storageBackends.values()) {
 198     if(s != storage) s->deleteLater();
 199   }
 200   _storageBackends.clear();
 201
 202   connect(storage, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)), this, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)));
 203   return configured = true;
 204 }
 205
 206 void Core::syncStorage() {
 207   QMutexLocker locker(&mutex);
 208   if(storage) storage->sync();
 209 }
 210
 211 /*** Storage Access ***/
 212 void Core::setUserSetting(UserId userId, const QString &settingName, const QVariant &data) {
 213   QMutexLocker locker(&mutex);
 214   instance()->storage->setUserSetting(userId, settingName, data);
 215 }
 216
 217 QVariant Core::getUserSetting(UserId userId, const QString &settingName, const QVariant &data) {
 218   QMutexLocker locker(&mutex);
 219   return instance()->storage->getUserSetting(userId, settingName, data);
 220 }
 221
 222 bool Core::createNetwork(UserId user, NetworkInfo &info) {
 223   QMutexLocker locker(&mutex);
 224   NetworkId networkId = instance()->storage->createNetwork(user, info);
 225   if(!networkId.isValid())
 226     return false;
 227
 228   info.networkId = networkId;
 229   return true;
 230 }
 231
 232 bool Core::updateNetwork(UserId user, const NetworkInfo &info) {
 233   QMutexLocker locker(&mutex);
 234   return instance()->storage->updateNetwork(user, info);
 235 }
 236
 237 bool Core::removeNetwork(UserId user, const NetworkId &networkId) {
 238   QMutexLocker locker(&mutex);
 239   return instance()->storage->removeNetwork(user, networkId);
 240 }
 241
 242 QList<NetworkInfo> Core::networks(UserId user) {
 243   QMutexLocker locker(&mutex);
 244   return instance()->storage->networks(user);
 245 }
 246
 247 NetworkId Core::networkId(UserId user, const QString &network) {
 248   QMutexLocker locker(&mutex);
 249   return instance()->storage->getNetworkId(user, network);
 250 }
 251
 252 QList<NetworkId> Core::connectedNetworks(UserId user) {
 253   QMutexLocker locker(&mutex);
 254   return instance()->storage->connectedNetworks(user);
 255 }
 256
 257 void Core::setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected) {
 258   QMutexLocker locker(&mutex);
 259   return instance()->storage->setNetworkConnected(user, networkId, isConnected);
 260 }
 261
 262 QHash<QString, QString> Core::persistentChannels(UserId user, const NetworkId &networkId) {
 263   QMutexLocker locker(&mutex);
 264   return instance()->storage->persistentChannels(user, networkId);
 265 }
 266
 267 void Core::setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined) {
 268   QMutexLocker locker(&mutex);
 269   return instance()->storage->setChannelPersistent(user, networkId, channel, isJoined);
 270 }
 271
 272 void Core::setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key) {
 273   QMutexLocker locker(&mutex);
 274   return instance()->storage->setPersistentChannelKey(user, networkId, channel, key);
 275 }
 276
 277 BufferInfo Core::bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer) {
 278   QMutexLocker locker(&mutex);
 279   return instance()->storage->getBufferInfo(user, networkId, type, buffer);
 280 }
 281
 282 BufferInfo Core::getBufferInfo(UserId user, const BufferId &bufferId) {
 283   QMutexLocker locker(&mutex);
 284   return instance()->storage->getBufferInfo(user, bufferId);
 285 }
 286
 287 MsgId Core::storeMessage(const Message &message) {
 288   QMutexLocker locker(&mutex);
 289   return instance()->storage->logMessage(message);
 290 }
 291
 292 QList<Message> Core::requestMsgs(UserId user, BufferId buffer, int lastmsgs, int offset) {
 293   QMutexLocker locker(&mutex);
 294   return instance()->storage->requestMsgs(user, buffer, lastmsgs, offset);
 295 }
 296
 297 QList<Message> Core::requestMsgs(UserId user, BufferId buffer, QDateTime since, int offset) {
 298   QMutexLocker locker(&mutex);
 299   return instance()->storage->requestMsgs(user, buffer, since, offset);
 300 }
 301
 302 QList<Message> Core::requestMsgRange(UserId user, BufferId buffer, int first, int last) {
 303   QMutexLocker locker(&mutex);
 304   return instance()->storage->requestMsgRange(user, buffer, first, last);
 305 }
 306
 307 QList<BufferInfo> Core::requestBuffers(UserId user) {
 308   QMutexLocker locker(&mutex);
 309   return instance()->storage->requestBuffers(user);
 310 }
 311
 312 bool Core::removeBuffer(const UserId &user, const BufferId &bufferId) {
 313   QMutexLocker locker(&mutex);
 314   return instance()->storage->removeBuffer(user, bufferId);
 315 }
 316
 317 BufferId Core::renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName) {
 318   QMutexLocker locker(&mutex);
 319   return instance()->storage->renameBuffer(user, networkId, newName, oldName);
 320 }
 321
 322 void Core::setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) {
 323   QMutexLocker locker(&mutex);
 324   return instance()->storage->setBufferLastSeenMsg(user, bufferId, msgId);
 325 }
 326
 327 QHash<BufferId, MsgId> Core::bufferLastSeenMsgIds(UserId user) {
 328   QMutexLocker locker(&mutex);
 329   return instance()->storage->bufferLastSeenMsgIds(user);
 330 }
 331
 332 /*** Network Management ***/
 333
 334 bool Core::startListening(uint port) {
 335   if(!server.listen(QHostAddress::Any, port)) {
 336     qWarning(qPrintable(QString("Could not open GUI client port %1: %2").arg(port).arg(server.errorString())));
 337     return false;
 338   }
 339   qDebug() << "Listening for GUI clients on port" << server.serverPort();
 340   return true;
 341 }
 342
 343 void Core::stopListening() {
 344   server.close();
 345   qDebug() << "No longer listening for GUI clients.";
 346 }
 347
 348 void Core::incomingConnection() {
 349   while(server.hasPendingConnections()) {
 350     QTcpSocket *socket = server.nextPendingConnection();
 351     connect(socket, SIGNAL(disconnected()), this, SLOT(clientDisconnected()));
 352     connect(socket, SIGNAL(readyRead()), this, SLOT(clientHasData()));
 353     connect(socket, SIGNAL(error(QAbstractSocket::SocketError)), this, SLOT(socketError(QAbstractSocket::SocketError)));
 354
 355     QVariantMap clientInfo;
 356     blocksizes.insert(socket, (quint32)0);
 357     qDebug() << "Client connected from"  << qPrintable(socket->peerAddress().toString());
 358
 359     if (!configured) {
 360       server.close();
 361       qDebug() << "Closing server for basic setup.";
 362     }
 363   }
 364 }
 365
 366 void Core::clientHasData() {
 367   QTcpSocket *socket = dynamic_cast<QTcpSocket*>(sender());
 368   Q_ASSERT(socket && blocksizes.contains(socket));
 369   QVariant item;
 370   while(SignalProxy::readDataFromDevice(socket, blocksizes[socket], item)) {
 371     QVariantMap msg = item.toMap();
 372     processClientMessage(socket, msg);
 373     if(!blocksizes.contains(socket)) break;  // this socket is no longer ours to handle!
 374   }
 375 }
 376
 377 void Core::processClientMessage(QTcpSocket *socket, const QVariantMap &msg) {
 378   if(!msg.contains("MsgType")) {
 379     // Client is way too old, does not even use the current init format
 380     qWarning() << qPrintable(tr("Antique client trying to connect... refusing."));
 381     socket->close();
 382     return;
 383   }
 384   // OK, so we have at least an init message format we can understand
 385   if(msg["MsgType"] == "ClientInit") {
 386     QVariantMap reply;
 387
 388     // Just version information -- check it!
 389     if((msg.contains("ClientBuild") && msg["ClientBuild"].toUInt() < 732)
 390        || (!msg.contains("ClientBuild") && msg["ProtocolVersion"].toUInt() < Global::coreNeedsProtocol)) {
 391       reply["MsgType"] = "ClientInitReject";
 392       reply["Error"] = tr("<b>Your Quassel Client is too old!</b><br>"
 393       "This core needs at least client/core protocol version %1.<br>"
 394       "Please consider upgrading your client.").arg(Global::coreNeedsProtocol);
 395       SignalProxy::writeDataToDevice(socket, reply);
 396       qWarning() << qPrintable(tr("Client %1 too old, rejecting.").arg(socket->peerAddress().toString()));
 397       socket->close(); return;
 398     }
 399
 400     reply["CoreVersion"] = Global::quasselVersion;
 401     reply["CoreDate"] = Global::quasselBuildDate;
 402     reply["CoreBuild"] = 860; // FIXME legacy
 403     reply["ProtocolVersion"] = Global::protocolVersion;
 404     // TODO: Make the core info configurable
 405     int uptime = startTime.secsTo(QDateTime::currentDateTime());
 406     int updays = uptime / 86400; uptime %= 86400;
 407     int uphours = uptime / 3600; uptime %= 3600;
 408     int upmins = uptime / 60;
 409     reply["CoreInfo"] = tr("<b>Quassel Core Version %1</b><br>"
 410                             "Built: %2<br>"
 411                             "Up %3d%4h%5m (since %6)").arg(Global::quasselVersion).arg(Global::quasselBuildDate)
 412                             .arg(updays).arg(uphours,2,10,QChar('0')).arg(upmins,2,10,QChar('0')).arg(startTime.toString(Qt::TextDate));
 413
 414 #ifndef QT_NO_OPENSSL
 415     SslServer *sslServer = qobject_cast<SslServer *>(&server);
 416     QSslSocket *sslSocket = qobject_cast<QSslSocket *>(socket);
 417     bool supportSsl = (bool)sslServer && (bool)sslSocket && sslServer->certIsValid();
 418 #else
 419     bool supportSsl = false;
 420 #endif
 421
 422 #ifndef QT_NO_COMPRESS
 423     bool supportsCompression = true;
 424 #else
 425     bool supportsCompression = false;
 426 #endif
 427
 428     reply["SupportSsl"] = supportSsl;
 429     reply["SupportsCompression"] = supportsCompression;
 430     // switch to ssl/compression after client has been informed about our capabilities (see below)
 431
 432     reply["LoginEnabled"] = true;
 433
 434     // check if we are configured, start wizard otherwise
 435     if(!configured) {
 436       reply["Configured"] = false;
 437       QList<QVariant> backends;
 438       foreach(Storage *backend, _storageBackends.values()) {
 439         QVariantMap v;
 440         v["DisplayName"] = backend->displayName();
 441         v["Description"] = backend->description();
 442         backends.append(v);
 443       }
 444       reply["StorageBackends"] = backends;
 445       reply["LoginEnabled"] = false;
 446     } else {
 447       reply["Configured"] = true;
 448     }
 449     clientInfo[socket] = msg; // store for future reference
 450     reply["MsgType"] = "ClientInitAck";
 451     SignalProxy::writeDataToDevice(socket, reply);
 452
 453 #ifndef QT_NO_OPENSSL
 454     // after we told the client that we are ssl capable we switch to ssl mode
 455     if(supportSsl && msg["UseSsl"].toBool()) {
 456       qDebug() << "Starting TLS for Client:" << qPrintable(socket->peerAddress().toString());
 457       connect(sslSocket, SIGNAL(sslErrors(const QList<QSslError> &)), this, SLOT(sslErrors(const QList<QSslError> &)));
 458       sslSocket->startServerEncryption();
 459     }
 460 #endif
 461
 462 #ifndef QT_NO_COMPRESS
 463     if(supportsCompression && msg["UseCompression"].toBool()) {
 464       socket->setProperty("UseCompression", true);
 465       qDebug() << "Using compression for Client:" << qPrintable(socket->peerAddress().toString());
 466     }
 467 #endif
 468
 469   } else {
 470     // for the rest, we need an initialized connection
 471     if(!clientInfo.contains(socket)) {
 472       QVariantMap reply;
 473       reply["MsgType"] = "ClientLoginReject";
 474       reply["Error"] = tr("<b>Client not initialized!</b><br>You need to send an init message before trying to login.");
 475       SignalProxy::writeDataToDevice(socket, reply);
 476       qWarning() << qPrintable(tr("Client %1 did not send an init message before trying to login, rejecting.").arg(socket->peerAddress().toString()));
 477       socket->close(); return;
 478     }
 479     if(msg["MsgType"] == "CoreSetupData") {
 480       QVariantMap reply;
 481       QString result = setupCore(msg["SetupData"]);
 482       if(!result.isEmpty()) {
 483         reply["MsgType"] = "CoreSetupReject";
 484         reply["Error"] = result;
 485       } else {
 486         reply["MsgType"] = "CoreSetupAck";
 487       }
 488       SignalProxy::writeDataToDevice(socket, reply);
 489     } else if(msg["MsgType"] == "ClientLogin") {
 490       QVariantMap reply;
 491       mutex.lock();
 492       UserId uid = storage->validateUser(msg["User"].toString(), msg["Password"].toString());
 493       mutex.unlock();
 494       if(uid == 0) {
 495         reply["MsgType"] = "ClientLoginReject";
 496         reply["Error"] = tr("<b>Invalid username or password!</b><br>The username/password combination you supplied could not be found in the database.");
 497         SignalProxy::writeDataToDevice(socket, reply);
 498         return;
 499       }
 500       reply["MsgType"] = "ClientLoginAck";
 501       SignalProxy::writeDataToDevice(socket, reply);
 502       qDebug() << qPrintable(tr("Client %1 initialized and authenticated successfully as \"%2\" (UserId: %3).").arg(socket->peerAddress().toString(), msg["User"].toString()).arg(uid.toInt()));
 503       setupClientSession(socket, uid);
 504     }
 505   }
 506 }
 507
 508 // Potentially called during the initialization phase (before handing the connection off to the session)
 509 void Core::clientDisconnected() {
 510   QTcpSocket *socket = dynamic_cast<QTcpSocket*>(sender());  // Note: This might be a QObject* already (if called by ~Core())!
 511   Q_ASSERT(socket);
 512   blocksizes.remove(socket);
 513   clientInfo.remove(socket);
 514   qDebug() << qPrintable(tr("Non-authed client disconnected."));
 515   socket->deleteLater();
 516   socket = 0;
 517
 518   // make server listen again if still not configured
 519   if (!configured) {
 520     startListening();
 521   }
 522
 523   // TODO remove unneeded sessions - if necessary/possible...
 524   // Suggestion: kill sessions if they are not connected to any network and client.
 525 }
 526
 527 void Core::setupClientSession(QTcpSocket *socket, UserId uid) {
 528   // Find or create session for validated user
 529   SessionThread *sess;
 530   if(sessions.contains(uid)) sess = sessions[uid];
 531   else sess = createSession(uid);
 532   // Hand over socket, session then sends state itself
 533   disconnect(socket, 0, this, 0);
 534   blocksizes.remove(socket);
 535   clientInfo.remove(socket);
 536   if(!sess) {
 537     qWarning() << qPrintable(tr("Could not initialize session for client %1!").arg(socket->peerAddress().toString()));
 538     socket->close();
 539   }
 540   sess->addClient(socket);
 541 }
 542
 543 SessionThread *Core::createSession(UserId uid, bool restore) {
 544   if(sessions.contains(uid)) {
 545     qWarning() << "Calling createSession() when a session for the user already exists!";
 546     return 0;
 547   }
 548   SessionThread *sess = new SessionThread(uid, restore, this);
 549   sessions[uid] = sess;
 550   sess->start();
 551   return sess;
 552 }
 553
 554 #ifndef QT_NO_OPENSSL
 555 void Core::sslErrors(const QList<QSslError> &errors) {
 556   Q_UNUSED(errors);
 557   QSslSocket *socket = qobject_cast<QSslSocket *>(sender());
 558   if(socket)
 559     socket->ignoreSslErrors();
 560 }
 561 #endif
 562
 563 void Core::socketError(QAbstractSocket::SocketError err) {
 564   QAbstractSocket *socket = qobject_cast<QAbstractSocket *>(sender());
 565   if(socket && err != QAbstractSocket::RemoteHostClosedError)
 566     qDebug() << "Core::socketError()" << socket << err << socket->errorString();
 567 }