contextnetwork.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_CORE_CONTEXT_CONTEXTNETWORK_H
#define SWIFT_CORE_CONTEXT_CONTEXTNETWORK_H
 
#include <functional>
 
#include <QCommandLineOption>
#include <QObject>
#include <QString>
 
#include "core/context/context.h"
#include "core/corefacade.h"
#include "core/corefacadeconfig.h"
#include "core/swiftcoreexport.h"
#include "misc/aviation/aircraftpartslist.h"
#include "misc/aviation/airporticaocode.h"
#include "misc/aviation/atcstation.h"
#include "misc/aviation/atcstationlist.h"
#include "misc/aviation/callsignset.h"
#include "misc/aviation/comsystem.h"
#include "misc/aviation/flightplan.h"
#include "misc/identifiable.h"
#include "misc/identifier.h"
#include "misc/network/clientlist.h"
#include "misc/network/connectionstatus.h"
#include "misc/network/loginmode.h"
#include "misc/network/server.h"
#include "misc/network/serverlist.h"
#include "misc/network/textmessagelist.h"
#include "misc/network/user.h"
#include "misc/network/userlist.h"
#include "misc/simulation/remoteaircraftprovider.h"
#include "misc/simulation/simulatedaircraftlist.h"
#include "misc/statusmessage.h"
#include "misc/weather/metar.h"
 
// clazy:excludeall=const-signal-or-slot
 
#define SWIFT_CORE_CONTEXTNETWORK_INTERFACENAME "org.swift_project.swift_core.contextnetwork"
 
#define SWIFT_CORE_CONTEXTNETWORK_OBJECTPATH "/network"
 
class QDBusConnection;
namespace swift::misc
{
    class CDBusServer;
    namespace aviation
    {
        class CAircraftParts;
        class CCallsign;
    } // namespace aviation
    namespace network
    {
        class CRawFsdMessage;
        class CTextMessage;
    } // namespace network
    namespace simulation
    {
        class CAircraftModel;
    }
} // namespace swift::misc
namespace swift::core::context
{
    class SWIFT_CORE_EXPORT IContextNetwork : public IContext
    {
        Q_OBJECT
        Q_CLASSINFO("D-Bus Interface", SWIFT_CORE_CONTEXTNETWORK_INTERFACENAME)
 
    public:
        static const QString &InterfaceName()
        {
            static QString s(SWIFT_CORE_CONTEXTNETWORK_INTERFACENAME);
            return s;
        }
 
        static const QString &ObjectPath()
        {
            static QString s(SWIFT_CORE_CONTEXTNETWORK_OBJECTPATH);
            return s;
        }
 
        virtual QString getPathAndContextId() const override { return this->buildPathAndContextId(ObjectPath()); }
 
        static IContextNetwork *create(CCoreFacade *parent, CCoreFacadeConfig::ContextMode mode,
                                       swift::misc::CDBusServer *server, QDBusConnection &connection);
 
        virtual ~IContextNetwork() override {}
 
    signals:
        void removedAircraft(const swift::misc::aviation::CCallsign &callsign);
 
        void addedAircraft(const swift::misc::simulation::CSimulatedAircraft &remoteAircraft);
 
        void readyForModelMatching(const swift::misc::simulation::CSimulatedAircraft &renderedAircraft);
 
        void changedAtcStationsOnline();
 
        void changedAtcStationsOnlineDigest();
 
        void changedAircraftInRange();
 
        void changedAircraftInRangeDigest();
 
        void changedRemoteAircraftModel(const swift::misc::simulation::CSimulatedAircraft &aircraft,
                                        const swift::misc::CIdentifier &originator);
 
        void changedRemoteAircraftEnabled(const swift::misc::simulation::CSimulatedAircraft &aircraft);
 
        void changedFastPositionUpdates(const swift::misc::simulation::CSimulatedAircraft &aircraft);
 
        void changedGndFlagCapability(const swift::misc::simulation::CSimulatedAircraft &aircraft);
 
        void atcStationDisconnected(const swift::misc::aviation::CAtcStation &atcStation);
 
        void kicked(const QString &kickMessage);
 
        void severeNetworkError(const QString &errorMessage);
 
        void muteRequestReceived(bool mute);
 
