fsdclient.cpp

// SPDX-FileCopyrightText: Copyright (C) 2019 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
#include "core/fsd/fsdclient.h"
 
#include <QHostAddress>
#include <QMetaEnum>
#include <QNetworkReply>
#include <QStringView>
 
#include "config/buildconfig.h"
#include "core/application.h"
#include "core/fsd/addatc.h"
#include "core/fsd/addpilot.h"
#include "core/fsd/atcdataupdate.h"
#include "core/fsd/authchallenge.h"
#include "core/fsd/authresponse.h"
#include "core/fsd/clientidentification.h"
#include "core/fsd/clientquery.h"
#include "core/fsd/clientresponse.h"
#include "core/fsd/deleteatc.h"
#include "core/fsd/deletepilot.h"
#include "core/fsd/euroscopesimdata.h"
#include "core/fsd/flightplan.h"
#include "core/fsd/fsdidentification.h"
#include "core/fsd/interimpilotdataupdate.h"
#include "core/fsd/killrequest.h"
#include "core/fsd/mute.h"
#include "core/fsd/pilotdataupdate.h"
#include "core/fsd/ping.h"
#include "core/fsd/planeinforequest.h"
#include "core/fsd/planeinforequestfsinn.h"
#include "core/fsd/planeinformation.h"
#include "core/fsd/planeinformationfsinn.h"
#include "core/fsd/pong.h"
#include "core/fsd/rehost.h"
#include "core/fsd/serializer.h"
#include "core/fsd/servererror.h"
#include "core/fsd/textmessage.h"
#include "core/fsd/visualpilotdataperiodic.h"
#include "core/fsd/visualpilotdatastopped.h"
#include "core/fsd/visualpilotdatatoggle.h"
#include "core/fsd/visualpilotdataupdate.h"
#include "misc/aviation/flightplan.h"
#include "misc/logmessage.h"
#include "misc/network/rawfsdmessage.h"
#include "misc/range.h"
#include "misc/swiftdirectories.h"
#include "misc/threadutils.h"
#include "misc/verify.h"
 
using namespace swift::config;
using namespace swift::core::vatsim;
using namespace swift::misc;
using namespace swift::misc::aviation;
using namespace swift::misc::geo;
using namespace swift::misc::json;
using namespace swift::misc::network;
using namespace swift::misc::physical_quantities;
using namespace swift::misc::simulation;
 
namespace swift::core::fsd
{
    QString convertToUnicodeEscaped(const QString &str)
    {
        QString escaped;
        for (const auto &ch : str)
        {
            const ushort code = ch.unicode();
            if (code < 0x80) { escaped += ch; }
            else { escaped += "\\u" % QString::number(code, 16).rightJustified(4, '0'); }
        }
        return escaped;
    }
 
    const QStringList &CFSDClient::getLogCategories()
    {
        static const QStringList cats = [] {
            QStringList cl = CContinuousWorker::getLogCategories();
            cl.push_back(CLogCategories::network());
            cl.push_back(CLogCategories::fsd());
            return cl;
        }();
        return cats;
    }
 
    // NOLINTBEGIN(cppcoreguidelines-pro-type-member-init)
    CFSDClient::CFSDClient(IClientProvider *clientProvider, IOwnAircraftProvider *ownAircraftProvider,
                           IRemoteAircraftProvider *remoteAircraftProvider, QObject *owner)
        : CContinuousWorker(owner, "FSDClient"), CClientAware(clientProvider), COwnAircraftAware(ownAircraftProvider),
          CRemoteAircraftAware(remoteAircraftProvider), m_tokenBucket(10, 5000, 1)
    {
        // NOLINTEND(cppcoreguidelines-pro-type-member-init)
 
        initializeMessageTypes();
        connectSocketSignals();
 
        m_positionUpdateTimer.setObjectName(this->objectName().append(":m_positionUpdateTimer"));
        connect(&m_positionUpdateTimer, &QTimer::timeout, this, &CFSDClient::sendPilotDataUpdate);
 
        m_interimPositionUpdateTimer.setObjectName(this->objectName().append(":m_interimPositionUpdateTimer"));
        connect(&m_interimPositionUpdateTimer, &QTimer::timeout, this, &CFSDClient::sendInterimPilotDataUpdate);
 
        m_visualPositionUpdateTimer.setObjectName(this->objectName().append(":m_visualPositionUpdateTimer"));
        connect(&m_visualPositionUpdateTimer, &QTimer::timeout, this, [this] { sendVisualPilotDataUpdate(); });
 
        m_scheduledConfigUpdate.setObjectName(this->objectName().append(":m_scheduledConfigUpdate"));
        connect(&m_scheduledConfigUpdate, &QTimer::timeout, this, &CFSDClient::sendIncrementalAircraftConfig);
 
        m_fsdSendMessageTimer.setObjectName(this->objectName().append(":m_fsdSendMessageTimer"));
        connect(&m_fsdSendMessageTimer, &QTimer::timeout, this, [this]() { this->sendQueuedMessage(); });
 
        fsdMessageSettingsChanged();
 
        if (!m_statistics &&
            (CBuildConfig::isLocalDeveloperDebugBuild() || (sApp && sApp->getOwnDistribution().isRestricted())))
        {
            CLogMessage(this).info(u"Enabled network statistics");
            m_statistics = true;
        }
    }
 
    void CFSDClient::connectSocketSignals()
    {
        connect(m_socket.get(), &QTcpSocket::readyRead, this, &CFSDClient::readDataFromSocket, Qt::QueuedConnection);
        connect(m_socket.get(), &QTcpSocket::connected, this, &CFSDClient::handleSocketConnected);
        connect(m_socket.get(), &QTcpSocket::errorOccurred, this, &CFSDClient::printSocketError, Qt::QueuedConnection);
        connect(m_socket.get(), &QTcpSocket::errorOccurred, this, &CFSDClient::handleSocketError, Qt::QueuedConnection);
    }
 
#ifdef SWIFT_VATSIM_SUPPORT
    void CFSDClient::setClientIdAndKey(quint16 id, const QByteArray &key)
    {
        QWriteLocker l(&m_lockUserClientBuffered);
        m_clientAuth = vatsim_auth_create(id, qPrintable(key));
        m_serverAuth = vatsim_auth_create(id, qPrintable(key));
    }
#endif
 
    void CFSDClient::setServer(const CServer &server)
    {
        Q_ASSERT_X(this->getConnectionStatus().isDisconnected(), Q_FUNC_INFO,
                   "Can't change server details while still connected");
 
        const QString codecName(server.getFsdSetup().getTextCodec());
        auto codec = QStringDecoder::encodingForName(codecName);
        if (!codec.has_value()) { codec = QStringConverter::Utf8; }
        const int protocolRev = (server.getServerType() == CServer::FSDServerVatsim) ?
                                    PROTOCOL_REVISION_VATSIM_VELOCITY :
                                    PROTOCOL_REVISION_CLASSIC;
 
        QWriteLocker l(&m_lockUserClientBuffered);
        m_server = server;
        m_protocolRevision = protocolRev;
        m_encoder = QStringEncoder(codec.value_or(QStringConverter::Utf8));
        m_decoder = QStringDecoder(codec.value_or(QStringConverter::Utf8));
    }
 
    void CFSDClient::setCallsign(const CCallsign &callsign)
    {
        Q_ASSERT_X(this->getConnectionStatus().isDisconnected(), Q_FUNC_INFO,
                   "Can't change callsign while still connected");
        updateOwnCallsign(callsign);
 
        QWriteLocker l(&m_lockUserClientBuffered);
        m_ownCallsign = callsign;
    }
 
    void CFSDClient::setIcaoCodes(const CSimulatedAircraft &ownAircraft)
    {
        Q_ASSERT_X(this->getConnectionStatus().isDisconnected(), Q_FUNC_INFO,
                   "Can't change ICAO codes while still connected");
        updateOwnIcaoCodes(ownAircraft.getAircraftIcaoCode(), ownAircraft.getAirlineIcaoCode());
 
        QWriteLocker l(&m_lockUserClientBuffered);
        m_ownAircraftIcaoCode = ownAircraft.getAircraftIcaoCode();
        m_ownAirlineIcaoCode = ownAircraft.getAirlineIcaoCode();
 
        /* use setLiveryAndModelString
        No longer do it here, use setLiveryAndModelString
        m_ownLivery           = ownAircraft.getModel().getSwiftLiveryString(m_simTypeInfo);
        m_ownModelString      = ownAircraft.getModelString();
        m_sendLiveryString    = true;
        m_sendModelString     = true;
        */
    }
 
    void CFSDClient::setLiveryAndModelString(const QString &livery, bool sendLiveryString, const QString &modelString,
                                             bool sendModelString)
    {
        QWriteLocker l(&m_lockUserClientBuffered);
        m_ownLivery = livery;
        m_ownModelString = modelString;
        m_sendLiveryString = sendLiveryString;
        m_sendModelString = sendModelString;
    }
 
    void CFSDClient::setSimType(const CSimulatorInfo &simInfo) { this->setSimType(simInfo.getSimulator()); }
 
    void CFSDClient::setSimType(swift::misc::simulation::CSimulatorInfo::Simulator simulator)
    {
        QWriteLocker l(&m_lockUserClientBuffered);
        switch (simulator)
        {
        case CSimulatorInfo::FSX: m_simType = SimType::MSFSX; break;
        case CSimulatorInfo::P3D: m_simType = SimType::P3Dv4; break;
        case CSimulatorInfo::FS9: m_simType = SimType::MSFS2004; break;
        case CSimulatorInfo::FG: m_simType = SimType::FlightGear; break;
        case CSimulatorInfo::XPLANE: m_simType = SimType::XPLANE11; break;
        case CSimulatorInfo::MSFS: m_simType = SimType::MSFS; break;
        case CSimulatorInfo::MSFS2024: m_simType = SimType::MSFS2024; break;
        default: m_simType = SimType::Unknown; break;
        }
        m_simTypeInfo = CSimulatorInfo(simulator);
    }
 
    QStringList CFSDClient::getPresetValues() const
    {
        QReadLocker l(&m_lockUserClientBuffered);
        const QStringList v = { m_ownModelString,
                                m_ownLivery,
                                m_ownAircraftIcaoCode.getDesignator(),
                                m_ownAirlineIcaoCode.getVDesignator(),
                                m_ownCallsign.asString(),
                                m_partnerCallsign.asString() };
        return v;
    }
 
    void CFSDClient::connectToServer()
    {
        if (!CThreadUtils::isInThisThread(this))
        {
            QMetaObject::invokeMethod(this, [=] {
                if (sApp && !sApp->isShuttingDown()) { connectToServer(); }
            });
            return;
        }
 
        if (m_socket->isOpen()) { return; }
        Q_ASSERT(!m_clientName.isEmpty());
        Q_ASSERT((m_versionMajor + m_versionMinor) > 0);
        Q_ASSERT(m_capabilities != Capabilities::None);
 
        if (m_hostApplication.isEmpty()) { m_hostApplication = this->getSimulatorNameAndVersion().replace(':', ' '); }
 
        this->clearState();
        m_filterPasswordFromLogin = true;
 
        m_loginSince = QDateTime::currentMSecsSinceEpoch();
        const qint64 timerMs = qRound(PendingConnectionTimeoutMs * 1.25);
 
        const QPointer<CFSDClient> myself(this);
        QTimer::singleShot(timerMs, this, [=] {
            if (!myself || !sApp || sApp->isShuttingDown()) { return; }
            this->pendingTimeoutCheck();
        });
 
        this->updateConnectionStatus(CConnectionStatus::Connecting);
 
        initiateConnection();
    }
 
    void CFSDClient::disconnectFromServer()
    {
        if (!CThreadUtils::isInThisThread(this))
        {
            QMetaObject::invokeMethod(this, [=] {
                if (sApp && !sApp->isShuttingDown()) { disconnectFromServer(); }
            });
            return;
        }
 
        this->stopPositionTimers();
        this->updateConnectionStatus(CConnectionStatus::Disconnecting);
 
        // allow also to close if broken
        CLoginMode mode = this->getLoginMode();
        if (m_socket->isOpen())
        {
            if (mode.isPilot()) { this->sendDeletePilot(); }
            else if (mode.isObserver()) { this->sendDeleteAtc(); }
        }
        m_socket->close();
 
        this->updateConnectionStatus(CConnectionStatus::Disconnected);
        this->clearState();
    }
 
    void CFSDClient::sendLogin(const QString &token)
    {
        const CServer s = this->getServer();
        const QString cid = s.getUser().getId();
        const QString password = token.isEmpty() ? s.getUser().getPassword() : token;
        const QString name = s.getUser().getRealNameAndHomeBase(); // m_server.getUser().getRealName();
        const QString callsign = m_ownCallsign.asString();
 
        const CLoginMode m = this->getLoginMode();
        if (m.isPilot())
        {
            const AddPilot pilotLogin(callsign, cid, password, m_pilotRating, m_protocolRevision, m_simType, name);
            sendQueuedMessage(pilotLogin);
            CStatusMessage(this).info(u"Sending login as '%1' '%2' '%3' '%4' '%5' '%6'")
                << callsign << cid << toQString(m_pilotRating) << m_protocolRevision << toQString(m_simType) << name;
        }
        else if (m.isObserver())
        {
            const AddAtc addAtc(callsign, name, cid, password, m_atcRating, m_protocolRevision);
            sendQueuedMessage(addAtc);
            CStatusMessage(this).info(u"Sending OBS login as '%1' '%2' '%3' '%4' '%5'")
                << callsign << cid << toQString(m_atcRating) << m_protocolRevision << name;
        }
 
        if (m_server.getFsdSetup().receiveEuroscopeSimData())
        {
            this->sendClientQuery(ClientQueryType::EuroscopeSimData, {}, {});
        }
    }
 
    void CFSDClient::sendDeletePilot()
    {
        const QString cid = this->getServer().getUser().getId();
        const DeletePilot deletePilot(m_ownCallsign.getFsdCallsignString(), cid);
        sendQueuedMessage(deletePilot);
    }
 
    void CFSDClient::sendDeleteAtc()
    {
        const QString cid = this->getServer().getUser().getId();
        const DeleteAtc deleteAtc(getOwnCallsignAsString(), cid);
        sendQueuedMessage(deleteAtc);
    }
 
