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 Core *Core::instanceptr = 0;
  34 QMutex Core::mutex;
  35
  36 Core *Core::instance() {
  37   if(instanceptr) return instanceptr;
  38   instanceptr = new Core();
  39   instanceptr->init();
  40   return instanceptr;
  41 }
  42
  43 void Core::destroy() {
  44   delete instanceptr;
  45   instanceptr = 0;
  46 }
  47
  48 Core::Core() : storage(0) {
  49   startTime = QDateTime::currentDateTime();  // for uptime :)
  50
  51   // Register storage backends here!
  52   registerStorageBackend(new SqliteStorage(this));
  53
  54   if(!_storageBackends.count()) {
  55     qWarning() << qPrintable(tr("Could not initialize any storage backend! Exiting..."));
  56     exit(1); // TODO make this less brutal (especially for mono client -> popup)
  57   }
  58   connect(&_storageSyncTimer, SIGNAL(timeout()), this, SLOT(syncStorage()));
  59   _storageSyncTimer.start(10 * 60 * 1000); // in msecs
  60 }
  61
  62 void Core::init() {
  63   configured = false;
  64
  65   CoreSettings cs;
  66
  67   if(!(configured = initStorage(cs.storageSettings().toMap()))) {
  68     qWarning("Core is currently not configured!");
  69
  70     // try to migrate old settings
  71     QVariantMap old = cs.oldDbSettings().toMap();
  72     if(old.count() && old["Type"].toString().toUpper() == "SQLITE") {
  73       QVariantMap newSettings;
  74       newSettings["Backend"] = "SQLite";
  75       if((configured = initStorage(newSettings))) {
  76         qWarning("...but thankfully I found some old settings to migrate!");
  77         cs.setStorageSettings(newSettings);
  78       }
  79     }
  80   }
  81
  82   connect(&server, SIGNAL(newConnection()), this, SLOT(incomingConnection()));
  83   if(!startListening(cs.port())) exit(1); // TODO make this less brutal
  84 }
  85
  86 Core::~Core() {
  87   foreach(QTcpSocket *socket, blocksizes.keys()) {
  88     socket->disconnectFromHost();  // disconnect local (i.e. non-authed) clients
  89   }
  90   qDeleteAll(sessions);
  91   qDeleteAll(_storageBackends);
  92 }
  93
  94 /*** Session Restore ***/
  95
  96 void Core::saveState() {
  97   CoreSettings s;
  98   QVariantMap state;
  99   QVariantList activeSessions;
 100   foreach(UserId user, instance()->sessions.keys()) activeSessions << QVariant::fromValue<UserId>(user);
 101   state["CoreBuild"] = Global::quasselBuild;
 102   state["ActiveSessions"] = activeSessions;
 103   s.setCoreState(state);
 104 }
 105
 106 void Core::restoreState() {
 107   if(!instance()->configured) {
 108     qWarning() << qPrintable(tr("Cannot restore a state for an unconfigured core!"));
 109     return;
 110   }
 111   if(instance()->sessions.count()) {
 112     qWarning() << qPrintable(tr("Calling restoreState() even though active sessions exist!"));
 113     return;
 114   }
 115   CoreSettings s;
 116   uint build = s.coreState().toMap()["CoreBuild"].toUInt();
 117   if(build < 362) {
 118     qWarning() << qPrintable(tr("Core state too old, ignoring..."));
 119     return;
 120   }
 121   QVariantList activeSessions = s.coreState().toMap()["ActiveSessions"].toList();
 122   if(activeSessions.count() > 0) {
 123     qDebug() << "Restoring previous core state...";
 124     foreach(QVariant v, activeSessions) {
 125       UserId user = v.value<UserId>();
 126       instance()->createSession(user, true);
 127     }
 128   }
 129 }
 130
 131 /*** Core Setup ***/
 132
 133 QString Core::setupCore(const QVariant &setupData_) {
 134   QVariantMap setupData = setupData_.toMap();
 135   QString user = setupData.take("AdminUser").toString();
 136   QString password = setupData.take("AdminPasswd").toString();
 137   if(user.isEmpty() || password.isEmpty()) {
 138     return tr("Admin user or password not set.");
 139   }
 140   if(!initStorage(setupData, true)) {
 141     return tr("Could not setup storage!");
 142   }
 143   CoreSettings s;
 144   //s.setStorageSettings(msg);
 145   qDebug() << qPrintable(tr("Creating admin user..."));
 146   mutex.lock();
 147   storage->addUser(user, password);
 148   mutex.unlock();
 149   startListening();  // TODO check when we need this
 150   return QString();
 151 }
 152
 153 /*** Storage Handling ***/
 154
 155 bool Core::registerStorageBackend(Storage *backend) {
 156   if(backend->isAvailable()) {
 157     _storageBackends[backend->displayName()] = backend;
 158     return true;
 159   } else {
 160     backend->deleteLater();
 161     return false;
 162   }
 163 }
 164
 165 void Core::unregisterStorageBackend(Storage *backend) {
 166   _storageBackends.remove(backend->displayName());
 167   backend->deleteLater();
 168 }
 169
 170 // old db settings:
 171 // "Type" => "sqlite"
 172 bool Core::initStorage(QVariantMap dbSettings, bool setup) {
 173   QString backend = dbSettings["Backend"].toString();
 174   if(backend.isEmpty()) {
 175     //qWarning() << "No storage backend selected!";
 176     return configured = false;
 177   }
 178
 179   if(_storageBackends.contains(backend)) {
 180     storage = _storageBackends[backend];
 181   } else {
 182     qWarning() << "Selected storage backend is not available:" << backend;
 183     return configured = false;
 184   }
 185   if(!storage->init(dbSettings)) {
 186     if(!setup || !(storage->setup(dbSettings) && storage->init(dbSettings))) {
 187       qWarning() << "Could not init storage!";
 188       storage = 0;
 189       return configured = false;
 190     }
 191   }
 192   // delete all other backends
 193   foreach(Storage *s, _storageBackends.values()) {
 194     if(s != storage) s->deleteLater();
 195   }
 196   _storageBackends.clear();
 197
 198   connect(storage, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)), this, SIGNAL(bufferInfoUpdated(UserId, const BufferInfo &)));
 199   return configured = true;
 200 }
 201
 202 void Core::syncStorage() {
 203   QMutexLocker locker(&mutex);
 204   if(storage) storage->sync();
 205 }
 206
 207 /*** Storage Access ***/
 208 bool Core::createNetwork(UserId user, NetworkInfo &info) {
 209   QMutexLocker locker(&mutex);
 210   NetworkId networkId = instance()->storage->createNetwork(user, info);
 211   if(!networkId.isValid())
 212     return false;
 213
 214   info.networkId = networkId;
 215   return true;
 216 }
 217
 218 bool Core::updateNetwork(UserId user, const NetworkInfo &info) {
 219   QMutexLocker locker(&mutex);
 220   return instance()->storage->updateNetwork(user, info);
 221 }
 222
 223 bool Core::removeNetwork(UserId user, const NetworkId &networkId) {
 224   QMutexLocker locker(&mutex);
 225   return instance()->storage->removeNetwork(user, networkId);
 226 }
 227
 228 QList<NetworkInfo> Core::networks(UserId user) {
 229   QMutexLocker locker(&mutex);
 230   return instance()->storage->networks(user);
 231 }
 232
 233 NetworkId Core::networkId(UserId user, const QString &network) {
 234   QMutexLocker locker(&mutex);
 235   return instance()->storage->getNetworkId(user, network);
 236 }
 237
 238 BufferInfo Core::bufferInfo(UserId user, const NetworkId &networkId, const QString &buffer) {
 239   QMutexLocker locker(&mutex);
 240   return instance()->storage->getBufferInfo(user, networkId, buffer);
 241 }
 242
 243 MsgId Core::storeMessage(const Message &message) {
 244   QMutexLocker locker(&mutex);
 245   return instance()->storage->logMessage(message);
 246 }
 247
 248 QList<Message> Core::requestMsgs(BufferInfo buffer, int lastmsgs, int offset) {
 249   QMutexLocker locker(&mutex);
 250   return instance()->storage->requestMsgs(buffer, lastmsgs, offset);
 251 }
 252
 253 QList<Message> Core::requestMsgs(BufferInfo buffer, QDateTime since, int offset) {
 254   QMutexLocker locker(&mutex);
 255   return instance()->storage->requestMsgs(buffer, since, offset);
 256 }
 257
 258 QList<Message> Core::requestMsgRange(BufferInfo buffer, int first, int last) {
 259   QMutexLocker locker(&mutex);
 260   return instance()->storage->requestMsgRange(buffer, first, last);
 261 }
 262
 263 QList<BufferInfo> Core::requestBuffers(UserId user, QDateTime since) {
 264   QMutexLocker locker(&mutex);
 265   return instance()->storage->requestBuffers(user, since);
 266 }
 267
 268 /*** Network Management ***/
 269
 270 bool Core::startListening(uint port) {
 271   if(!server.listen(QHostAddress::Any, port)) {
 272     qWarning(qPrintable(QString("Could not open GUI client port %1: %2").arg(port).arg(server.errorString())));
 273     return false;
 274   }
 275   qDebug() << "Listening for GUI clients on port" << server.serverPort();
 276   return true;
 277 }
 278
 279 void Core::stopListening() {
 280   server.close();
 281   qDebug() << "No longer listening for GUI clients.";
 282 }
 283
 284 void Core::incomingConnection() {
 285   // TODO implement SSL
 286   while(server.hasPendingConnections()) {
 287     QTcpSocket *socket = server.nextPendingConnection();
 288     connect(socket, SIGNAL(disconnected()), this, SLOT(clientDisconnected()));
 289     connect(socket, SIGNAL(readyRead()), this, SLOT(clientHasData()));
 290     QVariantMap clientInfo;
 291     blocksizes.insert(socket, (quint32)0);
 292     qDebug() << "Client connected from"  << qPrintable(socket->peerAddress().toString());
 293
 294     if (!configured) {
 295       server.close();
 296       qDebug() << "Closing server for basic setup.";
 297     }
 298   }
 299 }
 300
 301 void Core::clientHasData() {
 302   QTcpSocket *socket = dynamic_cast<QTcpSocket*>(sender());
 303   Q_ASSERT(socket && blocksizes.contains(socket));
 304   QVariant item;
 305   while(SignalProxy::readDataFromDevice(socket, blocksizes[socket], item)) {
 306     QVariantMap msg = item.toMap();
 307     processClientMessage(socket, msg);
 308   }
 309 }
 310
 311 void Core::processClientMessage(QTcpSocket *socket, const QVariantMap &msg) {
 312   if(!msg.contains("MsgType")) {
 313     // Client is way too old, does not even use the current init format
 314     qWarning() << qPrintable(tr("Antique client trying to connect... refusing."));
 315     socket->close();
 316     return;
 317   }
 318   // OK, so we have at least an init message format we can understand
 319   if(msg["MsgType"] == "ClientInit") {
 320     QVariantMap reply;
 321     reply["CoreVersion"] = Global::quasselVersion;
 322     reply["CoreDate"] = Global::quasselDate;
 323     reply["CoreBuild"] = Global::quasselBuild;
 324     // TODO: Make the core info configurable
 325     int uptime = startTime.secsTo(QDateTime::currentDateTime());
 326     int updays = uptime / 86400; uptime %= 86400;
 327     int uphours = uptime / 3600; uptime %= 3600;
 328     int upmins = uptime / 60;
 329     reply["CoreInfo"] = tr("<b>Quassel Core Version %1 (Build >= %2)</b><br>"
 330                             "Up %3d%4h%5m (since %6)").arg(Global::quasselVersion).arg(Global::quasselBuild)
 331                             .arg(updays).arg(uphours,2,10,QChar('0')).arg(upmins,2,10,QChar('0')).arg(startTime.toString(Qt::TextDate));
 332
 333     reply["SupportSsl"] = false;
 334     reply["LoginEnabled"] = true;
 335
 336     // Just version information -- check it!
 337     if(msg["ClientBuild"].toUInt() < Global::clientBuildNeeded) {
 338       reply["MsgType"] = "ClientInitReject";
 339       reply["Error"] = tr("<b>Your Quassel Client is too old!</b><br>"
 340                           "This core needs at least client version %1 (Build >= %2).<br>"
 341                           "Please consider upgrading your client.").arg(Global::quasselVersion).arg(Global::quasselBuild);
 342       SignalProxy::writeDataToDevice(socket, reply);
 343       qWarning() << qPrintable(tr("Client %1 too old, rejecting.").arg(socket->peerAddress().toString()));
 344       socket->close(); return;
 345     }
 346     // check if we are configured, start wizard otherwise
 347     if(!configured) {
 348       reply["Configured"] = false;
 349       QList<QVariant> backends;
 350       foreach(Storage *backend, _storageBackends.values()) {
 351         QVariantMap v;
 352         v["DisplayName"] = backend->displayName();
 353         v["Description"] = backend->description();
 354         backends.append(v);
 355       }
 356       reply["StorageBackends"] = backends;
 357       reply["LoginEnabled"] = false;
 358     } else {
 359       reply["Configured"] = true;
 360     }
 361     clientInfo[socket] = msg; // store for future reference
 362     reply["MsgType"] = "ClientInitAck";
 363     SignalProxy::writeDataToDevice(socket, reply);
 364   } else {
 365     // for the rest, we need an initialized connection
 366     if(!clientInfo.contains(socket)) {
 367       QVariantMap reply;
 368       reply["MsgType"] = "ClientLoginReject";
 369       reply["Error"] = tr("<b>Client not initialized!</b><br>You need to send an init message before trying to login.");
 370       SignalProxy::writeDataToDevice(socket, reply);
 371       qWarning() << qPrintable(tr("Client %1 did not send an init message before trying to login, rejecting.").arg(socket->peerAddress().toString()));
 372       socket->close(); return;
 373     }
 374     if(msg["MsgType"] == "CoreSetupData") {
 375       QVariantMap reply;
 376       QString result = setupCore(msg["SetupData"]);
 377       if(!result.isEmpty()) {
 378         reply["MsgType"] = "CoreSetupReject";
 379         reply["Error"] = result;
 380       } else {
 381         reply["MsgType"] = "CoreSetupAck";
 382       }
 383       SignalProxy::writeDataToDevice(socket, reply);
 384     } else if(msg["MsgType"] == "ClientLogin") {
 385       QVariantMap reply;
 386       mutex.lock();
 387       UserId uid = storage->validateUser(msg["User"].toString(), msg["Password"].toString());
 388       mutex.unlock();
 389       if(uid == 0) {
 390         reply["MsgType"] = "ClientLoginReject";
 391         reply["Error"] = tr("<b>Invalid username or password!</b><br>The username/password combination you supplied could not be found in the database.");
 392         SignalProxy::writeDataToDevice(socket, reply);
 393         return;
 394       }
 395       reply["MsgType"] = "ClientLoginAck";
 396       SignalProxy::writeDataToDevice(socket, reply);
 397       qDebug() << qPrintable(tr("Client %1 initialized and authentificated successfully as \"%2\".").arg(socket->peerAddress().toString(), msg["User"].toString()));
 398       setupClientSession(socket, uid);
 399     }
 400   }
 401 }
 402
 403 // Potentially called during the initialization phase (before handing the connection off to the session)
 404 void Core::clientDisconnected() {
 405   QTcpSocket *socket = dynamic_cast<QTcpSocket*>(sender());  // Note: This might be a QObject* already (if called by ~Core())!
 406   Q_ASSERT(socket);
 407   blocksizes.remove(socket);
 408   clientInfo.remove(socket);
 409   qDebug() << qPrintable(tr("Non-authed client disconnected."));
 410   socket->deleteLater();
 411   socket = 0;
 412
 413   // make server listen again if still not configured
 414   if (!configured) {
 415     startListening();
 416   }
 417
 418   // TODO remove unneeded sessions - if necessary/possible...
 419   // Suggestion: kill sessions if they are not connected to any network and client.
 420 }
 421
 422 void Core::setupClientSession(QTcpSocket *socket, UserId uid) {
 423   // Find or create session for validated user
 424   SessionThread *sess;
 425   if(sessions.contains(uid)) sess = sessions[uid];
 426   else sess = createSession(uid);
 427   // Hand over socket, session then sends state itself
 428   disconnect(socket, 0, this, 0);
 429   blocksizes.remove(socket);
 430   clientInfo.remove(socket);
 431   if(!sess) {
 432     qWarning() << qPrintable(tr("Could not initialize session for client %1!").arg(socket->peerAddress().toString()));
 433     socket->close();
 434   }
 435   sess->addClient(socket);
 436 }
 437
 438 SessionThread *Core::createSession(UserId uid, bool restore) {
 439   if(sessions.contains(uid)) {
 440     qWarning() << "Calling createSession() when a session for the user already exists!";
 441     return 0;
 442   }
 443   SessionThread *sess = new SessionThread(uid, restore, this);
 444   sessions[uid] = sess;
 445   sess->start();
 446   return sess;
 447 }