gnomevfs.c 12.8 KB
Newer Older
1
/*****************************************************************************
2
 * gnomevfs.c: GnomeVFS input
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
4
 * Copyright (C) 2005 VLC authors and VideoLAN
5
 * $Id$
6 7 8
 *
 * Authors: Benjamin Pracht <bigben -AT- videolan -DOT- org>
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
9 10 11
 * 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
12 13 14 15
 * (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
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
18
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
19 20 21
 * 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.
22 23 24 25 26
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
27

28 29 30 31
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

32
#include <vlc_common.h>
33
#include <vlc_plugin.h>
34 35
#include <vlc_access.h>

36 37
#include <libgnomevfs/gnome-vfs.h>

38
#include <vlc_url.h>
39 40 41 42 43 44 45

/*****************************************************************************
 * Module descriptor
 *****************************************************************************/
static int  Open ( vlc_object_t * );
static void Close( vlc_object_t * );

46 47 48 49 50 51 52 53 54
vlc_module_begin ()
    set_description( N_("GnomeVFS input") )
    set_shortname( "GnomeVFS" )
    set_category( CAT_INPUT )
    set_subcategory( SUBCAT_INPUT_ACCESS )
    set_capability( "access", 10 )
    add_shortcut( "gnomevfs" )
    set_callbacks( Open, Close )
vlc_module_end ()
55 56 57 58 59


/*****************************************************************************
 * Exported prototypes
 *****************************************************************************/
60 61 62
static int     Seek( access_t *, uint64_t );
static ssize_t Read( access_t *, uint8_t *, size_t );
static int     Control( access_t *, int, va_list );
63 64 65 66 67 68 69 70 71

struct access_sys_t
{
    unsigned int i_nb_reads;
    char *psz_name;

    GnomeVFSHandle *p_handle;
    GnomeVFSFileInfo *p_file_info;

72 73 74
    bool b_local;
    bool b_seekable;
    bool b_pace_control;
75 76
};

77 78 79
/* NOTE: we do not handle memory errors in this plugin.
 * Underlying glib does not, so there is no point in doing it here either. */

80 81 82 83 84
/*****************************************************************************
 * Open: open the file
 *****************************************************************************/