    void CFSDClient::sendPilotDataUpdate()
    {
        if (this->getConnectionStatus().isDisconnected() && !m_unitTestMode) { return; }
        const CSimulatedAircraft myAircraft(getOwnAircraft());
        if (m_loginMode == CLoginMode::Observer)
        {
            sendAtcDataUpdate(myAircraft.latitude().value(CAngleUnit::deg()),
                              myAircraft.longitude().value(CAngleUnit::deg()));
        }
        else
        {
            if (this->isVisualPositionSendingEnabledForServer())
            {
                // Slowfast must be sent before the ordinary update.
                // Sending after causes a server performance issue.
                // See https://discord.com/channels/775552633918062643/775736423319732256/960746661259390996
                sendVisualPilotDataUpdate(true);
            }
 
            PilotRating r = this->getPilotRating();
            PilotDataUpdate pilotDataUpdate(
                myAircraft.getTransponderMode(), getOwnCallsignAsString(),
                static_cast<qint16>(myAircraft.getTransponderCode()), r, myAircraft.latitude().value(CAngleUnit::deg()),
                myAircraft.longitude().value(CAngleUnit::deg()),
                myAircraft.getAltitude().valueInteger(CLengthUnit::ft()),
                myAircraft.getPressureAltitude().valueInteger(CLengthUnit::ft()),
                myAircraft.getGroundSpeed().valueInteger(CSpeedUnit::kts()),
                myAircraft.getPitch().value(CAngleUnit::deg()), myAircraft.getBank().value(CAngleUnit::deg()),
                myAircraft.getHeading().normalizedTo360Degrees().value(CAngleUnit::deg()),
                myAircraft.getParts().isOnGround());
            sendQueuedMessage(pilotDataUpdate);
        }
    }
 
    void CFSDClient::sendInterimPilotDataUpdate()
    {
        if (this->getConnectionStatus().isDisconnected()) { return; }
        const CSimulatedAircraft myAircraft(getOwnAircraft());
        InterimPilotDataUpdate interimPilotDataUpdate(
            getOwnCallsignAsString(), QString(), myAircraft.latitude().value(CAngleUnit::deg()),
            myAircraft.longitude().value(CAngleUnit::deg()), myAircraft.getAltitude().valueInteger(CLengthUnit::ft()),
            myAircraft.getGroundSpeed().valueInteger(CSpeedUnit::kts()), myAircraft.getPitch().value(CAngleUnit::deg()),
            myAircraft.getBank().value(CAngleUnit::deg()),
            myAircraft.getHeading().normalizedTo360Degrees().value(CAngleUnit::deg()),
            myAircraft.getParts().isOnGround());
 
        for (const auto &receiver : std::as_const(m_interimPositionReceivers))
        {
            interimPilotDataUpdate.setReceiver(receiver.asString());
            sendQueuedMessage(interimPilotDataUpdate);
            // statistics
        }
    }
 
    void CFSDClient::sendVisualPilotDataUpdate(bool slowUpdate)
    {
        if (this->getConnectionStatus().isDisconnected() && !m_unitTestMode) { return; }
        if (m_loginMode == CLoginMode::Observer || !isVisualPositionSendingEnabledForServer()) { return; }
        const CSimulatedAircraft myAircraft(getOwnAircraft());
 
        if (!slowUpdate)
        {
            static constexpr double minVelocity = 0.00005;
            if (std::abs(myAircraft.getVelocity().getVelocityX(CSpeedUnit::m_s())) < minVelocity &&
                std::abs(myAircraft.getVelocity().getVelocityY(CSpeedUnit::m_s())) < minVelocity &&
                std::abs(myAircraft.getVelocity().getVelocityZ(CSpeedUnit::m_s())) < minVelocity &&
                std::abs(myAircraft.getVelocity().getPitchVelocity(CAngleUnit::rad(), CTimeUnit::s())) < minVelocity &&
                std::abs(myAircraft.getVelocity().getRollVelocity(CAngleUnit::rad(), CTimeUnit::s())) < minVelocity &&
                std::abs(myAircraft.getVelocity().getHeadingVelocity(CAngleUnit::rad(), CTimeUnit::s())) < minVelocity)
            {
                if (m_stoppedSendingVisualPositions) { return; }
                m_stoppedSendingVisualPositions = true;
                m_visualPositionUpdateSentCount = 0;
            }
            else { m_stoppedSendingVisualPositions = false; }
 
            if (!m_serverWantsVisualPositions) { return; }
        }
        VisualPilotDataUpdate visualPilotDataUpdate(
            getOwnCallsignAsString(), myAircraft.latitude().value(CAngleUnit::deg()),
            myAircraft.longitude().value(CAngleUnit::deg()), myAircraft.getAltitude().value(CLengthUnit::ft()),
            myAircraft.getAltitude().value(CLengthUnit::ft()) -
                myAircraft.getGroundElevation().value(CLengthUnit::ft()),
            myAircraft.getPitch().value(CAngleUnit::deg()), myAircraft.getBank().value(CAngleUnit::deg()),
            myAircraft.getHeading().normalizedTo360Degrees().value(CAngleUnit::deg()),
            myAircraft.getVelocity().getVelocityX(CSpeedUnit::m_s()),
            myAircraft.getVelocity().getVelocityY(CSpeedUnit::m_s()),
            myAircraft.getVelocity().getVelocityZ(CSpeedUnit::m_s()),
            myAircraft.getVelocity().getPitchVelocity(CAngleUnit::rad(), CTimeUnit::s()),
            myAircraft.getVelocity().getRollVelocity(CAngleUnit::rad(), CTimeUnit::s()),
            myAircraft.getVelocity().getHeadingVelocity(CAngleUnit::rad(), CTimeUnit::s()));
 
        if (m_stoppedSendingVisualPositions) { sendQueuedMessage(visualPilotDataUpdate.toStopped()); }
        else if (m_visualPositionUpdateSentCount++ % 25 == 0) { sendQueuedMessage(visualPilotDataUpdate.toPeriodic()); }
        else { sendQueuedMessage(visualPilotDataUpdate); }
    }
 
    void CFSDClient::sendAtcDataUpdate(double latitude, double longitude)
    {
        const AtcDataUpdate atcDataUpdate(getOwnCallsignAsString(), 199998, CFacilityType::OBS, 300,
                                          AtcRating::Observer, latitude, longitude, 0);
        sendQueuedMessage(atcDataUpdate);
    }
 
    void CFSDClient::sendPing(const QString &receiver)
    {
        const qint64 msecSinceEpoch = QDateTime::currentMSecsSinceEpoch();
        const QString timeString = QString::number(msecSinceEpoch);
 
        const Ping ping(getOwnCallsignAsString(), receiver, timeString);
        sendQueuedMessage(ping);
 
        // statistics
        increaseStatisticsValue(QStringLiteral("sendPing"));
    }
 
    void CFSDClient::sendClientQueryIsValidAtc(const CCallsign &callsign)
    {
        sendClientQuery(ClientQueryType::IsValidATC, {}, { callsign.asString() });
    }
 
    void CFSDClient::sendClientQueryCapabilities(const CCallsign &callsign)
    {
        sendClientQuery(ClientQueryType::Capabilities, callsign);
    }
 
    void CFSDClient::sendClientQueryCom1Freq(const CCallsign &callsign)
    {
        sendClientQuery(ClientQueryType::Com1Freq, callsign);
    }
 
    void CFSDClient::sendClientQueryRealName(const CCallsign &callsign)
    {
        sendClientQuery(ClientQueryType::RealName, callsign);
    }
 
    void CFSDClient::sendClientQueryServer(const CCallsign &callsign)
    {
        sendClientQuery(ClientQueryType::Server, callsign);
    }
 
    void CFSDClient::sendClientQueryAtis(const CCallsign &callsign)
    {
        sendClientQuery(ClientQueryType::ATIS, callsign);
    }
 
    void CFSDClient::sendClientQueryFlightPlan(const CCallsign &callsign)
    {
        sendClientQuery(ClientQueryType::FP, {}, { callsign.toQString() });
    }
 
    void CFSDClient::sendClientQueryAircraftConfig(const CCallsign &callsign)
    {
        QString data = QJsonDocument(JsonPackets::aircraftConfigRequest()).toJson(QJsonDocument::Compact);
        data = convertToUnicodeEscaped(data);
        sendClientQuery(ClientQueryType::AircraftConfig, callsign, { data });
    }
 
    void CFSDClient::sendClientQuery(ClientQueryType queryType, const CCallsign &receiver, const QStringList &queryData)
    {
        if (queryType == ClientQueryType::Unknown) { return; }
        if (!CThreadUtils::isInThisThread(this))
        {
            QMetaObject::invokeMethod(this, [=] {
                if (sApp && !sApp->isShuttingDown()) { sendClientQuery(queryType, receiver, queryData); }
            });
            return;
        }
 
        const QString receiverCallsign = receiver.getFsdCallsignString();
        if (queryType == ClientQueryType::IsValidATC)
        {
            const ClientQuery clientQuery(getOwnCallsignAsString(), "SERVER", ClientQueryType::IsValidATC, queryData);
            sendQueuedMessage(clientQuery);
        }
        else if (queryType == ClientQueryType::Capabilities)
        {
            const ClientQuery clientQuery(getOwnCallsignAsString(), receiverCallsign, ClientQueryType::Capabilities);
            sendQueuedMessage(clientQuery);
        }
        else if (queryType == ClientQueryType::Com1Freq)
        {
            const ClientQuery clientQuery(getOwnCallsignAsString(), receiverCallsign, ClientQueryType::Com1Freq);
            sendQueuedMessage(clientQuery);
        }
        else if (queryType == ClientQueryType::RealName)
        {
            const ClientQuery clientQuery(getOwnCallsignAsString(), receiverCallsign, ClientQueryType::RealName);
            sendQueuedMessage(clientQuery);
        }
        else if (queryType == ClientQueryType::Server)
        {
            ClientQuery clientQuery(getOwnCallsignAsString(), receiverCallsign, ClientQueryType::Server);
            sendQueuedMessage(clientQuery);
        }
        else if (queryType == ClientQueryType::ATIS)
        {
            const ClientQuery clientQuery(getOwnCallsignAsString(), receiverCallsign, ClientQueryType::ATIS);
            sendQueuedMessage(clientQuery);
            if (m_serverType != ServerType::Vatsim) { m_pendingAtisQueries.insert(receiver, {}); }
        }
        else if (queryType == ClientQueryType::PublicIP)
        {
            const ClientQuery clientQuery(getOwnCallsignAsString(), receiverCallsign, ClientQueryType::PublicIP);
            sendQueuedMessage(clientQuery);
        }
        else if (queryType == ClientQueryType::INF)
        {
            const ClientQuery clientQuery(getOwnCallsignAsString(), receiverCallsign, ClientQueryType::INF);
            sendQueuedMessage(clientQuery);
        }
        else if (queryType == ClientQueryType::FP)
        {
            if (queryData.isEmpty()) { return; }
            const ClientQuery clientQuery(getOwnCallsignAsString(), "SERVER", ClientQueryType::FP, queryData);
            sendQueuedMessage(clientQuery);
        }
        else if (queryType == ClientQueryType::AircraftConfig)
        {
            if (queryData.isEmpty()) { return; }
            const ClientQuery clientQuery(getOwnCallsignAsString(), receiverCallsign, ClientQueryType::AircraftConfig,
                                          queryData);
            sendQueuedMessage(clientQuery);
        }
        else if (queryType == ClientQueryType::EuroscopeSimData)
        {
            const ClientQuery clientQuery(getOwnCallsignAsString(), "@94835", ClientQueryType::EuroscopeSimData,
                                          { "1" });
            sendQueuedMessage(clientQuery);
        }
 
        increaseStatisticsValue(QStringLiteral("sendClientQuery"), toQString(queryType));
    }
 
    void CFSDClient::sendTextMessages(const CTextMessageList &messages)
    {
        if (messages.isEmpty()) { return; }
        if (!CThreadUtils::isInThisThread(this))
        {
            QMetaObject::invokeMethod(this, [=] {
                if (sApp && !sApp->isShuttingDown()) { sendTextMessages(messages); }
            });
            return;
        }
 
        const CTextMessageList privateMessages = messages.getPrivateMessages().markedAsSent();
        const QString ownCallsign = getOwnCallsignAsString();
 
        for (const auto &message : privateMessages)
        {
            if (message.getRecipientCallsign().isEmpty()) { continue; }
            const TextMessage textMessage(ownCallsign, message.getRecipientCallsign().getFsdCallsignString(),
                                          message.getMessage());
            sendQueuedMessage(textMessage);
            increaseStatisticsValue(QStringLiteral("sendTextMessages.PM"));
            emit textMessageSent(message);
        }
 
        const CTextMessageList radioMessages = messages.getRadioMessages().markedAsSent();
        QVector<int> frequencies;
        for (const auto &message : radioMessages)
        {
            // Adjust to nearest frequency, in case of 5kHz difference
            const CAtcStationList stations = m_atcStations.findIfFrequencyIsWithinSpacing(message.getFrequency());
            const CFrequency freq = stations.isEmpty() ?
                                        message.getFrequency() :
                                        stations.findClosest(1, getOwnAircraftPosition()).front().getFrequency();
 
            // I could send the same message to n frequencies in one step
            // if this is really required, I need to group by message
            // currently I send individual messages
            frequencies.clear();
            int freqkHz = freq.valueInteger(CFrequencyUnit::kHz());
            frequencies.push_back(freqkHz);
            sendRadioMessage(frequencies, message.getMessage());
            increaseStatisticsValue(QStringLiteral("sendTextMessages.FREQ"));
            emit textMessageSent(message);
        }
    }
 
    void CFSDClient::sendTextMessage(const CTextMessage &message)
    {
        if (message.isEmpty()) { return; }
        sendTextMessages({ message });
    }
 
