modules/access/directory.c

   1 /*****************************************************************************
   2  * directory.c: expands a directory (directory: access plug-in)
   3  *****************************************************************************
   4  * Copyright (C) 2002-2008 VLC authors and VideoLAN
   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 it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * 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_common.h>
  34 #include "fs.h"
  35 #include <vlc_access.h>
  36
  37 #include <sys/types.h>
  38 #include <sys/stat.h>
  39 #include <errno.h>
  40 #include <unistd.h>
  41 #include <fcntl.h>
  42
  43 #include <vlc_fs.h>
  44 #include <vlc_url.h>
  45 #include <vlc_strings.h>
  46 #include <vlc_charset.h>
  47
  48 enum
  49 {
  50     MODE_NONE,
  51     MODE_COLLAPSE,
  52     MODE_EXPAND,
  53 };
  54
  55 typedef struct directory_t directory_t;
  56 struct directory_t
  57 {
  58     directory_t *parent;
  59     DIR         *handle;
  60     char        *uri;
  61     char       **filev;
  62     int          filec, i;
  63 #ifdef HAVE_OPENAT
  64     dev_t        device;
  65     ino_t        inode;
  66 #else
  67     char         *path;
  68 #endif
  69 };
  70
  71 struct access_sys_t
  72 {
  73     directory_t *current;
  74     char *ignored_exts;
  75     char mode;
  76     bool header;
  77     int i_item_count;
  78     char *xspf_ext;
  79     int (*compar)(const char **a, const char **b);
  80 };
  81
  82 /* Select non-hidden files only */
  83 static int visible (const char *name)
  84 {
  85     return name[0] != '.';
  86 }
  87
  88 static int collate (const char **a, const char **b)
  89 {
  90 #ifdef HAVE_STRCOLL
  91     return strcoll (*a, *b);
  92 #else
  93     return strcmp  (*a, *b);
  94 #endif
  95 }
  96
  97 static int version (const char **a, const char **b)
  98 {
  99     return strverscmp (*a, *b);
 100 }
 101
 102 /*****************************************************************************
 103  * Open: open the directory
 104  *****************************************************************************/
 105 int DirOpen( vlc_object_t *p_this )
 106 {
 107     access_t *p_access = (access_t*)p_this;
 108
 109     if( !p_access->psz_filepath )
 110         return VLC_EGENERIC;
 111
 112     DIR *handle = vlc_opendir (p_access->psz_filepath);
 113     if (handle == NULL)
 114         return VLC_EGENERIC;
 115
 116     return DirInit (p_access, handle);
 117 }
 118
 119 int DirInit (access_t *p_access, DIR *handle)
 120 {
 121     access_sys_t *p_sys = malloc (sizeof (*p_sys));
 122     if (unlikely(p_sys == NULL))
 123         goto error;
 124
 125     char *uri;
 126     if (!strcmp (p_access->psz_access, "fd"))
 127     {
 128         if (asprintf (&uri, "fd://%s", p_access->psz_location) == -1)
 129             uri = NULL;
 130     }
 131     else
 132         uri = vlc_path2uri (p_access->psz_filepath, "file");
 133     if (unlikely(uri == NULL))
 134         goto error;
 135
 136     /* "Open" the base directory */
 137     directory_t *root = malloc (sizeof (*root));
 138     if (unlikely(root == NULL))
 139     {
 140         free (uri);
 141         goto error;
 142     }
 143
 144     char *psz_sort = var_InheritString (p_access, "directory-sort");
 145     if (!psz_sort)
 146         p_sys->compar = collate;
 147     else if (!strcasecmp (psz_sort, "version"))
 148         p_sys->compar = version;
 149     else if (!strcasecmp (psz_sort, "none"))
 150         p_sys->compar = NULL;
 151     else
 152         p_sys->compar = collate;
 153     free(psz_sort);
 154
 155     root->parent = NULL;
 156     root->handle = handle;
 157     root->uri = uri;
 158     root->filec = vlc_loaddir (handle, &root->filev, visible, p_sys->compar);
 159     if (root->filec < 0)
 160         root->filev = NULL;
 161     root->i = 0;
 162 #ifdef HAVE_OPENAT
 163     struct stat st;
 164     if (fstat (dirfd (handle), &st))
 165     {
 166         free (root);
 167         free (uri);
 168         goto error;
 169     }
 170     root->device = st.st_dev;
 171     root->inode = st.st_ino;
 172 #else
 173     root->path = strdup (p_access->psz_filepath);
 174 #endif
 175
 176     p_access->p_sys = p_sys;
 177     p_sys->current = root;
 178     p_sys->ignored_exts = var_InheritString (p_access, "ignore-filetypes");
 179     p_sys->header = true;
 180     p_sys->i_item_count = 0;
 181     p_sys->xspf_ext = strdup ("");
 182
 183     /* Handle mode */
 184     char *psz = var_InheritString (p_access, "recursive");
 185     if (psz == NULL || !strcasecmp (psz, "none"))
 186         p_sys->mode = MODE_NONE;
 187     else if( !strcasecmp( psz, "collapse" )  )
 188         p_sys->mode = MODE_COLLAPSE;
 189     else
 190         p_sys->mode = MODE_EXPAND;
 191     free( psz );
 192
 193     access_InitFields(p_access);
 194     p_access->pf_read  = NULL;
 195     p_access->pf_block = DirBlock;
 196     p_access->pf_seek  = NULL;
 197     p_access->pf_control = DirControl;
 198     return VLC_SUCCESS;
 199
 200 error:
 201     closedir (handle);
 202     free (p_sys);
 203     return VLC_EGENERIC;
 204 }
 205
 206 /*****************************************************************************
 207  * Close: close the target
 208  *****************************************************************************/
 209 void DirClose( vlc_object_t * p_this )
 210 {
 211     access_t *p_access = (access_t*)p_this;
 212     access_sys_t *p_sys = p_access->p_sys;
 213
 214     while (p_sys->current)
 215     {
 216         directory_t *current = p_sys->current;
 217
 218         p_sys->current = current->parent;
 219         closedir (current->handle);
 220         free (current->uri);
 221         while (current->i < current->filec)
 222             free (current->filev[current->i++]);
 223         free (current->filev);
 224 #ifndef HAVE_OPENAT
 225         free (current->path);
 226 #endif
 227         free (current);
 228     }
 229
 230     free (p_sys->xspf_ext);
 231     free (p_sys->ignored_exts);
 232     free (p_sys);
 233 }
 234
 235 #ifdef HAVE_OPENAT
 236 /* Detect directories that recurse into themselves. */
 237 static bool has_inode_loop (const directory_t *dir, dev_t dev, ino_t inode)
 238 {
 239     while (dir != NULL)
 240     {
 241         if ((dir->device == dev) && (dir->inode == inode))
 242             return true;
 243         dir = dir->parent;
 244     }
 245     return false;
 246 }
 247 #endif
 248
 249 block_t *DirBlock (access_t *p_access)
 250 {
 251     access_sys_t *p_sys = p_access->p_sys;
 252     directory_t *current = p_sys->current;
 253
 254     if (p_access->info.b_eof)
 255         return NULL;
 256
 257     if (p_sys->header)
 258     {   /* Startup: send the XSPF header */
 259         static const char header[] =
 260             "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 261             "<playlist version=\"1\" xmlns=\"http://xspf.org/ns/0/\" xmlns:vlc=\"http://www.videolan.org/vlc/playlist/ns/0/\">\n"
 262             " <trackList>\n";
 263         block_t *block = block_Alloc (sizeof (header) - 1);
 264         if (!block)
 265             goto fatal;
 266         memcpy (block->p_buffer, header, sizeof (header) - 1);
 267         p_sys->header = false;
 268         return block;
 269     }
 270
 271     if (current->i >= current->filec)
 272     {   /* End of directory, go back to parent */
 273         closedir (current->handle);
 274         p_sys->current = current->parent;
 275         free (current->uri);
 276         free (current->filev);
 277 #ifndef HAVE_OPENAT
 278         free (current->path);
 279 #endif
 280         free (current);
 281
 282         if (p_sys->current == NULL)
 283         {   /* End of XSPF playlist */
 284             char *footer;
 285             int len = asprintf (&footer, " </trackList>\n"
 286                 " <extension application=\"http://www.videolan.org/"
 287                                              "vlc/playlist/0\">\n"
 288                 "%s"
 289                 " </extension>\n"
 290                 "</playlist>\n", p_sys->xspf_ext ? p_sys->xspf_ext : "");
 291             if (unlikely(len == -1))
 292                 goto fatal;
 293
 294             block_t *block = block_heap_Alloc (footer, len);
 295             p_access->info.b_eof = true;
 296             return block;
 297         }
 298         else
 299         {
 300             /* This was the end of a "subnode" */
 301             /* Write the ID to the extension */
 302             char *old_xspf_ext = p_sys->xspf_ext;
 303             if (old_xspf_ext != NULL
 304              && asprintf (&p_sys->xspf_ext, "%s  </vlc:node>\n",
 305                           old_xspf_ext ? old_xspf_ext : "") == -1)
 306                 p_sys->xspf_ext = NULL;
 307             free (old_xspf_ext);
 308         }
 309         return NULL;
 310     }
 311
 312     char *entry = current->filev[current->i++];
 313
 314     /* Handle recursion */
 315     if (p_sys->mode != MODE_COLLAPSE)
 316     {
 317         DIR *handle;
 318 #ifdef HAVE_OPENAT
 319         int fd = vlc_openat (dirfd (current->handle), entry,
 320                              O_RDONLY | O_DIRECTORY);
 321         if (fd == -1)
 322         {
 323             if (errno == ENOTDIR)
 324                 goto notdir;
 325             goto skip; /* File cannot be opened... forget it */
 326         }
 327
 328         struct stat st;
 329         if (fstat (fd, &st)
 330          || p_sys->mode == MODE_NONE
 331          || has_inode_loop (current, st.st_dev, st.st_ino)
 332          || (handle = fdopendir (fd)) == NULL)
 333         {
 334             close (fd);
 335             goto skip;
 336         }
 337 #else
 338         char *path;
 339         if (asprintf (&path, "%s/%s", current->path, entry) == -1)
 340             goto skip;
 341         if ((handle = vlc_opendir (path)) == NULL)
 342             goto notdir;
 343         if (p_sys->mode == MODE_NONE)
 344             goto skip;
 345 #endif
 346         directory_t *sub = malloc (sizeof (*sub));
 347         if (unlikely(sub == NULL))
 348         {
 349             closedir (handle);
 350 #ifndef HAVE_OPENAT
 351             free (path);
 352 #endif
 353             goto skip;
 354         }
 355         sub->parent = current;
 356         sub->handle = handle;
 357         sub->filec = vlc_loaddir (handle, &sub->filev, visible, p_sys->compar);
 358         if (sub->filec < 0)
 359             sub->filev = NULL;
 360         sub->i = 0;
 361 #ifdef HAVE_OPENAT
 362         sub->device = st.st_dev;
 363         sub->inode = st.st_ino;
 364 #else
 365         sub->path = path;
 366 #endif
 367         p_sys->current = sub;
 368
 369         char *encoded = encode_URI_component (entry);
 370         if (encoded == NULL
 371          || (asprintf (&sub->uri, "%s/%s", current->uri, encoded) == -1))
 372              sub->uri = NULL;
 373         free (encoded);
 374         if (unlikely(sub->uri == NULL))
 375         {
 376             free (entry);
 377             goto fatal;
 378         }
 379
 380         /* Add node to XSPF extension */
 381         char *old_xspf_ext = p_sys->xspf_ext;
 382         EnsureUTF8 (entry);
 383         char *title = convert_xml_special_chars (entry);
 384         if (old_xspf_ext != NULL
 385          && asprintf (&p_sys->xspf_ext, "%s  <vlc:node title=\"%s\">\n",
 386                       old_xspf_ext, title ? title : "?") == -1)
 387             p_sys->xspf_ext = NULL;
 388         free (old_xspf_ext);
 389         free (title);
 390         goto skip;
 391     }
 392
 393 notdir:
 394     /* Skip files with ignored extensions */
 395     if (p_sys->ignored_exts != NULL)
 396     {
 397         const char *ext = strrchr (entry, '.');
 398         if (ext != NULL)
 399         {
 400             size_t extlen = strlen (++ext);
 401             for (const char *type = p_sys->ignored_exts, *end;
 402                  type[0]; type = end + 1)
 403             {
 404                 end = strchr (type, ',');
 405                 if (end == NULL)
 406                     end = type + strlen (type);
 407
 408                 if (type + extlen == end
 409                  && !strncasecmp (ext, type, extlen))
 410                 {
 411                     free (entry);
 412                     return NULL;
 413                 }
 414
 415                 if (*end == '\0')
 416                     break;
 417             }
 418         }
 419     }
 420
 421     char *encoded = encode_URI_component (entry);
 422     free (entry);
 423     if (encoded == NULL)
 424         goto fatal;
 425     int len = asprintf (&entry,
 426                         "  <track><location>%s/%s</location>\n" \
 427                         "   <extension application=\"http://www.videolan.org/vlc/playlist/0\">\n" \
 428                         "    <vlc:id>%d</vlc:id>\n" \
 429                         "   </extension>\n" \
 430                         "  </track>\n",
 431                         current->uri, encoded, p_sys->i_item_count++);
 432     free (encoded);
 433     if (len == -1)
 434         goto fatal;
 435
 436     /* Write the ID to the extension */
 437     char *old_xspf_ext = p_sys->xspf_ext;
 438     if (old_xspf_ext != NULL
 439      && asprintf (&p_sys->xspf_ext, "%s   <vlc:item tid=\"%i\" />\n",
 440                   old_xspf_ext, p_sys->i_item_count - 1) == -1)
 441         p_sys->xspf_ext = NULL;
 442     free (old_xspf_ext);
 443
 444     block_t *block = block_heap_Alloc (entry, len);
 445     if (unlikely(block == NULL))
 446         goto fatal;
 447     return block;
 448
 449 fatal:
 450     p_access->info.b_eof = true;
 451     return NULL;
 452
 453 skip:
 454     free (entry);
 455     return NULL;
 456 }
 457
 458 /*****************************************************************************
 459  * Control:
 460  *****************************************************************************/
 461 int DirControl( access_t *p_access, int i_query, va_list args )
 462 {
 463     switch( i_query )
 464     {
 465         case ACCESS_CAN_SEEK:
 466         case ACCESS_CAN_FASTSEEK:
 467             *va_arg( args, bool* ) = false;
 468             break;
 469
 470         case ACCESS_CAN_PAUSE:
 471         case ACCESS_CAN_CONTROL_PACE:
 472             *va_arg( args, bool* ) = true;
 473             break;
 474
 475         case ACCESS_GET_PTS_DELAY:
 476             *va_arg( args, int64_t * ) = DEFAULT_PTS_DELAY * 1000;
 477             break;
 478
 479         case ACCESS_GET_CONTENT_TYPE:
 480             *va_arg( args, char** ) = strdup("application/xspf+xml");
 481             return VLC_SUCCESS;
 482
 483         default:
 484             return VLC_EGENERIC;
 485     }
 486     (void) p_access;
 487     return VLC_SUCCESS;
 488 }