X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fsignalproxy.h;h=a94861713387f5dc2435b7f8c49ef7c59df473b5;hp=50010607604019fcd214890ee75dc5a6f33de128;hb=158443f71d48215eea8b47b836b61afd77654b78;hpb=a7f5d6a23f7214b11f6db85346a67fd7d02767da diff --git a/src/common/signalproxy.h b/src/common/signalproxy.h index 50010607..a9486171 100644 --- a/src/common/signalproxy.h +++ b/src/common/signalproxy.h @@ -1,11 +1,11 @@ /*************************************************************************** - * Copyright (C) 2005-07 by the Quassel IRC Team * + * Copyright (C) 2005-2018 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * + * (at your option) version 3. * * * * This program is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * @@ -15,155 +15,268 @@ * You should have received a copy of the GNU General Public License * * along with this program; if not, write to the * * Free Software Foundation, Inc., * - * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * - *************************************************************************** - * SignalProxy has been inspired by QxtRPCPeer, part of libqxt, * - * the Qt eXTension Library . We would like to * - * thank Arvid "aep" Picciani and Adam "ahigerd" Higerd for providing * - * QxtRPCPeer, valuable input and the genius idea to (ab)use Qt's * - * Meta Object System for transmitting signals over the network. * - * * - * To make contribution back into libqxt possible, redistribution and * - * modification of this file is additionally allowed under the terms of * - * the Common Public License, version 1.0, as published by IBM. * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#ifndef _SIGNALPROXY_H_ -#define _SIGNALPROXY_H_ +#pragma once + +#include "common-export.h" + +#include +#include + +#include +#include -#include -#include -#include -#include -#include -#include -#include +#include "protocol.h" -class SignalRelay; -class QMetaObject; +struct QMetaObject; +class QIODevice; -class SignalProxy : public QObject { - Q_OBJECT +class Peer; +class SyncableObject; + +class COMMON_EXPORT SignalProxy : public QObject +{ + Q_OBJECT + + class SignalRelay; public: - enum ProxyMode { - Server, - Client - }; - - enum RequestType { - Sync = 0, - InitRequest, - InitData - }; - - SignalProxy(QObject *parent); - SignalProxy(ProxyMode mode, QObject *parent); - SignalProxy(ProxyMode mode, QIODevice *device, QObject *parent); - virtual ~SignalProxy(); - - void setProxyMode(ProxyMode mode); - ProxyMode proxyMode() const; - - bool addPeer(QIODevice *iodev); - void removePeer(QIODevice *iodev = 0); - - bool attachSignal(QObject *sender, const char *signal, const QByteArray& sigName = QByteArray()); - bool attachSlot(const QByteArray& sigName, QObject *recv, const char *slot); - - void synchronize(QObject *obj); - void synchronizeAsMaster(QObject *obj); - void synchronizeAsSlave(QObject *obj); - - void setInitialized(QObject *obj); - bool initialized(QObject *obj); - void requestInit(QObject *obj); - - void detachObject(QObject *obj); - void detachSignals(QObject *sender); - void detachSlots(QObject *receiver); - - static void writeDataToDevice(QIODevice *dev, const QVariant &item); - static bool readDataFromDevice(QIODevice *dev, quint32 &blockSize, QVariant &item); - - static QString methodBaseName(const QMetaMethod &method); - - const QList &argTypes(QObject *obj, int methodId); - const QByteArray &methodName(QObject *obj, int methodId); - const QHash &syncMap(QObject *obj); - - typedef QHash > ArgHash; - typedef QHash MethodNameHash; - struct ClassInfo { - ArgHash argTypes; - MethodNameHash methodNames; - QHash syncMap; - }; - - void dumpProxyStats(); - + enum ProxyMode { + Server, + Client + }; + + enum EventType { + RemovePeerEvent = QEvent::User + }; + + SignalProxy(QObject *parent); + SignalProxy(ProxyMode mode, QObject *parent); + ~SignalProxy() override; + + void setProxyMode(ProxyMode mode); + inline ProxyMode proxyMode() const { return _proxyMode; } + + void setHeartBeatInterval(int secs); + inline int heartBeatInterval() const { return _heartBeatInterval; } + void setMaxHeartBeatCount(int max); + inline int maxHeartBeatCount() const { return _maxHeartBeatCount; } + + bool addPeer(Peer *peer); + + bool attachSignal(QObject *sender, const char *signal, const QByteArray &sigName = QByteArray()); + bool attachSlot(const QByteArray &sigName, QObject *recv, const char *slot); + + void synchronize(SyncableObject *obj); + void stopSynchronize(SyncableObject *obj); + + class ExtendedMetaObject; + ExtendedMetaObject *extendedMetaObject(const QMetaObject *meta) const; + ExtendedMetaObject *createExtendedMetaObject(const QMetaObject *meta, bool checkConflicts = false); + inline ExtendedMetaObject *extendedMetaObject(const QObject *obj) const { return extendedMetaObject(metaObject(obj)); } + inline ExtendedMetaObject *createExtendedMetaObject(const QObject *obj, bool checkConflicts = false) { return createExtendedMetaObject(metaObject(obj), checkConflicts); } + + bool isSecure() const { return _secure; } + void dumpProxyStats(); + void dumpSyncMap(SyncableObject *object); + + static SignalProxy *current(); + + /**@{*/ + /** + * This method allows to send a signal only to a limited set of peers + * @param peers A list of peers that should receive it + * @param closure Code you want to execute within of that restricted environment + */ + void restrictTargetPeers(QSet peers, std::function closure); + void restrictTargetPeers(Peer *peer, std::function closure) { + QSet set; + set.insert(peer); + restrictTargetPeers(set, std::move(closure)); + } + + //A better version, but only implemented on Qt5 if Initializer Lists exist +#ifdef Q_COMPILER_INITIALIZER_LISTS + void restrictTargetPeers(std::initializer_list peers, std::function closure) { + restrictTargetPeers(QSet(peers), std::move(closure)); + } +#endif + /**}@*/ + + inline int peerCount() const { return _peerMap.size(); } + QVariantList peerData(); + + Peer *peerById(int peerId); + + /** + * @return If handling a signal, the Peer from which the current signal originates + */ + Peer *sourcePeer(); + void setSourcePeer(Peer *sourcePeer); + + /** + * @return If sending a signal, the Peer to which the current signal is directed + */ + Peer *targetPeer(); + void setTargetPeer(Peer *targetPeer); + +public slots: + void detachObject(QObject *obj); + void detachSignals(QObject *sender); + void detachSlots(QObject *receiver); + +protected: + void customEvent(QEvent *event) override; + void sync_call__(const SyncableObject *obj, ProxyMode modeType, const char *funcname, va_list ap); + void renameObject(const SyncableObject *obj, const QString &newname, const QString &oldname); + private slots: - void dataAvailable(); - void detachSender(); - void removePeerBySender(); - void objectRenamed(QString oldname, QString newname); - void objectRenamed(QByteArray classname, QString oldname, QString newname); + void removePeerBySender(); + void objectRenamed(const QByteArray &classname, const QString &newname, const QString &oldname); + void updateSecureState(); signals: - void peerRemoved(QIODevice *obj); - void connected(); - void disconnected(); - + void peerRemoved(Peer *peer); + void connected(); + void disconnected(); + void objectInitialized(SyncableObject *); + void heartBeatIntervalChanged(int secs); + void maxHeartBeatCountChanged(int max); + void lagUpdated(int lag); + void secureStateChanged(bool); + private: - void initServer(); - void initClient(); - - void createClassInfo(QObject *obj); - void setArgTypes(QObject *obj, int methodId); - void setMethodName(QObject *obj, int methodId); - void setSyncMap(QObject *obj); + template + class PeerMessageEvent; - bool methodsMatch(const QMetaMethod &signal, const QMetaMethod &slot) const; + void init(); + void initServer(); + void initClient(); - void dispatchSignal(QIODevice *receiver, const QVariant &identifier, const QVariantList ¶ms); - void dispatchSignal(const QVariant &identifier, const QVariantList ¶ms); - - void receivePeerSignal(QIODevice *sender, const QVariant &packedFunc); - void handleSync(QVariantList params); - void handleInitRequest(QIODevice *sender, const QVariantList ¶ms); - void handleInitData(QIODevice *sender, const QVariantList ¶ms); - void handleSignal(const QByteArray &funcName, const QVariantList ¶ms); + static const QMetaObject *metaObject(const QObject *obj); - bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms); + void removePeer(Peer *peer); + void removeAllPeers(); - QVariantMap initData(QObject *obj) const; - void setInitData(QObject *obj, const QVariantMap &properties); - bool setInitValue(QObject *obj, const QString &property, const QVariant &value); + int nextPeerId() { + return _lastPeerId++; + } - void _detachSignals(QObject *sender); - void _detachSlots(QObject *receiver); + template + void dispatch(const T &protoMessage); + template + void dispatch(Peer *peer, const T &protoMessage); - // containg a list of argtypes for fast access - QHash _classInfo; + void handle(Peer *peer, const Protocol::SyncMessage &syncMessage); + void handle(Peer *peer, const Protocol::RpcCall &rpcCall); + void handle(Peer *peer, const Protocol::InitRequest &initRequest); + void handle(Peer *peer, const Protocol::InitData &initData); - // we use one SignalRelay per QObject - QHash _relayHash; + template + void handle(Peer *, T) { Q_ASSERT(0); } - // RPC function -> (object, slot ID) - typedef QPair MethodId; - typedef QMultiHash SlotHash; - SlotHash _attachedSlots; + bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms, QVariant &returnValue, Peer *peer = nullptr); + bool invokeSlot(QObject *receiver, int methodId, const QVariantList ¶ms = QVariantList(), Peer *peer = nullptr); - // slaves for sync - typedef QHash ObjectId; - QHash _syncSlave; + void requestInit(SyncableObject *obj); + QVariantMap initData(SyncableObject *obj) const; + void setInitData(SyncableObject *obj, const QVariantMap &properties); - // Hash of used QIODevices - QHash _peerByteCount; + static void disconnectDevice(QIODevice *dev, const QString &reason = QString()); - ProxyMode _proxyMode; + QHash _peerMap; - friend class SignalRelay; + // containg a list of argtypes for fast access + QHash _extendedMetaObjects; + + // SignalRelay for all manually attached signals + SignalRelay *_signalRelay; + + // RPC function -> (object, slot ID) + using MethodId = QPair; + using SlotHash = QMultiHash; + SlotHash _attachedSlots; + + // slaves for sync + using ObjectId = QHash; + QHash _syncSlave; + + ProxyMode _proxyMode; + int _heartBeatInterval; + int _maxHeartBeatCount; + + bool _secure; // determines if all connections are in a secured state (using ssl or internal connections) + + int _lastPeerId = 0; + + QSet _restrictedTargets; + bool _restrictMessageTarget = false; + + Peer *_sourcePeer = nullptr; + Peer *_targetPeer = nullptr; + + friend class SignalRelay; + friend class SyncableObject; + friend class Peer; }; -#endif + +// ================================================== +// ExtendedMetaObject +// ================================================== +class SignalProxy::ExtendedMetaObject +{ + class MethodDescriptor + { + public: + MethodDescriptor(const QMetaMethod &method); + MethodDescriptor() {} + + inline const QByteArray &methodName() const { return _methodName; } + inline const QList &argTypes() const { return _argTypes; } + inline int returnType() const { return _returnType; } + inline int minArgCount() const { return _minArgCount; } + inline SignalProxy::ProxyMode receiverMode() const { return _receiverMode; } + + private: + QByteArray _methodName; + QList _argTypes; + int _returnType{-1}; + int _minArgCount{-1}; + SignalProxy::ProxyMode _receiverMode{SignalProxy::Client}; // Only acceptable as a Sync Call if the receiving SignalProxy is in this mode. + }; + + +public: + ExtendedMetaObject(const QMetaObject *meta, bool checkConflicts); + + inline const QByteArray &methodName(int methodId) { return methodDescriptor(methodId).methodName(); } + inline const QList &argTypes(int methodId) { return methodDescriptor(methodId).argTypes(); } + inline int returnType(int methodId) { return methodDescriptor(methodId).returnType(); } + inline int minArgCount(int methodId) { return methodDescriptor(methodId).minArgCount(); } + inline SignalProxy::ProxyMode receiverMode(int methodId) { return methodDescriptor(methodId).receiverMode(); } + + inline int methodId(const QByteArray &methodName) { return _methodIds.contains(methodName) ? _methodIds[methodName] : -1; } + + inline int updatedRemotelyId() { return _updatedRemotelyId; } + + inline const QHash &slotMap() { return _methodIds; } + const QHash &receiveMap(); + + const QMetaObject *metaObject() const { return _meta; } + + static QByteArray methodName(const QMetaMethod &method); + static QString methodBaseName(const QMetaMethod &method); + +private: + const MethodDescriptor &methodDescriptor(int methodId); + + const QMetaObject *_meta; + int _updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster + + QHash _methods; + QHash _methodIds; + QHash _receiveMap; // if slot x is called then hand over the result to slot y +};