b03b0d718c406281324169f14ca64beffdb36eed
[quassel.git] / src / core / ircserverhandler.cpp
1 /***************************************************************************
2  *   Copyright (C) 2005-09 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 #include "ircserverhandler.h"
21
22 #include "util.h"
23
24 #include "coresession.h"
25 #include "coreirclisthelper.h"
26 #include "coreidentity.h"
27 #include "ctcphandler.h"
28
29 #include "ircuser.h"
30 #include "coreircchannel.h"
31 #include "logger.h"
32
33 #include <QDebug>
34
35 IrcServerHandler::IrcServerHandler(CoreNetwork *parent)
36   : BasicHandler(parent),
37     _whois(false)
38 {
39 }
40
41 IrcServerHandler::~IrcServerHandler() {
42 }
43
44 /*! Handle a raw message string sent by the server. We try to find a suitable handler, otherwise we call a default handler. */
45 void IrcServerHandler::handleServerMsg(QByteArray msg) {
46   if(msg.isEmpty()) {
47     qWarning() << "Received empty string from server!";
48     return;
49   }
50
51   // Now we split the raw message into its various parts...
52   QString prefix = "";
53   QByteArray trailing;
54   QString cmd;
55
56   // First, check for a trailing parameter introduced by " :", since this might screw up splitting the msg
57   // NOTE: This assumes that this is true in raw encoding, but well, hopefully there are no servers running in japanese on protocol level...
58   int idx = msg.indexOf(" :");
59   if(idx >= 0) {
60     if(msg.length() > idx + 2)
61       trailing = msg.mid(idx + 2);
62     msg = msg.left(idx);
63   }
64   // OK, now it is safe to split...
65   QList<QByteArray> params = msg.split(' ');
66
67   // This could still contain empty elements due to (faulty?) ircds sending multiple spaces in a row
68   // Also, QByteArray is not nearly as convenient to work with as QString for such things :)
69   QList<QByteArray>::iterator iter = params.begin();
70   while(iter != params.end()) {
71     if(iter->isEmpty())
72       iter = params.erase(iter);
73     else
74       ++iter;
75   }
76
77   if(!trailing.isEmpty()) params << trailing;
78   if(params.count() < 1) {
79     qWarning() << "Received invalid string from server!";
80     return;
81   }
82
83   QString foo = serverDecode(params.takeFirst());
84
85   // a colon as the first chars indicates the existence of a prefix
86   if(foo[0] == ':') {
87     foo.remove(0, 1);
88     prefix = foo;
89     if(params.count() < 1) {
90       qWarning() << "Received invalid string from server!";
91       return;
92     }
93     foo = serverDecode(params.takeFirst());
94   }
95
96   // next string without a whitespace is the command
97   cmd = foo.trimmed().toUpper();
98
99   // numeric replies have the target as first param (RFC 2812 - 2.4). this is usually our own nick. Remove this!
100   uint num = cmd.toUInt();
101   if(num > 0) {
102     if(params.count() == 0) {
103       qWarning() << "Message received from server violates RFC and is ignored!" << msg;
104       return;
105     }
106     _target = serverDecode(params.takeFirst());
107   } else {
108     _target = QString();
109   }
110
111   // note that the IRC server is still alive
112   network()->resetPingTimeout();
113
114   // Now we try to find a handler for this message. BTW, I do love the Trolltech guys ;-)
115   handle(cmd, Q_ARG(QString, prefix), Q_ARG(QList<QByteArray>, params));
116 }
117
118
119 void IrcServerHandler::defaultHandler(QString cmd, const QString &prefix, const QList<QByteArray> &rawparams) {
120   // we assume that all this happens in server encoding
121   QStringList params = serverDecode(rawparams);
122   uint num = cmd.toUInt();
123   if(num) {
124     // A lot of server messages don't really need their own handler because they don't do much.
125     // Catch and handle these here.
126     switch(num) {
127       // Welcome, status, info messages. Just display these.
128       case 2: case 3: case 4: case 5: case 251: case 252: case 253: case 254: case 255: case 372: case 375:
129         emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", params.join(" "), prefix);
130         break;
131       // Server error messages without param, just display them
132       case 409: case 411: case 412: case 422: case 424: case 445: case 446: case 451: case 462:
133       case 463: case 464: case 465: case 466: case 472: case 481: case 483: case 485: case 491: case 501: case 502:
134       case 431: // ERR_NONICKNAMEGIVEN
135         emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", params.join(" "), prefix);
136         break;
137       // Server error messages, display them in red. First param will be appended.
138       case 401: {
139         QString target = params.takeFirst();
140         emit displayMsg(Message::Error, target, params.join(" ") + " " + target, prefix, Message::Redirected);
141         break;
142       }
143       case 402: case 403: case 404: case 406: case 408: case 415: case 421: case 442: {
144         QString channelName = params.takeFirst();
145         emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", params.join(" ") + " " + channelName, prefix);
146         break;
147       }
148       // Server error messages which will be displayed with a colon between the first param and the rest
149       case 413: case 414: case 423: case 441: case 444: case 461:  // FIXME see below for the 47x codes
150       case 467: case 471: case 473: case 474: case 475: case 476: case 477: case 478: case 482:
151       case 436: // ERR_NICKCOLLISION
152       {
153         QString p = params.takeFirst();
154         emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", p + ": " + params.join(" "));
155         break;
156       }
157       // Ignore these commands.
158       case 321: case 366: case 376:
159         break;
160
161       // Everything else will be marked in red, so we can add them somewhere.
162       default:
163         if(_whois) {
164           // many nets define their own WHOIS fields. we fetch those not in need of special attention here:
165           emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", "[Whois] " + params.join(" "), prefix);
166         } else {
167           if(coreSession()->ircListHelper()->requestInProgress(network()->networkId()))
168             coreSession()->ircListHelper()->reportError(params.join(" "));
169           else
170             emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", cmd + " " + params.join(" "), prefix);
171         }
172     }
173     //qDebug() << prefix <<":"<<cmd<<params;
174   } else {
175     emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Unknown: ") + cmd + " " + params.join(" "), prefix);
176     //qDebug() << prefix <<":"<<cmd<<params;
177   }
178 }
179
180 //******************************/
181 // IRC SERVER HANDLER
182 //******************************/
183 void IrcServerHandler::handleJoin(const QString &prefix, const QList<QByteArray> &params) {
184   if(!checkParamCount("IrcServerHandler::handleJoin()", params, 1))
185     return;
186
187   QString channel = serverDecode(params[0]);
188   IrcUser *ircuser = network()->updateNickFromMask(prefix);
189
190   bool handledByNetsplit = false;
191   if(!_netsplits.empty()) {
192     foreach(Netsplit* n, _netsplits) {
193       handledByNetsplit = n->userJoined(prefix, channel);
194       if(handledByNetsplit)
195         break;
196     }
197   }
198
199   // normal join
200   if(!handledByNetsplit) {
201     emit displayMsg(Message::Join, BufferInfo::ChannelBuffer, channel, channel, prefix);
202     ircuser->joinChannel(channel);
203   }
204   //qDebug() << "IrcServerHandler::handleJoin()" << prefix << params;
205
206   if(network()->isMe(ircuser)) {
207     network()->setChannelJoined(channel);
208     putCmd("MODE", params[0]); // we want to know the modes of the channel we just joined, so we ask politely
209   }
210 }
211
212 void IrcServerHandler::handleKick(const QString &prefix, const QList<QByteArray> &params) {
213   if(!checkParamCount("IrcServerHandler::handleKick()", params, 2))
214     return;
215
216   network()->updateNickFromMask(prefix);
217   IrcUser *victim = network()->ircUser(params[1]);
218   if(!victim)
219     return;
220
221   QString channel = serverDecode(params[0]);
222   victim->partChannel(channel);
223
224   QString msg;
225   if(params.count() > 2) // someone got a reason!
226     msg = QString("%1 %2").arg(victim->nick()).arg(channelDecode(channel, params[2]));
227   else
228     msg = victim->nick();
229
230   emit displayMsg(Message::Kick, BufferInfo::ChannelBuffer, channel, msg, prefix);
231   //if(network()->isMe(victim)) network()->setKickedFromChannel(channel);
232 }
233
234 void IrcServerHandler::handleMode(const QString &prefix, const QList<QByteArray> &params) {
235   if(!checkParamCount("IrcServerHandler::handleMode()", params, 2))
236     return;
237
238   if(network()->isChannelName(serverDecode(params[0]))) {
239     // Channel Modes
240     emit displayMsg(Message::Mode, BufferInfo::ChannelBuffer, serverDecode(params[0]), serverDecode(params).join(" "), prefix);
241
242     IrcChannel *channel = network()->ircChannel(params[0]);
243     if(!channel) {
244       // we received mode information for a channel we're not in. that means probably we've just been kicked out or something like that
245       // anyways: we don't have a place to store the data --> discard the info.
246       return;
247     }
248
249     QString modes = params[1];
250     bool add = true;
251     int paramOffset = 2;
252     for(int c = 0; c < modes.length(); c++) {
253       if(modes[c] == '+') {
254         add = true;
255         continue;
256       }
257       if(modes[c] == '-') {
258         add = false;
259         continue;
260       }
261
262       if(network()->prefixModes().contains(modes[c])) {
263         // user channel modes (op, voice, etc...)
264         if(paramOffset < params.count()) {
265           IrcUser *ircUser = network()->ircUser(params[paramOffset]);
266           if(add)
267             channel->addUserMode(ircUser, QString(modes[c]));
268           else
269             channel->removeUserMode(ircUser, QString(modes[c]));
270         } else {
271           qWarning() << "Received MODE with too few parameters:" << serverDecode(params);
272         }
273         paramOffset++;
274       } else {
275         // regular channel modes
276         QString value;
277         Network::ChannelModeType modeType = network()->channelModeType(modes[c]);
278         if(modeType == Network::A_CHANMODE || modeType == Network::B_CHANMODE || (modeType == Network::C_CHANMODE && add)) {
279           if(paramOffset < params.count()) {
280             value = params[paramOffset];
281           } else {
282             qWarning() << "Received MODE with too few parameters:" << serverDecode(params);
283           }
284           paramOffset++;
285         }
286
287         if(add)
288           channel->addChannelMode(modes[c], value);
289         else
290           channel->removeChannelMode(modes[c], value);
291       }
292     }
293
294   } else {
295     // pure User Modes
296     IrcUser *ircUser = network()->newIrcUser(params[0]);
297     QString modeString(serverDecode(params[1]));
298     QString addModes;
299     QString removeModes;
300     bool add = false;
301     for(int c = 0; c < modeString.count(); c++) {
302       if(modeString[c] == '+') {
303         add = true;
304         continue;
305       }
306       if(modeString[c] == '-') {
307         add = false;
308         continue;
309       }
310       if(add)
311         addModes += modeString[c];
312       else
313         removeModes += modeString[c];
314     }
315     if(!addModes.isEmpty())
316       ircUser->addUserModes(addModes);
317     if(!removeModes.isEmpty())
318       ircUser->removeUserModes(removeModes);
319
320     // FIXME: redirect
321     emit displayMsg(Message::Mode, BufferInfo::StatusBuffer, "", serverDecode(params).join(" "), prefix);
322   }
323 }
324
325 void IrcServerHandler::handleNick(const QString &prefix, const QList<QByteArray> &params) {
326   if(!checkParamCount("IrcServerHandler::handleNick()", params, 1))
327     return;
328
329   IrcUser *ircuser = network()->updateNickFromMask(prefix);
330   if(!ircuser) {
331     qWarning() << "IrcServerHandler::handleNick(): Unknown IrcUser!";
332     return;
333   }
334   QString newnick = serverDecode(params[0]);
335   QString oldnick = ircuser->nick();
336
337   QString sender = network()->isMyNick(oldnick)
338     ? newnick
339     : prefix;
340
341
342   // the order is cruicial
343   // otherwise the client would rename the buffer, see that the assigned ircuser doesn't match anymore
344   // and remove the ircuser from the querybuffer leading to a wrong on/offline state
345   ircuser->setNick(newnick);
346   coreSession()->renameBuffer(network()->networkId(), newnick, oldnick);
347
348   foreach(QString channel, ircuser->channels())
349     emit displayMsg(Message::Nick, BufferInfo::ChannelBuffer, channel, newnick, sender);
350 }
351
352 void IrcServerHandler::handleNotice(const QString &prefix, const QList<QByteArray> &params) {
353   if(!checkParamCount("IrcServerHandler::handleNotice()", params, 2))
354     return;
355
356
357   QStringList targets = serverDecode(params[0]).split(',', QString::SkipEmptyParts);
358   QStringList::const_iterator targetIter;
359   for(targetIter = targets.constBegin(); targetIter != targets.constEnd(); targetIter++) {
360     QString target = *targetIter;
361
362     // special treatment for welcome messages like:
363     // :ChanServ!ChanServ@services. NOTICE egst :[#apache] Welcome, this is #apache. Please read the in-channel topic message. This channel is being logged by IRSeekBot. If you have any question please see http://blog.freenode.net/?p=68
364     if(!network()->isChannelName(target)) {
365       QString msg = serverDecode(params[1]);
366       QRegExp welcomeRegExp("^\\[([^\\]]+)\\] ");
367       if(welcomeRegExp.indexIn(msg) != -1) {
368         QString channelname = welcomeRegExp.cap(1);
369         msg = msg.mid(welcomeRegExp.matchedLength());
370         CoreIrcChannel *chan = static_cast<CoreIrcChannel *>(network()->ircChannel(channelname)); // we only have CoreIrcChannels in the core, so this cast is safe
371         if(chan && !chan->receivedWelcomeMsg()) {
372           chan->setReceivedWelcomeMsg();
373           emit displayMsg(Message::Notice, BufferInfo::ChannelBuffer, channelname, msg, prefix);
374           continue;
375         }
376       }
377     }
378
379     if(prefix.isEmpty() || target == "AUTH") {
380       target = "";
381     } else {
382       if(!target.isEmpty() && network()->prefixes().contains(target[0]))
383         target = target.mid(1);
384       if(!network()->isChannelName(target))
385         target = nickFromMask(prefix);
386     }
387
388     network()->ctcpHandler()->parse(Message::Notice, prefix, target, params[1]);
389   }
390
391 }
392
393 void IrcServerHandler::handlePart(const QString &prefix, const QList<QByteArray> &params) {
394   if(!checkParamCount("IrcServerHandler::handlePart()", params, 1))
395     return;
396
397   IrcUser *ircuser = network()->updateNickFromMask(prefix);
398   QString channel = serverDecode(params[0]);
399   if(!ircuser) {
400     qWarning() << "IrcServerHandler::handlePart(): Unknown IrcUser!";
401     return;
402   }
403
404   ircuser->partChannel(channel);
405
406   QString msg;
407   if(params.count() > 1)
408     msg = userDecode(ircuser->nick(), params[1]);
409
410   emit displayMsg(Message::Part, BufferInfo::ChannelBuffer, channel, msg, prefix);
411   if(network()->isMe(ircuser)) network()->setChannelParted(channel);
412 }
413
414 void IrcServerHandler::handlePing(const QString &prefix, const QList<QByteArray> &params) {
415   Q_UNUSED(prefix);
416   putCmd("PONG", params);
417 }
418
419 void IrcServerHandler::handlePong(const QString &prefix, const QList<QByteArray> &params) {
420   Q_UNUSED(prefix);
421   // the server is supposed to send back what we passed as param. and we send a timestamp
422   // but using quote and whatnought one can send arbitrary pings, so we have to do some sanity checks
423   if(params.count() < 2)
424     return;
425
426   QString timestamp = serverDecode(params[1]);
427   QTime sendTime = QTime::fromString(timestamp, "hh:mm:ss.zzz");
428   if(!sendTime.isValid()) {
429     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", "PONG " + serverDecode(params).join(" "), prefix);
430     return;
431   }
432
433   network()->setLatency(sendTime.msecsTo(QTime::currentTime()) / 2);
434 }
435
436 void IrcServerHandler::handlePrivmsg(const QString &prefix, const QList<QByteArray> &params) {
437   if(!checkParamCount("IrcServerHandler::handlePrivmsg()", params, 1))
438     return;
439
440   IrcUser *ircuser = network()->updateNickFromMask(prefix);
441   if(!ircuser) {
442     qWarning() << "IrcServerHandler::handlePrivmsg(): Unknown IrcUser!";
443     return;
444   }
445
446   if(params.isEmpty()) {
447     qWarning() << "IrcServerHandler::handlePrivmsg(): received PRIVMSG without target or message from:" << prefix;
448     return;
449   }
450
451   QString senderNick = nickFromMask(prefix);
452
453   QByteArray msg = params.count() < 2
454     ? QByteArray("")
455     : params[1];
456
457   QStringList targets = serverDecode(params[0]).split(',', QString::SkipEmptyParts);
458   QStringList::const_iterator targetIter;
459   for(targetIter = targets.constBegin(); targetIter != targets.constEnd(); targetIter++) {
460     const QString &target = network()->isChannelName(*targetIter)
461       ? *targetIter
462       : senderNick;
463
464     // it's possible to pack multiple privmsgs into one param using ctcp
465     // - > we let the ctcpHandler do the work
466     network()->ctcpHandler()->parse(Message::Plain, prefix, target, msg);
467   }
468 }
469
470 void IrcServerHandler::handleQuit(const QString &prefix, const QList<QByteArray> &params) {
471   IrcUser *ircuser = network()->updateNickFromMask(prefix);
472   if(!ircuser) return;
473
474   QString msg;
475   if(params.count() > 0)
476     msg = userDecode(ircuser->nick(), params[0]);
477
478   // check if netsplit
479   if(Netsplit::isNetsplit(msg)) {
480     Netsplit *n;
481     if(!_netsplits.contains(msg)) {
482       n = new Netsplit();
483       connect(n, SIGNAL(finished()), this, SLOT(handleNetsplitFinished()));
484       connect(n, SIGNAL(netsplitJoin(QString,QStringList,QString)), this, SLOT(handleNetsplitJoin(QString,QStringList,QString)));
485       connect(n, SIGNAL(netsplitQuit(QString,QStringList,QString)), this, SLOT(handleNetsplitQuit(QString,QStringList,QString)));
486       _netsplits.insert(msg, n);
487     }
488     else {
489       n = _netsplits[msg];
490     }
491     // add this user to the netsplit
492     n->userQuit(prefix, ircuser->channels(),msg);
493   }
494   // normal quit
495   else {
496     foreach(QString channel, ircuser->channels())
497       emit displayMsg(Message::Quit, BufferInfo::ChannelBuffer, channel, msg, prefix);
498     ircuser->quit();
499   }
500 }
501
502 void IrcServerHandler::handleTopic(const QString &prefix, const QList<QByteArray> &params) {
503   if(!checkParamCount("IrcServerHandler::handleTopic()", params, 1))
504     return;
505
506   IrcUser *ircuser = network()->updateNickFromMask(prefix);
507   if(!ircuser)
508     return;
509
510   IrcChannel *channel = network()->ircChannel(serverDecode(params[0]));
511   if(!channel)
512     return;
513
514   QString topic;
515   if(params.count() > 1)
516     topic = channelDecode(channel->name(), params[1]);
517
518   channel->setTopic(topic);
519
520   emit displayMsg(Message::Topic, BufferInfo::ChannelBuffer, channel->name(), tr("%1 has changed topic for %2 to: \"%3\"").arg(ircuser->nick()).arg(channel->name()).arg(topic));
521 }
522
523 /* RPL_WELCOME */
524 void IrcServerHandler::handle001(const QString &prefix, const QList<QByteArray> &params) {
525   network()->setCurrentServer(prefix);
526
527   if(params.isEmpty()) {
528     emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("%1 didn't supply a valid welcome message... expect some serious issues..."));
529   }
530   // there should be only one param: "Welcome to the Internet Relay Network <nick>!<user>@<host>"
531   QString param = serverDecode(params[0]);
532   QString myhostmask = param.section(' ', -1, -1);
533
534   network()->setMyNick(nickFromMask(myhostmask));
535
536   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", param, prefix);
537 }
538
539 /* RPL_ISUPPORT */
540 // TODO Complete 005 handling, also use sensible defaults for non-sent stuff
541 void IrcServerHandler::handle005(const QString &prefix, const QList<QByteArray> &params) {
542   Q_UNUSED(prefix);
543   const int numParams = params.size();
544   if(numParams == 0) {
545     emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Received RPL_ISUPPORT (005) without parameters!"), prefix);
546     return;
547   }
548
549   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", serverDecode(params).join(" "), prefix);
550
551   QString rpl_isupport_suffix = serverDecode(params.last());
552   if(!rpl_isupport_suffix.toLower().contains("are supported by this server")) {
553     emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Received non RFC compliant RPL_ISUPPORT: this can lead to unexpected behavior!"), prefix);
554   }
555
556   QString rawSupport;
557   QString key, value;
558   for(int i = 0; i < numParams - 1; i++) {
559     QString rawSupport = serverDecode(params[i]);
560     QString key = rawSupport.section("=", 0, 0);
561     QString value = rawSupport.section("=", 1);
562     network()->addSupport(key, value);
563   }
564 }
565
566 /* RPL_UMODEIS - "<user_modes> [<user_mode_params>]" */
567 void IrcServerHandler::handle221(const QString &prefix, const QList<QByteArray> &params) {
568   Q_UNUSED(prefix)
569   //TODO: save information in network object
570   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("%1").arg(serverDecode(params).join(" ")));
571 }
572
573 /* RPL_STATSCONN - "Highest connection cout: 8000 (7999 clients)" */
574 void IrcServerHandler::handle250(const QString &prefix, const QList<QByteArray> &params) {
575   Q_UNUSED(prefix)
576   //TODO: save information in network object
577   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("%1").arg(serverDecode(params).join(" ")));
578 }
579
580 /* RPL_LOCALUSERS - "Current local user: 5024  Max: 7999 */
581 void IrcServerHandler::handle265(const QString &prefix, const QList<QByteArray> &params) {
582   Q_UNUSED(prefix)
583   //TODO: save information in network object
584   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("%1").arg(serverDecode(params).join(" ")));
585 }
586
587 /* RPL_GLOBALUSERS - "Current global users: 46093  Max: 47650" */
588 void IrcServerHandler::handle266(const QString &prefix, const QList<QByteArray> &params) {
589   Q_UNUSED(prefix)
590   //TODO: save information in network object
591   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("%1").arg(serverDecode(params).join(" ")));
592 }
593
594 /*
595 WHOIS-Message:
596    Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message.
597   and 301 (RPL_AWAY)
598               "<nick> :<away message>"
599 WHO-Message:
600    Replies 352 and 315 paired are used to answer a WHO message.
601
602 WHOWAS-Message:
603    Replies 314 and 369 are responses to a WHOWAS message.
604
605 */
606
607
608 /*   RPL_AWAY - "<nick> :<away message>" */
609 void IrcServerHandler::handle301(const QString &prefix, const QList<QByteArray> &params) {
610   Q_UNUSED(prefix);
611   if(!checkParamCount("IrcServerHandler::handle301()", params, 2))
612     return;
613
614
615   QString nickName = serverDecode(params[0]);
616   QString awayMessage = userDecode(nickName, params[1]);
617
618   IrcUser *ircuser = network()->ircUser(nickName);
619   if(ircuser) {
620     ircuser->setAwayMessage(awayMessage);
621     ircuser->setAway(true);
622   }
623
624   // FIXME: proper redirection needed
625   if(_whois) {
626     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is away: \"%2\"").arg(nickName).arg(awayMessage));
627   } else {
628     if(ircuser) {
629       int now = QDateTime::currentDateTime().toTime_t();
630       int silenceTime = 60;
631       if(ircuser->lastAwayMessage() + silenceTime < now) {
632         emit displayMsg(Message::Server, BufferInfo::QueryBuffer, params[0], tr("%1 is away: \"%2\"").arg(nickName).arg(awayMessage));
633       }
634       ircuser->setLastAwayMessage(now);
635     } else {
636       // probably should not happen
637       emit displayMsg(Message::Server, BufferInfo::QueryBuffer, params[0], tr("%1 is away: \"%2\"").arg(nickName).arg(awayMessage));
638     }
639   }
640 }
641
642 // 305  RPL_UNAWAY
643 //      ":You are no longer marked as being away"
644 void IrcServerHandler::handle305(const QString &prefix, const QList<QByteArray> &params) {
645   Q_UNUSED(prefix);
646   IrcUser *me = network()->me();
647   if(me)
648     me->setAway(false);
649
650   if(!network()->autoAwayActive()) {
651     if(!params.isEmpty())
652       emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", serverDecode(params[0]));
653   } else {
654     network()->setAutoAwayActive(false);
655   }
656 }
657
658 // 306  RPL_NOWAWAY
659 //      ":You have been marked as being away"
660 void IrcServerHandler::handle306(const QString &prefix, const QList<QByteArray> &params) {
661   Q_UNUSED(prefix);
662   IrcUser *me = network()->me();
663   if(me)
664     me->setAway(true);
665
666   if(!params.isEmpty() && !network()->autoAwayActive())
667     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", serverDecode(params[0]));
668 }
669
670 /* RPL_WHOISSERVICE - "<user> is registered nick" */
671 void IrcServerHandler::handle307(const QString &prefix, const QList<QByteArray> &params) {
672   Q_UNUSED(prefix)
673   if(!checkParamCount("IrcServerHandler::handle307()", params, 1))
674     return;
675
676   QString whoisServiceReply = serverDecode(params).join(" ");
677   IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
678   if(ircuser) {
679     ircuser->setWhoisServiceReply(whoisServiceReply);
680   }
681   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(whoisServiceReply));
682 }
683
684 /* RPL_SUSERHOST - "<user> is available for help." */
685 void IrcServerHandler::handle310(const QString &prefix, const QList<QByteArray> &params) {
686   Q_UNUSED(prefix)
687   if(!checkParamCount("IrcServerHandler::handle310()", params, 1))
688     return;
689
690   QString suserHost = serverDecode(params).join(" ");
691   IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
692   if(ircuser) {
693     ircuser->setSuserHost(suserHost);
694   }
695   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(suserHost));
696 }
697
698 /*  RPL_WHOISUSER - "<nick> <user> <host> * :<real name>" */
699 void IrcServerHandler::handle311(const QString &prefix, const QList<QByteArray> &params) {
700   Q_UNUSED(prefix)
701   if(!checkParamCount("IrcServerHandler::handle311()", params, 3))
702     return;
703
704   _whois = true;
705   IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
706   if(ircuser) {
707     ircuser->setUser(serverDecode(params[1]));
708     ircuser->setHost(serverDecode(params[2]));
709     ircuser->setRealName(serverDecode(params.last()));
710     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is %2 (%3)") .arg(ircuser->nick()).arg(ircuser->hostmask()).arg(ircuser->realName()));
711   } else {
712     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is %2 (%3)") .arg(serverDecode(params[1])).arg(serverDecode(params[2])).arg(serverDecode(params.last())));
713   }
714 }
715
716 /*  RPL_WHOISSERVER -  "<nick> <server> :<server info>" */
717 void IrcServerHandler::handle312(const QString &prefix, const QList<QByteArray> &params) {
718   Q_UNUSED(prefix)
719   if(!checkParamCount("IrcServerHandler::handle312()", params, 2))
720     return;
721
722   IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
723   if(ircuser) {
724     ircuser->setServer(serverDecode(params[1]));
725   }
726
727   QString returnString = tr("%1 is online via %2 (%3)").arg(serverDecode(params[0])).arg(serverDecode(params[1])).arg(serverDecode(params.last()));
728   if(_whois) {
729     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(returnString));
730   } else {
731     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whowas] %1").arg(returnString));
732   }
733 }
734
735 /*  RPL_WHOISOPERATOR - "<nick> :is an IRC operator" */
736 void IrcServerHandler::handle313(const QString &prefix, const QList<QByteArray> &params) {
737   Q_UNUSED(prefix)
738   if(!checkParamCount("IrcServerHandler::handle313()", params, 1))
739     return;
740
741   IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
742   if(ircuser) {
743     ircuser->setIrcOperator(params.last());
744   }
745   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
746 }
747
748 /*  RPL_WHOWASUSER - "<nick> <user> <host> * :<real name>" */
749 void IrcServerHandler::handle314(const QString &prefix, const QList<QByteArray> &params) {
750   Q_UNUSED(prefix)
751   if(!checkParamCount("IrcServerHandler::handle314()", params, 3))
752     return;
753
754   QString nick = serverDecode(params[0]);
755   QString hostmask = QString("%1@%2").arg(serverDecode(params[1])).arg(serverDecode(params[2]));
756   QString realName = serverDecode(params.last());
757   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whowas] %1 was %2 (%3)").arg(nick).arg(hostmask).arg(realName));
758 }
759
760 /*  RPL_ENDOFWHO: "<name> :End of WHO list" */
761 void IrcServerHandler::handle315(const QString &prefix, const QList<QByteArray> &params) {
762   Q_UNUSED(prefix);
763   if(!checkParamCount("IrcServerHandler::handle315()", params, 1))
764     return;
765
766   QStringList p = serverDecode(params);
767   if(network()->setAutoWhoDone(p[0])) {
768     return; // stay silent
769   }
770   p.takeLast(); // should be "End of WHO list"
771   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Who] End of /WHO list for %1").arg(p.join(" ")));
772 }
773
774 /*  RPL_WHOISIDLE - "<nick> <integer> :seconds idle"
775    (real life: "<nick> <integer> <integer> :seconds idle, signon time) */
776 void IrcServerHandler::handle317(const QString &prefix, const QList<QByteArray> &params) {
777   Q_UNUSED(prefix);
778   if(!checkParamCount("IrcServerHandler::handle317()", params, 2))
779     return;
780
781   QString nick = serverDecode(params[0]);
782   IrcUser *ircuser = network()->ircUser(nick);
783   if(ircuser) {
784     QDateTime now = QDateTime::currentDateTime();
785     int idleSecs = serverDecode(params[1]).toInt();
786     idleSecs *= -1;
787     ircuser->setIdleTime(now.addSecs(idleSecs));
788     if(params.size() > 3) { // if we have more then 3 params we have the above mentioned "real life" situation
789       int loginTime = serverDecode(params[2]).toInt();
790       ircuser->setLoginTime(QDateTime::fromTime_t(loginTime));
791       emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is logged in since %2").arg(ircuser->nick()).arg(ircuser->loginTime().toString()));
792     }
793     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is idling for %2 (%3)").arg(ircuser->nick()).arg(secondsToString(ircuser->idleTime().secsTo(now))).arg(ircuser->idleTime().toString()));
794
795   } else {
796     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] idle message: %1").arg(userDecode(nick, params).join(" ")));
797   }
798 }
799
800 /*  RPL_ENDOFWHOIS - "<nick> :End of WHOIS list" */
801 void IrcServerHandler::handle318(const QString &prefix, const QList<QByteArray> &params) {
802   Q_UNUSED(prefix)
803   _whois = false;
804   QStringList parameter = serverDecode(params);
805   parameter.removeFirst();
806   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(parameter.join(" ")));
807 }
808
809 /*  RPL_WHOISCHANNELS - "<nick> :*( ( "@" / "+" ) <channel> " " )" */
810 void IrcServerHandler::handle319(const QString &prefix, const QList<QByteArray> &params) {
811   Q_UNUSED(prefix)
812   if(!checkParamCount("IrcServerHandler::handle319()", params, 2))
813     return;
814
815   QString nick = serverDecode(params.first());
816   QStringList op;
817   QStringList voice;
818   QStringList user;
819   foreach (QString channel, serverDecode(params.last()).split(" ")) {
820     if(channel.startsWith("@"))
821        op.append(channel.remove(0,1));
822     else if(channel.startsWith("+"))
823       voice.append(channel.remove(0,1));
824     else
825       user.append(channel);
826   }
827   if(!user.isEmpty())
828     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is a user on channels: %2").arg(nick).arg(user.join(" ")));
829   if(!voice.isEmpty())
830     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 has voice on channels: %2").arg(nick).arg(voice.join(" ")));
831   if(!op.isEmpty())
832     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is an operator on channels: %2").arg(nick).arg(op.join(" ")));
833 }
834
835 /*  RPL_WHOISVIRT - "<nick> is identified to services" */
836 void IrcServerHandler::handle320(const QString &prefix, const QList<QByteArray> &params) {
837   Q_UNUSED(prefix);
838   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
839 }
840
841 /* RPL_LIST -  "<channel> <# visible> :<topic>" */
842 void IrcServerHandler::handle322(const QString &prefix, const QList<QByteArray> &params) {
843   Q_UNUSED(prefix)
844   QString channelName;
845   quint32 userCount = 0;
846   QString topic;
847
848   int paramCount = params.count();
849   switch(paramCount) {
850   case 3:
851     topic = serverDecode(params[2]);
852   case 2:
853     userCount = serverDecode(params[1]).toUInt();
854   case 1:
855     channelName = serverDecode(params[0]);
856   default:
857     break;
858   }
859   if(!coreSession()->ircListHelper()->addChannel(network()->networkId(), channelName, userCount, topic))
860     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Channel %1 has %2 users. Topic is: %3").arg(channelName).arg(userCount).arg(topic));
861 }
862
863 /* RPL_LISTEND ":End of LIST" */
864 void IrcServerHandler::handle323(const QString &prefix, const QList<QByteArray> &params) {
865   Q_UNUSED(prefix)
866   Q_UNUSED(params)
867
868   if(!coreSession()->ircListHelper()->endOfChannelList(network()->networkId()))
869     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("End of channel list"));
870 }
871
872 /* RPL_CHANNELMODEIS - "<channel> <mode> <mode params>" */
873 void IrcServerHandler::handle324(const QString &prefix, const QList<QByteArray> &params) {
874   Q_UNUSED(prefix);
875   handleMode(prefix, params);
876 }
877
878 /* RPL_??? - "<channel> <homepage> */
879 void IrcServerHandler::handle328(const QString &prefix, const QList<QByteArray> &params) {
880   Q_UNUSED(prefix);
881   if(!checkParamCount("IrcServerHandler::handle328()", params, 2))
882     return;
883
884   QString channel = serverDecode(params[0]);
885   QString homepage = serverDecode(params[1]);
886
887   emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel, tr("Homepage for %1 is %2").arg(channel, homepage));
888 }
889
890
891 /* RPL_??? - "<channel> <creation time (unix)>" */
892 void IrcServerHandler::handle329(const QString &prefix, const QList<QByteArray> &params) {
893   Q_UNUSED(prefix);
894   if(!checkParamCount("IrcServerHandler::handle329()", params, 2))
895     return;
896
897   QString channel = serverDecode(params[0]);
898   uint unixtime = params[1].toUInt();
899   if(!unixtime) {
900     qWarning() << Q_FUNC_INFO << "received invalid timestamp:" << params[1];
901     return;
902   }
903   QDateTime time = QDateTime::fromTime_t(unixtime);
904
905   emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel, tr("Channel %1 created on %2").arg(channel, time.toString()));
906 }
907
908 /* RPL_NOTOPIC */
909 void IrcServerHandler::handle331(const QString &prefix, const QList<QByteArray> &params) {
910   Q_UNUSED(prefix);
911   if(!checkParamCount("IrcServerHandler::handle331()", params, 1))
912     return;
913
914   QString channel = serverDecode(params[0]);
915   IrcChannel *chan = network()->ircChannel(channel);
916   if(chan)
917     chan->setTopic(QString());
918
919   emit displayMsg(Message::Topic, BufferInfo::ChannelBuffer, channel, tr("No topic is set for %1.").arg(channel));
920 }
921
922 /* RPL_TOPIC */
923 void IrcServerHandler::handle332(const QString &prefix, const QList<QByteArray> &params) {
924   Q_UNUSED(prefix);
925   if(!checkParamCount("IrcServerHandler::handle332()", params, 2))
926     return;
927
928   QString channel = serverDecode(params[0]);
929   QString topic = channelDecode(channel, params[1]);
930   IrcChannel *chan = network()->ircChannel(channel);
931   if(chan)
932     chan->setTopic(topic);
933
934   emit displayMsg(Message::Topic, BufferInfo::ChannelBuffer, channel, tr("Topic for %1 is \"%2\"").arg(channel, topic));
935 }
936
937 /* Topic set by... */
938 void IrcServerHandler::handle333(const QString &prefix, const QList<QByteArray> &params) {
939   Q_UNUSED(prefix);
940   if(!checkParamCount("IrcServerHandler::handle333()", params, 3))
941     return;
942
943   QString channel = serverDecode(params[0]);
944   emit displayMsg(Message::Topic, BufferInfo::ChannelBuffer, channel,
945                   tr("Topic set by %1 on %2") .arg(serverDecode(params[1]), QDateTime::fromTime_t(channelDecode(channel, params[2]).toUInt()).toString()));
946 }
947
948 /*  RPL_WHOREPLY: "<channel> <user> <host> <server> <nick>
949               ( "H" / "G" > ["*"] [ ( "@" / "+" ) ] :<hopcount> <real name>" */
950 void IrcServerHandler::handle352(const QString &prefix, const QList<QByteArray> &params) {
951   Q_UNUSED(prefix)
952   if(!checkParamCount("IrcServerHandler::handle352()", params, 6))
953     return;
954
955   QString channel = serverDecode(params[0]);
956   IrcUser *ircuser = network()->ircUser(serverDecode(params[4]));
957   if(ircuser) {
958     ircuser->setUser(serverDecode(params[1]));
959     ircuser->setHost(serverDecode(params[2]));
960
961     bool away = serverDecode(params[5]).startsWith("G") ? true : false;
962     ircuser->setAway(away);
963     ircuser->setServer(serverDecode(params[3]));
964     ircuser->setRealName(serverDecode(params.last()).section(" ", 1));
965   }
966
967   if(!network()->isAutoWhoInProgress(channel)) {
968     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Who] %1").arg(serverDecode(params).join(" ")));
969   }
970 }
971
972 /* RPL_NAMREPLY */
973 void IrcServerHandler::handle353(const QString &prefix, const QList<QByteArray> &params) {
974   Q_UNUSED(prefix);
975   if(!checkParamCount("IrcServerHandler::handle353()", params, 3))
976     return;
977
978   // param[0] is either "=", "*" or "@" indicating a public, private or secret channel
979   // we don't use this information at the time beeing
980   QString channelname = serverDecode(params[1]);
981
982   IrcChannel *channel = network()->ircChannel(channelname);
983   if(!channel) {
984     qWarning() << "IrcServerHandler::handle353(): received unknown target channel:" << channelname;
985     return;
986   }
987
988   QStringList nicks;
989   QStringList modes;
990
991   foreach(QString nick, serverDecode(params[2]).split(' ')) {
992     QString mode = QString();
993
994     if(network()->prefixes().contains(nick[0])) {
995       mode = network()->prefixToMode(nick[0]);
996       nick = nick.mid(1);
997     }
998
999     nicks << nick;
1000     modes << mode;
1001   }
1002
1003   channel->joinIrcUsers(nicks, modes);
1004 }
1005
1006 /*  RPL_ENDOFWHOWAS - "<nick> :End of WHOWAS" */
1007 void IrcServerHandler::handle369(const QString &prefix, const QList<QByteArray> &params) {
1008   Q_UNUSED(prefix)
1009   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whowas] %1").arg(serverDecode(params).join(" ")));
1010 }
1011
1012 /* ERR_ERRONEUSNICKNAME */
1013 void IrcServerHandler::handle432(const QString &prefix, const QList<QByteArray> &params) {
1014   Q_UNUSED(prefix);
1015
1016   QString errnick;
1017   if(params.size() < 2) {
1018     // handle unreal-ircd bug, where unreal ircd doesnt supply a TARGET in ERR_ERRONEUSNICKNAME during registration phase:
1019     // nick @@@
1020     // :irc.scortum.moep.net 432  @@@ :Erroneous Nickname: Illegal characters
1021     // correct server reply:
1022     // :irc.scortum.moep.net 432 * @@@ :Erroneous Nickname: Illegal characters
1023     errnick = target();
1024   } else {
1025     errnick = params[0];
1026   }
1027   emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Nick %1 contains illegal characters").arg(errnick));
1028   tryNextNick(errnick, true /* erroneus */);
1029 }
1030
1031 /* ERR_NICKNAMEINUSE */
1032 void IrcServerHandler::handle433(const QString &prefix, const QList<QByteArray> &params) {
1033   Q_UNUSED(prefix);
1034   if(!checkParamCount("IrcServerHandler::handle433()", params, 1))
1035     return;
1036
1037   QString errnick = serverDecode(params[0]);
1038   emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Nick already in use: %1").arg(errnick));
1039
1040   // if there is a problem while connecting to the server -> we handle it
1041   // but only if our connection has not been finished yet...
1042   if(!network()->currentServer().isEmpty())
1043     return;
1044
1045   tryNextNick(errnick);
1046 }
1047
1048 /* Handle signals from Netsplit objects  */
1049
1050 void IrcServerHandler::handleNetsplitJoin(const QString &channel, const QStringList &users, const QString& quitMessage)
1051 {
1052   QString msg = users.join(":").append(':').append(quitMessage);
1053   emit displayMsg(Message::NetsplitJoin, BufferInfo::ChannelBuffer, channel, msg);
1054
1055   foreach(QString user, users) {
1056     IrcUser *iu = network()->ircUser(nickFromMask(user));
1057     if(iu)
1058       iu->joinChannel(channel);
1059   }
1060 }
1061
1062 void IrcServerHandler::handleNetsplitQuit(const QString &channel, const QStringList &users, const QString& quitMessage)
1063 {
1064   QString msg = users.join(":").append(':').append(quitMessage);
1065   emit displayMsg(Message::NetsplitQuit, BufferInfo::ChannelBuffer, channel, msg);
1066   foreach(QString user, users) {
1067     IrcUser *iu = network()->ircUser(nickFromMask(user));
1068     if(iu)
1069       iu->quit();
1070   }
1071 }
1072
1073 void IrcServerHandler::handleNetsplitFinished()
1074 {
1075   Netsplit* n = qobject_cast<Netsplit*>(sender());
1076   _netsplits.remove(_netsplits.key(n));
1077   n->deleteLater();
1078 }
1079
1080 /* */
1081
1082 // FIXME networkConnection()->setChannelKey("") for all ERR replies indicating that a JOIN went wrong
1083 //       mostly, these are codes in the 47x range
1084
1085 /* */
1086
1087 void IrcServerHandler::tryNextNick(const QString &errnick, bool erroneus) {
1088   QStringList desiredNicks = coreSession()->identity(network()->identity())->nicks();
1089   int nextNickIdx = desiredNicks.indexOf(errnick) + 1;
1090   QString nextNick;
1091   if(nextNickIdx > 0 && desiredNicks.size() > nextNickIdx) {
1092     nextNick = desiredNicks[nextNickIdx];
1093   } else {
1094     if(erroneus) {
1095       emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("No free and valid nicks in nicklist found. use: /nick <othernick> to continue"));
1096       return;
1097     } else {
1098       nextNick = errnick + "_";
1099     }
1100   }
1101   putCmd("NICK", serverEncode(nextNick));
1102 }
1103
1104 bool IrcServerHandler::checkParamCount(const QString &methodName, const QList<QByteArray> &params, int minParams) {
1105   if(params.count() < minParams) {
1106     qWarning() << qPrintable(methodName) << "requires" << minParams << "parameters but received only" << params.count() << serverDecode(params);
1107     return false;
1108   } else {
1109     return true;
1110   }
1111 }
1112
1113
1114 /***********************************************************************************/
1115
1116