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