modules/access/file.c

   1 /*****************************************************************************
   2  * file.c: file input (file: access plug-in)
   3  *****************************************************************************
   4  * Copyright (C) 2001-2006 VLC authors and VideoLAN
   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 it
  12  * under the terms of the GNU Lesser General Public License as published by
  13  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * along with this program; if not, write to the Free Software Foundation,
  23  * 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 <assert.h>
  31 #include <errno.h>
  32 #include <sys/types.h>
  33 #include <sys/stat.h>
  34 #include <fcntl.h>
  35 #ifdef HAVE_FSTATVFS
  36 #   include <sys/statvfs.h>
  37 #   if defined (HAVE_SYS_MOUNT_H)
  38 #      include <sys/param.h>
  39 #      include <sys/mount.h>
  40 #   endif
  41 #endif
  42 #ifdef HAVE_LINUX_MAGIC_H
  43 #   include <sys/vfs.h>
  44 #   include <linux/magic.h>
  45 #endif
  46
  47 #if defined( _WIN32 )
  48 #   include <io.h>
  49 #   include <ctype.h>
  50 #   include <shlwapi.h>
  51 #else
  52 #   include <unistd.h>
  53 #endif
  54 #include <dirent.h>
  55
  56 #include <vlc_common.h>
  57 #include "fs.h"
  58 #include <vlc_input.h>
  59 #include <vlc_access.h>
  60 #include <vlc_dialog.h>
  61 #ifdef _WIN32
  62 # include <vlc_charset.h>
  63 #endif
  64 #include <vlc_fs.h>
  65 #include <vlc_url.h>
  66
  67 struct access_sys_t
  68 {
  69     int fd;
  70
  71     bool b_pace_control;
  72     uint64_t size;
  73 };
  74
  75 #if !defined (_WIN32) && !defined (__OS2__)
  76 static bool IsRemote (int fd)
  77 {
  78 #if defined (HAVE_FSTATVFS) && defined (MNT_LOCAL)
  79     struct statvfs stf;
  80
  81     if (fstatvfs (fd, &stf))
  82         return false;
  83     /* fstatvfs() is in POSIX, but MNT_LOCAL is not */
  84     return !(stf.f_flag & MNT_LOCAL);
  85
  86 #elif defined (HAVE_LINUX_MAGIC_H)
  87     struct statfs stf;
  88
  89     if (fstatfs (fd, &stf))
  90         return false;
  91
  92     switch ((unsigned long)stf.f_type)
  93     {
  94         case AFS_SUPER_MAGIC:
  95         case CODA_SUPER_MAGIC:
  96         case NCP_SUPER_MAGIC:
  97         case NFS_SUPER_MAGIC:
  98         case SMB_SUPER_MAGIC:
  99         case 0xFF534D42 /*CIFS_MAGIC_NUMBER*/:
 100             return true;
 101     }
 102     return false;
 103
 104 #else
 105     (void)fd;
 106     return false;
 107
 108 #endif
 109 }
 110 # define IsRemote(fd,path) IsRemote(fd)
 111
 112 #else /* _WIN32 || __OS2__ */
 113 static bool IsRemote (const char *path)
 114 {
 115 # if !defined(__OS2__) && !VLC_WINSTORE_APP
 116     wchar_t *wpath = ToWide (path);
 117     bool is_remote = (wpath != NULL && PathIsNetworkPathW (wpath));
 118     free (wpath);
 119     return is_remote;
 120 # else
 121     return (! strncmp(path, "\\\\", 2));
 122 # endif
 123 }
 124 # define IsRemote(fd,path) IsRemote(path)
 125 #endif
 126
 127 #ifndef HAVE_POSIX_FADVISE
 128 # define posix_fadvise(fd, off, len, adv)
 129 #endif
 130
 131 static ssize_t FileRead (access_t *, uint8_t *, size_t);
 132 static int FileSeek (access_t *, uint64_t);
 133 static ssize_t StreamRead (access_t *, uint8_t *, size_t);
 134 static int NoSeek (access_t *, uint64_t);
 135 static int FileControl (access_t *, int, va_list);
 136
 137 /*****************************************************************************
 138  * FileOpen: open the file
 139  *****************************************************************************/
 140 int FileOpen( vlc_object_t *p_this )
 141 {
 142     access_t     *p_access = (access_t*)p_this;
 143
 144     /* Open file */
 145     int fd = -1;
 146
 147     if (!strcasecmp (p_access->psz_access, "fd"))
 148     {
 149         char *end;
 150         int oldfd = strtol (p_access->psz_location, &end, 10);
 151
 152         if (*end == '\0')
 153             fd = vlc_dup (oldfd);
 154         else if (*end == '/' && end > p_access->psz_location)
 155         {
 156             char *name = decode_URI_duplicate (end - 1);
 157             if (name != NULL)
 158             {
 159                 name[0] = '.';
 160                 fd = vlc_openat (oldfd, name, O_RDONLY | O_NONBLOCK);
 161                 free (name);
 162             }
 163         }
 164     }
 165     else
 166     {
 167         const char *path = p_access->psz_filepath;
 168
 169         if (unlikely(path == NULL))
 170             return VLC_EGENERIC;
 171         msg_Dbg (p_access, "opening file `%s'", path);
 172         fd = vlc_open (path, O_RDONLY | O_NONBLOCK);
 173         if (fd == -1)
 174         {
 175             msg_Err (p_access, "cannot open file %s (%s)", path,
 176                      vlc_strerror_c(errno));
 177             dialog_Fatal (p_access, _("File reading failed"),
 178                           _("VLC could not open the file \"%s\" (%s)."), path,
 179                           vlc_strerror(errno));
 180         }
 181     }
 182     if (fd == -1)
 183         return VLC_EGENERIC;
 184
 185     struct stat st;
 186     if (fstat (fd, &st))
 187     {
 188         msg_Err (p_access, "read error: %s", vlc_strerror_c(errno));
 189         goto error;
 190     }
 191
 192 #if O_NONBLOCK
 193     int flags = fcntl (fd, F_GETFL);
 194     if (S_ISFIFO (st.st_mode) || S_ISSOCK (st.st_mode))
 195         /* Force non-blocking mode where applicable (fd://) */
 196         flags |= O_NONBLOCK;
 197     else
 198         /* Force blocking mode when not useful or not specified */
 199         flags &= ~O_NONBLOCK;
 200     fcntl (fd, F_SETFL, flags);
 201 #endif
 202
 203     /* Directories can be opened and read from, but only readdir() knows
 204      * how to parse the data. The directory plugin will do it. */
 205     if (S_ISDIR (st.st_mode))
 206     {
 207 #ifdef HAVE_FDOPENDIR
 208         DIR *handle = fdopendir (fd);
 209         if (handle == NULL)
 210             goto error; /* Uh? */
 211         return DirInit (p_access, handle);
 212 #else
 213         msg_Dbg (p_access, "ignoring directory");
 214         goto error;
 215 #endif
 216     }
 217
 218     access_sys_t *p_sys = malloc (sizeof (*p_sys));
 219     if (unlikely(p_sys == NULL))
 220         goto error;
 221     access_InitFields (p_access);
 222     p_access->pf_block = NULL;
 223     p_access->pf_control = FileControl;
 224     p_access->p_sys = p_sys;
 225     p_sys->fd = fd;
 226
 227     if (S_ISREG (st.st_mode) || S_ISBLK (st.st_mode))
 228     {
 229         p_access->pf_read = FileRead;
 230         p_access->pf_seek = FileSeek;
 231         p_sys->b_pace_control = true;
 232         p_sys->size = st.st_size;
 233
 234         /* Demuxers will need the beginning of the file for probing. */
 235         posix_fadvise (fd, 0, 4096, POSIX_FADV_WILLNEED);
 236         /* In most cases, we only read the file once. */
 237         posix_fadvise (fd, 0, 0, POSIX_FADV_NOREUSE);
 238 #ifdef F_NOCACHE
 239         fcntl (fd, F_NOCACHE, 0);
 240 #endif
 241 #ifdef F_RDAHEAD
 242         if (IsRemote(fd, p_access->psz_filepath))
 243             fcntl (fd, F_RDAHEAD, 0);
 244         else
 245             fcntl (fd, F_RDAHEAD, 1);
 246 #endif
 247     }
 248     else
 249     {
 250         p_access->pf_read = StreamRead;
 251         p_access->pf_seek = NoSeek;
 252         p_sys->b_pace_control = strcasecmp (p_access->psz_access, "stream");
 253         p_sys->size = 0;
 254     }
 255
 256     return VLC_SUCCESS;
 257
 258 error:
 259     close (fd);
 260     return VLC_EGENERIC;
 261 }
 262
 263 /*****************************************************************************
 264  * FileClose: close the target
 265  *****************************************************************************/
 266 void FileClose (vlc_object_t * p_this)
 267 {
 268     access_t     *p_access = (access_t*)p_this;
 269
 270     if (p_access->pf_read == NULL)
 271     {
 272         DirClose (p_this);
 273         return;
 274     }
 275
 276     access_sys_t *p_sys = p_access->p_sys;
 277
 278     close (p_sys->fd);
 279     free (p_sys);
 280 }
 281
 282
 283 #include <vlc_network.h>
 284
 285 /**
 286  * Reads from a regular file.
 287  */
 288 static ssize_t FileRead (access_t *p_access, uint8_t *p_buffer, size_t i_len)
 289 {
 290     access_sys_t *p_sys = p_access->p_sys;
 291     int fd = p_sys->fd;
 292     ssize_t val = read (fd, p_buffer, i_len);
 293
 294     if (val < 0)
 295     {
 296         switch (errno)
 297         {
 298             case EINTR:
 299             case EAGAIN:
 300                 return -1;
 301         }
 302
 303         msg_Err (p_access, "read error: %s", vlc_strerror_c(errno));
 304         dialog_Fatal (p_access, _("File reading failed"),
 305                       _("VLC could not read the file (%s)."),
 306                       vlc_strerror(errno));
 307         val = 0;
 308     }
 309
 310     p_access->info.i_pos += val;
 311     p_access->info.b_eof = !val;
 312     if (p_access->info.i_pos >= p_sys->size)
 313     {
 314         struct stat st;
 315
 316         if (fstat (fd, &st) == 0)
 317             p_sys->size = st.st_size;
 318     }
 319     return val;
 320 }
 321
 322
 323 /*****************************************************************************
 324  * Seek: seek to a specific location in a file
 325  *****************************************************************************/
 326 static int FileSeek (access_t *p_access, uint64_t i_pos)
 327 {
 328     p_access->info.i_pos = i_pos;
 329     p_access->info.b_eof = false;
 330
 331     if (lseek (p_access->p_sys->fd, i_pos, SEEK_SET) == (off_t)-1)
 332         return VLC_EGENERIC;
 333     return VLC_SUCCESS;
 334 }
 335
 336 /**
 337  * Reads from a non-seekable file.
 338  */
 339 static ssize_t StreamRead (access_t *p_access, uint8_t *p_buffer, size_t i_len)
 340 {
 341     access_sys_t *p_sys = p_access->p_sys;
 342     int fd = p_sys->fd;
 343
 344 #if !defined (_WIN32) && !defined (__OS2__)
 345     ssize_t val = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
 346 #else
 347     ssize_t val = read (fd, p_buffer, i_len);
 348 #endif
 349
 350     if (val < 0)
 351     {
 352         switch (errno)
 353         {
 354             case EINTR:
 355             case EAGAIN:
 356                 return -1;
 357         }
 358         msg_Err (p_access, "read error: %s", vlc_strerror_c(errno));
 359         val = 0;
 360     }
 361
 362     p_access->info.i_pos += val;
 363     p_access->info.b_eof = !val;
 364     return val;
 365 }
 366
 367 static int NoSeek (access_t *p_access, uint64_t i_pos)
 368 {
 369     /* assert(0); ?? */
 370     (void) p_access; (void) i_pos;
 371     return VLC_EGENERIC;
 372 }
 373
 374 /*****************************************************************************
 375  * Control:
 376  *****************************************************************************/
 377 static int FileControl( access_t *p_access, int i_query, va_list args )
 378 {
 379     access_sys_t *p_sys = p_access->p_sys;
 380     bool    *pb_bool;
 381     int64_t *pi_64;
 382
 383     switch( i_query )
 384     {
 385         case ACCESS_CAN_SEEK:
 386         case ACCESS_CAN_FASTSEEK:
 387             pb_bool = (bool*)va_arg( args, bool* );
 388             *pb_bool = (p_access->pf_seek != NoSeek);
 389             break;
 390
 391         case ACCESS_CAN_PAUSE:
 392         case ACCESS_CAN_CONTROL_PACE:
 393             pb_bool = (bool*)va_arg( args, bool* );
 394             *pb_bool = p_sys->b_pace_control;
 395             break;
 396
 397         case ACCESS_GET_SIZE:
 398         {
 399             struct stat st;
 400
 401             if (fstat (p_sys->fd, &st) == 0)
 402                 p_sys->size = st.st_size;
 403             *va_arg( args, uint64_t * ) = p_sys->size;
 404             break;
 405         }
 406
 407         case ACCESS_GET_PTS_DELAY:
 408             pi_64 = (int64_t*)va_arg( args, int64_t * );
 409             if (IsRemote (p_sys->fd, p_access->psz_filepath))
 410                 *pi_64 = var_InheritInteger (p_access, "network-caching");
 411             else
 412                 *pi_64 = var_InheritInteger (p_access, "file-caching");
 413             *pi_64 *= 1000;
 414             break;
 415
 416         case ACCESS_SET_PAUSE_STATE:
 417             /* Nothing to do */
 418             break;
 419
 420         default:
 421             return VLC_EGENERIC;
 422
 423     }
 424     return VLC_SUCCESS;
 425 }