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