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"
37 #include "ircchannel.h"
42 // TODO: ConnectionInfo to propagate and sync the current state of NetworkConnection, encodings etcpp
44 class Network : public SyncableObject {
46 Q_ENUMS(ConnectionState Network::ConnectionState)
48 Q_PROPERTY(QString networkName READ networkName WRITE setNetworkName STORED false)
49 Q_PROPERTY(QString currentServer READ currentServer WRITE setCurrentServer STORED false)
50 Q_PROPERTY(QString myNick READ myNick WRITE setMyNick STORED false)
51 Q_PROPERTY(QByteArray codecForServer READ codecForServer WRITE setCodecForServer STORED false)
52 Q_PROPERTY(QByteArray codecForEncoding READ codecForEncoding WRITE setCodecForEncoding STORED false)
53 Q_PROPERTY(QByteArray codecForDecoding READ codecForDecoding WRITE setCodecForDecoding STORED false)
54 Q_PROPERTY(IdentityId identityId READ identity WRITE setIdentity STORED false)
55 Q_PROPERTY(bool isConnected READ isConnected WRITE setConnected STORED false)
56 //Q_PROPERTY(Network::ConnectionState connectionState READ connectionState WRITE setConnectionState STORED false)
57 Q_PROPERTY(int connectionState READ connectionState WRITE setConnectionState STORED false)
58 Q_PROPERTY(bool useRandomServer READ useRandomServer WRITE setUseRandomServer STORED false)
59 Q_PROPERTY(QStringList perform READ perform WRITE setPerform STORED false)
60 Q_PROPERTY(bool useAutoIdentify READ useAutoIdentify WRITE setUseAutoIdentify STORED false)
61 Q_PROPERTY(QString autoIdentifyService READ autoIdentifyService WRITE setAutoIdentifyService STORED false)
62 Q_PROPERTY(QString autoIdentifyPassword READ autoIdentifyPassword WRITE setAutoIdentifyPassword STORED false)
63 Q_PROPERTY(bool useAutoReconnect READ useAutoReconnect WRITE setUseAutoReconnect STORED false)
64 Q_PROPERTY(quint32 autoReconnectInterval READ autoReconnectInterval WRITE setAutoReconnectInterval STORED false)
65 Q_PROPERTY(quint16 autoReconnectRetries READ autoReconnectRetries WRITE setAutoReconnectRetries STORED false)
66 Q_PROPERTY(bool unlimitedReconnectRetries READ unlimitedReconnectRetries WRITE setUnlimitedReconnectRetries STORED false)
67 Q_PROPERTY(bool rejoinChannels READ rejoinChannels WRITE setRejoinChannels STORED false)
70 enum ConnectionState {
80 // http://www.irc.org/tech_docs/005.html
81 // http://www.irc.org/tech_docs/draft-brocklesby-irc-isupport-03.txt
82 enum ChannelModeType {
83 NOT_A_CHANMODE = 0x00,
91 Network(const NetworkId &networkid, QObject *parent = 0);
94 inline NetworkId networkId() const { return _networkId; }
96 inline SignalProxy *proxy() const { return _proxy; }
97 inline void setProxy(SignalProxy *proxy) { _proxy = proxy; }
99 inline bool isMyNick(const QString &nick) const { return (myNick().toLower() == nick.toLower()); }
100 inline bool isMe(IrcUser *ircuser) const { return (ircuser->nick().toLower() == myNick().toLower()); }
102 bool isChannelName(const QString &channelname) const;
104 inline bool isConnected() const { return _connected; }
105 //Network::ConnectionState connectionState() const;
106 inline int connectionState() const { return _connectionState; }
108 QString prefixToMode(const QString &prefix);
109 inline QString prefixToMode(const QCharRef &prefix) { return prefixToMode(QString(prefix)); }
110 QString modeToPrefix(const QString &mode);
111 inline QString modeToPrefix(const QCharRef &mode) { return modeToPrefix(QString(mode)); }
113 ChannelModeType channelModeType(const QString &mode);
114 inline ChannelModeType channelModeType(const QCharRef &mode) { return channelModeType(QString(mode)); }
116 inline const QString &networkName() const { return _networkName; }
117 inline const QString ¤tServer() const { return _currentServer; }
118 inline const QString &myNick() const { return _myNick; }
119 inline IrcUser *me() const { return ircUser(myNick()); }
120 inline IdentityId identity() const { return _identity; }
121 QStringList nicks() const;
122 inline QStringList channels() const { return _ircChannels.keys(); }
123 inline const QVariantList &serverList() const { return _serverList; }
124 inline bool useRandomServer() const { return _useRandomServer; }
125 inline const QStringList &perform() const { return _perform; }
126 inline bool useAutoIdentify() const { return _useAutoIdentify; }
127 inline const QString &autoIdentifyService() const { return _autoIdentifyService; }
128 inline const QString &autoIdentifyPassword() const { return _autoIdentifyPassword; }
129 inline bool useAutoReconnect() const { return _useAutoReconnect; }
130 inline quint32 autoReconnectInterval() const { return _autoReconnectInterval; }
131 inline quint16 autoReconnectRetries() const { return _autoReconnectRetries; }
132 inline bool unlimitedReconnectRetries() const { return _unlimitedReconnectRetries; }
133 inline bool rejoinChannels() const { return _rejoinChannels; }
135 NetworkInfo networkInfo() const;
136 void setNetworkInfo(const NetworkInfo &);
139 QString prefixModes();
141 bool supports(const QString ¶m) const { return _supports.contains(param); }
142 QString support(const QString ¶m) const;
144 IrcUser *newIrcUser(const QString &hostmask);
145 inline IrcUser *newIrcUser(const QByteArray &hostmask) { return newIrcUser(decodeServerString(hostmask)); }
146 IrcUser *ircUser(QString nickname) const;
147 inline IrcUser *ircUser(const QByteArray &nickname) const { return ircUser(decodeServerString(nickname)); }
148 inline QList<IrcUser *> ircUsers() const { return _ircUsers.values(); }
149 inline quint32 ircUserCount() const { return _ircUsers.count(); }
151 IrcChannel *newIrcChannel(const QString &channelname);
152 inline IrcChannel *newIrcChannel(const QByteArray &channelname) { return newIrcChannel(decodeServerString(channelname)); }
153 IrcChannel *ircChannel(QString channelname) const;
154 inline IrcChannel *ircChannel(const QByteArray &channelname) const { return ircChannel(decodeServerString(channelname)); }
155 inline QList<IrcChannel *> ircChannels() const { return _ircChannels.values(); }
156 inline quint32 ircChannelCount() const { return _ircChannels.count(); }
158 QByteArray codecForServer() const;
159 QByteArray codecForEncoding() const;
160 QByteArray codecForDecoding() const;
161 void setCodecForServer(QTextCodec *codec);
162 void setCodecForEncoding(QTextCodec *codec);
163 void setCodecForDecoding(QTextCodec *codec);
165 QString decodeString(const QByteArray &text) const;
166 QByteArray encodeString(const QString &string) const;
167 QString decodeServerString(const QByteArray &text) const;
168 QByteArray encodeServerString(const QString &string) const;
170 static QByteArray defaultCodecForServer();
171 static QByteArray defaultCodecForEncoding();
172 static QByteArray defaultCodecForDecoding();
173 static void setDefaultCodecForServer(const QByteArray &name);
174 static void setDefaultCodecForEncoding(const QByteArray &name);
175 static void setDefaultCodecForDecoding(const QByteArray &name);
178 void setNetworkName(const QString &networkName);
179 void setCurrentServer(const QString ¤tServer);
180 void setConnected(bool isConnected);
181 //void setConnectionState(Network::ConnectionState state);
182 void setConnectionState(int state);
183 void setMyNick(const QString &mynick);
184 void setIdentity(IdentityId);
186 void setServerList(const QVariantList &serverList);
187 void setUseRandomServer(bool);
188 void setPerform(const QStringList &);
189 void setUseAutoIdentify(bool);
190 void setAutoIdentifyService(const QString &);
191 void setAutoIdentifyPassword(const QString &);
192 void setUseAutoReconnect(bool);
193 void setAutoReconnectInterval(quint32);
194 void setAutoReconnectRetries(quint16);
195 void setUnlimitedReconnectRetries(bool);
196 void setRejoinChannels(bool);
198 void setCodecForServer(const QByteArray &codecName);
199 void setCodecForEncoding(const QByteArray &codecName);
200 void setCodecForDecoding(const QByteArray &codecName);
202 void addSupport(const QString ¶m, const QString &value = QString());
203 void removeSupport(const QString ¶m);
205 inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
206 inline void addIrcChannel(const QString &channel) { newIrcChannel(channel); }
207 void removeIrcUser(const QString &nick);
208 void removeIrcChannel(const QString &channel);
211 QVariantMap initSupports() const;
212 inline QVariantList initServerList() const { return serverList(); }
213 QStringList initIrcUsers() const;
214 QStringList initIrcChannels() const;
217 void initSetSupports(const QVariantMap &supports);
218 inline void initSetServerList(const QVariantList &serverList) { setServerList(serverList); }
219 void initSetIrcUsers(const QStringList &hostmasks);
220 void initSetIrcChannels(const QStringList &channels);
222 IrcUser *updateNickFromMask(const QString &mask);
224 // these slots are to keep the hashlists of all users and the
225 // channel lists up to date
226 void ircUserNickChanged(QString newnick);
228 virtual inline void requestConnect() const { emit connectRequested(); }
229 virtual inline void requestDisconnect() const { emit disconnectRequested(); }
231 void emitConnectionError(const QString &);
234 void ircUserDestroyed();
235 void channelDestroyed();
236 void removeIrcUser(IrcUser *ircuser);
237 void removeIrcChannel(IrcChannel *ircChannel);
238 void removeChansAndUsers();
239 void ircUserInitDone();
240 void ircChannelInitDone();
243 void aboutToBeDestroyed();
244 void networkNameSet(const QString &networkName);
245 void currentServerSet(const QString ¤tServer);
246 void connectedSet(bool isConnected);
247 void connectionStateSet(Network::ConnectionState);
248 void connectionStateSet(int);
249 void connectionError(const QString &errorMsg);
250 void myNickSet(const QString &mynick);
251 void identitySet(IdentityId);
253 void serverListSet(QVariantList serverList);
254 void useRandomServerSet(bool);
255 void performSet(const QStringList &);
256 void useAutoIdentifySet(bool);
257 void autoIdentifyServiceSet(const QString &);
258 void autoIdentifyPasswordSet(const QString &);
259 void useAutoReconnectSet(bool);
260 void autoReconnectIntervalSet(quint32);
261 void autoReconnectRetriesSet(quint16);
262 void unlimitedReconnectRetriesSet(bool);
263 void rejoinChannelsSet(bool);
265 void codecForServerSet(const QByteArray &codecName);
266 void codecForEncodingSet(const QByteArray &codecName);
267 void codecForDecodingSet(const QByteArray &codecName);
269 void supportAdded(const QString ¶m, const QString &value);
270 void supportRemoved(const QString ¶m);
272 void ircUserAdded(const QString &hostmask);
273 void ircUserAdded(IrcUser *);
274 void ircChannelAdded(const QString &channelname);
275 void ircChannelAdded(IrcChannel *);
277 void ircUserRemoved(const QString &nick);
278 void ircChannelRemoved(const QString &channel);
280 // needed for client sync progress
281 void ircUserRemoved(QObject *);
282 void ircChannelRemoved(QObject *);
284 void ircUserInitDone(IrcUser *);
285 void ircChannelInitDone(IrcChannel *);
287 void connectRequested(NetworkId id = 0) const;
288 void disconnectRequested(NetworkId id = 0) const;
291 QPointer<SignalProxy> _proxy;
293 NetworkId _networkId;
294 IdentityId _identity;
297 QString _networkName;
298 QString _currentServer;
300 ConnectionState _connectionState;
303 QString _prefixModes;
305 QHash<QString, IrcUser *> _ircUsers; // stores all known nicks for the server
306 QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
307 QHash<QString, QString> _supports; // stores results from RPL_ISUPPORT
309 QVariantList _serverList;
310 bool _useRandomServer;
311 QStringList _perform;
313 bool _useAutoIdentify;
314 QString _autoIdentifyService;
315 QString _autoIdentifyPassword;
317 bool _useAutoReconnect;
318 quint32 _autoReconnectInterval;
319 quint16 _autoReconnectRetries;
320 bool _unlimitedReconnectRetries;
321 bool _rejoinChannels;
323 void determinePrefixes();
325 QTextCodec *_codecForServer;
326 QTextCodec *_codecForEncoding;
327 QTextCodec *_codecForDecoding;
329 static QTextCodec *_defaultCodecForServer;
330 static QTextCodec *_defaultCodecForEncoding;
331 static QTextCodec *_defaultCodecForDecoding;
334 //! Stores all editable information about a network (as opposed to runtime state).
340 bool useCustomEncodings; // not used!
341 QByteArray codecForServer;
342 QByteArray codecForEncoding;
343 QByteArray codecForDecoding;
345 // Server entry: QString "Host", uint "Port", QString "Password", bool "UseSSL"
346 QVariantList serverList;
347 bool useRandomServer;
351 bool useAutoIdentify;
352 QString autoIdentifyService;
353 QString autoIdentifyPassword;
355 bool useAutoReconnect;
356 quint32 autoReconnectInterval;
357 quint16 autoReconnectRetries;
358 bool unlimitedReconnectRetries;
361 bool operator==(const NetworkInfo &other) const;
362 bool operator!=(const NetworkInfo &other) const;
365 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
366 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
367 QDebug operator<<(QDebug dbg, const NetworkInfo &i);
369 Q_DECLARE_METATYPE(NetworkInfo);