utility-private.h

Go to the documentation of this file.

/*
  Copyright 1999-2021 ImageMagick Studio LLC, a non-profit organization
  dedicated to making software imaging solutions freely available.
 
  You may not use this file except in compliance with the License.  You may
  obtain a copy of the License at
 
    https://imagemagick.org/script/license.php
 
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
 
  MagickCore private utility methods.
*/
#ifndef MAGICKCORE_UTILITY_PRIVATE_H
#define MAGICKCORE_UTILITY_PRIVATE_H
 
#include "magick/memory_.h"
#include "magick/nt-base.h"
#include "magick/nt-base-private.h"
 
#if defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif
 
#define MagickPathTemplate "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"  /* min 6 X's */
 
extern MagickPrivate MagickBooleanType
  ShredFile(const char *);
 
static inline int MagickReadDirectory(DIR *directory,struct dirent *entry,
  struct dirent **result)
{
#if defined(MAGICKCORE_HAVE_READDIR_R)
  return(readdir_r(directory,entry,result));
#else
  (void) entry;
  errno=0;
  *result=readdir(directory);
  return(errno);
#endif
}
 
/*
  Windows UTF8 compatibility methods.
*/
 
#if defined(MAGICKCORE_WINDOWS_SUPPORT)
static inline wchar_t *create_wchar_path(const char *utf8)
{
  int
    count;
 
  wchar_t
    *wideChar;
 
  count=MultiByteToWideChar(CP_UTF8,0,utf8,-1,NULL,0);
  if ((count > MAX_PATH) && (NTLongPathsEnabled() == MagickFalse))
    {
      char
        buffer[MaxTextExtent];
 
      wchar_t
        shortPath[MAX_PATH],
        *longPath;
 
      (void) FormatLocaleString(buffer,MaxTextExtent,"\\\\?\\%s",utf8);
      count+=4;
      longPath=(wchar_t *) AcquireQuantumMemory(count,sizeof(*longPath));
      if (longPath == (wchar_t *) NULL)
        return((wchar_t *) NULL);
      count=MultiByteToWideChar(CP_UTF8,0,buffer,-1,longPath,count);
      if (count != 0)
        count=GetShortPathNameW(longPath,shortPath,MAX_PATH);
      longPath=(wchar_t *) RelinquishMagickMemory(longPath);
      if ((count < 5) || (count >= MAX_PATH))
        return((wchar_t *) NULL);
      wideChar=(wchar_t *) AcquireQuantumMemory(count-3,sizeof(*wideChar));
      wcscpy(wideChar,shortPath+4);
      return(wideChar);
    }
  wideChar=(wchar_t *) AcquireQuantumMemory(count,sizeof(*wideChar));
  if (wideChar == (wchar_t *) NULL)
    return((wchar_t *) NULL);
  count=MultiByteToWideChar(CP_UTF8,0,utf8,-1,wideChar,count);
  if (count == 0)
    {
      wideChar=(wchar_t *) RelinquishMagickMemory(wideChar);
      return((wchar_t *) NULL);
    }
  return(wideChar);
}
#endif
 
static inline int access_utf8(const char *path,int mode)
{
#if !defined(MAGICKCORE_WINDOWS_SUPPORT) || defined(__CYGWIN__)
  return(access(path,mode));
#else
   int
     status;
 
   wchar_t
     *path_wide;
 
   path_wide=create_wchar_path(path);
   if (path_wide == (wchar_t *) NULL)
     return(-1);
   status=_waccess(path_wide,mode);
   path_wide=(wchar_t *) RelinquishMagickMemory(path_wide);
   return(status);
#endif
}
 
#if defined(MAGICKCORE_WINDOWS_SUPPORT) && !defined(__CYGWIN__)
#define close_utf8 _close
#else
#define close_utf8 close
#endif
 
static inline FILE *fopen_utf8(const char *path,const char *mode)
{
#if !defined(MAGICKCORE_WINDOWS_SUPPORT) || defined(__CYGWIN__)
  return(fopen(path,mode));
#else
   FILE
     *file;
 
   wchar_t
     *mode_wide,
     *path_wide;
 
   path_wide=create_wchar_path(path);
   if (path_wide == (wchar_t *) NULL)
     return((FILE *) NULL);
   mode_wide=create_wchar_path(mode);
   if (mode_wide == (wchar_t *) NULL)
     {
       path_wide=(wchar_t *) RelinquishMagickMemory(path_wide);
       return((FILE *) NULL);
     }
   file=_wfopen(path_wide,mode_wide);
   mode_wide=(wchar_t *) RelinquishMagickMemory(mode_wide);
   path_wide=(wchar_t *) RelinquishMagickMemory(path_wide);
   return(file);
#endif
}
 
