1 /***************************************************************************
2 * Copyright (C) 2005-2018 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 ***************************************************************************/
22 #include <QDataStream>
23 #include <QHostAddress>
26 #include "datastreampeer.h"
28 #include "serializers/serializers.h"
30 using namespace Protocol;
32 DataStreamPeer::DataStreamPeer(::AuthHandler *authHandler, QTcpSocket *socket, quint16 features, Compressor::CompressionLevel level, QObject *parent)
33 : RemotePeer(authHandler, socket, level, parent)
39 quint16 DataStreamPeer::supportedFeatures()
45 bool DataStreamPeer::acceptsFeatures(quint16 peerFeatures)
47 Q_UNUSED(peerFeatures);
52 quint16 DataStreamPeer::enabledFeatures() const
58 void DataStreamPeer::processMessage(const QByteArray &msg)
60 QDataStream stream(msg);
61 stream.setVersion(QDataStream::Qt_4_2);
63 if (!Serializers::deserialize(stream, features(), list))
64 close("Peer sent corrupt data, closing down!");
65 if (stream.status() != QDataStream::Ok) {
66 close("Peer sent corrupt data, closing down!");
70 // if no sigproxy is set, we're in handshake mode
72 handleHandshakeMessage(list);
74 handlePackedFunc(list);
78 void DataStreamPeer::writeMessage(const QVariantMap &handshakeMsg)
81 QVariantMap::const_iterator it = handshakeMsg.begin();
82 while (it != handshakeMsg.end()) {
83 list << it.key().toUtf8() << it.value();
91 void DataStreamPeer::writeMessage(const QVariantList &sigProxyMsg)
94 QDataStream msgStream(&data, QIODevice::WriteOnly);
95 msgStream.setVersion(QDataStream::Qt_4_2);
96 msgStream << sigProxyMsg;
102 /*** Handshake messages ***/
104 /* These messages are transmitted during handshake phase, which in case of the legacy protocol means they have
105 * a structure different from those being used after the handshake.
106 * Also, the legacy handshake does not fully match the redesigned one, so we'll have to do various mappings here.
109 void DataStreamPeer::handleHandshakeMessage(const QVariantList &mapData)
112 for (int i = 0; i < mapData.count()/2; ++i)
113 m[QString::fromUtf8(mapData[2*i].toByteArray())] = mapData[2*i+1];
115 QString msgType = m["MsgType"].toString();
116 if (msgType.isEmpty()) {
117 emit protocolError(tr("Invalid handshake message!"));
121 if (msgType == "ClientInit") {
122 handle(RegisterClient{Quassel::Features{m["FeatureList"].toStringList(), Quassel::LegacyFeatures(m["Features"].toUInt())},
123 m["ClientVersion"].toString(),
124 m["ClientDate"].toString(),
125 false // UseSsl obsolete
129 else if (msgType == "ClientInitReject") {
130 handle(ClientDenied(m["Error"].toString()));
133 else if (msgType == "ClientInitAck") {
134 handle(ClientRegistered{Quassel::Features{m["FeatureList"].toStringList(), Quassel::LegacyFeatures(m["CoreFeatures"].toUInt())},
135 m["Configured"].toBool(),
136 m["StorageBackends"].toList(),
137 m["Authenticators"].toList(),
138 false // SupportsSsl obsolete
142 else if (msgType == "CoreSetupData") {
143 QVariantMap map = m["SetupData"].toMap();
144 handle(SetupData(map["AdminUser"].toString(), map["AdminPasswd"].toString(), map["Backend"].toString(), map["ConnectionProperties"].toMap(), map["Authenticator"].toString(), map["AuthProperties"].toMap()));
147 else if (msgType == "CoreSetupReject") {
148 handle(SetupFailed(m["Error"].toString()));
151 else if (msgType == "CoreSetupAck") {
155 else if (msgType == "ClientLogin") {
156 handle(Login(m["User"].toString(), m["Password"].toString()));
159 else if (msgType == "ClientLoginReject") {
160 handle(LoginFailed(m["Error"].toString()));
163 else if (msgType == "ClientLoginAck") {
164 handle(LoginSuccess());
167 else if (msgType == "SessionInit") {
168 QVariantMap map = m["SessionState"].toMap();
169 handle(SessionState(map["Identities"].toList(), map["BufferInfos"].toList(), map["NetworkIds"].toList()));
173 emit protocolError(tr("Unknown protocol message of type %1").arg(msgType));
178 void DataStreamPeer::dispatch(const RegisterClient &msg) {
180 m["MsgType"] = "ClientInit";
181 m["Features"] = static_cast<quint32>(msg.features.toLegacyFeatures());
182 m["FeatureList"] = msg.features.toStringList();
183 m["ClientVersion"] = msg.clientVersion;
184 m["ClientDate"] = msg.buildDate;
190 void DataStreamPeer::dispatch(const ClientDenied &msg) {
192 m["MsgType"] = "ClientInitReject";
193 m["Error"] = msg.errorString;
199 void DataStreamPeer::dispatch(const ClientRegistered &msg) {
201 m["MsgType"] = "ClientInitAck";
202 if (hasFeature(Quassel::Feature::ExtendedFeatures)) {
203 m["FeatureList"] = msg.features.toStringList();
206 m["CoreFeatures"] = static_cast<quint32>(msg.features.toLegacyFeatures());
208 m["LoginEnabled"] = m["Configured"] = msg.coreConfigured;
209 m["StorageBackends"] = msg.backendInfo;
210 if (hasFeature(Quassel::Feature::Authenticators)) {
211 m["Authenticators"] = msg.authenticatorInfo;
218 void DataStreamPeer::dispatch(const SetupData &msg)
221 map["AdminUser"] = msg.adminUser;
222 map["AdminPasswd"] = msg.adminPassword;
223 map["Backend"] = msg.backend;
224 map["ConnectionProperties"] = msg.setupData;
226 // Auth backend properties.
227 map["Authenticator"] = msg.authenticator;
228 map["AuthProperties"] = msg.authSetupData;
231 m["MsgType"] = "CoreSetupData";
232 m["SetupData"] = map;
238 void DataStreamPeer::dispatch(const SetupFailed &msg)
241 m["MsgType"] = "CoreSetupReject";
242 m["Error"] = msg.errorString;
248 void DataStreamPeer::dispatch(const SetupDone &msg)
253 m["MsgType"] = "CoreSetupAck";
259 void DataStreamPeer::dispatch(const Login &msg)
262 m["MsgType"] = "ClientLogin";
263 m["User"] = msg.user;
264 m["Password"] = msg.password;
270 void DataStreamPeer::dispatch(const LoginFailed &msg)
273 m["MsgType"] = "ClientLoginReject";
274 m["Error"] = msg.errorString;
280 void DataStreamPeer::dispatch(const LoginSuccess &msg)
285 m["MsgType"] = "ClientLoginAck";
291 void DataStreamPeer::dispatch(const SessionState &msg)
294 m["MsgType"] = "SessionInit";
297 map["BufferInfos"] = msg.bufferInfos;
298 map["NetworkIds"] = msg.networkIds;
299 map["Identities"] = msg.identities;
300 m["SessionState"] = map;
306 /*** Standard messages ***/
308 void DataStreamPeer::handlePackedFunc(const QVariantList &packedFunc)
310 QVariantList params(packedFunc);
312 if (params.isEmpty()) {
313 qWarning() << Q_FUNC_INFO << "Received incompatible data:" << packedFunc;
317 // TODO: make sure that this is a valid request type
318 RequestType requestType = (RequestType)params.takeFirst().value<qint16>();
319 switch (requestType) {
321 if (params.count() < 3) {
322 qWarning() << Q_FUNC_INFO << "Received invalid sync call:" << params;
325 QByteArray className = params.takeFirst().toByteArray();
326 QString objectName = QString::fromUtf8(params.takeFirst().toByteArray());
327 QByteArray slotName = params.takeFirst().toByteArray();
328 handle(Protocol::SyncMessage(className, objectName, slotName, params));
332 if (params.empty()) {
333 qWarning() << Q_FUNC_INFO << "Received empty RPC call!";
336 QByteArray slotName = params.takeFirst().toByteArray();
337 handle(Protocol::RpcCall(slotName, params));
341 if (params.count() != 2) {
342 qWarning() << Q_FUNC_INFO << "Received invalid InitRequest:" << params;
345 QByteArray className = params[0].toByteArray();
346 QString objectName = QString::fromUtf8(params[1].toByteArray());
347 handle(Protocol::InitRequest(className, objectName));
351 if (params.count() < 2) {
352 qWarning() << Q_FUNC_INFO << "Received invalid InitData:" << params;
355 QByteArray className = params.takeFirst().toByteArray();
356 QString objectName = QString::fromUtf8(params.takeFirst().toByteArray());
357 QVariantMap initData;
358 for (int i = 0; i < params.count()/2; ++i)
359 initData[QString::fromUtf8(params[2*i].toByteArray())] = params[2*i+1];
360 handle(Protocol::InitData(className, objectName, initData));
364 if (params.count() != 1) {
365 qWarning() << Q_FUNC_INFO << "Received invalid HeartBeat:" << params;
368 // Note: QDateTime instead of QTime as in the legacy protocol!
369 handle(Protocol::HeartBeat(params[0].toDateTime()));
372 case HeartBeatReply: {
373 if (params.count() != 1) {
374 qWarning() << Q_FUNC_INFO << "Received invalid HeartBeat:" << params;
377 // Note: QDateTime instead of QTime as in the legacy protocol!
378 handle(Protocol::HeartBeatReply(params[0].toDateTime()));
386 void DataStreamPeer::dispatch(const Protocol::SyncMessage &msg)
388 dispatchPackedFunc(QVariantList() << (qint16)Sync << msg.className << msg.objectName.toUtf8() << msg.slotName << msg.params);
392 void DataStreamPeer::dispatch(const Protocol::RpcCall &msg)
394 dispatchPackedFunc(QVariantList() << (qint16)RpcCall << msg.slotName << msg.params);
398 void DataStreamPeer::dispatch(const Protocol::InitRequest &msg)
400 dispatchPackedFunc(QVariantList() << (qint16)InitRequest << msg.className << msg.objectName.toUtf8());
404 void DataStreamPeer::dispatch(const Protocol::InitData &msg)
406 QVariantList initData;
407 QVariantMap::const_iterator it = msg.initData.begin();
408 while (it != msg.initData.end()) {
409 initData << it.key().toUtf8() << it.value();
412 dispatchPackedFunc(QVariantList() << (qint16)InitData << msg.className << msg.objectName.toUtf8() << initData);
416 void DataStreamPeer::dispatch(const Protocol::HeartBeat &msg)
418 dispatchPackedFunc(QVariantList() << (qint16)HeartBeat << msg.timestamp);
422 void DataStreamPeer::dispatch(const Protocol::HeartBeatReply &msg)
424 dispatchPackedFunc(QVariantList() << (qint16)HeartBeatReply << msg.timestamp);
428 void DataStreamPeer::dispatchPackedFunc(const QVariantList &packedFunc)
430 writeMessage(packedFunc);