SignalProxy internal redesign.
[quassel.git] / src / common / signalproxy.cpp
index 22e71f1..1b05ab4 100644 (file)
@@ -23,6 +23,7 @@
 #include <QObject>
 #include <QIODevice>
 #include <QAbstractSocket>
+#include <QHostAddress>
 #include <QHash>
 #include <QMultiHash>
 #include <QList>
 #include <QMetaProperty>
 #include <QRegExp>
 #include <QThread>
+#include <QTime>
 
 #include "syncableobject.h"
 #include "util.h"
 
-class SignalRelay: public QObject {
 
+// ==================================================
+//  SIGNALRELAY
+// ==================================================
+class SignalRelay: public QObject {
 /* Q_OBJECT is not necessary or even allowed, because we implement
    qt_metacall ourselves (and don't use any other features of the meta
    object system)
@@ -178,24 +183,32 @@ void SignalRelay::attachSignal(int methodId, const QByteArray &func) {
   }
   sigNames.insert(methodId, fn);
 }
-// ====================
-// END SIGNALRELAY
-// ====================
 
+// ==================================================
+//  Peers
+// ==================================================
+void SignalProxy::IODevicePeer::dispatchSignal(const RequestType &requestType, const QVariantList &params) {
+  QVariantList packedFunc;
+  packedFunc << (qint16)requestType
+            << params;
+  dispatchPackedFunc(QVariant(packedFunc));
+}
 
-// ====================
+// ==================================================
 //  SignalProxy
-// ====================
+// ==================================================
 SignalProxy::SignalProxy(QObject* parent)
   : QObject(parent)
 {
   setProxyMode(Client);
+  init();
 }
 
 SignalProxy::SignalProxy(ProxyMode mode, QObject* parent)
   : QObject(parent)
 {
   setProxyMode(mode);
+  init();
 }
 
 SignalProxy::SignalProxy(ProxyMode mode, QIODevice* device, QObject* parent)
@@ -203,27 +216,32 @@ SignalProxy::SignalProxy(ProxyMode mode, QIODevice* device, QObject* parent)
 {
   setProxyMode(mode);
   addPeer(device);
+  init();
 } 
 
 SignalProxy::~SignalProxy() {
   QList<QObject*> senders = _relayHash.keys();
   foreach(QObject* sender, senders)
     detachObject(sender);
-
-  // close peer connections
-  foreach(QIODevice *device, _peerByteCount.keys()) {
-    device->close();
-    delete device;
-  }
 }
 
 void SignalProxy::setProxyMode(ProxyMode mode) {
-  foreach(QIODevice* peer, _peerByteCount.keys()) {
-    if(peer->isOpen()) {
-      qWarning() << "SignalProxy: Cannot change proxy mode while connected";
+  PeerHash::iterator peer = _peers.begin();
+  while(peer != _peers.end()) {
+    if((*peer)->type() != AbstractPeer::IODevicePeer) {
+      IODevicePeer *ioPeer = static_cast<IODevicePeer *>(*peer);
+      if(ioPeer->isOpen()) {
+       qWarning() << "SignalProxy: Cannot change proxy mode while connected";
+       return;
+      }
+    }
+    if((*peer)->type() != AbstractPeer::SignalProxyPeer) {
+      qWarning() << "SignalProxy: Cannot change proxy mode while connected to another internal SignalProxy";
       return;
     }
+    peer++;
   }
+
   _proxyMode = mode;
   if(mode == Server)
     initServer();
@@ -231,30 +249,26 @@ void SignalProxy::setProxyMode(ProxyMode mode) {
     initClient();
 }
 
-SignalProxy::ProxyMode SignalProxy::proxyMode() const {
-  return _proxyMode;
+void SignalProxy::init() {
+  connect(&_heartBeatTimer, SIGNAL(timeout()), this, SLOT(sendHeartBeat()));
+  _heartBeatTimer.start(30 * 1000);
 }
 
 void SignalProxy::initServer() {
-  disconnect(&_heartBeatTimer, 0, this, 0);
-  _heartBeatTimer.stop();
 }
 
 void SignalProxy::initClient() {
   attachSlot("__objectRenamed__", this, SLOT(objectRenamed(QByteArray, QString, QString)));
-  connect(&_heartBeatTimer, SIGNAL(timeout()),
-         this, SLOT(sendHeartBeat()));
-  _heartBeatTimer.start(60 * 1000); // msecs: one beep per minute
 }
 
 bool SignalProxy::addPeer(QIODevice* iodev) {
   if(!iodev)
     return false;
   
-  if(_peerByteCount.contains(iodev))
+  if(_peers.contains(iodev))
     return true;
 
-  if(proxyMode() == Client && !_peerByteCount.isEmpty()) {
+  if(proxyMode() == Client && !_peers.isEmpty()) {
     qWarning("SignalProxy: only one peer allowed in client mode!");
     return false;
   }
@@ -270,46 +284,71 @@ bool SignalProxy::addPeer(QIODevice* iodev) {
     connect(sock, SIGNAL(disconnected()), this, SLOT(removePeerBySender()));
   }
 
-  _peerByteCount[iodev] = 0;
+  // we take ownership of that device
+  iodev->setParent(this);
+
+  _peers[iodev] = new IODevicePeer(iodev, iodev->property("UseCompression").toBool());
 
-  if(_peerByteCount.count() == 1)
+  if(_peers.count() == 1)
     emit connected();
 
   return true;
 }
 
+void SignalProxy::removeAllPeers() {
+  Q_ASSERT(proxyMode() == Server || _peers.count() <= 1);
+  // wee need to copy that list since we modify it in the loop
+  QList<QObject *> peers = _peers.keys();
+  foreach(QObject *peer, peers) {
+    switch(_peers[peer]->type()) {
+    case AbstractPeer::IODevicePeer:
+      removePeer(static_cast<QIODevice *>(peer));
+      break;
+    case AbstractPeer::SignalProxyPeer:
+      removePeer(static_cast<SignalProxy *>(peer));
+      break;
+    default:
+      Q_ASSERT(false); // there shouldn't be any peers with wrong / unknown type
+    }
+  }
+}
+
 void SignalProxy::removePeer(QIODevice* iodev) {
-  if(_peerByteCount.isEmpty()) {
+  if(_peers.isEmpty()) {
     qWarning() << "SignalProxy::removePeer(): No peers in use!";
     return;
   }
 
-  if(proxyMode() == Server && !iodev) {
-    // disconnect all
-    QList<QIODevice *> peers = _peerByteCount.keys();
-    foreach(QIODevice *peer, peers)
-      removePeer(peer);
-  }
-
-  if(proxyMode() != Server && !iodev)
-    iodev = _peerByteCount.keys().first();
-
   Q_ASSERT(iodev);
-
-  if(!_peerByteCount.contains(iodev)) {
+  if(!_peers.contains(iodev)) {
     qWarning() << "SignalProxy: unknown QIODevice" << iodev;
     return;
   }
 
-  _peerByteCount.remove(iodev);
+  AbstractPeer *peer = _peers[iodev];
+  _peers.remove(iodev);  
+  delete peer;
 
   disconnect(iodev, 0, this, 0);
   emit peerRemoved(iodev);
 
-  if(_peerByteCount.isEmpty())
+  if(_peers.isEmpty())
+    emit disconnected();
+}
+
+void SignalProxy::removePeer(SignalProxy *proxy) {
+  if(!_peers.contains(proxy)) {
+    qWarning() << "SignalProxy: unknown QIODevice" << proxy;
+    return;
+  }
+
+  _peers.remove(proxy);
+
+  if(_peers.isEmpty())
     emit disconnected();
 }
 
+
 void SignalProxy::removePeerBySender() {
   // OK we're brutal here... but since it's a private slot we know what we've got connected to it...
   // this Slot is not triggered by destroyed, so the object is still alive and can be used!
@@ -604,23 +643,18 @@ void SignalProxy::synchronize(SyncableObject *obj) {
 
   if(proxyMode() == Server) {
     connect(obj, SIGNAL(objectRenamed(QString, QString)), this, SLOT(objectRenamed(QString, QString)));
-    setInitialized(obj);
+    obj->setInitialized();
+    emit objectInitialized(obj);
   } else {
-    requestInit(obj);
+    if(obj->isInitialized())
+      emit objectInitialized(obj);
+    else
+      requestInit(obj);
   }
 }
 
-void SignalProxy::setInitialized(SyncableObject *obj) {
-  obj->setInitialized();
-  emit objectInitialized(obj);
-}
-
-bool SignalProxy::isInitialized(SyncableObject *obj) const {
-  return obj->isInitialized();
-}
-
 void SignalProxy::requestInit(SyncableObject *obj) {
-  if(proxyMode() == Server || isInitialized(obj))
+  if(proxyMode() == Server || obj->isInitialized())
     return;
 
   QVariantList params;
@@ -671,55 +705,75 @@ void SignalProxy::stopSync(SyncableObject* obj) {
   }
 }
 
-void SignalProxy::dispatchSignal(QIODevice *receiver, const RequestType &requestType, const QVariantList &params) {
-  QVariantList packedFunc;
-  packedFunc << (qint16)requestType;
-  packedFunc << params;
-  writeDataToDevice(receiver, QVariant(packedFunc));
-}
-
 void SignalProxy::dispatchSignal(const RequestType &requestType, const QVariantList &params) {
-  // yes I know we have a little code duplication here... it's for the sake of performance
-  QVariantList packedFunc;
-  packedFunc << (qint16)requestType;
-  packedFunc << params;
-  foreach(QIODevice* dev, _peerByteCount.keys())
-    writeDataToDevice(dev, QVariant(packedFunc));
+  QVariant packedFunc(QVariantList() << (qint16)requestType << params);
+  PeerHash::iterator peer = _peers.begin();
+  while(peer != _peers.end()) {
+    switch((*peer)->type()) {
+    case AbstractPeer::IODevicePeer:
+      {
+       IODevicePeer *ioPeer = static_cast<IODevicePeer *>(*peer);
+       ioPeer->dispatchPackedFunc(packedFunc);
+      }
+      break;
+    case AbstractPeer::SignalProxyPeer:
+      (*peer)->dispatchSignal(requestType, params);
+      break;
+    default:
+      Q_ASSERT(false); // there shouldn't be any peers with wrong / unknown type
+    }
+    peer++;
+  }
 }
 
-void SignalProxy::receivePeerSignal(QIODevice *sender, const QVariant &packedFunc) {
+void SignalProxy::receivePackedFunc(AbstractPeer *sender, const QVariant &packedFunc) {
   QVariantList params(packedFunc.toList());
 
   if(params.isEmpty()) {
     qWarning() << "SignalProxy::receivePeerSignal(): received incompatible Data:" << packedFunc;
     return;
   }
-  
-  int callType = params.takeFirst().value<int>();
 
-  switch(callType) {
+  RequestType requestType = (RequestType)params.takeFirst().value<int>();
+  receivePeerSignal(sender, requestType, params);
+}
+  
+void SignalProxy::receivePeerSignal(AbstractPeer *sender, const RequestType &requestType, const QVariantList &params) {
+  switch(requestType) {
   case RpcCall:
-    if(params.empty()) {
+    if(params.empty())
       qWarning() << "SignalProxy::receivePeerSignal(): received empty RPC-Call";
-      return;
-    } else {
-      return handleSignal(params.takeFirst().toByteArray(), params);
-    }
+    else
+      handleSignal(params);
+      //handleSignal(params.takeFirst().toByteArray(), params);
+    break;
+
   case Sync:
-    return handleSync(sender, params);
+    handleSync(sender, params);
+    break;
+    
   case InitRequest:
-    return handleInitRequest(sender, params);
+    handleInitRequest(sender, params);
+    break;
+    
   case InitData:
-    return handleInitData(sender, params);
+    handleInitData(sender, params);
+    break;
+    
   case HeartBeat:
-    return;
+    receiveHeartBeat(sender, params);
+    break;
+
+  case HeartBeatReply:
+    receiveHeartBeatReply(sender, params);
+    break;
+
   default:
-    qWarning() << "SignalProxy::receivePeerSignal(): received undefined CallType" << callType << params;
-    return;
+    qWarning() << "SignalProxy::receivePeerSignal(): received undefined CallType" << requestType << params;
   }
 }
 
-void SignalProxy::handleSync(QIODevice *sender, QVariantList params) {
+void SignalProxy::handleSync(AbstractPeer *sender, QVariantList params) {
   if(params.count() < 3) {
     qWarning() << "received invalid Sync call" << params;
     return;
@@ -759,14 +813,14 @@ void SignalProxy::handleSync(QIODevice *sender, QVariantList params) {
     if(argTypes(receiver, receiverId).count() > 1)
       returnParams << params;
     returnParams << returnValue;
-    dispatchSignal(sender, Sync, returnParams);
+    sender->dispatchSignal(Sync, returnParams);
   }
   
   // send emit update signal
   invokeSlot(receiver, updatedRemotelyId(receiver));
 }
 
-void SignalProxy::handleInitRequest(QIODevice *sender, const QVariantList &params) {
+void SignalProxy::handleInitRequest(AbstractPeer *sender, const QVariantList &params) {
   if(params.count() != 2) {
     qWarning() << "SignalProxy::handleInitRequest() received initRequest with invalid param Count:"
               << params;
@@ -795,10 +849,10 @@ void SignalProxy::handleInitRequest(QIODevice *sender, const QVariantList &param
          << objectName
          << initData(obj);
 
-  dispatchSignal(sender, InitData, params_);
+  sender->dispatchSignal(InitData, params_);
 }
 
-void SignalProxy::handleInitData(QIODevice *sender, const QVariantList &params) {
+void SignalProxy::handleInitData(AbstractPeer *sender, const QVariantList &params) {
   Q_UNUSED(sender)
   if(params.count() != 3) {
     qWarning() << "SignalProxy::handleInitData() received initData with invalid param Count:"
@@ -826,7 +880,11 @@ void SignalProxy::handleInitData(QIODevice *sender, const QVariantList &params)
   setInitData(obj, propertyMap);
 }
 
-void SignalProxy::handleSignal(const QByteArray &funcName, const QVariantList &params) {
+//void SignalProxy::handleSignal(const QByteArray &funcName, const QVariantList &params) {
+void SignalProxy::handleSignal(const QVariantList &data) {
+  QVariantList params = data;
+  QByteArray funcName = params.takeFirst().toByteArray();
+
   QObject* receiver;
   int methodId;
   SlotHash::const_iterator slot = _attachedSlots.constFind(funcName);
@@ -893,27 +951,46 @@ bool SignalProxy::invokeSlot(QObject *receiver, int methodId, const QVariantList
 void SignalProxy::dataAvailable() {
   // yet again. it's a private slot. no need for checks.
   QIODevice* ioDev = qobject_cast<QIODevice* >(sender());
+  Q_ASSERT(_peers.contains(ioDev) && _peers[ioDev]->type() == AbstractPeer::IODevicePeer);
+  IODevicePeer *peer = static_cast<IODevicePeer *>(_peers[ioDev]);
   QVariant var;
-  while(readDataFromDevice(ioDev, _peerByteCount[ioDev], var))
-    receivePeerSignal(ioDev, var);
+  while(peer->readData(var))
+    receivePackedFunc(peer, var);
 }
 
-void SignalProxy::writeDataToDevice(QIODevice *dev, const QVariant &item) {
+void SignalProxy::writeDataToDevice(QIODevice *dev, const QVariant &item, bool compressed) {
   QAbstractSocket* sock  = qobject_cast<QAbstractSocket*>(dev);
   if(!dev->isOpen() || (sock && sock->state()!=QAbstractSocket::ConnectedState)) {
-    qWarning("SignalProxy: Can't call on a closed device");
+    qWarning("SignalProxy: Can't call write on a closed device");
     return;
   }
+
   QByteArray block;
   QDataStream out(&block, QIODevice::WriteOnly);
   out.setVersion(QDataStream::Qt_4_2);
-  out << (quint32)0 << item;
+  out << (quint32)0;
+  
+  if(compressed) {
+    QByteArray rawItem;
+    QDataStream itemStream(&rawItem, QIODevice::WriteOnly);
+
+    itemStream.setVersion(QDataStream::Qt_4_2);
+    itemStream << item;
+
+    rawItem = qCompress(rawItem);
+
+    out << rawItem;
+  } else {
+    out << item;
+  }
+
   out.device()->seek(0);
   out << (quint32)(block.size() - sizeof(quint32));
+
   dev->write(block);
 }
 
-bool SignalProxy::readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVariant &item) {
+bool SignalProxy::readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVariant &item, bool compressed) {
   QDataStream in(dev);
   in.setVersion(QDataStream::Qt_4_2);
 
@@ -922,10 +999,40 @@ bool SignalProxy::readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVarian
     in >> blockSize;
   }
 
+  if(blockSize > 1 << 22) {
+    qWarning() << qPrintable(tr("Client tried to send package larger than max package size!"));
+    QAbstractSocket *sock  = qobject_cast<QAbstractSocket *>(dev);
+    qWarning() << qPrintable(tr("Disconnecting")) << (sock ? qPrintable(sock->peerAddress().toString()) : qPrintable(tr("local client")));
+    dev->close();
+    return false;
+  }
+    
   if(dev->bytesAvailable() < blockSize)
     return false;
-  in >> item;
+
+  if(compressed) {
+    QByteArray rawItem;
+    in >> rawItem;
+    // debug check
+    int nbytes = rawItem.size();
+    if (nbytes <= 4) {
+      const char *data = rawItem.constData();
+      if (nbytes < 4 || (data[0]!=0 || data[1]!=0 || data[2]!=0 || data[3]!=0))
+       qWarning() << "receieved corrupted compressed data:"
+                  << blockSize << rawItem << rawItem.size() << dev;
+    }
+    // end
+    rawItem = qUncompress(rawItem);
+      
+    QDataStream itemStream(&rawItem, QIODevice::ReadOnly);
+    itemStream.setVersion(QDataStream::Qt_4_2);
+    itemStream >> item;
+  } else {
+    in >> item;
+  }
+
   blockSize = 0;
+
   return true;
 }
 
@@ -976,17 +1083,68 @@ QVariantMap SignalProxy::initData(SyncableObject *obj) const {
 }
 
 void SignalProxy::setInitData(SyncableObject *obj, const QVariantMap &properties) {
-  if(isInitialized(obj))
+  if(obj->isInitialized())
     return;
   obj->fromVariantMap(properties);
-  setInitialized(obj);
+  obj->setInitialized();
+  emit objectInitialized(obj);
   invokeSlot(obj, updatedRemotelyId(obj));
 }
 
 void SignalProxy::sendHeartBeat() {
-  dispatchSignal(SignalProxy::HeartBeat, QVariantList());
+  dispatchSignal(SignalProxy::HeartBeat, QVariantList() << QTime::currentTime());
+  PeerHash::iterator peer = _peers.begin();
+  while(peer != _peers.end()) {
+    if((*peer)->type() == AbstractPeer::IODevicePeer) {
+      IODevicePeer *ioPeer = static_cast<IODevicePeer *>(*peer);
+      if(ioPeer->sentHeartBeats > 0) {
+       updateLag(ioPeer, ioPeer->sentHeartBeats * _heartBeatTimer.interval());
+      }
+      if(ioPeer->sentHeartBeats > 1) {
+       //FIXME: proper disconnect.
+//     QAbstractSocket *socket = qobject_cast<QAbstractSocket *>(peerIter.key());
+//     qWarning() << "SignalProxy: Disconnecting peer:"
+//                << (socket ? qPrintable(socket->peerAddress().toString()) : "local client")
+//                << "(didn't receive a heartbeat for over" << peerIter->sentHeartBeats * _heartBeatTimer.interval() / 1000 << "seconds)";      
+//     peerIter.key()->close();
+      } else {
+       ioPeer->sentHeartBeats++;
+      }
+    }
+    peer++;
+  }
+}
+
+void SignalProxy::receiveHeartBeat(AbstractPeer *peer, const QVariantList &params) {
+  peer->dispatchSignal(SignalProxy::HeartBeatReply, params);
+}
+
+void SignalProxy::receiveHeartBeatReply(AbstractPeer *peer, const QVariantList &params) {
+  if(peer->type() != AbstractPeer::IODevicePeer) {
+    qWarning() << "SignalProxy::receiveHeartBeatReply: received heart beat from a non IODevicePeer!";
+    return;
+  }
+
+  IODevicePeer *ioPeer = static_cast<IODevicePeer *>(peer);
+  ioPeer->sentHeartBeats = 0;
+
+  if(params.isEmpty()) {
+    qWarning() << "SignalProxy: received heart beat reply with less params then sent from:" << ioPeer->device();
+    return;
+  }
+  
+  QTime sendTime = params[0].value<QTime>();
+  updateLag(ioPeer, sendTime.msecsTo(QTime::currentTime()) / 2);
+}
+
+void SignalProxy::updateLag(IODevicePeer *peer, int lag) {
+  peer->lag = lag;
+  if(proxyMode() == Client) {
+    emit lagUpdated(lag);
+  }
 }
 
+
 void SignalProxy::dumpProxyStats() {
   QString mode;
   if(proxyMode() == Server)