NOTAMProvider.h

/***************************************************************************
 *   Copyright (C) 2023-2024 by Stefan Kebekus                             *
 *   stefan.kebekus@gmail.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; either 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 for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#pragma once
 
#include <QBindable>
#include <QNetworkReply>
#include <QQmlEngine>
#include <QStandardPaths>
 
#include "GlobalObject.h"
#include "notam/NOTAMList.h"
 
using namespace Qt::Literals::StringLiterals;
 
 
namespace NOTAM {

 
class NOTAMProvider : public GlobalObject {
    Q_OBJECT
    QML_ELEMENT
    QML_SINGLETON
 
public:
    explicit NOTAMProvider(QObject* parent = nullptr);
 
    // deferred initialization
    void deferredInitialization() override;
 
    // No default constructor, important for QML singleton
    explicit NOTAMProvider() = delete;

    ~NOTAMProvider() override;
 
    // factory function for QML singleton
    static NOTAMProvider* create(QQmlEngine* /*unused*/, QJSEngine* /*unused*/)
    {
        return GlobalObject::notamProvider();
    }
 
    // NOTAM data is considered to cover a given point if the data covers a
    // circle of radius minimumRadiusPoint around that point.
    static constexpr Units::Distance minimumRadiusPoint = Units::Distance::fromNM(20.0);
 
    // NOTAM data is considered to cover the flight route if it covers a region of at least
    // minimumRadiusFlightRoute around the route
    static constexpr Units::Distance minimumRadiusFlightRoute = Units::Distance::fromNM(3.0);
 
 
    //
    // Properties
    //

    Q_PROPERTY(QByteArray geoJSON READ geoJSON BINDABLE bindableGeoJSON)
 
    
    Q_PROPERTY(QDateTime lastUpdate READ lastUpdate BINDABLE bindableLastUpdate)

    Q_PROPERTY(QString status READ status BINDABLE bindableStatus)
 
 
    //
    // Getter Methods
    //

    Q_REQUIRED_RESULT QByteArray geoJSON() const {return m_geoJSON.value();}

    Q_REQUIRED_RESULT QBindable<QByteArray> bindableGeoJSON() const {return &m_geoJSON;}

    Q_REQUIRED_RESULT QDateTime lastUpdate() const {return {m_lastUpdate};}

    Q_REQUIRED_RESULT QBindable<QDateTime> bindableLastUpdate() const {return &m_lastUpdate;}

    Q_REQUIRED_RESULT QString status() const {return {m_status};}

    Q_REQUIRED_RESULT QBindable<QString> bindableStatus() const {return &m_status;}
 
 
    //
    // Methods
    //
 

    Q_REQUIRED_RESULT Q_INVOKABLE NOTAMList notams(const GeoMaps::Waypoint& waypoint);

    Q_REQUIRED_RESULT Q_INVOKABLE bool isRead(const QString& number) const { return m_readNotamNumbers.contains(number); }

    Q_INVOKABLE void setRead(const QString& number, bool read);
 
private:
 
 
private:
    Q_DISABLE_COPY_MOVE(NOTAMProvider)
 
 
    //
    // Private Methods
    //
 
    // Removes outdated NOTAMs and outdated NOTAMLists.
    Q_REQUIRED_RESULT static QList<NOTAMList> cleaned(const QList<NOTAMList>& notamLists, const QSet<QString>& cancelledNotams = {});
 
    // This method reads the incoming data from network replies and adds it to
    // the database. It cleans up the list of network replies in
    // m_networkReplies. On error, it requests a call to updateData in five
    // minutes. This method is connected to signals QNetworkReply::finished and
    // QNetworkReply::errorOccurred of the QNetworkReply contained in the list
    // in m_networkReply.
    void downloadFinished();
 
    // Check if current NOTAM data exists for a circle of radius minimalRadius
    // around position. This method ignores outdated NOTAM data. An invalid
    // position is always considered to be covered.
    //
    // includeDataThatNeedsUpdate: If true, then also count NOTAM lists that
    // need an update as NOTAM data
    //
    // includeRunningDownloads: If true, then also count running downloads as
    // NOTAM data
    Q_REQUIRED_RESULT bool hasDataForPosition(const QGeoCoordinate& position, bool includeDataThatNeedsUpdate, bool includeRunningDownloads) const;
 
    // Save NOTAM data to a file, using the filename found in m_stdFileName.
    // There are no error checks of any kind. The propertyNotifier ensures that
    // the method save() is called whenever m_notamLists changes.
    void save() const;
    QPropertyNotifier m_saveNotifier;
 
    // Request NOTAM data from the FAA, for a circle of radius requestRadius
    // around the coordinate.  For performance reasons, the request will be
    // ignored if existing NOTAM data or ongoing download requests cover the
    // position alreads.
    void startRequest(const QGeoCoordinate& coordinate);
 
    // Checks if NOTAM data is available for an area of marginRadius around the
    // current position and around the current flight route. If not, requests
    // the data.
    void updateData();
 
 
    //
    // Private Members and Member Computing Methods
    //
 
    // List with numbers of notams that have been marked as read
    QList<QString> m_readNotamNumbers;
 
    // List of pending network requests
    QList<QPointer<QNetworkReply>> m_networkReplies;
 
    // List of NOTAMLists, sorted so that newest lists come first
    QProperty<QList<NOTAMList>> m_notamLists;
 
    // This is a list of control points.  The computing function guarantees that
    // the NOTAM data covers a region of at least marginRadiusFlightRoute around
    // the route if the data covers a circle of radius marginRadius around every
    // control point point. Exeption: For performance reasons, this guarantee is
    // lifted if the flight route contains a leg of size >
    // maximumFlightRouteLegLength.
    QProperty<QList<QGeoCoordinate>> m_controlPoints4FlightRoute;
    Q_REQUIRED_RESULT static QList<QGeoCoordinate> computeControlPoints4FlightRoute();
 
    // GeoJSON, for use in map
    QProperty<QByteArray> m_geoJSON;
    Q_REQUIRED_RESULT QByteArray computeGeoJSON() const;
 
    // Time of last update to data
    QProperty<QDateTime> m_lastUpdate;
    Q_REQUIRED_RESULT QDateTime computeLastUpdate() const;
 
    // Filename for loading/saving NOTAM data
    QProperty<QString> m_status;
    Q_REQUIRED_RESULT QString computeStatus() const;
 
    // Filename for loading/saving NOTAM data
    QString m_stdFileName { QStandardPaths::writableLocation(QStandardPaths::AppDataLocation)+u"/notam.dat"_s };
 
    // NOTAM data is considered to cover the flight route if it covers a region
    // of at least marginRadiusFlightRoute around the route
    static constexpr Units::Distance maximumFlightRouteLegLength = Units::Distance::fromNM(200.0);
 
    // Requests for Notam data are requestRadius around given position. This is
    // the maximum that FAA API currently allows (FAA max is 100NM)
    static constexpr Units::Distance requestRadius = Units::Distance::fromNM(99.0);
};
 
} // namespace NOTAM