1 /***************************************************************************
2 * Copyright (C) 2005-09 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 "userinputhandler.h"
24 #include "ctcphandler.h"
25 #include "coreidentity.h"
31 UserInputHandler::UserInputHandler(CoreNetwork *parent)
32 : BasicHandler(parent)
36 void UserInputHandler::handleUserInput(const BufferInfo &bufferInfo, const QString &msg_) {
40 // FIXME: With protocol >= v10, this is all done in the client -> remove
43 // leading slashes indicate there's a command to call unless there is another one in the first section (like a path /proc/cpuinfo)
44 int secondSlashPos = msg.indexOf('/', 1);
45 int firstSpacePos = msg.indexOf(' ');
46 if(!msg.startsWith('/') || (secondSlashPos != -1 && (secondSlashPos < firstSpacePos || firstSpacePos == -1))) {
47 if(msg.startsWith("//"))
48 msg.remove(0, 1); // //asdf is transformed to /asdf
51 cmd = msg.section(' ', 0, 0).remove(0, 1).toUpper();
52 msg = msg.section(' ', 1);
54 handle(cmd, Q_ARG(BufferInfo, bufferInfo), Q_ARG(QString, msg));
57 // ====================
59 // ====================
60 void UserInputHandler::handleAway(const BufferInfo &bufferInfo, const QString &msg) {
63 QString awayMsg = msg;
64 IrcUser *me = network()->me();
66 // if there is no message supplied we have to check if we are already away or not
68 if(me && !me->isAway()) {
69 awayMsg = network()->identityPtr()->awayReason();
70 if(awayMsg.isEmpty()) {
76 me->setAwayMessage(awayMsg);
78 putCmd("AWAY", serverEncode(awayMsg));
81 void UserInputHandler::handleBan(const BufferInfo &bufferInfo, const QString &msg) {
82 banOrUnban(bufferInfo, msg, true);
85 void UserInputHandler::handleUnban(const BufferInfo &bufferInfo, const QString &msg) {
86 banOrUnban(bufferInfo, msg, false);
89 void UserInputHandler::banOrUnban(const BufferInfo &bufferInfo, const QString &msg, bool ban) {
93 QStringList params = msg.split(" ");
95 if(!params.isEmpty() && isChannelName(params[0])) {
96 banChannel = params.takeFirst();
97 } else if(bufferInfo.type() == BufferInfo::ChannelBuffer) {
98 banChannel = bufferInfo.bufferName();
100 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Error: channel unknown in command: /BAN %1").arg(msg));
104 if(!params.isEmpty() && !params.contains("!") && network()->ircUser(params[0])) {
105 IrcUser *ircuser = network()->ircUser(params[0]);
106 // generalizedHost changes <nick> to *!ident@*.sld.tld.
107 QString generalizedHost = ircuser->host();
108 if(generalizedHost.isEmpty()) {
109 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Error: host unknown in command: /BAN %1").arg(msg));
113 static QRegExp ipAddress("\\d+\\.\\d+\\.\\d+\\.\\d+");
114 if(ipAddress.exactMatch(generalizedHost)) {
115 int lastDotPos = generalizedHost.lastIndexOf('.') + 1;
116 generalizedHost.replace(lastDotPos, generalizedHost.length() - lastDotPos, '*');
117 } else if(generalizedHost.lastIndexOf(".") != -1 && generalizedHost.lastIndexOf(".", generalizedHost.lastIndexOf(".")-1) != -1) {
118 int secondLastPeriodPosition = generalizedHost.lastIndexOf(".", generalizedHost.lastIndexOf(".")-1);
119 generalizedHost.replace(0, secondLastPeriodPosition, "*");
121 banUser = QString("*!%1@%2").arg(ircuser->user(), generalizedHost);
123 banUser = params.join(" ");
126 QString banMode = ban ? "+b" : "-b";
127 QString banMsg = QString("MODE %1 %2 %3").arg(banChannel, banMode, banUser);
128 emit putRawLine(serverEncode(banMsg));
131 void UserInputHandler::handleCtcp(const BufferInfo &bufferInfo, const QString &msg) {
134 QString nick = msg.section(' ', 0, 0);
135 QString ctcpTag = msg.section(' ', 1, 1).toUpper();
136 if(ctcpTag.isEmpty())
139 QString message = "";
140 QString verboseMessage = tr("sending CTCP-%1 request").arg(ctcpTag);
142 if(ctcpTag == "PING") {
143 uint now = QDateTime::currentDateTime().toTime_t();
144 message = QString::number(now);
147 network()->ctcpHandler()->query(nick, ctcpTag, message);
148 emit displayMsg(Message::Action, BufferInfo::StatusBuffer, "", verboseMessage, network()->myNick());
151 void UserInputHandler::handleDeop(const BufferInfo &bufferInfo, const QString &msg) {
152 QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
153 QString m = "-"; for(int i = 0; i < nicks.count(); i++) m += 'o';
155 params << bufferInfo.bufferName() << m << nicks;
156 emit putCmd("MODE", serverEncode(params));
159 void UserInputHandler::handleDevoice(const BufferInfo &bufferInfo, const QString &msg) {
160 QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
161 QString m = "-"; for(int i = 0; i < nicks.count(); i++) m += 'v';
163 params << bufferInfo.bufferName() << m << nicks;
164 emit putCmd("MODE", serverEncode(params));
167 void UserInputHandler::handleInvite(const BufferInfo &bufferInfo, const QString &msg) {
169 params << msg << bufferInfo.bufferName();
170 emit putCmd("INVITE", serverEncode(params));
173 void UserInputHandler::handleJoin(const BufferInfo &bufferInfo, const QString &msg) {
174 Q_UNUSED(bufferInfo);
176 // trim spaces before chans or keys
177 QString sane_msg = msg;
178 sane_msg.replace(QRegExp(", +"), ",");
179 QStringList params = sane_msg.trimmed().split(" ");
180 QStringList chans = params[0].split(",");
183 for(i = 0; i < chans.count(); i++) {
184 if(!network()->isChannelName(chans[i]))
185 chans[i].prepend('#');
187 params[0] = chans.join(",");
188 if(params.count() > 1) keys = params[1].split(",");
189 emit putCmd("JOIN", serverEncode(params)); // FIXME handle messages longer than 512 bytes!
191 for(; i < keys.count(); i++) {
192 if(i >= chans.count()) break;
193 network()->addChannelKey(chans[i], keys[i]);
195 for(; i < chans.count(); i++) {
196 network()->removeChannelKey(chans[i]);
200 void UserInputHandler::handleKick(const BufferInfo &bufferInfo, const QString &msg) {
201 QString nick = msg.section(' ', 0, 0, QString::SectionSkipEmpty);
202 QString reason = msg.section(' ', 1, -1, QString::SectionSkipEmpty).trimmed();
204 reason = network()->identityPtr()->kickReason();
206 QList<QByteArray> params;
207 params << serverEncode(bufferInfo.bufferName()) << serverEncode(nick) << channelEncode(bufferInfo.bufferName(), reason);
208 emit putCmd("KICK", params);
211 void UserInputHandler::handleKill(const BufferInfo &bufferInfo, const QString &msg) {
213 QString nick = msg.section(' ', 0, 0, QString::SectionSkipEmpty);
214 QString pass = msg.section(' ', 1, -1, QString::SectionSkipEmpty);
215 QList<QByteArray> params;
216 params << serverEncode(nick) << serverEncode(pass);
217 emit putCmd("KILL", params);
221 void UserInputHandler::handleList(const BufferInfo &bufferInfo, const QString &msg) {
223 emit putCmd("LIST", serverEncode(msg.split(' ', QString::SkipEmptyParts)));
226 void UserInputHandler::handleMe(const BufferInfo &bufferInfo, const QString &msg) {
227 if(bufferInfo.bufferName().isEmpty()) return; // server buffer
228 network()->ctcpHandler()->query(bufferInfo.bufferName(), "ACTION", msg);
229 emit displayMsg(Message::Action, bufferInfo.type(), bufferInfo.bufferName(), msg, network()->myNick(), Message::Self);
232 void UserInputHandler::handleMode(const BufferInfo &bufferInfo, const QString &msg) {
235 QStringList params = msg.split(' ', QString::SkipEmptyParts);
236 // 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
237 if(!params.isEmpty() && !network()->isChannelName(params[0]) && !network()->isMyNick(params[0]))
238 params.prepend(bufferInfo.bufferName());
240 // TODO handle correct encoding for buffer modes (channelEncode())
241 emit putCmd("MODE", serverEncode(params));
244 // TODO: show privmsgs
245 void UserInputHandler::handleMsg(const BufferInfo &bufferInfo, const QString &msg) {
246 Q_UNUSED(bufferInfo);
247 if(!msg.contains(' '))
250 QByteArray target = serverEncode(msg.section(' ', 0, 0));
251 putPrivmsg(target, userEncode(target, msg.section(' ', 1)));
254 void UserInputHandler::handleNick(const BufferInfo &bufferInfo, const QString &msg) {
256 QString nick = msg.section(' ', 0, 0);
257 emit putCmd("NICK", serverEncode(nick));
260 void UserInputHandler::handleNotice(const BufferInfo &bufferInfo, const QString &msg) {
261 QString bufferName = msg.section(' ', 0, 0);
262 QString payload = msg.section(' ', 1);
263 QList<QByteArray> params;
264 params << serverEncode(bufferName) << channelEncode(bufferInfo.bufferName(), payload);
265 emit putCmd("NOTICE", params);
266 emit displayMsg(Message::Notice, bufferName, payload, network()->myNick(), Message::Self);
269 void UserInputHandler::handleOp(const BufferInfo &bufferInfo, const QString &msg) {
270 QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
271 QString m = "+"; for(int i = 0; i < nicks.count(); i++) m += 'o';
273 params << bufferInfo.bufferName() << m << nicks;
274 emit putCmd("MODE", serverEncode(params));
277 void UserInputHandler::handleOper(const BufferInfo &bufferInfo, const QString &msg) {
279 emit putRawLine(serverEncode(QString("OPER %1").arg(msg)));
282 void UserInputHandler::handlePart(const BufferInfo &bufferInfo, const QString &msg) {
283 QList<QByteArray> params;
286 // msg might contain either a channel name and/or a reaon, so we have to check if the first word is a known channel
287 QString channelName = msg.section(' ', 0, 0);
288 if(channelName.isEmpty() || !network()->ircChannel(channelName)) {
289 channelName = bufferInfo.bufferName();
292 partReason = msg.mid(channelName.length() + 1);
295 if(partReason.isEmpty())
296 partReason = network()->identityPtr()->partReason();
298 params << serverEncode(channelName) << channelEncode(bufferInfo.bufferName(), partReason);
299 emit putCmd("PART", params);
302 void UserInputHandler::handlePing(const BufferInfo &bufferInfo, const QString &msg) {
307 param = QTime::currentTime().toString("hh:mm:ss.zzz");
309 putCmd("PING", serverEncode(param));
312 // TODO: implement queries
313 void UserInputHandler::handleQuery(const BufferInfo &bufferInfo, const QString &msg) {
315 QString target = msg.section(' ', 0, 0);
316 QString message = msg.section(' ', 1);
317 if(message.isEmpty())
318 emit displayMsg(Message::Server, BufferInfo::QueryBuffer, target, "Starting query with " + target, network()->myNick(), Message::Self);
320 emit displayMsg(Message::Plain, BufferInfo::QueryBuffer, target, message, network()->myNick(), Message::Self);
321 handleMsg(bufferInfo, msg);
324 void UserInputHandler::handleQuit(const BufferInfo &bufferInfo, const QString &msg) {
326 network()->disconnectFromIrc(true, msg);
329 void UserInputHandler::issueQuit(const QString &reason) {
330 emit putCmd("QUIT", serverEncode(reason));
333 void UserInputHandler::handleQuote(const BufferInfo &bufferInfo, const QString &msg) {
335 emit putRawLine(serverEncode(msg));
338 void UserInputHandler::handleSay(const BufferInfo &bufferInfo, const QString &msg) {
339 if(bufferInfo.bufferName().isEmpty())
340 return; // server buffer
341 putPrivmsg(serverEncode(bufferInfo.bufferName()), channelEncode(bufferInfo.bufferName(), msg));
342 emit displayMsg(Message::Plain, bufferInfo.type(), bufferInfo.bufferName(), msg, network()->myNick(), Message::Self);
345 void UserInputHandler::handleTopic(const BufferInfo &bufferInfo, const QString &msg) {
346 if(bufferInfo.bufferName().isEmpty()) return;
347 QList<QByteArray> params;
348 params << serverEncode(bufferInfo.bufferName());
350 params << channelEncode(bufferInfo.bufferName(), msg);
351 emit putCmd("TOPIC", params);
354 void UserInputHandler::handleVoice(const BufferInfo &bufferInfo, const QString &msg) {
355 QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
356 QString m = "+"; for(int i = 0; i < nicks.count(); i++) m += 'v';
358 params << bufferInfo.bufferName() << m << nicks;
359 emit putCmd("MODE", serverEncode(params));
362 void UserInputHandler::handleWait(const BufferInfo &bufferInfo, const QString &msg) {
363 int splitPos = msg.indexOf(';');
368 int delay = msg.left(splitPos).trimmed().toInt(&ok);
374 QString command = msg.mid(splitPos + 1).trimmed();
375 if(command.isEmpty())
378 _delayedCommands[startTimer(delay)] = Command(bufferInfo, command);
381 void UserInputHandler::handleWho(const BufferInfo &bufferInfo, const QString &msg) {
383 emit putCmd("WHO", serverEncode(msg.split(' ')));
386 void UserInputHandler::handleWhois(const BufferInfo &bufferInfo, const QString &msg) {
388 emit putCmd("WHOIS", serverEncode(msg.split(' ')));
391 void UserInputHandler::handleWhowas(const BufferInfo &bufferInfo, const QString &msg) {
393 emit putCmd("WHOWAS", serverEncode(msg.split(' ')));
396 // FIXME: Remove alias handling as soon as core protocol >= v10
397 void UserInputHandler::defaultHandler(QString cmd, const BufferInfo &bufferInfo, const QString &msg) {
398 for(int i = 0; i < coreSession()->aliasManager().count(); i++) {
399 if(coreSession()->aliasManager()[i].name.toLower() == cmd.toLower()) {
400 expand(coreSession()->aliasManager()[i].expansion, bufferInfo, msg);
404 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Error: %1 %2").arg(cmd, msg));
407 void UserInputHandler::expand(const QString &alias, const BufferInfo &bufferInfo, const QString &msg) {
408 QRegExp paramRangeR("\\$(\\d+)\\.\\.(\\d*)");
409 QStringList commands = alias.split(QRegExp("; ?"));
410 QStringList params = msg.split(' ');
411 QStringList expandedCommands;
412 for(int i = 0; i < commands.count(); i++) {
413 QString command = commands[i];
415 // replace ranges like $1..3
416 if(!params.isEmpty()) {
418 while((pos = paramRangeR.indexIn(command)) != -1) {
419 int start = paramRangeR.cap(1).toInt();
421 int end = paramRangeR.cap(2).toInt(&ok);
423 end = params.count();
426 command = command.replace(pos, paramRangeR.matchedLength(), QString());
428 command = command.replace(pos, paramRangeR.matchedLength(), QStringList(params.mid(start - 1, end - start + 1)).join(" "));
433 for(int j = params.count(); j > 0; j--) {
434 IrcUser *ircUser = network()->ircUser(params[j - 1]);
435 command = command.replace(QString("$%1:hostname").arg(j), ircUser ? ircUser->host() : QString("*"));
436 command = command.replace(QString("$%1").arg(j), params[j - 1]);
438 command = command.replace("$0", msg);
439 command = command.replace("$channelname", bufferInfo.bufferName());
440 command = command.replace("$currentnick", network()->myNick());
441 expandedCommands << command;
444 while(!expandedCommands.isEmpty()) {
446 if(expandedCommands[0].trimmed().toLower().startsWith("/wait")) {
447 command = expandedCommands.join("; ");
448 expandedCommands.clear();
450 command = expandedCommands.takeFirst();
452 handleUserInput(bufferInfo, command);
457 void UserInputHandler::putPrivmsg(const QByteArray &target, const QByteArray &message) {
458 static const char *cmd = "PRIVMSG";
459 int overrun = lastParamOverrun(cmd, QList<QByteArray>() << message);
461 static const char *splitter = " .,-";
462 int maxSplitPos = message.count() - overrun;
464 for(const char *splitChar = splitter; *splitChar != 0; splitChar++) {
465 splitPos = qMax(splitPos, message.lastIndexOf(*splitChar, maxSplitPos));
468 splitPos = maxSplitPos;
470 putCmd(cmd, QList<QByteArray>() << target << message.left(splitPos));
471 putPrivmsg(target, message.mid(splitPos));
474 putCmd(cmd, QList<QByteArray>() << target << message);
478 // returns 0 if the message will not be chopped by the irc server or number of chopped bytes if message is too long
479 int UserInputHandler::lastParamOverrun(const QString &cmd, const QList<QByteArray> ¶ms) {
480 // the server will pass our message trunkated to 512 bytes including CRLF with the following format:
481 // ":prefix COMMAND param0 param1 :lastparam"
482 // where prefix = "nickname!user@host"
483 // that means that the last message can be as long as:
484 // 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)
485 IrcUser *me = network()->me();
486 int maxLen = 480 - cmd.toAscii().count(); // educated guess in case we don't know us (yet?)
489 maxLen = 512 - serverEncode(me->nick()).count() - serverEncode(me->user()).count() - serverEncode(me->host()).count() - cmd.toAscii().count() - 6;
491 if(!params.isEmpty()) {
492 for(int i = 0; i < params.count() - 1; i++) {
493 maxLen -= (params[i].count() + 1);
495 maxLen -= 2; // " :" last param separator;
497 if(params.last().count() > maxLen) {
498 return params.last().count() - maxLen;
508 void UserInputHandler::timerEvent(QTimerEvent *event) {
509 if(!_delayedCommands.contains(event->timerId())) {
510 QObject::timerEvent(event);
513 BufferInfo bufferInfo = _delayedCommands[event->timerId()].bufferInfo;
514 QString rawCommand = _delayedCommands[event->timerId()].command;
515 _delayedCommands.remove(event->timerId());
518 // the stored command might be the result of an alias expansion, so we need to split it up again
519 QStringList commands = rawCommand.split(QRegExp("; ?"));
520 foreach(QString command, commands) {
521 handleUserInput(bufferInfo, command);