Fix warning and potential memleak.
[vlc.git] / modules / access / directory.c
1 /*****************************************************************************
2  * directory.c: expands a directory (directory: access plug-in)
3  *****************************************************************************
4  * Copyright (C) 2002-2007 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Derk-Jan Hartman <hartman at videolan dot org>
8  *          RĂ©mi Denis-Courmont
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 /*****************************************************************************
26  * Preamble
27  *****************************************************************************/
28
29 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #include <assert.h>
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #warning playlist code must not be used here.
37 #include <vlc_playlist.h>
38 #include <vlc_input.h>
39 #include <vlc_access.h>
40 #include <vlc_demux.h>
41
42 #ifdef HAVE_SYS_TYPES_H
43 #   include <sys/types.h>
44 #endif
45 #ifdef HAVE_SYS_STAT_H
46 #   include <sys/stat.h>
47 #endif
48 #ifdef HAVE_ERRNO_H
49 #   include <errno.h>
50 #endif
51 #ifdef HAVE_FCNTL_H
52 #   include <fcntl.h>
53 #endif
54
55 #ifdef HAVE_UNISTD_H
56 #   include <unistd.h>
57 #elif defined( WIN32 ) && !defined( UNDER_CE )
58 #   include <io.h>
59 #elif defined( UNDER_CE )
60 #   define strcoll strcmp
61 #endif
62
63 #ifdef HAVE_DIRENT_H
64 #   include <dirent.h>
65 #endif
66
67 #include <vlc_charset.h>
68
69 /*****************************************************************************
70  * Module descriptor
71  *****************************************************************************/
72 static int  Open ( vlc_object_t * );
73 static void Close( vlc_object_t * );
74
75 static int  DemuxOpen ( vlc_object_t * );
76
77 #define RECURSIVE_TEXT N_("Subdirectory behavior")
78 #define RECURSIVE_LONGTEXT N_( \
79         "Select whether subdirectories must be expanded.\n" \
80         "none: subdirectories do not appear in the playlist.\n" \
81         "collapse: subdirectories appear but are expanded on first play.\n" \
82         "expand: all subdirectories are expanded.\n" )
83
84 static const char *const psz_recursive_list[] = { "none", "collapse", "expand" };
85 static const char *const psz_recursive_list_text[] = {
86     N_("none"), N_("collapse"), N_("expand") };
87
88 #define IGNORE_TEXT N_("Ignored extensions")
89 #define IGNORE_LONGTEXT N_( \
90         "Files with these extensions will not be added to playlist when " \
91         "opening a directory.\n" \
92         "This is useful if you add directories that contain playlist files " \
93         "for instance. Use a comma-separated list of extensions." )
94
95 vlc_module_begin();
96     set_category( CAT_INPUT );
97     set_shortname( N_("Directory" ) );
98     set_subcategory( SUBCAT_INPUT_ACCESS );
99     set_description( N_("Standard filesystem directory input") );
100     set_capability( "access", 55 );
101     add_shortcut( "directory" );
102     add_shortcut( "dir" );
103     add_shortcut( "file" );
104     add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
105                 RECURSIVE_LONGTEXT, false );
106       change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
107     add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
108                 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, false );
109     set_callbacks( Open, Close );
110
111     add_submodule();
112         set_description( "Directory EOF");
113         set_capability( "demux", 0 );
114         set_callbacks( DemuxOpen, NULL );
115 vlc_module_end();
116
117
118 /*****************************************************************************
119  * Local prototypes, constants, structures
120  *****************************************************************************/
121
122 enum
123 {
124     MODE_EXPAND,
125     MODE_COLLAPSE,
126     MODE_NONE
127 };
128
129 typedef struct stat_list_t stat_list_t;
130
131 static ssize_t Read( access_t *, uint8_t *, size_t );
132 static ssize_t ReadNull( access_t *, uint8_t *, size_t );
133 static int Control( access_t *, int, va_list );
134
135 static int Demux( demux_t *p_demux );
136 static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
137
138
139 static int ReadDir( access_t *, playlist_t *, const char *psz_name,
140                     int i_mode, playlist_item_t *, input_item_t *,
141                     DIR *handle, stat_list_t *stats );
142
143 static DIR *OpenDir (vlc_object_t *obj, const char *psz_name);
144
145 /*****************************************************************************
146  * Open: open the directory
147  *****************************************************************************/
148 static int Open( vlc_object_t *p_this )
149 {
150     access_t *p_access = (access_t*)p_this;
151
152     if( !p_access->psz_path )
153         return VLC_EGENERIC;
154
155     struct stat st;
156     if( !stat( p_access->psz_path, &st ) && !S_ISDIR( st.st_mode ) )
157         return VLC_EGENERIC;
158
159     DIR *handle = OpenDir (p_this, p_access->psz_path);
160     if (handle == NULL)
161         return VLC_EGENERIC;
162
163     p_access->p_sys = (access_sys_t *)handle;
164
165     p_access->pf_read  = Read;
166     p_access->pf_block = NULL;
167     p_access->pf_seek  = NULL;
168     p_access->pf_control= Control;
169
170     /* Force a demux */
171     free( p_access->psz_demux );
172     p_access->psz_demux = strdup( "directory" );
173
174     return VLC_SUCCESS;
175 }
176
177 /*****************************************************************************
178  * Close: close the target
179  *****************************************************************************/
180 static void Close( vlc_object_t * p_this )
181 {
182     access_t *p_access = (access_t*)p_this;
183     DIR *handle = (DIR *)p_access->p_sys;
184     closedir (handle);
185 }
186
187 /*****************************************************************************
188  * ReadNull: read the directory
189  *****************************************************************************/
190 static ssize_t ReadNull( access_t *p_access, uint8_t *p_buffer, size_t i_len)
191 {
192     (void)p_access;
193     /* Return fake data */
194     memset( p_buffer, 0, i_len );
195     return i_len;
196 }
197
198 /*****************************************************************************
199  * Read: read the directory
200  *****************************************************************************/
201 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len)
202 {
203     char               *psz;
204     int                 i_mode;
205     char               *psz_name = strdup( p_access->psz_path );
206
207     if( psz_name == NULL )
208         return VLC_ENOMEM;
209
210     playlist_t         *p_playlist = pl_Yield( p_access );
211     input_thread_t     *p_input = (input_thread_t*)vlc_object_find( p_access, VLC_OBJECT_INPUT, FIND_PARENT );
212
213     playlist_item_t    *p_item_in_category;
214     input_item_t       *p_current_input;
215     playlist_item_t    *p_current;
216
217     if( !p_input )
218     {
219         msg_Err( p_access, "unable to find input (internal error)" );
220         free( psz_name );
221         pl_Release( p_access );
222         return VLC_ENOOBJ;
223     }
224
225     p_current_input = input_GetItem( p_input );
226     p_current = playlist_ItemGetByInput( p_playlist, p_current_input, pl_Unlocked );
227
228     if( !p_current )
229     {
230         msg_Err( p_access, "unable to find item in playlist" );
231         vlc_object_release( p_input );
232         free( psz_name );
233         pl_Release( p_access );
234         return VLC_ENOOBJ;
235     }
236
237     /* Remove the ending '/' char */
238     if( psz_name[0] )
239     {
240         char *ptr = psz_name + strlen (psz_name);
241         switch (*--ptr)
242         {
243             case '/':
244             case '\\':
245                 *ptr = '\0';
246         }
247     }
248
249     /* Handle mode */
250     psz = var_CreateGetString( p_access, "recursive" );
251     if( *psz == '\0' || !strncmp( psz, "none" , 4 )  )
252         i_mode = MODE_NONE;
253     else if( !strncmp( psz, "collapse", 8 )  )
254         i_mode = MODE_COLLAPSE;
255     else
256         i_mode = MODE_EXPAND;
257     free( psz );
258
259     p_current->p_input->i_type = ITEM_TYPE_DIRECTORY;
260     p_item_in_category = playlist_ItemToNode( p_playlist, p_current,
261                                               pl_Unlocked );
262     assert( p_item_in_category );
263
264     ReadDir( p_access, p_playlist, psz_name, i_mode,
265              p_item_in_category,
266              p_current_input, (DIR *)p_access->p_sys, NULL );
267
268     playlist_Signal( p_playlist );
269
270     free( psz_name );
271     vlc_object_release( p_input );
272     pl_Release( p_access );
273
274     /* Return fake data forever */
275     p_access->pf_read = ReadNull;
276     return -1;
277 }
278
279 /*****************************************************************************
280  * Control:
281  *****************************************************************************/
282 static int Control( access_t *p_access, int i_query, va_list args )
283 {
284     bool   *pb_bool;
285     int          *pi_int;
286     int64_t      *pi_64;
287
288     switch( i_query )
289     {
290         /* */
291         case ACCESS_CAN_SEEK:
292         case ACCESS_CAN_FASTSEEK:
293         case ACCESS_CAN_PAUSE:
294         case ACCESS_CAN_CONTROL_PACE:
295             pb_bool = (bool*)va_arg( args, bool* );
296             *pb_bool = false;    /* FIXME */
297             break;
298
299         /* */
300         case ACCESS_GET_MTU:
301             pi_int = (int*)va_arg( args, int * );
302             *pi_int = 0;
303             break;
304
305         case ACCESS_GET_PTS_DELAY:
306             pi_64 = (int64_t*)va_arg( args, int64_t * );
307             *pi_64 = DEFAULT_PTS_DELAY * 1000;
308             break;
309
310         /* */
311         case ACCESS_SET_PAUSE_STATE:
312         case ACCESS_GET_TITLE_INFO:
313         case ACCESS_SET_TITLE:
314         case ACCESS_SET_SEEKPOINT:
315         case ACCESS_SET_PRIVATE_ID_STATE:
316         case ACCESS_GET_CONTENT_TYPE:
317             return VLC_EGENERIC;
318
319         default:
320             msg_Warn( p_access, "unimplemented query in control" );
321             return VLC_EGENERIC;
322     }
323     return VLC_SUCCESS;
324 }
325
326 /*****************************************************************************
327  * DemuxOpen:
328  *****************************************************************************/
329 static int DemuxOpen ( vlc_object_t *p_this )
330 {
331     demux_t *p_demux = (demux_t*)p_this;
332
333     if( strcmp( p_demux->psz_demux, "directory" ) )
334         return VLC_EGENERIC;
335
336     p_demux->pf_demux   = Demux;
337     p_demux->pf_control = DemuxControl;
338     return VLC_SUCCESS;
339 }
340
341 /*****************************************************************************
342  * Demux: EOF
343  *****************************************************************************/
344 static int Demux( demux_t *p_demux )
345 {
346     (void)p_demux;
347     return 0;
348 }
349
350 /*****************************************************************************
351  * DemuxControl:
352  *****************************************************************************/
353 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
354 {
355     return demux_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
356 }
357
358
359 static int Sort (const char **a, const char **b)
360 {
361     return strcoll (*a, *b);
362 }
363
364 struct stat_list_t
365 {
366     stat_list_t *parent;
367     struct stat st;
368 };
369
370
371 /*****************************************************************************
372  * ReadDir: read a directory and add its content to the list
373  *****************************************************************************/
374 static int ReadDir( access_t *p_access, playlist_t *p_playlist,
375                     const char *psz_name,
376                     int i_mode,
377                     playlist_item_t *p_parent_category,
378                     input_item_t *p_current_input,
379                     DIR *handle, stat_list_t *stparent )
380 {
381     char **pp_dir_content = NULL;
382     int             i_dir_content, i, i_return = VLC_SUCCESS;
383     playlist_item_t *p_node;
384
385     if( !vlc_object_alive( p_access ) )
386         return VLC_EGENERIC;
387
388     if( !vlc_object_alive( p_playlist ) )
389         return VLC_EGENERIC;
390
391     char **ppsz_extensions = NULL;
392     int i_extensions = 0;
393     char *psz_ignore;
394
395     struct stat_list_t stself;
396 #ifndef WIN32
397     int fd = dirfd (handle);
398
399     if ((fd == -1) || fstat (fd, &stself.st))
400     {
401         msg_Err (p_playlist, "cannot stat `%s': %m", psz_name);
402         return VLC_EGENERIC;
403     }
404
405     for (stat_list_t *stats = stparent; stats != NULL; stats = stats->parent)
406     {
407         if ((stself.st.st_ino == stats->st.st_ino)
408          && (stself.st.st_dev == stats->st.st_dev))
409         {
410             msg_Warn (p_playlist,
411                       "ignoring infinitely recursive directory `%s'",
412                       psz_name);
413             return VLC_SUCCESS;
414         }
415     }
416 #else
417         /* Windows has st_dev (driver letter - 'A'), but it zeroes st_ino,
418          * so that the test above will always incorrectly succeed.
419          * Besides, Windows does not have dirfd(). */
420 #endif
421
422     stself.parent = stparent;
423
424     /* Get the first directory entry */
425     i_dir_content = utf8_loaddir (handle, &pp_dir_content, NULL, Sort);
426     if( i_dir_content == -1 )
427     {
428         msg_Err (p_playlist, "cannot read `%s': %m", psz_name);
429         return VLC_EGENERIC;
430     }
431     else if( i_dir_content <= 0 )
432     {
433         /* directory is empty */
434         msg_Dbg( p_playlist, "%s directory is empty", psz_name );
435         free( pp_dir_content );
436         return VLC_SUCCESS;
437     }
438
439     /* Build array with ignores */
440     psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
441     if( psz_ignore && *psz_ignore )
442     {
443         char *psz_parser = psz_ignore;
444         int a;
445
446         for( a = 0; psz_parser[a] != '\0'; a++ )
447         {
448             if( psz_parser[a] == ',' ) i_extensions++;
449         }
450
451         ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
452
453         for( a = 0; a < i_extensions; a++ )
454         {
455             char *tmp, *ptr;
456
457             while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
458             ptr = strchr( psz_parser, ',');
459             tmp = ( ptr == NULL )
460                  ? strdup( psz_parser )
461                  : strndup( psz_parser, ptr - psz_parser );
462
463             ppsz_extensions[a] = tmp;
464             psz_parser = ptr + 1;
465         }
466     }
467     free( psz_ignore );
468
469     /* While we still have entries in the directory */
470     for( i = 0; i < i_dir_content; i++ )
471     {
472         const char *entry = pp_dir_content[i];
473         int i_size_entry = strlen( psz_name ) +
474                            strlen( entry ) + 2 + 7 /* strlen("file://") */;
475         char psz_uri[i_size_entry];
476
477         sprintf( psz_uri, "%s/%s", psz_name, entry);
478
479         /* if it starts with '.' then forget it */
480         if (entry[0] != '.')
481         {
482             DIR *subdir = (i_mode != MODE_COLLAPSE)
483                     ? OpenDir (VLC_OBJECT (p_playlist), psz_uri) : NULL;
484
485             if (subdir != NULL) /* Recurse into subdirectory */
486             {
487                 if( i_mode == MODE_NONE )
488                 {
489                     msg_Dbg( p_playlist, "skipping subdirectory `%s'",
490                              psz_uri );
491                     closedir (subdir);
492                     continue;
493                 }
494
495                 msg_Dbg (p_playlist, "creating subdirectory %s", psz_uri);
496
497                 PL_LOCK;
498                 p_node = playlist_NodeCreate( p_playlist, entry,
499                                               p_parent_category,
500                                               PLAYLIST_NO_REBUILD, NULL );
501                 PL_UNLOCK;
502                 assert( p_node );
503                 /* If we had the parent in category, the it is now node.
504                  * Else, we still don't have  */
505                 i_return = ReadDir( p_access, p_playlist, psz_uri , MODE_EXPAND,
506                                     p_parent_category ? p_node : NULL,
507                                     p_current_input, subdir, &stself );
508                 closedir (subdir);
509                 if (i_return)
510                     break; // error :-(
511             }
512             else
513             {
514                 input_item_t *p_input;
515
516                 if( i_extensions > 0 )
517                 {
518                     const char *psz_dot = strrchr (entry, '.' );
519                     if( psz_dot++ && *psz_dot )
520                     {
521                         int a;
522                         for( a = 0; a < i_extensions; a++ )
523                         {
524                             if( !strcmp( psz_dot, ppsz_extensions[a] ) )
525                                 break;
526                         }
527                         if( a < i_extensions )
528                         {
529                             msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
530                             continue;
531                         }
532                     }
533                 }
534
535                 memmove (psz_uri + 7, psz_uri, sizeof (psz_uri) - 7);
536                 memcpy (psz_uri, "file://", 7);
537                 p_input = input_item_NewWithType( VLC_OBJECT( p_playlist ),
538                                                  psz_uri, entry, 0, NULL,
539                                                  -1, ITEM_TYPE_FILE );
540                 if (p_input != NULL)
541                 {
542                     if( p_current_input )
543                         input_item_CopyOptions( p_current_input, p_input );
544                     assert( p_parent_category );
545                     int i_ret = playlist_BothAddInput( p_playlist, p_input,
546                                            p_parent_category,
547                                            PLAYLIST_APPEND|PLAYLIST_PREPARSE|
548                                            PLAYLIST_NO_REBUILD,
549                                            PLAYLIST_END, NULL, NULL,
550                                            pl_Unlocked );
551                     vlc_gc_decref( p_input );
552                     if( i_ret != VLC_SUCCESS )
553                         return VLC_EGENERIC;
554                 }
555             }
556         }
557     }
558
559     for( i = 0; i < i_extensions; i++ )
560         free( ppsz_extensions[i] );
561     free( ppsz_extensions );
562
563     for( i = 0; i < i_dir_content; i++ )
564         free( pp_dir_content[i] );
565     free( pp_dir_content );
566
567     return i_return;
568 }
569
570
571 static DIR *OpenDir (vlc_object_t *obj, const char *path)
572 {
573     msg_Dbg (obj, "opening directory `%s'", path);
574     DIR *handle = utf8_opendir (path);
575     if (handle == NULL)
576     {
577         int err = errno;
578         if (err != ENOTDIR)
579             msg_Err (obj, "%s: %m", path);
580         else
581             msg_Dbg (obj, "skipping non-directory `%s'", path);
582         errno = err;
583
584         return NULL;
585     }
586     return handle;
587 }