1 /****************************************************************************
3 ** Copyright (C) Qxt Foundation. Some rights reserved.
5 ** This file is part of the QxtNetwork module of the Qt eXTension library
7 ** This library is free software; you can redistribute it and/or modify it
8 ** under the terms of th Common Public License, version 1.0, as published by
11 ** This file is provided "AS IS", without WARRANTIES OR CONDITIONS OF ANY
12 ** KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY
13 ** WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR
14 ** FITNESS FOR A PARTICULAR PURPOSE.
16 ** You should have received a copy of the CPL along with this file.
17 ** See the LICENSE file and the cpl1.0.txt file included with the source
18 ** distribution for more information. If you did not receive a copy of the
19 ** license, contact the Qxt Foundation.
21 ** <http://libqxt.sourceforge.net> <foundation@libqxt.org>
23 ****************************************************************************/
25 #include "qxtrpcpeer.h"
31 #include <QMetaMethod>
33 #include "qxtmetaobject.h"
36 class QxtIntrospector: public QObject
38 // This class MANUALLY implements the necessary parts of QObject.
39 // Do NOT add the Q_OBJECT macro. As this class isn't intended
40 // for direct use, it doesn't offer any sort of useful meta-object.
42 QxtIntrospector(QxtRPCPeer* parent, QObject* source, const char* signal);
44 int qt_metacall(QMetaObject::Call _c, int _id, void **_a);
53 struct QxtRPCConnection
60 class QxtRPCPeerPrivate : public QxtPrivate<QxtRPCPeer>, public QTcpServer
63 QXT_DECLARE_PUBLIC(QxtRPCPeer);
65 void incomingConnection ( int socketDescriptor );
68 void receivePeerSignal(QString fn, QVariant p0 = QVariant(), QVariant p1 = QVariant(), QVariant p2 = QVariant(), QVariant p3 = QVariant(),
69 QVariant p4 = QVariant(), QVariant p5 = QVariant(), QVariant p6 = QVariant(), QVariant p7 = QVariant(), QVariant p8 = QVariant()) const;
70 void receiveClientSignal(quint64 id, QString fn, QVariant p0 = QVariant(), QVariant p1 = QVariant(), QVariant p2 = QVariant(), QVariant p3 = QVariant(),
71 QVariant p4 = QVariant(), QVariant p5 = QVariant(), QVariant p6 = QVariant(), QVariant p7 = QVariant()) const;
73 void processInput(QIODevice* socket, QByteArray& buffer);
75 // Object -> introspector for each signal
76 QMultiHash<QObject*, QxtIntrospector*> attachedSignals;
77 // RPC function -> (object, slot ID)
78 typedef QPair<QObject*, int> MethodID;
79 QHash<QString, QList<MethodID> > attachedSlots;
81 typedef QHash<QObject*, QxtRPCConnection*> ConnHash;
89 QStack<QTcpSocket*> pending_connections;
93 QxtRPCPeer::QxtRPCPeer(QObject* parent) : QObject(parent)
95 QXT_INIT_PRIVATE(QxtRPCPeer);
96 qxt_d().m_rpctype = Peer;
97 qxt_d().m_peer = new QTcpSocket(this);
98 QObject::connect(qxt_d().m_peer, SIGNAL(connected()), this, SIGNAL(peerConnected()));
99 QObject::connect(qxt_d().m_peer, SIGNAL(disconnected()), this, SIGNAL(peerDisconnected()));
100 QObject::connect(qxt_d().m_peer, SIGNAL(disconnected()), this, SLOT(disconnectSender()));
101 QObject::connect(qxt_d().m_peer, SIGNAL(readyRead()), this, SLOT(dataAvailable()));
102 QObject::connect(qxt_d().m_peer, SIGNAL(error(QAbstractSocket::SocketError)), this, SIGNAL(peerError(QAbstractSocket::SocketError)));
106 QxtRPCPeer::QxtRPCPeer(RPCTypes type, QObject* parent) : QObject(parent)
108 QXT_INIT_PRIVATE(QxtRPCPeer);
109 qxt_d().m_rpctype = type;
110 qxt_d().m_peer = new QTcpSocket(this);
111 QObject::connect(qxt_d().m_peer, SIGNAL(connected()), this, SIGNAL(peerConnected()));
112 QObject::connect(qxt_d().m_peer, SIGNAL(disconnected()), this, SIGNAL(peerDisconnected()));
113 QObject::connect(qxt_d().m_peer, SIGNAL(disconnected()), this, SLOT(disconnectSender()));
114 QObject::connect(qxt_d().m_peer, SIGNAL(readyRead()), this, SLOT(dataAvailable()));
115 QObject::connect(qxt_d().m_peer, SIGNAL(error(QAbstractSocket::SocketError)), this, SIGNAL(peerError(QAbstractSocket::SocketError)));
119 QxtRPCPeer::QxtRPCPeer(QIODevice* device, RPCTypes type, QObject* parent) : QObject(parent)
121 if (!device->isOpen())
123 qWarning("QxtRPCPeer::the device you passed is not open!");
126 QXT_INIT_PRIVATE(QxtRPCPeer);
127 qxt_d().m_rpctype = type;
128 qxt_d().m_peer = device;
129 //qDebug() << device->metaObject()->className();
131 if (qobject_cast<QAbstractSocket *>(device)!=0)
133 QObject::connect(qxt_d().m_peer, SIGNAL(connected()), this, SIGNAL(peerConnected()));
134 QObject::connect(qxt_d().m_peer, SIGNAL(disconnected()), this, SIGNAL(peerDisconnected()));
135 QObject::connect(qxt_d().m_peer, SIGNAL(disconnected()), this, SLOT(disconnectSender()));
136 QObject::connect(qxt_d().m_peer, SIGNAL(error(QAbstractSocket::SocketError)), this, SIGNAL(peerError(QAbstractSocket::SocketError)));
138 QObject::connect(qxt_d().m_peer, SIGNAL(readyRead()), this, SLOT(dataAvailable()));
142 void QxtRPCPeer::setRPCType(RPCTypes type)
144 if (qxt_d().m_peer->isOpen () || qxt_d().isListening())
146 qWarning() << "QxtRPCPeer: Cannot change RPC types while connected or listening";
149 qxt_d().m_rpctype = type;
153 QxtRPCPeer::RPCTypes QxtRPCPeer::rpcType() const
155 return (RPCTypes)(qxt_d().m_rpctype);
159 void QxtRPCPeer::connect(QHostAddress addr, int port)
161 if (qxt_d().m_rpctype == Server)
163 qWarning() << "QxtRPCPeer: Cannot connect outward in Server mode";
167 QAbstractSocket * sock = qobject_cast<QAbstractSocket*>(qxt_d().m_peer);
170 qWarning("QxtRPCPeer: cannot connect a custom QIODevice");
174 if (sock->state()!=QAbstractSocket::UnconnectedState)
176 qWarning("QxtRPCPeer: Already connected");
180 sock->connectToHost(addr, port);
184 bool QxtRPCPeer::listen(QHostAddress iface, int port)
186 if (qxt_d().m_rpctype == Client)
188 qWarning() << "QxtRPCPeer: Cannot listen in Client mode";
191 else if (qxt_d().m_rpctype == Peer && qxt_d().m_peer->isOpen ())
193 qWarning() << "QxtRPCPeer: Cannot listen while connected to a peer";
196 else if (qxt_d().isListening())
198 qWarning() << "QxtRPCPeer: Already listening";
201 return qxt_d().listen(iface, port);
205 void QxtRPCPeer::disconnectPeer(quint64 id)
207 if (qxt_d().m_rpctype == Server && id==(quint64)-1)
209 qWarning() << "QxtRPCPeer: Server mode does not have a peer";
212 else if (qxt_d().m_rpctype!= Server && id!=(quint64)-1)
214 qWarning() << "QxtRPCPeer: Must specify a client ID to disconnect";
217 QxtRPCConnection* conn;
220 qxt_d().m_peer->close();
221 ///hackaround for qt bug
222 QAbstractSocket *s =qobject_cast<QAbstractSocket*>( qxt_d().m_peer);
224 s->disconnectFromHost();
227 else if ((conn = qxt_d().m_clients.take((QObject*)(id)))!= 0)
229 conn->socket->disconnectFromHost();
230 conn->socket->deleteLater();
235 qWarning() << "QxtRPCPeer: no client with id " << id;
240 void QxtRPCPeer::disconnectAll()
242 if (qxt_d().m_rpctype!= Server)
246 for (QxtRPCPeerPrivate::ConnHash::const_iterator i = qxt_d().m_clients.constBegin(); i!= qxt_d().m_clients.constEnd(); i++)
248 (*i)->socket->deleteLater();
251 qxt_d().m_clients.clear();
256 void QxtRPCPeer::stopListening()
258 if (!qxt_d().isListening())
260 qWarning() << "QxtRPCPeer: Not listening";
267 bool QxtRPCPeer::attachSignal(QObject* sender, const char* signal, const QByteArray& rpcFunction)
269 const QMetaObject* meta = sender->metaObject();
270 QByteArray sig(meta->normalizedSignature(signal).mid(1));
271 int methodID = meta->indexOfMethod(sig.constData());
272 if (methodID == -1 || meta->method(methodID).methodType() != QMetaMethod::Signal)
274 qWarning() << "QxtRPCPeer::attachSignal: No such signal " << signal;
279 QxtIntrospector* spec = new QxtIntrospector(this, sender, signal);
280 if (!rpcFunction.isEmpty())
282 if (QxtMetaObject::isSignalOrSlot(rpcFunction.constData()))
284 spec->rpcFunction = QMetaObject::normalizedSignature(rpcFunction.constData());
288 spec->rpcFunction = rpcFunction.simplified();
293 spec->rpcFunction = QMetaObject::normalizedSignature(signal);
295 qxt_d().attachedSignals.insertMulti(sender, spec);
300 bool QxtRPCPeer::attachSlot(const QByteArray& rpcFunction, QObject* recv, const char* slot)
302 const QMetaObject* meta = recv->metaObject();
303 int methodID = meta->indexOfMethod(meta->normalizedSignature(slot).mid(1));
304 if (methodID == -1 || meta->method(methodID).methodType() == QMetaMethod::Method)
306 qWarning() << "QxtRPCPeer::attachSlot: No such slot " << slot;
312 if (QxtMetaObject::isSignalOrSlot(rpcFunction.constData()))
314 fn = QMetaObject::normalizedSignature(rpcFunction.constData());
318 fn = rpcFunction.simplified();
321 qxt_d().attachedSlots[fn].append(QPair<QObject*, int>(recv, recv->metaObject()->indexOfMethod(recv->metaObject()->normalizedSignature(slot).mid(1))));
326 void QxtRPCPeer::detachSender()
328 detachObject(sender());
332 void QxtRPCPeer::detachObject(QObject* obj)
334 foreach(QxtIntrospector* i, qxt_d().attachedSignals.values(obj)) i->deleteLater();
335 qxt_d().attachedSignals.remove(obj);
336 foreach(QString slot, qxt_d().attachedSlots.keys())
338 for (QList<QPair<QObject*, int> >::iterator i(qxt_d().attachedSlots[slot].begin());
339 i!= qxt_d().attachedSlots[slot].end(); )
341 if ((*i).first == obj)
342 i = qxt_d().attachedSlots[slot].erase(i);
350 QByteArray QxtRPCPeer::serialize(QString fn, QVariant p1, QVariant p2, QVariant p3, QVariant p4, QVariant p5, QVariant p6, QVariant p7, QVariant p8, QVariant p9) const
353 QDataStream str(&rv, QIODevice::WriteOnly);
355 unsigned char ct = 9;
356 if (p1.isNull()) ct = 0;
357 else if (p2.isNull()) ct = 1;
358 else if (p3.isNull()) ct = 2;
359 else if (p4.isNull()) ct = 3;
360 else if (p5.isNull()) ct = 4;
361 else if (p6.isNull()) ct = 5;
362 else if (p7.isNull()) ct = 6;
363 else if (p8.isNull()) ct = 7;
364 else if (p9.isNull()) ct = 8;
375 rv.replace(QByteArray("\\"), QByteArray("\\\\"));
376 rv.replace(QByteArray("\n"), QByteArray("\\n"));
382 void QxtRPCPeer::call(const char * signal , QVariant p1, QVariant p2, QVariant p3, QVariant p4, QVariant p5, QVariant p6, QVariant p7, QVariant p8, QVariant p9)
385 QByteArray sig=QMetaObject::normalizedSignature(signal);
387 QAbstractSocket * sock = qobject_cast<QAbstractSocket*>(qxt_d().m_peer);
388 if (!qxt_d().m_peer->isOpen () || ( sock && sock->state()!=QAbstractSocket::ConnectedState ))
390 qWarning("can't call on a closed device");
393 qxt_d().m_peer->write(serialize(sig, p1, p2, p3, p4, p5, p6, p7, p8, p9));
397 void QxtRPCPeer::callClientList(QList<quint64> ids, QString fn, QVariant p1, QVariant p2, QVariant p3, QVariant p4, QVariant p5, QVariant p6, QVariant p7, QVariant p8)
399 QByteArray c = serialize(fn, p1, p2, p3, p4, p5, p6, p7, p8, QVariant());
400 foreach(quint64 id, ids)
402 QxtRPCConnection* conn = qxt_d().m_clients.value((QObject*)(id));
405 qWarning() << "QxtRPCPeer: no client with id" << id;
409 conn->socket->write(c);
415 void QxtRPCPeer::callClient(quint64 id, QString fn, QVariant p1, QVariant p2, QVariant p3, QVariant p4, QVariant p5, QVariant p6, QVariant p7, QVariant p8)
417 callClientList(QList<quint64>() << id, fn, p1, p2, p3, p4, p5, p6, p7, p8);
421 void QxtRPCPeer::callClientsExcept(quint64 id, QString fn, QVariant p1, QVariant p2, QVariant p3, QVariant p4, QVariant p5, QVariant p6, QVariant p7, QVariant p8)
423 QList<quint64> cs = clients();
425 callClientList(cs, fn, p1, p2, p3, p4, p5, p6, p7, p8);
428 #include <QStringList>
429 #define QXT_ARG(i) ((numParams>i)?QGenericArgument(p ## i .typeName(), p ## i .constData()):QGenericArgument())
430 void QxtRPCPeerPrivate::receivePeerSignal(QString fn, QVariant p0, QVariant p1, QVariant p2, QVariant p3, QVariant p4, QVariant p5, QVariant p6, QVariant p7, QVariant p8) const
434 if(!attachedSlots.value(fn).count()) qDebug() << "no attached slot for signal" << fn;// qDebug() << attachedSlots;
435 foreach(QxtRPCPeerPrivate::MethodID i, attachedSlots.value(fn))
437 sig = i.first->metaObject()->method(i.second).signature();
438 sig = sig.left(sig.indexOf('('));
439 numParams = i.first->metaObject()->method(i.second).parameterTypes().count(); //qDebug() << "calling" << fn << p0 << p1 << p2;
440 bool res = QMetaObject::invokeMethod(i.first, sig, QXT_ARG(0), QXT_ARG(1), QXT_ARG(2), QXT_ARG(3), QXT_ARG(4), QXT_ARG(5), QXT_ARG(6), QXT_ARG(7), QXT_ARG(8));
441 if(!res) qDebug() << "rpccall failed" << fn << sig << p0 << p1 << p2;
446 void QxtRPCPeerPrivate::receiveClientSignal(quint64 id, QString fn, QVariant p0, QVariant p1, QVariant p2, QVariant p3, QVariant p4, QVariant p5, QVariant p6, QVariant p7) const
450 foreach(QxtRPCPeerPrivate::MethodID i, attachedSlots.value(fn))
452 sig = i.first->metaObject()->method(i.second).signature();
453 sig = sig.left(sig.indexOf('('));
454 numParams = i.first->metaObject()->method(i.second).parameterTypes().count();
455 QMetaObject::invokeMethod(i.first, sig, Q_ARG(quint64, id), QXT_ARG(0), QXT_ARG(1), QXT_ARG(2), QXT_ARG(3), QXT_ARG(4), QXT_ARG(5), QXT_ARG(6), QXT_ARG(7));
462 void QxtRPCPeerPrivate::incomingConnection ( int socketDescriptor )
464 QTcpSocket* next = qxt_p().incomingConnection(socketDescriptor);
465 if (m_rpctype == QxtRPCPeer::Peer)
467 if (m_peer->isOpen ())
469 qWarning() << "QxtRPCPeer: Rejected connection from " << next->peerAddress().toString() << "; another peer is connected";
470 next->disconnectFromHost();
475 m_peer->deleteLater();
477 QObject::connect(m_peer, SIGNAL(connected()), &qxt_p(), SIGNAL(peerConnected()));
478 QObject::connect(m_peer, SIGNAL(disconnected()), &qxt_p(), SIGNAL(peerDisconnected()));
479 QObject::connect(m_peer, SIGNAL(disconnected()), &qxt_p(), SLOT(disconnectSender()));
480 QObject::connect(m_peer, SIGNAL(readyRead()), &qxt_p(), SLOT(dataAvailable()));
481 QObject::connect(m_peer, SIGNAL(error(QAbstractSocket::SocketError)), &qxt_p(), SIGNAL(peerError(QAbstractSocket::SocketError)));
482 emit qxt_p().peerConnected();
487 QxtRPCConnection* conn = new QxtRPCConnection;
489 m_clients[next] = conn;
490 QObject::connect(next, SIGNAL(disconnected()), &qxt_p(), SLOT(disconnectSender()));
491 QObject::connect(next, SIGNAL(readyRead()), &qxt_p(), SLOT(dataAvailable()));
492 QObject::connect(next, SIGNAL(error(QAbstractSocket::SocketError)), &qxt_p(), SIGNAL(peerError(QAbstractSocket::SocketError)));
493 emit qxt_p().clientConnected((quint64)(next));
498 void QxtRPCPeer::dataAvailable()
500 if (qxt_d().m_rpctype!=QxtRPCPeer::Server && qxt_d().m_peer==sender())
502 qxt_d().m_buffer.append(qxt_d().m_peer->readAll());
503 qxt_d().processInput(qxt_d().m_peer, qxt_d().m_buffer);
508 QxtRPCConnection* conn = qxt_d().m_clients.value(sender());
511 qWarning() << "QxtRPCPeer: Unrecognized client object connected to dataAvailable";
514 conn->buffer.append(conn->socket->readAll());
515 qxt_d().processInput(conn->socket, (conn->buffer));
518 qWarning() << "QxtRPCPeer: Unrecognized peer object connected to dataAvailable";
522 void QxtRPCPeer::disconnectSender()
524 QxtRPCConnection* conn = qxt_d().m_clients.value(sender());
527 //qDebug() << qxt_d().m_peer->metaObject()->className();
528 if (qxt_d().m_peer!= qobject_cast<QTcpSocket*>(sender()))
530 qWarning() << "QxtRPCPeer: Unrecognized object connected to disconnectSender";
533 qxt_d().m_buffer.append(qxt_d().m_peer->readAll());
534 qxt_d().m_buffer.append("\n");
535 qxt_d().processInput(qxt_d().m_peer, qxt_d().m_buffer);
536 qxt_d().m_buffer.clear();
537 emit clientDisconnected((quint64)(sender()));
540 conn->buffer.append(conn->socket->readAll());
541 conn->buffer.append("\n");
542 qxt_d().processInput(conn->socket, conn->buffer);
543 conn->socket->deleteLater();
545 qxt_d().m_clients.remove(sender());
549 void QxtRPCPeerPrivate::processInput(QIODevice* socket, QByteArray& buffer)
551 while (qxt_p().canDeserialize(buffer))
553 QPair<QString, QList<QVariant> > sig = qxt_p().deserialize(buffer);
554 if (sig.first.isEmpty())
556 if (sig.second.count())
558 qWarning() << "QxtRPCPeer: Invalid data received; disconnecting";
559 if (socket == m_peer)
560 qxt_p().disconnectPeer();
562 qxt_p().disconnectPeer((quint64)(socket));
567 while (sig.second.count() < 9) sig.second << QVariant();
568 if (socket == m_peer)
570 receivePeerSignal(sig.first, sig.second[0], sig.second[1], sig.second[2], sig.second[3], sig.second[4], sig.second[5], sig.second[6], sig.second[7], sig.second[8]);
574 receiveClientSignal((quint64)(socket), sig.first, sig.second[0], sig.second[1], sig.second[2], sig.second[3], sig.second[4], sig.second[5], sig.second[6], sig.second[7]);
580 QList<quint64> QxtRPCPeer::clients() const
583 QList<QObject*> cs = qxt_d().m_clients.keys();
584 foreach(QObject* id, cs) rv << (const quint64)(id);
589 QxtIntrospector::QxtIntrospector(QxtRPCPeer* parent, QObject* source, const char* signal): QObject(parent)
592 QByteArray sig_ba = QMetaObject::normalizedSignature(QByteArray(signal).mid(1));
593 const char * sig=sig_ba.constData();
594 int idx = source->metaObject()->indexOfSignal(sig);
596 qWarning("no such signal: %s",sig_ba.constData());
598 // Our "method" will have the first ID not used by the superclass.
599 QMetaObject::connect(source, idx, this, QObject::staticMetaObject.methodCount());
600 QObject::connect(source, SIGNAL(destroyed()), peer, SLOT(detachSender()));
601 QList<QByteArray> p = source->metaObject()->method(idx).parameterTypes();
603 for (int i=0; i<ct; i++) argTypes.append(QMetaType::type(p.value(i).constData()));
607 int QxtIntrospector::qt_metacall(QMetaObject::Call _c, int _id, void **_a)
609 _id = QObject::qt_metacall(_c, _id, _a);
612 if (_c == QMetaObject::InvokeMetaMethod)
617 int n = argTypes.size();
618 for (int i=0; i<n; i++) v[i] = QVariant(argTypes[i], _a[i+1]);
619 peer->call(rpcFunction.toUtf8().constData(), v[0], v[1], v[2], v[3], v[4], v[5], v[6], v[7], v[8]);
627 QPair<QString, QList<QVariant> > QxtRPCPeer::deserialize(QByteArray& data)
630 int pos = data.indexOf('\n');
631 cmd = data.left(pos-1);
632 data = data.mid(pos+1);
633 if (cmd.length()==0) return qMakePair(QString(), QList<QVariant>());
634 cmd.replace(QByteArray("\\n"), QByteArray("\n"));
635 cmd.replace(QByteArray("\\\\"), QByteArray("\\"));
636 QDataStream str(cmd);
638 unsigned char argCount;
641 str >> signal >> argCount;
643 if (str.status() == QDataStream::ReadCorruptData)
646 return qMakePair(QString(), v);
649 for (int i=0; i<argCount; i++)
654 return qMakePair(signal, v);
658 bool QxtRPCPeer::canDeserialize(const QByteArray& buffer) const
660 if (buffer.indexOf('\n') == -1)
671 QIODevice * QxtRPCPeer::socket()
673 if (qxt_d().m_rpctype == Server)return 0;
674 return qxt_d().m_peer;
680 QTcpSocket * QxtRPCPeer::incomingConnection ( int socketDescriptor )
682 QTcpSocket * t = new QTcpSocket;
683 t->setSocketDescriptor (socketDescriptor);
690 const QTcpSocket * QxtRPCPeer::clientSocket(quint64 id) const
692 if (qxt_d().m_rpctype != Server)
695 return qxt_d().m_clients[(QTcpSocket*)(id)]->socket;
697 QList<quint64> QxtRPCPeer::clients()
700 foreach(QObject * o,qxt_d().m_clients.keys ())
702 list.append((quint64)o);