1 /***************************************************************************
2 * Copyright (C) 2005-2012 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
21 #include "eventstringifier.h"
23 #include "coresession.h"
24 #include "ctcpevent.h"
25 #include "messageevent.h"
27 EventStringifier::EventStringifier(CoreSession *parent) : BasicHandler("handleCtcp", parent),
31 connect(this, SIGNAL(newMessageEvent(Event *)), coreSession()->eventManager(), SLOT(postEvent(Event *)));
35 void EventStringifier::displayMsg(NetworkEvent *event, Message::Type msgType, const QString &msg, const QString &sender,
36 const QString &target, Message::Flags msgFlags)
38 if (event->flags().testFlag(EventManager::Silent))
41 MessageEvent *msgEvent = createMessageEvent(event, msgType, msg, sender, target, msgFlags);
42 //sendMessageEvent(msgEvent);
43 emit newMessageEvent(msgEvent);
47 MessageEvent *EventStringifier::createMessageEvent(NetworkEvent *event, Message::Type msgType, const QString &msg, const QString &sender,
48 const QString &target, Message::Flags msgFlags)
50 MessageEvent *msgEvent = new MessageEvent(msgType, event->network(), msg, sender, target, msgFlags);
51 msgEvent->setTimestamp(event->timestamp());
56 bool EventStringifier::checkParamCount(IrcEvent *e, int minParams)
58 if (e->params().count() < minParams) {
59 if (e->type() == EventManager::IrcEventNumeric) {
60 qWarning() << "Command " << static_cast<IrcEventNumeric *>(e)->number() << " requires " << minParams << "params, got: " << e->params();
63 QString name = coreSession()->eventManager()->enumName(e->type());
64 qWarning() << qPrintable(name) << "requires" << minParams << "params, got:" << e->params();
73 /* These are only for legacy reasons; remove as soon as we handle NetworkSplitEvents properly */
74 void EventStringifier::processNetworkSplitJoin(NetworkSplitEvent *e)
76 QString msg = e->users().join("#:#") + "#:#" + e->quitMessage();
77 displayMsg(e, Message::NetsplitJoin, msg, QString(), e->channel());
81 void EventStringifier::processNetworkSplitQuit(NetworkSplitEvent *e)
83 QString msg = e->users().join("#:#") + "#:#" + e->quitMessage();
84 displayMsg(e, Message::NetsplitQuit, msg, QString(), e->channel());
90 void EventStringifier::processIrcEventNumeric(IrcEventNumeric *e)
92 //qDebug() << e->number();
93 switch (e->number()) {
94 // Welcome, status, info messages. Just display these.
111 displayMsg(e, Message::Server, e->params().join(" "), e->prefix());
114 // Server error messages without param, just display them
135 case 431: // ERR_NONICKNAMEGIVEN
136 displayMsg(e, Message::Error, e->params().join(" "), e->prefix());
139 // Server error messages, display them in red. Colon between first param and rest.
142 if (!checkParamCount(e, 1))
145 QStringList params = e->params();
146 QString target = params.takeFirst();
147 displayMsg(e, Message::Error, target + ": " + params.join(" "), e->prefix(), target, Message::Redirected);
160 if (!checkParamCount(e, 1))
163 QStringList params = e->params();
164 QString channelName = params.takeFirst();
165 displayMsg(e, Message::Error, channelName + ": " + params.join(" "), e->prefix());
169 // Server error messages which will be displayed with a colon between the first param and the rest
175 case 461: // FIXME see below for the 47x codes
185 case 436: // ERR_NICKCOLLISION
187 if (!checkParamCount(e, 1))
190 QStringList params = e->params();
191 QString p = params.takeFirst();
192 displayMsg(e, Message::Error, p + ": " + params.join(" "));
196 // Ignore these commands.
211 displayMsg(e, Message::Info, "CAP: " + e->params().join(""));
215 // Everything else will be marked in red, so we can add them somewhere.
218 // many nets define their own WHOIS fields. we fetch those not in need of special attention here:
219 displayMsg(e, Message::Server, tr("[Whois] ") + e->params().join(" "), e->prefix());
222 // FIXME figure out how/where to do this in the future
223 //if(coreSession()->ircListHelper()->requestInProgress(network()->networkId()))
224 // coreSession()->ircListHelper()->reportError(params.join(" "));
226 displayMsg(e, Message::Error, QString("%1 %2").arg(e->number(), 3, 10, QLatin1Char('0')).arg(e->params().join(" ")), e->prefix());
232 void EventStringifier::processIrcEventInvite(IrcEvent *e)
234 displayMsg(e, Message::Invite, tr("%1 invited you to channel %2").arg(e->nick(), e->params().at(1)));
238 void EventStringifier::processIrcEventJoin(IrcEvent *e)
240 if (e->testFlag(EventManager::Netsplit))
243 displayMsg(e, Message::Join, e->params()[0], e->prefix(), e->params()[0]);
247 void EventStringifier::processIrcEventKick(IrcEvent *e)
249 if (!checkParamCount(e, 2))
252 IrcUser *victim = e->network()->ircUser(e->params().at(1));
254 QString channel = e->params().at(0);
255 QString msg = victim->nick();
256 if (e->params().count() > 2)
257 msg += " " + e->params().at(2);
259 displayMsg(e, Message::Kick, msg, e->prefix(), channel);
264 void EventStringifier::processIrcEventMode(IrcEvent *e)
266 if (e->network()->isChannelName(e->params().first())) {
268 displayMsg(e, Message::Mode, e->params().join(" "), e->prefix(), e->params().first());
273 displayMsg(e, Message::Mode, e->params().join(" "), e->prefix());
278 // this needs to be called before the ircuser is renamed!
279 void EventStringifier::processIrcEventNick(IrcEvent *e)
281 if (!checkParamCount(e, 1))
284 IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
286 qWarning() << Q_FUNC_INFO << "Unknown IrcUser!";
290 QString newnick = e->params().at(0);
291 QString oldnick = ircuser->nick();
293 QString sender = e->network()->isMyNick(oldnick) ? newnick : e->prefix();
294 foreach(const QString &channel, ircuser->channels())
295 displayMsg(e, Message::Nick, newnick, sender, channel);
299 void EventStringifier::processIrcEventPart(IrcEvent *e)
301 if (!checkParamCount(e, 1))
304 QString channel = e->params().at(0);
305 QString msg = e->params().count() > 1 ? e->params().at(1) : QString();
307 displayMsg(e, Message::Part, msg, e->prefix(), channel);
311 void EventStringifier::processIrcEventPong(IrcEvent *e)
313 QString timestamp = e->params().at(1);
314 QTime sendTime = QTime::fromString(timestamp, "hh:mm:ss.zzz");
315 if (!sendTime.isValid())
316 displayMsg(e, Message::Server, "PONG " + e->params().join(" "), e->prefix());
320 void EventStringifier::processIrcEventQuit(IrcEvent *e)
322 if (e->testFlag(EventManager::Netsplit))
325 IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
329 foreach(const QString &channel, ircuser->channels())
330 displayMsg(e, Message::Quit, e->params().count() ? e->params().first() : QString(), e->prefix(), channel);
334 void EventStringifier::processIrcEventTopic(IrcEvent *e)
336 displayMsg(e, Message::Topic, tr("%1 has changed topic for %2 to: \"%3\"")
337 .arg(e->nick(), e->params().at(0), e->params().at(1)), QString(), e->params().at(0));
342 void EventStringifier::processIrcEvent005(IrcEvent *e)
344 if (!e->params().last().contains(QRegExp("are supported (by|on) this server")))
345 displayMsg(e, Message::Error, tr("Received non-RFC-compliant RPL_ISUPPORT: this can lead to unexpected behavior!"), e->prefix());
346 displayMsg(e, Message::Server, e->params().join(" "), e->prefix());
350 /* RPL_AWAY - "<nick> :<away message>" */
351 void EventStringifier::processIrcEvent301(IrcEvent *e)
353 QString nick = e->params().at(0);
354 QString awayMsg = e->params().at(1);
358 // FIXME: proper redirection needed
360 msg = tr("[Whois] ");
364 IrcUser *ircuser = e->network()->ircUser(nick);
366 int now = QDateTime::currentDateTime().toTime_t();
367 const int silenceTime = 60;
368 if (ircuser->lastAwayMessage() + silenceTime >= now)
370 ircuser->setLastAwayMessage(now);
374 displayMsg(e, Message::Server, msg + tr("%1 is away: \"%2\"").arg(nick, awayMsg), QString(), target);
378 /* RPL_UNAWAY - ":You are no longer marked as being away" */
379 void EventStringifier::processIrcEvent305(IrcEvent *e)
381 displayMsg(e, Message::Server, tr("You are no longer marked as being away"));
385 /* RPL_NOWAWAY - ":You have been marked as being away" */
386 void EventStringifier::processIrcEvent306(IrcEvent *e)
388 if (!e->network()->autoAwayActive())
389 displayMsg(e, Message::Server, tr("You have been marked as being away"));
395 Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message.
397 "<nick> :<away message>"
399 Replies 352 and 315 paired are used to answer a WHO message.
402 Replies 314 and 369 are responses to a WHOWAS message.
406 /* RPL_WHOISUSER - "<nick> <user> <host> * :<real name>" */
407 void EventStringifier::processIrcEvent311(IrcEvent *e)
411 const QString whoisUserString = tr("[Whois] %1 is %2 (%3)");
413 IrcUser *ircuser = e->network()->ircUser(e->params().at(0));
415 displayMsg(e, Message::Server, whoisUserString.arg(ircuser->nick(), ircuser->hostmask(), ircuser->realName()));
417 QString host = QString("%1!%2@%3").arg(e->params().at(0), e->params().at(1), e->params().at(2));
418 displayMsg(e, Message::Server, whoisUserString.arg(e->params().at(0), host, e->params().last()));
423 /* RPL_WHOISSERVER - "<nick> <server> :<server info>" */
424 void EventStringifier::processIrcEvent312(IrcEvent *e)
427 displayMsg(e, Message::Server, tr("[Whois] %1 is online via %2 (%3)").arg(e->params().at(0), e->params().at(1), e->params().last()));
429 displayMsg(e, Message::Server, tr("[Whowas] %1 was online via %2 (%3)").arg(e->params().at(0), e->params().at(1), e->params().last()));
433 /* RPL_WHOWASUSER - "<nick> <user> <host> * :<real name>" */
434 void EventStringifier::processIrcEvent314(IrcEvent *e)
436 if (!checkParamCount(e, 3))
439 displayMsg(e, Message::Server, tr("[Whowas] %1 was %2@%3 (%4)").arg(e->params()[0], e->params()[1], e->params()[2], e->params().last()));
443 /* RPL_ENDOFWHO: "<name> :End of WHO list" */
444 void EventStringifier::processIrcEvent315(IrcEvent *e)
446 QStringList p = e->params();
447 p.takeLast(); // should be "End of WHO list"
448 displayMsg(e, Message::Server, tr("[Who] End of /WHO list for %1").arg(p.join(" ")));
452 /* RPL_WHOISIDLE - "<nick> <integer> :seconds idle"
453 (real life: "<nick> <integer> <integer> :seconds idle, signon time) */
454 void EventStringifier::processIrcEvent317(IrcEvent *e)
456 int idleSecs = e->params()[1].toInt();
458 if (e->params().count() > 3) { // if we have more then 3 params we have the above mentioned "real life" situation
459 QDateTime loginTime = QDateTime::fromTime_t(e->params()[2].toInt());
460 displayMsg(e, Message::Server, tr("[Whois] %1 is logged in since %2")
461 .arg(e->params()[0], QLocale().toString(loginTime, QLocale().dateTimeFormat())));
463 QDateTime idlingSince = e->timestamp().toLocalTime().addSecs(-idleSecs);
464 displayMsg(e, Message::Server, tr("[Whois] %1 is idling for %2 (since %3)")
465 .arg(e->params()[0], secondsToString(idleSecs),
466 QLocale().toString(idlingSince, QLocale().dateTimeFormat())));
470 /* RPL_ENDOFWHOIS - "<nick> :End of WHOIS list" */
471 void EventStringifier::processIrcEvent318(IrcEvent *e)
474 displayMsg(e, Message::Server, tr("[Whois] End of /WHOIS list"));
478 /* RPL_WHOISCHANNELS - "<nick> :*( ( "@" / "+" ) <channel> " " )" */
479 void EventStringifier::processIrcEvent319(IrcEvent *e)
481 if (!checkParamCount(e, 2))
484 QString nick = e->params().first();
488 foreach(QString channel, e->params().last().split(" ")) {
489 if (channel.startsWith("@"))
490 op.append(channel.remove(0, 1));
491 else if (channel.startsWith("+"))
492 voice.append(channel.remove(0, 1));
494 user.append(channel);
497 displayMsg(e, Message::Server, tr("[Whois] %1 is a user on channels: %2").arg(nick, user.join(" ")));
498 if (!voice.isEmpty())
499 displayMsg(e, Message::Server, tr("[Whois] %1 has voice on channels: %2").arg(nick, voice.join(" ")));
501 displayMsg(e, Message::Server, tr("[Whois] %1 is an operator on channels: %2").arg(nick, op.join(" ")));
505 /* RPL_LIST - "<channel> <# visible> :<topic>" */
506 void EventStringifier::processIrcEvent322(IrcEvent *e)
509 quint32 userCount = 0;
512 switch (e->params().count()) {
514 topic = e->params()[2];
516 userCount = e->params()[1].toUInt();
518 channelName = e->params()[0];
522 displayMsg(e, Message::Server, tr("Channel %1 has %2 users. Topic is: \"%3\"")
523 .arg(channelName).arg(userCount).arg(topic));
527 /* RPL_LISTEND ":End of LIST" */
528 void EventStringifier::processIrcEvent323(IrcEvent *e)
530 displayMsg(e, Message::Server, tr("End of channel list"));
534 /* RPL_CHANNELMODEIS - "<channel> <mode> <mode params>" */
535 void EventStringifier::processIrcEvent324(IrcEvent *e)
537 processIrcEventMode(e);
541 /* RPL_??? - "<channel> <homepage> */
542 void EventStringifier::processIrcEvent328(IrcEvent *e)
544 if (!checkParamCount(e, 2))
547 QString channel = e->params()[0];
548 displayMsg(e, Message::Topic, tr("Homepage for %1 is %2").arg(channel, e->params()[1]), QString(), channel);
552 /* RPL_??? - "<channel> <creation time (unix)>" */
553 void EventStringifier::processIrcEvent329(IrcEvent *e)
555 if (!checkParamCount(e, 2))
558 QString channel = e->params()[0];
559 uint unixtime = e->params()[1].toUInt();
561 qWarning() << Q_FUNC_INFO << "received invalid timestamp:" << e->params()[1];
564 QDateTime time = QDateTime::fromTime_t(unixtime);
565 displayMsg(e, Message::Topic, tr("Channel %1 created on %2")
566 .arg(channel, QLocale().toString(time, QLocale().dateTimeFormat())),
571 /* RPL_WHOISACCOUNT: "<nick> <account> :is authed as */
572 void EventStringifier::processIrcEvent330(IrcEvent *e)
574 if (e->params().count() < 3)
577 // check for whois or whowas
579 displayMsg(e, Message::Server, tr("[Whois] %1 is authed as %2").arg(e->params()[0], e->params()[1]));
582 displayMsg(e, Message::Server, tr("[Whowas] %1 was authed as %2").arg(e->params()[0], e->params()[1]));
588 void EventStringifier::processIrcEvent331(IrcEvent *e)
590 QString channel = e->params().first();
591 displayMsg(e, Message::Topic, tr("No topic is set for %1.").arg(channel), QString(), channel);
596 void EventStringifier::processIrcEvent332(IrcEvent *e)
598 QString channel = e->params().first();
599 displayMsg(e, Message::Topic, tr("Topic for %1 is \"%2\"").arg(channel, e->params()[1]), QString(), channel);
603 /* Topic set by... */
604 void EventStringifier::processIrcEvent333(IrcEvent *e)
606 if (!checkParamCount(e, 3))
609 QString channel = e->params().first();
610 QDateTime topicSetTime = QDateTime::fromTime_t(e->params()[2].toInt());
611 displayMsg(e, Message::Topic, tr("Topic set by %1 on %2")
613 QLocale().toString(topicSetTime, QLocale().dateTimeFormat()), QString(), channel));
617 /* RPL_INVITING - "<nick> <channel>*/
618 void EventStringifier::processIrcEvent341(IrcEvent *e)
620 if (!checkParamCount(e, 2))
623 QString channel = e->params()[1];
624 displayMsg(e, Message::Server, tr("%1 has been invited to %2").arg(e->params().first(), channel), QString(), channel);
628 /* RPL_WHOREPLY: "<channel> <user> <host> <server> <nick>
629 ( "H" / "G" > ["*"] [ ( "@" / "+" ) ] :<hopcount> <real name>" */
630 void EventStringifier::processIrcEvent352(IrcEvent *e)
632 displayMsg(e, Message::Server, tr("[Who] %1").arg(e->params().join(" ")));
636 /* RPL_ENDOFWHOWAS - "<nick> :End of WHOWAS" */
637 void EventStringifier::processIrcEvent369(IrcEvent *e)
639 displayMsg(e, Message::Server, tr("End of /WHOWAS"));
643 /* ERR_ERRONEUSNICKNAME */
644 void EventStringifier::processIrcEvent432(IrcEvent *e)
646 if (!checkParamCount(e, 1))
649 displayMsg(e, Message::Error, tr("Nick %1 contains illegal characters").arg(e->params()[0]));
653 /* ERR_NICKNAMEINUSE */
654 void EventStringifier::processIrcEvent433(IrcEvent *e)
656 if (!checkParamCount(e, 1))
659 displayMsg(e, Message::Error, tr("Nick already in use: %1").arg(e->params()[0]));
663 /* ERR_UNAVAILRESOURCE */
664 void EventStringifier::processIrcEvent437(IrcEvent *e)
666 if (!checkParamCount(e, 1))
669 displayMsg(e, Message::Error, tr("Nick/channel is temporarily unavailable: %1").arg(e->params()[0]));
676 void EventStringifier::processIrcEvent(IrcEvent *e) {
682 /*******************************/
683 /******** CTCP HANDLING ********/
684 /*******************************/
686 void EventStringifier::processCtcpEvent(CtcpEvent *e)
688 if (e->type() != EventManager::CtcpEvent)
691 if (e->testFlag(EventManager::Self)) {
692 displayMsg(e, Message::Action, tr("sending CTCP-%1 request to %2").arg(e->ctcpCmd(), e->target()), e->network()->myNick());
696 handle(e->ctcpCmd(), Q_ARG(CtcpEvent *, e));
700 void EventStringifier::defaultHandler(const QString &ctcpCmd, CtcpEvent *e)
703 if (e->ctcpType() == CtcpEvent::Query) {
705 if (e->reply().isNull()) // all known core-side handlers (except for ACTION) set a reply!
706 //: Optional "unknown" in "Received unknown CTCP-FOO request by bar"
707 unknown = tr("unknown") + ' ';
708 displayMsg(e, Message::Server, tr("Received %1CTCP-%2 request by %3").arg(unknown, e->ctcpCmd(), e->prefix()));
711 displayMsg(e, Message::Server, tr("Received CTCP-%1 answer from %2: %3").arg(e->ctcpCmd(), nickFromMask(e->prefix()), e->param()));
715 void EventStringifier::handleCtcpAction(CtcpEvent *e)
717 displayMsg(e, Message::Action, e->param(), e->prefix(), e->target());
721 void EventStringifier::handleCtcpPing(CtcpEvent *e)
723 if (e->ctcpType() == CtcpEvent::Query)
724 defaultHandler(e->ctcpCmd(), e);
726 displayMsg(e, Message::Server, tr("Received CTCP-PING answer from %1 with %2 seconds round trip time")
727 .arg(nickFromMask(e->prefix())).arg(QDateTime::fromTime_t(e->param().toInt()).secsTo(e->timestamp())));