]> git.sesse.net Git - vlc/blobdiff - modules/access/ftp.c
FTP: fix relative file paths (fix #3984)
[vlc] / modules / access / ftp.c
index ff8ae8d9fa811256ccb44bfe4338d97cb2b11edc..127ee3572971f1f086605768513d501751019da1 100644 (file)
 /*****************************************************************************
  * Preamble
  *****************************************************************************/
-#include <vlc/vlc.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+#include <vlc_plugin.h>
 
-#include <stdio.h>
-#include <stdlib.h>
 #include <assert.h>
 
 #include <vlc_access.h>
-#include <vlc_interface.h>
+#include <vlc_dialog.h>
 
 #include <vlc_network.h>
-#include "vlc_url.h"
+#include <vlc_url.h>
 #include <vlc_sout.h>
+#include <vlc_charset.h>
 
 #ifndef IPPORT_FTP
 # define IPPORT_FTP 21u
@@ -65,40 +69,41 @@ static void OutClose( vlc_object_t * );
 #define ACCOUNT_LONGTEXT N_("Account that will be " \
     "used for the connection.")
 
-vlc_module_begin();
-    set_shortname( "FTP" );
-    set_description( _("FTP input") );
-    set_capability( "access2", 0 );
-    set_category( CAT_INPUT );
-    set_subcategory( SUBCAT_INPUT_ACCESS );
+vlc_module_begin ()
+    set_shortname( "FTP" )
+    set_description( N_("FTP input") )
+    set_capability( "access", 0 )
+    set_category( CAT_INPUT )
+    set_subcategory( SUBCAT_INPUT_ACCESS )
     add_integer( "ftp-caching", 2 * DEFAULT_PTS_DELAY / 1000, NULL,
-                 CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
+                 CACHING_TEXT, CACHING_LONGTEXT, true )
+        change_safe()
     add_string( "ftp-user", "anonymous", NULL, USER_TEXT, USER_LONGTEXT,
-                VLC_FALSE );
+                false )
     add_string( "ftp-pwd", "anonymous@example.com", NULL, PASS_TEXT,
-                PASS_LONGTEXT, VLC_FALSE );
+                PASS_LONGTEXT, false )
     add_string( "ftp-account", "anonymous", NULL, ACCOUNT_TEXT,
-                ACCOUNT_LONGTEXT, VLC_FALSE );
-    add_shortcut( "ftp" );
-    set_callbacks( InOpen, InClose );
-
-    add_submodule();
-    set_shortname( "FTP" );
-    set_description( _("FTP upload output") );
-    set_capability( "sout access", 0 );
-    set_category( CAT_SOUT );
-    set_subcategory( SUBCAT_SOUT_ACO );
-    add_shortcut( "ftp" );
-    set_callbacks( OutOpen, OutClose );
-vlc_module_end();
+                ACCOUNT_LONGTEXT, false )
+    add_shortcut( "ftp" )
+    set_callbacks( InOpen, InClose )
+
+    add_submodule ()
+        set_shortname( "FTP" )
+        set_description( N_("FTP upload output") )
+        set_capability( "sout access", 0 )
+        set_category( CAT_SOUT )
+        set_subcategory( SUBCAT_SOUT_ACO )
+        add_shortcut( "ftp" )
+        set_callbacks( OutOpen, OutClose )
+vlc_module_end ()
 
 /*****************************************************************************
  * Local prototypes
  *****************************************************************************/
-static int Read( access_t *, uint8_t *, int );
-static int Write( sout_access_out_t *, block_t * );
-static int Seek( access_t *, int64_t );
-static int OutSeek( sout_access_out_t *, int64_t );
+static ssize_t Read( access_t *, uint8_t *, size_t );
+static ssize_t Write( sout_access_out_t *, block_t * );
+static int Seek( access_t *, uint64_t );
+static int OutSeek( sout_access_out_t *, off_t );
 static int Control( access_t *, int, va_list );
 
 struct access_sys_t
