]> git.sesse.net Git - vlc/blobdiff - modules/access/file.c
Use _WIN32 rather than WIN32 (same for WIN64)
[vlc] / modules / access / file.c
index 5a798b236f11c0737d294531f51de8fc342218ee..8e00b3d94f0bf1aede33334ff5e359d9259e7f35 100644 (file)
 /*****************************************************************************
  * file.c: file input (file: access plug-in)
  *****************************************************************************
- * Copyright (C) 2001-2006 the VideoLAN team
+ * Copyright (C) 2001-2006 VLC authors and VideoLAN
  * Copyright © 2006-2007 Rémi Denis-Courmont
  * $Id$
  *
  * Authors: Christophe Massiot <massiot@via.ecp.fr>
  *          Rémi Denis-Courmont <rem # videolan # org>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-/*****************************************************************************
- * Preamble
- *****************************************************************************/
 #ifdef HAVE_CONFIG_H
 # include "config.h"
 #endif
 
-#include <vlc_common.h>
-#include <vlc_plugin.h>
-#include <vlc_input.h>
-#include <vlc_access.h>
-#include <vlc_interface.h>
-
 #include <assert.h>
 #include <errno.h>
-#ifdef HAVE_SYS_TYPES_H
-#   include <sys/types.h>
-#endif
-#ifdef HAVE_SYS_STAT_H
-#   include <sys/stat.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#ifdef HAVE_FSTATVFS
+#   include <sys/statvfs.h>
+#   if defined (HAVE_SYS_MOUNT_H)
+#      include <sys/param.h>
+#      include <sys/mount.h>
+#   endif
 #endif
-#ifdef HAVE_FCNTL_H
-#   include <fcntl.h>
+#ifdef HAVE_LINUX_MAGIC_H
+#   include <sys/vfs.h>
+#   include <linux/magic.h>
 #endif
 
-#if defined( WIN32 )
+#if defined( _WIN32 )
 #   include <io.h>
 #   include <ctype.h>
+#   include <shlwapi.h>
 #else
 #   include <unistd.h>
-#   include <poll.h>
 #endif
+#include <dirent.h>
 
-#if defined( WIN32 ) && !defined( UNDER_CE )
-#   ifdef lseek
-#      undef lseek
-#   endif
-#   define lseek _lseeki64
-#elif defined( UNDER_CE )
-/* FIXME the commandline on wince is a mess */
-# define dup(a) -1
+#include <vlc_common.h>
+#include "fs.h"
+#include <vlc_input.h>
+#include <vlc_access.h>
+#include <vlc_dialog.h>
+#ifdef _WIN32
+# include <vlc_charset.h>
 #endif
+#include <vlc_fs.h>
+#include <vlc_url.h>
 
