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 */
41 #if !defined(NAME_MAX) && defined(_POSIX_NAME_MAX)
42 # define NAME_MAX _POSIX_NAME_MAX
45 #include <sys/types.h>
47 #ifdef HAVE_SYS_STAT_H
48 # include <sys/stat.h>
55 # include <winsock2.h>
63 # include <sys/socket.h>
67 # define lstat( a, b ) stat(a, b)
71 static int convert_path (const char *restrict path
, wchar_t *restrict wpath
)
73 if (!MultiByteToWideChar (CP_UTF8
, 0, path
, -1, wpath
, MAX_PATH
))
78 wpath
[MAX_PATH
] = L
'\0';
81 # define CONVERT_PATH(path, wpath, err) \
82 wchar_t wpath[MAX_PATH+1]; \
83 if (convert_path (path, wpath)) \
88 * Opens a system file handle.
90 * @param filename file path to open (with UTF-8 encoding)
91 * @param flags open() flags, see the C library open() documentation
92 * @return a file handle on success, -1 on error (see errno).
93 * @note Contrary to standard open(), this function returns file handles
94 * with the close-on-exec flag enabled.
96 int vlc_open (const char *filename
, int flags
, ...)
98 unsigned int mode
= 0;
101 va_start (ap
, flags
);
103 mode
= va_arg (ap
, unsigned int);
111 /*_open translates to wchar internally on WinCE*/
112 return _open (filename
, flags
, mode
);
113 #elif defined (WIN32)
115 * open() cannot open files with non-“ANSI” characters on Windows.
116 * We use _wopen() instead. Same thing for mkdir() and stat().
118 CONVERT_PATH(filename
, wpath
, -1);
119 return _wopen (wpath
, flags
, mode
);
122 const char *local_name
= ToLocale (filename
);
124 if (local_name
== NULL
)
130 int fd
= open (local_name
, flags
, mode
);
133 fcntl (fd
, F_SETFD
, FD_CLOEXEC
);
136 LocaleFree (local_name
);
141 * Opens a FILE pointer.
142 * @param filename file path, using UTF-8 encoding
143 * @param mode fopen file open mode
144 * @return NULL on error, an open FILE pointer on success.
146 FILE *vlc_fopen (const char *filename
, const char *mode
)
148 int rwflags
= 0, oflags
= 0;
151 for (const char *ptr
= mode
; *ptr
; ptr
++)
167 oflags
|= O_CREAT
| O_TRUNC
;
182 int fd
= vlc_open (filename
, rwflags
| oflags
, 0666);
186 if (append
&& (lseek (fd
, 0, SEEK_END
) == -1))
192 FILE *stream
= fdopen (fd
, mode
);
200 * Opens a system file handle relative to an existing directory handle.
202 * @param dir directory file descriptor
203 * @param filename file path to open (with UTF-8 encoding)
204 * @param flags open() flags, see the C library open() documentation
205 * @return a file handle on success, -1 on error (see errno).
206 * @note Contrary to standard open(), this function returns file handles
207 * with the close-on-exec flag enabled.
209 int vlc_openat (int dir
, const char *filename
, int flags
, ...)
211 unsigned int mode
= 0;
214 va_start (ap
, flags
);
216 mode
= va_arg (ap
, unsigned int);
223 const char *local_name
= ToLocale (filename
);
224 if (local_name
== NULL
)
231 int fd
= openat (dir
, local_name
, flags
, mode
);
234 fcntl (fd
, F_SETFD
, FD_CLOEXEC
);
241 LocaleFree (local_name
);
247 * Creates a directory using UTF-8 paths.
249 * @param dirname a UTF-8 string with the name of the directory that you
251 * @param mode directory permissions
252 * @return 0 on success, -1 on error (see errno).
254 int vlc_mkdir( const char *dirname
, mode_t mode
)
256 #if defined (UNDER_CE)
258 /* mkdir converts internally to wchar */
259 return _mkdir(dirname
);
260 #elif defined (WIN32)
262 CONVERT_PATH (dirname
, wpath
, -1);
263 return _wmkdir (wpath
);
266 char *locname
= ToLocale( dirname
);
269 if( locname
== NULL
)
274 res
= mkdir( locname
, mode
);
276 LocaleFree( locname
);
282 * Opens a DIR pointer.
284 * @param dirname UTF-8 representation of the directory name
285 * @return a pointer to the DIR struct, or NULL in case of error.
286 * Release with standard closedir().
288 DIR *vlc_opendir( const char *dirname
)
291 CONVERT_PATH (dirname
, wpath
, NULL
);
292 return (DIR *)vlc_wopendir (wpath
);
295 const char *local_name
= ToLocale( dirname
);
297 if( local_name
!= NULL
)
299 DIR *dir
= opendir( local_name
);
300 LocaleFree( local_name
);
310 * Reads the next file name from an open directory.
312 * @param dir The directory that is being read
314 * @return a UTF-8 string of the directory entry.
315 * Use free() to free this memory.
317 char *vlc_readdir( DIR *dir
)
320 struct _wdirent
*ent
= vlc_wreaddir (dir
);
324 return FromWide (ent
->d_name
);
330 char buf
[NAME_MAX
+ 1];
332 int val
= readdir_r (dir
, &buf
.ent
, &ent
);
338 return ent
? vlc_fix_readdir( ent
->d_name
) : NULL
;
342 static int dummy_select( const char *str
)
349 * Does the same as vlc_scandir(), but takes an open directory pointer
350 * instead of a directory path.
352 int vlc_loaddir( DIR *dir
, char ***namelist
,
353 int (*select
)( const char * ),
354 int (*compar
)( const char **, const char ** ) )
359 select
= dummy_select
;
366 for (unsigned size
= 0;;)
369 char *entry
= vlc_readdir (dir
);
385 size
= size
? (2 * size
) : 16;
386 char **newtab
= realloc (tab
, sizeof (*tab
) * (size
));
388 if (unlikely(newtab
== NULL
))
400 qsort (tab
, num
, sizeof (*tab
),
401 (int (*)( const void *, const void *))compar
);
406 for (unsigned i
= 0; i
< num
; i
++)
413 * Selects file entries from a directory, as GNU C scandir().
415 * @param dirname UTF-8 diretory path
416 * @param pointer [OUT] pointer set, on successful completion, to the address
417 * of a table of UTF-8 filenames. All filenames must be freed with free().
418 * The table itself must be freed with free() as well.
420 * @return How many file names were selected (possibly 0),
421 * or -1 in case of error.
423 int vlc_scandir( const char *dirname
, char ***namelist
,
424 int (*select
)( const char * ),
425 int (*compar
)( const char **, const char ** ) )
427 DIR *dir
= vlc_opendir (dirname
);
432 val
= vlc_loaddir (dir
, namelist
, select
, compar
);
438 static int vlc_statEx( const char *filename
, struct stat
*buf
,
442 /*_stat translates to wchar internally on WinCE*/
443 return _stat( filename
, buf
);
444 #elif defined (WIN32)
445 CONVERT_PATH (filename
, wpath
, -1);
446 return _wstati64 (wpath
, buf
);
449 #ifdef HAVE_SYS_STAT_H
450 const char *local_name
= ToLocale( filename
);
452 if( local_name
!= NULL
)
454 int res
= deref
? stat( local_name
, buf
)
455 : lstat( local_name
, buf
);
456 LocaleFree( local_name
);
465 * Finds file/inode information, as stat().
466 * Consider using fstat() instead, if possible.
468 * @param filename UTF-8 file path
470 int vlc_stat( const char *filename
, struct stat
*buf
)
472 return vlc_statEx( filename
, buf
, true );
476 * Finds file/inode information, as lstat().
477 * Consider using fstat() instead, if possible.
479 * @param filename UTF-8 file path
481 int vlc_lstat( const char *filename
, struct stat
*buf
)
483 return vlc_statEx( filename
, buf
, false );
489 * @param filename a UTF-8 string with the name of the file you want to delete.
490 * @return A 0 return value indicates success. A -1 return value indicates an
491 * error, and an error code is stored in errno
493 int vlc_unlink( const char *filename
)
496 /*_open translates to wchar internally on WinCE*/
497 return _unlink( filename
);
498 #elif defined (WIN32)
499 CONVERT_PATH (filename
, wpath
, -1);
500 return _wunlink (wpath
);
503 const char *local_name
= ToLocale( filename
);
505 if( local_name
== NULL
)
511 int ret
= unlink( local_name
);
512 LocaleFree( local_name
);
517 * Moves a file atomically. This only works within a single file system.
519 * @param oldpath path to the file before the move
520 * @param newpath intended path to the file after the move
521 * @return A 0 return value indicates success. A -1 return value indicates an
522 * error, and an error code is stored in errno
524 int vlc_rename (const char *oldpath
, const char *newpath
)
527 CONVERT_PATH (oldpath
, wold
, -1);
528 CONVERT_PATH (newpath
, wnew
, -1);
530 /* FIXME: errno support */
531 if (MoveFileW (wold
, wnew
))
536 if (_wrename (wold
, wnew
) && errno
== EACCES
)
537 { /* Windows does not allow atomic file replacement */
540 errno
= EACCES
; /* restore errno */
543 if (_wrename (wold
, wnew
))
550 const char *lo
= ToLocale (oldpath
);
554 const char *ln
= ToLocale (newpath
);
563 int ret
= rename (lo
, ln
);
569 int vlc_mkstemp( char *template )
571 static const char digits
[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
572 static const int i_digits
= sizeof(digits
)/sizeof(*digits
) - 1;
577 /* Check template validity */
578 const size_t i_length
= strlen( template );
579 char *psz_rand
= &template[i_length
-6];
581 if( i_length
< 6 || strcmp( psz_rand
, "XXXXXX" ) )
588 for( int i
= 0; i
< 256; i
++ )
590 /* Create a pseudo random file name */
593 vlc_rand_bytes( pi_rand
, sizeof(pi_rand
) );
594 for( int j
= 0; j
< 6; j
++ )
595 psz_rand
[j
] = digits
[pi_rand
[j
] % i_digits
];
598 int fd
= vlc_open( template, O_CREAT
| O_EXCL
| O_RDWR
, 0600 );
601 if( errno
!= EEXIST
)
610 # define dup(fd) (fd, -1)
614 * Duplicates a file descriptor. The new file descriptor has the close-on-exec
615 * descriptor flag set.
616 * @return a new file descriptor or -1
618 int vlc_dup (int oldfd
)
623 /* Unfortunately, dup3() works like dup2(), not like plain dup(). So we
624 * need such contortion to find the new file descriptor while preserving
625 * thread safety of the file descriptor table. */
626 newfd
= vlc_open ("/dev/null", O_RDONLY
);
627 if (likely(newfd
!= -1))
629 if (likely(dup3 (oldfd
, newfd
, O_CLOEXEC
) == newfd
))
637 if (likely(newfd
!= -1))
638 fcntl (newfd
, F_SETFD
, FD_CLOEXEC
);
643 #include <vlc_network.h>
646 * Creates a socket file descriptor. The new file descriptor has the
647 * close-on-exec flag set.
648 * @param pf protocol family
649 * @param type socket type
650 * @param proto network protocol
651 * @param nonblock true to create a non-blocking socket
652 * @return a new file descriptor or -1
654 int vlc_socket (int pf
, int type
, int proto
, bool nonblock
)
659 type
|= SOCK_CLOEXEC
;
661 type
|= SOCK_NONBLOCK
;
662 fd
= socket (pf
, type
, proto
);
663 if (fd
!= -1 || errno
!= EINVAL
)
666 type
&= ~(SOCK_CLOEXEC
|SOCK_NONBLOCK
);
669 fd
= socket (pf
, type
, proto
);
674 fcntl (fd
, F_SETFD
, FD_CLOEXEC
);
676 fcntl (fd
, F_SETFL
, fcntl (fd
, F_GETFL
, 0) | O_NONBLOCK
);
679 ioctlsocket (fd
, FIONBIO
, &(unsigned long){ 1 });
685 * Accepts an inbound connection request on a listening socket.
686 * The new file descriptor has the close-on-exec flag set.
687 * @param lfd listening socket file descriptor
688 * @param addr pointer to the peer address or NULL [OUT]
689 * @param alen pointer to the length of the peer address or NULL [OUT]
690 * @param nonblock whether to put the new socket in non-blocking mode
691 * @return a new file descriptor, or -1 on error.
693 int vlc_accept (int lfd
, struct sockaddr
*addr
, socklen_t
*alen
, bool nonblock
)
696 int flags
= SOCK_CLOEXEC
;
698 flags
|= SOCK_NONBLOCK
;
702 int fd
= accept4 (lfd
, addr
, alen
, flags
);
706 while (errno
== EINTR
);
717 int fd
= accept (lfd
, addr
, alen
);
721 fcntl (fd
, F_SETFD
, FD_CLOEXEC
);
723 fcntl (fd
, F_SETFL
, fcntl (fd
, F_GETFL
, 0) | O_NONBLOCK
);
726 ioctlsocket (fd
, FIONBIO
, &(unsigned long){ 1 });
731 while (errno
== EINTR
);