        void connectionStatusChanged(const swift::misc::network::CConnectionStatus &from,
                                     const swift::misc::network::CConnectionStatus &to);
 
        void connectedServerChanged(const swift::misc::network::CServer &server);
 
        void textMessagesReceived(const swift::misc::network::CTextMessageList &textMessages);
 
        void supervisorTextMessageReceived(const swift::misc::network::CTextMessage &message);
 
        void textMessageSent(const swift::misc::network::CTextMessage &sentMessage);
 
    public slots:
        virtual swift::misc::aviation::CAtcStationList getAtcStationsOnline(bool recalculateDistance) const = 0;
 
        virtual swift::misc::aviation::CAtcStationList getClosestAtcStationsOnline(int number) const = 0;
 
        virtual swift::misc::simulation::CSimulatedAircraftList getAircraftInRange() const = 0;
 
        virtual swift::misc::aviation::CCallsignSet getAircraftInRangeCallsigns() const = 0;
 
        virtual swift::misc::simulation::CSimulatedAircraft
        getAircraftInRangeForCallsign(const swift::misc::aviation::CCallsign &callsign) const = 0;
 
        virtual int getAircraftInRangeCount() const = 0;
 
        virtual bool isAircraftInRange(const swift::misc::aviation::CCallsign &callsign) const = 0;
 
        virtual swift::misc::weather::CMetar
        getMetarForAirport(const swift::misc::aviation::CAirportIcaoCode &airportIcaoCode) const = 0;
 
        virtual swift::misc::aviation::CAtcStation
        getOnlineStationForCallsign(const swift::misc::aviation::CCallsign &callsign) const = 0;
 
        virtual swift::misc::aviation::CAtcStationList
        getOnlineStationsForFrequency(const swift::misc::physical_quantities::CFrequency &frequency) const = 0;
 
        virtual bool isOnlineStation(const swift::misc::aviation::CCallsign &callsign) const = 0;
 
        virtual swift::misc::network::CUserList getUsers() const = 0;
 
        virtual swift::misc::network::CUserList
        getUsersForCallsigns(const swift::misc::aviation::CCallsignSet &callsigns) const = 0;
 
        virtual swift::misc::network::CUser
        getUserForCallsign(const swift::misc::aviation::CCallsign &callsign) const = 0;
 
        virtual swift::misc::network::CClientList getClients() const = 0;
 
        virtual swift::misc::network::CClientList
        getClientsForCallsigns(const swift::misc::aviation::CCallsignSet &callsigns) const = 0;
 
        virtual bool setOtherClient(const swift::misc::network::CClient &client) = 0;
 
        virtual swift::misc::network::CServerList getVatsimFsdServers() const = 0;
 
        virtual void setFastPositionEnabledCallsigns(swift::misc::aviation::CCallsignSet &callsigns) = 0;
 
        virtual swift::misc::aviation::CCallsignSet getFastPositionEnabledCallsigns() const = 0;
 
        virtual swift::misc::CStatusMessage connectToNetwork(const swift::misc::network::CServer &server,
                                                             const QString &extraLiveryString, bool sendLivery,
                                                             const QString &extraModelString, bool sendModelString,
                                                             const swift::misc::aviation::CCallsign &partnerCallsign,
                                                             swift::misc::network::CLoginMode loginMode) = 0;
 
        virtual swift::misc::network::CServer getConnectedServer() const = 0;
 
        virtual swift::misc::network::CLoginMode getLoginMode() const = 0;
 
        QString getLoginModeAsString() const { return this->getLoginMode().toQString(); }
 
        virtual swift::misc::CStatusMessage disconnectFromNetwork() = 0;
 
        virtual bool isConnected() const = 0;
 
        virtual void sendTextMessages(const swift::misc::network::CTextMessageList &textMessages) = 0;
 
        virtual void sendFlightPlan(const swift::misc::aviation::CFlightPlan &flightPlan) = 0;
 
        virtual swift::misc::aviation::CFlightPlan
        loadFlightPlanFromNetwork(const swift::misc::aviation::CCallsign &callsign) const = 0;
 
        virtual void requestAircraftDataUpdates() = 0;
 
        virtual void requestAtisUpdates() = 0;
 
