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 char *psz_recursive_list[] = { "none", "collapse", "expand" };
  78 static 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 #ifdef HAVE_SYS_STAT_H
 138     struct stat stat_info;
 139     char *psz_path = ToLocale( p_access->psz_path );
 140
 141     if( ( stat( psz_path, &stat_info ) == -1 ) ||
 142         !S_ISDIR( stat_info.st_mode ) )
 143 #elif defined(WIN32)
 144     int i_ret;
 145
 146 #   ifdef UNICODE
 147     wchar_t psz_path[MAX_PATH];
 148     mbstowcs( psz_path, p_access->psz_path, MAX_PATH );
 149     psz_path[MAX_PATH-1] = 0;
 150 #   else
 151     char *psz_path = p_access->psz_path;
 152 #   endif /* UNICODE */
 153
 154     i_ret = GetFileAttributes( psz_path );
 155     if( i_ret == -1 || !(i_ret & FILE_ATTRIBUTE_DIRECTORY) )
 156
 157 #else
 158     if( strcmp( p_access->psz_access, "dir") &&
 159         strcmp( p_access->psz_access, "directory") )
 160 #endif
 161     {
 162         LocaleFree( psz_path );
 163         return VLC_EGENERIC;
 164     }
 165
 166     LocaleFree( psz_path );
 167     p_access->pf_read  = Read;
 168     p_access->pf_block = NULL;
 169     p_access->pf_seek  = NULL;
 170     p_access->pf_control= Control;
 171
 172     /* Force a demux */
 173     p_access->psz_demux = strdup( "directory" );
 174
 175     return VLC_SUCCESS;
 176 }
 177
 178 /*****************************************************************************
 179  * Close: close the target
 180  *****************************************************************************/
 181 static void Close( vlc_object_t * p_this )
 182 {
 183 }
 184
 185 /*****************************************************************************
 186  * ReadNull: read the directory
 187  *****************************************************************************/
 188 static int ReadNull( access_t *p_access, uint8_t *p_buffer, int i_len)
 189 {
 190     /* Return fake data */
 191     memset( p_buffer, 0, i_len );
 192     return i_len;
 193 }
 194
 195 /*****************************************************************************
 196  * Read: read the directory
 197  *****************************************************************************/
 198 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len)
 199 {
 200     char *psz_name = NULL;
 201     char *psz;
 202     char *ptr;
 203     int  i_mode, i_activity;
 204
 205     playlist_item_t *p_item, *p_root_category;
 206     vlc_bool_t b_play = VLC_FALSE;
 207
 208     playlist_t *p_playlist =
 209         (playlist_t *) vlc_object_find( p_access,
 210                                         VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
 211
 212     if( !p_playlist )
 213     {
 214         msg_Err( p_access, "can't find playlist" );
 215         goto end;
 216     }
 217
 218     psz_name = ToLocale( p_access->psz_path );
 219     ptr = strdup( psz_name );
 220     LocaleFree( psz_name );
 221     if( ptr == NULL )
 222         goto end;
 223
 224     psz_name = ptr;
 225
 226     /* Remove the ending '/' char */
 227     ptr += strlen( ptr );
 228     if( ( ptr > psz_name ) )
 229     {
 230         switch( *--ptr )
 231         {
 232             case '/':
 233             case '\\':
 234                 *ptr = '\0';
 235         }
 236     }
 237
 238     /* Handle mode */
 239     psz = var_CreateGetString( p_access, "recursive" );
 240     if( *psz == '\0' || !strncmp( psz, "none" , 4 )  )
 241         i_mode = MODE_NONE;
 242     else if( !strncmp( psz, "collapse", 8 )  )
 243         i_mode = MODE_COLLAPSE;
 244     else
 245         i_mode = MODE_EXPAND;
 246     free( psz );
 247
 248     msg_Dbg( p_access, "opening directory `%s'", p_access->psz_path );
 249
 250     if( p_playlist->status.p_item->p_input ==
 251         ((input_thread_t *)p_access->p_parent)->input.p_item )
 252     {
 253         p_item = p_playlist->status.p_item;
 254         b_play = VLC_TRUE;
 255         msg_Dbg( p_access, "starting directory playback");
 256     }
 257     else
 258     {
 259         input_item_t *p_current = ( (input_thread_t*)p_access->p_parent)->
 260                                                         input.p_item;
 261         p_item = playlist_LockItemGetByInput( p_playlist, p_current );
 262         msg_Dbg( p_access, "not starting directory playback");
 263         if( !p_item )
 264         {
 265             msg_Dbg( p_playlist, "unable to find item in playlist");
 266             return -1;
 267         }
 268         b_play = VLC_FALSE;
 269     }
 270     p_item->p_input->i_type = ITEM_TYPE_DIRECTORY;
 271
 272     p_root_category = playlist_LockItemToNode( p_playlist, p_item );
 273
 274     i_activity = var_GetInteger( p_playlist, "activity" );
 275     var_SetInteger( p_playlist, "activity", i_activity +
 276                     DIRECTORY_ACTIVITY );
 277
 278     ReadDir( p_playlist, psz_name , i_mode, p_item, p_root_category );
 279
 280     i_activity = var_GetInteger( p_playlist, "activity" );
 281     var_SetInteger( p_playlist, "activity", i_activity -
 282                     DIRECTORY_ACTIVITY );
 283 end:
 284
 285     /* Begin to read the directory */
 286     if( b_play )
 287     {
 288 #if 0
 289        /// \bug we can start playing an already deleted item. Fix ?*/
 290        playlist_Control( p_playlist, PLAYLIST_VIEWPLAY, 1242,
 291                           p_playlist->status.p_item, NULL );
 292 #endif
 293     }
 294     if( psz_name ) free( psz_name );
 295     vlc_object_release( p_playlist );
 296
 297     /* Return fake data forever */
 298     p_access->pf_read = ReadNull;
 299     return ReadNull( p_access, p_buffer, i_len );
 300 }
 301
 302 /*****************************************************************************
 303  * DemuxOpen:
 304  *****************************************************************************/
 305 static int Control( access_t *p_access, int i_query, va_list args )
 306 {
 307     vlc_bool_t   *pb_bool;
 308     int          *pi_int;
 309     int64_t      *pi_64;
 310
 311     switch( i_query )
 312     {
 313         /* */
 314         case ACCESS_CAN_SEEK:
 315         case ACCESS_CAN_FASTSEEK:
 316         case ACCESS_CAN_PAUSE:
 317         case ACCESS_CAN_CONTROL_PACE:
 318             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 319             *pb_bool = VLC_FALSE;    /* FIXME */
 320             break;
 321
 322         /* */
 323         case ACCESS_GET_MTU:
 324             pi_int = (int*)va_arg( args, int * );
 325             *pi_int = 0;
 326             break;
 327
 328         case ACCESS_GET_PTS_DELAY:
 329             pi_64 = (int64_t*)va_arg( args, int64_t * );
 330             *pi_64 = DEFAULT_PTS_DELAY * 1000;
 331             break;
 332
 333         /* */
 334         case ACCESS_SET_PAUSE_STATE:
 335         case ACCESS_GET_TITLE_INFO:
 336         case ACCESS_SET_TITLE:
 337         case ACCESS_SET_SEEKPOINT:
 338         case ACCESS_SET_PRIVATE_ID_STATE:
 339             return VLC_EGENERIC;
 340
 341         default:
 342             msg_Warn( p_access, "unimplemented query in control" );
 343             return VLC_EGENERIC;
 344     }
 345     return VLC_SUCCESS;
 346 }
 347
 348 /*****************************************************************************
 349  * DemuxOpen:
 350  *****************************************************************************/
 351 static int DemuxOpen ( vlc_object_t *p_this )
 352 {
 353     demux_t *p_demux = (demux_t*)p_this;
 354
 355     if( strcmp( p_demux->psz_demux, "directory" ) )
 356         return VLC_EGENERIC;
 357
 358     p_demux->pf_demux   = Demux;
 359     p_demux->pf_control = DemuxControl;
 360     return VLC_SUCCESS;
 361 }
 362
 363 /*****************************************************************************
 364  * Demux: EOF
 365  *****************************************************************************/
 366 static int Demux( demux_t *p_demux )
 367 {
 368     return 0;
 369 }
 370
 371 /*****************************************************************************
 372  * DemuxControl:
 373  *****************************************************************************/
 374 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
 375 {
 376     return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
 377 }
 378
 379 static int Filter( const struct dirent *foo )
 380 {
 381     return VLC_TRUE;
 382 }
 383
 384 /*****************************************************************************
 385  * ReadDir: read a directory and add its content to the list
 386  *****************************************************************************/
 387 static int ReadDir( playlist_t *p_playlist, const char *psz_name,
 388                     int i_mode, playlist_item_t *p_parent,
 389                     playlist_item_t *p_parent_category )
 390 {
 391     struct dirent   **pp_dir_content = 0;
 392     int             i_dir_content, i, i_return = VLC_SUCCESS;
 393     playlist_item_t *p_node;
 394
 395     char **ppsz_extensions = 0;
 396     int i_extensions = 0;
 397     char *psz_ignore;
 398
 399     /* Get the first directory entry */
 400     i_dir_content = scandir( psz_name, &pp_dir_content, Filter, alphasort );
 401     if( i_dir_content == -1 )
 402     {
 403         msg_Warn( p_playlist, "failed to read directory" );
 404         return VLC_EGENERIC;
 405     }
 406     else if( i_dir_content <= 0 )
 407     {
 408         /* directory is empty */
 409         if( pp_dir_content ) free( pp_dir_content );
 410         return VLC_SUCCESS;
 411     }
 412
 413     /* Build array with ignores */
 414     psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
 415     if( psz_ignore && *psz_ignore )
 416     {
 417         char *psz_parser = psz_ignore;
 418         int a;
 419
 420         for( a = 0; psz_parser[a] != '\0'; a++ )
 421         {
 422             if( psz_parser[a] == ',' ) i_extensions++;
 423         }
 424
 425         ppsz_extensions = (char **)malloc( sizeof( char * ) * i_extensions );
 426
 427         for( a = 0; a < i_extensions; a++ )
 428         {
 429             char *tmp, *ptr;
 430
 431             while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
 432             ptr = strchr( psz_parser, ',');
 433             tmp = ( ptr == NULL )
 434                  ? strdup( psz_parser )
 435                  : strndup( psz_parser, ptr - psz_parser );
 436
 437             ppsz_extensions[a] = tmp;
 438             psz_parser = ptr + 1;
 439         }
 440     }
 441
 442     /* While we still have entries in the directory */
 443     for( i = 0; i < i_dir_content; i++ )
 444     {
 445         struct dirent *p_dir_content = pp_dir_content[i];
 446         int i_size_entry = strlen( psz_name ) +
 447                            strlen( p_dir_content->d_name ) + 2;
 448         char *psz_uri = (char *)malloc( sizeof(char) * i_size_entry );
 449
 450         sprintf( psz_uri, "%s/%s", psz_name, p_dir_content->d_name );
 451
 452         /* if it starts with '.' then forget it */
 453         if( p_dir_content->d_name[0] != '.' )
 454         {
 455 #if defined( S_ISDIR )
 456             struct stat stat_data;
 457
 458             if( !stat( psz_uri, &stat_data )
 459              && S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
 460 #elif defined( DT_DIR )
 461             if( ( p_dir_content->d_type & DT_DIR ) && i_mode != MODE_COLLAPSE )
 462 #else
 463             if( 0 )
 464 #endif
 465             {
 466 #if defined( S_ISLNK )
 467 /*
 468  * FIXME: there is a ToCToU race condition here; but it is rather tricky
 469  * impossible to fix while keeping some kind of portable code, and maybe even
 470  * in a non-portable way.
 471  */
 472                 if( lstat( psz_uri, &stat_data )
 473                  || S_ISLNK(stat_data.st_mode) )
 474                 {
 475                     msg_Dbg( p_playlist, "skipping directory symlink %s",
 476                              psz_uri );
 477                     free( psz_uri );
 478                     continue;
 479                 }
 480 #endif
 481                 if( i_mode == MODE_NONE )
 482                 {
 483                     msg_Dbg( p_playlist, "skipping subdirectory %s", psz_uri );
 484                     free( psz_uri );
 485                     continue;
 486                 }
 487                 else if( i_mode == MODE_EXPAND )
 488                 {
 489                     char *psz_newname, *psz_tmp;
 490                     msg_Dbg(p_playlist, "reading subdirectory %s", psz_uri );
 491
 492                     psz_tmp = FromLocale( p_dir_content->d_name );
 493                     psz_newname = vlc_fix_readdir_charset(
 494                                                 p_playlist, psz_tmp );
 495                     LocaleFree( psz_tmp );
 496
 497                     if( p_parent_category )
 498                     {
 499                         p_node = playlist_NodeCreate( p_playlist, psz_newname,
 500                                                       p_parent_category );
 501                     }
 502                     else
 503                     {
 504                         p_node = playlist_NodeCreate( p_playlist, psz_newname,
 505                                                       p_parent_category );
 506                     }
 507
 508                     /* an strdup() just because of Mac OS X */
 509                     free( psz_newname );
 510
 511                     /* If we had the parent in category, the it is now node.
 512                      * Else, we still don't have  */
 513                     if( ReadDir( p_playlist, psz_uri , MODE_EXPAND,
 514                                  p_node, p_parent_category ? p_node : NULL )
 515                           != VLC_SUCCESS )
 516                     {
 517                         i_return = VLC_EGENERIC;
 518                         break;
 519                     }
 520                 }
 521             }
 522             else
 523             {
 524                 input_item_t *p_input;
 525                 char *psz_tmp1, *psz_tmp2, *psz_loc;
 526
 527                 if( i_extensions > 0 )
 528                 {
 529                     char *psz_dot = strrchr( p_dir_content->d_name, '.' );
 530                     if( psz_dot++ && *psz_dot )
 531                     {
 532                         int a;
 533                         for( a = 0; a < i_extensions; a++ )
 534                         {
 535                             if( !strcmp( psz_dot, ppsz_extensions[a] ) )
 536                                 break;
 537                         }
 538                         if( a < i_extensions )
 539                         {
 540                             msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
 541                             free( psz_uri );
 542                             continue;
 543                         }
 544                     }
 545                 }
 546
 547                 psz_loc = FromLocale( psz_uri );
 548                 psz_tmp1 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
 549                                                     psz_loc );
 550                 LocaleFree( psz_loc );
 551
 552                 psz_loc = FromLocale( p_dir_content->d_name );
 553                 psz_tmp2 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
 554                                                     psz_loc );
 555                 LocaleFree( psz_loc );
 556
 557                 p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist),
 558                                                  psz_tmp1, psz_tmp2, 0, NULL,
 559                                                  -1, ITEM_TYPE_VFILE );
 560
 561                 playlist_AddWhereverNeeded( p_playlist, p_input, p_parent,
 562                                             p_parent_category, VLC_FALSE,
 563                                             PLAYLIST_APPEND|PLAYLIST_PREPARSE);
 564             }
 565         }
 566         free( psz_uri );
 567     }
 568
 569     for( i = 0; i < i_extensions; i++ )
 570         if( ppsz_extensions[i] ) free( ppsz_extensions[i] );
 571     if( ppsz_extensions ) free( ppsz_extensions );
 572
 573     if( psz_ignore ) free( psz_ignore );
 574
 575     for( i = 0; i < i_dir_content; i++ )
 576         if( pp_dir_content[i] ) free( pp_dir_content[i] );
 577     if( pp_dir_content ) free( pp_dir_content );
 578
 579     return i_return;
 580 }