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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
31 #include <vlc/input.h>
36 /*****************************************************************************
38 *****************************************************************************/
39 static int Open ( vlc_object_t * );
40 static void Close( vlc_object_t * );
42 #define CACHING_TEXT N_("Caching value in ms")
43 #define CACHING_LONGTEXT N_( \
44 "Allows you to modify the default caching value for FTP streams. This " \
45 "value should be set in millisecond units." )
46 #define USER_TEXT N_("FTP user name")
47 #define USER_LONGTEXT N_("Allows you to modify the user name that will " \
48 "be used for the connection.")
49 #define PASS_TEXT N_("FTP password")
50 #define PASS_LONGTEXT N_("Allows you to modify the password that will be " \
51 "used for the connection.")
52 #define ACCOUNT_TEXT N_("FTP account")
53 #define ACCOUNT_LONGTEXT N_("Allows you to modify the account that will be " \
54 "used for the connection.")
57 set_shortname( "FTP" );
58 set_description( _("FTP input") );
59 set_capability( "access2", 0 );
60 set_category( CAT_INPUT );
61 set_subcategory( SUBCAT_INPUT_ACCESS );
62 add_integer( "ftp-caching", 2 * DEFAULT_PTS_DELAY / 1000, NULL,
63 CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
64 add_string( "ftp-user", "anonymous", NULL, USER_TEXT, USER_LONGTEXT,
66 add_string( "ftp-pwd", "anonymous@dummy.org", NULL, PASS_TEXT,
67 PASS_LONGTEXT, VLC_FALSE );
68 add_string( "ftp-account", "anonymous", NULL, ACCOUNT_TEXT,
69 ACCOUNT_LONGTEXT, VLC_FALSE );
70 add_shortcut( "ftp" );
71 set_callbacks( Open, Close );
74 /*****************************************************************************
76 *****************************************************************************/
77 static int Read( access_t *, uint8_t *, int );
78 static int Seek( access_t *, int64_t );
79 static int Control( access_t *, int, va_list );
88 char sz_epsv_ip[NI_MAXNUMERICHOST];
91 static int ftp_SendCommand( access_t *, char *, ... );
92 static int ftp_ReadCommand( access_t *, int *, char ** );
93 static int ftp_StartStream( access_t *, int64_t );
94 static int ftp_StopStream ( access_t *);
96 static int Connect( access_t *p_access, access_sys_t *p_sys )
101 /* *** Open a TCP connection with server *** */
102 msg_Dbg( p_access, "waiting for connection..." );
103 p_sys->fd_cmd = fd = net_ConnectTCP( p_access, p_sys->url.psz_host,
107 msg_Err( p_access, "failed to connect with server" );
113 if( ftp_ReadCommand( p_access, &i_answer, NULL ) != 1 )
118 if( i_answer / 100 != 2 )
120 msg_Err( p_access, "connection rejected" );
124 msg_Dbg( p_access, "connection accepted (%d)", i_answer );
126 psz = var_CreateGetString( p_access, "ftp-user" );
127 if( ftp_SendCommand( p_access, "USER %s", psz ) < 0 ||
128 ftp_ReadCommand( p_access, &i_answer, NULL ) < 0 )
135 switch( i_answer / 100 )
138 msg_Dbg( p_access, "user accepted" );
141 msg_Dbg( p_access, "password needed" );
142 psz = var_CreateGetString( p_access, "ftp-pwd" );
143 if( ftp_SendCommand( p_access, "PASS %s", psz ) < 0 ||
144 ftp_ReadCommand( p_access, &i_answer, NULL ) < 0 )
151 switch( i_answer / 100 )
154 msg_Dbg( p_access, "password accepted" );
157 msg_Dbg( p_access, "account needed" );
158 psz = var_CreateGetString( p_access, "ftp-account" );
159 if( ftp_SendCommand( p_access, "ACCT %s",
161 ftp_ReadCommand( p_access, &i_answer, NULL ) < 0 )
168 if( i_answer / 100 != 2 )
170 msg_Err( p_access, "account rejected" );
173 msg_Dbg( p_access, "account accepted" );
177 msg_Err( p_access, "password rejected" );
182 msg_Err( p_access, "user rejected" );
189 /****************************************************************************
190 * Open: connect to ftp server and ask for file
191 ****************************************************************************/
192 static int Open( vlc_object_t *p_this )
194 access_t *p_access = (access_t*)p_this;
202 p_access->pf_read = Read;
203 p_access->pf_block = NULL;
204 p_access->pf_seek = Seek;
205 p_access->pf_control = Control;
206 p_access->info.i_update = 0;
207 p_access->info.i_size = 0;
208 p_access->info.i_pos = 0;
209 p_access->info.b_eof = VLC_FALSE;
210 p_access->info.i_title = 0;
211 p_access->info.i_seekpoint = 0;
212 p_access->p_sys = p_sys = malloc( sizeof( access_sys_t ) );
213 memset( p_sys, 0, sizeof( access_sys_t ) );
217 /* *** Parse URL and get server addr/port and path *** */
218 psz = p_access->psz_path;
223 vlc_UrlParse( &p_sys->url, psz, 0 );
225 if( p_sys->url.psz_host == NULL || *p_sys->url.psz_host == '\0' )
227 msg_Err( p_access, "invalid server name" );
230 if( p_sys->url.i_port <= 0 )
232 p_sys->url.i_port = 21; /* default port */
235 /* FTP URLs are relative to user's default directory (RFC1738)
236 For absolute path use ftp://foo.bar//usr/local/etc/filename */
238 if( *p_sys->url.psz_path == '/' )
239 p_sys->url.psz_path++;
241 if( Connect( p_access, p_sys ) < 0 )
244 /* Extended passive mode */
245 if( ftp_SendCommand( p_access, "EPSV ALL" ) < 0 )
247 msg_Err( p_access, "cannot request extended passive mode" );
251 if( ftp_ReadCommand( p_access, &i_answer, NULL ) == 2 )
253 if( net_GetPeerAddress( p_sys->fd_cmd, p_sys->sz_epsv_ip, NULL ) )
258 /* If ESPV ALL fails, we fallback to PASV.
259 * We have to restart the connection in case there is a NAT that
260 * understands EPSV ALL in the way, and hence won't allow PASV on
261 * the initial connection.
263 net_Close( p_sys->fd_cmd );
265 *p_sys->sz_epsv_ip = '\0';
267 if( ( p_sys->fd_cmd = Connect( p_access, p_sys ) ) < 0 )
270 msg_Info( p_access, "FTP Extended passive mode disabled" );
274 if( ftp_SendCommand( p_access, "TYPE I" ) < 0 ||
275 ftp_ReadCommand( p_access, &i_answer, NULL ) != 2 )
277 msg_Err( p_access, "cannot set binary transfer mode" );
282 if( ftp_SendCommand( p_access, "SIZE %s", p_sys->url.psz_path ) < 0 ||
283 ftp_ReadCommand( p_access, &i_answer, &psz_arg ) != 2 )
285 msg_Err( p_access, "cannot get file size" );
288 p_access->info.i_size = atoll( &psz_arg[4] );
290 msg_Dbg( p_access, "file size: "I64Fd, p_access->info.i_size );
292 /* Start the 'stream' */
293 if( ftp_StartStream( p_access, 0 ) < 0 )
295 msg_Err( p_access, "cannot retrieve file" );
299 /* Update default_pts to a suitable value for ftp access */
300 var_Create( p_access, "ftp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
305 if( p_sys->fd_cmd >= 0 )
306 net_Close( p_sys->fd_cmd );
307 vlc_UrlClean( &p_sys->url );
312 /*****************************************************************************
313 * Close: free unused data structures
314 *****************************************************************************/
315 static void Close( vlc_object_t *p_this )
317 access_t *p_access = (access_t*)p_this;
318 access_sys_t *p_sys = p_access->p_sys;
320 msg_Dbg( p_access, "stopping stream" );
321 ftp_StopStream( p_access );
323 if( ftp_SendCommand( p_access, "QUIT" ) < 0 )
325 msg_Warn( p_access, "cannot quit" );
329 ftp_ReadCommand( p_access, NULL, NULL );
331 net_Close( p_sys->fd_cmd );
334 vlc_UrlClean( &p_sys->url );
338 /*****************************************************************************
339 * Seek: try to go at the right place
340 *****************************************************************************/
341 static int Seek( access_t *p_access, int64_t i_pos )
347 msg_Dbg( p_access, "seeking to "I64Fd, i_pos );
349 ftp_StopStream( p_access );
350 if( ftp_StartStream( p_access, i_pos ) < 0 )
352 p_access->info.b_eof = VLC_TRUE;
356 p_access->info.b_eof = VLC_FALSE;
357 p_access->info.i_pos = i_pos;
362 /*****************************************************************************
364 *****************************************************************************/
365 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
367 access_sys_t *p_sys = p_access->p_sys;
370 if( p_access->info.b_eof )
373 i_read = net_Read( p_access, p_sys->fd_data, NULL, p_buffer, i_len,
376 p_access->info.b_eof = VLC_TRUE;
377 else if( i_read > 0 )
378 p_access->info.i_pos += i_read;
383 /*****************************************************************************
385 *****************************************************************************/
386 static int Control( access_t *p_access, int i_query, va_list args )
396 case ACCESS_CAN_SEEK:
397 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
400 case ACCESS_CAN_FASTSEEK:
401 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
402 *pb_bool = VLC_FALSE;
404 case ACCESS_CAN_PAUSE:
405 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
406 *pb_bool = VLC_TRUE; /* FIXME */
408 case ACCESS_CAN_CONTROL_PACE:
409 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
410 *pb_bool = VLC_TRUE; /* FIXME */
415 pi_int = (int*)va_arg( args, int * );
419 case ACCESS_GET_PTS_DELAY:
420 pi_64 = (int64_t*)va_arg( args, int64_t * );
421 var_Get( p_access, "ftp-caching", &val );
422 *pi_64 = (int64_t)var_GetInteger( p_access, "ftp-caching" ) * I64C(1000);
426 case ACCESS_SET_PAUSE_STATE:
430 case ACCESS_GET_TITLE_INFO:
431 case ACCESS_SET_TITLE:
432 case ACCESS_SET_SEEKPOINT:
433 case ACCESS_SET_PRIVATE_ID_STATE:
437 msg_Warn( p_access, "unimplemented query in control" );
444 /*****************************************************************************
446 *****************************************************************************/
447 static int ftp_SendCommand( access_t *p_access, char *psz_fmt, ... )
449 access_sys_t *p_sys = p_access->p_sys;
453 va_start( args, psz_fmt );
454 vasprintf( &psz_cmd, psz_fmt, args );
457 msg_Dbg( p_access, "ftp_SendCommand:\"%s\"", psz_cmd);
458 if( net_Printf( VLC_OBJECT(p_access), p_sys->fd_cmd, NULL, "%s\r\n",
461 msg_Err( p_access, "failed to send command" );
467 /* TODO support this s**t :
468 RFC 959 allows the client to send certain TELNET strings at any moment,
469 even in the middle of a request:
472 * \377\376x where x is one byte.
473 * \377\375x where x is one byte. The server is obliged to send \377\374x
474 * immediately after reading x.
475 * \377\374x where x is one byte.
476 * \377\373x where x is one byte. The server is obliged to send \377\376x
477 * immediately after reading x.
478 * \377x for any other byte x.
480 These strings are not part of the requests, except in the case \377\377,
481 where the request contains one \377. */
482 static int ftp_ReadCommand( access_t *p_access,
483 int *pi_answer, char **ppsz_answer )
485 access_sys_t *p_sys = p_access->p_sys;
489 psz_line = net_Gets( p_access, p_sys->fd_cmd, NULL );
490 msg_Dbg( p_access, "answer=%s", psz_line );
491 if( psz_line == NULL || strlen( psz_line ) < 3 )
493 msg_Err( p_access, "cannot get answer" );
494 if( psz_line ) free( psz_line );
495 if( pi_answer ) *pi_answer = 500;
496 if( ppsz_answer ) *ppsz_answer = NULL;
500 if( psz_line[3] == '-' ) /* Multiple response */
504 memcpy( end, psz_line, 3 );
509 char *psz_tmp = net_Gets( p_access, p_sys->fd_cmd, NULL );
511 if( psz_tmp == NULL ) /* Error */
514 if( !strncmp( psz_tmp, end, 4 ) )
523 i_answer = atoi( psz_line );
525 if( pi_answer ) *pi_answer = i_answer;
528 *ppsz_answer = psz_line;
534 return( i_answer / 100 );
537 static int ftp_StartStream( access_t *p_access, off_t i_start )
539 access_sys_t *p_sys = p_access->p_sys;
541 char psz_ipv4[16], *psz_ip;
543 char *psz_arg, *psz_parser;
546 psz_ip = p_sys->sz_epsv_ip;
548 if( ( ftp_SendCommand( p_access, *psz_ip ? "EPSV" : "PASV" ) < 0 )
549 || ( ftp_ReadCommand( p_access, &i_answer, &psz_arg ) != 2 ) )
551 msg_Err( p_access, "cannot set passive mode" );
555 psz_parser = strchr( psz_arg, '(' );
556 if( psz_parser == NULL )
559 msg_Err( p_access, "cannot parse passive mode response" );
565 char psz_fmt[7] = "(|||%u";
566 psz_fmt[1] = psz_fmt[2] = psz_fmt[3] = psz_parser[1];
568 if( sscanf( psz_parser, psz_fmt, &i_port ) < 1 )
571 msg_Err( p_access, "cannot parse passive mode response" );
577 unsigned a1, a2, a3, a4, p1, p2;
579 if( ( sscanf( psz_parser, "(%u,%u,%u,%u,%u,%u", &a1, &a2, &a3, &a4,
580 &p1, &p2 ) < 6 ) || ( a1 > 255 ) || ( a2 > 255 )
581 || ( a3 > 255 ) || ( a4 > 255 ) || ( p1 > 255 ) || ( p2 > 255 ) )
584 msg_Err( p_access, "cannot parse passive mode response" );
588 sprintf( psz_ipv4, "%u.%u.%u.%u", a1, a2, a3, a4 );
590 i_port = (p1 << 8) | p2;
594 msg_Dbg( p_access, "ip:%s port:%d", psz_ip, i_port );
596 if( ftp_SendCommand( p_access, "TYPE I" ) < 0 ||
597 ftp_ReadCommand( p_access, &i_answer, NULL ) != 2 )
599 msg_Err( p_access, "cannot set binary transfer mode" );
605 if( ftp_SendCommand( p_access, "REST "I64Fu, i_start ) < 0 ||
606 ftp_ReadCommand( p_access, &i_answer, NULL ) > 3 )
608 msg_Err( p_access, "cannot set restart point" );
613 msg_Dbg( p_access, "waiting for data connection..." );
614 p_sys->fd_data = net_ConnectTCP( p_access, psz_ip, i_port );
615 if( p_sys->fd_data < 0 )
617 msg_Err( p_access, "failed to connect with server" );
620 msg_Dbg( p_access, "connection with \"%s:%d\" successful",
624 if( ftp_SendCommand( p_access, "RETR %s", p_sys->url.psz_path ) < 0 ||
625 ftp_ReadCommand( p_access, &i_answer, NULL ) > 2 )
627 msg_Err( p_access, "cannot retreive file" );
633 static int ftp_StopStream ( access_t *p_access )
635 access_sys_t *p_sys = p_access->p_sys;
639 if( ftp_SendCommand( p_access, "ABOR" ) < 0 )
641 msg_Warn( p_access, "cannot abort file" );
642 if( p_sys->fd_data > 0 )
643 net_Close( p_sys->fd_data );
647 if( p_sys->fd_data > 0 )
649 net_Close( p_sys->fd_data );
651 ftp_ReadCommand( p_access, &i_answer, NULL );
653 ftp_ReadCommand( p_access, &i_answer, NULL );