src/core/corenetwork.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2015 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 #include <QTimer>
  29
  30 #ifdef HAVE_SSL
  31 # include <QSslSocket>
  32 # include <QSslError>
  33 #else
  34 # include <QTcpSocket>
  35 #endif
  36
  37 #ifdef HAVE_QCA2
  38 #  include "cipher.h"
  39 #endif
  40
  41 #include "coresession.h"
  42
  43 #include <functional>
  44
  45 class CoreIdentity;
  46 class CoreUserInputHandler;
  47 class CoreIgnoreListManager;
  48 class Event;
  49
  50 class CoreNetwork : public Network
  51 {
  52     SYNCABLE_OBJECT
  53         Q_OBJECT
  54
  55 public:
  56     CoreNetwork(const NetworkId &networkid, CoreSession *session);
  57     ~CoreNetwork();
  58     inline virtual const QMetaObject *syncMetaObject() const { return &Network::staticMetaObject; }
  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     inline bool isAutoWhoInProgress(const QString &channel) const { return _autoWhoPending.value(channel.toLower(), 0); }
  91
  92     inline UserId userId() const { return _coreSession->user(); }
  93
  94     inline QAbstractSocket::SocketState socketState() const { return socket.state(); }
  95     inline bool socketConnected() const { return socket.state() == QAbstractSocket::ConnectedState; }
  96     inline QHostAddress localAddress() const { return socket.localAddress(); }
  97     inline QHostAddress peerAddress() const { return socket.peerAddress(); }
  98     inline quint16 localPort() const { return socket.localPort(); }
  99     inline quint16 peerPort() const { return socket.peerPort(); }
 100
 101     QList<QList<QByteArray>> splitMessage(const QString &cmd, const QString &message, std::function<QList<QByteArray>(QString &)> cmdGenerator);
 102
 103 public slots:
 104     virtual void setMyNick(const QString &mynick);
 105
 106     virtual void requestConnect() const;
 107     virtual void requestDisconnect() const;
 108     virtual void requestSetNetworkInfo(const NetworkInfo &info);
 109
 110     virtual void setUseAutoReconnect(bool);
 111     virtual void setAutoReconnectInterval(quint32);
 112     virtual void setAutoReconnectRetries(quint16);
 113
 114     void setPingInterval(int interval);
 115
 116     void connectToIrc(bool reconnecting = false);
 117     /**
 118      * Disconnect from the IRC server.
 119      *
 120      * Begin disconnecting from the IRC server, including optionally reconnecting.
 121      *
 122      * @param requested       If true, user requested this disconnect; don't try to reconnect
 123      * @param reason          Reason for quitting, defaulting to the user-configured quit reason
 124      * @param withReconnect   Reconnect to the network after disconnecting (e.g. ping timeout)
 125      * @param forceImmediate  Immediately disconnect from network, skipping queue of other commands
 126      */
 127     void disconnectFromIrc(bool requested = true, const QString &reason = QString(),
 128                            bool withReconnect = false, bool forceImmediate = false);
 129
 130     /**
 131      * Forcibly close the IRC server socket, waiting for it to close.
 132      *
 133      * Call CoreNetwork::disconnectFromIrc() first, allow the event loop to run, then if you need to
 134      * be sure the network's disconencted (e.g. clean-up), call this.
 135      *
 136      * @param msecs  Maximum time to wait for socket to close, in milliseconds.
 137      * @return True if socket closes successfully; false if error occurs or timeout reached
 138      */
 139     bool forceDisconnect(int msecs = 1000);
 140
 141     void userInput(BufferInfo bufferInfo, QString msg);
 142
 143     /**
 144      * Sends the raw (encoded) line, adding to the queue if needed, optionally with higher priority.
 145      *
 146      * @param[in] input   QByteArray of encoded characters
 147      * @param[in] prepend
 148      * @parmblock
 149      * If true, the line is prepended into the start of the queue, otherwise, it's appended to the
 150      * end.  This should be used sparingly, for if either the core or the IRC server cannot maintain
 151      * PING/PONG replies, the other side will close the connection.
 152      * @endparmblock
 153      */
 154     void putRawLine(const QByteArray input, const bool prepend = false);
 155
 156     /**
 157      * Sends the command with encoded parameters, with optional prefix or high priority.
 158      *
 159      * @param[in] cmd      Command to send, ignoring capitalization
 160      * @param[in] params   Parameters for the command, encoded within a QByteArray
 161      * @param[in] prefix   Optional command prefix
 162      * @param[in] prepend
 163      * @parmblock
 164      * If true, the command is prepended into the start of the queue, otherwise, it's appended to
 165      * the end.  This should be used sparingly, for if either the core or the IRC server cannot
 166      * maintain PING/PONG replies, the other side will close the connection.
 167      * @endparmblock
 168      */
 169     void putCmd(const QString &cmd, const QList<QByteArray> &params, const QByteArray &prefix = QByteArray(), const bool prepend = false);
 170
 171     /**
 172      * Sends the command for each set of encoded parameters, with optional prefix or high priority.
 173      *
 174      * @param[in] cmd         Command to send, ignoring capitalization
 175      * @param[in] params
 176      * @parmblock
 177      * List of parameter lists for the command, encoded within a QByteArray.  The command will be
 178      * sent multiple times, once for each set of params stored within the outer list.
 179      * @endparmblock
 180      * @param[in] prefix      Optional command prefix
 181      * @param[in] prependAll
 182      * @parmblock
 183      * If true, ALL of the commands are prepended into the start of the queue, otherwise, they're
 184      * appended to the end.  This should be used sparingly, for if either the core or the IRC server
 185      * cannot maintain PING/PONG replies, the other side will close the connection.
 186      * @endparmblock
 187      */
 188     void putCmd(const QString &cmd, const QList<QList<QByteArray>> &params, const QByteArray &prefix = QByteArray(), const bool prependAll = false);
 189
 190     void setChannelJoined(const QString &channel);
 191     void setChannelParted(const QString &channel);
 192     void addChannelKey(const QString &channel, const QString &key);
 193     void removeChannelKey(const QString &channel);
 194
 195     // Blowfish stuff
 196 #ifdef HAVE_QCA2
 197     Cipher *cipher(const QString &recipient);
 198     QByteArray cipherKey(const QString &recipient) const;
 199     void setCipherKey(const QString &recipient, const QByteArray &key);
 200     bool cipherUsesCBC(const QString &target);
 201 #endif
 202
 203     void setAutoWhoEnabled(bool enabled);
 204     void setAutoWhoInterval(int interval);
 205     void setAutoWhoDelay(int delay);
 206
 207     bool setAutoWhoDone(const QString &channel);
 208
 209     void updateIssuedModes(const QString &requestedModes);
 210     void updatePersistentModes(QString addModes, QString removeModes);
 211     void resetPersistentModes();
 212
 213     Server usedServer() const;
 214
 215     inline void resetPingTimeout() { _pingCount = 0; }
 216
 217     inline void displayMsg(Message::Type msgType, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None)
 218     {
 219         emit displayMsg(networkId(), msgType, bufferType, target, text, sender, flags);
 220     }
 221
 222
 223 signals:
 224     void recvRawServerMsg(QString);
 225     void displayStatusMsg(QString);
 226     void displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
 227     void disconnected(NetworkId networkId);
 228     void connectionError(const QString &errorMsg);
 229
 230     void quitRequested(NetworkId networkId);
 231     void sslErrors(const QVariant &errorData);
 232
 233     void newEvent(Event *event);
 234     void socketInitialized(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
 235     void socketDisconnected(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
 236
 237 protected:
 238     inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new CoreIrcChannel(channelname, this); }
 239     inline virtual IrcUser *ircUserFactory(const QString &hostmask) { return new CoreIrcUser(hostmask, this); }
 240
 241 protected slots:
 242     // TODO: remove cached cipher keys, when appropriate
 243     //virtual void removeIrcUser(IrcUser *ircuser);
 244     //virtual void removeIrcChannel(IrcChannel *ircChannel);
 245     //virtual void removeChansAndUsers();
 246
 247 private slots:
 248     void socketHasData();
 249     void socketError(QAbstractSocket::SocketError);
 250     void socketInitialized();
 251     inline void socketCloseTimeout() { socket.abort(); }
 252     void socketDisconnected();
 253     void socketStateChanged(QAbstractSocket::SocketState);
 254     void networkInitialized();
 255
 256     void sendPerform();
 257     void restoreUserModes();
 258     void doAutoReconnect();
 259     void sendPing();
 260     void enablePingTimeout(bool enable = true);
 261     void disablePingTimeout();
 262     void sendAutoWho();
 263     void startAutoWhoCycle();
 264
 265 #ifdef HAVE_SSL
 266     void sslErrors(const QList<QSslError> &errors);
 267 #endif
 268
 269     void fillBucketAndProcessQueue();
 270
 271     void writeToSocket(const QByteArray &data);
 272
 273 private:
 274     CoreSession *_coreSession;
 275
 276 #ifdef HAVE_SSL
 277     QSslSocket socket;
 278 #else
 279     QTcpSocket socket;
 280 #endif
 281
 282     CoreUserInputHandler *_userInputHandler;
 283
 284     QHash<QString, QString> _channelKeys; // stores persistent channels and their passwords, if any
 285
 286     QTimer _autoReconnectTimer;
 287     int _autoReconnectCount;
 288
 289     QTimer _socketCloseTimer;
 290
 291     /* this flag triggers quitRequested() once the socket is closed
 292      * it is needed to determine whether or not the connection needs to be
 293      * in the automatic session restore. */
 294     bool _quitRequested;
 295     QString _quitReason;
 296
 297     bool _disconnectExpected;  /// If true, connection is quitting, expect a socket close
 298     // This avoids logging a spurious RemoteHostClosedError whenever disconnect is called without
 299     // specifying a permanent (saved to core session) disconnect.
 300
 301     bool _previousConnectionAttemptFailed;
 302     int _lastUsedServerIndex;
 303
 304     QTimer _pingTimer;
 305     uint _lastPingTime;
 306     uint _pingCount;
 307     bool _sendPings;
 308
 309     QStringList _autoWhoQueue;
 310     QHash<QString, int> _autoWhoPending;
 311     QTimer _autoWhoTimer, _autoWhoCycleTimer;
 312
 313     QTimer _tokenBucketTimer;
 314     int _messageDelay;      // token refill speed in ms
 315     int _burstSize;         // size of the token bucket
 316     int _tokenBucket;       // the virtual bucket that holds the tokens
 317     QList<QByteArray> _msgQueue;
 318
 319     QString _requestedUserModes; // 2 strings separated by a '-' character. first part are requested modes to add, the second to remove
 320
 321     // List of blowfish keys for channels
 322     QHash<QString, QByteArray> _cipherKeys;
 323 };
 324
 325
 326 #endif //CORENETWORK_H