/******************************************************************************

 *

 * Project:  PlanetLabs scene driver

 * Purpose:  PLScenes driver interface

 * Author:   Even Rouault, even dot rouault at spatialys.com

 *

 ******************************************************************************

 * Copyright (c) 2015, Planet Labs

 *

 * SPDX-License-Identifier: MIT

 ****************************************************************************/

#ifndef OGR_PLSCENES_H_INCLUDED

#define OGR_PLSCENES_H_INCLUDED

#include "gdal_priv.h"

#include "ogrsf_frmts.h"

#include "ogr_srs_api.h"

#include "cpl_http.h"

#include "ogrlibjsonutils.h"

#include "ogr_swq.h"

#include <map>

#include <set>

#include <vector>

class OGRPLScenesDataV1Layer;

class OGRPLScenesDataV1Dataset final : public GDALDataset

{

    mutable bool m_bLayerListInitialized;

    bool m_bMustCleanPersistent;

    CPLString m_osBaseURL;

    CPLString m_osAPIKey;

    CPLString m_osNextItemTypesPageURL;

    CPLString m_osFilter;

    int m_nLayers;

    OGRPLScenesDataV1Layer **m_papoLayers;

    bool m_bFollowLinks;

    char **GetBaseHTTPOptions();

    OGRLayer *ParseItemType(json_object *poItemType);

    bool ParseItemTypes(json_object *poObj, CPLString &osNext);

    void EstablishLayerList();

    GDALDataset *OpenRasterScene(GDALOpenInfo *poOpenInfo, CPLString osScene,

                                 CSLConstList papszOptions);

    CPLString InsertAPIKeyInURL(CPLString osURL);

  public:

    OGRPLScenesDataV1Dataset();

    ~OGRPLScenesDataV1Dataset() override;

    int GetLayerCount() const override;

    using GDALDataset::GetLayer;

    const OGRLayer *GetLayer(int idx) const override;

    OGRLayer *GetLayerByName(const char *pszName) override;

    json_object *RunRequest(const char *pszURL, int bQuiet404Error = FALSE,

                            const char *pszHTTPVerb = "GET",

                            bool bExpectJSonReturn = true,

                            const char *pszPostContent = nullptr);

    bool DoesFollowLinks() const

    {

        return m_bFollowLinks;

    }

    const CPLString &GetFilter() const

    {

        return m_osFilter;

    }

    const CPLString &GetBaseURL() const

    {

        return m_osBaseURL;

    }

    static GDALDataset *Open(GDALOpenInfo *poOpenInfo);

};

class OGRPLScenesDataV1FeatureDefn final : public OGRFeatureDefn

{

    OGRPLScenesDataV1Layer *m_poLayer;

  public:

    OGRPLScenesDataV1FeatureDefn(OGRPLScenesDataV1Layer *poLayer,

                                 const char *pszName)

        : OGRFeatureDefn(pszName), m_poLayer(poLayer)

    {

    }

    int GetFieldCount() const override;

    void DropRefToLayer()

    {

        m_poLayer = nullptr;

    }

};

class OGRPLScenesDataV1Layer final : public OGRLayer

{

    friend class OGRPLScenesDataV1Dataset;

    friend class OGRPLScenesDataV1FeatureDefn;

    OGRPLScenesDataV1Dataset *m_poDS;

    bool m_bFeatureDefnEstablished;

    OGRPLScenesDataV1FeatureDefn *m_poFeatureDefn;

    OGRSpatialReference *m_poSRS;

    GIntBig m_nTotalFeatures;

    std::map<CPLString, int> m_oMapPrefixedJSonFieldNameToFieldIdx;

    std::map<int, CPLString> m_oMapFieldIdxToQueryableJSonFieldName;

    GIntBig m_nNextFID;

    bool m_bEOF;

    bool m_bStillInFirstPage;

    CPLString m_osNextURL;

    CPLString m_osRequestURL;

    int m_nPageSize;

    bool m_bInFeatureCountOrGetExtent;

    json_object *m_poPageObj;

    json_object *m_poFeatures;

    int m_nFeatureIdx;

    json_object *m_poAttributeFilter;

    bool m_bFilterMustBeClientSideEvaluated;

    std::set<CPLString> m_oSetAssets;

    std::set<CPLString> m_oSetUnregisteredAssets;

    std::set<CPLString> m_oSetUnregisteredFields;

    OGRFeature *GetNextRawFeature();

    bool

    SetFieldFromPrefixedJSonFieldName(OGRFeature *poFeature,

                                      const CPLString &osPrefixedJSonFieldName,

                                      json_object *poVal);

    void EstablishLayerDefn();

    void RegisterField(OGRFieldDefn *poFieldDefn,

                       const char *pszQueryableJSonName,

                       const char *pszPrefixedJSonName);

    bool GetNextPage();

    json_object *BuildFilter(swq_expr_node *poNode);

    bool IsSimpleComparison(const swq_expr_node *poNode);

  public:

    OGRPLScenesDataV1Layer(OGRPLScenesDataV1Dataset *poDS, const char *pszName);

    ~OGRPLScenesDataV1Layer() override;

    void ResetReading() override;

    OGRFeature *GetNextFeature() override;

    int TestCapability(const char *) const override;

    const OGRFeatureDefn *GetLayerDefn() const override;

    GIntBig GetFeatureCount(int bForce = FALSE) override;

    CSLConstList GetMetadata(const char *pszDomain = "") override;

    virtual const char *GetMetadataItem(const char *pszName,

                                        const char *pszDomain = "") override;

    OGRErr ISetSpatialFilter(int iGeomField,

                             const OGRGeometry *poGeom) override;

    OGRErr SetAttributeFilter(const char *) override;

    OGRErr IGetExtent(int iGeomField, OGREnvelope *psExtent,

                      bool bForce) override;

};

#endif /* ndef OGR_PLSCENES_H_INCLUDED */