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     // IRCv3 capability negotiation
 104
 105     /**
 106      * Checks if a given capability is enabled.
 107      *
 108      * @returns True if enabled, otherwise false
 109      */
 110     inline bool capEnabled(const QString &capability) const { return _capsSupported.contains(capability); }
 111
 112     /**
 113      * Checks if capability negotiation is currently ongoing.
 114      *
 115      * @returns True if in progress, otherwise false
 116      */
 117     inline bool capNegotiationInProgress() const { return !_capsQueued.empty(); }
 118
 119     /**
 120      * Gets the value of an enabled or pending capability, e.g. sasl=plain.
 121      *
 122      * @returns Value of capability if one was specified, otherwise empty string
 123      */
 124     QString capValue(const QString &capability) const;
 125
 126     /**
 127      * Gets the next capability to request, removing it from the queue.
 128      *
 129      * @returns Name of capability to request
 130      */
 131     QString takeQueuedCap();
 132
 133     // Specific capabilities for easy reference
 134
 135     /**
 136      * Gets the status of the sasl authentication capability.
 137      *
 138      * http://ircv3.net/specs/extensions/sasl-3.2.html
 139      *
 140      * @returns True if SASL authentication is enabled, otherwise false
 141      */
 142     inline bool useCapSASL() const { return capEnabled("sasl"); }
 143
 144     /**
 145      * Gets the status of the away-notify capability.
 146      *
 147      * http://ircv3.net/specs/extensions/away-notify-3.1.html
 148      *
 149      * @returns True if away-notify is enabled, otherwise false
 150      */
 151     inline bool useCapAwayNotify() const { return capEnabled("away-notify"); }
 152
 153     /**
 154      * Gets the status of the account-notify capability.
 155      *
 156      * http://ircv3.net/specs/extensions/account-notify-3.1.html
 157      *
 158      * @returns True if account-notify is enabled, otherwise false
 159      */
 160     inline bool useCapAccountNotify() const { return capEnabled("account-notify"); }
 161
 162     /**
 163      * Gets the status of the extended-join capability.
 164      *
 165      * http://ircv3.net/specs/extensions/extended-join-3.1.html
 166      *
 167      * @returns True if extended-join is enabled, otherwise false
 168      */
 169     inline bool useCapExtendedJoin() const { return capEnabled("extended-join"); }
 170
 171 public slots:
 172     virtual void setMyNick(const QString &mynick);
 173
 174     virtual void requestConnect() const;
 175     virtual void requestDisconnect() const;
 176     virtual void requestSetNetworkInfo(const NetworkInfo &info);
 177
 178     virtual void setUseAutoReconnect(bool);
 179     virtual void setAutoReconnectInterval(quint32);
 180     virtual void setAutoReconnectRetries(quint16);
 181
 182     void setPingInterval(int interval);
 183
 184     void connectToIrc(bool reconnecting = false);
 185     void disconnectFromIrc(bool requested = true, const QString &reason = QString(), bool withReconnect = false);
 186
 187     void userInput(BufferInfo bufferInfo, QString msg);
 188     void putRawLine(QByteArray input);
 189     void putCmd(const QString &cmd, const QList<QByteArray> &params, const QByteArray &prefix = QByteArray());
 190     void putCmd(const QString &cmd, const QList<QList<QByteArray>> &params, const QByteArray &prefix = QByteArray());
 191
 192     void setChannelJoined(const QString &channel);
 193     void setChannelParted(const QString &channel);
 194     void addChannelKey(const QString &channel, const QString &key);
 195     void removeChannelKey(const QString &channel);
 196
 197     // Blowfish stuff
 198 #ifdef HAVE_QCA2
 199     Cipher *cipher(const QString &recipient);
 200     QByteArray cipherKey(const QString &recipient) const;
 201     void setCipherKey(const QString &recipient, const QByteArray &key);
 202     bool cipherUsesCBC(const QString &target);
 203 #endif
 204
 205     // IRCv3 capability negotiation (can be connected to signals)
 206
 207     /**
 208      * Marks a capability as accepted, providing an optional value.
 209      *
 210      * Removes it from queue of pending capabilities and triggers any capability-specific
 211      * activation.
 212      *
 213      * @param[in] capability Name of the capability
 214      * @param[in] value
 215      * @parblock
 216      * Optional value of the capability, e.g. sasl=plain.  If left empty, will be copied from the
 217      * pending capability.
 218      * @endparblock
 219      */
 220     void addCap(const QString &capability, const QString &value = QString());
 221
 222     /**
 223      * Marks a capability as denied.
 224      *
 225      * Removes it from the queue of pending capabilities and triggers any capability-specific
 226      * deactivation.
 227      *
 228      * @param[in] capability Name of the capability
 229      */
 230     void removeCap(const QString &capability);
 231
 232     /**
 233      * Queues a capability as available but not yet accepted or denied.
 234      *
 235      * Capabilities should be queued when registration pauses for CAP LS for capabilities are only
 236      * requested during login.
 237      *
 238      * @param[in] capability Name of the capability
 239      * @param[in] value      Optional value of the capability, e.g. sasl=plain
 240      */
 241     void queuePendingCap(const QString &capability, const QString &value = QString());
 242
 243     void setAutoWhoEnabled(bool enabled);
 244     void setAutoWhoInterval(int interval);
 245     void setAutoWhoDelay(int delay);
 246
 247     /**
 248      * Appends the given channel/nick to the front of the AutoWho queue.
 249      *
 250      * When 'away-notify' is enabled, this will trigger an immediate AutoWho since regular
 251      * who-cycles are disabled as per IRCv3 specifications.
 252      *
 253      * @param[in] channelOrNick Channel or nickname to WHO
 254      */
 255     void queueAutoWhoOneshot(const QString &channelOrNick);
 256
 257     bool setAutoWhoDone(const QString &channel);
 258
 259     void updateIssuedModes(const QString &requestedModes);
 260     void updatePersistentModes(QString addModes, QString removeModes);
 261     void resetPersistentModes();
 262
 263     Server usedServer() const;
 264
 265     inline void resetPingTimeout() { _pingCount = 0; }
 266
 267     inline void displayMsg(Message::Type msgType, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None)
 268     {
 269         emit displayMsg(networkId(), msgType, bufferType, target, text, sender, flags);
 270     }
 271
 272
 273 signals:
 274     void recvRawServerMsg(QString);
 275     void displayStatusMsg(QString);
 276     void displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
 277     void disconnected(NetworkId networkId);
 278     void connectionError(const QString &errorMsg);
 279
 280     void quitRequested(NetworkId networkId);
 281     void sslErrors(const QVariant &errorData);
 282
 283     void newEvent(Event *event);
 284     void socketInitialized(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
 285     void socketDisconnected(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
 286
 287 protected:
 288     inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new CoreIrcChannel(channelname, this); }
 289     inline virtual IrcUser *ircUserFactory(const QString &hostmask) { return new CoreIrcUser(hostmask, this); }
 290
 291 protected slots:
 292     // TODO: remove cached cipher keys, when appropriate
 293     //virtual void removeIrcUser(IrcUser *ircuser);
 294     //virtual void removeIrcChannel(IrcChannel *ircChannel);
 295     //virtual void removeChansAndUsers();
 296
 297 private slots:
 298     void socketHasData();
 299     void socketError(QAbstractSocket::SocketError);
 300     void socketInitialized();
 301     inline void socketCloseTimeout() { socket.abort(); }
 302     void socketDisconnected();
 303     void socketStateChanged(QAbstractSocket::SocketState);
 304     void networkInitialized();
 305
 306     void sendPerform();
 307     void restoreUserModes();
 308     void doAutoReconnect();
 309     void sendPing();
 310     void enablePingTimeout(bool enable = true);
 311     void disablePingTimeout();
 312     void sendAutoWho();
 313     void startAutoWhoCycle();
 314
 315 #ifdef HAVE_SSL
 316     void sslErrors(const QList<QSslError> &errors);
 317 #endif
 318
 319     void fillBucketAndProcessQueue();
 320
 321     void writeToSocket(const QByteArray &data);
 322
 323 private:
 324     CoreSession *_coreSession;
 325
 326 #ifdef HAVE_SSL
 327     QSslSocket socket;
 328 #else
 329     QTcpSocket socket;
 330 #endif
 331
 332     CoreUserInputHandler *_userInputHandler;
 333
 334     QHash<QString, QString> _channelKeys; // stores persistent channels and their passwords, if any
 335
 336     QTimer _autoReconnectTimer;
 337     int _autoReconnectCount;
 338
 339     QTimer _socketCloseTimer;
 340
 341     /* this flag triggers quitRequested() once the socket is closed
 342      * it is needed to determine whether or not the connection needs to be
 343      * in the automatic session restore. */
 344     bool _quitRequested;
 345     QString _quitReason;
 346
 347     bool _previousConnectionAttemptFailed;
 348     int _lastUsedServerIndex;
 349
 350     QTimer _pingTimer;
 351     uint _lastPingTime;
 352     uint _pingCount;
 353     bool _sendPings;
 354
 355     QStringList _autoWhoQueue;
 356     QHash<QString, int> _autoWhoPending;
 357     QTimer _autoWhoTimer, _autoWhoCycleTimer;
 358
 359     // CAPs may have parameter values
 360     // See http://ircv3.net/specs/core/capability-negotiation-3.2.html
 361     QStringList _capsQueued;                /// Capabilities to be checked
 362     QHash<QString, QString> _capsPending;   /// Capabilities pending 'CAP ACK' from server
 363     QHash<QString, QString> _capsSupported; /// Enabled capabilities that received 'CAP ACK'
 364
 365     QTimer _tokenBucketTimer;
 366     int _messageDelay;      // token refill speed in ms
 367     int _burstSize;         // size of the token bucket
 368     int _tokenBucket;       // the virtual bucket that holds the tokens
 369     QList<QByteArray> _msgQueue;
 370
 371     QString _requestedUserModes; // 2 strings separated by a '-' character. first part are requested modes to add, the second to remove
 372
 373     // List of blowfish keys for channels
 374     QHash<QString, QByteArray> _cipherKeys;
 375 };
 376
 377
 378 #endif //CORENETWORK_H