gnomevfs.c 13.4 KB
Newer Older
1
/*****************************************************************************
Christophe Mutricy's avatar
Christophe Mutricy committed
2
 * gnomevfs.c: GnomeVFS input
3
 *****************************************************************************
Christophe Mutricy's avatar
Christophe Mutricy committed
4 5
 * Copyright (C) 2005 the VideoLAN team
 * $Id$
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.
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>
Clément Stenac's avatar
Clément Stenac committed
34 35
#include <vlc_access.h>

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


Clément Stenac's avatar
Clément Stenac committed
39
#include <vlc_charset.h>
40
#include <vlc_url.h>
41 42 43 44 45 46 47 48 49

/*****************************************************************************
 * 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_( \
50
    "Caching value for GnomeVFS streams."\
Clément Stenac's avatar
Clément Stenac committed
51
    "This value should be set in milliseconds." )
52

53 54 55 56 57 58 59 60 61 62
vlc_module_begin ()
    set_description( N_("GnomeVFS input") )
    set_shortname( "GnomeVFS" )
    set_category( CAT_INPUT )
    set_subcategory( SUBCAT_INPUT_ACCESS )
    add_integer( "gnomevfs-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, true )
    set_capability( "access", 10 )
    add_shortcut( "gnomevfs" )
    set_callbacks( Open, Close )
vlc_module_end ()
63 64 65 66 67


/*****************************************************************************
 * Exported prototypes
 *****************************************************************************/
68 69 70
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 );
71 72 73 74 75 76 77 78 79

struct access_sys_t
{
    unsigned int i_nb_reads;
    char *psz_name;

    GnomeVFSHandle *p_handle;
    GnomeVFSFileInfo *p_file_info;

80 81 82
    bool b_local;
    bool b_seekable;
    bool b_pace_control;
83 84
};

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

88 89 90 91 92
/*****************************************************************************
 * Open: open the file
 *****************************************************************************/
static int Open( vlc_object_t *p_this )
{
93 94 95 96 97
    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;
98 99
    char           *psz_unescaped = NULL;
    char           *psz_expand_tilde = NULL;
100 101 102
    GnomeVFSURI    *p_uri = NULL;
    GnomeVFSResult  i_ret;
    GnomeVFSHandle *p_handle = NULL;
103 104 105 106 107
    if( !(gnome_vfs_init()) )
    {
        msg_Warn( p_access, "couldn't initilize GnomeVFS" );
        return VLC_EGENERIC;
    }
108

109 110
    /* FIXME
       Since GnomeVFS segfaults on exit if we initialize it without trying to
111 112
       open a file with a valid protocol, try to open at least file:// */
    gnome_vfs_open( &p_handle, "file://", 5 );
113

114
    STANDARD_READ_ACCESS_INIT;
115 116

    p_sys->p_handle = p_handle;
117
    p_sys->i_nb_reads = 0;
118
    p_sys->b_pace_control = true;
119

120 121
    if( strcmp( "gnomevfs", p_access->psz_access ) &&
                                            *(p_access->psz_access) != '\0')
122
    {
123
        asprintf( &psz_name, "%s://%s", p_access->psz_access,
124
                                                    p_access->psz_path );
125 126 127 128 129
    }
    else
    {
        psz_name = strdup( p_access->psz_path );
    }
130
    psz = ToLocale( psz_name );
131 132 133 134
    psz_expand_tilde = gnome_vfs_expand_initial_tilde( psz );
    LocaleFree( psz );

    psz_unescaped = gnome_vfs_make_uri_from_shell_arg( psz_expand_tilde );
135

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

163 164 165 166 167 168 169
            g_free( psz_escaped_path );
            g_free( psz_unescaped );
        }
        else
        {
            psz_uri = psz_unescaped;
        }
170 171 172 173
    }
    else
    {
        psz_uri = psz_unescaped;
174 175
    }

176
    g_free( psz_expand_tilde );
