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         add_shortcut( "directory" );
 110         set_callbacks( DemuxOpen, NULL );
 111 vlc_module_end();
 112
 113
 114 /*****************************************************************************
 115  * Local prototypes, constants, structures
 116  *****************************************************************************/
 117
 118 enum
 119 {
 120     MODE_EXPAND,
 121     MODE_COLLAPSE,
 122     MODE_NONE
 123 };
 124
 125 typedef struct stat_list_t stat_list_t;
 126
 127 static int Read( access_t *, uint8_t *, int );
 128 static int ReadNull( access_t *, uint8_t *, int );
 129 static int Control( access_t *, int, va_list );
 130
 131 static int Demux( demux_t *p_demux );
 132 static int DemuxControl( demux_t *p_demux, int i_query, va_list args );
 133
 134
 135 static int ReadDir( playlist_t *, const char *psz_name, int i_mode,
 136                     playlist_item_t *, playlist_item_t *, input_item_t *,
 137                     DIR *handle, stat_list_t *stats );
 138
 139 static DIR *OpenDir (vlc_object_t *obj, const char *psz_name);
 140
 141 /*****************************************************************************
 142  * Open: open the directory
 143  *****************************************************************************/
 144 static int Open( vlc_object_t *p_this )
 145 {
 146     access_t *p_access = (access_t*)p_this;
 147
 148     DIR *handle = OpenDir (p_this, p_access->psz_path);
 149     if (handle == NULL)
 150         return VLC_EGENERIC;
 151
 152     p_access->p_sys = (access_sys_t *)handle;
 153
 154     p_access->pf_read  = Read;
 155     p_access->pf_block = NULL;
 156     p_access->pf_seek  = NULL;
 157     p_access->pf_control= Control;
 158
 159     /* Force a demux */
 160     p_access->psz_demux = strdup( "directory" );
 161
 162     return VLC_SUCCESS;
 163 }
 164
 165 /*****************************************************************************
 166  * Close: close the target
 167  *****************************************************************************/
 168 static void Close( vlc_object_t * p_this )
 169 {
 170     access_t *p_access = (access_t*)p_this;
 171     DIR *handle = (DIR *)p_access->p_sys;
 172     closedir (handle);
 173 }
 174
 175 /*****************************************************************************
 176  * ReadNull: read the directory
 177  *****************************************************************************/
 178 static int ReadNull( access_t *p_access, uint8_t *p_buffer, int i_len)
 179 {
 180     /* Return fake data */
 181     memset( p_buffer, 0, i_len );
 182     return i_len;
 183 }
 184
 185 /*****************************************************************************
 186  * Read: read the directory
 187  *****************************************************************************/
 188 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len)
 189 {
 190     char               *psz;
 191     int                 i_mode, i_activity;
 192     char               *psz_name = strdup (p_access->psz_path);
 193
 194     if( psz_name == NULL )
 195         return VLC_ENOMEM;
 196
 197     playlist_t         *p_playlist = pl_Yield( p_access );
 198     playlist_item_t    *p_item_in_category;
 199     input_item_t       *p_current_input = input_GetItem(
 200                                     (input_thread_t*)p_access->p_parent);
 201     playlist_item_t    *p_current = playlist_ItemGetByInput( p_playlist,
 202                                                              p_current_input,
 203                                                              VLC_FALSE );
 204
 205     if( p_current == NULL )
 206     {
 207         msg_Err( p_access, "unable to find item in playlist" );
 208         vlc_object_release( p_playlist );
 209         return VLC_ENOOBJ;
 210     }
 211
 212     /* Remove the ending '/' char */
 213     if (psz_name[0])
 214     {
 215         char *ptr = psz_name + strlen (psz_name);
 216         switch (*--ptr)
 217         {
 218             case '/':
 219             case '\\':
 220                 *ptr = '\0';
 221         }
 222     }
 223
 224     /* Handle mode */
 225     psz = var_CreateGetString( p_access, "recursive" );
 226     if( *psz == '\0' || !strncmp( psz, "none" , 4 )  )
 227         i_mode = MODE_NONE;
 228     else if( !strncmp( psz, "collapse", 8 )  )
 229         i_mode = MODE_COLLAPSE;
 230     else
 231         i_mode = MODE_EXPAND;
 232     free( psz );
 233
 234     p_current->p_input->i_type = ITEM_TYPE_DIRECTORY;
 235     p_item_in_category = playlist_ItemToNode( p_playlist, p_current,
 236                                               VLC_FALSE );
 237
 238     i_activity = var_GetInteger( p_playlist, "activity" );
 239     var_SetInteger( p_playlist, "activity", i_activity +
 240                     DIRECTORY_ACTIVITY );
 241
 242     ReadDir( p_playlist, psz_name, i_mode, p_current, p_item_in_category,
 243              p_current_input, (DIR *)p_access->p_sys, NULL );
 244
 245     i_activity = var_GetInteger( p_playlist, "activity" );
 246     var_SetInteger( p_playlist, "activity", i_activity -
 247                     DIRECTORY_ACTIVITY );
 248
 249     playlist_Signal( p_playlist );
 250
 251     if( psz_name ) free( psz_name );
 252     vlc_object_release( p_playlist );
 253
 254     /* Return fake data forever */
 255     p_access->pf_read = ReadNull;
 256     return ReadNull( p_access, p_buffer, i_len );
 257 }
 258
 259 /*****************************************************************************
 260  * DemuxOpen:
 261  *****************************************************************************/
 262 static int Control( access_t *p_access, int i_query, va_list args )
 263 {
 264     vlc_bool_t   *pb_bool;
 265     int          *pi_int;
 266     int64_t      *pi_64;
 267
 268     switch( i_query )
 269     {
 270         /* */
 271         case ACCESS_CAN_SEEK:
 272         case ACCESS_CAN_FASTSEEK:
 273         case ACCESS_CAN_PAUSE:
 274         case ACCESS_CAN_CONTROL_PACE:
 275             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 276             *pb_bool = VLC_FALSE;    /* FIXME */
 277             break;
 278
 279         /* */
 280         case ACCESS_GET_MTU:
 281             pi_int = (int*)va_arg( args, int * );
 282             *pi_int = 0;
 283             break;
 284
 285         case ACCESS_GET_PTS_DELAY:
 286             pi_64 = (int64_t*)va_arg( args, int64_t * );
 287             *pi_64 = DEFAULT_PTS_DELAY * 1000;
 288             break;
 289
 290         /* */
 291         case ACCESS_SET_PAUSE_STATE:
 292         case ACCESS_GET_TITLE_INFO:
 293         case ACCESS_SET_TITLE:
 294         case ACCESS_SET_SEEKPOINT:
 295         case ACCESS_SET_PRIVATE_ID_STATE:
 296             return VLC_EGENERIC;
 297
 298         default:
 299             msg_Warn( p_access, "unimplemented query in control" );
 300             return VLC_EGENERIC;
 301     }
 302     return VLC_SUCCESS;
 303 }
 304
 305 /*****************************************************************************
 306  * DemuxOpen:
 307  *****************************************************************************/
 308 static int DemuxOpen ( vlc_object_t *p_this )
 309 {
 310     demux_t *p_demux = (demux_t*)p_this;
 311
 312     if( strcmp( p_demux->psz_demux, "directory" ) )
 313         return VLC_EGENERIC;
 314
 315     p_demux->pf_demux   = Demux;
 316     p_demux->pf_control = DemuxControl;
 317     return VLC_SUCCESS;
 318 }
 319
 320 /*****************************************************************************
 321  * Demux: EOF
 322  *****************************************************************************/
 323 static int Demux( demux_t *p_demux )
 324 {
 325     return 0;
 326 }
 327
 328 /*****************************************************************************
 329  * DemuxControl:
 330  *****************************************************************************/
 331 static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
 332 {
 333     return demux2_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
 334 }
 335
 336
 337 static int Sort (const char **a, const char **b)
 338 {
 339     return strcoll (*a, *b);
 340 }
 341
 342 struct stat_list_t
 343 {
 344     stat_list_t *parent;
 345     struct stat st;
 346 };
 347
 348
 349 /*****************************************************************************
 350  * ReadDir: read a directory and add its content to the list
 351  *****************************************************************************/
 352 static int ReadDir( playlist_t *p_playlist, const char *psz_name,
 353                     int i_mode, playlist_item_t *p_parent,
 354                     playlist_item_t *p_parent_category,
 355                     input_item_t *p_current_input,
 356                     DIR *handle, stat_list_t *stparent )
 357 {
 358     char **pp_dir_content = NULL;
 359     int             i_dir_content, i, i_return = VLC_SUCCESS;
 360     playlist_item_t *p_node;
 361
 362     char **ppsz_extensions = NULL;
 363     int i_extensions = 0;
 364     char *psz_ignore;
 365
 366     struct stat_list_t stself;
 367 #ifndef WIN32
 368     int fd = dirfd (handle);
 369
 370     if ((fd == -1) || fstat (fd, &stself.st))
 371     {
 372         msg_Err (p_playlist, "cannot stat `%s': %s", psz_name,
 373                  strerror (errno));
 374         return VLC_EGENERIC;
 375     }
 376
 377     for (stat_list_t *stats = stparent; stats != NULL; stats = stats->parent)
 378     {
 379         if ((stself.st.st_ino == stats->st.st_ino)
 380          && (stself.st.st_dev == stats->st.st_dev))
 381         {
 382             msg_Warn (p_playlist,
 383                       "ignoring infinitely recursive directory `%s'",
 384                       psz_name);
 385             return VLC_SUCCESS;
 386         }
 387     }
 388 #else
 389         /* Windows has st_dev (driver letter - 'A'), but it zeroes st_ino,
 390          * so that the test above will always incorrectly succeed.
 391          * Besides, Windows does not have dirfd(). */
 392 #endif
 393
 394     stself.parent = stparent;
 395
 396     /* Get the first directory entry */
 397     i_dir_content = utf8_loaddir (handle, &pp_dir_content, NULL, Sort);
 398     if( i_dir_content == -1 )
 399     {
 400         msg_Err (p_playlist, "cannot read `%s': %s", psz_name,
 401                  strerror (errno));
 402         return VLC_EGENERIC;
 403     }
 404     else if( i_dir_content <= 0 )
 405     {
 406         /* directory is empty */
 407         msg_Dbg( p_playlist, "%s directory is empty", psz_name );
 408         free( pp_dir_content );
 409         return VLC_SUCCESS;
 410     }
 411
 412     /* Build array with ignores */
 413     psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
 414     if( psz_ignore && *psz_ignore )
 415     {
 416         char *psz_parser = psz_ignore;
 417         int a;
 418
 419         for( a = 0; psz_parser[a] != '\0'; a++ )
 420         {
 421             if( psz_parser[a] == ',' ) i_extensions++;
 422         }
 423
 424         ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
 425
 426         for( a = 0; a < i_extensions; a++ )
 427         {
 428             char *tmp, *ptr;
 429
 430             while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
 431             ptr = strchr( psz_parser, ',');
 432             tmp = ( ptr == NULL )
 433                  ? strdup( psz_parser )
 434                  : strndup( psz_parser, ptr - psz_parser );
 435
 436             ppsz_extensions[a] = tmp;
 437             psz_parser = ptr + 1;
 438         }
 439     }
 440     if( psz_ignore ) free( psz_ignore );
 441
 442     /* While we still have entries in the directory */
 443     for( i = 0; i < i_dir_content; i++ )
 444     {
 445         const char *entry = pp_dir_content[i];
 446         int i_size_entry = strlen( psz_name ) +
 447                            strlen( entry ) + 2 + 7 /* strlen("file://") */;
 448         char psz_uri[i_size_entry];
 449
 450         sprintf( psz_uri, "%s/%s", psz_name, entry);
 451
 452         /* if it starts with '.' then forget it */
 453         if (entry[0] != '.')
 454         {
 455             DIR *subdir = (i_mode != MODE_COLLAPSE)
 456                     ? OpenDir (VLC_OBJECT (p_playlist), psz_uri) : NULL;
 457
 458             if (subdir != NULL) /* Recurse into subdirectory */
 459             {
 460                 if( i_mode == MODE_NONE )
 461                 {
 462                     msg_Dbg( p_playlist, "skipping subdirectory `%s'",
 463                              psz_uri );
 464                     closedir (subdir);
 465                     continue;
 466                 }
 467
 468                 msg_Dbg (p_playlist, "creating subdirectory %s", psz_uri);
 469
 470                 p_node = playlist_NodeCreate( p_playlist, entry,
 471                                               p_parent_category,
 472                                               PLAYLIST_NO_REBUILD );
 473
 474                 /* If we had the parent in category, the it is now node.
 475                  * Else, we still don't have  */
 476                 i_return = ReadDir( p_playlist, psz_uri , MODE_EXPAND,
 477                                     p_node, p_parent_category ? p_node : NULL,
 478                                     p_current_input, subdir, &stself );
 479                 closedir (subdir);
 480                 if (i_return)
 481                     break; // error :-(
 482             }
 483             else
 484             {
 485                 input_item_t *p_input;
 486
 487                 if( i_extensions > 0 )
 488                 {
 489                     const char *psz_dot = strrchr (entry, '.' );
 490                     if( psz_dot++ && *psz_dot )
 491                     {
 492                         int a;
 493                         for( a = 0; a < i_extensions; a++ )
 494                         {
 495                             if( !strcmp( psz_dot, ppsz_extensions[a] ) )
 496                                 break;
 497                         }
 498                         if( a < i_extensions )
 499                         {
 500                             msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
 501                             continue;
 502                         }
 503                     }
 504                 }
 505
 506                 memmove (psz_uri + 7, psz_uri, sizeof (psz_uri) - 7);
 507                 memcpy (psz_uri, "file://", 7);
 508                 p_input = input_ItemNewWithType( VLC_OBJECT(p_playlist),
 509                                                  psz_uri, entry, 0, NULL,
 510                                                  -1, ITEM_TYPE_VFILE );
 511                 if (p_input != NULL)
 512                 {
 513                     if( p_current_input )
 514                         input_ItemCopyOptions( p_current_input, p_input );
 515                     playlist_BothAddInput( p_playlist, p_input,
 516                                            p_parent_category,
 517                                            PLAYLIST_APPEND|PLAYLIST_PREPARSE|
 518                                            PLAYLIST_NO_REBUILD,
 519                                            PLAYLIST_END, NULL, NULL );
 520                 }
 521             }
 522         }
 523     }
 524
 525     for( i = 0; i < i_extensions; i++ )
 526         if( ppsz_extensions[i] ) free( ppsz_extensions[i] );
 527     if( ppsz_extensions ) free( ppsz_extensions );
 528
 529     for( i = 0; i < i_dir_content; i++ )
 530         if( pp_dir_content[i] ) free( pp_dir_content[i] );
 531     if( pp_dir_content ) free( pp_dir_content );
 532
 533     return i_return;
 534 }
 535
 536
 537 static DIR *OpenDir (vlc_object_t *obj, const char *path)
 538 {
 539     msg_Dbg (obj, "opening directory `%s'", path);
 540     DIR *handle = utf8_opendir (path);
 541     if (handle == NULL)
 542     {
 543         int err = errno;
 544         if (err != ENOTDIR)
 545             msg_Err (obj, "%s: %s", path, strerror (err));
 546         else
 547             msg_Dbg (obj, "skipping non-directory `%s'", path);
 548         errno = err;
 549
 550         return NULL;
 551     }
 552     return handle;
 553 }