git.sesse.net Git - vlc/blob - modules/access/directory.c

   1 /*****************************************************************************
   2  * directory.c: expands a directory (directory: access plug-in)
   3  *****************************************************************************
   4  * Copyright (C) 2002-2004 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Derk-Jan Hartman <hartman at videolan dot org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27
  28 #include <vlc/vlc.h>
  29 #include <vlc/input.h>
  30 #include <vlc_playlist.h>
  31 #include <vlc_input.h>
  32
  33 #include <stdlib.h>
  34 #include <string.h>
  35 #ifdef HAVE_SYS_TYPES_H
  36 #   include <sys/types.h>
  37 #endif
  38 #ifdef HAVE_SYS_STAT_H
  39 #   include <sys/stat.h>
  40 #endif
  41 #ifdef HAVE_ERRNO_H
  42 #   include <errno.h>
  43 #endif
  44 #ifdef HAVE_FCNTL_H
  45 #   include <fcntl.h>
  46 #endif
  47
  48 #ifdef HAVE_UNISTD_H
  49 #   include <unistd.h>
  50 #elif defined( WIN32 ) && !defined( UNDER_CE )
  51 #   include <io.h>
  52 #elif defined( UNDER_CE )
  53 #   define strcoll strcmp
  54 #endif
  55
  56 #ifdef HAVE_DIRENT_H
  57 #   include <dirent.h>
  58 #endif
  59
  60 #include "charset.h"
  61
  62 /*****************************************************************************
  63  * Module descriptor
  64  *****************************************************************************/
  65 static int  Open ( vlc_object_t * );
  66 static void Close( vlc_object_t * );
  67
  68 static int  DemuxOpen ( vlc_object_t * );
  69
  70 #define RECURSIVE_TEXT N_("Subdirectory behavior")
  71 #define RECURSIVE_LONGTEXT N_( \
  72         "Select whether subdirectories must be expanded.\n" \
  73         "none: subdirectories do not appear in the playlist.\n" \
  74         "collapse: subdirectories appear but are expanded on first play.\n" \
  75         "expand: all subdirectories are expanded.\n" )
  76
  77 static const char *psz_recursive_list[] = { "none", "collapse", "expand" };
  78 static const char *psz_recursive_list_text[] = { N_("none"), N_("collapse"),
  79                                                  N_("expand") };
  80
  81 #define IGNORE_TEXT N_("Ignored extensions")
  82 #define IGNORE_LONGTEXT N_( \
  83         "Files with these extensions will not be added to playlist when " \
  84         "opening a directory.\n" \
  85         "This is useful if you add directories that contain playlist files " \
  86         "for instance. Use a comma-separated list of extensions." )
  87
  88 vlc_module_begin();
  89     set_category( CAT_INPUT );
  90     set_shortname( _("Directory" ) );
  91     set_subcategory( SUBCAT_INPUT_ACCESS );
  92     set_description( _("Standard filesystem directory input") );
  93     set_capability( "access2", 55 );
  94     add_shortcut( "directory" );
  95     add_shortcut( "dir" );
  96     add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
  97                 RECURSIVE_LONGTEXT, VLC_FALSE );
  98       change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
  99     add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
 100                 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, VLC_FALSE );
 101     set_callbacks( Open, Close );
 102
 103     add_submodule();
 104         set_description( "Directory EOF");
 105         set_capability( "demux2", 0 );
 106         add_shortcut( "directory" );
 107         set_callbacks( DemuxOpen, NULL );
 108 vlc_module_end();
 109
 110
 111 /*****************************************************************************
 112  * Local prototypes, constants, structures
 113  *****************************************************************************/
 114
 115 #define MODE_EXPAND 0
 116 #define MODE_COLLAPSE 1
 117 #define MODE_NONE 2
 118
 119 static int Read( access_t *, uint8_t *, int );
 120 static int ReadNull( access_t *, uint8_t *, int );
 121 static int Control( access_t *, int, va_list );
 122
 123 static int Demux( demux_t *p_demux );
 124 static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
 125
 126
 127 static int ReadDir( playlist_t *, const char *psz_name, int i_mode,
 128                     playlist_item_t *, playlist_item_t * );
 129
 130 /*****************************************************************************
 131  * Open: open the directory
 132  *****************************************************************************/
 133 static int Open( vlc_object_t *p_this )
 134 {
 135     access_t *p_access = (access_t*)p_this;
 136
 137     struct stat stat_info;
 138
 139 #ifdef S_ISDIR
 140     if (utf8_stat (p_access->psz_path, &stat_info)
 141      || !S_ISDIR (stat_info.st_mode))
 142 #else
 143     if( strcmp( p_access->psz_access, "dir") &&
 144         strcmp( p_access->psz_access, "directory") )
 145 #endif
 146         return VLC_EGENERIC;
 147
 148     p_access->pf_read  = Read;
 149     p_access->pf_block = NULL;
 150     p_access->pf_seek  = NULL;
 151     p_access->pf_control= Control;
 152
 153     /* Force a demux */
 154     p_access->psz_demux = strdup( "directory" );
 155
 156     return VLC_SUCCESS;
 157 }
 158
 159 /*****************************************************************************
 160  * Close: close the target
 161  *****************************************************************************/
 162 static void Close( vlc_object_t * p_this )
 163 {
 164 }
 165
 166 /*****************************************************************************
 167  * ReadNull: read the directory
 168  *****************************************************************************/
 169 static int ReadNull( access_t *p_access, uint8_t *p_buffer, int i_len)
 170 {
 171     /* Return fake data */
 172     memset( p_buffer, 0, i_len );
 173     return i_len;
 174 }
 175
 176 /*****************************************************************************
 177  * Read: read the directory
 178  *****************************************************************************/
 179 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len)
 180 {
 181     char               *psz;
 182     int                 i_mode, i_activity;
 183     playlist_t         *p_playlist = pl_Yield( p_access );
 184     playlist_item_t    *p_item_in_category;
 185     input_item_t       *p_current_input = ( (input_thread_t*)p_access->p_parent)
 186                                                        ->input.p_item;
 187     playlist_item_t    *p_current =
 188                 playlist_LockItemGetByInput( p_playlist, p_current_input );
 189     char               *psz_name = strdup (p_access->psz_path);
 190
 191     if( psz_name == NULL )
 192         return VLC_ENOMEM;
 193
 194     if( p_current == NULL ) {
 195         msg_Err( p_access, "unable to find item in playlist" );
 196         return VLC_ENOOBJ;
 197     }
 198
 199     /* Remove the ending '/' char */
 200     if (psz_name[0])
 201     {
 202         char *ptr = psz_name + strlen (psz_name);
 203         switch (*--ptr)
 204         {
 205             case '/':
 206             case '\\':
 207                 *ptr = '\0';
 208         }
 209     }
 210
 211     /* Handle mode */
 212     psz = var_CreateGetString( p_access, "recursive" );
 213     if( *psz == '\0' || !strncmp( psz, "none" , 4 )  )
 214         i_mode = MODE_NONE;
 215     else if( !strncmp( psz, "collapse", 8 )  )
 216         i_mode = MODE_COLLAPSE;
 217     else
 218         i_mode = MODE_EXPAND;
 219     free( psz );
 220
 221     msg_Dbg( p_access, "opening directory `%s'", p_access->psz_path );
 222
 223     p_current->p_input->i_type = ITEM_TYPE_DIRECTORY;
 224     p_item_in_category = playlist_LockItemToNode( p_playlist, p_current );
 225
 226     i_activity = var_GetInteger( p_playlist, "activity" );
 227     var_SetInteger( p_playlist, "activity", i_activity +
 228                     DIRECTORY_ACTIVITY );
 229
 230     ReadDir( p_playlist, psz_name, i_mode, p_current, p_item_in_category );
 231
 232     i_activity = var_GetInteger( p_playlist, "activity" );
 233     var_SetInteger( p_playlist, "activity", i_activity -
 234                     DIRECTORY_ACTIVITY );
 235
 236     if( psz_name ) free( psz_name );
 237     vlc_object_release( p_playlist );
 238
 239     /* Return fake data forever */
 240     p_access->pf_read = ReadNull;
 241     return ReadNull( p_access, p_buffer, i_len );
 242 }
 243
 244 /*****************************************************************************
 245  * DemuxOpen:
 246  *****************************************************************************/
 247 static int Control( access_t *p_access, int i_query, va_list args )
 248 {
 249     vlc_bool_t   *pb_bool;
 250     int          *pi_int;
 251     int64_t      *pi_64;
 252
 253     switch( i_query )
 254     {
 255         /* */
 256         case ACCESS_CAN_SEEK:
 257         case ACCESS_CAN_FASTSEEK:
 258         case ACCESS_CAN_PAUSE:
 259         case ACCESS_CAN_CONTROL_PACE:
 260             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 261             *pb_bool = VLC_FALSE;    /* FIXME */
 262             break;
 263
 264         /* */
 265         case ACCESS_GET_MTU:
 266             pi_int = (int*)va_arg( args, int * );
 267             *pi_int = 0;
 268             break;
 269
 270         case ACCESS_GET_PTS_DELAY:
 271             pi_64 = (int64_t*)va_arg( args, int64_t * );
 272             *pi_64 = DEFAULT_PTS_DELAY * 1000;
 273             break;
 274
 275         /* */
 276         case ACCESS_SET_PAUSE_STATE:
 277         case ACCESS_GET_TITLE_INFO:
 278         case ACCESS_SET_TITLE:
 279         case ACCESS_SET_SEEKPOINT:
 280         case ACCESS_SET_PRIVATE_ID_STATE:
 281             return VLC_EGENERIC;
 282
 283         default:
 284             msg_Warn( p_access, "unimplemented query in control" );
 285             return VLC_EGENERIC;
 286     }
 287     return VLC_SUCCESS;
 288 }
 289
 290 /*****************************************************************************
 291  * DemuxOpen:
 292  *****************************************************************************/
 293 static int DemuxOpen ( vlc_object_t *p_this )
 294 {
 295     demux_t *p_demux = (demux_t*)p_this;
 296
 297     if( strcmp( p_demux->psz_demux, "directory" ) )
 298         return VLC_EGENERIC;
 299
 300     p_demux->pf_demux   = Demux;
 301     p_demux->pf_control = DemuxControl;
 302     return VLC_SUCCESS;
 303 }
 304
 305 /*****************************************************************************
 306  * Demux: EOF
 307  *****************************************************************************/
 308 static int Demux( demux_t *p_demux )
 309 {
 310     return 0;
 311 }
 312
 313 /*****************************************************************************
 314  * DemuxControl:
 315  *****************************************************************************/
 316 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
 317 {
 318     return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
 319 }
 320
 321
 322 static int Sort (const char **a, const char **b)
 323 {
 324     return strcoll (*a, *b);
 325 }
 326
 327 /*****************************************************************************
 328  * ReadDir: read a directory and add its content to the list
 329  *****************************************************************************/
 330 static int ReadDir( playlist_t *p_playlist, const char *psz_name,
 331                     int i_mode, playlist_item_t *p_parent,
 332                     playlist_item_t *p_parent_category )
 333 {
 334     char **pp_dir_content = NULL;
 335     int             i_dir_content, i, i_return = VLC_SUCCESS;
 336     playlist_item_t *p_node;
 337
 338     char **ppsz_extensions = NULL;
 339     int i_extensions = 0;
 340     char *psz_ignore;
 341
 342     /* Get the first directory entry */
 343     i_dir_content = utf8_scandir (psz_name, &pp_dir_content, NULL, Sort);
 344     if( i_dir_content == -1 )
 345     {
 346         msg_Warn( p_playlist, "failed to read directory" );
 347         return VLC_EGENERIC;
 348     }
 349     else if( i_dir_content <= 0 )
 350     {
 351         /* directory is empty */
 352         if( pp_dir_content ) free( pp_dir_content );
 353         return VLC_SUCCESS;
 354     }
 355
 356     /* Build array with ignores */
 357     psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
 358     if( psz_ignore && *psz_ignore )
 359     {
 360         char *psz_parser = psz_ignore;
 361         int a;
 362
 363         for( a = 0; psz_parser[a] != '\0'; a++ )
 364         {
 365             if( psz_parser[a] == ',' ) i_extensions++;
 366         }
 367
 368         ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
 369
 370         for( a = 0; a < i_extensions; a++ )
 371         {
 372             char *tmp, *ptr;
 373
 374             while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
 375             ptr = strchr( psz_parser, ',');
 376             tmp = ( ptr == NULL )
 377                  ? strdup( psz_parser )
 378                  : strndup( psz_parser, ptr - psz_parser );
 379
 380             ppsz_extensions[a] = tmp;
 381             psz_parser = ptr + 1;
 382         }
 383     }
 384     if( psz_ignore ) free( psz_ignore );
 385
 386     /* While we still have entries in the directory */
 387     for( i = 0; i < i_dir_content; i++ )
 388     {
 389         const char *entry = pp_dir_content[i];
 390         int i_size_entry = strlen( psz_name ) +
 391                            strlen( entry ) + 2;
 392         char psz_uri[i_size_entry];
 393
 394         sprintf( psz_uri, "%s/%s", psz_name, entry);
 395
 396         /* if it starts with '.' then forget it */
 397         if (entry[0] != '.')
 398         {
 399 #if defined( S_ISDIR )
 400             struct stat stat_data;
 401
 402             if (!utf8_stat (psz_uri, &stat_data)
 403              && S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
 404 #else
 405             if( 0 )
 406 #endif
 407             {
 408 #if defined( S_ISLNK )
 409 /*
 410  * FIXME: there is a ToCToU race condition here; but it is rather tricky
 411  * impossible to fix while keeping some kind of portable code, and maybe even
 412  * in a non-portable way.
 413  */
 414                 if (utf8_lstat (psz_uri, &stat_data)
 415                  || S_ISLNK(stat_data.st_mode) )
 416                 {
 417                     msg_Dbg( p_playlist, "skipping directory symlink %s",
 418                              psz_uri );
 419                     continue;
 420                 }
 421 #endif
 422                 if( i_mode == MODE_NONE )
 423                 {
 424                     msg_Dbg( p_playlist, "skipping subdirectory %s", psz_uri );
 425                     continue;
 426                 }
 427                 else if( i_mode == MODE_EXPAND )
 428                 {
 429                     msg_Dbg(p_playlist, "creading subdirectory %s", psz_uri );
 430
 431                     p_node = playlist_NodeCreate (p_playlist, entry,
 432                                                   p_parent_category);
 433
 434                     /* If we had the parent in category, the it is now node.
 435                      * Else, we still don't have  */
 436                     if( ReadDir( p_playlist, psz_uri , MODE_EXPAND,
 437                                  p_node, p_parent_category ? p_node : NULL )
 438                           != VLC_SUCCESS )
 439                     {
 440                         i_return = VLC_EGENERIC;
 441                         break;
 442                     }
 443                 }
 444             }
 445             else
 446             {
 447                 input_item_t *p_input;
 448
 449                 if( i_extensions > 0 )
 450                 {
 451                     const char *psz_dot = strrchr (entry, '.' );
 452                     if( psz_dot++ && *psz_dot )
 453                     {
 454                         int a;
 455                         for( a = 0; a < i_extensions; a++ )
 456                         {
 457                             if( !strcmp( psz_dot, ppsz_extensions[a] ) )
 458                                 break;
 459                         }
 460                         if( a < i_extensions )
 461                         {
 462                             msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
 463                             continue;
 464                         }
 465                     }
 466                 }
 467
 468                 p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist),
 469                                                  psz_uri, entry, 0, NULL,
 470                                                  -1, ITEM_TYPE_VFILE );
 471                 if (p_input != NULL)
 472                     playlist_BothAddInput( p_playlist, p_input,
 473                                            p_parent_category,
 474                                            PLAYLIST_APPEND|PLAYLIST_PREPARSE,
 475                                            PLAYLIST_END );
 476             }
 477         }
 478     }
 479
 480     for( i = 0; i < i_extensions; i++ )
 481         if( ppsz_extensions[i] ) free( ppsz_extensions[i] );
 482     if( ppsz_extensions ) free( ppsz_extensions );
 483
 484     for( i = 0; i < i_dir_content; i++ )
 485         if( pp_dir_content[i] ) free( pp_dir_content[i] );
 486     if( pp_dir_content ) free( pp_dir_content );
 487
 488     return i_return;
 489 }