        virtual bool updateAircraftEnabled(const swift::misc::aviation::CCallsign &callsign,
                                           bool enabledForRendering) = 0;
 
        virtual bool setAircraftEnabledFlag(const swift::misc::aviation::CCallsign &callsign,
                                            bool enabledForRendering) = 0;
 
        virtual bool updateAircraftSupportingGndFLag(const swift::misc::aviation::CCallsign &callsign,
                                                     bool supportGndFlag) = 0;
 
        virtual bool updateAircraftModel(const swift::misc::aviation::CCallsign &callsign,
                                         const swift::misc::simulation::CAircraftModel &model,
                                         const swift::misc::CIdentifier &originator) = 0;
 
        virtual bool updateAircraftNetworkModel(const swift::misc::aviation::CCallsign &callsign,
                                                const swift::misc::simulation::CAircraftModel &model,
                                                const swift::misc::CIdentifier &originator) = 0;
 
        virtual bool updateFastPositionEnabled(const swift::misc::aviation::CCallsign &callsign,
                                               bool enableFastPositionSending) = 0;
 
        virtual int reInitializeAllAircraft() = 0;
 
        virtual swift::misc::CStatusMessageList
        getReverseLookupMessages(const swift::misc::aviation::CCallsign &callsign) const = 0;
 
        virtual swift::misc::simulation::ReverseLookupLogging isReverseLookupMessagesEnabled() const = 0;
 
        virtual void enableReverseLookupMessages(swift::misc::simulation::ReverseLookupLogging enable) = 0;
 
        virtual swift::misc::CStatusMessageList
        getAircraftPartsHistory(const swift::misc::aviation::CCallsign &callsign) const = 0;
 
        virtual swift::misc::aviation::CAircraftPartsList
        getRemoteAircraftParts(const swift::misc::aviation::CCallsign &callsign) const = 0;
 
        virtual bool isRemoteAircraftSupportingParts(const swift::misc::aviation::CCallsign &callsign) const = 0;
 
        virtual bool isAircraftPartsHistoryEnabled() const = 0;
 
        virtual void enableAircraftPartsHistory(bool enabled) = 0;
 
        virtual QString getNetworkStatistics(bool reset, const QString &separator) = 0;
 
        virtual bool setNetworkStatisticsEnable(bool enabled) = 0;
 
        virtual QStringList getNetworkPresetValues() const = 0;
 
        virtual swift::misc::aviation::CCallsign getPartnerCallsign() const = 0;
 
        // ------------------------ testing ------------------------
 
        virtual void testCreateDummyOnlineAtcStations(int number) = 0;
 
        virtual void testAddAircraftParts(const swift::misc::aviation::CCallsign &callsign,
                                          const swift::misc::aviation::CAircraftParts &parts, bool incremental) = 0;
 
        virtual void testReceivedTextMessages(const swift::misc::network::CTextMessageList &textMessages) = 0;
 
        virtual void testReceivedAtisMessage(const swift::misc::aviation::CCallsign &callsign,
                                             const swift::misc::aviation::CInformationMessage &msg) = 0;
 
        virtual void testRequestAircraftConfig(const swift::misc::aviation::CCallsign &callsign) = 0;
 
        virtual bool testAddAltitudeOffset(const swift::misc::aviation::CCallsign &callsign,
                                           const swift::misc::physical_quantities::CLength &offset =
                                               swift::misc::physical_quantities::CLength::null()) = 0;
 
    public:
        using RawFsdMessageReceivedSlot = std::function<void(const swift::misc::network::CRawFsdMessage &)>;
 
        virtual QMetaObject::Connection
        connectRawFsdMessageSignal(QObject *receiver, RawFsdMessageReceivedSlot rawFsdMessageReceivedSlot) = 0;
 
        static const QList<QCommandLineOption> &getCmdLineOptions();
 
#ifdef SWIFT_VATSIM_SUPPORT
        static bool getCmdLineClientIdAndKey(int &id, QString &key);
#endif
 
    protected:
        IContextNetwork(CCoreFacadeConfig::ContextMode mode, CCoreFacade *runtime) : IContext(mode, runtime) {}
    };
} // namespace swift::core::context
#endif // SWIFT_CORE_CONTEXT_CONTEXTNETWORK_H