1 /*****************************************************************************
2 * directory.c: expands a directory (directory: access plug-in)
3 *****************************************************************************
4 * Copyright (C) 2002-2007 the VideoLAN team
7 * Authors: Derk-Jan Hartman <hartman at videolan dot org>
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.
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.
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 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
34 #include <vlc_playlist.h>
35 #include <vlc_input.h>
36 #include <vlc_access.h>
37 #include <vlc_demux.h>
39 #ifdef HAVE_SYS_TYPES_H
40 # include <sys/types.h>
42 #ifdef HAVE_SYS_STAT_H
43 # include <sys/stat.h>
54 #elif defined( WIN32 ) && !defined( UNDER_CE )
56 #elif defined( UNDER_CE )
57 # define strcoll strcmp
64 #include <vlc_charset.h>
66 /*****************************************************************************
68 *****************************************************************************/
69 static int Open ( vlc_object_t * );
70 static void Close( vlc_object_t * );
72 static int DemuxOpen ( vlc_object_t * );
74 #define RECURSIVE_TEXT N_("Subdirectory behavior")
75 #define RECURSIVE_LONGTEXT N_( \
76 "Select whether subdirectories must be expanded.\n" \
77 "none: subdirectories do not appear in the playlist.\n" \
78 "collapse: subdirectories appear but are expanded on first play.\n" \
79 "expand: all subdirectories are expanded.\n" )
81 static const char *psz_recursive_list[] = { "none", "collapse", "expand" };
82 static const char *psz_recursive_list_text[] = { N_("none"), N_("collapse"),
85 #define IGNORE_TEXT N_("Ignored extensions")
86 #define IGNORE_LONGTEXT N_( \
87 "Files with these extensions will not be added to playlist when " \
88 "opening a directory.\n" \
89 "This is useful if you add directories that contain playlist files " \
90 "for instance. Use a comma-separated list of extensions." )
93 set_category( CAT_INPUT );
94 set_shortname( _("Directory" ) );
95 set_subcategory( SUBCAT_INPUT_ACCESS );
96 set_description( _("Standard filesystem directory input") );
97 set_capability( "access", 55 );
98 add_shortcut( "directory" );
99 add_shortcut( "dir" );
100 add_shortcut( "file" );
101 add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
102 RECURSIVE_LONGTEXT, false );
103 change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
104 add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
105 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, false );
106 set_callbacks( Open, Close );
109 set_description( "Directory EOF");
110 set_capability( "demux", 0 );
111 set_callbacks( DemuxOpen, NULL );
115 /*****************************************************************************
116 * Local prototypes, constants, structures
117 *****************************************************************************/
126 typedef struct stat_list_t stat_list_t;
128 static ssize_t Read( access_t *, uint8_t *, size_t );
129 static ssize_t ReadNull( access_t *, uint8_t *, size_t );
130 static int Control( access_t *, int, va_list );
132 static int Demux( demux_t *p_demux );
133 static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
136 static int ReadDir( playlist_t *, const char *psz_name, int i_mode,
137 playlist_item_t *, playlist_item_t *, input_item_t *,
138 DIR *handle, stat_list_t *stats );
140 static DIR *OpenDir (vlc_object_t *obj, const char *psz_name);
142 /*****************************************************************************
143 * Open: open the directory
144 *****************************************************************************/
145 static int Open( vlc_object_t *p_this )
147 access_t *p_access = (access_t*)p_this;
149 if( !p_access->psz_path )
153 if( !stat( p_access->psz_path, &st ) && !S_ISDIR( st.st_mode ) )
156 DIR *handle = OpenDir (p_this, p_access->psz_path);
160 p_access->p_sys = (access_sys_t *)handle;
162 p_access->pf_read = Read;
163 p_access->pf_block = NULL;
164 p_access->pf_seek = NULL;
165 p_access->pf_control= Control;
168 p_access->psz_demux = strdup( "directory" );
173 /*****************************************************************************
174 * Close: close the target
175 *****************************************************************************/
176 static void Close( vlc_object_t * p_this )
178 access_t *p_access = (access_t*)p_this;
179 DIR *handle = (DIR *)p_access->p_sys;
183 /*****************************************************************************
184 * ReadNull: read the directory
185 *****************************************************************************/
186 static ssize_t ReadNull( access_t *p_access, uint8_t *p_buffer, size_t i_len)
188 /* Return fake data */
189 memset( p_buffer, 0, i_len );
193 /*****************************************************************************
194 * Read: read the directory
195 *****************************************************************************/
196 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len)
199 int i_mode, i_activity;
200 char *psz_name = strdup (p_access->psz_path);
202 if( psz_name == NULL )
205 playlist_t *p_playlist = pl_Yield( p_access );
206 input_thread_t *p_input = (input_thread_t*)vlc_object_find( p_access, VLC_OBJECT_INPUT, FIND_PARENT );
208 playlist_item_t *p_item_in_category;
209 input_item_t *p_current_input;
210 playlist_item_t *p_current;
214 msg_Err( p_access, "unable to find input (internal error)" );
215 vlc_object_release( p_playlist );
219 p_current_input = input_GetItem( p_input );
220 p_current = playlist_ItemGetByInput( p_playlist, p_current_input, false );
224 msg_Err( p_access, "unable to find item in playlist" );
225 vlc_object_release( p_input );
226 vlc_object_release( p_playlist );
230 /* Remove the ending '/' char */
233 char *ptr = psz_name + strlen (psz_name);
243 psz = var_CreateGetString( p_access, "recursive" );
244 if( *psz == '\0' || !strncmp( psz, "none" , 4 ) )
246 else if( !strncmp( psz, "collapse", 8 ) )
247 i_mode = MODE_COLLAPSE;
249 i_mode = MODE_EXPAND;
252 p_current->p_input->i_type = ITEM_TYPE_DIRECTORY;
253 p_item_in_category = playlist_ItemToNode( p_playlist, p_current,
256 i_activity = var_GetInteger( p_playlist, "activity" );
257 var_SetInteger( p_playlist, "activity", i_activity +
258 DIRECTORY_ACTIVITY );
260 ReadDir( p_playlist, psz_name, i_mode, p_current, p_item_in_category,
261 p_current_input, (DIR *)p_access->p_sys, NULL );
263 i_activity = var_GetInteger( p_playlist, "activity" );
264 var_SetInteger( p_playlist, "activity", i_activity -
265 DIRECTORY_ACTIVITY );
267 playlist_Signal( p_playlist );
270 vlc_object_release( p_input );
271 vlc_object_release( p_playlist );
273 /* Return fake data forever */
274 p_access->pf_read = ReadNull;
278 /*****************************************************************************
280 *****************************************************************************/
281 static int Control( access_t *p_access, int i_query, va_list args )
290 case ACCESS_CAN_SEEK:
291 case ACCESS_CAN_FASTSEEK:
292 case ACCESS_CAN_PAUSE:
293 case ACCESS_CAN_CONTROL_PACE:
294 pb_bool = (bool*)va_arg( args, bool* );
295 *pb_bool = false; /* FIXME */
300 pi_int = (int*)va_arg( args, int * );
304 case ACCESS_GET_PTS_DELAY:
305 pi_64 = (int64_t*)va_arg( args, int64_t * );
306 *pi_64 = DEFAULT_PTS_DELAY * 1000;
310 case ACCESS_SET_PAUSE_STATE:
311 case ACCESS_GET_TITLE_INFO:
312 case ACCESS_SET_TITLE:
313 case ACCESS_SET_SEEKPOINT:
314 case ACCESS_SET_PRIVATE_ID_STATE:
315 case ACCESS_GET_CONTENT_TYPE:
319 msg_Warn( p_access, "unimplemented query in control" );
325 /*****************************************************************************
327 *****************************************************************************/
328 static int DemuxOpen ( vlc_object_t *p_this )
330 demux_t *p_demux = (demux_t*)p_this;
332 if( strcmp( p_demux->psz_demux, "directory" ) )
335 p_demux->pf_demux = Demux;
336 p_demux->pf_control = DemuxControl;
340 /*****************************************************************************
342 *****************************************************************************/
343 static int Demux( demux_t *p_demux )
348 /*****************************************************************************
350 *****************************************************************************/
351 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
353 return demux_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
357 static int Sort (const char **a, const char **b)
359 return strcoll (*a, *b);
369 /*****************************************************************************
370 * ReadDir: read a directory and add its content to the list
371 *****************************************************************************/
372 static int ReadDir( playlist_t *p_playlist, const char *psz_name,
373 int i_mode, playlist_item_t *p_parent,
374 playlist_item_t *p_parent_category,
375 input_item_t *p_current_input,
376 DIR *handle, stat_list_t *stparent )
378 char **pp_dir_content = NULL;
379 int i_dir_content, i, i_return = VLC_SUCCESS;
380 playlist_item_t *p_node;
382 char **ppsz_extensions = NULL;
383 int i_extensions = 0;
386 struct stat_list_t stself;
388 int fd = dirfd (handle);
390 if ((fd == -1) || fstat (fd, &stself.st))
392 msg_Err (p_playlist, "cannot stat `%s': %m", psz_name);
396 for (stat_list_t *stats = stparent; stats != NULL; stats = stats->parent)
398 if ((stself.st.st_ino == stats->st.st_ino)
399 && (stself.st.st_dev == stats->st.st_dev))
401 msg_Warn (p_playlist,
402 "ignoring infinitely recursive directory `%s'",
408 /* Windows has st_dev (driver letter - 'A'), but it zeroes st_ino,
409 * so that the test above will always incorrectly succeed.
410 * Besides, Windows does not have dirfd(). */
413 stself.parent = stparent;
415 /* Get the first directory entry */
416 i_dir_content = utf8_loaddir (handle, &pp_dir_content, NULL, Sort);
417 if( i_dir_content == -1 )
419 msg_Err (p_playlist, "cannot read `%s': %m", psz_name);
422 else if( i_dir_content <= 0 )
424 /* directory is empty */
425 msg_Dbg( p_playlist, "%s directory is empty", psz_name );
426 free( pp_dir_content );
430 /* Build array with ignores */
431 psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
432 if( psz_ignore && *psz_ignore )
434 char *psz_parser = psz_ignore;
437 for( a = 0; psz_parser[a] != '\0'; a++ )
439 if( psz_parser[a] == ',' ) i_extensions++;
442 ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
444 for( a = 0; a < i_extensions; a++ )
448 while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
449 ptr = strchr( psz_parser, ',');
450 tmp = ( ptr == NULL )
451 ? strdup( psz_parser )
452 : strndup( psz_parser, ptr - psz_parser );
454 ppsz_extensions[a] = tmp;
455 psz_parser = ptr + 1;
460 /* While we still have entries in the directory */
461 for( i = 0; i < i_dir_content; i++ )
463 const char *entry = pp_dir_content[i];
464 int i_size_entry = strlen( psz_name ) +
465 strlen( entry ) + 2 + 7 /* strlen("file://") */;
466 char psz_uri[i_size_entry];
468 sprintf( psz_uri, "%s/%s", psz_name, entry);
470 /* if it starts with '.' then forget it */
473 DIR *subdir = (i_mode != MODE_COLLAPSE)
474 ? OpenDir (VLC_OBJECT (p_playlist), psz_uri) : NULL;
476 if (subdir != NULL) /* Recurse into subdirectory */
478 if( i_mode == MODE_NONE )
480 msg_Dbg( p_playlist, "skipping subdirectory `%s'",
486 msg_Dbg (p_playlist, "creating subdirectory %s", psz_uri);
488 p_node = playlist_NodeCreate( p_playlist, entry,
490 PLAYLIST_NO_REBUILD, NULL );
492 /* If we had the parent in category, the it is now node.
493 * Else, we still don't have */
494 i_return = ReadDir( p_playlist, psz_uri , MODE_EXPAND,
495 p_node, p_parent_category ? p_node : NULL,
496 p_current_input, subdir, &stself );
503 input_item_t *p_input;
505 if( i_extensions > 0 )
507 const char *psz_dot = strrchr (entry, '.' );
508 if( psz_dot++ && *psz_dot )
511 for( a = 0; a < i_extensions; a++ )
513 if( !strcmp( psz_dot, ppsz_extensions[a] ) )
516 if( a < i_extensions )
518 msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
524 memmove (psz_uri + 7, psz_uri, sizeof (psz_uri) - 7);
525 memcpy (psz_uri, "file://", 7);
526 p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist),
527 psz_uri, entry, 0, NULL,
528 -1, ITEM_TYPE_FILE );
531 if( p_current_input )
532 input_ItemCopyOptions( p_current_input, p_input );
533 int i_ret = playlist_BothAddInput( p_playlist, p_input,
535 PLAYLIST_APPEND|PLAYLIST_PREPARSE|
537 PLAYLIST_END, NULL, NULL,
539 vlc_gc_decref( p_input );
540 if( i_ret != VLC_SUCCESS )
547 for( i = 0; i < i_extensions; i++ )
548 free( ppsz_extensions[i] );
549 free( ppsz_extensions );
551 for( i = 0; i < i_dir_content; i++ )
552 free( pp_dir_content[i] );
553 free( pp_dir_content );
559 static DIR *OpenDir (vlc_object_t *obj, const char *path)
561 msg_Dbg (obj, "opening directory `%s'", path);
562 DIR *handle = utf8_opendir (path);
567 msg_Err (obj, "%s: %m", path);
569 msg_Dbg (obj, "skipping non-directory `%s'", path);