src/core/userinputhandler.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 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 "userinputhandler.h"
  21
  22 #include "util.h"
  23
  24 #include "ctcphandler.h"
  25 #include "identity.h"
  26 #include "ircuser.h"
  27
  28 #include <QDebug>
  29 #include <QRegExp>
  30
  31 UserInputHandler::UserInputHandler(CoreNetwork *parent)
  32   : BasicHandler(parent)
  33 {
  34 }
  35
  36 void UserInputHandler::handleUserInput(const BufferInfo &bufferInfo, const QString &msg_) {
  37   try {
  38     if(msg_.isEmpty())
  39       return;
  40     QString cmd;
  41     QString msg = msg_;
  42     // leading slashes indicate there's a command to call unless there is another one in the first section (like a path /proc/cpuinfo)
  43     int secondSlashPos = msg.indexOf('/', 1);
  44     int firstSpacePos = msg.indexOf(' ');
  45     if(!msg.startsWith('/') || (secondSlashPos != -1 && (secondSlashPos < firstSpacePos || firstSpacePos == -1))) {
  46       if(msg.startsWith("//"))
  47         msg.remove(0, 1); // //asdf is transformed to /asdf
  48       cmd = QString("SAY");
  49     } else {
  50       cmd = msg.section(' ', 0, 0).remove(0, 1).toUpper();
  51       msg = msg.section(' ', 1);
  52     }
  53     handle(cmd, Q_ARG(BufferInfo, bufferInfo), Q_ARG(QString, msg));
  54   } catch(Exception e) {
  55     emit displayMsg(Message::Error, bufferInfo.type(), "", e.msg());
  56   }
  57 }
  58
  59 // ====================
  60 //  Public Slots
  61 // ====================
  62 void UserInputHandler::handleAway(const BufferInfo &bufferInfo, const QString &msg) {
  63   Q_UNUSED(bufferInfo)
  64
  65   QString awayMsg = msg;
  66   IrcUser *me = network()->me();
  67
  68   // if there is no message supplied we have to check if we are already away or not
  69   if(msg.isEmpty()) {
  70     if(me && !me->isAway())
  71       awayMsg = network()->identityPtr()->awayReason();
  72   }
  73   if(me)
  74     me->setAwayMessage(awayMsg);
  75
  76   putCmd("AWAY", serverEncode(awayMsg));
  77 }
  78
  79 void UserInputHandler::handleBan(const BufferInfo &bufferInfo, const QString &msg) {
  80   banOrUnban(bufferInfo, msg, true);
  81 }
  82
  83 void UserInputHandler::handleUnban(const BufferInfo &bufferInfo, const QString &msg) {
  84   banOrUnban(bufferInfo, msg, false);
  85 }
  86
  87 void UserInputHandler::banOrUnban(const BufferInfo &bufferInfo, const QString &msg, bool ban) {
  88   QString banChannel;
  89   QString banUser;
  90
  91   QStringList params = msg.split(" ");
  92
  93   if(!params.isEmpty() && isChannelName(params[0])) {
  94     banChannel = params.takeFirst();
  95   } else if(bufferInfo.type() == BufferInfo::ChannelBuffer) {
  96     banChannel = bufferInfo.bufferName();
  97   } else {
  98     emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Error: channel unknown in command: /BAN %1").arg(msg));
  99     return;
 100   }
 101
 102   if(!params.isEmpty() && !params.contains("!") && network()->ircUser(params[0])) {
 103     IrcUser *ircuser = network()->ircUser(params[0]);
 104     // generalizedHost changes <nick> to  *!ident@*.sld.tld.
 105     QString generalizedHost = ircuser->host();
 106     if(generalizedHost.isEmpty()) {
 107       emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Error: host unknown in command: /BAN %1").arg(msg));
 108       return;
 109     }
 110
 111     if(generalizedHost.lastIndexOf(".") != -1 && generalizedHost.lastIndexOf(".", generalizedHost.lastIndexOf(".")-1) != -1) {
 112       int secondLastPeriodPosition = generalizedHost.lastIndexOf(".", generalizedHost.lastIndexOf(".")-1);
 113       generalizedHost.replace(0, secondLastPeriodPosition, "*");
 114     }
 115     banUser = QString("*!%1@%2").arg(ircuser->user(), generalizedHost);
 116   } else {
 117     banUser = params.join(" ");
 118   }
 119
 120   QString banMode = ban ? "+b" : "-b";
 121   QString banMsg = QString("MODE %1 %2 %3").arg(banChannel, banMode, banUser);
 122   emit putRawLine(serverEncode(banMsg));
 123 }
 124
 125 void UserInputHandler::handleCtcp(const BufferInfo &bufferInfo, const QString &msg) {
 126   Q_UNUSED(bufferInfo)
 127
 128   QString nick = msg.section(' ', 0, 0);
 129   QString ctcpTag = msg.section(' ', 1, 1).toUpper();
 130   if(ctcpTag.isEmpty())
 131     return;
 132
 133   QString message = "";
 134   QString verboseMessage = tr("sending CTCP-%1 request").arg(ctcpTag);
 135
 136   if(ctcpTag == "PING") {
 137     uint now = QDateTime::currentDateTime().toTime_t();
 138     message = QString::number(now);
 139   }
 140
 141   network()->ctcpHandler()->query(nick, ctcpTag, message);
 142   emit displayMsg(Message::Action, BufferInfo::StatusBuffer, "", verboseMessage, network()->myNick());
 143 }
 144
 145 void UserInputHandler::handleDeop(const BufferInfo &bufferInfo, const QString &msg) {
 146   QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
 147   QString m = "-"; for(int i = 0; i < nicks.count(); i++) m += 'o';
 148   QStringList params;
 149   params << bufferInfo.bufferName() << m << nicks;
 150   emit putCmd("MODE", serverEncode(params));
 151 }
 152
 153 void UserInputHandler::handleDevoice(const BufferInfo &bufferInfo, const QString &msg) {
 154   QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
 155   QString m = "-"; for(int i = 0; i < nicks.count(); i++) m += 'v';
 156   QStringList params;
 157   params << bufferInfo.bufferName() << m << nicks;
 158   emit putCmd("MODE", serverEncode(params));
 159 }
 160
 161 void UserInputHandler::handleInvite(const BufferInfo &bufferInfo, const QString &msg) {
 162   QStringList params;
 163   params << msg << bufferInfo.bufferName();
 164   emit putCmd("INVITE", serverEncode(params));
 165 }
 166
 167 void UserInputHandler::handleJoin(const BufferInfo &bufferInfo, const QString &msg) {
 168   Q_UNUSED(bufferInfo);
 169
 170   // trim spaces before chans or keys
 171   QString sane_msg = msg;
 172   sane_msg.replace(QRegExp(", +"), ",");
 173   QStringList params = sane_msg.trimmed().split(" ");
 174   QStringList chans = params[0].split(",");
 175   QStringList keys;
 176   int i;
 177   for(i = 0; i < chans.count(); i++) {
 178     if(!network()->isChannelName(chans[i]))
 179       chans[i].prepend('#');
 180   }
 181   params[0] = chans.join(",");
 182   if(params.count() > 1) keys = params[1].split(",");
 183   emit putCmd("JOIN", serverEncode(params)); // FIXME handle messages longer than 512 bytes!
 184   i = 0;
 185   for(; i < keys.count(); i++) {
 186     if(i >= chans.count()) break;
 187     network()->addChannelKey(chans[i], keys[i]);
 188   }
 189   for(; i < chans.count(); i++) {
 190     network()->removeChannelKey(chans[i]);
 191   }
 192 }
 193
 194 void UserInputHandler::handleKick(const BufferInfo &bufferInfo, const QString &msg) {
 195   QString nick = msg.section(' ', 0, 0, QString::SectionSkipEmpty);
 196   QString reason = msg.section(' ', 1, -1, QString::SectionSkipEmpty).trimmed();
 197   if(reason.isEmpty())
 198     reason = network()->identityPtr()->kickReason();
 199
 200   QList<QByteArray> params;
 201   params << serverEncode(bufferInfo.bufferName()) << serverEncode(nick) << channelEncode(bufferInfo.bufferName(), reason);
 202   emit putCmd("KICK", params);
 203 }
 204
 205 void UserInputHandler::handleKill(const BufferInfo &bufferInfo, const QString &msg) {
 206   Q_UNUSED(bufferInfo)
 207   QString nick = msg.section(' ', 0, 0, QString::SectionSkipEmpty);
 208   QString pass = msg.section(' ', 1, -1, QString::SectionSkipEmpty);
 209   QList<QByteArray> params;
 210   params << serverEncode(nick) << serverEncode(pass);
 211   emit putCmd("KILL", params);
 212 }
 213
 214
 215 void UserInputHandler::handleList(const BufferInfo &bufferInfo, const QString &msg) {
 216   Q_UNUSED(bufferInfo)
 217   emit putCmd("LIST", serverEncode(msg.split(' ', QString::SkipEmptyParts)));
 218 }
 219
 220 void UserInputHandler::handleMe(const BufferInfo &bufferInfo, const QString &msg) {
 221   if(bufferInfo.bufferName().isEmpty()) return; // server buffer
 222   network()->ctcpHandler()->query(bufferInfo.bufferName(), "ACTION", msg);
 223   emit displayMsg(Message::Action, bufferInfo.type(), bufferInfo.bufferName(), msg, network()->myNick(), Message::Self);
 224 }
 225
 226 void UserInputHandler::handleMode(const BufferInfo &bufferInfo, const QString &msg) {
 227   Q_UNUSED(bufferInfo)
 228
 229   QStringList params = msg.split(' ', QString::SkipEmptyParts);
 230   // if the first argument is neither a channel nor us (user modes are only to oneself) the current buffer is assumed to be the target
 231   if(!params.isEmpty() && !network()->isChannelName(params[0]) && !network()->isMyNick(params[0]))
 232     params.prepend(bufferInfo.bufferName());
 233
 234   // TODO handle correct encoding for buffer modes (channelEncode())
 235   emit putCmd("MODE", serverEncode(params));
 236 }
 237
 238 // TODO: show privmsgs
 239 void UserInputHandler::handleMsg(const BufferInfo &bufferInfo, const QString &msg) {
 240   Q_UNUSED(bufferInfo);
 241   if(!msg.contains(' '))
 242     return;
 243
 244   QByteArray target = serverEncode(msg.section(' ', 0, 0));
 245   putPrivmsg(target, userEncode(target, msg.section(' ', 1)));
 246 }
 247
 248 void UserInputHandler::handleNick(const BufferInfo &bufferInfo, const QString &msg) {
 249   Q_UNUSED(bufferInfo)
 250   QString nick = msg.section(' ', 0, 0);
 251   emit putCmd("NICK", serverEncode(nick));
 252 }
 253
 254 void UserInputHandler::handleNotice(const BufferInfo &bufferInfo, const QString &msg) {
 255   QString bufferName = msg.section(' ', 0, 0);
 256   QString payload = msg.section(' ', 1);
 257   QList<QByteArray> params;
 258   params << serverEncode(bufferName) << channelEncode(bufferInfo.bufferName(), payload);
 259   emit putCmd("NOTICE", params);
 260   emit displayMsg(Message::Notice, bufferName, payload, network()->myNick(), Message::Self);
 261 }
 262
 263 void UserInputHandler::handleOp(const BufferInfo &bufferInfo, const QString &msg) {
 264   QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
 265   QString m = "+"; for(int i = 0; i < nicks.count(); i++) m += 'o';
 266   QStringList params;
 267   params << bufferInfo.bufferName() << m << nicks;
 268   emit putCmd("MODE", serverEncode(params));
 269 }
 270
 271 void UserInputHandler::handleOper(const BufferInfo &bufferInfo, const QString &msg) {
 272   Q_UNUSED(bufferInfo)
 273   emit putRawLine(serverEncode(QString("OPER %1").arg(msg)));
 274 }
 275
 276 void UserInputHandler::handlePart(const BufferInfo &bufferInfo, const QString &msg) {
 277   QList<QByteArray> params;
 278   QString partReason;
 279
 280   // msg might contain either a channel name and/or a reaon, so we have to check if the first word is a known channel
 281   QString channelName = msg.section(' ', 0, 0);
 282   if(channelName.isEmpty() || !network()->ircChannel(channelName)) {
 283     channelName = bufferInfo.bufferName();
 284     partReason = msg;
 285   } else {
 286     partReason = msg.mid(channelName.length() + 1);
 287   }
 288
 289   if(partReason.isEmpty())
 290     partReason = network()->identityPtr()->partReason();
 291
 292   params << serverEncode(channelName) << channelEncode(bufferInfo.bufferName(), partReason);
 293   emit putCmd("PART", params);
 294 }
 295
 296 void UserInputHandler::handlePing(const BufferInfo &bufferInfo, const QString &msg) {
 297   Q_UNUSED(bufferInfo)
 298
 299   QString param = msg;
 300   if(param.isEmpty())
 301     param = QTime::currentTime().toString("hh:mm:ss.zzz");
 302
 303   putCmd("PING", serverEncode(param));
 304 }
 305
 306 // TODO: implement queries
 307 void UserInputHandler::handleQuery(const BufferInfo &bufferInfo, const QString &msg) {
 308   Q_UNUSED(bufferInfo)
 309   QString target = msg.section(' ', 0, 0);
 310   QString message = msg.section(' ', 1);
 311   if(message.isEmpty())
 312     emit displayMsg(Message::Server, BufferInfo::QueryBuffer, target, "Starting query with " + target, network()->myNick(), Message::Self);
 313   else
 314     emit displayMsg(Message::Plain, BufferInfo::QueryBuffer, target, message, network()->myNick(), Message::Self);
 315   handleMsg(bufferInfo, msg);
 316 }
 317
 318 void UserInputHandler::handleQuit(const BufferInfo &bufferInfo, const QString &msg) {
 319   Q_UNUSED(bufferInfo)
 320   network()->disconnectFromIrc(true, msg);
 321 }
 322
 323 void UserInputHandler::issueQuit(const QString &reason) {
 324   QString quitReason;
 325   if(reason.isEmpty())
 326     quitReason = network()->identityPtr()->quitReason();
 327   else
 328     quitReason = reason;
 329   emit putCmd("QUIT", serverEncode(quitReason));
 330 }
 331
 332 void UserInputHandler::handleQuote(const BufferInfo &bufferInfo, const QString &msg) {
 333   Q_UNUSED(bufferInfo)
 334   emit putRawLine(serverEncode(msg));
 335 }
 336
 337 void UserInputHandler::handleSay(const BufferInfo &bufferInfo, const QString &msg) {
 338   if(bufferInfo.bufferName().isEmpty())
 339     return;  // server buffer
 340   putPrivmsg(serverEncode(bufferInfo.bufferName()), channelEncode(bufferInfo.bufferName(), msg));
 341   emit displayMsg(Message::Plain, bufferInfo.type(), bufferInfo.bufferName(), msg, network()->myNick(), Message::Self);
 342 }
 343
 344 void UserInputHandler::handleTopic(const BufferInfo &bufferInfo, const QString &msg) {
 345   if(bufferInfo.bufferName().isEmpty()) return;
 346   QList<QByteArray> params;
 347   params << serverEncode(bufferInfo.bufferName());
 348   if(!msg.isEmpty())
 349     params << channelEncode(bufferInfo.bufferName(), msg);
 350   emit putCmd("TOPIC", params);
 351 }
 352
 353 void UserInputHandler::handleVoice(const BufferInfo &bufferInfo, const QString &msg) {
 354   QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
 355   QString m = "+"; for(int i = 0; i < nicks.count(); i++) m += 'v';
 356   QStringList params;
 357   params << bufferInfo.bufferName() << m << nicks;
 358   emit putCmd("MODE", serverEncode(params));
 359 }
 360
 361 void UserInputHandler::handleWho(const BufferInfo &bufferInfo, const QString &msg) {
 362   Q_UNUSED(bufferInfo)
 363   emit putCmd("WHO", serverEncode(msg.split(' ')));
 364 }
 365
 366 void UserInputHandler::handleWhois(const BufferInfo &bufferInfo, const QString &msg) {
 367   Q_UNUSED(bufferInfo)
 368   emit putCmd("WHOIS", serverEncode(msg.split(' ')));
 369 }
 370
 371 void UserInputHandler::handleWhowas(const BufferInfo &bufferInfo, const QString &msg) {
 372   Q_UNUSED(bufferInfo)
 373   emit putCmd("WHOWAS", serverEncode(msg.split(' ')));
 374 }
 375
 376 void UserInputHandler::defaultHandler(QString cmd, const BufferInfo &bufferInfo, const QString &msg) {
 377   for(int i = 0; i < coreSession()->aliasManager().count(); i++) {
 378     if(coreSession()->aliasManager()[i].name.toLower() == cmd.toLower()) {
 379       expand(coreSession()->aliasManager()[i].expansion, bufferInfo, msg);
 380       return;
 381     }
 382   }
 383   emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Error: %1 %2").arg(cmd, msg));
 384 }
 385
 386 void UserInputHandler::expand(const QString &alias, const BufferInfo &bufferInfo, const QString &msg) {
 387   QRegExp paramRangeR("\\$(\\d+)\\.\\.(\\d*)");
 388   QStringList commands = alias.split(QRegExp("; ?"));
 389   QStringList params = msg.split(' ');
 390   for(int i = 0; i < commands.count(); i++) {
 391     QString command = commands[i];
 392
 393     // replace ranges like $1..3
 394     if(!params.isEmpty()) {
 395       int pos;
 396       while((pos = paramRangeR.indexIn(command)) != -1) {
 397         int start = paramRangeR.cap(1).toInt();
 398         bool ok;
 399         int end = paramRangeR.cap(2).toInt(&ok);
 400         if(!ok) {
 401           end = params.count();
 402         }
 403         if(end < start)
 404           command = command.replace(pos, paramRangeR.matchedLength(), QString());
 405         else {
 406           command = command.replace(pos, paramRangeR.matchedLength(), QStringList(params.mid(start - 1, end - start + 1)).join(" "));
 407         }
 408       }
 409     }
 410
 411     for(int j = params.count(); j > 0; j--) {
 412       IrcUser *ircUser = network()->ircUser(params[j - 1]);
 413       command = command.replace(QString("$%1:hostname").arg(j), ircUser ? ircUser->host() : QString("*"));
 414       command = command.replace(QString("$%1").arg(j), params[j - 1]);
 415     }
 416     command = command.replace("$0", msg);
 417     command = command.replace("$channelname", bufferInfo.bufferName());
 418     command = command.replace("$currentnick", network()->myNick());
 419     handleUserInput(bufferInfo, command);
 420   }
 421 }
 422
 423
 424 void UserInputHandler::putPrivmsg(const QByteArray &target, const QByteArray &message) {
 425   static const char *cmd = "PRIVMSG";
 426   int overrun = lastParamOverrun(cmd, QList<QByteArray>() << message);
 427   if(overrun) {
 428     static const char *splitter = " .,-";
 429     int maxSplitPos = message.count() - overrun;
 430     int splitPos = -1;
 431     for(const char *splitChar = splitter; *splitChar != 0; splitChar++) {
 432       splitPos = qMax(splitPos, message.lastIndexOf(*splitChar, maxSplitPos));
 433     }
 434     if(splitPos <= 0) {
 435       splitPos = maxSplitPos;
 436     }
 437     putCmd(cmd, QList<QByteArray>() << target << message.left(splitPos));
 438     putPrivmsg(target, message.mid(splitPos));
 439     return;
 440   } else {
 441     putCmd(cmd, QList<QByteArray>() << target << message);
 442   }
 443 }
 444
 445 // returns 0 if the message will not be chopped by the irc server or number of chopped bytes if message is too long
 446 int UserInputHandler::lastParamOverrun(const QString &cmd, const QList<QByteArray> &params) {
 447   // the server will pass our message trunkated to 512 bytes including CRLF with the following format:
 448   // ":prefix COMMAND param0 param1 :lastparam"
 449   // where prefix = "nickname!user@host"
 450   // that means that the last message can be as long as:
 451   // 512 - nicklen - userlen - hostlen - commandlen - sum(param[0]..param[n-1])) - 2 (for CRLF) - 4 (":!@" + 1space between prefix and command) - max(paramcount - 1, 0) (space for simple params) - 2 (space and colon for last param)
 452   IrcUser *me = network()->me();
 453   int maxLen = 480 - cmd.toAscii().count(); // educated guess in case we don't know us (yet?)
 454
 455   if(me)
 456     maxLen = 512 - serverEncode(me->nick()).count() - serverEncode(me->user()).count() - serverEncode(me->host()).count() - cmd.toAscii().count() - 6;
 457
 458   if(!params.isEmpty()) {
 459     for(int i = 0; i < params.count() - 1; i++) {
 460       maxLen -= (params[i].count() + 1);
 461     }
 462     maxLen -= 2; // " :" last param separator;
 463
 464     if(params.last().count() > maxLen) {
 465       return params.last().count() - maxLen;
 466     } else {
 467       return 0;
 468     }
 469   } else {
 470     return 0;
 471   }
 472 }
 473