1 /***************************************************************************
2 * Copyright (C) 2005-2016 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"
29 using namespace Protocol;
31 DataStreamPeer::DataStreamPeer(::AuthHandler *authHandler, QTcpSocket *socket, quint16 features, Compressor::CompressionLevel level, QObject *parent)
32 : RemotePeer(authHandler, socket, level, parent)
38 quint16 DataStreamPeer::supportedFeatures()
44 bool DataStreamPeer::acceptsFeatures(quint16 peerFeatures)
46 Q_UNUSED(peerFeatures);
51 quint16 DataStreamPeer::enabledFeatures() const
57 void DataStreamPeer::processMessage(const QByteArray &msg)
59 QDataStream stream(msg);
60 stream.setVersion(QDataStream::Qt_4_2);
63 if (stream.status() != QDataStream::Ok) {
64 close("Peer sent corrupt data, closing down!");
68 // if no sigproxy is set, we're in handshake mode
70 handleHandshakeMessage(list);
72 handlePackedFunc(list);
76 void DataStreamPeer::writeMessage(const QVariantMap &handshakeMsg)
79 QVariantMap::const_iterator it = handshakeMsg.begin();
80 while (it != handshakeMsg.end()) {
81 list << it.key().toUtf8() << it.value();
89 void DataStreamPeer::writeMessage(const QVariantList &sigProxyMsg)
92 QDataStream msgStream(&data, QIODevice::WriteOnly);
93 msgStream.setVersion(QDataStream::Qt_4_2);
94 msgStream << sigProxyMsg;
100 /*** Handshake messages ***/
102 /* These messages are transmitted during handshake phase, which in case of the legacy protocol means they have
103 * a structure different from those being used after the handshake.
104 * Also, the legacy handshake does not fully match the redesigned one, so we'll have to do various mappings here.
107 void DataStreamPeer::handleHandshakeMessage(const QVariantList &mapData)
110 for (int i = 0; i < mapData.count()/2; ++i)
111 m[QString::fromUtf8(mapData[2*i].toByteArray())] = mapData[2*i+1];
113 QString msgType = m["MsgType"].toString();
114 if (msgType.isEmpty()) {
115 emit protocolError(tr("Invalid handshake message!"));
119 if (msgType == "ClientInit") {
120 handle(RegisterClient{Quassel::Features{m["FeatureList"].toStringList(), Quassel::LegacyFeatures(m["Features"].toUInt())},
121 m["ClientVersion"].toString(),
122 m["ClientDate"].toString(),
123 false // UseSsl obsolete
127 else if (msgType == "ClientInitReject") {
128 handle(ClientDenied(m["Error"].toString()));
131 else if (msgType == "ClientInitAck") {
132 handle(ClientRegistered{Quassel::Features{m["FeatureList"].toStringList(), Quassel::LegacyFeatures(m["CoreFeatures"].toUInt())},
133 m["Configured"].toBool(),
134 m["StorageBackends"].toList(),
135 m["Authenticators"].toList(),
136 false // SupportsSsl obsolete
140 else if (msgType == "CoreSetupData") {
141 QVariantMap map = m["SetupData"].toMap();
142 handle(SetupData(map["AdminUser"].toString(), map["AdminPasswd"].toString(), map["Backend"].toString(), map["ConnectionProperties"].toMap(), map["Authenticator"].toString(), map["AuthProperties"].toMap()));
145 else if (msgType == "CoreSetupReject") {
146 handle(SetupFailed(m["Error"].toString()));
149 else if (msgType == "CoreSetupAck") {
153 else if (msgType == "ClientLogin") {
154 handle(Login(m["User"].toString(), m["Password"].toString()));
157 else if (msgType == "ClientLoginReject") {
158 handle(LoginFailed(m["Error"].toString()));
161 else if (msgType == "ClientLoginAck") {
162 handle(LoginSuccess());
165 else if (msgType == "SessionInit") {
166 QVariantMap map = m["SessionState"].toMap();
167 handle(SessionState(map["Identities"].toList(), map["BufferInfos"].toList(), map["NetworkIds"].toList()));
171 emit protocolError(tr("Unknown protocol message of type %1").arg(msgType));
176 void DataStreamPeer::dispatch(const RegisterClient &msg) {
178 m["MsgType"] = "ClientInit";
179 m["Features"] = static_cast<quint32>(msg.features.toLegacyFeatures());
180 m["FeatureList"] = msg.features.toStringList();
181 m["ClientVersion"] = msg.clientVersion;
182 m["ClientDate"] = msg.buildDate;
188 void DataStreamPeer::dispatch(const ClientDenied &msg) {
190 m["MsgType"] = "ClientInitReject";
191 m["Error"] = msg.errorString;
197 void DataStreamPeer::dispatch(const ClientRegistered &msg) {
199 m["MsgType"] = "ClientInitAck";
200 if (hasFeature(Quassel::Feature::ExtendedFeatures)) {
201 m["FeatureList"] = msg.features.toStringList();
204 m["CoreFeatures"] = static_cast<quint32>(msg.features.toLegacyFeatures());
206 m["LoginEnabled"] = m["Configured"] = msg.coreConfigured;
207 m["StorageBackends"] = msg.backendInfo;
208 if (hasFeature(Quassel::Feature::Authenticators)) {
209 m["Authenticators"] = msg.authenticatorInfo;
216 void DataStreamPeer::dispatch(const SetupData &msg)
219 map["AdminUser"] = msg.adminUser;
220 map["AdminPasswd"] = msg.adminPassword;
221 map["Backend"] = msg.backend;
222 map["ConnectionProperties"] = msg.setupData;
224 // Auth backend properties.
225 map["Authenticator"] = msg.authenticator;
226 map["AuthProperties"] = msg.authSetupData;
229 m["MsgType"] = "CoreSetupData";
230 m["SetupData"] = map;
236 void DataStreamPeer::dispatch(const SetupFailed &msg)
239 m["MsgType"] = "CoreSetupReject";
240 m["Error"] = msg.errorString;
246 void DataStreamPeer::dispatch(const SetupDone &msg)
251 m["MsgType"] = "CoreSetupAck";
257 void DataStreamPeer::dispatch(const Login &msg)
260 m["MsgType"] = "ClientLogin";
261 m["User"] = msg.user;
262 m["Password"] = msg.password;
268 void DataStreamPeer::dispatch(const LoginFailed &msg)
271 m["MsgType"] = "ClientLoginReject";
272 m["Error"] = msg.errorString;
278 void DataStreamPeer::dispatch(const LoginSuccess &msg)
283 m["MsgType"] = "ClientLoginAck";
289 void DataStreamPeer::dispatch(const SessionState &msg)
292 m["MsgType"] = "SessionInit";
295 map["BufferInfos"] = msg.bufferInfos;
296 map["NetworkIds"] = msg.networkIds;
297 map["Identities"] = msg.identities;
298 m["SessionState"] = map;
304 /*** Standard messages ***/
306 void DataStreamPeer::handlePackedFunc(const QVariantList &packedFunc)
308 QVariantList params(packedFunc);
310 if (params.isEmpty()) {
311 qWarning() << Q_FUNC_INFO << "Received incompatible data:" << packedFunc;
315 // TODO: make sure that this is a valid request type
316 RequestType requestType = (RequestType)params.takeFirst().value<qint16>();
317 switch (requestType) {
319 if (params.count() < 3) {
320 qWarning() << Q_FUNC_INFO << "Received invalid sync call:" << params;
323 QByteArray className = params.takeFirst().toByteArray();
324 QString objectName = QString::fromUtf8(params.takeFirst().toByteArray());
325 QByteArray slotName = params.takeFirst().toByteArray();
326 handle(Protocol::SyncMessage(className, objectName, slotName, params));
330 if (params.empty()) {
331 qWarning() << Q_FUNC_INFO << "Received empty RPC call!";
334 QByteArray slotName = params.takeFirst().toByteArray();
335 handle(Protocol::RpcCall(slotName, params));
339 if (params.count() != 2) {
340 qWarning() << Q_FUNC_INFO << "Received invalid InitRequest:" << params;
343 QByteArray className = params[0].toByteArray();
344 QString objectName = QString::fromUtf8(params[1].toByteArray());
345 handle(Protocol::InitRequest(className, objectName));
349 if (params.count() < 2) {
350 qWarning() << Q_FUNC_INFO << "Received invalid InitData:" << params;
353 QByteArray className = params.takeFirst().toByteArray();
354 QString objectName = QString::fromUtf8(params.takeFirst().toByteArray());
355 QVariantMap initData;
356 for (int i = 0; i < params.count()/2; ++i)
357 initData[QString::fromUtf8(params[2*i].toByteArray())] = params[2*i+1];
358 handle(Protocol::InitData(className, objectName, initData));
362 if (params.count() != 1) {
363 qWarning() << Q_FUNC_INFO << "Received invalid HeartBeat:" << params;
366 // Note: QDateTime instead of QTime as in the legacy protocol!
367 handle(Protocol::HeartBeat(params[0].toDateTime()));
370 case HeartBeatReply: {
371 if (params.count() != 1) {
372 qWarning() << Q_FUNC_INFO << "Received invalid HeartBeat:" << params;
375 // Note: QDateTime instead of QTime as in the legacy protocol!
376 handle(Protocol::HeartBeatReply(params[0].toDateTime()));
384 void DataStreamPeer::dispatch(const Protocol::SyncMessage &msg)
386 dispatchPackedFunc(QVariantList() << (qint16)Sync << msg.className << msg.objectName.toUtf8() << msg.slotName << msg.params);
390 void DataStreamPeer::dispatch(const Protocol::RpcCall &msg)
392 dispatchPackedFunc(QVariantList() << (qint16)RpcCall << msg.slotName << msg.params);
396 void DataStreamPeer::dispatch(const Protocol::InitRequest &msg)
398 dispatchPackedFunc(QVariantList() << (qint16)InitRequest << msg.className << msg.objectName.toUtf8());
402 void DataStreamPeer::dispatch(const Protocol::InitData &msg)
404 QVariantList initData;
405 QVariantMap::const_iterator it = msg.initData.begin();
406 while (it != msg.initData.end()) {
407 initData << it.key().toUtf8() << it.value();
410 dispatchPackedFunc(QVariantList() << (qint16)InitData << msg.className << msg.objectName.toUtf8() << initData);
414 void DataStreamPeer::dispatch(const Protocol::HeartBeat &msg)
416 dispatchPackedFunc(QVariantList() << (qint16)HeartBeat << msg.timestamp);
420 void DataStreamPeer::dispatch(const Protocol::HeartBeatReply &msg)
422 dispatchPackedFunc(QVariantList() << (qint16)HeartBeatReply << msg.timestamp);
426 void DataStreamPeer::dispatchPackedFunc(const QVariantList &packedFunc)
428 writeMessage(packedFunc);