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 );
98 add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
99 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 *, char *psz_name, int i_mode, int *pi_pos,
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;
204 playlist_item_t *p_item;
205 vlc_bool_t b_play = VLC_FALSE;
207 playlist_t *p_playlist =
208 (playlist_t *) vlc_object_find( p_access,
209 VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
213 msg_Err( p_access, "can't find playlist" );
220 psz_name = ToLocale( p_access->psz_path );
221 ptr = strdup( psz_name );
222 LocaleFree( psz_name );
228 /* Remove the ending '/' char */
229 ptr += strlen( ptr );
230 if( ( ptr > psz_name ) )
241 /* Initialize structure */
242 psz = var_CreateGetString( p_access, "recursive" );
243 if( *psz == '\0' || !strncmp( psz, "none" , 4 ) )
247 else if( !strncmp( psz, "collapse", 8 ) )
249 i_mode = MODE_COLLAPSE;
253 i_mode = MODE_EXPAND;
257 /* Make sure we are deleted when we are done */
258 /* The playlist position we will use for the add */
259 i_pos = p_playlist->i_index + 1;
261 msg_Dbg( p_access, "opening directory `%s'", p_access->psz_path );
263 if( &p_playlist->status.p_item->input ==
264 ((input_thread_t *)p_access->p_parent)->input.p_item )
266 p_item = p_playlist->status.p_item;
268 msg_Dbg( p_access, "starting directory playback");
272 input_item_t *p_current = ( (input_thread_t*)p_access->p_parent)->
274 p_item = playlist_LockItemGetByInput( p_playlist, p_current );
275 msg_Dbg( p_access, "not starting directory playback");
278 msg_Dbg( p_playlist, "unable to find item in playlist");
284 p_item->input.i_type = ITEM_TYPE_DIRECTORY;
285 if( ReadDir( p_playlist, psz_name , i_mode, &i_pos,
286 p_item ) != VLC_SUCCESS )
291 /* Begin to read the directory */
294 playlist_Control( p_playlist, PLAYLIST_VIEWPLAY,
295 p_playlist->status.i_view,
296 p_playlist->status.p_item, NULL );
298 if( psz_name ) free( psz_name );
299 vlc_object_release( p_playlist );
301 /* Return fake data forever */
302 p_access->pf_read = ReadNull;
303 return ReadNull( p_access, p_buffer, i_len );
306 /*****************************************************************************
308 *****************************************************************************/
309 static int Control( access_t *p_access, int i_query, va_list args )
318 case ACCESS_CAN_SEEK:
319 case ACCESS_CAN_FASTSEEK:
320 case ACCESS_CAN_PAUSE:
321 case ACCESS_CAN_CONTROL_PACE:
322 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
323 *pb_bool = VLC_FALSE; /* FIXME */
328 pi_int = (int*)va_arg( args, int * );
332 case ACCESS_GET_PTS_DELAY:
333 pi_64 = (int64_t*)va_arg( args, int64_t * );
334 *pi_64 = DEFAULT_PTS_DELAY * 1000;
338 case ACCESS_SET_PAUSE_STATE:
339 case ACCESS_GET_TITLE_INFO:
340 case ACCESS_SET_TITLE:
341 case ACCESS_SET_SEEKPOINT:
342 case ACCESS_SET_PRIVATE_ID_STATE:
346 msg_Warn( p_access, "unimplemented query in control" );
352 /*****************************************************************************
354 *****************************************************************************/
355 static int DemuxOpen ( vlc_object_t *p_this )
357 demux_t *p_demux = (demux_t*)p_this;
359 if( strcmp( p_demux->psz_demux, "directory" ) )
362 p_demux->pf_demux = Demux;
363 p_demux->pf_control = DemuxControl;
367 /*****************************************************************************
369 *****************************************************************************/
370 static int Demux( demux_t *p_demux )
374 /*****************************************************************************
376 *****************************************************************************/
377 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
379 return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
382 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,
390 char *psz_name, int i_mode, int *pi_position,
391 playlist_item_t *p_parent )
393 struct dirent **pp_dir_content;
394 int i_dir_content, i;
395 playlist_item_t *p_node;
397 /* Build array with ignores */
398 char **ppsz_extensions = 0;
399 int i_extensions = 0;
400 char *psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
401 if( psz_ignore && *psz_ignore )
403 char *psz_parser = psz_ignore;
406 for( a = 0; psz_parser[a] != '\0'; a++ )
408 if( psz_parser[a] == ',' ) i_extensions++;
411 ppsz_extensions = (char **)malloc( sizeof( char * ) * i_extensions );
413 for( a = 0; a < i_extensions; a++ )
418 while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
419 for( b = 0; psz_parser[b] != '\0'; b++ )
421 if( psz_parser[b] == ',' ) break;
423 tmp = malloc( b + 1 );
424 strncpy( tmp, psz_parser, b );
426 ppsz_extensions[a] = tmp;
431 /* Change the item to a node */
432 if( p_parent->i_children == -1 )
434 playlist_LockItemToNode( p_playlist,p_parent );
437 /* get the first directory entry */
438 i_dir_content = scandir( psz_name, &pp_dir_content, Filter, alphasort );
439 if( i_dir_content == -1 )
441 msg_Warn( p_playlist, "Failed to read directory" );
444 else if( i_dir_content <= 0 )
446 /* directory is empty */
450 /* While we still have entries in the directory */
451 for( i = 0; i < i_dir_content; i++ )
453 struct dirent *p_dir_content = pp_dir_content[i];
454 int i_size_entry = strlen( psz_name ) +
455 strlen( p_dir_content->d_name ) + 2;
456 char *psz_uri = (char *)malloc( sizeof(char) * i_size_entry );
458 sprintf( psz_uri, "%s/%s", psz_name, p_dir_content->d_name );
460 /* if it starts with '.' then forget it */
461 if( p_dir_content->d_name[0] != '.' )
463 #if defined( S_ISDIR )
464 struct stat stat_data;
466 if( !stat( psz_uri, &stat_data )
467 && S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
468 #elif defined( DT_DIR )
469 if( ( p_dir_content->d_type & DT_DIR ) && i_mode != MODE_COLLAPSE )
474 if( i_mode == MODE_NONE )
476 msg_Dbg( p_playlist, "Skipping subdirectory %s", psz_uri );
480 else if( i_mode == MODE_EXPAND )
482 char *psz_newname, *psz_tmp;
483 msg_Dbg(p_playlist, "Reading subdirectory %s", psz_uri );
485 psz_tmp = FromLocale( p_dir_content->d_name );
486 psz_newname = vlc_fix_readdir_charset(
487 p_playlist, psz_tmp );
488 LocaleFree( psz_tmp );
490 p_node = playlist_NodeCreate( p_playlist,
491 p_parent->pp_parents[0]->i_view,
492 psz_newname, p_parent );
494 playlist_CopyParents( p_parent, p_node );
496 p_node->input.i_type = ITEM_TYPE_DIRECTORY;
498 if( ReadDir( p_playlist, psz_uri , MODE_EXPAND,
499 pi_position, p_node ) != VLC_SUCCESS )
504 /* an strdup() just because of Mac OS X */
510 playlist_item_t *p_item;
511 char *psz_tmp1, *psz_tmp2, *psz_loc;
513 if( i_extensions > 0 )
515 char *psz_dot = strrchr( p_dir_content->d_name, '.' );
516 if( psz_dot++ && *psz_dot )
519 for( a = 0; a < i_extensions; a++ )
521 if( !strcmp( psz_dot, ppsz_extensions[a] ) )
524 if( a < i_extensions )
526 msg_Dbg( p_playlist, "Ignoring file %s", psz_uri );
533 psz_loc = FromLocale( psz_uri );
534 psz_tmp1 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
536 LocaleFree( psz_loc );
538 psz_loc = FromLocale( p_dir_content->d_name );
539 psz_tmp2 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
541 LocaleFree( psz_loc );
543 p_item = playlist_ItemNewWithType( VLC_OBJECT(p_playlist),
544 psz_tmp1, psz_tmp2, ITEM_TYPE_VFILE );
545 playlist_NodeAddItem( p_playlist,p_item,
546 p_parent->pp_parents[0]->i_view,
548 PLAYLIST_APPEND, PLAYLIST_END );
550 playlist_CopyParents( p_parent, p_item );
556 for( i = 0; i < i_extensions; i++ )
558 if( ppsz_extensions[i] )
559 free( ppsz_extensions[i] );
561 if( ppsz_extensions ) free( ppsz_extensions );
562 if( psz_ignore ) free( psz_ignore );
564 free( pp_dir_content );