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

 *

 * Project:  OpenGIS Simple Features Reference Implementation

 * Purpose:  Definitions of OGR OGRGeoJSON driver types.

 * Author:   Mateusz Loskot, mateusz@loskot.net

 *

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

 * Copyright (c) 2007, Mateusz Loskot

 * Copyright (c) 2010-2013, Even Rouault <even dot rouault at spatialys.com>

 *

 * SPDX-License-Identifier: MIT

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

#ifndef OGR_GEOJSON_H_INCLUDED

#define OGR_GEOJSON_H_INCLUDED

#include "cpl_port.h"

#include "ogrsf_frmts.h"

#include "memdataset.h"

#include <cstdio>

#include <vector>  // Used by OGRGeoJSONLayer.

#include "ogrgeojsonutils.h"

#include "ogrgeojsonwriter.h"

constexpr const char *INVALID_CONTENT_FOR_JSON_LIKE =

    "__INVALID_CONTENT_FOR_JSON_LIKE__";

class OGRGeoJSONDataSource;

GDALDataset *OGRGeoJSONDriverOpenInternal(GDALOpenInfo *poOpenInfo,

                                          GeoJSONSourceType nSrcType,

                                          const char *pszJSonFlavor);

void OGRGeoJSONDriverStoreContent(const char *pszSource, char *pszText);

char *OGRGeoJSONDriverStealStoredContent(const char *pszSource);

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

/*                           OGRGeoJSONLayer                            */

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

class OGRGeoJSONReader;

class OGRGeoJSONLayer final : public OGRMemLayer

{

    friend class OGRGeoJSONDataSource;

  public:

    static const char *const DefaultName;

    static const OGRwkbGeometryType DefaultGeometryType;

    static const char *GetValidLayerName(const char *pszName)

    {

        if (pszName == nullptr || pszName[0] == 0)

        {

            // Can happen for example if reading from /vsistdin/

            pszName = OGRGeoJSONLayer::DefaultName;

        }

        return pszName;

    }

    OGRGeoJSONLayer(const char *pszName, OGRSpatialReference *poSRS,

                    OGRwkbGeometryType eGType, OGRGeoJSONDataSource *poDS,

                    OGRGeoJSONReader *poReader);

    ~OGRGeoJSONLayer() override;

    //

    // OGRLayer Interface

    //

    const char *GetFIDColumn() const override;

    int TestCapability(const char *pszCap) const override;

    OGRErr SyncToDisk() override;

    void ResetReading() override;

    OGRFeature *GetNextFeature() override;

    OGRFeature *GetFeature(GIntBig nFID) override;

    GIntBig GetFeatureCount(int bForce) override;

    OGRErr ISetFeature(OGRFeature *poFeature) override;

    OGRErr ICreateFeature(OGRFeature *poFeature) override;

    OGRErr IUpdateFeature(OGRFeature *poFeature, int nUpdatedFieldsCount,

                          const int *panUpdatedFieldsIdx,

                          int nUpdatedGeomFieldsCount,

                          const int *panUpdatedGeomFieldsIdx,

                          bool bUpdateStyleString) override;

    OGRErr DeleteFeature(GIntBig nFID) override;

    virtual OGRErr CreateField(const OGRFieldDefn *poField,

                               int bApproxOK = TRUE) override;

    OGRErr DeleteField(int iField) override;

    OGRErr ReorderFields(int *panMap) override;

    virtual OGRErr AlterFieldDefn(int iField, OGRFieldDefn *poNewFieldDefn,

                                  int nFlags) override;

    virtual OGRErr CreateGeomField(const OGRGeomFieldDefn *poGeomField,

                                   int bApproxOK = TRUE) override;

    OGRErr IGetExtent(int iGeomField, OGREnvelope *psExtent,

                      bool bForce = true) override;

    OGRErr IGetExtent3D(int iGeomField, OGREnvelope3D *psExtent3D,

                        bool bForce = true) override;

    GDALDataset *GetDataset() override;

    //

