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 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 (%m)", path);
 176             dialog_Fatal (p_access, _("File reading failed"),
 177                           _("VLC could not open the file \"%s\" (%m)."), path);
 178         }
 179     }
 180     if (fd == -1)
 181         return VLC_EGENERIC;
 182
 183     struct stat st;
 184     if (fstat (fd, &st))
 185     {
 186         msg_Err (p_access, "failed to read (%m)");
 187         goto error;
 188     }
 189
 190 #if O_NONBLOCK
 191     int flags = fcntl (fd, F_GETFL);
 192     if (S_ISFIFO (st.st_mode) || S_ISSOCK (st.st_mode))
 193         /* Force non-blocking mode where applicable (fd://) */
 194         flags |= O_NONBLOCK;
 195     else
 196         /* Force blocking mode when not useful or not specified */
 197         flags &= ~O_NONBLOCK;
 198     fcntl (fd, F_SETFL, flags);
 199 #endif
 200
 201     /* Directories can be opened and read from, but only readdir() knows
 202      * how to parse the data. The directory plugin will do it. */
 203     if (S_ISDIR (st.st_mode))
 204     {
 205 #ifdef HAVE_FDOPENDIR
 206         DIR *handle = fdopendir (fd);
 207         if (handle == NULL)
 208             goto error; /* Uh? */
 209         return DirInit (p_access, handle);
 210 #else
 211         msg_Dbg (p_access, "ignoring directory");
 212         goto error;
 213 #endif
 214     }
 215
 216     access_sys_t *p_sys = malloc (sizeof (*p_sys));
 217     if (unlikely(p_sys == NULL))
 218         goto error;
 219     access_InitFields (p_access);
 220     p_access->pf_block = NULL;
 221     p_access->pf_control = FileControl;
 222     p_access->p_sys = p_sys;
 223     p_sys->fd = fd;
 224
 225     if (S_ISREG (st.st_mode) || S_ISBLK (st.st_mode))
 226     {
 227         p_access->pf_read = FileRead;
 228         p_access->pf_seek = FileSeek;
 229         p_sys->b_pace_control = true;
 230         p_sys->size = st.st_size;
 231
 232         /* Demuxers will need the beginning of the file for probing. */
 233         posix_fadvise (fd, 0, 4096, POSIX_FADV_WILLNEED);
 234         /* In most cases, we only read the file once. */
 235         posix_fadvise (fd, 0, 0, POSIX_FADV_NOREUSE);
 236 #ifdef F_RDAHEAD
 237         fcntl (fd, F_RDAHEAD, 1);
 238 #endif
 239 #ifdef F_NOCACHE
 240         fcntl (fd, F_NOCACHE, 0);
 241 #endif
 242     }
 243     else
 244     {
 245         p_access->pf_read = StreamRead;
 246         p_access->pf_seek = NoSeek;
 247         p_sys->b_pace_control = strcasecmp (p_access->psz_access, "stream");
 248         p_sys->size = 0;
 249     }
 250
 251     return VLC_SUCCESS;
 252
 253 error:
 254     close (fd);
 255     return VLC_EGENERIC;
 256 }
 257
 258 /*****************************************************************************
 259  * FileClose: close the target
 260  *****************************************************************************/
 261 void FileClose (vlc_object_t * p_this)
 262 {
 263     access_t     *p_access = (access_t*)p_this;
 264
 265     if (p_access->pf_read == NULL)
 266     {
 267         DirClose (p_this);
 268         return;
 269     }
 270
 271     access_sys_t *p_sys = p_access->p_sys;
 272
 273     close (p_sys->fd);
 274     free (p_sys);
 275 }
 276
 277
 278 #include <vlc_network.h>
 279
 280 /**
 281  * Reads from a regular file.
 282  */
 283 static ssize_t FileRead (access_t *p_access, uint8_t *p_buffer, size_t i_len)
 284 {
 285     access_sys_t *p_sys = p_access->p_sys;
 286     int fd = p_sys->fd;
 287     ssize_t val = read (fd, p_buffer, i_len);
 288
 289     if (val < 0)
 290     {
 291         switch (errno)
 292         {
 293             case EINTR:
 294             case EAGAIN:
 295                 return -1;
 296         }
 297
 298         msg_Err (p_access, "read error: %m");
 299         dialog_Fatal (p_access, _("File reading failed"),
 300                       _("VLC could not read the file (%m)."));
 301         val = 0;
 302     }
 303
 304     p_access->info.i_pos += val;
 305     p_access->info.b_eof = !val;
 306     if (p_access->info.i_pos >= p_sys->size)
 307     {
 308         struct stat st;
 309
 310         if (fstat (fd, &st) == 0)
 311             p_sys->size = st.st_size;
 312     }
 313     return val;
 314 }
 315
 316
 317 /*****************************************************************************
 318  * Seek: seek to a specific location in a file
 319  *****************************************************************************/
 320 static int FileSeek (access_t *p_access, uint64_t i_pos)
 321 {
 322     p_access->info.i_pos = i_pos;
 323     p_access->info.b_eof = false;
 324
 325     lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
 326     return VLC_SUCCESS;
 327 }
 328
 329 /**
 330  * Reads from a non-seekable file.
 331  */
 332 static ssize_t StreamRead (access_t *p_access, uint8_t *p_buffer, size_t i_len)
 333 {
 334     access_sys_t *p_sys = p_access->p_sys;
 335     int fd = p_sys->fd;
 336
 337 #if !defined (_WIN32) && !defined (__OS2__)
 338     ssize_t val = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
 339 #else
 340     ssize_t val = read (fd, p_buffer, i_len);
 341 #endif
 342
 343     if (val < 0)
 344     {
 345         switch (errno)
 346         {
 347             case EINTR:
 348             case EAGAIN:
 349                 return -1;
 350         }
 351         msg_Err (p_access, "read error: %m");
 352         val = 0;
 353     }
 354
 355     p_access->info.i_pos += val;
 356     p_access->info.b_eof = !val;
 357     return val;
 358 }
 359
 360 static int NoSeek (access_t *p_access, uint64_t i_pos)
 361 {
 362     /* assert(0); ?? */
 363     (void) p_access; (void) i_pos;
 364     return VLC_EGENERIC;
 365 }
 366
 367 /*****************************************************************************
 368  * Control:
 369  *****************************************************************************/
 370 static int FileControl( access_t *p_access, int i_query, va_list args )
 371 {
 372     access_sys_t *p_sys = p_access->p_sys;
 373     bool    *pb_bool;
 374     int64_t *pi_64;
 375
 376     switch( i_query )
 377     {
 378         case ACCESS_CAN_SEEK:
 379         case ACCESS_CAN_FASTSEEK:
 380             pb_bool = (bool*)va_arg( args, bool* );
 381             *pb_bool = (p_access->pf_seek != NoSeek);
 382             break;
 383
 384         case ACCESS_CAN_PAUSE:
 385         case ACCESS_CAN_CONTROL_PACE:
 386             pb_bool = (bool*)va_arg( args, bool* );
 387             *pb_bool = p_sys->b_pace_control;
 388             break;
 389
 390         case ACCESS_GET_SIZE:
 391         {
 392             struct stat st;
 393
 394             if (fstat (p_sys->fd, &st) == 0)
 395                 p_sys->size = st.st_size;
 396             *va_arg( args, uint64_t * ) = p_sys->size;
 397             break;
 398         }
 399
 400         case ACCESS_GET_PTS_DELAY:
 401             pi_64 = (int64_t*)va_arg( args, int64_t * );
 402             if (IsRemote (p_sys->fd, p_access->psz_filepath))
 403                 *pi_64 = var_InheritInteger (p_access, "network-caching");
 404             else
 405                 *pi_64 = var_InheritInteger (p_access, "file-caching");
 406             *pi_64 *= 1000;
 407             break;
 408
 409         case ACCESS_SET_PAUSE_STATE:
 410             /* Nothing to do */
 411             break;
 412
 413         default:
 414             return VLC_EGENERIC;
 415
 416     }
 417     return VLC_SUCCESS;
 418 }