]> git.sesse.net Git - vlc/blobdiff - src/text/filesystem.c
Use var_Inherit* instead of var_CreateGet*.
[vlc] / src / text / filesystem.c
index 7cd4455206c858677febd15f0bf83c0e7a779c4a..f83a4fcff803311f47628c7d1ded6dbed8c2f644 100644 (file)
 
 #include <vlc_common.h>
 #include <vlc_charset.h>
-#include "libvlc.h" /* utf8_mkdir */
+#include <vlc_fs.h>
+#include "libvlc.h" /* vlc_mkdir */
+#include <vlc_rand.h>
 
 #include <assert.h>
 
 #include <stdio.h>
+#include <limits.h> /* NAME_MAX */
 #include <errno.h>
 #include <sys/types.h>
-#ifdef HAVE_DIRENT_H
-#  include <dirent.h>
-#endif
-#ifdef UNDER_CE
-#  include <tchar.h>
-#endif
+#include <dirent.h>
 #ifdef HAVE_SYS_STAT_H
 # include <sys/stat.h>
 #endif
 #endif
 #ifdef WIN32
 # include <io.h>
-# include <direct.h>
+# include <winsock2.h>
+# ifndef UNDER_CE
+#  include <direct.h>
+# else
+#  include <tchar.h>
+# endif
 #else
 # include <unistd.h>
+# include <sys/socket.h>
 #endif
 
 #ifndef HAVE_LSTAT
@@ -82,11 +86,24 @@ static int convert_path (const char *restrict path, wchar_t *restrict wpath)
  *
  * @param filename file path to open (with UTF-8 encoding)
  * @param flags open() flags, see the C library open() documentation
- * @param mode file permissions if creating a new file
  * @return a file handle on success, -1 on error (see errno).
+ * @note Contrary to standard open(), this function returns file handles
+ * with the close-on-exec flag enabled.
  */
-int utf8_open (const char *filename, int flags, mode_t mode)
+int vlc_open (const char *filename, int flags, ...)
 {
+    unsigned int mode = 0;
+    va_list ap;
+
+    va_start (ap, flags);
+    if (flags & O_CREAT)
+        mode = va_arg (ap, unsigned int);
+    va_end (ap);
+
+#ifdef O_CLOEXEC
+    flags |= O_CLOEXEC;
+#endif
+
 #ifdef UNDER_CE
     /*_open translates to wchar internally on WinCE*/
     return _open (filename, flags, mode);
@@ -108,6 +125,11 @@ int utf8_open (const char *filename, int flags, mode_t mode)
     }
 
     int fd = open (local_name, flags, mode);
+#ifdef HAVE_FCNTL
+    if (fd != -1)
+        fcntl (fd, F_SETFD, FD_CLOEXEC);
+#endif
+
     LocaleFree (local_name);
     return fd;
 }
@@ -118,7 +140,7 @@ int utf8_open (const char *filename, int flags, mode_t mode)
  * @param mode fopen file open mode
  * @return NULL on error, an open FILE pointer on success.
  */
-FILE *utf8_fopen (const char *filename, const char *mode)
+FILE *vlc_fopen (const char *filename, const char *mode)
 {
     int rwflags = 0, oflags = 0;
     bool append = false;
@@ -154,7 +176,7 @@ FILE *utf8_fopen (const char *filename, const char *mode)
         }
     }
 
-    int fd = utf8_open (filename, rwflags | oflags, 0666);
+    int fd = vlc_open (filename, rwflags | oflags, 0666);
     if (fd == -1)
         return NULL;
 
@@ -171,6 +193,53 @@ FILE *utf8_fopen (const char *filename, const char *mode)
     return stream;
 }
 
