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),
37 networkConnection(parent) {
41 IrcServerHandler::~IrcServerHandler() {
45 QString IrcServerHandler::serverDecode(const QByteArray &string) {
46 return networkConnection->serverDecode(string);
49 QStringList IrcServerHandler::serverDecode(const QList<QByteArray> &stringlist) {
51 foreach(QByteArray s, stringlist) list << networkConnection->serverDecode(s);
55 QString IrcServerHandler::bufferDecode(const QString &bufferName, const QByteArray &string) {
56 return networkConnection->bufferDecode(bufferName, string);
59 QStringList IrcServerHandler::bufferDecode(const QString &bufferName, const QList<QByteArray> &stringlist) {
61 foreach(QByteArray s, stringlist) list << networkConnection->bufferDecode(bufferName, s);
65 QString IrcServerHandler::userDecode(const QString &userNick, const QByteArray &string) {
66 return networkConnection->userDecode(userNick, string);
69 QStringList IrcServerHandler::userDecode(const QString &userNick, const QList<QByteArray> &stringlist) {
71 foreach(QByteArray s, stringlist) list << networkConnection->userDecode(userNick, s);
75 /*! Handle a raw message string sent by the server. We try to find a suitable handler, otherwise we call a default handler. */
76 void IrcServerHandler::handleServerMsg(QByteArray msg) {
79 qWarning() << "Received empty string from server!";
83 // Now we split the raw message into its various parts...
88 // First, check for a trailing parameter introduced by " :", since this might screw up splitting the msg
89 // NOTE: This assumes that this is true in raw encoding, but well, hopefully there are no servers running in japanese on protocol level...
90 int idx = msg.indexOf(" :");
92 if(msg.length() > idx + 2) trailing = msg.mid(idx + 2);
95 // OK, now it is safe to split...
96 QList<QByteArray> params = msg.split(' ');
97 if(!trailing.isEmpty()) params << trailing;
98 if(params.count() < 1) {
99 qWarning() << "Received invalid string from server!";
103 QString foo = serverDecode(params.takeFirst());
105 // a colon as the first chars indicates the existence of a prefix
109 if(params.count() < 1) {
110 qWarning() << "Received invalid string from server!";
113 foo = serverDecode(params.takeFirst());
116 // next string without a whitespace is the command
117 cmd = foo.trimmed().toUpper();
119 // numeric replies have the target as first param (RFC 2812 - 2.4). this is usually our own nick. Remove this!
120 uint num = cmd.toUInt();
122 if(params.count() == 0) {
123 qWarning() << "Message received from server violates RFC and is ignored!";
126 params.removeFirst();
129 // Now we try to find a handler for this message. BTW, I do love the Trolltech guys ;-)
130 handle(cmd, Q_ARG(QString, prefix), Q_ARG(QList<QByteArray>, params));
131 //handle(cmd, Q_ARG(QString, prefix));
132 } catch(Exception e) {
133 emit displayMsg(Message::Error, "", e.msg());
138 void IrcServerHandler::defaultHandler(QString cmd, QString prefix, QList<QByteArray> rawparams) {
139 // we assume that all this happens in server encoding
141 foreach(QByteArray r, rawparams) params << serverDecode(r);
142 uint num = cmd.toUInt();
144 // A lot of server messages don't really need their own handler because they don't do much.
145 // Catch and handle these here.
147 // Welcome, status, info messages. Just display these.
148 case 2: case 3: case 4: case 5: case 251: case 252: case 253: case 254: case 255: case 372: case 375:
149 emit displayMsg(Message::Server, "", params.join(" "), prefix);
151 // Server error messages without param, just display them
152 case 409: case 411: case 412: case 422: case 424: case 445: case 446: case 451: case 462:
153 case 463: case 464: case 465: case 466: case 472: case 481: case 483: case 485: case 491: case 501: case 502:
154 case 431: // ERR_NONICKNAMEGIVEN
155 emit displayMsg(Message::Error, "", params.join(" "), prefix);
157 // Server error messages, display them in red. First param will be appended.
159 { QString channelName = params.takeFirst();
160 emit displayMsg(Message::Error, "", params.join(" ") + " " + channelName, prefix);
161 emit displayMsg(Message::Error, channelName, params.join(" ") + " " + channelName, prefix);
164 case 402: case 403: case 404: case 406: case 408: case 415: case 421: case 442:
165 { QString channelName = params.takeFirst();
166 emit displayMsg(Message::Error, "", params.join(" ") + " " + channelName, prefix);
169 // Server error messages which will be displayed with a colon between the first param and the rest
170 case 413: case 414: case 423: case 441: case 444: case 461:
171 case 467: case 471: case 473: case 474: case 475: case 476: case 477: case 478: case 482:
172 case 436: // ERR_NICKCOLLISION
173 { QString p = params.takeFirst();
174 emit displayMsg(Message::Error, "", p + ": " + params.join(" "));
177 // Ignore these commands.
181 // Everything else will be marked in red, so we can add them somewhere.
183 emit displayMsg(Message::Error, "", cmd + " " + params.join(" "), prefix);
185 //qDebug() << prefix <<":"<<cmd<<params;
187 emit displayMsg(Message::Error, "", QString("Unknown: ") + cmd + " " + params.join(" "), prefix);
188 //qDebug() << prefix <<":"<<cmd<<params;
192 //******************************/
193 // IRC SERVER HANDLER
194 //******************************/
195 void IrcServerHandler::handleJoin(QString prefix, QList<QByteArray> params) {
196 Q_ASSERT(params.count() == 1);
197 QString channel = serverDecode(params[0]);
198 IrcUser *ircuser = network()->updateNickFromMask(prefix);
199 emit displayMsg(Message::Join, channel, channel, prefix);
200 //qDebug() << "IrcServerHandler::handleJoin()" << prefix << params;
201 ircuser->joinChannel(channel);
204 void IrcServerHandler::handleKick(QString prefix, QList<QByteArray> params) {
205 network()->updateNickFromMask(prefix);
206 IrcUser *victim = network()->ircUser(serverDecode(params[1]));
207 QString channel = serverDecode(params[0]);
210 victim->partChannel(channel);
213 if(params.count() > 2) // someone got a reason!
214 msg = QString("%1 %2").arg(victim->nick()).arg(bufferDecode(channel, params[2]));
216 msg = victim->nick();
218 emit displayMsg(Message::Kick, channel, msg, prefix);
221 void IrcServerHandler::handleMode(QString prefix, QList<QByteArray> params) {
222 if(params.count() < 2) {
223 emit displayMsg(Message::Error, "", tr("Received invalid MODE from %s: %s").arg(prefix).arg(serverDecode(params).join(" ")));
227 if(network()->isChannelName(params[0])) {
229 emit displayMsg(Message::Mode, serverDecode(params[0]), serverDecode(params).join(" "), prefix);
231 IrcChannel *channel = network()->ircChannel(params.takeFirst());
232 // FIXME: currently the IrcChannels only support PREFIX-Modes for users
233 // This cannot be fixed unless the SignalProxy() doesn't rely on methodIds anymore
234 QString modes = params.takeFirst();
237 for(int c = 0; c < modes.length(); c++) {
238 if(modes[c] == '+') {
242 if(modes[c] == '-') {
247 // this is the part where we restrict the mode changes to PREFIXES:
248 if(network()->prefixModes().contains(modes[c]) && modeIndex < params.count()) {
249 IrcUser *ircUser = network()->ircUser(params[modeIndex]);
251 channel->addUserMode(ircUser, QString(modes[c]));
253 channel->removeUserMode(ircUser, QString(modes[c]));
260 emit displayMsg(Message::Mode, "", serverDecode(params).join(" "), prefix);
264 void IrcServerHandler::handleNick(QString prefix, QList<QByteArray> params) {
265 IrcUser *ircuser = network()->updateNickFromMask(prefix);
267 QString newnick = serverDecode(params[0]);
268 QString oldnick = ircuser->nick();
270 foreach(QString channel, ircuser->channels()) {
271 if(network()->isMyNick(oldnick)) {
272 emit displayMsg(Message::Nick, channel, newnick, newnick);
274 emit displayMsg(Message::Nick, channel, newnick, prefix);
277 ircuser->setNick(newnick);
280 void IrcServerHandler::handleNotice(QString prefix, QList<QByteArray> params) {
281 if(params.count() < 2) {
282 qWarning() << "IrcServerHandler::handleNotice(): not enoug Parameters:" << prefix << serverDecode(params);
286 // check if it's only a Server Message or if it's a regular Notice
287 if(network()->currentServer().isEmpty() || network()->currentServer() == prefix) {
288 emit displayMsg(Message::Server, "", serverDecode(params[1]), prefix);
292 QString target = serverDecode(params[0]);
294 // kick notices to the server buffer if they are directly addressed to us
295 if(network()->isMyNick(target))
296 target = QString("");
298 networkConnection->ctcpHandler()->parse(Message::Notice, prefix, target, userDecode(prefix, params[1]));
301 void IrcServerHandler::handlePart(QString prefix, QList<QByteArray> params) {
302 IrcUser *ircuser = network()->updateNickFromMask(prefix);
303 QString channel = serverDecode(params[0]);
306 ircuser->partChannel(channel);
309 if(params.count() > 1)
310 msg = userDecode(ircuser->nick(), params[1]);
312 emit displayMsg(Message::Part, channel, msg, prefix);
315 void IrcServerHandler::handlePing(QString prefix, QList<QByteArray> params) {
317 emit putCmd("PONG", serverDecode(params));
320 void IrcServerHandler::handlePrivmsg(QString prefix, QList<QByteArray> params) {
321 IrcUser *ircuser = network()->updateNickFromMask(prefix);
323 if(params.count() < 2)
324 params << QByteArray("");
326 QString target = serverDecode(params[0]);
328 // are we the target?
329 if(network()->isMyNick(target))
330 target = nickFromMask(ircuser->nick());
332 // it's possible to pack multiple privmsgs into one param using ctcp
333 // - > we let the ctcpHandler do the work
334 networkConnection->ctcpHandler()->parse(Message::Plain, prefix, target, userDecode(ircuser->nick(), params[1]));
337 void IrcServerHandler::handleQuit(QString prefix, QList<QByteArray> params) {
338 IrcUser *ircuser = network()->updateNickFromMask(prefix);
343 msg = userDecode(ircuser->nick(), params[0]);
345 foreach(QString channel, ircuser->channels())
346 emit displayMsg(Message::Quit, channel, msg, prefix);
348 network()->removeIrcUser(nickFromMask(prefix));
351 void IrcServerHandler::handleTopic(QString prefix, QList<QByteArray> params) {
352 IrcUser *ircuser = network()->updateNickFromMask(prefix);
353 QString channel = serverDecode(params[0]);
354 QString topic = bufferDecode(channel, params[1]);
357 network()->ircChannel(channel)->setTopic(topic);
359 emit displayMsg(Message::Server, channel, tr("%1 has changed topic for %2 to: \"%3\"").arg(ircuser->nick()).arg(channel).arg(topic));
363 void IrcServerHandler::handle001(QString prefix, QList<QByteArray> params) {
364 // there should be only one param: "Welcome to the Internet Relay Network <nick>!<user>@<host>"
365 QString param = serverDecode(params[0]);
366 QString myhostmask = param.section(' ', -1, -1);
367 network()->setCurrentServer(prefix);
368 network()->setMyNick(nickFromMask(myhostmask));
370 emit displayMsg(Message::Server, "", param, prefix);
374 // TODO Complete 005 handling, also use sensible defaults for non-sent stuff
375 void IrcServerHandler::handle005(QString prefix, QList<QByteArray> params) {
377 QString rpl_isupport_suffix = serverDecode(params.takeLast());
378 if(rpl_isupport_suffix.toLower() != QString("are supported by this server")) {
379 qWarning() << "Received invalid RPL_ISUPPORT! Suffix is:" << rpl_isupport_suffix << "Excpected: are supported by this server";
383 foreach(QString param, serverDecode(params)) {
384 QString key = param.section("=", 0, 0);
385 QString value = param.section("=", 1);
386 network()->addSupport(key, value);
393 Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message.
395 "<nick> :<away message>"
397 Replies 352 and 315 paired are used to answer a WHO message.
400 Replies 314 and 369 are responses to a WHOWAS message.
405 /* RPL_AWAY - "<nick> :<away message>" */
406 void IrcServerHandler::handle301(QString prefix, QList<QByteArray> params) {
408 QString nickName = serverDecode(params[0]);
409 QString awayMessage = serverDecode(params.last());
411 IrcUser *ircuser = network()->ircUser(nickName);
413 ircuser->setAwayMessage(awayMessage);
414 ircuser->setAway(true);
418 emit displayMsg(Message::Server, "", tr("[Whois] %1 is away: \"%2\"").arg(nickName).arg(awayMessage));
421 int now = QDateTime::currentDateTime().toTime_t();
422 int silenceTime = 60;
423 if(ircuser->lastAwayMessage() + silenceTime < now) {
424 emit displayMsg(Message::Server, params[0], tr("%1 is away: \"%2\"").arg(nickName).arg(awayMessage));
426 ircuser->setLastAwayMessage(now);
428 // probably should not happen
429 emit displayMsg(Message::Server, params[0], tr("%1 is away: \"%2\"").arg(nickName).arg(awayMessage));
434 /* RPL_WHOISUSER - "<nick> <user> <host> * :<real name>" */
435 void IrcServerHandler::handle311(QString prefix, QList<QByteArray> params) {
438 IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
440 ircuser->setUser(serverDecode(params[1]));
441 ircuser->setHost(serverDecode(params[2]));
442 ircuser->setRealName(serverDecode(params.last()));
444 emit displayMsg(Message::Server, "", tr("[Whois] %1")
445 .arg(serverDecode(params).join(" ")));
448 /* RPL_WHOISSERVER - "<nick> <server> :<server info>" */
449 void IrcServerHandler::handle312(QString prefix, QList<QByteArray> params) {
451 IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
453 ircuser->setServer(serverDecode(params[1]));
456 emit displayMsg(Message::Server, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
458 emit displayMsg(Message::Server, "", tr("[Whowas] %1").arg(serverDecode(params).join(" ")));
462 /* RPL_WHOISOPERATOR - "<nick> :is an IRC operator" */
463 void IrcServerHandler::handle313(QString prefix, QList<QByteArray> params) {
465 IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
467 ircuser->setIrcOperator(params.last());
469 emit displayMsg(Message::Server, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
472 /* RPL_WHOWASUSER - "<nick> <user> <host> * :<real name>" */
473 void IrcServerHandler::handle314(QString prefix, QList<QByteArray> params) {
475 emit displayMsg(Message::Server, "", tr("[Whowas] %1").arg(serverDecode(params).join(" ")));
478 /* RPL_ENDOFWHO: "<name> :End of WHO list" */
479 void IrcServerHandler::handle315(QString prefix, QList<QByteArray> params) {
481 emit displayMsg(Message::Server, "", tr("[Who] %1").arg(serverDecode(params).join(" ")));
484 /* RPL_WHOISIDLE - "<nick> <integer> :seconds idle"
485 (real life: "<nick> <integer> <integer> :seconds idle, signon time) */
486 //TODO: parse real life message
487 void IrcServerHandler::handle317(QString prefix, QList<QByteArray> params) {
489 IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
491 QDateTime now = QDateTime::currentDateTime();
492 int idleSecs = serverDecode(params[1]).toInt();
494 ircuser->setIdleTime(now.addSecs(idleSecs));
495 emit displayMsg(Message::Server, "", tr("[Whois] %1 is idling for %2 seconds").arg(ircuser->nick()).arg(ircuser->idleTime().secsTo(now)));
497 emit displayMsg(Message::Server, "", tr("[Whois] idle message: %1").arg(serverDecode(params).join(" ")));
501 /* RPL_ENDOFWHOIS - "<nick> :End of WHOIS list" */
502 void IrcServerHandler::handle318(QString prefix, QList<QByteArray> params) {
505 emit displayMsg(Message::Server, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
508 /* RPL_WHOISCHANNELS - "<nick> :*( ( "@" / "+" ) <channel> " " )" */
509 void IrcServerHandler::handle319(QString prefix, QList<QByteArray> params) {
511 emit displayMsg(Message::Server, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
515 void IrcServerHandler::handle331(QString prefix, QList<QByteArray> params) {
517 QString channel = serverDecode(params[0]);
518 network()->ircChannel(channel)->setTopic(QString());
519 emit displayMsg(Message::Server, channel, tr("No topic is set for %1.").arg(channel));
523 void IrcServerHandler::handle332(QString prefix, QList<QByteArray> params) {
525 QString channel = serverDecode(params[0]);
526 QString topic = bufferDecode(channel, params[1]);
527 network()->ircChannel(channel)->setTopic(topic);
528 emit displayMsg(Message::Server, channel, tr("Topic for %1 is \"%2\"").arg(channel, topic));
531 /* Topic set by... */
532 void IrcServerHandler::handle333(QString prefix, QList<QByteArray> params) {
534 QString channel = serverDecode(params[0]);
535 emit displayMsg(Message::Server, channel, tr("Topic set by %1 on %2")
536 .arg(bufferDecode(channel, params[1]), QDateTime::fromTime_t(bufferDecode(channel, params[2]).toUInt()).toString()));
539 /* RPL_WHOREPLY: "<channel> <user> <host> <server> <nick>
540 ( "H" / "G" > ["*"] [ ( "@" / "+" ) ] :<hopcount> <real name>" */
541 void IrcServerHandler::handle352(QString prefix, QList<QByteArray> params) {
543 QString channel = serverDecode(params[0]);
544 IrcUser *ircuser = network()->ircUser(serverDecode(params[4]));
546 ircuser->setUser(serverDecode(params[1]));
547 ircuser->setHost(serverDecode(params[2]));
549 bool away = serverDecode(params[5]).startsWith("G") ? true : false;
550 ircuser->setAway(away);
551 ircuser->setServer(serverDecode(params[3]));
552 ircuser->setRealName(serverDecode(params.last()).section(" ", 1));
555 emit displayMsg(Message::Server, "", tr("[Who] %1").arg(serverDecode(params).join(" ")));
559 void IrcServerHandler::handle353(QString prefix, QList<QByteArray> params) {
561 params.removeFirst(); // either "=", "*" or "@" indicating a public, private or secret channel
562 QString channelname = serverDecode(params.takeFirst());
564 foreach(QString nick, serverDecode(params.takeFirst()).split(' ')) {
565 QString mode = QString();
567 if(network()->prefixes().contains(nick[0])) {
568 mode = network()->prefixToMode(nick[0]);
572 IrcUser *ircuser = network()->newIrcUser(nick);
573 ircuser->joinChannel(channelname);
576 network()->ircChannel(channelname)->addUserMode(ircuser, mode);
580 /* RPL_ENDOFWHOWAS - "<nick> :End of WHOWAS" */
581 void IrcServerHandler::handle369(QString prefix, QList<QByteArray> params) {
583 emit displayMsg(Message::Server, "", tr("[Whowas] %1").arg(serverDecode(params).join(" ")));
586 /* ERR_ERRONEUSNICKNAME */
587 void IrcServerHandler::handle432(QString prefix, QList<QByteArray> params) {
590 if(params.size() < 2) {
591 // handle unreal-ircd bug, where unreal ircd doesnt supply a TARGET in ERR_ERRONEUSNICKNAME during registration phase:
593 // :irc.scortum.moep.net 432 @@@ :Erroneous Nickname: Illegal characters
594 // correct server reply:
595 // :irc.scortum.moep.net 432 * @@@ :Erroneous Nickname: Illegal characters
596 emit displayMsg(Message::Error, "", tr("There is a nickname in your identity's nicklist which contains illegal characters"));
597 emit displayMsg(Message::Error, "", tr("Due to a bug in Unreal IRCd (and maybe other irc-servers too) we're unable to determine the erroneous nick"));
598 emit displayMsg(Message::Error, "", tr("Please use: /nick <othernick> to continue or clean up your nicklist"));
600 QString errnick = params[0];
601 emit displayMsg(Message::Error, "", tr("Nick %1 contains illegal characters").arg(errnick));
602 tryNextNick(errnick);
606 /* ERR_NICKNAMEINUSE */
607 void IrcServerHandler::handle433(QString prefix, QList<QByteArray> params) {
610 QString errnick = serverDecode(params[0]);
611 emit displayMsg(Message::Error, "", tr("Nick already in use: %1").arg(errnick));
613 // if there is a problem while connecting to the server -> we handle it
614 // but only if our connection has not been finished yet...
615 if(!networkConnection->network()->currentServer().isEmpty())
618 tryNextNick(errnick);
621 void IrcServerHandler::tryNextNick(const QString &errnick) {
622 QStringList desiredNicks = networkConnection->coreSession()->identity(networkConnection->network()->identity())->nicks();
623 int nextNick = desiredNicks.indexOf(errnick) + 1;
624 if(desiredNicks.size() > nextNick) {
625 putCmd("NICK", QStringList(desiredNicks[nextNick]));
627 emit displayMsg(Message::Error, "", tr("No free and valid nicks in nicklist found. use: /nick <othernick> to continue"));
632 /***********************************************************************************/