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 inline IrcUser *me() const { return ircUser(myNick()); }
99 IdentityId identity() const;
100 QStringList nicks() const;
101 QStringList channels() const;
102 QVariantList serverList() const;
103 bool useRandomServer() const;
104 QStringList perform() const;
105 bool useAutoIdentify() const;
106 QString autoIdentifyService() const;
107 QString autoIdentifyPassword() const;
108 bool useAutoReconnect() const;
109 quint32 autoReconnectInterval() const;
110 quint16 autoReconnectRetries() const;
111 bool unlimitedReconnectRetries() const;
112 bool rejoinChannels() const;
114 NetworkInfo networkInfo() const;
115 void setNetworkInfo(const NetworkInfo &);
118 QString prefixModes();
120 bool supports(const QString ¶m) const;
121 QString support(const QString ¶m) const;
123 IrcUser *newIrcUser(const QString &hostmask);
124 IrcUser *newIrcUser(const QByteArray &hostmask);
125 IrcUser *ircUser(QString nickname) const;
126 IrcUser *ircUser(const QByteArray &nickname) const;
127 QList<IrcUser *> ircUsers() const;
128 quint32 ircUserCount() const;
130 IrcChannel *newIrcChannel(const QString &channelname);
131 IrcChannel *newIrcChannel(const QByteArray &channelname);
132 IrcChannel *ircChannel(QString channelname) const;
133 IrcChannel *ircChannel(const QByteArray &channelname) const;
134 QList<IrcChannel *> ircChannels() const;
135 quint32 ircChannelCount() const;
137 QByteArray codecForServer() const;
138 QByteArray codecForEncoding() const;
139 QByteArray codecForDecoding() const;
140 void setCodecForServer(QTextCodec *codec);
141 void setCodecForEncoding(QTextCodec *codec);
142 void setCodecForDecoding(QTextCodec *codec);
144 QString decodeString(const QByteArray &text) const;
145 QByteArray encodeString(const QString &string) const;
146 QString decodeServerString(const QByteArray &text) const;
147 QByteArray encodeServerString(const QString &string) const;
149 static QByteArray defaultCodecForServer();
150 static QByteArray defaultCodecForEncoding();
151 static QByteArray defaultCodecForDecoding();
152 static void setDefaultCodecForServer(const QByteArray &name);
153 static void setDefaultCodecForEncoding(const QByteArray &name);
154 static void setDefaultCodecForDecoding(const QByteArray &name);
157 void setNetworkName(const QString &networkName);
158 void setCurrentServer(const QString ¤tServer);
159 void setConnected(bool isConnected);
160 //void setConnectionState(Network::ConnectionState state);
161 void setConnectionState(int state);
162 void setMyNick(const QString &mynick);
163 void setIdentity(IdentityId);
165 void setServerList(const QVariantList &serverList);
166 void setUseRandomServer(bool);
167 void setPerform(const QStringList &);
168 void setUseAutoIdentify(bool);
169 void setAutoIdentifyService(const QString &);
170 void setAutoIdentifyPassword(const QString &);
171 void setUseAutoReconnect(bool);
172 void setAutoReconnectInterval(quint32);
173 void setAutoReconnectRetries(quint16);
174 void setUnlimitedReconnectRetries(bool);
175 void setRejoinChannels(bool);
177 void setCodecForServer(const QByteArray &codecName);
178 void setCodecForEncoding(const QByteArray &codecName);
179 void setCodecForDecoding(const QByteArray &codecName);
181 void addSupport(const QString ¶m, const QString &value = QString());
182 void removeSupport(const QString ¶m);
184 inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
185 inline void addIrcChannel(const QString &channel) { newIrcChannel(channel); }
186 void removeIrcUser(const QString &nick);
187 void removeIrcChannel(const QString &channel);
190 QVariantMap initSupports() const;
191 QVariantList initServerList() const;
192 QStringList initIrcUsers() const;
193 QStringList initIrcChannels() const;
196 void initSetSupports(const QVariantMap &supports);
197 void initSetServerList(const QVariantList &serverList);
198 void initSetIrcUsers(const QStringList &hostmasks);
199 void initSetIrcChannels(const QStringList &channels);
201 IrcUser *updateNickFromMask(const QString &mask);
203 // these slots are to keep the hashlists of all users and the
204 // channel lists up to date
205 void ircUserNickChanged(QString newnick);
207 void requestConnect() const;
208 void requestDisconnect() const;
210 void emitConnectionError(const QString &);
213 void ircUserDestroyed();
214 void channelDestroyed();
215 void removeIrcUser(IrcUser *ircuser);
216 void removeIrcChannel(IrcChannel *ircChannel);
217 void removeChansAndUsers();
218 void ircUserInitDone();
219 void ircChannelInitDone();
222 void aboutToBeDestroyed();
223 void networkNameSet(const QString &networkName);
224 void currentServerSet(const QString ¤tServer);
225 void connectedSet(bool isConnected);
226 void connectionStateSet(Network::ConnectionState);
227 void connectionStateSet(int);
228 void connectionError(const QString &errorMsg);
229 void myNickSet(const QString &mynick);
230 void identitySet(IdentityId);
232 void serverListSet(QVariantList serverList);
233 void useRandomServerSet(bool);
234 void performSet(const QStringList &);
235 void useAutoIdentifySet(bool);
236 void autoIdentifyServiceSet(const QString &);
237 void autoIdentifyPasswordSet(const QString &);
238 void useAutoReconnectSet(bool);
239 void autoReconnectIntervalSet(quint32);
240 void autoReconnectRetriesSet(quint16);
241 void unlimitedReconnectRetriesSet(bool);
242 void rejoinChannelsSet(bool);
244 void codecForServerSet(const QByteArray &codecName);
245 void codecForEncodingSet(const QByteArray &codecName);
246 void codecForDecodingSet(const QByteArray &codecName);
248 void supportAdded(const QString ¶m, const QString &value);
249 void supportRemoved(const QString ¶m);
251 void ircUserAdded(const QString &hostmask);
252 void ircUserAdded(IrcUser *);
253 void ircChannelAdded(const QString &channelname);
254 void ircChannelAdded(IrcChannel *);
256 void ircUserRemoved(const QString &nick);
257 void ircChannelRemoved(const QString &channel);
259 // needed for client sync progress
260 void ircUserRemoved(QObject *);
261 void ircChannelRemoved(QObject *);
263 void ircUserInitDone(IrcUser *);
264 void ircChannelInitDone(IrcChannel *);
266 void connectRequested(NetworkId id = 0) const;
267 void disconnectRequested(NetworkId id = 0) const;
270 QPointer<SignalProxy> _proxy;
272 NetworkId _networkId;
273 IdentityId _identity;
276 QString _networkName;
277 QString _currentServer;
279 ConnectionState _connectionState;
282 QString _prefixModes;
284 QHash<QString, IrcUser *> _ircUsers; // stores all known nicks for the server
285 QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
286 QHash<QString, QString> _supports; // stores results from RPL_ISUPPORT
288 QVariantList _serverList;
289 bool _useRandomServer;
290 QStringList _perform;
292 bool _useAutoIdentify;
293 QString _autoIdentifyService;
294 QString _autoIdentifyPassword;
296 bool _useAutoReconnect;
297 quint32 _autoReconnectInterval;
298 quint16 _autoReconnectRetries;
299 bool _unlimitedReconnectRetries;
300 bool _rejoinChannels;
302 void determinePrefixes();
304 QTextCodec *_codecForServer;
305 QTextCodec *_codecForEncoding;
306 QTextCodec *_codecForDecoding;
308 static QTextCodec *_defaultCodecForServer;
309 static QTextCodec *_defaultCodecForEncoding;
310 static QTextCodec *_defaultCodecForDecoding;
313 //! Stores all editable information about a network (as opposed to runtime state).
319 bool useCustomEncodings; // not used!
320 QByteArray codecForServer;
321 QByteArray codecForEncoding;
322 QByteArray codecForDecoding;
324 // Server entry: QString "Host", uint "Port", QString "Password", bool "UseSSL"
325 QVariantList serverList;
326 bool useRandomServer;
330 bool useAutoIdentify;
331 QString autoIdentifyService;
332 QString autoIdentifyPassword;
334 bool useAutoReconnect;
335 quint32 autoReconnectInterval;
336 quint16 autoReconnectRetries;
337 bool unlimitedReconnectRetries;
340 bool operator==(const NetworkInfo &other) const;
341 bool operator!=(const NetworkInfo &other) const;
344 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
345 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
346 QDebug operator<<(QDebug dbg, const NetworkInfo &i);
348 Q_DECLARE_METATYPE(NetworkInfo);