gnomevfs.c 13.7 KB
Newer Older
Benjamin Pracht's avatar
Benjamin Pracht committed
1
/*****************************************************************************
Christophe Mutricy's avatar
Christophe Mutricy committed
2
 * gnomevfs.c: GnomeVFS input
Benjamin Pracht's avatar
Benjamin Pracht committed
3
 *****************************************************************************
Christophe Mutricy's avatar
Christophe Mutricy committed
4 5
 * Copyright (C) 2005 the VideoLAN team
 * $Id$
Benjamin Pracht's avatar
Benjamin Pracht committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * Authors: Benjamin Pracht <bigben -AT- videolan -DOT- 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
 * (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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Benjamin Pracht's avatar
Benjamin Pracht committed
22 23 24 25 26 27
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/
#include <vlc/vlc.h>
Clément Stenac's avatar
Clément Stenac committed
28 29
#include <vlc_access.h>

Benjamin Pracht's avatar
Benjamin Pracht committed
30 31
#include <libgnomevfs/gnome-vfs.h>

32
#include <stdio.h>
Benjamin Pracht's avatar
Benjamin Pracht committed
33

Clément Stenac's avatar
Clément Stenac committed
34
#include <vlc_charset.h>
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
35
#include "vlc_url.h"
Benjamin Pracht's avatar
Benjamin Pracht committed
36 37 38 39 40 41 42 43 44

/*****************************************************************************
 * 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_( \
45
    "Caching value for GnomeVFS streams."\
Clément Stenac's avatar
Clément Stenac committed
46
    "This value should be set in milliseconds." )
Benjamin Pracht's avatar
Benjamin Pracht committed
47 48

vlc_module_begin();
Clément Stenac's avatar
Clément Stenac committed
49
    set_description( _("GnomeVFS input") );
50
    set_shortname( "GnomeVFS" );
Benjamin Pracht's avatar
Benjamin Pracht committed
51 52 53
    set_category( CAT_INPUT );
    set_subcategory( SUBCAT_INPUT_ACCESS );
    add_integer( "gnomevfs-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
54
    set_capability( "access2", 10 );
Benjamin Pracht's avatar
Benjamin Pracht committed
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
    add_shortcut( "gnomevfs" );
    set_callbacks( Open, Close );
vlc_module_end();


/*****************************************************************************
 * Exported prototypes
 *****************************************************************************/
static int  Seek( access_t *, int64_t );
static int  Read( access_t *, uint8_t *, int );
static int  Control( access_t *, int, va_list );

struct access_sys_t
{
    unsigned int i_nb_reads;
    char *psz_name;

    GnomeVFSHandle *p_handle;
    GnomeVFSFileInfo *p_file_info;

    vlc_bool_t b_local;
    vlc_bool_t b_seekable;
    vlc_bool_t b_pace_control;
};

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

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

106
    STANDARD_READ_ACCESS_INIT;
107 108

    p_sys->p_handle = p_handle;
Benjamin Pracht's avatar
Benjamin Pracht committed
109 110 111
    p_sys->i_nb_reads = 0;
    p_sys->b_pace_control = VLC_TRUE;

112 113
    if( strcmp( "gnomevfs", p_access->psz_access ) &&
                                            *(p_access->psz_access) != '\0')
114 115
    {
        psz_name = malloc( strlen( p_access->psz_access ) +
116 117 118
                                            strlen( p_access->psz_path ) + 4 );
        sprintf( psz_name, "%s://%s", p_access->psz_access,
                                                    p_access->psz_path );
119 120 121 122 123
    }
    else
    {
        psz_name = strdup( p_access->psz_path );
    }
Benjamin Pracht's avatar
Benjamin Pracht committed
124
    psz = ToLocale( psz_name );
125 126 127 128
    psz_expand_tilde = gnome_vfs_expand_initial_tilde( psz );
    LocaleFree( psz );

    psz_unescaped = gnome_vfs_make_uri_from_shell_arg( psz_expand_tilde );
129

130 131 132 133 134
   /* 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 ) )
135
    {
136 137 138 139 140 141 142 143 144 145 146 147 148
    /* 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
149
        if( psz_escaped_path )
150
        {
151
    /* Now let's reconstruct a valid URI from all that stuff */
Benjamin Pracht's avatar
Benjamin Pracht committed
152 153 154
            psz_path_begin = psz_unescaped + strlen( psz_unescaped )
                                           - strlen( url.psz_path );
            *psz_path_begin = '\0';
155
            psz_uri = malloc( strlen( psz_unescaped ) +
156
                                        strlen( psz_escaped_path ) + 1 );
157
            sprintf( psz_uri, "%s%s",psz_unescaped, psz_escaped_path );
158

159 160 161 162 163 164 165
            g_free( psz_escaped_path );
            g_free( psz_unescaped );
        }
        else
        {
            psz_uri = psz_unescaped;
        }
166 167 168 169
    }
    else
    {
        psz_uri = psz_unescaped;
170 171
    }

172
    g_free( psz_expand_tilde );
