1 /*****************************************************************************
2 * filesystem.c: File system helpers
3 *****************************************************************************
4 * Copyright (C) 2005-2006 the VideoLAN team
5 * Copyright © 2005-2008 Rémi Denis-Courmont
7 * Authors: Rémi Denis-Courmont <rem # videolan.org>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
31 #include <vlc_common.h>
32 #include <vlc_charset.h>
34 #include "libvlc.h" /* vlc_mkdir */
40 #include <limits.h> /* NAME_MAX */
42 #include <sys/types.h>
44 #ifdef HAVE_SYS_STAT_H
45 # include <sys/stat.h>
52 # include <winsock2.h>
60 # include <sys/socket.h>
64 # define lstat( a, b ) stat(a, b)
68 static int convert_path (const char *restrict path, wchar_t *restrict wpath)
70 if (!MultiByteToWideChar (CP_UTF8, 0, path, -1, wpath, MAX_PATH))
75 wpath[MAX_PATH] = L'\0';
78 # define CONVERT_PATH(path, wpath, err) \
79 wchar_t wpath[MAX_PATH+1]; \
80 if (convert_path (path, wpath)) \
85 * Opens a system file handle.
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.
93 int vlc_open (const char *filename, int flags, ...)
95 unsigned int mode = 0;
100 mode = va_arg (ap, unsigned int);
108 /*_open translates to wchar internally on WinCE*/
109 return _open (filename, flags, mode);
110 #elif defined (WIN32)
112 * open() cannot open files with non-“ANSI” characters on Windows.
113 * We use _wopen() instead. Same thing for mkdir() and stat().
115 CONVERT_PATH(filename, wpath, -1);
116 return _wopen (wpath, flags, mode);
119 const char *local_name = ToLocale (filename);
121 if (local_name == NULL)
127 int fd = open (local_name, flags, mode);
130 fcntl (fd, F_SETFD, FD_CLOEXEC);
133 LocaleFree (local_name);
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.
143 FILE *vlc_fopen (const char *filename, const char *mode)
145 int rwflags = 0, oflags = 0;
148 for (const char *ptr = mode; *ptr; ptr++)
164 oflags |= O_CREAT | O_TRUNC;
179 int fd = vlc_open (filename, rwflags | oflags, 0666);
183 if (append && (lseek (fd, 0, SEEK_END) == -1))
189 FILE *stream = fdopen (fd, mode);
197 * Opens a system file handle relative to an existing directory handle.
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.
206 int vlc_openat (int dir, const char *filename, int flags, ...)
208 unsigned int mode = 0;
211 va_start (ap, flags);
213 mode = va_arg (ap, unsigned int);
220 const char *local_name = ToLocale (filename);
221 if (local_name == NULL)
228 int fd = openat (dir, local_name, flags, mode);
231 fcntl (fd, F_SETFD, FD_CLOEXEC);
238 LocaleFree (local_name);
244 * Creates a directory using UTF-8 paths.
246 * @param dirname a UTF-8 string with the name of the directory that you
248 * @param mode directory permissions
249 * @return 0 on success, -1 on error (see errno).
251 int vlc_mkdir( const char *dirname, mode_t mode )
253 #if defined (UNDER_CE)
255 /* mkdir converts internally to wchar */
256 return _mkdir(dirname);
257 #elif defined (WIN32)
259 CONVERT_PATH (dirname, wpath, -1);
260 return _wmkdir (wpath);
263 char *locname = ToLocale( dirname );
266 if( locname == NULL )
271 res = mkdir( locname, mode );
273 LocaleFree( locname );
279 * Opens a DIR pointer.
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().
285 DIR *vlc_opendir( const char *dirname )
288 CONVERT_PATH (dirname, wpath, NULL);
289 return (DIR *)vlc_wopendir (wpath);
292 const char *local_name = ToLocale( dirname );
294 if( local_name != NULL )
296 DIR *dir = opendir( local_name );
297 LocaleFree( local_name );
307 * Reads the next file name from an open directory.
309 * @param dir The directory that is being read
311 * @return a UTF-8 string of the directory entry. Use free() to release it.
312 * If there are no more entries in the directory, NULL is returned.
313 * If an error occurs, errno is set and NULL is returned.
315 char *vlc_readdir( DIR *dir )
318 struct _wdirent *ent = vlc_wreaddir (dir);
322 return FromWide (ent->d_name);
324 /* Beware that readdir_r() assumes <buf> is large enough to hold the result
325 * dirent including the file name. A buffer overflow could occur otherwise.
326 * In particular, pathconf() and _POSIX_NAME_MAX cannot be used here. */
330 long len = fpathconf (dirfd (dir), _PC_NAME_MAX);
337 return NULL; // OS is broken. There is no sane way to fix this.
340 len += offsetof (struct dirent, d_name) + 1;
342 struct dirent *buf = malloc (len);
343 if (unlikely(buf == NULL))
346 int val = readdir_r (dir, buf, &ent);
349 else if (ent != NULL)
350 path = vlc_fix_readdir (ent->d_name);
356 static int dummy_select( const char *str )
363 * Does the same as vlc_scandir(), but takes an open directory pointer
364 * instead of a directory path.
366 int vlc_loaddir( DIR *dir, char ***namelist,
367 int (*select)( const char * ),
368 int (*compar)( const char **, const char ** ) )
373 select = dummy_select;
380 for (unsigned size = 0;;)
383 char *entry = vlc_readdir (dir);
399 size = size ? (2 * size) : 16;
400 char **newtab = realloc (tab, sizeof (*tab) * (size));
402 if (unlikely(newtab == NULL))
414 qsort (tab, num, sizeof (*tab),
415 (int (*)( const void *, const void *))compar);
420 for (unsigned i = 0; i < num; i++)
427 * Selects file entries from a directory, as GNU C scandir().
429 * @param dirname UTF-8 diretory path
430 * @param pointer [OUT] pointer set, on successful completion, to the address
431 * of a table of UTF-8 filenames. All filenames must be freed with free().
432 * The table itself must be freed with free() as well.
434 * @return How many file names were selected (possibly 0),
435 * or -1 in case of error.
437 int vlc_scandir( const char *dirname, char ***namelist,
438 int (*select)( const char * ),
439 int (*compar)( const char **, const char ** ) )
441 DIR *dir = vlc_opendir (dirname);
446 val = vlc_loaddir (dir, namelist, select, compar);
452 static int vlc_statEx( const char *filename, struct stat *buf,
456 /*_stat translates to wchar internally on WinCE*/
457 return _stat( filename, buf );
458 #elif defined (WIN32)
459 CONVERT_PATH (filename, wpath, -1);
460 return _wstati64 (wpath, buf);
463 #ifdef HAVE_SYS_STAT_H
464 const char *local_name = ToLocale( filename );
466 if( local_name != NULL )
468 int res = deref ? stat( local_name, buf )
469 : lstat( local_name, buf );
470 LocaleFree( local_name );
479 * Finds file/inode information, as stat().
480 * Consider using fstat() instead, if possible.
482 * @param filename UTF-8 file path
484 int vlc_stat( const char *filename, struct stat *buf)
486 return vlc_statEx( filename, buf, true );
490 * Finds file/inode information, as lstat().
491 * Consider using fstat() instead, if possible.
493 * @param filename UTF-8 file path
495 int vlc_lstat( const char *filename, struct stat *buf)
497 return vlc_statEx( filename, buf, false );
503 * @param filename a UTF-8 string with the name of the file you want to delete.
504 * @return A 0 return value indicates success. A -1 return value indicates an
505 * error, and an error code is stored in errno
507 int vlc_unlink( const char *filename )
510 /*_open translates to wchar internally on WinCE*/
511 return _unlink( filename );
512 #elif defined (WIN32)
513 CONVERT_PATH (filename, wpath, -1);
514 return _wunlink (wpath);
517 const char *local_name = ToLocale( filename );
519 if( local_name == NULL )
525 int ret = unlink( local_name );
526 LocaleFree( local_name );
531 * Moves a file atomically. This only works within a single file system.
533 * @param oldpath path to the file before the move
534 * @param newpath intended path to the file after the move
535 * @return A 0 return value indicates success. A -1 return value indicates an
536 * error, and an error code is stored in errno
538 int vlc_rename (const char *oldpath, const char *newpath)
541 CONVERT_PATH (oldpath, wold, -1);
542 CONVERT_PATH (newpath, wnew, -1);
544 /* FIXME: errno support */
545 if (MoveFileW (wold, wnew))
550 if (_wrename (wold, wnew) && errno == EACCES)
551 { /* Windows does not allow atomic file replacement */
554 errno = EACCES; /* restore errno */
557 if (_wrename (wold, wnew))
564 const char *lo = ToLocale (oldpath);
568 const char *ln = ToLocale (newpath);
577 int ret = rename (lo, ln);
583 int vlc_mkstemp( char *template )
585 static const char digits[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
586 static const int i_digits = sizeof(digits)/sizeof(*digits) - 1;
591 /* Check template validity */
592 const size_t i_length = strlen( template );
593 char *psz_rand = &template[i_length-6];
595 if( i_length < 6 || strcmp( psz_rand, "XXXXXX" ) )
602 for( int i = 0; i < 256; i++ )
604 /* Create a pseudo random file name */
607 vlc_rand_bytes( pi_rand, sizeof(pi_rand) );
608 for( int j = 0; j < 6; j++ )
609 psz_rand[j] = digits[pi_rand[j] % i_digits];
612 int fd = vlc_open( template, O_CREAT | O_EXCL | O_RDWR, 0600 );
615 if( errno != EEXIST )
624 # define dup(fd) (fd, -1)
628 * Duplicates a file descriptor. The new file descriptor has the close-on-exec
629 * descriptor flag set.
630 * @return a new file descriptor or -1
632 int vlc_dup (int oldfd)
637 /* Unfortunately, dup3() works like dup2(), not like plain dup(). So we
638 * need such contortion to find the new file descriptor while preserving
639 * thread safety of the file descriptor table. */
640 newfd = vlc_open ("/dev/null", O_RDONLY);
641 if (likely(newfd != -1))
643 if (likely(dup3 (oldfd, newfd, O_CLOEXEC) == newfd))
651 if (likely(newfd != -1))
652 fcntl (newfd, F_SETFD, FD_CLOEXEC);
657 #include <vlc_network.h>
660 * Creates a socket file descriptor. The new file descriptor has the
661 * close-on-exec flag set.
662 * @param pf protocol family
663 * @param type socket type
664 * @param proto network protocol
665 * @param nonblock true to create a non-blocking socket
666 * @return a new file descriptor or -1
668 int vlc_socket (int pf, int type, int proto, bool nonblock)
673 type |= SOCK_CLOEXEC;
675 type |= SOCK_NONBLOCK;
676 fd = socket (pf, type, proto);
677 if (fd != -1 || errno != EINVAL)
680 type &= ~(SOCK_CLOEXEC|SOCK_NONBLOCK);
683 fd = socket (pf, type, proto);
688 fcntl (fd, F_SETFD, FD_CLOEXEC);
690 fcntl (fd, F_SETFL, fcntl (fd, F_GETFL, 0) | O_NONBLOCK);
693 ioctlsocket (fd, FIONBIO, &(unsigned long){ 1 });
699 * Accepts an inbound connection request on a listening socket.
700 * The new file descriptor has the close-on-exec flag set.
701 * @param lfd listening socket file descriptor
702 * @param addr pointer to the peer address or NULL [OUT]
703 * @param alen pointer to the length of the peer address or NULL [OUT]
704 * @param nonblock whether to put the new socket in non-blocking mode
705 * @return a new file descriptor, or -1 on error.
707 int vlc_accept (int lfd, struct sockaddr *addr, socklen_t *alen, bool nonblock)
710 int flags = SOCK_CLOEXEC;
712 flags |= SOCK_NONBLOCK;
716 int fd = accept4 (lfd, addr, alen, flags);
720 while (errno == EINTR);
731 int fd = accept (lfd, addr, alen);
735 fcntl (fd, F_SETFD, FD_CLOEXEC);
737 fcntl (fd, F_SETFL, fcntl (fd, F_GETFL, 0) | O_NONBLOCK);
740 ioctlsocket (fd, FIONBIO, &(unsigned long){ 1 });
745 while (errno == EINTR);