/*****************************************************************************
* directory.c: expands a directory (directory: access plug-in)
*****************************************************************************
- * Copyright (C) 2002-2004 VideoLAN
+ * Copyright (C) 2002-2004 the VideoLAN team
* $Id$
*
- * Authors: Derk-Jan Hartman <thedj@users.sourceforge.net>
+ * Authors: Derk-Jan Hartman <hartman at videolan dot org>
*
* 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.
*****************************************************************************/
/*****************************************************************************
# 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
-/*****************************************************************************
- * Constants and structures
- *****************************************************************************/
-#define MODE_EXPAND 0
-#define MODE_COLLAPSE 1
-#define MODE_NONE 2
+#include "charset.h"
/*****************************************************************************
- * Local prototypes
+ * Module descriptor
*****************************************************************************/
-static int Open ( vlc_object_t * );
-static void Close ( vlc_object_t * );
+static int Open ( vlc_object_t * );
+static void Close( vlc_object_t * );
-static ssize_t Read ( input_thread_t *, byte_t *, size_t );
-int ReadDir( playlist_t *p_playlist, char *psz_name , int i_mode, int *pi_pos );
+static int DemuxOpen ( vlc_object_t * );
-/*****************************************************************************
- * Module descriptor
- *****************************************************************************/
-#define RECURSIVE_TEXT N_("Subdirectory behaviour")
+#define RECURSIVE_TEXT N_("Subdirectory behavior")
#define RECURSIVE_LONGTEXT N_( \
"Select whether subdirectories must be expanded.\n" \
"none: subdirectories do not appear in the playlist.\n" \
static char *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_subcategory( SUBCAT_INPUT_ACCESS );
set_description( _("Standard filesystem directory input") );
- set_capability( "access", 55 );
+ set_capability( "access2", 55 );
add_shortcut( "directory" );
add_shortcut( "dir" );
add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
RECURSIVE_LONGTEXT, VLC_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, VLC_FALSE );
set_callbacks( Open, Close );
+
+ add_submodule();
+ set_description( "Directory EOF");
+ set_capability( "demux2", 0 );
+ add_shortcut( "directory" );
+ set_callbacks( DemuxOpen, NULL );
vlc_module_end();
+/*****************************************************************************
+ * Local prototypes, constants, structures
+ *****************************************************************************/
+
+#define MODE_EXPAND 0
+#define MODE_COLLAPSE 1
+#define MODE_NONE 2
+
+static int Read( access_t *, uint8_t *, int );
+static int ReadNull( access_t *, uint8_t *, int );
+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 *, const char *psz_name, int i_mode,
+ playlist_item_t * );
+
/*****************************************************************************
* Open: open the directory
*****************************************************************************/
static int Open( vlc_object_t *p_this )
{
- input_thread_t * p_input = (input_thread_t *)p_this;
+ access_t *p_access = (access_t*)p_this;
+
#ifdef HAVE_SYS_STAT_H
- struct stat stat_info;
-#endif
+ struct stat stat_info;
+ char *psz_path = ToLocale( p_access->psz_path );
- /* Initialize access plug-in structures. */
- if( p_input->i_mtu == 0 )
- {
- /* Improve speed. */
- p_input->i_bufsize = INPUT_DEFAULT_BUFSIZE;
- }
+ if( ( stat( psz_path, &stat_info ) == -1 ) ||
+ !S_ISDIR( stat_info.st_mode ) )
+#elif defined(WIN32)
+ int i_ret;
- p_input->pf_read = Read;
- p_input->pf_set_program = NULL;
- p_input->pf_set_area = NULL;
- p_input->pf_seek = NULL;
+# ifdef UNICODE
+ wchar_t psz_path[MAX_PATH];
+ mbstowcs( psz_path, p_access->psz_path, MAX_PATH );
+ psz_path[MAX_PATH-1] = 0;
+# else
+ char *psz_path = p_access->psz_path;
+# endif /* UNICODE */
+
+ i_ret = GetFileAttributes( psz_path );
+ if( i_ret == -1 || !(i_ret & FILE_ATTRIBUTE_DIRECTORY) )
-#ifdef HAVE_SYS_STAT_H
- if( ( stat( p_input->psz_name, &stat_info ) == -1 ) ||
- !S_ISDIR( stat_info.st_mode ) )
#else
- if( !p_input->psz_access || strcmp(p_input->psz_access, "dir") )
+ if( strcmp( p_access->psz_access, "dir") &&
+ strcmp( p_access->psz_access, "directory") )
#endif
{
+ LocaleFree( psz_path );
return VLC_EGENERIC;
}
+ LocaleFree( psz_path );
+ p_access->pf_read = Read;
+ p_access->pf_block = NULL;
+ p_access->pf_seek = NULL;
+ p_access->pf_control= Control;
+
/* Force a demux */
- p_input->psz_demux = "dummy";
+ p_access->psz_demux = strdup( "directory" );
return VLC_SUCCESS;
}
*****************************************************************************/
static void Close( vlc_object_t * p_this )
{
- input_thread_t * p_input = (input_thread_t *)p_this;
+}
- msg_Info( p_input, "closing `%s/%s://%s'",
- p_input->psz_access, p_input->psz_demux, p_input->psz_name );
+/*****************************************************************************
+ * ReadNull: read the directory
+ *****************************************************************************/
+static int ReadNull( access_t *p_access, uint8_t *p_buffer, int i_len)
+{
+ /* Return fake data */
+ memset( p_buffer, 0, i_len );
+ return i_len;
}
/*****************************************************************************
* Read: read the directory
*****************************************************************************/
-static ssize_t Read( input_thread_t * p_input, byte_t * p_buffer, size_t i_len )
+static int Read( access_t *p_access, uint8_t *p_buffer, int i_len)
{
- char * psz_name;
- char * psz_mode;
- int i_mode, i_pos;
+ char *psz_name = NULL;
+ char *psz;
+ int i_mode, i_pos;
- playlist_t * p_playlist = (playlist_t *) vlc_object_find(
- p_input, VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
+ playlist_item_t *p_item;
+ vlc_bool_t b_play = VLC_FALSE;
+
+ playlist_t *p_playlist =
+ (playlist_t *) vlc_object_find( p_access,
+ VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
if( !p_playlist )
{
- msg_Err( p_input, "can't find playlist" );
+ msg_Err( p_access, "can't find playlist" );
goto end;
}
-
- /* Remove the ending '/' char */
- psz_name = strdup( p_input->psz_name );
- if( psz_name == NULL )
- goto end;
-
- if( (psz_name[strlen(psz_name)-1] == '/') ||
- (psz_name[strlen(psz_name)-1] == '\\') )
+ else
{
- psz_name[strlen(psz_name)-1] = '\0';
+ char *ptr;
+
+ psz_name = ToLocale( p_access->psz_path );
+ ptr = strdup( psz_name );
+ LocaleFree( psz_name );
+ if( ptr == NULL )
+ goto end;
+
+ psz_name = ptr;
+
+ /* Remove the ending '/' char */
+ ptr += strlen( ptr );
+ if( ( ptr > psz_name ) )
+ {
+ switch( *--ptr )
+ {
+ case '/':
+ case '\\':
+ *ptr = '\0';
+ }
+ }
}
-
+
/* Initialize structure */
- psz_mode = config_GetPsz( p_input , "recursive" );
- if( !psz_mode || !strncmp( psz_mode, "none" , 4 ) )
+ psz = var_CreateGetString( p_access, "recursive" );
+ if( *psz == '\0' || !strncmp( psz, "none" , 4 ) )
{
i_mode = MODE_NONE;
}
- else if( !strncmp( psz_mode, "collapse", 8 ) )
+ else if( !strncmp( psz, "collapse", 8 ) )
{
i_mode = MODE_COLLAPSE;
}
{
i_mode = MODE_EXPAND;
}
-
+ free( psz );
+
/* Make sure we are deleted when we are done */
- p_playlist->pp_items[p_playlist->i_index]->b_autodeletion = VLC_TRUE;
/* The playlist position we will use for the add */
i_pos = p_playlist->i_index + 1;
- msg_Dbg( p_input, "opening directory `%s'", psz_name );
- if( ReadDir( p_playlist, psz_name , i_mode, &i_pos ) != VLC_SUCCESS )
+ msg_Dbg( p_access, "opening directory `%s'", p_access->psz_path );
+
+ if( &p_playlist->status.p_item->input ==
+ ((input_thread_t *)p_access->p_parent)->input.p_item )
{
- free( psz_name );
- goto end;
+ 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, p_item ) != VLC_SUCCESS )
+ {
+ }
end:
+
+ /* 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 );
- p_input->b_eof = 1;
+
+ /* Return fake data forever */
+ p_access->pf_read = ReadNull;
+ return ReadNull( p_access, p_buffer, i_len );
+}
+
+/*****************************************************************************
+ * DemuxOpen:
+ *****************************************************************************/
+static int Control( access_t *p_access, int i_query, va_list args )
+{
+ vlc_bool_t *pb_bool;
+ int *pi_int;
+ int64_t *pi_64;
+
+ switch( i_query )
+ {
+ /* */
+ case ACCESS_CAN_SEEK:
+ 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 */
+ break;
+
+ /* */
+ case ACCESS_GET_MTU:
+ pi_int = (int*)va_arg( args, int * );
+ *pi_int = 0;
+ break;
+
+ case ACCESS_GET_PTS_DELAY:
+ pi_64 = (int64_t*)va_arg( args, int64_t * );
+ *pi_64 = DEFAULT_PTS_DELAY * 1000;
+ break;
+
+ /* */
+ case ACCESS_SET_PAUSE_STATE:
+ case ACCESS_GET_TITLE_INFO:
+ case ACCESS_SET_TITLE:
+ case ACCESS_SET_SEEKPOINT:
+ case ACCESS_SET_PRIVATE_ID_STATE:
+ return VLC_EGENERIC;
+
+ default:
+ msg_Warn( p_access, "unimplemented query in control" );
+ return VLC_EGENERIC;
+ }
+ return VLC_SUCCESS;
+}
+
+/*****************************************************************************
+ * DemuxOpen:
+ *****************************************************************************/
+static int DemuxOpen ( vlc_object_t *p_this )
+{
+ demux_t *p_demux = (demux_t*)p_this;
+
+ if( strcmp( p_demux->psz_demux, "directory" ) )
+ return VLC_EGENERIC;
+
+ p_demux->pf_demux = Demux;
+ p_demux->pf_control = DemuxControl;
+ return VLC_SUCCESS;
+}
+
+/*****************************************************************************
+ * Demux: EOF
+ *****************************************************************************/
+static int Demux( demux_t *p_demux )
+{
return 0;
}
-/* Local functions */
+/*****************************************************************************
+ * 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 );
+}
+
+static int Filter( const struct dirent *foo )
+{
+ return VLC_TRUE;
+}
/*****************************************************************************
* ReadDir: read a directory and add its content to the list
*****************************************************************************/
-int ReadDir( playlist_t *p_playlist, char *psz_name , int i_mode, int *pi_position )
+static int ReadDir( playlist_t *p_playlist, const char *psz_name,
+ int i_mode, playlist_item_t *p_parent )
{
- DIR * p_current_dir;
- struct dirent * p_dir_content;
+ struct dirent **pp_dir_content;
+ int i_dir_content, i;
+ playlist_item_t *p_node;
+
+ /* Build array with ignores */
+ char **ppsz_extensions = 0;
+ int i_extensions = 0;
+ char *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 **)malloc( sizeof( char * ) * i_extensions );
- /* Open the dir */
- p_current_dir = opendir( psz_name );
+ for( a = 0; a < i_extensions; a++ )
+ {
+ int b;
+ char *tmp;
- if( p_current_dir == NULL )
+ while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
+ for( b = 0; psz_parser[b] != '\0'; b++ )
+ {
+ if( psz_parser[b] == ',' ) break;
+ }
+ tmp = malloc( b + 1 );
+ strncpy( tmp, psz_parser, b );
+ tmp[b] = 0;
+ ppsz_extensions[a] = tmp;
+ psz_parser += b+1;
+ }
+ }
+
+ /* Change the item to a node */
+ if( p_parent->i_children == -1 )
{
- /* something went bad, get out of here ! */
-# ifdef HAVE_ERRNO_H
- msg_Warn( p_playlist, "cannot open directory `%s' (%s)",
- psz_name, strerror(errno));
-# else
- msg_Warn( p_playlist, "cannot open directory `%s'", psz_name );
-# endif
- return VLC_EGENERIC;
+ playlist_LockItemToNode( p_playlist,p_parent );
}
/* get the first directory entry */
- p_dir_content = readdir( p_current_dir );
+ i_dir_content = scandir( psz_name, &pp_dir_content, Filter, alphasort );
+ if( i_dir_content == -1 )
+ {
+ msg_Warn( p_playlist, "Failed to read directory" );
+ return VLC_EGENERIC;
+ }
+ else if( i_dir_content <= 0 )
+ {
+ /* directory is empty */
+ return VLC_SUCCESS;
+ }
- /* while we still have entries in the directory */
- while( p_dir_content != NULL )
+ /* While we still have entries in the directory */
+ for( i = 0; i < i_dir_content; i++ )
{
+ struct dirent *p_dir_content = pp_dir_content[i];
int i_size_entry = strlen( psz_name ) +
- p_dir_content->d_namlen + 2;
- char *psz_uri = (char *)malloc( sizeof(char)*i_size_entry);
+ strlen( p_dir_content->d_name ) + 2;
+ char *psz_uri = (char *)malloc( sizeof(char) * i_size_entry );
sprintf( psz_uri, "%s/%s", psz_name, p_dir_content->d_name );
{
#if defined( S_ISDIR )
struct stat stat_data;
- stat( psz_uri, &stat_data );
- if( S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
+
+ if( !stat( psz_uri, &stat_data )
+ && 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 )
+ if( ( p_dir_content->d_type & DT_DIR ) && i_mode != MODE_COLLAPSE )
#else
if( 0 )
#endif
{
+#if defined( S_ISLNK )
+/*
+ * FIXME: there is a ToCToU race condition here; but it is rather tricky
+ * impossible to fix while keeping some kind of portable code, and maybe even
+ * in a non-portable way.
+ */
+ if( lstat( psz_uri, &stat_data )
+ || S_ISLNK(stat_data.st_mode) )
+ {
+ msg_Dbg( p_playlist, "Skipping directory symlink %s",
+ psz_uri );
+ free( psz_uri );
+ continue;
+ }
+#endif
if( i_mode == MODE_NONE )
{
msg_Dbg( p_playlist, "Skipping subdirectory %s", psz_uri );
- p_dir_content = readdir( p_current_dir );
+ free( psz_uri );
continue;
}
- else if(i_mode == MODE_EXPAND )
+ else if( i_mode == MODE_EXPAND )
{
+ char *psz_newname, *psz_tmp;
msg_Dbg(p_playlist, "Reading subdirectory %s", psz_uri );
- if( ReadDir( p_playlist, psz_uri , MODE_EXPAND, pi_position )
- != VLC_SUCCESS )
+
+ psz_tmp = FromLocale( p_dir_content->d_name );
+ psz_newname = vlc_fix_readdir_charset(
+ p_playlist, psz_tmp );
+ LocaleFree( psz_tmp );
+
+ 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;
+
+ if( ReadDir( p_playlist, psz_uri , MODE_EXPAND,
+ p_node ) != VLC_SUCCESS )
{
return VLC_EGENERIC;
}
+
+ /* an strdup() just because of Mac OS X */
+ free( psz_newname );
}
}
else
{
- playlist_Add( p_playlist, psz_uri, p_dir_content->d_name,
- PLAYLIST_INSERT, *pi_position );
- (*pi_position)++;
+ playlist_item_t *p_item;
+ char *psz_tmp1, *psz_tmp2, *psz_loc;
+
+ if( i_extensions > 0 )
+ {
+ char *psz_dot = strrchr( p_dir_content->d_name, '.' );
+ if( psz_dot++ && *psz_dot )
+ {
+ 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 );
+ free( psz_uri );
+ continue;
+ }
+ }
+ }
+
+ psz_loc = FromLocale( psz_uri );
+ psz_tmp1 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
+ psz_loc );
+ LocaleFree( psz_loc );
+
+ psz_loc = FromLocale( p_dir_content->d_name );
+ psz_tmp2 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
+ psz_loc );
+ LocaleFree( psz_loc );
+
+ p_item = playlist_ItemNewWithType( VLC_OBJECT(p_playlist),
+ psz_tmp1, psz_tmp2, ITEM_TYPE_VFILE );
+ playlist_NodeAddItem( p_playlist,p_item,
+ p_parent->pp_parents[0]->i_view,
+ p_parent,
+ PLAYLIST_APPEND | PLAYLIST_PREPARSE,
+ PLAYLIST_END );
+
+ playlist_CopyParents( p_parent, p_item );
}
}
free( psz_uri );
- p_dir_content = readdir( p_current_dir );
}
- closedir( p_current_dir );
+
+ for( i = 0; i < i_extensions; i++ )
+ {
+ if( ppsz_extensions[i] )
+ free( ppsz_extensions[i] );
+ }
+ if( ppsz_extensions ) free( ppsz_extensions );
+ if( psz_ignore ) free( psz_ignore );
+
+ for( i = 0; i < i_dir_content; i++ )
+ if( pp_dir_content[i] ) free( pp_dir_content[i] );
+ if( pp_dir_content ) free( pp_dir_content );
return VLC_SUCCESS;
}