directory.c 18.4 KB
Newer Older
1 2 3
/*****************************************************************************
 * directory.c: expands a directory (directory: access plug-in)
 *****************************************************************************
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 11 12 13
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
14
 *
15 16 17 18 19 20 21
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 24 25 26 27
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
28

29 30 31 32
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

33
#include <assert.h>
34
#include <vlc_common.h>
35
#include <vlc_plugin.h>
36
#warning playlist code must not be used here.
37
#include <vlc_playlist.h>
38
#include <vlc_input.h>
Clément Stenac's avatar
Clément Stenac committed
39 40
#include <vlc_access.h>
#include <vlc_demux.h>
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58

#ifdef HAVE_SYS_TYPES_H
#   include <sys/types.h>
#endif
#ifdef HAVE_SYS_STAT_H
#   include <sys/stat.h>
#endif
#ifdef HAVE_ERRNO_H
#   include <errno.h>
#endif
#ifdef HAVE_FCNTL_H
#   include <fcntl.h>
#endif

#ifdef HAVE_UNISTD_H
#   include <unistd.h>
#elif defined( WIN32 ) && !defined( UNDER_CE )
#   include <io.h>
59 60
#elif defined( UNDER_CE )
#   define strcoll strcmp
61 62
#endif

63
#ifdef HAVE_DIRENT_H
64 65 66
#   include <dirent.h>
#endif

Clément Stenac's avatar
Clément Stenac committed
67
#include <vlc_charset.h>
68

69
/*****************************************************************************
70
 * Module descriptor
71
 *****************************************************************************/
72 73
static int  Open ( vlc_object_t * );
static void Close( vlc_object_t * );
74

75
static int  DemuxOpen ( vlc_object_t * );
76

77
#define RECURSIVE_TEXT N_("Subdirectory behavior")
78 79
#define RECURSIVE_LONGTEXT N_( \
        "Select whether subdirectories must be expanded.\n" \
80 81 82
        "none: subdirectories do not appear in the playlist.\n" \
        "collapse: subdirectories appear but are expanded on first play.\n" \
        "expand: all subdirectories are expanded.\n" )
83

84 85 86
static const char *const psz_recursive_list[] = { "none", "collapse", "expand" };
static const char *const psz_recursive_list_text[] = {
    N_("none"), N_("collapse"), N_("expand") };
87

Clément Stenac's avatar
Clément Stenac committed
88
#define IGNORE_TEXT N_("Ignored extensions")
89
#define IGNORE_LONGTEXT N_( \
Clément Stenac's avatar
Clément Stenac committed
90 91 92 93
        "Files with these extensions will not be added to playlist when " \
        "opening a directory.\n" \
        "This is useful if you add directories that contain playlist files " \
        "for instance. Use a comma-separated list of extensions." )
94

95
vlc_module_begin();
96
    set_category( CAT_INPUT );
97
    set_shortname( N_("Directory" ) );
98
    set_subcategory( SUBCAT_INPUT_ACCESS );
99
    set_description( N_("Standard filesystem directory input") );
100
    set_capability( "access", 55 );
101 102
    add_shortcut( "directory" );
    add_shortcut( "dir" );
103
    add_shortcut( "file" );
104
    add_string( "recursive", "expand" , NULL, RECURSIVE_TEXT,
105
                RECURSIVE_LONGTEXT, false );
106
      change_string_list( psz_recursive_list, psz_recursive_list_text, 0 );
107
    add_string( "ignore-filetypes", "m3u,db,nfo,jpg,gif,sfv,txt,sub,idx,srt,cue",
108
                NULL, IGNORE_TEXT, IGNORE_LONGTEXT, false );
109
    set_callbacks( Open, Close );
110 111

    add_submodule();
112
        set_description( "Directory EOF");
113
        set_capability( "demux", 0 );
114
        set_callbacks( DemuxOpen, NULL );
115 116 117
vlc_module_end();


118 119 120 121
/*****************************************************************************
 * Local prototypes, constants, structures
 *****************************************************************************/

122 123 124 125 126 127 128 129
enum
{
    MODE_EXPAND,
    MODE_COLLAPSE,
    MODE_NONE
};

