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-2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Derk-Jan Hartman <hartman at videolan dot org>
   8  *          Rémi Denis-Courmont
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28
  29 #ifdef HAVE_CONFIG_H
  30 # include "config.h"
  31 #endif
  32
  33 #include <assert.h>
  34 #include <vlc_common.h>
  35 #include <vlc_plugin.h>
  36 #warning playlist code must not be used here.
  37 #include <vlc_playlist.h>
  38 #include <vlc_input.h>
  39 #include <vlc_access.h>
  40 #include <vlc_demux.h>
  41
  42 #ifdef HAVE_SYS_TYPES_H
  43 #   include <sys/types.h>
  44 #endif
  45 #ifdef HAVE_SYS_STAT_H
  46 #   include <sys/stat.h>
  47 #endif
  48 #ifdef HAVE_ERRNO_H
  49 #   include <errno.h>
  50 #endif
  51 #ifdef HAVE_FCNTL_H
  52 #   include <fcntl.h>
  53 #endif
  54
  55 #ifdef HAVE_UNISTD_H
  56 #   include <unistd.h>
  57 #elif defined( WIN32 ) && !defined( UNDER_CE )
  58 #   include <io.h>
  59 #elif defined( UNDER_CE )
  60 #   define strcoll strcmp
  61 #endif
  62
  63 #ifdef HAVE_DIRENT_H
  64 #   include <dirent.h>
  65 #endif
  66
  67 #include <vlc_charset.h>
  68
  69 /*****************************************************************************
  70  * Module descriptor
  71  *****************************************************************************/
  72 static int  Open ( vlc_object_t * );
  73 static void Close( vlc_object_t * );
  74
  75 static int  DemuxOpen ( vlc_object_t * );
  76
  77 #define RECURSIVE_TEXT N_("Subdirectory behavior")
  78 #define RECURSIVE_LONGTEXT N_( \
  79         "Select whether subdirectories must be expanded.\n" \
  80         "none: subdirectories do not appear in the playlist.\n" \
  81         "collapse: subdirectories appear but are expanded on first play.\n" \
  82         "expand: all subdirectories are expanded.\n" )
  83
  84 static const char *const psz_recursive_list[] = { "none", "collapse", "expand" };
  85 static const char *const psz_recursive_list_text[] = {
  86     N_("none"), N_("collapse"), N_("expand") };
  87
  88 #define IGNORE_TEXT N_("Ignored extensions")
  89 #define IGNORE_LONGTEXT N_( \
  90         "Files with these extensions will not be added to playlist when " \
  91         "opening a directory.\n" \
  92         "This is useful if you add directories that contain playlist files " \
  93         "for instance. Use a comma-separated list of extensions." )
  94
  95 vlc_module_begin();
  96     set_category( CAT_INPUT );
  97     set_shortname( N_("Directory" ) );
  98     set_subcategory( SUBCAT_INPUT_ACCESS );
  99     set_description( N_("Standard filesystem directory input") );
 100     set_capability( "access", 55 );
 101     add_shortcut( "directory" );
 102     add_shortcut( "dir" );
 103     add_shortcut( "file" );
 104     add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
 105                 RECURSIVE_LONGTEXT, false );
 106       change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
 107     add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
 108                 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, false );
 109     set_callbacks( Open, Close );
 110
 111     add_submodule();
 112         set_description( "Directory EOF");
 113         set_capability( "demux", 0 );
 114         set_callbacks( DemuxOpen, NULL );
 115 vlc_module_end();
 116
 117
 118 /*****************************************************************************
 119  * Local prototypes, constants, structures
 120  *****************************************************************************/
 121
 122 enum
 123 {
 124     MODE_EXPAND,
 125     MODE_COLLAPSE,
 126     MODE_NONE
 127 };
 128
 129 typedef struct stat_list_t stat_list_t;
 130
 131 static ssize_t Read( access_t *, uint8_t *, size_t );
 132 static ssize_t ReadNull( access_t *, uint8_t *, size_t );
 133 static int Control( access_t *, int, va_list );
 134
 135 static int Demux( demux_t *p_demux );
 136 static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
 137
 138
 139 static int ReadDir( access_t *, playlist_t *, const char *psz_name,
 140                     int i_mode, playlist_item_t *, input_item_t *,
 141                     DIR *handle, stat_list_t *stats );
 142
 143 static DIR *OpenDir (vlc_object_t *obj, const char *psz_name);
 144
 145 /*****************************************************************************
 146  * Open: open the directory
 147  *****************************************************************************/
 148 static int Open( vlc_object_t *p_this )
 149 {
 150     access_t *p_access = (access_t*)p_this;
 151
 152     if( !p_access->psz_path )
 153         return VLC_EGENERIC;
 154
 155     struct stat st;
 156     if( !stat( p_access->psz_path, &st ) && !S_ISDIR( st.st_mode ) )
 157         return VLC_EGENERIC;
 158
 159     DIR *handle = OpenDir (p_this, p_access->psz_path);
 160     if (handle == NULL)
 161         return VLC_EGENERIC;
 162
 163     p_access->p_sys = (access_sys_t *)handle;
 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     free( p_access->psz_demux );
 172     p_access->psz_demux = strdup( "directory" );
 173
 174     return VLC_SUCCESS;
 175 }
 176
 177 /*****************************************************************************
 178  * Close: close the target
 179  *****************************************************************************/
 180 static void Close( vlc_object_t * p_this )
 181 {
 182     access_t *p_access = (access_t*)p_this;
 183     DIR *handle = (DIR *)p_access->p_sys;
 184     closedir (handle);
 185 }
 186
 187 /*****************************************************************************
 188  * ReadNull: read the directory
 189  *****************************************************************************/
 190 static ssize_t ReadNull( access_t *p_access, uint8_t *p_buffer, size_t i_len)
 191 {
 192     (void)p_access;
 193     /* Return fake data */
 194     memset( p_buffer, 0, i_len );
 195     return i_len;
 196 }
 197
 198 /*****************************************************************************
 199  * Read: read the directory
 200  *****************************************************************************/
 201 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len)
 202 {
 203     (void)p_buffer;    (void)i_len;
 204     char               *psz;
 205     int                 i_mode;
 206     char               *psz_name = strdup( p_access->psz_path );
 207
 208     if( psz_name == NULL )
 209         return VLC_ENOMEM;
 210
 211     playlist_t         *p_playlist = pl_Yield( p_access );
 212     input_thread_t     *p_input = (input_thread_t*)vlc_object_find( p_access, VLC_OBJECT_INPUT, FIND_PARENT );
 213
 214     playlist_item_t    *p_item_in_category;
 215     input_item_t       *p_current_input;
 216     playlist_item_t    *p_current;
 217
 218     if( !p_input )
 219     {
 220         msg_Err( p_access, "unable to find input (internal error)" );
 221         free( psz_name );
 222         pl_Release( p_access );
 223         return VLC_ENOOBJ;
 224     }
 225
 226     p_current_input = input_GetItem( p_input );
 227     p_current = playlist_ItemGetByInput( p_playlist, p_current_input, pl_Unlocked );
 228
 229     if( !p_current )
 230     {
 231         msg_Err( p_access, "unable to find item in playlist" );
 232         vlc_object_release( p_input );
 233         free( psz_name );
 234         pl_Release( p_access );
 235         return VLC_ENOOBJ;
 236     }
 237
 238     /* Remove the ending '/' char */
 239     if( psz_name[0] )
 240     {
 241         char *ptr = psz_name + strlen (psz_name);
 242         switch (*--ptr)
 243         {
 244             case '/':
 245             case '\\':
 246                 *ptr = '\0';
 247         }
 248     }
 249
 250     /* Handle mode */
 251     psz = var_CreateGetString( p_access, "recursive" );
 252     if( *psz == '\0' || !strncmp( psz, "none" , 4 )  )
 253         i_mode = MODE_NONE;
 254     else if( !strncmp( psz, "collapse", 8 )  )
 255         i_mode = MODE_COLLAPSE;
 256     else
 257         i_mode = MODE_EXPAND;
 258     free( psz );
 259
 260     p_current->p_input->i_type = ITEM_TYPE_DIRECTORY;
 261     p_item_in_category = playlist_ItemToNode( p_playlist, p_current,
 262                                               pl_Unlocked );
 263     assert( p_item_in_category );
 264
 265     ReadDir( p_access, p_playlist, psz_name, i_mode,
 266              p_item_in_category,
 267              p_current_input, (DIR *)p_access->p_sys, NULL );
 268
 269     playlist_Signal( p_playlist );
 270
 271     free( psz_name );
 272     vlc_object_release( p_input );
 273     pl_Release( p_access );
 274
 275     /* Return fake data forever */
 276     p_access->pf_read = ReadNull;
 277     return -1;
 278 }
 279
 280 /*****************************************************************************
 281  * Control:
 282  *****************************************************************************/
 283 static int Control( access_t *p_access, int i_query, va_list args )
 284 {
 285     bool   *pb_bool;
 286     int          *pi_int;
 287     int64_t      *pi_64;
 288
 289     switch( i_query )
 290     {
 291         /* */
 292         case ACCESS_CAN_SEEK:
 293         case ACCESS_CAN_FASTSEEK:
 294         case ACCESS_CAN_PAUSE:
 295         case ACCESS_CAN_CONTROL_PACE:
 296             pb_bool = (bool*)va_arg( args, bool* );
 297             *pb_bool = false;    /* FIXME */
 298             break;
 299
 300         /* */
 301         case ACCESS_GET_MTU:
 302             pi_int = (int*)va_arg( args, int * );
 303             *pi_int = 0;
 304             break;
 305
 306         case ACCESS_GET_PTS_DELAY:
 307             pi_64 = (int64_t*)va_arg( args, int64_t * );
 308             *pi_64 = DEFAULT_PTS_DELAY * 1000;
 309             break;
 310
 311         /* */
 312         case ACCESS_SET_PAUSE_STATE:
 313         case ACCESS_GET_TITLE_INFO:
 314         case ACCESS_SET_TITLE:
 315         case ACCESS_SET_SEEKPOINT:
 316         case ACCESS_SET_PRIVATE_ID_STATE:
 317         case ACCESS_GET_CONTENT_TYPE:
 318         case ACCESS_GET_META:
 319             return VLC_EGENERIC;
 320
 321         default:
 322             msg_Warn( p_access, "unimplemented query in control" );
 323             return VLC_EGENERIC;
 324     }
 325     return VLC_SUCCESS;
 326 }
 327
 328 /*****************************************************************************
 329  * DemuxOpen:
 330  *****************************************************************************/
 331 static int DemuxOpen ( vlc_object_t *p_this )
 332 {
 333     demux_t *p_demux = (demux_t*)p_this;
 334
 335     if( strcmp( p_demux->psz_demux, "directory" ) )
 336         return VLC_EGENERIC;
 337
 338     p_demux->pf_demux   = Demux;
 339     p_demux->pf_control = DemuxControl;
 340     return VLC_SUCCESS;
 341 }
 342
 343 /*****************************************************************************
 344  * Demux: EOF
 345  *****************************************************************************/
 346 static int Demux( demux_t *p_demux )
 347 {
 348     (void)p_demux;
 349     return 0;
 350 }
 351
 352 /*****************************************************************************
 353  * DemuxControl:
 354  *****************************************************************************/
 355 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
 356 {
 357     return demux_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
 358 }
 359
 360
 361 static int Sort (const char **a, const char **b)
 362 {
 363     return strcoll (*a, *b);
 364 }
 365
 366 struct stat_list_t
 367 {
 368     stat_list_t *parent;
 369     struct stat st;
 370 };
 371
 372
 373 /*****************************************************************************
 374  * ReadDir: read a directory and add its content to the list
 375  *****************************************************************************/
 376 static int ReadDir( access_t *p_access, playlist_t *p_playlist,
 377                     const char *psz_name,
 378                     int i_mode,
 379                     playlist_item_t *p_parent_category,
 380                     input_item_t *p_current_input,
 381                     DIR *handle, stat_list_t *stparent )
 382 {
 383     char **pp_dir_content = NULL;
 384     int             i_dir_content, i, i_return = VLC_SUCCESS;
 385     playlist_item_t *p_node;
 386
 387     if( !vlc_object_alive( p_access ) )
 388         return VLC_EGENERIC;
 389
 390     if( !vlc_object_alive( p_playlist ) )
 391         return VLC_EGENERIC;
 392
 393     char **ppsz_extensions = NULL;
 394     int i_extensions = 0;
 395     char *psz_ignore;
 396
 397     struct stat_list_t stself;
 398 #ifndef WIN32
 399     int fd = dirfd (handle);
 400
 401     if ((fd == -1) || fstat (fd, &stself.st))
 402     {
 403         msg_Err (p_playlist, "cannot stat `%s': %m", psz_name);
 404         return VLC_EGENERIC;
 405     }
 406
 407     for (stat_list_t *stats = stparent; stats != NULL; stats = stats->parent)
 408     {
 409         if ((stself.st.st_ino == stats->st.st_ino)
 410          && (stself.st.st_dev == stats->st.st_dev))
 411         {
 412             msg_Warn (p_playlist,
 413                       "ignoring infinitely recursive directory `%s'",
 414                       psz_name);
 415             return VLC_SUCCESS;
 416         }
 417     }
 418 #else
 419         /* Windows has st_dev (driver letter - 'A'), but it zeroes st_ino,
 420          * so that the test above will always incorrectly succeed.
 421          * Besides, Windows does not have dirfd(). */
 422 #endif
 423
 424     stself.parent = stparent;
 425
 426     /* Get the first directory entry */
 427     i_dir_content = utf8_loaddir (handle, &pp_dir_content, NULL, Sort);
 428     if( i_dir_content == -1 )
 429     {
 430         msg_Err (p_playlist, "cannot read `%s': %m", psz_name);
 431         return VLC_EGENERIC;
 432     }
 433     else if( i_dir_content <= 0 )
 434     {
 435         /* directory is empty */
 436         msg_Dbg( p_playlist, "%s directory is empty", psz_name );
 437         free( pp_dir_content );
 438         return VLC_SUCCESS;
 439     }
 440
 441     /* Build array with ignores */
 442     psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
 443     if( psz_ignore && *psz_ignore )
 444     {
 445         char *psz_parser = psz_ignore;
 446         int a;
 447
 448         for( a = 0; psz_parser[a] != '\0'; a++ )
 449         {
 450             if( psz_parser[a] == ',' ) i_extensions++;
 451         }
 452
 453         ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
 454
 455         for( a = 0; a < i_extensions; a++ )
 456         {
 457             char *tmp, *ptr;
 458
 459             while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
 460             ptr = strchr( psz_parser, ',');
 461             tmp = ( ptr == NULL )
 462                  ? strdup( psz_parser )
 463                  : strndup( psz_parser, ptr - psz_parser );
 464
 465             ppsz_extensions[a] = tmp;
 466             psz_parser = ptr + 1;
 467         }
 468     }
 469     free( psz_ignore );
 470
 471     /* While we still have entries in the directory */
 472     for( i = 0; i < i_dir_content; i++ )
 473     {
 474         const char *entry = pp_dir_content[i];
 475         int i_size_entry = strlen( psz_name ) +
 476                            strlen( entry ) + 2 + 7 /* strlen("file://") */;
 477         char psz_uri[i_size_entry];
 478
 479         sprintf( psz_uri, "%s/%s", psz_name, entry);
 480
 481         /* if it starts with '.' then forget it */
 482         if (entry[0] != '.')
 483         {
 484             DIR *subdir = (i_mode != MODE_COLLAPSE)
 485                     ? OpenDir (VLC_OBJECT (p_playlist), psz_uri) : NULL;
 486
 487             if (subdir != NULL) /* Recurse into subdirectory */
 488             {
 489                 if( i_mode == MODE_NONE )
 490                 {
 491                     msg_Dbg( p_playlist, "skipping subdirectory `%s'",
 492                              psz_uri );
 493                     closedir (subdir);
 494                     continue;
 495                 }
 496
 497                 msg_Dbg (p_playlist, "creating subdirectory %s", psz_uri);
 498
 499                 PL_LOCK;
 500                 p_node = playlist_NodeCreate( p_playlist, entry,
 501                                               p_parent_category,
 502                                               PLAYLIST_NO_REBUILD, NULL );
 503                 PL_UNLOCK;
 504                 assert( p_node );
 505                 /* If we had the parent in category, the it is now node.
 506                  * Else, we still don't have  */
 507                 i_return = ReadDir( p_access, p_playlist, psz_uri , MODE_EXPAND,
 508                                     p_parent_category ? p_node : NULL,
 509                                     p_current_input, subdir, &stself );
 510                 closedir (subdir);
 511                 if (i_return)
 512                     break; // error :-(
 513             }
 514             else
 515             {
 516                 input_item_t *p_input;
 517
 518                 if( i_extensions > 0 )
 519                 {
 520                     const char *psz_dot = strrchr (entry, '.' );
 521                     if( psz_dot++ && *psz_dot )
 522                     {
 523                         int a;
 524                         for( a = 0; a < i_extensions; a++ )
 525                         {
 526                             if( !strcmp( psz_dot, ppsz_extensions[a] ) )
 527                                 break;
 528                         }
 529                         if( a < i_extensions )
 530                         {
 531                             msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
 532                             continue;
 533                         }
 534                     }
 535                 }
 536
 537                 memmove (psz_uri + 7, psz_uri, sizeof (psz_uri) - 7);
 538                 memcpy (psz_uri, "file://", 7);
 539                 p_input = input_item_NewWithType( VLC_OBJECT( p_playlist ),
 540                                                  psz_uri, entry, 0, NULL,
 541                                                  -1, ITEM_TYPE_FILE );
 542                 if (p_input != NULL)
 543                 {
 544                     if( p_current_input )
 545                         input_item_CopyOptions( p_current_input, p_input );
 546                     assert( p_parent_category );
 547                     int i_ret = playlist_BothAddInput( p_playlist, p_input,
 548                                            p_parent_category,
 549                                            PLAYLIST_APPEND|PLAYLIST_PREPARSE|
 550                                            PLAYLIST_NO_REBUILD,
 551                                            PLAYLIST_END, NULL, NULL,
 552                                            pl_Unlocked );
 553                     vlc_gc_decref( p_input );
 554                     if( i_ret != VLC_SUCCESS )
 555                         return VLC_EGENERIC;
 556                 }
 557             }
 558         }
 559     }
 560
 561     for( i = 0; i < i_extensions; i++ )
 562         free( ppsz_extensions[i] );
 563     free( ppsz_extensions );
 564
 565     for( i = 0; i < i_dir_content; i++ )
 566         free( pp_dir_content[i] );
 567     free( pp_dir_content );
 568
 569     return i_return;
 570 }
 571
 572
 573 static DIR *OpenDir (vlc_object_t *obj, const char *path)
 574 {
 575     msg_Dbg (obj, "opening directory `%s'", path);
 576     DIR *handle = utf8_opendir (path);
 577     if (handle == NULL)
 578     {
 579         int err = errno;
 580         if (err != ENOTDIR)
 581             msg_Err (obj, "%s: %m", path);
 582         else
 583             msg_Dbg (obj, "skipping non-directory `%s'", path);
 584         errno = err;
 585
 586         return NULL;
 587     }
 588     return handle;
 589 }