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