bump © years
[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. First param will be appended.
96   case 401: {
97     if(!checkParamCount(e, 1))
98       return;
99
100     QString target = e->params().takeFirst();
101     displayMsg(e, Message::Error, e->params().join(" ") + " " + target, e->prefix(), target, Message::Redirected);
102     break;
103   }
104
105   case 402: case 403: case 404: case 406: case 408: case 415: case 421: case 442: {
106     if(!checkParamCount(e, 1))
107       return;
108
109     QString channelName = e->params().takeFirst();
110     displayMsg(e, Message::Error, e->params().join(" ") + " " + channelName, e->prefix());
111     break;
112   }
113
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
118   {
119     if(!checkParamCount(e, 1))
120       return;
121
122     QString p = e->params().takeFirst();
123     displayMsg(e, Message::Error, p + ": " + e->params().join(" "));
124     break;
125   }
126
127   // Ignore these commands.
128   case 321: case 353: case 366: case 376:
129     break;
130
131   // CAP stuff
132   case 900: case 903: case 904: case 905: case 906: case 907:
133   {
134     displayMsg(e, Message::Info, "CAP: " + e->params().join(""));
135     break;
136   }
137
138   // Everything else will be marked in red, so we can add them somewhere.
139   default:
140     if(_whois) {
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());
143     } else {
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(" "));
147       //else
148         displayMsg(e, Message::Error, QString("%1 %2").arg(e->number(), 3, 10, QLatin1Char('0')).arg(e->params().join(" ")), e->prefix());
149     }
150   }
151 }
152
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)));
155 }
156
157 void EventStringifier::processIrcEventJoin(IrcEvent *e) {
158   if(e->testFlag(EventManager::Netsplit))
159     return;
160
161   displayMsg(e, Message::Join, e->params()[0], e->prefix(), e->params()[0]);
162 }
163
164 void EventStringifier::processIrcEventKick(IrcEvent *e) {
165   if(!checkParamCount(e, 2))
166     return;
167
168   IrcUser *victim = e->network()->ircUser(e->params().at(1));
169   if(victim) {
170     QString channel = e->params().at(0);
171     QString msg = victim->nick();
172     if(e->params().count() > 2)
173       msg += " " + e->params().at(2);
174
175     displayMsg(e, Message::Kick, msg, e->prefix(), channel);
176   }
177 }
178
179 void EventStringifier::processIrcEventMode(IrcEvent *e) {
180   if(e->network()->isChannelName(e->params().first())) {
181     // Channel Modes
182     displayMsg(e, Message::Mode, e->params().join(" "), e->prefix(), e->params().first());
183   } else {
184     // User Modes
185     // FIXME: redirect
186     displayMsg(e, Message::Mode, e->params().join(" "), e->prefix());
187   }
188 }
189
190 // this needs to be called before the ircuser is renamed!
191 void EventStringifier::processIrcEventNick(IrcEvent *e) {
192   if(!checkParamCount(e, 1))
193     return;
194
195   IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
196   if(!ircuser) {
197     qWarning() << Q_FUNC_INFO << "Unknown IrcUser!";
198     return;
199   }
200
201   QString newnick = e->params().at(0);
202   QString oldnick = ircuser->nick();
203
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);
207 }
208
209 void EventStringifier::processIrcEventPart(IrcEvent *e) {
210   if(!checkParamCount(e, 1))
211     return;
212
213   QString channel = e->params().at(0);
214   QString msg = e->params().count() > 1? e->params().at(1) : QString();
215
216   displayMsg(e, Message::Part, msg, e->prefix(), channel);
217 }
218
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());
224 }
225
226 void EventStringifier::processIrcEventQuit(IrcEvent *e) {
227   if(e->testFlag(EventManager::Netsplit))
228     return;
229
230   IrcUser *ircuser = e->network()->updateNickFromMask(e->prefix());
231   if(!ircuser)
232     return;
233
234   foreach(const QString &channel, ircuser->channels())
235     displayMsg(e, Message::Quit, e->params().count()? e->params().first() : QString(), e->prefix(), channel);
236 }
237
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));
241 }
242
243 /* RPL_ISUPPORT */
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());
248 }
249
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);
254   QString msg, target;
255   bool send = true;
256
257   // FIXME: proper redirection needed
258   if(_whois) {
259     msg = tr("[Whois] ");
260   } else {
261     target = nick;
262     IrcUser *ircuser = e->network()->ircUser(nick);
263     if(ircuser) {
264       int now = QDateTime::currentDateTime().toTime_t();
265       const int silenceTime = 60;
266       if(ircuser->lastAwayMessage() + silenceTime >= now)
267         send = false;
268       ircuser->setLastAwayMessage(now);
269     }
270   }
271   if(send)
272     displayMsg(e, Message::Server, msg + tr("%1 is away: \"%2\"").arg(nick, awayMsg), QString(), target);
273 }
274
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"));
278 }
279
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"));
284 }
285
286 /*
287 WHOIS-Message:
288    Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message.
289   and 301 (RPL_AWAY)
290               "<nick> :<away message>"
291 WHO-Message:
292    Replies 352 and 315 paired are used to answer a WHO message.
293
294 WHOWAS-Message:
295    Replies 314 and 369 are responses to a WHOWAS message.
296
297 */
298
299 /*  RPL_WHOISUSER - "<nick> <user> <host> * :<real name>" */
300 void EventStringifier::processIrcEvent311(IrcEvent *e) {
301   _whois = true;
302
303   const QString whoisUserString = tr("[Whois] %1 is %2 (%3)");
304
305   IrcUser *ircuser = e->network()->ircUser(e->params().at(0));
306   if(ircuser)
307     displayMsg(e, Message::Server, whoisUserString.arg(ircuser->nick(), ircuser->hostmask(), ircuser->realName()));
308   else {
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()));
311   }
312 }
313
314 /*  RPL_WHOISSERVER -  "<nick> <server> :<server info>" */
315 void EventStringifier::processIrcEvent312(IrcEvent *e) {
316   if(_whois)
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()));
318   else
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()));
320 }
321
322 /*  RPL_WHOWASUSER - "<nick> <user> <host> * :<real name>" */
323 void EventStringifier::processIrcEvent314(IrcEvent *e) {
324   if(!checkParamCount(e, 3))
325     return;
326
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()));
328 }
329
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(" ")));
335 }
336
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();
341
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()));
345   }
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()));
348 }
349
350 /*  RPL_ENDOFWHOIS - "<nick> :End of WHOIS list" */
351 void EventStringifier::processIrcEvent318(IrcEvent *e) {
352   _whois = false;
353   displayMsg(e, Message::Server, tr("[Whois] End of /WHOIS list"));
354 }
355
356 /*  RPL_WHOISCHANNELS - "<nick> :*( ( "@" / "+" ) <channel> " " )" */
357 void EventStringifier::processIrcEvent319(IrcEvent *e) {
358   if(!checkParamCount(e, 2))
359     return;
360
361   QString nick = e->params().first();
362   QStringList op;
363   QStringList voice;
364   QStringList user;
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));
370     else
371       user.append(channel);
372   }
373   if(!user.isEmpty())
374     displayMsg(e, Message::Server, tr("[Whois] %1 is a user on channels: %2").arg(nick, user.join(" ")));
375   if(!voice.isEmpty())
376     displayMsg(e, Message::Server, tr("[Whois] %1 has voice on channels: %2").arg(nick, voice.join(" ")));
377   if(!op.isEmpty())
378     displayMsg(e, Message::Server, tr("[Whois] %1 is an operator on channels: %2").arg(nick, op.join(" ")));
379 }
380
381 /* RPL_LIST -  "<channel> <# visible> :<topic>" */
382 void EventStringifier::processIrcEvent322(IrcEvent *e) {
383   QString channelName;
384   quint32 userCount = 0;
385   QString topic;
386
387   switch(e->params().count()) {
388   case 3:
389     topic = e->params()[2];
390   case 2:
391     userCount = e->params()[1].toUInt();
392   case 1:
393     channelName = e->params()[0];
394   default:
395     break;
396   }
397   displayMsg(e, Message::Server, tr("Channel %1 has %2 users. Topic is: \"%3\"")
398              .arg(channelName).arg(userCount).arg(topic));
399 }
400
401 /* RPL_LISTEND ":End of LIST" */
402 void EventStringifier::processIrcEvent323(IrcEvent *e) {
403   displayMsg(e, Message::Server, tr("End of channel list"));
404 }
405
406 /* RPL_CHANNELMODEIS - "<channel> <mode> <mode params>" */
407 void EventStringifier::processIrcEvent324(IrcEvent *e) {
408   processIrcEventMode(e);
409 }
410
411 /* RPL_??? - "<channel> <homepage> */
412 void EventStringifier::processIrcEvent328(IrcEvent *e) {
413   if(!checkParamCount(e, 2))
414     return;
415
416   QString channel = e->params()[0];
417   displayMsg(e, Message::Topic, tr("Homepage for %1 is %2").arg(channel, e->params()[1]), QString(), channel);
418 }
419
420 /* RPL_??? - "<channel> <creation time (unix)>" */
421 void EventStringifier::processIrcEvent329(IrcEvent *e) {
422   if(!checkParamCount(e, 2))
423     return;
424
425   QString channel = e->params()[0];
426   uint unixtime = e->params()[1].toUInt();
427   if(!unixtime) {
428     qWarning() << Q_FUNC_INFO << "received invalid timestamp:" << e->params()[1];
429     return;
430   }
431   QDateTime time = QDateTime::fromTime_t(unixtime);
432   displayMsg(e, Message::Topic, tr("Channel %1 created on %2").arg(channel, time.toString()), QString(), channel);
433 }
434
435 /*  RPL_WHOISACCOUNT: "<nick> <account> :is authed as */
436 void EventStringifier::processIrcEvent330(IrcEvent *e) {
437   if(e->params().count() < 3)
438     return;
439
440   displayMsg(e, Message::Server, tr("[Whois] %1 is authed as %2").arg(e->params()[0], e->params()[1]));
441 }
442
443 /* RPL_NOTOPIC */
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);
447 }
448
449 /* RPL_TOPIC */
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);
453 }
454
455 /* Topic set by... */
456 void EventStringifier::processIrcEvent333(IrcEvent *e) {
457   if(!checkParamCount(e, 3))
458     return;
459
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);
463 }
464
465 /* RPL_INVITING - "<nick> <channel>*/
466 void EventStringifier::processIrcEvent341(IrcEvent *e) {
467   if(!checkParamCount(e, 2))
468     return;
469
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);
472 }
473
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(" ")));
478 }
479
480 /*  RPL_ENDOFWHOWAS - "<nick> :End of WHOWAS" */
481 void EventStringifier::processIrcEvent369(IrcEvent *e) {
482   displayMsg(e, Message::Server, tr("End of /WHOWAS"));
483 }
484
485 /* ERR_ERRONEUSNICKNAME */
486 void EventStringifier::processIrcEvent432(IrcEvent *e) {
487   if(!checkParamCount(e, 1))
488     return;
489
490   displayMsg(e, Message::Error, tr("Nick %1 contains illegal characters").arg(e->params()[0]));
491 }
492
493 /* ERR_NICKNAMEINUSE */
494 void EventStringifier::processIrcEvent433(IrcEvent *e) {
495   if(!checkParamCount(e, 1))
496     return;
497
498   displayMsg(e, Message::Error, tr("Nick already in use: %1").arg(e->params()[0]));
499 }
500
501 /* ERR_UNAVAILRESOURCE */
502 void EventStringifier::processIrcEvent437(IrcEvent *e) {
503   if(!checkParamCount(e, 1))
504     return;
505
506   displayMsg(e, Message::Error, tr("Nick/channel is temporarily unavailable: %1").arg(e->params()[0]));
507 }
508
509 // template
510 /*
511
512 void EventStringifier::processIrcEvent(IrcEvent *e) {
513
514 }
515
516 */
517
518 /*******************************/
519 /******** CTCP HANDLING ********/
520 /*******************************/
521
522 void EventStringifier::processCtcpEvent(CtcpEvent *e) {
523   if(e->type() != EventManager::CtcpEvent)
524     return;
525
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());
528     return;
529   }
530
531   handle(e->ctcpCmd(), Q_ARG(CtcpEvent *, e));
532 }
533
534 void EventStringifier::defaultHandler(const QString &ctcpCmd, CtcpEvent *e) {
535   Q_UNUSED(ctcpCmd);
536   if(e->ctcpType() == CtcpEvent::Query) {
537     QString unknown;
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()));
542     return;
543   }
544   displayMsg(e, Message::Server, tr("Received CTCP-%1 answer from %2: %3").arg(e->ctcpCmd(), nickFromMask(e->prefix()), e->param()));
545 }
546
547 void EventStringifier::handleCtcpAction(CtcpEvent *e) {
548   displayMsg(e, Message::Action, e->param(), e->prefix(), e->target());
549 }
550
551 void EventStringifier::handleCtcpPing(CtcpEvent *e) {
552   if(e->ctcpType() == CtcpEvent::Query)
553     defaultHandler(e->ctcpCmd(), e);
554   else {
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())));
557   }
558 }