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["CoreBuild"] = Global::quasselBuild;
 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   uint build = s.coreState().toMap()["CoreBuild"].toUInt();
 119   if(build < 362) {
 120     qWarning() << qPrintable(tr("Core state too old, ignoring..."));
 121     return;
 122   }
 123   QVariantList activeSessions = s.coreState().toMap()["ActiveSessions"].toList();
 124   if(activeSessions.count() > 0) {
 125     qDebug() << "Restoring previous core state...";
 126     foreach(QVariant v, activeSessions) {
 127       UserId user = v.value<UserId>();
 128       instance()->createSession(user, true);
 129     }
 130   }
 131 }
 132
 133 /*** Core Setup ***/
 134
 135 QString Core::setupCore(const QVariant &setupData_) {
 136   QVariantMap setupData = setupData_.toMap();
 137   QString user = setupData.take("AdminUser").toString();
 138   QString password = setupData.take("AdminPasswd").toString();
 139   if(user.isEmpty() || password.isEmpty()) {
 140     return tr("Admin user or password not set.");
 141   }
 142   if(!initStorage(setupData, true)) {
 143     return tr("Could not setup storage!");
 144   }
 145   CoreSettings s;
 146   s.setStorageSettings(setupData);
 147   qDebug() << qPrintable(tr("Creating admin user..."));
 148   mutex.lock();
 149   storage->addUser(user, password);
 150   mutex.unlock();
 151   startListening();  // TODO check when we need this
 152   return QString();
 153 }
 154
 155 /*** Storage Handling ***/
 156
 157 bool Core::registerStorageBackend(Storage *backend) {
 158   if(backend->isAvailable()) {
 159     _storageBackends[backend->displayName()] = backend;
 160     return true;
 161   } else {
 162     backend->deleteLater();
 163     return false;
 164   }
 165 }
 166
 167 void Core::unregisterStorageBackend(Storage *backend) {
 168   _storageBackends.remove(backend->displayName());
 169   backend->deleteLater();
 170 }
 171
 172 // old db settings:
 173 // "Type" => "sqlite"
 174 bool Core::initStorage(QVariantMap dbSettings, bool setup) {
 175   QString backend = dbSettings["Backend"].toString();
 176   if(backend.isEmpty()) {
 177     //qWarning() << "No storage backend selected!";
 178     return configured = false;
 179   }
 180
 181   if(_storageBackends.contains(backend)) {
 182     storage = _storageBackends[backend];
 183   } else {
 184     qWarning() << "Selected storage backend is not available:" << backend;
 185     return configured = false;
 186   }
 187   if(!storage->init(dbSettings)) {
 188     if(!setup || !(storage->setup(dbSettings) && storage->init(dbSettings))) {
 189       qWarning() << "Could not init storage!";
 190       storage = 0;
 191       return configured = false;
 192     }
 193   }
 194   // delete all other backends
 195   foreach(Storage *s, _storageBackends.values()) {
 196     if(s != storage) s->deleteLater();
 197   }
 198   _storageBackends.clear();
 199
 200   connect(storage, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)), this, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)));
 201   return configured = true;
 202 }
 203
 204 void Core::syncStorage() {
 205   QMutexLocker locker(&mutex);
 206   if(storage) storage->sync();
 207 }
 208
 209 /*** Storage Access ***/
 210 bool Core::createNetwork(UserId user, NetworkInfo &info) {
 211   QMutexLocker locker(&mutex);
 212   NetworkId networkId = instance()->storage->createNetwork(user, info);
 213   if(!networkId.isValid())
 214     return false;
 215
 216   info.networkId = networkId;
 217   return true;
 218 }
 219
 220 bool Core::updateNetwork(UserId user, const NetworkInfo &info) {
 221   QMutexLocker locker(&mutex);
 222   return instance()->storage->updateNetwork(user, info);
 223 }
 224
 225 bool Core::removeNetwork(UserId user, const NetworkId &networkId) {
 226   QMutexLocker locker(&mutex);
 227   return instance()->storage->removeNetwork(user, networkId);
 228 }
 229
 230 QList<NetworkInfo> Core::networks(UserId user) {
 231   QMutexLocker locker(&mutex);
 232   return instance()->storage->networks(user);
 233 }
 234
 235 NetworkId Core::networkId(UserId user, const QString &network) {
 236   QMutexLocker locker(&mutex);
 237   return instance()->storage->getNetworkId(user, network);
 238 }
 239
 240 QList<NetworkId> Core::connectedNetworks(UserId user) {
 241   QMutexLocker locker(&mutex);
 242   return instance()->storage->connectedNetworks(user);
 243 }
 244
 245 void Core::setNetworkConnected(UserId user, const NetworkId &networkId, bool isConnected) {
 246   QMutexLocker locker(&mutex);
 247   return instance()->storage->setNetworkConnected(user, networkId, isConnected);
 248 }
 249
 250 QHash<QString, QString> Core::persistentChannels(UserId user, const NetworkId &networkId) {
 251   QMutexLocker locker(&mutex);
 252   return instance()->storage->persistentChannels(user, networkId);
 253 }
 254
 255 void Core::setChannelPersistent(UserId user, const NetworkId &networkId, const QString &channel, bool isJoined) {
 256   QMutexLocker locker(&mutex);
 257   return instance()->storage->setChannelPersistent(user, networkId, channel, isJoined);
 258 }
 259
 260 void Core::setPersistentChannelKey(UserId user, const NetworkId &networkId, const QString &channel, const QString &key) {
 261   QMutexLocker locker(&mutex);
 262   return instance()->storage->setPersistentChannelKey(user, networkId, channel, key);
 263 }
 264
 265 BufferInfo Core::bufferInfo(UserId user, const NetworkId &networkId, BufferInfo::Type type, const QString &buffer) {
 266   QMutexLocker locker(&mutex);
 267   return instance()->storage->getBufferInfo(user, networkId, type, buffer);
 268 }
 269
 270 BufferInfo Core::getBufferInfo(UserId user, const BufferId &bufferId) {
 271   QMutexLocker locker(&mutex);
 272   return instance()->storage->getBufferInfo(user, bufferId);
 273 }
 274
 275 MsgId Core::storeMessage(const Message &message) {
 276   QMutexLocker locker(&mutex);
 277   return instance()->storage->logMessage(message);
 278 }
 279
 280 QList<Message> Core::requestMsgs(UserId user, BufferId buffer, int lastmsgs, int offset) {
 281   QMutexLocker locker(&mutex);
 282   return instance()->storage->requestMsgs(user, buffer, lastmsgs, offset);
 283 }
 284
 285 QList<Message> Core::requestMsgs(UserId user, BufferId buffer, QDateTime since, int offset) {
 286   QMutexLocker locker(&mutex);
 287   return instance()->storage->requestMsgs(user, buffer, since, offset);
 288 }
 289
 290 QList<Message> Core::requestMsgRange(UserId user, BufferId buffer, int first, int last) {
 291   QMutexLocker locker(&mutex);
 292   return instance()->storage->requestMsgRange(user, buffer, first, last);
 293 }
 294
 295 QList<BufferInfo> Core::requestBuffers(UserId user) {
 296   QMutexLocker locker(&mutex);
 297   return instance()->storage->requestBuffers(user);
 298 }
 299
 300 bool Core::removeBuffer(const UserId &user, const BufferId &bufferId) {
 301   QMutexLocker locker(&mutex);
 302   return instance()->storage->removeBuffer(user, bufferId);
 303 }
 304
 305 BufferId Core::renameBuffer(const UserId &user, const NetworkId &networkId, const QString &newName, const QString &oldName) {
 306   QMutexLocker locker(&mutex);
 307   return instance()->storage->renameBuffer(user, networkId, newName, oldName);
 308 }
 309
 310 void Core::setBufferLastSeenMsg(UserId user, const BufferId &bufferId, const MsgId &msgId) {
 311   QMutexLocker locker(&mutex);
 312   return instance()->storage->setBufferLastSeenMsg(user, bufferId, msgId);
 313 }
 314
 315 QHash<BufferId, MsgId> Core::bufferLastSeenMsgIds(UserId user) {
 316   QMutexLocker locker(&mutex);
 317   return instance()->storage->bufferLastSeenMsgIds(user);
 318 }
 319
 320 /*** Network Management ***/
 321
 322 bool Core::startListening(uint port) {
 323   if(!server.listen(QHostAddress::Any, port)) {
 324     qWarning(qPrintable(QString("Could not open GUI client port %1: %2").arg(port).arg(server.errorString())));
 325     return false;
 326   }
 327   qDebug() << "Listening for GUI clients on port" << server.serverPort();
 328   return true;
 329 }
 330
 331 void Core::stopListening() {
 332   server.close();
 333   qDebug() << "No longer listening for GUI clients.";
 334 }
 335
 336 void Core::incomingConnection() {
 337   while(server.hasPendingConnections()) {
 338     QTcpSocket *socket = server.nextPendingConnection();
 339     connect(socket, SIGNAL(disconnected()), this, SLOT(clientDisconnected()));
 340     connect(socket, SIGNAL(readyRead()), this, SLOT(clientHasData()));
 341     connect(socket, SIGNAL(error(QAbstractSocket::SocketError)), this, SLOT(socketError(QAbstractSocket::SocketError)));
 342
 343     QVariantMap clientInfo;
 344     blocksizes.insert(socket, (quint32)0);
 345     qDebug() << "Client connected from"  << qPrintable(socket->peerAddress().toString());
 346
 347     if (!configured) {
 348       server.close();
 349       qDebug() << "Closing server for basic setup.";
 350     }
 351   }
 352 }
 353
 354 void Core::clientHasData() {
 355   QTcpSocket *socket = dynamic_cast<QTcpSocket*>(sender());
 356   Q_ASSERT(socket && blocksizes.contains(socket));
 357   QVariant item;
 358   while(SignalProxy::readDataFromDevice(socket, blocksizes[socket], item)) {
 359     QVariantMap msg = item.toMap();
 360     processClientMessage(socket, msg);
 361     if(!blocksizes.contains(socket)) break;  // this socket is no longer ours to handle!
 362   }
 363 }
 364
 365 void Core::processClientMessage(QTcpSocket *socket, const QVariantMap &msg) {
 366   if(!msg.contains("MsgType")) {
 367     // Client is way too old, does not even use the current init format
 368     qWarning() << qPrintable(tr("Antique client trying to connect... refusing."));
 369     socket->close();
 370     return;
 371   }
 372   // OK, so we have at least an init message format we can understand
 373   if(msg["MsgType"] == "ClientInit") {
 374     QVariantMap reply;
 375     reply["CoreVersion"] = Global::quasselVersion;
 376     reply["CoreDate"] = Global::quasselDate;
 377     reply["CoreBuild"] = Global::quasselBuild;
 378     // TODO: Make the core info configurable
 379     int uptime = startTime.secsTo(QDateTime::currentDateTime());
 380     int updays = uptime / 86400; uptime %= 86400;
 381     int uphours = uptime / 3600; uptime %= 3600;
 382     int upmins = uptime / 60;
 383     reply["CoreInfo"] = tr("<b>Quassel Core Version %1 (Build &ge; %2)</b><br>"
 384                             "Up %3d%4h%5m (since %6)").arg(Global::quasselVersion).arg(Global::quasselBuild)
 385                             .arg(updays).arg(uphours,2,10,QChar('0')).arg(upmins,2,10,QChar('0')).arg(startTime.toString(Qt::TextDate));
 386
 387 #ifndef QT_NO_OPENSSL
 388     SslServer *sslServer = qobject_cast<SslServer *>(&server);
 389     QSslSocket *sslSocket = qobject_cast<QSslSocket *>(socket);
 390     bool supportSsl = (bool)sslServer && (bool)sslSocket && sslServer->certIsValid();
 391 #else
 392     bool supportSsl = false;
 393 #endif
 394
 395     reply["SupportSsl"] = supportSsl;
 396     // switch to ssl after client has been informed about our capabilities (see below)
 397
 398     reply["LoginEnabled"] = true;
 399
 400     // Just version information -- check it!
 401     if(msg["ClientBuild"].toUInt() < Global::clientBuildNeeded) {
 402       reply["MsgType"] = "ClientInitReject";
 403       reply["Error"] = tr("<b>Your Quassel Client is too old!</b><br>"
 404                           "This core needs at least client version %1 (Build >= %2).<br>"
 405                           "Please consider upgrading your client.").arg(Global::quasselVersion).arg(Global::quasselBuild);
 406       SignalProxy::writeDataToDevice(socket, reply);
 407       qWarning() << qPrintable(tr("Client %1 too old, rejecting.").arg(socket->peerAddress().toString()));
 408       socket->close(); return;
 409     }
 410     // check if we are configured, start wizard otherwise
 411     if(!configured) {
 412       reply["Configured"] = false;
 413       QList<QVariant> backends;
 414       foreach(Storage *backend, _storageBackends.values()) {
 415         QVariantMap v;
 416         v["DisplayName"] = backend->displayName();
 417         v["Description"] = backend->description();
 418         backends.append(v);
 419       }
 420       reply["StorageBackends"] = backends;
 421       reply["LoginEnabled"] = false;
 422     } else {
 423       reply["Configured"] = true;
 424     }
 425     clientInfo[socket] = msg; // store for future reference
 426     reply["MsgType"] = "ClientInitAck";
 427     SignalProxy::writeDataToDevice(socket, reply);
 428
 429 #ifndef QT_NO_OPENSSL
 430     // after we told the client that we are ssl capable we switch to ssl mode
 431     if(supportSsl && msg["UseSsl"].toBool()) {
 432       qDebug() << "Starting TLS for Client:"  << qPrintable(socket->peerAddress().toString());
 433       connect(sslSocket, SIGNAL(sslErrors(const QList<QSslError> &)), this, SLOT(sslErrors(const QList<QSslError> &)));
 434       sslSocket->startServerEncryption();
 435     }
 436 #endif
 437
 438   } else {
 439     // for the rest, we need an initialized connection
 440     if(!clientInfo.contains(socket)) {
 441       QVariantMap reply;
 442       reply["MsgType"] = "ClientLoginReject";
 443       reply["Error"] = tr("<b>Client not initialized!</b><br>You need to send an init message before trying to login.");
 444       SignalProxy::writeDataToDevice(socket, reply);
 445       qWarning() << qPrintable(tr("Client %1 did not send an init message before trying to login, rejecting.").arg(socket->peerAddress().toString()));
 446       socket->close(); return;
 447     }
 448     if(msg["MsgType"] == "CoreSetupData") {
 449       QVariantMap reply;
 450       QString result = setupCore(msg["SetupData"]);
 451       if(!result.isEmpty()) {
 452         reply["MsgType"] = "CoreSetupReject";
 453         reply["Error"] = result;
 454       } else {
 455         reply["MsgType"] = "CoreSetupAck";
 456       }
 457       SignalProxy::writeDataToDevice(socket, reply);
 458     } else if(msg["MsgType"] == "ClientLogin") {
 459       QVariantMap reply;
 460       mutex.lock();
 461       UserId uid = storage->validateUser(msg["User"].toString(), msg["Password"].toString());
 462       mutex.unlock();
 463       if(uid == 0) {
 464         reply["MsgType"] = "ClientLoginReject";
 465         reply["Error"] = tr("<b>Invalid username or password!</b><br>The username/password combination you supplied could not be found in the database.");
 466         SignalProxy::writeDataToDevice(socket, reply);
 467         return;
 468       }
 469       reply["MsgType"] = "ClientLoginAck";
 470       SignalProxy::writeDataToDevice(socket, reply);
 471       qDebug() << qPrintable(tr("Client %1 initialized and authentificated successfully as \"%2\" (UserId: %3).").arg(socket->peerAddress().toString(), msg["User"].toString()).arg(uid.toInt()));
 472       setupClientSession(socket, uid);
 473     }
 474   }
 475 }
 476
 477 // Potentially called during the initialization phase (before handing the connection off to the session)
 478 void Core::clientDisconnected() {
 479   QTcpSocket *socket = dynamic_cast<QTcpSocket*>(sender());  // Note: This might be a QObject* already (if called by ~Core())!
 480   Q_ASSERT(socket);
 481   blocksizes.remove(socket);
 482   clientInfo.remove(socket);
 483   qDebug() << qPrintable(tr("Non-authed client disconnected."));
 484   socket->deleteLater();
 485   socket = 0;
 486
 487   // make server listen again if still not configured
 488   if (!configured) {
 489     startListening();
 490   }
 491
 492   // TODO remove unneeded sessions - if necessary/possible...
 493   // Suggestion: kill sessions if they are not connected to any network and client.
 494 }
 495
 496 void Core::setupClientSession(QTcpSocket *socket, UserId uid) {
 497   // Find or create session for validated user
 498   SessionThread *sess;
 499   if(sessions.contains(uid)) sess = sessions[uid];
 500   else sess = createSession(uid);
 501   // Hand over socket, session then sends state itself
 502   disconnect(socket, 0, this, 0);
 503   blocksizes.remove(socket);
 504   clientInfo.remove(socket);
 505   if(!sess) {
 506     qWarning() << qPrintable(tr("Could not initialize session for client %1!").arg(socket->peerAddress().toString()));
 507     socket->close();
 508   }
 509   sess->addClient(socket);
 510 }
 511
 512 SessionThread *Core::createSession(UserId uid, bool restore) {
 513   if(sessions.contains(uid)) {
 514     qWarning() << "Calling createSession() when a session for the user already exists!";
 515     return 0;
 516   }
 517   SessionThread *sess = new SessionThread(uid, restore, this);
 518   sessions[uid] = sess;
 519   sess->start();
 520   return sess;
 521 }
 522
 523 #ifndef QT_NO_OPENSSL
 524 void Core::sslErrors(const QList<QSslError> &errors) {
 525   Q_UNUSED(errors);
 526   QSslSocket *socket = qobject_cast<QSslSocket *>(sender());
 527   if(socket)
 528     socket->ignoreSslErrors();
 529 }
 530 #endif
 531
 532 void Core::socketError(QAbstractSocket::SocketError err) {
 533   QAbstractSocket *socket = qobject_cast<QAbstractSocket *>(sender());
 534   if(socket && err != QAbstractSocket::RemoteHostClosedError)
 535     qDebug() << "Core::socketError()" << socket << err << socket->errorString();
 536 }