1 /***************************************************************************
2 * Copyright (C) 2005-10 by the Quassel Project *
3 * devel@quassel-irc.org *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) version 3. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
20 #include "coreuserinputhandler.h"
24 #include "ctcphandler.h"
25 #include "coreidentity.h"
35 CoreUserInputHandler::CoreUserInputHandler(CoreNetwork *parent)
36 : CoreBasicHandler(parent)
40 void CoreUserInputHandler::handleUserInput(const BufferInfo &bufferInfo, const QString &msg) {
44 AliasManager::CommandList list = coreSession()->aliasManager().processInput(bufferInfo, msg);
46 for(int i = 0; i < list.count(); i++) {
47 QString cmd = list.at(i).second.section(' ', 0, 0).remove(0, 1).toUpper();
48 QString payload = list.at(i).second.section(' ', 1);
49 handle(cmd, Q_ARG(BufferInfo, list.at(i).first), Q_ARG(QString, payload));
53 // ====================
55 // ====================
56 void CoreUserInputHandler::handleAway(const BufferInfo &bufferInfo, const QString &msg) {
58 if(msg.startsWith("-all")) {
59 if(msg.length() == 4) {
60 coreSession()->globalAway();
63 Q_ASSERT(msg.length() > 4);
65 coreSession()->globalAway(msg.mid(5));
72 void CoreUserInputHandler::issueAway(const QString &msg, bool autoCheck) {
73 QString awayMsg = msg;
74 IrcUser *me = network()->me();
76 // if there is no message supplied we have to check if we are already away or not
77 if(autoCheck && msg.isEmpty()) {
78 if(me && !me->isAway()) {
79 Identity *identity = network()->identityPtr();
81 awayMsg = identity->awayReason();
83 if(awayMsg.isEmpty()) {
89 me->setAwayMessage(awayMsg);
91 putCmd("AWAY", serverEncode(awayMsg));
94 void CoreUserInputHandler::handleBan(const BufferInfo &bufferInfo, const QString &msg) {
95 banOrUnban(bufferInfo, msg, true);
98 void CoreUserInputHandler::handleUnban(const BufferInfo &bufferInfo, const QString &msg) {
99 banOrUnban(bufferInfo, msg, false);
102 void CoreUserInputHandler::banOrUnban(const BufferInfo &bufferInfo, const QString &msg, bool ban) {
106 QStringList params = msg.split(" ");
108 if(!params.isEmpty() && isChannelName(params[0])) {
109 banChannel = params.takeFirst();
110 } else if(bufferInfo.type() == BufferInfo::ChannelBuffer) {
111 banChannel = bufferInfo.bufferName();
113 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Error: channel unknown in command: /BAN %1").arg(msg));
117 if(!params.isEmpty() && !params.contains("!") && network()->ircUser(params[0])) {
118 IrcUser *ircuser = network()->ircUser(params[0]);
119 // generalizedHost changes <nick> to *!ident@*.sld.tld.
120 QString generalizedHost = ircuser->host();
121 if(generalizedHost.isEmpty()) {
122 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Error: host unknown in command: /BAN %1").arg(msg));
126 static QRegExp ipAddress("\\d+\\.\\d+\\.\\d+\\.\\d+");
127 if(ipAddress.exactMatch(generalizedHost)) {
128 int lastDotPos = generalizedHost.lastIndexOf('.') + 1;
129 generalizedHost.replace(lastDotPos, generalizedHost.length() - lastDotPos, '*');
130 } else if(generalizedHost.lastIndexOf(".") != -1 && generalizedHost.lastIndexOf(".", generalizedHost.lastIndexOf(".")-1) != -1) {
131 int secondLastPeriodPosition = generalizedHost.lastIndexOf(".", generalizedHost.lastIndexOf(".")-1);
132 generalizedHost.replace(0, secondLastPeriodPosition, "*");
134 banUser = QString("*!%1@%2").arg(ircuser->user(), generalizedHost);
136 banUser = params.join(" ");
139 QString banMode = ban ? "+b" : "-b";
140 QString banMsg = QString("MODE %1 %2 %3").arg(banChannel, banMode, banUser);
141 emit putRawLine(serverEncode(banMsg));
144 void CoreUserInputHandler::handleCtcp(const BufferInfo &bufferInfo, const QString &msg) {
147 QString nick = msg.section(' ', 0, 0);
148 QString ctcpTag = msg.section(' ', 1, 1).toUpper();
149 if(ctcpTag.isEmpty())
152 QString message = msg.section(' ', 2);
153 QString verboseMessage = tr("sending CTCP-%1 request to %2").arg(ctcpTag).arg(nick);
155 if(ctcpTag == "PING") {
156 uint now = QDateTime::currentDateTime().toTime_t();
157 message = QString::number(now);
160 network()->ctcpHandler()->query(nick, ctcpTag, message);
161 emit displayMsg(Message::Action, BufferInfo::StatusBuffer, "", verboseMessage, network()->myNick());
164 void CoreUserInputHandler::handleDelkey(const BufferInfo &bufferInfo, const QString &msg) {
166 if (!bufferInfo.isValid())
169 QStringList parms = msg.split(' ', QString::SkipEmptyParts);
171 if(parms.isEmpty() && !bufferInfo.bufferName().isEmpty())
172 parms.prepend(bufferInfo.bufferName());
174 if(parms.isEmpty()) {
175 QString message = tr("[usage] /delkey <nick|channel> deletes the encryption key for nick or channel or just /delkey when in a channel or query.");
177 if(bufferInfo.bufferName().isEmpty())
178 emit displayMsg(Message::Info, BufferInfo::StatusBuffer, "", message);
180 emit displayMsg(Message::Info, bufferInfo.bufferName(), message);
184 if(network()->bufferKey(parms[0]).isEmpty()) {
185 QString message = tr("No key has been set for %1.").arg(parms[0]);
187 if(bufferInfo.bufferName().isEmpty())
188 emit displayMsg(Message::Info, BufferInfo::StatusBuffer, "", message);
190 emit displayMsg(Message::Info, bufferInfo.bufferName(), message);
194 network()->setBufferKey(parms[0], "");
196 if(network()->isChannelName(parms[0]) && network()->channels().contains(parms[0])) {
197 network()->ircChannel(parms[0])->setEncrypted(false);
199 else if(network()->nicks().contains(parms[0])) {
200 network()->ircUser(parms[0])->setEncrypted(false);
203 QString message = tr("The key for %1 has been deleted.").arg(parms[0]);
205 if(bufferInfo.bufferName().isEmpty())
206 emit displayMsg(Message::Info, BufferInfo::StatusBuffer, "", message);
208 emit displayMsg(Message::Info, bufferInfo.bufferName(), message);
211 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Error: Setting an encryption key requires Quassel to have been built "
212 "with support for the Qt Cryptographic Architecture (QCA) library. "
213 "Contact your distributor about a Quassel package with QCA "
214 "support, or rebuild Quassel with QCA present."));
218 void CoreUserInputHandler::handleDeop(const BufferInfo &bufferInfo, const QString &msg) {
219 QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
220 QString m = "-"; for(int i = 0; i < nicks.count(); i++) m += 'o';
222 params << bufferInfo.bufferName() << m << nicks;
223 emit putCmd("MODE", serverEncode(params));
226 void CoreUserInputHandler::handleDevoice(const BufferInfo &bufferInfo, const QString &msg) {
227 QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
228 QString m = "-"; for(int i = 0; i < nicks.count(); i++) m += 'v';
230 params << bufferInfo.bufferName() << m << nicks;
231 emit putCmd("MODE", serverEncode(params));
234 void CoreUserInputHandler::handleInvite(const BufferInfo &bufferInfo, const QString &msg) {
236 params << msg << bufferInfo.bufferName();
237 emit putCmd("INVITE", serverEncode(params));
240 void CoreUserInputHandler::handleJoin(const BufferInfo &bufferInfo, const QString &msg) {
241 Q_UNUSED(bufferInfo);
243 // trim spaces before chans or keys
244 QString sane_msg = msg;
245 sane_msg.replace(QRegExp(", +"), ",");
246 QStringList params = sane_msg.trimmed().split(" ");
248 QStringList chans = params[0].split(",", QString::SkipEmptyParts);
250 if(params.count() > 1)
251 keys = params[1].split(",");
254 for(i = 0; i < chans.count(); i++) {
255 if(!network()->isChannelName(chans[i]))
256 chans[i].prepend('#');
258 if(i < keys.count()) {
259 network()->addChannelKey(chans[i], keys[i]);
261 network()->removeChannelKey(chans[i]);
265 static const char *cmd = "JOIN";
267 QStringList joinChans, joinKeys;
268 int slicesize = chans.count();
269 QList<QByteArray> encodedParams;
271 // go through all to-be-joined channels and (re)build the join list
272 while(i < chans.count()) {
273 joinChans.append(chans.at(i));
275 joinKeys.append(keys.at(i));
277 // if the channel list we built so far either contains all requested channels or exceeds
278 // the desired amount of channels in this slice, try to send what we have so far
279 if(++i == chans.count() || joinChans.count() >= slicesize) {
281 params.append(joinChans.join(","));
282 params.append(joinKeys.join(","));
283 encodedParams = serverEncode(params);
284 // check if it fits in one command
285 if(lastParamOverrun(cmd, encodedParams) == 0) {
286 emit putCmd(cmd, encodedParams);
287 } else if(slicesize > 1) {
288 // back to start of slice, try again with half the amount of channels
298 void CoreUserInputHandler::handleKick(const BufferInfo &bufferInfo, const QString &msg) {
299 QString nick = msg.section(' ', 0, 0, QString::SectionSkipEmpty);
300 QString reason = msg.section(' ', 1, -1, QString::SectionSkipEmpty).trimmed();
302 reason = network()->identityPtr()->kickReason();
304 QList<QByteArray> params;
305 params << serverEncode(bufferInfo.bufferName()) << serverEncode(nick) << channelEncode(bufferInfo.bufferName(), reason);
306 emit putCmd("KICK", params);
309 void CoreUserInputHandler::handleKill(const BufferInfo &bufferInfo, const QString &msg) {
311 QString nick = msg.section(' ', 0, 0, QString::SectionSkipEmpty);
312 QString pass = msg.section(' ', 1, -1, QString::SectionSkipEmpty);
313 QList<QByteArray> params;
314 params << serverEncode(nick) << serverEncode(pass);
315 emit putCmd("KILL", params);
319 void CoreUserInputHandler::handleList(const BufferInfo &bufferInfo, const QString &msg) {
321 emit putCmd("LIST", serverEncode(msg.split(' ', QString::SkipEmptyParts)));
324 void CoreUserInputHandler::handleMe(const BufferInfo &bufferInfo, const QString &msg) {
325 if(bufferInfo.bufferName().isEmpty()) return; // server buffer
326 network()->ctcpHandler()->query(bufferInfo.bufferName(), "ACTION", msg);
327 emit displayMsg(Message::Action, bufferInfo.type(), bufferInfo.bufferName(), msg, network()->myNick(), Message::Self);
330 void CoreUserInputHandler::handleMode(const BufferInfo &bufferInfo, const QString &msg) {
333 QStringList params = msg.split(' ', QString::SkipEmptyParts);
334 // 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
335 if(!params.isEmpty()) {
336 if(!network()->isChannelName(params[0]) && !network()->isMyNick(params[0]))
337 params.prepend(bufferInfo.bufferName());
338 if(network()->isMyNick(params[0]) && params.count() == 2)
339 network()->updateIssuedModes(params[1]);
340 if(params[0] == "-reset" && params.count() == 1) {
341 // FIXME: give feedback to the user (I don't want to add new strings right now)
342 network()->resetPersistentModes();
347 // TODO handle correct encoding for buffer modes (channelEncode())
348 emit putCmd("MODE", serverEncode(params));
351 // TODO: show privmsgs
352 void CoreUserInputHandler::handleMsg(const BufferInfo &bufferInfo, const QString &msg) {
353 Q_UNUSED(bufferInfo);
354 if(!msg.contains(' '))
357 QByteArray target = serverEncode(msg.section(' ', 0, 0));
358 putPrivmsg(target, userEncode(target, msg.section(' ', 1)), false);
361 void CoreUserInputHandler::handleNick(const BufferInfo &bufferInfo, const QString &msg) {
363 QString nick = msg.section(' ', 0, 0);
364 emit putCmd("NICK", serverEncode(nick));
367 void CoreUserInputHandler::handleNotice(const BufferInfo &bufferInfo, const QString &msg) {
368 QString bufferName = msg.section(' ', 0, 0);
369 QString payload = msg.section(' ', 1);
370 QList<QByteArray> params;
371 params << serverEncode(bufferName) << channelEncode(bufferInfo.bufferName(), payload);
372 emit putCmd("NOTICE", params);
373 emit displayMsg(Message::Notice, bufferName, payload, network()->myNick(), Message::Self);
376 void CoreUserInputHandler::handleOp(const BufferInfo &bufferInfo, const QString &msg) {
377 QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
378 QString m = "+"; for(int i = 0; i < nicks.count(); i++) m += 'o';
380 params << bufferInfo.bufferName() << m << nicks;
381 emit putCmd("MODE", serverEncode(params));
384 void CoreUserInputHandler::handleOper(const BufferInfo &bufferInfo, const QString &msg) {
386 emit putRawLine(serverEncode(QString("OPER %1").arg(msg)));
389 void CoreUserInputHandler::handlePart(const BufferInfo &bufferInfo, const QString &msg) {
390 QList<QByteArray> params;
393 // msg might contain either a channel name and/or a reaon, so we have to check if the first word is a known channel
394 QString channelName = msg.section(' ', 0, 0);
395 if(channelName.isEmpty() || !network()->ircChannel(channelName)) {
396 channelName = bufferInfo.bufferName();
399 partReason = msg.mid(channelName.length() + 1);
402 if(partReason.isEmpty())
403 partReason = network()->identityPtr()->partReason();
405 params << serverEncode(channelName) << channelEncode(bufferInfo.bufferName(), partReason);
406 emit putCmd("PART", params);
409 void CoreUserInputHandler::handlePing(const BufferInfo &bufferInfo, const QString &msg) {
414 param = QTime::currentTime().toString("hh:mm:ss.zzz");
416 putCmd("PING", serverEncode(param));
419 // TODO: implement queries
420 void CoreUserInputHandler::handleQuery(const BufferInfo &bufferInfo, const QString &msg) {
422 QString target = msg.section(' ', 0, 0);
423 QString message = msg.section(' ', 1);
424 if(message.isEmpty())
425 emit displayMsg(Message::Server, BufferInfo::QueryBuffer, target, "Starting query with " + target, network()->myNick(), Message::Self);
427 emit displayMsg(Message::Plain, BufferInfo::QueryBuffer, target, message, network()->myNick(), Message::Self);
428 handleMsg(bufferInfo, msg);
431 void CoreUserInputHandler::handleQuit(const BufferInfo &bufferInfo, const QString &msg) {
433 network()->disconnectFromIrc(true, msg);
436 void CoreUserInputHandler::issueQuit(const QString &reason) {
437 emit putCmd("QUIT", serverEncode(reason));
440 void CoreUserInputHandler::handleQuote(const BufferInfo &bufferInfo, const QString &msg) {
442 emit putRawLine(serverEncode(msg));
445 void CoreUserInputHandler::handleSay(const BufferInfo &bufferInfo, const QString &msg) {
446 if(bufferInfo.bufferName().isEmpty())
447 return; // server buffer
448 putPrivmsg(serverEncode(bufferInfo.bufferName()), channelEncode(bufferInfo.bufferName(), msg), false);
449 emit displayMsg(Message::Plain, bufferInfo.type(), bufferInfo.bufferName(), msg, network()->myNick(), Message::Self);
452 void CoreUserInputHandler::handleSetkey(const BufferInfo &bufferInfo, const QString &msg) {
454 if(!bufferInfo.isValid())
457 QStringList parms = msg.split(' ', QString::SkipEmptyParts);
459 if(parms.count() == 1 && !bufferInfo.bufferName().isEmpty())
460 parms.prepend(bufferInfo.bufferName());
461 else if(parms.count() != 2) {
462 QString message =tr("[usage] /setkey <nick|channel> <key> sets the encryption key for nick or channel. /setkey <key> when in a channel or query buffer sets the key for it.");
464 if(bufferInfo.bufferName().isEmpty())
465 emit displayMsg(Message::Info, BufferInfo::StatusBuffer, "", message);
467 emit displayMsg(Message::Info, bufferInfo.bufferName(), message);
470 network()->setBufferKey(parms[0], parms[1].toLocal8Bit());
472 if(network()->isChannelName(parms[0]) && network()->channels().contains(parms[0]))
473 network()->ircChannel(parms[0])->setEncrypted(true);
474 else if(network()->nicks().contains(parms[0]))
475 network()->ircUser(parms[0])->setEncrypted(true);
477 QString message = tr("The key for %1 has been set.").arg(parms[0]);
478 if (bufferInfo.bufferName().isEmpty())
479 emit displayMsg(Message::Info, BufferInfo::StatusBuffer, "", message);
481 emit displayMsg(Message::Info, bufferInfo.bufferName(), message);
483 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Error: Setting an encryption key requires Quassel to have been built "
484 "with support for the Qt Cryptographic Architecture (QCA) library. "
485 "Contact your distributor about a Quassel package with QCA "
486 "support, or rebuild Quassel with QCA present."));
490 void CoreUserInputHandler::handleTopic(const BufferInfo &bufferInfo, const QString &msg) {
491 if(bufferInfo.bufferName().isEmpty()) return;
492 QList<QByteArray> params;
493 params << serverEncode(bufferInfo.bufferName());
496 const QByteArray bufferName = bufferInfo.bufferName().toAscii();
497 QByteArray message = channelEncode(bufferInfo.bufferName(), msg);
498 params << encrypt(bufferName, message);
500 params << channelEncode(bufferInfo.bufferName(), msg);
504 emit putCmd("TOPIC", params);
507 void CoreUserInputHandler::handleVoice(const BufferInfo &bufferInfo, const QString &msg) {
508 QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
509 QString m = "+"; for(int i = 0; i < nicks.count(); i++) m += 'v';
511 params << bufferInfo.bufferName() << m << nicks;
512 emit putCmd("MODE", serverEncode(params));
515 void CoreUserInputHandler::handleWait(const BufferInfo &bufferInfo, const QString &msg) {
516 int splitPos = msg.indexOf(';');
521 int delay = msg.left(splitPos).trimmed().toInt(&ok);
527 QString command = msg.mid(splitPos + 1).trimmed();
528 if(command.isEmpty())
531 _delayedCommands[startTimer(delay)] = Command(bufferInfo, command);
534 void CoreUserInputHandler::handleWho(const BufferInfo &bufferInfo, const QString &msg) {
536 emit putCmd("WHO", serverEncode(msg.split(' ')));
539 void CoreUserInputHandler::handleWhois(const BufferInfo &bufferInfo, const QString &msg) {
541 emit putCmd("WHOIS", serverEncode(msg.split(' ')));
544 void CoreUserInputHandler::handleWhowas(const BufferInfo &bufferInfo, const QString &msg) {
546 emit putCmd("WHOWAS", serverEncode(msg.split(' ')));
549 void CoreUserInputHandler::defaultHandler(QString cmd, const BufferInfo &bufferInfo, const QString &msg) {
550 Q_UNUSED(bufferInfo);
551 emit putCmd(serverEncode(cmd.toUpper()), serverEncode(msg.split(" ")));
554 void CoreUserInputHandler::putPrivmsg(const QByteArray &target, const QByteArray &message, bool encrypted) {
556 QByteArray temp = message;
560 temp = encrypt(target, temp);
565 static const char *cmd = "PRIVMSG";
566 int overrun = lastParamOverrun(cmd, QList<QByteArray>() << target << temp);
568 static const char *splitter = " .,-";
569 int maxSplitPos = temp.count() - overrun;
571 for(const char *splitChar = splitter; *splitChar != 0; splitChar++) {
572 splitPos = qMax(splitPos, temp.lastIndexOf(*splitChar, maxSplitPos));
575 splitPos = maxSplitPos;
577 putCmd(cmd, QList<QByteArray>() << target << temp.left(splitPos));
578 putPrivmsg(target, temp.mid(splitPos), encrypted);
581 putCmd(cmd, QList<QByteArray>() << target << temp);
585 // returns 0 if the message will not be chopped by the irc server or number of chopped bytes if message is too long
586 int CoreUserInputHandler::lastParamOverrun(const QString &cmd, const QList<QByteArray> ¶ms) {
587 // the server will pass our message truncated to 512 bytes including CRLF with the following format:
588 // ":prefix COMMAND param0 param1 :lastparam"
589 // where prefix = "nickname!user@host"
590 // that means that the last message can be as long as:
591 // 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)
592 IrcUser *me = network()->me();
593 int maxLen = 480 - cmd.toAscii().count(); // educated guess in case we don't know us (yet?)
596 maxLen = 512 - serverEncode(me->nick()).count() - serverEncode(me->user()).count() - serverEncode(me->host()).count() - cmd.toAscii().count() - 6;
598 if(!params.isEmpty()) {
599 for(int i = 0; i < params.count() - 1; i++) {
600 maxLen -= (params[i].count() + 1);
602 maxLen -= 2; // " :" last param separator;
604 if(params.last().count() > maxLen) {
605 return params.last().count() - maxLen;
615 QByteArray CoreUserInputHandler::encrypt(const QByteArray &target, QByteArray &message) {
619 if(message.isEmpty())
622 QByteArray key = network()->bufferKey(target);
626 IrcChannel *channel = network()->ircChannel(target);
627 IrcUser *user = network()->ircUser(target);
629 if(channel && channel->cipher()->setKey(key))
630 channel->cipher()->encrypt(message);
631 else if(user && user->cipher()->setKey(key))
632 user->cipher()->encrypt(message);
638 void CoreUserInputHandler::timerEvent(QTimerEvent *event) {
639 if(!_delayedCommands.contains(event->timerId())) {
640 QObject::timerEvent(event);
643 BufferInfo bufferInfo = _delayedCommands[event->timerId()].bufferInfo;
644 QString rawCommand = _delayedCommands[event->timerId()].command;
645 _delayedCommands.remove(event->timerId());
648 // the stored command might be the result of an alias expansion, so we need to split it up again
649 QStringList commands = rawCommand.split(QRegExp("; ?"));
650 foreach(QString command, commands) {
651 handleUserInput(bufferInfo, command);