    // OGRGeoJSONLayer Interface

    //

    void SetFIDColumn(const char *pszFIDColumn);

    void AddFeature(OGRFeature *poFeature);

    void DetectGeometryType();

    void IncFeatureCount()

    {

        nTotalFeatureCount_++;

    }

    void UnsetReader()

    {

        poReader_ = nullptr;

    }

    void InvalidateFeatureCount()

    {

        nTotalFeatureCount_ = -1;

    }

    void SetWriteOptions(const OGRGeoJSONWriteOptions &options)

    {

        oWriteOptions_ = options;

    }

    void SetSupportsMGeometries(bool bSupportsMGeometries)

    {

        m_bSupportsMGeometries = bSupportsMGeometries;

    }

    void SetSupportsZGeometries(bool bSupportsZGeometries)

    {

        m_bSupportsZGeometries = bSupportsZGeometries;

    }

  private:

    OGRGeoJSONDataSource *poDS_;

    OGRGeoJSONReader *poReader_;

    bool bHasAppendedFeatures_;

    CPLString sFIDColumn_;

    bool bOriginalIdModified_;

    GIntBig nTotalFeatureCount_;

    GIntBig nFeatureReadSinceReset_ = 0;

    bool m_bSupportsMGeometries = false;

    bool m_bSupportsZGeometries = true;

    //! Write options used by ICreateFeature() in append scenarios

    OGRGeoJSONWriteOptions oWriteOptions_;

    bool IngestAll();

    void TerminateAppendSession();

    bool SetOrUpdateFeaturePreparation();

    CPL_DISALLOW_COPY_ASSIGN(OGRGeoJSONLayer)

};

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

/*                         OGRGeoJSONWriteLayer                         */

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

class OGRGeoJSONWriteLayer final : public OGRLayer

{

  public:

    OGRGeoJSONWriteLayer(const char *pszName, OGRwkbGeometryType eGType,

                         CSLConstList papszOptions, bool bWriteFC_BBOXIn,

                         OGRCoordinateTransformation *poCT,

                         OGRGeoJSONDataSource *poDS);

    ~OGRGeoJSONWriteLayer() override;

    //

    // OGRLayer Interface

    //

    using OGRLayer::GetLayerDefn;

    const OGRFeatureDefn *GetLayerDefn() const override

    {

        return poFeatureDefn_;

    }

    const OGRSpatialReference *GetSpatialRef() const override

    {

        return nullptr;

    }

    void ResetReading() override

    {

    }

    OGRFeature *GetNextFeature() override

    {

        return nullptr;

    }

    OGRErr ICreateFeature(OGRFeature *poFeature) override;

    OGRErr CreateField(const OGRFieldDefn *poField, int bApproxOK) override;

    int TestCapability(const char *pszCap) const override;

    OGRErr IGetExtent(int iGeomField, OGREnvelope *psExtent,

                      bool bForce) override;

    OGRErr SyncToDisk() override;

    GDALDataset *GetDataset() override;

  private:

    OGRGeoJSONDataSource *poDS_;

    OGRFeatureDefn *poFeatureDefn_;

    int nOutCounter_;

    /** Offset at which the '] }' terminating sequence has already been

     * written by SyncToDisk(). 0 if it has not been written.

     */

    vsi_l_offset m_nPositionBeforeFCClosed = 0;

    bool bWriteBBOX;

    bool bBBOX3D;

    bool bWriteFC_BBOX;

    OGREnvelope3D sEnvelopeLayer;

    int nSignificantFigures_;

    bool bRFC7946_;

    bool bWrapDateLine_ = false;

    std::string osForeignMembers_{};

    OGRCoordinateTransformation *poCT_;

    OGRGeometryFactory::TransformWithOptionsCache oTransformCache_;

    OGRGeoJSONWriteOptions oWriteOptions_;

    CPL_DISALLOW_COPY_ASSIGN(OGRGeoJSONWriteLayer)

    void FinishWriting();

};

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

/*                           OGRGeoJSONDataSource                       */

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

