sigproxy: Modernize RPC calls (remote signals)
[quassel.git] / src / common / protocols / datastream / datastreampeer.cpp
index b7b9b36..1027c40 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-2016 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  *
  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
-#include <QtEndian>
+#include "datastreampeer.h"
+
 #include <QDataStream>
 #include <QHostAddress>
 #include <QTcpSocket>
+#include <QtEndian>
 
-#include "datastreampeer.h"
+#include "quassel.h"
+
+#include "serializers/serializers.h"
 
 using namespace Protocol;
 
-DataStreamPeer::DataStreamPeer(::AuthHandler *authHandler, QTcpSocket *socket, quint16 features, Compressor::CompressionLevel level, QObject *parent)
+DataStreamPeer::DataStreamPeer(
+    ::AuthHandler* authHandler, QTcpSocket* socket, quint16 features, Compressor::CompressionLevel level, QObject* parent)
     : RemotePeer(authHandler, socket, level, parent)
 {
     Q_UNUSED(features);
 }
 
-
 quint16 DataStreamPeer::supportedFeatures()
 {
     return 0;
 }
 
-
 bool DataStreamPeer::acceptsFeatures(quint16 peerFeatures)
 {
     Q_UNUSED(peerFeatures);
     return true;
 }
 
-
 quint16 DataStreamPeer::enabledFeatures() const
 {
     return 0;
 }
 