    void CFSDClient::sendTextMessage(TextMessageGroups receiverGroup, const QString &message)
    {
        if (message.isEmpty()) { return; }
        if (!CThreadUtils::isInThisThread(this))
        {
            QMetaObject::invokeMethod(this, [=] {
                if (sApp && !sApp->isShuttingDown()) { sendTextMessage(receiverGroup, message); }
            });
            return;
        }
 
        QString receiver;
        if (receiverGroup == TextMessageGroups::AllClients) { receiver = '*'; }
        else if (receiverGroup == TextMessageGroups::AllAtcClients) { receiver = QStringLiteral("*A"); }
        else if (receiverGroup == TextMessageGroups::AllPilotClients) { receiver = QStringLiteral("*P"); }
        else if (receiverGroup == TextMessageGroups::AllSups) { receiver = QStringLiteral("*S"); }
        else { return; }
        const TextMessage textMessage(getOwnCallsignAsString(), receiver, message);
        sendQueuedMessage(textMessage);
        if (receiver == QStringLiteral("*S"))
        {
            const CCallsign sender(getOwnCallsignAsString());
            const CCallsign recipient(receiver);
            CTextMessage t(message, sender, recipient);
            t.markAsSent();
            emit textMessageSent(t);
        }
        increaseStatisticsValue(QStringLiteral("sendTextMessages"));
    }
 
    void CFSDClient::sendTextMessage(const QString &receiver, const QString &message)
    {
        const CTextMessage msg(message, getOwnCallsign(), { receiver });
        sendTextMessage(msg);
    }
 
    void CFSDClient::sendRadioMessage(const QVector<int> &frequencieskHz, const QString &message)
    {
        QStringList receivers;
        for (const int &frequency : frequencieskHz)
        {
            receivers.push_back(QStringLiteral("@%1").arg(frequency - 100000));
        }
 
        const TextMessage radioMessage(getOwnCallsignAsString(), receivers.join('&'), message);
        sendQueuedMessage(radioMessage);
        increaseStatisticsValue(QStringLiteral("sendTextMessages"));
    }
 
    void CFSDClient::sendFlightPlan(const CFlightPlan &flightPlan)
    {
        if (!CThreadUtils::isInThisThread(this))
        {
            QMetaObject::invokeMethod(this, [=] {
                if (sApp && !sApp->isShuttingDown()) { sendFlightPlan(flightPlan); }
            });
            return;
        }
 
        // Removed with T353 although it is standard
        // const QString route = QString(flightPlan.getRoute()).replace(" ", ".");
 
        QString route = flightPlan.getRoute();
        QString remarks = flightPlan.getRemarks();
        route.remove(':');
        remarks.remove(':');
 
        const QString alt = flightPlan.getCruiseAltitude().asFpVatsimAltitudeString();
        // const QString alt = flightPlan.getCruiseAltitude().asFpAltitudeString();
 
        FlightType flightType = getFlightType(flightPlan.getFlightRules());
 
        QString act;
 
        if (m_server.getFsdSetup().shouldSendFlightPlanEquipmentInIcaoFormat())
        {
            act = flightPlan.getAircraftInfo().asIcaoString();
        }
        else { act = flightPlan.getAircraftInfo().asFaaString(); }
 
        Q_ASSERT_X(!act.isEmpty(), Q_FUNC_INFO, "Aircraft type must not be empty");
 
        const QList<int> timePartsEnroute = flightPlan.getEnrouteTime().getHrsMinSecParts();
        const QList<int> timePartsFuel = flightPlan.getFuelTime().getHrsMinSecParts();
        const FlightPlan fp(getOwnCallsignAsString(), "SERVER", flightType, act,
                            flightPlan.getCruiseTrueAirspeed().valueInteger(CSpeedUnit::kts()),
                            flightPlan.getOriginAirportIcao().asString(),
                            flightPlan.getTakeoffTimePlanned().toUTC().toString("hhmm").toInt(),
                            flightPlan.getTakeoffTimeActual().toUTC().toString("hhmm").toInt(), alt,
                            flightPlan.getDestinationAirportIcao().asString(), timePartsEnroute[CTime::Hours],
                            timePartsEnroute[CTime::Minutes], timePartsFuel[CTime::Hours],
                            timePartsFuel[CTime::Minutes], flightPlan.getAlternateAirportIcao().asString(), remarks,
                            route);
 
        sendQueuedMessage(fp);
        increaseStatisticsValue(QStringLiteral("sendFlightPlan"));
    }
 
    void CFSDClient::sendPlaneInfoRequest(const CCallsign &receiver)
    {
        if (!CThreadUtils::isInThisThread(this))
        {
            QMetaObject::invokeMethod(this, [=] {
                if (sApp && !sApp->isShuttingDown()) { sendPlaneInfoRequest(receiver); }
            });
            return;
        }
 
        const PlaneInfoRequest planeInfoRequest(getOwnCallsignAsString(), receiver.toQString());
        sendQueuedMessage(planeInfoRequest);
        increaseStatisticsValue(QStringLiteral("sendPlaneInfoRequest"));
    }
 
    void CFSDClient::sendPlaneInfoRequestFsinn(const CCallsign &callsign)
    {
        if (!CThreadUtils::isInThisThread(this))
        {
            QMetaObject::invokeMethod(this, [=] {
                if (sApp && !sApp->isShuttingDown()) { sendPlaneInfoRequestFsinn(callsign); }
            });
            return;
        }
 
        const bool connected = isConnected();
        SWIFT_VERIFY_X(connected, Q_FUNC_INFO, "Can't send to server when disconnected");
        if (!connected) { return; }
 
        const CSimulatedAircraft myAircraft(getOwnAircraft());
        const QString modelString = this->getConfiguredModelString(myAircraft);
        const PlaneInfoRequestFsinn planeInfoRequestFsinn(
            getOwnCallsignAsString(), callsign.toQString(), myAircraft.getAirlineIcaoCodeDesignator(),
            myAircraft.getAircraftIcaoCodeDesignator(), myAircraft.getAircraftIcaoCombinedType(), modelString);
        sendQueuedMessage(planeInfoRequestFsinn);
        increaseStatisticsValue(QStringLiteral("sendPlaneInfoRequestFsinn"));
    }
 
    void CFSDClient::sendPlaneInformation(const QString &receiver, const QString &aircraft, const QString &airline,
                                          const QString &livery)
    {
        const PlaneInformation planeInformation(getOwnCallsignAsString(), receiver, aircraft, airline, livery);
        sendQueuedMessage(planeInformation);
        increaseStatisticsValue(QStringLiteral("sendPlaneInformation"));
    }
 
    void CFSDClient::sendPlaneInformationFsinn(const CCallsign &callsign)
    {
        if (this->getConnectionStatus().isDisconnected() && !m_unitTestMode) { return; }
        const CSimulatedAircraft myAircraft(getOwnAircraft());
        const QString modelString = this->getConfiguredModelString(myAircraft);
        const PlaneInformationFsinn planeInformationFsinn(
            getOwnCallsignAsString(), callsign.toQString(), myAircraft.getAirlineIcaoCodeDesignator(),
            myAircraft.getAircraftIcaoCodeDesignator(), myAircraft.getAircraftIcaoCombinedType(), modelString);
        sendQueuedMessage(planeInformationFsinn);
        increaseStatisticsValue(QStringLiteral("sendPlaneInformationFsinn"));
    }
 
    void CFSDClient::sendAircraftConfiguration(const QString &receiver, const QString &aircraftConfigJson)
    {
        if (aircraftConfigJson.size() == 0) { return; }
        const ClientQuery clientQuery(getOwnCallsignAsString(), receiver, ClientQueryType::AircraftConfig,
                                      { aircraftConfigJson });
        sendQueuedMessage(clientQuery);
    }
 
    void CFSDClient::sendMessageString(const QString &message)
    {
        if (message.isEmpty()) { return; }
        const QByteArray bufferEncoded = m_encoder(message);
        if (m_printToConsole) { qDebug() << "FSD Sent=>" << bufferEncoded; }
        if (!m_unitTestMode) { m_socket->write(bufferEncoded); }
 
        // remove CR/LF and emit
        emitRawFsdMessage(message.trimmed(), true);
    }
 
    void CFSDClient::sendQueuedMessage()
    {
        if (m_queuedFsdMessages.isEmpty()) { return; }
        const qsizetype s = m_queuedFsdMessages.size(); // NOLINT(cppcoreguidelines-init-variables)
        this->sendMessageString(m_queuedFsdMessages.dequeue());
 
        // send up to 6 at once
        if (s > 5) { this->sendMessageString(m_queuedFsdMessages.dequeue()); }
        if (s > 10) { this->sendMessageString(m_queuedFsdMessages.dequeue()); }
        if (s > 20) { this->sendMessageString(m_queuedFsdMessages.dequeue()); }
        if (s > 30) { this->sendMessageString(m_queuedFsdMessages.dequeue()); }
 
        // overload
        // no idea, if we ever get here
        if (s > 50)
        {
            const StatusSeverity severity = s > 75 ? SeverityWarning : SeverityInfo;
            CLogMessage(this).log(severity, u"Too many queued messages (%1), bulk send!") << s;
            int sendNo = 10;
            if (s > 75) { sendNo = 20; }
            if (s > 100) { sendNo = 30; }
 
            for (int i = 0; i < sendNo; i++) { this->sendMessageString(m_queuedFsdMessages.dequeue()); }
        }
    }
 
    void CFSDClient::sendFsdMessage(const QString &message)
    {
        // UNIT tests
        parseMessage(message);
    }
 
    QString CFSDClient::getConfiguredModelString(const CSimulatedAircraft &myAircraft) const
    {
        if (!m_sendModelString) { return noModelString(); }
        QReadLocker l(&m_lockUserClientBuffered);
        const QString ms = m_ownModelString.isEmpty() ? myAircraft.getModelString() : m_ownModelString;
        return ms.isEmpty() ? noModelString() : ms;
    }
 
    QString CFSDClient::getConfiguredLiveryString(const CSimulatedAircraft &myAircraft) const
    {
        if (!m_sendLiveryString) { return {}; }
        QReadLocker l(&m_lockUserClientBuffered);
        const QString livery = m_ownLivery.isEmpty() ? myAircraft.getModel().getSwiftLiveryString() : m_ownLivery;
        return livery;
    }
 
    void CFSDClient::sendAuthChallenge(const QString &challenge)
    {
        const AuthChallenge pduAuthChallenge(getOwnCallsignAsString(), "SERVER", challenge);
        sendDirectMessage(pduAuthChallenge); // avoid timeouts
        increaseStatisticsValue(QStringLiteral("sendAuthChallenge"));
    }
 
    void CFSDClient::sendAuthResponse(const QString &response)
    {
        const AuthResponse pduAuthResponse(getOwnCallsignAsString(), "SERVER", response);
        sendDirectMessage(pduAuthResponse); // avoid timeouts
        increaseStatisticsValue(QStringLiteral("sendAuthResponse"));
    }
 
    void CFSDClient::sendPong(const QString &receiver, const QString &timestamp)
    {
        const Pong pong(getOwnCallsignAsString(), receiver, timestamp);
        sendQueuedMessage(pong);
        increaseStatisticsValue(QStringLiteral("sendPong"));
    }
 
