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