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_) {
41 // leading slashes indicate there's a command to call unless there is another one in the first section (like a path /proc/cpuinfo)
42 int secondSlashPos = msg.indexOf('/', 1);
43 int firstSpacePos = msg.indexOf(' ');
44 if(!msg.startsWith('/') || (secondSlashPos != -1 && (secondSlashPos < firstSpacePos || firstSpacePos == -1))) {
45 if(msg.startsWith("//"))
46 msg.remove(0, 1); // //asdf is transformed to /asdf
49 cmd = msg.section(' ', 0, 0).remove(0, 1).toUpper();
50 msg = msg.section(' ', 1);
52 handle(cmd, Q_ARG(BufferInfo, bufferInfo), Q_ARG(QString, msg));
55 // ====================
57 // ====================
58 void UserInputHandler::handleAway(const BufferInfo &bufferInfo, const QString &msg) {
61 QString awayMsg = msg;
62 IrcUser *me = network()->me();
64 // if there is no message supplied we have to check if we are already away or not
66 if(me && !me->isAway())
67 awayMsg = network()->identityPtr()->awayReason();
70 me->setAwayMessage(awayMsg);
72 putCmd("AWAY", serverEncode(awayMsg));
75 void UserInputHandler::handleBan(const BufferInfo &bufferInfo, const QString &msg) {
76 banOrUnban(bufferInfo, msg, true);
79 void UserInputHandler::handleUnban(const BufferInfo &bufferInfo, const QString &msg) {
80 banOrUnban(bufferInfo, msg, false);
83 void UserInputHandler::banOrUnban(const BufferInfo &bufferInfo, const QString &msg, bool ban) {
87 QStringList params = msg.split(" ");
89 if(!params.isEmpty() && isChannelName(params[0])) {
90 banChannel = params.takeFirst();
91 } else if(bufferInfo.type() == BufferInfo::ChannelBuffer) {
92 banChannel = bufferInfo.bufferName();
94 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Error: channel unknown in command: /BAN %1").arg(msg));
98 if(!params.isEmpty() && !params.contains("!") && network()->ircUser(params[0])) {
99 IrcUser *ircuser = network()->ircUser(params[0]);
100 // generalizedHost changes <nick> to *!ident@*.sld.tld.
101 QString generalizedHost = ircuser->host();
102 if(generalizedHost.isEmpty()) {
103 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Error: host unknown in command: /BAN %1").arg(msg));
107 static QRegExp ipAddress("\\d+\\.\\d+\\.\\d+\\.\\d+");
108 if(ipAddress.exactMatch(generalizedHost)) {
109 int lastDotPos = generalizedHost.lastIndexOf('.') + 1;
110 generalizedHost.replace(lastDotPos, generalizedHost.length() - lastDotPos, '*');
111 } else if(generalizedHost.lastIndexOf(".") != -1 && generalizedHost.lastIndexOf(".", generalizedHost.lastIndexOf(".")-1) != -1) {
112 int secondLastPeriodPosition = generalizedHost.lastIndexOf(".", generalizedHost.lastIndexOf(".")-1);
113 generalizedHost.replace(0, secondLastPeriodPosition, "*");
115 banUser = QString("*!%1@%2").arg(ircuser->user(), generalizedHost);
117 banUser = params.join(" ");
120 QString banMode = ban ? "+b" : "-b";
121 QString banMsg = QString("MODE %1 %2 %3").arg(banChannel, banMode, banUser);
122 emit putRawLine(serverEncode(banMsg));
125 void UserInputHandler::handleCtcp(const BufferInfo &bufferInfo, const QString &msg) {
128 QString nick = msg.section(' ', 0, 0);
129 QString ctcpTag = msg.section(' ', 1, 1).toUpper();
130 if(ctcpTag.isEmpty())
133 QString message = "";
134 QString verboseMessage = tr("sending CTCP-%1 request").arg(ctcpTag);
136 if(ctcpTag == "PING") {
137 uint now = QDateTime::currentDateTime().toTime_t();
138 message = QString::number(now);
141 network()->ctcpHandler()->query(nick, ctcpTag, message);
142 emit displayMsg(Message::Action, BufferInfo::StatusBuffer, "", verboseMessage, network()->myNick());
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';
149 params << bufferInfo.bufferName() << m << nicks;
150 emit putCmd("MODE", serverEncode(params));
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';
157 params << bufferInfo.bufferName() << m << nicks;
158 emit putCmd("MODE", serverEncode(params));
161 void UserInputHandler::handleInvite(const BufferInfo &bufferInfo, const QString &msg) {
163 params << msg << bufferInfo.bufferName();
164 emit putCmd("INVITE", serverEncode(params));
167 void UserInputHandler::handleJoin(const BufferInfo &bufferInfo, const QString &msg) {
168 Q_UNUSED(bufferInfo);
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(",");
177 for(i = 0; i < chans.count(); i++) {
178 if(!network()->isChannelName(chans[i]))
179 chans[i].prepend('#');
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!
185 for(; i < keys.count(); i++) {
186 if(i >= chans.count()) break;
187 network()->addChannelKey(chans[i], keys[i]);
189 for(; i < chans.count(); i++) {
190 network()->removeChannelKey(chans[i]);
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();
198 reason = network()->identityPtr()->kickReason();
200 QList<QByteArray> params;
201 params << serverEncode(bufferInfo.bufferName()) << serverEncode(nick) << channelEncode(bufferInfo.bufferName(), reason);
202 emit putCmd("KICK", params);
205 void UserInputHandler::handleKill(const BufferInfo &bufferInfo, const QString &msg) {
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);
215 void UserInputHandler::handleList(const BufferInfo &bufferInfo, const QString &msg) {
217 emit putCmd("LIST", serverEncode(msg.split(' ', QString::SkipEmptyParts)));
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);
226 void UserInputHandler::handleMode(const BufferInfo &bufferInfo, const QString &msg) {
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());
234 // TODO handle correct encoding for buffer modes (channelEncode())
235 emit putCmd("MODE", serverEncode(params));
238 // TODO: show privmsgs
239 void UserInputHandler::handleMsg(const BufferInfo &bufferInfo, const QString &msg) {
240 Q_UNUSED(bufferInfo);
241 if(!msg.contains(' '))
244 QByteArray target = serverEncode(msg.section(' ', 0, 0));
245 putPrivmsg(target, userEncode(target, msg.section(' ', 1)));
248 void UserInputHandler::handleNick(const BufferInfo &bufferInfo, const QString &msg) {
250 QString nick = msg.section(' ', 0, 0);
251 emit putCmd("NICK", serverEncode(nick));
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);
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';
267 params << bufferInfo.bufferName() << m << nicks;
268 emit putCmd("MODE", serverEncode(params));
271 void UserInputHandler::handleOper(const BufferInfo &bufferInfo, const QString &msg) {
273 emit putRawLine(serverEncode(QString("OPER %1").arg(msg)));
276 void UserInputHandler::handlePart(const BufferInfo &bufferInfo, const QString &msg) {
277 QList<QByteArray> params;
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();
286 partReason = msg.mid(channelName.length() + 1);
289 if(partReason.isEmpty())
290 partReason = network()->identityPtr()->partReason();
292 params << serverEncode(channelName) << channelEncode(bufferInfo.bufferName(), partReason);
293 emit putCmd("PART", params);
296 void UserInputHandler::handlePing(const BufferInfo &bufferInfo, const QString &msg) {
301 param = QTime::currentTime().toString("hh:mm:ss.zzz");
303 putCmd("PING", serverEncode(param));
306 // TODO: implement queries
307 void UserInputHandler::handleQuery(const BufferInfo &bufferInfo, const QString &msg) {
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);
314 emit displayMsg(Message::Plain, BufferInfo::QueryBuffer, target, message, network()->myNick(), Message::Self);
315 handleMsg(bufferInfo, msg);
318 void UserInputHandler::handleQuit(const BufferInfo &bufferInfo, const QString &msg) {
320 network()->disconnectFromIrc(true, msg);
323 void UserInputHandler::issueQuit(const QString &reason) {
326 quitReason = network()->identityPtr()->quitReason();
329 emit putCmd("QUIT", serverEncode(quitReason));
332 void UserInputHandler::handleQuote(const BufferInfo &bufferInfo, const QString &msg) {
334 emit putRawLine(serverEncode(msg));
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);
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());
349 params << channelEncode(bufferInfo.bufferName(), msg);
350 emit putCmd("TOPIC", params);
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';
357 params << bufferInfo.bufferName() << m << nicks;
358 emit putCmd("MODE", serverEncode(params));
361 void UserInputHandler::handleWait(const BufferInfo &bufferInfo, const QString &msg) {
362 int splitPos = msg.indexOf(';');
367 int delay = msg.left(splitPos).trimmed().toInt(&ok);
373 QString command = msg.mid(splitPos + 1).trimmed();
374 if(command.isEmpty())
377 _delayedCommands[startTimer(delay)] = Command(bufferInfo, command);
380 void UserInputHandler::handleWho(const BufferInfo &bufferInfo, const QString &msg) {
382 emit putCmd("WHO", serverEncode(msg.split(' ')));
385 void UserInputHandler::handleWhois(const BufferInfo &bufferInfo, const QString &msg) {
387 emit putCmd("WHOIS", serverEncode(msg.split(' ')));
390 void UserInputHandler::handleWhowas(const BufferInfo &bufferInfo, const QString &msg) {
392 emit putCmd("WHOWAS", serverEncode(msg.split(' ')));
395 void UserInputHandler::defaultHandler(QString cmd, const BufferInfo &bufferInfo, const QString &msg) {
396 for(int i = 0; i < coreSession()->aliasManager().count(); i++) {
397 if(coreSession()->aliasManager()[i].name.toLower() == cmd.toLower()) {
398 expand(coreSession()->aliasManager()[i].expansion, bufferInfo, msg);
402 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Error: %1 %2").arg(cmd, msg));
405 void UserInputHandler::expand(const QString &alias, const BufferInfo &bufferInfo, const QString &msg) {
406 QRegExp paramRangeR("\\$(\\d+)\\.\\.(\\d*)");
407 QStringList commands = alias.split(QRegExp("; ?"));
408 QStringList params = msg.split(' ');
409 QStringList expandedCommands;
410 for(int i = 0; i < commands.count(); i++) {
411 QString command = commands[i];
413 // replace ranges like $1..3
414 if(!params.isEmpty()) {
416 while((pos = paramRangeR.indexIn(command)) != -1) {
417 int start = paramRangeR.cap(1).toInt();
419 int end = paramRangeR.cap(2).toInt(&ok);
421 end = params.count();
424 command = command.replace(pos, paramRangeR.matchedLength(), QString());
426 command = command.replace(pos, paramRangeR.matchedLength(), QStringList(params.mid(start - 1, end - start + 1)).join(" "));
431 for(int j = params.count(); j > 0; j--) {
432 IrcUser *ircUser = network()->ircUser(params[j - 1]);
433 command = command.replace(QString("$%1:hostname").arg(j), ircUser ? ircUser->host() : QString("*"));
434 command = command.replace(QString("$%1").arg(j), params[j - 1]);
436 command = command.replace("$0", msg);
437 command = command.replace("$channelname", bufferInfo.bufferName());
438 command = command.replace("$currentnick", network()->myNick());
439 expandedCommands << command;
442 while(!expandedCommands.isEmpty()) {
444 if(expandedCommands[0].trimmed().toLower().startsWith("/wait")) {
445 command = expandedCommands.join("; ");
446 expandedCommands.clear();
448 command = expandedCommands.takeFirst();
450 handleUserInput(bufferInfo, command);
455 void UserInputHandler::putPrivmsg(const QByteArray &target, const QByteArray &message) {
456 static const char *cmd = "PRIVMSG";
457 int overrun = lastParamOverrun(cmd, QList<QByteArray>() << message);
459 static const char *splitter = " .,-";
460 int maxSplitPos = message.count() - overrun;
462 for(const char *splitChar = splitter; *splitChar != 0; splitChar++) {
463 splitPos = qMax(splitPos, message.lastIndexOf(*splitChar, maxSplitPos));
466 splitPos = maxSplitPos;
468 putCmd(cmd, QList<QByteArray>() << target << message.left(splitPos));
469 putPrivmsg(target, message.mid(splitPos));
472 putCmd(cmd, QList<QByteArray>() << target << message);
476 // returns 0 if the message will not be chopped by the irc server or number of chopped bytes if message is too long
477 int UserInputHandler::lastParamOverrun(const QString &cmd, const QList<QByteArray> ¶ms) {
478 // the server will pass our message trunkated to 512 bytes including CRLF with the following format:
479 // ":prefix COMMAND param0 param1 :lastparam"
480 // where prefix = "nickname!user@host"
481 // that means that the last message can be as long as:
482 // 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)
483 IrcUser *me = network()->me();
484 int maxLen = 480 - cmd.toAscii().count(); // educated guess in case we don't know us (yet?)
487 maxLen = 512 - serverEncode(me->nick()).count() - serverEncode(me->user()).count() - serverEncode(me->host()).count() - cmd.toAscii().count() - 6;
489 if(!params.isEmpty()) {
490 for(int i = 0; i < params.count() - 1; i++) {
491 maxLen -= (params[i].count() + 1);
493 maxLen -= 2; // " :" last param separator;
495 if(params.last().count() > maxLen) {
496 return params.last().count() - maxLen;
506 void UserInputHandler::timerEvent(QTimerEvent *event) {
507 if(!_delayedCommands.contains(event->timerId())) {
508 QObject::timerEvent(event);
511 BufferInfo bufferInfo = _delayedCommands[event->timerId()].bufferInfo;
512 QString rawCommand = _delayedCommands[event->timerId()].command;
513 _delayedCommands.remove(event->timerId());
516 // the stored command might be the result of an alias expansion, so we need to split it up again
517 QStringList commands = rawCommand.split(QRegExp("; ?"));
518 foreach(QString command, commands) {
519 handleUserInput(bufferInfo, command);