1 /*****************************************************************************
2 * ftp.c: FTP input module
3 *****************************************************************************
4 * Copyright (C) 2001-2006 the VideoLAN team
5 * Copyright © 2006 Rémi Denis-Courmont
8 * Authors: Laurent Aimar <fenrir@via.ecp.fr> - original code
9 * Rémi Denis-Courmont <rem # videolan.org> - EPSV support
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
26 /*****************************************************************************
28 *****************************************************************************/
34 #include <vlc_plugin.h>
38 #include <vlc_access.h>
39 #include <vlc_interface.h>
41 #include <vlc_network.h>
46 # define IPPORT_FTP 21u
49 /*****************************************************************************
51 *****************************************************************************/
52 static int InOpen ( vlc_object_t * );
53 static void InClose( vlc_object_t * );
54 static int OutOpen ( vlc_object_t * );
55 static void OutClose( vlc_object_t * );
57 #define CACHING_TEXT N_("Caching value in ms")
58 #define CACHING_LONGTEXT N_( \
59 "Caching value for FTP streams. This " \
60 "value should be set in milliseconds." )
61 #define USER_TEXT N_("FTP user name")
62 #define USER_LONGTEXT N_("User name that will " \
63 "be used for the connection.")
64 #define PASS_TEXT N_("FTP password")
65 #define PASS_LONGTEXT N_("Password that will be " \
66 "used for the connection.")
67 #define ACCOUNT_TEXT N_("FTP account")
68 #define ACCOUNT_LONGTEXT N_("Account that will be " \
69 "used for the connection.")
72 set_shortname( "FTP" );
73 set_description( N_("FTP input") );
74 set_capability( "access", 0 );
75 set_category( CAT_INPUT );
76 set_subcategory( SUBCAT_INPUT_ACCESS );
77 add_integer( "ftp-caching", 2 * DEFAULT_PTS_DELAY / 1000, NULL,
78 CACHING_TEXT, CACHING_LONGTEXT, true );
79 add_string( "ftp-user", "anonymous", NULL, USER_TEXT, USER_LONGTEXT,
81 add_string( "ftp-pwd", "anonymous@example.com", NULL, PASS_TEXT,
82 PASS_LONGTEXT, false );
83 add_string( "ftp-account", "anonymous", NULL, ACCOUNT_TEXT,
84 ACCOUNT_LONGTEXT, false );
85 add_shortcut( "ftp" );
86 set_callbacks( InOpen, InClose );
89 set_shortname( "FTP" );
90 set_description( N_("FTP upload output") );
91 set_capability( "sout access", 0 );
92 set_category( CAT_SOUT );
93 set_subcategory( SUBCAT_SOUT_ACO );
94 set_callbacks( OutOpen, OutClose );
97 /*****************************************************************************
99 *****************************************************************************/
100 static ssize_t Read( access_t *, uint8_t *, size_t );
101 static ssize_t Write( sout_access_out_t *, block_t * );
102 static int Seek( access_t *, int64_t );
103 static int OutSeek( sout_access_out_t *, off_t );
104 static int Control( access_t *, int, va_list );
113 char sz_epsv_ip[NI_MAXNUMERICHOST];
115 #define GET_OUT_SYS( p_this ) \
116 ((access_sys_t *)(((sout_access_out_t *)(p_this))->p_sys))
118 static int ftp_SendCommand( vlc_object_t *, access_sys_t *, const char *, ... );
119 static int ftp_ReadCommand( vlc_object_t *, access_sys_t *, int *, char ** );
120 static int ftp_StartStream( vlc_object_t *, access_sys_t *, int64_t );
121 static int ftp_StopStream ( vlc_object_t *, access_sys_t * );
123 static int Login( vlc_object_t *p_access, access_sys_t *p_sys )
128 /* *** Open a TCP connection with server *** */
129 int fd = p_sys->fd_cmd = net_ConnectTCP( p_access, p_sys->url.psz_host,
133 msg_Err( p_access, "connection failed" );
134 intf_UserFatal( p_access, false, _("Network interaction failed"),
135 _("VLC could not connect with the given server.") );
139 while( ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) == 1 );
141 if( i_answer / 100 != 2 )
143 msg_Err( p_access, "connection rejected" );
144 intf_UserFatal( p_access, false, _("Network interaction failed"),
145 _("VLC's connection to the given server was rejected.") );
149 msg_Dbg( p_access, "connection accepted (%d)", i_answer );
151 if( p_sys->url.psz_username && *p_sys->url.psz_username )
152 psz = strdup( p_sys->url.psz_username );
154 psz = var_CreateGetString( p_access, "ftp-user" );
156 if( ftp_SendCommand( p_access, p_sys, "USER %s", psz ) < 0 ||
157 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
164 switch( i_answer / 100 )
167 msg_Dbg( p_access, "user accepted" );
170 msg_Dbg( p_access, "password needed" );
171 if( p_sys->url.psz_password && *p_sys->url.psz_password )
172 psz = strdup( p_sys->url.psz_password );
174 psz = var_CreateGetString( p_access, "ftp-pwd" );
176 if( ftp_SendCommand( p_access, p_sys, "PASS %s", psz ) < 0 ||
177 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
184 switch( i_answer / 100 )
187 msg_Dbg( p_access, "password accepted" );
190 msg_Dbg( p_access, "account needed" );
191 psz = var_CreateGetString( p_access, "ftp-account" );
192 if( ftp_SendCommand( p_access, p_sys, "ACCT %s",
194 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
201 if( i_answer / 100 != 2 )
203 msg_Err( p_access, "account rejected" );
204 intf_UserFatal( p_access, false,
205 _("Network interaction failed"),
206 _("Your account was rejected.") );
209 msg_Dbg( p_access, "account accepted" );
213 msg_Err( p_access, "password rejected" );
214 intf_UserFatal( p_access, false,
215 _("Network interaction failed"),
216 _("Your password was rejected.") );
221 msg_Err( p_access, "user rejected" );
222 intf_UserFatal( p_access, false,
223 _("Network interaction failed"),
224 _("Your connection attempt to the server was rejected.") );
231 static int Connect( vlc_object_t *p_access, access_sys_t *p_sys )
233 if( Login( p_access, p_sys ) < 0 )
236 /* Extended passive mode */
237 if( ftp_SendCommand( p_access, p_sys, "EPSV ALL" ) < 0 )
239 msg_Err( p_access, "cannot request extended passive mode" );
240 net_Close( p_sys->fd_cmd );
244 if( ftp_ReadCommand( p_access, p_sys, NULL, NULL ) == 2 )
246 if( net_GetPeerAddress( p_sys->fd_cmd, p_sys->sz_epsv_ip, NULL ) )
248 net_Close( p_sys->fd_cmd );
254 /* If ESPV ALL fails, we fallback to PASV.
255 * We have to restart the connection in case there is a NAT that
256 * understands EPSV ALL in the way, and hence won't allow PASV on
257 * the initial connection.
259 msg_Info( p_access, "FTP Extended passive mode disabled" );
260 net_Close( p_sys->fd_cmd );
262 if( Login( p_access, p_sys ) )
264 net_Close( p_sys->fd_cmd );
269 /* check binary mode support */
270 if( ftp_SendCommand( p_access, p_sys, "TYPE I" ) < 0 ||
271 ftp_ReadCommand( p_access, p_sys, NULL, NULL ) != 2 )
273 msg_Err( p_access, "cannot set binary transfer mode" );
274 net_Close( p_sys->fd_cmd );
282 static int parseURL( vlc_url_t *url, const char *path )
287 /* *** Parse URL and get server addr/port and path *** */
288 while( *path == '/' )
291 vlc_UrlParse( url, path, 0 );
293 if( url->psz_host == NULL || *url->psz_host == '\0' )
296 if( url->i_port <= 0 )
297 url->i_port = IPPORT_FTP; /* default port */
299 /* FTP URLs are relative to user's default directory (RFC1738)
300 For absolute path use ftp://foo.bar//usr/local/etc/filename */
302 if( *url->psz_path == '/' )
309 /****************************************************************************
310 * Open: connect to ftp server and ask for file
311 ****************************************************************************/
312 static int InOpen( vlc_object_t *p_this )
314 access_t *p_access = (access_t*)p_this;
319 STANDARD_READ_ACCESS_INIT
322 if( parseURL( &p_sys->url, p_access->psz_path ) )
325 if( Connect( p_this, p_sys ) )
329 if( ftp_SendCommand( p_this, p_sys, "SIZE %s", p_sys->url.psz_path ) < 0 ||
330 ftp_ReadCommand( p_this, p_sys, NULL, &psz_arg ) != 2 )
332 msg_Err( p_access, "cannot get file size" );
333 net_Close( p_sys->fd_cmd );
336 p_access->info.i_size = atoll( &psz_arg[4] );
338 msg_Dbg( p_access, "file size: %"PRId64, p_access->info.i_size );
340 /* Start the 'stream' */
341 if( ftp_StartStream( p_this, p_sys, 0 ) < 0 )
343 msg_Err( p_access, "cannot retrieve file" );
344 net_Close( p_sys->fd_cmd );
348 /* Update default_pts to a suitable value for ftp access */
349 var_Create( p_access, "ftp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
354 vlc_UrlClean( &p_sys->url );
359 static int OutOpen( vlc_object_t *p_this )
361 sout_access_out_t *p_access = (sout_access_out_t *)p_this;
364 p_sys = malloc( sizeof( *p_sys ) );
367 memset( p_sys, 0, sizeof( *p_sys ) );
372 if( parseURL( &p_sys->url, p_access->psz_path ) )
375 if( Connect( p_this, p_sys ) )
378 /* Start the 'stream' */
379 if( ftp_StartStream( p_this, p_sys, 0 ) < 0 )
381 msg_Err( p_access, "cannot store file" );
382 net_Close( p_sys->fd_cmd );
386 p_access->pf_seek = OutSeek;
387 p_access->pf_write = Write;
388 p_access->p_sys = (void *)p_sys;
393 vlc_UrlClean( &p_sys->url );
398 /*****************************************************************************
399 * Close: free unused data structures
400 *****************************************************************************/
401 static void Close( vlc_object_t *p_access, access_sys_t *p_sys )
403 msg_Dbg( p_access, "stopping stream" );
404 ftp_StopStream( p_access, p_sys );
406 if( ftp_SendCommand( p_access, p_sys, "QUIT" ) < 0 )
408 msg_Warn( p_access, "cannot quit" );
412 ftp_ReadCommand( p_access, p_sys, NULL, NULL );
414 net_Close( p_sys->fd_cmd );
417 vlc_UrlClean( &p_sys->url );
421 static void InClose( vlc_object_t *p_this )
423 Close( p_this, ((access_t *)p_this)->p_sys);
426 static void OutClose( vlc_object_t *p_this )
428 Close( p_this, GET_OUT_SYS(p_this));
432 /*****************************************************************************
433 * Seek: try to go at the right place
434 *****************************************************************************/
435 static int _Seek( vlc_object_t *p_access, access_sys_t *p_sys, int64_t i_pos )
440 msg_Dbg( p_access, "seeking to %"PRId64, i_pos );
442 ftp_StopStream( (vlc_object_t *)p_access, p_sys );
443 if( ftp_StartStream( (vlc_object_t *)p_access, p_sys, i_pos ) < 0 )
449 static int Seek( access_t *p_access, int64_t i_pos )
451 int val = _Seek( (vlc_object_t *)p_access, p_access->p_sys, i_pos );
455 p_access->info.b_eof = false;
456 p_access->info.i_pos = i_pos;
461 static int OutSeek( sout_access_out_t *p_access, off_t i_pos )
463 return _Seek( (vlc_object_t *)p_access, GET_OUT_SYS( p_access ), i_pos);
466 /*****************************************************************************
468 *****************************************************************************/
469 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
471 access_sys_t *p_sys = p_access->p_sys;
474 assert( p_sys->fd_data != -1 );
475 assert( p_access->i_object_type == VLC_OBJECT_ACCESS );
477 if( p_access->info.b_eof )
480 i_read = net_Read( p_access, p_sys->fd_data, NULL, p_buffer, i_len,
483 p_access->info.b_eof = true;
484 else if( i_read > 0 )
485 p_access->info.i_pos += i_read;
490 /*****************************************************************************
492 *****************************************************************************/
493 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
495 access_sys_t *p_sys = GET_OUT_SYS(p_access);
498 assert( p_sys->fd_data != -1 );
500 while( p_buffer != NULL )
502 block_t *p_next = p_buffer->p_next;;
504 i_write += net_Write( p_access, p_sys->fd_data, NULL,
505 p_buffer->p_buffer, p_buffer->i_buffer );
506 block_Release( p_buffer );
514 /*****************************************************************************
516 *****************************************************************************/
517 static int Control( access_t *p_access, int i_query, va_list args )
527 case ACCESS_CAN_SEEK:
528 pb_bool = (bool*)va_arg( args, bool* );
531 case ACCESS_CAN_FASTSEEK:
532 pb_bool = (bool*)va_arg( args, bool* );
535 case ACCESS_CAN_PAUSE:
536 pb_bool = (bool*)va_arg( args, bool* );
537 *pb_bool = true; /* FIXME */
539 case ACCESS_CAN_CONTROL_PACE:
540 pb_bool = (bool*)va_arg( args, bool* );
541 *pb_bool = true; /* FIXME */
546 pi_int = (int*)va_arg( args, int * );
550 case ACCESS_GET_PTS_DELAY:
551 pi_64 = (int64_t*)va_arg( args, int64_t * );
552 var_Get( p_access, "ftp-caching", &val );
553 *pi_64 = (int64_t)var_GetInteger( p_access, "ftp-caching" ) * INT64_C(1000);
557 case ACCESS_SET_PAUSE_STATE:
558 pb_bool = (bool*)va_arg( args, bool* );
560 return Seek( p_access, p_access->info.i_pos );
563 case ACCESS_GET_TITLE_INFO:
564 case ACCESS_SET_TITLE:
565 case ACCESS_SET_SEEKPOINT:
566 case ACCESS_SET_PRIVATE_ID_STATE:
567 case ACCESS_GET_CONTENT_TYPE:
568 case ACCESS_GET_META:
572 msg_Warn( p_access, "unimplemented query in control: %d", i_query);
579 /*****************************************************************************
581 *****************************************************************************/
582 static int ftp_SendCommand( vlc_object_t *p_access, access_sys_t *p_sys,
583 const char *psz_fmt, ... )
588 va_start( args, psz_fmt );
589 vasprintf( &psz_cmd, psz_fmt, args );
592 msg_Dbg( p_access, "ftp_SendCommand:\"%s\"", psz_cmd);
593 if( net_Printf( VLC_OBJECT(p_access), p_sys->fd_cmd, NULL, "%s\r\n",
596 msg_Err( p_access, "failed to send command" );
602 /* TODO support this s**t :
603 RFC 959 allows the client to send certain TELNET strings at any moment,
604 even in the middle of a request:
607 * \377\376x where x is one byte.
608 * \377\375x where x is one byte. The server is obliged to send \377\374x
609 * immediately after reading x.
610 * \377\374x where x is one byte.
611 * \377\373x where x is one byte. The server is obliged to send \377\376x
612 * immediately after reading x.
613 * \377x for any other byte x.
615 These strings are not part of the requests, except in the case \377\377,
616 where the request contains one \377. */
617 static int ftp_ReadCommand( vlc_object_t *p_access, access_sys_t *p_sys,
618 int *pi_answer, char **ppsz_answer )
623 psz_line = net_Gets( p_access, p_sys->fd_cmd, NULL );
624 if( psz_line == NULL || strlen( psz_line ) < 3 )
626 msg_Err( p_access, "cannot get answer" );
628 if( pi_answer ) *pi_answer = 500;
629 if( ppsz_answer ) *ppsz_answer = NULL;
632 msg_Dbg( p_access, "answer=%s", psz_line );
634 if( psz_line[3] == '-' ) /* Multiple response */
638 memcpy( end, psz_line, 3 );
643 char *psz_tmp = net_Gets( p_access, p_sys->fd_cmd, NULL );
645 if( psz_tmp == NULL ) /* Error */
648 if( !strncmp( psz_tmp, end, 4 ) )
657 i_answer = atoi( psz_line );
659 if( pi_answer ) *pi_answer = i_answer;
662 *ppsz_answer = psz_line;
668 return( i_answer / 100 );
671 static int ftp_StartStream( vlc_object_t *p_access, access_sys_t *p_sys,
674 char psz_ipv4[16], *psz_ip = p_sys->sz_epsv_ip;
676 char *psz_arg, *psz_parser;
679 assert( p_sys->fd_data == -1 );
681 if( ( ftp_SendCommand( p_access, p_sys, *psz_ip ? "EPSV" : "PASV" ) < 0 )
682 || ( ftp_ReadCommand( p_access, p_sys, &i_answer, &psz_arg ) != 2 ) )
684 msg_Err( p_access, "cannot set passive mode" );
688 psz_parser = strchr( psz_arg, '(' );
689 if( psz_parser == NULL )
692 msg_Err( p_access, "cannot parse passive mode response" );
698 char psz_fmt[7] = "(|||%u";
699 psz_fmt[1] = psz_fmt[2] = psz_fmt[3] = psz_parser[1];
701 if( sscanf( psz_parser, psz_fmt, &i_port ) < 1 )
704 msg_Err( p_access, "cannot parse passive mode response" );
710 unsigned a1, a2, a3, a4, p1, p2;
712 if( ( sscanf( psz_parser, "(%u,%u,%u,%u,%u,%u", &a1, &a2, &a3, &a4,
713 &p1, &p2 ) < 6 ) || ( a1 > 255 ) || ( a2 > 255 )
714 || ( a3 > 255 ) || ( a4 > 255 ) || ( p1 > 255 ) || ( p2 > 255 ) )
717 msg_Err( p_access, "cannot parse passive mode response" );
721 sprintf( psz_ipv4, "%u.%u.%u.%u", a1, a2, a3, a4 );
723 i_port = (p1 << 8) | p2;
727 msg_Dbg( p_access, "ip:%s port:%d", psz_ip, i_port );
729 if( ftp_SendCommand( p_access, p_sys, "TYPE I" ) < 0 ||
730 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) != 2 )
732 msg_Err( p_access, "cannot set binary transfer mode" );
738 if( ftp_SendCommand( p_access, p_sys, "REST %"PRIu64, i_start ) < 0 ||
739 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) > 3 )
741 msg_Err( p_access, "cannot set restart offset" );
746 msg_Dbg( p_access, "waiting for data connection..." );
747 p_sys->fd_data = net_ConnectTCP( p_access, psz_ip, i_port );
748 if( p_sys->fd_data < 0 )
750 msg_Err( p_access, "failed to connect with server" );
753 msg_Dbg( p_access, "connection with \"%s:%d\" successful",
757 if( ftp_SendCommand( p_access, p_sys, "%s %s",
758 (p_access->i_object_type == VLC_OBJECT_ACCESS)
760 p_sys->url.psz_path ) < 0 ||
761 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) > 2 )
763 msg_Err( p_access, "cannot retrieve file" );
767 shutdown( p_sys->fd_data,
768 ( p_access->i_object_type == VLC_OBJECT_ACCESS ) );
773 static int ftp_StopStream ( vlc_object_t *p_access, access_sys_t *p_sys )
775 if( ftp_SendCommand( p_access, p_sys, "ABOR" ) < 0 )
777 msg_Warn( p_access, "cannot abort file" );
778 if( p_sys->fd_data > 0 )
779 net_Close( p_sys->fd_data );
784 if( p_sys->fd_data != -1 )
787 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL );
788 if ( i_answer != 227 )
789 /* If answer is from the previous command,
790 * rathen that succesful ABOR - read next command */
791 ftp_ReadCommand( p_access, p_sys, NULL, NULL );
793 net_Close( p_sys->fd_data );