This branch introduces a new sync method which should use less bandwidth and might...
[quassel.git] / src / common / network.h
index 1969430..2ff0a36 100644 (file)
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 
-#ifndef _NETWORK_H_
-#define _NETWORK_H_
+#ifndef NETWORK_H_
+#define NETWORK_H_
 
-#include <QDebug>
 #include <QString>
 #include <QStringList>
 #include <QList>
@@ -33,9 +32,9 @@
 #include "types.h"
 #include "syncableobject.h"
 
-class SignalProxy;
-class IrcUser;
-class IrcChannel;
+#include "signalproxy.h"
+#include "ircuser.h"
+#include "ircchannel.h"
 
 // defined below!
 struct NetworkInfo;
@@ -49,45 +48,89 @@ class Network : public SyncableObject {
   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(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)
   Q_PROPERTY(IdentityId identityId READ identity WRITE setIdentity STORED false)
   Q_PROPERTY(bool isConnected READ isConnected WRITE setConnected STORED false)
   //Q_PROPERTY(Network::ConnectionState connectionState READ connectionState WRITE setConnectionState STORED false)
   Q_PROPERTY(int connectionState READ connectionState WRITE setConnectionState STORED false)
+  Q_PROPERTY(bool useRandomServer READ useRandomServer WRITE setUseRandomServer STORED false)
+  Q_PROPERTY(QStringList perform READ perform WRITE setPerform STORED false)
+  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 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)
+  Q_PROPERTY(bool unlimitedReconnectRetries READ unlimitedReconnectRetries WRITE setUnlimitedReconnectRetries STORED false)
+  Q_PROPERTY(bool rejoinChannels READ rejoinChannels WRITE setRejoinChannels STORED false)
 
 public:
-  enum ConnectionState { Disconnected, Connecting, Initializing, Initialized, Disconnecting };
+  enum ConnectionState {
+    Disconnected,
+    Connecting,
+    Initializing,
+    Initialized,
+    Reconnecting,
+    Disconnecting
+  };
+
+  // see:
+  //  http://www.irc.org/tech_docs/005.html
+  //  http://www.irc.org/tech_docs/draft-brocklesby-irc-isupport-03.txt
+  enum ChannelModeType {
+    NOT_A_CHANMODE = 0x00,
+    A_CHANMODE = 0x01,
+    B_CHANMODE = 0x02,
+    C_CHANMODE = 0x04,
+    D_CHANMODE = 0x08
+  };
 
+  
   Network(const NetworkId &networkid, QObject *parent = 0);
   ~Network();
 
-  NetworkId networkId() const;
+  inline NetworkId networkId() const { return _networkId; }
 
-  SignalProxy *proxy() const;
-  void setProxy(SignalProxy *proxy);
+  inline SignalProxy *proxy() const { return _proxy; }
+  inline void setProxy(SignalProxy *proxy) { _proxy = proxy; }
 
-  bool isMyNick(const QString &nick) const;
-  bool isMe(IrcUser *ircuser) const;
+  inline bool isMyNick(const QString &nick) const { return (myNick().toLower() == nick.toLower()); }
+  inline bool isMe(IrcUser *ircuser) const { return (ircuser->nick().toLower() == myNick().toLower()); }
 
   bool isChannelName(const QString &channelname) const;
 
-  bool isConnected() const;
+  inline bool isConnected() const { return _connected; }
   //Network::ConnectionState connectionState() const;
-  int connectionState() const;
+  inline int connectionState() const { return _connectionState; }
 
   QString prefixToMode(const QString &prefix);
-  QString prefixToMode(const QCharRef &prefix);
+  inline QString prefixToMode(const QCharRef &prefix) { return prefixToMode(QString(prefix)); }
   QString modeToPrefix(const QString &mode);
-  QString modeToPrefix(const QCharRef &mode);
+  inline QString modeToPrefix(const QCharRef &mode) { return modeToPrefix(QString(mode)); }
 
-  QString networkName() const;
-  QString currentServer() const;
-  QString myNick() const;
-  IdentityId identity() const;
+  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 IrcUser *me() const { return ircUser(myNick()); }
+  inline IdentityId identity() const { return _identity; }
   QStringList nicks() const;
