1 /***************************************************************************
2 * Copyright (C) 2005-2020 by the Quassel Project *
3 * devel@quassel-irc.org *
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. *
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. *
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 ***************************************************************************/
23 #include "common-export.h"
25 #include <QAbstractSocket>
26 #include <QDataStream>
29 #include "authhandler.h"
32 #include "signalproxy.h"
34 class COMMON_EXPORT Peer : public QObject
39 explicit Peer(AuthHandler* authHandler, QObject* parent = nullptr);
41 virtual Protocol::Type protocol() const = 0;
42 virtual QString description() const = 0;
44 virtual SignalProxy* signalProxy() const = 0;
45 virtual void setSignalProxy(SignalProxy* proxy) = 0;
47 QDateTime connectedSince() const;
48 void setConnectedSince(const QDateTime& connectedSince);
50 QString buildDate() const;
51 void setBuildDate(const QString& buildDate);
53 QString clientVersion() const;
54 void setClientVersion(const QString& clientVersion);
56 bool hasFeature(Quassel::Feature feature) const;
57 Quassel::Features features() const;
58 void setFeatures(Quassel::Features features);
63 AuthHandler* authHandler() const;
65 virtual bool isOpen() const = 0;
66 virtual bool isSecure() const = 0;
67 virtual bool isLocal() const = 0;
69 virtual int lag() const = 0;
71 virtual QString address() const = 0;
72 virtual quint16 port() const = 0;
75 /* Handshake messages */
76 virtual void dispatch(const Protocol::RegisterClient&) = 0;
77 virtual void dispatch(const Protocol::ClientDenied&) = 0;
78 virtual void dispatch(const Protocol::ClientRegistered&) = 0;
79 virtual void dispatch(const Protocol::SetupData&) = 0;
80 virtual void dispatch(const Protocol::SetupFailed&) = 0;
81 virtual void dispatch(const Protocol::SetupDone&) = 0;
82 virtual void dispatch(const Protocol::Login&) = 0;
83 virtual void dispatch(const Protocol::LoginFailed&) = 0;
84 virtual void dispatch(const Protocol::LoginSuccess&) = 0;
85 virtual void dispatch(const Protocol::SessionState&) = 0;
87 /* Sigproxy messages */
88 virtual void dispatch(const Protocol::SyncMessage&) = 0;
89 virtual void dispatch(const Protocol::RpcCall&) = 0;
90 virtual void dispatch(const Protocol::InitRequest&) = 0;
91 virtual void dispatch(const Protocol::InitData&) = 0;
93 virtual void close(const QString& reason = QString()) = 0;
97 void secureStateChanged(bool secure = true);
98 void lagUpdated(int msecs);
102 void handle(const T& protoMessage);
105 QPointer<AuthHandler> _authHandler;
107 QDateTime _connectedSince;
110 QString _clientVersion;
111 Quassel::Features _features;
116 // We need to special-case Peer* in attached signals/slots, so typedef it for the meta type system
117 using PeerPtr = Peer*;
118 Q_DECLARE_METATYPE(PeerPtr)
120 QDataStream& operator<<(QDataStream& out, PeerPtr ptr);
121 QDataStream& operator>>(QDataStream& in, PeerPtr& ptr);
123 // Template method needed in the header
125 inline void Peer::handle(const T& protoMessage)
127 switch (protoMessage.handler()) {
128 case Protocol::Handler::SignalProxy:
129 if (!signalProxy()) {
130 qWarning() << Q_FUNC_INFO << "Cannot handle message without a SignalProxy!";
133 signalProxy()->handle(this, protoMessage);
136 case Protocol::Handler::AuthHandler:
137 if (!authHandler()) {
138 qWarning() << Q_FUNC_INFO << "Cannot handle auth messages without an active AuthHandler!";
141 authHandler()->handle(protoMessage);
145 qWarning() << Q_FUNC_INFO << "Unknown handler for protocol message!";