icaodatareader.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_ICAODATAREADER_H
#define SWIFT_CORE_ICAODATAREADER_H
 
#include <atomic>
 
#include <QObject>
#include <QString>
 
#include "core/data/dbcaches.h"
#include "core/db/databasereader.h"
#include "core/swiftcoreexport.h"
#include "misc/aviation/aircrafticaocodelist.h"
#include "misc/aviation/airlineicaocodelist.h"
#include "misc/country.h"
#include "misc/countrylist.h"
#include "misc/datacache.h"
#include "misc/network/entityflags.h"
#include "misc/network/url.h"
 
class QDateTime;
class QNetworkReply;
 
namespace swift::core::db
{
    class SWIFT_CORE_EXPORT CIcaoDataReader : public CDatabaseReader
    {
        Q_OBJECT
 
    public:
        explicit CIcaoDataReader(QObject *owner, const CDatabaseReaderConfigList &config);
 
        swift::misc::aviation::CAircraftIcaoCodeList getAircraftIcaoCodes() const;
 
        int getAircraftIcaoCodesCount() const;
 
        swift::misc::aviation::CAircraftIcaoCode getAircraftIcaoCodeForDesignator(const QString &designator) const;
 
        swift::misc::aviation::CAircraftIcaoCodeList getAircraftIcaoCodesForDesignator(const QString &designator) const;
 
        swift::misc::aviation::CAircraftIcaoCodeList getAircraftIcaoCodesForIataCode(const QString &iataCode) const;
 
        swift::misc::aviation::CAircraftIcaoCode getAircraftIcaoCodeForDbKey(int key) const;
 
        bool containsAircraftIcaoDesignator(const QString &designator) const;
 
        swift::misc::aviation::CAircraftIcaoCode
        smartAircraftIcaoSelector(const swift::misc::aviation::CAircraftIcaoCode &icaoPattern) const;
 
        swift::misc::CCountryList getCountries() const;
 
        int getCountriesCount() const;
 
        swift::misc::CCountry getCountryForIsoCode(const QString &isoCode) const;
 
        swift::misc::CCountry getCountryForName(const QString &name) const;
 
        swift::misc::aviation::CAirlineIcaoCodeList getAirlineIcaoCodes() const;
 
        int getAirlineIcaoCodesCount() const;
 
        swift::misc::aviation::CAirlineIcaoCodeList getAirlineIcaoCodesForDesignator(const QString &designator) const;
 
        bool containsAirlineIcaoDesignator(const QString &designator) const;
 
        swift::misc::aviation::CAirlineIcaoCode
        getAirlineIcaoCodeForUniqueDesignatorOrDefault(const QString &designator, bool preferOperatingAirlines) const;
 
        swift::misc::aviation::CAirlineIcaoCodeList getAirlineIcaoCodesForIataCode(const QString &iataCode) const;
 
        swift::misc::aviation::CAirlineIcaoCode
        getAirlineIcaoCodeForUniqueIataCodeOrDefault(const QString &iataCode) const;
 
        swift::misc::aviation::CAirlineIcaoCode getAirlineIcaoCodeForDbKey(int key) const;
 
        swift::misc::aviation::CAirlineIcaoCode smartAirlineIcaoSelector(
            const swift::misc::aviation::CAirlineIcaoCode &icaoPattern,
            const swift::misc::aviation::CCallsign &callsign = swift::misc::aviation::CCallsign()) const;
 
        swift::misc::aviation::CAircraftCategoryList getAircraftCategories() const;
 
        int getAircraftCategoryCount() const;
 
        bool areAllDataRead() const;
 
        bool writeToJsonFiles(const QString &dir);
 
        // data read from local data
        virtual swift::misc::CStatusMessageList readFromJsonFiles(const QString &dir,
                                                                  swift::misc::network::CEntityFlags::Entity whatToRead,
                                                                  bool overrideNewerOnly) override;
        virtual bool readFromJsonFilesInBackground(const QString &dir,
                                                   swift::misc::network::CEntityFlags::Entity whatToRead,
                                                   bool overrideNewerOnly) override;
 
