/***************************************************************************
- * Copyright (C) 2005-2013 by the Quassel Project *
+ * Copyright (C) 2005-2020 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
#include "ircparser.h"
+#include <QDebug>
+
#include "corenetwork.h"
#include "eventmanager.h"
+#include "ircdecoder.h"
#include "ircevent.h"
+#include "irctags.h"
#include "messageevent.h"
#include "networkevent.h"
#ifdef HAVE_QCA2
-# include "cipher.h"
-# include "keyevent.h"
+# include "cipher.h"
+# include "keyevent.h"
#endif
-IrcParser::IrcParser(CoreSession *session) :
- QObject(session),
- _coreSession(session)
+IrcParser::IrcParser(CoreSession* session)
+ : QObject(session)
+ , _coreSession(session)
{
- connect(this, SIGNAL(newEvent(Event *)), coreSession()->eventManager(), SLOT(postEvent(Event *)));
+ // Check if raw IRC logging is enabled
+ _debugLogRawIrc = (Quassel::isOptionSet("debug-irc") || Quassel::isOptionSet("debug-irc-id"));
+ _debugLogRawNetId = Quassel::optionValue("debug-irc-id").toInt();
+ // Check if parsed IRC logging is enabled
+ _debugLogParsedIrc = (Quassel::isOptionSet("debug-irc-parsed") || Quassel::isOptionSet("debug-irc-parsed-id"));
+ _debugLogParsedNetId = Quassel::optionValue("debug-irc-parsed-id").toInt();
+
+ connect(this, &IrcParser::newEvent, coreSession()->eventManager(), &EventManager::postEvent);
}
-
-bool IrcParser::checkParamCount(const QString &cmd, const QList<QByteArray> ¶ms, int minParams)
+bool IrcParser::checkParamCount(const QString& cmd, const QList<QByteArray>& params, int minParams)
{
if (params.count() < minParams) {
qWarning() << "Expected" << minParams << "params for IRC command" << cmd << ", got:" << params;
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())
if (!Cipher::neededFeaturesAvailable())
return message;
- Cipher *cipher = qobject_cast<CoreNetwork *>(network)->cipher(bufferName);
+ Cipher* cipher = qobject_cast<CoreNetwork*>(network)->cipher(bufferName);
if (!cipher || cipher->key().isEmpty())
return message;
#endif
}
-
/* parse the raw server string and generate an appropriate event */
/* used to be handleServerMsg() */
-void IrcParser::processNetworkIncoming(NetworkDataEvent *e)
+void IrcParser::processNetworkIncoming(NetworkDataEvent* e)
{
- CoreNetwork *net = qobject_cast<CoreNetwork *>(e->network());
+ auto* net = qobject_cast<CoreNetwork*>(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()) {
+ const QByteArray rawMsg = e->data();
+ if (rawMsg.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<QByteArray> 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<QByteArray>::iterator iter = params.begin();
- while (iter != params.end()) {
- if (iter->isEmpty())
- iter = params.erase(iter);
- else
- ++iter;
+ // 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() << "<<" << rawMsg;
}
- if (!trailing.isEmpty())
- params << trailing;
- if (params.count() < 1) {
- qWarning() << "Received invalid string from server!";
- return;
+ QHash<IrcTagKey, QString> tags;
+ QString prefix;
+ QString cmd;
+ QList<QByteArray> params;
+ IrcDecoder::parseMessage([&net](const QByteArray& data) {
+ return net->serverDecode(data);
+ }, rawMsg, tags, prefix, cmd, params);
+
+ // Log the message if enabled and network ID matches or allows all
+ if (_debugLogParsedIrc && (_debugLogParsedNetId == -1 || net->networkId().toInt() == _debugLogParsedNetId)) {
+ // Include network ID
+ qDebug() << "IRC net" << net->networkId() << "<<" << tags << prefix << cmd << params;
}
- 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;
+ IrcTagKey serverTimeTag{"", "time", false};
+ if (tags.contains(serverTimeTag)) {
+ QDateTime serverTime = QDateTime::fromString(tags[serverTimeTag], "yyyy-MM-ddThh:mm:ss.zzzZ");
+ serverTime.setTimeSpec(Qt::UTC);
+ if (serverTime.isValid()) {
+ e->setTimestamp(serverTime);
+ } else {
+ qDebug() << "Invalid timestamp from server-time tag:" << tags[serverTimeTag];
}
- foo = net->serverDecode(params.takeFirst());
}
- // next string without a whitespace is the command
- cmd = foo.trimmed();
-
- QList<Event *> events;
+ QList<Event*> events;
EventManager::EventType type = EventManager::Invalid;
+ QString messageTarget;
uint num = cmd.toUInt();
if (num > 0) {
// numeric reply
if (params.count() == 0) {
- qWarning() << "Message received from server violates RFC and is ignored!" << msg;
+ qWarning() << "Message received from server violates RFC and is ignored!" << rawMsg;
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());
+ messageTarget = net->serverDecode(params.takeFirst());
type = EventManager::IrcEventNumeric;
}
else {
// any other irc command
QString typeName = QLatin1String("IrcEvent") + cmd.at(0).toUpper() + cmd.mid(1).toLower();
- type = eventManager()->eventTypeByName(typeName);
+ type = EventManager::eventTypeByName(typeName);
if (type == EventManager::Invalid) {
- type = eventManager()->eventTypeByName("IrcEventUnknown");
+ 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!
// 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
+ 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
+ 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) {
- QString target = net->isChannelName(*targetIter) ? *targetIter : senderNick;
+ // 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);
- events << new IrcEventRawMessage(EventManager::IrcEventRawPrivmsg, net, msg, prefix, target, e->timestamp());
+ IrcEventRawMessage* rawMessage = new IrcEventRawMessage(EventManager::IrcEventRawPrivmsg,
+ net,
+ tags,
+ msg,
+ prefix,
+ target,
+ e->timestamp());
+ if (isSelfMessage) {
+ // Self-messages need processed differently, tag as such via flag.
+ rawMessage->setFlag(EventManager::Self);
+ }
+ events << rawMessage;
}
}
break;
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
+ // :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("^\\[([^\\]]+)\\] ");
+ QRegExp welcomeRegExp(R"(^\[([^\]]+)\] )");
if (welcomeRegExp.indexIn(decMsg) != -1) {
QString channelname = welcomeRegExp.cap(1);
decMsg = decMsg.mid(welcomeRegExp.matchedLength());
- CoreIrcChannel *chan = static_cast<CoreIrcChannel *>(net->ircChannel(channelname)); // we only have CoreIrcChannels in the core, so this cast is safe
+ // we only have CoreIrcChannels in the core, so this cast is safe
+ CoreIrcChannel* chan = static_cast<CoreIrcChannel*>(net->ircChannel(channelname)); // NOLINT(cppcoreguidelines-pro-type-static-cast-downcast)
if (chan && !chan->receivedWelcomeMsg()) {
chan->setReceivedWelcomeMsg();
events << new MessageEvent(Message::Notice, net, decMsg, prefix, channelname, Message::None, e->timestamp());
else {
if (!target.isEmpty() && net->prefixes().contains(target.at(0)))
target = target.mid(1);
- if (!net->isChannelName(target))
- target = nickFromMask(prefix);
+
+ 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);
+ }
}
#ifdef HAVE_QCA2
// Handle DH1080 key exchange
- if (params[1].startsWith("DH1080_INIT")) {
- events << new KeyEvent(EventManager::KeyEvent, net, prefix, target, KeyEvent::Init, params[1].mid(12));
- } else if (params[1].startsWith("DH1080_FINISH")) {
- events << new KeyEvent(EventManager::KeyEvent, net, prefix, target, KeyEvent::Finish, params[1].mid(14));
- } else
+ // 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, tags, prefix, target, KeyEvent::Init, params[1].mid(12));
+ }
+ else if (params[1].startsWith("DH1080_FINISH") && keyExchangeAllowed) {
+ events << new KeyEvent(EventManager::KeyEvent, net, tags, prefix, target, KeyEvent::Finish, params[1].mid(14));
+ }
+ else
#endif
- events << new IrcEventRawMessage(EventManager::IrcEventRawNotice, net, params[1], prefix, target, e->timestamp());
+ {
+ IrcEventRawMessage* rawMessage = new IrcEventRawMessage(EventManager::IrcEventRawNotice,
+ net,
+ tags,
+ params[1],
+ prefix,
+ target,
+ e->timestamp());
+ if (isSelfMessage) {
+ // Self-messages need processed differently, tag as such via flag.
+ rawMessage->setFlag(EventManager::Self);
+ }
+ events << rawMessage;
+ }
}
}
break;
- // the following events need only special casing for param decoding
+ // the following events need only special casing for param decoding
case EventManager::IrcEventKick:
- if (params.count() >= 3) { // we have a reason
+ 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
+ decParams << net->channelDecode(decParams.first(), params.at(2)); // kick reason
}
break;
QString channel = net->serverDecode(params.at(0));
decParams << channel;
decParams << net->userDecode(nickFromMask(prefix), params.at(1));
+ net->updateNickFromMask(prefix);
}
break;
case EventManager::IrcEventQuit:
if (params.count() >= 1) {
decParams << net->userDecode(nickFromMask(prefix), params.at(0));
+ net->updateNickFromMask(prefix);
+ }
+ break;
+
+ case EventManager::IrcEventTagmsg:
+ 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);
+
+ 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;
+
+ IrcEvent* tagMsg = new IrcEvent(EventManager::IrcEventTagmsg, net, tags, prefix, {target});
+ if (isSelfMessage) {
+ // Self-messages need processed differently, tag as such via flag.
+ tagMsg->setFlag(EventManager::Self);
+ }
+ tagMsg->setTimestamp(e->timestamp());
+ events << tagMsg;
+ }
}
break;
}
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 */
decParams << net->channelDecode(channel, params.at(2));
}
break;
+ case 451: /* You have not registered... */
+ if (messageTarget.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;
}
default:
if (!decParams.isEmpty() && decParams.last().endsWith(' '))
decParams.append(decParams.takeLast().trimmed());
- IrcEvent *event;
+ IrcEvent* event;
if (type == EventManager::IrcEventNumeric)
- event = new IrcEventNumeric(num, net, prefix, target);
+ event = new IrcEventNumeric(num, net, tags, prefix, messageTarget);
else
- event = new IrcEvent(type, net, prefix);
+ event = new IrcEvent(type, net, tags, prefix);
event->setParams(decParams);
event->setTimestamp(e->timestamp());
events << event;
}
- foreach(Event *event, events) {
+ for (Event* event : events) {
emit newEvent(event);
}
}