git.sesse.net Git - vlc/blob - src/text/filesystem.c

   1 /*****************************************************************************
   2  * filesystem.c: File system helpers
   3  *****************************************************************************
   4  * Copyright (C) 2005-2006 the VideoLAN team
   5  * Copyright © 2005-2008 Rémi Denis-Courmont
   6  *
   7  * Authors: Rémi Denis-Courmont <rem # videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <vlc_common.h>
  32 #include <vlc_charset.h>
  33 #include <vlc_fs.h>
  34 #include "libvlc.h" /* vlc_mkdir */
  35 #include <vlc_rand.h>
  36
  37 #include <assert.h>
  38
  39 #include <stdio.h>
  40 #include <errno.h>
  41 #include <sys/types.h>
  42 #ifdef HAVE_DIRENT_H
  43 #  include <dirent.h>
  44 #endif
  45 #ifdef UNDER_CE
  46 #  include <tchar.h>
  47 #endif
  48 #ifdef HAVE_SYS_STAT_H
  49 # include <sys/stat.h>
  50 #endif
  51 #ifdef HAVE_FCNTL_H
  52 # include <fcntl.h>
  53 #endif
  54 #ifdef WIN32
  55 # include <io.h>
  56 # ifndef UNDER_CE
  57 #  include <direct.h>
  58 # endif
  59 #else
  60 # include <unistd.h>
  61 #endif
  62
  63 #ifndef HAVE_LSTAT
  64 # define lstat( a, b ) stat(a, b)
  65 #endif
  66
  67 #ifdef WIN32
  68 static int convert_path (const char *restrict path, wchar_t *restrict wpath)
  69 {
  70     if (!MultiByteToWideChar (CP_UTF8, 0, path, -1, wpath, MAX_PATH))
  71     {
  72         errno = ENOENT;
  73         return -1;
  74     }
  75     wpath[MAX_PATH] = L'\0';
  76     return 0;
  77 }
  78 # define CONVERT_PATH(path, wpath, err) \
  79   wchar_t wpath[MAX_PATH+1]; \
  80   if (convert_path (path, wpath)) \
  81       return (err)
  82 #endif
  83
  84 /**
  85  * Opens a system file handle.
  86  *
  87  * @param filename file path to open (with UTF-8 encoding)
  88  * @param flags open() flags, see the C library open() documentation
  89  * @return a file handle on success, -1 on error (see errno).
  90  * @note Contrary to standard open(), this function returns file handles
  91  * with the close-on-exec flag enabled.
  92  */
  93 int vlc_open (const char *filename, int flags, ...)
  94 {
  95     unsigned int mode = 0;
  96     va_list ap;
  97
  98     va_start (ap, flags);
  99     if (flags & O_CREAT)
 100         mode = va_arg (ap, unsigned int);
 101     va_end (ap);
 102
 103 #ifdef O_CLOEXEC
 104     flags |= O_CLOEXEC;
 105 #endif
 106
 107 #ifdef UNDER_CE
 108     /*_open translates to wchar internally on WinCE*/
 109     return _open (filename, flags, mode);
 110 #elif defined (WIN32)
 111     /*
 112      * open() cannot open files with non-“ANSI” characters on Windows.
 113      * We use _wopen() instead. Same thing for mkdir() and stat().
 114      */
 115     CONVERT_PATH(filename, wpath, -1);
 116     return _wopen (wpath, flags, mode);
 117
 118 #endif
 119     const char *local_name = ToLocale (filename);
 120
 121     if (local_name == NULL)
 122     {
 123         errno = ENOENT;
 124         return -1;
 125     }
 126
 127     int fd = open (local_name, flags, mode);
 128 #ifdef HAVE_FCNTL
 129     if (fd != -1)
 130         fcntl (fd, F_SETFD, FD_CLOEXEC);
 131 #endif
 132
 133     LocaleFree (local_name);
 134     return fd;
 135 }
 136
 137 /**
 138  * Opens a FILE pointer.
 139  * @param filename file path, using UTF-8 encoding
 140  * @param mode fopen file open mode
 141  * @return NULL on error, an open FILE pointer on success.
 142  */
 143 FILE *vlc_fopen (const char *filename, const char *mode)
 144 {
 145     int rwflags = 0, oflags = 0;
 146     bool append = false;
 147
 148     for (const char *ptr = mode; *ptr; ptr++)
 149     {
 150         switch (*ptr)
 151         {
 152             case 'r':
 153                 rwflags = O_RDONLY;
 154                 break;
 155
 156             case 'a':
 157                 rwflags = O_WRONLY;
 158                 oflags |= O_CREAT;
 159                 append = true;
 160                 break;
 161
 162             case 'w':
 163                 rwflags = O_WRONLY;
 164                 oflags |= O_CREAT | O_TRUNC;
 165                 break;
 166
 167             case '+':
 168                 rwflags = O_RDWR;
 169                 break;
 170
 171 #ifdef O_TEXT
 172             case 't':
 173                 oflags |= O_TEXT;
 174                 break;
 175 #endif
 176         }
 177     }
 178
 179     int fd = vlc_open (filename, rwflags | oflags, 0666);
 180     if (fd == -1)
 181         return NULL;
 182
 183     if (append && (lseek (fd, 0, SEEK_END) == -1))
 184     {
 185         close (fd);
 186         return NULL;
 187     }
 188
 189     FILE *stream = fdopen (fd, mode);
 190     if (stream == NULL)
 191         close (fd);
 192
 193     return stream;
 194 }
 195
 196 /**
 197  * Opens a system file handle relative to an existing directory handle.
 198  *
 199  * @param dir directory file descriptor
 200  * @param filename file path to open (with UTF-8 encoding)
 201  * @param flags open() flags, see the C library open() documentation
 202  * @return a file handle on success, -1 on error (see errno).
 203  * @note Contrary to standard open(), this function returns file handles
 204  * with the close-on-exec flag enabled.
 205  */
 206 int vlc_openat (int dir, const char *filename, int flags, ...)
 207 {
 208     unsigned int mode = 0;
 209     va_list ap;
 210
 211     va_start (ap, flags);
 212     if (flags & O_CREAT)
 213         mode = va_arg (ap, unsigned int);
 214     va_end (ap);
 215
 216 #ifdef O_CLOEXEC
 217     flags |= O_CLOEXEC;
 218 #endif
 219
 220     const char *local_name = ToLocale (filename);
 221     if (local_name == NULL)
 222     {
 223         errno = ENOENT;
 224         return -1;
 225     }
 226
 227 #ifdef HAVE_FDOPENDIR
 228     int fd = openat (dir, local_name, flags, mode);
 229 # ifdef HAVE_FCNTL
 230     if (fd != -1)
 231         fcntl (fd, F_SETFD, FD_CLOEXEC);
 232 # endif
 233 #else
 234     int fd = -1;
 235     errno = ENOSYS;
 236 #endif
 237
 238     LocaleFree (local_name);
 239     return fd;
 240 }
 241
 242
 243 /**
 244  * Creates a directory using UTF-8 paths.
 245  *
 246  * @param dirname a UTF-8 string with the name of the directory that you
 247  *        want to create.
 248  * @param mode directory permissions
 249  * @return 0 on success, -1 on error (see errno).
 250  */
 251 int vlc_mkdir( const char *dirname, mode_t mode )
 252 {
 253 #if defined (UNDER_CE)
 254     (void) mode;
 255     /* mkdir converts internally to wchar */
 256     return _mkdir(dirname);
 257 #elif defined (WIN32)
 258     (void) mode;
 259     CONVERT_PATH (dirname, wpath, -1);
 260     return _wmkdir (wpath);
 261
 262 #else
 263     char *locname = ToLocale( dirname );
 264     int res;
 265
 266     if( locname == NULL )
 267     {
 268         errno = ENOENT;
 269         return -1;
 270     }
 271     res = mkdir( locname, mode );
 272
 273     LocaleFree( locname );
 274     return res;
 275 #endif
 276 }
 277
 278 /**
 279  * Opens a DIR pointer.
 280  *
 281  * @param dirname UTF-8 representation of the directory name
 282  * @return a pointer to the DIR struct, or NULL in case of error.
 283  * Release with standard closedir().
 284  */
 285 DIR *vlc_opendir( const char *dirname )
 286 {
 287 #ifdef WIN32
 288     CONVERT_PATH (dirname, wpath, NULL);
 289     return (DIR *)vlc_wopendir (wpath);
 290
 291 #else
 292     const char *local_name = ToLocale( dirname );
 293
 294     if( local_name != NULL )
 295     {
 296         DIR *dir = opendir( local_name );
 297         LocaleFree( local_name );
 298         return dir;
 299     }
 300 #endif
 301
 302     errno = ENOENT;
 303     return NULL;
 304 }
 305
 306 /**
 307  * Reads the next file name from an open directory.
 308  *
 309  * @param dir The directory that is being read
 310  *
 311  * @return a UTF-8 string of the directory entry.
 312  * Use free() to free this memory.
 313  */
 314 char *vlc_readdir( DIR *dir )
 315 {
 316 #ifdef WIN32
 317     struct _wdirent *ent = vlc_wreaddir (dir);
 318     if (ent == NULL)
 319         return NULL;
 320
 321     return FromWide (ent->d_name);
 322 #else
 323     struct dirent *ent;
 324
 325     ent = readdir( (DIR *)dir );
 326     if( ent == NULL )
 327         return NULL;
 328
 329     return vlc_fix_readdir( ent->d_name );
 330 #endif
 331 }
 332
 333 static int dummy_select( const char *str )
 334 {
 335     (void)str;
 336     return 1;
 337 }
 338
 339 /**
 340  * Does the same as vlc_scandir(), but takes an open directory pointer
 341  * instead of a directory path.
 342  */
 343 int vlc_loaddir( DIR *dir, char ***namelist,
 344                   int (*select)( const char * ),
 345                   int (*compar)( const char **, const char ** ) )
 346 {
 347     if( select == NULL )
 348         select = dummy_select;
 349
 350     if( dir == NULL )
 351         return -1;
 352     else
 353     {
 354         char **tab = NULL;
 355         char *entry;
 356         unsigned num = 0;
 357
 358         rewinddir( dir );
 359
 360         while( ( entry = vlc_readdir( dir ) ) != NULL )
 361         {
 362             char **newtab;
 363
 364             if( !select( entry ) )
 365             {
 366                 free( entry );
 367                 continue;
 368             }
 369
 370             newtab = realloc( tab, sizeof( char * ) * (num + 1) );
 371             if( newtab == NULL )
 372             {
 373                 free( entry );
 374                 goto error;
 375             }
 376             tab = newtab;
 377             tab[num++] = entry;
 378         }
 379
 380         if( compar != NULL )
 381             qsort( tab, num, sizeof( tab[0] ),
 382                    (int (*)( const void *, const void *))compar );
 383
 384         *namelist = tab;
 385         return num;
 386
 387     error:{
 388         unsigned i;
 389
 390         for( i = 0; i < num; i++ )
 391             free( tab[i] );
 392         free( tab );
 393         }
 394     }
 395     return -1;
 396 }
 397
 398 /**
 399  * Selects file entries from a directory, as GNU C scandir().
 400  *
 401  * @param dirname UTF-8 diretory path
 402  * @param pointer [OUT] pointer set, on succesful completion, to the address
 403  * of a table of UTF-8 filenames. All filenames must be freed with free().
 404  * The table itself must be freed with free() as well.
 405  *
 406  * @return How many file names were selected (possibly 0),
 407  * or -1 in case of error.
 408  */
 409 int vlc_scandir( const char *dirname, char ***namelist,
 410                   int (*select)( const char * ),
 411                   int (*compar)( const char **, const char ** ) )
 412 {
 413     DIR *dir = vlc_opendir (dirname);
 414     int val = -1;
 415
 416     if (dir != NULL)
 417     {
 418         val = vlc_loaddir (dir, namelist, select, compar);
 419         closedir (dir);
 420     }
 421     return val;
 422 }
 423
 424 static int vlc_statEx( const char *filename, struct stat *buf,
 425                         bool deref )
 426 {
 427 #ifdef UNDER_CE
 428     /*_stat translates to wchar internally on WinCE*/
 429     return _stat( filename, buf );
 430 #elif defined (WIN32)
 431     CONVERT_PATH (filename, wpath, -1);
 432     return _wstati64 (wpath, buf);
 433
 434 #endif
 435 #ifdef HAVE_SYS_STAT_H
 436     const char *local_name = ToLocale( filename );
 437
 438     if( local_name != NULL )
 439     {
 440         int res = deref ? stat( local_name, buf )
 441                        : lstat( local_name, buf );
 442         LocaleFree( local_name );
 443         return res;
 444     }
 445     errno = ENOENT;
 446 #endif
 447     return -1;
 448 }
 449
 450 /**
 451  * Finds file/inode informations, as stat().
 452  * Consider using fstat() instead, if possible.
 453  *
 454  * @param filename UTF-8 file path
 455  */
 456 int vlc_stat( const char *filename, struct stat *buf)
 457 {
 458     return vlc_statEx( filename, buf, true );
 459 }
 460
 461 /**
 462  * Finds file/inode informations, as lstat().
 463  * Consider using fstat() instead, if possible.
 464  *
 465  * @param filename UTF-8 file path
 466  */
 467 int utf8_lstat( const char *filename, struct stat *buf)
 468 {
 469     return vlc_statEx( filename, buf, false );
 470 }
 471
 472 /**
 473  * Removes a file.
 474  *
 475  * @param filename a UTF-8 string with the name of the file you want to delete.
 476  * @return A 0 return value indicates success. A -1 return value indicates an
 477  *        error, and an error code is stored in errno
 478  */
 479 int vlc_unlink( const char *filename )
 480 {
 481 #ifdef UNDER_CE
 482     /*_open translates to wchar internally on WinCE*/
 483     return _unlink( filename );
 484 #elif defined (WIN32)
 485     CONVERT_PATH (filename, wpath, -1);
 486     return _wunlink (wpath);
 487
 488 #endif
 489     const char *local_name = ToLocale( filename );
 490
 491     if( local_name == NULL )
 492     {
 493         errno = ENOENT;
 494         return -1;
 495     }
 496
 497     int ret = unlink( local_name );
 498     LocaleFree( local_name );
 499     return ret;
 500 }
 501
 502 /**
 503  * Moves a file atomically. This only works within a single file system.
 504  *
 505  * @param oldpath path to the file before the move
 506  * @param newpath intended path to the file after the move
 507  * @return A 0 return value indicates success. A -1 return value indicates an
 508  *        error, and an error code is stored in errno
 509  */
 510 int vlc_rename (const char *oldpath, const char *newpath)
 511 {
 512 #if defined (WIN32)
 513     CONVERT_PATH (oldpath, wold, -1);
 514     CONVERT_PATH (newpath, wnew, -1);
 515 # ifdef UNDER_CE
 516     /* FIXME: errno support */
 517     if (MoveFileW (wold, wnew))
 518         return 0;
 519     else
 520         return -1;
 521 #else
 522     return _wrename (wold, wnew);
 523 #endif
 524
 525 #endif
 526     const char *lo = ToLocale (oldpath);
 527     if (lo == NULL)
 528         goto error;
 529
 530     const char *ln = ToLocale (newpath);
 531     if (ln == NULL)
 532     {
 533         LocaleFree (lo);
 534 error:
 535         errno = ENOENT;
 536         return -1;
 537     }
 538
 539     int ret = rename (lo, ln);
 540     LocaleFree (lo);
 541     LocaleFree (ln);
 542     return ret;
 543 }
 544
 545 int vlc_mkstemp( char *template )
 546 {
 547     static const char digits[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
 548     static const int i_digits = sizeof(digits)/sizeof(*digits) - 1;
 549
 550     /* */
 551     assert( template );
 552
 553     /* Check template validity */
 554     const size_t i_length = strlen( template );
 555     char *psz_rand = &template[i_length-6];
 556
 557     if( i_length < 6 || strcmp( psz_rand, "XXXXXX" ) )
 558     {
 559         errno = EINVAL;
 560         return -1;
 561     }
 562
 563     /* */
 564     for( int i = 0; i < 256; i++ )
 565     {
 566         /* Create a pseudo random file name */
 567         uint8_t pi_rand[6];
 568
 569         vlc_rand_bytes( pi_rand, sizeof(pi_rand) );
 570         for( int j = 0; j < 6; j++ )
 571             psz_rand[j] = digits[pi_rand[j] % i_digits];
 572
 573         /* */
 574         int fd = vlc_open( template, O_CREAT | O_EXCL | O_RDWR, 0600 );
 575         if( fd >= 0 )
 576             return fd;
 577         if( errno != EEXIST )
 578             return -1;
 579     }
 580
 581     errno = EEXIST;
 582     return -1;
 583 }
 584
 585 #ifdef UNDER_CE
 586 # define dup(fd) (fd, -1)
 587 #endif
 588
 589 /**
 590  * Duplicates a file descriptor. The new file descriptor has the close-on-exec
 591  * descriptor flag set.
 592  * @return a new file descriptor or -1
 593  */
 594 int vlc_dup (int oldfd)
 595 {
 596     int newfd;
 597
 598 #ifdef HAVE_DUP3
 599     /* Unfortunately, dup3() works like dup2(), not like plain dup(). So we
 600      * need such contortion to find the new file descriptor while preserving
 601      * thread safety of the file descriptor table. */
 602     newfd = vlc_open ("/dev/null", O_RDONLY);
 603     if (likely(newfd != -1))
 604     {
 605         if (likely(dup3 (oldfd, newfd, O_CLOEXEC) == newfd))
 606             return newfd;
 607         close (newfd);
 608     }
 609 #endif
 610
 611     newfd = dup (oldfd);
 612 #ifdef HAVE_FCNTL
 613     if (likely(newfd != -1))
 614         fcntl (newfd, F_SETFD, FD_CLOEXEC);
 615 #endif
 616     return newfd;
 617 }