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