sdrangel/plugins/feature/satellitetracker/satellitetracker.h

///////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2020-2022 Edouard Griffiths, F4EXB <f4exb06@gmail.com>          //
// Copyright (C) 2020 Kacper Michajłow <kasper93@gmail.com>                      //
// Copyright (C) 2021-2022 Jon Beniston, M7RCE <jon@beniston.com>                //
//                                                                               //
// This program is free software; you can redistribute it and/or modify          //
// it under the terms of the GNU General Public License as published by          //
// the Free Software Foundation as version 3 of the License, or                  //
// (at your option) any later version.                                           //
//                                                                               //
// This program is distributed in the hope that it will be useful,               //
// but WITHOUT ANY WARRANTY; without even the implied warranty of                //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                  //
// GNU General Public License V3 for more details.                               //
//                                                                               //
// You should have received a copy of the GNU General Public License             //
// along with this program. If not, see <http://www.gnu.org/licenses/>.          //
///////////////////////////////////////////////////////////////////////////////////

#ifndef INCLUDE_FEATURE_SATELLITETRACKER_H_
#define INCLUDE_FEATURE_SATELLITETRACKER_H_

#include <QThread>
#include <QNetworkRequest>

#include "feature/feature.h"
#include "util/message.h"
#include "util/httpdownloadmanager.h"

#include "satellitetrackersettings.h"
#include "satnogs.h"
#include "satellitetrackersgp4.h"

class WebAPIAdapterInterface;
class SatelliteTrackerWorker;
class QNetworkAccessManager;
class QNetworkReply;

namespace SWGSDRangel {
    class SWGDeviceState;
    class SWGSatelliteDeviceSettingsList;
}

class SatelliteTracker : public Feature
{
	Q_OBJECT
public:
    class MsgConfigureSatelliteTracker : public Message {
        MESSAGE_CLASS_DECLARATION

    public:
        const SatelliteTrackerSettings& getSettings() const { return m_settings; }
        const QList<QString>& getSettingsKeys() const { return m_settingsKeys; }
        bool getForce() const { return m_force; }

        static MsgConfigureSatelliteTracker* create(const SatelliteTrackerSettings& settings, const QList<QString>& settingsKeys, bool force) {
            return new MsgConfigureSatelliteTracker(settings, settingsKeys, force);
        }

    private:
        SatelliteTrackerSettings m_settings;
        QList<QString> m_settingsKeys;
        bool m_force;

        MsgConfigureSatelliteTracker(const SatelliteTrackerSettings& settings, const QList<QString>& settingsKeys, bool force) :
            Message(),
            m_settings(settings),
            m_settingsKeys(settingsKeys),
            m_force(force)
        { }
    };

    class MsgStartStop : public Message {
        MESSAGE_CLASS_DECLARATION

    public:
        bool getStartStop() const { return m_startStop; }

        static MsgStartStop* create(bool startStop) {
            return new MsgStartStop(startStop);
        }

    protected:
        bool m_startStop;

        MsgStartStop(bool startStop) :
            Message(),
            m_startStop(startStop)
        { }
    };

    class MsgUpdateSatData : public Message {
        MESSAGE_CLASS_DECLARATION

    public:

        static MsgUpdateSatData* create() {
            return new MsgUpdateSatData();
        }

    private:

        MsgUpdateSatData() :
            Message()
        { }
    };

    class MsgSatData : public Message {
        MESSAGE_CLASS_DECLARATION

    public:
        QHash<QString, SatNogsSatellite *> getSatellites() { return m_satellites; }

        static MsgSatData* create(QHash<QString, SatNogsSatellite *> satellites) {
            return new MsgSatData(satellites);
        }

    private:
        QHash<QString, SatNogsSatellite *> m_satellites;

        MsgSatData(QHash<QString, SatNogsSatellite *> satellites) :
            Message(),
            m_satellites(satellites)
        { }
    };

    class MsgError : public Message {
        MESSAGE_CLASS_DECLARATION

    public:
        QString getError() { return m_error; }

        static MsgError* create(const QString& error) {
            return new MsgError(error);
        }

    private:
        QString m_error;

        MsgError(const QString& error) :
            Message(),
            m_error(error)
        { }
    };