typedef struct stat_list_t stat_list_t;
130

131 132
static ssize_t Read( access_t *, uint8_t *, size_t );
static ssize_t ReadNull( access_t *, uint8_t *, size_t );
133 134 135 136 137 138
static int Control( access_t *, int, va_list );

static int Demux( demux_t *p_demux );
static int DemuxControl( demux_t *p_demux, int i_query, va_list args );


139 140
static int ReadDir( access_t *, playlist_t *, const char *psz_name,
                    int i_mode, playlist_item_t *, input_item_t *,
141 142 143
                    DIR *handle, stat_list_t *stats );

static DIR *OpenDir (vlc_object_t *obj, const char *psz_name);
144

145 146 147 148 149
/*****************************************************************************
 * Open: open the directory
 *****************************************************************************/
static int Open( vlc_object_t *p_this )
{
150
    access_t *p_access = (access_t*)p_this;
151

152 153 154 155 156 157 158
    if( !p_access->psz_path )
        return VLC_EGENERIC;

    struct stat st;
    if( !stat( p_access->psz_path, &st ) && !S_ISDIR( st.st_mode ) )
        return VLC_EGENERIC;

159 160
    DIR *handle = OpenDir (p_this, p_access->psz_path);
    if (handle == NULL)
161
        return VLC_EGENERIC;
Gildas Bazin's avatar
 
Gildas Bazin committed
162

163 164
    p_access->p_sys = (access_sys_t *)handle;

165 166 167 168 169
    p_access->pf_read  = Read;
    p_access->pf_block = NULL;
    p_access->pf_seek  = NULL;
    p_access->pf_control= Control;

170
    /* Force a demux */
Rafaël Carré's avatar
Rafaël Carré committed
171
    free( p_access->psz_demux );
172
    p_access->psz_demux = strdup( "directory" );
Gildas Bazin's avatar
 
Gildas Bazin committed
173

174 175 176 177 178 179 180 181
    return VLC_SUCCESS;
}

/*****************************************************************************
 * Close: close the target
 *****************************************************************************/
static void Close( vlc_object_t * p_this )
{
182 183 184
    access_t *p_access = (access_t*)p_this;
    DIR *handle = (DIR *)p_access->p_sys;
    closedir (handle);
185 186 187 188 189
}

/*****************************************************************************
 * ReadNull: read the directory
 *****************************************************************************/
190
static ssize_t ReadNull( access_t *p_access, uint8_t *p_buffer, size_t i_len)
191
{
192
    (void)p_access;
193 194 195
    /* Return fake data */
    memset( p_buffer, 0, i_len );
    return i_len;
196 197 198
}

/*****************************************************************************
199
 * Read: read the directory
200
 *****************************************************************************/
