common: Make InternalPeer (more) thread-safe

[quassel.git] / src / common / protocol.h

diff --git a/src/common/protocol.h b/src/common/protocol.h
index 89625f4..2453a52 100644 (file)
--- a/src/common/protocol.h
+++ b/src/common/protocol.h
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2013 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,32 +18,180 @@
  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
-#ifndef PROTOCOL_H_
-#define PROTOCOL_H_
+#pragma once
 
 #include <QByteArray>
 #include <QDateTime>
 #include <QVariantList>
 
+#include "quassel.h"
+
 namespace Protocol {
 
-enum Handler {
-    SignalProxy
+const quint32 magic = 0x42b33f00;
+
+enum Type {
+    InternalProtocol = 0x00,
+    LegacyProtocol = 0x01,
+    DataStreamProtocol = 0x02
+};
+
+
+enum Feature {
+    Encryption = 0x01,
+    Compression = 0x02
+};
+
+
+enum class Handler {
+    SignalProxy,
+    AuthHandler
+};
+
+
+/*** Handshake, handled by AuthHandler ***/
+
+struct HandshakeMessage {
+    inline Handler handler() const { return Handler::AuthHandler; }
+};
+
+
+struct RegisterClient : public HandshakeMessage
+{
+    inline RegisterClient(Quassel::Features clientFeatures, const QString &clientVersion, const QString &buildDate, bool sslSupported = false)
+        : features(std::move(clientFeatures))
+        , clientVersion(clientVersion)
+        , buildDate(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) {}
+
+    QString errorString;
+};
+
+
+struct ClientRegistered : public HandshakeMessage
+{
+    inline ClientRegistered(Quassel::Features coreFeatures, bool coreConfigured, const QVariantList &backendInfo, const QVariantList &authenticatorInfo, bool sslSupported)
+        : features(std::move(coreFeatures))
+        , coreConfigured(coreConfigured)
+        , backendInfo(backendInfo)
+        , authenticatorInfo(authenticatorInfo)
+        , sslSupported(sslSupported)
+    {}
+
+    Quassel::Features features;
+    bool coreConfigured;
+    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;
+};
+
+
+struct SetupData : public HandshakeMessage
+{
+    inline SetupData(const QString &adminUser, const QString &adminPassword, const QString &backend,
+                     const QVariantMap &setupData, const QString &authenticator = QString(),
+                     const QVariantMap &authSetupData = QVariantMap())
+    : adminUser(adminUser)
+    , adminPassword(adminPassword)
+    , backend(backend)
+    , setupData(setupData)
+    , authenticator(authenticator)
+    , authSetupData(authSetupData)
+    {}
+
+    QString adminUser;
+    QString adminPassword;
+    QString backend;
+    QVariantMap setupData;
+    QString authenticator;
+    QVariantMap authSetupData;
+};
+
+
+struct SetupFailed : public HandshakeMessage
+{
+    inline SetupFailed(const QString &errorString)
+    : errorString(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) {}
+
+    QString user;
+    QString password;
+};
+
+
+struct LoginFailed : public HandshakeMessage
+{
+    inline LoginFailed(const QString &errorString)
+    : errorString(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) {}
+
+    QVariantList identities;
+    QVariantList bufferInfos;
+    QVariantList networkIds;
+};
+
 /*** handled by SignalProxy ***/
 
 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 &params)
-    : className(className), objectName(objectName), slotName(slotName), params(params) {}
+    SyncMessage() = default;
+    SyncMessage(const QByteArray &className, const QString &objectName, const QByteArray &slotName, const QVariantList &params)
+        : className(className), objectName(objectName), slotName(slotName), params(params) {}
 
     QByteArray className;
     QString objectName;
@@ -54,8 +202,9 @@ struct SyncMessage : public SignalProxyMessage
 
 struct RpcCall : public SignalProxyMessage
 {
-    inline RpcCall(const QByteArray &slotName, const QVariantList &params)
-    : slotName(slotName), params(params) {}
+    RpcCall() = default;
+    RpcCall(const QByteArray &slotName, const QVariantList &params)
+        : slotName(slotName), params(params) {}
 
     QByteArray slotName;
     QVariantList params;
@@ -64,8 +213,9 @@ struct RpcCall : public SignalProxyMessage
 
 struct InitRequest : public SignalProxyMessage
 {
-    inline InitRequest(const QByteArray &className, const QString &objectName)
-    : className(className), objectName(objectName) {}
+    InitRequest() = default;
+    InitRequest(const QByteArray &className, const QString &objectName)
+        : className(className), objectName(objectName) {}
 
     QByteArray className;
     QString objectName;
@@ -74,8 +224,9 @@ struct InitRequest : public SignalProxyMessage
 
 struct InitData : public SignalProxyMessage
 {
-    inline InitData(const QByteArray &className, const QString &objectName, const QVariantMap &initData)
-    : className(className), objectName(objectName), initData(initData) {}
+    InitData() = default;
+    InitData(const QByteArray &className, const QString &objectName, const QVariantMap &initData)
+        : className(className), objectName(objectName), initData(initData) {}
 
     QByteArray className;
     QString objectName;
@@ -103,4 +254,8 @@ struct HeartBeatReply
 
 };
 
-#endif
+// Required for InternalPeer
+Q_DECLARE_METATYPE(Protocol::SyncMessage)
+Q_DECLARE_METATYPE(Protocol::RpcCall)
+Q_DECLARE_METATYPE(Protocol::InitRequest)
+Q_DECLARE_METATYPE(Protocol::InitData)