    void CFSDClient::sendClientResponse(ClientQueryType queryType, const QString &receiver)
    {
        if (queryType == ClientQueryType::Unknown) { return; }
        if (queryType == ClientQueryType::IsValidATC)
        {
            this->handleIllegalFsdState("Never use sendClientResponse with IsValidATC from the client");
            return;
        }
 
        increaseStatisticsValue(QStringLiteral("sendClientResponse"), toQString(queryType));
 
        QStringList responseData;
        const QString ownCallsign = getOwnCallsignAsString();
 
        if (queryType == ClientQueryType::Capabilities)
        {
            responseData.clear();
            if (m_capabilities & Capabilities::AtcInfo) responseData.push_back(toQString(Capabilities::AtcInfo) % "=1");
            if (m_capabilities & Capabilities::SecondaryPos)
                responseData.push_back(toQString(Capabilities::SecondaryPos) % "=1");
            if (m_capabilities & Capabilities::AircraftInfo)
                responseData.push_back(toQString(Capabilities::AircraftInfo) % "=1");
            if (m_capabilities & Capabilities::OngoingCoord)
                responseData.push_back(toQString(Capabilities::OngoingCoord) % "=1");
            if (m_capabilities & Capabilities::InterminPos)
                responseData.push_back(toQString(Capabilities::InterminPos) % "=1");
            if (m_capabilities & Capabilities::FastPos) responseData.push_back(toQString(Capabilities::FastPos) % "=1");
            if (m_capabilities & Capabilities::VisPos) responseData.push_back(toQString(Capabilities::VisPos) % "=1");
            if (m_capabilities & Capabilities::Stealth) responseData.push_back(toQString(Capabilities::Stealth) % "=1");
            if (m_capabilities & Capabilities::AircraftConfig)
                responseData.push_back(toQString(Capabilities::AircraftConfig) % "=1");
            if (m_capabilities & Capabilities::IcaoEquipment)
                responseData.push_back(toQString(Capabilities::IcaoEquipment) % "=1");
            const ClientResponse clientResponse(ownCallsign, receiver, ClientQueryType::Capabilities, responseData);
            sendQueuedMessage(clientResponse);
        }
        else if (queryType == ClientQueryType::Com1Freq)
        {
            const QString com1Frequency = QString::number(
                getOwnAircraft().getCom1System().getFrequencyActive().value(CFrequencyUnit::MHz()), 'f', 3);
            responseData.push_back(com1Frequency);
            const ClientResponse pduClientResponse(ownCallsign, receiver, ClientQueryType::Com1Freq, responseData);
            sendQueuedMessage(pduClientResponse);
        }
        else if (queryType == ClientQueryType::RealName)
        {
            // real name
            // responseData.push_back(m_server.getUser().getRealName());
            responseData.push_back(m_server.getUser().getRealNameAndHomeBase()); // getHomeBase
            // sector file in use (blank if pilot)
            responseData.push_back({});
            // current user rating
            if (m_loginMode.isObserver()) { responseData.push_back(toQString(m_atcRating)); }
            else { responseData.push_back(toQString(m_pilotRating)); }
 
            const ClientResponse pduClientQueryResponse(ownCallsign, receiver, ClientQueryType::RealName, responseData);
            sendQueuedMessage(pduClientQueryResponse);
        }
        else if (queryType == ClientQueryType::Server)
        {
            responseData.push_back(m_server.getAddress());
            const ClientResponse pduClientQueryResponse(ownCallsign, receiver, ClientQueryType::Server, responseData);
            sendQueuedMessage(pduClientQueryResponse);
        }
        else if (queryType == ClientQueryType::ATIS)
        {
            this->handleIllegalFsdState(
                QStringLiteral("Dont send '%1' as pilot client!").arg(toQString(ClientQueryType::ATIS)));
        }
        else if (queryType == ClientQueryType::PublicIP)
        {
            this->handleIllegalFsdState(
                QStringLiteral("Dont send '%1' as pilot client!").arg(toQString(ClientQueryType::PublicIP)));
        }
        else if (queryType == ClientQueryType::INF)
        {
            const QString cid = m_server.getUser().getId();
            const QString realName = m_server.getUser().getRealName();
 
            const CAircraftSituation situation = this->getOwnAircraftPosition();
            const double latitude = situation.latitude().value(CAngleUnit::deg());
            const double longitude = situation.longitude().value(CAngleUnit::deg());
            const int altitude = situation.getAltitude().valueInteger(CLengthUnit::ft());
 
            std::array<char, 50> sysuid = {};
#ifdef SWIFT_VATSIM_SUPPORT
            vatsim_get_system_unique_id(sysuid.data());
#endif
 
            const QString userInfo = QStringLiteral("CID=") % cid % " " % m_clientName % " IP=" %
                                     m_socket->localAddress().toString() % " SYS_UID=" % sysuid.data() % " FSVER=" %
                                     m_hostApplication % " LT=" % QString::number(latitude) % " LO=" %
                                     QString::number(longitude) % " AL=" % QString::number(altitude) % " " % realName;
 
            const TextMessage textMessage(ownCallsign, receiver, userInfo);
            sendQueuedMessage(textMessage);
        }
        else if (queryType == ClientQueryType::FP)
        {
            this->handleIllegalFsdState(
                QStringLiteral("Dont send '%1' as pilot client!").arg(toQString(ClientQueryType::FP)));
        }
        else if (queryType == ClientQueryType::AircraftConfig)
        {
            this->handleIllegalFsdState(
                QStringLiteral("Dont send '%1' as pilot client!").arg(toQString(ClientQueryType::AircraftConfig)));
        }
    }
 
#ifdef SWIFT_VATSIM_SUPPORT
    void CFSDClient::sendClientIdentification(const QString &fsdChallenge)
    {
        std::array<char, 50> sysuid = {};
        vatsim_get_system_unique_id(sysuid.data());
        const QString cid = m_server.getUser().getId();
        const ClientIdentification clientIdentification(
            getOwnCallsignAsString(), vatsim_auth_get_client_id(m_clientAuth), m_clientName, m_versionMajor,
            m_versionMinor, cid, sysuid.data(), fsdChallenge);
        this->sendQueuedMessage(clientIdentification);
 
        if (getServer().getEcosystem().isSystem(CEcosystem::VATSIM))
        {
            this->getVatsimAuthToken(cid, m_server.getUser().getPassword(),
                                     { this, [this](const QString &token) {
                                          this->sendLogin(token);
                                          this->updateConnectionStatus(CConnectionStatus::Connected);
                                      } });
        }
        else
        {
            this->sendLogin();
            this->updateConnectionStatus(CConnectionStatus::Connected);
        }
        increaseStatisticsValue(QStringLiteral("sendClientIdentification"));
    }
#endif
 
    void CFSDClient::getVatsimAuthToken(const QString &cid, const QString &password,
                                        const swift::misc::CSlot<void(const QString &)> &callback)
    {
        Q_ASSERT_X(sApp, Q_FUNC_INFO, "Need app");
        QNetworkRequest nwRequest(sApp->getGlobalSetup().getVatsimAuthUrl());
        nwRequest.setHeader(QNetworkRequest::ContentTypeHeader, "application/json");
        const QJsonObject jsonRequest { { "cid", cid }, { "password", password } };
 
        sApp->postToNetwork(nwRequest, CApplication::NoLogRequestId, QJsonDocument(jsonRequest).toJson(),
                            { this, [=](QNetworkReply *nwReply) {
                                 const QByteArray data = nwReply->readAll();
                                 const QJsonObject json = QJsonDocument::fromJson(data).object();
 
                                 if (json.value("success").toBool()) { callback(json.value("token").toString()); }
                                 else
                                 {
                                     const QString error = json.value("error_msg").isString() ?
                                                               json.value("error_msg").toString() :
                                                               nwReply->errorString();
                                     CLogMessage(this).error(u"VATSIM auth token endpoint: %1") << error;
                                     disconnectFromServer();
                                 }
                                 nwReply->deleteLater();
                             } });
    }
 
    void CFSDClient::sendIncrementalAircraftConfig()
    {
        if (!m_unitTestMode && (!this->isConnected() || !this->getSetupForServer().sendAircraftParts())) { return; }
        const CAircraftParts currentParts(this->getOwnAircraftParts());
 
        // If it hasn't changed, return
        if (m_sentAircraftConfig == currentParts) { return; }
 
        if (!m_tokenBucket.tryConsume()) { return; }
 
        const QJsonObject previousConfig = m_sentAircraftConfig.toJson();
        const QJsonObject currentConfig = currentParts.toJson();
        const QJsonObject incrementalConfig = getIncrementalObject(previousConfig, currentConfig);
 
        const QString dataStr = convertToUnicodeEscaped(
            QJsonDocument(QJsonObject { { "config", incrementalConfig } }).toJson(QJsonDocument::Compact));
 
        sendAircraftConfiguration("@94836", dataStr);
        m_sentAircraftConfig = currentParts;
    }
 
    void CFSDClient::initializeMessageTypes()
    {
        m_messageTypeMapping["#AA"] = MessageType::AddAtc;
        m_messageTypeMapping["#AP"] = MessageType::AddPilot;
        m_messageTypeMapping["%"] = MessageType::AtcDataUpdate;
        m_messageTypeMapping["$ZC"] = MessageType::AuthChallenge;
        m_messageTypeMapping["$ZR"] = MessageType::AuthResponse;
        m_messageTypeMapping["$ID"] = MessageType::ClientIdentification;
        m_messageTypeMapping["$CQ"] = MessageType::ClientQuery;
        m_messageTypeMapping["$CR"] = MessageType::ClientResponse;
        m_messageTypeMapping["#DA"] = MessageType::DeleteATC;
        m_messageTypeMapping["#DP"] = MessageType::DeletePilot;
        m_messageTypeMapping["$FP"] = MessageType::FlightPlan;
        m_messageTypeMapping["#PC"] = MessageType::ProController;
        m_messageTypeMapping["$DI"] = MessageType::FsdIdentification;
        m_messageTypeMapping["$!!"] = MessageType::KillRequest;
        m_messageTypeMapping["@"] = MessageType::PilotDataUpdate;
        m_messageTypeMapping["^"] = MessageType::VisualPilotDataUpdate;
        m_messageTypeMapping["#SL"] = MessageType::VisualPilotDataPeriodic;
        m_messageTypeMapping["#ST"] = MessageType::VisualPilotDataStopped;
        m_messageTypeMapping["$SF"] = MessageType::VisualPilotDataToggle;
        m_messageTypeMapping["$PI"] = MessageType::Ping;
        m_messageTypeMapping["$PO"] = MessageType::Pong;
        m_messageTypeMapping["$ER"] = MessageType::ServerError;
        m_messageTypeMapping["#DL"] = MessageType::ServerHeartbeat;
        m_messageTypeMapping["#TM"] = MessageType::TextMessage;
        m_messageTypeMapping["#SB"] = MessageType::PilotClientCom;
        m_messageTypeMapping["$XX"] = MessageType::Rehost;
        m_messageTypeMapping["#MU"] = MessageType::Mute;
 
        // Euroscope
        m_messageTypeMapping["SIMDATA"] = MessageType::EuroscopeSimData;
    }
 
    void CFSDClient::handleAtcDataUpdate(const QStringList &tokens)
    {
        const AtcDataUpdate atcDataUpdate = AtcDataUpdate::fromTokens(tokens);
        const QString senderCs = atcDataUpdate.sender();
        const CCallsign cs(senderCs, CCallsign::Atc);
 
        // Filter non-ATC like OBS stations, like pilots logging in as shared cockpit co-pilots.
        if (atcDataUpdate.m_facility == CFacilityType::Unknown && !cs.isObserverCallsign())
        {
            return;
        } // like in old version
        if (atcDataUpdate.m_facility == CFacilityType::OBS && !cs.hasSuffix()) { return; }
 
        CFrequency freq(atcDataUpdate.m_frequencykHz, CFrequencyUnit::kHz());
        freq.switchUnit(CFrequencyUnit::MHz()); // we would not need to bother, but this makes it easier to identify
 
        // Here we could round to channel spacing, based on
        // https://discordapp.com/channels/539048679160676382/539486489977946112/651514202405601291
        // CComSystem::roundToChannelSpacing(freq, CComSystem::ChannelSpacing25KHz);
 
        const CLength networkRange(atcDataUpdate.m_visibleRange, CLengthUnit::NM());
        const CLength range = fixAtcRange(networkRange, cs);
        const CCoordinateGeodetic position(atcDataUpdate.m_latitude, atcDataUpdate.m_longitude, 0);
 
        emit this->atcDataUpdateReceived(cs, freq, position, range);
 
        m_atcStations.replaceOrAddObjectByCallsign({ cs, {}, freq, position, range });
    }
 
#ifdef SWIFT_VATSIM_SUPPORT
    void CFSDClient::handleAuthChallenge(const QStringList &tokens)
    {
        const AuthChallenge authChallenge = AuthChallenge::fromTokens(tokens);
        char response[33];
        vatsim_auth_generate_response(m_clientAuth, qPrintable(authChallenge.m_challengeKey), response);
        sendAuthResponse(QString(response));
 
        char challenge[33];
        vatsim_auth_generate_challenge(m_serverAuth, challenge);
        m_lastServerAuthChallenge = QString(challenge);
        sendAuthChallenge(m_lastServerAuthChallenge);
    }
#endif
 
#ifdef SWIFT_VATSIM_SUPPORT
    void CFSDClient::handleAuthResponse(const QStringList &tokens)
    {
        const AuthResponse authResponse = AuthResponse::fromTokens(tokens);
 
        char expectedResponse[33];
        vatsim_auth_generate_response(m_serverAuth, qPrintable(m_lastServerAuthChallenge), expectedResponse);
        if (authResponse.m_response != QString(expectedResponse))
        {
            CLogMessage().error(u"The server you are connected to is not a VATSIM server. Disconnecting!");
            disconnectFromServer();
        }
    }
#endif
 
    void CFSDClient::handleDeleteATC(const QStringList &tokens)
    {
        const DeleteAtc deleteAtc = DeleteAtc::fromTokens(tokens);
        emit deleteAtcReceived(deleteAtc.m_cid);
 
        m_atcStations.removeByCallsign(deleteAtc.m_cid);
    }
 
    void CFSDClient::handleDeletePilot(const QStringList &tokens)
    {
        const DeletePilot deletePilot = DeletePilot::fromTokens(tokens);
        const CCallsign cs(deletePilot.sender(), CCallsign::Aircraft);
        clearState(cs);
        emit deletePilotReceived(deletePilot.m_cid);
    }
 
    void CFSDClient::handleTextMessage(const QStringList &tokens)
    {
        const TextMessage textMessage = TextMessage::fromTokens(tokens);
 
        const CCallsign sender(textMessage.sender());
        const CCallsign receiver(textMessage.receiver());
 
        if (textMessage.m_type == TextMessage::PrivateMessage)
        {
            // Other FSD servers send the controller ATIS as text message. The following conditions need to be met:
            // * non-VATSIM server. VATSIM has a specific ATIS message
            // * Receiver callsign must be owner callsign and not any type of broadcast.
            // * We have requested the ATIS of this controller before.
            if (m_server.getServerType() != CServer::FSDServerVatsim &&
                m_ownCallsign.asString() == textMessage.receiver() && m_pendingAtisQueries.contains(sender))
            {
                maybeHandleAtisReply(sender, receiver, textMessage.m_message);
                return;
            }
 
            CTextMessage tm(textMessage.m_message, sender, receiver);
            tm.setCurrentUtcTime();
            this->consolidateTextMessage(tm); // emit textMessagesReceived({ tm });
        }
        else if (textMessage.m_type == TextMessage::RadioMessage)
        {
            const CFrequency com1 = getOwnAircraft().getCom1System().getFrequencyActive();
            const CFrequency com2 = getOwnAircraft().getCom2System().getFrequencyActive();
            QList<CFrequency> frequencies;
 
            for (int freqKhz : textMessage.m_frequencies)
            {
                CFrequency f(freqKhz, CFrequencyUnit::kHz());
                CComSystem::roundToChannelSpacing(f, CComSystem::ChannelSpacing8_33KHz);
                if (f == com1 || f == com2) { frequencies.push_back(f); }
            }
            if (frequencies.isEmpty()) { return; }
            CTextMessageList messages(textMessage.m_message, frequencies, CCallsign(textMessage.sender()));
            messages.setCurrentUtcTime();
            emit textMessagesReceived(messages);
        }
    }
 
