/* Copyright (C) 2015
 * swift project Community / Contributors
 *
 * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
 * directory of this distribution. No part of swift project, including this file, may be copied, modified, propagated,
 * or distributed except according to the terms contained in the LICENSE file.
 */

//! \file

#ifndef BLACKCORE_AIRCRAFTMATCHER_H
#define BLACKCORE_AIRCRAFTMATCHER_H

#include "blackcore/webdataservicesms.h"
#include "blackcore/blackcoreexport.h"
#include "blackmisc/simulation/aircraftmodelsetprovider.h"
#include "blackmisc/simulation/aircraftmatchersetup.h"
#include "blackmisc/simulation/aircraftmodellist.h"
#include "blackmisc/simulation/matchingscriptmisc.h"
#include "blackmisc/simulation/matchingstatistics.h"
#include "blackmisc/simulation/matchinglog.h"
#include "blackmisc/simulation/categorymatcher.h"
#include "blackmisc/statusmessage.h"
#include "blackmisc/valueobject.h"
#include "blackmisc/variant.h"

#include <QFlags>
#include <QObject>
#include <QString>
#include <QPair>
#include <QSet>

namespace BlackMisc
{
    class CLogCategoryList;
    class CStatusMessageList;
    namespace Aviation   { class CCallsign; }
    namespace Simulation { class CSimulatedAircraft; }
}

