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