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 /*****************************************************************************
  60  * Module descriptor
  61  *****************************************************************************/
  62 static int  Open ( vlc_object_t * );
  63 static void Close( vlc_object_t * );
  64
  65 static int  DemuxOpen ( vlc_object_t * );
  66
  67 #define RECURSIVE_TEXT N_("Subdirectory behavior")
  68 #define RECURSIVE_LONGTEXT N_( \
  69         "Select whether subdirectories must be expanded.\n" \
  70         "none: subdirectories do not appear in the playlist.\n" \
  71         "collapse: subdirectories appear but are expanded on first play.\n" \
  72         "expand: all subdirectories are expanded.\n" )
  73
  74 static char *psz_recursive_list[] = { "none", "collapse", "expand" };
  75 static char *psz_recursive_list_text[] = { N_("none"), N_("collapse"),
  76                                            N_("expand") };
  77
  78 #define IGNORE_TEXT N_("Ignore files with these extensions")
  79 #define IGNORE_LONGTEXT N_( \
  80         "Specify a comma seperated list of file extensions. " \
  81         "Files with these extensions will not be added to playlist when opening a directory. " \
  82         "This is useful if you add directories that contain mp3 albums for instance." )
  83
  84 vlc_module_begin();
  85     set_category( CAT_INPUT );
  86     set_shortname( _("Directory" ) );
  87     set_subcategory( SUBCAT_INPUT_ACCESS );
  88     set_description( _("Standard filesystem directory input") );
  89     set_capability( "access2", 55 );
  90     add_shortcut( "directory" );
  91     add_shortcut( "dir" );
  92     add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
  93                 RECURSIVE_LONGTEXT, VLC_FALSE );
  94       change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
  95 #ifdef HAVE_STRSEP
  96     add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
  97                 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, VLC_FALSE );
  98 #endif
  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 *, char *psz_name, int i_mode, int *pi_pos,
 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
 138     if( ( stat( p_access->psz_path, &stat_info ) == -1 ) ||
 139         !S_ISDIR( stat_info.st_mode ) )
 140
 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         return VLC_EGENERIC;
 161     }
 162
 163     p_access->pf_read  = Read;
 164     p_access->pf_block = NULL;
 165     p_access->pf_seek  = NULL;
 166     p_access->pf_control= Control;
 167
 168     /* Force a demux */
 169     p_access->psz_demux = strdup( "directory" );
 170
 171     return VLC_SUCCESS;
 172 }
 173
 174 /*****************************************************************************
 175  * Close: close the target
 176  *****************************************************************************/
 177 static void Close( vlc_object_t * p_this )
 178 {
 179 }
 180
 181 /*****************************************************************************
 182  * ReadNull: read the directory
 183  *****************************************************************************/
 184 static int ReadNull( access_t *p_access, uint8_t *p_buffer, int i_len)
 185 {
 186     /* Return fake data */
 187     memset( p_buffer, 0, i_len );
 188     return i_len;
 189 }
 190
 191 /*****************************************************************************
 192  * Read: read the directory
 193  *****************************************************************************/
 194 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len)
 195 {
 196     char *psz_name = NULL;
 197     char *psz;
 198     int  i_mode, i_pos;
 199
 200     playlist_item_t *p_item;
 201     vlc_bool_t b_play = VLC_FALSE;
 202
 203     playlist_t *p_playlist =
 204         (playlist_t *) vlc_object_find( p_access,
 205                                         VLC_OBJECT_PLAYLIST, FIND_ANYWHERE );
 206
 207     if( !p_playlist )
 208     {
 209         msg_Err( p_access, "can't find playlist" );
 210         goto end;
 211     }
 212
 213     /* Remove the ending '/' char */
 214     psz_name = strdup( p_access->psz_path );
 215     if( psz_name == NULL )
 216         goto end;
 217
 218     if( (psz_name[strlen(psz_name)-1] == '/') ||
 219         (psz_name[strlen(psz_name)-1] == '\\') )
 220     {
 221         psz_name[strlen(psz_name)-1] = '\0';
 222     }
 223
 224     /* Initialize structure */
 225     psz = var_CreateGetString( p_access, "recursive" );
 226     if( *psz == '\0' || !strncmp( psz, "none" , 4 )  )
 227     {
 228         i_mode = MODE_NONE;
 229     }
 230     else if( !strncmp( psz, "collapse", 8 )  )
 231     {
 232         i_mode = MODE_COLLAPSE;
 233     }
 234     else
 235     {
 236         i_mode = MODE_EXPAND;
 237     }
 238     free( psz );
 239
 240     /* Make sure we are deleted when we are done */
 241     /* The playlist position we will use for the add */
 242     i_pos = p_playlist->i_index + 1;
 243
 244     msg_Dbg( p_access, "opening directory `%s'", psz_name );
 245
 246     if( &p_playlist->status.p_item->input ==
 247         ((input_thread_t *)p_access->p_parent)->input.p_item )
 248     {
 249         p_item = p_playlist->status.p_item;
 250         b_play = VLC_TRUE;
 251         msg_Dbg( p_access, "starting directory playback");
 252     }
 253     else
 254     {
 255         input_item_t *p_current = ( (input_thread_t*)p_access->p_parent)->
 256                                                         input.p_item;
 257         p_item = playlist_LockItemGetByInput( p_playlist, p_current );
 258         msg_Dbg( p_access, "not starting directory playback");
 259         if( !p_item )
 260         {
 261             msg_Dbg( p_playlist, "unable to find item in playlist");
 262             return -1;
 263         }
 264         b_play = VLC_FALSE;
 265     }
 266
 267     p_item->input.i_type = ITEM_TYPE_DIRECTORY;
 268     if( ReadDir( p_playlist, psz_name , i_mode, &i_pos,
 269                  p_item ) != VLC_SUCCESS )
 270     {
 271     }
 272 end:
 273
 274     /* Begin to read the directory */
 275     if( b_play )
 276     {
 277         playlist_Control( p_playlist, PLAYLIST_VIEWPLAY,
 278                           p_playlist->status.i_view,
 279                           p_playlist->status.p_item, NULL );
 280     }
 281     if( psz_name ) free( psz_name );
 282     vlc_object_release( p_playlist );
 283
 284     /* Return fake data forever */
 285     p_access->pf_read = ReadNull;
 286     return ReadNull( p_access, p_buffer, i_len );
 287 }
 288
 289 /*****************************************************************************
 290  * DemuxOpen:
 291  *****************************************************************************/
 292 static int Control( access_t *p_access, int i_query, va_list args )
 293 {
 294     vlc_bool_t   *pb_bool;
 295     int          *pi_int;
 296     int64_t      *pi_64;
 297
 298     switch( i_query )
 299     {
 300         /* */
 301         case ACCESS_CAN_SEEK:
 302         case ACCESS_CAN_FASTSEEK:
 303         case ACCESS_CAN_PAUSE:
 304         case ACCESS_CAN_CONTROL_PACE:
 305             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 306             *pb_bool = VLC_FALSE;    /* FIXME */
 307             break;
 308
 309         /* */
 310         case ACCESS_GET_MTU:
 311             pi_int = (int*)va_arg( args, int * );
 312             *pi_int = 0;
 313             break;
 314
 315         case ACCESS_GET_PTS_DELAY:
 316             pi_64 = (int64_t*)va_arg( args, int64_t * );
 317             *pi_64 = DEFAULT_PTS_DELAY * 1000;
 318             break;
 319
 320         /* */
 321         case ACCESS_SET_PAUSE_STATE:
 322         case ACCESS_GET_TITLE_INFO:
 323         case ACCESS_SET_TITLE:
 324         case ACCESS_SET_SEEKPOINT:
 325         case ACCESS_SET_PRIVATE_ID_STATE:
 326             return VLC_EGENERIC;
 327
 328         default:
 329             msg_Warn( p_access, "unimplemented query in control" );
 330             return VLC_EGENERIC;
 331     }
 332     return VLC_SUCCESS;
 333 }
 334
 335 /*****************************************************************************
 336  * DemuxOpen:
 337  *****************************************************************************/
 338 static int DemuxOpen ( vlc_object_t *p_this )
 339 {
 340     demux_t *p_demux = (demux_t*)p_this;
 341
 342     if( strcmp( p_demux->psz_demux, "directory" ) )
 343         return VLC_EGENERIC;
 344
 345     p_demux->pf_demux   = Demux;
 346     p_demux->pf_control = DemuxControl;
 347     return VLC_SUCCESS;
 348 }
 349
 350 /*****************************************************************************
 351  * Demux: EOF
 352  *****************************************************************************/
 353 static int Demux( demux_t *p_demux )
 354 {
 355     return 0;
 356 }
 357 /*****************************************************************************
 358  * DemuxControl:
 359  *****************************************************************************/
 360 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
 361 {
 362     return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
 363 }
 364
 365 #if defined(SYS_BEOS) || defined(WIN32)
 366 /* BeOS doesn't have scandir/alphasort/versionsort */
 367 static int alphasort( const struct dirent **a, const struct dirent **b )
 368 {
 369     return strcoll( (*a)->d_name, (*b)->d_name );
 370 }
 371
 372 static int scandir( const char *name, struct dirent ***namelist,
 373                     int (*filter) ( const struct dirent * ),
 374                     int (*compar) ( const struct dirent **,
 375                                     const struct dirent ** ) )
 376 {
 377     DIR            * p_dir;
 378     struct dirent  * p_content;
 379     struct dirent ** pp_list;
 380     int              ret, size;
 381
 382     if( !namelist || !( p_dir = opendir( name ) ) ) return -1;
 383
 384     ret     = 0;
 385     pp_list = NULL;
 386     while( ( p_content = readdir( p_dir ) ) )
 387     {
 388         if( filter && !filter( p_content ) )
 389         {
 390             continue;
 391         }
 392         pp_list = realloc( pp_list, ( ret + 1 ) * sizeof( struct dirent * ) );
 393         size = sizeof( struct dirent ) + strlen( p_content->d_name ) + 1;
 394         pp_list[ret] = malloc( size );
 395         memcpy( pp_list[ret], p_content, size );
 396         ret++;
 397     }
 398
 399     closedir( p_dir );
 400
 401     if( compar )
 402     {
 403         qsort( pp_list, ret, sizeof( struct dirent * ),
 404                (int (*)(const void *, const void *)) compar );
 405     }
 406
 407     *namelist = pp_list;
 408     return ret;
 409 }
 410 #endif
 411
 412 static int Filter( const struct dirent *foo )
 413 {
 414     return VLC_TRUE;
 415 }
 416 /*****************************************************************************
 417  * ReadDir: read a directory and add its content to the list
 418  *****************************************************************************/
 419 static int ReadDir( playlist_t *p_playlist,
 420                     char *psz_name , int i_mode, int *pi_position,
 421                     playlist_item_t *p_parent )
 422 {
 423     struct dirent   **pp_dir_content;
 424     int             i_dir_content, i;
 425     playlist_item_t *p_node;
 426
 427     /* Build array with ignores */
 428 #ifdef HAVE_STRSEP
 429     char **ppsz_extensions = 0;
 430     int i_extensions = 0;
 431     char *psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
 432     if( psz_ignore && *psz_ignore )
 433     {
 434         char *psz_backup;
 435         char *psz_parser = psz_backup = strdup( psz_ignore );
 436         int a = 0;
 437
 438         while( strsep( &psz_parser, "," ) ) i_extensions++;
 439         free( psz_backup );
 440
 441         ppsz_extensions = (char **)malloc( sizeof( char * ) * i_extensions );
 442
 443         psz_parser = psz_ignore;
 444         while( a < i_extensions &&
 445                ( ppsz_extensions[a++] = strsep( &psz_parser, "," ) ) );
 446     }
 447 #endif /* HAVE_STRSEP */
 448
 449     /* Change the item to a node */
 450     if( p_parent->i_children == -1 )
 451     {
 452         playlist_LockItemToNode( p_playlist,p_parent );
 453     }
 454
 455     /* get the first directory entry */
 456     i_dir_content = scandir( psz_name, &pp_dir_content, Filter, alphasort );
 457     if( i_dir_content == -1 )
 458     {
 459         msg_Warn( p_playlist, "Failed to read directory" );
 460         return VLC_EGENERIC;
 461     }
 462     else if( i_dir_content <= 0 )
 463     {
 464         /* directory is empty */
 465         return VLC_SUCCESS;
 466     }
 467
 468     /* While we still have entries in the directory */
 469     for( i = 0; i < i_dir_content; i++ )
 470     {
 471         struct dirent *p_dir_content = pp_dir_content[i];
 472         int i_size_entry = strlen( psz_name ) +
 473                            strlen( p_dir_content->d_name ) + 2;
 474         char *psz_uri = (char *)malloc( sizeof(char) * i_size_entry );
 475
 476         sprintf( psz_uri, "%s/%s", psz_name, p_dir_content->d_name );
 477
 478         /* if it starts with '.' then forget it */
 479         if( p_dir_content->d_name[0] != '.' )
 480         {
 481 #if defined( S_ISDIR )
 482             struct stat stat_data;
 483             stat( psz_uri, &stat_data );
 484             if( S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
 485 #elif defined( DT_DIR )
 486             if( ( p_dir_content->d_type & DT_DIR ) && i_mode != MODE_COLLAPSE )
 487 #else
 488             if( 0 )
 489 #endif
 490             {
 491                 if( i_mode == MODE_NONE )
 492                 {
 493                     msg_Dbg( p_playlist, "Skipping subdirectory %s", psz_uri );
 494                     free( psz_uri );
 495                     continue;
 496                 }
 497                 else if( i_mode == MODE_EXPAND )
 498                 {
 499                     char *psz_newname;
 500                     msg_Dbg(p_playlist, "Reading subdirectory %s", psz_uri );
 501
 502                     if( !strncmp( psz_uri, psz_name, strlen( psz_name ) ) )
 503                     {
 504                         char *psz_subdir = psz_uri;
 505                         /* Skip the parent path + the separator */
 506                         psz_subdir += strlen( psz_name ) + 1;
 507                         psz_newname = strdup( psz_subdir );
 508                     }
 509                     else
 510                     {
 511                         psz_newname = strdup( psz_uri );
 512                     }
 513                     p_node = playlist_NodeCreate( p_playlist,
 514                                        p_parent->pp_parents[0]->i_view,
 515                                        psz_newname, p_parent );
 516
 517                     playlist_CopyParents(  p_parent, p_node );
 518
 519                     p_node->input.i_type = ITEM_TYPE_DIRECTORY;
 520
 521                     if( ReadDir( p_playlist, psz_uri , MODE_EXPAND,
 522                                  pi_position, p_node ) != VLC_SUCCESS )
 523                     {
 524                         return VLC_EGENERIC;
 525                     }
 526
 527                     free( psz_newname );
 528                 }
 529             }
 530             else
 531             {
 532                 playlist_item_t *p_item;
 533
 534 #ifdef HAVE_STRSEP
 535                 if( i_extensions > 0 )
 536                 {
 537                     char *psz_dot = strrchr( p_dir_content->d_name, '.' );
 538                     if( psz_dot++ && *psz_dot )
 539                     {
 540                         int a;
 541                         for( a = 0; a < i_extensions; a++ )
 542                         {
 543                             if( !strcmp( psz_dot, ppsz_extensions[a] ) )
 544                                 break;
 545                         }
 546                         if( a < i_extensions )
 547                         {
 548                             msg_Dbg( p_playlist, "Ignoring file %s", psz_uri );
 549                             free( psz_uri );
 550                             continue;
 551                         }
 552                     }
 553                 }
 554 #endif /* HAVE_STRSEP */
 555
 556                 p_item = playlist_ItemNewWithType( VLC_OBJECT(p_playlist),
 557                         psz_uri, p_dir_content->d_name, 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_END );
 562
 563                 playlist_CopyParents( p_parent, p_item );
 564             }
 565         }
 566         free( psz_uri );
 567     }
 568
 569 #ifdef HAVE_STRSEP
 570     if( ppsz_extensions ) free( ppsz_extensions );
 571     if( psz_ignore ) free( psz_ignore );
 572 #endif /* HAVE_STRSEP */
 573
 574     free( pp_dir_content );
 575     return VLC_SUCCESS;
 576 }