1 /***************************************************************************
2 * Copyright (C) 2005-2018 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)
54 Q_PROPERTY(QString currentServer READ currentServer WRITE setCurrentServer)
55 Q_PROPERTY(QString myNick READ myNick WRITE setMyNick)
56 Q_PROPERTY(int latency READ latency WRITE setLatency)
57 Q_PROPERTY(QByteArray codecForServer READ codecForServer WRITE setCodecForServer)
58 Q_PROPERTY(QByteArray codecForEncoding READ codecForEncoding WRITE setCodecForEncoding)
59 Q_PROPERTY(QByteArray codecForDecoding READ codecForDecoding WRITE setCodecForDecoding)
60 Q_PROPERTY(IdentityId identityId READ identity WRITE setIdentity)
61 Q_PROPERTY(bool isConnected READ isConnected WRITE setConnected)
62 //Q_PROPERTY(Network::ConnectionState connectionState READ connectionState WRITE setConnectionState)
63 Q_PROPERTY(int connectionState READ connectionState WRITE setConnectionState)
64 Q_PROPERTY(bool useRandomServer READ useRandomServer WRITE setUseRandomServer)
65 Q_PROPERTY(QStringList perform READ perform WRITE setPerform)
66 Q_PROPERTY(bool useAutoIdentify READ useAutoIdentify WRITE setUseAutoIdentify)
67 Q_PROPERTY(QString autoIdentifyService READ autoIdentifyService WRITE setAutoIdentifyService)
68 Q_PROPERTY(QString autoIdentifyPassword READ autoIdentifyPassword WRITE setAutoIdentifyPassword)
69 Q_PROPERTY(bool useSasl READ useSasl WRITE setUseSasl)
70 Q_PROPERTY(QString saslAccount READ saslAccount WRITE setSaslAccount)
71 Q_PROPERTY(QString saslPassword READ saslPassword WRITE setSaslPassword)
72 Q_PROPERTY(bool useAutoReconnect READ useAutoReconnect WRITE setUseAutoReconnect)
73 Q_PROPERTY(quint32 autoReconnectInterval READ autoReconnectInterval WRITE setAutoReconnectInterval)
74 Q_PROPERTY(quint16 autoReconnectRetries READ autoReconnectRetries WRITE setAutoReconnectRetries)
75 Q_PROPERTY(bool unlimitedReconnectRetries READ unlimitedReconnectRetries WRITE setUnlimitedReconnectRetries)
76 Q_PROPERTY(bool rejoinChannels READ rejoinChannels WRITE setRejoinChannels)
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;
136 * Checks if the target counts as a STATUSMSG
138 * Status messages are prefixed with one or more characters from the server-provided STATUSMSG
139 * if available, otherwise "@" and "+" are assumed. Generally, status messages sent to a
140 * channel are only visible to those with the same or higher permissions, e.g. voiced.
142 * @param[in] target Name of destination, e.g. a channel or query
143 * @returns True if a STATUSMSG, otherwise false
145 bool isStatusMsg(const QString &target) const;
147 inline bool isConnected() const { return _connected; }
148 //Network::ConnectionState connectionState() const;
149 inline int connectionState() const { return _connectionState; }
151 QString prefixToMode(const QString &prefix) const;
152 inline QString prefixToMode(const QCharRef &prefix) const { return prefixToMode(QString(prefix)); }
153 QString modeToPrefix(const QString &mode) const;
154 inline QString modeToPrefix(const QCharRef &mode) const { return modeToPrefix(QString(mode)); }
156 ChannelModeType channelModeType(const QString &mode);
157 inline ChannelModeType channelModeType(const QCharRef &mode) { return channelModeType(QString(mode)); }
159 inline const QString &networkName() const { return _networkName; }
160 inline const QString ¤tServer() const { return _currentServer; }
161 inline const QString &myNick() const { return _myNick; }
162 inline int latency() const { return _latency; }
163 inline IrcUser *me() const { return ircUser(myNick()); }
164 inline IdentityId identity() const { return _identity; }
165 QStringList nicks() const;
166 inline QStringList channels() const { return _ircChannels.keys(); }
167 inline const ServerList &serverList() const { return _serverList; }
168 inline bool useRandomServer() const { return _useRandomServer; }
169 inline const QStringList &perform() const { return _perform; }
170 inline bool useAutoIdentify() const { return _useAutoIdentify; }
171 inline const QString &autoIdentifyService() const { return _autoIdentifyService; }
172 inline const QString &autoIdentifyPassword() const { return _autoIdentifyPassword; }
173 inline bool useSasl() const { return _useSasl; }
174 inline const QString &saslAccount() const { return _saslAccount; }
175 inline const QString &saslPassword() const { return _saslPassword; }
176 inline bool useAutoReconnect() const { return _useAutoReconnect; }
177 inline quint32 autoReconnectInterval() const { return _autoReconnectInterval; }
178 inline quint16 autoReconnectRetries() const { return _autoReconnectRetries; }
179 inline bool unlimitedReconnectRetries() const { return _unlimitedReconnectRetries; }
180 inline bool rejoinChannels() const { return _rejoinChannels; }
182 NetworkInfo networkInfo() const;
183 void setNetworkInfo(const NetworkInfo &);
185 QString prefixes() const;
186 QString prefixModes() const;
187 void determinePrefixes() const;
189 bool supports(const QString ¶m) const { return _supports.contains(param); }
190 QString support(const QString ¶m) const;
192 IrcUser *newIrcUser(const QString &hostmask, const QVariantMap &initData = QVariantMap());
193 inline IrcUser *newIrcUser(const QByteArray &hostmask) { return newIrcUser(decodeServerString(hostmask)); }
194 IrcUser *ircUser(QString nickname) const;
195 inline IrcUser *ircUser(const QByteArray &nickname) const { return ircUser(decodeServerString(nickname)); }
196 inline QList<IrcUser *> ircUsers() const { return _ircUsers.values(); }
197 inline quint32 ircUserCount() const { return _ircUsers.count(); }
199 IrcChannel *newIrcChannel(const QString &channelname, const QVariantMap &initData = QVariantMap());
200 inline IrcChannel *newIrcChannel(const QByteArray &channelname) { return newIrcChannel(decodeServerString(channelname)); }
201 IrcChannel *ircChannel(QString channelname) const;
202 inline IrcChannel *ircChannel(const QByteArray &channelname) const { return ircChannel(decodeServerString(channelname)); }
203 inline QList<IrcChannel *> ircChannels() const { return _ircChannels.values(); }
204 inline quint32 ircChannelCount() const { return _ircChannels.count(); }
206 QByteArray codecForServer() const;
207 QByteArray codecForEncoding() const;
208 QByteArray codecForDecoding() const;
209 void setCodecForServer(QTextCodec *codec);
210 void setCodecForEncoding(QTextCodec *codec);
211 void setCodecForDecoding(QTextCodec *codec);
213 QString decodeString(const QByteArray &text) const;
214 QByteArray encodeString(const QString &string) const;
215 QString decodeServerString(const QByteArray &text) const;
216 QByteArray encodeServerString(const QString &string) const;
218 static QByteArray defaultCodecForServer();
219 static QByteArray defaultCodecForEncoding();
220 static QByteArray defaultCodecForDecoding();
221 static void setDefaultCodecForServer(const QByteArray &name);
222 static void setDefaultCodecForEncoding(const QByteArray &name);
223 static void setDefaultCodecForDecoding(const QByteArray &name);
225 inline bool autoAwayActive() const { return _autoAwayActive; }
226 inline void setAutoAwayActive(bool active) { _autoAwayActive = active; }
229 void setNetworkName(const QString &networkName);
230 void setCurrentServer(const QString ¤tServer);
231 void setConnected(bool isConnected);
232 void setConnectionState(int state);
233 virtual void setMyNick(const QString &mynick);
234 void setLatency(int latency);
235 void setIdentity(IdentityId);
237 void setServerList(const QVariantList &serverList);
238 void setUseRandomServer(bool);
239 void setPerform(const QStringList &);
240 void setUseAutoIdentify(bool);
241 void setAutoIdentifyService(const QString &);
242 void setAutoIdentifyPassword(const QString &);
243 void setUseSasl(bool);
244 void setSaslAccount(const QString &);
245 void setSaslPassword(const QString &);
246 virtual void setUseAutoReconnect(bool);
247 virtual void setAutoReconnectInterval(quint32);
248 virtual void setAutoReconnectRetries(quint16);
249 void setUnlimitedReconnectRetries(bool);
250 void setRejoinChannels(bool);
252 void setCodecForServer(const QByteArray &codecName);
253 void setCodecForEncoding(const QByteArray &codecName);
254 void setCodecForDecoding(const QByteArray &codecName);
256 void addSupport(const QString ¶m, const QString &value = QString());
257 void removeSupport(const QString ¶m);
259 inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
260 inline void addIrcChannel(const QString &channel) { newIrcChannel(channel); }
263 QVariantMap initSupports() const;
264 inline QVariantList initServerList() const { return toVariantList(serverList()); }
265 virtual QVariantMap initIrcUsersAndChannels() const;
268 void initSetSupports(const QVariantMap &supports);
269 inline void initSetServerList(const QVariantList &serverList) { _serverList = fromVariantList<Server>(serverList); }
270 virtual void initSetIrcUsersAndChannels(const QVariantMap &usersAndChannels);
273 * Update IrcUser hostmask and username from mask, creating an IrcUser if one does not exist.
275 * @param[in] mask Full nick!user@hostmask string
276 * @return IrcUser of the matching nick if exists, otherwise a new IrcUser
278 IrcUser *updateNickFromMask(const QString &mask);
280 // these slots are to keep the hashlists of all users and the
281 // channel lists up to date
282 void ircUserNickChanged(QString newnick);
284 virtual inline void requestConnect() const { REQUEST(NO_ARG) }
285 virtual inline void requestDisconnect() const { REQUEST(NO_ARG) }
286 virtual inline void requestSetNetworkInfo(const NetworkInfo &info) { REQUEST(ARG(info)) }
288 void emitConnectionError(const QString &);
291 virtual void removeIrcUser(IrcUser *ircuser);
292 virtual void removeIrcChannel(IrcChannel *ircChannel);
293 virtual void removeChansAndUsers();
296 void aboutToBeDestroyed();
297 void networkNameSet(const QString &networkName);
298 void currentServerSet(const QString ¤tServer);
299 void connectedSet(bool isConnected);
300 void connectionStateSet(Network::ConnectionState);
301 // void connectionStateSet(int);
302 void connectionError(const QString &errorMsg);
303 void myNickSet(const QString &mynick);
304 // void latencySet(int latency);
305 void identitySet(IdentityId);
307 void configChanged();
309 // void serverListSet(QVariantList serverList);
310 // void useRandomServerSet(bool);
311 // void performSet(const QStringList &);
312 // void useAutoIdentifySet(bool);
313 // void autoIdentifyServiceSet(const QString &);
314 // void autoIdentifyPasswordSet(const QString &);
315 // void useAutoReconnectSet(bool);
316 // void autoReconnectIntervalSet(quint32);
317 // void autoReconnectRetriesSet(quint16);
318 // void unlimitedReconnectRetriesSet(bool);
319 // void rejoinChannelsSet(bool);
321 // void codecForServerSet(const QByteArray &codecName);
322 // void codecForEncodingSet(const QByteArray &codecName);
323 // void codecForDecodingSet(const QByteArray &codecName);
325 // void supportAdded(const QString ¶m, const QString &value);
326 // void supportRemoved(const QString ¶m);
328 // void ircUserAdded(const QString &hostmask);
329 void ircUserAdded(IrcUser *);
330 // void ircChannelAdded(const QString &channelname);
331 void ircChannelAdded(IrcChannel *);
333 // void connectRequested() const;
334 // void disconnectRequested() const;
335 // void setNetworkInfoRequested(const NetworkInfo &) const;
338 inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new IrcChannel(channelname, this); }
339 inline virtual IrcUser *ircUserFactory(const QString &hostmask) { return new IrcUser(hostmask, this); }
342 QPointer<SignalProxy> _proxy;
344 NetworkId _networkId;
345 IdentityId _identity;
349 QString _networkName;
350 QString _currentServer;
352 ConnectionState _connectionState;
354 mutable QString _prefixes;
355 mutable QString _prefixModes;
357 QHash<QString, IrcUser *> _ircUsers; // stores all known nicks for the server
358 QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
359 QHash<QString, QString> _supports; // stores results from RPL_ISUPPORT
361 ServerList _serverList;
362 bool _useRandomServer;
363 QStringList _perform;
365 bool _useAutoIdentify;
366 QString _autoIdentifyService;
367 QString _autoIdentifyPassword;
370 QString _saslAccount;
371 QString _saslPassword;
373 bool _useAutoReconnect;
374 quint32 _autoReconnectInterval;
375 quint16 _autoReconnectRetries;
376 bool _unlimitedReconnectRetries;
377 bool _rejoinChannels;
379 QTextCodec *_codecForServer;
380 QTextCodec *_codecForEncoding;
381 QTextCodec *_codecForDecoding;
383 static QTextCodec *_defaultCodecForServer;
384 static QTextCodec *_defaultCodecForEncoding;
385 static QTextCodec *_defaultCodecForDecoding;
387 bool _autoAwayActive; // when this is active handle305 and handle306 don't trigger any output
389 friend class IrcUser;
390 friend class IrcChannel;
394 //! Stores all editable information about a network (as opposed to runtime state).
396 // set some default values, note that this does not initialize e.g. name and id
403 bool useCustomEncodings; // not used!
404 QByteArray codecForServer;
405 QByteArray codecForEncoding;
406 QByteArray codecForDecoding;
408 Network::ServerList serverList;
409 bool useRandomServer;
413 bool useAutoIdentify;
414 QString autoIdentifyService;
415 QString autoIdentifyPassword;
419 QString saslPassword;
421 bool useAutoReconnect;
422 quint32 autoReconnectInterval;
423 quint16 autoReconnectRetries;
424 bool unlimitedReconnectRetries;
427 bool operator==(const NetworkInfo &other) const;
428 bool operator!=(const NetworkInfo &other) const;
431 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
432 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
433 QDebug operator<<(QDebug dbg, const NetworkInfo &i);
434 Q_DECLARE_METATYPE(NetworkInfo)
436 QDataStream &operator<<(QDataStream &out, const Network::Server &server);
437 QDataStream &operator>>(QDataStream &in, Network::Server &server);
438 QDebug operator<<(QDebug dbg, const Network::Server &server);
439 Q_DECLARE_METATYPE(Network::Server)