1 /*****************************************************************************
2 * directory.c: expands a directory (directory: access plug-in)
3 *****************************************************************************
4 * Copyright (C) 2002-2007 the VideoLAN team
7 * Authors: Derk-Jan Hartman <hartman at videolan dot org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
30 #include <vlc_playlist.h>
31 #include <vlc_input.h>
32 #include <vlc_access.h>
33 #include <vlc_demux.h>
37 #ifdef HAVE_SYS_TYPES_H
38 # include <sys/types.h>
40 #ifdef HAVE_SYS_STAT_H
41 # include <sys/stat.h>
52 #elif defined( WIN32 ) && !defined( UNDER_CE )
54 #elif defined( UNDER_CE )
55 # define strcoll strcmp
62 #include <vlc_charset.h>
64 /*****************************************************************************
66 *****************************************************************************/
67 static int Open ( vlc_object_t * );
68 static void Close( vlc_object_t * );
70 static int DemuxOpen ( vlc_object_t * );
72 #define RECURSIVE_TEXT N_("Subdirectory behavior")
73 #define RECURSIVE_LONGTEXT N_( \
74 "Select whether subdirectories must be expanded.\n" \
75 "none: subdirectories do not appear in the playlist.\n" \
76 "collapse: subdirectories appear but are expanded on first play.\n" \
77 "expand: all subdirectories are expanded.\n" )
79 static const char *psz_recursive_list[] = { "none", "collapse", "expand" };
80 static const char *psz_recursive_list_text[] = { N_("none"), N_("collapse"),
83 #define IGNORE_TEXT N_("Ignored extensions")
84 #define IGNORE_LONGTEXT N_( \
85 "Files with these extensions will not be added to playlist when " \
86 "opening a directory.\n" \
87 "This is useful if you add directories that contain playlist files " \
88 "for instance. Use a comma-separated list of extensions." )
91 set_category( CAT_INPUT );
92 set_shortname( _("Directory" ) );
93 set_subcategory( SUBCAT_INPUT_ACCESS );
94 set_description( _("Standard filesystem directory input") );
95 set_capability( "access2", 55 );
96 add_shortcut( "directory" );
97 add_shortcut( "dir" );
98 add_shortcut( "file" );
99 add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
100 RECURSIVE_LONGTEXT, VLC_FALSE );
101 change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
102 add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
103 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, VLC_FALSE );
104 set_callbacks( Open, Close );
107 set_description( "Directory EOF");
108 set_capability( "demux2", 0 );
109 add_shortcut( "directory" );
110 set_callbacks( DemuxOpen, NULL );
114 /*****************************************************************************
115 * Local prototypes, constants, structures
116 *****************************************************************************/
125 typedef struct stat_list_t stat_list_t;
127 static int Read( access_t *, uint8_t *, int );
128 static int ReadNull( access_t *, uint8_t *, int );
129 static int Control( access_t *, int, va_list );
131 static int Demux( demux_t *p_demux );
132 static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
135 static int ReadDir( playlist_t *, const char *psz_name, int i_mode,
136 playlist_item_t *, playlist_item_t *, input_item_t *,
137 DIR *handle, stat_list_t *stats );
139 static DIR *OpenDir (vlc_object_t *obj, const char *psz_name);
141 /*****************************************************************************
142 * Open: open the directory
143 *****************************************************************************/
144 static int Open( vlc_object_t *p_this )
146 access_t *p_access = (access_t*)p_this;
148 DIR *handle = OpenDir (p_this, p_access->psz_path);
152 p_access->p_sys = (access_sys_t *)handle;
154 p_access->pf_read = Read;
155 p_access->pf_block = NULL;
156 p_access->pf_seek = NULL;
157 p_access->pf_control= Control;
160 p_access->psz_demux = strdup( "directory" );
165 /*****************************************************************************
166 * Close: close the target
167 *****************************************************************************/
168 static void Close( vlc_object_t * p_this )
170 access_t *p_access = (access_t*)p_this;
171 DIR *handle = (DIR *)p_access->p_sys;
175 /*****************************************************************************
176 * ReadNull: read the directory
177 *****************************************************************************/
178 static int ReadNull( access_t *p_access, uint8_t *p_buffer, int i_len)
180 /* Return fake data */
181 memset( p_buffer, 0, i_len );
185 /*****************************************************************************
186 * Read: read the directory
187 *****************************************************************************/
188 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len)
191 int i_mode, i_activity;
192 char *psz_name = strdup (p_access->psz_path);
194 if( psz_name == NULL )
197 playlist_t *p_playlist = pl_Yield( p_access );
198 input_thread_t *p_input = (input_thread_t*)vlc_object_find( p_access, VLC_OBJECT_INPUT, FIND_PARENT );
200 playlist_item_t *p_item_in_category;
201 input_item_t *p_current_input;
202 playlist_item_t *p_current;
206 msg_Err( p_access, "unable to find input (internal error)" );
207 vlc_object_release( p_playlist );
211 p_current_input = input_GetItem( p_input );
212 p_current = playlist_ItemGetByInput( p_playlist, p_current_input, VLC_FALSE );
216 msg_Err( p_access, "unable to find item in playlist" );
217 vlc_object_release( p_input );
218 vlc_object_release( p_playlist );
222 /* Remove the ending '/' char */
225 char *ptr = psz_name + strlen (psz_name);
235 psz = var_CreateGetString( p_access, "recursive" );
236 if( *psz == '\0' || !strncmp( psz, "none" , 4 ) )
238 else if( !strncmp( psz, "collapse", 8 ) )
239 i_mode = MODE_COLLAPSE;
241 i_mode = MODE_EXPAND;
244 p_current->p_input->i_type = ITEM_TYPE_DIRECTORY;
245 p_item_in_category = playlist_ItemToNode( p_playlist, p_current,
248 i_activity = var_GetInteger( p_playlist, "activity" );
249 var_SetInteger( p_playlist, "activity", i_activity +
250 DIRECTORY_ACTIVITY );
252 ReadDir( p_playlist, psz_name, i_mode, p_current, p_item_in_category,
253 p_current_input, (DIR *)p_access->p_sys, NULL );
255 i_activity = var_GetInteger( p_playlist, "activity" );
256 var_SetInteger( p_playlist, "activity", i_activity -
257 DIRECTORY_ACTIVITY );
259 playlist_Signal( p_playlist );
261 if( psz_name ) free( psz_name );
262 vlc_object_release( p_input );
263 vlc_object_release( p_playlist );
265 /* Return fake data forever */
266 p_access->pf_read = ReadNull;
267 return ReadNull( p_access, p_buffer, i_len );
270 /*****************************************************************************
272 *****************************************************************************/
273 static int Control( access_t *p_access, int i_query, va_list args )
282 case ACCESS_CAN_SEEK:
283 case ACCESS_CAN_FASTSEEK:
284 case ACCESS_CAN_PAUSE:
285 case ACCESS_CAN_CONTROL_PACE:
286 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
287 *pb_bool = VLC_FALSE; /* FIXME */
292 pi_int = (int*)va_arg( args, int * );
296 case ACCESS_GET_PTS_DELAY:
297 pi_64 = (int64_t*)va_arg( args, int64_t * );
298 *pi_64 = DEFAULT_PTS_DELAY * 1000;
302 case ACCESS_SET_PAUSE_STATE:
303 case ACCESS_GET_TITLE_INFO:
304 case ACCESS_SET_TITLE:
305 case ACCESS_SET_SEEKPOINT:
306 case ACCESS_SET_PRIVATE_ID_STATE:
310 msg_Warn( p_access, "unimplemented query in control" );
316 /*****************************************************************************
318 *****************************************************************************/
319 static int DemuxOpen ( vlc_object_t *p_this )
321 demux_t *p_demux = (demux_t*)p_this;
323 if( strcmp( p_demux->psz_demux, "directory" ) )
326 p_demux->pf_demux = Demux;
327 p_demux->pf_control = DemuxControl;
331 /*****************************************************************************
333 *****************************************************************************/
334 static int Demux( demux_t *p_demux )
339 /*****************************************************************************
341 *****************************************************************************/
342 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
344 return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
348 static int Sort (const char **a, const char **b)
350 return strcoll (*a, *b);
360 /*****************************************************************************
361 * ReadDir: read a directory and add its content to the list
362 *****************************************************************************/
363 static int ReadDir( playlist_t *p_playlist, const char *psz_name,
364 int i_mode, playlist_item_t *p_parent,
365 playlist_item_t *p_parent_category,
366 input_item_t *p_current_input,
367 DIR *handle, stat_list_t *stparent )
369 char **pp_dir_content = NULL;
370 int i_dir_content, i, i_return = VLC_SUCCESS;
371 playlist_item_t *p_node;
373 char **ppsz_extensions = NULL;
374 int i_extensions = 0;
377 struct stat_list_t stself;
379 int fd = dirfd (handle);
381 if ((fd == -1) || fstat (fd, &stself.st))
383 msg_Err (p_playlist, "cannot stat `%s': %s", psz_name,
388 for (stat_list_t *stats = stparent; stats != NULL; stats = stats->parent)
390 if ((stself.st.st_ino == stats->st.st_ino)
391 && (stself.st.st_dev == stats->st.st_dev))
393 msg_Warn (p_playlist,
394 "ignoring infinitely recursive directory `%s'",
400 /* Windows has st_dev (driver letter - 'A'), but it zeroes st_ino,
401 * so that the test above will always incorrectly succeed.
402 * Besides, Windows does not have dirfd(). */
405 stself.parent = stparent;
407 /* Get the first directory entry */
408 i_dir_content = utf8_loaddir (handle, &pp_dir_content, NULL, Sort);
409 if( i_dir_content == -1 )
411 msg_Err (p_playlist, "cannot read `%s': %s", psz_name,
415 else if( i_dir_content <= 0 )
417 /* directory is empty */
418 msg_Dbg( p_playlist, "%s directory is empty", psz_name );
419 free( pp_dir_content );
423 /* Build array with ignores */
424 psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
425 if( psz_ignore && *psz_ignore )
427 char *psz_parser = psz_ignore;
430 for( a = 0; psz_parser[a] != '\0'; a++ )
432 if( psz_parser[a] == ',' ) i_extensions++;
435 ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
437 for( a = 0; a < i_extensions; a++ )
441 while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
442 ptr = strchr( psz_parser, ',');
443 tmp = ( ptr == NULL )
444 ? strdup( psz_parser )
445 : strndup( psz_parser, ptr - psz_parser );
447 ppsz_extensions[a] = tmp;
448 psz_parser = ptr + 1;
451 if( psz_ignore ) free( psz_ignore );
453 /* While we still have entries in the directory */
454 for( i = 0; i < i_dir_content; i++ )
456 const char *entry = pp_dir_content[i];
457 int i_size_entry = strlen( psz_name ) +
458 strlen( entry ) + 2 + 7 /* strlen("file://") */;
459 char psz_uri[i_size_entry];
461 sprintf( psz_uri, "%s/%s", psz_name, entry);
463 /* if it starts with '.' then forget it */
466 DIR *subdir = (i_mode != MODE_COLLAPSE)
467 ? OpenDir (VLC_OBJECT (p_playlist), psz_uri) : NULL;
469 if (subdir != NULL) /* Recurse into subdirectory */
471 if( i_mode == MODE_NONE )
473 msg_Dbg( p_playlist, "skipping subdirectory `%s'",
479 msg_Dbg (p_playlist, "creating subdirectory %s", psz_uri);
481 p_node = playlist_NodeCreate( p_playlist, entry,
483 PLAYLIST_NO_REBUILD );
485 /* If we had the parent in category, the it is now node.
486 * Else, we still don't have */
487 i_return = ReadDir( p_playlist, psz_uri , MODE_EXPAND,
488 p_node, p_parent_category ? p_node : NULL,
489 p_current_input, subdir, &stself );
496 input_item_t *p_input;
498 if( i_extensions > 0 )
500 const char *psz_dot = strrchr (entry, '.' );
501 if( psz_dot++ && *psz_dot )
504 for( a = 0; a < i_extensions; a++ )
506 if( !strcmp( psz_dot, ppsz_extensions[a] ) )
509 if( a < i_extensions )
511 msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
517 memmove (psz_uri + 7, psz_uri, sizeof (psz_uri) - 7);
518 memcpy (psz_uri, "file://", 7);
519 p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist),
520 psz_uri, entry, 0, NULL,
521 -1, ITEM_TYPE_VFILE );
524 if( p_current_input )
525 input_ItemCopyOptions( p_current_input, p_input );
526 playlist_BothAddInput( p_playlist, p_input,
528 PLAYLIST_APPEND|PLAYLIST_PREPARSE|
530 PLAYLIST_END, NULL, NULL,
537 for( i = 0; i < i_extensions; i++ )
538 if( ppsz_extensions[i] ) free( ppsz_extensions[i] );
539 if( ppsz_extensions ) free( ppsz_extensions );
541 for( i = 0; i < i_dir_content; i++ )
542 if( pp_dir_content[i] ) free( pp_dir_content[i] );
543 if( pp_dir_content ) free( pp_dir_content );
549 static DIR *OpenDir (vlc_object_t *obj, const char *path)
551 msg_Dbg (obj, "opening directory `%s'", path);
552 DIR *handle = utf8_opendir (path);
557 msg_Err (obj, "%s: %s", path, strerror (err));
559 msg_Dbg (obj, "skipping non-directory `%s'", path);