src/common/signalproxy.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
  21 #include "signalproxy.h"
  22
  23 #include <QObject>
  24 #include <QIODevice>
  25 #include <QAbstractSocket>
  26 #include <QHostAddress>
  27 #include <QHash>
  28 #include <QMultiHash>
  29 #include <QList>
  30 #include <QSet>
  31 #include <QDebug>
  32 #include <QMetaMethod>
  33 #include <QMetaProperty>
  34 #include <QRegExp>
  35 #include <QThread>
  36 #include <QTime>
  37
  38 #include "syncableobject.h"
  39 #include "util.h"
  40
  41 class SignalRelay: public QObject {
  42
  43 /* Q_OBJECT is not necessary or even allowed, because we implement
  44    qt_metacall ourselves (and don't use any other features of the meta
  45    object system)
  46 */
  47 public:
  48   SignalRelay(SignalProxy* parent, QObject* source);
  49   int qt_metacall(QMetaObject::Call _c, int _id, void **_a);
  50
  51   void attachSignal(int methodId, const QByteArray &func);
  52
  53   void setSynchronize(bool);
  54   bool synchronize() const;
  55
  56   int sigCount() const;
  57
  58 private:
  59   bool isSyncMethod(int i);
  60
  61   SignalProxy* proxy;
  62   QObject* caller;
  63   QMultiHash<int, QByteArray> sigNames;
  64   bool _sync;
  65 };
  66
  67 SignalRelay::SignalRelay(SignalProxy* parent, QObject* source)
  68   : QObject(parent),
  69     proxy(parent),
  70     caller(source),
  71     _sync(false)
  72 {
  73   QObject::connect(source, SIGNAL(destroyed()), parent, SLOT(detachSender()));
  74 }
  75
  76 int SignalRelay::qt_metacall(QMetaObject::Call _c, int _id, void **_a) {
  77   _id = QObject::qt_metacall(_c, _id, _a);
  78   if(_id < 0)
  79     return _id;
  80   if(_c == QMetaObject::InvokeMetaMethod) {
  81     if(sigNames.contains(_id) || synchronize()) {
  82       const QList<int> &argTypes = proxy->argTypes(caller, _id);
  83       QVariantList params;
  84       int n = argTypes.size();
  85       for(int i=0; i<n; i++) {
  86         if(argTypes[i] == 0) {
  87           qWarning() << "SignalRelay::qt_metacall(): received invalid data for argument number" << i << "of signal" << QString("%1::%2").arg(caller->metaObject()->className()).arg(caller->metaObject()->method(_id).signature());
  88           qWarning() << "                            - make sure all your data types are known by the Qt MetaSystem";
  89           return _id;
  90         }
  91         params.append(QVariant(argTypes[i], _a[i+1]));
  92       }
  93       QMultiHash<int, QByteArray>::const_iterator funcIter = sigNames.constFind(_id);
  94       while(funcIter != sigNames.constEnd() && funcIter.key() == _id) {
  95         proxy->dispatchSignal(SignalProxy::RpcCall, QVariantList() << funcIter.value() << params);
  96         funcIter++;
  97       }
  98
  99       // dispatch Sync Signal if necessary
 100       QByteArray signature(caller->metaObject()->method(_id).signature());
 101       SyncableObject *syncObject = qobject_cast<SyncableObject *>(caller);
 102       if(synchronize() && proxy->syncMap(syncObject).contains(signature)) {
 103          //qDebug() << "__SYNC__ >>>"
 104          //      << caller->metaObject()->className()
 105          //      << caller->objectName()
 106          //      << signature
 107          //      << params;
 108         // params.prepend(QVariant(_id));
 109         params.prepend(signature);
 110         params.prepend(syncObject->objectName());
 111         params.prepend(syncObject->syncMetaObject()->className());
 112         proxy->dispatchSignal(SignalProxy::Sync, params);
 113       }
 114     }
 115     _id -= QObject::staticMetaObject.methodCount();
 116   }
 117   return _id;
 118 }
 119
 120 void SignalRelay::setSynchronize(bool sync) {
 121   SyncableObject *syncObject = qobject_cast<SyncableObject *>(caller);
 122   if(!syncObject)
 123     return;
 124
 125   const QMetaObject *meta = syncObject->syncMetaObject();
 126   if(!_sync && sync) {
 127     // enable Sync
 128     for(int i = 0; i < meta->methodCount(); i++ ) {
 129       if(isSyncMethod(i))
 130         QMetaObject::connect(caller, i, this, QObject::staticMetaObject.methodCount() + i);
 131     }
 132   } else if (_sync && !sync) {
 133     // disable Sync
 134     for(int i = 0; i < meta->methodCount(); i++ ) {
 135       if(isSyncMethod(i))
 136         QMetaObject::disconnect(caller, i, this, QObject::staticMetaObject.methodCount() + i);
 137     }
 138   }
 139   _sync = sync;
 140 }
 141
 142 bool SignalRelay::isSyncMethod(int i) {
 143   SyncableObject *syncObject = qobject_cast<SyncableObject *>(caller);
 144   if(!syncObject)
 145     return false;
 146
 147   QByteArray signature = syncObject->syncMetaObject()->method(i).signature();
 148   if(!proxy->syncMap(syncObject).contains(signature))
 149     return false;
 150
 151   if(proxy->proxyMode() == SignalProxy::Server && !signature.contains("Requested"))
 152     return true;
 153
 154   if(proxy->proxyMode() == SignalProxy::Client && signature.contains("Requested"))
 155     return true;
 156
 157   return false;
 158 }
 159
 160 bool SignalRelay::synchronize() const {
 161   return _sync;
 162 }
 163
 164 int SignalRelay::sigCount() const {
 165   // only for debuging purpose
 166   return sigNames.count();
 167 }
 168
 169 void SignalRelay::attachSignal(int methodId, const QByteArray &func) {
 170   // we ride without safetybelts here... all checking for valid method etc pp has to be done by the caller
 171   // all connected methodIds are offset by the standard methodCount of QObject
 172   if(!sigNames.contains(methodId))
 173     QMetaObject::connect(caller, methodId, this, QObject::staticMetaObject.methodCount() + methodId);
 174
 175   QByteArray fn;
 176   if(!func.isEmpty()) {
 177     fn = QMetaObject::normalizedSignature(func);
 178   } else {
 179     fn = QByteArray("2") + caller->metaObject()->method(methodId).signature();
 180   }
 181   sigNames.insert(methodId, fn);
 182 }
 183 // ====================
 184 //  /SIGNALRELAY
 185 // ====================
 186
 187
 188 // ====================
 189 //  SignalProxy
 190 // ====================
 191 SignalProxy::SignalProxy(QObject* parent)
 192   : QObject(parent)
 193 {
 194   setProxyMode(Client);
 195   init();
 196 }
 197
 198 SignalProxy::SignalProxy(ProxyMode mode, QObject* parent)
 199   : QObject(parent)
 200 {
 201   setProxyMode(mode);
 202   init();
 203 }
 204
 205 SignalProxy::SignalProxy(ProxyMode mode, QIODevice* device, QObject* parent)
 206   : QObject(parent)
 207 {
 208   setProxyMode(mode);
 209   addPeer(device);
 210   init();
 211 }
 212
 213 SignalProxy::~SignalProxy() {
 214   QList<QObject*> senders = _relayHash.keys();
 215   foreach(QObject* sender, senders)
 216     detachObject(sender);
 217
 218   // close peer connections
 219   foreach(QIODevice *device, _peers.keys()) {
 220     device->close();
 221     delete device;
 222   }
 223 }
 224
 225 void SignalProxy::setProxyMode(ProxyMode mode) {
 226   foreach(QIODevice* peer, _peers.keys()) {
 227     if(peer->isOpen()) {
 228       qWarning() << "SignalProxy: Cannot change proxy mode while connected";
 229       return;
 230     }
 231   }
 232   _proxyMode = mode;
 233   if(mode == Server)
 234     initServer();
 235   else
 236     initClient();
 237 }
 238
 239 void SignalProxy::init() {
 240   connect(&_heartBeatTimer, SIGNAL(timeout()), this, SLOT(sendHeartBeat()));
 241   _heartBeatTimer.start(30 * 1000);
 242 }
 243
 244 void SignalProxy::initServer() {
 245 }
 246
 247 void SignalProxy::initClient() {
 248   attachSlot("__objectRenamed__", this, SLOT(objectRenamed(QByteArray, QString, QString)));
 249 }
 250
 251 bool SignalProxy::addPeer(QIODevice* iodev) {
 252   if(!iodev)
 253     return false;
 254
 255   if(_peers.contains(iodev))
 256     return true;
 257
 258   if(proxyMode() == Client && !_peers.isEmpty()) {
 259     qWarning("SignalProxy: only one peer allowed in client mode!");
 260     return false;
 261   }
 262
 263   if(!iodev->isOpen())
 264     qWarning("SignalProxy::the device you passed is not open!");
 265
 266   connect(iodev, SIGNAL(disconnected()), this, SLOT(removePeerBySender()));
 267   connect(iodev, SIGNAL(readyRead()), this, SLOT(dataAvailable()));
 268
 269   QAbstractSocket* sock  = qobject_cast<QAbstractSocket*>(iodev);
 270   if(sock) {
 271     connect(sock, SIGNAL(disconnected()), this, SLOT(removePeerBySender()));
 272   }
 273
 274   _peers[iodev] = peerInfo();
 275   if(iodev->property("UseCompression").toBool())
 276     _peers[iodev].usesCompression = true;
 277
 278   if(_peers.count() == 1)
 279     emit connected();
 280
 281   return true;
 282 }
 283
 284 void SignalProxy::removePeer(QIODevice* iodev) {
 285   if(_peers.isEmpty()) {
 286     qWarning() << "SignalProxy::removePeer(): No peers in use!";
 287     return;
 288   }
 289
 290   if(proxyMode() == Server && !iodev) {
 291     // disconnect all
 292     QList<QIODevice *> peers = _peers.keys();
 293     foreach(QIODevice *peer, peers)
 294       removePeer(peer);
 295   }
 296
 297   if(proxyMode() != Server && !iodev)
 298     iodev = _peers.keys().first();
 299
 300   Q_ASSERT(iodev);
 301
 302   if(!_peers.contains(iodev)) {
 303     qWarning() << "SignalProxy: unknown QIODevice" << iodev;
 304     return;
 305   }
 306
 307   _peers.remove(iodev);
 308
 309   disconnect(iodev, 0, this, 0);
 310   emit peerRemoved(iodev);
 311
 312   if(_peers.isEmpty())
 313     emit disconnected();
 314 }
 315
 316 void SignalProxy::removePeerBySender() {
 317   // OK we're brutal here... but since it's a private slot we know what we've got connected to it...
 318   // this Slot is not triggered by destroyed, so the object is still alive and can be used!
 319   QIODevice *ioDev = (QIODevice *)(sender());
 320   removePeer(ioDev);
 321 }
 322
 323 void SignalProxy::objectRenamed(const QString &newname, const QString &oldname) {
 324   SyncableObject *syncObject = qobject_cast<SyncableObject *>(sender());
 325   const QMetaObject *meta = syncObject->metaObject();
 326   const QByteArray className(meta->className());
 327   objectRenamed(className, newname, oldname);
 328
 329   if(proxyMode() == Client)
 330     return;
 331
 332   QVariantList params;
 333   params << "__objectRenamed__" << className << newname << oldname;
 334   dispatchSignal(RpcCall, params);
 335 }
 336
 337 void SignalProxy::objectRenamed(const QByteArray &classname, const QString &newname, const QString &oldname) {
 338   if(_syncSlave.contains(classname) && _syncSlave[classname].contains(oldname) && oldname != newname) {
 339     SyncableObject *obj = _syncSlave[classname][newname] = _syncSlave[classname].take(oldname);
 340     requestInit(obj);
 341   }
 342 }
 343
 344 void SignalProxy::setArgTypes(QObject* obj, int methodId) {
 345   const QMetaObject *meta = metaObject(obj);
 346   QList<QByteArray> p = meta->method(methodId).parameterTypes();
 347   QList<int> argTypes;
 348   int ct = p.count();
 349   for(int i=0; i<ct; i++)
 350     argTypes.append(QMetaType::type(p.value(i)));
 351
 352   Q_ASSERT(!_classInfo[meta]->argTypes.contains(methodId));
 353   _classInfo[meta]->argTypes[methodId] = argTypes;
 354 }
 355
 356 const QList<int> &SignalProxy::argTypes(QObject *obj, int methodId) {
 357   const QMetaObject *meta = metaObject(obj);
 358   Q_ASSERT(_classInfo.contains(meta));
 359   if(!_classInfo[meta]->argTypes.contains(methodId))
 360     setArgTypes(obj, methodId);
 361   return _classInfo[meta]->argTypes[methodId];
 362 }
 363
 364 void SignalProxy::setReturnType(QObject *obj, int methodId) {
 365   const QMetaObject *meta = metaObject(obj);
 366   int returnType = QMetaType::type(meta->method(methodId).typeName());
 367
 368   Q_ASSERT(!_classInfo[meta]->returnType.contains(methodId));
 369   _classInfo[meta]->returnType[methodId] = returnType;
 370 }
 371
 372 const int &SignalProxy::returnType(QObject *obj, int methodId) {
 373   const QMetaObject *meta = metaObject(obj);
 374   Q_ASSERT(_classInfo.contains(meta));
 375   if(!_classInfo[meta]->returnType.contains(methodId))
 376     setReturnType(obj, methodId);
 377   return _classInfo[meta]->returnType[methodId];
 378 }
 379
 380 void SignalProxy::setMinArgCount(QObject *obj, int methodId) {
 381   const QMetaObject *meta = metaObject(obj);
 382   QString signature(meta->method(methodId).signature());
 383   int minCount = meta->method(methodId).parameterTypes().count() - signature.count("=");
 384   Q_ASSERT(!_classInfo[meta]->minArgCount.contains(methodId));
 385   _classInfo[meta]->minArgCount[methodId] = minCount;
 386 }
 387
 388 const int &SignalProxy::minArgCount(QObject *obj, int methodId) {
 389   const QMetaObject *meta = metaObject(obj);
 390   Q_ASSERT(_classInfo.contains(meta));
 391   if(!_classInfo[meta]->minArgCount.contains(methodId))
 392     setMinArgCount(obj, methodId);
 393   return _classInfo[meta]->minArgCount[methodId];
 394 }
 395
 396 void SignalProxy::setMethodName(QObject *obj, int methodId) {
 397   const QMetaObject *meta = metaObject(obj);
 398   QByteArray method(::methodName(meta->method(methodId)));
 399   Q_ASSERT(!_classInfo[meta]->methodNames.contains(methodId));
 400   _classInfo[meta]->methodNames[methodId] = method;
 401 }
 402
 403 const QByteArray &SignalProxy::methodName(QObject *obj, int methodId) {
 404   const QMetaObject *meta = metaObject(obj);
 405   Q_ASSERT(_classInfo.contains(meta));
 406   if(!_classInfo[meta]->methodNames.contains(methodId))
 407     setMethodName(obj, methodId);
 408   return _classInfo[meta]->methodNames[methodId];
 409 }
 410
 411
 412 void SignalProxy::setSyncMap(SyncableObject *obj) {
 413   const QMetaObject *meta = obj->syncMetaObject();
 414   QHash<QByteArray, int> syncMap;
 415
 416   QList<int> slotIndexes;
 417   for(int i = 0; i < meta->methodCount(); i++) {
 418     if(meta->method(i).methodType() == QMetaMethod::Slot)
 419       slotIndexes << i;
 420   }
 421
 422   // we're faking sync pairs for sync replies
 423   QByteArray slotSignature;
 424   foreach(int slotIdx, slotIndexes) {
 425     slotSignature = QByteArray(meta->method(slotIdx).signature());
 426     if(!slotSignature.startsWith("receive"))
 427       continue;
 428     syncMap[slotSignature] = slotIdx;
 429   }
 430
 431   QMetaMethod signal, slot;
 432   int matchIdx;
 433   for(int signalIdx = 0; signalIdx < meta->methodCount(); signalIdx++) {
 434     signal = meta->method(signalIdx);
 435     if(signal.methodType() != QMetaMethod::Signal)
 436       continue;
 437
 438     matchIdx = -1;
 439     foreach(int slotIdx, slotIndexes) {
 440       slot = meta->method(slotIdx);
 441       if(methodsMatch(signal, slot)) {
 442         matchIdx = slotIdx;
 443         break;
 444       }
 445     }
 446     if(matchIdx != -1) {
 447       slotIndexes.removeAt(slotIndexes.indexOf(matchIdx));
 448       syncMap[QByteArray(signal.signature())] = matchIdx;
 449     }
 450   }
 451
 452   Q_ASSERT(_classInfo[meta]->syncMap.isEmpty());
 453   _classInfo[meta]->syncMap = syncMap;
 454 }
 455
 456 const QHash<QByteArray,int> &SignalProxy::syncMap(SyncableObject *obj) {
 457   const QMetaObject *meta = obj->syncMetaObject();
 458   Q_ASSERT(_classInfo.contains(meta));
 459   if(_classInfo[meta]->syncMap.isEmpty())
 460     setSyncMap(obj);
 461   return _classInfo[meta]->syncMap;
 462 }
 463
 464 void SignalProxy::setReceiveMap(SyncableObject *obj) {
 465   const QMetaObject *meta = obj->syncMetaObject();
 466   Q_ASSERT(_classInfo.contains(meta));
 467
 468   QHash<int, int> receiveMap;
 469
 470   QMetaMethod requestSlot;
 471   QByteArray returnTypeName;
 472   QByteArray signature;
 473   QByteArray methodName;
 474   QByteArray params;
 475   int paramsPos;
 476   int receiverId;
 477   const int methodCount = meta->methodCount();
 478   for(int i = 0; i < methodCount; i++) {
 479     requestSlot = meta->method(i);
 480     if(requestSlot.methodType() != QMetaMethod::Slot)
 481       continue;
 482
 483     returnTypeName = requestSlot.typeName();
 484     if(QMetaType::Void == (QMetaType::Type)returnType(obj, i))
 485       continue;
 486
 487     signature = QByteArray(requestSlot.signature());
 488     if(!signature.startsWith("request"))
 489       continue;
 490
 491     paramsPos = signature.indexOf('(');
 492     if(paramsPos == -1)
 493       continue;
 494
 495     methodName = signature.left(paramsPos);
 496     params = signature.mid(paramsPos);
 497
 498     methodName = methodName.replace("request", "receive");
 499     params = params.left(params.count() - 1) + ", " + returnTypeName + ")";
 500
 501     signature = QMetaObject::normalizedSignature(methodName + params);
 502     receiverId = meta->indexOfSlot(signature);
 503
 504     if(receiverId == -1) {
 505       signature = QMetaObject::normalizedSignature(methodName + "(" + returnTypeName + ")");
 506       receiverId = meta->indexOfSlot(signature);
 507     }
 508
 509     if(receiverId != -1)
 510       receiveMap[i] = receiverId;
 511   }
 512   _classInfo[meta]->receiveMap = receiveMap;
 513 }
 514
 515 const QHash<int, int> &SignalProxy::receiveMap(SyncableObject *obj) {
 516   const QMetaObject *meta = obj->syncMetaObject();
 517   Q_ASSERT(_classInfo.contains(meta));
 518   if(_classInfo[meta]->receiveMap.isEmpty())
 519     setReceiveMap(obj);
 520   return _classInfo[meta]->receiveMap;
 521 }
 522
 523 void SignalProxy::setUpdatedRemotelyId(SyncableObject *obj) {
 524   const QMetaObject *meta = obj->syncMetaObject();
 525   Q_ASSERT(_classInfo.contains(meta));
 526   _classInfo[meta]->updatedRemotelyId = meta->indexOfSignal("updatedRemotely()");
 527 }
 528
 529 int SignalProxy::updatedRemotelyId(SyncableObject *obj) {
 530   Q_ASSERT(_classInfo.contains(obj->syncMetaObject()));
 531   return _classInfo[obj->syncMetaObject()]->updatedRemotelyId;
 532 }
 533
 534 const QMetaObject *SignalProxy::metaObject(QObject *obj) {
 535   if(SyncableObject *syncObject = qobject_cast<SyncableObject *>(obj))
 536     return syncObject->syncMetaObject();
 537   else
 538     return obj->metaObject();
 539 }
 540
 541 void SignalProxy::createClassInfo(QObject *obj) {
 542   const QMetaObject *meta = metaObject(obj);
 543   if(_classInfo.contains(meta))
 544     return;
 545
 546   ClassInfo *classInfo = new ClassInfo();
 547   _classInfo[meta] = classInfo;
 548 }
 549
 550 bool SignalProxy::attachSignal(QObject* sender, const char* signal, const QByteArray& sigName) {
 551   const QMetaObject* meta = metaObject(sender);
 552   QByteArray sig(meta->normalizedSignature(signal).mid(1));
 553   int methodId = meta->indexOfMethod(sig.constData());
 554   if(methodId == -1 || meta->method(methodId).methodType() != QMetaMethod::Signal) {
 555     qWarning() << "SignalProxy::attachSignal(): No such signal" << signal;
 556     return false;
 557   }
 558
 559   createClassInfo(sender);
 560
 561   SignalRelay* relay;
 562   if(_relayHash.contains(sender))
 563     relay = _relayHash[sender];
 564   else
 565     relay = _relayHash[sender] = new SignalRelay(this, sender);
 566
 567   relay->attachSignal(methodId, sigName);
 568
 569   return true;
 570 }
 571
 572
 573 bool SignalProxy::attachSlot(const QByteArray& sigName, QObject* recv, const char* slot) {
 574   const QMetaObject* meta = recv->metaObject();
 575   int methodId = meta->indexOfMethod(meta->normalizedSignature(slot).mid(1));
 576   if(methodId == -1 || meta->method(methodId).methodType() == QMetaMethod::Method) {
 577     qWarning() << "SignalProxy::attachSlot(): No such slot" << slot;
 578     return false;
 579   }
 580
 581   createClassInfo(recv);
 582
 583   QByteArray funcName = QMetaObject::normalizedSignature(sigName.constData());
 584   _attachedSlots.insert(funcName, qMakePair(recv, methodId));
 585
 586   QObject::disconnect(recv, SIGNAL(destroyed()), this, SLOT(detachSender()));
 587   QObject::connect(recv, SIGNAL(destroyed()), this, SLOT(detachSender()));
 588   return true;
 589 }
 590
 591 void SignalProxy::synchronize(SyncableObject *obj) {
 592   createClassInfo(obj);
 593   setUpdatedRemotelyId(obj);
 594
 595   // attaching all the Signals
 596   SignalRelay* relay;
 597   if(_relayHash.contains(obj))
 598     relay = _relayHash[obj];
 599   else
 600     relay = _relayHash[obj] = new SignalRelay(this, obj);
 601
 602   relay->setSynchronize(true);
 603
 604   // attaching as slave to receive sync Calls
 605   QByteArray className(obj->syncMetaObject()->className());
 606   _syncSlave[className][obj->objectName()] = obj;
 607
 608   if(proxyMode() == Server) {
 609     connect(obj, SIGNAL(objectRenamed(QString, QString)), this, SLOT(objectRenamed(QString, QString)));
 610     obj->setInitialized();
 611     emit objectInitialized(obj);
 612   } else {
 613     if(obj->isInitialized())
 614       emit objectInitialized(obj);
 615     else
 616       requestInit(obj);
 617   }
 618 }
 619
 620 void SignalProxy::requestInit(SyncableObject *obj) {
 621   if(proxyMode() == Server || obj->isInitialized())
 622     return;
 623
 624   QVariantList params;
 625   params << obj->syncMetaObject()->className()
 626          << obj->objectName();
 627   dispatchSignal(InitRequest, params);
 628 }
 629
 630 void SignalProxy::detachSender() {
 631   detachObject(sender());
 632 }
 633
 634 void SignalProxy::detachObject(QObject* obj) {
 635   detachSignals(obj);
 636   detachSlots(obj);
 637   stopSync(static_cast<SyncableObject *>(obj));
 638 }
 639
 640 void SignalProxy::detachSignals(QObject* sender) {
 641   if(!_relayHash.contains(sender))
 642     return;
 643   _relayHash.take(sender)->deleteLater();
 644 }
 645
 646 void SignalProxy::detachSlots(QObject* receiver) {
 647   SlotHash::iterator slotIter = _attachedSlots.begin();
 648   while(slotIter != _attachedSlots.end()) {
 649     if(slotIter.value().first == receiver) {
 650       slotIter = _attachedSlots.erase(slotIter);
 651     } else
 652       slotIter++;
 653   }
 654 }
 655
 656 void SignalProxy::stopSync(SyncableObject* obj) {
 657   if(_relayHash.contains(obj))
 658     _relayHash[obj]->setSynchronize(false);
 659
 660   // we can't use a className here, since it might be effed up, if we receive the call as a result of a decon
 661   // gladly the objectName() is still valid. So we have only to iterate over the classes not each instance! *sigh*
 662   QHash<QByteArray, ObjectId>::iterator classIter = _syncSlave.begin();
 663   while(classIter != _syncSlave.end()) {
 664     if(classIter->contains(obj->objectName()) && classIter.value()[obj->objectName()] == obj) {
 665       classIter->remove(obj->objectName());
 666       break;
 667     }
 668     classIter++;
 669   }
 670 }
 671
 672 void SignalProxy::dispatchSignal(QIODevice *receiver, const RequestType &requestType, const QVariantList &params) {
 673   Q_ASSERT(_peers.contains(receiver));
 674   QVariantList packedFunc;
 675   packedFunc << (qint16)requestType;
 676   packedFunc << params;
 677   writeDataToDevice(receiver, QVariant(packedFunc), _peers[receiver].usesCompression);
 678 }
 679
 680 void SignalProxy::dispatchSignal(const RequestType &requestType, const QVariantList &params) {
 681   // yes I know we have a little code duplication here... it's for the sake of performance
 682   QVariantList packedFunc;
 683   packedFunc << (qint16)requestType;
 684   packedFunc << params;
 685   foreach(QIODevice* dev, _peers.keys()) {
 686     Q_ASSERT(_peers.contains(dev));
 687     writeDataToDevice(dev, QVariant(packedFunc), _peers[dev].usesCompression);
 688   }
 689 }
 690
 691 void SignalProxy::receivePeerSignal(QIODevice *sender, const QVariant &packedFunc) {
 692   QVariantList params(packedFunc.toList());
 693
 694   if(params.isEmpty()) {
 695     qWarning() << "SignalProxy::receivePeerSignal(): received incompatible Data:" << packedFunc;
 696     return;
 697   }
 698
 699   int callType = params.takeFirst().value<int>();
 700
 701   switch(callType) {
 702   case RpcCall:
 703     if(params.empty())
 704       qWarning() << "SignalProxy::receivePeerSignal(): received empty RPC-Call";
 705     else
 706       handleSignal(params.takeFirst().toByteArray(), params);
 707     break;
 708
 709   case Sync:
 710     handleSync(sender, params);
 711     break;
 712
 713   case InitRequest:
 714     handleInitRequest(sender, params);
 715     break;
 716
 717   case InitData:
 718     handleInitData(sender, params);
 719     break;
 720
 721   case HeartBeat:
 722     receiveHeartBeat(sender, params);
 723     break;
 724
 725   case HeartBeatReply:
 726     receiveHeartBeatReply(sender, params);
 727     break;
 728
 729   default:
 730     qWarning() << "SignalProxy::receivePeerSignal(): received undefined CallType" << callType << params;
 731   }
 732 }
 733
 734 void SignalProxy::handleSync(QIODevice *sender, QVariantList params) {
 735   if(params.count() < 3) {
 736     qWarning() << "received invalid Sync call" << params;
 737     return;
 738   }
 739
 740   QByteArray className = params.takeFirst().toByteArray();
 741   QString objectName = params.takeFirst().toString();
 742   QByteArray signal = params.takeFirst().toByteArray();
 743
 744   if(!_syncSlave.contains(className) || !_syncSlave[className].contains(objectName)) {
 745     qWarning() << QString("no registered receiver for sync call: %1::%2 (objectName=\"%3\"). Params are:").arg(QString(className)).arg(QString(signal)).arg(objectName)
 746                << params;
 747     return;
 748   }
 749
 750   SyncableObject *receiver = _syncSlave[className][objectName];
 751   if(!syncMap(receiver).contains(signal)) {
 752     qWarning() << QString("no matching slot for sync call: %1::%2 (objectName=\"%3\"). Params are:").arg(QString(className)).arg(QString(signal)).arg(objectName)
 753                << params;
 754     return;
 755   }
 756
 757   int slotId = syncMap(receiver)[signal];
 758
 759   QVariant returnValue((QVariant::Type)returnType(receiver, slotId));
 760   if(!invokeSlot(receiver, slotId, params, returnValue)) {
 761     qWarning("SignalProxy::handleSync(): invokeMethod for \"%s\" failed ", methodName(receiver, slotId).constData());
 762     return;
 763   }
 764
 765   if(returnValue.type() != QVariant::Invalid && receiveMap(receiver).contains(slotId)) {
 766     int receiverId = receiveMap(receiver)[slotId];
 767     QVariantList returnParams;
 768     returnParams << className
 769                  << objectName
 770                  << QByteArray(receiver->metaObject()->method(receiverId).signature());
 771     if(argTypes(receiver, receiverId).count() > 1)
 772       returnParams << params;
 773     returnParams << returnValue;
 774     dispatchSignal(sender, Sync, returnParams);
 775   }
 776
 777   // send emit update signal
 778   invokeSlot(receiver, updatedRemotelyId(receiver));
 779 }
 780
 781 void SignalProxy::handleInitRequest(QIODevice *sender, const QVariantList &params) {
 782   if(params.count() != 2) {
 783     qWarning() << "SignalProxy::handleInitRequest() received initRequest with invalid param Count:"
 784                << params;
 785     return;
 786   }
 787
 788   QByteArray className(params[0].toByteArray());
 789   QString objectName(params[1].toString());
 790
 791   if(!_syncSlave.contains(className)) {
 792     qWarning() << "SignalProxy::handleInitRequest() received initRequest for unregistered Class:"
 793                << className;
 794     return;
 795   }
 796
 797   if(!_syncSlave[className].contains(objectName)) {
 798     qWarning() << "SignalProxy::handleInitRequest() received initRequest for unregistered Object:"
 799                << className << objectName;
 800     return;
 801   }
 802
 803   SyncableObject *obj = _syncSlave[className][objectName];
 804
 805   QVariantList params_;
 806   params_ << className
 807           << objectName
 808           << initData(obj);
 809
 810   dispatchSignal(sender, InitData, params_);
 811 }
 812
 813 void SignalProxy::handleInitData(QIODevice *sender, const QVariantList &params) {
 814   Q_UNUSED(sender)
 815   if(params.count() != 3) {
 816     qWarning() << "SignalProxy::handleInitData() received initData with invalid param Count:"
 817                << params;
 818     return;
 819   }
 820
 821   QByteArray className(params[0].toByteArray());
 822   QString objectName(params[1].toString());
 823   QVariantMap propertyMap(params[2].toMap());
 824
 825   if(!_syncSlave.contains(className)) {
 826     qWarning() << "SignalProxy::handleInitData() received initData for unregistered Class:"
 827                << className;
 828     return;
 829   }
 830
 831   if(!_syncSlave[className].contains(objectName)) {
 832     qWarning() << "SignalProxy::handleInitData() received initData for unregistered Object:"
 833                << className << objectName;
 834     return;
 835   }
 836
 837   SyncableObject *obj = _syncSlave[className][objectName];
 838   setInitData(obj, propertyMap);
 839 }
 840
 841 void SignalProxy::handleSignal(const QByteArray &funcName, const QVariantList &params) {
 842   QObject* receiver;
 843   int methodId;
 844   SlotHash::const_iterator slot = _attachedSlots.constFind(funcName);
 845   while(slot != _attachedSlots.constEnd() && slot.key() == funcName) {
 846     receiver = (*slot).first;
 847     methodId = (*slot).second;
 848     if(!invokeSlot(receiver, methodId, params))
 849       qWarning("SignalProxy::handleSignal(): invokeMethod for \"%s\" failed ", methodName(receiver, methodId).constData());
 850     slot++;
 851   }
 852 }
 853
 854 bool SignalProxy::invokeSlot(QObject *receiver, int methodId, const QVariantList &params, QVariant &returnValue) {
 855   const QList<int> args = argTypes(receiver, methodId);
 856   const int numArgs = params.count() < args.count()
 857     ? params.count()
 858     : args.count();
 859
 860   if(minArgCount(receiver, methodId) > params.count()) {
 861       qWarning() << "SignalProxy::invokeSlot(): not enough params to invoke" << methodName(receiver, methodId);
 862       return false;
 863   }
 864
 865   void *_a[] = {0,              // return type...
 866                 0, 0, 0, 0 , 0, // and 10 args - that's the max size qt can handle with signals and slots
 867                 0, 0, 0, 0 , 0};
 868
 869   // check for argument compatibility and build params array
 870   for(int i = 0; i < numArgs; i++) {
 871     if(!params[i].isValid()) {
 872       qWarning() << "SignalProxy::invokeSlot(): received invalid data for argument number" << i << "of method" << QString("%1::%2()").arg(receiver->metaObject()->className()).arg(receiver->metaObject()->method(methodId).signature());
 873       qWarning() << "                            - make sure all your data types are known by the Qt MetaSystem";
 874       return false;
 875     }
 876     if(args[i] != QMetaType::type(params[i].typeName())) {
 877       qWarning() << "SignalProxy::invokeSlot(): incompatible param types to invoke" << methodName(receiver, methodId);
 878       return false;
 879     }
 880     _a[i+1] = const_cast<void *>(params[i].constData());
 881   }
 882
 883   if(returnValue.type() != QVariant::Invalid)
 884     _a[0] = const_cast<void *>(returnValue.constData());
 885
 886   Qt::ConnectionType type = QThread::currentThread() == receiver->thread()
 887     ? Qt::DirectConnection
 888     : Qt::QueuedConnection;
 889
 890   if (type == Qt::DirectConnection) {
 891     return receiver->qt_metacall(QMetaObject::InvokeMetaMethod, methodId, _a) < 0;
 892   } else {
 893     qWarning() << "Queued Connections are not implemented yet";
 894     // note to self: qmetaobject.cpp:990 ff
 895     return false;
 896   }
 897
 898 }
 899
 900 bool SignalProxy::invokeSlot(QObject *receiver, int methodId, const QVariantList &params) {
 901   QVariant ret;
 902   return invokeSlot(receiver, methodId, params, ret);
 903 }
 904
 905 void SignalProxy::dataAvailable() {
 906   // yet again. it's a private slot. no need for checks.
 907   QIODevice* ioDev = qobject_cast<QIODevice* >(sender());
 908   Q_ASSERT(_peers.contains(ioDev));
 909   QVariant var;
 910   while(readDataFromDevice(ioDev, _peers[ioDev].byteCount, var, _peers[ioDev].usesCompression))
 911     receivePeerSignal(ioDev, var);
 912 }
 913
 914 void SignalProxy::writeDataToDevice(QIODevice *dev, const QVariant &item, bool compressed) {
 915   QAbstractSocket* sock  = qobject_cast<QAbstractSocket*>(dev);
 916   if(!dev->isOpen() || (sock && sock->state()!=QAbstractSocket::ConnectedState)) {
 917     qWarning("SignalProxy: Can't call write on a closed device");
 918     return;
 919   }
 920
 921   QByteArray block;
 922   QDataStream out(&block, QIODevice::WriteOnly);
 923   out.setVersion(QDataStream::Qt_4_2);
 924   out << (quint32)0;
 925
 926   if(compressed) {
 927     QByteArray rawItem;
 928     QDataStream itemStream(&rawItem, QIODevice::WriteOnly);
 929
 930     itemStream.setVersion(QDataStream::Qt_4_2);
 931     itemStream << item;
 932
 933     rawItem = qCompress(rawItem);
 934
 935     out << rawItem;
 936   } else {
 937     out << item;
 938   }
 939
 940   out.device()->seek(0);
 941   out << (quint32)(block.size() - sizeof(quint32));
 942
 943   dev->write(block);
 944 }
 945
 946 bool SignalProxy::readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVariant &item, bool compressed) {
 947   QDataStream in(dev);
 948   in.setVersion(QDataStream::Qt_4_2);
 949
 950   if(blockSize == 0) {
 951     if(dev->bytesAvailable() < (int)sizeof(quint32)) return false;
 952     in >> blockSize;
 953   }
 954
 955   if(blockSize > 1 << 22) {
 956     qWarning() << qPrintable(tr("Client tried to send package larger than max package size!"));
 957     QAbstractSocket *sock  = qobject_cast<QAbstractSocket *>(dev);
 958     qWarning() << qPrintable(tr("Disconnecting")) << (sock ? qPrintable(sock->peerAddress().toString()) : qPrintable(tr("local client")));
 959     dev->close();
 960     return false;
 961   }
 962
 963   if(dev->bytesAvailable() < blockSize)
 964     return false;
 965
 966   if(compressed) {
 967     QByteArray rawItem;
 968     in >> rawItem;
 969     rawItem = qUncompress(rawItem);
 970
 971     QDataStream itemStream(&rawItem, QIODevice::ReadOnly);
 972     itemStream.setVersion(QDataStream::Qt_4_2);
 973     itemStream >> item;
 974   } else {
 975     in >> item;
 976   }
 977
 978   blockSize = 0;
 979
 980   return true;
 981 }
 982
 983 bool SignalProxy::methodsMatch(const QMetaMethod &signal, const QMetaMethod &slot) const {
 984   // if we don't even have the same basename it's a sure NO
 985   if(methodBaseName(signal) != methodBaseName(slot))
 986     return false;
 987
 988   // are the signatures compatible?
 989   if(!QObject::staticMetaObject.checkConnectArgs(signal.signature(), slot.signature()))
 990     return false;
 991
 992   // we take an educated guess if the signals and slots match
 993   QString signalsuffix = ::methodName(signal).mid(QString(::methodName(signal)).lastIndexOf(QRegExp("[A-Z]"))).toLower();
 994   QString slotprefix = ::methodName(slot).left(QString(::methodName(slot)).indexOf(QRegExp("[A-Z]"))).toLower();
 995
 996   uint sizediff = qAbs(slotprefix.size() - signalsuffix.size());
 997   int ratio = editingDistance(slotprefix, signalsuffix) - sizediff;
 998   return (ratio < 2);
 999 }
