LGPL
[vlc.git] / src / text / filesystem.c
1 /*****************************************************************************
2  * filesystem.c: Common file system helpers
3  *****************************************************************************
4  * Copyright (C) 2005-2006 VLC authors and VideoLAN
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 it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * 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_fs.h>
33 #include <vlc_rand.h>
34
35 #include <assert.h>
36
37 #include <stdio.h>
38 #include <errno.h>
39 #include <sys/types.h>
40 #include <fcntl.h>
41 #ifdef HAVE_UNISTD_H
42 # include <unistd.h>
43 #endif
44
45 /**
46  * Opens a FILE pointer.
47  * @param filename file path, using UTF-8 encoding
48  * @param mode fopen file open mode
49  * @return NULL on error, an open FILE pointer on success.
50  */
51 FILE *vlc_fopen (const char *filename, const char *mode)
52 {
53     int rwflags = 0, oflags = 0;
54
55     for (const char *ptr = mode; *ptr; ptr++)
56     {
57         switch (*ptr)
58         {
59             case 'r':
60                 rwflags = O_RDONLY;
61                 break;
62
63             case 'a':
64                 rwflags = O_WRONLY;
65                 oflags |= O_CREAT | O_APPEND;
66                 break;
67
68             case 'w':
69                 rwflags = O_WRONLY;
70                 oflags |= O_CREAT | O_TRUNC;
71                 break;
72
73             case '+':
74                 rwflags = O_RDWR;
75                 break;
76
77 #ifdef O_BINARY
78             case 'b':
79                 oflags = (oflags & ~O_TEXT) | O_BINARY;
80                 break;
81
82             case 't':
83                 oflags = (oflags & ~O_BINARY) | O_TEXT;
84                 break;
85 #endif
86         }
87     }
88
89     int fd = vlc_open (filename, rwflags | oflags, 0666);
90     if (fd == -1)
91         return NULL;
92
93     FILE *stream = fdopen (fd, mode);
94     if (stream == NULL)
95         close (fd);
96
97     return stream;
98 }
99
100
101 static int dummy_select( const char *str )
102 {
103     (void)str;
104     return 1;
105 }
106
107 /**
108  * Does the same as vlc_scandir(), but takes an open directory pointer
109  * instead of a directory path.
110  */
111 int vlc_loaddir( DIR *dir, char ***namelist,
112                   int (*select)( const char * ),
113                   int (*compar)( const char **, const char ** ) )
114 {
115     assert (dir);
116
117     if (select == NULL)
118         select = dummy_select;
119
120     char **tab = NULL;
121     unsigned num = 0;
122
123     rewinddir (dir);
124
125     for (unsigned size = 0;;)
126     {
127         errno = 0;
128         char *entry = vlc_readdir (dir);
129         if (entry == NULL)
130         {
131             if (errno)
132                 goto error;
133             break;
134         }
135
136         if (!select (entry))
137         {
138             free (entry);
139             continue;
140         }
141
142         if (num >= size)
143         {
144             size = size ? (2 * size) : 16;
145             char **newtab = realloc (tab, sizeof (*tab) * (size));
146
147             if (unlikely(newtab == NULL))
148             {
149                 free (entry);
150                 goto error;
151             }
152             tab = newtab;
153         }
154
155         tab[num++] = entry;
156     }
157
158     if (compar != NULL)
159         qsort (tab, num, sizeof (*tab),
160                (int (*)( const void *, const void *))compar);
161     *namelist = tab;
162     return num;
163
164 error:
165     for (unsigned i = 0; i < num; i++)
166         free (tab[i]);
167     free (tab);
168     return -1;
169 }
170
171 /**
172  * Selects file entries from a directory, as GNU C scandir().
173  *
174  * @param dirname UTF-8 diretory path
175  * @param pointer [OUT] pointer set, on successful completion, to the address
176  * of a table of UTF-8 filenames. All filenames must be freed with free().
177  * The table itself must be freed with free() as well.
178  *
179  * @return How many file names were selected (possibly 0),
180  * or -1 in case of error.
181  */
182 int vlc_scandir( const char *dirname, char ***namelist,
183                   int (*select)( const char * ),
184                   int (*compar)( const char **, const char ** ) )
185 {
186     DIR *dir = vlc_opendir (dirname);
187     int val = -1;
188
189     if (dir != NULL)
190     {
191         val = vlc_loaddir (dir, namelist, select, compar);
192         closedir (dir);
193     }
194     return val;
195 }
196
197 int vlc_mkstemp( char *template )
198 {
199     static const char digits[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
200     static const int i_digits = sizeof(digits)/sizeof(*digits) - 1;
201
202     /* */
203     assert( template );
204
205     /* Check template validity */
206     const size_t i_length = strlen( template );
207     char *psz_rand = &template[i_length-6];
208
209     if( i_length < 6 || strcmp( psz_rand, "XXXXXX" ) )
210     {
211         errno = EINVAL;
212         return -1;
213     }
214
215     /* */
216     for( int i = 0; i < 256; i++ )
217     {
218         /* Create a pseudo random file name */
219         uint8_t pi_rand[6];
220
221         vlc_rand_bytes( pi_rand, sizeof(pi_rand) );
222         for( int j = 0; j < 6; j++ )
223             psz_rand[j] = digits[pi_rand[j] % i_digits];
224
225         /* */
226         int fd = vlc_open( template, O_CREAT | O_EXCL | O_RDWR, 0600 );
227         if( fd >= 0 )
228             return fd;
229         if( errno != EEXIST )
230             return -1;
231     }
232
233     errno = EEXIST;
234     return -1;
235 }