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 inline QHash<QString, QString> persistentChannels() const { return _persistentChannels; }
138 QByteArray codecForServer() const;
139 QByteArray codecForEncoding() const;
140 QByteArray codecForDecoding() const;
141 void setCodecForServer(QTextCodec *codec);
142 void setCodecForEncoding(QTextCodec *codec);
143 void setCodecForDecoding(QTextCodec *codec);
145 QString decodeString(const QByteArray &text) const;
146 QByteArray encodeString(const QString &string) const;
147 QString decodeServerString(const QByteArray &text) const;
148 QByteArray encodeServerString(const QString &string) const;
150 static QByteArray defaultCodecForServer();
151 static QByteArray defaultCodecForEncoding();
152 static QByteArray defaultCodecForDecoding();
153 static void setDefaultCodecForServer(const QByteArray &name);
154 static void setDefaultCodecForEncoding(const QByteArray &name);
155 static void setDefaultCodecForDecoding(const QByteArray &name);
158 void setNetworkName(const QString &networkName);
159 void setCurrentServer(const QString ¤tServer);
160 void setConnected(bool isConnected);
161 //void setConnectionState(Network::ConnectionState state);
162 void setConnectionState(int state);
163 void setMyNick(const QString &mynick);
164 void setIdentity(IdentityId);
166 void setServerList(const QVariantList &serverList);
167 void setUseRandomServer(bool);
168 void setPerform(const QStringList &);
169 void setUseAutoIdentify(bool);
170 void setAutoIdentifyService(const QString &);
171 void setAutoIdentifyPassword(const QString &);
172 void setUseAutoReconnect(bool);
173 void setAutoReconnectInterval(quint32);
174 void setAutoReconnectRetries(quint16);
175 void setUnlimitedReconnectRetries(bool);
176 void setRejoinChannels(bool);
178 void setCodecForServer(const QByteArray &codecName);
179 void setCodecForEncoding(const QByteArray &codecName);
180 void setCodecForDecoding(const QByteArray &codecName);
182 void addSupport(const QString ¶m, const QString &value = QString());
183 void removeSupport(const QString ¶m);
185 inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
186 void removeIrcUser(const QString &nick);
187 void removeIrcChannel(const QString &channel);
189 void addPersistentChannel(const QString &channel, const QString &key = QString());
190 void removePersistentChannel(const QString &channel);
191 void setPersistentChannelKey(const QString &channel, const QString &key);
194 QVariantMap initSupports() const;
195 QVariantList initServerList() const;
196 QStringList initIrcUsers() const;
197 QStringList initIrcChannels() const;
198 QStringList initPersistentChannels() const;
201 void initSetSupports(const QVariantMap &supports);
202 void initSetServerList(const QVariantList &serverList);
203 void initSetIrcUsers(const QStringList &hostmasks);
204 void initSetIrcChannels(const QStringList &channels);
205 void initSetPersistentChannels(const QStringList &channels);
207 IrcUser *updateNickFromMask(const QString &mask);
209 // these slots are to keep the hashlists of all users and the
210 // channel lists up to date
211 void ircUserNickChanged(QString newnick);
213 void requestConnect() const;
214 void requestDisconnect() const;
216 void emitConnectionError(const QString &);
219 void channelDestroyed();
220 void removeIrcUser(IrcUser *ircuser);
221 void removeIrcChannel(IrcChannel *ircChannel);
222 void removeChansAndUsers();
223 void ircUserInitDone();
224 void ircChannelInitDone();
227 void aboutToBeDestroyed();
228 void networkNameSet(const QString &networkName);
229 void currentServerSet(const QString ¤tServer);
230 void connectedSet(bool isConnected);
231 void connectionStateSet(Network::ConnectionState);
232 void connectionStateSet(int);
233 void connectionError(const QString &errorMsg);
234 void myNickSet(const QString &mynick);
235 void identitySet(IdentityId);
237 void serverListSet(QVariantList serverList);
238 void useRandomServerSet(bool);
239 void performSet(const QStringList &);
240 void useAutoIdentifySet(bool);
241 void autoIdentifyServiceSet(const QString &);
242 void autoIdentifyPasswordSet(const QString &);
243 void useAutoReconnectSet(bool);
244 void autoReconnectIntervalSet(quint32);
245 void autoReconnectRetriesSet(quint16);
246 void unlimitedReconnectRetriesSet(bool);
247 void rejoinChannelsSet(bool);
249 void codecForServerSet(const QByteArray &codecName);
250 void codecForEncodingSet(const QByteArray &codecName);
251 void codecForDecodingSet(const QByteArray &codecName);
253 void supportAdded(const QString ¶m, const QString &value);
254 void supportRemoved(const QString ¶m);
256 void ircUserAdded(const QString &hostmask);
257 void ircUserAdded(IrcUser *);
258 void ircChannelAdded(const QString &channelname);
259 void ircChannelAdded(IrcChannel *);
261 void ircUserRemoved(const QString &nick);
262 void ircChannelRemoved(const QString &channel);
264 void persistentChannelAdded(const QString &channel, const QString &key);
265 void persistentChannelRemoved(const QString &channel);
266 void persistentChannelKeySet(const QString &channel, const QString &key);
268 // needed for client sync progress
269 void ircUserRemoved(QObject *);
270 void ircChannelRemoved(QObject *);
272 void ircUserInitDone(IrcUser *);
273 void ircChannelInitDone(IrcChannel *);
275 void connectRequested(NetworkId id = 0) const;
276 void disconnectRequested(NetworkId id = 0) const;
279 QPointer<SignalProxy> _proxy;
281 NetworkId _networkId;
282 IdentityId _identity;
285 QString _networkName;
286 QString _currentServer;
288 ConnectionState _connectionState;
291 QString _prefixModes;
293 QHash<QString, IrcUser *> _ircUsers; // stores all known nicks for the server
294 QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
295 QHash<QString, QString> _supports; // stores results from RPL_ISUPPORT
296 QHash<QString, QString> _persistentChannels; // stores persistent channels and their passwords, if any
298 QVariantList _serverList;
299 bool _useRandomServer;
300 QStringList _perform;
302 bool _useAutoIdentify;
303 QString _autoIdentifyService;
304 QString _autoIdentifyPassword;
306 bool _useAutoReconnect;
307 quint32 _autoReconnectInterval;
308 quint16 _autoReconnectRetries;
309 bool _unlimitedReconnectRetries;
310 bool _rejoinChannels;
312 void determinePrefixes();
314 QTextCodec *_codecForServer;
315 QTextCodec *_codecForEncoding;
316 QTextCodec *_codecForDecoding;
318 static QTextCodec *_defaultCodecForServer;
319 static QTextCodec *_defaultCodecForEncoding;
320 static QTextCodec *_defaultCodecForDecoding;
323 //! Stores all editable information about a network (as opposed to runtime state).
329 bool useCustomEncodings; // not used!
330 QByteArray codecForServer;
331 QByteArray codecForEncoding;
332 QByteArray codecForDecoding;
334 // Server entry: QString "Host", uint "Port", QString "Password", bool "UseSSL"
335 QVariantList serverList;
336 bool useRandomServer;
340 bool useAutoIdentify;
341 QString autoIdentifyService;
342 QString autoIdentifyPassword;
344 bool useAutoReconnect;
345 quint32 autoReconnectInterval;
346 quint16 autoReconnectRetries;
347 bool unlimitedReconnectRetries;
350 bool operator==(const NetworkInfo &other) const;
351 bool operator!=(const NetworkInfo &other) const;
354 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
355 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
356 QDebug operator<<(QDebug dbg, const NetworkInfo &i);
358 Q_DECLARE_METATYPE(NetworkInfo);