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 <QDebug>
  25 #include <QString>
  26 #include <QStringList>
  27 #include <QList>
  28 #include <QHash>
  29 #include <QVariantMap>
  30 #include <QPointer>
  31 #include <QMutex>
  32
  33 #include "types.h"
  34 #include "syncableobject.h"
  35
  36 class SignalProxy;
  37 class IrcUser;
  38 class IrcChannel;
  39
  40 // defined below!
  41 struct NetworkInfo;
  42
  43 // TODO: ConnectionInfo to propagate and sync the current state of NetworkConnection, encodings etcpp
  44
  45 class Network : public SyncableObject {
  46   Q_OBJECT
  47   Q_ENUMS(ConnectionState Network::ConnectionState)
  48
  49   Q_PROPERTY(QString networkName READ networkName WRITE setNetworkName STORED false)
  50   Q_PROPERTY(QString currentServer READ currentServer WRITE setCurrentServer STORED false)
  51   Q_PROPERTY(QString myNick READ myNick WRITE setMyNick 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(qint16 autoReconnectRetries READ autoReconnectRetries WRITE setAutoReconnectRetries STORED false)
  66   Q_PROPERTY(bool rejoinChannels READ rejoinChannels WRITE setRejoinChannels STORED false)
  67
  68 public:
  69   enum ConnectionState { Disconnected, Connecting, Initializing, Initialized, Disconnecting };
  70
  71   Network(const NetworkId &networkid, QObject *parent = 0);
  72   ~Network();
  73
  74   NetworkId networkId() const;
  75
  76   SignalProxy *proxy() const;
  77   void setProxy(SignalProxy *proxy);
  78
  79   bool isMyNick(const QString &nick) const;
  80   bool isMe(IrcUser *ircuser) const;
  81
  82   bool isChannelName(const QString &channelname) const;
  83
  84   bool isConnected() const;
  85   //Network::ConnectionState connectionState() const;
  86   int connectionState() const;
  87
  88   QString prefixToMode(const QString &prefix);
  89   QString prefixToMode(const QCharRef &prefix);
  90   QString modeToPrefix(const QString &mode);
  91   QString modeToPrefix(const QCharRef &mode);
  92
  93   QString networkName() const;
  94   QString currentServer() const;
  95   QString myNick() const;
  96   IdentityId identity() const;
  97   QStringList nicks() const;
  98   QStringList channels() const;
  99   QVariantList serverList() const;
 100   bool useRandomServer() const;
 101   QStringList perform() const;
 102   bool useAutoIdentify() const;
 103   QString autoIdentifyService() const;
 104   QString autoIdentifyPassword() const;
 105   bool useAutoReconnect() const;
 106   quint32 autoReconnectInterval() const;
 107   qint16 autoReconnectRetries() const;  // -1 => unlimited
 108   bool rejoinChannels() const;
 109
 110   NetworkInfo networkInfo() const;
 111   void setNetworkInfo(const NetworkInfo &);
 112
 113   QString prefixes();
 114   QString prefixModes();
 115
 116   bool supports(const QString &param) const;
 117   QString support(const QString &param) const;
 118
 119   IrcUser *newIrcUser(const QString &hostmask);
 120   IrcUser *newIrcUser(const QByteArray &hostmask);
 121   IrcUser *ircUser(QString nickname) const;
 122   IrcUser *ircUser(const QByteArray &nickname) const;
 123   QList<IrcUser *> ircUsers() const;
 124   quint32 ircUserCount() const;
 125
 126   IrcChannel *newIrcChannel(const QString &channelname);
 127   IrcChannel *newIrcChannel(const QByteArray &channelname);
 128   IrcChannel *ircChannel(QString channelname) const;
 129   IrcChannel *ircChannel(const QByteArray &channelname) const;
 130   QList<IrcChannel *> ircChannels() const;
 131   quint32 ircChannelCount() const;
 132
 133   QByteArray codecForEncoding() const;
 134   QByteArray codecForDecoding() const;
 135   void setCodecForEncoding(QTextCodec *codec);
 136   void setCodecForDecoding(QTextCodec *codec);
 137
 138   QString decodeString(const QByteArray &text) const;
 139   QByteArray encodeString(const QString string) const;
 140
 141   static QByteArray defaultCodecForEncoding();
 142   static QByteArray defaultCodecForDecoding();
 143   static void setDefaultCodecForEncoding(const QByteArray &name);
 144   static void setDefaultCodecForDecoding(const QByteArray &name);
 145
 146 public slots:
 147   void setNetworkName(const QString &networkName);
 148   void setCurrentServer(const QString &currentServer);
 149   void setConnected(bool isConnected);
 150   //void setConnectionState(Network::ConnectionState state);
 151   void setConnectionState(int state);
 152   void setMyNick(const QString &mynick);
 153   void setIdentity(IdentityId);
 154
 155   void setServerList(const QVariantList &serverList);
 156   void setUseRandomServer(bool);
 157   void setPerform(const QStringList &);
 158   void setUseAutoIdentify(bool);
 159   void setAutoIdentifyService(const QString &);
 160   void setAutoIdentifyPassword(const QString &);
 161   void setUseAutoReconnect(bool);
 162   void setAutoReconnectInterval(quint32);
 163   void setAutoReconnectRetries(qint16);
 164   void setRejoinChannels(bool);
 165
 166   void setCodecForEncoding(const QByteArray &codecName);
 167   void setCodecForDecoding(const QByteArray &codecName);
 168
 169   void addSupport(const QString &param, const QString &value = QString());
 170   void removeSupport(const QString &param);
 171
 172   inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
 173   void removeIrcUser(const QString &nick);
 174   void removeIrcChannel(const QString &channel);
 175
 176   //init geters
 177   QVariantMap initSupports() const;
 178   QVariantList initServerList() const;
 179   QStringList initIrcUsers() const;
 180   QStringList initIrcChannels() const;
 181
 182   //init seters
 183   void initSetSupports(const QVariantMap &supports);
 184   void initSetServerList(const QVariantList &serverList);
 185   void initSetIrcUsers(const QStringList &hostmasks);
 186   void initSetChannels(const QStringList &channels);
 187
 188   IrcUser *updateNickFromMask(const QString &mask);
 189
 190   // these slots are to keep the hashlists of all users and the
 191   // channel lists up to date
 192   void ircUserNickChanged(QString newnick);
 193
 194   void requestConnect() const;
 195   void requestDisconnect() const;
 196
 197   void emitConnectionError(const QString &);
 198
 199 private slots:
 200   void channelDestroyed();
 201   void removeIrcUser(IrcUser *ircuser);
 202   void removeIrcChannel(IrcChannel *ircChannel);
 203   void removeChansAndUsers();
 204   void ircUserInitDone();
 205   void ircChannelInitDone();
 206
 207 signals:
 208   void aboutToBeDestroyed();
 209   void networkNameSet(const QString &networkName);
 210   void currentServerSet(const QString &currentServer);
 211   void connectedSet(bool isConnected);
 212   void connectionStateSet(Network::ConnectionState);
 213   void connectionStateSet(int);
 214   void connectionError(const QString &errorMsg);
 215   void myNickSet(const QString &mynick);
 216   void identitySet(IdentityId);
 217
 218   void serverListSet(QVariantList serverList);
 219   void useRandomServerSet(bool);
 220   void performSet(const QStringList &);
 221   void useAutoIdentifySet(bool);
 222   void autoIdentifyServiceSet(const QString &);
 223   void autoIdentifyPasswordSet(const QString &);
 224   void useAutoReconnectSet(bool);
 225   void autoReconnectIntervalSet(quint32);
 226   void autoReconnectRetriesSet(qint16);
 227   void rejoinChannelsSet(bool);
 228
 229   void codecForEncodingSet(const QByteArray &codecName);
 230   void codecForDecodingSet(const QByteArray &codecName);
 231
 232   void supportAdded(const QString &param, const QString &value);
 233   void supportRemoved(const QString &param);
 234
 235   void ircUserAdded(const QString &hostmask);
 236   void ircUserAdded(IrcUser *);
 237   void ircChannelAdded(const QString &channelname);
 238   void ircChannelAdded(IrcChannel *);
 239
 240   void ircUserRemoved(const QString &nick);
 241   void ircChannelRemoved(const QString &channel);
 242
 243   // needed for client sync progress
 244   void ircUserRemoved(QObject *);
 245   void ircChannelRemoved(QObject *);
 246
 247   void ircUserInitDone(IrcUser *);
 248   void ircChannelInitDone(IrcChannel *);
 249
 250   void connectRequested(NetworkId id = 0) const;
 251   void disconnectRequested(NetworkId id = 0) const;
 252
 253 private:
 254   NetworkId _networkId;
 255   IdentityId _identity;
 256
 257   QString _myNick;
 258   QString _networkName;
 259   QString _currentServer;
 260   bool _connected;
 261   ConnectionState _connectionState;
 262
 263   QString _prefixes;
 264   QString _prefixModes;
 265
 266   QHash<QString, IrcUser *> _ircUsers;  // stores all known nicks for the server
 267   QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
 268   QHash<QString, QString> _supports;  // stores results from RPL_ISUPPORT
 269
 270   QVariantList _serverList;
 271   bool _useRandomServer;
 272   QStringList _perform;
 273
 274   bool _useAutoIdentify;
 275   QString _autoIdentifyService;
 276   QString _autoIdentifyPassword;
 277
 278   bool _useAutoReconnect;
 279   quint32 _autoReconnectInterval;
 280   qint16 _autoReconnectRetries;
 281   bool _rejoinChannels;
 282
 283   QPointer<SignalProxy> _proxy;
 284   void determinePrefixes();
 285
 286   QTextCodec *_codecForEncoding;
 287   QTextCodec *_codecForDecoding;
 288
 289   static QTextCodec *_defaultCodecForEncoding;
 290   static QTextCodec *_defaultCodecForDecoding;
 291 };
 292
 293 //! Stores all editable information about a network (as opposed to runtime state).
 294 struct NetworkInfo {
 295   NetworkId networkId;
 296   QString networkName;
 297   IdentityId identity;
 298
 299   bool useCustomEncodings;
 300   QByteArray codecForEncoding;
 301   QByteArray codecForDecoding;
 302
 303   // Server entry: QString "Host", uint "Port", QString "Password", bool "UseSSL"
 304   QVariantList serverList;
 305   bool useRandomServer;
 306
 307   QStringList perform;
 308
 309   bool useAutoIdentify;
 310   QString autoIdentifyService;
 311   QString autoIdentifyPassword;
 312
 313   bool useAutoReconnect;
 314   quint32 autoReconnectInterval;
 315   qint16 autoReconnectRetries;  // -1 => Unlimited
 316   bool rejoinChannels;
 317
 318   bool operator==(const NetworkInfo &other) const;
 319   bool operator!=(const NetworkInfo &other) const;
 320 };
 321
 322 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
 323 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
 324
 325 Q_DECLARE_METATYPE(NetworkInfo);
 326
 327 #endif