    void CFSDClient::handlePilotDataUpdate(const QStringList &tokens)
    {
        const PilotDataUpdate dataUpdate = PilotDataUpdate::fromTokens(tokens);
        const CCallsign callsign(dataUpdate.sender(), CCallsign::Aircraft);
 
        CAircraftSituation situation(
            callsign, CCoordinateGeodetic(dataUpdate.m_latitude, dataUpdate.m_longitude, dataUpdate.m_altitudeTrue),
            CHeading(dataUpdate.m_heading, CHeading::True, CAngleUnit::deg()),
            CAngle(dataUpdate.m_pitch, CAngleUnit::deg()), CAngle(dataUpdate.m_bank, CAngleUnit::deg()),
            CSpeed(dataUpdate.m_groundSpeed, CSpeedUnit::kts()));
        situation.setPressureAltitude(CAltitude(dataUpdate.m_altitudePressure, CAltitude::MeanSeaLevel,
                                                CAltitude::PressureAltitude, CLengthUnit::ft()));
        // NotSetGroundDetails because here we do not know if this FSD protocol actually utilizes this flag
        const COnGroundInfo og(dataUpdate.m_onGround ? COnGroundInfo::OnGround : COnGroundInfo::NotOnGround,
                               COnGroundInfo::NotSetGroundDetails);
        situation.setOnGroundInfo(og);
 
        // Ref T297, default offset time
        situation.setCurrentUtcTime();
        const qint64 offsetTimeMs =
            receivedPositionFixTsAndGetOffsetTime(situation.getCallsign(), situation.getMSecsSinceEpoch());
        situation.setTimeOffsetMs(offsetTimeMs);
 
        // I did have a situation where I got wrong transponder codes (KB)
        // So I now check for a valid code in order to detect such codes
        CTransponder transponder;
        if (CTransponder::isValidTransponderCode(dataUpdate.m_transponderCode))
        {
            transponder = CTransponder(dataUpdate.m_transponderCode, dataUpdate.m_transponderMode);
        }
        else
        {
            if (CBuildConfig::isLocalDeveloperDebugBuild())
            {
                CLogMessage(this).debug(u"Wrong transponder code '%1' for '%2'")
                    << dataUpdate.m_transponderCode << callsign;
            }
 
            // I set a default: IFR standby is a reasonable default
            transponder = CTransponder(2000, CTransponder::StateStandby);
        }
        emit pilotDataUpdateReceived(situation, transponder);
    }
 
    void CFSDClient::handleEuroscopeSimData(const QStringList &tokens)
    {
        const EuroscopeSimData data = EuroscopeSimData::fromTokens(tokens);
 
        CAircraftSituation situation(CCallsign(data.sender(), CCallsign::Aircraft),
                                     CCoordinateGeodetic(data.m_latitude, data.m_longitude, data.m_altitude),
                                     CHeading(data.m_heading, CAngleUnit::deg()),
                                     CAngle(-data.m_pitch, CAngleUnit::deg()), CAngle(-data.m_bank, CAngleUnit::deg()),
                                     CSpeed(data.m_groundSpeed, CSpeedUnit::kts()));
        // NotSetGroundDetails because here we do not know if this FSD protocol actually utilizes this flag
        const COnGroundInfo og(data.m_onGround ? COnGroundInfo::OnGround : COnGroundInfo::NotOnGround,
                               COnGroundInfo::NotSetGroundDetails);
        situation.setOnGroundInfo(og);
 
        // Ref T297, default offset time
        situation.setCurrentUtcTime();
        const qint64 offsetTimeMs =
            receivedPositionFixTsAndGetOffsetTime(situation.getCallsign(), situation.getMSecsSinceEpoch());
        situation.setTimeOffsetMs(offsetTimeMs);
 
        CAircraftParts parts;
        parts.setLights(data.m_lights);
        parts.setGearDown(data.m_gearPercent);
        parts.setOnGround(data.m_onGround);
 
        emit euroscopeSimDataUpdatedReceived(situation, parts, currentOffsetTime(data.sender()), data.m_model,
                                             data.m_livery);
    }
 
    void CFSDClient::handleVisualPilotDataUpdate(const QStringList & /*tokens*/, MessageType /*messageType*/)
    {
#if 0
        VisualPilotDataUpdate dataUpdate;
        switch (messageType)
        {
        case MessageType::VisualPilotDataUpdate: dataUpdate = VisualPilotDataUpdate::fromTokens(tokens); break;
        case MessageType::VisualPilotDataPeriodic: dataUpdate = VisualPilotDataPeriodic::fromTokens(tokens).toUpdate(); break;
        case MessageType::VisualPilotDataStopped: dataUpdate = VisualPilotDataStopped::fromTokens(tokens).toUpdate(); break;
        default: qFatal("Precondition violated"); break;
        }
        const CCallsign callsign(dataUpdate.sender(), CCallsign::Aircraft);
 
        CAircraftSituation situation(
            callsign,
            CCoordinateGeodetic(dataUpdate.m_latitude, dataUpdate.m_longitude, dataUpdate.m_altitudeTrue),
            CHeading(dataUpdate.m_heading, CHeading::True, CAngleUnit::deg()),
            CAngle(dataUpdate.m_pitch, CAngleUnit::deg()),
            CAngle(dataUpdate.m_bank, CAngleUnit::deg()));
 
        // not used
        // situation.setVelocity(CAircraftVelocity(
        //    dataUpdate.m_xVelocity, dataUpdate.m_yVelocity, dataUpdate.m_zVelocity, CSpeedUnit::m_s(),
        //    dataUpdate.m_pitchRadPerSec, dataUpdate.m_bankRadPerSec, dataUpdate.m_headingRadPerSec, CAngleUnit::rad(), CTimeUnit::s()));
 
        // Ref T297, default offset time
        situation.setCurrentUtcTime();
        const qint64 offsetTimeMs = receivedPositionFixTsAndGetOffsetTime(situation.getCallsign(), situation.getMSecsSinceEpoch());
        situation.setTimeOffsetMs(offsetTimeMs);
 
        emit visualPilotDataUpdateReceived(situation);
#endif
    }
 
    void CFSDClient::handleVisualPilotDataToggle(const QStringList &tokens)
    {
        const VisualPilotDataToggle toggle = VisualPilotDataToggle::fromTokens(tokens);
        m_serverWantsVisualPositions = toggle.m_active;
    }
 
    void CFSDClient::handlePing(const QStringList &tokens)
    {
        const Ping ping = Ping::fromTokens(tokens);
        sendPong(ping.sender(), ping.m_timestamp);
    }
 
    void CFSDClient::handlePong(const QStringList &tokens)
    {
        const Pong pong = Pong::fromTokens(tokens);
        const qint64 msecSinceEpoch = QDateTime::currentMSecsSinceEpoch();
        const qint64 elapsedTime = msecSinceEpoch - pong.m_timestamp.toLongLong();
        emit pongReceived(pong.sender(), static_cast<double>(elapsedTime));
    }
 
    void CFSDClient::handleKillRequest(const QStringList &tokens)
    {
        KillRequest killRequest = KillRequest::fromTokens(tokens);
        emit killRequestReceived(killRequest.m_reason);
        disconnectFromServer();
    }
 
    void CFSDClient::handleFlightPlan(const QStringList &tokens)
    {
        FlightPlan fp = FlightPlan::fromTokens(tokens);
        CFlightPlan::FlightRules rules = CFlightPlan::VFR;
 
        switch (fp.m_flightType)
        {
        case FlightType::VFR: rules = CFlightPlan::VFR; break;
        case FlightType::IFR: rules = CFlightPlan::IFR; break;
        case FlightType::DVFR: rules = CFlightPlan::DVFR; break;
        case FlightType::SVFR: rules = CFlightPlan::SVFR; break;
        }
 
        QString cruiseAltString = fp.m_cruiseAlt.trimmed();
        if (!cruiseAltString.isEmpty() && is09OnlyString(cruiseAltString))
        {
            int ca = cruiseAltString.toInt();
            // we have a 0-9 only string
            // we assume values like 24000 as FL
            // RefT323, also major tool such as PFPX and Simbrief do so
            if (rules == CFlightPlan::IFR)
            {
                if (ca >= 1000) { cruiseAltString = u"FL" % QString::number(ca / 100); }
                else { cruiseAltString = u"FL" % cruiseAltString; }
            }
            else // VFR
            {
                if (ca >= 5000) { cruiseAltString = u"FL" % QString::number(ca / 100); }
                else { cruiseAltString = cruiseAltString % u"ft"; }
            }
        }
        CAltitude cruiseAlt;
        cruiseAlt.parseFromString(cruiseAltString, CPqString::SeparatorBestGuess);
 
        const QString depTimePlanned = QStringLiteral("0000").append(QString::number(fp.m_estimatedDepTime)).right(4);
        const QString depTimeActual = QStringLiteral("0000").append(QString::number(fp.m_actualDepTime)).right(4);
 
        const CCallsign callsign(fp.sender(), CCallsign::Aircraft);
        const CFlightPlan flightPlan(
            callsign, CFlightPlanAircraftInfo(fp.m_aircraftIcaoType), fp.m_depAirport, fp.m_destAirport,
            fp.m_altAirport, fromStringUtc(depTimePlanned, "hhmm"), fromStringUtc(depTimeActual, "hhmm"),
            CTime(fp.m_hoursEnroute * 60 + fp.m_minutesEnroute, CTimeUnit::min()),
            CTime(fp.m_fuelAvailHours * 60 + fp.m_fuelAvailMinutes, CTimeUnit::min()), cruiseAlt,
            CSpeed(fp.m_trueCruisingSpeed, CSpeedUnit::kts()), rules, fp.m_route, fp.m_remarks);
 
        emit flightPlanReceived(callsign, flightPlan);
    }
 
    void CFSDClient::handleClientQuery(const QStringList &tokens)
    {
        const ClientQuery clientQuery = ClientQuery::fromTokens(tokens);
        // NOLINTBEGIN(bugprone-branch-clone)
        if (clientQuery.m_queryType == ClientQueryType::Unknown) { return; }
        if (clientQuery.m_queryType == ClientQueryType::IsValidATC)
        {
            // This is usually sent to the server only. If it ever arrives here, just ignore it.
        }
        else if (clientQuery.m_queryType == ClientQueryType::Capabilities)
        {
            sendClientResponse(ClientQueryType::Capabilities, clientQuery.sender());
        }
        else if (clientQuery.m_queryType == ClientQueryType::Com1Freq)
        {
            sendClientResponse(ClientQueryType::Com1Freq, clientQuery.sender());
        }
        else if (clientQuery.m_queryType == ClientQueryType::RealName)
        {
            sendClientResponse(ClientQueryType::RealName, clientQuery.sender());
        }
        else if (clientQuery.m_queryType == ClientQueryType::Server)
        {
            sendClientResponse(ClientQueryType::Server, clientQuery.sender());
        }
        else if (clientQuery.m_queryType == ClientQueryType::ATIS)
        {
            // This is answered by ATC clients only. If we get such a request, ignore it.
        }
        else if (clientQuery.m_queryType == ClientQueryType::PublicIP)
        {
            // This is usually sent to the server only. If it ever arrives here, just ignore it.
        }
        else if (clientQuery.m_queryType == ClientQueryType::INF)
        {
            sendClientResponse(ClientQueryType::INF, clientQuery.sender());
        }
        else if (clientQuery.m_queryType == ClientQueryType::FP)
        {
            // This is usually sent to the server only. If it ever arrives here, just ignore it.
        }
        else if (clientQuery.m_queryType == ClientQueryType::AircraftConfig)
        {
            QStringList aircraftConfigTokens = tokens.mid(3);
            QString aircraftConfigJson = aircraftConfigTokens.join(":");
 
            const CCallsign callsign(clientQuery.sender(), CCallsign::Aircraft);
 
            QJsonParseError parserError;
            const QByteArray json = aircraftConfigJson.toUtf8();
            const QJsonDocument doc = QJsonDocument::fromJson(json, &parserError);
 
            if (parserError.error != QJsonParseError::NoError)
            {
                CLogMessage(this).warning(u"Failed to parse aircraft config packet: '%1' packet: '%2'")
                    << parserError.errorString() << QString(json);
                return; // we cannot parse the packet, so we give up here
            }
 
            const QJsonObject packet = doc.object();
            if (packet == JsonPackets::aircraftConfigRequest())
            {
                // this MUST work for NOT IN RANGE aircraft as well
                // Here we send our OWN parts
                QJsonObject config = this->getOwnAircraftParts().toJson();
                config.insert(CAircraftParts::attributeNameIsFullJson(), true);
                QString data = QJsonDocument(QJsonObject { { "config", config } }).toJson(QJsonDocument::Compact);
                data = convertToUnicodeEscaped(data);
                sendAircraftConfiguration(clientQuery.sender(), data);
                return;
            }
 
            const bool inRange = isAircraftInRange(callsign);
            if (!inRange) { return; } // sort out all broadcasts we DO NOT NEED
            if (!getSetupForServer().receiveAircraftParts()) { return; }
            const QJsonObject config = doc.object().value("config").toObject();
            if (config.isEmpty()) { return; }
 
            const qint64 offsetTimeMs = currentOffsetTime(callsign);
            emit aircraftConfigReceived(clientQuery.sender(), config, offsetTimeMs);
        }
        // NOLINTEND(bugprone-branch-clone)
    }
 
