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