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 #   include <poll.h>
  62 #endif
  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 #ifdef HAVE_FDOPENDIR
 149         else if (*end == '/' && end > path)
 150         {
 151             char *name = decode_URI_duplicate (end - 1);
 152             if (name != NULL) /* TODO: ToLocale(), FD_CLOEXEC */
 153             {
 154                 name[0] = '.';
 155                 fd = openat (oldfd, name, O_RDONLY | O_NONBLOCK);
 156                 free (name);
 157             }
 158         }
 159 #endif
 160     }
 161     else
 162     {
 163         msg_Dbg (p_access, "opening file `%s'", path);
 164         fd = vlc_open (path, O_RDONLY | O_NONBLOCK);
 165         if (fd == -1)
 166         {
 167             msg_Err (p_access, "cannot open file %s (%m)", path);
 168             dialog_Fatal (p_access, _("File reading failed"),
 169                           _("VLC could not open the file \"%s\"."), path);
 170         }
 171
 172 #ifdef WIN32
 173         wchar_t wpath[MAX_PATH+1];
 174         if (MultiByteToWideChar (CP_UTF8, 0, path, -1,
 175                                  wpath, MAX_PATH)
 176          && PathIsNetworkPathW (wpath))
 177             is_remote = true;
 178 # define IsRemote( fd ) ((void)fd, is_remote)
 179 #endif
 180     }
 181     if (fd == -1)
 182         return VLC_EGENERIC;
 183
 184     struct stat st;
 185     if (fstat (fd, &st))
 186     {
 187         msg_Err (p_access, "failed to read (%m)");
 188         goto error;
 189     }
 190     /* Directories can be opened and read from, but only readdir() knows
 191      * how to parse the data. The directory plugin will do it. */
 192     if (S_ISDIR (st.st_mode))
 193     {
 194 #ifdef HAVE_FDOPENDIR
 195         DIR *handle = fdopendir (fd);
 196         if (handle == NULL)
 197             goto error; /* Uh? */
 198         return DirInit (p_access, handle);
 199 #else
 200         msg_Dbg (p_access, "ignoring directory");
 201         goto error;
 202 #endif
 203     }
 204
 205     access_sys_t *p_sys = malloc (sizeof (*p_sys));
 206     if (unlikely(p_sys == NULL))
 207         goto error;
 208     access_InitFields (p_access);
 209     p_access->pf_read = FileRead;
 210     p_access->pf_block = NULL;
 211     p_access->pf_control = FileControl;
 212     p_access->pf_seek = FileSeek;
 213     p_access->p_sys = p_sys;
 214     p_sys->i_nb_reads = 0;
 215     p_sys->fd = fd;
 216     p_sys->caching = var_CreateGetInteger (p_access, "file-caching");
 217     if (IsRemote(fd))
 218         p_sys->caching += var_CreateGetInteger (p_access, "network-caching");
 219     p_sys->b_pace_control = true;
 220
 221     if (S_ISREG (st.st_mode))
 222         p_access->info.i_size = st.st_size;
 223     else if (!S_ISBLK (st.st_mode))
 224     {
 225         p_access->pf_seek = NoSeek;
 226         p_sys->b_pace_control = strcasecmp (p_access->psz_access, "stream");
 227     }
 228
 229     if (p_access->pf_seek != NoSeek)
 230     {
 231         /* Demuxers will need the beginning of the file for probing. */
 232         posix_fadvise (fd, 0, 4096, POSIX_FADV_WILLNEED);
 233         /* In most cases, we only read the file once. */
 234         posix_fadvise (fd, 0, 0, POSIX_FADV_NOREUSE);
 235 #if defined(HAVE_FCNTL)
 236         /* We'd rather use any available memory for reading ahead
 237          * than for caching what we've already seen/heard */
 238 # if defined(F_RDAHEAD)
 239         fcntl (fd, F_RDAHEAD, 1);
 240 # endif
 241 # if defined(F_NOCACHE)
 242         fcntl (fd, F_NOCACHE, 1);
 243 # endif
 244 #endif
 245     }
 246     return VLC_SUCCESS;
 247
 248 error:
 249     close (fd);
 250     return VLC_EGENERIC;
 251 }
 252
 253 /*****************************************************************************
 254  * Close: close the target
 255  *****************************************************************************/
 256 void Close (vlc_object_t * p_this)
 257 {
 258     access_t     *p_access = (access_t*)p_this;
 259
 260     if (p_access->pf_read == NULL)
 261     {
 262         DirClose (p_this);
 263         return;
 264     }
 265
 266     access_sys_t *p_sys = p_access->p_sys;
 267
 268     close (p_sys->fd);
 269     free (p_sys);
 270 }
 271
 272
 273 #include <vlc_network.h>
 274
 275 /*****************************************************************************
 276  * Read: standard read on a file descriptor.
 277  *****************************************************************************/
 278 ssize_t FileRead( access_t *p_access, uint8_t *p_buffer, size_t i_len )
 279 {
 280     access_sys_t *p_sys = p_access->p_sys;
 281     int fd = p_sys->fd;
 282     ssize_t i_ret;
 283
 284 #ifndef WIN32
 285     if (p_access->pf_seek == NoSeek)
 286         i_ret = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
 287     else
 288 #endif
 289         i_ret = read (fd, p_buffer, i_len);
 290
 291     if( i_ret < 0 )
 292     {
 293         switch (errno)
 294         {
 295             case EINTR:
 296             case EAGAIN:
 297                 break;
 298
 299             default:
 300                 msg_Err (p_access, "failed to read (%m)");
 301                 dialog_Fatal (p_access, _("File reading failed"), "%s",
 302                               _("VLC could not read the file."));
 303                 p_access->info.b_eof = true;
 304                 return 0;
 305         }
 306     }
 307     else if( i_ret > 0 )
 308         p_access->info.i_pos += i_ret;
 309     else
 310         p_access->info.b_eof = true;
 311
 312     p_sys->i_nb_reads++;
 313
 314     if ((p_access->info.i_size && !(p_sys->i_nb_reads % INPUT_FSTAT_NB_READS))
 315      || (p_access->info.i_pos > p_access->info.i_size))
 316     {
 317 #ifdef HAVE_SYS_STAT_H
 318         struct stat st;
 319
 320         if ((fstat (fd, &st) == 0)
 321          && (p_access->info.i_size != (uint64_t)st.st_size))
 322         {
 323             p_access->info.i_size = st.st_size;
 324             p_access->info.i_update |= INPUT_UPDATE_SIZE;
 325         }
 326 #endif
 327     }
 328     return i_ret;
 329 }
 330
 331
 332 /*****************************************************************************
 333  * Seek: seek to a specific location in a file
 334  *****************************************************************************/
 335 int FileSeek (access_t *p_access, uint64_t i_pos)
 336 {
 337     p_access->info.i_pos = i_pos;
 338     p_access->info.b_eof = false;
 339
 340     lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
 341     return VLC_SUCCESS;
 342 }
 343
 344 int NoSeek (access_t *p_access, uint64_t i_pos)
 345 {
 346     /* assert(0); ?? */
 347     (void) p_access; (void) i_pos;
 348     return VLC_EGENERIC;
 349 }
 350
 351 /*****************************************************************************
 352  * Control:
 353  *****************************************************************************/
 354 int FileControl( access_t *p_access, int i_query, va_list args )
 355 {
 356     access_sys_t *p_sys = p_access->p_sys;
 357     bool    *pb_bool;
 358     int64_t *pi_64;
 359
 360     switch( i_query )
 361     {
 362         /* */
 363         case ACCESS_CAN_SEEK:
 364         case ACCESS_CAN_FASTSEEK:
 365             pb_bool = (bool*)va_arg( args, bool* );
 366             *pb_bool = (p_access->pf_seek != NoSeek);
 367             break;
 368
 369         case ACCESS_CAN_PAUSE:
 370         case ACCESS_CAN_CONTROL_PACE:
 371             pb_bool = (bool*)va_arg( args, bool* );
 372             *pb_bool = p_sys->b_pace_control;
 373             break;
 374
 375         /* */
 376         case ACCESS_GET_PTS_DELAY:
 377             pi_64 = (int64_t*)va_arg( args, int64_t * );
 378             *pi_64 = p_sys->caching * INT64_C(1000);
 379             break;
 380
 381         /* */
 382         case ACCESS_SET_PAUSE_STATE:
 383             /* Nothing to do */
 384             break;
 385
 386         case ACCESS_GET_TITLE_INFO:
 387         case ACCESS_SET_TITLE:
 388         case ACCESS_SET_SEEKPOINT:
 389         case ACCESS_SET_PRIVATE_ID_STATE:
 390         case ACCESS_GET_META:
 391         case ACCESS_GET_PRIVATE_ID_STATE:
 392         case ACCESS_GET_CONTENT_TYPE:
 393             return VLC_EGENERIC;
 394
 395         default:
 396             msg_Warn( p_access, "unimplemented query %d in control", i_query );
 397             return VLC_EGENERIC;
 398
 399     }
 400     return VLC_SUCCESS;
 401 }