modeldatareader.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_MODELDATAREADER_H
#define SWIFT_CORE_MODELDATAREADER_H
 
#include <QDateTime>
#include <QList>
#include <QObject>
#include <QSet>
#include <QString>
#include <QStringList>
 
#include "core/data/dbcaches.h"
#include "core/db/databasereader.h"
#include "core/swiftcoreexport.h"
#include "misc/aviation/aircraftcategorylist.h"
#include "misc/aviation/airlineicaocode.h"
#include "misc/aviation/liverylist.h"
#include "misc/network/entityflags.h"
#include "misc/network/url.h"
#include "misc/simulation/aircraftmodellist.h"
#include "misc/simulation/distributorlist.h"
 
class QNetworkReply;
 
namespace swift::core::db
{
    class SWIFT_CORE_EXPORT CModelDataReader : public CDatabaseReader
    {
        Q_OBJECT
 
    public:
        explicit CModelDataReader(QObject *owner, const CDatabaseReaderConfigList &config);
 
        swift::misc::aviation::CLiveryList getLiveries() const;
 
        swift::misc::aviation::CLivery getLiveryForCombinedCode(const QString &combinedCode) const;
 
        swift::misc::aviation::CLivery
        getStdLiveryForAirlineVDesignator(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::CDistributorList getDistributors() const;
 
        swift::misc::simulation::CDistributor getDistributorForDbKey(const QString &dbKey) const;
 
        swift::misc::simulation::CAircraftModelList getModels() const;
 
        swift::misc::simulation::CAircraftModel getModelForModelString(const QString &modelString) const;
 
        bool containsModelString(const QString &modelString) const;
 
        swift::misc::simulation::CAircraftModel getModelForDbKey(int dbKey) const;
 
        QSet<QString> getAircraftDesignatorsForAirline(const swift::misc::aviation::CAirlineIcaoCode &code) const;
 
        swift::misc::aviation::CAircraftIcaoCodeList
        getAicraftIcaoCodesForAirline(const swift::misc::aviation::CAirlineIcaoCode &code) const;
 
        swift::misc::simulation::CAircraftModelList
        getModelsForAircraftDesignatorAndLiveryCombinedCode(const QString &aircraftDesignator,
                                                            const QString &combinedCode);
 
        int getLiveriesCount() const;
 
        int getDistributorsCount() const;
 
        swift::misc::simulation::CDistributor
        smartDistributorSelector(const swift::misc::simulation::CDistributor &distributorPattern) const;
 
        swift::misc::simulation::CDistributor
        smartDistributorSelector(const swift::misc::simulation::CDistributor &distributorPattern,
                                 const swift::misc::simulation::CAircraftModel &model) const;
 
        int getModelsCount() const;
 
        QSet<int> getModelDbKeys() const;
 
        QStringList getModelStringList(bool sort = false) 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::TDbLiveryCache> m_liveryCache { this,
                                                                              &CModelDataReader::liveryCacheChanged };
        swift::misc::CData<swift::core::data::TDbModelCache> m_modelCache { this,
                                                                            &CModelDataReader::modelCacheChanged };
        swift::misc::CData<swift::core::data::TDbDistributorCache> m_distributorCache {
            this, &CModelDataReader::distributorCacheChanged
        };
        std::atomic_bool m_syncedLiveryCache { false }; 
        std::atomic_bool m_syncedModelCache { false }; 
        std::atomic_bool m_syncedDistributorCache { false }; 
 
        virtual void read(swift::misc::network::CEntityFlags::Entity entities =
                              swift::misc::network::CEntityFlags::DistributorLiveryModel,
                          swift::misc::db::CDbFlags::DataRetrievalModeFlag mode = swift::misc::db::CDbFlags::DbReading,
                          const QDateTime &newerThan = QDateTime()) override;
 
        swift::misc::CData<swift::core::data::TDbModelReaderBaseUrl> m_readerUrlCache {
            this, &CModelDataReader::baseUrlCacheChanged
        };
 
        void parseLiveryData(QNetworkReply *nwReply);
 
        void parseDistributorData(QNetworkReply *nwReply);
 
        void parseModelData(QNetworkReply *nwReply);
 
        void liveryCacheChanged();
 
        void modelCacheChanged();
 
        void distributorCacheChanged();
 
        void baseUrlCacheChanged();
 
        void updateReaderUrl(const swift::misc::network::CUrl &url);
 
        swift::misc::aviation::CAircraftIcaoCodeList getAircraftAircraftIcaos() const;
 
        swift::misc::aviation::CAircraftCategoryList getAircraftCategories() const;
 
        swift::misc::network::CUrl getLiveryUrl(swift::misc::db::CDbFlags::DataRetrievalModeFlag mode) const;
 
        swift::misc::network::CUrl getDistributorUrl(swift::misc::db::CDbFlags::DataRetrievalModeFlag mode) const;
 
        swift::misc::network::CUrl getModelUrl(swift::misc::db::CDbFlags::DataRetrievalModeFlag mode) const;
    };
} // namespace swift::core::db
 
#endif // SWIFT_CORE_MODELDATAREADER_H