vatsimdatafilereader.cpp

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
#include "core/vatsim/vatsimdatafilereader.h"
 
#include <QByteArray>
#include <QDateTime>
#include <QMetaObject>
#include <QNetworkReply>
#include <QPointer>
#include <QReadLocker>
#include <QRegularExpression>
#include <QScopedPointer>
#include <QScopedPointerDeleteLater>
#include <QStringBuilder>
#include <QTimer>
#include <QUrl>
#include <QWriteLocker>
#include <Qt>
#include <QtGlobal>
 
#include "core/application.h"
#include "misc/aviation/aircraftsituation.h"
#include "misc/aviation/altitude.h"
#include "misc/aviation/atcstation.h"
#include "misc/geo/coordinategeodetic.h"
#include "misc/logmessage.h"
#include "misc/mixin/mixincompare.h"
#include "misc/network/entityflags.h"
#include "misc/network/server.h"
#include "misc/network/url.h"
#include "misc/network/user.h"
#include "misc/pq/frequency.h"
#include "misc/pq/length.h"
#include "misc/pq/speed.h"
#include "misc/pq/units.h"
#include "misc/predicates.h"
#include "misc/range.h"
#include "misc/simulation/simulatedaircraft.h"
#include "misc/statusmessage.h"
#include "misc/verify.h"
 
using namespace swift::misc;
using namespace swift::misc::aviation;
using namespace swift::misc::network;
using namespace swift::misc::geo;
using namespace swift::misc::simulation;
using namespace swift::misc::physical_quantities;
using namespace swift::core::data;
 
namespace swift::core::vatsim
{
    CVatsimDataFileReader::CVatsimDataFileReader(QObject *owner)
        : CThreadedReaderPeriodic(owner, "CVatsimDataFileReader")
    {
        this->reloadSettings();
    }
 
    CSimulatedAircraftList CVatsimDataFileReader::getAircraft() const
    {
        QReadLocker rl(&m_lock);
        return m_aircraft;
    }
 
    CAtcStationList CVatsimDataFileReader::getAtcStations() const
    {
        QReadLocker rl(&m_lock);
        return m_atcStations;
    }
 
    CAtcStationList CVatsimDataFileReader::getAtcStationsForCallsign(const CCallsign &callsign) const
    {
        const CCallsignSet cs({ callsign });
        return this->getAtcStationsForCallsigns(cs);
    }
 
    CAtcStationList CVatsimDataFileReader::getAtcStationsForCallsigns(const CCallsignSet &callsigns) const
    {
        return this->getAtcStations().findByCallsigns(callsigns);
    }
 
    CUserList CVatsimDataFileReader::getPilotsForCallsigns(const CCallsignSet &callsigns) const
    {
        return this->getAircraft().findByCallsigns(callsigns).transform(
            predicates::MemberTransform(&CSimulatedAircraft::getPilot));
    }
 
    CUserList CVatsimDataFileReader::getPilotsForCallsign(const CCallsign &callsign) const
    {
        const CCallsignSet callsigns({ callsign });
        return this->getPilotsForCallsigns(callsigns);
    }
 
    CAirlineIcaoCode CVatsimDataFileReader::getAirlineIcaoCode(const CCallsign &callsign) const
    {
        const CSimulatedAircraft aircraft = this->getAircraft().findFirstByCallsign(callsign);
        return aircraft.getAirlineIcaoCode();
    }
 
    CAircraftIcaoCode CVatsimDataFileReader::getAircraftIcaoCode(const CCallsign &callsign) const
    {
        const CSimulatedAircraft aircraft = this->getAircraft().findFirstByCallsign(callsign);
        return aircraft.getAircraftIcaoCode();
    }
 
    CVoiceCapabilities CVatsimDataFileReader::getVoiceCapabilityForCallsign(const CCallsign &callsign) const
    {
        if (callsign.isEmpty()) { return {}; }
        QReadLocker rl(&m_lock);
        return m_flightPlanRemarks.value(callsign).getVoiceCapabilities();
    }
 
    CFlightPlanRemarks CVatsimDataFileReader::getFlightPlanRemarksForCallsign(const CCallsign &callsign) const
    {
        if (callsign.isEmpty()) { return QString(); }
        QReadLocker rl(&m_lock);
        return m_flightPlanRemarks.value(callsign);
    }
 
