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., 59 Temple Place - Suite 330, Boston, MA 02111, 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
59 /*****************************************************************************
61 *****************************************************************************/
62 static int Open ( vlc_object_t * );
63 static void Close( vlc_object_t * );
65 static int DemuxOpen ( vlc_object_t * );
67 #define RECURSIVE_TEXT N_("Subdirectory behavior")
68 #define RECURSIVE_LONGTEXT N_( \
69 "Select whether subdirectories must be expanded.\n" \
70 "none: subdirectories do not appear in the playlist.\n" \
71 "collapse: subdirectories appear but are expanded on first play.\n" \
72 "expand: all subdirectories are expanded.\n" )
74 static char *psz_recursive_list[] = { "none", "collapse", "expand" };
75 static char *psz_recursive_list_text[] = { N_("none"), N_("collapse"),
78 #define IGNORE_TEXT N_("Ignore files with these extensions")
79 #define IGNORE_LONGTEXT N_( \
80 "Specify a comma seperated list of file extensions. " \
81 "Files with these extensions will not be added to playlist when opening a directory. " \
82 "This is useful if you add directories that contain mp3 albums for instance." )
85 set_category( CAT_INPUT );
86 set_shortname( _("Directory" ) );
87 set_subcategory( SUBCAT_INPUT_ACCESS );
88 set_description( _("Standard filesystem directory input") );
89 set_capability( "access2", 55 );
90 add_shortcut( "directory" );
91 add_shortcut( "dir" );
92 add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
93 RECURSIVE_LONGTEXT, VLC_FALSE );
94 change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
96 add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
97 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, VLC_FALSE );
99 set_callbacks( Open, Close );
102 set_description( "Directory EOF");
103 set_capability( "demux2", 0 );
104 add_shortcut( "directory" );
105 set_callbacks( DemuxOpen, NULL );
109 /*****************************************************************************
110 * Local prototypes, constants, structures
111 *****************************************************************************/
113 #define MODE_EXPAND 0
114 #define MODE_COLLAPSE 1
117 static int Read( access_t *, uint8_t *, int );
118 static int ReadNull( access_t *, uint8_t *, int );
119 static int Control( access_t *, int, va_list );
121 static int Demux( demux_t *p_demux );
122 static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
125 static int ReadDir( playlist_t *, char *psz_name, int i_mode, int *pi_pos,
128 /*****************************************************************************
129 * Open: open the directory
130 *****************************************************************************/
131 static int Open( vlc_object_t *p_this )
133 access_t *p_access = (access_t*)p_this;
135 #ifdef HAVE_SYS_STAT_H
136 struct stat stat_info;
138 if( ( stat( p_access->psz_path, &stat_info ) == -1 ) ||
139 !S_ISDIR( stat_info.st_mode ) )
145 wchar_t psz_path[MAX_PATH];
146 mbstowcs( psz_path, p_access->psz_path, MAX_PATH );
147 psz_path[MAX_PATH-1] = 0;
149 char *psz_path = p_access->psz_path;
150 # endif /* UNICODE */
152 i_ret = GetFileAttributes( psz_path );
153 if( i_ret == -1 || !(i_ret & FILE_ATTRIBUTE_DIRECTORY) )
156 if( strcmp( p_access->psz_access, "dir") &&
157 strcmp( p_access->psz_access, "directory") )
163 p_access->pf_read = Read;
164 p_access->pf_block = NULL;
165 p_access->pf_seek = NULL;
166 p_access->pf_control= Control;
169 p_access->psz_demux = strdup( "directory" );
174 /*****************************************************************************
175 * Close: close the target
176 *****************************************************************************/
177 static void Close( vlc_object_t * p_this )
181 /*****************************************************************************
182 * ReadNull: read the directory
183 *****************************************************************************/
184 static int ReadNull( access_t *p_access, uint8_t *p_buffer, int i_len)
186 /* Return fake data */
187 memset( p_buffer, 0, i_len );
191 /*****************************************************************************
192 * Read: read the directory
193 *****************************************************************************/
194 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len)
196 char *psz_name = NULL;
200 playlist_item_t *p_item;
201 vlc_bool_t b_play = VLC_FALSE;
203 playlist_t *p_playlist =
204 (playlist_t *) vlc_object_find( p_access,
205 VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
209 msg_Err( p_access, "can't find playlist" );
213 /* Remove the ending '/' char */
214 psz_name = strdup( p_access->psz_path );
215 if( psz_name == NULL )
218 if( (psz_name[strlen(psz_name)-1] == '/') ||
219 (psz_name[strlen(psz_name)-1] == '\\') )
221 psz_name[strlen(psz_name)-1] = '\0';
224 /* Initialize structure */
225 psz = var_CreateGetString( p_access, "recursive" );
226 if( *psz == '\0' || !strncmp( psz, "none" , 4 ) )
230 else if( !strncmp( psz, "collapse", 8 ) )
232 i_mode = MODE_COLLAPSE;
236 i_mode = MODE_EXPAND;
240 /* Make sure we are deleted when we are done */
241 /* The playlist position we will use for the add */
242 i_pos = p_playlist->i_index + 1;
244 msg_Dbg( p_access, "opening directory `%s'", psz_name );
246 if( &p_playlist->status.p_item->input ==
247 ((input_thread_t *)p_access->p_parent)->input.p_item )
249 p_item = p_playlist->status.p_item;
251 msg_Dbg( p_access, "starting directory playback");
255 input_item_t *p_current = ( (input_thread_t*)p_access->p_parent)->
257 p_item = playlist_LockItemGetByInput( p_playlist, p_current );
258 msg_Dbg( p_access, "not starting directory playback");
261 msg_Dbg( p_playlist, "unable to find item in playlist");
267 p_item->input.i_type = ITEM_TYPE_DIRECTORY;
268 if( ReadDir( p_playlist, psz_name , i_mode, &i_pos,
269 p_item ) != VLC_SUCCESS )
274 /* Begin to read the directory */
277 playlist_Control( p_playlist, PLAYLIST_VIEWPLAY,
278 p_playlist->status.i_view,
279 p_playlist->status.p_item, NULL );
281 if( psz_name ) free( psz_name );
282 vlc_object_release( p_playlist );
284 /* Return fake data forever */
285 p_access->pf_read = ReadNull;
286 return ReadNull( p_access, p_buffer, i_len );
289 /*****************************************************************************
291 *****************************************************************************/
292 static int Control( access_t *p_access, int i_query, va_list args )
301 case ACCESS_CAN_SEEK:
302 case ACCESS_CAN_FASTSEEK:
303 case ACCESS_CAN_PAUSE:
304 case ACCESS_CAN_CONTROL_PACE:
305 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
306 *pb_bool = VLC_FALSE; /* FIXME */
311 pi_int = (int*)va_arg( args, int * );
315 case ACCESS_GET_PTS_DELAY:
316 pi_64 = (int64_t*)va_arg( args, int64_t * );
317 *pi_64 = DEFAULT_PTS_DELAY * 1000;
321 case ACCESS_SET_PAUSE_STATE:
322 case ACCESS_GET_TITLE_INFO:
323 case ACCESS_SET_TITLE:
324 case ACCESS_SET_SEEKPOINT:
325 case ACCESS_SET_PRIVATE_ID_STATE:
329 msg_Warn( p_access, "unimplemented query in control" );
335 /*****************************************************************************
337 *****************************************************************************/
338 static int DemuxOpen ( vlc_object_t *p_this )
340 demux_t *p_demux = (demux_t*)p_this;
342 if( strcmp( p_demux->psz_demux, "directory" ) )
345 p_demux->pf_demux = Demux;
346 p_demux->pf_control = DemuxControl;
350 /*****************************************************************************
352 *****************************************************************************/
353 static int Demux( demux_t *p_demux )
357 /*****************************************************************************
359 *****************************************************************************/
360 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
362 return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
365 #if defined(SYS_BEOS) || defined(WIN32) || defined(SYS_SOLARIS)
366 /* BeOS doesn't have scandir/alphasort/versionsort */
367 static int alphasort( const struct dirent **a, const struct dirent **b )
369 return strcoll( (*a)->d_name, (*b)->d_name );
372 static int scandir( const char *name, struct dirent ***namelist,
373 int (*filter) ( const struct dirent * ),
374 int (*compar) ( const struct dirent **,
375 const struct dirent ** ) )
378 struct dirent * p_content;
379 struct dirent ** pp_list;
382 if( !namelist || !( p_dir = opendir( name ) ) ) return -1;
386 while( ( p_content = readdir( p_dir ) ) )
388 if( filter && !filter( p_content ) )
392 pp_list = realloc( pp_list, ( ret + 1 ) * sizeof( struct dirent * ) );
393 size = sizeof( struct dirent ) + strlen( p_content->d_name ) + 1;
394 pp_list[ret] = malloc( size );
395 memcpy( pp_list[ret], p_content, size );
403 qsort( pp_list, ret, sizeof( struct dirent * ),
404 (int (*)(const void *, const void *)) compar );
412 static int Filter( const struct dirent *foo )
416 /*****************************************************************************
417 * ReadDir: read a directory and add its content to the list
418 *****************************************************************************/
419 static int ReadDir( playlist_t *p_playlist,
420 char *psz_name , int i_mode, int *pi_position,
421 playlist_item_t *p_parent )
423 struct dirent **pp_dir_content;
424 int i_dir_content, i;
425 playlist_item_t *p_node;
427 /* Build array with ignores */
429 char **ppsz_extensions = 0;
430 int i_extensions = 0;
431 char *psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
432 if( psz_ignore && *psz_ignore )
435 char *psz_parser = psz_backup = strdup( psz_ignore );
438 while( strsep( &psz_parser, "," ) ) i_extensions++;
441 ppsz_extensions = (char **)malloc( sizeof( char * ) * i_extensions );
443 psz_parser = psz_ignore;
444 while( a < i_extensions &&
445 ( ppsz_extensions[a++] = strsep( &psz_parser, "," ) ) );
447 #endif /* HAVE_STRSEP */
449 /* Change the item to a node */
450 if( p_parent->i_children == -1 )
452 playlist_LockItemToNode( p_playlist,p_parent );
455 /* get the first directory entry */
456 i_dir_content = scandir( psz_name, &pp_dir_content, Filter, alphasort );
457 if( i_dir_content == -1 )
459 msg_Warn( p_playlist, "Failed to read directory" );
462 else if( i_dir_content <= 0 )
464 /* directory is empty */
468 /* While we still have entries in the directory */
469 for( i = 0; i < i_dir_content; i++ )
471 struct dirent *p_dir_content = pp_dir_content[i];
472 int i_size_entry = strlen( psz_name ) +
473 strlen( p_dir_content->d_name ) + 2;
474 char *psz_uri = (char *)malloc( sizeof(char) * i_size_entry );
476 sprintf( psz_uri, "%s/%s", psz_name, p_dir_content->d_name );
478 /* if it starts with '.' then forget it */
479 if( p_dir_content->d_name[0] != '.' )
481 #if defined( S_ISDIR )
482 struct stat stat_data;
483 stat( psz_uri, &stat_data );
484 if( S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
485 #elif defined( DT_DIR )
486 if( ( p_dir_content->d_type & DT_DIR ) && i_mode != MODE_COLLAPSE )
491 if( i_mode == MODE_NONE )
493 msg_Dbg( p_playlist, "Skipping subdirectory %s", psz_uri );
497 else if( i_mode == MODE_EXPAND )
500 msg_Dbg(p_playlist, "Reading subdirectory %s", psz_uri );
502 if( !strncmp( psz_uri, psz_name, strlen( psz_name ) ) )
504 char *psz_subdir = psz_uri;
505 /* Skip the parent path + the separator */
506 psz_subdir += strlen( psz_name ) + 1;
507 psz_newname = strdup( psz_subdir );
511 psz_newname = strdup( psz_uri );
513 p_node = playlist_NodeCreate( p_playlist,
514 p_parent->pp_parents[0]->i_view,
515 psz_newname, p_parent );
517 playlist_CopyParents( p_parent, p_node );
519 p_node->input.i_type = ITEM_TYPE_DIRECTORY;
521 if( ReadDir( p_playlist, psz_uri , MODE_EXPAND,
522 pi_position, p_node ) != VLC_SUCCESS )
532 playlist_item_t *p_item;
535 if( i_extensions > 0 )
537 char *psz_dot = strrchr( p_dir_content->d_name, '.' );
538 if( psz_dot++ && *psz_dot )
541 for( a = 0; a < i_extensions; a++ )
543 if( !strcmp( psz_dot, ppsz_extensions[a] ) )
546 if( a < i_extensions )
548 msg_Dbg( p_playlist, "Ignoring file %s", psz_uri );
554 #endif /* HAVE_STRSEP */
556 p_item = playlist_ItemNewWithType( VLC_OBJECT(p_playlist),
557 psz_uri, p_dir_content->d_name, ITEM_TYPE_VFILE );
558 playlist_NodeAddItem( p_playlist,p_item,
559 p_parent->pp_parents[0]->i_view,
561 PLAYLIST_APPEND, PLAYLIST_END );
563 playlist_CopyParents( p_parent, p_item );
570 if( ppsz_extensions ) free( ppsz_extensions );
571 if( psz_ignore ) free( psz_ignore );
572 #endif /* HAVE_STRSEP */
574 free( pp_dir_content );