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.
158 case 401: case 402: case 403: case 404: case 406: case 408: case 415: case 421: case 442:
159 { QString p = params.takeFirst();
160 emit displayMsg(Message::Error, "", params.join(" ") + " " + p, prefix);
163 // Server error messages which will be displayed with a colon between the first param and the rest
164 case 413: case 414: case 423: case 441: case 444: case 461:
165 case 467: case 471: case 473: case 474: case 475: case 476: case 477: case 478: case 482:
166 case 436: // ERR_NICKCOLLISION
167 { QString p = params.takeFirst();
168 emit displayMsg(Message::Error, "", p + ": " + params.join(" "));
171 // Ignore these commands.
175 // Everything else will be marked in red, so we can add them somewhere.
177 emit displayMsg(Message::Error, "", cmd + " " + params.join(" "), prefix);
179 //qDebug() << prefix <<":"<<cmd<<params;
181 emit displayMsg(Message::Error, "", QString("Unknown: ") + cmd + " " + params.join(" "), prefix);
182 //qDebug() << prefix <<":"<<cmd<<params;
186 //******************************/
187 // IRC SERVER HANDLER
188 //******************************/
189 void IrcServerHandler::handleJoin(QString prefix, QList<QByteArray> params) {
190 Q_ASSERT(params.count() == 1);
191 QString channel = serverDecode(params[0]);
192 IrcUser *ircuser = network()->updateNickFromMask(prefix);
193 emit displayMsg(Message::Join, channel, channel, prefix);
194 //qDebug() << "IrcServerHandler::handleJoin()" << prefix << params;
195 ircuser->joinChannel(channel);
198 void IrcServerHandler::handleKick(QString prefix, QList<QByteArray> params) {
199 network()->updateNickFromMask(prefix);
200 IrcUser *victim = network()->ircUser(serverDecode(params[1]));
201 QString channel = serverDecode(params[0]);
204 victim->partChannel(channel);
207 if(params.count() > 2) // someone got a reason!
208 msg = QString("%1 %2").arg(victim->nick()).arg(bufferDecode(channel, params[2]));
210 msg = victim->nick();
212 emit displayMsg(Message::Kick, channel, msg, prefix);
215 void IrcServerHandler::handleMode(QString prefix, QList<QByteArray> params) {
216 if(params.count() < 2) {
217 emit displayMsg(Message::Error, "", tr("Received invalid MODE from %s: %s").arg(prefix).arg(serverDecode(params).join(" ")));
221 if(network()->isChannelName(params[0])) {
223 emit displayMsg(Message::Mode, serverDecode(params[0]), serverDecode(params).join(" "), prefix);
225 IrcChannel *channel = network()->ircChannel(params.takeFirst());
226 // FIXME: currently the IrcChannels only support PREFIX-Modes for users
227 // This cannot be fixed unless the SignalProxy() doesn't rely on methodIds anymore
228 QString modes = params.takeFirst();
231 for(int c = 0; c < modes.length(); c++) {
232 if(modes[c] == '+') {
236 if(modes[c] == '-') {
241 // this is the part where we restrict the mode changes to PREFIXES:
242 if(network()->prefixModes().contains(modes[c]) && modeIndex < params.count()) {
243 IrcUser *ircUser = network()->ircUser(params[modeIndex]);
245 channel->addUserMode(ircUser, QString(modes[c]));
247 channel->removeUserMode(ircUser, QString(modes[c]));
254 emit displayMsg(Message::Mode, "", serverDecode(params).join(" "), prefix);
258 void IrcServerHandler::handleNick(QString prefix, QList<QByteArray> params) {
259 IrcUser *ircuser = network()->updateNickFromMask(prefix);
261 QString newnick = serverDecode(params[0]);
262 QString oldnick = ircuser->nick();
264 foreach(QString channel, ircuser->channels()) {
265 if(network()->isMyNick(oldnick)) {
266 emit displayMsg(Message::Nick, channel, newnick, newnick);
268 emit displayMsg(Message::Nick, channel, newnick, prefix);
271 ircuser->setNick(newnick);
274 void IrcServerHandler::handleNotice(QString prefix, QList<QByteArray> params) {
275 if(network()->currentServer().isEmpty() || network()->currentServer() == prefix)
276 emit displayMsg(Message::Server, "", serverDecode(params[1]), prefix);
278 emit displayMsg(Message::Notice, "", userDecode(prefix, params[1]), prefix);
281 void IrcServerHandler::handlePart(QString prefix, QList<QByteArray> params) {
282 IrcUser *ircuser = network()->updateNickFromMask(prefix);
283 QString channel = serverDecode(params[0]);
286 ircuser->partChannel(channel);
289 if(params.count() > 1)
290 msg = userDecode(ircuser->nick(), params[1]);
292 emit displayMsg(Message::Part, channel, msg, prefix);
295 void IrcServerHandler::handlePing(QString prefix, QList<QByteArray> params) {
297 emit putCmd("PONG", serverDecode(params));
300 void IrcServerHandler::handlePrivmsg(QString prefix, QList<QByteArray> params) {
301 IrcUser *ircuser = network()->updateNickFromMask(prefix);
303 if(params.count() < 2)
304 params << QByteArray("");
306 QString target = serverDecode(params[0]);
308 // are we the target or is it a channel?
309 if(network()->isMyNick(target)) {
310 // it's possible to pack multiple privmsgs into one param using ctcp
311 QStringList messages = networkConnection->ctcpHandler()->parse(CtcpHandler::CtcpQuery, prefix, target, userDecode(ircuser->nick(), params[1]));
313 foreach(QString message, messages) {
314 flags = Message::PrivMsg;
315 if(message.contains(network()->myNick()))
316 flags |= Message::Highlight;
317 emit displayMsg(Message::Plain, "", message, prefix, flags);
320 // so it's probably a channel..
321 if(!isChannelName(target)) {
322 qWarning() << "received PRIVMSG with target" << target << "which is neither us nor a channel!";
326 QStringList messages = networkConnection->ctcpHandler()->parse(CtcpHandler::CtcpQuery, prefix, target, bufferDecode(target, params[1]));
328 foreach(QString message, messages) {
329 flags = Message::None;
330 if(message.contains(network()->myNick()))
331 flags |= Message::Highlight;
332 emit displayMsg(Message::Plain, target, message, prefix, flags);
338 void IrcServerHandler::handleQuit(QString prefix, QList<QByteArray> params) {
339 IrcUser *ircuser = network()->updateNickFromMask(prefix);
344 msg = userDecode(ircuser->nick(), params[0]);
346 foreach(QString channel, ircuser->channels())
347 emit displayMsg(Message::Quit, channel, msg, prefix);
349 network()->removeIrcUser(nickFromMask(prefix));
352 void IrcServerHandler::handleTopic(QString prefix, QList<QByteArray> params) {
353 IrcUser *ircuser = network()->updateNickFromMask(prefix);
354 QString channel = serverDecode(params[0]);
355 QString topic = bufferDecode(channel, params[1]);
358 network()->ircChannel(channel)->setTopic(topic);
360 emit displayMsg(Message::Server, channel, tr("%1 has changed topic for %2 to: \"%3\"").arg(ircuser->nick()).arg(channel).arg(topic));
364 void IrcServerHandler::handle001(QString prefix, QList<QByteArray> params) {
365 // there should be only one param: "Welcome to the Internet Relay Network <nick>!<user>@<host>"
366 QString param = serverDecode(params[0]);
367 QString myhostmask = param.section(' ', -1, -1);
368 network()->setCurrentServer(prefix);
369 network()->setMyNick(nickFromMask(myhostmask));
371 emit displayMsg(Message::Server, "", param, prefix);
375 // TODO Complete 005 handling, also use sensible defaults for non-sent stuff
376 void IrcServerHandler::handle005(QString prefix, QList<QByteArray> params) {
378 QString rpl_isupport_suffix = serverDecode(params.takeLast());
379 if(rpl_isupport_suffix.toLower() != QString("are supported by this server")) {
380 qWarning() << "Received invalid RPL_ISUPPORT! Suffix is:" << rpl_isupport_suffix << "Excpected: are supported by this server";
384 foreach(QString param, serverDecode(params)) {
385 QString key = param.section("=", 0, 0);
386 QString value = param.section("=", 1);
387 network()->addSupport(key, value);
394 Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message.
396 "<nick> :<away message>"
398 Replies 352 and 315 paired are used to answer a WHO message.
401 Replies 314 and 369 are responses to a WHOWAS message.
403 ??? BitlBee program, simulating IRC server with one channel, 374-378
407 /* RPL_AWAY - "<nick> :<away message>" */
408 void IrcServerHandler::handle301(QString prefix, QList<QByteArray> params) {
410 IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
411 ircuser->setAwayMessage(serverDecode(params.last()));
412 ircuser->setAway(true);
413 emit displayMsg(Message::Server, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
416 /* RPL_WHOISUSER - "<nick> <user> <host> * :<real name>" */
417 void IrcServerHandler::handle311(QString prefix, QList<QByteArray> params) {
419 IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
420 ircuser->setUser(serverDecode(params[1]));
421 ircuser->setHost(serverDecode(params[2]));
422 ircuser->setRealName(serverDecode(params.last()));
423 emit displayMsg(Message::Server, "", tr("[Whois] %1 %2 %3 (%4)")
424 .arg(ircuser->nick(), ircuser->user(), ircuser->host(), ircuser->realName()));
427 /* RPL_WHOISSERVER - "<nick> <server> :<server info>" */
428 void IrcServerHandler::handle312(QString prefix, QList<QByteArray> params) {
430 IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
431 ircuser->setServer(serverDecode(params[1]));
433 emit displayMsg(Message::Server, "", tr("[Whowas] %1").arg(serverDecode(params).join(" ")));
435 emit displayMsg(Message::Server, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
439 /* RPL_WHOISOPERATOR - "<nick> :is an IRC operator" */
440 void IrcServerHandler::handle313(QString prefix, QList<QByteArray> params) {
442 IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
443 ircuser->setIrcOperator(params.last());
444 emit displayMsg(Message::Server, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
447 /* RPL_WHOWASUSER - "<nick> <user> <host> * :<real name>" */
448 void IrcServerHandler::handle314(QString prefix, QList<QByteArray> params) {
451 emit displayMsg(Message::Server, "", tr("[Whowas] %1").arg(serverDecode(params).join(" ")));
454 /* RPL_ENDOFWHO: "<name> :End of WHO list" */
455 void IrcServerHandler::handle315(QString prefix, QList<QByteArray> params) {
457 emit displayMsg(Message::Server, "", tr("[Who] %1").arg(serverDecode(params).join(" ")));
460 /* RPL_WHOISIDLE - "<nick> <integer> :seconds idle" */
461 void IrcServerHandler::handle317(QString prefix, QList<QByteArray> params) {
463 IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
464 QDateTime now = QDateTime::currentDateTime();
465 int idleSecs = serverDecode(params[1]).toInt();
467 ircuser->setIdleTime(now.addSecs(idleSecs));
468 emit displayMsg(Message::Server, "", tr("[Whois] %1 %2").arg(ircuser->nick()).arg(ircuser->idleTime().secsTo(now)));
471 /* RPL_ENDOFWHOIS - "<nick> :End of WHOIS list" */
472 void IrcServerHandler::handle318(QString prefix, QList<QByteArray> params) {
474 emit displayMsg(Message::Server, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
477 /* RPL_WHOISCHANNELS - "<nick> :*( ( "@" / "+" ) <channel> " " )" */
478 void IrcServerHandler::handle319(QString prefix, QList<QByteArray> params) {
480 emit displayMsg(Message::Server, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
484 void IrcServerHandler::handle331(QString prefix, QList<QByteArray> params) {
486 QString channel = serverDecode(params[0]);
487 network()->ircChannel(channel)->setTopic(QString());
488 emit displayMsg(Message::Server, channel, tr("No topic is set for %1.").arg(channel));
492 void IrcServerHandler::handle332(QString prefix, QList<QByteArray> params) {
494 QString channel = serverDecode(params[0]);
495 QString topic = bufferDecode(channel, params[1]);
496 network()->ircChannel(channel)->setTopic(topic);
497 emit displayMsg(Message::Server, channel, tr("Topic for %1 is \"%2\"").arg(channel, topic));
500 /* Topic set by... */
501 void IrcServerHandler::handle333(QString prefix, QList<QByteArray> params) {
503 QString channel = serverDecode(params[0]);
504 emit displayMsg(Message::Server, channel, tr("Topic set by %1 on %2")
505 .arg(bufferDecode(channel, params[1]), QDateTime::fromTime_t(bufferDecode(channel, params[2]).toUInt()).toString()));
508 /* RPL_WHOREPLY: "<channel> <user> <host> <server> <nick>
509 ( "H" / "G" > ["*"] [ ( "@" / "+" ) ] :<hopcount> <real name>" */
510 void IrcServerHandler::handle352(QString prefix, QList<QByteArray> params) {
512 QString channel = serverDecode(params[0]);
513 IrcUser *ircuser = network()->ircUser(serverDecode(params[4]));
514 ircuser->setUser(serverDecode(params[1]));
515 ircuser->setHost(serverDecode(params[2]));
517 bool away = serverDecode(params[5]).startsWith("G") ? true : false;
518 ircuser->setAway(away);
519 ircuser->setServer(serverDecode(params[3]));
520 ircuser->setRealName(serverDecode(params.last()).section(" ", 1));
522 emit displayMsg(Message::Server, "", tr("[Who] %1").arg(serverDecode(params).join(" ")));
526 void IrcServerHandler::handle353(QString prefix, QList<QByteArray> params) {
528 params.removeFirst(); // either "=", "*" or "@" indicating a public, private or secret channel
529 QString channelname = serverDecode(params.takeFirst());
531 foreach(QString nick, serverDecode(params.takeFirst()).split(' ')) {
532 QString mode = QString();
534 if(network()->prefixes().contains(nick[0])) {
535 mode = network()->prefixToMode(nick[0]);
539 IrcUser *ircuser = network()->newIrcUser(nick);
540 ircuser->joinChannel(channelname);
543 network()->ircChannel(channelname)->addUserMode(ircuser, mode);
547 /* RPL_ENDOFWHOWAS - "<nick> :End of WHOWAS" */
548 void IrcServerHandler::handle369(QString prefix, QList<QByteArray> params) {
551 emit displayMsg(Message::Server, "", tr("[Whowas] %1").arg(serverDecode(params).join(" ")));
554 /* ERR_ERRONEUSNICKNAME */
555 void IrcServerHandler::handle432(QString prefix, QList<QByteArray> params) {
558 if(params.size() < 2) {
559 // handle unreal-ircd bug, where unreal ircd doesnt supply a TARGET in ERR_ERRONEUSNICKNAME during registration phase:
561 // :irc.scortum.moep.net 432 @@@ :Erroneous Nickname: Illegal characters
562 // correct server reply:
563 // :irc.scortum.moep.net 432 * @@@ :Erroneous Nickname: Illegal characters
564 emit displayMsg(Message::Error, "", tr("There is a nickname in your identity's nicklist which contains illegal characters"));
565 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"));
566 emit displayMsg(Message::Error, "", tr("Please use: /nick <othernick> to continue or clean up your nicklist"));
568 QString errnick = params[0];
569 emit displayMsg(Message::Error, "", tr("Nick %1 contains illegal characters").arg(errnick));
570 tryNextNick(errnick);
574 /* ERR_NICKNAMEINUSE */
575 void IrcServerHandler::handle433(QString prefix, QList<QByteArray> params) {
578 QString errnick = serverDecode(params[0]);
579 emit displayMsg(Message::Error, "", tr("Nick already in use: %1").arg(errnick));
581 // if there is a problem while connecting to the server -> we handle it
582 // but only if our connection has not been finished yet...
583 if(!networkConnection->network()->currentServer().isEmpty())
586 tryNextNick(errnick);
589 void IrcServerHandler::tryNextNick(const QString &errnick) {
590 QStringList desiredNicks = networkConnection->coreSession()->identity(networkConnection->network()->identity())->nicks();
591 int nextNick = desiredNicks.indexOf(errnick) + 1;
592 if(desiredNicks.size() > nextNick) {
593 putCmd("NICK", QStringList(desiredNicks[nextNick]));
595 emit displayMsg(Message::Error, "", tr("No free and valid nicks in nicklist found. use: /nick <othernick> to continue"));
600 /***********************************************************************************/