-  QStringList channels() const;
-  QVariantList serverList() const;
+  inline QStringList channels() const { return _ircChannels.keys(); }
+  inline const QVariantList &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 useAutoReconnect() const { return _useAutoReconnect; }
+  inline quint32 autoReconnectInterval() const { return _autoReconnectInterval; }
+  inline quint16 autoReconnectRetries() const { return _autoReconnectRetries; }
+  inline bool unlimitedReconnectRetries() const { return _unlimitedReconnectRetries; }
+  inline bool rejoinChannels() const { return _rejoinChannels; }
 
   NetworkInfo networkInfo() const;
   void setNetworkInfo(const NetworkInfo &);
@@ -95,30 +138,41 @@ public:
   QString prefixes();
   QString prefixModes();
 
-  bool supports(const QString &param) const;
+  bool supports(const QString &param) const { return _supports.contains(param); }
   QString support(const QString &param) const;
 
   IrcUser *newIrcUser(const QString &hostmask);
-  IrcUser *newIrcUser(const QByteArray &hostmask);
+  inline IrcUser *newIrcUser(const QByteArray &hostmask) { return newIrcUser(decodeServerString(hostmask)); }
   IrcUser *ircUser(QString nickname) const;
-  IrcUser *ircUser(const QByteArray &nickname) const;
-  QList<IrcUser *> ircUsers() const;
-  quint32 ircUserCount() 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 QByteArray &channelname);
+  inline IrcChannel *newIrcChannel(const QByteArray &channelname) { return newIrcChannel(decodeServerString(channelname)); }
   IrcChannel *ircChannel(QString channelname) const;
-  IrcChannel *ircChannel(const QByteArray &channelname) const;
-  QList<IrcChannel *> ircChannels() const;
-  quint32 ircChannelCount() const;
+  inline IrcChannel *ircChannel(const QByteArray &channelname) const { return ircChannel(decodeServerString(channelname)); }
+  inline QList<IrcChannel *> ircChannels() const { return _ircChannels.values(); }
+  inline quint32 ircChannelCount() const { return _ircChannels.count(); }
 
+  QByteArray codecForServer() const;
   QByteArray codecForEncoding() const;
   QByteArray codecForDecoding() const;
+  void setCodecForServer(QTextCodec *codec);
   void setCodecForEncoding(QTextCodec *codec);
   void setCodecForDecoding(QTextCodec *codec);
 
   QString decodeString(const QByteArray &text) const;
-  QByteArray encodeString(const QString string) const;
+  QByteArray encodeString(const QString &string) const;
+  QString decodeServerString(const QByteArray &text) const;
+  QByteArray encodeServerString(const QString &string) const;
+
+  static QByteArray defaultCodecForServer();
+  static QByteArray defaultCodecForEncoding();
+  static QByteArray defaultCodecForDecoding();
+  static void setDefaultCodecForServer(const QByteArray &name);
+  static void setDefaultCodecForEncoding(const QByteArray &name);
+  static void setDefaultCodecForDecoding(const QByteArray &name);
 
 public slots:
   void setNetworkName(const QString &networkName);
@@ -130,7 +184,18 @@ public slots:
   void setIdentity(IdentityId);
 
   void setServerList(const QVariantList &serverList);
-
+  void setUseRandomServer(bool);
+  void setPerform(const QStringList &);
+  void setUseAutoIdentify(bool);
+  void setAutoIdentifyService(const QString &);
+  void setAutoIdentifyPassword(const QString &);
+  void setUseAutoReconnect(bool);
+  void setAutoReconnectInterval(quint32);
+  void setAutoReconnectRetries(quint16);
+  void setUnlimitedReconnectRetries(bool);
+  void setRejoinChannels(bool);
+
+  void setCodecForServer(const QByteArray &codecName);
   void setCodecForEncoding(const QByteArray &codecName);
   void setCodecForDecoding(const QByteArray &codecName);
 
@@ -138,19 +203,23 @@ public slots:
   void removeSupport(const QString &param);
 
   inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
-  void removeIrcUser(QString nick);
-  
+  inline void addIrcChannel(const QString &channel) { newIrcChannel(channel); }
+  void removeIrcUser(const QString &nick);
+  void removeIrcChannel(const QString &channel);
+
   //init geters
   QVariantMap initSupports() const;
