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) : QObject(network),
  40     _connectionState(Network::Disconnected),
  41     _network(network),
  42     _coreSession(session),
  43     _ircServerHandler(new IrcServerHandler(this)),
  44     _userInputHandler(new UserInputHandler(this)),
  45     _ctcpHandler(new CtcpHandler(this)),
  46     _autoReconnectCount(0)
  47 {
  48   _autoReconnectTimer.setSingleShot(true);
  49  _previousConnectionAttemptFailed = false;
  50  _lastUsedServerlistIndex = 0;
  51   // TODO make configurable
  52   _whoTimer.setInterval(90 * 1000);
  53   _whoTimer.setSingleShot(false);
  54
  55   QHash<QString, QString> channels = coreSession()->persistentChannels(networkId());
  56   foreach(QString chan, channels.keys()) {
  57     _channelKeys[chan.toLower()] = channels[chan];
  58   }
  59
  60   connect(&_autoReconnectTimer, SIGNAL(timeout()), this, SLOT(doAutoReconnect()));
  61   connect(&_whoTimer, SIGNAL(timeout()), this, SLOT(sendWho()));
  62
  63   connect(network, SIGNAL(currentServerSet(const QString &)), this, SLOT(networkInitialized(const QString &)));
  64   connect(network, SIGNAL(useAutoReconnectSet(bool)), this, SLOT(autoReconnectSettingsChanged()));
  65   connect(network, SIGNAL(autoReconnectIntervalSet(quint32)), this, SLOT(autoReconnectSettingsChanged()));
  66   connect(network, SIGNAL(autoReconnectRetriesSet(quint16)), this, SLOT(autoReconnectSettingsChanged()));
  67
  68 #ifndef QT_NO_OPENSSL
  69   connect(&socket, SIGNAL(encrypted()), this, SLOT(socketEncrypted()));
  70   connect(&socket, SIGNAL(sslErrors(const QList<QSslError> &)), this, SLOT(sslErrors(const QList<QSslError> &)));
  71 #endif
  72   connect(&socket, SIGNAL(connected()), this, SLOT(socketConnected()));
  73
  74   connect(&socket, SIGNAL(disconnected()), this, SLOT(socketDisconnected()));
  75   connect(&socket, SIGNAL(error(QAbstractSocket::SocketError)), this, SLOT(socketError(QAbstractSocket::SocketError)));
  76   connect(&socket, SIGNAL(stateChanged(QAbstractSocket::SocketState)), this, SLOT(socketStateChanged(QAbstractSocket::SocketState)));
  77   connect(&socket, SIGNAL(readyRead()), this, SLOT(socketHasData()));
  78
  79   connect(_ircServerHandler, SIGNAL(nickChanged(const QString &, const QString &)),
  80           this, SLOT(nickChanged(const QString &, const QString &)));
  81
  82   network->proxy()->attachSignal(this, SIGNAL(sslErrors(const QVariant &)));
  83 }
  84
  85 NetworkConnection::~NetworkConnection() {
  86   if(connectionState() != Network::Disconnected && connectionState() != Network::Reconnecting)
  87     disconnectFromIrc(false); // clean up, but this does not count as requested disconnect!
  88   delete _ircServerHandler;
  89   delete _userInputHandler;
  90   delete _ctcpHandler;
  91 }
  92
  93 bool NetworkConnection::isConnected() const {
  94   // return socket.state() == QAbstractSocket::ConnectedState;
  95   return connectionState() == Network::Initialized;
  96 }
  97
  98 Network::ConnectionState NetworkConnection::connectionState() const {
  99   return _connectionState;
 100 }
 101
 102 void NetworkConnection::setConnectionState(Network::ConnectionState state) {
 103   _connectionState = state;
 104   network()->setConnectionState(state);
 105   emit connectionStateChanged(state);
 106 }
 107
 108 NetworkId NetworkConnection::networkId() const {
 109   return network()->networkId();
 110 }
 111
 112 QString NetworkConnection::networkName() const {
 113   return network()->networkName();
 114 }
 115
 116 Identity *NetworkConnection::identity() const {
 117   return coreSession()->identity(network()->identity());
 118 }
 119
 120 Network *NetworkConnection::network() const {
 121   return _network;
 122 }
 123
 124 CoreSession *NetworkConnection::coreSession() const {
 125   return _coreSession;
 126 }
 127
 128 IrcServerHandler *NetworkConnection::ircServerHandler() const {
 129   return _ircServerHandler;
 130 }
 131
 132 UserInputHandler *NetworkConnection::userInputHandler() const {
 133   return _userInputHandler;
 134 }
 135
 136 CtcpHandler *NetworkConnection::ctcpHandler() const {
 137   return _ctcpHandler;
 138 }
 139
 140 QString NetworkConnection::serverDecode(const QByteArray &string) const {
 141   return network()->decodeServerString(string);
 142 }
 143
 144 QString NetworkConnection::channelDecode(const QString &bufferName, const QByteArray &string) const {
 145   if(!bufferName.isEmpty()) {
 146     IrcChannel *channel = network()->ircChannel(bufferName);
 147     if(channel) return channel->decodeString(string);
 148   }
 149   return network()->decodeString(string);
 150 }
 151
 152 QString NetworkConnection::userDecode(const QString &userNick, const QByteArray &string) const {
 153   IrcUser *user = network()->ircUser(userNick);
 154   if(user) return user->decodeString(string);
 155   return network()->decodeString(string);
 156 }
 157
 158 QByteArray NetworkConnection::serverEncode(const QString &string) const {
 159   return network()->encodeServerString(string);
 160 }
 161
 162 QByteArray NetworkConnection::channelEncode(const QString &bufferName, const QString &string) const {
 163   if(!bufferName.isEmpty()) {
 164     IrcChannel *channel = network()->ircChannel(bufferName);
 165     if(channel) return channel->encodeString(string);
 166   }
 167   return network()->encodeString(string);
 168 }
 169
 170 QByteArray NetworkConnection::userEncode(const QString &userNick, const QString &string) const {
 171   IrcUser *user = network()->ircUser(userNick);
 172   if(user) return user->encodeString(string);
 173   return network()->encodeString(string);
 174 }
 175
 176 void NetworkConnection::autoReconnectSettingsChanged() {
 177   if(!network()->useAutoReconnect()) {
 178     _autoReconnectTimer.stop();
 179     _autoReconnectCount = 0;
 180   } else {
 181     _autoReconnectTimer.setInterval(network()->autoReconnectInterval() * 1000);
 182     if(_autoReconnectCount != 0) {
 183       if(network()->unlimitedReconnectRetries()) _autoReconnectCount = -1;
 184       else _autoReconnectCount = network()->autoReconnectRetries();
 185     }
 186   }
 187 }
 188
 189 void NetworkConnection::connectToIrc(bool reconnecting) {
 190   if(!reconnecting && network()->useAutoReconnect() && _autoReconnectCount == 0) {
 191     _autoReconnectTimer.setInterval(network()->autoReconnectInterval() * 1000);
 192     if(network()->unlimitedReconnectRetries()) _autoReconnectCount = -1;
 193     else _autoReconnectCount = network()->autoReconnectRetries();
 194   }
 195   QVariantList serverList = network()->serverList();
 196   Identity *identity = coreSession()->identity(network()->identity());
 197   if(!serverList.count()) {
 198     qWarning() << "Server list empty, ignoring connect request!";
 199     return;
 200   }
 201   if(!identity) {
 202     qWarning() << "Invalid identity configures, ignoring connect request!";
 203     return;
 204   }
 205   // use a random server?
 206   if(network()->useRandomServer()) {
 207     _lastUsedServerlistIndex = qrand() % serverList.size();
 208   } else if(_previousConnectionAttemptFailed) {
 209     // cycle to next server if previous connection attempt failed
 210     displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Connection failed. Cycling to next Server"));
 211     if(++_lastUsedServerlistIndex == serverList.size()) {
 212       _lastUsedServerlistIndex = 0;
 213     }
 214   }
 215   _previousConnectionAttemptFailed = false;
 216
 217   QString host = serverList[_lastUsedServerlistIndex].toMap()["Host"].toString();
 218   quint16 port = serverList[_lastUsedServerlistIndex].toMap()["Port"].toUInt();
 219   displayStatusMsg(tr("Connecting to %1:%2...").arg(host).arg(port));
 220   displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Connecting to %1:%2...").arg(host).arg(port));
 221   socket.connectToHost(host, port);
 222 }
 223
 224 void NetworkConnection::networkInitialized(const QString &currentServer) {
 225   if(currentServer.isEmpty()) return;
 226
 227   if(network()->useAutoReconnect() && !network()->unlimitedReconnectRetries()) {
 228     _autoReconnectCount = network()->autoReconnectRetries(); // reset counter
 229   }
 230
 231   sendPerform();
 232
 233   // now we are initialized
 234   setConnectionState(Network::Initialized);
 235   network()->setConnected(true);
 236   emit connected(networkId());
 237   if(!Global::SPUTDEV) {
 238     sendWho();
 239     _whoTimer.start();
 240   }
 241 }
 242
 243 void NetworkConnection::sendPerform() {
 244   BufferInfo statusBuf = Core::bufferInfo(coreSession()->user(), network()->networkId(), BufferInfo::StatusBuffer);
 245   // do auto identify
 246   if(network()->useAutoIdentify() && !network()->autoIdentifyService().isEmpty() && !network()->autoIdentifyPassword().isEmpty()) {
 247     userInputHandler()->handleMsg(statusBuf, QString("%1 IDENTIFY %2").arg(network()->autoIdentifyService(), network()->autoIdentifyPassword()));
 248   }
 249   // send perform list
 250   foreach(QString line, network()->perform()) {
 251     if(!line.isEmpty()) userInput(statusBuf, line);
 252   }
 253
 254   // rejoin channels we've been in
 255   QStringList channels, keys;
 256   foreach(QString chan, persistentChannels()) {
 257     QString key = channelKey(chan);
 258     if(!key.isEmpty()) {
 259       channels.prepend(chan); keys.prepend(key);
 260     } else {
 261       channels.append(chan);
 262     }
 263   }
 264   QString joinString = QString("%1 %2").arg(channels.join(",")).arg(keys.join(",")).trimmed();
 265   if(!joinString.isEmpty()) userInputHandler()->handleJoin(statusBuf, joinString);
 266 }
 267
 268 void NetworkConnection::disconnectFromIrc(bool requested) {
 269   _autoReconnectTimer.stop();
 270   _autoReconnectCount = 0;
 271   displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Disconnecting."));
 272   if(socket.state() < QAbstractSocket::ConnectedState) {
 273     setConnectionState(Network::Disconnected);
 274     socketDisconnected();
 275   } else socket.disconnectFromHost();
 276
 277   if(requested) {
 278     emit quitRequested(networkId());
 279   }
 280 }
 281
 282 void NetworkConnection::socketHasData() {
 283   while(socket.canReadLine()) {
 284     QByteArray s = socket.readLine().trimmed();
 285     ircServerHandler()->handleServerMsg(s);
 286   }
 287 }
 288
 289 void NetworkConnection::socketError(QAbstractSocket::SocketError) {
 290   _previousConnectionAttemptFailed = true;
 291   qDebug() << qPrintable(tr("Could not connect to %1 (%2)").arg(network()->networkName(), socket.errorString()));
 292   emit connectionError(socket.errorString());
 293   emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Connection failure: %1").arg(socket.errorString()));
 294   network()->emitConnectionError(socket.errorString());
 295   if(socket.state() < QAbstractSocket::ConnectedState) {
 296     setConnectionState(Network::Disconnected);
 297     socketDisconnected();
 298   }
 299   // mark last connection attempt as failed
 300
 301   //qDebug() << "exiting...";
 302   //exit(1);
 303 }
 304
 305 #ifndef QT_NO_OPENSSL
 306
 307 void NetworkConnection::sslErrors(const QList<QSslError> &errors) {
 308   socket.ignoreSslErrors();
 309   /* TODO errorhandling
 310   QVariantMap errmsg;
 311   QVariantList errnums;
 312   foreach(QSslError err, errors) errnums << err.error();
 313   errmsg["SslErrors"] = errnums;
 314   errmsg["SslCert"] = socket.peerCertificate().toPem();
 315   errmsg["PeerAddress"] = socket.peerAddress().toString();
 316   errmsg["PeerPort"] = socket.peerPort();
 317   errmsg["PeerName"] = socket.peerName();
 318   emit sslErrors(errmsg);
 319   disconnectFromIrc();
 320   */
 321 }
 322
 323 void NetworkConnection::socketEncrypted() {
 324   //qDebug() << "encrypted!";
 325   socketInitialized();
 326 }
 327
 328 #endif  // QT_NO_OPENSSL
 329
 330 void NetworkConnection::socketConnected() {
 331 #ifdef QT_NO_OPENSSL
 332   socketInitialized();
 333   return;
 334 #else
 335   if(!network()->serverList()[_lastUsedServerlistIndex].toMap()["UseSSL"].toBool()) {
 336     socketInitialized();
 337     return;
 338   }
 339   //qDebug() << "starting handshake";
 340   socket.startClientEncryption();
 341 #endif
 342 }
 343
 344 void NetworkConnection::socketInitialized() {
 345   //emit connected(networkId());  initialize first!
 346   Identity *identity = coreSession()->identity(network()->identity());
 347   if(!identity) {
 348     qWarning() << "Identity invalid!";
 349     disconnectFromIrc();
 350     return;
 351   }
 352   QString passwd = network()->serverList()[_lastUsedServerlistIndex].toMap()["Password"].toString();
 353   if(!passwd.isEmpty()) {
 354     putRawLine(serverEncode(QString("PASS %1").arg(passwd)));
 355   }
 356   putRawLine(serverEncode(QString("NICK :%1").arg(identity->nicks()[0])));  // FIXME: try more nicks if error occurs
 357   putRawLine(serverEncode(QString("USER %1 8 * :%2").arg(identity->ident(), identity->realName())));
 358 }
 359
 360 void NetworkConnection::socketStateChanged(QAbstractSocket::SocketState socketState) {
 361   Network::ConnectionState state;
 362   switch(socketState) {
 363     case QAbstractSocket::UnconnectedState:
 364       state = Network::Disconnected;
 365       break;
 366     case QAbstractSocket::HostLookupState:
 367     case QAbstractSocket::ConnectingState:
 368       state = Network::Connecting;
 369       break;
 370     case QAbstractSocket::ConnectedState:
 371       state = Network::Initializing;
 372       break;
 373     case QAbstractSocket::ClosingState:
 374       state = Network::Disconnecting;
 375       break;
 376     default:
 377       state = Network::Disconnected;
 378   }
 379   setConnectionState(state);
 380 }
 381
 382 void NetworkConnection::socketDisconnected() {
 383   _whoTimer.stop();
 384   network()->setConnected(false);
 385   emit disconnected(networkId());
 386   if(_autoReconnectCount != 0) {
 387     setConnectionState(Network::Reconnecting);
 388     if(_autoReconnectCount == network()->autoReconnectRetries()) doAutoReconnect(); // first try is immediate
 389     else _autoReconnectTimer.start();
 390   }
 391 }
 392
 393 void NetworkConnection::doAutoReconnect() {
 394   if(connectionState() != Network::Disconnected && connectionState() != Network::Reconnecting) {
 395     qWarning() << "NetworkConnection::doAutoReconnect(): Cannot reconnect while not being disconnected!";
 396     return;
 397   }
 398   if(_autoReconnectCount > 0) _autoReconnectCount--;
 399   connectToIrc(true);
 400 }
 401
 402 // FIXME switch to BufferId
 403 void NetworkConnection::userInput(BufferInfo buf, QString msg) {
 404   userInputHandler()->handleUserInput(buf, msg);
 405 }
 406
 407 void NetworkConnection::putRawLine(QByteArray s) {
 408   s += "\r\n";
 409   socket.write(s);
 410   if(Global::SPUTDEV) qDebug() << "SENT:" << s;
 411 }
 412
 413 void NetworkConnection::putCmd(const QString &cmd, const QVariantList &params, const QByteArray &prefix) {
 414   QByteArray msg;
 415   if(!prefix.isEmpty())
 416     msg += ":" + prefix + " ";
 417   msg += cmd.toUpper().toAscii();
 418
 419   for(int i = 0; i < params.size() - 1; i++) {
 420     msg += " " + params[i].toByteArray();
 421   }
 422   if(!params.isEmpty())
 423     msg += " :" + params.last().toByteArray();
 424
 425   putRawLine(msg);
 426 }
 427
 428 void NetworkConnection::sendWho() {
 429   foreach(QString chan, network()->channels()) {
 430     putRawLine("WHO " + serverEncode(chan));
 431   }
 432 }
 433
 434 void NetworkConnection::setChannelJoined(const QString &channel) {
 435   emit channelJoined(networkId(), channel, _channelKeys[channel.toLower()]);
 436 }
 437
 438 void NetworkConnection::setChannelParted(const QString &channel) {
 439   removeChannelKey(channel);
 440   emit channelParted(networkId(), channel);
 441 }
 442
 443 void NetworkConnection::addChannelKey(const QString &channel, const QString &key) {
 444   if(key.isEmpty()) {
 445     removeChannelKey(channel);
 446   } else {
 447     _channelKeys[channel.toLower()] = key;
 448   }
 449 }
 450
 451 void NetworkConnection::removeChannelKey(const QString &channel) {
 452   _channelKeys.remove(channel.toLower());
 453 }
 454
 455 void NetworkConnection::nickChanged(const QString &newNick, const QString &oldNick) {
 456   emit nickChanged(networkId(), newNick, oldNick);
 457 }
 458
 459 /* Exception classes for message handling */
 460 NetworkConnection::ParseError::ParseError(QString cmd, QString prefix, QStringList params) {
 461   Q_UNUSED(prefix);
 462   _msg = QString("Command Parse Error: ") + cmd + params.join(" ");
 463 }
 464
 465 NetworkConnection::UnknownCmdError::UnknownCmdError(QString cmd, QString prefix, QStringList params) {
 466   Q_UNUSED(prefix);
 467   _msg = QString("Unknown Command: ") + cmd + params.join(" ");
 468 }
 469