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

 *

 * Project:  KML Driver

 * Purpose:  Implementation of OGRKMLDriver class.

 * Author:   Christopher Condit, condit@sdsc.edu;

 *           Jens Oberender, j.obi@troja.net

 *

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

 * Copyright (c) 2006, Christopher Condit

 *               2007, Jens Oberender

 *

 * SPDX-License-Identifier: MIT

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

#include "cpl_port.h"

#include "ogr_kml.h"

#include <cstring>

#include "cpl_conv.h"

#include "cpl_error.h"

#include "gdal.h"

#include "gdal_priv.h"

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

/*                        OGRKMLDriverIdentify()                        */

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

static int OGRKMLDriverIdentify(GDALOpenInfo *poOpenInfo)

{

    if (poOpenInfo->fpL == nullptr)

        return FALSE;

    return strstr(reinterpret_cast<char *>(poOpenInfo->pabyHeader), "<kml") !=

               nullptr ||

           strstr(reinterpret_cast<char *>(poOpenInfo->pabyHeader),

                  "<kml:kml") != nullptr;

}

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

/*                                Open()                                */

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

static GDALDataset *OGRKMLDriverOpen(GDALOpenInfo *poOpenInfo)

{

    if (poOpenInfo->eAccess == GA_Update)

        return nullptr;

    if (!OGRKMLDriverIdentify(poOpenInfo))

        return nullptr;

#ifdef HAVE_EXPAT

    OGRKMLDataSource *poDS = new OGRKMLDataSource();

    if (poDS->Open(poOpenInfo->pszFilename, TRUE))

    {

#ifdef DEBUG_VERBOSE

        if (poDS->GetLayerCount() == 0)

        {

            CPLError(CE_Failure, CPLE_OpenFailed, "No layers in KML file: %s.",

                     poOpenInfo->pszFilename);

            delete poDS;

            poDS = nullptr;

        }

#endif

    }

    else

    {

        delete poDS;

        poDS = nullptr;

    }

    return poDS;

#else

    return nullptr;

#endif

}

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

/*                               Create()                               */

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

static GDALDataset *OGRKMLDriverCreate(const char *pszName, int /* nBands */,

                                       int /* nXSize */, int /* nYSize */,

                                       GDALDataType /* eDT */,

                                       CSLConstList papszOptions)

{

    CPLAssert(nullptr != pszName);

    CPLDebug("KML", "Attempt to create: %s", pszName);

    OGRKMLDataSource *poDS = new OGRKMLDataSource();

    if (!poDS->Create(pszName, papszOptions))

    {

        delete poDS;

        poDS = nullptr;

    }

    return poDS;

}

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

/*                           RegisterOGRKML()                           */

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

void RegisterOGRKML()

{

    if (GDALGetDriverByName("KML") != nullptr)

        return;

    GDALDriver *poDriver = new GDALDriver();

    poDriver->SetDescription("KML");

    poDriver->SetMetadataItem(GDAL_DCAP_VECTOR, "YES");

    poDriver->SetMetadataItem(GDAL_DCAP_CREATE_LAYER, "YES");

    poDriver->SetMetadataItem(GDAL_DCAP_CREATE_FIELD, "YES");

    poDriver->SetMetadataItem(GDAL_DCAP_Z_GEOMETRIES, "YES");

    poDriver->SetMetadataItem(GDAL_DMD_LONGNAME,

                              "Keyhole Markup Language (KML)");

    poDriver->SetMetadataItem(GDAL_DMD_EXTENSION, "kml");

    poDriver->SetMetadataItem(GDAL_DMD_HELPTOPIC, "drivers/vector/kml.html");

    poDriver->SetMetadataItem(GDAL_DMD_SUPPORTED_SQL_DIALECTS, "OGRSQL SQLITE");

    poDriver->SetMetadataItem(

        GDAL_DMD_CREATIONOPTIONLIST,

        "<CreationOptionList>"

        "  <Option name='DOCUMENT_ID' type='string' description='Id of the "

        "root <Document> node' default='root_doc'/>"

        "  <Option name='GPX_USE_EXTENSIONS' type='boolean' "

        "description='Whether to write non-GPX attributes in an "

        "<extensions> tag' default='NO'/>"

        "  <Option name='NameField' type='string' description='Field to use to "

        "fill the KML <name> element' default='Name'/>"

        "  <Option name='DescriptionField' type='string' description='Field to "

        "use to fill the KML <description> element' "

        "default='Description'/>"

        "  <Option name='AltitudeMode' type='string-select' description='Value "

        "of the <AltitudeMode> element for 3D geometries'>"

        "    <Value>clampToGround</Value>"

        "    <Value>relativeToGround</Value>"

        "    <Value>absolute</Value>"

        "  </Option>"

        "</CreationOptionList>");

    poDriver->SetMetadataItem(GDAL_DS_LAYER_CREATIONOPTIONLIST,

                              "<LayerCreationOptionList/>");

    poDriver->SetMetadataItem(GDAL_DCAP_VIRTUALIO, "YES");

    poDriver->SetMetadataItem(GDAL_DMD_CREATIONFIELDDATATYPES,

                              "Integer Real String");

    poDriver->SetMetadataItem(GDAL_DCAP_FEATURE_STYLES, "YES");

    poDriver->SetMetadataItem(GDAL_DCAP_FEATURE_STYLES_WRITE, "YES");

    poDriver->SetMetadataItem(GDAL_DCAP_MULTIPLE_VECTOR_LAYERS, "YES");

    poDriver->pfnOpen = OGRKMLDriverOpen;

    poDriver->pfnIdentify = OGRKMLDriverIdentify;

    poDriver->pfnCreate = OGRKMLDriverCreate;

    GetGDALDriverManager()->RegisterDriver(poDriver);

}