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     void disconnectFromIrc(bool requested = true, const QString &reason = QString(), bool withReconnect = false);
 160
 161     void userInput(BufferInfo bufferInfo, QString msg);
 162
 163     /**
 164      * Sends the raw (encoded) line, adding to the queue if needed, optionally with higher priority.
 165      *
 166      * @param[in] input   QByteArray of encoded characters
 167      * @param[in] prepend
 168      * @parmblock
 169      * If true, the line is prepended into the start of the queue, otherwise, it's appended to the
 170      * end.  This should be used sparingly, for if either the core or the IRC server cannot maintain
 171      * PING/PONG replies, the other side will close the connection.
 172      * @endparmblock
 173      */
 174     void putRawLine(const QByteArray input, const bool prepend = false);
 175
 176     /**
 177      * Sends the command with encoded parameters, with optional prefix or high priority.
 178      *
 179      * @param[in] cmd      Command to send, ignoring capitalization
 180      * @param[in] params   Parameters for the command, encoded within a QByteArray
 181      * @param[in] prefix   Optional command prefix
 182      * @param[in] prepend
 183      * @parmblock
 184      * If true, the command is prepended into the start of the queue, otherwise, it's appended to
 185      * the end.  This should be used sparingly, for if either the core or the IRC server cannot
 186      * maintain PING/PONG replies, the other side will close the connection.
 187      * @endparmblock
 188      */
 189     void putCmd(const QString &cmd, const QList<QByteArray> &params, const QByteArray &prefix = QByteArray(), const bool prepend = false);
 190
 191     /**
 192      * Sends the command for each set of encoded parameters, with optional prefix or high priority.
 193      *
 194      * @param[in] cmd         Command to send, ignoring capitalization
 195      * @param[in] params
 196      * @parmblock
 197      * List of parameter lists for the command, encoded within a QByteArray.  The command will be
 198      * sent multiple times, once for each set of params stored within the outer list.
 199      * @endparmblock
 200      * @param[in] prefix      Optional command prefix
 201      * @param[in] prependAll
 202      * @parmblock
 203      * If true, ALL of the commands are prepended into the start of the queue, otherwise, they're
 204      * appended to the end.  This should be used sparingly, for if either the core or the IRC server
 205      * cannot maintain PING/PONG replies, the other side will close the connection.
 206      * @endparmblock
 207      */
 208     void putCmd(const QString &cmd, const QList<QList<QByteArray>> &params, const QByteArray &prefix = QByteArray(), const bool prependAll = false);
 209
 210     void setChannelJoined(const QString &channel);
 211     void setChannelParted(const QString &channel);
 212     void addChannelKey(const QString &channel, const QString &key);
 213     void removeChannelKey(const QString &channel);
 214
 215     // Blowfish stuff
 216 #ifdef HAVE_QCA2
 217     Cipher *cipher(const QString &recipient);
 218     QByteArray cipherKey(const QString &recipient) const;
 219     void setCipherKey(const QString &recipient, const QByteArray &key);
 220     bool cipherUsesCBC(const QString &target);
 221 #endif
 222
 223     // IRCv3 capability negotiation (can be connected to signals)
 224
 225     /**
 226      * Indicates a capability is now available, with optional value in Network::capValue().
 227      *
 228      * @see Network::addCap()
 229      *
 230      * @param[in] capability Name of the capability
 231      */
 232     void serverCapAdded(const QString &capability);
 233
 234     /**
 235      * Indicates a capability was acknowledged (enabled by the IRC server).
 236      *
 237      * @see Network::acknowledgeCap()
 238      *
 239      * @param[in] capability Name of the capability
 240      */
 241     void serverCapAcknowledged(const QString &capability);
 242
 243     /**
 244      * Indicates a capability was removed from the list of available capabilities.
 245      *
 246      * @see Network::removeCap()
 247      *
 248      * @param[in] capability Name of the capability
 249      */
 250     void serverCapRemoved(const QString &capability);
 251
 252     /**
 253      * Sends the next capability from the queue.
 254      *
 255      * During nick registration if any capabilities remain queued, this will take the next and
 256      * request it.  When no capabilities remain, capability negotiation is ended.
 257      */
 258     void sendNextCap();
 259
 260     void setAutoWhoEnabled(bool enabled);
 261     void setAutoWhoInterval(int interval);
 262     void setAutoWhoDelay(int delay);
 263
 264     /**
 265      * Appends the given channel/nick to the front of the AutoWho queue.
 266      *
 267      * When 'away-notify' is enabled, this will trigger an immediate AutoWho since regular
 268      * who-cycles are disabled as per IRCv3 specifications.
 269      *
 270      * @param[in] channelOrNick Channel or nickname to WHO
 271      */
 272     void queueAutoWhoOneshot(const QString &channelOrNick);
 273
 274     bool setAutoWhoDone(const QString &channel);
 275
 276     void updateIssuedModes(const QString &requestedModes);
 277     void updatePersistentModes(QString addModes, QString removeModes);
 278     void resetPersistentModes();
 279
 280     Server usedServer() const;
 281
 282     inline void resetPingTimeout() { _pingCount = 0; }
 283
 284     inline void displayMsg(Message::Type msgType, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None)
 285     {
 286         emit displayMsg(networkId(), msgType, bufferType, target, text, sender, flags);
 287     }
 288
 289
 290 signals:
 291     void recvRawServerMsg(QString);
 292     void displayStatusMsg(QString);
 293     void displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
 294     void disconnected(NetworkId networkId);
 295     void connectionError(const QString &errorMsg);
 296
 297     void quitRequested(NetworkId networkId);
 298     void sslErrors(const QVariant &errorData);
 299
 300     void newEvent(Event *event);
 301     void socketInitialized(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
 302     void socketDisconnected(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
 303
 304 protected:
 305     inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new CoreIrcChannel(channelname, this); }
 306     inline virtual IrcUser *ircUserFactory(const QString &hostmask) { return new CoreIrcUser(hostmask, this); }
 307
 308 protected slots:
 309     // TODO: remove cached cipher keys, when appropriate
 310     //virtual void removeIrcUser(IrcUser *ircuser);
 311     //virtual void removeIrcChannel(IrcChannel *ircChannel);
 312     //virtual void removeChansAndUsers();
 313
 314 private slots:
 315     void socketHasData();
 316     void socketError(QAbstractSocket::SocketError);
 317     void socketInitialized();
 318     inline void socketCloseTimeout() { socket.abort(); }
 319     void socketDisconnected();
 320     void socketStateChanged(QAbstractSocket::SocketState);
 321     void networkInitialized();
 322
 323     void sendPerform();
 324     void restoreUserModes();
 325     void doAutoReconnect();
 326     void sendPing();
 327     void enablePingTimeout(bool enable = true);
 328     void disablePingTimeout();
 329     void sendAutoWho();
 330     void startAutoWhoCycle();
 331
 332 #ifdef HAVE_SSL
 333     void sslErrors(const QList<QSslError> &errors);
 334 #endif
 335
 336     void fillBucketAndProcessQueue();
 337
 338     void writeToSocket(const QByteArray &data);
 339
 340 private:
 341     CoreSession *_coreSession;
 342
 343 #ifdef HAVE_SSL
 344     QSslSocket socket;
 345 #else
 346     QTcpSocket socket;
 347 #endif
 348
 349     CoreUserInputHandler *_userInputHandler;
 350
 351     QHash<QString, QString> _channelKeys; // stores persistent channels and their passwords, if any
 352
 353     QTimer _autoReconnectTimer;
 354     int _autoReconnectCount;
 355
 356     QTimer _socketCloseTimer;
 357
 358     /* this flag triggers quitRequested() once the socket is closed
 359      * it is needed to determine whether or not the connection needs to be
 360      * in the automatic session restore. */
 361     bool _quitRequested;
 362     QString _quitReason;
 363
 364     bool _previousConnectionAttemptFailed;
 365     int _lastUsedServerIndex;
 366
 367     QTimer _pingTimer;
 368     uint _lastPingTime;
 369     uint _pingCount;
 370     bool _sendPings;
 371
 372     QStringList _autoWhoQueue;
 373     QHash<QString, int> _autoWhoPending;
 374     QTimer _autoWhoTimer, _autoWhoCycleTimer;
 375
 376     // Maintain a list of CAPs that are being checked; if empty, negotiation finished
 377     // See http://ircv3.net/specs/core/capability-negotiation-3.2.html
 378     QStringList _capsQueued;           /// Capabilities to be checked
 379     bool _capNegotiationActive;        /// Whether or not full capability negotiation was started
 380     // Avoid displaying repeat "negotiation finished" messages
 381     bool _capInitialNegotiationEnded;  /// Whether or not initial capability negotiation finished
 382     // Avoid sending repeat "CAP END" replies when registration is already ended
 383
 384     /**
 385      * Gets the next capability to request, removing it from the queue.
 386      *
 387      * @returns Name of capability to request
 388      */
 389     QString takeQueuedCap();
 390
 391     QTimer _tokenBucketTimer;
 392     int _messageDelay;      // token refill speed in ms
 393     int _burstSize;         // size of the token bucket
 394     int _tokenBucket;       // the virtual bucket that holds the tokens
 395     QList<QByteArray> _msgQueue;
 396
 397     QString _requestedUserModes; // 2 strings separated by a '-' character. first part are requested modes to add, the second to remove
 398
 399     // List of blowfish keys for channels
 400     QHash<QString, QByteArray> _cipherKeys;
 401 };
 402
 403
 404 #endif //CORENETWORK_H