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 _pingTimer.setInterval(60000);
69 connect(&_pingTimer, SIGNAL(timeout()), this, SLOT(sendPing()));
71 _autoWhoTimer.setInterval(_autoWhoDelay * 1000);
72 _autoWhoCycleTimer.setInterval(_autoWhoInterval * 1000);
74 _tokenBucketTimer.start(_messagesPerSecond * 1000);
76 QHash<QString, QString> channels = coreSession()->persistentChannels(networkId());
77 foreach(QString chan, channels.keys()) {
78 _channelKeys[chan.toLower()] = channels[chan];
81 connect(&_autoReconnectTimer, SIGNAL(timeout()), this, SLOT(doAutoReconnect()));
82 connect(&_autoWhoTimer, SIGNAL(timeout()), this, SLOT(sendAutoWho()));
83 connect(&_autoWhoCycleTimer, SIGNAL(timeout()), this, SLOT(startAutoWhoCycle()));
84 connect(&_tokenBucketTimer, SIGNAL(timeout()), this, SLOT(fillBucketAndProcessQueue()));
86 connect(network, SIGNAL(currentServerSet(const QString &)), this, SLOT(networkInitialized(const QString &)));
87 connect(network, SIGNAL(useAutoReconnectSet(bool)), this, SLOT(autoReconnectSettingsChanged()));
88 connect(network, SIGNAL(autoReconnectIntervalSet(quint32)), this, SLOT(autoReconnectSettingsChanged()));
89 connect(network, SIGNAL(autoReconnectRetriesSet(quint16)), this, SLOT(autoReconnectSettingsChanged()));
92 connect(&socket, SIGNAL(encrypted()), this, SLOT(socketEncrypted()));
93 connect(&socket, SIGNAL(sslErrors(const QList<QSslError> &)), this, SLOT(sslErrors(const QList<QSslError> &)));
95 connect(&socket, SIGNAL(connected()), this, SLOT(socketConnected()));
97 connect(&socket, SIGNAL(disconnected()), this, SLOT(socketDisconnected()));
98 connect(&socket, SIGNAL(error(QAbstractSocket::SocketError)), this, SLOT(socketError(QAbstractSocket::SocketError)));
99 connect(&socket, SIGNAL(stateChanged(QAbstractSocket::SocketState)), this, SLOT(socketStateChanged(QAbstractSocket::SocketState)));
100 connect(&socket, SIGNAL(readyRead()), this, SLOT(socketHasData()));
102 connect(_ircServerHandler, SIGNAL(nickChanged(const QString &, const QString &)),
103 this, SLOT(nickChanged(const QString &, const QString &)));
105 network->proxy()->attachSignal(this, SIGNAL(sslErrors(const QVariant &)));
108 NetworkConnection::~NetworkConnection() {
109 if(connectionState() != Network::Disconnected && connectionState() != Network::Reconnecting)
110 disconnectFromIrc(false); // clean up, but this does not count as requested disconnect!
111 disconnect(&socket, 0, this, 0); // this keeps the socket from triggering events during clean up
112 delete _ircServerHandler;
113 delete _userInputHandler;
117 void NetworkConnection::setConnectionState(Network::ConnectionState state) {
118 _connectionState = state;
119 network()->setConnectionState(state);
120 emit connectionStateChanged(state);
123 QString NetworkConnection::serverDecode(const QByteArray &string) const {
124 return network()->decodeServerString(string);
127 QString NetworkConnection::channelDecode(const QString &bufferName, const QByteArray &string) const {
128 if(!bufferName.isEmpty()) {
129 IrcChannel *channel = network()->ircChannel(bufferName);
130 if(channel) return channel->decodeString(string);
132 return network()->decodeString(string);
135 QString NetworkConnection::userDecode(const QString &userNick, const QByteArray &string) const {
136 IrcUser *user = network()->ircUser(userNick);
137 if(user) return user->decodeString(string);
138 return network()->decodeString(string);
141 QByteArray NetworkConnection::serverEncode(const QString &string) const {
142 return network()->encodeServerString(string);
145 QByteArray NetworkConnection::channelEncode(const QString &bufferName, const QString &string) const {
146 if(!bufferName.isEmpty()) {
147 IrcChannel *channel = network()->ircChannel(bufferName);
148 if(channel) return channel->encodeString(string);
150 return network()->encodeString(string);
153 QByteArray NetworkConnection::userEncode(const QString &userNick, const QString &string) const {
154 IrcUser *user = network()->ircUser(userNick);
155 if(user) return user->encodeString(string);
156 return network()->encodeString(string);
159 void NetworkConnection::autoReconnectSettingsChanged() {
160 if(!network()->useAutoReconnect()) {
161 _autoReconnectTimer.stop();
162 _autoReconnectCount = 0;
164 _autoReconnectTimer.setInterval(network()->autoReconnectInterval() * 1000);
165 if(_autoReconnectCount != 0) {
166 if(network()->unlimitedReconnectRetries()) _autoReconnectCount = -1;
167 else _autoReconnectCount = network()->autoReconnectRetries();
172 void NetworkConnection::connectToIrc(bool reconnecting) {
173 if(!reconnecting && network()->useAutoReconnect() && _autoReconnectCount == 0) {
174 _autoReconnectTimer.setInterval(network()->autoReconnectInterval() * 1000);
175 if(network()->unlimitedReconnectRetries()) _autoReconnectCount = -1;
176 else _autoReconnectCount = network()->autoReconnectRetries();
178 QVariantList serverList = network()->serverList();
179 Identity *identity = coreSession()->identity(network()->identity());
180 if(!serverList.count()) {
181 qWarning() << "Server list empty, ignoring connect request!";
185 qWarning() << "Invalid identity configures, ignoring connect request!";
188 // use a random server?
189 if(network()->useRandomServer()) {
190 _lastUsedServerlistIndex = qrand() % serverList.size();
191 } else if(_previousConnectionAttemptFailed) {
192 // cycle to next server if previous connection attempt failed
193 displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Connection failed. Cycling to next Server"));
194 if(++_lastUsedServerlistIndex == serverList.size()) {
195 _lastUsedServerlistIndex = 0;
198 _previousConnectionAttemptFailed = false;
200 QString host = serverList[_lastUsedServerlistIndex].toMap()["Host"].toString();
201 quint16 port = serverList[_lastUsedServerlistIndex].toMap()["Port"].toUInt();
202 displayStatusMsg(tr("Connecting to %1:%2...").arg(host).arg(port));
203 displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Connecting to %1:%2...").arg(host).arg(port));
204 socket.connectToHost(host, port);
207 void NetworkConnection::networkInitialized(const QString ¤tServer) {
208 if(currentServer.isEmpty()) return;
210 if(network()->useAutoReconnect() && !network()->unlimitedReconnectRetries()) {
211 _autoReconnectCount = network()->autoReconnectRetries(); // reset counter
216 // now we are initialized
217 setConnectionState(Network::Initialized);
218 network()->setConnected(true);
219 emit connected(networkId());
223 if(_autoWhoEnabled) {
224 _autoWhoCycleTimer.start();
225 _autoWhoTimer.start();
226 startAutoWhoCycle(); // FIXME wait for autojoin to be completed
230 void NetworkConnection::sendPerform() {
231 BufferInfo statusBuf = Core::bufferInfo(coreSession()->user(), network()->networkId(), BufferInfo::StatusBuffer);
233 if(network()->useAutoIdentify() && !network()->autoIdentifyService().isEmpty() && !network()->autoIdentifyPassword().isEmpty()) {
234 userInputHandler()->handleMsg(statusBuf, QString("%1 IDENTIFY %2").arg(network()->autoIdentifyService(), network()->autoIdentifyPassword()));
237 foreach(QString line, network()->perform()) {
238 if(!line.isEmpty()) userInput(statusBuf, line);
241 // rejoin channels we've been in
242 QStringList channels, keys;
243 foreach(QString chan, persistentChannels()) {
244 QString key = channelKey(chan);
246 channels.prepend(chan); keys.prepend(key);
248 channels.append(chan);
251 QString joinString = QString("%1 %2").arg(channels.join(",")).arg(keys.join(",")).trimmed();
252 if(!joinString.isEmpty()) userInputHandler()->handleJoin(statusBuf, joinString);
255 void NetworkConnection::disconnectFromIrc(bool requested) {
256 _autoReconnectTimer.stop();
257 _autoReconnectCount = 0;
258 displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Disconnecting."));
259 if(socket.state() < QAbstractSocket::ConnectedState) {
260 setConnectionState(Network::Disconnected);
261 socketDisconnected();
263 _socketCloseTimer.start(10000); // the irc server has 10 seconds to close the socket
266 // this flag triggers quitRequested() once the socket is closed
267 // it is needed to determine whether or not the connection needs to be
268 // in the automatic session restore.
269 _quitRequested = requested;
272 void NetworkConnection::socketHasData() {
273 while(socket.canReadLine()) {
274 QByteArray s = socket.readLine().trimmed();
275 ircServerHandler()->handleServerMsg(s);
279 void NetworkConnection::socketError(QAbstractSocket::SocketError) {
280 _previousConnectionAttemptFailed = true;
281 qDebug() << qPrintable(tr("Could not connect to %1 (%2)").arg(network()->networkName(), socket.errorString()));
282 emit connectionError(socket.errorString());
283 emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Connection failure: %1").arg(socket.errorString()));
284 network()->emitConnectionError(socket.errorString());
285 if(socket.state() < QAbstractSocket::ConnectedState) {
286 setConnectionState(Network::Disconnected);
287 socketDisconnected();
289 // mark last connection attempt as failed
291 //qDebug() << "exiting...";
295 #ifndef QT_NO_OPENSSL
297 void NetworkConnection::sslErrors(const QList<QSslError> &sslErrors) {
299 socket.ignoreSslErrors();
300 /* TODO errorhandling
302 QVariantList errnums;
303 foreach(QSslError err, errors) errnums << err.error();
304 errmsg["SslErrors"] = errnums;
305 errmsg["SslCert"] = socket.peerCertificate().toPem();
306 errmsg["PeerAddress"] = socket.peerAddress().toString();
307 errmsg["PeerPort"] = socket.peerPort();
308 errmsg["PeerName"] = socket.peerName();
309 emit sslErrors(errmsg);
314 void NetworkConnection::socketEncrypted() {
315 //qDebug() << "encrypted!";
319 #endif // QT_NO_OPENSSL
321 void NetworkConnection::socketConnected() {
326 if(!network()->serverList()[_lastUsedServerlistIndex].toMap()["UseSSL"].toBool()) {
330 //qDebug() << "starting handshake";
331 socket.startClientEncryption();
335 void NetworkConnection::socketInitialized() {
336 //emit connected(networkId()); initialize first!
337 Identity *identity = coreSession()->identity(network()->identity());
339 qWarning() << "Identity invalid!";
343 QString passwd = network()->serverList()[_lastUsedServerlistIndex].toMap()["Password"].toString();
344 if(!passwd.isEmpty()) {
345 putRawLine(serverEncode(QString("PASS %1").arg(passwd)));
347 putRawLine(serverEncode(QString("NICK :%1").arg(identity->nicks()[0]))); // FIXME: try more nicks if error occurs
348 putRawLine(serverEncode(QString("USER %1 8 * :%2").arg(identity->ident(), identity->realName())));
351 void NetworkConnection::socketStateChanged(QAbstractSocket::SocketState socketState) {
352 Network::ConnectionState state;
353 switch(socketState) {
354 case QAbstractSocket::UnconnectedState:
355 state = Network::Disconnected;
357 case QAbstractSocket::HostLookupState:
358 case QAbstractSocket::ConnectingState:
359 state = Network::Connecting;
361 case QAbstractSocket::ConnectedState:
362 state = Network::Initializing;
364 case QAbstractSocket::ClosingState:
365 state = Network::Disconnecting;
368 state = Network::Disconnected;
370 setConnectionState(state);
373 void NetworkConnection::socketCloseTimeout() {
374 socket.disconnectFromHost();
377 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(" ");