77c7c526fd3bbc869ed82e64d371d8697077685b
[quassel.git] / src / core / eventstringifier.cpp
1 /***************************************************************************
2  *   Copyright (C) 2005-2012 by the Quassel Project                        *
3  *   devel@quassel-irc.org                                                 *
4  *                                                                         *
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.                                           *
9  *                                                                         *
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.                          *
14  *                                                                         *
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  ***************************************************************************/
20
21 #include "eventstringifier.h"
22
23 #include "coresession.h"
24 #include "ctcpevent.h"
25 #include "messageevent.h"
26
27 EventStringifier::EventStringifier(CoreSession *parent) : BasicHandler("handleCtcp", parent),
28   _coreSession(parent),
29   _whois(false)
30 {
31   connect(this, SIGNAL(newMessageEvent(Event *)), coreSession()->eventManager(), SLOT(postEvent(Event *)));
32 }
33
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))
37     return;
38
39   MessageEvent *msgEvent = createMessageEvent(event, msgType, msg, sender, target, msgFlags);
40   //sendMessageEvent(msgEvent);
41   emit newMessageEvent(msgEvent);
42 }
43
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());
48   return msgEvent;
49 }
50
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();
55     } else {
56       QString name = coreSession()->eventManager()->enumName(e->type());
57       qWarning() << qPrintable(name) << "requires" << minParams << "params, got:" << e->params();
58     }
59     e->stop();
60     return false;
61   }
62   return true;
63 }
64
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());
69 }
70
71 void EventStringifier::processNetworkSplitQuit(NetworkSplitEvent *e) {
72   QString msg = e->users().join("#:#") + "#:#" + e->quitMessage();
73   displayMsg(e, Message::NetsplitQuit, msg, QString(), e->channel());
74 }
75
76 /* End legacy */
77
78 void EventStringifier::processIrcEventNumeric(IrcEventNumeric *e) {
79   //qDebug() << e->number();
80   switch(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:
84   case 372: case 375:
85     displayMsg(e, Message::Server, e->params().join(" "), e->prefix());
86     break;
87
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());
93     break;
94
95   // Server error messages, display them in red. Colon between first param and rest.
96   case 401: {
97     if(!checkParamCount(e, 1))
98       return;
99
100     QStringList params = e->params();
101     QString target = params.takeFirst();
102     displayMsg(e, Message::Error, target + ": " + params.join(" "), e->prefix(), target, Message::Redirected);
103     break;
104   }
105
106   case 402: case 403: case 404: case 406: case 408: case 415: case 421: case 442: {
107     if(!checkParamCount(e, 1))
108       return;
109
110     QStringList params = e->params();
111     QString channelName = params.takeFirst();
112     displayMsg(e, Message::Error, channelName + ": " + params.join(" "), e->prefix());
113     break;
114   }
115
116   // Server error messages which will be displayed with a colon between the first param and the rest
117   case 413: case 414: case 423: case 441: case 444: case 461:  // FIXME see below for the 47x codes
118   case 467: case 471: case 473: case 474: case 475: case 476: case 477: case 478: case 482:
119   case 436: // ERR_NICKCOLLISION
120   {
121     if(!checkParamCount(e, 1))
122       return;
123
124     QStringList params = e->params();
125     QString p = params.takeFirst();
126     displayMsg(e, Message::Error, p + ": " + params.join(" "));
127     break;
128   }
129
130   // Ignore these commands.
131   case 321: case 353: case 366: case 376:
132     break;
133
134   // CAP stuff
135   case 900: case 903: case 904: case 905: case 906: case 907:
136   {
137     displayMsg(e, Message::Info, "CAP: " + e->params().join(""));
138     break;
139   }
140
141   // Everything else will be marked in red, so we can add them somewhere.
142   default:
143     if(_whois) {
144       // many nets define their own WHOIS fields. we fetch those not in need of special attention here:
145       displayMsg(e, Message::Server, tr("[Whois] ") + e->params().join(" "), e->prefix());
146     } else {
147       // FIXME figure out how/where to do this in the future
148       //if(coreSession()->ircListHelper()->requestInProgress(network()->networkId()))
149       //  coreSession()->ircListHelper()->reportError(params.join(" "));
150       //else
151         displayMsg(e, Message::Error, QString("%1 %2").arg(e->number(), 3, 10, QLatin1Char('0')).arg(e->params().join(" ")), e->prefix());
152     }
153   }
154 }
155
156 void EventStringifier::processIrcEventInvite(IrcEvent *e) {
157   displayMsg(e, Message::Invite, tr("%1 invited you to channel %2").arg(e->nick(), e->params().at(1)));
158 }
159
160 void EventStringifier::processIrcEventJoin(IrcEvent *e) {
161   if(e->testFlag(EventManager::Netsplit))
162     return;
163
164   displayMsg(e, Message::Join, e->params()[0], e->prefix(), e->params()[0]);
165 }
166
167 void EventStringifier::processIrcEventKick(IrcEvent *e) {
168   if(!checkParamCount(e, 2))
169     return;
170
171   IrcUser *victim = e->network()->ircUser(e->params().at(1));
172   if(victim) {
173     QString channel = e->params().at(0);
174     QString msg = victim->nick();
175     if(e->params().count() > 2)
176       msg += " " + e->params().at(2);
177
178     displayMsg(e, Message::Kick, msg, e->prefix(), channel);
179   }
180 }
181
182 void EventStringifier::processIrcEventMode(IrcEvent *e) {
183   if(e->network()->isChannelName(e->params().first())) {
184     // Channel Modes
185     displayMsg(e, Message::Mode, e->params().join(" "), e->prefix(), e->params().first());
186   } else {
187     // User Modes
188     // FIXME: redirect
189     displayMsg(e, Message::Mode, e->params().join(" "), e->prefix());
190   }
191 }
192
193 // this needs to be called before the ircuser is renamed!
194 void EventStringifier::processIrcEventNick(IrcEvent *e) {
195   if(!checkParamCount(e, 1))
196     return;
197
198   IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
199   if(!ircuser) {
200     qWarning() << Q_FUNC_INFO << "Unknown IrcUser!";
201     return;
202   }
203
204   QString newnick = e->params().at(0);
205   QString oldnick = ircuser->nick();
206
207   QString sender = e->network()->isMyNick(oldnick) ? newnick : e->prefix();
208   foreach(const QString &channel, ircuser->channels())
209     displayMsg(e, Message::Nick, newnick, sender, channel);
210 }
211
212 void EventStringifier::processIrcEventPart(IrcEvent *e) {
213   if(!checkParamCount(e, 1))
214     return;
215
216   QString channel = e->params().at(0);
217   QString msg = e->params().count() > 1? e->params().at(1) : QString();
218
219   displayMsg(e, Message::Part, msg, e->prefix(), channel);
220 }
221
222 void EventStringifier::processIrcEventPong(IrcEvent *e) {
223   QString timestamp = e->params().at(1);
224   QTime sendTime = QTime::fromString(timestamp, "hh:mm:ss.zzz");
225   if(!sendTime.isValid())
226     displayMsg(e, Message::Server, "PONG " + e->params().join(" "), e->prefix());
227 }
228
229 void EventStringifier::processIrcEventQuit(IrcEvent *e) {
230   if(e->testFlag(EventManager::Netsplit))
231     return;
232
233   IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
234   if(!ircuser)
235     return;
236
237   foreach(const QString &channel, ircuser->channels())
238     displayMsg(e, Message::Quit, e->params().count()? e->params().first() : QString(), e->prefix(), channel);
239 }
240
241 void EventStringifier::processIrcEventTopic(IrcEvent *e) {
242   displayMsg(e, Message::Topic, tr("%1 has changed topic for %2 to: \"%3\"")
243              .arg(e->nick(), e->params().at(0), e->params().at(1)), QString(), e->params().at(0));
244 }
245
246 /* RPL_ISUPPORT */
247 void EventStringifier::processIrcEvent005(IrcEvent *e) {
248   if(!e->params().last().contains(QRegExp("are supported (by|on) this server")))
249     displayMsg(e, Message::Error, tr("Received non-RFC-compliant RPL_ISUPPORT: this can lead to unexpected behavior!"), e->prefix());
250   displayMsg(e, Message::Server, e->params().join(" "), e->prefix());
251 }
252
253 /* RPL_AWAY - "<nick> :<away message>" */
254 void EventStringifier::processIrcEvent301(IrcEvent *e) {
255   QString nick = e->params().at(0);
256   QString awayMsg = e->params().at(1);
257   QString msg, target;
258   bool send = true;
259
260   // FIXME: proper redirection needed
261   if(_whois) {
262     msg = tr("[Whois] ");
263   } else {
264     target = nick;
265     IrcUser *ircuser = e->network()->ircUser(nick);
266     if(ircuser) {
267       int now = QDateTime::currentDateTime().toTime_t();
268       const int silenceTime = 60;
269       if(ircuser->lastAwayMessage() + silenceTime >= now)
270         send = false;
271       ircuser->setLastAwayMessage(now);
272     }
273   }
274   if(send)
275     displayMsg(e, Message::Server, msg + tr("%1 is away: \"%2\"").arg(nick, awayMsg), QString(), target);
276 }
277
278 /* RPL_UNAWAY - ":You are no longer marked as being away" */
279 void EventStringifier::processIrcEvent305(IrcEvent *e) {
280   displayMsg(e, Message::Server, tr("You are no longer marked as being away"));
281 }
282
283 /* RPL_NOWAWAY - ":You have been marked as being away" */
284 void EventStringifier::processIrcEvent306(IrcEvent *e) {
285   if(!e->network()->autoAwayActive())
286     displayMsg(e, Message::Server, tr("You have been marked as being away"));
287 }
288
289 /*
290 WHOIS-Message:
291    Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message.
292   and 301 (RPL_AWAY)
293               "<nick> :<away message>"
294 WHO-Message:
295    Replies 352 and 315 paired are used to answer a WHO message.
296
297 WHOWAS-Message:
298    Replies 314 and 369 are responses to a WHOWAS message.
299
300 */
301
302 /*  RPL_WHOISUSER - "<nick> <user> <host> * :<real name>" */
303 void EventStringifier::processIrcEvent311(IrcEvent *e) {
304   _whois = true;
305
306   const QString whoisUserString = tr("[Whois] %1 is %2 (%3)");
307
308   IrcUser *ircuser = e->network()->ircUser(e->params().at(0));
309   if(ircuser)
310     displayMsg(e, Message::Server, whoisUserString.arg(ircuser->nick(), ircuser->hostmask(), ircuser->realName()));
311   else {
312     QString host = QString("%1!%2@%3").arg(e->params().at(0), e->params().at(1), e->params().at(2));
313     displayMsg(e, Message::Server, whoisUserString.arg(e->params().at(0), host, e->params().last()));
314   }
315 }
316
317 /*  RPL_WHOISSERVER -  "<nick> <server> :<server info>" */
318 void EventStringifier::processIrcEvent312(IrcEvent *e) {
319   if(_whois)
320     displayMsg(e, Message::Server, tr("[Whois] %1 is online via %2 (%3)").arg(e->params().at(0), e->params().at(1), e->params().last()));
321   else
322     displayMsg(e, Message::Server, tr("[Whowas] %1 was online via %2 (%3)").arg(e->params().at(0), e->params().at(1), e->params().last()));
323 }
324
325 /*  RPL_WHOWASUSER - "<nick> <user> <host> * :<real name>" */
326 void EventStringifier::processIrcEvent314(IrcEvent *e) {
327   if(!checkParamCount(e, 3))
328     return;
329
330   displayMsg(e, Message::Server, tr("[Whowas] %1 was %2@%3 (%4)").arg(e->params()[0], e->params()[1], e->params()[2], e->params().last()));
331 }
332
333 /*  RPL_ENDOFWHO: "<name> :End of WHO list" */
334 void EventStringifier::processIrcEvent315(IrcEvent *e) {
335   QStringList p = e->params();
336   p.takeLast(); // should be "End of WHO list"
337   displayMsg(e, Message::Server, tr("[Who] End of /WHO list for %1").arg(p.join(" ")));
338 }
339
340 /*  RPL_WHOISIDLE - "<nick> <integer> :seconds idle"
341    (real life: "<nick> <integer> <integer> :seconds idle, signon time) */
342 void EventStringifier::processIrcEvent317(IrcEvent *e) {
343   int idleSecs = e->params()[1].toInt();
344
345   if(e->params().count() > 3) { // if we have more then 3 params we have the above mentioned "real life" situation
346     QDateTime loginTime = QDateTime::fromTime_t(e->params()[2].toInt());
347     displayMsg(e, Message::Server, tr("[Whois] %1 is logged in since %2").arg(e->params()[0], loginTime.toString()));
348   }
349   displayMsg(e, Message::Server, tr("[Whois] %1 is idling for %2 (since %3)")
350              .arg(e->params()[0], secondsToString(idleSecs), e->timestamp().toLocalTime().addSecs(-idleSecs).toString()));
351 }
352
353 /*  RPL_ENDOFWHOIS - "<nick> :End of WHOIS list" */
354 void EventStringifier::processIrcEvent318(IrcEvent *e) {
355   _whois = false;
356   displayMsg(e, Message::Server, tr("[Whois] End of /WHOIS list"));
357 }
358
359 /*  RPL_WHOISCHANNELS - "<nick> :*( ( "@" / "+" ) <channel> " " )" */
360 void EventStringifier::processIrcEvent319(IrcEvent *e) {
361   if(!checkParamCount(e, 2))
362     return;
363
364   QString nick = e->params().first();
365   QStringList op;
366   QStringList voice;
367   QStringList user;
368   foreach(QString channel, e->params().last().split(" ")) {
369     if(channel.startsWith("@"))
370        op.append(channel.remove(0,1));
371     else if(channel.startsWith("+"))
372       voice.append(channel.remove(0,1));
373     else
374       user.append(channel);
375   }
376   if(!user.isEmpty())
377     displayMsg(e, Message::Server, tr("[Whois] %1 is a user on channels: %2").arg(nick, user.join(" ")));
378   if(!voice.isEmpty())
379     displayMsg(e, Message::Server, tr("[Whois] %1 has voice on channels: %2").arg(nick, voice.join(" ")));
380   if(!op.isEmpty())
381     displayMsg(e, Message::Server, tr("[Whois] %1 is an operator on channels: %2").arg(nick, op.join(" ")));
382 }
383
384 /* RPL_LIST -  "<channel> <# visible> :<topic>" */
385 void EventStringifier::processIrcEvent322(IrcEvent *e) {
386   QString channelName;
387   quint32 userCount = 0;
388   QString topic;
389
390   switch(e->params().count()) {
391   case 3:
392     topic = e->params()[2];
393   case 2:
394     userCount = e->params()[1].toUInt();
395   case 1:
396     channelName = e->params()[0];
397   default:
398     break;
399   }
400   displayMsg(e, Message::Server, tr("Channel %1 has %2 users. Topic is: \"%3\"")
401              .arg(channelName).arg(userCount).arg(topic));
402 }
403
404 /* RPL_LISTEND ":End of LIST" */
405 void EventStringifier::processIrcEvent323(IrcEvent *e) {
406   displayMsg(e, Message::Server, tr("End of channel list"));
407 }
408
409 /* RPL_CHANNELMODEIS - "<channel> <mode> <mode params>" */
410 void EventStringifier::processIrcEvent324(IrcEvent *e) {
411   processIrcEventMode(e);
412 }
413
414 /* RPL_??? - "<channel> <homepage> */
415 void EventStringifier::processIrcEvent328(IrcEvent *e) {
416   if(!checkParamCount(e, 2))
417     return;
418
419   QString channel = e->params()[0];
420   displayMsg(e, Message::Topic, tr("Homepage for %1 is %2").arg(channel, e->params()[1]), QString(), channel);
421 }
422
423 /* RPL_??? - "<channel> <creation time (unix)>" */
424 void EventStringifier::processIrcEvent329(IrcEvent *e) {
425   if(!checkParamCount(e, 2))
426     return;
427
428   QString channel = e->params()[0];
429   uint unixtime = e->params()[1].toUInt();
430   if(!unixtime) {
431     qWarning() << Q_FUNC_INFO << "received invalid timestamp:" << e->params()[1];
432     return;
433   }
434   QDateTime time = QDateTime::fromTime_t(unixtime);
435   displayMsg(e, Message::Topic, tr("Channel %1 created on %2").arg(channel, time.toString()), QString(), channel);
436 }
437
438 /*  RPL_WHOISACCOUNT: "<nick> <account> :is authed as */
439 void EventStringifier::processIrcEvent330(IrcEvent *e) {
440   if(e->params().count() < 3)
441     return;
442
443   // check for whois or whowas
444   if (_whois) {
445     displayMsg(e, Message::Server, tr("[Whois] %1 is authed as %2").arg(e->params()[0], e->params()[1]));
446   } else {
447     displayMsg(e, Message::Server, tr("[Whowas] %1 was authed as %2").arg(e->params()[0], e->params()[1]));
448   }
449 }
450
451 /* RPL_NOTOPIC */
452 void EventStringifier::processIrcEvent331(IrcEvent *e) {
453   QString channel = e->params().first();
454   displayMsg(e, Message::Topic, tr("No topic is set for %1.").arg(channel), QString(), channel);
455 }
456
457 /* RPL_TOPIC */
458 void EventStringifier::processIrcEvent332(IrcEvent *e) {
459   QString channel = e->params().first();
460   displayMsg(e, Message::Topic, tr("Topic for %1 is \"%2\"").arg(channel, e->params()[1]), QString(), channel);
461 }
462
463 /* Topic set by... */
464 void EventStringifier::processIrcEvent333(IrcEvent *e) {
465   if(!checkParamCount(e, 3))
466     return;
467
468   QString channel = e->params().first();
469   displayMsg(e, Message::Topic, tr("Topic set by %1 on %2")
470              .arg(e->params()[1], QDateTime::fromTime_t(e->params()[2].toInt()).toString()), QString(), channel);
471 }
472
473 /* RPL_INVITING - "<nick> <channel>*/
474 void EventStringifier::processIrcEvent341(IrcEvent *e) {
475   if(!checkParamCount(e, 2))
476     return;
477
478   QString channel = e->params()[1];
479   displayMsg(e, Message::Server, tr("%1 has been invited to %2").arg(e->params().first(), channel), QString(), channel);
480 }
481
482 /*  RPL_WHOREPLY: "<channel> <user> <host> <server> <nick>
483               ( "H" / "G" > ["*"] [ ( "@" / "+" ) ] :<hopcount> <real name>" */
484 void EventStringifier::processIrcEvent352(IrcEvent *e) {
485   displayMsg(e, Message::Server, tr("[Who] %1").arg(e->params().join(" ")));
486 }
487
488 /*  RPL_ENDOFWHOWAS - "<nick> :End of WHOWAS" */
489 void EventStringifier::processIrcEvent369(IrcEvent *e) {
490   displayMsg(e, Message::Server, tr("End of /WHOWAS"));
491 }
492
493 /* ERR_ERRONEUSNICKNAME */
494 void EventStringifier::processIrcEvent432(IrcEvent *e) {
495   if(!checkParamCount(e, 1))
496     return;
497
498   displayMsg(e, Message::Error, tr("Nick %1 contains illegal characters").arg(e->params()[0]));
499 }
500
501 /* ERR_NICKNAMEINUSE */
502 void EventStringifier::processIrcEvent433(IrcEvent *e) {
503   if(!checkParamCount(e, 1))
504     return;
505
506   displayMsg(e, Message::Error, tr("Nick already in use: %1").arg(e->params()[0]));
507 }
508
509 /* ERR_UNAVAILRESOURCE */
510 void EventStringifier::processIrcEvent437(IrcEvent *e) {
511   if(!checkParamCount(e, 1))
512     return;
513
514   displayMsg(e, Message::Error, tr("Nick/channel is temporarily unavailable: %1").arg(e->params()[0]));
515 }
516
517 // template
518 /*
519
520 void EventStringifier::processIrcEvent(IrcEvent *e) {
521
522 }
523
524 */
525
526 /*******************************/
527 /******** CTCP HANDLING ********/
528 /*******************************/
529
530 void EventStringifier::processCtcpEvent(CtcpEvent *e) {
531   if(e->type() != EventManager::CtcpEvent)
532     return;
533
534   if(e->testFlag(EventManager::Self)) {
535     displayMsg(e, Message::Action, tr("sending CTCP-%1 request to %2").arg(e->ctcpCmd(), e->target()), e->network()->myNick());
536     return;
537   }
538
539   handle(e->ctcpCmd(), Q_ARG(CtcpEvent *, e));
540 }
541
542 void EventStringifier::defaultHandler(const QString &ctcpCmd, CtcpEvent *e) {
543   Q_UNUSED(ctcpCmd);
544   if(e->ctcpType() == CtcpEvent::Query) {
545     QString unknown;
546     if(e->reply().isNull()) // all known core-side handlers (except for ACTION) set a reply!
547       //: Optional "unknown" in "Received unknown CTCP-FOO request by bar"
548       unknown = tr("unknown") + ' ';
549     displayMsg(e, Message::Server, tr("Received %1CTCP-%2 request by %3").arg(unknown, e->ctcpCmd(), e->prefix()));
550     return;
551   }
552   displayMsg(e, Message::Server, tr("Received CTCP-%1 answer from %2: %3").arg(e->ctcpCmd(), nickFromMask(e->prefix()), e->param()));
553 }
554
555 void EventStringifier::handleCtcpAction(CtcpEvent *e) {
556   displayMsg(e, Message::Action, e->param(), e->prefix(), e->target());
557 }
558
559 void EventStringifier::handleCtcpPing(CtcpEvent *e) {
560   if(e->ctcpType() == CtcpEvent::Query)
561     defaultHandler(e->ctcpCmd(), e);
562   else {
563     displayMsg(e, Message::Server, tr("Received CTCP-PING answer from %1 with %2 seconds round trip time")
564                .arg(nickFromMask(e->prefix())).arg(QDateTime::fromTime_t(e->param().toInt()).secsTo(e->timestamp())));
565   }
566 }