text: /******************************************************************************
   *
   * Project:  OpenGIS Simple Features Reference Implementation
   * Purpose:  Implements OGRShapeDriver class.
   * Author:   Frank Warmerdam, warmerdam@pobox.com
   *
   ******************************************************************************
   * Copyright (c) 1999,  Les Technologies SoftMap Inc.
   *
   * 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 "ogrshape.h"
  
  #include <cstring>
  
  #include "cpl_conv.h"
  #include "cpl_error.h"
  #include "cpl_port.h"
  #include "cpl_string.h"
  #include "cpl_vsi.h"
  #include "gdal.h"
  #include "gdal_priv.h"
  #include "ogrsf_frmts.h"
  
  CPL_CVSID("$Id$")
  
  /************************************************************************/
  /*                              Identify()                              */
  /************************************************************************/
  
  static int OGRShapeDriverIdentify( GDALOpenInfo* poOpenInfo )
  {
      // Files not ending with .shp, .shx or .dbf are not handled by this driver.
      if( !poOpenInfo->bStatOK )
          return FALSE;
      if( poOpenInfo->bIsDirectory )
          return -1;  // Unsure.
      if( poOpenInfo->fpL == nullptr )
      {
          return FALSE;
      }
      CPLString osExt(CPLGetExtension(poOpenInfo->pszFilename));
      if (EQUAL(osExt, "SHP") ||  EQUAL(osExt, "SHX") )
      {
          return memcmp(poOpenInfo->pabyHeader, "\x00\x00\x27\x0A", 4) == 0 ||
                 memcmp(poOpenInfo->pabyHeader, "\x00\x00\x27\x0D", 4) == 0;
      }
      if( EQUAL(osExt, "DBF") )
      {
          if( poOpenInfo->nHeaderBytes < 32 )
              return FALSE;
          const GByte* pabyBuf = poOpenInfo->pabyHeader;
          const unsigned int nHeadLen = pabyBuf[8] + pabyBuf[9]*256;
          const unsigned int nRecordLength = pabyBuf[10] + pabyBuf[11]*256;
          if( nHeadLen < 32 )
              return FALSE;
          // The header length of some .dbf files can be a non-multiple of 32
          // See https://trac.osgeo.org/gdal/ticket/6035
          // Hopefully there are not so many .dbf files around that are not real
          // DBFs
          // if( (nHeadLen % 32) != 0 && (nHeadLen % 32) != 1 )
          //     return FALSE;
          const unsigned int nFields = (nHeadLen - 32) / 32;
          if( nRecordLength < nFields )
              return FALSE;
          return TRUE;
      }
  #ifdef DEBUG
      // For AFL, so that .cur_input is detected as the archive filename.
      if( !STARTS_WITH(poOpenInfo->pszFilename, "/vsitar/") &&
          EQUAL(CPLGetFilename(poOpenInfo->pszFilename), ".cur_input") )
      {
          return -1;
      }
  #endif
      return FALSE;
  }
  
  /************************************************************************/
  /*                                Open()                                */
  /************************************************************************/
  
  static GDALDataset *OGRShapeDriverOpen( GDALOpenInfo* poOpenInfo )
  
  {
      if( OGRShapeDriverIdentify(poOpenInfo) == FALSE )
          return nullptr;
  
  #ifdef DEBUG
      // For AFL, so that .cur_input is detected as the archive filename.
      if( poOpenInfo->fpL != nullptr &&
          !STARTS_WITH(poOpenInfo->pszFilename, "/vsitar/") &&
          EQUAL(CPLGetFilename(poOpenInfo->pszFilename), ".cur_input") )
      {
          GDALOpenInfo oOpenInfo(
              (CPLString("/vsitar/") + poOpenInfo->pszFilename).c_str(),
              poOpenInfo->nOpenFlags );
          oOpenInfo.papszOpenOptions = poOpenInfo->papszOpenOptions;
          return OGRShapeDriverOpen(&oOpenInfo);
      }
  #endif
  
      OGRShapeDataSource *poDS = new OGRShapeDataSource();
  
      if( !poDS->Open( poOpenInfo, true ) )
      {
          delete poDS;
          return nullptr;
      }
  
      return poDS;
  }
  
  /************************************************************************/
  /*                               Create()                               */
  /************************************************************************/
  
  static GDALDataset *OGRShapeDriverCreate( const char * pszName,
                                             int /* nBands */,
                                             int /* nXSize */,
                                             int /* nYSize */,
                                             GDALDataType /* eDT */,
                                             char ** /* papszOptions */ )
  {
      bool bSingleNewFile = false;
  
  /* -------------------------------------------------------------------- */
  /*      Is the target a valid existing directory?                       */
  /* -------------------------------------------------------------------- */
      VSIStatBufL stat;
      if( VSIStatL( pszName, &stat ) == 0 )
      {
          if( !VSI_ISDIR(stat.st_mode) )
          {
              CPLError( CE_Failure, CPLE_AppDefined,
                        "%s is not a directory.",
                        pszName );
  
              return nullptr;
          }
      }
  
  /* -------------------------------------------------------------------- */
  /*      Does it end in the extension .shp indicating the user likely    */
  /*      wants to create a single file set?                              */
  /* -------------------------------------------------------------------- */
      else if( EQUAL(CPLGetExtension(pszName), "shp")
               || EQUAL(CPLGetExtension(pszName), "dbf") )
      {
          bSingleNewFile = true;
      }
  
  /* -------------------------------------------------------------------- */
  /*      Otherwise try to create a new directory.                        */
  /* -------------------------------------------------------------------- */
      else
      {
          if( VSIMkdir( pszName, 0755 ) != 0 )
          {
              CPLError( CE_Failure, CPLE_AppDefined,
                        "Failed to create directory %s "
                        "for shapefile datastore.",
                        pszName );
  
              return nullptr;
          }
      }
  
  /* -------------------------------------------------------------------- */
  /*      Return a new OGRDataSource()                                    */
  /* -------------------------------------------------------------------- */
      OGRShapeDataSource  *poDS = new OGRShapeDataSource();
  
      GDALOpenInfo oOpenInfo( pszName, GA_Update );
      if( !poDS->Open( &oOpenInfo, false, bSingleNewFile ) )
      {
          delete poDS;
          return nullptr;
      }
  
      return poDS;
  }
  
  /************************************************************************/
  /*                           Delete()                                   */
  /************************************************************************/
  
  static CPLErr OGRShapeDriverDelete( const char *pszDataSource )
  
  {
      VSIStatBufL sStatBuf;
  
      if( VSIStatL( pszDataSource, &sStatBuf ) != 0 )
      {
          CPLError( CE_Failure, CPLE_AppDefined,
                    "%s does not appear to be a file or directory.",
                    pszDataSource );
  
          return CE_Failure;
      }
  
      const char * const* papszExtensions =
          OGRShapeDataSource::GetExtensionsForDeletion();
  
      if( VSI_ISREG(sStatBuf.st_mode)
          && (EQUAL(CPLGetExtension(pszDataSource), "shp")
              || EQUAL(CPLGetExtension(pszDataSource), "shx")
              || EQUAL(CPLGetExtension(pszDataSource), "dbf")) )
      {
          for( int iExt = 0; papszExtensions[iExt] != nullptr; iExt++ )
          {
              const char *pszFile = CPLResetExtension(pszDataSource,
                                                      papszExtensions[iExt]);
              if( VSIStatL( pszFile, &sStatBuf ) == 0 )
                  VSIUnlink( pszFile );
          }
      }
      else if( VSI_ISDIR(sStatBuf.st_mode) )
      {
          char **papszDirEntries = VSIReadDir( pszDataSource );
  
          for( int iFile = 0;
               papszDirEntries != nullptr && papszDirEntries[iFile] != nullptr;
               iFile++ )
          {
              if( CSLFindString( papszExtensions,
                                 CPLGetExtension(papszDirEntries[iFile])) != -1)
              {
                  VSIUnlink( CPLFormFilename( pszDataSource,
                                              papszDirEntries[iFile],
                                              nullptr ) );
              }
          }
  
          CSLDestroy( papszDirEntries );
  
          VSIRmdir( pszDataSource );
      }
  
      return CE_None;
  }
  
  /************************************************************************/
  /*                          RegisterOGRShape()                          */
  /************************************************************************/
  
  void RegisterOGRShape()
  
  {
      if( GDALGetDriverByName( "ESRI Shapefile" ) != nullptr )
          return;
  
      GDALDriver *poDriver = new GDALDriver();
  
      poDriver->SetDescription( "ESRI Shapefile" );
      poDriver->SetMetadataItem( GDAL_DCAP_VECTOR, "YES" );
      poDriver->SetMetadataItem( GDAL_DMD_LONGNAME, "ESRI Shapefile" );
      poDriver->SetMetadataItem( GDAL_DMD_EXTENSION, "shp" );
      poDriver->SetMetadataItem( GDAL_DMD_EXTENSIONS, "shp dbf" );
      poDriver->SetMetadataItem( GDAL_DMD_HELPTOPIC, "drv_shape.html" );
  
      poDriver->SetMetadataItem( GDAL_DMD_OPENOPTIONLIST,
  "<OpenOptionList>"
  "  <Option name='ENCODING' type='string' description='to override the encoding interpretation of the DBF with any encoding supported by CPLRecode or to \"\" to avoid any recoding'/>"
  "  <Option name='DBF_DATE_LAST_UPDATE' type='string' description='Modification date to write in DBF header with YYYY-MM-DD format'/>"
  "  <Option name='ADJUST_TYPE' type='boolean' description='Whether to read whole .dbf to adjust Real->Integer/Integer64 or Integer64->Integer field types if possible' default='NO'/>"
  "  <Option name='ADJUST_GEOM_TYPE' type='string-select' description='Whether and how to adjust layer geometry type from actual shapes' default='FIRST_SHAPE'>"
  "    <Value>NO</Value>"
  "    <Value>FIRST_SHAPE</Value>"
  "    <Value>ALL_SHAPES</Value>"
  "  </Option>"
  "  <Option name='AUTO_REPACK' type='boolean' description='Whether the shapefile should be automatically repacked when needed' default='YES'/>"
  "  <Option name='DBF_EOF_CHAR' type='boolean' description='Whether to write the 0x1A end-of-file character in DBF files' default='YES'/>"
  "</OpenOptionList>");
  
      poDriver->SetMetadataItem( GDAL_DMD_CREATIONOPTIONLIST,
                                 "<CreationOptionList/>" );
      poDriver->SetMetadataItem( GDAL_DS_LAYER_CREATIONOPTIONLIST,
  "<LayerCreationOptionList>"
  "  <Option name='SHPT' type='string-select' description='type of shape' default='automatically detected'>"
  "    <Value>POINT</Value>"
  "    <Value>ARC</Value>"
  "    <Value>POLYGON</Value>"
  "    <Value>MULTIPOINT</Value>"
  "    <Value>POINTZ</Value>"
  "    <Value>ARCZ</Value>"
  "    <Value>POLYGONZ</Value>"
  "    <Value>MULTIPOINTZ</Value>"
  "    <Value>POINTM</Value>"
  "    <Value>ARCM</Value>"
  "    <Value>POLYGONM</Value>"
  "    <Value>MULTIPOINTM</Value>"
  "    <Value>POINTZM</Value>"
  "    <Value>ARCZM</Value>"
  "    <Value>POLYGONZM</Value>"
  "    <Value>MULTIPOINTZM</Value>"
  "    <Value>MULTIPATCH</Value>"
  "    <Value>NONE</Value>"
  "    <Value>NULL</Value>"
  "  </Option>"
  "  <Option name='2GB_LIMIT' type='boolean' description='Restrict .shp and .dbf to 2GB' default='NO'/>"
  "  <Option name='ENCODING' type='string' description='DBF encoding' default='LDID/87'/>"
  "  <Option name='RESIZE' type='boolean' description='To resize fields to their optimal size.' default='NO'/>"
  "  <Option name='SPATIAL_INDEX' type='boolean' description='To create a spatial index.' default='NO'/>"
  "  <Option name='DBF_DATE_LAST_UPDATE' type='string' description='Modification date to write in DBF header with YYYY-MM-DD format'/>"
  "  <Option name='AUTO_REPACK' type='boolean' description='Whether the shapefile should be automatically repacked when needed' default='YES'/>"
  "  <Option name='DBF_EOF_CHAR' type='boolean' description='Whether to write the 0x1A end-of-file character in DBF files' default='YES'/>"
  "</LayerCreationOptionList>");
  
      poDriver->SetMetadataItem( GDAL_DMD_CREATIONFIELDDATATYPES,
                                 "Integer Integer64 Real String Date DateTime" );
      poDriver->SetMetadataItem( GDAL_DCAP_VIRTUALIO, "YES" );
  
      poDriver->pfnOpen = OGRShapeDriverOpen;
      poDriver->pfnIdentify = OGRShapeDriverIdentify;
      poDriver->pfnCreate = OGRShapeDriverCreate;
      poDriver->pfnDelete = OGRShapeDriverDelete;
  
      GetGDALDriverManager()->RegisterDriver( poDriver );
  }
  