    void CVatsimDataFileReader::updateWithVatsimDataFileData(CSimulatedAircraft &aircraftToBeUdpated) const
    {
        this->getAircraft().updateWithVatsimDataFileData(aircraftToBeUdpated);
    }
 
    CUserList CVatsimDataFileReader::getControllersForCallsign(const CCallsign &callsign) const
    {
        const CCallsignSet cs({ callsign });
        return this->getControllersForCallsigns(cs);
    }
 
    CUserList CVatsimDataFileReader::getControllersForCallsigns(const CCallsignSet &callsigns) const
    {
        return this->getAtcStations().findByCallsigns(callsigns).transform(
            predicates::MemberTransform(&CAtcStation::getController));
    }
 
    CUserList CVatsimDataFileReader::getUsersForCallsign(const CCallsign &callsign) const
    {
        const CCallsignSet callsigns({ callsign });
        return this->getUsersForCallsigns(callsigns);
    }
 
    CUserList CVatsimDataFileReader::getUsersForCallsigns(const CCallsignSet &callsigns) const
    {
        CUserList users;
        if (callsigns.isEmpty()) { return users; }
        for (const CCallsign &callsign : callsigns)
        {
            users.push_back(this->getPilotsForCallsign(callsign));
            users.push_back(this->getControllersForCallsign(callsign));
        }
        return users;
    }
 
    void CVatsimDataFileReader::doWorkImpl() { this->read(); }
 
    void CVatsimDataFileReader::read()
    {
        this->threadAssertCheck();
        if (!this->doWorkCheck()) { return; }
 
        Q_ASSERT_X(sApp, Q_FUNC_INFO, "Missing application");
        const QUrl url(sApp->getVatsimDataFileUrl());
        if (url.isEmpty()) { return; }
        this->getFromNetworkAndLog(url, { this, &CVatsimDataFileReader::parseVatsimFile });
    }
 
    void CVatsimDataFileReader::parseVatsimFile(QNetworkReply *nwReplyPtr)
    {
        // wrap pointer, make sure any exit cleans up reply
        // required to use delete later as object is created in a different thread
        QScopedPointer<QNetworkReply, QScopedPointerDeleteLater> nwReply(nwReplyPtr);
        this->threadAssertCheck();
 
        // Worker thread, make sure to write only synced here!
        if (!this->doWorkCheck())
        {
            CLogMessage(this).info(u"Terminated VATSIM file parsing process");
            return; // stop, terminate straight away, ending thread
        }
 
        this->logNetworkReplyReceived(nwReplyPtr);
        QStringList illegalEquipmentCodes;
        const QUrl url = nwReply->url();
        const QString urlString = url.toString();
 
        if (nwReply->error() == QNetworkReply::NoError)
        {
            const QString dataFileData = nwReply->readAll();
            nwReply->close(); // close asap
 
            if (dataFileData.isEmpty()) { return; }
            if (!this->didContentChange(dataFileData)) // Quick check by hash
            {
                CLogMessage(this).info(u"VATSIM file '%1' has same content, skipped") << urlString;
                return;
            }
            auto jsonDoc = QJsonDocument::fromJson(dataFileData.toUtf8());
            if (jsonDoc.isEmpty()) { return; }
 
            // build on local vars for thread safety
            CAtcStationList atcStations;
            CSimulatedAircraftList aircraft;
            QMap<CCallsign, CFlightPlanRemarks> flightPlanRemarksMap;
            auto updateTimestampFromFile =
                QDateTime::fromString(jsonDoc["general"]["update_timestamp"].toString(), Qt::ISODateWithMs);
 
            const bool alreadyRead = (updateTimestampFromFile == this->getUpdateTimestamp());
            if (alreadyRead)
            {
                CLogMessage(this).info(u"VATSIM file has same timestamp, skipped");
                return;
            }
 
            for (QJsonValueRef pilot : jsonDoc["pilots"].toArray())
            {
                if (!this->doWorkCheck())
                {
                    CLogMessage(this).info(u"Terminated VATSIM file parsing process");
                    return;
                }
                aircraft.push_back(parsePilot(pilot.toObject(), illegalEquipmentCodes));
                flightPlanRemarksMap.insert(aircraft.back().getCallsign(), parseFlightPlanRemarks(pilot.toObject()));
            }
            for (QJsonValueRef controller : jsonDoc["controllers"].toArray())
            {
                if (!this->doWorkCheck())
                {
                    CLogMessage(this).info(u"Terminated VATSIM file parsing process");
                    return;
                }
                atcStations.push_back(parseController(controller.toObject()));
            }
            for (QJsonValueRef atis : jsonDoc["atis"].toArray())
            {
                if (!this->doWorkCheck())
                {
                    CLogMessage(this).info(u"Terminated VATSIM file parsing process");
                    return;
                }
                atcStations.push_back(parseController(atis.toObject()));
            }
 
            // this part needs to be synchronized
            {
                QWriteLocker wl(&m_lock);
                this->setUpdateTimestamp(updateTimestampFromFile);
                m_aircraft = aircraft;
                m_atcStations = atcStations;
                m_flightPlanRemarks = flightPlanRemarksMap;
            }
 
            // warnings, if required
            if (!illegalEquipmentCodes.isEmpty())
            {
                CVatsimDataFileReader::logInconsistentData(
                    CStatusMessage(this, CStatusMessage::SeverityInfo,
                                   u"Illegal / ignored equipment code(s) in VATSIM data file: %1")
                    << illegalEquipmentCodes.join(", "));
            }
 
            // data read finished
            emit this->dataFileRead(dataFileData.size() / 1000);
            emit this->dataRead(CEntityFlags::VatsimDataFile, CEntityFlags::ReadFinished, dataFileData.size() / 1000,
                                url);
        }
        else
        {
            // network error
            CLogMessage(this).warning(u"Reading VATSIM data file failed '%1' '%2'")
                << nwReply->errorString() << urlString;
            nwReply->abort();
            emit this->dataRead(CEntityFlags::VatsimDataFile, CEntityFlags::ReadFailed, 0, url);
        }
    }
 