+/**
+ * Opens a system file handle relative to an existing directory handle.
+ *
+ * @param dir directory file descriptor
+ * @param filename file path to open (with UTF-8 encoding)
+ * @param flags open() flags, see the C library open() documentation
+ * @return a file handle on success, -1 on error (see errno).
+ * @note Contrary to standard open(), this function returns file handles
+ * with the close-on-exec flag enabled.
+ */
+int vlc_openat (int dir, const char *filename, int flags, ...)
+{
+    unsigned int mode = 0;
+    va_list ap;
+
+    va_start (ap, flags);
+    if (flags & O_CREAT)
+        mode = va_arg (ap, unsigned int);
+    va_end (ap);
+
+#ifdef O_CLOEXEC
+    flags |= O_CLOEXEC;
+#endif
+
+    const char *local_name = ToLocale (filename);
+    if (local_name == NULL)
+    {
+        errno = ENOENT;
+        return -1;
+    }
+
+#ifdef HAVE_OPENAT
+    int fd = openat (dir, local_name, flags, mode);
+# ifdef HAVE_FCNTL
+    if (fd != -1)
+        fcntl (fd, F_SETFD, FD_CLOEXEC);
+# endif
+#else
+    int fd = -1;
+    errno = ENOSYS;
+#endif
+
+    LocaleFree (local_name);
+    return fd;
+}
+
+
 /**
  * Creates a directory using UTF-8 paths.
  *
@@ -179,9 +248,13 @@ FILE *utf8_fopen (const char *filename, const char *mode)
  * @param mode directory permissions
  * @return 0 on success, -1 on error (see errno).
  */
