src/core/corenetwork.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 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 #ifndef CORENETWORK_H
  22 #define CORENETWORK_H
  23
  24 #include "network.h"
  25 #include "coreircchannel.h"
  26 #include "coreircuser.h"
  27
  28 // IRCv3 capabilities
  29 #include "irccap.h"
  30
  31 #include <QTimer>
  32
  33 #ifdef HAVE_SSL
  34 # include <QSslSocket>
  35 # include <QSslError>
  36 #else
  37 # include <QTcpSocket>
  38 #endif
  39
  40 #ifdef HAVE_QCA2
  41 #  include "cipher.h"
  42 #endif
  43
  44 #include "coresession.h"
  45
  46 #include <functional>
  47
  48 class CoreIdentity;
  49 class CoreUserInputHandler;
  50 class CoreIgnoreListManager;
  51 class Event;
  52
  53 class CoreNetwork : public Network
  54 {
  55     SYNCABLE_OBJECT
  56         Q_OBJECT
  57
  58 public:
  59     CoreNetwork(const NetworkId &networkid, CoreSession *session);
  60     ~CoreNetwork();
  61     inline virtual const QMetaObject *syncMetaObject() const { return &Network::staticMetaObject; }
  62
  63     inline CoreIdentity *identityPtr() const { return coreSession()->identity(identity()); }
  64     inline CoreSession *coreSession() const { return _coreSession; }
  65     inline CoreNetworkConfig *networkConfig() const { return coreSession()->networkConfig(); }
  66
  67     inline CoreUserInputHandler *userInputHandler() const { return _userInputHandler; }
  68     inline CoreIgnoreListManager *ignoreListManager() { return coreSession()->ignoreListManager(); }
  69
  70     //! Decode a string using the server (network) decoding.
  71     inline QString serverDecode(const QByteArray &string) const { return decodeServerString(string); }
  72
  73     //! Decode a string using a channel-specific encoding if one is set (and use the standard encoding else).
  74     QString channelDecode(const QString &channelName, const QByteArray &string) const;
  75
  76     //! Decode a string using an IrcUser-specific encoding, if one exists (using the standaed encoding else).
  77     QString userDecode(const QString &userNick, const QByteArray &string) const;
  78
  79     //! Encode a string using the server (network) encoding.
  80     inline QByteArray serverEncode(const QString &string) const { return encodeServerString(string); }
  81
  82     //! Encode a string using the channel-specific encoding, if set, and use the standard encoding else.
  83     QByteArray channelEncode(const QString &channelName, const QString &string) const;
  84
  85     //! Encode a string using the user-specific encoding, if set, and use the standard encoding else.
  86     QByteArray userEncode(const QString &userNick, const QString &string) const;
  87
  88     inline QString channelKey(const QString &channel) const { return _channelKeys.value(channel.toLower(), QString()); }
  89
  90     inline QByteArray readChannelCipherKey(const QString &channel) const { return _cipherKeys.value(channel.toLower()); }
  91     inline void storeChannelCipherKey(const QString &channel, const QByteArray &key) { _cipherKeys[channel.toLower()] = key; }
  92
  93     inline bool isAutoWhoInProgress(const QString &channel) const { return _autoWhoPending.value(channel.toLower(), 0); }
  94
  95     inline UserId userId() const { return _coreSession->user(); }
  96
  97     inline QAbstractSocket::SocketState socketState() const { return socket.state(); }
  98     inline bool socketConnected() const { return socket.state() == QAbstractSocket::ConnectedState; }
  99     inline QHostAddress localAddress() const { return socket.localAddress(); }
 100     inline QHostAddress peerAddress() const { return socket.peerAddress(); }
 101     inline quint16 localPort() const { return socket.localPort(); }
 102     inline quint16 peerPort() const { return socket.peerPort(); }
 103
 104     /**
 105      * Gets whether or not a disconnect was expected.
 106      *
 107      * Distinguishes desired quits from unexpected disconnections such as socket errors or timeouts.
 108      *
 109      * @return True if disconnect was requested, otherwise false.
 110      */
 111     inline bool disconnectExpected() const { return _disconnectExpected; }
 112
 113     /**
 114      * Gets whether or not the server replies to automated PINGs with a valid timestamp
 115      *
 116      * Distinguishes between servers that reply by quoting the text sent, and those that respond
 117      * with whatever they want.
 118      *
 119      * @return True if a valid timestamp has been received as a PONG, otherwise false.
 120      */
 121     inline bool isPongTimestampValid() const { return _pongTimestampValid; }
 122
 123     /**
 124      * Gets whether or not an automated PING has been sent without any PONG received
 125      *
 126      * Reset whenever any PONG is received, not just the automated one sent.
 127      *
 128      * @return True if a PING has been sent without a PONG received, otherwise false.
 129      */
 130     inline bool isPongReplyPending() const { return _pongReplyPending; }
 131
 132     QList<QList<QByteArray>> splitMessage(const QString &cmd, const QString &message, std::function<QList<QByteArray>(QString &)> cmdGenerator);
 133
 134     // IRCv3 capability negotiation
 135
 136     /**
 137      * Checks if capability negotiation is currently ongoing.
 138      *
 139      * @returns True if in progress, otherwise false
 140      */
 141     inline bool capNegotiationInProgress() const { return (!_capsQueuedIndividual.empty() ||
 142                                                            !_capsQueuedBundled.empty()); }
 143
 144     /**
 145      * Queues a capability to be requested.
 146      *
 147      * Adds to the list of capabilities being requested.  If non-empty, CAP REQ messages are sent
 148      * to the IRC server.  This may happen at login or if capabilities are announced via CAP NEW.
 149      *
 150      * @param[in] capability Name of the capability
 151      */
 152     void queueCap(const QString &capability);
 153
 154     /**
 155      * Begins capability negotiation if capabilities are queued, otherwise returns.
 156      *
 157      * If any capabilities are queued, this will begin the cycle of taking each capability and
 158      * requesting it.  When no capabilities remain, capability negotiation is suitably ended.
 159      */
 160     void beginCapNegotiation();
 161
 162     /**
 163      * Ends capability negotiation.
 164      *
 165      * This won't have effect if other CAP commands are in the command queue before calling this
 166      * command.  It should only be called when capability negotiation is complete.
 167      */
 168     void endCapNegotiation();
 169
 170     /**
 171      * Queues the most recent capability set for retrying individually.
 172      *
 173      * Retries the most recent bundle of capabilities one at a time instead of as a group, working
 174      * around the issue that IRC servers can deny a group of requested capabilities without
 175      * indicating which capabilities failed.
 176      *
 177      * See: http://ircv3.net/specs/core/capability-negotiation-3.1.html
 178      *
 179      * This does NOT call CoreNetwork::sendNextCap().  Call that when ready afterwards.  Does
 180      * nothing if the last capability tried was individual instead of a set.
 181      */
 182     void retryCapsIndividually();
 183
 184     /**
 185      * List of capabilities requiring further core<->server messages to configure.
 186      *
 187      * For example, SASL requires the back-and-forth of AUTHENTICATE, so the next capability cannot
 188      * be immediately sent.
 189      *
 190      * Any capabilities in this list must call CoreNetwork::sendNextCap() on their own and they will
 191      * not be batched together with other capabilities.
 192      *
 193      * See: http://ircv3.net/specs/extensions/sasl-3.2.html
 194      */
 195     const QStringList capsRequiringConfiguration = QStringList {
 196         IrcCap::SASL
 197     };
 198
 199 public slots:
 200     virtual void setMyNick(const QString &mynick);
 201
 202     virtual void requestConnect() const;
 203     virtual void requestDisconnect() const;
 204     virtual void requestSetNetworkInfo(const NetworkInfo &info);
 205
 206     virtual void setUseAutoReconnect(bool);
 207     virtual void setAutoReconnectInterval(quint32);
 208     virtual void setAutoReconnectRetries(quint16);
 209
 210     void setPingInterval(int interval);
 211
 212     /**
 213      * Sets whether or not the IRC server has replied to PING with a valid timestamp
 214      *
 215      * This allows determining whether or not an IRC server responds to PING with a PONG that quotes
 216      * what was sent, or if it does something else (and therefore PONGs should be more aggressively
 217      * hidden).
 218      *
 219      * @param timestampValid If true, a valid timestamp has been received via PONG reply
 220      */
 221     void setPongTimestampValid(bool validTimestamp);
 222
 223     void connectToIrc(bool reconnecting = false);
 224     /**
 225      * Disconnect from the IRC server.
 226      *
 227      * Begin disconnecting from the IRC server, including optionally reconnecting.
 228      *
 229      * @param requested       If true, user requested this disconnect; don't try to reconnect
 230      * @param reason          Reason for quitting, defaulting to the user-configured quit reason
 231      * @param withReconnect   Reconnect to the network after disconnecting (e.g. ping timeout)
 232      * @param forceImmediate  Immediately disconnect from network, skipping queue of other commands
 233      */
 234     void disconnectFromIrc(bool requested = true, const QString &reason = QString(),
 235                            bool withReconnect = false, bool forceImmediate = false);
 236
 237     /**
 238      * Forcibly close the IRC server socket, waiting for it to close.
 239      *
 240      * Call CoreNetwork::disconnectFromIrc() first, allow the event loop to run, then if you need to
 241      * be sure the network's disconencted (e.g. clean-up), call this.
 242      *
 243      * @param msecs  Maximum time to wait for socket to close, in milliseconds.
 244      * @return True if socket closes successfully; false if error occurs or timeout reached
 245      */
 246     bool forceDisconnect(int msecs = 1000);
 247
 248     void userInput(BufferInfo bufferInfo, QString msg);
 249
 250     /**
 251      * Sends the raw (encoded) line, adding to the queue if needed, optionally with higher priority.
 252      *
 253      * @param[in] input   QByteArray of encoded characters
 254      * @param[in] prepend
 255      * @parmblock
 256      * If true, the line is prepended into the start of the queue, otherwise, it's appended to the
 257      * end.  This should be used sparingly, for if either the core or the IRC server cannot maintain
 258      * PING/PONG replies, the other side will close the connection.
 259      * @endparmblock
 260      */
 261     void putRawLine(const QByteArray input, const bool prepend = false);
 262
 263     /**
 264      * Sends the command with encoded parameters, with optional prefix or high priority.
 265      *
 266      * @param[in] cmd      Command to send, ignoring capitalization
 267      * @param[in] params   Parameters for the command, encoded within a QByteArray
 268      * @param[in] prefix   Optional command prefix
 269      * @param[in] prepend
 270      * @parmblock
 271      * If true, the command is prepended into the start of the queue, otherwise, it's appended to
 272      * the end.  This should be used sparingly, for if either the core or the IRC server cannot
 273      * maintain PING/PONG replies, the other side will close the connection.
 274      * @endparmblock
 275      */
 276     void putCmd(const QString &cmd, const QList<QByteArray> &params, const QByteArray &prefix = QByteArray(), const bool prepend = false);
 277
 278     /**
 279      * Sends the command for each set of encoded parameters, with optional prefix or high priority.
 280      *
 281      * @param[in] cmd         Command to send, ignoring capitalization
 282      * @param[in] params
 283      * @parmblock
 284      * List of parameter lists for the command, encoded within a QByteArray.  The command will be
 285      * sent multiple times, once for each set of params stored within the outer list.
 286      * @endparmblock
 287      * @param[in] prefix      Optional command prefix
 288      * @param[in] prependAll
 289      * @parmblock
 290      * If true, ALL of the commands are prepended into the start of the queue, otherwise, they're
 291      * appended to the end.  This should be used sparingly, for if either the core or the IRC server
 292      * cannot maintain PING/PONG replies, the other side will close the connection.
 293      * @endparmblock
 294      */
 295     void putCmd(const QString &cmd, const QList<QList<QByteArray>> &params, const QByteArray &prefix = QByteArray(), const bool prependAll = false);
 296
 297     void setChannelJoined(const QString &channel);
 298     void setChannelParted(const QString &channel);
 299     void addChannelKey(const QString &channel, const QString &key);
 300     void removeChannelKey(const QString &channel);
 301
 302     // Blowfish stuff
 303 #ifdef HAVE_QCA2
 304     Cipher *cipher(const QString &recipient);
 305     QByteArray cipherKey(const QString &recipient) const;
 306     void setCipherKey(const QString &recipient, const QByteArray &key);
 307     bool cipherUsesCBC(const QString &target);
 308 #endif
 309
 310     // Custom rate limiting (can be connected to signals)
 311
 312     /**
 313      * Update rate limiting according to Network configuration
 314      *
 315      * Updates the token bucket and message queue timer according to the network configuration, such
 316      * as on first load, or after changing settings.
 317      *
 318      * Calling this will reset any ongoing queue delays.  If messages exist in the queue when rate
 319      * limiting is disabled, messages will be quickly sent (100 ms) with new messages queued to send
 320      * until the queue is cleared.
 321      *
 322      * @see Network::useCustomMessageRate()
 323      * @see Network::messageRateBurstSize()
 324      * @see Network::messageRateDelay()
 325      * @see Network::unlimitedMessageRate()
 326      *
 327      * @param[in] forceUnlimited
 328      * @parmblock
 329      * If true, override user settings to disable message rate limiting, otherwise apply rate limits
 330      * set by the user.  Use with caution and remember to re-enable configured limits when done.
 331      * @endparmblock
 332      */
 333     void updateRateLimiting(const bool forceUnlimited = false);
 334
 335     /**
 336      * Resets the token bucket up to the maximum
 337      *
 338      * Call this if the connection's been reset after calling updateRateLimiting() if needed.
 339      *
 340      * @see CoreNetwork::updateRateLimiting()
 341      */
 342     void resetTokenBucket();
 343
 344     // IRCv3 capability negotiation (can be connected to signals)
 345
 346     /**
 347      * Indicates a capability is now available, with optional value in Network::capValue().
 348      *
 349      * @see Network::addCap()
 350      *
 351      * @param[in] capability Name of the capability
 352      */
 353     void serverCapAdded(const QString &capability);
 354
 355     /**
 356      * Indicates a capability was acknowledged (enabled by the IRC server).
 357      *
 358      * @see Network::acknowledgeCap()
 359      *
 360      * @param[in] capability Name of the capability
 361      */
 362     void serverCapAcknowledged(const QString &capability);
 363
 364     /**
 365      * Indicates a capability was removed from the list of available capabilities.
 366      *
 367      * @see Network::removeCap()
 368      *
 369      * @param[in] capability Name of the capability
 370      */
 371     void serverCapRemoved(const QString &capability);
 372
 373     /**
 374      * Sends the next capability from the queue.
 375      *
 376      * During nick registration if any capabilities remain queued, this will take the next and
 377      * request it.  When no capabilities remain, capability negotiation is ended.
 378      */
 379     void sendNextCap();
 380
 381     void setAutoWhoEnabled(bool enabled);
 382     void setAutoWhoInterval(int interval);
 383     void setAutoWhoDelay(int delay);
 384
 385     /**
 386      * Appends the given channel/nick to the front of the AutoWho queue.
 387      *
 388      * When 'away-notify' is enabled, this will trigger an immediate AutoWho since regular
 389      * who-cycles are disabled as per IRCv3 specifications.
 390      *
 391      * @param[in] channelOrNick Channel or nickname to WHO
 392      */
 393     void queueAutoWhoOneshot(const QString &channelOrNick);
 394
 395     bool setAutoWhoDone(const QString &channel);
 396
 397     void updateIssuedModes(const QString &requestedModes);
 398     void updatePersistentModes(QString addModes, QString removeModes);
 399     void resetPersistentModes();
 400
 401     Server usedServer() const;
 402
 403     inline void resetPingTimeout() { _pingCount = 0; }
 404
 405     /**
 406      * Marks the network as no longer having a pending reply to an automated PING
 407      */
 408     inline void resetPongReplyPending() { _pongReplyPending = false; }
 409
 410     inline void displayMsg(Message::Type msgType, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None)
 411     {
 412         emit displayMsg(networkId(), msgType, bufferType, target, text, sender, flags);
 413     }
 414
 415
 416 signals:
 417     void recvRawServerMsg(QString);
 418     void displayStatusMsg(QString);
 419     void displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
 420     void disconnected(NetworkId networkId);
 421     void connectionError(const QString &errorMsg);
 422
 423     void quitRequested(NetworkId networkId);
 424     void sslErrors(const QVariant &errorData);
 425
 426     void newEvent(Event *event);
 427     void socketInitialized(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort, qint64 socketId);
 428     void socketDisconnected(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort, qint64 socketId);
 429
 430 protected:
 431     inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new CoreIrcChannel(channelname, this); }
 432     inline virtual IrcUser *ircUserFactory(const QString &hostmask) { return new CoreIrcUser(hostmask, this); }
 433
 434 protected slots:
 435     // TODO: remove cached cipher keys, when appropriate
 436     //virtual void removeIrcUser(IrcUser *ircuser);
 437     //virtual void removeIrcChannel(IrcChannel *ircChannel);
 438     //virtual void removeChansAndUsers();
 439
 440 private slots:
 441     void socketHasData();
 442     void socketError(QAbstractSocket::SocketError);
 443     void socketInitialized();
 444     inline void socketCloseTimeout() { socket.abort(); }
 445     void socketDisconnected();
 446     void socketStateChanged(QAbstractSocket::SocketState);
 447     void networkInitialized();
 448
 449     void sendPerform();
 450     void restoreUserModes();
 451     void doAutoReconnect();
 452     void sendPing();
 453     void enablePingTimeout(bool enable = true);
 454     void disablePingTimeout();
 455     void sendAutoWho();
 456     void startAutoWhoCycle();
 457
 458 #ifdef HAVE_SSL
 459     void sslErrors(const QList<QSslError> &errors);
 460 #endif
 461
 462     /**
 463      * Check the message token bucket
 464      *
 465      * If rate limiting is disabled and the message queue is empty, this disables the token bucket
 466      * timer.  Otherwise, a queued message will be sent.
 467      *
 468      * @see CoreNetwork::fillBucketAndProcessQueue()
 469      */
 470     void checkTokenBucket();
 471
 472     /**
 473      * Top up token bucket and send as many queued messages as possible
 474      *
 475      * If there's any room for more tokens, add to the token bucket.  Separately, if there's any
 476      * messages to send, send until there's no more tokens or the queue is empty, whichever comes
 477      * first.
 478      */
 479     void fillBucketAndProcessQueue();
 480
 481     void writeToSocket(const QByteArray &data);
 482
 483 private:
 484     CoreSession *_coreSession;
 485
 486 #ifdef HAVE_SSL
 487     QSslSocket socket;
 488 #else
 489     QTcpSocket socket;
 490 #endif
 491     qint64 _socketId{0};
 492
 493     CoreUserInputHandler *_userInputHandler;
 494
 495     QHash<QString, QString> _channelKeys; // stores persistent channels and their passwords, if any
 496
 497     QTimer _autoReconnectTimer;
 498     int _autoReconnectCount;
 499
 500     QTimer _socketCloseTimer;
 501
 502     /* this flag triggers quitRequested() once the socket is closed
 503      * it is needed to determine whether or not the connection needs to be
 504      * in the automatic session restore. */
 505     bool _quitRequested;
 506     QString _quitReason;
 507
 508     bool _disconnectExpected;  /// If true, connection is quitting, expect a socket close
 509     // This avoids logging a spurious RemoteHostClosedError whenever disconnect is called without
 510     // specifying a permanent (saved to core session) disconnect.
 511
 512     bool _previousConnectionAttemptFailed;
 513     int _lastUsedServerIndex;
 514
 515     QTimer _pingTimer;
 516     qint64 _lastPingTime = 0;          ///< Unix time of most recently sent automatic ping
 517     uint _pingCount = 0;               ///< Unacknowledged automatic pings
 518     bool _sendPings = false;           ///< If true, pings should be periodically sent to server
 519     bool _pongTimestampValid = false;  ///< If true, IRC server responds to PING by quoting in PONG
 520     // This tracks whether or not a server responds to PING with a PONG of what was sent, or if it
 521     // does something else.  If false, PING reply hiding should be more aggressive.
 522     bool _pongReplyPending = false;    ///< If true, at least one PING sent without a PONG reply
 523
 524     QStringList _autoWhoQueue;
 525     QHash<QString, int> _autoWhoPending;
 526     QTimer _autoWhoTimer, _autoWhoCycleTimer;
 527
 528     // Maintain a list of CAPs that are being checked; if empty, negotiation finished
 529     // See http://ircv3.net/specs/core/capability-negotiation-3.2.html
 530     QStringList _capsQueuedIndividual;  /// Capabilities to check that require one at a time requests
 531     QStringList _capsQueuedBundled;     /// Capabilities to check that can be grouped together
 532     QStringList _capsQueuedLastBundle;  /// Most recent capability bundle requested (no individuals)
 533     // Some capabilities, such as SASL, require follow-up messages to be fully enabled.  These
 534     // capabilities should not be grouped with others to avoid requesting new capabilities while the
 535     // previous capability is still being set up.
 536     // Additionally, IRC servers can choose to send a 'NAK' to any set of requested capabilities.
 537     // If this happens, we need a way to retry each capability individually in order to avoid having
 538     // one failing capability (e.g. SASL) block all other capabilities.
 539
 540     bool _capNegotiationActive;         /// Whether or not full capability negotiation was started
 541     // Avoid displaying repeat "negotiation finished" messages
 542     bool _capInitialNegotiationEnded;   /// Whether or not initial capability negotiation finished
 543     // Avoid sending repeat "CAP END" replies when registration is already ended
 544
 545     /**
 546      * Gets the next set of capabilities to request, removing them from the queue.
 547      *
 548      * May return one or multiple space-separated capabilities, depending on queue.
 549      *
 550      * @returns Space-separated names of capabilities to request, or empty string if none remain
 551      */
 552     QString takeQueuedCaps();
 553
 554     /**
 555      * Maximum length of a single 'CAP REQ' command.
 556      *
 557      * To be safe, 100 chars.  Higher numbers should be possible; this is following the conservative
 558      * minimum number of characters that IRC servers must return in CAP NAK replies.  This also
 559      * means CAP NAK replies will contain the full list of denied capabilities.
 560      *
 561      * See: http://ircv3.net/specs/core/capability-negotiation-3.1.html
 562      */
 563     const int maxCapRequestLength = 100;
 564
 565     QTimer _tokenBucketTimer;
 566     // No need for int type as one cannot travel into the past (at least not yet, Doc)
 567     quint32 _messageDelay;       /// Token refill speed in ms
 568     quint32 _burstSize;          /// Size of the token bucket
 569     quint32 _tokenBucket;        /// The virtual bucket that holds the tokens
 570     QList<QByteArray> _msgQueue; /// Queue of messages waiting to be sent
 571     bool _skipMessageRates;      /// If true, skip all message rate limits
 572
 573     QString _requestedUserModes; // 2 strings separated by a '-' character. first part are requested modes to add, the second to remove
 574
 575     // List of blowfish keys for channels
 576     QHash<QString, QByteArray> _cipherKeys;
 577 };
 578
 579
 580 #endif //CORENETWORK_H