src/common/signalproxy.h

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