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