src/core/coresession.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 "coresession.h"
  22
  23 #include <QtScript>
  24
  25 #include "core.h"
  26 #include "coreuserinputhandler.h"
  27 #include "corebuffersyncer.h"
  28 #include "corebacklogmanager.h"
  29 #include "corebufferviewmanager.h"
  30 #include "coreidentity.h"
  31 #include "coreignorelistmanager.h"
  32 #include "coreirclisthelper.h"
  33 #include "corenetwork.h"
  34 #include "corenetworkconfig.h"
  35 #include "coresessioneventprocessor.h"
  36 #include "coreusersettings.h"
  37 #include "eventmanager.h"
  38 #include "ircchannel.h"
  39 #include "ircparser.h"
  40 #include "ircuser.h"
  41 #include "logger.h"
  42 #include "messageevent.h"
  43 #include "signalproxy.h"
  44 #include "storage.h"
  45 #include "util.h"
  46
  47 class ProcessMessagesEvent : public QEvent {
  48 public:
  49   ProcessMessagesEvent() : QEvent(QEvent::User) {}
  50 };
  51
  52 CoreSession::CoreSession(UserId uid, bool restoreState, QObject *parent)
  53   : QObject(parent),
  54     _user(uid),
  55     _signalProxy(new SignalProxy(SignalProxy::Server, 0, this)),
  56     _aliasManager(this),
  57     _bufferSyncer(new CoreBufferSyncer(this)),
  58     _backlogManager(new CoreBacklogManager(this)),
  59     _bufferViewManager(new CoreBufferViewManager(_signalProxy, this)),
  60     _ircListHelper(new CoreIrcListHelper(this)),
  61     _networkConfig(new CoreNetworkConfig("GlobalNetworkConfig", this)),
  62     _coreInfo(this),
  63     _eventManager(new EventManager(this)),
  64     _eventProcessor(new CoreSessionEventProcessor(this)),
  65     _ircParser(new IrcParser(this)),
  66     scriptEngine(new QScriptEngine(this)),
  67     _processMessages(false),
  68     _ignoreListManager(this)
  69 {
  70   SignalProxy *p = signalProxy();
  71   p->setHeartBeatInterval(30);
  72   p->setMaxHeartBeatCount(60); // 30 mins until we throw a dead socket out
  73
  74   connect(p, SIGNAL(peerRemoved(QIODevice *)), this, SLOT(removeClient(QIODevice *)));
  75
  76   connect(p, SIGNAL(connected()), this, SLOT(clientsConnected()));
  77   connect(p, SIGNAL(disconnected()), this, SLOT(clientsDisconnected()));
  78
  79   p->attachSlot(SIGNAL(sendInput(BufferInfo, QString)), this, SLOT(msgFromClient(BufferInfo, QString)));
  80   p->attachSignal(this, SIGNAL(displayMsg(Message)));
  81   p->attachSignal(this, SIGNAL(displayStatusMsg(QString, QString)));
  82
  83   p->attachSignal(this, SIGNAL(identityCreated(const Identity &)));
  84   p->attachSignal(this, SIGNAL(identityRemoved(IdentityId)));
  85   p->attachSlot(SIGNAL(createIdentity(const Identity &, const QVariantMap &)), this, SLOT(createIdentity(const Identity &, const QVariantMap &)));
  86   p->attachSlot(SIGNAL(removeIdentity(IdentityId)), this, SLOT(removeIdentity(IdentityId)));
  87
  88   p->attachSignal(this, SIGNAL(networkCreated(NetworkId)));
  89   p->attachSignal(this, SIGNAL(networkRemoved(NetworkId)));
  90   p->attachSlot(SIGNAL(createNetwork(const NetworkInfo &, const QStringList &)), this, SLOT(createNetwork(const NetworkInfo &, const QStringList &)));
  91   p->attachSlot(SIGNAL(removeNetwork(NetworkId)), this, SLOT(removeNetwork(NetworkId)));
  92
  93   loadSettings();
  94   initScriptEngine();
  95
  96   eventManager()->registerObject(ircParser(), EventManager::NormalPriority, "process");
  97   eventManager()->registerObject(eventProcessor(), EventManager::HighPriority, "process");
  98   eventManager()->registerObject(this, EventManager::LowPriority, "process"); // for sending MessageEvents to the client
  99
 100   // periodically save our session state
 101   connect(&(Core::instance()->syncTimer()), SIGNAL(timeout()), this, SLOT(saveSessionState()));
 102
 103   p->synchronize(_bufferSyncer);
 104   p->synchronize(&aliasManager());
 105   p->synchronize(_backlogManager);
 106   p->synchronize(ircListHelper());
 107   p->synchronize(networkConfig());
 108   p->synchronize(&_coreInfo);
 109   p->synchronize(&_ignoreListManager);
 110   // Restore session state
 111   if(restoreState)
 112     restoreSessionState();
 113
 114   emit initialized();
 115 }
 116
 117 CoreSession::~CoreSession() {
 118   saveSessionState();
 119   foreach(CoreNetwork *net, _networks.values()) {
 120     delete net;
 121   }
 122 }
 123
 124 CoreNetwork *CoreSession::network(NetworkId id) const {
 125   if(_networks.contains(id)) return _networks[id];
 126   return 0;
 127 }
 128
 129 CoreIdentity *CoreSession::identity(IdentityId id) const {
 130   if(_identities.contains(id)) return _identities[id];
 131   return 0;
 132 }
 133
 134 void CoreSession::loadSettings() {
 135   CoreUserSettings s(user());
 136
 137   // migrate to db
 138   QList<IdentityId> ids = s.identityIds();
 139   QList<NetworkInfo> networkInfos = Core::networks(user());
 140   foreach(IdentityId id, ids) {
 141     CoreIdentity identity(s.identity(id));
 142     IdentityId newId = Core::createIdentity(user(), identity);
 143     QList<NetworkInfo>::iterator networkIter = networkInfos.begin();
 144     while(networkIter != networkInfos.end()) {
 145       if(networkIter->identity == id) {
 146         networkIter->identity = newId;
 147         Core::updateNetwork(user(), *networkIter);
 148         networkIter = networkInfos.erase(networkIter);
 149       } else {
 150         networkIter++;
 151       }
 152     }
 153     s.removeIdentity(id);
 154   }
 155   // end of migration
 156
 157   foreach(CoreIdentity identity, Core::identities(user())) {
 158     createIdentity(identity);
 159   }
 160
 161   foreach(NetworkInfo info, Core::networks(user())) {
 162     createNetwork(info);
 163   }
 164 }
 165
 166 void CoreSession::saveSessionState() const {
 167   _bufferSyncer->storeDirtyIds();
 168   _bufferViewManager->saveBufferViews();
 169   _networkConfig->save();
 170 }
 171
 172 void CoreSession::restoreSessionState() {
 173   QList<NetworkId> nets = Core::connectedNetworks(user());
 174   CoreNetwork *net = 0;
 175   foreach(NetworkId id, nets) {
 176     net = network(id);
 177     Q_ASSERT(net);
 178     net->connectToIrc();
 179   }
 180 }
 181
 182 void CoreSession::addClient(QIODevice *device) {
 183   if(!device) {
 184     qCritical() << "Invoking CoreSession::addClient with a QObject that is not a QIODevice!";
 185   } else {
 186     // if the socket is an orphan, the signalProxy adopts it.
 187     // -> we don't need to care about it anymore
 188     device->setParent(0);
 189     signalProxy()->addPeer(device);
 190     QVariantMap reply;
 191     reply["MsgType"] = "SessionInit";
 192     reply["SessionState"] = sessionState();
 193     SignalProxy::writeDataToDevice(device, reply);
 194   }
 195 }
 196
 197 void CoreSession::addClient(SignalProxy *proxy) {
 198   signalProxy()->addPeer(proxy);
 199   emit sessionState(sessionState());
 200 }
 201
 202 void CoreSession::removeClient(QIODevice *iodev) {
 203   QTcpSocket *socket = qobject_cast<QTcpSocket *>(iodev);
 204   if(socket)
 205     quInfo() << qPrintable(tr("Client")) << qPrintable(socket->peerAddress().toString()) << qPrintable(tr("disconnected (UserId: %1).").arg(user().toInt()));
 206 }
 207
 208 QHash<QString, QString> CoreSession::persistentChannels(NetworkId id) const {
 209   return Core::persistentChannels(user(), id);
 210 }
 211
 212 // FIXME switch to BufferId
 213 void CoreSession::msgFromClient(BufferInfo bufinfo, QString msg) {
 214   CoreNetwork *net = network(bufinfo.networkId());
 215   if(net) {
 216     net->userInput(bufinfo, msg);
 217   } else {
 218     qWarning() << "Trying to send to unconnected network:" << msg;
 219   }
 220 }
 221
 222 // ALL messages coming pass through these functions before going to the GUI.
 223 // So this is the perfect place for storing the backlog and log stuff.
 224 void CoreSession::recvMessageFromServer(NetworkId networkId, Message::Type type, BufferInfo::Type bufferType,
 225                                         const QString &target, const QString &text_, const QString &sender, Message::Flags flags) {
 226
 227   // U+FDD0 and U+FDD1 are special characters for Qt's text engine, specifically they mark the boundaries of
 228   // text frames in a QTextDocument. This might lead to problems in widgets displaying QTextDocuments (such as
 229   // KDE's notifications), hence we remove those just to be safe.
 230   QString text = text_;
 231   text.remove(QChar(0xfdd0)).remove(QChar(0xfdd1));
 232   RawMessage rawMsg(networkId, type, bufferType, target, text, sender, flags);
 233
 234   // check for HardStrictness ignore
 235   CoreNetwork *currentNetwork = network(networkId);
 236   QString networkName = currentNetwork ? currentNetwork->networkName() : QString("");
 237   if(_ignoreListManager.match(rawMsg, networkName) == IgnoreListManager::HardStrictness)
 238     return;
 239
 240   _messageQueue << rawMsg;
 241   if(!_processMessages) {
 242     _processMessages = true;
 243     QCoreApplication::postEvent(this, new ProcessMessagesEvent());
 244   }
 245 }
 246
 247 void CoreSession::recvStatusMsgFromServer(QString msg) {
 248   CoreNetwork *net = qobject_cast<CoreNetwork*>(sender());
 249   Q_ASSERT(net);
 250   emit displayStatusMsg(net->networkName(), msg);
 251 }
 252
 253 void CoreSession::processMessageEvent(MessageEvent *event) {
 254   recvMessageFromServer(event->networkId(), event->msgType(), event->bufferType(), event->target(),
 255                         event->text(), event->sender(), event->msgFlags());
 256 }
 257
 258 QList<BufferInfo> CoreSession::buffers() const {
 259   return Core::requestBuffers(user());
 260 }
 261
 262 void CoreSession::customEvent(QEvent *event) {
 263   if(event->type() != QEvent::User)
 264     return;
 265
 266   processMessages();
 267   event->accept();
 268 }
 269
 270 void CoreSession::processMessages() {
 271   if(_messageQueue.count() == 1) {
 272     const RawMessage &rawMsg = _messageQueue.first();
 273     bool createBuffer = !(rawMsg.flags & Message::Redirected);
 274     BufferInfo bufferInfo = Core::bufferInfo(user(), rawMsg.networkId, rawMsg.bufferType, rawMsg.target, createBuffer);
 275     if(!bufferInfo.isValid()) {
 276       Q_ASSERT(!createBuffer);
 277       bufferInfo = Core::bufferInfo(user(), rawMsg.networkId, BufferInfo::StatusBuffer, "");
 278     }
 279     Message msg(bufferInfo, rawMsg.type, rawMsg.text, rawMsg.sender, rawMsg.flags);
 280     Core::storeMessage(msg);
 281     emit displayMsg(msg);
 282   } else {
 283     QHash<NetworkId, QHash<QString, BufferInfo> > bufferInfoCache;
 284     MessageList messages;
 285     QList<RawMessage> redirectedMessages; // list of Messages which don't enforce a buffer creation
 286     BufferInfo bufferInfo;
 287     for(int i = 0; i < _messageQueue.count(); i++) {
 288       const RawMessage &rawMsg = _messageQueue.at(i);
 289       if(bufferInfoCache.contains(rawMsg.networkId) && bufferInfoCache[rawMsg.networkId].contains(rawMsg.target)) {
 290         bufferInfo = bufferInfoCache[rawMsg.networkId][rawMsg.target];
 291       } else {
 292         bool createBuffer = !(rawMsg.flags & Message::Redirected);
 293         bufferInfo = Core::bufferInfo(user(), rawMsg.networkId, rawMsg.bufferType, rawMsg.target, createBuffer);
 294         if(!bufferInfo.isValid()) {
 295           Q_ASSERT(!createBuffer);
 296           redirectedMessages << rawMsg;
 297           continue;
 298         }
 299         bufferInfoCache[rawMsg.networkId][rawMsg.target] = bufferInfo;
 300       }
 301       Message msg(bufferInfo, rawMsg.type, rawMsg.text, rawMsg.sender, rawMsg.flags);
 302       messages << msg;
 303     }
 304
 305     // recheck if there exists a buffer to store a redirected message in
 306     for(int i = 0; i < redirectedMessages.count(); i++) {
 307       const RawMessage &rawMsg = _messageQueue.at(i);
 308       if(bufferInfoCache.contains(rawMsg.networkId) && bufferInfoCache[rawMsg.networkId].contains(rawMsg.target)) {
 309         bufferInfo = bufferInfoCache[rawMsg.networkId][rawMsg.target];
 310       } else {
 311         // no luck -> we store them in the StatusBuffer
 312         bufferInfo = Core::bufferInfo(user(), rawMsg.networkId, BufferInfo::StatusBuffer, "");
 313         // add the StatusBuffer to the Cache in case there are more Messages for the original target
 314         bufferInfoCache[rawMsg.networkId][rawMsg.target] = bufferInfo;
 315       }
 316       Message msg(bufferInfo, rawMsg.type, rawMsg.text, rawMsg.sender, rawMsg.flags);
 317       messages << msg;
 318     }
 319
 320     Core::storeMessages(messages);
 321     // FIXME: extend protocol to a displayMessages(MessageList)
 322     for(int i = 0; i < messages.count(); i++) {
 323       emit displayMsg(messages[i]);
 324     }
 325   }
 326   _processMessages = false;
 327   _messageQueue.clear();
 328 }
 329
 330 QVariant CoreSession::sessionState() {
 331   QVariantMap v;
 332
 333   v["CoreFeatures"] = (int)Quassel::features();
 334
 335   QVariantList bufs;
 336   foreach(BufferInfo id, buffers()) bufs << qVariantFromValue(id);
 337   v["BufferInfos"] = bufs;
 338   QVariantList networkids;
 339   foreach(NetworkId id, _networks.keys()) networkids << qVariantFromValue(id);
 340   v["NetworkIds"] = networkids;
 341
 342   quint32 ircusercount = 0;
 343   quint32 ircchannelcount = 0;
 344   foreach(Network *net, _networks.values()) {
 345     ircusercount += net->ircUserCount();
 346     ircchannelcount += net->ircChannelCount();
 347   }
 348   v["IrcUserCount"] = ircusercount;
 349   v["IrcChannelCount"] = ircchannelcount;
 350
 351   QList<QVariant> idlist;
 352   foreach(Identity *i, _identities.values()) idlist << qVariantFromValue(*i);
 353   v["Identities"] = idlist;
 354
 355   //v["Payload"] = QByteArray(100000000, 'a');  // for testing purposes
 356   return v;
 357 }
 358
 359 void CoreSession::initScriptEngine() {
 360   signalProxy()->attachSlot(SIGNAL(scriptRequest(QString)), this, SLOT(scriptRequest(QString)));
 361   signalProxy()->attachSignal(this, SIGNAL(scriptResult(QString)));
 362
 363   // FIXME
 364   //QScriptValue storage_ = scriptEngine->newQObject(storage);
 365   //scriptEngine->globalObject().setProperty("storage", storage_);
 366 }
 367
 368 void CoreSession::scriptRequest(QString script) {
 369   emit scriptResult(scriptEngine->evaluate(script).toString());
 370 }
 371
 372 /*** Identity Handling ***/
 373 void CoreSession::createIdentity(const Identity &identity, const QVariantMap &additional) {
 374 #ifndef HAVE_SSL
 375   Q_UNUSED(additional)
 376 #endif
 377
 378   CoreIdentity coreIdentity(identity);
 379 #ifdef HAVE_SSL
 380   if(additional.contains("KeyPem"))
 381     coreIdentity.setSslKey(additional["KeyPem"].toByteArray());
 382   if(additional.contains("CertPem"))
 383     coreIdentity.setSslCert(additional["CertPem"].toByteArray());
 384 #endif
 385   qDebug() << Q_FUNC_INFO;
 386   IdentityId id = Core::createIdentity(user(), coreIdentity);
 387   if(!id.isValid())
 388     return;
 389   else
 390     createIdentity(coreIdentity);
 391 }
 392
 393 void CoreSession::createIdentity(const CoreIdentity &identity) {
 394   CoreIdentity *coreIdentity = new CoreIdentity(identity, this);
 395   _identities[identity.id()] = coreIdentity;
 396   // CoreIdentity has it's own synchronize method since it's "private" sslManager needs to be synced aswell
 397   coreIdentity->synchronize(signalProxy());
 398   connect(coreIdentity, SIGNAL(updated()), this, SLOT(updateIdentityBySender()));
 399   emit identityCreated(*coreIdentity);
 400 }
 401
 402 void CoreSession::updateIdentityBySender() {
 403   CoreIdentity *identity = qobject_cast<CoreIdentity *>(sender());
 404   if(!identity)
 405     return;
 406   Core::updateIdentity(user(), *identity);
 407 }
 408
 409 void CoreSession::removeIdentity(IdentityId id) {
 410   CoreIdentity *identity = _identities.take(id);
 411   if(identity) {
 412     emit identityRemoved(id);
 413     Core::removeIdentity(user(), id);
 414     identity->deleteLater();
 415   }
 416 }
 417
 418 /*** Network Handling ***/
 419
 420 void CoreSession::createNetwork(const NetworkInfo &info_, const QStringList &persistentChans) {
 421   NetworkInfo info = info_;
 422   int id;
 423
 424   if(!info.networkId.isValid())
 425     Core::createNetwork(user(), info);
 426
 427   if(!info.networkId.isValid()) {
 428     qWarning() << qPrintable(tr("CoreSession::createNetwork(): Got invalid networkId from Core when trying to create network %1!").arg(info.networkName));
 429     return;
 430   }
 431
 432   id = info.networkId.toInt();
 433   if(!_networks.contains(id)) {
 434
 435     // create persistent chans
 436     QRegExp rx("\\s*(\\S+)(?:\\s*(\\S+))?\\s*");
 437     foreach(QString channel, persistentChans) {
 438       if(!rx.exactMatch(channel)) {
 439         qWarning() << QString("Invalid persistent channel declaration: %1").arg(channel);
 440         continue;
 441       }
 442       Core::bufferInfo(user(), info.networkId, BufferInfo::ChannelBuffer, rx.cap(1), true);
 443       Core::setChannelPersistent(user(), info.networkId, rx.cap(1), true);
 444       if(!rx.cap(2).isEmpty())
 445         Core::setPersistentChannelKey(user(), info.networkId, rx.cap(1), rx.cap(2));
 446     }
 447
 448     CoreNetwork *net = new CoreNetwork(id, this);
 449     connect(net, SIGNAL(displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &, const QString &, const QString &, Message::Flags)),
 450                  SLOT(recvMessageFromServer(NetworkId, Message::Type, BufferInfo::Type, const QString &, const QString &, const QString &, Message::Flags)));
 451     connect(net, SIGNAL(displayStatusMsg(QString)), SLOT(recvStatusMsgFromServer(QString)));
 452
 453     net->setNetworkInfo(info);
 454     net->setProxy(signalProxy());
 455     _networks[id] = net;
 456     signalProxy()->synchronize(net);
 457     emit networkCreated(id);
 458   } else {
 459     qWarning() << qPrintable(tr("CoreSession::createNetwork(): Trying to create a network that already exists, updating instead!"));
 460     _networks[info.networkId]->requestSetNetworkInfo(info);
 461   }
 462 }
 463
 464 void CoreSession::removeNetwork(NetworkId id) {
 465   // Make sure the network is disconnected!
 466   CoreNetwork *net = network(id);
 467   if(!net)
 468     return;
 469
 470   if(net->connectionState() != Network::Disconnected) {
 471     connect(net, SIGNAL(disconnected(NetworkId)), this, SLOT(destroyNetwork(NetworkId)));
 472     net->disconnectFromIrc();
 473   } else {
 474     destroyNetwork(id);
 475   }
 476 }
 477
 478 void CoreSession::destroyNetwork(NetworkId id) {
 479   QList<BufferId> removedBuffers = Core::requestBufferIdsForNetwork(user(), id);
 480   Network *net = _networks.take(id);
 481   if(net && Core::removeNetwork(user(), id)) {
 482     foreach(BufferId bufferId, removedBuffers) {
 483       _bufferSyncer->removeBuffer(bufferId);
 484     }
 485     emit networkRemoved(id);
 486     net->deleteLater();
 487   }
 488 }
 489
 490 void CoreSession::renameBuffer(const NetworkId &networkId, const QString &newName, const QString &oldName) {
 491   BufferInfo bufferInfo = Core::bufferInfo(user(), networkId, BufferInfo::QueryBuffer, oldName, false);
 492   if(bufferInfo.isValid()) {
 493     _bufferSyncer->renameBuffer(bufferInfo.bufferId(), newName);
 494   }
 495 }
 496
 497 void CoreSession::clientsConnected() {
 498   QHash<NetworkId, CoreNetwork *>::iterator netIter = _networks.begin();
 499   Identity *identity = 0;
 500   CoreNetwork *net = 0;
 501   IrcUser *me = 0;
 502   while(netIter != _networks.end()) {
 503     net = *netIter;
 504     netIter++;
 505
 506     if(!net->isConnected())
 507       continue;
 508     identity = net->identityPtr();
 509     if(!identity)
 510       continue;
 511     me = net->me();
 512     if(!me)
 513       continue;
 514
 515     if(identity->detachAwayEnabled() && me->isAway()) {
 516       net->userInputHandler()->handleAway(BufferInfo(), QString());
 517     }
 518   }
 519 }
 520
 521 void CoreSession::clientsDisconnected() {
 522   QHash<NetworkId, CoreNetwork *>::iterator netIter = _networks.begin();
 523   Identity *identity = 0;
 524   CoreNetwork *net = 0;
 525   IrcUser *me = 0;
 526   QString awayReason;
 527   while(netIter != _networks.end()) {
 528     net = *netIter;
 529     netIter++;
 530
 531     if(!net->isConnected())
 532       continue;
 533
 534     identity = net->identityPtr();
 535     if(!identity)
 536       continue;
 537     me = net->me();
 538     if(!me)
 539       continue;
 540
 541     if(identity->detachAwayEnabled() && !me->isAway()) {
 542       if(!identity->detachAwayReason().isEmpty())
 543         awayReason = identity->detachAwayReason();
 544       net->setAutoAwayActive(true);
 545       net->userInputHandler()->handleAway(BufferInfo(), awayReason);
 546     }
 547   }
 548 }
 549
 550
 551 void CoreSession::globalAway(const QString &msg) {
 552   QHash<NetworkId, CoreNetwork *>::iterator netIter = _networks.begin();
 553   CoreNetwork *net = 0;
 554   while(netIter != _networks.end()) {
 555     net = *netIter;
 556     netIter++;
 557
 558     if(!net->isConnected())
 559       continue;
 560
 561     net->userInputHandler()->issueAway(msg, false /* no force away */);
 562   }
 563 }