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 *****************************************************************************/
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
35 #include <vlc_playlist.h>
36 #include <vlc_input.h>
37 #include <vlc_access.h>
38 #include <vlc_demux.h>
40 #ifdef HAVE_SYS_TYPES_H
41 # include <sys/types.h>
43 #ifdef HAVE_SYS_STAT_H
44 # include <sys/stat.h>
55 #elif defined( WIN32 ) && !defined( UNDER_CE )
57 #elif defined( UNDER_CE )
58 # define strcoll strcmp
65 #include <vlc_charset.h>
67 /*****************************************************************************
69 *****************************************************************************/
70 static int Open ( vlc_object_t * );
71 static void Close( vlc_object_t * );
73 static int DemuxOpen ( vlc_object_t * );
75 #define RECURSIVE_TEXT N_("Subdirectory behavior")
76 #define RECURSIVE_LONGTEXT N_( \
77 "Select whether subdirectories must be expanded.\n" \
78 "none: subdirectories do not appear in the playlist.\n" \
79 "collapse: subdirectories appear but are expanded on first play.\n" \
80 "expand: all subdirectories are expanded.\n" )
82 static const char *const psz_recursive_list[] = { "none", "collapse", "expand" };
83 static const char *const psz_recursive_list_text[] = {
84 N_("none"), N_("collapse"), N_("expand") };
86 #define IGNORE_TEXT N_("Ignored extensions")
87 #define IGNORE_LONGTEXT N_( \
88 "Files with these extensions will not be added to playlist when " \
89 "opening a directory.\n" \
90 "This is useful if you add directories that contain playlist files " \
91 "for instance. Use a comma-separated list of extensions." )
94 set_category( CAT_INPUT );
95 set_shortname( N_("Directory" ) );
96 set_subcategory( SUBCAT_INPUT_ACCESS );
97 set_description( N_("Standard filesystem directory input") );
98 set_capability( "access", 55 );
99 add_shortcut( "directory" );
100 add_shortcut( "dir" );
101 add_shortcut( "file" );
102 add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
103 RECURSIVE_LONGTEXT, false );
104 change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
105 add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
106 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, false );
107 set_callbacks( Open, Close );
110 set_description( "Directory EOF");
111 set_capability( "demux", 0 );
112 set_callbacks( DemuxOpen, NULL );
116 /*****************************************************************************
117 * Local prototypes, constants, structures
118 *****************************************************************************/
127 typedef struct stat_list_t stat_list_t;
129 static ssize_t Read( access_t *, uint8_t *, size_t );
130 static ssize_t ReadNull( access_t *, uint8_t *, size_t );
131 static int Control( access_t *, int, va_list );
133 static int Demux( demux_t *p_demux );
134 static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
137 static int ReadDir( playlist_t *, const char *psz_name, int i_mode,
138 playlist_item_t *, playlist_item_t *, input_item_t *,
139 DIR *handle, stat_list_t *stats );
141 static DIR *OpenDir (vlc_object_t *obj, const char *psz_name);
143 /*****************************************************************************
144 * Open: open the directory
145 *****************************************************************************/
146 static int Open( vlc_object_t *p_this )
148 access_t *p_access = (access_t*)p_this;
150 if( !p_access->psz_path )
154 if( !stat( p_access->psz_path, &st ) && !S_ISDIR( st.st_mode ) )
157 DIR *handle = OpenDir (p_this, p_access->psz_path);
161 p_access->p_sys = (access_sys_t *)handle;
163 p_access->pf_read = Read;
164 p_access->pf_block = NULL;
165 p_access->pf_seek = NULL;
166 p_access->pf_control= Control;
169 free( p_access->psz_demux );
170 p_access->psz_demux = strdup( "directory" );
175 /*****************************************************************************
176 * Close: close the target
177 *****************************************************************************/
178 static void Close( vlc_object_t * p_this )
180 access_t *p_access = (access_t*)p_this;
181 DIR *handle = (DIR *)p_access->p_sys;
185 /*****************************************************************************
186 * ReadNull: read the directory
187 *****************************************************************************/
188 static ssize_t ReadNull( access_t *p_access, uint8_t *p_buffer, size_t i_len)
190 /* Return fake data */
191 memset( p_buffer, 0, i_len );
195 /*****************************************************************************
196 * Read: read the directory
197 *****************************************************************************/
198 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len)
201 int i_mode, i_activity;
202 char *psz_name = strdup (p_access->psz_path);
204 if( psz_name == NULL )
207 playlist_t *p_playlist = pl_Yield( p_access );
208 input_thread_t *p_input = (input_thread_t*)vlc_object_find( p_access, VLC_OBJECT_INPUT, FIND_PARENT );
210 playlist_item_t *p_item_in_category;
211 input_item_t *p_current_input;
212 playlist_item_t *p_current;
216 msg_Err( p_access, "unable to find input (internal error)" );
217 vlc_object_release( p_playlist );
221 p_current_input = input_GetItem( p_input );
222 p_current = playlist_ItemGetByInput( p_playlist, p_current_input, false );
226 msg_Err( p_access, "unable to find item in playlist" );
227 vlc_object_release( p_input );
228 vlc_object_release( p_playlist );
232 /* Remove the ending '/' char */
235 char *ptr = psz_name + strlen (psz_name);
245 psz = var_CreateGetString( p_access, "recursive" );
246 if( *psz == '\0' || !strncmp( psz, "none" , 4 ) )
248 else if( !strncmp( psz, "collapse", 8 ) )
249 i_mode = MODE_COLLAPSE;
251 i_mode = MODE_EXPAND;
254 p_current->p_input->i_type = ITEM_TYPE_DIRECTORY;
255 p_item_in_category = playlist_ItemToNode( p_playlist, p_current,
258 i_activity = var_GetInteger( p_playlist, "activity" );
259 var_SetInteger( p_playlist, "activity", i_activity +
260 DIRECTORY_ACTIVITY );
262 ReadDir( p_playlist, psz_name, i_mode, p_current, p_item_in_category,
263 p_current_input, (DIR *)p_access->p_sys, NULL );
265 i_activity = var_GetInteger( p_playlist, "activity" );
266 var_SetInteger( p_playlist, "activity", i_activity -
267 DIRECTORY_ACTIVITY );
269 playlist_Signal( p_playlist );
272 vlc_object_release( p_input );
273 vlc_object_release( p_playlist );
275 /* Return fake data forever */
276 p_access->pf_read = ReadNull;
280 /*****************************************************************************
282 *****************************************************************************/
283 static int Control( access_t *p_access, int i_query, va_list args )
292 case ACCESS_CAN_SEEK:
293 case ACCESS_CAN_FASTSEEK:
294 case ACCESS_CAN_PAUSE:
295 case ACCESS_CAN_CONTROL_PACE:
296 pb_bool = (bool*)va_arg( args, bool* );
297 *pb_bool = false; /* FIXME */
302 pi_int = (int*)va_arg( args, int * );
306 case ACCESS_GET_PTS_DELAY:
307 pi_64 = (int64_t*)va_arg( args, int64_t * );
308 *pi_64 = DEFAULT_PTS_DELAY * 1000;
312 case ACCESS_SET_PAUSE_STATE:
313 case ACCESS_GET_TITLE_INFO:
314 case ACCESS_SET_TITLE:
315 case ACCESS_SET_SEEKPOINT:
316 case ACCESS_SET_PRIVATE_ID_STATE:
317 case ACCESS_GET_CONTENT_TYPE:
321 msg_Warn( p_access, "unimplemented query in control" );
327 /*****************************************************************************
329 *****************************************************************************/
330 static int DemuxOpen ( vlc_object_t *p_this )
332 demux_t *p_demux = (demux_t*)p_this;
334 if( strcmp( p_demux->psz_demux, "directory" ) )
337 p_demux->pf_demux = Demux;
338 p_demux->pf_control = DemuxControl;
342 /*****************************************************************************
344 *****************************************************************************/
345 static int Demux( demux_t *p_demux )
350 /*****************************************************************************
352 *****************************************************************************/
353 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
355 return demux_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
359 static int Sort (const char **a, const char **b)
361 return strcoll (*a, *b);
371 /*****************************************************************************
372 * ReadDir: read a directory and add its content to the list
373 *****************************************************************************/
374 static int ReadDir( playlist_t *p_playlist, const char *psz_name,
375 int i_mode, playlist_item_t *p_parent,
376 playlist_item_t *p_parent_category,
377 input_item_t *p_current_input,
378 DIR *handle, stat_list_t *stparent )
380 char **pp_dir_content = NULL;
381 int i_dir_content, i, i_return = VLC_SUCCESS;
382 playlist_item_t *p_node;
384 char **ppsz_extensions = NULL;
385 int i_extensions = 0;
388 struct stat_list_t stself;
390 int fd = dirfd (handle);
392 if ((fd == -1) || fstat (fd, &stself.st))
394 msg_Err (p_playlist, "cannot stat `%s': %m", psz_name);
398 for (stat_list_t *stats = stparent; stats != NULL; stats = stats->parent)
400 if ((stself.st.st_ino == stats->st.st_ino)
401 && (stself.st.st_dev == stats->st.st_dev))
403 msg_Warn (p_playlist,
404 "ignoring infinitely recursive directory `%s'",
410 /* Windows has st_dev (driver letter - 'A'), but it zeroes st_ino,
411 * so that the test above will always incorrectly succeed.
412 * Besides, Windows does not have dirfd(). */
415 stself.parent = stparent;
417 /* Get the first directory entry */
418 i_dir_content = utf8_loaddir (handle, &pp_dir_content, NULL, Sort);
419 if( i_dir_content == -1 )
421 msg_Err (p_playlist, "cannot read `%s': %m", psz_name);
424 else if( i_dir_content <= 0 )
426 /* directory is empty */
427 msg_Dbg( p_playlist, "%s directory is empty", psz_name );
428 free( pp_dir_content );
432 /* Build array with ignores */
433 psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
434 if( psz_ignore && *psz_ignore )
436 char *psz_parser = psz_ignore;
439 for( a = 0; psz_parser[a] != '\0'; a++ )
441 if( psz_parser[a] == ',' ) i_extensions++;
444 ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
446 for( a = 0; a < i_extensions; a++ )
450 while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
451 ptr = strchr( psz_parser, ',');
452 tmp = ( ptr == NULL )
453 ? strdup( psz_parser )
454 : strndup( psz_parser, ptr - psz_parser );
456 ppsz_extensions[a] = tmp;
457 psz_parser = ptr + 1;
462 /* While we still have entries in the directory */
463 for( i = 0; i < i_dir_content; i++ )
465 const char *entry = pp_dir_content[i];
466 int i_size_entry = strlen( psz_name ) +
467 strlen( entry ) + 2 + 7 /* strlen("file://") */;
468 char psz_uri[i_size_entry];
470 sprintf( psz_uri, "%s/%s", psz_name, entry);
472 /* if it starts with '.' then forget it */
475 DIR *subdir = (i_mode != MODE_COLLAPSE)
476 ? OpenDir (VLC_OBJECT (p_playlist), psz_uri) : NULL;
478 if (subdir != NULL) /* Recurse into subdirectory */
480 if( i_mode == MODE_NONE )
482 msg_Dbg( p_playlist, "skipping subdirectory `%s'",
488 msg_Dbg (p_playlist, "creating subdirectory %s", psz_uri);
490 p_node = playlist_NodeCreate( p_playlist, entry,
492 PLAYLIST_NO_REBUILD, NULL );
494 /* If we had the parent in category, the it is now node.
495 * Else, we still don't have */
496 i_return = ReadDir( p_playlist, psz_uri , MODE_EXPAND,
497 p_node, p_parent_category ? p_node : NULL,
498 p_current_input, subdir, &stself );
505 input_item_t *p_input;
507 if( i_extensions > 0 )
509 const char *psz_dot = strrchr (entry, '.' );
510 if( psz_dot++ && *psz_dot )
513 for( a = 0; a < i_extensions; a++ )
515 if( !strcmp( psz_dot, ppsz_extensions[a] ) )
518 if( a < i_extensions )
520 msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
526 memmove (psz_uri + 7, psz_uri, sizeof (psz_uri) - 7);
527 memcpy (psz_uri, "file://", 7);
528 p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist),
529 psz_uri, entry, 0, NULL,
530 -1, ITEM_TYPE_FILE );
533 if( p_current_input )
534 input_ItemCopyOptions( p_current_input, p_input );
535 int i_ret = playlist_BothAddInput( p_playlist, p_input,
537 PLAYLIST_APPEND|PLAYLIST_PREPARSE|
539 PLAYLIST_END, NULL, NULL,
541 vlc_gc_decref( p_input );
542 if( i_ret != VLC_SUCCESS )
549 for( i = 0; i < i_extensions; i++ )
550 free( ppsz_extensions[i] );
551 free( ppsz_extensions );
553 for( i = 0; i < i_dir_content; i++ )
554 free( pp_dir_content[i] );
555 free( pp_dir_content );
561 static DIR *OpenDir (vlc_object_t *obj, const char *path)
563 msg_Dbg (obj, "opening directory `%s'", path);
564 DIR *handle = utf8_opendir (path);
569 msg_Err (obj, "%s: %m", path);
571 msg_Dbg (obj, "skipping non-directory `%s'", path);