X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fircparser.cpp;h=bfbc3915bfd2eacdbfc57b6c75ab1469800871d6;hp=34e693d6aab0dae0bba8fbd58dd0317e5c539451;hb=cc6e7c08709c4e761e2fd9c2e322751015497003;hpb=96cd8441f9ab217b1d3c2ba0f2899ef64ca781e4 diff --git a/src/core/ircparser.cpp b/src/core/ircparser.cpp index 34e693d6..bfbc3915 100644 --- a/src/core/ircparser.cpp +++ b/src/core/ircparser.cpp @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2010 by the Quassel Project * + * Copyright (C) 2005-2019 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -15,11 +15,13 @@ * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ #include "ircparser.h" +#include + #include "corenetwork.h" #include "eventmanager.h" #include "ircevent.h" @@ -27,273 +29,385 @@ #include "networkevent.h" #ifdef HAVE_QCA2 -# include "cipher.h" +# include "cipher.h" +# include "keyevent.h" #endif -IrcParser::IrcParser(CoreSession *session) : - QObject(session), - _coreSession(session) +IrcParser::IrcParser(CoreSession* session) + : QObject(session) + , _coreSession(session) { + // Check if raw IRC logging is enabled + _debugLogRawIrc = (Quassel::isOptionSet("debug-irc") || Quassel::isOptionSet("debug-irc-id")); + _debugLogRawNetId = Quassel::optionValue("debug-irc-id").toInt(); + connect(this, &IrcParser::newEvent, coreSession()->eventManager(), &EventManager::postEvent); } -bool IrcParser::checkParamCount(const QString &cmd, const QList ¶ms, int minParams) { - if(params.count() < minParams) { - qWarning() << "Expected" << minParams << "params for IRC command" << cmd << ", got:" << params; - return false; - } - return true; +bool IrcParser::checkParamCount(const QString& cmd, const QList& params, int minParams) +{ + if (params.count() < minParams) { + qWarning() << "Expected" << minParams << "params for IRC command" << cmd << ", got:" << params; + return false; + } + return true; } -QByteArray IrcParser::decrypt(Network *network, const QString &bufferName, const QByteArray &message, bool isTopic) { +QByteArray IrcParser::decrypt(Network* network, const QString& bufferName, const QByteArray& message, bool isTopic) +{ #ifdef HAVE_QCA2 - if(message.isEmpty()) - return message; + if (message.isEmpty()) + return message; - Cipher *cipher = qobject_cast(network)->cipher(bufferName); - if(!cipher) - return message; + if (!Cipher::neededFeaturesAvailable()) + return message; - return isTopic? cipher->decryptTopic(message) : cipher->decrypt(message); + Cipher* cipher = qobject_cast(network)->cipher(bufferName); + if (!cipher || cipher->key().isEmpty()) + return message; + + return isTopic ? cipher->decryptTopic(message) : cipher->decrypt(message); #else - return message; + Q_UNUSED(network); + Q_UNUSED(bufferName); + Q_UNUSED(isTopic); + return message; #endif } /* parse the raw server string and generate an appropriate event */ /* used to be handleServerMsg() */ -void IrcParser::processNetworkIncoming(NetworkDataEvent *e) { - CoreNetwork *net = qobject_cast(e->network()); - if(!net) { - qWarning() << "Received network event without valid network pointer!"; - return; - } - - // note that the IRC server is still alive - net->resetPingTimeout(); - - QByteArray msg = e->data(); - if(msg.isEmpty()) { - qWarning() << "Received empty string from server!"; - return; - } - - // Now we split the raw message into its various parts... - QString prefix; - QByteArray trailing; - QString cmd, target; - - // First, check for a trailing parameter introduced by " :", since this might screw up splitting the msg - // NOTE: This assumes that this is true in raw encoding, but well, hopefully there are no servers running in japanese on protocol level... - int idx = msg.indexOf(" :"); - if(idx >= 0) { - if(msg.length() > idx + 2) - trailing = msg.mid(idx + 2); - msg = msg.left(idx); - } - // OK, now it is safe to split... - QList params = msg.split(' '); - - // This could still contain empty elements due to (faulty?) ircds sending multiple spaces in a row - // Also, QByteArray is not nearly as convenient to work with as QString for such things :) - QList::iterator iter = params.begin(); - while(iter != params.end()) { - if(iter->isEmpty()) - iter = params.erase(iter); - else - ++iter; - } - - if(!trailing.isEmpty()) - params << trailing; - if(params.count() < 1) { - qWarning() << "Received invalid string from server!"; - return; - } - - QString foo = net->serverDecode(params.takeFirst()); - - // a colon as the first chars indicates the existence of a prefix - if(foo[0] == ':') { - foo.remove(0, 1); - prefix = foo; - if(params.count() < 1) { - qWarning() << "Received invalid string from server!"; - return; +void IrcParser::processNetworkIncoming(NetworkDataEvent* e) +{ + auto* net = qobject_cast(e->network()); + if (!net) { + qWarning() << "Received network event without valid network pointer!"; + return; } - foo = net->serverDecode(params.takeFirst()); - } - // next string without a whitespace is the command - cmd = foo.trimmed(); + // note that the IRC server is still alive + net->resetPingTimeout(); - QList events; - EventManager::EventType type = EventManager::Invalid; - - // numeric replies have the target as first param (RFC 2812 - 2.4). this is usually our own nick. Remove this! - uint num = cmd.toUInt(); - if(num > 0) { - if(params.count() == 0) { - qWarning() << "Message received from server violates RFC and is ignored!" << msg; - return; - } - target = net->serverDecode(params.takeFirst()); - type = EventManager::IrcEventNumeric; - } else { - QString typeName = QLatin1String("IrcEvent") + cmd.at(0).toUpper() + cmd.mid(1).toLower(); - type = eventManager()->eventTypeByName(typeName); - if(type == EventManager::Invalid) { - type = eventManager()->eventTypeByName("IrcEventUnknown"); - Q_ASSERT(type != EventManager::Invalid); + QByteArray msg = e->data(); + if (msg.isEmpty()) { + qWarning() << "Received empty string from server!"; + return; } - target = QString(); - } - // Almost always, all params are server-encoded. There's a few exceptions, let's catch them here! - // Possibly not the best option, we might want something more generic? Maybe yet another layer of - // unencoded events with event handlers for the exceptions... - // Also, PRIVMSG and NOTICE need some special handling, we put this in here as well, so we get out - // nice pre-parsed events that the CTCP handler can consume. + // Log the message if enabled and network ID matches or allows all + if (_debugLogRawIrc && (_debugLogRawNetId == -1 || net->networkId().toInt() == _debugLogRawNetId)) { + // Include network ID + qDebug() << "IRC net" << net->networkId() << "<<" << msg; + } - QStringList decParams; - bool defaultHandling = true; // whether to automatically copy the remaining params and send the event + // Now we split the raw message into its various parts... + QString prefix; + QByteArray trailing; + QString cmd, target; + + // First, check for a trailing parameter introduced by " :", since this might screw up splitting the msg + // NOTE: This assumes that this is true in raw encoding, but well, hopefully there are no servers running in japanese on protocol level... + int idx = msg.indexOf(" :"); + if (idx >= 0) { + if (msg.length() > idx + 2) + trailing = msg.mid(idx + 2); + msg = msg.left(idx); + } + // OK, now it is safe to split... + QList params = msg.split(' '); + + // This could still contain empty elements due to (faulty?) ircds sending multiple spaces in a row + // Also, QByteArray is not nearly as convenient to work with as QString for such things :) + QList::iterator iter = params.begin(); + while (iter != params.end()) { + if (iter->isEmpty()) + iter = params.erase(iter); + else + ++iter; + } - switch(type) { + if (!trailing.isEmpty()) + params << trailing; + if (params.count() < 1) { + qWarning() << "Received invalid string from server!"; + return; + } - case EventManager::IrcEventPrivmsg: - defaultHandling = false; // this might create a list of events + QString foo = net->serverDecode(params.takeFirst()); - if(checkParamCount(cmd, params, 1)) { - QString senderNick = nickFromMask(prefix); - QByteArray msg = params.count() < 2 ? QByteArray() : params.at(1); + // a colon as the first chars indicates the existence of a prefix + if (foo[0] == ':') { + foo.remove(0, 1); + prefix = foo; + if (params.count() < 1) { + qWarning() << "Received invalid string from server!"; + return; + } + foo = net->serverDecode(params.takeFirst()); + } - QStringList targets = net->serverDecode(params.at(0)).split(',', QString::SkipEmptyParts); - QStringList::const_iterator targetIter; - for(targetIter = targets.constBegin(); targetIter != targets.constEnd(); ++targetIter) { - QString target = net->isChannelName(*targetIter) ? *targetIter : senderNick; + // next string without a whitespace is the command + cmd = foo.trimmed(); - msg = decrypt(net, target, msg); + QList events; + EventManager::EventType type = EventManager::Invalid; - events << new IrcEventRawMessage(EventManager::IrcEventRawPrivmsg, net, prefix, target, msg); - //events << new MessageEvent(Message::Plain, net, net->channelDecode(target, msg), target, prefix); - } + uint num = cmd.toUInt(); + if (num > 0) { + // numeric reply + if (params.count() == 0) { + qWarning() << "Message received from server violates RFC and is ignored!" << msg; + return; + } + // numeric replies have the target as first param (RFC 2812 - 2.4). this is usually our own nick. Remove this! + target = net->serverDecode(params.takeFirst()); + type = EventManager::IrcEventNumeric; } - break; - - case EventManager::IrcEventNotice: - defaultHandling = false; - - if(checkParamCount(cmd, params, 2)) { - QStringList targets = net->serverDecode(params.at(0)).split(',', QString::SkipEmptyParts); - QStringList::const_iterator targetIter; - for(targetIter = targets.constBegin(); targetIter != targets.constEnd(); ++targetIter) { - QString target = *targetIter; - - // special treatment for welcome messages like: - // :ChanServ!ChanServ@services. NOTICE egst :[#apache] Welcome, this is #apache. Please read the in-channel topic message. This channel is being logged by IRSeekBot. If you have any question please see http://blog.freenode.net/?p=68 - if(!net->isChannelName(target)) { - QString decMsg = net->serverDecode(params.at(1)); - QRegExp welcomeRegExp("^\\[([^\\]]+)\\] "); - if(welcomeRegExp.indexIn(decMsg) != -1) { - QString channelname = welcomeRegExp.cap(1); - decMsg = decMsg.mid(welcomeRegExp.matchedLength()); - CoreIrcChannel *chan = static_cast(net->ircChannel(channelname)); // we only have CoreIrcChannels in the core, so this cast is safe - if(chan && !chan->receivedWelcomeMsg()) { - chan->setReceivedWelcomeMsg(); - events << new MessageEvent(Message::Notice, net, decMsg, channelname, prefix); - continue; + else { + // any other irc command + QString typeName = QLatin1String("IrcEvent") + cmd.at(0).toUpper() + cmd.mid(1).toLower(); + type = eventManager()->eventTypeByName(typeName); + if (type == EventManager::Invalid) { + type = eventManager()->eventTypeByName("IrcEventUnknown"); + Q_ASSERT(type != EventManager::Invalid); + } + target = QString(); + } + + // Almost always, all params are server-encoded. There's a few exceptions, let's catch them here! + // Possibly not the best option, we might want something more generic? Maybe yet another layer of + // unencoded events with event handlers for the exceptions... + // Also, PRIVMSG and NOTICE need some special handling, we put this in here as well, so we get out + // nice pre-parsed events that the CTCP handler can consume. + + QStringList decParams; + bool defaultHandling = true; // whether to automatically copy the remaining params and send the event + + switch (type) { + case EventManager::IrcEventPrivmsg: + defaultHandling = false; // this might create a list of events + + if (checkParamCount(cmd, params, 1)) { + QString senderNick = nickFromMask(prefix); + net->updateNickFromMask(prefix); + // Check if the sender is our own nick. If so, treat message as if sent by ourself. + // See http://ircv3.net/specs/extensions/echo-message-3.2.html + // Cache the result to avoid multiple redundant comparisons + bool isSelfMessage = net->isMyNick(senderNick); + + QByteArray msg = params.count() < 2 ? QByteArray() : params.at(1); + + QStringList targets = net->serverDecode(params.at(0)).split(',', QString::SkipEmptyParts); + QStringList::const_iterator targetIter; + for (targetIter = targets.constBegin(); targetIter != targets.constEnd(); ++targetIter) { + // For self-messages, keep the target, don't set it to the senderNick + QString target = net->isChannelName(*targetIter) || net->isStatusMsg(*targetIter) || isSelfMessage ? *targetIter : senderNick; + + // Note: self-messages could be encrypted with a different key. If issues arise, + // consider including this within an if (!isSelfMessage) block + msg = decrypt(net, target, msg); + + IrcEventRawMessage* rawMessage = new IrcEventRawMessage(EventManager::IrcEventRawPrivmsg, + net, + msg, + prefix, + target, + e->timestamp()); + if (isSelfMessage) { + // Self-messages need processed differently, tag as such via flag. + rawMessage->setFlag(EventManager::Self); + } + events << rawMessage; } - } } + break; + + case EventManager::IrcEventNotice: + defaultHandling = false; + + if (checkParamCount(cmd, params, 2)) { + // Check if the sender is our own nick. If so, treat message as if sent by ourself. + // See http://ircv3.net/specs/extensions/echo-message-3.2.html + // Cache the result to avoid multiple redundant comparisons + bool isSelfMessage = net->isMyNick(nickFromMask(prefix)); + + QStringList targets = net->serverDecode(params.at(0)).split(',', QString::SkipEmptyParts); + QStringList::const_iterator targetIter; + for (targetIter = targets.constBegin(); targetIter != targets.constEnd(); ++targetIter) { + QString target = *targetIter; + + // special treatment for welcome messages like: + // :ChanServ!ChanServ@services. NOTICE egst :[#apache] Welcome, this is #apache. Please read the in-channel topic message. + // This channel is being logged by IRSeekBot. If you have any question please see http://blog.freenode.net/?p=68 + if (!net->isChannelName(target)) { + QString decMsg = net->serverDecode(params.at(1)); + QRegExp welcomeRegExp(R"(^\[([^\]]+)\] )"); + if (welcomeRegExp.indexIn(decMsg) != -1) { + QString channelname = welcomeRegExp.cap(1); + decMsg = decMsg.mid(welcomeRegExp.matchedLength()); + CoreIrcChannel* chan = static_cast( + net->ircChannel(channelname)); // we only have CoreIrcChannels in the core, so this cast is safe + if (chan && !chan->receivedWelcomeMsg()) { + chan->setReceivedWelcomeMsg(); + events << new MessageEvent(Message::Notice, net, decMsg, prefix, channelname, Message::None, e->timestamp()); + continue; + } + } + } + + if (prefix.isEmpty() || target == "AUTH") { + target = QString(); + } + else { + if (!target.isEmpty() && net->prefixes().contains(target.at(0))) + target = target.mid(1); + + if (!net->isChannelName(target)) { + // For self-messages, keep the target, don't set it to the sender prefix + if (!isSelfMessage) { + target = nickFromMask(prefix); + } + net->updateNickFromMask(prefix); + } + } - if(prefix.isEmpty() || target == "AUTH") { - target = QString(); - } else { - if(!target.isEmpty() && net->prefixes().contains(target.at(0))) - target = target.mid(1); - if(!net->isChannelName(target)) - target = nickFromMask(prefix); +#ifdef HAVE_QCA2 + // Handle DH1080 key exchange + // Don't allow key exchange in channels, and don't allow it for self-messages. + bool keyExchangeAllowed = (!net->isChannelName(target) && !isSelfMessage); + if (params[1].startsWith("DH1080_INIT") && keyExchangeAllowed) { + events << new KeyEvent(EventManager::KeyEvent, net, prefix, target, KeyEvent::Init, params[1].mid(12)); + } + else if (params[1].startsWith("DH1080_FINISH") && keyExchangeAllowed) { + events << new KeyEvent(EventManager::KeyEvent, net, prefix, target, KeyEvent::Finish, params[1].mid(14)); + } + else +#endif + { + IrcEventRawMessage* rawMessage = new IrcEventRawMessage(EventManager::IrcEventRawNotice, + net, + params[1], + prefix, + target, + e->timestamp()); + if (isSelfMessage) { + // Self-messages need processed differently, tag as such via flag. + rawMessage->setFlag(EventManager::Self); + } + events << rawMessage; + } + } } - events << new IrcEventRawMessage(EventManager::IrcEventRawNotice, net, prefix, target, msg); - } - } - break; + break; // the following events need only special casing for param decoding - case EventManager::IrcEventKick: - if(params.count() >= 3) { // we have a reason - decParams << net->serverDecode(params.at(0)) << net->serverDecode(params.at(1)); - decParams << net->channelDecode(decParams.first(), params.at(2)); // kick reason - } - break; + case EventManager::IrcEventKick: + if (params.count() >= 3) { // we have a reason + decParams << net->serverDecode(params.at(0)) << net->serverDecode(params.at(1)); + decParams << net->channelDecode(decParams.first(), params.at(2)); // kick reason + } + break; + + case EventManager::IrcEventPart: + if (params.count() >= 2) { + QString channel = net->serverDecode(params.at(0)); + decParams << channel; + decParams << net->userDecode(nickFromMask(prefix), params.at(1)); + net->updateNickFromMask(prefix); + } + break; - case EventManager::IrcEventPart: - if(params.count() >= 2) { - QString channel = net->serverDecode(params.at(0)); - decParams << channel; - decParams << net->userDecode(nickFromMask(prefix), params.at(1)); - } - break; + case EventManager::IrcEventQuit: + if (params.count() >= 1) { + decParams << net->userDecode(nickFromMask(prefix), params.at(0)); + net->updateNickFromMask(prefix); + } + break; - case EventManager::IrcEventQuit: - if(params.count() >= 1) { - decParams << net->userDecode(nickFromMask(prefix), params.at(0)); - } - break; + case EventManager::IrcEventTopic: + if (params.count() >= 1) { + QString channel = net->serverDecode(params.at(0)); + decParams << channel; + decParams << (params.count() >= 2 ? net->channelDecode(channel, decrypt(net, channel, params.at(1), true)) : QString()); + } + break; + + case EventManager::IrcEventAway: { + // Update hostmask info first. This will create the nick if it doesn't exist, e.g. + // away-notify data being sent before JOIN messages. + net->updateNickFromMask(prefix); + // Separate nick in order to separate server and user decoding + QString nick = nickFromMask(prefix); + decParams << nick; + decParams << (params.count() >= 1 ? net->userDecode(nick, params.at(0)) : QString()); + } break; + + case EventManager::IrcEventNumeric: + switch (num) { + case 301: /* RPL_AWAY */ + if (params.count() >= 2) { + QString nick = net->serverDecode(params.at(0)); + decParams << nick; + decParams << net->userDecode(nick, params.at(1)); + } + break; + + case 332: /* RPL_TOPIC */ + if (params.count() >= 2) { + QString channel = net->serverDecode(params.at(0)); + decParams << channel; + decParams << net->channelDecode(channel, decrypt(net, channel, params.at(1), true)); + } + break; + + case 333: /* Topic set by... */ + if (params.count() >= 3) { + QString channel = net->serverDecode(params.at(0)); + decParams << channel << net->serverDecode(params.at(1)); + decParams << net->channelDecode(channel, params.at(2)); + } + break; + case 451: /* You have not registered... */ + if (target.compare("CAP", Qt::CaseInsensitive) == 0) { + // :irc.server.com 451 CAP :You have not registered + // If server doesn't support capabilities, it will report this message. Turn it + // into a nicer message since it's not a real error. + defaultHandling = false; + events << new MessageEvent(Message::Server, + e->network(), + tr("Capability negotiation not supported"), + QString(), + QString(), + Message::None, + e->timestamp()); + } + break; + } - case EventManager::IrcEventTopic: - if(params.count() >= 1) { - QString channel = net->serverDecode(params.at(0)); - decParams << channel; - decParams << (params.count() >= 2? net->channelDecode(channel, decrypt(net, channel, params.at(1), true)) : QString()); + default: + break; } - break; - case EventManager::IrcEventNumeric: - switch(num) { - case 301: /* RPL_AWAY */ - if(params.count() >= 2) { - QString nick = net->serverDecode(params.at(0)); - decParams << nick; - decParams << net->userDecode(nick, params.at(1)); - } - break; - - case 332: /* RPL_TOPIC */ - if(params.count() >= 2) { - QString channel = net->serverDecode(params.at(0)); - decParams << channel; - decParams << net->channelDecode(channel, decrypt(net, channel, params.at(1), true)); - } - break; - - case 333: /* Topic set by... */ - if(params.count() >= 2) { - QString channel = net->serverDecode(params.at(0)); - decParams << channel << net->serverDecode(params.at(1)); - decParams << net->channelDecode(channel, params.at(2)); - } - break; + if (defaultHandling && type != EventManager::Invalid) { + for (int i = decParams.count(); i < params.count(); i++) + decParams << net->serverDecode(params.at(i)); + + // We want to trim the last param just in case, except for PRIVMSG and NOTICE + // ... but those happen to be the only ones not using defaultHandling anyway + if (!decParams.isEmpty() && decParams.last().endsWith(' ')) + decParams.append(decParams.takeLast().trimmed()); + + IrcEvent* event; + if (type == EventManager::IrcEventNumeric) + event = new IrcEventNumeric(num, net, prefix, target); + else + event = new IrcEvent(type, net, prefix); + event->setParams(decParams); + event->setTimestamp(e->timestamp()); + events << event; } - default: - break; - } - - if(defaultHandling && type != EventManager::Invalid) { - for(int i = decParams.count(); i < params.count(); i++) - decParams << net->serverDecode(params.at(i)); - - IrcEvent *event; - if(type == EventManager::IrcEventNumeric) - event = new IrcEventNumeric(num, net, prefix, target); - else - event = new IrcEvent(type, net, prefix); - event->setParams(decParams); - events << event; - } - - foreach(Event *event, events) { - coreSession()->eventManager()->sendEvent(event); - } + foreach (Event* event, events) { + emit newEvent(event); + } }