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
  32 #include <stdlib.h>
  33 #include <string.h>
  34 #ifdef HAVE_SYS_TYPES_H
  35 #   include <sys/types.h>
  36 #endif
  37 #ifdef HAVE_SYS_STAT_H
  38 #   include <sys/stat.h>
  39 #endif
  40 #ifdef HAVE_ERRNO_H
  41 #   include <errno.h>
  42 #endif
  43 #ifdef HAVE_FCNTL_H
  44 #   include <fcntl.h>
  45 #endif
  46
  47 #ifdef HAVE_UNISTD_H
  48 #   include <unistd.h>
  49 #elif defined( WIN32 ) && !defined( UNDER_CE )
  50 #   include <io.h>
  51 #elif defined( UNDER_CE )
  52 #   define strcoll strcmp
  53 #endif
  54
  55 #ifdef HAVE_DIRENT_H
  56 #   include <dirent.h>
  57 #endif
  58
  59 #include "charset.h"
  60
  61 /*****************************************************************************
  62  * Module descriptor
  63  *****************************************************************************/
  64 static int  Open ( vlc_object_t * );
  65 static void Close( vlc_object_t * );
  66
  67 static int  DemuxOpen ( vlc_object_t * );
  68
  69 #define RECURSIVE_TEXT N_("Subdirectory behavior")
  70 #define RECURSIVE_LONGTEXT N_( \
  71         "Select whether subdirectories must be expanded.\n" \
  72         "none: subdirectories do not appear in the playlist.\n" \
  73         "collapse: subdirectories appear but are expanded on first play.\n" \
  74         "expand: all subdirectories are expanded.\n" )
  75
  76 static char *psz_recursive_list[] = { "none", "collapse", "expand" };
  77 static char *psz_recursive_list_text[] = { N_("none"), N_("collapse"),
  78                                            N_("expand") };
  79
  80 #define IGNORE_TEXT N_("Ignore files with these extensions")
  81 #define IGNORE_LONGTEXT N_( \
  82         "Specify a comma seperated list of file extensions. " \
  83         "Files with these extensions will not be added to playlist when opening a directory. " \
  84         "This is useful if you add directories that contain mp3 albums for instance." )
  85
  86 vlc_module_begin();
  87     set_category( CAT_INPUT );
  88     set_shortname( _("Directory" ) );
  89     set_subcategory( SUBCAT_INPUT_ACCESS );
  90     set_description( _("Standard filesystem directory input") );
  91     set_capability( "access2", 55 );
  92     add_shortcut( "directory" );
  93     add_shortcut( "dir" );
  94     add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
  95                 RECURSIVE_LONGTEXT, VLC_FALSE );
  96       change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
  97     add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
  98                 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, VLC_FALSE );
  99     set_callbacks( Open, Close );
 100
 101     add_submodule();
 102         set_description( "Directory EOF");
 103         set_capability( "demux2", 0 );
 104         add_shortcut( "directory" );
 105         set_callbacks( DemuxOpen, NULL );
 106 vlc_module_end();
 107
 108
 109 /*****************************************************************************
 110  * Local prototypes, constants, structures
 111  *****************************************************************************/
 112
 113 #define MODE_EXPAND 0
 114 #define MODE_COLLAPSE 1
 115 #define MODE_NONE 2
 116
 117 static int Read( access_t *, uint8_t *, int );
 118 static int ReadNull( access_t *, uint8_t *, int );
 119 static int Control( access_t *, int, va_list );
 120
 121 static int Demux( demux_t *p_demux );
 122 static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
 123
 124
 125 static int ReadDir( playlist_t *, const char *psz_name, int i_mode,
 126                     playlist_item_t * );
 127
 128 /*****************************************************************************
 129  * Open: open the directory
 130  *****************************************************************************/
 131 static int Open( vlc_object_t *p_this )
 132 {
 133     access_t *p_access = (access_t*)p_this;
 134
 135 #ifdef HAVE_SYS_STAT_H
 136     struct stat stat_info;
 137     char *psz_path = ToLocale( p_access->psz_path );
 138
 139     if( ( stat( psz_path, &stat_info ) == -1 ) ||
 140         !S_ISDIR( stat_info.st_mode ) )
 141 #elif defined(WIN32)
 142     int i_ret;
 143
 144 #   ifdef UNICODE
 145     wchar_t psz_path[MAX_PATH];
 146     mbstowcs( psz_path, p_access->psz_path, MAX_PATH );
 147     psz_path[MAX_PATH-1] = 0;
 148 #   else
 149     char *psz_path = p_access->psz_path;
 150 #   endif /* UNICODE */
 151
 152     i_ret = GetFileAttributes( psz_path );
 153     if( i_ret == -1 || !(i_ret & FILE_ATTRIBUTE_DIRECTORY) )
 154
 155 #else
 156     if( strcmp( p_access->psz_access, "dir") &&
 157         strcmp( p_access->psz_access, "directory") )
 158 #endif
 159     {
 160         LocaleFree( psz_path );
 161         return VLC_EGENERIC;
 162     }
 163
 164     LocaleFree( psz_path );
 165     p_access->pf_read  = Read;
 166     p_access->pf_block = NULL;
 167     p_access->pf_seek  = NULL;
 168     p_access->pf_control= Control;
 169
 170     /* Force a demux */
 171     p_access->psz_demux = strdup( "directory" );
 172
 173     return VLC_SUCCESS;
 174 }
 175
 176 /*****************************************************************************
 177  * Close: close the target
 178  *****************************************************************************/
 179 static void Close( vlc_object_t * p_this )
 180 {
 181 }
 182
 183 /*****************************************************************************
 184  * ReadNull: read the directory
 185  *****************************************************************************/
 186 static int ReadNull( access_t *p_access, uint8_t *p_buffer, int i_len)
 187 {
 188     /* Return fake data */
 189     memset( p_buffer, 0, i_len );
 190     return i_len;
 191 }
 192
 193 /*****************************************************************************
 194  * Read: read the directory
 195  *****************************************************************************/
 196 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len)
 197 {
 198     char *psz_name = NULL;
 199     char *psz;
 200     int  i_mode, i_pos;
 201
 202     playlist_item_t *p_item;
 203     vlc_bool_t b_play = VLC_FALSE;
 204
 205     playlist_t *p_playlist =
 206         (playlist_t *) vlc_object_find( p_access,
 207                                         VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
 208
 209     if( !p_playlist )
 210     {
 211         msg_Err( p_access, "can't find playlist" );
 212         goto end;
 213     }
 214     else
 215     {
 216         char *ptr;
 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
 239     /* Initialize structure */
 240     psz = var_CreateGetString( p_access, "recursive" );
 241     if( *psz == '\0' || !strncmp( psz, "none" , 4 )  )
 242     {
 243         i_mode = MODE_NONE;
 244     }
 245     else if( !strncmp( psz, "collapse", 8 )  )
 246     {
 247         i_mode = MODE_COLLAPSE;
 248     }
 249     else
 250     {
 251         i_mode = MODE_EXPAND;
 252     }
 253     free( psz );
 254
 255     /* Make sure we are deleted when we are done */
 256     /* The playlist position we will use for the add */
 257     i_pos = p_playlist->i_index + 1;
 258
 259     msg_Dbg( p_access, "opening directory `%s'", p_access->psz_path );
 260
 261     if( &p_playlist->status.p_item->input ==
 262         ((input_thread_t *)p_access->p_parent)->input.p_item )
 263     {
 264         p_item = p_playlist->status.p_item;
 265         b_play = VLC_TRUE;
 266         msg_Dbg( p_access, "starting directory playback");
 267     }
 268     else
 269     {
 270         input_item_t *p_current = ( (input_thread_t*)p_access->p_parent)->
 271                                                         input.p_item;
 272         p_item = playlist_LockItemGetByInput( p_playlist, p_current );
 273         msg_Dbg( p_access, "not starting directory playback");
 274         if( !p_item )
 275         {
 276             msg_Dbg( p_playlist, "unable to find item in playlist");
 277             return -1;
 278         }
 279         b_play = VLC_FALSE;
 280     }
 281
 282     p_item->input.i_type = ITEM_TYPE_DIRECTORY;
 283     if( ReadDir( p_playlist, psz_name , i_mode, p_item ) != VLC_SUCCESS )
 284     {
 285     }
 286 end:
 287
 288     /* Begin to read the directory */
 289     if( b_play )
 290     {
 291         playlist_Control( p_playlist, PLAYLIST_VIEWPLAY,
 292                           p_playlist->status.i_view,
 293                           p_playlist->status.p_item, NULL );
 294     }
 295     if( psz_name ) free( psz_name );
 296     vlc_object_release( p_playlist );
 297
 298     /* Return fake data forever */
 299     p_access->pf_read = ReadNull;
 300     return ReadNull( p_access, p_buffer, i_len );
 301 }
 302
 303 /*****************************************************************************
 304  * DemuxOpen:
 305  *****************************************************************************/
 306 static int Control( access_t *p_access, int i_query, va_list args )
 307 {
 308     vlc_bool_t   *pb_bool;
 309     int          *pi_int;
 310     int64_t      *pi_64;
 311
 312     switch( i_query )
 313     {
 314         /* */
 315         case ACCESS_CAN_SEEK:
 316         case ACCESS_CAN_FASTSEEK:
 317         case ACCESS_CAN_PAUSE:
 318         case ACCESS_CAN_CONTROL_PACE:
 319             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 320             *pb_bool = VLC_FALSE;    /* FIXME */
 321             break;
 322
 323         /* */
 324         case ACCESS_GET_MTU:
 325             pi_int = (int*)va_arg( args, int * );
 326             *pi_int = 0;
 327             break;
 328
 329         case ACCESS_GET_PTS_DELAY:
 330             pi_64 = (int64_t*)va_arg( args, int64_t * );
 331             *pi_64 = DEFAULT_PTS_DELAY * 1000;
 332             break;
 333
 334         /* */
 335         case ACCESS_SET_PAUSE_STATE:
 336         case ACCESS_GET_TITLE_INFO:
 337         case ACCESS_SET_TITLE:
 338         case ACCESS_SET_SEEKPOINT:
 339         case ACCESS_SET_PRIVATE_ID_STATE:
 340             return VLC_EGENERIC;
 341
 342         default:
 343             msg_Warn( p_access, "unimplemented query in control" );
 344             return VLC_EGENERIC;
 345     }
 346     return VLC_SUCCESS;
 347 }
 348
 349 /*****************************************************************************
 350  * DemuxOpen:
 351  *****************************************************************************/
 352 static int DemuxOpen ( vlc_object_t *p_this )
 353 {
 354     demux_t *p_demux = (demux_t*)p_this;
 355
 356     if( strcmp( p_demux->psz_demux, "directory" ) )
 357         return VLC_EGENERIC;
 358
 359     p_demux->pf_demux   = Demux;
 360     p_demux->pf_control = DemuxControl;
 361     return VLC_SUCCESS;
 362 }
 363
 364 /*****************************************************************************
 365  * Demux: EOF
 366  *****************************************************************************/
 367 static int Demux( demux_t *p_demux )
 368 {
 369     return 0;
 370 }
 371
 372 /*****************************************************************************
 373  * DemuxControl:
 374  *****************************************************************************/
 375 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
 376 {
 377     return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
 378 }
 379
 380 static int Filter( const struct dirent *foo )
 381 {
 382     return VLC_TRUE;
 383 }
 384
 385 /*****************************************************************************
 386  * ReadDir: read a directory and add its content to the list
 387  *****************************************************************************/
 388 static int ReadDir( playlist_t *p_playlist, const char *psz_name,
 389                     int i_mode, playlist_item_t *p_parent )
 390 {
 391     struct dirent   **pp_dir_content;
 392     int             i_dir_content, i;
 393     playlist_item_t *p_node;
 394
 395     /* Build array with ignores */
 396     char **ppsz_extensions = 0;
 397     int i_extensions = 0;
 398     char *psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
 399     if( psz_ignore && *psz_ignore )
 400     {
 401         char *psz_parser = psz_ignore;
 402         int a;
 403
 404         for( a = 0; psz_parser[a] != '\0'; a++ )
 405         {
 406             if( psz_parser[a] == ',' ) i_extensions++;
 407         }
 408
 409         ppsz_extensions = (char **)malloc( sizeof( char * ) * i_extensions );
 410
 411         for( a = 0; a < i_extensions; a++ )
 412         {
 413             int b;
 414             char *tmp;
 415
 416             while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
 417             for( b = 0; psz_parser[b] != '\0'; b++ )
 418             {
 419                 if( psz_parser[b] == ',' ) break;
 420             }
 421             tmp = malloc( b + 1 );
 422             strncpy( tmp, psz_parser, b );
 423             tmp[b] = 0;
 424             ppsz_extensions[a] = tmp;
 425             psz_parser += b+1;
 426         }
 427     }
 428
 429     /* Change the item to a node */
 430     if( p_parent->i_children == -1 )
 431     {
 432         playlist_LockItemToNode( p_playlist,p_parent );
 433     }
 434
 435     /* get the first directory entry */
 436     i_dir_content = scandir( psz_name, &pp_dir_content, Filter, alphasort );
 437     if( i_dir_content == -1 )
 438     {
 439         msg_Warn( p_playlist, "Failed to read directory" );
 440         return VLC_EGENERIC;
 441     }
 442     else if( i_dir_content <= 0 )
 443     {
 444         /* directory is empty */
 445         return VLC_SUCCESS;
 446     }
 447
 448     /* While we still have entries in the directory */
 449     for( i = 0; i < i_dir_content; i++ )
 450     {
 451         struct dirent *p_dir_content = pp_dir_content[i];
 452         int i_size_entry = strlen( psz_name ) +
 453                            strlen( p_dir_content->d_name ) + 2;
 454         char *psz_uri = (char *)malloc( sizeof(char) * i_size_entry );
 455
 456         sprintf( psz_uri, "%s/%s", psz_name, p_dir_content->d_name );
 457
 458         /* if it starts with '.' then forget it */
 459         if( p_dir_content->d_name[0] != '.' )
 460         {
 461 #if defined( S_ISDIR )
 462             struct stat stat_data;
 463
 464             if( !stat( psz_uri, &stat_data )
 465              && S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
 466 #elif defined( DT_DIR )
 467             if( ( p_dir_content->d_type & DT_DIR ) && i_mode != MODE_COLLAPSE )
 468 #else
 469             if( 0 )
 470 #endif
 471             {
 472 #if defined( S_ISLNK )
 473 /*
 474  * FIXME: there is a ToCToU race condition here; but it is rather tricky
 475  * impossible to fix while keeping some kind of portable code, and maybe even
 476  * in a non-portable way.
 477  */
 478                 if( lstat( psz_uri, &stat_data )
 479                  || S_ISLNK(stat_data.st_mode) )
 480                 {
 481                     msg_Dbg( p_playlist, "Skipping directory symlink %s",
 482                              psz_uri );
 483                     free( psz_uri );
 484                     continue;
 485                 }
 486 #endif
 487                 if( i_mode == MODE_NONE )
 488                 {
 489                     msg_Dbg( p_playlist, "Skipping subdirectory %s", psz_uri );
 490                     free( psz_uri );
 491                     continue;
 492                 }
 493                 else if( i_mode == MODE_EXPAND )
 494                 {
 495                     char *psz_newname, *psz_tmp;
 496                     msg_Dbg(p_playlist, "Reading subdirectory %s", psz_uri );
 497
 498                     psz_tmp = FromLocale( p_dir_content->d_name );
 499                     psz_newname = vlc_fix_readdir_charset(
 500                                                 p_playlist, psz_tmp );
 501                     LocaleFree( psz_tmp );
 502
 503                     p_node = playlist_NodeCreate( p_playlist,
 504                                        p_parent->pp_parents[0]->i_view,
 505                                        psz_newname, p_parent );
 506
 507                     playlist_CopyParents(  p_parent, p_node );
 508
 509                     p_node->input.i_type = ITEM_TYPE_DIRECTORY;
 510
 511                     if( ReadDir( p_playlist, psz_uri , MODE_EXPAND,
 512                                  p_node ) != VLC_SUCCESS )
 513                     {
 514                         return VLC_EGENERIC;
 515                     }
 516
 517                     /* an strdup() just because of Mac OS X */
 518                     free( psz_newname );
 519                 }
 520             }
 521             else
 522             {
 523                 playlist_item_t *p_item;
 524                 char *psz_tmp1, *psz_tmp2, *psz_loc;
 525
 526                 if( i_extensions > 0 )
 527                 {
 528                     char *psz_dot = strrchr( p_dir_content->d_name, '.' );
 529                     if( psz_dot++ && *psz_dot )
 530                     {
 531                         int a;
 532                         for( a = 0; a < i_extensions; a++ )
 533                         {
 534                             if( !strcmp( psz_dot, ppsz_extensions[a] ) )
 535                                 break;
 536                         }
 537                         if( a < i_extensions )
 538                         {
 539                             msg_Dbg( p_playlist, "Ignoring file %s", psz_uri );
 540                             free( psz_uri );
 541                             continue;
 542                         }
 543                     }
 544                 }
 545
 546                 psz_loc = FromLocale( psz_uri );
 547                 psz_tmp1 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
 548                                                     psz_loc );
 549                 LocaleFree( psz_loc );
 550
 551                 psz_loc = FromLocale( p_dir_content->d_name );
 552                 psz_tmp2 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
 553                                                     psz_loc );
 554                 LocaleFree( psz_loc );
 555
 556                 p_item = playlist_ItemNewWithType( VLC_OBJECT(p_playlist),
 557                         psz_tmp1, psz_tmp2, ITEM_TYPE_VFILE );
 558                 playlist_NodeAddItem( p_playlist,p_item,
 559                                       p_parent->pp_parents[0]->i_view,
 560                                       p_parent,
 561                                       PLAYLIST_APPEND | PLAYLIST_PREPARSE,
 562                                       PLAYLIST_END );
 563
 564                 playlist_CopyParents( p_parent, p_item );
 565             }
 566         }
 567         free( psz_uri );
 568     }
 569
 570     for( i = 0; i < i_extensions; i++ )
 571     {
 572         if( ppsz_extensions[i] )
 573             free( ppsz_extensions[i] );
 574     }
 575     if( ppsz_extensions ) free( ppsz_extensions );
 576     if( psz_ignore ) free( psz_ignore );
 577
 578     for( i = 0; i < i_dir_content; i++ )
 579         if( pp_dir_content[i] ) free( pp_dir_content[i] );
 580     if( pp_dir_content ) free( pp_dir_content );
 581     return VLC_SUCCESS;
 582 }