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"
25 #include "networkinfo.h"
26 #include "ctcphandler.h"
29 #include "ircchannel.h"
33 IrcServerHandler::IrcServerHandler(Server *parent)
34 : BasicHandler(parent), server(parent) {
37 IrcServerHandler::~IrcServerHandler() {
41 QString IrcServerHandler::serverDecode(const QByteArray &string) {
42 return server->serverDecode(string);
45 QStringList IrcServerHandler::serverDecode(const QList<QByteArray> &stringlist) {
47 foreach(QByteArray s, stringlist) list << server->serverDecode(s);
51 QString IrcServerHandler::bufferDecode(const QString &bufferName, const QByteArray &string) {
52 return server->bufferDecode(bufferName, string);
55 QStringList IrcServerHandler::bufferDecode(const QString &bufferName, const QList<QByteArray> &stringlist) {
57 foreach(QByteArray s, stringlist) list << server->bufferDecode(bufferName, s);
61 QString IrcServerHandler::userDecode(const QString &userNick, const QByteArray &string) {
62 return server->userDecode(userNick, string);
65 QStringList IrcServerHandler::userDecode(const QString &userNick, const QList<QByteArray> &stringlist) {
67 foreach(QByteArray s, stringlist) list << server->userDecode(userNick, s);
71 /*! Handle a raw message string sent by the server. We try to find a suitable handler, otherwise we call a default handler. */
72 void IrcServerHandler::handleServerMsg(QByteArray msg) {
75 qWarning() << "Received empty string from server!";
79 // Now we split the raw message into its various parts...
84 // First, check for a trailing parameter introduced by " :", since this might screw up splitting the msg
85 // NOTE: This assumes that this is true in raw encoding, but well, hopefully there are no servers running in japanese on protocol level...
86 int idx = msg.indexOf(" :");
88 if(msg.length() > idx + 2) trailing = msg.mid(idx + 2);
91 // OK, now it is safe to split...
92 QList<QByteArray> params = msg.split(' ');
93 if(!trailing.isEmpty()) params << trailing;
94 if(params.count() < 1) {
95 qWarning() << "Received invalid string from server!";
99 QString foo = serverDecode(params.takeFirst());
101 // a colon as the first chars indicates the existence of a prefix
105 if(params.count() < 1) {
106 qWarning() << "Received invalid string from server!";
109 foo = serverDecode(params.takeFirst());
112 // next string without a whitespace is the command
113 cmd = foo.trimmed().toUpper();
115 // numeric replies have the target as first param (RFC 2812 - 2.4). this is usually our own nick. Remove this!
116 uint num = cmd.toUInt();
118 if(params.count() == 0) {
119 qWarning() << "Message received from server violates RFC and is ignored!";
122 params.removeFirst();
125 // Now we try to find a handler for this message. BTW, I do love the Trolltech guys ;-)
126 handle(cmd, Q_ARG(QString, prefix), Q_ARG(QList<QByteArray>, params));
127 //handle(cmd, Q_ARG(QString, prefix));
128 } catch(Exception e) {
129 emit displayMsg(Message::Error, "", e.msg());
134 void IrcServerHandler::defaultHandler(QString cmd, QString prefix, QList<QByteArray> rawparams) {
135 // we assume that all this happens in server encoding
137 foreach(QByteArray r, rawparams) params << serverDecode(r);
138 uint num = cmd.toUInt();
140 // A lot of server messages don't really need their own handler because they don't do much.
141 // Catch and handle these here.
143 // Welcome, status, info messages. Just display these.
144 case 2: case 3: case 4: case 5: case 251: case 252: case 253: case 254: case 255: case 372: case 375:
145 emit displayMsg(Message::Server, "", params.join(" "), prefix);
147 // Server error messages without param, just display them
148 case 409: case 411: case 412: case 422: case 424: case 445: case 446: case 451: case 462:
149 case 463: case 464: case 465: case 466: case 472: case 481: case 483: case 485: case 491: case 501: case 502:
150 case 431: // ERR_NONICKNAMEGIVEN
151 emit displayMsg(Message::Error, "", params.join(" "), prefix);
153 // Server error messages, display them in red. First param will be appended.
154 case 401: case 402: case 403: case 404: case 406: case 408: case 415: case 421: case 442:
155 { QString p = params.takeFirst();
156 emit displayMsg(Message::Error, "", params.join(" ") + " " + p, prefix);
159 // Server error messages which will be displayed with a colon between the first param and the rest
160 case 413: case 414: case 423: case 441: case 444: case 461:
161 case 467: case 471: case 473: case 474: case 475: case 476: case 477: case 478: case 482:
162 case 436: // ERR_NICKCOLLISION
163 { QString p = params.takeFirst();
164 emit displayMsg(Message::Error, "", p + ": " + params.join(" "));
167 // Ignore these commands.
171 // Everything else will be marked in red, so we can add them somewhere.
173 emit displayMsg(Message::Error, "", cmd + " " + params.join(" "), prefix);
175 //qDebug() << prefix <<":"<<cmd<<params;
177 emit displayMsg(Message::Error, "", QString("Unknown: ") + cmd + " " + params.join(" "), prefix);
178 //qDebug() << prefix <<":"<<cmd<<params;
182 //******************************/
183 // IRC SERVER HANDLER
184 //******************************/
185 void IrcServerHandler::handleJoin(QString prefix, QList<QByteArray> params) {
186 Q_ASSERT(params.count() == 1);
187 QString channel = serverDecode(params[0]);
188 IrcUser *ircuser = networkInfo()->updateNickFromMask(prefix);
189 emit displayMsg(Message::Join, channel, channel, prefix);
190 //qDebug() << "IrcServerHandler::handleJoin()" << prefix << params;
191 ircuser->joinChannel(channel);
194 void IrcServerHandler::handleKick(QString prefix, QList<QByteArray> params) {
195 networkInfo()->updateNickFromMask(prefix);
196 IrcUser *victim = networkInfo()->ircUser(serverDecode(params[1]));
197 QString channel = serverDecode(params[0]);
200 victim->partChannel(channel);
203 if(params.count() > 2) // someone got a reason!
204 msg = QString("%1 %2").arg(victim->nick()).arg(bufferDecode(channel, params[2]));
206 msg = victim->nick();
208 emit displayMsg(Message::Kick, channel, msg, prefix);
211 void IrcServerHandler::handleMode(QString prefix, QList<QByteArray> params) {
212 if(params.count() < 2) {
213 emit displayMsg(Message::Error, "", tr("Received invalid MODE from %s: %s").arg(prefix).arg(serverDecode(params).join(" ")));
217 if(networkInfo()->isChannelName(params[0])) {
219 emit displayMsg(Message::Mode, serverDecode(params[0]), serverDecode(params).join(" "), prefix);
221 IrcChannel *channel = networkInfo()->ircChannel(params.takeFirst());
222 // FIXME: currently the IrcChannels only support PREFIX-Modes for users
223 // This cannot be fixed unless the SignalProxy() doesn't rely on methodIds anymore
224 QString modes = params.takeFirst();
227 for(int c = 0; c < modes.length(); c++) {
228 if(modes[c] == '+') {
232 if(modes[c] == '-') {
237 // this is the part where we restrict the mode changes to PREFIXES:
238 if(networkInfo()->prefixModes().contains(modes[c]) && modeIndex < params.count()) {
239 IrcUser *ircUser = networkInfo()->ircUser(params[modeIndex]);
241 channel->addUserMode(ircUser, QString(modes[c]));
243 channel->removeUserMode(ircUser, QString(modes[c]));
250 emit displayMsg(Message::Mode, "", serverDecode(params).join(" "), prefix);
254 void IrcServerHandler::handleNick(QString prefix, QList<QByteArray> params) {
255 IrcUser *ircuser = networkInfo()->updateNickFromMask(prefix);
257 QString newnick = serverDecode(params[0]);
258 QString oldnick = ircuser->nick();
260 foreach(QString channel, ircuser->channels()) {
261 if(networkInfo()->isMyNick(oldnick)) {
262 emit displayMsg(Message::Nick, channel, newnick, newnick);
264 emit displayMsg(Message::Nick, channel, newnick, prefix);
267 ircuser->setNick(newnick);
270 void IrcServerHandler::handleNotice(QString prefix, QList<QByteArray> params) {
271 if(networkInfo()->currentServer().isEmpty() || networkInfo()->currentServer() == prefix)
272 emit displayMsg(Message::Server, "", serverDecode(params[1]), prefix);
274 emit displayMsg(Message::Notice, "", userDecode(prefix, params[1]), prefix);
277 void IrcServerHandler::handlePart(QString prefix, QList<QByteArray> params) {
278 IrcUser *ircuser = networkInfo()->updateNickFromMask(prefix);
279 QString channel = serverDecode(params[0]);
282 ircuser->partChannel(channel);
285 if(params.count() > 1)
286 msg = userDecode(ircuser->nick(), params[1]);
288 emit displayMsg(Message::Part, channel, msg, prefix);
291 void IrcServerHandler::handlePing(QString prefix, QList<QByteArray> params) {
293 emit putCmd("PONG", serverDecode(params));
296 void IrcServerHandler::handlePrivmsg(QString prefix, QList<QByteArray> params) {
297 IrcUser *ircuser = networkInfo()->updateNickFromMask(prefix);
299 if(params.count() < 2)
300 params << QByteArray("");
302 QString target = serverDecode(params[0]);
304 // are we the target or is it a channel?
305 if(networkInfo()->isMyNick(target)) {
306 // it's possible to pack multiple privmsgs into one param using ctcp
307 QStringList messages = server->ctcpHandler()->parse(CtcpHandler::CtcpQuery, prefix, target, userDecode(ircuser->nick(), params[1]));
308 foreach(QString message, messages) {
309 if(!message.isEmpty()) {
310 emit displayMsg(Message::Plain, "", message, prefix, Message::PrivMsg);
314 Q_ASSERT(isChannelName(target)); // should be channel!
315 QStringList messages = server->ctcpHandler()->parse(CtcpHandler::CtcpQuery, prefix, target, bufferDecode(target, params[1]));
316 foreach(QString message, messages) {
317 if(!message.isEmpty()) {
318 emit displayMsg(Message::Plain, target, message, prefix);
325 void IrcServerHandler::handleQuit(QString prefix, QList<QByteArray> params) {
326 IrcUser *ircuser = networkInfo()->updateNickFromMask(prefix);
331 msg = userDecode(ircuser->nick(), params[0]);
333 foreach(QString channel, ircuser->channels())
334 emit displayMsg(Message::Quit, channel, msg, prefix);
336 networkInfo()->removeIrcUser(nickFromMask(prefix));
339 void IrcServerHandler::handleTopic(QString prefix, QList<QByteArray> params) {
340 IrcUser *ircuser = networkInfo()->updateNickFromMask(prefix);
341 QString channel = serverDecode(params[0]);
342 QString topic = bufferDecode(channel, params[1]);
345 networkInfo()->ircChannel(channel)->setTopic(topic);
347 emit displayMsg(Message::Server, channel, tr("%1 has changed topic for %2 to: \"%3\"").arg(ircuser->nick()).arg(channel).arg(topic));
351 void IrcServerHandler::handle001(QString prefix, QList<QByteArray> params) {
352 // there should be only one param: "Welcome to the Internet Relay Network <nick>!<user>@<host>"
353 QString param = serverDecode(params[0]);
354 QString myhostmask = param.section(' ', -1, -1);
355 networkInfo()->setCurrentServer(prefix);
356 networkInfo()->setMyNick(nickFromMask(myhostmask));
358 emit displayMsg(Message::Server, "", param, prefix);
362 // TODO Complete 005 handling, also use sensible defaults for non-sent stuff
363 void IrcServerHandler::handle005(QString prefix, QList<QByteArray> params) {
365 QString rpl_isupport_suffix = serverDecode(params.takeLast());
366 if(rpl_isupport_suffix.toLower() != QString("are supported by this server")) {
367 qWarning() << "Received invalid RPL_ISUPPORT! Suffix is:" << rpl_isupport_suffix << "Excpected: are supported by this server";
371 foreach(QString param, serverDecode(params)) {
372 QString key = param.section("=", 0, 0);
373 QString value = param.section("=", 1);
374 networkInfo()->addSupport(key, value);
380 void IrcServerHandler::handle331(QString prefix, QList<QByteArray> params) {
382 QString channel = serverDecode(params[0]);
383 networkInfo()->ircChannel(channel)->setTopic(QString());
384 emit displayMsg(Message::Server, channel, tr("No topic is set for %1.").arg(channel));
388 void IrcServerHandler::handle332(QString prefix, QList<QByteArray> params) {
390 QString channel = serverDecode(params[0]);
391 QString topic = bufferDecode(channel, params[1]);
392 networkInfo()->ircChannel(channel)->setTopic(topic);
393 emit displayMsg(Message::Server, channel, tr("Topic for %1 is \"%2\"").arg(channel, topic));
396 /* Topic set by... */
397 void IrcServerHandler::handle333(QString prefix, QList<QByteArray> params) {
399 QString channel = serverDecode(params[0]);
400 emit displayMsg(Message::Server, channel, tr("Topic set by %1 on %2")
401 .arg(bufferDecode(channel, params[1]), QDateTime::fromTime_t(bufferDecode(channel, params[2]).toUInt()).toString()));
405 void IrcServerHandler::handle353(QString prefix, QList<QByteArray> params) {
407 params.removeFirst(); // either "=", "*" or "@" indicating a public, private or secret channel
408 QString channelname = serverDecode(params.takeFirst());
410 foreach(QString nick, serverDecode(params.takeFirst()).split(' ')) {
411 QString mode = QString();
413 if(networkInfo()->prefixes().contains(nick[0])) {
414 mode = networkInfo()->prefixToMode(nick[0]);
418 IrcUser *ircuser = networkInfo()->newIrcUser(nick);
419 ircuser->joinChannel(channelname);
422 networkInfo()->ircChannel(channelname)->addUserMode(ircuser, mode);
426 /* ERR_ERRONEUSNICKNAME */
427 void IrcServerHandler::handle432(QString prefix, QList<QByteArray> params) {
430 emit displayMsg(Message::Error, "", tr("Your desired nickname contains illegal characters!"));
431 emit displayMsg(Message::Error, "", tr("Please use /nick <othernick> to continue your IRC-Session!"));
434 // if(params.size() < 2) {
435 // // handle unreal-ircd bug, where unreal ircd doesnt supply a TARGET in ERR_ERRONEUSNICKNAME during registration phase:
437 // // :irc.scortum.moep.net 432 @@@ :Erroneous Nickname: Illegal characters
438 // // correct server reply:
439 // // :irc.scortum.moep.net 432 * @@@ :Erroneous Nickname: Illegal characters
440 // emit displayMsg(Message::Error, "", tr("There is a nickname in your identity's nicklist which contains illegal characters"));
441 // 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"));
442 // emit displayMsg(Message::Error, "", tr("Please use: /nick <othernick> to continue or clean up your nicklist"));
444 // QString errnick = params[0];
445 // emit displayMsg(Message::Error, "", tr("Nick %1 contains illegal characters").arg(errnick));
446 // // if there is a problem while connecting to the server -> we handle it
447 // // TODO rely on another source...
448 // if(currentServer.isEmpty()) {
449 // QStringList desiredNicks = identity["NickList"].toStringList();
450 // int nextNick = desiredNicks.indexOf(errnick) + 1;
451 // if (desiredNicks.size() > nextNick) {
452 // putCmd("NICK", QStringList(desiredNicks[nextNick]));
454 // emit displayMsg(Message::Error, "", tr("No free and valid nicks in nicklist found. use: /nick <othernick> to continue"));
460 /* ERR_NICKNAMEINUSE */
461 void IrcServerHandler::handle433(QString prefix, QList<QByteArray> params) {
463 QString errnick = serverDecode(params[0]);
464 emit displayMsg(Message::Error, "", tr("Nick %1 is already taken").arg(errnick));
465 emit displayMsg(Message::Error, "", tr("Please use /nick <othernick> to continue your IRC-Session!"));
468 // // if there is a problem while connecting to the server -> we handle it
469 // // TODO rely on another source...
470 // if(currentServer.isEmpty()) {
471 // QStringList desiredNicks = identity["NickList"].toStringList();
472 // int nextNick = desiredNicks.indexOf(errnick) + 1;
473 // if (desiredNicks.size() > nextNick) {
474 // putCmd("NICK", QStringList(desiredNicks[nextNick]));
476 // emit displayMsg(Message::Error, "", tr("No free and valid nicks in nicklist found. use: /nick <othernick> to continue"));
481 /***********************************************************************************/