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 QString target = e->params().takeFirst();
98 displayMsg(e, Message::Error, e->params().join(" ") + " " + target, e->prefix(), target, Message::Redirected);
102 case 402: case 403: case 404: case 406: case 408: case 415: case 421: case 442: {
103 QString channelName = e->params().takeFirst();
104 displayMsg(e, Message::Error, e->params().join(" ") + " " + channelName, e->prefix());
108 // Server error messages which will be displayed with a colon between the first param and the rest
109 case 413: case 414: case 423: case 441: case 444: case 461: // FIXME see below for the 47x codes
110 case 467: case 471: case 473: case 474: case 475: case 476: case 477: case 478: case 482:
111 case 436: // ERR_NICKCOLLISION
113 QString p = e->params().takeFirst();
114 displayMsg(e, Message::Error, p + ": " + e->params().join(" "));
118 // Ignore these commands.
119 case 321: case 353: case 366: case 376:
123 case 900: case 903: case 904: case 905: case 906: case 907:
125 displayMsg(e, Message::Info, "CAP: " + e->params().join(""));
129 // Everything else will be marked in red, so we can add them somewhere.
132 // many nets define their own WHOIS fields. we fetch those not in need of special attention here:
133 displayMsg(e, Message::Server, tr("[Whois] ") + e->params().join(" "), e->prefix());
135 // FIXME figure out how/where to do this in the future
136 //if(coreSession()->ircListHelper()->requestInProgress(network()->networkId()))
137 // coreSession()->ircListHelper()->reportError(params.join(" "));
139 displayMsg(e, Message::Error, QString("%1 %2").arg(e->number(), 3, 10, QLatin1Char('0')).arg(e->params().join(" ")), e->prefix());
144 void EventStringifier::processIrcEventInvite(IrcEvent *e) {
145 displayMsg(e, Message::Invite, tr("%1 invited you to channel %2").arg(e->nick(), e->params().at(1)));
148 void EventStringifier::processIrcEventJoin(IrcEvent *e) {
149 if(e->testFlag(EventManager::Netsplit))
152 displayMsg(e, Message::Join, e->params()[0], e->prefix(), e->params()[0]);
155 void EventStringifier::processIrcEventKick(IrcEvent *e) {
156 if(!checkParamCount(e, 2))
159 IrcUser *victim = e->network()->ircUser(e->params().at(1));
161 QString channel = e->params().at(0);
162 QString msg = victim->nick();
163 if(e->params().count() > 2)
164 msg += " " + e->params().at(2);
166 displayMsg(e, Message::Kick, msg, e->prefix(), channel);
170 void EventStringifier::processIrcEventMode(IrcEvent *e) {
171 if(e->network()->isChannelName(e->params().first())) {
173 displayMsg(e, Message::Mode, e->params().join(" "), e->prefix(), e->params().first());
177 displayMsg(e, Message::Mode, e->params().join(" "), e->prefix());
181 // this needs to be called before the ircuser is renamed!
182 void EventStringifier::processIrcEventNick(IrcEvent *e) {
183 if(!checkParamCount(e, 1))
186 IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
188 qWarning() << Q_FUNC_INFO << "Unknown IrcUser!";
192 QString newnick = e->params().at(0);
193 QString oldnick = ircuser->nick();
195 QString sender = e->network()->isMyNick(oldnick) ? newnick : e->prefix();
196 foreach(const QString &channel, ircuser->channels())
197 displayMsg(e, Message::Nick, newnick, sender, channel);
200 void EventStringifier::processIrcEventPart(IrcEvent *e) {
201 if(!checkParamCount(e, 1))
204 QString channel = e->params().at(0);
205 QString msg = e->params().count() > 1? e->params().at(1) : QString();
207 displayMsg(e, Message::Part, msg, e->prefix(), channel);
210 void EventStringifier::processIrcEventPong(IrcEvent *e) {
211 QString timestamp = e->params().at(1);
212 QTime sendTime = QTime::fromString(timestamp, "hh:mm:ss.zzz");
213 if(!sendTime.isValid())
214 displayMsg(e, Message::Server, "PONG " + e->params().join(" "), e->prefix());
217 void EventStringifier::processIrcEventQuit(IrcEvent *e) {
218 if(e->testFlag(EventManager::Netsplit))
221 IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
225 foreach(const QString &channel, ircuser->channels())
226 displayMsg(e, Message::Quit, e->params().count()? e->params().first() : QString(), e->prefix(), channel);
229 void EventStringifier::processIrcEventTopic(IrcEvent *e) {
230 displayMsg(e, Message::Topic, tr("%1 has changed topic for %2 to: \"%3\"")
231 .arg(e->nick(), e->params().at(0), e->params().at(1)), QString(), e->params().at(0));
235 void EventStringifier::processIrcEvent005(IrcEvent *e) {
236 if(!e->params().last().contains(QRegExp("are supported (by|on) this server")))
237 displayMsg(e, Message::Error, tr("Received non-RFC-compliant RPL_ISUPPORT: this can lead to unexpected behavior!"), e->prefix());
238 displayMsg(e, Message::Server, e->params().join(" "), e->prefix());
241 /* RPL_AWAY - "<nick> :<away message>" */
242 void EventStringifier::processIrcEvent301(IrcEvent *e) {
243 QString nick = e->params().at(0);
244 QString awayMsg = e->params().at(1);
248 // FIXME: proper redirection needed
250 msg = tr("[Whois] ");
253 IrcUser *ircuser = e->network()->ircUser(nick);
255 int now = QDateTime::currentDateTime().toTime_t();
256 const int silenceTime = 60;
257 if(ircuser->lastAwayMessage() + silenceTime >= now)
259 ircuser->setLastAwayMessage(now);
263 displayMsg(e, Message::Server, msg + tr("%1 is away: \"%2\"").arg(nick, awayMsg), QString(), target);
266 /* RPL_UNAWAY - ":You are no longer marked as being away" */
267 void EventStringifier::processIrcEvent305(IrcEvent *e) {
268 displayMsg(e, Message::Server, tr("You are no longer marked as being away"));
271 /* RPL_NOWAWAY - ":You have been marked as being away" */
272 void EventStringifier::processIrcEvent306(IrcEvent *e) {
273 if(!e->network()->autoAwayActive())
274 displayMsg(e, Message::Server, tr("You have been marked as being away"));
279 Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message.
281 "<nick> :<away message>"
283 Replies 352 and 315 paired are used to answer a WHO message.
286 Replies 314 and 369 are responses to a WHOWAS message.
290 /* RPL_WHOISUSER - "<nick> <user> <host> * :<real name>" */
291 void EventStringifier::processIrcEvent311(IrcEvent *e) {
294 const QString whoisUserString = tr("[Whois] %1 is %2 (%3)");
296 IrcUser *ircuser = e->network()->ircUser(e->params().at(0));
298 displayMsg(e, Message::Server, whoisUserString.arg(ircuser->nick(), ircuser->hostmask(), ircuser->realName()));
300 QString host = QString("%1!%2@%3").arg(e->params().at(0), e->params().at(1), e->params().at(2));
301 displayMsg(e, Message::Server, whoisUserString.arg(e->params().at(0), host, e->params().last()));
305 /* RPL_WHOISSERVER - "<nick> <server> :<server info>" */
306 void EventStringifier::processIrcEvent312(IrcEvent *e) {
308 displayMsg(e, Message::Server, tr("[Whois] %1 is online via %2 (%3)").arg(e->params().at(0), e->params().at(1), e->params().last()));
310 displayMsg(e, Message::Server, tr("[Whowas] %1 was online via %2 (%3)").arg(e->params().at(0), e->params().at(1), e->params().last()));
313 /* RPL_WHOWASUSER - "<nick> <user> <host> * :<real name>" */
314 void EventStringifier::processIrcEvent314(IrcEvent *e) {
315 if(!checkParamCount(e, 3))
318 displayMsg(e, Message::Server, tr("[Whowas] %1 was %2@%3 (%4)").arg(e->params()[0], e->params()[1], e->params()[2], e->params().last()));
321 /* RPL_ENDOFWHO: "<name> :End of WHO list" */
322 void EventStringifier::processIrcEvent315(IrcEvent *e) {
323 QStringList p = e->params();
324 p.takeLast(); // should be "End of WHO list"
325 displayMsg(e, Message::Server, tr("[Who] End of /WHO list for %1").arg(p.join(" ")));
328 /* RPL_WHOISIDLE - "<nick> <integer> :seconds idle"
329 (real life: "<nick> <integer> <integer> :seconds idle, signon time) */
330 void EventStringifier::processIrcEvent317(IrcEvent *e) {
331 int idleSecs = e->params()[1].toInt();
333 if(e->params().count() > 3) { // if we have more then 3 params we have the above mentioned "real life" situation
334 QDateTime loginTime = QDateTime::fromTime_t(e->params()[2].toInt());
335 displayMsg(e, Message::Server, tr("[Whois] %1 is logged in since %2").arg(e->params()[0], loginTime.toString()));
337 displayMsg(e, Message::Server, tr("[Whois] %1 is idling for %2 (since %3)")
338 .arg(e->params()[0], secondsToString(idleSecs), e->timestamp().toLocalTime().addSecs(-idleSecs).toString()));
341 /* RPL_ENDOFWHOIS - "<nick> :End of WHOIS list" */
342 void EventStringifier::processIrcEvent318(IrcEvent *e) {
344 displayMsg(e, Message::Server, tr("[Whois] End of /WHOIS list"));
347 /* RPL_WHOISCHANNELS - "<nick> :*( ( "@" / "+" ) <channel> " " )" */
348 void EventStringifier::processIrcEvent319(IrcEvent *e) {
349 if(!checkParamCount(e, 2))
352 QString nick = e->params().first();
356 foreach(QString channel, e->params().last().split(" ")) {
357 if(channel.startsWith("@"))
358 op.append(channel.remove(0,1));
359 else if(channel.startsWith("+"))
360 voice.append(channel.remove(0,1));
362 user.append(channel);
365 displayMsg(e, Message::Server, tr("[Whois] %1 is a user on channels: %2").arg(nick, user.join(" ")));
367 displayMsg(e, Message::Server, tr("[Whois] %1 has voice on channels: %2").arg(nick, voice.join(" ")));
369 displayMsg(e, Message::Server, tr("[Whois] %1 is an operator on channels: %2").arg(nick, op.join(" ")));
372 /* RPL_LIST - "<channel> <# visible> :<topic>" */
373 void EventStringifier::processIrcEvent322(IrcEvent *e) {
375 quint32 userCount = 0;
378 switch(e->params().count()) {
380 topic = e->params()[2];
382 userCount = e->params()[1].toUInt();
384 channelName = e->params()[0];
388 displayMsg(e, Message::Server, tr("Channel %1 has %2 users. Topic is: \"%3\"")
389 .arg(channelName).arg(userCount).arg(topic));
392 /* RPL_LISTEND ":End of LIST" */
393 void EventStringifier::processIrcEvent323(IrcEvent *e) {
394 displayMsg(e, Message::Server, tr("End of channel list"));
397 /* RPL_CHANNELMODEIS - "<channel> <mode> <mode params>" */
398 void EventStringifier::processIrcEvent324(IrcEvent *e) {
399 processIrcEventMode(e);
402 /* RPL_??? - "<channel> <homepage> */
403 void EventStringifier::processIrcEvent328(IrcEvent *e) {
404 if(!checkParamCount(e, 2))
407 QString channel = e->params()[0];
408 displayMsg(e, Message::Topic, tr("Homepage for %1 is %2").arg(channel, e->params()[1]), QString(), channel);
411 /* RPL_??? - "<channel> <creation time (unix)>" */
412 void EventStringifier::processIrcEvent329(IrcEvent *e) {
413 if(!checkParamCount(e, 2))
416 QString channel = e->params()[0];
417 uint unixtime = e->params()[1].toUInt();
419 qWarning() << Q_FUNC_INFO << "received invalid timestamp:" << e->params()[1];
422 QDateTime time = QDateTime::fromTime_t(unixtime);
423 displayMsg(e, Message::Topic, tr("Channel %1 created on %2").arg(channel, time.toString()), QString(), channel);
426 /* RPL_WHOISACCOUNT: "<nick> <account> :is authed as */
427 void EventStringifier::processIrcEvent330(IrcEvent *e) {
428 if(e->params().count() < 3)
431 displayMsg(e, Message::Server, tr("[Whois] %1 is authed as %2").arg(e->params()[0], e->params()[1]));
435 void EventStringifier::processIrcEvent331(IrcEvent *e) {
436 QString channel = e->params().first();
437 displayMsg(e, Message::Topic, tr("No topic is set for %1.").arg(channel), QString(), channel);
441 void EventStringifier::processIrcEvent332(IrcEvent *e) {
442 QString channel = e->params().first();
443 displayMsg(e, Message::Topic, tr("Topic for %1 is \"%2\"").arg(channel, e->params()[1]), QString(), channel);
446 /* Topic set by... */
447 void EventStringifier::processIrcEvent333(IrcEvent *e) {
448 if(!checkParamCount(e, 3))
451 QString channel = e->params().first();
452 displayMsg(e, Message::Topic, tr("Topic set by %1 on %2")
453 .arg(e->params()[1], QDateTime::fromTime_t(e->params()[2].toInt()).toString()), QString(), channel);
456 /* RPL_INVITING - "<nick> <channel>*/
457 void EventStringifier::processIrcEvent341(IrcEvent *e) {
458 if(!checkParamCount(e, 2))
461 QString channel = e->params()[1];
462 displayMsg(e, Message::Server, tr("%1 has been invited to %2").arg(e->params().first(), channel), QString(), channel);
465 /* RPL_WHOREPLY: "<channel> <user> <host> <server> <nick>
466 ( "H" / "G" > ["*"] [ ( "@" / "+" ) ] :<hopcount> <real name>" */
467 void EventStringifier::processIrcEvent352(IrcEvent *e) {
468 displayMsg(e, Message::Server, tr("[Who] %1").arg(e->params().join(" ")));
471 /* RPL_ENDOFWHOWAS - "<nick> :End of WHOWAS" */
472 void EventStringifier::processIrcEvent369(IrcEvent *e) {
473 displayMsg(e, Message::Server, tr("End of /WHOWAS"));
476 /* ERR_ERRONEUSNICKNAME */
477 void EventStringifier::processIrcEvent432(IrcEvent *e) {
478 displayMsg(e, Message::Error, tr("Nick %1 contains illegal characters").arg(e->params()[0]));
481 /* ERR_NICKNAMEINUSE */
482 void EventStringifier::processIrcEvent433(IrcEvent *e) {
483 displayMsg(e, Message::Error, tr("Nick already in use: %1").arg(e->params()[0]));
486 /* ERR_UNAVAILRESOURCE */
487 void EventStringifier::processIrcEvent437(IrcEvent *e) {
488 displayMsg(e, Message::Error, tr("Nick/channel is temporarily unavailable: %1").arg(e->params()[0]));
494 void EventStringifier::processIrcEvent(IrcEvent *e) {
500 /*******************************/
501 /******** CTCP HANDLING ********/
502 /*******************************/
504 void EventStringifier::processCtcpEvent(CtcpEvent *e) {
505 if(e->type() != EventManager::CtcpEvent)
508 if(e->testFlag(EventManager::Self)) {
509 displayMsg(e, Message::Action, tr("sending CTCP-%1 request to %2").arg(e->ctcpCmd(), e->target()), e->network()->myNick());
513 handle(e->ctcpCmd(), Q_ARG(CtcpEvent *, e));
516 void EventStringifier::defaultHandler(const QString &ctcpCmd, CtcpEvent *e) {
518 if(e->ctcpType() == CtcpEvent::Query) {
520 if(e->reply().isNull()) // all known core-side handlers (except for ACTION) set a reply!
521 //: Optional "unknown" in "Received unknown CTCP-FOO request by bar"
522 unknown = tr("unknown") + ' ';
523 displayMsg(e, Message::Server, tr("Received %1CTCP-%2 request by %3").arg(unknown, e->ctcpCmd(), e->prefix()));
526 displayMsg(e, Message::Server, tr("Received CTCP-%1 answer from %2: %3").arg(e->ctcpCmd(), nickFromMask(e->prefix()), e->param()));
529 void EventStringifier::handleCtcpAction(CtcpEvent *e) {
530 displayMsg(e, Message::Action, e->param(), e->prefix(), e->target());
533 void EventStringifier::handleCtcpPing(CtcpEvent *e) {
534 if(e->ctcpType() == CtcpEvent::Query)
535 defaultHandler(e->ctcpCmd(), e);
537 displayMsg(e, Message::Server, tr("Received CTCP-PING answer from %1 with %2 seconds round trip time")
538 .arg(nickFromMask(e->prefix())).arg(QDateTime::fromTime_t(e->param().toInt()).secsTo(e->timestamp())));