/******************************************************************************
 *
 * Project:  S-57 Translator
 * Purpose:  Implements OGRS57Driver
 * Author:   Frank Warmerdam, warmerdam@pobox.com
 *
 ******************************************************************************
 * Copyright (c) 1999, Frank Warmerdam
 * Copyright (c) 2013, Even Rouault <even dot rouault at spatialys.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 ****************************************************************************/

#include "ogr_s57.h"
#include "cpl_conv.h"
#include "cpl_multiproc.h"

S57ClassRegistrar *OGRS57Driver::poRegistrar = nullptr;
static CPLMutex *hS57RegistrarMutex = nullptr;

/************************************************************************/
/*                            OGRS57Driver()                            */
/************************************************************************/

OGRS57Driver::OGRS57Driver()
{
}

/************************************************************************/
/*                           ~OGRS57Driver()                            */
/************************************************************************/

OGRS57Driver::~OGRS57Driver()

{
    if (poRegistrar != nullptr)
    {
        delete poRegistrar;
        poRegistrar = nullptr;
    }

    if (hS57RegistrarMutex != nullptr)
    {
        CPLDestroyMutex(hS57RegistrarMutex);
        hS57RegistrarMutex = nullptr;
    }
}

/************************************************************************/
/*                          OGRS57DriverIdentify()                      */
/************************************************************************/

static int OGRS57DriverIdentify(GDALOpenInfo *poOpenInfo)

{
    if (poOpenInfo->nHeaderBytes < 10)
        return false;
    const char *pachLeader = reinterpret_cast<char *>(poOpenInfo->pabyHeader);
    if ((pachLeader[5] != '1' && pachLeader[5] != '2' &&
         pachLeader[5] != '3') ||
        pachLeader[6] != 'L' || (pachLeader[8] != '1' && pachLeader[8] != ' '))
    {
        return false;
    }
    // Test for S-57 DSID field structure (to distinguish it from S-101)
    return strstr(pachLeader, "DSID") != nullptr &&
           (strstr(pachLeader,
                   "RCNM!RCID!EXPP!INTU!DSNM!EDTN!UPDN!UADT!ISDT!"
                   "STED!PRSP!PSDN!PRED!PROF!AGEN!COMT") != nullptr ||
            // Below is for autotest/ogr/data/s57/fake_s57.000 fake dataset that has a shortened structure
            strstr(pachLeader, "RCNM!RCID!EXPP!xxxx") != nullptr);
}

/************************************************************************/
/*                                Open()                                */
/************************************************************************/

GDALDataset *OGRS57Driver::Open(GDALOpenInfo *poOpenInfo)

{
    if (!OGRS57DriverIdentify(poOpenInfo))
        return nullptr;

    OGRS57DataSource *poDS = new OGRS57DataSource(poOpenInfo->papszOpenOptions);
    if (!poDS->Open(poOpenInfo->pszFilename))
    {
        delete poDS;
        poDS = nullptr;
    }

    if (poDS && poOpenInfo->eAccess == GA_Update)
    {
        delete poDS;
        CPLError(CE_Failure, CPLE_OpenFailed,
                 "S57 Driver doesn't support update.");
        return nullptr;
    }

    return poDS;
}

/************************************************************************/
/*                              Create()                                */
/************************************************************************/

GDALDataset *OGRS57Driver::Create(const char *pszName, int /* nBands */,
                                  int /* nXSize */, int /* nYSize */,
                                  GDALDataType /* eDT */, char **papszOptions)
{
    OGRS57DataSource *poDS = new OGRS57DataSource();

    if (poDS->Create(pszName, papszOptions))
        return poDS;

    delete poDS;
    return nullptr;
}

/************************************************************************/
/*                          GetS57Registrar()                           */
/************************************************************************/

S57ClassRegistrar *OGRS57Driver::GetS57Registrar()

{
    /* -------------------------------------------------------------------- */
    /*      Instantiate the class registrar if possible.                    */
    /* -------------------------------------------------------------------- */
    CPLMutexHolderD(&hS57RegistrarMutex);

    if (poRegistrar == nullptr)
    {
        poRegistrar = new S57ClassRegistrar();

        if (!poRegistrar->LoadInfo(nullptr, nullptr, false))
        {
            delete poRegistrar;
            poRegistrar = nullptr;
        }
    }

    return poRegistrar;
}

/************************************************************************/
/*                           RegisterOGRS57()                           */
/************************************************************************/

void RegisterOGRS57()

