1 /*****************************************************************************
2 * ftp.c: FTP input module
3 *****************************************************************************
4 * Copyright (C) 2001-2005 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr> - original code
8 * RĂ©mi Denis-Courmont <rem # videolan.org> - EPSV support
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
31 #include <vlc/input.h>
34 #if defined( UNDER_CE )
36 #elif defined( WIN32 )
37 # include <winsock2.h>
39 # include <sys/socket.h>
42 /*****************************************************************************
44 *****************************************************************************/
45 static int Open ( vlc_object_t * );
46 static void Close( vlc_object_t * );
48 #define CACHING_TEXT N_("Caching value in ms")
49 #define CACHING_LONGTEXT N_( \
50 "Allows you to modify the default caching value for FTP streams. This " \
51 "value should be set in millisecond units." )
52 #define USER_TEXT N_("FTP user name")
53 #define USER_LONGTEXT N_("Allows you to modify the user name that will " \
54 "be used for the connection.")
55 #define PASS_TEXT N_("FTP password")
56 #define PASS_LONGTEXT N_("Allows you to modify the password that will be " \
57 "used for the connection.")
58 #define ACCOUNT_TEXT N_("FTP account")
59 #define ACCOUNT_LONGTEXT N_("Allows you to modify the 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@dummy.org", 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( Open, Close );
80 /*****************************************************************************
82 *****************************************************************************/
83 static int Read( access_t *, uint8_t *, int );
84 static int Seek( access_t *, int64_t );
85 static int Control( access_t *, int, va_list );
94 char sz_epsv_ip[NI_MAXNUMERICHOST];
97 static int ftp_SendCommand( access_t *, char *, ... );
98 static int ftp_ReadCommand( access_t *, int *, char ** );
99 static int ftp_StartStream( access_t *, int64_t );
100 static int ftp_StopStream ( access_t *);
102 static int Connect( access_t *p_access, access_sys_t *p_sys )
107 /* *** Open a TCP connection with server *** */
108 msg_Dbg( p_access, "waiting for connection..." );
109 p_sys->fd_cmd = fd = net_ConnectTCP( p_access, p_sys->url.psz_host,
113 msg_Err( p_access, "failed to connect with server" );
119 if( ftp_ReadCommand( p_access, &i_answer, NULL ) != 1 )
124 if( i_answer / 100 != 2 )
126 msg_Err( p_access, "connection rejected" );
130 msg_Dbg( p_access, "connection accepted (%d)", i_answer );
132 psz = var_CreateGetString( p_access, "ftp-user" );
133 if( ftp_SendCommand( p_access, "USER %s", psz ) < 0 ||
134 ftp_ReadCommand( p_access, &i_answer, NULL ) < 0 )
141 switch( i_answer / 100 )
144 msg_Dbg( p_access, "user accepted" );
147 msg_Dbg( p_access, "password needed" );
148 psz = var_CreateGetString( p_access, "ftp-pwd" );
149 if( ftp_SendCommand( p_access, "PASS %s", psz ) < 0 ||
150 ftp_ReadCommand( p_access, &i_answer, NULL ) < 0 )
157 switch( i_answer / 100 )
160 msg_Dbg( p_access, "password accepted" );
163 msg_Dbg( p_access, "account needed" );
164 psz = var_CreateGetString( p_access, "ftp-account" );
165 if( ftp_SendCommand( p_access, "ACCT %s",
167 ftp_ReadCommand( p_access, &i_answer, NULL ) < 0 )
174 if( i_answer / 100 != 2 )
176 msg_Err( p_access, "account rejected" );
179 msg_Dbg( p_access, "account accepted" );
183 msg_Err( p_access, "password rejected" );
188 msg_Err( p_access, "user rejected" );
195 /****************************************************************************
196 * Open: connect to ftp server and ask for file
197 ****************************************************************************/
198 static int Open( vlc_object_t *p_this )
200 access_t *p_access = (access_t*)p_this;
208 p_access->pf_read = Read;
209 p_access->pf_block = NULL;
210 p_access->pf_seek = Seek;
211 p_access->pf_control = Control;
212 p_access->info.i_update = 0;
213 p_access->info.i_size = 0;
214 p_access->info.i_pos = 0;
215 p_access->info.b_eof = VLC_FALSE;
216 p_access->info.i_title = 0;
217 p_access->info.i_seekpoint = 0;
218 p_access->p_sys = p_sys = malloc( sizeof( access_sys_t ) );
219 memset( p_sys, 0, sizeof( access_sys_t ) );
223 /* *** Parse URL and get server addr/port and path *** */
224 psz = p_access->psz_path;
229 vlc_UrlParse( &p_sys->url, psz, 0 );
231 if( p_sys->url.psz_host == NULL || *p_sys->url.psz_host == '\0' )
233 msg_Err( p_access, "invalid server name" );
236 if( p_sys->url.i_port <= 0 )
238 p_sys->url.i_port = 21; /* default port */
241 /* FTP URLs are relative to user's default directory (RFC1738)
242 For absolute path use ftp://foo.bar//usr/local/etc/filename */
244 if( *p_sys->url.psz_path == '/' )
245 p_sys->url.psz_path++;
247 if( Connect( p_access, p_sys ) < 0 )
250 /* Extended passive mode */
251 if( ftp_SendCommand( p_access, "EPSV ALL" ) < 0 )
253 msg_Err( p_access, "cannot request extended passive mode" );
257 if( ftp_ReadCommand( p_access, &i_answer, NULL ) == 2 )
259 if( net_GetPeerAddress( p_sys->fd_cmd, p_sys->sz_epsv_ip, NULL ) )
264 /* If ESPV ALL fails, we fallback to PASV.
265 * We have to restart the connection in case there is a NAT that
266 * understands EPSV ALL in the way, and hence won't allow PASV on
267 * the initial connection.
269 net_Close( p_sys->fd_cmd );
271 *p_sys->sz_epsv_ip = '\0';
273 if( ( p_sys->fd_cmd = Connect( p_access, p_sys ) ) < 0 )
276 msg_Info( p_access, "FTP Extended passive mode disabled" );
280 if( ftp_SendCommand( p_access, "TYPE I" ) < 0 ||
281 ftp_ReadCommand( p_access, &i_answer, NULL ) != 2 )
283 msg_Err( p_access, "cannot set binary transfer mode" );
288 if( ftp_SendCommand( p_access, "SIZE %s", p_sys->url.psz_path ) < 0 ||
289 ftp_ReadCommand( p_access, &i_answer, &psz_arg ) != 2 )
291 msg_Err( p_access, "cannot get file size" );
294 p_access->info.i_size = atoll( &psz_arg[4] );
296 msg_Dbg( p_access, "file size: "I64Fd, p_access->info.i_size );
298 /* Start the 'stream' */
299 if( ftp_StartStream( p_access, 0 ) < 0 )
301 msg_Err( p_access, "cannot retrieve file" );
305 /* Update default_pts to a suitable value for ftp access */
306 var_Create( p_access, "ftp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
311 if( p_sys->fd_cmd >= 0 )
312 net_Close( p_sys->fd_cmd );
313 vlc_UrlClean( &p_sys->url );
318 /*****************************************************************************
319 * Close: free unused data structures
320 *****************************************************************************/
321 static void Close( vlc_object_t *p_this )
323 access_t *p_access = (access_t*)p_this;
324 access_sys_t *p_sys = p_access->p_sys;
326 msg_Dbg( p_access, "stopping stream" );
327 ftp_StopStream( p_access );
329 if( ftp_SendCommand( p_access, "QUIT" ) < 0 )
331 msg_Warn( p_access, "cannot quit" );
335 ftp_ReadCommand( p_access, NULL, NULL );
337 net_Close( p_sys->fd_cmd );
340 vlc_UrlClean( &p_sys->url );
344 /*****************************************************************************
345 * Seek: try to go at the right place
346 *****************************************************************************/
347 static int Seek( access_t *p_access, int64_t i_pos )
353 msg_Dbg( p_access, "seeking to "I64Fd, i_pos );
355 ftp_StopStream( p_access );
356 if( ftp_StartStream( p_access, i_pos ) < 0 )
358 p_access->info.b_eof = VLC_TRUE;
362 p_access->info.b_eof = VLC_FALSE;
363 p_access->info.i_pos = i_pos;
368 /*****************************************************************************
370 *****************************************************************************/
371 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
373 access_sys_t *p_sys = p_access->p_sys;
376 if( p_access->info.b_eof )
379 i_read = net_Read( p_access, p_sys->fd_data, NULL, p_buffer, i_len,
382 p_access->info.b_eof = VLC_TRUE;
383 else if( i_read > 0 )
384 p_access->info.i_pos += i_read;
389 /*****************************************************************************
391 *****************************************************************************/
392 static int Control( access_t *p_access, int i_query, va_list args )
402 case ACCESS_CAN_SEEK:
403 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
406 case ACCESS_CAN_FASTSEEK:
407 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
408 *pb_bool = VLC_FALSE;
410 case ACCESS_CAN_PAUSE:
411 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
412 *pb_bool = VLC_TRUE; /* FIXME */
414 case ACCESS_CAN_CONTROL_PACE:
415 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
416 *pb_bool = VLC_TRUE; /* FIXME */
421 pi_int = (int*)va_arg( args, int * );
425 case ACCESS_GET_PTS_DELAY:
426 pi_64 = (int64_t*)va_arg( args, int64_t * );
427 var_Get( p_access, "ftp-caching", &val );
428 *pi_64 = (int64_t)var_GetInteger( p_access, "ftp-caching" ) * I64C(1000);
432 case ACCESS_SET_PAUSE_STATE:
436 case ACCESS_GET_TITLE_INFO:
437 case ACCESS_SET_TITLE:
438 case ACCESS_SET_SEEKPOINT:
439 case ACCESS_SET_PRIVATE_ID_STATE:
443 msg_Warn( p_access, "unimplemented query in control" );
450 /*****************************************************************************
452 *****************************************************************************/
453 static int ftp_SendCommand( access_t *p_access, char *psz_fmt, ... )
455 access_sys_t *p_sys = p_access->p_sys;
459 va_start( args, psz_fmt );
460 vasprintf( &psz_cmd, psz_fmt, args );
463 msg_Dbg( p_access, "ftp_SendCommand:\"%s\"", psz_cmd);
464 if( net_Printf( VLC_OBJECT(p_access), p_sys->fd_cmd, NULL, "%s\r\n",
467 msg_Err( p_access, "failed to send command" );
473 /* TODO support this s**t :
474 RFC 959 allows the client to send certain TELNET strings at any moment,
475 even in the middle of a request:
478 * \377\376x where x is one byte.
479 * \377\375x where x is one byte. The server is obliged to send \377\374x
480 * immediately after reading x.
481 * \377\374x where x is one byte.
482 * \377\373x where x is one byte. The server is obliged to send \377\376x
483 * immediately after reading x.
484 * \377x for any other byte x.
486 These strings are not part of the requests, except in the case \377\377,
487 where the request contains one \377. */
488 static int ftp_ReadCommand( access_t *p_access,
489 int *pi_answer, char **ppsz_answer )
491 access_sys_t *p_sys = p_access->p_sys;
495 psz_line = net_Gets( p_access, p_sys->fd_cmd, NULL );
496 msg_Dbg( p_access, "answer=%s", psz_line );
497 if( psz_line == NULL || strlen( psz_line ) < 3 )
499 msg_Err( p_access, "cannot get answer" );
500 if( psz_line ) free( psz_line );
501 if( pi_answer ) *pi_answer = 500;
502 if( ppsz_answer ) *ppsz_answer = NULL;
506 if( psz_line[3] == '-' ) /* Multiple response */
510 memcpy( end, psz_line, 3 );
515 char *psz_tmp = net_Gets( p_access, p_sys->fd_cmd, NULL );
517 if( psz_tmp == NULL ) /* Error */
520 if( !strncmp( psz_tmp, end, 4 ) )
529 i_answer = atoi( psz_line );
531 if( pi_answer ) *pi_answer = i_answer;
534 *ppsz_answer = psz_line;
540 return( i_answer / 100 );
543 static int ftp_StartStream( access_t *p_access, off_t i_start )
545 access_sys_t *p_sys = p_access->p_sys;
547 char psz_ipv4[16], *psz_ip;
549 char *psz_arg, *psz_parser;
552 psz_ip = p_sys->sz_epsv_ip;
554 if( ( ftp_SendCommand( p_access, *psz_ip ? "EPSV" : "PASV" ) < 0 )
555 || ( ftp_ReadCommand( p_access, &i_answer, &psz_arg ) != 2 ) )
557 msg_Err( p_access, "cannot set passive mode" );
561 psz_parser = strchr( psz_arg, '(' );
562 if( psz_parser == NULL )
565 msg_Err( p_access, "cannot parse passive mode response" );
571 char psz_fmt[7] = "(|||%u";
572 psz_fmt[1] = psz_fmt[2] = psz_fmt[3] = psz_parser[1];
574 if( sscanf( psz_parser, psz_fmt, &i_port ) < 1 )
577 msg_Err( p_access, "cannot parse passive mode response" );
583 unsigned a1, a2, a3, a4, p1, p2;
585 if( ( sscanf( psz_parser, "(%u,%u,%u,%u,%u,%u", &a1, &a2, &a3, &a4,
586 &p1, &p2 ) < 6 ) || ( a1 > 255 ) || ( a2 > 255 )
587 || ( a3 > 255 ) || ( a4 > 255 ) || ( p1 > 255 ) || ( p2 > 255 ) )
590 msg_Err( p_access, "cannot parse passive mode response" );
594 sprintf( psz_ipv4, "%u.%u.%u.%u", a1, a2, a3, a4 );
596 i_port = (p1 << 8) | p2;
600 msg_Dbg( p_access, "ip:%s port:%d", psz_ip, i_port );
602 if( ftp_SendCommand( p_access, "TYPE I" ) < 0 ||
603 ftp_ReadCommand( p_access, &i_answer, NULL ) != 2 )
605 msg_Err( p_access, "cannot set binary transfer mode" );
611 if( ftp_SendCommand( p_access, "REST "I64Fu, i_start ) < 0 ||
612 ftp_ReadCommand( p_access, &i_answer, NULL ) > 3 )
614 msg_Err( p_access, "cannot set restart point" );
619 msg_Dbg( p_access, "waiting for data connection..." );
620 p_sys->fd_data = net_ConnectTCP( p_access, psz_ip, i_port );
621 if( p_sys->fd_data < 0 )
623 msg_Err( p_access, "failed to connect with server" );
626 msg_Dbg( p_access, "connection with \"%s:%d\" successful",
630 if( ftp_SendCommand( p_access, "RETR %s", p_sys->url.psz_path ) < 0 ||
631 ftp_ReadCommand( p_access, &i_answer, NULL ) > 2 )
633 msg_Err( p_access, "cannot retreive file" );
639 static int ftp_StopStream ( access_t *p_access )
641 access_sys_t *p_sys = p_access->p_sys;
645 if( ftp_SendCommand( p_access, "ABOR" ) < 0 )
647 msg_Warn( p_access, "cannot abort file" );
648 if( p_sys->fd_data > 0 )
649 net_Close( p_sys->fd_data );
653 if( p_sys->fd_data > 0 )
655 net_Close( p_sys->fd_data );
657 ftp_ReadCommand( p_access, &i_answer, NULL );
659 ftp_ReadCommand( p_access, &i_answer, NULL );