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