Force parsing of PREFIX in RPL_ISUPPORT. Fixes #936
[quassel.git] / src / common / network.h
index 3759e56..236269a 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel Project                          *
+ *   Copyright (C) 2005-2010 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 
-#ifndef NETWORK_H_
-#define NETWORK_H_
+#ifndef NETWORK_H
+#define NETWORK_H
 
 #include <QString>
 #include <QStringList>
 #include <QList>
+#include <QNetworkProxy>
 #include <QHash>
 #include <QVariantMap>
 #include <QPointer>
 #include <QMutex>
+#include <QByteArray>
 
 #include "types.h"
+#include "util.h"
 #include "syncableobject.h"
 
 #include "signalproxy.h"
@@ -42,12 +45,14 @@ struct NetworkInfo;
 // TODO: ConnectionInfo to propagate and sync the current state of NetworkConnection, encodings etcpp
 
 class Network : public SyncableObject {
+  SYNCABLE_OBJECT
   Q_OBJECT
   Q_ENUMS(ConnectionState Network::ConnectionState)
 
   Q_PROPERTY(QString networkName READ networkName WRITE setNetworkName STORED false)
   Q_PROPERTY(QString currentServer READ currentServer WRITE setCurrentServer STORED false)
   Q_PROPERTY(QString myNick READ myNick WRITE setMyNick STORED false)
+  Q_PROPERTY(int latency READ latency WRITE setLatency STORED false)
   Q_PROPERTY(QByteArray codecForServer READ codecForServer WRITE setCodecForServer STORED false)
   Q_PROPERTY(QByteArray codecForEncoding READ codecForEncoding WRITE setCodecForEncoding STORED false)
   Q_PROPERTY(QByteArray codecForDecoding READ codecForDecoding WRITE setCodecForDecoding STORED false)
@@ -60,6 +65,9 @@ class Network : public SyncableObject {
   Q_PROPERTY(bool useAutoIdentify READ useAutoIdentify WRITE setUseAutoIdentify STORED false)
   Q_PROPERTY(QString autoIdentifyService READ autoIdentifyService WRITE setAutoIdentifyService STORED false)
   Q_PROPERTY(QString autoIdentifyPassword READ autoIdentifyPassword WRITE setAutoIdentifyPassword STORED false)
+  Q_PROPERTY(bool useSasl READ useSasl WRITE setUseSasl STORED false)
+  Q_PROPERTY(QString saslAccount READ saslAccount WRITE setSaslAccount STORED false)
+  Q_PROPERTY(QString saslPassword READ saslPassword WRITE setSaslPassword STORED false)
   Q_PROPERTY(bool useAutoReconnect READ useAutoReconnect WRITE setUseAutoReconnect STORED false)
   Q_PROPERTY(quint32 autoReconnectInterval READ autoReconnectInterval WRITE setAutoReconnectInterval STORED false)
   Q_PROPERTY(quint16 autoReconnectRetries READ autoReconnectRetries WRITE setAutoReconnectRetries STORED false)
@@ -87,7 +95,29 @@ public:
     D_CHANMODE = 0x08
   };
 
-  
+  struct Server {
+    QString host;
+    uint port;
+    QString password;
+    bool useSsl;
+    int sslVersion;
+
+    bool useProxy;
+    int proxyType;
+    QString proxyHost;
+    uint proxyPort;
+    QString proxyUser;
+    QString proxyPass;
+
+    Server() : port(6667), useSsl(false), sslVersion(0), useProxy(false), proxyType(QNetworkProxy::Socks5Proxy), proxyHost("localhost"), proxyPort(8080) {}
+    Server(const QString &host, uint port, const QString &password, bool useSsl)
+      : host(host), port(port), password(password), useSsl(useSsl), sslVersion(0),
+        useProxy(false), proxyType(QNetworkProxy::Socks5Proxy), proxyHost("localhost"), proxyPort(8080) {}
+    bool operator==(const Server &other) const;
+    bool operator!=(const Server &other) const;
+  };
+  typedef QList<Server> ServerList;
+
   Network(const NetworkId &networkid, QObject *parent = 0);
   ~Network();
 
@@ -112,20 +142,24 @@ public:
 
   ChannelModeType channelModeType(const QString &mode);
   inline ChannelModeType channelModeType(const QCharRef &mode) { return channelModeType(QString(mode)); }
-  
+
   inline const QString &networkName() const { return _networkName; }
   inline const QString &currentServer() const { return _currentServer; }
   inline const QString &myNick() const { return _myNick; }
+  inline int latency() const { return _latency; }
   inline IrcUser *me() const { return ircUser(myNick()); }
   inline IdentityId identity() const { return _identity; }
   QStringList nicks() const;
   inline QStringList channels() const { return _ircChannels.keys(); }
-  inline const QVariantList &serverList() const { return _serverList; }
+  inline const ServerList &serverList() const { return _serverList; }
   inline bool useRandomServer() const { return _useRandomServer; }
   inline const QStringList &perform() const { return _perform; }
   inline bool useAutoIdentify() const { return _useAutoIdentify; }
   inline const QString &autoIdentifyService() const { return _autoIdentifyService; }
   inline const QString &autoIdentifyPassword() const { return _autoIdentifyPassword; }
+  inline bool useSasl() const { return _useSasl; }
+  inline const QString &saslAccount() const { return _saslAccount; }
+  inline const QString &saslPassword() const { return _saslPassword; }
   inline bool useAutoReconnect() const { return _useAutoReconnect; }
   inline quint32 autoReconnectInterval() const { return _autoReconnectInterval; }
   inline quint16 autoReconnectRetries() const { return _autoReconnectRetries; }
@@ -137,18 +171,19 @@ public:
 
   QString prefixes();
   QString prefixModes();
+  void determinePrefixes();
 
   bool supports(const QString &param) const { return _supports.contains(param); }
   QString support(const QString &param) const;
 
-  IrcUser *newIrcUser(const QString &hostmask);
+  IrcUser *newIrcUser(const QString &hostmask, const QVariantMap &initData = QVariantMap());
   inline IrcUser *newIrcUser(const QByteArray &hostmask) { return newIrcUser(decodeServerString(hostmask)); }
   IrcUser *ircUser(QString nickname) const;
   inline IrcUser *ircUser(const QByteArray &nickname) const { return ircUser(decodeServerString(nickname)); }
   inline QList<IrcUser *> ircUsers() const { return _ircUsers.values(); }
   inline quint32 ircUserCount() const { return _ircUsers.count(); }
 
-  IrcChannel *newIrcChannel(const QString &channelname);
+  IrcChannel *newIrcChannel(const QString &channelname, const QVariantMap &initData = QVariantMap());
   inline IrcChannel *newIrcChannel(const QByteArray &channelname) { return newIrcChannel(decodeServerString(channelname)); }
   IrcChannel *ircChannel(QString channelname) const;
   inline IrcChannel *ircChannel(const QByteArray &channelname) const { return ircChannel(decodeServerString(channelname)); }
@@ -174,13 +209,20 @@ public:
   static void setDefaultCodecForEncoding(const QByteArray &name);
   static void setDefaultCodecForDecoding(const QByteArray &name);
 
+  inline bool autoAwayActive() const { return _autoAwayActive; }
+  inline void setAutoAwayActive(bool active) { _autoAwayActive = active; }
+
+  static QStringList presetNetworks(bool onlyDefault = false);
+  static QStringList presetDefaultChannels(const QString &networkName);
+  static NetworkInfo networkInfoFromPreset(const QString &networkName);
+
 public slots:
   void setNetworkName(const QString &networkName);
   void setCurrentServer(const QString &currentServer);
   void setConnected(bool isConnected);
-  //void setConnectionState(Network::ConnectionState state);
   void setConnectionState(int state);
-  void setMyNick(const QString &mynick);
+  virtual void setMyNick(const QString &mynick);
+  void setLatency(int latency);
   void setIdentity(IdentityId);
 
   void setServerList(const QVariantList &serverList);
@@ -189,9 +231,12 @@ public slots:
   void setUseAutoIdentify(bool);
   void setAutoIdentifyService(const QString &);
   void setAutoIdentifyPassword(const QString &);
-  void setUseAutoReconnect(bool);
-  void setAutoReconnectInterval(quint32);
-  void setAutoReconnectRetries(quint16);
+  void setUseSasl(bool);
+  void setSaslAccount(const QString &);
+  void setSaslPassword(const QString &);
+  virtual void setUseAutoReconnect(bool);
+  virtual void setAutoReconnectInterval(quint32);
+  virtual void setAutoReconnectRetries(quint16);
   void setUnlimitedReconnectRetries(bool);
   void setRejoinChannels(bool);
 
@@ -204,40 +249,33 @@ public slots:
 
   inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
   inline void addIrcChannel(const QString &channel) { newIrcChannel(channel); }
-  void removeIrcUser(const QString &nick);
-  void removeIrcChannel(const QString &channel);
 
   //init geters
   QVariantMap initSupports() const;
-  inline QVariantList initServerList() const { return serverList(); }
-  QStringList initIrcUsers() const;
-  QStringList initIrcChannels() const;
-  
+  inline QVariantList initServerList() const { return toVariantList(serverList()); }
+  virtual QVariantMap initIrcUsersAndChannels() const;
+
   //init seters
   void initSetSupports(const QVariantMap &supports);
-  inline void initSetServerList(const QVariantList &serverList) { setServerList(serverList); }
-  void initSetIrcUsers(const QStringList &hostmasks);
-  void initSetIrcChannels(const QStringList &channels);
-  
+  inline void initSetServerList(const QVariantList &serverList) { _serverList = fromVariantList<Server>(serverList); }
+  virtual void initSetIrcUsersAndChannels(const QVariantMap &usersAndChannels);
+
   IrcUser *updateNickFromMask(const QString &mask);
 
   // these slots are to keep the hashlists of all users and the
   // channel lists up to date
   void ircUserNickChanged(QString newnick);
 
-  virtual inline void requestConnect() const { emit connectRequested(); }
-  virtual inline void requestDisconnect() const { emit disconnectRequested(); }
+  virtual inline void requestConnect() const { REQUEST(NO_ARG) }
+  virtual inline void requestDisconnect() const { REQUEST(NO_ARG) }
+  virtual inline void requestSetNetworkInfo(const NetworkInfo &info) { REQUEST(ARG(info)) }
 
   void emitConnectionError(const QString &);
 
-private slots:
-  void ircUserDestroyed();
-  void channelDestroyed();
-  void removeIrcUser(IrcUser *ircuser);
-  void removeIrcChannel(IrcChannel *ircChannel);
-  void removeChansAndUsers();
-  void ircUserInitDone();
-  void ircChannelInitDone();
+protected slots:
+  virtual void removeIrcUser(IrcUser *ircuser);
+  virtual void removeIrcChannel(IrcChannel *ircChannel);
+  virtual void removeChansAndUsers();
 
 signals:
   void aboutToBeDestroyed();
@@ -245,47 +283,45 @@ signals:
   void currentServerSet(const QString &currentServer);
   void connectedSet(bool isConnected);
   void connectionStateSet(Network::ConnectionState);
-  void connectionStateSet(int);
+//   void connectionStateSet(int);
   void connectionError(const QString &errorMsg);
   void myNickSet(const QString &mynick);
+//   void latencySet(int latency);
   void identitySet(IdentityId);
 
-  void serverListSet(QVariantList serverList);
-  void useRandomServerSet(bool);
-  void performSet(const QStringList &);
-  void useAutoIdentifySet(bool);
-  void autoIdentifyServiceSet(const QString &);
-  void autoIdentifyPasswordSet(const QString &);
-  void useAutoReconnectSet(bool);
-  void autoReconnectIntervalSet(quint32);
-  void autoReconnectRetriesSet(quint16);
-  void unlimitedReconnectRetriesSet(bool);
-  void rejoinChannelsSet(bool);
-
-  void codecForServerSet(const QByteArray &codecName);
-  void codecForEncodingSet(const QByteArray &codecName);
-  void codecForDecodingSet(const QByteArray &codecName);
-
-  void supportAdded(const QString &param, const QString &value);
-  void supportRemoved(const QString &param);
-
-  void ircUserAdded(const QString &hostmask);
-  void ircUserAdded(IrcUser *);
-  void ircChannelAdded(const QString &channelname);
-  void ircChannelAdded(IrcChannel *);
+  void configChanged();
+
+  //   void serverListSet(QVariantList serverList);
+//   void useRandomServerSet(bool);
+//   void performSet(const QStringList &);
+//   void useAutoIdentifySet(bool);
+//   void autoIdentifyServiceSet(const QString &);
+//   void autoIdentifyPasswordSet(const QString &);
+//   void useAutoReconnectSet(bool);
+//   void autoReconnectIntervalSet(quint32);
+//   void autoReconnectRetriesSet(quint16);
+//   void unlimitedReconnectRetriesSet(bool);
+//   void rejoinChannelsSet(bool);
 
-  void ircUserRemoved(const QString &nick);
-  void ircChannelRemoved(const QString &channel);
+//   void codecForServerSet(const QByteArray &codecName);
+//   void codecForEncodingSet(const QByteArray &codecName);
+//   void codecForDecodingSet(const QByteArray &codecName);
 
-  // needed for client sync progress
-  void ircUserRemoved(QObject *);
-  void ircChannelRemoved(QObject *);
+//   void supportAdded(const QString &param, const QString &value);
+//   void supportRemoved(const QString &param);
 
-  void ircUserInitDone(IrcUser *);
-  void ircChannelInitDone(IrcChannel *);
+//   void ircUserAdded(const QString &hostmask);
+  void ircUserAdded(IrcUser *);
+//   void ircChannelAdded(const QString &channelname);
+  void ircChannelAdded(IrcChannel *);
+
+//   void connectRequested() const;
+//   void disconnectRequested() const;
+//   void setNetworkInfoRequested(const NetworkInfo &) const;
 
-  void connectRequested(NetworkId id = 0) const;
-  void disconnectRequested(NetworkId id = 0) const;
+protected:
+  inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new IrcChannel(channelname, this); }
+  inline virtual IrcUser *ircUserFactory(const QString &hostmask) { return new IrcUser(hostmask, this); }
 
 private:
   QPointer<SignalProxy> _proxy;
