X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcommon%2Fprotocol.h;h=d95a529e16c75edae65264028837c6a98a34a601;hp=d7c1b1d590ec8cd9a29a4c2767ac88bec5865d78;hb=db00831bca59a012242d1ad5fac52a20c6cd2956;hpb=d1bf207d30fe62a15d0e8669d186374c68e6eae8 diff --git a/src/common/protocol.h b/src/common/protocol.h index d7c1b1d5..d95a529e 100644 --- a/src/common/protocol.h +++ b/src/common/protocol.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2005-2014 by the Quassel Project * + * Copyright (C) 2005-2018 by the Quassel Project * * devel@quassel-irc.org * * * * This program is free software; you can redistribute it and/or modify * @@ -18,141 +18,162 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * ***************************************************************************/ -#ifndef PROTOCOL_H_ -#define PROTOCOL_H_ +#pragma once + +#include #include #include #include +#include "quassel.h" + namespace Protocol { const quint32 magic = 0x42b33f00; -enum Type { - LegacyProtocol = 1 +enum Type +{ + InternalProtocol = 0x00, + LegacyProtocol = 0x01, + DataStreamProtocol = 0x02 }; - -enum Feature { +enum Feature +{ Encryption = 0x01, Compression = 0x02 }; - -enum Handler { +enum class Handler +{ SignalProxy, AuthHandler }; - /*** Handshake, handled by AuthHandler ***/ -struct HandshakeMessage { - inline Handler handler() const { return AuthHandler; } +struct HandshakeMessage +{ + inline Handler handler() const { return Handler::AuthHandler; } }; - struct RegisterClient : public HandshakeMessage { - inline RegisterClient(const QString &clientVersion, bool sslSupported = false) - : clientVersion(clientVersion) - , sslSupported(sslSupported) {} + inline RegisterClient(Quassel::Features clientFeatures, QString clientVersion, QString buildDate, bool sslSupported = false) + : features(std::move(clientFeatures)) + , clientVersion(std::move(clientVersion)) + , buildDate(std::move(buildDate)) + , sslSupported(sslSupported) + {} + Quassel::Features features; QString clientVersion; + QString buildDate; // this is only used by the LegacyProtocol in compat mode bool sslSupported; }; - struct ClientDenied : public HandshakeMessage { - inline ClientDenied(const QString &errorString) - : errorString(errorString) {} + inline ClientDenied(QString errorString) + : errorString(std::move(errorString)) + {} QString errorString; }; - struct ClientRegistered : public HandshakeMessage { - inline ClientRegistered(quint32 coreFeatures, bool coreConfigured, const QVariantList &backendInfo, bool sslSupported, const QDateTime &coreStartTime) - : coreFeatures(coreFeatures) - , coreConfigured(coreConfigured) - , backendInfo(backendInfo) - , sslSupported(sslSupported) - , coreStartTime(coreStartTime) + inline ClientRegistered( + Quassel::Features coreFeatures, bool coreConfigured, QVariantList backendInfo, QVariantList authenticatorInfo, bool sslSupported) + : features(std::move(coreFeatures)) + , coreConfigured(coreConfigured) + , backendInfo(std::move(backendInfo)) + , authenticatorInfo(std::move(authenticatorInfo)) + , sslSupported(sslSupported) {} - quint32 coreFeatures; + Quassel::Features features; bool coreConfigured; - QVariantList backendInfo; // TODO: abstract this better + QVariantList backendInfo; // TODO: abstract this better + + // The authenticatorInfo should be optional! + QVariantList authenticatorInfo; // this is only used by the LegacyProtocol in compat mode bool sslSupported; - QDateTime coreStartTime; }; - struct SetupData : public HandshakeMessage { - inline SetupData(const QString &adminUser, const QString &adminPassword, const QString &backend, const QVariantMap &setupData) - : adminUser(adminUser), adminPassword(adminPassword), backend(backend), setupData(setupData) {} + inline SetupData(QString adminUser, + QString adminPassword, + QString backend, + QVariantMap setupData, + QString authenticator = QString(), + QVariantMap authSetupData = QVariantMap()) + : adminUser(std::move(adminUser)) + , adminPassword(std::move(adminPassword)) + , backend(std::move(backend)) + , setupData(std::move(setupData)) + , authenticator(std::move(authenticator)) + , authSetupData(std::move(authSetupData)) + {} QString adminUser; QString adminPassword; QString backend; QVariantMap setupData; + QString authenticator; + QVariantMap authSetupData; }; - struct SetupFailed : public HandshakeMessage { - inline SetupFailed(const QString &errorString) - : errorString(errorString) {} + inline SetupFailed(QString errorString) + : errorString(std::move(errorString)) + {} QString errorString; }; - struct SetupDone : public HandshakeMessage -{ - inline SetupDone() {} -}; - +{}; struct Login : public HandshakeMessage { - inline Login(const QString &user, const QString &password) - : user(user), password(password) {} + inline Login(QString user, QString password) + : user(std::move(user)) + , password(std::move(password)) + {} QString user; QString password; }; - struct LoginFailed : public HandshakeMessage { - inline LoginFailed(const QString &errorString) - : errorString(errorString) {} + inline LoginFailed(QString errorString) + : errorString(std::move(errorString)) + {} QString errorString; }; - struct LoginSuccess : public HandshakeMessage -{ - inline LoginSuccess() {} -}; - +{}; // TODO: more generic format struct SessionState : public HandshakeMessage { - inline SessionState() {} // needed for QMetaType (for the mono client) - inline SessionState(const QVariantList &identities, const QVariantList &bufferInfos, const QVariantList &networkIds) - : identities(identities), bufferInfos(bufferInfos), networkIds(networkIds) {} + inline SessionState() = default; // needed for QMetaType (for the mono client) + inline SessionState(QVariantList identities, QVariantList bufferInfos, QVariantList networkIds) + : identities(std::move(identities)) + , bufferInfos(std::move(bufferInfos)) + , networkIds(std::move(networkIds)) + {} QVariantList identities; QVariantList bufferInfos; @@ -163,14 +184,18 @@ struct SessionState : public HandshakeMessage struct SignalProxyMessage { - inline Handler handler() const { return SignalProxy; } + inline Handler handler() const { return Handler::SignalProxy; } }; - struct SyncMessage : public SignalProxyMessage { - inline SyncMessage(const QByteArray &className, const QString &objectName, const QByteArray &slotName, const QVariantList ¶ms) - : className(className), objectName(objectName), slotName(slotName), params(params) {} + SyncMessage() = default; + SyncMessage(QByteArray className, QString objectName, QByteArray slotName, QVariantList params) + : className(std::move(className)) + , objectName(std::move(objectName)) + , slotName(std::move(slotName)) + , params(std::move(params)) + {} QByteArray className; QString objectName; @@ -178,56 +203,68 @@ struct SyncMessage : public SignalProxyMessage QVariantList params; }; - struct RpcCall : public SignalProxyMessage { - inline RpcCall(const QByteArray &slotName, const QVariantList ¶ms) - : slotName(slotName), params(params) {} + RpcCall() = default; + RpcCall(QByteArray signalName, QVariantList params) + : signalName(std::move(signalName)) + , params(std::move(params)) + {} - QByteArray slotName; + QByteArray signalName; QVariantList params; }; - struct InitRequest : public SignalProxyMessage { - inline InitRequest(const QByteArray &className, const QString &objectName) - : className(className), objectName(objectName) {} + InitRequest() = default; + InitRequest(QByteArray className, QString objectName) + : className(std::move(className)) + , objectName(std::move(objectName)) + {} QByteArray className; QString objectName; }; - struct InitData : public SignalProxyMessage { - inline InitData(const QByteArray &className, const QString &objectName, const QVariantMap &initData) - : className(className), objectName(objectName), initData(initData) {} + InitData() = default; + InitData(QByteArray className, QString objectName, QVariantMap initData) + : className(std::move(className)) + , objectName(std::move(objectName)) + , initData(std::move(initData)) + {} QByteArray className; QString objectName; QVariantMap initData; }; - /*** handled by RemoteConnection ***/ struct HeartBeat { - inline HeartBeat(const QDateTime ×tamp) : timestamp(timestamp) {} + inline HeartBeat(QDateTime timestamp) + : timestamp(std::move(timestamp)) + {} QDateTime timestamp; }; - struct HeartBeatReply { - inline HeartBeatReply(const QDateTime ×tamp) : timestamp(timestamp) {} + inline HeartBeatReply(QDateTime timestamp) + : timestamp(std::move(timestamp)) + {} QDateTime timestamp; }; +} // namespace Protocol -}; - -#endif +// Required for InternalPeer +Q_DECLARE_METATYPE(Protocol::SyncMessage) +Q_DECLARE_METATYPE(Protocol::RpcCall) +Q_DECLARE_METATYPE(Protocol::InitRequest) +Q_DECLARE_METATYPE(Protocol::InitData)