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
  49     _previousConnectionAttemptFailed(false),
  50     _lastUsedServerlistIndex(0),
  51
  52     // TODO make autowho configurable (possibly per-network)
  53     _autoWhoEnabled(true),
  54     _autoWhoInterval(90),
  55     _autoWhoNickLimit(0), // unlimited
  56     _autoWhoDelay(3),
  57
  58     // TokenBucket to avaid sending too much at once
  59     _messagesPerSecond(1),
  60     _burstSize(5),
  61     _tokenBucket(5) // init with a full bucket
  62 {
  63   _autoReconnectTimer.setSingleShot(true);
  64
  65   _autoWhoTimer.setInterval(_autoWhoDelay * 1000);
  66   _autoWhoTimer.setSingleShot(false);
  67   _autoWhoCycleTimer.setInterval(_autoWhoInterval * 1000);
  68   _autoWhoCycleTimer.setSingleShot(false);
  69
  70   _tokenBucketTimer.start(_messagesPerSecond * 1000);
  71   _tokenBucketTimer.setSingleShot(false);
  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     socket.disconnectFromHost();
 259   }
 260
 261   if(requested) {
 262     emit quitRequested(networkId());
 263   }
 264 }
 265
 266 void NetworkConnection::socketHasData() {
 267   while(socket.canReadLine()) {
 268     QByteArray s = socket.readLine().trimmed();
 269     ircServerHandler()->handleServerMsg(s);
 270   }
 271 }
 272
 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     setConnectionState(Network::Disconnected);
 281     socketDisconnected();
 282   }
 283   // mark last connection attempt as failed
 284
 285   //qDebug() << "exiting...";
 286   //exit(1);
 287 }
 288
 289 #ifndef QT_NO_OPENSSL
 290
 291 void NetworkConnection::sslErrors(const QList<QSslError> &sslErrors) {
 292   Q_UNUSED(sslErrors)
 293   socket.ignoreSslErrors();
 294   /* TODO errorhandling
 295   QVariantMap errmsg;
 296   QVariantList errnums;
 297   foreach(QSslError err, errors) errnums << err.error();
 298   errmsg["SslErrors"] = errnums;
 299   errmsg["SslCert"] = socket.peerCertificate().toPem();
 300   errmsg["PeerAddress"] = socket.peerAddress().toString();
 301   errmsg["PeerPort"] = socket.peerPort();
 302   errmsg["PeerName"] = socket.peerName();
 303   emit sslErrors(errmsg);
 304   disconnectFromIrc();
 305   */
 306 }
 307
 308 void NetworkConnection::socketEncrypted() {
 309   //qDebug() << "encrypted!";
 310   socketInitialized();
 311 }
 312
 313 #endif  // QT_NO_OPENSSL
 314
 315 void NetworkConnection::socketConnected() {
 316 #ifdef QT_NO_OPENSSL
 317   socketInitialized();
 318   return;
 319 #else
 320   if(!network()->serverList()[_lastUsedServerlistIndex].toMap()["UseSSL"].toBool()) {
 321     socketInitialized();
 322     return;
 323   }
 324   //qDebug() << "starting handshake";
 325   socket.startClientEncryption();
 326 #endif
 327 }
 328
 329 void NetworkConnection::socketInitialized() {
 330   //emit connected(networkId());  initialize first!
 331   Identity *identity = coreSession()->identity(network()->identity());
 332   if(!identity) {
 333     qWarning() << "Identity invalid!";
 334     disconnectFromIrc();
 335     return;
 336   }
 337   QString passwd = network()->serverList()[_lastUsedServerlistIndex].toMap()["Password"].toString();
 338   if(!passwd.isEmpty()) {
 339     putRawLine(serverEncode(QString("PASS %1").arg(passwd)));
 340   }
 341   putRawLine(serverEncode(QString("NICK :%1").arg(identity->nicks()[0])));  // FIXME: try more nicks if error occurs
 342   putRawLine(serverEncode(QString("USER %1 8 * :%2").arg(identity->ident(), identity->realName())));
 343 }
 344
 345 void NetworkConnection::socketStateChanged(QAbstractSocket::SocketState socketState) {
 346   Network::ConnectionState state;
 347   switch(socketState) {
 348     case QAbstractSocket::UnconnectedState:
 349       state = Network::Disconnected;
 350       break;
 351     case QAbstractSocket::HostLookupState:
 352     case QAbstractSocket::ConnectingState:
 353       state = Network::Connecting;
 354       break;
 355     case QAbstractSocket::ConnectedState:
 356       state = Network::Initializing;
 357       break;
 358     case QAbstractSocket::ClosingState:
 359       state = Network::Disconnecting;
 360       break;
 361     default:
 362       state = Network::Disconnected;
 363   }
 364   setConnectionState(state);
 365 }
 366
 367 void NetworkConnection::socketDisconnected() {
 368   _autoWhoCycleTimer.stop();
 369   _autoWhoTimer.stop();
 370   _autoWhoQueue.clear();
 371   _autoWhoInProgress.clear();
 372
 373   network()->setConnected(false);
 374   emit disconnected(networkId());
 375   if(_autoReconnectCount != 0) {
 376     setConnectionState(Network::Reconnecting);
 377     if(_autoReconnectCount == network()->autoReconnectRetries()) doAutoReconnect(); // first try is immediate
 378     else _autoReconnectTimer.start();
 379   }
 380 }
 381
 382 void NetworkConnection::doAutoReconnect() {
 383   if(connectionState() != Network::Disconnected && connectionState() != Network::Reconnecting) {
 384     qWarning() << "NetworkConnection::doAutoReconnect(): Cannot reconnect while not being disconnected!";
 385     return;
 386   }
 387   if(_autoReconnectCount > 0) _autoReconnectCount--;
 388   connectToIrc(true);
 389 }
 390
 391 // FIXME switch to BufferId
 392 void NetworkConnection::userInput(BufferInfo buf, QString msg) {
 393   userInputHandler()->handleUserInput(buf, msg);
 394 }
 395
 396 void NetworkConnection::putRawLine(QByteArray s) {
 397   if(_tokenBucket > 0) {
 398     writeToSocket(s);
 399   } else {
 400     _msgQueue.append(s);
 401   }
 402 }
 403
 404 void NetworkConnection::writeToSocket(QByteArray s) {
 405   s += "\r\n";
 406   socket.write(s);
 407   _tokenBucket--;
 408 }
 409
 410 void NetworkConnection::fillBucketAndProcessQueue() {
 411   if(_tokenBucket < _burstSize) {
 412     _tokenBucket++;
 413   }
 414
 415   while(_msgQueue.size() > 0 && _tokenBucket > 0) {
 416     writeToSocket(_msgQueue.takeFirst());
 417   }
 418 }
 419
 420 void NetworkConnection::putCmd(const QString &cmd, const QVariantList &params, const QByteArray &prefix) {
 421   QByteArray msg;
 422   if(!prefix.isEmpty())
 423     msg += ":" + prefix + " ";
 424   msg += cmd.toUpper().toAscii();
 425
 426   for(int i = 0; i < params.size() - 1; i++) {
 427     msg += " " + params[i].toByteArray();
 428   }
 429   if(!params.isEmpty())
 430     msg += " :" + params.last().toByteArray();
 431
 432   putRawLine(msg);
 433 }
 434
 435 void NetworkConnection::sendAutoWho() {
 436   while(!_autoWhoQueue.isEmpty()) {
 437     QString chan = _autoWhoQueue.takeFirst();
 438     IrcChannel *ircchan = network()->ircChannel(chan);
 439     if(!ircchan) continue;
 440     if(_autoWhoNickLimit > 0 && ircchan->ircUsers().count() > _autoWhoNickLimit) continue;
 441     _autoWhoInProgress[chan]++;
 442     putRawLine("WHO " + serverEncode(chan));
 443     if(_autoWhoQueue.isEmpty() && _autoWhoEnabled && !_autoWhoCycleTimer.isActive()) {
 444       // Timer was stopped, means a new cycle is due immediately
 445       _autoWhoCycleTimer.start();
 446       startAutoWhoCycle();
 447     }
 448     break;
 449   }
 450 }
 451
 452 void NetworkConnection::startAutoWhoCycle() {
 453   if(!_autoWhoQueue.isEmpty()) {
 454     _autoWhoCycleTimer.stop();
 455     return;
 456   }
 457   _autoWhoQueue = network()->channels();
 458 }
 459
 460 bool NetworkConnection::setAutoWhoDone(const QString &channel) {
 461   if(_autoWhoInProgress.value(channel.toLower(), 0) <= 0) return false;
 462   _autoWhoInProgress[channel.toLower()]--;
 463   return true;
 464 }
 465
 466 void NetworkConnection::setChannelJoined(const QString &channel) {
 467   emit channelJoined(networkId(), channel, _channelKeys[channel.toLower()]);
 468   _autoWhoQueue.prepend(channel.toLower()); // prepend so this new chan is the first to be checked
 469 }
 470
 471 void NetworkConnection::setChannelParted(const QString &channel) {
 472   removeChannelKey(channel);
 473   _autoWhoQueue.removeAll(channel.toLower());
 474   _autoWhoInProgress.remove(channel.toLower());
 475   emit channelParted(networkId(), channel);
 476 }
 477
 478 void NetworkConnection::addChannelKey(const QString &channel, const QString &key) {
 479   if(key.isEmpty()) {
 480     removeChannelKey(channel);
 481   } else {
 482     _channelKeys[channel.toLower()] = key;
 483   }
 484 }
 485
 486 void NetworkConnection::removeChannelKey(const QString &channel) {
 487   _channelKeys.remove(channel.toLower());
 488 }
 489
 490 void NetworkConnection::nickChanged(const QString &newNick, const QString &oldNick) {
 491   emit nickChanged(networkId(), newNick, oldNick);
 492 }
 493
 494 /* Exception classes for message handling */
 495 NetworkConnection::ParseError::ParseError(QString cmd, QString prefix, QStringList params) {
 496   Q_UNUSED(prefix);
 497   _msg = QString("Command Parse Error: ") + cmd + params.join(" ");
 498 }
 499
 500 NetworkConnection::UnknownCmdError::UnknownCmdError(QString cmd, QString prefix, QStringList params) {
 501   Q_UNUSED(prefix);
 502   _msg = QString("Unknown Command: ") + cmd + params.join(" ");
 503 }
 504