1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 2001, 2002 VideoLAN
5 * $Id: ftp.c,v 1.13 2003/03/24 23:04:07 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 );
75 static ssize_t NetRead ( input_thread_t *, input_socket_t *, byte_t *, size_t );
76 static void NetClose( input_thread_t *, input_socket_t *);
78 static int ftp_SendCommand( input_thread_t *, char *, ... );
79 static int ftp_ReadCommand( input_thread_t *, int *, char ** );
80 static int ftp_StartStream( input_thread_t *, off_t );
81 static int ftp_StopStream ( input_thread_t *);
83 /*****************************************************************************
85 *****************************************************************************/
86 #define CACHING_TEXT N_("caching value in ms")
87 #define CACHING_LONGTEXT N_( \
88 "Allows you to modify the default caching value for ftp streams. This " \
89 "value should be set in miliseconds units." )
92 set_description( _("ftp access module") );
93 set_capability( "access", 0 );
94 add_category_hint( "stream", NULL, VLC_FALSE );
95 add_integer( "ftp-caching", 2 * DEFAULT_PTS_DELAY / 1000, NULL,
96 CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
97 add_string( "ftp-user", "anonymous", NULL, "ftp user name", "ftp user name", VLC_FALSE );
98 add_string( "ftp-pwd", "anonymous@dummy.org", NULL, "ftp password", "ftp password, be careful with that option...", VLC_FALSE );
99 add_string( "ftp-account", "anonymous", NULL, "ftp account", "ftp account", VLC_FALSE );
100 add_shortcut( "ftp" );
101 set_callbacks( Open, Close );
104 /* url: [/]host[:port][/path] */
107 char *psz_server_addr;
119 static void ftp_ParseURL( url_t *, char * );
121 #define FREE( p ) if( p ) free( p )
123 typedef struct access_s
125 input_socket_t socket_cmd;
126 input_socket_t socket_data;
128 url_t url; /* connect to this server */
137 /****************************************************************************
138 ****************************************************************************
139 ******************* *******************
140 ******************* Main functions *******************
141 ******************* *******************
142 ****************************************************************************
143 ****************************************************************************/
145 /****************************************************************************
146 * Open: connect to ftp server and ask for file
147 ****************************************************************************/
148 static int Open( vlc_object_t *p_this )
150 input_thread_t *p_input = (input_thread_t*)p_this;
156 network_socket_t socket_desc;
160 char *psz_user, *psz_pwd, *psz_account;
164 /* *** allocate p_access_data *** */
165 p_input->p_access_data =
166 (void*)p_access = malloc( sizeof( access_t ) );
167 memset( p_access, 0, sizeof( access_t ) );
168 p_url = &p_access->url;
170 /* *** Parse URL and get server addr/port and path *** */
171 ftp_ParseURL( p_url, p_input->psz_name );
173 if( p_url->psz_server_addr == NULL ||
174 !( *p_url->psz_server_addr ) )
176 FREE( p_url->psz_private );
177 msg_Err( p_input, "invalid server name" );
180 if( p_url->i_server_port == 0 )
182 p_url->i_server_port = 21; /* default port */
185 /* 2: look at ip version ipv4/ipv6 */
187 if( config_GetInt( p_input, "ipv4" ) )
189 psz_network = "ipv4";
191 else if( config_GetInt( p_input, "ipv6" ) )
193 psz_network = "ipv6";
196 /* 3: Open a TCP connection with server *** */
197 msg_Dbg( p_input, "waiting for connection..." );
198 socket_desc.i_type = NETWORK_TCP;
199 socket_desc.psz_server_addr = p_url->psz_server_addr;
200 socket_desc.i_server_port = p_url->i_server_port;
201 socket_desc.psz_bind_addr = "";
202 socket_desc.i_bind_port = 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" );
338 p_access->i_filesize = atoll( psz_arg + 4 );
342 char *psz_parser = psz_arg + 4;
344 while( *psz_parser == ' ' ) psz_parser++;
346 while( psz_parser[0] >= '0' && psz_parser[0] <= '9' )
349 i_size += psz_parser[0] - '0';
351 p_access->i_filesize = i_size;
355 msg_Dbg( p_input, "file size: "I64Fd, p_access->i_filesize );
358 if( ftp_StartStream( p_input, 0 ) < 0 )
360 msg_Err( p_input, "cannot retrieve file" );
363 /* *** set exported functions *** */
364 p_input->pf_read = Read;
365 p_input->pf_seek = Seek;
366 p_input->pf_set_program = input_SetProgram;
367 p_input->pf_set_area = NULL;
369 p_input->p_private = NULL;
371 /* *** finished to set some variable *** */
372 vlc_mutex_lock( &p_input->stream.stream_lock );
373 p_input->stream.b_pace_control = 1;
374 p_input->stream.p_selected_area->i_tell = 0;
375 p_input->stream.b_seekable = 1;
376 p_input->stream.p_selected_area->i_size = p_access->i_filesize;
377 p_input->stream.i_method = INPUT_METHOD_NETWORK;
378 vlc_mutex_unlock( &p_input->stream.stream_lock );
380 /* Update default_pts to a suitable value for ftp access */
381 p_input->i_pts_delay = config_GetInt( p_input, "ftp-caching" ) * 1000;
386 NetClose( p_input, &p_access->socket_cmd );
387 FREE( p_access->url.psz_private );
388 FREE( p_input->p_access_data );
392 /*****************************************************************************
393 * Close: free unused data structures
394 *****************************************************************************/
395 static void Close( vlc_object_t *p_this )
397 input_thread_t *p_input = (input_thread_t *)p_this;
398 access_t *p_access = (access_t*)p_input->p_access_data;
400 msg_Dbg( p_input, "stopping stream" );
401 ftp_StopStream( p_input );
403 if( ftp_SendCommand( p_input, "QUIT" ) < 0 )
405 msg_Err( p_input, "cannot quit" );
409 ftp_ReadCommand( p_input, NULL, NULL );
413 NetClose( p_input, &p_access->socket_cmd );
416 FREE( p_access->url.psz_private );
419 /*****************************************************************************
420 * Seek: try to go at the right place
421 *****************************************************************************/
422 static void Seek( input_thread_t * p_input, off_t i_pos )
424 //access_t *p_access = (access_t*)p_input->p_access_data;
429 vlc_mutex_lock( &p_input->stream.stream_lock );
431 msg_Dbg( p_input, "seeking to "I64Fd, i_pos );
433 ftp_StopStream( p_input );
434 ftp_StartStream( p_input, i_pos );
436 p_input->stream.p_selected_area->i_tell = i_pos;
437 vlc_mutex_unlock( &p_input->stream.stream_lock );
440 static int Read ( input_thread_t * p_input, byte_t * p_buffer,
443 access_t *p_access = (access_t*)p_input->p_access_data;
446 i_data = NetRead( p_input, &p_access->socket_data, p_buffer, i_len );
451 static int ftp_SendCommand( input_thread_t *p_input, char *psz_fmt, ... )
453 access_t *p_access = (access_t*)p_input->p_access_data;
456 #if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN)
460 va_start( args, psz_fmt );
462 #if defined(HAVE_VASPRINTF) && !defined(SYS_DARWIN)
463 vasprintf( &psz_buffer, psz_fmt, args );
465 i_size = strlen( psz_fmt ) + 2048;
466 psz_buffer = calloc( i_size, sizeof( char ) );
467 vsnprintf( psz_buffer, i_size, psz_fmt, args );
468 psz_buffer[i_size - 1] = 0;
470 if( !strncmp( psz_buffer, "PASS", 4 ) )
472 msg_Dbg( p_input, "ftp_SendCommand:\"PASS xxx\"" );
476 msg_Dbg( p_input, "ftp_SendCommand:\"%s\"", psz_buffer );
478 psz_buffer = realloc( psz_buffer, strlen( psz_buffer ) + 3 );
479 strcat( psz_buffer, "\r\n" );
480 if( send( p_access->socket_cmd.i_handle,
482 strlen( psz_buffer ),
486 msg_Err( p_input, "failed to send command" );
496 #define BLOCK_SIZE 1024
497 /* TODO support this s**t :
498 RFC 959 allows the client to send certain TELNET strings at any moment,
499 even in the middle of a request:
502 * \377\376x where x is one byte.
503 * \377\375x where x is one byte. The server is obliged to send \377\374x
504 * immediately after reading x.
505 * \377\374x where x is one byte.
506 * \377\373x where x is one byte. The server is obliged to send \377\376x
507 * immediately after reading x.
508 * \377x for any other byte x.
510 These strings are not part of the requests, except in the case \377\377,
511 where the request contains one \377. */
513 static int ftp_ReadCommand( input_thread_t *p_input,
514 int *pi_answer, char **ppsz_answer )
516 access_t *p_access = (access_t*)p_input->p_access_data;
524 i_buffer_size = BLOCK_SIZE + 1;
525 p_buffer = malloc( BLOCK_SIZE + 1);
530 i_read = NetRead( p_input, &p_access->socket_cmd,
531 p_buffer + i_buffer, BLOCK_SIZE );
532 if( i_read <= 0 || p_input->b_die || p_input->b_error )
535 if( pi_answer ) *pi_answer = 500;
536 if( ppsz_answer ) *ppsz_answer = NULL;
544 if( i_read < BLOCK_SIZE )
546 p_buffer[i_buffer] = '\0';
549 i_buffer_size += BLOCK_SIZE;
550 p_buffer = realloc( p_buffer, i_buffer_size );
558 i_answer = atoi( p_buffer );
560 if( pi_answer ) *pi_answer = i_answer;
563 *ppsz_answer = p_buffer;
569 return( i_answer / 100 );
573 if( pi_answer ) *pi_answer = 500;
574 if( ppsz_answer ) *ppsz_answer = NULL;
578 static int ftp_StartStream( input_thread_t *p_input, off_t i_start )
580 access_t *p_access = (access_t*)p_input->p_access_data;
584 char *psz_arg, *psz_parser;
589 network_socket_t socket_desc;
591 if( ftp_SendCommand( p_input, "PASV" ) < 0 )
593 msg_Err( p_input, "cannot set passive transfert mode" );
596 if( ftp_ReadCommand( p_input, &i_answer, &psz_arg ) != 2 )
598 msg_Err( p_input, "cannot set passive transfert mode" );
601 psz_parser = strchr( psz_arg, '(' );
602 if( !psz_parser || sscanf( psz_parser, "(%d,%d,%d,%d,%d,%d", &a1, &a2, &a3, &a4, &p1, &p2 ) < 6 )
605 msg_Err( p_input, "cannot get ip/port for passive transfert mode" );
610 sprintf( psz_ip, "%d.%d.%d.%d", a1, a2, a3, a4 );
611 i_port = p1 * 256 + p2;
612 msg_Dbg( p_input, "ip:%s port:%d", psz_ip, i_port );
614 if( ftp_SendCommand( p_input, "TYPE I" ) < 0 )
616 msg_Err( p_input, "cannot set binary transfert mode" );
619 if( ftp_ReadCommand( p_input, &i_answer, NULL ) != 2 )
621 msg_Err( p_input, "cannot set binary transfert mode" );
628 if( ftp_SendCommand( p_input, "REST "I64Fu, i_start ) < 0 )
630 msg_Err( p_input, "cannot set restart point" );
633 if( ftp_ReadCommand( p_input, &i_answer, NULL ) > 3 )
635 msg_Err( p_input, "cannot set restart point" );
640 msg_Dbg( p_input, "waiting for data connection..." );
641 socket_desc.i_type = NETWORK_TCP;
642 socket_desc.psz_server_addr = psz_ip;
643 socket_desc.i_server_port = i_port;
644 socket_desc.psz_bind_addr = "";
645 socket_desc.i_bind_port = 0;
646 p_input->p_private = (void*)&socket_desc;
647 if( !( p_network = module_Need( p_input, "network", "" ) ) )
649 msg_Err( p_input, "failed to connect with server" );
652 module_Unneed( p_input, p_network );
653 p_access->socket_data.i_handle = socket_desc.i_handle;
654 p_input->i_mtu = socket_desc.i_mtu;
656 "connection with \"%s:%d\" successful",
659 if( ftp_SendCommand( p_input, "RETR %s", p_access->url.psz_path ) < 0 )
661 msg_Err( p_input, "cannot retreive file" );
665 if( ftp_ReadCommand( p_input, &i_answer, NULL ) > 2 )
667 msg_Err( p_input, "cannot retreive file" );
674 static int ftp_StopStream ( input_thread_t *p_input)
676 access_t *p_access = (access_t*)p_input->p_access_data;
680 NetClose( p_input, &p_access->socket_data );
682 if( ftp_SendCommand( p_input, "ABOR" ) < 0 )
684 msg_Err( p_input, "cannot abord file" );
688 ftp_ReadCommand( p_input, &i_answer, NULL );
689 ftp_ReadCommand( p_input, &i_answer, NULL );
695 /****************************************************************************
697 ****************************************************************************/
698 static void ftp_ParseURL( url_t *p_url, char *psz_url )
701 char *psz_server_port;
703 p_url->psz_private = strdup( psz_url );
705 psz_parser = p_url->psz_private;
707 while( *psz_parser == '/' )
711 p_url->psz_server_addr = psz_parser;
713 while( *psz_parser &&
714 *psz_parser != ':' && *psz_parser != '/' && *psz_parser != '@' )
719 if( *psz_parser == ':' )
723 psz_server_port = psz_parser;
725 while( *psz_parser && *psz_parser != '/' )
732 psz_server_port = "";
735 if( *psz_parser == '@' )
742 p_url->psz_bind_addr = psz_parser;
744 while( *psz_parser && *psz_parser != ':' && *psz_parser != '/' )
749 if( *psz_parser == ':' )
753 psz_bind_port = psz_parser;
755 while( *psz_parser && *psz_parser != '/' )
766 p_url->i_bind_port = strtol( psz_bind_port, &psz_parser, 10 );
770 p_url->i_bind_port = 0;
775 p_url->psz_bind_addr = "";
776 p_url->i_bind_port = 0;
779 if( *psz_parser == '/' )
783 p_url->psz_path = psz_parser;
786 if( *psz_server_port )
788 p_url->i_server_port = strtol( psz_server_port, &psz_parser, 10 );
792 p_url->i_server_port = 0;
796 /*****************************************************************************
797 * Read: read on a file descriptor, checking b_die periodically
798 *****************************************************************************/
799 static ssize_t NetRead( input_thread_t *p_input,
800 input_socket_t *p_socket,
801 byte_t *p_buffer, size_t i_len )
807 struct timeval timeout;
812 /* Initialize file descriptor set */
814 FD_SET( p_socket->i_handle, &fds );
816 /* We'll wait 1 second if nothing happens */
820 /* Find if some data is available */
821 while( (i_ret = select( p_socket->i_handle + 1, &fds,
822 NULL, NULL, &timeout )) == 0
823 || (i_ret < 0 && errno == EINTR) )
826 FD_SET( p_socket->i_handle, &fds );
830 if( p_input->b_die || p_input->b_error )
838 msg_Err( p_input, "network select error (%s)", strerror(errno) );
842 i_recv = recv( p_socket->i_handle, p_buffer, i_len, 0 );
846 msg_Err( p_input, "recv failed (%s)", strerror(errno) );
854 static void NetClose( input_thread_t *p_input, input_socket_t *p_socket )
856 #if defined( UNDER_CE )
857 CloseHandle( (HANDLE)p_socket->i_handle );
858 #elif defined( WIN32 )
859 closesocket( p_socket->i_handle );
861 close( p_socket->i_handle );