-#include <vlc_charset.h>
+struct access_sys_t
+{
+    int fd;
 
-/*****************************************************************************
- * Module descriptor
- *****************************************************************************/
-static int  Open ( vlc_object_t * );
-static void Close( vlc_object_t * );
-
-#define CACHING_TEXT N_("Caching value in ms")
-#define CACHING_LONGTEXT N_( \
-    "Caching value for files. This " \
-    "value should be set in milliseconds." )
-
-vlc_module_begin();
-    set_description( N_("File input") );
-    set_shortname( N_("File") );
-    set_category( CAT_INPUT );
-    set_subcategory( SUBCAT_INPUT_ACCESS );
-    add_integer( "file-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, true );
-    add_obsolete_string( "file-cat" );
-    set_capability( "access", 50 );
-    add_shortcut( "file" );
-    add_shortcut( "stream" );
-    set_callbacks( Open, Close );
-vlc_module_end();
+    /* */
+    bool b_pace_control;
+};
+
+#if !defined (_WIN32) && !defined (__OS2__)
+static bool IsRemote (int fd)
+{
+#if defined (HAVE_FSTATVFS) && defined (MNT_LOCAL)
+    struct statvfs stf;
 
+    if (fstatvfs (fd, &stf))
+        return false;
+    /* fstatvfs() is in POSIX, but MNT_LOCAL is not */
+    return !(stf.f_flag & MNT_LOCAL);
 
-/*****************************************************************************
- * Exported prototypes
- *****************************************************************************/
-static int  Seek( access_t *, int64_t );
-static ssize_t Read( access_t *, uint8_t *, size_t );
-static int  Control( access_t *, int, va_list );
+#elif defined (HAVE_LINUX_MAGIC_H)
+    struct statfs stf;
 
-static int  open_file( access_t *, const char * );
+    if (fstatfs (fd, &stf))
+        return false;
 
-struct access_sys_t
+    switch ((unsigned long)stf.f_type)
+    {
+        case AFS_SUPER_MAGIC:
+        case CODA_SUPER_MAGIC:
+        case NCP_SUPER_MAGIC:
+        case NFS_SUPER_MAGIC:
+        case SMB_SUPER_MAGIC:
+        case 0xFF534D42 /*CIFS_MAGIC_NUMBER*/:
+            return true;
+    }
+    return false;
+
+#else
+    (void)fd;
+    return false;
+
+#endif
+}
+# define IsRemote(fd,path) IsRemote(fd)
+
+#else /* _WIN32 || __OS2__ */
+static bool IsRemote (const char *path)
 {
-    unsigned int i_nb_reads;
+# if !defined(__OS2__) && !VLC_WINSTORE_APP
+    wchar_t *wpath = ToWide (path);
+    bool is_remote = (wpath != NULL && PathIsNetworkPathW (wpath));
+    free (wpath);
+    return is_remote;
+# else
+    return (! strncmp(path, "\\\\", 2));
+# endif
+}
+# define IsRemote(fd,path) IsRemote(path)
+#endif
 
-    int fd;
+#ifndef HAVE_POSIX_FADVISE
+# define posix_fadvise(fd, off, len, adv)
+#endif
 
-    /* */
-    bool b_seekable;
-    bool b_pace_control;
-};
+static ssize_t FileRead (access_t *, uint8_t *, size_t);
+static int FileSeek (access_t *, uint64_t);
+static ssize_t StreamRead (access_t *, uint8_t *, size_t);
+static int NoSeek (access_t *, uint64_t);
+static int FileControl (access_t *, int, va_list);
 
 /*****************************************************************************
- * Open: open the file
+ * FileOpen: open the file
  *****************************************************************************/
