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., 59 Temple Place - Suite 330, Boston, MA  02111, 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 #ifdef HAVE_STRSEP
  98     add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
  99                 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, VLC_FALSE );
 100 #endif
 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 *, char *psz_name, int i_mode, int *pi_pos,
 128                     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
 140     if( ( stat( p_access->psz_path, &stat_info ) == -1 ) ||
 141         !S_ISDIR( stat_info.st_mode ) )
 142
 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         return VLC_EGENERIC;
 163     }
 164
 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
 215     /* Remove the ending '/' char */
 216     psz_name = strdup( p_access->psz_path );
 217     if( psz_name == NULL )
 218         goto end;
 219
 220     if( (psz_name[strlen(psz_name)-1] == '/') ||
 221         (psz_name[strlen(psz_name)-1] == '\\') )
 222     {
 223         psz_name[strlen(psz_name)-1] = '\0';
 224     }
 225
 226     /* Initialize structure */
 227     psz = var_CreateGetString( p_access, "recursive" );
 228     if( *psz == '\0' || !strncmp( psz, "none" , 4 )  )
 229     {
 230         i_mode = MODE_NONE;
 231     }
 232     else if( !strncmp( psz, "collapse", 8 )  )
 233     {
 234         i_mode = MODE_COLLAPSE;
 235     }
 236     else
 237     {
 238         i_mode = MODE_EXPAND;
 239     }
 240     free( psz );
 241
 242     /* Make sure we are deleted when we are done */
 243     /* The playlist position we will use for the add */
 244     i_pos = p_playlist->i_index + 1;
 245
 246     msg_Dbg( p_access, "opening directory `%s'", psz_name );
 247
 248     if( &p_playlist->status.p_item->input ==
 249         ((input_thread_t *)p_access->p_parent)->input.p_item )
 250     {
 251         p_item = p_playlist->status.p_item;
 252         b_play = VLC_TRUE;
 253         msg_Dbg( p_access, "starting directory playback");
 254     }
 255     else
 256     {
 257         input_item_t *p_current = ( (input_thread_t*)p_access->p_parent)->
 258                                                         input.p_item;
 259         p_item = playlist_LockItemGetByInput( p_playlist, p_current );
 260         msg_Dbg( p_access, "not starting directory playback");
 261         if( !p_item )
 262         {
 263             msg_Dbg( p_playlist, "unable to find item in playlist");
 264             return -1;
 265         }
 266         b_play = VLC_FALSE;
 267     }
 268
 269     p_item->input.i_type = ITEM_TYPE_DIRECTORY;
 270     if( ReadDir( p_playlist, psz_name , i_mode, &i_pos,
 271                  p_item ) != VLC_SUCCESS )
 272     {
 273     }
 274 end:
 275
 276     /* Begin to read the directory */
 277     if( b_play )
 278     {
 279         playlist_Control( p_playlist, PLAYLIST_VIEWPLAY,
 280                           p_playlist->status.i_view,
 281                           p_playlist->status.p_item, NULL );
 282     }
 283     if( psz_name ) free( psz_name );
 284     vlc_object_release( p_playlist );
 285
 286     /* Return fake data forever */
 287     p_access->pf_read = ReadNull;
 288     return ReadNull( p_access, p_buffer, i_len );
 289 }
 290
 291 /*****************************************************************************
 292  * DemuxOpen:
 293  *****************************************************************************/
 294 static int Control( access_t *p_access, int i_query, va_list args )
 295 {
 296     vlc_bool_t   *pb_bool;
 297     int          *pi_int;
 298     int64_t      *pi_64;
 299
 300     switch( i_query )
 301     {
 302         /* */
 303         case ACCESS_CAN_SEEK:
 304         case ACCESS_CAN_FASTSEEK:
 305         case ACCESS_CAN_PAUSE:
 306         case ACCESS_CAN_CONTROL_PACE:
 307             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 308             *pb_bool = VLC_FALSE;    /* FIXME */
 309             break;
 310
 311         /* */
 312         case ACCESS_GET_MTU:
 313             pi_int = (int*)va_arg( args, int * );
 314             *pi_int = 0;
 315             break;
 316
 317         case ACCESS_GET_PTS_DELAY:
 318             pi_64 = (int64_t*)va_arg( args, int64_t * );
 319             *pi_64 = DEFAULT_PTS_DELAY * 1000;
 320             break;
 321
 322         /* */
 323         case ACCESS_SET_PAUSE_STATE:
 324         case ACCESS_GET_TITLE_INFO:
 325         case ACCESS_SET_TITLE:
 326         case ACCESS_SET_SEEKPOINT:
 327         case ACCESS_SET_PRIVATE_ID_STATE:
 328             return VLC_EGENERIC;
 329
 330         default:
 331             msg_Warn( p_access, "unimplemented query in control" );
 332             return VLC_EGENERIC;
 333     }
 334     return VLC_SUCCESS;
 335 }
 336
 337 /*****************************************************************************
 338  * DemuxOpen:
 339  *****************************************************************************/
 340 static int DemuxOpen ( vlc_object_t *p_this )
 341 {
 342     demux_t *p_demux = (demux_t*)p_this;
 343
 344     if( strcmp( p_demux->psz_demux, "directory" ) )
 345         return VLC_EGENERIC;
 346
 347     p_demux->pf_demux   = Demux;
 348     p_demux->pf_control = DemuxControl;
 349     return VLC_SUCCESS;
 350 }
 351
 352 /*****************************************************************************
 353  * Demux: EOF
 354  *****************************************************************************/
 355 static int Demux( demux_t *p_demux )
 356 {
 357     return 0;
 358 }
 359 /*****************************************************************************
 360  * DemuxControl:
 361  *****************************************************************************/
 362 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
 363 {
 364     return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
 365 }
 366
 367 #if defined(SYS_BEOS) || defined(WIN32) || defined(SYS_SOLARIS)
 368 /* BeOS doesn't have scandir/alphasort/versionsort */
 369 static int alphasort( const struct dirent **a, const struct dirent **b )
 370 {
 371     return strcoll( (*a)->d_name, (*b)->d_name );
 372 }
 373
 374 static int scandir( const char *name, struct dirent ***namelist,
 375                     int (*filter) ( const struct dirent * ),
 376                     int (*compar) ( const struct dirent **,
 377                                     const struct dirent ** ) )
 378 {
 379     DIR            * p_dir;
 380     struct dirent  * p_content;
 381     struct dirent ** pp_list;
 382     int              ret, size;
 383
 384     if( !namelist || !( p_dir = opendir( name ) ) ) return -1;
 385
 386     ret     = 0;
 387     pp_list = NULL;
 388     while( ( p_content = readdir( p_dir ) ) )
 389     {
 390         if( filter && !filter( p_content ) )
 391         {
 392             continue;
 393         }
 394         pp_list = realloc( pp_list, ( ret + 1 ) * sizeof( struct dirent * ) );
 395         size = sizeof( struct dirent ) + strlen( p_content->d_name ) + 1;
 396         pp_list[ret] = malloc( size );
 397         memcpy( pp_list[ret], p_content, size );
 398         ret++;
 399     }
 400
 401     closedir( p_dir );
 402
 403     if( compar )
 404     {
 405         qsort( pp_list, ret, sizeof( struct dirent * ),
 406                (int (*)(const void *, const void *)) compar );
 407     }
 408
 409     *namelist = pp_list;
 410     return ret;
 411 }
 412 #endif
 413
 414 static int Filter( const struct dirent *foo )
 415 {
 416     return VLC_TRUE;
 417 }
 418 /*****************************************************************************
 419  * ReadDir: read a directory and add its content to the list
 420  *****************************************************************************/
 421 static int ReadDir( playlist_t *p_playlist,
 422                     char *psz_name, int i_mode, int *pi_position,
 423                     playlist_item_t *p_parent )
 424 {
 425     struct dirent   **pp_dir_content;
 426     int             i_dir_content, i;
 427     playlist_item_t *p_node;
 428
 429     /* Build array with ignores */
 430 #ifdef HAVE_STRSEP
 431     char **ppsz_extensions = 0;
 432     int i_extensions = 0;
 433     char *psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
 434     if( psz_ignore && *psz_ignore )
 435     {
 436         char *psz_backup;
 437         char *psz_parser = psz_backup = strdup( psz_ignore );
 438         int a = 0;
 439
 440         while( strsep( &psz_parser, "," ) ) i_extensions++;
 441         free( psz_backup );
 442
 443         ppsz_extensions = (char **)malloc( sizeof( char * ) * i_extensions );
 444
 445         psz_parser = psz_ignore;
 446         while( a < i_extensions &&
 447                ( ppsz_extensions[a++] = strsep( &psz_parser, "," ) ) );
 448     }
 449 #endif /* HAVE_STRSEP */
 450
 451     /* Change the item to a node */
 452     if( p_parent->i_children == -1 )
 453     {
 454         playlist_LockItemToNode( p_playlist,p_parent );
 455     }
 456
 457     /* get the first directory entry */
 458     i_dir_content = scandir( psz_name, &pp_dir_content, Filter, alphasort );
 459     if( i_dir_content == -1 )
 460     {
 461         msg_Warn( p_playlist, "Failed to read directory" );
 462         return VLC_EGENERIC;
 463     }
 464     else if( i_dir_content <= 0 )
 465     {
 466         /* directory is empty */
 467         return VLC_SUCCESS;
 468     }
 469
 470     /* While we still have entries in the directory */
 471     for( i = 0; i < i_dir_content; i++ )
 472     {
 473         struct dirent *p_dir_content = pp_dir_content[i];
 474         int i_size_entry = strlen( psz_name ) +
 475                            strlen( p_dir_content->d_name ) + 2;
 476         char *psz_uri = (char *)malloc( sizeof(char) * i_size_entry );
 477
 478         sprintf( psz_uri, "%s/%s", psz_name, p_dir_content->d_name );
 479
 480         /* if it starts with '.' then forget it */
 481         if( p_dir_content->d_name[0] != '.' )
 482         {
 483 #if defined( S_ISDIR )
 484             struct stat stat_data;
 485             stat( psz_uri, &stat_data );
 486             if( S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
 487 #elif defined( DT_DIR )
 488             if( ( p_dir_content->d_type & DT_DIR ) && i_mode != MODE_COLLAPSE )
 489 #else
 490             if( 0 )
 491 #endif
 492             {
 493                 if( i_mode == MODE_NONE )
 494                 {
 495                     msg_Dbg( p_playlist, "Skipping subdirectory %s", psz_uri );
 496                     free( psz_uri );
 497                     continue;
 498                 }
 499                 else if( i_mode == MODE_EXPAND )
 500                 {
 501                     char *psz_newname;
 502                     msg_Dbg(p_playlist, "Reading subdirectory %s", psz_uri );
 503
 504                     if( !strncmp( psz_uri, psz_name, strlen( psz_name ) ) )
 505                     {
 506                         char *psz_subdir = psz_uri;
 507                         /* Skip the parent path + the separator */
 508                         psz_subdir += strlen( psz_name ) + 1;
 509                         psz_newname = vlc_fix_readdir_charset(
 510                                                 VLC_OBJECT(p_playlist),
 511                                                 psz_subdir );
 512                     }
 513                     else
 514                     {
 515                         psz_newname = vlc_fix_readdir_charset(
 516                                                 VLC_OBJECT(p_playlist),
 517                                                 psz_name );
 518                     }
 519                     p_node = playlist_NodeCreate( p_playlist,
 520                                        p_parent->pp_parents[0]->i_view,
 521                                        psz_newname, p_parent );
 522
 523                     playlist_CopyParents(  p_parent, p_node );
 524
 525                     p_node->input.i_type = ITEM_TYPE_DIRECTORY;
 526
 527                     if( ReadDir( p_playlist, psz_uri , MODE_EXPAND,
 528                                  pi_position, p_node ) != VLC_SUCCESS )
 529                     {
 530                         return VLC_EGENERIC;
 531                     }
 532
 533                     free( psz_newname );
 534                 }
 535             }
 536             else
 537             {
 538                 playlist_item_t *p_item;
 539                 char *psz_tmp1, *psz_tmp2;
 540
 541 #ifdef HAVE_STRSEP
 542                 if( i_extensions > 0 )
 543                 {
 544                     char *psz_dot = strrchr( p_dir_content->d_name, '.' );
 545                     if( psz_dot++ && *psz_dot )
 546                     {
 547                         int a;
 548                         for( a = 0; a < i_extensions; a++ )
 549                         {
 550                             if( !strcmp( psz_dot, ppsz_extensions[a] ) )
 551                                 break;
 552                         }
 553                         if( a < i_extensions )
 554                         {
 555                             msg_Dbg( p_playlist, "Ignoring file %s", psz_uri );
 556                             free( psz_uri );
 557                             continue;
 558                         }
 559                     }
 560                 }
 561 #endif /* HAVE_STRSEP */
 562
 563                 psz_tmp1 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
 564                                                     psz_uri );
 565                 psz_tmp2 = vlc_fix_readdir_charset( VLC_OBJECT(p_playlist),
 566                                                     p_dir_content->d_name );
 567
 568                 p_item = playlist_ItemNewWithType( VLC_OBJECT(p_playlist),
 569                         psz_tmp1, psz_tmp2, ITEM_TYPE_VFILE );
 570                 playlist_NodeAddItem( p_playlist,p_item,
 571                                       p_parent->pp_parents[0]->i_view,
 572                                       p_parent,
 573                                       PLAYLIST_APPEND, PLAYLIST_END );
 574
 575                 playlist_CopyParents( p_parent, p_item );
 576             }
 577         }
 578         free( psz_uri );
 579     }
 580
 581 #ifdef HAVE_STRSEP
 582     if( ppsz_extensions ) free( ppsz_extensions );
 583     if( psz_ignore ) free( psz_ignore );
 584 #endif /* HAVE_STRSEP */
 585
 586     free( pp_dir_content );
 587     return VLC_SUCCESS;
 588 }