static int Open( vlc_object_t *p_this )
{
85 86 87 88
    access_t       *p_access = (access_t*)p_this;
    access_sys_t   *p_sys = NULL;
    char           *psz_name = NULL;
    char           *psz_uri = NULL;
89 90
    char           *psz_unescaped = NULL;
    char           *psz_expand_tilde = NULL;
91 92 93
    GnomeVFSURI    *p_uri = NULL;
    GnomeVFSResult  i_ret;
    GnomeVFSHandle *p_handle = NULL;
94 95 96 97 98
    if( !(gnome_vfs_init()) )
    {
        msg_Warn( p_access, "couldn't initilize GnomeVFS" );
        return VLC_EGENERIC;
    }
99

100 101
    /* FIXME
       Since GnomeVFS segfaults on exit if we initialize it without trying to
102 103
       open a file with a valid protocol, try to open at least file:// */
    gnome_vfs_open( &p_handle, "file://", 5 );
104

105
    STANDARD_READ_ACCESS_INIT;
106 107

    p_sys->p_handle = p_handle;
108
    p_sys->i_nb_reads = 0;
109
    p_sys->b_pace_control = true;
110

111 112
    if( strcmp( "gnomevfs", p_access->psz_access ) &&
                                            *(p_access->psz_access) != '\0')
113
    {
114
        asprintf( &psz_name, "%s://%s", p_access->psz_access,
115
                  p_access->psz_location );
116 117 118
    }
    else
    {
119
        psz_name = strdup( p_access->psz_location );
120
    }
121
    psz_expand_tilde = gnome_vfs_expand_initial_tilde( psz_name );
122 123

    psz_unescaped = gnome_vfs_make_uri_from_shell_arg( psz_expand_tilde );
124

125 126 127 128 129
   /* gnome_vfs_make_uri_from_shell_arg will only escape the uri
      for relative paths. So we need to use
      gnome_vfs_escape_host_and_path_string in other cases. */

    if( !strcmp( psz_unescaped, psz_expand_tilde ) )
130
    {
131 132 133 134 135 136 137 138 139 140 141 142 143
    /* Now we are sure that we have a complete valid unescaped URI beginning
       with the protocol. We want to escape it. However, gnomevfs's escaping
       function are broken and will try to escape characters un the username/
       password field. So parse the URI with vlc_UrlParse ans only escape the
       path */

        vlc_url_t url;
        char *psz_escaped_path;
        char *psz_path_begin;

        vlc_UrlParse( &url, psz_unescaped, 0 );
        psz_escaped_path = gnome_vfs_escape_path_string( url.psz_path );

Benjamin Pracht's avatar
Benjamin Pracht committed
144
        if( psz_escaped_path )
145
        {
146
    /* Now let's reconstruct a valid URI from all that stuff */
Benjamin Pracht's avatar
Benjamin Pracht committed
147 148 149
            psz_path_begin = psz_unescaped + strlen( psz_unescaped )
                                           - strlen( url.psz_path );
            *psz_path_begin = '\0';
150
            asprintf( &psz_uri, "%s%s", psz_unescaped, psz_escaped_path );
151

152 153 154 155 156 157 158
            g_free( psz_escaped_path );
            g_free( psz_unescaped );
        }
        else
        {
            psz_uri = psz_unescaped;
        }
159 160 161 162
    }
    else
    {
        psz_uri = psz_unescaped;
163 164
    }

165
    g_free( psz_expand_tilde );
166 167 168
    p_uri = gnome_vfs_uri_new( psz_uri );
    if( p_uri )
    {
169 170
        p_sys->p_file_info = gnome_vfs_file_info_new();
        i_ret = gnome_vfs_get_file_info_uri( p_uri,
171
                                                p_sys->p_file_info, 8 );
172

173 174
        if( i_ret )
        {
175
            msg_Warn( p_access, "cannot get file info for uri %s (%s)",
176
                                psz_uri, gnome_vfs_result_to_string( i_ret ) );
177
            gnome_vfs_file_info_unref( p_sys->p_file_info );
178 179
            gnome_vfs_uri_unref( p_uri);
            free( p_sys );
180
            free( psz_uri );
181 182 183 184 185 186
            free( psz_name );
            return VLC_EGENERIC;
        }
    }
    else
    {
187
        msg_Warn( p_access, "cannot parse MRL %s or unsupported protocol", psz_name );
188
        free( psz_uri );
189 190 191 192 193
        free( p_sys );
        free( psz_name );
        return VLC_EGENERIC;
    }

194
    msg_Dbg( p_access, "opening file `%s'", psz_uri );
195
    i_ret = gnome_vfs_open( &(p_sys->p_handle), psz_uri, 5 );
196 197
    if( i_ret )
    {
198
        msg_Warn( p_access, "cannot open file %s: %s", psz_uri,
199 200 201
                                gnome_vfs_result_to_string( i_ret ) );

        gnome_vfs_uri_unref( p_uri);
202
        free( psz_uri );
203
        free( p_sys );
204 205 206 207 208 209
        free( psz_name );
        return VLC_EGENERIC;
    }

    if (GNOME_VFS_FILE_INFO_LOCAL( p_sys->p_file_info ))
    {
210
        p_sys->b_local = true;
211 212
    }

213
    if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_REGULAR ||
214 215 216
        p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_CHARACTER_DEVICE ||
        p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_BLOCK_DEVICE )
    {
217
        p_sys->b_seekable = true;
218 219 220 221 222
        p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
    }
    else if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_FIFO
              || p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_SOCKET )
    {
223
        p_sys->b_seekable = false;
224 225 226 227 228 229 230 231 232 233
    }
    else
    {
        msg_Err( p_access, "unknown file type for `%s'", psz_name );
        return VLC_EGENERIC;
    }

    if( p_sys->b_seekable && !p_access->info.i_size )
    {
        /* FIXME that's bad because all others access will be probed */
234
        msg_Warn( p_access, "file %s is empty, aborting", psz_name );
235
        gnome_vfs_file_info_unref( p_sys->p_file_info );
236
        gnome_vfs_uri_unref( p_uri);
237
        free( p_sys );
238
        free( psz_uri );
239 240 241 242
        free( psz_name );
        return VLC_EGENERIC;
    }

243
    free( psz_uri );
244
    p_sys->psz_name = psz_name;
245
    gnome_vfs_uri_unref( p_uri);
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
    return VLC_SUCCESS;
}

/*****************************************************************************
 * Close: close the target
 *****************************************************************************/
static void Close( vlc_object_t * p_this )
{
    access_t     *p_access = (access_t*)p_this;
    access_sys_t *p_sys = p_access->p_sys;
    int i_result;

    i_result = gnome_vfs_close( p_sys->p_handle );
    if( i_result )
    {
         msg_Err( p_access, "cannot close %s: %s", p_sys->psz_name,
                                gnome_vfs_result_to_string( i_result ) );
    }

    gnome_vfs_file_info_unref( p_sys->p_file_info );

    free( p_sys->psz_name );
    free( p_sys );
}