static inline void getcwd_utf8(char *path,size_t extent)
{
#if !defined(MAGICKCORE_WINDOWS_SUPPORT) || defined(__CYGWIN__)
  char
    *directory;
 
   directory=getcwd(path,extent);
   (void) directory;
#else
  wchar_t
    wide_path[MaxTextExtent];
 
  (void) _wgetcwd(wide_path,MaxTextExtent-1);
  (void) WideCharToMultiByte(CP_UTF8,0,wide_path,-1,path,(int) extent,NULL,NULL);
#endif
}
 
#if defined(MAGICKCORE_WINDOWS_SUPPORT) && !defined(__CYGWIN__) && !defined(__MINGW32__)
typedef int
  mode_t;
#endif
 
static inline int open_utf8(const char *path,int flags,mode_t mode)
{
#if !defined(MAGICKCORE_WINDOWS_SUPPORT) || defined(__CYGWIN__)
  return(open(path,flags,mode));
#else
   int
     status;
 
   wchar_t
     *path_wide;
 
   path_wide=create_wchar_path(path);
   if (path_wide == (wchar_t *) NULL)
     return(-1);
   status=_wopen(path_wide,flags,mode);
   path_wide=(wchar_t *) RelinquishMagickMemory(path_wide);
   return(status);
#endif
}
 
static inline FILE *popen_utf8(const char *command,const char *type)
{
#if !defined(MAGICKCORE_WINDOWS_SUPPORT) || defined(__CYGWIN__)
  return(popen(command,type));
#else
  FILE
    *file;
 
  int
    length;
 
  wchar_t
    *command_wide,
    type_wide[5];
 
  file=(FILE *) NULL;
  length=MultiByteToWideChar(CP_UTF8,0,type,-1,type_wide,5);
  if (length == 0)
    return(file);
  length=MultiByteToWideChar(CP_UTF8,0,command,-1,NULL,0);
  if (length == 0)
    return(file);
  command_wide=(wchar_t *) AcquireQuantumMemory(length,sizeof(*command_wide));
  if (command_wide == (wchar_t *) NULL)
    return(file);
  length=MultiByteToWideChar(CP_UTF8,0,command,-1,command_wide,length);
  if (length != 0)
    file=_wpopen(command_wide,type_wide);
  command_wide=(wchar_t *) RelinquishMagickMemory(command_wide);
  return(file);
#endif
}
 
static inline char *realpath_utf8(const char *path)
{
#if !defined(MAGICKCORE_WINDOWS_SUPPORT) || defined(__CYGWIN__)
#if defined(MAGICKCORE_HAVE_REALPATH)
  return(realpath(path,(char *) NULL));
#else
  return(AcquireString(path));
#endif
#else
  char
    *real_path;
 
  DWORD
    final_path_length,
    full_path_length;
 
  HANDLE
    file_handle;
 
  int
    length,
    utf8_length,
 
  wchar_t
    *clean_path,
    *final_path,
    *full_path,
    *wide_path;
 
  /*
    Convert UTF-8 to UTF-16.
  */
  if (path == (const char *) NULL)
    return((char *) NULL);
  length=MultiByteToWideChar(CP_UTF8,0,path,-1,NULL,0);
  if (length <= 0)
    return((char *) NULL);
  wide_path=(wchar_t *) AcquireQuantumMeory(length,sizeof(wchar_t));
  if (wide_path == (wchar_t *) NULL)
    return((char *) NULL);
  MultiByteToWideChar(CP_UTF8,0,path,-1,wide_path,length);
  /*
    Normalize syntactically.
  */
  full_path_length=GetFullPathNameW(wide_path,0,NULL,NULL);
  if (full_path_length == 0)
    {
      wide_path=(wchar_t *) RelinquishMagickMemory(wide_path);
      return((char *) NULL);
    }
  full_path=(wchar_t *) AcquireQuantumMemory(full_path_length,sizeof(wchar_t));
  if (full_path == (wchar_t *) NULL);
    {
      wide_path=(wchar_t *) RelinquishMagickMemory(wide_path);
      return((char *) NULL);
    }
  GetFullPathNameW(wide_path,full_path_length,full_path,NULL);
  wide_path=(wchar_t *) RelinquishMagickMemory(wide_path);
  /*
    Open the file/directory to resolve symlinks.
  */
  file_handle=CreateFileW(full_path,GENERIC_READ,FILE_SHARE_READ |
    FILE_SHARE_WRITE | FILE_SHARE_DELETE,NULL,OPEN_EXISTING,
    FILE_FLAG_BACKUP_SEMANTICS,NULL);
  if (file_handle == INVALID_HANDLE_VALUE)
    {
      full_path=(wchar_t *) RelinquishMagickMemory(full_path);
      return((char *) NULL);
    }
  /*
    Resolve final canonical path.
  */
  final_path_length=GetFinalPathNameByHandleW(file_handle,NULL,0,
    FILE_NAME_NORMALIZED);
  if (final_path_length == 0)
    {
      CloseHandle(file_handle);
      full_path=(wchar_t *) RelinquishMagickMemory(full_path);
      return((char *) NULL);
    }
  final_path=(wchar_t *) AcquireQuantumMemory(final_path_length,
    sizeof(wchar_t));
  if (final_path == (wchar_t *) NULL)
    {
      CloseHandle(file_handle);
      full_path=(wchar_t *) RelinquishMagickMemory(full_path);
      return((char *) NULL);
    }
  GetFinalPathNameByHandleW(file_handle,final_path,final_path_length,
    FILE_NAME_NORMALIZED);
  CloseHandle(file_handle);
  full_path=(wchar_t *) RelinquishMagickMemory(full_path);
  /*
    Remove \\?\ prefix for POSIX-like behavior.
  */
  clean_path=final_path;
  if (wcsncmp(final_path,L"\\\\?\\",4) == 0)
    clean_path=final_path+4;
  /*
    Convert UTF-16 to UTF-8.
  */
  utf8_length=WideCharToMultiByte(CP_UTF8,0,clean_path,-1,NULL,0,NULL,NULL);
  if (utf8_length <= 0)
    {
      final_path=(wchar_t *) RelinquishMagickMemory(final_path);
      return NULL;
    }
  real_path=(char *) AcquireQuantumMemory(utf8_length,sizeof(char));
  if (real_path == (char *) NULL)
    {
      final_path=(wchar_t *) RelinquishMagickMemory(final_path);
      return NULL;
    }
  WideCharToMultiByte(CP_UTF8,0,clean_path,-1,real_path,utf8_length,NULL,NULL);
  final_path=(wchar_t *) RelinquishMagickMemory(final_path);
  return(real_path);
#endif
}
 
