free(NULL) is safe.
[vlc.git] / 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 "libvlc.h" /* utf8_mkdir */
34 #include <vlc_rand.h>
35
36 #include <assert.h>
37
38 #include <stdio.h>
39 #include <errno.h>
40 #include <sys/types.h>
41 #ifdef HAVE_DIRENT_H
42 #  include <dirent.h>
43 #endif
44 #ifdef UNDER_CE
45 #  include <tchar.h>
46 #endif
47 #ifdef HAVE_SYS_STAT_H
48 # include <sys/stat.h>
49 #endif
50 #ifdef HAVE_FCNTL_H
51 # include <fcntl.h>
52 #endif
53 #ifdef WIN32
54 # include <io.h>
55 # ifndef UNDER_CE
56 #  include <direct.h>
57 # endif
58 #else
59 # include <unistd.h>
60 #endif
61
62 #ifndef HAVE_LSTAT
63 # define lstat( a, b ) stat(a, b)
64 #endif
65
66 #ifdef WIN32
67 static int convert_path (const char *restrict path, wchar_t *restrict wpath)
68 {
69     if (!MultiByteToWideChar (CP_UTF8, 0, path, -1, wpath, MAX_PATH))
70     {
71         errno = ENOENT;
72         return -1;
73     }
74     wpath[MAX_PATH] = L'\0';
75     return 0;
76 }
77 # define CONVERT_PATH(path, wpath, err) \
78   wchar_t wpath[MAX_PATH+1]; \
79   if (convert_path (path, wpath)) \
80       return (err)
81 #endif
82
83 /**
84  * Opens a system file handle.
85  *
86  * @param filename file path to open (with UTF-8 encoding)
87  * @param flags open() flags, see the C library open() documentation
88  * @param mode file permissions if creating a new file
89  * @return a file handle on success, -1 on error (see errno).
90  */
91 int utf8_open (const char *filename, int flags, mode_t mode)
92 {
93 #ifdef UNDER_CE
94     /*_open translates to wchar internally on WinCE*/
95     return _open (filename, flags, mode);
96 #elif defined (WIN32)
97     /*
98      * open() cannot open files with non-“ANSI” characters on Windows.
99      * We use _wopen() instead. Same thing for mkdir() and stat().
100      */
101     CONVERT_PATH(filename, wpath, -1);
102     return _wopen (wpath, flags, mode);
103
104 #endif
105     const char *local_name = ToLocale (filename);
106
107     if (local_name == NULL)
108     {
109         errno = ENOENT;
110         return -1;
111     }
112
113     int fd;
114
115 #ifdef O_CLOEXEC
116     fd = open (local_name, flags | O_CLOEXEC, mode);
117     if (fd == -1 && errno == EINVAL)
118 #endif
119     {
120         fd = open (local_name, flags, mode);
121 #ifdef HAVE_FCNTL
122         if (fd != -1)
123         {
124             int flags = fcntl (fd, F_GETFD);
125             fcntl (fd, F_SETFD, FD_CLOEXEC | ((flags != -1) ? flags : 0));
126         }
127 #endif
128     }
129
130     LocaleFree (local_name);
131     return fd;
132 }
133
134 /**
135  * Opens a FILE pointer.
136  * @param filename file path, using UTF-8 encoding
137  * @param mode fopen file open mode
138  * @return NULL on error, an open FILE pointer on success.
139  */
140 FILE *utf8_fopen (const char *filename, const char *mode)
141 {
142     int rwflags = 0, oflags = 0;
143     bool append = false;
144
145     for (const char *ptr = mode; *ptr; ptr++)
146     {
147         switch (*ptr)
148         {
149             case 'r':
150                 rwflags = O_RDONLY;
151                 break;
152
153             case 'a':
154                 rwflags = O_WRONLY;
155                 oflags |= O_CREAT;
156                 append = true;
157                 break;
158
159             case 'w':
160                 rwflags = O_WRONLY;
161                 oflags |= O_CREAT | O_TRUNC;
162                 break;
163
164             case '+':
165                 rwflags = O_RDWR;
166                 break;
167
168 #ifdef O_TEXT
169             case 't':
170                 oflags |= O_TEXT;
171                 break;
172 #endif
173         }
174     }
175
176     int fd = utf8_open (filename, rwflags | oflags, 0666);
177     if (fd == -1)
178         return NULL;
179
180     if (append && (lseek (fd, 0, SEEK_END) == -1))
181     {
182         close (fd);
183         return NULL;
184     }
185
186     FILE *stream = fdopen (fd, mode);
187     if (stream == NULL)
188         close (fd);
189
190     return stream;
191 }
192
193 /**
194  * Creates a directory using UTF-8 paths.
195  *
196  * @param dirname a UTF-8 string with the name of the directory that you
197  *        want to create.
198  * @param mode directory permissions
199  * @return 0 on success, -1 on error (see errno).
200  */
201 int utf8_mkdir( const char *dirname, mode_t mode )
202 {
203 #if defined (UNDER_CE)
204     (void) mode;
205     /* mkdir converts internally to wchar */
206     return _mkdir(dirname);
207 #elif defined (WIN32)
208     (void) mode;
209     CONVERT_PATH (dirname, wpath, -1);
210     return _wmkdir (wpath);
211
212 #else
213     char *locname = ToLocale( dirname );
214     int res;
215
216     if( locname == NULL )
217     {
218         errno = ENOENT;
219         return -1;
220     }
221     res = mkdir( locname, mode );
222
223     LocaleFree( locname );
224     return res;
225 #endif
226 }
227
228 /**
229  * Opens a DIR pointer.
230  *
231  * @param dirname UTF-8 representation of the directory name
232  * @return a pointer to the DIR struct, or NULL in case of error.
233  * Release with standard closedir().
234  */
235 DIR *utf8_opendir( const char *dirname )
236 {
237 #ifdef WIN32
238     CONVERT_PATH (dirname, wpath, NULL);
239     return (DIR *)vlc_wopendir (wpath);
240
241 #else
242     const char *local_name = ToLocale( dirname );
243
244     if( local_name != NULL )
245     {
246         DIR *dir = opendir( local_name );
247         LocaleFree( local_name );
248         return dir;
249     }
250 #endif
251
252     errno = ENOENT;
253     return NULL;
254 }
255
256 /**
257  * Reads the next file name from an open directory.
258  *
259  * @param dir The directory that is being read
260  *
261  * @return a UTF-8 string of the directory entry.
262  * Use free() to free this memory.
263  */
264 char *utf8_readdir( DIR *dir )
265 {
266 #ifdef WIN32
267     struct _wdirent *ent = vlc_wreaddir (dir);
268     if (ent == NULL)
269         return NULL;
270
271     return FromWide (ent->d_name);
272 #else
273     struct dirent *ent;
274
275     ent = readdir( (DIR *)dir );
276     if( ent == NULL )
277         return NULL;
278
279     return vlc_fix_readdir( ent->d_name );
280 #endif
281 }
282
283 static int dummy_select( const char *str )
284 {
285     (void)str;
286     return 1;
287 }
288
289 /**
290  * Does the same as utf8_scandir(), but takes an open directory pointer
291  * instead of a directory path.
292  */
293 int utf8_loaddir( DIR *dir, char ***namelist,
294                   int (*select)( const char * ),
295                   int (*compar)( const char **, const char ** ) )
296 {
297     if( select == NULL )
298         select = dummy_select;
299
300     if( dir == NULL )
301         return -1;
302     else
303     {
304         char **tab = NULL;
305         char *entry;
306         unsigned num = 0;
307
308         rewinddir( dir );
309
310         while( ( entry = utf8_readdir( dir ) ) != NULL )
311         {
312             char **newtab;
313
314             if( !select( entry ) )
315             {
316                 free( entry );
317                 continue;
318             }
319
320             newtab = realloc( tab, sizeof( char * ) * (num + 1) );
321             if( newtab == NULL )
322             {
323                 free( entry );
324                 goto error;
325             }
326             tab = newtab;
327             tab[num++] = entry;
328         }
329
330         if( compar != NULL )
331             qsort( tab, num, sizeof( tab[0] ),
332                    (int (*)( const void *, const void *))compar );
333
334         *namelist = tab;
335         return num;
336
337     error:{
338         unsigned i;
339
340         for( i = 0; i < num; i++ )
341             free( tab[i] );
342         free( tab );
343         }
344     }
345     return -1;
346 }
347
348 /**
349  * Selects file entries from a directory, as GNU C scandir().
350  *
351  * @param dirname UTF-8 diretory path
352  * @param pointer [OUT] pointer set, on succesful completion, to the address
353  * of a table of UTF-8 filenames. All filenames must be freed with free().
354  * The table itself must be freed with free() as well.
355  *
356  * @return How many file names were selected (possibly 0),
357  * or -1 in case of error.
358  */
359 int utf8_scandir( const char *dirname, char ***namelist,
360                   int (*select)( const char * ),
361                   int (*compar)( const char **, const char ** ) )
362 {
363     DIR *dir = utf8_opendir (dirname);
364     int val = -1;
365
366     if (dir != NULL)
367     {
368         val = utf8_loaddir (dir, namelist, select, compar);
369         closedir (dir);
370     }
371     return val;
372 }
373
374 static int utf8_statEx( const char *filename, struct stat *buf,
375                         bool deref )
376 {
377 #ifdef UNDER_CE
378     /*_stat translates to wchar internally on WinCE*/
379     return _stat( filename, buf );
380 #elif defined (WIN32)
381     CONVERT_PATH (filename, wpath, -1);
382     return _wstati64 (wpath, buf);
383
384 #endif
385 #ifdef HAVE_SYS_STAT_H
386     const char *local_name = ToLocale( filename );
387
388     if( local_name != NULL )
389     {
390         int res = deref ? stat( local_name, buf )
391                        : lstat( local_name, buf );
392         LocaleFree( local_name );
393         return res;
394     }
395     errno = ENOENT;
396 #endif
397     return -1;
398 }
399
400 /**
401  * Finds file/inode informations, as stat().
402  * Consider using fstat() instead, if possible.
403  *
404  * @param filename UTF-8 file path
405  */
406 int utf8_stat( const char *filename, struct stat *buf)
407 {
408     return utf8_statEx( filename, buf, true );
409 }
410
411 /**
412  * Finds file/inode informations, as lstat().
413  * Consider using fstat() instead, if possible.
414  *
415  * @param filename UTF-8 file path
416  */
417 int utf8_lstat( const char *filename, struct stat *buf)
418 {
419     return utf8_statEx( filename, buf, false );
420 }
421
422 /**
423  * Removes a file.
424  *
425  * @param filename a UTF-8 string with the name of the file you want to delete.
426  * @return A 0 return value indicates success. A -1 return value indicates an
427  *        error, and an error code is stored in errno
428  */
429 int utf8_unlink( const char *filename )
430 {
431 #ifdef UNDER_CE
432     /*_open translates to wchar internally on WinCE*/
433     return _unlink( filename );
434 #elif defined (WIN32)
435     CONVERT_PATH (filename, wpath, -1);
436     return _wunlink (wpath);
437
438 #endif
439     const char *local_name = ToLocale( filename );
440
441     if( local_name == NULL )
442     {
443         errno = ENOENT;
444         return -1;
445     }
446
447     int ret = unlink( local_name );
448     LocaleFree( local_name );
449     return ret;
450 }
451
452 /**
453  * Moves a file atomically. This only works within a single file system.
454  *
455  * @param oldpath path to the file before the move
456  * @param newpath intended path to the file after the move
457  * @return A 0 return value indicates success. A -1 return value indicates an
458  *        error, and an error code is stored in errno
459  */
460 int utf8_rename (const char *oldpath, const char *newpath)
461 {
462 #if defined (WIN32)
463     CONVERT_PATH (oldpath, wold, -1);
464     CONVERT_PATH (newpath, wnew, -1);
465 # ifdef UNDER_CE
466     /* FIXME: errno support */
467     if (MoveFileW (wold, wnew))
468         return 0;
469     else
470         return -1;
471 #else
472     return _wrename (wold, wnew);
473 #endif
474
475 #endif
476     const char *lo = ToLocale (oldpath);
477     if (lo == NULL)
478         goto error;
479
480     const char *ln = ToLocale (newpath);
481     if (ln == NULL)
482     {
483         LocaleFree (lo);
484 error:
485         errno = ENOENT;
486         return -1;
487     }
488
489     int ret = rename (lo, ln);
490     LocaleFree (lo);
491     LocaleFree (ln);
492     return ret;
493 }
494
495 int utf8_mkstemp( char *template )
496 {
497     static const char digits[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
498     static const int i_digits = sizeof(digits)/sizeof(*digits) - 1;
499
500     /* */
501     assert( template );
502
503     /* Check template validity */
504     const size_t i_length = strlen( template );
505     char *psz_rand = &template[i_length-6];
506
507     if( i_length < 6 || strcmp( psz_rand, "XXXXXX" ) )
508     {
509         errno = EINVAL;
510         return -1;
511     }
512
513     /* */
514     for( int i = 0; i < 256; i++ )
515     {
516         /* Create a pseudo random file name */
517         uint8_t pi_rand[6];
518
519         vlc_rand_bytes( pi_rand, sizeof(pi_rand) );
520         for( int j = 0; j < 6; j++ )
521             psz_rand[j] = digits[pi_rand[j] % i_digits];
522
523         /* */
524         int fd = utf8_open( template, O_CREAT | O_EXCL | O_RDWR, 0600 );
525         if( fd >= 0 )
526             return fd;
527         if( errno != EEXIST )
528             return -1;
529     }
530
531     errno = EEXIST;
532     return -1;
533 }
534