1 /***************************************************************************
2 * Copyright (C) 2005-2013 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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
25 #include <QStringList>
27 #include <QNetworkProxy>
29 #include <QVariantMap>
36 #include "syncableobject.h"
38 #include "signalproxy.h"
40 #include "ircchannel.h"
45 // TODO: ConnectionInfo to propagate and sync the current state of NetworkConnection, encodings etcpp
47 class Network : public SyncableObject
51 Q_ENUMS(ConnectionState)
53 Q_PROPERTY(QString networkName READ networkName WRITE setNetworkName STORED false)
54 Q_PROPERTY(QString currentServer READ currentServer WRITE setCurrentServer STORED false)
55 Q_PROPERTY(QString myNick READ myNick WRITE setMyNick STORED false)
56 Q_PROPERTY(int latency READ latency WRITE setLatency STORED false)
57 Q_PROPERTY(QByteArray codecForServer READ codecForServer WRITE setCodecForServer STORED false)
58 Q_PROPERTY(QByteArray codecForEncoding READ codecForEncoding WRITE setCodecForEncoding STORED false)
59 Q_PROPERTY(QByteArray codecForDecoding READ codecForDecoding WRITE setCodecForDecoding STORED false)
60 Q_PROPERTY(IdentityId identityId READ identity WRITE setIdentity STORED false)
61 Q_PROPERTY(bool isConnected READ isConnected WRITE setConnected STORED false)
62 //Q_PROPERTY(Network::ConnectionState connectionState READ connectionState WRITE setConnectionState STORED false)
63 Q_PROPERTY(int connectionState READ connectionState WRITE setConnectionState STORED false)
64 Q_PROPERTY(bool useRandomServer READ useRandomServer WRITE setUseRandomServer STORED false)
65 Q_PROPERTY(QStringList perform READ perform WRITE setPerform STORED false)
66 Q_PROPERTY(bool useAutoIdentify READ useAutoIdentify WRITE setUseAutoIdentify STORED false)
67 Q_PROPERTY(QString autoIdentifyService READ autoIdentifyService WRITE setAutoIdentifyService STORED false)
68 Q_PROPERTY(QString autoIdentifyPassword READ autoIdentifyPassword WRITE setAutoIdentifyPassword STORED false)
69 Q_PROPERTY(bool useSasl READ useSasl WRITE setUseSasl STORED false)
70 Q_PROPERTY(QString saslAccount READ saslAccount WRITE setSaslAccount STORED false)
71 Q_PROPERTY(QString saslPassword READ saslPassword WRITE setSaslPassword STORED false)
72 Q_PROPERTY(bool useAutoReconnect READ useAutoReconnect WRITE setUseAutoReconnect STORED false)
73 Q_PROPERTY(quint32 autoReconnectInterval READ autoReconnectInterval WRITE setAutoReconnectInterval STORED false)
74 Q_PROPERTY(quint16 autoReconnectRetries READ autoReconnectRetries WRITE setAutoReconnectRetries STORED false)
75 Q_PROPERTY(bool unlimitedReconnectRetries READ unlimitedReconnectRetries WRITE setUnlimitedReconnectRetries STORED false)
76 Q_PROPERTY(bool rejoinChannels READ rejoinChannels WRITE setRejoinChannels STORED false)
79 enum ConnectionState {
89 // http://www.irc.org/tech_docs/005.html
90 // http://www.irc.org/tech_docs/draft-brocklesby-irc-isupport-03.txt
91 enum ChannelModeType {
92 NOT_A_CHANMODE = 0x00,
113 Server() : port(6667), useSsl(false), sslVersion(0), useProxy(false), proxyType(QNetworkProxy::Socks5Proxy), proxyHost("localhost"), proxyPort(8080) {}
114 Server(const QString &host, uint port, const QString &password, bool useSsl)
115 : host(host), port(port), password(password), useSsl(useSsl), sslVersion(0),
116 useProxy(false), proxyType(QNetworkProxy::Socks5Proxy), proxyHost("localhost"), proxyPort(8080) {}
117 bool operator==(const Server &other) const;
118 bool operator!=(const Server &other) const;
120 typedef QList<Server> ServerList;
122 Network(const NetworkId &networkid, QObject *parent = 0);
125 inline NetworkId networkId() const { return _networkId; }
127 inline SignalProxy *proxy() const { return _proxy; }
128 inline void setProxy(SignalProxy *proxy) { _proxy = proxy; }
130 inline bool isMyNick(const QString &nick) const { return (myNick().toLower() == nick.toLower()); }
131 inline bool isMe(IrcUser *ircuser) const { return (ircuser->nick().toLower() == myNick().toLower()); }
133 bool isChannelName(const QString &channelname) const;
135 inline bool isConnected() const { return _connected; }
136 //Network::ConnectionState connectionState() const;
137 inline int connectionState() const { return _connectionState; }
139 QString prefixToMode(const QString &prefix) const;
140 inline QString prefixToMode(const QCharRef &prefix) const { return prefixToMode(QString(prefix)); }
141 QString modeToPrefix(const QString &mode) const;
142 inline QString modeToPrefix(const QCharRef &mode) const { return modeToPrefix(QString(mode)); }
144 ChannelModeType channelModeType(const QString &mode);
145 inline ChannelModeType channelModeType(const QCharRef &mode) { return channelModeType(QString(mode)); }
147 inline const QString &networkName() const { return _networkName; }
148 inline const QString ¤tServer() const { return _currentServer; }
149 inline const QString &myNick() const { return _myNick; }
150 inline int latency() const { return _latency; }
151 inline IrcUser *me() const { return ircUser(myNick()); }
152 inline IdentityId identity() const { return _identity; }
153 QStringList nicks() const;
154 inline QStringList channels() const { return _ircChannels.keys(); }
155 inline const ServerList &serverList() const { return _serverList; }
156 inline bool useRandomServer() const { return _useRandomServer; }
157 inline const QStringList &perform() const { return _perform; }
158 inline bool useAutoIdentify() const { return _useAutoIdentify; }
159 inline const QString &autoIdentifyService() const { return _autoIdentifyService; }
160 inline const QString &autoIdentifyPassword() const { return _autoIdentifyPassword; }
161 inline bool useSasl() const { return _useSasl; }
162 inline const QString &saslAccount() const { return _saslAccount; }
163 inline const QString &saslPassword() const { return _saslPassword; }
164 inline bool useAutoReconnect() const { return _useAutoReconnect; }
165 inline quint32 autoReconnectInterval() const { return _autoReconnectInterval; }
166 inline quint16 autoReconnectRetries() const { return _autoReconnectRetries; }
167 inline bool unlimitedReconnectRetries() const { return _unlimitedReconnectRetries; }
168 inline bool rejoinChannels() const { return _rejoinChannels; }
170 NetworkInfo networkInfo() const;
171 void setNetworkInfo(const NetworkInfo &);
173 QString prefixes() const;
174 QString prefixModes() const;
175 void determinePrefixes() const;
177 bool supports(const QString ¶m) const { return _supports.contains(param); }
178 QString support(const QString ¶m) const;
180 IrcUser *newIrcUser(const QString &hostmask, const QVariantMap &initData = QVariantMap());
181 inline IrcUser *newIrcUser(const QByteArray &hostmask) { return newIrcUser(decodeServerString(hostmask)); }
182 IrcUser *ircUser(QString nickname) const;
183 inline IrcUser *ircUser(const QByteArray &nickname) const { return ircUser(decodeServerString(nickname)); }
184 inline QList<IrcUser *> ircUsers() const { return _ircUsers.values(); }
185 inline quint32 ircUserCount() const { return _ircUsers.count(); }
187 IrcChannel *newIrcChannel(const QString &channelname, const QVariantMap &initData = QVariantMap());
188 inline IrcChannel *newIrcChannel(const QByteArray &channelname) { return newIrcChannel(decodeServerString(channelname)); }
189 IrcChannel *ircChannel(QString channelname) const;
190 inline IrcChannel *ircChannel(const QByteArray &channelname) const { return ircChannel(decodeServerString(channelname)); }
191 inline QList<IrcChannel *> ircChannels() const { return _ircChannels.values(); }
192 inline quint32 ircChannelCount() const { return _ircChannels.count(); }
194 QByteArray codecForServer() const;
195 QByteArray codecForEncoding() const;
196 QByteArray codecForDecoding() const;
197 void setCodecForServer(QTextCodec *codec);
198 void setCodecForEncoding(QTextCodec *codec);
199 void setCodecForDecoding(QTextCodec *codec);
201 QString decodeString(const QByteArray &text) const;
202 QByteArray encodeString(const QString &string) const;
203 QString decodeServerString(const QByteArray &text) const;
204 QByteArray encodeServerString(const QString &string) const;
206 static QByteArray defaultCodecForServer();
207 static QByteArray defaultCodecForEncoding();
208 static QByteArray defaultCodecForDecoding();
209 static void setDefaultCodecForServer(const QByteArray &name);
210 static void setDefaultCodecForEncoding(const QByteArray &name);
211 static void setDefaultCodecForDecoding(const QByteArray &name);
213 inline bool autoAwayActive() const { return _autoAwayActive; }
214 inline void setAutoAwayActive(bool active) { _autoAwayActive = active; }
216 static QStringList presetNetworks(bool onlyDefault = false);
217 static QStringList presetDefaultChannels(const QString &networkName);
218 static NetworkInfo networkInfoFromPreset(const QString &networkName);
221 void setNetworkName(const QString &networkName);
222 void setCurrentServer(const QString ¤tServer);
223 void setConnected(bool isConnected);
224 void setConnectionState(int state);
225 virtual void setMyNick(const QString &mynick);
226 void setLatency(int latency);
227 void setIdentity(IdentityId);
229 void setServerList(const QVariantList &serverList);
230 void setUseRandomServer(bool);
231 void setPerform(const QStringList &);
232 void setUseAutoIdentify(bool);
233 void setAutoIdentifyService(const QString &);
234 void setAutoIdentifyPassword(const QString &);
235 void setUseSasl(bool);
236 void setSaslAccount(const QString &);
237 void setSaslPassword(const QString &);
238 virtual void setUseAutoReconnect(bool);
239 virtual void setAutoReconnectInterval(quint32);
240 virtual void setAutoReconnectRetries(quint16);
241 void setUnlimitedReconnectRetries(bool);
242 void setRejoinChannels(bool);
244 void setCodecForServer(const QByteArray &codecName);
245 void setCodecForEncoding(const QByteArray &codecName);
246 void setCodecForDecoding(const QByteArray &codecName);
248 void addSupport(const QString ¶m, const QString &value = QString());
249 void removeSupport(const QString ¶m);
251 inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
252 inline void addIrcChannel(const QString &channel) { newIrcChannel(channel); }
255 QVariantMap initSupports() const;
256 inline QVariantList initServerList() const { return toVariantList(serverList()); }
257 virtual QVariantMap initIrcUsersAndChannels() const;
260 void initSetSupports(const QVariantMap &supports);
261 inline void initSetServerList(const QVariantList &serverList) { _serverList = fromVariantList<Server>(serverList); }
262 virtual void initSetIrcUsersAndChannels(const QVariantMap &usersAndChannels);
264 IrcUser *updateNickFromMask(const QString &mask);
266 // these slots are to keep the hashlists of all users and the
267 // channel lists up to date
268 void ircUserNickChanged(QString newnick);
270 virtual inline void requestConnect() const { REQUEST(NO_ARG) }
271 virtual inline void requestDisconnect() const { REQUEST(NO_ARG) }
272 virtual inline void requestSetNetworkInfo(const NetworkInfo &info) { REQUEST(ARG(info)) }
274 void emitConnectionError(const QString &);
277 virtual void removeIrcUser(IrcUser *ircuser);
278 virtual void removeIrcChannel(IrcChannel *ircChannel);
279 virtual void removeChansAndUsers();
282 void aboutToBeDestroyed();
283 void networkNameSet(const QString &networkName);
284 void currentServerSet(const QString ¤tServer);
285 void connectedSet(bool isConnected);
286 void connectionStateSet(Network::ConnectionState);
287 // void connectionStateSet(int);
288 void connectionError(const QString &errorMsg);
289 void myNickSet(const QString &mynick);
290 // void latencySet(int latency);
291 void identitySet(IdentityId);
293 void configChanged();
295 // void serverListSet(QVariantList serverList);
296 // void useRandomServerSet(bool);
297 // void performSet(const QStringList &);
298 // void useAutoIdentifySet(bool);
299 // void autoIdentifyServiceSet(const QString &);
300 // void autoIdentifyPasswordSet(const QString &);
301 // void useAutoReconnectSet(bool);
302 // void autoReconnectIntervalSet(quint32);
303 // void autoReconnectRetriesSet(quint16);
304 // void unlimitedReconnectRetriesSet(bool);
305 // void rejoinChannelsSet(bool);
307 // void codecForServerSet(const QByteArray &codecName);
308 // void codecForEncodingSet(const QByteArray &codecName);
309 // void codecForDecodingSet(const QByteArray &codecName);
311 // void supportAdded(const QString ¶m, const QString &value);
312 // void supportRemoved(const QString ¶m);
314 // void ircUserAdded(const QString &hostmask);
315 void ircUserAdded(IrcUser *);
316 // void ircChannelAdded(const QString &channelname);
317 void ircChannelAdded(IrcChannel *);
319 // void connectRequested() const;
320 // void disconnectRequested() const;
321 // void setNetworkInfoRequested(const NetworkInfo &) const;
324 inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new IrcChannel(channelname, this); }
325 inline virtual IrcUser *ircUserFactory(const QString &hostmask) { return new IrcUser(hostmask, this); }
328 QPointer<SignalProxy> _proxy;
330 NetworkId _networkId;
331 IdentityId _identity;
335 QString _networkName;
336 QString _currentServer;
338 ConnectionState _connectionState;
340 mutable QString _prefixes;
341 mutable QString _prefixModes;
343 QHash<QString, IrcUser *> _ircUsers; // stores all known nicks for the server
344 QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
345 QHash<QString, QString> _supports; // stores results from RPL_ISUPPORT
347 ServerList _serverList;
348 bool _useRandomServer;
349 QStringList _perform;
351 bool _useAutoIdentify;
352 QString _autoIdentifyService;
353 QString _autoIdentifyPassword;
356 QString _saslAccount;
357 QString _saslPassword;
359 bool _useAutoReconnect;
360 quint32 _autoReconnectInterval;
361 quint16 _autoReconnectRetries;
362 bool _unlimitedReconnectRetries;
363 bool _rejoinChannels;
365 QTextCodec *_codecForServer;
366 QTextCodec *_codecForEncoding;
367 QTextCodec *_codecForDecoding;
369 static QTextCodec *_defaultCodecForServer;
370 static QTextCodec *_defaultCodecForEncoding;
371 static QTextCodec *_defaultCodecForDecoding;
373 bool _autoAwayActive; // when this is active handle305 and handle306 don't trigger any output
375 static QString _networksIniPath;
377 friend class IrcUser;
378 friend class IrcChannel;
382 //! Stores all editable information about a network (as opposed to runtime state).
384 // set some default values, note that this does not initialize e.g. name and id
391 bool useCustomEncodings; // not used!
392 QByteArray codecForServer;
393 QByteArray codecForEncoding;
394 QByteArray codecForDecoding;
396 Network::ServerList serverList;
397 bool useRandomServer;
401 bool useAutoIdentify;
402 QString autoIdentifyService;
403 QString autoIdentifyPassword;
407 QString saslPassword;
409 bool useAutoReconnect;
410 quint32 autoReconnectInterval;
411 quint16 autoReconnectRetries;
412 bool unlimitedReconnectRetries;
415 bool operator==(const NetworkInfo &other) const;
416 bool operator!=(const NetworkInfo &other) const;
419 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
420 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
421 QDebug operator<<(QDebug dbg, const NetworkInfo &i);
422 Q_DECLARE_METATYPE(NetworkInfo)
424 QDataStream &operator<<(QDataStream &out, const Network::Server &server);
425 QDataStream &operator>>(QDataStream &in, Network::Server &server);
426 QDebug operator<<(QDebug dbg, const Network::Server &server);
427 Q_DECLARE_METATYPE(Network::Server)