src/common/protocols/datastream/datastreampeer.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2016 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   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.                                           *
   9  *                                                                         *
  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.                          *
  14  *                                                                         *
  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  ***************************************************************************/
  20
  21 #include <QtEndian>
  22 #include <QDataStream>
  23 #include <QHostAddress>
  24 #include <QTcpSocket>
  25
  26 #include "datastreampeer.h"
  27
  28 using namespace Protocol;
  29
  30 DataStreamPeer::DataStreamPeer(::AuthHandler *authHandler, QTcpSocket *socket, quint16 features, Compressor::CompressionLevel level, QObject *parent)
  31     : RemotePeer(authHandler, socket, level, parent)
  32 {
  33     Q_UNUSED(features);
  34 }
  35
  36
  37 quint16 DataStreamPeer::supportedFeatures()
  38 {
  39     return 0;
  40 }
  41
  42
  43 bool DataStreamPeer::acceptsFeatures(quint16 peerFeatures)
  44 {
  45     Q_UNUSED(peerFeatures);
  46     return true;
  47 }
  48
  49
  50 quint16 DataStreamPeer::enabledFeatures() const
  51 {
  52     return 0;
  53 }
  54
  55
  56 void DataStreamPeer::processMessage(const QByteArray &msg)
  57 {
  58     QDataStream stream(msg);
  59     stream.setVersion(QDataStream::Qt_4_2);
  60     QVariantList list;
  61     stream >> list;
  62     if (stream.status() != QDataStream::Ok) {
  63         close("Peer sent corrupt data, closing down!");
  64         return;
  65     }
  66
  67     // if no sigproxy is set, we're in handshake mode
  68     if (!signalProxy())
  69         handleHandshakeMessage(list);
  70     else
  71         handlePackedFunc(list);
  72 }
  73
  74
  75 void DataStreamPeer::writeMessage(const QVariantMap &handshakeMsg)
  76 {
  77     QVariantList list;
  78     QVariantMap::const_iterator it = handshakeMsg.begin();
  79     while (it != handshakeMsg.end()) {
  80         list << it.key().toUtf8() << it.value();
  81         ++it;
  82     }
  83
  84     writeMessage(list);
  85 }
  86
  87
  88 void DataStreamPeer::writeMessage(const QVariantList &sigProxyMsg)
  89 {
  90     QByteArray data;
  91     QDataStream msgStream(&data, QIODevice::WriteOnly);
  92     msgStream.setVersion(QDataStream::Qt_4_2);
  93     msgStream << sigProxyMsg;
  94
  95     writeMessage(data);
  96 }
  97
  98
  99 /*** Handshake messages ***/
 100
 101 /* These messages are transmitted during handshake phase, which in case of the legacy protocol means they have
 102  * a structure different from those being used after the handshake.
 103  * Also, the legacy handshake does not fully match the redesigned one, so we'll have to do various mappings here.
 104  */
 105
 106 void DataStreamPeer::handleHandshakeMessage(const QVariantList &mapData)
 107 {
 108     QVariantMap m;
 109     for (int i = 0; i < mapData.count()/2; ++i)
 110         m[QString::fromUtf8(mapData[2*i].toByteArray())] = mapData[2*i+1];
 111
 112     QString msgType = m["MsgType"].toString();
 113     if (msgType.isEmpty()) {
 114         emit protocolError(tr("Invalid handshake message!"));
 115         return;
 116     }
 117
 118     if (msgType == "ClientInit") {
 119         handle(RegisterClient(m["ClientVersion"].toString(), m["ClientDate"].toString(), false)); // UseSsl obsolete
 120     }
 121
 122     else if (msgType == "ClientInitReject") {
 123         handle(ClientDenied(m["Error"].toString()));
 124     }
 125
 126     else if (msgType == "ClientInitAck") {
 127         handle(ClientRegistered(m["CoreFeatures"].toUInt(), m["Configured"].toBool(), m["StorageBackends"].toList(), false, m["Authenticators"].toList())); // SupportsSsl obsolete
 128     }
 129
 130     else if (msgType == "CoreSetupData") {
 131         QVariantMap map = m["SetupData"].toMap();
 132         handle(SetupData(map["AdminUser"].toString(), map["AdminPasswd"].toString(), map["Backend"].toString(), map["ConnectionProperties"].toMap(), map["Authenticator"].toString(), map["AuthProperties"].toMap()));
 133     }
 134
 135     else if (msgType == "CoreSetupReject") {
 136         handle(SetupFailed(m["Error"].toString()));
 137     }
 138
 139     else if (msgType == "CoreSetupAck") {
 140         handle(SetupDone());
 141     }
 142
 143     else if (msgType == "ClientLogin") {
 144         handle(Login(m["User"].toString(), m["Password"].toString()));
 145     }
 146
 147     else if (msgType == "ClientLoginReject") {
 148         handle(LoginFailed(m["Error"].toString()));
 149     }
 150
 151     else if (msgType == "ClientLoginAck") {
 152         handle(LoginSuccess());
 153     }
 154
 155     else if (msgType == "SessionInit") {
 156         QVariantMap map = m["SessionState"].toMap();
 157         handle(SessionState(map["Identities"].toList(), map["BufferInfos"].toList(), map["NetworkIds"].toList()));
 158     }
 159
 160     else {
 161         emit protocolError(tr("Unknown protocol message of type %1").arg(msgType));
 162     }
 163 }
 164
 165
 166 void DataStreamPeer::dispatch(const RegisterClient &msg) {
 167     QVariantMap m;
 168     m["MsgType"] = "ClientInit";
 169     m["ClientVersion"] = msg.clientVersion;
 170     m["ClientDate"] = msg.buildDate;
 171
 172     writeMessage(m);
 173 }
 174
 175
 176 void DataStreamPeer::dispatch(const ClientDenied &msg) {
 177     QVariantMap m;
 178     m["MsgType"] = "ClientInitReject";
 179     m["Error"] = msg.errorString;
 180
 181     writeMessage(m);
 182 }
 183
 184
 185 void DataStreamPeer::dispatch(const ClientRegistered &msg) {
 186     QVariantMap m;
 187     m["MsgType"] = "ClientInitAck";
 188     m["CoreFeatures"] = msg.coreFeatures;
 189     m["StorageBackends"] = msg.backendInfo;
 190     m["Authenticators"] = msg.authenticatorInfo;
 191     m["LoginEnabled"] = m["Configured"] = msg.coreConfigured;
 192
 193     writeMessage(m);
 194 }
 195
 196
 197 void DataStreamPeer::dispatch(const SetupData &msg)
 198 {
 199     QVariantMap map;
 200     map["AdminUser"] = msg.adminUser;
 201     map["AdminPasswd"] = msg.adminPassword;
 202     map["Backend"] = msg.backend;
 203     map["ConnectionProperties"] = msg.setupData;
 204
 205     // Auth backend properties.
 206     map["Authenticator"] = msg.authenticator;
 207     map["AuthProperties"] = msg.authSetupData;
 208
 209     QVariantMap m;
 210     m["MsgType"] = "CoreSetupData";
 211     m["SetupData"] = map;
 212
 213     writeMessage(m);
 214 }
 215
 216
 217 void DataStreamPeer::dispatch(const SetupFailed &msg)
 218 {
 219     QVariantMap m;
 220     m["MsgType"] = "CoreSetupReject";
 221     m["Error"] = msg.errorString;
 222
 223     writeMessage(m);
 224 }
 225
 226
 227 void DataStreamPeer::dispatch(const SetupDone &msg)
 228 {
 229     Q_UNUSED(msg)
 230
 231     QVariantMap m;
 232     m["MsgType"] = "CoreSetupAck";
 233
 234     writeMessage(m);
 235 }
 236
 237
 238 void DataStreamPeer::dispatch(const Login &msg)
 239 {
 240     QVariantMap m;
 241     m["MsgType"] = "ClientLogin";
 242     m["User"] = msg.user;
 243     m["Password"] = msg.password;
 244
 245     writeMessage(m);
 246 }
 247
 248
 249 void DataStreamPeer::dispatch(const LoginFailed &msg)
 250 {
 251     QVariantMap m;
 252     m["MsgType"] = "ClientLoginReject";
 253     m["Error"] = msg.errorString;
 254
 255     writeMessage(m);
 256 }
 257
 258
 259 void DataStreamPeer::dispatch(const LoginSuccess &msg)
 260 {
 261     Q_UNUSED(msg)
 262
 263     QVariantMap m;
 264     m["MsgType"] = "ClientLoginAck";
 265
 266     writeMessage(m);
 267 }
 268
 269
 270 void DataStreamPeer::dispatch(const SessionState &msg)
 271 {
 272     QVariantMap m;
 273     m["MsgType"] = "SessionInit";
 274
 275     QVariantMap map;
 276     map["BufferInfos"] = msg.bufferInfos;
 277     map["NetworkIds"] = msg.networkIds;
 278     map["Identities"] = msg.identities;
 279     m["SessionState"] = map;
 280
 281     writeMessage(m);
 282 }
 283
 284
 285 /*** Standard messages ***/
 286
 287 void DataStreamPeer::handlePackedFunc(const QVariantList &packedFunc)
 288 {
 289     QVariantList params(packedFunc);
 290
 291     if (params.isEmpty()) {
 292         qWarning() << Q_FUNC_INFO << "Received incompatible data:" << packedFunc;
 293         return;
 294     }
 295
 296     // TODO: make sure that this is a valid request type
 297     RequestType requestType = (RequestType)params.takeFirst().value<qint16>();
 298     switch (requestType) {
 299         case Sync: {
 300             if (params.count() < 3) {
 301                 qWarning() << Q_FUNC_INFO << "Received invalid sync call:" << params;
 302                 return;
 303             }
 304             QByteArray className = params.takeFirst().toByteArray();
 305             QString objectName = QString::fromUtf8(params.takeFirst().toByteArray());
 306             QByteArray slotName = params.takeFirst().toByteArray();
 307             handle(Protocol::SyncMessage(className, objectName, slotName, params));
 308             break;
 309         }
 310         case RpcCall: {
 311             if (params.empty()) {
 312                 qWarning() << Q_FUNC_INFO << "Received empty RPC call!";
 313                 return;
 314             }
 315             QByteArray slotName = params.takeFirst().toByteArray();
 316             handle(Protocol::RpcCall(slotName, params));
 317             break;
 318         }
 319         case InitRequest: {
 320             if (params.count() != 2) {
 321                 qWarning() << Q_FUNC_INFO << "Received invalid InitRequest:" << params;
 322                 return;
 323             }
 324             QByteArray className = params[0].toByteArray();
 325             QString objectName = QString::fromUtf8(params[1].toByteArray());
 326             handle(Protocol::InitRequest(className, objectName));
 327             break;
 328         }
 329         case InitData: {
 330             if (params.count() < 2) {
 331                 qWarning() << Q_FUNC_INFO << "Received invalid InitData:" << params;
 332                 return;
 333             }
 334             QByteArray className = params.takeFirst().toByteArray();
 335             QString objectName = QString::fromUtf8(params.takeFirst().toByteArray());
 336             QVariantMap initData;
 337             for (int i = 0; i < params.count()/2; ++i)
 338                 initData[QString::fromUtf8(params[2*i].toByteArray())] = params[2*i+1];
 339             handle(Protocol::InitData(className, objectName, initData));
 340             break;
 341         }
 342         case HeartBeat: {
 343             if (params.count() != 1) {
 344                 qWarning() << Q_FUNC_INFO << "Received invalid HeartBeat:" << params;
 345                 return;
 346             }
 347             // Note: QDateTime instead of QTime as in the legacy protocol!
 348             handle(Protocol::HeartBeat(params[0].toDateTime()));
 349             break;
 350         }
 351         case HeartBeatReply: {
 352             if (params.count() != 1) {
 353                 qWarning() << Q_FUNC_INFO << "Received invalid HeartBeat:" << params;
 354                 return;
 355             }
 356             // Note: QDateTime instead of QTime as in the legacy protocol!
 357             handle(Protocol::HeartBeatReply(params[0].toDateTime()));
 358             break;
 359         }
 360
 361     }
 362 }
 363
 364
 365 void DataStreamPeer::dispatch(const Protocol::SyncMessage &msg)
 366 {
 367     dispatchPackedFunc(QVariantList() << (qint16)Sync << msg.className << msg.objectName.toUtf8() << msg.slotName << msg.params);
 368 }
 369
 370
 371 void DataStreamPeer::dispatch(const Protocol::RpcCall &msg)
 372 {
 373     dispatchPackedFunc(QVariantList() << (qint16)RpcCall << msg.slotName << msg.params);
 374 }
 375
 376
 377 void DataStreamPeer::dispatch(const Protocol::InitRequest &msg)
 378 {
 379     dispatchPackedFunc(QVariantList() << (qint16)InitRequest << msg.className << msg.objectName.toUtf8());
 380 }
 381
 382
 383 void DataStreamPeer::dispatch(const Protocol::InitData &msg)
 384 {
 385     QVariantList initData;
 386     QVariantMap::const_iterator it = msg.initData.begin();
 387     while (it != msg.initData.end()) {
 388         initData << it.key().toUtf8() << it.value();
 389         ++it;
 390     }
 391     dispatchPackedFunc(QVariantList() << (qint16)InitData << msg.className << msg.objectName.toUtf8() << initData);
 392 }
 393
 394
 395 void DataStreamPeer::dispatch(const Protocol::HeartBeat &msg)
 396 {
 397     dispatchPackedFunc(QVariantList() << (qint16)HeartBeat << msg.timestamp);
 398 }
 399
 400
 401 void DataStreamPeer::dispatch(const Protocol::HeartBeatReply &msg)
 402 {
 403     dispatchPackedFunc(QVariantList() << (qint16)HeartBeatReply << msg.timestamp);
 404 }
 405
 406
 407 void DataStreamPeer::dispatchPackedFunc(const QVariantList &packedFunc)
 408 {
 409     writeMessage(packedFunc);
 410 }