1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2001-2003 VideoLAN
5 * $Id: ftp.c,v 1.21 2003/09/10 21:09:05 fenrir 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>
35 #include <vlc/input.h>
37 #ifdef HAVE_SYS_TIME_H
38 # include <sys/time.h>
46 # include <winsock2.h>
47 # include <ws2tcpip.h>
49 # define IN_MULTICAST(a) IN_CLASSD(a)
52 # include <sys/socket.h>
53 # include <netinet/in.h>
55 # include <arpa/inet.h>
56 # elif defined( SYS_BEOS )
57 # include <net/netdb.h>
63 /*****************************************************************************
65 *****************************************************************************/
66 static int Open ( vlc_object_t * );
67 static void Close ( vlc_object_t * );
69 static ssize_t Read ( input_thread_t * p_input, byte_t * p_buffer,
71 static void Seek ( input_thread_t *, off_t );
74 static ssize_t NetRead ( input_thread_t *, input_socket_t *, byte_t *, size_t );
75 static void NetClose( input_thread_t *, input_socket_t *);
77 static int ftp_SendCommand( input_thread_t *, char *, ... );
78 static int ftp_ReadCommand( input_thread_t *, int *, char ** );
79 static int ftp_StartStream( input_thread_t *, off_t );
80 static int ftp_StopStream ( input_thread_t *);
82 /*****************************************************************************
84 *****************************************************************************/
85 #define CACHING_TEXT N_("Caching value in ms")
86 #define CACHING_LONGTEXT N_( \
87 "Allows you to modify the default caching value for ftp streams. This " \
88 "value should be set in miliseconds units." )
91 set_description( _("FTP input") );
92 set_capability( "access", 0 );
93 add_category_hint( "stream", NULL, VLC_FALSE );
94 add_integer( "ftp-caching", 2 * DEFAULT_PTS_DELAY / 1000, NULL,
95 CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
96 add_string( "ftp-user", "anonymous", NULL, "ftp user name", "ftp user name", VLC_FALSE );
97 add_string( "ftp-pwd", "anonymous@dummy.org", NULL, "ftp password", "ftp password, be careful with that option...", VLC_FALSE );
98 add_string( "ftp-account", "anonymous", NULL, "ftp account", "ftp account", VLC_FALSE );
99 add_shortcut( "ftp" );
100 set_callbacks( Open, Close );
103 /* url: [/]host[:port][/path] */
106 char *psz_server_addr;
118 static void ftp_ParseURL( url_t *, char * );
120 #define FREE( p ) if( p ) free( p )
122 typedef struct access_s
124 input_socket_t socket_cmd;
125 input_socket_t socket_data;
127 url_t url; /* connect to this server */
136 /****************************************************************************
137 ****************************************************************************
138 ******************* *******************
139 ******************* Main functions *******************
140 ******************* *******************
141 ****************************************************************************
142 ****************************************************************************/
144 /****************************************************************************
145 * Open: connect to ftp server and ask for file
146 ****************************************************************************/
147 static int Open( vlc_object_t *p_this )
149 input_thread_t *p_input = (input_thread_t*)p_this;
155 network_socket_t socket_desc;
159 char *psz_user, *psz_pwd, *psz_account;
163 /* *** allocate p_access_data *** */
164 p_input->p_access_data =
165 (void*)p_access = malloc( sizeof( access_t ) );
166 memset( p_access, 0, sizeof( access_t ) );
167 p_url = &p_access->url;
169 /* *** Parse URL and get server addr/port and path *** */
170 ftp_ParseURL( p_url, p_input->psz_name );
172 if( p_url->psz_server_addr == NULL ||
173 !( *p_url->psz_server_addr ) )
175 FREE( p_url->psz_private );
176 msg_Err( p_input, "invalid server name" );
179 if( p_url->i_server_port == 0 )
181 p_url->i_server_port = 21; /* default port */
184 /* 2: look at ip version ipv4/ipv6 */
186 if( config_GetInt( p_input, "ipv4" ) )
188 psz_network = "ipv4";
190 else if( config_GetInt( p_input, "ipv6" ) )
192 psz_network = "ipv6";
195 /* 3: Open a TCP connection with server *** */
196 msg_Dbg( p_input, "waiting for connection..." );
197 socket_desc.i_type = NETWORK_TCP;
198 socket_desc.psz_server_addr = p_url->psz_server_addr;
199 socket_desc.i_server_port = p_url->i_server_port;
200 socket_desc.psz_bind_addr = "";
201 socket_desc.i_bind_port = 0;
202 socket_desc.i_ttl = 0;
203 p_input->p_private = (void*)&socket_desc;
204 if( !( p_network = module_Need( p_input, "network", psz_network ) ) )
206 msg_Err( p_input, "failed to connect with server" );
207 FREE( p_access->url.psz_private );
208 FREE( p_input->p_access_data );
211 module_Unneed( p_input, p_network );
212 p_access->socket_cmd.i_handle = socket_desc.i_handle;
213 p_input->i_mtu = socket_desc.i_mtu;
215 "connection with \"%s:%d\" successful",
216 p_url->psz_server_addr,
217 p_url->i_server_port );
222 if( ftp_ReadCommand( p_input, &i_answer, NULL ) < 0)
224 msg_Err( p_input, "failed to get answer" );
227 if( i_answer / 100 != 1 )
233 if( i_answer / 100 != 2 )
235 msg_Err( p_input, "connection rejected" );
240 msg_Dbg( p_input, "connection accepted (%d)", i_answer );
243 psz_user = config_GetPsz( p_input, "ftp-user" );
244 if( ftp_SendCommand( p_input, "USER %s", psz_user ) < 0 )
251 if( ftp_ReadCommand( p_input, &i_answer, NULL ) < 0)
253 msg_Err( p_input, "failed to get answer" );
256 switch( i_answer / 100 )
259 msg_Dbg( p_input, "user accepted" );
262 msg_Dbg( p_input, "password needed" );
263 psz_pwd = config_GetPsz( p_input, "ftp-pwd" );
264 if( ftp_SendCommand( p_input, "PASS %s", psz_pwd ) < 0 )
270 if( ftp_ReadCommand( p_input, &i_answer, NULL ) < 0)
272 msg_Err( p_input, "failed to get answer" );
275 switch( i_answer / 100 )
278 msg_Dbg( p_input, "password accepted" );
281 msg_Dbg( p_input, "account needed" );
282 psz_account = config_GetPsz( p_input, "ftp-account" );
283 if( ftp_SendCommand( p_input, "ACCT %s", psz_account ) < 0 )
289 if( ftp_ReadCommand( p_input, &i_answer, NULL ) < 0)
291 msg_Err( p_input, "failed to get answer" );
294 if( i_answer / 100 != 2 )
296 msg_Err( p_input, "account rejected" );
301 msg_Dbg( p_input, "account accepted" );
305 msg_Err( p_input, "password rejected" );
310 msg_Err( p_input, "user rejected" );
314 if( ftp_SendCommand( p_input, "TYPE I" ) < 0 )
316 msg_Err( p_input, "cannot set binary transfert mode" );
319 if( ftp_ReadCommand( p_input, &i_answer, NULL ) != 2 )
321 msg_Err( p_input, "cannot set binary transfert mode" );
326 if( ftp_SendCommand( p_input, "SIZE %s", p_url->psz_path ) < 0 )
328 msg_Err( p_input, "cannot get file size" );
331 if( ftp_ReadCommand( p_input, &i_answer, &psz_arg ) != 2 )
333 msg_Err( p_input, "cannot get file size" );
337 p_access->i_filesize = atoll( psz_arg + 4 );
339 msg_Dbg( p_input, "file size: "I64Fd, p_access->i_filesize );
342 if( ftp_StartStream( p_input, 0 ) < 0 )
344 msg_Err( p_input, "cannot retrieve file" );
347 /* *** set exported functions *** */
348 p_input->pf_read = Read;
349 p_input->pf_seek = Seek;
350 p_input->pf_set_program = input_SetProgram;
351 p_input->pf_set_area = NULL;
353 p_input->p_private = NULL;
355 /* *** finished to set some variable *** */
356 vlc_mutex_lock( &p_input->stream.stream_lock );
357 p_input->stream.b_pace_control = 1;
358 p_input->stream.p_selected_area->i_tell = 0;
359 p_input->stream.b_seekable = 1;
360 p_input->stream.p_selected_area->i_size = p_access->i_filesize;
361 p_input->stream.i_method = INPUT_METHOD_NETWORK;
362 vlc_mutex_unlock( &p_input->stream.stream_lock );
364 /* Update default_pts to a suitable value for ftp access */
365 p_input->i_pts_delay = config_GetInt( p_input, "ftp-caching" ) * 1000;
370 NetClose( p_input, &p_access->socket_cmd );
371 FREE( p_access->url.psz_private );
372 FREE( p_input->p_access_data );
376 /*****************************************************************************
377 * Close: free unused data structures
378 *****************************************************************************/
379 static void Close( vlc_object_t *p_this )
381 input_thread_t *p_input = (input_thread_t *)p_this;
382 access_t *p_access = (access_t*)p_input->p_access_data;
384 msg_Dbg( p_input, "stopping stream" );
385 ftp_StopStream( p_input );
387 if( ftp_SendCommand( p_input, "QUIT" ) < 0 )
389 msg_Err( p_input, "cannot quit" );
393 ftp_ReadCommand( p_input, NULL, NULL );
397 NetClose( p_input, &p_access->socket_cmd );
400 FREE( p_access->url.psz_private );
403 /*****************************************************************************
404 * Seek: try to go at the right place
405 *****************************************************************************/
406 static void Seek( input_thread_t * p_input, off_t i_pos )
408 //access_t *p_access = (access_t*)p_input->p_access_data;
413 vlc_mutex_lock( &p_input->stream.stream_lock );
415 msg_Dbg( p_input, "seeking to "I64Fd, i_pos );
417 ftp_StopStream( p_input );
418 ftp_StartStream( p_input, i_pos );
420 p_input->stream.p_selected_area->i_tell = i_pos;
421 vlc_mutex_unlock( &p_input->stream.stream_lock );
424 static ssize_t Read ( input_thread_t * p_input, byte_t * p_buffer,
427 access_t *p_access = (access_t*)p_input->p_access_data;
430 i_data = NetRead( p_input, &p_access->socket_data, p_buffer, i_len );
435 static int ftp_SendCommand( input_thread_t *p_input, char *psz_fmt, ... )
437 access_t *p_access = (access_t*)p_input->p_access_data;
440 #if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
444 va_start( args, psz_fmt );
446 #if defined(HAVE_VASPRINTF) && !defined(SYS_DARWIN) && !defined(SYS_BEOS)
447 vasprintf( &psz_buffer, psz_fmt, args );
449 i_size = strlen( psz_fmt ) + 2048;
450 psz_buffer = calloc( i_size, sizeof( char ) );
451 vsnprintf( psz_buffer, i_size, psz_fmt, args );
452 psz_buffer[i_size - 1] = 0;
454 if( !strncmp( psz_buffer, "PASS", 4 ) )
456 msg_Dbg( p_input, "ftp_SendCommand:\"PASS xxx\"" );
460 msg_Dbg( p_input, "ftp_SendCommand:\"%s\"", psz_buffer );
462 psz_buffer = realloc( psz_buffer, strlen( psz_buffer ) + 3 );
463 strcat( psz_buffer, "\r\n" );
464 if( send( p_access->socket_cmd.i_handle,
466 strlen( psz_buffer ),
470 msg_Err( p_input, "failed to send command" );
480 #define BLOCK_SIZE 1024
481 /* TODO support this s**t :
482 RFC 959 allows the client to send certain TELNET strings at any moment,
483 even in the middle of a request:
486 * \377\376x where x is one byte.
487 * \377\375x where x is one byte. The server is obliged to send \377\374x
488 * immediately after reading x.
489 * \377\374x where x is one byte.
490 * \377\373x where x is one byte. The server is obliged to send \377\376x
491 * immediately after reading x.
492 * \377x for any other byte x.
494 These strings are not part of the requests, except in the case \377\377,
495 where the request contains one \377. */
497 static int ftp_ReadCommand( input_thread_t *p_input,
498 int *pi_answer, char **ppsz_answer )
500 access_t *p_access = (access_t*)p_input->p_access_data;
508 i_buffer_size = BLOCK_SIZE + 1;
509 p_buffer = malloc( BLOCK_SIZE + 1);
514 i_read = NetRead( p_input, &p_access->socket_cmd,
515 p_buffer + i_buffer, BLOCK_SIZE );
516 if( i_read <= 0 || p_input->b_die || p_input->b_error )
519 if( pi_answer ) *pi_answer = 500;
520 if( ppsz_answer ) *ppsz_answer = NULL;
528 if( i_read < BLOCK_SIZE )
530 p_buffer[i_buffer] = '\0';
533 i_buffer_size += BLOCK_SIZE;
534 p_buffer = realloc( p_buffer, i_buffer_size );
542 i_answer = atoi( p_buffer );
544 if( pi_answer ) *pi_answer = i_answer;
547 *ppsz_answer = p_buffer;
553 return( i_answer / 100 );
557 if( pi_answer ) *pi_answer = 500;
558 if( ppsz_answer ) *ppsz_answer = NULL;
562 static int ftp_StartStream( input_thread_t *p_input, off_t i_start )
564 access_t *p_access = (access_t*)p_input->p_access_data;
568 char *psz_arg, *psz_parser;
573 network_socket_t socket_desc;
575 if( ftp_SendCommand( p_input, "PASV" ) < 0 )
577 msg_Err( p_input, "cannot set passive transfert mode" );
580 if( ftp_ReadCommand( p_input, &i_answer, &psz_arg ) != 2 )
582 msg_Err( p_input, "cannot set passive transfert mode" );
585 psz_parser = strchr( psz_arg, '(' );
586 if( !psz_parser || sscanf( psz_parser, "(%d,%d,%d,%d,%d,%d", &a1, &a2, &a3, &a4, &p1, &p2 ) < 6 )
589 msg_Err( p_input, "cannot get ip/port for passive transfert mode" );
594 sprintf( psz_ip, "%d.%d.%d.%d", a1, a2, a3, a4 );
595 i_port = p1 * 256 + p2;
596 msg_Dbg( p_input, "ip:%s port:%d", psz_ip, i_port );
598 if( ftp_SendCommand( p_input, "TYPE I" ) < 0 )
600 msg_Err( p_input, "cannot set binary transfert mode" );
603 if( ftp_ReadCommand( p_input, &i_answer, NULL ) != 2 )
605 msg_Err( p_input, "cannot set binary transfert mode" );
612 if( ftp_SendCommand( p_input, "REST "I64Fu, i_start ) < 0 )
614 msg_Err( p_input, "cannot set restart point" );
617 if( ftp_ReadCommand( p_input, &i_answer, NULL ) > 3 )
619 msg_Err( p_input, "cannot set restart point" );
624 msg_Dbg( p_input, "waiting for data connection..." );
625 socket_desc.i_type = NETWORK_TCP;
626 socket_desc.psz_server_addr = psz_ip;
627 socket_desc.i_server_port = i_port;
628 socket_desc.psz_bind_addr = "";
629 socket_desc.i_bind_port = 0;
630 socket_desc.i_ttl = 0;
631 p_input->p_private = (void*)&socket_desc;
632 if( !( p_network = module_Need( p_input, "network", "" ) ) )
634 msg_Err( p_input, "failed to connect with server" );
637 module_Unneed( p_input, p_network );
638 p_access->socket_data.i_handle = socket_desc.i_handle;
639 p_input->i_mtu = socket_desc.i_mtu;
641 "connection with \"%s:%d\" successful",
644 if( ftp_SendCommand( p_input, "RETR %s", p_access->url.psz_path ) < 0 )
646 msg_Err( p_input, "cannot retreive file" );
650 if( ftp_ReadCommand( p_input, &i_answer, NULL ) > 2 )
652 msg_Err( p_input, "cannot retreive file" );
659 static int ftp_StopStream ( input_thread_t *p_input)
661 access_t *p_access = (access_t*)p_input->p_access_data;
665 NetClose( p_input, &p_access->socket_data );
667 if( ftp_SendCommand( p_input, "ABOR" ) < 0 )
669 msg_Err( p_input, "cannot abord file" );
673 ftp_ReadCommand( p_input, &i_answer, NULL );
674 ftp_ReadCommand( p_input, &i_answer, NULL );
680 /****************************************************************************
682 ****************************************************************************/
683 static void ftp_ParseURL( url_t *p_url, char *psz_url )
686 char *psz_server_port;
688 p_url->psz_private = strdup( psz_url );
690 psz_parser = p_url->psz_private;
692 while( *psz_parser == '/' )
696 p_url->psz_server_addr = psz_parser;
698 while( *psz_parser &&
699 *psz_parser != ':' && *psz_parser != '/' && *psz_parser != '@' )
704 if( *psz_parser == ':' )
708 psz_server_port = psz_parser;
710 while( *psz_parser && *psz_parser != '/' )
717 psz_server_port = "";
720 if( *psz_parser == '@' )
727 p_url->psz_bind_addr = psz_parser;
729 while( *psz_parser && *psz_parser != ':' && *psz_parser != '/' )
734 if( *psz_parser == ':' )
738 psz_bind_port = psz_parser;
740 while( *psz_parser && *psz_parser != '/' )
751 p_url->i_bind_port = strtol( psz_bind_port, &psz_parser, 10 );
755 p_url->i_bind_port = 0;
760 p_url->psz_bind_addr = "";
761 p_url->i_bind_port = 0;
764 if( *psz_parser == '/' )
768 p_url->psz_path = psz_parser;
771 if( *psz_server_port )
773 p_url->i_server_port = strtol( psz_server_port, &psz_parser, 10 );
777 p_url->i_server_port = 0;
781 /*****************************************************************************
782 * Read: read on a file descriptor, checking b_die periodically
783 *****************************************************************************/
784 static ssize_t NetRead( input_thread_t *p_input,
785 input_socket_t *p_socket,
786 byte_t *p_buffer, size_t i_len )
792 struct timeval timeout;
797 /* Initialize file descriptor set */
799 FD_SET( p_socket->i_handle, &fds );
801 /* We'll wait 1 second if nothing happens */
805 /* Find if some data is available */
806 while( (i_ret = select( p_socket->i_handle + 1, &fds,
807 NULL, NULL, &timeout )) == 0
808 || (i_ret < 0 && errno == EINTR) )
811 FD_SET( p_socket->i_handle, &fds );
815 if( p_input->b_die || p_input->b_error )
823 msg_Err( p_input, "network select error (%s)", strerror(errno) );
827 i_recv = recv( p_socket->i_handle, p_buffer, i_len, 0 );
831 msg_Err( p_input, "recv failed (%s)", strerror(errno) );
839 static void NetClose( input_thread_t *p_input, input_socket_t *p_socket )
841 #if defined( UNDER_CE )
842 CloseHandle( (HANDLE)p_socket->i_handle );
843 #elif defined( WIN32 )
844 closesocket( p_socket->i_handle );
846 close( p_socket->i_handle );