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
  92   Network(const NetworkId &networkid, QObject *parent = 0);
  93   ~Network();
  94
  95   inline NetworkId networkId() const { return _networkId; }
  96
  97   inline SignalProxy *proxy() const { return _proxy; }
  98   inline void setProxy(SignalProxy *proxy) { _proxy = proxy; }
  99
 100   inline bool isMyNick(const QString &nick) const { return (myNick().toLower() == nick.toLower()); }
 101   inline bool isMe(IrcUser *ircuser) const { return (ircuser->nick().toLower() == myNick().toLower()); }
 102
 103   bool isChannelName(const QString &channelname) const;
 104
 105   inline bool isConnected() const { return _connected; }
 106   //Network::ConnectionState connectionState() const;
 107   inline int connectionState() const { return _connectionState; }
 108
 109   QString prefixToMode(const QString &prefix);
 110   inline QString prefixToMode(const QCharRef &prefix) { return prefixToMode(QString(prefix)); }
 111   QString modeToPrefix(const QString &mode);
 112   inline QString modeToPrefix(const QCharRef &mode) { return modeToPrefix(QString(mode)); }
 113
 114   ChannelModeType channelModeType(const QString &mode);
 115   inline ChannelModeType channelModeType(const QCharRef &mode) { return channelModeType(QString(mode)); }
 116
 117   inline const QString &networkName() const { return _networkName; }
 118   inline const QString &currentServer() const { return _currentServer; }
 119   inline const QString &myNick() const { return _myNick; }
 120   inline int latency() const { return _latency; }
 121   inline IrcUser *me() const { return ircUser(myNick()); }
 122   inline IdentityId identity() const { return _identity; }
 123   QStringList nicks() const;
 124   inline QStringList channels() const { return _ircChannels.keys(); }
 125   inline const QVariantList &serverList() const { return _serverList; }
 126   inline bool useRandomServer() const { return _useRandomServer; }
 127   inline const QStringList &perform() const { return _perform; }
 128   inline bool useAutoIdentify() const { return _useAutoIdentify; }
 129   inline const QString &autoIdentifyService() const { return _autoIdentifyService; }
 130   inline const QString &autoIdentifyPassword() const { return _autoIdentifyPassword; }
 131   inline bool useAutoReconnect() const { return _useAutoReconnect; }
 132   inline quint32 autoReconnectInterval() const { return _autoReconnectInterval; }
 133   inline quint16 autoReconnectRetries() const { return _autoReconnectRetries; }
 134   inline bool unlimitedReconnectRetries() const { return _unlimitedReconnectRetries; }
 135   inline bool rejoinChannels() const { return _rejoinChannels; }
 136
 137   NetworkInfo networkInfo() const;
 138   void setNetworkInfo(const NetworkInfo &);
 139
 140   QString prefixes();
 141   QString prefixModes();
 142
 143   bool supports(const QString &param) const { return _supports.contains(param); }
 144   QString support(const QString &param) const;
 145
 146   IrcUser *newIrcUser(const QString &hostmask);
 147   inline IrcUser *newIrcUser(const QByteArray &hostmask) { return newIrcUser(decodeServerString(hostmask)); }
 148   IrcUser *ircUser(QString nickname) const;
 149   inline IrcUser *ircUser(const QByteArray &nickname) const { return ircUser(decodeServerString(nickname)); }
 150   inline QList<IrcUser *> ircUsers() const { return _ircUsers.values(); }
 151   inline quint32 ircUserCount() const { return _ircUsers.count(); }
 152
 153   IrcChannel *newIrcChannel(const QString &channelname);
 154   inline IrcChannel *newIrcChannel(const QByteArray &channelname) { return newIrcChannel(decodeServerString(channelname)); }
 155   IrcChannel *ircChannel(QString channelname) const;
 156   inline IrcChannel *ircChannel(const QByteArray &channelname) const { return ircChannel(decodeServerString(channelname)); }
 157   inline QList<IrcChannel *> ircChannels() const { return _ircChannels.values(); }
 158   inline quint32 ircChannelCount() const { return _ircChannels.count(); }
 159
 160   QByteArray codecForServer() const;
 161   QByteArray codecForEncoding() const;
 162   QByteArray codecForDecoding() const;
 163   void setCodecForServer(QTextCodec *codec);
 164   void setCodecForEncoding(QTextCodec *codec);
 165   void setCodecForDecoding(QTextCodec *codec);
 166
 167   QString decodeString(const QByteArray &text) const;
 168   QByteArray encodeString(const QString &string) const;
 169   QString decodeServerString(const QByteArray &text) const;
 170   QByteArray encodeServerString(const QString &string) const;
 171
 172   static QByteArray defaultCodecForServer();
 173   static QByteArray defaultCodecForEncoding();
 174   static QByteArray defaultCodecForDecoding();
 175   static void setDefaultCodecForServer(const QByteArray &name);
 176   static void setDefaultCodecForEncoding(const QByteArray &name);
 177   static void setDefaultCodecForDecoding(const QByteArray &name);
 178
 179   bool autoAwayActive() const { return _autoAwayActive; }
 180   void setAutoAwayActive(bool active) { _autoAwayActive = active; }
 181
 182 public slots:
 183   void setNetworkName(const QString &networkName);
 184   void setCurrentServer(const QString &currentServer);
 185   void setConnected(bool isConnected);
 186   //void setConnectionState(Network::ConnectionState state);
 187   void setConnectionState(int state);
 188   void setMyNick(const QString &mynick);
 189   void setLatency(int latency);
 190   void setIdentity(IdentityId);
 191
 192   void setServerList(const QVariantList &serverList);
 193   void setUseRandomServer(bool);
 194   void setPerform(const QStringList &);
 195   void setUseAutoIdentify(bool);
 196   void setAutoIdentifyService(const QString &);
 197   void setAutoIdentifyPassword(const QString &);
 198   void setUseAutoReconnect(bool);
 199   void setAutoReconnectInterval(quint32);
 200   void setAutoReconnectRetries(quint16);
 201   void setUnlimitedReconnectRetries(bool);
 202   void setRejoinChannels(bool);
 203
 204   void setCodecForServer(const QByteArray &codecName);
 205   void setCodecForEncoding(const QByteArray &codecName);
 206   void setCodecForDecoding(const QByteArray &codecName);
 207
 208   void addSupport(const QString &param, const QString &value = QString());
 209   void removeSupport(const QString &param);
 210
 211   inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
 212   inline void addIrcChannel(const QString &channel) { newIrcChannel(channel); }
 213   void removeIrcUser(const QString &nick);
 214   void removeIrcChannel(const QString &channel);
 215
 216   //init geters
 217   QVariantMap initSupports() const;
 218   inline QVariantList initServerList() const { return serverList(); }
 219   virtual QVariantMap initIrcUsersAndChannels() const;
 220 //   QStringList initIrcUsers() const;
 221 //   QStringList initIrcChannels() const;
 222
 223   //init seters
 224   void initSetSupports(const QVariantMap &supports);
 225   inline void initSetServerList(const QVariantList &serverList) { setServerList(serverList); }
 226   virtual void initSetIrcUsersAndChannels(const QVariantMap &usersAndChannels);
 227 //   void initSetIrcUsers(const QStringList &hostmasks);
 228 //   void initSetIrcChannels(const QStringList &channels);
 229
 230   IrcUser *updateNickFromMask(const QString &mask);
 231
 232   // these slots are to keep the hashlists of all users and the
 233   // channel lists up to date
 234   void ircUserNickChanged(QString newnick);
 235
 236   virtual inline void requestConnect() const { emit connectRequested(); }
 237   virtual inline void requestDisconnect() const { emit disconnectRequested(); }
 238   virtual inline void requestSetNetworkInfo(const NetworkInfo &info) { emit setNetworkInfoRequested(info); }
 239
 240   void emitConnectionError(const QString &);
 241
 242 private slots:
 243   void ircUserDestroyed();
 244   void channelDestroyed();
 245   void removeIrcUser(IrcUser *ircuser);
 246   void removeIrcChannel(IrcChannel *ircChannel);
 247   void removeChansAndUsers();
 248   void ircUserInitDone();
 249   void ircChannelInitDone();
 250
 251 signals:
 252   void aboutToBeDestroyed();
 253   void networkNameSet(const QString &networkName);
 254   void currentServerSet(const QString &currentServer);
 255   void connectedSet(bool isConnected);
 256   void connectionStateSet(Network::ConnectionState);
 257   void connectionStateSet(int);
 258   void connectionError(const QString &errorMsg);
 259   void myNickSet(const QString &mynick);
 260   void latencySet(int latency);
 261   void identitySet(IdentityId);
 262
 263   void serverListSet(QVariantList serverList);
 264   void useRandomServerSet(bool);
 265   void performSet(const QStringList &);
 266   void useAutoIdentifySet(bool);
 267   void autoIdentifyServiceSet(const QString &);
 268   void autoIdentifyPasswordSet(const QString &);
 269   void useAutoReconnectSet(bool);
 270   void autoReconnectIntervalSet(quint32);
 271   void autoReconnectRetriesSet(quint16);
 272   void unlimitedReconnectRetriesSet(bool);
 273   void rejoinChannelsSet(bool);
 274
 275   void codecForServerSet(const QByteArray &codecName);
 276   void codecForEncodingSet(const QByteArray &codecName);
 277   void codecForDecodingSet(const QByteArray &codecName);
 278
 279   void supportAdded(const QString &param, const QString &value);
 280   void supportRemoved(const QString &param);
 281
 282   void ircUserAdded(const QString &hostmask);
 283   void ircUserAdded(IrcUser *);
 284   void ircChannelAdded(const QString &channelname);
 285   void ircChannelAdded(IrcChannel *);
 286
 287   void ircUserRemoved(const QString &nick);
 288   void ircChannelRemoved(const QString &channel);
 289
 290   // needed for client sync progress
 291   void ircUserRemoved(QObject *);
 292   void ircChannelRemoved(QObject *);
 293
 294   void ircUserInitDone(IrcUser *);
 295   void ircChannelInitDone(IrcChannel *);
 296
 297   void connectRequested(NetworkId id = 0) const;
 298   void disconnectRequested(NetworkId id = 0) const;
 299   void setNetworkInfoRequested(const NetworkInfo &) const;
 300
 301 protected:
 302   inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new IrcChannel(channelname, this); }
 303
 304 private:
 305   QPointer<SignalProxy> _proxy;
 306
 307   NetworkId _networkId;
 308   IdentityId _identity;
 309
 310   QString _myNick;
 311   int _latency;
 312   QString _networkName;
 313   QString _currentServer;
 314   bool _connected;
 315   ConnectionState _connectionState;
 316
 317   QString _prefixes;
 318   QString _prefixModes;
 319
 320   QHash<QString, IrcUser *> _ircUsers;  // stores all known nicks for the server
 321   QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
 322   QHash<QString, QString> _supports;  // stores results from RPL_ISUPPORT
 323
 324   QVariantList _serverList;
 325   bool _useRandomServer;
 326   QStringList _perform;
 327
 328   bool _useAutoIdentify;
 329   QString _autoIdentifyService;
 330   QString _autoIdentifyPassword;
 331
 332   bool _useAutoReconnect;
 333   quint32 _autoReconnectInterval;
 334   quint16 _autoReconnectRetries;
 335   bool _unlimitedReconnectRetries;
 336   bool _rejoinChannels;
 337
 338   void determinePrefixes();
 339
 340   QTextCodec *_codecForServer;
 341   QTextCodec *_codecForEncoding;
 342   QTextCodec *_codecForDecoding;
 343
 344   static QTextCodec *_defaultCodecForServer;
 345   static QTextCodec *_defaultCodecForEncoding;
 346   static QTextCodec *_defaultCodecForDecoding;
 347
 348   bool _autoAwayActive; // when this is active handle305 and handle306 don't trigger any output
 349 };
 350
 351 //! Stores all editable information about a network (as opposed to runtime state).
 352 struct NetworkInfo {
 353   NetworkId networkId;
 354   QString networkName;
 355   IdentityId identity;
 356
 357   bool useCustomEncodings; // not used!
 358   QByteArray codecForServer;
 359   QByteArray codecForEncoding;
 360   QByteArray codecForDecoding;
 361
 362   // Server entry: QString "Host", uint "Port", QString "Password", bool "UseSSL"
 363   QVariantList serverList;
 364   bool useRandomServer;
 365
 366   QStringList perform;
 367
 368   bool useAutoIdentify;
 369   QString autoIdentifyService;
 370   QString autoIdentifyPassword;
 371
 372   bool useAutoReconnect;
 373   quint32 autoReconnectInterval;
 374   quint16 autoReconnectRetries;
 375   bool unlimitedReconnectRetries;
 376   bool rejoinChannels;
 377
 378   bool operator==(const NetworkInfo &other) const;
 379   bool operator!=(const NetworkInfo &other) const;
 380 };
 381
 382 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
 383 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
 384 QDebug operator<<(QDebug dbg, const NetworkInfo &i);
 385
 386 Q_DECLARE_METATYPE(NetworkInfo)
 387
 388 #endif