Add igungor to aboutdlg.cpp
[quassel.git] / src / core / networkconnection.cpp
index a461d26..d177d4c 100644 (file)
 
 #include "ircchannel.h"
 #include "ircuser.h"
-#include "network.h"
 #include "identity.h"
 
 #include "ircserverhandler.h"
 #include "userinputhandler.h"
 #include "ctcphandler.h"
 
-NetworkConnection::NetworkConnection(Network *network, CoreSession *session) : QObject(network),
+#include "logger.h"
+
+NetworkConnection::NetworkConnection(Network *network, CoreSession *session)
+  : QObject(network),
     _connectionState(Network::Disconnected),
     _network(network),
     _coreSession(session),
     _ircServerHandler(new IrcServerHandler(this)),
     _userInputHandler(new UserInputHandler(this)),
     _ctcpHandler(new CtcpHandler(this)),
-    _autoReconnectCount(0)
+    _autoReconnectCount(0),
+    _quitRequested(false),
+
+    _previousConnectionAttemptFailed(false),
+    _lastUsedServerlistIndex(0),
+
+    // TODO make autowho configurable (possibly per-network)
+    _autoWhoEnabled(true),
+    _autoWhoInterval(90),
+    _autoWhoNickLimit(0), // unlimited
+    _autoWhoDelay(3),
+
+    // TokenBucket to avaid sending too much at once
+    _messagesPerSecond(1),
+    _burstSize(5),
+    _tokenBucket(5) // init with a full bucket
 {
   _autoReconnectTimer.setSingleShot(true);
- _previousConnectionAttemptFailed = false;
- _lastUsedServerlistIndex = 0;
-  // TODO make configurable
-  _whoTimer.setInterval(60 * 1000);
-  _whoTimer.setSingleShot(false);
+  _socketCloseTimer.setSingleShot(true);
+  connect(&_socketCloseTimer, SIGNAL(timeout()), this, SLOT(socketCloseTimeout()));
+
+  _pingTimer.setInterval(60000);
+  connect(&_pingTimer, SIGNAL(timeout()), this, SLOT(sendPing()));
+
+  _autoWhoTimer.setInterval(_autoWhoDelay * 1000);
+  _autoWhoCycleTimer.setInterval(_autoWhoInterval * 1000);
+  
+  _tokenBucketTimer.start(_messagesPerSecond * 1000);
 
   QHash<QString, QString> channels = coreSession()->persistentChannels(networkId());
   foreach(QString chan, channels.keys()) {
@@ -58,14 +80,16 @@ NetworkConnection::NetworkConnection(Network *network, CoreSession *session) : Q
   }
 
   connect(&_autoReconnectTimer, SIGNAL(timeout()), this, SLOT(doAutoReconnect()));
-  connect(&_whoTimer, SIGNAL(timeout()), this, SLOT(sendWho()));
+  connect(&_autoWhoTimer, SIGNAL(timeout()), this, SLOT(sendAutoWho()));
+  connect(&_autoWhoCycleTimer, SIGNAL(timeout()), this, SLOT(startAutoWhoCycle()));
+  connect(&_tokenBucketTimer, SIGNAL(timeout()), this, SLOT(fillBucketAndProcessQueue()));
 
   connect(network, SIGNAL(currentServerSet(const QString &)), this, SLOT(networkInitialized(const QString &)));
   connect(network, SIGNAL(useAutoReconnectSet(bool)), this, SLOT(autoReconnectSettingsChanged()));
   connect(network, SIGNAL(autoReconnectIntervalSet(quint32)), this, SLOT(autoReconnectSettingsChanged()));
   connect(network, SIGNAL(autoReconnectRetriesSet(quint16)), this, SLOT(autoReconnectSettingsChanged()));
 
-#ifndef QT_NO_OPENSSL
+#ifdef HAVE_SSL
   connect(&socket, SIGNAL(encrypted()), this, SLOT(socketEncrypted()));
   connect(&socket, SIGNAL(sslErrors(const QList<QSslError> &)), this, SLOT(sslErrors(const QList<QSslError> &)));
 #endif
@@ -85,58 +109,18 @@ NetworkConnection::NetworkConnection(Network *network, CoreSession *session) : Q
 NetworkConnection::~NetworkConnection() {
   if(connectionState() != Network::Disconnected && connectionState() != Network::Reconnecting)
     disconnectFromIrc(false); // clean up, but this does not count as requested disconnect!
+  disconnect(&socket, 0, this, 0); // this keeps the socket from triggering events during clean up
   delete _ircServerHandler;
   delete _userInputHandler;
   delete _ctcpHandler;
 }
 
-bool NetworkConnection::isConnected() const {
-  // return socket.state() == QAbstractSocket::ConnectedState;
-  return connectionState() == Network::Initialized;
-}
-
-Network::ConnectionState NetworkConnection::connectionState() const {
-  return _connectionState;
-}
-
 void NetworkConnection::setConnectionState(Network::ConnectionState state) {
   _connectionState = state;
   network()->setConnectionState(state);
   emit connectionStateChanged(state);
 }
 
-NetworkId NetworkConnection::networkId() const {
-  return network()->networkId();
-}
-
-QString NetworkConnection::networkName() const {
-  return network()->networkName();
-}
-
-Identity *NetworkConnection::identity() const {
-  return coreSession()->identity(network()->identity());
-}
-
-Network *NetworkConnection::network() const {
-  return _network;
-}
-
-CoreSession *NetworkConnection::coreSession() const {
-  return _coreSession;
-}
-
-IrcServerHandler *NetworkConnection::ircServerHandler() const {
-  return _ircServerHandler;
-}
-
-UserInputHandler *NetworkConnection::userInputHandler() const {
-  return _userInputHandler;
-}
-
-CtcpHandler *NetworkConnection::ctcpHandler() const {
-  return _ctcpHandler;
-}
-
 QString NetworkConnection::serverDecode(const QByteArray &string) const {
   return network()->decodeServerString(string);
 }
@@ -234,8 +218,14 @@ void NetworkConnection::networkInitialized(const QString &currentServer) {
   setConnectionState(Network::Initialized);
   network()->setConnected(true);
   emit connected(networkId());
-  sendWho();
-  _whoTimer.start();
+
+  _pingTimer.start();
+
+  if(_autoWhoEnabled) {
+    _autoWhoCycleTimer.start();
+    _autoWhoTimer.start();
+    startAutoWhoCycle();  // FIXME wait for autojoin to be completed
+  }
 }
 
 void NetworkConnection::sendPerform() {
@@ -263,40 +253,41 @@ void NetworkConnection::sendPerform() {
   if(!joinString.isEmpty()) userInputHandler()->handleJoin(statusBuf, joinString);
 }
 
-void NetworkConnection::disconnectFromIrc(bool requested) {
+void NetworkConnection::disconnectFromIrc(bool requested, const QString &reason) {
+  _quitRequested = requested; // see socketDisconnected();
   _autoReconnectTimer.stop();
-  _autoReconnectCount = 0;
+  _autoReconnectCount = 0; // prohibiting auto reconnect
   displayMsg(Message::Server, BufferInfo::StatusBuffer, "", tr("Disconnecting."));
-  if(socket.state() < QAbstractSocket::ConnectedState) {
-    setConnectionState(Network::Disconnected);
+  if(socket.state() == QAbstractSocket::UnconnectedState) {
     socketDisconnected();
-  } else socket.disconnectFromHost();
-
-  if(requested) {
-    emit quitRequested(networkId());
+  } else if(socket.state() < QAbstractSocket::ConnectedState || !requested) {
+    // we might be in a state waiting for a timeout...
+    // or (!requested) this is a core shutdown...
+    // in both cases we don't really care... set a disconnected state
+    socket.close();
+    socketDisconnected();
+  } else {
+    // quit gracefully if it's user requested quit
+    userInputHandler()->issueQuit(reason);
+    // the irc server has 10 seconds to close the socket
+    _socketCloseTimer.start(10000);
   }
 }
 
 void NetworkConnection::socketHasData() {
   while(socket.canReadLine()) {
     QByteArray s = socket.readLine().trimmed();
-    // FIXME debug
-    if(Global::SPUTDEV && s == lastMsgReceived) {
-      qWarning() << "NetworkConnection::socketHasData(): Message repeated! -> loop?";
-    }
-    lastMsgReceived = s;
     ircServerHandler()->handleServerMsg(s);
   }
 }
 
 void NetworkConnection::socketError(QAbstractSocket::SocketError) {
   _previousConnectionAttemptFailed = true;
-  qDebug() << qPrintable(tr("Could not connect to %1 (%2)").arg(network()->networkName(), socket.errorString()));
+  qWarning() << qPrintable(tr("Could not connect to %1 (%2)").arg(network()->networkName(), socket.errorString()));
   emit connectionError(socket.errorString());
   emit displayMsg(Message::Error, BufferInfo::StatusBuffer, "", tr("Connection failure: %1").arg(socket.errorString()));
   network()->emitConnectionError(socket.errorString());
   if(socket.state() < QAbstractSocket::ConnectedState) {
-    setConnectionState(Network::Disconnected);
     socketDisconnected();
   }
   // mark last connection attempt as failed
@@ -305,9 +296,10 @@ void NetworkConnection::socketError(QAbstractSocket::SocketError) {
   //exit(1);
 }
 
-#ifndef QT_NO_OPENSSL
+#ifdef HAVE_SSL
 
-void NetworkConnection::sslErrors(const QList<QSslError> &errors) {
+void NetworkConnection::sslErrors(const QList<QSslError> &sslErrors) {
+  Q_UNUSED(sslErrors)
   socket.ignoreSslErrors();
   /* TODO errorhandling
   QVariantMap errmsg;
@@ -328,10 +320,10 @@ void NetworkConnection::socketEncrypted() {
   socketInitialized();
 }
 
-#endif  // QT_NO_OPENSSL
+#endif  // HAVE_SSL
 
 void NetworkConnection::socketConnected() {
-#ifdef QT_NO_OPENSSL
+#ifndef HAVE_SSL
   socketInitialized();
   return;
 #else
@@ -348,7 +340,7 @@ void NetworkConnection::socketInitialized() {
   //emit connected(networkId());  initialize first!
   Identity *identity = coreSession()->identity(network()->identity());
   if(!identity) {
-    qWarning() << "Identity invalid!";
+    qCritical() << "Identity invalid!";
     disconnectFromIrc();
     return;
   }
@@ -382,14 +374,36 @@ void NetworkConnection::socketStateChanged(QAbstractSocket::SocketState socketSt
   setConnectionState(state);
 }
 
+void NetworkConnection::socketCloseTimeout() {
+  socket.disconnectFromHost();
+}
+
 void NetworkConnection::socketDisconnected() {
-  _whoTimer.stop();
+  _pingTimer.stop();
+  _autoWhoCycleTimer.stop();
+  _autoWhoTimer.stop();
+  _autoWhoQueue.clear();
+  _autoWhoInProgress.clear();
+
+  _socketCloseTimer.stop();
+
+  IrcUser *me = network()->me();
+  if(me) {
+    foreach(QString channel, me->channels())
+      emit displayMsg(Message::Quit, BufferInfo::ChannelBuffer, channel, "", me->hostmask());
+  }
+
   network()->setConnected(false);
   emit disconnected(networkId());
-  if(_autoReconnectCount != 0) {
+  if(_quitRequested) {
+    setConnectionState(Network::Disconnected);
+    emit quitRequested(networkId());
+  } else if(_autoReconnectCount != 0) {
     setConnectionState(Network::Reconnecting);
-    if(_autoReconnectCount == network()->autoReconnectRetries()) doAutoReconnect(); // first try is immediate
-    else _autoReconnectTimer.start();
+    if(_autoReconnectCount == network()->autoReconnectRetries())
+      doAutoReconnect(); // first try is immediate
+    else
+      _autoReconnectTimer.start();
   }
 }
 
@@ -408,37 +422,145 @@ void NetworkConnection::userInput(BufferInfo buf, QString msg) {
 }
 
 void NetworkConnection::putRawLine(QByteArray s) {
+  if(_tokenBucket > 0) {
+    // qDebug() << "putRawLine: " << s;
+    writeToSocket(s);
+  } else {
+    _msgQueue.append(s);
+  }
+}
+
+void NetworkConnection::writeToSocket(QByteArray s) {
   s += "\r\n";
+  // qDebug() << "writeToSocket: " << s.size();
   socket.write(s);
+  _tokenBucket--;
 }
 
-void NetworkConnection::putCmd(const QString &cmd, const QVariantList &params, const QByteArray &prefix) {
+void NetworkConnection::fillBucketAndProcessQueue() {
+  if(_tokenBucket < _burstSize) {
+    _tokenBucket++;
+  }
+
+  while(_msgQueue.size() > 0 && _tokenBucket > 0) {
+    writeToSocket(_msgQueue.takeFirst());
+  }
+}
+
+// returns 0 if the message will not be chopped by the irc server or number of chopped bytes if message is too long
+int NetworkConnection::lastParamOverrun(const QString &cmd, const QList<QByteArray> &params) {
+  //the server will pass our message that trunkated to 512 bytes including CRLF with the following format:
+  // ":prefix COMMAND param0 param1 :lastparam"
+  // where prefix = "nickname!user@host"
+  // that means that the last message can be as long as:
+  // 512 - nicklen - userlen - hostlen - commandlen - sum(param[0]..param[n-1])) - 2 (for CRLF) - 4 (":!@" + 1space between prefix and command) - max(paramcount - 1, 0) (space for simple params) - 2 (space and colon for last param)
+  IrcUser *me = network()->me();
+  int maxLen = 480 - cmd.toAscii().count(); // educated guess in case we don't know us (yet?)
+
+  if(me)
+    maxLen = 512 - serverEncode(me->nick()).count() - serverEncode(me->user()).count() - serverEncode(me->host()).count() - cmd.toAscii().count() - 6;
+
+  if(!params.isEmpty()) {
+    for(int i = 0; i < params.count() - 1; i++) {
+      maxLen -= (params[i].count() + 1);
+    }
+    maxLen -= 2; // " :" last param separator;
+    
+    if(params.last().count() > maxLen) {
+      return params.last().count() - maxLen;
+    } else {
+      return 0;
+    }
+  } else {
+    return 0;
+  }
+}
+
+void NetworkConnection::putCmd(const QString &cmd, const QList<QByteArray> &params, const QByteArray &prefix) {
   QByteArray msg;
+  if(cmd == "PRIVMSG" && params.count() > 1) {
+    int overrun = lastParamOverrun(cmd, params);
+    if(overrun) {
+      QList<QByteArray> paramCopy1 = params;
+      paramCopy1.removeLast();
+      QList<QByteArray> paramCopy2 = paramCopy1;
+
+      QByteArray lastPart = params.last();
+      QByteArray splitter(" .,-");
+      int maxSplitPos = params.last().count() - overrun;
+      int splitPos = -1;
+      for(int i = 0; i < splitter.size(); i++) {
+       splitPos = qMax(splitPos, lastPart.lastIndexOf(splitter[i], maxSplitPos));
+      }
+      if(splitPos <= 0) {
+       splitPos = maxSplitPos;
+      }
+      
+      paramCopy1 << lastPart.left(splitPos);
+      paramCopy2 << lastPart.mid(splitPos);
+      putCmd(cmd, paramCopy1, prefix);
+      putCmd(cmd, paramCopy2, prefix);
+      return;
+    }
+  }
+     
   if(!prefix.isEmpty())
     msg += ":" + prefix + " ";
   msg += cmd.toUpper().toAscii();
 
   for(int i = 0; i < params.size() - 1; i++) {
-    msg += " " + params[i].toByteArray();
+    msg += " " + params[i];
   }
   if(!params.isEmpty())
-    msg += " :" + params.last().toByteArray();
+    msg += " :" + params.last();
 
   putRawLine(msg);
 }
 
-void NetworkConnection::sendWho() {
-  foreach(QString chan, network()->channels()) {
+void NetworkConnection::sendPing() {
+  userInputHandler()->handlePing(BufferInfo(), QString());
+}
+
+void NetworkConnection::sendAutoWho() {
+  while(!_autoWhoQueue.isEmpty()) {
+    QString chan = _autoWhoQueue.takeFirst();
+    IrcChannel *ircchan = network()->ircChannel(chan);
+    if(!ircchan) continue;
+    if(_autoWhoNickLimit > 0 && ircchan->ircUsers().count() > _autoWhoNickLimit) continue;
+    _autoWhoInProgress[chan]++;
     putRawLine("WHO " + serverEncode(chan));
+    if(_autoWhoQueue.isEmpty() && _autoWhoEnabled && !_autoWhoCycleTimer.isActive()) {
+      // Timer was stopped, means a new cycle is due immediately
+      _autoWhoCycleTimer.start();
+      startAutoWhoCycle();
+    }
+    break;
+  }
+}
+
+void NetworkConnection::startAutoWhoCycle() {
+  if(!_autoWhoQueue.isEmpty()) {
+    _autoWhoCycleTimer.stop();
+    return;
   }
+  _autoWhoQueue = network()->channels();
+}
+
+bool NetworkConnection::setAutoWhoDone(const QString &channel) {
+  if(_autoWhoInProgress.value(channel.toLower(), 0) <= 0) return false;
+  _autoWhoInProgress[channel.toLower()]--;
+  return true;
 }
 
 void NetworkConnection::setChannelJoined(const QString &channel) {
   emit channelJoined(networkId(), channel, _channelKeys[channel.toLower()]);
+  _autoWhoQueue.prepend(channel.toLower()); // prepend so this new chan is the first to be checked
 }
 
 void NetworkConnection::setChannelParted(const QString &channel) {
   removeChannelKey(channel);
+  _autoWhoQueue.removeAll(channel.toLower());
+  _autoWhoInProgress.remove(channel.toLower());
   emit channelParted(networkId(), channel);
 }