git.sesse.net Git - vlc/blob - modules/access/file.c

   1 /*****************************************************************************
   2  * file.c: file input (file: access plug-in)
   3  *****************************************************************************
   4  * Copyright (C) 2001-2006 the VideoLAN team
   5  * Copyright © 2006-2007 Rémi Denis-Courmont
   6  * $Id$
   7  *
   8  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   9  *          Rémi Denis-Courmont <rem # videolan # org>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 #ifdef HAVE_CONFIG_H
  27 # include "config.h"
  28 #endif
  29
  30 #include <vlc_common.h>
  31 #include "fs.h"
  32 #include <vlc_input.h>
  33 #include <vlc_access.h>
  34 #include <vlc_dialog.h>
  35
  36 #include <assert.h>
  37 #include <errno.h>
  38 #include <sys/types.h>
  39 #ifdef HAVE_SYS_STAT_H
  40 #   include <sys/stat.h>
  41 #endif
  42 #ifdef HAVE_FCNTL_H
  43 #   include <fcntl.h>
  44 #endif
  45 #if defined (__linux__)
  46 #   include <sys/vfs.h>
  47 #ifdef HAVE_LINUX_MAGIC_H
  48 #   include <linux/magic.h>
  49 #endif
  50 #elif defined (HAVE_SYS_MOUNT_H)
  51 #   include <sys/param.h>
  52 #   include <sys/mount.h>
  53 #endif
  54
  55 #if defined( WIN32 )
  56 #   include <io.h>
  57 #   include <ctype.h>
  58 #   include <shlwapi.h>
  59 #else
  60 #   include <unistd.h>
  61 #endif
  62 #include <dirent.h>
  63
  64 #if defined( WIN32 ) && !defined( UNDER_CE )
  65 #   ifdef lseek
  66 #      undef lseek
  67 #   endif
  68 #   define lseek _lseeki64
  69 #elif defined( UNDER_CE )
  70 /* FIXME the commandline on wince is a mess */
  71 # define PathIsNetworkPathW(wpath) (! wcsncmp(wpath, L"\\\\", 2))
  72 #endif
  73
  74 #include <vlc_fs.h>
  75 #include <vlc_url.h>
  76
  77 struct access_sys_t
  78 {
  79     unsigned int i_nb_reads;
  80
  81     int fd;
  82
  83     /* */
  84     unsigned caching;
  85     bool b_pace_control;
  86 };
  87
  88 #ifndef WIN32
  89 static bool IsRemote (int fd)
  90 {
  91 #ifdef HAVE_FSTATFS
  92     struct statfs stf;
  93
  94     if (fstatfs (fd, &stf))
  95         return false;
  96
  97 #if defined(MNT_LOCAL)
  98     return !(stf.f_flags & MNT_LOCAL);
  99
 100 #else
 101 #   ifdef HAVE_LINUX_MAGIC_H
 102     switch (stf.f_type)
 103     {
 104         case AFS_SUPER_MAGIC:
 105         case CODA_SUPER_MAGIC:
 106         case NCP_SUPER_MAGIC:
 107         case NFS_SUPER_MAGIC:
 108         case SMB_SUPER_MAGIC:
 109         case 0xFF534D42 /*CIFS_MAGIC_NUMBER*/:
 110             return true;
 111     }
 112     return false;
 113 #   endif
 114 #endif
 115 #else /* !HAVE_FSTATFS */
 116     (void)fd;
 117     return false;
 118
 119 #endif
 120 }
 121 #endif
 122
 123 #ifndef HAVE_POSIX_FADVISE
 124 # define posix_fadvise(fd, off, len, adv)
 125 #endif
 126
 127 /*****************************************************************************
 128  * Open: open the file
 129  *****************************************************************************/
 130 int Open( vlc_object_t *p_this )
 131 {
 132     access_t     *p_access = (access_t*)p_this;
 133     const char   *path = p_access->psz_path;
 134 #ifdef WIN32
 135     bool is_remote = false;
 136 #endif
 137
 138     /* Open file */
 139     int fd = -1;
 140
 141     if (!strcasecmp (p_access->psz_access, "fd"))
 142     {
 143         char *end;
 144         int oldfd = strtol (path, &end, 10);
 145
 146         if (*end == '\0')
 147             fd = vlc_dup (oldfd);
 148         else if (*end == '/' && end > path)
 149         {
 150             char *name = decode_URI_duplicate (end - 1);
 151             if (name != NULL)
 152             {
 153                 name[0] = '.';
 154                 fd = vlc_openat (oldfd, name, O_RDONLY | O_NONBLOCK);
 155                 free (name);
 156             }
 157         }
 158     }
 159     else
 160     {
 161         msg_Dbg (p_access, "opening file `%s'", path);
 162         fd = vlc_open (path, O_RDONLY | O_NONBLOCK);
 163         if (fd == -1)
 164         {
 165             msg_Err (p_access, "cannot open file %s (%m)", path);
 166             dialog_Fatal (p_access, _("File reading failed"),
 167                           _("VLC could not open the file \"%s\"."), path);
 168         }
 169
 170 #ifdef WIN32
 171         wchar_t wpath[MAX_PATH+1];
 172         if (MultiByteToWideChar (CP_UTF8, 0, path, -1,
 173                                  wpath, MAX_PATH)
 174          && PathIsNetworkPathW (wpath))
 175             is_remote = true;
 176 # define IsRemote( fd ) ((void)fd, is_remote)
 177 #endif
 178     }
 179     if (fd == -1)
 180         return VLC_EGENERIC;
 181
 182     struct stat st;
 183     if (fstat (fd, &st))
 184     {
 185         msg_Err (p_access, "failed to read (%m)");
 186         goto error;
 187     }
 188     /* Directories can be opened and read from, but only readdir() knows
 189      * how to parse the data. The directory plugin will do it. */
 190     if (S_ISDIR (st.st_mode))
 191     {
 192 #ifdef HAVE_FDOPENDIR
 193         DIR *handle = fdopendir (fd);
 194         if (handle == NULL)
 195             goto error; /* Uh? */
 196         return DirInit (p_access, handle);
 197 #else
 198         msg_Dbg (p_access, "ignoring directory");
 199         goto error;
 200 #endif
 201     }
 202
 203     access_sys_t *p_sys = malloc (sizeof (*p_sys));
 204     if (unlikely(p_sys == NULL))
 205         goto error;
 206     access_InitFields (p_access);
 207     p_access->pf_read = FileRead;
 208     p_access->pf_block = NULL;
 209     p_access->pf_control = FileControl;
 210     p_access->pf_seek = FileSeek;
 211     p_access->p_sys = p_sys;
 212     p_sys->i_nb_reads = 0;
 213     p_sys->fd = fd;
 214     p_sys->caching = var_CreateGetInteger (p_access, "file-caching");
 215     if (IsRemote(fd))
 216         p_sys->caching += var_CreateGetInteger (p_access, "network-caching");
 217     p_sys->b_pace_control = true;
 218
 219     if (S_ISREG (st.st_mode))
 220         p_access->info.i_size = st.st_size;
 221     else if (!S_ISBLK (st.st_mode))
 222     {
 223         p_access->pf_seek = NoSeek;
 224         p_sys->b_pace_control = strcasecmp (p_access->psz_access, "stream");
 225     }
 226
 227     if (p_access->pf_seek != NoSeek)
 228     {
 229         /* Demuxers will need the beginning of the file for probing. */
 230         posix_fadvise (fd, 0, 4096, POSIX_FADV_WILLNEED);
 231         /* In most cases, we only read the file once. */
 232         posix_fadvise (fd, 0, 0, POSIX_FADV_NOREUSE);
 233 #if defined(HAVE_FCNTL)
 234         /* We'd rather use any available memory for reading ahead
 235          * than for caching what we've already seen/heard */
 236 # if defined(F_RDAHEAD)
 237         fcntl (fd, F_RDAHEAD, 1);
 238 # endif
 239 # if defined(F_NOCACHE)
 240         fcntl (fd, F_NOCACHE, 1);
 241 # endif
 242 #endif
 243     }
 244     return VLC_SUCCESS;
 245
 246 error:
 247     close (fd);
 248     return VLC_EGENERIC;
 249 }
 250
 251 /*****************************************************************************
 252  * Close: close the target
 253  *****************************************************************************/
 254 void Close (vlc_object_t * p_this)
 255 {
 256     access_t     *p_access = (access_t*)p_this;
 257
 258     if (p_access->pf_read == NULL)
 259     {
 260         DirClose (p_this);
 261         return;
 262     }
 263
 264     access_sys_t *p_sys = p_access->p_sys;
 265
 266     close (p_sys->fd);
 267     free (p_sys);
 268 }
 269
 270
 271 #include <vlc_network.h>
 272
 273 /*****************************************************************************
 274  * Read: standard read on a file descriptor.
 275  *****************************************************************************/
 276 ssize_t FileRead( access_t *p_access, uint8_t *p_buffer, size_t i_len )
 277 {
 278     access_sys_t *p_sys = p_access->p_sys;
 279     int fd = p_sys->fd;
 280     ssize_t i_ret;
 281
 282 #ifndef WIN32
 283     if (p_access->pf_seek == NoSeek)
 284         i_ret = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
 285     else
 286 #endif
 287         i_ret = read (fd, p_buffer, i_len);
 288
 289     if( i_ret < 0 )
 290     {
 291         switch (errno)
 292         {
 293             case EINTR:
 294             case EAGAIN:
 295                 break;
 296
 297             default:
 298                 msg_Err (p_access, "failed to read (%m)");
 299                 dialog_Fatal (p_access, _("File reading failed"), "%s",
 300                               _("VLC could not read the file."));
 301                 p_access->info.b_eof = true;
 302                 return 0;
 303         }
 304     }
 305     else if( i_ret > 0 )
 306         p_access->info.i_pos += i_ret;
 307     else
 308         p_access->info.b_eof = true;
 309
 310     p_sys->i_nb_reads++;
 311
 312     if ((p_access->info.i_size && !(p_sys->i_nb_reads % INPUT_FSTAT_NB_READS))
 313      || (p_access->info.i_pos > p_access->info.i_size))
 314     {
 315 #ifdef HAVE_SYS_STAT_H
 316         struct stat st;
 317
 318         if ((fstat (fd, &st) == 0)
 319          && (p_access->info.i_size != (uint64_t)st.st_size))
 320         {
 321             p_access->info.i_size = st.st_size;
 322             p_access->info.i_update |= INPUT_UPDATE_SIZE;
 323         }
 324 #endif
 325     }
 326     return i_ret;
 327 }
 328
 329
 330 /*****************************************************************************
 331  * Seek: seek to a specific location in a file
 332  *****************************************************************************/
 333 int FileSeek (access_t *p_access, uint64_t i_pos)
 334 {
 335     p_access->info.i_pos = i_pos;
 336     p_access->info.b_eof = false;
 337
 338     lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
 339     return VLC_SUCCESS;
 340 }
 341
 342 int NoSeek (access_t *p_access, uint64_t i_pos)
 343 {
 344     /* assert(0); ?? */
 345     (void) p_access; (void) i_pos;
 346     return VLC_EGENERIC;
 347 }
 348
 349 /*****************************************************************************
 350  * Control:
 351  *****************************************************************************/
 352 int FileControl( access_t *p_access, int i_query, va_list args )
 353 {
 354     access_sys_t *p_sys = p_access->p_sys;
 355     bool    *pb_bool;
 356     int64_t *pi_64;
 357
 358     switch( i_query )
 359     {
 360         /* */
 361         case ACCESS_CAN_SEEK:
 362         case ACCESS_CAN_FASTSEEK:
 363             pb_bool = (bool*)va_arg( args, bool* );
 364             *pb_bool = (p_access->pf_seek != NoSeek);
 365             break;
 366
 367         case ACCESS_CAN_PAUSE:
 368         case ACCESS_CAN_CONTROL_PACE:
 369             pb_bool = (bool*)va_arg( args, bool* );
 370             *pb_bool = p_sys->b_pace_control;
 371             break;
 372
 373         /* */
 374         case ACCESS_GET_PTS_DELAY:
 375             pi_64 = (int64_t*)va_arg( args, int64_t * );
 376             *pi_64 = p_sys->caching * INT64_C(1000);
 377             break;
 378
 379         /* */
 380         case ACCESS_SET_PAUSE_STATE:
 381             /* Nothing to do */
 382             break;
 383
 384         case ACCESS_GET_TITLE_INFO:
 385         case ACCESS_SET_TITLE:
 386         case ACCESS_SET_SEEKPOINT:
 387         case ACCESS_SET_PRIVATE_ID_STATE:
 388         case ACCESS_GET_META:
 389         case ACCESS_GET_PRIVATE_ID_STATE:
 390         case ACCESS_GET_CONTENT_TYPE:
 391             return VLC_EGENERIC;
 392
 393         default:
 394             msg_Warn( p_access, "unimplemented query %d in control", i_query );
 395             return VLC_EGENERIC;
 396
 397     }
 398     return VLC_SUCCESS;
 399 }