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/input.h>
34 #include <vlc_interaction.h>
38 #include "stream_output.h"
41 # define IPPORT_FTP 21u
44 /*****************************************************************************
46 *****************************************************************************/
47 static int InOpen ( vlc_object_t * );
48 static void InClose( vlc_object_t * );
49 static int OutOpen ( vlc_object_t * );
50 static void OutClose( vlc_object_t * );
52 #define CACHING_TEXT N_("Caching value in ms")
53 #define CACHING_LONGTEXT N_( \
54 "Caching value for FTP streams. This " \
55 "value should be set in milliseconds." )
56 #define USER_TEXT N_("FTP user name")
57 #define USER_LONGTEXT N_("User name that will " \
58 "be used for the connection.")
59 #define PASS_TEXT N_("FTP password")
60 #define PASS_LONGTEXT N_("Password that will be " \
61 "used for the connection.")
62 #define ACCOUNT_TEXT N_("FTP account")
63 #define ACCOUNT_LONGTEXT N_("Account that will be " \
64 "used for the connection.")
67 set_shortname( "FTP" );
68 set_description( _("FTP input") );
69 set_capability( "access2", 0 );
70 set_category( CAT_INPUT );
71 set_subcategory( SUBCAT_INPUT_ACCESS );
72 add_integer( "ftp-caching", 2 * DEFAULT_PTS_DELAY / 1000, NULL,
73 CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
74 add_string( "ftp-user", "anonymous", NULL, USER_TEXT, USER_LONGTEXT,
76 add_string( "ftp-pwd", "anonymous@example.com", NULL, PASS_TEXT,
77 PASS_LONGTEXT, VLC_FALSE );
78 add_string( "ftp-account", "anonymous", NULL, ACCOUNT_TEXT,
79 ACCOUNT_LONGTEXT, VLC_FALSE );
80 add_shortcut( "ftp" );
81 set_callbacks( InOpen, InClose );
84 set_shortname( "FTP" );
85 set_description( _("FTP upload output") );
86 set_capability( "sout access", 0 );
87 set_category( CAT_SOUT );
88 set_subcategory( SUBCAT_SOUT_ACO );
89 add_shortcut( "ftp" );
90 set_callbacks( OutOpen, OutClose );
93 /*****************************************************************************
95 *****************************************************************************/
96 static int Read( access_t *, uint8_t *, int );
97 static int Write( sout_access_out_t *, block_t * );
98 static int Seek( access_t *, int64_t );
99 static int OutSeek( sout_access_out_t *, int64_t );
100 static int Control( access_t *, int, va_list );
109 char sz_epsv_ip[NI_MAXNUMERICHOST];
111 #define GET_OUT_SYS( p_this ) \
112 ((access_sys_t *)(((sout_access_out_t *)(p_this))->p_sys))
114 static int ftp_SendCommand( vlc_object_t *, access_sys_t *, const char *, ... );
115 static int ftp_ReadCommand( vlc_object_t *, access_sys_t *, int *, char ** );
116 static int ftp_StartStream( vlc_object_t *, access_sys_t *, int64_t );
117 static int ftp_StopStream ( vlc_object_t *, access_sys_t * );
119 static int Login( vlc_object_t *p_access, access_sys_t *p_sys )
124 /* *** Open a TCP connection with server *** */
125 int fd = p_sys->fd_cmd = net_ConnectTCP( p_access, p_sys->url.psz_host,
129 msg_Err( p_access, "connection failed" );
130 intf_UserFatal( p_access, VLC_FALSE, _("Network interaction failed"),
131 _("VLC could not connect with the given server.") );
135 while( ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) == 1 );
137 if( i_answer / 100 != 2 )
139 msg_Err( p_access, "connection rejected" );
140 intf_UserFatal( p_access, VLC_FALSE, _("Network interaction failed"),
141 _("VLC's connection to the given server was rejected.") );
145 msg_Dbg( p_access, "connection accepted (%d)", i_answer );
147 if( p_sys->url.psz_username && *p_sys->url.psz_username )
148 psz = strdup( p_sys->url.psz_username );
150 psz = var_CreateGetString( p_access, "ftp-user" );
152 if( ftp_SendCommand( p_access, p_sys, "USER %s", psz ) < 0 ||
153 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
160 switch( i_answer / 100 )
163 msg_Dbg( p_access, "user accepted" );
166 msg_Dbg( p_access, "password needed" );
167 if( p_sys->url.psz_password && *p_sys->url.psz_password )
168 psz = strdup( p_sys->url.psz_password );
170 psz = var_CreateGetString( p_access, "ftp-pwd" );
172 if( ftp_SendCommand( p_access, p_sys, "PASS %s", psz ) < 0 ||
173 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
180 switch( i_answer / 100 )
183 msg_Dbg( p_access, "password accepted" );
186 msg_Dbg( p_access, "account needed" );
187 psz = var_CreateGetString( p_access, "ftp-account" );
188 if( ftp_SendCommand( p_access, p_sys, "ACCT %s",
190 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
197 if( i_answer / 100 != 2 )
199 msg_Err( p_access, "account rejected" );
200 intf_UserFatal( p_access, VLC_FALSE,
201 _("Network interaction failed"),
202 _("Your account was rejected.") );
205 msg_Dbg( p_access, "account accepted" );
209 msg_Err( p_access, "password rejected" );
210 intf_UserFatal( p_access, VLC_FALSE,
211 _("Network interaction failed"),
212 _("Your password was rejected.") );
217 msg_Err( p_access, "user rejected" );
218 intf_UserFatal( p_access, VLC_FALSE,
219 _("Network interaction failed"),
220 _("Your connection attemp to the server was rejected.") );
227 static int Connect( vlc_object_t *p_access, access_sys_t *p_sys )
229 if( Login( p_access, p_sys ) < 0 )
232 /* Extended passive mode */
233 if( ftp_SendCommand( p_access, p_sys, "EPSV ALL" ) < 0 )
235 msg_Err( p_access, "cannot request extended passive mode" );
236 net_Close( p_sys->fd_cmd );
240 if( ftp_ReadCommand( p_access, p_sys, NULL, NULL ) == 2 )
242 if( net_GetPeerAddress( p_sys->fd_cmd, p_sys->sz_epsv_ip, NULL ) )
244 net_Close( p_sys->fd_cmd );
250 /* If ESPV ALL fails, we fallback to PASV.
251 * We have to restart the connection in case there is a NAT that
252 * understands EPSV ALL in the way, and hence won't allow PASV on
253 * the initial connection.
255 msg_Info( p_access, "FTP Extended passive mode disabled" );
256 net_Close( p_sys->fd_cmd );
258 if( Login( p_access, p_sys ) )
260 net_Close( p_sys->fd_cmd );
265 /* check binary mode support */
266 if( ftp_SendCommand( p_access, p_sys, "TYPE I" ) < 0 ||
267 ftp_ReadCommand( p_access, p_sys, NULL, NULL ) != 2 )
269 msg_Err( p_access, "cannot set binary transfer mode" );
270 net_Close( p_sys->fd_cmd );
278 static int parseURL( vlc_url_t *url, const char *path )
283 /* *** Parse URL and get server addr/port and path *** */
284 while( *path == '/' )
287 vlc_UrlParse( url, path, 0 );
289 if( url->psz_host == NULL || *url->psz_host == '\0' )
292 if( url->i_port <= 0 )
293 url->i_port = IPPORT_FTP; /* default port */
295 /* FTP URLs are relative to user's default directory (RFC1738)
296 For absolute path use ftp://foo.bar//usr/local/etc/filename */
298 if( *url->psz_path == '/' )
305 /****************************************************************************
306 * Open: connect to ftp server and ask for file
307 ****************************************************************************/
308 static int InOpen( vlc_object_t *p_this )
310 access_t *p_access = (access_t*)p_this;
315 STANDARD_READ_ACCESS_INIT
318 if( parseURL( &p_sys->url, p_access->psz_path ) )
321 if( Connect( p_this, p_sys ) )
325 if( ftp_SendCommand( p_this, p_sys, "SIZE %s", p_sys->url.psz_path ) < 0 ||
326 ftp_ReadCommand( p_this, p_sys, NULL, &psz_arg ) != 2 )
328 msg_Err( p_access, "cannot get file size" );
329 net_Close( p_sys->fd_cmd );
332 p_access->info.i_size = atoll( &psz_arg[4] );
334 msg_Dbg( p_access, "file size: "I64Fd, p_access->info.i_size );
336 /* Start the 'stream' */
337 if( ftp_StartStream( p_this, p_sys, 0 ) < 0 )
339 msg_Err( p_access, "cannot retrieve file" );
340 net_Close( p_sys->fd_cmd );
344 /* Update default_pts to a suitable value for ftp access */
345 var_Create( p_access, "ftp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
350 vlc_UrlClean( &p_sys->url );
355 static int OutOpen( vlc_object_t *p_this )
357 sout_access_out_t *p_access = (sout_access_out_t *)p_this;
360 p_sys = malloc( sizeof( *p_sys ) );
363 memset( p_sys, 0, sizeof( *p_sys ) );
368 if( parseURL( &p_sys->url, p_access->psz_name ) )
371 if( Connect( p_this, p_sys ) )
374 /* Start the 'stream' */
375 if( ftp_StartStream( p_this, p_sys, 0 ) < 0 )
377 msg_Err( p_access, "cannot store file" );
378 net_Close( p_sys->fd_cmd );
382 p_access->pf_seek = OutSeek;
383 p_access->pf_write = Write;
384 p_access->p_sys = p_sys;
389 vlc_UrlClean( &p_sys->url );
394 /*****************************************************************************
395 * Close: free unused data structures
396 *****************************************************************************/
397 static void Close( vlc_object_t *p_access, access_sys_t *p_sys )
399 msg_Dbg( p_access, "stopping stream" );
400 ftp_StopStream( p_access, p_sys );
402 if( ftp_SendCommand( p_access, p_sys, "QUIT" ) < 0 )
404 msg_Warn( p_access, "cannot quit" );
408 ftp_ReadCommand( p_access, p_sys, NULL, NULL );
410 net_Close( p_sys->fd_cmd );
413 vlc_UrlClean( &p_sys->url );
417 static void InClose( vlc_object_t *p_this )
419 Close( p_this, ((access_t *)p_this)->p_sys);
422 static void OutClose( vlc_object_t *p_this )
424 Close( p_this, GET_OUT_SYS(p_this));
428 /*****************************************************************************
429 * Seek: try to go at the right place
430 *****************************************************************************/
431 static int _Seek( vlc_object_t *p_access, access_sys_t *p_sys, int64_t i_pos )
436 msg_Dbg( p_access, "seeking to "I64Fd, i_pos );
438 ftp_StopStream( (vlc_object_t *)p_access, p_sys );
439 if( ftp_StartStream( (vlc_object_t *)p_access, p_sys, i_pos ) < 0 )
445 static int Seek( access_t *p_access, int64_t i_pos )
447 int val = _Seek( (vlc_object_t *)p_access, p_access->p_sys, i_pos );
451 p_access->info.b_eof = VLC_FALSE;
452 p_access->info.i_pos = i_pos;
457 static int OutSeek( sout_access_out_t *p_access, off_t i_pos )
459 return _Seek( (vlc_object_t *)p_access, GET_OUT_SYS( p_access ), i_pos);
462 /*****************************************************************************
464 *****************************************************************************/
465 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
467 access_sys_t *p_sys = p_access->p_sys;
470 assert( p_sys->fd_data != -1 );
471 assert( p_access->i_object_type == VLC_OBJECT_ACCESS );
473 if( p_access->info.b_eof )
476 i_read = net_Read( p_access, p_sys->fd_data, NULL, p_buffer, i_len,
479 p_access->info.b_eof = VLC_TRUE;
480 else if( i_read > 0 )
481 p_access->info.i_pos += i_read;
486 /*****************************************************************************
488 *****************************************************************************/
489 static int Write( sout_access_out_t *p_access, block_t *p_buffer )
491 access_sys_t *p_sys = GET_OUT_SYS(p_access);
494 assert( p_sys->fd_data != -1 );
496 while( p_buffer != NULL )
498 block_t *p_next = p_buffer->p_next;;
500 i_write += net_Write( p_access, p_sys->fd_data, NULL,
501 p_buffer->p_buffer, p_buffer->i_buffer );
502 block_Release( p_buffer );
510 /*****************************************************************************
512 *****************************************************************************/
513 static int Control( access_t *p_access, int i_query, va_list args )
523 case ACCESS_CAN_SEEK:
524 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
527 case ACCESS_CAN_FASTSEEK:
528 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
529 *pb_bool = VLC_FALSE;
531 case ACCESS_CAN_PAUSE:
532 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
533 *pb_bool = VLC_TRUE; /* FIXME */
535 case ACCESS_CAN_CONTROL_PACE:
536 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
537 *pb_bool = VLC_TRUE; /* FIXME */
542 pi_int = (int*)va_arg( args, int * );
546 case ACCESS_GET_PTS_DELAY:
547 pi_64 = (int64_t*)va_arg( args, int64_t * );
548 var_Get( p_access, "ftp-caching", &val );
549 *pi_64 = (int64_t)var_GetInteger( p_access, "ftp-caching" ) * I64C(1000);
553 case ACCESS_SET_PAUSE_STATE:
557 case ACCESS_GET_TITLE_INFO:
558 case ACCESS_SET_TITLE:
559 case ACCESS_SET_SEEKPOINT:
560 case ACCESS_SET_PRIVATE_ID_STATE:
564 msg_Warn( p_access, "unimplemented query in control" );
571 /*****************************************************************************
573 *****************************************************************************/
574 static int ftp_SendCommand( vlc_object_t *p_access, access_sys_t *p_sys,
575 const char *psz_fmt, ... )
580 va_start( args, psz_fmt );
581 vasprintf( &psz_cmd, psz_fmt, args );
584 msg_Dbg( p_access, "ftp_SendCommand:\"%s\"", psz_cmd);
585 if( net_Printf( VLC_OBJECT(p_access), p_sys->fd_cmd, NULL, "%s\r\n",
588 msg_Err( p_access, "failed to send command" );
594 /* TODO support this s**t :
595 RFC 959 allows the client to send certain TELNET strings at any moment,
596 even in the middle of a request:
599 * \377\376x where x is one byte.
600 * \377\375x where x is one byte. The server is obliged to send \377\374x
601 * immediately after reading x.
602 * \377\374x where x is one byte.
603 * \377\373x where x is one byte. The server is obliged to send \377\376x
604 * immediately after reading x.
605 * \377x for any other byte x.
607 These strings are not part of the requests, except in the case \377\377,
608 where the request contains one \377. */
609 static int ftp_ReadCommand( vlc_object_t *p_access, access_sys_t *p_sys,
610 int *pi_answer, char **ppsz_answer )
615 psz_line = net_Gets( p_access, p_sys->fd_cmd, NULL );
616 if( psz_line == NULL || strlen( psz_line ) < 3 )
618 msg_Err( p_access, "cannot get answer" );
619 if( psz_line ) free( psz_line );
620 if( pi_answer ) *pi_answer = 500;
621 if( ppsz_answer ) *ppsz_answer = NULL;
624 msg_Dbg( p_access, "answer=%s", psz_line );
626 if( psz_line[3] == '-' ) /* Multiple response */
630 memcpy( end, psz_line, 3 );
635 char *psz_tmp = net_Gets( p_access, p_sys->fd_cmd, NULL );
637 if( psz_tmp == NULL ) /* Error */
640 if( !strncmp( psz_tmp, end, 4 ) )
649 i_answer = atoi( psz_line );
651 if( pi_answer ) *pi_answer = i_answer;
654 *ppsz_answer = psz_line;
660 return( i_answer / 100 );
663 static int ftp_StartStream( vlc_object_t *p_access, access_sys_t *p_sys,
666 char psz_ipv4[16], *psz_ip = p_sys->sz_epsv_ip;
668 char *psz_arg, *psz_parser;
671 assert( p_sys->fd_data == -1 );
673 if( ( ftp_SendCommand( p_access, p_sys, *psz_ip ? "EPSV" : "PASV" ) < 0 )
674 || ( ftp_ReadCommand( p_access, p_sys, &i_answer, &psz_arg ) != 2 ) )
676 msg_Err( p_access, "cannot set passive mode" );
680 psz_parser = strchr( psz_arg, '(' );
681 if( psz_parser == NULL )
684 msg_Err( p_access, "cannot parse passive mode response" );
690 char psz_fmt[7] = "(|||%u";
691 psz_fmt[1] = psz_fmt[2] = psz_fmt[3] = psz_parser[1];
693 if( sscanf( psz_parser, psz_fmt, &i_port ) < 1 )
696 msg_Err( p_access, "cannot parse passive mode response" );
702 unsigned a1, a2, a3, a4, p1, p2;
704 if( ( sscanf( psz_parser, "(%u,%u,%u,%u,%u,%u", &a1, &a2, &a3, &a4,
705 &p1, &p2 ) < 6 ) || ( a1 > 255 ) || ( a2 > 255 )
706 || ( a3 > 255 ) || ( a4 > 255 ) || ( p1 > 255 ) || ( p2 > 255 ) )
709 msg_Err( p_access, "cannot parse passive mode response" );
713 sprintf( psz_ipv4, "%u.%u.%u.%u", a1, a2, a3, a4 );
715 i_port = (p1 << 8) | p2;
719 msg_Dbg( p_access, "ip:%s port:%d", psz_ip, i_port );
721 if( ftp_SendCommand( p_access, p_sys, "TYPE I" ) < 0 ||
722 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) != 2 )
724 msg_Err( p_access, "cannot set binary transfer mode" );
730 if( ftp_SendCommand( p_access, p_sys, "REST "I64Fu, i_start ) < 0 ||
731 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) > 3 )
733 msg_Err( p_access, "cannot set restart offset" );
738 msg_Dbg( p_access, "waiting for data connection..." );
739 p_sys->fd_data = net_ConnectTCP( p_access, psz_ip, i_port );
740 if( p_sys->fd_data < 0 )
742 msg_Err( p_access, "failed to connect with server" );
745 msg_Dbg( p_access, "connection with \"%s:%d\" successful",
749 if( ftp_SendCommand( p_access, p_sys, "%s %s",
750 (p_access->i_object_type == VLC_OBJECT_ACCESS)
752 p_sys->url.psz_path ) < 0 ||
753 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) > 2 )
755 msg_Err( p_access, "cannot retreive file" );
759 if( p_access->i_object_type == VLC_OBJECT_ACCESS )
760 net_StopSend( p_sys->fd_data );
762 net_StopRecv( p_sys->fd_data );
767 static int ftp_StopStream ( vlc_object_t *p_access, access_sys_t *p_sys )
769 if( ftp_SendCommand( p_access, p_sys, "ABOR" ) < 0 )
771 msg_Warn( p_access, "cannot abort file" );
772 if( p_sys->fd_data > 0 )
773 net_Close( p_sys->fd_data );
778 if( p_sys->fd_data != -1 )
780 net_Close( p_sys->fd_data );
782 ftp_ReadCommand( p_access, p_sys, NULL, NULL );
784 ftp_ReadCommand( p_access, p_sys, NULL, NULL );