class OGRGeoJSONDataSource final : public GDALDataset

{

  public:

    OGRGeoJSONDataSource();

    ~OGRGeoJSONDataSource() override;

    int Open(GDALOpenInfo *poOpenInfo, GeoJSONSourceType nSrcType,

             const char *pszJSonFlavor);

    int GetLayerCount() const override;

    using GDALDataset::GetLayer;

    const OGRLayer *GetLayer(int nLayer) const override;

    OGRLayer *ICreateLayer(const char *pszName,

                           const OGRGeomFieldDefn *poGeomFieldDefn,

                           CSLConstList papszOptions) override;

    int TestCapability(const char *pszCap) const override;

    void AddLayer(OGRGeoJSONLayer *poLayer);

    //

    // OGRGeoJSONDataSource Interface

    //

    int Create(const char *pszName, char **papszOptions);

    VSILFILE *GetOutputFile() const

    {

        return fpOut_;

    }

    enum GeometryTranslation

    {

        eGeometryPreserve,

        eGeometryAsCollection,

    };

    void SetGeometryTranslation(GeometryTranslation type);

    enum AttributesTranslation

    {

        eAttributesPreserve,

        eAttributesSkip

    };

    void SetAttributesTranslation(AttributesTranslation type);

    int GetFpOutputIsSeekable() const

    {

        return bFpOutputIsSeekable_;

    }

    int GetBBOXInsertLocation() const

    {

        return nBBOXInsertLocation_;

    }

    int HasOtherPages() const

    {

        return bOtherPages_;

    }

    bool IsUpdatable() const

    {

        return bUpdatable_;

    }

    const CPLString &GetJSonFlavor() const

    {

        return osJSonFlavor_;

    }

    void SetSupportsMGeometries(bool bSupportsMGeometries)

    {

        m_bSupportsMGeometries = bSupportsMGeometries;

    }

    void SetSupportsZGeometries(bool bSupportsZGeometries)

    {

        m_bSupportsZGeometries = bSupportsZGeometries;

    }

    CPLErr FlushCache(bool bAtClosing) override;

    CPLErr Close() override;

    // Analyze the OGR_SCHEMA open options and apply changes to the feature definition, return false in case of a critical error

    bool DealWithOgrSchemaOpenOption(const GDALOpenInfo *poOpenInfo);

    static const size_t SPACE_FOR_BBOX = 130;

  private:

    //

    // Private data members

    //

    char *pszName_;

    char *pszGeoData_;

    vsi_l_offset nGeoDataLen_;

    OGRGeoJSONLayer **papoLayers_;

    OGRGeoJSONWriteLayer **papoLayersWriter_;

    int nLayers_;

    VSILFILE *fpOut_;

    //

    // Translation/Creation control flags

    //

    GeometryTranslation flTransGeom_;

    AttributesTranslation flTransAttrs_;

    bool bOtherPages_;  // ESRI Feature Service specific.

    bool bFpOutputIsSeekable_;

    int nBBOXInsertLocation_;

    bool bUpdatable_;

    CPLString osJSonFlavor_;

    bool m_bSupportsMGeometries = false;

    bool m_bSupportsZGeometries = true;

    //

    // Private utility functions

    //

    bool Clear();

    int ReadFromFile(GDALOpenInfo *poOpenInfo, const char *pszUnprefixed);

    int ReadFromService(GDALOpenInfo *poOpenInfo, const char *pszSource);

    void LoadLayers(GDALOpenInfo *poOpenInfo, GeoJSONSourceType nSrcType,

                    const char *pszUnprefixed, const char *pszJSonFlavor);

    void SetOptionsOnReader(GDALOpenInfo *poOpenInfo,

                            OGRGeoJSONReader *poReader);

    void CheckExceededTransferLimit(json_object *poObj);

    void RemoveJSonPStuff();

    CPL_DISALLOW_COPY_ASSIGN(OGRGeoJSONDataSource)

};

#endif  // OGR_GEOJSON_H_INCLUDED