src/common/network.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 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 <QNetworkProxy>
  28 #include <QHash>
  29 #include <QVariantMap>
  30 #include <QPointer>
  31 #include <QMutex>
  32
  33 #include "types.h"
  34 #include "util.h"
  35 #include "syncableobject.h"
  36
  37 #include "signalproxy.h"
  38 #include "ircuser.h"
  39 #include "ircchannel.h"
  40
  41 // defined below!
  42 struct NetworkInfo;
  43
  44 // TODO: ConnectionInfo to propagate and sync the current state of NetworkConnection, encodings etcpp
  45
  46 class Network : public SyncableObject {
  47   SYNCABLE_OBJECT
  48   Q_OBJECT
  49   Q_ENUMS(ConnectionState Network::ConnectionState)
  50
  51   Q_PROPERTY(QString networkName READ networkName WRITE setNetworkName STORED false)
  52   Q_PROPERTY(QString currentServer READ currentServer WRITE setCurrentServer STORED false)
  53   Q_PROPERTY(QString myNick READ myNick WRITE setMyNick STORED false)
  54   Q_PROPERTY(int latency READ latency WRITE setLatency STORED false)
  55   Q_PROPERTY(QByteArray codecForServer READ codecForServer WRITE setCodecForServer STORED false)
  56   Q_PROPERTY(QByteArray codecForEncoding READ codecForEncoding WRITE setCodecForEncoding STORED false)
  57   Q_PROPERTY(QByteArray codecForDecoding READ codecForDecoding WRITE setCodecForDecoding STORED false)
  58   Q_PROPERTY(IdentityId identityId READ identity WRITE setIdentity STORED false)
  59   Q_PROPERTY(bool isConnected READ isConnected WRITE setConnected STORED false)
  60   //Q_PROPERTY(Network::ConnectionState connectionState READ connectionState WRITE setConnectionState STORED false)
  61   Q_PROPERTY(int connectionState READ connectionState WRITE setConnectionState STORED false)
  62   Q_PROPERTY(bool useRandomServer READ useRandomServer WRITE setUseRandomServer STORED false)
  63   Q_PROPERTY(QStringList perform READ perform WRITE setPerform STORED false)
  64   Q_PROPERTY(bool useAutoIdentify READ useAutoIdentify WRITE setUseAutoIdentify STORED false)
  65   Q_PROPERTY(QString autoIdentifyService READ autoIdentifyService WRITE setAutoIdentifyService STORED false)
  66   Q_PROPERTY(QString autoIdentifyPassword READ autoIdentifyPassword WRITE setAutoIdentifyPassword STORED false)
  67   Q_PROPERTY(bool useSasl READ useSasl WRITE setUseSasl STORED false)
  68   Q_PROPERTY(QString saslAccount READ saslAccount WRITE setSaslAccount STORED false)
  69   Q_PROPERTY(QString saslPassword READ saslPassword WRITE setSaslPassword STORED false)
  70   Q_PROPERTY(bool useAutoReconnect READ useAutoReconnect WRITE setUseAutoReconnect STORED false)
  71   Q_PROPERTY(quint32 autoReconnectInterval READ autoReconnectInterval WRITE setAutoReconnectInterval STORED false)
  72   Q_PROPERTY(quint16 autoReconnectRetries READ autoReconnectRetries WRITE setAutoReconnectRetries STORED false)
  73   Q_PROPERTY(bool unlimitedReconnectRetries READ unlimitedReconnectRetries WRITE setUnlimitedReconnectRetries STORED false)
  74   Q_PROPERTY(bool rejoinChannels READ rejoinChannels WRITE setRejoinChannels STORED false)
  75
  76 public:
  77   enum ConnectionState {
  78     Disconnected,
  79     Connecting,
  80     Initializing,
  81     Initialized,
  82     Reconnecting,
  83     Disconnecting
  84   };
  85
  86   // see:
  87   //  http://www.irc.org/tech_docs/005.html
  88   //  http://www.irc.org/tech_docs/draft-brocklesby-irc-isupport-03.txt
  89   enum ChannelModeType {
  90     NOT_A_CHANMODE = 0x00,
  91     A_CHANMODE = 0x01,
  92     B_CHANMODE = 0x02,
  93     C_CHANMODE = 0x04,
  94     D_CHANMODE = 0x08
  95   };
  96
  97   struct Server {
  98     QString host;
  99     uint port;
 100     QString password;
 101     bool useSsl;
 102     int sslVersion;
 103
 104     bool useProxy;
 105     int proxyType;
 106     QString proxyHost;
 107     uint proxyPort;
 108     QString proxyUser;
 109     QString proxyPass;
 110
 111     Server() : port(6667), useSsl(false), sslVersion(0), useProxy(false), proxyType(QNetworkProxy::Socks5Proxy), proxyHost("localhost"), proxyPort(8080) {}
 112     Server(const QString &host, uint port, const QString &password, bool useSsl)
 113       : host(host), port(port), password(password), useSsl(useSsl), sslVersion(0),
 114         useProxy(false), proxyType(QNetworkProxy::Socks5Proxy), proxyHost("localhost"), proxyPort(8080) {}
 115     bool operator==(const Server &other) const;
 116     bool operator!=(const Server &other) const;
 117   };
 118   typedef QList<Server> ServerList;
 119
 120   Network(const NetworkId &networkid, QObject *parent = 0);
 121   ~Network();
 122
 123   inline NetworkId networkId() const { return _networkId; }
 124
 125   inline SignalProxy *proxy() const { return _proxy; }
 126   inline void setProxy(SignalProxy *proxy) { _proxy = proxy; }
 127
 128   inline bool isMyNick(const QString &nick) const { return (myNick().toLower() == nick.toLower()); }
 129   inline bool isMe(IrcUser *ircuser) const { return (ircuser->nick().toLower() == myNick().toLower()); }
 130
 131   bool isChannelName(const QString &channelname) const;
 132
 133   inline bool isConnected() const { return _connected; }
 134   //Network::ConnectionState connectionState() const;
 135   inline int connectionState() const { return _connectionState; }
 136
 137   QString prefixToMode(const QString &prefix);
 138   inline QString prefixToMode(const QCharRef &prefix) { return prefixToMode(QString(prefix)); }
 139   QString modeToPrefix(const QString &mode);
 140   inline QString modeToPrefix(const QCharRef &mode) { return modeToPrefix(QString(mode)); }
 141
 142   ChannelModeType channelModeType(const QString &mode);
 143   inline ChannelModeType channelModeType(const QCharRef &mode) { return channelModeType(QString(mode)); }
 144
 145   inline const QString &networkName() const { return _networkName; }
 146   inline const QString &currentServer() const { return _currentServer; }
 147   inline const QString &myNick() const { return _myNick; }
 148   inline int latency() const { return _latency; }
 149   inline IrcUser *me() const { return ircUser(myNick()); }
 150   inline IdentityId identity() const { return _identity; }
 151   QStringList nicks() const;
 152   inline QStringList channels() const { return _ircChannels.keys(); }
 153   inline const ServerList &serverList() const { return _serverList; }
 154   inline bool useRandomServer() const { return _useRandomServer; }
 155   inline const QStringList &perform() const { return _perform; }
 156   inline bool useAutoIdentify() const { return _useAutoIdentify; }
 157   inline const QString &autoIdentifyService() const { return _autoIdentifyService; }
 158   inline const QString &autoIdentifyPassword() const { return _autoIdentifyPassword; }
 159   inline bool useSasl() const { return _useSasl; }
 160   inline const QString &saslAccount() const { return _saslAccount; }
 161   inline const QString &saslPassword() const { return _saslPassword; }
 162   inline bool useAutoReconnect() const { return _useAutoReconnect; }
 163   inline quint32 autoReconnectInterval() const { return _autoReconnectInterval; }
 164   inline quint16 autoReconnectRetries() const { return _autoReconnectRetries; }
 165   inline bool unlimitedReconnectRetries() const { return _unlimitedReconnectRetries; }
 166   inline bool rejoinChannels() const { return _rejoinChannels; }
 167
 168   NetworkInfo networkInfo() const;
 169   void setNetworkInfo(const NetworkInfo &);
 170
 171   QString prefixes();
 172   QString prefixModes();
 173
 174   bool supports(const QString &param) const { return _supports.contains(param); }
 175   QString support(const QString &param) const;
 176
 177   IrcUser *newIrcUser(const QString &hostmask, const QVariantMap &initData = QVariantMap());
 178   inline IrcUser *newIrcUser(const QByteArray &hostmask) { return newIrcUser(decodeServerString(hostmask)); }
 179   IrcUser *ircUser(QString nickname) const;
 180   inline IrcUser *ircUser(const QByteArray &nickname) const { return ircUser(decodeServerString(nickname)); }
 181   inline QList<IrcUser *> ircUsers() const { return _ircUsers.values(); }
 182   inline quint32 ircUserCount() const { return _ircUsers.count(); }
 183
 184   IrcChannel *newIrcChannel(const QString &channelname, const QVariantMap &initData = QVariantMap());
 185   inline IrcChannel *newIrcChannel(const QByteArray &channelname) { return newIrcChannel(decodeServerString(channelname)); }
 186   IrcChannel *ircChannel(QString channelname) const;
 187   inline IrcChannel *ircChannel(const QByteArray &channelname) const { return ircChannel(decodeServerString(channelname)); }
 188   inline QList<IrcChannel *> ircChannels() const { return _ircChannels.values(); }
 189   inline quint32 ircChannelCount() const { return _ircChannels.count(); }
 190
 191   QByteArray codecForServer() const;
 192   QByteArray codecForEncoding() const;
 193   QByteArray codecForDecoding() const;
 194   void setCodecForServer(QTextCodec *codec);
 195   void setCodecForEncoding(QTextCodec *codec);
 196   void setCodecForDecoding(QTextCodec *codec);
 197
 198   QString decodeString(const QByteArray &text) const;
 199   QByteArray encodeString(const QString &string) const;
 200   QString decodeServerString(const QByteArray &text) const;
 201   QByteArray encodeServerString(const QString &string) const;
 202
 203   static QByteArray defaultCodecForServer();
 204   static QByteArray defaultCodecForEncoding();
 205   static QByteArray defaultCodecForDecoding();
 206   static void setDefaultCodecForServer(const QByteArray &name);
 207   static void setDefaultCodecForEncoding(const QByteArray &name);
 208   static void setDefaultCodecForDecoding(const QByteArray &name);
 209
 210   inline bool autoAwayActive() const { return _autoAwayActive; }
 211   inline void setAutoAwayActive(bool active) { _autoAwayActive = active; }
 212
 213   static QStringList presetNetworks(bool onlyDefault = false);
 214   static QStringList presetDefaultChannels(const QString &networkName);
 215   static NetworkInfo networkInfoFromPreset(const QString &networkName);
 216
 217 public slots:
 218   void setNetworkName(const QString &networkName);
 219   void setCurrentServer(const QString &currentServer);
 220   void setConnected(bool isConnected);
 221   void setConnectionState(int state);
 222   virtual void setMyNick(const QString &mynick);
 223   void setLatency(int latency);
 224   void setIdentity(IdentityId);
 225
 226   void setServerList(const QVariantList &serverList);
 227   void setUseRandomServer(bool);
 228   void setPerform(const QStringList &);
 229   void setUseAutoIdentify(bool);
 230   void setAutoIdentifyService(const QString &);
 231   void setAutoIdentifyPassword(const QString &);
 232   void setUseSasl(bool);
 233   void setSaslAccount(const QString &);
 234   void setSaslPassword(const QString &);
 235   virtual void setUseAutoReconnect(bool);
 236   virtual void setAutoReconnectInterval(quint32);
 237   virtual void setAutoReconnectRetries(quint16);
 238   void setUnlimitedReconnectRetries(bool);
 239   void setRejoinChannels(bool);
 240
 241   void setCodecForServer(const QByteArray &codecName);
 242   void setCodecForEncoding(const QByteArray &codecName);
 243   void setCodecForDecoding(const QByteArray &codecName);
 244
 245   void addSupport(const QString &param, const QString &value = QString());
 246   void removeSupport(const QString &param);
 247
 248   inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
 249   inline void addIrcChannel(const QString &channel) { newIrcChannel(channel); }
 250
 251   //init geters
 252   QVariantMap initSupports() const;
 253   inline QVariantList initServerList() const { return toVariantList(serverList()); }
 254   virtual QVariantMap initIrcUsersAndChannels() const;
 255
 256   //init seters
 257   void initSetSupports(const QVariantMap &supports);
 258   inline void initSetServerList(const QVariantList &serverList) { _serverList = fromVariantList<Server>(serverList); }
 259   virtual void initSetIrcUsersAndChannels(const QVariantMap &usersAndChannels);
 260
 261   IrcUser *updateNickFromMask(const QString &mask);
 262
 263   // these slots are to keep the hashlists of all users and the
 264   // channel lists up to date
 265   void ircUserNickChanged(QString newnick);
 266
 267   virtual inline void requestConnect() const { REQUEST(NO_ARG) }
 268   virtual inline void requestDisconnect() const { REQUEST(NO_ARG) }
 269   virtual inline void requestSetNetworkInfo(const NetworkInfo &info) { REQUEST(ARG(info)) }
 270
 271   void emitConnectionError(const QString &);
 272
 273 private slots:
 274   void removeIrcUser(IrcUser *ircuser);
 275   void removeIrcChannel(IrcChannel *ircChannel);
 276   void removeChansAndUsers();
 277
 278 signals:
 279   void aboutToBeDestroyed();
 280   void networkNameSet(const QString &networkName);
 281   void currentServerSet(const QString &currentServer);
 282   void connectedSet(bool isConnected);
 283   void connectionStateSet(Network::ConnectionState);
 284 //   void connectionStateSet(int);
 285   void connectionError(const QString &errorMsg);
 286   void myNickSet(const QString &mynick);
 287 //   void latencySet(int latency);
 288   void identitySet(IdentityId);
 289
 290   void configChanged();
 291
 292   //   void serverListSet(QVariantList serverList);
 293 //   void useRandomServerSet(bool);
 294 //   void performSet(const QStringList &);
 295 //   void useAutoIdentifySet(bool);
 296 //   void autoIdentifyServiceSet(const QString &);
 297 //   void autoIdentifyPasswordSet(const QString &);
 298 //   void useAutoReconnectSet(bool);
 299 //   void autoReconnectIntervalSet(quint32);
 300 //   void autoReconnectRetriesSet(quint16);
 301 //   void unlimitedReconnectRetriesSet(bool);
 302 //   void rejoinChannelsSet(bool);
 303
 304 //   void codecForServerSet(const QByteArray &codecName);
 305 //   void codecForEncodingSet(const QByteArray &codecName);
 306 //   void codecForDecodingSet(const QByteArray &codecName);
 307
 308 //   void supportAdded(const QString &param, const QString &value);
 309 //   void supportRemoved(const QString &param);
 310
 311 //   void ircUserAdded(const QString &hostmask);
 312   void ircUserAdded(IrcUser *);
 313 //   void ircChannelAdded(const QString &channelname);
 314   void ircChannelAdded(IrcChannel *);
 315
 316 //   void connectRequested() const;
 317 //   void disconnectRequested() const;
 318 //   void setNetworkInfoRequested(const NetworkInfo &) const;
 319
 320 protected:
 321   inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new IrcChannel(channelname, this); }
 322
 323 private:
 324   QPointer<SignalProxy> _proxy;
 325
 326   NetworkId _networkId;
 327   IdentityId _identity;
 328
 329   QString _myNick;
 330   int _latency;
 331   QString _networkName;
 332   QString _currentServer;
 333   bool _connected;
 334   ConnectionState _connectionState;
 335
 336   QString _prefixes;
 337   QString _prefixModes;
 338
 339   QHash<QString, IrcUser *> _ircUsers;  // stores all known nicks for the server
 340   QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
 341   QHash<QString, QString> _supports;  // stores results from RPL_ISUPPORT
 342
 343   ServerList _serverList;
 344   bool _useRandomServer;
 345   QStringList _perform;
 346
 347   bool _useAutoIdentify;
 348   QString _autoIdentifyService;
 349   QString _autoIdentifyPassword;
 350
 351   bool _useSasl;
 352   QString _saslAccount;
 353   QString _saslPassword;
 354
 355   bool _useAutoReconnect;
 356   quint32 _autoReconnectInterval;
 357   quint16 _autoReconnectRetries;
 358   bool _unlimitedReconnectRetries;
 359   bool _rejoinChannels;
 360
 361   void determinePrefixes();
 362
 363   QTextCodec *_codecForServer;
 364   QTextCodec *_codecForEncoding;
 365   QTextCodec *_codecForDecoding;
 366
 367   static QTextCodec *_defaultCodecForServer;
 368   static QTextCodec *_defaultCodecForEncoding;
 369   static QTextCodec *_defaultCodecForDecoding;
 370
 371   bool _autoAwayActive; // when this is active handle305 and handle306 don't trigger any output
 372
 373   static QString _networksIniPath;
 374
 375   friend class IrcUser;
 376   friend class IrcChannel;
 377 };
 378
 379 //! Stores all editable information about a network (as opposed to runtime state).
 380 struct NetworkInfo {
 381   // set some default values, note that this does not initialize e.g. name and id
 382   NetworkInfo();
 383
 384   NetworkId networkId;
 385   QString networkName;
 386   IdentityId identity;
 387
 388   bool useCustomEncodings; // not used!
 389   QByteArray codecForServer;
 390   QByteArray codecForEncoding;
 391   QByteArray codecForDecoding;
 392
 393   Network::ServerList serverList;
 394   bool useRandomServer;
 395
 396   QStringList perform;
 397
 398   bool useAutoIdentify;
 399   QString autoIdentifyService;
 400   QString autoIdentifyPassword;
 401
 402   bool useSasl;
 403   QString saslAccount;
 404   QString saslPassword;
 405
 406   bool useAutoReconnect;
 407   quint32 autoReconnectInterval;
 408   quint16 autoReconnectRetries;
 409   bool unlimitedReconnectRetries;
 410   bool rejoinChannels;
 411
 412   bool operator==(const NetworkInfo &other) const;
 413   bool operator!=(const NetworkInfo &other) const;
 414 };
 415
 416 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
 417 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
 418 QDebug operator<<(QDebug dbg, const NetworkInfo &i);
 419 Q_DECLARE_METATYPE(NetworkInfo)
 420
 421 QDataStream &operator<<(QDataStream &out, const Network::Server &server);
 422 QDataStream &operator>>(QDataStream &in, Network::Server &server);
 423 QDebug operator<<(QDebug dbg, const Network::Server &server);
 424 Q_DECLARE_METATYPE(Network::Server)
 425
 426 #endif