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 char *psz_recursive_list[] = { "none", "collapse", "expand" };
78 static 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 #ifdef HAVE_SYS_STAT_H
138 struct stat stat_info;
139 char *psz_path = ToLocale( p_access->psz_path );
141 if( ( stat( psz_path, &stat_info ) == -1 ) ||
142 !S_ISDIR( stat_info.st_mode ) )
147 wchar_t psz_path[MAX_PATH];
148 mbstowcs( psz_path, p_access->psz_path, MAX_PATH );
149 psz_path[MAX_PATH-1] = 0;
151 char *psz_path = p_access->psz_path;
152 # endif /* UNICODE */
154 i_ret = GetFileAttributes( psz_path );
155 if( i_ret == -1 || !(i_ret & FILE_ATTRIBUTE_DIRECTORY) )
158 if( strcmp( p_access->psz_access, "dir") &&
159 strcmp( p_access->psz_access, "directory") )
162 LocaleFree( psz_path );
166 LocaleFree( psz_path );
167 p_access->pf_read = Read;
168 p_access->pf_block = NULL;
169 p_access->pf_seek = NULL;
170 p_access->pf_control= Control;
173 p_access->psz_demux = strdup( "directory" );
178 /*****************************************************************************
179 * Close: close the target
180 *****************************************************************************/
181 static void Close( vlc_object_t * p_this )
185 /*****************************************************************************
186 * ReadNull: read the directory
187 *****************************************************************************/
188 static int ReadNull( access_t *p_access, uint8_t *p_buffer, int i_len)
190 /* Return fake data */
191 memset( p_buffer, 0, i_len );
195 /*****************************************************************************
196 * Read: read the directory
197 *****************************************************************************/
198 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len)
200 char *psz_name = NULL;
203 int i_mode, i_activity;
205 playlist_item_t *p_item, *p_root_category;
206 playlist_t *p_playlist = pl_Yield( p_access );
208 psz_name = ToLocale( p_access->psz_path );
209 ptr = strdup( psz_name );
210 LocaleFree( psz_name );
216 /* Remove the ending '/' char */
217 ptr += strlen( ptr );
218 if( ( ptr > psz_name ) )
229 psz = var_CreateGetString( p_access, "recursive" );
230 if( *psz == '\0' || !strncmp( psz, "none" , 4 ) )
232 else if( !strncmp( psz, "collapse", 8 ) )
233 i_mode = MODE_COLLAPSE;
235 i_mode = MODE_EXPAND;
238 msg_Dbg( p_access, "opening directory `%s'", p_access->psz_path );
240 if( p_playlist->status.p_item && p_playlist->status.p_item->p_input ==
241 ((input_thread_t *)p_access->p_parent)->input.p_item )
242 p_item = p_playlist->status.p_item;
245 input_item_t *p_current = ( (input_thread_t*)p_access->p_parent)->
247 p_item = playlist_LockItemGetByInput( p_playlist, p_current );
250 msg_Dbg( p_playlist, "unable to find item in playlist");
254 p_item->p_input->i_type = ITEM_TYPE_DIRECTORY;
256 p_root_category = playlist_LockItemToNode( p_playlist, p_item );
258 i_activity = var_GetInteger( p_playlist, "activity" );
259 var_SetInteger( p_playlist, "activity", i_activity +
260 DIRECTORY_ACTIVITY );
262 ReadDir( p_playlist, psz_name , i_mode, p_item, p_root_category );
264 i_activity = var_GetInteger( p_playlist, "activity" );
265 var_SetInteger( p_playlist, "activity", i_activity -
266 DIRECTORY_ACTIVITY );
268 if( psz_name ) free( psz_name );
269 vlc_object_release( p_playlist );
271 /* Return fake data forever */
272 p_access->pf_read = ReadNull;
273 return ReadNull( p_access, p_buffer, i_len );
276 /*****************************************************************************
278 *****************************************************************************/
279 static int Control( access_t *p_access, int i_query, va_list args )
288 case ACCESS_CAN_SEEK:
289 case ACCESS_CAN_FASTSEEK:
290 case ACCESS_CAN_PAUSE:
291 case ACCESS_CAN_CONTROL_PACE:
292 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
293 *pb_bool = VLC_FALSE; /* FIXME */
298 pi_int = (int*)va_arg( args, int * );
302 case ACCESS_GET_PTS_DELAY:
303 pi_64 = (int64_t*)va_arg( args, int64_t * );
304 *pi_64 = DEFAULT_PTS_DELAY * 1000;
308 case ACCESS_SET_PAUSE_STATE:
309 case ACCESS_GET_TITLE_INFO:
310 case ACCESS_SET_TITLE:
311 case ACCESS_SET_SEEKPOINT:
312 case ACCESS_SET_PRIVATE_ID_STATE:
316 msg_Warn( p_access, "unimplemented query in control" );
322 /*****************************************************************************
324 *****************************************************************************/
325 static int DemuxOpen ( vlc_object_t *p_this )
327 demux_t *p_demux = (demux_t*)p_this;
329 if( strcmp( p_demux->psz_demux, "directory" ) )
332 p_demux->pf_demux = Demux;
333 p_demux->pf_control = DemuxControl;
337 /*****************************************************************************
339 *****************************************************************************/
340 static int Demux( demux_t *p_demux )
345 /*****************************************************************************
347 *****************************************************************************/
348 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
350 return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
353 static int Filter( const struct dirent *foo )
358 /*****************************************************************************
359 * ReadDir: read a directory and add its content to the list
360 *****************************************************************************/
361 static int ReadDir( playlist_t *p_playlist, const char *psz_name,
362 int i_mode, playlist_item_t *p_parent,
363 playlist_item_t *p_parent_category )
365 struct dirent **pp_dir_content = 0;
366 int i_dir_content, i, i_return = VLC_SUCCESS;
367 playlist_item_t *p_node;
369 char **ppsz_extensions = 0;
370 int i_extensions = 0;
373 /* Get the first directory entry */
374 i_dir_content = scandir( psz_name, &pp_dir_content, Filter, alphasort );
375 if( i_dir_content == -1 )
377 msg_Warn( p_playlist, "failed to read directory" );
380 else if( i_dir_content <= 0 )
382 /* directory is empty */
383 if( pp_dir_content ) free( pp_dir_content );
387 /* Build array with ignores */
388 psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
389 if( psz_ignore && *psz_ignore )
391 char *psz_parser = psz_ignore;
394 for( a = 0; psz_parser[a] != '\0'; a++ )
396 if( psz_parser[a] == ',' ) i_extensions++;
399 ppsz_extensions = (char **)malloc( sizeof( char * ) * i_extensions );
401 for( a = 0; a < i_extensions; a++ )
405 while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
406 ptr = strchr( psz_parser, ',');
407 tmp = ( ptr == NULL )
408 ? strdup( psz_parser )
409 : strndup( psz_parser, ptr - psz_parser );
411 ppsz_extensions[a] = tmp;
412 psz_parser = ptr + 1;
416 /* While we still have entries in the directory */
417 for( i = 0; i < i_dir_content; i++ )
419 struct dirent *p_dir_content = pp_dir_content[i];
420 int i_size_entry = strlen( psz_name ) +
421 strlen( p_dir_content->d_name ) + 2;
422 char *psz_uri = (char *)malloc( sizeof(char) * i_size_entry );
424 sprintf( psz_uri, "%s/%s", psz_name, p_dir_content->d_name );
426 /* if it starts with '.' then forget it */
427 if( p_dir_content->d_name[0] != '.' )
429 #if defined( S_ISDIR )
430 struct stat stat_data;
432 if( !stat( psz_uri, &stat_data )
433 && S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
434 #elif defined( DT_DIR )
435 if( ( p_dir_content->d_type & DT_DIR ) && i_mode != MODE_COLLAPSE )
440 #if defined( S_ISLNK )
442 * FIXME: there is a ToCToU race condition here; but it is rather tricky
443 * impossible to fix while keeping some kind of portable code, and maybe even
444 * in a non-portable way.
446 if( lstat( psz_uri, &stat_data )
447 || S_ISLNK(stat_data.st_mode) )
449 msg_Dbg( p_playlist, "skipping directory symlink %s",
455 if( i_mode == MODE_NONE )
457 msg_Dbg( p_playlist, "skipping subdirectory %s", psz_uri );
461 else if( i_mode == MODE_EXPAND )
463 char *psz_newname, *psz_tmp;
464 msg_Dbg(p_playlist, "reading subdirectory %s", psz_uri );
466 psz_tmp = FromLocale( p_dir_content->d_name );
467 psz_newname = vlc_fix_readdir_charset(
468 p_playlist, psz_tmp );
469 LocaleFree( psz_tmp );
471 if( p_parent_category )
473 p_node = playlist_NodeCreate( p_playlist, psz_newname,
478 p_node = playlist_NodeCreate( p_playlist, psz_newname,
482 /* an strdup() just because of Mac OS X */
485 /* If we had the parent in category, the it is now node.
486 * Else, we still don't have */
487 if( ReadDir( p_playlist, psz_uri , MODE_EXPAND,
488 p_node, p_parent_category ? p_node : NULL )
491 i_return = VLC_EGENERIC;
498 input_item_t *p_input;
499 char *psz_tmp1, *psz_tmp2, *psz_loc;
501 if( i_extensions > 0 )
503 char *psz_dot = strrchr( p_dir_content->d_name, '.' );
504 if( psz_dot++ && *psz_dot )
507 for( a = 0; a < i_extensions; a++ )
509 if( !strcmp( psz_dot, ppsz_extensions[a] ) )
512 if( a < i_extensions )
514 msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
521 psz_loc = FromLocale( psz_uri );
522 psz_tmp1 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
524 LocaleFree( psz_loc );
526 psz_loc = FromLocale( p_dir_content->d_name );
527 psz_tmp2 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
529 LocaleFree( psz_loc );
531 p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist),
532 psz_tmp1, psz_tmp2, 0, NULL,
533 -1, ITEM_TYPE_VFILE );
535 playlist_AddWhereverNeeded( p_playlist, p_input, p_parent,
536 p_parent_category, VLC_FALSE,
537 PLAYLIST_APPEND|PLAYLIST_PREPARSE);
543 for( i = 0; i < i_extensions; i++ )
544 if( ppsz_extensions[i] ) free( ppsz_extensions[i] );
545 if( ppsz_extensions ) free( ppsz_extensions );
547 if( psz_ignore ) free( psz_ignore );
549 for( i = 0; i < i_dir_content; i++ )
550 if( pp_dir_content[i] ) free( pp_dir_content[i] );
551 if( pp_dir_content ) free( pp_dir_content );