-
-void DataStreamPeer::processMessage(const QByteArray &msg)
+void DataStreamPeer::processMessage(const QByteArray& msg)
 {
     QDataStream stream(msg);
     stream.setVersion(QDataStream::Qt_4_2);
     QVariantList list;
-    stream >> list;
+    if (!Serializers::deserialize(stream, features(), list))
+        close("Peer sent corrupt data, closing down!");
     if (stream.status() != QDataStream::Ok) {
         close("Peer sent corrupt data, closing down!");
         return;
@@ -71,8 +73,7 @@ void DataStreamPeer::processMessage(const QByteArray &msg)
         handlePackedFunc(list);
 }
 
-
-void DataStreamPeer::writeMessage(const QVariantMap &handshakeMsg)
+void DataStreamPeer::writeMessage(const QVariantMap& handshakeMsg)
 {
     QVariantList list;
     QVariantMap::const_iterator it = handshakeMsg.begin();
@@ -84,8 +85,7 @@ void DataStreamPeer::writeMessage(const QVariantMap &handshakeMsg)
     writeMessage(list);
 }
 
-
-void DataStreamPeer::writeMessage(const QVariantList &sigProxyMsg)
+void DataStreamPeer::writeMessage(const QVariantList& sigProxyMsg)
 {
     QByteArray data;
     QDataStream msgStream(&data, QIODevice::WriteOnly);
@@ -95,7 +95,6 @@ void DataStreamPeer::writeMessage(const QVariantList &sigProxyMsg)
     writeMessage(data);
 }
 
-
 /*** Handshake messages ***/
 
 /* These messages are transmitted during handshake phase, which in case of the legacy protocol means they have
@@ -103,11 +102,11 @@ void DataStreamPeer::writeMessage(const QVariantList &sigProxyMsg)
  * Also, the legacy handshake does not fully match the redesigned one, so we'll have to do various mappings here.
  */
 
-void DataStreamPeer::handleHandshakeMessage(const QVariantList &mapData)
+void DataStreamPeer::handleHandshakeMessage(const QVariantListmapData)
 {
     QVariantMap m;
-    for (int i = 0; i < mapData.count()/2; ++i)
-        m[QString::fromUtf8(mapData[2*i].toByteArray())] = mapData[2*i+1];
+    for (int i = 0; i < mapData.count() / 2; ++i)
+        m[QString::fromUtf8(mapData[2 * i].toByteArray())] = mapData[2 * i + 1];
 
     QString msgType = m["MsgType"].toString();
     if (msgType.isEmpty()) {
@@ -116,7 +115,12 @@ void DataStreamPeer::handleHandshakeMessage(const QVariantList &mapData)
     }
 
     if (msgType == "ClientInit") {
-        handle(RegisterClient(m["ClientVersion"].toString(), m["ClientDate"].toString(), false)); // UseSsl obsolete
+        handle(RegisterClient{
+            Quassel::Features{m["FeatureList"].toStringList(), Quassel::LegacyFeatures(m["Features"].toUInt())},
+            m["ClientVersion"].toString(),
+            m["ClientDate"].toString(),
+            false  // UseSsl obsolete
+        });
     }
 
     else if (msgType == "ClientInitReject") {
@@ -124,12 +128,23 @@ void DataStreamPeer::handleHandshakeMessage(const QVariantList &mapData)
     }
 
     else if (msgType == "ClientInitAck") {
-        handle(ClientRegistered(m["CoreFeatures"].toUInt(), m["Configured"].toBool(), m["StorageBackends"].toList(), false, QString())); // SupportsSsl and coreInfo obsolete
+        handle(ClientRegistered{
+            Quassel::Features{m["FeatureList"].toStringList(), Quassel::LegacyFeatures(m["CoreFeatures"].toUInt())},
+            m["Configured"].toBool(),
+            m["StorageBackends"].toList(),
+            m["Authenticators"].toList(),
+            false  // SupportsSsl obsolete
+        });
     }
 
     else if (msgType == "CoreSetupData") {
         QVariantMap map = m["SetupData"].toMap();
-        handle(SetupData(map["AdminUser"].toString(), map["AdminPasswd"].toString(), map["Backend"].toString(), map["ConnectionProperties"].toMap()));
+        handle(SetupData(map["AdminUser"].toString(),
+                         map["AdminPasswd"].toString(),
+                         map["Backend"].toString(),
+                         map["ConnectionProperties"].toMap(),
+                         map["Authenticator"].toString(),
+                         map["AuthProperties"].toMap()));
     }
 
     else if (msgType == "CoreSetupReject") {
@@ -162,18 +177,20 @@ void DataStreamPeer::handleHandshakeMessage(const QVariantList &mapData)
     }
 }
 
-
-void DataStreamPeer::dispatch(const RegisterClient &msg) {
+void DataStreamPeer::dispatch(const RegisterClient& msg)
+{
     QVariantMap m;
     m["MsgType"] = "ClientInit";
+    m["Features"] = static_cast<quint32>(msg.features.toLegacyFeatures());
+    m["FeatureList"] = msg.features.toStringList();
     m["ClientVersion"] = msg.clientVersion;
     m["ClientDate"] = msg.buildDate;
 
     writeMessage(m);
 }
 
-
-void DataStreamPeer::dispatch(const ClientDenied &msg) {
+void DataStreamPeer::dispatch(const ClientDenied& msg)
+{
     QVariantMap m;
     m["MsgType"] = "ClientInitReject";
     m["Error"] = msg.errorString;
@@ -181,19 +198,26 @@ void DataStreamPeer::dispatch(const ClientDenied &msg) {
     writeMessage(m);
 }
 
-
-void DataStreamPeer::dispatch(const ClientRegistered &msg) {
+void DataStreamPeer::dispatch(const ClientRegistered& msg)
+{
     QVariantMap m;
     m["MsgType"] = "ClientInitAck";
-    m["CoreFeatures"] = msg.coreFeatures;
-    m["StorageBackends"] = msg.backendInfo;
+    if (hasFeature(Quassel::Feature::ExtendedFeatures)) {
+        m["FeatureList"] = msg.features.toStringList();
+    }
+    else {
+        m["CoreFeatures"] = static_cast<quint32>(msg.features.toLegacyFeatures());
+    }
     m["LoginEnabled"] = m["Configured"] = msg.coreConfigured;
+    m["StorageBackends"] = msg.backendInfo;
+    if (hasFeature(Quassel::Feature::Authenticators)) {
+        m["Authenticators"] = msg.authenticatorInfo;
+    }
 
     writeMessage(m);
 }
 
-
-void DataStreamPeer::dispatch(const SetupData &msg)
+void DataStreamPeer::dispatch(const SetupData& msg)
 {
     QVariantMap map;
     map["AdminUser"] = msg.adminUser;
@@ -201,6 +225,10 @@ void DataStreamPeer::dispatch(const SetupData &msg)
     map["Backend"] = msg.backend;
     map["ConnectionProperties"] = msg.setupData;
 
+    // Auth backend properties.
+    map["Authenticator"] = msg.authenticator;
+    map["AuthProperties"] = msg.authSetupData;
+
     QVariantMap m;
     m["MsgType"] = "CoreSetupData";
     m["SetupData"] = map;
@@ -208,8 +236,7 @@ void DataStreamPeer::dispatch(const SetupData &msg)
     writeMessage(m);
 }
 
-
-void DataStreamPeer::dispatch(const SetupFailed &msg)
+void DataStreamPeer::dispatch(const SetupFailed& msg)
 {
     QVariantMap m;
     m["MsgType"] = "CoreSetupReject";
@@ -218,8 +245,7 @@ void DataStreamPeer::dispatch(const SetupFailed &msg)
     writeMessage(m);
 }
 
-
-void DataStreamPeer::dispatch(const SetupDone &msg)
+void DataStreamPeer::dispatch(const SetupDone& msg)
 {
     Q_UNUSED(msg)
 
@@ -229,8 +255,7 @@ void DataStreamPeer::dispatch(const SetupDone &msg)
     writeMessage(m);
 }
 
-
-void DataStreamPeer::dispatch(const Login &msg)
+void DataStreamPeer::dispatch(const Login& msg)
 {
     QVariantMap m;
     m["MsgType"] = "ClientLogin";
@@ -240,8 +265,7 @@ void DataStreamPeer::dispatch(const Login &msg)
     writeMessage(m);
 }
 
-
-void DataStreamPeer::dispatch(const LoginFailed &msg)
+void DataStreamPeer::dispatch(const LoginFailed& msg)
 {
     QVariantMap m;
     m["MsgType"] = "ClientLoginReject";
@@ -250,8 +274,7 @@ void DataStreamPeer::dispatch(const LoginFailed &msg)
     writeMessage(m);
 }
 
-
-void DataStreamPeer::dispatch(const LoginSuccess &msg)
+void DataStreamPeer::dispatch(const LoginSuccess& msg)
 {
     Q_UNUSED(msg)
 
@@ -261,8 +284,7 @@ void DataStreamPeer::dispatch(const LoginSuccess &msg)
     writeMessage(m);
 }
 
-
-void DataStreamPeer::dispatch(const SessionState &msg)
+void DataStreamPeer::dispatch(const SessionState& msg)
 {
     QVariantMap m;
     m["MsgType"] = "SessionInit";
@@ -276,10 +298,9 @@ void DataStreamPeer::dispatch(const SessionState &msg)
     writeMessage(m);
 }
 
-
 /*** Standard messages ***/
 
-void DataStreamPeer::handlePackedFunc(const QVariantList &packedFunc)
+void DataStreamPeer::handlePackedFunc(const QVariantListpackedFunc)
 {
     QVariantList params(packedFunc);
 
@@ -291,91 +312,86 @@ void DataStreamPeer::handlePackedFunc(const QVariantList &packedFunc)
     // TODO: make sure that this is a valid request type
     RequestType requestType = (RequestType)params.takeFirst().value<qint16>();
     switch (requestType) {
-        case Sync: {
-            if (params.count() < 3) {
-                qWarning() << Q_FUNC_INFO << "Received invalid sync call:" << params;
-                return;
-            }
-            QByteArray className = params.takeFirst().toByteArray();
-            QString objectName = QString::fromUtf8(params.takeFirst().toByteArray());
-            QByteArray slotName = params.takeFirst().toByteArray();
-            handle(Protocol::SyncMessage(className, objectName, slotName, params));
-            break;
+    case Sync: {
+        if (params.count() < 3) {
+            qWarning() << Q_FUNC_INFO << "Received invalid sync call:" << params;
+            return;
         }
-        case RpcCall: {
-            if (params.empty()) {
-                qWarning() << Q_FUNC_INFO << "Received empty RPC call!";
-                return;
-            }
-            QByteArray slotName = params.takeFirst().toByteArray();
-            handle(Protocol::RpcCall(slotName, params));
-            break;
+        QByteArray className = params.takeFirst().toByteArray();
+        QString objectName = QString::fromUtf8(params.takeFirst().toByteArray());
+        QByteArray slotName = params.takeFirst().toByteArray();
+        handle(Protocol::SyncMessage(className, objectName, slotName, params));
+        break;
+    }
+    case RpcCall: {
+        if (params.empty()) {
+            qWarning() << Q_FUNC_INFO << "Received empty RPC call!";
+            return;
         }
-        case InitRequest: {
-            if (params.count() != 2) {
-                qWarning() << Q_FUNC_INFO << "Received invalid InitRequest:" << params;
-                return;
-            }
-            QByteArray className = params[0].toByteArray();
-            QString objectName = QString::fromUtf8(params[1].toByteArray());
-            handle(Protocol::InitRequest(className, objectName));
-            break;
+        QByteArray signalName = params.takeFirst().toByteArray();
+        handle(Protocol::RpcCall(signalName, params));
+        break;
+    }
+    case InitRequest: {
+        if (params.count() != 2) {
+            qWarning() << Q_FUNC_INFO << "Received invalid InitRequest:" << params;
+            return;
         }
-        case InitData: {
-            if (params.count() < 2) {
-                qWarning() << Q_FUNC_INFO << "Received invalid InitData:" << params;
-                return;
-            }
-            QByteArray className = params.takeFirst().toByteArray();
-            QString objectName = QString::fromUtf8(params.takeFirst().toByteArray());
-            QVariantMap initData;
-            for (int i = 0; i < params.count()/2; ++i)
-                initData[QString::fromUtf8(params[2*i].toByteArray())] = params[2*i+1];
-            handle(Protocol::InitData(className, objectName, initData));
-            break;
+        QByteArray className = params[0].toByteArray();
+        QString objectName = QString::fromUtf8(params[1].toByteArray());
+        handle(Protocol::InitRequest(className, objectName));
+        break;
+    }
+    case InitData: {
+        if (params.count() < 2) {
+            qWarning() << Q_FUNC_INFO << "Received invalid InitData:" << params;
+            return;
         }
-        case HeartBeat: {
-            if (params.count() != 1) {
-                qWarning() << Q_FUNC_INFO << "Received invalid HeartBeat:" << params;
-                return;
-            }
-            // Note: QDateTime instead of QTime as in the legacy protocol!
-            handle(Protocol::HeartBeat(params[0].toDateTime()));
-            break;
+        QByteArray className = params.takeFirst().toByteArray();
+        QString objectName = QString::fromUtf8(params.takeFirst().toByteArray());
+        QVariantMap initData;
+        for (int i = 0; i < params.count() / 2; ++i)
+            initData[QString::fromUtf8(params[2 * i].toByteArray())] = params[2 * i + 1];
+        handle(Protocol::InitData(className, objectName, initData));
+        break;
+    }
+    case HeartBeat: {
+        if (params.count() != 1) {
+            qWarning() << Q_FUNC_INFO << "Received invalid HeartBeat:" << params;
+            return;
         }
-        case HeartBeatReply: {
-            if (params.count() != 1) {
-                qWarning() << Q_FUNC_INFO << "Received invalid HeartBeat:" << params;
-                return;
-            }
-            // Note: QDateTime instead of QTime as in the legacy protocol!
-            handle(Protocol::HeartBeatReply(params[0].toDateTime()));
-            break;
+        // Note: QDateTime instead of QTime as in the legacy protocol!
+        handle(Protocol::HeartBeat(params[0].toDateTime()));
+        break;
+    }
+    case HeartBeatReply: {
+        if (params.count() != 1) {
+            qWarning() << Q_FUNC_INFO << "Received invalid HeartBeat:" << params;
+            return;
         }
-
+        // Note: QDateTime instead of QTime as in the legacy protocol!
+        handle(Protocol::HeartBeatReply(params[0].toDateTime()));
+        break;
+    }
     }
 }
 
-
-void DataStreamPeer::dispatch(const Protocol::SyncMessage &msg)
+void DataStreamPeer::dispatch(const Protocol::SyncMessage& msg)
 {
     dispatchPackedFunc(QVariantList() << (qint16)Sync << msg.className << msg.objectName.toUtf8() << msg.slotName << msg.params);
 }
 
-
-void DataStreamPeer::dispatch(const Protocol::RpcCall &msg)
+void DataStreamPeer::dispatch(const Protocol::RpcCall& msg)
 {
-    dispatchPackedFunc(QVariantList() << (qint16)RpcCall << msg.slotName << msg.params);
+    dispatchPackedFunc(QVariantList() << (qint16)RpcCall << msg.signalName << msg.params);
 }
 
-
-void DataStreamPeer::dispatch(const Protocol::InitRequest &msg)
+void DataStreamPeer::dispatch(const Protocol::InitRequest& msg)
 {
     dispatchPackedFunc(QVariantList() << (qint16)InitRequest << msg.className << msg.objectName.toUtf8());
 }
 
-
-void DataStreamPeer::dispatch(const Protocol::InitData &msg)
+void DataStreamPeer::dispatch(const Protocol::InitData& msg)
 {
     QVariantList initData;
     QVariantMap::const_iterator it = msg.initData.begin();
@@ -386,20 +402,17 @@ void DataStreamPeer::dispatch(const Protocol::InitData &msg)
     dispatchPackedFunc(QVariantList() << (qint16)InitData << msg.className << msg.objectName.toUtf8() << initData);
 }
 
-
-void DataStreamPeer::dispatch(const Protocol::HeartBeat &msg)
+void DataStreamPeer::dispatch(const Protocol::HeartBeat& msg)
 {
     dispatchPackedFunc(QVariantList() << (qint16)HeartBeat << msg.timestamp);
 }
 
-
-void DataStreamPeer::dispatch(const Protocol::HeartBeatReply &msg)
+void DataStreamPeer::dispatch(const Protocol::HeartBeatReply& msg)
 {
     dispatchPackedFunc(QVariantList() << (qint16)HeartBeatReply << msg.timestamp);
 }
 
-
-void DataStreamPeer::dispatchPackedFunc(const QVariantList &packedFunc)
+void DataStreamPeer::dispatchPackedFunc(const QVariantList& packedFunc)
 {
     writeMessage(packedFunc);
 }