    void CFSDClient::handleClientResponse(const QStringList &tokens)
    {
        const ClientResponse clientResponse = ClientResponse::fromTokens(tokens);
        if (clientResponse.isUnknownQuery()) { return; }
        const QString sender = clientResponse.sender();
 
        QString responseData1;
        QString responseData2;
        // NOLINTBEGIN(bugprone-branch-clone)
        if (!clientResponse.m_responseData.empty()) { responseData1 = clientResponse.m_responseData.at(0); }
 
        if (clientResponse.m_responseData.size() > 1) { responseData2 = clientResponse.m_responseData.at(1); }
 
        if (clientResponse.m_queryType == ClientQueryType::IsValidATC)
        {
            emit validAtcResponseReceived(responseData2, responseData1 == u"Y");
        }
        else if (clientResponse.m_queryType == ClientQueryType::Capabilities)
        {
            Capabilities capabilities = Capabilities::None;
            for (auto keyValuePair : clientResponse.m_responseData)
            {
                if (keyValuePair.count('=') != 1) { continue; }
 
                const QStringList split = keyValuePair.split('=');
                if (split.size() < 2) { continue; }
                const QString key = split.at(0);
                const QString value = split.at(1);
 
                if (value == "1") { capabilities |= fromQString<Capabilities>(key); }
            }
 
            CClient::Capabilities caps = CClient::None;
            if (capabilities & Capabilities::AtcInfo) { caps |= CClient::FsdAtisCanBeReceived; }
            if (capabilities & Capabilities::FastPos) { caps |= CClient::FsdWithInterimPositions; }
            if (capabilities & Capabilities::VisPos) { caps |= CClient::FsdWithVisualPositions; }
            if (capabilities & Capabilities::AircraftInfo) { caps |= CClient::FsdWithIcaoCodes; }
            if (capabilities & Capabilities::AircraftConfig) { caps |= CClient::FsdWithAircraftConfig; }
 
            emit capabilityResponseReceived(clientResponse.sender(), caps);
        }
        else if (clientResponse.m_queryType == ClientQueryType::Com1Freq)
        {
            if (responseData1.isEmpty()) { return; }
            bool ok {};
            const double freqMHz = responseData1.toDouble(&ok);
            if (!ok) { return; }
            emit com1FrequencyResponseReceived(clientResponse.sender(), CFrequency(freqMHz, CFrequencyUnit::MHz()));
        }
        else if (clientResponse.m_queryType == ClientQueryType::RealName)
        {
            // The response also includes sector name and pilot rating, but we ignore them here.
            emit realNameResponseReceived(clientResponse.sender(), responseData1);
        }
        else if (clientResponse.m_queryType == ClientQueryType::Server)
        {
            emit serverResponseReceived(clientResponse.sender(), responseData1);
        }
        else if (clientResponse.m_queryType == ClientQueryType::ATIS)
        {
            if (responseData1.isEmpty())
            {
                // networkLog(vatSeverityDebug, "VatFsdClient::handleClientQueryResponse", "ATIS line type cannot be
                // empty!");
            }
            updateAtisMap(clientResponse.sender(), fromQString<AtisLineType>(responseData1), responseData2);
        }
        else if (clientResponse.m_queryType == ClientQueryType::PublicIP)
        {
            // To be implemented if needed
        }
        else if (clientResponse.m_queryType == ClientQueryType::INF)
        {
            // To be implemented if needed
        }
        else if (clientResponse.m_queryType == ClientQueryType::FP)
        {
            // FP is sent back as a $FP answer from the server and never as part of a client response.
        }
        else if (clientResponse.m_queryType == ClientQueryType::AircraftConfig)
        {
            // Currently not existing.
        }
        // NOLINTEND(bugprone-branch-clone)
    }
 
    void CFSDClient::handleServerError(const QStringList &tokens)
    {
        const ServerError serverError = ServerError::fromTokens(tokens);
        switch (serverError.m_errorNumber)
        {
        case ServerErrorCode::CallsignInUse: CLogMessage(this).error(u"The requested callsign is already taken"); break;
        case ServerErrorCode::InvalidCallsign: CLogMessage(this).error(u"The requested callsign is not valid"); break;
        case ServerErrorCode::InvalidCidPassword:
            CLogMessage(this).error(u"Wrong user ID or password, inactive account");
            break;
        case ServerErrorCode::InvalidRevision:
            CLogMessage(this).error(u"This server does not support our protocol version");
            break;
        case ServerErrorCode::ServerFull: CLogMessage(this).error(u"The server is full"); break;
        case ServerErrorCode::CidSuspended: CLogMessage(this).error(u"Your user account is suspended"); break;
        case ServerErrorCode::RatingTooLow:
            CLogMessage(this).error(u"You are not authorized to use the requested rating");
            break;
        case ServerErrorCode::InvalidClient:
            CLogMessage(this).error(u"This software is not authorized for use on this network");
            break;
        case ServerErrorCode::RequestedLevelTooHigh:
            CLogMessage(this).error(u"You are not authorized to use the requested pilot rating");
            break;
 
        case ServerErrorCode::NoError: CLogMessage(this).info(u"OK"); break;
        case ServerErrorCode::SyntaxError:
            CLogMessage(this).error(
                u"Malformed packet, syntax error: '%1'. This can also occur if an OBS sends frequency text messages.")
                << serverError.getCausingParameter();
            break;
        case ServerErrorCode::InvalidSrcCallsign:
            CLogMessage(this).info(u"FSD message was using an invalid callsign: %1 (%2)")
                << serverError.getCausingParameter() << serverError.getDescription();
            break;
        case ServerErrorCode::NoSuchCallsign:
            CLogMessage(this).info(u"FSD Server: no such callsign: %1 %2")
                << serverError.getCausingParameter() << serverError.getDescription();
            break;
        case ServerErrorCode::NoFlightPlan: CLogMessage(this).info(u"FSD Server: no flight plan"); break;
        case ServerErrorCode::NoWeatherProfile:
            CLogMessage(this).info(u"FSD Server: requested weather profile does not exist");
            break;
 
        // we have no idea what these mean
        case ServerErrorCode::AlreadyRegistered:
            CLogMessage(this).warning(u"Server says already registered: %1") << serverError.getDescription();
            break;
        case ServerErrorCode::InvalidCtrl:
            CLogMessage(this).warning(u"Server invalid control: %1") << serverError.getDescription();
            break;
        case ServerErrorCode::Unknown:
            CLogMessage(this).warning(u"Server sent unknown error code: %1 (%2)")
                << serverError.getCausingParameter() << serverError.getDescription();
            break;
        case ServerErrorCode::AuthTimeout: CLogMessage(this).warning(u"Client did not authenticate in time"); break;
        }
        if (serverError.isFatalError()) { disconnectFromServer(); }
    }
 
    void CFSDClient::handleRehost(const QStringList &tokens)
    {
        const Rehost rehost = Rehost::fromTokens(tokens);
 
        CLogMessage(this).info(u"Server requested we switch server to %1") << rehost.m_hostname;
 
        SWIFT_AUDIT_X(!m_rehosting, Q_FUNC_INFO, "Rehosting already in progress");
 
        m_rehosting = true;
        auto rehostingSocket = std::make_shared<QTcpSocket>();
        connect(rehostingSocket.get(), &QTcpSocket::connected, this, [this, rehostingSocket] {
            readDataFromSocket();
            CLogMessage(this).debug(u"Successfully switched server");
            m_socket = rehostingSocket;
            m_rehosting = false;
            rehostingSocket->disconnect(this);
            connectSocketSignals();
            readDataFromSocket();
        });
        connect(rehostingSocket.get(), &QTcpSocket::errorOccurred, this, [this, rehostingSocket] {
            CLogMessage(this).warning(u"Failed to switch server: %1") << rehostingSocket->errorString();
            m_rehosting = false;
            rehostingSocket->disconnect(this);
            if (m_socket->state() != QAbstractSocket::ConnectedState)
            {
                updateConnectionStatus(CConnectionStatus::Disconnected);
            }
        });
 
        initiateConnection(rehostingSocket, rehost.m_hostname);
    }
 
    void CFSDClient::handleMute(const QStringList &tokens)
    {
        const Mute mute = Mute::fromTokens(tokens);
        if (mute.receiver() != m_ownCallsign.asString()) { return; }
        emit muteRequestReceived(mute.m_mute);
    }
 
    void CFSDClient::initiateConnection(std::shared_ptr<QTcpSocket> rehostingSocket, const QString &rehostingHost)
    {
        const CServer server = this->getServer();
        const auto socket = rehostingSocket ? rehostingSocket : m_socket;
 
        // NOLINTBEGIN(cppcoreguidelines-init-variables)
        const QString host = rehostingSocket ? rehostingHost : server.getAddress();
        const quint16 port = rehostingSocket ? m_socket->peerPort() : static_cast<quint16>(getServer().getPort());
        // NOLINTEND(cppcoreguidelines-init-variables)
 
        resolveLoadBalancing(host, [=](const QString &host) {
            socket->connectToHost(host, port);
            if (!rehostingSocket) { this->startPositionTimers(); }
        });
    }
 
    void CFSDClient::resolveLoadBalancing(const QString &host, std::function<void(const QString &)> callback)
    {
        if (QHostAddress(host).isNull() && (getServer().getName() == "AUTOMATIC" || m_rehosting) &&
            getServer().getEcosystem() == CEcosystem::VATSIM)
        {
            // Not an IP -> Get IP for load balancing via HTTP
            Q_ASSERT_X(sApp, Q_FUNC_INFO, "Need app");
            CUrl url = sApp->getVatsimFsdHttpUrl();
            sApp->getFromNetwork(url, { this, [=](QNetworkReply *nwReplyPtr) {
                                           QScopedPointer<QNetworkReply, QScopedPointerDeleteLater> nwReply(nwReplyPtr);
 
                                           if (nwReply->error() == QNetworkReply::NoError)
                                           {
                                               QHostAddress addr(static_cast<QString>(nwReply->readAll()));
                                               if (!addr.isNull())
                                               {
                                                   callback(addr.toString());
                                                   return;
                                               }
                                           }
                                           callback(host);
                                       } });
        }
        else { callback(host); }
    }
 
    void CFSDClient::handleCustomPilotPacket(const QStringList &tokens)
    {
        const QString subType = tokens.at(2);
 
        if (subType == u"PIR")
        {
            PlaneInfoRequest planeInfoRequest = PlaneInfoRequest::fromTokens(tokens);
 
            const CSimulatedAircraft myAircraft = this->getOwnAircraft();
            const QString airlineIcao = m_server.getFsdSetup().force3LetterAirlineCodes() ?
                                            myAircraft.getAirlineIcaoCode().getDesignator() :
                                            myAircraft.getAirlineIcaoCode().getVDesignator();
            const QString acTypeICAO = myAircraft.getAircraftIcaoCode().getDesignator();
            const QString livery = this->getConfiguredLiveryString(myAircraft);
 
            sendPlaneInformation(planeInfoRequest.sender(), acTypeICAO, airlineIcao, livery);
        }
        else if (subType == "PI")
        {
            if (tokens.size() > 6 && tokens.at(3) == "X")
            {
                // This is the old version of a plane info request and no active client should ever send it.
            }
            else if (tokens.size() > 4 && tokens.at(3) == "GEN")
            {
                const PlaneInformation planeInformation = PlaneInformation::fromTokens(tokens);
                emit planeInformationReceived(planeInformation.sender(), planeInformation.m_aircraft,
                                              planeInformation.m_airline, planeInformation.m_livery);
            }
        }
        else if (subType == "I")
        {
            // SquawkBox interim pilot position. This one is producing too many precision errors. Therefore ignore it.
        }
        else if (subType == "VI")
        {
            // swift's updated interim pilot update.
            if (!isInterimPositionReceivingEnabledForServer()) { return; }
 
            const InterimPilotDataUpdate interimPilotDataUpdate = InterimPilotDataUpdate::fromTokens(tokens);
            const CCallsign callsign(interimPilotDataUpdate.sender(), CCallsign::Aircraft);
 
            CAircraftSituation situation(callsign,
                                         CCoordinateGeodetic(interimPilotDataUpdate.m_latitude,
                                                             interimPilotDataUpdate.m_longitude,
                                                             interimPilotDataUpdate.m_altitudeTrue),
                                         CHeading(interimPilotDataUpdate.m_heading, CHeading::True, CAngleUnit::deg()),
                                         CAngle(interimPilotDataUpdate.m_pitch, CAngleUnit::deg()),
                                         CAngle(interimPilotDataUpdate.m_bank, CAngleUnit::deg()),
                                         CSpeed(interimPilotDataUpdate.m_groundSpeed, CSpeedUnit::kts()));
            // NotSetGroundDetails because here we do not know if this FSD protocol actually utilizes this flag
            const COnGroundInfo og(interimPilotDataUpdate.m_onGround ? COnGroundInfo::OnGround :
                                                                       COnGroundInfo::NotOnGround,
                                   COnGroundInfo::NotSetGroundDetails);
            situation.setOnGroundInfo(og);
 
            // Ref T297, default offset time
            situation.setCurrentUtcTime();
            const qint64 offsetTimeMs =
                receivedPositionFixTsAndGetOffsetTime(situation.getCallsign(), situation.getMSecsSinceEpoch());
            situation.setTimeOffsetMs(offsetTimeMs);
 
            emit interimPilotDataUpdatedReceived(situation);
        }
        else if (subType == "FSIPI")
        {
            const PlaneInformationFsinn planeInformationFsinn = PlaneInformationFsinn::fromTokens(tokens);
            emit planeInformationFsinnReceived(planeInformationFsinn.sender(), planeInformationFsinn.m_airlineIcao,
                                               planeInformationFsinn.m_aircraftIcao,
                                               planeInformationFsinn.m_aircraftIcaoCombinedType,
                                               planeInformationFsinn.m_sendMModelString);
        }
        else if (subType == "FSIPIR")
        {
            const PlaneInfoRequestFsinn planeInfoRequestFsinn = PlaneInfoRequestFsinn::fromTokens(tokens);
            sendPlaneInformationFsinn(planeInfoRequestFsinn.sender());
            emit planeInformationFsinnReceived(planeInfoRequestFsinn.sender(), planeInfoRequestFsinn.m_airlineIcao,
                                               planeInfoRequestFsinn.m_aircraftIcao,
                                               planeInfoRequestFsinn.m_aircraftIcaoCombinedType,
                                               planeInfoRequestFsinn.m_sendMModelString);
        }
        else
        {
            // Unknown #SB opcode, just pass it on.
            const QString sender = tokens.at(0);
            const QStringList data = tokens.mid(3);
            emit customPilotPacketReceived(sender, data);
        }
    }
 
#ifdef SWIFT_VATSIM_SUPPORT
    void CFSDClient::handleFsdIdentification(const QStringList &tokens)
    {
        if (m_protocolRevision >= PROTOCOL_REVISION_VATSIM_AUTH)
        {
            const FSDIdentification fsdIdentification = FSDIdentification::fromTokens(tokens);
            vatsim_auth_set_initial_challenge(m_clientAuth, qPrintable(fsdIdentification.m_initialChallenge));
 
            char fsdChallenge[33];
            vatsim_auth_generate_challenge(m_serverAuth, fsdChallenge);
            vatsim_auth_set_initial_challenge(m_serverAuth, fsdChallenge);
            sendClientIdentification(QString(fsdChallenge));
        }
        else
        {
            CLogMessage(this).error(
                u"You tried to connect to a VATSIM server without using VATSIM protocol, disconnecting!");
            disconnectFromServer();
        }
    }
#endif
 
    void CFSDClient::handleUnknownPacket(const QString &line)
    {
        CLogMessage(this).warning(u"FSD unknown packet: '%1'") << line;
    }
 
