file.c 10.7 KB
Newer Older
1
2
3
/*****************************************************************************
 * file.c: file input (file: access plug-in)
 *****************************************************************************
4
 * Copyright (C) 2001-2006 the VideoLAN team
5
 * Copyright © 2006-2007 Rémi Denis-Courmont
gbazin's avatar
gbazin committed
6
 * $Id$
7
8
 *
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
9
 *          Rémi Denis-Courmont <rem # videolan # org>
10
11
12
13
14
 *
 * 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
 * (at your option) any later version.
15
 *
16
17
18
19
20
21
22
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
dionoea's avatar
dionoea committed
23
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24
25
 *****************************************************************************/

26
27
28
29
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

30
#include <vlc_common.h>
31
#include "fs.h"
zorglub's avatar
zorglub committed
32
33
#include <vlc_input.h>
#include <vlc_access.h>
34
#include <vlc_dialog.h>
35

36
#include <assert.h>
37
#include <errno.h>
38
#include <sys/types.h>
39
40
41
42
43
44
#ifdef HAVE_SYS_STAT_H
#   include <sys/stat.h>
#endif
#ifdef HAVE_FCNTL_H
#   include <fcntl.h>
#endif
45
46
47
48
49
50
51
#ifdef HAVE_FSTATVFS
#   include <sys/statvfs.h>
#   if defined (HAVE_SYS_MOUNT_H)
#      include <sys/param.h>
#      include <sys/mount.h>
#   endif
#endif
52
#ifdef HAVE_LINUX_MAGIC_H
53
#   include <sys/vfs.h>
54
#   include <linux/magic.h>
55
#endif
56

57
#if defined( WIN32 )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
58
#   include <io.h>
59
#   include <ctype.h>
60
#   include <shlwapi.h>
61
#   include <vlc_charset.h>
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
62
#else
63
64
#   include <unistd.h>
#endif
65
#include <dirent.h>
66

gbazin's avatar
   
gbazin committed
67
#if defined( WIN32 ) && !defined( UNDER_CE )
68
69
70
71
#   ifdef lseek
#      undef lseek
#   endif
#   define lseek _lseeki64
gbazin's avatar
gbazin committed
72
73
#endif

74
#include <vlc_fs.h>
75
#include <vlc_url.h>
76

77
struct access_sys_t
78
{
79
    unsigned int i_nb_reads;
gbazin's avatar
gbazin committed
80

81
    int fd;
gbazin's avatar
gbazin committed
82

83
    /* */
84
    bool b_pace_control;
85
};
86

