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