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( access_t *, playlist_t *, const char *psz_name,
 139                     int i_mode, 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, pl_Unlocked );
 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                                               pl_Unlocked );
 258
 259     ReadDir( p_access, p_playlist, psz_name, i_mode,
 260              p_item_in_category,
 261              p_current_input, (DIR *)p_access->p_sys, NULL );
 262
 263     playlist_Signal( p_playlist );
 264
 265     free( psz_name );
 266     vlc_object_release( p_input );
 267     vlc_object_release( p_playlist );
 268
 269     /* Return fake data forever */
 270     p_access->pf_read = ReadNull;
 271     return -1;
 272 }
 273
 274 /*****************************************************************************
 275  * Control:
 276  *****************************************************************************/
 277 static int Control( access_t *p_access, int i_query, va_list args )
 278 {
 279     bool   *pb_bool;
 280     int          *pi_int;
 281     int64_t      *pi_64;
 282
 283     switch( i_query )
 284     {
 285         /* */
 286         case ACCESS_CAN_SEEK:
 287         case ACCESS_CAN_FASTSEEK:
 288         case ACCESS_CAN_PAUSE:
 289         case ACCESS_CAN_CONTROL_PACE:
 290             pb_bool = (bool*)va_arg( args, bool* );
 291             *pb_bool = false;    /* FIXME */
 292             break;
 293
 294         /* */
 295         case ACCESS_GET_MTU:
 296             pi_int = (int*)va_arg( args, int * );
 297             *pi_int = 0;
 298             break;
 299
 300         case ACCESS_GET_PTS_DELAY:
 301             pi_64 = (int64_t*)va_arg( args, int64_t * );
 302             *pi_64 = DEFAULT_PTS_DELAY * 1000;
 303             break;
 304
 305         /* */
 306         case ACCESS_SET_PAUSE_STATE:
 307         case ACCESS_GET_TITLE_INFO:
 308         case ACCESS_SET_TITLE:
 309         case ACCESS_SET_SEEKPOINT:
 310         case ACCESS_SET_PRIVATE_ID_STATE:
 311         case ACCESS_GET_CONTENT_TYPE:
 312             return VLC_EGENERIC;
 313
 314         default:
 315             msg_Warn( p_access, "unimplemented query in control" );
 316             return VLC_EGENERIC;
 317     }
 318     return VLC_SUCCESS;
 319 }
 320
 321 /*****************************************************************************
 322  * DemuxOpen:
 323  *****************************************************************************/
 324 static int DemuxOpen ( vlc_object_t *p_this )
 325 {
 326     demux_t *p_demux = (demux_t*)p_this;
 327
 328     if( strcmp( p_demux->psz_demux, "directory" ) )
 329         return VLC_EGENERIC;
 330
 331     p_demux->pf_demux   = Demux;
 332     p_demux->pf_control = DemuxControl;
 333     return VLC_SUCCESS;
 334 }
 335
 336 /*****************************************************************************
 337  * Demux: EOF
 338  *****************************************************************************/
 339 static int Demux( demux_t *p_demux )
 340 {
 341     return 0;
 342 }
 343
 344 /*****************************************************************************
 345  * DemuxControl:
 346  *****************************************************************************/
 347 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
 348 {
 349     return demux_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
 350 }
 351
 352
 353 static int Sort (const char **a, const char **b)
 354 {
 355     return strcoll (*a, *b);
 356 }
 357
 358 struct stat_list_t
 359 {
 360     stat_list_t *parent;
 361     struct stat st;
 362 };
 363
 364
 365 /*****************************************************************************
 366  * ReadDir: read a directory and add its content to the list
 367  *****************************************************************************/
 368 static int ReadDir( access_t *p_access, playlist_t *p_playlist,
 369                     const char *psz_name,
 370                     int i_mode,
 371                     playlist_item_t *p_parent_category,
 372                     input_item_t *p_current_input,
 373                     DIR *handle, stat_list_t *stparent )
 374 {
 375     char **pp_dir_content = NULL;
 376     int             i_dir_content, i, i_return = VLC_SUCCESS;
 377     playlist_item_t *p_node;
 378
 379     if( !vlc_object_alive( p_access ) )
 380         return VLC_EGENERIC;
 381
 382     if( !vlc_object_alive( p_playlist ) )
 383         return VLC_EGENERIC;
 384
 385     char **ppsz_extensions = NULL;
 386     int i_extensions = 0;
 387     char *psz_ignore;
 388
 389     struct stat_list_t stself;
 390 #ifndef WIN32
 391     int fd = dirfd (handle);
 392
 393     if ((fd == -1) || fstat (fd, &stself.st))
 394     {
 395         msg_Err (p_playlist, "cannot stat `%s': %m", psz_name);
 396         return VLC_EGENERIC;
 397     }
 398
 399     for (stat_list_t *stats = stparent; stats != NULL; stats = stats->parent)
 400     {
 401         if ((stself.st.st_ino == stats->st.st_ino)
 402          && (stself.st.st_dev == stats->st.st_dev))
 403         {
 404             msg_Warn (p_playlist,
 405                       "ignoring infinitely recursive directory `%s'",
 406                       psz_name);
 407             return VLC_SUCCESS;
 408         }
 409     }
 410 #else
 411         /* Windows has st_dev (driver letter - 'A'), but it zeroes st_ino,
 412          * so that the test above will always incorrectly succeed.
 413          * Besides, Windows does not have dirfd(). */
 414 #endif
 415
 416     stself.parent = stparent;
 417
 418     /* Get the first directory entry */
 419     i_dir_content = utf8_loaddir (handle, &pp_dir_content, NULL, Sort);
 420     if( i_dir_content == -1 )
 421     {
 422         msg_Err (p_playlist, "cannot read `%s': %m", psz_name);
 423         return VLC_EGENERIC;
 424     }
 425     else if( i_dir_content <= 0 )
 426     {
 427         /* directory is empty */
 428         msg_Dbg( p_playlist, "%s directory is empty", psz_name );
 429         free( pp_dir_content );
 430         return VLC_SUCCESS;
 431     }
 432
 433     /* Build array with ignores */
 434     psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
 435     if( psz_ignore && *psz_ignore )
 436     {
 437         char *psz_parser = psz_ignore;
 438         int a;
 439
 440         for( a = 0; psz_parser[a] != '\0'; a++ )
 441         {
 442             if( psz_parser[a] == ',' ) i_extensions++;
 443         }
 444
 445         ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
 446
 447         for( a = 0; a < i_extensions; a++ )
 448         {
 449             char *tmp, *ptr;
 450
 451             while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
 452             ptr = strchr( psz_parser, ',');
 453             tmp = ( ptr == NULL )
 454                  ? strdup( psz_parser )
 455                  : strndup( psz_parser, ptr - psz_parser );
 456
 457             ppsz_extensions[a] = tmp;
 458             psz_parser = ptr + 1;
 459         }
 460     }
 461     free( psz_ignore );
 462
 463     /* While we still have entries in the directory */
 464     for( i = 0; i < i_dir_content; i++ )
 465     {
 466         const char *entry = pp_dir_content[i];
 467         int i_size_entry = strlen( psz_name ) +
 468                            strlen( entry ) + 2 + 7 /* strlen("file://") */;
 469         char psz_uri[i_size_entry];
 470
 471         sprintf( psz_uri, "%s/%s", psz_name, entry);
 472
 473         /* if it starts with '.' then forget it */
 474         if (entry[0] != '.')
 475         {
 476             DIR *subdir = (i_mode != MODE_COLLAPSE)
 477                     ? OpenDir (VLC_OBJECT (p_playlist), psz_uri) : NULL;
 478
 479             if (subdir != NULL) /* Recurse into subdirectory */
 480             {
 481                 if( i_mode == MODE_NONE )
 482                 {
 483                     msg_Dbg( p_playlist, "skipping subdirectory `%s'",
 484                              psz_uri );
 485                     closedir (subdir);
 486                     continue;
 487                 }
 488
 489                 msg_Dbg (p_playlist, "creating subdirectory %s", psz_uri);
 490
 491                 PL_LOCK;
 492                 p_node = playlist_NodeCreate( p_playlist, entry,
 493                                               p_parent_category,
 494                                               PLAYLIST_NO_REBUILD, NULL );
 495                 PL_UNLOCK;
 496
 497                 /* If we had the parent in category, the it is now node.
 498                  * Else, we still don't have  */
 499                 i_return = ReadDir( p_access, p_playlist, psz_uri , MODE_EXPAND,
 500                                     p_parent_category ? p_node : NULL,
 501                                     p_current_input, subdir, &stself );
 502                 closedir (subdir);
 503                 if (i_return)
 504                     break; // error :-(
 505             }
 506             else
 507             {
 508                 input_item_t *p_input;
 509
 510                 if( i_extensions > 0 )
 511                 {
 512                     const char *psz_dot = strrchr (entry, '.' );
 513                     if( psz_dot++ && *psz_dot )
 514                     {
 515                         int a;
 516                         for( a = 0; a < i_extensions; a++ )
 517                         {
 518                             if( !strcmp( psz_dot, ppsz_extensions[a] ) )
 519                                 break;
 520                         }
 521                         if( a < i_extensions )
 522                         {
 523                             msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
 524                             continue;
 525                         }
 526                     }
 527                 }
 528
 529                 memmove (psz_uri + 7, psz_uri, sizeof (psz_uri) - 7);
 530                 memcpy (psz_uri, "file://", 7);
 531                 p_input = input_ItemNewWithType( p_playlist,
 532                                                  psz_uri, entry, 0, NULL,
 533                                                  -1, ITEM_TYPE_FILE );
 534                 if (p_input != NULL)
 535                 {
 536                     if( p_current_input )
 537                         input_ItemCopyOptions( p_current_input, p_input );
 538                     int i_ret = playlist_BothAddInput( p_playlist, p_input,
 539                                            p_parent_category,
 540                                            PLAYLIST_APPEND|PLAYLIST_PREPARSE|
 541                                            PLAYLIST_NO_REBUILD,
 542                                            PLAYLIST_END, NULL, NULL,
 543                                            pl_Unlocked );
 544                     vlc_gc_decref( p_input );
 545                     if( i_ret != VLC_SUCCESS )
 546                         return VLC_EGENERIC;
 547                 }
 548             }
 549         }
 550     }
 551
 552     for( i = 0; i < i_extensions; i++ )
 553         free( ppsz_extensions[i] );
 554     free( ppsz_extensions );
 555
 556     for( i = 0; i < i_dir_content; i++ )
 557         free( pp_dir_content[i] );
 558     free( pp_dir_content );
 559
 560     return i_return;
 561 }
 562
 563
 564 static DIR *OpenDir (vlc_object_t *obj, const char *path)
 565 {
 566     msg_Dbg (obj, "opening directory `%s'", path);
 567     DIR *handle = utf8_opendir (path);
 568     if (handle == NULL)
 569     {
 570         int err = errno;
 571         if (err != ENOTDIR)
 572             msg_Err (obj, "%s: %m", path);
 573         else
 574             msg_Dbg (obj, "skipping non-directory `%s'", path);
 575         errno = err;
 576
 577         return NULL;
 578     }
 579     return handle;
 580 }