1 /***************************************************************************
2 * Copyright (C) 2005-09 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
25 #include <QStringList>
27 #include <QNetworkProxy>
29 #include <QVariantMap>
35 #include "syncableobject.h"
37 #include "signalproxy.h"
39 #include "ircchannel.h"
44 // TODO: ConnectionInfo to propagate and sync the current state of NetworkConnection, encodings etcpp
46 class Network : public SyncableObject {
48 Q_ENUMS(ConnectionState Network::ConnectionState)
50 Q_PROPERTY(QString networkName READ networkName WRITE setNetworkName STORED false)
51 Q_PROPERTY(QString currentServer READ currentServer WRITE setCurrentServer STORED false)
52 Q_PROPERTY(QString myNick READ myNick WRITE setMyNick STORED false)
53 Q_PROPERTY(int latency READ latency WRITE setLatency STORED false)
54 Q_PROPERTY(QByteArray codecForServer READ codecForServer WRITE setCodecForServer STORED false)
55 Q_PROPERTY(QByteArray codecForEncoding READ codecForEncoding WRITE setCodecForEncoding STORED false)
56 Q_PROPERTY(QByteArray codecForDecoding READ codecForDecoding WRITE setCodecForDecoding STORED false)
57 Q_PROPERTY(IdentityId identityId READ identity WRITE setIdentity STORED false)
58 Q_PROPERTY(bool isConnected READ isConnected WRITE setConnected STORED false)
59 //Q_PROPERTY(Network::ConnectionState connectionState READ connectionState WRITE setConnectionState STORED false)
60 Q_PROPERTY(int connectionState READ connectionState WRITE setConnectionState STORED false)
61 Q_PROPERTY(bool useRandomServer READ useRandomServer WRITE setUseRandomServer STORED false)
62 Q_PROPERTY(QStringList perform READ perform WRITE setPerform STORED false)
63 Q_PROPERTY(bool useAutoIdentify READ useAutoIdentify WRITE setUseAutoIdentify STORED false)
64 Q_PROPERTY(QString autoIdentifyService READ autoIdentifyService WRITE setAutoIdentifyService STORED false)
65 Q_PROPERTY(QString autoIdentifyPassword READ autoIdentifyPassword WRITE setAutoIdentifyPassword STORED false)
66 Q_PROPERTY(bool useAutoReconnect READ useAutoReconnect WRITE setUseAutoReconnect STORED false)
67 Q_PROPERTY(quint32 autoReconnectInterval READ autoReconnectInterval WRITE setAutoReconnectInterval STORED false)
68 Q_PROPERTY(quint16 autoReconnectRetries READ autoReconnectRetries WRITE setAutoReconnectRetries STORED false)
69 Q_PROPERTY(bool unlimitedReconnectRetries READ unlimitedReconnectRetries WRITE setUnlimitedReconnectRetries STORED false)
70 Q_PROPERTY(bool rejoinChannels READ rejoinChannels WRITE setRejoinChannels STORED false)
73 enum ConnectionState {
83 // http://www.irc.org/tech_docs/005.html
84 // http://www.irc.org/tech_docs/draft-brocklesby-irc-isupport-03.txt
85 enum ChannelModeType {
86 NOT_A_CHANMODE = 0x00,
107 Server() : port(6667), useSsl(false), sslVersion(0), useProxy(false), proxyType(QNetworkProxy::Socks5Proxy), proxyHost("localhost"), proxyPort(8080) {}
108 Server(const QString &host, uint port, const QString &password, bool useSsl)
109 : host(host), port(port), password(password), useSsl(useSsl), sslVersion(0),
110 useProxy(false), proxyType(QNetworkProxy::Socks5Proxy), proxyHost("localhost"), proxyPort(8080) {}
111 bool operator==(const Server &other) const;
112 bool operator!=(const Server &other) const;
114 typedef QList<Server> ServerList;
116 Network(const NetworkId &networkid, QObject *parent = 0);
119 inline NetworkId networkId() const { return _networkId; }
121 inline SignalProxy *proxy() const { return _proxy; }
122 inline void setProxy(SignalProxy *proxy) { _proxy = proxy; }
124 inline bool isMyNick(const QString &nick) const { return (myNick().toLower() == nick.toLower()); }
125 inline bool isMe(IrcUser *ircuser) const { return (ircuser->nick().toLower() == myNick().toLower()); }
127 bool isChannelName(const QString &channelname) const;
129 inline bool isConnected() const { return _connected; }
130 //Network::ConnectionState connectionState() const;
131 inline int connectionState() const { return _connectionState; }
133 QString prefixToMode(const QString &prefix);
134 inline QString prefixToMode(const QCharRef &prefix) { return prefixToMode(QString(prefix)); }
135 QString modeToPrefix(const QString &mode);
136 inline QString modeToPrefix(const QCharRef &mode) { return modeToPrefix(QString(mode)); }
138 ChannelModeType channelModeType(const QString &mode);
139 inline ChannelModeType channelModeType(const QCharRef &mode) { return channelModeType(QString(mode)); }
141 inline const QString &networkName() const { return _networkName; }
142 inline const QString ¤tServer() const { return _currentServer; }
143 inline const QString &myNick() const { return _myNick; }
144 inline int latency() const { return _latency; }
145 inline IrcUser *me() const { return ircUser(myNick()); }
146 inline IdentityId identity() const { return _identity; }
147 QStringList nicks() const;
148 inline QStringList channels() const { return _ircChannels.keys(); }
149 inline const ServerList &serverList() const { return _serverList; }
150 inline bool useRandomServer() const { return _useRandomServer; }
151 inline const QStringList &perform() const { return _perform; }
152 inline bool useAutoIdentify() const { return _useAutoIdentify; }
153 inline const QString &autoIdentifyService() const { return _autoIdentifyService; }
154 inline const QString &autoIdentifyPassword() const { return _autoIdentifyPassword; }
155 inline bool useAutoReconnect() const { return _useAutoReconnect; }
156 inline quint32 autoReconnectInterval() const { return _autoReconnectInterval; }
157 inline quint16 autoReconnectRetries() const { return _autoReconnectRetries; }
158 inline bool unlimitedReconnectRetries() const { return _unlimitedReconnectRetries; }
159 inline bool rejoinChannels() const { return _rejoinChannels; }
161 NetworkInfo networkInfo() const;
162 void setNetworkInfo(const NetworkInfo &);
165 QString prefixModes();
167 bool supports(const QString ¶m) const { return _supports.contains(param); }
168 QString support(const QString ¶m) const;
170 IrcUser *newIrcUser(const QString &hostmask, const QVariantMap &initData = QVariantMap());
171 inline IrcUser *newIrcUser(const QByteArray &hostmask) { return newIrcUser(decodeServerString(hostmask)); }
172 IrcUser *ircUser(QString nickname) const;
173 inline IrcUser *ircUser(const QByteArray &nickname) const { return ircUser(decodeServerString(nickname)); }
174 inline QList<IrcUser *> ircUsers() const { return _ircUsers.values(); }
175 inline quint32 ircUserCount() const { return _ircUsers.count(); }
177 IrcChannel *newIrcChannel(const QString &channelname, const QVariantMap &initData = QVariantMap());
178 inline IrcChannel *newIrcChannel(const QByteArray &channelname) { return newIrcChannel(decodeServerString(channelname)); }
179 IrcChannel *ircChannel(QString channelname) const;
180 inline IrcChannel *ircChannel(const QByteArray &channelname) const { return ircChannel(decodeServerString(channelname)); }
181 inline QList<IrcChannel *> ircChannels() const { return _ircChannels.values(); }
182 inline quint32 ircChannelCount() const { return _ircChannels.count(); }
184 QByteArray codecForServer() const;
185 QByteArray codecForEncoding() const;
186 QByteArray codecForDecoding() const;
187 void setCodecForServer(QTextCodec *codec);
188 void setCodecForEncoding(QTextCodec *codec);
189 void setCodecForDecoding(QTextCodec *codec);
191 QString decodeString(const QByteArray &text) const;
192 QByteArray encodeString(const QString &string) const;
193 QString decodeServerString(const QByteArray &text) const;
194 QByteArray encodeServerString(const QString &string) const;
196 static QByteArray defaultCodecForServer();
197 static QByteArray defaultCodecForEncoding();
198 static QByteArray defaultCodecForDecoding();
199 static void setDefaultCodecForServer(const QByteArray &name);
200 static void setDefaultCodecForEncoding(const QByteArray &name);
201 static void setDefaultCodecForDecoding(const QByteArray &name);
203 inline bool autoAwayActive() const { return _autoAwayActive; }
204 inline void setAutoAwayActive(bool active) { _autoAwayActive = active; }
206 static QStringList presetNetworks(bool onlyDefault = false);
207 static QStringList presetDefaultChannels(const QString &networkName);
208 static NetworkInfo networkInfoFromPreset(const QString &networkName);
211 void setNetworkName(const QString &networkName);
212 void setCurrentServer(const QString ¤tServer);
213 void setConnected(bool isConnected);
214 void setConnectionState(int state);
215 virtual void setMyNick(const QString &mynick);
216 void setLatency(int latency);
217 void setIdentity(IdentityId);
219 void setServerList(const QVariantList &serverList);
220 void setUseRandomServer(bool);
221 void setPerform(const QStringList &);
222 void setUseAutoIdentify(bool);
223 void setAutoIdentifyService(const QString &);
224 void setAutoIdentifyPassword(const QString &);
225 virtual void setUseAutoReconnect(bool);
226 virtual void setAutoReconnectInterval(quint32);
227 virtual void setAutoReconnectRetries(quint16);
228 void setUnlimitedReconnectRetries(bool);
229 void setRejoinChannels(bool);
231 void setCodecForServer(const QByteArray &codecName);
232 void setCodecForEncoding(const QByteArray &codecName);
233 void setCodecForDecoding(const QByteArray &codecName);
235 void addSupport(const QString ¶m, const QString &value = QString());
236 void removeSupport(const QString ¶m);
238 inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
239 inline void addIrcChannel(const QString &channel) { newIrcChannel(channel); }
242 QVariantMap initSupports() const;
243 inline QVariantList initServerList() const { return toVariantList(serverList()); }
244 virtual QVariantMap initIrcUsersAndChannels() const;
247 void initSetSupports(const QVariantMap &supports);
248 inline void initSetServerList(const QVariantList &serverList) { _serverList = fromVariantList<Server>(serverList); }
249 virtual void initSetIrcUsersAndChannels(const QVariantMap &usersAndChannels);
251 IrcUser *updateNickFromMask(const QString &mask);
253 // these slots are to keep the hashlists of all users and the
254 // channel lists up to date
255 void ircUserNickChanged(QString newnick);
257 virtual inline void requestConnect() const { emit connectRequested(); }
258 virtual inline void requestDisconnect() const { emit disconnectRequested(); }
259 virtual inline void requestSetNetworkInfo(const NetworkInfo &info) { emit setNetworkInfoRequested(info); }
261 void emitConnectionError(const QString &);
264 void removeIrcUser(IrcUser *ircuser);
265 void removeIrcChannel(IrcChannel *ircChannel);
266 void removeChansAndUsers();
269 void aboutToBeDestroyed();
270 void networkNameSet(const QString &networkName);
271 void currentServerSet(const QString ¤tServer);
272 void connectedSet(bool isConnected);
273 void connectionStateSet(Network::ConnectionState);
274 void connectionStateSet(int);
275 void connectionError(const QString &errorMsg);
276 void myNickSet(const QString &mynick);
277 void latencySet(int latency);
278 void identitySet(IdentityId);
280 void serverListSet(QVariantList serverList);
281 void useRandomServerSet(bool);
282 void performSet(const QStringList &);
283 void useAutoIdentifySet(bool);
284 void autoIdentifyServiceSet(const QString &);
285 void autoIdentifyPasswordSet(const QString &);
286 void useAutoReconnectSet(bool);
287 void autoReconnectIntervalSet(quint32);
288 void autoReconnectRetriesSet(quint16);
289 void unlimitedReconnectRetriesSet(bool);
290 void rejoinChannelsSet(bool);
292 void codecForServerSet(const QByteArray &codecName);
293 void codecForEncodingSet(const QByteArray &codecName);
294 void codecForDecodingSet(const QByteArray &codecName);
296 void supportAdded(const QString ¶m, const QString &value);
297 void supportRemoved(const QString ¶m);
299 void ircUserAdded(const QString &hostmask);
300 void ircUserAdded(IrcUser *);
301 void ircChannelAdded(const QString &channelname);
302 void ircChannelAdded(IrcChannel *);
304 void connectRequested() const;
305 void disconnectRequested() const;
306 void setNetworkInfoRequested(const NetworkInfo &) const;
309 inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new IrcChannel(channelname, this); }
312 QPointer<SignalProxy> _proxy;
314 NetworkId _networkId;
315 IdentityId _identity;
319 QString _networkName;
320 QString _currentServer;
322 ConnectionState _connectionState;
325 QString _prefixModes;
327 QHash<QString, IrcUser *> _ircUsers; // stores all known nicks for the server
328 QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
329 QHash<QString, QString> _supports; // stores results from RPL_ISUPPORT
331 ServerList _serverList;
332 bool _useRandomServer;
333 QStringList _perform;
335 bool _useAutoIdentify;
336 QString _autoIdentifyService;
337 QString _autoIdentifyPassword;
339 bool _useAutoReconnect;
340 quint32 _autoReconnectInterval;
341 quint16 _autoReconnectRetries;
342 bool _unlimitedReconnectRetries;
343 bool _rejoinChannels;
345 void determinePrefixes();
347 QTextCodec *_codecForServer;
348 QTextCodec *_codecForEncoding;
349 QTextCodec *_codecForDecoding;
351 static QTextCodec *_defaultCodecForServer;
352 static QTextCodec *_defaultCodecForEncoding;
353 static QTextCodec *_defaultCodecForDecoding;
355 bool _autoAwayActive; // when this is active handle305 and handle306 don't trigger any output
357 static QString _networksIniPath;
359 friend class IrcUser;
360 friend class IrcChannel;
363 //! Stores all editable information about a network (as opposed to runtime state).
365 // set some default values, note that this does not initialize e.g. name and id
372 bool useCustomEncodings; // not used!
373 QByteArray codecForServer;
374 QByteArray codecForEncoding;
375 QByteArray codecForDecoding;
377 Network::ServerList serverList;
378 bool useRandomServer;
382 bool useAutoIdentify;
383 QString autoIdentifyService;
384 QString autoIdentifyPassword;
386 bool useAutoReconnect;
387 quint32 autoReconnectInterval;
388 quint16 autoReconnectRetries;
389 bool unlimitedReconnectRetries;
392 bool operator==(const NetworkInfo &other) const;
393 bool operator!=(const NetworkInfo &other) const;
396 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
397 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
398 QDebug operator<<(QDebug dbg, const NetworkInfo &i);
399 Q_DECLARE_METATYPE(NetworkInfo)
401 QDataStream &operator<<(QDataStream &out, const Network::Server &server);
402 QDataStream &operator>>(QDataStream &in, Network::Server &server);
403 QDebug operator<<(QDebug dbg, const Network::Server &server);
404 Q_DECLARE_METATYPE(Network::Server)