File indexing completed on 2024-05-12 04:42:47

 /*
     SPDX-FileCopyrightText: 2020 Volker Krause <vkrause@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef KPUBLICTRANSPORT_GBFSJOB_H
 #define KPUBLICTRANSPORT_GBFSJOB_H
 
 #include "kpublictransport_export.h"
 #include "gbfsservice.h"
 #include "gbfsstore.h"
 
 #include <QJsonArray>
 #include <QJsonDocument>
 #include <QObject>
 #include <QRectF>
 #include <QUrl>
 
 class QNetworkAccessManager;
 class QNetworkReply;
 
 namespace KPublicTransport {
 
 /** GBFS fetch job.
  *  @internal exported for testing only
  *  @see https://github.com/NABSA/gbfs/blob/master/gbfs.md
  */
 class KPUBLICTRANSPORT_EXPORT GBFSJob : public QObject
 {
     Q_OBJECT
 public:
     explicit GBFSJob(QNetworkAccessManager *nam, QObject *parent = nullptr);
     ~GBFSJob() override;
 
     /** Perform GBFS auto-discovery based on the given @p url and update the local state as far as necessary. */
     void discoverAndUpdate(const GBFSService &service);
 
     /** Define which data elements to fetch. */
     void setRequestedData(std::vector<GBFS::FileType> &&fileTypes);
 
     /** The service that is updated, or which has been discovered. */
     GBFSService service() const;
 
     enum Error {
         NoError,
         NetworkError,
         TooManyRequestsError, ///< API endpoint call limit, try again later
         DataError,
     };
     Error error() const;
     QString errorMessage() const;
 
 Q_SIGNALS:
     /** Emitted when the discovery and/or update process has finished.
      *  This can be immediately (if everything is still up to date).
      */
     void finished();
 
 private:
     void discoverFinished(QNetworkReply *reply);
     void parseDiscoverData();
     void processFeeds();
     void fetchFinished(QNetworkReply *reply, GBFS::FileType type);
     void handleNetworkError(QNetworkReply *reply);
     void parseData(const QJsonDocument &doc, GBFS::FileType type);
     void parseSystemInformation(const QJsonDocument &doc);
     void parseStationInformation(const QJsonDocument &doc);
     void parseFreeBikeStatus(const QJsonDocument &doc);
     void collectCoordinates(const QJsonArray &array);
     void parseVersionData(const QJsonDocument &doc);
     void parseGeofencingZones(const QJsonDocument &doc);
     void finalize();
     bool shouldFetchFile(GBFS::FileType fileType) const;
 
     enum class State {
         Discover,
         Version,
         DiscoverRestart,
         SystemInformation,
         Data
     };
     State m_state = State::Discover;
 
     QNetworkAccessManager *m_nam = nullptr;
     GBFSService m_service;
     QUrl m_previousDiscoveryUrl;
     GBFSStore m_store;
     QJsonDocument m_discoverDoc;
     QJsonDocument m_versionDoc;
     QJsonArray m_feeds;
 
     std::vector<GBFS::FileType> m_fileTypes;
 
     std::vector<double> m_latitudes;
     std::vector<double> m_longitudes;
 
     QString m_errorMsg;
     Error m_error = NoError;
     int m_pendingJobs = 0;
 };
 
 }
 
 #endif // KPUBLICTRANSPORT_GBFSJOB_H