87
#if !defined (WIN32) && !defined (__OS2__)
88
89
static bool IsRemote (int fd)
{
90
91
92
93
94
95
#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 */
Joseph S. Atkinson's avatar
Joseph S. Atkinson committed
96
    return !(stf.f_flag & MNT_LOCAL);
97
98

#elif defined (HAVE_LINUX_MAGIC_H)
99
100
101
102
103
    struct statfs stf;

    if (fstatfs (fd, &stf))
        return false;

104
    switch ((unsigned long)stf.f_type)
105
106
107
108
109
110
111
112
113
114
    {
        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;
115
116

#else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
117
    (void)fd;
118
119
120
121
    return false;

#endif
}
122
123
# define IsRemote(fd,path) IsRemote(fd)

KO Myung-Hun's avatar
KO Myung-Hun committed
124
#else /* WIN32 || __OS2__ */
125
126
static bool IsRemote (const char *path)
{
KO Myung-Hun's avatar
KO Myung-Hun committed
127
# if !defined(UNDER_CE) && !defined(__OS2__)
128
129
130
131
132
133
134
135
136
137
    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
138

139
#ifndef HAVE_POSIX_FADVISE
140
# define posix_fadvise(fd, off, len, adv)
141
#endif
142

143
/*****************************************************************************
Rafaël Carré's avatar
Rafaël Carré committed
144
 * FileOpen: open the file
145
 *****************************************************************************/
Rafaël Carré's avatar
Rafaël Carré committed
146
int FileOpen( vlc_object_t *p_this )
147
{
148
149
    access_t     *p_access = (access_t*)p_this;

150
    /* Open file */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
151
    int fd = -1;
152
153

    if (!strcasecmp (p_access->psz_access, "fd"))
154
155
    {
        char *end;
156
        int oldfd = strtol (p_access->psz_location, &end, 10);
157
158

        if (*end == '\0')
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
159
            fd = vlc_dup (oldfd);
160
        else if (*end == '/' && end > p_access->psz_location)
161
162
        {
            char *name = decode_URI_duplicate (end - 1);
163
            if (name != NULL)
164
165
            {
                name[0] = '.';
166
                fd = vlc_openat (oldfd, name, O_RDONLY | O_NONBLOCK);
167
168
169
170
                free (name);
            }
        }
    }
171
    else
172
    {
173
174
        const char *path = p_access->psz_filepath;

175
        msg_Dbg (p_access, "opening file `%s'", path);
176
        fd = vlc_open (path, O_RDONLY | O_NONBLOCK);
177
178
179
180
        if (fd == -1)
        {
            msg_Err (p_access, "cannot open file %s (%m)", path);
            dialog_Fatal (p_access, _("File reading failed"),
181
                          _("VLC could not open the file \"%s\". (%m)"), path);
182
        }
183
    }
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
184
    if (fd == -1)
185
        return VLC_EGENERIC;
186

187
    struct stat st;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
188
    if (fstat (fd, &st))
gbazin's avatar
gbazin committed
189
    {
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
190
191
        msg_Err (p_access, "failed to read (%m)");
        goto error;
192
    }
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
193
194
195
    /* 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))
196
    {
197
198
199
200
201
202
#ifdef HAVE_FDOPENDIR
        DIR *handle = fdopendir (fd);
        if (handle == NULL)
            goto error; /* Uh? */
        return DirInit (p_access, handle);
#else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
203
204
        msg_Dbg (p_access, "ignoring directory");
        goto error;
205
#endif
206
    }
207
208
209
210
211
212
213
214
215
216
217
218
219
220

    access_sys_t *p_sys = malloc (sizeof (*p_sys));
    if (unlikely(p_sys == NULL))
        goto error;
    access_InitFields (p_access);
    p_access->pf_read = FileRead;
    p_access->pf_block = NULL;
    p_access->pf_control = FileControl;
    p_access->pf_seek = FileSeek;
    p_access->p_sys = p_sys;
    p_sys->i_nb_reads = 0;
    p_sys->fd = fd;
    p_sys->b_pace_control = true;

221
222
223
    if (S_ISREG (st.st_mode))
        p_access->info.i_size = st.st_size;
    else if (!S_ISBLK (st.st_mode))
224
    {
225
        p_access->pf_seek = NoSeek;
226
227
        p_sys->b_pace_control = strcasecmp (p_access->psz_access, "stream");
    }
228
229
230
231
232
233
234

    if (p_access->pf_seek != NoSeek)
    {
        /* 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);
235
236
237
238
239
240
241
242
243
244
#if defined(HAVE_FCNTL)
        /* 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
245
    }
246
    return VLC_SUCCESS;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
247
248

error:
249
    close (fd);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
250
    return VLC_EGENERIC;
251
252
253
}

/*****************************************************************************
Rafaël Carré's avatar
Rafaël Carré committed
254
 * FileClose: close the target
255
 *****************************************************************************/
Rafaël Carré's avatar
Rafaël Carré committed
256
void FileClose (vlc_object_t * p_this)
257
{
258
    access_t     *p_access = (access_t*)p_this;
259
260
261
262
263
264
265

    if (p_access->pf_read == NULL)
    {
        DirClose (p_this);
        return;
    }

266
    access_sys_t *p_sys = p_access->p_sys;
267

268
    close (p_sys->fd);
269
    free (p_sys);
270
271
}

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
272
273
274

#include <vlc_network.h>

275
276
277
/*****************************************************************************
 * Read: standard read on a file descriptor.
 *****************************************************************************/
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;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
282
    ssize_t i_ret;
283

284
#if !defined (WIN32) && !defined (__OS2__)
285
    if (p_access->pf_seek == NoSeek)
286
287
        i_ret = net_Read (p_access, fd, NULL, p_buffer, i_len, false);
    else
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
288
#endif
289
        i_ret = read (fd, p_buffer, i_len);
290

291
292
    if( i_ret < 0 )
    {
293
        switch (errno)
294
        {
295
296
297
298
299
            case EINTR:
            case EAGAIN:
                break;

            default:
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
300
                msg_Err (p_access, "failed to read (%m)");
301
                dialog_Fatal (p_access, _("File reading failed"), "%s (%m)",
302
                              _("VLC could not read the file."));
303
                p_access->info.b_eof = true;
304
                return 0;
305
        }
306
    }
307
308
    else if( i_ret > 0 )
        p_access->info.i_pos += i_ret;
ivoire's avatar
ivoire committed
309
    else
310
        p_access->info.b_eof = true;
311
312

    p_sys->i_nb_reads++;
313

314
315
    if ((p_access->info.i_size && !(p_sys->i_nb_reads % INPUT_FSTAT_NB_READS))
     || (p_access->info.i_pos > p_access->info.i_size))
316
    {
317
#ifdef HAVE_SYS_STAT_H
318
        struct stat st;
gbazin's avatar
gbazin committed
319

320
        if ((fstat (fd, &st) == 0)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
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
329
330
    return i_ret;
}

331

332
333
334
/*****************************************************************************
 * Seek: seek to a specific location in a file
 *****************************************************************************/
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

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
340
    lseek (p_access->p_sys->fd, i_pos, SEEK_SET);
341
342
343
    return VLC_SUCCESS;
}

344
int NoSeek (access_t *p_access, uint64_t i_pos)
345
346
347
348
349
350
{
    /* assert(0); ?? */
    (void) p_access; (void) i_pos;
    return VLC_EGENERIC;
}

351
352
353
/*****************************************************************************
 * Control:
 *****************************************************************************/
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
358
    bool    *pb_bool;
    int64_t *pi_64;
359
360

    switch( i_query )
361
    {
362
363
364
        /* */
        case ACCESS_CAN_SEEK:
        case ACCESS_CAN_FASTSEEK:
365
            pb_bool = (bool*)va_arg( args, bool* );
366
            *pb_bool = (p_access->pf_seek != NoSeek);
367
368
369
370
            break;

        case ACCESS_CAN_PAUSE:
        case ACCESS_CAN_CONTROL_PACE:
371
            pb_bool = (bool*)va_arg( args, bool* );
372
373
374
375
376
377
            *pb_bool = p_sys->b_pace_control;
            break;

        /* */
        case ACCESS_GET_PTS_DELAY:
            pi_64 = (int64_t*)va_arg( args, int64_t * );
378
            if (IsRemote (p_sys->fd, p_access->psz_filepath))
379
380
381
382
                *pi_64 = var_InheritInteger (p_access, "network-caching");
            else
                *pi_64 = var_InheritInteger (p_access, "file-caching");
            *pi_64 *= 1000;
383
            break;
384

385
386
387
388
389
390
391
392
        /* */
        case ACCESS_SET_PAUSE_STATE:
            /* Nothing to do */
            break;

        case ACCESS_GET_TITLE_INFO:
        case ACCESS_SET_TITLE:
        case ACCESS_SET_SEEKPOINT:
393
        case ACCESS_SET_PRIVATE_ID_STATE:
394
        case ACCESS_GET_META:
395
        case ACCESS_GET_PRIVATE_ID_STATE:
396
        case ACCESS_GET_CONTENT_TYPE:
397
398
399
            return VLC_EGENERIC;

        default:
400
            msg_Warn( p_access, "unimplemented query %d in control", i_query );
401
402
            return VLC_EGENERIC;

403
    }
404
    return VLC_SUCCESS;
405
}