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 ***************************************************************************/
26 #include <QStringList>
29 #include <QVariantMap>
34 #include "syncableobject.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 { Disconnected, Connecting, Initializing, Initialized, Reconnecting, Disconnecting };
73 Network(const NetworkId &networkid, QObject *parent = 0);
76 NetworkId networkId() const;
78 SignalProxy *proxy() const;
79 void setProxy(SignalProxy *proxy);
81 bool isMyNick(const QString &nick) const;
82 bool isMe(IrcUser *ircuser) const;
84 bool isChannelName(const QString &channelname) const;
86 bool isConnected() const;
87 //Network::ConnectionState connectionState() const;
88 int connectionState() const;
90 QString prefixToMode(const QString &prefix);
91 QString prefixToMode(const QCharRef &prefix);
92 QString modeToPrefix(const QString &mode);
93 QString modeToPrefix(const QCharRef &mode);
95 QString networkName() const;
96 QString currentServer() const;
97 QString myNick() const;
98 IdentityId identity() const;
99 QStringList nicks() const;
100 QStringList channels() const;
101 QVariantList serverList() const;
102 bool useRandomServer() const;
103 QStringList perform() const;
104 bool useAutoIdentify() const;
105 QString autoIdentifyService() const;
106 QString autoIdentifyPassword() const;
107 bool useAutoReconnect() const;
108 quint32 autoReconnectInterval() const;
109 quint16 autoReconnectRetries() const;
110 bool unlimitedReconnectRetries() const;
111 bool rejoinChannels() const;
113 NetworkInfo networkInfo() const;
114 void setNetworkInfo(const NetworkInfo &);
117 QString prefixModes();
119 bool supports(const QString ¶m) const;
120 QString support(const QString ¶m) const;
122 IrcUser *newIrcUser(const QString &hostmask);
123 IrcUser *newIrcUser(const QByteArray &hostmask);
124 IrcUser *ircUser(QString nickname) const;
125 IrcUser *ircUser(const QByteArray &nickname) const;
126 QList<IrcUser *> ircUsers() const;
127 quint32 ircUserCount() const;
129 IrcChannel *newIrcChannel(const QString &channelname);
130 IrcChannel *newIrcChannel(const QByteArray &channelname);
131 IrcChannel *ircChannel(QString channelname) const;
132 IrcChannel *ircChannel(const QByteArray &channelname) const;
133 QList<IrcChannel *> ircChannels() const;
134 quint32 ircChannelCount() const;
136 QByteArray codecForServer() const;
137 QByteArray codecForEncoding() const;
138 QByteArray codecForDecoding() const;
139 void setCodecForServer(QTextCodec *codec);
140 void setCodecForEncoding(QTextCodec *codec);
141 void setCodecForDecoding(QTextCodec *codec);
143 QString decodeString(const QByteArray &text) const;
144 QByteArray encodeString(const QString &string) const;
145 QString decodeServerString(const QByteArray &text) const;
146 QByteArray encodeServerString(const QString &string) const;
148 static QByteArray defaultCodecForServer();
149 static QByteArray defaultCodecForEncoding();
150 static QByteArray defaultCodecForDecoding();
151 static void setDefaultCodecForServer(const QByteArray &name);
152 static void setDefaultCodecForEncoding(const QByteArray &name);
153 static void setDefaultCodecForDecoding(const QByteArray &name);
156 void setNetworkName(const QString &networkName);
157 void setCurrentServer(const QString ¤tServer);
158 void setConnected(bool isConnected);
159 //void setConnectionState(Network::ConnectionState state);
160 void setConnectionState(int state);
161 void setMyNick(const QString &mynick);
162 void setIdentity(IdentityId);
164 void setServerList(const QVariantList &serverList);
165 void setUseRandomServer(bool);
166 void setPerform(const QStringList &);
167 void setUseAutoIdentify(bool);
168 void setAutoIdentifyService(const QString &);
169 void setAutoIdentifyPassword(const QString &);
170 void setUseAutoReconnect(bool);
171 void setAutoReconnectInterval(quint32);
172 void setAutoReconnectRetries(quint16);
173 void setUnlimitedReconnectRetries(bool);
174 void setRejoinChannels(bool);
176 void setCodecForServer(const QByteArray &codecName);
177 void setCodecForEncoding(const QByteArray &codecName);
178 void setCodecForDecoding(const QByteArray &codecName);
180 void addSupport(const QString ¶m, const QString &value = QString());
181 void removeSupport(const QString ¶m);
183 inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
184 void removeIrcUser(const QString &nick);
185 void removeIrcChannel(const QString &channel);
188 QVariantMap initSupports() const;
189 QVariantList initServerList() const;
190 QStringList initIrcUsers() const;
191 QStringList initIrcChannels() const;
194 void initSetSupports(const QVariantMap &supports);
195 void initSetServerList(const QVariantList &serverList);
196 void initSetIrcUsers(const QStringList &hostmasks);
197 void initSetIrcChannels(const QStringList &channels);
199 IrcUser *updateNickFromMask(const QString &mask);
201 // these slots are to keep the hashlists of all users and the
202 // channel lists up to date
203 void ircUserNickChanged(QString newnick);
205 void requestConnect() const;
206 void requestDisconnect() const;
208 void emitConnectionError(const QString &);
211 void ircUserDestroyed();
212 void channelDestroyed();
213 void removeIrcUser(IrcUser *ircuser);
214 void removeIrcChannel(IrcChannel *ircChannel);
215 void removeChansAndUsers();
216 void ircUserInitDone();
217 void ircChannelInitDone();
220 void aboutToBeDestroyed();
221 void networkNameSet(const QString &networkName);
222 void currentServerSet(const QString ¤tServer);
223 void connectedSet(bool isConnected);
224 void connectionStateSet(Network::ConnectionState);
225 void connectionStateSet(int);
226 void connectionError(const QString &errorMsg);
227 void myNickSet(const QString &mynick);
228 void identitySet(IdentityId);
230 void serverListSet(QVariantList serverList);
231 void useRandomServerSet(bool);
232 void performSet(const QStringList &);
233 void useAutoIdentifySet(bool);
234 void autoIdentifyServiceSet(const QString &);
235 void autoIdentifyPasswordSet(const QString &);
236 void useAutoReconnectSet(bool);
237 void autoReconnectIntervalSet(quint32);
238 void autoReconnectRetriesSet(quint16);
239 void unlimitedReconnectRetriesSet(bool);
240 void rejoinChannelsSet(bool);
242 void codecForServerSet(const QByteArray &codecName);
243 void codecForEncodingSet(const QByteArray &codecName);
244 void codecForDecodingSet(const QByteArray &codecName);
246 void supportAdded(const QString ¶m, const QString &value);
247 void supportRemoved(const QString ¶m);
249 void ircUserAdded(const QString &hostmask);
250 void ircUserAdded(IrcUser *);
251 void ircChannelAdded(const QString &channelname);
252 void ircChannelAdded(IrcChannel *);
254 void ircUserRemoved(const QString &nick);
255 void ircChannelRemoved(const QString &channel);
257 // needed for client sync progress
258 void ircUserRemoved(QObject *);
259 void ircChannelRemoved(QObject *);
261 void ircUserInitDone(IrcUser *);
262 void ircChannelInitDone(IrcChannel *);
264 void connectRequested(NetworkId id = 0) const;
265 void disconnectRequested(NetworkId id = 0) const;
268 QPointer<SignalProxy> _proxy;
270 NetworkId _networkId;
271 IdentityId _identity;
274 QString _networkName;
275 QString _currentServer;
277 ConnectionState _connectionState;
280 QString _prefixModes;
282 QHash<QString, IrcUser *> _ircUsers; // stores all known nicks for the server
283 QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
284 QHash<QString, QString> _supports; // stores results from RPL_ISUPPORT
286 QVariantList _serverList;
287 bool _useRandomServer;
288 QStringList _perform;
290 bool _useAutoIdentify;
291 QString _autoIdentifyService;
292 QString _autoIdentifyPassword;
294 bool _useAutoReconnect;
295 quint32 _autoReconnectInterval;
296 quint16 _autoReconnectRetries;
297 bool _unlimitedReconnectRetries;
298 bool _rejoinChannels;
300 void determinePrefixes();
302 QTextCodec *_codecForServer;
303 QTextCodec *_codecForEncoding;
304 QTextCodec *_codecForDecoding;
306 static QTextCodec *_defaultCodecForServer;
307 static QTextCodec *_defaultCodecForEncoding;
308 static QTextCodec *_defaultCodecForDecoding;
311 //! Stores all editable information about a network (as opposed to runtime state).
317 bool useCustomEncodings; // not used!
318 QByteArray codecForServer;
319 QByteArray codecForEncoding;
320 QByteArray codecForDecoding;
322 // Server entry: QString "Host", uint "Port", QString "Password", bool "UseSSL"
323 QVariantList serverList;
324 bool useRandomServer;
328 bool useAutoIdentify;
329 QString autoIdentifyService;
330 QString autoIdentifyPassword;
332 bool useAutoReconnect;
333 quint32 autoReconnectInterval;
334 quint16 autoReconnectRetries;
335 bool unlimitedReconnectRetries;
338 bool operator==(const NetworkInfo &other) const;
339 bool operator!=(const NetworkInfo &other) const;
342 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
343 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
344 QDebug operator<<(QDebug dbg, const NetworkInfo &i);
346 Q_DECLARE_METATYPE(NetworkInfo);