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