1 /***************************************************************************
2 * Copyright (C) 2005-2010 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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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 *)));
34 void EventStringifier::displayMsg(NetworkEvent *event, Message::Type msgType, const QString &msg, const QString &sender,
35 const QString &target, Message::Flags msgFlags) {
36 if(event->flags().testFlag(EventManager::Silent))
39 MessageEvent *msgEvent = createMessageEvent(event, msgType, msg, sender, target, msgFlags);
40 //sendMessageEvent(msgEvent);
41 emit newMessageEvent(msgEvent);
44 MessageEvent *EventStringifier::createMessageEvent(NetworkEvent *event, Message::Type msgType, const QString &msg, const QString &sender,
45 const QString &target, Message::Flags msgFlags) {
46 MessageEvent *msgEvent = new MessageEvent(msgType, event->network(), msg, sender, target, msgFlags);
47 msgEvent->setTimestamp(event->timestamp());
51 bool EventStringifier::checkParamCount(IrcEvent *e, int minParams) {
52 if(e->params().count() < minParams) {
53 if(e->type() == EventManager::IrcEventNumeric) {
54 qWarning() << "Command " << static_cast<IrcEventNumeric *>(e)->number() << " requires " << minParams << "params, got: " << e->params();
56 QString name = coreSession()->eventManager()->enumName(e->type());
57 qWarning() << qPrintable(name) << "requires" << minParams << "params, got:" << e->params();
65 /* These are only for legacy reasons; remove as soon as we handle NetworkSplitEvents properly */
66 void EventStringifier::processNetworkSplitJoin(NetworkSplitEvent *e) {
67 QString msg = e->users().join("#:#") + "#:#" + e->quitMessage();
68 displayMsg(e, Message::NetsplitJoin, msg, QString(), e->channel());
71 void EventStringifier::processNetworkSplitQuit(NetworkSplitEvent *e) {
72 QString msg = e->users().join("#:#") + "#:#" + e->quitMessage();
73 displayMsg(e, Message::NetsplitQuit, msg, QString(), e->channel());
78 void EventStringifier::processIrcEventNumeric(IrcEventNumeric *e) {
79 //qDebug() << e->number();
81 // Welcome, status, info messages. Just display these.
82 case 1: case 2: case 3: case 4: case 5:
83 case 221: case 250: case 251: case 252: case 253: case 254: case 255: case 265: case 266:
85 displayMsg(e, Message::Server, e->params().join(" "), e->prefix());
88 // Server error messages without param, just display them
89 case 409: case 411: case 412: case 422: case 424: case 445: case 446: case 451: case 462:
90 case 463: case 464: case 465: case 466: case 472: case 481: case 483: case 485: case 491: case 501: case 502:
91 case 431: // ERR_NONICKNAMEGIVEN
92 displayMsg(e, Message::Error, e->params().join(" "), e->prefix());
95 // Server error messages, display them in red. First param will be appended.
97 if(!checkParamCount(e, 1))
100 QString target = e->params().takeFirst();
101 displayMsg(e, Message::Error, e->params().join(" ") + " " + target, e->prefix(), target, Message::Redirected);
105 case 402: case 403: case 404: case 406: case 408: case 415: case 421: case 442: {
106 if(!checkParamCount(e, 1))
109 QString channelName = e->params().takeFirst();
110 displayMsg(e, Message::Error, e->params().join(" ") + " " + channelName, e->prefix());
114 // Server error messages which will be displayed with a colon between the first param and the rest
115 case 413: case 414: case 423: case 441: case 444: case 461: // FIXME see below for the 47x codes
116 case 467: case 471: case 473: case 474: case 475: case 476: case 477: case 478: case 482:
117 case 436: // ERR_NICKCOLLISION
119 if(!checkParamCount(e, 1))
122 QString p = e->params().takeFirst();
123 displayMsg(e, Message::Error, p + ": " + e->params().join(" "));
127 // Ignore these commands.
128 case 321: case 353: case 366: case 376:
132 case 900: case 903: case 904: case 905: case 906: case 907:
134 displayMsg(e, Message::Info, "CAP: " + e->params().join(""));
138 // Everything else will be marked in red, so we can add them somewhere.
141 // many nets define their own WHOIS fields. we fetch those not in need of special attention here:
142 displayMsg(e, Message::Server, tr("[Whois] ") + e->params().join(" "), e->prefix());
144 // FIXME figure out how/where to do this in the future
145 //if(coreSession()->ircListHelper()->requestInProgress(network()->networkId()))
146 // coreSession()->ircListHelper()->reportError(params.join(" "));
148 displayMsg(e, Message::Error, QString("%1 %2").arg(e->number(), 3, 10, QLatin1Char('0')).arg(e->params().join(" ")), e->prefix());
153 void EventStringifier::processIrcEventInvite(IrcEvent *e) {
154 displayMsg(e, Message::Invite, tr("%1 invited you to channel %2").arg(e->nick(), e->params().at(1)));
157 void EventStringifier::processIrcEventJoin(IrcEvent *e) {
158 if(e->testFlag(EventManager::Netsplit))
161 displayMsg(e, Message::Join, e->params()[0], e->prefix(), e->params()[0]);
164 void EventStringifier::processIrcEventKick(IrcEvent *e) {
165 if(!checkParamCount(e, 2))
168 IrcUser *victim = e->network()->ircUser(e->params().at(1));
170 QString channel = e->params().at(0);
171 QString msg = victim->nick();
172 if(e->params().count() > 2)
173 msg += " " + e->params().at(2);
175 displayMsg(e, Message::Kick, msg, e->prefix(), channel);
179 void EventStringifier::processIrcEventMode(IrcEvent *e) {
180 if(e->network()->isChannelName(e->params().first())) {
182 displayMsg(e, Message::Mode, e->params().join(" "), e->prefix(), e->params().first());
186 displayMsg(e, Message::Mode, e->params().join(" "), e->prefix());
190 // this needs to be called before the ircuser is renamed!
191 void EventStringifier::processIrcEventNick(IrcEvent *e) {
192 if(!checkParamCount(e, 1))
195 IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
197 qWarning() << Q_FUNC_INFO << "Unknown IrcUser!";
201 QString newnick = e->params().at(0);
202 QString oldnick = ircuser->nick();
204 QString sender = e->network()->isMyNick(oldnick) ? newnick : e->prefix();
205 foreach(const QString &channel, ircuser->channels())
206 displayMsg(e, Message::Nick, newnick, sender, channel);
209 void EventStringifier::processIrcEventPart(IrcEvent *e) {
210 if(!checkParamCount(e, 1))
213 QString channel = e->params().at(0);
214 QString msg = e->params().count() > 1? e->params().at(1) : QString();
216 displayMsg(e, Message::Part, msg, e->prefix(), channel);
219 void EventStringifier::processIrcEventPong(IrcEvent *e) {
220 QString timestamp = e->params().at(1);
221 QTime sendTime = QTime::fromString(timestamp, "hh:mm:ss.zzz");
222 if(!sendTime.isValid())
223 displayMsg(e, Message::Server, "PONG " + e->params().join(" "), e->prefix());
226 void EventStringifier::processIrcEventQuit(IrcEvent *e) {
227 if(e->testFlag(EventManager::Netsplit))
230 IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
234 foreach(const QString &channel, ircuser->channels())
235 displayMsg(e, Message::Quit, e->params().count()? e->params().first() : QString(), e->prefix(), channel);
238 void EventStringifier::processIrcEventTopic(IrcEvent *e) {
239 displayMsg(e, Message::Topic, tr("%1 has changed topic for %2 to: \"%3\"")
240 .arg(e->nick(), e->params().at(0), e->params().at(1)), QString(), e->params().at(0));
244 void EventStringifier::processIrcEvent005(IrcEvent *e) {
245 if(!e->params().last().contains(QRegExp("are supported (by|on) this server")))
246 displayMsg(e, Message::Error, tr("Received non-RFC-compliant RPL_ISUPPORT: this can lead to unexpected behavior!"), e->prefix());
247 displayMsg(e, Message::Server, e->params().join(" "), e->prefix());
250 /* RPL_AWAY - "<nick> :<away message>" */
251 void EventStringifier::processIrcEvent301(IrcEvent *e) {
252 QString nick = e->params().at(0);
253 QString awayMsg = e->params().at(1);
257 // FIXME: proper redirection needed
259 msg = tr("[Whois] ");
262 IrcUser *ircuser = e->network()->ircUser(nick);
264 int now = QDateTime::currentDateTime().toTime_t();
265 const int silenceTime = 60;
266 if(ircuser->lastAwayMessage() + silenceTime >= now)
268 ircuser->setLastAwayMessage(now);
272 displayMsg(e, Message::Server, msg + tr("%1 is away: \"%2\"").arg(nick, awayMsg), QString(), target);
275 /* RPL_UNAWAY - ":You are no longer marked as being away" */
276 void EventStringifier::processIrcEvent305(IrcEvent *e) {
277 displayMsg(e, Message::Server, tr("You are no longer marked as being away"));
280 /* RPL_NOWAWAY - ":You have been marked as being away" */
281 void EventStringifier::processIrcEvent306(IrcEvent *e) {
282 if(!e->network()->autoAwayActive())
283 displayMsg(e, Message::Server, tr("You have been marked as being away"));
288 Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message.
290 "<nick> :<away message>"
292 Replies 352 and 315 paired are used to answer a WHO message.
295 Replies 314 and 369 are responses to a WHOWAS message.
299 /* RPL_WHOISUSER - "<nick> <user> <host> * :<real name>" */
300 void EventStringifier::processIrcEvent311(IrcEvent *e) {
303 const QString whoisUserString = tr("[Whois] %1 is %2 (%3)");
305 IrcUser *ircuser = e->network()->ircUser(e->params().at(0));
307 displayMsg(e, Message::Server, whoisUserString.arg(ircuser->nick(), ircuser->hostmask(), ircuser->realName()));
309 QString host = QString("%1!%2@%3").arg(e->params().at(0), e->params().at(1), e->params().at(2));
310 displayMsg(e, Message::Server, whoisUserString.arg(e->params().at(0), host, e->params().last()));
314 /* RPL_WHOISSERVER - "<nick> <server> :<server info>" */
315 void EventStringifier::processIrcEvent312(IrcEvent *e) {
317 displayMsg(e, Message::Server, tr("[Whois] %1 is online via %2 (%3)").arg(e->params().at(0), e->params().at(1), e->params().last()));
319 displayMsg(e, Message::Server, tr("[Whowas] %1 was online via %2 (%3)").arg(e->params().at(0), e->params().at(1), e->params().last()));
322 /* RPL_WHOWASUSER - "<nick> <user> <host> * :<real name>" */
323 void EventStringifier::processIrcEvent314(IrcEvent *e) {
324 if(!checkParamCount(e, 3))
327 displayMsg(e, Message::Server, tr("[Whowas] %1 was %2@%3 (%4)").arg(e->params()[0], e->params()[1], e->params()[2], e->params().last()));
330 /* RPL_ENDOFWHO: "<name> :End of WHO list" */
331 void EventStringifier::processIrcEvent315(IrcEvent *e) {
332 QStringList p = e->params();
333 p.takeLast(); // should be "End of WHO list"
334 displayMsg(e, Message::Server, tr("[Who] End of /WHO list for %1").arg(p.join(" ")));
337 /* RPL_WHOISIDLE - "<nick> <integer> :seconds idle"
338 (real life: "<nick> <integer> <integer> :seconds idle, signon time) */
339 void EventStringifier::processIrcEvent317(IrcEvent *e) {
340 int idleSecs = e->params()[1].toInt();
342 if(e->params().count() > 3) { // if we have more then 3 params we have the above mentioned "real life" situation
343 QDateTime loginTime = QDateTime::fromTime_t(e->params()[2].toInt());
344 displayMsg(e, Message::Server, tr("[Whois] %1 is logged in since %2").arg(e->params()[0], loginTime.toString()));
346 displayMsg(e, Message::Server, tr("[Whois] %1 is idling for %2 (since %3)")
347 .arg(e->params()[0], secondsToString(idleSecs), e->timestamp().toLocalTime().addSecs(-idleSecs).toString()));
350 /* RPL_ENDOFWHOIS - "<nick> :End of WHOIS list" */
351 void EventStringifier::processIrcEvent318(IrcEvent *e) {
353 displayMsg(e, Message::Server, tr("[Whois] End of /WHOIS list"));
356 /* RPL_WHOISCHANNELS - "<nick> :*( ( "@" / "+" ) <channel> " " )" */
357 void EventStringifier::processIrcEvent319(IrcEvent *e) {
358 if(!checkParamCount(e, 2))
361 QString nick = e->params().first();
365 foreach(QString channel, e->params().last().split(" ")) {
366 if(channel.startsWith("@"))
367 op.append(channel.remove(0,1));
368 else if(channel.startsWith("+"))
369 voice.append(channel.remove(0,1));
371 user.append(channel);
374 displayMsg(e, Message::Server, tr("[Whois] %1 is a user on channels: %2").arg(nick, user.join(" ")));
376 displayMsg(e, Message::Server, tr("[Whois] %1 has voice on channels: %2").arg(nick, voice.join(" ")));
378 displayMsg(e, Message::Server, tr("[Whois] %1 is an operator on channels: %2").arg(nick, op.join(" ")));
381 /* RPL_LIST - "<channel> <# visible> :<topic>" */
382 void EventStringifier::processIrcEvent322(IrcEvent *e) {
384 quint32 userCount = 0;
387 switch(e->params().count()) {
389 topic = e->params()[2];
391 userCount = e->params()[1].toUInt();
393 channelName = e->params()[0];
397 displayMsg(e, Message::Server, tr("Channel %1 has %2 users. Topic is: \"%3\"")
398 .arg(channelName).arg(userCount).arg(topic));
401 /* RPL_LISTEND ":End of LIST" */
402 void EventStringifier::processIrcEvent323(IrcEvent *e) {
403 displayMsg(e, Message::Server, tr("End of channel list"));
406 /* RPL_CHANNELMODEIS - "<channel> <mode> <mode params>" */
407 void EventStringifier::processIrcEvent324(IrcEvent *e) {
408 processIrcEventMode(e);
411 /* RPL_??? - "<channel> <homepage> */
412 void EventStringifier::processIrcEvent328(IrcEvent *e) {
413 if(!checkParamCount(e, 2))
416 QString channel = e->params()[0];
417 displayMsg(e, Message::Topic, tr("Homepage for %1 is %2").arg(channel, e->params()[1]), QString(), channel);
420 /* RPL_??? - "<channel> <creation time (unix)>" */
421 void EventStringifier::processIrcEvent329(IrcEvent *e) {
422 if(!checkParamCount(e, 2))
425 QString channel = e->params()[0];
426 uint unixtime = e->params()[1].toUInt();
428 qWarning() << Q_FUNC_INFO << "received invalid timestamp:" << e->params()[1];
431 QDateTime time = QDateTime::fromTime_t(unixtime);
432 displayMsg(e, Message::Topic, tr("Channel %1 created on %2").arg(channel, time.toString()), QString(), channel);
435 /* RPL_WHOISACCOUNT: "<nick> <account> :is authed as */
436 void EventStringifier::processIrcEvent330(IrcEvent *e) {
437 if(e->params().count() < 3)
440 displayMsg(e, Message::Server, tr("[Whois] %1 is authed as %2").arg(e->params()[0], e->params()[1]));
444 void EventStringifier::processIrcEvent331(IrcEvent *e) {
445 QString channel = e->params().first();
446 displayMsg(e, Message::Topic, tr("No topic is set for %1.").arg(channel), QString(), channel);
450 void EventStringifier::processIrcEvent332(IrcEvent *e) {
451 QString channel = e->params().first();
452 displayMsg(e, Message::Topic, tr("Topic for %1 is \"%2\"").arg(channel, e->params()[1]), QString(), channel);
455 /* Topic set by... */
456 void EventStringifier::processIrcEvent333(IrcEvent *e) {
457 if(!checkParamCount(e, 3))
460 QString channel = e->params().first();
461 displayMsg(e, Message::Topic, tr("Topic set by %1 on %2")
462 .arg(e->params()[1], QDateTime::fromTime_t(e->params()[2].toInt()).toString()), QString(), channel);
465 /* RPL_INVITING - "<nick> <channel>*/
466 void EventStringifier::processIrcEvent341(IrcEvent *e) {
467 if(!checkParamCount(e, 2))
470 QString channel = e->params()[1];
471 displayMsg(e, Message::Server, tr("%1 has been invited to %2").arg(e->params().first(), channel), QString(), channel);
474 /* RPL_WHOREPLY: "<channel> <user> <host> <server> <nick>
475 ( "H" / "G" > ["*"] [ ( "@" / "+" ) ] :<hopcount> <real name>" */
476 void EventStringifier::processIrcEvent352(IrcEvent *e) {
477 displayMsg(e, Message::Server, tr("[Who] %1").arg(e->params().join(" ")));
480 /* RPL_ENDOFWHOWAS - "<nick> :End of WHOWAS" */
481 void EventStringifier::processIrcEvent369(IrcEvent *e) {
482 displayMsg(e, Message::Server, tr("End of /WHOWAS"));
485 /* ERR_ERRONEUSNICKNAME */
486 void EventStringifier::processIrcEvent432(IrcEvent *e) {
487 if(!checkParamCount(e, 1))
490 displayMsg(e, Message::Error, tr("Nick %1 contains illegal characters").arg(e->params()[0]));
493 /* ERR_NICKNAMEINUSE */
494 void EventStringifier::processIrcEvent433(IrcEvent *e) {
495 if(!checkParamCount(e, 1))
498 displayMsg(e, Message::Error, tr("Nick already in use: %1").arg(e->params()[0]));
501 /* ERR_UNAVAILRESOURCE */
502 void EventStringifier::processIrcEvent437(IrcEvent *e) {
503 if(!checkParamCount(e, 1))
506 displayMsg(e, Message::Error, tr("Nick/channel is temporarily unavailable: %1").arg(e->params()[0]));
512 void EventStringifier::processIrcEvent(IrcEvent *e) {
518 /*******************************/
519 /******** CTCP HANDLING ********/
520 /*******************************/
522 void EventStringifier::processCtcpEvent(CtcpEvent *e) {
523 if(e->type() != EventManager::CtcpEvent)
526 if(e->testFlag(EventManager::Self)) {
527 displayMsg(e, Message::Action, tr("sending CTCP-%1 request to %2").arg(e->ctcpCmd(), e->target()), e->network()->myNick());
531 handle(e->ctcpCmd(), Q_ARG(CtcpEvent *, e));
534 void EventStringifier::defaultHandler(const QString &ctcpCmd, CtcpEvent *e) {
536 if(e->ctcpType() == CtcpEvent::Query) {
538 if(e->reply().isNull()) // all known core-side handlers (except for ACTION) set a reply!
539 //: Optional "unknown" in "Received unknown CTCP-FOO request by bar"
540 unknown = tr("unknown") + ' ';
541 displayMsg(e, Message::Server, tr("Received %1CTCP-%2 request by %3").arg(unknown, e->ctcpCmd(), e->prefix()));
544 displayMsg(e, Message::Server, tr("Received CTCP-%1 answer from %2: %3").arg(e->ctcpCmd(), nickFromMask(e->prefix()), e->param()));
547 void EventStringifier::handleCtcpAction(CtcpEvent *e) {
548 displayMsg(e, Message::Action, e->param(), e->prefix(), e->target());
551 void EventStringifier::handleCtcpPing(CtcpEvent *e) {
552 if(e->ctcpType() == CtcpEvent::Query)
553 defaultHandler(e->ctcpCmd(), e);
555 displayMsg(e, Message::Server, tr("Received CTCP-PING answer from %1 with %2 seconds round trip time")
556 .arg(nickFromMask(e->prefix())).arg(QDateTime::fromTime_t(e->param().toInt()).secsTo(e->timestamp())));