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"
40 /*****************************************************************************
42 *****************************************************************************/
43 static int InOpen ( vlc_object_t * );
44 static void InClose( vlc_object_t * );
45 static int OutOpen ( vlc_object_t * );
46 static void OutClose( vlc_object_t * );
48 #define CACHING_TEXT N_("Caching value in ms")
49 #define CACHING_LONGTEXT N_( \
50 "Caching value for FTP streams. This " \
51 "value should be set in milliseconds." )
52 #define USER_TEXT N_("FTP user name")
53 #define USER_LONGTEXT N_("User name that will " \
54 "be used for the connection.")
55 #define PASS_TEXT N_("FTP password")
56 #define PASS_LONGTEXT N_("Password that will be " \
57 "used for the connection.")
58 #define ACCOUNT_TEXT N_("FTP account")
59 #define ACCOUNT_LONGTEXT N_("Account that will be " \
60 "used for the connection.")
63 set_shortname( "FTP" );
64 set_description( _("FTP input") );
65 set_capability( "access2", 0 );
66 set_category( CAT_INPUT );
67 set_subcategory( SUBCAT_INPUT_ACCESS );
68 add_integer( "ftp-caching", 2 * DEFAULT_PTS_DELAY / 1000, NULL,
69 CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
70 add_string( "ftp-user", "anonymous", NULL, USER_TEXT, USER_LONGTEXT,
72 add_string( "ftp-pwd", "anonymous@example.com", NULL, PASS_TEXT,
73 PASS_LONGTEXT, VLC_FALSE );
74 add_string( "ftp-account", "anonymous", NULL, ACCOUNT_TEXT,
75 ACCOUNT_LONGTEXT, VLC_FALSE );
76 add_shortcut( "ftp" );
77 set_callbacks( InOpen, InClose );
80 set_shortname( "FTP" );
81 set_description( _("FTP upload output") );
82 set_capability( "sout access", 0 );
83 set_category( CAT_SOUT );
84 set_subcategory( SUBCAT_SOUT_ACO );
85 add_shortcut( "ftp" );
86 set_callbacks( OutOpen, OutClose );
89 /*****************************************************************************
91 *****************************************************************************/
92 static int Read( access_t *, uint8_t *, int );
93 static int Write( sout_access_out_t *, block_t * );
94 static int Seek( access_t *, int64_t );
95 static int OutSeek( sout_access_out_t *, int64_t );
96 static int Control( access_t *, int, va_list );
105 char sz_epsv_ip[NI_MAXNUMERICHOST];
107 #define GET_OUT_SYS( p_this ) \
108 ((access_sys_t *)(((sout_access_out_t *)(p_this))->p_sys))
110 static int ftp_SendCommand( vlc_object_t *, access_sys_t *, const char *, ... );
111 static int ftp_ReadCommand( vlc_object_t *, access_sys_t *, int *, char ** );
112 static int ftp_StartStream( vlc_object_t *, access_sys_t *, int64_t );
113 static int ftp_StopStream ( vlc_object_t *, access_sys_t * );
115 static int Login( vlc_object_t *p_access, access_sys_t *p_sys )
120 /* *** Open a TCP connection with server *** */
121 int fd = p_sys->fd_cmd = net_ConnectTCP( p_access, p_sys->url.psz_host,
125 msg_Err( p_access, "connection failed" );
126 intf_UserFatal( p_access, VLC_FALSE, _("Network interaction failed"),
127 _("VLC could not connect with the given server.") );
131 while( ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) == 1 );
133 if( i_answer / 100 != 2 )
135 msg_Err( p_access, "connection rejected" );
136 intf_UserFatal( p_access, VLC_FALSE, _("Network interaction failed"),
137 _("VLC's connection to the given server was rejected.") );
141 msg_Dbg( p_access, "connection accepted (%d)", i_answer );
143 if( p_sys->url.psz_username && *p_sys->url.psz_username )
144 psz = strdup( p_sys->url.psz_username );
146 psz = var_CreateGetString( p_access, "ftp-user" );
148 if( ftp_SendCommand( p_access, p_sys, "USER %s", psz ) < 0 ||
149 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
156 switch( i_answer / 100 )
159 msg_Dbg( p_access, "user accepted" );
162 msg_Dbg( p_access, "password needed" );
163 if( p_sys->url.psz_password && *p_sys->url.psz_password )
164 psz = strdup( p_sys->url.psz_password );
166 psz = var_CreateGetString( p_access, "ftp-pwd" );
168 if( ftp_SendCommand( p_access, p_sys, "PASS %s", psz ) < 0 ||
169 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
176 switch( i_answer / 100 )
179 msg_Dbg( p_access, "password accepted" );
182 msg_Dbg( p_access, "account needed" );
183 psz = var_CreateGetString( p_access, "ftp-account" );
184 if( ftp_SendCommand( p_access, p_sys, "ACCT %s",
186 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
193 if( i_answer / 100 != 2 )
195 msg_Err( p_access, "account rejected" );
196 intf_UserFatal( p_access, VLC_FALSE,
197 _("Network interaction failed"),
198 _("Your account was rejected.") );
201 msg_Dbg( p_access, "account accepted" );
205 msg_Err( p_access, "password rejected" );
206 intf_UserFatal( p_access, VLC_FALSE,
207 _("Network interaction failed"),
208 _("Your password was rejected.") );
213 msg_Err( p_access, "user rejected" );
214 intf_UserFatal( p_access, VLC_FALSE,
215 _("Network interaction failed"),
216 _("Your connection attemp to the server was rejected.") );
223 static int Connect( vlc_object_t *p_access, access_sys_t *p_sys )
225 if( Login( p_access, p_sys ) < 0 )
228 /* Extended passive mode */
229 if( ftp_SendCommand( p_access, p_sys, "EPSV ALL" ) < 0 )
231 msg_Err( p_access, "cannot request extended passive mode" );
232 net_Close( p_sys->fd_cmd );
236 if( ftp_ReadCommand( p_access, p_sys, NULL, NULL ) == 2 )
238 if( net_GetPeerAddress( p_sys->fd_cmd, p_sys->sz_epsv_ip, NULL ) )
240 net_Close( p_sys->fd_cmd );
246 /* If ESPV ALL fails, we fallback to PASV.
247 * We have to restart the connection in case there is a NAT that
248 * understands EPSV ALL in the way, and hence won't allow PASV on
249 * the initial connection.
251 msg_Info( p_access, "FTP Extended passive mode disabled" );
252 net_Close( p_sys->fd_cmd );
254 if( ( p_sys->fd_cmd = Login( p_access, p_sys ) ) < 0 )
256 net_Close( p_sys->fd_cmd );
261 /* check binary mode support */
262 if( ftp_SendCommand( p_access, p_sys, "TYPE I" ) < 0 ||
263 ftp_ReadCommand( p_access, p_sys, NULL, NULL ) != 2 )
265 msg_Err( p_access, "cannot set binary transfer mode" );
266 net_Close( p_sys->fd_cmd );
274 static int parseURL( vlc_url_t *url, const char *path )
279 /* *** Parse URL and get server addr/port and path *** */
280 while( *path == '/' )
283 vlc_UrlParse( url, path, 0 );
285 if( url->psz_host == NULL || *url->psz_host == '\0' )
288 if( url->i_port <= 0 )
289 url->i_port = IPPORT_FTP; /* default port */
291 /* FTP URLs are relative to user's default directory (RFC1738)
292 For absolute path use ftp://foo.bar//usr/local/etc/filename */
294 if( *url->psz_path == '/' )
301 /****************************************************************************
302 * Open: connect to ftp server and ask for file
303 ****************************************************************************/
304 static int InOpen( vlc_object_t *p_this )
306 access_t *p_access = (access_t*)p_this;
311 STANDARD_READ_ACCESS_INIT
314 if( parseURL( &p_sys->url, p_access->psz_path ) )
317 if( Connect( p_this, p_sys ) )
321 if( ftp_SendCommand( p_this, p_sys, "SIZE %s", p_sys->url.psz_path ) < 0 ||
322 ftp_ReadCommand( p_this, p_sys, NULL, &psz_arg ) != 2 )
324 msg_Err( p_access, "cannot get file size" );
325 net_Close( p_sys->fd_cmd );
328 p_access->info.i_size = atoll( &psz_arg[4] );
330 msg_Dbg( p_access, "file size: "I64Fd, p_access->info.i_size );
332 /* Start the 'stream' */
333 if( ftp_StartStream( p_this, p_sys, 0 ) < 0 )
335 msg_Err( p_access, "cannot retrieve file" );
336 net_Close( p_sys->fd_cmd );
340 /* Update default_pts to a suitable value for ftp access */
341 var_Create( p_access, "ftp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
346 vlc_UrlClean( &p_sys->url );
351 static int OutOpen( vlc_object_t *p_this )
353 sout_access_out_t *p_access = (sout_access_out_t *)p_this;
356 p_sys = malloc( sizeof( *p_sys ) );
359 memset( p_sys, 0, sizeof( *p_sys ) );
364 if( parseURL( &p_sys->url, p_access->psz_name ) )
367 if( Connect( p_this, p_sys ) )
370 /* Start the 'stream' */
371 if( ftp_StartStream( p_this, p_sys, 0 ) < 0 )
373 msg_Err( p_access, "cannot store file" );
374 net_Close( p_sys->fd_cmd );
378 p_access->pf_seek = OutSeek;
379 p_access->pf_write = Write;
384 vlc_UrlClean( &p_sys->url );
389 /*****************************************************************************
390 * Close: free unused data structures
391 *****************************************************************************/
392 static void Close( vlc_object_t *p_access, access_sys_t *p_sys )
394 msg_Dbg( p_access, "stopping stream" );
395 ftp_StopStream( p_access, p_sys );
397 if( ftp_SendCommand( p_access, p_sys, "QUIT" ) < 0 )
399 msg_Warn( p_access, "cannot quit" );
403 ftp_ReadCommand( p_access, p_sys, NULL, NULL );
405 net_Close( p_sys->fd_cmd );
408 vlc_UrlClean( &p_sys->url );
412 static void InClose( vlc_object_t *p_this )
414 Close( p_this, ((access_t *)p_this)->p_sys);
417 static void OutClose( vlc_object_t *p_this )
419 Close( p_this, GET_OUT_SYS(p_this));
423 /*****************************************************************************
424 * Seek: try to go at the right place
425 *****************************************************************************/
426 static int _Seek( vlc_object_t *p_access, access_sys_t *p_sys, int64_t i_pos )
431 msg_Dbg( p_access, "seeking to "I64Fd, i_pos );
433 ftp_StopStream( (vlc_object_t *)p_access, p_sys );
434 if( ftp_StartStream( (vlc_object_t *)p_access, p_sys, i_pos ) < 0 )
440 static int Seek( access_t *p_access, int64_t i_pos )
442 int val = _Seek( (vlc_object_t *)p_access, p_access->p_sys, i_pos );
446 p_access->info.b_eof = VLC_FALSE;
447 p_access->info.i_pos = i_pos;
452 static int OutSeek( sout_access_out_t *p_access, off_t i_pos )
454 return _Seek( (vlc_object_t *)p_access, GET_OUT_SYS( p_access ), i_pos);
457 /*****************************************************************************
459 *****************************************************************************/
460 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
462 access_sys_t *p_sys = p_access->p_sys;
465 assert( p_sys->fd_data != -1 );
466 assert( p_access->i_object_type == VLC_OBJECT_ACCESS );
468 if( p_access->info.b_eof )
471 i_read = net_Read( p_access, p_sys->fd_data, NULL, p_buffer, i_len,
474 p_access->info.b_eof = VLC_TRUE;
475 else if( i_read > 0 )
476 p_access->info.i_pos += i_read;
481 /*****************************************************************************
483 *****************************************************************************/
484 static int Write( sout_access_out_t *p_access, block_t *p_buffer )
486 access_sys_t *p_sys = GET_OUT_SYS(p_access);
489 assert( p_sys->fd_data != -1 );
491 while( p_buffer != NULL )
493 block_t *p_next = p_buffer->p_next;;
495 i_write += net_Write( p_access, p_sys->fd_data, NULL,
496 p_buffer->p_buffer, p_buffer->i_buffer );
497 block_Release( p_buffer );
505 /*****************************************************************************
507 *****************************************************************************/
508 static int Control( access_t *p_access, int i_query, va_list args )
518 case ACCESS_CAN_SEEK:
519 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
522 case ACCESS_CAN_FASTSEEK:
523 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
524 *pb_bool = VLC_FALSE;
526 case ACCESS_CAN_PAUSE:
527 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
528 *pb_bool = VLC_TRUE; /* FIXME */
530 case ACCESS_CAN_CONTROL_PACE:
531 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
532 *pb_bool = VLC_TRUE; /* FIXME */
537 pi_int = (int*)va_arg( args, int * );
541 case ACCESS_GET_PTS_DELAY:
542 pi_64 = (int64_t*)va_arg( args, int64_t * );
543 var_Get( p_access, "ftp-caching", &val );
544 *pi_64 = (int64_t)var_GetInteger( p_access, "ftp-caching" ) * I64C(1000);
548 case ACCESS_SET_PAUSE_STATE:
552 case ACCESS_GET_TITLE_INFO:
553 case ACCESS_SET_TITLE:
554 case ACCESS_SET_SEEKPOINT:
555 case ACCESS_SET_PRIVATE_ID_STATE:
559 msg_Warn( p_access, "unimplemented query in control" );
566 /*****************************************************************************
568 *****************************************************************************/
569 static int ftp_SendCommand( vlc_object_t *p_access, access_sys_t *p_sys,
570 const char *psz_fmt, ... )
575 va_start( args, psz_fmt );
576 vasprintf( &psz_cmd, psz_fmt, args );
579 msg_Dbg( p_access, "ftp_SendCommand:\"%s\"", psz_cmd);
580 if( net_Printf( VLC_OBJECT(p_access), p_sys->fd_cmd, NULL, "%s\r\n",
583 msg_Err( p_access, "failed to send command" );
589 /* TODO support this s**t :
590 RFC 959 allows the client to send certain TELNET strings at any moment,
591 even in the middle of a request:
594 * \377\376x where x is one byte.
595 * \377\375x where x is one byte. The server is obliged to send \377\374x
596 * immediately after reading x.
597 * \377\374x where x is one byte.
598 * \377\373x where x is one byte. The server is obliged to send \377\376x
599 * immediately after reading x.
600 * \377x for any other byte x.
602 These strings are not part of the requests, except in the case \377\377,
603 where the request contains one \377. */
604 static int ftp_ReadCommand( vlc_object_t *p_access, access_sys_t *p_sys,
605 int *pi_answer, char **ppsz_answer )
610 psz_line = net_Gets( p_access, p_sys->fd_cmd, NULL );
611 msg_Dbg( p_access, "answer=%s", psz_line );
612 if( psz_line == NULL || strlen( psz_line ) < 3 )
614 msg_Err( p_access, "cannot get answer" );
615 if( psz_line ) free( psz_line );
616 if( pi_answer ) *pi_answer = 500;
617 if( ppsz_answer ) *ppsz_answer = NULL;
621 if( psz_line[3] == '-' ) /* Multiple response */
625 memcpy( end, psz_line, 3 );
630 char *psz_tmp = net_Gets( p_access, p_sys->fd_cmd, NULL );
632 if( psz_tmp == NULL ) /* Error */
635 if( !strncmp( psz_tmp, end, 4 ) )
644 i_answer = atoi( psz_line );
646 if( pi_answer ) *pi_answer = i_answer;
649 *ppsz_answer = psz_line;
655 return( i_answer / 100 );
658 static int ftp_StartStream( vlc_object_t *p_access, access_sys_t *p_sys,
661 char psz_ipv4[16], *psz_ip = p_sys->sz_epsv_ip;
663 char *psz_arg, *psz_parser;
666 assert( p_sys->fd_data == -1 );
668 if( ( ftp_SendCommand( p_access, p_sys, *psz_ip ? "EPSV" : "PASV" ) < 0 )
669 || ( ftp_ReadCommand( p_access, p_sys, &i_answer, &psz_arg ) != 2 ) )
671 msg_Err( p_access, "cannot set passive mode" );
675 psz_parser = strchr( psz_arg, '(' );
676 if( psz_parser == NULL )
679 msg_Err( p_access, "cannot parse passive mode response" );
685 char psz_fmt[7] = "(|||%u";
686 psz_fmt[1] = psz_fmt[2] = psz_fmt[3] = psz_parser[1];
688 if( sscanf( psz_parser, psz_fmt, &i_port ) < 1 )
691 msg_Err( p_access, "cannot parse passive mode response" );
697 unsigned a1, a2, a3, a4, p1, p2;
699 if( ( sscanf( psz_parser, "(%u,%u,%u,%u,%u,%u", &a1, &a2, &a3, &a4,
700 &p1, &p2 ) < 6 ) || ( a1 > 255 ) || ( a2 > 255 )
701 || ( a3 > 255 ) || ( a4 > 255 ) || ( p1 > 255 ) || ( p2 > 255 ) )
704 msg_Err( p_access, "cannot parse passive mode response" );
708 sprintf( psz_ipv4, "%u.%u.%u.%u", a1, a2, a3, a4 );
710 i_port = (p1 << 8) | p2;
714 msg_Dbg( p_access, "ip:%s port:%d", psz_ip, i_port );
716 if( ftp_SendCommand( p_access, p_sys, "TYPE I" ) < 0 ||
717 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) != 2 )
719 msg_Err( p_access, "cannot set binary transfer mode" );
725 if( ftp_SendCommand( p_access, p_sys, "REST "I64Fu, i_start ) < 0 ||
726 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) > 3 )
728 msg_Err( p_access, "cannot set restart offset" );
733 msg_Dbg( p_access, "waiting for data connection..." );
734 p_sys->fd_data = net_ConnectTCP( p_access, psz_ip, i_port );
735 if( p_sys->fd_data < 0 )
737 msg_Err( p_access, "failed to connect with server" );
740 msg_Dbg( p_access, "connection with \"%s:%d\" successful",
744 if( ftp_SendCommand( p_access, p_sys, "%s %s",
745 (p_access->i_object_type == VLC_OBJECT_ACCESS)
747 p_sys->url.psz_path ) < 0 ||
748 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) > 2 )
750 msg_Err( p_access, "cannot retreive file" );
756 static int ftp_StopStream ( vlc_object_t *p_access, access_sys_t *p_sys )
758 if( ftp_SendCommand( p_access, p_sys, "ABOR" ) < 0 )
760 msg_Warn( p_access, "cannot abort file" );
761 if( p_sys->fd_data > 0 )
762 net_Close( p_sys->fd_data );
767 if( p_sys->fd_data != -1 )
769 net_Close( p_sys->fd_data );
771 ftp_ReadCommand( p_access, p_sys, NULL, NULL );
773 ftp_ReadCommand( p_access, p_sys, NULL, NULL );