src/core/ircparser.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2019 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   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.                                           *
   9  *                                                                         *
  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.                          *
  14  *                                                                         *
  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  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #include "ircparser.h"
  22
  23 #include <QDebug>
  24
  25 #include "corenetwork.h"
  26 #include "eventmanager.h"
  27 #include "ircdecoder.h"
  28 #include "ircevent.h"
  29 #include "irctags.h"
  30 #include "messageevent.h"
  31 #include "networkevent.h"
  32
  33 #ifdef HAVE_QCA2
  34 #    include "cipher.h"
  35 #    include "keyevent.h"
  36 #endif
  37
  38 IrcParser::IrcParser(CoreSession* session)
  39     : QObject(session)
  40     , _coreSession(session)
  41 {
  42     // Check if raw IRC logging is enabled
  43     _debugLogRawIrc = (Quassel::isOptionSet("debug-irc") || Quassel::isOptionSet("debug-irc-id"));
  44     _debugLogRawNetId = Quassel::optionValue("debug-irc-id").toInt();
  45     // Check if parsed IRC logging is enabled
  46     _debugLogParsedIrc = (Quassel::isOptionSet("debug-irc-parsed") || Quassel::isOptionSet("debug-irc-parsed-id"));
  47     _debugLogParsedNetId = Quassel::optionValue("debug-irc-parsed-id").toInt();
  48
  49     connect(this, &IrcParser::newEvent, coreSession()->eventManager(), &EventManager::postEvent);
  50 }
  51
  52 bool IrcParser::checkParamCount(const QString& cmd, const QList<QByteArray>& params, int minParams)
  53 {
  54     if (params.count() < minParams) {
  55         qWarning() << "Expected" << minParams << "params for IRC command" << cmd << ", got:" << params;
  56         return false;
  57     }
  58     return true;
  59 }
  60
  61 QByteArray IrcParser::decrypt(Network* network, const QString& bufferName, const QByteArray& message, bool isTopic)
  62 {
  63 #ifdef HAVE_QCA2
  64     if (message.isEmpty())
  65         return message;
  66
  67     if (!Cipher::neededFeaturesAvailable())
  68         return message;
  69
  70     Cipher* cipher = qobject_cast<CoreNetwork*>(network)->cipher(bufferName);
  71     if (!cipher || cipher->key().isEmpty())
  72         return message;
  73
  74     return isTopic ? cipher->decryptTopic(message) : cipher->decrypt(message);
  75 #else
  76     Q_UNUSED(network);
  77     Q_UNUSED(bufferName);
  78     Q_UNUSED(isTopic);
  79     return message;
  80 #endif
  81 }
  82
  83 /* parse the raw server string and generate an appropriate event */
  84 /* used to be handleServerMsg()                                  */
  85 void IrcParser::processNetworkIncoming(NetworkDataEvent* e)
  86 {
  87     auto* net = qobject_cast<CoreNetwork*>(e->network());
  88     if (!net) {
  89         qWarning() << "Received network event without valid network pointer!";
  90         return;
  91     }
  92
  93     // note that the IRC server is still alive
  94     net->resetPingTimeout();
  95
  96     const QByteArray rawMsg = e->data();
  97     if (rawMsg.isEmpty()) {
  98         qWarning() << "Received empty string from server!";
  99         return;
 100     }
 101
 102     // Log the message if enabled and network ID matches or allows all
 103     if (_debugLogRawIrc && (_debugLogRawNetId == -1 || net->networkId().toInt() == _debugLogRawNetId)) {
 104         // Include network ID
 105         qDebug() << "IRC net" << net->networkId() << "<<" << rawMsg;
 106     }
 107
 108     QHash<IrcTagKey, QString> tags;
 109     QString prefix;
 110     QString cmd;
 111     QList<QByteArray> params;
 112     IrcDecoder::parseMessage([&net](const QByteArray& data) {
 113         return net->serverDecode(data);
 114     }, rawMsg, tags, prefix, cmd, params);
 115
 116     // Log the message if enabled and network ID matches or allows all
 117     if (_debugLogParsedIrc && (_debugLogParsedNetId == -1 || net->networkId().toInt() == _debugLogParsedNetId)) {
 118         // Include network ID
 119         qDebug() << "IRC net" << net->networkId() << "<<" << tags << prefix << cmd << params;
 120     }
 121
 122     QList<Event*> events;
 123     EventManager::EventType type = EventManager::Invalid;
 124
 125     QString messageTarget;
 126     uint num = cmd.toUInt();
 127     if (num > 0) {
 128         // numeric reply
 129         if (params.count() == 0) {
 130             qWarning() << "Message received from server violates RFC and is ignored!" << rawMsg;
 131             return;
 132         }
 133         // numeric replies have the target as first param (RFC 2812 - 2.4). this is usually our own nick. Remove this!
 134         messageTarget = net->serverDecode(params.takeFirst());
 135         type = EventManager::IrcEventNumeric;
 136     }
 137     else {
 138         // any other irc command
 139         QString typeName = QLatin1String("IrcEvent") + cmd.at(0).toUpper() + cmd.mid(1).toLower();
 140         type = EventManager::eventTypeByName(typeName);
 141         if (type == EventManager::Invalid) {
 142             type = EventManager::eventTypeByName("IrcEventUnknown");
 143             Q_ASSERT(type != EventManager::Invalid);
 144         }
 145     }
 146
 147     // Almost always, all params are server-encoded. There's a few exceptions, let's catch them here!
 148     // Possibly not the best option, we might want something more generic? Maybe yet another layer of
 149     // unencoded events with event handlers for the exceptions...
 150     // Also, PRIVMSG and NOTICE need some special handling, we put this in here as well, so we get out
 151     // nice pre-parsed events that the CTCP handler can consume.
 152
 153     QStringList decParams;
 154     bool defaultHandling = true;  // whether to automatically copy the remaining params and send the event
 155
 156     switch (type) {
 157     case EventManager::IrcEventPrivmsg:
 158         defaultHandling = false;  // this might create a list of events
 159
 160         if (checkParamCount(cmd, params, 1)) {
 161             QString senderNick = nickFromMask(prefix);
 162             net->updateNickFromMask(prefix);
 163             // Check if the sender is our own nick.  If so, treat message as if sent by ourself.
 164             // See http://ircv3.net/specs/extensions/echo-message-3.2.html
 165             // Cache the result to avoid multiple redundant comparisons
 166             bool isSelfMessage = net->isMyNick(senderNick);
 167
 168             QByteArray msg = params.count() < 2 ? QByteArray() : params.at(1);
 169
 170             QStringList targets = net->serverDecode(params.at(0)).split(',', QString::SkipEmptyParts);
 171             QStringList::const_iterator targetIter;
 172             for (targetIter = targets.constBegin(); targetIter != targets.constEnd(); ++targetIter) {
 173                 // For self-messages, keep the target, don't set it to the senderNick
 174                 QString target = net->isChannelName(*targetIter) || net->isStatusMsg(*targetIter) || isSelfMessage ? *targetIter : senderNick;
 175
 176                 // Note: self-messages could be encrypted with a different key.  If issues arise,
 177                 // consider including this within an if (!isSelfMessage) block
 178                 msg = decrypt(net, target, msg);
 179
 180                 IrcEventRawMessage* rawMessage = new IrcEventRawMessage(EventManager::IrcEventRawPrivmsg,
 181                                                                         net,
 182                                                                         tags,
 183                                                                         msg,
 184                                                                         prefix,
 185                                                                         target,
 186                                                                         e->timestamp());
 187                 if (isSelfMessage) {
 188                     // Self-messages need processed differently, tag as such via flag.
 189                     rawMessage->setFlag(EventManager::Self);
 190                 }
 191                 events << rawMessage;
 192             }
 193         }
 194         break;
 195
 196     case EventManager::IrcEventNotice:
 197         defaultHandling = false;
 198
 199         if (checkParamCount(cmd, params, 2)) {
 200             // Check if the sender is our own nick.  If so, treat message as if sent by ourself.
 201             // See http://ircv3.net/specs/extensions/echo-message-3.2.html
 202             // Cache the result to avoid multiple redundant comparisons
 203             bool isSelfMessage = net->isMyNick(nickFromMask(prefix));
 204
 205             QStringList targets = net->serverDecode(params.at(0)).split(',', QString::SkipEmptyParts);
 206             QStringList::const_iterator targetIter;
 207             for (targetIter = targets.constBegin(); targetIter != targets.constEnd(); ++targetIter) {
 208                 QString target = *targetIter;
 209
 210                 // special treatment for welcome messages like:
 211                 // :ChanServ!ChanServ@services. NOTICE egst :[#apache] Welcome, this is #apache. Please read the in-channel topic message.
 212                 // This channel is being logged by IRSeekBot. If you have any question please see http://blog.freenode.net/?p=68
 213                 if (!net->isChannelName(target)) {
 214                     QString decMsg = net->serverDecode(params.at(1));
 215                     QRegExp welcomeRegExp(R"(^\[([^\]]+)\] )");
 216                     if (welcomeRegExp.indexIn(decMsg) != -1) {
 217                         QString channelname = welcomeRegExp.cap(1);
 218                         decMsg = decMsg.mid(welcomeRegExp.matchedLength());
 219                         // we only have CoreIrcChannels in the core, so this cast is safe
 220                         CoreIrcChannel* chan = static_cast<CoreIrcChannel*>(net->ircChannel(channelname)); // NOLINT(cppcoreguidelines-pro-type-static-cast-downcast)
 221                         if (chan && !chan->receivedWelcomeMsg()) {
 222                             chan->setReceivedWelcomeMsg();
 223                             events << new MessageEvent(Message::Notice, net, decMsg, prefix, channelname, Message::None, e->timestamp());
 224                             continue;
 225                         }
 226                     }
 227                 }
 228
 229                 if (prefix.isEmpty() || target == "AUTH") {
 230                     target = QString();
 231                 }
 232                 else {
 233                     if (!target.isEmpty() && net->prefixes().contains(target.at(0)))
 234                         target = target.mid(1);
 235
 236                     if (!net->isChannelName(target)) {
 237                         // For self-messages, keep the target, don't set it to the sender prefix
 238                         if (!isSelfMessage) {
 239                             target = nickFromMask(prefix);
 240                         }
 241                         net->updateNickFromMask(prefix);
 242                     }
 243                 }
 244
 245 #ifdef HAVE_QCA2
 246                 // Handle DH1080 key exchange
 247                 // Don't allow key exchange in channels, and don't allow it for self-messages.
 248                 bool keyExchangeAllowed = (!net->isChannelName(target) && !isSelfMessage);
 249                 if (params[1].startsWith("DH1080_INIT") && keyExchangeAllowed) {
 250                     events << new KeyEvent(EventManager::KeyEvent, net, tags, prefix, target, KeyEvent::Init, params[1].mid(12));
 251                 }
 252                 else if (params[1].startsWith("DH1080_FINISH") && keyExchangeAllowed) {
 253                     events << new KeyEvent(EventManager::KeyEvent, net, tags, prefix, target, KeyEvent::Finish, params[1].mid(14));
 254                 }
 255                 else
 256 #endif
 257                 {
 258                     IrcEventRawMessage* rawMessage = new IrcEventRawMessage(EventManager::IrcEventRawNotice,
 259                                                                             net,
 260                                                                             tags,
 261                                                                             params[1],
 262                                                                             prefix,
 263                                                                             target,
 264                                                                             e->timestamp());
 265                     if (isSelfMessage) {
 266                         // Self-messages need processed differently, tag as such via flag.
 267                         rawMessage->setFlag(EventManager::Self);
 268                     }
 269                     events << rawMessage;
 270                 }
 271             }
 272         }
 273         break;
 274
 275         // the following events need only special casing for param decoding
 276     case EventManager::IrcEventKick:
 277         if (params.count() >= 3) {  // we have a reason
 278             decParams << net->serverDecode(params.at(0)) << net->serverDecode(params.at(1));
 279             decParams << net->channelDecode(decParams.first(), params.at(2));  // kick reason
 280         }
 281         break;
 282
 283     case EventManager::IrcEventPart:
 284         if (params.count() >= 2) {
 285             QString channel = net->serverDecode(params.at(0));
 286             decParams << channel;
 287             decParams << net->userDecode(nickFromMask(prefix), params.at(1));
 288             net->updateNickFromMask(prefix);
 289         }
 290         break;
 291
 292     case EventManager::IrcEventQuit:
 293         if (params.count() >= 1) {
 294             decParams << net->userDecode(nickFromMask(prefix), params.at(0));
 295             net->updateNickFromMask(prefix);
 296         }
 297         break;
 298
 299     case EventManager::IrcEventTagmsg:
 300         defaultHandling = false;  // this might create a list of events
 301
 302         if (checkParamCount(cmd, params, 1)) {
 303             QString senderNick = nickFromMask(prefix);
 304             net->updateNickFromMask(prefix);
 305             // Check if the sender is our own nick.  If so, treat message as if sent by ourself.
 306             // See http://ircv3.net/specs/extensions/echo-message-3.2.html
 307             // Cache the result to avoid multiple redundant comparisons
 308             bool isSelfMessage = net->isMyNick(senderNick);
 309
 310             QStringList targets = net->serverDecode(params.at(0)).split(',', QString::SkipEmptyParts);
 311             QStringList::const_iterator targetIter;
 312             for (targetIter = targets.constBegin(); targetIter != targets.constEnd(); ++targetIter) {
 313                 // For self-messages, keep the target, don't set it to the senderNick
 314                 QString target = net->isChannelName(*targetIter) || net->isStatusMsg(*targetIter) || isSelfMessage ? *targetIter : senderNick;
 315
 316                 IrcEvent* tagMsg = new IrcEvent(EventManager::IrcEventTagmsg, net, tags, prefix, {target});
 317                 if (isSelfMessage) {
 318                     // Self-messages need processed differently, tag as such via flag.
 319                     tagMsg->setFlag(EventManager::Self);
 320                 }
 321                 tagMsg->setTimestamp(e->timestamp());
 322                 events << tagMsg;
 323             }
 324         }
 325         break;
 326
 327     case EventManager::IrcEventTopic:
 328         if (params.count() >= 1) {
 329             QString channel = net->serverDecode(params.at(0));
 330             decParams << channel;
 331             decParams << (params.count() >= 2 ? net->channelDecode(channel, decrypt(net, channel, params.at(1), true)) : QString());
 332         }
 333         break;
 334
 335     case EventManager::IrcEventAway:
 336         {
 337             // Update hostmask info first.  This will create the nick if it doesn't exist, e.g.
 338             // away-notify data being sent before JOIN messages.
 339             net->updateNickFromMask(prefix);
 340             // Separate nick in order to separate server and user decoding
 341             QString nick = nickFromMask(prefix);
 342             decParams << nick;
 343             decParams << (params.count() >= 1 ? net->userDecode(nick, params.at(0)) : QString());
 344         }
 345         break;
 346
 347     case EventManager::IrcEventNumeric:
 348         switch (num) {
 349         case 301: /* RPL_AWAY */
 350             if (params.count() >= 2) {
 351                 QString nick = net->serverDecode(params.at(0));
 352                 decParams << nick;
 353                 decParams << net->userDecode(nick, params.at(1));
 354             }
 355             break;
 356
 357         case 332: /* RPL_TOPIC */
 358             if (params.count() >= 2) {
 359                 QString channel = net->serverDecode(params.at(0));
 360                 decParams << channel;
 361                 decParams << net->channelDecode(channel, decrypt(net, channel, params.at(1), true));
 362             }
 363             break;
 364
 365         case 333: /* Topic set by... */
 366             if (params.count() >= 3) {
 367                 QString channel = net->serverDecode(params.at(0));
 368                 decParams << channel << net->serverDecode(params.at(1));
 369                 decParams << net->channelDecode(channel, params.at(2));
 370             }
 371             break;
 372         case 451: /* You have not registered... */
 373             if (messageTarget.compare("CAP", Qt::CaseInsensitive) == 0) {
 374                 // :irc.server.com 451 CAP :You have not registered
 375                 // If server doesn't support capabilities, it will report this message.  Turn it
 376                 // into a nicer message since it's not a real error.
 377                 defaultHandling = false;
 378                 events << new MessageEvent(Message::Server,
 379                                            e->network(),
 380                                            tr("Capability negotiation not supported"),
 381                                            QString(),
 382                                            QString(),
 383                                            Message::None,
 384                                            e->timestamp());
 385             }
 386             break;
 387         }
 388
 389     default:
 390         break;
 391     }
 392
 393     if (defaultHandling && type != EventManager::Invalid) {
 394         for (int i = decParams.count(); i < params.count(); i++)
 395             decParams << net->serverDecode(params.at(i));
 396
 397         // We want to trim the last param just in case, except for PRIVMSG and NOTICE
 398         // ... but those happen to be the only ones not using defaultHandling anyway
 399         if (!decParams.isEmpty() && decParams.last().endsWith(' '))
 400             decParams.append(decParams.takeLast().trimmed());
 401
 402         IrcEvent* event;
 403         if (type == EventManager::IrcEventNumeric)
 404             event = new IrcEventNumeric(num, net, tags, prefix, messageTarget);
 405         else
 406             event = new IrcEvent(type, net, tags, prefix);
 407         event->setParams(decParams);
 408         event->setTimestamp(e->timestamp());
 409         events << event;
 410     }
 411
 412     for (Event* event : events) {
 413         emit newEvent(event);
 414     }
 415 }