-int utf8_mkdir( const char *dirname, mode_t mode )
+int vlc_mkdir( const char *dirname, mode_t mode )
 {
-#if defined (UNDER_CE) || defined (WIN32)
+#if defined (UNDER_CE)
+    (void) mode;
+    /* mkdir converts internally to wchar */
+    return _mkdir(dirname);
+#elif defined (WIN32)
     (void) mode;
     CONVERT_PATH (dirname, wpath, -1);
     return _wmkdir (wpath);
@@ -209,7 +282,7 @@ int utf8_mkdir( const char *dirname, mode_t mode )
  * @return a pointer to the DIR struct, or NULL in case of error.
  * Release with standard closedir().
  */
-DIR *utf8_opendir( const char *dirname )
+DIR *vlc_opendir( const char *dirname )
 {
 #ifdef WIN32
     CONVERT_PATH (dirname, wpath, NULL);
@@ -235,10 +308,11 @@ DIR *utf8_opendir( const char *dirname )
  *
  * @param dir The directory that is being read
  *
- * @return a UTF-8 string of the directory entry.
- * Use free() to free this memory.
+ * @return a UTF-8 string of the directory entry. Use free() to release it.
+ * If there are no more entries in the directory, NULL is returned.
+ * If an error occurs, errno is set and NULL is returned.
  */
-char *utf8_readdir( DIR *dir )
+char *vlc_readdir( DIR *dir )
 {
 #ifdef WIN32
     struct _wdirent *ent = vlc_wreaddir (dir);
@@ -247,13 +321,35 @@ char *utf8_readdir( DIR *dir )
 
     return FromWide (ent->d_name);
 #else
+    /* Beware that readdir_r() assumes <buf> is large enough to hold the result
+     * dirent including the file name. A buffer overflow could occur otherwise.
+     * In particular, pathconf() and _POSIX_NAME_MAX cannot be used here. */
     struct dirent *ent;
+    char *path = NULL;
+
+    long len = fpathconf (dirfd (dir), _PC_NAME_MAX);
+    if (len == -1)
+    {
+#ifdef NAME_MAX
+        len = NAME_MAX;
+#else
+        errno = ENOMEM;
+        return NULL; // OS is broken. There is no sane way to fix this.
+#endif
+    }
+    len += offsetof (struct dirent, d_name) + 1;
 
-    ent = readdir( (DIR *)dir );
-    if( ent == NULL )
+    struct dirent *buf = malloc (len);
+    if (unlikely(buf == NULL))
         return NULL;
 
-    return vlc_fix_readdir( ent->d_name );
+    int val = readdir_r (dir, buf, &ent);
+    if (val != 0)
+        errno = val;
+    else if (ent != NULL)
+        path = vlc_fix_readdir (ent->d_name);
+    free (buf);
+    return path;
 #endif
 }
 
@@ -264,62 +360,66 @@ static int dummy_select( const char *str )
 }
 
 /**
- * Does the same as utf8_scandir(), but takes an open directory pointer
+ * Does the same as vlc_scandir(), but takes an open directory pointer
  * instead of a directory path.
  */
-int utf8_loaddir( DIR *dir, char ***namelist,
+int vlc_loaddir( DIR *dir, char ***namelist,
                   int (*select)( const char * ),
                   int (*compar)( const char **, const char ** ) )
 {
-    if( select == NULL )
+    assert (dir);
+
+    if (select == NULL)
         select = dummy_select;
 
-    if( dir == NULL )
-        return -1;
-    else
-    {
-        char **tab = NULL;
-        char *entry;
-        unsigned num = 0;
+    char **tab = NULL;
+    unsigned num = 0;
 
-        rewinddir( dir );
+    rewinddir (dir);
 
-        while( ( entry = utf8_readdir( dir ) ) != NULL )
+    for (unsigned size = 0;;)
+    {
+        errno = 0;
+        char *entry = vlc_readdir (dir);
+        if (entry == NULL)
         {
-            char **newtab;
+            if (errno)
+                goto error;
+            break;
+        }
 
-            if( !select( entry ) )
-            {
-                free( entry );
-                continue;
-            }
+        if (!select (entry))
+        {
+            free (entry);
+            continue;
+        }
+
+        if (num >= size)
+        {
+            size = size ? (2 * size) : 16;
+            char **newtab = realloc (tab, sizeof (*tab) * (size));
 
-            newtab = realloc( tab, sizeof( char * ) * (num + 1) );
-            if( newtab == NULL )
+            if (unlikely(newtab == NULL))
             {
-                free( entry );
+                free (entry);
                 goto error;
             }
             tab = newtab;
-            tab[num++] = entry;
         }
 
-        if( compar != NULL )
-            qsort( tab, num, sizeof( tab[0] ),
-                   (int (*)( const void *, const void *))compar );
-
-        *namelist = tab;
-        return num;
+        tab[num++] = entry;
+    }
 
-    error:{
-        unsigned i;
+    if (compar != NULL)
+        qsort (tab, num, sizeof (*tab),
+               (int (*)( const void *, const void *))compar);
+    *namelist = tab;
+    return num;
 
-        for( i = 0; i < num; i++ )
-            free( tab[i] );
-        if( tab != NULL )
-            free( tab );
-        }
-    }
+error:
+    for (unsigned i = 0; i < num; i++)
+        free (tab[i]);
+    free (tab);
     return -1;
 }
 
@@ -327,29 +427,29 @@ int utf8_loaddir( DIR *dir, char ***namelist,
  * Selects file entries from a directory, as GNU C scandir().
  *
  * @param dirname UTF-8 diretory path
- * @param pointer [OUT] pointer set, on succesful completion, to the address
+ * @param pointer [OUT] pointer set, on successful completion, to the address
  * of a table of UTF-8 filenames. All filenames must be freed with free().
  * The table itself must be freed with free() as well.
  *
  * @return How many file names were selected (possibly 0),
  * or -1 in case of error.
  */
-int utf8_scandir( const char *dirname, char ***namelist,
+int vlc_scandir( const char *dirname, char ***namelist,
                   int (*select)( const char * ),
                   int (*compar)( const char **, const char ** ) )
 {
-    DIR *dir = utf8_opendir (dirname);
+    DIR *dir = vlc_opendir (dirname);
     int val = -1;
 
     if (dir != NULL)
     {
-        val = utf8_loaddir (dir, namelist, select, compar);
+        val = vlc_loaddir (dir, namelist, select, compar);
         closedir (dir);
     }
     return val;
 }
 
-static int utf8_statEx( const char *filename, struct stat *buf,
+static int vlc_statEx( const char *filename, struct stat *buf,
                         bool deref )
 {
 #ifdef UNDER_CE
@@ -376,25 +476,25 @@ static int utf8_statEx( const char *filename, struct stat *buf,
 }
 
 /**
- * Finds file/inode informations, as stat().
+ * Finds file/inode information, as stat().
  * Consider using fstat() instead, if possible.
  *
  * @param filename UTF-8 file path
  */
-int utf8_stat( const char *filename, struct stat *buf)
+int vlc_stat( const char *filename, struct stat *buf)
 {
-    return utf8_statEx( filename, buf, true );
+    return vlc_statEx( filename, buf, true );
 }
 
 /**
- * Finds file/inode informations, as lstat().
+ * Finds file/inode information, as lstat().
  * Consider using fstat() instead, if possible.
  *
  * @param filename UTF-8 file path
  */
-int utf8_lstat( const char *filename, struct stat *buf)
+int vlc_lstat( const char *filename, struct stat *buf)
 {
-    return utf8_statEx( filename, buf, false );
+    return vlc_statEx( filename, buf, false );
 }
 
 /**
@@ -404,7 +504,7 @@ int utf8_lstat( const char *filename, struct stat *buf)
  * @return A 0 return value indicates success. A -1 return value indicates an
  *        error, and an error code is stored in errno
  */
-int utf8_unlink( const char *filename )
+int vlc_unlink( const char *filename )
 {
 #ifdef UNDER_CE
     /*_open translates to wchar internally on WinCE*/
@@ -426,3 +526,223 @@ int utf8_unlink( const char *filename )
     LocaleFree( local_name );
     return ret;
 }
+
+/**
+ * Moves a file atomically. This only works within a single file system.
+ *
+ * @param oldpath path to the file before the move
+ * @param newpath intended path to the file after the move
+ * @return A 0 return value indicates success. A -1 return value indicates an
+ *        error, and an error code is stored in errno
+ */
+int vlc_rename (const char *oldpath, const char *newpath)
+{
+#if defined (WIN32)
+    CONVERT_PATH (oldpath, wold, -1);
+    CONVERT_PATH (newpath, wnew, -1);
+# ifdef UNDER_CE
+    /* FIXME: errno support */
+    if (MoveFileW (wold, wnew))
+        return 0;
+    else
+        return -1;
+#else
+    if (_wrename (wold, wnew) && errno == EACCES)
+    {   /* Windows does not allow atomic file replacement */
+        if (_wremove (wnew))
+        {
+            errno = EACCES; /* restore errno */
+            return -1;
+        }
+        if (_wrename (wold, wnew))
+            return -1;
+    }
+    return 0;
+#endif
+
+#endif
+    const char *lo = ToLocale (oldpath);
+    if (lo == NULL)
+        goto error;
+
+    const char *ln = ToLocale (newpath);
+    if (ln == NULL)
+    {
+        LocaleFree (lo);
+error:
+        errno = ENOENT;
+        return -1;
+    }
+
+    int ret = rename (lo, ln);
+    LocaleFree (lo);
+    LocaleFree (ln);
+    return ret;
+}
+
+int vlc_mkstemp( char *template )
+{
+    static const char digits[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
+    static const int i_digits = sizeof(digits)/sizeof(*digits) - 1;
+
+    /* */
+    assert( template );
+
+    /* Check template validity */
+    const size_t i_length = strlen( template );
+    char *psz_rand = &template[i_length-6];
+
+    if( i_length < 6 || strcmp( psz_rand, "XXXXXX" ) )
+    {
+        errno = EINVAL;
+        return -1;
+    }
+
+    /* */
+    for( int i = 0; i < 256; i++ )
+    {
+        /* Create a pseudo random file name */
+        uint8_t pi_rand[6];
+
+        vlc_rand_bytes( pi_rand, sizeof(pi_rand) );
+        for( int j = 0; j < 6; j++ )
+            psz_rand[j] = digits[pi_rand[j] % i_digits];
+
+        /* */
+        int fd = vlc_open( template, O_CREAT | O_EXCL | O_RDWR, 0600 );
+        if( fd >= 0 )
+            return fd;
+        if( errno != EEXIST )
+            return -1;
+    }
+
+    errno = EEXIST;
+    return -1;
+}
+
+#ifdef UNDER_CE
+# define dup(fd) (fd, -1)
+#endif
+
+/**
+ * Duplicates a file descriptor. The new file descriptor has the close-on-exec
+ * descriptor flag set.
+ * @return a new file descriptor or -1
+ */
+int vlc_dup (int oldfd)
+{
+    int newfd;
+
+#ifdef HAVE_DUP3
+    /* Unfortunately, dup3() works like dup2(), not like plain dup(). So we
+     * need such contortion to find the new file descriptor while preserving
+     * thread safety of the file descriptor table. */
+    newfd = vlc_open ("/dev/null", O_RDONLY);
+    if (likely(newfd != -1))
+    {
+        if (likely(dup3 (oldfd, newfd, O_CLOEXEC) == newfd))
+            return newfd;
+        close (newfd);
+    }
+#endif
+
+    newfd = dup (oldfd);
+#ifdef HAVE_FCNTL
+    if (likely(newfd != -1))
+        fcntl (newfd, F_SETFD, FD_CLOEXEC);
+#endif
+    return newfd;
+}
+
+#include <vlc_network.h>
+
+/**
+ * Creates a socket file descriptor. The new file descriptor has the
+ * close-on-exec flag set.
+ * @param pf protocol family
+ * @param type socket type
+ * @param proto network protocol
+ * @param nonblock true to create a non-blocking socket
+ * @return a new file descriptor or -1
+ */
+int vlc_socket (int pf, int type, int proto, bool nonblock)
+{
+    int fd;
+
+#ifdef SOCK_CLOEXEC
+    type |= SOCK_CLOEXEC;
+    if (nonblock)
+        type |= SOCK_NONBLOCK;
+    fd = socket (pf, type, proto);
+    if (fd != -1 || errno != EINVAL)
+        return fd;
+
+    type &= ~(SOCK_CLOEXEC|SOCK_NONBLOCK);
+#endif
+
+    fd = socket (pf, type, proto);
+    if (fd == -1)
+        return -1;
+
+#ifndef WIN32
+    fcntl (fd, F_SETFD, FD_CLOEXEC);
+    if (nonblock)
+        fcntl (fd, F_SETFL, fcntl (fd, F_GETFL, 0) | O_NONBLOCK);
+#else
+    if (nonblock)
+        ioctlsocket (fd, FIONBIO, &(unsigned long){ 1 });
+#endif
+    return fd;
+}
+
+/**
+ * Accepts an inbound connection request on a listening socket.
+ * The new file descriptor has the close-on-exec flag set.
+ * @param lfd listening socket file descriptor
+ * @param addr pointer to the peer address or NULL [OUT]
+ * @param alen pointer to the length of the peer address or NULL [OUT]
+ * @param nonblock whether to put the new socket in non-blocking mode
+ * @return a new file descriptor, or -1 on error.
+ */
+int vlc_accept (int lfd, struct sockaddr *addr, socklen_t *alen, bool nonblock)
+{
+#ifdef HAVE_ACCEPT4
+    int flags = SOCK_CLOEXEC;
+    if (nonblock)
+        flags |= SOCK_NONBLOCK;
+
+    do
+    {
+        int fd = accept4 (lfd, addr, alen, flags);
+        if (fd != -1)
+            return fd;
+    }
+    while (errno == EINTR);
+
+    if (errno != ENOSYS)
+        return -1;
+#endif
+#ifdef WIN32
+    errno = 0;
+#endif
+
+    do
+    {
+        int fd = accept (lfd, addr, alen);
+        if (fd != -1)
+        {
+#ifndef WIN32
+            fcntl (fd, F_SETFD, FD_CLOEXEC);
+            if (nonblock)
+                fcntl (fd, F_SETFL, fcntl (fd, F_GETFL, 0) | O_NONBLOCK);
+#else
+            if (nonblock)
+                ioctlsocket (fd, FIONBIO, &(unsigned long){ 1 });
+#endif
+            return fd;
+        }
+    }
+    while (errno == EINTR);
+
+    return -1;
+}