]> git.sesse.net Git - vlc/blobdiff - modules/access/ftp.c
Some more demux and access code factorization
[vlc] / modules / access / ftp.c
index 1aed4d30a820af94235b49138dc866b8516bfaeb..70728ba3fd61f6feab734c2a6a90b0fbd1f8de78 100644 (file)
@@ -1,10 +1,11 @@
 /*****************************************************************************
  * ftp.c: FTP input module
  *****************************************************************************
- * Copyright (C) 2001-2004 VideoLAN
+ * Copyright (C) 2001-2006 the VideoLAN team
  * $Id$
  *
- * Authors: Laurent Aimar <fenrir@via.ecp.fr>
+ * Authors: Laurent Aimar <fenrir@via.ecp.fr> - original code
+ *          RĂ©mi Denis-Courmont <rem # videolan.org> - EPSV support
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -18,7 +19,7 @@
  *
  * 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.
  *****************************************************************************/
 
 /*****************************************************************************
@@ -30,6 +31,7 @@
 #include <vlc/input.h>
 
 #include "network.h"
+#include "vlc_url.h"
 
 /*****************************************************************************
  * Module descriptor
@@ -39,21 +41,24 @@ 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 FTP streams. This " \
-    "value should be set in millisecond units." )
+    "Caching value for FTP streams. This " \
+    "value should be set in milliseconds." )
 #define USER_TEXT N_("FTP user name")
-#define USER_LONGTEXT N_("Allows you to modify the user name that will " \
+#define USER_LONGTEXT N_("User name that will " \
     "be used for the connection.")
 #define PASS_TEXT N_("FTP password")
-#define PASS_LONGTEXT N_("Allows you to modify the password that will be " \
+#define PASS_LONGTEXT N_("Password that will be " \
     "used for the connection.")
 #define ACCOUNT_TEXT N_("FTP account")
-#define ACCOUNT_LONGTEXT N_("Allows you to modify the account that will be " \
+#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 );
     add_integer( "ftp-caching", 2 * DEFAULT_PTS_DELAY / 1000, NULL,
                  CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
     add_string( "ftp-user", "anonymous", NULL, USER_TEXT, USER_LONGTEXT,
@@ -75,10 +80,12 @@ static int Control( access_t *, int, va_list );
 
 struct access_sys_t
 {
-    vlc_url_t url;
+    vlc_url_t  url;
 
-    int       fd_cmd;
-    int       fd_data;
+    int        fd_cmd;
+    int        fd_data;
+    
+    char       sz_epsv_ip[NI_MAXNUMERICHOST];
 };
 
 static int  ftp_SendCommand( access_t *, char *, ... );
@@ -86,60 +93,19 @@ static int  ftp_ReadCommand( access_t *, int *, char ** );
 static int  ftp_StartStream( access_t *, int64_t );
 static int  ftp_StopStream ( access_t *);
 
-/****************************************************************************
- * Open: connect to ftp server and ask for file
- ****************************************************************************/
-static int Open( vlc_object_t *p_this )
+static int Connect( access_t *p_access, access_sys_t *p_sys )
 {
-    access_t     *p_access = (access_t*)p_this;
-    access_sys_t *p_sys;
-    char         *psz;
-
-    int          i_answer;
-    char         *psz_arg;
-
-    /* Init p_access */
-    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 ) );
-    memset( p_sys, 0, sizeof( access_sys_t ) );
-    p_sys->fd_cmd = -1;
-    p_sys->fd_data = -1;
-
-    /* *** Parse URL and get server addr/port and path *** */
-    psz = p_access->psz_path;
-    while( *psz == '/' )
-    {
-        psz++;
-    }
-    vlc_UrlParse( &p_sys->url, psz, 0 );
-
-    if( p_sys->url.psz_host == NULL || *p_sys->url.psz_host == '\0' )
-    {
-        msg_Err( p_access, "invalid server name" );
-        goto exit_error;
-    }
-    if( p_sys->url.i_port <= 0 )
-    {
-        p_sys->url.i_port = 21; /* default port */
-    }
+    int fd, i_answer;
+    char *psz;
 
     /* *** Open a TCP connection with server *** */
     msg_Dbg( p_access, "waiting for connection..." );
-    p_sys->fd_cmd = net_OpenTCP( p_access, p_sys->url.psz_host,
-                                 p_sys->url.i_port );
-    if( p_sys->fd_cmd < 0 )
+    p_sys->fd_cmd = fd = net_ConnectTCP( p_access, p_sys->url.psz_host,
+                                      p_sys->url.i_port );
+    if( fd < 0 )
     {
         msg_Err( p_access, "failed to connect with server" );
-        goto exit_error;
+        return -1;
     }
 
     for( ;; )
@@ -152,17 +118,21 @@ static int Open( vlc_object_t *p_this )
     if( i_answer / 100 != 2 )
     {
         msg_Err( p_access, "connection rejected" );
-        goto exit_error;
+        return -1;
     }
 
     msg_Dbg( p_access, "connection accepted (%d)", i_answer );
