]> git.sesse.net Git - vlc/blobdiff - modules/access/gnomevfs.c
Use var_Inherit* instead of var_CreateGet*.
[vlc] / modules / access / gnomevfs.c
index 9ce36a9dbb63933a78fe838619bf3c1f98323016..d39d54d36e6457ea31915dc3d113948655c8735d 100644 (file)
  *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /*****************************************************************************
  * Preamble
  *****************************************************************************/
-#include <vlc/vlc.h>
-#include <vlc/input.h>
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+#include <vlc_plugin.h>
+#include <vlc_access.h>
+
 #include <libgnomevfs/gnome-vfs.h>
 
-#include <stdlib.h>
-#include <string.h>
-#include <stdio.h>
 
-#include "charset.h"
+#include <vlc_charset.h>
+#include <vlc_url.h>
 
 /*****************************************************************************
  * Module descriptor
@@ -42,27 +47,27 @@ static void Close( vlc_object_t * );
 
 #define CACHING_TEXT N_("Caching value in ms")
 #define CACHING_LONGTEXT N_( \
-    "Allows you to modify the default caching value for GnomeVFS streams."\
-    "This value should be set in millisecond units." )
+    "Caching value for GnomeVFS streams."\
+    "This value should be set in milliseconds." )
 
-vlc_module_begin();
-    set_description( _("GnomeVFS filesystem file input") );
-    set_shortname( _("GnomeVFS") );
-    set_category( CAT_INPUT );
-    set_subcategory( SUBCAT_INPUT_ACCESS );
-    add_integer( "gnomevfs-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
-    set_capability( "access2", 10 );
-    add_shortcut( "gnomevfs" );
-    set_callbacks( Open, Close );
-vlc_module_end();
+vlc_module_begin ()
+    set_description( N_("GnomeVFS input") )
+    set_shortname( "GnomeVFS" )
+    set_category( CAT_INPUT )
+    set_subcategory( SUBCAT_INPUT_ACCESS )
+    add_integer( "gnomevfs-caching", DEFAULT_PTS_DELAY / 1000, NULL, CACHING_TEXT, CACHING_LONGTEXT, true )
+    set_capability( "access", 10 )
+    add_shortcut( "gnomevfs" )
+    set_callbacks( Open, Close )
+vlc_module_end ()
 
 
 /*****************************************************************************
  * Exported prototypes
  *****************************************************************************/
-static int  Seek( access_t *, int64_t );
-static int  Read( access_t *, uint8_t *, int );
-static int  Control( access_t *, int, va_list );
+static int     Seek( access_t *, uint64_t );
+static ssize_t Read( access_t *, uint8_t *, size_t );
+static int     Control( access_t *, int, va_list );
 
 struct access_sys_t
 {
@@ -72,87 +77,114 @@ struct access_sys_t
     GnomeVFSHandle *p_handle;
     GnomeVFSFileInfo *p_file_info;
 
-    vlc_bool_t b_local;
-    vlc_bool_t b_seekable;
-    vlc_bool_t b_pace_control;
+    bool b_local;
+    bool b_seekable;
+    bool b_pace_control;
 };
 
