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>
40 /*****************************************************************************
42 *****************************************************************************/
43 static int Open ( vlc_object_t * );
44 static void Close( vlc_object_t * );
47 set_description( N_("GnomeVFS input") )
48 set_shortname( "GnomeVFS" )
49 set_category( CAT_INPUT )
50 set_subcategory( SUBCAT_INPUT_ACCESS )
51 set_capability( "access", 10 )
52 add_shortcut( "gnomevfs" )
53 set_callbacks( Open, Close )
57 /*****************************************************************************
59 *****************************************************************************/
60 static int Seek( access_t *, uint64_t );
61 static ssize_t Read( access_t *, uint8_t *, size_t );
62 static int Control( access_t *, int, va_list );
66 unsigned int i_nb_reads;
69 GnomeVFSHandle *p_handle;
70 GnomeVFSFileInfo *p_file_info;
77 /* NOTE: we do not handle memory errors in this plugin.
78 * Underlying glib does not, so there is no point in doing it here either. */
80 /*****************************************************************************
82 *****************************************************************************/
83 static int Open( vlc_object_t *p_this )
85 access_t *p_access = (access_t*)p_this;
86 access_sys_t *p_sys = NULL;
87 char *psz_name = NULL;
89 char *psz_unescaped = NULL;
90 char *psz_expand_tilde = NULL;
91 GnomeVFSURI *p_uri = NULL;
93 GnomeVFSHandle *p_handle = NULL;
94 if( !(gnome_vfs_init()) )
96 msg_Warn( p_access, "couldn't initilize GnomeVFS" );
101 Since GnomeVFS segfaults on exit if we initialize it without trying to
102 open a file with a valid protocol, try to open at least file:// */
103 gnome_vfs_open( &p_handle, "file://", 5 );
105 STANDARD_READ_ACCESS_INIT;
107 p_sys->p_handle = p_handle;
108 p_sys->i_nb_reads = 0;
109 p_sys->b_pace_control = true;
111 if( strcmp( "gnomevfs", p_access->psz_access ) &&
112 *(p_access->psz_access) != '\0')
114 asprintf( &psz_name, "%s://%s", p_access->psz_access,
115 p_access->psz_location );
119 psz_name = strdup( p_access->psz_location );
121 psz_expand_tilde = gnome_vfs_expand_initial_tilde( psz_name );
123 psz_unescaped = gnome_vfs_make_uri_from_shell_arg( psz_expand_tilde );
125 /* gnome_vfs_make_uri_from_shell_arg will only escape the uri
126 for relative paths. So we need to use
127 gnome_vfs_escape_host_and_path_string in other cases. */
129 if( !strcmp( psz_unescaped, psz_expand_tilde ) )
131 /* Now we are sure that we have a complete valid unescaped URI beginning
132 with the protocol. We want to escape it. However, gnomevfs's escaping
133 function are broken and will try to escape characters un the username/
134 password field. So parse the URI with vlc_UrlParse ans only escape the
138 char *psz_escaped_path;
139 char *psz_path_begin;
141 vlc_UrlParse( &url, psz_unescaped, 0 );
142 psz_escaped_path = gnome_vfs_escape_path_string( url.psz_path );
144 if( psz_escaped_path )
146 /* Now let's reconstruct a valid URI from all that stuff */
147 psz_path_begin = psz_unescaped + strlen( psz_unescaped )
148 - strlen( url.psz_path );
149 *psz_path_begin = '\0';
150 asprintf( &psz_uri, "%s%s", psz_unescaped, psz_escaped_path );
152 g_free( psz_escaped_path );
153 g_free( psz_unescaped );
157 psz_uri = psz_unescaped;
162 psz_uri = psz_unescaped;
165 g_free( psz_expand_tilde );
166 p_uri = gnome_vfs_uri_new( psz_uri );
169 p_sys->p_file_info = gnome_vfs_file_info_new();
170 i_ret = gnome_vfs_get_file_info_uri( p_uri,
171 p_sys->p_file_info, 8 );
175 msg_Warn( p_access, "cannot get file info for uri %s (%s)",
176 psz_uri, gnome_vfs_result_to_string( i_ret ) );
177 gnome_vfs_file_info_unref( p_sys->p_file_info );
178 gnome_vfs_uri_unref( p_uri);
187 msg_Warn( p_access, "cannot parse MRL %s or unsupported protocol", psz_name );
194 msg_Dbg( p_access, "opening file `%s'", psz_uri );
195 i_ret = gnome_vfs_open( &(p_sys->p_handle), psz_uri, 5 );
198 msg_Warn( p_access, "cannot open file %s: %s", psz_uri,
199 gnome_vfs_result_to_string( i_ret ) );
201 gnome_vfs_uri_unref( p_uri);
208 if (GNOME_VFS_FILE_INFO_LOCAL( p_sys->p_file_info ))
210 p_sys->b_local = true;
213 if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_REGULAR ||
214 p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_CHARACTER_DEVICE ||
215 p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_BLOCK_DEVICE )
217 p_sys->b_seekable = true;
218 p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
220 else if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_FIFO
221 || p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_SOCKET )
223 p_sys->b_seekable = false;
227 msg_Err( p_access, "unknown file type for `%s'", psz_name );
231 if( p_sys->b_seekable && !p_access->info.i_size )
233 /* FIXME that's bad because all others access will be probed */
234 msg_Warn( p_access, "file %s is empty, aborting", psz_name );
235 gnome_vfs_file_info_unref( p_sys->p_file_info );
236 gnome_vfs_uri_unref( p_uri);
244 p_sys->psz_name = psz_name;
245 gnome_vfs_uri_unref( p_uri);
249 /*****************************************************************************
250 * Close: close the target
251 *****************************************************************************/
252 static void Close( vlc_object_t * p_this )
254 access_t *p_access = (access_t*)p_this;
255 access_sys_t *p_sys = p_access->p_sys;
258 i_result = gnome_vfs_close( p_sys->p_handle );
261 msg_Err( p_access, "cannot close %s: %s", p_sys->psz_name,
262 gnome_vfs_result_to_string( i_result ) );
265 gnome_vfs_file_info_unref( p_sys->p_file_info );
267 free( p_sys->psz_name );
271 /*****************************************************************************
272 * Read: standard read on a file descriptor.
273 *****************************************************************************/
274 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
276 access_sys_t *p_sys = p_access->p_sys;
277 GnomeVFSFileSize i_read_len;
280 i_ret = gnome_vfs_read( p_sys->p_handle, p_buffer,
281 (GnomeVFSFileSize)i_len, &i_read_len );
284 p_access->info.b_eof = true;
285 if( i_ret != GNOME_VFS_ERROR_EOF )
287 msg_Err( p_access, "read failed (%s)",
288 gnome_vfs_result_to_string( i_ret ) );
294 if( p_access->info.i_size != 0 &&
295 (p_sys->i_nb_reads % INPUT_FSTAT_NB_READS) == 0 &&
298 gnome_vfs_file_info_clear( p_sys->p_file_info );
299 i_ret = gnome_vfs_get_file_info_from_handle( p_sys->p_handle,
300 p_sys->p_file_info, 8 );
303 msg_Warn( p_access, "couldn't get file properties again (%s)",
304 gnome_vfs_result_to_string( i_ret ) );
308 p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
313 p_access->info.i_pos += (int64_t)i_read_len;
315 /* Some Acces (http) never return EOF and loop on the file */
316 if( p_access->info.i_pos > p_access->info.i_size )
318 p_access->info.b_eof = true;
321 return (int)i_read_len;
324 /*****************************************************************************
325 * Seek: seek to a specific location in a file
326 *****************************************************************************/
327 static int Seek( access_t *p_access, uint64_t i_pos )
329 access_sys_t *p_sys = p_access->p_sys;
332 i_ret = gnome_vfs_seek( p_sys->p_handle, GNOME_VFS_SEEK_START,
333 (GnomeVFSFileOffset)i_pos);
336 p_access->info.i_pos = i_pos;
340 GnomeVFSFileSize i_offset;
341 msg_Err( p_access, "cannot seek (%s)",
342 gnome_vfs_result_to_string( i_ret ) );
343 i_ret = gnome_vfs_tell( p_sys->p_handle, &i_offset );
346 msg_Err( p_access, "cannot tell the current position (%s)",
347 gnome_vfs_result_to_string( i_ret ) );
352 p_access->info.b_eof = false;
358 /*****************************************************************************
360 *****************************************************************************/
361 static int Control( access_t *p_access, int i_query, va_list args )
363 access_sys_t *p_sys = p_access->p_sys;
370 case ACCESS_CAN_SEEK:
371 case ACCESS_CAN_FASTSEEK:
372 pb_bool = (bool*)va_arg( args, bool* );
373 *pb_bool = p_sys->b_seekable;
376 case ACCESS_CAN_PAUSE:
377 case ACCESS_CAN_CONTROL_PACE:
378 pb_bool = (bool*)va_arg( args, bool* );
379 *pb_bool = p_sys->b_pace_control;
382 case ACCESS_GET_PTS_DELAY:
383 pi_64 = (int64_t*)va_arg( args, int64_t * );
384 *pi_64 = DEFAULT_PTS_DELAY; /* FIXME */
388 case ACCESS_SET_PAUSE_STATE:
392 case ACCESS_GET_TITLE_INFO:
393 case ACCESS_SET_TITLE:
394 case ACCESS_SET_SEEKPOINT:
395 case ACCESS_SET_PRIVATE_ID_STATE:
396 case ACCESS_GET_META:
397 case ACCESS_GET_CONTENT_TYPE:
401 msg_Warn( p_access, "unimplemented query in control" );