webdataservices.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_CORE_WEBDATASERVICES_H
#define SWIFT_CORE_WEBDATASERVICES_H
 
#include <atomic>
 
#include <QDateTime>
#include <QList>
#include <QObject>
#include <QSet>
#include <QString>
#include <QStringList>
 
#include "core/db/databasereader.h"
#include "core/swiftcoreexport.h"
#include "core/webreaderflags.h"
#include "misc/aviation/aircrafticaocodelist.h"
#include "misc/aviation/airlineicaocodelist.h"
#include "misc/aviation/airporticaocode.h"
#include "misc/aviation/airportlist.h"
#include "misc/aviation/atcstationlist.h"
#include "misc/aviation/liverylist.h"
#include "misc/countrylist.h"
#include "misc/network/entityflags.h"
#include "misc/network/serverlist.h"
#include "misc/network/url.h"
#include "misc/network/userlist.h"
#include "misc/network/voicecapabilities.h"
#include "misc/simulation/aircraftmodel.h"
#include "misc/simulation/aircraftmodellist.h"
#include "misc/simulation/distributor.h"
#include "misc/simulation/distributorlist.h"
#include "misc/statusmessagelist.h"
#include "misc/weather/metar.h"
#include "misc/weather/metarlist.h"
 
namespace swift::misc
{
    class CLogCategoryList;
 
    namespace aviation
    {
        class CCallsign;
    }
    namespace simulation
    {
        class CSimulatedAircraft;
        class CAutoPublishData;
    } // namespace simulation
} // namespace swift::misc
 
namespace swift::core
{
    namespace vatsim
    {
        class CVatsimDataFileReader;
        class CVatsimMetarReader;
        class CVatsimStatusFileReader;
        class CVatsimServerFileReader;
    } // namespace vatsim
 
    namespace db
    {
        class CAirportDataReader;
        class CDatabaseWriter;
        class CDatabaseReader;
        class CIcaoDataReader;
        class CModelDataReader;
        class CInfoDataReader;
    } // namespace db
 
    class SWIFT_CORE_EXPORT CWebDataServices : public QObject
    {
        Q_OBJECT
 
    public:
        static const QStringList &getLogCategories();
 
        CWebDataServices(CWebReaderFlags::WebReader readerFlags,
                         const swift::core::db::CDatabaseReaderConfigList &dbReaderConfig, QObject *parent = nullptr);
 
        virtual ~CWebDataServices() override;
 
        void gracefulShutdown();
 
        vatsim::CVatsimDataFileReader *getVatsimDataFileReader() const { return m_vatsimDataFileReader; }
 
        vatsim::CVatsimMetarReader *getMetarReader() const { return m_vatsimMetarReader; }
 
        swift::core::db::CInfoDataReader *getDbInfoDataReader() const { return m_dbInfoDataReader; }
 
        swift::core::db::CInfoDataReader *getSharedInfoDataReader() const { return m_sharedInfoDataReader; }
 
        db::CDatabaseWriter *getDatabaseWriter() const { return m_databaseWriter; }
 
        swift::misc::network::CEntityFlags::Entity allDbEntitiesForUsedReaders() const;
 
        swift::misc::network::CServerList getVatsimFsdServers() const;
 
        swift::misc::network::CUrl getVatsimMetarUrl() const;
 
        swift::misc::network::CUrl getVatsimDataFileUrl() const;
 
        swift::misc::network::CUserList getUsersForCallsign(const swift::misc::aviation::CCallsign &callsign) const;
 
        swift::misc::aviation::CAtcStationList
        getAtcStationsForCallsign(const swift::misc::aviation::CCallsign &callsign) const;
 
        swift::misc::network::CVoiceCapabilities
        getVoiceCapabilityForCallsign(const swift::misc::aviation::CCallsign &callsign) const;
 
        void updateWithVatsimDataFileData(swift::misc::simulation::CSimulatedAircraft &aircraftToBeUdpated) const;
 
        swift::misc::simulation::CDistributorList getDistributors() const;
 
        int getDistributorsCount() const;
 
        swift::misc::simulation::CDistributor getDistributorForDbKey(const QString &key) const;
 
        swift::misc::simulation::CDistributor
        smartDistributorSelector(const swift::misc::simulation::CDistributor &distributor) const;
 
        swift::misc::simulation::CDistributor smartDistributorSelector() const;
 
        swift::misc::simulation::CDistributor
        smartDistributorSelector(const swift::misc::simulation::CDistributor &distributor,
                                 const swift::misc::simulation::CAircraftModel &model) const;
 
        swift::misc::aviation::CLiveryList getLiveries() const;
 
