Introduce CtcpParser for CTCP-related event processing
[quassel.git] / src / core / coresession.cpp
index 491e99a..3fd539e 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel Project                          *
+ *   Copyright (C) 2005-09 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 
+#include "coresession.h"
+
 #include <QtScript>
 
 #include "core.h"
-#include "coresession.h"
-#include "userinputhandler.h"
-#include "signalproxy.h"
+#include "coreuserinputhandler.h"
 #include "corebuffersyncer.h"
 #include "corebacklogmanager.h"
 #include "corebufferviewmanager.h"
-#include "coreirclisthelper.h"
-#include "storage.h"
-
 #include "coreidentity.h"
+#include "coreignorelistmanager.h"
+#include "coreirclisthelper.h"
 #include "corenetwork.h"
-#include "ircuser.h"
-#include "ircchannel.h"
-
-#include "util.h"
+#include "corenetworkconfig.h"
+#include "coresessioneventprocessor.h"
 #include "coreusersettings.h"
+#include "ctcpparser.h"
+#include "eventmanager.h"
+#include "eventstringifier.h"
+#include "ircchannel.h"
+#include "ircparser.h"
+#include "ircuser.h"
 #include "logger.h"
+#include "messageevent.h"
+#include "signalproxy.h"
+#include "storage.h"
+#include "util.h"
+
+class ProcessMessagesEvent : public QEvent {
+public:
+  ProcessMessagesEvent() : QEvent(QEvent::User) {}
+};
 
 CoreSession::CoreSession(UserId uid, bool restoreState, QObject *parent)
   : QObject(parent),
@@ -48,10 +60,21 @@ CoreSession::CoreSession(UserId uid, bool restoreState, QObject *parent)
     _backlogManager(new CoreBacklogManager(this)),
     _bufferViewManager(new CoreBufferViewManager(_signalProxy, this)),
     _ircListHelper(new CoreIrcListHelper(this)),
+    _networkConfig(new CoreNetworkConfig("GlobalNetworkConfig", this)),
     _coreInfo(this),