    CSimulatedAircraft CVatsimDataFileReader::parsePilot(const QJsonObject &pilot,
                                                         QStringList &o_illegalEquipmentCodes) const
    {
        const CCallsign callsign(pilot["callsign"].toString());
        const CUser user(pilot["cid"].toString(), pilot["name"].toString(), callsign);
        const CCoordinateGeodetic position(pilot["latitude"].toDouble(), pilot["longitude"].toDouble(),
                                           pilot["altitude"].toInt());
        const CHeading heading(pilot["heading"].toInt(), CAngleUnit::deg());
        const CSpeed groundspeed(pilot["groundspeed"].toInt(), CSpeedUnit::kts());
        const CAircraftSituation situation(callsign, position, heading, {}, {}, groundspeed);
        CSimulatedAircraft aircraft(callsign, user, situation);
        const QString icaoAndEquipment(pilot["flight_plan"]["aircraft"].toString().trimmed()); // in ICAO format
        CFlightPlanAircraftInfo info(icaoAndEquipment);
        if (info.getAircraftIcao().hasValidDesignator()) { aircraft.setAircraftIcaoCode(info.getAircraftIcao()); }
        else if (!icaoAndEquipment.isEmpty()) { o_illegalEquipmentCodes.push_back(icaoAndEquipment); }
        aircraft.setTransponderCode(pilot["transponder"].toString().toInt());
        return aircraft;
    }
 
    CFlightPlanRemarks CVatsimDataFileReader::parseFlightPlanRemarks(const QJsonObject &pilot) const
    {
        return { pilot["flight_plan"]["remarks"].toString().trimmed() };
    }
 
    CAtcStation CVatsimDataFileReader::parseController(const QJsonObject &controller) const
    {
        const CCallsign callsign(controller["callsign"].toString());
        const CUser user(controller["cid"].toString(), controller["name"].toString(), callsign);
        const CFrequency freq(controller["frequency"].toString().toDouble(), CFrequencyUnit::kHz());
        const CLength range(controller["visual_range"].toInt(), CLengthUnit::NM());
        const QJsonArray atisLines = controller["text_atis"].toArray();
        const auto atisText = makeRange(atisLines).transform([](auto line) { return line.toString(); });
        const CInformationMessage atis(CInformationMessage::ATIS, atisText.to<QStringList>().join('\n'));
        return { callsign, user, freq, {}, range, true, {}, {}, atis };
    }
 
    void CVatsimDataFileReader::reloadSettings()
    {
        CReaderSettings s = m_settings.get();
        setInitialAndPeriodicTime(std::chrono::milliseconds(s.getInitialTime().toMs()),
                                  std::chrono::milliseconds(s.getPeriodicTime().toMs()));
    }
} // namespace swift::core::vatsim