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 #warning playlist code must not be used here.
36 #include <vlc_playlist.h>
37 #include <vlc_input.h>
38 #include <vlc_access.h>
39 #include <vlc_demux.h>
41 #ifdef HAVE_SYS_TYPES_H
42 # include <sys/types.h>
44 #ifdef HAVE_SYS_STAT_H
45 # include <sys/stat.h>
56 #elif defined( WIN32 ) && !defined( UNDER_CE )
58 #elif defined( UNDER_CE )
59 # define strcoll strcmp
66 #include <vlc_charset.h>
68 /*****************************************************************************
70 *****************************************************************************/
71 static int Open ( vlc_object_t * );
72 static void Close( vlc_object_t * );
74 static int DemuxOpen ( vlc_object_t * );
76 #define RECURSIVE_TEXT N_("Subdirectory behavior")
77 #define RECURSIVE_LONGTEXT N_( \
78 "Select whether subdirectories must be expanded.\n" \
79 "none: subdirectories do not appear in the playlist.\n" \
80 "collapse: subdirectories appear but are expanded on first play.\n" \
81 "expand: all subdirectories are expanded.\n" )
83 static const char *const psz_recursive_list[] = { "none", "collapse", "expand" };
84 static const char *const psz_recursive_list_text[] = {
85 N_("none"), N_("collapse"), N_("expand") };
87 #define IGNORE_TEXT N_("Ignored extensions")
88 #define IGNORE_LONGTEXT N_( \
89 "Files with these extensions will not be added to playlist when " \
90 "opening a directory.\n" \
91 "This is useful if you add directories that contain playlist files " \
92 "for instance. Use a comma-separated list of extensions." )
95 set_category( CAT_INPUT );
96 set_shortname( N_("Directory" ) );
97 set_subcategory( SUBCAT_INPUT_ACCESS );
98 set_description( N_("Standard filesystem directory input") );
99 set_capability( "access", 55 );
100 add_shortcut( "directory" );
101 add_shortcut( "dir" );
102 add_shortcut( "file" );
103 add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
104 RECURSIVE_LONGTEXT, false );
105 change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
106 add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
107 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, false );
108 set_callbacks( Open, Close );
111 set_description( "Directory EOF");
112 set_capability( "demux", 0 );
113 set_callbacks( DemuxOpen, NULL );
117 /*****************************************************************************
118 * Local prototypes, constants, structures
119 *****************************************************************************/
128 typedef struct stat_list_t stat_list_t;
130 static ssize_t Read( access_t *, uint8_t *, size_t );
131 static ssize_t ReadNull( access_t *, uint8_t *, size_t );
132 static int Control( access_t *, int, va_list );
134 static int Demux( demux_t *p_demux );
135 static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
138 static int ReadDir( playlist_t *, const char *psz_name, int i_mode,
139 playlist_item_t *, playlist_item_t *, input_item_t *,
140 DIR *handle, stat_list_t *stats );
142 static DIR *OpenDir (vlc_object_t *obj, const char *psz_name);
144 /*****************************************************************************
145 * Open: open the directory
146 *****************************************************************************/
147 static int Open( vlc_object_t *p_this )
149 access_t *p_access = (access_t*)p_this;
151 if( !p_access->psz_path )
155 if( !stat( p_access->psz_path, &st ) && !S_ISDIR( st.st_mode ) )
158 DIR *handle = OpenDir (p_this, p_access->psz_path);
162 p_access->p_sys = (access_sys_t *)handle;
164 p_access->pf_read = Read;
165 p_access->pf_block = NULL;
166 p_access->pf_seek = NULL;
167 p_access->pf_control= Control;
170 free( p_access->psz_demux );
171 p_access->psz_demux = strdup( "directory" );
176 /*****************************************************************************
177 * Close: close the target
178 *****************************************************************************/
179 static void Close( vlc_object_t * p_this )
181 access_t *p_access = (access_t*)p_this;
182 DIR *handle = (DIR *)p_access->p_sys;
186 /*****************************************************************************
187 * ReadNull: read the directory
188 *****************************************************************************/
189 static ssize_t ReadNull( access_t *p_access, uint8_t *p_buffer, size_t i_len)
191 /* Return fake data */
192 memset( p_buffer, 0, i_len );
196 /*****************************************************************************
197 * Read: read the directory
198 *****************************************************************************/
199 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len)
203 char *psz_name = strdup (p_access->psz_path);
205 if( psz_name == NULL )
208 playlist_t *p_playlist = pl_Yield( p_access );
209 input_thread_t *p_input = (input_thread_t*)vlc_object_find( p_access, VLC_OBJECT_INPUT, FIND_PARENT );
211 playlist_item_t *p_item_in_category;
212 input_item_t *p_current_input;
213 playlist_item_t *p_current;
217 msg_Err( p_access, "unable to find input (internal error)" );
218 vlc_object_release( p_playlist );
222 p_current_input = input_GetItem( p_input );
223 p_current = playlist_ItemGetByInput( p_playlist, p_current_input, false );
227 msg_Err( p_access, "unable to find item in playlist" );
228 vlc_object_release( p_input );
229 vlc_object_release( p_playlist );
233 /* Remove the ending '/' char */
236 char *ptr = psz_name + strlen (psz_name);
246 psz = var_CreateGetString( p_access, "recursive" );
247 if( *psz == '\0' || !strncmp( psz, "none" , 4 ) )
249 else if( !strncmp( psz, "collapse", 8 ) )
250 i_mode = MODE_COLLAPSE;
252 i_mode = MODE_EXPAND;
255 p_current->p_input->i_type = ITEM_TYPE_DIRECTORY;
256 p_item_in_category = playlist_ItemToNode( p_playlist, p_current,
259 ReadDir( p_playlist, psz_name, i_mode, p_current, p_item_in_category,
260 p_current_input, (DIR *)p_access->p_sys, NULL );
262 playlist_Signal( p_playlist );
265 vlc_object_release( p_input );
266 vlc_object_release( p_playlist );
268 /* Return fake data forever */
269 p_access->pf_read = ReadNull;
273 /*****************************************************************************
275 *****************************************************************************/
276 static int Control( access_t *p_access, int i_query, va_list args )
285 case ACCESS_CAN_SEEK:
286 case ACCESS_CAN_FASTSEEK:
287 case ACCESS_CAN_PAUSE:
288 case ACCESS_CAN_CONTROL_PACE:
289 pb_bool = (bool*)va_arg( args, bool* );
290 *pb_bool = false; /* FIXME */
295 pi_int = (int*)va_arg( args, int * );
299 case ACCESS_GET_PTS_DELAY:
300 pi_64 = (int64_t*)va_arg( args, int64_t * );
301 *pi_64 = DEFAULT_PTS_DELAY * 1000;
305 case ACCESS_SET_PAUSE_STATE:
306 case ACCESS_GET_TITLE_INFO:
307 case ACCESS_SET_TITLE:
308 case ACCESS_SET_SEEKPOINT:
309 case ACCESS_SET_PRIVATE_ID_STATE:
310 case ACCESS_GET_CONTENT_TYPE:
314 msg_Warn( p_access, "unimplemented query in control" );
320 /*****************************************************************************
322 *****************************************************************************/
323 static int DemuxOpen ( vlc_object_t *p_this )
325 demux_t *p_demux = (demux_t*)p_this;
327 if( strcmp( p_demux->psz_demux, "directory" ) )
330 p_demux->pf_demux = Demux;
331 p_demux->pf_control = DemuxControl;
335 /*****************************************************************************
337 *****************************************************************************/
338 static int Demux( demux_t *p_demux )
343 /*****************************************************************************
345 *****************************************************************************/
346 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
348 return demux_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
352 static int Sort (const char **a, const char **b)
354 return strcoll (*a, *b);
364 /*****************************************************************************
365 * ReadDir: read a directory and add its content to the list
366 *****************************************************************************/
367 static int ReadDir( playlist_t *p_playlist, const char *psz_name,
368 int i_mode, playlist_item_t *p_parent,
369 playlist_item_t *p_parent_category,
370 input_item_t *p_current_input,
371 DIR *handle, stat_list_t *stparent )
373 char **pp_dir_content = NULL;
374 int i_dir_content, i, i_return = VLC_SUCCESS;
375 playlist_item_t *p_node;
377 char **ppsz_extensions = NULL;
378 int i_extensions = 0;
381 struct stat_list_t stself;
383 int fd = dirfd (handle);
385 if ((fd == -1) || fstat (fd, &stself.st))
387 msg_Err (p_playlist, "cannot stat `%s': %m", psz_name);
391 for (stat_list_t *stats = stparent; stats != NULL; stats = stats->parent)
393 if ((stself.st.st_ino == stats->st.st_ino)
394 && (stself.st.st_dev == stats->st.st_dev))
396 msg_Warn (p_playlist,
397 "ignoring infinitely recursive directory `%s'",
403 /* Windows has st_dev (driver letter - 'A'), but it zeroes st_ino,
404 * so that the test above will always incorrectly succeed.
405 * Besides, Windows does not have dirfd(). */
408 stself.parent = stparent;
410 /* Get the first directory entry */
411 i_dir_content = utf8_loaddir (handle, &pp_dir_content, NULL, Sort);
412 if( i_dir_content == -1 )
414 msg_Err (p_playlist, "cannot read `%s': %m", psz_name);
417 else if( i_dir_content <= 0 )
419 /* directory is empty */
420 msg_Dbg( p_playlist, "%s directory is empty", psz_name );
421 free( pp_dir_content );
425 /* Build array with ignores */
426 psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
427 if( psz_ignore && *psz_ignore )
429 char *psz_parser = psz_ignore;
432 for( a = 0; psz_parser[a] != '\0'; a++ )
434 if( psz_parser[a] == ',' ) i_extensions++;
437 ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
439 for( a = 0; a < i_extensions; a++ )
443 while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
444 ptr = strchr( psz_parser, ',');
445 tmp = ( ptr == NULL )
446 ? strdup( psz_parser )
447 : strndup( psz_parser, ptr - psz_parser );
449 ppsz_extensions[a] = tmp;
450 psz_parser = ptr + 1;
455 /* While we still have entries in the directory */
456 for( i = 0; i < i_dir_content; i++ )
458 const char *entry = pp_dir_content[i];
459 int i_size_entry = strlen( psz_name ) +
460 strlen( entry ) + 2 + 7 /* strlen("file://") */;
461 char psz_uri[i_size_entry];
463 sprintf( psz_uri, "%s/%s", psz_name, entry);
465 /* if it starts with '.' then forget it */
468 DIR *subdir = (i_mode != MODE_COLLAPSE)
469 ? OpenDir (VLC_OBJECT (p_playlist), psz_uri) : NULL;
471 if (subdir != NULL) /* Recurse into subdirectory */
473 if( i_mode == MODE_NONE )
475 msg_Dbg( p_playlist, "skipping subdirectory `%s'",
481 msg_Dbg (p_playlist, "creating subdirectory %s", psz_uri);
483 p_node = playlist_NodeCreate( p_playlist, entry,
485 PLAYLIST_NO_REBUILD, NULL );
487 /* If we had the parent in category, the it is now node.
488 * Else, we still don't have */
489 i_return = ReadDir( p_playlist, psz_uri , MODE_EXPAND,
490 p_node, p_parent_category ? p_node : NULL,
491 p_current_input, subdir, &stself );
498 input_item_t *p_input;
500 if( i_extensions > 0 )
502 const char *psz_dot = strrchr (entry, '.' );
503 if( psz_dot++ && *psz_dot )
506 for( a = 0; a < i_extensions; a++ )
508 if( !strcmp( psz_dot, ppsz_extensions[a] ) )
511 if( a < i_extensions )
513 msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
519 memmove (psz_uri + 7, psz_uri, sizeof (psz_uri) - 7);
520 memcpy (psz_uri, "file://", 7);
521 p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist),
522 psz_uri, entry, 0, NULL,
523 -1, ITEM_TYPE_FILE );
526 if( p_current_input )
527 input_ItemCopyOptions( p_current_input, p_input );
528 int i_ret = playlist_BothAddInput( p_playlist, p_input,
530 PLAYLIST_APPEND|PLAYLIST_PREPARSE|
532 PLAYLIST_END, NULL, NULL,
534 vlc_gc_decref( p_input );
535 if( i_ret != VLC_SUCCESS )
542 for( i = 0; i < i_extensions; i++ )
543 free( ppsz_extensions[i] );
544 free( ppsz_extensions );
546 for( i = 0; i < i_dir_content; i++ )
547 free( pp_dir_content[i] );
548 free( pp_dir_content );
554 static DIR *OpenDir (vlc_object_t *obj, const char *path)
556 msg_Dbg (obj, "opening directory `%s'", path);
557 DIR *handle = utf8_opendir (path);
562 msg_Err (obj, "%s: %m", path);
564 msg_Dbg (obj, "skipping non-directory `%s'", path);