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(int latency READ latency WRITE setLatency 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->nick().toLower() == myNick().toLower()); }
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 int latency() const { return _latency; }
121 inline IrcUser *me() const { return ircUser(myNick()); }
122 inline IdentityId identity() const { return _identity; }
123 QStringList nicks() const;
124 inline QStringList channels() const { return _ircChannels.keys(); }
125 inline const QVariantList &serverList() const { return _serverList; }
126 inline bool useRandomServer() const { return _useRandomServer; }
127 inline const QStringList &perform() const { return _perform; }
128 inline bool useAutoIdentify() const { return _useAutoIdentify; }
129 inline const QString &autoIdentifyService() const { return _autoIdentifyService; }
130 inline const QString &autoIdentifyPassword() const { return _autoIdentifyPassword; }
131 inline bool useAutoReconnect() const { return _useAutoReconnect; }
132 inline quint32 autoReconnectInterval() const { return _autoReconnectInterval; }
133 inline quint16 autoReconnectRetries() const { return _autoReconnectRetries; }
134 inline bool unlimitedReconnectRetries() const { return _unlimitedReconnectRetries; }
135 inline bool rejoinChannels() const { return _rejoinChannels; }
137 NetworkInfo networkInfo() const;
138 void setNetworkInfo(const NetworkInfo &);
141 QString prefixModes();
143 bool supports(const QString ¶m) const { return _supports.contains(param); }
144 QString support(const QString ¶m) const;
146 IrcUser *newIrcUser(const QString &hostmask, const QVariantMap &initData = QVariantMap());
147 inline IrcUser *newIrcUser(const QByteArray &hostmask) { return newIrcUser(decodeServerString(hostmask)); }
148 IrcUser *ircUser(QString nickname) const;
149 inline IrcUser *ircUser(const QByteArray &nickname) const { return ircUser(decodeServerString(nickname)); }
150 inline QList<IrcUser *> ircUsers() const { return _ircUsers.values(); }
151 inline quint32 ircUserCount() const { return _ircUsers.count(); }
153 IrcChannel *newIrcChannel(const QString &channelname, const QVariantMap &initData = QVariantMap());
154 inline IrcChannel *newIrcChannel(const QByteArray &channelname) { return newIrcChannel(decodeServerString(channelname)); }
155 IrcChannel *ircChannel(QString channelname) const;
156 inline IrcChannel *ircChannel(const QByteArray &channelname) const { return ircChannel(decodeServerString(channelname)); }
157 inline QList<IrcChannel *> ircChannels() const { return _ircChannels.values(); }
158 inline quint32 ircChannelCount() const { return _ircChannels.count(); }
160 QByteArray codecForServer() const;
161 QByteArray codecForEncoding() const;
162 QByteArray codecForDecoding() const;
163 void setCodecForServer(QTextCodec *codec);
164 void setCodecForEncoding(QTextCodec *codec);
165 void setCodecForDecoding(QTextCodec *codec);
167 QString decodeString(const QByteArray &text) const;
168 QByteArray encodeString(const QString &string) const;
169 QString decodeServerString(const QByteArray &text) const;
170 QByteArray encodeServerString(const QString &string) const;
172 static QByteArray defaultCodecForServer();
173 static QByteArray defaultCodecForEncoding();
174 static QByteArray defaultCodecForDecoding();
175 static void setDefaultCodecForServer(const QByteArray &name);
176 static void setDefaultCodecForEncoding(const QByteArray &name);
177 static void setDefaultCodecForDecoding(const QByteArray &name);
179 bool autoAwayActive() const { return _autoAwayActive; }
180 void setAutoAwayActive(bool active) { _autoAwayActive = active; }
183 void setNetworkName(const QString &networkName);
184 void setCurrentServer(const QString ¤tServer);
185 void setConnected(bool isConnected);
186 //void setConnectionState(Network::ConnectionState state);
187 void setConnectionState(int state);
188 void setMyNick(const QString &mynick);
189 void setLatency(int latency);
190 void setIdentity(IdentityId);
192 void setServerList(const QVariantList &serverList);
193 void setUseRandomServer(bool);
194 void setPerform(const QStringList &);
195 void setUseAutoIdentify(bool);
196 void setAutoIdentifyService(const QString &);
197 void setAutoIdentifyPassword(const QString &);
198 void setUseAutoReconnect(bool);
199 void setAutoReconnectInterval(quint32);
200 void setAutoReconnectRetries(quint16);
201 void setUnlimitedReconnectRetries(bool);
202 void setRejoinChannels(bool);
204 void setCodecForServer(const QByteArray &codecName);
205 void setCodecForEncoding(const QByteArray &codecName);
206 void setCodecForDecoding(const QByteArray &codecName);
208 void addSupport(const QString ¶m, const QString &value = QString());
209 void removeSupport(const QString ¶m);
211 inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
212 inline void addIrcChannel(const QString &channel) { newIrcChannel(channel); }
215 QVariantMap initSupports() const;
216 inline QVariantList initServerList() const { return serverList(); }
217 virtual QVariantMap initIrcUsersAndChannels() const;
218 // QStringList initIrcUsers() const;
219 // QStringList initIrcChannels() const;
222 void initSetSupports(const QVariantMap &supports);
223 inline void initSetServerList(const QVariantList &serverList) { setServerList(serverList); }
224 virtual void initSetIrcUsersAndChannels(const QVariantMap &usersAndChannels);
225 // void initSetIrcUsers(const QStringList &hostmasks);
226 // void initSetIrcChannels(const QStringList &channels);
228 IrcUser *updateNickFromMask(const QString &mask);
230 // these slots are to keep the hashlists of all users and the
231 // channel lists up to date
232 void ircUserNickChanged(QString newnick);
234 virtual inline void requestConnect() const { emit connectRequested(); }
235 virtual inline void requestDisconnect() const { emit disconnectRequested(); }
236 virtual inline void requestSetNetworkInfo(const NetworkInfo &info) { emit setNetworkInfoRequested(info); }
238 void emitConnectionError(const QString &);
241 void removeIrcUser(IrcUser *ircuser);
242 void removeIrcChannel(IrcChannel *ircChannel);
243 void removeChansAndUsers();
246 void aboutToBeDestroyed();
247 void networkNameSet(const QString &networkName);
248 void currentServerSet(const QString ¤tServer);
249 void connectedSet(bool isConnected);
250 void connectionStateSet(Network::ConnectionState);
251 void connectionStateSet(int);
252 void connectionError(const QString &errorMsg);
253 void myNickSet(const QString &mynick);
254 void latencySet(int latency);
255 void identitySet(IdentityId);
257 void serverListSet(QVariantList serverList);
258 void useRandomServerSet(bool);
259 void performSet(const QStringList &);
260 void useAutoIdentifySet(bool);
261 void autoIdentifyServiceSet(const QString &);
262 void autoIdentifyPasswordSet(const QString &);
263 void useAutoReconnectSet(bool);
264 void autoReconnectIntervalSet(quint32);
265 void autoReconnectRetriesSet(quint16);
266 void unlimitedReconnectRetriesSet(bool);
267 void rejoinChannelsSet(bool);
269 void codecForServerSet(const QByteArray &codecName);
270 void codecForEncodingSet(const QByteArray &codecName);
271 void codecForDecodingSet(const QByteArray &codecName);
273 void supportAdded(const QString ¶m, const QString &value);
274 void supportRemoved(const QString ¶m);
276 void ircUserAdded(const QString &hostmask);
277 void ircUserAdded(IrcUser *);
278 void ircChannelAdded(const QString &channelname);
279 void ircChannelAdded(IrcChannel *);
281 void connectRequested(NetworkId id = 0) const;
282 void disconnectRequested(NetworkId id = 0) const;
283 void setNetworkInfoRequested(const NetworkInfo &) const;
286 inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new IrcChannel(channelname, this); }
289 QPointer<SignalProxy> _proxy;
291 NetworkId _networkId;
292 IdentityId _identity;
296 QString _networkName;
297 QString _currentServer;
299 ConnectionState _connectionState;
302 QString _prefixModes;
304 QHash<QString, IrcUser *> _ircUsers; // stores all known nicks for the server
305 QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
306 QHash<QString, QString> _supports; // stores results from RPL_ISUPPORT
308 QVariantList _serverList;
309 bool _useRandomServer;
310 QStringList _perform;
312 bool _useAutoIdentify;
313 QString _autoIdentifyService;
314 QString _autoIdentifyPassword;
316 bool _useAutoReconnect;
317 quint32 _autoReconnectInterval;
318 quint16 _autoReconnectRetries;
319 bool _unlimitedReconnectRetries;
320 bool _rejoinChannels;
322 void determinePrefixes();
324 QTextCodec *_codecForServer;
325 QTextCodec *_codecForEncoding;
326 QTextCodec *_codecForDecoding;
328 static QTextCodec *_defaultCodecForServer;
329 static QTextCodec *_defaultCodecForEncoding;
330 static QTextCodec *_defaultCodecForDecoding;
332 bool _autoAwayActive; // when this is active handle305 and handle306 don't trigger any output
334 friend class IrcUser;
335 friend class IrcChannel;
338 //! Stores all editable information about a network (as opposed to runtime state).
344 bool useCustomEncodings; // not used!
345 QByteArray codecForServer;
346 QByteArray codecForEncoding;
347 QByteArray codecForDecoding;
349 // Server entry: QString "Host", uint "Port", QString "Password", bool "UseSSL"
350 QVariantList serverList;
351 bool useRandomServer;
355 bool useAutoIdentify;
356 QString autoIdentifyService;
357 QString autoIdentifyPassword;
359 bool useAutoReconnect;
360 quint32 autoReconnectInterval;
361 quint16 autoReconnectRetries;
362 bool unlimitedReconnectRetries;
365 bool operator==(const NetworkInfo &other) const;
366 bool operator!=(const NetworkInfo &other) const;
369 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
370 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
371 QDebug operator<<(QDebug dbg, const NetworkInfo &i);
373 Q_DECLARE_METATYPE(NetworkInfo)