Benjamin Pracht's avatar
Benjamin Pracht committed
173 174 175
    p_uri = gnome_vfs_uri_new( psz_uri );
    if( p_uri )
    {
176 177
        p_sys->p_file_info = gnome_vfs_file_info_new();
        i_ret = gnome_vfs_get_file_info_uri( p_uri,
Clément Stenac's avatar
Clément Stenac committed
178
                                                p_sys->p_file_info, 8 );
179

Benjamin Pracht's avatar
Benjamin Pracht committed
180 181
        if( i_ret )
        {
Clément Stenac's avatar
Clément Stenac committed
182
            msg_Warn( p_access, "cannot get file info for uri %s (%s)",
183
                                psz_uri, gnome_vfs_result_to_string( i_ret ) );
184
            gnome_vfs_file_info_unref( p_sys->p_file_info );
Benjamin Pracht's avatar
Benjamin Pracht committed
185 186
            gnome_vfs_uri_unref( p_uri);
            free( p_sys );
187
            g_free( psz_uri );
Benjamin Pracht's avatar
Benjamin Pracht committed
188 189 190 191 192 193
            free( psz_name );
            return VLC_EGENERIC;
        }
    }
    else
    {
194
        msg_Warn( p_access, "cannot parse MRL %s or unsupported protocol", psz_name );
Benjamin Pracht's avatar
Benjamin Pracht committed
195 196 197 198 199 200
        g_free( psz_uri );
        free( p_sys );
        free( psz_name );
        return VLC_EGENERIC;
    }

201
    msg_Dbg( p_access, "opening file `%s'", psz_uri );
202
    i_ret = gnome_vfs_open( &(p_sys->p_handle), psz_uri, 5 );
Benjamin Pracht's avatar
Benjamin Pracht committed
203 204
    if( i_ret )
    {
205
        msg_Warn( p_access, "cannot open file %s: %s", psz_uri,
206 207 208
                                gnome_vfs_result_to_string( i_ret ) );

        gnome_vfs_uri_unref( p_uri);
209
        g_free( psz_uri );
Clément Stenac's avatar
Clément Stenac committed
210
        free( p_sys );
Benjamin Pracht's avatar
Benjamin Pracht committed
211 212 213 214 215 216 217 218 219
        free( psz_name );
        return VLC_EGENERIC;
    }

    if (GNOME_VFS_FILE_INFO_LOCAL( p_sys->p_file_info ))
    {
        p_sys->b_local = VLC_TRUE;
    }

Clément Stenac's avatar
Clément Stenac committed
220
    if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_REGULAR ||
Benjamin Pracht's avatar
Benjamin Pracht committed
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
        p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_CHARACTER_DEVICE ||
        p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_BLOCK_DEVICE )
    {
        p_sys->b_seekable = VLC_TRUE;
        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 )
    {
        p_sys->b_seekable = VLC_FALSE;
    }
    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 */
Clément Stenac's avatar
Clément Stenac committed
241
        msg_Warn( p_access, "file %s is empty, aborting", psz_name );
Benjamin Pracht's avatar
Benjamin Pracht committed
242
        gnome_vfs_file_info_unref( p_sys->p_file_info );
243
        gnome_vfs_uri_unref( p_uri);
Benjamin Pracht's avatar
Benjamin Pracht committed
244
        free( p_sys );
245
        g_free( psz_uri );
Benjamin Pracht's avatar
Benjamin Pracht committed
246 247 248 249 250 251 252 253
        free( psz_name );
        return VLC_EGENERIC;
    }

    /* Update default_pts to a suitable value for file access */
    var_Create( p_access, "gnomevfs-caching",
                                    VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );

254
    g_free( psz_uri );
Benjamin Pracht's avatar
Benjamin Pracht committed
255
    p_sys->psz_name = psz_name;
256
    gnome_vfs_uri_unref( p_uri);
Benjamin Pracht's avatar
Benjamin Pracht committed
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
    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.
 *****************************************************************************/
static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
{
    access_sys_t *p_sys = p_access->p_sys;
    GnomeVFSFileSize i_read_len;
289
    int i_ret;
Benjamin Pracht's avatar
Benjamin Pracht committed
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 315 316 317 318 319 320 321 322 323 324 325

    i_ret = gnome_vfs_read( p_sys->p_handle, p_buffer,
                                  (GnomeVFSFileSize)i_len, &i_read_len );
    if( i_ret )
    {
        p_access->info.b_eof = VLC_TRUE;
        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;

326 327 328 329 330 331
    /* Some Acces (http) never return EOF and loop on the file */
    if( p_access->info.i_pos > p_access->info.i_size )
    {
        p_access->info.b_eof = VLC_TRUE;
        return 0;
    }
Benjamin Pracht's avatar
Benjamin Pracht committed
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
    return (int)i_read_len;
}

/*****************************************************************************
 * Seek: seek to a specific location in a file
 *****************************************************************************/
static int Seek( access_t *p_access, int64_t i_pos )
{
    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 */
    p_access->info.b_eof = VLC_FALSE;

    /* 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;
    vlc_bool_t   *pb_bool;
    int          *pi_int;
    int64_t      *pi_64;

    switch( i_query )
    {
        /* */
        case ACCESS_CAN_SEEK:
        case ACCESS_CAN_FASTSEEK:
            pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
            *pb_bool = p_sys->b_seekable;
            break;

        case ACCESS_CAN_PAUSE:
        case ACCESS_CAN_CONTROL_PACE:
            pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
            *pb_bool = p_sys->b_pace_control;
            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,
                                        "gnomevfs-caching" ) * I64C(1000);
            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:
            return VLC_EGENERIC;

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

    }
    return VLC_SUCCESS;
}