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