1 /***************************************************************************
2 * Copyright (C) 2005-2015 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"
46 class CoreUserInputHandler;
47 class CoreIgnoreListManager;
50 class CoreNetwork : public Network
56 CoreNetwork(const NetworkId &networkid, CoreSession *session);
58 inline virtual const QMetaObject *syncMetaObject() const { return &Network::staticMetaObject; }
60 inline CoreIdentity *identityPtr() const { return coreSession()->identity(identity()); }
61 inline CoreSession *coreSession() const { return _coreSession; }
62 inline CoreNetworkConfig *networkConfig() const { return coreSession()->networkConfig(); }
64 inline CoreUserInputHandler *userInputHandler() const { return _userInputHandler; }
65 inline CoreIgnoreListManager *ignoreListManager() { return coreSession()->ignoreListManager(); }
67 //! Decode a string using the server (network) decoding.
68 inline QString serverDecode(const QByteArray &string) const { return decodeServerString(string); }
70 //! Decode a string using a channel-specific encoding if one is set (and use the standard encoding else).
71 QString channelDecode(const QString &channelName, const QByteArray &string) const;
73 //! Decode a string using an IrcUser-specific encoding, if one exists (using the standaed encoding else).
74 QString userDecode(const QString &userNick, const QByteArray &string) const;
76 //! Encode a string using the server (network) encoding.
77 inline QByteArray serverEncode(const QString &string) const { return encodeServerString(string); }
79 //! Encode a string using the channel-specific encoding, if set, and use the standard encoding else.
80 QByteArray channelEncode(const QString &channelName, const QString &string) const;
82 //! Encode a string using the user-specific encoding, if set, and use the standard encoding else.
83 QByteArray userEncode(const QString &userNick, const QString &string) const;
85 inline QString channelKey(const QString &channel) const { return _channelKeys.value(channel.toLower(), QString()); }
87 inline QByteArray readChannelCipherKey(const QString &channel) const { return _cipherKeys.value(channel.toLower()); }
88 inline void storeChannelCipherKey(const QString &channel, const QByteArray &key) { _cipherKeys[channel.toLower()] = key; }
90 inline bool isAutoWhoInProgress(const QString &channel) const { return _autoWhoPending.value(channel.toLower(), 0); }
92 inline UserId userId() const { return _coreSession->user(); }
94 inline QAbstractSocket::SocketState socketState() const { return socket.state(); }
95 inline bool socketConnected() const { return socket.state() == QAbstractSocket::ConnectedState; }
96 inline QHostAddress localAddress() const { return socket.localAddress(); }
97 inline QHostAddress peerAddress() const { return socket.peerAddress(); }
98 inline quint16 localPort() const { return socket.localPort(); }
99 inline quint16 peerPort() const { return socket.peerPort(); }
101 QList<QList<QByteArray>> splitMessage(const QString &cmd, const QString &message, std::function<QList<QByteArray>(QString &)> cmdGenerator);
103 // IRCv3 capability negotiation
106 * Checks if a given capability is enabled.
108 * @returns True if enabled, otherwise false
110 inline bool capEnabled(const QString &capability) const { return _capsSupported.contains(capability); }
113 * Checks if capability negotiation is currently ongoing.
115 * @returns True if in progress, otherwise false
117 inline bool capNegotiationInProgress() const { return !_capsQueued.empty(); }
120 * Gets the value of an enabled or pending capability, e.g. sasl=plain.
122 * @returns Value of capability if one was specified, otherwise empty string
124 QString capValue(const QString &capability) const;
127 * Gets the next capability to request, removing it from the queue.
129 * @returns Name of capability to request
131 QString takeQueuedCap();
133 // Specific capabilities for easy reference
136 * Gets the status of the sasl authentication capability.
138 * http://ircv3.net/specs/extensions/sasl-3.2.html
140 * @returns True if SASL authentication is enabled, otherwise false
142 inline bool useCapSASL() const { return capEnabled("sasl"); }
145 virtual void setMyNick(const QString &mynick);
147 virtual void requestConnect() const;
148 virtual void requestDisconnect() const;
149 virtual void requestSetNetworkInfo(const NetworkInfo &info);
151 virtual void setUseAutoReconnect(bool);
152 virtual void setAutoReconnectInterval(quint32);
153 virtual void setAutoReconnectRetries(quint16);
155 void setPingInterval(int interval);
157 void connectToIrc(bool reconnecting = false);
158 void disconnectFromIrc(bool requested = true, const QString &reason = QString(), bool withReconnect = false);
160 void userInput(BufferInfo bufferInfo, QString msg);
161 void putRawLine(QByteArray input);
162 void putCmd(const QString &cmd, const QList<QByteArray> ¶ms, const QByteArray &prefix = QByteArray());
163 void putCmd(const QString &cmd, const QList<QList<QByteArray>> ¶ms, const QByteArray &prefix = QByteArray());
165 void setChannelJoined(const QString &channel);
166 void setChannelParted(const QString &channel);
167 void addChannelKey(const QString &channel, const QString &key);
168 void removeChannelKey(const QString &channel);
172 Cipher *cipher(const QString &recipient);
173 QByteArray cipherKey(const QString &recipient) const;
174 void setCipherKey(const QString &recipient, const QByteArray &key);
175 bool cipherUsesCBC(const QString &target);
178 // IRCv3 capability negotiation (can be connected to signals)
181 * Marks a capability as accepted, providing an optional value.
183 * Removes it from queue of pending capabilities and triggers any capability-specific
186 * @param[in] capability Name of the capability
189 * Optional value of the capability, e.g. sasl=plain. If left empty, will be copied from the
190 * pending capability.
193 void addCap(const QString &capability, const QString &value = QString());
196 * Marks a capability as denied.
198 * Removes it from the queue of pending capabilities and triggers any capability-specific
201 * @param[in] capability Name of the capability
203 void removeCap(const QString &capability);
206 * Queues a capability as available but not yet accepted or denied.
208 * Capabilities should be queued when registration pauses for CAP LS for capabilities are only
209 * requested during login.
211 * @param[in] capability Name of the capability
212 * @param[in] value Optional value of the capability, e.g. sasl=plain
214 void queuePendingCap(const QString &capability, const QString &value = QString());
216 void setAutoWhoEnabled(bool enabled);
217 void setAutoWhoInterval(int interval);
218 void setAutoWhoDelay(int delay);
220 bool setAutoWhoDone(const QString &channel);
222 void updateIssuedModes(const QString &requestedModes);
223 void updatePersistentModes(QString addModes, QString removeModes);
224 void resetPersistentModes();
226 Server usedServer() const;
228 inline void resetPingTimeout() { _pingCount = 0; }
230 inline void displayMsg(Message::Type msgType, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None)
232 emit displayMsg(networkId(), msgType, bufferType, target, text, sender, flags);
237 void recvRawServerMsg(QString);
238 void displayStatusMsg(QString);
239 void displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
240 void disconnected(NetworkId networkId);
241 void connectionError(const QString &errorMsg);
243 void quitRequested(NetworkId networkId);
244 void sslErrors(const QVariant &errorData);
246 void newEvent(Event *event);
247 void socketInitialized(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
248 void socketDisconnected(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
251 inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new CoreIrcChannel(channelname, this); }
252 inline virtual IrcUser *ircUserFactory(const QString &hostmask) { return new CoreIrcUser(hostmask, this); }
255 // TODO: remove cached cipher keys, when appropriate
256 //virtual void removeIrcUser(IrcUser *ircuser);
257 //virtual void removeIrcChannel(IrcChannel *ircChannel);
258 //virtual void removeChansAndUsers();
261 void socketHasData();
262 void socketError(QAbstractSocket::SocketError);
263 void socketInitialized();
264 inline void socketCloseTimeout() { socket.abort(); }
265 void socketDisconnected();
266 void socketStateChanged(QAbstractSocket::SocketState);
267 void networkInitialized();
270 void restoreUserModes();
271 void doAutoReconnect();
273 void enablePingTimeout(bool enable = true);
274 void disablePingTimeout();
276 void startAutoWhoCycle();
279 void sslErrors(const QList<QSslError> &errors);
282 void fillBucketAndProcessQueue();
284 void writeToSocket(const QByteArray &data);
287 CoreSession *_coreSession;
295 CoreUserInputHandler *_userInputHandler;
297 QHash<QString, QString> _channelKeys; // stores persistent channels and their passwords, if any
299 QTimer _autoReconnectTimer;
300 int _autoReconnectCount;
302 QTimer _socketCloseTimer;
304 /* this flag triggers quitRequested() once the socket is closed
305 * it is needed to determine whether or not the connection needs to be
306 * in the automatic session restore. */
310 bool _previousConnectionAttemptFailed;
311 int _lastUsedServerIndex;
318 QStringList _autoWhoQueue;
319 QHash<QString, int> _autoWhoPending;
320 QTimer _autoWhoTimer, _autoWhoCycleTimer;
322 // CAPs may have parameter values
323 // See http://ircv3.net/specs/core/capability-negotiation-3.2.html
324 QStringList _capsQueued; /// Capabilities to be checked
325 QHash<QString, QString> _capsPending; /// Capabilities pending 'CAP ACK' from server
326 QHash<QString, QString> _capsSupported; /// Enabled capabilities that received 'CAP ACK'
328 QTimer _tokenBucketTimer;
329 int _messageDelay; // token refill speed in ms
330 int _burstSize; // size of the token bucket
331 int _tokenBucket; // the virtual bucket that holds the tokens
332 QList<QByteArray> _msgQueue;
334 QString _requestedUserModes; // 2 strings separated by a '-' character. first part are requested modes to add, the second to remove
336 // List of blowfish keys for channels
337 QHash<QString, QByteArray> _cipherKeys;
341 #endif //CORENETWORK_H