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
  59 public:
  60   enum ConnectionState { Disconnected, Connecting, Initializing, Initialized, Disconnecting };
  61
  62   Network(const NetworkId &networkid, QObject *parent = 0);
  63   ~Network();
  64
  65   NetworkId networkId() const;
  66
  67   SignalProxy *proxy() const;
  68   void setProxy(SignalProxy *proxy);
  69
  70   bool isMyNick(const QString &nick) const;
  71   bool isMe(IrcUser *ircuser) const;
  72
  73   bool isChannelName(const QString &channelname) const;
  74
  75   bool isConnected() const;
  76   //Network::ConnectionState connectionState() const;
  77   int connectionState() const;
  78
  79   QString prefixToMode(const QString &prefix);
  80   QString prefixToMode(const QCharRef &prefix);
  81   QString modeToPrefix(const QString &mode);
  82   QString modeToPrefix(const QCharRef &mode);
  83
  84   QString networkName() const;
  85   QString currentServer() const;
  86   QString myNick() const;
  87   IdentityId identity() const;
  88   QStringList nicks() const;
  89   QStringList channels() const;
  90   QVariantList serverList() const;
  91
  92   NetworkInfo networkInfo() const;
  93   void setNetworkInfo(const NetworkInfo &);
  94
  95   QString prefixes();
  96   QString prefixModes();
  97
  98   bool supports(const QString &param) const;
  99   QString support(const QString &param) const;
 100
 101   IrcUser *newIrcUser(const QString &hostmask);
 102   IrcUser *newIrcUser(const QByteArray &hostmask);
 103   IrcUser *ircUser(QString nickname) const;
 104   IrcUser *ircUser(const QByteArray &nickname) const;
 105   QList<IrcUser *> ircUsers() const;
 106   quint32 ircUserCount() const;
 107
 108   IrcChannel *newIrcChannel(const QString &channelname);
 109   IrcChannel *newIrcChannel(const QByteArray &channelname);
 110   IrcChannel *ircChannel(QString channelname) const;
 111   IrcChannel *ircChannel(const QByteArray &channelname) const;
 112   QList<IrcChannel *> ircChannels() const;
 113   quint32 ircChannelCount() const;
 114
 115   QByteArray codecForEncoding() const;
 116   QByteArray codecForDecoding() const;
 117   void setCodecForEncoding(QTextCodec *codec);
 118   void setCodecForDecoding(QTextCodec *codec);
 119
 120   QString decodeString(const QByteArray &text) const;
 121   QByteArray encodeString(const QString string) const;
 122
 123 public slots:
 124   void setNetworkName(const QString &networkName);
 125   void setCurrentServer(const QString &currentServer);
 126   void setConnected(bool isConnected);
 127   //void setConnectionState(Network::ConnectionState state);
 128   void setConnectionState(int state);
 129   void setMyNick(const QString &mynick);
 130   void setIdentity(IdentityId);
 131
 132   void setServerList(const QVariantList &serverList);
 133
 134   void setCodecForEncoding(const QByteArray &codecName);
 135   void setCodecForDecoding(const QByteArray &codecName);
 136
 137   void addSupport(const QString &param, const QString &value = QString());
 138   void removeSupport(const QString &param);
 139
 140   inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
 141   void removeIrcUser(const QString &nick);
 142   void removeIrcChannel(const QString &channel);
 143
 144   //init geters
 145   QVariantMap initSupports() const;
 146   QVariantList initServerList() const;
 147   QStringList initIrcUsers() const;
 148   QStringList initIrcChannels() const;
 149
 150   //init seters
 151   void initSetSupports(const QVariantMap &supports);
 152   void initSetServerList(const QVariantList &serverList);
 153   void initSetIrcUsers(const QStringList &hostmasks);
 154   void initSetChannels(const QStringList &channels);
 155
 156   IrcUser *updateNickFromMask(const QString &mask);
 157
 158   // these slots are to keep the hashlists of all users and the
 159   // channel lists up to date
 160   void ircUserNickChanged(QString newnick);
 161
 162   void requestConnect() const;
 163   void requestDisconnect() const;
 164
 165   void emitConnectionError(const QString &);
 166
 167 private slots:
 168   void channelDestroyed();
 169   void removeIrcUser(IrcUser *ircuser);
 170   void removeIrcChannel(IrcChannel *ircChannel);
 171   void removeChansAndUsers();
 172   void ircUserInitDone();
 173   void ircChannelInitDone();
 174
 175 signals:
 176   void networkNameSet(const QString &networkName);
 177   void currentServerSet(const QString &currentServer);
 178   void connectedSet(bool isConnected);
 179   void connectionStateSet(Network::ConnectionState);
 180   void connectionStateSet(int);
 181   void connectionError(const QString &errorMsg);
 182   void myNickSet(const QString &mynick);
 183   void identitySet(IdentityId);
 184
 185   void serverListSet(QVariantList serverList);
 186
 187   void codecForEncodingSet(const QString &codecName);
 188   void codecForDecodingSet(const QString &codecName);
 189
 190   void supportAdded(const QString &param, const QString &value);
 191   void supportRemoved(const QString &param);
 192
 193   void ircUserAdded(const QString &hostmask);
 194   void ircUserAdded(IrcUser *);
 195   void ircChannelAdded(const QString &channelname);
 196   void ircChannelAdded(IrcChannel *);
 197
 198   void ircUserRemoved(const QString &nick);
 199   void ircChannelRemoved(const QString &channel);
 200
 201   // needed for client sync progress
 202   void ircUserRemoved(QObject *);
 203   void ircChannelRemoved(QObject *);
 204
 205   void ircUserInitDone(IrcUser *);
 206   void ircChannelInitDone(IrcChannel *);
 207
 208   void connectRequested(NetworkId id = 0) const;
 209   void disconnectRequested(NetworkId id = 0) const;
 210
 211 private:
 212   NetworkId _networkId;
 213   IdentityId _identity;
 214
 215   QString _myNick;
 216   QString _networkName;
 217   QString _currentServer;
 218   bool _connected;
 219   ConnectionState _connectionState;
 220
 221   QString _prefixes;
 222   QString _prefixModes;
 223
 224   QHash<QString, IrcUser *> _ircUsers;  // stores all known nicks for the server
 225   QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
 226   QHash<QString, QString> _supports;  // stores results from RPL_ISUPPORT
 227
 228   QVariantList _serverList;
 229   QStringList _perform;
 230   //QVariantMap networkSettings;
 231
 232   QPointer<SignalProxy> _proxy;
 233   void determinePrefixes();
 234
 235   QTextCodec *_codecForEncoding;
 236   QTextCodec *_codecForDecoding;
 237
 238 };
 239
 240 //! Stores all editable information about a network (as opposed to runtime state).
 241 struct NetworkInfo {
 242   NetworkId networkId;
 243   QString networkName;
 244   IdentityId identity;
 245
 246   bool useCustomEncodings;
 247   QByteArray codecForEncoding;
 248   QByteArray codecForDecoding;
 249
 250   // Server entry: QString "Host", uint "Port", QString "Password", bool "UseSSL"
 251   QVariantList serverList;
 252   bool useRandomServer;
 253
 254   QStringList perform;
 255
 256   bool useAutoIdentify;
 257   QString autoIdentifyService;
 258   QString autoIdentifyPassword;
 259
 260   bool useAutoReconnect;
 261   quint32 autoReconnectInterval;
 262   qint16 autoReconnectRetries;  // -1 => Unlimited
 263   bool rejoinChannels;
 264
 265   bool operator==(const NetworkInfo &other) const;
 266   bool operator!=(const NetworkInfo &other) const;
 267 };
 268
 269 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
 270 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
 271
 272 Q_DECLARE_METATYPE(NetworkInfo);
 273
 274 #endif