dialog: use new API
[vlc.git] / modules / access / ftp.c
1 /*****************************************************************************
2  * ftp.c: FTP input module
3  *****************************************************************************
4  * Copyright (C) 2001-2006 VLC authors and VideoLAN
5  * Copyright © 2006 Rémi Denis-Courmont
6  * $Id$
7  *
8  * Authors: Laurent Aimar <fenrir@via.ecp.fr> - original code
9  *          Rémi Denis-Courmont <rem # videolan.org> - EPSV support
10  *
11  * This program is free software; you can redistribute it and/or modify it
12  * under the terms of the GNU Lesser General Public License as published by
13  * the Free Software Foundation; either version 2.1 of the License, or
14  * (at your option) any later version.
15  *
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 Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25
26 /*****************************************************************************
27  * Preamble
28  *****************************************************************************/
29 #ifdef HAVE_CONFIG_H
30 # include "config.h"
31 #endif
32
33 #include <assert.h>
34 #include <stdint.h>
35 #include <errno.h>
36
37 #include <vlc_common.h>
38 #include <vlc_plugin.h>
39 #include <vlc_access.h>
40 #include <vlc_dialog.h>
41 #include <vlc_input_item.h>
42 #include <vlc_network.h>
43 #include <vlc_url.h>
44 #include <vlc_tls.h>
45 #include <vlc_sout.h>
46 #include <vlc_charset.h>
47 #include <vlc_interrupt.h>
48 #include <vlc_keystore.h>
49
50 #ifndef IPPORT_FTP
51 # define IPPORT_FTP 21u
52 #endif
53
54 #ifndef IPPORT_FTPS
55 # define IPPORT_FTPS 990u
56 #endif
57
58 /*****************************************************************************
59  * Module descriptor
60  *****************************************************************************/
61 static int   InOpen ( vlc_object_t * );
62 static void  InClose( vlc_object_t * );
63 #ifdef ENABLE_SOUT
64 static int  OutOpen ( vlc_object_t * );
65 static void OutClose( vlc_object_t * );
66 #endif
67
68 #define USER_TEXT N_("Username")
69 #define USER_LONGTEXT N_("Username that will be used for the connection, " \
70         "if no username is set in the URL.")
71 #define PASS_TEXT N_("Password")
72 #define PASS_LONGTEXT N_("Password that will be used for the connection, " \
73         "if no username or password are set in URL.")
74 #define ACCOUNT_TEXT N_("FTP account")
75 #define ACCOUNT_LONGTEXT N_("Account that will be " \
76     "used for the connection.")
77
78 #define LOGIN_DIALOG_TITLE _("FTP authentication")
79 #define LOGIN_DIALOG_TEXT _("Please enter a valid login and password for " \
80         "the ftp connexion to %s")
81
82 vlc_module_begin ()
83     set_shortname( "FTP" )
84     set_description( N_("FTP input") )
85     set_capability( "access", 0 )
86     set_category( CAT_INPUT )
87     set_subcategory( SUBCAT_INPUT_ACCESS )
88     add_string( "ftp-user", "anonymous", USER_TEXT, USER_LONGTEXT,
89                 false )
90     add_string( "ftp-pwd", "anonymous@example.com", PASS_TEXT,
91                 PASS_LONGTEXT, false )
92     add_string( "ftp-account", "anonymous", ACCOUNT_TEXT,
93                 ACCOUNT_LONGTEXT, false )
94     add_shortcut( "ftp", "ftps", "ftpes" )
95     set_callbacks( InOpen, InClose )
96
97 #ifdef ENABLE_SOUT
98     add_submodule ()
99         set_shortname( "FTP" )
100         set_description( N_("FTP upload output") )
101         set_capability( "sout access", 0 )
102         set_category( CAT_SOUT )
103         set_subcategory( SUBCAT_SOUT_ACO )
104         add_shortcut( "ftp", "ftps", "ftpes" )
105         set_callbacks( OutOpen, OutClose )
106 #endif
107 vlc_module_end ()
108
109 /*****************************************************************************
110  * Local prototypes
111  *****************************************************************************/
112 static ssize_t Read( access_t *, uint8_t *, size_t );
113 static int Seek( access_t *, uint64_t );
114 static int Control( access_t *, int, va_list );
115 static input_item_t* DirRead( access_t * );
116 static int DirControl( access_t *, int, va_list );
117 #ifdef ENABLE_SOUT
118 static int OutSeek( sout_access_out_t *, off_t );
119 static ssize_t Write( sout_access_out_t *, block_t * );
120 #endif
121
122 static int LoginUserPwd( vlc_object_t *, access_sys_t *,
123                          const char *, const char *, bool * );
124 static void FeaturesCheck( void *, const char * );
125
126 typedef struct ftp_features_t
127 {
128     bool b_unicode;
129     bool b_authtls;
130 } ftp_features_t;
131
132 enum tls_mode_e
133 {
134     NONE = 0,
135     IMPLICIT,/* ftps */
136     EXPLICIT /* ftpes */
137 };
138
139 struct access_sys_t
140 {
141     vlc_url_t  url;
142
143     ftp_features_t   features;
144     vlc_tls_creds_t *p_creds;
145     enum tls_mode_e  tlsmode;
146     struct
147     {
148         vlc_tls_t   *p_tls;
149         int          fd;
150     } cmd, data;
151
152     char       sz_epsv_ip[NI_MAXNUMERICHOST];
153     bool       out;
154     uint64_t   offset;
155     uint64_t   size;
156 };
157 #define GET_OUT_SYS( p_this ) \
158     ((access_sys_t *)(((sout_access_out_t *)(p_this))->p_sys))
159
160 static int ftp_SendCommand( vlc_object_t *obj, access_sys_t *sys,
161                             const char *fmt, ... )
162 {
163     size_t fmtlen = strlen( fmt );
164     char fmtbuf[fmtlen + 3];
165
166     memcpy( fmtbuf, fmt, fmtlen );
167     memcpy( fmtbuf + fmtlen, "\r\n", 3 );
168
169     va_list args;
170     char *cmd;
171     int val;
172
173     va_start( args, fmt );
174     val = vasprintf( &cmd, fmtbuf, args );
175     va_end( args );
176     if( unlikely(val == -1) )
177         return -1;
178
179     msg_Dbg( obj, "sending request: \"%.*s\" (%d bytes)", val - 2, cmd, val );
180     if( ((sys->cmd.p_tls != NULL)
181             ? vlc_tls_Write( sys->cmd.p_tls, cmd, val )
182             : net_Write( obj, sys->cmd.fd, cmd, val )) != val )
183     {
184         msg_Err( obj, "request failure" );
185         val = -1;
186     }
187     else
188         val = 0;
189     free( cmd );
190     return val;
191 }
192
193 /* TODO support this s**t :
194  RFC 959 allows the client to send certain TELNET strings at any moment,
195  even in the middle of a request:
196
197  * \377\377.
198  * \377\376x where x is one byte.
199  * \377\375x where x is one byte. The server is obliged to send \377\374x
200  *                                immediately after reading x.
201  * \377\374x where x is one byte.
202  * \377\373x where x is one byte. The server is obliged to send \377\376x
203  *                                immediately after reading x.
204  * \377x for any other byte x.
205
206  These strings are not part of the requests, except in the case \377\377,
207  where the request contains one \377. */
208 static int ftp_RecvAnswer( vlc_object_t *obj, access_sys_t *sys,
209                            int *restrict codep, char **restrict strp,
210                            void (*cb)(void *, const char *), void *opaque )
211 {
212     if( codep != NULL )
213         *codep = 500;
214     if( strp != NULL )
215         *strp = NULL;
216
217     char *resp;
218     if( sys->cmd.p_tls != NULL )
219         resp = vlc_tls_GetLine( sys->cmd.p_tls );
220     else
221         resp = net_Gets( obj, sys->cmd.fd );
222     if( resp == NULL )
223     {
224         msg_Err( obj, "response failure" );
225         goto error;
226     }
227
228     char *end;
229     unsigned code = strtoul( resp, &end, 10 );
230     if( (end - resp) != 3 || (*end != '-' && *end != ' ') )
231     {
232         msg_Err( obj, "malformatted response" );
233         goto error;
234     }
235     msg_Dbg( obj, "received response: \"%s\"", resp );
236
237     if( *end == '-' ) /* Multi-line response */
238     {
239         bool done;
240
241         *end = ' ';
242         do
243         {
244             char *line;
245             if( sys->cmd.p_tls != NULL )
246                 line = vlc_tls_GetLine( sys->cmd.p_tls );
247             else
248                 line = net_Gets( obj, sys->cmd.fd );
249             if( line == NULL )
250             {
251                 msg_Err( obj, "response failure" );
252                 goto error;
253             }
254
255             done = !strncmp( resp, line, 4 );
256             if( !done )
257                 cb( opaque, line );
258             free( line );
259         }
260         while( !done );
261     }
262
263     if( codep != NULL )
264         *codep = code;
265     if( strp != NULL )
266         *strp = resp;
267     else
268         free( resp );
269     return code / 100;
270 error:
271     free( resp );
272     return -1;
273 }
274
275 static void DummyLine( void *data, const char *str )
276 {
277     (void) data; (void) str;
278 }
279
280 static int ftp_RecvCommand( vlc_object_t *obj, access_sys_t *sys,
281                             int *restrict codep, char **restrict strp )
282 {
283     return ftp_RecvAnswer( obj, sys, codep, strp, DummyLine, NULL );
284 }
285
286 static int ftp_StartStream( vlc_object_t *, access_sys_t *, uint64_t, bool );
287 static int ftp_StopStream ( vlc_object_t *, access_sys_t * );
288
289 static int readTLSMode( vlc_object_t *obj, access_sys_t *p_sys,
290                         const char * psz_access )
291 {
292     if ( !strncmp( psz_access, "ftps", 4 ) )
293         p_sys->tlsmode = IMPLICIT;
294     else
295     if ( !strncmp( psz_access, "ftpes", 5 ) )
296         p_sys->tlsmode = EXPLICIT;
297     else
298     {
299         p_sys->p_creds = NULL;
300         p_sys->tlsmode = NONE;
301         return 0;
302     }
303
304     p_sys->p_creds = vlc_tls_ClientCreate( obj );
305     return (p_sys->p_creds != NULL) ? 0 : -1;
306 }
307
308 static int createCmdTLS( vlc_object_t *p_access, access_sys_t *p_sys, int fd,
309                          const char *psz_session_name )
310 {
311     /* TLS/SSL handshake */
312     p_sys->cmd.p_tls = vlc_tls_ClientSessionCreateFD( p_sys->p_creds, fd,
313                                                       p_sys->url.psz_host,
314                                                       psz_session_name,
315                                                       NULL, NULL );
316     if( p_sys->cmd.p_tls == NULL )
317     {
318         msg_Err( p_access, "cannot establish FTP/TLS session on command channel" );
319         return -1;
320     }
321
322     return 0;
323 }
324
325 static void clearCmdTLS( access_sys_t *p_sys )
326 {
327     if ( p_sys->cmd.p_tls ) vlc_tls_SessionDelete( p_sys->cmd.p_tls );
328     p_sys->cmd.p_tls = NULL;
329 }
330
331 static int Login( vlc_object_t *p_access, access_sys_t *p_sys )
332 {
333     int i_answer;
334
335     /* *** Open a TCP connection with server *** */
336     int fd = p_sys->cmd.fd = net_ConnectTCP( p_access, p_sys->url.psz_host,
337                                              p_sys->url.i_port );
338     if( fd == -1 )
339     {
340         msg_Err( p_access, "connection failed" );
341         vlc_dialog_display_error( p_access, _("Network interaction failed"), "%s",
342             _("VLC could not connect with the given server.") );
343         return -1;
344     }
345
346     if ( p_sys->tlsmode == IMPLICIT ) /* FTPS Mode */
347     {
348         if ( createCmdTLS( p_access, p_sys, fd, "ftps") < 0 )
349             goto error;
350     }
351
352     while( ftp_RecvCommand( p_access, p_sys, &i_answer, NULL ) == 1 );
353
354     if( i_answer / 100 != 2 )
355     {
356         msg_Err( p_access, "connection rejected" );
357         vlc_dialog_display_error( p_access, _("Network interaction failed"), "%s",
358             _("VLC's connection to the given server was rejected.") );
359         return -1;
360     }
361
362     msg_Dbg( p_access, "connection accepted (%d)", i_answer );
363
364     /* Features check first */
365     if( ftp_SendCommand( p_access, p_sys, "FEAT" ) < 0
366      || ftp_RecvAnswer( p_access, p_sys, NULL, NULL,
367                         FeaturesCheck, &p_sys->features ) < 0 )
368     {
369          msg_Err( p_access, "cannot get server features" );
370          return -1;
371     }
372
373     /* Create TLS Session */
374     if( p_sys->tlsmode == EXPLICIT )
375     {
376         if ( ! p_sys->features.b_authtls )
377         {
378             msg_Err( p_access, "Server does not support TLS" );
379             return -1;
380         }
381
382         if( ftp_SendCommand( p_access, p_sys, "AUTH TLS" ) < 0
383          || ftp_RecvCommand( p_access, p_sys, &i_answer, NULL ) < 0
384          || i_answer != 234 )
385         {
386              msg_Err( p_access, "cannot switch to TLS: server replied with code %d",
387                       i_answer );
388              return -1;
389         }
390
391         if ( createCmdTLS( p_access, p_sys, fd, "ftpes") < 0 )
392         {
393             goto error;
394         }
395     }
396
397     if( p_sys->tlsmode != NONE )
398     {
399         if( ftp_SendCommand( p_access, p_sys, "PBSZ 0" ) < 0 ||
400             ftp_RecvCommand( p_access, p_sys, &i_answer, NULL ) < 0 ||
401             i_answer != 200 )
402         {
403             msg_Err( p_access, "Can't truncate Protection buffer size for TLS" );
404             goto error;
405         }
406
407         if( ftp_SendCommand( p_access, p_sys, "PROT P" ) < 0 ||
408             ftp_RecvCommand( p_access, p_sys, &i_answer, NULL ) < 0 ||
409             i_answer != 200 )
410         {
411             msg_Err( p_access, "Can't set Data channel protection" );
412             goto error;
413         }
414     }
415
416     vlc_url_t url;
417     vlc_credential credential;
418     vlc_UrlParse( &url, ((access_t *)p_access)->psz_url );
419     vlc_credential_init( &credential, &url );
420     bool b_logged = false;
421
422     while( vlc_credential_get( &credential, p_access, "ftp-user", "ftp-pwd",
423                                LOGIN_DIALOG_TITLE, LOGIN_DIALOG_TEXT,
424                                url.psz_host )
425         && LoginUserPwd( p_access, p_sys, credential.psz_username,
426                          credential.psz_password, &b_logged ) == 0
427         && !b_logged );
428     if( b_logged )
429     {
430         vlc_credential_store( &credential );
431         vlc_credential_clean( &credential );
432         vlc_UrlClean( &url );
433         return 0;
434     }
435     vlc_credential_clean( &credential );
436     vlc_UrlClean( &url );
437 error:
438     clearCmdTLS( p_sys );
439     return -1;
440 }
441
442 static int LoginUserPwd( vlc_object_t *p_access, access_sys_t *p_sys,
443                          const char *psz_user, const char *psz_pwd,
444                          bool *p_logged )
445 {
446     int i_answer;
447
448     /* Send credentials over channel */
449     if( ftp_SendCommand( p_access, p_sys, "USER %s", psz_user ) < 0 ||
450         ftp_RecvCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
451         return -1;
452
453     switch( i_answer / 100 )
454     {
455         case 2:
456             /* X.509 auth successful after AUTH TLS / RFC 2228 sec. 4 */
457             if ( i_answer == 232 )
458                 msg_Dbg( p_access, "user accepted and authenticated" );
459             else
460                 msg_Dbg( p_access, "user accepted" );
461             break;
462         case 3:
463             msg_Dbg( p_access, "password needed" );
464
465             if( ftp_SendCommand( p_access, p_sys, "PASS %s", psz_pwd ) < 0 ||
466                 ftp_RecvCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
467                 return -1;
468
469             switch( i_answer / 100 )
470             {
471                 case 2:
472                     msg_Dbg( p_access, "password accepted" );
473                     break;
474                 case 3:
475                 {
476                     char *psz;
477                     msg_Dbg( p_access, "account needed" );
478                     psz = var_InheritString( p_access, "ftp-account" );
479                     if( ftp_SendCommand( p_access, p_sys, "ACCT %s",
480                                          psz ) < 0 ||
481                         ftp_RecvCommand( p_access, p_sys, &i_answer, NULL ) < 0 )
482                     {
483                         free( psz );
484                         return -1;
485                     }
486                     free( psz );
487
488                     if( i_answer / 100 != 2 )
489                     {
490                         msg_Err( p_access, "account rejected" );
491                         vlc_dialog_display_error( p_access,
492                           _("Network interaction failed"),
493                           "%s", _("Your account was rejected.") );
494                         return -1;
495                     }
496                     msg_Dbg( p_access, "account accepted" );
497                     break;
498                 }
499
500                 default:
501                     msg_Warn( p_access, "password rejected" );
502                     *p_logged = false;
503                     return 0;
504             }
505             break;
506         default:
507             msg_Warn( p_access, "user rejected" );
508             *p_logged = false;
509             return 0;
510     }
511
512     *p_logged = true;
513     return 0;
514 }
515
516 static void FeaturesCheck( void *opaque, const char *feature )
517 {
518     ftp_features_t *features = opaque;
519
520     if( strcasestr( feature, "UTF8" ) != NULL )
521         features->b_unicode = true;
522     else
523     if( strcasestr( feature, "AUTH TLS" ) != NULL )
524         features->b_authtls = true;
525 }
526
527 static const char *IsASCII( const char *str )
528 {
529     int8_t c;
530     for( const char *p = str; (c = *p) != '\0'; p++ )
531         if( c < 0 )
532             return NULL;
533     return str;
534 }
535
536 static int Connect( vlc_object_t *p_access, access_sys_t *p_sys )
537 {
538     if( Login( p_access, p_sys ) < 0 )
539         return -1;
540
541     /* Extended passive mode */
542     if( ftp_SendCommand( p_access, p_sys, "EPSV ALL" ) < 0 )
543     {
544         msg_Err( p_access, "cannot request extended passive mode" );
545         goto error;
546     }
547
548     if( ftp_RecvCommand( p_access, p_sys, NULL, NULL ) == 2 )
549     {
550         if( net_GetPeerAddress( p_sys->cmd.fd, p_sys->sz_epsv_ip, NULL ) )
551             goto error;
552     }
553     else
554     {
555         /* If ESPV ALL fails, we fallback to PASV.
556          * We have to restart the connection in case there is a NAT that
557          * understands EPSV ALL in the way, and hence won't allow PASV on
558          * the initial connection.
559          */
560         msg_Info( p_access, "FTP Extended passive mode disabled" );
561         clearCmdTLS( p_sys );
562         net_Close( p_sys->cmd.fd );
563
564         if( Login( p_access, p_sys ) )
565             goto error;
566     }
567
568     if( p_sys->url.psz_path &&
569         (p_sys->features.b_unicode ? IsUTF8 : IsASCII)(p_sys->url.psz_path) == NULL )
570     {
571         msg_Err( p_access, "unsupported path: \"%s\"", p_sys->url.psz_path );
572         goto error;
573     }
574
575     /* check binary mode support */
576     if( ftp_SendCommand( p_access, p_sys, "TYPE I" ) < 0 ||
577         ftp_RecvCommand( p_access, p_sys, NULL, NULL ) != 2 )
578     {
579         msg_Err( p_access, "cannot set binary transfer mode" );
580         goto error;
581     }
582
583     return 0;
584
585 error:
586     clearCmdTLS( p_sys );
587     net_Close( p_sys->cmd.fd );
588     return -1;
589 }
590
591
592 static int parseURL( vlc_url_t *url, const char *path, enum tls_mode_e mode )
593 {
594     if( path == NULL )
595         return VLC_EGENERIC;
596
597     /* *** Parse URL and get server addr/port and path *** */
598     while( *path == '/' )
599         path++;
600
601     vlc_UrlParse( url, path );
602
603     if( url->psz_host == NULL || *url->psz_host == '\0' )
604         return VLC_EGENERIC;
605
606     if( url->i_port <= 0 )
607     {
608         if( mode == IMPLICIT )
609             url->i_port = IPPORT_FTPS;
610         else
611             url->i_port = IPPORT_FTP; /* default port */
612     }
613
614     if( url->psz_path == NULL )
615         return VLC_SUCCESS;
616     /* FTP URLs are relative to user's default directory (RFC1738 §3.2)
617     For absolute path use ftp://foo.bar//usr/local/etc/filename */
618     /* FIXME: we should issue a series of CWD, one per slash */
619     if( url->psz_path )
620     {
621         assert( url->psz_path[0] == '/' );
622         url->psz_path++;
623     }
624
625     char *type = strstr( url->psz_path, ";type=" );
626     if( type )
627     {
628         *type = '\0';
629         if( strchr( "iI", type[6] ) == NULL )
630             return VLC_EGENERIC; /* ASCII and directory not supported */
631     }
632     vlc_uri_decode( url->psz_path );
633     return VLC_SUCCESS;
634 }
635
636
637 /****************************************************************************
638  * Open: connect to ftp server and ask for file
639  ****************************************************************************/
640 static int InOpen( vlc_object_t *p_this )
641 {
642     access_t     *p_access = (access_t*)p_this;
643     access_sys_t *p_sys;
644     char         *psz_arg;
645     bool          b_directory = false;
646
647     /* Init p_access */
648     access_InitFields( p_access );
649     p_sys = p_access->p_sys = (access_sys_t*)calloc( 1, sizeof( access_sys_t ) );
650     if( !p_sys )
651         return VLC_ENOMEM;
652     p_sys->data.fd = -1;
653     p_sys->out = false;
654     p_sys->offset = 0;
655     p_sys->size = UINT64_MAX;
656
657     if( readTLSMode( p_this, p_sys, p_access->psz_access ) )
658         goto exit_error;
659
660     if( parseURL( &p_sys->url, p_access->psz_location, p_sys->tlsmode ) )
661         goto exit_error;
662
663     if( Connect( p_this, p_sys ) )
664         goto exit_error;
665
666     /* get size */
667     if( p_sys->url.psz_path == NULL )
668         b_directory = true;
669     else
670     if( ftp_SendCommand( p_this, p_sys, "SIZE %s", p_sys->url.psz_path ) < 0 )
671         goto error;
672     else
673     if ( ftp_RecvCommand( p_this, p_sys, NULL, &psz_arg ) == 2 )
674     {
675         p_sys->size = atoll( &psz_arg[4] );
676         free( psz_arg );
677         msg_Dbg( p_access, "file size: %"PRIu64, p_sys->size );
678     }
679     else
680     if( ftp_SendCommand( p_this, p_sys, "CWD %s", p_sys->url.psz_path ) < 0 )
681         goto error;
682     else
683     if( ftp_RecvCommand( p_this, p_sys, NULL, NULL ) != 2 )
684     {
685         msg_Err( p_this, "file or directory does not exist" );
686         goto error;
687     }
688     else
689         b_directory = true;
690
691     if( b_directory )
692     {
693         p_access->pf_readdir = DirRead;
694         p_access->pf_control = DirControl;
695     } else
696         ACCESS_SET_CALLBACKS( Read, NULL, Control, Seek ); \
697
698     /* Start the 'stream' */
699     if( ftp_StartStream( p_this, p_sys, 0, b_directory ) < 0 )
700     {
701         msg_Err( p_this, "cannot retrieve file" );
702         clearCmdTLS( p_sys );
703         net_Close( p_sys->cmd.fd );
704         goto exit_error;
705     }
706
707     return VLC_SUCCESS;
708
709 error:
710     clearCmdTLS( p_sys );
711     net_Close( p_sys->cmd.fd );
712
713 exit_error:
714     vlc_UrlClean( &p_sys->url );
715     vlc_tls_Delete( p_sys->p_creds );
716     free( p_sys );
717     return VLC_EGENERIC;
718 }
719
720 #ifdef ENABLE_SOUT
721 static int OutOpen( vlc_object_t *p_this )
722 {
723     sout_access_out_t *p_access = (sout_access_out_t *)p_this;
724     access_sys_t      *p_sys;
725
726     p_sys = calloc( 1, sizeof( *p_sys ) );
727     if( !p_sys )
728         return VLC_ENOMEM;
729
730     /* Init p_access */
731     p_sys->data.fd = -1;
732     p_sys->out = true;
733
734     if( readTLSMode( p_this, p_sys, p_access->psz_access ) )
735         goto exit_error;
736
737     if( parseURL( &p_sys->url, p_access->psz_path, p_sys->tlsmode ) )
738         goto exit_error;
739     if( p_sys->url.psz_path == NULL )
740     {
741         msg_Err( p_this, "no filename specified" );
742         goto exit_error;
743     }
744
745     if( Connect( p_this, p_sys ) )
746         goto exit_error;
747
748     /* Start the 'stream' */
749     if( ftp_StartStream( p_this, p_sys, 0, false ) < 0 )
750     {
751         msg_Err( p_access, "cannot store file" );
752         clearCmdTLS( p_sys );
753         net_Close( p_sys->cmd.fd );
754         goto exit_error;
755     }
756
757     p_access->pf_seek = OutSeek;
758     p_access->pf_write = Write;
759     p_access->p_sys = (void *)p_sys;
760
761     return VLC_SUCCESS;
762
763 exit_error:
764     vlc_UrlClean( &p_sys->url );
765     vlc_tls_Delete( p_sys->p_creds );
766     free( p_sys );
767     return VLC_EGENERIC;
768 }
769 #endif
770
771 /*****************************************************************************
772  * Close: free unused data structures
773  *****************************************************************************/
774 static void Close( vlc_object_t *p_access, access_sys_t *p_sys )
775 {
776     msg_Dbg( p_access, "stopping stream" );
777     ftp_StopStream( p_access, p_sys );
778
779     if( ftp_SendCommand( p_access, p_sys, "QUIT" ) < 0 )
780     {
781         msg_Warn( p_access, "cannot quit" );
782     }
783     else
784     {
785         ftp_RecvCommand( p_access, p_sys, NULL, NULL );
786     }
787
788     clearCmdTLS( p_sys );
789     net_Close( p_sys->cmd.fd );
790
791     /* free memory */
792     vlc_UrlClean( &p_sys->url );
793     vlc_tls_Delete( p_sys->p_creds );
794     free( p_sys );
795 }
796
797 static void InClose( vlc_object_t *p_this )
798 {
799     Close( p_this, ((access_t *)p_this)->p_sys);
800 }
801
802 #ifdef ENABLE_SOUT
803 static void OutClose( vlc_object_t *p_this )
804 {
805     Close( p_this, GET_OUT_SYS(p_this));
806 }
807 #endif
808
809
810 /*****************************************************************************
811  * Seek: try to go at the right place
812  *****************************************************************************/
813 static int _Seek( vlc_object_t *p_access, access_sys_t *p_sys, uint64_t i_pos )
814 {
815     msg_Dbg( p_access, "seeking to %"PRIu64, i_pos );
816
817     ftp_StopStream( (vlc_object_t *)p_access, p_sys );
818     if( ftp_StartStream( (vlc_object_t *)p_access, p_sys, i_pos, false ) < 0 )
819         return VLC_EGENERIC;
820
821     return VLC_SUCCESS;
822 }
823
824 static int Seek( access_t *p_access, uint64_t i_pos )
825 {
826     access_sys_t *p_sys = p_access->p_sys;
827
828     int val = _Seek( (vlc_object_t *)p_access, p_sys, i_pos );
829     if( val )
830         return val;
831
832     p_access->info.b_eof = false;
833     p_sys->offset = i_pos;
834
835     return VLC_SUCCESS;
836 }
837
838 #ifdef ENABLE_SOUT
839 static int OutSeek( sout_access_out_t *p_access, off_t i_pos )
840 {
841     return _Seek( (vlc_object_t *)p_access, GET_OUT_SYS( p_access ), i_pos);
842 }
843 #endif
844
845 /*****************************************************************************
846  * Read:
847  *****************************************************************************/
848 static ssize_t Read( access_t *p_access, uint8_t *p_buffer, size_t i_len )
849 {
850     access_sys_t *p_sys = p_access->p_sys;
851     int i_read;
852
853     assert( p_sys->data.fd != -1 );
854     assert( !p_sys->out );
855
856     if( p_access->info.b_eof )
857         return 0;
858
859     if( p_sys->data.p_tls != NULL )
860         i_read = vlc_tls_Read( p_sys->data.p_tls, p_buffer, i_len, false );
861     else
862         i_read = vlc_recv_i11e( p_sys->data.fd, p_buffer, i_len, 0 );
863
864     if( i_read > 0 )
865         p_sys->offset += i_read;
866     else if( i_read == 0 )
867         p_access->info.b_eof = true;
868     else if( errno != EINTR && errno != EAGAIN )
869     {
870         msg_Err( p_access, "receive error: %s", vlc_strerror_c(errno) );
871         p_access->info.b_eof = true;
872     }
873
874     return i_read;
875 }
876
877 /*****************************************************************************
878  * DirRead:
879  *****************************************************************************/
880 static input_item_t* DirRead( access_t *p_access )
881 {
882     access_sys_t *p_sys = p_access->p_sys;
883     input_item_t *p_item = NULL;
884
885     assert( p_sys->data.fd != -1 );
886     assert( !p_sys->out );
887
888     char *psz_line;
889     if( p_sys->data.p_tls != NULL )
890         psz_line = vlc_tls_GetLine( p_sys->data.p_tls );
891     else
892         psz_line = net_Gets( p_access, p_sys->data.fd );
893     if( psz_line == NULL )
894         return NULL;
895
896     char *psz_uri;
897     if( asprintf( &psz_uri, "%s://%s:%d%s%s/%s",
898                   ( p_sys->tlsmode == NONE ) ? "ftp" :
899                   ( ( p_sys->tlsmode == IMPLICIT ) ? "ftps" : "ftpes" ),
900                   p_sys->url.psz_host, p_sys->url.i_port,
901                   p_sys->url.psz_path ? "/" : "",
902                   p_sys->url.psz_path ? p_sys->url.psz_path : "",
903                   psz_line ) != -1 )
904     {
905         p_item = input_item_NewWithTypeExt( psz_uri, psz_line, 0, NULL,
906                                             0, -1, ITEM_TYPE_UNKNOWN, 1 );
907         free( psz_uri );
908     }
909     free( psz_line );
910     return p_item;
911 }
912
913 static int DirControl( access_t *p_access, int i_query, va_list args )
914 {
915     switch( i_query )
916     {
917     case ACCESS_IS_DIRECTORY:
918         *va_arg( args, bool * ) = false; /* is not sorted */
919         *va_arg( args, bool * ) = true; /* might loop */
920         break;
921     default:
922         return access_vaDirectoryControlHelper( p_access, i_query, args );
923     }
924
925     return VLC_SUCCESS;
926 }
927
928 /*****************************************************************************
929  * Write:
930  *****************************************************************************/
931 #ifdef ENABLE_SOUT
932 static ssize_t Write( sout_access_out_t *p_access, block_t *p_buffer )
933 {
934     access_sys_t *p_sys = GET_OUT_SYS(p_access);
935     size_t i_write = 0;
936
937     assert( p_sys->data.fd != -1 );
938
939     while( p_buffer != NULL )
940     {
941         block_t *p_next = p_buffer->p_next;;
942
943         if( p_sys->data.p_tls != NULL )
944             i_write += vlc_tls_Write( p_sys->data.p_tls,
945                                       p_buffer->p_buffer, p_buffer->i_buffer );
946         else
947             i_write += net_Write( p_access, p_sys->data.fd,
948                                   p_buffer->p_buffer, p_buffer->i_buffer );
949         block_Release( p_buffer );
950
951         p_buffer = p_next;
952     }
953
954     return i_write;
955 }
956 #endif
957
958 /*****************************************************************************
959  * Control:
960  *****************************************************************************/
961 static int Control( access_t *p_access, int i_query, va_list args )
962 {
963     bool    *pb_bool;
964     int64_t *pi_64;
965
966     switch( i_query )
967     {
968         case ACCESS_CAN_SEEK:
969             pb_bool = (bool*)va_arg( args, bool* );
970             *pb_bool = true;
971             break;
972         case ACCESS_CAN_FASTSEEK:
973             pb_bool = (bool*)va_arg( args, bool* );
974             *pb_bool = false;
975             break;
976         case ACCESS_CAN_PAUSE:
977             pb_bool = (bool*)va_arg( args, bool* );
978             *pb_bool = true;    /* FIXME */
979             break;
980         case ACCESS_CAN_CONTROL_PACE:
981             pb_bool = (bool*)va_arg( args, bool* );
982             *pb_bool = true;    /* FIXME */
983             break;
984         case ACCESS_GET_SIZE:
985             if( p_access->p_sys->size == UINT64_MAX )
986                 return VLC_EGENERIC;
987             *va_arg( args, uint64_t * ) = p_access->p_sys->size;
988             break;
989
990         case ACCESS_GET_PTS_DELAY:
991             pi_64 = (int64_t*)va_arg( args, int64_t * );
992             *pi_64 = INT64_C(1000)
993                    * var_InheritInteger( p_access, "network-caching" );
994             break;
995
996         case ACCESS_SET_PAUSE_STATE:
997             pb_bool = (bool*)va_arg( args, bool* );
998             if ( !pb_bool )
999                  return Seek( p_access, p_access->p_sys->offset );
1000             break;
1001
1002         default:
1003             return VLC_EGENERIC;
1004
1005     }
1006     return VLC_SUCCESS;
1007 }
1008
1009 static int ftp_StartStream( vlc_object_t *p_access, access_sys_t *p_sys,
1010                             uint64_t i_start, bool b_directory )
1011 {
1012     char psz_ipv4[16], *psz_ip = p_sys->sz_epsv_ip;
1013     int  i_answer;
1014     char *psz_arg, *psz_parser;
1015     int  i_port;
1016
1017     assert( p_sys->data.fd == -1 );
1018
1019     if( ( ftp_SendCommand( p_access, p_sys, *psz_ip ? "EPSV" : "PASV" ) < 0 )
1020      || ( ftp_RecvCommand( p_access, p_sys, &i_answer, &psz_arg ) != 2 ) )
1021     {
1022         msg_Err( p_access, "cannot set passive mode" );
1023         return VLC_EGENERIC;
1024     }
1025
1026     psz_parser = strchr( psz_arg, '(' );
1027     if( psz_parser == NULL )
1028     {
1029         free( psz_arg );
1030         msg_Err( p_access, "cannot parse passive mode response" );
1031         return VLC_EGENERIC;
1032     }
1033
1034     if( *psz_ip )
1035     {
1036         char psz_fmt[7] = "(|||%u";
1037         psz_fmt[1] = psz_fmt[2] = psz_fmt[3] = psz_parser[1];
1038
1039         if( sscanf( psz_parser, psz_fmt, &i_port ) < 1 )
1040         {
1041             free( psz_arg );
1042             msg_Err( p_access, "cannot parse passive mode response" );
1043             return VLC_EGENERIC;
1044         }
1045     }
1046     else
1047     {
1048         unsigned a1, a2, a3, a4, p1, p2;
1049
1050         if( ( sscanf( psz_parser, "(%u,%u,%u,%u,%u,%u", &a1, &a2, &a3, &a4,
1051                       &p1, &p2 ) < 6 ) || ( a1 > 255 ) || ( a2 > 255 )
1052          || ( a3 > 255 ) || ( a4 > 255 ) || ( p1 > 255 ) || ( p2 > 255 ) )
1053         {
1054             free( psz_arg );
1055             msg_Err( p_access, "cannot parse passive mode response" );
1056             return VLC_EGENERIC;
1057         }
1058
1059         sprintf( psz_ipv4, "%u.%u.%u.%u", a1, a2, a3, a4 );
1060         psz_ip = psz_ipv4;
1061         i_port = (p1 << 8) | p2;
1062     }
1063     free( psz_arg );
1064
1065     msg_Dbg( p_access, "ip:%s port:%d", psz_ip, i_port );
1066
1067     if( ftp_SendCommand( p_access, p_sys, "TYPE I" ) < 0 ||
1068         ftp_RecvCommand( p_access, p_sys, &i_answer, NULL ) != 2 )
1069     {
1070         msg_Err( p_access, "cannot set binary transfer mode" );
1071         return VLC_EGENERIC;
1072     }
1073
1074     if( i_start > 0 )
1075     {
1076         if( ftp_SendCommand( p_access, p_sys, "REST %"PRIu64, i_start ) < 0 ||
1077             ftp_RecvCommand( p_access, p_sys, &i_answer, NULL ) > 3 )
1078         {
1079             msg_Err( p_access, "cannot set restart offset" );
1080             return VLC_EGENERIC;
1081         }
1082     }
1083
1084     msg_Dbg( p_access, "waiting for data connection..." );
1085     p_sys->data.fd = net_ConnectTCP( p_access, psz_ip, i_port );
1086     if( p_sys->data.fd < 0 )
1087     {
1088         msg_Err( p_access, "failed to connect with server" );
1089         return VLC_EGENERIC;
1090     }
1091     msg_Dbg( p_access, "connection with \"%s:%d\" successful",
1092              psz_ip, i_port );
1093
1094     if( b_directory )
1095     {
1096         if( ftp_SendCommand( p_access, p_sys, "NLST" ) < 0 ||
1097             ftp_RecvCommand( p_access, p_sys, NULL, &psz_arg ) > 2 )
1098         {
1099             msg_Err( p_access, "cannot list directory contents" );
1100             return VLC_EGENERIC;
1101         }
1102     }
1103     else
1104     {
1105         /* "1xx" message */
1106         assert( p_sys->url.psz_path );
1107         if( ftp_SendCommand( p_access, p_sys, "%s %s",
1108                              p_sys->out ? "STOR" : "RETR",
1109                              p_sys->url.psz_path ) < 0
1110          || ftp_RecvCommand( p_access, p_sys, &i_answer, NULL ) > 2 )
1111         {
1112             msg_Err( p_access, "cannot retrieve file" );
1113             return VLC_EGENERIC;
1114         }
1115     }
1116
1117     if( p_sys->tlsmode != NONE )
1118     {
1119         /* FIXME: Do Reuse TLS Session */
1120         /* TLS/SSL handshake */
1121         p_sys->data.p_tls = vlc_tls_ClientSessionCreateFD( p_sys->p_creds,
1122                             p_sys->data.fd, p_sys->url.psz_host,
1123                             ( p_sys->tlsmode == EXPLICIT ) ? "ftpes-data"
1124                                                            : "ftps-data",
1125                                                          NULL, NULL );
1126         if( p_sys->data.p_tls == NULL )
1127         {
1128             msg_Err( p_access, "cannot establish FTP/TLS session for data" \
1129                              ": server not allowing new session ?" );
1130             return VLC_EGENERIC;
1131         }
1132     }
1133     else
1134         shutdown( p_sys->data.fd, p_sys->out ? SHUT_RD : SHUT_WR );
1135
1136     return VLC_SUCCESS;
1137 }
1138
1139 static int ftp_StopStream ( vlc_object_t *p_access, access_sys_t *p_sys )
1140 {
1141     if( ftp_SendCommand( p_access, p_sys, "ABOR" ) < 0 )
1142     {
1143         msg_Warn( p_access, "cannot abort file" );
1144         if( p_sys->data.fd > 0 )
1145         {
1146             if ( p_sys->data.p_tls ) vlc_tls_SessionDelete( p_sys->data.p_tls );
1147             net_Close( p_sys->data.fd );
1148         }
1149         p_sys->data.fd = -1;
1150         p_sys->data.p_tls = NULL;
1151         return VLC_EGENERIC;
1152     }
1153
1154     if( p_sys->data.fd != -1 )
1155     {
1156         if ( p_sys->data.p_tls ) vlc_tls_SessionDelete( p_sys->data.p_tls );
1157         net_Close( p_sys->data.fd );
1158         p_sys->data.fd = -1;
1159         p_sys->data.p_tls = NULL;
1160         /* Read the final response from RETR/STOR, i.e. 426 or 226 */
1161         ftp_RecvCommand( p_access, p_sys, NULL, NULL );
1162     }
1163     /* Read the response from ABOR, i.e. 226 or 225 */
1164     ftp_RecvCommand( p_access, p_sys, NULL, NULL );
1165
1166     return VLC_SUCCESS;
1167 }