-static int Open( vlc_object_t *p_this )
+int FileOpen( vlc_object_t *p_this )
 {
     access_t     *p_access = (access_t*)p_this;
-    access_sys_t *p_sys;
 
-    bool    b_stdin = !strcmp (p_access->psz_path, "-");
-
-    /* Update default_pts to a suitable value for file access */
-    var_Create( p_access, "file-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
-
-    STANDARD_READ_ACCESS_INIT;
-    p_sys->i_nb_reads = 0;
-    int fd = p_sys->fd = -1;
+    /* Open file */
+    int fd = -1;
 
-    if (!strcasecmp (p_access->psz_access, "stream"))
+    if (!strcasecmp (p_access->psz_access, "fd"))
     {
-        p_sys->b_seekable = false;
-        p_sys->b_pace_control = false;
+        char *end;
+        int oldfd = strtol (p_access->psz_location, &end, 10);
+
+        if (*end == '\0')
+            fd = vlc_dup (oldfd);
+        else if (*end == '/' && end > p_access->psz_location)
+        {
+            char *name = decode_URI_duplicate (end - 1);
+            if (name != NULL)
+            {
+                name[0] = '.';
+                fd = vlc_openat (oldfd, name, O_RDONLY | O_NONBLOCK);
+                free (name);
+            }
+        }
     }
     else
     {
-        p_sys->b_seekable = true;
-        p_sys->b_pace_control = true;
-    }
+        const char *path = p_access->psz_filepath;
 
-    /* Open file */
-    msg_Dbg (p_access, "opening file `%s'", p_access->psz_path);
-
-    if (b_stdin)
-        fd = dup (0);
-    else
-        fd = open_file (p_access, p_access->psz_path);
+        if (unlikely(path == NULL))
+            return VLC_EGENERIC;
+        msg_Dbg (p_access, "opening file `%s'", path);
+        fd = vlc_open (path, O_RDONLY | O_NONBLOCK);
+        if (fd == -1)
+        {
+            msg_Err (p_access, "cannot open file %s (%m)", path);
+            dialog_Fatal (p_access, _("File reading failed"),
+                          _("VLC could not open the file \"%s\" (%m)."), path);
+        }
+    }
+    if (fd == -1)
+        return VLC_EGENERIC;
 
-#ifdef HAVE_SYS_STAT_H
     struct stat st;
-
-    while (fd != -1)
+    if (fstat (fd, &st))
     {
-        if (fstat (fd, &st))
-            msg_Err (p_access, "fstat(%d): %m", fd);
-        else
-        if (S_ISDIR (st.st_mode))
-            /* The directory plugin takes care of that */
-            msg_Dbg (p_access, "file is a directory, aborting");
-        else
-            break; // success
-
-        close (fd);
-        fd = -1;
+        msg_Err (p_access, "failed to read (%m)");
+        goto error;
     }
+
+#if O_NONBLOCK
+    int flags = fcntl (fd, F_GETFL);
+    if (S_ISFIFO (st.st_mode) || S_ISSOCK (st.st_mode))
+        /* Force non-blocking mode where applicable (fd://) */
+        flags |= O_NONBLOCK;
+    else
+        /* Force blocking mode when not useful or not specified */
+        flags &= ~O_NONBLOCK;
+    fcntl (fd, F_SETFL, flags);
 #endif
 
-    if (fd == -1)
+    /* Directories can be opened and read from, but only readdir() knows
+     * how to parse the data. The directory plugin will do it. */
+    if (S_ISDIR (st.st_mode))
     {
-        free (p_sys);
-        return VLC_EGENERIC;
+#ifdef HAVE_FDOPENDIR
+        DIR *handle = fdopendir (fd);
+        if (handle == NULL)
+            goto error; /* Uh? */
+        return DirInit (p_access, handle);
+#else
+        msg_Dbg (p_access, "ignoring directory");
+        goto error;
+#endif
     }
+
+    access_sys_t *p_sys = malloc (sizeof (*p_sys));
+    if (unlikely(p_sys == NULL))
+        goto error;
+    access_InitFields (p_access);
+    p_access->pf_block = NULL;
+    p_access->pf_control = FileControl;
+    p_access->p_sys = p_sys;
     p_sys->fd = fd;
 
-#ifdef HAVE_SYS_STAT_H
-    p_access->info.i_size = st.st_size;
-    if (!S_ISREG (st.st_mode))
-        p_sys->b_seekable = false;
-#else
-    p_sys->b_seekable = !b_stdin;
-# warning File size not known!
+    if (S_ISREG (st.st_mode) || S_ISBLK (st.st_mode))
+    {
+        p_access->pf_read = FileRead;
+        p_access->pf_seek = FileSeek;
+        p_access->info.i_size = st.st_size;
+        p_sys->b_pace_control = true;
+
+        /* Demuxers will need the beginning of the file for probing. */
+        posix_fadvise (fd, 0, 4096, POSIX_FADV_WILLNEED);
+        /* In most cases, we only read the file once. */
+        posix_fadvise (fd, 0, 0, POSIX_FADV_NOREUSE);
+#ifdef F_RDAHEAD
+        fcntl (fd, F_RDAHEAD, 1);
+#endif
+#ifdef F_NOCACHE
+        fcntl (fd, F_NOCACHE, 0);
 #endif
+    }
+    else
+    {
+        p_access->pf_read = StreamRead;
+        p_access->pf_seek = NoSeek;
+        p_sys->b_pace_control = strcasecmp (p_access->psz_access, "stream");
+    }
 
     return VLC_SUCCESS;
+
+error:
+    close (fd);
+    return VLC_EGENERIC;
 }
 
 /*****************************************************************************
- * Close: close the target
+ * FileClose: close the target
  *****************************************************************************/