/*****************************************************************************
 * Read: standard read on a file descriptor.
 *****************************************************************************/
274
static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
275 276 277
{
    access_sys_t *p_sys = p_access->p_sys;
    GnomeVFSFileSize i_read_len;
278
    int i_ret;
279 280 281 282 283

    i_ret = gnome_vfs_read( p_sys->p_handle, p_buffer,
                                  (GnomeVFSFileSize)i_len, &i_read_len );
    if( i_ret )
    {
284
        p_access->info.b_eof = true;
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
        if( i_ret != GNOME_VFS_ERROR_EOF )
        {
            msg_Err( p_access, "read failed (%s)",
                                    gnome_vfs_result_to_string( i_ret ) );
        }
    }
    else
    {
        p_sys->i_nb_reads++;
        if( p_access->info.i_size != 0 &&
            (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 &&
            p_sys->b_local )
        {
            gnome_vfs_file_info_clear( p_sys->p_file_info );
            i_ret = gnome_vfs_get_file_info_from_handle( p_sys->p_handle,
                                                p_sys->p_file_info, 8 );
            if( i_ret )
            {
                msg_Warn( p_access, "couldn't get file properties again (%s)",
                                        gnome_vfs_result_to_string( i_ret ) );
            }
            else
            {
                p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
            }
        }
    }

    p_access->info.i_pos += (int64_t)i_read_len;

315 316 317
    /* Some Acces (http) never return EOF and loop on the file */
    if( p_access->info.i_pos > p_access->info.i_size )
    {
318
        p_access->info.b_eof = true;
319 320
        return 0;
    }
321 322 323 324 325 326
    return (int)i_read_len;
}

/*****************************************************************************
 * Seek: seek to a specific location in a file
 *****************************************************************************/
327
static int Seek( access_t *p_access, uint64_t i_pos )
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
{
    access_sys_t *p_sys = p_access->p_sys;
    int i_ret;

    i_ret = gnome_vfs_seek( p_sys->p_handle, GNOME_VFS_SEEK_START,
                                            (GnomeVFSFileOffset)i_pos);
    if ( !i_ret )
    {
        p_access->info.i_pos = i_pos;
    }
    else
    {
        GnomeVFSFileSize i_offset;
        msg_Err( p_access, "cannot seek (%s)",
                                        gnome_vfs_result_to_string( i_ret ) );
        i_ret = gnome_vfs_tell( p_sys->p_handle, &i_offset );
        if( !i_ret )
        {
            msg_Err( p_access, "cannot tell the current position (%s)",
                                        gnome_vfs_result_to_string( i_ret ) );
            return VLC_EGENERIC;
        }
    }
    /* Reset eof */
352
    p_access->info.b_eof = false;
353 354 355 356 357 358 359 360 361 362 363

    /* FIXME */
    return VLC_SUCCESS;
}

/*****************************************************************************
 * Control:
 *****************************************************************************/
static int Control( access_t *p_access, int i_query, va_list args )
{
    access_sys_t *p_sys = p_access->p_sys;
364
    bool   *pb_bool;
365 366 367 368 369 370 371
    int64_t      *pi_64;

    switch( i_query )
    {
        /* */
        case ACCESS_CAN_SEEK:
        case ACCESS_CAN_FASTSEEK:
372
            pb_bool = (bool*)va_arg( args, bool* );
373 374 375 376 377
            *pb_bool = p_sys->b_seekable;
            break;

        case ACCESS_CAN_PAUSE:
        case ACCESS_CAN_CONTROL_PACE:
378
            pb_bool = (bool*)va_arg( args, bool* );
379 380 381 382 383
            *pb_bool = p_sys->b_pace_control;
            break;

        case ACCESS_GET_PTS_DELAY:
            pi_64 = (int64_t*)va_arg( args, int64_t * );
384
            *pi_64 = DEFAULT_PTS_DELAY; /* FIXME */
385 386 387 388 389 390 391 392 393 394 395 396
            break;

        /* */
        case ACCESS_SET_PAUSE_STATE:
            /* Nothing to do */
            break;

        case ACCESS_GET_TITLE_INFO:
        case ACCESS_SET_TITLE:
        case ACCESS_SET_SEEKPOINT:
        case ACCESS_SET_PRIVATE_ID_STATE:
        case ACCESS_GET_META:
397
        case ACCESS_GET_CONTENT_TYPE:
398 399 400 401 402 403 404 405 406
            return VLC_EGENERIC;

        default:
            msg_Warn( p_access, "unimplemented query in control" );
            return VLC_EGENERIC;

    }
    return VLC_SUCCESS;
}