201
static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len)
202
{
Rémi Duraffort's avatar
Rémi Duraffort committed
203
    (void)p_buffer;    (void)i_len;
204
    char               *psz;
205
    int                 i_mode;
206
    char               *psz_name = strdup( p_access->psz_path );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
207 208 209 210

    if( psz_name == NULL )
        return VLC_ENOMEM;

Antoine Cellerier's avatar
Antoine Cellerier committed
211
    playlist_t         *p_playlist = pl_Hold( p_access );
212 213
    input_thread_t     *p_input = (input_thread_t*)vlc_object_find( p_access, VLC_OBJECT_INPUT, FIND_PARENT );

214
    playlist_item_t    *p_item_in_category;
215 216 217 218 219 220
    input_item_t       *p_current_input;
    playlist_item_t    *p_current;

    if( !p_input )
    {
        msg_Err( p_access, "unable to find input (internal error)" );
221
        free( psz_name );
Rémi Duraffort's avatar
Rémi Duraffort committed
222
        pl_Release( p_access );
223 224 225 226
        return VLC_ENOOBJ;
    }

    p_current_input = input_GetItem( p_input );
227
    p_current = playlist_ItemGetByInput( p_playlist, p_current_input, pl_Unlocked );
228

229
    if( !p_current )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
230
    {
231
        msg_Err( p_access, "unable to find item in playlist" );
232
        vlc_object_release( p_input );
233
        free( psz_name );
234
        pl_Release( p_access );
235 236 237
        return VLC_ENOOBJ;
    }

238
    /* Remove the ending '/' char */
239
    if( psz_name[0] )
240
    {
241 242
        char *ptr = psz_name + strlen (psz_name);
        switch (*--ptr)
243
        {
244 245 246
            case '/':
            case '\\':
                *ptr = '\0';
247
        }
248
    }
249

250
    /* Handle mode */
251 252
    psz = var_CreateGetString( p_access, "recursive" );
    if( *psz == '\0' || !strncmp( psz, "none" , 4 )  )
253
        i_mode = MODE_NONE;
254
    else if( !strncmp( psz, "collapse", 8 )  )
255 256 257
        i_mode = MODE_COLLAPSE;
    else
        i_mode = MODE_EXPAND;
258
    free( psz );
259

260
    p_current->p_input->i_type = ITEM_TYPE_DIRECTORY;
261
    p_item_in_category = playlist_ItemToNode( p_playlist, p_current,
262
                                              pl_Unlocked );
263
    assert( p_item_in_category );
264

265 266
    ReadDir( p_access, p_playlist, psz_name, i_mode,
             p_item_in_category,
267
             p_current_input, (DIR *)p_access->p_sys, NULL );
268

269 270
    playlist_Signal( p_playlist );

271
    free( psz_name );
272
    vlc_object_release( p_input );
Rémi Duraffort's avatar
Rémi Duraffort committed
273
    pl_Release( p_access );
274 275 276

    /* Return fake data forever */
    p_access->pf_read = ReadNull;
277
    return -1;
278 279 280
}

/*****************************************************************************
281
 * Control:
282 283 284
 *****************************************************************************/
static int Control( access_t *p_access, int i_query, va_list args )
{
285
    bool   *pb_bool;
286 287 288 289 290 291 292 293 294 295
    int          *pi_int;
    int64_t      *pi_64;

    switch( i_query )
    {
        /* */
        case ACCESS_CAN_SEEK:
        case ACCESS_CAN_FASTSEEK:
        case ACCESS_CAN_PAUSE:
        case ACCESS_CAN_CONTROL_PACE:
296 297
            pb_bool = (bool*)va_arg( args, bool* );
            *pb_bool = false;    /* FIXME */
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
            break;

        /* */
        case ACCESS_GET_MTU:
            pi_int = (int*)va_arg( args, int * );
            *pi_int = 0;
            break;

        case ACCESS_GET_PTS_DELAY:
            pi_64 = (int64_t*)va_arg( args, int64_t * );
            *pi_64 = DEFAULT_PTS_DELAY * 1000;
            break;

        /* */
        case ACCESS_SET_PAUSE_STATE:
        case ACCESS_GET_TITLE_INFO:
        case ACCESS_SET_TITLE:
        case ACCESS_SET_SEEKPOINT:
316
        case ACCESS_SET_PRIVATE_ID_STATE:
317
        case ACCESS_GET_CONTENT_TYPE:
318
        case ACCESS_GET_META:
319 320 321
            return VLC_EGENERIC;

        default:
322
            msg_Warn( p_access, "unimplemented query in control" );
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
            return VLC_EGENERIC;
    }
    return VLC_SUCCESS;
}

/*****************************************************************************
 * DemuxOpen:
 *****************************************************************************/
static int DemuxOpen ( vlc_object_t *p_this )
{
    demux_t *p_demux = (demux_t*)p_this;

    if( strcmp( p_demux->psz_demux, "directory" ) )
        return VLC_EGENERIC;

    p_demux->pf_demux   = Demux;
    p_demux->pf_control = DemuxControl;
    return VLC_SUCCESS;
341
}
342

343 344 345 346 347
/*****************************************************************************
 * Demux: EOF
 *****************************************************************************/
static int Demux( demux_t *p_demux )
{
348
    (void)p_demux;
349 350
    return 0;
}
351

352 353 354 355 356
/*****************************************************************************
 * DemuxControl:
 *****************************************************************************/
static int DemuxControl( demux_t *p_demux, int i_query, va_list args )
{
357
    return demux_vaControlHelper( p_demux->s, 0, 0, 0, 1, i_query, args );
358
}
359

360 361

