src/core/ircserverhandler.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 by the Quassel Project                          *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   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.                                           *
   9  *                                                                         *
  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.                          *
  14  *                                                                         *
  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"
  21
  22 #include "util.h"
  23
  24 #include "coresession.h"
  25 #include "coreirclisthelper.h"
  26 #include "coreidentity.h"
  27 #include "ctcphandler.h"
  28
  29 #include "ircuser.h"
  30 #include "coreircchannel.h"
  31 #include "logger.h"
  32
  33 #include <QDebug>
  34
  35 IrcServerHandler::IrcServerHandler(CoreNetwork *parent)
  36   : BasicHandler(parent),
  37     _whois(false)
  38 {
  39 }
  40
  41 IrcServerHandler::~IrcServerHandler() {
  42 }
  43
  44 /*! Handle a raw message string sent by the server. We try to find a suitable handler, otherwise we call a default handler. */
  45 void IrcServerHandler::handleServerMsg(QByteArray msg) {
  46   if(msg.isEmpty()) {
  47     qWarning() << "Received empty string from server!";
  48     return;
  49   }
  50
  51   // Now we split the raw message into its various parts...
  52   QString prefix = "";
  53   QByteArray trailing;
  54   QString cmd;
  55
  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(" :");
  59   if(idx >= 0) {
  60     if(msg.length() > idx + 2)
  61       trailing = msg.mid(idx + 2);
  62     msg = msg.left(idx);
  63   }
  64   // OK, now it is safe to split...
  65   QList<QByteArray> params = msg.split(' ');
  66
  67   // This could still contain empty elements due to (faulty?) ircds sending multiple spaces in a row
  68   // Also, QByteArray is not nearly as convenient to work with as QString for such things :)
  69   QList<QByteArray>::iterator iter = params.begin();
  70   while(iter != params.end()) {
  71     if(iter->isEmpty())
  72       iter = params.erase(iter);
  73     else
  74       ++iter;
  75   }
  76
  77   if(!trailing.isEmpty()) params << trailing;
  78   if(params.count() < 1) {
  79     qWarning() << "Received invalid string from server!";
  80     return;
  81   }
  82
  83   QString foo = serverDecode(params.takeFirst());
  84
  85   // a colon as the first chars indicates the existence of a prefix
  86   if(foo[0] == ':') {
  87     foo.remove(0, 1);
  88     prefix = foo;
  89     if(params.count() < 1) {
  90       qWarning() << "Received invalid string from server!";
  91       return;
  92     }
  93     foo = serverDecode(params.takeFirst());
  94   }
  95
  96   // next string without a whitespace is the command
  97   cmd = foo.trimmed().toUpper();
  98
  99   // numeric replies have the target as first param (RFC 2812 - 2.4). this is usually our own nick. Remove this!
 100   uint num = cmd.toUInt();
 101   if(num > 0) {
 102     if(params.count() == 0) {
 103       qWarning() << "Message received from server violates RFC and is ignored!" << msg;
 104       return;
 105     }
 106     _target = serverDecode(params.takeFirst());
 107   } else {
 108     _target = QString();
 109   }
 110
 111   // note that the IRC server is still alive
 112   network()->resetPingTimeout();
 113
 114   // Now we try to find a handler for this message. BTW, I do love the Trolltech guys ;-)
 115   handle(cmd, Q_ARG(QString, prefix), Q_ARG(QList<QByteArray>, params));
 116 }
 117
 118
 119 void IrcServerHandler::defaultHandler(QString cmd, const QString &prefix, const QList<QByteArray> &rawparams) {
 120   // we assume that all this happens in server encoding
 121   QStringList params = serverDecode(rawparams);
 122   uint num = cmd.toUInt();
 123   if(num) {
 124     // A lot of server messages don't really need their own handler because they don't do much.
 125     // Catch and handle these here.
 126     switch(num) {
 127       // Welcome, status, info messages. Just display these.
 128       case 2: case 3: case 4: case 5: case 251: case 252: case 253: case 254: case 255: case 372: case 375:
 129         emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", params.join(" "), prefix);
 130         break;
 131       // Server error messages without param, just display them
 132       case 409: case 411: case 412: case 422: case 424: case 445: case 446: case 451: case 462:
 133       case 463: case 464: case 465: case 466: case 472: case 481: case 483: case 485: case 491: case 501: case 502:
 134       case 431: // ERR_NONICKNAMEGIVEN
 135         emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", params.join(" "), prefix);
 136         break;
 137       // Server error messages, display them in red. First param will be appended.
 138       case 401: {
 139         QString target = params.takeFirst();
 140         emit displayMsg(Message::Error, target, params.join(" ") + " " + target, prefix, Message::Redirected);
 141         break;
 142       }
 143       case 402: case 403: case 404: case 406: case 408: case 415: case 421: case 442: {
 144         QString channelName = params.takeFirst();
 145         emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", params.join(" ") + " " + channelName, prefix);
 146         break;
 147       }
 148       // Server error messages which will be displayed with a colon between the first param and the rest
 149       case 413: case 414: case 423: case 441: case 444: case 461:  // FIXME see below for the 47x codes
 150       case 467: case 471: case 473: case 474: case 475: case 476: case 477: case 478: case 482:
 151       case 436: // ERR_NICKCOLLISION
 152       {
 153         QString p = params.takeFirst();
 154         emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", p + ": " + params.join(" "));
 155         break;
 156       }
 157       // Ignore these commands.
 158       case 321: case 366: case 376:
 159         break;
 160
 161       // Everything else will be marked in red, so we can add them somewhere.
 162       default:
 163         if(_whois) {
 164           // many nets define their own WHOIS fields. we fetch those not in need of special attention here:
 165           emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", "[Whois] " + params.join(" "), prefix);
 166         } else {
 167           if(coreSession()->ircListHelper()->requestInProgress(network()->networkId()))
 168             coreSession()->ircListHelper()->reportError(params.join(" "));
 169           else
 170             emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", cmd + " " + params.join(" "), prefix);
 171         }
 172     }
 173     //qDebug() << prefix <<":"<<cmd<<params;
 174   } else {
 175     emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Unknown: ") + cmd + " " + params.join(" "), prefix);
 176     //qDebug() << prefix <<":"<<cmd<<params;
 177   }
 178 }
 179
 180 //******************************/
 181 // IRC SERVER HANDLER
 182 //******************************/
 183 void IrcServerHandler::handleJoin(const QString &prefix, const QList<QByteArray> &params) {
 184   if(!checkParamCount("IrcServerHandler::handleJoin()", params, 1))
 185     return;
 186
 187   QString channel = serverDecode(params[0]);
 188   IrcUser *ircuser = network()->updateNickFromMask(prefix);
 189   emit displayMsg(Message::Join, BufferInfo::ChannelBuffer, channel, channel, prefix);
 190   //qDebug() << "IrcServerHandler::handleJoin()" << prefix << params;
 191   ircuser->joinChannel(channel);
 192   if(network()->isMe(ircuser)) {
 193     network()->setChannelJoined(channel);
 194     putCmd("MODE", params[0]); // we want to know the modes of the channel we just joined, so we ask politely
 195   }
 196 }
 197
 198 void IrcServerHandler::handleKick(const QString &prefix, const QList<QByteArray> &params) {
 199   if(!checkParamCount("IrcServerHandler::handleKick()", params, 2))
 200     return;
 201
 202   network()->updateNickFromMask(prefix);
 203   IrcUser *victim = network()->ircUser(params[1]);
 204   if(!victim)
 205     return;
 206
 207   QString channel = serverDecode(params[0]);
 208   victim->partChannel(channel);
 209
 210   QString msg;
 211   if(params.count() > 2) // someone got a reason!
 212     msg = QString("%1 %2").arg(victim->nick()).arg(channelDecode(channel, params[2]));
 213   else
 214     msg = victim->nick();
 215
 216   emit displayMsg(Message::Kick, BufferInfo::ChannelBuffer, channel, msg, prefix);
 217   //if(network()->isMe(victim)) network()->setKickedFromChannel(channel);
 218 }
 219
 220 void IrcServerHandler::handleMode(const QString &prefix, const QList<QByteArray> &params) {
 221   if(!checkParamCount("IrcServerHandler::handleMode()", params, 2))
 222     return;
 223
 224   if(network()->isChannelName(serverDecode(params[0]))) {
 225     // Channel Modes
 226     emit displayMsg(Message::Mode, BufferInfo::ChannelBuffer, serverDecode(params[0]), serverDecode(params).join(" "), prefix);
 227
 228     IrcChannel *channel = network()->ircChannel(params[0]);
 229     if(!channel) {
 230       // we received mode information for a channel we're not in. that means probably we've just been kicked out or something like that
 231       // anyways: we don't have a place to store the data --> discard the info.
 232       return;
 233     }
 234
 235     QString modes = params[1];
 236     bool add = true;
 237     int paramOffset = 2;
 238     for(int c = 0; c < modes.length(); c++) {
 239       if(modes[c] == '+') {
 240         add = true;
 241         continue;
 242       }
 243       if(modes[c] == '-') {
 244         add = false;
 245         continue;
 246       }
 247
 248       if(network()->prefixModes().contains(modes[c])) {
 249         // user channel modes (op, voice, etc...)
 250         if(paramOffset < params.count()) {
 251           IrcUser *ircUser = network()->ircUser(params[paramOffset]);
 252           if(add)
 253             channel->addUserMode(ircUser, QString(modes[c]));
 254           else
 255             channel->removeUserMode(ircUser, QString(modes[c]));
 256         } else {
 257           qWarning() << "Received MODE with too few parameters:" << serverDecode(params);
 258         }
 259         paramOffset++;
 260       } else {
 261         // regular channel modes
 262         QString value;
 263         Network::ChannelModeType modeType = network()->channelModeType(modes[c]);
 264         if(modeType == Network::A_CHANMODE || modeType == Network::B_CHANMODE || (modeType == Network::C_CHANMODE && add)) {
 265           if(paramOffset < params.count()) {
 266             value = params[paramOffset];
 267           } else {
 268             qWarning() << "Received MODE with too few parameters:" << serverDecode(params);
 269           }
 270           paramOffset++;
 271         }
 272
 273         if(add)
 274           channel->addChannelMode(modes[c], value);
 275         else
 276           channel->removeChannelMode(modes[c], value);
 277       }
 278     }
 279
 280   } else {
 281     // pure User Modes
 282     IrcUser *ircUser = network()->newIrcUser(params[0]);
 283     QString modeString(serverDecode(params[1]));
 284     QString addModes;
 285     QString removeModes;
 286     bool add = false;
 287     for(int c = 0; c < modeString.count(); c++) {
 288       if(modeString[c] == '+') {
 289         add = true;
 290         continue;
 291       }
 292       if(modeString[c] == '-') {
 293         add = false;
 294         continue;
 295       }
 296       if(add)
 297         addModes += modeString[c];
 298       else
 299         removeModes += modeString[c];
 300     }
 301     if(!addModes.isEmpty())
 302       ircUser->addUserModes(addModes);
 303     if(!removeModes.isEmpty())
 304       ircUser->removeUserModes(removeModes);
 305
 306     // FIXME: redirect
 307     emit displayMsg(Message::Mode, BufferInfo::StatusBuffer, "", serverDecode(params).join(" "), prefix);
 308   }
 309 }
 310
 311 void IrcServerHandler::handleNick(const QString &prefix, const QList<QByteArray> &params) {
 312   if(!checkParamCount("IrcServerHandler::handleNick()", params, 1))
 313     return;
 314
 315   IrcUser *ircuser = network()->updateNickFromMask(prefix);
 316   if(!ircuser) {
 317     qWarning() << "IrcServerHandler::handleNick(): Unknown IrcUser!";
 318     return;
 319   }
 320   QString newnick = serverDecode(params[0]);
 321   QString oldnick = ircuser->nick();
 322
 323   QString sender = network()->isMyNick(oldnick)
 324     ? newnick
 325     : prefix;
 326
 327
 328   // the order is cruicial
 329   // otherwise the client would rename the buffer, see that the assigned ircuser doesn't match anymore
 330   // and remove the ircuser from the querybuffer leading to a wrong on/offline state
 331   ircuser->setNick(newnick);
 332   coreSession()->renameBuffer(network()->networkId(), newnick, oldnick);
 333
 334   foreach(QString channel, ircuser->channels())
 335     emit displayMsg(Message::Nick, BufferInfo::ChannelBuffer, channel, newnick, sender);
 336 }
 337
 338 void IrcServerHandler::handleNotice(const QString &prefix, const QList<QByteArray> &params) {
 339   if(!checkParamCount("IrcServerHandler::handleNotice()", params, 2))
 340     return;
 341
 342
 343   QStringList targets = serverDecode(params[0]).split(',', QString::SkipEmptyParts);
 344   QStringList::const_iterator targetIter;
 345   for(targetIter = targets.constBegin(); targetIter != targets.constEnd(); targetIter++) {
 346     QString target = *targetIter;
 347
 348     // special treatment for welcome messages like:
 349     // :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
 350     if(!network()->isChannelName(target)) {
 351       QString msg = serverDecode(params[1]);
 352       QRegExp welcomeRegExp("^\\[([^\\]]+)\\] ");
 353       if(welcomeRegExp.indexIn(msg) != -1) {
 354         QString channelname = welcomeRegExp.cap(1);
 355         msg = msg.mid(welcomeRegExp.matchedLength());
 356         CoreIrcChannel *chan = static_cast<CoreIrcChannel *>(network()->ircChannel(channelname)); // we only have CoreIrcChannels in the core, so this cast is safe
 357         if(chan && !chan->receivedWelcomeMsg()) {
 358           chan->setReceivedWelcomeMsg();
 359           emit displayMsg(Message::Notice, BufferInfo::ChannelBuffer, channelname, msg, prefix);
 360           continue;
 361         }
 362       }
 363     }
 364
 365     if(prefix.isEmpty() || target == "AUTH") {
 366       target = "";
 367     } else {
 368       if(!target.isEmpty() && network()->prefixes().contains(target[0]))
 369         target = target.mid(1);
 370       if(!network()->isChannelName(target))
 371         target = nickFromMask(prefix);
 372     }
 373
 374     network()->ctcpHandler()->parse(Message::Notice, prefix, target, params[1]);
 375   }
 376
 377 }
 378
 379 void IrcServerHandler::handlePart(const QString &prefix, const QList<QByteArray> &params) {
 380   if(!checkParamCount("IrcServerHandler::handlePart()", params, 1))
 381     return;
 382
 383   IrcUser *ircuser = network()->updateNickFromMask(prefix);
 384   QString channel = serverDecode(params[0]);
 385   if(!ircuser) {
 386     qWarning() << "IrcServerHandler::handlePart(): Unknown IrcUser!";
 387     return;
 388   }
 389
 390   ircuser->partChannel(channel);
 391
 392   QString msg;
 393   if(params.count() > 1)
 394     msg = userDecode(ircuser->nick(), params[1]);
 395
 396   emit displayMsg(Message::Part, BufferInfo::ChannelBuffer, channel, msg, prefix);
 397   if(network()->isMe(ircuser)) network()->setChannelParted(channel);
 398 }
 399
 400 void IrcServerHandler::handlePing(const QString &prefix, const QList<QByteArray> &params) {
 401   Q_UNUSED(prefix);
 402   putCmd("PONG", params);
 403 }
 404
 405 void IrcServerHandler::handlePong(const QString &prefix, const QList<QByteArray> &params) {
 406   Q_UNUSED(prefix);
 407   // the server is supposed to send back what we passed as param. and we send a timestamp
 408   // but using quote and whatnought one can send arbitrary pings, so we have to do some sanity checks
 409   if(params.count() < 2)
 410     return;
 411
 412   QString timestamp = serverDecode(params[1]);
 413   QTime sendTime = QTime::fromString(timestamp, "hh:mm:ss.zzz");
 414   if(!sendTime.isValid()) {
 415     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", "PONG " + serverDecode(params).join(" "), prefix);
 416     return;
 417   }
 418
 419   network()->setLatency(sendTime.msecsTo(QTime::currentTime()) / 2);
 420 }
 421
 422 void IrcServerHandler::handlePrivmsg(const QString &prefix, const QList<QByteArray> &params) {
 423   if(!checkParamCount("IrcServerHandler::handlePrivmsg()", params, 1))
 424     return;
 425
 426   IrcUser *ircuser = network()->updateNickFromMask(prefix);
 427   if(!ircuser) {
 428     qWarning() << "IrcServerHandler::handlePrivmsg(): Unknown IrcUser!";
 429     return;
 430   }
 431
 432   if(params.isEmpty()) {
 433     qWarning() << "IrcServerHandler::handlePrivmsg(): received PRIVMSG without target or message from:" << prefix;
 434     return;
 435   }
 436
 437   QString senderNick = nickFromMask(prefix);
 438
 439   QByteArray msg = params.count() < 2
 440     ? QByteArray("")
 441     : params[1];
 442
 443   QStringList targets = serverDecode(params[0]).split(',', QString::SkipEmptyParts);
 444   QStringList::const_iterator targetIter;
 445   for(targetIter = targets.constBegin(); targetIter != targets.constEnd(); targetIter++) {
 446     const QString &target = network()->isChannelName(*targetIter)
 447       ? *targetIter
 448       : senderNick;
 449
 450     // it's possible to pack multiple privmsgs into one param using ctcp
 451     // - > we let the ctcpHandler do the work
 452     network()->ctcpHandler()->parse(Message::Plain, prefix, target, msg);
 453   }
 454 }
 455
 456 void IrcServerHandler::handleQuit(const QString &prefix, const QList<QByteArray> &params) {
 457   IrcUser *ircuser = network()->updateNickFromMask(prefix);
 458   if(!ircuser) return;
 459
 460   QString msg;
 461   if(params.count() > 0)
 462     msg = userDecode(ircuser->nick(), params[0]);
 463
 464   foreach(QString channel, ircuser->channels())
 465     emit displayMsg(Message::Quit, BufferInfo::ChannelBuffer, channel, msg, prefix);
 466
 467   ircuser->quit();
 468 }
 469
 470 void IrcServerHandler::handleTopic(const QString &prefix, const QList<QByteArray> &params) {
 471   if(!checkParamCount("IrcServerHandler::handleTopic()", params, 1))
 472     return;
 473
 474   IrcUser *ircuser = network()->updateNickFromMask(prefix);
 475   if(!ircuser)
 476     return;
 477
 478   IrcChannel *channel = network()->ircChannel(serverDecode(params[0]));
 479   if(!channel)
 480     return;
 481
 482   QString topic;
 483   if(params.count() > 1)
 484     topic = channelDecode(channel->name(), params[1]);
 485
 486   channel->setTopic(topic);
 487
 488   emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel->name(), tr("%1 has changed topic for %2 to: \"%3\"").arg(ircuser->nick()).arg(channel->name()).arg(topic));
 489 }
 490
 491 /* RPL_WELCOME */
 492 void IrcServerHandler::handle001(const QString &prefix, const QList<QByteArray> &params) {
 493   network()->setCurrentServer(prefix);
 494
 495   if(params.isEmpty()) {
 496     emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("%1 didn't supply a valid welcome message... expect some serious issues..."));
 497   }
 498   // there should be only one param: "Welcome to the Internet Relay Network <nick>!<user>@<host>"
 499   QString param = serverDecode(params[0]);
 500   QString myhostmask = param.section(' ', -1, -1);
 501
 502   network()->setMyNick(nickFromMask(myhostmask));
 503
 504   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", param, prefix);
 505 }
 506
 507 /* RPL_ISUPPORT */
 508 // TODO Complete 005 handling, also use sensible defaults for non-sent stuff
 509 void IrcServerHandler::handle005(const QString &prefix, const QList<QByteArray> &params) {
 510   Q_UNUSED(prefix);
 511   const int numParams = params.size();
 512   if(numParams == 0) {
 513     emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Received RPL_ISUPPORT (005) without parameters!"), prefix);
 514     return;
 515   }
 516
 517   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", serverDecode(params).join(" "), prefix);
 518
 519   QString rpl_isupport_suffix = serverDecode(params.last());
 520   if(!rpl_isupport_suffix.toLower().contains("are supported by this server")) {
 521     emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Received non RFC compliant RPL_ISUPPORT: this can lead to unexpected behavior!"), prefix);
 522   }
 523
 524   QString rawSupport;
 525   QString key, value;
 526   for(int i = 0; i < numParams - 1; i++) {
 527     QString rawSupport = serverDecode(params[i]);
 528     QString key = rawSupport.section("=", 0, 0);
 529     QString value = rawSupport.section("=", 1);
 530     network()->addSupport(key, value);
 531   }
 532 }
 533
 534 /* RPL_UMODEIS - "<user_modes> [<user_mode_params>]" */
 535 void IrcServerHandler::handle221(const QString &prefix, const QList<QByteArray> &params) {
 536   Q_UNUSED(prefix)
 537   //TODO: save information in network object
 538   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("%1").arg(serverDecode(params).join(" ")));
 539 }
 540
 541 /* RPL_STATSCONN - "Highest connection cout: 8000 (7999 clients)" */
 542 void IrcServerHandler::handle250(const QString &prefix, const QList<QByteArray> &params) {
 543   Q_UNUSED(prefix)
 544   //TODO: save information in network object
 545   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("%1").arg(serverDecode(params).join(" ")));
 546 }
 547
 548 /* RPL_LOCALUSERS - "Current local user: 5024  Max: 7999 */
 549 void IrcServerHandler::handle265(const QString &prefix, const QList<QByteArray> &params) {
 550   Q_UNUSED(prefix)
 551   //TODO: save information in network object
 552   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("%1").arg(serverDecode(params).join(" ")));
 553 }
 554
 555 /* RPL_GLOBALUSERS - "Current global users: 46093  Max: 47650" */
 556 void IrcServerHandler::handle266(const QString &prefix, const QList<QByteArray> &params) {
 557   Q_UNUSED(prefix)
 558   //TODO: save information in network object
 559   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("%1").arg(serverDecode(params).join(" ")));
 560 }
 561
 562 /*
 563 WHOIS-Message:
 564    Replies 311 - 313, 317 - 319 are all replies generated in response to a WHOIS message.
 565   and 301 (RPL_AWAY)
 566               "<nick> :<away message>"
 567 WHO-Message:
 568    Replies 352 and 315 paired are used to answer a WHO message.
 569
 570 WHOWAS-Message:
 571    Replies 314 and 369 are responses to a WHOWAS message.
 572
 573 */
 574
 575
 576 /*   RPL_AWAY - "<nick> :<away message>" */
 577 void IrcServerHandler::handle301(const QString &prefix, const QList<QByteArray> &params) {
 578   Q_UNUSED(prefix);
 579   if(!checkParamCount("IrcServerHandler::handle301()", params, 2))
 580     return;
 581
 582
 583   QString nickName = serverDecode(params[0]);
 584   QString awayMessage = userDecode(nickName, params[1]);
 585
 586   IrcUser *ircuser = network()->ircUser(nickName);
 587   if(ircuser) {
 588     ircuser->setAwayMessage(awayMessage);
 589     ircuser->setAway(true);
 590   }
 591
 592   // FIXME: proper redirection needed
 593   if(_whois) {
 594     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is away: \"%2\"").arg(nickName).arg(awayMessage));
 595   } else {
 596     if(ircuser) {
 597       int now = QDateTime::currentDateTime().toTime_t();
 598       int silenceTime = 60;
 599       if(ircuser->lastAwayMessage() + silenceTime < now) {
 600         emit displayMsg(Message::Server, BufferInfo::QueryBuffer, params[0], tr("%1 is away: \"%2\"").arg(nickName).arg(awayMessage));
 601       }
 602       ircuser->setLastAwayMessage(now);
 603     } else {
 604       // probably should not happen
 605       emit displayMsg(Message::Server, BufferInfo::QueryBuffer, params[0], tr("%1 is away: \"%2\"").arg(nickName).arg(awayMessage));
 606     }
 607   }
 608 }
 609
 610 // 305  RPL_UNAWAY
 611 //      ":You are no longer marked as being away"
 612 void IrcServerHandler::handle305(const QString &prefix, const QList<QByteArray> &params) {
 613   Q_UNUSED(prefix);
 614   IrcUser *me = network()->me();
 615   if(me)
 616     me->setAway(false);
 617
 618   if(!network()->autoAwayActive()) {
 619     if(!params.isEmpty())
 620       emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", serverDecode(params[0]));
 621   } else {
 622     network()->setAutoAwayActive(false);
 623   }
 624 }
 625
 626 // 306  RPL_NOWAWAY
 627 //      ":You have been marked as being away"
 628 void IrcServerHandler::handle306(const QString &prefix, const QList<QByteArray> &params) {
 629   Q_UNUSED(prefix);
 630   IrcUser *me = network()->me();
 631   if(me)
 632     me->setAway(true);
 633
 634   if(!params.isEmpty() && !network()->autoAwayActive())
 635     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", serverDecode(params[0]));
 636 }
 637
 638 /* RPL_WHOISSERVICE - "<user> is registered nick" */
 639 void IrcServerHandler::handle307(const QString &prefix, const QList<QByteArray> &params) {
 640   Q_UNUSED(prefix)
 641   if(!checkParamCount("IrcServerHandler::handle307()", params, 1))
 642     return;
 643
 644   QString whoisServiceReply = serverDecode(params).join(" ");
 645   IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
 646   if(ircuser) {
 647     ircuser->setWhoisServiceReply(whoisServiceReply);
 648   }
 649   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(whoisServiceReply));
 650 }
 651
 652 /* RPL_SUSERHOST - "<user> is available for help." */
 653 void IrcServerHandler::handle310(const QString &prefix, const QList<QByteArray> &params) {
 654   Q_UNUSED(prefix)
 655   if(!checkParamCount("IrcServerHandler::handle310()", params, 1))
 656     return;
 657
 658   QString suserHost = serverDecode(params).join(" ");
 659   IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
 660   if(ircuser) {
 661     ircuser->setSuserHost(suserHost);
 662   }
 663   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(suserHost));
 664 }
 665
 666 /*  RPL_WHOISUSER - "<nick> <user> <host> * :<real name>" */
 667 void IrcServerHandler::handle311(const QString &prefix, const QList<QByteArray> &params) {
 668   Q_UNUSED(prefix)
 669   if(!checkParamCount("IrcServerHandler::handle311()", params, 3))
 670     return;
 671
 672   _whois = true;
 673   IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
 674   if(ircuser) {
 675     ircuser->setUser(serverDecode(params[1]));
 676     ircuser->setHost(serverDecode(params[2]));
 677     ircuser->setRealName(serverDecode(params.last()));
 678     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is %2 (%3)") .arg(ircuser->nick()).arg(ircuser->hostmask()).arg(ircuser->realName()));
 679   } else {
 680     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is %2 (%3)") .arg(serverDecode(params[1])).arg(serverDecode(params[2])).arg(serverDecode(params.last())));
 681   }
 682 }
 683
 684 /*  RPL_WHOISSERVER -  "<nick> <server> :<server info>" */
 685 void IrcServerHandler::handle312(const QString &prefix, const QList<QByteArray> &params) {
 686   Q_UNUSED(prefix)
 687   if(!checkParamCount("IrcServerHandler::handle312()", params, 2))
 688     return;
 689
 690   IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
 691   if(ircuser) {
 692     ircuser->setServer(serverDecode(params[1]));
 693   }
 694
 695   QString returnString = tr("%1 is online via %2 (%3)").arg(serverDecode(params[0])).arg(serverDecode(params[1])).arg(serverDecode(params.last()));
 696   if(_whois) {
 697     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(returnString));
 698   } else {
 699     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whowas] %1").arg(returnString));
 700   }
 701 }
 702
 703 /*  RPL_WHOISOPERATOR - "<nick> :is an IRC operator" */
 704 void IrcServerHandler::handle313(const QString &prefix, const QList<QByteArray> &params) {
 705   Q_UNUSED(prefix)
 706   if(!checkParamCount("IrcServerHandler::handle313()", params, 1))
 707     return;
 708
 709   IrcUser *ircuser = network()->ircUser(serverDecode(params[0]));
 710   if(ircuser) {
 711     ircuser->setIrcOperator(params.last());
 712   }
 713   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
 714 }
 715
 716 /*  RPL_WHOWASUSER - "<nick> <user> <host> * :<real name>" */
 717 void IrcServerHandler::handle314(const QString &prefix, const QList<QByteArray> &params) {
 718   Q_UNUSED(prefix)
 719   if(!checkParamCount("IrcServerHandler::handle314()", params, 3))
 720     return;
 721
 722   QString nick = serverDecode(params[0]);
 723   QString hostmask = QString("%1@%2").arg(serverDecode(params[1])).arg(serverDecode(params[2]));
 724   QString realName = serverDecode(params.last());
 725   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whowas] %1 was %2 (%3)").arg(nick).arg(hostmask).arg(realName));
 726 }
 727
 728 /*  RPL_ENDOFWHO: "<name> :End of WHO list" */
 729 void IrcServerHandler::handle315(const QString &prefix, const QList<QByteArray> &params) {
 730   Q_UNUSED(prefix);
 731   if(!checkParamCount("IrcServerHandler::handle315()", params, 1))
 732     return;
 733
 734   QStringList p = serverDecode(params);
 735   if(network()->setAutoWhoDone(p[0])) {
 736     return; // stay silent
 737   }
 738   p.takeLast(); // should be "End of WHO list"
 739   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Who] End of /WHO list for %1").arg(p.join(" ")));
 740 }
 741
 742 /*  RPL_WHOISIDLE - "<nick> <integer> :seconds idle"
 743    (real life: "<nick> <integer> <integer> :seconds idle, signon time) */
 744 void IrcServerHandler::handle317(const QString &prefix, const QList<QByteArray> &params) {
 745   Q_UNUSED(prefix);
 746   if(!checkParamCount("IrcServerHandler::handle317()", params, 2))
 747     return;
 748
 749   QString nick = serverDecode(params[0]);
 750   IrcUser *ircuser = network()->ircUser(nick);
 751   if(ircuser) {
 752     QDateTime now = QDateTime::currentDateTime();
 753     int idleSecs = serverDecode(params[1]).toInt();
 754     idleSecs *= -1;
 755     ircuser->setIdleTime(now.addSecs(idleSecs));
 756     if(params.size() > 3) { // if we have more then 3 params we have the above mentioned "real life" situation
 757       int loginTime = serverDecode(params[2]).toInt();
 758       ircuser->setLoginTime(QDateTime::fromTime_t(loginTime));
 759       emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is logged in since %2").arg(ircuser->nick()).arg(ircuser->loginTime().toString()));
 760     }
 761     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is idling for %2 (%3)").arg(ircuser->nick()).arg(secondsToString(ircuser->idleTime().secsTo(now))).arg(ircuser->idleTime().toString()));
 762
 763   } else {
 764     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] idle message: %1").arg(userDecode(nick, params).join(" ")));
 765   }
 766 }
 767
 768 /*  RPL_ENDOFWHOIS - "<nick> :End of WHOIS list" */
 769 void IrcServerHandler::handle318(const QString &prefix, const QList<QByteArray> &params) {
 770   Q_UNUSED(prefix)
 771   _whois = false;
 772   QStringList parameter = serverDecode(params);
 773   parameter.removeFirst();
 774   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(parameter.join(" ")));
 775 }
 776
 777 /*  RPL_WHOISCHANNELS - "<nick> :*( ( "@" / "+" ) <channel> " " )" */
 778 void IrcServerHandler::handle319(const QString &prefix, const QList<QByteArray> &params) {
 779   Q_UNUSED(prefix)
 780   if(!checkParamCount("IrcServerHandler::handle319()", params, 2))
 781     return;
 782
 783   QString nick = serverDecode(params.first());
 784   QStringList op;
 785   QStringList voice;
 786   QStringList user;
 787   foreach (QString channel, serverDecode(params.last()).split(" ")) {
 788     if(channel.startsWith("@"))
 789        op.append(channel.remove(0,1));
 790     else if(channel.startsWith("+"))
 791       voice.append(channel.remove(0,1));
 792     else
 793       user.append(channel);
 794   }
 795   if(!user.isEmpty())
 796     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is a user on channels: %2").arg(nick).arg(user.join(" ")));
 797   if(!voice.isEmpty())
 798     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 has voice on channels: %2").arg(nick).arg(voice.join(" ")));
 799   if(!op.isEmpty())
 800     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1 is an operator on channels: %2").arg(nick).arg(op.join(" ")));
 801 }
 802
 803 /*  RPL_WHOISVIRT - "<nick> is identified to services" */
 804 void IrcServerHandler::handle320(const QString &prefix, const QList<QByteArray> &params) {
 805   Q_UNUSED(prefix);
 806   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whois] %1").arg(serverDecode(params).join(" ")));
 807 }
 808
 809 /* RPL_LIST -  "<channel> <# visible> :<topic>" */
 810 void IrcServerHandler::handle322(const QString &prefix, const QList<QByteArray> &params) {
 811   Q_UNUSED(prefix)
 812   QString channelName;
 813   quint32 userCount = 0;
 814   QString topic;
 815
 816   int paramCount = params.count();
 817   switch(paramCount) {
 818   case 3:
 819     topic = serverDecode(params[2]);
 820   case 2:
 821     userCount = serverDecode(params[1]).toUInt();
 822   case 1:
 823     channelName = serverDecode(params[0]);
 824   default:
 825     break;
 826   }
 827   if(!coreSession()->ircListHelper()->addChannel(network()->networkId(), channelName, userCount, topic))
 828     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Channel %1 has %2 users. Topic is: %3").arg(channelName).arg(userCount).arg(topic));
 829 }
 830
 831 /* RPL_LISTEND ":End of LIST" */
 832 void IrcServerHandler::handle323(const QString &prefix, const QList<QByteArray> &params) {
 833   Q_UNUSED(prefix)
 834   Q_UNUSED(params)
 835
 836   if(!coreSession()->ircListHelper()->endOfChannelList(network()->networkId()))
 837     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("End of channel list"));
 838 }
 839
 840 /* RPL_CHANNELMODEIS - "<channel> <mode> <mode params>" */
 841 void IrcServerHandler::handle324(const QString &prefix, const QList<QByteArray> &params) {
 842   Q_UNUSED(prefix);
 843   handleMode(prefix, params);
 844 }
 845
 846 /* RPL_??? - "<channel> <homepage> */
 847 void IrcServerHandler::handle328(const QString &prefix, const QList<QByteArray> &params) {
 848   Q_UNUSED(prefix);
 849   if(!checkParamCount("IrcServerHandler::handle328()", params, 2))
 850     return;
 851
 852   QString channel = serverDecode(params[0]);
 853   QString homepage = serverDecode(params[1]);
 854
 855   emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel, tr("Homepage for %1 is %2").arg(channel, homepage));
 856 }
 857
 858
 859 /* RPL_??? - "<channel> <creation time (unix)>" */
 860 void IrcServerHandler::handle329(const QString &prefix, const QList<QByteArray> &params) {
 861   Q_UNUSED(prefix);
 862   if(!checkParamCount("IrcServerHandler::handle329()", params, 2))
 863     return;
 864
 865   QString channel = serverDecode(params[0]);
 866   uint unixtime = params[1].toUInt();
 867   if(!unixtime) {
 868     qWarning() << Q_FUNC_INFO << "received invalid timestamp:" << params[1];
 869     return;
 870   }
 871   QDateTime time = QDateTime::fromTime_t(unixtime);
 872
 873   emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel, tr("Channel %1 created on %2").arg(channel, time.toString()));
 874 }
 875
 876 /* RPL_NOTOPIC */
 877 void IrcServerHandler::handle331(const QString &prefix, const QList<QByteArray> &params) {
 878   Q_UNUSED(prefix);
 879   if(!checkParamCount("IrcServerHandler::handle331()", params, 1))
 880     return;
 881
 882   QString channel = serverDecode(params[0]);
 883   IrcChannel *chan = network()->ircChannel(channel);
 884   if(chan)
 885     chan->setTopic(QString());
 886
 887   emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel, tr("No topic is set for %1.").arg(channel));
 888 }
 889
 890 /* RPL_TOPIC */
 891 void IrcServerHandler::handle332(const QString &prefix, const QList<QByteArray> &params) {
 892   Q_UNUSED(prefix);
 893   if(!checkParamCount("IrcServerHandler::handle332()", params, 2))
 894     return;
 895
 896   QString channel = serverDecode(params[0]);
 897   QString topic = channelDecode(channel, params[1]);
 898   IrcChannel *chan = network()->ircChannel(channel);
 899   if(chan)
 900     chan->setTopic(topic);
 901
 902   emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel, tr("Topic for %1 is \"%2\"").arg(channel, topic));
 903 }
 904
 905 /* Topic set by... */
 906 void IrcServerHandler::handle333(const QString &prefix, const QList<QByteArray> &params) {
 907   Q_UNUSED(prefix);
 908   if(!checkParamCount("IrcServerHandler::handle333()", params, 3))
 909     return;
 910
 911   QString channel = serverDecode(params[0]);
 912   emit displayMsg(Message::Server, BufferInfo::ChannelBuffer, channel,
 913                   tr("Topic set by %1 on %2") .arg(serverDecode(params[1]), QDateTime::fromTime_t(channelDecode(channel, params[2]).toUInt()).toString()));
 914 }
 915
 916 /*  RPL_WHOREPLY: "<channel> <user> <host> <server> <nick>
 917               ( "H" / "G" > ["*"] [ ( "@" / "+" ) ] :<hopcount> <real name>" */
 918 void IrcServerHandler::handle352(const QString &prefix, const QList<QByteArray> &params) {
 919   Q_UNUSED(prefix)
 920   if(!checkParamCount("IrcServerHandler::handle352()", params, 6))
 921     return;
 922
 923   QString channel = serverDecode(params[0]);
 924   IrcUser *ircuser = network()->ircUser(serverDecode(params[4]));
 925   if(ircuser) {
 926     ircuser->setUser(serverDecode(params[1]));
 927     ircuser->setHost(serverDecode(params[2]));
 928
 929     bool away = serverDecode(params[5]).startsWith("G") ? true : false;
 930     ircuser->setAway(away);
 931     ircuser->setServer(serverDecode(params[3]));
 932     ircuser->setRealName(serverDecode(params.last()).section(" ", 1));
 933   }
 934
 935   if(!network()->isAutoWhoInProgress(channel)) {
 936     emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Who] %1").arg(serverDecode(params).join(" ")));
 937   }
 938 }
 939
 940 /* RPL_NAMREPLY */
 941 void IrcServerHandler::handle353(const QString &prefix, const QList<QByteArray> &params) {
 942   Q_UNUSED(prefix);
 943   if(!checkParamCount("IrcServerHandler::handle353()", params, 3))
 944     return;
 945
 946   // param[0] is either "=", "*" or "@" indicating a public, private or secret channel
 947   // we don't use this information at the time beeing
 948   QString channelname = serverDecode(params[1]);
 949
 950   IrcChannel *channel = network()->ircChannel(channelname);
 951   if(!channel) {
 952     qWarning() << "IrcServerHandler::handle353(): received unknown target channel:" << channelname;
 953     return;
 954   }
 955
 956   QStringList nicks;
 957   QStringList modes;
 958
 959   foreach(QString nick, serverDecode(params[2]).split(' ')) {
 960     QString mode = QString();
 961
 962     if(network()->prefixes().contains(nick[0])) {
 963       mode = network()->prefixToMode(nick[0]);
 964       nick = nick.mid(1);
 965     }
 966
 967     nicks << nick;
 968     modes << mode;
 969   }
 970
 971   channel->joinIrcUsers(nicks, modes);
 972 }
 973
 974 /*  RPL_ENDOFWHOWAS - "<nick> :End of WHOWAS" */
 975 void IrcServerHandler::handle369(const QString &prefix, const QList<QByteArray> &params) {
 976   Q_UNUSED(prefix)
 977   emit displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("[Whowas] %1").arg(serverDecode(params).join(" ")));
 978 }
 979
 980 /* ERR_ERRONEUSNICKNAME */
 981 void IrcServerHandler::handle432(const QString &prefix, const QList<QByteArray> &params) {
 982   Q_UNUSED(prefix);
 983
 984   QString errnick;
 985   if(params.size() < 2) {
 986     // handle unreal-ircd bug, where unreal ircd doesnt supply a TARGET in ERR_ERRONEUSNICKNAME during registration phase:
 987     // nick @@@
 988     // :irc.scortum.moep.net 432  @@@ :Erroneous Nickname: Illegal characters
 989     // correct server reply:
 990     // :irc.scortum.moep.net 432 * @@@ :Erroneous Nickname: Illegal characters
 991     errnick = target();
 992   } else {
 993     errnick = params[0];
 994   }
 995   emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Nick %1 contains illegal characters").arg(errnick));
 996   tryNextNick(errnick, true /* erroneus */);
 997 }
 998
 999 /* ERR_NICKNAMEINUSE */
