/****************************************************************************** * * Project: OpenGIS Simple Features Reference Implementation * Purpose: Different utility functions used in FileGDB OGR driver. * Author: Ragi Yaser Burhum, ragi@burhum.com * Paul Ramsey, pramsey at cleverelephant.ca * ****************************************************************************** * Copyright (c) 2010, Ragi Yaser Burhum * Copyright (c) 2011, Paul Ramsey * Copyright (c) 2011-2014, Even Rouault * * SPDX-License-Identifier: MIT ****************************************************************************/ #include "FGdbUtils.h" #include #include "ogr_api.h" #include "ogrpgeogeometry.h" #include "filegdb_reserved_keywords.h" using std::string; /************************************************************************/ /* StringToWString() */ /************************************************************************/ std::wstring StringToWString(const std::string &utf8string) { wchar_t *pszUTF16 = CPLRecodeToWChar(utf8string.c_str(), CPL_ENC_UTF8, CPL_ENC_UCS2); std::wstring utf16string(pszUTF16); CPLFree(pszUTF16); return utf16string; } /************************************************************************/ /* WStringToString() */ /************************************************************************/ std::string WStringToString(const std::wstring &utf16string) { char *pszUTF8 = CPLRecodeFromWChar(utf16string.c_str(), CPL_ENC_UCS2, CPL_ENC_UTF8); std::string utf8string(pszUTF8); CPLFree(pszUTF8); return utf8string; } /************************************************************************/ /* GDBErr() */ /************************************************************************/ bool GDBErr(long int hr, const std::string &desc, CPLErr errType, const char *pszAddMsg) { std::wstring fgdb_error_desc_w; fgdbError er; er = FileGDBAPI::ErrorInfo::GetErrorDescription(static_cast(hr), fgdb_error_desc_w); if (er == S_OK) { std::string fgdb_error_desc = WStringToString(fgdb_error_desc_w); CPLError(errType, CPLE_AppDefined, "%s (%s)%s", desc.c_str(), fgdb_error_desc.c_str(), pszAddMsg); } else { CPLError(errType, CPLE_AppDefined, "Error (%ld): %s%s", hr, desc.c_str(), pszAddMsg); } // FIXME? EvenR: not sure if ClearErrors() is really necessary, but as it, // it causes crashes in case of repeated errors // FileGDBAPI::ErrorInfo::ClearErrors(); return false; } /************************************************************************/ /* GDBDebug() */ /************************************************************************/ bool GDBDebug(long int hr, const std::string &desc) { std::wstring fgdb_error_desc_w; fgdbError er; er = FileGDBAPI::ErrorInfo::GetErrorDescription(static_cast(hr), fgdb_error_desc_w); if (er == S_OK) { std::string fgdb_error_desc = WStringToString(fgdb_error_desc_w); CPLDebug("FGDB", "%s (%s)", desc.c_str(), fgdb_error_desc.c_str()); } else { CPLDebug("FGDB", "%s", desc.c_str()); } // FIXME? EvenR: not sure if ClearErrors() is really necessary, but as it, // it causes crashes in case of repeated errors // FileGDBAPI::ErrorInfo::ClearErrors(); return false; } /************************************************************************/ /* GDBToOGRGeometry() */ /************************************************************************/ bool GDBToOGRGeometry(const std::string &geoType, bool hasZ, bool hasM, OGRwkbGeometryType *pOut) { if (geoType == "esriGeometryPoint") { *pOut = wkbPoint; } else if (geoType == "esriGeometryMultipoint") { *pOut = wkbMultiPoint; } else if (geoType == "esriGeometryLine") { *pOut = wkbLineString; } else if (geoType == "esriGeometryPolyline") { *pOut = wkbMultiLineString; } else if (geoType == "esriGeometryPolygon" || geoType == "esriGeometryMultiPatch") { *pOut = wkbMultiPolygon; // no mapping to single polygon } else { CPLError(CE_Failure, CPLE_AppDefined, "Cannot map esriGeometryType(%s) to OGRwkbGeometryType", geoType.c_str()); return false; } if (hasZ) *pOut = wkbSetZ(*pOut); if (hasM) *pOut = wkbSetM(*pOut); return true; } /************************************************************************/ /* OGRGeometryToGDB() */ /************************************************************************/ bool OGRGeometryToGDB(OGRwkbGeometryType ogrType, std::string *gdbType, bool *hasZ, bool *hasM) { *hasZ = wkbHasZ(ogrType); *hasM = wkbHasM(ogrType); switch (wkbFlatten(ogrType)) { case wkbPoint: { *gdbType = "esriGeometryPoint"; break; } case wkbMultiPoint: { *gdbType = "esriGeometryMultipoint"; break; } case wkbLineString: case wkbMultiLineString: { *gdbType = "esriGeometryPolyline"; break; } case wkbPolygon: case wkbMultiPolygon: { *gdbType = "esriGeometryPolygon"; break; } case wkbTIN: case wkbPolyhedralSurface: { *gdbType = "esriGeometryMultiPatch"; break; } default: { CPLError(CE_Failure, CPLE_AppDefined, "Cannot map OGRwkbGeometryType (%s) to ESRI type", OGRGeometryTypeToName(ogrType)); return false; } } return true; } /************************************************************************/ /* OGRToGDBFieldType() */ /************************************************************************/ bool OGRToGDBFieldType(OGRFieldType ogrType, OGRFieldSubType eSubType, std::string *gdbType) { switch (ogrType) { case OFTInteger: { if (eSubType == OFSTInt16) *gdbType = "esriFieldTypeSmallInteger"; else *gdbType = "esriFieldTypeInteger"; break; } case OFTReal: case OFTInteger64: { if (eSubType == OFSTFloat32) *gdbType = "esriFieldTypeSingle"; else *gdbType = "esriFieldTypeDouble"; break; } case OFTString: { *gdbType = "esriFieldTypeString"; break; } case OFTBinary: { *gdbType = "esriFieldTypeBlob"; break; } case OFTDate: case OFTDateTime: { *gdbType = "esriFieldTypeDate"; break; } default: { CPLError(CE_Warning, CPLE_AppDefined, "Cannot map OGR field type (%s)", OGR_GetFieldTypeName(ogrType)); return false; } } return true; } /************************************************************************/ /* GDBFieldTypeToLengthInBytes() */ /************************************************************************/ bool GDBFieldTypeToLengthInBytes(const std::string &gdbType, int &lengthOut) { /* Length based on * FileGDB_API/samples/XMLsamples/OneOfEachFieldType.xml */ /* Length is in bytes per doc of FileGDB_API/xmlResources/FileGDBAPI.xsd */ if (gdbType == "esriFieldTypeSmallInteger") { lengthOut = 2; } else if (gdbType == "esriFieldTypeInteger") { lengthOut = 4; } else if (gdbType == "esriFieldTypeSingle") { lengthOut = 4; } else if (gdbType == "esriFieldTypeDouble") { lengthOut = 8; } else if (gdbType == "esriFieldTypeString" || gdbType == "esriFieldTypeXML") { lengthOut = atoi(CPLGetConfigOption("FGDB_STRING_WIDTH", "65536")); } else if (gdbType == "esriFieldTypeDate") { lengthOut = 8; } else if (gdbType == "esriFieldTypeOID") { lengthOut = 4; } else if (gdbType == "esriFieldTypeGUID") { lengthOut = 16; } else if (gdbType == "esriFieldTypeBlob") { lengthOut = 0; } else if (gdbType == "esriFieldTypeGlobalID") { lengthOut = 38; } else { CPLError(CE_Warning, CPLE_AppDefined, "Cannot map ESRI field type (%s)", gdbType.c_str()); return false; } return true; } /************************************************************************/ /* GDBGeometryToOGRGeometry() */ /************************************************************************/ bool GDBGeometryToOGRGeometry(bool forceMulti, FileGDBAPI::ShapeBuffer *pGdbGeometry, OGRSpatialReference *pOGRSR, OGRGeometry **ppOutGeometry) { OGRGeometry *pOGRGeometry = nullptr; OGRErr eErr = OGRCreateFromShapeBin(pGdbGeometry->shapeBuffer, &pOGRGeometry, static_cast(pGdbGeometry->inUseLength)); // OGRErr eErr = // OGRGeometryFactory::createFromWkb(pGdbGeometry->shapeBuffer, pOGRSR, // &pOGRGeometry, pGdbGeometry->inUseLength ); if (eErr != OGRERR_NONE) { CPLError(CE_Failure, CPLE_AppDefined, "Failed attempting to import GDB WKB Geometry. " "OGRGeometryFactory err:%d", eErr); return false; } if (pOGRGeometry != nullptr) { // force geometries to multi if requested // If it is a polygon, force to MultiPolygon since we always produce // multipolygons OGRwkbGeometryType eFlattenType = wkbFlatten(pOGRGeometry->getGeometryType()); if (eFlattenType == wkbPolygon) { pOGRGeometry = OGRGeometryFactory::forceToMultiPolygon(pOGRGeometry); } else if (eFlattenType == wkbCurvePolygon) { OGRMultiSurface *poMS = new OGRMultiSurface(); poMS->addGeometryDirectly(pOGRGeometry); pOGRGeometry = poMS; } else if (forceMulti) { if (eFlattenType == wkbLineString) { pOGRGeometry = OGRGeometryFactory::forceToMultiLineString(pOGRGeometry); } else if (eFlattenType == wkbCompoundCurve) { OGRMultiCurve *poMC = new OGRMultiCurve(); poMC->addGeometryDirectly(pOGRGeometry); pOGRGeometry = poMC; } else if (eFlattenType == wkbPoint) { pOGRGeometry = OGRGeometryFactory::forceToMultiPoint(pOGRGeometry); } } if (pOGRGeometry) pOGRGeometry->assignSpatialReference(pOGRSR); } *ppOutGeometry = pOGRGeometry; return true; } /************************************************************************/ /* GDBToOGRSpatialReference() */ /************************************************************************/ bool GDBToOGRSpatialReference(const string &wkt, OGRSpatialReference **ppSR) { if (wkt.empty()) { CPLError(CE_Warning, CPLE_AppDefined, "ESRI Spatial Reference is NULL"); return false; } *ppSR = new OGRSpatialReference(wkt.c_str()); (*ppSR)->SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER); OGRErr result = (*ppSR)->morphFromESRI(); if (result == OGRERR_NONE) { if (CPLTestBool(CPLGetConfigOption("USE_OSR_FIND_MATCHES", "YES"))) { int nEntries = 0; int *panConfidence = nullptr; OGRSpatialReferenceH *pahSRS = (*ppSR)->FindMatches(nullptr, &nEntries, &panConfidence); if (nEntries == 1 && panConfidence[0] == 100) { (*ppSR)->Release(); (*ppSR) = reinterpret_cast(pahSRS[0]); (*ppSR)->SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER); CPLFree(pahSRS); } else { OSRFreeSRSArray(pahSRS); } CPLFree(panConfidence); } else { (*ppSR)->AutoIdentifyEPSG(); } return true; } else { delete *ppSR; *ppSR = nullptr; CPLError(CE_Failure, CPLE_AppDefined, "Failed morphing from ESRI Geometry: %s", wkt.c_str()); return false; } } /************************************************************************/ /* FGDB_CPLAddXMLAttribute() */ /************************************************************************/ /* Utility method for attributing nodes */ void FGDB_CPLAddXMLAttribute(CPLXMLNode *node, const char *attrname, const char *attrvalue) { if (!node) return; CPLCreateXMLNode(CPLCreateXMLNode(node, CXT_Attribute, attrname), CXT_Text, attrvalue); } /************************************************************************/ /* FGDBLaunderName() */ /************************************************************************/ std::wstring FGDBLaunderName(const std::wstring &name) { std::wstring newName = name; // https://support.esri.com/en/technical-article/000005588 // "Do not start field or table names with an underscore or a number." // But we can see in the wild table names starting with underscore... // (cf https://github.com/OSGeo/gdal/issues/4112) if (!newName.empty() && newName[0] >= '0' && newName[0] <= '9') { newName = StringToWString("_") + newName; } // "Essentially, eliminate anything that is not alphanumeric or an // underscore." Note: alphanumeric unicode is supported for (size_t i = 0; i < newName.size(); i++) { if (!(newName[i] == '_' || (newName[i] >= '0' && newName[i] <= '9') || (newName[i] >= 'a' && newName[i] <= 'z') || (newName[i] >= 'A' && newName[i] <= 'Z') || newName[i] >= 128)) { newName[i] = '_'; } } return newName; } /************************************************************************/ /* FGDBEscapeUnsupportedPrefixes() */ /************************************************************************/ std::wstring FGDBEscapeUnsupportedPrefixes(const std::wstring &className) { std::wstring newName = className; // From ESRI docs // Feature classes starting with these strings are unsupported. static const char *const UNSUPPORTED_PREFIXES[] = {"sde_", "gdb_", "delta_", nullptr}; for (int i = 0; UNSUPPORTED_PREFIXES[i] != nullptr; i++) { // cppcheck-suppress stlIfStrFind if (newName.find(StringToWString(UNSUPPORTED_PREFIXES[i])) == 0) { // Normally table names shouldn't start with underscore, but // there are such in the wild (cf // https://github.com/OSGeo/gdal/issues/4112) newName = StringToWString("_") + newName; break; } } return newName; } /************************************************************************/ /* FGDBEscapeReservedKeywords() */ /************************************************************************/ std::wstring FGDBEscapeReservedKeywords(const std::wstring &name) { std::string newName = WStringToString(name); std::string upperName = CPLString(newName).toupper(); // Append an underscore to any FGDB reserved words used as field names // This is the same behavior ArcCatalog follows. for (const char *pszKeyword : apszRESERVED_WORDS) { if (upperName == pszKeyword) { newName += '_'; break; } } return StringToWString(newName); }