src/core/corenetwork.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2016 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     QList<QList<QByteArray>> splitMessage(const QString &cmd, const QString &message, std::function<QList<QByteArray>(QString &)> cmdGenerator);
 105
 106     // IRCv3 capability negotiation
 107
 108     /**
 109      * Checks if capability negotiation is currently ongoing.
 110      *
 111      * @returns True if in progress, otherwise false
 112      */
 113     inline bool capNegotiationInProgress() const { return !_capsQueued.empty(); }
 114
 115     /**
 116      * Queues a capability to be requested.
 117      *
 118      * Adds to the list of capabilities being requested.  If non-empty, CAP REQ messages are sent
 119      * to the IRC server.  This may happen at login or if capabilities are announced via CAP NEW.
 120      *
 121      * @param[in] capability Name of the capability
 122      */
 123     void queueCap(const QString &capability);
 124
 125     /**
 126      * Begins capability negotiation if capabilities are queued, otherwise returns.
 127      *
 128      * If any capabilities are queued, this will begin the cycle of taking each capability and
 129      * requesting it.  When no capabilities remain, capability negotiation is suitably ended.
 130      */
 131     void beginCapNegotiation();
 132
 133     /**
 134      * List of capabilities requiring further core<->server messages to configure.
 135      *
 136      * For example, SASL requires the back-and-forth of AUTHENTICATE, so the next capability cannot
 137      * be immediately sent.
 138      *
 139      * See: http://ircv3.net/specs/extensions/sasl-3.2.html
 140      */
 141     const QStringList capsRequiringConfiguration = QStringList {
 142         IrcCap::SASL
 143     };
 144
 145 public slots:
 146     virtual void setMyNick(const QString &mynick);
 147
 148     virtual void requestConnect() const;
 149     virtual void requestDisconnect() const;
 150     virtual void requestSetNetworkInfo(const NetworkInfo &info);
 151
 152     virtual void setUseAutoReconnect(bool);
 153     virtual void setAutoReconnectInterval(quint32);
 154     virtual void setAutoReconnectRetries(quint16);
 155
 156     void setPingInterval(int interval);
 157
 158     void connectToIrc(bool reconnecting = false);
 159     /**
 160      * Disconnect from the IRC server.
 161      *
 162      * Begin disconnecting from the IRC server, including optionally reconnecting.
 163      *
 164      * @param requested       If true, user requested this disconnect; don't try to reconnect
 165      * @param reason          Reason for quitting, defaulting to the user-configured quit reason
 166      * @param withReconnect   Reconnect to the network after disconnecting (e.g. ping timeout)
 167      * @param forceImmediate  Immediately disconnect from network, skipping queue of other commands
 168      */
 169     void disconnectFromIrc(bool requested = true, const QString &reason = QString(),
 170                            bool withReconnect = false, bool forceImmediate = false);
 171
 172     void userInput(BufferInfo bufferInfo, QString msg);
 173
 174     /**
 175      * Sends the raw (encoded) line, adding to the queue if needed, optionally with higher priority.
 176      *
 177      * @param[in] input   QByteArray of encoded characters
 178      * @param[in] prepend
 179      * @parmblock
 180      * If true, the line is prepended into the start of the queue, otherwise, it's appended to the
 181      * end.  This should be used sparingly, for if either the core or the IRC server cannot maintain
 182      * PING/PONG replies, the other side will close the connection.
 183      * @endparmblock
 184      */
 185     void putRawLine(const QByteArray input, const bool prepend = false);
 186
 187     /**
 188      * Sends the command with encoded parameters, with optional prefix or high priority.
 189      *
 190      * @param[in] cmd      Command to send, ignoring capitalization
 191      * @param[in] params   Parameters for the command, encoded within a QByteArray
 192      * @param[in] prefix   Optional command prefix
 193      * @param[in] prepend
 194      * @parmblock
 195      * If true, the command is prepended into the start of the queue, otherwise, it's appended to
 196      * the end.  This should be used sparingly, for if either the core or the IRC server cannot
 197      * maintain PING/PONG replies, the other side will close the connection.
 198      * @endparmblock
 199      */
 200     void putCmd(const QString &cmd, const QList<QByteArray> &params, const QByteArray &prefix = QByteArray(), const bool prepend = false);
 201
 202     /**
 203      * Sends the command for each set of encoded parameters, with optional prefix or high priority.
 204      *
 205      * @param[in] cmd         Command to send, ignoring capitalization
 206      * @param[in] params
 207      * @parmblock
 208      * List of parameter lists for the command, encoded within a QByteArray.  The command will be
 209      * sent multiple times, once for each set of params stored within the outer list.
 210      * @endparmblock
 211      * @param[in] prefix      Optional command prefix
 212      * @param[in] prependAll
 213      * @parmblock
 214      * If true, ALL of the commands are prepended into the start of the queue, otherwise, they're
 215      * appended to the end.  This should be used sparingly, for if either the core or the IRC server
 216      * cannot maintain PING/PONG replies, the other side will close the connection.
 217      * @endparmblock
 218      */
 219     void putCmd(const QString &cmd, const QList<QList<QByteArray>> &params, const QByteArray &prefix = QByteArray(), const bool prependAll = false);
 220
 221     void setChannelJoined(const QString &channel);
 222     void setChannelParted(const QString &channel);
 223     void addChannelKey(const QString &channel, const QString &key);
 224     void removeChannelKey(const QString &channel);
 225
 226     // Blowfish stuff
 227 #ifdef HAVE_QCA2
 228     Cipher *cipher(const QString &recipient);
 229     QByteArray cipherKey(const QString &recipient) const;
 230     void setCipherKey(const QString &recipient, const QByteArray &key);
 231     bool cipherUsesCBC(const QString &target);
 232 #endif
 233
 234     // IRCv3 capability negotiation (can be connected to signals)
 235
 236     /**
 237      * Indicates a capability is now available, with optional value in Network::capValue().
 238      *
 239      * @see Network::addCap()
 240      *
 241      * @param[in] capability Name of the capability
 242      */
 243     void serverCapAdded(const QString &capability);
 244
 245     /**
 246      * Indicates a capability was acknowledged (enabled by the IRC server).
 247      *
 248      * @see Network::acknowledgeCap()
 249      *
 250      * @param[in] capability Name of the capability
 251      */
 252     void serverCapAcknowledged(const QString &capability);
 253
 254     /**
 255      * Indicates a capability was removed from the list of available capabilities.
 256      *
 257      * @see Network::removeCap()
 258      *
 259      * @param[in] capability Name of the capability
 260      */
 261     void serverCapRemoved(const QString &capability);
 262
 263     /**
 264      * Sends the next capability from the queue.
 265      *
 266      * During nick registration if any capabilities remain queued, this will take the next and
 267      * request it.  When no capabilities remain, capability negotiation is ended.
 268      */
 269     void sendNextCap();
 270
 271     void setAutoWhoEnabled(bool enabled);
 272     void setAutoWhoInterval(int interval);
 273     void setAutoWhoDelay(int delay);
 274
 275     /**
 276      * Appends the given channel/nick to the front of the AutoWho queue.
 277      *
 278      * When 'away-notify' is enabled, this will trigger an immediate AutoWho since regular
 279      * who-cycles are disabled as per IRCv3 specifications.
 280      *
 281      * @param[in] channelOrNick Channel or nickname to WHO
 282      */
 283     void queueAutoWhoOneshot(const QString &channelOrNick);
 284
 285     bool setAutoWhoDone(const QString &channel);
 286
 287     void updateIssuedModes(const QString &requestedModes);
 288     void updatePersistentModes(QString addModes, QString removeModes);
 289     void resetPersistentModes();
 290
 291     Server usedServer() const;
 292
 293     inline void resetPingTimeout() { _pingCount = 0; }
 294
 295     inline void displayMsg(Message::Type msgType, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None)
 296     {
 297         emit displayMsg(networkId(), msgType, bufferType, target, text, sender, flags);
 298     }
 299
 300
 301 signals:
 302     void recvRawServerMsg(QString);
 303     void displayStatusMsg(QString);
 304     void displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
 305     void disconnected(NetworkId networkId);
 306     void connectionError(const QString &errorMsg);
 307
 308     void quitRequested(NetworkId networkId);
 309     void sslErrors(const QVariant &errorData);
 310
 311     void newEvent(Event *event);
 312     void socketInitialized(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
 313     void socketDisconnected(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
 314
 315 protected:
 316     inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new CoreIrcChannel(channelname, this); }
 317     inline virtual IrcUser *ircUserFactory(const QString &hostmask) { return new CoreIrcUser(hostmask, this); }
 318
 319 protected slots:
 320     // TODO: remove cached cipher keys, when appropriate
 321     //virtual void removeIrcUser(IrcUser *ircuser);
 322     //virtual void removeIrcChannel(IrcChannel *ircChannel);
 323     //virtual void removeChansAndUsers();
 324
 325 private slots:
 326     void socketHasData();
 327     void socketError(QAbstractSocket::SocketError);
 328     void socketInitialized();
 329     inline void socketCloseTimeout() { socket.abort(); }
 330     void socketDisconnected();
 331     void socketStateChanged(QAbstractSocket::SocketState);
 332     void networkInitialized();
 333
 334     void sendPerform();
 335     void restoreUserModes();
 336     void doAutoReconnect();
 337     void sendPing();
 338     void enablePingTimeout(bool enable = true);
 339     void disablePingTimeout();
 340     void sendAutoWho();
 341     void startAutoWhoCycle();
 342
 343 #ifdef HAVE_SSL
 344     void sslErrors(const QList<QSslError> &errors);
 345 #endif
 346
 347     void fillBucketAndProcessQueue();
 348
 349     void writeToSocket(const QByteArray &data);
 350
 351 private:
 352     CoreSession *_coreSession;
 353
 354 #ifdef HAVE_SSL
 355     QSslSocket socket;
 356 #else
 357     QTcpSocket socket;
 358 #endif
 359
 360     CoreUserInputHandler *_userInputHandler;
 361
 362     QHash<QString, QString> _channelKeys; // stores persistent channels and their passwords, if any
 363
 364     QTimer _autoReconnectTimer;
 365     int _autoReconnectCount;
 366
 367     QTimer _socketCloseTimer;
 368
 369     /* this flag triggers quitRequested() once the socket is closed
 370      * it is needed to determine whether or not the connection needs to be
 371      * in the automatic session restore. */
 372     bool _quitRequested;
 373     QString _quitReason;
 374
 375     bool _disconnectExpected;  /// If true, connection is quitting, expect a socket close
 376     // This avoids logging a spurious RemoteHostClosedError whenever disconnect is called without
 377     // specifying a permanent (saved to core session) disconnect.
 378
 379     bool _previousConnectionAttemptFailed;
 380     int _lastUsedServerIndex;
 381
 382     QTimer _pingTimer;
 383     uint _lastPingTime;
 384     uint _pingCount;
 385     bool _sendPings;
 386
 387     QStringList _autoWhoQueue;
 388     QHash<QString, int> _autoWhoPending;
 389     QTimer _autoWhoTimer, _autoWhoCycleTimer;
 390
 391     // Maintain a list of CAPs that are being checked; if empty, negotiation finished
 392     // See http://ircv3.net/specs/core/capability-negotiation-3.2.html
 393     QStringList _capsQueued;           /// Capabilities to be checked
 394     bool _capNegotiationActive;        /// Whether or not full capability negotiation was started
 395     // Avoid displaying repeat "negotiation finished" messages
 396     bool _capInitialNegotiationEnded;  /// Whether or not initial capability negotiation finished
 397     // Avoid sending repeat "CAP END" replies when registration is already ended
 398
 399     /**
 400      * Gets the next capability to request, removing it from the queue.
 401      *
 402      * @returns Name of capability to request
 403      */
 404     QString takeQueuedCap();
 405
 406     QTimer _tokenBucketTimer;
 407     int _messageDelay;      // token refill speed in ms
 408     int _burstSize;         // size of the token bucket
 409     int _tokenBucket;       // the virtual bucket that holds the tokens
 410     QList<QByteArray> _msgQueue;
 411
 412     QString _requestedUserModes; // 2 strings separated by a '-' character. first part are requested modes to add, the second to remove
 413
 414     // List of blowfish keys for channels
 415     QHash<QString, QByteArray> _cipherKeys;
 416 };
 417
 418
 419 #endif //CORENETWORK_H