static inline int remove_utf8(const char *path)
{
#if !defined(MAGICKCORE_WINDOWS_SUPPORT) || defined(__CYGWIN__)
  return(unlink(path));
#else
   int
     status;
 
   wchar_t
     *path_wide;
 
   path_wide=create_wchar_path(path);
   if (path_wide == (wchar_t *) NULL)
     return(-1);
   status=_wremove(path_wide);
   path_wide=(wchar_t *) RelinquishMagickMemory(path_wide);
   return(status);
#endif
}
 
static inline int rename_utf8(const char *source,const char *destination)
{
#if !defined(MAGICKCORE_WINDOWS_SUPPORT) || defined(__CYGWIN__)
  return(rename(source,destination));
#else
   int
     status;
 
   wchar_t
     *destination_wide,
     *source_wide;
 
   source_wide=create_wchar_path(source);
   if (source_wide == (wchar_t *) NULL)
     return(-1);
   destination_wide=create_wchar_path(destination);
   if (destination_wide == (wchar_t *) NULL)
     {
       source_wide=(wchar_t *) RelinquishMagickMemory(source_wide);
       return(-1);
     }
   status=_wrename(source_wide,destination_wide);
   destination_wide=(wchar_t *) RelinquishMagickMemory(destination_wide);
   source_wide=(wchar_t *) RelinquishMagickMemory(source_wide);
   return(status);
#endif
}
 
static inline int stat_utf8(const char *path,struct stat *attributes)
{
#if !defined(MAGICKCORE_WINDOWS_SUPPORT) || defined(__CYGWIN__)
  return(stat(path,attributes));
#else
   int
     status;
 
   wchar_t
     *path_wide;
 
   path_wide=create_wchar_path(path);
   if (path_wide == (WCHAR *) NULL)
     return(-1);
   status=wstat(path_wide,attributes);
   path_wide=(WCHAR *) RelinquishMagickMemory(path_wide);
   return(status);
#endif
}
 
static inline MagickBooleanType is_symlink_utf8(const char *path)
{
#if !defined(MAGICKCORE_WINDOWS_SUPPORT) || defined(__CYGWIN__)
#if defined(MAGICKCORE_POSIX_SUPPORT)
  struct stat
    status;
 
  if (lstat(path,&status) == -1)
    return(MagickFalse);
  return(S_ISLNK(status.st_mode) != 0 ? MagickTrue : MagickFalse);
#else
  return(MagickFalse);
#endif
#else
 return(NTIsSymlinkWide(path));
#endif
}
 
 
#if defined(__cplusplus) || defined(c_plusplus)
}
#endif
 
#endif