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