-    scriptEngine(new QScriptEngine(this))
+    _eventManager(new EventManager(this)),
+    _eventStringifier(new EventStringifier(this)),
+    _sessionEventProcessor(new CoreSessionEventProcessor(this)),
+    _ctcpParser(new CtcpParser(this)),
+    _ircParser(new IrcParser(this)),
+    scriptEngine(new QScriptEngine(this)),
+    _processMessages(false),
+    _ignoreListManager(this)
 {
   SignalProxy *p = signalProxy();
+  p->setHeartBeatInterval(30);
+  p->setMaxHeartBeatCount(60); // 30 mins until we throw a dead socket out
+
   connect(p, SIGNAL(peerRemoved(QIODevice *)), this, SLOT(removeClient(QIODevice *)));
 
   connect(p, SIGNAL(connected()), this, SLOT(clientsConnected()));
@@ -68,21 +91,31 @@ CoreSession::CoreSession(UserId uid, bool restoreState, QObject *parent)
 
   p->attachSignal(this, SIGNAL(networkCreated(NetworkId)));
   p->attachSignal(this, SIGNAL(networkRemoved(NetworkId)));
-  p->attachSlot(SIGNAL(createNetwork(const NetworkInfo &)), this, SLOT(createNetwork(const NetworkInfo &)));
+  p->attachSlot(SIGNAL(createNetwork(const NetworkInfo &, const QStringList &)), this, SLOT(createNetwork(const NetworkInfo &, const QStringList &)));
   p->attachSlot(SIGNAL(removeNetwork(NetworkId)), this, SLOT(removeNetwork(NetworkId)));
 
   loadSettings();
   initScriptEngine();
 
-  connect(&(Core::instance()->syncTimer()), SIGNAL(timeout()), _bufferSyncer, SLOT(storeDirtyIds()));
-  connect(&(Core::instance()->syncTimer()), SIGNAL(timeout()), _bufferViewManager, SLOT(saveBufferViews()));
+  eventManager()->registerObject(ircParser(), EventManager::NormalPriority);
+  eventManager()->registerObject(sessionEventProcessor(), EventManager::HighPriority); // needs to process events *before* the stringifier!
+  eventManager()->registerObject(ctcpParser(), EventManager::NormalPriority);
+  eventManager()->registerObject(eventStringifier(), EventManager::NormalPriority);
+  eventManager()->registerObject(this, EventManager::LowPriority); // for sending MessageEvents to the client
+   // some events need to be handled after msg generation
+  eventManager()->registerObject(sessionEventProcessor(), EventManager::LowPriority, "lateProcess");
+  eventManager()->registerObject(ctcpParser(), EventManager::LowPriority, "send");
+
+  // periodically save our session state
+  connect(&(Core::instance()->syncTimer()), SIGNAL(timeout()), this, SLOT(saveSessionState()));
 
   p->synchronize(_bufferSyncer);
   p->synchronize(&aliasManager());
   p->synchronize(_backlogManager);
   p->synchronize(ircListHelper());
+  p->synchronize(networkConfig());
   p->synchronize(&_coreInfo);
-
+  p->synchronize(&_ignoreListManager);
   // Restore session state
   if(restoreState)
     restoreSessionState();
@@ -119,11 +152,11 @@ void CoreSession::loadSettings() {
     QList<NetworkInfo>::iterator networkIter = networkInfos.begin();
     while(networkIter != networkInfos.end()) {
       if(networkIter->identity == id) {
-       networkIter->identity = newId;
-       Core::updateNetwork(user(), *networkIter);
-       networkIter = networkInfos.erase(networkIter);
+        networkIter->identity = newId;
+        Core::updateNetwork(user(), *networkIter);
+        networkIter = networkInfos.erase(networkIter);
       } else {
-       networkIter++;
+        networkIter++;
       }
     }
     s.removeIdentity(id);
@@ -133,12 +166,6 @@ void CoreSession::loadSettings() {
   foreach(CoreIdentity identity, Core::identities(user())) {
     createIdentity(identity);
   }
-  if(!_identities.count()) {
-    Identity identity;
-    identity.setToDefaults();
-    identity.setIdentityName(tr("Default Identity"));
-    createIdentity(identity, QVariantMap());
-  }
 
   foreach(NetworkInfo info, Core::networks(user())) {
     createNetwork(info);
@@ -148,6 +175,7 @@ void CoreSession::loadSettings() {
 void CoreSession::saveSessionState() const {
   _bufferSyncer->storeDirtyIds();
   _bufferViewManager->saveBufferViews();
+  _networkConfig->save();
 }
 
 void CoreSession::restoreSessionState() {
@@ -188,7 +216,6 @@ void CoreSession::removeClient(QIODevice *iodev) {
 
 QHash<QString, QString> CoreSession::persistentChannels(NetworkId id) const {
   return Core::persistentChannels(user(), id);
-  return QHash<QString, QString>();
 }
 
 // FIXME switch to BufferId
@@ -203,16 +230,27 @@ void CoreSession::msgFromClient(BufferInfo bufinfo, QString msg) {
 
 // ALL messages coming pass through these functions before going to the GUI.
 // So this is the perfect place for storing the backlog and log stuff.
-void CoreSession::recvMessageFromServer(Message::Type type, BufferInfo::Type bufferType,
-                                        QString target, QString text, QString sender, Message::Flags flags) {
-  CoreNetwork *net = qobject_cast<CoreNetwork*>(this->sender());
-  Q_ASSERT(net);
+void CoreSession::recvMessageFromServer(NetworkId networkId, Message::Type type, BufferInfo::Type bufferType,
+                                        const QString &target, const QString &text_, const QString &sender, Message::Flags flags) {
+
+  // U+FDD0 and U+FDD1 are special characters for Qt's text engine, specifically they mark the boundaries of
+  // text frames in a QTextDocument. This might lead to problems in widgets displaying QTextDocuments (such as
+  // KDE's notifications), hence we remove those just to be safe.
+  QString text = text_;
+  text.remove(QChar(0xfdd0)).remove(QChar(0xfdd1));
+  RawMessage rawMsg(networkId, type, bufferType, target, text, sender, flags);
+
+  // check for HardStrictness ignore
+  CoreNetwork *currentNetwork = network(networkId);
+  QString networkName = currentNetwork ? currentNetwork->networkName() : QString("");
+  if(_ignoreListManager.match(rawMsg, networkName) == IgnoreListManager::HardStrictness)
+    return;
 
-  BufferInfo bufferInfo = Core::bufferInfo(user(), net->networkId(), bufferType, target);
-  Message msg(bufferInfo, type, text, sender, flags);
-  msg.setMsgId(Core::storeMessage(msg));
-  Q_ASSERT(msg.msgId() != 0);
-  emit displayMsg(msg);
+  _messageQueue << rawMsg;
+  if(!_processMessages) {
+    _processMessages = true;
+    QCoreApplication::postEvent(this, new ProcessMessagesEvent());
+  }
 }
 
 void CoreSession::recvStatusMsgFromServer(QString msg) {
@@ -221,14 +259,91 @@ void CoreSession::recvStatusMsgFromServer(QString msg) {
   emit displayStatusMsg(net->networkName(), msg);
 }
 
+void CoreSession::processMessageEvent(MessageEvent *event) {
+  recvMessageFromServer(event->networkId(), event->msgType(), event->bufferType(),
+                        event->target().isNull()? "" : event->target(),
+                        event->text().isNull()? "" : event->text(),
+                        event->sender().isNull()? "" : event->sender(),
+                        event->msgFlags());
+}
+
 QList<BufferInfo> CoreSession::buffers() const {
   return Core::requestBuffers(user());
 }
 
+void CoreSession::customEvent(QEvent *event) {
+  if(event->type() != QEvent::User)
+    return;
+
+  processMessages();
+  event->accept();
+}
+
+void CoreSession::processMessages() {
+  if(_messageQueue.count() == 1) {
+    const RawMessage &rawMsg = _messageQueue.first();
+    bool createBuffer = !(rawMsg.flags & Message::Redirected);
+    BufferInfo bufferInfo = Core::bufferInfo(user(), rawMsg.networkId, rawMsg.bufferType, rawMsg.target, createBuffer);
+    if(!bufferInfo.isValid()) {
+      Q_ASSERT(!createBuffer);
+      bufferInfo = Core::bufferInfo(user(), rawMsg.networkId, BufferInfo::StatusBuffer, "");
+    }
+    Message msg(bufferInfo, rawMsg.type, rawMsg.text, rawMsg.sender, rawMsg.flags);
+    Core::storeMessage(msg);
+    emit displayMsg(msg);
+  } else {
+    QHash<NetworkId, QHash<QString, BufferInfo> > bufferInfoCache;
+    MessageList messages;
+    QList<RawMessage> redirectedMessages; // list of Messages which don't enforce a buffer creation
+    BufferInfo bufferInfo;
+    for(int i = 0; i < _messageQueue.count(); i++) {
+      const RawMessage &rawMsg = _messageQueue.at(i);
+      if(bufferInfoCache.contains(rawMsg.networkId) && bufferInfoCache[rawMsg.networkId].contains(rawMsg.target)) {
+        bufferInfo = bufferInfoCache[rawMsg.networkId][rawMsg.target];
+      } else {
+        bool createBuffer = !(rawMsg.flags & Message::Redirected);
+        bufferInfo = Core::bufferInfo(user(), rawMsg.networkId, rawMsg.bufferType, rawMsg.target, createBuffer);
+        if(!bufferInfo.isValid()) {
+          Q_ASSERT(!createBuffer);
+          redirectedMessages << rawMsg;
+          continue;
+        }
+        bufferInfoCache[rawMsg.networkId][rawMsg.target] = bufferInfo;
+      }
+      Message msg(bufferInfo, rawMsg.type, rawMsg.text, rawMsg.sender, rawMsg.flags);
+      messages << msg;
+    }
+
+    // recheck if there exists a buffer to store a redirected message in
+    for(int i = 0; i < redirectedMessages.count(); i++) {
+      const RawMessage &rawMsg = _messageQueue.at(i);
+      if(bufferInfoCache.contains(rawMsg.networkId) && bufferInfoCache[rawMsg.networkId].contains(rawMsg.target)) {
+        bufferInfo = bufferInfoCache[rawMsg.networkId][rawMsg.target];
+      } else {
+        // no luck -> we store them in the StatusBuffer
+        bufferInfo = Core::bufferInfo(user(), rawMsg.networkId, BufferInfo::StatusBuffer, "");
+        // add the StatusBuffer to the Cache in case there are more Messages for the original target
+        bufferInfoCache[rawMsg.networkId][rawMsg.target] = bufferInfo;
+      }
+      Message msg(bufferInfo, rawMsg.type, rawMsg.text, rawMsg.sender, rawMsg.flags);
+      messages << msg;
+    }
+
+    Core::storeMessages(messages);
+    // FIXME: extend protocol to a displayMessages(MessageList)
+    for(int i = 0; i < messages.count(); i++) {
+      emit displayMsg(messages[i]);
+    }
+  }
+  _processMessages = false;
+  _messageQueue.clear();
+}
 
 QVariant CoreSession::sessionState() {
   QVariantMap v;
 
+  v["CoreFeatures"] = (int)Quassel::features();
+
   QVariantList bufs;
   foreach(BufferInfo id, buffers()) bufs << qVariantFromValue(id);
   v["BufferInfos"] = bufs;
@@ -279,6 +394,7 @@ void CoreSession::createIdentity(const Identity &identity, const QVariantMap &ad
   if(additional.contains("CertPem"))
     coreIdentity.setSslCert(additional["CertPem"].toByteArray());
 #endif
+  qDebug() << Q_FUNC_INFO;
   IdentityId id = Core::createIdentity(user(), coreIdentity);
   if(!id.isValid())
     return;
@@ -291,7 +407,7 @@ void CoreSession::createIdentity(const CoreIdentity &identity) {
   _identities[identity.id()] = coreIdentity;
   // CoreIdentity has it's own synchronize method since it's "private" sslManager needs to be synced aswell
   coreIdentity->synchronize(signalProxy());
-  connect(coreIdentity, SIGNAL(updated(const QVariantMap &)), this, SLOT(updateIdentityBySender()));
+  connect(coreIdentity, SIGNAL(updated()), this, SLOT(updateIdentityBySender()));
   emit identityCreated(*coreIdentity);
 }
 
@@ -313,7 +429,7 @@ void CoreSession::removeIdentity(IdentityId id) {
 
 /*** Network Handling ***/
 
-void CoreSession::createNetwork(const NetworkInfo &info_) {
+void CoreSession::createNetwork(const NetworkInfo &info_, const QStringList &persistentChans) {
   NetworkInfo info = info_;
   int id;
 
@@ -327,10 +443,25 @@ void CoreSession::createNetwork(const NetworkInfo &info_) {
 
   id = info.networkId.toInt();
   if(!_networks.contains(id)) {
+
+    // create persistent chans
+    QRegExp rx("\\s*(\\S+)(?:\\s*(\\S+))?\\s*");
+    foreach(QString channel, persistentChans) {
+      if(!rx.exactMatch(channel)) {
+        qWarning() << QString("Invalid persistent channel declaration: %1").arg(channel);
+        continue;
+      }
+      Core::bufferInfo(user(), info.networkId, BufferInfo::ChannelBuffer, rx.cap(1), true);
+      Core::setChannelPersistent(user(), info.networkId, rx.cap(1), true);
+      if(!rx.cap(2).isEmpty())
+        Core::setPersistentChannelKey(user(), info.networkId, rx.cap(1), rx.cap(2));
+    }
+
     CoreNetwork *net = new CoreNetwork(id, this);
-    connect(net, SIGNAL(displayMsg(Message::Type, BufferInfo::Type, QString, QString, QString, Message::Flags)),
-           this, SLOT(recvMessageFromServer(Message::Type, BufferInfo::Type, QString, QString, QString, Message::Flags)));
-    connect(net, SIGNAL(displayStatusMsg(QString)), this, SLOT(recvStatusMsgFromServer(QString)));
+    connect(net, SIGNAL(displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &, const QString &, const QString &, Message::Flags)),
+                 SLOT(recvMessageFromServer(NetworkId, Message::Type, BufferInfo::Type, const QString &, const QString &, const QString &, Message::Flags)));
+    connect(net, SIGNAL(displayStatusMsg(QString)), SLOT(recvStatusMsgFromServer(QString)));
+    connect(net, SIGNAL(disconnected(NetworkId)), SIGNAL(networkDisconnected(NetworkId)));
 
     net->setNetworkInfo(info);
     net->setProxy(signalProxy());
@@ -350,7 +481,7 @@ void CoreSession::removeNetwork(NetworkId id) {
     return;
 
   if(net->connectionState() != Network::Disconnected) {
-    connect(net, SIGNAL(disconnected(NetworkId)), this, SLOT(destroyNetwork(NetworkId)));
+    connect(net, SIGNAL(disconnected(NetworkId)), SLOT(destroyNetwork(NetworkId)));
     net->disconnectFromIrc();
   } else {
     destroyNetwork(id);
@@ -381,7 +512,6 @@ void CoreSession::clientsConnected() {
   Identity *identity = 0;
   CoreNetwork *net = 0;
   IrcUser *me = 0;
-  QString awayReason;
   while(netIter != _networks.end()) {
     net = *netIter;
     netIter++;
@@ -413,6 +543,7 @@ void CoreSession::clientsDisconnected() {
 
     if(!net->isConnected())
       continue;
+
     identity = net->identityPtr();
     if(!identity)
       continue;
@@ -421,12 +552,25 @@ void CoreSession::clientsDisconnected() {
       continue;
 
     if(identity->detachAwayEnabled() && !me->isAway()) {
-      if(identity->detachAwayReasonEnabled())
-       awayReason = identity->detachAwayReason();
-      else
-       awayReason = identity->awayReason();
+      if(!identity->detachAwayReason().isEmpty())
+        awayReason = identity->detachAwayReason();
       net->setAutoAwayActive(true);
       net->userInputHandler()->handleAway(BufferInfo(), awayReason);
     }
   }
 }
+
+
+void CoreSession::globalAway(const QString &msg) {
+  QHash<NetworkId, CoreNetwork *>::iterator netIter = _networks.begin();
+  CoreNetwork *net = 0;
+  while(netIter != _networks.end()) {
+    net = *netIter;
+    netIter++;
+
+    if(!net->isConnected())
+      continue;
+
+    net->userInputHandler()->issueAway(msg, false /* no force away */);
+  }
+}