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
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_("Ignore files with these extensions")
81 #define IGNORE_LONGTEXT N_( \
82 "Specify a comma seperated list of file extensions. " \
83 "Files with these extensions will not be added to playlist when opening a directory. " \
84 "This is useful if you add directories that contain mp3 albums for instance." )
87 set_category( CAT_INPUT );
88 set_shortname( _("Directory" ) );
89 set_subcategory( SUBCAT_INPUT_ACCESS );
90 set_description( _("Standard filesystem directory input") );
91 set_capability( "access2", 55 );
92 add_shortcut( "directory" );
93 add_shortcut( "dir" );
94 add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
95 RECURSIVE_LONGTEXT, VLC_FALSE );
96 change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
97 add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
98 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;
137 char *psz_path = ToLocale( p_access->psz_path );
139 if( ( stat( psz_path, &stat_info ) == -1 ) ||
140 !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") )
160 LocaleFree( psz_path );
164 LocaleFree( psz_path );
165 p_access->pf_read = Read;
166 p_access->pf_block = NULL;
167 p_access->pf_seek = NULL;
168 p_access->pf_control= Control;
171 p_access->psz_demux = strdup( "directory" );
176 /*****************************************************************************
177 * Close: close the target
178 *****************************************************************************/
179 static void Close( vlc_object_t * p_this )
183 /*****************************************************************************
184 * ReadNull: read the directory
185 *****************************************************************************/
186 static int ReadNull( access_t *p_access, uint8_t *p_buffer, int i_len)
188 /* Return fake data */
189 memset( p_buffer, 0, i_len );
193 /*****************************************************************************
194 * Read: read the directory
195 *****************************************************************************/
196 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len)
198 char *psz_name = NULL;
202 playlist_item_t *p_item;
203 vlc_bool_t b_play = VLC_FALSE;
205 playlist_t *p_playlist =
206 (playlist_t *) vlc_object_find( p_access,
207 VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
211 msg_Err( p_access, "can't find playlist" );
218 psz_name = ToLocale( p_access->psz_path );
219 ptr = strdup( psz_name );
220 LocaleFree( psz_name );
226 /* Remove the ending '/' char */
227 ptr += strlen( ptr );
228 if( ( ptr > psz_name ) )
239 /* Initialize structure */
240 psz = var_CreateGetString( p_access, "recursive" );
241 if( *psz == '\0' || !strncmp( psz, "none" , 4 ) )
245 else if( !strncmp( psz, "collapse", 8 ) )
247 i_mode = MODE_COLLAPSE;
251 i_mode = MODE_EXPAND;
255 /* Make sure we are deleted when we are done */
256 /* The playlist position we will use for the add */
257 i_pos = p_playlist->i_index + 1;
259 msg_Dbg( p_access, "opening directory `%s'", p_access->psz_path );
261 if( &p_playlist->status.p_item->input ==
262 ((input_thread_t *)p_access->p_parent)->input.p_item )
264 p_item = p_playlist->status.p_item;
266 msg_Dbg( p_access, "starting directory playback");
270 input_item_t *p_current = ( (input_thread_t*)p_access->p_parent)->
272 p_item = playlist_LockItemGetByInput( p_playlist, p_current );
273 msg_Dbg( p_access, "not starting directory playback");
276 msg_Dbg( p_playlist, "unable to find item in playlist");
282 p_item->input.i_type = ITEM_TYPE_DIRECTORY;
283 if( ReadDir( p_playlist, psz_name , i_mode, &i_pos,
284 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 )
372 /*****************************************************************************
374 *****************************************************************************/
375 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
377 return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
380 static int Filter( const struct dirent *foo )
384 /*****************************************************************************
385 * ReadDir: read a directory and add its content to the list
386 *****************************************************************************/
387 static int ReadDir( playlist_t *p_playlist,
388 char *psz_name, int i_mode, int *pi_position,
389 playlist_item_t *p_parent )
391 struct dirent **pp_dir_content;
392 int i_dir_content, i;
393 playlist_item_t *p_node;
395 /* Build array with ignores */
396 char **ppsz_extensions = 0;
397 int i_extensions = 0;
398 char *psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
399 if( psz_ignore && *psz_ignore )
401 char *psz_parser = psz_ignore;
404 for( a = 0; psz_parser[a] != '\0'; a++ )
406 if( psz_parser[a] == ',' ) i_extensions++;
409 ppsz_extensions = (char **)malloc( sizeof( char * ) * i_extensions );
411 for( a = 0; a < i_extensions; a++ )
416 while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
417 for( b = 0; psz_parser[b] != '\0'; b++ )
419 if( psz_parser[b] == ',' ) break;
421 tmp = malloc( b + 1 );
422 strncpy( tmp, psz_parser, b );
424 ppsz_extensions[a] = tmp;
429 /* Change the item to a node */
430 if( p_parent->i_children == -1 )
432 playlist_LockItemToNode( p_playlist,p_parent );
435 /* get the first directory entry */
436 i_dir_content = scandir( psz_name, &pp_dir_content, Filter, alphasort );
437 if( i_dir_content == -1 )
439 msg_Warn( p_playlist, "Failed to read directory" );
442 else if( i_dir_content <= 0 )
444 /* directory is empty */
448 /* While we still have entries in the directory */
449 for( i = 0; i < i_dir_content; i++ )
451 struct dirent *p_dir_content = pp_dir_content[i];
452 int i_size_entry = strlen( psz_name ) +
453 strlen( p_dir_content->d_name ) + 2;
454 char *psz_uri = (char *)malloc( sizeof(char) * i_size_entry );
456 sprintf( psz_uri, "%s/%s", psz_name, p_dir_content->d_name );
458 /* if it starts with '.' then forget it */
459 if( p_dir_content->d_name[0] != '.' )
461 #if defined( S_ISDIR )
462 struct stat stat_data;
464 if( !stat( psz_uri, &stat_data )
465 && S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
466 #elif defined( DT_DIR )
467 if( ( p_dir_content->d_type & DT_DIR ) && i_mode != MODE_COLLAPSE )
472 if( i_mode == MODE_NONE )
474 msg_Dbg( p_playlist, "Skipping subdirectory %s", psz_uri );
478 else if( i_mode == MODE_EXPAND )
480 char *psz_newname, *psz_tmp;
481 msg_Dbg(p_playlist, "Reading subdirectory %s", psz_uri );
483 psz_tmp = FromLocale( p_dir_content->d_name );
484 psz_newname = vlc_fix_readdir_charset(
485 p_playlist, psz_tmp );
486 LocaleFree( psz_tmp );
488 p_node = playlist_NodeCreate( p_playlist,
489 p_parent->pp_parents[0]->i_view,
490 psz_newname, p_parent );
492 playlist_CopyParents( p_parent, p_node );
494 p_node->input.i_type = ITEM_TYPE_DIRECTORY;
496 if( ReadDir( p_playlist, psz_uri , MODE_EXPAND,
497 pi_position, p_node ) != VLC_SUCCESS )
502 /* an strdup() just because of Mac OS X */
508 playlist_item_t *p_item;
509 char *psz_tmp1, *psz_tmp2, *psz_loc;
511 if( i_extensions > 0 )
513 char *psz_dot = strrchr( p_dir_content->d_name, '.' );
514 if( psz_dot++ && *psz_dot )
517 for( a = 0; a < i_extensions; a++ )
519 if( !strcmp( psz_dot, ppsz_extensions[a] ) )
522 if( a < i_extensions )
524 msg_Dbg( p_playlist, "Ignoring file %s", psz_uri );
531 psz_loc = FromLocale( psz_uri );
532 psz_tmp1 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
534 LocaleFree( psz_loc );
536 psz_loc = FromLocale( p_dir_content->d_name );
537 psz_tmp2 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
539 LocaleFree( psz_loc );
541 p_item = playlist_ItemNewWithType( VLC_OBJECT(p_playlist),
542 psz_tmp1, psz_tmp2, ITEM_TYPE_VFILE );
543 playlist_NodeAddItem( p_playlist,p_item,
544 p_parent->pp_parents[0]->i_view,
546 PLAYLIST_APPEND, PLAYLIST_END );
548 playlist_CopyParents( p_parent, p_item );
554 for( i = 0; i < i_extensions; i++ )
556 if( ppsz_extensions[i] )
557 free( ppsz_extensions[i] );
559 if( ppsz_extensions ) free( ppsz_extensions );
560 if( psz_ignore ) free( psz_ignore );
562 free( pp_dir_content );