@@ -109,13 +114,15 @@ struct access_sys_t
     int        fd_data;
 
     char       sz_epsv_ip[NI_MAXNUMERICHOST];
+    bool       out;
+    bool       directory;
 };
 #define GET_OUT_SYS( p_this ) \
     ((access_sys_t *)(((sout_access_out_t *)(p_this))->p_sys))
 
 static int ftp_SendCommand( vlc_object_t *, access_sys_t *, const char *, ... );
 static int ftp_ReadCommand( vlc_object_t *, access_sys_t *, int *, char ** );
-static int ftp_StartStream( vlc_object_t *, access_sys_t *, int64_t );
+static int ftp_StartStream( vlc_object_t *, access_sys_t *, uint64_t );
 static int ftp_StopStream ( vlc_object_t *, access_sys_t * );
 
 static int Login( vlc_object_t *p_access, access_sys_t *p_sys )
@@ -129,7 +136,7 @@ static int Login( vlc_object_t *p_access, access_sys_t *p_sys )
     if( fd == -1 )
     {
         msg_Err( p_access, "connection failed" );
-        intf_UserFatal( p_access, VLC_FALSE, _("Network interaction failed"), 
+        dialog_Fatal( p_access, _("Network interaction failed"), "%s",
                         _("VLC could not connect with the given server.") );
         return -1;
     }
@@ -139,7 +146,7 @@ static int Login( vlc_object_t *p_access, access_sys_t *p_sys )
     if( i_answer / 100 != 2 )
     {
         msg_Err( p_access, "connection rejected" );
-        intf_UserFatal( p_access, VLC_FALSE, _("Network interaction failed"), 
+        dialog_Fatal( p_access, _("Network interaction failed"), "%s",
                         _("VLC's connection to the given server was rejected.") );
         return -1;
     }
@@ -150,6 +157,8 @@ static int Login( vlc_object_t *p_access, access_sys_t *p_sys )
         psz = strdup( p_sys->url.psz_username );
     else
         psz = var_CreateGetString( p_access, "ftp-user" );
+    if( !psz )
+        return -1;
 
     if( ftp_SendCommand( p_access, p_sys, "USER %s", psz ) < 0 ||
         ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
@@ -170,6 +179,8 @@ static int Login( vlc_object_t *p_access, access_sys_t *p_sys )
                 psz = strdup( p_sys->url.psz_password );
             else
                 psz = var_CreateGetString( p_access, "ftp-pwd" );
+            if( !psz )
+                return -1;
 
             if( ftp_SendCommand( p_access, p_sys, "PASS %s", psz ) < 0 ||
                 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
@@ -199,9 +210,9 @@ static int Login( vlc_object_t *p_access, access_sys_t *p_sys )
                     if( i_answer / 100 != 2 )
                     {
                         msg_Err( p_access, "account rejected" );
-                        intf_UserFatal( p_access, VLC_FALSE, 
-                                        _("Network interaction failed"), 
-                                        _("Your account was rejected.") );
+                        dialog_Fatal( p_access,
+                                      _("Network interaction failed"),
+                                      "%s", _("Your account was rejected.") );
                         return -1;
                     }
                     msg_Dbg( p_access, "account accepted" );
@@ -209,17 +220,15 @@ static int Login( vlc_object_t *p_access, access_sys_t *p_sys )
 
                 default:
                     msg_Err( p_access, "password rejected" );
-                    intf_UserFatal( p_access, VLC_FALSE, 
-                                    _("Network interaction failed"), 
-                                    _("Your password was rejected.") );
+                    dialog_Fatal( p_access, _("Network interaction failed"),
+                                  "%s",  _("Your password was rejected.") );
                     return -1;
             }
             break;
         default:
             msg_Err( p_access, "user rejected" );
-            intf_UserFatal( p_access, VLC_FALSE, 
-                        _("Network interaction failed"), 
-                        _("Your connection attemp to the server was rejected.") );
+            dialog_Fatal( p_access, _("Network interaction failed"), "%s",
+                        _("Your connection attempt to the server was rejected.") );
             return -1;
     }
 
@@ -280,7 +289,7 @@ static int Connect( vlc_object_t *p_access, access_sys_t *p_sys )
 static int parseURL( vlc_url_t *url, const char *path )
 {
     if( path == NULL )
-        return -1;
+        return VLC_EGENERIC;
 
     /* *** Parse URL and get server addr/port and path *** */
     while( *path == '/' )
@@ -289,18 +298,33 @@ static int parseURL( vlc_url_t *url, const char *path )
     vlc_UrlParse( url, path, 0 );
 
     if( url->psz_host == NULL || *url->psz_host == '\0' )
-        return -1;
+        return VLC_EGENERIC;
 
     if( url->i_port <= 0 )
         url->i_port = IPPORT_FTP; /* default port */
 
-    /* FTP URLs are relative to user's default directory (RFC1738)
+    if( url->psz_path == NULL )
+        return VLC_SUCCESS;
+    /* FTP URLs are relative to user's default directory (RFC1738 ยง3.2)
     For absolute path use ftp://foo.bar//usr/local/etc/filename */
-
-    if( *url->psz_path == '/' )
+    /* FIXME: we should issue a series of CWD, one per slash */
+    if( url->psz_path )
+    {
+        assert( url->psz_path[0] == '/' );
         url->psz_path++;
+    }
 
-    return 0;
+    char *type = strstr( url->psz_path, ";type=" );
+    if( type )
+    {
+        *type = '\0';
+        if( strchr( "iI", type[6] ) == NULL )
+            return VLC_EGENERIC; /* ASCII and directory not supported */
+    }
+    decode_URI( url->psz_path );
+    /* FIXME: check for UTF-8 support, otherwise only ASCII is allowed */
+    EnsureUTF8( url->psz_path );
+    return VLC_SUCCESS;
 }
 
 
@@ -316,24 +340,39 @@ static int InOpen( vlc_object_t *p_this )
     /* Init p_access */
     STANDARD_READ_ACCESS_INIT
     p_sys->fd_data = -1;
+    p_sys->out = false;
+    p_sys->directory = false;
 
-    if( parseURL( &p_sys->url, p_access->psz_path ) )
+    if( parseURL( &p_sys->url, p_access->psz_location ) )
         goto exit_error;
 
     if( Connect( p_this, p_sys ) )
         goto exit_error;
 
     /* get size */
-    if( ftp_SendCommand( p_this, p_sys, "SIZE %s", p_sys->url.psz_path ) < 0 ||
-        ftp_ReadCommand( p_this, p_sys, NULL, &psz_arg ) != 2 )
+    if( p_sys->url.psz_path == NULL )
+        p_sys->directory = true;
+    else
+    if( ftp_SendCommand( p_this, p_sys, "SIZE %s", p_sys->url.psz_path ) < 0
+     || ftp_ReadCommand( p_this, p_sys, NULL, &psz_arg ) != 2 )
     {
-        msg_Err( p_access, "cannot get file size" );
-        net_Close( p_sys->fd_cmd );
-        goto exit_error;
+        msg_Dbg( p_access, "cannot get file size" );
+        msg_Dbg( p_access, "will try to get directory contents" );
+        if( ftp_SendCommand( p_this, p_sys, "CWD %s", p_sys->url.psz_path ) < 0
+         || ftp_ReadCommand( p_this, p_sys, NULL, &psz_arg ) != 2 )
+        {
+            msg_Err( p_access, "file or directory doesn't exist" );
+            net_Close( p_sys->fd_cmd );
+            goto exit_error;
+        }
+        p_sys->directory = true;
+    }
+    else
+    {
+        p_access->info.i_size = atoll( &psz_arg[4] );
+        free( psz_arg );
+        msg_Dbg( p_access, "file size: %"PRIu64, p_access->info.i_size );
     }
-    p_access->info.i_size = atoll( &psz_arg[4] );
-    free( psz_arg );
-    msg_Dbg( p_access, "file size: "I64Fd, p_access->info.i_size );
 
     /* Start the 'stream' */
     if( ftp_StartStream( p_this, p_sys, 0 ) < 0 )
@@ -359,16 +398,21 @@ static int OutOpen( vlc_object_t *p_this )
     sout_access_out_t *p_access = (sout_access_out_t *)p_this;
     access_sys_t      *p_sys;
 
-    p_sys = malloc( sizeof( *p_sys ) );
-    if( p_sys == NULL )
+    p_sys = calloc( 1, sizeof( *p_sys ) );
+    if( !p_sys )
         return VLC_ENOMEM;
-    memset( p_sys, 0, sizeof( *p_sys ) );
 
     /* Init p_access */
     p_sys->fd_data = -1;
+    p_sys->out = true;
 
     if( parseURL( &p_sys->url, p_access->psz_path ) )
         goto exit_error;
+    if( p_sys->url.psz_path == NULL )
+    {
+        msg_Err( p_this, "no filename specified" );
+        goto exit_error;
+    }
 
     if( Connect( p_this, p_sys ) )
         goto exit_error;
@@ -430,12 +474,9 @@ static void OutClose( vlc_object_t *p_this )
 /*****************************************************************************
  * Seek: try to go at the right place
  *****************************************************************************/
-static int _Seek( vlc_object_t *p_access, access_sys_t *p_sys, int64_t i_pos )
+static int _Seek( vlc_object_t *p_access, access_sys_t *p_sys, uint64_t i_pos )
 {
-    if( i_pos < 0 )
-        return VLC_EGENERIC;
-
-    msg_Dbg( p_access, "seeking to "I64Fd, i_pos );
+    msg_Dbg( p_access, "seeking to %"PRIu64, i_pos );
 
     ftp_StopStream( (vlc_object_t *)p_access, p_sys );
     if( ftp_StartStream( (vlc_object_t *)p_access, p_sys, i_pos ) < 0 )
@@ -444,13 +485,13 @@ static int _Seek( vlc_object_t *p_access, access_sys_t *p_sys, int64_t i_pos )
     return VLC_SUCCESS;
 }
 
-static int Seek( access_t *p_access, int64_t i_pos )
+static int Seek( access_t *p_access, uint64_t i_pos )
 {
     int val = _Seek( (vlc_object_t *)p_access, p_access->p_sys, i_pos );
     if( val )
         return val;
 
-    p_access->info.b_eof = VLC_FALSE;
+    p_access->info.b_eof = false;
     p_access->info.i_pos = i_pos;
 
     return VLC_SUCCESS;
@@ -464,31 +505,50 @@ static int OutSeek( sout_access_out_t *p_access, off_t i_pos )
 /*****************************************************************************
  * Read:
  *****************************************************************************/
-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_read;
 
     assert( p_sys->fd_data != -1 );
-    assert( p_access->i_object_type == VLC_OBJECT_ACCESS );
+    assert( !p_sys->out );
 
     if( p_access->info.b_eof )
         return 0;
 
-    i_read = net_Read( p_access, p_sys->fd_data, NULL, p_buffer, i_len,
-                       VLC_FALSE );
-    if( i_read == 0 )
-        p_access->info.b_eof = VLC_TRUE;
-    else if( i_read > 0 )
-        p_access->info.i_pos += i_read;
-
-    return i_read;
+    if( p_sys->directory )
+    {
+        char *psz_line = net_Gets( p_access, p_sys->fd_data, NULL );
+        if( !psz_line )
+        {
+            p_access->info.b_eof = true;
+            return 0;
+        }
+        else
+        {
+            snprintf( (char*)p_buffer, i_len, "ftp://%s:%d%s/%s\n",
+                      p_sys->url.psz_host, p_sys->url.i_port,
+                      p_sys->url.psz_path, psz_line );
+            free( psz_line );
+            return strlen( (const char *)p_buffer );
+        }
+    }
+    else
+    {
+        int i_read = net_Read( p_access, p_sys->fd_data, NULL,
+                               p_buffer, i_len, false );
+        if( i_read == 0 )
+            p_access->info.b_eof = true;
+        else if( i_read > 0 )
+            p_access->info.i_pos += i_read;
+
+        return i_read;
+    }
 }
 
 /*****************************************************************************
  * Write:
  *****************************************************************************/
-static int Write( sout_access_out_t *p_access, block_t *p_buffer )
+static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
 {
     access_sys_t *p_sys = GET_OUT_SYS(p_access);
     size_t i_write = 0;
@@ -514,56 +574,52 @@ static int Write( sout_access_out_t *p_access, block_t *p_buffer )
  *****************************************************************************/
 static int Control( access_t *p_access, int i_query, va_list args )
 {
-    vlc_bool_t   *pb_bool;
-    int          *pi_int;
-    int64_t      *pi_64;
-    vlc_value_t  val;
+    bool    *pb_bool;
+    int64_t *pi_64;
 
     switch( i_query )
     {
         /* */
         case ACCESS_CAN_SEEK:
-            pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
-            *pb_bool = VLC_TRUE;
+            pb_bool = (bool*)va_arg( args, bool* );
+            *pb_bool = true;
             break;
         case ACCESS_CAN_FASTSEEK:
-            pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
-            *pb_bool = VLC_FALSE;
+            pb_bool = (bool*)va_arg( args, bool* );
+            *pb_bool = false;
             break;
         case ACCESS_CAN_PAUSE:
-            pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
-            *pb_bool = VLC_TRUE;    /* FIXME */
+            pb_bool = (bool*)va_arg( args, bool* );
+            *pb_bool = true;    /* FIXME */
             break;
         case ACCESS_CAN_CONTROL_PACE:
-            pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
-            *pb_bool = VLC_TRUE;    /* FIXME */
+            pb_bool = (bool*)va_arg( args, bool* );
+            *pb_bool = true;    /* FIXME */
             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 * );
-            var_Get( p_access, "ftp-caching", &val );
-            *pi_64 = (int64_t)var_GetInteger( p_access, "ftp-caching" ) * I64C(1000);
+            *pi_64 = var_GetInteger( p_access, "ftp-caching" ) * INT64_C(1000);
             break;
 
         /* */
         case ACCESS_SET_PAUSE_STATE:
-            /* Nothing to do */
+            pb_bool = (bool*)va_arg( args, bool* );
+            if ( !pb_bool )
+              return Seek( p_access, p_access->info.i_pos );
             break;
 
         case ACCESS_GET_TITLE_INFO:
         case ACCESS_SET_TITLE:
         case ACCESS_SET_SEEKPOINT:
         case ACCESS_SET_PRIVATE_ID_STATE:
+        case ACCESS_GET_CONTENT_TYPE:
+        case ACCESS_GET_META:
             return VLC_EGENERIC;
 
         default:
-            msg_Warn( p_access, "unimplemented query in control);
+            msg_Warn( p_access, "unimplemented query in control: %d", i_query);
             return VLC_EGENERIC;
 
     }
@@ -580,12 +636,14 @@ static int ftp_SendCommand( vlc_object_t *p_access, access_sys_t *p_sys,
     char         *psz_cmd;
 
     va_start( args, psz_fmt );
-    vasprintf( &psz_cmd, psz_fmt, args );
+    if( vasprintf( &psz_cmd, psz_fmt, args ) == -1 )
+        return VLC_EGENERIC;
+
     va_end( args );
 
     msg_Dbg( p_access, "ftp_SendCommand:\"%s\"", psz_cmd);
-    if( net_Printf( VLC_OBJECT(p_access), p_sys->fd_cmd, NULL, "%s\r\n",
-                    psz_cmd ) < 0 )
+
+    if( net_Printf( p_access, p_sys->fd_cmd, NULL, "%s\r\n", psz_cmd ) < 0 )
     {
         msg_Err( p_access, "failed to send command" );
         return VLC_EGENERIC;
@@ -618,7 +676,7 @@ static int ftp_ReadCommand( vlc_object_t *p_access, access_sys_t *p_sys,
     if( psz_line == NULL || strlen( psz_line ) < 3 )
     {
         msg_Err( p_access, "cannot get answer" );
-        if( psz_line ) free( psz_line );
+        free( psz_line );
         if( pi_answer ) *pi_answer    = 500;
         if( ppsz_answer ) *ppsz_answer  = NULL;
         return -1;
@@ -663,7 +721,7 @@ static int ftp_ReadCommand( vlc_object_t *p_access, access_sys_t *p_sys,
 }
 
 static int ftp_StartStream( vlc_object_t *p_access, access_sys_t *p_sys,
-                            off_t i_start )
+                            uint64_t i_start )
 {
     char psz_ipv4[16], *psz_ip = p_sys->sz_epsv_ip;
     int  i_answer;
@@ -729,7 +787,7 @@ static int ftp_StartStream( vlc_object_t *p_access, access_sys_t *p_sys,
 
     if( i_start > 0 )
     {
-        if( ftp_SendCommand( p_access, p_sys, "REST "I64Fu, i_start ) < 0 ||
+        if( ftp_SendCommand( p_access, p_sys, "REST %"PRIu64, i_start ) < 0 ||
             ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) > 3 )
         {
             msg_Err( p_access, "cannot set restart offset" );
@@ -747,21 +805,30 @@ static int ftp_StartStream( vlc_object_t *p_access, access_sys_t *p_sys,
     msg_Dbg( p_access, "connection with \"%s:%d\" successful",
              psz_ip, i_port );
 
-    /* "1xx" message */
-    if( ftp_SendCommand( p_access, p_sys, "%s %s",
-                         (p_access->i_object_type == VLC_OBJECT_ACCESS)
-                                 ? "RETR" : "STOR",
-                         p_sys->url.psz_path ) < 0 ||
-        ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) > 2 )
+    if( p_sys->directory )
     {
-        msg_Err( p_access, "cannot retreive file" );
+        if( ftp_SendCommand( p_access, p_sys, "NLST" ) < 0 ||
+            ftp_ReadCommand( p_access, p_sys, NULL, &psz_arg ) > 2 )
+        {
+            msg_Err( p_access, "cannot list directory contents" );
         return VLC_EGENERIC;
+        }
     }
-
-    if( p_access->i_object_type == VLC_OBJECT_ACCESS )
-        net_StopSend( p_sys->fd_data );
     else
-        net_StopRecv( p_sys->fd_data );
+    {
+        /* "1xx" message */
+        assert( p_sys->url.psz_path );
+        if( ftp_SendCommand( p_access, p_sys, "%s %s",
+                             p_sys->out ? "STOR" : "RETR",
+                             p_sys->url.psz_path ) < 0
+         || ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) > 2 )
+        {
+            msg_Err( p_access, "cannot retrieve file" );
+            return VLC_EGENERIC;
+        }
+    }
+
+    shutdown( p_sys->fd_data, p_sys->out ? SHUT_RD : SHUT_WR );
 
     return VLC_SUCCESS;
 }
@@ -781,8 +848,10 @@ static int ftp_StopStream ( vlc_object_t *p_access, access_sys_t *p_sys )
     {
         net_Close( p_sys->fd_data );
         p_sys->fd_data = -1;
+        /* Read the final response from RETR/STOR, i.e. 426 or 226 */
         ftp_ReadCommand( p_access, p_sys, NULL, NULL );
     }
+    /* Read the response from ABOR, i.e. 226 or 225 */
     ftp_ReadCommand( p_access, p_sys, NULL, NULL );
 
     return VLC_SUCCESS;