1000
1001 QString SignalProxy::methodBaseName(const QMetaMethod &method) {
1002   QString methodname = QString(method.signature()).section("(", 0, 0);
1003
1004   // determine where we have to chop:
1005   int upperCharPos;
1006   if(method.methodType() == QMetaMethod::Slot) {
1007     // we take evertyhing from the first uppercase char if it's slot
1008     upperCharPos = methodname.indexOf(QRegExp("[A-Z]"));
1009     if(upperCharPos == -1)
1010       return QString();
1011     methodname = methodname.mid(upperCharPos);
1012   } else {
1013     // and if it's a signal we discard everything from the last uppercase char
1014     upperCharPos = methodname.lastIndexOf(QRegExp("[A-Z]"));
1015     if(upperCharPos == -1)
1016       return QString();
1017     methodname = methodname.left(upperCharPos);
1018   }
1019
1020   methodname[0] = methodname[0].toUpper();
1021
1022   return methodname;
1023 }
1024
1025 QVariantMap SignalProxy::initData(SyncableObject *obj) const {
1026   return obj->toVariantMap();
1027 }
1028
1029 void SignalProxy::setInitData(SyncableObject *obj, const QVariantMap &properties) {
1030   if(obj->isInitialized())
1031     return;
1032   obj->fromVariantMap(properties);
1033   obj->setInitialized();
1034   emit objectInitialized(obj);
1035   invokeSlot(obj, updatedRemotelyId(obj));
1036 }
1037
1038 void SignalProxy::sendHeartBeat() {
1039   dispatchSignal(SignalProxy::HeartBeat, QVariantList() << QTime::currentTime());
1040   QHash<QIODevice *, peerInfo>::iterator peerIter = _peers.begin();
1041   QHash<QIODevice *, peerInfo>::iterator peerIterEnd = _peers.end();
1042   while(peerIter != peerIterEnd) {
1043     if(peerIter->sentHeartBeats > 0) {
1044       updateLag(peerIter.key(), (float)_heartBeatTimer.interval());
1045     }
1046     if(peerIter->sentHeartBeats > 1) {
1047       QAbstractSocket *socket = qobject_cast<QAbstractSocket *>(peerIter.key());
1048       qWarning() << "SignalProxy: Disconnecting peer:"
1049                  << (socket ? qPrintable(socket->peerAddress().toString()) : "local client")
1050                  << "(didn't receive a heartbeat for over" << peerIter->sentHeartBeats * _heartBeatTimer.interval() / 1000 << "seconds)";
1051       peerIter.key()->close();
1052     } else {
1053       peerIter->sentHeartBeats++;
1054     }
1055     peerIter++;
1056   }
1057 }
1058
1059 void SignalProxy::receiveHeartBeat(QIODevice *dev, const QVariantList &params) {
1060   if(!_peers.contains(dev)) {
1061     qWarning() << "SignalProxy: received heart beat from unknown Device:" << dev;
1062   }
1063   dispatchSignal(dev, SignalProxy::HeartBeatReply, params);
1064 }
1065
1066 void SignalProxy::receiveHeartBeatReply(QIODevice *dev, const QVariantList &params) {
1067   if(!_peers.contains(dev)) {
1068     qWarning() << "SignalProxy: received heart beat reply from unknown Device:" << dev;
1069     return;
1070   }
1071
1072   _peers[dev].sentHeartBeats = 0;
1073
1074   if(params.isEmpty()) {
1075     qWarning() << "SignalProxy: received heart beat reply with less params then sent from:" << dev;
1076     return;
1077   }
1078
1079   QTime sendTime = params[0].value<QTime>();
1080   updateLag(dev, (float)sendTime.msecsTo(QTime::currentTime()) / 2);
1081 }
1082
1083 void SignalProxy::updateLag(QIODevice *dev, float lag) {
1084   Q_ASSERT(_peers.contains(dev));
1085   _peers[dev].lag = lag;
1086   if(proxyMode() == Client) {
1087     qDebug() << "LAG" << lag;
1088     emit lagUpdated(lag);
1089   }
1090 }
1091
1092
1093 void SignalProxy::dumpProxyStats() {
1094   QString mode;
1095   if(proxyMode() == Server)
1096     mode = "Server";
1097   else
1098     mode = "Client";
1099
1100   int sigCount = 0;
1101   foreach(SignalRelay *relay, _relayHash.values())
1102     sigCount += relay->sigCount();
1103
1104   int slaveCount = 0;
1105   foreach(ObjectId oid, _syncSlave.values())
1106     slaveCount += oid.count();
1107
1108   qDebug() << this;
1109   qDebug() << "              Proxy Mode:" << mode;
1110   qDebug() << "attached sending Objects:" << _relayHash.count();
1111   qDebug() << "       number of Signals:" << sigCount;
1112   qDebug() << "          attached Slots:" << _attachedSlots.count();
1113   qDebug() << " number of synced Slaves:" << slaveCount;
1114   qDebug() << "number of Classes cached:" << _classInfo.count();
1115 }
1116
1117 void SignalProxy::dumpSyncMap(SyncableObject *object) {
1118   const QMetaObject *meta = object->metaObject();
1119   qDebug() << "SignalProxy: SyncMap for Class" << meta->className();
1120
1121   QHash<QByteArray, int> syncMap_ = syncMap(object);
1122   QHash<QByteArray, int>::const_iterator iter = syncMap_.constBegin();
1123   while(iter != syncMap_.constEnd()) {
1124     qDebug() << iter.key() << "-->" << iter.value() << meta->method(iter.value()).signature();
1125     iter++;
1126   }
1127 //   QHash<int, int> syncMap_ = syncMap(object);
1128 //   QHash<int, int>::const_iterator iter = syncMap_.constBegin();
1129 //   while(iter != syncMap_.constEnd()) {
1130 //     qDebug() << iter.key() << meta->method(iter.key()).signature() << "-->" << iter.value() << meta->method(iter.value()).signature();
1131 //     iter++;
1132 //   }
1133 }