1000 void IrcServerHandler::handle433(const QString &prefix, const QList<QByteArray> &params) {
1001   Q_UNUSED(prefix);
1002   if(!checkParamCount("IrcServerHandler::handle433()", params, 1))
1003     return;
1004
1005   QString errnick = serverDecode(params[0]);
1006   emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Nick already in use: %1").arg(errnick));
1007
1008   // if there is a problem while connecting to the server -> we handle it
1009   // but only if our connection has not been finished yet...
1010   if(!network()->currentServer().isEmpty())
1011     return;
1012
1013   tryNextNick(errnick);
1014 }
1015
1016 /* */
1017
1018 // FIXME networkConnection()->setChannelKey("") for all ERR replies indicating that a JOIN went wrong
1019 //       mostly, these are codes in the 47x range
1020
1021 /* */
1022
1023 void IrcServerHandler::tryNextNick(const QString &errnick, bool erroneus) {
1024   QStringList desiredNicks = coreSession()->identity(network()->identity())->nicks();
1025   int nextNickIdx = desiredNicks.indexOf(errnick) + 1;
1026   QString nextNick;
1027   if(nextNickIdx > 0 && desiredNicks.size() > nextNickIdx) {
1028     nextNick = desiredNicks[nextNickIdx];
1029   } else {
1030     if(erroneus) {
1031       emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("No free and valid nicks in nicklist found. use: /nick <othernick> to continue"));
1032       return;
1033     } else {
1034       nextNick = errnick + "_";
1035     }
1036   }
1037   putCmd("NICK", serverEncode(nextNick));
1038 }
1039
1040 bool IrcServerHandler::checkParamCount(const QString &methodName, const QList<QByteArray> &params, int minParams) {
1041   if(params.count() < minParams) {
1042     qWarning() << qPrintable(methodName) << "requires" << minParams << "parameters but received only" << params.count() << serverDecode(params);
1043     return false;
1044   } else {
1045     return true;
1046   }
1047 }
1048
1049
1050 /***********************************************************************************/
1051
1052