1 /***************************************************************************
2 * Copyright (C) 2005-2013 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.
216 displayMsg(e, Message::Info, "CAP: " + e->params().join(""));
220 // Everything else will be marked in red, so we can add them somewhere.
223 // many nets define their own WHOIS fields. we fetch those not in need of special attention here:
224 displayMsg(e, Message::Server, tr("[Whois] ") + e->params().join(" "), e->prefix());
227 // FIXME figure out how/where to do this in the future
228 //if(coreSession()->ircListHelper()->requestInProgress(network()->networkId()))
229 // coreSession()->ircListHelper()->reportError(params.join(" "));
231 displayMsg(e, Message::Error, QString("%1 %2").arg(e->number(), 3, 10, QLatin1Char('0')).arg(e->params().join(" ")), e->prefix());
237 void EventStringifier::processIrcEventInvite(IrcEvent *e)
239 displayMsg(e, Message::Invite, tr("%1 invited you to channel %2").arg(e->nick(), e->params().at(1)));
243 void EventStringifier::processIrcEventJoin(IrcEvent *e)
245 if (e->testFlag(EventManager::Netsplit))
248 displayMsg(e, Message::Join, e->params()[0], e->prefix(), e->params()[0]);
252 void EventStringifier::processIrcEventKick(IrcEvent *e)
254 if (!checkParamCount(e, 2))
257 IrcUser *victim = e->network()->ircUser(e->params().at(1));
259 QString channel = e->params().at(0);
260 QString msg = victim->nick();
261 if (e->params().count() > 2)
262 msg += " " + e->params().at(2);
264 displayMsg(e, Message::Kick, msg, e->prefix(), channel);
269 void EventStringifier::processIrcEventMode(IrcEvent *e)
271 if (e->network()->isChannelName(e->params().first())) {
273 displayMsg(e, Message::Mode, e->params().join(" "), e->prefix(), e->params().first());
278 displayMsg(e, Message::Mode, e->params().join(" "), e->prefix());
283 // this needs to be called before the ircuser is renamed!
284 void EventStringifier::processIrcEventNick(IrcEvent *e)
286 if (!checkParamCount(e, 1))
289 IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
291 qWarning() << Q_FUNC_INFO << "Unknown IrcUser!";
295 QString newnick = e->params().at(0);
296 QString oldnick = ircuser->nick();
298 QString sender = e->network()->isMyNick(oldnick) ? newnick : e->prefix();
299 foreach(const QString &channel, ircuser->channels())
300 displayMsg(e, Message::Nick, newnick, sender, channel);
304 void EventStringifier::processIrcEventPart(IrcEvent *e)
306 if (!checkParamCount(e, 1))
309 QString channel = e->params().at(0);
310 QString msg = e->params().count() > 1 ? e->params().at(1) : QString();
312 displayMsg(e, Message::Part, msg, e->prefix(), channel);
316 void EventStringifier::processIrcEventPong(IrcEvent *e)
318 QString timestamp = e->params().at(1);
319 QTime sendTime = QTime::fromString(timestamp, "hh:mm:ss.zzz");
320 if (!sendTime.isValid())
321 displayMsg(e, Message::Server, "PONG " + e->params().join(" "), e->prefix());
325 void EventStringifier::processIrcEventQuit(IrcEvent *e)
327 if (e->testFlag(EventManager::Netsplit))
330 IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
334 foreach(const QString &channel, ircuser->channels())
335 displayMsg(e, Message::Quit, e->params().count() ? e->params().first() : QString(), e->prefix(), channel);
339 void EventStringifier::processIrcEventTopic(IrcEvent *e)
341 displayMsg(e, Message::Topic, tr("%1 has changed topic for %2 to: \"%3\"")
342 .arg(e->nick(), e->params().at(0), e->params().at(1)), QString(), e->params().at(0));
345 void EventStringifier::processIrcEventWallops(IrcEvent *e)
347 displayMsg(e, Message::Server, tr("[Operwall] %1: %2").arg(e->nick(), e->params().join(" ")));
352 void EventStringifier::processIrcEvent005(IrcEvent *e)
354 if (!e->params().last().contains(QRegExp("are supported (by|on) this server")))
355 displayMsg(e, Message::Error, tr("Received non-RFC-compliant RPL_ISUPPORT: this can lead to unexpected behavior!"), e->prefix());
356 displayMsg(e, Message::Server, e->params().join(" "), e->prefix());
360 /* RPL_AWAY - "<nick> :<away message>" */
361 void EventStringifier::processIrcEvent301(IrcEvent *e)
363 QString nick = e->params().at(0);
364 QString awayMsg = e->params().at(1);
368 // FIXME: proper redirection needed
370 msg = tr("[Whois] ");
374 IrcUser *ircuser = e->network()->ircUser(nick);
376 int now = QDateTime::currentDateTime().toTime_t();
377 const int silenceTime = 60;
378 if (ircuser->lastAwayMessage() + silenceTime >= now)
380 ircuser->setLastAwayMessage(now);
384 displayMsg(e, Message::Server, msg + tr("%1 is away: \"%2\"").arg(nick, awayMsg), QString(), target);
388 /* RPL_UNAWAY - ":You are no longer marked as being away" */
389 void EventStringifier::processIrcEvent305(IrcEvent *e)
391 displayMsg(e, Message::Server, tr("You are no longer marked as being away"));
395 /* RPL_NOWAWAY - ":You have been marked as being away" */
396 void EventStringifier::processIrcEvent306(IrcEvent *e)
398 if (!e->network()->autoAwayActive())
399 displayMsg(e, Message::Server, tr("You have been marked as being away"));
405 Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message.
407 "<nick> :<away message>"
409 Replies 352 and 315 paired are used to answer a WHO message.
412 Replies 314 and 369 are responses to a WHOWAS message.
416 /* RPL_WHOISUSER - "<nick> <user> <host> * :<real name>" */
417 void EventStringifier::processIrcEvent311(IrcEvent *e)
421 const QString whoisUserString = tr("[Whois] %1 is %2 (%3)");
423 IrcUser *ircuser = e->network()->ircUser(e->params().at(0));
425 displayMsg(e, Message::Server, whoisUserString.arg(ircuser->nick(), ircuser->hostmask(), ircuser->realName()));
427 QString host = QString("%1!%2@%3").arg(e->params().at(0), e->params().at(1), e->params().at(2));
428 displayMsg(e, Message::Server, whoisUserString.arg(e->params().at(0), host, e->params().last()));
433 /* RPL_WHOISSERVER - "<nick> <server> :<server info>" */
434 void EventStringifier::processIrcEvent312(IrcEvent *e)
437 displayMsg(e, Message::Server, tr("[Whois] %1 is online via %2 (%3)").arg(e->params().at(0), e->params().at(1), e->params().last()));
439 displayMsg(e, Message::Server, tr("[Whowas] %1 was online via %2 (%3)").arg(e->params().at(0), e->params().at(1), e->params().last()));
443 /* RPL_WHOWASUSER - "<nick> <user> <host> * :<real name>" */
444 void EventStringifier::processIrcEvent314(IrcEvent *e)
446 if (!checkParamCount(e, 3))
449 displayMsg(e, Message::Server, tr("[Whowas] %1 was %2@%3 (%4)").arg(e->params()[0], e->params()[1], e->params()[2], e->params().last()));
453 /* RPL_ENDOFWHO: "<name> :End of WHO list" */
454 void EventStringifier::processIrcEvent315(IrcEvent *e)
456 QStringList p = e->params();
457 p.takeLast(); // should be "End of WHO list"
458 displayMsg(e, Message::Server, tr("[Who] End of /WHO list for %1").arg(p.join(" ")));
462 /* RPL_WHOISIDLE - "<nick> <integer> :seconds idle"
463 (real life: "<nick> <integer> <integer> :seconds idle, signon time) */
464 void EventStringifier::processIrcEvent317(IrcEvent *e)
466 int idleSecs = e->params()[1].toInt();
468 if (e->params().count() > 3) { // if we have more then 3 params we have the above mentioned "real life" situation
469 QDateTime loginTime = QDateTime::fromTime_t(e->params()[2].toInt()).toUTC();
470 displayMsg(e, Message::Server, tr("[Whois] %1 is logged in since %2")
471 .arg(e->params()[0], loginTime.toString("yyyy-MM-dd hh:mm:ss UTC")));
473 QDateTime idlingSince = e->timestamp().toLocalTime().addSecs(-idleSecs).toUTC();
474 displayMsg(e, Message::Server, tr("[Whois] %1 is idling for %2 (since %3)")
475 .arg(e->params()[0], secondsToString(idleSecs),
476 idlingSince.toString("yyyy-MM-dd hh:mm:ss UTC")));
480 /* RPL_ENDOFWHOIS - "<nick> :End of WHOIS list" */
481 void EventStringifier::processIrcEvent318(IrcEvent *e)
484 displayMsg(e, Message::Server, tr("[Whois] End of /WHOIS list"));
488 /* RPL_WHOISCHANNELS - "<nick> :*( ( "@" / "+" ) <channel> " " )" */
489 void EventStringifier::processIrcEvent319(IrcEvent *e)
491 if (!checkParamCount(e, 2))
494 QString nick = e->params().first();
498 foreach(QString channel, e->params().last().split(" ")) {
499 if (channel.startsWith("@"))
500 op.append(channel.remove(0, 1));
501 else if (channel.startsWith("+"))
502 voice.append(channel.remove(0, 1));
504 user.append(channel);
507 displayMsg(e, Message::Server, tr("[Whois] %1 is a user on channels: %2").arg(nick, user.join(" ")));
508 if (!voice.isEmpty())
509 displayMsg(e, Message::Server, tr("[Whois] %1 has voice on channels: %2").arg(nick, voice.join(" ")));
511 displayMsg(e, Message::Server, tr("[Whois] %1 is an operator on channels: %2").arg(nick, op.join(" ")));
515 /* RPL_LIST - "<channel> <# visible> :<topic>" */
516 void EventStringifier::processIrcEvent322(IrcEvent *e)
519 quint32 userCount = 0;
522 switch (e->params().count()) {
524 topic = e->params()[2];
526 userCount = e->params()[1].toUInt();
528 channelName = e->params()[0];
532 displayMsg(e, Message::Server, tr("Channel %1 has %2 users. Topic is: \"%3\"")
533 .arg(channelName).arg(userCount).arg(topic));
537 /* RPL_LISTEND ":End of LIST" */
538 void EventStringifier::processIrcEvent323(IrcEvent *e)
540 displayMsg(e, Message::Server, tr("End of channel list"));
544 /* RPL_CHANNELMODEIS - "<channel> <mode> <mode params>" */
545 void EventStringifier::processIrcEvent324(IrcEvent *e)
547 processIrcEventMode(e);
551 /* RPL_??? - "<channel> <homepage> */
552 void EventStringifier::processIrcEvent328(IrcEvent *e)
554 if (!checkParamCount(e, 2))
557 QString channel = e->params()[0];
558 displayMsg(e, Message::Topic, tr("Homepage for %1 is %2").arg(channel, e->params()[1]), QString(), channel);
562 /* RPL_??? - "<channel> <creation time (unix)>" */
563 void EventStringifier::processIrcEvent329(IrcEvent *e)
565 if (!checkParamCount(e, 2))
568 QString channel = e->params()[0];
569 uint unixtime = e->params()[1].toUInt();
571 qWarning() << Q_FUNC_INFO << "received invalid timestamp:" << e->params()[1];
574 QDateTime time = QDateTime::fromTime_t(unixtime).toUTC();
575 displayMsg(e, Message::Topic, tr("Channel %1 created on %2")
576 .arg(channel, time.toString("yyyy-MM-dd hh:mm:ss UTC")),
581 /* RPL_WHOISACCOUNT: "<nick> <account> :is authed as */
582 void EventStringifier::processIrcEvent330(IrcEvent *e)
584 if (e->params().count() < 3)
587 // check for whois or whowas
589 displayMsg(e, Message::Server, tr("[Whois] %1 is authed as %2").arg(e->params()[0], e->params()[1]));
592 displayMsg(e, Message::Server, tr("[Whowas] %1 was authed as %2").arg(e->params()[0], e->params()[1]));
598 void EventStringifier::processIrcEvent331(IrcEvent *e)
600 QString channel = e->params().first();
601 displayMsg(e, Message::Topic, tr("No topic is set for %1.").arg(channel), QString(), channel);
606 void EventStringifier::processIrcEvent332(IrcEvent *e)
608 QString channel = e->params().first();
609 displayMsg(e, Message::Topic, tr("Topic for %1 is \"%2\"").arg(channel, e->params()[1]), QString(), channel);
613 /* Topic set by... */
614 void EventStringifier::processIrcEvent333(IrcEvent *e)
616 if (!checkParamCount(e, 3))
619 QString channel = e->params().first();
620 QDateTime topicSetTime = QDateTime::fromTime_t(e->params()[2].toInt()).toUTC();
621 displayMsg(e, Message::Topic, tr("Topic set by %1 on %2")
623 topicSetTime.toString("yyyy-MM-dd hh:mm:ss UTC")), QString(), channel);
627 /* RPL_INVITING - "<nick> <channel>*/
628 void EventStringifier::processIrcEvent341(IrcEvent *e)
630 if (!checkParamCount(e, 2))
633 QString channel = e->params()[1];
634 displayMsg(e, Message::Server, tr("%1 has been invited to %2").arg(e->params().first(), channel), QString(), channel);
638 /* RPL_WHOREPLY: "<channel> <user> <host> <server> <nick>
639 ( "H" / "G" > ["*"] [ ( "@" / "+" ) ] :<hopcount> <real name>" */
640 void EventStringifier::processIrcEvent352(IrcEvent *e)
642 displayMsg(e, Message::Server, tr("[Who] %1").arg(e->params().join(" ")));
646 /* RPL_ENDOFWHOWAS - "<nick> :End of WHOWAS" */
647 void EventStringifier::processIrcEvent369(IrcEvent *e)
649 displayMsg(e, Message::Server, tr("End of /WHOWAS"));
653 /* ERR_ERRONEUSNICKNAME */
654 void EventStringifier::processIrcEvent432(IrcEvent *e)
656 if (!checkParamCount(e, 1))
659 displayMsg(e, Message::Error, tr("Nick %1 contains illegal characters").arg(e->params()[0]));
663 /* ERR_NICKNAMEINUSE */
664 void EventStringifier::processIrcEvent433(IrcEvent *e)
666 if (!checkParamCount(e, 1))
669 displayMsg(e, Message::Error, tr("Nick already in use: %1").arg(e->params()[0]));
673 /* ERR_UNAVAILRESOURCE */
674 void EventStringifier::processIrcEvent437(IrcEvent *e)
676 if (!checkParamCount(e, 1))
679 displayMsg(e, Message::Error, tr("Nick/channel is temporarily unavailable: %1").arg(e->params()[0]));
686 void EventStringifier::processIrcEvent(IrcEvent *e) {
692 /*******************************/
693 /******** CTCP HANDLING ********/
694 /*******************************/
696 void EventStringifier::processCtcpEvent(CtcpEvent *e)
698 if (e->type() != EventManager::CtcpEvent)
701 if (e->testFlag(EventManager::Self)) {
702 displayMsg(e, Message::Action, tr("sending CTCP-%1 request to %2").arg(e->ctcpCmd(), e->target()), e->network()->myNick());
706 handle(e->ctcpCmd(), Q_ARG(CtcpEvent *, e));
710 void EventStringifier::defaultHandler(const QString &ctcpCmd, CtcpEvent *e)
713 if (e->ctcpType() == CtcpEvent::Query) {
715 if (e->reply().isNull()) // all known core-side handlers (except for ACTION) set a reply!
716 //: Optional "unknown" in "Received unknown CTCP-FOO request by bar"
717 unknown = tr("unknown") + ' ';
718 displayMsg(e, Message::Server, tr("Received %1CTCP-%2 request by %3").arg(unknown, e->ctcpCmd(), e->prefix()));
721 displayMsg(e, Message::Server, tr("Received CTCP-%1 answer from %2: %3").arg(e->ctcpCmd(), nickFromMask(e->prefix()), e->param()));
725 void EventStringifier::handleCtcpAction(CtcpEvent *e)
727 displayMsg(e, Message::Action, e->param(), e->prefix(), e->target());
731 void EventStringifier::handleCtcpPing(CtcpEvent *e)
733 if (e->ctcpType() == CtcpEvent::Query)
734 defaultHandler(e->ctcpCmd(), e);
736 displayMsg(e, Message::Server, tr("Received CTCP-PING answer from %1 with %2 seconds round trip time")
737 .arg(nickFromMask(e->prefix())).arg(QDateTime::fromTime_t(e->param().toInt()).secsTo(e->timestamp())));