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