        int getLiveriesCount() const;
 
        swift::misc::aviation::CLivery getLiveryForCombinedCode(const QString &combinedCode) const;
 
        swift::misc::aviation::CLivery getTempLiveryOrDefault() const;
 
        swift::misc::aviation::CLivery
        getStdLiveryForAirlineCode(const swift::misc::aviation::CAirlineIcaoCode &icao) const;
 
        swift::misc::aviation::CLivery getLiveryForDbKey(int id) const;
 
        swift::misc::aviation::CLivery smartLiverySelector(const swift::misc::aviation::CLivery &livery) const;
 
        swift::misc::simulation::CAircraftModelList getModels() const;
 
        int getModelsCount() const;
 
        QSet<int> getModelDbKeys() const;
 
        QStringList getModelStrings(bool sort = false) const;
 
        QStringList getModelCompleterStrings(bool sorted = true,
                                             const swift::misc::simulation::CSimulatorInfo &simulator = {
                                                 swift::misc::simulation::CSimulatorInfo::All }) const;
 
        swift::misc::simulation::CAircraftModelList
        getModelsForAircraftDesignatorAndLiveryCombinedCode(const QString &aircraftDesignator,
                                                            const QString &combinedCode) const;
 
        swift::misc::simulation::CAircraftModel getModelForModelString(const QString &modelString) const;
 
        bool containsModelString(const QString &modelString) const;
 
        swift::misc::simulation::CAircraftModel getModelForDbKey(int dbKey) const;
 
        swift::misc::aviation::CAircraftIcaoCodeList getAircraftIcaoCodes() const;
 
        int getAircraftIcaoCodesCount() const;
 
        swift::misc::aviation::CAircraftIcaoCode getAircraftIcaoCodeForDesignator(const QString &designator) const;
 
        int getAircraftIcaoCodesForDesignatorCount(const QString &designator) const;
 
        QSet<QString> getAircraftDesignatorsForAirline(const swift::misc::aviation::CAirlineIcaoCode &airline) const;
 
        swift::misc::aviation::CAircraftIcaoCodeList
        getAircraftIcaoCodesForAirline(const swift::misc::aviation::CAirlineIcaoCode &airline) const;
 
        swift::misc::aviation::CAircraftCategoryList getAircraftCategories() const;
 
        int getAircraftCategoriesCount() const;
 
        bool containsAircraftIcaoDesignator(const QString &designator) const;
 
        swift::misc::aviation::CAircraftIcaoCodeList getAircraftIcaoCodesForDesignator(const QString &designator) const;
 
        swift::misc::aviation::CAircraftIcaoCode getAircraftIcaoCodeForDbKey(int id) const;
 
        swift::misc::aviation::CAircraftIcaoCode
        smartAircraftIcaoSelector(const swift::misc::aviation::CAircraftIcaoCode &icao) const;
 
        swift::misc::aviation::CAirlineIcaoCodeList getAirlineIcaoCodes() const;
 
        bool containsAirlineIcaoDesignator(const QString &designator) const;
 
        swift::misc::aviation::CAirlineIcaoCode
        getAirlineIcaoCodeForUniqueDesignatorOrDefault(const QString &designator, bool preferOperatingAirlines) const;
 
        swift::misc::aviation::CAirlineIcaoCode
        getAirlineIcaoCodeForUniqueIataCodeOrDefault(const QString &iataCode) const;
 
        QStringList getAirlineNames() const;
 
        QStringList getTelephonyDesignators() const;
 
        int getAirlineIcaoCodesCount() const;
 
        swift::misc::aviation::CAirlineIcaoCodeList getAirlineIcaoCodesForDesignator(const QString &designator) const;
 
        int getAirlineIcaoCodesForDesignatorCount(const QString &designator) const;
 
        swift::misc::aviation::CAirlineIcaoCode getAirlineIcaoCodeForDbKey(int id) const;
 
        swift::misc::aviation::CAirlineIcaoCode smartAirlineIcaoSelector(
            const swift::misc::aviation::CAirlineIcaoCode &code,
            const swift::misc::aviation::CCallsign &callsign = swift::misc::aviation::CCallsign()) const;
 
        swift::misc::aviation::CAirlineIcaoCode
        findBestMatchByCallsign(const swift::misc::aviation::CCallsign &callsign) const;
 
        swift::misc::CCountryList getCountries() const;
 
        int getCountriesCount() const;
 
        swift::misc::CCountry getCountryForIsoCode(const QString &iso) const;
 
        swift::misc::CCountry getCountryForName(const QString &name) const;
 
        swift::misc::aviation::CAirportList getAirports() const;
 
