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