1 /***************************************************************************
2 * Copyright (C) 2005-08 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>
28 #include <QVariantMap>
33 #include "syncableobject.h"
35 #include "signalproxy.h"
36 #include "ircchannel.h"
43 // TODO: ConnectionInfo to propagate and sync the current state of NetworkConnection, encodings etcpp
45 class Network : public SyncableObject {
47 Q_ENUMS(ConnectionState Network::ConnectionState)
49 Q_PROPERTY(QString networkName READ networkName WRITE setNetworkName STORED false)
50 Q_PROPERTY(QString currentServer READ currentServer WRITE setCurrentServer STORED false)
51 Q_PROPERTY(QString myNick READ myNick WRITE setMyNick STORED false)
52 Q_PROPERTY(QByteArray codecForServer READ codecForServer WRITE setCodecForServer STORED false)
53 Q_PROPERTY(QByteArray codecForEncoding READ codecForEncoding WRITE setCodecForEncoding STORED false)
54 Q_PROPERTY(QByteArray codecForDecoding READ codecForDecoding WRITE setCodecForDecoding STORED false)
55 Q_PROPERTY(IdentityId identityId READ identity WRITE setIdentity STORED false)
56 Q_PROPERTY(bool isConnected READ isConnected WRITE setConnected STORED false)
57 //Q_PROPERTY(Network::ConnectionState connectionState READ connectionState WRITE setConnectionState STORED false)
58 Q_PROPERTY(int connectionState READ connectionState WRITE setConnectionState STORED false)
59 Q_PROPERTY(bool useRandomServer READ useRandomServer WRITE setUseRandomServer STORED false)
60 Q_PROPERTY(QStringList perform READ perform WRITE setPerform STORED false)
61 Q_PROPERTY(bool useAutoIdentify READ useAutoIdentify WRITE setUseAutoIdentify STORED false)
62 Q_PROPERTY(QString autoIdentifyService READ autoIdentifyService WRITE setAutoIdentifyService STORED false)
63 Q_PROPERTY(QString autoIdentifyPassword READ autoIdentifyPassword WRITE setAutoIdentifyPassword STORED false)
64 Q_PROPERTY(bool useAutoReconnect READ useAutoReconnect WRITE setUseAutoReconnect STORED false)
65 Q_PROPERTY(quint32 autoReconnectInterval READ autoReconnectInterval WRITE setAutoReconnectInterval STORED false)
66 Q_PROPERTY(quint16 autoReconnectRetries READ autoReconnectRetries WRITE setAutoReconnectRetries STORED false)
67 Q_PROPERTY(bool unlimitedReconnectRetries READ unlimitedReconnectRetries WRITE setUnlimitedReconnectRetries STORED false)
68 Q_PROPERTY(bool rejoinChannels READ rejoinChannels WRITE setRejoinChannels STORED false)
71 enum ConnectionState {
81 // http://www.irc.org/tech_docs/005.html
82 // http://www.irc.org/tech_docs/draft-brocklesby-irc-isupport-03.txt
83 enum ChannelModeType {
84 NOT_A_CHANMODE = 0x00,
92 Network(const NetworkId &networkid, QObject *parent = 0);
95 inline NetworkId networkId() const { return _networkId; }
97 inline SignalProxy *proxy() const { return _proxy; }
98 inline void setProxy(SignalProxy *proxy) { _proxy = proxy; }
100 inline bool isMyNick(const QString &nick) const { return (myNick().toLower() == nick.toLower()); }
101 inline bool isMe(IrcUser *ircuser) const { return (ircuser == me()); }
103 bool isChannelName(const QString &channelname) const;
105 inline bool isConnected() const { return _connected; }
106 //Network::ConnectionState connectionState() const;
107 inline int connectionState() const { return _connectionState; }
109 QString prefixToMode(const QString &prefix);
110 inline QString prefixToMode(const QCharRef &prefix) { return prefixToMode(QString(prefix)); }
111 QString modeToPrefix(const QString &mode);
112 inline QString modeToPrefix(const QCharRef &mode) { return modeToPrefix(QString(mode)); }
114 ChannelModeType channelModeType(const QString &mode);
115 inline ChannelModeType channelModeType(const QCharRef &mode) { return channelModeType(QString(mode)); }
117 inline const QString &networkName() const { return _networkName; }
118 inline const QString ¤tServer() const { return _currentServer; }
119 inline const QString &myNick() const { return _myNick; }
120 inline IrcUser *me() const { return ircUser(myNick()); }
121 inline IdentityId identity() const { return _identity; }
122 QStringList nicks() const;
123 inline QStringList channels() const { return _ircChannels.keys(); }
124 inline const QVariantList &serverList() const { return _serverList; }
125 inline bool useRandomServer() const { return _useRandomServer; }
126 inline const QStringList &perform() const { return _perform; }
127 inline bool useAutoIdentify() const { return _useAutoIdentify; }
128 inline const QString &autoIdentifyService() const { return _autoIdentifyService; }
129 inline const QString &autoIdentifyPassword() const { return _autoIdentifyPassword; }
130 inline bool useAutoReconnect() const { return _useAutoReconnect; }
131 inline quint32 autoReconnectInterval() const { return _autoReconnectInterval; }
132 inline quint16 autoReconnectRetries() const { return _autoReconnectRetries; }
133 inline bool unlimitedReconnectRetries() const { return _unlimitedReconnectRetries; }
134 inline bool rejoinChannels() const { return _rejoinChannels; }
136 NetworkInfo networkInfo() const;
137 void setNetworkInfo(const NetworkInfo &);
140 QString prefixModes();
142 bool supports(const QString ¶m) const { return _supports.contains(param); }
143 QString support(const QString ¶m) const;
145 IrcUser *newIrcUser(const QString &hostmask);
146 inline IrcUser *newIrcUser(const QByteArray &hostmask) { return newIrcUser(decodeServerString(hostmask)); }
147 IrcUser *ircUser(QString nickname) const;
148 inline IrcUser *ircUser(const QByteArray &nickname) const { return ircUser(decodeServerString(nickname)); }
149 inline QList<IrcUser *> ircUsers() const { return _ircUsers.values(); }
150 inline quint32 ircUserCount() const { return _ircUsers.count(); }
152 IrcChannel *newIrcChannel(const QString &channelname);
153 inline IrcChannel *newIrcChannel(const QByteArray &channelname) { return newIrcChannel(decodeServerString(channelname)); }
154 IrcChannel *ircChannel(QString channelname) const;
155 inline IrcChannel *ircChannel(const QByteArray &channelname) const { return ircChannel(decodeServerString(channelname)); }
156 inline QList<IrcChannel *> ircChannels() const { return _ircChannels.values(); }
157 inline quint32 ircChannelCount() const { return _ircChannels.count(); }
159 QByteArray codecForServer() const;
160 QByteArray codecForEncoding() const;
161 QByteArray codecForDecoding() const;
162 void setCodecForServer(QTextCodec *codec);
163 void setCodecForEncoding(QTextCodec *codec);
164 void setCodecForDecoding(QTextCodec *codec);
166 QString decodeString(const QByteArray &text) const;
167 QByteArray encodeString(const QString &string) const;
168 QString decodeServerString(const QByteArray &text) const;
169 QByteArray encodeServerString(const QString &string) const;
171 static QByteArray defaultCodecForServer();
172 static QByteArray defaultCodecForEncoding();
173 static QByteArray defaultCodecForDecoding();
174 static void setDefaultCodecForServer(const QByteArray &name);
175 static void setDefaultCodecForEncoding(const QByteArray &name);
176 static void setDefaultCodecForDecoding(const QByteArray &name);
179 void setNetworkName(const QString &networkName);
180 void setCurrentServer(const QString ¤tServer);
181 void setConnected(bool isConnected);
182 //void setConnectionState(Network::ConnectionState state);
183 void setConnectionState(int state);
184 void setMyNick(const QString &mynick);
185 void setIdentity(IdentityId);
187 void setServerList(const QVariantList &serverList);
188 void setUseRandomServer(bool);
189 void setPerform(const QStringList &);
190 void setUseAutoIdentify(bool);
191 void setAutoIdentifyService(const QString &);
192 void setAutoIdentifyPassword(const QString &);
193 void setUseAutoReconnect(bool);
194 void setAutoReconnectInterval(quint32);
195 void setAutoReconnectRetries(quint16);
196 void setUnlimitedReconnectRetries(bool);
197 void setRejoinChannels(bool);
199 void setCodecForServer(const QByteArray &codecName);
200 void setCodecForEncoding(const QByteArray &codecName);
201 void setCodecForDecoding(const QByteArray &codecName);
203 void addSupport(const QString ¶m, const QString &value = QString());
204 void removeSupport(const QString ¶m);
206 inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
207 inline void addIrcChannel(const QString &channel) { newIrcChannel(channel); }
208 void removeIrcUser(const QString &nick);
209 void removeIrcChannel(const QString &channel);
212 QVariantMap initSupports() const;
213 inline QVariantList initServerList() const { return serverList(); }
214 QStringList initIrcUsers() const;
215 QStringList initIrcChannels() const;
218 void initSetSupports(const QVariantMap &supports);
219 inline void initSetServerList(const QVariantList &serverList) { setServerList(serverList); }
220 void initSetIrcUsers(const QStringList &hostmasks);
221 void initSetIrcChannels(const QStringList &channels);
223 IrcUser *updateNickFromMask(const QString &mask);
225 // these slots are to keep the hashlists of all users and the
226 // channel lists up to date
227 void ircUserNickChanged(QString newnick);
229 virtual inline void requestConnect() const { emit connectRequested(); }
230 virtual inline void requestDisconnect() const { emit disconnectRequested(); }
232 void emitConnectionError(const QString &);
235 void ircUserDestroyed();
236 void channelDestroyed();
237 void removeIrcUser(IrcUser *ircuser);
238 void removeIrcChannel(IrcChannel *ircChannel);
239 void removeChansAndUsers();
240 void ircUserInitDone();
241 void ircChannelInitDone();
244 void aboutToBeDestroyed();
245 void networkNameSet(const QString &networkName);
246 void currentServerSet(const QString ¤tServer);
247 void connectedSet(bool isConnected);
248 void connectionStateSet(Network::ConnectionState);
249 void connectionStateSet(int);
250 void connectionError(const QString &errorMsg);
251 void myNickSet(const QString &mynick);
252 void identitySet(IdentityId);
254 void serverListSet(QVariantList serverList);
255 void useRandomServerSet(bool);
256 void performSet(const QStringList &);
257 void useAutoIdentifySet(bool);
258 void autoIdentifyServiceSet(const QString &);
259 void autoIdentifyPasswordSet(const QString &);
260 void useAutoReconnectSet(bool);
261 void autoReconnectIntervalSet(quint32);
262 void autoReconnectRetriesSet(quint16);
263 void unlimitedReconnectRetriesSet(bool);
264 void rejoinChannelsSet(bool);
266 void codecForServerSet(const QByteArray &codecName);
267 void codecForEncodingSet(const QByteArray &codecName);
268 void codecForDecodingSet(const QByteArray &codecName);
270 void supportAdded(const QString ¶m, const QString &value);
271 void supportRemoved(const QString ¶m);
273 void ircUserAdded(const QString &hostmask);
274 void ircUserAdded(IrcUser *);
275 void ircChannelAdded(const QString &channelname);
276 void ircChannelAdded(IrcChannel *);
278 void ircUserRemoved(const QString &nick);
279 void ircChannelRemoved(const QString &channel);
281 // needed for client sync progress
282 void ircUserRemoved(QObject *);
283 void ircChannelRemoved(QObject *);
285 void ircUserInitDone(IrcUser *);
286 void ircChannelInitDone(IrcChannel *);
288 void connectRequested(NetworkId id = 0) const;
289 void disconnectRequested(NetworkId id = 0) const;
292 QPointer<SignalProxy> _proxy;
294 NetworkId _networkId;
295 IdentityId _identity;
298 QString _networkName;
299 QString _currentServer;
301 ConnectionState _connectionState;
304 QString _prefixModes;
306 QHash<QString, IrcUser *> _ircUsers; // stores all known nicks for the server
307 QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
308 QHash<QString, QString> _supports; // stores results from RPL_ISUPPORT
310 QVariantList _serverList;
311 bool _useRandomServer;
312 QStringList _perform;
314 bool _useAutoIdentify;
315 QString _autoIdentifyService;
316 QString _autoIdentifyPassword;
318 bool _useAutoReconnect;
319 quint32 _autoReconnectInterval;
320 quint16 _autoReconnectRetries;
321 bool _unlimitedReconnectRetries;
322 bool _rejoinChannels;
324 void determinePrefixes();
326 QTextCodec *_codecForServer;
327 QTextCodec *_codecForEncoding;
328 QTextCodec *_codecForDecoding;
330 static QTextCodec *_defaultCodecForServer;
331 static QTextCodec *_defaultCodecForEncoding;
332 static QTextCodec *_defaultCodecForDecoding;
335 //! Stores all editable information about a network (as opposed to runtime state).
341 bool useCustomEncodings; // not used!
342 QByteArray codecForServer;
343 QByteArray codecForEncoding;
344 QByteArray codecForDecoding;
346 // Server entry: QString "Host", uint "Port", QString "Password", bool "UseSSL"
347 QVariantList serverList;
348 bool useRandomServer;
352 bool useAutoIdentify;
353 QString autoIdentifyService;
354 QString autoIdentifyPassword;
356 bool useAutoReconnect;
357 quint32 autoReconnectInterval;
358 quint16 autoReconnectRetries;
359 bool unlimitedReconnectRetries;
362 bool operator==(const NetworkInfo &other) const;
363 bool operator!=(const NetworkInfo &other) const;
366 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
367 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
368 QDebug operator<<(QDebug dbg, const NetworkInfo &i);
370 Q_DECLARE_METATYPE(NetworkInfo);