1 /*****************************************************************************
2 * ftp.c: FTP input module
3 *****************************************************************************
4 * Copyright (C) 2001-2004 VideoLAN
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 *****************************************************************************/
30 #include <vlc/input.h>
34 /*****************************************************************************
36 *****************************************************************************/
37 static int Open ( vlc_object_t * );
38 static void Close( vlc_object_t * );
40 #define CACHING_TEXT N_("Caching value in ms")
41 #define CACHING_LONGTEXT N_( \
42 "Allows you to modify the default caching value for FTP streams. This " \
43 "value should be set in millisecond units." )
44 #define USER_TEXT N_("FTP user name")
45 #define USER_LONGTEXT N_("Allows you to modify the user name that will " \
46 "be used for the connection.")
47 #define PASS_TEXT N_("FTP password")
48 #define PASS_LONGTEXT N_("Allows you to modify the password that will be " \
49 "used for the connection.")
50 #define ACCOUNT_TEXT N_("FTP account")
51 #define ACCOUNT_LONGTEXT N_("Allows you to modify the account that will be " \
52 "used for the connection.")
56 set_description( _("FTP input") );
57 set_capability( "access2", 0 );
58 set_category( CAT_INPUT );
59 set_subcategory( SUBCAT_INPUT_ACCESS );
60 add_integer( "ftp-caching", 2 * DEFAULT_PTS_DELAY / 1000, NULL,
61 CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
62 add_string( "ftp-user", "anonymous", NULL, USER_TEXT, USER_LONGTEXT,
64 add_string( "ftp-pwd", "anonymous@dummy.org", NULL, PASS_TEXT,
65 PASS_LONGTEXT, VLC_FALSE );
66 add_string( "ftp-account", "anonymous", NULL, ACCOUNT_TEXT,
67 ACCOUNT_LONGTEXT, VLC_FALSE );
68 add_shortcut( "ftp" );
69 set_callbacks( Open, Close );
72 /*****************************************************************************
74 *****************************************************************************/
75 static int Read( access_t *, uint8_t *, int );
76 static int Seek( access_t *, int64_t );
77 static int Control( access_t *, int, va_list );
87 static int ftp_SendCommand( access_t *, char *, ... );
88 static int ftp_ReadCommand( access_t *, int *, char ** );
89 static int ftp_StartStream( access_t *, int64_t );
90 static int ftp_StopStream ( access_t *);
92 /****************************************************************************
93 * Open: connect to ftp server and ask for file
94 ****************************************************************************/
95 static int Open( vlc_object_t *p_this )
97 access_t *p_access = (access_t*)p_this;
105 p_access->pf_read = Read;
106 p_access->pf_block = NULL;
107 p_access->pf_seek = Seek;
108 p_access->pf_control = Control;
109 p_access->info.i_update = 0;
110 p_access->info.i_size = 0;
111 p_access->info.i_pos = 0;
112 p_access->info.b_eof = VLC_FALSE;
113 p_access->info.i_title = 0;
114 p_access->info.i_seekpoint = 0;
115 p_access->p_sys = p_sys = malloc( sizeof( access_sys_t ) );
116 memset( p_sys, 0, sizeof( access_sys_t ) );
120 /* *** Parse URL and get server addr/port and path *** */
121 psz = p_access->psz_path;
126 vlc_UrlParse( &p_sys->url, psz, 0 );
128 if( p_sys->url.psz_host == NULL || *p_sys->url.psz_host == '\0' )
130 msg_Err( p_access, "invalid server name" );
133 if( p_sys->url.i_port <= 0 )
135 p_sys->url.i_port = 21; /* default port */
138 /* *** Open a TCP connection with server *** */
139 msg_Dbg( p_access, "waiting for connection..." );
140 p_sys->fd_cmd = net_OpenTCP( p_access, p_sys->url.psz_host,
142 if( p_sys->fd_cmd < 0 )
144 msg_Err( p_access, "failed to connect with server" );
150 if( ftp_ReadCommand( p_access, &i_answer, NULL ) != 1 )
155 if( i_answer / 100 != 2 )
157 msg_Err( p_access, "connection rejected" );
161 msg_Dbg( p_access, "connection accepted (%d)", i_answer );
163 psz = var_CreateGetString( p_access, "ftp-user" );
164 if( ftp_SendCommand( p_access, "USER %s", psz ) < 0 ||
165 ftp_ReadCommand( p_access, &i_answer, NULL ) < 0 )
172 switch( i_answer / 100 )
175 msg_Dbg( p_access, "user accepted" );
178 msg_Dbg( p_access, "password needed" );
179 psz = var_CreateGetString( p_access, "ftp-pwd" );
180 if( ftp_SendCommand( p_access, "PASS %s", psz ) < 0 ||
181 ftp_ReadCommand( p_access, &i_answer, NULL ) < 0 )
188 switch( i_answer / 100 )
191 msg_Dbg( p_access, "password accepted" );
194 msg_Dbg( p_access, "account needed" );
195 psz = var_CreateGetString( p_access, "ftp-account" );
196 if( ftp_SendCommand( p_access, "ACCT %s",
198 ftp_ReadCommand( p_access, &i_answer, NULL ) < 0 )
205 if( i_answer / 100 != 2 )
207 msg_Err( p_access, "account rejected" );
210 msg_Dbg( p_access, "account accepted" );
214 msg_Err( p_access, "password rejected" );
219 msg_Err( p_access, "user rejected" );
224 if( ftp_SendCommand( p_access, "TYPE I" ) < 0 ||
225 ftp_ReadCommand( p_access, &i_answer, NULL ) != 2 )
227 msg_Err( p_access, "cannot set binary transfer mode" );
232 if( ftp_SendCommand( p_access, "SIZE %s", p_sys->url.psz_path ) < 0 ||
233 ftp_ReadCommand( p_access, &i_answer, &psz_arg ) != 2 )
235 msg_Err( p_access, "cannot get file size" );
238 p_access->info.i_size = atoll( &psz_arg[4] );
240 msg_Dbg( p_access, "file size: "I64Fd, p_access->info.i_size );
242 /* Start the 'stream' */
243 if( ftp_StartStream( p_access, 0 ) < 0 )
245 msg_Err( p_access, "cannot retrieve file" );
249 /* Update default_pts to a suitable value for ftp access */
250 var_Create( p_access, "ftp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
255 if( p_sys->fd_cmd > 0 )
257 net_Close( p_sys->fd_cmd );
259 vlc_UrlClean( &p_sys->url );
264 /*****************************************************************************
265 * Close: free unused data structures
266 *****************************************************************************/
267 static void Close( vlc_object_t *p_this )
269 access_t *p_access = (access_t*)p_this;
270 access_sys_t *p_sys = p_access->p_sys;
272 msg_Dbg( p_access, "stopping stream" );
273 ftp_StopStream( p_access );
275 if( ftp_SendCommand( p_access, "QUIT" ) < 0 )
277 msg_Warn( p_access, "cannot quit" );
281 ftp_ReadCommand( p_access, NULL, NULL );
283 net_Close( p_sys->fd_cmd );
286 vlc_UrlClean( &p_sys->url );
290 /*****************************************************************************
291 * Seek: try to go at the right place
292 *****************************************************************************/
293 static int Seek( access_t *p_access, int64_t i_pos )
299 msg_Dbg( p_access, "seeking to "I64Fd, i_pos );
301 ftp_StopStream( p_access );
302 if( ftp_StartStream( p_access, i_pos ) < 0 )
304 p_access->info.b_eof = VLC_TRUE;
308 p_access->info.b_eof = VLC_FALSE;
309 p_access->info.i_pos = i_pos;
314 /*****************************************************************************
316 *****************************************************************************/
317 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
319 access_sys_t *p_sys = p_access->p_sys;
322 if( p_access->info.b_eof )
325 i_read = net_Read( p_access, p_sys->fd_data, NULL, p_buffer, i_len,
328 p_access->info.b_eof = VLC_TRUE;
329 else if( i_read > 0 )
330 p_access->info.i_pos += i_read;
335 /*****************************************************************************
337 *****************************************************************************/
338 static int Control( access_t *p_access, int i_query, va_list args )
348 case ACCESS_CAN_SEEK:
349 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
352 case ACCESS_CAN_FASTSEEK:
353 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
354 *pb_bool = VLC_FALSE;
356 case ACCESS_CAN_PAUSE:
357 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
358 *pb_bool = VLC_TRUE; /* FIXME */
360 case ACCESS_CAN_CONTROL_PACE:
361 pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
362 *pb_bool = VLC_TRUE; /* FIXME */
367 pi_int = (int*)va_arg( args, int * );
371 case ACCESS_GET_PTS_DELAY:
372 pi_64 = (int64_t*)va_arg( args, int64_t * );
373 var_Get( p_access, "ftp-caching", &val );
374 *pi_64 = (int64_t)var_GetInteger( p_access, "ftp-caching" ) * I64C(1000);
378 case ACCESS_SET_PAUSE_STATE:
382 case ACCESS_GET_TITLE_INFO:
383 case ACCESS_SET_TITLE:
384 case ACCESS_SET_SEEKPOINT:
385 case ACCESS_SET_PRIVATE_ID_STATE:
389 msg_Warn( p_access, "unimplemented query in control" );
396 /*****************************************************************************
398 *****************************************************************************/
399 static int ftp_SendCommand( access_t *p_access, char *psz_fmt, ... )
401 access_sys_t *p_sys = p_access->p_sys;
406 va_start( args, psz_fmt );
407 vasprintf( &psz_cmd, psz_fmt, args );
410 msg_Dbg( p_access, "ftp_SendCommand:\"%s\"", psz_cmd);
411 if( ( i_ret = net_Printf( VLC_OBJECT(p_access), p_sys->fd_cmd, NULL,
412 "%s", psz_cmd ) ) > 0 )
414 i_ret = net_Printf( VLC_OBJECT(p_access), p_sys->fd_cmd, NULL,
420 msg_Err( p_access, "failed to send command" );
426 /* TODO support this s**t :
427 RFC 959 allows the client to send certain TELNET strings at any moment,
428 even in the middle of a request:
431 * \377\376x where x is one byte.
432 * \377\375x where x is one byte. The server is obliged to send \377\374x
433 * immediately after reading x.
434 * \377\374x where x is one byte.
435 * \377\373x where x is one byte. The server is obliged to send \377\376x
436 * immediately after reading x.
437 * \377x for any other byte x.
439 These strings are not part of the requests, except in the case \377\377,
440 where the request contains one \377. */
441 static int ftp_ReadCommand( access_t *p_access,
442 int *pi_answer, char **ppsz_answer )
444 access_sys_t *p_sys = p_access->p_sys;
448 psz_line = net_Gets( p_access, p_sys->fd_cmd, NULL );
449 msg_Dbg( p_access, "answer=%s", psz_line );
450 if( psz_line == NULL || strlen( psz_line ) < 3 )
452 msg_Err( p_access, "cannot get answer" );
453 if( psz_line ) free( psz_line );
454 if( pi_answer ) *pi_answer = 500;
455 if( ppsz_answer ) *ppsz_answer = NULL;
459 if( psz_line[3] == '-' ) /* Multiple response */
463 memcpy( end, psz_line, 3 );
468 char *psz_tmp = net_Gets( p_access, p_sys->fd_cmd, NULL );
470 if( psz_tmp == NULL ) /* Error */
473 if( !strncmp( psz_tmp, end, 4 ) )
482 i_answer = atoi( psz_line );
484 if( pi_answer ) *pi_answer = i_answer;
487 *ppsz_answer = psz_line;
493 return( i_answer / 100 );
496 static int ftp_StartStream( access_t *p_access, off_t i_start )
498 access_sys_t *p_sys = p_access->p_sys;
502 char *psz_arg, *psz_parser;
507 if( ftp_SendCommand( p_access, "PASV" ) < 0 ||
508 ftp_ReadCommand( p_access, &i_answer, &psz_arg ) != 2 )
510 msg_Err( p_access, "cannot set passive transfer mode" );
514 psz_parser = strchr( psz_arg, '(' );
516 sscanf( psz_parser, "(%d,%d,%d,%d,%d,%d", &a1, &a2, &a3,
517 &a4, &p1, &p2 ) < 6 )
520 msg_Err( p_access, "cannot get ip/port for passive transfer mode" );
525 sprintf( psz_ip, "%d.%d.%d.%d", a1, a2, a3, a4 );
526 i_port = p1 * 256 + p2;
527 msg_Dbg( p_access, "ip:%s port:%d", psz_ip, i_port );
529 if( ftp_SendCommand( p_access, "TYPE I" ) < 0 ||
530 ftp_ReadCommand( p_access, &i_answer, NULL ) != 2 )
532 msg_Err( p_access, "cannot set binary transfer mode" );
538 if( ftp_SendCommand( p_access, "REST "I64Fu, i_start ) < 0 ||
539 ftp_ReadCommand( p_access, &i_answer, NULL ) > 3 )
541 msg_Err( p_access, "cannot set restart point" );
546 msg_Dbg( p_access, "waiting for data connection..." );
547 p_sys->fd_data = net_OpenTCP( p_access, psz_ip, i_port );
548 if( p_sys->fd_data < 0 )
550 msg_Err( p_access, "failed to connect with server" );
553 msg_Dbg( p_access, "connection with \"%s:%d\" successful",
557 if( ftp_SendCommand( p_access, "RETR %s", p_sys->url.psz_path ) < 0 ||
558 ftp_ReadCommand( p_access, &i_answer, NULL ) > 2 )
560 msg_Err( p_access, "cannot retreive file" );
566 static int ftp_StopStream ( access_t *p_access )
568 access_sys_t *p_sys = p_access->p_sys;
572 if( ftp_SendCommand( p_access, "ABOR" ) < 0 )
574 msg_Warn( p_access, "cannot abord file" );
575 if( p_sys->fd_data > 0 )
576 net_Close( p_sys->fd_data );
580 if( p_sys->fd_data > 0 )
582 net_Close( p_sys->fd_data );
584 ftp_ReadCommand( p_access, &i_answer, NULL );
586 ftp_ReadCommand( p_access, &i_answer, NULL );