1 /***************************************************************************
2 * Copyright (C) 2005-2016 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"
34 # include <QSslSocket>
37 # include <QTcpSocket>
44 #include "coresession.h"
49 class CoreUserInputHandler;
50 class CoreIgnoreListManager;
53 class CoreNetwork : public Network
59 CoreNetwork(const NetworkId &networkid, CoreSession *session);
61 inline virtual const QMetaObject *syncMetaObject() const { return &Network::staticMetaObject; }
63 inline CoreIdentity *identityPtr() const { return coreSession()->identity(identity()); }
64 inline CoreSession *coreSession() const { return _coreSession; }
65 inline CoreNetworkConfig *networkConfig() const { return coreSession()->networkConfig(); }
67 inline CoreUserInputHandler *userInputHandler() const { return _userInputHandler; }
68 inline CoreIgnoreListManager *ignoreListManager() { return coreSession()->ignoreListManager(); }
70 //! Decode a string using the server (network) decoding.
71 inline QString serverDecode(const QByteArray &string) const { return decodeServerString(string); }
73 //! Decode a string using a channel-specific encoding if one is set (and use the standard encoding else).
74 QString channelDecode(const QString &channelName, const QByteArray &string) const;
76 //! Decode a string using an IrcUser-specific encoding, if one exists (using the standaed encoding else).
77 QString userDecode(const QString &userNick, const QByteArray &string) const;
79 //! Encode a string using the server (network) encoding.
80 inline QByteArray serverEncode(const QString &string) const { return encodeServerString(string); }
82 //! Encode a string using the channel-specific encoding, if set, and use the standard encoding else.
83 QByteArray channelEncode(const QString &channelName, const QString &string) const;
85 //! Encode a string using the user-specific encoding, if set, and use the standard encoding else.
86 QByteArray userEncode(const QString &userNick, const QString &string) const;
88 inline QString channelKey(const QString &channel) const { return _channelKeys.value(channel.toLower(), QString()); }
90 inline QByteArray readChannelCipherKey(const QString &channel) const { return _cipherKeys.value(channel.toLower()); }
91 inline void storeChannelCipherKey(const QString &channel, const QByteArray &key) { _cipherKeys[channel.toLower()] = key; }
93 inline bool isAutoWhoInProgress(const QString &channel) const { return _autoWhoPending.value(channel.toLower(), 0); }
95 inline UserId userId() const { return _coreSession->user(); }
97 inline QAbstractSocket::SocketState socketState() const { return socket.state(); }
98 inline bool socketConnected() const { return socket.state() == QAbstractSocket::ConnectedState; }
99 inline QHostAddress localAddress() const { return socket.localAddress(); }
100 inline QHostAddress peerAddress() const { return socket.peerAddress(); }
101 inline quint16 localPort() const { return socket.localPort(); }
102 inline quint16 peerPort() const { return socket.peerPort(); }
104 QList<QList<QByteArray>> splitMessage(const QString &cmd, const QString &message, std::function<QList<QByteArray>(QString &)> cmdGenerator);
106 // IRCv3 capability negotiation
109 * Checks if capability negotiation is currently ongoing.
111 * @returns True if in progress, otherwise false
113 inline bool capNegotiationInProgress() const { return !_capsQueued.empty(); }
116 * Queues a capability to be requested.
118 * Adds to the list of capabilities being requested. If non-empty, CAP REQ messages are sent
119 * to the IRC server. This may happen at login or if capabilities are announced via CAP NEW.
121 * @param[in] capability Name of the capability
123 void queueCap(const QString &capability);
126 * Begins capability negotiation if capabilities are queued, otherwise returns.
128 * If any capabilities are queued, this will begin the cycle of taking each capability and
129 * requesting it. When no capabilities remain, capability negotiation is suitably ended.
131 void beginCapNegotiation();
134 * List of capabilities requiring further core<->server messages to configure.
136 * For example, SASL requires the back-and-forth of AUTHENTICATE, so the next capability cannot
137 * be immediately sent.
139 * See: http://ircv3.net/specs/extensions/sasl-3.2.html
141 const QStringList capsRequiringConfiguration = QStringList {
146 virtual void setMyNick(const QString &mynick);
148 virtual void requestConnect() const;
149 virtual void requestDisconnect() const;
150 virtual void requestSetNetworkInfo(const NetworkInfo &info);
152 virtual void setUseAutoReconnect(bool);
153 virtual void setAutoReconnectInterval(quint32);
154 virtual void setAutoReconnectRetries(quint16);
156 void setPingInterval(int interval);
158 void connectToIrc(bool reconnecting = false);
159 void disconnectFromIrc(bool requested = true, const QString &reason = QString(), bool withReconnect = false);
161 void userInput(BufferInfo bufferInfo, QString msg);
162 void putRawLine(QByteArray input);
163 void putCmd(const QString &cmd, const QList<QByteArray> ¶ms, const QByteArray &prefix = QByteArray());
164 void putCmd(const QString &cmd, const QList<QList<QByteArray>> ¶ms, const QByteArray &prefix = QByteArray());
166 void setChannelJoined(const QString &channel);
167 void setChannelParted(const QString &channel);
168 void addChannelKey(const QString &channel, const QString &key);
169 void removeChannelKey(const QString &channel);
173 Cipher *cipher(const QString &recipient);
174 QByteArray cipherKey(const QString &recipient) const;
175 void setCipherKey(const QString &recipient, const QByteArray &key);
176 bool cipherUsesCBC(const QString &target);
179 // IRCv3 capability negotiation (can be connected to signals)
182 * Indicates a capability is now available, with optional value in Network::capValue().
184 * @see Network::addCap()
186 * @param[in] capability Name of the capability
188 void serverCapAdded(const QString &capability);
191 * Indicates a capability was acknowledged (enabled by the IRC server).
193 * @see Network::acknowledgeCap()
195 * @param[in] capability Name of the capability
197 void serverCapAcknowledged(const QString &capability);
200 * Indicates a capability was removed from the list of available capabilities.
202 * @see Network::removeCap()
204 * @param[in] capability Name of the capability
206 void serverCapRemoved(const QString &capability);
209 * Sends the next capability from the queue.
211 * During nick registration if any capabilities remain queued, this will take the next and
212 * request it. When no capabilities remain, capability negotiation is ended.
216 void setAutoWhoEnabled(bool enabled);
217 void setAutoWhoInterval(int interval);
218 void setAutoWhoDelay(int delay);
221 * Appends the given channel/nick to the front of the AutoWho queue.
223 * When 'away-notify' is enabled, this will trigger an immediate AutoWho since regular
224 * who-cycles are disabled as per IRCv3 specifications.
226 * @param[in] channelOrNick Channel or nickname to WHO
228 void queueAutoWhoOneshot(const QString &channelOrNick);
230 bool setAutoWhoDone(const QString &channel);
232 void updateIssuedModes(const QString &requestedModes);
233 void updatePersistentModes(QString addModes, QString removeModes);
234 void resetPersistentModes();
236 Server usedServer() const;
238 inline void resetPingTimeout() { _pingCount = 0; }
240 inline void displayMsg(Message::Type msgType, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None)
242 emit displayMsg(networkId(), msgType, bufferType, target, text, sender, flags);
247 void recvRawServerMsg(QString);
248 void displayStatusMsg(QString);
249 void displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
250 void disconnected(NetworkId networkId);
251 void connectionError(const QString &errorMsg);
253 void quitRequested(NetworkId networkId);
254 void sslErrors(const QVariant &errorData);
256 void newEvent(Event *event);
257 void socketInitialized(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
258 void socketDisconnected(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
261 inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new CoreIrcChannel(channelname, this); }
262 inline virtual IrcUser *ircUserFactory(const QString &hostmask) { return new CoreIrcUser(hostmask, this); }
265 // TODO: remove cached cipher keys, when appropriate
266 //virtual void removeIrcUser(IrcUser *ircuser);
267 //virtual void removeIrcChannel(IrcChannel *ircChannel);
268 //virtual void removeChansAndUsers();
271 void socketHasData();
272 void socketError(QAbstractSocket::SocketError);
273 void socketInitialized();
274 inline void socketCloseTimeout() { socket.abort(); }
275 void socketDisconnected();
276 void socketStateChanged(QAbstractSocket::SocketState);
277 void networkInitialized();
280 void restoreUserModes();
281 void doAutoReconnect();
283 void enablePingTimeout(bool enable = true);
284 void disablePingTimeout();
286 void startAutoWhoCycle();
289 void sslErrors(const QList<QSslError> &errors);
292 void fillBucketAndProcessQueue();
294 void writeToSocket(const QByteArray &data);
297 CoreSession *_coreSession;
305 CoreUserInputHandler *_userInputHandler;
307 QHash<QString, QString> _channelKeys; // stores persistent channels and their passwords, if any
309 QTimer _autoReconnectTimer;
310 int _autoReconnectCount;
312 QTimer _socketCloseTimer;
314 /* this flag triggers quitRequested() once the socket is closed
315 * it is needed to determine whether or not the connection needs to be
316 * in the automatic session restore. */
320 bool _previousConnectionAttemptFailed;
321 int _lastUsedServerIndex;
328 QStringList _autoWhoQueue;
329 QHash<QString, int> _autoWhoPending;
330 QTimer _autoWhoTimer, _autoWhoCycleTimer;
332 // Maintain a list of CAPs that are being checked; if empty, negotiation finished
333 // See http://ircv3.net/specs/core/capability-negotiation-3.2.html
334 QStringList _capsQueued; /// Capabilities to be checked
335 bool _capNegotiationActive; /// Whether or not full capability negotiation was started
336 // Avoid displaying repeat "negotiation finished" messages
337 bool _capInitialNegotiationEnded; /// Whether or not initial capability negotiation finished
338 // Avoid sending repeat "CAP END" replies when registration is already ended
341 * Gets the next capability to request, removing it from the queue.
343 * @returns Name of capability to request
345 QString takeQueuedCap();
347 QTimer _tokenBucketTimer;
348 int _messageDelay; // token refill speed in ms
349 int _burstSize; // size of the token bucket
350 int _tokenBucket; // the virtual bucket that holds the tokens
351 QList<QByteArray> _msgQueue;
353 QString _requestedUserModes; // 2 strings separated by a '-' character. first part are requested modes to add, the second to remove
355 // List of blowfish keys for channels
356 QHash<QString, QByteArray> _cipherKeys;
360 #endif //CORENETWORK_H