]> git.sesse.net Git - vlc/blobdiff - src/text/filesystem.c
Ensure string list always has text
[vlc] / src / text / filesystem.c
index 66111acfa8afe0a221a51b1b991f3beb6b348156..f3eb1d7f4c05c68bdaa4f0af08090db5dd22c6eb 100644 (file)
@@ -1,24 +1,24 @@
 /*****************************************************************************
- * filesystem.c: File system helpers
+ * filesystem.c: Common file system helpers
  *****************************************************************************
- * Copyright (C) 2005-2006 the VideoLAN team
+ * Copyright (C) 2005-2006 VLC authors and VideoLAN
  * Copyright © 2005-2008 Rémi Denis-Courmont
  *
  * Authors: Rémi Denis-Courmont <rem # videolan.org>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /*****************************************************************************
@@ -29,9 +29,7 @@
 #endif
 
 #include <vlc_common.h>
-#include <vlc_charset.h>
 #include <vlc_fs.h>
-#include "libvlc.h" /* vlc_mkdir */
 #include <vlc_rand.h>
 
 #include <assert.h>
 #include <stdio.h>
 #include <errno.h>
 #include <sys/types.h>
-#ifdef HAVE_DIRENT_H
-#  include <dirent.h>
-#endif
-#ifdef HAVE_SYS_STAT_H
-# include <sys/stat.h>
-#endif
-#ifdef HAVE_FCNTL_H
-# include <fcntl.h>
-#endif
-#ifdef WIN32
-# include <io.h>
-# include <winsock2.h>
-# ifndef UNDER_CE
-#  include <direct.h>
-# else
-#  include <tchar.h>
-# endif
-#else
+#include <fcntl.h>
+#ifdef HAVE_UNISTD_H
 # include <unistd.h>
-# include <sys/socket.h>
-#endif
-
-#ifndef HAVE_LSTAT
-# define lstat( a, b ) stat(a, b)
-#endif
-
-#ifdef WIN32
-static int convert_path (const char *restrict path, wchar_t *restrict wpath)
-{
-    if (!MultiByteToWideChar (CP_UTF8, 0, path, -1, wpath, MAX_PATH))
-    {
-        errno = ENOENT;
-        return -1;
-    }
-    wpath[MAX_PATH] = L'\0';
-    return 0;
-}
-# define CONVERT_PATH(path, wpath, err) \
-  wchar_t wpath[MAX_PATH+1]; \
-  if (convert_path (path, wpath)) \
-      return (err)
-#endif
-
-/**
- * Opens a system file handle.
- *
- * @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_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);
-#elif defined (WIN32)
-    /*
-     * open() cannot open files with non-“ANSI” characters on Windows.
-     * We use _wopen() instead. Same thing for mkdir() and stat().
-     */
-    CONVERT_PATH(filename, wpath, -1);
-    return _wopen (wpath, flags, mode);
-
-#endif
-    const char *local_name = ToLocale (filename);
-
-    if (local_name == NULL)
-    {
-        errno = ENOENT;
-        return -1;
-    }
-
-    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;
-}
-
 /**
  * Opens a FILE pointer.
  * @param filename file path, using UTF-8 encoding
@@ -144,7 +51,6 @@ int vlc_open (const char *filename, int flags, ...)
 FILE *vlc_fopen (const char *filename, const char *mode)
 {
     int rwflags = 0, oflags = 0;
-    bool append = false;
 
     for (const char *ptr = mode; *ptr; ptr++)
     {
@@ -156,8 +62,7 @@ FILE *vlc_fopen (const char *filename, const char *mode)
 
             case 'a':
                 rwflags = O_WRONLY;
-                oflags |= O_CREAT;
-                append = true;
+                oflags |= O_CREAT | O_APPEND;
                 break;
 
             case 'w':
@@ -165,13 +70,21 @@ FILE *vlc_fopen (const char *filename, const char *mode)
                 oflags |= O_CREAT | O_TRUNC;
                 break;
 
+            case 'x':
+                oflags |= O_EXCL;
+                break;
+
             case '+':
                 rwflags = O_RDWR;
                 break;
 
-#ifdef O_TEXT
+#ifdef O_BINARY
+            case 'b':
+                oflags = (oflags & ~O_TEXT) | O_BINARY;
+                break;
+
             case 't':
-                oflags |= O_TEXT;
+                oflags = (oflags & ~O_BINARY) | O_TEXT;
                 break;
 #endif
         }
@@ -181,12 +94,6 @@ FILE *vlc_fopen (const char *filename, const char *mode)
     if (fd == -1)
         return NULL;
 
-    if (append && (lseek (fd, 0, SEEK_END) == -1))
-    {
-        close (fd);
-        return NULL;
-    }
-
     FILE *stream = fdopen (fd, mode);
     if (stream == NULL)
         close (fd);
@@ -194,142 +101,6 @@ FILE *vlc_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_FDOPENDIR
-    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.
- *
- * @param dirname a UTF-8 string with the name of the directory that you
- *        want to create.
- * @param mode directory permissions
- * @return 0 on success, -1 on error (see errno).
- */
-int vlc_mkdir( const char *dirname, mode_t mode )
-{
-#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);
-
-#else
-    char *locname = ToLocale( dirname );
-    int res;
-
-    if( locname == NULL )
-    {
-        errno = ENOENT;
-        return -1;
-    }
-    res = mkdir( locname, mode );
-
-    LocaleFree( locname );
-    return res;
-#endif
-}
-
-/**
- * Opens a DIR pointer.
- *
- * @param dirname UTF-8 representation of the directory name
- * @return a pointer to the DIR struct, or NULL in case of error.
- * Release with standard closedir().
- */
-DIR *vlc_opendir( const char *dirname )
-{
-#ifdef WIN32
-    CONVERT_PATH (dirname, wpath, NULL);
-    return (DIR *)vlc_wopendir (wpath);
-
-#else
-    const char *local_name = ToLocale( dirname );
-
-    if( local_name != NULL )
-    {
-        DIR *dir = opendir( local_name );
-        LocaleFree( local_name );
-        return dir;
-    }
-#endif
-
-    errno = ENOENT;
-    return NULL;
-}
-
-/**
- * Reads the next file name from an open directory.
- *
- * @param dir The directory that is being read
- *
- * @return a UTF-8 string of the directory entry.
- * Use free() to free this memory.
- */
-char *vlc_readdir( DIR *dir )
-{
-#ifdef WIN32
-    struct _wdirent *ent = vlc_wreaddir (dir);
-    if (ent == NULL)
-        return NULL;
-
-    return FromWide (ent->d_name);
-#else
-    struct dirent *ent;
-
-    ent = readdir( (DIR *)dir );
-    if( ent == NULL )
-        return NULL;
-
-    return vlc_fix_readdir( ent->d_name );
-#endif
-}
 
 static int dummy_select( const char *str )
 {
@@ -345,54 +116,59 @@ 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 = vlc_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] );
-        free( tab );
-        }
-    }
+error:
+    for (unsigned i = 0; i < num; i++)
+        free (tab[i]);
+    free (tab);
     return -1;
 }
 
