1 /***************************************************************************
2 * Copyright (C) 2005-2016 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.
115 displayMsg(e, Message::Server, e->params().join(" "), e->prefix());
118 // Server error messages without param, just display them
140 case 431: // ERR_NONICKNAMEGIVEN
141 displayMsg(e, Message::Error, e->params().join(" "), e->prefix());
144 // Server error messages, display them in red. Colon between first param and rest.
147 if (!checkParamCount(e, 1))
150 QStringList params = e->params();
151 QString target = params.takeFirst();
152 displayMsg(e, Message::Error, target + ": " + params.join(" "), e->prefix(), target, Message::Redirected);
165 if (!checkParamCount(e, 1))
168 QStringList params = e->params();
169 QString channelName = params.takeFirst();
170 displayMsg(e, Message::Error, channelName + ": " + params.join(" "), e->prefix());
174 // Server error messages which will be displayed with a colon between the first param and the rest
180 case 461: // FIXME see below for the 47x codes
190 case 436: // ERR_NICKCOLLISION
192 if (!checkParamCount(e, 1))
195 QStringList params = e->params();
196 QString p = params.takeFirst();
197 displayMsg(e, Message::Error, p + ": " + params.join(" "));
201 // Ignore these commands.
208 // SASL authentication stuff
209 // See: http://ircv3.net/specs/extensions/sasl-3.1.html
210 case 900: // RPL_LOGGEDIN
211 case 901: // RPL_LOGGEDOUT
213 // :server 900 <nick> <nick>!<ident>@<host> <account> :You are now logged in as <user>
214 // :server 901 <nick> <nick>!<ident>@<host> :You are now logged out
215 if (!checkParamCount(e, 3))
217 displayMsg(e, Message::Server, "SASL: " + e->params().at(2));
220 // Ignore SASL success, partially redundant with RPL_LOGGEDIN and RPL_LOGGEDOUT
221 case 903: // RPL_SASLSUCCESS :server 903 <nick> :SASL authentication successful
223 case 902: // ERR_NICKLOCKED :server 902 <nick> :You must use a nick assigned to you
224 case 904: // ERR_SASLFAIL :server 904 <nick> :SASL authentication failed
225 case 905: // ERR_SASLTOOLONG :server 905 <nick> :SASL message too long
226 case 906: // ERR_SASLABORTED :server 906 <nick> :SASL authentication aborted
227 case 907: // ERR_SASLALREADY :server 907 <nick> :You have already authenticated using SASL
228 case 908: // RPL_SASLMECHS :server 908 <nick> <mechanisms> :are available SASL mechanisms
230 displayMsg(e, Message::Server, "SASL: " + e->params().join(""));
234 // Everything else will be marked in red, so we can add them somewhere.
237 // many nets define their own WHOIS fields. we fetch those not in need of special attention here:
238 displayMsg(e, Message::Server, tr("[Whois] ") + e->params().join(" "), e->prefix());
241 // FIXME figure out how/where to do this in the future
242 //if(coreSession()->ircListHelper()->requestInProgress(network()->networkId()))
243 // coreSession()->ircListHelper()->reportError(params.join(" "));
245 displayMsg(e, Message::Error, QString("%1 %2").arg(e->number(), 3, 10, QLatin1Char('0')).arg(e->params().join(" ")), e->prefix());
251 void EventStringifier::processIrcEventInvite(IrcEvent *e)
253 displayMsg(e, Message::Invite, tr("%1 invited you to channel %2").arg(e->nick(), e->params().at(1)));
257 void EventStringifier::processIrcEventJoin(IrcEvent *e)
259 if (e->testFlag(EventManager::Netsplit))
262 displayMsg(e, Message::Join, e->params()[0], e->prefix(), e->params()[0]);
266 void EventStringifier::processIrcEventKick(IrcEvent *e)
268 if (!checkParamCount(e, 2))
271 IrcUser *victim = e->network()->ircUser(e->params().at(1));
273 QString channel = e->params().at(0);
274 QString msg = victim->nick();
275 if (e->params().count() > 2)
276 msg += " " + e->params().at(2);
278 displayMsg(e, Message::Kick, msg, e->prefix(), channel);
283 void EventStringifier::processIrcEventMode(IrcEvent *e)
285 if (e->network()->isChannelName(e->params().first())) {
287 displayMsg(e, Message::Mode, e->params().join(" "), e->prefix(), e->params().first());
292 displayMsg(e, Message::Mode, e->params().join(" "), e->prefix());
297 // this needs to be called before the ircuser is renamed!
298 void EventStringifier::processIrcEventNick(IrcEvent *e)
300 if (!checkParamCount(e, 1))
303 IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
305 qWarning() << Q_FUNC_INFO << "Unknown IrcUser!";
309 QString newnick = e->params().at(0);
310 QString oldnick = ircuser->nick();
312 QString sender = e->network()->isMyNick(oldnick) ? newnick : e->prefix();
313 foreach(const QString &channel, ircuser->channels())
314 displayMsg(e, Message::Nick, newnick, sender, channel);
318 void EventStringifier::processIrcEventPart(IrcEvent *e)
320 if (!checkParamCount(e, 1))
323 QString channel = e->params().at(0);
324 QString msg = e->params().count() > 1 ? e->params().at(1) : QString();
326 displayMsg(e, Message::Part, msg, e->prefix(), channel);
330 void EventStringifier::processIrcEventPong(IrcEvent *e)
332 QString timestamp = e->params().at(1);
333 QTime sendTime = QTime::fromString(timestamp, "hh:mm:ss.zzz");
334 if (!sendTime.isValid())
335 displayMsg(e, Message::Server, "PONG " + e->params().join(" "), e->prefix());
339 void EventStringifier::processIrcEventQuit(IrcEvent *e)
341 if (e->testFlag(EventManager::Netsplit))
344 IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
348 foreach(const QString &channel, ircuser->channels())
349 displayMsg(e, Message::Quit, e->params().count() ? e->params().first() : QString(), e->prefix(), channel);
353 void EventStringifier::processIrcEventTopic(IrcEvent *e)
355 displayMsg(e, Message::Topic, tr("%1 has changed topic for %2 to: \"%3\"")
356 .arg(e->nick(), e->params().at(0), e->params().at(1)), QString(), e->params().at(0));
359 void EventStringifier::processIrcEventError(IrcEvent *e)
361 // Need an error reason
362 if (!checkParamCount(e, 1))
365 displayMsg(e, Message::Server, tr("Error from server: ") + e->params().join(""));
368 void EventStringifier::processIrcEventWallops(IrcEvent *e)
370 displayMsg(e, Message::Server, tr("[Operwall] %1: %2").arg(e->nick(), e->params().join(" ")));
375 void EventStringifier::processIrcEvent005(IrcEvent *e)
377 if (!e->params().last().contains(QRegExp("are supported (by|on) this server")))
378 displayMsg(e, Message::Error, tr("Received non-RFC-compliant RPL_ISUPPORT: this can lead to unexpected behavior!"), e->prefix());
379 displayMsg(e, Message::Server, e->params().join(" "), e->prefix());
383 /* RPL_AWAY - "<nick> :<away message>" */
384 void EventStringifier::processIrcEvent301(IrcEvent *e)
386 QString nick = e->params().at(0);
387 QString awayMsg = e->params().at(1);
391 // FIXME: proper redirection needed
393 msg = tr("[Whois] ");
397 IrcUser *ircuser = e->network()->ircUser(nick);
399 int now = QDateTime::currentDateTime().toTime_t();
400 const int silenceTime = 60;
401 if (ircuser->lastAwayMessage() + silenceTime >= now)
403 ircuser->setLastAwayMessage(now);
407 displayMsg(e, Message::Server, msg + tr("%1 is away: \"%2\"").arg(nick, awayMsg), QString(), target);
411 /* RPL_UNAWAY - ":You are no longer marked as being away" */
412 void EventStringifier::processIrcEvent305(IrcEvent *e)
414 displayMsg(e, Message::Server, tr("You are no longer marked as being away"));
418 /* RPL_NOWAWAY - ":You have been marked as being away" */
419 void EventStringifier::processIrcEvent306(IrcEvent *e)
421 if (!e->network()->autoAwayActive())
422 displayMsg(e, Message::Server, tr("You have been marked as being away"));
428 Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message.
430 "<nick> :<away message>"
432 Replies 352 and 315 paired are used to answer a WHO message.
435 Replies 314 and 369 are responses to a WHOWAS message.
439 /* RPL_WHOISUSER - "<nick> <user> <host> * :<real name>" */
440 void EventStringifier::processIrcEvent311(IrcEvent *e)
444 const QString whoisUserString = tr("[Whois] %1 is %2 (%3)");
446 IrcUser *ircuser = e->network()->ircUser(e->params().at(0));
448 displayMsg(e, Message::Server, whoisUserString.arg(ircuser->nick(), ircuser->hostmask(), ircuser->realName()));
450 QString host = QString("%1!%2@%3").arg(e->params().at(0), e->params().at(1), e->params().at(2));
451 displayMsg(e, Message::Server, whoisUserString.arg(e->params().at(0), host, e->params().last()));
456 /* RPL_WHOISSERVER - "<nick> <server> :<server info>" */
457 void EventStringifier::processIrcEvent312(IrcEvent *e)
460 displayMsg(e, Message::Server, tr("[Whois] %1 is online via %2 (%3)").arg(e->params().at(0), e->params().at(1), e->params().last()));
462 displayMsg(e, Message::Server, tr("[Whowas] %1 was online via %2 (%3)").arg(e->params().at(0), e->params().at(1), e->params().last()));
466 /* RPL_WHOWASUSER - "<nick> <user> <host> * :<real name>" */
467 void EventStringifier::processIrcEvent314(IrcEvent *e)
469 if (!checkParamCount(e, 3))
472 displayMsg(e, Message::Server, tr("[Whowas] %1 was %2@%3 (%4)").arg(e->params()[0], e->params()[1], e->params()[2], e->params().last()));
476 /* RPL_ENDOFWHO: "<name> :End of WHO list" */
477 void EventStringifier::processIrcEvent315(IrcEvent *e)
479 QStringList p = e->params();
480 p.takeLast(); // should be "End of WHO list"
481 displayMsg(e, Message::Server, tr("[Who] End of /WHO list for %1").arg(p.join(" ")));
485 /* RPL_WHOISIDLE - "<nick> <integer> :seconds idle"
486 (real life: "<nick> <integer> <integer> :seconds idle, signon time) */
487 void EventStringifier::processIrcEvent317(IrcEvent *e)
489 int idleSecs = e->params()[1].toInt();
491 if (e->params().count() > 3) { // if we have more then 3 params we have the above mentioned "real life" situation
492 QDateTime loginTime = QDateTime::fromTime_t(e->params()[2].toInt()).toUTC();
493 displayMsg(e, Message::Server, tr("[Whois] %1 is logged in since %2")
494 .arg(e->params()[0], loginTime.toString("yyyy-MM-dd hh:mm:ss UTC")));
496 QDateTime idlingSince = e->timestamp().toLocalTime().addSecs(-idleSecs).toUTC();
497 displayMsg(e, Message::Server, tr("[Whois] %1 is idling for %2 (since %3)")
498 .arg(e->params()[0], secondsToString(idleSecs),
499 idlingSince.toString("yyyy-MM-dd hh:mm:ss UTC")));
503 /* RPL_ENDOFWHOIS - "<nick> :End of WHOIS list" */
504 void EventStringifier::processIrcEvent318(IrcEvent *e)
507 displayMsg(e, Message::Server, tr("[Whois] End of /WHOIS list"));
511 /* RPL_WHOISCHANNELS - "<nick> :*( ( "@" / "+" ) <channel> " " )" */
512 void EventStringifier::processIrcEvent319(IrcEvent *e)
514 if (!checkParamCount(e, 2))
517 QString nick = e->params().first();
521 foreach(QString channel, e->params().last().split(" ")) {
522 if (channel.startsWith("@"))
523 op.append(channel.remove(0, 1));
524 else if (channel.startsWith("+"))
525 voice.append(channel.remove(0, 1));
527 user.append(channel);
530 displayMsg(e, Message::Server, tr("[Whois] %1 is a user on channels: %2").arg(nick, user.join(" ")));
531 if (!voice.isEmpty())
532 displayMsg(e, Message::Server, tr("[Whois] %1 has voice on channels: %2").arg(nick, voice.join(" ")));
534 displayMsg(e, Message::Server, tr("[Whois] %1 is an operator on channels: %2").arg(nick, op.join(" ")));
538 /* RPL_LIST - "<channel> <# visible> :<topic>" */
539 void EventStringifier::processIrcEvent322(IrcEvent *e)
542 quint32 userCount = 0;
545 switch (e->params().count()) {
547 topic = e->params()[2];
549 userCount = e->params()[1].toUInt();
551 channelName = e->params()[0];
555 displayMsg(e, Message::Server, tr("Channel %1 has %2 users. Topic is: \"%3\"")
556 .arg(channelName).arg(userCount).arg(topic));
560 /* RPL_LISTEND ":End of LIST" */
561 void EventStringifier::processIrcEvent323(IrcEvent *e)
563 displayMsg(e, Message::Server, tr("End of channel list"));
567 /* RPL_CHANNELMODEIS - "<channel> <mode> <mode params>" */
568 void EventStringifier::processIrcEvent324(IrcEvent *e)
570 processIrcEventMode(e);
574 /* RPL_??? - "<channel> <homepage> */
575 void EventStringifier::processIrcEvent328(IrcEvent *e)
577 if (!checkParamCount(e, 2))
580 QString channel = e->params()[0];
581 displayMsg(e, Message::Topic, tr("Homepage for %1 is %2").arg(channel, e->params()[1]), QString(), channel);
585 /* RPL_??? - "<channel> <creation time (unix)>" */
586 void EventStringifier::processIrcEvent329(IrcEvent *e)
588 if (!checkParamCount(e, 2))
591 QString channel = e->params()[0];
592 uint unixtime = e->params()[1].toUInt();
594 qWarning() << Q_FUNC_INFO << "received invalid timestamp:" << e->params()[1];
597 QDateTime time = QDateTime::fromTime_t(unixtime).toUTC();
598 displayMsg(e, Message::Topic, tr("Channel %1 created on %2")
599 .arg(channel, time.toString("yyyy-MM-dd hh:mm:ss UTC")),
604 /* RPL_WHOISACCOUNT: "<nick> <account> :is authed as */
605 void EventStringifier::processIrcEvent330(IrcEvent *e)
607 if (e->params().count() < 3)
610 // check for whois or whowas
612 displayMsg(e, Message::Server, tr("[Whois] %1 is authed as %2").arg(e->params()[0], e->params()[1]));
615 displayMsg(e, Message::Server, tr("[Whowas] %1 was authed as %2").arg(e->params()[0], e->params()[1]));
621 void EventStringifier::processIrcEvent331(IrcEvent *e)
623 QString channel = e->params().first();
624 displayMsg(e, Message::Topic, tr("No topic is set for %1.").arg(channel), QString(), channel);
629 void EventStringifier::processIrcEvent332(IrcEvent *e)
631 QString channel = e->params().first();
632 displayMsg(e, Message::Topic, tr("Topic for %1 is \"%2\"").arg(channel, e->params()[1]), QString(), channel);
636 /* Topic set by... */
637 void EventStringifier::processIrcEvent333(IrcEvent *e)
639 if (!checkParamCount(e, 3))
642 QString channel = e->params().first();
643 QDateTime topicSetTime = QDateTime::fromTime_t(e->params()[2].toInt()).toUTC();
644 displayMsg(e, Message::Topic, tr("Topic set by %1 on %2")
646 topicSetTime.toString("yyyy-MM-dd hh:mm:ss UTC")), QString(), channel);
650 /* RPL_INVITING - "<nick> <channel>*/
651 void EventStringifier::processIrcEvent341(IrcEvent *e)
653 if (!checkParamCount(e, 2))
656 QString channel = e->params()[1];
657 displayMsg(e, Message::Server, tr("%1 has been invited to %2").arg(e->params().first(), channel), QString(), channel);
661 /* RPL_WHOREPLY: "<channel> <user> <host> <server> <nick>
662 ( "H" / "G" > ["*"] [ ( "@" / "+" ) ] :<hopcount> <real name>" */
663 void EventStringifier::processIrcEvent352(IrcEvent *e)
665 displayMsg(e, Message::Server, tr("[Who] %1").arg(e->params().join(" ")));
669 /* RPL_WHOSPCRPL: "<yournick> <num> #<channel> ~<ident> <host> <servname> <nick>
670 ("H"/ "G") <account> :<realname>"
671 Could be anything else, though. User-specified fields.
672 See http://faerion.sourceforge.net/doc/irc/whox.var */
673 void EventStringifier::processIrcEvent354(IrcEvent *e)
675 displayMsg(e, Message::Server, tr("[WhoX] %1").arg(e->params().join(" ")));
679 /* RPL_ENDOFWHOWAS - "<nick> :End of WHOWAS" */
680 void EventStringifier::processIrcEvent369(IrcEvent *e)
682 displayMsg(e, Message::Server, tr("End of /WHOWAS"));
686 /* ERR_ERRONEUSNICKNAME */
687 void EventStringifier::processIrcEvent432(IrcEvent *e)
689 if (!checkParamCount(e, 1))
692 displayMsg(e, Message::Error, tr("Nick %1 contains illegal characters").arg(e->params()[0]));
696 /* ERR_NICKNAMEINUSE */
697 void EventStringifier::processIrcEvent433(IrcEvent *e)
699 if (!checkParamCount(e, 1))
702 displayMsg(e, Message::Error, tr("Nick already in use: %1").arg(e->params()[0]));
706 /* ERR_UNAVAILRESOURCE */
707 void EventStringifier::processIrcEvent437(IrcEvent *e)
709 if (!checkParamCount(e, 1))
712 displayMsg(e, Message::Error, tr("Nick/channel is temporarily unavailable: %1").arg(e->params()[0]));
719 void EventStringifier::processIrcEvent(IrcEvent *e) {
725 /*******************************/
726 /******** CTCP HANDLING ********/
727 /*******************************/
729 void EventStringifier::processCtcpEvent(CtcpEvent *e)
731 if (e->type() != EventManager::CtcpEvent)
734 if (e->testFlag(EventManager::Self)) {
735 displayMsg(e, Message::Action, tr("sending CTCP-%1 request to %2").arg(e->ctcpCmd(), e->target()), e->network()->myNick());
739 handle(e->ctcpCmd(), Q_ARG(CtcpEvent *, e));
743 void EventStringifier::defaultHandler(const QString &ctcpCmd, CtcpEvent *e)
746 if (e->ctcpType() == CtcpEvent::Query) {
748 if (e->reply().isNull()) // all known core-side handlers (except for ACTION) set a reply!
749 //: Optional "unknown" in "Received unknown CTCP-FOO request by bar"
750 unknown = tr("unknown") + ' ';
751 displayMsg(e, Message::Server, tr("Received %1CTCP-%2 request by %3").arg(unknown, e->ctcpCmd(), e->prefix()));
754 displayMsg(e, Message::Server, tr("Received CTCP-%1 answer from %2: %3").arg(e->ctcpCmd(), nickFromMask(e->prefix()), e->param()));
758 void EventStringifier::handleCtcpAction(CtcpEvent *e)
760 displayMsg(e, Message::Action, e->param(), e->prefix(), e->target());
764 void EventStringifier::handleCtcpPing(CtcpEvent *e)
766 if (e->ctcpType() == CtcpEvent::Query)
767 defaultHandler(e->ctcpCmd(), e);
769 displayMsg(e, Message::Server, tr("Received CTCP-PING answer from %1 with %2 milliseconds round trip time")
770 .arg(nickFromMask(e->prefix())).arg(QDateTime::fromMSecsSinceEpoch(e->param().toULongLong()).msecsTo(e->timestamp())));