src/core/core.cpp

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