src/share/grabbag/file.c

   1 /* grabbag - Convenience lib for various routines common to several tools
   2  * Copyright (C) 2002-2009  Josh Coalson
   3  * Copyright (C) 2011-2016  Xiph.Org Foundation
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  18  */
  19
  20 #ifdef HAVE_CONFIG_H
  21 #  include <config.h>
  22 #endif
  23
  24 #if defined _MSC_VER || defined __MINGW32__
  25 #include <sys/utime.h> /* for utime() */
  26 #include <io.h> /* for chmod(), _setmode(), unlink() */
  27 #include <fcntl.h> /* for _O_BINARY */
  28 #else
  29 #include <sys/types.h> /* some flavors of BSD (like OS X) require this to get time_t */
  30 #include <utime.h> /* for utime() */
  31 #endif
  32 #if defined __EMX__
  33 #include <io.h> /* for setmode(), O_BINARY */
  34 #include <fcntl.h> /* for _O_BINARY */
  35 #endif
  36 #include <sys/stat.h> /* for stat(), maybe chmod() */
  37 #if defined _WIN32 && !defined __CYGWIN__
  38 #else
  39 #include <unistd.h> /* for unlink() */
  40 #endif
  41 #include <stdio.h>
  42 #include <stdlib.h>
  43 #include <string.h> /* for strrchr() */
  44 #if defined _WIN32 && !defined __CYGWIN__
  45 // for GetFileInformationByHandle() etc
  46 #include <windows.h>
  47 #include <winbase.h>
  48 #endif
  49 #include "share/grabbag.h"
  50 #include "share/compat.h"
  51
  52
  53 void grabbag__file_copy_metadata(const char *srcpath, const char *destpath)
  54 {
  55         struct flac_stat_s srcstat;
  56         struct utimbuf srctime;
  57
  58         if(0 == flac_stat(srcpath, &srcstat)) {
  59                 srctime.actime = srcstat.st_atime;
  60                 srctime.modtime = srcstat.st_mtime;
  61                 (void)flac_chmod(destpath, srcstat.st_mode);
  62                 (void)flac_utime(destpath, &srctime);
  63         }
  64 }
  65
  66 FLAC__off_t grabbag__file_get_filesize(const char *srcpath)
  67 {
  68         struct flac_stat_s srcstat;
  69
  70         if(0 == flac_stat(srcpath, &srcstat))
  71                 return srcstat.st_size;
  72         else
  73                 return -1;
  74 }
  75
  76 const char *grabbag__file_get_basename(const char *srcpath)
  77 {
  78         const char *p;
  79
  80         p = strrchr(srcpath, '/');
  81         if(0 == p) {
  82                 p = strrchr(srcpath, '\\');
  83                 if(0 == p)
  84                         return srcpath;
  85         }
  86         return ++p;
  87 }
  88
  89 FLAC__bool grabbag__file_change_stats(const char *filename, FLAC__bool read_only)
  90 {
  91         struct flac_stat_s stats;
  92
  93         if(0 == flac_stat(filename, &stats)) {
  94 #if !defined _MSC_VER && !defined __MINGW32__
  95                 if(read_only) {
  96                         stats.st_mode &= ~S_IWUSR;
  97                         stats.st_mode &= ~S_IWGRP;
  98                         stats.st_mode &= ~S_IWOTH;
  99                 }
 100                 else {
 101                         stats.st_mode |= S_IWUSR;
 102                 }
 103 #else
 104                 if(read_only)
 105                         stats.st_mode &= ~S_IWRITE;
 106                 else
 107                         stats.st_mode |= S_IWRITE;
 108 #endif
 109                 if(0 != flac_chmod(filename, stats.st_mode))
 110                         return false;
 111         }
 112         else
 113                 return false;
 114
 115         return true;
 116 }
 117
 118 FLAC__bool grabbag__file_are_same(const char *f1, const char *f2)
 119 {
 120 #if defined _WIN32 && !defined __CYGWIN__
 121         /* see
 122          *  http://www.hydrogenaudio.org/forums/index.php?showtopic=49439&pid=444300&st=0
 123          *  http://msdn.microsoft.com/library/default.asp?url=/library/en-us/fileio/fs/getfileinformationbyhandle.asp
 124          *  http://msdn.microsoft.com/library/default.asp?url=/library/en-us/fileio/fs/by_handle_file_information_str.asp
 125          *  http://msdn.microsoft.com/library/default.asp?url=/library/en-us/fileio/fs/createfile.asp
 126          * apparently both the files have to be open at the same time for the comparison to work
 127          */
 128         FLAC__bool same = false;
 129         BY_HANDLE_FILE_INFORMATION info1, info2;
 130         HANDLE h1, h2;
 131         BOOL ok = 1;
 132         h1 = CreateFile_utf8(f1, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
 133         h2 = CreateFile_utf8(f2, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
 134         if(h1 == INVALID_HANDLE_VALUE || h2 == INVALID_HANDLE_VALUE)
 135                 ok = 0;
 136         ok &= GetFileInformationByHandle(h1, &info1);
 137         ok &= GetFileInformationByHandle(h2, &info2);
 138         if(ok)
 139                 same =
 140                         info1.dwVolumeSerialNumber == info2.dwVolumeSerialNumber &&
 141                         info1.nFileIndexHigh == info2.nFileIndexHigh &&
 142                         info1.nFileIndexLow == info2.nFileIndexLow
 143                 ;
 144         if(h1 != INVALID_HANDLE_VALUE)
 145                 CloseHandle(h1);
 146         if(h2 != INVALID_HANDLE_VALUE)
 147                 CloseHandle(h2);
 148         return same;
 149 #else
 150         struct flac_stat_s s1, s2;
 151         return f1 && f2 && flac_stat(f1, &s1) == 0 && flac_stat(f2, &s2) == 0 && s1.st_ino == s2.st_ino && s1.st_dev == s2.st_dev;
 152 #endif
 153 }
 154
 155 FLAC__bool grabbag__file_remove_file(const char *filename)
 156 {
 157         return grabbag__file_change_stats(filename, /*read_only=*/false) && 0 == flac_unlink(filename);
 158 }
 159
 160 FILE *grabbag__file_get_binary_stdin(void)
 161 {
 162         /* if something breaks here it is probably due to the presence or
 163          * absence of an underscore before the identifiers 'setmode',
 164          * 'fileno', and/or 'O_BINARY'; check your system header files.
 165          */
 166 #if defined _MSC_VER || defined __MINGW32__
 167         _setmode(_fileno(stdin), _O_BINARY);
 168 #elif defined __EMX__
 169         setmode(fileno(stdin), O_BINARY);
 170 #endif
 171
 172         return stdin;
 173 }
 174
 175 FILE *grabbag__file_get_binary_stdout(void)
 176 {
 177         /* if something breaks here it is probably due to the presence or
 178          * absence of an underscore before the identifiers 'setmode',
 179          * 'fileno', and/or 'O_BINARY'; check your system header files.
 180          */
 181 #if defined _MSC_VER || defined __MINGW32__
 182         _setmode(_fileno(stdout), _O_BINARY);
 183 #elif defined __EMX__
 184         setmode(fileno(stdout), O_BINARY);
 185 #endif
 186
 187         return stdout;
 188 }