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(60 * 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   sendWho();
 238   _whoTimer.start();
 239 }
 240
 241 void NetworkConnection::sendPerform() {
 242   BufferInfo statusBuf = Core::bufferInfo(coreSession()->user(), network()->networkId(), BufferInfo::StatusBuffer);
 243   // do auto identify
 244   if(network()->useAutoIdentify() && !network()->autoIdentifyService().isEmpty() && !network()->autoIdentifyPassword().isEmpty()) {
 245     userInputHandler()->handleMsg(statusBuf, QString("%1 IDENTIFY %2").arg(network()->autoIdentifyService(), network()->autoIdentifyPassword()));
 246   }
 247   // send perform list
 248   foreach(QString line, network()->perform()) {
 249     if(!line.isEmpty()) userInput(statusBuf, line);
 250   }
 251
 252   // rejoin channels we've been in
 253   QStringList channels, keys;
 254   foreach(QString chan, persistentChannels()) {
 255     QString key = channelKey(chan);
 256     if(!key.isEmpty()) {
 257       channels.prepend(chan); keys.prepend(key);
 258     } else {
 259       channels.append(chan);
 260     }
 261   }
 262   QString joinString = QString("%1 %2").arg(channels.join(",")).arg(keys.join(",")).trimmed();
 263   if(!joinString.isEmpty()) userInputHandler()->handleJoin(statusBuf, joinString);
 264 }
 265
 266 void NetworkConnection::disconnectFromIrc(bool requested) {
 267   _autoReconnectTimer.stop();
 268   _autoReconnectCount = 0;
 269   displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Disconnecting."));
 270   if(socket.state() < QAbstractSocket::ConnectedState) {
 271     setConnectionState(Network::Disconnected);
 272     socketDisconnected();
 273   } else socket.disconnectFromHost();
 274
 275   if(requested) {
 276     emit quitRequested(networkId());
 277   }
 278 }
 279
 280 void NetworkConnection::socketHasData() {
 281   while(socket.canReadLine()) {
 282     QByteArray s = socket.readLine();
 283     ircServerHandler()->handleServerMsg(s);
 284   }
 285 }
 286
 287 void NetworkConnection::socketError(QAbstractSocket::SocketError) {
 288   _previousConnectionAttemptFailed = true;
 289   qDebug() << qPrintable(tr("Could not connect to %1 (%2)").arg(network()->networkName(), socket.errorString()));
 290   emit connectionError(socket.errorString());
 291   emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Connection failure: %1").arg(socket.errorString()));
 292   network()->emitConnectionError(socket.errorString());
 293   if(socket.state() < QAbstractSocket::ConnectedState) {
 294     setConnectionState(Network::Disconnected);
 295     socketDisconnected();
 296   }
 297   // mark last connection attempt as failed
 298
 299   //qDebug() << "exiting...";
 300   //exit(1);
 301 }
 302
 303 #ifndef QT_NO_OPENSSL
 304
 305 void NetworkConnection::sslErrors(const QList<QSslError> &errors) {
 306   socket.ignoreSslErrors();
 307   /* TODO errorhandling
 308   QVariantMap errmsg;
 309   QVariantList errnums;
 310   foreach(QSslError err, errors) errnums << err.error();
 311   errmsg["SslErrors"] = errnums;
 312   errmsg["SslCert"] = socket.peerCertificate().toPem();
 313   errmsg["PeerAddress"] = socket.peerAddress().toString();
 314   errmsg["PeerPort"] = socket.peerPort();
 315   errmsg["PeerName"] = socket.peerName();
 316   emit sslErrors(errmsg);
 317   disconnectFromIrc();
 318   */
 319 }
 320
 321 void NetworkConnection::socketEncrypted() {
 322   //qDebug() << "encrypted!";
 323   socketInitialized();
 324 }
 325
 326 #endif  // QT_NO_OPENSSL
 327
 328 void NetworkConnection::socketConnected() {
 329 #ifdef QT_NO_OPENSSL
 330   socketInitialized();
 331   return;
 332 #else
 333   if(!network()->serverList()[_lastUsedServerlistIndex].toMap()["UseSSL"].toBool()) {
 334     socketInitialized();
 335     return;
 336   }
 337   //qDebug() << "starting handshake";
 338   socket.startClientEncryption();
 339 #endif
 340 }
 341
 342 void NetworkConnection::socketInitialized() {
 343   //emit connected(networkId());  initialize first!
 344   Identity *identity = coreSession()->identity(network()->identity());
 345   if(!identity) {
 346     qWarning() << "Identity invalid!";
 347     disconnectFromIrc();
 348     return;
 349   }
 350   QString passwd = network()->serverList()[_lastUsedServerlistIndex].toMap()["Password"].toString();
 351   if(!passwd.isEmpty()) {
 352     putRawLine(serverEncode(QString("PASS %1").arg(passwd)));
 353   }
 354   putRawLine(serverEncode(QString("NICK :%1").arg(identity->nicks()[0])));  // FIXME: try more nicks if error occurs
 355   putRawLine(serverEncode(QString("USER %1 8 * :%2").arg(identity->ident(), identity->realName())));
 356 }
 357
 358 void NetworkConnection::socketStateChanged(QAbstractSocket::SocketState socketState) {
 359   Network::ConnectionState state;
 360   switch(socketState) {
 361     case QAbstractSocket::UnconnectedState:
 362       state = Network::Disconnected;
 363       break;
 364     case QAbstractSocket::HostLookupState:
 365     case QAbstractSocket::ConnectingState:
 366       state = Network::Connecting;
 367       break;
 368     case QAbstractSocket::ConnectedState:
 369       state = Network::Initializing;
 370       break;
 371     case QAbstractSocket::ClosingState:
 372       state = Network::Disconnecting;
 373       break;
 374     default:
 375       state = Network::Disconnected;
 376   }
 377   setConnectionState(state);
 378 }
 379
 380 void NetworkConnection::socketDisconnected() {
 381   _whoTimer.stop();
 382   network()->setConnected(false);
 383   emit disconnected(networkId());
 384   if(_autoReconnectCount != 0) {
 385     setConnectionState(Network::Reconnecting);
 386     if(_autoReconnectCount == network()->autoReconnectRetries()) doAutoReconnect(); // first try is immediate
 387     else _autoReconnectTimer.start();
 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   s += "\r\n";
 407   socket.write(s);
 408 }
 409
 410 void NetworkConnection::putCmd(const QString &cmd, const QVariantList &params, const QByteArray &prefix) {
 411   QByteArray msg;
 412   if(!prefix.isEmpty())
 413     msg += ":" + prefix + " ";
 414   msg += cmd.toUpper().toAscii();
 415
 416   for(int i = 0; i < params.size() - 1; i++) {
 417     msg += " " + params[i].toByteArray();
 418   }
 419   if(!params.isEmpty())
 420     msg += " :" + params.last().toByteArray();
 421
 422   putRawLine(msg);
 423 }
 424
 425 void NetworkConnection::sendWho() {
 426   foreach(QString chan, network()->channels()) {
 427     putRawLine("WHO " + serverEncode(chan));
 428   }
 429 }
 430
 431 void NetworkConnection::setChannelJoined(const QString &channel) {
 432   emit channelJoined(networkId(), channel, _channelKeys[channel.toLower()]);
 433 }
 434
 435 void NetworkConnection::setChannelParted(const QString &channel) {
 436   removeChannelKey(channel);
 437   emit channelParted(networkId(), channel);
 438 }
 439
 440 void NetworkConnection::addChannelKey(const QString &channel, const QString &key) {
 441   if(key.isEmpty()) {
 442     removeChannelKey(channel);
 443   } else {
 444     _channelKeys[channel.toLower()] = key;
 445   }
 446 }
 447
 448 void NetworkConnection::removeChannelKey(const QString &channel) {
 449   _channelKeys.remove(channel.toLower());
 450 }
 451
 452 void NetworkConnection::nickChanged(const QString &newNick, const QString &oldNick) {
 453   emit nickChanged(networkId(), newNick, oldNick);
 454 }
 455
 456 /* Exception classes for message handling */
 457 NetworkConnection::ParseError::ParseError(QString cmd, QString prefix, QStringList params) {
 458   Q_UNUSED(prefix);
 459   _msg = QString("Command Parse Error: ") + cmd + params.join(" ");
 460 }
 461
 462 NetworkConnection::UnknownCmdError::UnknownCmdError(QString cmd, QString prefix, QStringList params) {
 463   Q_UNUSED(prefix);
 464   _msg = QString("Unknown Command: ") + cmd + params.join(" ");
 465 }
 466