        int getAirportsCount() const;
 
        swift::misc::aviation::CAirport getAirportForIcaoDesignator(const QString &icao) const;
 
        swift::misc::aviation::CAirport getAirportForNameOrLocation(const QString &nameOrLocation) const;
 
        swift::misc::weather::CMetarList getMetars() const;
 
        swift::misc::weather::CMetar getMetarForAirport(const swift::misc::aviation::CAirportIcaoCode &icao) const;
 
        swift::misc::CStatusMessageList
        validateForPublishing(const swift::misc::simulation::CAircraftModelList &modelsToBePublished, bool ignoreEqual,
                              swift::misc::simulation::CAircraftModelList &validModels,
                              swift::misc::simulation::CAircraftModelList &invalidModels) const;
 
        bool isDbModelEqualForPublishing(const swift::misc::simulation::CAircraftModel &modelToBeChecked,
                                         swift::misc::CStatusMessageList *details = nullptr) const;
 
        swift::misc::CStatusMessageList
        asyncPublishModels(const swift::misc::simulation::CAircraftModelList &modelsToBePublished) const;
 
        swift::misc::CStatusMessageList asyncAutoPublish(const swift::misc::simulation::CAutoPublishData &data) const;
 
        void triggerReadOfDbInfoObjects();
 
        void triggerReadOfSharedInfoObjects();
 
        swift::misc::network::CEntityFlags::Entity triggerRead(swift::misc::network::CEntityFlags::Entity whatToRead,
                                                               const QDateTime &newerThan = QDateTime());
 
        swift::misc::network::CEntityFlags::Entity
        triggerLoadingDirectlyFromDb(swift::misc::network::CEntityFlags::Entity whatToRead,
                                     const QDateTime &newerThan = QDateTime());
 
        swift::misc::network::CEntityFlags::Entity
        triggerLoadingDirectlyFromSharedFiles(swift::misc::network::CEntityFlags::Entity whatToRead,
                                              bool checkCacheTsUpfront);
 
        QDateTime getCacheTimestamp(swift::misc::network::CEntityFlags::Entity entity) const;
 
        QDateTime getLatestDbEntityCacheTimestamp() const;
 
        QDateTime getLatestDbEntityTimestamp(swift::misc::network::CEntityFlags::Entity entity) const;
 
        QDateTime getLatestSharedInfoObjectTimestamp(swift::misc::network::CEntityFlags::Entity entity) const;
 
        swift::misc::network::CEntityFlags::Entity
        getEntitiesWithNewerSharedFile(swift::misc::network::CEntityFlags::Entity entities) const;
 
        swift::misc::network::CEntityFlags::Entity
        getEmptyEntities(swift::misc::network::CEntityFlags::Entity entities =
                             swift::misc::network::CEntityFlags::AllDbEntities) const;
 
        swift::misc::network::CEntityFlags::Entity getSynchronizedEntitiesWithNewerSharedFileOrEmpty(
            bool syncData = true,
            swift::misc::network::CEntityFlags::Entity entities = swift::misc::network::CEntityFlags::AllDbEntities);
 
        int getCacheCount(swift::misc::network::CEntityFlags::Entity entity) const;
 
        int getDbInfoObjectCount(swift::misc::network::CEntityFlags::Entity entity) const;
 
        int getDbInfoObjectsCount(swift::misc::network::CEntityFlags::Entity entities,
                                  bool stopIfNotFound = true) const;
 
        int getSharedInfoObjectCount(swift::misc::network::CEntityFlags::Entity entity) const;
 
        QString getDbReadersLog(const QString &separator = "\n") const;
 
        QString getReadersLog(const QString &separator = "\n") const;
 
        bool hasSuccesfullyConnectedSwiftDb() const;
 
        bool hasDbAircraftData() const;
 
        bool hasDbModelData() const;
 
        bool hasDbIcaoData() const;
 
        void admitDbCaches(swift::misc::network::CEntityFlags::Entity entities);
 
        void synchronizeDbCaches(swift::misc::network::CEntityFlags::Entity entities);
 
        bool writeDbDataToDisk(const QString &dir);
 
        bool readDbDataFromDisk(const QString &dir, bool inBackground, bool overrideNewerOnly);
 
        swift::misc::CStatusMessageList initDbCachesFromLocalResourceFiles(bool inBackground);
 
        swift::misc::CStatusMessageList
        initDbCachesFromLocalResourceFiles(swift::misc::network::CEntityFlags::Entity entities, bool inBackground);
 
    signals:
        void dataRead(swift::misc::network::CEntityFlags::Entity entity,
                      swift::misc::network::CEntityFlags::ReadState state, int number, const QUrl &url);
 