    SatelliteTracker(WebAPIAdapterInterface *webAPIAdapterInterface);
    virtual ~SatelliteTracker();
    virtual void destroy() { delete this; }
    virtual bool handleMessage(const Message& cmd);

    virtual void getIdentifier(QString& id) const { id = objectName(); }
    virtual QString getIdentifier() const { return objectName(); }
    virtual void getTitle(QString& title) const { title = m_settings.m_title; }

    virtual QByteArray serialize() const;
    virtual bool deserialize(const QByteArray& data);

    virtual int webapiRun(bool run,
            SWGSDRangel::SWGDeviceState& response,
            QString& errorMessage);

    virtual int webapiSettingsGet(
            SWGSDRangel::SWGFeatureSettings& response,
            QString& errorMessage);

    virtual int webapiSettingsPutPatch(
            bool force,
            const QStringList& featureSettingsKeys,
            SWGSDRangel::SWGFeatureSettings& response,
            QString& errorMessage);

    virtual int webapiReportGet(
            SWGSDRangel::SWGFeatureReport& response,
            QString& errorMessage);

    virtual int webapiActionsPost(
            const QStringList& featureActionsKeys,
            SWGSDRangel::SWGFeatureActions& query,
            QString& errorMessage);

    static void webapiFormatFeatureSettings(
        SWGSDRangel::SWGFeatureSettings& response,
        const SatelliteTrackerSettings& settings);

    static void webapiUpdateFeatureSettings(
            SatelliteTrackerSettings& settings,
            const QStringList& featureSettingsKeys,
            SWGSDRangel::SWGFeatureSettings& response);

    QDateTime currentDateTimeUtc();
    QDateTime currentDateTime();

    static const char* const m_featureIdURI;
    static const char* const m_featureId;

    bool isUpdatingSatData() { return m_updatingSatData; }

private:
    QThread *m_thread;
    SatelliteTrackerWorker *m_worker;
    SatelliteTrackerSettings m_settings;

    QNetworkAccessManager *m_networkManager;
    QNetworkRequest m_networkRequest;
    HttpDownloadManager m_dlm;
    bool m_updatingSatData;
    int m_tleIndex;
    QMutex m_mutex;

    QHash<QString, SatNogsSatellite *> m_satellites;    // Satellites, hashed on name
    QHash<int, SatNogsSatellite *> m_satellitesId;      // Same data as m_satellites, but hashed on id, rather than name
    bool m_firstUpdateSatData;

    QDateTime m_startedDateTime;

    QHash<QString, SatelliteState *> m_satState;

    void start();
    void stop();
    void applySettings(const SatelliteTrackerSettings& settings, const QList<QString>& settingsKeys, bool force = false);
    void webapiFormatFeatureReport(SWGSDRangel::SWGFeatureReport& response);
    void webapiReverseSendSettings(const QList<QString>& featureSettingsKeys, const SatelliteTrackerSettings& settings, bool force);

    QString satNogsSatellitesFilename();
    QString satNogsTransmittersFilename();
    QString satNogsTLEFilename();
    QString tleURLToFilename(const QString& string);
    bool parseSatellites(const QByteArray& json);
    bool parseTransmitters(const QByteArray& json);
    bool parseSatNogsTLEs(const QByteArray& json);
    bool parseTxtTLEs(const QByteArray& txt);
    bool readSatData();
    void updateSatData();
    void updateSatellitesReply(QNetworkReply *reply);
    void updateTransmittersReply(QNetworkReply *reply);
    void updateTLEsReply(QNetworkReply *reply);
    static QList<SWGSDRangel::SWGSatelliteDeviceSettingsList*>* getSWGSatelliteDeviceSettingsList(const SatelliteTrackerSettings& settings);
    static QHash<QString, QList<SatelliteTrackerSettings::SatelliteDeviceSettings *> *> getSatelliteDeviceSettings(QList<SWGSDRangel::SWGSatelliteDeviceSettingsList*>* list);

private slots:
    void networkManagerFinished(QNetworkReply *reply);
    void downloadFinished(const QString& filename, bool success, const QString& url, const QString& error);
};

#endif // INCLUDE_FEATURE_SATELLITETRACKER_H_