+    
+    if( p_sys->url.psz_username && *p_sys->url.psz_username )
+        psz = strdup( p_sys->url.psz_username );
+    else
+        psz = var_CreateGetString( p_access, "ftp-user" );
 
-    psz = var_CreateGetString( p_access, "ftp-user" );
     if( ftp_SendCommand( p_access, "USER %s", psz ) < 0 ||
         ftp_ReadCommand( p_access, &i_answer, NULL ) < 0 )
     {
         free( psz );
-        goto exit_error;
+        return -1;
     }
     free( psz );
 
@@ -173,12 +143,16 @@ static int Open( vlc_object_t *p_this )
             break;
         case 3:
             msg_Dbg( p_access, "password needed" );
-            psz = var_CreateGetString( p_access, "ftp-pwd" );
+            if( p_sys->url.psz_password && *p_sys->url.psz_password )
+                psz = strdup( p_sys->url.psz_password );
+           else
+                psz = var_CreateGetString( p_access, "ftp-pwd" );
+
             if( ftp_SendCommand( p_access, "PASS %s", psz ) < 0 ||
                 ftp_ReadCommand( p_access, &i_answer, NULL ) < 0 )
             {
                 free( psz );
-                goto exit_error;
+                return -1;
             }
             free( psz );
 
@@ -195,27 +169,103 @@ static int Open( vlc_object_t *p_this )
                         ftp_ReadCommand( p_access, &i_answer, NULL ) < 0 )
                     {
                         free( psz );
-                        goto exit_error;
+                        return -1;
                     }
                     free( psz );
 
                     if( i_answer / 100 != 2 )
                     {
                         msg_Err( p_access, "account rejected" );
-                        goto exit_error;
+                        return -1;
                     }
                     msg_Dbg( p_access, "account accepted" );
                     break;
 
                 default:
                     msg_Err( p_access, "password rejected" );
-                    goto exit_error;
+                    return -1;
             }
             break;
         default:
             msg_Err( p_access, "user rejected" );
