git.sesse.net Git - vlc/blob - modules/access/gnomevfs.c

   1 /*****************************************************************************
   2  * gnomevfs.c: GnomeVFS input
   3  *****************************************************************************
   4  * Copyright (C) 2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Benjamin Pracht <bigben -AT- videolan -DOT- org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <vlc/vlc.h>
  28 #include <vlc_access.h>
  29
  30 #include <libgnomevfs/gnome-vfs.h>
  31
  32 #include <stdlib.h>
  33 #include <string.h>
  34 #include <stdio.h>
  35
  36 #include <vlc_charset.h>
  37 #include "vlc_url.h"
  38
  39 /*****************************************************************************
  40  * Module descriptor
  41  *****************************************************************************/
  42 static int  Open ( vlc_object_t * );
  43 static void Close( vlc_object_t * );
  44
  45 #define CACHING_TEXT N_("Caching value in ms")
  46 #define CACHING_LONGTEXT N_( \
  47     "Caching value for GnomeVFS streams."\
  48     "This value should be set in milliseconds." )
  49
  50 vlc_module_begin();
  51     set_description( _("GnomeVFS input") );
  52     set_shortname( "GnomeVFS" );
  53     set_category( CAT_INPUT );
  54     set_subcategory( SUBCAT_INPUT_ACCESS );
  55     add_integer( "gnomevfs-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
  56     set_capability( "access2", 10 );
  57     add_shortcut( "gnomevfs" );
  58     set_callbacks( Open, Close );
  59 vlc_module_end();
  60
  61
  62 /*****************************************************************************
  63  * Exported prototypes
  64  *****************************************************************************/
  65 static int  Seek( access_t *, int64_t );
  66 static int  Read( access_t *, uint8_t *, int );
  67 static int  Control( access_t *, int, va_list );
  68
  69 struct access_sys_t
  70 {
  71     unsigned int i_nb_reads;
  72     char *psz_name;
  73
  74     GnomeVFSHandle *p_handle;
  75     GnomeVFSFileInfo *p_file_info;
  76
  77     vlc_bool_t b_local;
  78     vlc_bool_t b_seekable;
  79     vlc_bool_t b_pace_control;
  80 };
  81
  82 /*****************************************************************************
  83  * Open: open the file
  84  *****************************************************************************/
  85 static int Open( vlc_object_t *p_this )
  86 {
  87     access_t       *p_access = (access_t*)p_this;
  88     access_sys_t   *p_sys = NULL;
  89     char           *psz_name = NULL;
  90     char           *psz = NULL;
  91     char           *psz_uri = NULL;
  92     char           *psz_unescaped = NULL;
  93     char           *psz_expand_tilde = NULL;
  94     GnomeVFSURI    *p_uri = NULL;
  95     GnomeVFSResult  i_ret;
  96     GnomeVFSHandle *p_handle = NULL;
  97     if( !(gnome_vfs_init()) )
  98     {
  99         msg_Warn( p_access, "couldn't initilize GnomeVFS" );
 100         return VLC_EGENERIC;
 101     }
 102
 103     /* FIXME
 104        Since GnomeVFS segfaults on exit if we initialize it without trying to
 105        open a file with a valid protocol, try to open at least file:// */
 106     gnome_vfs_open( &p_handle, "file://", 5 );
 107
 108     STANDARD_READ_ACCESS_INIT;
 109
 110     p_sys->p_handle = p_handle;
 111     p_sys->i_nb_reads = 0;
 112     p_sys->b_pace_control = VLC_TRUE;
 113
 114     if( strcmp( "gnomevfs", p_access->psz_access ) &&
 115                                             *(p_access->psz_access) != '\0')
 116     {
 117         psz_name = malloc( strlen( p_access->psz_access ) +
 118                                             strlen( p_access->psz_path ) + 4 );
 119         sprintf( psz_name, "%s://%s", p_access->psz_access,
 120                                                     p_access->psz_path );
 121     }
 122     else
 123     {
 124         psz_name = strdup( p_access->psz_path );
 125     }
 126     psz = ToLocale( psz_name );
 127     psz_expand_tilde = gnome_vfs_expand_initial_tilde( psz );
 128     LocaleFree( psz );
 129
 130     psz_unescaped = gnome_vfs_make_uri_from_shell_arg( psz_expand_tilde );
 131
 132    /* gnome_vfs_make_uri_from_shell_arg will only escape the uri
 133       for relative paths. So we need to use
 134       gnome_vfs_escape_host_and_path_string in other cases. */
 135
 136     if( !strcmp( psz_unescaped, psz_expand_tilde ) )
 137     {
 138     /* Now we are sure that we have a complete valid unescaped URI beginning
 139        with the protocol. We want to escape it. However, gnomevfs's escaping
 140        function are broken and will try to escape characters un the username/
 141        password field. So parse the URI with vlc_UrlParse ans only escape the
 142        path */
 143
 144         vlc_url_t url;
 145         char *psz_escaped_path;
 146         char *psz_path_begin;
 147
 148         vlc_UrlParse( &url, psz_unescaped, 0 );
 149         psz_escaped_path = gnome_vfs_escape_path_string( url.psz_path );
 150
 151         if( psz_escaped_path )
 152         {
 153     /* Now let's reconstruct a valid URI from all that stuff */
 154             psz_path_begin = psz_unescaped + strlen( psz_unescaped )
 155                                            - strlen( url.psz_path );
 156             *psz_path_begin = '\0';
 157             psz_uri = malloc( strlen( psz_unescaped ) +
 158                                         strlen( psz_escaped_path ) + 1 );
 159             sprintf( psz_uri, "%s%s",psz_unescaped, psz_escaped_path );
 160
 161             g_free( psz_escaped_path );
 162             g_free( psz_unescaped );
 163         }
 164         else
 165         {
 166             psz_uri = psz_unescaped;
 167         }
 168     }
 169     else
 170     {
 171         psz_uri = psz_unescaped;
 172     }
 173
 174     g_free( psz_expand_tilde );
 175     p_uri = gnome_vfs_uri_new( psz_uri );
 176     if( p_uri )
 177     {
 178         p_sys->p_file_info = gnome_vfs_file_info_new();
 179         i_ret = gnome_vfs_get_file_info_uri( p_uri,
 180                                                 p_sys->p_file_info, 8 );
 181
 182         if( i_ret )
 183         {
 184             msg_Warn( p_access, "cannot get file info for uri %s (%s)",
 185                                 psz_uri, gnome_vfs_result_to_string( i_ret ) );
 186             gnome_vfs_file_info_unref( p_sys->p_file_info );
 187             gnome_vfs_uri_unref( p_uri);
 188             free( p_sys );
 189             g_free( psz_uri );
 190             free( psz_name );
 191             return VLC_EGENERIC;
 192         }
 193     }
 194     else
 195     {
 196         msg_Warn( p_access, "cannot parse MRL %s or unsupported protocol", psz_name );
 197         g_free( psz_uri );
 198         free( p_sys );
 199         free( psz_name );
 200         return VLC_EGENERIC;
 201     }
 202
 203     msg_Dbg( p_access, "opening file `%s'", psz_uri );
 204     i_ret = gnome_vfs_open( &(p_sys->p_handle), psz_uri, 5 );
 205     if( i_ret )
 206     {
 207         msg_Warn( p_access, "cannot open file %s: %s", psz_uri,
 208                                 gnome_vfs_result_to_string( i_ret ) );
 209
 210         gnome_vfs_uri_unref( p_uri);
 211         g_free( psz_uri );
 212         free( p_sys );
 213         free( psz_name );
 214         return VLC_EGENERIC;
 215     }
 216
 217     if (GNOME_VFS_FILE_INFO_LOCAL( p_sys->p_file_info ))
 218     {
 219         p_sys->b_local = VLC_TRUE;
 220     }
 221
 222     if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_REGULAR ||
 223         p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_CHARACTER_DEVICE ||
 224         p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_BLOCK_DEVICE )
 225     {
 226         p_sys->b_seekable = VLC_TRUE;
 227         p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
 228     }
 229     else if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_FIFO
 230               || p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_SOCKET )
 231     {
 232         p_sys->b_seekable = VLC_FALSE;
 233     }
 234     else
 235     {
 236         msg_Err( p_access, "unknown file type for `%s'", psz_name );
 237         return VLC_EGENERIC;
 238     }
 239
 240     if( p_sys->b_seekable && !p_access->info.i_size )
 241     {
 242         /* FIXME that's bad because all others access will be probed */
 243         msg_Warn( p_access, "file %s is empty, aborting", psz_name );
 244         gnome_vfs_file_info_unref( p_sys->p_file_info );
 245         gnome_vfs_uri_unref( p_uri);
 246         free( p_sys );
 247         g_free( psz_uri );
 248         free( psz_name );
 249         return VLC_EGENERIC;
 250     }
 251
 252     /* Update default_pts to a suitable value for file access */
 253     var_Create( p_access, "gnomevfs-caching",
 254                                     VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 255
 256     g_free( psz_uri );
 257     p_sys->psz_name = psz_name;
 258     gnome_vfs_uri_unref( p_uri);
 259     return VLC_SUCCESS;
 260 }
 261
 262 /*****************************************************************************
 263  * Close: close the target
 264  *****************************************************************************/
 265 static void Close( vlc_object_t * p_this )
 266 {
 267     access_t     *p_access = (access_t*)p_this;
 268     access_sys_t *p_sys = p_access->p_sys;
 269     int i_result;
 270
 271     i_result = gnome_vfs_close( p_sys->p_handle );
 272     if( i_result )
 273     {
 274          msg_Err( p_access, "cannot close %s: %s", p_sys->psz_name,
 275                                 gnome_vfs_result_to_string( i_result ) );
 276     }
 277
 278     gnome_vfs_file_info_unref( p_sys->p_file_info );
 279
 280     free( p_sys->psz_name );
 281     free( p_sys );
 282 }
 283
 284 /*****************************************************************************
 285  * Read: standard read on a file descriptor.
 286  *****************************************************************************/
 287 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
 288 {
 289     access_sys_t *p_sys = p_access->p_sys;
 290     GnomeVFSFileSize i_read_len;
 291     int i_ret;
 292
 293     i_ret = gnome_vfs_read( p_sys->p_handle, p_buffer,
 294                                   (GnomeVFSFileSize)i_len, &i_read_len );
 295     if( i_ret )
 296     {
 297         p_access->info.b_eof = VLC_TRUE;
 298         if( i_ret != GNOME_VFS_ERROR_EOF )
 299         {
 300             msg_Err( p_access, "read failed (%s)",
 301                                     gnome_vfs_result_to_string( i_ret ) );
 302         }
 303     }
 304     else
 305     {
 306         p_sys->i_nb_reads++;
 307         if( p_access->info.i_size != 0 &&
 308             (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 &&
 309             p_sys->b_local )
 310         {
 311             gnome_vfs_file_info_clear( p_sys->p_file_info );
 312             i_ret = gnome_vfs_get_file_info_from_handle( p_sys->p_handle,
 313                                                 p_sys->p_file_info, 8 );
 314             if( i_ret )
 315             {
 316                 msg_Warn( p_access, "couldn't get file properties again (%s)",
 317                                         gnome_vfs_result_to_string( i_ret ) );
 318             }
 319             else
 320             {
 321                 p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
 322             }
 323         }
 324     }
 325
 326     p_access->info.i_pos += (int64_t)i_read_len;
 327
 328     /* Some Acces (http) never return EOF and loop on the file */
 329     if( p_access->info.i_pos > p_access->info.i_size )
 330     {
 331         p_access->info.b_eof = VLC_TRUE;
 332         return 0;
 333     }
 334     return (int)i_read_len;
 335 }
 336
 337 /*****************************************************************************
 338  * Seek: seek to a specific location in a file
 339  *****************************************************************************/
 340 static int Seek( access_t *p_access, int64_t i_pos )
 341 {
 342     access_sys_t *p_sys = p_access->p_sys;
 343     int i_ret;
 344
 345     i_ret = gnome_vfs_seek( p_sys->p_handle, GNOME_VFS_SEEK_START,
 346                                             (GnomeVFSFileOffset)i_pos);
 347     if ( !i_ret )
 348     {
 349         p_access->info.i_pos = i_pos;
 350     }
 351     else
 352     {
 353         GnomeVFSFileSize i_offset;
 354         msg_Err( p_access, "cannot seek (%s)",
 355                                         gnome_vfs_result_to_string( i_ret ) );
 356         i_ret = gnome_vfs_tell( p_sys->p_handle, &i_offset );
 357         if( !i_ret )
 358         {
 359             msg_Err( p_access, "cannot tell the current position (%s)",
 360                                         gnome_vfs_result_to_string( i_ret ) );
 361             return VLC_EGENERIC;
 362         }
 363     }
 364     /* Reset eof */
 365     p_access->info.b_eof = VLC_FALSE;
 366
 367     /* FIXME */
 368     return VLC_SUCCESS;
 369 }
 370
 371 /*****************************************************************************
 372  * Control:
 373  *****************************************************************************/
 374 static int Control( access_t *p_access, int i_query, va_list args )
 375 {
 376     access_sys_t *p_sys = p_access->p_sys;
 377     vlc_bool_t   *pb_bool;
 378     int          *pi_int;
 379     int64_t      *pi_64;
 380
 381     switch( i_query )
 382     {
 383         /* */
 384         case ACCESS_CAN_SEEK:
 385         case ACCESS_CAN_FASTSEEK:
 386             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 387             *pb_bool = p_sys->b_seekable;
 388             break;
 389
 390         case ACCESS_CAN_PAUSE:
 391         case ACCESS_CAN_CONTROL_PACE:
 392             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 393             *pb_bool = p_sys->b_pace_control;
 394             break;
 395
 396         /* */
 397         case ACCESS_GET_MTU:
 398             pi_int = (int*)va_arg( args, int * );
 399             *pi_int = 0;
 400             break;
 401
 402         case ACCESS_GET_PTS_DELAY:
 403             pi_64 = (int64_t*)va_arg( args, int64_t * );
 404             *pi_64 = var_GetInteger( p_access,
 405                                         "gnomevfs-caching" ) * I64C(1000);
 406             break;
 407
 408         /* */
 409         case ACCESS_SET_PAUSE_STATE:
 410             /* Nothing to do */
 411             break;
 412
 413         case ACCESS_GET_TITLE_INFO:
 414         case ACCESS_SET_TITLE:
 415         case ACCESS_SET_SEEKPOINT:
 416         case ACCESS_SET_PRIVATE_ID_STATE:
 417         case ACCESS_GET_META:
 418             return VLC_EGENERIC;
 419
 420         default:
 421             msg_Warn( p_access, "unimplemented query in control" );
 422             return VLC_EGENERIC;
 423
 424     }
 425     return VLC_SUCCESS;
 426 }