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