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 _autoReconnectTimer.stop();
256 _autoReconnectCount = 0;
257 displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Disconnecting."));
258 if(socket.state() < QAbstractSocket::ConnectedState) {
259 setConnectionState(Network::Disconnected);
260 socketDisconnected();
262 _socketCloseTimer.start(10000); // the irc server has 10 seconds to close the socket
265 // this flag triggers quitRequested() once the socket is closed
266 // it is needed to determine whether or not the connection needs to be
267 // in the automatic session restore.
268 _quitRequested = requested;
271 void NetworkConnection::socketHasData() {
272 while(socket.canReadLine()) {
273 QByteArray s = socket.readLine().trimmed();
274 ircServerHandler()->handleServerMsg(s);
278 void NetworkConnection::socketError(QAbstractSocket::SocketError) {
279 _previousConnectionAttemptFailed = true;
280 qDebug() << qPrintable(tr("Could not connect to %1 (%2)").arg(network()->networkName(), socket.errorString()));
281 emit connectionError(socket.errorString());
282 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Connection failure: %1").arg(socket.errorString()));
283 network()->emitConnectionError(socket.errorString());
284 if(socket.state() < QAbstractSocket::ConnectedState) {
285 setConnectionState(Network::Disconnected);
286 socketDisconnected();
288 // mark last connection attempt as failed
290 //qDebug() << "exiting...";
294 #ifndef QT_NO_OPENSSL
296 void NetworkConnection::sslErrors(const QList<QSslError> &sslErrors) {
298 socket.ignoreSslErrors();
299 /* TODO errorhandling
301 QVariantList errnums;
302 foreach(QSslError err, errors) errnums << err.error();
303 errmsg["SslErrors"] = errnums;
304 errmsg["SslCert"] = socket.peerCertificate().toPem();
305 errmsg["PeerAddress"] = socket.peerAddress().toString();
306 errmsg["PeerPort"] = socket.peerPort();
307 errmsg["PeerName"] = socket.peerName();
308 emit sslErrors(errmsg);
313 void NetworkConnection::socketEncrypted() {
314 //qDebug() << "encrypted!";
318 #endif // QT_NO_OPENSSL
320 void NetworkConnection::socketConnected() {
325 if(!network()->serverList()[_lastUsedServerlistIndex].toMap()["UseSSL"].toBool()) {
329 //qDebug() << "starting handshake";
330 socket.startClientEncryption();
334 void NetworkConnection::socketInitialized() {
335 //emit connected(networkId()); initialize first!
336 Identity *identity = coreSession()->identity(network()->identity());
338 qWarning() << "Identity invalid!";
342 QString passwd = network()->serverList()[_lastUsedServerlistIndex].toMap()["Password"].toString();
343 if(!passwd.isEmpty()) {
344 putRawLine(serverEncode(QString("PASS %1").arg(passwd)));
346 putRawLine(serverEncode(QString("NICK :%1").arg(identity->nicks()[0]))); // FIXME: try more nicks if error occurs
347 putRawLine(serverEncode(QString("USER %1 8 * :%2").arg(identity->ident(), identity->realName())));
350 void NetworkConnection::socketStateChanged(QAbstractSocket::SocketState socketState) {
351 Network::ConnectionState state;
352 switch(socketState) {
353 case QAbstractSocket::UnconnectedState:
354 state = Network::Disconnected;
356 case QAbstractSocket::HostLookupState:
357 case QAbstractSocket::ConnectingState:
358 state = Network::Connecting;
360 case QAbstractSocket::ConnectedState:
361 state = Network::Initializing;
363 case QAbstractSocket::ClosingState:
364 state = Network::Disconnecting;
367 state = Network::Disconnected;
369 setConnectionState(state);
372 void NetworkConnection::socketCloseTimeout() {
373 socket.disconnectFromHost();
376 void NetworkConnection::socketDisconnected() {
378 _autoWhoCycleTimer.stop();
379 _autoWhoTimer.stop();
380 _autoWhoQueue.clear();
381 _autoWhoInProgress.clear();
383 _socketCloseTimer.stop();
385 network()->setConnected(false);
386 emit disconnected(networkId());
387 if(_autoReconnectCount != 0) {
388 setConnectionState(Network::Reconnecting);
389 if(_autoReconnectCount == network()->autoReconnectRetries()) doAutoReconnect(); // first try is immediate
390 else _autoReconnectTimer.start();
391 } else if(_quitRequested) {
392 emit quitRequested(networkId());
396 void NetworkConnection::doAutoReconnect() {
397 if(connectionState() != Network::Disconnected && connectionState() != Network::Reconnecting) {
398 qWarning() << "NetworkConnection::doAutoReconnect(): Cannot reconnect while not being disconnected!";
401 if(_autoReconnectCount > 0) _autoReconnectCount--;
405 // FIXME switch to BufferId
406 void NetworkConnection::userInput(BufferInfo buf, QString msg) {
407 userInputHandler()->handleUserInput(buf, msg);
410 void NetworkConnection::putRawLine(QByteArray s) {
411 if(_tokenBucket > 0) {
412 // qDebug() << "putRawLine: " << s;
419 void NetworkConnection::writeToSocket(QByteArray s) {
421 // qDebug() << "writeToSocket: " << s.size();
426 void NetworkConnection::fillBucketAndProcessQueue() {
427 if(_tokenBucket < _burstSize) {
431 while(_msgQueue.size() > 0 && _tokenBucket > 0) {
432 writeToSocket(_msgQueue.takeFirst());
436 // returns 0 if the message will not be chopped by the irc server or number of chopped bytes if message is too long
437 int NetworkConnection::lastParamOverrun(const QString &cmd, const QList<QByteArray> ¶ms) {
438 //the server will pass our message that trunkated to 512 bytes including CRLF with the following format:
439 // ":prefix COMMAND param0 param1 :lastparam"
440 // where prefix = "nickname!user@host"
441 // that means that the last message can be as long as:
442 // 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)
443 IrcUser *me = network()->me();
444 int maxLen = 480 - cmd.toAscii().count(); // educated guess in case we don't know us (yet?)
447 maxLen = 512 - serverEncode(me->nick()).count() - serverEncode(me->user()).count() - serverEncode(me->host()).count() - cmd.toAscii().count() - 6;
449 if(!params.isEmpty()) {
450 for(int i = 0; i < params.count() - 1; i++) {
451 maxLen -= (params[i].count() + 1);
453 maxLen -= 2; // " :" last param separator;
455 if(params.last().count() > maxLen) {
456 return params.last().count() - maxLen;
465 void NetworkConnection::putCmd(const QString &cmd, const QList<QByteArray> ¶ms, const QByteArray &prefix) {
467 if(cmd == "PRIVMSG" && params.count() > 1) {
468 int overrun = lastParamOverrun(cmd, params);
470 QList<QByteArray> paramCopy1;
471 QList<QByteArray> paramCopy2;
472 for(int i = 0; i < params.count() - 1; i++) {
473 paramCopy1 << params[i];
474 paramCopy2 << params[i];
477 QByteArray lastPart = params.last();
478 QByteArray splitter(" .,-");
479 int maxSplitPos = params.last().count() - overrun;
481 for(int i = 0; i < splitter.size(); i++) {
482 splitPos = qMax(splitPos, lastPart.lastIndexOf(splitter[i], maxSplitPos));
486 splitPos = maxSplitPos;
489 paramCopy1 << lastPart.left(splitPos);
490 paramCopy2 << lastPart.mid(splitPos);
491 putCmd(cmd, paramCopy1, prefix);
492 putCmd(cmd, paramCopy2, prefix);
497 if(!prefix.isEmpty())
498 msg += ":" + prefix + " ";
499 msg += cmd.toUpper().toAscii();
501 for(int i = 0; i < params.size() - 1; i++) {
502 msg += " " + params[i];
504 if(!params.isEmpty())
505 msg += " :" + params.last();
510 void NetworkConnection::sendPing() {
511 userInputHandler()->handlePing(BufferInfo(), QString());
514 void NetworkConnection::sendAutoWho() {
515 while(!_autoWhoQueue.isEmpty()) {
516 QString chan = _autoWhoQueue.takeFirst();
517 IrcChannel *ircchan = network()->ircChannel(chan);
518 if(!ircchan) continue;
519 if(_autoWhoNickLimit > 0 && ircchan->ircUsers().count() > _autoWhoNickLimit) continue;
520 _autoWhoInProgress[chan]++;
521 putRawLine("WHO " + serverEncode(chan));
522 if(_autoWhoQueue.isEmpty() && _autoWhoEnabled && !_autoWhoCycleTimer.isActive()) {
523 // Timer was stopped, means a new cycle is due immediately
524 _autoWhoCycleTimer.start();
531 void NetworkConnection::startAutoWhoCycle() {
532 if(!_autoWhoQueue.isEmpty()) {
533 _autoWhoCycleTimer.stop();
536 _autoWhoQueue = network()->channels();
539 bool NetworkConnection::setAutoWhoDone(const QString &channel) {
540 if(_autoWhoInProgress.value(channel.toLower(), 0) <= 0) return false;
541 _autoWhoInProgress[channel.toLower()]--;
545 void NetworkConnection::setChannelJoined(const QString &channel) {
546 emit channelJoined(networkId(), channel, _channelKeys[channel.toLower()]);
547 _autoWhoQueue.prepend(channel.toLower()); // prepend so this new chan is the first to be checked
550 void NetworkConnection::setChannelParted(const QString &channel) {
551 removeChannelKey(channel);
552 _autoWhoQueue.removeAll(channel.toLower());
553 _autoWhoInProgress.remove(channel.toLower());
554 emit channelParted(networkId(), channel);
557 void NetworkConnection::addChannelKey(const QString &channel, const QString &key) {
559 removeChannelKey(channel);
561 _channelKeys[channel.toLower()] = key;
565 void NetworkConnection::removeChannelKey(const QString &channel) {
566 _channelKeys.remove(channel.toLower());
569 void NetworkConnection::nickChanged(const QString &newNick, const QString &oldNick) {
570 emit nickChanged(networkId(), newNick, oldNick);
573 /* Exception classes for message handling */
574 NetworkConnection::ParseError::ParseError(QString cmd, QString prefix, QStringList params) {
576 _msg = QString("Command Parse Error: ") + cmd + params.join(" ");
579 NetworkConnection::UnknownCmdError::UnknownCmdError(QString cmd, QString prefix, QStringList params) {
581 _msg = QString("Unknown Command: ") + cmd + params.join(" ");