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