1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2001, 2002 VideoLAN
5 * $Id: ftp.c,v 1.10 2003/03/24 17:15:29 gbazin Exp $
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
28 #include <sys/types.h>
36 #include <vlc/input.h>
38 #ifdef HAVE_SYS_TIME_H
39 # include <sys/time.h>
47 # include <winsock2.h>
48 # include <ws2tcpip.h>
50 # define IN_MULTICAST(a) IN_CLASSD(a)
53 # include <sys/socket.h>
54 # include <netinet/in.h>
56 # include <arpa/inet.h>
57 # elif defined( SYS_BEOS )
58 # include <net/netdb.h>
64 /*****************************************************************************
66 *****************************************************************************/
67 static int Open ( vlc_object_t * );
68 static void Close ( vlc_object_t * );
70 static int Read ( input_thread_t * p_input, byte_t * p_buffer,
72 static void Seek ( input_thread_t *, off_t );
73 static int SetProgram ( input_thread_t *, pgrm_descriptor_t * );
76 static ssize_t NetRead ( input_thread_t *, input_socket_t *, byte_t *, size_t );
77 static void NetClose( input_thread_t *, input_socket_t *);
79 static int ftp_SendCommand( input_thread_t *, char *, ... );
80 static int ftp_ReadCommand( input_thread_t *, int *, char ** );
81 static int ftp_StartStream( input_thread_t *, off_t );
82 static int ftp_StopStream ( input_thread_t *);
84 /*****************************************************************************
86 *****************************************************************************/
87 #define CACHING_TEXT N_("caching value in ms")
88 #define CACHING_LONGTEXT N_( \
89 "Allows you to modify the default caching value for ftp streams. This " \
90 "value should be set in miliseconds units." )
93 set_description( _("ftp access module") );
94 set_capability( "access", 0 );
95 add_category_hint( "stream", NULL, VLC_FALSE );
96 add_integer( "ftp-caching", 2 * DEFAULT_PTS_DELAY / 1000, NULL,
97 CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
98 add_string( "ftp-user", "anonymous", NULL, "ftp user name", "ftp user name", VLC_FALSE );
99 add_string( "ftp-pwd", "anonymous@dummy.org", NULL, "ftp password", "ftp password, be careful with that option...", VLC_FALSE );
100 add_string( "ftp-account", "anonymous", NULL, "ftp account", "ftp account", VLC_FALSE );
101 add_shortcut( "ftp" );
102 set_callbacks( Open, Close );
105 /* url: [/]host[:port][/path] */
108 char *psz_server_addr;
120 static void ftp_ParseURL( url_t *, char * );
122 #define FREE( p ) if( p ) free( p )
124 typedef struct access_s
126 input_socket_t socket_cmd;
127 input_socket_t socket_data;
129 url_t url; /* connect to this server */
138 /****************************************************************************
139 ****************************************************************************
140 ******************* *******************
141 ******************* Main functions *******************
142 ******************* *******************
143 ****************************************************************************
144 ****************************************************************************/
146 /****************************************************************************
147 * Open: connect to ftp server and ask for file
148 ****************************************************************************/
149 static int Open( vlc_object_t *p_this )
151 input_thread_t *p_input = (input_thread_t*)p_this;
157 network_socket_t socket_desc;
161 char *psz_user, *psz_pwd, *psz_account;
165 /* *** allocate p_access_data *** */
166 p_input->p_access_data =
167 (void*)p_access = malloc( sizeof( access_t ) );
168 memset( p_access, 0, sizeof( access_t ) );
169 p_url = &p_access->url;
171 /* *** Parse URL and get server addr/port and path *** */
172 ftp_ParseURL( p_url, p_input->psz_name );
174 if( p_url->psz_server_addr == NULL ||
175 !( *p_url->psz_server_addr ) )
177 FREE( p_url->psz_private );
178 msg_Err( p_input, "invalid server name" );
181 if( p_url->i_server_port == 0 )
183 p_url->i_server_port = 21; /* default port */
186 /* 2: look at ip version ipv4/ipv6 */
188 if( config_GetInt( p_input, "ipv4" ) )
190 psz_network = "ipv4";
192 else if( config_GetInt( p_input, "ipv6" ) )
194 psz_network = "ipv6";
197 /* 3: Open a TCP connection with server *** */
198 msg_Dbg( p_input, "waiting for connection..." );
199 socket_desc.i_type = NETWORK_TCP;
200 socket_desc.psz_server_addr = p_url->psz_server_addr;
201 socket_desc.i_server_port = p_url->i_server_port;
202 socket_desc.psz_bind_addr = "";
203 socket_desc.i_bind_port = 0;
204 p_input->p_private = (void*)&socket_desc;
205 if( !( p_network = module_Need( p_input, "network", psz_network ) ) )
207 msg_Err( p_input, "failed to connect with server" );
208 FREE( p_access->url.psz_private );
209 FREE( p_input->p_access_data );
212 module_Unneed( p_input, p_network );
213 p_access->socket_cmd.i_handle = socket_desc.i_handle;
214 p_input->i_mtu = socket_desc.i_mtu;
216 "connection with \"%s:%d\" successful",
217 p_url->psz_server_addr,
218 p_url->i_server_port );
223 if( ftp_ReadCommand( p_input, &i_answer, NULL ) < 0)
225 msg_Err( p_input, "failed to get answer" );
228 if( i_answer / 100 != 1 )
234 if( i_answer / 100 != 2 )
236 msg_Err( p_input, "connection rejected" );
241 msg_Dbg( p_input, "connection accepted (%d)", i_answer );
244 psz_user = config_GetPsz( p_input, "ftp-user" );
245 if( ftp_SendCommand( p_input, "USER %s", psz_user ) < 0 )
252 if( ftp_ReadCommand( p_input, &i_answer, NULL ) < 0)
254 msg_Err( p_input, "failed to get answer" );
257 switch( i_answer / 100 )
260 msg_Dbg( p_input, "user accepted" );
263 msg_Dbg( p_input, "password needed" );
264 psz_pwd = config_GetPsz( p_input, "ftp-pwd" );
265 if( ftp_SendCommand( p_input, "PASS %s", psz_pwd ) < 0 )
271 if( ftp_ReadCommand( p_input, &i_answer, NULL ) < 0)
273 msg_Err( p_input, "failed to get answer" );
276 switch( i_answer / 100 )
279 msg_Dbg( p_input, "password accepted" );
282 msg_Dbg( p_input, "account needed" );
283 psz_account = config_GetPsz( p_input, "ftp-account" );
284 if( ftp_SendCommand( p_input, "ACCT %s", psz_account ) < 0 )
290 if( ftp_ReadCommand( p_input, &i_answer, NULL ) < 0)
292 msg_Err( p_input, "failed to get answer" );
295 if( i_answer / 100 != 2 )
297 msg_Err( p_input, "account rejected" );
302 msg_Dbg( p_input, "account accepted" );
306 msg_Err( p_input, "password rejected" );
311 msg_Err( p_input, "user rejected" );
315 if( ftp_SendCommand( p_input, "TYPE I" ) < 0 )
317 msg_Err( p_input, "cannot set binary transfert mode" );
320 if( ftp_ReadCommand( p_input, &i_answer, NULL ) != 2 )
322 msg_Err( p_input, "cannot set binary transfert mode" );
327 if( ftp_SendCommand( p_input, "SIZE %s", p_url->psz_path ) < 0 )
329 msg_Err( p_input, "cannot get file size" );
332 if( ftp_ReadCommand( p_input, &i_answer, &psz_arg ) != 2 )
334 msg_Err( p_input, "cannot get file size" );
339 p_access->i_filesize = atoll( psz_arg + 4 );
343 char *psz_parser = psz_arg + 4;
345 while( *psz_parser == ' ' ) psz_parser++;
347 while( psz_parser[0] >= '0' && psz_parser[0] <= '9' )
350 i_size += psz_parser[0] - '0';
352 p_access->i_filesize = i_size;
356 msg_Dbg( p_input, "file size: "I64Fd, p_access->i_filesize );
359 if( ftp_StartStream( p_input, 0 ) < 0 )
361 msg_Err( p_input, "cannot retrieve file" );
364 /* *** set exported functions *** */
365 p_input->pf_read = Read;
366 p_input->pf_seek = Seek;
367 p_input->pf_set_program = SetProgram;
368 p_input->pf_set_area = NULL;
370 p_input->p_private = NULL;
372 /* *** finished to set some variable *** */
373 vlc_mutex_lock( &p_input->stream.stream_lock );
374 p_input->stream.b_pace_control = 1;
375 p_input->stream.p_selected_area->i_tell = 0;
376 p_input->stream.b_seekable = 1;
377 p_input->stream.p_selected_area->i_size = p_access->i_filesize;
378 p_input->stream.i_method = INPUT_METHOD_NETWORK;
379 vlc_mutex_unlock( &p_input->stream.stream_lock );
381 /* Update default_pts to a suitable value for ftp access */
382 p_input->i_pts_delay = config_GetInt( p_input, "ftp-caching" ) * 1000;
387 NetClose( p_input, &p_access->socket_cmd );
388 FREE( p_access->url.psz_private );
389 FREE( p_input->p_access_data );
393 /*****************************************************************************
394 * Close: free unused data structures
395 *****************************************************************************/
396 static void Close( vlc_object_t *p_this )
398 input_thread_t *p_input = (input_thread_t *)p_this;
399 access_t *p_access = (access_t*)p_input->p_access_data;
401 msg_Dbg( p_input, "stopping stream" );
402 ftp_StopStream( p_input );
404 if( ftp_SendCommand( p_input, "QUIT" ) < 0 )
406 msg_Err( p_input, "cannot quit" );
410 ftp_ReadCommand( p_input, NULL, NULL );
414 NetClose( p_input, &p_access->socket_cmd );
417 FREE( p_access->url.psz_private );
420 /*****************************************************************************
421 * SetProgram: do nothing
422 *****************************************************************************/
423 static int SetProgram( input_thread_t * p_input,
424 pgrm_descriptor_t * p_program )
429 /*****************************************************************************
430 * Seek: try to go at the right place
431 *****************************************************************************/
432 static void Seek( input_thread_t * p_input, off_t i_pos )
434 //access_t *p_access = (access_t*)p_input->p_access_data;
439 vlc_mutex_lock( &p_input->stream.stream_lock );
441 msg_Dbg( p_input, "seeking to "I64Fd, i_pos );
443 ftp_StopStream( p_input );
444 ftp_StartStream( p_input, i_pos );
446 p_input->stream.p_selected_area->i_tell = i_pos;
447 vlc_mutex_unlock( &p_input->stream.stream_lock );
450 static int Read ( input_thread_t * p_input, byte_t * p_buffer,
453 access_t *p_access = (access_t*)p_input->p_access_data;
456 i_data = NetRead( p_input, &p_access->socket_data, p_buffer, i_len );
461 static int ftp_SendCommand( input_thread_t *p_input, char *psz_fmt, ... )
463 access_t *p_access = (access_t*)p_input->p_access_data;
466 #if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN)
470 va_start( args, psz_fmt );
472 #if defined(HAVE_VASPRINTF) && !defined(SYS_DARWIN)
473 vasprintf( &psz_buffer, psz_fmt, args );
475 i_size = strlen( psz_fmt ) + 2048;
476 psz_buffer = calloc( i_size, sizeof( char ) );
477 vsnprintf( psz_buffer, i_size, psz_fmt, args );
478 psz_buffer[i_size - 1] = 0;
480 if( !strncmp( psz_buffer, "PASS", 4 ) )
482 msg_Dbg( p_input, "ftp_SendCommand:\"PASS xxx\"" );
486 msg_Dbg( p_input, "ftp_SendCommand:\"%s\"", psz_buffer );
488 psz_buffer = realloc( psz_buffer, strlen( psz_buffer ) + 3 );
489 strcat( psz_buffer, "\r\n" );
490 if( send( p_access->socket_cmd.i_handle,
492 strlen( psz_buffer ),
496 msg_Err( p_input, "failed to send command" );
506 #define BLOCK_SIZE 1024
507 /* TODO support this s**t :
508 RFC 959 allows the client to send certain TELNET strings at any moment,
509 even in the middle of a request:
512 * \377\376x where x is one byte.
513 * \377\375x where x is one byte. The server is obliged to send \377\374x
514 * immediately after reading x.
515 * \377\374x where x is one byte.
516 * \377\373x where x is one byte. The server is obliged to send \377\376x
517 * immediately after reading x.
518 * \377x for any other byte x.
520 These strings are not part of the requests, except in the case \377\377,
521 where the request contains one \377. */
523 static int ftp_ReadCommand( input_thread_t *p_input,
524 int *pi_answer, char **ppsz_answer )
526 access_t *p_access = (access_t*)p_input->p_access_data;
534 i_buffer_size = BLOCK_SIZE + 1;
535 p_buffer = malloc( BLOCK_SIZE + 1);
540 i_read = NetRead( p_input, &p_access->socket_cmd,
541 p_buffer + i_buffer, BLOCK_SIZE );
542 if( i_read <= 0 || p_input->b_die || p_input->b_error )
545 if( pi_answer ) *pi_answer = 500;
546 if( ppsz_answer ) *ppsz_answer = NULL;
554 if( i_read < BLOCK_SIZE )
556 p_buffer[i_buffer] = '\0';
559 i_buffer_size += BLOCK_SIZE;
560 p_buffer = realloc( p_buffer, i_buffer_size );
568 i_answer = atoi( p_buffer );
570 if( pi_answer ) *pi_answer = i_answer;
573 *ppsz_answer = p_buffer;
579 return( i_answer / 100 );
583 if( pi_answer ) *pi_answer = 500;
584 if( ppsz_answer ) *ppsz_answer = NULL;
588 static int ftp_StartStream( input_thread_t *p_input, off_t i_start )
590 access_t *p_access = (access_t*)p_input->p_access_data;
594 char *psz_arg, *psz_parser;
599 network_socket_t socket_desc;
601 if( ftp_SendCommand( p_input, "PASV" ) < 0 )
603 msg_Err( p_input, "cannot set passive transfert mode" );
606 if( ftp_ReadCommand( p_input, &i_answer, &psz_arg ) != 2 )
608 msg_Err( p_input, "cannot set passive transfert mode" );
611 psz_parser = strchr( psz_arg, '(' );
612 if( !psz_parser || sscanf( psz_parser, "(%d,%d,%d,%d,%d,%d", &a1, &a2, &a3, &a4, &p1, &p2 ) < 6 )
615 msg_Err( p_input, "cannot get ip/port for passive transfert mode" );
620 sprintf( psz_ip, "%d.%d.%d.%d", a1, a2, a3, a4 );
621 i_port = p1 * 256 + p2;
622 msg_Dbg( p_input, "ip:%s port:%d", psz_ip, i_port );
624 if( ftp_SendCommand( p_input, "TYPE I" ) < 0 )
626 msg_Err( p_input, "cannot set binary transfert mode" );
629 if( ftp_ReadCommand( p_input, &i_answer, NULL ) != 2 )
631 msg_Err( p_input, "cannot set binary transfert mode" );
638 if( ftp_SendCommand( p_input, "REST "I64Fu, i_start ) < 0 )
640 msg_Err( p_input, "cannot set restart point" );
643 if( ftp_ReadCommand( p_input, &i_answer, NULL ) > 3 )
645 msg_Err( p_input, "cannot set restart point" );
650 msg_Dbg( p_input, "waiting for data connection..." );
651 socket_desc.i_type = NETWORK_TCP;
652 socket_desc.psz_server_addr = psz_ip;
653 socket_desc.i_server_port = i_port;
654 socket_desc.psz_bind_addr = "";
655 socket_desc.i_bind_port = 0;
656 p_input->p_private = (void*)&socket_desc;
657 if( !( p_network = module_Need( p_input, "network", "" ) ) )
659 msg_Err( p_input, "failed to connect with server" );
662 module_Unneed( p_input, p_network );
663 p_access->socket_data.i_handle = socket_desc.i_handle;
664 p_input->i_mtu = socket_desc.i_mtu;
666 "connection with \"%s:%d\" successful",
669 if( ftp_SendCommand( p_input, "RETR %s", p_access->url.psz_path ) < 0 )
671 msg_Err( p_input, "cannot retreive file" );
675 if( ftp_ReadCommand( p_input, &i_answer, NULL ) > 2 )
677 msg_Err( p_input, "cannot retreive file" );
684 static int ftp_StopStream ( input_thread_t *p_input)
686 access_t *p_access = (access_t*)p_input->p_access_data;
690 NetClose( p_input, &p_access->socket_data );
692 if( ftp_SendCommand( p_input, "ABOR" ) < 0 )
694 msg_Err( p_input, "cannot abord file" );
698 ftp_ReadCommand( p_input, &i_answer, NULL );
699 ftp_ReadCommand( p_input, &i_answer, NULL );
705 /****************************************************************************
707 ****************************************************************************/
708 static void ftp_ParseURL( url_t *p_url, char *psz_url )
711 char *psz_server_port;
713 p_url->psz_private = strdup( psz_url );
715 psz_parser = p_url->psz_private;
717 while( *psz_parser == '/' )
721 p_url->psz_server_addr = psz_parser;
723 while( *psz_parser &&
724 *psz_parser != ':' && *psz_parser != '/' && *psz_parser != '@' )
729 if( *psz_parser == ':' )
733 psz_server_port = psz_parser;
735 while( *psz_parser && *psz_parser != '/' )
742 psz_server_port = "";
745 if( *psz_parser == '@' )
752 p_url->psz_bind_addr = psz_parser;
754 while( *psz_parser && *psz_parser != ':' && *psz_parser != '/' )
759 if( *psz_parser == ':' )
763 psz_bind_port = psz_parser;
765 while( *psz_parser && *psz_parser != '/' )
776 p_url->i_bind_port = strtol( psz_bind_port, &psz_parser, 10 );
780 p_url->i_bind_port = 0;
785 p_url->psz_bind_addr = "";
786 p_url->i_bind_port = 0;
789 if( *psz_parser == '/' )
793 p_url->psz_path = psz_parser;
796 if( *psz_server_port )
798 p_url->i_server_port = strtol( psz_server_port, &psz_parser, 10 );
802 p_url->i_server_port = 0;
806 /*****************************************************************************
807 * Read: read on a file descriptor, checking b_die periodically
808 *****************************************************************************/
809 static ssize_t NetRead( input_thread_t *p_input,
810 input_socket_t *p_socket,
811 byte_t *p_buffer, size_t i_len )
817 struct timeval timeout;
822 /* Initialize file descriptor set */
824 FD_SET( p_socket->i_handle, &fds );
826 /* We'll wait 1 second if nothing happens */
828 timeout.tv_usec = 1000000;
830 /* Find if some data is available */
831 while( (i_ret = select( p_socket->i_handle + 1, &fds,
832 NULL, NULL, &timeout )) == 0
833 || (i_ret < 0 && errno == EINTR) )
835 if( p_input->b_die || p_input->b_error )
843 msg_Err( p_input, "network select error (%s)", strerror(errno) );
847 i_recv = recv( p_socket->i_handle, p_buffer, i_len, 0 );
851 msg_Err( p_input, "recv failed (%s)", strerror(errno) );
859 static void NetClose( input_thread_t *p_input, input_socket_t *p_socket )
861 #if defined( UNDER_CE )
862 CloseHandle( (HANDLE)p_socket->i_handle );
863 #elif defined( WIN32 )
864 closesocket( p_socket->i_handle );
866 close( p_socket->i_handle );