1 /*****************************************************************************
2 * ftp.c: FTP input module
3 *****************************************************************************
4 * Copyright (C) 2001-2006 the VideoLAN team
5 * Copyright © 2006 Rémi Denis-Courmont
8 * Authors: Laurent Aimar <fenrir@via.ecp.fr> - original code
9 * Rémi Denis-Courmont <rem # videolan.org> - EPSV support
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
26 /*****************************************************************************
28 *****************************************************************************/
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
38 #include <vlc_access.h>
39 #include <vlc_interface.h>
41 #include <vlc_network.h>
46 # define IPPORT_FTP 21u
49 /*****************************************************************************
51 *****************************************************************************/
52 static int InOpen ( vlc_object_t * );
53 static void InClose( vlc_object_t * );
54 static int OutOpen ( vlc_object_t * );
55 static void OutClose( vlc_object_t * );
57 #define CACHING_TEXT N_("Caching value in ms")
58 #define CACHING_LONGTEXT N_( \
59 "Caching value for FTP streams. This " \
60 "value should be set in milliseconds." )
61 #define USER_TEXT N_("FTP user name")
62 #define USER_LONGTEXT N_("User name that will " \
63 "be used for the connection.")
64 #define PASS_TEXT N_("FTP password")
65 #define PASS_LONGTEXT N_("Password that will be " \
66 "used for the connection.")
67 #define ACCOUNT_TEXT N_("FTP account")
68 #define ACCOUNT_LONGTEXT N_("Account that will be " \
69 "used for the connection.")
72 set_shortname( "FTP" )
73 set_description( N_("FTP input") )
74 set_capability( "access", 0 )
75 set_category( CAT_INPUT )
76 set_subcategory( SUBCAT_INPUT_ACCESS )
77 add_integer( "ftp-caching", 2 * DEFAULT_PTS_DELAY / 1000, NULL,
78 CACHING_TEXT, CACHING_LONGTEXT, true )
79 add_string( "ftp-user", "anonymous", NULL, USER_TEXT, USER_LONGTEXT,
81 add_string( "ftp-pwd", "anonymous@example.com", NULL, PASS_TEXT,
82 PASS_LONGTEXT, false )
83 add_string( "ftp-account", "anonymous", NULL, ACCOUNT_TEXT,
84 ACCOUNT_LONGTEXT, false )
86 set_callbacks( InOpen, InClose )
89 set_shortname( "FTP" )
90 set_description( N_("FTP upload output") )
91 set_capability( "sout access", 0 )
92 set_category( CAT_SOUT )
93 set_subcategory( SUBCAT_SOUT_ACO )
94 set_callbacks( OutOpen, OutClose )
97 /*****************************************************************************
99 *****************************************************************************/
100 static ssize_t Read( access_t *, uint8_t *, size_t );
101 static ssize_t Write( sout_access_out_t *, block_t * );
102 static int Seek( access_t *, int64_t );
103 static int OutSeek( sout_access_out_t *, off_t );
104 static int Control( access_t *, int, va_list );
113 char sz_epsv_ip[NI_MAXNUMERICHOST];
116 #define GET_OUT_SYS( p_this ) \
117 ((access_sys_t *)(((sout_access_out_t *)(p_this))->p_sys))
119 static int ftp_SendCommand( vlc_object_t *, access_sys_t *, const char *, ... );
120 static int ftp_ReadCommand( vlc_object_t *, access_sys_t *, int *, char ** );
121 static int ftp_StartStream( vlc_object_t *, access_sys_t *, int64_t );
122 static int ftp_StopStream ( vlc_object_t *, access_sys_t * );
124 static int Login( vlc_object_t *p_access, access_sys_t *p_sys )
129 /* *** Open a TCP connection with server *** */
130 int fd = p_sys->fd_cmd = net_ConnectTCP( p_access, p_sys->url.psz_host,
134 msg_Err( p_access, "connection failed" );
135 intf_UserFatal( p_access, false, _("Network interaction failed"),
136 _("VLC could not connect with the given server.") );
140 while( ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) == 1 );
142 if( i_answer / 100 != 2 )
144 msg_Err( p_access, "connection rejected" );
145 intf_UserFatal( p_access, false, _("Network interaction failed"),
146 _("VLC's connection to the given server was rejected.") );
150 msg_Dbg( p_access, "connection accepted (%d)", i_answer );
152 if( p_sys->url.psz_username && *p_sys->url.psz_username )
153 psz = strdup( p_sys->url.psz_username );
155 psz = var_CreateGetString( p_access, "ftp-user" );
159 if( ftp_SendCommand( p_access, p_sys, "USER %s", psz ) < 0 ||
160 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
167 switch( i_answer / 100 )
170 msg_Dbg( p_access, "user accepted" );
173 msg_Dbg( p_access, "password needed" );
174 if( p_sys->url.psz_password && *p_sys->url.psz_password )
175 psz = strdup( p_sys->url.psz_password );
177 psz = var_CreateGetString( p_access, "ftp-pwd" );
181 if( ftp_SendCommand( p_access, p_sys, "PASS %s", psz ) < 0 ||
182 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
189 switch( i_answer / 100 )
192 msg_Dbg( p_access, "password accepted" );
195 msg_Dbg( p_access, "account needed" );
196 psz = var_CreateGetString( p_access, "ftp-account" );
197 if( ftp_SendCommand( p_access, p_sys, "ACCT %s",
199 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
206 if( i_answer / 100 != 2 )
208 msg_Err( p_access, "account rejected" );
209 intf_UserFatal( p_access, false,
210 _("Network interaction failed"),
211 _("Your account was rejected.") );
214 msg_Dbg( p_access, "account accepted" );
218 msg_Err( p_access, "password rejected" );
219 intf_UserFatal( p_access, false,
220 _("Network interaction failed"),
221 _("Your password was rejected.") );
226 msg_Err( p_access, "user rejected" );
227 intf_UserFatal( p_access, false,
228 _("Network interaction failed"),
229 _("Your connection attempt to the server was rejected.") );
236 static int Connect( vlc_object_t *p_access, access_sys_t *p_sys )
238 if( Login( p_access, p_sys ) < 0 )
241 /* Extended passive mode */
242 if( ftp_SendCommand( p_access, p_sys, "EPSV ALL" ) < 0 )
244 msg_Err( p_access, "cannot request extended passive mode" );
245 net_Close( p_sys->fd_cmd );
249 if( ftp_ReadCommand( p_access, p_sys, NULL, NULL ) == 2 )
251 if( net_GetPeerAddress( p_sys->fd_cmd, p_sys->sz_epsv_ip, NULL ) )
253 net_Close( p_sys->fd_cmd );
259 /* If ESPV ALL fails, we fallback to PASV.
260 * We have to restart the connection in case there is a NAT that
261 * understands EPSV ALL in the way, and hence won't allow PASV on
262 * the initial connection.
264 msg_Info( p_access, "FTP Extended passive mode disabled" );
265 net_Close( p_sys->fd_cmd );
267 if( Login( p_access, p_sys ) )
269 net_Close( p_sys->fd_cmd );
274 /* check binary mode support */
275 if( ftp_SendCommand( p_access, p_sys, "TYPE I" ) < 0 ||
276 ftp_ReadCommand( p_access, p_sys, NULL, NULL ) != 2 )
278 msg_Err( p_access, "cannot set binary transfer mode" );
279 net_Close( p_sys->fd_cmd );
287 static int parseURL( vlc_url_t *url, const char *path )
292 /* *** Parse URL and get server addr/port and path *** */
293 while( *path == '/' )
296 vlc_UrlParse( url, path, 0 );
298 if( url->psz_host == NULL || *url->psz_host == '\0' )
301 if( url->i_port <= 0 )
302 url->i_port = IPPORT_FTP; /* default port */
304 /* FTP URLs are relative to user's default directory (RFC1738)
305 For absolute path use ftp://foo.bar//usr/local/etc/filename */
307 if( url->psz_path && *url->psz_path == '/' )
314 /****************************************************************************
315 * Open: connect to ftp server and ask for file
316 ****************************************************************************/
317 static int InOpen( vlc_object_t *p_this )
319 access_t *p_access = (access_t*)p_this;
324 STANDARD_READ_ACCESS_INIT
328 if( parseURL( &p_sys->url, p_access->psz_path ) )
331 if( Connect( p_this, p_sys ) )
335 if( ftp_SendCommand( p_this, p_sys, "SIZE %s", p_sys->url.psz_path ? : "" ) < 0 ||
336 ftp_ReadCommand( p_this, p_sys, NULL, &psz_arg ) != 2 )
338 msg_Err( p_access, "cannot get file size" );
339 net_Close( p_sys->fd_cmd );
342 p_access->info.i_size = atoll( &psz_arg[4] );
344 msg_Dbg( p_access, "file size: %"PRId64, p_access->info.i_size );
346 /* Start the 'stream' */
347 if( ftp_StartStream( p_this, p_sys, 0 ) < 0 )
349 msg_Err( p_access, "cannot retrieve file" );
350 net_Close( p_sys->fd_cmd );
354 /* Update default_pts to a suitable value for ftp access */
355 var_Create( p_access, "ftp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
360 vlc_UrlClean( &p_sys->url );
365 static int OutOpen( vlc_object_t *p_this )
367 sout_access_out_t *p_access = (sout_access_out_t *)p_this;
370 p_sys = calloc( 1, sizeof( *p_sys ) );
378 if( parseURL( &p_sys->url, p_access->psz_path ) )
381 if( Connect( p_this, p_sys ) )
384 /* Start the 'stream' */
385 if( ftp_StartStream( p_this, p_sys, 0 ) < 0 )
387 msg_Err( p_access, "cannot store file" );
388 net_Close( p_sys->fd_cmd );
392 p_access->pf_seek = OutSeek;
393 p_access->pf_write = Write;
394 p_access->p_sys = (void *)p_sys;
399 vlc_UrlClean( &p_sys->url );
404 /*****************************************************************************
405 * Close: free unused data structures
406 *****************************************************************************/
407 static void Close( vlc_object_t *p_access, access_sys_t *p_sys )
409 msg_Dbg( p_access, "stopping stream" );
410 ftp_StopStream( p_access, p_sys );
412 if( ftp_SendCommand( p_access, p_sys, "QUIT" ) < 0 )
414 msg_Warn( p_access, "cannot quit" );
418 ftp_ReadCommand( p_access, p_sys, NULL, NULL );
420 net_Close( p_sys->fd_cmd );
423 vlc_UrlClean( &p_sys->url );
427 static void InClose( vlc_object_t *p_this )
429 Close( p_this, ((access_t *)p_this)->p_sys);
432 static void OutClose( vlc_object_t *p_this )
434 Close( p_this, GET_OUT_SYS(p_this));
438 /*****************************************************************************
439 * Seek: try to go at the right place
440 *****************************************************************************/
441 static int _Seek( vlc_object_t *p_access, access_sys_t *p_sys, int64_t i_pos )
446 msg_Dbg( p_access, "seeking to %"PRId64, i_pos );
448 ftp_StopStream( (vlc_object_t *)p_access, p_sys );
449 if( ftp_StartStream( (vlc_object_t *)p_access, p_sys, i_pos ) < 0 )
455 static int Seek( access_t *p_access, int64_t i_pos )
457 int val = _Seek( (vlc_object_t *)p_access, p_access->p_sys, i_pos );
461 p_access->info.b_eof = false;
462 p_access->info.i_pos = i_pos;
467 static int OutSeek( sout_access_out_t *p_access, off_t i_pos )
469 return _Seek( (vlc_object_t *)p_access, GET_OUT_SYS( p_access ), i_pos);
472 /*****************************************************************************
474 *****************************************************************************/
475 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
477 access_sys_t *p_sys = p_access->p_sys;
480 assert( p_sys->fd_data != -1 );
481 assert( !p_sys->out );
483 if( p_access->info.b_eof )
486 i_read = net_Read( p_access, p_sys->fd_data, NULL, p_buffer, i_len,
489 p_access->info.b_eof = true;
490 else if( i_read > 0 )
491 p_access->info.i_pos += i_read;
496 /*****************************************************************************
498 *****************************************************************************/
499 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
501 access_sys_t *p_sys = GET_OUT_SYS(p_access);
504 assert( p_sys->fd_data != -1 );
506 while( p_buffer != NULL )
508 block_t *p_next = p_buffer->p_next;;
510 i_write += net_Write( p_access, p_sys->fd_data, NULL,
511 p_buffer->p_buffer, p_buffer->i_buffer );
512 block_Release( p_buffer );
520 /*****************************************************************************
522 *****************************************************************************/
523 static int Control( access_t *p_access, int i_query, va_list args )
532 case ACCESS_CAN_SEEK:
533 pb_bool = (bool*)va_arg( args, bool* );
536 case ACCESS_CAN_FASTSEEK:
537 pb_bool = (bool*)va_arg( args, bool* );
540 case ACCESS_CAN_PAUSE:
541 pb_bool = (bool*)va_arg( args, bool* );
542 *pb_bool = true; /* FIXME */
544 case ACCESS_CAN_CONTROL_PACE:
545 pb_bool = (bool*)va_arg( args, bool* );
546 *pb_bool = true; /* FIXME */
551 pi_int = (int*)va_arg( args, int * );
555 case ACCESS_GET_PTS_DELAY:
556 pi_64 = (int64_t*)va_arg( args, int64_t * );
557 *pi_64 = (int64_t)var_GetInteger( p_access, "ftp-caching" ) * INT64_C(1000);
561 case ACCESS_SET_PAUSE_STATE:
562 pb_bool = (bool*)va_arg( args, bool* );
564 return Seek( p_access, p_access->info.i_pos );
567 case ACCESS_GET_TITLE_INFO:
568 case ACCESS_SET_TITLE:
569 case ACCESS_SET_SEEKPOINT:
570 case ACCESS_SET_PRIVATE_ID_STATE:
571 case ACCESS_GET_CONTENT_TYPE:
572 case ACCESS_GET_META:
576 msg_Warn( p_access, "unimplemented query in control: %d", i_query);
583 /*****************************************************************************
585 *****************************************************************************/
586 static int ftp_SendCommand( vlc_object_t *p_access, access_sys_t *p_sys,
587 const char *psz_fmt, ... )
592 va_start( args, psz_fmt );
593 if( vasprintf( &psz_cmd, psz_fmt, args ) == -1 )
598 msg_Dbg( p_access, "ftp_SendCommand:\"%s\"", psz_cmd);
600 if( net_Printf( VLC_OBJECT(p_access), p_sys->fd_cmd, NULL, "%s\r\n",
603 msg_Err( p_access, "failed to send command" );
609 /* TODO support this s**t :
610 RFC 959 allows the client to send certain TELNET strings at any moment,
611 even in the middle of a request:
614 * \377\376x where x is one byte.
615 * \377\375x where x is one byte. The server is obliged to send \377\374x
616 * immediately after reading x.
617 * \377\374x where x is one byte.
618 * \377\373x where x is one byte. The server is obliged to send \377\376x
619 * immediately after reading x.
620 * \377x for any other byte x.
622 These strings are not part of the requests, except in the case \377\377,
623 where the request contains one \377. */
624 static int ftp_ReadCommand( vlc_object_t *p_access, access_sys_t *p_sys,
625 int *pi_answer, char **ppsz_answer )
630 psz_line = net_Gets( p_access, p_sys->fd_cmd, NULL );
631 if( psz_line == NULL || strlen( psz_line ) < 3 )
633 msg_Err( p_access, "cannot get answer" );
635 if( pi_answer ) *pi_answer = 500;
636 if( ppsz_answer ) *ppsz_answer = NULL;
639 msg_Dbg( p_access, "answer=%s", psz_line );
641 if( psz_line[3] == '-' ) /* Multiple response */
645 memcpy( end, psz_line, 3 );
650 char *psz_tmp = net_Gets( p_access, p_sys->fd_cmd, NULL );
652 if( psz_tmp == NULL ) /* Error */
655 if( !strncmp( psz_tmp, end, 4 ) )
664 i_answer = atoi( psz_line );
666 if( pi_answer ) *pi_answer = i_answer;
669 *ppsz_answer = psz_line;
675 return( i_answer / 100 );
678 static int ftp_StartStream( vlc_object_t *p_access, access_sys_t *p_sys,
681 char psz_ipv4[16], *psz_ip = p_sys->sz_epsv_ip;
683 char *psz_arg, *psz_parser;
686 assert( p_sys->fd_data == -1 );
688 if( ( ftp_SendCommand( p_access, p_sys, *psz_ip ? "EPSV" : "PASV" ) < 0 )
689 || ( ftp_ReadCommand( p_access, p_sys, &i_answer, &psz_arg ) != 2 ) )
691 msg_Err( p_access, "cannot set passive mode" );
695 psz_parser = strchr( psz_arg, '(' );
696 if( psz_parser == NULL )
699 msg_Err( p_access, "cannot parse passive mode response" );
705 char psz_fmt[7] = "(|||%u";
706 psz_fmt[1] = psz_fmt[2] = psz_fmt[3] = psz_parser[1];
708 if( sscanf( psz_parser, psz_fmt, &i_port ) < 1 )
711 msg_Err( p_access, "cannot parse passive mode response" );
717 unsigned a1, a2, a3, a4, p1, p2;
719 if( ( sscanf( psz_parser, "(%u,%u,%u,%u,%u,%u", &a1, &a2, &a3, &a4,
720 &p1, &p2 ) < 6 ) || ( a1 > 255 ) || ( a2 > 255 )
721 || ( a3 > 255 ) || ( a4 > 255 ) || ( p1 > 255 ) || ( p2 > 255 ) )
724 msg_Err( p_access, "cannot parse passive mode response" );
728 sprintf( psz_ipv4, "%u.%u.%u.%u", a1, a2, a3, a4 );
730 i_port = (p1 << 8) | p2;
734 msg_Dbg( p_access, "ip:%s port:%d", psz_ip, i_port );
736 if( ftp_SendCommand( p_access, p_sys, "TYPE I" ) < 0 ||
737 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) != 2 )
739 msg_Err( p_access, "cannot set binary transfer mode" );
745 if( ftp_SendCommand( p_access, p_sys, "REST %"PRIu64, i_start ) < 0 ||
746 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) > 3 )
748 msg_Err( p_access, "cannot set restart offset" );
753 msg_Dbg( p_access, "waiting for data connection..." );
754 p_sys->fd_data = net_ConnectTCP( p_access, psz_ip, i_port );
755 if( p_sys->fd_data < 0 )
757 msg_Err( p_access, "failed to connect with server" );
760 msg_Dbg( p_access, "connection with \"%s:%d\" successful",
764 if( ftp_SendCommand( p_access, p_sys, "%s %s",
765 p_sys->out ? "STOR" : "RETR",
766 p_sys->url.psz_path ?: "" ) < 0 ||
767 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) > 2 )
769 msg_Err( p_access, "cannot retrieve file" );
773 shutdown( p_sys->fd_data, p_sys->out ? SHUT_RD : SHUT_WR );
778 static int ftp_StopStream ( vlc_object_t *p_access, access_sys_t *p_sys )
780 if( ftp_SendCommand( p_access, p_sys, "ABOR" ) < 0 )
782 msg_Warn( p_access, "cannot abort file" );
783 if( p_sys->fd_data > 0 )
784 net_Close( p_sys->fd_data );
789 if( p_sys->fd_data != -1 )
791 net_Close( p_sys->fd_data );
793 /* Read the final response from RETR/STOR, i.e. 426 or 226 */
794 ftp_ReadCommand( p_access, p_sys, NULL, NULL );
796 /* Read the response from ABOR, i.e. 226 or 225 */
797 ftp_ReadCommand( p_access, p_sys, NULL, NULL );