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