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