fix netCdf derived driver if there is special char on the file name (…

…Windows) (#429)
lutraconsulting · Sep 18, 2022 · e397b50 · e397b50
1 parent 3d36908
commit e397b50
Show file tree

Hide file tree

Showing 5 changed files with 66 additions and 16 deletions.
diff --git a/mdal/frmts/mdal_netcdf.cpp b/mdal/frmts/mdal_netcdf.cpp
@@ -33,7 +33,7 @@ int NetCDFFile::handle() const
 
 void NetCDFFile::openFile( const std::string &fileName, bool write )
 {
-  int res = nc_open( fileName.c_str(), write ? NC_WRITE : NC_NOWRITE, &mNcid );
+  int res = nc_open( MDAL::systemFileName( fileName ).c_str(), write ? NC_WRITE : NC_NOWRITE, &mNcid );
   if ( res != NC_NOERR )
   {
     throw MDAL::Error( MDAL_Status::Err_UnknownFormat, "Could not open file " + fileName );
@@ -484,7 +484,7 @@ bool NetCDFFile::hasDimension( const std::string &name ) const
 
 void NetCDFFile::createFile( const std::string &fileName )
 {
-  int res = nc_create( fileName.c_str(), NC_CLOBBER, &mNcid );
+  int res = nc_create( MDAL::systemFileName( fileName ).c_str(), NC_CLOBBER, &mNcid );
   if ( res != NC_NOERR )
   {
     throw MDAL::Error( MDAL_Status::Err_FailToWriteToDisk, nc_strerror( res ) );

diff --git a/mdal/mdal_utils.cpp b/mdal/mdal_utils.cpp
@@ -16,10 +16,11 @@
 #include <ctime>
 #include <stdlib.h>
 
-#if defined _WIN32
+#ifdef _WIN32
 #define UNICODE
 #include <locale>
 #include <codecvt>
+#include <stringapiset.h>
 #endif
 
 std::string MDAL::getEnvVar( const std::string &varname, const std::string &defaultVal )
@@ -37,7 +38,7 @@ std::string MDAL::getEnvVar( const std::string &varname, const std::string &defa
 
 bool MDAL::openInputFile( std::ifstream &inputFileStream, const std::string &fileName, std::ios_base::openmode mode )
 {
-#if defined _MSC_VER
+#ifdef _WIN32
   std::wstring_convert< std::codecvt_utf8_utf16< wchar_t > > converter;
   std::wstring wStr = converter.from_bytes( fileName );
   inputFileStream.open( wStr, std::ifstream::in | mode );
@@ -52,7 +53,7 @@ std::ifstream MDAL::openInputFile( const std::string &fileName, std::ios_base::o
 {
   std::ifstream ret;
 
-#if defined _MSC_VER
+#ifdef _WIN32
   std::wstring_convert< std::codecvt_utf8_utf16< wchar_t > > converter;
   std::wstring wStr = converter.from_bytes( fileName );
   ret.open( wStr, mode );
@@ -67,7 +68,7 @@ std::ofstream MDAL::openOutputFile( const std::string &fileName, std::ios_base::
 {
   std::ofstream ret;
 
-#if defined _MSC_VER
+#ifdef _WIN32
   std::wstring_convert< std::codecvt_utf8_utf16< wchar_t > > converter;
   std::wstring wStr = converter.from_bytes( fileName );
   ret.open( wStr, mode );
@@ -262,7 +263,7 @@ std::string MDAL::fileExtension( const std::string &path )
 std::string MDAL::pathJoin( const std::string &path1, const std::string &path2 )
 {
 //https://stackoverflow.com/questions/6297738/how-to-build-a-full-path-string-safely-from-separate-strings#6297807
-#ifdef _MSC_VER
+#ifdef _WIN32
   return path1 + "\\" + path2;
 #else
   return path1 + "/" + path2;
@@ -291,7 +292,7 @@ bool MDAL::contains( const std::string &str, const std::string &substr, Contains
                 substr.begin(),   substr.end(),
                 []( char ch1, char ch2 )
     {
-#ifdef _MSC_VER
+#ifdef _WIN32
       return toupper( ch1 ) == toupper( ch2 );
 #else
       return std::toupper( ch1 ) == std::toupper( ch2 );
@@ -342,7 +343,7 @@ std::string MDAL::leftJustified( const std::string &str, size_t width, char fill
 std::string MDAL::toLower( const std::string &std )
 {
   std::string res( std );
-#ifdef WIN32
+#ifdef _WIN32
   //silence algorithm(1443): warning C4244: '=': conversion from 'int' to 'char'
   std::transform( res.begin(), res.end(), res.begin(),
   []( char c ) {return static_cast<char>( ::tolower( c ) );} );
@@ -400,6 +401,42 @@ std::string MDAL::trim( const std::string &s, const std::string &delimiters )
   return ltrim( rtrim( s, delimiters ), delimiters );
 }
 
+#ifdef _WIN32
+static std::string utf8ToWin32Recode( const std::string &utf8String )
+{
+  //from GDAL: ./port/cpl_recode_stub.cpp, CPLWin32Recode()
+
+  // Compute length in wide characters
+  int wlen = MultiByteToWideChar( CP_UTF8, 0, utf8String.c_str(), -1, nullptr, 0 );
+
+  // do the conversion to wide char
+  std::wstring wstr;
+  wstr.resize( MDAL::toSizeT( wlen ) + 1 );
+  wstr.data()[wlen] = 0;
+  MultiByteToWideChar( CP_UTF8, 0, utf8String.c_str(), -1, wstr.data(), wstr.size() );
+
+  int len = WideCharToMultiByte( CP_ACP, 0, wstr.c_str(), -1, nullptr, 0, nullptr, nullptr );
+
+  std::string ret;
+  ret.resize( MDAL::toSizeT( len ) + 1 );
+
+  WideCharToMultiByte( CP_ACP, 0, wstr.c_str(), -1, ret.data(), ret.size(), nullptr, nullptr );
+
+  return ret;
+}
+#endif
+
+std::string MDAL::systemFileName( const std::string &utf8FileName )
+{
+  std::string ret;
+#ifdef _WIN32
+  ret = utf8ToWin32Recode( utf8FileName );
+#else
+  ret = utf8FileName;
+#endif
+  return ret;
+}
+
 // http://www.cplusplus.com/faq/sequences/strings/trim/
 std::string MDAL::ltrim( const std::string &s, const std::string &delimiters )
 {
@@ -1041,7 +1078,7 @@ MDAL::Library::Library( std::string libraryFile )
 MDAL::Library::~Library()
 {
   d->mRef--;
-#ifdef WIN32
+#ifdef _WIN32
   if ( d->mLibrary &&  d->mRef == 0 )
     FreeLibrary( d->mLibrary );
 #else
@@ -1075,7 +1112,7 @@ bool MDAL::Library::isValid()
 std::vector<std::string> MDAL::Library::libraryFilesInDir( const std::string &dirPath )
 {
   std::vector<std::string> filesList;
-#if defined(WIN32)
+#ifdef _WIN32
   WIN32_FIND_DATA data;
   HANDLE hFind;
   std::string pattern = dirPath;
@@ -1120,7 +1157,7 @@ bool MDAL::Library::loadLibrary()
   //should we allow only one successful loading?
   if ( d->mLibrary )
     return false;
-#ifdef WIN32
+#ifdef _WIN32
   UINT uOldErrorMode =
     SetErrorMode( SEM_NOOPENFILEERRORBOX | SEM_FAILCRITICALERRORS );
   d->mLibrary = LoadLibrary( d->mLibraryFile.c_str() );

diff --git a/mdal/mdal_utils.hpp b/mdal/mdal_utils.hpp
@@ -15,7 +15,7 @@
 #include <cmath>
 #include <functional>
 
-#if defined (WIN32)
+#ifdef _WIN32
 #include <windows.h>
 #undef min
 #undef max
@@ -139,6 +139,9 @@ namespace MDAL
     const std::string &s,
     const std::string &delimiters = " \f\n\r\t\v" );
 
+  //! Returns a string file path encoded consistently with the system from a string encoded with UTF-8
+  std::string systemFileName( const std::string &utf8FileName );
+
   // extent
   BBox computeExtent( const Vertices &vertices );
 
@@ -277,7 +280,7 @@ namespace MDAL
       {
         if ( !isValid() )
           return std::function<T( Ts ... args )>();
-#ifdef WIN32
+#ifdef _WIN32
         FARPROC proc = GetProcAddress( d->mLibrary, symbolName.c_str() );
 
         if ( !proc )
@@ -308,7 +311,7 @@ namespace MDAL
     private:
       struct Data
       {
-#ifdef  WIN32
+#ifdef _WIN32
         HINSTANCE  mLibrary = nullptr;
 #else
         void *mLibrary = nullptr;

diff --git a/tests/data/ugrid/special@char/àeé.nc b/tests/data/ugrid/special@char/àeé.nc
diff --git a/tests/test_ugrid.cpp b/tests/test_ugrid.cpp
@@ -1,4 +1,4 @@
-/*
+/*
  MDAL - Mesh Data Abstraction Library (MIT License)
  Copyright (C) 2018 Peter Petrik (zilolv at gmail dot com)
 */
@@ -1170,6 +1170,16 @@ TEST( MeshUgridTest, unlockWhenClose )
   ASSERT_FALSE( fileExists( tmpUgridFile ) );
 }
 
+TEST( MeshUgridTest, SpecialChar )
+{
+  std::string path = test_file( u8"/ugrid/special@char/àeé.nc" );
+  EXPECT_EQ( MDAL_MeshNames( path.c_str() ), "Ugrid:\"" + path + "\":mesh1d;;Ugrid:\"" + path + "\":mesh2d" );
+  MDAL_MeshH m = MDAL_LoadMesh( path.c_str() );
+  ASSERT_NE( m, nullptr );
+
+  MDAL_CloseMesh( m );
+}
+
 int main( int argc, char **argv )
 {
   testing::InitGoogleTest( &argc, argv );