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>
34 #ifdef HAVE_SYS_TYPES_H
35 # include <sys/types.h>
37 #ifdef HAVE_SYS_STAT_H
38 # include <sys/stat.h>
49 #elif defined( WIN32 ) && !defined( UNDER_CE )
51 #elif defined( UNDER_CE )
52 # define strcoll strcmp
61 /*****************************************************************************
63 *****************************************************************************/
64 static int Open ( vlc_object_t * );
65 static void Close( vlc_object_t * );
67 static int DemuxOpen ( vlc_object_t * );
69 #define RECURSIVE_TEXT N_("Subdirectory behavior")
70 #define RECURSIVE_LONGTEXT N_( \
71 "Select whether subdirectories must be expanded.\n" \
72 "none: subdirectories do not appear in the playlist.\n" \
73 "collapse: subdirectories appear but are expanded on first play.\n" \
74 "expand: all subdirectories are expanded.\n" )
76 static char *psz_recursive_list[] = { "none", "collapse", "expand" };
77 static char *psz_recursive_list_text[] = { N_("none"), N_("collapse"),
80 #define IGNORE_TEXT N_("Ignored extensions")
81 #define IGNORE_LONGTEXT N_( \
82 "Files with these extensions will not be added to playlist when " \
83 "opening a directory.\n" \
84 "This is useful if you add directories that contain playlist files " \
85 "for instance. Use a comma-separated list of extensions." )
88 set_category( CAT_INPUT );
89 set_shortname( _("Directory" ) );
90 set_subcategory( SUBCAT_INPUT_ACCESS );
91 set_description( _("Standard filesystem directory input") );
92 set_capability( "access2", 55 );
93 add_shortcut( "directory" );
94 add_shortcut( "dir" );
95 add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
96 RECURSIVE_LONGTEXT, VLC_FALSE );
97 change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
98 add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
99 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, VLC_FALSE );
100 set_callbacks( Open, Close );
103 set_description( "Directory EOF");
104 set_capability( "demux2", 0 );
105 add_shortcut( "directory" );
106 set_callbacks( DemuxOpen, NULL );
110 /*****************************************************************************
111 * Local prototypes, constants, structures
112 *****************************************************************************/
114 #define MODE_EXPAND 0
115 #define MODE_COLLAPSE 1
118 static int Read( access_t *, uint8_t *, int );
119 static int ReadNull( access_t *, uint8_t *, int );
120 static int Control( access_t *, int, va_list );
122 static int Demux( demux_t *p_demux );
123 static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
126 static int ReadDir( playlist_t *, const char *psz_name, int i_mode,
129 /*****************************************************************************
130 * Open: open the directory
131 *****************************************************************************/
132 static int Open( vlc_object_t *p_this )
134 access_t *p_access = (access_t*)p_this;
136 #ifdef HAVE_SYS_STAT_H
137 struct stat stat_info;
138 char *psz_path = ToLocale( p_access->psz_path );
140 if( ( stat( psz_path, &stat_info ) == -1 ) ||
141 !S_ISDIR( stat_info.st_mode ) )
146 wchar_t psz_path[MAX_PATH];
147 mbstowcs( psz_path, p_access->psz_path, MAX_PATH );
148 psz_path[MAX_PATH-1] = 0;
150 char *psz_path = p_access->psz_path;
151 # endif /* UNICODE */
153 i_ret = GetFileAttributes( psz_path );
154 if( i_ret == -1 || !(i_ret & FILE_ATTRIBUTE_DIRECTORY) )
157 if( strcmp( p_access->psz_access, "dir") &&
158 strcmp( p_access->psz_access, "directory") )
161 LocaleFree( psz_path );
165 LocaleFree( psz_path );
166 p_access->pf_read = Read;
167 p_access->pf_block = NULL;
168 p_access->pf_seek = NULL;
169 p_access->pf_control= Control;
172 p_access->psz_demux = strdup( "directory" );
177 /*****************************************************************************
178 * Close: close the target
179 *****************************************************************************/
180 static void Close( vlc_object_t * p_this )
184 /*****************************************************************************
185 * ReadNull: read the directory
186 *****************************************************************************/
187 static int ReadNull( access_t *p_access, uint8_t *p_buffer, int i_len)
189 /* Return fake data */
190 memset( p_buffer, 0, i_len );
194 /*****************************************************************************
195 * Read: read the directory
196 *****************************************************************************/
197 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len)
199 char *psz_name = NULL;
203 playlist_item_t *p_item;
204 vlc_bool_t b_play = VLC_FALSE;
206 playlist_t *p_playlist =
207 (playlist_t *) vlc_object_find( p_access,
208 VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
212 msg_Err( p_access, "can't find playlist" );
219 psz_name = ToLocale( p_access->psz_path );
220 ptr = strdup( psz_name );
221 LocaleFree( psz_name );
227 /* Remove the ending '/' char */
228 ptr += strlen( ptr );
229 if( ( ptr > psz_name ) )
240 /* Initialize structure */
241 psz = var_CreateGetString( p_access, "recursive" );
242 if( *psz == '\0' || !strncmp( psz, "none" , 4 ) )
246 else if( !strncmp( psz, "collapse", 8 ) )
248 i_mode = MODE_COLLAPSE;
252 i_mode = MODE_EXPAND;
256 /* Make sure we are deleted when we are done */
257 /* The playlist position we will use for the add */
258 i_pos = p_playlist->i_index + 1;
260 msg_Dbg( p_access, "opening directory `%s'", p_access->psz_path );
262 if( &p_playlist->status.p_item->input ==
263 ((input_thread_t *)p_access->p_parent)->input.p_item )
265 p_item = p_playlist->status.p_item;
267 msg_Dbg( p_access, "starting directory playback");
271 input_item_t *p_current = ( (input_thread_t*)p_access->p_parent)->
273 p_item = playlist_LockItemGetByInput( p_playlist, p_current );
274 msg_Dbg( p_access, "not starting directory playback");
277 msg_Dbg( p_playlist, "unable to find item in playlist");
283 p_item->input.i_type = ITEM_TYPE_DIRECTORY;
284 if( ReadDir( p_playlist, psz_name , i_mode, p_item ) != VLC_SUCCESS )
289 /* Begin to read the directory */
292 playlist_Control( p_playlist, PLAYLIST_VIEWPLAY,
293 p_playlist->status.i_view,
294 p_playlist->status.p_item, NULL );
296 if( psz_name ) free( psz_name );
297 vlc_object_release( p_playlist );
299 /* Return fake data forever */
300 p_access->pf_read = ReadNull;
301 return ReadNull( p_access, p_buffer, i_len );
304 /*****************************************************************************
306 *****************************************************************************/
307 static int Control( access_t *p_access, int i_query, va_list args )
316 case ACCESS_CAN_SEEK:
317 case ACCESS_CAN_FASTSEEK:
318 case ACCESS_CAN_PAUSE:
319 case ACCESS_CAN_CONTROL_PACE:
320 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
321 *pb_bool = VLC_FALSE; /* FIXME */
326 pi_int = (int*)va_arg( args, int * );
330 case ACCESS_GET_PTS_DELAY:
331 pi_64 = (int64_t*)va_arg( args, int64_t * );
332 *pi_64 = DEFAULT_PTS_DELAY * 1000;
336 case ACCESS_SET_PAUSE_STATE:
337 case ACCESS_GET_TITLE_INFO:
338 case ACCESS_SET_TITLE:
339 case ACCESS_SET_SEEKPOINT:
340 case ACCESS_SET_PRIVATE_ID_STATE:
344 msg_Warn( p_access, "unimplemented query in control" );
350 /*****************************************************************************
352 *****************************************************************************/
353 static int DemuxOpen ( vlc_object_t *p_this )
355 demux_t *p_demux = (demux_t*)p_this;
357 if( strcmp( p_demux->psz_demux, "directory" ) )
360 p_demux->pf_demux = Demux;
361 p_demux->pf_control = DemuxControl;
365 /*****************************************************************************
367 *****************************************************************************/
368 static int Demux( demux_t *p_demux )
373 /*****************************************************************************
375 *****************************************************************************/
376 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
378 return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
381 static int Filter( const struct dirent *foo )
386 /*****************************************************************************
387 * ReadDir: read a directory and add its content to the list
388 *****************************************************************************/
389 static int ReadDir( playlist_t *p_playlist, const char *psz_name,
390 int i_mode, playlist_item_t *p_parent )
392 struct dirent **pp_dir_content;
393 int i_dir_content, i;
394 playlist_item_t *p_node;
396 /* Build array with ignores */
397 char **ppsz_extensions = 0;
398 int i_extensions = 0;
399 char *psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
400 if( psz_ignore && *psz_ignore )
402 char *psz_parser = psz_ignore;
405 for( a = 0; psz_parser[a] != '\0'; a++ )
407 if( psz_parser[a] == ',' ) i_extensions++;
410 ppsz_extensions = (char **)malloc( sizeof( char * ) * i_extensions );
412 for( a = 0; a < i_extensions; a++ )
417 while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
418 for( b = 0; psz_parser[b] != '\0'; b++ )
420 if( psz_parser[b] == ',' ) break;
422 tmp = malloc( b + 1 );
423 strncpy( tmp, psz_parser, b );
425 ppsz_extensions[a] = tmp;
430 /* Change the item to a node */
431 if( p_parent->i_children == -1 )
433 playlist_LockItemToNode( p_playlist,p_parent );
436 /* get the first directory entry */
437 i_dir_content = scandir( psz_name, &pp_dir_content, Filter, alphasort );
438 if( i_dir_content == -1 )
440 msg_Warn( p_playlist, "Failed to read directory" );
443 else if( i_dir_content <= 0 )
445 /* directory is empty */
449 /* While we still have entries in the directory */
450 for( i = 0; i < i_dir_content; i++ )
452 struct dirent *p_dir_content = pp_dir_content[i];
453 int i_size_entry = strlen( psz_name ) +
454 strlen( p_dir_content->d_name ) + 2;
455 char *psz_uri = (char *)malloc( sizeof(char) * i_size_entry );
457 sprintf( psz_uri, "%s/%s", psz_name, p_dir_content->d_name );
459 /* if it starts with '.' then forget it */
460 if( p_dir_content->d_name[0] != '.' )
462 #if defined( S_ISDIR )
463 struct stat stat_data;
465 if( !stat( psz_uri, &stat_data )
466 && S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
467 #elif defined( DT_DIR )
468 if( ( p_dir_content->d_type & DT_DIR ) && i_mode != MODE_COLLAPSE )
473 #if defined( S_ISLNK )
475 * FIXME: there is a ToCToU race condition here; but it is rather tricky
476 * impossible to fix while keeping some kind of portable code, and maybe even
477 * in a non-portable way.
479 if( lstat( psz_uri, &stat_data )
480 || S_ISLNK(stat_data.st_mode) )
482 msg_Dbg( p_playlist, "Skipping directory symlink %s",
488 if( i_mode == MODE_NONE )
490 msg_Dbg( p_playlist, "Skipping subdirectory %s", psz_uri );
494 else if( i_mode == MODE_EXPAND )
496 char *psz_newname, *psz_tmp;
497 msg_Dbg(p_playlist, "Reading subdirectory %s", psz_uri );
499 psz_tmp = FromLocale( p_dir_content->d_name );
500 psz_newname = vlc_fix_readdir_charset(
501 p_playlist, psz_tmp );
502 LocaleFree( psz_tmp );
504 p_node = playlist_NodeCreate( p_playlist,
505 p_parent->pp_parents[0]->i_view,
506 psz_newname, p_parent );
508 playlist_CopyParents( p_parent, p_node );
510 p_node->input.i_type = ITEM_TYPE_DIRECTORY;
512 if( ReadDir( p_playlist, psz_uri , MODE_EXPAND,
513 p_node ) != VLC_SUCCESS )
518 /* an strdup() just because of Mac OS X */
524 playlist_item_t *p_item;
525 char *psz_tmp1, *psz_tmp2, *psz_loc;
527 if( i_extensions > 0 )
529 char *psz_dot = strrchr( p_dir_content->d_name, '.' );
530 if( psz_dot++ && *psz_dot )
533 for( a = 0; a < i_extensions; a++ )
535 if( !strcmp( psz_dot, ppsz_extensions[a] ) )
538 if( a < i_extensions )
540 msg_Dbg( p_playlist, "Ignoring file %s", psz_uri );
547 psz_loc = FromLocale( psz_uri );
548 psz_tmp1 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
550 LocaleFree( psz_loc );
552 psz_loc = FromLocale( p_dir_content->d_name );
553 psz_tmp2 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
555 LocaleFree( psz_loc );
557 p_item = playlist_ItemNewWithType( VLC_OBJECT(p_playlist),
558 psz_tmp1, psz_tmp2, ITEM_TYPE_VFILE );
559 playlist_NodeAddItem( p_playlist,p_item,
560 p_parent->pp_parents[0]->i_view,
562 PLAYLIST_APPEND | PLAYLIST_PREPARSE,
565 playlist_CopyParents( p_parent, p_item );
571 for( i = 0; i < i_extensions; i++ )
573 if( ppsz_extensions[i] )
574 free( ppsz_extensions[i] );
576 if( ppsz_extensions ) free( ppsz_extensions );
577 if( psz_ignore ) free( psz_ignore );
579 for( i = 0; i < i_dir_content; i++ )
580 if( pp_dir_content[i] ) free( pp_dir_content[i] );
581 if( pp_dir_content ) free( pp_dir_content );