SASL support
[quassel.git] / src / common / network.h
index 84e8699..f0bd112 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel Project                          *
+ *   Copyright (C) 2005-09 by the Quassel Project                          *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
 #include <QString>
 #include <QStringList>
 #include <QList>
+#include <QNetworkProxy>
 #include <QHash>
 #include <QVariantMap>
 #include <QPointer>
 #include <QMutex>
 
 #include "types.h"
+#include "util.h"
 #include "syncableobject.h"
 
 #include "signalproxy.h"
@@ -42,6 +44,7 @@ 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)
 
@@ -61,6 +64,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)
@@ -93,12 +99,21 @@ public:
     uint port;
     QString password;
     bool useSsl;
-    Server() : port(0), useSsl(false) {}
-    Server(const QString &host, uint port, const QString &password, bool useSsl)
-      : host(host), port(port), password(password), useSsl(useSsl) {}
+    int sslVersion;
+
+    bool useProxy;
+    int proxyType;
+    QString proxyHost;
+    uint proxyPort;
+    QString proxyUser;
+    QString proxyPass;
 
-    static Server fromVariant(const QVariant &variant);
-    QVariant toVariant() const;
+    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;
 
@@ -136,12 +151,14 @@ public:
   QStringList nicks() const;
   inline QStringList channels() const { return _ircChannels.keys(); }
   inline const ServerList &serverList() const { return _serverList; }
-  QVariantList variantServerList() const;
   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; }
@@ -193,6 +210,10 @@ public:
   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);
@@ -208,6 +229,9 @@ public slots:
   void setUseAutoIdentify(bool);
   void setAutoIdentifyService(const QString &);
   void setAutoIdentifyPassword(const QString &);
+  void setUseSasl(bool);
+  void setSaslAccount(const QString &);
+  void setSaslPassword(const QString &);
   virtual void setUseAutoReconnect(bool);
   virtual void setAutoReconnectInterval(quint32);
   virtual void setAutoReconnectRetries(quint16);
@@ -226,12 +250,12 @@ public slots:
 
   //init geters
   QVariantMap initSupports() const;
-  inline QVariantList initServerList() const { return variantServerList(); }
+  inline QVariantList initServerList() const { return toVariantList(serverList()); }
   virtual QVariantMap initIrcUsersAndChannels() const;
 
   //init seters
   void initSetSupports(const QVariantMap &supports);
-  void initSetServerList(const QVariantList &serverList);
+  inline void initSetServerList(const QVariantList &serverList) { _serverList = fromVariantList<Server>(serverList); }
   virtual void initSetIrcUsersAndChannels(const QVariantMap &usersAndChannels);
 
   IrcUser *updateNickFromMask(const QString &mask);
@@ -240,9 +264,9 @@ public slots:
   // 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 requestSetNetworkInfo(const NetworkInfo &info) { emit setNetworkInfoRequested(info); }
+  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 &);
 
@@ -257,39 +281,41 @@ 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 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 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 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(const QString &channelname);
   void ircChannelAdded(IrcChannel *);
 
-  void connectRequested() const;
-  void disconnectRequested() const;
-  void setNetworkInfoRequested(const NetworkInfo &) const;
+//   void connectRequested() const;
+//   void disconnectRequested() const;
+//   void setNetworkInfoRequested(const NetworkInfo &) const;
 
 protected:
   inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new IrcChannel(channelname, this); }
@@ -322,6 +348,10 @@ private:
   QString _autoIdentifyService;
   QString _autoIdentifyPassword;
 
+  bool _useSasl;
+  QString _saslAccount;
+  QString _saslPassword;
+
   bool _useAutoReconnect;
   quint32 _autoReconnectInterval;
   quint16 _autoReconnectRetries;
@@ -340,12 +370,17 @@ private:
 
   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;
@@ -355,8 +390,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;
@@ -365,6 +399,10 @@ struct NetworkInfo {
   QString autoIdentifyService;
   QString autoIdentifyPassword;
 
+  bool useSasl;
+  QString saslAccount;
+  QString saslPassword;
+
   bool useAutoReconnect;
   quint32 autoReconnectInterval;
   quint16 autoReconnectRetries;
@@ -378,7 +416,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)
 
+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