        void entityDownloadProgress(swift::misc::network::CEntityFlags::Entity entity, int logId, int progress,
                                    qint64 current, qint64 max, const QUrl &url);
 
        void databaseReaderMessages(const swift::misc::CStatusMessageList &messages);
 
        void swiftDbDataRead(bool success);
 
        // simplified signals follow
        // 1) simple signature
        // 2) fired directly after read, no need to wait for other entities
 
 
        void swiftDbAllDataRead();
 
        void sharedInfoObjectsRead();
 
        void swiftDbModelsRead();
 
        void swiftDbAircraftIcaoRead();
 
        void swiftDbAirlineIcaoRead();
 
        void swiftDbAirportsRead();
 
        void swiftDbAllIcaoEntitiesRead();
 
        void swiftDbModelMatchingEntitiesRead();
 
    public slots:
        void readDeferredInBackground(swift::misc::network::CEntityFlags::Entity entities, int delayMs);
 
        void readInBackground(
            swift::misc::network::CEntityFlags::Entity entities = swift::misc::network::CEntityFlags::AllEntities);
 
    private:
        void receivedMetars(const swift::misc::weather::CMetarList &metars);
 
        void vatsimDataFileRead(int kB);
 
        void vatsimStatusFileRead(int bytes);
 
        void vatsimServerFileRead(int bytes);
 
        void startVatsimServerFileReader();
 
        void readFromSwiftReader(swift::misc::network::CEntityFlags::Entity entities,
                                 swift::misc::network::CEntityFlags::ReadState state, int number, const QUrl &url);
 
        void initReaders(CWebReaderFlags::WebReader readersNeeded, swift::misc::network::CEntityFlags::Entity entities);
 
        void initDbInfoObjectReaderAndTriggerRead();
 
        void initSharedInfoObjectReaderAndTriggerRead();
 
        db::CDatabaseReader *getDbReader(swift::misc::network::CEntityFlags::Entity entity) const;
 
        void initWriters();
 
        bool signalEntitiesAlreadyRead(swift::misc::network::CEntityFlags::Entity entities);
 
        int getInfoObjectCount(swift::misc::network::CEntityFlags::Entity entity,
                               swift::core::db::CInfoDataReader *reader) const;
 
        swift::misc::network::CEntityFlags::Entity getDbEntitiesWithCachedData() const;
 
        swift::misc::network::CEntityFlags::Entity
        getDbEntitiesWithTimestampNewerThan(const QDateTime &threshold) const;
 
        bool waitForDbInfoObjectsThenRead(swift::misc::network::CEntityFlags::Entity entities);
 
        bool waitForSharedInfoObjectsThenRead(swift::misc::network::CEntityFlags::Entity entities);
 
        bool waitForInfoObjectsThenRead(swift::misc::network::CEntityFlags::Entity entities, const QString &info,
                                        swift::core::db::CInfoDataReader *infoReader, QDateTime &timeOut);
 
        swift::misc::network::CEntityFlags::Entity m_entitiesPeriodicallyRead =
            swift::misc::network::CEntityFlags::NoEntity; 
        swift::misc::network::CEntityFlags::Entity m_swiftDbEntitiesRead =
            swift::misc::network::CEntityFlags::NoEntity; 
        swift::core::db::CDatabaseReaderConfigList m_dbReaderConfig; 
        std::atomic_bool m_shuttingDown { false }; 
        QDateTime m_dbInfoObjectTimeout; 
        QDateTime m_sharedInfoObjectsTimeout; 
        QSet<swift::misc::network::CEntityFlags::Entity> m_signalledEntities; 
 
        // for reading XML and VATSIM data files
        vatsim::CVatsimStatusFileReader *m_vatsimStatusReader = nullptr;
        vatsim::CVatsimDataFileReader *m_vatsimDataFileReader = nullptr;
        vatsim::CVatsimMetarReader *m_vatsimMetarReader = nullptr;
        vatsim::CVatsimServerFileReader *m_vatsimServerFileReader = nullptr;
        db::CIcaoDataReader *m_icaoDataReader = nullptr;
        db::CModelDataReader *m_modelDataReader = nullptr;
        db::CAirportDataReader *m_airportDataReader = nullptr;
        db::CInfoDataReader *m_dbInfoDataReader = nullptr;
        db::CInfoDataReader *m_sharedInfoDataReader = nullptr;
 
        // writing objects directly into DB
        db::CDatabaseWriter *m_databaseWriter = nullptr;
    };
} // namespace swift::core
 
#endif // SWIFT_CORE_WEBDATASERVICES_H