/***************************************************************************
- * Copyright (C) 2005-2015 by the Quassel Project *
+ * Copyright (C) 2005-2018 by the Quassel Project *
* devel@quassel-irc.org *
* *
* This program is free software; you can redistribute it and/or modify *
#include "coreircchannel.h"
#include "coreircuser.h"
+// IRCv3 capabilities
+#include "irccap.h"
+
#include <QTimer>
#ifdef HAVE_SSL
inline quint16 localPort() const { return socket.localPort(); }
inline quint16 peerPort() const { return socket.peerPort(); }
- QList<QList<QByteArray>> splitMessage(const QString &cmd, const QString &message, std::function<QList<QByteArray>(QString &)> cmdGenerator);
-
- // IRCv3 capability negotiation
-
/**
- * Checks if a given capability is enabled.
+ * Gets whether or not a disconnect was expected.
+ *
+ * Distinguishes desired quits from unexpected disconnections such as socket errors or timeouts.
*
- * @param[in] capability Name of capability
- * @returns True if enabled, otherwise false
+ * @return True if disconnect was requested, otherwise false.
*/
- inline bool capEnabled(const QString &capability) const { return _capsSupported.contains(capability); }
+ inline bool disconnectExpected() const { return _disconnectExpected; }
+
+ QList<QList<QByteArray>> splitMessage(const QString &cmd, const QString &message, std::function<QList<QByteArray>(QString &)> cmdGenerator);
+
+ // IRCv3 capability negotiation
/**
* Checks if capability negotiation is currently ongoing.
*
* @returns True if in progress, otherwise false
*/
- inline bool capNegotiationInProgress() const { return !_capsQueued.empty(); }
+ inline bool capNegotiationInProgress() const { return (!_capsQueuedIndividual.empty() ||
+ !_capsQueuedBundled.empty()); }
/**
- * Gets the value of an enabled or pending capability, e.g. sasl=plain.
+ * Queues a capability to be requested.
*
- * @param[in] capability Name of capability
- * @returns Value of capability if one was specified, otherwise empty string
- */
- QString capValue(const QString &capability) const;
-
- /**
- * Gets the next capability to request, removing it from the queue.
+ * Adds to the list of capabilities being requested. If non-empty, CAP REQ messages are sent
+ * to the IRC server. This may happen at login or if capabilities are announced via CAP NEW.
*
- * @returns Name of capability to request
+ * @param[in] capability Name of the capability
*/
- QString takeQueuedCap();
-
- // Specific capabilities for easy reference
+ void queueCap(const QString &capability);
/**
- * Gets the status of the sasl authentication capability.
- *
- * http://ircv3.net/specs/extensions/sasl-3.2.html
+ * Begins capability negotiation if capabilities are queued, otherwise returns.
*
- * @returns True if SASL authentication is enabled, otherwise false
+ * If any capabilities are queued, this will begin the cycle of taking each capability and
+ * requesting it. When no capabilities remain, capability negotiation is suitably ended.
*/
- inline bool useCapSASL() const { return capEnabled("sasl"); }
+ void beginCapNegotiation();
/**
- * Gets the status of the away-notify capability.
+ * Ends capability negotiation.
*
- * http://ircv3.net/specs/extensions/away-notify-3.1.html
- *
- * @returns True if away-notify is enabled, otherwise false
+ * This won't have effect if other CAP commands are in the command queue before calling this
+ * command. It should only be called when capability negotiation is complete.
*/
- inline bool useCapAwayNotify() const { return capEnabled("away-notify"); }
+ void endCapNegotiation();
/**
- * Gets the status of the account-notify capability.
- *
- * http://ircv3.net/specs/extensions/account-notify-3.1.html
+ * Queues the most recent capability set for retrying individually.
*
- * @returns True if account-notify is enabled, otherwise false
- */
- inline bool useCapAccountNotify() const { return capEnabled("account-notify"); }
-
- /**
- * Gets the status of the extended-join capability.
+ * Retries the most recent bundle of capabilities one at a time instead of as a group, working
+ * around the issue that IRC servers can deny a group of requested capabilities without
+ * indicating which capabilities failed.
*
- * http://ircv3.net/specs/extensions/extended-join-3.1.html
+ * See: http://ircv3.net/specs/core/capability-negotiation-3.1.html
*
- * @returns True if extended-join is enabled, otherwise false
+ * This does NOT call CoreNetwork::sendNextCap(). Call that when ready afterwards. Does
+ * nothing if the last capability tried was individual instead of a set.
*/
- inline bool useCapExtendedJoin() const { return capEnabled("extended-join"); }
+ void retryCapsIndividually();
/**
- * Gets the status of the userhost-in-names capability.
+ * List of capabilities requiring further core<->server messages to configure.
*
- * http://ircv3.net/specs/extensions/userhost-in-names-3.2.html
+ * For example, SASL requires the back-and-forth of AUTHENTICATE, so the next capability cannot
+ * be immediately sent.
*
- * @returns True if userhost-in-names is enabled, otherwise false
- */
- inline bool useCapUserhostInNames() const { return capEnabled("userhost-in-names"); }
-
- /**
- * Gets the status of the multi-prefix capability.
+ * Any capabilities in this list must call CoreNetwork::sendNextCap() on their own and they will
+ * not be batched together with other capabilities.
*
- * http://ircv3.net/specs/extensions/multi-prefix-3.1.html
- *
- * @returns True if multi-prefix is enabled, otherwise false
+ * See: http://ircv3.net/specs/extensions/sasl-3.2.html
*/
- inline bool useCapMultiPrefix() const { return capEnabled("multi-prefix"); }
+ const QStringList capsRequiringConfiguration = QStringList {
+ IrcCap::SASL
+ };
public slots:
virtual void setMyNick(const QString &mynick);
void setPingInterval(int interval);
void connectToIrc(bool reconnecting = false);
- void disconnectFromIrc(bool requested = true, const QString &reason = QString(), bool withReconnect = false);
+ /**
+ * Disconnect from the IRC server.
+ *
+ * Begin disconnecting from the IRC server, including optionally reconnecting.
+ *
+ * @param requested If true, user requested this disconnect; don't try to reconnect
+ * @param reason Reason for quitting, defaulting to the user-configured quit reason
+ * @param withReconnect Reconnect to the network after disconnecting (e.g. ping timeout)
+ * @param forceImmediate Immediately disconnect from network, skipping queue of other commands
+ */
+ void disconnectFromIrc(bool requested = true, const QString &reason = QString(),
+ bool withReconnect = false, bool forceImmediate = false);
+
+ /**
+ * Forcibly close the IRC server socket, waiting for it to close.
+ *
+ * Call CoreNetwork::disconnectFromIrc() first, allow the event loop to run, then if you need to
+ * be sure the network's disconencted (e.g. clean-up), call this.
+ *
+ * @param msecs Maximum time to wait for socket to close, in milliseconds.
+ * @return True if socket closes successfully; false if error occurs or timeout reached
+ */
+ bool forceDisconnect(int msecs = 1000);
void userInput(BufferInfo bufferInfo, QString msg);
- void putRawLine(QByteArray input);
- void putCmd(const QString &cmd, const QList<QByteArray> ¶ms, const QByteArray &prefix = QByteArray());
- void putCmd(const QString &cmd, const QList<QList<QByteArray>> ¶ms, const QByteArray &prefix = QByteArray());
+
+ /**
+ * Sends the raw (encoded) line, adding to the queue if needed, optionally with higher priority.
+ *
+ * @param[in] input QByteArray of encoded characters
+ * @param[in] prepend
+ * @parmblock
+ * If true, the line is prepended into the start of the queue, otherwise, it's appended to the
+ * end. This should be used sparingly, for if either the core or the IRC server cannot maintain
+ * PING/PONG replies, the other side will close the connection.
+ * @endparmblock
+ */
+ void putRawLine(const QByteArray input, const bool prepend = false);
+
+ /**
+ * Sends the command with encoded parameters, with optional prefix or high priority.
+ *
+ * @param[in] cmd Command to send, ignoring capitalization
+ * @param[in] params Parameters for the command, encoded within a QByteArray
+ * @param[in] prefix Optional command prefix
+ * @param[in] prepend
+ * @parmblock
+ * If true, the command is prepended into the start of the queue, otherwise, it's appended to
+ * the end. This should be used sparingly, for if either the core or the IRC server cannot
+ * maintain PING/PONG replies, the other side will close the connection.
+ * @endparmblock
+ */
+ void putCmd(const QString &cmd, const QList<QByteArray> ¶ms, const QByteArray &prefix = QByteArray(), const bool prepend = false);
+
+ /**
+ * Sends the command for each set of encoded parameters, with optional prefix or high priority.
+ *
+ * @param[in] cmd Command to send, ignoring capitalization
+ * @param[in] params
+ * @parmblock
+ * List of parameter lists for the command, encoded within a QByteArray. The command will be
+ * sent multiple times, once for each set of params stored within the outer list.
+ * @endparmblock
+ * @param[in] prefix Optional command prefix
+ * @param[in] prependAll
+ * @parmblock
+ * If true, ALL of the commands are prepended into the start of the queue, otherwise, they're
+ * appended to the end. This should be used sparingly, for if either the core or the IRC server
+ * cannot maintain PING/PONG replies, the other side will close the connection.
+ * @endparmblock
+ */
+ void putCmd(const QString &cmd, const QList<QList<QByteArray>> ¶ms, const QByteArray &prefix = QByteArray(), const bool prependAll = false);
void setChannelJoined(const QString &channel);
void setChannelParted(const QString &channel);
bool cipherUsesCBC(const QString &target);
#endif
+ // Custom rate limiting (can be connected to signals)
+
+ /**
+ * Update rate limiting according to Network configuration
+ *
+ * Updates the token bucket and message queue timer according to the network configuration, such
+ * as on first load, or after changing settings.
+ *
+ * Calling this will reset any ongoing queue delays. If messages exist in the queue when rate
+ * limiting is disabled, messages will be quickly sent (100 ms) with new messages queued to send
+ * until the queue is cleared.
+ *
+ * @see Network::useCustomMessageRate()
+ * @see Network::messageRateBurstSize()
+ * @see Network::messageRateDelay()
+ * @see Network::unlimitedMessageRate()
+ *
+ * @param[in] forceUnlimited
+ * @parmblock
+ * If true, override user settings to disable message rate limiting, otherwise apply rate limits
+ * set by the user. Use with caution and remember to re-enable configured limits when done.
+ * @endparmblock
+ */
+ void updateRateLimiting(const bool forceUnlimited = false);
+
+ /**
+ * Resets the token bucket up to the maximum
+ *
+ * Call this if the connection's been reset after calling updateRateLimiting() if needed.
+ *
+ * @see CoreNetwork::updateRateLimiting()
+ */
+ void resetTokenBucket();
+
// IRCv3 capability negotiation (can be connected to signals)
/**
- * Marks a capability as accepted, providing an optional value.
+ * Indicates a capability is now available, with optional value in Network::capValue().
*
- * Removes it from queue of pending capabilities and triggers any capability-specific
- * activation.
+ * @see Network::addCap()
*
* @param[in] capability Name of the capability
- * @param[in] value
- * @parblock
- * Optional value of the capability, e.g. sasl=plain. If left empty, will be copied from the
- * pending capability.
- * @endparblock
*/
- void addCap(const QString &capability, const QString &value = QString());
+ void serverCapAdded(const QString &capability);
/**
- * Marks a capability as denied.
+ * Indicates a capability was acknowledged (enabled by the IRC server).
*
- * Removes it from the queue of pending capabilities and triggers any capability-specific
- * deactivation.
+ * @see Network::acknowledgeCap()
*
* @param[in] capability Name of the capability
*/
- void removeCap(const QString &capability);
+ void serverCapAcknowledged(const QString &capability);
/**
- * Queues a capability as available but not yet accepted or denied.
+ * Indicates a capability was removed from the list of available capabilities.
*
- * Capabilities should be queued when registration pauses for CAP LS for capabilities are only
- * requested during login.
+ * @see Network::removeCap()
*
* @param[in] capability Name of the capability
- * @param[in] value Optional value of the capability, e.g. sasl=plain
*/
- void queuePendingCap(const QString &capability, const QString &value = QString());
+ void serverCapRemoved(const QString &capability);
+
+ /**
+ * Sends the next capability from the queue.
+ *
+ * During nick registration if any capabilities remain queued, this will take the next and
+ * request it. When no capabilities remain, capability negotiation is ended.
+ */
+ void sendNextCap();
void setAutoWhoEnabled(bool enabled);
void setAutoWhoInterval(int interval);
void sslErrors(const QList<QSslError> &errors);
#endif
+ /**
+ * Check the message token bucket
+ *
+ * If rate limiting is disabled and the message queue is empty, this disables the token bucket
+ * timer. Otherwise, a queued message will be sent.
+ *
+ * @see CoreNetwork::fillBucketAndProcessQueue()
+ */
+ void checkTokenBucket();
+
+ /**
+ * Top up token bucket and send as many queued messages as possible
+ *
+ * If there's any room for more tokens, add to the token bucket. Separately, if there's any
+ * messages to send, send until there's no more tokens or the queue is empty, whichever comes
+ * first.
+ */
void fillBucketAndProcessQueue();
void writeToSocket(const QByteArray &data);
bool _quitRequested;
QString _quitReason;
+ bool _disconnectExpected; /// If true, connection is quitting, expect a socket close
+ // This avoids logging a spurious RemoteHostClosedError whenever disconnect is called without
+ // specifying a permanent (saved to core session) disconnect.
+
bool _previousConnectionAttemptFailed;
int _lastUsedServerIndex;
QHash<QString, int> _autoWhoPending;
QTimer _autoWhoTimer, _autoWhoCycleTimer;
- // CAPs may have parameter values
+ // Maintain a list of CAPs that are being checked; if empty, negotiation finished
// See http://ircv3.net/specs/core/capability-negotiation-3.2.html
- QStringList _capsQueued; /// Capabilities to be checked
- QHash<QString, QString> _capsPending; /// Capabilities pending 'CAP ACK' from server
- QHash<QString, QString> _capsSupported; /// Enabled capabilities that received 'CAP ACK'
+ QStringList _capsQueuedIndividual; /// Capabilities to check that require one at a time requests
+ QStringList _capsQueuedBundled; /// Capabilities to check that can be grouped together
+ QStringList _capsQueuedLastBundle; /// Most recent capability bundle requested (no individuals)
+ // Some capabilities, such as SASL, require follow-up messages to be fully enabled. These
+ // capabilities should not be grouped with others to avoid requesting new capabilities while the
+ // previous capability is still being set up.
+ // Additionally, IRC servers can choose to send a 'NAK' to any set of requested capabilities.
+ // If this happens, we need a way to retry each capability individually in order to avoid having
+ // one failing capability (e.g. SASL) block all other capabilities.
+
+ bool _capNegotiationActive; /// Whether or not full capability negotiation was started
+ // Avoid displaying repeat "negotiation finished" messages
+ bool _capInitialNegotiationEnded; /// Whether or not initial capability negotiation finished
+ // Avoid sending repeat "CAP END" replies when registration is already ended
+
+ /**
+ * Gets the next set of capabilities to request, removing them from the queue.
+ *
+ * May return one or multiple space-separated capabilities, depending on queue.
+ *
+ * @returns Space-separated names of capabilities to request, or empty string if none remain
+ */
+ QString takeQueuedCaps();
+
+ /**
+ * Maximum length of a single 'CAP REQ' command.
+ *
+ * To be safe, 100 chars. Higher numbers should be possible; this is following the conservative
+ * minimum number of characters that IRC servers must return in CAP NAK replies. This also
+ * means CAP NAK replies will contain the full list of denied capabilities.
+ *
+ * See: http://ircv3.net/specs/core/capability-negotiation-3.1.html
+ */
+ const int maxCapRequestLength = 100;
QTimer _tokenBucketTimer;
- int _messageDelay; // token refill speed in ms
- int _burstSize; // size of the token bucket
- int _tokenBucket; // the virtual bucket that holds the tokens
- QList<QByteArray> _msgQueue;
+ // No need for int type as one cannot travel into the past (at least not yet, Doc)
+ quint32 _messageDelay; /// Token refill speed in ms
+ quint32 _burstSize; /// Size of the token bucket
+ quint32 _tokenBucket; /// The virtual bucket that holds the tokens
+ QList<QByteArray> _msgQueue; /// Queue of messages waiting to be sent
+ bool _skipMessageRates; /// If true, skip all message rate limits
QString _requestedUserModes; // 2 strings separated by a '-' character. first part are requested modes to add, the second to remove
projects / quassel.git / blobdiff