@@ -400,7 +176,7 @@ int vlc_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.
  *
@@ -422,127 +198,6 @@ int vlc_scandir( const char *dirname, char ***namelist,
     return val;
 }
 
-static int vlc_statEx( const char *filename, struct stat *buf,
-                        bool deref )
-{
-#ifdef UNDER_CE
-    /*_stat translates to wchar internally on WinCE*/
-    return _stat( filename, buf );
-#elif defined (WIN32)
-    CONVERT_PATH (filename, wpath, -1);
-    return _wstati64 (wpath, buf);
-
-#endif
-#ifdef HAVE_SYS_STAT_H
-    const char *local_name = ToLocale( filename );
-
-    if( local_name != NULL )
-    {
-        int res = deref ? stat( local_name, buf )
-                       : lstat( local_name, buf );
-        LocaleFree( local_name );
-        return res;
-    }
-    errno = ENOENT;
-#endif
-    return -1;
-}
-
-/**
- * Finds file/inode informations, as stat().
- * Consider using fstat() instead, if possible.
- *
- * @param filename UTF-8 file path
- */
-int vlc_stat( const char *filename, struct stat *buf)
-{
-    return vlc_statEx( filename, buf, true );
-}
-
-/**
- * Finds file/inode informations, as lstat().
- * Consider using fstat() instead, if possible.
- *
- * @param filename UTF-8 file path
- */
-int vlc_lstat( const char *filename, struct stat *buf)
-{
-    return vlc_statEx( filename, buf, false );
-}
-
-/**
- * Removes a file.
- *
- * @param filename a UTF-8 string with the name of the file you want to delete.
- * @return A 0 return value indicates success. A -1 return value indicates an
- *        error, and an error code is stored in errno
- */
-int vlc_unlink( const char *filename )
-{
-#ifdef UNDER_CE
-    /*_open translates to wchar internally on WinCE*/
-    return _unlink( filename );
-#elif defined (WIN32)
-    CONVERT_PATH (filename, wpath, -1);
-    return _wunlink (wpath);
-
-#endif
-    const char *local_name = ToLocale( filename );
-
-    if( local_name == NULL )
-    {
-        errno = ENOENT;
-        return -1;
-    }
-
-    int ret = unlink( local_name );
-    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
-    return _wrename (wold, wnew);
-#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";
@@ -582,130 +237,3 @@ int vlc_mkstemp( char *template )
     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;
-}