{
    if (GDALGetDriverByName("S57") != nullptr)
        return;

    GDALDriver *poDriver = new OGRS57Driver();

    poDriver->SetDescription("S57");
    poDriver->SetMetadataItem(GDAL_DCAP_VECTOR, "YES");
    poDriver->SetMetadataItem(GDAL_DMD_LONGNAME, "IHO S-57 (ENC)");
    poDriver->SetMetadataItem(GDAL_DMD_EXTENSION, "000");
    poDriver->SetMetadataItem(GDAL_DMD_HELPTOPIC, "drivers/vector/s57.html");
    poDriver->SetMetadataItem(GDAL_DMD_SUPPORTED_SQL_DIALECTS, "OGRSQL SQLITE");

    poDriver->SetMetadataItem(
        GDAL_DMD_OPENOPTIONLIST,
        "<OpenOptionList>"
        "  <Option name='" S57O_UPDATES
        "' type='string-select' description='Should update files be "
        "incorporated into the base data on the fly' default='APPLY'>"
        "    <Value>APPLY</Value>"
        "    <Value>IGNORE</Value>"
        "  </Option>"
        "  <Option name='" S57O_SPLIT_MULTIPOINT
        "' type='boolean' description='Should multipoint soundings be split "
        "into many single point sounding features' default='NO'/>"
        "  <Option name='" S57O_ADD_SOUNDG_DEPTH
        "' type='boolean' description='Should a DEPTH attribute be added on "
        "SOUNDG features and assign the depth of the sounding' default='NO'/>"
        "  <Option name='" S57O_RETURN_PRIMITIVES
        "' type='boolean' description='Should all the low level geometry "
        "primitives be returned as special IsolatedNode, ConnectedNode, Edge "
        "and Face layers' default='NO'/>"
        "  <Option name='" S57O_PRESERVE_EMPTY_NUMBERS
        "' type='boolean' description='If enabled, numeric attributes assigned "
        "an empty string as a value will be preserved as a special numeric "
        "value' default='NO'/>"
        "  <Option name='" S57O_LNAM_REFS
        "' type='boolean' description='Should LNAM and LNAM_REFS fields be "
        "attached to features capturing the feature to feature relationships "
        "in the FFPT group of the S-57 file' default='NO'/>"
        "  <Option name='" S57O_RETURN_LINKAGES
        "' type='boolean' description='Should additional attributes relating "
        "features to their underlying geometric primitives be attached' "
        "default='NO'/>"
        "  <Option name='" S57O_RECODE_BY_DSSI
        "' type='boolean' description='Should attribute values be recoded to "
        "UTF-8 from the character encoding specified in the S57 DSSI record.' "
        "default='YES'/>"
        "  <Option name='" S57O_LIST_AS_STRING
        "' type='boolean' description='Whether attributes tagged as list in "
        "S57 dictionaries should be reported as a String field' default='NO'/>"
        "</OpenOptionList>");
    poDriver->SetMetadataItem(
        GDAL_DMD_CREATIONOPTIONLIST,
        "<CreationOptionList>"
        "   <Option name='S57_EXPP' type='int' description='Exchange purpose' "
        "default='1'/>"
        "   <Option name='S57_INTU' type='int' description='Intended usage' "
        "default='4'/>"
        "   <Option name='S57_EDTN' type='string' description='Edition number' "
        "default='2'/>"
        "   <Option name='S57_UPDN' type='string' description='Update number' "
        "default='0'/>"
        "   <Option name='S57_UADT' type='string' description='Update "
        "application date' default='20030801'/>"
        "   <Option name='S57_ISDT' type='string' description='Issue date' "
        "default='20030801'/>"
        "   <Option name='S57_STED' type='string' description='Edition number "
        "of S-57' default='03.1'/>"
        "   <Option name='S57_AGEN' type='int' description='Producing agency' "
        "default='540'/>"
        "   <Option name='S57_COMT' type='string' description='Comment' "
        "default=''/>"
        "   <Option name='S57_AALL' type='int' description='Lexical level used "
        "for the ATTF fields' default='0'/>"
        "   <Option name='S57_NALL' type='int' description='Lexical level used "
        "for the NATF fields' default='0'/>"
        "   <Option name='S57_NOMR' type='int' description='Number of meta "
        "records (objects with acronym starting with \"M_\")' default='0'/>"
        "   <Option name='S57_NOGR' type='int' description='Number of geo "
        "records' default='0'/>"
        "   <Option name='S57_NOLR' type='int' description='Number of "
        "collection records' default='0'/>"
        "   <Option name='S57_NOIN' type='int' description='Number of isolated "
        "node records' default='0'/>"
        "   <Option name='S57_NOCN' type='int' description='Number of "
        "connected node records' default='0'/>"
        "   <Option name='S57_NOED' type='int' description='Number of edge "
        "records' default='0'/>"
        "   <Option name='S57_HDAT' type='int' description='Horizontal "
        "geodetic datum' default='2'/>"
        "   <Option name='S57_VDAT' type='int' description='Vertical datum' "
        "default='17'/>"
        "   <Option name='S57_SDAT' type='int' description='Sounding datum' "
        "default='23'/>"
        "   <Option name='S57_CSCL' type='int' description='Compilation scale "
        "of data (1:X)' default='52000'/>"
        "   <Option name='S57_COMF' type='int' description='Floating-point to "
        "integer multiplication factor for coordinate values' "
        "default='10000000'/>"
        "   <Option name='S57_SOMF' type='int' description='Floating point to "
        "integer multiplication factor for 3-D (sounding) values' "
        "default='10'/>"
        "</CreationOptionList>");

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

    poDriver->pfnOpen = OGRS57Driver::Open;
    poDriver->pfnIdentify = OGRS57DriverIdentify;
    poDriver->pfnCreate = OGRS57Driver::Create;

    GetGDALDriverManager()->RegisterDriver(poDriver);
}