    void CFSDClient::handleUnknownPacket(const QStringList &tokens) { this->handleUnknownPacket(tokens.join(", ")); }
 
    void CFSDClient::printSocketError(QAbstractSocket::SocketError socketError)
    {
        if (m_rehosting) { return; }
 
        CLogMessage(this).error(u"FSD socket error: %1") << this->socketErrorString(socketError);
    }
 
    void CFSDClient::handleSocketError(QAbstractSocket::SocketError socketError)
    {
        if (m_rehosting) { return; }
 
        const QString error = this->socketErrorString(socketError);
        switch (socketError)
        {
        // all named here need a logoff
        case QAbstractSocket::RemoteHostClosedError:
            emit this->severeNetworkError(error);
            this->disconnectFromServer();
            break;
        default: break;
        }
    }
 
    void CFSDClient::handleSocketConnected()
    {
        if (m_protocolRevision == PROTOCOL_REVISION_CLASSIC)
        {
            this->sendLogin();
            this->updateConnectionStatus(CConnectionStatus::Connected);
        }
    }
 
    void CFSDClient::updateConnectionStatus(CConnectionStatus newStatus)
    {
        if (this->getConnectionStatus() == newStatus) { return; }
        if (newStatus.isConnected())
        {
            CEcosystem ecoSystem;
            {
                QWriteLocker l(&m_lockUserClientBuffered);
                m_server.setConnectedSinceNow();
                ecoSystem = m_server.getEcosystem();
            }
            this->setCurrentEcosystem(ecoSystem);
        }
        else
        {
            QWriteLocker l(&m_lockUserClientBuffered);
            m_server.markAsDisconnected();
        }
 
        if (newStatus.isDisconnected())
        {
            this->stopPositionTimers();
            this->clearState();
            this->setLastEcosystem(m_server.getEcosystem());
            this->setCurrentEcosystem(CEcosystem::NoSystem);
            this->saveNetworkStatistics(m_server.getName());
        }
 
        CConnectionStatus oldStatus;
        {
            QWriteLocker l(&m_lockConnectionStatus);
            oldStatus = m_connectionStatus;
            m_connectionStatus = newStatus;
        }
 
        emit this->connectionStatusChanged(oldStatus, newStatus);
    }
 
    void CFSDClient::consolidateTextMessage(const CTextMessage &textMessage)
    {
        if (textMessage.isSupervisorMessage()) { emit this->textMessagesReceived(textMessage); }
        else
        {
            m_textMessagesToConsolidate.addConsolidatedTextMessage(textMessage);
            m_dsSendTextMessage.inputSignal(); // trigger
        }
    }
 
    void CFSDClient::emitConsolidatedTextMessages()
    {
        emit this->textMessagesReceived(m_textMessagesToConsolidate);
        m_textMessagesToConsolidate.clear();
    }
 
    qint64 CFSDClient::receivedPositionFixTsAndGetOffsetTime(const CCallsign &callsign, qint64 markerTs)
    {
        Q_ASSERT_X(!callsign.isEmpty(), Q_FUNC_INFO, "Need callsign");
 
        if (markerTs < 0) { markerTs = QDateTime::currentMSecsSinceEpoch(); }
        if (!m_lastPositionUpdate.contains(callsign))
        {
            m_lastPositionUpdate.insert(callsign, markerTs);
            return CFsdSetup::c_positionTimeOffsetMsec;
        }
        const qint64 oldTs = m_lastPositionUpdate.value(callsign); // NOLINT(cppcoreguidelines-init-variables)
        m_lastPositionUpdate[callsign] = markerTs;
 
        // Ref T297, dynamic offsets
        const qint64 diff = qAbs(markerTs - oldTs);
        this->insertLatestOffsetTime(callsign, diff);
 
        int count = 0;
        const qint64 avgTimeMs = this->averageOffsetTimeMs(callsign, count, 3); // latest average
        qint64 offsetTime = CFsdSetup::c_positionTimeOffsetMsec;
 
        if (avgTimeMs < CFsdSetup::c_interimPositionTimeOffsetMsec && count >= 3)
        {
            offsetTime = CFsdSetup::c_interimPositionTimeOffsetMsec;
        }
 
        return m_additionalOffsetTime + offsetTime;
    }
 
    qint64 CFSDClient::currentOffsetTime(const CCallsign &callsign) const
    {
        Q_ASSERT_X(!callsign.isEmpty(), Q_FUNC_INFO, "Need callsign");
 
        if (!m_lastOffsetTimes.contains(callsign) || m_lastOffsetTimes[callsign].isEmpty())
        {
            return CFsdSetup::c_positionTimeOffsetMsec;
        }
        return m_lastOffsetTimes[callsign].front();
    }
 
    void CFSDClient::clearState()
    {
        m_rehosting = false;
        m_stoppedSendingVisualPositions = false;
        m_serverWantsVisualPositions = false;
        m_visualPositionUpdateSentCount = 0;
        m_textMessagesToConsolidate.clear();
        m_pendingAtisQueries.clear();
        m_lastPositionUpdate.clear();
        m_lastOffsetTimes.clear();
        m_atcStations.clear();
        m_queuedFsdMessages.clear();
        m_sentAircraftConfig = CAircraftParts::null();
        m_loginSince = -1;
    }
 
    void CFSDClient::clearState(const CCallsign &callsign)
    {
        if (callsign.isEmpty()) { return; }
        m_pendingAtisQueries.remove(callsign);
        m_lastPositionUpdate.remove(callsign);
        m_interimPositionReceivers.remove(callsign);
        m_lastOffsetTimes.remove(callsign);
    }
 
    void CFSDClient::insertLatestOffsetTime(const CCallsign &callsign, qint64 offsetMs)
    {
        QList<qint64> &offsets = m_lastOffsetTimes[callsign];
        offsets.push_front(offsetMs);
        if (offsets.size() > c_maxOffsetTimes) { offsets.removeLast(); }
    }
 
    qint64 CFSDClient::averageOffsetTimeMs(const CCallsign &callsign, int &count, int maxLastValues) const
    {
        const QList<qint64> &offsets = m_lastOffsetTimes[callsign];
        if (offsets.size() < 1) { return -1; }
        qint64 sum = 0;
        count = 0;
        for (qint64 v : offsets)
        {
            count++;
            sum += v;
            if (count > maxLastValues) { break; }
        }
        return qRound(static_cast<double>(sum) / count);
    }
 
    bool CFSDClient::isInterimPositionSendingEnabledForServer() const
    {
        const CFsdSetup::SendReceiveDetails d = this->getSetupForServer().getSendReceiveDetails();
        return (d & CFsdSetup::SendInterimPositions);
    }
 
    bool CFSDClient::isInterimPositionReceivingEnabledForServer() const
    {
        const CFsdSetup::SendReceiveDetails d = this->getSetupForServer().getSendReceiveDetails();
        return (d & CFsdSetup::ReceiveInterimPositions);
    }
 
    bool CFSDClient::isVisualPositionSendingEnabledForServer() const
    {
        const CFsdSetup::SendReceiveDetails d = this->getSetupForServer().getSendReceiveDetails();
        return (d & CFsdSetup::SendVisualPositions);
    }
 
    const CFsdSetup &CFSDClient::getSetupForServer() const { return m_server.getFsdSetup(); }
 
    void CFSDClient::maybeHandleAtisReply(const CCallsign &sender, const CCallsign &receiver, const QString &message)
    {
        Q_ASSERT(m_pendingAtisQueries.contains(sender));
        PendingAtisQuery &pendingQuery = m_pendingAtisQueries[sender];
        pendingQuery.m_atisMessage.push_back(message);
 
        // Wait maximum 5 seconds for the reply and release as text message after
        if (pendingQuery.m_queryTime.secsTo(QDateTime::currentDateTimeUtc()) > 5)
        {
            const QString atisMessage(pendingQuery.m_atisMessage.join(QChar::LineFeed));
            CTextMessage tm(atisMessage, sender, receiver);
            tm.setCurrentUtcTime();
            this->consolidateTextMessage(tm); // emit textMessagesReceived(tm);
            m_pendingAtisQueries.remove(sender);
            return;
        }
 
        // 4 digits followed by z (e.g. 0200z) is always the last atis line.
        // Some controllers leave the logoff time empty. Hence we accept anything
        // between 0-4 digits.
        thread_local const QRegularExpression reLogoff("^\\d{0,4}z$");
        if (reLogoff.match(message).hasMatch())
        {
            emit atisLogoffTimeReplyReceived(sender, message);
            CInformationMessage atisMessage(CInformationMessage::ATIS);
            for (const auto &line : std::as_const(pendingQuery.m_atisMessage))
            {
                if (!atisMessage.isEmpty()) atisMessage.appendMessage("\n");
                atisMessage.appendMessage(line);
            }
            emit atisReplyReceived(CCallsign(sender.toQString(), CCallsign::Atc), atisMessage);
            m_pendingAtisQueries.remove(sender);
            return;
        }
    }
 
    void CFSDClient::fsdMessageSettingsChanged()
    {
        if (m_rawFsdMessageLogFile.isOpen()) { m_rawFsdMessageLogFile.close(); }
        const CRawFsdMessageSettings setting = m_fsdMessageSetting.get();
        m_rawFsdMessagesEnabled = setting.areRawFsdMessagesEnabled();
 
        if (setting.getFileWriteMode() == CRawFsdMessageSettings::None || setting.getFileDir().isEmpty()) { return; }
        if (setting.getFileWriteMode() == CRawFsdMessageSettings::Truncate)
        {
            const QString filePath = CFileUtils::appendFilePaths(setting.getFileDir(), "rawfsdmessages.log");
            m_rawFsdMessageLogFile.setFileName(filePath);
            const bool res = m_rawFsdMessageLogFile.open(QIODevice::Text | QIODevice::WriteOnly);
            SWIFT_VERIFY_X(res, Q_FUNC_INFO, "Could not open log file");
        }
        else if (setting.getFileWriteMode() == CRawFsdMessageSettings::Append)
        {
            const QString filePath = CFileUtils::appendFilePaths(setting.getFileDir(), "rawfsdmessages.log");
            m_rawFsdMessageLogFile.setFileName(filePath);
            const bool res = m_rawFsdMessageLogFile.open(QIODevice::Text | QIODevice::WriteOnly | QIODevice::Append);
            SWIFT_VERIFY_X(res, Q_FUNC_INFO, "Could not open log file");
        }
        else if (setting.getFileWriteMode() == CRawFsdMessageSettings::Timestamped)
        {
            QString filename("rawfsdmessages");
            filename += QLatin1String("_");
            filename += QDateTime::currentDateTime().toString(QStringLiteral("yyMMddhhmmss"));
            filename += QLatin1String(".log");
            const QString filePath = CFileUtils::appendFilePaths(setting.getFileDir(), filename);
            m_rawFsdMessageLogFile.setFileName(filePath);
            const bool res = m_rawFsdMessageLogFile.open(QIODevice::Text | QIODevice::WriteOnly);
            SWIFT_VERIFY_X(res, Q_FUNC_INFO, "Could not open log file");
        }
    }
 
    swift::misc::aviation::CCallsignSet CFSDClient::getInterimPositionReceivers() const
    {
        return m_interimPositionReceivers;
    }
 
    void CFSDClient::setInterimPositionReceivers(const swift::misc::aviation::CCallsignSet &interimPositionReceivers)
    {
        m_interimPositionReceivers = interimPositionReceivers;
    }
 
    bool CFSDClient::isPendingConnection() const
    {
        return m_connectionStatus.isConnecting() || m_connectionStatus.isDisconnecting();
    }
 
    int CFSDClient::increaseStatisticsValue(const QString &identifier, const QString &appendix)
    {
        if (identifier.isEmpty() || !m_statistics) { return -1; }
 
        QWriteLocker l(&m_lockStatistics);
        const QString i = appendix.isEmpty() ? identifier : identifier % u"." % appendix;
        int &v = m_callStatistics[i];
        v++;
 
        constexpr int MaxTimeValues = 50;
        m_callByTime.push_front(QPair<qint64, QString>(QDateTime::currentMSecsSinceEpoch(), i));
        if (m_callByTime.size() > MaxTimeValues) { m_callByTime.removeLast(); }
        return v;
    }
 
    int CFSDClient::increaseStatisticsValue(const QString &identifier, int value)
    {
        return increaseStatisticsValue(identifier, QString::number(value));
    }
 
    void CFSDClient::clearStatistics()
    {
        QWriteLocker l(&m_lockStatistics);
        m_callStatistics.clear();
        m_callByTime.clear();
    }
 
    QString CFSDClient::getNetworkStatisticsAsText(bool reset, const QString &separator)
    {
        QVector<std::pair<int, QString>> transformed;
        QMap<QString, int> callStatistics;
        QVector<QPair<qint64, QString>> callByTime;
 
        {
            QReadLocker l(&m_lockStatistics);
            callStatistics = m_callStatistics;
            callByTime = m_callByTime;
        }
 
        if (callStatistics.isEmpty()) { return {}; }
        for (const auto [key, value] : makePairsRange(std::as_const(callStatistics)))
        {
            // key is pair.first, value is pair.second
            transformed.push_back({ value, key });
        }
 
        // sorted by value
        std::sort(transformed.begin(), transformed.end(), std::greater<>());
        QString stats;
        for (const auto &pair : transformed)
        {
            stats += (stats.isEmpty() ? QString() : separator) % pair.second % u": " % QString::number(pair.first);
        }
 
        for (const auto &pair : transformed)
        {
            stats += (stats.isEmpty() ? QString() : separator) % pair.second % u": " % QString::number(pair.first);
        }
 
        if (!callByTime.isEmpty())
        {
            const qint64 lastTs = callByTime.front().first;
            for (const auto &pair : std::as_const(callByTime))
            {
                const qint64 deltaTs = lastTs - pair.first;
                stats += separator % QStringLiteral("%1").arg(deltaTs, 5, 10, QChar('0')) % u": " % pair.second;
            }
        }
 
        if (reset) { this->clearStatistics(); }
        return stats;
    }
 
    void CFSDClient::gracefulShutdown()
    {
        disconnectFromServer(); // async, runs in background thread
        quitAndWait();
    }
 