177 178 179
    p_uri = gnome_vfs_uri_new( psz_uri );
    if( p_uri )
    {
180 181
        p_sys->p_file_info = gnome_vfs_file_info_new();
        i_ret = gnome_vfs_get_file_info_uri( p_uri,
182
                                                p_sys->p_file_info, 8 );
183

184 185
        if( i_ret )
        {
186
            msg_Warn( p_access, "cannot get file info for uri %s (%s)",
187
                                psz_uri, gnome_vfs_result_to_string( i_ret ) );
188
            gnome_vfs_file_info_unref( p_sys->p_file_info );
189 190
            gnome_vfs_uri_unref( p_uri);
            free( p_sys );
191
            free( psz_uri );
192 193 194 195 196 197
            free( psz_name );
            return VLC_EGENERIC;
        }
    }
    else
    {
198
        msg_Warn( p_access, "cannot parse MRL %s or unsupported protocol", psz_name );
199
        free( psz_uri );
200 201 202 203 204
        free( p_sys );
        free( psz_name );
        return VLC_EGENERIC;
    }

205
    msg_Dbg( p_access, "opening file `%s'", psz_uri );
206
    i_ret = gnome_vfs_open( &(p_sys->p_handle), psz_uri, 5 );
207 208
    if( i_ret )
    {
209
        msg_Warn( p_access, "cannot open file %s: %s", psz_uri,
210 211 212
                                gnome_vfs_result_to_string( i_ret ) );

        gnome_vfs_uri_unref( p_uri);
213
        free( psz_uri );
214
        free( p_sys );
215 216 217 218 219 220
        free( psz_name );
        return VLC_EGENERIC;
    }

    if (GNOME_VFS_FILE_INFO_LOCAL( p_sys->p_file_info ))
    {
221
        p_sys->b_local = true;
222 223
    }

224
    if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_REGULAR ||
225 226 227
        p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_CHARACTER_DEVICE ||
        p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_BLOCK_DEVICE )
    {
228
        p_sys->b_seekable = true;
229 230 231 232 233
        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 )
    {
234
        p_sys->b_seekable = false;
235 236 237 238 239 240 241 242 243 244
    }
    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 */
245
        msg_Warn( p_access, "file %s is empty, aborting", psz_name );
246
        gnome_vfs_file_info_unref( p_sys->p_file_info );
247
        gnome_vfs_uri_unref( p_uri);
248
        free( p_sys );
249
        free( psz_uri );
250 251 252 253 254 255 256 257
        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 );

258
    free( psz_uri );
259
    p_sys->psz_name = psz_name;
260
    gnome_vfs_uri_unref( p_uri);
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.
 *****************************************************************************/
289
static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
290 291 292
{
    access_sys_t *p_sys = p_access->p_sys;
    GnomeVFSFileSize i_read_len;
293
    int i_ret;
294 295 296 297 298

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

330 331 332
    /* Some Acces (http) never return EOF and loop on the file */
    if( p_access->info.i_pos > p_access->info.i_size )
    {
333
        p_access->info.b_eof = true;
334 335
        return 0;
    }
336 337 338 339 340 341
    return (int)i_read_len;
}

/*****************************************************************************
 * Seek: seek to a specific location in a file
 *****************************************************************************/
342
static int Seek( access_t *p_access, uint64_t i_pos )
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
{
    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 */
367
    p_access->info.b_eof = false;
368 369 370 371 372 373 374 375 376 377 378

    /* 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;
379
    bool   *pb_bool;
380 381 382 383 384 385 386
    int64_t      *pi_64;

    switch( i_query )
    {
        /* */
        case ACCESS_CAN_SEEK:
        case ACCESS_CAN_FASTSEEK:
387
            pb_bool = (bool*)va_arg( args, bool* );
388 389 390 391 392
            *pb_bool = p_sys->b_seekable;
            break;

        case ACCESS_CAN_PAUSE:
        case ACCESS_CAN_CONTROL_PACE:
393
            pb_bool = (bool*)va_arg( args, bool* );
394 395 396 397 398 399
            *pb_bool = p_sys->b_pace_control;
            break;

        case ACCESS_GET_PTS_DELAY:
            pi_64 = (int64_t*)va_arg( args, int64_t * );
            *pi_64 = var_GetInteger( p_access,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
400
                                        "gnomevfs-caching" ) * INT64_C(1000);
401 402 403 404 405 406 407 408 409 410 411 412
            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:
413
        case ACCESS_GET_CONTENT_TYPE:
414 415 416 417 418 419 420 421 422
            return VLC_EGENERIC;

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

    }
    return VLC_SUCCESS;
}