1 /***************************************************************************
2 * Copyright (C) 2005-2014 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 ***************************************************************************/
23 #include <QHostAddress>
26 #include "datastreampeer.h"
29 using namespace Protocol;
31 DataStreamPeer::DataStreamPeer(::AuthHandler *authHandler, QTcpSocket *socket, quint16 features, QObject *parent)
32 : RemotePeer(authHandler, socket, parent),
37 _stream.setDevice(socket);
38 _stream.setVersion(QDataStream::Qt_4_2);
42 quint16 DataStreamPeer::supportedFeatures()
48 bool DataStreamPeer::acceptsFeatures(quint16 peerFeatures)
50 Q_UNUSED(peerFeatures);
55 quint16 DataStreamPeer::enabledFeatures() const
61 // Note that we're already preparing for readSocketData() moving into RemotePeer, thus the slightly
62 // cumbersome type and stream handling here.
63 void DataStreamPeer::onSocketDataAvailable()
65 // don't try to read more data if we're already closing
66 if (socket()->state() != QAbstractSocket::ConnectedState)
70 while (readSocketData(data)) {
71 // data contains always a serialized QVector<QVariant>
72 QDataStream stream(data);
73 stream.setVersion(QDataStream::Qt_4_2);
76 if (stream.status() != QDataStream::Ok) {
77 close("Peer sent corrupt data, closing down!");
81 // if no sigproxy is set, we're in handshake mode
83 handleHandshakeMessage(list);
85 handlePackedFunc(list);
90 bool DataStreamPeer::readSocketData(QByteArray &data)
92 if (_blockSize == 0) {
93 if (socket()->bytesAvailable() < 4)
95 // the block size is part of QByteArray's serialization format, so we don't actually read it now...
96 socket()->peek((char*)&_blockSize, 4);
97 _blockSize = qFromBigEndian<quint32>(_blockSize) + 4; // ... but of course we have to add its size to the total size of the block
100 if (_blockSize > 1 << 22) {
101 close("Peer tried to send package larger than max package size!");
105 if (_blockSize == 0) {
106 close("Peer tried to send 0 byte package!");
110 if (socket()->bytesAvailable() < _blockSize) {
111 emit transferProgress(socket()->bytesAvailable(), _blockSize);
115 emit transferProgress(_blockSize, _blockSize);
120 if (_stream.status() != QDataStream::Ok) {
121 close("Peer sent corrupt data, closing down!");
129 void DataStreamPeer::writeSocketData(const QVariantList &list)
131 if (!socket()->isOpen()) {
132 qWarning() << Q_FUNC_INFO << "Can't write to a closed socket!";
137 QDataStream msgStream(&data, QIODevice::WriteOnly);
138 msgStream.setVersion(QDataStream::Qt_4_2);
141 _stream << data; // also writes the block size as part of the serialization format
142 if (_stream.status() != QDataStream::Ok)
143 close("Could not serialize data for peer!");
147 void DataStreamPeer::writeSocketData(const QVariantMap &handshakeMsg)
150 QVariantMap::const_iterator it = handshakeMsg.begin();
151 while (it != handshakeMsg.end()) {
152 list << it.key().toUtf8() << it.value();
156 writeSocketData(list);
161 /*** Handshake messages ***/
163 /* These messages are transmitted during handshake phase, which in case of the legacy protocol means they have
164 * a structure different from those being used after the handshake.
165 * Also, the legacy handshake does not fully match the redesigned one, so we'll have to do various mappings here.
168 void DataStreamPeer::handleHandshakeMessage(const QVariantList &mapData)
171 for (int i = 0; i < mapData.count()/2; ++i)
172 m[QString::fromUtf8(mapData[2*i].toByteArray())] = mapData[2*i+1];
174 QString msgType = m["MsgType"].toString();
175 if (msgType.isEmpty()) {
176 emit protocolError(tr("Invalid handshake message!"));
180 if (msgType == "ClientInit") {
181 handle(RegisterClient(m["ClientVersion"].toString(), false)); // UseSsl obsolete
184 else if (msgType == "ClientInitReject") {
185 handle(ClientDenied(m["Error"].toString()));
188 else if (msgType == "ClientInitAck") {
189 handle(ClientRegistered(m["CoreFeatures"].toUInt(), m["Configured"].toBool(), m["StorageBackends"].toList(), false, QDateTime())); // SupportsSsl and coreStartTime obsolete
192 else if (msgType == "CoreSetupData") {
193 QVariantMap map = m["SetupData"].toMap();
194 handle(SetupData(map["AdminUser"].toString(), map["AdminPasswd"].toString(), map["Backend"].toString(), map["ConnectionProperties"].toMap()));
197 else if (msgType == "CoreSetupReject") {
198 handle(SetupFailed(m["Error"].toString()));
201 else if (msgType == "CoreSetupAck") {
205 else if (msgType == "ClientLogin") {
206 handle(Login(m["User"].toString(), m["Password"].toString()));
209 else if (msgType == "ClientLoginReject") {
210 handle(LoginFailed(m["Error"].toString()));
213 else if (msgType == "ClientLoginAck") {
214 handle(LoginSuccess());
217 else if (msgType == "SessionInit") {
218 QVariantMap map = m["SessionState"].toMap();
219 handle(SessionState(map["Identities"].toList(), map["BufferInfos"].toList(), map["NetworkIds"].toList()));
223 emit protocolError(tr("Unknown protocol message of type %1").arg(msgType));
228 void DataStreamPeer::dispatch(const RegisterClient &msg) {
230 m["MsgType"] = "ClientInit";
231 m["ClientVersion"] = msg.clientVersion;
232 m["ClientDate"] = Quassel::buildInfo().buildDate;
238 void DataStreamPeer::dispatch(const ClientDenied &msg) {
240 m["MsgType"] = "ClientInitReject";
241 m["Error"] = msg.errorString;
247 void DataStreamPeer::dispatch(const ClientRegistered &msg) {
249 m["MsgType"] = "ClientInitAck";
250 m["CoreFeatures"] = msg.coreFeatures;
251 m["StorageBackends"] = msg.backendInfo;
252 m["LoginEnabled"] = m["Configured"] = msg.coreConfigured;
258 void DataStreamPeer::dispatch(const SetupData &msg)
261 map["AdminUser"] = msg.adminUser;
262 map["AdminPasswd"] = msg.adminPassword;
263 map["Backend"] = msg.backend;
264 map["ConnectionProperties"] = msg.setupData;
267 m["MsgType"] = "CoreSetupData";
268 m["SetupData"] = map;
273 void DataStreamPeer::dispatch(const SetupFailed &msg)
276 m["MsgType"] = "CoreSetupReject";
277 m["Error"] = msg.errorString;
283 void DataStreamPeer::dispatch(const SetupDone &msg)
288 m["MsgType"] = "CoreSetupAck";
294 void DataStreamPeer::dispatch(const Login &msg)
297 m["MsgType"] = "ClientLogin";
298 m["User"] = msg.user;
299 m["Password"] = msg.password;
305 void DataStreamPeer::dispatch(const LoginFailed &msg)
308 m["MsgType"] = "ClientLoginReject";
309 m["Error"] = msg.errorString;
315 void DataStreamPeer::dispatch(const LoginSuccess &msg)
320 m["MsgType"] = "ClientLoginAck";
326 void DataStreamPeer::dispatch(const SessionState &msg)
329 m["MsgType"] = "SessionInit";
332 map["BufferInfos"] = msg.bufferInfos;
333 map["NetworkIds"] = msg.networkIds;
334 map["Identities"] = msg.identities;
335 m["SessionState"] = map;
341 /*** Standard messages ***/
343 void DataStreamPeer::handlePackedFunc(const QVariantList &packedFunc)
345 QVariantList params(packedFunc);
347 if (params.isEmpty()) {
348 qWarning() << Q_FUNC_INFO << "Received incompatible data:" << packedFunc;
352 // TODO: make sure that this is a valid request type
353 RequestType requestType = (RequestType)params.takeFirst().value<qint16>();
354 switch (requestType) {
356 if (params.count() < 3) {
357 qWarning() << Q_FUNC_INFO << "Received invalid sync call:" << params;
360 QByteArray className = params.takeFirst().toByteArray();
361 QString objectName = QString::fromUtf8(params.takeFirst().toByteArray());
362 QByteArray slotName = params.takeFirst().toByteArray();
363 handle(Protocol::SyncMessage(className, objectName, slotName, params));
367 if (params.empty()) {
368 qWarning() << Q_FUNC_INFO << "Received empty RPC call!";
371 QByteArray slotName = params.takeFirst().toByteArray();
372 handle(Protocol::RpcCall(slotName, params));
376 if (params.count() != 2) {
377 qWarning() << Q_FUNC_INFO << "Received invalid InitRequest:" << params;
380 QByteArray className = params[0].toByteArray();
381 QString objectName = QString::fromUtf8(params[1].toByteArray());
382 handle(Protocol::InitRequest(className, objectName));
386 if (params.count() < 2) {
387 qWarning() << Q_FUNC_INFO << "Received invalid InitData:" << params;
390 QByteArray className = params.takeFirst().toByteArray();
391 QString objectName = QString::fromUtf8(params.takeFirst().toByteArray());
392 QVariantMap initData;
393 for (int i = 0; i < params.count()/2; ++i)
394 initData[QString::fromUtf8(params[2*i].toByteArray())] = params[2*i+1];
395 handle(Protocol::InitData(className, objectName, initData));
399 if (params.count() != 1) {
400 qWarning() << Q_FUNC_INFO << "Received invalid HeartBeat:" << params;
403 // Note: QDateTime instead of QTime as in the legacy protocol!
404 handle(Protocol::HeartBeat(params[0].toDateTime()));
407 case HeartBeatReply: {
408 if (params.count() != 1) {
409 qWarning() << Q_FUNC_INFO << "Received invalid HeartBeat:" << params;
412 // Note: QDateTime instead of QTime as in the legacy protocol!
413 handle(Protocol::HeartBeatReply(params[0].toDateTime()));
421 void DataStreamPeer::dispatch(const Protocol::SyncMessage &msg)
423 dispatchPackedFunc(QVariantList() << (qint16)Sync << msg.className << msg.objectName.toUtf8() << msg.slotName << msg.params);
427 void DataStreamPeer::dispatch(const Protocol::RpcCall &msg)
429 dispatchPackedFunc(QVariantList() << (qint16)RpcCall << msg.slotName << msg.params);
433 void DataStreamPeer::dispatch(const Protocol::InitRequest &msg)
435 dispatchPackedFunc(QVariantList() << (qint16)InitRequest << msg.className << msg.objectName.toUtf8());
439 void DataStreamPeer::dispatch(const Protocol::InitData &msg)
441 QVariantList initData;
442 QVariantMap::const_iterator it = msg.initData.begin();
443 while (it != msg.initData.end()) {
444 initData << it.key().toUtf8() << it.value();
447 dispatchPackedFunc(QVariantList() << (qint16)InitData << msg.className << msg.objectName.toUtf8() << initData);
451 void DataStreamPeer::dispatch(const Protocol::HeartBeat &msg)
453 dispatchPackedFunc(QVariantList() << (qint16)HeartBeat << msg.timestamp);
457 void DataStreamPeer::dispatch(const Protocol::HeartBeatReply &msg)
459 dispatchPackedFunc(QVariantList() << (qint16)HeartBeatReply << msg.timestamp);
463 void DataStreamPeer::dispatchPackedFunc(const QVariantList &packedFunc)
465 writeSocketData(packedFunc);