src/core/corenetwork.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-09 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
  21 #include "corenetwork.h"
  22
  23 #include "core.h"
  24 #include "coresession.h"
  25 #include "coreidentity.h"
  26
  27 #include "ircserverhandler.h"
  28 #include "userinputhandler.h"
  29 #include "ctcphandler.h"
  30
  31 CoreNetwork::CoreNetwork(const NetworkId &networkid, CoreSession *session)
  32   : Network(networkid, session),
  33     _coreSession(session),
  34     _ircServerHandler(new IrcServerHandler(this)),
  35     _userInputHandler(new UserInputHandler(this)),
  36     _ctcpHandler(new CtcpHandler(this)),
  37     _autoReconnectCount(0),
  38     _quitRequested(false),
  39
  40     _previousConnectionAttemptFailed(false),
  41     _lastUsedServerIndex(0),
  42
  43     // TODO make autowho configurable (possibly per-network)
  44     _autoWhoEnabled(true),
  45     _autoWhoInterval(90),
  46     _autoWhoNickLimit(0), // unlimited
  47     _autoWhoDelay(3)
  48 {
  49   _autoReconnectTimer.setSingleShot(true);
  50   _socketCloseTimer.setSingleShot(true);
  51   connect(&_socketCloseTimer, SIGNAL(timeout()), this, SLOT(socketCloseTimeout()));
  52
  53   _pingTimer.setInterval(60000);
  54   connect(&_pingTimer, SIGNAL(timeout()), this, SLOT(sendPing()));
  55
  56   _autoWhoTimer.setInterval(_autoWhoDelay * 1000);
  57   _autoWhoCycleTimer.setInterval(_autoWhoInterval * 1000);
  58
  59   QHash<QString, QString> channels = coreSession()->persistentChannels(networkId());
  60   foreach(QString chan, channels.keys()) {
  61     _channelKeys[chan.toLower()] = channels[chan];
  62   }
  63
  64   connect(&_autoReconnectTimer, SIGNAL(timeout()), this, SLOT(doAutoReconnect()));
  65   connect(&_autoWhoTimer, SIGNAL(timeout()), this, SLOT(sendAutoWho()));
  66   connect(&_autoWhoCycleTimer, SIGNAL(timeout()), this, SLOT(startAutoWhoCycle()));
  67   connect(&_tokenBucketTimer, SIGNAL(timeout()), this, SLOT(fillBucketAndProcessQueue()));
  68   connect(this, SIGNAL(connectRequested()), this, SLOT(connectToIrc()));
  69
  70
  71   connect(&socket, SIGNAL(connected()), this, SLOT(socketInitialized()));
  72   connect(&socket, SIGNAL(disconnected()), this, SLOT(socketDisconnected()));
  73   connect(&socket, SIGNAL(error(QAbstractSocket::SocketError)), this, SLOT(socketError(QAbstractSocket::SocketError)));
  74   connect(&socket, SIGNAL(stateChanged(QAbstractSocket::SocketState)), this, SLOT(socketStateChanged(QAbstractSocket::SocketState)));
  75   connect(&socket, SIGNAL(readyRead()), this, SLOT(socketHasData()));
  76 #ifdef HAVE_SSL
  77   connect(&socket, SIGNAL(encrypted()), this, SLOT(socketInitialized()));
  78   connect(&socket, SIGNAL(sslErrors(const QList<QSslError> &)), this, SLOT(sslErrors(const QList<QSslError> &)));
  79 #endif
  80 }
  81
  82 CoreNetwork::~CoreNetwork() {
  83   if(connectionState() != Disconnected && connectionState() != Network::Reconnecting)
  84     disconnectFromIrc(false);      // clean up, but this does not count as requested disconnect!
  85   disconnect(&socket, 0, this, 0); // this keeps the socket from triggering events during clean up
  86   delete _ircServerHandler;
  87   delete _userInputHandler;
  88   delete _ctcpHandler;
  89 }
  90
  91 QString CoreNetwork::channelDecode(const QString &bufferName, const QByteArray &string) const {
  92   if(!bufferName.isEmpty()) {
  93     IrcChannel *channel = ircChannel(bufferName);
  94     if(channel)
  95       return channel->decodeString(string);
  96   }
  97   return decodeString(string);
  98 }
  99
 100 QString CoreNetwork::userDecode(const QString &userNick, const QByteArray &string) const {
 101   IrcUser *user = ircUser(userNick);
 102   if(user)
 103     return user->decodeString(string);
 104   return decodeString(string);
 105 }
 106
 107 QByteArray CoreNetwork::channelEncode(const QString &bufferName, const QString &string) const {
 108   if(!bufferName.isEmpty()) {
 109     IrcChannel *channel = ircChannel(bufferName);
 110     if(channel)
 111       return channel->encodeString(string);
 112   }
 113   return encodeString(string);
 114 }
 115
 116 QByteArray CoreNetwork::userEncode(const QString &userNick, const QString &string) const {
 117   IrcUser *user = ircUser(userNick);
 118   if(user)
 119     return user->encodeString(string);
 120   return encodeString(string);
 121 }
 122
 123 void CoreNetwork::connectToIrc(bool reconnecting) {
 124   if(!reconnecting && useAutoReconnect() && _autoReconnectCount == 0) {
 125     _autoReconnectTimer.setInterval(autoReconnectInterval() * 1000);
 126     if(unlimitedReconnectRetries())
 127       _autoReconnectCount = -1;
 128     else
 129       _autoReconnectCount = autoReconnectRetries();
 130   }
 131   if(serverList().isEmpty()) {
 132     qWarning() << "Server list empty, ignoring connect request!";
 133     return;
 134   }
 135   CoreIdentity *identity = identityPtr();
 136   if(!identity) {
 137     qWarning() << "Invalid identity configures, ignoring connect request!";
 138     return;
 139   }
 140   // use a random server?
 141   if(useRandomServer()) {
 142     _lastUsedServerIndex = qrand() % serverList().size();
 143   } else if(_previousConnectionAttemptFailed) {
 144     // cycle to next server if previous connection attempt failed
 145     displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Connection failed. Cycling to next Server"));
 146     if(++_lastUsedServerIndex >= serverList().size()) {
 147       _lastUsedServerIndex = 0;
 148     }
 149   }
 150   _previousConnectionAttemptFailed = false;
 151
 152   Server server = usedServer();
 153   displayStatusMsg(tr("Connecting to %1:%2...").arg(server.host).arg(server.port));
 154   displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Connecting to %1:%2...").arg(server.host).arg(server.port));
 155
 156   if(server.useProxy) {
 157     QNetworkProxy proxy((QNetworkProxy::ProxyType)server.proxyType, server.proxyHost, server.proxyPort, server.proxyUser, server.proxyPass);
 158     socket.setProxy(proxy);
 159   } else {
 160     socket.setProxy(QNetworkProxy::NoProxy);
 161   }
 162
 163 #ifdef HAVE_SSL
 164   socket.setProtocol((QSsl::SslProtocol)server.sslVersion);
 165   if(server.useSsl) {
 166     CoreIdentity *identity = identityPtr();
 167     if(identity) {
 168       socket.setLocalCertificate(identity->sslCert());
 169       socket.setPrivateKey(identity->sslKey());
 170     }
 171     socket.connectToHostEncrypted(server.host, server.port);
 172   } else {
 173     socket.connectToHost(server.host, server.port);
 174   }
 175 #else
 176   socket.connectToHost(server.host, server.port);
 177 #endif
 178 }
 179
 180 void CoreNetwork::disconnectFromIrc(bool requested, const QString &reason) {
 181   _quitRequested = requested; // see socketDisconnected();
 182   _autoReconnectTimer.stop();
 183   _autoReconnectCount = 0; // prohibiting auto reconnect
 184
 185   IrcUser *me_ = me();
 186   if(me_) {
 187     QString awayMsg;
 188     if(me_->isAway())
 189       awayMsg = me_->awayMessage();
 190     Core::setAwayMessage(userId(), networkId(), awayMsg);
 191     Core::setUserModes(userId(), networkId(), me_->userModes());
 192   }
 193
 194   displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Disconnecting."));
 195   if(socket.state() == QAbstractSocket::UnconnectedState) {
 196     socketDisconnected();
 197   } else if(socket.state() < QAbstractSocket::ConnectedState || !requested) {
 198     // we might be in a state waiting for a timeout...
 199     // or (!requested) this is a core shutdown...
 200     // in both cases we don't really care... set a disconnected state
 201     socket.close();
 202     socketDisconnected();
 203   } else {
 204     // quit gracefully if it's user requested quit
 205     userInputHandler()->issueQuit(reason);
 206     // the irc server has 10 seconds to close the socket
 207     _socketCloseTimer.start(10000);
 208   }
 209 }
 210
 211 void CoreNetwork::userInput(BufferInfo buf, QString msg) {
 212   userInputHandler()->handleUserInput(buf, msg);
 213 }
 214
 215 void CoreNetwork::putRawLine(QByteArray s) {
 216   if(_tokenBucket > 0)
 217     writeToSocket(s);
 218   else
 219     _msgQueue.append(s);
 220 }
 221
 222 void CoreNetwork::putCmd(const QString &cmd, const QList<QByteArray> &params, const QByteArray &prefix) {
 223   QByteArray msg;
 224
 225   if(!prefix.isEmpty())
 226     msg += ":" + prefix + " ";
 227   msg += cmd.toUpper().toAscii();
 228
 229   for(int i = 0; i < params.size() - 1; i++) {
 230     msg += " " + params[i];
 231   }
 232   if(!params.isEmpty())
 233     msg += " :" + params.last();
 234
 235   putRawLine(msg);
 236 }
 237
 238 void CoreNetwork::setChannelJoined(const QString &channel) {
 239   _autoWhoQueue.prepend(channel.toLower()); // prepend so this new chan is the first to be checked
 240
 241   Core::setChannelPersistent(userId(), networkId(), channel, true);
 242   Core::setPersistentChannelKey(userId(), networkId(), channel, _channelKeys[channel.toLower()]);
 243 }
 244
 245 void CoreNetwork::setChannelParted(const QString &channel) {
 246   removeChannelKey(channel);
 247   _autoWhoQueue.removeAll(channel.toLower());
 248   _autoWhoInProgress.remove(channel.toLower());
 249
 250   Core::setChannelPersistent(userId(), networkId(), channel, false);
 251 }
 252
 253 void CoreNetwork::addChannelKey(const QString &channel, const QString &key) {
 254   if(key.isEmpty()) {
 255     removeChannelKey(channel);
 256   } else {
 257     _channelKeys[channel.toLower()] = key;
 258   }
 259 }
 260
 261 void CoreNetwork::removeChannelKey(const QString &channel) {
 262   _channelKeys.remove(channel.toLower());
 263 }
 264
 265 bool CoreNetwork::setAutoWhoDone(const QString &channel) {
 266   if(_autoWhoInProgress.value(channel.toLower(), 0) <= 0)
 267     return false;
 268   _autoWhoInProgress[channel.toLower()]--;
 269   return true;
 270 }
 271
 272 void CoreNetwork::setMyNick(const QString &mynick) {
 273   Network::setMyNick(mynick);
 274   if(connectionState() == Network::Initializing)
 275     networkInitialized();
 276 }
 277
 278 void CoreNetwork::socketHasData() {
 279   while(socket.canReadLine()) {
 280     QByteArray s = socket.readLine().trimmed();
 281     ircServerHandler()->handleServerMsg(s);
 282   }
 283 }
 284
 285 void CoreNetwork::socketError(QAbstractSocket::SocketError error) {
 286   if(_quitRequested && error == QAbstractSocket::RemoteHostClosedError)
 287     return;
 288
 289   _previousConnectionAttemptFailed = true;
 290   qWarning() << qPrintable(tr("Could not connect to %1 (%2)").arg(networkName(), socket.errorString()));
 291   emit connectionError(socket.errorString());
 292   emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Connection failure: %1").arg(socket.errorString()));
 293   emitConnectionError(socket.errorString());
 294   if(socket.state() < QAbstractSocket::ConnectedState) {
 295     socketDisconnected();
 296   }
 297 }
 298
 299 void CoreNetwork::socketInitialized() {
 300   Server server = usedServer();
 301 #ifdef HAVE_SSL
 302   if(server.useSsl && !socket.isEncrypted())
 303     return;
 304 #endif
 305
 306   CoreIdentity *identity = identityPtr();
 307   if(!identity) {
 308     qCritical() << "Identity invalid!";
 309     disconnectFromIrc();
 310     return;
 311   }
 312
 313   // TokenBucket to avoid sending too much at once
 314   _messagesPerSecond = 1;
 315   _burstSize = 5;
 316   _tokenBucket = 5; // init with a full bucket
 317   _tokenBucketTimer.start(_messagesPerSecond * 1000);
 318
 319   if(!server.password.isEmpty()) {
 320     putRawLine(serverEncode(QString("PASS %1").arg(server.password)));
 321   }
 322   putRawLine(serverEncode(QString("NICK :%1").arg(identity->nicks()[0])));
 323   putRawLine(serverEncode(QString("USER %1 8 * :%2").arg(identity->ident(), identity->realName())));
 324 }
 325
 326 void CoreNetwork::socketDisconnected() {
 327   _pingTimer.stop();
 328   _autoWhoCycleTimer.stop();
 329   _autoWhoTimer.stop();
 330   _autoWhoQueue.clear();
 331   _autoWhoInProgress.clear();
 332
 333   _socketCloseTimer.stop();
 334
 335   _tokenBucketTimer.stop();
 336
 337   IrcUser *me_ = me();
 338   if(me_) {
 339     foreach(QString channel, me_->channels())
 340       emit displayMsg(Message::Quit, BufferInfo::ChannelBuffer, channel, "", me_->hostmask());
 341   }
 342
 343   setConnected(false);
 344   emit disconnected(networkId());
 345   if(_quitRequested) {
 346     setConnectionState(Network::Disconnected);
 347     Core::setNetworkConnected(userId(), networkId(), false);
 348   } else if(_autoReconnectCount != 0) {
 349     setConnectionState(Network::Reconnecting);
 350     if(_autoReconnectCount == autoReconnectRetries())
 351       doAutoReconnect(); // first try is immediate
 352     else
 353       _autoReconnectTimer.start();
 354   }
 355 }
 356
 357 void CoreNetwork::socketStateChanged(QAbstractSocket::SocketState socketState) {
 358   Network::ConnectionState state;
 359   switch(socketState) {
 360     case QAbstractSocket::UnconnectedState:
 361       state = Network::Disconnected;
 362       break;
 363     case QAbstractSocket::HostLookupState:
 364     case QAbstractSocket::ConnectingState:
 365       state = Network::Connecting;
 366       break;
 367     case QAbstractSocket::ConnectedState:
 368       state = Network::Initializing;
 369       break;
 370     case QAbstractSocket::ClosingState:
 371       state = Network::Disconnecting;
 372       break;
 373     default:
 374       state = Network::Disconnected;
 375   }
 376   setConnectionState(state);
 377 }
 378
 379 void CoreNetwork::networkInitialized() {
 380   setConnectionState(Network::Initialized);
 381   setConnected(true);
 382   _quitRequested = false;
 383
 384   if(useAutoReconnect()) {
 385     // reset counter
 386     _autoReconnectCount = autoReconnectRetries();
 387   }
 388
 389   // restore away state
 390   userInputHandler()->handleAway(BufferInfo(), Core::awayMessage(userId(), networkId()));
 391
 392   // restore old user modes if server default mode is set.
 393   IrcUser *me_ = me();
 394   if(me_) {
 395     if(!me_->userModes().isEmpty()) {
 396       restoreUserModes();
 397     } else {
 398       connect(me_, SIGNAL(userModesSet(QString)), this, SLOT(restoreUserModes()));
 399       connect(me_, SIGNAL(userModesAdded(QString)), this, SLOT(restoreUserModes()));
 400     }
 401   }
 402
 403   sendPerform();
 404
 405   _pingTimer.start();
 406
 407   if(_autoWhoEnabled) {
 408     _autoWhoCycleTimer.start();
 409     _autoWhoTimer.start();
 410     startAutoWhoCycle();  // FIXME wait for autojoin to be completed
 411   }
 412
 413   Core::bufferInfo(userId(), networkId(), BufferInfo::StatusBuffer); // create status buffer
 414   Core::setNetworkConnected(userId(), networkId(), true);
 415 }
 416
 417 void CoreNetwork::sendPerform() {
 418   BufferInfo statusBuf = BufferInfo::fakeStatusBuffer(networkId());
 419
 420   // do auto identify
 421   if(useAutoIdentify() && !autoIdentifyService().isEmpty() && !autoIdentifyPassword().isEmpty()) {
 422     userInputHandler()->handleMsg(statusBuf, QString("%1 IDENTIFY %2").arg(autoIdentifyService(), autoIdentifyPassword()));
 423   }
 424
 425   // send perform list
 426   foreach(QString line, perform()) {
 427     if(!line.isEmpty()) userInput(statusBuf, line);
 428   }
 429
 430   // rejoin channels we've been in
 431   if(rejoinChannels()) {
 432     QStringList channels, keys;
 433     foreach(QString chan, coreSession()->persistentChannels(networkId()).keys()) {
 434       QString key = channelKey(chan);
 435       if(!key.isEmpty()) {
 436         channels.prepend(chan);
 437         keys.prepend(key);
 438       } else {
 439         channels.append(chan);
 440       }
 441     }
 442     QString joinString = QString("%1 %2").arg(channels.join(",")).arg(keys.join(",")).trimmed();
 443     if(!joinString.isEmpty())
 444       userInputHandler()->handleJoin(statusBuf, joinString);
 445   }
 446 }
 447
 448 void CoreNetwork::restoreUserModes() {
 449   IrcUser *me_ = me();
 450   Q_ASSERT(me_);
 451
 452   disconnect(me_, SIGNAL(userModesSet(QString)), this, SLOT(restoreUserModes()));
 453   disconnect(me_, SIGNAL(userModesAdded(QString)), this, SLOT(restoreUserModes()));
 454
 455   QString removeModes;
 456   QString addModes = Core::userModes(userId(), networkId());
 457   QString currentModes = me_->userModes();
 458
 459   removeModes = currentModes;
 460   removeModes.remove(QRegExp(QString("[%1]").arg(addModes)));
 461   addModes.remove(QRegExp(QString("[%1]").arg(currentModes)));
 462
 463   removeModes = QString("%1 -%2").arg(me_->nick(), removeModes);
 464   addModes = QString("%1 +%2").arg(me_->nick(), addModes);
 465   userInputHandler()->handleMode(BufferInfo(), removeModes);
 466   userInputHandler()->handleMode(BufferInfo(), addModes);
 467 }
 468
 469 void CoreNetwork::setUseAutoReconnect(bool use) {
 470   Network::setUseAutoReconnect(use);
 471   if(!use)
 472     _autoReconnectTimer.stop();
 473 }
 474
 475 void CoreNetwork::setAutoReconnectInterval(quint32 interval) {
 476   Network::setAutoReconnectInterval(interval);
 477   _autoReconnectTimer.setInterval(interval * 1000);
 478 }
 479
 480 void CoreNetwork::setAutoReconnectRetries(quint16 retries) {
 481   Network::setAutoReconnectRetries(retries);
 482   if(_autoReconnectCount != 0) {
 483     if(unlimitedReconnectRetries())
 484       _autoReconnectCount = -1;
 485     else
 486       _autoReconnectCount = autoReconnectRetries();
 487   }
 488 }
 489
 490 void CoreNetwork::doAutoReconnect() {
 491   if(connectionState() != Network::Disconnected && connectionState() != Network::Reconnecting) {
 492     qWarning() << "CoreNetwork::doAutoReconnect(): Cannot reconnect while not being disconnected!";
 493     return;
 494   }
 495   if(_autoReconnectCount > 0)
 496     _autoReconnectCount--;
 497   connectToIrc(true);
 498 }
 499
 500 void CoreNetwork::sendPing() {
 501   userInputHandler()->handlePing(BufferInfo(), QString());
 502 }
 503
 504 void CoreNetwork::sendAutoWho() {
 505   while(!_autoWhoQueue.isEmpty()) {
 506     QString chan = _autoWhoQueue.takeFirst();
 507     IrcChannel *ircchan = ircChannel(chan);
 508     if(!ircchan) continue;
 509     if(_autoWhoNickLimit > 0 && ircchan->ircUsers().count() > _autoWhoNickLimit) continue;
 510     _autoWhoInProgress[chan]++;
 511     putRawLine("WHO " + serverEncode(chan));
 512     if(_autoWhoQueue.isEmpty() && _autoWhoEnabled && !_autoWhoCycleTimer.isActive()) {
 513       // Timer was stopped, means a new cycle is due immediately
 514       _autoWhoCycleTimer.start();
 515       startAutoWhoCycle();
 516     }
 517     break;
 518   }
 519 }
 520
 521 void CoreNetwork::startAutoWhoCycle() {
 522   if(!_autoWhoQueue.isEmpty()) {
 523     _autoWhoCycleTimer.stop();
 524     return;
 525   }
 526   _autoWhoQueue = channels();
 527 }
 528
 529 #ifdef HAVE_SSL
 530 void CoreNetwork::sslErrors(const QList<QSslError> &sslErrors) {
 531   Q_UNUSED(sslErrors)
 532   socket.ignoreSslErrors();
 533   // TODO errorhandling
 534 }
 535 #endif  // HAVE_SSL
 536
 537 void CoreNetwork::fillBucketAndProcessQueue() {
 538   if(_tokenBucket < _burstSize) {
 539     _tokenBucket++;
 540   }
 541
 542   while(_msgQueue.size() > 0 && _tokenBucket > 0) {
 543     writeToSocket(_msgQueue.takeFirst());
 544   }
 545 }
 546
 547 void CoreNetwork::writeToSocket(const QByteArray &data) {
 548   socket.write(data);
 549   socket.write("\r\n");
 550   _tokenBucket--;
 551 }
 552
 553 Network::Server CoreNetwork::usedServer() const {
 554   if(_lastUsedServerIndex < serverList().count())
 555     return serverList()[_lastUsedServerIndex];
 556
 557   if(!serverList().isEmpty())
 558     return serverList()[0];
 559
 560   return Network::Server();
 561 }
 562
 563 void CoreNetwork::requestConnect() const {
 564   if(connectionState() != Disconnected) {
 565     qWarning() << "Requesting connect while already being connected!";
 566     return;
 567   }
 568   Network::requestConnect();
 569 }
 570
 571 void CoreNetwork::requestDisconnect() const {
 572   if(connectionState() == Disconnected) {
 573     qWarning() << "Requesting disconnect while not being connected!";
 574     return;
 575   }
 576   userInputHandler()->handleQuit(BufferInfo(), QString());
 577 }
 578
 579 void CoreNetwork::requestSetNetworkInfo(const NetworkInfo &info) {
 580   Network::Server currentServer = usedServer();
 581   setNetworkInfo(info);
 582   Core::updateNetwork(coreSession()->user(), info);
 583
 584   // the order of the servers might have changed,
 585   // so we try to find the previously used server
 586   _lastUsedServerIndex = 0;
 587   for(int i = 0; i < serverList().count(); i++) {
 588     Network::Server server = serverList()[i];
 589     if(server.host == currentServer.host && server.port == currentServer.port) {
 590       _lastUsedServerIndex = i;
 591       break;
 592     }
 593   }
 594 }