X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fcorenetwork.h;h=01d71edc8e8857e6501dcbba80c1bb31d4088454;hp=509df19d77671c5b1d45620afcc126122dd7cfe6;hb=8f92b3f08df9f4eb8fd243ccec6aa9d4b563ec23;hpb=7d30b18136eecbdf2089e5d5877c7e41c6f4bcb6 diff --git a/src/core/corenetwork.h b/src/core/corenetwork.h index 509df19d..01d71edc 100644 --- a/src/core/corenetwork.h +++ b/src/core/corenetwork.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2016 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 * @@ -18,32 +18,29 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#ifndef CORENETWORK_H -#define CORENETWORK_H +#pragma once -#include "network.h" -#include "coreircchannel.h" -#include "coreircuser.h" - -// IRCv3 capabilities -#include "irccap.h" +#include #include #ifdef HAVE_SSL -# include -# include +# include +# include #else -# include +# include #endif #ifdef HAVE_QCA2 -# include "cipher.h" +# include "cipher.h" #endif +#include "coreircchannel.h" +#include "coreircuser.h" #include "coresession.h" - -#include +#include "irccap.h" +#include "irctag.h" +#include "network.h" class CoreIdentity; class CoreUserInputHandler; @@ -52,45 +49,49 @@ class Event; class CoreNetwork : public Network { - SYNCABLE_OBJECT - Q_OBJECT + Q_OBJECT public: - CoreNetwork(const NetworkId &networkid, CoreSession *session); - ~CoreNetwork(); - inline virtual const QMetaObject *syncMetaObject() const { return &Network::staticMetaObject; } + CoreNetwork(const NetworkId& networkid, CoreSession* session); + ~CoreNetwork() override; - inline CoreIdentity *identityPtr() const { return coreSession()->identity(identity()); } - inline CoreSession *coreSession() const { return _coreSession; } - inline CoreNetworkConfig *networkConfig() const { return coreSession()->networkConfig(); } + inline CoreIdentity* identityPtr() const { return coreSession()->identity(identity()); } + inline CoreSession* coreSession() const { return _coreSession; } + inline CoreNetworkConfig* networkConfig() const { return coreSession()->networkConfig(); } - inline CoreUserInputHandler *userInputHandler() const { return _userInputHandler; } - inline CoreIgnoreListManager *ignoreListManager() { return coreSession()->ignoreListManager(); } + inline CoreUserInputHandler* userInputHandler() const { return _userInputHandler; } + inline CoreIgnoreListManager* ignoreListManager() { return coreSession()->ignoreListManager(); } //! Decode a string using the server (network) decoding. - inline QString serverDecode(const QByteArray &string) const { return decodeServerString(string); } + inline QString serverDecode(const QByteArray& string) const { return decodeServerString(string); } //! Decode a string using a channel-specific encoding if one is set (and use the standard encoding else). - QString channelDecode(const QString &channelName, const QByteArray &string) const; + QString channelDecode(const QString& channelName, const QByteArray& string) const; //! Decode a string using an IrcUser-specific encoding, if one exists (using the standaed encoding else). - QString userDecode(const QString &userNick, const QByteArray &string) const; + QString userDecode(const QString& userNick, const QByteArray& string) const; //! Encode a string using the server (network) encoding. - inline QByteArray serverEncode(const QString &string) const { return encodeServerString(string); } + inline QByteArray serverEncode(const QString& string) const { return encodeServerString(string); } //! Encode a string using the channel-specific encoding, if set, and use the standard encoding else. - QByteArray channelEncode(const QString &channelName, const QString &string) const; + QByteArray channelEncode(const QString& channelName, const QString& string) const; //! Encode a string using the user-specific encoding, if set, and use the standard encoding else. - QByteArray userEncode(const QString &userNick, const QString &string) const; + QByteArray userEncode(const QString& userNick, const QString& string) const; - inline QString channelKey(const QString &channel) const { return _channelKeys.value(channel.toLower(), QString()); } + inline QString channelKey(const QString& channel) const { return _channelKeys.value(channel.toLower(), QString()); } - inline QByteArray readChannelCipherKey(const QString &channel) const { return _cipherKeys.value(channel.toLower()); } - inline void storeChannelCipherKey(const QString &channel, const QByteArray &key) { _cipherKeys[channel.toLower()] = key; } + inline QByteArray readChannelCipherKey(const QString& channel) const { return _cipherKeys.value(channel.toLower()); } + inline void storeChannelCipherKey(const QString& channel, const QByteArray& key) { _cipherKeys[channel.toLower()] = key; } - inline bool isAutoWhoInProgress(const QString &channel) const { return _autoWhoPending.value(channel.toLower(), 0); } + /** + * Checks if the given target has an automatic WHO in progress + * + * @param name Channel or nickname + * @return True if an automatic WHO is in progress, otherwise false + */ + inline bool isAutoWhoInProgress(const QString& name) const { return _autoWhoPending.value(name.toLower(), 0); } inline UserId userId() const { return _coreSession->user(); } @@ -101,7 +102,37 @@ public: inline quint16 localPort() const { return socket.localPort(); } inline quint16 peerPort() const { return socket.peerPort(); } - QList> splitMessage(const QString &cmd, const QString &message, std::function(QString &)> cmdGenerator); + /** + * Gets whether or not a disconnect was expected. + * + * Distinguishes desired quits from unexpected disconnections such as socket errors or timeouts. + * + * @return True if disconnect was requested, otherwise false. + */ + inline bool disconnectExpected() const { return _disconnectExpected; } + + /** + * Gets whether or not the server replies to automated PINGs with a valid timestamp + * + * Distinguishes between servers that reply by quoting the text sent, and those that respond + * with whatever they want. + * + * @return True if a valid timestamp has been received as a PONG, otherwise false. + */ + inline bool isPongTimestampValid() const { return _pongTimestampValid; } + + /** + * Gets whether or not an automated PING has been sent without any PONG received + * + * Reset whenever any PONG is received, not just the automated one sent. + * + * @return True if a PING has been sent without a PONG received, otherwise false. + */ + inline bool isPongReplyPending() const { return _pongReplyPending; } + + QList> splitMessage(const QString& cmd, + const QString& message, + const std::function(QString&)>& cmdGenerator); // IRCv3 capability negotiation @@ -110,8 +141,7 @@ public: * * @returns True if in progress, otherwise false */ - inline bool capNegotiationInProgress() const { return (!_capsQueuedIndividual.empty() || - !_capsQueuedBundled.empty()); } + inline bool capNegotiationInProgress() const { return (!_capsQueuedIndividual.empty() || !_capsQueuedBundled.empty()); } /** * Queues a capability to be requested. @@ -121,7 +151,7 @@ public: * * @param[in] capability Name of the capability */ - void queueCap(const QString &capability); + void queueCap(const QString& capability); /** * Begins capability negotiation if capabilities are queued, otherwise returns. @@ -164,23 +194,39 @@ public: * * See: http://ircv3.net/specs/extensions/sasl-3.2.html */ - const QStringList capsRequiringConfiguration = QStringList { - IrcCap::SASL - }; + const QStringList capsRequiringConfiguration = QStringList{IrcCap::SASL}; public slots: - virtual void setMyNick(const QString &mynick); + void setMyNick(const QString& mynick) override; - virtual void requestConnect() const; - virtual void requestDisconnect() const; - virtual void requestSetNetworkInfo(const NetworkInfo &info); + void requestConnect() const override; + void requestDisconnect() const override; + void requestSetNetworkInfo(const NetworkInfo& info) override; - virtual void setUseAutoReconnect(bool); - virtual void setAutoReconnectInterval(quint32); - virtual void setAutoReconnectRetries(quint16); + void setUseAutoReconnect(bool) override; + void setAutoReconnectInterval(quint32) override; + void setAutoReconnectRetries(quint16) override; void setPingInterval(int interval); + /** + * Sets whether or not the IRC server has replied to PING with a valid timestamp + * + * This allows determining whether or not an IRC server responds to PING with a PONG that quotes + * what was sent, or if it does something else (and therefore PONGs should be more aggressively + * hidden). + * + * @param timestampValid If true, a valid timestamp has been received via PONG reply + */ + void setPongTimestampValid(bool validTimestamp); + + /** + * Indicates that the CoreSession is shutting down. + * + * Disconnects the network if connected, and sets a flag that prevents reconnections. + */ + void shutdown(); + void connectToIrc(bool reconnecting = false); /** * Disconnect from the IRC server. @@ -190,23 +236,21 @@ public slots: * @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); + void disconnectFromIrc(bool requested = true, const QString& reason = QString(), bool withReconnect = 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. + * be sure the network's disconnected (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 userInput(const BufferInfo& bufferInfo, QString msg); /** * Sends the raw (encoded) line, adding to the queue if needed, optionally with higher priority. @@ -219,7 +263,7 @@ public slots: * PING/PONG replies, the other side will close the connection. * @endparmblock */ - void putRawLine(const QByteArray input, const bool prepend = false); + void putRawLine(const QByteArray& input, bool prepend = false); /** * Sends the command with encoded parameters, with optional prefix or high priority. @@ -234,7 +278,7 @@ public slots: * maintain PING/PONG replies, the other side will close the connection. * @endparmblock */ - void putCmd(const QString &cmd, const QList ¶ms, const QByteArray &prefix = QByteArray(), const bool prepend = false); + void putCmd(const QString& cmd, const QList& params, const QByteArray& prefix = {}, const QHash &tags = {}, bool prepend = false); /** * Sends the command for each set of encoded parameters, with optional prefix or high priority. @@ -253,19 +297,19 @@ public slots: * cannot maintain PING/PONG replies, the other side will close the connection. * @endparmblock */ - void putCmd(const QString &cmd, const QList> ¶ms, const QByteArray &prefix = QByteArray(), const bool prependAll = false); + void putCmd(const QString& cmd, const QList>& params, const QByteArray& prefix = {}, const QHash &tags = {}, bool prependAll = false); - void setChannelJoined(const QString &channel); - void setChannelParted(const QString &channel); - void addChannelKey(const QString &channel, const QString &key); - void removeChannelKey(const QString &channel); + void setChannelJoined(const QString& channel); + void setChannelParted(const QString& channel); + void addChannelKey(const QString& channel, const QString& key); + void removeChannelKey(const QString& channel); // Blowfish stuff #ifdef HAVE_QCA2 - Cipher *cipher(const QString &recipient); - QByteArray cipherKey(const QString &recipient) const; - void setCipherKey(const QString &recipient, const QByteArray &key); - bool cipherUsesCBC(const QString &target); + Cipher* cipher(const QString& recipient); + QByteArray cipherKey(const QString& recipient) const; + void setCipherKey(const QString& recipient, const QByteArray& key); + bool cipherUsesCBC(const QString& target); #endif // Custom rate limiting (can be connected to signals) @@ -284,8 +328,14 @@ public slots: * @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(); + void updateRateLimiting(bool forceUnlimited = false); /** * Resets the token bucket up to the maximum @@ -305,7 +355,7 @@ public slots: * * @param[in] capability Name of the capability */ - void serverCapAdded(const QString &capability); + void serverCapAdded(const QString& capability); /** * Indicates a capability was acknowledged (enabled by the IRC server). @@ -314,7 +364,7 @@ public slots: * * @param[in] capability Name of the capability */ - void serverCapAcknowledged(const QString &capability); + void serverCapAcknowledged(const QString& capability); /** * Indicates a capability was removed from the list of available capabilities. @@ -323,7 +373,7 @@ public slots: * * @param[in] capability Name of the capability */ - void serverCapRemoved(const QString &capability); + void serverCapRemoved(const QString& capability); /** * Sends the next capability from the queue. @@ -343,13 +393,19 @@ public slots: * When 'away-notify' is enabled, this will trigger an immediate AutoWho since regular * who-cycles are disabled as per IRCv3 specifications. * - * @param[in] channelOrNick Channel or nickname to WHO + * @param[in] name Channel or nickname */ - void queueAutoWhoOneshot(const QString &channelOrNick); + void queueAutoWhoOneshot(const QString& name); - bool setAutoWhoDone(const QString &channel); + /** + * Checks if the given target has an automatic WHO in progress, and sets it as done if so + * + * @param name Channel or nickname + * @return True if an automatic WHO is in progress (and should be silenced), otherwise false + */ + bool setAutoWhoDone(const QString& name); - void updateIssuedModes(const QString &requestedModes); + void updateIssuedModes(const QString& requestedModes); void updatePersistentModes(QString addModes, QString removeModes); void resetPersistentModes(); @@ -357,43 +413,58 @@ public slots: inline void resetPingTimeout() { _pingCount = 0; } - inline void displayMsg(Message::Type msgType, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None) + /** + * Marks the network as no longer having a pending reply to an automated PING + */ + inline void resetPongReplyPending() { _pongReplyPending = false; } + + void onDisplayMsg(const NetworkInternalMessage& msg) { - emit displayMsg(networkId(), msgType, bufferType, target, text, sender, flags); + emit displayMsg(RawMessage(networkId(), msg)); } - signals: - void recvRawServerMsg(QString); - void displayStatusMsg(QString); - void displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None); + void recvRawServerMsg(const QString&); + void displayStatusMsg(const QString&); + void displayMsg(const RawMessage& msg); void disconnected(NetworkId networkId); - void connectionError(const QString &errorMsg); + void connectionError(const QString& errorMsg); void quitRequested(NetworkId networkId); - void sslErrors(const QVariant &errorData); - - void newEvent(Event *event); - void socketInitialized(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort); - void socketDisconnected(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort); + void sslErrors(const QVariant& errorData); + + void newEvent(Event* event); + void socketInitialized(const CoreIdentity* identity, + const QHostAddress& localAddress, + quint16 localPort, + const QHostAddress& peerAddress, + quint16 peerPort, + qint64 socketId); + void socketDisconnected(const CoreIdentity* identity, + const QHostAddress& localAddress, + quint16 localPort, + const QHostAddress& peerAddress, + quint16 peerPort, + qint64 socketId); protected: - inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new CoreIrcChannel(channelname, this); } - inline virtual IrcUser *ircUserFactory(const QString &hostmask) { return new CoreIrcUser(hostmask, this); } + inline IrcChannel* ircChannelFactory(const QString& channelname) override { return new CoreIrcChannel(channelname, this); } + inline IrcUser* ircUserFactory(const QString& hostmask) override { return new CoreIrcUser(hostmask, this); } protected slots: // TODO: remove cached cipher keys, when appropriate - //virtual void removeIrcUser(IrcUser *ircuser); - //virtual void removeIrcChannel(IrcChannel *ircChannel); - //virtual void removeChansAndUsers(); + // virtual void removeIrcUser(IrcUser *ircuser); + // virtual void removeIrcChannel(IrcChannel *ircChannel); + // virtual void removeChansAndUsers(); private slots: - void socketHasData(); - void socketError(QAbstractSocket::SocketError); - void socketInitialized(); - inline void socketCloseTimeout() { socket.abort(); } - void socketDisconnected(); - void socketStateChanged(QAbstractSocket::SocketState); + void onSocketHasData(); + void onSocketError(QAbstractSocket::SocketError); + void onSocketInitialized(); + void onSocketCloseTimeout(); + void onSocketDisconnected(); + void onSocketStateChanged(QAbstractSocket::SocketState); + void networkInitialized(); void sendPerform(); @@ -406,7 +477,7 @@ private slots: void startAutoWhoCycle(); #ifdef HAVE_SSL - void sslErrors(const QList &errors); + void onSslErrors(const QList& errors); #endif /** @@ -428,20 +499,31 @@ private slots: */ void fillBucketAndProcessQueue(); - void writeToSocket(const QByteArray &data); + void writeToSocket(const QByteArray& data); + +private: + void showMessage(const NetworkInternalMessage& msg) + { + emit displayMsg(RawMessage(networkId(), msg)); + } private: - CoreSession *_coreSession; + CoreSession* _coreSession; + + bool _debugLogRawIrc; ///< If true, include raw IRC socket messages in the debug log + qint32 _debugLogRawNetId; ///< Network ID for logging raw IRC socket messages, or -1 for all #ifdef HAVE_SSL QSslSocket socket; #else QTcpSocket socket; #endif + qint64 _socketId{0}; - CoreUserInputHandler *_userInputHandler; + CoreUserInputHandler* _userInputHandler; + MetricsServer* _metricsServer; - QHash _channelKeys; // stores persistent channels and their passwords, if any + QHash _channelKeys; // stores persistent channels and their passwords, if any QTimer _autoReconnectTimer; int _autoReconnectCount; @@ -458,13 +540,19 @@ private: // This avoids logging a spurious RemoteHostClosedError whenever disconnect is called without // specifying a permanent (saved to core session) disconnect. + bool _shuttingDown{false}; ///< If true, we're shutting down and ignore requests to (dis)connect networks + bool _previousConnectionAttemptFailed; int _lastUsedServerIndex; QTimer _pingTimer; - uint _lastPingTime; - uint _pingCount; - bool _sendPings; + qint64 _lastPingTime = 0; ///< Unix time of most recently sent automatic ping + uint _pingCount = 0; ///< Unacknowledged automatic pings + bool _sendPings = false; ///< If true, pings should be periodically sent to server + bool _pongTimestampValid = false; ///< If true, IRC server responds to PING by quoting in PONG + // This tracks whether or not a server responds to PING with a PONG of what was sent, or if it + // does something else. If false, PING reply hiding should be more aggressive. + bool _pongReplyPending = false; ///< If true, at least one PING sent without a PONG reply QStringList _autoWhoQueue; QHash _autoWhoPending; @@ -482,9 +570,9 @@ private: // 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 + 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 + bool _capInitialNegotiationEnded; /// Whether or not initial capability negotiation finished // Avoid sending repeat "CAP END" replies when registration is already ended /** @@ -509,17 +597,14 @@ private: QTimer _tokenBucketTimer; // 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 _msgQueue; /// Queue of messages waiting to be sent - bool _skipMessageRates; /// If true, skip all message rate limits + quint32 _messageDelay; /// Token refill speed in ms + quint32 _burstSize; /// Size of the token bucket + quint32 _tokenBucket; /// The virtual bucket that holds the tokens + QList _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 + QString _requestedUserModes; // 2 strings separated by a '-' character. first part are requested modes to add, the second to remove // List of blowfish keys for channels QHash _cipherKeys; }; - - -#endif //CORENETWORK_H