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;
140 if( ( stat( p_access->psz_path, &stat_info ) == -1 ) ||
141 !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") )
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" );
215 /* Remove the ending '/' char */
216 psz_name = strdup( p_access->psz_path );
217 if( psz_name == NULL )
220 if( (psz_name[strlen(psz_name)-1] == '/') ||
221 (psz_name[strlen(psz_name)-1] == '\\') )
223 psz_name[strlen(psz_name)-1] = '\0';
226 /* Initialize structure */
227 psz = var_CreateGetString( p_access, "recursive" );
228 if( *psz == '\0' || !strncmp( psz, "none" , 4 ) )
232 else if( !strncmp( psz, "collapse", 8 ) )
234 i_mode = MODE_COLLAPSE;
238 i_mode = MODE_EXPAND;
242 /* Make sure we are deleted when we are done */
243 /* The playlist position we will use for the add */
244 i_pos = p_playlist->i_index + 1;
246 msg_Dbg( p_access, "opening directory `%s'", psz_name );
248 if( &p_playlist->status.p_item->input ==
249 ((input_thread_t *)p_access->p_parent)->input.p_item )
251 p_item = p_playlist->status.p_item;
253 msg_Dbg( p_access, "starting directory playback");
257 input_item_t *p_current = ( (input_thread_t*)p_access->p_parent)->
259 p_item = playlist_LockItemGetByInput( p_playlist, p_current );
260 msg_Dbg( p_access, "not starting directory playback");
263 msg_Dbg( p_playlist, "unable to find item in playlist");
269 p_item->input.i_type = ITEM_TYPE_DIRECTORY;
270 if( ReadDir( p_playlist, psz_name , i_mode, &i_pos,
271 p_item ) != VLC_SUCCESS )
276 /* Begin to read the directory */
279 playlist_Control( p_playlist, PLAYLIST_VIEWPLAY,
280 p_playlist->status.i_view,
281 p_playlist->status.p_item, NULL );
283 if( psz_name ) free( psz_name );
284 vlc_object_release( p_playlist );
286 /* Return fake data forever */
287 p_access->pf_read = ReadNull;
288 return ReadNull( p_access, p_buffer, i_len );
291 /*****************************************************************************
293 *****************************************************************************/
294 static int Control( access_t *p_access, int i_query, va_list args )
303 case ACCESS_CAN_SEEK:
304 case ACCESS_CAN_FASTSEEK:
305 case ACCESS_CAN_PAUSE:
306 case ACCESS_CAN_CONTROL_PACE:
307 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
308 *pb_bool = VLC_FALSE; /* FIXME */
313 pi_int = (int*)va_arg( args, int * );
317 case ACCESS_GET_PTS_DELAY:
318 pi_64 = (int64_t*)va_arg( args, int64_t * );
319 *pi_64 = DEFAULT_PTS_DELAY * 1000;
323 case ACCESS_SET_PAUSE_STATE:
324 case ACCESS_GET_TITLE_INFO:
325 case ACCESS_SET_TITLE:
326 case ACCESS_SET_SEEKPOINT:
327 case ACCESS_SET_PRIVATE_ID_STATE:
331 msg_Warn( p_access, "unimplemented query in control" );
337 /*****************************************************************************
339 *****************************************************************************/
340 static int DemuxOpen ( vlc_object_t *p_this )
342 demux_t *p_demux = (demux_t*)p_this;
344 if( strcmp( p_demux->psz_demux, "directory" ) )
347 p_demux->pf_demux = Demux;
348 p_demux->pf_control = DemuxControl;
352 /*****************************************************************************
354 *****************************************************************************/
355 static int Demux( demux_t *p_demux )
359 /*****************************************************************************
361 *****************************************************************************/
362 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
364 return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
367 static int Filter( const struct dirent *foo )
371 /*****************************************************************************
372 * ReadDir: read a directory and add its content to the list
373 *****************************************************************************/
374 static int ReadDir( playlist_t *p_playlist,
375 char *psz_name, int i_mode, int *pi_position,
376 playlist_item_t *p_parent )
378 struct dirent **pp_dir_content;
379 int i_dir_content, i;
380 playlist_item_t *p_node;
382 /* Build array with ignores */
384 char **ppsz_extensions = 0;
385 int i_extensions = 0;
386 char *psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
387 if( psz_ignore && *psz_ignore )
390 char *psz_parser = psz_backup = strdup( psz_ignore );
393 while( strsep( &psz_parser, "," ) ) i_extensions++;
396 ppsz_extensions = (char **)malloc( sizeof( char * ) * i_extensions );
398 psz_parser = psz_ignore;
399 while( a < i_extensions &&
400 ( ppsz_extensions[a++] = strsep( &psz_parser, "," ) ) );
402 #endif /* HAVE_STRSEP */
404 /* Change the item to a node */
405 if( p_parent->i_children == -1 )
407 playlist_LockItemToNode( p_playlist,p_parent );
410 /* get the first directory entry */
411 i_dir_content = scandir( psz_name, &pp_dir_content, Filter, alphasort );
412 if( i_dir_content == -1 )
414 msg_Warn( p_playlist, "Failed to read directory" );
417 else if( i_dir_content <= 0 )
419 /* directory is empty */
423 /* While we still have entries in the directory */
424 for( i = 0; i < i_dir_content; i++ )
426 struct dirent *p_dir_content = pp_dir_content[i];
427 int i_size_entry = strlen( psz_name ) +
428 strlen( p_dir_content->d_name ) + 2;
429 char *psz_uri = (char *)malloc( sizeof(char) * i_size_entry );
431 sprintf( psz_uri, "%s/%s", psz_name, p_dir_content->d_name );
433 /* if it starts with '.' then forget it */
434 if( p_dir_content->d_name[0] != '.' )
436 #if defined( S_ISDIR )
437 struct stat stat_data;
438 stat( psz_uri, &stat_data );
439 if( S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
440 #elif defined( DT_DIR )
441 if( ( p_dir_content->d_type & DT_DIR ) && i_mode != MODE_COLLAPSE )
446 if( i_mode == MODE_NONE )
448 msg_Dbg( p_playlist, "Skipping subdirectory %s", psz_uri );
452 else if( i_mode == MODE_EXPAND )
455 msg_Dbg(p_playlist, "Reading subdirectory %s", psz_uri );
457 if( !strncmp( psz_uri, psz_name, strlen( psz_name ) ) )
459 char *psz_subdir = psz_uri;
460 /* Skip the parent path + the separator */
461 psz_subdir += strlen( psz_name ) + 1;
462 psz_newname = vlc_fix_readdir_charset(
463 p_playlist, psz_subdir );
467 psz_newname = vlc_fix_readdir_charset(
468 p_playlist, psz_name );
470 p_node = playlist_NodeCreate( p_playlist,
471 p_parent->pp_parents[0]->i_view,
472 psz_newname, p_parent );
474 playlist_CopyParents( p_parent, p_node );
476 p_node->input.i_type = ITEM_TYPE_DIRECTORY;
478 if( ReadDir( p_playlist, psz_uri , MODE_EXPAND,
479 pi_position, p_node ) != VLC_SUCCESS )
489 playlist_item_t *p_item;
490 char *psz_tmp1, *psz_tmp2;
493 if( i_extensions > 0 )
495 char *psz_dot = strrchr( p_dir_content->d_name, '.' );
496 if( psz_dot++ && *psz_dot )
499 for( a = 0; a < i_extensions; a++ )
501 if( !strcmp( psz_dot, ppsz_extensions[a] ) )
504 if( a < i_extensions )
506 msg_Dbg( p_playlist, "Ignoring file %s", psz_uri );
512 #endif /* HAVE_STRSEP */
514 psz_tmp1 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
516 psz_tmp2 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
517 p_dir_content->d_name );
519 p_item = playlist_ItemNewWithType( VLC_OBJECT(p_playlist),
520 psz_tmp1, psz_tmp2, ITEM_TYPE_VFILE );
521 playlist_NodeAddItem( p_playlist,p_item,
522 p_parent->pp_parents[0]->i_view,
524 PLAYLIST_APPEND, PLAYLIST_END );
526 playlist_CopyParents( p_parent, p_item );
533 if( ppsz_extensions ) free( ppsz_extensions );
534 if( psz_ignore ) free( psz_ignore );
535 #endif /* HAVE_STRSEP */
537 free( pp_dir_content );