src/common/protocols/datastream/datastreampeer.cpp

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