resolve #1145 (parse 330 in /whowas)
[quassel.git] / src / core / eventstringifier.cpp
index 62ae9fd..77c7c52 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2010 by the Quassel Project                        *
+ *   Copyright (C) 2005-2012 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
 
 #include "eventstringifier.h"
 
-EventStringifier::EventStringifier(QObject *parent) : QObject(parent) {
+#include "coresession.h"
+#include "ctcpevent.h"
+#include "messageevent.h"
 
+EventStringifier::EventStringifier(CoreSession *parent) : BasicHandler("handleCtcp", parent),
+  _coreSession(parent),
+  _whois(false)
+{
+  connect(this, SIGNAL(newMessageEvent(Event *)), coreSession()->eventManager(), SLOT(postEvent(Event *)));
+}
+
+void EventStringifier::displayMsg(NetworkEvent *event, Message::Type msgType, const QString &msg, const QString &sender,
+                                  const QString &target, Message::Flags msgFlags) {
+  if(event->flags().testFlag(EventManager::Silent))
+    return;
+
+  MessageEvent *msgEvent = createMessageEvent(event, msgType, msg, sender, target, msgFlags);
+  //sendMessageEvent(msgEvent);
+  emit newMessageEvent(msgEvent);
+}
+
+MessageEvent *EventStringifier::createMessageEvent(NetworkEvent *event, Message::Type msgType, const QString &msg, const QString &sender,
+                        const QString &target, Message::Flags msgFlags) {
+  MessageEvent *msgEvent = new MessageEvent(msgType, event->network(), msg, sender, target, msgFlags);
+  msgEvent->setTimestamp(event->timestamp());
+  return msgEvent;
+}
+
+bool EventStringifier::checkParamCount(IrcEvent *e, int minParams) {
+  if(e->params().count() < minParams) {
+    if(e->type() == EventManager::IrcEventNumeric) {
+      qWarning() << "Command " << static_cast<IrcEventNumeric *>(e)->number() << " requires " << minParams << "params, got: " << e->params();
+    } else {
+      QString name = coreSession()->eventManager()->enumName(e->type());
+      qWarning() << qPrintable(name) << "requires" << minParams << "params, got:" << e->params();
+    }
+    e->stop();
+    return false;
+  }
+  return true;
+}
+
+/* These are only for legacy reasons; remove as soon as we handle NetworkSplitEvents properly */
+void EventStringifier::processNetworkSplitJoin(NetworkSplitEvent *e) {
+  QString msg = e->users().join("#:#") + "#:#" + e->quitMessage();
+  displayMsg(e, Message::NetsplitJoin, msg, QString(), e->channel());
+}
+
+void EventStringifier::processNetworkSplitQuit(NetworkSplitEvent *e) {
+  QString msg = e->users().join("#:#") + "#:#" + e->quitMessage();
+  displayMsg(e, Message::NetsplitQuit, msg, QString(), e->channel());
+}
+
+/* End legacy */
+
+void EventStringifier::processIrcEventNumeric(IrcEventNumeric *e) {
+  //qDebug() << e->number();
+  switch(e->number()) {
+  // Welcome, status, info messages. Just display these.
+  case 1: case 2: case 3: case 4: case 5:
+  case 221: case 250: case 251: case 252: case 253: case 254: case 255: case 265: case 266:
+  case 372: case 375:
+    displayMsg(e, Message::Server, e->params().join(" "), e->prefix());
+    break;
+
+  // Server error messages without param, just display them
+  case 409: case 411: case 412: case 422: case 424: case 445: case 446: case 451: case 462:
+  case 463: case 464: case 465: case 466: case 472: case 481: case 483: case 485: case 491: case 501: case 502:
+  case 431: // ERR_NONICKNAMEGIVEN
+    displayMsg(e, Message::Error, e->params().join(" "), e->prefix());
+    break;
+
+  // Server error messages, display them in red. Colon between first param and rest.
+  case 401: {
+    if(!checkParamCount(e, 1))
+      return;
+
+    QStringList params = e->params();
+    QString target = params.takeFirst();
+    displayMsg(e, Message::Error, target + ": " + params.join(" "), e->prefix(), target, Message::Redirected);
+    break;
+  }
+
+  case 402: case 403: case 404: case 406: case 408: case 415: case 421: case 442: {
+    if(!checkParamCount(e, 1))
+      return;
+
+    QStringList params = e->params();
+    QString channelName = params.takeFirst();
+    displayMsg(e, Message::Error, channelName + ": " + params.join(" "), e->prefix());
+    break;
+  }
+
+  // Server error messages which will be displayed with a colon between the first param and the rest
+  case 413: case 414: case 423: case 441: case 444: case 461:  // FIXME see below for the 47x codes
+  case 467: case 471: case 473: case 474: case 475: case 476: case 477: case 478: case 482:
+  case 436: // ERR_NICKCOLLISION
+  {
+    if(!checkParamCount(e, 1))
+      return;
+
+    QStringList params = e->params();
+    QString p = params.takeFirst();
+    displayMsg(e, Message::Error, p + ": " + params.join(" "));
+    break;
+  }
+
+  // Ignore these commands.
+  case 321: case 353: case 366: case 376:
+    break;
+
+  // CAP stuff
+  case 900: case 903: case 904: case 905: case 906: case 907:
+  {
+    displayMsg(e, Message::Info, "CAP: " + e->params().join(""));
+    break;
+  }
+
+  // Everything else will be marked in red, so we can add them somewhere.
+  default:
+    if(_whois) {
+      // many nets define their own WHOIS fields. we fetch those not in need of special attention here:
+      displayMsg(e, Message::Server, tr("[Whois] ") + e->params().join(" "), e->prefix());
+    } else {
+      // FIXME figure out how/where to do this in the future
+      //if(coreSession()->ircListHelper()->requestInProgress(network()->networkId()))
+      //  coreSession()->ircListHelper()->reportError(params.join(" "));
+      //else
+        displayMsg(e, Message::Error, QString("%1 %2").arg(e->number(), 3, 10, QLatin1Char('0')).arg(e->params().join(" ")), e->prefix());
+    }
+  }
+}
+
+void EventStringifier::processIrcEventInvite(IrcEvent *e) {
+  displayMsg(e, Message::Invite, tr("%1 invited you to channel %2").arg(e->nick(), e->params().at(1)));
+}
+
+void EventStringifier::processIrcEventJoin(IrcEvent *e) {
+  if(e->testFlag(EventManager::Netsplit))
+    return;
+
+  displayMsg(e, Message::Join, e->params()[0], e->prefix(), e->params()[0]);
+}
+
+void EventStringifier::processIrcEventKick(IrcEvent *e) {
+  if(!checkParamCount(e, 2))
+    return;
+
+  IrcUser *victim = e->network()->ircUser(e->params().at(1));
+  if(victim) {
+    QString channel = e->params().at(0);
+    QString msg = victim->nick();
+    if(e->params().count() > 2)
+      msg += " " + e->params().at(2);
+
+    displayMsg(e, Message::Kick, msg, e->prefix(), channel);
+  }
+}
+
+void EventStringifier::processIrcEventMode(IrcEvent *e) {
+  if(e->network()->isChannelName(e->params().first())) {
+    // Channel Modes
+    displayMsg(e, Message::Mode, e->params().join(" "), e->prefix(), e->params().first());
+  } else {
+    // User Modes
+    // FIXME: redirect
+    displayMsg(e, Message::Mode, e->params().join(" "), e->prefix());
+  }
+}
+
+// this needs to be called before the ircuser is renamed!
+void EventStringifier::processIrcEventNick(IrcEvent *e) {
+  if(!checkParamCount(e, 1))
+    return;
+
+  IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
+  if(!ircuser) {
+    qWarning() << Q_FUNC_INFO << "Unknown IrcUser!";
+    return;
+  }
+
+  QString newnick = e->params().at(0);
+  QString oldnick = ircuser->nick();
+
+  QString sender = e->network()->isMyNick(oldnick) ? newnick : e->prefix();
+  foreach(const QString &channel, ircuser->channels())
+    displayMsg(e, Message::Nick, newnick, sender, channel);
+}
+
+void EventStringifier::processIrcEventPart(IrcEvent *e) {
+  if(!checkParamCount(e, 1))
+    return;
+
+  QString channel = e->params().at(0);
+  QString msg = e->params().count() > 1? e->params().at(1) : QString();
+
+  displayMsg(e, Message::Part, msg, e->prefix(), channel);
+}
+
+void EventStringifier::processIrcEventPong(IrcEvent *e) {
+  QString timestamp = e->params().at(1);
+  QTime sendTime = QTime::fromString(timestamp, "hh:mm:ss.zzz");
+  if(!sendTime.isValid())
+    displayMsg(e, Message::Server, "PONG " + e->params().join(" "), e->prefix());
+}
+
+void EventStringifier::processIrcEventQuit(IrcEvent *e) {
+  if(e->testFlag(EventManager::Netsplit))
+    return;
+
+  IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
+  if(!ircuser)
+    return;
+
+  foreach(const QString &channel, ircuser->channels())
+    displayMsg(e, Message::Quit, e->params().count()? e->params().first() : QString(), e->prefix(), channel);
+}
+
+void EventStringifier::processIrcEventTopic(IrcEvent *e) {
+  displayMsg(e, Message::Topic, tr("%1 has changed topic for %2 to: \"%3\"")
+             .arg(e->nick(), e->params().at(0), e->params().at(1)), QString(), e->params().at(0));
+}
+
+/* RPL_ISUPPORT */
+void EventStringifier::processIrcEvent005(IrcEvent *e) {
+  if(!e->params().last().contains(QRegExp("are supported (by|on) this server")))
+    displayMsg(e, Message::Error, tr("Received non-RFC-compliant RPL_ISUPPORT: this can lead to unexpected behavior!"), e->prefix());
+  displayMsg(e, Message::Server, e->params().join(" "), e->prefix());
+}
+
+/* RPL_AWAY - "<nick> :<away message>" */
+void EventStringifier::processIrcEvent301(IrcEvent *e) {
+  QString nick = e->params().at(0);
+  QString awayMsg = e->params().at(1);
+  QString msg, target;
+  bool send = true;
+
+  // FIXME: proper redirection needed
+  if(_whois) {
+    msg = tr("[Whois] ");
+  } else {
+    target = nick;
+    IrcUser *ircuser = e->network()->ircUser(nick);
+    if(ircuser) {
+      int now = QDateTime::currentDateTime().toTime_t();
+      const int silenceTime = 60;
+      if(ircuser->lastAwayMessage() + silenceTime >= now)
+        send = false;
+      ircuser->setLastAwayMessage(now);
+    }
+  }
+  if(send)
+    displayMsg(e, Message::Server, msg + tr("%1 is away: \"%2\"").arg(nick, awayMsg), QString(), target);
+}
+
+/* RPL_UNAWAY - ":You are no longer marked as being away" */
+void EventStringifier::processIrcEvent305(IrcEvent *e) {
+  displayMsg(e, Message::Server, tr("You are no longer marked as being away"));
+}
+
+/* RPL_NOWAWAY - ":You have been marked as being away" */
+void EventStringifier::processIrcEvent306(IrcEvent *e) {
+  if(!e->network()->autoAwayActive())
+    displayMsg(e, Message::Server, tr("You have been marked as being away"));
+}
+
+/*
+WHOIS-Message:
+   Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message.
+  and 301 (RPL_AWAY)
+              "<nick> :<away message>"
+WHO-Message:
+   Replies 352 and 315 paired are used to answer a WHO message.
+
+WHOWAS-Message:
+   Replies 314 and 369 are responses to a WHOWAS message.
+
+*/
+
+/*  RPL_WHOISUSER - "<nick> <user> <host> * :<real name>" */
+void EventStringifier::processIrcEvent311(IrcEvent *e) {
+  _whois = true;
+
+  const QString whoisUserString = tr("[Whois] %1 is %2 (%3)");
+
+  IrcUser *ircuser = e->network()->ircUser(e->params().at(0));
+  if(ircuser)
+    displayMsg(e, Message::Server, whoisUserString.arg(ircuser->nick(), ircuser->hostmask(), ircuser->realName()));
+  else {
+    QString host = QString("%1!%2@%3").arg(e->params().at(0), e->params().at(1), e->params().at(2));
+    displayMsg(e, Message::Server, whoisUserString.arg(e->params().at(0), host, e->params().last()));
+  }
+}
+
+/*  RPL_WHOISSERVER -  "<nick> <server> :<server info>" */
+void EventStringifier::processIrcEvent312(IrcEvent *e) {
+  if(_whois)
+    displayMsg(e, Message::Server, tr("[Whois] %1 is online via %2 (%3)").arg(e->params().at(0), e->params().at(1), e->params().last()));
+  else
+    displayMsg(e, Message::Server, tr("[Whowas] %1 was online via %2 (%3)").arg(e->params().at(0), e->params().at(1), e->params().last()));
+}
+
+/*  RPL_WHOWASUSER - "<nick> <user> <host> * :<real name>" */
+void EventStringifier::processIrcEvent314(IrcEvent *e) {
+  if(!checkParamCount(e, 3))
+    return;
+
+  displayMsg(e, Message::Server, tr("[Whowas] %1 was %2@%3 (%4)").arg(e->params()[0], e->params()[1], e->params()[2], e->params().last()));
+}
+
+/*  RPL_ENDOFWHO: "<name> :End of WHO list" */
+void EventStringifier::processIrcEvent315(IrcEvent *e) {
+  QStringList p = e->params();
+  p.takeLast(); // should be "End of WHO list"
+  displayMsg(e, Message::Server, tr("[Who] End of /WHO list for %1").arg(p.join(" ")));
+}
+
+/*  RPL_WHOISIDLE - "<nick> <integer> :seconds idle"
+   (real life: "<nick> <integer> <integer> :seconds idle, signon time) */
+void EventStringifier::processIrcEvent317(IrcEvent *e) {
+  int idleSecs = e->params()[1].toInt();
+
+  if(e->params().count() > 3) { // if we have more then 3 params we have the above mentioned "real life" situation
+    QDateTime loginTime = QDateTime::fromTime_t(e->params()[2].toInt());
+    displayMsg(e, Message::Server, tr("[Whois] %1 is logged in since %2").arg(e->params()[0], loginTime.toString()));
+  }
+  displayMsg(e, Message::Server, tr("[Whois] %1 is idling for %2 (since %3)")
+             .arg(e->params()[0], secondsToString(idleSecs), e->timestamp().toLocalTime().addSecs(-idleSecs).toString()));
+}
+
+/*  RPL_ENDOFWHOIS - "<nick> :End of WHOIS list" */
+void EventStringifier::processIrcEvent318(IrcEvent *e) {
+  _whois = false;
+  displayMsg(e, Message::Server, tr("[Whois] End of /WHOIS list"));
+}
+
+/*  RPL_WHOISCHANNELS - "<nick> :*( ( "@" / "+" ) <channel> " " )" */
+void EventStringifier::processIrcEvent319(IrcEvent *e) {
+  if(!checkParamCount(e, 2))
+    return;
+
+  QString nick = e->params().first();
+  QStringList op;
+  QStringList voice;
+  QStringList user;
+  foreach(QString channel, e->params().last().split(" ")) {
+    if(channel.startsWith("@"))
+       op.append(channel.remove(0,1));
+    else if(channel.startsWith("+"))
+      voice.append(channel.remove(0,1));
+    else
+      user.append(channel);
+  }
+  if(!user.isEmpty())
+    displayMsg(e, Message::Server, tr("[Whois] %1 is a user on channels: %2").arg(nick, user.join(" ")));
+  if(!voice.isEmpty())
+    displayMsg(e, Message::Server, tr("[Whois] %1 has voice on channels: %2").arg(nick, voice.join(" ")));
+  if(!op.isEmpty())
+    displayMsg(e, Message::Server, tr("[Whois] %1 is an operator on channels: %2").arg(nick, op.join(" ")));
+}
+
+/* RPL_LIST -  "<channel> <# visible> :<topic>" */
+void EventStringifier::processIrcEvent322(IrcEvent *e) {
+  QString channelName;
+  quint32 userCount = 0;
+  QString topic;
+
+  switch(e->params().count()) {
+  case 3:
+    topic = e->params()[2];
+  case 2:
+    userCount = e->params()[1].toUInt();
+  case 1:
+    channelName = e->params()[0];
+  default:
+    break;
+  }
+  displayMsg(e, Message::Server, tr("Channel %1 has %2 users. Topic is: \"%3\"")
+             .arg(channelName).arg(userCount).arg(topic));
+}
+
+/* RPL_LISTEND ":End of LIST" */
+void EventStringifier::processIrcEvent323(IrcEvent *e) {
+  displayMsg(e, Message::Server, tr("End of channel list"));
+}
+
+/* RPL_CHANNELMODEIS - "<channel> <mode> <mode params>" */
+void EventStringifier::processIrcEvent324(IrcEvent *e) {
+  processIrcEventMode(e);
+}
+
+/* RPL_??? - "<channel> <homepage> */
+void EventStringifier::processIrcEvent328(IrcEvent *e) {
+  if(!checkParamCount(e, 2))
+    return;
+
+  QString channel = e->params()[0];
+  displayMsg(e, Message::Topic, tr("Homepage for %1 is %2").arg(channel, e->params()[1]), QString(), channel);
+}
+
+/* RPL_??? - "<channel> <creation time (unix)>" */
+void EventStringifier::processIrcEvent329(IrcEvent *e) {
+  if(!checkParamCount(e, 2))
+    return;
+
+  QString channel = e->params()[0];
+  uint unixtime = e->params()[1].toUInt();
+  if(!unixtime) {
+    qWarning() << Q_FUNC_INFO << "received invalid timestamp:" << e->params()[1];
+    return;
+  }
+  QDateTime time = QDateTime::fromTime_t(unixtime);
+  displayMsg(e, Message::Topic, tr("Channel %1 created on %2").arg(channel, time.toString()), QString(), channel);
+}
+
+/*  RPL_WHOISACCOUNT: "<nick> <account> :is authed as */
+void EventStringifier::processIrcEvent330(IrcEvent *e) {
+  if(e->params().count() < 3)
+    return;
+
+  // check for whois or whowas
+  if (_whois) {
+    displayMsg(e, Message::Server, tr("[Whois] %1 is authed as %2").arg(e->params()[0], e->params()[1]));
+  } else {
+    displayMsg(e, Message::Server, tr("[Whowas] %1 was authed as %2").arg(e->params()[0], e->params()[1]));
+  }
+}
+
+/* RPL_NOTOPIC */
+void EventStringifier::processIrcEvent331(IrcEvent *e) {
+  QString channel = e->params().first();
+  displayMsg(e, Message::Topic, tr("No topic is set for %1.").arg(channel), QString(), channel);
+}
+
+/* RPL_TOPIC */
+void EventStringifier::processIrcEvent332(IrcEvent *e) {
+  QString channel = e->params().first();
+  displayMsg(e, Message::Topic, tr("Topic for %1 is \"%2\"").arg(channel, e->params()[1]), QString(), channel);
+}
+
+/* Topic set by... */
+void EventStringifier::processIrcEvent333(IrcEvent *e) {
+  if(!checkParamCount(e, 3))
+    return;
+
+  QString channel = e->params().first();
+  displayMsg(e, Message::Topic, tr("Topic set by %1 on %2")
+             .arg(e->params()[1], QDateTime::fromTime_t(e->params()[2].toInt()).toString()), QString(), channel);
+}
+
+/* RPL_INVITING - "<nick> <channel>*/
+void EventStringifier::processIrcEvent341(IrcEvent *e) {
+  if(!checkParamCount(e, 2))
+    return;
+
+  QString channel = e->params()[1];
+  displayMsg(e, Message::Server, tr("%1 has been invited to %2").arg(e->params().first(), channel), QString(), channel);
+}
+
+/*  RPL_WHOREPLY: "<channel> <user> <host> <server> <nick>
+              ( "H" / "G" > ["*"] [ ( "@" / "+" ) ] :<hopcount> <real name>" */
+void EventStringifier::processIrcEvent352(IrcEvent *e) {
+  displayMsg(e, Message::Server, tr("[Who] %1").arg(e->params().join(" ")));
+}
+
+/*  RPL_ENDOFWHOWAS - "<nick> :End of WHOWAS" */
+void EventStringifier::processIrcEvent369(IrcEvent *e) {
+  displayMsg(e, Message::Server, tr("End of /WHOWAS"));
+}
+
+/* ERR_ERRONEUSNICKNAME */
+void EventStringifier::processIrcEvent432(IrcEvent *e) {
+  if(!checkParamCount(e, 1))
+    return;
+
+  displayMsg(e, Message::Error, tr("Nick %1 contains illegal characters").arg(e->params()[0]));
+}
+
+/* ERR_NICKNAMEINUSE */
+void EventStringifier::processIrcEvent433(IrcEvent *e) {
+  if(!checkParamCount(e, 1))
+    return;
+
+  displayMsg(e, Message::Error, tr("Nick already in use: %1").arg(e->params()[0]));
+}
+
+/* ERR_UNAVAILRESOURCE */
+void EventStringifier::processIrcEvent437(IrcEvent *e) {
+  if(!checkParamCount(e, 1))
+    return;
+
+  displayMsg(e, Message::Error, tr("Nick/channel is temporarily unavailable: %1").arg(e->params()[0]));
+}
+
+// template
+/*
+
+void EventStringifier::processIrcEvent(IrcEvent *e) {
+
+}
+
+*/
+
+/*******************************/
+/******** CTCP HANDLING ********/
+/*******************************/
+
+void EventStringifier::processCtcpEvent(CtcpEvent *e) {
+  if(e->type() != EventManager::CtcpEvent)
+    return;
+
+  if(e->testFlag(EventManager::Self)) {
+    displayMsg(e, Message::Action, tr("sending CTCP-%1 request to %2").arg(e->ctcpCmd(), e->target()), e->network()->myNick());
+    return;
+  }
+
+  handle(e->ctcpCmd(), Q_ARG(CtcpEvent *, e));
+}
+
+void EventStringifier::defaultHandler(const QString &ctcpCmd, CtcpEvent *e) {
+  Q_UNUSED(ctcpCmd);
+  if(e->ctcpType() == CtcpEvent::Query) {
+    QString unknown;
+    if(e->reply().isNull()) // all known core-side handlers (except for ACTION) set a reply!
+      //: Optional "unknown" in "Received unknown CTCP-FOO request by bar"
+      unknown = tr("unknown") + ' ';
+    displayMsg(e, Message::Server, tr("Received %1CTCP-%2 request by %3").arg(unknown, e->ctcpCmd(), e->prefix()));
+    return;
+  }
+  displayMsg(e, Message::Server, tr("Received CTCP-%1 answer from %2: %3").arg(e->ctcpCmd(), nickFromMask(e->prefix()), e->param()));
+}
+
+void EventStringifier::handleCtcpAction(CtcpEvent *e) {
+  displayMsg(e, Message::Action, e->param(), e->prefix(), e->target());
+}
+
+void EventStringifier::handleCtcpPing(CtcpEvent *e) {
+  if(e->ctcpType() == CtcpEvent::Query)
+    defaultHandler(e->ctcpCmd(), e);
+  else {
+    displayMsg(e, Message::Server, tr("Received CTCP-PING answer from %1 with %2 seconds round trip time")
+               .arg(nickFromMask(e->prefix())).arg(QDateTime::fromTime_t(e->param().toInt()).secsTo(e->timestamp())));
+  }
 }