1 /*****************************************************************************
2 * directory.c: expands a directory (directory: access plug-in)
3 *****************************************************************************
4 * Copyright (C) 2002-2004 the VideoLAN team
7 * Authors: Derk-Jan Hartman <hartman at videolan dot org>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
29 #include <vlc/input.h>
30 #include <vlc_playlist.h>
31 #include <vlc_input.h>
35 #ifdef HAVE_SYS_TYPES_H
36 # include <sys/types.h>
38 #ifdef HAVE_SYS_STAT_H
39 # include <sys/stat.h>
50 #elif defined( WIN32 ) && !defined( UNDER_CE )
52 #elif defined( UNDER_CE )
53 # define strcoll strcmp
62 /*****************************************************************************
64 *****************************************************************************/
65 static int Open ( vlc_object_t * );
66 static void Close( vlc_object_t * );
68 static int DemuxOpen ( vlc_object_t * );
70 #define RECURSIVE_TEXT N_("Subdirectory behavior")
71 #define RECURSIVE_LONGTEXT N_( \
72 "Select whether subdirectories must be expanded.\n" \
73 "none: subdirectories do not appear in the playlist.\n" \
74 "collapse: subdirectories appear but are expanded on first play.\n" \
75 "expand: all subdirectories are expanded.\n" )
77 static const char *psz_recursive_list[] = { "none", "collapse", "expand" };
78 static const char *psz_recursive_list_text[] = { N_("none"), N_("collapse"),
81 #define IGNORE_TEXT N_("Ignored extensions")
82 #define IGNORE_LONGTEXT N_( \
83 "Files with these extensions will not be added to playlist when " \
84 "opening a directory.\n" \
85 "This is useful if you add directories that contain playlist files " \
86 "for instance. Use a comma-separated list of extensions." )
89 set_category( CAT_INPUT );
90 set_shortname( _("Directory" ) );
91 set_subcategory( SUBCAT_INPUT_ACCESS );
92 set_description( _("Standard filesystem directory input") );
93 set_capability( "access2", 55 );
94 add_shortcut( "directory" );
95 add_shortcut( "dir" );
96 add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
97 RECURSIVE_LONGTEXT, VLC_FALSE );
98 change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
99 add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
100 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, VLC_FALSE );
101 set_callbacks( Open, Close );
104 set_description( "Directory EOF");
105 set_capability( "demux2", 0 );
106 add_shortcut( "directory" );
107 set_callbacks( DemuxOpen, NULL );
111 /*****************************************************************************
112 * Local prototypes, constants, structures
113 *****************************************************************************/
115 #define MODE_EXPAND 0
116 #define MODE_COLLAPSE 1
119 static int Read( access_t *, uint8_t *, int );
120 static int ReadNull( access_t *, uint8_t *, int );
121 static int Control( access_t *, int, va_list );
123 static int Demux( demux_t *p_demux );
124 static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
127 static int ReadDir( playlist_t *, const char *psz_name, int i_mode,
128 playlist_item_t *, playlist_item_t * );
130 /*****************************************************************************
131 * Open: open the directory
132 *****************************************************************************/
133 static int Open( vlc_object_t *p_this )
135 access_t *p_access = (access_t*)p_this;
137 struct stat stat_info;
140 if (utf8_stat (p_access->psz_path, &stat_info)
141 || !S_ISDIR (stat_info.st_mode))
143 if( strcmp( p_access->psz_access, "dir") &&
144 strcmp( p_access->psz_access, "directory") )
148 p_access->pf_read = Read;
149 p_access->pf_block = NULL;
150 p_access->pf_seek = NULL;
151 p_access->pf_control= Control;
154 p_access->psz_demux = strdup( "directory" );
159 /*****************************************************************************
160 * Close: close the target
161 *****************************************************************************/
162 static void Close( vlc_object_t * p_this )
166 /*****************************************************************************
167 * ReadNull: read the directory
168 *****************************************************************************/
169 static int ReadNull( access_t *p_access, uint8_t *p_buffer, int i_len)
171 /* Return fake data */
172 memset( p_buffer, 0, i_len );
176 /*****************************************************************************
177 * Read: read the directory
178 *****************************************************************************/
179 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len)
182 int i_mode, i_activity;
184 char *psz_name = strdup (p_access->psz_path);
185 if (psz_name == NULL)
188 /* Remove the ending '/' char */
191 char *ptr = psz_name + strlen (psz_name);
200 playlist_item_t *p_item, *p_root_category;
201 playlist_t *p_playlist = pl_Yield( p_access );
204 psz = var_CreateGetString( p_access, "recursive" );
205 if( *psz == '\0' || !strncmp( psz, "none" , 4 ) )
207 else if( !strncmp( psz, "collapse", 8 ) )
208 i_mode = MODE_COLLAPSE;
210 i_mode = MODE_EXPAND;
213 msg_Dbg( p_access, "opening directory `%s'", p_access->psz_path );
215 if( p_playlist->status.p_item && p_playlist->status.p_item->p_input ==
216 ((input_thread_t *)p_access->p_parent)->input.p_item )
217 p_item = p_playlist->status.p_item;
220 input_item_t *p_current = ( (input_thread_t*)p_access->p_parent)->
222 p_item = playlist_LockItemGetByInput( p_playlist, p_current );
225 msg_Dbg( p_playlist, "unable to find item in playlist");
229 p_item->p_input->i_type = ITEM_TYPE_DIRECTORY;
231 p_root_category = playlist_LockItemToNode( p_playlist, p_item );
233 i_activity = var_GetInteger( p_playlist, "activity" );
234 var_SetInteger( p_playlist, "activity", i_activity +
235 DIRECTORY_ACTIVITY );
237 ReadDir( p_playlist, psz_name, i_mode, p_item, p_root_category );
239 i_activity = var_GetInteger( p_playlist, "activity" );
240 var_SetInteger( p_playlist, "activity", i_activity -
241 DIRECTORY_ACTIVITY );
242 if( psz_name ) free( psz_name );
243 vlc_object_release( p_playlist );
245 /* Return fake data forever */
246 p_access->pf_read = ReadNull;
247 return ReadNull( p_access, p_buffer, i_len );
250 /*****************************************************************************
252 *****************************************************************************/
253 static int Control( access_t *p_access, int i_query, va_list args )
262 case ACCESS_CAN_SEEK:
263 case ACCESS_CAN_FASTSEEK:
264 case ACCESS_CAN_PAUSE:
265 case ACCESS_CAN_CONTROL_PACE:
266 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
267 *pb_bool = VLC_FALSE; /* FIXME */
272 pi_int = (int*)va_arg( args, int * );
276 case ACCESS_GET_PTS_DELAY:
277 pi_64 = (int64_t*)va_arg( args, int64_t * );
278 *pi_64 = DEFAULT_PTS_DELAY * 1000;
282 case ACCESS_SET_PAUSE_STATE:
283 case ACCESS_GET_TITLE_INFO:
284 case ACCESS_SET_TITLE:
285 case ACCESS_SET_SEEKPOINT:
286 case ACCESS_SET_PRIVATE_ID_STATE:
290 msg_Warn( p_access, "unimplemented query in control" );
296 /*****************************************************************************
298 *****************************************************************************/
299 static int DemuxOpen ( vlc_object_t *p_this )
301 demux_t *p_demux = (demux_t*)p_this;
303 if( strcmp( p_demux->psz_demux, "directory" ) )
306 p_demux->pf_demux = Demux;
307 p_demux->pf_control = DemuxControl;
311 /*****************************************************************************
313 *****************************************************************************/
314 static int Demux( demux_t *p_demux )
319 /*****************************************************************************
321 *****************************************************************************/
322 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
324 return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
328 static int Sort (const char **a, const char **b)
330 return strcoll (*a, *b);
333 /*****************************************************************************
334 * ReadDir: read a directory and add its content to the list
335 *****************************************************************************/
336 static int ReadDir( playlist_t *p_playlist, const char *psz_name,
337 int i_mode, playlist_item_t *p_parent,
338 playlist_item_t *p_parent_category )
340 char **pp_dir_content = NULL;
341 int i_dir_content, i, i_return = VLC_SUCCESS;
342 playlist_item_t *p_node;
344 char **ppsz_extensions = NULL;
345 int i_extensions = 0;
348 /* Get the first directory entry */
349 i_dir_content = utf8_scandir (psz_name, &pp_dir_content, NULL, Sort);
350 if( i_dir_content == -1 )
352 msg_Warn( p_playlist, "failed to read directory" );
355 else if( i_dir_content <= 0 )
357 /* directory is empty */
358 if( pp_dir_content ) free( pp_dir_content );
362 /* Build array with ignores */
363 psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
364 if( psz_ignore && *psz_ignore )
366 char *psz_parser = psz_ignore;
369 for( a = 0; psz_parser[a] != '\0'; a++ )
371 if( psz_parser[a] == ',' ) i_extensions++;
374 ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
376 for( a = 0; a < i_extensions; a++ )
380 while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
381 ptr = strchr( psz_parser, ',');
382 tmp = ( ptr == NULL )
383 ? strdup( psz_parser )
384 : strndup( psz_parser, ptr - psz_parser );
386 ppsz_extensions[a] = tmp;
387 psz_parser = ptr + 1;
390 if( psz_ignore ) free( psz_ignore );
392 /* While we still have entries in the directory */
393 for( i = 0; i < i_dir_content; i++ )
395 const char *entry = pp_dir_content[i];
396 int i_size_entry = strlen( psz_name ) +
398 char psz_uri[i_size_entry];
400 sprintf( psz_uri, "%s/%s", psz_name, entry);
402 /* if it starts with '.' then forget it */
405 #if defined( S_ISDIR )
406 struct stat stat_data;
408 if (!utf8_stat (psz_uri, &stat_data)
409 && S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
414 #if defined( S_ISLNK )
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.
420 if (utf8_lstat (psz_uri, &stat_data)
421 || S_ISLNK(stat_data.st_mode) )
423 msg_Dbg( p_playlist, "skipping directory symlink %s",
428 if( i_mode == MODE_NONE )
430 msg_Dbg( p_playlist, "skipping subdirectory %s", psz_uri );
433 else if( i_mode == MODE_EXPAND )
435 msg_Dbg(p_playlist, "creading subdirectory %s", psz_uri );
437 p_node = playlist_NodeCreate (p_playlist, entry,
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 )
446 i_return = VLC_EGENERIC;
453 input_item_t *p_input;
455 if( i_extensions > 0 )
457 const char *psz_dot = strrchr (entry, '.' );
458 if( psz_dot++ && *psz_dot )
461 for( a = 0; a < i_extensions; a++ )
463 if( !strcmp( psz_dot, ppsz_extensions[a] ) )
466 if( a < i_extensions )
468 msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
474 p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist),
475 psz_uri, entry, 0, NULL,
476 -1, ITEM_TYPE_VFILE );
478 playlist_AddWhereverNeeded (p_playlist, p_input, p_parent,
479 p_parent_category, VLC_FALSE,
480 PLAYLIST_APPEND|PLAYLIST_PREPARSE);
485 for( i = 0; i < i_extensions; i++ )
486 if( ppsz_extensions[i] ) free( ppsz_extensions[i] );
487 if( ppsz_extensions ) free( ppsz_extensions );
489 for( i = 0; i < i_dir_content; i++ )
490 if( pp_dir_content[i] ) free( pp_dir_content[i] );
491 if( pp_dir_content ) free( pp_dir_content );