1 /***************************************************************************
2 * Copyright (C) 2005-10 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 "coreirclisthelper.h"
26 #include "coreidentity.h"
27 #include "ctcphandler.h"
30 #include "coreircchannel.h"
39 IrcServerHandler::IrcServerHandler(CoreNetwork *parent)
40 : CoreBasicHandler(parent),
43 connect(parent, SIGNAL(disconnected(NetworkId)), this, SLOT(destroyNetsplits()));
46 IrcServerHandler::~IrcServerHandler() {
50 /*! Handle a raw message string sent by the server. We try to find a suitable handler, otherwise we call a default handler. */
51 void IrcServerHandler::handleServerMsg(QByteArray msg) {
53 qWarning() << "Received empty string from server!";
57 // Now we split the raw message into its various parts...
62 // First, check for a trailing parameter introduced by " :", since this might screw up splitting the msg
63 // NOTE: This assumes that this is true in raw encoding, but well, hopefully there are no servers running in japanese on protocol level...
64 int idx = msg.indexOf(" :");
66 if(msg.length() > idx + 2)
67 trailing = msg.mid(idx + 2);
70 // OK, now it is safe to split...
71 QList<QByteArray> params = msg.split(' ');
73 // This could still contain empty elements due to (faulty?) ircds sending multiple spaces in a row
74 // Also, QByteArray is not nearly as convenient to work with as QString for such things :)
75 QList<QByteArray>::iterator iter = params.begin();
76 while(iter != params.end()) {
78 iter = params.erase(iter);
83 if(!trailing.isEmpty()) params << trailing;
84 if(params.count() < 1) {
85 qWarning() << "Received invalid string from server!";
89 QString foo = serverDecode(params.takeFirst());
91 // with SASL, the command is 'AUTHENTICATE +' and we should check for this here.
92 /* obsolete because of events
93 if(foo == QString("AUTHENTICATE +")) {
98 // a colon as the first chars indicates the existence of a prefix
102 if(params.count() < 1) {
103 qWarning() << "Received invalid string from server!";
106 foo = serverDecode(params.takeFirst());
109 // next string without a whitespace is the command
110 cmd = foo.trimmed().toUpper();
112 // numeric replies have the target as first param (RFC 2812 - 2.4). this is usually our own nick. Remove this!
113 uint num = cmd.toUInt();
115 if(params.count() == 0) {
116 qWarning() << "Message received from server violates RFC and is ignored!" << msg;
119 _target = serverDecode(params.takeFirst());
124 // note that the IRC server is still alive
125 network()->resetPingTimeout();
127 // Now we try to find a handler for this message. BTW, I do love the Trolltech guys ;-)
128 handle(cmd, Q_ARG(QString, prefix), Q_ARG(QList<QByteArray>, params));
132 void IrcServerHandler::defaultHandler(QString cmd, const QString &prefix, const QList<QByteArray> &rawparams) {
133 // many commands are handled by the event system now
139 //******************************/
140 // IRC SERVER HANDLER
141 //******************************/
143 void IrcServerHandler::handleJoin(const QString &prefix, const QList<QByteArray> ¶ms) {
144 if(!checkParamCount("IrcServerHandler::handleJoin()", params, 1))
147 QString channel = serverDecode(params[0]);
148 IrcUser *ircuser = network()->updateNickFromMask(prefix);
150 bool handledByNetsplit = false;
151 if(!_netsplits.empty()) {
152 foreach(Netsplit* n, _netsplits) {
153 handledByNetsplit = n->userJoined(prefix, channel);
154 if(handledByNetsplit)
160 if(!handledByNetsplit) {
161 emit displayMsg(Message::Join, BufferInfo::ChannelBuffer, channel, channel, prefix);
162 ircuser->joinChannel(channel);
164 //qDebug() << "IrcServerHandler::handleJoin()" << prefix << params;
166 if(network()->isMe(ircuser)) {
167 network()->setChannelJoined(channel);
168 putCmd("MODE", params[0]); // we want to know the modes of the channel we just joined, so we ask politely
172 void IrcServerHandler::handleMode(const QString &prefix, const QList<QByteArray> ¶ms) {
173 if(!checkParamCount("IrcServerHandler::handleMode()", params, 2))
176 if(network()->isChannelName(serverDecode(params[0]))) {
178 emit displayMsg(Message::Mode, BufferInfo::ChannelBuffer, serverDecode(params[0]), serverDecode(params).join(" "), prefix);
180 IrcChannel *channel = network()->ircChannel(params[0]);
182 // we received mode information for a channel we're not in. that means probably we've just been kicked out or something like that
183 // anyways: we don't have a place to store the data --> discard the info.
187 QString modes = params[1];
190 for(int c = 0; c < modes.length(); c++) {
191 if(modes[c] == '+') {
195 if(modes[c] == '-') {
200 if(network()->prefixModes().contains(modes[c])) {
201 // user channel modes (op, voice, etc...)
202 if(paramOffset < params.count()) {
203 IrcUser *ircUser = network()->ircUser(params[paramOffset]);
205 qWarning() << Q_FUNC_INFO << "Unknown IrcUser:" << params[paramOffset];
208 bool handledByNetsplit = false;
209 if(!_netsplits.empty()) {
210 foreach(Netsplit* n, _netsplits) {
211 handledByNetsplit = n->userAlreadyJoined(ircUser->hostmask(), channel->name());
212 if(handledByNetsplit) {
213 n->addMode(ircUser->hostmask(), channel->name(), QString(modes[c]));
218 if(!handledByNetsplit)
219 channel->addUserMode(ircUser, QString(modes[c]));
222 channel->removeUserMode(ircUser, QString(modes[c]));
225 qWarning() << "Received MODE with too few parameters:" << serverDecode(params);
229 // regular channel modes
231 Network::ChannelModeType modeType = network()->channelModeType(modes[c]);
232 if(modeType == Network::A_CHANMODE || modeType == Network::B_CHANMODE || (modeType == Network::C_CHANMODE && add)) {
233 if(paramOffset < params.count()) {
234 value = params[paramOffset];
236 qWarning() << "Received MODE with too few parameters:" << serverDecode(params);
242 channel->addChannelMode(modes[c], value);
244 channel->removeChannelMode(modes[c], value);
250 IrcUser *ircUser = network()->newIrcUser(params[0]);
251 QString modeString(serverDecode(params[1]));
255 for(int c = 0; c < modeString.count(); c++) {
256 if(modeString[c] == '+') {
260 if(modeString[c] == '-') {
265 addModes += modeString[c];
267 removeModes += modeString[c];
269 if(!addModes.isEmpty())
270 ircUser->addUserModes(addModes);
271 if(!removeModes.isEmpty())
272 ircUser->removeUserModes(removeModes);
274 if(network()->isMe(ircUser)) {
275 network()->updatePersistentModes(addModes, removeModes);
279 emit displayMsg(Message::Mode, BufferInfo::StatusBuffer, "", serverDecode(params).join(" "), prefix);
283 void IrcServerHandler::handleNotice(const QString &prefix, const QList<QByteArray> ¶ms) {
284 if(!checkParamCount("IrcServerHandler::handleNotice()", params, 2))
288 QStringList targets = serverDecode(params[0]).split(',', QString::SkipEmptyParts);
289 QStringList::const_iterator targetIter;
290 for(targetIter = targets.constBegin(); targetIter != targets.constEnd(); targetIter++) {
291 QString target = *targetIter;
293 // special treatment for welcome messages like:
294 // :ChanServ!ChanServ@services. NOTICE egst :[#apache] Welcome, this is #apache. Please read the in-channel topic message. This channel is being logged by IRSeekBot. If you have any question please see http://blog.freenode.net/?p=68
295 if(!network()->isChannelName(target)) {
296 QString msg = serverDecode(params[1]);
297 QRegExp welcomeRegExp("^\\[([^\\]]+)\\] ");
298 if(welcomeRegExp.indexIn(msg) != -1) {
299 QString channelname = welcomeRegExp.cap(1);
300 msg = msg.mid(welcomeRegExp.matchedLength());
301 CoreIrcChannel *chan = static_cast<CoreIrcChannel *>(network()->ircChannel(channelname)); // we only have CoreIrcChannels in the core, so this cast is safe
302 if(chan && !chan->receivedWelcomeMsg()) {
303 chan->setReceivedWelcomeMsg();
304 emit displayMsg(Message::Notice, BufferInfo::ChannelBuffer, channelname, msg, prefix);
310 if(prefix.isEmpty() || target == "AUTH") {
313 if(!target.isEmpty() && network()->prefixes().contains(target[0]))
314 target = target.mid(1);
315 if(!network()->isChannelName(target))
316 target = nickFromMask(prefix);
319 network()->ctcpHandler()->parse(Message::Notice, prefix, target, params[1]);
324 void IrcServerHandler::handlePing(const QString &prefix, const QList<QByteArray> ¶ms) {
326 putCmd("PONG", params);
329 void IrcServerHandler::handlePrivmsg(const QString &prefix, const QList<QByteArray> ¶ms) {
330 if(!checkParamCount("IrcServerHandler::handlePrivmsg()", params, 1))
333 IrcUser *ircuser = network()->updateNickFromMask(prefix);
335 qWarning() << "IrcServerHandler::handlePrivmsg(): Unknown IrcUser!";
339 if(params.isEmpty()) {
340 qWarning() << "IrcServerHandler::handlePrivmsg(): received PRIVMSG without target or message from:" << prefix;
344 QString senderNick = nickFromMask(prefix);
346 QByteArray msg = params.count() < 2
350 QStringList targets = serverDecode(params[0]).split(',', QString::SkipEmptyParts);
351 QStringList::const_iterator targetIter;
352 for(targetIter = targets.constBegin(); targetIter != targets.constEnd(); targetIter++) {
353 const QString &target = network()->isChannelName(*targetIter)
358 msg = decrypt(target, msg);
360 // it's possible to pack multiple privmsgs into one param using ctcp
361 // - > we let the ctcpHandler do the work
362 network()->ctcpHandler()->parse(Message::Plain, prefix, target, msg);
366 void IrcServerHandler::handleQuit(const QString &prefix, const QList<QByteArray> ¶ms) {
367 IrcUser *ircuser = network()->updateNickFromMask(prefix);
371 if(params.count() > 0)
372 msg = userDecode(ircuser->nick(), params[0]);
375 if(Netsplit::isNetsplit(msg)) {
377 if(!_netsplits.contains(msg)) {
379 connect(n, SIGNAL(finished()), this, SLOT(handleNetsplitFinished()));
380 connect(n, SIGNAL(netsplitJoin(const QString&, const QStringList&, const QStringList&, const QString&)),
381 this, SLOT(handleNetsplitJoin(const QString&, const QStringList&, const QStringList&, const QString&)));
382 connect(n, SIGNAL(netsplitQuit(const QString&, const QStringList&, const QString&)),
383 this, SLOT(handleNetsplitQuit(const QString&, const QStringList&, const QString&)));
384 connect(n, SIGNAL(earlyJoin(const QString&, const QStringList&, const QStringList&)),
385 this, SLOT(handleEarlyNetsplitJoin(const QString&, const QStringList&, const QStringList&)));
386 _netsplits.insert(msg, n);
391 // add this user to the netsplit
392 n->userQuit(prefix, ircuser->channels(),msg);
396 foreach(QString channel, ircuser->channels())
397 emit displayMsg(Message::Quit, BufferInfo::ChannelBuffer, channel, msg, prefix);
402 /* RPL_CHANNELMODEIS - "<channel> <mode> <mode params>" */
403 void IrcServerHandler::handle324(const QString &prefix, const QList<QByteArray> ¶ms) {
405 handleMode(prefix, params);
408 /* RPL_INVITING - "<nick> <channel>*/
409 void IrcServerHandler::handle341(const QString &prefix, const QList<QByteArray> ¶ms) {
411 if(!checkParamCount("IrcServerHandler::handle341()", params, 2))
414 QString nick = serverDecode(params[0]);
416 IrcChannel *channel = network()->ircChannel(serverDecode(params[1]));
418 qWarning() << "IrcServerHandler::handle341(): unknown channel:" << params[1];
422 emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel->name(), tr("%1 has been invited to %2").arg(nick).arg(channel->name()));
425 /* RPL_WHOREPLY: "<channel> <user> <host> <server> <nick>
426 ( "H" / "G" > ["*"] [ ( "@" / "+" ) ] :<hopcount> <real name>" */
427 void IrcServerHandler::handle352(const QString &prefix, const QList<QByteArray> ¶ms) {
429 if(!checkParamCount("IrcServerHandler::handle352()", params, 6))
432 QString channel = serverDecode(params[0]);
433 IrcUser *ircuser = network()->ircUser(serverDecode(params[4]));
435 ircuser->setUser(serverDecode(params[1]));
436 ircuser->setHost(serverDecode(params[2]));
438 bool away = serverDecode(params[5]).startsWith("G") ? true : false;
439 ircuser->setAway(away);
440 ircuser->setServer(serverDecode(params[3]));
441 ircuser->setRealName(serverDecode(params.last()).section(" ", 1));
444 if(!network()->isAutoWhoInProgress(channel)) {
445 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Who] %1").arg(serverDecode(params).join(" ")));
450 void IrcServerHandler::handle353(const QString &prefix, const QList<QByteArray> ¶ms) {
452 if(!checkParamCount("IrcServerHandler::handle353()", params, 3))
455 // param[0] is either "=", "*" or "@" indicating a public, private or secret channel
456 // we don't use this information at the time beeing
457 QString channelname = serverDecode(params[1]);
459 IrcChannel *channel = network()->ircChannel(channelname);
461 qWarning() << "IrcServerHandler::handle353(): received unknown target channel:" << channelname;
468 foreach(QString nick, serverDecode(params[2]).split(' ')) {
469 QString mode = QString();
471 if(network()->prefixes().contains(nick[0])) {
472 mode = network()->prefixToMode(nick[0]);
480 channel->joinIrcUsers(nicks, modes);
483 /* RPL_ENDOFWHOWAS - "<nick> :End of WHOWAS" */
484 void IrcServerHandler::handle369(const QString &prefix, const QList<QByteArray> ¶ms) {
486 emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whowas] %1").arg(serverDecode(params).join(" ")));
489 /* ERR_ERRONEUSNICKNAME */
490 void IrcServerHandler::handle432(const QString &prefix, const QList<QByteArray> ¶ms) {
494 if(params.size() < 2) {
495 // handle unreal-ircd bug, where unreal ircd doesnt supply a TARGET in ERR_ERRONEUSNICKNAME during registration phase:
497 // :irc.scortum.moep.net 432 @@@ :Erroneous Nickname: Illegal characters
498 // correct server reply:
499 // :irc.scortum.moep.net 432 * @@@ :Erroneous Nickname: Illegal characters
504 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Nick %1 contains illegal characters").arg(errnick));
505 tryNextNick(errnick, true /* erroneus */);
508 /* ERR_NICKNAMEINUSE */
509 void IrcServerHandler::handle433(const QString &prefix, const QList<QByteArray> ¶ms) {
511 if(!checkParamCount("IrcServerHandler::handle433()", params, 1))
514 QString errnick = serverDecode(params[0]);
515 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Nick already in use: %1").arg(errnick));
517 // if there is a problem while connecting to the server -> we handle it
518 // but only if our connection has not been finished yet...
519 if(!network()->currentServer().isEmpty())
522 tryNextNick(errnick);
525 /* ERR_UNAVAILRESOURCE */
526 void IrcServerHandler::handle437(const QString &prefix, const QList<QByteArray> ¶ms) {
528 if(!checkParamCount("IrcServerHandler::handle437()", params, 1))
531 QString errnick = serverDecode(params[0]);
532 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Nick/channel is temporarily unavailable: %1").arg(errnick));
534 // if there is a problem while connecting to the server -> we handle it
535 // but only if our connection has not been finished yet...
536 if(!network()->currentServer().isEmpty())
539 if(!network()->isChannelName(errnick))
540 tryNextNick(errnick);
543 /* Handle signals from Netsplit objects */
545 void IrcServerHandler::handleNetsplitJoin(const QString &channel, const QStringList &users, const QStringList &modes, const QString& quitMessage)
547 IrcChannel *ircChannel = network()->ircChannel(channel);
551 QList<IrcUser *> ircUsers;
552 QStringList newModes = modes;
553 QStringList newUsers = users;
555 foreach(QString user, users) {
556 IrcUser *iu = network()->ircUser(nickFromMask(user));
559 else { // the user already quit
560 int idx = users.indexOf(user);
561 newUsers.removeAt(idx);
562 newModes.removeAt(idx);
566 QString msg = newUsers.join("#:#").append("#:#").append(quitMessage);
567 emit displayMsg(Message::NetsplitJoin, BufferInfo::ChannelBuffer, channel, msg);
568 ircChannel->joinIrcUsers(ircUsers, newModes);
571 void IrcServerHandler::handleNetsplitQuit(const QString &channel, const QStringList &users, const QString& quitMessage)
573 QString msg = users.join("#:#").append("#:#").append(quitMessage);
574 emit displayMsg(Message::NetsplitQuit, BufferInfo::ChannelBuffer, channel, msg);
575 foreach(QString user, users) {
576 IrcUser *iu = network()->ircUser(nickFromMask(user));
582 void IrcServerHandler::handleEarlyNetsplitJoin(const QString &channel, const QStringList &users, const QStringList &modes) {
583 IrcChannel *ircChannel = network()->ircChannel(channel);
585 qDebug() << "handleEarlyNetsplitJoin(): channel " << channel << " invalid";
588 QList<IrcUser *> ircUsers;
589 QStringList newModes = modes;
591 foreach(QString user, users) {
592 IrcUser *iu = network()->updateNickFromMask(user);
595 emit displayMsg(Message::Join, BufferInfo::ChannelBuffer, channel, channel, user);
598 newModes.removeAt(users.indexOf(user));
601 ircChannel->joinIrcUsers(ircUsers, newModes);
603 void IrcServerHandler::handleNetsplitFinished()
605 Netsplit* n = qobject_cast<Netsplit*>(sender());
606 _netsplits.remove(_netsplits.key(n));
612 // FIXME networkConnection()->setChannelKey("") for all ERR replies indicating that a JOIN went wrong
613 // mostly, these are codes in the 47x range
617 void IrcServerHandler::tryNextNick(const QString &errnick, bool erroneus) {
618 QStringList desiredNicks = coreSession()->identity(network()->identity())->nicks();
619 int nextNickIdx = desiredNicks.indexOf(errnick) + 1;
621 if(nextNickIdx > 0 && desiredNicks.size() > nextNickIdx) {
622 nextNick = desiredNicks[nextNickIdx];
625 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("No free and valid nicks in nicklist found. use: /nick <othernick> to continue"));
628 nextNick = errnick + "_";
631 putCmd("NICK", serverEncode(nextNick));
634 bool IrcServerHandler::checkParamCount(const QString &methodName, const QList<QByteArray> ¶ms, int minParams) {
635 if(params.count() < minParams) {
636 qWarning() << qPrintable(methodName) << "requires" << minParams << "parameters but received only" << params.count() << serverDecode(params);
643 void IrcServerHandler::destroyNetsplits() {
644 qDeleteAll(_netsplits);
649 QByteArray IrcServerHandler::decrypt(const QString &bufferName, const QByteArray &message_, bool isTopic) {
650 if(message_.isEmpty())
653 Cipher *cipher = network()->cipher(bufferName);
657 QByteArray message = message_;
658 message = isTopic? cipher->decryptTopic(message) : cipher->decrypt(message);