        // cache handling for base class
        virtual swift::misc::network::CEntityFlags::Entity getSupportedEntities() const override;
        virtual QDateTime getCacheTimestamp(swift::misc::network::CEntityFlags::Entity entity) const override;
        virtual int getCacheCount(swift::misc::network::CEntityFlags::Entity entity) const override;
        virtual swift::misc::network::CEntityFlags::Entity getEntitiesWithCacheCount() const override;
        virtual swift::misc::network::CEntityFlags::Entity
        getEntitiesWithCacheTimestampNewerThan(const QDateTime &threshold) const override;
        virtual void synchronizeCaches(swift::misc::network::CEntityFlags::Entity entities) override;
        virtual void admitCaches(swift::misc::network::CEntityFlags::Entity entities) override;
 
    protected:
        // cache handling for base class
        virtual void invalidateCaches(swift::misc::network::CEntityFlags::Entity entities) override;
        virtual bool hasChangedUrl(swift::misc::network::CEntityFlags::Entity entity,
                                   swift::misc::network::CUrl &oldUrlInfo,
                                   swift::misc::network::CUrl &newUrlInfo) const override;
        virtual swift::misc::network::CUrl getDbServiceBaseUrl() const override;
 
    private:
        swift::misc::CData<swift::core::data::TDbAircraftIcaoCache> m_aircraftIcaoCache {
            this, &CIcaoDataReader::aircraftIcaoCacheChanged
        };
        swift::misc::CData<swift::core::data::TDbAirlineIcaoCache> m_airlineIcaoCache {
            this, &CIcaoDataReader::airlineIcaoCacheChanged
        };
        swift::misc::CData<swift::core::data::TDbCountryCache> m_countryCache { this,
                                                                                &CIcaoDataReader::countryCacheChanged };
        swift::misc::CData<swift::core::data::TDbAircraftCategoryCache> m_categoryCache {
            this, &CIcaoDataReader::aircraftCategoryCacheChanged
        };
        std::atomic_bool m_syncedAircraftIcaoCache { false }; 
        std::atomic_bool m_syncedAirlineIcaoCache { false }; 
        std::atomic_bool m_syncedCountryCache { false }; 
        std::atomic_bool m_syncedCategories { false }; 
 
        virtual void read(swift::misc::network::CEntityFlags::Entity entities,
                          swift::misc::db::CDbFlags::DataRetrievalModeFlag mode, const QDateTime &newerThan) override;
 
        swift::misc::CData<swift::core::data::TDbIcaoReaderBaseUrl> m_readerUrlCache {
            this, &CIcaoDataReader::baseUrlCacheChanged
        };
 
        void parseAircraftIcaoData(QNetworkReply *nwReply);
 
        void parseAirlineIcaoData(QNetworkReply *nwReply);
 
        void parseCountryData(QNetworkReply *nwReply);
 
        void parseAircraftCategoryData(QNetworkReply *nwReplyPtr);
 
        void aircraftIcaoCacheChanged();
 
        void airlineIcaoCacheChanged();
 
        void countryCacheChanged();
 
        void aircraftCategoryCacheChanged();
 
        void baseUrlCacheChanged();
 
        void updateReaderUrl(const swift::misc::network::CUrl &url);
 
        swift::misc::network::CUrl getAircraftIcaoUrl(swift::misc::db::CDbFlags::DataRetrievalModeFlag mode) const;
 
        swift::misc::network::CUrl getAirlineIcaoUrl(swift::misc::db::CDbFlags::DataRetrievalModeFlag mode) const;
 
        swift::misc::network::CUrl getCountryUrl(swift::misc::db::CDbFlags::DataRetrievalModeFlag mode) const;
 
        swift::misc::network::CUrl getAircraftCategoryUrl(swift::misc::db::CDbFlags::DataRetrievalModeFlag mode) const;
    };
} // namespace swift::core::db
 
#endif // SWIFT_CORE_ICAODATAREADER_H