src/common/network.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-08 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 NETWORK_H
  22 #define NETWORK_H
  23
  24 #include <QString>
  25 #include <QStringList>
  26 #include <QList>
  27 #include <QHash>
  28 #include <QVariantMap>
  29 #include <QPointer>
  30 #include <QMutex>
  31
  32 #include "types.h"
  33 #include "syncableobject.h"
  34
  35 #include "signalproxy.h"
  36 #include "ircuser.h"
  37 #include "ircchannel.h"
  38
  39 // defined below!
  40 struct NetworkInfo;
  41
  42 // TODO: ConnectionInfo to propagate and sync the current state of NetworkConnection, encodings etcpp
  43
  44 class Network : public SyncableObject {
  45   Q_OBJECT
  46   Q_ENUMS(ConnectionState Network::ConnectionState)
  47
  48   Q_PROPERTY(QString networkName READ networkName WRITE setNetworkName STORED false)
  49   Q_PROPERTY(QString currentServer READ currentServer WRITE setCurrentServer STORED false)
  50   Q_PROPERTY(QString myNick READ myNick WRITE setMyNick STORED false)
  51   Q_PROPERTY(int latency READ latency WRITE setLatency STORED false)
  52   Q_PROPERTY(QByteArray codecForServer READ codecForServer WRITE setCodecForServer STORED false)
  53   Q_PROPERTY(QByteArray codecForEncoding READ codecForEncoding WRITE setCodecForEncoding STORED false)
  54   Q_PROPERTY(QByteArray codecForDecoding READ codecForDecoding WRITE setCodecForDecoding STORED false)
  55   Q_PROPERTY(IdentityId identityId READ identity WRITE setIdentity STORED false)
  56   Q_PROPERTY(bool isConnected READ isConnected WRITE setConnected STORED false)
  57   //Q_PROPERTY(Network::ConnectionState connectionState READ connectionState WRITE setConnectionState STORED false)
  58   Q_PROPERTY(int connectionState READ connectionState WRITE setConnectionState STORED false)
  59   Q_PROPERTY(bool useRandomServer READ useRandomServer WRITE setUseRandomServer STORED false)
  60   Q_PROPERTY(QStringList perform READ perform WRITE setPerform STORED false)
  61   Q_PROPERTY(bool useAutoIdentify READ useAutoIdentify WRITE setUseAutoIdentify STORED false)
  62   Q_PROPERTY(QString autoIdentifyService READ autoIdentifyService WRITE setAutoIdentifyService STORED false)
  63   Q_PROPERTY(QString autoIdentifyPassword READ autoIdentifyPassword WRITE setAutoIdentifyPassword STORED false)
  64   Q_PROPERTY(bool useAutoReconnect READ useAutoReconnect WRITE setUseAutoReconnect STORED false)
  65   Q_PROPERTY(quint32 autoReconnectInterval READ autoReconnectInterval WRITE setAutoReconnectInterval STORED false)
  66   Q_PROPERTY(quint16 autoReconnectRetries READ autoReconnectRetries WRITE setAutoReconnectRetries STORED false)
  67   Q_PROPERTY(bool unlimitedReconnectRetries READ unlimitedReconnectRetries WRITE setUnlimitedReconnectRetries STORED false)
  68   Q_PROPERTY(bool rejoinChannels READ rejoinChannels WRITE setRejoinChannels STORED false)
  69
  70 public:
  71   enum ConnectionState {
  72     Disconnected,
  73     Connecting,
  74     Initializing,
  75     Initialized,
  76     Reconnecting,
  77     Disconnecting
  78   };
  79
  80   // see:
  81   //  http://www.irc.org/tech_docs/005.html
  82   //  http://www.irc.org/tech_docs/draft-brocklesby-irc-isupport-03.txt
  83   enum ChannelModeType {
  84     NOT_A_CHANMODE = 0x00,
  85     A_CHANMODE = 0x01,
  86     B_CHANMODE = 0x02,
  87     C_CHANMODE = 0x04,
  88     D_CHANMODE = 0x08
  89   };
  90
  91   struct Server {
  92     QString host;
  93     uint port;
  94     QString password;
  95     bool useSsl;
  96     Server() : port(0), useSsl(false) {}
  97     Server(const QString &host, uint port, const QString &password, bool useSsl)
  98       : host(host), port(port), password(password), useSsl(useSsl) {}
  99
 100     static Server fromVariant(const QVariant &variant);
 101     QVariant toVariant() const;
 102   };
 103   typedef QList<Server> ServerList;
 104
 105   Network(const NetworkId &networkid, QObject *parent = 0);
 106   ~Network();
 107
 108   inline NetworkId networkId() const { return _networkId; }
 109
 110   inline SignalProxy *proxy() const { return _proxy; }
 111   inline void setProxy(SignalProxy *proxy) { _proxy = proxy; }
 112
 113   inline bool isMyNick(const QString &nick) const { return (myNick().toLower() == nick.toLower()); }
 114   inline bool isMe(IrcUser *ircuser) const { return (ircuser->nick().toLower() == myNick().toLower()); }
 115
 116   bool isChannelName(const QString &channelname) const;
 117
 118   inline bool isConnected() const { return _connected; }
 119   //Network::ConnectionState connectionState() const;
 120   inline int connectionState() const { return _connectionState; }
 121
 122   QString prefixToMode(const QString &prefix);
 123   inline QString prefixToMode(const QCharRef &prefix) { return prefixToMode(QString(prefix)); }
 124   QString modeToPrefix(const QString &mode);
 125   inline QString modeToPrefix(const QCharRef &mode) { return modeToPrefix(QString(mode)); }
 126
 127   ChannelModeType channelModeType(const QString &mode);
 128   inline ChannelModeType channelModeType(const QCharRef &mode) { return channelModeType(QString(mode)); }
 129
 130   inline const QString &networkName() const { return _networkName; }
 131   inline const QString &currentServer() const { return _currentServer; }
 132   inline const QString &myNick() const { return _myNick; }
 133   inline int latency() const { return _latency; }
 134   inline IrcUser *me() const { return ircUser(myNick()); }
 135   inline IdentityId identity() const { return _identity; }
 136   QStringList nicks() const;
 137   inline QStringList channels() const { return _ircChannels.keys(); }
 138   inline const ServerList &serverList() const { return _serverList; }
 139   QVariantList variantServerList() const;
 140   inline bool useRandomServer() const { return _useRandomServer; }
 141   inline const QStringList &perform() const { return _perform; }
 142   inline bool useAutoIdentify() const { return _useAutoIdentify; }
 143   inline const QString &autoIdentifyService() const { return _autoIdentifyService; }
 144   inline const QString &autoIdentifyPassword() const { return _autoIdentifyPassword; }
 145   inline bool useAutoReconnect() const { return _useAutoReconnect; }
 146   inline quint32 autoReconnectInterval() const { return _autoReconnectInterval; }
 147   inline quint16 autoReconnectRetries() const { return _autoReconnectRetries; }
 148   inline bool unlimitedReconnectRetries() const { return _unlimitedReconnectRetries; }
 149   inline bool rejoinChannels() const { return _rejoinChannels; }
 150
 151   NetworkInfo networkInfo() const;
 152   void setNetworkInfo(const NetworkInfo &);
 153
 154   QString prefixes();
 155   QString prefixModes();
 156
 157   bool supports(const QString &param) const { return _supports.contains(param); }
 158   QString support(const QString &param) const;
 159
 160   IrcUser *newIrcUser(const QString &hostmask, const QVariantMap &initData = QVariantMap());
 161   inline IrcUser *newIrcUser(const QByteArray &hostmask) { return newIrcUser(decodeServerString(hostmask)); }
 162   IrcUser *ircUser(QString nickname) const;
 163   inline IrcUser *ircUser(const QByteArray &nickname) const { return ircUser(decodeServerString(nickname)); }
 164   inline QList<IrcUser *> ircUsers() const { return _ircUsers.values(); }
 165   inline quint32 ircUserCount() const { return _ircUsers.count(); }
 166
 167   IrcChannel *newIrcChannel(const QString &channelname, const QVariantMap &initData = QVariantMap());
 168   inline IrcChannel *newIrcChannel(const QByteArray &channelname) { return newIrcChannel(decodeServerString(channelname)); }
 169   IrcChannel *ircChannel(QString channelname) const;
 170   inline IrcChannel *ircChannel(const QByteArray &channelname) const { return ircChannel(decodeServerString(channelname)); }
 171   inline QList<IrcChannel *> ircChannels() const { return _ircChannels.values(); }
 172   inline quint32 ircChannelCount() const { return _ircChannels.count(); }
 173
 174   QByteArray codecForServer() const;
 175   QByteArray codecForEncoding() const;
 176   QByteArray codecForDecoding() const;
 177   void setCodecForServer(QTextCodec *codec);
 178   void setCodecForEncoding(QTextCodec *codec);
 179   void setCodecForDecoding(QTextCodec *codec);
 180
 181   QString decodeString(const QByteArray &text) const;
 182   QByteArray encodeString(const QString &string) const;
 183   QString decodeServerString(const QByteArray &text) const;
 184   QByteArray encodeServerString(const QString &string) const;
 185
 186   static QByteArray defaultCodecForServer();
 187   static QByteArray defaultCodecForEncoding();
 188   static QByteArray defaultCodecForDecoding();
 189   static void setDefaultCodecForServer(const QByteArray &name);
 190   static void setDefaultCodecForEncoding(const QByteArray &name);
 191   static void setDefaultCodecForDecoding(const QByteArray &name);
 192
 193   inline bool autoAwayActive() const { return _autoAwayActive; }
 194   inline void setAutoAwayActive(bool active) { _autoAwayActive = active; }
 195
 196 public slots:
 197   void setNetworkName(const QString &networkName);
 198   void setCurrentServer(const QString &currentServer);
 199   void setConnected(bool isConnected);
 200   void setConnectionState(int state);
 201   virtual void setMyNick(const QString &mynick);
 202   void setLatency(int latency);
 203   void setIdentity(IdentityId);
 204
 205   void setServerList(const QVariantList &serverList);
 206   void setUseRandomServer(bool);
 207   void setPerform(const QStringList &);
 208   void setUseAutoIdentify(bool);
 209   void setAutoIdentifyService(const QString &);
 210   void setAutoIdentifyPassword(const QString &);
 211   virtual void setUseAutoReconnect(bool);
 212   virtual void setAutoReconnectInterval(quint32);
 213   virtual void setAutoReconnectRetries(quint16);
 214   void setUnlimitedReconnectRetries(bool);
 215   void setRejoinChannels(bool);
 216
 217   void setCodecForServer(const QByteArray &codecName);
 218   void setCodecForEncoding(const QByteArray &codecName);
 219   void setCodecForDecoding(const QByteArray &codecName);
 220
 221   void addSupport(const QString &param, const QString &value = QString());
 222   void removeSupport(const QString &param);
 223
 224   inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
 225   inline void addIrcChannel(const QString &channel) { newIrcChannel(channel); }
 226
 227   //init geters
 228   QVariantMap initSupports() const;
 229   inline QVariantList initServerList() const { return variantServerList(); }
 230   virtual QVariantMap initIrcUsersAndChannels() const;
 231
 232   //init seters
 233   void initSetSupports(const QVariantMap &supports);
 234   void initSetServerList(const QVariantList &serverList);
 235   virtual void initSetIrcUsersAndChannels(const QVariantMap &usersAndChannels);
 236
 237   IrcUser *updateNickFromMask(const QString &mask);
 238
 239   // these slots are to keep the hashlists of all users and the
 240   // channel lists up to date
 241   void ircUserNickChanged(QString newnick);
 242
 243   virtual inline void requestConnect() const { emit connectRequested(); }
 244   virtual inline void requestDisconnect() const { emit disconnectRequested(); }
 245   virtual inline void requestSetNetworkInfo(const NetworkInfo &info) { emit setNetworkInfoRequested(info); }
 246
 247   void emitConnectionError(const QString &);
 248
 249 private slots:
 250   void removeIrcUser(IrcUser *ircuser);
 251   void removeIrcChannel(IrcChannel *ircChannel);
 252   void removeChansAndUsers();
 253
 254 signals:
 255   void aboutToBeDestroyed();
 256   void networkNameSet(const QString &networkName);
 257   void currentServerSet(const QString &currentServer);
 258   void connectedSet(bool isConnected);
 259   void connectionStateSet(Network::ConnectionState);
 260   void connectionStateSet(int);
 261   void connectionError(const QString &errorMsg);
 262   void myNickSet(const QString &mynick);
 263   void latencySet(int latency);
 264   void identitySet(IdentityId);
 265
 266   void serverListSet(QVariantList serverList);
 267   void useRandomServerSet(bool);
 268   void performSet(const QStringList &);
 269   void useAutoIdentifySet(bool);
 270   void autoIdentifyServiceSet(const QString &);
 271   void autoIdentifyPasswordSet(const QString &);
 272   void useAutoReconnectSet(bool);
 273   void autoReconnectIntervalSet(quint32);
 274   void autoReconnectRetriesSet(quint16);
 275   void unlimitedReconnectRetriesSet(bool);
 276   void rejoinChannelsSet(bool);
 277
 278   void codecForServerSet(const QByteArray &codecName);
 279   void codecForEncodingSet(const QByteArray &codecName);
 280   void codecForDecodingSet(const QByteArray &codecName);
 281
 282   void supportAdded(const QString &param, const QString &value);
 283   void supportRemoved(const QString &param);
 284
 285   void ircUserAdded(const QString &hostmask);
 286   void ircUserAdded(IrcUser *);
 287   void ircChannelAdded(const QString &channelname);
 288   void ircChannelAdded(IrcChannel *);
 289
 290   void connectRequested() const;
 291   void disconnectRequested() const;
 292   void setNetworkInfoRequested(const NetworkInfo &) const;
 293
 294 protected:
 295   inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new IrcChannel(channelname, this); }
 296
 297 private:
 298   QPointer<SignalProxy> _proxy;
 299
 300   NetworkId _networkId;
 301   IdentityId _identity;
 302
 303   QString _myNick;
 304   int _latency;
 305   QString _networkName;
 306   QString _currentServer;
 307   bool _connected;
 308   ConnectionState _connectionState;
 309
 310   QString _prefixes;
 311   QString _prefixModes;
 312
 313   QHash<QString, IrcUser *> _ircUsers;  // stores all known nicks for the server
 314   QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
 315   QHash<QString, QString> _supports;  // stores results from RPL_ISUPPORT
 316
 317   ServerList _serverList;
 318   bool _useRandomServer;
 319   QStringList _perform;
 320
 321   bool _useAutoIdentify;
 322   QString _autoIdentifyService;
 323   QString _autoIdentifyPassword;
 324
 325   bool _useAutoReconnect;
 326   quint32 _autoReconnectInterval;
 327   quint16 _autoReconnectRetries;
 328   bool _unlimitedReconnectRetries;
 329   bool _rejoinChannels;
 330
 331   void determinePrefixes();
 332
 333   QTextCodec *_codecForServer;
 334   QTextCodec *_codecForEncoding;
 335   QTextCodec *_codecForDecoding;
 336
 337   static QTextCodec *_defaultCodecForServer;
 338   static QTextCodec *_defaultCodecForEncoding;
 339   static QTextCodec *_defaultCodecForDecoding;
 340
 341   bool _autoAwayActive; // when this is active handle305 and handle306 don't trigger any output
 342
 343   friend class IrcUser;
 344   friend class IrcChannel;
 345 };
 346
 347 //! Stores all editable information about a network (as opposed to runtime state).
 348 struct NetworkInfo {
 349   NetworkId networkId;
 350   QString networkName;
 351   IdentityId identity;
 352
 353   bool useCustomEncodings; // not used!
 354   QByteArray codecForServer;
 355   QByteArray codecForEncoding;
 356   QByteArray codecForDecoding;
 357
 358   // Server entry: QString "Host", uint "Port", QString "Password", bool "UseSSL"
 359   QVariantList serverList;
 360   bool useRandomServer;
 361
 362   QStringList perform;
 363
 364   bool useAutoIdentify;
 365   QString autoIdentifyService;
 366   QString autoIdentifyPassword;
 367
 368   bool useAutoReconnect;
 369   quint32 autoReconnectInterval;
 370   quint16 autoReconnectRetries;
 371   bool unlimitedReconnectRetries;
 372   bool rejoinChannels;
 373
 374   bool operator==(const NetworkInfo &other) const;
 375   bool operator!=(const NetworkInfo &other) const;
 376 };
 377
 378 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
 379 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
 380 QDebug operator<<(QDebug dbg, const NetworkInfo &i);
 381
 382 Q_DECLARE_METATYPE(NetworkInfo)
 383
 384 #endif