src/common/network.h

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