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 QStringList parms = msg.split(' ', QString::SkipEmptyParts);
168 if(parms.isEmpty() && !bufferInfo.bufferName().isEmpty())
169 parms.prepend(bufferInfo.bufferName());
171 if(parms.isEmpty()) {
172 emit displayMsg(Message::Info, bufferInfo.bufferName(), "",
173 tr("[usage] /delkey <nick|channel> deletes the encryption key for nick or channel or just /delkey when in a channel or query."));
177 QString target = parms.at(0);
179 if(network()->cipherKey(target).isEmpty()) {
180 emit displayMsg(Message::Info, bufferInfo.bufferName(), tr("No key has been set for %1.").arg(target));
184 network()->setCipherKey(target, QByteArray());
186 if(network()->isChannelName(target) && network()->channels().contains(target)) {
187 qobject_cast<CoreIrcChannel *>(network()->ircChannel(target))->setEncrypted(false);
189 else if(network()->nicks().contains(target)) {
190 qobject_cast<CoreIrcUser *>(network()->ircUser(target))->setEncrypted(false);
193 emit displayMsg(Message::Info, bufferInfo.bufferName(), tr("The key for %1 has been deleted.").arg(target));
197 emit displayMsg(Message::Error, bufferInfo.bufferName(), "", tr("Error: Setting an encryption key requires Quassel to have been built "
198 "with support for the Qt Cryptographic Architecture (QCA2) library. "
199 "Contact your distributor about a Quassel package with QCA2 "
200 "support, or rebuild Quassel with QCA2 present."));
204 void CoreUserInputHandler::handleDeop(const BufferInfo &bufferInfo, const QString &msg) {
205 QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
206 QString m = "-"; for(int i = 0; i < nicks.count(); i++) m += 'o';
208 params << bufferInfo.bufferName() << m << nicks;
209 emit putCmd("MODE", serverEncode(params));
212 void CoreUserInputHandler::handleDevoice(const BufferInfo &bufferInfo, const QString &msg) {
213 QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
214 QString m = "-"; for(int i = 0; i < nicks.count(); i++) m += 'v';
216 params << bufferInfo.bufferName() << m << nicks;
217 emit putCmd("MODE", serverEncode(params));
220 void CoreUserInputHandler::handleInvite(const BufferInfo &bufferInfo, const QString &msg) {
222 params << msg << bufferInfo.bufferName();
223 emit putCmd("INVITE", serverEncode(params));
226 void CoreUserInputHandler::handleJoin(const BufferInfo &bufferInfo, const QString &msg) {
227 Q_UNUSED(bufferInfo);
229 // trim spaces before chans or keys
230 QString sane_msg = msg;
231 sane_msg.replace(QRegExp(", +"), ",");
232 QStringList params = sane_msg.trimmed().split(" ");
234 QStringList chans = params[0].split(",", QString::SkipEmptyParts);
236 if(params.count() > 1)
237 keys = params[1].split(",");
240 for(i = 0; i < chans.count(); i++) {
241 if(!network()->isChannelName(chans[i]))
242 chans[i].prepend('#');
244 if(i < keys.count()) {
245 network()->addChannelKey(chans[i], keys[i]);
247 network()->removeChannelKey(chans[i]);
251 static const char *cmd = "JOIN";
253 QStringList joinChans, joinKeys;
254 int slicesize = chans.count();
255 QList<QByteArray> encodedParams;
257 // go through all to-be-joined channels and (re)build the join list
258 while(i < chans.count()) {
259 joinChans.append(chans.at(i));
261 joinKeys.append(keys.at(i));
263 // if the channel list we built so far either contains all requested channels or exceeds
264 // the desired amount of channels in this slice, try to send what we have so far
265 if(++i == chans.count() || joinChans.count() >= slicesize) {
267 params.append(joinChans.join(","));
268 params.append(joinKeys.join(","));
269 encodedParams = serverEncode(params);
270 // check if it fits in one command
271 if(lastParamOverrun(cmd, encodedParams) == 0) {
272 emit putCmd(cmd, encodedParams);
273 } else if(slicesize > 1) {
274 // back to start of slice, try again with half the amount of channels
284 void CoreUserInputHandler::handleKick(const BufferInfo &bufferInfo, const QString &msg) {
285 QString nick = msg.section(' ', 0, 0, QString::SectionSkipEmpty);
286 QString reason = msg.section(' ', 1, -1, QString::SectionSkipEmpty).trimmed();
288 reason = network()->identityPtr()->kickReason();
290 QList<QByteArray> params;
291 params << serverEncode(bufferInfo.bufferName()) << serverEncode(nick) << channelEncode(bufferInfo.bufferName(), reason);
292 emit putCmd("KICK", params);
295 void CoreUserInputHandler::handleKill(const BufferInfo &bufferInfo, const QString &msg) {
297 QString nick = msg.section(' ', 0, 0, QString::SectionSkipEmpty);
298 QString pass = msg.section(' ', 1, -1, QString::SectionSkipEmpty);
299 QList<QByteArray> params;
300 params << serverEncode(nick) << serverEncode(pass);
301 emit putCmd("KILL", params);
305 void CoreUserInputHandler::handleList(const BufferInfo &bufferInfo, const QString &msg) {
307 emit putCmd("LIST", serverEncode(msg.split(' ', QString::SkipEmptyParts)));
310 void CoreUserInputHandler::handleMe(const BufferInfo &bufferInfo, const QString &msg) {
311 if(bufferInfo.bufferName().isEmpty()) return; // server buffer
312 network()->ctcpHandler()->query(bufferInfo.bufferName(), "ACTION", msg);
313 emit displayMsg(Message::Action, bufferInfo.type(), bufferInfo.bufferName(), msg, network()->myNick(), Message::Self);
316 void CoreUserInputHandler::handleMode(const BufferInfo &bufferInfo, const QString &msg) {
319 QStringList params = msg.split(' ', QString::SkipEmptyParts);
320 // 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
321 if(!params.isEmpty()) {
322 if(!network()->isChannelName(params[0]) && !network()->isMyNick(params[0]))
323 params.prepend(bufferInfo.bufferName());
324 if(network()->isMyNick(params[0]) && params.count() == 2)
325 network()->updateIssuedModes(params[1]);
326 if(params[0] == "-reset" && params.count() == 1) {
327 // FIXME: give feedback to the user (I don't want to add new strings right now)
328 network()->resetPersistentModes();
333 // TODO handle correct encoding for buffer modes (channelEncode())
334 emit putCmd("MODE", serverEncode(params));
337 // TODO: show privmsgs
338 void CoreUserInputHandler::handleMsg(const BufferInfo &bufferInfo, const QString &msg) {
339 Q_UNUSED(bufferInfo);
340 if(!msg.contains(' '))
343 QString target = msg.section(' ', 0, 0);
344 QByteArray encMsg = userEncode(target, msg.section(' ', 1));
347 putPrivmsg(serverEncode(target), encMsg, network()->cipher(target));
349 putPrivmsg(serverEncode(target), encMsg);
353 void CoreUserInputHandler::handleNick(const BufferInfo &bufferInfo, const QString &msg) {
355 QString nick = msg.section(' ', 0, 0);
356 emit putCmd("NICK", serverEncode(nick));
359 void CoreUserInputHandler::handleNotice(const BufferInfo &bufferInfo, const QString &msg) {
360 QString bufferName = msg.section(' ', 0, 0);
361 QString payload = msg.section(' ', 1);
362 QList<QByteArray> params;
363 params << serverEncode(bufferName) << channelEncode(bufferInfo.bufferName(), payload);
364 emit putCmd("NOTICE", params);
365 emit displayMsg(Message::Notice, bufferName, payload, network()->myNick(), Message::Self);
368 void CoreUserInputHandler::handleOp(const BufferInfo &bufferInfo, const QString &msg) {
369 QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
370 QString m = "+"; for(int i = 0; i < nicks.count(); i++) m += 'o';
372 params << bufferInfo.bufferName() << m << nicks;
373 emit putCmd("MODE", serverEncode(params));
376 void CoreUserInputHandler::handleOper(const BufferInfo &bufferInfo, const QString &msg) {
378 emit putRawLine(serverEncode(QString("OPER %1").arg(msg)));
381 void CoreUserInputHandler::handlePart(const BufferInfo &bufferInfo, const QString &msg) {
382 QList<QByteArray> params;
385 // msg might contain either a channel name and/or a reaon, so we have to check if the first word is a known channel
386 QString channelName = msg.section(' ', 0, 0);
387 if(channelName.isEmpty() || !network()->ircChannel(channelName)) {
388 channelName = bufferInfo.bufferName();
391 partReason = msg.mid(channelName.length() + 1);
394 if(partReason.isEmpty())
395 partReason = network()->identityPtr()->partReason();
397 params << serverEncode(channelName) << channelEncode(bufferInfo.bufferName(), partReason);
398 emit putCmd("PART", params);
401 void CoreUserInputHandler::handlePing(const BufferInfo &bufferInfo, const QString &msg) {
406 param = QTime::currentTime().toString("hh:mm:ss.zzz");
408 putCmd("PING", serverEncode(param));
411 // TODO: implement queries
412 void CoreUserInputHandler::handleQuery(const BufferInfo &bufferInfo, const QString &msg) {
414 QString target = msg.section(' ', 0, 0);
415 QString message = msg.section(' ', 1);
416 if(message.isEmpty())
417 emit displayMsg(Message::Server, BufferInfo::QueryBuffer, target, "Starting query with " + target, network()->myNick(), Message::Self);
419 emit displayMsg(Message::Plain, BufferInfo::QueryBuffer, target, message, network()->myNick(), Message::Self);
420 handleMsg(bufferInfo, msg);
423 void CoreUserInputHandler::handleQuit(const BufferInfo &bufferInfo, const QString &msg) {
425 network()->disconnectFromIrc(true, msg);
428 void CoreUserInputHandler::issueQuit(const QString &reason) {
429 emit putCmd("QUIT", serverEncode(reason));
432 void CoreUserInputHandler::handleQuote(const BufferInfo &bufferInfo, const QString &msg) {
434 emit putRawLine(serverEncode(msg));
437 void CoreUserInputHandler::handleSay(const BufferInfo &bufferInfo, const QString &msg) {
438 if(bufferInfo.bufferName().isEmpty())
439 return; // server buffer
441 QByteArray encMsg = channelEncode(bufferInfo.bufferName(), msg);
443 putPrivmsg(serverEncode(bufferInfo.bufferName()), encMsg, network()->cipher(bufferInfo.bufferName()));
445 putPrivmsg(serverEncode(bufferInfo.bufferName()), encMsg);
447 emit displayMsg(Message::Plain, bufferInfo.type(), bufferInfo.bufferName(), msg, network()->myNick(), Message::Self);
450 void CoreUserInputHandler::handleSetkey(const BufferInfo &bufferInfo, const QString &msg) {
452 if(!bufferInfo.isValid())
455 QStringList parms = msg.split(' ', QString::SkipEmptyParts);
457 if(parms.count() == 1 && !bufferInfo.bufferName().isEmpty())
458 parms.prepend(bufferInfo.bufferName());
459 else if(parms.count() != 2) {
460 emit displayMsg(Message::Info, bufferInfo.bufferName(),
461 tr("[usage] /setkey <nick|channel> <key> sets the encryption key for nick or channel. "
462 "/setkey <key> when in a channel or query buffer sets the key for it."));
466 QString target = parms.at(0);
467 QByteArray key = parms.at(1).toLocal8Bit();
469 network()->setCipherKey(target, key);
471 if(network()->isChannelName(target) && network()->channels().contains(target))
472 qobject_cast<CoreIrcChannel *>(network()->ircChannel(target))->setEncrypted(true);
473 else if(network()->nicks().contains(target))
474 qobject_cast<CoreIrcUser *>(network()->ircUser(target))->setEncrypted(true);
476 emit displayMsg(Message::Info, bufferInfo.bufferName(), tr("The key for %1 has been set.").arg(target));
479 emit displayMsg(Message::Error, bufferInfo.bufferName(), tr("Error: Setting an encryption key requires Quassel to have been built "
480 "with support for the Qt Cryptographic Architecture (QCA) library. "
481 "Contact your distributor about a Quassel package with QCA "
482 "support, or rebuild Quassel with QCA present."));
486 void CoreUserInputHandler::handleTopic(const BufferInfo &bufferInfo, const QString &msg) {
487 if(bufferInfo.bufferName().isEmpty())
490 QList<QByteArray> params;
491 params << serverEncode(bufferInfo.bufferName());
495 params << encrypt(bufferInfo.bufferName(), channelEncode(bufferInfo.bufferName(), msg));
497 params << channelEncode(bufferInfo.bufferName(), msg);
501 emit putCmd("TOPIC", params);
504 void CoreUserInputHandler::handleVoice(const BufferInfo &bufferInfo, const QString &msg) {
505 QStringList nicks = msg.split(' ', QString::SkipEmptyParts);
506 QString m = "+"; for(int i = 0; i < nicks.count(); i++) m += 'v';
508 params << bufferInfo.bufferName() << m << nicks;
509 emit putCmd("MODE", serverEncode(params));
512 void CoreUserInputHandler::handleWait(const BufferInfo &bufferInfo, const QString &msg) {
513 int splitPos = msg.indexOf(';');
518 int delay = msg.left(splitPos).trimmed().toInt(&ok);
524 QString command = msg.mid(splitPos + 1).trimmed();
525 if(command.isEmpty())
528 _delayedCommands[startTimer(delay)] = Command(bufferInfo, command);
531 void CoreUserInputHandler::handleWho(const BufferInfo &bufferInfo, const QString &msg) {
533 emit putCmd("WHO", serverEncode(msg.split(' ')));
536 void CoreUserInputHandler::handleWhois(const BufferInfo &bufferInfo, const QString &msg) {
538 emit putCmd("WHOIS", serverEncode(msg.split(' ')));
541 void CoreUserInputHandler::handleWhowas(const BufferInfo &bufferInfo, const QString &msg) {
543 emit putCmd("WHOWAS", serverEncode(msg.split(' ')));
546 void CoreUserInputHandler::defaultHandler(QString cmd, const BufferInfo &bufferInfo, const QString &msg) {
547 Q_UNUSED(bufferInfo);
548 emit putCmd(serverEncode(cmd.toUpper()), serverEncode(msg.split(" ")));
551 void CoreUserInputHandler::putPrivmsg(const QByteArray &target, const QByteArray &message, Cipher *cipher) {
552 // Encrypted messages need special care. There's no clear relation between cleartext and encrypted message length,
553 // so we can't just compute the maxSplitPos. Instead, we need to loop through the splitpoints until the crypted
554 // version is short enough...
555 // TODO: check out how the various possible encryption methods behave length-wise and make
556 // this clean by predicting the length of the crypted msg.
557 // For example, blowfish-ebc seems to create 8-char chunks.
559 static const char *cmd = "PRIVMSG";
560 static const char *splitter = " .,-";
562 int maxSplitPos = message.count();
563 int splitPos = maxSplitPos;
565 QByteArray crypted = message.left(splitPos);
566 bool isEncrypted = false;
568 if(cipher && !message.isEmpty()) {
569 isEncrypted = cipher->encrypt(crypted);
572 int overrun = lastParamOverrun(cmd, QList<QByteArray>() << target << crypted);
574 // In case this is not an encrypted msg, we can just cut off at the end
576 maxSplitPos = message.count() - overrun;
579 for(const char *splitChar = splitter; *splitChar != 0; splitChar++) {
580 splitPos = qMax(splitPos, message.lastIndexOf(*splitChar, maxSplitPos) + 1); // keep split char on old line
582 if(splitPos <= 0 || splitPos > maxSplitPos)
583 splitPos = maxSplitPos;
585 maxSplitPos = splitPos - 1;
586 if(maxSplitPos <= 0) { // this should never happen, but who knows...
587 qWarning() << tr("[Error] Could not encrypt your message: %1").arg(message.data());
590 continue; // we never come back here for !encrypted!
593 // now we have found a valid splitpos (or didn't need to split to begin with)
594 putCmd(cmd, QList<QByteArray>() << target << crypted);
595 if(splitPos < message.count())
596 putPrivmsg(target, message.mid(splitPos), cipher);
602 // returns 0 if the message will not be chopped by the irc server or number of chopped bytes if message is too long
603 int CoreUserInputHandler::lastParamOverrun(const QString &cmd, const QList<QByteArray> ¶ms) {
604 // the server will pass our message truncated to 512 bytes including CRLF with the following format:
605 // ":prefix COMMAND param0 param1 :lastparam"
606 // where prefix = "nickname!user@host"
607 // that means that the last message can be as long as:
608 // 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)
609 IrcUser *me = network()->me();
610 int maxLen = 480 - cmd.toAscii().count(); // educated guess in case we don't know us (yet?)
613 maxLen = 512 - serverEncode(me->nick()).count() - serverEncode(me->user()).count() - serverEncode(me->host()).count() - cmd.toAscii().count() - 6;
615 if(!params.isEmpty()) {
616 for(int i = 0; i < params.count() - 1; i++) {
617 maxLen -= (params[i].count() + 1);
619 maxLen -= 2; // " :" last param separator;
621 if(params.last().count() > maxLen) {
622 return params.last().count() - maxLen;
632 QByteArray CoreUserInputHandler::encrypt(const QString &target, const QByteArray &message_, bool *didEncrypt) const {
636 if(message_.isEmpty())
639 Cipher *cipher = network()->cipher(target);
643 QByteArray message = message_;
644 bool result = cipher->encrypt(message);
646 *didEncrypt = result;
652 void CoreUserInputHandler::timerEvent(QTimerEvent *event) {
653 if(!_delayedCommands.contains(event->timerId())) {
654 QObject::timerEvent(event);
657 BufferInfo bufferInfo = _delayedCommands[event->timerId()].bufferInfo;
658 QString rawCommand = _delayedCommands[event->timerId()].command;
659 _delayedCommands.remove(event->timerId());
662 // the stored command might be the result of an alias expansion, so we need to split it up again
663 QStringList commands = rawCommand.split(QRegExp("; ?"));
664 foreach(QString command, commands) {
665 handleUserInput(bufferInfo, command);