-static void Close (vlc_object_t * p_this)
+void FileClose (vlc_object_t * p_this)
 {
     access_t     *p_access = (access_t*)p_this;
+
+    if (p_access->pf_read == NULL)
+    {
+        DirClose (p_this);
+        return;
+    }
+
     access_sys_t *p_sys = p_access->p_sys;
 
     close (p_sys->fd);
@@ -202,65 +276,47 @@ static void Close (vlc_object_t * p_this)
 
 #include <vlc_network.h>
 
-/*****************************************************************************
- * Read: standard read on a file descriptor.
- *****************************************************************************/
-static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
+/**
+ * Reads from a regular file.
+ */
+static ssize_t FileRead (access_t *p_access, uint8_t *p_buffer, size_t i_len)
 {
     access_sys_t *p_sys = p_access->p_sys;
     int fd = p_sys->fd;
-    ssize_t i_ret;
-
-#ifndef WIN32
-    i_ret = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
-#else
-    i_ret = read (fd, p_buffer, i_len);
-#endif
+    ssize_t val = read (fd, p_buffer, i_len);
 
-    if( i_ret < 0 )
+    if (val < 0)
     {
         switch (errno)
         {
             case EINTR:
             case EAGAIN:
-                break;
-
-            default:
-                msg_Err (p_access, "read failed (%m)");
-                intf_UserFatal (p_access, false, _("File reading failed"),
-                                _("VLC could not read the file."));
-                return 0;
+                return -1;
         }
-    }
-    else if( i_ret > 0 )
-        p_access->info.i_pos += i_ret;
-    else if( i_ret == 0 )
-        p_access->info.b_eof = true;
 
-    p_sys->i_nb_reads++;
+        msg_Err (p_access, "read error: %m");
+        dialog_Fatal (p_access, _("File reading failed"),
+                      _("VLC could not read the file (%m)."));
+        val = 0;
+    }
 
-#ifdef HAVE_SYS_STAT_H
-    if( p_access->info.i_size != 0 &&
-        (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 )
+    p_access->info.i_pos += val;
+    p_access->info.b_eof = !val;
+    if (p_access->info.i_pos >= p_access->info.i_size)
     {
         struct stat st;
 
-        if ((fstat (fd, &st) == 0)
-         && (p_access->info.i_size != st.st_size))
-        {
+        if (fstat (fd, &st) == 0)
             p_access->info.i_size = st.st_size;
-            p_access->info.i_update |= INPUT_UPDATE_SIZE;
-        }
     }
-#endif
-    return i_ret;
+    return val;
 }
 
 
 /*****************************************************************************
  * Seek: seek to a specific location in a file
  *****************************************************************************/
-static int Seek (access_t *p_access, int64_t i_pos)
+static int FileSeek (access_t *p_access, uint64_t i_pos)
 {
     p_access->info.i_pos = i_pos;
     p_access->info.b_eof = false;
@@ -269,15 +325,52 @@ static int Seek (access_t *p_access, int64_t i_pos)
     return VLC_SUCCESS;
 }
 
+/**
+ * Reads from a non-seekable file.
+ */
+static ssize_t StreamRead (access_t *p_access, uint8_t *p_buffer, size_t i_len)
+{
+    access_sys_t *p_sys = p_access->p_sys;
+    int fd = p_sys->fd;
+
+#if !defined (_WIN32) && !defined (__OS2__)
+    ssize_t val = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
+#else
+    ssize_t val = read (fd, p_buffer, i_len);
+#endif
+
+    if (val < 0)
+    {
+        switch (errno)
+        {
+            case EINTR:
+            case EAGAIN:
+                return -1;
+        }
+        msg_Err (p_access, "read error: %m");
+        val = 0;
+    }
+
+    p_access->info.i_pos += val;
+    p_access->info.b_eof = !val;
+    return val;
+}
+
+static int NoSeek (access_t *p_access, uint64_t i_pos)
+{
+    /* assert(0); ?? */
+    (void) p_access; (void) i_pos;
+    return VLC_EGENERIC;
+}
+
 /*****************************************************************************
  * Control:
  *****************************************************************************/
-static int Control( access_t *p_access, int i_query, va_list args )
+static int FileControl( access_t *p_access, int i_query, va_list args )
 {
     access_sys_t *p_sys = p_access->p_sys;
-    bool   *pb_bool;
-    int          *pi_int;
-    int64_t      *pi_64;
+    bool    *pb_bool;
+    int64_t *pi_64;
 
     switch( i_query )
     {
@@ -285,7 +378,7 @@ static int Control( access_t *p_access, int i_query, va_list args )
         case ACCESS_CAN_SEEK:
         case ACCESS_CAN_FASTSEEK:
             pb_bool = (bool*)va_arg( args, bool* );
-            *pb_bool = p_sys->b_seekable;
+            *pb_bool = (p_access->pf_seek != NoSeek);
             break;
 
         case ACCESS_CAN_PAUSE:
@@ -295,14 +388,13 @@ static int Control( access_t *p_access, int i_query, va_list args )
             break;
 
         /* */
-        case ACCESS_GET_MTU:
-            pi_int = (int*)va_arg( args, int * );
-            *pi_int = 0;
-            break;
-
         case ACCESS_GET_PTS_DELAY:
             pi_64 = (int64_t*)va_arg( args, int64_t * );
-            *pi_64 = var_GetInteger( p_access, "file-caching" ) * INT64_C(1000);
+            if (IsRemote (p_sys->fd, p_access->psz_filepath))
+                *pi_64 = var_InheritInteger (p_access, "network-caching");
+            else
+                *pi_64 = var_InheritInteger (p_access, "file-caching");
+            *pi_64 *= 1000;
             break;
 
         /* */
@@ -326,42 +418,3 @@ static int Control( access_t *p_access, int i_query, va_list args )
     }
     return VLC_SUCCESS;
 }
-
-/*****************************************************************************
- * open_file: Opens a specific file
- *****************************************************************************/
-static int open_file (access_t *p_access, const char *path)
-{
-#if defined(WIN32)
-    if (!strcasecmp (p_access->psz_access, "file")
-      && ('/' == path[0]) && isalpha (path[1])
-      && (':' == path[2]) && ('/' == path[3]))
-        /* Explorer can open path such as file:/C:/ or file:///C:/
-         * hence remove leading / if found */
-        path++;
-#endif
-
-    int fd = utf8_open (path, O_RDONLY | O_NONBLOCK /* O_LARGEFILE*/, 0666);
-    if (fd == -1)
-    {
-        msg_Err (p_access, "cannot open file %s (%m)", path);
-        intf_UserFatal (p_access, false, _("File reading failed"),
-                        _("VLC could not open the file \"%s\"."), path);
-        return -1;
-    }
-
-#if defined(HAVE_FCNTL)
-    fcntl (fd, F_SETFD, fcntl (fd, F_GETFD) | FD_CLOEXEC);
-
-    /* We'd rather use any available memory for reading ahead
-     * than for caching what we've already seen/heard */
-# if defined(F_RDAHEAD)
-    fcntl (fd, F_RDAHEAD, 1);
-# endif
-# if defined(F_NOCACHE)
-    fcntl (fd, F_NOCACHE, 1);
-# endif
-#endif
-
-    return fd;
-}