1 /***************************************************************************
2 * Copyright (C) 2005-08 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 ***************************************************************************/
20 #include "ircserverhandler.h"
24 #include "coresession.h"
25 #include "networkconnection.h"
28 #include "ctcphandler.h"
31 #include "ircchannel.h"
35 IrcServerHandler::IrcServerHandler(NetworkConnection *parent)
36 : BasicHandler(parent),
41 IrcServerHandler::~IrcServerHandler() {
45 /*! Handle a raw message string sent by the server. We try to find a suitable handler, otherwise we call a default handler. */
46 void IrcServerHandler::handleServerMsg(QByteArray msg) {
49 qWarning() << "Received empty string from server!";
53 // Now we split the raw message into its various parts...
58 // First, check for a trailing parameter introduced by " :", since this might screw up splitting the msg
59 // NOTE: This assumes that this is true in raw encoding, but well, hopefully there are no servers running in japanese on protocol level...
60 int idx = msg.indexOf(" :");
62 if(msg.length() > idx + 2) trailing = msg.mid(idx + 2);
65 // OK, now it is safe to split...
66 QList<QByteArray> params = msg.split(' ');
67 if(!trailing.isEmpty()) params << trailing;
68 if(params.count() < 1) {
69 qWarning() << "Received invalid string from server!";
73 QString foo = serverDecode(params.takeFirst());
75 // a colon as the first chars indicates the existence of a prefix
79 if(params.count() < 1) {
80 qWarning() << "Received invalid string from server!";
83 foo = serverDecode(params.takeFirst());
86 // next string without a whitespace is the command
87 cmd = foo.trimmed().toUpper();
89 // numeric replies have the target as first param (RFC 2812 - 2.4). this is usually our own nick. Remove this!
90 uint num = cmd.toUInt();
92 if(params.count() == 0) {
93 qWarning() << "Message received from server violates RFC and is ignored!";
99 // Now we try to find a handler for this message. BTW, I do love the Trolltech guys ;-)
100 handle(cmd, Q_ARG(QString, prefix), Q_ARG(QList<QByteArray>, params));
101 //handle(cmd, Q_ARG(QString, prefix));
102 } catch(Exception e) {
103 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", e.msg());
108 void IrcServerHandler::defaultHandler(QString cmd, const QString &prefix, const QList<QByteArray> &rawparams) {
109 // we assume that all this happens in server encoding
111 foreach(QByteArray r, rawparams) params << serverDecode(r);
112 uint num = cmd.toUInt();
114 // A lot of server messages don't really need their own handler because they don't do much.
115 // Catch and handle these here.
117 // Welcome, status, info messages. Just display these.
118 case 2: case 3: case 4: case 5: case 251: case 252: case 253: case 254: case 255: case 372: case 375:
119 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", params.join(" "), prefix);
121 // Server error messages without param, just display them
122 case 409: case 411: case 412: case 422: case 424: case 445: case 446: case 451: case 462:
123 case 463: case 464: case 465: case 466: case 472: case 481: case 483: case 485: case 491: case 501: case 502:
124 case 431: // ERR_NONICKNAMEGIVEN
125 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", params.join(" "), prefix);
127 // Server error messages, display them in red. First param will be appended.
129 QString target = params.takeFirst();
130 displayMsg(Message::Error, target, params.join(" ") + " " + target, prefix, Message::Redirected);
133 case 402: case 403: case 404: case 406: case 408: case 415: case 421: case 442: {
134 QString channelName = params.takeFirst();
135 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", params.join(" ") + " " + channelName, prefix);
138 // Server error messages which will be displayed with a colon between the first param and the rest
139 case 413: case 414: case 423: case 441: case 444: case 461: // FIXME see below for the 47x codes
140 case 467: case 471: case 473: case 474: case 475: case 476: case 477: case 478: case 482:
141 case 436: // ERR_NICKCOLLISION
142 { QString p = params.takeFirst();
143 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", p + ": " + params.join(" "));
146 // Ignore these commands.
150 // Everything else will be marked in red, so we can add them somewhere.
152 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", cmd + " " + params.join(" "), prefix);
154 //qDebug() << prefix <<":"<<cmd<<params;
156 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Unknown: ") + cmd + " " + params.join(" "), prefix);
157 //qDebug() << prefix <<":"<<cmd<<params;
161 //******************************/
162 // IRC SERVER HANDLER
163 //******************************/
164 void IrcServerHandler::handleJoin(const QString &prefix, const QList<QByteArray> ¶ms) {
165 Q_ASSERT(params.count() == 1);
166 QString channel = serverDecode(params[0]);
167 IrcUser *ircuser = network()->updateNickFromMask(prefix);
168 emit displayMsg(Message::Join, BufferInfo::ChannelBuffer, channel, channel, prefix);
169 //qDebug() << "IrcServerHandler::handleJoin()" << prefix << params;
170 ircuser->joinChannel(channel);
171 if(network()->isMe(ircuser)) network()->addPersistentChannel(channel, networkConnection()->channelKey(channel));
174 void IrcServerHandler::handleKick(const QString &prefix, const QList<QByteArray> ¶ms) {
175 network()->updateNickFromMask(prefix);
176 IrcUser *victim = network()->ircUser(params[1]);
177 QString channel = serverDecode(params[0]);
180 victim->partChannel(channel);
183 if(params.count() > 2) // someone got a reason!
184 msg = QString("%1 %2").arg(victim->nick()).arg(channelDecode(channel, params[2]));
186 msg = victim->nick();
188 emit displayMsg(Message::Kick, BufferInfo::ChannelBuffer, channel, msg, prefix);
189 //if(network()->isMe(victim)) networkConnection()->setKickedFromChannel(channel);
192 void IrcServerHandler::handleMode(const QString &prefix, const QList<QByteArray> ¶ms) {
193 if(params.count() < 2) {
194 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Received invalid MODE from %s: %s").arg(prefix).arg(serverDecode(params).join(" ")));
198 if(network()->isChannelName(serverDecode(params[0]))) {
200 emit displayMsg(Message::Mode, BufferInfo::ChannelBuffer, serverDecode(params[0]), serverDecode(params).join(" "), prefix);
202 IrcChannel *channel = network()->ircChannel(params[0]);
203 // FIXME: currently the IrcChannels only support PREFIX-Modes for users
204 // This cannot be fixed unless the SignalProxy() doesn't rely on methodIds anymore
205 QString modes = params[1];
208 for(int c = 0; c < modes.length(); c++) {
209 if(modes[c] == '+') {
213 if(modes[c] == '-') {
218 // this is the part where we restrict the mode changes to PREFIXES:
219 if(network()->prefixModes().contains(modes[c]) && modeIndex < params.count()) {
220 IrcUser *ircUser = network()->ircUser(params[modeIndex]);
222 channel->addUserMode(ircUser, QString(modes[c]));
224 channel->removeUserMode(ircUser, QString(modes[c]));
232 emit displayMsg(Message::Mode, BufferInfo::StatusBuffer, "", serverDecode(params).join(" "), prefix);
236 void IrcServerHandler::handleNick(const QString &prefix, const QList<QByteArray> ¶ms) {
237 IrcUser *ircuser = network()->updateNickFromMask(prefix);
239 QString newnick = serverDecode(params[0]);
240 QString oldnick = ircuser->nick();
242 QString sender = network()->isMyNick(oldnick)
247 emit nickChanged(newnick, oldnick);
248 foreach(QString channel, ircuser->channels())
249 emit displayMsg(Message::Nick, BufferInfo::ChannelBuffer, channel, newnick, sender);
251 ircuser->setNick(newnick);
254 void IrcServerHandler::handleNotice(const QString &prefix, const QList<QByteArray> ¶ms) {
255 if(params.count() < 2) {
256 qWarning() << "IrcServerHandler::handleNotice(): not enough Parameters:" << prefix << serverDecode(params);
260 QString target = serverDecode(params[0]);
261 if(prefix.isEmpty() || target == "AUTH")
263 else if(!network()->isChannelName(target))
264 target = nickFromMask(prefix);
266 networkConnection()->ctcpHandler()->parse(Message::Notice, prefix, target, params[1]);
269 void IrcServerHandler::handlePart(const QString &prefix, const QList<QByteArray> ¶ms) {
270 IrcUser *ircuser = network()->updateNickFromMask(prefix);
271 QString channel = serverDecode(params[0]);
274 ircuser->partChannel(channel);
277 if(params.count() > 1)
278 msg = userDecode(ircuser->nick(), params[1]);
280 emit displayMsg(Message::Part, BufferInfo::ChannelBuffer, channel, msg, prefix);
281 if(network()->isMe(ircuser)) network()->removePersistentChannel(channel);
284 void IrcServerHandler::handlePing(const QString &prefix, const QList<QByteArray> ¶ms) {
286 putCmd("PONG", params);
289 void IrcServerHandler::handlePrivmsg(const QString &prefix, const QList<QByteArray> ¶ms) {
290 IrcUser *ircuser = network()->updateNickFromMask(prefix);
293 if(params.isEmpty()) {
294 qWarning() << "IrcServerHandler::handlePrivmsg(): received PRIVMSG without target or message from:" << prefix;
298 QString target = serverDecode(params[0]);
300 QByteArray msg = params.count() < 2
304 // are we the target?
305 if(network()->isMyNick(target))
306 target = nickFromMask(ircuser->nick());
308 // it's possible to pack multiple privmsgs into one param using ctcp
309 // - > we let the ctcpHandler do the work
310 networkConnection()->ctcpHandler()->parse(Message::Plain, prefix, target, msg);
313 void IrcServerHandler::handleQuit(const QString &prefix, const QList<QByteArray> ¶ms) {
314 IrcUser *ircuser = network()->updateNickFromMask(prefix);
319 msg = userDecode(ircuser->nick(), params[0]);
321 foreach(QString channel, ircuser->channels())
322 emit displayMsg(Message::Quit, BufferInfo::ChannelBuffer, channel, msg, prefix);
324 network()->removeIrcUser(nickFromMask(prefix));
327 void IrcServerHandler::handleTopic(const QString &prefix, const QList<QByteArray> ¶ms) {
328 IrcUser *ircuser = network()->updateNickFromMask(prefix);
330 QString channel = serverDecode(params[0]);
332 if(params.count() >= 2) topic = channelDecode(channel, params[1]);
334 network()->ircChannel(channel)->setTopic(topic);
336 emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel, tr("%1 has changed topic for %2 to: \"%3\"").arg(ircuser->nick()).arg(channel).arg(topic));
340 void IrcServerHandler::handle001(const QString &prefix, const QList<QByteArray> ¶ms) {
341 // there should be only one param: "Welcome to the Internet Relay Network <nick>!<user>@<host>"
342 QString param = serverDecode(params[0]);
343 QString myhostmask = param.section(' ', -1, -1);
344 network()->setCurrentServer(prefix);
345 network()->setMyNick(nickFromMask(myhostmask));
347 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", param, prefix);
351 // TODO Complete 005 handling, also use sensible defaults for non-sent stuff
352 void IrcServerHandler::handle005(const QString &prefix, const QList<QByteArray> ¶ms) {
354 const int numParams = params.size();
356 qWarning() << "IrcServerHandler::handle005(): received RPL_ISUPPORT (005) with too few parameters:" << serverDecode(params);
360 QString rpl_isupport_suffix = serverDecode(params.last());
361 if(!rpl_isupport_suffix.toLower().contains("supported")) {
362 qWarning() << "Received invalid RPL_ISUPPORT! Suffix is:" << rpl_isupport_suffix << "Excpected: are supported by this server";
368 for(int i = 0; i < numParams - 1; i++) {
369 QString rawSupport = serverDecode(params[i]);
370 QString key = rawSupport.section("=", 0, 0);
371 QString value = rawSupport.section("=", 1);
372 network()->addSupport(key, value);
379 Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message.
381 "<nick> :<away message>"
383 Replies 352 and 315 paired are used to answer a WHO message.
386 Replies 314 and 369 are responses to a WHOWAS message.
391 /* RPL_AWAY - "<nick> :<away message>" */
392 void IrcServerHandler::handle301(const QString &prefix, const QList<QByteArray> ¶ms) {
394 QString nickName = serverDecode(params[0]);
395 QString awayMessage = userDecode(nickName, params.last());
397 IrcUser *ircuser = network()->ircUser(nickName);
399 ircuser->setAwayMessage(awayMessage);
400 ircuser->setAway(true);
403 // FIXME: proper redirection needed
405 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is away: \"%2\"").arg(nickName).arg(awayMessage));
408 int now = QDateTime::currentDateTime().toTime_t();
409 int silenceTime = 60;
410 if(ircuser->lastAwayMessage() + silenceTime < now) {
411 emit displayMsg(Message::Server, BufferInfo::QueryBuffer, params[0], tr("%1 is away: \"%2\"").arg(nickName).arg(awayMessage));
413 ircuser->setLastAwayMessage(now);
415 // probably should not happen
416 emit displayMsg(Message::Server, BufferInfo::QueryBuffer, params[0], tr("%1 is away: \"%2\"").arg(nickName).arg(awayMessage));
421 /* RPL_WHOISUSER - "<nick> <user> <host> * :<real name>" */
422 void IrcServerHandler::handle311(const QString &prefix, const QList<QByteArray> ¶ms) {
425 IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
427 ircuser->setUser(serverDecode(params[1]));
428 ircuser->setHost(serverDecode(params[2]));
429 ircuser->setRealName(serverDecode(params.last()));
431 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1") .arg(serverDecode(params).join(" ")));
434 /* RPL_WHOISSERVER - "<nick> <server> :<server info>" */
435 void IrcServerHandler::handle312(const QString &prefix, const QList<QByteArray> ¶ms) {
437 IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
439 ircuser->setServer(serverDecode(params[1]));
442 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
444 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whowas] %1").arg(serverDecode(params).join(" ")));
448 /* RPL_WHOISOPERATOR - "<nick> :is an IRC operator" */
449 void IrcServerHandler::handle313(const QString &prefix, const QList<QByteArray> ¶ms) {
451 IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
453 ircuser->setIrcOperator(params.last());
455 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
458 /* RPL_WHOWASUSER - "<nick> <user> <host> * :<real name>" */
459 void IrcServerHandler::handle314(const QString &prefix, const QList<QByteArray> ¶ms) {
461 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whowas] %1").arg(serverDecode(params).join(" ")));
464 /* RPL_ENDOFWHO: "<name> :End of WHO list" */
465 void IrcServerHandler::handle315(const QString &prefix, const QList<QByteArray> ¶ms) {
467 // FIXME temporarily made silent
469 // emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Who] %1").arg(serverDecode(params).join(" ")));
472 /* RPL_WHOISIDLE - "<nick> <integer> :seconds idle"
473 (real life: "<nick> <integer> <integer> :seconds idle, signon time) */
474 //TODO: parse real life message
475 void IrcServerHandler::handle317(const QString &prefix, const QList<QByteArray> ¶ms) {
477 QString nick = serverDecode(params[0]);
478 IrcUser *ircuser = network()->ircUser(nick);
480 QDateTime now = QDateTime::currentDateTime();
481 int idleSecs = serverDecode(params[1]).toInt();
483 ircuser->setIdleTime(now.addSecs(idleSecs));
484 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is idling for %2 seconds").arg(ircuser->nick()).arg(ircuser->idleTime().secsTo(now)));
486 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] idle message: %1").arg(userDecode(nick, params).join(" ")));
490 /* RPL_ENDOFWHOIS - "<nick> :End of WHOIS list" */
491 void IrcServerHandler::handle318(const QString &prefix, const QList<QByteArray> ¶ms) {
494 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
497 /* RPL_WHOISCHANNELS - "<nick> :*( ( "@" / "+" ) <channel> " " )" */
498 void IrcServerHandler::handle319(const QString &prefix, const QList<QByteArray> ¶ms) {
500 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
504 void IrcServerHandler::handle331(const QString &prefix, const QList<QByteArray> ¶ms) {
506 QString channel = serverDecode(params[0]);
507 network()->ircChannel(channel)->setTopic(QString());
508 emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel, tr("No topic is set for %1.").arg(channel));
512 void IrcServerHandler::handle332(const QString &prefix, const QList<QByteArray> ¶ms) {
514 QString channel = serverDecode(params[0]);
515 QString topic = channelDecode(channel, params[1]);
516 network()->ircChannel(channel)->setTopic(topic);
517 emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel, tr("Topic for %1 is \"%2\"").arg(channel, topic));
520 /* Topic set by... */
521 void IrcServerHandler::handle333(const QString &prefix, const QList<QByteArray> ¶ms) {
523 QString channel = serverDecode(params[0]);
524 emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel,
525 tr("Topic set by %1 on %2") .arg(serverDecode(params[1]), QDateTime::fromTime_t(channelDecode(channel, params[2]).toUInt()).toString()));
528 /* RPL_WHOREPLY: "<channel> <user> <host> <server> <nick>
529 ( "H" / "G" > ["*"] [ ( "@" / "+" ) ] :<hopcount> <real name>" */
530 void IrcServerHandler::handle352(const QString &prefix, const QList<QByteArray> ¶ms) {
532 QString channel = serverDecode(params[0]);
533 IrcUser *ircuser = network()->ircUser(serverDecode(params[4]));
535 ircuser->setUser(serverDecode(params[1]));
536 ircuser->setHost(serverDecode(params[2]));
538 bool away = serverDecode(params[5]).startsWith("G") ? true : false;
539 ircuser->setAway(away);
540 ircuser->setServer(serverDecode(params[3]));
541 ircuser->setRealName(serverDecode(params.last()).section(" ", 1));
544 // FIXME temporarily made silent
545 //emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Who] %1").arg(serverDecode(params).join(" ")));
549 void IrcServerHandler::handle353(const QString &prefix, const QList<QByteArray> ¶ms) {
551 const int numParams = params.count();
553 qWarning() << "IrcServerHandler::handler353() received not enough params:" << serverDecode(params);
557 // param[0] is either "=", "*" or "@" indicating a public, private or secret channel
558 // we don't use this information at the time beeing
559 QString channelname = serverDecode(params[1]);
561 foreach(QString nick, serverDecode(params[2]).split(' ')) {
562 QString mode = QString();
564 if(network()->prefixes().contains(nick[0])) {
565 mode = network()->prefixToMode(nick[0]);
569 IrcUser *ircuser = network()->newIrcUser(nick);
570 ircuser->joinChannel(channelname);
573 network()->ircChannel(channelname)->addUserMode(ircuser, mode);
577 /* RPL_ENDOFWHOWAS - "<nick> :End of WHOWAS" */
578 void IrcServerHandler::handle369(const QString &prefix, const QList<QByteArray> ¶ms) {
580 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whowas] %1").arg(serverDecode(params).join(" ")));
583 /* ERR_ERRONEUSNICKNAME */
584 void IrcServerHandler::handle432(const QString &prefix, const QList<QByteArray> ¶ms) {
587 if(params.size() < 2) {
588 // handle unreal-ircd bug, where unreal ircd doesnt supply a TARGET in ERR_ERRONEUSNICKNAME during registration phase:
590 // :irc.scortum.moep.net 432 @@@ :Erroneous Nickname: Illegal characters
591 // correct server reply:
592 // :irc.scortum.moep.net 432 * @@@ :Erroneous Nickname: Illegal characters
593 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("There is a nickname in your identity's nicklist which contains illegal characters"));
594 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Due to a bug in Unreal IRCd (and maybe other irc-servers too) we're unable to determine the erroneous nick"));
595 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Please use: /nick <othernick> to continue or clean up your nicklist"));
597 QString errnick = params[0];
598 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Nick %1 contains illegal characters").arg(errnick));
599 tryNextNick(errnick);
603 /* ERR_NICKNAMEINUSE */
604 void IrcServerHandler::handle433(const QString &prefix, const QList<QByteArray> ¶ms) {
607 QString errnick = serverDecode(params[0]);
608 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Nick already in use: %1").arg(errnick));
610 // if there is a problem while connecting to the server -> we handle it
611 // but only if our connection has not been finished yet...
612 if(!network()->currentServer().isEmpty())
615 tryNextNick(errnick);
620 // FIXME networkConnection()->setChannelKey("") for all ERR replies indicating that a JOIN went wrong
621 // mostly, these are codes in the 47x range
625 void IrcServerHandler::tryNextNick(const QString &errnick) {
626 QStringList desiredNicks = networkConnection()->coreSession()->identity(network()->identity())->nicks();
627 int nextNick = desiredNicks.indexOf(errnick) + 1;
628 if(desiredNicks.size() > nextNick) {
629 putCmd("NICK", serverEncode(desiredNicks[nextNick]));
631 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("No free and valid nicks in nicklist found. use: /nick <othernick> to continue"));
636 /***********************************************************************************/