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