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_playlist.h>
  30 #include <vlc_input.h>
  31 #include <vlc_access.h>
  32 #include <vlc_demux.h>
  33
  34 #include <stdlib.h>
  35 #include <string.h>
  36 #ifdef HAVE_SYS_TYPES_H
  37 #   include <sys/types.h>
  38 #endif
  39 #ifdef HAVE_SYS_STAT_H
  40 #   include <sys/stat.h>
  41 #endif
  42 #ifdef HAVE_ERRNO_H
  43 #   include <errno.h>
  44 #endif
  45 #ifdef HAVE_FCNTL_H
  46 #   include <fcntl.h>
  47 #endif
  48
  49 #ifdef HAVE_UNISTD_H
  50 #   include <unistd.h>
  51 #elif defined( WIN32 ) && !defined( UNDER_CE )
  52 #   include <io.h>
  53 #elif defined( UNDER_CE )
  54 #   define strcoll strcmp
  55 #endif
  56
  57 #ifdef HAVE_DIRENT_H
  58 #   include <dirent.h>
  59 #endif
  60
  61 #include <vlc_charset.h>
  62
  63 /*****************************************************************************
  64  * Module descriptor
  65  *****************************************************************************/
  66 static int  Open ( vlc_object_t * );
  67 static void Close( vlc_object_t * );
  68
  69 static int  DemuxOpen ( vlc_object_t * );
  70
  71 #define RECURSIVE_TEXT N_("Subdirectory behavior")
  72 #define RECURSIVE_LONGTEXT N_( \
  73         "Select whether subdirectories must be expanded.\n" \
  74         "none: subdirectories do not appear in the playlist.\n" \
  75         "collapse: subdirectories appear but are expanded on first play.\n" \
  76         "expand: all subdirectories are expanded.\n" )
  77
  78 static const char *psz_recursive_list[] = { "none", "collapse", "expand" };
  79 static const char *psz_recursive_list_text[] = { N_("none"), N_("collapse"),
  80                                                  N_("expand") };
  81
  82 #define IGNORE_TEXT N_("Ignored extensions")
  83 #define IGNORE_LONGTEXT N_( \
  84         "Files with these extensions will not be added to playlist when " \
  85         "opening a directory.\n" \
  86         "This is useful if you add directories that contain playlist files " \
  87         "for instance. Use a comma-separated list of extensions." )
  88
  89 vlc_module_begin();
  90     set_category( CAT_INPUT );
  91     set_shortname( _("Directory" ) );
  92     set_subcategory( SUBCAT_INPUT_ACCESS );
  93     set_description( _("Standard filesystem directory input") );
  94     set_capability( "access2", 55 );
  95     add_shortcut( "directory" );
  96     add_shortcut( "dir" );
  97     add_shortcut( "file" );
  98     add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
  99                 RECURSIVE_LONGTEXT, VLC_FALSE );
 100       change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
 101     add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
 102                 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, VLC_FALSE );
 103     set_callbacks( Open, Close );
 104
 105     add_submodule();
 106         set_description( "Directory EOF");
 107         set_capability( "demux2", 0 );
 108         add_shortcut( "directory" );
 109         set_callbacks( DemuxOpen, NULL );
 110 vlc_module_end();
 111
 112
 113 /*****************************************************************************
 114  * Local prototypes, constants, structures
 115  *****************************************************************************/
 116
 117 #define MODE_EXPAND 0
 118 #define MODE_COLLAPSE 1
 119 #define MODE_NONE 2
 120
 121 static int Read( access_t *, uint8_t *, int );
 122 static int ReadNull( access_t *, uint8_t *, int );
 123 static int Control( access_t *, int, va_list );
 124
 125 static int Demux( demux_t *p_demux );
 126 static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
 127
 128
 129 static int ReadDir( playlist_t *, const char *psz_name, int i_mode,
 130                     playlist_item_t *, playlist_item_t *, input_item_t * );
 131
 132 /*****************************************************************************
 133  * Open: open the directory
 134  *****************************************************************************/
 135 static int Open( vlc_object_t *p_this )
 136 {
 137     access_t *p_access = (access_t*)p_this;
 138
 139     struct stat stat_info;
 140
 141 #ifdef S_ISDIR
 142     if (utf8_stat (p_access->psz_path, &stat_info)
 143      || !S_ISDIR (stat_info.st_mode))
 144 #else
 145     if( strcmp( p_access->psz_access, "dir") &&
 146         strcmp( p_access->psz_access, "directory") )
 147 #endif
 148         return VLC_EGENERIC;
 149
 150     p_access->pf_read  = Read;
 151     p_access->pf_block = NULL;
 152     p_access->pf_seek  = NULL;
 153     p_access->pf_control= Control;
 154
 155     /* Force a demux */
 156     p_access->psz_demux = strdup( "directory" );
 157
 158     return VLC_SUCCESS;
 159 }
 160
 161 /*****************************************************************************
 162  * Close: close the target
 163  *****************************************************************************/
 164 static void Close( vlc_object_t * p_this )
 165 {
 166 }
 167
 168 /*****************************************************************************
 169  * ReadNull: read the directory
 170  *****************************************************************************/
 171 static int ReadNull( access_t *p_access, uint8_t *p_buffer, int i_len)
 172 {
 173     /* Return fake data */
 174     memset( p_buffer, 0, i_len );
 175     return i_len;
 176 }
 177
 178 /*****************************************************************************
 179  * Read: read the directory
 180  *****************************************************************************/
 181 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len)
 182 {
 183     char               *psz;
 184     int                 i_mode, i_activity;
 185     char               *psz_name = strdup (p_access->psz_path);
 186
 187     if( psz_name == NULL )
 188         return VLC_ENOMEM;
 189
 190     playlist_t         *p_playlist = pl_Yield( p_access );
 191     playlist_item_t    *p_item_in_category;
 192     input_item_t       *p_current_input = input_GetItem(
 193                                     (input_thread_t*)p_access->p_parent);
 194     playlist_item_t    *p_current = playlist_ItemGetByInput( p_playlist,
 195                                                              p_current_input,
 196                                                              VLC_FALSE );
 197
 198     if( p_current == NULL )
 199     {
 200         msg_Err( p_access, "unable to find item in playlist" );
 201         vlc_object_release( p_playlist );
 202         return VLC_ENOOBJ;
 203     }
 204
 205     /* Remove the ending '/' char */
 206     if (psz_name[0])
 207     {
 208         char *ptr = psz_name + strlen (psz_name);
 209         switch (*--ptr)
 210         {
 211             case '/':
 212             case '\\':
 213                 *ptr = '\0';
 214         }
 215     }
 216
 217     /* Handle mode */
 218     psz = var_CreateGetString( p_access, "recursive" );
 219     if( *psz == '\0' || !strncmp( psz, "none" , 4 )  )
 220         i_mode = MODE_NONE;
 221     else if( !strncmp( psz, "collapse", 8 )  )
 222         i_mode = MODE_COLLAPSE;
 223     else
 224         i_mode = MODE_EXPAND;
 225     free( psz );
 226
 227     msg_Dbg( p_access, "opening directory `%s'", p_access->psz_path );
 228
 229     p_current->p_input->i_type = ITEM_TYPE_DIRECTORY;
 230     p_item_in_category = playlist_ItemToNode( p_playlist, p_current,
 231                                               VLC_FALSE );
 232
 233     i_activity = var_GetInteger( p_playlist, "activity" );
 234     var_SetInteger( p_playlist, "activity", i_activity +
 235                     DIRECTORY_ACTIVITY );
 236
 237     ReadDir( p_playlist, psz_name, i_mode, p_current, p_item_in_category,
 238              p_current_input );
 239
 240     i_activity = var_GetInteger( p_playlist, "activity" );
 241     var_SetInteger( p_playlist, "activity", i_activity -
 242                     DIRECTORY_ACTIVITY );
 243
 244     playlist_Signal( p_playlist );
 245
 246     if( psz_name ) free( psz_name );
 247     vlc_object_release( p_playlist );
 248
 249     /* Return fake data forever */
 250     p_access->pf_read = ReadNull;
 251     return ReadNull( p_access, p_buffer, i_len );
 252 }
 253
 254 /*****************************************************************************
 255  * DemuxOpen:
 256  *****************************************************************************/
 257 static int Control( access_t *p_access, int i_query, va_list args )
 258 {
 259     vlc_bool_t   *pb_bool;
 260     int          *pi_int;
 261     int64_t      *pi_64;
 262
 263     switch( i_query )
 264     {
 265         /* */
 266         case ACCESS_CAN_SEEK:
 267         case ACCESS_CAN_FASTSEEK:
 268         case ACCESS_CAN_PAUSE:
 269         case ACCESS_CAN_CONTROL_PACE:
 270             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 271             *pb_bool = VLC_FALSE;    /* FIXME */
 272             break;
 273
 274         /* */
 275         case ACCESS_GET_MTU:
 276             pi_int = (int*)va_arg( args, int * );
 277             *pi_int = 0;
 278             break;
 279
 280         case ACCESS_GET_PTS_DELAY:
 281             pi_64 = (int64_t*)va_arg( args, int64_t * );
 282             *pi_64 = DEFAULT_PTS_DELAY * 1000;
 283             break;
 284
 285         /* */
 286         case ACCESS_SET_PAUSE_STATE:
 287         case ACCESS_GET_TITLE_INFO:
 288         case ACCESS_SET_TITLE:
 289         case ACCESS_SET_SEEKPOINT:
 290         case ACCESS_SET_PRIVATE_ID_STATE:
 291             return VLC_EGENERIC;
 292
 293         default:
 294             msg_Warn( p_access, "unimplemented query in control" );
 295             return VLC_EGENERIC;
 296     }
 297     return VLC_SUCCESS;
 298 }
 299
 300 /*****************************************************************************
 301  * DemuxOpen:
 302  *****************************************************************************/
 303 static int DemuxOpen ( vlc_object_t *p_this )
 304 {
 305     demux_t *p_demux = (demux_t*)p_this;
 306
 307     if( strcmp( p_demux->psz_demux, "directory" ) )
 308         return VLC_EGENERIC;
 309
 310     p_demux->pf_demux   = Demux;
 311     p_demux->pf_control = DemuxControl;
 312     return VLC_SUCCESS;
 313 }
 314
 315 /*****************************************************************************
 316  * Demux: EOF
 317  *****************************************************************************/
 318 static int Demux( demux_t *p_demux )
 319 {
 320     return 0;
 321 }
 322
 323 /*****************************************************************************
 324  * DemuxControl:
 325  *****************************************************************************/
 326 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
 327 {
 328     return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
 329 }
 330
 331
 332 static int Sort (const char **a, const char **b)
 333 {
 334     return strcoll (*a, *b);
 335 }
 336
 337 /*****************************************************************************
 338  * ReadDir: read a directory and add its content to the list
 339  *****************************************************************************/
 340 static int ReadDir( playlist_t *p_playlist, const char *psz_name,
 341                     int i_mode, playlist_item_t *p_parent,
 342                     playlist_item_t *p_parent_category,
 343                     input_item_t *p_current_input )
 344 {
 345     char **pp_dir_content = NULL;
 346     int             i_dir_content, i, i_return = VLC_SUCCESS;
 347     playlist_item_t *p_node;
 348
 349     char **ppsz_extensions = NULL;
 350     int i_extensions = 0;
 351     char *psz_ignore;
 352
 353     /* Get the first directory entry */
 354     i_dir_content = utf8_scandir (psz_name, &pp_dir_content, NULL, Sort);
 355     if( i_dir_content == -1 )
 356     {
 357         msg_Warn( p_playlist, "failed to read directory" );
 358         return VLC_EGENERIC;
 359     }
 360     else if( i_dir_content <= 0 )
 361     {
 362         /* directory is empty */
 363         if( pp_dir_content ) free( pp_dir_content );
 364         return VLC_SUCCESS;
 365     }
 366
 367     /* Build array with ignores */
 368     psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
 369     if( psz_ignore && *psz_ignore )
 370     {
 371         char *psz_parser = psz_ignore;
 372         int a;
 373
 374         for( a = 0; psz_parser[a] != '\0'; a++ )
 375         {
 376             if( psz_parser[a] == ',' ) i_extensions++;
 377         }
 378
 379         ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
 380
 381         for( a = 0; a < i_extensions; a++ )
 382         {
 383             char *tmp, *ptr;
 384
 385             while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
 386             ptr = strchr( psz_parser, ',');
 387             tmp = ( ptr == NULL )
 388                  ? strdup( psz_parser )
 389                  : strndup( psz_parser, ptr - psz_parser );
 390
 391             ppsz_extensions[a] = tmp;
 392             psz_parser = ptr + 1;
 393         }
 394     }
 395     if( psz_ignore ) free( psz_ignore );
 396
 397     /* While we still have entries in the directory */
 398     for( i = 0; i < i_dir_content; i++ )
 399     {
 400         const char *entry = pp_dir_content[i];
 401         int i_size_entry = strlen( psz_name ) +
 402                            strlen( entry ) + 2 + 7 /* strlen("file://") */;
 403         char psz_uri[i_size_entry];
 404
 405         sprintf( psz_uri, "%s/%s", psz_name, entry);
 406
 407         /* if it starts with '.' then forget it */
 408         if (entry[0] != '.')
 409         {
 410 #if defined( S_ISDIR )
 411             struct stat stat_data;
 412
 413             if (!utf8_stat (psz_uri, &stat_data)
 414              && S_ISDIR(stat_data.st_mode) && i_mode != MODE_COLLAPSE )
 415 #else
 416             if( 0 )
 417 #endif
 418             {
 419 #if defined( S_ISLNK )
 420 /*
 421  * FIXME: there is a ToCToU race condition here; but it is rather tricky
 422  * impossible to fix while keeping some kind of portable code, and maybe even
 423  * in a non-portable way.
 424  */
 425                 if (utf8_lstat (psz_uri, &stat_data)
 426                  || S_ISLNK(stat_data.st_mode) )
 427                 {
 428                     msg_Dbg( p_playlist, "skipping directory symlink %s",
 429                              psz_uri );
 430                     continue;
 431                 }
 432 #endif
 433                 if( i_mode == MODE_NONE )
 434                 {
 435                     msg_Dbg( p_playlist, "skipping subdirectory %s", psz_uri );
 436                     continue;
 437                 }
 438                 else if( i_mode == MODE_EXPAND )
 439                 {
 440                     msg_Dbg(p_playlist, "creading subdirectory %s", psz_uri );
 441
 442                     p_node = playlist_NodeCreate( p_playlist, entry,
 443                                                   p_parent_category,
 444                                                   PLAYLIST_NO_REBUILD );
 445
 446                     /* If we had the parent in category, the it is now node.
 447                      * Else, we still don't have  */
 448                     if( ReadDir( p_playlist, psz_uri , MODE_EXPAND,
 449                                  p_node, p_parent_category ? p_node : NULL,
 450                                  p_current_input )
 451                           != VLC_SUCCESS )
 452                     {
 453                         i_return = VLC_EGENERIC;
 454                         break;
 455                     }
 456                 }
 457             }
 458             else
 459             {
 460                 input_item_t *p_input;
 461
 462                 if( i_extensions > 0 )
 463                 {
 464                     const char *psz_dot = strrchr (entry, '.' );
 465                     if( psz_dot++ && *psz_dot )
 466                     {
 467                         int a;
 468                         for( a = 0; a < i_extensions; a++ )
 469                         {
 470                             if( !strcmp( psz_dot, ppsz_extensions[a] ) )
 471                                 break;
 472                         }
 473                         if( a < i_extensions )
 474                         {
 475                             msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
 476                             continue;
 477                         }
 478                     }
 479                 }
 480
 481                 memmove (psz_uri + 7, psz_uri, sizeof (psz_uri) - 7);
 482                 memcpy (psz_uri, "file://", 7);
 483                 p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist),
 484                                                  psz_uri, entry, 0, NULL,
 485                                                  -1, ITEM_TYPE_VFILE );
 486                 if (p_input != NULL)
 487                 {
 488                     if( p_current_input )
 489                         input_ItemCopyOptions( p_current_input, p_input );
 490                     playlist_BothAddInput( p_playlist, p_input,
 491                                            p_parent_category,
 492                                            PLAYLIST_APPEND|PLAYLIST_PREPARSE|
 493                                            PLAYLIST_NO_REBUILD,
 494                                            PLAYLIST_END, NULL, NULL );
 495                 }
 496             }
 497         }
 498     }
 499
 500     for( i = 0; i < i_extensions; i++ )
 501         if( ppsz_extensions[i] ) free( ppsz_extensions[i] );
 502     if( ppsz_extensions ) free( ppsz_extensions );
 503
 504     for( i = 0; i < i_dir_content; i++ )
 505         if( pp_dir_content[i] ) free( pp_dir_content[i] );
 506     if( pp_dir_content ) free( pp_dir_content );
 507
 508     return i_return;
 509 }