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(QString nick);
 142
 143   //init geters
 144   QVariantMap initSupports() const;
 145   QVariantList initServerList() const;
 146   QStringList initIrcUsers() const;
 147   QStringList initIrcChannels() const;
 148
 149   //init seters
 150   void initSetSupports(const QVariantMap &supports);
 151   void initSetServerList(const QVariantList &serverList);
 152   void initSetIrcUsers(const QStringList &hostmasks);
 153   void initSetChannels(const QStringList &channels);
 154
 155   IrcUser *updateNickFromMask(const QString &mask);
 156
 157   // these slots are to keep the hashlists of all users and the
 158   // channel lists up to date
 159   void ircUserNickChanged(QString newnick);
 160
 161   void requestConnect() const;
 162   void requestDisconnect() const;
 163
 164   void emitConnectionError(const QString &);
 165
 166 private slots:
 167   void ircUserDestroyed();
 168   void channelDestroyed();
 169   void removeIrcUser(IrcUser *ircuser);
 170   void ircUserInitDone();
 171   void ircChannelInitDone();
 172
 173 signals:
 174   void networkNameSet(const QString &networkName);
 175   void currentServerSet(const QString &currentServer);
 176   void connectedSet(bool isConnected);
 177   void connectionStateSet(Network::ConnectionState);
 178   void connectionStateSet(int);
 179   void connectionError(const QString &errorMsg);
 180   void myNickSet(const QString &mynick);
 181   void identitySet(IdentityId);
 182
 183   void serverListSet(QVariantList serverList);
 184
 185   void codecForEncodingSet(const QString &codecName);
 186   void codecForDecodingSet(const QString &codecName);
 187
 188   void supportAdded(const QString &param, const QString &value);
 189   void supportRemoved(const QString &param);
 190
 191   void ircUserAdded(const QString &hostmask);
 192   void ircUserAdded(IrcUser *);
 193   void ircChannelAdded(const QString &channelname);
 194   void ircChannelAdded(IrcChannel *);
 195
 196   void ircUserRemoved(const QString &nick);
 197
 198   // needed for client sync progress
 199   void ircUserRemoved(QObject *);
 200   void ircChannelRemoved(QObject *);
 201
 202   void ircUserInitDone(IrcUser *);
 203   void ircChannelInitDone(IrcChannel *);
 204
 205   void connectRequested(NetworkId id = 0) const;
 206   void disconnectRequested(NetworkId id = 0) const;
 207
 208 private:
 209   NetworkId _networkId;
 210   IdentityId _identity;
 211
 212   QString _myNick;
 213   QString _networkName;
 214   QString _currentServer;
 215   bool _connected;
 216   ConnectionState _connectionState;
 217
 218   QString _prefixes;
 219   QString _prefixModes;
 220
 221   QHash<QString, IrcUser *> _ircUsers;  // stores all known nicks for the server
 222   QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
 223   QHash<QString, QString> _supports;  // stores results from RPL_ISUPPORT
 224
 225   QVariantList _serverList;
 226   QStringList _perform;
 227   //QVariantMap networkSettings;
 228
 229   QPointer<SignalProxy> _proxy;
 230   void determinePrefixes();
 231
 232   QTextCodec *_codecForEncoding;
 233   QTextCodec *_codecForDecoding;
 234
 235 };
 236
 237 //! Stores all editable information about a network (as opposed to runtime state).
 238 struct NetworkInfo {
 239   NetworkId networkId;
 240   QString networkName;
 241   IdentityId identity;
 242
 243   bool useCustomEncodings;
 244   QByteArray codecForEncoding;
 245   QByteArray codecForDecoding;
 246
 247   // Server entry: QString "Host", uint "Port", QString "Password", bool "UseSSL"
 248   QVariantList serverList;
 249   bool useRandomServer;
 250
 251   QStringList perform;
 252
 253   bool useAutoIdentify;
 254   QString autoIdentifyService;
 255   QString autoIdentifyPassword;
 256
 257   bool useAutoReconnect;
 258   quint32 autoReconnectInterval;
 259   qint16 autoReconnectRetries;  // -1 => Unlimited
 260   bool rejoinChannels;
 261
 262   bool operator==(const NetworkInfo &other) const;
 263   bool operator!=(const NetworkInfo &other) const;
 264 };
 265
 266 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
 267 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
 268
 269 Q_DECLARE_METATYPE(NetworkInfo);
 270
 271 #endif