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_dialog.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 )
80 add_string( "ftp-user", "anonymous", NULL, USER_TEXT, USER_LONGTEXT,
82 add_password( "ftp-pwd", "anonymous@example.com", NULL, PASS_TEXT,
83 PASS_LONGTEXT, false )
84 add_string( "ftp-account", "anonymous", NULL, ACCOUNT_TEXT,
85 ACCOUNT_LONGTEXT, false )
87 set_callbacks( InOpen, InClose )
90 set_shortname( "FTP" )
91 set_description( N_("FTP upload output") )
92 set_capability( "sout access", 0 )
93 set_category( CAT_SOUT )
94 set_subcategory( SUBCAT_SOUT_ACO )
96 set_callbacks( OutOpen, OutClose )
99 /*****************************************************************************
101 *****************************************************************************/
102 static ssize_t Read( access_t *, uint8_t *, size_t );
103 static ssize_t Write( sout_access_out_t *, block_t * );
104 static int Seek( access_t *, int64_t );
105 static int OutSeek( sout_access_out_t *, off_t );
106 static int Control( access_t *, int, va_list );
115 char sz_epsv_ip[NI_MAXNUMERICHOST];
119 #define GET_OUT_SYS( p_this ) \
120 ((access_sys_t *)(((sout_access_out_t *)(p_this))->p_sys))
122 static int ftp_SendCommand( vlc_object_t *, access_sys_t *, const char *, ... );
123 static int ftp_ReadCommand( vlc_object_t *, access_sys_t *, int *, char ** );
124 static int ftp_StartStream( vlc_object_t *, access_sys_t *, int64_t );
125 static int ftp_StopStream ( vlc_object_t *, access_sys_t * );
127 static int Login( vlc_object_t *p_access, access_sys_t *p_sys )
132 /* *** Open a TCP connection with server *** */
133 int fd = p_sys->fd_cmd = net_ConnectTCP( p_access, p_sys->url.psz_host,
137 msg_Err( p_access, "connection failed" );
138 dialog_Fatal( p_access, _("Network interaction failed"), "%s",
139 _("VLC could not connect with the given server.") );
143 while( ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) == 1 );
145 if( i_answer / 100 != 2 )
147 msg_Err( p_access, "connection rejected" );
148 dialog_Fatal( p_access, _("Network interaction failed"), "%s",
149 _("VLC's connection to the given server was rejected.") );
153 msg_Dbg( p_access, "connection accepted (%d)", i_answer );
155 if( p_sys->url.psz_username && *p_sys->url.psz_username )
156 psz = strdup( p_sys->url.psz_username );
158 psz = var_CreateGetString( p_access, "ftp-user" );
162 if( ftp_SendCommand( p_access, p_sys, "USER %s", psz ) < 0 ||
163 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
170 switch( i_answer / 100 )
173 msg_Dbg( p_access, "user accepted" );
176 msg_Dbg( p_access, "password needed" );
177 if( p_sys->url.psz_password && *p_sys->url.psz_password )
178 psz = strdup( p_sys->url.psz_password );
180 psz = var_CreateGetString( p_access, "ftp-pwd" );
184 if( ftp_SendCommand( p_access, p_sys, "PASS %s", psz ) < 0 ||
185 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
192 switch( i_answer / 100 )
195 msg_Dbg( p_access, "password accepted" );
198 msg_Dbg( p_access, "account needed" );
199 psz = var_CreateGetString( p_access, "ftp-account" );
200 if( ftp_SendCommand( p_access, p_sys, "ACCT %s",
202 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
209 if( i_answer / 100 != 2 )
211 msg_Err( p_access, "account rejected" );
212 dialog_Fatal( p_access,
213 _("Network interaction failed"),
214 "%s", _("Your account was rejected.") );
217 msg_Dbg( p_access, "account accepted" );
221 msg_Err( p_access, "password rejected" );
222 dialog_Fatal( p_access, _("Network interaction failed"),
223 "%s", _("Your password was rejected.") );
228 msg_Err( p_access, "user rejected" );
229 dialog_Fatal( p_access, _("Network interaction failed"), "%s",
230 _("Your connection attempt to the server was rejected.") );
237 static int Connect( vlc_object_t *p_access, access_sys_t *p_sys )
239 if( Login( p_access, p_sys ) < 0 )
242 /* Extended passive mode */
243 if( ftp_SendCommand( p_access, p_sys, "EPSV ALL" ) < 0 )
245 msg_Err( p_access, "cannot request extended passive mode" );
246 net_Close( p_sys->fd_cmd );
250 if( ftp_ReadCommand( p_access, p_sys, NULL, NULL ) == 2 )
252 if( net_GetPeerAddress( p_sys->fd_cmd, p_sys->sz_epsv_ip, NULL ) )
254 net_Close( p_sys->fd_cmd );
260 /* If ESPV ALL fails, we fallback to PASV.
261 * We have to restart the connection in case there is a NAT that
262 * understands EPSV ALL in the way, and hence won't allow PASV on
263 * the initial connection.
265 msg_Info( p_access, "FTP Extended passive mode disabled" );
266 net_Close( p_sys->fd_cmd );
268 if( Login( p_access, p_sys ) )
270 net_Close( p_sys->fd_cmd );
275 /* check binary mode support */
276 if( ftp_SendCommand( p_access, p_sys, "TYPE I" ) < 0 ||
277 ftp_ReadCommand( p_access, p_sys, NULL, NULL ) != 2 )
279 msg_Err( p_access, "cannot set binary transfer mode" );
280 net_Close( p_sys->fd_cmd );
288 static int parseURL( vlc_url_t *url, const char *path )
293 /* *** Parse URL and get server addr/port and path *** */
294 while( *path == '/' )
297 vlc_UrlParse( url, path, 0 );
299 if( url->psz_host == NULL || *url->psz_host == '\0' )
302 if( url->i_port <= 0 )
303 url->i_port = IPPORT_FTP; /* default port */
305 /* FTP URLs are relative to user's default directory (RFC1738)
306 For absolute path use ftp://foo.bar//usr/local/etc/filename */
308 if( url->psz_path && *url->psz_path == '/' )
315 /****************************************************************************
316 * Open: connect to ftp server and ask for file
317 ****************************************************************************/
318 static int InOpen( vlc_object_t *p_this )
320 access_t *p_access = (access_t*)p_this;
325 STANDARD_READ_ACCESS_INIT
328 p_sys->directory = false;
330 if( parseURL( &p_sys->url, p_access->psz_path ) )
333 if( Connect( p_this, p_sys ) )
337 if( ftp_SendCommand( p_this, p_sys, "SIZE %s", p_sys->url.psz_path
338 ? p_sys->url.psz_path : "" ) < 0
339 || ftp_ReadCommand( p_this, p_sys, NULL, &psz_arg ) != 2 )
341 msg_Dbg( p_access, "cannot get file size" );
342 msg_Dbg( p_access, "will try to get directory contents" );
343 if( ftp_SendCommand( p_this, p_sys, "CWD %s", p_sys->url.psz_path
344 ? p_sys->url.psz_path : "" ) < 0 ||
345 ftp_ReadCommand( p_this, p_sys, NULL, &psz_arg ) != 2 )
347 msg_Err( p_access, "file or directory doesn't exist" );
348 net_Close( p_sys->fd_cmd );
351 p_sys->directory = true;
355 p_access->info.i_size = atoll( &psz_arg[4] );
357 msg_Dbg( p_access, "file size: %"PRId64, p_access->info.i_size );
360 /* Start the 'stream' */
361 if( ftp_StartStream( p_this, p_sys, 0 ) < 0 )
363 msg_Err( p_access, "cannot retrieve file" );
364 net_Close( p_sys->fd_cmd );
368 /* Update default_pts to a suitable value for ftp access */
369 var_Create( p_access, "ftp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
374 vlc_UrlClean( &p_sys->url );
379 static int OutOpen( vlc_object_t *p_this )
381 sout_access_out_t *p_access = (sout_access_out_t *)p_this;
384 p_sys = calloc( 1, sizeof( *p_sys ) );
392 if( parseURL( &p_sys->url, p_access->psz_path ) )
395 if( Connect( p_this, p_sys ) )
398 /* Start the 'stream' */
399 if( ftp_StartStream( p_this, p_sys, 0 ) < 0 )
401 msg_Err( p_access, "cannot store file" );
402 net_Close( p_sys->fd_cmd );
406 p_access->pf_seek = OutSeek;
407 p_access->pf_write = Write;
408 p_access->p_sys = (void *)p_sys;
413 vlc_UrlClean( &p_sys->url );
418 /*****************************************************************************
419 * Close: free unused data structures
420 *****************************************************************************/
421 static void Close( vlc_object_t *p_access, access_sys_t *p_sys )
423 msg_Dbg( p_access, "stopping stream" );
424 ftp_StopStream( p_access, p_sys );
426 if( ftp_SendCommand( p_access, p_sys, "QUIT" ) < 0 )
428 msg_Warn( p_access, "cannot quit" );
432 ftp_ReadCommand( p_access, p_sys, NULL, NULL );
434 net_Close( p_sys->fd_cmd );
437 vlc_UrlClean( &p_sys->url );
441 static void InClose( vlc_object_t *p_this )
443 Close( p_this, ((access_t *)p_this)->p_sys);
446 static void OutClose( vlc_object_t *p_this )
448 Close( p_this, GET_OUT_SYS(p_this));
452 /*****************************************************************************
453 * Seek: try to go at the right place
454 *****************************************************************************/
455 static int _Seek( vlc_object_t *p_access, access_sys_t *p_sys, int64_t i_pos )
460 msg_Dbg( p_access, "seeking to %"PRId64, i_pos );
462 ftp_StopStream( (vlc_object_t *)p_access, p_sys );
463 if( ftp_StartStream( (vlc_object_t *)p_access, p_sys, i_pos ) < 0 )
469 static int Seek( access_t *p_access, int64_t i_pos )
471 int val = _Seek( (vlc_object_t *)p_access, p_access->p_sys, i_pos );
475 p_access->info.b_eof = false;
476 p_access->info.i_pos = i_pos;
481 static int OutSeek( sout_access_out_t *p_access, off_t i_pos )
483 return _Seek( (vlc_object_t *)p_access, GET_OUT_SYS( p_access ), i_pos);
486 /*****************************************************************************
488 *****************************************************************************/
489 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
491 access_sys_t *p_sys = p_access->p_sys;
493 assert( p_sys->fd_data != -1 );
494 assert( !p_sys->out );
496 if( p_access->info.b_eof )
499 if( p_sys->directory )
501 char *psz_line = net_Gets( p_access, p_sys->fd_data, NULL );
504 p_access->info.b_eof = true;
509 snprintf( (char*)p_buffer, i_len, "ftp://%s:%d/%s/%s\n",
510 p_sys->url.psz_host, p_sys->url.i_port,
511 p_sys->url.psz_path, psz_line );
513 return strlen( (const char *)p_buffer );
518 int i_read = net_Read( p_access, p_sys->fd_data, NULL,
519 p_buffer, i_len, false );
521 p_access->info.b_eof = true;
522 else if( i_read > 0 )
523 p_access->info.i_pos += i_read;
529 /*****************************************************************************
531 *****************************************************************************/
532 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
534 access_sys_t *p_sys = GET_OUT_SYS(p_access);
537 assert( p_sys->fd_data != -1 );
539 while( p_buffer != NULL )
541 block_t *p_next = p_buffer->p_next;;
543 i_write += net_Write( p_access, p_sys->fd_data, NULL,
544 p_buffer->p_buffer, p_buffer->i_buffer );
545 block_Release( p_buffer );
553 /*****************************************************************************
555 *****************************************************************************/
556 static int Control( access_t *p_access, int i_query, va_list args )
564 case ACCESS_CAN_SEEK:
565 pb_bool = (bool*)va_arg( args, bool* );
568 case ACCESS_CAN_FASTSEEK:
569 pb_bool = (bool*)va_arg( args, bool* );
572 case ACCESS_CAN_PAUSE:
573 pb_bool = (bool*)va_arg( args, bool* );
574 *pb_bool = true; /* FIXME */
576 case ACCESS_CAN_CONTROL_PACE:
577 pb_bool = (bool*)va_arg( args, bool* );
578 *pb_bool = true; /* FIXME */
582 case ACCESS_GET_PTS_DELAY:
583 pi_64 = (int64_t*)va_arg( args, int64_t * );
584 *pi_64 = (int64_t)var_GetInteger( p_access, "ftp-caching" ) * INT64_C(1000);
588 case ACCESS_SET_PAUSE_STATE:
589 pb_bool = (bool*)va_arg( args, bool* );
591 return Seek( p_access, p_access->info.i_pos );
594 case ACCESS_GET_TITLE_INFO:
595 case ACCESS_SET_TITLE:
596 case ACCESS_SET_SEEKPOINT:
597 case ACCESS_SET_PRIVATE_ID_STATE:
598 case ACCESS_GET_CONTENT_TYPE:
599 case ACCESS_GET_META:
603 msg_Warn( p_access, "unimplemented query in control: %d", i_query);
610 /*****************************************************************************
612 *****************************************************************************/
613 static int ftp_SendCommand( vlc_object_t *p_access, access_sys_t *p_sys,
614 const char *psz_fmt, ... )
619 va_start( args, psz_fmt );
620 if( vasprintf( &psz_cmd, psz_fmt, args ) == -1 )
625 msg_Dbg( p_access, "ftp_SendCommand:\"%s\"", psz_cmd);
627 if( net_Printf( VLC_OBJECT(p_access), p_sys->fd_cmd, NULL, "%s\r\n",
630 msg_Err( p_access, "failed to send command" );
636 /* TODO support this s**t :
637 RFC 959 allows the client to send certain TELNET strings at any moment,
638 even in the middle of a request:
641 * \377\376x where x is one byte.
642 * \377\375x where x is one byte. The server is obliged to send \377\374x
643 * immediately after reading x.
644 * \377\374x where x is one byte.
645 * \377\373x where x is one byte. The server is obliged to send \377\376x
646 * immediately after reading x.
647 * \377x for any other byte x.
649 These strings are not part of the requests, except in the case \377\377,
650 where the request contains one \377. */
651 static int ftp_ReadCommand( vlc_object_t *p_access, access_sys_t *p_sys,
652 int *pi_answer, char **ppsz_answer )
657 psz_line = net_Gets( p_access, p_sys->fd_cmd, NULL );
658 if( psz_line == NULL || strlen( psz_line ) < 3 )
660 msg_Err( p_access, "cannot get answer" );
662 if( pi_answer ) *pi_answer = 500;
663 if( ppsz_answer ) *ppsz_answer = NULL;
666 msg_Dbg( p_access, "answer=%s", psz_line );
668 if( psz_line[3] == '-' ) /* Multiple response */
672 memcpy( end, psz_line, 3 );
677 char *psz_tmp = net_Gets( p_access, p_sys->fd_cmd, NULL );
679 if( psz_tmp == NULL ) /* Error */
682 if( !strncmp( psz_tmp, end, 4 ) )
691 i_answer = atoi( psz_line );
693 if( pi_answer ) *pi_answer = i_answer;
696 *ppsz_answer = psz_line;
702 return( i_answer / 100 );
705 static int ftp_StartStream( vlc_object_t *p_access, access_sys_t *p_sys,
708 char psz_ipv4[16], *psz_ip = p_sys->sz_epsv_ip;
710 char *psz_arg, *psz_parser;
713 assert( p_sys->fd_data == -1 );
715 if( ( ftp_SendCommand( p_access, p_sys, *psz_ip ? "EPSV" : "PASV" ) < 0 )
716 || ( ftp_ReadCommand( p_access, p_sys, &i_answer, &psz_arg ) != 2 ) )
718 msg_Err( p_access, "cannot set passive mode" );
722 psz_parser = strchr( psz_arg, '(' );
723 if( psz_parser == NULL )
726 msg_Err( p_access, "cannot parse passive mode response" );
732 char psz_fmt[7] = "(|||%u";
733 psz_fmt[1] = psz_fmt[2] = psz_fmt[3] = psz_parser[1];
735 if( sscanf( psz_parser, psz_fmt, &i_port ) < 1 )
738 msg_Err( p_access, "cannot parse passive mode response" );
744 unsigned a1, a2, a3, a4, p1, p2;
746 if( ( sscanf( psz_parser, "(%u,%u,%u,%u,%u,%u", &a1, &a2, &a3, &a4,
747 &p1, &p2 ) < 6 ) || ( a1 > 255 ) || ( a2 > 255 )
748 || ( a3 > 255 ) || ( a4 > 255 ) || ( p1 > 255 ) || ( p2 > 255 ) )
751 msg_Err( p_access, "cannot parse passive mode response" );
755 sprintf( psz_ipv4, "%u.%u.%u.%u", a1, a2, a3, a4 );
757 i_port = (p1 << 8) | p2;
761 msg_Dbg( p_access, "ip:%s port:%d", psz_ip, i_port );
763 if( ftp_SendCommand( p_access, p_sys, "TYPE I" ) < 0 ||
764 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) != 2 )
766 msg_Err( p_access, "cannot set binary transfer mode" );
772 if( ftp_SendCommand( p_access, p_sys, "REST %"PRIu64, i_start ) < 0 ||
773 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) > 3 )
775 msg_Err( p_access, "cannot set restart offset" );
780 msg_Dbg( p_access, "waiting for data connection..." );
781 p_sys->fd_data = net_ConnectTCP( p_access, psz_ip, i_port );
782 if( p_sys->fd_data < 0 )
784 msg_Err( p_access, "failed to connect with server" );
787 msg_Dbg( p_access, "connection with \"%s:%d\" successful",
790 if( p_sys->directory )
792 if( ftp_SendCommand( p_access, p_sys, "NLST" ) < 0 ||
793 ftp_ReadCommand( p_access, p_sys, NULL, &psz_arg ) > 2 )
795 msg_Err( p_access, "cannot list directory contents" );
802 if( ftp_SendCommand( p_access, p_sys, "%s %s",
803 p_sys->out ? "STOR" : "RETR",
804 p_sys->url.psz_path ? p_sys->url.psz_path : "" ) < 0
805 || ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) > 2 )
807 msg_Err( p_access, "cannot retrieve file" );
812 shutdown( p_sys->fd_data, p_sys->out ? SHUT_RD : SHUT_WR );
817 static int ftp_StopStream ( vlc_object_t *p_access, access_sys_t *p_sys )
819 if( ftp_SendCommand( p_access, p_sys, "ABOR" ) < 0 )
821 msg_Warn( p_access, "cannot abort file" );
822 if( p_sys->fd_data > 0 )
823 net_Close( p_sys->fd_data );
828 if( p_sys->fd_data != -1 )
830 net_Close( p_sys->fd_data );
832 /* Read the final response from RETR/STOR, i.e. 426 or 226 */
833 ftp_ReadCommand( p_access, p_sys, NULL, NULL );
835 /* Read the response from ABOR, i.e. 226 or 225 */
836 ftp_ReadCommand( p_access, p_sys, NULL, NULL );