@@ -294,6 +330,7 @@ private:
   IdentityId _identity;
 
   QString _myNick;
+  int _latency;
   QString _networkName;
   QString _currentServer;
   bool _connected;
@@ -306,7 +343,7 @@ private:
   QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
   QHash<QString, QString> _supports;  // stores results from RPL_ISUPPORT
 
-  QVariantList _serverList;
+  ServerList _serverList;
   bool _useRandomServer;
   QStringList _perform;
 
@@ -314,14 +351,16 @@ private:
   QString _autoIdentifyService;
   QString _autoIdentifyPassword;
 
+  bool _useSasl;
+  QString _saslAccount;
+  QString _saslPassword;
+
   bool _useAutoReconnect;
   quint32 _autoReconnectInterval;
   quint16 _autoReconnectRetries;
   bool _unlimitedReconnectRetries;
   bool _rejoinChannels;
 
-  void determinePrefixes();
-
   QTextCodec *_codecForServer;
   QTextCodec *_codecForEncoding;
   QTextCodec *_codecForDecoding;
@@ -329,10 +368,20 @@ private:
   static QTextCodec *_defaultCodecForServer;
   static QTextCodec *_defaultCodecForEncoding;
   static QTextCodec *_defaultCodecForDecoding;
+
+  bool _autoAwayActive; // when this is active handle305 and handle306 don't trigger any output
+
+  static QString _networksIniPath;
+
+  friend class IrcUser;
+  friend class IrcChannel;
 };
 
 //! Stores all editable information about a network (as opposed to runtime state).
 struct NetworkInfo {
+  // set some default values, note that this does not initialize e.g. name and id
+  NetworkInfo();
+
   NetworkId networkId;
   QString networkName;
   IdentityId identity;
@@ -342,8 +391,7 @@ struct NetworkInfo {
   QByteArray codecForEncoding;
   QByteArray codecForDecoding;
 
-  // Server entry: QString "Host", uint "Port", QString "Password", bool "UseSSL"
-  QVariantList serverList;
+  Network::ServerList serverList;
   bool useRandomServer;
 
   QStringList perform;
@@ -352,6 +400,10 @@ struct NetworkInfo {
   QString autoIdentifyService;
   QString autoIdentifyPassword;
 
+  bool useSasl;
+  QString saslAccount;
+  QString saslPassword;
+
   bool useAutoReconnect;
   quint32 autoReconnectInterval;
   quint16 autoReconnectRetries;
@@ -365,7 +417,11 @@ struct NetworkInfo {
 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
 QDebug operator<<(QDebug dbg, const NetworkInfo &i);
+Q_DECLARE_METATYPE(NetworkInfo)
 
-Q_DECLARE_METATYPE(NetworkInfo);
+QDataStream &operator<<(QDataStream &out, const Network::Server &server);
+QDataStream &operator>>(QDataStream &in, Network::Server &server);
+QDebug operator<<(QDebug dbg, const Network::Server &server);
+Q_DECLARE_METATYPE(Network::Server)
 
 #endif