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>
44 #include <vlc_charset.h>
47 # define IPPORT_FTP 21u
50 /*****************************************************************************
52 *****************************************************************************/
53 static int InOpen ( vlc_object_t
* );
54 static void InClose( vlc_object_t
* );
55 static int OutOpen ( vlc_object_t
* );
56 static void OutClose( vlc_object_t
* );
58 #define USER_TEXT N_("FTP user name")
59 #define USER_LONGTEXT N_("User name that will " \
60 "be used for the connection.")
61 #define PASS_TEXT N_("FTP password")
62 #define PASS_LONGTEXT N_("Password that will be " \
63 "used for the connection.")
64 #define ACCOUNT_TEXT N_("FTP account")
65 #define ACCOUNT_LONGTEXT N_("Account that will be " \
66 "used for the connection.")
69 set_shortname( "FTP" )
70 set_description( N_("FTP input") )
71 set_capability( "access", 0 )
72 set_category( CAT_INPUT
)
73 set_subcategory( SUBCAT_INPUT_ACCESS
)
74 add_string( "ftp-user", "anonymous", USER_TEXT
, USER_LONGTEXT
,
76 add_string( "ftp-pwd", "anonymous@example.com", PASS_TEXT
,
77 PASS_LONGTEXT
, false )
78 add_string( "ftp-account", "anonymous", ACCOUNT_TEXT
,
79 ACCOUNT_LONGTEXT
, false )
81 set_callbacks( InOpen
, InClose
)
84 set_shortname( "FTP" )
85 set_description( N_("FTP upload output") )
86 set_capability( "sout access", 0 )
87 set_category( CAT_SOUT
)
88 set_subcategory( SUBCAT_SOUT_ACO
)
90 set_callbacks( OutOpen
, OutClose
)
93 /*****************************************************************************
95 *****************************************************************************/
96 static ssize_t
Read( access_t
*, uint8_t *, size_t );
97 static ssize_t
Write( sout_access_out_t
*, block_t
* );
98 static int Seek( access_t
*, uint64_t );
99 static int OutSeek( sout_access_out_t
*, off_t
);
100 static int Control( access_t
*, int, va_list );
109 char sz_epsv_ip
[NI_MAXNUMERICHOST
];
113 #define GET_OUT_SYS( p_this ) \
114 ((access_sys_t *)(((sout_access_out_t *)(p_this))->p_sys))
116 static int ftp_SendCommand( vlc_object_t
*, access_sys_t
*, const char *, ... );
117 static int ftp_ReadCommand( vlc_object_t
*, access_sys_t
*, int *, char ** );
118 static int ftp_StartStream( vlc_object_t
*, access_sys_t
*, uint64_t );
119 static int ftp_StopStream ( vlc_object_t
*, access_sys_t
* );
121 static int Login( vlc_object_t
*p_access
, access_sys_t
*p_sys
)
126 /* *** Open a TCP connection with server *** */
127 int fd
= p_sys
->fd_cmd
= net_ConnectTCP( p_access
, p_sys
->url
.psz_host
,
131 msg_Err( p_access
, "connection failed" );
132 dialog_Fatal( p_access
, _("Network interaction failed"), "%s",
133 _("VLC could not connect with the given server.") );
137 while( ftp_ReadCommand( p_access
, p_sys
, &i_answer
, NULL
) == 1 );
139 if( i_answer
/ 100 != 2 )
141 msg_Err( p_access
, "connection rejected" );
142 dialog_Fatal( p_access
, _("Network interaction failed"), "%s",
143 _("VLC's connection to the given server was rejected.") );
147 msg_Dbg( p_access
, "connection accepted (%d)", i_answer
);
149 if( p_sys
->url
.psz_username
&& *p_sys
->url
.psz_username
)
150 psz
= strdup( p_sys
->url
.psz_username
);
152 psz
= var_InheritString( 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_InheritString( p_access
, "ftp-pwd" );
178 if( ftp_SendCommand( p_access
, p_sys
, "PASS %s", psz
) < 0 ||
179 ftp_ReadCommand( p_access
, p_sys
, &i_answer
, NULL
) < 0 )
186 switch( i_answer
/ 100 )
189 msg_Dbg( p_access
, "password accepted" );
192 msg_Dbg( p_access
, "account needed" );
193 psz
= var_InheritString( p_access
, "ftp-account" );
194 if( ftp_SendCommand( p_access
, p_sys
, "ACCT %s",
196 ftp_ReadCommand( p_access
, p_sys
, &i_answer
, NULL
) < 0 )
203 if( i_answer
/ 100 != 2 )
205 msg_Err( p_access
, "account rejected" );
206 dialog_Fatal( p_access
,
207 _("Network interaction failed"),
208 "%s", _("Your account was rejected.") );
211 msg_Dbg( p_access
, "account accepted" );
215 msg_Err( p_access
, "password rejected" );
216 dialog_Fatal( p_access
, _("Network interaction failed"),
217 "%s", _("Your password was rejected.") );
222 msg_Err( p_access
, "user rejected" );
223 dialog_Fatal( p_access
, _("Network interaction failed"), "%s",
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 if( url
->psz_path
== NULL
)
301 /* FTP URLs are relative to user's default directory (RFC1738 §3.2)
302 For absolute path use ftp://foo.bar//usr/local/etc/filename */
303 /* FIXME: we should issue a series of CWD, one per slash */
306 assert( url
->psz_path
[0] == '/' );
310 char *type
= strstr( url
->psz_path
, ";type=" );
314 if( strchr( "iI", type
[6] ) == NULL
)
315 return VLC_EGENERIC
; /* ASCII and directory not supported */
317 decode_URI( url
->psz_path
);
318 /* FIXME: check for UTF-8 support, otherwise only ASCII is allowed */
319 EnsureUTF8( url
->psz_path
);
324 /****************************************************************************
325 * Open: connect to ftp server and ask for file
326 ****************************************************************************/
327 static int InOpen( vlc_object_t
*p_this
)
329 access_t
*p_access
= (access_t
*)p_this
;
334 STANDARD_READ_ACCESS_INIT
337 p_sys
->directory
= false;
339 if( parseURL( &p_sys
->url
, p_access
->psz_location
) )
342 if( Connect( p_this
, p_sys
) )
346 if( p_sys
->url
.psz_path
== NULL
)
347 p_sys
->directory
= true;
349 if( ftp_SendCommand( p_this
, p_sys
, "SIZE %s", p_sys
->url
.psz_path
) < 0 )
352 if ( ftp_ReadCommand( p_this
, p_sys
, NULL
, &psz_arg
) == 2 )
354 p_access
->info
.i_size
= atoll( &psz_arg
[4] );
356 msg_Dbg( p_access
, "file size: %"PRIu64
, p_access
->info
.i_size
);
359 if( ftp_SendCommand( p_this
, p_sys
, "CWD %s", p_sys
->url
.psz_path
) < 0 )
362 if( ftp_ReadCommand( p_this
, p_sys
, NULL
, NULL
) != 2 )
364 msg_Err( p_access
, "file or directory does not exist" );
368 p_sys
->directory
= true;
370 /* Start the 'stream' */
371 if( ftp_StartStream( p_this
, p_sys
, 0 ) < 0 )
373 msg_Err( p_access
, "cannot retrieve file" );
374 net_Close( p_sys
->fd_cmd
);
381 net_Close( p_sys
->fd_cmd
);
383 vlc_UrlClean( &p_sys
->url
);
388 static int OutOpen( vlc_object_t
*p_this
)
390 sout_access_out_t
*p_access
= (sout_access_out_t
*)p_this
;
393 p_sys
= calloc( 1, sizeof( *p_sys
) );
401 if( parseURL( &p_sys
->url
, p_access
->psz_path
) )
403 if( p_sys
->url
.psz_path
== NULL
)
405 msg_Err( p_this
, "no filename specified" );
409 if( Connect( p_this
, p_sys
) )
412 /* Start the 'stream' */
413 if( ftp_StartStream( p_this
, p_sys
, 0 ) < 0 )
415 msg_Err( p_access
, "cannot store file" );
416 net_Close( p_sys
->fd_cmd
);
420 p_access
->pf_seek
= OutSeek
;
421 p_access
->pf_write
= Write
;
422 p_access
->p_sys
= (void *)p_sys
;
427 vlc_UrlClean( &p_sys
->url
);
432 /*****************************************************************************
433 * Close: free unused data structures
434 *****************************************************************************/
435 static void Close( vlc_object_t
*p_access
, access_sys_t
*p_sys
)
437 msg_Dbg( p_access
, "stopping stream" );
438 ftp_StopStream( p_access
, p_sys
);
440 if( ftp_SendCommand( p_access
, p_sys
, "QUIT" ) < 0 )
442 msg_Warn( p_access
, "cannot quit" );
446 ftp_ReadCommand( p_access
, p_sys
, NULL
, NULL
);
448 net_Close( p_sys
->fd_cmd
);
451 vlc_UrlClean( &p_sys
->url
);
455 static void InClose( vlc_object_t
*p_this
)
457 Close( p_this
, ((access_t
*)p_this
)->p_sys
);
460 static void OutClose( vlc_object_t
*p_this
)
462 Close( p_this
, GET_OUT_SYS(p_this
));
466 /*****************************************************************************
467 * Seek: try to go at the right place
468 *****************************************************************************/
469 static int _Seek( vlc_object_t
*p_access
, access_sys_t
*p_sys
, uint64_t i_pos
)
471 msg_Dbg( p_access
, "seeking to %"PRIu64
, i_pos
);
473 ftp_StopStream( (vlc_object_t
*)p_access
, p_sys
);
474 if( ftp_StartStream( (vlc_object_t
*)p_access
, p_sys
, i_pos
) < 0 )
480 static int Seek( access_t
*p_access
, uint64_t i_pos
)
482 int val
= _Seek( (vlc_object_t
*)p_access
, p_access
->p_sys
, i_pos
);
486 p_access
->info
.b_eof
= false;
487 p_access
->info
.i_pos
= i_pos
;
492 static int OutSeek( sout_access_out_t
*p_access
, off_t i_pos
)
494 return _Seek( (vlc_object_t
*)p_access
, GET_OUT_SYS( p_access
), i_pos
);
497 /*****************************************************************************
499 *****************************************************************************/
500 static ssize_t
Read( access_t
*p_access
, uint8_t *p_buffer
, size_t i_len
)
502 access_sys_t
*p_sys
= p_access
->p_sys
;
504 assert( p_sys
->fd_data
!= -1 );
505 assert( !p_sys
->out
);
507 if( p_access
->info
.b_eof
)
510 if( p_sys
->directory
)
512 char *psz_line
= net_Gets( p_access
, p_sys
->fd_data
, NULL
);
515 p_access
->info
.b_eof
= true;
520 snprintf( (char*)p_buffer
, i_len
, "ftp://%s:%d/%s/%s\n",
521 p_sys
->url
.psz_host
, p_sys
->url
.i_port
,
522 p_sys
->url
.psz_path
, psz_line
);
524 return strlen( (const char *)p_buffer
);
529 int i_read
= net_Read( p_access
, p_sys
->fd_data
, NULL
,
530 p_buffer
, i_len
, false );
532 p_access
->info
.b_eof
= true;
533 else if( i_read
> 0 )
534 p_access
->info
.i_pos
+= i_read
;
540 /*****************************************************************************
542 *****************************************************************************/
543 static ssize_t
Write( sout_access_out_t
*p_access
, block_t
*p_buffer
)
545 access_sys_t
*p_sys
= GET_OUT_SYS(p_access
);
548 assert( p_sys
->fd_data
!= -1 );
550 while( p_buffer
!= NULL
)
552 block_t
*p_next
= p_buffer
->p_next
;;
554 i_write
+= net_Write( p_access
, p_sys
->fd_data
, NULL
,
555 p_buffer
->p_buffer
, p_buffer
->i_buffer
);
556 block_Release( p_buffer
);
564 /*****************************************************************************
566 *****************************************************************************/
567 static int Control( access_t
*p_access
, int i_query
, va_list args
)
575 case ACCESS_CAN_SEEK
:
576 pb_bool
= (bool*)va_arg( args
, bool* );
577 *pb_bool
= !p_access
->p_sys
->directory
;
579 case ACCESS_CAN_FASTSEEK
:
580 pb_bool
= (bool*)va_arg( args
, bool* );
583 case ACCESS_CAN_PAUSE
:
584 pb_bool
= (bool*)va_arg( args
, bool* );
585 *pb_bool
= true; /* FIXME */
587 case ACCESS_CAN_CONTROL_PACE
:
588 pb_bool
= (bool*)va_arg( args
, bool* );
589 *pb_bool
= true; /* FIXME */
593 case ACCESS_GET_PTS_DELAY
:
594 pi_64
= (int64_t*)va_arg( args
, int64_t * );
595 *pi_64
= INT64_C(1000)
596 * var_InheritInteger( p_access
, "network-caching" );
600 case ACCESS_SET_PAUSE_STATE
:
601 pb_bool
= (bool*)va_arg( args
, bool* );
603 return Seek( p_access
, p_access
->info
.i_pos
);
606 case ACCESS_GET_TITLE_INFO
:
607 case ACCESS_SET_TITLE
:
608 case ACCESS_SET_SEEKPOINT
:
609 case ACCESS_SET_PRIVATE_ID_STATE
:
610 case ACCESS_GET_CONTENT_TYPE
:
611 case ACCESS_GET_META
:
615 msg_Warn( p_access
, "unimplemented query in control: %d", i_query
);
622 /*****************************************************************************
624 *****************************************************************************/
625 static int ftp_SendCommand( vlc_object_t
*p_access
, access_sys_t
*p_sys
,
626 const char *psz_fmt
, ... )
631 va_start( args
, psz_fmt
);
632 if( vasprintf( &psz_cmd
, psz_fmt
, args
) == -1 )
637 msg_Dbg( p_access
, "ftp_SendCommand:\"%s\"", psz_cmd
);
639 if( net_Printf( p_access
, p_sys
->fd_cmd
, NULL
, "%s\r\n", psz_cmd
) < 0 )
641 msg_Err( p_access
, "failed to send command" );
647 /* TODO support this s**t :
648 RFC 959 allows the client to send certain TELNET strings at any moment,
649 even in the middle of a request:
652 * \377\376x where x is one byte.
653 * \377\375x where x is one byte. The server is obliged to send \377\374x
654 * immediately after reading x.
655 * \377\374x where x is one byte.
656 * \377\373x where x is one byte. The server is obliged to send \377\376x
657 * immediately after reading x.
658 * \377x for any other byte x.
660 These strings are not part of the requests, except in the case \377\377,
661 where the request contains one \377. */
662 static int ftp_ReadCommand( vlc_object_t
*p_access
, access_sys_t
*p_sys
,
663 int *pi_answer
, char **ppsz_answer
)
668 psz_line
= net_Gets( p_access
, p_sys
->fd_cmd
, NULL
);
669 if( psz_line
== NULL
|| strlen( psz_line
) < 3 )
671 msg_Err( p_access
, "cannot get answer" );
673 if( pi_answer
) *pi_answer
= 500;
674 if( ppsz_answer
) *ppsz_answer
= NULL
;
677 msg_Dbg( p_access
, "answer=%s", psz_line
);
679 if( psz_line
[3] == '-' ) /* Multiple response */
683 memcpy( end
, psz_line
, 3 );
688 char *psz_tmp
= net_Gets( p_access
, p_sys
->fd_cmd
, NULL
);
690 if( psz_tmp
== NULL
) /* Error */
693 if( !strncmp( psz_tmp
, end
, 4 ) )
702 i_answer
= atoi( psz_line
);
704 if( pi_answer
) *pi_answer
= i_answer
;
707 *ppsz_answer
= psz_line
;
713 return( i_answer
/ 100 );
716 static int ftp_StartStream( vlc_object_t
*p_access
, access_sys_t
*p_sys
,
719 char psz_ipv4
[16], *psz_ip
= p_sys
->sz_epsv_ip
;
721 char *psz_arg
, *psz_parser
;
724 assert( p_sys
->fd_data
== -1 );
726 if( ( ftp_SendCommand( p_access
, p_sys
, *psz_ip
? "EPSV" : "PASV" ) < 0 )
727 || ( ftp_ReadCommand( p_access
, p_sys
, &i_answer
, &psz_arg
) != 2 ) )
729 msg_Err( p_access
, "cannot set passive mode" );
733 psz_parser
= strchr( psz_arg
, '(' );
734 if( psz_parser
== NULL
)
737 msg_Err( p_access
, "cannot parse passive mode response" );
743 char psz_fmt
[7] = "(|||%u";
744 psz_fmt
[1] = psz_fmt
[2] = psz_fmt
[3] = psz_parser
[1];
746 if( sscanf( psz_parser
, psz_fmt
, &i_port
) < 1 )
749 msg_Err( p_access
, "cannot parse passive mode response" );
755 unsigned a1
, a2
, a3
, a4
, p1
, p2
;
757 if( ( sscanf( psz_parser
, "(%u,%u,%u,%u,%u,%u", &a1
, &a2
, &a3
, &a4
,
758 &p1
, &p2
) < 6 ) || ( a1
> 255 ) || ( a2
> 255 )
759 || ( a3
> 255 ) || ( a4
> 255 ) || ( p1
> 255 ) || ( p2
> 255 ) )
762 msg_Err( p_access
, "cannot parse passive mode response" );
766 sprintf( psz_ipv4
, "%u.%u.%u.%u", a1
, a2
, a3
, a4
);
768 i_port
= (p1
<< 8) | p2
;
772 msg_Dbg( p_access
, "ip:%s port:%d", psz_ip
, i_port
);
774 if( ftp_SendCommand( p_access
, p_sys
, "TYPE I" ) < 0 ||
775 ftp_ReadCommand( p_access
, p_sys
, &i_answer
, NULL
) != 2 )
777 msg_Err( p_access
, "cannot set binary transfer mode" );
783 if( ftp_SendCommand( p_access
, p_sys
, "REST %"PRIu64
, i_start
) < 0 ||
784 ftp_ReadCommand( p_access
, p_sys
, &i_answer
, NULL
) > 3 )
786 msg_Err( p_access
, "cannot set restart offset" );
791 msg_Dbg( p_access
, "waiting for data connection..." );
792 p_sys
->fd_data
= net_ConnectTCP( p_access
, psz_ip
, i_port
);
793 if( p_sys
->fd_data
< 0 )
795 msg_Err( p_access
, "failed to connect with server" );
798 msg_Dbg( p_access
, "connection with \"%s:%d\" successful",
801 if( p_sys
->directory
)
803 if( ftp_SendCommand( p_access
, p_sys
, "NLST" ) < 0 ||
804 ftp_ReadCommand( p_access
, p_sys
, NULL
, &psz_arg
) > 2 )
806 msg_Err( p_access
, "cannot list directory contents" );
813 assert( p_sys
->url
.psz_path
);
814 if( ftp_SendCommand( p_access
, p_sys
, "%s %s",
815 p_sys
->out
? "STOR" : "RETR",
816 p_sys
->url
.psz_path
) < 0
817 || ftp_ReadCommand( p_access
, p_sys
, &i_answer
, NULL
) > 2 )
819 msg_Err( p_access
, "cannot retrieve file" );
824 shutdown( p_sys
->fd_data
, p_sys
->out
? SHUT_RD
: SHUT_WR
);
829 static int ftp_StopStream ( vlc_object_t
*p_access
, access_sys_t
*p_sys
)
831 if( ftp_SendCommand( p_access
, p_sys
, "ABOR" ) < 0 )
833 msg_Warn( p_access
, "cannot abort file" );
834 if( p_sys
->fd_data
> 0 )
835 net_Close( p_sys
->fd_data
);
840 if( p_sys
->fd_data
!= -1 )
842 net_Close( p_sys
->fd_data
);
844 /* Read the final response from RETR/STOR, i.e. 426 or 226 */
845 ftp_ReadCommand( p_access
, p_sys
, NULL
, NULL
);
847 /* Read the response from ABOR, i.e. 226 or 225 */
848 ftp_ReadCommand( p_access
, p_sys
, NULL
, NULL
);