static int Sort (const char **a, const char **b)
362
{
363
    return strcoll (*a, *b);
364
}
365

366 367 368 369 370 371 372
struct stat_list_t
{
    stat_list_t *parent;
    struct stat st;
};


373 374 375
/*****************************************************************************
 * ReadDir: read a directory and add its content to the list
 *****************************************************************************/
376 377
static int ReadDir( access_t *p_access, playlist_t *p_playlist,
                    const char *psz_name,
378
                    int i_mode,
379
                    playlist_item_t *p_parent_category,
380 381
                    input_item_t *p_current_input,
                    DIR *handle, stat_list_t *stparent )
382
{
383
    char **pp_dir_content = NULL;
384
    int             i_dir_content, i, i_return = VLC_SUCCESS;
385
    playlist_item_t *p_node;
386

387 388 389
    if( !vlc_object_alive( p_access ) )
        return VLC_EGENERIC;

390
    if( !vlc_object_alive( p_playlist ) )
391
        return VLC_EGENERIC;
392

393
    char **ppsz_extensions = NULL;
394
    int i_extensions = 0;
395 396
    char *psz_ignore;

397
    struct stat_list_t stself;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
398
#ifndef WIN32
399 400 401 402
    int fd = dirfd (handle);

    if ((fd == -1) || fstat (fd, &stself.st))
    {
403
        msg_Err (p_playlist, "cannot stat `%s': %m", psz_name);
404 405 406 407 408 409 410 411 412 413 414 415 416
        return VLC_EGENERIC;
    }

    for (stat_list_t *stats = stparent; stats != NULL; stats = stats->parent)
    {
        if ((stself.st.st_ino == stats->st.st_ino)
         && (stself.st.st_dev == stats->st.st_dev))
        {
            msg_Warn (p_playlist,
                      "ignoring infinitely recursive directory `%s'",
                      psz_name);
            return VLC_SUCCESS;
        }
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
417
    }
418 419
#else
        /* Windows has st_dev (driver letter - 'A'), but it zeroes st_ino,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
420 421
         * so that the test above will always incorrectly succeed.
         * Besides, Windows does not have dirfd(). */
422 423 424 425
#endif

    stself.parent = stparent;

426
    /* Get the first directory entry */
427
    i_dir_content = utf8_loaddir (handle, &pp_dir_content, NULL, Sort);
428 429
    if( i_dir_content == -1 )
    {
430
        msg_Err (p_playlist, "cannot read `%s': %m", psz_name);
431 432 433 434 435
        return VLC_EGENERIC;
    }
    else if( i_dir_content <= 0 )
    {
        /* directory is empty */
436 437
        msg_Dbg( p_playlist, "%s directory is empty", psz_name );
        free( pp_dir_content );
438 439 440 441 442
        return VLC_SUCCESS;
    }

    /* Build array with ignores */
    psz_ignore = var_CreateGetString( p_playlist, "ignore-filetypes" );
443 444
    if( psz_ignore && *psz_ignore )
    {
445 446
        char *psz_parser = psz_ignore;
        int a;
447

448 449 450 451
        for( a = 0; psz_parser[a] != '\0'; a++ )
        {
            if( psz_parser[a] == ',' ) i_extensions++;
        }
452

453
        ppsz_extensions = (char **)calloc (i_extensions, sizeof (char *));
454

455 456
        for( a = 0; a < i_extensions; a++ )
        {
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
457
            char *tmp, *ptr;
458

459
            while( psz_parser[0] != '\0' && psz_parser[0] == ' ' ) psz_parser++;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
460 461 462 463 464
            ptr = strchr( psz_parser, ',');
            tmp = ( ptr == NULL )
                 ? strdup( psz_parser )
                 : strndup( psz_parser, ptr - psz_parser );

465
            ppsz_extensions[a] = tmp;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
466
            psz_parser = ptr + 1;
467
        }
468
    }
469
    free( psz_ignore );
470

471 472
    /* While we still have entries in the directory */
    for( i = 0; i < i_dir_content; i++ )
473
    {
474
        const char *entry = pp_dir_content[i];
475
        int i_size_entry = strlen( psz_name ) +
476
                           strlen( entry ) + 2 + 7 /* strlen("file://") */;
477
        char psz_uri[i_size_entry];
478

479
        sprintf( psz_uri, "%s/%s", psz_name, entry);
480

481
        /* if it starts with '.' then forget it */
482
        if (entry[0] != '.')
483
        {
484 485
            DIR *subdir = (i_mode != MODE_COLLAPSE)
                    ? OpenDir (VLC_OBJECT (p_playlist), psz_uri) : NULL;
486

487
            if (subdir != NULL) /* Recurse into subdirectory */
488 489 490
            {
                if( i_mode == MODE_NONE )
                {
491 492 493
                    msg_Dbg( p_playlist, "skipping subdirectory `%s'",
                             psz_uri );
                    closedir (subdir);
494 495
                    continue;
                }
496 497 498

                msg_Dbg (p_playlist, "creating subdirectory %s", psz_uri);

499
                PL_LOCK;
500 501
                p_node = playlist_NodeCreate( p_playlist, entry,
                                              p_parent_category,
502
                                              PLAYLIST_NO_REBUILD, NULL );
503
                PL_UNLOCK;
504
                assert( p_node );
505 506
                /* If we had the parent in category, the it is now node.
                 * Else, we still don't have  */
507
                i_return = ReadDir( p_access, p_playlist, psz_uri , MODE_EXPAND,
508
                                    p_parent_category ? p_node : NULL,
509 510 511 512
                                    p_current_input, subdir, &stself );
                closedir (subdir);
                if (i_return)
                    break; // error :-(
513 514 515
            }
            else
            {
516
                input_item_t *p_input;
517

518 519
                if( i_extensions > 0 )
                {
520
                    const char *psz_dot = strrchr (entry, '.' );
521
                    if( psz_dot++ && *psz_dot )
522 523 524 525 526 527 528 529 530
                    {
                        int a;
                        for( a = 0; a < i_extensions; a++ )
                        {
                            if( !strcmp( psz_dot, ppsz_extensions[a] ) )
                                break;
                        }
                        if( a < i_extensions )
                        {
531
                            msg_Dbg( p_playlist, "ignoring file %s", psz_uri );
532 533 534 535
                            continue;
                        }
                    }
                }
536

537 538
                memmove (psz_uri + 7, psz_uri, sizeof (psz_uri) - 7);
                memcpy (psz_uri, "file://", 7);
539
                p_input = input_item_NewWithType( VLC_OBJECT( p_playlist ),
540
                                                 psz_uri, entry, 0, NULL,
541
                                                 -1, ITEM_TYPE_FILE );
542
                if (p_input != NULL)
543 544
                {
                    if( p_current_input )
545
                        input_item_CopyOptions( p_current_input, p_input );
546
                    assert( p_parent_category );
547
                    int i_ret = playlist_BothAddInput( p_playlist, p_input,
548
                                           p_parent_category,
549 550
                                           PLAYLIST_APPEND|PLAYLIST_PREPARSE|
                                           PLAYLIST_NO_REBUILD,
551
                                           PLAYLIST_END, NULL, NULL,
552
                                           pl_Unlocked );
553
                    vlc_gc_decref( p_input );
554 555
                    if( i_ret != VLC_SUCCESS )
                        return VLC_EGENERIC;
556
                }
557 558 559
            }
        }
    }
560

561
    for( i = 0; i < i_extensions; i++ )
562 563
        free( ppsz_extensions[i] );
    free( ppsz_extensions );
564

565
    for( i = 0; i < i_dir_content; i++ )
566 567
        free( pp_dir_content[i] );
    free( pp_dir_content );
568 569

    return i_return;
570
}
571 572 573 574 575 576 577 578 579 580


static DIR *OpenDir (vlc_object_t *obj, const char *path)
{
    msg_Dbg (obj, "opening directory `%s'", path);
    DIR *handle = utf8_opendir (path);
    if (handle == NULL)
    {
        int err = errno;
        if (err != ENOTDIR)
581
            msg_Err (obj, "%s: %m", path);
582 583 584 585 586 587 588 589
        else
            msg_Dbg (obj, "skipping non-directory `%s'", path);
        errno = err;

        return NULL;
    }
    return handle;
}