git.sesse.net Git - vlc/blob - modules/access/ftp.c

   1 /*****************************************************************************
   2  * ftp.c: FTP input module
   3  *****************************************************************************
   4  * Copyright (C) 2001-2004 VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #include <stdlib.h>
  28
  29 #include <vlc/vlc.h>
  30 #include <vlc/input.h>
  31
  32 #include "network.h"
  33
  34 /*****************************************************************************
  35  * Module descriptor
  36  *****************************************************************************/
  37 static int     Open ( vlc_object_t * );
  38 static void    Close( vlc_object_t * );
  39
  40 #define CACHING_TEXT N_("Caching value in ms")
  41 #define CACHING_LONGTEXT N_( \
  42     "Allows you to modify the default caching value for FTP streams. This " \
  43     "value should be set in millisecond units." )
  44 #define USER_TEXT N_("FTP user name")
  45 #define USER_LONGTEXT N_("Allows you to modify the user name that will " \
  46     "be used for the connection.")
  47 #define PASS_TEXT N_("FTP password")
  48 #define PASS_LONGTEXT N_("Allows you to modify the password that will be " \
  49     "used for the connection.")
  50 #define ACCOUNT_TEXT N_("FTP account")
  51 #define ACCOUNT_LONGTEXT N_("Allows you to modify the account that will be " \
  52     "used for the connection.")
  53
  54 vlc_module_begin();
  55     set_description( _("FTP input") );
  56     set_capability( "access2", 0 );
  57     add_integer( "ftp-caching", 2 * DEFAULT_PTS_DELAY / 1000, NULL,
  58                  CACHING_TEXT, CACHING_LONGTEXT, VLC_TRUE );
  59     add_string( "ftp-user", "anonymous", NULL, USER_TEXT, USER_LONGTEXT,
  60                 VLC_FALSE );
  61     add_string( "ftp-pwd", "anonymous@dummy.org", NULL, PASS_TEXT,
  62                 PASS_LONGTEXT, VLC_FALSE );
  63     add_string( "ftp-account", "anonymous", NULL, ACCOUNT_TEXT,
  64                 ACCOUNT_LONGTEXT, VLC_FALSE );
  65     add_shortcut( "ftp" );
  66     set_callbacks( Open, Close );
  67 vlc_module_end();
  68
  69 /*****************************************************************************
  70  * Local prototypes
  71  *****************************************************************************/
  72 static int Read( access_t *, uint8_t *, int );
  73 static int Seek( access_t *, int64_t );
  74 static int Control( access_t *, int, va_list );
  75
  76 struct access_sys_t
  77 {
  78     vlc_url_t url;
  79
  80     int       fd_cmd;
  81     int       fd_data;
  82 };
  83
  84 static int  ftp_SendCommand( access_t *, char *, ... );
  85 static int  ftp_ReadCommand( access_t *, int *, char ** );
  86 static int  ftp_StartStream( access_t *, int64_t );
  87 static int  ftp_StopStream ( access_t *);
  88
  89 /****************************************************************************
  90  * Open: connect to ftp server and ask for file
  91  ****************************************************************************/
  92 static int Open( vlc_object_t *p_this )
  93 {
  94     access_t     *p_access = (access_t*)p_this;
  95     access_sys_t *p_sys;
  96     char         *psz;
  97     vlc_value_t   val;
  98
  99     int          i_answer;
 100     char         *psz_arg;
 101
 102     /* Init p_access */
 103     p_access->pf_read = Read;
 104     p_access->pf_block = NULL;
 105     p_access->pf_seek = Seek;
 106     p_access->pf_control = Control;
 107     p_access->info.i_update = 0;
 108     p_access->info.i_size = 0;
 109     p_access->info.i_pos = 0;
 110     p_access->info.b_eof = VLC_FALSE;
 111     p_access->info.i_title = 0;
 112     p_access->info.i_seekpoint = 0;
 113     p_access->p_sys = p_sys = malloc( sizeof( access_sys_t ) );
 114     memset( p_sys, 0, sizeof( access_sys_t ) );
 115     p_sys->fd_cmd = -1;
 116     p_sys->fd_data = -1;
 117
 118     /* *** Parse URL and get server addr/port and path *** */
 119     psz = p_access->psz_path;
 120     while( *psz == '/' )
 121     {
 122         psz++;
 123     }
 124     vlc_UrlParse( &p_sys->url, psz, 0 );
 125
 126     if( p_sys->url.psz_host == NULL || *p_sys->url.psz_host == '\0' )
 127     {
 128         msg_Err( p_access, "invalid server name" );
 129         goto exit_error;
 130     }
 131     if( p_sys->url.i_port <= 0 )
 132     {
 133         p_sys->url.i_port = 21; /* default port */
 134     }
 135
 136     /* *** Open a TCP connection with server *** */
 137     msg_Dbg( p_access, "waiting for connection..." );
 138     p_sys->fd_cmd = net_OpenTCP( p_access, p_sys->url.psz_host,
 139                                  p_sys->url.i_port );
 140     if( p_sys->fd_cmd < 0 )
 141     {
 142         msg_Err( p_access, "failed to connect with server" );
 143         goto exit_error;
 144     }
 145
 146     for( ;; )
 147     {
 148         if( ftp_ReadCommand( p_access, &i_answer, NULL ) != 1 )
 149         {
 150             break;
 151         }
 152     }
 153     if( i_answer / 100 != 2 )
 154     {
 155         msg_Err( p_access, "connection rejected" );
 156         goto exit_error;
 157     }
 158
 159     msg_Dbg( p_access, "connection accepted (%d)", i_answer );
 160
 161     var_Create( p_access, "ftp-user", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 162     var_Get( p_access, "ftp-user", &val );
 163     if( ftp_SendCommand( p_access, "USER %s", val.psz_string ) < 0 ||
 164         ftp_ReadCommand( p_access, &i_answer, NULL ) < 0 )
 165     {
 166         if( val.psz_string ) free( val.psz_string );
 167         goto exit_error;
 168     }
 169     if( val.psz_string ) free( val.psz_string );
 170
 171     switch( i_answer / 100 )
 172     {
 173         case 2:
 174             msg_Dbg( p_access, "user accepted" );
 175             break;
 176         case 3:
 177             msg_Dbg( p_access, "password needed" );
 178             var_Create( p_access, "ftp-pwd", VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 179             var_Get( p_access, "ftp-pwd", &val );
 180             if( ftp_SendCommand( p_access, "PASS %s", val.psz_string ) < 0 ||
 181                 ftp_ReadCommand( p_access, &i_answer, NULL ) < 0 )
 182             {
 183                 if( val.psz_string ) free( val.psz_string );
 184                 goto exit_error;
 185             }
 186             if( val.psz_string ) free( val.psz_string );
 187
 188             switch( i_answer / 100 )
 189             {
 190                 case 2:
 191                     msg_Dbg( p_access, "password accepted" );
 192                     break;
 193                 case 3:
 194                     msg_Dbg( p_access, "account needed" );
 195                     var_Create( p_access, "ftp-account",
 196                                 VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 197                     var_Get( p_access, "ftp-account", &val );
 198                     if( ftp_SendCommand( p_access, "ACCT %s",
 199                                          val.psz_string ) < 0 ||
 200                         ftp_ReadCommand( p_access, &i_answer, NULL ) < 0 )
 201                     {
 202                         if( val.psz_string ) free( val.psz_string );
 203                         goto exit_error;
 204                     }
 205                     if( val.psz_string ) free( val.psz_string );
 206
 207                     if( i_answer / 100 != 2 )
 208                     {
 209                         msg_Err( p_access, "account rejected" );
 210                         goto exit_error;
 211                     }
 212                     msg_Dbg( p_access, "account accepted" );
 213                     break;
 214
 215                 default:
 216                     msg_Err( p_access, "password rejected" );
 217                     goto exit_error;
 218             }
 219             break;
 220         default:
 221             msg_Err( p_access, "user rejected" );
 222             goto exit_error;
 223     }
 224
 225     /* binary mode */
 226     if( ftp_SendCommand( p_access, "TYPE I" ) < 0 ||
 227         ftp_ReadCommand( p_access, &i_answer, NULL ) != 2 )
 228     {
 229         msg_Err( p_access, "cannot set binary transfert mode" );
 230         goto exit_error;
 231     }
 232
 233     /* get size */
 234     if( ftp_SendCommand( p_access, "SIZE %s", p_sys->url.psz_path ) < 0 ||
 235         ftp_ReadCommand( p_access, &i_answer, &psz_arg ) != 2 )
 236     {
 237         msg_Err( p_access, "cannot get file size" );
 238         goto exit_error;
 239     }
 240     p_access->info.i_size = atoll( &psz_arg[4] );
 241     free( psz_arg );
 242     msg_Dbg( p_access, "file size: "I64Fd, p_access->info.i_size );
 243
 244     /* Start the 'stream' */
 245     if( ftp_StartStream( p_access, 0 ) < 0 )
 246     {
 247         msg_Err( p_access, "cannot retrieve file" );
 248         goto exit_error;
 249     }
 250
 251     /* Update default_pts to a suitable value for ftp access */
 252     var_Create( p_access, "ftp-caching", VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 253
 254     return VLC_SUCCESS;
 255
 256 exit_error:
 257     if( p_sys->fd_cmd > 0 )
 258     {
 259         net_Close( p_sys->fd_cmd );
 260     }
 261     vlc_UrlClean( &p_sys->url );
 262     free( p_sys );
 263     return VLC_EGENERIC;
 264 }
 265
 266 /*****************************************************************************
 267  * Close: free unused data structures
 268  *****************************************************************************/
 269 static void Close( vlc_object_t *p_this )
 270 {
 271     access_t      *p_access = (access_t*)p_this;
 272     access_sys_t  *p_sys = p_access->p_sys;
 273
 274     msg_Dbg( p_access, "stopping stream" );
 275     ftp_StopStream( p_access );
 276
 277     if( ftp_SendCommand( p_access, "QUIT" ) < 0 )
 278     {
 279         msg_Warn( p_access, "cannot quit" );
 280     }
 281     else
 282     {
 283         ftp_ReadCommand( p_access, NULL, NULL );
 284     }
 285     net_Close( p_sys->fd_cmd );
 286
 287     /* free memory */
 288     vlc_UrlClean( &p_sys->url );
 289     free( p_sys );
 290 }
 291
 292 /*****************************************************************************
 293  * Seek: try to go at the right place
 294  *****************************************************************************/
 295 static int Seek( access_t *p_access, int64_t i_pos )
 296 {
 297     if( i_pos < 0 )
 298     {
 299         return VLC_EGENERIC;
 300     }
 301     msg_Dbg( p_access, "seeking to "I64Fd, i_pos );
 302
 303     ftp_StopStream( p_access );
 304     if( ftp_StartStream( p_access, i_pos ) < 0 )
 305     {
 306         p_access->info.b_eof = VLC_TRUE;
 307         return VLC_EGENERIC;
 308     }
 309
 310     p_access->info.b_eof = VLC_FALSE;
 311     p_access->info.i_pos = i_pos;
 312
 313     return VLC_SUCCESS;
 314 }
 315
 316 /*****************************************************************************
 317  * Read:
 318  *****************************************************************************/
 319 static int Read( access_t *p_access, uint8_t *p_buffer, int i_len )
 320 {
 321     access_sys_t *p_sys = p_access->p_sys;
 322     int i_read;
 323
 324     if( p_access->info.b_eof )
 325         return 0;
 326
 327     i_read = net_Read( p_access, p_sys->fd_data, p_buffer, i_len, VLC_FALSE );
 328     if( i_read == 0 )
 329         p_access->info.b_eof = VLC_TRUE;
 330     else if( i_read > 0 )
 331         p_access->info.i_pos += i_read;
 332
 333     return i_read;
 334 }
 335
 336 /*****************************************************************************
 337  * Control:
 338  *****************************************************************************/
 339 static int Control( access_t *p_access, int i_query, va_list args )
 340 {
 341     vlc_bool_t   *pb_bool;
 342     int          *pi_int;
 343     int64_t      *pi_64;
 344     vlc_value_t  val;
 345
 346     switch( i_query )
 347     {
 348         /* */
 349         case ACCESS_CAN_SEEK:
 350             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 351             *pb_bool = VLC_TRUE;
 352             break;
 353         case ACCESS_CAN_FASTSEEK:
 354             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 355             *pb_bool = VLC_FALSE;
 356             break;
 357         case ACCESS_CAN_PAUSE:
 358             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 359             *pb_bool = VLC_TRUE;    /* FIXME */
 360             break;
 361         case ACCESS_CAN_CONTROL_PACE:
 362             pb_bool = (vlc_bool_t*)va_arg( args, vlc_bool_t* );
 363             *pb_bool = VLC_TRUE;    /* FIXME */
 364             break;
 365
 366         /* */
 367         case ACCESS_GET_MTU:
 368             pi_int = (int*)va_arg( args, int * );
 369             *pi_int = 0;
 370             break;
 371
 372         case ACCESS_GET_PTS_DELAY:
 373             pi_64 = (int64_t*)va_arg( args, int64_t * );
 374             var_Get( p_access, "ftp-caching", &val );
 375             *pi_64 = val.i_int * 1000;
 376             break;
 377
 378         /* */
 379         case ACCESS_SET_PAUSE_STATE:
 380             /* Nothing to do */
 381             break;
 382
 383         case ACCESS_GET_TITLE_INFO:
 384         case ACCESS_SET_TITLE:
 385         case ACCESS_SET_SEEKPOINT:
 386             return VLC_EGENERIC;
 387
 388         default:
 389             msg_Err( p_access, "unimplemented query in control" );
 390             return VLC_EGENERIC;
 391
 392     }
 393     return VLC_SUCCESS;
 394 }
 395
 396 /*****************************************************************************
 397  * ftp_*:
 398  *****************************************************************************/
 399 static int ftp_SendCommand( access_t *p_access, char *psz_fmt, ... )
 400 {
 401     access_sys_t *p_sys = p_access->p_sys;
 402     va_list      args;
 403     char         *psz_cmd;
 404     int          i_ret;
 405
 406     va_start( args, psz_fmt );
 407     vasprintf( &psz_cmd, psz_fmt, args );
 408     va_end( args );
 409
 410     msg_Dbg( p_access, "ftp_SendCommand:\"%s\"", psz_cmd);
 411     if( ( i_ret = net_Printf( VLC_OBJECT(p_access), p_sys->fd_cmd,
 412                               "%s", psz_cmd ) ) > 0 )
 413     {
 414         i_ret = net_Printf( VLC_OBJECT(p_access), p_sys->fd_cmd, "\n" );
 415     }
 416
 417     if( i_ret < 0 )
 418     {
 419         msg_Err( p_access, "failed to send command" );
 420         return VLC_EGENERIC;
 421     }
 422     return VLC_SUCCESS;
 423 }
 424
 425 /* TODO support this s**t :
 426  RFC 959 allows the client to send certain TELNET strings at any moment,
 427  even in the middle of a request:
 428
 429  * \377\377.
 430  * \377\376x where x is one byte.
 431  * \377\375x where x is one byte. The server is obliged to send \377\374x
 432  *                                immediately after reading x.
 433  * \377\374x where x is one byte.
 434  * \377\373x where x is one byte. The server is obliged to send \377\376x
 435  *                                immediately after reading x.
 436  * \377x for any other byte x.
 437
 438  These strings are not part of the requests, except in the case \377\377,
 439  where the request contains one \377. */
 440 static int ftp_ReadCommand( access_t *p_access,
 441                             int *pi_answer, char **ppsz_answer )
 442 {
 443     access_sys_t *p_sys = p_access->p_sys;
 444     char         *psz_line;
 445     int          i_answer;
 446
 447     psz_line = net_Gets( p_access, p_sys->fd_cmd );
 448     msg_Dbg( p_access, "answer=%s", psz_line );
 449     if( psz_line == NULL || strlen( psz_line ) < 3 )
 450     {
 451         msg_Err( p_access, "cannot get answer" );
 452         if( psz_line ) free( psz_line );
 453         if( pi_answer ) *pi_answer    = 500;
 454         if( ppsz_answer ) *ppsz_answer  = NULL;
 455         return -1;
 456     }
 457
 458     i_answer = atoi( psz_line );
 459
 460     if( pi_answer ) *pi_answer = i_answer;
 461     if( ppsz_answer )
 462     {
 463         *ppsz_answer = psz_line;
 464     }
 465     else
 466     {
 467         free( psz_line );
 468     }
 469     return( i_answer / 100 );
 470 }
 471
 472 static int ftp_StartStream( access_t *p_access, off_t i_start )
 473 {
 474     access_sys_t *p_sys = p_access->p_sys;
 475
 476     char psz_ip[1000];
 477     int  i_answer;
 478     char *psz_arg, *psz_parser;
 479     int  a1,a2,a3,a4;
 480     int  p1,p2;
 481     int  i_port;
 482
 483     if( ftp_SendCommand( p_access, "PASV" ) < 0 ||
 484         ftp_ReadCommand( p_access, &i_answer, &psz_arg ) != 2 )
 485     {
 486         msg_Err( p_access, "cannot set passive transfert mode" );
 487         return VLC_EGENERIC;
 488     }
 489
 490     psz_parser = strchr( psz_arg, '(' );
 491     if( !psz_parser ||
 492         sscanf( psz_parser, "(%d,%d,%d,%d,%d,%d", &a1, &a2, &a3,
 493                 &a4, &p1, &p2 ) < 6 )
 494     {
 495         free( psz_arg );
 496         msg_Err( p_access, "cannot get ip/port for passive transfert mode" );
 497         return VLC_EGENERIC;
 498     }
 499     free( psz_arg );
 500
 501     sprintf( psz_ip, "%d.%d.%d.%d", a1, a2, a3, a4 );
 502     i_port = p1 * 256 + p2;
 503     msg_Dbg( p_access, "ip:%s port:%d", psz_ip, i_port );
 504
 505     if( ftp_SendCommand( p_access, "TYPE I" ) < 0 ||
 506         ftp_ReadCommand( p_access, &i_answer, NULL ) != 2 )
 507     {
 508         msg_Err( p_access, "cannot set binary transfert mode" );
 509         return VLC_EGENERIC;
 510     }
 511
 512     if( i_start > 0 )
 513     {
 514         if( ftp_SendCommand( p_access, "REST "I64Fu, i_start ) < 0 ||
 515             ftp_ReadCommand( p_access, &i_answer, NULL ) > 3 )
 516         {
 517             msg_Err( p_access, "cannot set restart point" );
 518             return VLC_EGENERIC;
 519         }
 520     }
 521
 522     msg_Dbg( p_access, "waiting for data connection..." );
 523     p_sys->fd_data = net_OpenTCP( p_access, psz_ip, i_port );
 524     if( p_sys->fd_data < 0 )
 525     {
 526         msg_Err( p_access, "failed to connect with server" );
 527         return VLC_EGENERIC;
 528     }
 529     msg_Dbg( p_access, "connection with \"%s:%d\" successful",
 530              psz_ip, i_port );
 531
 532     /* "1xx" message */
 533     if( ftp_SendCommand( p_access, "RETR %s", p_sys->url.psz_path ) < 0 ||
 534         ftp_ReadCommand( p_access, &i_answer, NULL ) > 2 )
 535     {
 536         msg_Err( p_access, "cannot retreive file" );
 537         return VLC_EGENERIC;
 538     }
 539     return VLC_SUCCESS;
 540 }
 541
 542 static int ftp_StopStream ( access_t *p_access )
 543 {
 544     access_sys_t *p_sys = p_access->p_sys;
 545
 546     int i_answer;
 547
 548     if( ftp_SendCommand( p_access, "ABOR" ) < 0 )
 549     {
 550         msg_Warn( p_access, "cannot abord file" );
 551         if(  p_sys->fd_data > 0 )
 552             net_Close( p_sys->fd_data );
 553         p_sys->fd_data = -1;
 554         return VLC_EGENERIC;
 555     }
 556     if(  p_sys->fd_data > 0 )
 557     {
 558         net_Close( p_sys->fd_data );
 559         p_sys->fd_data = -1;
 560         ftp_ReadCommand( p_access, &i_answer, NULL );
 561     }
 562     ftp_ReadCommand( p_access, &i_answer, NULL );
 563
 564     return VLC_SUCCESS;
 565 }
 566