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