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 *****************************************************************************/
33 #include <vlc_common.h>
34 #include <vlc_plugin.h>
38 #include <vlc_access.h>
39 #include <vlc_dialog.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 )
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];
117 #define GET_OUT_SYS( p_this ) \
118 ((access_sys_t *)(((sout_access_out_t *)(p_this))->p_sys))
120 static int ftp_SendCommand( vlc_object_t *, access_sys_t *, const char *, ... );
121 static int ftp_ReadCommand( vlc_object_t *, access_sys_t *, int *, char ** );
122 static int ftp_StartStream( vlc_object_t *, access_sys_t *, int64_t );
123 static int ftp_StopStream ( vlc_object_t *, access_sys_t * );
125 static int Login( vlc_object_t *p_access, access_sys_t *p_sys )
130 /* *** Open a TCP connection with server *** */
131 int fd = p_sys->fd_cmd = net_ConnectTCP( p_access, p_sys->url.psz_host,
135 msg_Err( p_access, "connection failed" );
136 dialog_Fatal( p_access, _("Network interaction failed"), "%s",
137 _("VLC could not connect with the given server.") );
141 while( ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) == 1 );
143 if( i_answer / 100 != 2 )
145 msg_Err( p_access, "connection rejected" );
146 dialog_Fatal( p_access, _("Network interaction failed"), "%s",
147 _("VLC's connection to the given server was rejected.") );
151 msg_Dbg( p_access, "connection accepted (%d)", i_answer );
153 if( p_sys->url.psz_username && *p_sys->url.psz_username )
154 psz = strdup( p_sys->url.psz_username );
156 psz = var_CreateGetString( p_access, "ftp-user" );
160 if( ftp_SendCommand( p_access, p_sys, "USER %s", psz ) < 0 ||
161 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
168 switch( i_answer / 100 )
171 msg_Dbg( p_access, "user accepted" );
174 msg_Dbg( p_access, "password needed" );
175 if( p_sys->url.psz_password && *p_sys->url.psz_password )
176 psz = strdup( p_sys->url.psz_password );
178 psz = var_CreateGetString( p_access, "ftp-pwd" );
182 if( ftp_SendCommand( p_access, p_sys, "PASS %s", psz ) < 0 ||
183 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
190 switch( i_answer / 100 )
193 msg_Dbg( p_access, "password accepted" );
196 msg_Dbg( p_access, "account needed" );
197 psz = var_CreateGetString( p_access, "ftp-account" );
198 if( ftp_SendCommand( p_access, p_sys, "ACCT %s",
200 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
207 if( i_answer / 100 != 2 )
209 msg_Err( p_access, "account rejected" );
210 dialog_Fatal( p_access,
211 _("Network interaction failed"),
212 "%s", _("Your account was rejected.") );
215 msg_Dbg( p_access, "account accepted" );
219 msg_Err( p_access, "password rejected" );
220 dialog_Fatal( p_access, _("Network interaction failed"),
221 "%s", _("Your password was rejected.") );
226 msg_Err( p_access, "user rejected" );
227 dialog_Fatal( p_access, _("Network interaction failed"), "%s",
228 _("Your connection attempt to the server was rejected.") );
235 static int Connect( vlc_object_t *p_access, access_sys_t *p_sys )
237 if( Login( p_access, p_sys ) < 0 )
240 /* Extended passive mode */
241 if( ftp_SendCommand( p_access, p_sys, "EPSV ALL" ) < 0 )
243 msg_Err( p_access, "cannot request extended passive mode" );
244 net_Close( p_sys->fd_cmd );
248 if( ftp_ReadCommand( p_access, p_sys, NULL, NULL ) == 2 )
250 if( net_GetPeerAddress( p_sys->fd_cmd, p_sys->sz_epsv_ip, NULL ) )
252 net_Close( p_sys->fd_cmd );
258 /* If ESPV ALL fails, we fallback to PASV.
259 * We have to restart the connection in case there is a NAT that
260 * understands EPSV ALL in the way, and hence won't allow PASV on
261 * the initial connection.
263 msg_Info( p_access, "FTP Extended passive mode disabled" );
264 net_Close( p_sys->fd_cmd );
266 if( Login( p_access, p_sys ) )
268 net_Close( p_sys->fd_cmd );
273 /* check binary mode support */
274 if( ftp_SendCommand( p_access, p_sys, "TYPE I" ) < 0 ||
275 ftp_ReadCommand( p_access, p_sys, NULL, NULL ) != 2 )
277 msg_Err( p_access, "cannot set binary transfer mode" );
278 net_Close( p_sys->fd_cmd );
286 static int parseURL( vlc_url_t *url, const char *path )
291 /* *** Parse URL and get server addr/port and path *** */
292 while( *path == '/' )
295 vlc_UrlParse( url, path, 0 );
297 if( url->psz_host == NULL || *url->psz_host == '\0' )
300 if( url->i_port <= 0 )
301 url->i_port = IPPORT_FTP; /* default port */
303 /* FTP URLs are relative to user's default directory (RFC1738)
304 For absolute path use ftp://foo.bar//usr/local/etc/filename */
306 if( url->psz_path && *url->psz_path == '/' )
313 /****************************************************************************
314 * Open: connect to ftp server and ask for file
315 ****************************************************************************/
316 static int InOpen( vlc_object_t *p_this )
318 access_t *p_access = (access_t*)p_this;
323 STANDARD_READ_ACCESS_INIT
326 p_sys->directory = false;
328 if( parseURL( &p_sys->url, p_access->psz_path ) )
331 if( Connect( p_this, p_sys ) )
335 if( ftp_SendCommand( p_this, p_sys, "SIZE %s", p_sys->url.psz_path ? : "" ) < 0 ||
336 ftp_ReadCommand( p_this, p_sys, NULL, &psz_arg ) != 2 )
338 msg_Dbg( p_access, "cannot get file size" );
339 msg_Dbg( p_access, "will try to get directory contents" );
340 if( ftp_SendCommand( p_this, p_sys, "CWD %s", p_sys->url.psz_path ?: "" ) < 0 ||
341 ftp_ReadCommand( p_this, p_sys, NULL, &psz_arg ) != 2 )
343 msg_Err( p_access, "file or directory doesn't exist" );
344 net_Close( p_sys->fd_cmd );
347 p_sys->directory = true;
351 p_access->info.i_size = atoll( &psz_arg[4] );
353 msg_Dbg( p_access, "file size: %"PRId64, p_access->info.i_size );
356 /* Start the 'stream' */
357 if( ftp_StartStream( p_this, p_sys, 0 ) < 0 )
359 msg_Err( p_access, "cannot retrieve file" );
360 net_Close( p_sys->fd_cmd );
364 /* Update default_pts to a suitable value for ftp access */
365 var_Create( p_access, "ftp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
370 vlc_UrlClean( &p_sys->url );
375 static int OutOpen( vlc_object_t *p_this )
377 sout_access_out_t *p_access = (sout_access_out_t *)p_this;
380 p_sys = calloc( 1, sizeof( *p_sys ) );
388 if( parseURL( &p_sys->url, p_access->psz_path ) )
391 if( Connect( p_this, p_sys ) )
394 /* Start the 'stream' */
395 if( ftp_StartStream( p_this, p_sys, 0 ) < 0 )
397 msg_Err( p_access, "cannot store file" );
398 net_Close( p_sys->fd_cmd );
402 p_access->pf_seek = OutSeek;
403 p_access->pf_write = Write;
404 p_access->p_sys = (void *)p_sys;
409 vlc_UrlClean( &p_sys->url );
414 /*****************************************************************************
415 * Close: free unused data structures
416 *****************************************************************************/
417 static void Close( vlc_object_t *p_access, access_sys_t *p_sys )
419 msg_Dbg( p_access, "stopping stream" );
420 ftp_StopStream( p_access, p_sys );
422 if( ftp_SendCommand( p_access, p_sys, "QUIT" ) < 0 )
424 msg_Warn( p_access, "cannot quit" );
428 ftp_ReadCommand( p_access, p_sys, NULL, NULL );
430 net_Close( p_sys->fd_cmd );
433 vlc_UrlClean( &p_sys->url );
437 static void InClose( vlc_object_t *p_this )
439 Close( p_this, ((access_t *)p_this)->p_sys);
442 static void OutClose( vlc_object_t *p_this )
444 Close( p_this, GET_OUT_SYS(p_this));
448 /*****************************************************************************
449 * Seek: try to go at the right place
450 *****************************************************************************/
451 static int _Seek( vlc_object_t *p_access, access_sys_t *p_sys, int64_t i_pos )
456 msg_Dbg( p_access, "seeking to %"PRId64, i_pos );
458 ftp_StopStream( (vlc_object_t *)p_access, p_sys );
459 if( ftp_StartStream( (vlc_object_t *)p_access, p_sys, i_pos ) < 0 )
465 static int Seek( access_t *p_access, int64_t i_pos )
467 int val = _Seek( (vlc_object_t *)p_access, p_access->p_sys, i_pos );
471 p_access->info.b_eof = false;
472 p_access->info.i_pos = i_pos;
477 static int OutSeek( sout_access_out_t *p_access, off_t i_pos )
479 return _Seek( (vlc_object_t *)p_access, GET_OUT_SYS( p_access ), i_pos);
482 /*****************************************************************************
484 *****************************************************************************/
485 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
487 access_sys_t *p_sys = p_access->p_sys;
489 assert( p_sys->fd_data != -1 );
490 assert( !p_sys->out );
492 if( p_access->info.b_eof )
495 if( p_sys->directory )
497 char *psz_line = net_Gets( p_access, p_sys->fd_data, NULL );
500 p_access->info.b_eof = true;
505 snprintf( (char*)p_buffer, i_len, "ftp://%s:%d/%s/%s\n",
506 p_sys->url.psz_host, p_sys->url.i_port,
507 p_sys->url.psz_path, psz_line );
509 return strlen( (const char *)p_buffer );
514 int i_read = net_Read( p_access, p_sys->fd_data, NULL,
515 p_buffer, i_len, false );
517 p_access->info.b_eof = true;
518 else if( i_read > 0 )
519 p_access->info.i_pos += i_read;
525 /*****************************************************************************
527 *****************************************************************************/
528 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
530 access_sys_t *p_sys = GET_OUT_SYS(p_access);
533 assert( p_sys->fd_data != -1 );
535 while( p_buffer != NULL )
537 block_t *p_next = p_buffer->p_next;;
539 i_write += net_Write( p_access, p_sys->fd_data, NULL,
540 p_buffer->p_buffer, p_buffer->i_buffer );
541 block_Release( p_buffer );
549 /*****************************************************************************
551 *****************************************************************************/
552 static int Control( access_t *p_access, int i_query, va_list args )
560 case ACCESS_CAN_SEEK:
561 pb_bool = (bool*)va_arg( args, bool* );
564 case ACCESS_CAN_FASTSEEK:
565 pb_bool = (bool*)va_arg( args, bool* );
568 case ACCESS_CAN_PAUSE:
569 pb_bool = (bool*)va_arg( args, bool* );
570 *pb_bool = true; /* FIXME */
572 case ACCESS_CAN_CONTROL_PACE:
573 pb_bool = (bool*)va_arg( args, bool* );
574 *pb_bool = true; /* FIXME */
578 case ACCESS_GET_PTS_DELAY:
579 pi_64 = (int64_t*)va_arg( args, int64_t * );
580 *pi_64 = (int64_t)var_GetInteger( p_access, "ftp-caching" ) * INT64_C(1000);
584 case ACCESS_SET_PAUSE_STATE:
585 pb_bool = (bool*)va_arg( args, bool* );
587 return Seek( p_access, p_access->info.i_pos );
590 case ACCESS_GET_TITLE_INFO:
591 case ACCESS_SET_TITLE:
592 case ACCESS_SET_SEEKPOINT:
593 case ACCESS_SET_PRIVATE_ID_STATE:
594 case ACCESS_GET_CONTENT_TYPE:
595 case ACCESS_GET_META:
599 msg_Warn( p_access, "unimplemented query in control: %d", i_query);
606 /*****************************************************************************
608 *****************************************************************************/
609 static int ftp_SendCommand( vlc_object_t *p_access, access_sys_t *p_sys,
610 const char *psz_fmt, ... )
615 va_start( args, psz_fmt );
616 if( vasprintf( &psz_cmd, psz_fmt, args ) == -1 )
621 msg_Dbg( p_access, "ftp_SendCommand:\"%s\"", psz_cmd);
623 if( net_Printf( VLC_OBJECT(p_access), p_sys->fd_cmd, NULL, "%s\r\n",
626 msg_Err( p_access, "failed to send command" );
632 /* TODO support this s**t :
633 RFC 959 allows the client to send certain TELNET strings at any moment,
634 even in the middle of a request:
637 * \377\376x where x is one byte.
638 * \377\375x where x is one byte. The server is obliged to send \377\374x
639 * immediately after reading x.
640 * \377\374x where x is one byte.
641 * \377\373x where x is one byte. The server is obliged to send \377\376x
642 * immediately after reading x.
643 * \377x for any other byte x.
645 These strings are not part of the requests, except in the case \377\377,
646 where the request contains one \377. */
647 static int ftp_ReadCommand( vlc_object_t *p_access, access_sys_t *p_sys,
648 int *pi_answer, char **ppsz_answer )
653 psz_line = net_Gets( p_access, p_sys->fd_cmd, NULL );
654 if( psz_line == NULL || strlen( psz_line ) < 3 )
656 msg_Err( p_access, "cannot get answer" );
658 if( pi_answer ) *pi_answer = 500;
659 if( ppsz_answer ) *ppsz_answer = NULL;
662 msg_Dbg( p_access, "answer=%s", psz_line );
664 if( psz_line[3] == '-' ) /* Multiple response */
668 memcpy( end, psz_line, 3 );
673 char *psz_tmp = net_Gets( p_access, p_sys->fd_cmd, NULL );
675 if( psz_tmp == NULL ) /* Error */
678 if( !strncmp( psz_tmp, end, 4 ) )
687 i_answer = atoi( psz_line );
689 if( pi_answer ) *pi_answer = i_answer;
692 *ppsz_answer = psz_line;
698 return( i_answer / 100 );
701 static int ftp_StartStream( vlc_object_t *p_access, access_sys_t *p_sys,
704 char psz_ipv4[16], *psz_ip = p_sys->sz_epsv_ip;
706 char *psz_arg, *psz_parser;
709 assert( p_sys->fd_data == -1 );
711 if( ( ftp_SendCommand( p_access, p_sys, *psz_ip ? "EPSV" : "PASV" ) < 0 )
712 || ( ftp_ReadCommand( p_access, p_sys, &i_answer, &psz_arg ) != 2 ) )
714 msg_Err( p_access, "cannot set passive mode" );
718 psz_parser = strchr( psz_arg, '(' );
719 if( psz_parser == NULL )
722 msg_Err( p_access, "cannot parse passive mode response" );
728 char psz_fmt[7] = "(|||%u";
729 psz_fmt[1] = psz_fmt[2] = psz_fmt[3] = psz_parser[1];
731 if( sscanf( psz_parser, psz_fmt, &i_port ) < 1 )
734 msg_Err( p_access, "cannot parse passive mode response" );
740 unsigned a1, a2, a3, a4, p1, p2;
742 if( ( sscanf( psz_parser, "(%u,%u,%u,%u,%u,%u", &a1, &a2, &a3, &a4,
743 &p1, &p2 ) < 6 ) || ( a1 > 255 ) || ( a2 > 255 )
744 || ( a3 > 255 ) || ( a4 > 255 ) || ( p1 > 255 ) || ( p2 > 255 ) )
747 msg_Err( p_access, "cannot parse passive mode response" );
751 sprintf( psz_ipv4, "%u.%u.%u.%u", a1, a2, a3, a4 );
753 i_port = (p1 << 8) | p2;
757 msg_Dbg( p_access, "ip:%s port:%d", psz_ip, i_port );
759 if( ftp_SendCommand( p_access, p_sys, "TYPE I" ) < 0 ||
760 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) != 2 )
762 msg_Err( p_access, "cannot set binary transfer mode" );
768 if( ftp_SendCommand( p_access, p_sys, "REST %"PRIu64, i_start ) < 0 ||
769 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) > 3 )
771 msg_Err( p_access, "cannot set restart offset" );
776 msg_Dbg( p_access, "waiting for data connection..." );
777 p_sys->fd_data = net_ConnectTCP( p_access, psz_ip, i_port );
778 if( p_sys->fd_data < 0 )
780 msg_Err( p_access, "failed to connect with server" );
783 msg_Dbg( p_access, "connection with \"%s:%d\" successful",
786 if( p_sys->directory )
788 if( ftp_SendCommand( p_access, p_sys, "NLST" ) < 0 ||
789 ftp_ReadCommand( p_access, p_sys, NULL, &psz_arg ) > 2 )
791 msg_Err( p_access, "cannot list directory contents" );
798 if( ftp_SendCommand( p_access, p_sys, "%s %s",
799 p_sys->out ? "STOR" : "RETR",
800 p_sys->url.psz_path ?: "" ) < 0 ||
801 ftp_ReadCommand( p_access, p_sys, &i_answer, NULL ) > 2 )
803 msg_Err( p_access, "cannot retrieve file" );
808 shutdown( p_sys->fd_data, p_sys->out ? SHUT_RD : SHUT_WR );
813 static int ftp_StopStream ( vlc_object_t *p_access, access_sys_t *p_sys )
815 if( ftp_SendCommand( p_access, p_sys, "ABOR" ) < 0 )
817 msg_Warn( p_access, "cannot abort file" );
818 if( p_sys->fd_data > 0 )
819 net_Close( p_sys->fd_data );
824 if( p_sys->fd_data != -1 )
826 net_Close( p_sys->fd_data );
828 /* Read the final response from RETR/STOR, i.e. 426 or 226 */
829 ftp_ReadCommand( p_access, p_sys, NULL, NULL );
831 /* Read the response from ABOR, i.e. 226 or 225 */
832 ftp_ReadCommand( p_access, p_sys, NULL, NULL );