    void CFSDClient::readDataFromSocketMaxLines(int maxLines)
    {
        if (m_socket->bytesAvailable() < 1) { return; }
 
        int lines = 0;
 
        // reads at least one line if available
        while (m_socket->canReadLine())
        {
            const QByteArray dataEncoded = m_socket->readLine();
            if (dataEncoded.isEmpty()) { continue; }
            const QString data = m_decoder(dataEncoded);
            this->parseMessage(data);
            lines++;
 
            static constexpr int MaxLines = 75 - 1;
            if (maxLines < 0) { maxLines = MaxLines; }
 
            if (lines > maxLines)
            {
                static constexpr int DelayMs = 10;
                const int newMax = qRound(1.2 * lines); // 20% more
 
                CLogMessage(this).debug(u"ReadDataFromSocket has too many lines (>%1), will read again in %2ms")
                    << MaxLines << DelayMs;
                QPointer<CFSDClient> myself(this);
                QTimer::singleShot(DelayMs, this, [=] {
                    if (!sApp || sApp->isShuttingDown()) { return; }
                    if (myself) { myself->readDataFromSocketMaxLines(newMax); }
                });
                break;
            }
        }
    }
 
    QString CFSDClient::socketErrorString(QAbstractSocket::SocketError error) const
    {
        QString e = CFSDClient::socketErrorToQString(error);
        if (!m_socket->errorString().isEmpty()) { e += QStringLiteral(": ") % m_socket->errorString(); }
        return e;
    }
 
    QString CFSDClient::socketErrorToQString(QAbstractSocket::SocketError error)
    {
        static const QMetaEnum metaEnum = QMetaEnum::fromType<QAbstractSocket::SocketError>();
        return metaEnum.valueToKey(error);
    }
 
    void CFSDClient::parseMessage(const QString &lineRaw)
    {
        MessageType messageType = MessageType::Unknown;
        QString cmd;
        const QString line = lineRaw.trimmed();
 
        if (m_printToConsole) { qDebug() << "FSD Recv=>" << line; }
        emitRawFsdMessage(line, false);
 
        for (const QString &str : makeKeysRange(std::as_const(m_messageTypeMapping)))
        {
            if (line.startsWith(str))
            {
                cmd = str;
                messageType = m_messageTypeMapping.value(str, MessageType::Unknown);
                break;
            }
        }
 
        // statistics
        if (m_statistics)
        {
            increaseStatisticsValue(QStringLiteral("parseMessage"), this->messageTypeToString(messageType));
        }
 
        if (messageType != MessageType::Unknown)
        {
            // Cutoff the cmd from the beginning
            const QString payload = line.mid(cmd.size()).trimmed();
 
            // We expected a payload, but there is nothing
            if (payload.length() == 0) { return; }
 
            const QStringList tokens = payload.split(':');
            switch (messageType)
            {
            // ignored ones
            case MessageType::AddAtc:
            case MessageType::AddPilot:
            case MessageType::ServerHeartbeat:
            case MessageType::ProController:
            case MessageType::ClientIdentification: break;
 
            // handled ones
            case MessageType::AtcDataUpdate: handleAtcDataUpdate(tokens); break;
#ifdef SWIFT_VATSIM_SUPPORT
            case MessageType::AuthChallenge: handleAuthChallenge(tokens); break;
            case MessageType::AuthResponse: handleAuthResponse(tokens); break;
#endif
            case MessageType::ClientQuery: handleClientQuery(tokens); break;
            case MessageType::ClientResponse: handleClientResponse(tokens); break;
            case MessageType::DeleteATC: handleDeleteATC(tokens); break;
            case MessageType::DeletePilot: handleDeletePilot(tokens); break;
            case MessageType::FlightPlan: handleFlightPlan(tokens); break;
#ifdef SWIFT_VATSIM_SUPPORT
            case MessageType::FsdIdentification: handleFsdIdentification(tokens); break;
#endif
            case MessageType::KillRequest: handleKillRequest(tokens); break;
            case MessageType::PilotDataUpdate: handlePilotDataUpdate(tokens); break;
            case MessageType::Ping: handlePing(tokens); break;
            case MessageType::Pong: handlePong(tokens); break;
            case MessageType::ServerError: handleServerError(tokens); break;
            case MessageType::TextMessage: handleTextMessage(tokens); break;
            case MessageType::PilotClientCom: handleCustomPilotPacket(tokens); break;
            case MessageType::VisualPilotDataUpdate:
            case MessageType::VisualPilotDataPeriodic:
            case MessageType::VisualPilotDataStopped: handleVisualPilotDataUpdate(tokens, messageType); break;
            case MessageType::VisualPilotDataToggle: handleVisualPilotDataToggle(tokens); break;
            case MessageType::EuroscopeSimData: handleEuroscopeSimData(tokens); break;
            case MessageType::Rehost: handleRehost(tokens); break;
            case MessageType::Mute: handleMute(tokens); break;
 
            // normally we should not get here
            default:
            case MessageType::Unknown: handleUnknownPacket(tokens); break;
            }
        }
        else { handleUnknownPacket(line); }
    }
 
    void CFSDClient::emitRawFsdMessage(const QString &fsdMessage, bool isSent)
    {
        if (!m_unitTestMode && !m_rawFsdMessagesEnabled) { return; }
        QString fsdMessageFiltered(fsdMessage);
        if (m_filterPasswordFromLogin)
        {
            if (fsdMessageFiltered.startsWith("#AP"))
            {
                thread_local const QRegularExpression re(R"(^(#AP\w+:SERVER:\d+:)[^:]+(:\d+:\d+:\d+:.+)$)");
                fsdMessageFiltered.replace(re, "\\1<password>\\2");
                m_filterPasswordFromLogin = false;
            }
        }
 
        const QString prefix = isSent ? "FSD Sent=>" : "FSD Recv=>";
        CRawFsdMessage rawMessage(prefix + fsdMessageFiltered);
        rawMessage.setCurrentUtcTime();
        if (m_rawFsdMessageLogFile.isOpen())
        {
            QTextStream stream(&m_rawFsdMessageLogFile);
            stream << rawMessage.toQString().trimmed() << Qt::endl;
        }
        emit rawFsdMessage(rawMessage);
    }
 
    bool CFSDClient::saveNetworkStatistics(const QString &server)
    {
        if (m_callStatistics.isEmpty()) { return false; }
 
        const QString s = this->getNetworkStatisticsAsText(false, "\n");
        if (s.isEmpty()) { return false; }
        const QString fn = QStringLiteral("networkstatistics_%1_%2.log")
                               .arg(QDateTime::currentDateTimeUtc().toString("yyMMddhhmmss"), server);
        const QString fp = CFileUtils::appendFilePaths(CSwiftDirectories::logDirectory(), fn);
        return CFileUtils::writeStringToFile(s, fp);
    }
 
    void CFSDClient::startPositionTimers()
    {
        m_positionUpdateTimer.start(c_updatePositionIntervalMsec);
        m_scheduledConfigUpdate.start(c_processingIntervalMsec);
        m_fsdSendMessageTimer.start(c_sendFsdMsgIntervalMsec);
        m_queuedFsdMessages.clear(); // clear everything before the timer is started
 
        // interim positions
        // NOLINTBEGIN(bugprone-branch-clone)
        if (this->isInterimPositionSendingEnabledForServer())
        {
            m_interimPositionUpdateTimer.start(c_updateInterimPositionIntervalMsec);
        }
        else { m_interimPositionUpdateTimer.stop(); }
        if (this->isVisualPositionSendingEnabledForServer())
        {
            m_visualPositionUpdateTimer.start(c_updateVisualPositionIntervalMsec);
        }
        else { m_visualPositionUpdateTimer.stop(); }
        // NOLINTEND(bugprone-branch-clone)
    }
 
    void CFSDClient::stopPositionTimers()
    {
        m_positionUpdateTimer.stop();
        m_interimPositionUpdateTimer.stop();
        m_visualPositionUpdateTimer.stop();
        m_scheduledConfigUpdate.stop();
        m_fsdSendMessageTimer.stop();
    }
 
    void CFSDClient::updateAtisMap(const QString &callsign, AtisLineType type, const QString &line)
    {
        // NOLINTBEGIN(bugprone-branch-clone)
        if (type == AtisLineType::VoiceRoom)
        {
            m_mapAtisMessages[callsign].m_voiceRoom = line;
            m_mapAtisMessages[callsign].m_lineCount++;
            return;
        }
        if (type == AtisLineType::TextMessage)
        {
            m_mapAtisMessages[callsign].m_textLines.push_back(line);
            m_mapAtisMessages[callsign].m_lineCount++;
            return;
        }
        if (type == AtisLineType::ZuluLogoff)
        {
            m_mapAtisMessages[callsign].m_zuluLogoff = line;
            m_mapAtisMessages[callsign].m_lineCount++;
            return;
        }
        if (!m_mapAtisMessages.contains(callsign)) { return; }
 
        // Ignore the check for line count.
        m_mapAtisMessages[callsign].m_lineCount++;
 
        const CCallsign cs(callsign, CCallsign::Atc);
        // emit atisVoiceRoomReplyReceived(cs, m_mapAtisMessages[callsign].voiceRoom);
        emit atisLogoffTimeReplyReceived(cs, m_mapAtisMessages[callsign].m_zuluLogoff);
 
        CInformationMessage atisMessage(CInformationMessage::ATIS);
        for (const QString &tm : std::as_const(m_mapAtisMessages[callsign].m_textLines))
        {
            const QString fixed = tm.trimmed();
            if (!fixed.isEmpty())
            {
                //  detect the stupid z1, z2, z3 placeholders
                thread_local const QRegularExpression RegExp(R"([\n\t\r])");
                const QString test = fixed.toLower().remove(RegExp);
                if (test == "z") return;
                if (test.startsWith("z") && test.length() == 2) return; // z1, z2, ..
                if (test.length() == 1) return; // sometimes just z
 
                // append
                if (!atisMessage.isEmpty()) atisMessage.appendMessage("\n");
                atisMessage.appendMessage(fixed);
            }
        }
 
        emit this->atisReplyReceived(cs, atisMessage);
 
        m_mapAtisMessages.remove(callsign);
        // NOLINTEND(bugprone-branch-clone)
    }
 
    void CFSDClient::pendingTimeoutCheck()
    {
        if (!this->isPendingConnection()) { return; }
 
        const qint64 age = QDateTime::currentMSecsSinceEpoch() - m_loginSince;
        if (age < PendingConnectionTimeoutMs) { return; }
 
        // time out
        CLogMessage(this).warning(u"Timeout on pending connection to '%1'") << this->getServer().getName();
        this->disconnectFromServer();
    }
 
    CLength CFSDClient::fixAtcRange(const CLength &networkRange, const CCallsign &cs)
    {
        // ATIS often have a range of 0 nm. Correct this to a proper value.
        const QString suffix = cs.getSuffix();
        if (suffix.contains(QStringLiteral("ATIS"), Qt::CaseInsensitive))
        {
            static const CLength l_Atis(150.0, CLengthUnit::NM());
            return maxOrNotNull(networkRange, l_Atis);
        }
        if (suffix.contains(QStringLiteral("GND"), Qt::CaseInsensitive))
        {
            static const CLength l_Gnd(10.0, CLengthUnit::NM());
            return maxOrNotNull(networkRange, l_Gnd);
        }
        if (suffix.contains(QStringLiteral("TWR"), Qt::CaseInsensitive))
        {
            static const CLength l_Twr(25.0, CLengthUnit::NM());
            return maxOrNotNull(networkRange, l_Twr);
        }
        if (suffix.contains(QStringLiteral("DEP"), Qt::CaseInsensitive))
        {
            static const CLength l_Dep(150.0, CLengthUnit::NM());
            return maxOrNotNull(networkRange, l_Dep);
        }
        if (suffix.contains(QStringLiteral("APP"), Qt::CaseInsensitive))
        {
            static const CLength l_App(150.0, CLengthUnit::NM());
            return maxOrNotNull(networkRange, l_App);
        }
        if (suffix.contains(QStringLiteral("CTR"), Qt::CaseInsensitive))
        {
            static const CLength l_Ctr(300.0, CLengthUnit::NM());
            return maxOrNotNull(networkRange, l_Ctr);
        }
        if (suffix.contains(QStringLiteral("FSS"), Qt::CaseInsensitive))
        {
            static const CLength l_Fss(1500.0, CLengthUnit::NM());
            return maxOrNotNull(networkRange, l_Fss);
        }
 
        return networkRange;
    }
 
    CLength CFSDClient::maxOrNotNull(const CLength &l1, const CLength &l2)
    {
        if (l1.isNull()) { return l2; }
        if (l2.isNull()) { return l1; }
        return (l2 > l1) ? l2 : l1;
    }
 
    QString CFSDClient::noColons(const QString &input)
    {
        if (!input.contains(':')) { return input; }
        QString copy(input);
        return copy.remove(':');
    }
 
    FlightType CFSDClient::getFlightType(CFlightPlan::FlightRules flightRules)
    {
        switch (flightRules)
        {
        case CFlightPlan::IFR: return FlightType::IFR;
        case CFlightPlan::VFR: return FlightType::VFR;
        case CFlightPlan::SVFR: return FlightType::SVFR;
        case CFlightPlan::DVFR: return FlightType::DVFR;
        default: return FlightType::IFR;
        }
    }
 
    const QString &CFSDClient::messageTypeToString(MessageType mt) const
    {
        QHash<QString, MessageType>::const_iterator i = m_messageTypeMapping.constBegin();
        while (i != m_messageTypeMapping.constEnd())
        {
            if (i.value() == mt) { return i.key(); }
            ++i;
        }
 
        static const QString empty;
        return empty;
    }
 
    void CFSDClient::handleIllegalFsdState(const QString &message)
    {
        if (CBuildConfig::isLocalDeveloperDebugBuild()) { SWIFT_VERIFY_X(false, Q_FUNC_INFO, "Illegal FSD state"); }
        CLogMessage(this).warning(message);
    }
 
    const QJsonObject &CFSDClient::JsonPackets::aircraftConfigRequest()
    {
        static const QJsonObject jsonObject { { "request", "full" } };
        return jsonObject;
    }
 
} // namespace swift::core::fsd