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 *, input_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 = playlist_ItemGetByInput( p_playlist,
 188                                                              p_current_input,
 189                                                              VLC_FALSE );
 190     char               *psz_name = strdup (p_access->psz_path);
 191
 192     if( psz_name == NULL )
 193         return VLC_ENOMEM;
 194
 195     if( p_current == NULL ) {
 196         msg_Err( p_access, "unable to find item in playlist" );
 197         return VLC_ENOOBJ;
 198     }
 199
 200     /* Remove the ending '/' char */
 201     if (psz_name[0])
 202     {
 203         char *ptr = psz_name + strlen (psz_name);
 204         switch (*--ptr)
 205         {
 206             case '/':
 207             case '\\':
 208                 *ptr = '\0';
 209         }
 210     }
 211
 212     /* Handle mode */
 213     psz = var_CreateGetString( p_access, "recursive" );
 214     if( *psz == '\0' || !strncmp( psz, "none" , 4 )  )
 215         i_mode = MODE_NONE;
 216     else if( !strncmp( psz, "collapse", 8 )  )
 217         i_mode = MODE_COLLAPSE;
 218     else
 219         i_mode = MODE_EXPAND;
 220     free( psz );
 221
 222     msg_Dbg( p_access, "opening directory `%s'", p_access->psz_path );
 223
 224     p_current->p_input->i_type = ITEM_TYPE_DIRECTORY;
 225     p_item_in_category = playlist_ItemToNode( p_playlist, p_current,
 226                                               VLC_FALSE );
 227
 228     i_activity = var_GetInteger( p_playlist, "activity" );
 229     var_SetInteger( p_playlist, "activity", i_activity +
 230                     DIRECTORY_ACTIVITY );
 231
 232     ReadDir( p_playlist, psz_name, i_mode, p_current, p_item_in_category,
 233              p_current_input );
 234
 235     i_activity = var_GetInteger( p_playlist, "activity" );
 236     var_SetInteger( p_playlist, "activity", i_activity -
 237                     DIRECTORY_ACTIVITY );
 238
 239     if( psz_name ) free( psz_name );
 240     vlc_object_release( p_playlist );
 241
 242     /* Return fake data forever */
 243     p_access->pf_read = ReadNull;
 244     return ReadNull( p_access, p_buffer, i_len );
 245 }
 246
 247 /*****************************************************************************
 248  * DemuxOpen:
 249  *****************************************************************************/
 250 static int Control( access_t *p_access, int i_query, va_list args )
 251 {
 252     vlc_bool_t   *pb_bool;
 253     int          *pi_int;
 254     int64_t      *pi_64;
 255
 256     switch( i_query )
 257     {
 258         /* */
 259         case ACCESS_CAN_SEEK:
 260         case ACCESS_CAN_FASTSEEK:
 261         case ACCESS_CAN_PAUSE:
 262         case ACCESS_CAN_CONTROL_PACE:
 263             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 264             *pb_bool = VLC_FALSE;    /* FIXME */
 265             break;
 266
 267         /* */
 268         case ACCESS_GET_MTU:
 269             pi_int = (int*)va_arg( args, int * );
 270             *pi_int = 0;
 271             break;
 272
 273         case ACCESS_GET_PTS_DELAY:
 274             pi_64 = (int64_t*)va_arg( args, int64_t * );
 275             *pi_64 = DEFAULT_PTS_DELAY * 1000;
 276             break;
 277
 278         /* */
 279         case ACCESS_SET_PAUSE_STATE:
 280         case ACCESS_GET_TITLE_INFO:
 281         case ACCESS_SET_TITLE:
 282         case ACCESS_SET_SEEKPOINT:
 283         case ACCESS_SET_PRIVATE_ID_STATE:
 284             return VLC_EGENERIC;
 285
 286         default:
 287             msg_Warn( p_access, "unimplemented query in control" );
 288             return VLC_EGENERIC;
 289     }
 290     return VLC_SUCCESS;
 291 }
 292
 293 /*****************************************************************************
 294  * DemuxOpen:
 295  *****************************************************************************/
 296 static int DemuxOpen ( vlc_object_t *p_this )
 297 {
 298     demux_t *p_demux = (demux_t*)p_this;
 299
 300     if( strcmp( p_demux->psz_demux, "directory" ) )
 301         return VLC_EGENERIC;
 302
 303     p_demux->pf_demux   = Demux;
 304     p_demux->pf_control = DemuxControl;
 305     return VLC_SUCCESS;
 306 }
 307
 308 /*****************************************************************************
 309  * Demux: EOF
 310  *****************************************************************************/
 311 static int Demux( demux_t *p_demux )
 312 {
 313     return 0;
 314 }
 315
 316 /*****************************************************************************
 317  * DemuxControl:
 318  *****************************************************************************/
 319 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
 320 {
 321     return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
 322 }
 323
 324
 325 static int Sort (const char **a, const char **b)
 326 {
 327     return strcoll (*a, *b);
 328 }
 329
 330 /*****************************************************************************
 331  * ReadDir: read a directory and add its content to the list
 332  *****************************************************************************/
 333 static int ReadDir( playlist_t *p_playlist, const char *psz_name,
 334                     int i_mode, playlist_item_t *p_parent,
 335                     playlist_item_t *p_parent_category,
 336                     input_item_t *p_current_input )
 337 {
 338     char **pp_dir_content = NULL;
 339     int             i_dir_content, i, i_return = VLC_SUCCESS;
 340     playlist_item_t *p_node;
 341
 342     char **ppsz_extensions = NULL;
 343     int i_extensions = 0;
 344     char *psz_ignore;
 345
 346     /* Get the first directory entry */
 347     i_dir_content = utf8_scandir (psz_name, &pp_dir_content, NULL, Sort);
 348     if( i_dir_content == -1 )
 349     {
 350         msg_Warn( p_playlist, "failed to read directory" );
 351         return VLC_EGENERIC;
 352     }
 353     else if( i_dir_content <= 0 )
 354     {
 355         /* directory is empty */
 356         if( pp_dir_content ) free( pp_dir_content );
 357         return VLC_SUCCESS;
 358     }
 359
 360     /* Build array with ignores */
 361     psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
 362     if( psz_ignore && *psz_ignore )
 363     {
 364         char *psz_parser = psz_ignore;
 365         int a;
 366
 367         for( a = 0; psz_parser[a] != '\0'; a++ )
 368         {
 369             if( psz_parser[a] == ',' ) i_extensions++;
 370         }
 371
 372         ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
 373
 374         for( a = 0; a < i_extensions; a++ )
 375         {
 376             char *tmp, *ptr;
 377
 378             while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
 379             ptr = strchr( psz_parser, ',');
 380             tmp = ( ptr == NULL )
 381                  ? strdup( psz_parser )
 382                  : strndup( psz_parser, ptr - psz_parser );
 383
 384             ppsz_extensions[a] = tmp;
 385             psz_parser = ptr + 1;
 386         }
 387     }
 388     if( psz_ignore ) free( psz_ignore );
 389
 390     /* While we still have entries in the directory */
 391     for( i = 0; i < i_dir_content; i++ )
 392     {
 393         const char *entry = pp_dir_content[i];
 394         int i_size_entry = strlen( psz_name ) +
 395                            strlen( entry ) + 2;
 396         char psz_uri[i_size_entry];
 397
 398         sprintf( psz_uri, "%s/%s", psz_name, entry);
 399
 400         /* if it starts with '.' then forget it */
 401         if (entry[0] != '.')
 402         {
 403 #if defined( S_ISDIR )
 404             struct stat stat_data;
 405
 406             if (!utf8_stat (psz_uri, &stat_data)
 407              && S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
 408 #else
 409             if( 0 )
 410 #endif
 411             {
 412 #if defined( S_ISLNK )
 413 /*
 414  * FIXME: there is a ToCToU race condition here; but it is rather tricky
 415  * impossible to fix while keeping some kind of portable code, and maybe even
 416  * in a non-portable way.
 417  */
 418                 if (utf8_lstat (psz_uri, &stat_data)
 419                  || S_ISLNK(stat_data.st_mode) )
 420                 {
 421                     msg_Dbg( p_playlist, "skipping directory symlink %s",
 422                              psz_uri );
 423                     continue;
 424                 }
 425 #endif
 426                 if( i_mode == MODE_NONE )
 427                 {
 428                     msg_Dbg( p_playlist, "skipping subdirectory %s", psz_uri );
 429                     continue;
 430                 }
 431                 else if( i_mode == MODE_EXPAND )
 432                 {
 433                     msg_Dbg(p_playlist, "creading subdirectory %s", psz_uri );
 434
 435                     p_node = playlist_NodeCreate (p_playlist, entry,
 436                                                   p_parent_category);
 437
 438                     /* If we had the parent in category, the it is now node.
 439                      * Else, we still don't have  */
 440                     if( ReadDir( p_playlist, psz_uri , MODE_EXPAND,
 441                                  p_node, p_parent_category ? p_node : NULL,
 442                                  p_current_input )
 443                           != VLC_SUCCESS )
 444                     {
 445                         i_return = VLC_EGENERIC;
 446                         break;
 447                     }
 448                 }
 449             }
 450             else
 451             {
 452                 input_item_t *p_input;
 453
 454                 if( i_extensions > 0 )
 455                 {
 456                     const char *psz_dot = strrchr (entry, '.' );
 457                     if( psz_dot++ && *psz_dot )
 458                     {
 459                         int a;
 460                         for( a = 0; a < i_extensions; a++ )
 461                         {
 462                             if( !strcmp( psz_dot, ppsz_extensions[a] ) )
 463                                 break;
 464                         }
 465                         if( a < i_extensions )
 466                         {
 467                             msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
 468                             continue;
 469                         }
 470                     }
 471                 }
 472
 473                 p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist),
 474                                                  psz_uri, entry, 0, NULL,
 475                                                  -1, ITEM_TYPE_VFILE );
 476                 if (p_input != NULL)
 477                 {
 478                     if( p_current_input )
 479                         input_ItemCopyOptions( p_current_input, p_input );
 480                     playlist_BothAddInput( p_playlist, p_input,
 481                                            p_parent_category,
 482                                            PLAYLIST_APPEND|PLAYLIST_PREPARSE,
 483                                            PLAYLIST_END, NULL, NULL );
 484                 }
 485             }
 486         }
 487     }
 488
 489     for( i = 0; i < i_extensions; i++ )
 490         if( ppsz_extensions[i] ) free( ppsz_extensions[i] );
 491     if( ppsz_extensions ) free( ppsz_extensions );
 492
 493     for( i = 0; i < i_dir_content; i++ )
 494         if( pp_dir_content[i] ) free( pp_dir_content[i] );
 495     if( pp_dir_content ) free( pp_dir_content );
 496
 497     return i_return;
 498 }