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