+/* NOTE: we do not handle memory errors in this plugin.
+ * Underlying glib does not, so there is no point in doing it here either. */
+
 /*****************************************************************************
  * Open: open the file
  *****************************************************************************/
 static int Open( vlc_object_t *p_this )
 {
-    access_t     *p_access = (access_t*)p_this;
-    access_sys_t *p_sys;
-    char *psz_name;
-    char *psz, *psz_uri;
-    GnomeVFSURI         *p_uri;
-    GnomeVFSResult      i_ret;
-
+    access_t       *p_access = (access_t*)p_this;
+    access_sys_t   *p_sys = NULL;
+    char           *psz_name = NULL;
+    char           *psz = NULL;
+    char           *psz_uri = NULL;
+    char           *psz_unescaped = NULL;
+    char           *psz_expand_tilde = NULL;
+    GnomeVFSURI    *p_uri = NULL;
+    GnomeVFSResult  i_ret;
+    GnomeVFSHandle *p_handle = NULL;
     if( !(gnome_vfs_init()) )
     {
         msg_Warn( p_access, "couldn't initilize GnomeVFS" );
         return VLC_EGENERIC;
     }
+
     /* FIXME
        Since GnomeVFS segfaults on exit if we initialize it without trying to
-       open a file with a valid protocol, try top open at least file:// */
-    gnome_vfs_open( &(p_sys->p_handle), "file://", 5 );
-
-    p_access->pf_read = Read;
-    p_access->pf_block = NULL;
-    p_access->pf_seek = Seek;
-    p_access->pf_control = Control;
-    p_access->info.i_update = 0;
-    p_access->info.i_size = 0;
-    p_access->info.i_pos = 0;
-    p_access->info.b_eof = VLC_FALSE;
-    p_access->info.i_title = 0;
-    p_access->info.i_seekpoint = 0;
-    p_access->p_sys = p_sys = malloc( sizeof( access_sys_t ) );
-    p_sys->i_nb_reads = 0;
-    p_sys->b_pace_control = VLC_TRUE;
+       open a file with a valid protocol, try to open at least file:// */
+    gnome_vfs_open( &p_handle, "file://", 5 );
 
+    STANDARD_READ_ACCESS_INIT;
+
+    p_sys->p_handle = p_handle;
+    p_sys->i_nb_reads = 0;
+    p_sys->b_pace_control = true;
 
     if( strcmp( "gnomevfs", p_access->psz_access ) &&
                                             *(p_access->psz_access) != '\0')
     {
-        psz_name = malloc( strlen( p_access->psz_access ) +
-                                            strlen( p_access->psz_path ) + 3 );
-        strcpy( psz_name, p_access->psz_access );
-        strcat( psz_name, "://" );
-        strcat( psz_name, p_access->psz_path );
+        asprintf( &psz_name, "%s://%s", p_access->psz_access,
+                  p_access->psz_location );
     }
     else
     {
-        psz_name = strdup( p_access->psz_path );
+        psz_name = strdup( p_access->psz_location );
     }
-
     psz = ToLocale( psz_name );
+    psz_expand_tilde = gnome_vfs_expand_initial_tilde( psz );
+    LocaleFree( psz );
+
+    psz_unescaped = gnome_vfs_make_uri_from_shell_arg( psz_expand_tilde );
 
-    /* Use gnome_vfs_make_uri_from_input_with_dirs for local paths, as it deals
-       relative directories, and gnome_vfs_make_uri_from_input_with_dirs
-       otherwise */
-    psz_uri = gnome_vfs_make_uri_from_input_with_dirs( psz,
-                                    GNOME_VFS_MAKE_URI_DIR_CURRENT);
-    if( *psz_uri != '/' )
+   /* gnome_vfs_make_uri_from_shell_arg will only escape the uri
+      for relative paths. So we need to use
+      gnome_vfs_escape_host_and_path_string in other cases. */
+
+    if( !strcmp( psz_unescaped, psz_expand_tilde ) )
     {
-        g_free( psz_uri );
-        psz_uri = gnome_vfs_escape_host_and_path_string( psz );
+    /* Now we are sure that we have a complete valid unescaped URI beginning
+       with the protocol. We want to escape it. However, gnomevfs's escaping
+       function are broken and will try to escape characters un the username/
+       password field. So parse the URI with vlc_UrlParse ans only escape the
+       path */
+
+        vlc_url_t url;
+        char *psz_escaped_path;
+        char *psz_path_begin;
+
+        vlc_UrlParse( &url, psz_unescaped, 0 );
+        psz_escaped_path = gnome_vfs_escape_path_string( url.psz_path );
+
+        if( psz_escaped_path )
+        {
+    /* Now let's reconstruct a valid URI from all that stuff */
+            psz_path_begin = psz_unescaped + strlen( psz_unescaped )
+                                           - strlen( url.psz_path );
+            *psz_path_begin = '\0';
+            asprintf( &psz_uri, "%s%s", psz_unescaped, psz_escaped_path );
+
+            g_free( psz_escaped_path );
+            g_free( psz_unescaped );
+        }
+        else
+        {
+            psz_uri = psz_unescaped;
+        }
+    }
+    else
+    {
+        psz_uri = psz_unescaped;
     }
 
+    g_free( psz_expand_tilde );
     p_uri = gnome_vfs_uri_new( psz_uri );
-
     if( p_uri )
     {
         p_sys->p_file_info = gnome_vfs_file_info_new();
         i_ret = gnome_vfs_get_file_info_uri( p_uri,
-                                                p_sys->p_file_info, 8 ); 
+                                                p_sys->p_file_info, 8 );
 
         if( i_ret )
         {
-            msg_Err( p_access, "cannot get file info (%s)", 
-                                    gnome_vfs_result_to_string( i_ret ) );
+            msg_Warn( p_access, "cannot get file info for uri %s (%s)",
+                                psz_uri, gnome_vfs_result_to_string( i_ret ) );
             gnome_vfs_file_info_unref( p_sys->p_file_info );
             gnome_vfs_uri_unref( p_uri);
             free( p_sys );
@@ -164,13 +196,11 @@ static int Open( vlc_object_t *p_this )
     else
     {
         msg_Warn( p_access, "cannot parse MRL %s or unsupported protocol", psz_name );
-        LocaleFree( psz );
-        g_free( psz_uri );
+        free( psz_uri );
         free( p_sys );
         free( psz_name );
         return VLC_EGENERIC;
     }
-    LocaleFree( psz );
 
     msg_Dbg( p_access, "opening file `%s'", psz_uri );
     i_ret = gnome_vfs_open( &(p_sys->p_handle), psz_uri, 5 );
@@ -179,31 +209,29 @@ static int Open( vlc_object_t *p_this )
         msg_Warn( p_access, "cannot open file %s: %s", psz_uri,
                                 gnome_vfs_result_to_string( i_ret ) );
 
-        LocaleFree( psz );
-        g_free( psz_uri );
         gnome_vfs_uri_unref( p_uri);
-        free( p_sys ); 
         free( psz_uri );
+        free( p_sys );
         free( psz_name );
         return VLC_EGENERIC;
     }
 
     if (GNOME_VFS_FILE_INFO_LOCAL( p_sys->p_file_info ))
     {
-        p_sys->b_local = VLC_TRUE;
+        p_sys->b_local = true;
     }
 
-    if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_REGULAR || 
+    if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_REGULAR ||
         p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_CHARACTER_DEVICE ||
         p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_BLOCK_DEVICE )
     {
-        p_sys->b_seekable = VLC_TRUE;
+        p_sys->b_seekable = true;
         p_access->info.i_size = (int64_t)(p_sys->p_file_info->size);
     }
     else if( p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_FIFO
               || p_sys->p_file_info->type == GNOME_VFS_FILE_TYPE_SOCKET )
     {
-        p_sys->b_seekable = VLC_FALSE;
+        p_sys->b_seekable = false;
     }
     else
     {
@@ -214,8 +242,9 @@ static int Open( vlc_object_t *p_this )
     if( p_sys->b_seekable && !p_access->info.i_size )
     {
         /* FIXME that's bad because all others access will be probed */
-        msg_Err( p_access, "file %s is empty, aborting", psz_name );
+        msg_Warn( p_access, "file %s is empty, aborting", psz_name );
         gnome_vfs_file_info_unref( p_sys->p_file_info );
+        gnome_vfs_uri_unref( p_uri);
         free( p_sys );
         free( psz_uri );
         free( psz_name );
@@ -226,11 +255,10 @@ static int Open( vlc_object_t *p_this )
     var_Create( p_access, "gnomevfs-caching",
                                     VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 
-    g_free( psz_uri );
+    free( psz_uri );
     p_sys->psz_name = psz_name;
     gnome_vfs_uri_unref( p_uri);
     return VLC_SUCCESS;
-
 }
 
 /*****************************************************************************
@@ -258,18 +286,17 @@ static void Close( vlc_object_t * p_this )
 /*****************************************************************************
  * Read: standard read on a file descriptor.
  *****************************************************************************/
-static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
+static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
 {
     access_sys_t *p_sys = p_access->p_sys;
-    int i_ret;
     GnomeVFSFileSize i_read_len;
+    int i_ret;
 
     i_ret = gnome_vfs_read( p_sys->p_handle, p_buffer,
                                   (GnomeVFSFileSize)i_len, &i_read_len );
-
     if( i_ret )
     {
-        p_access->info.b_eof = VLC_TRUE;
+        p_access->info.b_eof = true;
         if( i_ret != GNOME_VFS_ERROR_EOF )
         {
             msg_Err( p_access, "read failed (%s)",
@@ -303,7 +330,7 @@ static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
     /* Some Acces (http) never return EOF and loop on the file */
     if( p_access->info.i_pos > p_access->info.i_size )
     {
-        p_access->info.b_eof = VLC_TRUE;
+        p_access->info.b_eof = true;
         return 0;
     }
     return (int)i_read_len;
@@ -312,14 +339,13 @@ static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
 /*****************************************************************************
  * Seek: seek to a specific location in a file
  *****************************************************************************/
-static int Seek( access_t *p_access, int64_t i_pos )
+static int Seek( access_t *p_access, uint64_t i_pos )
 {
     access_sys_t *p_sys = p_access->p_sys;
     int i_ret;
 
     i_ret = gnome_vfs_seek( p_sys->p_handle, GNOME_VFS_SEEK_START,
                                             (GnomeVFSFileOffset)i_pos);
-
     if ( !i_ret )
     {
         p_access->info.i_pos = i_pos;
@@ -338,7 +364,7 @@ static int Seek( access_t *p_access, int64_t i_pos )
         }
     }
     /* Reset eof */
-    p_access->info.b_eof = VLC_FALSE;
+    p_access->info.b_eof = false;
 
     /* FIXME */
     return VLC_SUCCESS;
@@ -350,8 +376,7 @@ static int Seek( access_t *p_access, int64_t i_pos )
 static int Control( access_t *p_access, int i_query, va_list args )
 {
     access_sys_t *p_sys = p_access->p_sys;
-    vlc_bool_t   *pb_bool;
-    int          *pi_int;
+    bool   *pb_bool;
     int64_t      *pi_64;
 
     switch( i_query )
@@ -359,26 +384,20 @@ static int Control( access_t *p_access, int i_query, va_list args )
         /* */
         case ACCESS_CAN_SEEK:
         case ACCESS_CAN_FASTSEEK:
-            pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
+            pb_bool = (bool*)va_arg( args, bool* );
             *pb_bool = p_sys->b_seekable;
             break;
 
         case ACCESS_CAN_PAUSE:
         case ACCESS_CAN_CONTROL_PACE:
-            pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
+            pb_bool = (bool*)va_arg( args, bool* );
             *pb_bool = p_sys->b_pace_control;
             break;
 
-        /* */
-        case ACCESS_GET_MTU:
-            pi_int = (int*)va_arg( args, int * );
-            *pi_int = 0;
-            break;
-
         case ACCESS_GET_PTS_DELAY:
             pi_64 = (int64_t*)va_arg( args, int64_t * );
             *pi_64 = var_GetInteger( p_access,
-                                        "gnomevfs-caching" ) * I64C(1000);
+                                        "gnomevfs-caching" ) * INT64_C(1000);
             break;
 
         /* */
@@ -391,6 +410,7 @@ static int Control( access_t *p_access, int i_query, va_list args )
         case ACCESS_SET_SEEKPOINT:
         case ACCESS_SET_PRIVATE_ID_STATE:
         case ACCESS_GET_META:
+        case ACCESS_GET_CONTENT_TYPE:
             return VLC_EGENERIC;
 
         default:
@@ -400,4 +420,3 @@ static int Control( access_t *p_access, int i_query, va_list args )
     }
     return VLC_SUCCESS;
 }
-