1 /***************************************************************************
2 * Copyright (C) 2005-2019 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
25 #include "coreircchannel.h"
26 #include "coreircuser.h"
34 # include <QSslSocket>
37 # include <QTcpSocket>
44 #include "coresession.h"
49 class CoreUserInputHandler;
50 class CoreIgnoreListManager;
53 class CoreNetwork : public Network
59 CoreNetwork(const NetworkId &networkid, CoreSession *session);
60 virtual ~CoreNetwork();
62 inline virtual const QMetaObject *syncMetaObject() const { return &Network::staticMetaObject; }
64 inline CoreIdentity *identityPtr() const { return coreSession()->identity(identity()); }
65 inline CoreSession *coreSession() const { return _coreSession; }
66 inline CoreNetworkConfig *networkConfig() const { return coreSession()->networkConfig(); }
68 inline CoreUserInputHandler *userInputHandler() const { return _userInputHandler; }
69 inline CoreIgnoreListManager *ignoreListManager() { return coreSession()->ignoreListManager(); }
71 //! Decode a string using the server (network) decoding.
72 inline QString serverDecode(const QByteArray &string) const { return decodeServerString(string); }
74 //! Decode a string using a channel-specific encoding if one is set (and use the standard encoding else).
75 QString channelDecode(const QString &channelName, const QByteArray &string) const;
77 //! Decode a string using an IrcUser-specific encoding, if one exists (using the standaed encoding else).
78 QString userDecode(const QString &userNick, const QByteArray &string) const;
80 //! Encode a string using the server (network) encoding.
81 inline QByteArray serverEncode(const QString &string) const { return encodeServerString(string); }
83 //! Encode a string using the channel-specific encoding, if set, and use the standard encoding else.
84 QByteArray channelEncode(const QString &channelName, const QString &string) const;
86 //! Encode a string using the user-specific encoding, if set, and use the standard encoding else.
87 QByteArray userEncode(const QString &userNick, const QString &string) const;
89 inline QString channelKey(const QString &channel) const { return _channelKeys.value(channel.toLower(), QString()); }
91 inline QByteArray readChannelCipherKey(const QString &channel) const { return _cipherKeys.value(channel.toLower()); }
92 inline void storeChannelCipherKey(const QString &channel, const QByteArray &key) { _cipherKeys[channel.toLower()] = key; }
95 * Checks if the given target has an automatic WHO in progress
97 * @param name Channel or nickname
98 * @return True if an automatic WHO is in progress, otherwise false
100 inline bool isAutoWhoInProgress(const QString &name) const
102 return _autoWhoPending.value(name.toLower(), 0);
105 inline UserId userId() const { return _coreSession->user(); }
107 inline QAbstractSocket::SocketState socketState() const { return socket.state(); }
108 inline bool socketConnected() const { return socket.state() == QAbstractSocket::ConnectedState; }
109 inline QHostAddress localAddress() const { return socket.localAddress(); }
110 inline QHostAddress peerAddress() const { return socket.peerAddress(); }
111 inline quint16 localPort() const { return socket.localPort(); }
112 inline quint16 peerPort() const { return socket.peerPort(); }
115 * Gets whether or not a disconnect was expected.
117 * Distinguishes desired quits from unexpected disconnections such as socket errors or timeouts.
119 * @return True if disconnect was requested, otherwise false.
121 inline bool disconnectExpected() const { return _disconnectExpected; }
124 * Gets whether or not the server replies to automated PINGs with a valid timestamp
126 * Distinguishes between servers that reply by quoting the text sent, and those that respond
127 * with whatever they want.
129 * @return True if a valid timestamp has been received as a PONG, otherwise false.
131 inline bool isPongTimestampValid() const { return _pongTimestampValid; }
134 * Gets whether or not an automated PING has been sent without any PONG received
136 * Reset whenever any PONG is received, not just the automated one sent.
138 * @return True if a PING has been sent without a PONG received, otherwise false.
140 inline bool isPongReplyPending() const { return _pongReplyPending; }
142 QList<QList<QByteArray>> splitMessage(const QString &cmd, const QString &message, std::function<QList<QByteArray>(QString &)> cmdGenerator);
144 // IRCv3 capability negotiation
147 * Checks if capability negotiation is currently ongoing.
149 * @returns True if in progress, otherwise false
151 inline bool capNegotiationInProgress() const { return (!_capsQueuedIndividual.empty() ||
152 !_capsQueuedBundled.empty()); }
155 * Queues a capability to be requested.
157 * Adds to the list of capabilities being requested. If non-empty, CAP REQ messages are sent
158 * to the IRC server. This may happen at login or if capabilities are announced via CAP NEW.
160 * @param[in] capability Name of the capability
162 void queueCap(const QString &capability);
165 * Begins capability negotiation if capabilities are queued, otherwise returns.
167 * If any capabilities are queued, this will begin the cycle of taking each capability and
168 * requesting it. When no capabilities remain, capability negotiation is suitably ended.
170 void beginCapNegotiation();
173 * Ends capability negotiation.
175 * This won't have effect if other CAP commands are in the command queue before calling this
176 * command. It should only be called when capability negotiation is complete.
178 void endCapNegotiation();
181 * Queues the most recent capability set for retrying individually.
183 * Retries the most recent bundle of capabilities one at a time instead of as a group, working
184 * around the issue that IRC servers can deny a group of requested capabilities without
185 * indicating which capabilities failed.
187 * See: http://ircv3.net/specs/core/capability-negotiation-3.1.html
189 * This does NOT call CoreNetwork::sendNextCap(). Call that when ready afterwards. Does
190 * nothing if the last capability tried was individual instead of a set.
192 void retryCapsIndividually();
195 * List of capabilities requiring further core<->server messages to configure.
197 * For example, SASL requires the back-and-forth of AUTHENTICATE, so the next capability cannot
198 * be immediately sent.
200 * Any capabilities in this list must call CoreNetwork::sendNextCap() on their own and they will
201 * not be batched together with other capabilities.
203 * See: http://ircv3.net/specs/extensions/sasl-3.2.html
205 const QStringList capsRequiringConfiguration = QStringList {
210 virtual void setMyNick(const QString &mynick);
212 virtual void requestConnect() const;
213 virtual void requestDisconnect() const;
214 virtual void requestSetNetworkInfo(const NetworkInfo &info);
216 virtual void setUseAutoReconnect(bool);
217 virtual void setAutoReconnectInterval(quint32);
218 virtual void setAutoReconnectRetries(quint16);
220 void setPingInterval(int interval);
223 * Sets whether or not the IRC server has replied to PING with a valid timestamp
225 * This allows determining whether or not an IRC server responds to PING with a PONG that quotes
226 * what was sent, or if it does something else (and therefore PONGs should be more aggressively
229 * @param timestampValid If true, a valid timestamp has been received via PONG reply
231 void setPongTimestampValid(bool validTimestamp);
234 * Indicates that the CoreSession is shutting down.
236 * Disconnects the network if connected, and sets a flag that prevents reconnections.
240 void connectToIrc(bool reconnecting = false);
242 * Disconnect from the IRC server.
244 * Begin disconnecting from the IRC server, including optionally reconnecting.
246 * @param requested If true, user requested this disconnect; don't try to reconnect
247 * @param reason Reason for quitting, defaulting to the user-configured quit reason
248 * @param withReconnect Reconnect to the network after disconnecting (e.g. ping timeout)
250 void disconnectFromIrc(bool requested = true, const QString &reason = QString(), bool withReconnect = false);
253 * Forcibly close the IRC server socket, waiting for it to close.
255 * Call CoreNetwork::disconnectFromIrc() first, allow the event loop to run, then if you need to
256 * be sure the network's disconnected (e.g. clean-up), call this.
258 * @param msecs Maximum time to wait for socket to close, in milliseconds.
259 * @return True if socket closes successfully; false if error occurs or timeout reached
261 bool forceDisconnect(int msecs = 1000);
263 void userInput(BufferInfo bufferInfo, QString msg);
266 * Sends the raw (encoded) line, adding to the queue if needed, optionally with higher priority.
268 * @param[in] input QByteArray of encoded characters
271 * If true, the line is prepended into the start of the queue, otherwise, it's appended to the
272 * end. This should be used sparingly, for if either the core or the IRC server cannot maintain
273 * PING/PONG replies, the other side will close the connection.
276 void putRawLine(const QByteArray input, const bool prepend = false);
279 * Sends the command with encoded parameters, with optional prefix or high priority.
281 * @param[in] cmd Command to send, ignoring capitalization
282 * @param[in] params Parameters for the command, encoded within a QByteArray
283 * @param[in] prefix Optional command prefix
286 * If true, the command is prepended into the start of the queue, otherwise, it's appended to
287 * the end. This should be used sparingly, for if either the core or the IRC server cannot
288 * maintain PING/PONG replies, the other side will close the connection.
291 void putCmd(const QString &cmd, const QList<QByteArray> ¶ms, const QByteArray &prefix = QByteArray(), const bool prepend = false);
294 * Sends the command for each set of encoded parameters, with optional prefix or high priority.
296 * @param[in] cmd Command to send, ignoring capitalization
299 * List of parameter lists for the command, encoded within a QByteArray. The command will be
300 * sent multiple times, once for each set of params stored within the outer list.
302 * @param[in] prefix Optional command prefix
303 * @param[in] prependAll
305 * If true, ALL of the commands are prepended into the start of the queue, otherwise, they're
306 * appended to the end. This should be used sparingly, for if either the core or the IRC server
307 * cannot maintain PING/PONG replies, the other side will close the connection.
310 void putCmd(const QString &cmd, const QList<QList<QByteArray>> ¶ms, const QByteArray &prefix = QByteArray(), const bool prependAll = false);
312 void setChannelJoined(const QString &channel);
313 void setChannelParted(const QString &channel);
314 void addChannelKey(const QString &channel, const QString &key);
315 void removeChannelKey(const QString &channel);
319 Cipher *cipher(const QString &recipient);
320 QByteArray cipherKey(const QString &recipient) const;
321 void setCipherKey(const QString &recipient, const QByteArray &key);
322 bool cipherUsesCBC(const QString &target);
325 // Custom rate limiting (can be connected to signals)
328 * Update rate limiting according to Network configuration
330 * Updates the token bucket and message queue timer according to the network configuration, such
331 * as on first load, or after changing settings.
333 * Calling this will reset any ongoing queue delays. If messages exist in the queue when rate
334 * limiting is disabled, messages will be quickly sent (100 ms) with new messages queued to send
335 * until the queue is cleared.
337 * @see Network::useCustomMessageRate()
338 * @see Network::messageRateBurstSize()
339 * @see Network::messageRateDelay()
340 * @see Network::unlimitedMessageRate()
342 * @param[in] forceUnlimited
344 * If true, override user settings to disable message rate limiting, otherwise apply rate limits
345 * set by the user. Use with caution and remember to re-enable configured limits when done.
348 void updateRateLimiting(const bool forceUnlimited = false);
351 * Resets the token bucket up to the maximum
353 * Call this if the connection's been reset after calling updateRateLimiting() if needed.
355 * @see CoreNetwork::updateRateLimiting()
357 void resetTokenBucket();
359 // IRCv3 capability negotiation (can be connected to signals)
362 * Indicates a capability is now available, with optional value in Network::capValue().
364 * @see Network::addCap()
366 * @param[in] capability Name of the capability
368 void serverCapAdded(const QString &capability);
371 * Indicates a capability was acknowledged (enabled by the IRC server).
373 * @see Network::acknowledgeCap()
375 * @param[in] capability Name of the capability
377 void serverCapAcknowledged(const QString &capability);
380 * Indicates a capability was removed from the list of available capabilities.
382 * @see Network::removeCap()
384 * @param[in] capability Name of the capability
386 void serverCapRemoved(const QString &capability);
389 * Sends the next capability from the queue.
391 * During nick registration if any capabilities remain queued, this will take the next and
392 * request it. When no capabilities remain, capability negotiation is ended.
396 void setAutoWhoEnabled(bool enabled);
397 void setAutoWhoInterval(int interval);
398 void setAutoWhoDelay(int delay);
401 * Appends the given channel/nick to the front of the AutoWho queue.
403 * When 'away-notify' is enabled, this will trigger an immediate AutoWho since regular
404 * who-cycles are disabled as per IRCv3 specifications.
406 * @param[in] name Channel or nickname
408 void queueAutoWhoOneshot(const QString &name);
411 * Checks if the given target has an automatic WHO in progress, and sets it as done if so
413 * @param name Channel or nickname
414 * @return True if an automatic WHO is in progress (and should be silenced), otherwise false
416 bool setAutoWhoDone(const QString &name);
418 void updateIssuedModes(const QString &requestedModes);
419 void updatePersistentModes(QString addModes, QString removeModes);
420 void resetPersistentModes();
422 Server usedServer() const;
424 inline void resetPingTimeout() { _pingCount = 0; }
427 * Marks the network as no longer having a pending reply to an automated PING
429 inline void resetPongReplyPending() { _pongReplyPending = false; }
431 inline void displayMsg(Message::Type msgType, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None)
433 emit displayMsg(networkId(), msgType, bufferType, target, text, sender, flags);
438 void recvRawServerMsg(QString);
439 void displayStatusMsg(QString);
440 void displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
441 void disconnected(NetworkId networkId);
442 void connectionError(const QString &errorMsg);
444 void quitRequested(NetworkId networkId);
445 void sslErrors(const QVariant &errorData);
447 void newEvent(Event *event);
448 void socketInitialized(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort, qint64 socketId);
449 void socketDisconnected(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort, qint64 socketId);
452 inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new CoreIrcChannel(channelname, this); }
453 inline virtual IrcUser *ircUserFactory(const QString &hostmask) { return new CoreIrcUser(hostmask, this); }
456 // TODO: remove cached cipher keys, when appropriate
457 //virtual void removeIrcUser(IrcUser *ircuser);
458 //virtual void removeIrcChannel(IrcChannel *ircChannel);
459 //virtual void removeChansAndUsers();
462 void socketHasData();
463 void socketError(QAbstractSocket::SocketError);
464 void socketInitialized();
465 void socketCloseTimeout();
466 void socketDisconnected();
467 void socketStateChanged(QAbstractSocket::SocketState);
468 void networkInitialized();
471 void restoreUserModes();
472 void doAutoReconnect();
474 void enablePingTimeout(bool enable = true);
475 void disablePingTimeout();
477 void startAutoWhoCycle();
480 void sslErrors(const QList<QSslError> &errors);
484 * Check the message token bucket
486 * If rate limiting is disabled and the message queue is empty, this disables the token bucket
487 * timer. Otherwise, a queued message will be sent.
489 * @see CoreNetwork::fillBucketAndProcessQueue()
491 void checkTokenBucket();
494 * Top up token bucket and send as many queued messages as possible
496 * If there's any room for more tokens, add to the token bucket. Separately, if there's any
497 * messages to send, send until there's no more tokens or the queue is empty, whichever comes
500 void fillBucketAndProcessQueue();
502 void writeToSocket(const QByteArray &data);
505 CoreSession *_coreSession;
507 bool _debugLogRawIrc; ///< If true, include raw IRC socket messages in the debug log
508 qint32 _debugLogRawNetId; ///< Network ID for logging raw IRC socket messages, or -1 for all
517 CoreUserInputHandler *_userInputHandler;
519 QHash<QString, QString> _channelKeys; // stores persistent channels and their passwords, if any
521 QTimer _autoReconnectTimer;
522 int _autoReconnectCount;
524 QTimer _socketCloseTimer;
526 /* this flag triggers quitRequested() once the socket is closed
527 * it is needed to determine whether or not the connection needs to be
528 * in the automatic session restore. */
532 bool _disconnectExpected; /// If true, connection is quitting, expect a socket close
533 // This avoids logging a spurious RemoteHostClosedError whenever disconnect is called without
534 // specifying a permanent (saved to core session) disconnect.
536 bool _shuttingDown{false}; ///< If true, we're shutting down and ignore requests to (dis)connect networks
538 bool _previousConnectionAttemptFailed;
539 int _lastUsedServerIndex;
542 qint64 _lastPingTime = 0; ///< Unix time of most recently sent automatic ping
543 uint _pingCount = 0; ///< Unacknowledged automatic pings
544 bool _sendPings = false; ///< If true, pings should be periodically sent to server
545 bool _pongTimestampValid = false; ///< If true, IRC server responds to PING by quoting in PONG
546 // This tracks whether or not a server responds to PING with a PONG of what was sent, or if it
547 // does something else. If false, PING reply hiding should be more aggressive.
548 bool _pongReplyPending = false; ///< If true, at least one PING sent without a PONG reply
550 QStringList _autoWhoQueue;
551 QHash<QString, int> _autoWhoPending;
552 QTimer _autoWhoTimer, _autoWhoCycleTimer;
554 // Maintain a list of CAPs that are being checked; if empty, negotiation finished
555 // See http://ircv3.net/specs/core/capability-negotiation-3.2.html
556 QStringList _capsQueuedIndividual; /// Capabilities to check that require one at a time requests
557 QStringList _capsQueuedBundled; /// Capabilities to check that can be grouped together
558 QStringList _capsQueuedLastBundle; /// Most recent capability bundle requested (no individuals)
559 // Some capabilities, such as SASL, require follow-up messages to be fully enabled. These
560 // capabilities should not be grouped with others to avoid requesting new capabilities while the
561 // previous capability is still being set up.
562 // Additionally, IRC servers can choose to send a 'NAK' to any set of requested capabilities.
563 // If this happens, we need a way to retry each capability individually in order to avoid having
564 // one failing capability (e.g. SASL) block all other capabilities.
566 bool _capNegotiationActive; /// Whether or not full capability negotiation was started
567 // Avoid displaying repeat "negotiation finished" messages
568 bool _capInitialNegotiationEnded; /// Whether or not initial capability negotiation finished
569 // Avoid sending repeat "CAP END" replies when registration is already ended
572 * Gets the next set of capabilities to request, removing them from the queue.
574 * May return one or multiple space-separated capabilities, depending on queue.
576 * @returns Space-separated names of capabilities to request, or empty string if none remain
578 QString takeQueuedCaps();
581 * Maximum length of a single 'CAP REQ' command.
583 * To be safe, 100 chars. Higher numbers should be possible; this is following the conservative
584 * minimum number of characters that IRC servers must return in CAP NAK replies. This also
585 * means CAP NAK replies will contain the full list of denied capabilities.
587 * See: http://ircv3.net/specs/core/capability-negotiation-3.1.html
589 const int maxCapRequestLength = 100;
591 QTimer _tokenBucketTimer;
592 // No need for int type as one cannot travel into the past (at least not yet, Doc)
593 quint32 _messageDelay; /// Token refill speed in ms
594 quint32 _burstSize; /// Size of the token bucket
595 quint32 _tokenBucket; /// The virtual bucket that holds the tokens
596 QList<QByteArray> _msgQueue; /// Queue of messages waiting to be sent
597 bool _skipMessageRates; /// If true, skip all message rate limits
599 QString _requestedUserModes; // 2 strings separated by a '-' character. first part are requested modes to add, the second to remove
601 // List of blowfish keys for channels
602 QHash<QString, QByteArray> _cipherKeys;
606 #endif //CORENETWORK_H