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 Message::Flag msgFlags = Message::Flag::None;
263 if (e->testFlag(EventManager::Self)) {
264 // Mark the message as Self
265 msgFlags = Message::Self;
268 displayMsg(e, Message::Join, e->params()[0], e->prefix(), e->params()[0], msgFlags);
272 void EventStringifier::processIrcEventKick(IrcEvent *e)
274 if (!checkParamCount(e, 2))
277 IrcUser *victim = e->network()->ircUser(e->params().at(1));
279 QString channel = e->params().at(0);
280 QString msg = victim->nick();
281 if (e->params().count() > 2)
282 msg += " " + e->params().at(2);
284 Message::Flag msgFlags = Message::Flag::None;
285 if (e->testFlag(EventManager::Self)) {
286 // Mark the message as Self
287 msgFlags = Message::Self;
290 displayMsg(e, Message::Kick, msg, e->prefix(), channel, msgFlags);
295 void EventStringifier::processIrcEventMode(IrcEvent *e)
297 if (e->network()->isChannelName(e->params().first())) {
299 displayMsg(e, Message::Mode, e->params().join(" "), e->prefix(), e->params().first());
305 Message::Flag msgFlags = Message::Flag::None;
306 if (e->testFlag(EventManager::Self)) {
307 // Mark the message as Self
308 msgFlags = Message::Self;
310 displayMsg(e, Message::Mode, e->params().join(" "), e->prefix(), QString(), msgFlags);
315 // this needs to be called before the ircuser is renamed!
316 void EventStringifier::processIrcEventNick(IrcEvent *e)
318 if (!checkParamCount(e, 1))
321 IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
323 qWarning() << Q_FUNC_INFO << "Unknown IrcUser!";
327 QString newnick = e->params().at(0);
330 Message::Flag msgFlags = Message::Flag::None;
331 if (e->testFlag(EventManager::Self)) {
332 // Treat the sender as the new nickname, mark the message as Self
334 msgFlags = Message::Self;
336 // Take the sender from the event prefix, don't mark the message
337 sender = e->prefix();
340 // Announce to all channels the IrcUser is in
341 foreach(const QString &channel, ircuser->channels()) {
342 displayMsg(e, Message::Nick, newnick, sender, channel, msgFlags);
347 void EventStringifier::processIrcEventPart(IrcEvent *e)
349 if (!checkParamCount(e, 1))
352 QString channel = e->params().at(0);
353 QString msg = e->params().count() > 1 ? e->params().at(1) : QString();
356 Message::Flag msgFlags = Message::Flag::None;
357 if (e->testFlag(EventManager::Self)) {
358 // Mark the message as Self
359 msgFlags = Message::Self;
362 displayMsg(e, Message::Part, msg, e->prefix(), channel, msgFlags);
366 void EventStringifier::processIrcEventPong(IrcEvent *e)
368 QString timestamp = e->params().at(1);
369 QTime sendTime = QTime::fromString(timestamp, "hh:mm:ss.zzz");
370 if (!sendTime.isValid())
371 displayMsg(e, Message::Server, "PONG " + e->params().join(" "), e->prefix());
375 void EventStringifier::processIrcEventQuit(IrcEvent *e)
377 if (e->testFlag(EventManager::Netsplit))
380 IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
385 Message::Flag msgFlags = Message::Flag::None;
386 if (e->testFlag(EventManager::Self)) {
387 // Mark the message as Self
388 msgFlags = Message::Self;
391 // Announce to all channels the IrcUser is in
392 foreach(const QString &channel, ircuser->channels()) {
393 displayMsg(e, Message::Quit, e->params().count() ? e->params().first() : QString(),
394 e->prefix(), channel, msgFlags);
399 void EventStringifier::processIrcEventTopic(IrcEvent *e)
401 Message::Flag msgFlags = Message::Flag::None;
402 if (e->testFlag(EventManager::Self)) {
403 // Mark the message as Self
404 msgFlags = Message::Self;
407 displayMsg(e, Message::Topic, tr("%1 has changed topic for %2 to: \"%3\"")
408 .arg(e->nick(), e->params().at(0), e->params().at(1)), QString(), e->params().at(0),
412 void EventStringifier::processIrcEventError(IrcEvent *e)
414 // Need an error reason
415 if (!checkParamCount(e, 1))
418 displayMsg(e, Message::Server, tr("Error from server: ") + e->params().join(""));
421 void EventStringifier::processIrcEventWallops(IrcEvent *e)
423 displayMsg(e, Message::Server, tr("[Operwall] %1: %2").arg(e->nick(), e->params().join(" ")));
428 void EventStringifier::processIrcEvent005(IrcEvent *e)
430 if (!e->params().last().contains(QRegExp("are supported (by|on) this server")))
431 displayMsg(e, Message::Error, tr("Received non-RFC-compliant RPL_ISUPPORT: this can lead to unexpected behavior!"), e->prefix());
432 displayMsg(e, Message::Server, e->params().join(" "), e->prefix());
436 /* RPL_AWAY - "<nick> :<away message>" */
437 void EventStringifier::processIrcEvent301(IrcEvent *e)
439 QString nick = e->params().at(0);
440 QString awayMsg = e->params().at(1);
444 // FIXME: proper redirection needed
446 msg = tr("[Whois] ");
450 IrcUser *ircuser = e->network()->ircUser(nick);
452 int now = QDateTime::currentDateTime().toTime_t();
453 const int silenceTime = 60;
454 if (ircuser->lastAwayMessage() + silenceTime >= now)
456 ircuser->setLastAwayMessage(now);
460 displayMsg(e, Message::Server, msg + tr("%1 is away: \"%2\"").arg(nick, awayMsg), QString(), target);
464 /* RPL_UNAWAY - ":You are no longer marked as being away" */
465 void EventStringifier::processIrcEvent305(IrcEvent *e)
467 displayMsg(e, Message::Server, tr("You are no longer marked as being away"));
471 /* RPL_NOWAWAY - ":You have been marked as being away" */
472 void EventStringifier::processIrcEvent306(IrcEvent *e)
474 if (!e->network()->autoAwayActive())
475 displayMsg(e, Message::Server, tr("You have been marked as being away"));
481 Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message.
483 "<nick> :<away message>"
485 Replies 352 and 315 paired are used to answer a WHO message.
488 Replies 314 and 369 are responses to a WHOWAS message.
492 /* RPL_WHOISUSER - "<nick> <user> <host> * :<real name>" */
493 void EventStringifier::processIrcEvent311(IrcEvent *e)
497 const QString whoisUserString = tr("[Whois] %1 is %2 (%3)");
499 IrcUser *ircuser = e->network()->ircUser(e->params().at(0));
501 displayMsg(e, Message::Server, whoisUserString.arg(ircuser->nick(), ircuser->hostmask(), ircuser->realName()));
503 QString host = QString("%1!%2@%3").arg(e->params().at(0), e->params().at(1), e->params().at(2));
504 displayMsg(e, Message::Server, whoisUserString.arg(e->params().at(0), host, e->params().last()));
509 /* RPL_WHOISSERVER - "<nick> <server> :<server info>" */
510 void EventStringifier::processIrcEvent312(IrcEvent *e)
513 displayMsg(e, Message::Server, tr("[Whois] %1 is online via %2 (%3)").arg(e->params().at(0), e->params().at(1), e->params().last()));
515 displayMsg(e, Message::Server, tr("[Whowas] %1 was online via %2 (%3)").arg(e->params().at(0), e->params().at(1), e->params().last()));
519 /* RPL_WHOWASUSER - "<nick> <user> <host> * :<real name>" */
520 void EventStringifier::processIrcEvent314(IrcEvent *e)
522 if (!checkParamCount(e, 3))
525 displayMsg(e, Message::Server, tr("[Whowas] %1 was %2@%3 (%4)").arg(e->params()[0], e->params()[1], e->params()[2], e->params().last()));
529 /* RPL_ENDOFWHO: "<name> :End of WHO list" */
530 void EventStringifier::processIrcEvent315(IrcEvent *e)
532 QStringList p = e->params();
533 p.takeLast(); // should be "End of WHO list"
534 displayMsg(e, Message::Server, tr("[Who] End of /WHO list for %1").arg(p.join(" ")));
538 /* RPL_WHOISIDLE - "<nick> <integer> :seconds idle"
539 (real life: "<nick> <integer> <integer> :seconds idle, signon time) */
540 void EventStringifier::processIrcEvent317(IrcEvent *e)
542 int idleSecs = e->params()[1].toInt();
544 if (e->params().count() > 3) { // if we have more then 3 params we have the above mentioned "real life" situation
545 QDateTime loginTime = QDateTime::fromTime_t(e->params()[2].toInt()).toUTC();
546 displayMsg(e, Message::Server, tr("[Whois] %1 is logged in since %2")
547 .arg(e->params()[0], loginTime.toString("yyyy-MM-dd hh:mm:ss UTC")));
549 QDateTime idlingSince = e->timestamp().toLocalTime().addSecs(-idleSecs).toUTC();
550 displayMsg(e, Message::Server, tr("[Whois] %1 is idling for %2 (since %3)")
551 .arg(e->params()[0], secondsToString(idleSecs),
552 idlingSince.toString("yyyy-MM-dd hh:mm:ss UTC")));
556 /* RPL_ENDOFWHOIS - "<nick> :End of WHOIS list" */
557 void EventStringifier::processIrcEvent318(IrcEvent *e)
560 displayMsg(e, Message::Server, tr("[Whois] End of /WHOIS list"));
564 /* RPL_WHOISCHANNELS - "<nick> :*( ( "@" / "+" ) <channel> " " )" */
565 void EventStringifier::processIrcEvent319(IrcEvent *e)
567 if (!checkParamCount(e, 2))
570 QString nick = e->params().first();
574 foreach(QString channel, e->params().last().split(" ")) {
575 if (channel.startsWith("@"))
576 op.append(channel.remove(0, 1));
577 else if (channel.startsWith("+"))
578 voice.append(channel.remove(0, 1));
580 user.append(channel);
583 displayMsg(e, Message::Server, tr("[Whois] %1 is a user on channels: %2").arg(nick, user.join(" ")));
584 if (!voice.isEmpty())
585 displayMsg(e, Message::Server, tr("[Whois] %1 has voice on channels: %2").arg(nick, voice.join(" ")));
587 displayMsg(e, Message::Server, tr("[Whois] %1 is an operator on channels: %2").arg(nick, op.join(" ")));
591 /* RPL_LIST - "<channel> <# visible> :<topic>" */
592 void EventStringifier::processIrcEvent322(IrcEvent *e)
595 quint32 userCount = 0;
598 switch (e->params().count()) {
600 topic = e->params()[2];
602 userCount = e->params()[1].toUInt();
604 channelName = e->params()[0];
608 displayMsg(e, Message::Server, tr("Channel %1 has %2 users. Topic is: \"%3\"")
609 .arg(channelName).arg(userCount).arg(topic));
613 /* RPL_LISTEND ":End of LIST" */
614 void EventStringifier::processIrcEvent323(IrcEvent *e)
616 displayMsg(e, Message::Server, tr("End of channel list"));
620 /* RPL_CHANNELMODEIS - "<channel> <mode> <mode params>" */
621 void EventStringifier::processIrcEvent324(IrcEvent *e)
623 processIrcEventMode(e);
627 /* RPL_??? - "<channel> <homepage> */
628 void EventStringifier::processIrcEvent328(IrcEvent *e)
630 if (!checkParamCount(e, 2))
633 QString channel = e->params()[0];
634 displayMsg(e, Message::Topic, tr("Homepage for %1 is %2").arg(channel, e->params()[1]), QString(), channel);
638 /* RPL_??? - "<channel> <creation time (unix)>" */
639 void EventStringifier::processIrcEvent329(IrcEvent *e)
641 if (!checkParamCount(e, 2))
644 QString channel = e->params()[0];
645 uint unixtime = e->params()[1].toUInt();
647 qWarning() << Q_FUNC_INFO << "received invalid timestamp:" << e->params()[1];
650 QDateTime time = QDateTime::fromTime_t(unixtime).toUTC();
651 displayMsg(e, Message::Topic, tr("Channel %1 created on %2")
652 .arg(channel, time.toString("yyyy-MM-dd hh:mm:ss UTC")),
657 /* RPL_WHOISACCOUNT: "<nick> <account> :is authed as */
658 void EventStringifier::processIrcEvent330(IrcEvent *e)
660 if (e->params().count() < 3)
663 // check for whois or whowas
665 displayMsg(e, Message::Server, tr("[Whois] %1 is authed as %2").arg(e->params()[0], e->params()[1]));
668 displayMsg(e, Message::Server, tr("[Whowas] %1 was authed as %2").arg(e->params()[0], e->params()[1]));
674 void EventStringifier::processIrcEvent331(IrcEvent *e)
676 QString channel = e->params().first();
677 displayMsg(e, Message::Topic, tr("No topic is set for %1.").arg(channel), QString(), channel);
682 void EventStringifier::processIrcEvent332(IrcEvent *e)
684 QString channel = e->params().first();
685 displayMsg(e, Message::Topic, tr("Topic for %1 is \"%2\"").arg(channel, e->params()[1]), QString(), channel);
689 /* Topic set by... */
690 void EventStringifier::processIrcEvent333(IrcEvent *e)
692 if (!checkParamCount(e, 3))
695 QString channel = e->params().first();
696 QDateTime topicSetTime = QDateTime::fromTime_t(e->params()[2].toInt()).toUTC();
697 displayMsg(e, Message::Topic, tr("Topic set by %1 on %2")
699 topicSetTime.toString("yyyy-MM-dd hh:mm:ss UTC")), QString(), channel);
703 /* RPL_INVITING - "<nick> <channel>*/
704 void EventStringifier::processIrcEvent341(IrcEvent *e)
706 if (!checkParamCount(e, 2))
709 QString channel = e->params()[1];
710 displayMsg(e, Message::Server, tr("%1 has been invited to %2").arg(e->params().first(), channel), QString(), channel);
714 /* RPL_WHOREPLY: "<channel> <user> <host> <server> <nick>
715 ( "H" / "G" > ["*"] [ ( "@" / "+" ) ] :<hopcount> <real name>" */
716 void EventStringifier::processIrcEvent352(IrcEvent *e)
718 displayMsg(e, Message::Server, tr("[Who] %1").arg(e->params().join(" ")));
722 /* RPL_WHOSPCRPL: "<yournick> <num> #<channel> ~<ident> <host> <servname> <nick>
723 ("H"/ "G") <account> :<realname>"
724 Could be anything else, though. User-specified fields.
725 See http://faerion.sourceforge.net/doc/irc/whox.var */
726 void EventStringifier::processIrcEvent354(IrcEvent *e)
728 displayMsg(e, Message::Server, tr("[WhoX] %1").arg(e->params().join(" ")));
732 /* RPL_ENDOFWHOWAS - "<nick> :End of WHOWAS" */
733 void EventStringifier::processIrcEvent369(IrcEvent *e)
735 displayMsg(e, Message::Server, tr("End of /WHOWAS"));
739 /* ERR_ERRONEUSNICKNAME */
740 void EventStringifier::processIrcEvent432(IrcEvent *e)
742 if (!checkParamCount(e, 1))
745 displayMsg(e, Message::Error, tr("Nick %1 contains illegal characters").arg(e->params()[0]));
749 /* ERR_NICKNAMEINUSE */
750 void EventStringifier::processIrcEvent433(IrcEvent *e)
752 if (!checkParamCount(e, 1))
755 displayMsg(e, Message::Error, tr("Nick already in use: %1").arg(e->params()[0]));
759 /* ERR_UNAVAILRESOURCE */
760 void EventStringifier::processIrcEvent437(IrcEvent *e)
762 if (!checkParamCount(e, 1))
765 displayMsg(e, Message::Error, tr("Nick/channel is temporarily unavailable: %1").arg(e->params()[0]));
772 void EventStringifier::processIrcEvent(IrcEvent *e) {
778 /*******************************/
779 /******** CTCP HANDLING ********/
780 /*******************************/
782 void EventStringifier::processCtcpEvent(CtcpEvent *e)
784 if (e->type() != EventManager::CtcpEvent)
787 if (e->testFlag(EventManager::Self)) {
788 displayMsg(e, Message::Action,
789 tr("sending CTCP-%1 request to %2").arg(e->ctcpCmd(), e->target()),
790 e->network()->myNick(), QString(), Message::Flag::Self);
794 handle(e->ctcpCmd(), Q_ARG(CtcpEvent *, e));
798 void EventStringifier::defaultHandler(const QString &ctcpCmd, CtcpEvent *e)
801 if (e->ctcpType() == CtcpEvent::Query) {
803 if (e->reply().isNull()) // all known core-side handlers (except for ACTION) set a reply!
804 //: Optional "unknown" in "Received unknown CTCP-FOO request by bar"
805 unknown = tr("unknown") + ' ';
806 displayMsg(e, Message::Server, tr("Received %1CTCP-%2 request by %3").arg(unknown, e->ctcpCmd(), e->prefix()));
809 displayMsg(e, Message::Server, tr("Received CTCP-%1 answer from %2: %3").arg(e->ctcpCmd(), nickFromMask(e->prefix()), e->param()));
813 void EventStringifier::handleCtcpAction(CtcpEvent *e)
815 displayMsg(e, Message::Action, e->param(), e->prefix(), e->target());
819 void EventStringifier::handleCtcpPing(CtcpEvent *e)
821 if (e->ctcpType() == CtcpEvent::Query)
822 defaultHandler(e->ctcpCmd(), e);
824 displayMsg(e, Message::Server, tr("Received CTCP-PING answer from %1 with %2 milliseconds round trip time")
825 .arg(nickFromMask(e->prefix())).arg(QDateTime::fromMSecsSinceEpoch(e->param().toULongLong()).msecsTo(e->timestamp())));