src/core/corenetwork.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 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  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, 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 #include <QAbstractSocket>
  37
  38 #ifdef HAVE_QCA2
  39 #  include "cipher.h"
  40 #endif
  41
  42 #include "coresession.h"
  43
  44 class CoreIdentity;
  45 class CoreUserInputHandler;
  46 class CoreIgnoreListManager;
  47 class Event;
  48
  49 class CoreNetwork : public Network {
  50   SYNCABLE_OBJECT
  51   Q_OBJECT
  52
  53 public:
  54   CoreNetwork(const NetworkId &networkid, CoreSession *session);
  55   ~CoreNetwork();
  56   inline virtual const QMetaObject *syncMetaObject() const { return &Network::staticMetaObject; }
  57
  58   inline CoreIdentity *identityPtr() const { return coreSession()->identity(identity()); }
  59   inline CoreSession *coreSession() const { return _coreSession; }
  60   inline CoreNetworkConfig *networkConfig() const { return coreSession()->networkConfig(); }
  61
  62   inline CoreUserInputHandler *userInputHandler() const { return _userInputHandler; }
  63   inline CoreIgnoreListManager *ignoreListManager() { return coreSession()->ignoreListManager(); }
  64
  65   //! Decode a string using the server (network) decoding.
  66   inline QString serverDecode(const QByteArray &string) const { return decodeServerString(string); }
  67
  68   //! Decode a string using a channel-specific encoding if one is set (and use the standard encoding else).
  69   QString channelDecode(const QString &channelName, const QByteArray &string) const;
  70
  71   //! Decode a string using an IrcUser-specific encoding, if one exists (using the standaed encoding else).
  72   QString userDecode(const QString &userNick, const QByteArray &string) const;
  73
  74   //! Encode a string using the server (network) encoding.
  75   inline QByteArray serverEncode(const QString &string) const { return encodeServerString(string); }
  76
  77   //! Encode a string using the channel-specific encoding, if set, and use the standard encoding else.
  78   QByteArray channelEncode(const QString &channelName, const QString &string) const;
  79
  80   //! Encode a string using the user-specific encoding, if set, and use the standard encoding else.
  81   QByteArray userEncode(const QString &userNick, const QString &string) const;
  82
  83   inline QString channelKey(const QString &channel) const { return _channelKeys.value(channel.toLower(), QString()); }
  84
  85   inline bool isAutoWhoInProgress(const QString &channel) const { return _autoWhoPending.value(channel.toLower(), 0); }
  86
  87   inline UserId userId() const { return _coreSession->user(); }
  88
  89   inline QAbstractSocket::SocketState socketState() const { return socket.state(); }
  90   inline bool socketConnected() const { return socket.state() == QAbstractSocket::ConnectedState; }
  91   inline QHostAddress localAddress() const { return socket.localAddress(); }
  92   inline QHostAddress peerAddress() const { return socket.peerAddress(); }
  93   inline quint16 localPort() const { return socket.localPort(); }
  94   inline quint16 peerPort() const { return socket.peerPort(); }
  95
  96 public slots:
  97   virtual void setMyNick(const QString &mynick);
  98
  99   virtual void requestConnect() const;
 100   virtual void requestDisconnect() const;
 101   virtual void requestSetNetworkInfo(const NetworkInfo &info);
 102
 103   virtual void setUseAutoReconnect(bool);
 104   virtual void setAutoReconnectInterval(quint32);
 105   virtual void setAutoReconnectRetries(quint16);
 106
 107   void setPingInterval(int interval);
 108
 109   void connectToIrc(bool reconnecting = false);
 110   void disconnectFromIrc(bool requested = true, const QString &reason = QString(), bool withReconnect = false);
 111
 112   void userInput(BufferInfo bufferInfo, QString msg);
 113   void putRawLine(QByteArray input);
 114   void putCmd(const QString &cmd, const QList<QByteArray> &params, const QByteArray &prefix = QByteArray());
 115
 116   void setChannelJoined(const QString &channel);
 117   void setChannelParted(const QString &channel);
 118   void addChannelKey(const QString &channel, const QString &key);
 119   void removeChannelKey(const QString &channel);
 120
 121   // Blowfish stuff
 122 #ifdef HAVE_QCA2
 123   Cipher *cipher(const QString &recipient) const;
 124   QByteArray cipherKey(const QString &recipient) const;
 125   void setCipherKey(const QString &recipient, const QByteArray &key);
 126 #endif
 127
 128   void setAutoWhoEnabled(bool enabled);
 129   void setAutoWhoInterval(int interval);
 130   void setAutoWhoDelay(int delay);
 131
 132   bool setAutoWhoDone(const QString &channel);
 133
 134   void updateIssuedModes(const QString &requestedModes);
 135   void updatePersistentModes(QString addModes, QString removeModes);
 136   void resetPersistentModes();
 137
 138   Server usedServer() const;
 139
 140   inline void resetPingTimeout() { _pingCount = 0; }
 141
 142   inline void displayMsg(Message::Type msgType, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None) {
 143     emit displayMsg(networkId(), msgType, bufferType, target, text, sender, flags);
 144   }
 145
 146 signals:
 147   void recvRawServerMsg(QString);
 148   void displayStatusMsg(QString);
 149   void displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
 150   void disconnected(NetworkId networkId);
 151   void connectionError(const QString &errorMsg);
 152
 153   void quitRequested(NetworkId networkId);
 154   void sslErrors(const QVariant &errorData);
 155
 156   void newEvent(Event *event);
 157   void socketInitialized(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
 158   void socketDisconnected(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
 159
 160 protected:
 161   inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new CoreIrcChannel(channelname, this); }
 162   inline virtual IrcUser *ircUserFactory(const QString &hostmask) { return new CoreIrcUser(hostmask, this); }
 163
 164 protected slots:
 165   // TODO: remove cached cipher keys, when appropriate
 166   //virtual void removeIrcUser(IrcUser *ircuser);
 167   //virtual void removeIrcChannel(IrcChannel *ircChannel);
 168   //virtual void removeChansAndUsers();
 169
 170 private slots:
 171   void socketHasData();
 172   void socketError(QAbstractSocket::SocketError);
 173   void socketInitialized();
 174   inline void socketCloseTimeout() { socket.disconnectFromHost(); }
 175   void socketDisconnected();
 176   void socketStateChanged(QAbstractSocket::SocketState);
 177   void networkInitialized();
 178
 179   void sendPerform();
 180   void restoreUserModes();
 181   void doAutoReconnect();
 182   void sendPing();
 183   void enablePingTimeout(bool enable = true);
 184   void disablePingTimeout();
 185   void sendAutoWho();
 186   void startAutoWhoCycle();
 187
 188 #ifdef HAVE_SSL
 189   void sslErrors(const QList<QSslError> &errors);
 190 #endif
 191
 192   void fillBucketAndProcessQueue();
 193
 194   void writeToSocket(const QByteArray &data);
 195
 196 private:
 197   CoreSession *_coreSession;
 198
 199 #ifdef HAVE_SSL
 200   QSslSocket socket;
 201 #else
 202   QTcpSocket socket;
 203 #endif
 204
 205   CoreUserInputHandler *_userInputHandler;
 206
 207   QHash<QString, QString> _channelKeys;  // stores persistent channels and their passwords, if any
 208
 209   QTimer _autoReconnectTimer;
 210   int _autoReconnectCount;
 211
 212   QTimer _socketCloseTimer;
 213
 214   /* this flag triggers quitRequested() once the socket is closed
 215    * it is needed to determine whether or not the connection needs to be
 216    * in the automatic session restore. */
 217   bool _quitRequested;
 218   QString _quitReason;
 219
 220   bool _previousConnectionAttemptFailed;
 221   int _lastUsedServerIndex;
 222
 223   QTimer _pingTimer;
 224   uint _lastPingTime;
 225   uint _pingCount;
 226
 227   QStringList _autoWhoQueue;
 228   QHash<QString, int> _autoWhoPending;
 229   QTimer _autoWhoTimer, _autoWhoCycleTimer;
 230
 231   QTimer _tokenBucketTimer;
 232   int _messageDelay;        // token refill speed in ms
 233   int _burstSize;           // size of the token bucket
 234   int _tokenBucket;         // the virtual bucket that holds the tokens
 235   QList<QByteArray> _msgQueue;
 236
 237   QString _requestedUserModes; // 2 strings separated by a '-' character. first part are requested modes to add, the second to remove
 238
 239   // Blowfish key map
 240   QHash<QString, QByteArray> _cipherKeys;
 241 };
 242
 243 #endif //CORENETWORK_H