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"
35 #include "ircserverhandler.h"
36 #include "userinputhandler.h"
37 #include "ctcphandler.h"
39 NetworkConnection::NetworkConnection(Network *network, CoreSession *session)
41 _connectionState(Network::Disconnected),
43 _coreSession(session),
44 _ircServerHandler(new IrcServerHandler(this)),
45 _userInputHandler(new UserInputHandler(this)),
46 _ctcpHandler(new CtcpHandler(this)),
47 _autoReconnectCount(0),
48 _quitRequested(false),
50 _previousConnectionAttemptFailed(false),
51 _lastUsedServerlistIndex(0),
53 // TODO make autowho configurable (possibly per-network)
54 _autoWhoEnabled(true),
56 _autoWhoNickLimit(0), // unlimited
59 // TokenBucket to avaid sending too much at once
60 _messagesPerSecond(1),
62 _tokenBucket(5) // init with a full bucket
64 _autoReconnectTimer.setSingleShot(true);
65 _socketCloseTimer.setSingleShot(true);
66 connect(&_socketCloseTimer, SIGNAL(timeout()), this, SLOT(socketCloseTimeout()));
68 _autoWhoTimer.setInterval(_autoWhoDelay * 1000);
69 _autoWhoCycleTimer.setInterval(_autoWhoInterval * 1000);
71 _tokenBucketTimer.start(_messagesPerSecond * 1000);
73 QHash<QString, QString> channels = coreSession()->persistentChannels(networkId());
74 foreach(QString chan, channels.keys()) {
75 _channelKeys[chan.toLower()] = channels[chan];
78 connect(&_autoReconnectTimer, SIGNAL(timeout()), this, SLOT(doAutoReconnect()));
79 connect(&_autoWhoTimer, SIGNAL(timeout()), this, SLOT(sendAutoWho()));
80 connect(&_autoWhoCycleTimer, SIGNAL(timeout()), this, SLOT(startAutoWhoCycle()));
81 connect(&_tokenBucketTimer, SIGNAL(timeout()), this, SLOT(fillBucketAndProcessQueue()));
83 connect(network, SIGNAL(currentServerSet(const QString &)), this, SLOT(networkInitialized(const QString &)));
84 connect(network, SIGNAL(useAutoReconnectSet(bool)), this, SLOT(autoReconnectSettingsChanged()));
85 connect(network, SIGNAL(autoReconnectIntervalSet(quint32)), this, SLOT(autoReconnectSettingsChanged()));
86 connect(network, SIGNAL(autoReconnectRetriesSet(quint16)), this, SLOT(autoReconnectSettingsChanged()));
89 connect(&socket, SIGNAL(encrypted()), this, SLOT(socketEncrypted()));
90 connect(&socket, SIGNAL(sslErrors(const QList<QSslError> &)), this, SLOT(sslErrors(const QList<QSslError> &)));
92 connect(&socket, SIGNAL(connected()), this, SLOT(socketConnected()));
94 connect(&socket, SIGNAL(disconnected()), this, SLOT(socketDisconnected()));
95 connect(&socket, SIGNAL(error(QAbstractSocket::SocketError)), this, SLOT(socketError(QAbstractSocket::SocketError)));
96 connect(&socket, SIGNAL(stateChanged(QAbstractSocket::SocketState)), this, SLOT(socketStateChanged(QAbstractSocket::SocketState)));
97 connect(&socket, SIGNAL(readyRead()), this, SLOT(socketHasData()));
99 connect(_ircServerHandler, SIGNAL(nickChanged(const QString &, const QString &)),
100 this, SLOT(nickChanged(const QString &, const QString &)));
102 network->proxy()->attachSignal(this, SIGNAL(sslErrors(const QVariant &)));
105 NetworkConnection::~NetworkConnection() {
106 if(connectionState() != Network::Disconnected && connectionState() != Network::Reconnecting)
107 disconnectFromIrc(false); // clean up, but this does not count as requested disconnect!
108 disconnect(&socket, 0, this, 0); // this keeps the socket from triggering events during clean up
109 delete _ircServerHandler;
110 delete _userInputHandler;
114 void NetworkConnection::setConnectionState(Network::ConnectionState state) {
115 _connectionState = state;
116 network()->setConnectionState(state);
117 emit connectionStateChanged(state);
120 QString NetworkConnection::serverDecode(const QByteArray &string) const {
121 return network()->decodeServerString(string);
124 QString NetworkConnection::channelDecode(const QString &bufferName, const QByteArray &string) const {
125 if(!bufferName.isEmpty()) {
126 IrcChannel *channel = network()->ircChannel(bufferName);
127 if(channel) return channel->decodeString(string);
129 return network()->decodeString(string);
132 QString NetworkConnection::userDecode(const QString &userNick, const QByteArray &string) const {
133 IrcUser *user = network()->ircUser(userNick);
134 if(user) return user->decodeString(string);
135 return network()->decodeString(string);
138 QByteArray NetworkConnection::serverEncode(const QString &string) const {
139 return network()->encodeServerString(string);
142 QByteArray NetworkConnection::channelEncode(const QString &bufferName, const QString &string) const {
143 if(!bufferName.isEmpty()) {
144 IrcChannel *channel = network()->ircChannel(bufferName);
145 if(channel) return channel->encodeString(string);
147 return network()->encodeString(string);
150 QByteArray NetworkConnection::userEncode(const QString &userNick, const QString &string) const {
151 IrcUser *user = network()->ircUser(userNick);
152 if(user) return user->encodeString(string);
153 return network()->encodeString(string);
156 void NetworkConnection::autoReconnectSettingsChanged() {
157 if(!network()->useAutoReconnect()) {
158 _autoReconnectTimer.stop();
159 _autoReconnectCount = 0;
161 _autoReconnectTimer.setInterval(network()->autoReconnectInterval() * 1000);
162 if(_autoReconnectCount != 0) {
163 if(network()->unlimitedReconnectRetries()) _autoReconnectCount = -1;
164 else _autoReconnectCount = network()->autoReconnectRetries();
169 void NetworkConnection::connectToIrc(bool reconnecting) {
170 if(!reconnecting && network()->useAutoReconnect() && _autoReconnectCount == 0) {
171 _autoReconnectTimer.setInterval(network()->autoReconnectInterval() * 1000);
172 if(network()->unlimitedReconnectRetries()) _autoReconnectCount = -1;
173 else _autoReconnectCount = network()->autoReconnectRetries();
175 QVariantList serverList = network()->serverList();
176 Identity *identity = coreSession()->identity(network()->identity());
177 if(!serverList.count()) {
178 qWarning() << "Server list empty, ignoring connect request!";
182 qWarning() << "Invalid identity configures, ignoring connect request!";
185 // use a random server?
186 if(network()->useRandomServer()) {
187 _lastUsedServerlistIndex = qrand() % serverList.size();
188 } else if(_previousConnectionAttemptFailed) {
189 // cycle to next server if previous connection attempt failed
190 displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Connection failed. Cycling to next Server"));
191 if(++_lastUsedServerlistIndex == serverList.size()) {
192 _lastUsedServerlistIndex = 0;
195 _previousConnectionAttemptFailed = false;
197 QString host = serverList[_lastUsedServerlistIndex].toMap()["Host"].toString();
198 quint16 port = serverList[_lastUsedServerlistIndex].toMap()["Port"].toUInt();
199 displayStatusMsg(tr("Connecting to %1:%2...").arg(host).arg(port));
200 displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Connecting to %1:%2...").arg(host).arg(port));
201 socket.connectToHost(host, port);
204 void NetworkConnection::networkInitialized(const QString ¤tServer) {
205 if(currentServer.isEmpty()) return;
207 if(network()->useAutoReconnect() && !network()->unlimitedReconnectRetries()) {
208 _autoReconnectCount = network()->autoReconnectRetries(); // reset counter
213 // now we are initialized
214 setConnectionState(Network::Initialized);
215 network()->setConnected(true);
216 emit connected(networkId());
218 if(_autoWhoEnabled) {
219 _autoWhoCycleTimer.start();
220 _autoWhoTimer.start();
221 startAutoWhoCycle(); // FIXME wait for autojoin to be completed
225 void NetworkConnection::sendPerform() {
226 BufferInfo statusBuf = Core::bufferInfo(coreSession()->user(), network()->networkId(), BufferInfo::StatusBuffer);
228 if(network()->useAutoIdentify() && !network()->autoIdentifyService().isEmpty() && !network()->autoIdentifyPassword().isEmpty()) {
229 userInputHandler()->handleMsg(statusBuf, QString("%1 IDENTIFY %2").arg(network()->autoIdentifyService(), network()->autoIdentifyPassword()));
232 foreach(QString line, network()->perform()) {
233 if(!line.isEmpty()) userInput(statusBuf, line);
236 // rejoin channels we've been in
237 QStringList channels, keys;
238 foreach(QString chan, persistentChannels()) {
239 QString key = channelKey(chan);
241 channels.prepend(chan); keys.prepend(key);
243 channels.append(chan);
246 QString joinString = QString("%1 %2").arg(channels.join(",")).arg(keys.join(",")).trimmed();
247 if(!joinString.isEmpty()) userInputHandler()->handleJoin(statusBuf, joinString);
250 void NetworkConnection::disconnectFromIrc(bool requested) {
251 _quitRequested = requested; // see socketDisconnected();
252 _autoReconnectTimer.stop();
253 _autoReconnectCount = 0; // prohibiting auto reconnect
254 displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Disconnecting."));
255 if(socket.state() == QAbstractSocket::UnconnectedState) {
256 socketDisconnected();
257 } else if(socket.state() < QAbstractSocket::ConnectedState) {
259 // we might be in a state waiting for a timeout... we don't care... set a disconnected state
260 socketDisconnected();
262 _socketCloseTimer.start(10000); // the irc server has 10 seconds to close the socket
266 void NetworkConnection::socketHasData() {
267 while(socket.canReadLine()) {
268 QByteArray s = socket.readLine().trimmed();
269 ircServerHandler()->handleServerMsg(s);
273 void NetworkConnection::socketError(QAbstractSocket::SocketError) {
274 _previousConnectionAttemptFailed = true;
275 qDebug() << qPrintable(tr("Could not connect to %1 (%2)").arg(network()->networkName(), socket.errorString()));
276 emit connectionError(socket.errorString());
277 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Connection failure: %1").arg(socket.errorString()));
278 network()->emitConnectionError(socket.errorString());
279 if(socket.state() < QAbstractSocket::ConnectedState) {
280 socketDisconnected();
282 // mark last connection attempt as failed
284 //qDebug() << "exiting...";
288 #ifndef QT_NO_OPENSSL
290 void NetworkConnection::sslErrors(const QList<QSslError> &sslErrors) {
292 socket.ignoreSslErrors();
293 /* TODO errorhandling
295 QVariantList errnums;
296 foreach(QSslError err, errors) errnums << err.error();
297 errmsg["SslErrors"] = errnums;
298 errmsg["SslCert"] = socket.peerCertificate().toPem();
299 errmsg["PeerAddress"] = socket.peerAddress().toString();
300 errmsg["PeerPort"] = socket.peerPort();
301 errmsg["PeerName"] = socket.peerName();
302 emit sslErrors(errmsg);
307 void NetworkConnection::socketEncrypted() {
308 //qDebug() << "encrypted!";
312 #endif // QT_NO_OPENSSL
314 void NetworkConnection::socketConnected() {
319 if(!network()->serverList()[_lastUsedServerlistIndex].toMap()["UseSSL"].toBool()) {
323 //qDebug() << "starting handshake";
324 socket.startClientEncryption();
328 void NetworkConnection::socketInitialized() {
329 //emit connected(networkId()); initialize first!
330 Identity *identity = coreSession()->identity(network()->identity());
332 qWarning() << "Identity invalid!";
336 QString passwd = network()->serverList()[_lastUsedServerlistIndex].toMap()["Password"].toString();
337 if(!passwd.isEmpty()) {
338 putRawLine(serverEncode(QString("PASS %1").arg(passwd)));
340 putRawLine(serverEncode(QString("NICK :%1").arg(identity->nicks()[0]))); // FIXME: try more nicks if error occurs
341 putRawLine(serverEncode(QString("USER %1 8 * :%2").arg(identity->ident(), identity->realName())));
344 void NetworkConnection::socketStateChanged(QAbstractSocket::SocketState socketState) {
345 Network::ConnectionState state;
346 switch(socketState) {
347 case QAbstractSocket::UnconnectedState:
348 state = Network::Disconnected;
350 case QAbstractSocket::HostLookupState:
351 case QAbstractSocket::ConnectingState:
352 state = Network::Connecting;
354 case QAbstractSocket::ConnectedState:
355 state = Network::Initializing;
357 case QAbstractSocket::ClosingState:
358 state = Network::Disconnecting;
361 state = Network::Disconnected;
363 setConnectionState(state);
366 void NetworkConnection::socketCloseTimeout() {
367 socket.disconnectFromHost();
370 void NetworkConnection::socketDisconnected() {
371 _autoWhoCycleTimer.stop();
372 _autoWhoTimer.stop();
373 _autoWhoQueue.clear();
374 _autoWhoInProgress.clear();
376 _socketCloseTimer.stop();
378 network()->setConnected(false);
379 emit disconnected(networkId());
381 setConnectionState(Network::Disconnected);
382 emit quitRequested(networkId());
383 } else if(_autoReconnectCount != 0) {
384 setConnectionState(Network::Reconnecting);
385 if(_autoReconnectCount == network()->autoReconnectRetries())
386 doAutoReconnect(); // first try is immediate
388 _autoReconnectTimer.start();
392 void NetworkConnection::doAutoReconnect() {
393 if(connectionState() != Network::Disconnected && connectionState() != Network::Reconnecting) {
394 qWarning() << "NetworkConnection::doAutoReconnect(): Cannot reconnect while not being disconnected!";
397 if(_autoReconnectCount > 0) _autoReconnectCount--;
401 // FIXME switch to BufferId
402 void NetworkConnection::userInput(BufferInfo buf, QString msg) {
403 userInputHandler()->handleUserInput(buf, msg);
406 void NetworkConnection::putRawLine(QByteArray s) {
407 if(_tokenBucket > 0) {
414 void NetworkConnection::writeToSocket(QByteArray s) {
420 void NetworkConnection::fillBucketAndProcessQueue() {
421 if(_tokenBucket < _burstSize) {
425 while(_msgQueue.size() > 0 && _tokenBucket > 0) {
426 writeToSocket(_msgQueue.takeFirst());
430 // returns 0 if the message will not be chopped by the irc server or number of chopped bytes if message is too long
431 int NetworkConnection::lastParamOverrun(const QString &cmd, const QList<QByteArray> ¶ms) {
432 //the server will pass our message that trunkated to 512 bytes including CRLF with the following format:
433 // ":prefix COMMAND param0 param1 :lastparam"
434 // where prefix = "nickname!user@host"
435 // that means that the last message can be as long as:
436 // 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)
437 IrcUser *me = network()->me();
438 int maxLen = 480 - cmd.toAscii().count(); // educated guess in case we don't know us (yet?)
441 maxLen = 512 - serverEncode(me->nick()).count() - serverEncode(me->user()).count() - serverEncode(me->host()).count() - cmd.toAscii().count() - 6;
443 if(!params.isEmpty()) {
444 for(int i = 0; i < params.count() - 1; i++) {
445 maxLen -= (params[i].count() + 1);
447 maxLen -= 2; // " :" last param separator;
449 if(params.last().count() > maxLen) {
450 return params.last().count() - maxLen;
459 void NetworkConnection::putCmd(const QString &cmd, const QList<QByteArray> ¶ms, const QByteArray &prefix) {
461 if(cmd == "PRIVMSG" && params.count() > 1) {
462 int overrun = lastParamOverrun(cmd, params);
464 QList<QByteArray> paramCopy1;
465 QList<QByteArray> paramCopy2;
466 for(int i = 0; i < params.count() - 1; i++) {
467 paramCopy1 << params[i];
468 paramCopy2 << params[i];
471 QByteArray lastPart = params.last();
472 QByteArray splitter(" .,-");
473 int maxSplitPos = params.last().count() - overrun;
475 for(int i = 0; i < splitter.size(); i++) {
476 splitPos = qMax(splitPos, lastPart.lastIndexOf(splitter[i], maxSplitPos));
480 splitPos = maxSplitPos;
483 paramCopy1 << lastPart.left(splitPos);
484 paramCopy2 << lastPart.mid(splitPos);
485 putCmd(cmd, paramCopy1, prefix);
486 putCmd(cmd, paramCopy2, prefix);
491 if(!prefix.isEmpty())
492 msg += ":" + prefix + " ";
493 msg += cmd.toUpper().toAscii();
495 for(int i = 0; i < params.size() - 1; i++) {
496 msg += " " + params[i];
498 if(!params.isEmpty())
499 msg += " :" + params.last();
504 void NetworkConnection::sendAutoWho() {
505 while(!_autoWhoQueue.isEmpty()) {
506 QString chan = _autoWhoQueue.takeFirst();
507 IrcChannel *ircchan = network()->ircChannel(chan);
508 if(!ircchan) continue;
509 if(_autoWhoNickLimit > 0 && ircchan->ircUsers().count() > _autoWhoNickLimit) continue;
510 _autoWhoInProgress[chan]++;
511 putRawLine("WHO " + serverEncode(chan));
512 if(_autoWhoQueue.isEmpty() && _autoWhoEnabled && !_autoWhoCycleTimer.isActive()) {
513 // Timer was stopped, means a new cycle is due immediately
514 _autoWhoCycleTimer.start();
521 void NetworkConnection::startAutoWhoCycle() {
522 if(!_autoWhoQueue.isEmpty()) {
523 _autoWhoCycleTimer.stop();
526 _autoWhoQueue = network()->channels();
529 bool NetworkConnection::setAutoWhoDone(const QString &channel) {
530 if(_autoWhoInProgress.value(channel.toLower(), 0) <= 0) return false;
531 _autoWhoInProgress[channel.toLower()]--;
535 void NetworkConnection::setChannelJoined(const QString &channel) {
536 emit channelJoined(networkId(), channel, _channelKeys[channel.toLower()]);
537 _autoWhoQueue.prepend(channel.toLower()); // prepend so this new chan is the first to be checked
540 void NetworkConnection::setChannelParted(const QString &channel) {
541 removeChannelKey(channel);
542 _autoWhoQueue.removeAll(channel.toLower());
543 _autoWhoInProgress.remove(channel.toLower());
544 emit channelParted(networkId(), channel);
547 void NetworkConnection::addChannelKey(const QString &channel, const QString &key) {
549 removeChannelKey(channel);
551 _channelKeys[channel.toLower()] = key;
555 void NetworkConnection::removeChannelKey(const QString &channel) {
556 _channelKeys.remove(channel.toLower());
559 void NetworkConnection::nickChanged(const QString &newNick, const QString &oldNick) {
560 emit nickChanged(networkId(), newNick, oldNick);
563 /* Exception classes for message handling */
564 NetworkConnection::ParseError::ParseError(QString cmd, QString prefix, QStringList params) {
566 _msg = QString("Command Parse Error: ") + cmd + params.join(" ");
569 NetworkConnection::UnknownCmdError::UnknownCmdError(QString cmd, QString prefix, QStringList params) {
571 _msg = QString("Unknown Command: ") + cmd + params.join(" ");