namespace BlackCore
{
    //! Matcher for all models.
    //! \details Reads the model set (ie the models the user wants to use).
    //!          Also Allows to reverse lookup a model (from network to DB data).
    class BLACKCORE_EXPORT CAircraftMatcher :
        public QObject,
        public BlackMisc::Simulation::IAircraftModelSetProvider
    {
        Q_OBJECT
        Q_INTERFACES(BlackMisc::Simulation::IAircraftModelSetProvider)

    public:
        //! Log categories
        static const QStringList &getLogCategories();

        //! Constructor
        CAircraftMatcher(const BlackMisc::Simulation::CAircraftMatcherSetup &setup, QObject *parent = nullptr);

        //! Constructor
        CAircraftMatcher(QObject *parent = nullptr);

        //! Destructor
        //! \remark saves a log of removed models if any
        virtual ~CAircraftMatcher() override;

        //! Copy constructor
        CAircraftMatcher(const CAircraftMatcher &) = delete;

        //! Copy assignment operator
        CAircraftMatcher &operator =(const CAircraftMatcher &) = delete;

        //! Set the setup
        bool setSetup(const BlackMisc::Simulation::CAircraftMatcherSetup &setup);

        //! Get the setup
        BlackMisc::Simulation::CAircraftMatcherSetup getSetup() const { return m_setup; }

        //! Get the closest matching aircraft model from set.
        //! Result depends on setup.
        //! \sa BlackMisc::Simulation::CAircraftMatcherSetup
        //! \threadsafe
        BlackMisc::Simulation::CAircraftModel getClosestMatch(
            const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft,
            BlackMisc::Simulation::MatchingLog whatToLog,
            BlackMisc::CStatusMessageList *log,
            bool useMatchingScript) const;

        //! Return an valid airline ICAO code
        //! \threadsafe
        static BlackMisc::Aviation::CAirlineIcaoCode failoverValidAirlineIcaoDesignator(
            const BlackMisc::Aviation::CCallsign &callsign,
            const QString &primaryIcao, const QString &secondaryIcao,
            bool airlineFromCallsign, const QString &airlineName, const QString &airlineTelephony, bool useWebServices, BlackMisc::CStatusMessageList *log = nullptr);

        //! Return an valid airline ICAO code from a given model list
        //! \remarks model list could be the model set
        //! \threadsafe
        static BlackMisc::Aviation::CAirlineIcaoCode failoverValidAirlineIcaoDesignator(
            const BlackMisc::Aviation::CCallsign &callsign,
            const QString &primaryIcao, const QString &secondaryIcao,
            bool airlineFromCallsign,
            const QString &airlineName, const QString &airlineTelephony,
            const BlackMisc::Simulation::CAircraftModelList &models,
            BlackMisc::CStatusMessageList *log = nullptr);

        //! Return an valid airline ICAO code from a given model list and use webservices if NOT found
        //! \remarks model list could be the model set
        //! \threadsafe
        static BlackMisc::Aviation::CAirlineIcaoCode failoverValidAirlineIcaoDesignatorModelsFirst(const BlackMisc::Aviation::CCallsign &callsign,
                const QString &primaryIcao, const QString &secondaryIcao,
                bool airlineFromCallsign,
                const QString &airlineName, const QString &airlineTelephony,
                const BlackMisc::Simulation::CAircraftModelList &models,
                BlackMisc::CStatusMessageList *log = nullptr);

        //! Run the network reverse lookup script
        //! \threadsafe
        //! \ingroup reverselookup
        static BlackMisc::Simulation::MatchingScriptReturnValues reverseLookupScript(const BlackMisc::Simulation::CAircraftModel &inModel, const BlackMisc::Simulation::CAircraftMatcherSetup &setup, const BlackMisc::Simulation::CAircraftModelList &modelSet, BlackMisc::CStatusMessageList *log);

        //! Run the matching stage lookup script
        //! \threadsafe
        static BlackMisc::Simulation::MatchingScriptReturnValues matchingStageScript(const BlackMisc::Simulation::CAircraftModel &inModel, const BlackMisc::Simulation::CAircraftModel &matchedModel, const BlackMisc::Simulation::CAircraftMatcherSetup &setup, const BlackMisc::Simulation::CAircraftModelList &modelSet, BlackMisc::CStatusMessageList *log);

        //! Run the matching script
        //! \threadsafe
        static BlackMisc::Simulation::MatchingScriptReturnValues matchingScript(const QString &js,
                const BlackMisc::Simulation::CAircraftModel &inModel, const BlackMisc::Simulation::CAircraftModel &matchedModel, const BlackMisc::Simulation::CAircraftMatcherSetup &setup,
                const BlackMisc::Simulation::CAircraftModelList &modelSet, BlackMisc::Simulation::MatchingScript ms,
                BlackMisc::CStatusMessageList *log);

        //! Try to find the corresponding data in DB and get best information for given data
        //! \threadsafe
        //! \ingroup reverselookup
        //! \remark NOT running matching script
        static BlackMisc::Simulation::CAircraftModel reverseLookupModel(const BlackMisc::Aviation::CCallsign &callsign,
                const BlackMisc::Aviation::CAircraftIcaoCode &networkAircraftIcao,
                const BlackMisc::Aviation::CAirlineIcaoCode &networkAirlineIcao, const QString &networkLiveryInfo, const QString &networkModelString,
                const BlackMisc::Simulation::CAircraftMatcherSetup &setup,
                const BlackMisc::Simulation::CAircraftModelList &modelSet,
                BlackMisc::Simulation::CAircraftModel::ModelType type,
                BlackMisc::CStatusMessageList *log);

        //! Try to find the corresponding data in DB and get best information for following matching
        //! \threadsafe
        //! \ingroup reverselookup
        //! \remark NOT running matching script
        static BlackMisc::Simulation::CAircraftModel reverseLookupModel(
            const BlackMisc::Simulation::CAircraftModel &modelToLookup,
            const QString &networkLiveryInfo,
            const BlackMisc::Simulation::CAircraftMatcherSetup &setup,
            const BlackMisc::Simulation::CAircraftModelList &modelSet,
            BlackMisc::CStatusMessageList *log);

        //! Try to find the corresponding data in DB and get best information for following matching
        //! \threadsafe
        //! \ingroup reverselookup
        //! \remark Running matching script
        static BlackMisc::Simulation::CAircraftModel reverseLookupModelMs(
            const BlackMisc::Simulation::CAircraftModel &modelToLookup,
            const QString &networkLiveryInfo,
            const BlackMisc::Simulation::CAircraftMatcherSetup &setup,
            const BlackMisc::Simulation::CAircraftModelList &modelSet,
            BlackMisc::CStatusMessageList *log);

        //! Try to find model by model string
        //! \threadsafe
        //! \ingroup reverselookup
        static BlackMisc::Simulation::CAircraftModel reverseLookupModelStringInDB(
            const QString &modelString,
            const BlackMisc::Aviation::CCallsign &callsign,
            bool doLookupString, BlackMisc::CStatusMessageList *log);

        //! Try to find model by model string in set
        //! \threadsafe
        //! \remark mostly needed to work witn NON-DB values in matching script
        //! \ingroup reverselookup
        static BlackMisc::Simulation::CAircraftModel reverseLookupModelStringInSet(
            const QString &modelString,
            const BlackMisc::Aviation::CCallsign &callsign, const BlackMisc::Simulation::CAircraftModelList &modelSet,
            bool useNonDbEntries, BlackMisc::CStatusMessageList *log);

        //! Try to find model by id
        //! \threadsafe
        //! \ingroup reverselookup
        static BlackMisc::Simulation::CAircraftModel reverseLookupModelId(int id, const BlackMisc::Aviation::CCallsign &callsign, BlackMisc::CStatusMessageList *log);

        //! Try to find the DB corresponding ICAO code
        //! \threadsafe
        //! \ingroup reverselookup
        static BlackMisc::Aviation::CAircraftIcaoCode reverseLookupAircraftIcao(
            const BlackMisc::Aviation::CAircraftIcaoCode &icaoDesignator,
            const BlackMisc::Aviation::CCallsign &logCallsign = {},
            BlackMisc::CStatusMessageList *log = nullptr);

        //! Lookup of ICAO by id
        //! \threadsafe
        //! \ingroup reverselookup
        static BlackMisc::Aviation::CAircraftIcaoCode reverseLookupAircraftIcaoId(int id, const BlackMisc::Aviation::CCallsign &logCallsign, BlackMisc::CStatusMessageList *log = nullptr);

        //! Try to find the DB corresponding ICAO code
        //! \threadsafe
        //! \ingroup reverselookup
        static BlackMisc::Aviation::CAirlineIcaoCode reverseLookupAirlineIcao(
            const BlackMisc::Aviation::CAirlineIcaoCode &icaoPattern,
            const BlackMisc::Aviation::CCallsign &callsign = {}, BlackMisc::CStatusMessageList *log = nullptr);

        //! Lookup of standard livery
        //! \threadsafe
        //! \ingroup reverselookup
        static BlackMisc::Aviation::CLivery reverseLookupStandardLivery(
            const BlackMisc::Aviation::CAirlineIcaoCode &airline,
            const BlackMisc::Aviation::CCallsign &callsign, BlackMisc::CStatusMessageList *log = nullptr);

        //! Lookup of livery by id
        //! \threadsafe
        //! \ingroup reverselookup
        static BlackMisc::Aviation::CLivery reverseLookupLiveryId(int id, const BlackMisc::Aviation::CCallsign &logCallsign, BlackMisc::CStatusMessageList *log = nullptr);

        //! Lookup by ids
        //! \threadsafe
        //! \ingroup reverselookup
        static int reverseLookupByIds(const BlackMisc::Simulation::DBTripleIds &ids, BlackMisc::Aviation::CAircraftIcaoCode &aircraftIcao, BlackMisc::Aviation::CLivery &livery, const BlackMisc::Aviation::CCallsign &logCallsign, BlackMisc::CStatusMessageList *log = nullptr);

        //! Lookup of airline name
        //! \threadsafe
        //! \ingroup reverselookup
        static QString reverseLookupAirlineName(
            const QString &candidate, const BlackMisc::Aviation::CCallsign &callsign = {}, BlackMisc::CStatusMessageList *log = nullptr);

        //! Lookup of telephony designator
        //! \threadsafe
        //! \ingroup reverselookup
        static QString reverseLookupTelephonyDesignator(
            const QString &candidate, const BlackMisc::Aviation::CCallsign &callsign = {},
            BlackMisc::CStatusMessageList *log = nullptr);

        //! Is this aircraft designator known?
        //! \threadsafe
        static bool isKnownAircraftDesignator(
            const QString &candidate, const BlackMisc::Aviation::CCallsign &callsign = {},
            BlackMisc::CStatusMessageList *log = nullptr);

        //! Is this aircraft designator known?
        //! \threadsafe
        static bool isKnownModelString(
            const QString &candidate, const BlackMisc::Aviation::CCallsign &callsign = {},
            BlackMisc::CStatusMessageList *log = nullptr);

        //! Search among the airline aircraft
        //! \remark only works if an airline is know
        //! \threadsafe
        static BlackMisc::Aviation::CAircraftIcaoCode searchAmongAirlineAircraft(
            const QString &icaoString,
            const BlackMisc::Aviation::CAirlineIcaoCode &airline,
            const BlackMisc::Aviation::CCallsign &callsign = {},
            BlackMisc::CStatusMessageList *log = nullptr);

        //! Turn callsign into airline
        //! \threadsafe
        static BlackMisc::Aviation::CAirlineIcaoCode callsignToAirline(const BlackMisc::Aviation::CCallsign &callsign, BlackMisc::CStatusMessageList *log = nullptr);

        //! \copydoc BlackMisc::Simulation::IAircraftModelSetProvider::getModelSet
        virtual BlackMisc::Simulation::CAircraftModelList getModelSet() const override { return m_modelSet; }

        //! Model set as reference
        virtual const BlackMisc::Simulation::CAircraftModelList &getModelSetRef() const { return m_modelSet; }

        //! Model set count
        virtual int getModelSetCount() const override { return m_modelSet.sizeInt(); }

        //! Models
        bool hasModels() const { return !m_modelSet.isEmpty(); }

        //! Set the models we want to use
        //! \note uses a set from "somewhere else" so it can also be used with arbitrary sets for testing
        int setModelSet(const BlackMisc::Simulation::CAircraftModelList &models, const BlackMisc::Simulation::CSimulatorInfo &simulator, bool forced);

        //! Remove a model for matching
        //! \remark effective until new set is set
        void disableModelsForMatching(const BlackMisc::Simulation::CAircraftModelList &removedModels, bool incremental);

        //! The disabled models for matching
        BlackMisc::Simulation::CAircraftModelList getDisabledModelsForMatching() const { return m_disabledModels; }

        //! Restore the models removed with CAircraftMatcher::disableModelForMatching
        void restoreDisabledModels();

        //! Default model
        const BlackMisc::Simulation::CAircraftModel &getDefaultModel() const { return m_defaultModel; }

        //! Set default model, can be set by driver specific for simulator
        void setDefaultModel(const BlackMisc::Simulation::CAircraftModel &defaultModel);

        //! The current statistics
        const BlackMisc::Simulation::CMatchingStatistics &getCurrentStatistics() const { return m_statistics; }

        //! Clear the statistics
        void clearMatchingStatistics() { m_statistics.clear(); }

        //! Evaluate if a statistics entry makes sense and add it
        void evaluateStatisticsEntry(const QString &sessionId, const BlackMisc::Aviation::CCallsign &callsign, const QString &aircraftIcao, const QString &airlineIcao, const QString &livery);

        //! Adding a model failed
        void addingRemoteModelFailed(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft);

    signals:
        //! Setup changed
        void setupChanged();

    private:
        //! Save the disabled models if any
        bool saveDisabledForMatchingModels();

        //! The search based implementation
        static BlackMisc::Simulation::CAircraftModelList getClosestMatchStepwiseReduceImplementation(
            const BlackMisc::Simulation::CAircraftModelList &modelSet, const BlackMisc::Simulation::CAircraftMatcherSetup &setup,
            const BlackMisc::Simulation::CCategoryMatcher &categoryMatcher, const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft,
            BlackMisc::Simulation::MatchingLog whatToLog, BlackMisc::CStatusMessageList *log = nullptr);

        //! The score based implementation
        static BlackMisc::Simulation::CAircraftModelList getClosestMatchScoreImplementation(const BlackMisc::Simulation::CAircraftModelList &modelSet, const BlackMisc::Simulation::CAircraftMatcherSetup &setup, const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft, int &maxScore, BlackMisc::Simulation::MatchingLog whatToLog, BlackMisc::CStatusMessageList *log = nullptr);

        //! Get combined type default model, i.e. get a default model under consideration of the combined code such as "L2J"
        //! \see BlackMisc::Simulation::CSimulatedAircraft::getAircraftIcaoCombinedType
        //! \remark in any case a (default) model is returned
        static BlackMisc::Simulation::CAircraftModel getCombinedTypeDefaultModel(const BlackMisc::Simulation::CAircraftModelList &modelSet, const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft, const BlackMisc::Simulation::CAircraftModel &defaultModel, BlackMisc::Simulation::MatchingLog whatToLog, BlackMisc::CStatusMessageList *log = nullptr);

        //! Search in models by key (aka model string)
        //! \threadsafe
        static BlackMisc::Simulation::CAircraftModel matchByExactModelString(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft, const BlackMisc::Simulation::CAircraftModelList &models, BlackMisc::Simulation::MatchingLog whatToLog, BlackMisc::CStatusMessageList *log);

        //! Installed models by ICAO data
        //! \threadsafe
        static BlackMisc::Simulation::CAircraftModelList ifPossibleReduceByIcaoData(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft, const BlackMisc::Simulation::CAircraftModelList &models, const BlackMisc::Simulation::CAircraftMatcherSetup &setup, bool &reduced, BlackMisc::CStatusMessageList *log);

        //! Find model by aircraft family
        //! \threadsafe
        static BlackMisc::Simulation::CAircraftModelList ifPossibleReduceByFamily(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft, bool allowPseudoFamily, const BlackMisc::Simulation::CAircraftModelList &inList, bool &reduced, QString &usedFamily, BlackMisc::CStatusMessageList *log);

        //! Find model by aircraft family
        //! \remark pseudo family searches for same combined type and manufacturer
        //! \threadsafe
        static BlackMisc::Simulation::CAircraftModelList ifPossibleReduceByFamily(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft, const QString &family, bool allowPseudoFamily, const BlackMisc::Simulation::CAircraftModelList &inList, const QString &hint, bool &reduced, BlackMisc::CStatusMessageList *log);

        //! Search for exact livery and aircraft ICAO code
        //! \threadsafe
        static BlackMisc::Simulation::CAircraftModelList ifPossibleReduceByLiveryAndAircraftIcaoCode(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft, const BlackMisc::Simulation::CAircraftModelList &inList, bool &reduced, BlackMisc::CStatusMessageList *log);

        //! Reduce by manufacturer
        //! \threadsafe
        static BlackMisc::Simulation::CAircraftModelList ifPossibleReduceByManufacturer(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft, const BlackMisc::Simulation::CAircraftModelList &inList, const QString &info, bool &reduced, BlackMisc::CStatusMessageList *log);

        //! Reduce by manufacturer
        //! \threadsafe
        static BlackMisc::Aviation::CAircraftIcaoCodeList ifPossibleReduceAircraftIcaoByManufacturer(const BlackMisc::Aviation::CAircraftIcaoCode &icaoCode, const BlackMisc::Aviation::CAircraftIcaoCodeList &inList, const QString &info, bool &reduced, const BlackMisc::Aviation::CCallsign &logCallsign, BlackMisc::CStatusMessageList *log);

        //! Reduce by aircraft ICAO
        //! \threadsafe
        static BlackMisc::Simulation::CAircraftModelList ifPossibleReduceByAircraft(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft, const BlackMisc::Simulation::CAircraftModelList &inList, const QString &info, bool &reduced, BlackMisc::CStatusMessageList *log);

        //! Reduce by aircraft ICAO or family
        //! \threadsafe
        static BlackMisc::Simulation::CAircraftModelList ifPossibleReduceByAircraftOrFamily(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft, bool allowPseudoFamily, const BlackMisc::Simulation::CAircraftModelList &inList, const BlackMisc::Simulation::CAircraftMatcherSetup &setup, const QString &info, bool &reduced, BlackMisc::CStatusMessageList *log);

        //! Reduce by airline ICAO
        //! \threadsafe
        static BlackMisc::Simulation::CAircraftModelList ifPossibleReduceByAirline(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft, const BlackMisc::Simulation::CAircraftModelList &inList, const BlackMisc::Simulation::CAircraftMatcherSetup &setup, const QString &info, bool &reduced, BlackMisc::CStatusMessageList *log);

        //! Reduce by airline name/telephone designator
        //! \threadsafe
        static BlackMisc::Simulation::CAircraftModelList ifPossibleReduceModelsByAirlineNameTelephonyDesignator(const BlackMisc::Aviation::CCallsign &cs, const QString &airlineName, const QString &telephony, const BlackMisc::Simulation::CAircraftModelList &inList, const QString &info, bool &reduced, BlackMisc::CStatusMessageList *log);

        //! Installed models by combined code (ie L2J, L1P, ...)
        //! \threadsafe
        static BlackMisc::Simulation::CAircraftModelList ifPossibleReduceByCombinedType(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft, const BlackMisc::Simulation::CAircraftModelList &inList, const BlackMisc::Simulation::CAircraftMatcherSetup &setup, bool &reduced, BlackMisc::CStatusMessageList *log);

        //! By military flag
        //! \threadsafe
        static BlackMisc::Simulation::CAircraftModelList ifPossibleReduceByMilitaryFlag(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft, const BlackMisc::Simulation::CAircraftModelList &inList, bool &reduced, BlackMisc::CStatusMessageList *log);

        //! By VTOL flag
        //! \threadsafe
        static BlackMisc::Simulation::CAircraftModelList ifPossibleReduceByVTOLFlag(const BlackMisc::Simulation::CSimulatedAircraft &remoteAircraft, const BlackMisc::Simulation::CAircraftModelList &inList, bool &reduced, BlackMisc::CStatusMessageList *log);

        //! Scores to string for debugging
        //! \threadsafe
        static QString scoresToString(const BlackMisc::Simulation::ScoredModels &scores, int lastElements = 5);

        //! Designator to object
        //! \threadsafe
        static BlackMisc::Aviation::CAirlineIcaoCode stringToAirlineIcaoObject(const BlackMisc::Aviation::CCallsign &cs, const QString &designator, const QString &airlineName, const QString &airlineTelephony, bool useSwiftDbData, BlackMisc::CStatusMessageList *log);

        //! Valid designator, allows to check against swift DB
        //! \threadsafe
        static bool isValidAirlineIcaoDesignator(const QString &designator, bool checkAgainstSwiftDb);

        //! Use pseudo family
        static bool constexpr UsePseudoFamily = true;

        BlackMisc::Simulation::CAircraftMatcherSetup m_setup;           //!< setup
        BlackMisc::Simulation::CAircraftModel        m_defaultModel;    //!< model to be used as default model
        BlackMisc::Simulation::CAircraftModelList    m_modelSet;        //!< models used for model matching
        BlackMisc::Simulation::CAircraftModelList    m_disabledModels;  //!< disabled models for matching
        BlackMisc::Simulation::CSimulatorInfo        m_simulator;       //!< simulator (optional)
        BlackMisc::Simulation::CMatchingStatistics   m_statistics;      //!< matching statistics
        BlackMisc::Simulation::CCategoryMatcher      m_categoryMatcher; //!< the category matcher
        QString                                      m_modelSetInfo;    //!< info string
    };
} // namespace

#endif // guard