mirror of
https://github.com/swift-project/pilotclient.git
synced 2026-03-31 21:15:33 +08:00
310 lines
17 KiB
C++
310 lines
17 KiB
C++
/* Copyright (C) 2013
|
|
* 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_VATSIM_NETWORK_VATLIB_H
|
|
#define BLACKCORE_VATSIM_NETWORK_VATLIB_H
|
|
|
|
#include "blackcore/blackcoreexport.h"
|
|
#include "blackcore/network.h"
|
|
#include "blackcore/vatsim/vatsimsettings.h"
|
|
#include "blackmisc/simulation/simulatorplugininfo.h"
|
|
#include "blackmisc/network/server.h"
|
|
#include "blackmisc/network/fsdsetup.h"
|
|
#include "blackmisc/network/textmessagelist.h"
|
|
#include "blackmisc/aviation/aircrafticaocode.h"
|
|
#include "blackmisc/aviation/aircraftparts.h"
|
|
#include "blackmisc/aviation/airlineicaocode.h"
|
|
#include "blackmisc/aviation/airporticaocode.h"
|
|
#include "blackmisc/aviation/callsign.h"
|
|
#include "blackmisc/aviation/callsignset.h"
|
|
#include "blackmisc/tokenbucket.h"
|
|
#include "blackmisc/settingscache.h"
|
|
#include "blackmisc/digestsignal.h"
|
|
|
|
#include <stdbool.h>
|
|
#include <vatlib/vatlib.h>
|
|
#include <QByteArray>
|
|
#include <QFile>
|
|
#include <QJsonObject>
|
|
#include <QList>
|
|
#include <QObject>
|
|
#include <QScopedPointer>
|
|
#include <QString>
|
|
#include <QStringList>
|
|
#include <QTimer>
|
|
#include <QTextCodec>
|
|
#include <functional>
|
|
|
|
class QCommandLineOption;
|
|
|
|
namespace BlackMisc
|
|
{
|
|
namespace Aviation { class CFlightPlan; }
|
|
namespace Simulation { class CSimulatedAircraft; }
|
|
}
|
|
|
|
namespace BlackCore
|
|
{
|
|
namespace Vatsim
|
|
{
|
|
//! Implementation of INetwork using the vatlib shim
|
|
class BLACKCORE_EXPORT CNetworkVatlib : public INetwork
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
//! Log. categories
|
|
static const BlackMisc::CLogCategoryList &getLogCategories();
|
|
|
|
//! Constructor
|
|
CNetworkVatlib(
|
|
BlackMisc::Network::IClientProvider *clientProvider,
|
|
BlackMisc::Simulation::IOwnAircraftProvider *ownAircraftProvider,
|
|
QObject *parent = nullptr);
|
|
|
|
//! Destructor
|
|
virtual ~CNetworkVatlib() override;
|
|
|
|
//! \copydoc INetwork::getLibraryInfo
|
|
const QString &getLibraryInfo(bool detailed) const override;
|
|
|
|
//! \name Network functions
|
|
//! @{
|
|
virtual bool isConnected() const override { return m_status == vatStatusConnected; }
|
|
virtual const BlackMisc::Network::CServer &getPresetServer() const override { return m_server; }
|
|
virtual bool isPendingConnection() const override { return m_status == vatStatusConnecting; }
|
|
virtual void presetLoginMode(LoginMode mode) override;
|
|
virtual void presetServer(const BlackMisc::Network::CServer &server) override;
|
|
virtual void presetCallsign(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
virtual void presetIcaoCodes(const BlackMisc::Simulation::CSimulatedAircraft &ownAircraft) override;
|
|
virtual void presetSimulatorInfo(const BlackMisc::Simulation::CSimulatorPluginInfo &simInfo) override;
|
|
virtual void initiateConnection() override;
|
|
virtual void terminateConnection() override;
|
|
virtual void sendPing(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
virtual void sendRealNameQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
virtual void sendIpQuery() override;
|
|
virtual void sendServerQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
virtual void sendCustomFsinnQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
virtual void sendCustomFsinnReponse(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
virtual void broadcastAircraftConfig(const QJsonObject &config) override;
|
|
virtual void sendAircraftConfigQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
//! @}
|
|
|
|
//! \name Text message functions
|
|
//! @{
|
|
virtual void sendTextMessages(const BlackMisc::Network::CTextMessageList &messages) override;
|
|
virtual void sendWallopMessage(const QString &message) override;
|
|
//! @}
|
|
|
|
//! \name ATC functions
|
|
//! @{
|
|
virtual void sendAtcQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
virtual void sendAtisQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
virtual void sendFlightPlan(const BlackMisc::Aviation::CFlightPlan &flightPlan) override;
|
|
virtual void sendFlightPlanQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
//! @}
|
|
|
|
//! \name Aircraft functions
|
|
//! @{
|
|
virtual void sendCapabilitiesQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
virtual void sendIcaoCodesQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
virtual void sendFrequencyQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
virtual void sendUserInfoQuery(const BlackMisc::Aviation::CCallsign &callsign) override;
|
|
virtual void setInterimPositionReceivers(const BlackMisc::Aviation::CCallsignSet &receivers) override;
|
|
virtual const BlackMisc::Aviation::CCallsignSet &getInterimPositionReceivers() const override;
|
|
//! @}
|
|
|
|
//! Arguments to be passed to another swift appplication
|
|
static QStringList vatlibArguments();
|
|
|
|
//! \name Weather functions
|
|
//! @{
|
|
virtual void sendMetarQuery(const BlackMisc::Aviation::CAirportIcaoCode &airportIcao) override;
|
|
//! @}
|
|
|
|
//! Command line options this library can handle
|
|
static const QList<QCommandLineOption> &getCmdLineOptions();
|
|
|
|
private:
|
|
static int constexpr c_processingIntervalMsec = 100; //!< interval for the processing timer
|
|
static int constexpr c_updatePostionIntervalMsec = 5000; //!< interval for the position update timer (send our position to network)
|
|
static int constexpr c_updateInterimPostionIntervalMsec = 1000; //!< interval for iterim position updates (send our position as interim position)
|
|
|
|
static bool getCmdLineClientIdAndKey(int &id, QString &key);
|
|
|
|
void replyToFrequencyQuery(const BlackMisc::Aviation::CCallsign &callsign);
|
|
void replyToNameQuery(const BlackMisc::Aviation::CCallsign &callsign);
|
|
void replyToConfigQuery(const BlackMisc::Aviation::CCallsign &callsign);
|
|
void sendAircraftInfo(const BlackMisc::Aviation::CCallsign &callsign);
|
|
void sendIncrementalAircraftConfig();
|
|
|
|
//! \name VATLIB callbacks
|
|
//! @{
|
|
static void onConnectionStatusChanged(VatFsdClient *, VatConnectionStatus oldStatus, VatConnectionStatus newStatus, void *cbvar);
|
|
static void onTextMessageReceived(VatFsdClient *, const char *from, const char *to, const char *msg, void *cbvar);
|
|
static void onRadioMessageReceived(VatFsdClient *, const char *from, unsigned int freqCount, int *freqList, const char *message, void *cbvar);
|
|
static void onControllerDisconnected(VatFsdClient *, const char *callsign, void *cbvar);
|
|
static void onInterimPilotPositionUpdate(VatFsdClient *, const char *sender, const VatInterimPilotPosition *position, void *cbvar);
|
|
static void onAtcPositionUpdate(VatFsdClient *, const char *callsign, const VatAtcPosition *pos, void *cbvar);
|
|
static void onKicked(VatFsdClient *, const char *reason, void *cbvar);
|
|
static void onPong(VatFsdClient *, const char *sender, double elapsedTime, void *cbvar);
|
|
static void onMetarReceived(VatFsdClient *, const char *data, void *cbvar);
|
|
static void onInfoQueryRequestReceived(VatFsdClient *, const char *callsign, VatClientQueryType type, const char *data, void *cbvar);
|
|
static void onInfoQueryReplyReceived(VatFsdClient *, const char *callsign, VatClientQueryType type, const char *data, const char *data2, void *cbvar);
|
|
static void onCapabilitiesReplyReceived(VatFsdClient *, const char *callsign, int capabilityFlags, void *cbvar);
|
|
static void onAtisReplyReceived(VatFsdClient *, const char *callsign, const VatControllerAtis *atis, void *cbvar);
|
|
static void onFlightPlanReceived(VatFsdClient *, const char *callsign, const VatFlightPlan *fp, void *cbvar);
|
|
static void onErrorReceived(VatFsdClient *, VatServerError error, const char *msg, const char *data, void *cbvar);
|
|
static void onPilotDisconnected(VatFsdClient *, const char *callsign, void *cbvar);
|
|
static void onPilotInfoRequestReceived(VatFsdClient *, const char *callsign, void *cbvar);
|
|
static void onPilotInfoReceived(VatFsdClient *, const char *callsign, const VatAircraftInfo *aircraftInfo, void *cbvar);
|
|
static void onPilotPositionUpdate(VatFsdClient *, const char *callsign, const VatPilotPosition *position, void *cbvar);
|
|
static void onAircraftConfigReceived(VatFsdClient *, const char *callsign, const char *aircraftConfig, void *cbvar);
|
|
static void onCustomPacketReceived(VatFsdClient *, const char *callsign, const char *packetId, const char **data, int dataSize, void *cbvar);
|
|
static void onRawFsdMessage(VatFsdClient *, const char *message, void *cbvar);
|
|
//! @}
|
|
|
|
QByteArray toFSDnoColon(const QString &qstr) const;
|
|
QByteArray toFSD(const QString &qstr) const;
|
|
QByteArray toFSD(const BlackMisc::Aviation::CCallsign &callsign) const;
|
|
std::function<const char **()> toFSD(const QStringList &qstrList) const;
|
|
QString fromFSD(const char *cstr) const;
|
|
QString getNetworkHostApplicationString() const; //!< simulator version and details info string
|
|
QStringList fromFSD(const char **cstrArray, int size) const;
|
|
bool isInterimPositionSendingEnabledForServer() const;
|
|
bool isInterimPositionReceivingEnabledForServer() const;
|
|
const BlackMisc::Network::CFsdSetup &getSetupForServer() const;
|
|
void startPositionTimers();
|
|
void stopPositionTimers();
|
|
void initializeSession();
|
|
void changeConnectionStatus(VatConnectionStatus newStatus);
|
|
bool isDisconnected() const { return m_status != vatStatusConnecting && m_status != vatStatusConnected; }
|
|
static QString convertToUnicodeEscaped(const QString &str);
|
|
static VatSimType convertToSimType(BlackMisc::Simulation::CSimulatorPluginInfo &simInfo);
|
|
static void networkLogHandler(VatSeverityLevel severity, const char *context, const char *message);
|
|
static QString simplifyTextMessage(const QString &msg);
|
|
void sendCustomPacket(const BlackMisc::Aviation::CCallsign &callsign, const QString &packetId, const QStringList &data);
|
|
|
|
//! Default model string
|
|
static const QString &defaultModelString()
|
|
{
|
|
static const QString dm("Cessna Skyhawk 172SP");
|
|
return dm;
|
|
}
|
|
|
|
//! Send if no model string is available
|
|
static const QString &noModelString()
|
|
{
|
|
static const QString noms("swift empty string");
|
|
return noms;
|
|
}
|
|
|
|
struct JsonPackets
|
|
{
|
|
static const QJsonObject &aircraftConfigRequest();
|
|
};
|
|
|
|
void process();
|
|
void sendPositionUpdate();
|
|
void sendInterimPositions();
|
|
void customPacketDispatcher(const BlackMisc::Aviation::CCallsign &callsign, const QString &packetId, const QStringList &data);
|
|
void handleRawFsdMessage(const QString &fsdMessage);
|
|
void fsdMessageSettingsChanged();
|
|
|
|
signals:
|
|
void terminate(); //!< \private
|
|
|
|
private:
|
|
//! Consolidate text messages if we receive multiple messages which belong together
|
|
//! \remark causes a slight delay
|
|
void consolidateTextMessage(const BlackMisc::Network::CTextMessage &textMessage);
|
|
|
|
//! Send the consolidatedTextMessages
|
|
void emitConsolidatedTextMessages();
|
|
|
|
//! Handles ATIS replies from non-VATSIM servers. If the conditions are not met, the message is
|
|
//! released as normal text message.
|
|
void maybeHandleAtisReply(const BlackMisc::Aviation::CCallsign &sender, const BlackMisc::Aviation::CCallsign &receiver, const QString &message);
|
|
|
|
//! Remember when last position was received
|
|
qint64 receivedPositionFixTsAndGetOffsetTime(const BlackMisc::Aviation::CCallsign &callsign, qint64 markerTs = -1);
|
|
|
|
//! Current offset time
|
|
qint64 currentOffsetTime(const BlackMisc::Aviation::CCallsign &callsign) const;
|
|
|
|
//! Clear state when connection is terminated
|
|
void clearState();
|
|
|
|
//! Clear state for callsign
|
|
void clearState(const BlackMisc::Aviation::CCallsign &callsign);
|
|
|
|
//! Insert as first value
|
|
void insertLatestOffsetTime(const BlackMisc::Aviation::CCallsign &callsign, qint64 offsetMs);
|
|
|
|
//! Average offset time in ms
|
|
qint64 averageOffsetTimeMs(const BlackMisc::Aviation::CCallsign &callsign, int &count, int maxLastValues = MaxOffseTimes) const;
|
|
|
|
//! Average offset time in ms
|
|
qint64 averageOffsetTimeMs(const BlackMisc::Aviation::CCallsign &callsign, int maxLastValues = MaxOffseTimes) const;
|
|
|
|
//! Remove colon
|
|
static QString removeColon(const QString &candidate);
|
|
|
|
//! Deletion policy for QScopedPointer
|
|
struct VatFsdClientDeleter
|
|
{
|
|
//! Called by QScopedPointer destructor
|
|
static void cleanup(VatFsdClient *session) { if (session) Vat_DestroyNetworkSession(session); }
|
|
};
|
|
|
|
QScopedPointer<VatFsdClient, VatFsdClientDeleter> m_net;
|
|
LoginMode m_loginMode;
|
|
VatConnectionStatus m_status;
|
|
BlackMisc::Network::CServer m_server;
|
|
QTextCodec *m_fsdTextCodec = nullptr;
|
|
BlackMisc::Simulation::CSimulatorPluginInfo m_simulatorInfo; //!< used simulator
|
|
BlackMisc::Aviation::CCallsign m_ownCallsign; //!< "buffered callsign", as this must not change when connected
|
|
BlackMisc::Aviation::CAircraftIcaoCode m_ownAircraftIcaoCode; //!< "buffered icao", as this must not change when connected
|
|
BlackMisc::Aviation::CAirlineIcaoCode m_ownAirlineIcaoCode; //!< "buffered icao", as this must not change when connected
|
|
QString m_ownLiveryDescription; //!< "buffered livery", as this must not change when connected
|
|
BlackMisc::Aviation::CCallsignSet m_interimPositionReceivers; //!< all aircraft receiving interim positions
|
|
BlackMisc::Aviation::CAircraftParts m_sentAircraftConfig; //!< aircraft parts sent
|
|
BlackMisc::CTokenBucket m_tokenBucket; //!< used with aircraft parts messages
|
|
|
|
BlackMisc::CDigestSignal m_dsSendTextMessage { this, &CNetworkVatlib::emitConsolidatedTextMessages, 500, 10 };
|
|
BlackMisc::Network::CTextMessageList m_textMessagesToConsolidate;
|
|
|
|
QTimer m_scheduledConfigUpdate;
|
|
QTimer m_processingTimer;
|
|
QTimer m_positionUpdateTimer; //!< sending positions
|
|
QTimer m_interimPositionUpdateTimer; //!< sending interim positions
|
|
|
|
//! Pending ATIS query since
|
|
struct PendingAtisQuery
|
|
{
|
|
QDateTime m_queryTime = QDateTime::currentDateTimeUtc();
|
|
QStringList m_atisMessage;
|
|
};
|
|
|
|
QHash<BlackMisc::Aviation::CCallsign, PendingAtisQuery> m_pendingAtisQueries;
|
|
QHash<BlackMisc::Aviation::CCallsign, qint64> m_lastPositionUpdate;
|
|
QHash<BlackMisc::Aviation::CCallsign, QList<qint64>> m_lastOffsetTimes; //!< latest offset first
|
|
|
|
static const int MaxOffseTimes = 6; //!< Max offset times kept
|
|
|
|
BlackMisc::CSettingReadOnly<BlackCore::Vatsim::TRawFsdMessageSetting> m_fsdMessageSetting { this, &CNetworkVatlib::fsdMessageSettingsChanged };
|
|
QFile m_rawFsdMessageLogFile;
|
|
bool m_rawFsdMessagesEnabled = false;
|
|
bool m_filterPasswordFromLogin = false;
|
|
};
|
|
} //namespace
|
|
} //namespace
|
|
#endif // guard
|