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