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 <vlc/vlc.h>
  34 #include <vlc_plugin.h>
  35 #include <vlc_playlist.h>
  36 #include <vlc_input.h>
  37 #include <vlc_access.h>
  38 #include <vlc_demux.h>
  39
  40 #ifdef HAVE_SYS_TYPES_H
  41 #   include <sys/types.h>
  42 #endif
  43 #ifdef HAVE_SYS_STAT_H
  44 #   include <sys/stat.h>
  45 #endif
  46 #ifdef HAVE_ERRNO_H
  47 #   include <errno.h>
  48 #endif
  49 #ifdef HAVE_FCNTL_H
  50 #   include <fcntl.h>
  51 #endif
  52
  53 #ifdef HAVE_UNISTD_H
  54 #   include <unistd.h>
  55 #elif defined( WIN32 ) && !defined( UNDER_CE )
  56 #   include <io.h>
  57 #elif defined( UNDER_CE )
  58 #   define strcoll strcmp
  59 #endif
  60
  61 #ifdef HAVE_DIRENT_H
  62 #   include <dirent.h>
  63 #endif
  64
  65 #include <vlc_charset.h>
  66
  67 /*****************************************************************************
  68  * Module descriptor
  69  *****************************************************************************/
  70 static int  Open ( vlc_object_t * );
  71 static void Close( vlc_object_t * );
  72
  73 static int  DemuxOpen ( vlc_object_t * );
  74
  75 #define RECURSIVE_TEXT N_("Subdirectory behavior")
  76 #define RECURSIVE_LONGTEXT N_( \
  77         "Select whether subdirectories must be expanded.\n" \
  78         "none: subdirectories do not appear in the playlist.\n" \
  79         "collapse: subdirectories appear but are expanded on first play.\n" \
  80         "expand: all subdirectories are expanded.\n" )
  81
  82 static const char *psz_recursive_list[] = { "none", "collapse", "expand" };
  83 static const char *psz_recursive_list_text[] = { N_("none"), N_("collapse"),
  84                                                  N_("expand") };
  85
  86 #define IGNORE_TEXT N_("Ignored extensions")
  87 #define IGNORE_LONGTEXT N_( \
  88         "Files with these extensions will not be added to playlist when " \
  89         "opening a directory.\n" \
  90         "This is useful if you add directories that contain playlist files " \
  91         "for instance. Use a comma-separated list of extensions." )
  92
  93 vlc_module_begin();
  94     set_category( CAT_INPUT );
  95     set_shortname( _("Directory" ) );
  96     set_subcategory( SUBCAT_INPUT_ACCESS );
  97     set_description( _("Standard filesystem directory input") );
  98     set_capability( "access", 55 );
  99     add_shortcut( "directory" );
 100     add_shortcut( "dir" );
 101     add_shortcut( "file" );
 102     add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
 103                 RECURSIVE_LONGTEXT, false );
 104       change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
 105     add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
 106                 NULL, IGNORE_TEXT, IGNORE_LONGTEXT, false );
 107     set_callbacks( Open, Close );
 108
 109     add_submodule();
 110         set_description( "Directory EOF");
 111         set_capability( "demux", 0 );
 112         set_callbacks( DemuxOpen, NULL );
 113 vlc_module_end();
 114
 115
 116 /*****************************************************************************
 117  * Local prototypes, constants, structures
 118  *****************************************************************************/
 119
 120 enum
 121 {
 122     MODE_EXPAND,
 123     MODE_COLLAPSE,
 124     MODE_NONE
 125 };
 126
 127 typedef struct stat_list_t stat_list_t;
 128
 129 static ssize_t Read( access_t *, uint8_t *, size_t );
 130 static ssize_t ReadNull( access_t *, uint8_t *, size_t );
 131 static int Control( access_t *, int, va_list );
 132
 133 static int Demux( demux_t *p_demux );
 134 static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
 135
 136
 137 static int ReadDir( playlist_t *, const char *psz_name, int i_mode,
 138                     playlist_item_t *, playlist_item_t *, input_item_t *,
 139                     DIR *handle, stat_list_t *stats );
 140
 141 static DIR *OpenDir (vlc_object_t *obj, const char *psz_name);
 142
 143 /*****************************************************************************
 144  * Open: open the directory
 145  *****************************************************************************/
 146 static int Open( vlc_object_t *p_this )
 147 {
 148     access_t *p_access = (access_t*)p_this;
 149
 150     if( !p_access->psz_path )
 151         return VLC_EGENERIC;
 152
 153     struct stat st;
 154     if( !stat( p_access->psz_path, &st ) && !S_ISDIR( st.st_mode ) )
 155         return VLC_EGENERIC;
 156
 157     DIR *handle = OpenDir (p_this, p_access->psz_path);
 158     if (handle == NULL)
 159         return VLC_EGENERIC;
 160
 161     p_access->p_sys = (access_sys_t *)handle;
 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     free( p_access->psz_demux );
 170     p_access->psz_demux = strdup( "directory" );
 171
 172     return VLC_SUCCESS;
 173 }
 174
 175 /*****************************************************************************
 176  * Close: close the target
 177  *****************************************************************************/
 178 static void Close( vlc_object_t * p_this )
 179 {
 180     access_t *p_access = (access_t*)p_this;
 181     DIR *handle = (DIR *)p_access->p_sys;
 182     closedir (handle);
 183 }
 184
 185 /*****************************************************************************
 186  * ReadNull: read the directory
 187  *****************************************************************************/
 188 static ssize_t ReadNull( access_t *p_access, uint8_t *p_buffer, size_t 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 ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len)
 199 {
 200     char               *psz;
 201     int                 i_mode, i_activity;
 202     char               *psz_name = strdup (p_access->psz_path);
 203
 204     if( psz_name == NULL )
 205         return VLC_ENOMEM;
 206
 207     playlist_t         *p_playlist = pl_Yield( p_access );
 208     input_thread_t     *p_input = (input_thread_t*)vlc_object_find( p_access, VLC_OBJECT_INPUT, FIND_PARENT );
 209
 210     playlist_item_t    *p_item_in_category;
 211     input_item_t       *p_current_input;
 212     playlist_item_t    *p_current;
 213
 214     if( !p_input )
 215     {
 216         msg_Err( p_access, "unable to find input (internal error)" );
 217         vlc_object_release( p_playlist );
 218         return VLC_ENOOBJ;
 219     }
 220
 221     p_current_input = input_GetItem( p_input );
 222     p_current = playlist_ItemGetByInput( p_playlist, p_current_input, false );
 223
 224     if( !p_current )
 225     {
 226         msg_Err( p_access, "unable to find item in playlist" );
 227         vlc_object_release( p_input );
 228         vlc_object_release( p_playlist );
 229         return VLC_ENOOBJ;
 230     }
 231
 232     /* Remove the ending '/' char */
 233     if( psz_name[0] )
 234     {
 235         char *ptr = psz_name + strlen (psz_name);
 236         switch (*--ptr)
 237         {
 238             case '/':
 239             case '\\':
 240                 *ptr = '\0';
 241         }
 242     }
 243
 244     /* Handle mode */
 245     psz = var_CreateGetString( p_access, "recursive" );
 246     if( *psz == '\0' || !strncmp( psz, "none" , 4 )  )
 247         i_mode = MODE_NONE;
 248     else if( !strncmp( psz, "collapse", 8 )  )
 249         i_mode = MODE_COLLAPSE;
 250     else
 251         i_mode = MODE_EXPAND;
 252     free( psz );
 253
 254     p_current->p_input->i_type = ITEM_TYPE_DIRECTORY;
 255     p_item_in_category = playlist_ItemToNode( p_playlist, p_current,
 256                                               false );
 257
 258     i_activity = var_GetInteger( p_playlist, "activity" );
 259     var_SetInteger( p_playlist, "activity", i_activity +
 260                     DIRECTORY_ACTIVITY );
 261
 262     ReadDir( p_playlist, psz_name, i_mode, p_current, p_item_in_category,
 263              p_current_input, (DIR *)p_access->p_sys, NULL );
 264
 265     i_activity = var_GetInteger( p_playlist, "activity" );
 266     var_SetInteger( p_playlist, "activity", i_activity -
 267                     DIRECTORY_ACTIVITY );
 268
 269     playlist_Signal( p_playlist );
 270
 271     free( psz_name );
 272     vlc_object_release( p_input );
 273     vlc_object_release( p_playlist );
 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             return VLC_EGENERIC;
 319
 320         default:
 321             msg_Warn( p_access, "unimplemented query in control" );
 322             return VLC_EGENERIC;
 323     }
 324     return VLC_SUCCESS;
 325 }
 326
 327 /*****************************************************************************
 328  * DemuxOpen:
 329  *****************************************************************************/
 330 static int DemuxOpen ( vlc_object_t *p_this )
 331 {
 332     demux_t *p_demux = (demux_t*)p_this;
 333
 334     if( strcmp( p_demux->psz_demux, "directory" ) )
 335         return VLC_EGENERIC;
 336
 337     p_demux->pf_demux   = Demux;
 338     p_demux->pf_control = DemuxControl;
 339     return VLC_SUCCESS;
 340 }
 341
 342 /*****************************************************************************
 343  * Demux: EOF
 344  *****************************************************************************/
 345 static int Demux( demux_t *p_demux )
 346 {
 347     return 0;
 348 }
 349
 350 /*****************************************************************************
 351  * DemuxControl:
 352  *****************************************************************************/
 353 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
 354 {
 355     return demux_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
 356 }
 357
 358
 359 static int Sort (const char **a, const char **b)
 360 {
 361     return strcoll (*a, *b);
 362 }
 363
 364 struct stat_list_t
 365 {
 366     stat_list_t *parent;
 367     struct stat st;
 368 };
 369
 370
 371 /*****************************************************************************
 372  * ReadDir: read a directory and add its content to the list
 373  *****************************************************************************/
 374 static int ReadDir( playlist_t *p_playlist, const char *psz_name,
 375                     int i_mode, playlist_item_t *p_parent,
 376                     playlist_item_t *p_parent_category,
 377                     input_item_t *p_current_input,
 378                     DIR *handle, stat_list_t *stparent )
 379 {
 380     char **pp_dir_content = NULL;
 381     int             i_dir_content, i, i_return = VLC_SUCCESS;
 382     playlist_item_t *p_node;
 383
 384     char **ppsz_extensions = NULL;
 385     int i_extensions = 0;
 386     char *psz_ignore;
 387
 388     struct stat_list_t stself;
 389 #ifndef WIN32
 390     int fd = dirfd (handle);
 391
 392     if ((fd == -1) || fstat (fd, &stself.st))
 393     {
 394         msg_Err (p_playlist, "cannot stat `%s': %m", psz_name);
 395         return VLC_EGENERIC;
 396     }
 397
 398     for (stat_list_t *stats = stparent; stats != NULL; stats = stats->parent)
 399     {
 400         if ((stself.st.st_ino == stats->st.st_ino)
 401          && (stself.st.st_dev == stats->st.st_dev))
 402         {
 403             msg_Warn (p_playlist,
 404                       "ignoring infinitely recursive directory `%s'",
 405                       psz_name);
 406             return VLC_SUCCESS;
 407         }
 408     }
 409 #else
 410         /* Windows has st_dev (driver letter - 'A'), but it zeroes st_ino,
 411          * so that the test above will always incorrectly succeed.
 412          * Besides, Windows does not have dirfd(). */
 413 #endif
 414
 415     stself.parent = stparent;
 416
 417     /* Get the first directory entry */
 418     i_dir_content = utf8_loaddir (handle, &pp_dir_content, NULL, Sort);
 419     if( i_dir_content == -1 )
 420     {
 421         msg_Err (p_playlist, "cannot read `%s': %m", psz_name);
 422         return VLC_EGENERIC;
 423     }
 424     else if( i_dir_content <= 0 )
 425     {
 426         /* directory is empty */
 427         msg_Dbg( p_playlist, "%s directory is empty", psz_name );
 428         free( pp_dir_content );
 429         return VLC_SUCCESS;
 430     }
 431
 432     /* Build array with ignores */
 433     psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
 434     if( psz_ignore && *psz_ignore )
 435     {
 436         char *psz_parser = psz_ignore;
 437         int a;
 438
 439         for( a = 0; psz_parser[a] != '\0'; a++ )
 440         {
 441             if( psz_parser[a] == ',' ) i_extensions++;
 442         }
 443
 444         ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
 445
 446         for( a = 0; a < i_extensions; a++ )
 447         {
 448             char *tmp, *ptr;
 449
 450             while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
 451             ptr = strchr( psz_parser, ',');
 452             tmp = ( ptr == NULL )
 453                  ? strdup( psz_parser )
 454                  : strndup( psz_parser, ptr - psz_parser );
 455
 456             ppsz_extensions[a] = tmp;
 457             psz_parser = ptr + 1;
 458         }
 459     }
 460     free( psz_ignore );
 461
 462     /* While we still have entries in the directory */
 463     for( i = 0; i < i_dir_content; i++ )
 464     {
 465         const char *entry = pp_dir_content[i];
 466         int i_size_entry = strlen( psz_name ) +
 467                            strlen( entry ) + 2 + 7 /* strlen("file://") */;
 468         char psz_uri[i_size_entry];
 469
 470         sprintf( psz_uri, "%s/%s", psz_name, entry);
 471
 472         /* if it starts with '.' then forget it */
 473         if (entry[0] != '.')
 474         {
 475             DIR *subdir = (i_mode != MODE_COLLAPSE)
 476                     ? OpenDir (VLC_OBJECT (p_playlist), psz_uri) : NULL;
 477
 478             if (subdir != NULL) /* Recurse into subdirectory */
 479             {
 480                 if( i_mode == MODE_NONE )
 481                 {
 482                     msg_Dbg( p_playlist, "skipping subdirectory `%s'",
 483                              psz_uri );
 484                     closedir (subdir);
 485                     continue;
 486                 }
 487
 488                 msg_Dbg (p_playlist, "creating subdirectory %s", psz_uri);
 489
 490                 p_node = playlist_NodeCreate( p_playlist, entry,
 491                                               p_parent_category,
 492                                               PLAYLIST_NO_REBUILD, NULL );
 493
 494                 /* If we had the parent in category, the it is now node.
 495                  * Else, we still don't have  */
 496                 i_return = ReadDir( p_playlist, psz_uri , MODE_EXPAND,
 497                                     p_node, p_parent_category ? p_node : NULL,
 498                                     p_current_input, subdir, &stself );
 499                 closedir (subdir);
 500                 if (i_return)
 501                     break; // error :-(
 502             }
 503             else
 504             {
 505                 input_item_t *p_input;
 506
 507                 if( i_extensions > 0 )
 508                 {
 509                     const char *psz_dot = strrchr (entry, '.' );
 510                     if( psz_dot++ && *psz_dot )
 511                     {
 512                         int a;
 513                         for( a = 0; a < i_extensions; a++ )
 514                         {
 515                             if( !strcmp( psz_dot, ppsz_extensions[a] ) )
 516                                 break;
 517                         }
 518                         if( a < i_extensions )
 519                         {
 520                             msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
 521                             continue;
 522                         }
 523                     }
 524                 }
 525
 526                 memmove (psz_uri + 7, psz_uri, sizeof (psz_uri) - 7);
 527                 memcpy (psz_uri, "file://", 7);
 528                 p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist),
 529                                                  psz_uri, entry, 0, NULL,
 530                                                  -1, ITEM_TYPE_FILE );
 531                 if (p_input != NULL)
 532                 {
 533                     if( p_current_input )
 534                         input_ItemCopyOptions( p_current_input, p_input );
 535                     int i_ret = playlist_BothAddInput( p_playlist, p_input,
 536                                            p_parent_category,
 537                                            PLAYLIST_APPEND|PLAYLIST_PREPARSE|
 538                                            PLAYLIST_NO_REBUILD,
 539                                            PLAYLIST_END, NULL, NULL,
 540                                            false );
 541                     vlc_gc_decref( p_input );
 542                     if( i_ret != VLC_SUCCESS )
 543                         return VLC_EGENERIC;
 544                 }
 545             }
 546         }
 547     }
 548
 549     for( i = 0; i < i_extensions; i++ )
 550         free( ppsz_extensions[i] );
 551     free( ppsz_extensions );
 552
 553     for( i = 0; i < i_dir_content; i++ )
 554         free( pp_dir_content[i] );
 555     free( pp_dir_content );
 556
 557     return i_return;
 558 }
 559
 560
 561 static DIR *OpenDir (vlc_object_t *obj, const char *path)
 562 {
 563     msg_Dbg (obj, "opening directory `%s'", path);
 564     DIR *handle = utf8_opendir (path);
 565     if (handle == NULL)
 566     {
 567         int err = errno;
 568         if (err != ENOTDIR)
 569             msg_Err (obj, "%s: %m", path);
 570         else
 571             msg_Dbg (obj, "skipping non-directory `%s'", path);
 572         errno = err;
 573
 574         return NULL;
 575     }
 576     return handle;
 577 }