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 ***************************************************************************/
21 #include <QHostAddress>
22 #include <QDataStream>
25 #include "legacypeer.h"
27 /* version.inc is no longer used for this */
28 const uint protocolVersion = 10;
29 const uint coreNeedsProtocol = protocolVersion;
30 const uint clientNeedsProtocol = protocolVersion;
32 using namespace Protocol;
34 LegacyPeer::LegacyPeer(::AuthHandler *authHandler, QTcpSocket *socket, Compressor::CompressionLevel level, QObject *parent)
35 : RemotePeer(authHandler, socket, level, parent),
36 _useCompression(false)
42 void LegacyPeer::setSignalProxy(::SignalProxy *proxy)
44 RemotePeer::setSignalProxy(proxy);
46 // FIXME only in compat mode
48 // enable compression now if requested - the initial handshake is uncompressed in the legacy protocol!
49 _useCompression = socket()->property("UseCompression").toBool();
51 qDebug() << "Using compression for peer:" << qPrintable(socket()->peerAddress().toString());
57 void LegacyPeer::processMessage(const QByteArray &msg)
59 QDataStream stream(msg);
60 stream.setVersion(QDataStream::Qt_4_2);
63 if (_useCompression) {
67 int nbytes = rawItem.size();
69 const char *data = rawItem.constData();
70 if (nbytes < 4 || (data[0] != 0 || data[1] != 0 || data[2] != 0 || data[3] != 0)) {
71 close("Peer sent corrupted compressed data!");
76 rawItem = qUncompress(rawItem);
78 QDataStream itemStream(&rawItem, QIODevice::ReadOnly);
79 itemStream.setVersion(QDataStream::Qt_4_2);
86 if (stream.status() != QDataStream::Ok || !item.isValid()) {
87 close("Peer sent corrupt data: unable to load QVariant!");
91 // if no sigproxy is set, we're in handshake mode and let the data be handled elsewhere
93 handleHandshakeMessage(item);
95 handlePackedFunc(item);
99 void LegacyPeer::writeMessage(const QVariant &item)
102 QDataStream out(&block, QIODevice::WriteOnly);
103 out.setVersion(QDataStream::Qt_4_2);
105 if (_useCompression) {
107 QDataStream itemStream(&rawItem, QIODevice::WriteOnly);
108 itemStream.setVersion(QDataStream::Qt_4_2);
111 rawItem = qCompress(rawItem);
123 /*** Handshake messages ***/
125 /* These messages are transmitted during handshake phase, which in case of the legacy protocol means they have
126 * a structure different from those being used after the handshake.
127 * Also, the legacy handshake does not fully match the redesigned one, so we'll have to do various mappings here.
130 void LegacyPeer::handleHandshakeMessage(const QVariant &msg)
132 QVariantMap m = msg.toMap();
134 QString msgType = m["MsgType"].toString();
135 if (msgType.isEmpty()) {
136 emit protocolError(tr("Invalid handshake message!"));
140 if (msgType == "ClientInit") {
141 // FIXME only in compat mode
142 uint ver = m["ProtocolVersion"].toUInt();
143 if (ver < coreNeedsProtocol) {
144 emit protocolVersionMismatch((int)ver, (int)coreNeedsProtocol);
148 #ifndef QT_NO_COMPRESS
149 // FIXME only in compat mode
150 if (m["UseCompression"].toBool()) {
151 socket()->setProperty("UseCompression", true);
154 handle(RegisterClient(m["ClientVersion"].toString(), m["ClientDate"].toString(), m["UseSsl"].toBool(), m["Features"].toInt()));
157 else if (msgType == "ClientInitReject") {
158 handle(ClientDenied(m["Error"].toString()));
161 else if (msgType == "ClientInitAck") {
162 // FIXME only in compat mode
163 uint ver = m["ProtocolVersion"].toUInt(); // actually an UInt
164 if (ver < clientNeedsProtocol) {
165 emit protocolVersionMismatch((int)ver, (int)clientNeedsProtocol);
168 #ifndef QT_NO_COMPRESS
169 if (m["SupportsCompression"].toBool())
170 socket()->setProperty("UseCompression", true);
173 handle(ClientRegistered(m["CoreFeatures"].toUInt(), m["Configured"].toBool(), m["StorageBackends"].toList(), m["SupportSsl"].toBool(), m["Authenticators"].toList()));
176 else if (msgType == "CoreSetupData") {
177 QVariantMap map = m["SetupData"].toMap();
178 handle(SetupData(map["AdminUser"].toString(), map["AdminPasswd"].toString(), map["Backend"].toString(), map["ConnectionProperties"].toMap(), map["Authenticator"].toString(), map["AuthProperties"].toMap()));
181 else if (msgType == "CoreSetupReject") {
182 handle(SetupFailed(m["Error"].toString()));
185 else if (msgType == "CoreSetupAck") {
189 else if (msgType == "ClientLogin") {
190 handle(Login(m["User"].toString(), m["Password"].toString()));
193 else if (msgType == "ClientLoginReject") {
194 handle(LoginFailed(m["Error"].toString()));
197 else if (msgType == "ClientLoginAck") {
198 handle(LoginSuccess());
201 else if (msgType == "SessionInit") {
202 QVariantMap map = m["SessionState"].toMap();
203 handle(SessionState(map["Identities"].toList(), map["BufferInfos"].toList(), map["NetworkIds"].toList()));
207 emit protocolError(tr("Unknown protocol message of type %1").arg(msgType));
212 void LegacyPeer::dispatch(const RegisterClient &msg) {
214 m["MsgType"] = "ClientInit";
215 m["ClientVersion"] = msg.clientVersion;
216 m["ClientDate"] = msg.buildDate;
217 m["Features"] = msg.clientFeatures;
219 // FIXME only in compat mode
220 m["ProtocolVersion"] = protocolVersion;
221 m["UseSsl"] = msg.sslSupported;
222 #ifndef QT_NO_COMPRESS
223 m["UseCompression"] = true;
225 m["UseCompression"] = false;
232 void LegacyPeer::dispatch(const ClientDenied &msg) {
234 m["MsgType"] = "ClientInitReject";
235 m["Error"] = msg.errorString;
241 void LegacyPeer::dispatch(const ClientRegistered &msg) {
243 m["MsgType"] = "ClientInitAck";
244 m["CoreFeatures"] = msg.coreFeatures;
245 m["StorageBackends"] = msg.backendInfo;
246 m["Authenticators"] = msg.authenticatorInfo;
248 // FIXME only in compat mode
249 m["ProtocolVersion"] = protocolVersion;
250 m["SupportSsl"] = msg.sslSupported;
251 m["SupportsCompression"] = socket()->property("UseCompression").toBool(); // this property gets already set in the ClientInit handler
253 // This is only used for display by really old v10 clients (pre-0.5), and we no longer set this
254 m["CoreInfo"] = QString();
256 m["LoginEnabled"] = m["Configured"] = msg.coreConfigured;
262 void LegacyPeer::dispatch(const SetupData &msg)
265 map["AdminUser"] = msg.adminUser;
266 map["AdminPasswd"] = msg.adminPassword;
267 map["Backend"] = msg.backend;
268 map["ConnectionProperties"] = msg.setupData;
270 // Auth backend properties.
271 map["Authenticator"] = msg.authenticator;
272 map["AuthProperties"] = msg.authSetupData;
275 m["MsgType"] = "CoreSetupData";
276 m["SetupData"] = map;
281 void LegacyPeer::dispatch(const SetupFailed &msg)
284 m["MsgType"] = "CoreSetupReject";
285 m["Error"] = msg.errorString;
291 void LegacyPeer::dispatch(const SetupDone &msg)
296 m["MsgType"] = "CoreSetupAck";
302 void LegacyPeer::dispatch(const Login &msg)
305 m["MsgType"] = "ClientLogin";
306 m["User"] = msg.user;
307 m["Password"] = msg.password;
313 void LegacyPeer::dispatch(const LoginFailed &msg)
316 m["MsgType"] = "ClientLoginReject";
317 m["Error"] = msg.errorString;
323 void LegacyPeer::dispatch(const LoginSuccess &msg)
328 m["MsgType"] = "ClientLoginAck";
334 void LegacyPeer::dispatch(const SessionState &msg)
337 m["MsgType"] = "SessionInit";
340 map["BufferInfos"] = msg.bufferInfos;
341 map["NetworkIds"] = msg.networkIds;
342 map["Identities"] = msg.identities;
343 m["SessionState"] = map;
349 /*** Standard messages ***/
351 void LegacyPeer::handlePackedFunc(const QVariant &packedFunc)
353 QVariantList params(packedFunc.toList());
355 if (params.isEmpty()) {
356 qWarning() << Q_FUNC_INFO << "Received incompatible data:" << packedFunc;
360 // TODO: make sure that this is a valid request type
361 RequestType requestType = (RequestType)params.takeFirst().value<int>();
362 switch (requestType) {
364 if (params.count() < 3) {
365 qWarning() << Q_FUNC_INFO << "Received invalid sync call:" << params;
368 QByteArray className = params.takeFirst().toByteArray();
369 QString objectName = params.takeFirst().toString();
370 QByteArray slotName = params.takeFirst().toByteArray();
371 handle(Protocol::SyncMessage(className, objectName, slotName, params));
375 if (params.empty()) {
376 qWarning() << Q_FUNC_INFO << "Received empty RPC call!";
379 QByteArray slotName = params.takeFirst().toByteArray();
380 handle(Protocol::RpcCall(slotName, params));
384 if (params.count() != 2) {
385 qWarning() << Q_FUNC_INFO << "Received invalid InitRequest:" << params;
388 QByteArray className = params[0].toByteArray();
389 QString objectName = params[1].toString();
390 handle(Protocol::InitRequest(className, objectName));
394 if (params.count() != 3) {
395 qWarning() << Q_FUNC_INFO << "Received invalid InitData:" << params;
398 QByteArray className = params[0].toByteArray();
399 QString objectName = params[1].toString();
400 QVariantMap initData = params[2].toMap();
402 // we need to special-case IrcUsersAndChannels here, since the format changed
403 if (className == "Network")
404 fromLegacyIrcUsersAndChannels(initData);
405 handle(Protocol::InitData(className, objectName, initData));
409 if (params.count() != 1) {
410 qWarning() << Q_FUNC_INFO << "Received invalid HeartBeat:" << params;
413 // The legacy protocol would only send a QTime, no QDateTime
414 // so we assume it's sent today, which works in exactly the same cases as it did in the old implementation
415 QDateTime dateTime = QDateTime::currentDateTime().toUTC();
416 dateTime.setTime(params[0].toTime());
417 handle(Protocol::HeartBeat(dateTime));
420 case HeartBeatReply: {
421 if (params.count() != 1) {
422 qWarning() << Q_FUNC_INFO << "Received invalid HeartBeat:" << params;
425 // The legacy protocol would only send a QTime, no QDateTime
426 // so we assume it's sent today, which works in exactly the same cases as it did in the old implementation
427 QDateTime dateTime = QDateTime::currentDateTime().toUTC();
428 dateTime.setTime(params[0].toTime());
429 handle(Protocol::HeartBeatReply(dateTime));
437 void LegacyPeer::dispatch(const Protocol::SyncMessage &msg)
439 dispatchPackedFunc(QVariantList() << (qint16)Sync << msg.className << msg.objectName << msg.slotName << msg.params);
443 void LegacyPeer::dispatch(const Protocol::RpcCall &msg)
445 dispatchPackedFunc(QVariantList() << (qint16)RpcCall << msg.slotName << msg.params);
449 void LegacyPeer::dispatch(const Protocol::InitRequest &msg)
451 dispatchPackedFunc(QVariantList() << (qint16)InitRequest << msg.className << msg.objectName);
455 void LegacyPeer::dispatch(const Protocol::InitData &msg)
457 // We need to special-case IrcUsersAndChannels, as the format changed
458 if (msg.className == "Network") {
459 QVariantMap initData = msg.initData;
460 toLegacyIrcUsersAndChannels(initData);
461 dispatchPackedFunc(QVariantList() << (qint16)InitData << msg.className << msg.objectName << initData);
464 dispatchPackedFunc(QVariantList() << (qint16)InitData << msg.className << msg.objectName << msg.initData);
468 void LegacyPeer::dispatch(const Protocol::HeartBeat &msg)
470 dispatchPackedFunc(QVariantList() << (qint16)HeartBeat << msg.timestamp.time());
474 void LegacyPeer::dispatch(const Protocol::HeartBeatReply &msg)
476 dispatchPackedFunc(QVariantList() << (qint16)HeartBeatReply << msg.timestamp.time());
480 void LegacyPeer::dispatchPackedFunc(const QVariantList &packedFunc)
482 writeMessage(QVariant(packedFunc));
486 // Handle the changed format for Network's initData
487 // cf. Network::initIrcUsersAndChannels()
488 void LegacyPeer::fromLegacyIrcUsersAndChannels(QVariantMap &initData)
490 const QVariantMap &legacyMap = initData["IrcUsersAndChannels"].toMap();
493 QHash<QString, QVariantList> users;
494 foreach(const QVariant &v, legacyMap["users"].toMap().values()) {
495 const QVariantMap &map = v.toMap();
496 foreach(const QString &key, map.keys())
497 users[key] << map[key];
500 foreach(const QString &key, users.keys())
501 userMap[key] = users[key];
502 newMap["Users"] = userMap;
504 QHash<QString, QVariantList> channels;
505 foreach(const QVariant &v, legacyMap["channels"].toMap().values()) {
506 const QVariantMap &map = v.toMap();
507 foreach(const QString &key, map.keys())
508 channels[key] << map[key];
510 QVariantMap channelMap;
511 foreach(const QString &key, channels.keys())
512 channelMap[key] = channels[key];
513 newMap["Channels"] = channelMap;
515 initData["IrcUsersAndChannels"] = newMap;
519 void LegacyPeer::toLegacyIrcUsersAndChannels(QVariantMap &initData)
521 const QVariantMap &usersAndChannels = initData["IrcUsersAndChannels"].toMap();
522 QVariantMap legacyMap;
524 // toMap() and toList() are cheap, so no need to copy to a hash
527 const QVariantMap &users = usersAndChannels["Users"].toMap();
529 int size = users["nick"].toList().size(); // we know this key exists
530 for(int i = 0; i < size; i++) {
532 foreach(const QString &key, users.keys())
533 map[key] = users[key].toList().at(i);
534 QString hostmask = QString("%1!%2@%3").arg(map["nick"].toString(), map["user"].toString(), map["host"].toString());
535 userMap[hostmask.toLower()] = map;
537 legacyMap["users"] = userMap;
539 QVariantMap channelMap;
540 const QVariantMap &channels = usersAndChannels["Channels"].toMap();
542 size = channels["name"].toList().size();
543 for(int i = 0; i < size; i++) {
545 foreach(const QString &key, channels.keys())
546 map[key] = channels[key].toList().at(i);
547 channelMap[map["name"].toString().toLower()] = map;
549 legacyMap["channels"] = channelMap;
551 initData["IrcUsersAndChannels"] = legacyMap;