1 /***************************************************************************
2 * Copyright (C) 2005-2010 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"
32 CoreUserInputHandler::CoreUserInputHandler(CoreNetwork *parent)
33 : CoreBasicHandler(parent)
37 void CoreUserInputHandler::handleUserInput(const BufferInfo &bufferInfo, const QString &msg) {
41 AliasManager::CommandList list = coreSession()->aliasManager().processInput(bufferInfo, msg);
43 for(int i = 0; i < list.count(); i++) {
44 QString cmd = list.at(i).second.section(' ', 0, 0).remove(0, 1).toUpper();
45 QString payload = list.at(i).second.section(' ', 1);
46 handle(cmd, Q_ARG(BufferInfo, list.at(i).first), Q_ARG(QString, payload));
50 // ====================
52 // ====================
53 void CoreUserInputHandler::handleAway(const BufferInfo &bufferInfo, const QString &msg) {
55 if(msg.startsWith("-all")) {
56 if(msg.length() == 4) {
57 coreSession()->globalAway();
60 Q_ASSERT(msg.length() > 4);
62 coreSession()->globalAway(msg.mid(5));
69 void CoreUserInputHandler::issueAway(const QString &msg, bool autoCheck) {
70 QString awayMsg = msg;
71 IrcUser *me = network()->me();
73 // if there is no message supplied we have to check if we are already away or not
74 if(autoCheck && msg.isEmpty()) {
75 if(me && !me->isAway()) {
76 Identity *identity = network()->identityPtr();
78 awayMsg = identity->awayReason();
80 if(awayMsg.isEmpty()) {
86 me->setAwayMessage(awayMsg);
88 putCmd("AWAY", serverEncode(awayMsg));
91 void CoreUserInputHandler::handleBan(const BufferInfo &bufferInfo, const QString &msg) {
92 banOrUnban(bufferInfo, msg, true);
95 void CoreUserInputHandler::handleUnban(const BufferInfo &bufferInfo, const QString &msg) {
96 banOrUnban(bufferInfo, msg, false);
99 void CoreUserInputHandler::banOrUnban(const BufferInfo &bufferInfo, const QString &msg, bool ban) {
103 QStringList params = msg.split(" ");
105 if(!params.isEmpty() && isChannelName(params[0])) {
106 banChannel = params.takeFirst();
107 } else if(bufferInfo.type() == BufferInfo::ChannelBuffer) {
108 banChannel = bufferInfo.bufferName();
110 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Error: channel unknown in command: /BAN %1").arg(msg));
114 if(!params.isEmpty() && !params.contains("!") && network()->ircUser(params[0])) {
115 IrcUser *ircuser = network()->ircUser(params[0]);
116 // generalizedHost changes <nick> to *!ident@*.sld.tld.
117 QString generalizedHost = ircuser->host();
118 if(generalizedHost.isEmpty()) {
119 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", QString("Error: host unknown in command: /BAN %1").arg(msg));
123 static QRegExp ipAddress("\\d+\\.\\d+\\.\\d+\\.\\d+");
124 if(ipAddress.exactMatch(generalizedHost)) {
125 int lastDotPos = generalizedHost.lastIndexOf('.') + 1;
126 generalizedHost.replace(lastDotPos, generalizedHost.length() - lastDotPos, '*');
127 } else if(generalizedHost.lastIndexOf(".") != -1 && generalizedHost.lastIndexOf(".", generalizedHost.lastIndexOf(".")-1) != -1) {
128 int secondLastPeriodPosition = generalizedHost.lastIndexOf(".", generalizedHost.lastIndexOf(".")-1);
129 generalizedHost.replace(0, secondLastPeriodPosition, "*");
131 banUser = QString("*!%1@%2").arg(ircuser->user(), generalizedHost);
133 banUser = params.join(" ");
136 QString banMode = ban ? "+b" : "-b";
137 QString banMsg = QString("MODE %1 %2 %3").arg(banChannel, banMode, banUser);
138 emit putRawLine(serverEncode(banMsg));
141 void CoreUserInputHandler::handleCtcp(const BufferInfo &bufferInfo, const QString &msg) {
144 QString nick = msg.section(' ', 0, 0);
145 QString ctcpTag = msg.section(' ', 1, 1).toUpper();
146 if(ctcpTag.isEmpty())
149 QString message = msg.section(' ', 2);
150 QString verboseMessage = tr("sending CTCP-%1 request to %2").arg(ctcpTag).arg(nick);
152 if(ctcpTag == "PING") {
153 uint now = QDateTime::currentDateTime().toTime_t();
154 message = QString::number(now);
157 network()->ctcpHandler()->query(nick, ctcpTag, message);
158 emit displayMsg(Message::Action, BufferInfo::StatusBuffer, "", verboseMessage, network()->myNick());
161 void CoreUserInputHandler::handleDelkey(const BufferInfo &bufferInfo, const QString &msg) {
163 if(!bufferInfo.isValid())
166 if(!Cipher::neededFeaturesAvailable())
169 QStringList parms = msg.split(' ', QString::SkipEmptyParts);
171 if(parms.isEmpty() && !bufferInfo.bufferName().isEmpty())
172 parms.prepend(bufferInfo.bufferName());
174 if(parms.isEmpty()) {
175 emit displayMsg(Message::Info, bufferInfo.bufferName(), "",
176 tr("[usage] /delkey <nick|channel> deletes the encryption key for nick or channel or just /delkey when in a channel or query."));
180 QString target = parms.at(0);
182 if(network()->cipherKey(target).isEmpty()) {
183 emit displayMsg(Message::Info, bufferInfo.bufferName(), tr("No key has been set for %1.").arg(target));
187 network()->setCipherKey(target, QByteArray());
189 if(network()->isChannelName(target) && network()->channels().contains(target)) {
190 qobject_cast<CoreIrcChannel *>(network()->ircChannel(target))->setEncrypted(false);
192 else if(network()->nicks().contains(target)) {
193 qobject_cast<CoreIrcUser *>(network()->ircUser(target))->setEncrypted(false);
196 emit displayMsg(Message::Info, bufferInfo.bufferName(), tr("The key for %1 has been deleted.").arg(target));
200 emit displayMsg(Message::Error, bufferInfo.bufferName(), "", tr("Error: Setting an encryption key requires Quassel to have been built "
201 "with support for the Qt Cryptographic Architecture (QCA2) library. "
202 "Contact your distributor about a Quassel package with QCA2 "
203 "support, or rebuild Quassel with QCA2 present."));
207 void CoreUserInputHandler::handleDeop(const BufferInfo &bufferInfo, const QString &msg) {
208 QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
209 QString m = "-"; for(int i = 0; i < nicks.count(); i++) m += 'o';
211 params << bufferInfo.bufferName() << m << nicks;
212 emit putCmd("MODE", serverEncode(params));
215 void CoreUserInputHandler::handleDevoice(const BufferInfo &bufferInfo, const QString &msg) {
216 QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
217 QString m = "-"; for(int i = 0; i < nicks.count(); i++) m += 'v';
219 params << bufferInfo.bufferName() << m << nicks;
220 emit putCmd("MODE", serverEncode(params));
223 void CoreUserInputHandler::handleInvite(const BufferInfo &bufferInfo, const QString &msg) {
225 params << msg << bufferInfo.bufferName();
226 emit putCmd("INVITE", serverEncode(params));
229 void CoreUserInputHandler::handleJoin(const BufferInfo &bufferInfo, const QString &msg) {
230 Q_UNUSED(bufferInfo);
232 // trim spaces before chans or keys
233 QString sane_msg = msg;
234 sane_msg.replace(QRegExp(", +"), ",");
235 QStringList params = sane_msg.trimmed().split(" ");
237 QStringList chans = params[0].split(",", QString::SkipEmptyParts);
239 if(params.count() > 1)
240 keys = params[1].split(",");
243 for(i = 0; i < chans.count(); i++) {
244 if(!network()->isChannelName(chans[i]))
245 chans[i].prepend('#');
247 if(i < keys.count()) {
248 network()->addChannelKey(chans[i], keys[i]);
250 network()->removeChannelKey(chans[i]);
254 static const char *cmd = "JOIN";
256 QStringList joinChans, joinKeys;
257 int slicesize = chans.count();
258 QList<QByteArray> encodedParams;
260 // go through all to-be-joined channels and (re)build the join list
261 while(i < chans.count()) {
262 joinChans.append(chans.at(i));
264 joinKeys.append(keys.at(i));
266 // if the channel list we built so far either contains all requested channels or exceeds
267 // the desired amount of channels in this slice, try to send what we have so far
268 if(++i == chans.count() || joinChans.count() >= slicesize) {
270 params.append(joinChans.join(","));
271 params.append(joinKeys.join(","));
272 encodedParams = serverEncode(params);
273 // check if it fits in one command
274 if(lastParamOverrun(cmd, encodedParams) == 0) {
275 emit putCmd(cmd, encodedParams);
276 } else if(slicesize > 1) {
277 // back to start of slice, try again with half the amount of channels
287 void CoreUserInputHandler::handleKick(const BufferInfo &bufferInfo, const QString &msg) {
288 QString nick = msg.section(' ', 0, 0, QString::SectionSkipEmpty);
289 QString reason = msg.section(' ', 1, -1, QString::SectionSkipEmpty).trimmed();
291 reason = network()->identityPtr()->kickReason();
293 QList<QByteArray> params;
294 params << serverEncode(bufferInfo.bufferName()) << serverEncode(nick) << channelEncode(bufferInfo.bufferName(), reason);
295 emit putCmd("KICK", params);
298 void CoreUserInputHandler::handleKill(const BufferInfo &bufferInfo, const QString &msg) {
300 QString nick = msg.section(' ', 0, 0, QString::SectionSkipEmpty);
301 QString pass = msg.section(' ', 1, -1, QString::SectionSkipEmpty);
302 QList<QByteArray> params;
303 params << serverEncode(nick) << serverEncode(pass);
304 emit putCmd("KILL", params);
308 void CoreUserInputHandler::handleList(const BufferInfo &bufferInfo, const QString &msg) {
310 emit putCmd("LIST", serverEncode(msg.split(' ', QString::SkipEmptyParts)));
313 void CoreUserInputHandler::handleMe(const BufferInfo &bufferInfo, const QString &msg) {
314 if(bufferInfo.bufferName().isEmpty()) return; // server buffer
315 network()->ctcpHandler()->query(bufferInfo.bufferName(), "ACTION", msg);
316 emit displayMsg(Message::Action, bufferInfo.type(), bufferInfo.bufferName(), msg, network()->myNick(), Message::Self);
319 void CoreUserInputHandler::handleMode(const BufferInfo &bufferInfo, const QString &msg) {
322 QStringList params = msg.split(' ', QString::SkipEmptyParts);
323 // 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
324 if(!params.isEmpty()) {
325 if(!network()->isChannelName(params[0]) && !network()->isMyNick(params[0]))
326 params.prepend(bufferInfo.bufferName());
327 if(network()->isMyNick(params[0]) && params.count() == 2)
328 network()->updateIssuedModes(params[1]);
329 if(params[0] == "-reset" && params.count() == 1) {
330 // FIXME: give feedback to the user (I don't want to add new strings right now)
331 network()->resetPersistentModes();
336 // TODO handle correct encoding for buffer modes (channelEncode())
337 emit putCmd("MODE", serverEncode(params));
340 // TODO: show privmsgs
341 void CoreUserInputHandler::handleMsg(const BufferInfo &bufferInfo, const QString &msg) {
342 Q_UNUSED(bufferInfo);
343 if(!msg.contains(' '))
346 QString target = msg.section(' ', 0, 0);
347 QByteArray encMsg = userEncode(target, msg.section(' ', 1));
350 putPrivmsg(serverEncode(target), encMsg, network()->cipher(target));
352 putPrivmsg(serverEncode(target), encMsg);
356 void CoreUserInputHandler::handleNick(const BufferInfo &bufferInfo, const QString &msg) {
358 QString nick = msg.section(' ', 0, 0);
359 emit putCmd("NICK", serverEncode(nick));
362 void CoreUserInputHandler::handleNotice(const BufferInfo &bufferInfo, const QString &msg) {
363 QString bufferName = msg.section(' ', 0, 0);
364 QString payload = msg.section(' ', 1);
365 QList<QByteArray> params;
366 params << serverEncode(bufferName) << channelEncode(bufferInfo.bufferName(), payload);
367 emit putCmd("NOTICE", params);
368 emit displayMsg(Message::Notice, bufferName, payload, network()->myNick(), Message::Self);
371 void CoreUserInputHandler::handleOp(const BufferInfo &bufferInfo, const QString &msg) {
372 QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
373 QString m = "+"; for(int i = 0; i < nicks.count(); i++) m += 'o';
375 params << bufferInfo.bufferName() << m << nicks;
376 emit putCmd("MODE", serverEncode(params));
379 void CoreUserInputHandler::handleOper(const BufferInfo &bufferInfo, const QString &msg) {
381 emit putRawLine(serverEncode(QString("OPER %1").arg(msg)));
384 void CoreUserInputHandler::handlePart(const BufferInfo &bufferInfo, const QString &msg) {
385 QList<QByteArray> params;
388 // msg might contain either a channel name and/or a reaon, so we have to check if the first word is a known channel
389 QString channelName = msg.section(' ', 0, 0);
390 if(channelName.isEmpty() || !network()->ircChannel(channelName)) {
391 channelName = bufferInfo.bufferName();
394 partReason = msg.mid(channelName.length() + 1);
397 if(partReason.isEmpty())
398 partReason = network()->identityPtr()->partReason();
400 params << serverEncode(channelName) << channelEncode(bufferInfo.bufferName(), partReason);
401 emit putCmd("PART", params);
404 void CoreUserInputHandler::handlePing(const BufferInfo &bufferInfo, const QString &msg) {
409 param = QTime::currentTime().toString("hh:mm:ss.zzz");
411 putCmd("PING", serverEncode(param));
414 // TODO: implement queries
415 void CoreUserInputHandler::handleQuery(const BufferInfo &bufferInfo, const QString &msg) {
417 QString target = msg.section(' ', 0, 0);
418 QString message = msg.section(' ', 1);
419 if(message.isEmpty())
420 emit displayMsg(Message::Server, BufferInfo::QueryBuffer, target, tr("Starting query with ") + target, network()->myNick(), Message::Self);
422 emit displayMsg(Message::Plain, BufferInfo::QueryBuffer, target, message, network()->myNick(), Message::Self);
423 handleMsg(bufferInfo, msg);
426 void CoreUserInputHandler::handleQuit(const BufferInfo &bufferInfo, const QString &msg) {
428 network()->disconnectFromIrc(true, msg);
431 void CoreUserInputHandler::issueQuit(const QString &reason) {
432 emit putCmd("QUIT", serverEncode(reason));
435 void CoreUserInputHandler::handleQuote(const BufferInfo &bufferInfo, const QString &msg) {
437 emit putRawLine(serverEncode(msg));
440 void CoreUserInputHandler::handleSay(const BufferInfo &bufferInfo, const QString &msg) {
441 if(bufferInfo.bufferName().isEmpty())
442 return; // server buffer
444 QByteArray encMsg = channelEncode(bufferInfo.bufferName(), msg);
446 putPrivmsg(serverEncode(bufferInfo.bufferName()), encMsg, network()->cipher(bufferInfo.bufferName()));
448 putPrivmsg(serverEncode(bufferInfo.bufferName()), encMsg);
450 emit displayMsg(Message::Plain, bufferInfo.type(), bufferInfo.bufferName(), msg, network()->myNick(), Message::Self);
453 void CoreUserInputHandler::handleSetkey(const BufferInfo &bufferInfo, const QString &msg) {
455 if(!bufferInfo.isValid())
458 if(!Cipher::neededFeaturesAvailable())
461 QStringList parms = msg.split(' ', QString::SkipEmptyParts);
463 if(parms.count() == 1 && !bufferInfo.bufferName().isEmpty())
464 parms.prepend(bufferInfo.bufferName());
465 else if(parms.count() != 2) {
466 emit displayMsg(Message::Info, bufferInfo.bufferName(),
467 tr("[usage] /setkey <nick|channel> <key> sets the encryption key for nick or channel. "
468 "/setkey <key> when in a channel or query buffer sets the key for it."));
472 QString target = parms.at(0);
473 QByteArray key = parms.at(1).toLocal8Bit();
475 network()->setCipherKey(target, key);
477 if(network()->isChannelName(target) && network()->channels().contains(target))
478 qobject_cast<CoreIrcChannel *>(network()->ircChannel(target))->setEncrypted(true);
479 else if(network()->nicks().contains(target))
480 qobject_cast<CoreIrcUser *>(network()->ircUser(target))->setEncrypted(true);
482 emit displayMsg(Message::Info, bufferInfo.bufferName(), tr("The key for %1 has been set.").arg(target));
485 emit displayMsg(Message::Error, bufferInfo.bufferName(), tr("Error: Setting an encryption key requires Quassel to have been built "
486 "with support for the Qt Cryptographic Architecture (QCA) library. "
487 "Contact your distributor about a Quassel package with QCA "
488 "support, or rebuild Quassel with QCA present."));
492 void CoreUserInputHandler::handleTopic(const BufferInfo &bufferInfo, const QString &msg) {
493 if(bufferInfo.bufferName().isEmpty())
496 QList<QByteArray> params;
497 params << serverEncode(bufferInfo.bufferName());
501 params << encrypt(bufferInfo.bufferName(), channelEncode(bufferInfo.bufferName(), msg));
503 params << channelEncode(bufferInfo.bufferName(), msg);
507 emit putCmd("TOPIC", params);
510 void CoreUserInputHandler::handleVoice(const BufferInfo &bufferInfo, const QString &msg) {
511 QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
512 QString m = "+"; for(int i = 0; i < nicks.count(); i++) m += 'v';
514 params << bufferInfo.bufferName() << m << nicks;
515 emit putCmd("MODE", serverEncode(params));
518 void CoreUserInputHandler::handleWait(const BufferInfo &bufferInfo, const QString &msg) {
519 int splitPos = msg.indexOf(';');
524 int delay = msg.left(splitPos).trimmed().toInt(&ok);
530 QString command = msg.mid(splitPos + 1).trimmed();
531 if(command.isEmpty())
534 _delayedCommands[startTimer(delay)] = Command(bufferInfo, command);
537 void CoreUserInputHandler::handleWho(const BufferInfo &bufferInfo, const QString &msg) {
539 emit putCmd("WHO", serverEncode(msg.split(' ')));
542 void CoreUserInputHandler::handleWhois(const BufferInfo &bufferInfo, const QString &msg) {
544 emit putCmd("WHOIS", serverEncode(msg.split(' ')));
547 void CoreUserInputHandler::handleWhowas(const BufferInfo &bufferInfo, const QString &msg) {
549 emit putCmd("WHOWAS", serverEncode(msg.split(' ')));
552 void CoreUserInputHandler::defaultHandler(QString cmd, const BufferInfo &bufferInfo, const QString &msg) {
553 Q_UNUSED(bufferInfo);
554 emit putCmd(serverEncode(cmd.toUpper()), serverEncode(msg.split(" ")));
557 void CoreUserInputHandler::putPrivmsg(const QByteArray &target, const QByteArray &message, Cipher *cipher) {
558 // Encrypted messages need special care. There's no clear relation between cleartext and encrypted message length,
559 // so we can't just compute the maxSplitPos. Instead, we need to loop through the splitpoints until the crypted
560 // version is short enough...
561 // TODO: check out how the various possible encryption methods behave length-wise and make
562 // this clean by predicting the length of the crypted msg.
563 // For example, blowfish-ebc seems to create 8-char chunks.
565 static const char *cmd = "PRIVMSG";
566 static const char *splitter = " .,-";
568 int maxSplitPos = message.count();
569 int splitPos = maxSplitPos;
571 QByteArray crypted = message.left(splitPos);
572 bool isEncrypted = false;
574 if(cipher && !message.isEmpty()) {
575 isEncrypted = cipher->encrypt(crypted);
578 int overrun = lastParamOverrun(cmd, QList<QByteArray>() << target << crypted);
580 // In case this is not an encrypted msg, we can just cut off at the end
582 maxSplitPos = message.count() - overrun;
585 for(const char *splitChar = splitter; *splitChar != 0; splitChar++) {
586 splitPos = qMax(splitPos, message.lastIndexOf(*splitChar, maxSplitPos) + 1); // keep split char on old line
588 if(splitPos <= 0 || splitPos > maxSplitPos)
589 splitPos = maxSplitPos;
591 maxSplitPos = splitPos - 1;
592 if(maxSplitPos <= 0) { // this should never happen, but who knows...
593 qWarning() << tr("[Error] Could not encrypt your message: %1").arg(message.data());
596 continue; // we never come back here for !encrypted!
599 // now we have found a valid splitpos (or didn't need to split to begin with)
600 putCmd(cmd, QList<QByteArray>() << target << crypted);
601 if(splitPos < message.count())
602 putPrivmsg(target, message.mid(splitPos), cipher);
608 // returns 0 if the message will not be chopped by the irc server or number of chopped bytes if message is too long
609 int CoreUserInputHandler::lastParamOverrun(const QString &cmd, const QList<QByteArray> ¶ms) {
610 // the server will pass our message truncated to 512 bytes including CRLF with the following format:
611 // ":prefix COMMAND param0 param1 :lastparam"
612 // where prefix = "nickname!user@host"
613 // that means that the last message can be as long as:
614 // 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)
615 IrcUser *me = network()->me();
616 int maxLen = 480 - cmd.toAscii().count(); // educated guess in case we don't know us (yet?)
619 maxLen = 512 - serverEncode(me->nick()).count() - serverEncode(me->user()).count() - serverEncode(me->host()).count() - cmd.toAscii().count() - 6;
621 if(!params.isEmpty()) {
622 for(int i = 0; i < params.count() - 1; i++) {
623 maxLen -= (params[i].count() + 1);
625 maxLen -= 2; // " :" last param separator;
627 if(params.last().count() > maxLen) {
628 return params.last().count() - maxLen;
638 QByteArray CoreUserInputHandler::encrypt(const QString &target, const QByteArray &message_, bool *didEncrypt) const {
642 if(message_.isEmpty())
645 if(!Cipher::neededFeaturesAvailable())
648 Cipher *cipher = network()->cipher(target);
652 QByteArray message = message_;
653 bool result = cipher->encrypt(message);
655 *didEncrypt = result;
661 void CoreUserInputHandler::timerEvent(QTimerEvent *event) {
662 if(!_delayedCommands.contains(event->timerId())) {
663 QObject::timerEvent(event);
666 BufferInfo bufferInfo = _delayedCommands[event->timerId()].bufferInfo;
667 QString rawCommand = _delayedCommands[event->timerId()].command;
668 _delayedCommands.remove(event->timerId());
671 // the stored command might be the result of an alias expansion, so we need to split it up again
672 QStringList commands = rawCommand.split(QRegExp("; ?"));
673 foreach(QString command, commands) {
674 handleUserInput(bufferInfo, command);