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
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <vlc_common.h>
  33 #include <vlc_plugin.h>
  34 #include <vlc_access.h>
  35
  36 #include <libgnomevfs/gnome-vfs.h>
  37
  38
  39 #include <vlc_charset.h>
  40 #include <vlc_url.h>
  41
  42 /*****************************************************************************
  43  * Module descriptor
  44  *****************************************************************************/
  45 static int  Open ( vlc_object_t * );
  46 static void Close( vlc_object_t * );
  47
  48 vlc_module_begin ()
  49     set_description( N_("GnomeVFS input") )
  50     set_shortname( "GnomeVFS" )
  51     set_category( CAT_INPUT )
  52     set_subcategory( SUBCAT_INPUT_ACCESS )
  53     set_capability( "access", 10 )
  54     add_shortcut( "gnomevfs" )
  55     set_callbacks( Open, Close )
  56 vlc_module_end ()
  57
  58
  59 /*****************************************************************************
  60  * Exported prototypes
  61  *****************************************************************************/
  62 static int     Seek( access_t *, uint64_t );
  63 static ssize_t Read( access_t *, uint8_t *, size_t );
  64 static int     Control( access_t *, int, va_list );
  65
  66 struct access_sys_t
  67 {
  68     unsigned int i_nb_reads;
  69     char *psz_name;
  70
  71     GnomeVFSHandle *p_handle;
  72     GnomeVFSFileInfo *p_file_info;
  73
  74     bool b_local;
  75     bool b_seekable;
  76     bool b_pace_control;
  77 };
  78
  79 /* NOTE: we do not handle memory errors in this plugin.
  80  * Underlying glib does not, so there is no point in doing it here either. */
  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 = true;
 113
 114     if( strcmp( "gnomevfs", p_access->psz_access ) &&
 115                                             *(p_access->psz_access) != '\0')
 116     {
 117         asprintf( &psz_name, "%s://%s", p_access->psz_access,
 118                   p_access->psz_location );
 119     }
 120     else
 121     {
 122         psz_name = strdup( p_access->psz_location );
 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             asprintf( &psz_uri, "%s%s", psz_unescaped, psz_escaped_path );
 156
 157             g_free( psz_escaped_path );
 158             g_free( psz_unescaped );
 159         }
 160         else
 161         {
 162             psz_uri = psz_unescaped;
 163         }
 164     }
 165     else
 166     {
 167         psz_uri = psz_unescaped;
 168     }
 169
 170     g_free( psz_expand_tilde );
 171     p_uri = gnome_vfs_uri_new( psz_uri );
 172     if( p_uri )
 173     {
 174         p_sys->p_file_info = gnome_vfs_file_info_new();
 175         i_ret = gnome_vfs_get_file_info_uri( p_uri,
 176                                                 p_sys->p_file_info, 8 );
 177
 178         if( i_ret )
 179         {
 180             msg_Warn( p_access, "cannot get file info for uri %s (%s)",
 181                                 psz_uri, gnome_vfs_result_to_string( i_ret ) );
 182             gnome_vfs_file_info_unref( p_sys->p_file_info );
 183             gnome_vfs_uri_unref( p_uri);
 184             free( p_sys );
 185             free( psz_uri );
 186             free( psz_name );
 187             return VLC_EGENERIC;
 188         }
 189     }
 190     else
 191     {
 192         msg_Warn( p_access, "cannot parse MRL %s or unsupported protocol", psz_name );
 193         free( psz_uri );
 194         free( p_sys );
 195         free( psz_name );
 196         return VLC_EGENERIC;
 197     }
 198
 199     msg_Dbg( p_access, "opening file `%s'", psz_uri );
 200     i_ret = gnome_vfs_open( &(p_sys->p_handle), psz_uri, 5 );
 201     if( i_ret )
 202     {
 203         msg_Warn( p_access, "cannot open file %s: %s", psz_uri,
 204                                 gnome_vfs_result_to_string( i_ret ) );
 205
 206         gnome_vfs_uri_unref( p_uri);
 207         free( psz_uri );
 208         free( p_sys );
 209         free( psz_name );
 210         return VLC_EGENERIC;
 211     }
 212
 213     if (GNOME_VFS_FILE_INFO_LOCAL( p_sys->p_file_info ))
 214     {
 215         p_sys->b_local = true;
 216     }
 217
 218     if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_REGULAR ||
 219         p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_CHARACTER_DEVICE ||
 220         p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_BLOCK_DEVICE )
 221     {
 222         p_sys->b_seekable = true;
 223         p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
 224     }
 225     else if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_FIFO
 226               || p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_SOCKET )
 227     {
 228         p_sys->b_seekable = false;
 229     }
 230     else
 231     {
 232         msg_Err( p_access, "unknown file type for `%s'", psz_name );
 233         return VLC_EGENERIC;
 234     }
 235
 236     if( p_sys->b_seekable && !p_access->info.i_size )
 237     {
 238         /* FIXME that's bad because all others access will be probed */
 239         msg_Warn( p_access, "file %s is empty, aborting", psz_name );
 240         gnome_vfs_file_info_unref( p_sys->p_file_info );
 241         gnome_vfs_uri_unref( p_uri);
 242         free( p_sys );
 243         free( psz_uri );
 244         free( psz_name );
 245         return VLC_EGENERIC;
 246     }
 247
 248     free( psz_uri );
 249     p_sys->psz_name = psz_name;
 250     gnome_vfs_uri_unref( p_uri);
 251     return VLC_SUCCESS;
 252 }
 253
 254 /*****************************************************************************
 255  * Close: close the target
 256  *****************************************************************************/
 257 static void Close( vlc_object_t * p_this )
 258 {
 259     access_t     *p_access = (access_t*)p_this;
 260     access_sys_t *p_sys = p_access->p_sys;
 261     int i_result;
 262
 263     i_result = gnome_vfs_close( p_sys->p_handle );
 264     if( i_result )
 265     {
 266          msg_Err( p_access, "cannot close %s: %s", p_sys->psz_name,
 267                                 gnome_vfs_result_to_string( i_result ) );
 268     }
 269
 270     gnome_vfs_file_info_unref( p_sys->p_file_info );
 271
 272     free( p_sys->psz_name );
 273     free( p_sys );
 274 }
 275
 276 /*****************************************************************************
 277  * Read: standard read on a file descriptor.
 278  *****************************************************************************/
 279 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
 280 {
 281     access_sys_t *p_sys = p_access->p_sys;
 282     GnomeVFSFileSize i_read_len;
 283     int i_ret;
 284
 285     i_ret = gnome_vfs_read( p_sys->p_handle, p_buffer,
 286                                   (GnomeVFSFileSize)i_len, &i_read_len );
 287     if( i_ret )
 288     {
 289         p_access->info.b_eof = true;
 290         if( i_ret != GNOME_VFS_ERROR_EOF )
 291         {
 292             msg_Err( p_access, "read failed (%s)",
 293                                     gnome_vfs_result_to_string( i_ret ) );
 294         }
 295     }
 296     else
 297     {
 298         p_sys->i_nb_reads++;
 299         if( p_access->info.i_size != 0 &&
 300             (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 &&
 301             p_sys->b_local )
 302         {
 303             gnome_vfs_file_info_clear( p_sys->p_file_info );
 304             i_ret = gnome_vfs_get_file_info_from_handle( p_sys->p_handle,
 305                                                 p_sys->p_file_info, 8 );
 306             if( i_ret )
 307             {
 308                 msg_Warn( p_access, "couldn't get file properties again (%s)",
 309                                         gnome_vfs_result_to_string( i_ret ) );
 310             }
 311             else
 312             {
 313                 p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
 314             }
 315         }
 316     }
 317
 318     p_access->info.i_pos += (int64_t)i_read_len;
 319
 320     /* Some Acces (http) never return EOF and loop on the file */
 321     if( p_access->info.i_pos > p_access->info.i_size )
 322     {
 323         p_access->info.b_eof = true;
 324         return 0;
 325     }
 326     return (int)i_read_len;
 327 }
 328
 329 /*****************************************************************************
 330  * Seek: seek to a specific location in a file
 331  *****************************************************************************/
 332 static int Seek( access_t *p_access, uint64_t i_pos )
 333 {
 334     access_sys_t *p_sys = p_access->p_sys;
 335     int i_ret;
 336
 337     i_ret = gnome_vfs_seek( p_sys->p_handle, GNOME_VFS_SEEK_START,
 338                                             (GnomeVFSFileOffset)i_pos);
 339     if ( !i_ret )
 340     {
 341         p_access->info.i_pos = i_pos;
 342     }
 343     else
 344     {
 345         GnomeVFSFileSize i_offset;
 346         msg_Err( p_access, "cannot seek (%s)",
 347                                         gnome_vfs_result_to_string( i_ret ) );
 348         i_ret = gnome_vfs_tell( p_sys->p_handle, &i_offset );
 349         if( !i_ret )
 350         {
 351             msg_Err( p_access, "cannot tell the current position (%s)",
 352                                         gnome_vfs_result_to_string( i_ret ) );
 353             return VLC_EGENERIC;
 354         }
 355     }
 356     /* Reset eof */
 357     p_access->info.b_eof = false;
 358
 359     /* FIXME */
 360     return VLC_SUCCESS;
 361 }
 362
 363 /*****************************************************************************
 364  * Control:
 365  *****************************************************************************/
 366 static int Control( access_t *p_access, int i_query, va_list args )
 367 {
 368     access_sys_t *p_sys = p_access->p_sys;
 369     bool   *pb_bool;
 370     int64_t      *pi_64;
 371
 372     switch( i_query )
 373     {
 374         /* */
 375         case ACCESS_CAN_SEEK:
 376         case ACCESS_CAN_FASTSEEK:
 377             pb_bool = (bool*)va_arg( args, bool* );
 378             *pb_bool = p_sys->b_seekable;
 379             break;
 380
 381         case ACCESS_CAN_PAUSE:
 382         case ACCESS_CAN_CONTROL_PACE:
 383             pb_bool = (bool*)va_arg( args, bool* );
 384             *pb_bool = p_sys->b_pace_control;
 385             break;
 386
 387         case ACCESS_GET_PTS_DELAY:
 388             pi_64 = (int64_t*)va_arg( args, int64_t * );
 389             *pi_64 = DEFAULT_PTS_DELAY; /* FIXME */
 390             break;
 391
 392         /* */
 393         case ACCESS_SET_PAUSE_STATE:
 394             /* Nothing to do */
 395             break;
 396
 397         case ACCESS_GET_TITLE_INFO:
 398         case ACCESS_SET_TITLE:
 399         case ACCESS_SET_SEEKPOINT:
 400         case ACCESS_SET_PRIVATE_ID_STATE:
 401         case ACCESS_GET_META:
 402         case ACCESS_GET_CONTENT_TYPE:
 403             return VLC_EGENERIC;
 404
 405         default:
 406             msg_Warn( p_access, "unimplemented query in control" );
 407             return VLC_EGENERIC;
 408
 409     }
 410     return VLC_SUCCESS;
 411 }