/*****************************************************************************
* directory.c: expands a directory (directory: access plug-in)
*****************************************************************************
- * Copyright (C) 2002-2004 VideoLAN
+ * Copyright (C) 2002-2007 the VideoLAN team
* $Id$
*
- * Authors: Derk-Jan Hartman <thedj@users.sourceforge.net>
+ * Authors: Derk-Jan Hartman <hartman at videolan dot org>
+ * RĂ©mi Denis-Courmont
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/*****************************************************************************
* Preamble
*****************************************************************************/
-#include <vlc/vlc.h>
-#include <vlc/input.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <assert.h>
+#include <vlc_common.h>
+#include <vlc_plugin.h>
+#warning playlist code must not be used here.
#include <vlc_playlist.h>
+#include <vlc_input.h>
+#include <vlc_access.h>
+#include <vlc_demux.h>
-#include <stdlib.h>
-#include <string.h>
#ifdef HAVE_SYS_TYPES_H
# include <sys/types.h>
#endif
# include <unistd.h>
#elif defined( WIN32 ) && !defined( UNDER_CE )
# include <io.h>
+#elif defined( UNDER_CE )
+# define strcoll strcmp
#endif
-#if (!defined( WIN32 ) || defined(__MINGW32__))
-/* Mingw has its own version of dirent */
+#ifdef HAVE_DIRENT_H
# include <dirent.h>
#endif
+#include <vlc_charset.h>
+
/*****************************************************************************
* Module descriptor
*****************************************************************************/
"collapse: subdirectories appear but are expanded on first play.\n" \
"expand: all subdirectories are expanded.\n" )
-static char *psz_recursive_list[] = { "none", "collapse", "expand" };
-static char *psz_recursive_list_text[] = { N_("none"), N_("collapse"),
- N_("expand") };
+static const char *const psz_recursive_list[] = { "none", "collapse", "expand" };
+static const char *const psz_recursive_list_text[] = {
+ N_("none"), N_("collapse"), N_("expand") };
+
+#define IGNORE_TEXT N_("Ignored extensions")
+#define IGNORE_LONGTEXT N_( \
+ "Files with these extensions will not be added to playlist when " \
+ "opening a directory.\n" \
+ "This is useful if you add directories that contain playlist files " \
+ "for instance. Use a comma-separated list of extensions." )
vlc_module_begin();
set_category( CAT_INPUT );
- set_shortname( _("Directory" ) );
+ set_shortname( N_("Directory" ) );
set_subcategory( SUBCAT_INPUT_ACCESS );
- set_description( _("Standard filesystem directory input") );
- set_capability( "access2", 55 );
+ set_description( N_("Standard filesystem directory input") );
+ set_capability( "access", 55 );
add_shortcut( "directory" );
add_shortcut( "dir" );
+ add_shortcut( "file" );
add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
- RECURSIVE_LONGTEXT, VLC_FALSE );
+ RECURSIVE_LONGTEXT, false );
change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
+ add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
+ NULL, IGNORE_TEXT, IGNORE_LONGTEXT, false );
set_callbacks( Open, Close );
add_submodule();
set_description( "Directory EOF");
- set_capability( "demux2", 0 );
- add_shortcut( "directory" );
+ set_capability( "demux", 0 );
set_callbacks( DemuxOpen, NULL );
vlc_module_end();
* Local prototypes, constants, structures
*****************************************************************************/
-#define MODE_EXPAND 0
-#define MODE_COLLAPSE 1
-#define MODE_NONE 2
+enum
+{
+ MODE_EXPAND,
+ MODE_COLLAPSE,
+ MODE_NONE
+};
+
+typedef struct stat_list_t stat_list_t;
-static int Read( access_t *, uint8_t *, int );
-static int ReadNull( access_t *, uint8_t *, int );
+static ssize_t Read( access_t *, uint8_t *, size_t );
+static ssize_t ReadNull( access_t *, uint8_t *, size_t );
static int Control( access_t *, int, va_list );
static int Demux( demux_t *p_demux );
static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
-static int ReadDir( playlist_t *, char *psz_name, int i_mode, int *pi_pos,
- playlist_item_t * );
+static int ReadDir( access_t *, playlist_t *, const char *psz_name,
+ int i_mode, playlist_item_t *, input_item_t *,
+ DIR *handle, stat_list_t *stats );
+
+static DIR *OpenDir (vlc_object_t *obj, const char *psz_name);
/*****************************************************************************
* Open: open the directory
{
access_t *p_access = (access_t*)p_this;
-#ifdef HAVE_SYS_STAT_H
- struct stat stat_info;
+ if( !p_access->psz_path )
+ return VLC_EGENERIC;
- if( ( stat( p_access->psz_path, &stat_info ) == -1 ) ||
- !S_ISDIR( stat_info.st_mode ) )
-#else
- if( strcmp( p_access->psz_access, "dir") &&
- strcmp( p_access->psz_access, "directory") )
-#endif
- {
+ struct stat st;
+ if( !stat( p_access->psz_path, &st ) && !S_ISDIR( st.st_mode ) )
return VLC_EGENERIC;
- }
+
+ DIR *handle = OpenDir (p_this, p_access->psz_path);
+ if (handle == NULL)
+ return VLC_EGENERIC;
+
+ p_access->p_sys = (access_sys_t *)handle;
p_access->pf_read = Read;
p_access->pf_block = NULL;
p_access->pf_control= Control;
/* Force a demux */
+ free( p_access->psz_demux );
p_access->psz_demux = strdup( "directory" );
return VLC_SUCCESS;
*****************************************************************************/
static void Close( vlc_object_t * p_this )
{
+ access_t *p_access = (access_t*)p_this;
+ DIR *handle = (DIR *)p_access->p_sys;
+ closedir (handle);
}
/*****************************************************************************
* ReadNull: read the directory
*****************************************************************************/
-static int ReadNull( access_t *p_access, uint8_t *p_buffer, int i_len)
+static ssize_t ReadNull( access_t *p_access, uint8_t *p_buffer, size_t i_len)
{
/* Return fake data */
memset( p_buffer, 0, i_len );
/*****************************************************************************
* Read: read the directory
*****************************************************************************/
-static int Read( access_t *p_access, uint8_t *p_buffer, int i_len)
+static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len)
{
- char *psz_name = NULL;
- char *psz;
- int i_mode, i_pos;
+ char *psz;
+ int i_mode;
+ char *psz_name = strdup (p_access->psz_path);
+
+ if( psz_name == NULL )
+ return VLC_ENOMEM;
- playlist_item_t *p_item;
- vlc_bool_t b_play = VLC_FALSE;
+ playlist_t *p_playlist = pl_Yield( p_access );
+ input_thread_t *p_input = (input_thread_t*)vlc_object_find( p_access, VLC_OBJECT_INPUT, FIND_PARENT );
- playlist_t *p_playlist =
- (playlist_t *) vlc_object_find( p_access,
- VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
+ playlist_item_t *p_item_in_category;
+ input_item_t *p_current_input;
+ playlist_item_t *p_current;
- if( !p_playlist )
+ if( !p_input )
{
- msg_Err( p_access, "can't find playlist" );
- goto end;
+ msg_Err( p_access, "unable to find input (internal error)" );
+ pl_Release( p_access );
+ return VLC_ENOOBJ;
}
- /* Remove the ending '/' char */
- psz_name = strdup( p_access->psz_path );
- if( psz_name == NULL )
- goto end;
+ p_current_input = input_GetItem( p_input );
+ p_current = playlist_ItemGetByInput( p_playlist, p_current_input, pl_Unlocked );
- if( (psz_name[strlen(psz_name)-1] == '/') ||
- (psz_name[strlen(psz_name)-1] == '\\') )
+ if( !p_current )
{
- psz_name[strlen(psz_name)-1] = '\0';
+ msg_Err( p_access, "unable to find item in playlist" );
+ vlc_object_release( p_input );
+ pl_Release( p_access );
+ return VLC_ENOOBJ;
}
- /* Initialize structure */
+ /* Remove the ending '/' char */
+ if( psz_name[0] )
+ {
+ char *ptr = psz_name + strlen (psz_name);
+ switch (*--ptr)
+ {
+ case '/':
+ case '\\':
+ *ptr = '\0';
+ }
+ }
+
+ /* Handle mode */
psz = var_CreateGetString( p_access, "recursive" );
if( *psz == '\0' || !strncmp( psz, "none" , 4 ) )
- {
i_mode = MODE_NONE;
- }
else if( !strncmp( psz, "collapse", 8 ) )
- {
i_mode = MODE_COLLAPSE;
- }
else
- {
i_mode = MODE_EXPAND;
- }
free( psz );
- /* Make sure we are deleted when we are done */
- /* The playlist position we will use for the add */
- i_pos = p_playlist->i_index + 1;
+ p_current->p_input->i_type = ITEM_TYPE_DIRECTORY;
+ p_item_in_category = playlist_ItemToNode( p_playlist, p_current,
+ pl_Unlocked );
+ assert( p_item_in_category );
- msg_Dbg( p_access, "opening directory `%s'", psz_name );
+ ReadDir( p_access, p_playlist, psz_name, i_mode,
+ p_item_in_category,
+ p_current_input, (DIR *)p_access->p_sys, NULL );
- if( &p_playlist->status.p_item->input ==
- ((input_thread_t *)p_access->p_parent)->input.p_item )
- {
- p_item = p_playlist->status.p_item;
- b_play = VLC_TRUE;
- msg_Dbg( p_access, "starting directory playback");
- }
- else
- {
- input_item_t *p_current = ( (input_thread_t*)p_access->p_parent)->
- input.p_item;
- p_item = playlist_LockItemGetByInput( p_playlist, p_current );
- msg_Dbg( p_access, "not starting directory playback");
- if( !p_item )
- {
- msg_Dbg( p_playlist, "unable to find item in playlist");
- return -1;
- }
- b_play = VLC_FALSE;
- }
- p_item->input.i_type = ITEM_TYPE_DIRECTORY;
- if( ReadDir( p_playlist, psz_name , i_mode, &i_pos,
- p_item ) != VLC_SUCCESS )
- {
- }
-end:
+ playlist_Signal( p_playlist );
- /* Begin to read the directory */
- if( b_play )
- {
- playlist_Control( p_playlist, PLAYLIST_VIEWPLAY,
- p_playlist->status.i_view,
- p_playlist->status.p_item, NULL );
- }
- if( psz_name ) free( psz_name );
- vlc_object_release( p_playlist );
+ free( psz_name );
+ vlc_object_release( p_input );
+ pl_Release( p_access );
/* Return fake data forever */
p_access->pf_read = ReadNull;
- return ReadNull( p_access, p_buffer, i_len );
+ return -1;
}
/*****************************************************************************
- * DemuxOpen:
+ * Control:
*****************************************************************************/
static int Control( access_t *p_access, int i_query, va_list args )
{
- vlc_bool_t *pb_bool;
+ bool *pb_bool;
int *pi_int;
int64_t *pi_64;
case ACCESS_CAN_FASTSEEK:
case ACCESS_CAN_PAUSE:
case ACCESS_CAN_CONTROL_PACE:
- pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
- *pb_bool = VLC_FALSE; /* FIXME */
+ pb_bool = (bool*)va_arg( args, bool* );
+ *pb_bool = false; /* FIXME */
break;
/* */
case ACCESS_SET_TITLE:
case ACCESS_SET_SEEKPOINT:
case ACCESS_SET_PRIVATE_ID_STATE:
+ case ACCESS_GET_CONTENT_TYPE:
return VLC_EGENERIC;
default:
{
return 0;
}
+
/*****************************************************************************
* DemuxControl:
*****************************************************************************/
static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
{
- return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
+ return demux_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
}
-#if defined(SYS_BEOS) || defined(WIN32)
-/* BeOS doesn't have scandir/alphasort/versionsort */
-static int alphasort( const struct dirent **a, const struct dirent **b )
+
+static int Sort (const char **a, const char **b)
{
- return strcoll( (*a)->d_name, (*b)->d_name );
+ return strcoll (*a, *b);
}
-static int scandir( const char *name, struct dirent ***namelist,
- int (*filter) ( const struct dirent * ),
- int (*compar) ( const struct dirent **,
- const struct dirent ** ) )
+struct stat_list_t
{
- DIR * p_dir;
- struct dirent * p_content;
- struct dirent ** pp_list;
- int ret, size;
-
- if( !namelist || !( p_dir = opendir( name ) ) ) return -1;
-
- ret = 0;
- pp_list = NULL;
- while( ( p_content = readdir( p_dir ) ) )
- {
- if( filter && !filter( p_content ) )
- {
- continue;
- }
- pp_list = realloc( pp_list, ( ret + 1 ) * sizeof( struct dirent * ) );
- size = sizeof( struct dirent ) + strlen( p_content->d_name ) + 1;
- pp_list[ret] = malloc( size );
- memcpy( pp_list[ret], p_content, size );
- ret++;
- }
+ stat_list_t *parent;
+ struct stat st;
+};
- closedir( p_dir );
- if( compar )
- {
- qsort( pp_list, ret, sizeof( struct dirent * ),
- (int (*)(const void *, const void *)) compar );
- }
-
- *namelist = pp_list;
- return ret;
-}
-#endif
-
-static int Filter( const struct dirent *foo )
-{
- return VLC_TRUE;
-}
/*****************************************************************************
* ReadDir: read a directory and add its content to the list
*****************************************************************************/
-static int ReadDir( playlist_t *p_playlist,
- char *psz_name , int i_mode, int *pi_position,
- playlist_item_t *p_parent )
+static int ReadDir( access_t *p_access, playlist_t *p_playlist,
+ const char *psz_name,
+ int i_mode,
+ playlist_item_t *p_parent_category,
+ input_item_t *p_current_input,
+ DIR *handle, stat_list_t *stparent )
{
- struct dirent *p_dir_content;
- struct dirent **pp_dir_content;
- int i_dir_content, i = 0;
+ char **pp_dir_content = NULL;
+ int i_dir_content, i, i_return = VLC_SUCCESS;
playlist_item_t *p_node;
- /* Change the item to a node */
- if( p_parent->i_children == -1 )
+ if( !vlc_object_alive( p_access ) )
+ return VLC_EGENERIC;
+
+ if( !vlc_object_alive( p_playlist ) )
+ return VLC_EGENERIC;
+
+ char **ppsz_extensions = NULL;
+ int i_extensions = 0;
+ char *psz_ignore;
+
+ struct stat_list_t stself;
+#ifndef WIN32
+ int fd = dirfd (handle);
+
+ if ((fd == -1) || fstat (fd, &stself.st))
{
- playlist_LockItemToNode( p_playlist,p_parent );
+ msg_Err (p_playlist, "cannot stat `%s': %m", psz_name);
+ return VLC_EGENERIC;
}
- /* get the first directory entry */
- i_dir_content = scandir( psz_name, &pp_dir_content, Filter, alphasort );
+ for (stat_list_t *stats = stparent; stats != NULL; stats = stats->parent)
+ {
+ if ((stself.st.st_ino == stats->st.st_ino)
+ && (stself.st.st_dev == stats->st.st_dev))
+ {
+ msg_Warn (p_playlist,
+ "ignoring infinitely recursive directory `%s'",
+ psz_name);
+ return VLC_SUCCESS;
+ }
+ }
+#else
+ /* Windows has st_dev (driver letter - 'A'), but it zeroes st_ino,
+ * so that the test above will always incorrectly succeed.
+ * Besides, Windows does not have dirfd(). */
+#endif
+
+ stself.parent = stparent;
+
+ /* Get the first directory entry */
+ i_dir_content = utf8_loaddir (handle, &pp_dir_content, NULL, Sort);
if( i_dir_content == -1 )
{
- msg_Warn( p_playlist, "Failed to read directory" );
+ msg_Err (p_playlist, "cannot read `%s': %m", psz_name);
return VLC_EGENERIC;
}
- p_dir_content = pp_dir_content[0];
+ else if( i_dir_content <= 0 )
+ {
+ /* directory is empty */
+ msg_Dbg( p_playlist, "%s directory is empty", psz_name );
+ free( pp_dir_content );
+ return VLC_SUCCESS;
+ }
- /* while we still have entries in the directory */
- while( i < i_dir_content )
+ /* Build array with ignores */
+ psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
+ if( psz_ignore && *psz_ignore )
{
+ char *psz_parser = psz_ignore;
+ int a;
+
+ for( a = 0; psz_parser[a] != '\0'; a++ )
+ {
+ if( psz_parser[a] == ',' ) i_extensions++;
+ }
+
+ ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
+
+ for( a = 0; a < i_extensions; a++ )
+ {
+ char *tmp, *ptr;
+
+ while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
+ ptr = strchr( psz_parser, ',');
+ tmp = ( ptr == NULL )
+ ? strdup( psz_parser )
+ : strndup( psz_parser, ptr - psz_parser );
+
+ ppsz_extensions[a] = tmp;
+ psz_parser = ptr + 1;
+ }
+ }
+ free( psz_ignore );
+
+ /* While we still have entries in the directory */
+ for( i = 0; i < i_dir_content; i++ )
+ {
+ const char *entry = pp_dir_content[i];
int i_size_entry = strlen( psz_name ) +
- strlen( p_dir_content->d_name ) + 2;
- char *psz_uri = (char *)malloc( sizeof(char)*i_size_entry);
+ strlen( entry ) + 2 + 7 /* strlen("file://") */;
+ char psz_uri[i_size_entry];
- sprintf( psz_uri, "%s/%s", psz_name, p_dir_content->d_name );
+ sprintf( psz_uri, "%s/%s", psz_name, entry);
/* if it starts with '.' then forget it */
- if( p_dir_content->d_name[0] != '.' )
+ if (entry[0] != '.')
{
-#if defined( S_ISDIR )
- struct stat stat_data;
- stat( psz_uri, &stat_data );
- if( S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
-#elif defined( DT_DIR )
- if( ( p_dir_content->d_type & DT_DIR ) && i_mode != MODE_COLLAPSE )
-#else
- if( 0 )
-#endif
+ DIR *subdir = (i_mode != MODE_COLLAPSE)
+ ? OpenDir (VLC_OBJECT (p_playlist), psz_uri) : NULL;
+
+ if (subdir != NULL) /* Recurse into subdirectory */
{
if( i_mode == MODE_NONE )
{
- msg_Dbg( p_playlist, "Skipping subdirectory %s", psz_uri );
- i++;
- p_dir_content = pp_dir_content[i];
+ msg_Dbg( p_playlist, "skipping subdirectory `%s'",
+ psz_uri );
+ closedir (subdir);
continue;
}
- else if(i_mode == MODE_EXPAND )
- {
- char *psz_newname;
- msg_Dbg(p_playlist, "Reading subdirectory %s", psz_uri );
-
- if( !strncmp( psz_uri, psz_name, strlen( psz_name ) ) )
- {
- char *psz_subdir = psz_uri;
- /* Skip the parent path + the separator */
- psz_subdir += strlen( psz_name ) + 1;
- psz_newname = strdup( psz_subdir );
- }
- else
- {
- psz_newname = strdup( psz_uri );
- }
- p_node = playlist_NodeCreate( p_playlist,
- p_parent->pp_parents[0]->i_view,
- psz_newname, p_parent );
- playlist_CopyParents( p_parent, p_node );
-
- p_node->input.i_type = ITEM_TYPE_DIRECTORY;
+ msg_Dbg (p_playlist, "creating subdirectory %s", psz_uri);
+
+ PL_LOCK;
+ p_node = playlist_NodeCreate( p_playlist, entry,
+ p_parent_category,
+ PLAYLIST_NO_REBUILD, NULL );
+ PL_UNLOCK;
+ assert( p_node );
+ /* If we had the parent in category, the it is now node.
+ * Else, we still don't have */
+ i_return = ReadDir( p_access, p_playlist, psz_uri , MODE_EXPAND,
+ p_parent_category ? p_node : NULL,
+ p_current_input, subdir, &stself );
+ closedir (subdir);
+ if (i_return)
+ break; // error :-(
+ }
+ else
+ {
+ input_item_t *p_input;
- if( ReadDir( p_playlist, psz_uri , MODE_EXPAND,
- pi_position, p_node ) != VLC_SUCCESS )
+ if( i_extensions > 0 )
+ {
+ const char *psz_dot = strrchr (entry, '.' );
+ if( psz_dot++ && *psz_dot )
{
- return VLC_EGENERIC;
+ int a;
+ for( a = 0; a < i_extensions; a++ )
+ {
+ if( !strcmp( psz_dot, ppsz_extensions[a] ) )
+ break;
+ }
+ if( a < i_extensions )
+ {
+ msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
+ continue;
+ }
}
+ }
- free( psz_newname );
+ memmove (psz_uri + 7, psz_uri, sizeof (psz_uri) - 7);
+ memcpy (psz_uri, "file://", 7);
+ p_input = input_ItemNewWithType( p_playlist,
+ psz_uri, entry, 0, NULL,
+ -1, ITEM_TYPE_FILE );
+ if (p_input != NULL)
+ {
+ if( p_current_input )
+ input_ItemCopyOptions( p_current_input, p_input );
+ assert( p_parent_category );
+ int i_ret = playlist_BothAddInput( p_playlist, p_input,
+ p_parent_category,
+ PLAYLIST_APPEND|PLAYLIST_PREPARSE|
+ PLAYLIST_NO_REBUILD,
+ PLAYLIST_END, NULL, NULL,
+ pl_Unlocked );
+ vlc_gc_decref( p_input );
+ if( i_ret != VLC_SUCCESS )
+ return VLC_EGENERIC;
}
}
- else
- {
- playlist_item_t *p_item = playlist_ItemNewWithType(
- p_playlist,
- psz_uri,
- p_dir_content->d_name,
- ITEM_TYPE_FILE );
- playlist_NodeAddItem( p_playlist,p_item,
- p_parent->pp_parents[0]->i_view,
- p_parent,
- PLAYLIST_APPEND, PLAYLIST_END );
-
- playlist_CopyParents( p_parent, p_item );
- }
}
- free( psz_uri );
- i++;
- p_dir_content = pp_dir_content[i];
}
+
+ for( i = 0; i < i_extensions; i++ )
+ free( ppsz_extensions[i] );
+ free( ppsz_extensions );
+
+ for( i = 0; i < i_dir_content; i++ )
+ free( pp_dir_content[i] );
free( pp_dir_content );
- return VLC_SUCCESS;
+
+ return i_return;
+}
+
+
+static DIR *OpenDir (vlc_object_t *obj, const char *path)
+{
+ msg_Dbg (obj, "opening directory `%s'", path);
+ DIR *handle = utf8_opendir (path);
+ if (handle == NULL)
+ {
+ int err = errno;
+ if (err != ENOTDIR)
+ msg_Err (obj, "%s: %m", path);
+ else
+ msg_Dbg (obj, "skipping non-directory `%s'", path);
+ errno = err;
+
+ return NULL;
+ }
+ return handle;
}