Uses file:// MRL only files, don't bug when recursively adding directories
[vlc.git] / modules / access / directory.c
1 /*****************************************************************************
2  * directory.c: expands a directory (directory: access plug-in)
3  *****************************************************************************
4  * Copyright (C) 2002-2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Derk-Jan Hartman <hartman at videolan dot 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
28 #include <vlc/vlc.h>
29 #include <vlc_playlist.h>
30 #include <vlc_input.h>
31 #include <vlc_access.h>
32 #include <vlc_demux.h>
33
34 #include <stdlib.h>
35 #include <string.h>
36 #ifdef HAVE_SYS_TYPES_H
37 #   include <sys/types.h>
38 #endif
39 #ifdef HAVE_SYS_STAT_H
40 #   include <sys/stat.h>
41 #endif
42 #ifdef HAVE_ERRNO_H
43 #   include <errno.h>
44 #endif
45 #ifdef HAVE_FCNTL_H
46 #   include <fcntl.h>
47 #endif
48
49 #ifdef HAVE_UNISTD_H
50 #   include <unistd.h>
51 #elif defined( WIN32 ) && !defined( UNDER_CE )
52 #   include <io.h>
53 #elif defined( UNDER_CE )
54 #   define strcoll strcmp
55 #endif
56
57 #ifdef HAVE_DIRENT_H
58 #   include <dirent.h>
59 #endif
60
61 #include <vlc_charset.h>
62
63 /*****************************************************************************
64  * Module descriptor
65  *****************************************************************************/
66 static int  Open ( vlc_object_t * );
67 static void Close( vlc_object_t * );
68
69 static int  DemuxOpen ( vlc_object_t * );
70
71 #define RECURSIVE_TEXT N_("Subdirectory behavior")
72 #define RECURSIVE_LONGTEXT N_( \
73         "Select whether subdirectories must be expanded.\n" \
74         "none: subdirectories do not appear in the playlist.\n" \
75         "collapse: subdirectories appear but are expanded on first play.\n" \
76         "expand: all subdirectories are expanded.\n" )
77
78 static const char *psz_recursive_list[] = { "none", "collapse", "expand" };
79 static const char *psz_recursive_list_text[] = { N_("none"), N_("collapse"),
80                                                  N_("expand") };
81
82 #define IGNORE_TEXT N_("Ignored extensions")
83 #define IGNORE_LONGTEXT N_( \
84         "Files with these extensions will not be added to playlist when " \
85         "opening a directory.\n" \
86         "This is useful if you add directories that contain playlist files " \
87         "for instance. Use a comma-separated list of extensions." )
88
89 vlc_module_begin();
90     set_category( CAT_INPUT );
91     set_shortname( _("Directory" ) );
92     set_subcategory( SUBCAT_INPUT_ACCESS );
93     set_description( _("Standard filesystem directory input") );
94     set_capability( "access2", 55 );
95     add_shortcut( "directory" );
96     add_shortcut( "dir" );
97     add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
98                 RECURSIVE_LONGTEXT, VLC_FALSE );
99       change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
100     add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
101                 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, VLC_FALSE );
102     set_callbacks( Open, Close );
103
104     add_submodule();
105         set_description( "Directory EOF");
106         set_capability( "demux2", 0 );
107         add_shortcut( "directory" );
108         set_callbacks( DemuxOpen, NULL );
109 vlc_module_end();
110
111
112 /*****************************************************************************
113  * Local prototypes, constants, structures
114  *****************************************************************************/
115
116 #define MODE_EXPAND 0
117 #define MODE_COLLAPSE 1
118 #define MODE_NONE 2
119
120 static int Read( access_t *, uint8_t *, int );
121 static int ReadNull( access_t *, uint8_t *, int );
122 static int Control( access_t *, int, va_list );
123
124 static int Demux( demux_t *p_demux );
125 static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
126
127
128 static int ReadDir( playlist_t *, const char *psz_name, int i_mode,
129                     playlist_item_t *, playlist_item_t *, input_item_t * );
130
131 /*****************************************************************************
132  * Open: open the directory
133  *****************************************************************************/
134 static int Open( vlc_object_t *p_this )
135 {
136     access_t *p_access = (access_t*)p_this;
137
138     struct stat stat_info;
139
140 #ifdef S_ISDIR
141     if (utf8_stat (p_access->psz_path, &stat_info)
142      || !S_ISDIR (stat_info.st_mode))
143 #else
144     if( strcmp( p_access->psz_access, "dir") &&
145         strcmp( p_access->psz_access, "directory") )
146 #endif
147         return VLC_EGENERIC;
148
149     p_access->pf_read  = Read;
150     p_access->pf_block = NULL;
151     p_access->pf_seek  = NULL;
152     p_access->pf_control= Control;
153
154     /* Force a demux */
155     p_access->psz_demux = strdup( "directory" );
156
157     return VLC_SUCCESS;
158 }
159
160 /*****************************************************************************
161  * Close: close the target
162  *****************************************************************************/
163 static void Close( vlc_object_t * p_this )
164 {
165 }
166
167 /*****************************************************************************
168  * ReadNull: read the directory
169  *****************************************************************************/
170 static int ReadNull( access_t *p_access, uint8_t *p_buffer, int i_len)
171 {
172     /* Return fake data */
173     memset( p_buffer, 0, i_len );
174     return i_len;
175 }
176
177 /*****************************************************************************
178  * Read: read the directory
179  *****************************************************************************/
180 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len)
181 {
182     char               *psz;
183     int                 i_mode, i_activity;
184     playlist_t         *p_playlist = pl_Yield( p_access );
185     playlist_item_t    *p_item_in_category;
186     input_item_t       *p_current_input = input_GetItem(
187                                     (input_thread_t*)p_access->p_parent);
188     playlist_item_t    *p_current = playlist_ItemGetByInput( p_playlist,
189                                                              p_current_input,
190                                                              VLC_FALSE );
191     char               *psz_name = strdup (p_access->psz_path);
192
193     if( psz_name == NULL )
194         return VLC_ENOMEM;
195
196     if( p_current == NULL ) {
197         msg_Err( p_access, "unable to find item in playlist" );
198         return VLC_ENOOBJ;
199     }
200
201     /* Remove the ending '/' char */
202     if (psz_name[0])
203     {
204         char *ptr = psz_name + strlen (psz_name);
205         switch (*--ptr)
206         {
207             case '/':
208             case '\\':
209                 *ptr = '\0';
210         }
211     }
212
213     /* Handle mode */
214     psz = var_CreateGetString( p_access, "recursive" );
215     if( *psz == '\0' || !strncmp( psz, "none" , 4 )  )
216         i_mode = MODE_NONE;
217     else if( !strncmp( psz, "collapse", 8 )  )
218         i_mode = MODE_COLLAPSE;
219     else
220         i_mode = MODE_EXPAND;
221     free( psz );
222
223     msg_Dbg( p_access, "opening directory `%s'", p_access->psz_path );
224
225     p_current->p_input->i_type = ITEM_TYPE_DIRECTORY;
226     p_item_in_category = playlist_ItemToNode( p_playlist, p_current,
227                                               VLC_FALSE );
228
229     i_activity = var_GetInteger( p_playlist, "activity" );
230     var_SetInteger( p_playlist, "activity", i_activity +
231                     DIRECTORY_ACTIVITY );
232
233     ReadDir( p_playlist, psz_name, i_mode, p_current, p_item_in_category,
234              p_current_input );
235
236     i_activity = var_GetInteger( p_playlist, "activity" );
237     var_SetInteger( p_playlist, "activity", i_activity -
238                     DIRECTORY_ACTIVITY );
239
240     if( psz_name ) free( psz_name );
241     vlc_object_release( p_playlist );
242
243     /* Return fake data forever */
244     p_access->pf_read = ReadNull;
245     return ReadNull( p_access, p_buffer, i_len );
246 }
247
248 /*****************************************************************************
249  * DemuxOpen:
250  *****************************************************************************/
251 static int Control( access_t *p_access, int i_query, va_list args )
252 {
253     vlc_bool_t   *pb_bool;
254     int          *pi_int;
255     int64_t      *pi_64;
256
257     switch( i_query )
258     {
259         /* */
260         case ACCESS_CAN_SEEK:
261         case ACCESS_CAN_FASTSEEK:
262         case ACCESS_CAN_PAUSE:
263         case ACCESS_CAN_CONTROL_PACE:
264             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
265             *pb_bool = VLC_FALSE;    /* FIXME */
266             break;
267
268         /* */
269         case ACCESS_GET_MTU:
270             pi_int = (int*)va_arg( args, int * );
271             *pi_int = 0;
272             break;
273
274         case ACCESS_GET_PTS_DELAY:
275             pi_64 = (int64_t*)va_arg( args, int64_t * );
276             *pi_64 = DEFAULT_PTS_DELAY * 1000;
277             break;
278
279         /* */
280         case ACCESS_SET_PAUSE_STATE:
281         case ACCESS_GET_TITLE_INFO:
282         case ACCESS_SET_TITLE:
283         case ACCESS_SET_SEEKPOINT:
284         case ACCESS_SET_PRIVATE_ID_STATE:
285             return VLC_EGENERIC;
286
287         default:
288             msg_Warn( p_access, "unimplemented query in control" );
289             return VLC_EGENERIC;
290     }
291     return VLC_SUCCESS;
292 }
293
294 /*****************************************************************************
295  * DemuxOpen:
296  *****************************************************************************/
297 static int DemuxOpen ( vlc_object_t *p_this )
298 {
299     demux_t *p_demux = (demux_t*)p_this;
300
301     if( strcmp( p_demux->psz_demux, "directory" ) )
302         return VLC_EGENERIC;
303
304     p_demux->pf_demux   = Demux;
305     p_demux->pf_control = DemuxControl;
306     return VLC_SUCCESS;
307 }
308
309 /*****************************************************************************
310  * Demux: EOF
311  *****************************************************************************/
312 static int Demux( demux_t *p_demux )
313 {
314     return 0;
315 }
316
317 /*****************************************************************************
318  * DemuxControl:
319  *****************************************************************************/
320 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
321 {
322     return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
323 }
324
325
326 static int Sort (const char **a, const char **b)
327 {
328     return strcoll (*a, *b);
329 }
330
331 /*****************************************************************************
332  * ReadDir: read a directory and add its content to the list
333  *****************************************************************************/
334 static int ReadDir( playlist_t *p_playlist, const char *psz_name,
335                     int i_mode, playlist_item_t *p_parent,
336                     playlist_item_t *p_parent_category,
337                     input_item_t *p_current_input )
338 {
339     char **pp_dir_content = NULL;
340     int             i_dir_content, i, i_return = VLC_SUCCESS;
341     playlist_item_t *p_node;
342
343     char **ppsz_extensions = NULL;
344     int i_extensions = 0;
345     char *psz_ignore;
346
347     /* Get the first directory entry */
348     i_dir_content = utf8_scandir (psz_name, &pp_dir_content, NULL, Sort);
349     if( i_dir_content == -1 )
350     {
351         msg_Warn( p_playlist, "failed to read directory" );
352         return VLC_EGENERIC;
353     }
354     else if( i_dir_content <= 0 )
355     {
356         /* directory is empty */
357         if( pp_dir_content ) free( pp_dir_content );
358         return VLC_SUCCESS;
359     }
360
361     /* Build array with ignores */
362     psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
363     if( psz_ignore && *psz_ignore )
364     {
365         char *psz_parser = psz_ignore;
366         int a;
367
368         for( a = 0; psz_parser[a] != '\0'; a++ )
369         {
370             if( psz_parser[a] == ',' ) i_extensions++;
371         }
372
373         ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
374
375         for( a = 0; a < i_extensions; a++ )
376         {
377             char *tmp, *ptr;
378
379             while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
380             ptr = strchr( psz_parser, ',');
381             tmp = ( ptr == NULL )
382                  ? strdup( psz_parser )
383                  : strndup( psz_parser, ptr - psz_parser );
384
385             ppsz_extensions[a] = tmp;
386             psz_parser = ptr + 1;
387         }
388     }
389     if( psz_ignore ) free( psz_ignore );
390
391     /* While we still have entries in the directory */
392     for( i = 0; i < i_dir_content; i++ )
393     {
394         const char *entry = pp_dir_content[i];
395         int i_size_entry = strlen( psz_name ) +
396                            strlen( entry ) + 2;
397         char psz_uri[i_size_entry];
398         char psz_mrl[i_size_entry + 7]; /* "file://psz_uri" */
399
400         sprintf( psz_uri, "%s/%s", psz_name, entry);
401
402         /* if it starts with '.' then forget it */
403         if (entry[0] != '.')
404         {
405 #if defined( S_ISDIR )
406             struct stat stat_data;
407
408             if (!utf8_stat (psz_uri, &stat_data)
409              && S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
410 #else
411             if( 0 )
412 #endif
413             {
414 #if defined( S_ISLNK )
415 /*
416  * FIXME: there is a ToCToU race condition here; but it is rather tricky
417  * impossible to fix while keeping some kind of portable code, and maybe even
418  * in a non-portable way.
419  */
420                 if (utf8_lstat (psz_uri, &stat_data)
421                  || S_ISLNK(stat_data.st_mode) )
422                 {
423                     msg_Dbg( p_playlist, "skipping directory symlink %s",
424                              psz_uri );
425                     continue;
426                 }
427 #endif
428                 if( i_mode == MODE_NONE )
429                 {
430                     msg_Dbg( p_playlist, "skipping subdirectory %s", psz_uri );
431                     continue;
432                 }
433                 else if( i_mode == MODE_EXPAND )
434                 {
435                     msg_Dbg(p_playlist, "creading subdirectory %s", psz_uri );
436
437                     p_node = playlist_NodeCreate (p_playlist, entry,
438                                                   p_parent_category);
439
440                     /* If we had the parent in category, the it is now node.
441                      * Else, we still don't have  */
442                     if( ReadDir( p_playlist, psz_uri , MODE_EXPAND,
443                                  p_node, p_parent_category ? p_node : NULL,
444                                  p_current_input )
445                           != VLC_SUCCESS )
446                     {
447                         i_return = VLC_EGENERIC;
448                         break;
449                     }
450                 }
451             }
452             else
453             {
454                 input_item_t *p_input;
455
456                 if( i_extensions > 0 )
457                 {
458                     const char *psz_dot = strrchr (entry, '.' );
459                     if( psz_dot++ && *psz_dot )
460                     {
461                         int a;
462                         for( a = 0; a < i_extensions; a++ )
463                         {
464                             if( !strcmp( psz_dot, ppsz_extensions[a] ) )
465                                 break;
466                         }
467                         if( a < i_extensions )
468                         {
469                             msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
470                             continue;
471                         }
472                     }
473                 }
474
475                 sprintf( &psz_mrl, "file://%s", psz_uri );
476                 p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist),
477                                                  psz_mrl, entry, 0, NULL,
478                                                  -1, ITEM_TYPE_VFILE );
479                 if (p_input != NULL)
480                 {
481                     if( p_current_input )
482                         input_ItemCopyOptions( p_current_input, p_input );
483                     playlist_BothAddInput( p_playlist, p_input,
484                                            p_parent_category,
485                                            PLAYLIST_APPEND|PLAYLIST_PREPARSE,
486                                            PLAYLIST_END, NULL, NULL );
487                 }
488             }
489         }
490     }
491
492     for( i = 0; i < i_extensions; i++ )
493         if( ppsz_extensions[i] ) free( ppsz_extensions[i] );
494     if( ppsz_extensions ) free( ppsz_extensions );
495
496     for( i = 0; i < i_dir_content; i++ )
497         if( pp_dir_content[i] ) free( pp_dir_content[i] );
498     if( pp_dir_content ) free( pp_dir_content );
499
500     return i_return;
501 }