X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fnetwork.h;h=55e953aca221a13408e21d531c78d4315c80150a;hp=93d9d515a401fda318d1c212850f457ada9278c3;hb=91e19c05228aaba95ef27b580b35fc6ed2af7517;hpb=fd7c2c4a41b5bb9cffcfe7a8f86a28ab7f38ac27 diff --git a/src/common/network.h b/src/common/network.h index 93d9d515..55e953ac 100644 --- a/src/common/network.h +++ b/src/common/network.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-08 by the Quassel Project * + * Copyright (C) 2005-2015 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -15,163 +15,427 @@ * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#ifndef _NETWORK_H_ -#define _NETWORK_H_ +#ifndef NETWORK_H +#define NETWORK_H #include #include #include +#include #include #include #include +#include +#include #include "types.h" +#include "util.h" #include "syncableobject.h" -class SignalProxy; -class IrcUser; -class IrcChannel; +#include "signalproxy.h" +#include "ircuser.h" +#include "ircchannel.h" + +// defined below! +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) + + Q_PROPERTY(QString networkName READ networkName WRITE setNetworkName) + Q_PROPERTY(QString currentServer READ currentServer WRITE setCurrentServer) + Q_PROPERTY(QString myNick READ myNick WRITE setMyNick) + Q_PROPERTY(int latency READ latency WRITE setLatency) + Q_PROPERTY(QByteArray codecForServer READ codecForServer WRITE setCodecForServer) + Q_PROPERTY(QByteArray codecForEncoding READ codecForEncoding WRITE setCodecForEncoding) + Q_PROPERTY(QByteArray codecForDecoding READ codecForDecoding WRITE setCodecForDecoding) + Q_PROPERTY(IdentityId identityId READ identity WRITE setIdentity) + Q_PROPERTY(bool isConnected READ isConnected WRITE setConnected) + //Q_PROPERTY(Network::ConnectionState connectionState READ connectionState WRITE setConnectionState) + Q_PROPERTY(int connectionState READ connectionState WRITE setConnectionState) + Q_PROPERTY(bool useRandomServer READ useRandomServer WRITE setUseRandomServer) + Q_PROPERTY(QStringList perform READ perform WRITE setPerform) + Q_PROPERTY(bool useAutoIdentify READ useAutoIdentify WRITE setUseAutoIdentify) + Q_PROPERTY(QString autoIdentifyService READ autoIdentifyService WRITE setAutoIdentifyService) + Q_PROPERTY(QString autoIdentifyPassword READ autoIdentifyPassword WRITE setAutoIdentifyPassword) + Q_PROPERTY(bool useSasl READ useSasl WRITE setUseSasl) + Q_PROPERTY(QString saslAccount READ saslAccount WRITE setSaslAccount) + Q_PROPERTY(QString saslPassword READ saslPassword WRITE setSaslPassword) + Q_PROPERTY(bool useAutoReconnect READ useAutoReconnect WRITE setUseAutoReconnect) + Q_PROPERTY(quint32 autoReconnectInterval READ autoReconnectInterval WRITE setAutoReconnectInterval) + Q_PROPERTY(quint16 autoReconnectRetries READ autoReconnectRetries WRITE setAutoReconnectRetries) + Q_PROPERTY(bool unlimitedReconnectRetries READ unlimitedReconnectRetries WRITE setUnlimitedReconnectRetries) + Q_PROPERTY(bool rejoinChannels READ rejoinChannels WRITE setRejoinChannels) + +public : + 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 + }; + + 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 ServerList; + + Network(const NetworkId &networkid, QObject *parent = 0); + ~Network(); + + inline NetworkId networkId() const { return _networkId; } + + inline SignalProxy *proxy() const { return _proxy; } + inline void setProxy(SignalProxy *proxy) { _proxy = proxy; } + + 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; + + /** + * Checks if the target counts as a STATUSMSG + * + * Status messages are prefixed with one or more characters from the server-provided STATUSMSG + * if available, otherwise "@" and "+" are assumed. Generally, status messages sent to a + * channel are only visible to those with the same or higher permissions, e.g. voiced. + * + * @param[in] target Name of destination, e.g. a channel or query + * @returns True if a STATUSMSG, otherwise false + */ + bool isStatusMsg(const QString &target) const; + + inline bool isConnected() const { return _connected; } + //Network::ConnectionState connectionState() const; + inline int connectionState() const { return _connectionState; } + + QString prefixToMode(const QString &prefix) const; + inline QString prefixToMode(const QCharRef &prefix) const { return prefixToMode(QString(prefix)); } + QString modeToPrefix(const QString &mode) const; + inline QString modeToPrefix(const QCharRef &mode) const { return modeToPrefix(QString(mode)); } + + 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 ¤tServer() 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 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; } + inline bool unlimitedReconnectRetries() const { return _unlimitedReconnectRetries; } + inline bool rejoinChannels() const { return _rejoinChannels; } + + NetworkInfo networkInfo() const; + void setNetworkInfo(const NetworkInfo &); + + QString prefixes() const; + QString prefixModes() const; + void determinePrefixes() const; + + bool supports(const QString ¶m) const { return _supports.contains(param); } + QString support(const QString ¶m) const; + + 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 ircUsers() const { return _ircUsers.values(); } + inline quint32 ircUserCount() const { return _ircUsers.count(); } + + 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)); } + inline QList 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; + 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); + + inline bool autoAwayActive() const { return _autoAwayActive; } + inline void setAutoAwayActive(bool active) { _autoAwayActive = active; } +public slots: + void setNetworkName(const QString &networkName); + void setCurrentServer(const QString ¤tServer); + void setConnected(bool isConnected); + void setConnectionState(int state); + virtual void setMyNick(const QString &mynick); + void setLatency(int latency); + 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 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); + + void setCodecForServer(const QByteArray &codecName); + void setCodecForEncoding(const QByteArray &codecName); + void setCodecForDecoding(const QByteArray &codecName); + + void addSupport(const QString ¶m, const QString &value = QString()); + void removeSupport(const QString ¶m); + + inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); } + inline void addIrcChannel(const QString &channel) { newIrcChannel(channel); } + + //init geters + QVariantMap initSupports() 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) { _serverList = fromVariantList(serverList); } + virtual void initSetIrcUsersAndChannels(const QVariantMap &usersAndChannels); + + /** + * Update IrcUser hostmask and username from mask, creating an IrcUser if one does not exist. + * + * @param[in] mask Full nick!user@hostmask string + * @return IrcUser of the matching nick if exists, otherwise a new IrcUser + */ + 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 { 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 &); + +protected slots: + virtual void removeIrcUser(IrcUser *ircuser); + virtual void removeIrcChannel(IrcChannel *ircChannel); + virtual void removeChansAndUsers(); -class Network : public SyncableObject { - Q_OBJECT +signals: + void aboutToBeDestroyed(); + void networkNameSet(const QString &networkName); + void currentServerSet(const QString ¤tServer); + void connectedSet(bool isConnected); + void connectionStateSet(Network::ConnectionState); +// void connectionStateSet(int); + void connectionError(const QString &errorMsg); + void myNickSet(const QString &mynick); +// void latencySet(int latency); + void identitySet(IdentityId); + + 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 ¶m, const QString &value); +// void supportRemoved(const QString ¶m); + +// 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; + +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); } - 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) +private: + QPointer _proxy; -public: - Network(const uint &networkid, QObject *parent = 0); - //virtual ~Network(); + NetworkId _networkId; + IdentityId _identity; - NetworkId networkId() const; - bool initialized() const; + QString _myNick; + int _latency; + QString _networkName; + QString _currentServer; + bool _connected; + ConnectionState _connectionState; - SignalProxy *proxy() const; - void setProxy(SignalProxy *proxy); + mutable QString _prefixes; + mutable QString _prefixModes; - bool isMyNick(const QString &nick) const; - bool isMyNick(IrcUser *ircuser) const; + QHash _ircUsers; // stores all known nicks for the server + QHash _ircChannels; // stores all known channels + QHash _supports; // stores results from RPL_ISUPPORT - bool isChannelName(const QString &channelname) const; + ServerList _serverList; + bool _useRandomServer; + QStringList _perform; - QString prefixToMode(const QString &prefix); - QString prefixToMode(const QCharRef &prefix); - QString modeToPrefix(const QString &mode); - QString modeToPrefix(const QCharRef &mode); + bool _useAutoIdentify; + QString _autoIdentifyService; + QString _autoIdentifyPassword; - QString networkName() const; - QString currentServer() const; - QString myNick() const; - QStringList nicks() const; - QStringList channels() const; + bool _useSasl; + QString _saslAccount; + QString _saslPassword; - QString prefixes(); - QString prefixModes(); + bool _useAutoReconnect; + quint32 _autoReconnectInterval; + quint16 _autoReconnectRetries; + bool _unlimitedReconnectRetries; + bool _rejoinChannels; - bool supports(const QString ¶m) const; - QString support(const QString ¶m) const; + QTextCodec *_codecForServer; + QTextCodec *_codecForEncoding; + QTextCodec *_codecForDecoding; - IrcUser *newIrcUser(const QString &hostmask); - IrcUser *newIrcUser(const QByteArray &hostmask); - IrcUser *ircUser(QString nickname) const; - IrcUser *ircUser(const QByteArray &nickname) const; - QList ircUsers() const; + static QTextCodec *_defaultCodecForServer; + static QTextCodec *_defaultCodecForEncoding; + static QTextCodec *_defaultCodecForDecoding; - IrcChannel *newIrcChannel(const QString &channelname); - IrcChannel *newIrcChannel(const QByteArray &channelname); - IrcChannel *ircChannel(QString channelname); - IrcChannel *ircChannel(const QByteArray &channelname); - - QList ircChannels() const; + bool _autoAwayActive; // when this is active handle305 and handle306 don't trigger any output - QTextCodec *codecForEncoding() const; - QTextCodec *codecForDecoding() const; - void setCodecForEncoding(const QString &codecName); - void setCodecForEncoding(QTextCodec *codec); - void setCodecForDecoding(const QString &codecName); - void setCodecForDecoding(QTextCodec *codec); + friend class IrcUser; + friend class IrcChannel; +}; - QString decodeString(const QByteArray &text) const; - QByteArray encodeString(const QString string) const; -public slots: - void setNetworkName(const QString &networkName); - void setCurrentServer(const QString ¤tServer); - void setMyNick(const QString &mynick); - - void addSupport(const QString ¶m, const QString &value = QString()); - void removeSupport(const QString ¶m); - - inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); } - void removeIrcUser(QString nick); - - //init geters - QVariantMap initSupports() const; - QStringList initIrcUsers() const; - QStringList initIrcChannels() const; - - //init seters - void initSetSupports(const QVariantMap &supports); - void initSetIrcUsers(const QStringList &hostmasks); - void initSetChannels(const QStringList &channels); - - 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); - void setInitialized(); - -private slots: - void ircUserDestroyed(); - void channelDestroyed(); - void removeIrcUser(IrcUser *ircuser); - -signals: - void networkNameSet(const QString &networkName); - void currentServerSet(const QString ¤tServer); - void myNickSet(const QString &mynick); - - void supportAdded(const QString ¶m, const QString &value); - void supportRemoved(const QString ¶m); - - void ircUserAdded(QString hostmask); - void ircChannelAdded(QString channelname); - - void ircUserRemoved(QString nick); - - void initDone(); - void ircUserInitDone(); - void ircChannelInitDone(); - -private: - uint _networkId; - bool _initialized; - - QString _myNick; - QString _networkName; - QString _currentServer; +//! 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; + + bool useCustomEncodings; // not used! + QByteArray codecForServer; + QByteArray codecForEncoding; + QByteArray codecForDecoding; - QString _prefixes; - QString _prefixModes; + Network::ServerList serverList; + bool useRandomServer; - QHash _ircUsers; // stores all known nicks for the server - QHash _ircChannels; // stores all known channels - QHash _supports; // stores results from RPL_ISUPPORT + QStringList perform; - //QVariantMap networkSettings; - //QVariantMap identity; - - QPointer _proxy; - void determinePrefixes(); + bool useAutoIdentify; + QString autoIdentifyService; + QString autoIdentifyPassword; - QTextCodec *_codecForEncoding; - QTextCodec *_codecForDecoding; + bool useSasl; + QString saslAccount; + QString saslPassword; + bool useAutoReconnect; + quint32 autoReconnectInterval; + quint16 autoReconnectRetries; + bool unlimitedReconnectRetries; + bool rejoinChannels; + + bool operator==(const NetworkInfo &other) const; + bool operator!=(const NetworkInfo &other) const; }; +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