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);
104 virtual void setMyNick(const QString &mynick);
106 virtual void requestConnect() const;
107 virtual void requestDisconnect() const;
108 virtual void requestSetNetworkInfo(const NetworkInfo &info);
110 virtual void setUseAutoReconnect(bool);
111 virtual void setAutoReconnectInterval(quint32);
112 virtual void setAutoReconnectRetries(quint16);
114 void setPingInterval(int interval);
116 void connectToIrc(bool reconnecting = false);
117 void disconnectFromIrc(bool requested = true, const QString &reason = QString(), bool withReconnect = false);
119 void userInput(BufferInfo bufferInfo, QString msg);
120 void putRawLine(QByteArray input);
121 void putCmd(const QString &cmd, const QList<QByteArray> ¶ms, const QByteArray &prefix = QByteArray());
122 void putCmd(const QString &cmd, const QList<QList<QByteArray>> ¶ms, const QByteArray &prefix = QByteArray());
124 void setChannelJoined(const QString &channel);
125 void setChannelParted(const QString &channel);
126 void addChannelKey(const QString &channel, const QString &key);
127 void removeChannelKey(const QString &channel);
131 Cipher *cipher(const QString &recipient);
132 QByteArray cipherKey(const QString &recipient) const;
133 void setCipherKey(const QString &recipient, const QByteArray &key);
134 bool cipherUsesCBC(const QString &target);
137 void setAutoWhoEnabled(bool enabled);
138 void setAutoWhoInterval(int interval);
139 void setAutoWhoDelay(int delay);
141 bool setAutoWhoDone(const QString &channel);
143 void updateIssuedModes(const QString &requestedModes);
144 void updatePersistentModes(QString addModes, QString removeModes);
145 void resetPersistentModes();
147 Server usedServer() const;
149 inline void resetPingTimeout() { _pingCount = 0; }
151 inline void displayMsg(Message::Type msgType, BufferInfo::Type bufferType, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None)
153 emit displayMsg(networkId(), msgType, bufferType, target, text, sender, flags);
158 void recvRawServerMsg(QString);
159 void displayStatusMsg(QString);
160 void displayMsg(NetworkId, Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
161 void disconnected(NetworkId networkId);
162 void connectionError(const QString &errorMsg);
164 void quitRequested(NetworkId networkId);
165 void sslErrors(const QVariant &errorData);
167 void newEvent(Event *event);
168 void socketOpen(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
169 void socketInitialized(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
170 void socketDisconnected(const CoreIdentity *identity, const QHostAddress &localAddress, quint16 localPort, const QHostAddress &peerAddress, quint16 peerPort);
173 inline virtual IrcChannel *ircChannelFactory(const QString &channelname) { return new CoreIrcChannel(channelname, this); }
174 inline virtual IrcUser *ircUserFactory(const QString &hostmask) { return new CoreIrcUser(hostmask, this); }
177 // TODO: remove cached cipher keys, when appropriate
178 //virtual void removeIrcUser(IrcUser *ircuser);
179 //virtual void removeIrcChannel(IrcChannel *ircChannel);
180 //virtual void removeChansAndUsers();
183 void socketHasData();
184 void socketError(QAbstractSocket::SocketError);
185 void socketInitialized();
186 inline void socketCloseTimeout() { socket.abort(); }
187 void socketDisconnected();
188 void socketStateChanged(QAbstractSocket::SocketState);
189 void networkInitialized();
192 void restoreUserModes();
193 void doAutoReconnect();
195 void enablePingTimeout(bool enable = true);
196 void disablePingTimeout();
198 void startAutoWhoCycle();
201 void sslErrors(const QList<QSslError> &errors);
204 void fillBucketAndProcessQueue();
206 void writeToSocket(const QByteArray &data);
209 CoreSession *_coreSession;
217 CoreUserInputHandler *_userInputHandler;
219 QHash<QString, QString> _channelKeys; // stores persistent channels and their passwords, if any
221 QTimer _autoReconnectTimer;
222 int _autoReconnectCount;
224 QTimer _socketCloseTimer;
226 /* this flag triggers quitRequested() once the socket is closed
227 * it is needed to determine whether or not the connection needs to be
228 * in the automatic session restore. */
232 bool _previousConnectionAttemptFailed;
233 int _lastUsedServerIndex;
240 QStringList _autoWhoQueue;
241 QHash<QString, int> _autoWhoPending;
242 QTimer _autoWhoTimer, _autoWhoCycleTimer;
244 QTimer _tokenBucketTimer;
245 int _messageDelay; // token refill speed in ms
246 int _burstSize; // size of the token bucket
247 int _tokenBucket; // the virtual bucket that holds the tokens
248 QList<QByteArray> _msgQueue;
250 QString _requestedUserModes; // 2 strings separated by a '-' character. first part are requested modes to add, the second to remove
252 // List of blowfish keys for channels
253 QHash<QString, QByteArray> _cipherKeys;
257 #endif //CORENETWORK_H