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 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)
60 enum ConnectionState { Disconnected, Connecting, Initializing, Initialized, Disconnecting };
62 Network(const NetworkId &networkid, QObject *parent = 0);
65 NetworkId networkId() const;
67 SignalProxy *proxy() const;
68 void setProxy(SignalProxy *proxy);
70 bool isMyNick(const QString &nick) const;
71 bool isMe(IrcUser *ircuser) const;
73 bool isChannelName(const QString &channelname) const;
75 bool isConnected() const;
76 //Network::ConnectionState connectionState() const;
77 int connectionState() const;
79 QString prefixToMode(const QString &prefix);
80 QString prefixToMode(const QCharRef &prefix);
81 QString modeToPrefix(const QString &mode);
82 QString modeToPrefix(const QCharRef &mode);
84 QString networkName() const;
85 QString currentServer() const;
86 QString myNick() const;
87 IdentityId identity() const;
88 QStringList nicks() const;
89 QStringList channels() const;
90 QVariantList serverList() const;
92 NetworkInfo networkInfo() const;
93 void setNetworkInfo(const NetworkInfo &);
96 QString prefixModes();
98 bool supports(const QString ¶m) const;
99 QString support(const QString ¶m) const;
101 IrcUser *newIrcUser(const QString &hostmask);
102 IrcUser *newIrcUser(const QByteArray &hostmask);
103 IrcUser *ircUser(QString nickname) const;
104 IrcUser *ircUser(const QByteArray &nickname) const;
105 QList<IrcUser *> ircUsers() const;
106 quint32 ircUserCount() const;
108 IrcChannel *newIrcChannel(const QString &channelname);
109 IrcChannel *newIrcChannel(const QByteArray &channelname);
110 IrcChannel *ircChannel(QString channelname) const;
111 IrcChannel *ircChannel(const QByteArray &channelname) const;
112 QList<IrcChannel *> ircChannels() const;
113 quint32 ircChannelCount() const;
115 QByteArray codecForEncoding() const;
116 QByteArray codecForDecoding() const;
117 void setCodecForEncoding(QTextCodec *codec);
118 void setCodecForDecoding(QTextCodec *codec);
120 QString decodeString(const QByteArray &text) const;
121 QByteArray encodeString(const QString string) const;
124 void setNetworkName(const QString &networkName);
125 void setCurrentServer(const QString ¤tServer);
126 void setConnected(bool isConnected);
127 //void setConnectionState(Network::ConnectionState state);
128 void setConnectionState(int state);
129 void setMyNick(const QString &mynick);
130 void setIdentity(IdentityId);
132 void setServerList(const QVariantList &serverList);
134 void setCodecForEncoding(const QByteArray &codecName);
135 void setCodecForDecoding(const QByteArray &codecName);
137 void addSupport(const QString ¶m, const QString &value = QString());
138 void removeSupport(const QString ¶m);
140 inline void addIrcUser(const QString &hostmask) { newIrcUser(hostmask); }
141 void removeIrcUser(QString nick);
144 QVariantMap initSupports() const;
145 QVariantList initServerList() const;
146 QStringList initIrcUsers() const;
147 QStringList initIrcChannels() const;
150 void initSetSupports(const QVariantMap &supports);
151 void initSetServerList(const QVariantList &serverList);
152 void initSetIrcUsers(const QStringList &hostmasks);
153 void initSetChannels(const QStringList &channels);
155 IrcUser *updateNickFromMask(const QString &mask);
157 // these slots are to keep the hashlists of all users and the
158 // channel lists up to date
159 void ircUserNickChanged(QString newnick);
161 void requestConnect() const;
162 void requestDisconnect() const;
164 void emitConnectionError(const QString &);
167 void ircUserDestroyed();
168 void channelDestroyed();
169 void removeIrcUser(IrcUser *ircuser);
170 void ircUserInitDone();
171 void ircChannelInitDone();
174 void networkNameSet(const QString &networkName);
175 void currentServerSet(const QString ¤tServer);
176 void connectedSet(bool isConnected);
177 void connectionStateSet(Network::ConnectionState);
178 void connectionStateSet(int);
179 void connectionError(const QString &errorMsg);
180 void myNickSet(const QString &mynick);
181 void identitySet(IdentityId);
183 void serverListSet(QVariantList serverList);
185 void codecForEncodingSet(const QString &codecName);
186 void codecForDecodingSet(const QString &codecName);
188 void supportAdded(const QString ¶m, const QString &value);
189 void supportRemoved(const QString ¶m);
191 void ircUserAdded(const QString &hostmask);
192 void ircUserAdded(IrcUser *);
193 void ircChannelAdded(const QString &channelname);
194 void ircChannelAdded(IrcChannel *);
196 void ircUserRemoved(const QString &nick);
198 // needed for client sync progress
199 void ircUserRemoved(QObject *);
200 void ircChannelRemoved(QObject *);
202 void ircUserInitDone(IrcUser *);
203 void ircChannelInitDone(IrcChannel *);
205 void connectRequested(NetworkId id = 0) const;
206 void disconnectRequested(NetworkId id = 0) const;
209 NetworkId _networkId;
210 IdentityId _identity;
213 QString _networkName;
214 QString _currentServer;
216 ConnectionState _connectionState;
219 QString _prefixModes;
221 QHash<QString, IrcUser *> _ircUsers; // stores all known nicks for the server
222 QHash<QString, IrcChannel *> _ircChannels; // stores all known channels
223 QHash<QString, QString> _supports; // stores results from RPL_ISUPPORT
225 QVariantList _serverList;
226 QStringList _perform;
227 //QVariantMap networkSettings;
229 QPointer<SignalProxy> _proxy;
230 void determinePrefixes();
232 QTextCodec *_codecForEncoding;
233 QTextCodec *_codecForDecoding;
237 //! Stores all editable information about a network (as opposed to runtime state).
243 bool useCustomEncodings;
244 QByteArray codecForEncoding;
245 QByteArray codecForDecoding;
247 // Server entry: QString "Host", uint "Port", QString "Password", bool "UseSSL"
248 QVariantList serverList;
249 bool useRandomServer;
253 bool useAutoIdentify;
254 QString autoIdentifyService;
255 QString autoIdentifyPassword;
257 bool useAutoReconnect;
258 quint32 autoReconnectInterval;
259 qint16 autoReconnectRetries; // -1 => Unlimited
262 bool operator==(const NetworkInfo &other) const;
263 bool operator!=(const NetworkInfo &other) const;
266 QDataStream &operator<<(QDataStream &out, const NetworkInfo &info);
267 QDataStream &operator>>(QDataStream &in, NetworkInfo &info);
269 Q_DECLARE_METATYPE(NetworkInfo);