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 ***************************************************************************/
20 #include "networkconnection.h"
22 #include <QMetaObject>
23 #include <QMetaMethod>
28 #include "coresession.h"
30 #include "ircchannel.h"
34 #include "ircserverhandler.h"
35 #include "userinputhandler.h"
36 #include "ctcphandler.h"
38 NetworkConnection::NetworkConnection(Network *network, CoreSession *session)
40 _connectionState(Network::Disconnected),
42 _coreSession(session),
43 _ircServerHandler(new IrcServerHandler(this)),
44 _userInputHandler(new UserInputHandler(this)),
45 _ctcpHandler(new CtcpHandler(this)),
46 _autoReconnectCount(0),
47 _quitRequested(false),
49 _previousConnectionAttemptFailed(false),
50 _lastUsedServerlistIndex(0),
52 // TODO make autowho configurable (possibly per-network)
53 _autoWhoEnabled(true),
55 _autoWhoNickLimit(0), // unlimited
58 // TokenBucket to avaid sending too much at once
59 _messagesPerSecond(1),
61 _tokenBucket(5) // init with a full bucket
63 _autoReconnectTimer.setSingleShot(true);
64 _socketCloseTimer.setSingleShot(true);
65 connect(&_socketCloseTimer, SIGNAL(timeout()), this, SLOT(socketCloseTimeout()));
67 _pingTimer.setInterval(60000);
68 connect(&_pingTimer, SIGNAL(timeout()), this, SLOT(sendPing()));
70 _autoWhoTimer.setInterval(_autoWhoDelay * 1000);
71 _autoWhoCycleTimer.setInterval(_autoWhoInterval * 1000);
73 _tokenBucketTimer.start(_messagesPerSecond * 1000);
75 QHash<QString, QString> channels = coreSession()->persistentChannels(networkId());
76 foreach(QString chan, channels.keys()) {
77 _channelKeys[chan.toLower()] = channels[chan];
80 connect(&_autoReconnectTimer, SIGNAL(timeout()), this, SLOT(doAutoReconnect()));
81 connect(&_autoWhoTimer, SIGNAL(timeout()), this, SLOT(sendAutoWho()));
82 connect(&_autoWhoCycleTimer, SIGNAL(timeout()), this, SLOT(startAutoWhoCycle()));
83 connect(&_tokenBucketTimer, SIGNAL(timeout()), this, SLOT(fillBucketAndProcessQueue()));
85 connect(network, SIGNAL(currentServerSet(const QString &)), this, SLOT(networkInitialized(const QString &)));
86 connect(network, SIGNAL(useAutoReconnectSet(bool)), this, SLOT(autoReconnectSettingsChanged()));
87 connect(network, SIGNAL(autoReconnectIntervalSet(quint32)), this, SLOT(autoReconnectSettingsChanged()));
88 connect(network, SIGNAL(autoReconnectRetriesSet(quint16)), this, SLOT(autoReconnectSettingsChanged()));
91 connect(&socket, SIGNAL(encrypted()), this, SLOT(socketEncrypted()));
92 connect(&socket, SIGNAL(sslErrors(const QList<QSslError> &)), this, SLOT(sslErrors(const QList<QSslError> &)));
94 connect(&socket, SIGNAL(connected()), this, SLOT(socketConnected()));
96 connect(&socket, SIGNAL(disconnected()), this, SLOT(socketDisconnected()));
97 connect(&socket, SIGNAL(error(QAbstractSocket::SocketError)), this, SLOT(socketError(QAbstractSocket::SocketError)));
98 connect(&socket, SIGNAL(stateChanged(QAbstractSocket::SocketState)), this, SLOT(socketStateChanged(QAbstractSocket::SocketState)));
99 connect(&socket, SIGNAL(readyRead()), this, SLOT(socketHasData()));
101 connect(_ircServerHandler, SIGNAL(nickChanged(const QString &, const QString &)),
102 this, SLOT(nickChanged(const QString &, const QString &)));
104 network->proxy()->attachSignal(this, SIGNAL(sslErrors(const QVariant &)));
107 NetworkConnection::~NetworkConnection() {
108 if(connectionState() != Network::Disconnected && connectionState() != Network::Reconnecting)
109 disconnectFromIrc(false); // clean up, but this does not count as requested disconnect!
110 disconnect(&socket, 0, this, 0); // this keeps the socket from triggering events during clean up
111 delete _ircServerHandler;
112 delete _userInputHandler;
116 void NetworkConnection::setConnectionState(Network::ConnectionState state) {
117 _connectionState = state;
118 network()->setConnectionState(state);
119 emit connectionStateChanged(state);
122 QString NetworkConnection::serverDecode(const QByteArray &string) const {
123 return network()->decodeServerString(string);
126 QString NetworkConnection::channelDecode(const QString &bufferName, const QByteArray &string) const {
127 if(!bufferName.isEmpty()) {
128 IrcChannel *channel = network()->ircChannel(bufferName);
129 if(channel) return channel->decodeString(string);
131 return network()->decodeString(string);
134 QString NetworkConnection::userDecode(const QString &userNick, const QByteArray &string) const {
135 IrcUser *user = network()->ircUser(userNick);
136 if(user) return user->decodeString(string);
137 return network()->decodeString(string);
140 QByteArray NetworkConnection::serverEncode(const QString &string) const {
141 return network()->encodeServerString(string);
144 QByteArray NetworkConnection::channelEncode(const QString &bufferName, const QString &string) const {
145 if(!bufferName.isEmpty()) {
146 IrcChannel *channel = network()->ircChannel(bufferName);
147 if(channel) return channel->encodeString(string);
149 return network()->encodeString(string);
152 QByteArray NetworkConnection::userEncode(const QString &userNick, const QString &string) const {
153 IrcUser *user = network()->ircUser(userNick);
154 if(user) return user->encodeString(string);
155 return network()->encodeString(string);
158 void NetworkConnection::autoReconnectSettingsChanged() {
159 if(!network()->useAutoReconnect()) {
160 _autoReconnectTimer.stop();
161 _autoReconnectCount = 0;
163 _autoReconnectTimer.setInterval(network()->autoReconnectInterval() * 1000);
164 if(_autoReconnectCount != 0) {
165 if(network()->unlimitedReconnectRetries()) _autoReconnectCount = -1;
166 else _autoReconnectCount = network()->autoReconnectRetries();
171 void NetworkConnection::connectToIrc(bool reconnecting) {
172 if(!reconnecting && network()->useAutoReconnect() && _autoReconnectCount == 0) {
173 _autoReconnectTimer.setInterval(network()->autoReconnectInterval() * 1000);
174 if(network()->unlimitedReconnectRetries()) _autoReconnectCount = -1;
175 else _autoReconnectCount = network()->autoReconnectRetries();
177 QVariantList serverList = network()->serverList();
178 Identity *identity = coreSession()->identity(network()->identity());
179 if(!serverList.count()) {
180 qWarning() << "Server list empty, ignoring connect request!";
184 qWarning() << "Invalid identity configures, ignoring connect request!";
187 // use a random server?
188 if(network()->useRandomServer()) {
189 _lastUsedServerlistIndex = qrand() % serverList.size();
190 } else if(_previousConnectionAttemptFailed) {
191 // cycle to next server if previous connection attempt failed
192 displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Connection failed. Cycling to next Server"));
193 if(++_lastUsedServerlistIndex == serverList.size()) {
194 _lastUsedServerlistIndex = 0;
197 _previousConnectionAttemptFailed = false;
199 QString host = serverList[_lastUsedServerlistIndex].toMap()["Host"].toString();
200 quint16 port = serverList[_lastUsedServerlistIndex].toMap()["Port"].toUInt();
201 displayStatusMsg(tr("Connecting to %1:%2...").arg(host).arg(port));
202 displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Connecting to %1:%2...").arg(host).arg(port));
203 socket.connectToHost(host, port);
206 void NetworkConnection::networkInitialized(const QString ¤tServer) {
207 if(currentServer.isEmpty()) return;
209 if(network()->useAutoReconnect() && !network()->unlimitedReconnectRetries()) {
210 _autoReconnectCount = network()->autoReconnectRetries(); // reset counter
215 // now we are initialized
216 setConnectionState(Network::Initialized);
217 network()->setConnected(true);
218 emit connected(networkId());
222 if(_autoWhoEnabled) {
223 _autoWhoCycleTimer.start();
224 _autoWhoTimer.start();
225 startAutoWhoCycle(); // FIXME wait for autojoin to be completed
229 void NetworkConnection::sendPerform() {
230 BufferInfo statusBuf = Core::bufferInfo(coreSession()->user(), network()->networkId(), BufferInfo::StatusBuffer);
232 if(network()->useAutoIdentify() && !network()->autoIdentifyService().isEmpty() && !network()->autoIdentifyPassword().isEmpty()) {
233 userInputHandler()->handleMsg(statusBuf, QString("%1 IDENTIFY %2").arg(network()->autoIdentifyService(), network()->autoIdentifyPassword()));
236 foreach(QString line, network()->perform()) {
237 if(!line.isEmpty()) userInput(statusBuf, line);
240 // rejoin channels we've been in
241 QStringList channels, keys;
242 foreach(QString chan, persistentChannels()) {
243 QString key = channelKey(chan);
245 channels.prepend(chan); keys.prepend(key);
247 channels.append(chan);
250 QString joinString = QString("%1 %2").arg(channels.join(",")).arg(keys.join(",")).trimmed();
251 if(!joinString.isEmpty()) userInputHandler()->handleJoin(statusBuf, joinString);
254 void NetworkConnection::disconnectFromIrc(bool requested) {
255 _quitRequested = requested; // see socketDisconnected();
256 _autoReconnectTimer.stop();
257 _autoReconnectCount = 0; // prohibiting auto reconnect
258 displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Disconnecting."));
259 if(socket.state() == QAbstractSocket::UnconnectedState) {
260 socketDisconnected();
261 } else if(socket.state() < QAbstractSocket::ConnectedState) {
263 // we might be in a state waiting for a timeout... we don't care... set a disconnected state
264 socketDisconnected();
266 _socketCloseTimer.start(10000); // the irc server has 10 seconds to close the socket
270 void NetworkConnection::socketHasData() {
271 while(socket.canReadLine()) {
272 QByteArray s = socket.readLine().trimmed();
273 ircServerHandler()->handleServerMsg(s);
277 void NetworkConnection::socketError(QAbstractSocket::SocketError) {
278 _previousConnectionAttemptFailed = true;
279 qDebug() << qPrintable(tr("Could not connect to %1 (%2)").arg(network()->networkName(), socket.errorString()));
280 emit connectionError(socket.errorString());
281 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Connection failure: %1").arg(socket.errorString()));
282 network()->emitConnectionError(socket.errorString());
283 if(socket.state() < QAbstractSocket::ConnectedState) {
284 socketDisconnected();
286 // mark last connection attempt as failed
288 //qDebug() << "exiting...";
292 #ifndef QT_NO_OPENSSL
294 void NetworkConnection::sslErrors(const QList<QSslError> &sslErrors) {
296 socket.ignoreSslErrors();
297 /* TODO errorhandling
299 QVariantList errnums;
300 foreach(QSslError err, errors) errnums << err.error();
301 errmsg["SslErrors"] = errnums;
302 errmsg["SslCert"] = socket.peerCertificate().toPem();
303 errmsg["PeerAddress"] = socket.peerAddress().toString();
304 errmsg["PeerPort"] = socket.peerPort();
305 errmsg["PeerName"] = socket.peerName();
306 emit sslErrors(errmsg);
311 void NetworkConnection::socketEncrypted() {
312 //qDebug() << "encrypted!";
316 #endif // QT_NO_OPENSSL
318 void NetworkConnection::socketConnected() {
323 if(!network()->serverList()[_lastUsedServerlistIndex].toMap()["UseSSL"].toBool()) {
327 //qDebug() << "starting handshake";
328 socket.startClientEncryption();
332 void NetworkConnection::socketInitialized() {
333 //emit connected(networkId()); initialize first!
334 Identity *identity = coreSession()->identity(network()->identity());
336 qWarning() << "Identity invalid!";
340 QString passwd = network()->serverList()[_lastUsedServerlistIndex].toMap()["Password"].toString();
341 if(!passwd.isEmpty()) {
342 putRawLine(serverEncode(QString("PASS %1").arg(passwd)));
344 putRawLine(serverEncode(QString("NICK :%1").arg(identity->nicks()[0]))); // FIXME: try more nicks if error occurs
345 putRawLine(serverEncode(QString("USER %1 8 * :%2").arg(identity->ident(), identity->realName())));
348 void NetworkConnection::socketStateChanged(QAbstractSocket::SocketState socketState) {
349 Network::ConnectionState state;
350 switch(socketState) {
351 case QAbstractSocket::UnconnectedState:
352 state = Network::Disconnected;
354 case QAbstractSocket::HostLookupState:
355 case QAbstractSocket::ConnectingState:
356 state = Network::Connecting;
358 case QAbstractSocket::ConnectedState:
359 state = Network::Initializing;
361 case QAbstractSocket::ClosingState:
362 state = Network::Disconnecting;
365 state = Network::Disconnected;
367 setConnectionState(state);
370 void NetworkConnection::socketCloseTimeout() {
371 socket.disconnectFromHost();
374 void NetworkConnection::socketDisconnected() {
376 _autoWhoCycleTimer.stop();
377 _autoWhoTimer.stop();
378 _autoWhoQueue.clear();
379 _autoWhoInProgress.clear();
381 _socketCloseTimer.stop();
383 network()->setConnected(false);
384 emit disconnected(networkId());
386 setConnectionState(Network::Disconnected);
387 emit quitRequested(networkId());
388 } else if(_autoReconnectCount != 0) {
389 setConnectionState(Network::Reconnecting);
390 if(_autoReconnectCount == network()->autoReconnectRetries())
391 doAutoReconnect(); // first try is immediate
393 _autoReconnectTimer.start();
397 void NetworkConnection::doAutoReconnect() {
398 if(connectionState() != Network::Disconnected && connectionState() != Network::Reconnecting) {
399 qWarning() << "NetworkConnection::doAutoReconnect(): Cannot reconnect while not being disconnected!";
402 if(_autoReconnectCount > 0) _autoReconnectCount--;
406 // FIXME switch to BufferId
407 void NetworkConnection::userInput(BufferInfo buf, QString msg) {
408 userInputHandler()->handleUserInput(buf, msg);
411 void NetworkConnection::putRawLine(QByteArray s) {
412 if(_tokenBucket > 0) {
413 // qDebug() << "putRawLine: " << s;
420 void NetworkConnection::writeToSocket(QByteArray s) {
422 // qDebug() << "writeToSocket: " << s.size();
427 void NetworkConnection::fillBucketAndProcessQueue() {
428 if(_tokenBucket < _burstSize) {
432 while(_msgQueue.size() > 0 && _tokenBucket > 0) {
433 writeToSocket(_msgQueue.takeFirst());
437 // returns 0 if the message will not be chopped by the irc server or number of chopped bytes if message is too long
438 int NetworkConnection::lastParamOverrun(const QString &cmd, const QList<QByteArray> ¶ms) {
439 //the server will pass our message that trunkated to 512 bytes including CRLF with the following format:
440 // ":prefix COMMAND param0 param1 :lastparam"
441 // where prefix = "nickname!user@host"
442 // that means that the last message can be as long as:
443 // 512 - nicklen - userlen - hostlen - commandlen - sum(param[0]..param[n-1])) - 2 (for CRLF) - 4 (":!@" + 1space between prefix and command) - max(paramcount - 1, 0) (space for simple params) - 2 (space and colon for last param)
444 IrcUser *me = network()->me();
445 int maxLen = 480 - cmd.toAscii().count(); // educated guess in case we don't know us (yet?)
448 maxLen = 512 - serverEncode(me->nick()).count() - serverEncode(me->user()).count() - serverEncode(me->host()).count() - cmd.toAscii().count() - 6;
450 if(!params.isEmpty()) {
451 for(int i = 0; i < params.count() - 1; i++) {
452 maxLen -= (params[i].count() + 1);
454 maxLen -= 2; // " :" last param separator;
456 if(params.last().count() > maxLen) {
457 return params.last().count() - maxLen;
466 void NetworkConnection::putCmd(const QString &cmd, const QList<QByteArray> ¶ms, const QByteArray &prefix) {
468 if(cmd == "PRIVMSG" && params.count() > 1) {
469 int overrun = lastParamOverrun(cmd, params);
471 QList<QByteArray> paramCopy1;
472 QList<QByteArray> paramCopy2;
473 for(int i = 0; i < params.count() - 1; i++) {
474 paramCopy1 << params[i];
475 paramCopy2 << params[i];
478 QByteArray lastPart = params.last();
479 QByteArray splitter(" .,-");
480 int maxSplitPos = params.last().count() - overrun;
482 for(int i = 0; i < splitter.size(); i++) {
483 splitPos = qMax(splitPos, lastPart.lastIndexOf(splitter[i], maxSplitPos));
487 splitPos = maxSplitPos;
490 paramCopy1 << lastPart.left(splitPos);
491 paramCopy2 << lastPart.mid(splitPos);
492 putCmd(cmd, paramCopy1, prefix);
493 putCmd(cmd, paramCopy2, prefix);
498 if(!prefix.isEmpty())
499 msg += ":" + prefix + " ";
500 msg += cmd.toUpper().toAscii();
502 for(int i = 0; i < params.size() - 1; i++) {
503 msg += " " + params[i];
505 if(!params.isEmpty())
506 msg += " :" + params.last();
511 void NetworkConnection::sendPing() {
512 userInputHandler()->handlePing(BufferInfo(), QString());
515 void NetworkConnection::sendAutoWho() {
516 while(!_autoWhoQueue.isEmpty()) {
517 QString chan = _autoWhoQueue.takeFirst();
518 IrcChannel *ircchan = network()->ircChannel(chan);
519 if(!ircchan) continue;
520 if(_autoWhoNickLimit > 0 && ircchan->ircUsers().count() > _autoWhoNickLimit) continue;
521 _autoWhoInProgress[chan]++;
522 putRawLine("WHO " + serverEncode(chan));
523 if(_autoWhoQueue.isEmpty() && _autoWhoEnabled && !_autoWhoCycleTimer.isActive()) {
524 // Timer was stopped, means a new cycle is due immediately
525 _autoWhoCycleTimer.start();
532 void NetworkConnection::startAutoWhoCycle() {
533 if(!_autoWhoQueue.isEmpty()) {
534 _autoWhoCycleTimer.stop();
537 _autoWhoQueue = network()->channels();
540 bool NetworkConnection::setAutoWhoDone(const QString &channel) {
541 if(_autoWhoInProgress.value(channel.toLower(), 0) <= 0) return false;
542 _autoWhoInProgress[channel.toLower()]--;
546 void NetworkConnection::setChannelJoined(const QString &channel) {
547 emit channelJoined(networkId(), channel, _channelKeys[channel.toLower()]);
548 _autoWhoQueue.prepend(channel.toLower()); // prepend so this new chan is the first to be checked
551 void NetworkConnection::setChannelParted(const QString &channel) {
552 removeChannelKey(channel);
553 _autoWhoQueue.removeAll(channel.toLower());
554 _autoWhoInProgress.remove(channel.toLower());
555 emit channelParted(networkId(), channel);
558 void NetworkConnection::addChannelKey(const QString &channel, const QString &key) {
560 removeChannelKey(channel);
562 _channelKeys[channel.toLower()] = key;
566 void NetworkConnection::removeChannelKey(const QString &channel) {
567 _channelKeys.remove(channel.toLower());
570 void NetworkConnection::nickChanged(const QString &newNick, const QString &oldNick) {
571 emit nickChanged(networkId(), newNick, oldNick);
574 /* Exception classes for message handling */
575 NetworkConnection::ParseError::ParseError(QString cmd, QString prefix, QStringList params) {
577 _msg = QString("Command Parse Error: ") + cmd + params.join(" ");
580 NetworkConnection::UnknownCmdError::UnknownCmdError(QString cmd, QString prefix, QStringList params) {
582 _msg = QString("Unknown Command: ") + cmd + params.join(" ");