1 /*****************************************************************************
2 * gnomevfs.c: GnomeVFS input
3 *****************************************************************************
4 * Copyright (C) 2005 the VideoLAN team
7 * Authors: Benjamin Pracht <bigben -AT- videolan -DOT- org>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_access.h>
36 #include <libgnomevfs/gnome-vfs.h>
39 #include <vlc_charset.h>
42 /*****************************************************************************
44 *****************************************************************************/
45 static int Open ( vlc_object_t * );
46 static void Close( vlc_object_t * );
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 )
59 /*****************************************************************************
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 );
68 unsigned int i_nb_reads;
71 GnomeVFSHandle *p_handle;
72 GnomeVFSFileInfo *p_file_info;
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. */
82 /*****************************************************************************
84 *****************************************************************************/
85 static int Open( vlc_object_t *p_this )
87 access_t *p_access = (access_t*)p_this;
88 access_sys_t *p_sys = NULL;
89 char *psz_name = NULL;
92 char *psz_unescaped = NULL;
93 char *psz_expand_tilde = NULL;
94 GnomeVFSURI *p_uri = NULL;
96 GnomeVFSHandle *p_handle = NULL;
97 if( !(gnome_vfs_init()) )
99 msg_Warn( p_access, "couldn't initilize GnomeVFS" );
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 );
108 STANDARD_READ_ACCESS_INIT;
110 p_sys->p_handle = p_handle;
111 p_sys->i_nb_reads = 0;
112 p_sys->b_pace_control = true;
114 if( strcmp( "gnomevfs", p_access->psz_access ) &&
115 *(p_access->psz_access) != '\0')
117 asprintf( &psz_name, "%s://%s", p_access->psz_access,
118 p_access->psz_location );
122 psz_name = strdup( p_access->psz_location );
124 psz = ToLocale( psz_name );
125 psz_expand_tilde = gnome_vfs_expand_initial_tilde( psz );
128 psz_unescaped = gnome_vfs_make_uri_from_shell_arg( psz_expand_tilde );
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. */
134 if( !strcmp( psz_unescaped, psz_expand_tilde ) )
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
143 char *psz_escaped_path;
144 char *psz_path_begin;
146 vlc_UrlParse( &url, psz_unescaped, 0 );
147 psz_escaped_path = gnome_vfs_escape_path_string( url.psz_path );
149 if( psz_escaped_path )
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 );
157 g_free( psz_escaped_path );
158 g_free( psz_unescaped );
162 psz_uri = psz_unescaped;
167 psz_uri = psz_unescaped;
170 g_free( psz_expand_tilde );
171 p_uri = gnome_vfs_uri_new( psz_uri );
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 );
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);
192 msg_Warn( p_access, "cannot parse MRL %s or unsupported protocol", psz_name );
199 msg_Dbg( p_access, "opening file `%s'", psz_uri );
200 i_ret = gnome_vfs_open( &(p_sys->p_handle), psz_uri, 5 );
203 msg_Warn( p_access, "cannot open file %s: %s", psz_uri,
204 gnome_vfs_result_to_string( i_ret ) );
206 gnome_vfs_uri_unref( p_uri);
213 if (GNOME_VFS_FILE_INFO_LOCAL( p_sys->p_file_info ))
215 p_sys->b_local = true;
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 )
222 p_sys->b_seekable = true;
223 p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
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 )
228 p_sys->b_seekable = false;
232 msg_Err( p_access, "unknown file type for `%s'", psz_name );
236 if( p_sys->b_seekable && !p_access->info.i_size )
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);
249 p_sys->psz_name = psz_name;
250 gnome_vfs_uri_unref( p_uri);
254 /*****************************************************************************
255 * Close: close the target
256 *****************************************************************************/
257 static void Close( vlc_object_t * p_this )
259 access_t *p_access = (access_t*)p_this;
260 access_sys_t *p_sys = p_access->p_sys;
263 i_result = gnome_vfs_close( p_sys->p_handle );
266 msg_Err( p_access, "cannot close %s: %s", p_sys->psz_name,
267 gnome_vfs_result_to_string( i_result ) );
270 gnome_vfs_file_info_unref( p_sys->p_file_info );
272 free( p_sys->psz_name );
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 )
281 access_sys_t *p_sys = p_access->p_sys;
282 GnomeVFSFileSize i_read_len;
285 i_ret = gnome_vfs_read( p_sys->p_handle, p_buffer,
286 (GnomeVFSFileSize)i_len, &i_read_len );
289 p_access->info.b_eof = true;
290 if( i_ret != GNOME_VFS_ERROR_EOF )
292 msg_Err( p_access, "read failed (%s)",
293 gnome_vfs_result_to_string( i_ret ) );
299 if( p_access->info.i_size != 0 &&
300 (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 &&
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 );
308 msg_Warn( p_access, "couldn't get file properties again (%s)",
309 gnome_vfs_result_to_string( i_ret ) );
313 p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
318 p_access->info.i_pos += (int64_t)i_read_len;
320 /* Some Acces (http) never return EOF and loop on the file */
321 if( p_access->info.i_pos > p_access->info.i_size )
323 p_access->info.b_eof = true;
326 return (int)i_read_len;
329 /*****************************************************************************
330 * Seek: seek to a specific location in a file
331 *****************************************************************************/
332 static int Seek( access_t *p_access, uint64_t i_pos )
334 access_sys_t *p_sys = p_access->p_sys;
337 i_ret = gnome_vfs_seek( p_sys->p_handle, GNOME_VFS_SEEK_START,
338 (GnomeVFSFileOffset)i_pos);
341 p_access->info.i_pos = i_pos;
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 );
351 msg_Err( p_access, "cannot tell the current position (%s)",
352 gnome_vfs_result_to_string( i_ret ) );
357 p_access->info.b_eof = false;
363 /*****************************************************************************
365 *****************************************************************************/
366 static int Control( access_t *p_access, int i_query, va_list args )
368 access_sys_t *p_sys = p_access->p_sys;
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;
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;
387 case ACCESS_GET_PTS_DELAY:
388 pi_64 = (int64_t*)va_arg( args, int64_t * );
389 *pi_64 = DEFAULT_PTS_DELAY; /* FIXME */
393 case ACCESS_SET_PAUSE_STATE:
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:
406 msg_Warn( p_access, "unimplemented query in control" );