+            return -1;
+    }
+
+    return 0;
+}
+
+/****************************************************************************
+ * Open: connect to ftp server and ask for file
+ ****************************************************************************/
+static int Open( vlc_object_t *p_this )
+{
+    access_t     *p_access = (access_t*)p_this;
+    access_sys_t *p_sys;
+    char         *psz;
+
+    int          i_answer;
+    char         *psz_arg;
+
+    /* Init p_access */
+    STANDARD_READ_ACCESS_INIT
+    p_sys->fd_cmd = -1;
+    p_sys->fd_data = -1;
+
+    /* *** Parse URL and get server addr/port and path *** */
+    psz = p_access->psz_path;
+    while( *psz == '/' )
+    {
+        psz++;
+    }
+    vlc_UrlParse( &p_sys->url, psz, 0 );
+
+    if( p_sys->url.psz_host == NULL || *p_sys->url.psz_host == '\0' )
+    {
+        msg_Err( p_access, "invalid server name" );
+        goto exit_error;
+    }
+    if( p_sys->url.i_port <= 0 )
+    {
+        p_sys->url.i_port = 21; /* default port */
+    }
+
+    /* FTP URLs are relative to user's default directory (RFC1738)
+       For absolute path use ftp://foo.bar//usr/local/etc/filename */
+
+    if( *p_sys->url.psz_path == '/' )
+        p_sys->url.psz_path++;
+
+    if( Connect( p_access, p_sys ) < 0 )
+        goto exit_error;
+
+    /* Extended passive mode */
+    if( ftp_SendCommand( p_access, "EPSV ALL" ) < 0 )
+    {
+        msg_Err( p_access, "cannot request extended passive mode" );
+        return -1;
+    }
+
+    if( ftp_ReadCommand( p_access, &i_answer, NULL ) == 2 )
+    {
+        if( net_GetPeerAddress( p_sys->fd_cmd, p_sys->sz_epsv_ip, NULL ) )
             goto exit_error;
     }
+    else
+    {
+        /* If ESPV ALL fails, we fallback to PASV.
+         * We have to restart the connection in case there is a NAT that
+         * understands EPSV ALL in the way, and hence won't allow PASV on
+         * the initial connection.
+         */
+        net_Close( p_sys->fd_cmd );
+        p_sys->fd_cmd = -1;
+        *p_sys->sz_epsv_ip = '\0';
+
+        msg_Info( p_access, "FTP Extended passive mode disabled" );
+
+        if( ( p_sys->fd_cmd = Connect( p_access, p_sys ) ) < 0 )
+           goto exit_error;
+    }
 
     /* binary mode */
     if( ftp_SendCommand( p_access, "TYPE I" ) < 0 ||
@@ -249,10 +299,8 @@ static int Open( vlc_object_t *p_this )
     return VLC_SUCCESS;
 
 exit_error:
-    if( p_sys->fd_cmd > 0 )
-    {
+    if( p_sys->fd_cmd >= 0 )
         net_Close( p_sys->fd_cmd );
-    }
     vlc_UrlClean( &p_sys->url );
     free( p_sys );
     return VLC_EGENERIC;
@@ -398,21 +446,14 @@ static int ftp_SendCommand( access_t *p_access, char *psz_fmt, ... )
     access_sys_t *p_sys = p_access->p_sys;
     va_list      args;
     char         *psz_cmd;
-    int          i_ret;
 
     va_start( args, psz_fmt );
     vasprintf( &psz_cmd, psz_fmt, args );
     va_end( args );
 
     msg_Dbg( p_access, "ftp_SendCommand:\"%s\"", psz_cmd);
-    if( ( i_ret = net_Printf( VLC_OBJECT(p_access), p_sys->fd_cmd, NULL,
-                              "%s", psz_cmd ) ) > 0 )
-    {
-        i_ret = net_Printf( VLC_OBJECT(p_access), p_sys->fd_cmd, NULL,
-                            "\r\n" );
-    }
-
-    if( i_ret < 0 )
+    if( net_Printf( VLC_OBJECT(p_access), p_sys->fd_cmd, NULL, "%s\r\n",
+                    psz_cmd ) < 0 )
     {
         msg_Err( p_access, "failed to send command" );
         return VLC_EGENERIC;
@@ -494,33 +535,59 @@ static int ftp_StartStream( access_t *p_access, off_t i_start )
 {
     access_sys_t *p_sys = p_access->p_sys;
 
-    char psz_ip[1000];
+    char psz_ipv4[16], *psz_ip;
     int  i_answer;
     char *psz_arg, *psz_parser;
-    int  a1,a2,a3,a4;
-    int  p1,p2;
     int  i_port;
 
-    if( ftp_SendCommand( p_access, "PASV" ) < 0 ||
-        ftp_ReadCommand( p_access, &i_answer, &psz_arg ) != 2 )
+    psz_ip = p_sys->sz_epsv_ip;
+
+    if( ( ftp_SendCommand( p_access, *psz_ip ? "EPSV" : "PASV" ) < 0 )
+     || ( ftp_ReadCommand( p_access, &i_answer, &psz_arg ) != 2 ) )
     {
-        msg_Err( p_access, "cannot set passive transfer mode" );
+        msg_Err( p_access, "cannot set passive mode" );
         return VLC_EGENERIC;
     }
 
     psz_parser = strchr( psz_arg, '(' );
-    if( !psz_parser ||
-        sscanf( psz_parser, "(%d,%d,%d,%d,%d,%d", &a1, &a2, &a3,
-                &a4, &p1, &p2 ) < 6 )
+    if( psz_parser == NULL )
     {
         free( psz_arg );
-        msg_Err( p_access, "cannot get ip/port for passive transfer mode" );
+        msg_Err( p_access, "cannot parse passive mode response" );
         return VLC_EGENERIC;
     }
+
+    if( psz_ip != NULL )
+    {
+        char psz_fmt[7] = "(|||%u";
+        psz_fmt[1] = psz_fmt[2] = psz_fmt[3] = psz_parser[1];
+
+        if( sscanf( psz_parser, psz_fmt, &i_port ) < 1 )
+        {
+            free( psz_arg );
+            msg_Err( p_access, "cannot parse passive mode response" );
+            return VLC_EGENERIC;
+        }
+    }
+    else
+    {
+        unsigned  a1, a2, a3, a4, p1, p2;
+
+        if( ( sscanf( psz_parser, "(%u,%u,%u,%u,%u,%u", &a1, &a2, &a3, &a4,
+                      &p1, &p2 ) < 6 ) || ( a1 > 255 ) || ( a2 > 255 )
+         || ( a3 > 255 ) || ( a4 > 255 ) || ( p1 > 255 ) || ( p2 > 255 ) )
+        {
+            free( psz_arg );
+            msg_Err( p_access, "cannot parse passive mode response" );
+            return VLC_EGENERIC;
+        }
+
+        sprintf( psz_ipv4, "%u.%u.%u.%u", a1, a2, a3, a4 );
+        psz_ip = psz_ipv4;
+        i_port = (p1 << 8) | p2;
+    }
     free( psz_arg );
 
-    sprintf( psz_ip, "%d.%d.%d.%d", a1, a2, a3, a4 );
-    i_port = p1 * 256 + p2;
     msg_Dbg( p_access, "ip:%s port:%d", psz_ip, i_port );
 
     if( ftp_SendCommand( p_access, "TYPE I" ) < 0 ||
@@ -541,7 +608,7 @@ static int ftp_StartStream( access_t *p_access, off_t i_start )
     }
 
     msg_Dbg( p_access, "waiting for data connection..." );
-    p_sys->fd_data = net_OpenTCP( p_access, psz_ip, i_port );
+    p_sys->fd_data = net_ConnectTCP( p_access, psz_ip, i_port );
     if( p_sys->fd_data < 0 )
     {
         msg_Err( p_access, "failed to connect with server" );
@@ -568,7 +635,7 @@ static int ftp_StopStream ( access_t *p_access )
 
     if( ftp_SendCommand( p_access, "ABOR" ) < 0 )
     {
-        msg_Warn( p_access, "cannot abord file" );
+        msg_Warn( p_access, "cannot abort file" );
         if(  p_sys->fd_data > 0 )
             net_Close( p_sys->fd_data );
         p_sys->fd_data = -1;