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) : BasicHandler(parent) {
39 IrcServerHandler::~IrcServerHandler() {
43 /*! Handle a raw message string sent by the server. We try to find a suitable handler, otherwise we call a default handler. */
44 void IrcServerHandler::handleServerMsg(QByteArray msg) {
47 qWarning() << "Received empty string from server!";
51 // Now we split the raw message into its various parts...
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(" :");
60 if(msg.length() > idx + 2) trailing = msg.mid(idx + 2);
63 // OK, now it is safe to split...
64 QList<QByteArray> params = msg.split(' ');
65 if(!trailing.isEmpty()) params << trailing;
66 if(params.count() < 1) {
67 qWarning() << "Received invalid string from server!";
71 QString foo = serverDecode(params.takeFirst());
73 // a colon as the first chars indicates the existence of a prefix
77 if(params.count() < 1) {
78 qWarning() << "Received invalid string from server!";
81 foo = serverDecode(params.takeFirst());
84 // next string without a whitespace is the command
85 cmd = foo.trimmed().toUpper();
87 // numeric replies have the target as first param (RFC 2812 - 2.4). this is usually our own nick. Remove this!
88 uint num = cmd.toUInt();
90 if(params.count() == 0) {
91 qWarning() << "Message received from server violates RFC and is ignored!";
97 // Now we try to find a handler for this message. BTW, I do love the Trolltech guys ;-)
98 handle(cmd, Q_ARG(QString, prefix), Q_ARG(QList<QByteArray>, params));
99 //handle(cmd, Q_ARG(QString, prefix));
100 } catch(Exception e) {
101 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", e.msg());
106 void IrcServerHandler::defaultHandler(QString cmd, const QString &prefix, const QList<QByteArray> &rawparams) {
107 // we assume that all this happens in server encoding
109 foreach(QByteArray r, rawparams) params << serverDecode(r);
110 uint num = cmd.toUInt();
112 // A lot of server messages don't really need their own handler because they don't do much.
113 // Catch and handle these here.
115 // Welcome, status, info messages. Just display these.
116 case 2: case 3: case 4: case 5: case 251: case 252: case 253: case 254: case 255: case 372: case 375:
117 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", params.join(" "), prefix);
119 // Server error messages without param, just display them
120 case 409: case 411: case 412: case 422: case 424: case 445: case 446: case 451: case 462:
121 case 463: case 464: case 465: case 466: case 472: case 481: case 483: case 485: case 491: case 501: case 502:
122 case 431: // ERR_NONICKNAMEGIVEN
123 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", params.join(" "), prefix);
125 // Server error messages, display them in red. First param will be appended.
128 // FIXME needs proper redirection
129 QString target = params.takeFirst();
130 BufferInfo::Type bufferType = network()->isChannelName(target)
131 ? BufferInfo::ChannelBuffer
132 : BufferInfo::QueryBuffer;
133 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", params.join(" ") + " " + target, prefix);
134 emit displayMsg(Message::Error, bufferType, target, params.join(" ") + " " + target, prefix);
137 case 402: case 403: case 404: case 406: case 408: case 415: case 421: case 442:
138 { QString channelName = params.takeFirst();
139 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", params.join(" ") + " " + channelName, prefix);
142 // Server error messages which will be displayed with a colon between the first param and the rest
143 case 413: case 414: case 423: case 441: case 444: case 461:
144 case 467: case 471: case 473: case 474: case 475: case 476: case 477: case 478: case 482:
145 case 436: // ERR_NICKCOLLISION
146 { QString p = params.takeFirst();
147 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", p + ": " + params.join(" "));
150 // Ignore these commands.
154 // Everything else will be marked in red, so we can add them somewhere.
156 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", cmd + " " + params.join(" "), prefix);
158 //qDebug() << prefix <<":"<<cmd<<params;
160 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Unknown: ") + cmd + " " + params.join(" "), prefix);
161 //qDebug() << prefix <<":"<<cmd<<params;
165 //******************************/
166 // IRC SERVER HANDLER
167 //******************************/
168 void IrcServerHandler::handleJoin(const QString &prefix, const QList<QByteArray> ¶ms) {
169 Q_ASSERT(params.count() == 1);
170 QString channel = serverDecode(params[0]);
171 IrcUser *ircuser = network()->updateNickFromMask(prefix);
172 emit displayMsg(Message::Join, BufferInfo::ChannelBuffer, channel, channel, prefix);
173 //qDebug() << "IrcServerHandler::handleJoin()" << prefix << params;
174 ircuser->joinChannel(channel);
177 void IrcServerHandler::handleKick(const QString &prefix, const QList<QByteArray> ¶ms) {
178 network()->updateNickFromMask(prefix);
179 IrcUser *victim = network()->ircUser(params[1]);
180 QString channel = serverDecode(params[0]);
183 victim->partChannel(channel);
186 if(params.count() > 2) // someone got a reason!
187 msg = QString("%1 %2").arg(victim->nick()).arg(channelDecode(channel, params[2]));
189 msg = victim->nick();
191 emit displayMsg(Message::Kick, BufferInfo::ChannelBuffer, channel, msg, prefix);
194 void IrcServerHandler::handleMode(const QString &prefix, const QList<QByteArray> ¶ms) {
195 if(params.count() < 2) {
196 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Received invalid MODE from %s: %s").arg(prefix).arg(serverDecode(params).join(" ")));
200 if(network()->isChannelName(serverDecode(params[0]))) {
202 emit displayMsg(Message::Mode, BufferInfo::ChannelBuffer, serverDecode(params[0]), serverDecode(params).join(" "), prefix);
204 IrcChannel *channel = network()->ircChannel(params[0]);
205 // FIXME: currently the IrcChannels only support PREFIX-Modes for users
206 // This cannot be fixed unless the SignalProxy() doesn't rely on methodIds anymore
207 QString modes = params[1];
210 for(int c = 0; c < modes.length(); c++) {
211 if(modes[c] == '+') {
215 if(modes[c] == '-') {
220 // this is the part where we restrict the mode changes to PREFIXES:
221 if(network()->prefixModes().contains(modes[c]) && modeIndex < params.count()) {
222 IrcUser *ircUser = network()->ircUser(params[modeIndex]);
224 channel->addUserMode(ircUser, QString(modes[c]));
226 channel->removeUserMode(ircUser, QString(modes[c]));
234 emit displayMsg(Message::Mode, BufferInfo::StatusBuffer, "", serverDecode(params).join(" "), prefix);
238 void IrcServerHandler::handleNick(const QString &prefix, const QList<QByteArray> ¶ms) {
239 IrcUser *ircuser = network()->updateNickFromMask(prefix);
241 QString newnick = serverDecode(params[0]);
242 QString oldnick = ircuser->nick();
244 QString sender = network()->isMyNick(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 // check if it's only a Server Message or if it's a regular Notice
261 if(network()->currentServer().isEmpty() || network()->currentServer() == prefix) {
262 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", serverDecode(params[1]), prefix);
266 QString target = serverDecode(params[0]);
268 // kick notices to the server buffer if they are directly addressed to us
269 if(network()->isMyNick(target))
270 target = QString("");
272 QString sender = prefix.contains('!')
273 ? nickFromMask(prefix)
276 networkConnection()->ctcpHandler()->parse(Message::Notice, sender, target, userDecode(sender, params[1]));
279 void IrcServerHandler::handlePart(const QString &prefix, const QList<QByteArray> ¶ms) {
280 IrcUser *ircuser = network()->updateNickFromMask(prefix);
281 QString channel = serverDecode(params[0]);
284 ircuser->partChannel(channel);
287 if(params.count() > 1)
288 msg = userDecode(ircuser->nick(), params[1]);
290 emit displayMsg(Message::Part, BufferInfo::ChannelBuffer, channel, msg, prefix);
293 void IrcServerHandler::handlePing(const QString &prefix, const QList<QByteArray> ¶ms) {
295 putCmd("PONG", params);
298 void IrcServerHandler::handlePrivmsg(const QString &prefix, const QList<QByteArray> ¶ms) {
299 IrcUser *ircuser = network()->updateNickFromMask(prefix);
302 if(params.isEmpty()) {
303 qWarning() << "IrcServerHandler::handlePrivmsg(): received PRIVMSG without target or message from:" << prefix;
307 QString target = serverDecode(params[0]);
309 QByteArray msg = params.count() < 2
313 // are we the target?
314 if(network()->isMyNick(target))
315 target = nickFromMask(ircuser->nick());
317 // it's possible to pack multiple privmsgs into one param using ctcp
318 // - > we let the ctcpHandler do the work
319 networkConnection()->ctcpHandler()->parse(Message::Plain, prefix, target, userDecode(ircuser->nick(), msg));
322 void IrcServerHandler::handleQuit(const QString &prefix, const QList<QByteArray> ¶ms) {
323 IrcUser *ircuser = network()->updateNickFromMask(prefix);
328 msg = userDecode(ircuser->nick(), params[0]);
330 foreach(QString channel, ircuser->channels())
331 emit displayMsg(Message::Quit, BufferInfo::ChannelBuffer, channel, msg, prefix);
333 network()->removeIrcUser(nickFromMask(prefix));
336 void IrcServerHandler::handleTopic(const QString &prefix, const QList<QByteArray> ¶ms) {
337 IrcUser *ircuser = network()->updateNickFromMask(prefix);
338 QString channel = serverDecode(params[0]);
339 QString topic = channelDecode(channel, params[1]);
342 network()->ircChannel(channel)->setTopic(topic);
344 emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel, tr("%1 has changed topic for %2 to: \"%3\"").arg(ircuser->nick()).arg(channel).arg(topic));
348 void IrcServerHandler::handle001(const QString &prefix, const QList<QByteArray> ¶ms) {
349 // there should be only one param: "Welcome to the Internet Relay Network <nick>!<user>@<host>"
350 QString param = serverDecode(params[0]);
351 QString myhostmask = param.section(' ', -1, -1);
352 network()->setCurrentServer(prefix);
353 network()->setMyNick(nickFromMask(myhostmask));
355 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", param, prefix);
359 // TODO Complete 005 handling, also use sensible defaults for non-sent stuff
360 void IrcServerHandler::handle005(const QString &prefix, const QList<QByteArray> ¶ms) {
362 const int numParams = params.size();
364 qWarning() << "IrcServerHandler::handle005(): received RPL_ISUPPORT (005) with too few parameters:" << serverDecode(params);
368 QString rpl_isupport_suffix = serverDecode(params.last());
369 if(!rpl_isupport_suffix.toLower().contains("supported")) {
370 qWarning() << "Received invalid RPL_ISUPPORT! Suffix is:" << rpl_isupport_suffix << "Excpected: are supported by this server";
376 for(int i = 0; i < numParams - 1; i++) {
377 QString rawSupport = serverDecode(params[i]);
378 QString key = rawSupport.section("=", 0, 0);
379 QString value = rawSupport.section("=", 1);
380 network()->addSupport(key, value);
387 Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message.
389 "<nick> :<away message>"
391 Replies 352 and 315 paired are used to answer a WHO message.
394 Replies 314 and 369 are responses to a WHOWAS message.
399 /* RPL_AWAY - "<nick> :<away message>" */
400 void IrcServerHandler::handle301(const QString &prefix, const QList<QByteArray> ¶ms) {
402 QString nickName = serverDecode(params[0]);
403 QString awayMessage = userDecode(nickName, params.last());
405 IrcUser *ircuser = network()->ircUser(nickName);
407 ircuser->setAwayMessage(awayMessage);
408 ircuser->setAway(true);
411 // FIXME: proper redirection needed
413 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is away: \"%2\"").arg(nickName).arg(awayMessage));
416 int now = QDateTime::currentDateTime().toTime_t();
417 int silenceTime = 60;
418 if(ircuser->lastAwayMessage() + silenceTime < now) {
419 emit displayMsg(Message::Server, BufferInfo::QueryBuffer, params[0], tr("%1 is away: \"%2\"").arg(nickName).arg(awayMessage));
421 ircuser->setLastAwayMessage(now);
423 // probably should not happen
424 emit displayMsg(Message::Server, BufferInfo::QueryBuffer, params[0], tr("%1 is away: \"%2\"").arg(nickName).arg(awayMessage));
429 /* RPL_WHOISUSER - "<nick> <user> <host> * :<real name>" */
430 void IrcServerHandler::handle311(const QString &prefix, const QList<QByteArray> ¶ms) {
433 IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
435 ircuser->setUser(serverDecode(params[1]));
436 ircuser->setHost(serverDecode(params[2]));
437 ircuser->setRealName(serverDecode(params.last()));
439 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1") .arg(serverDecode(params).join(" ")));
442 /* RPL_WHOISSERVER - "<nick> <server> :<server info>" */
443 void IrcServerHandler::handle312(const QString &prefix, const QList<QByteArray> ¶ms) {
445 IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
447 ircuser->setServer(serverDecode(params[1]));
450 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
452 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whowas] %1").arg(serverDecode(params).join(" ")));
456 /* RPL_WHOISOPERATOR - "<nick> :is an IRC operator" */
457 void IrcServerHandler::handle313(const QString &prefix, const QList<QByteArray> ¶ms) {
459 IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
461 ircuser->setIrcOperator(params.last());
463 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
466 /* RPL_WHOWASUSER - "<nick> <user> <host> * :<real name>" */
467 void IrcServerHandler::handle314(const QString &prefix, const QList<QByteArray> ¶ms) {
469 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whowas] %1").arg(serverDecode(params).join(" ")));
472 /* RPL_ENDOFWHO: "<name> :End of WHO list" */
473 void IrcServerHandler::handle315(const QString &prefix, const QList<QByteArray> ¶ms) {
475 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Who] %1").arg(serverDecode(params).join(" ")));
478 /* RPL_WHOISIDLE - "<nick> <integer> :seconds idle"
479 (real life: "<nick> <integer> <integer> :seconds idle, signon time) */
480 //TODO: parse real life message
481 void IrcServerHandler::handle317(const QString &prefix, const QList<QByteArray> ¶ms) {
483 QString nick = serverDecode(params[0]);
484 IrcUser *ircuser = network()->ircUser(nick);
486 QDateTime now = QDateTime::currentDateTime();
487 int idleSecs = serverDecode(params[1]).toInt();
489 ircuser->setIdleTime(now.addSecs(idleSecs));
490 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is idling for %2 seconds").arg(ircuser->nick()).arg(ircuser->idleTime().secsTo(now)));
492 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] idle message: %1").arg(userDecode(nick, params).join(" ")));
496 /* RPL_ENDOFWHOIS - "<nick> :End of WHOIS list" */
497 void IrcServerHandler::handle318(const QString &prefix, const QList<QByteArray> ¶ms) {
500 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
503 /* RPL_WHOISCHANNELS - "<nick> :*( ( "@" / "+" ) <channel> " " )" */
504 void IrcServerHandler::handle319(const QString &prefix, const QList<QByteArray> ¶ms) {
506 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
510 void IrcServerHandler::handle331(const QString &prefix, const QList<QByteArray> ¶ms) {
512 QString channel = serverDecode(params[0]);
513 network()->ircChannel(channel)->setTopic(QString());
514 emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel, tr("No topic is set for %1.").arg(channel));
518 void IrcServerHandler::handle332(const QString &prefix, const QList<QByteArray> ¶ms) {
520 QString channel = serverDecode(params[0]);
521 QString topic = channelDecode(channel, params[1]);
522 network()->ircChannel(channel)->setTopic(topic);
523 emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel, tr("Topic for %1 is \"%2\"").arg(channel, topic));
526 /* Topic set by... */
527 void IrcServerHandler::handle333(const QString &prefix, const QList<QByteArray> ¶ms) {
529 QString channel = serverDecode(params[0]);
530 emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel,
531 tr("Topic set by %1 on %2") .arg(serverDecode(params[1]), QDateTime::fromTime_t(channelDecode(channel, params[2]).toUInt()).toString()));
534 /* RPL_WHOREPLY: "<channel> <user> <host> <server> <nick>
535 ( "H" / "G" > ["*"] [ ( "@" / "+" ) ] :<hopcount> <real name>" */
536 void IrcServerHandler::handle352(const QString &prefix, const QList<QByteArray> ¶ms) {
538 QString channel = serverDecode(params[0]);
539 IrcUser *ircuser = network()->ircUser(serverDecode(params[4]));
541 ircuser->setUser(serverDecode(params[1]));
542 ircuser->setHost(serverDecode(params[2]));
544 bool away = serverDecode(params[5]).startsWith("G") ? true : false;
545 ircuser->setAway(away);
546 ircuser->setServer(serverDecode(params[3]));
547 ircuser->setRealName(serverDecode(params.last()).section(" ", 1));
550 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Who] %1").arg(serverDecode(params).join(" ")));
554 void IrcServerHandler::handle353(const QString &prefix, const QList<QByteArray> ¶ms) {
556 const int numParams = params.count();
558 qWarning() << "IrcServerHandler::handler353() received not enough params:" << serverDecode(params);
562 // param[0] is either "=", "*" or "@" indicating a public, private or secret channel
563 // we don't use this information at the time beeing
564 QString channelname = serverDecode(params[1]);
566 foreach(QString nick, serverDecode(params[2]).split(' ')) {
567 QString mode = QString();
569 if(network()->prefixes().contains(nick[0])) {
570 mode = network()->prefixToMode(nick[0]);
574 IrcUser *ircuser = network()->newIrcUser(nick);
575 ircuser->joinChannel(channelname);
578 network()->ircChannel(channelname)->addUserMode(ircuser, mode);
582 /* RPL_ENDOFWHOWAS - "<nick> :End of WHOWAS" */
583 void IrcServerHandler::handle369(const QString &prefix, const QList<QByteArray> ¶ms) {
585 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whowas] %1").arg(serverDecode(params).join(" ")));
588 /* ERR_ERRONEUSNICKNAME */
589 void IrcServerHandler::handle432(const QString &prefix, const QList<QByteArray> ¶ms) {
592 if(params.size() < 2) {
593 // handle unreal-ircd bug, where unreal ircd doesnt supply a TARGET in ERR_ERRONEUSNICKNAME during registration phase:
595 // :irc.scortum.moep.net 432 @@@ :Erroneous Nickname: Illegal characters
596 // correct server reply:
597 // :irc.scortum.moep.net 432 * @@@ :Erroneous Nickname: Illegal characters
598 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("There is a nickname in your identity's nicklist which contains illegal characters"));
599 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"));
600 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Please use: /nick <othernick> to continue or clean up your nicklist"));
602 QString errnick = params[0];
603 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Nick %1 contains illegal characters").arg(errnick));
604 tryNextNick(errnick);
608 /* ERR_NICKNAMEINUSE */
609 void IrcServerHandler::handle433(const QString &prefix, const QList<QByteArray> ¶ms) {
612 QString errnick = serverDecode(params[0]);
613 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Nick already in use: %1").arg(errnick));
615 // if there is a problem while connecting to the server -> we handle it
616 // but only if our connection has not been finished yet...
617 if(!network()->currentServer().isEmpty())
620 tryNextNick(errnick);
623 void IrcServerHandler::tryNextNick(const QString &errnick) {
624 QStringList desiredNicks = networkConnection()->coreSession()->identity(network()->identity())->nicks();
625 int nextNick = desiredNicks.indexOf(errnick) + 1;
626 if(desiredNicks.size() > nextNick) {
627 putCmd("NICK", serverEncode(desiredNicks[nextNick]));
629 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("No free and valid nicks in nicklist found. use: /nick <othernick> to continue"));
634 /***********************************************************************************/