Merge branch 'seezer'
[quassel.git] / src / core / networkconnection.cpp
1 /***************************************************************************
2  *   Copyright (C) 2005-08 by the Quassel Project                          *
3  *   devel@quassel-irc.org                                                 *
4  *                                                                         *
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.                                           *
9  *                                                                         *
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.                          *
14  *                                                                         *
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"
21
22 #include <QMetaObject>
23 #include <QMetaMethod>
24 #include <QDateTime>
25
26 #include "util.h"
27 #include "core.h"
28 #include "coresession.h"
29
30 #include "ircchannel.h"
31 #include "ircuser.h"
32 #include "network.h"
33 #include "identity.h"
34
35 #include "ircserverhandler.h"
36 #include "userinputhandler.h"
37 #include "ctcphandler.h"
38
39 NetworkConnection::NetworkConnection(Network *network, CoreSession *session)
40   : QObject(network),
41     _connectionState(Network::Disconnected),
42     _network(network),
43     _coreSession(session),
44     _ircServerHandler(new IrcServerHandler(this)),
45     _userInputHandler(new UserInputHandler(this)),
46     _ctcpHandler(new CtcpHandler(this)),
47     _autoReconnectCount(0),
48     _quitRequested(false),
49
50     _previousConnectionAttemptFailed(false),
51     _lastUsedServerlistIndex(0),
52
53     // TODO make autowho configurable (possibly per-network)
54     _autoWhoEnabled(true),
55     _autoWhoInterval(90),
56     _autoWhoNickLimit(0), // unlimited
57     _autoWhoDelay(3),
58
59     // TokenBucket to avaid sending too much at once
60     _messagesPerSecond(1),
61     _burstSize(5),
62     _tokenBucket(5) // init with a full bucket
63 {
64   _autoReconnectTimer.setSingleShot(true);
65   _socketCloseTimer.setSingleShot(true);
66   connect(&_socketCloseTimer, SIGNAL(timeout()), this, SLOT(socketCloseTimeout()));
67   
68   _autoWhoTimer.setInterval(_autoWhoDelay * 1000);
69   _autoWhoCycleTimer.setInterval(_autoWhoInterval * 1000);
70   
71   _tokenBucketTimer.start(_messagesPerSecond * 1000);
72
73   QHash<QString, QString> channels = coreSession()->persistentChannels(networkId());
74   foreach(QString chan, channels.keys()) {
75     _channelKeys[chan.toLower()] = channels[chan];
76   }
77
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()));
82
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()));
87
88 #ifndef QT_NO_OPENSSL
89   connect(&socket, SIGNAL(encrypted()), this, SLOT(socketEncrypted()));
90   connect(&socket, SIGNAL(sslErrors(const QList<QSslError> &)), this, SLOT(sslErrors(const QList<QSslError> &)));
91 #endif
92   connect(&socket, SIGNAL(connected()), this, SLOT(socketConnected()));
93
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()));
98
99   connect(_ircServerHandler, SIGNAL(nickChanged(const QString &, const QString &)),
100           this, SLOT(nickChanged(const QString &, const QString &)));
101
102   network->proxy()->attachSignal(this, SIGNAL(sslErrors(const QVariant &)));
103 }
104
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;
111   delete _ctcpHandler;
112 }
113
114 void NetworkConnection::setConnectionState(Network::ConnectionState state) {
115   _connectionState = state;
116   network()->setConnectionState(state);
117   emit connectionStateChanged(state);
118 }
119
120 QString NetworkConnection::serverDecode(const QByteArray &string) const {
121   return network()->decodeServerString(string);
122 }
123
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);
128   }
129   return network()->decodeString(string);
130 }
131
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);
136 }
137
138 QByteArray NetworkConnection::serverEncode(const QString &string) const {
139   return network()->encodeServerString(string);
140 }
141
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);
146   }
147   return network()->encodeString(string);
148 }
149
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);
154 }
155
156 void NetworkConnection::autoReconnectSettingsChanged() {
157   if(!network()->useAutoReconnect()) {
158     _autoReconnectTimer.stop();
159     _autoReconnectCount = 0;
160   } else {
161     _autoReconnectTimer.setInterval(network()->autoReconnectInterval() * 1000);
162     if(_autoReconnectCount != 0) {
163       if(network()->unlimitedReconnectRetries()) _autoReconnectCount = -1;
164       else _autoReconnectCount = network()->autoReconnectRetries();
165     }
166   }
167 }
168
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();
174   }
175   QVariantList serverList = network()->serverList();
176   Identity *identity = coreSession()->identity(network()->identity());
177   if(!serverList.count()) {
178     qWarning() << "Server list empty, ignoring connect request!";
179     return;
180   }
181   if(!identity) {
182     qWarning() << "Invalid identity configures, ignoring connect request!";
183     return;
184   }
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;
193     }
194   }
195   _previousConnectionAttemptFailed = false;
196
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);
202 }
203
204 void NetworkConnection::networkInitialized(const QString &currentServer) {
205   if(currentServer.isEmpty()) return;
206
207   if(network()->useAutoReconnect() && !network()->unlimitedReconnectRetries()) {
208     _autoReconnectCount = network()->autoReconnectRetries(); // reset counter
209   }
210
211   sendPerform();
212
213   // now we are initialized
214   setConnectionState(Network::Initialized);
215   network()->setConnected(true);
216   emit connected(networkId());
217
218   if(_autoWhoEnabled) {
219     _autoWhoCycleTimer.start();
220     _autoWhoTimer.start();
221     startAutoWhoCycle();  // FIXME wait for autojoin to be completed
222   }
223 }
224
225 void NetworkConnection::sendPerform() {
226   BufferInfo statusBuf = Core::bufferInfo(coreSession()->user(), network()->networkId(), BufferInfo::StatusBuffer);
227   // do auto identify
228   if(network()->useAutoIdentify() && !network()->autoIdentifyService().isEmpty() && !network()->autoIdentifyPassword().isEmpty()) {
229     userInputHandler()->handleMsg(statusBuf, QString("%1 IDENTIFY %2").arg(network()->autoIdentifyService(), network()->autoIdentifyPassword()));
230   }
231   // send perform list
232   foreach(QString line, network()->perform()) {
233     if(!line.isEmpty()) userInput(statusBuf, line);
234   }
235
236   // rejoin channels we've been in
237   QStringList channels, keys;
238   foreach(QString chan, persistentChannels()) {
239     QString key = channelKey(chan);
240     if(!key.isEmpty()) {
241       channels.prepend(chan); keys.prepend(key);
242     } else {
243       channels.append(chan);
244     }
245   }
246   QString joinString = QString("%1 %2").arg(channels.join(",")).arg(keys.join(",")).trimmed();
247   if(!joinString.isEmpty()) userInputHandler()->handleJoin(statusBuf, joinString);
248 }
249
250 void NetworkConnection::disconnectFromIrc(bool requested) {
251   _autoReconnectTimer.stop();
252   _autoReconnectCount = 0;
253   displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Disconnecting."));
254   if(socket.state() < QAbstractSocket::ConnectedState) {
255     setConnectionState(Network::Disconnected);
256     socketDisconnected();
257   } else {
258     _socketCloseTimer.start(10000); // the irc server has 10 seconds to close the socket
259   }
260
261   // this flag triggers quitRequested() once the socket is closed
262   // it is needed to determine whether or not the connection needs to be
263   // in the automatic session restore.
264   _quitRequested = requested;
265 }
266
267 void NetworkConnection::socketHasData() {
268   while(socket.canReadLine()) {
269     QByteArray s = socket.readLine().trimmed();
270     ircServerHandler()->handleServerMsg(s);
271   }
272 }
273
274 void NetworkConnection::socketError(QAbstractSocket::SocketError) {
275   _previousConnectionAttemptFailed = true;
276   qDebug() << qPrintable(tr("Could not connect to %1 (%2)").arg(network()->networkName(), socket.errorString()));
277   emit connectionError(socket.errorString());
278   emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Connection failure: %1").arg(socket.errorString()));
279   network()->emitConnectionError(socket.errorString());
280   if(socket.state() < QAbstractSocket::ConnectedState) {
281     setConnectionState(Network::Disconnected);
282     socketDisconnected();
283   }
284   // mark last connection attempt as failed
285   
286   //qDebug() << "exiting...";
287   //exit(1);
288 }
289
290 #ifndef QT_NO_OPENSSL
291
292 void NetworkConnection::sslErrors(const QList<QSslError> &sslErrors) {
293   Q_UNUSED(sslErrors)
294   socket.ignoreSslErrors();
295   /* TODO errorhandling
296   QVariantMap errmsg;
297   QVariantList errnums;
298   foreach(QSslError err, errors) errnums << err.error();
299   errmsg["SslErrors"] = errnums;
300   errmsg["SslCert"] = socket.peerCertificate().toPem();
301   errmsg["PeerAddress"] = socket.peerAddress().toString();
302   errmsg["PeerPort"] = socket.peerPort();
303   errmsg["PeerName"] = socket.peerName();
304   emit sslErrors(errmsg);
305   disconnectFromIrc();
306   */
307 }
308
309 void NetworkConnection::socketEncrypted() {
310   //qDebug() << "encrypted!";
311   socketInitialized();
312 }
313
314 #endif  // QT_NO_OPENSSL
315
316 void NetworkConnection::socketConnected() {
317 #ifdef QT_NO_OPENSSL
318   socketInitialized();
319   return;
320 #else
321   if(!network()->serverList()[_lastUsedServerlistIndex].toMap()["UseSSL"].toBool()) {
322     socketInitialized();
323     return;
324   }
325   //qDebug() << "starting handshake";
326   socket.startClientEncryption();
327 #endif
328 }
329
330 void NetworkConnection::socketInitialized() {
331   //emit connected(networkId());  initialize first!
332   Identity *identity = coreSession()->identity(network()->identity());
333   if(!identity) {
334     qWarning() << "Identity invalid!";
335     disconnectFromIrc();
336     return;
337   }
338   QString passwd = network()->serverList()[_lastUsedServerlistIndex].toMap()["Password"].toString();
339   if(!passwd.isEmpty()) {
340     putRawLine(serverEncode(QString("PASS %1").arg(passwd)));
341   }
342   putRawLine(serverEncode(QString("NICK :%1").arg(identity->nicks()[0])));  // FIXME: try more nicks if error occurs
343   putRawLine(serverEncode(QString("USER %1 8 * :%2").arg(identity->ident(), identity->realName())));
344 }
345
346 void NetworkConnection::socketStateChanged(QAbstractSocket::SocketState socketState) {
347   Network::ConnectionState state;
348   switch(socketState) {
349     case QAbstractSocket::UnconnectedState:
350       state = Network::Disconnected;
351       break;
352     case QAbstractSocket::HostLookupState:
353     case QAbstractSocket::ConnectingState:
354       state = Network::Connecting;
355       break;
356     case QAbstractSocket::ConnectedState:
357       state = Network::Initializing;
358       break;
359     case QAbstractSocket::ClosingState:
360       state = Network::Disconnecting;
361       break;
362     default:
363       state = Network::Disconnected;
364   }
365   setConnectionState(state);
366 }
367
368 void NetworkConnection::socketCloseTimeout() {
369   socket.disconnectFromHost();
370 }
371
372 void NetworkConnection::socketDisconnected() {
373   _autoWhoCycleTimer.stop();
374   _autoWhoTimer.stop();
375   _autoWhoQueue.clear();
376   _autoWhoInProgress.clear();
377
378   _socketCloseTimer.stop();
379   
380   network()->setConnected(false);
381   emit disconnected(networkId());
382   if(_autoReconnectCount != 0) {
383     setConnectionState(Network::Reconnecting);
384     if(_autoReconnectCount == network()->autoReconnectRetries()) doAutoReconnect(); // first try is immediate
385     else _autoReconnectTimer.start();
386   } else if(_quitRequested) {
387     emit quitRequested(networkId());
388   }
389 }
390
391 void NetworkConnection::doAutoReconnect() {
392   if(connectionState() != Network::Disconnected && connectionState() != Network::Reconnecting) {
393     qWarning() << "NetworkConnection::doAutoReconnect(): Cannot reconnect while not being disconnected!";
394     return;
395   }
396   if(_autoReconnectCount > 0) _autoReconnectCount--;
397   connectToIrc(true);
398 }
399
400 // FIXME switch to BufferId
401 void NetworkConnection::userInput(BufferInfo buf, QString msg) {
402   userInputHandler()->handleUserInput(buf, msg);
403 }
404
405 void NetworkConnection::putRawLine(QByteArray s) {
406   if(_tokenBucket > 0) {
407     // qDebug() << "putRawLine: " << s;
408     writeToSocket(s);
409   } else {
410     _msgQueue.append(s);
411   }
412 }
413
414 void NetworkConnection::writeToSocket(QByteArray s) {
415   s += "\r\n";
416   // qDebug() << "writeToSocket: " << s.size();
417   socket.write(s);
418   _tokenBucket--;
419 }
420
421 void NetworkConnection::fillBucketAndProcessQueue() {
422   if(_tokenBucket < _burstSize) {
423     _tokenBucket++;
424   }
425
426   while(_msgQueue.size() > 0 && _tokenBucket > 0) {
427     writeToSocket(_msgQueue.takeFirst());
428   }
429 }
430
431 // returns 0 if the message will not be chopped by the irc server or number of chopped bytes if message is too long
432 int NetworkConnection::lastParamOverrun(const QString &cmd, const QList<QByteArray> &params) {
433   //the server will pass our message that trunkated to 512 bytes including CRLF with the following format:
434   // ":prefix COMMAND param0 param1 :lastparam"
435   // where prefix = "nickname!user@host"
436   // that means that the last message can be as long as:
437   // 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)
438   IrcUser *me = network()->me();
439   int maxLen = 480 - cmd.toAscii().count(); // educated guess in case we don't know us (yet?)
440
441   if(me)
442     maxLen = 512 - serverEncode(me->nick()).count() - serverEncode(me->user()).count() - serverEncode(me->host()).count() - cmd.toAscii().count() - 6;
443
444   if(!params.isEmpty()) {
445     for(int i = 0; i < params.count() - 1; i++) {
446       maxLen -= (params[i].count() + 1);
447     }
448     maxLen -= 2; // " :" last param separator;
449     
450     if(params.last().count() > maxLen) {
451       return params.last().count() - maxLen;
452     } else {
453       return 0;
454     }
455   } else {
456     return 0;
457   }
458 }
459
460 void NetworkConnection::putCmd(const QString &cmd, const QList<QByteArray> &params, const QByteArray &prefix) {
461   QByteArray msg;
462   if(cmd == "PRIVMSG" && params.count() > 1) {
463     int overrun = lastParamOverrun(cmd, params);
464     if(overrun) {
465       QList<QByteArray> paramCopy1;
466       QList<QByteArray> paramCopy2;
467       for(int i = 0; i < params.count() - 1; i++) {
468         paramCopy1 << params[i];
469         paramCopy2 << params[i];
470       }
471
472       QByteArray lastPart = params.last();
473       QByteArray splitter(" .,-");
474       int maxSplitPos = params.last().count() - overrun;
475       int splitPos = -1;
476       for(int i = 0; i < splitter.size(); i++) {
477         splitPos = qMax(splitPos, lastPart.lastIndexOf(splitter[i], maxSplitPos));
478       }
479
480       if(splitPos == -1) {
481         splitPos = maxSplitPos;
482       }
483       
484       paramCopy1 << lastPart.left(splitPos);
485       paramCopy2 << lastPart.mid(splitPos);
486       putCmd(cmd, paramCopy1, prefix);
487       putCmd(cmd, paramCopy2, prefix);
488       return;
489     }
490   }
491      
492   if(!prefix.isEmpty())
493     msg += ":" + prefix + " ";
494   msg += cmd.toUpper().toAscii();
495
496   for(int i = 0; i < params.size() - 1; i++) {
497     msg += " " + params[i];
498   }
499   if(!params.isEmpty())
500     msg += " :" + params.last();
501
502   putRawLine(msg);
503 }
504
505 void NetworkConnection::sendAutoWho() {
506   while(!_autoWhoQueue.isEmpty()) {
507     QString chan = _autoWhoQueue.takeFirst();
508     IrcChannel *ircchan = network()->ircChannel(chan);
509     if(!ircchan) continue;
510     if(_autoWhoNickLimit > 0 && ircchan->ircUsers().count() > _autoWhoNickLimit) continue;
511     _autoWhoInProgress[chan]++;
512     putRawLine("WHO " + serverEncode(chan));
513     if(_autoWhoQueue.isEmpty() && _autoWhoEnabled && !_autoWhoCycleTimer.isActive()) {
514       // Timer was stopped, means a new cycle is due immediately
515       _autoWhoCycleTimer.start();
516       startAutoWhoCycle();
517     }
518     break;
519   }
520 }
521
522 void NetworkConnection::startAutoWhoCycle() {
523   if(!_autoWhoQueue.isEmpty()) {
524     _autoWhoCycleTimer.stop();
525     return;
526   }
527   _autoWhoQueue = network()->channels();
528 }
529
530 bool NetworkConnection::setAutoWhoDone(const QString &channel) {
531   if(_autoWhoInProgress.value(channel.toLower(), 0) <= 0) return false;
532   _autoWhoInProgress[channel.toLower()]--;
533   return true;
534 }
535
536 void NetworkConnection::setChannelJoined(const QString &channel) {
537   emit channelJoined(networkId(), channel, _channelKeys[channel.toLower()]);
538   _autoWhoQueue.prepend(channel.toLower()); // prepend so this new chan is the first to be checked
539 }
540
541 void NetworkConnection::setChannelParted(const QString &channel) {
542   removeChannelKey(channel);
543   _autoWhoQueue.removeAll(channel.toLower());
544   _autoWhoInProgress.remove(channel.toLower());
545   emit channelParted(networkId(), channel);
546 }
547
548 void NetworkConnection::addChannelKey(const QString &channel, const QString &key) {
549   if(key.isEmpty()) {
550     removeChannelKey(channel);
551   } else {
552     _channelKeys[channel.toLower()] = key;
553   }
554 }
555
556 void NetworkConnection::removeChannelKey(const QString &channel) {
557   _channelKeys.remove(channel.toLower());
558 }
559
560 void NetworkConnection::nickChanged(const QString &newNick, const QString &oldNick) {
561   emit nickChanged(networkId(), newNick, oldNick);
562 }
563
564 /* Exception classes for message handling */
565 NetworkConnection::ParseError::ParseError(QString cmd, QString prefix, QStringList params) {
566   Q_UNUSED(prefix);
567   _msg = QString("Command Parse Error: ") + cmd + params.join(" ");
568 }
569
570 NetworkConnection::UnknownCmdError::UnknownCmdError(QString cmd, QString prefix, QStringList params) {
571   Q_UNUSED(prefix);
572   _msg = QString("Unknown Command: ") + cmd + params.join(" ");
573 }
574