1 /***************************************************************************
2 * Copyright (C) 2005-2012 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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
19 ***************************************************************************/
25 #include "coreircchannel.h"
26 #include "coreircuser.h"
31 # include <QSslSocket>
34 # include <QTcpSocket>
41 #include "coresession.h"
44 class CoreUserInputHandler;
45 class CoreIgnoreListManager;
48 class CoreNetwork : public Network
54 CoreNetwork(const NetworkId &networkid, CoreSession *session);
56 inline virtual const QMetaObject *syncMetaObject() const { return &Network::staticMetaObject; }
58 inline CoreIdentity *identityPtr() const { return coreSession()->identity(identity()); }
59 inline CoreSession *coreSession() const { return _coreSession; }
60 inline CoreNetworkConfig *networkConfig() const { return coreSession()->networkConfig(); }
62 inline CoreUserInputHandler *userInputHandler() const { return _userInputHandler; }
63 inline CoreIgnoreListManager *ignoreListManager() { return coreSession()->ignoreListManager(); }
65 //! Decode a string using the server (network) decoding.
66 inline QString serverDecode(const QByteArray &string) const { return decodeServerString(string); }
68 //! Decode a string using a channel-specific encoding if one is set (and use the standard encoding else).
69 QString channelDecode(const QString &channelName, const QByteArray &string) const;
71 //! Decode a string using an IrcUser-specific encoding, if one exists (using the standaed encoding else).
72 QString userDecode(const QString &userNick, const QByteArray &string) const;
74 //! Encode a string using the server (network) encoding.
75 inline QByteArray serverEncode(const QString &string) const { return encodeServerString(string); }
77 //! Encode a string using the channel-specific encoding, if set, and use the standard encoding else.
78 QByteArray channelEncode(const QString &channelName, const QString &string) const;
80 //! Encode a string using the user-specific encoding, if set, and use the standard encoding else.
81 QByteArray userEncode(const QString &userNick, const QString &string) const;
83 inline QString channelKey(const QString &channel) const { return _channelKeys.value(channel.toLower(), QString()); }
85 inline bool isAutoWhoInProgress(const QString &channel) const { return _autoWhoPending.value(channel.toLower(), 0); }
87 inline UserId userId() const { return _coreSession->user(); }
89 inline QAbstractSocket::SocketState socketState() const { return socket.state(); }
90 inline bool socketConnected() const { return socket.state() == QAbstractSocket::ConnectedState; }
91 inline QHostAddress localAddress() const { return socket.localAddress(); }
92 inline QHostAddress peerAddress() const { return socket.peerAddress(); }
93 inline quint16 localPort() const { return socket.localPort(); }
94 inline quint16 peerPort() const { return socket.peerPort(); }
97 virtual void setMyNick(const QString &mynick);
99 virtual void requestConnect() const;
100 virtual void requestDisconnect() const;
101 virtual void requestSetNetworkInfo(const NetworkInfo &info);
103 virtual void setUseAutoReconnect(bool);
104 virtual void setAutoReconnectInterval(quint32);
105 virtual void setAutoReconnectRetries(quint16);
107 void setPingInterval(int interval);
109 void connectToIrc(bool reconnecting = false);
110 void disconnectFromIrc(bool requested = true, const QString &reason = QString(), bool withReconnect = false);
112 void userInput(BufferInfo bufferInfo, QString msg);
113 void putRawLine(QByteArray input);
114 void putCmd(const QString &cmd, const QList<QByteArray> ¶ms, const QByteArray &prefix = QByteArray());
116 void setChannelJoined(const QString &channel);
117 void setChannelParted(const QString &channel);
118 void addChannelKey(const QString &channel, const QString &key);
119 void removeChannelKey(const QString &channel);
123 Cipher *cipher(const QString &recipient);
124 QByteArray cipherKey(const QString &recipient) const;
125 void setCipherKey(const QString &recipient, const QByteArray &key);
128 void setAutoWhoEnabled(bool enabled);
129 void setAutoWhoInterval(int interval);
130 void setAutoWhoDelay(int delay);
132 bool setAutoWhoDone(const QString &channel);
134 void updateIssuedModes(const QString &requestedModes);
135 void updatePersistentModes(QString addModes, QString removeModes);
136 void resetPersistentModes();
138 Server usedServer() const;
140 inline void resetPingTimeout() { _pingCount = 0; }
142 inline void displayMsg(Message::Type msgType, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None)
144 emit displayMsg(networkId(), msgType, bufferType, target, text, sender, flags);
149 void recvRawServerMsg(QString);
150 void displayStatusMsg(QString);
151 void displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
152 void disconnected(NetworkId networkId);
153 void connectionError(const QString &errorMsg);
155 void quitRequested(NetworkId networkId);
156 void sslErrors(const QVariant &errorData);
158 void newEvent(Event *event);
159 void socketInitialized(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
160 void socketDisconnected(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
163 inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new CoreIrcChannel(channelname, this); }
164 inline virtual IrcUser *ircUserFactory(const QString &hostmask) { return new CoreIrcUser(hostmask, this); }
167 // TODO: remove cached cipher keys, when appropriate
168 //virtual void removeIrcUser(IrcUser *ircuser);
169 //virtual void removeIrcChannel(IrcChannel *ircChannel);
170 //virtual void removeChansAndUsers();
173 void socketHasData();
174 void socketError(QAbstractSocket::SocketError);
175 void socketInitialized();
176 inline void socketCloseTimeout() { socket.disconnectFromHost(); }
177 void socketDisconnected();
178 void socketStateChanged(QAbstractSocket::SocketState);
179 void networkInitialized();
182 void restoreUserModes();
183 void doAutoReconnect();
185 void enablePingTimeout(bool enable = true);
186 void disablePingTimeout();
188 void startAutoWhoCycle();
191 void sslErrors(const QList<QSslError> &errors);
194 void fillBucketAndProcessQueue();
196 void writeToSocket(const QByteArray &data);
199 CoreSession *_coreSession;
207 CoreUserInputHandler *_userInputHandler;
209 QHash<QString, QString> _channelKeys; // stores persistent channels and their passwords, if any
211 QTimer _autoReconnectTimer;
212 int _autoReconnectCount;
214 QTimer _socketCloseTimer;
216 /* this flag triggers quitRequested() once the socket is closed
217 * it is needed to determine whether or not the connection needs to be
218 * in the automatic session restore. */
222 bool _previousConnectionAttemptFailed;
223 int _lastUsedServerIndex;
229 QStringList _autoWhoQueue;
230 QHash<QString, int> _autoWhoPending;
231 QTimer _autoWhoTimer, _autoWhoCycleTimer;
233 QTimer _tokenBucketTimer;
234 int _messageDelay; // token refill speed in ms
235 int _burstSize; // size of the token bucket
236 int _tokenBucket; // the virtual bucket that holds the tokens
237 QList<QByteArray> _msgQueue;
239 QString _requestedUserModes; // 2 strings separated by a '-' character. first part are requested modes to add, the second to remove
242 QHash<QString, QByteArray> _cipherKeys;
246 #endif //CORENETWORK_H