src/common/signalproxy.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2016 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  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #pragma once
  22
  23 #include <QEvent>
  24 #include <QSet>
  25
  26 #include <functional>
  27 #include <initializer_list>
  28
  29 #include "protocol.h"
  30
  31 struct QMetaObject;
  32 class QIODevice;
  33
  34 class Peer;
  35 class SyncableObject;
  36
  37 class SignalProxy : public QObject
  38 {
  39     Q_OBJECT
  40
  41     class SignalRelay;
  42
  43 public:
  44     enum ProxyMode {
  45         Server,
  46         Client
  47     };
  48
  49     enum EventType {
  50         RemovePeerEvent = QEvent::User
  51     };
  52
  53     SignalProxy(QObject *parent);
  54     SignalProxy(ProxyMode mode, QObject *parent);
  55     virtual ~SignalProxy();
  56
  57     void setProxyMode(ProxyMode mode);
  58     inline ProxyMode proxyMode() const { return _proxyMode; }
  59
  60     void setHeartBeatInterval(int secs);
  61     inline int heartBeatInterval() const { return _heartBeatInterval; }
  62     void setMaxHeartBeatCount(int max);
  63     inline int maxHeartBeatCount() const { return _maxHeartBeatCount; }
  64
  65     bool addPeer(Peer *peer);
  66
  67     bool attachSignal(QObject *sender, const char *signal, const QByteArray &sigName = QByteArray());
  68     bool attachSlot(const QByteArray &sigName, QObject *recv, const char *slot);
  69
  70     void synchronize(SyncableObject *obj);
  71     void stopSynchronize(SyncableObject *obj);
  72
  73     class ExtendedMetaObject;
  74     ExtendedMetaObject *extendedMetaObject(const QMetaObject *meta) const;
  75     ExtendedMetaObject *createExtendedMetaObject(const QMetaObject *meta, bool checkConflicts = false);
  76     inline ExtendedMetaObject *extendedMetaObject(const QObject *obj) const { return extendedMetaObject(metaObject(obj)); }
  77     inline ExtendedMetaObject *createExtendedMetaObject(const QObject *obj, bool checkConflicts = false) { return createExtendedMetaObject(metaObject(obj), checkConflicts); }
  78
  79     bool isSecure() const { return _secure; }
  80     void dumpProxyStats();
  81     void dumpSyncMap(SyncableObject *object);
  82
  83     static SignalProxy *current() {
  84         return _current;
  85     }
  86
  87     /**@{*/
  88     /**
  89      * This method allows to send a signal only to a limited set of peers
  90      * @param peers A list of peers that should receive it
  91      * @param closure Code you want to execute within of that restricted environment
  92      */
  93     void restrictTargetPeers(QSet<Peer*> peers, std::function<void()> closure);
  94     void restrictTargetPeers(Peer *peer, std::function<void()> closure) {
  95         QSet<Peer*> set;
  96         set.insert(peer);
  97         restrictTargetPeers(set, std::move(closure));
  98     }
  99
 100     //A better version, but only implemented on Qt5 if Initializer Lists exist
 101 #if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0)
 102 #ifdef Q_COMPILER_INITIALIZER_LISTS
 103     void restrictTargetPeers(std::initializer_list<Peer*> peers, std::function<void()> closure) {
 104         restrictTargetPeers(QSet<Peer*>(peers), std::move(closure));
 105     }
 106 #endif
 107 #endif
 108     /**}@*/
 109
 110     inline int peerCount() const { return _peerMap.size(); }
 111     QVariantList peerData();
 112
 113     Peer *peerById(int peerId);
 114
 115     /**
 116      * @return If handling a signal, the Peer from which the current signal originates
 117      */
 118     Peer *sourcePeer();
 119     void setSourcePeer(Peer *sourcePeer);
 120
 121     /**
 122      * @return If sending a signal, the Peer to which the current signal is directed
 123      */
 124     Peer *targetPeer();
 125     void setTargetPeer(Peer *targetPeer);
 126
 127 public slots:
 128     void detachObject(QObject *obj);
 129     void detachSignals(QObject *sender);
 130     void detachSlots(QObject *receiver);
 131
 132 protected:
 133     void customEvent(QEvent *event);
 134     void sync_call__(const SyncableObject *obj, ProxyMode modeType, const char *funcname, va_list ap);
 135     void renameObject(const SyncableObject *obj, const QString &newname, const QString &oldname);
 136
 137 private slots:
 138     void removePeerBySender();
 139     void objectRenamed(const QByteArray &classname, const QString &newname, const QString &oldname);
 140     void updateSecureState();
 141
 142 signals:
 143     void peerRemoved(Peer *peer);
 144     void connected();
 145     void disconnected();
 146     void objectInitialized(SyncableObject *);
 147     void heartBeatIntervalChanged(int secs);
 148     void maxHeartBeatCountChanged(int max);
 149     void lagUpdated(int lag);
 150     void secureStateChanged(bool);
 151
 152 private:
 153     template<class T>
 154     class PeerMessageEvent;
 155
 156     void init();
 157     void initServer();
 158     void initClient();
 159
 160     static const QMetaObject *metaObject(const QObject *obj);
 161
 162     void removePeer(Peer *peer);
 163     void removeAllPeers();
 164
 165     int nextPeerId() {
 166         return _lastPeerId++;
 167     }
 168
 169     template<class T>
 170     void dispatch(const T &protoMessage);
 171     template<class T>
 172     void dispatch(Peer *peer, const T &protoMessage);
 173
 174     void handle(Peer *peer, const Protocol::SyncMessage &syncMessage);
 175     void handle(Peer *peer, const Protocol::RpcCall &rpcCall);
 176     void handle(Peer *peer, const Protocol::InitRequest &initRequest);
 177     void handle(Peer *peer, const Protocol::InitData &initData);
 178
 179     template<class T>
 180     void handle(Peer *, T) { Q_ASSERT(0); }
 181
 182     bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params, QVariant &returnValue, Peer *peer = 0);
 183     bool invokeSlot(QObject *receiver, int methodId, const QVariantList &params = QVariantList(), Peer *peer = 0);
 184
 185     void requestInit(SyncableObject *obj);
 186     QVariantMap initData(SyncableObject *obj) const;
 187     void setInitData(SyncableObject *obj, const QVariantMap &properties);
 188
 189     static void disconnectDevice(QIODevice *dev, const QString &reason = QString());
 190
 191     QHash<int, Peer*> _peerMap;
 192
 193     // containg a list of argtypes for fast access
 194     QHash<const QMetaObject *, ExtendedMetaObject *> _extendedMetaObjects;
 195
 196     // SignalRelay for all manually attached signals
 197     SignalRelay *_signalRelay;
 198
 199     // RPC function -> (object, slot ID)
 200     typedef QPair<QObject *, int> MethodId;
 201     typedef QMultiHash<QByteArray, MethodId> SlotHash;
 202     SlotHash _attachedSlots;
 203
 204     // slaves for sync
 205     typedef QHash<QString, SyncableObject *> ObjectId;
 206     QHash<QByteArray, ObjectId> _syncSlave;
 207
 208     ProxyMode _proxyMode;
 209     int _heartBeatInterval;
 210     int _maxHeartBeatCount;
 211
 212     bool _secure; // determines if all connections are in a secured state (using ssl or internal connections)
 213
 214     int _lastPeerId = 0;
 215
 216     QSet<Peer *> _restrictedTargets;
 217     bool _restrictMessageTarget = false;
 218
 219     Peer *_sourcePeer = nullptr;
 220     Peer *_targetPeer = nullptr;
 221
 222     thread_local static SignalProxy *_current;
 223
 224     friend class SignalRelay;
 225     friend class SyncableObject;
 226     friend class Peer;
 227 };
 228
 229
 230 // ==================================================
 231 //  ExtendedMetaObject
 232 // ==================================================
 233 class SignalProxy::ExtendedMetaObject
 234 {
 235     class MethodDescriptor
 236     {
 237     public:
 238         MethodDescriptor(const QMetaMethod &method);
 239         MethodDescriptor() : _returnType(-1), _minArgCount(-1), _receiverMode(SignalProxy::Client) {}
 240
 241         inline const QByteArray &methodName() const { return _methodName; }
 242         inline const QList<int> &argTypes() const { return _argTypes; }
 243         inline int returnType() const { return _returnType; }
 244         inline int minArgCount() const { return _minArgCount; }
 245         inline SignalProxy::ProxyMode receiverMode() const { return _receiverMode; }
 246
 247     private:
 248         QByteArray _methodName;
 249         QList<int> _argTypes;
 250         int _returnType;
 251         int _minArgCount;
 252         SignalProxy::ProxyMode _receiverMode; // Only acceptable as a Sync Call if the receiving SignalProxy is in this mode.
 253     };
 254
 255
 256 public:
 257     ExtendedMetaObject(const QMetaObject *meta, bool checkConflicts);
 258
 259     inline const QByteArray &methodName(int methodId) { return methodDescriptor(methodId).methodName(); }
 260     inline const QList<int> &argTypes(int methodId) { return methodDescriptor(methodId).argTypes(); }
 261     inline int returnType(int methodId) { return methodDescriptor(methodId).returnType(); }
 262     inline int minArgCount(int methodId) { return methodDescriptor(methodId).minArgCount(); }
 263     inline SignalProxy::ProxyMode receiverMode(int methodId) { return methodDescriptor(methodId).receiverMode(); }
 264
 265     inline int methodId(const QByteArray &methodName) { return _methodIds.contains(methodName) ? _methodIds[methodName] : -1; }
 266
 267     inline int updatedRemotelyId() { return _updatedRemotelyId; }
 268
 269     inline const QHash<QByteArray, int> &slotMap() { return _methodIds; }
 270     const QHash<int, int> &receiveMap();
 271
 272     const QMetaObject *metaObject() const { return _meta; }
 273
 274     static QByteArray methodName(const QMetaMethod &method);
 275     static QString methodBaseName(const QMetaMethod &method);
 276
 277 private:
 278     const MethodDescriptor &methodDescriptor(int methodId);
 279
 280     const QMetaObject *_meta;
 281     int _updatedRemotelyId; // id of the updatedRemotely() signal - makes things faster
 282
 283     QHash<int, MethodDescriptor> _methods;
 284     QHash<QByteArray, int> _methodIds;
 285     QHash<int, int> _receiveMap; // if slot x is called then hand over the result to slot y
 286 };