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>
35 #ifdef HAVE_SYS_TYPES_H
36 # include <sys/types.h>
38 #ifdef HAVE_SYS_STAT_H
39 # include <sys/stat.h>
50 #elif defined( WIN32 ) && !defined( UNDER_CE )
52 #elif defined( UNDER_CE )
53 # define strcoll strcmp
60 #include <vlc_charset.h>
62 /*****************************************************************************
64 *****************************************************************************/
65 static int Open ( vlc_object_t * );
66 static void Close( vlc_object_t * );
68 static int DemuxOpen ( vlc_object_t * );
70 #define RECURSIVE_TEXT N_("Subdirectory behavior")
71 #define RECURSIVE_LONGTEXT N_( \
72 "Select whether subdirectories must be expanded.\n" \
73 "none: subdirectories do not appear in the playlist.\n" \
74 "collapse: subdirectories appear but are expanded on first play.\n" \
75 "expand: all subdirectories are expanded.\n" )
77 static const char *psz_recursive_list[] = { "none", "collapse", "expand" };
78 static const char *psz_recursive_list_text[] = { N_("none"), N_("collapse"),
81 #define IGNORE_TEXT N_("Ignored extensions")
82 #define IGNORE_LONGTEXT N_( \
83 "Files with these extensions will not be added to playlist when " \
84 "opening a directory.\n" \
85 "This is useful if you add directories that contain playlist files " \
86 "for instance. Use a comma-separated list of extensions." )
89 set_category( CAT_INPUT );
90 set_shortname( _("Directory" ) );
91 set_subcategory( SUBCAT_INPUT_ACCESS );
92 set_description( _("Standard filesystem directory input") );
93 set_capability( "access2", 55 );
94 add_shortcut( "directory" );
95 add_shortcut( "dir" );
96 add_shortcut( "file" );
97 add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
98 RECURSIVE_LONGTEXT, VLC_FALSE );
99 change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
100 add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
101 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, VLC_FALSE );
102 set_callbacks( Open, Close );
105 set_description( "Directory EOF");
106 set_capability( "demux2", 0 );
107 set_callbacks( DemuxOpen, NULL );
111 /*****************************************************************************
112 * Local prototypes, constants, structures
113 *****************************************************************************/
122 typedef struct stat_list_t stat_list_t;
124 static int Read( access_t *, uint8_t *, int );
125 static int ReadNull( access_t *, uint8_t *, int );
126 static int Control( access_t *, int, va_list );
128 static int Demux( demux_t *p_demux );
129 static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
132 static int ReadDir( playlist_t *, const char *psz_name, int i_mode,
133 playlist_item_t *, playlist_item_t *, input_item_t *,
134 DIR *handle, stat_list_t *stats );
136 static DIR *OpenDir (vlc_object_t *obj, const char *psz_name);
138 /*****************************************************************************
139 * Open: open the directory
140 *****************************************************************************/
141 static int Open( vlc_object_t *p_this )
143 access_t *p_access = (access_t*)p_this;
145 DIR *handle = OpenDir (p_this, p_access->psz_path);
149 p_access->p_sys = (access_sys_t *)handle;
151 p_access->pf_read = Read;
152 p_access->pf_block = NULL;
153 p_access->pf_seek = NULL;
154 p_access->pf_control= Control;
157 p_access->psz_demux = strdup( "directory" );
162 /*****************************************************************************
163 * Close: close the target
164 *****************************************************************************/
165 static void Close( vlc_object_t * p_this )
167 access_t *p_access = (access_t*)p_this;
168 DIR *handle = (DIR *)p_access->p_sys;
172 /*****************************************************************************
173 * ReadNull: read the directory
174 *****************************************************************************/
175 static int ReadNull( access_t *p_access, uint8_t *p_buffer, int i_len)
177 /* Return fake data */
178 memset( p_buffer, 0, i_len );
182 /*****************************************************************************
183 * Read: read the directory
184 *****************************************************************************/
185 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len)
188 int i_mode, i_activity;
189 char *psz_name = strdup (p_access->psz_path);
191 if( psz_name == NULL )
194 playlist_t *p_playlist = pl_Yield( p_access );
195 input_thread_t *p_input = (input_thread_t*)vlc_object_find( p_access, VLC_OBJECT_INPUT, FIND_PARENT );
197 playlist_item_t *p_item_in_category;
198 input_item_t *p_current_input;
199 playlist_item_t *p_current;
203 msg_Err( p_access, "unable to find input (internal error)" );
204 vlc_object_release( p_playlist );
208 p_current_input = input_GetItem( p_input );
209 p_current = playlist_ItemGetByInput( p_playlist, p_current_input, VLC_FALSE );
213 msg_Err( p_access, "unable to find item in playlist" );
214 vlc_object_release( p_input );
215 vlc_object_release( p_playlist );
219 /* Remove the ending '/' char */
222 char *ptr = psz_name + strlen (psz_name);
232 psz = var_CreateGetString( p_access, "recursive" );
233 if( *psz == '\0' || !strncmp( psz, "none" , 4 ) )
235 else if( !strncmp( psz, "collapse", 8 ) )
236 i_mode = MODE_COLLAPSE;
238 i_mode = MODE_EXPAND;
241 p_current->p_input->i_type = ITEM_TYPE_DIRECTORY;
242 p_item_in_category = playlist_ItemToNode( p_playlist, p_current,
245 i_activity = var_GetInteger( p_playlist, "activity" );
246 var_SetInteger( p_playlist, "activity", i_activity +
247 DIRECTORY_ACTIVITY );
249 ReadDir( p_playlist, psz_name, i_mode, p_current, p_item_in_category,
250 p_current_input, (DIR *)p_access->p_sys, NULL );
252 i_activity = var_GetInteger( p_playlist, "activity" );
253 var_SetInteger( p_playlist, "activity", i_activity -
254 DIRECTORY_ACTIVITY );
256 playlist_Signal( p_playlist );
258 if( psz_name ) free( psz_name );
259 vlc_object_release( p_input );
260 vlc_object_release( p_playlist );
262 /* Return fake data forever */
263 p_access->pf_read = ReadNull;
264 return ReadNull( p_access, p_buffer, i_len );
267 /*****************************************************************************
269 *****************************************************************************/
270 static int Control( access_t *p_access, int i_query, va_list args )
279 case ACCESS_CAN_SEEK:
280 case ACCESS_CAN_FASTSEEK:
281 case ACCESS_CAN_PAUSE:
282 case ACCESS_CAN_CONTROL_PACE:
283 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
284 *pb_bool = VLC_FALSE; /* FIXME */
289 pi_int = (int*)va_arg( args, int * );
293 case ACCESS_GET_PTS_DELAY:
294 pi_64 = (int64_t*)va_arg( args, int64_t * );
295 *pi_64 = DEFAULT_PTS_DELAY * 1000;
299 case ACCESS_SET_PAUSE_STATE:
300 case ACCESS_GET_TITLE_INFO:
301 case ACCESS_SET_TITLE:
302 case ACCESS_SET_SEEKPOINT:
303 case ACCESS_SET_PRIVATE_ID_STATE:
304 case ACCESS_GET_CONTENT_TYPE:
308 msg_Warn( p_access, "unimplemented query in control" );
314 /*****************************************************************************
316 *****************************************************************************/
317 static int DemuxOpen ( vlc_object_t *p_this )
319 demux_t *p_demux = (demux_t*)p_this;
321 if( strcmp( p_demux->psz_demux, "directory" ) )
324 p_demux->pf_demux = Demux;
325 p_demux->pf_control = DemuxControl;
329 /*****************************************************************************
331 *****************************************************************************/
332 static int Demux( demux_t *p_demux )
337 /*****************************************************************************
339 *****************************************************************************/
340 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
342 return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
346 static int Sort (const char **a, const char **b)
348 return strcoll (*a, *b);
358 /*****************************************************************************
359 * ReadDir: read a directory and add its content to the list
360 *****************************************************************************/
361 static int ReadDir( playlist_t *p_playlist, const char *psz_name,
362 int i_mode, playlist_item_t *p_parent,
363 playlist_item_t *p_parent_category,
364 input_item_t *p_current_input,
365 DIR *handle, stat_list_t *stparent )
367 char **pp_dir_content = NULL;
368 int i_dir_content, i, i_return = VLC_SUCCESS;
369 playlist_item_t *p_node;
371 char **ppsz_extensions = NULL;
372 int i_extensions = 0;
375 struct stat_list_t stself;
377 int fd = dirfd (handle);
379 if ((fd == -1) || fstat (fd, &stself.st))
381 msg_Err (p_playlist, "cannot stat `%s': %m", psz_name);
385 for (stat_list_t *stats = stparent; stats != NULL; stats = stats->parent)
387 if ((stself.st.st_ino == stats->st.st_ino)
388 && (stself.st.st_dev == stats->st.st_dev))
390 msg_Warn (p_playlist,
391 "ignoring infinitely recursive directory `%s'",
397 /* Windows has st_dev (driver letter - 'A'), but it zeroes st_ino,
398 * so that the test above will always incorrectly succeed.
399 * Besides, Windows does not have dirfd(). */
402 stself.parent = stparent;
404 /* Get the first directory entry */
405 i_dir_content = utf8_loaddir (handle, &pp_dir_content, NULL, Sort);
406 if( i_dir_content == -1 )
408 msg_Err (p_playlist, "cannot read `%s': %m", psz_name);
411 else if( i_dir_content <= 0 )
413 /* directory is empty */
414 msg_Dbg( p_playlist, "%s directory is empty", psz_name );
415 free( pp_dir_content );
419 /* Build array with ignores */
420 psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
421 if( psz_ignore && *psz_ignore )
423 char *psz_parser = psz_ignore;
426 for( a = 0; psz_parser[a] != '\0'; a++ )
428 if( psz_parser[a] == ',' ) i_extensions++;
431 ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
433 for( a = 0; a < i_extensions; a++ )
437 while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
438 ptr = strchr( psz_parser, ',');
439 tmp = ( ptr == NULL )
440 ? strdup( psz_parser )
441 : strndup( psz_parser, ptr - psz_parser );
443 ppsz_extensions[a] = tmp;
444 psz_parser = ptr + 1;
447 if( psz_ignore ) free( psz_ignore );
449 /* While we still have entries in the directory */
450 for( i = 0; i < i_dir_content; i++ )
452 const char *entry = pp_dir_content[i];
453 int i_size_entry = strlen( psz_name ) +
454 strlen( entry ) + 2 + 7 /* strlen("file://") */;
455 char psz_uri[i_size_entry];
457 sprintf( psz_uri, "%s/%s", psz_name, entry);
459 /* if it starts with '.' then forget it */
462 DIR *subdir = (i_mode != MODE_COLLAPSE)
463 ? OpenDir (VLC_OBJECT (p_playlist), psz_uri) : NULL;
465 if (subdir != NULL) /* Recurse into subdirectory */
467 if( i_mode == MODE_NONE )
469 msg_Dbg( p_playlist, "skipping subdirectory `%s'",
475 msg_Dbg (p_playlist, "creating subdirectory %s", psz_uri);
477 p_node = playlist_NodeCreate( p_playlist, entry,
479 PLAYLIST_NO_REBUILD, NULL );
481 /* If we had the parent in category, the it is now node.
482 * Else, we still don't have */
483 i_return = ReadDir( p_playlist, psz_uri , MODE_EXPAND,
484 p_node, p_parent_category ? p_node : NULL,
485 p_current_input, subdir, &stself );
492 input_item_t *p_input;
494 if( i_extensions > 0 )
496 const char *psz_dot = strrchr (entry, '.' );
497 if( psz_dot++ && *psz_dot )
500 for( a = 0; a < i_extensions; a++ )
502 if( !strcmp( psz_dot, ppsz_extensions[a] ) )
505 if( a < i_extensions )
507 msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
513 memmove (psz_uri + 7, psz_uri, sizeof (psz_uri) - 7);
514 memcpy (psz_uri, "file://", 7);
515 p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist),
516 psz_uri, entry, 0, NULL,
517 -1, ITEM_TYPE_FILE );
520 if( p_current_input )
521 input_ItemCopyOptions( p_current_input, p_input );
522 playlist_BothAddInput( p_playlist, p_input,
524 PLAYLIST_APPEND|PLAYLIST_PREPARSE|
526 PLAYLIST_END, NULL, NULL,
533 for( i = 0; i < i_extensions; i++ )
534 if( ppsz_extensions[i] ) free( ppsz_extensions[i] );
535 if( ppsz_extensions ) free( ppsz_extensions );
537 for( i = 0; i < i_dir_content; i++ )
538 if( pp_dir_content[i] ) free( pp_dir_content[i] );
539 if( pp_dir_content ) free( pp_dir_content );
545 static DIR *OpenDir (vlc_object_t *obj, const char *path)
547 msg_Dbg (obj, "opening directory `%s'", path);
548 DIR *handle = utf8_opendir (path);
553 msg_Err (obj, "%s: %m", path);
555 msg_Dbg (obj, "skipping non-directory `%s'", path);