[vlc-devel] [PATCH 5/6] Make access/directory.c a pf_readdir browsing module
Rémi Denis-Courmont
remi at remlab.net
Sat Jun 21 11:11:49 CEST 2014
Laurent established the convention of keeping the existing style of existing
files. I don't mind removing the extra whitespace between function identifier
and parenthesis, but the rest is pretty much standard.
Le vendredi 20 juin 2014, 19:53:07 Julien 'Lta' BALLET a écrit :
> From: Julien 'Lta' BALLET <contact at lta.io>
>
> ---
> modules/access/directory.c | 539
> +++++++++++++++++++++------------------------ modules/access/fs.h |
> 5 +-
> 2 files changed, 256 insertions(+), 288 deletions(-)
>
> diff --git a/modules/access/directory.c b/modules/access/directory.c
> index 3d72dc0..df28bfa 100644
> --- a/modules/access/directory.c
> +++ b/modules/access/directory.c
> @@ -1,11 +1,12 @@
> /**************************************************************************
> *** - * directory.c: expands a directory (directory: access plug-in)
> + * directory.c: expands a directory (directory: access_browser plug-in)
>
> ***************************************************************************
> ** * Copyright (C) 2002-2008 VLC authors and VideoLAN
> * $Id$
> *
> * Authors: Derk-Jan Hartman <hartman at videolan dot org>
> * Rémi Denis-Courmont
> + * Julien 'Lta' BALLET <contact # lta.io>
> *
> * This program is free software; you can redistribute it and/or modify it
> * under the terms of the GNU Lesser General Public License as published by
> @@ -33,6 +34,7 @@
> #include <vlc_common.h>
> #include "fs.h"
> #include <vlc_access.h>
> +#include <vlc_input_item.h>
>
> #include <sys/types.h>
> #include <sys/stat.h>
> @@ -47,6 +49,13 @@
>
> enum
> {
> + ENTRY_DIR = 0,
> + ENTRY_ENOTDIR = -1,
> + ENTRY_EACCESS = -2,
> +};
> +
> +enum
> +{
> MODE_NONE,
> MODE_COLLAPSE,
> MODE_EXPAND,
> @@ -73,9 +82,6 @@ struct access_sys_t
> directory_t *current;
> char *ignored_exts;
> char mode;
> - bool header;
> - int i_item_count;
> - char *xspf_ext;
> int (*compar)(const char **a, const char **b);
> };
>
> @@ -99,6 +105,159 @@ static int version (const char **a, const char **b)
> return strverscmp (*a, *b);
> }
>
> + /**
> ++ * Does the provided URI/path/stuff has one of the extension provided ?
have
> ++ *
> ++ * \param psz_exts A comma separated list of extension without dot, or
> only ++
> * one ext (ex: "avi,mkv,webm")
comma-separated list of extensions (without leading dot)
> ++ * \param psz_uri The uri/path to check (ex: "file:///home/foo/bar.avi")
URI but you are better off allowing only paths because
> ++ *
> ++ * \return true if the uri/path has one of the provided extension
> ++ * false otherwise.
> ++ */
> +static bool has_ext( const char *psz_exts, const char *psz_uri )
> +{
> + if( psz_exts == NULL )
> + return false;
> +
> + const char *ext = strrchr( psz_uri, '.' );
> + if( ext == NULL )
> + return false;
> +
> + size_t extlen = strlen (++ext);
> +
> + for( const char *type = psz_exts, *end; type[0]; type = end + 1 )
> + {
> + end = strchr( type, ',' );
> + if ( end == NULL )
> + end = type + strlen( type );
> +
> + if ( type + extlen == end && !strncasecmp ( ext, type, extlen ) )
> + return true;
> +
> + if (*end == '\0')
> + break;
> + }
> +
> + return false;
> +}
> +
> +
> +#ifdef HAVE_OPENAT
> +/* Detect directories that recurse into themselves. */
> +static bool has_inode_loop( const directory_t *dir, dev_t dev, ino_t inode
> ) +{
> + while (dir != NULL)
> + {
> + if ((dir->device == dev) && (dir->inode == inode))
> + return true;
> + dir = dir->parent;
> + }
> + return false;
> +}
> +#endif
What was the problem? Reordering code for no reasons make it really hard to
review.
> +
> +/* success -> returns ENTRY_DIR and the handle parameter is set to the
> handle, + * error -> return ENTRY_ENOTDIR or ENTRY_EACCESS */
> +static int directory_open( directory_t *p_dir, char *psz_entry, DIR
> **handle ) +{
> + *handle = NULL;
> +
> +#ifdef HAVE_OPENAT
> + int fd = vlc_openat( dirfd( p_dir->handle ), psz_entry,
> + O_RDONLY | O_DIRECTORY );
> +
> + if (fd == -1)
> + {
> + if (errno == ENOTDIR)
> + return ENTRY_ENOTDIR;
> + else
> + return ENTRY_EACCESS;
> + }
> +
> + struct stat st;
> + if( fstat( fd, &st )
> + || has_inode_loop( p_dir, st.st_dev, st.st_ino )
> + || ( *handle = fdopendir( fd ) ) == NULL )
> + {
> + close (fd);
> + return ENTRY_EACCESS;
> + }
> +#else
> + char *path;
> + if( asprintf( &path, "%s/%s", current->path, entry ) == -1 )
> + goto ENTRY_EACCESS;
> + if( ( *handle = vlc_opendir( path ) ) == NULL )
> + goto ENTRY_ENOTDIR;
> +#endif
> +
> + return ENTRY_DIR;
> +}
> +
> +static bool directory_push( access_sys_t *p_sys, DIR *handle, char *psz_uri
> ) +{
> + directory_t *p_dir;
> +
> + p_dir = malloc( sizeof( *p_dir ) );
> + if( unlikely( p_dir == NULL ) )
> + return NULL;
> +
> + psz_uri = strdup( psz_uri );
> + if( unlikely ( psz_uri == NULL ) )
> + goto error;
> +
> + p_dir->parent = p_sys->current;
> + p_dir->handle = handle;
> + p_dir->uri = psz_uri;
> + p_dir->filec = vlc_loaddir (handle, &p_dir->filev, visible,
> p_sys->compar); + if (p_dir->filec < 0)
> + p_dir->filev = NULL;
> + p_dir->i = 0;
> +
> +#ifdef HAVE_OPENAT
> + struct stat st;
> + if( fstat( dirfd( handle ), &st ) )
> + goto error;
> + p_dir->device = st.st_dev;
> + p_dir->inode = st.st_ino;
> +#else
> + p_dir->path = make_path( psz_uri );
> + if( p_dir->path == NULL )
> + goto error;
> +#endif
> +
> + p_sys->current = p_dir;
> + return true;
> +
> + error:
> + closedir( handle );
> + free( p_dir );
> + if ( psz_uri != NULL )
> + free( psz_uri );
> +
> + return false;
> +}
> +
> +static bool directory_pop( access_sys_t *p_sys )
> +{
> + directory_t *p_old = p_sys->current;
> +
> + if( p_old == NULL )
> + return false;
> +
> + p_sys->current = p_old->parent;
> + closedir( p_old->handle );
> + free( p_old->uri );
> + free( p_old->filev );
> +#ifndef HAVE_OPENAT
> + free (p_old->path);
> +#endif
> + free( p_old );
> +
> + return p_sys->current != NULL;
> +}
> +
> +
> /**************************************************************************
> *** * Open: open the directory
>
> ***************************************************************************
> **/ @@ -106,22 +265,31 @@ int DirOpen( vlc_object_t *p_this )
> {
> access_t *p_access = (access_t*)p_this;
>
> - if( !p_access->psz_filepath )
> - return VLC_EGENERIC;
> + DIR *handle = vlc_opendir( p_access->psz_location );
>
> - DIR *handle = vlc_opendir (p_access->psz_filepath);
> if (handle == NULL)
> return VLC_EGENERIC;
> -
> - return DirInit (p_access, handle);
> + else
> + return DirInit( p_access, handle );
> }
>
> -int DirInit (access_t *p_access, DIR *handle)
> +int DirInit( access_t *p_access, DIR *handle )
> {
> - access_sys_t *p_sys = malloc (sizeof (*p_sys));
> - if (unlikely(p_sys == NULL))
> + access_sys_t *p_sys = malloc( sizeof( *p_sys ) );
> + if( unlikely( p_sys == NULL ) )
> goto error;
>
> + char *psz_sort = var_InheritString( p_access, "directory-sort" );
> + if (!psz_sort)
> + p_sys->compar = collate;
> + else if ( !strcasecmp ( psz_sort, "version" ) )
> + p_sys->compar = version;
> + else if ( !strcasecmp ( psz_sort, "none" ) )
> + p_sys->compar = NULL;
> + else
> + p_sys->compar = collate;
> + free(psz_sort);
> +
> char *uri;
> if (!strcmp (p_access->psz_access, "fd"))
> {
> @@ -134,72 +302,37 @@ int DirInit (access_t *p_access, DIR *handle)
> goto error;
>
> /* "Open" the base directory */
> - directory_t *root = malloc (sizeof (*root));
> - if (unlikely(root == NULL))
> - {
> - free (uri);
> - goto error;
> - }
> -
> - char *psz_sort = var_InheritString (p_access, "directory-sort");
> - if (!psz_sort)
> - p_sys->compar = collate;
> - else if (!strcasecmp (psz_sort, "version"))
> - p_sys->compar = version;
> - else if (!strcasecmp (psz_sort, "none"))
> - p_sys->compar = NULL;
> - else
> - p_sys->compar = collate;
> - free(psz_sort);
> -
> - root->parent = NULL;
> - root->handle = handle;
> - root->uri = uri;
> - root->filec = vlc_loaddir (handle, &root->filev, visible,
> p_sys->compar); - if (root->filec < 0)
> - root->filev = NULL;
> - root->i = 0;
> -#ifdef HAVE_OPENAT
> - struct stat st;
> - if (fstat (dirfd (handle), &st))
> + p_sys->current = NULL;
> + if( !directory_push( p_sys, handle, uri ) )
> {
> - free (root);
> - free (uri);
> + free(uri);
> goto error;
> }
> - root->device = st.st_dev;
> - root->inode = st.st_ino;
> -#else
> - root->path = strdup (p_access->psz_filepath);
> -#endif
> + free(uri);
>
> p_access->p_sys = p_sys;
> - p_sys->current = root;
> p_sys->ignored_exts = var_InheritString (p_access, "ignore-filetypes");
> - p_sys->header = true;
> - p_sys->i_item_count = 0;
> - p_sys->xspf_ext = strdup ("");
> +
>
> /* Handle mode */
> - char *psz = var_InheritString (p_access, "recursive");
> - if (psz == NULL || !strcasecmp (psz, "none"))
> + char *psz_rec = var_InheritString ( p_access, "recursive" );
> + if( psz_rec == NULL || !strcasecmp ( psz_rec, "none" ) )
> p_sys->mode = MODE_NONE;
> - else if( !strcasecmp( psz, "collapse" ) )
> + else if( !strcasecmp( psz_rec, "collapse" ) )
> p_sys->mode = MODE_COLLAPSE;
> else
> p_sys->mode = MODE_EXPAND;
> - free( psz );
> + free( psz_rec );
>
> - access_InitFields(p_access);
> - p_access->pf_read = NULL;
> - p_access->pf_block = DirBlock;
> - p_access->pf_seek = NULL;
> + p_access->pf_readdir = DirRead;
> p_access->pf_control = DirControl;
> +
> return VLC_SUCCESS;
>
> error:
> - closedir (handle);
> - free (p_sys);
> + closedir( handle );
> + if( p_sys != NULL )
Pointless.
> + free( p_sys );
> return VLC_EGENERIC;
> }
>
> @@ -211,248 +344,87 @@ void DirClose( vlc_object_t * p_this )
> access_t *p_access = (access_t*)p_this;
> access_sys_t *p_sys = p_access->p_sys;
>
> - while (p_sys->current)
> - {
> - directory_t *current = p_sys->current;
> -
> - p_sys->current = current->parent;
> - closedir (current->handle);
> - free (current->uri);
> - while (current->i < current->filec)
> - free (current->filev[current->i++]);
> - free (current->filev);
> -#ifndef HAVE_OPENAT
> - free (current->path);
> -#endif
> - free (current);
> - }
> + while( directory_pop( p_sys ) )
> + ;
>
> - free (p_sys->xspf_ext);
> free (p_sys->ignored_exts);
> free (p_sys);
> }
>
> -#ifdef HAVE_OPENAT
> -/* Detect directories that recurse into themselves. */
> -static bool has_inode_loop (const directory_t *dir, dev_t dev, ino_t inode)
> -{
> - while (dir != NULL)
> - {
> - if ((dir->device == dev) && (dir->inode == inode))
> - return true;
> - dir = dir->parent;
> - }
> - return false;
> -}
> -#endif
> -
> -block_t *DirBlock (access_t *p_access)
> +/* This function is a little bit too complex for what it seems to do, but
> the + * point is to de-recursify directory recusion to avoid overruning the
> stack + * in case there's a high directory depth */
> +int DirRead( access_t *p_access, input_item_node_t *p_current_node )
> {
> access_sys_t *p_sys = p_access->p_sys;
> - directory_t *current = p_sys->current;
> -
> - if (p_access->info.b_eof)
> - return NULL;
>
> - if (p_sys->header)
> - { /* Startup: send the XSPF header */
> - static const char header[] =
> - "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
> - "<playlist version=\"1\" xmlns=\"http://xspf.org/ns/0/\"
> xmlns:vlc=\"http://www.videolan.org/vlc/playlist/ns/0/\">\n" - "
> <trackList>\n";
> - block_t *block = block_Alloc (sizeof (header) - 1);
> - if (!block)
> - goto fatal;
> - memcpy (block->p_buffer, header, sizeof (header) - 1);
> - p_sys->header = false;
> - return block;
> - }
> + while( p_sys->current != NULL
> + && p_sys->current->i <= p_sys->current->filec )
> + {
> + directory_t *p_current = p_sys->current;
>
> - if (current->i >= current->filec)
> - { /* End of directory, go back to parent */
> - closedir (current->handle);
> - p_sys->current = current->parent;
> - free (current->uri);
> - free (current->filev);
> -#ifndef HAVE_OPENAT
> - free (current->path);
> -#endif
> - free (current);
> -
> - if (p_sys->current == NULL)
> - { /* End of XSPF playlist */
> - char *footer;
> - int len = asprintf (&footer, " </trackList>\n"
> - " <extension application=\"http://www.videolan.org/"
> - "vlc/playlist/0\">\n"
> - "%s"
> - " </extension>\n"
> - "</playlist>\n", p_sys->xspf_ext ? p_sys->xspf_ext : "");
> - if (unlikely(len == -1))
> - goto fatal;
> -
> - block_t *block = block_heap_Alloc (footer, len);
> - p_access->info.b_eof = true;
> - return block;
> - }
> - else
> + /* End of the current folder, let's pop directory and node */
> + if( p_current->i == p_current->filec )
> {
> - /* This was the end of a "subnode" */
> - /* Write the ID to the extension */
> - char *old_xspf_ext = p_sys->xspf_ext;
> - if (old_xspf_ext != NULL
> - && asprintf (&p_sys->xspf_ext, "%s </vlc:node>\n",
> - old_xspf_ext ? old_xspf_ext : "") == -1)
> - p_sys->xspf_ext = NULL;
> - free (old_xspf_ext);
> + directory_pop( p_sys );
> + p_current_node = p_current_node->p_parent;
> + continue;
> }
> - return NULL;
> - }
>
> - char *entry = current->filev[current->i++];
> -
> - /* Handle recursion */
> - if (p_sys->mode != MODE_COLLAPSE)
> - {
> + char *psz_entry = p_current->filev[p_current->i++];
> + char *psz_full_uri, *psz_uri;
> DIR *handle;
> -#ifdef HAVE_OPENAT
> - int fd = vlc_openat (dirfd (current->handle), entry,
> - O_RDONLY | O_DIRECTORY);
> - if (fd == -1)
> - {
> - if (errno == ENOTDIR)
> - goto notdir;
> - goto skip; /* File cannot be opened... forget it */
> - }
> + input_item_t *p_new = NULL;
> + int i_res;
>
> - struct stat st;
> - if (fstat (fd, &st)
> - || p_sys->mode == MODE_NONE
> - || has_inode_loop (current, st.st_dev, st.st_ino)
> - || (handle = fdopendir (fd)) == NULL)
> - {
> - close (fd);
> - goto skip;
> - }
> -#else
> - char *path;
> - if (asprintf (&path, "%s/%s", current->path, entry) == -1)
> - goto skip;
> - if ((handle = vlc_opendir (path)) == NULL)
> - goto notdir;
> - if (p_sys->mode == MODE_NONE)
> - goto skip;
> -#endif
> - directory_t *sub = malloc (sizeof (*sub));
> - if (unlikely(sub == NULL))
> + /* Check if it is a directory or even readable */
> + i_res = directory_open( p_current, psz_entry, &handle );
> +
> + if( i_res == ENTRY_EACCESS
> + || ( i_res == ENTRY_DIR && p_sys->mode == MODE_NONE )
> + || ( i_res == ENTRY_ENOTDIR && has_ext( p_sys->ignored_exts,
> psz_entry ) ) ) + continue;
> +
> +
> + /* Create an input item for the current entry */
> + psz_uri = encode_URI_component( psz_entry );
> + if( psz_uri == NULL
> + || asprintf( &psz_full_uri, "%s/%s", p_current->uri, psz_uri )
> == -1 ) {
> - closedir (handle);
> -#ifndef HAVE_OPENAT
> - free (path);
> -#endif
> - goto skip;
> + closedir( handle );
> + continue;
> }
> - sub->parent = current;
> - sub->handle = handle;
> - sub->filec = vlc_loaddir (handle, &sub->filev, visible,
> p_sys->compar); - if (sub->filec < 0)
> - sub->filev = NULL;
> - sub->i = 0;
> -#ifdef HAVE_OPENAT
> - sub->device = st.st_dev;
> - sub->inode = st.st_ino;
> -#else
> - sub->path = path;
> -#endif
> - p_sys->current = sub;
> -
> - char *encoded = encode_URI_component (entry);
> - if (encoded == NULL
> - || (asprintf (&sub->uri, "%s/%s", current->uri, encoded) == -1))
> - sub->uri = NULL;
> - free (encoded);
> - if (unlikely(sub->uri == NULL))
> + free (psz_uri);
> +
> + int i_type = i_res == ENTRY_DIR ? ITEM_TYPE_DIRECTORY :
> ITEM_TYPE_FILE; + p_new = input_item_NewWithType( psz_full_uri,
> psz_entry,
> + 0, NULL, 0, 0, i_type);
> + //msg_Dbg( p_access, "|||||| psz_full_uri = %s ", psz_full_uri );
???
> + if( p_new == NULL )
> {
> - free (entry);
> - goto fatal;
> + free( psz_full_uri );
> + closedir( handle );
> + continue;
> }
>
> - /* Add node to XSPF extension */
> - char *old_xspf_ext = p_sys->xspf_ext;
> - EnsureUTF8 (entry);
> - char *title = convert_xml_special_chars (entry);
> - if (old_xspf_ext != NULL
> - && asprintf (&p_sys->xspf_ext, "%s <vlc:node title=\"%s\">\n",
> - old_xspf_ext, title ? title : "?") == -1)
> - p_sys->xspf_ext = NULL;
> - free (old_xspf_ext);
> - free (title);
> - goto skip;
> - }
> + input_item_CopyOptions( p_current_node->p_item, p_new );
> + input_item_node_t *p_new_node = input_item_node_AppendItem(
> p_current_node, p_new );
>
> -notdir:
> - /* Skip files with ignored extensions */
> - if (p_sys->ignored_exts != NULL)
> - {
> - const char *ext = strrchr (entry, '.');
> - if (ext != NULL)
> + /* Handle directory flags and recursion if in EXPAND mode */
> + if( i_res == ENTRY_DIR )
> {
> - size_t extlen = strlen (++ext);
> - for (const char *type = p_sys->ignored_exts, *end;
> - type[0]; type = end + 1)
> + if( p_sys->mode == MODE_EXPAND
> + && directory_push( p_sys, handle, psz_full_uri ) )
> {
> - end = strchr (type, ',');
> - if (end == NULL)
> - end = type + strlen (type);
> -
> - if (type + extlen == end
> - && !strncasecmp (ext, type, extlen))
> - {
> - free (entry);
> - return NULL;
> - }
> -
> - if (*end == '\0')
> - break;
> + p_current_node = p_new_node;
> }
> }
> +
> + free( psz_full_uri );
> + input_item_Release( p_new );
> }
>
> - char *encoded = encode_URI_component (entry);
> - free (entry);
> - if (encoded == NULL)
> - goto fatal;
> - int len = asprintf (&entry,
> - " <track><location>%s/%s</location>\n" \
> - " <extension
> application=\"http://www.videolan.org/vlc/playlist/0\">\n" \ -
> " <vlc:id>%d</vlc:id>\n" \
> - " </extension>\n" \
> - " </track>\n",
> - current->uri, encoded, p_sys->i_item_count++);
> - free (encoded);
> - if (len == -1)
> - goto fatal;
> -
> - /* Write the ID to the extension */
> - char *old_xspf_ext = p_sys->xspf_ext;
> - if (old_xspf_ext != NULL
> - && asprintf (&p_sys->xspf_ext, "%s <vlc:item tid=\"%i\" />\n",
> - old_xspf_ext, p_sys->i_item_count - 1) == -1)
> - p_sys->xspf_ext = NULL;
> - free (old_xspf_ext);
> -
> - block_t *block = block_heap_Alloc (entry, len);
> - if (unlikely(block == NULL))
> - goto fatal;
> - return block;
> -
> -fatal:
> - p_access->info.b_eof = true;
> - return NULL;
> -
> -skip:
> - free (entry);
> - return NULL;
> + return VLC_SUCCESS;
> }
>
> /**************************************************************************
> *** @@ -460,6 +432,8 @@ skip:
>
> ***************************************************************************
> **/ int DirControl( access_t *p_access, int i_query, va_list args )
> {
> + VLC_UNUSED( p_access );
> +
> switch( i_query )
> {
> case ACCESS_CAN_SEEK:
> @@ -476,13 +450,8 @@ int DirControl( access_t *p_access, int i_query,
> va_list args ) *va_arg( args, int64_t * ) = DEFAULT_PTS_DELAY * 1000;
> break;
>
> - case ACCESS_GET_CONTENT_TYPE:
> - *va_arg( args, char** ) = strdup("application/xspf+xml");
> - return VLC_SUCCESS;
> -
> default:
> return VLC_EGENERIC;
> - }
> - (void) p_access;
> - return VLC_SUCCESS;
> -}
> + }
> + return VLC_SUCCESS;
> + }
> diff --git a/modules/access/fs.h b/modules/access/fs.h
> index 5124769..eac2ce8 100644
> --- a/modules/access/fs.h
> +++ b/modules/access/fs.h
> @@ -22,9 +22,8 @@
>
> int FileOpen (vlc_object_t *);
> void FileClose (vlc_object_t *);
> -
> -int DirOpen (vlc_object_t *);
> int DirInit (access_t *p_access, DIR *handle);
> -block_t *DirBlock (access_t *);
> +int DirRead (access_t *, input_item_node_t *);
> int DirControl (access_t *, int, va_list);
> +int DirOpen (vlc_object_t *);
> void DirClose (vlc_object_t *);
--
Rémi Denis-Courmont
http://www.remlab.net/
More information about the vlc-devel
mailing list