]> git.sesse.net Git - vlc/blobdiff - modules/access/ftp.c
Documentation fixes
[vlc] / modules / access / ftp.c
index 09d9fed1c7900ad97fc55b26d0f2699076949ba1..8cb24f89b328219a1b8543f85706fcd2112608bb 100644 (file)
@@ -30,7 +30,8 @@
 # include "config.h"
 #endif
 
-#include <vlc/vlc.h>
+#include <vlc_common.h>
+#include <vlc_plugin.h>
 
 #include <assert.h>
 
@@ -67,31 +68,31 @@ 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 );
     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 );
-    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 )
+    set_callbacks( OutOpen, OutClose )
+vlc_module_end ()
 
 /*****************************************************************************
  * Local prototypes
@@ -110,6 +111,7 @@ struct access_sys_t
     int        fd_data;
 
     char       sz_epsv_ip[NI_MAXNUMERICHOST];
+    bool       out;
 };
 #define GET_OUT_SYS( p_this ) \
     ((access_sys_t *)(((sout_access_out_t *)(p_this))->p_sys))
@@ -130,7 +132,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"),
+        intf_UserFatal( p_access, false, _("Network interaction failed"),
                         _("VLC could not connect with the given server.") );
         return -1;
     }
@@ -140,7 +142,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"),
+        intf_UserFatal( p_access, false, _("Network interaction failed"),
                         _("VLC's connection to the given server was rejected.") );
         return -1;
     }
@@ -151,6 +153,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 )
@@ -171,6 +175,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 )
@@ -200,7 +206,7 @@ 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,
+                        intf_UserFatal( p_access, false,
                                         _("Network interaction failed"),
                                         _("Your account was rejected.") );
                         return -1;
@@ -210,7 +216,7 @@ 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,
+                    intf_UserFatal( p_access, false,
                                     _("Network interaction failed"),
                                     _("Your password was rejected.") );
                     return -1;
@@ -218,7 +224,7 @@ static int Login( vlc_object_t *p_access, access_sys_t *p_sys )
             break;
         default:
             msg_Err( p_access, "user rejected" );
-            intf_UserFatal( p_access, VLC_FALSE,
+            intf_UserFatal( p_access, false,
                         _("Network interaction failed"),
                         _("Your connection attempt to the server was rejected.") );
             return -1;
@@ -281,7 +287,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 == '/' )
@@ -290,7 +296,7 @@ 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 */
@@ -298,10 +304,10 @@ static int parseURL( vlc_url_t *url, const char *path )
     /* FTP URLs are relative to user's default directory (RFC1738)
     For absolute path use ftp://foo.bar//usr/local/etc/filename */
 
-    if( *url->psz_path == '/' )
+    if( url->psz_path && *url->psz_path == '/' )
         url->psz_path++;
 
-    return 0;
+    return VLC_SUCCESS;
 }
 
 
@@ -317,6 +323,7 @@ static int InOpen( vlc_object_t *p_this )
     /* Init p_access */
     STANDARD_READ_ACCESS_INIT
     p_sys->fd_data = -1;
+    p_sys->out = false;
 
     if( parseURL( &p_sys->url, p_access->psz_path ) )
         goto exit_error;
@@ -325,7 +332,7 @@ static int InOpen( vlc_object_t *p_this )
         goto exit_error;
 
     /* get size */
-    if( ftp_SendCommand( p_this, p_sys, "SIZE %s", p_sys->url.psz_path ) < 0 ||
+    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" );
@@ -334,7 +341,7 @@ static int InOpen( vlc_object_t *p_this )
     }
     p_access->info.i_size = atoll( &psz_arg[4] );
     free( psz_arg );
-    msg_Dbg( p_access, "file size: "I64Fd, p_access->info.i_size );
+    msg_Dbg( p_access, "file size: %"PRId64, p_access->info.i_size );
 
     /* Start the 'stream' */
     if( ftp_StartStream( p_this, p_sys, 0 ) < 0 )
@@ -367,6 +374,7 @@ static int OutOpen( vlc_object_t *p_this )
 
     /* Init p_access */
     p_sys->fd_data = -1;
+    p_sys->out = true;
 
     if( parseURL( &p_sys->url, p_access->psz_path ) )
         goto exit_error;
@@ -436,7 +444,7 @@ static int _Seek( vlc_object_t *p_access, access_sys_t *p_sys, int64_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 %"PRId64, i_pos );
 
     ftp_StopStream( (vlc_object_t *)p_access, p_sys );
     if( ftp_StartStream( (vlc_object_t *)p_access, p_sys, i_pos ) < 0 )
@@ -451,7 +459,7 @@ static int Seek( access_t *p_access, int64_t 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;
@@ -471,15 +479,15 @@ static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
     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 );
+                       false );
     if( i_read == 0 )
-        p_access->info.b_eof = VLC_TRUE;
+        p_access->info.b_eof = true;
     else if( i_read > 0 )
         p_access->info.i_pos += i_read;
 
@@ -515,7 +523,7 @@ static ssize_t 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;
+    bool   *pb_bool;
     int          *pi_int;
     int64_t      *pi_64;
     vlc_value_t  val;
@@ -524,20 +532,20 @@ static int Control( access_t *p_access, int i_query, va_list args )
     {
         /* */
         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;
 
         /* */
@@ -549,12 +557,12 @@ static int Control( access_t *p_access, int i_query, va_list args )
         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 = (int64_t)var_GetInteger( p_access, "ftp-caching" ) * INT64_C(1000);
             break;
 
         /* */
         case ACCESS_SET_PAUSE_STATE:
-            pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
+            pb_bool = (bool*)va_arg( args, bool* );
             if ( !pb_bool )
               return Seek( p_access, p_access->info.i_pos );
             break;
@@ -585,10 +593,13 @@ 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 )
     {
@@ -623,7 +634,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;
@@ -734,7 +745,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" );
@@ -754,17 +765,15 @@ static int ftp_StartStream( vlc_object_t *p_access, access_sys_t *p_sys,
 
     /* "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 ||
+                         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_access->i_object_type == VLC_OBJECT_ACCESS ) );
+    shutdown( p_sys->fd_data, p_sys->out ? SHUT_RD : SHUT_WR );
 
     return VLC_SUCCESS;
 }
@@ -782,16 +791,13 @@ static int ftp_StopStream ( vlc_object_t *p_access, access_sys_t *p_sys )
 
     if( p_sys->fd_data != -1 )
     {
-        int i_answer;
-        ftp_ReadCommand( p_access, p_sys, &i_answer, NULL );
-        if ( i_answer != 227 )
-            /* If answer is from the previous command,
-             * rathen that succesful ABOR - read next command */
-            ftp_ReadCommand( p_access, p_sys, NULL, NULL );
-
         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;
 }