-  QVariantList initServerList() const;
-  QStringList initIrcUsers() const;
-  QStringList initIrcChannels() const;
+  inline QVariantList initServerList() const { return serverList(); }
+  virtual QVariantMap initIrcUsersAndChannels() const;
+//   QStringList initIrcUsers() const;
+//   QStringList initIrcChannels() const;
   
   //init seters
   void initSetSupports(const QVariantMap &supports);
-  void initSetServerList(const QVariantList &serverList);
-  void initSetIrcUsers(const QStringList &hostmasks);
-  void initSetChannels(const QStringList &channels);
+  inline void initSetServerList(const QVariantList &serverList) { setServerList(serverList); }
+  virtual void initSetIrcUsersAndChannels(const QVariantMap &usersAndChannels);
+//   void initSetIrcUsers(const QStringList &hostmasks);
+//   void initSetIrcChannels(const QStringList &channels);
   
   IrcUser *updateNickFromMask(const QString &mask);
 
@@ -158,8 +227,8 @@ public slots:
   // channel lists up to date
   void ircUserNickChanged(QString newnick);
 
-  void requestConnect() const;
-  void requestDisconnect() const;
+  virtual inline void requestConnect() const { emit connectRequested(); }
+  virtual inline void requestDisconnect() const { emit disconnectRequested(); }
 
   void emitConnectionError(const QString &);
 
@@ -167,10 +236,13 @@ private slots:
   void ircUserDestroyed();
   void channelDestroyed();
   void removeIrcUser(IrcUser *ircuser);
+  void removeIrcChannel(IrcChannel *ircChannel);
+  void removeChansAndUsers();
   void ircUserInitDone();
   void ircChannelInitDone();
 
 signals:
+  void aboutToBeDestroyed();
   void networkNameSet(const QString &networkName);
   void currentServerSet(const QString &currentServer);
   void connectedSet(bool isConnected);
@@ -181,9 +253,20 @@ signals:
   void identitySet(IdentityId);
 
   void serverListSet(QVariantList serverList);
-
-  void codecForEncodingSet(const QString &codecName);
-  void codecForDecodingSet(const QString &codecName);
+  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);
@@ -194,6 +277,7 @@ signals:
   void ircChannelAdded(IrcChannel *);
 
   void ircUserRemoved(const QString &nick);
+  void ircChannelRemoved(const QString &channel);
 
   // needed for client sync progress
   void ircUserRemoved(QObject *);
@@ -206,6 +290,8 @@ signals:
   void disconnectRequested(NetworkId id = 0) const;
 
 private:
+  QPointer<SignalProxy> _proxy;
+
   NetworkId _networkId;
   IdentityId _identity;
 
@@ -223,15 +309,28 @@ private:
   QHash<QString, QString> _supports;  // stores results from RPL_ISUPPORT
 
   QVariantList _serverList;
+  bool _useRandomServer;
   QStringList _perform;
-  //QVariantMap networkSettings;
 
-  QPointer<SignalProxy> _proxy;
+  bool _useAutoIdentify;
+  QString _autoIdentifyService;
+  QString _autoIdentifyPassword;
+
+  bool _useAutoReconnect;
+  quint32 _autoReconnectInterval;
+  quint16 _autoReconnectRetries;
+  bool _unlimitedReconnectRetries;
+  bool _rejoinChannels;
+
   void determinePrefixes();
 
+  QTextCodec *_codecForServer;
   QTextCodec *_codecForEncoding;
   QTextCodec *_codecForDecoding;
 
+  static QTextCodec *_defaultCodecForServer;
+  static QTextCodec *_defaultCodecForEncoding;
+  static QTextCodec *_defaultCodecForDecoding;
 };
 
 //! Stores all editable information about a network (as opposed to runtime state).
@@ -240,7 +339,8 @@ struct NetworkInfo {
   QString networkName;
   IdentityId identity;
 
-  bool useCustomEncodings;
+  bool useCustomEncodings; // not used!
+  QByteArray codecForServer;
   QByteArray codecForEncoding;
   QByteArray codecForDecoding;
 
@@ -256,7 +356,8 @@ struct NetworkInfo {
 
   bool useAutoReconnect;
   quint32 autoReconnectInterval;
-  qint16 autoReconnectRetries;  // -1 => Unlimited
+  quint16 autoReconnectRetries;
+  bool unlimitedReconnectRetries;
   bool rejoinChannels;
 
   bool operator==(const NetworkInfo &other) const;
@@ -265,6 +366,7 @@ 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);