path: root/ecos/packages/net/ftpclient/current/src/ftpclient.c

//==========================================================================
//
//      ftpclient.c
//
//      A simple FTP client
//
//==========================================================================
// ####ECOSGPLCOPYRIGHTBEGIN####                                            
// -------------------------------------------                              
// This file is part of eCos, the Embedded Configurable Operating System.   
// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2004 Free Software Foundation, Inc.
//
// eCos is free software; you can redistribute it and/or modify it under    
// the terms of the GNU General Public License as published by the Free     
// Software Foundation; either version 2 or (at your option) any later      
// version.                                                                 
//
// eCos is distributed in the hope that it will be useful, but WITHOUT      
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or    
// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License    
// for more details.                                                        
//
// You should have received a copy of the GNU General Public License        
// along with eCos; if not, write to the Free Software Foundation, Inc.,    
// 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.            
//
// As a special exception, if other files instantiate templates or use      
// macros or inline functions from this file, or you compile this file      
// and link it with other works to produce a work based on this file,       
// this file does not by itself cause the resulting work to be covered by   
// the GNU General Public License. However the source code for this file    
// must still be made available in accordance with section (3) of the GNU   
// General Public License v2.                                               
//
// This exception does not invalidate any other reasons why a work based    
// on this file might be covered by the GNU General Public License.         
// -------------------------------------------                              
// ####ECOSGPLCOPYRIGHTEND####                                              
//==========================================================================
//#####DESCRIPTIONBEGIN####
//
// Author(s):    andrew.lunn@ascom.ch
// Contributors: andrew.lunn@ascom.ch
// Date:         2001-11-4
// Purpose:      
// Description:  
//              
//####DESCRIPTIONEND####
//
//==========================================================================

#include <pkgconf/system.h>
#include <pkgconf/net_ftpclient.h>

#include <network.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <ctype.h>
#include "ftpclient.h"

/* Build one command to send to the FTP server */
static int 
build_cmd(char *buf,
          unsigned bufsize,
          char *cmd, 
          char *arg1)
{
  int cnt;
  
  if (arg1) {
    cnt = snprintf(buf,bufsize,"%s %s\r\n",cmd,arg1);
  } else {
    cnt = snprintf(buf,bufsize,"%s\r\n",cmd);
  }
  
  if (cnt < bufsize) 
    return 1;
  
  return 0;
}


/* Read one line from the server, being careful not to overrun the
   buffer. If we do reach the end of the buffer, discard the rest of
   the line. */
static int 
get_line(int s, char *buf, unsigned buf_size, ftp_printf_t ftp_printf) 
{
  int eol = 0;
  int cnt = 0;
  int ret;
  char c;
  
  while(!eol) {
    ret = read(s,&c,1);
    
    if (ret != 1) {
      ftp_printf(1,"read %s\n",strerror(errno));
      return FTP_BAD;
    }
    
    if (c == '\n') {
      eol = 1;
      continue;
    }

    if (cnt < buf_size) {
      buf[cnt++] = c;
    }   
  }
  if (cnt < buf_size) {
    buf[cnt++] = '\0';
  } else {
    buf[buf_size -1] = '\0';
  }
  return 0;
}  

/* Read the reply from the server and return the MSB from the return
   code. This gives us a basic idea if the command failed/worked. The
   reply can be spread over multiple lines. When this happens the line
   will start with a - to indicate there is more*/
static int 
get_reply(int s, ftp_printf_t ftp_printf) 
{
  char buf[BUFSIZ];
  int more = 0;
  int ret;
  int first_line=1;
  int code=0;
  
  do {
    
    if ((ret=get_line(s,buf,sizeof(buf),ftp_printf)) < 0) {
      return(ret);
    }
    
    ftp_printf(0,"FTP: %s\n",buf);
    
    if (first_line) {
      code = strtoul(buf,NULL,0);
      first_line=0;
      more = (buf[3] == '-');
    } else {
      if (isdigit(buf[0]) && isdigit(buf[1]) && isdigit(buf[2]) &&
          (code == strtoul(buf,NULL,0)) && 
          buf[3]==' ') {
        more=0;
      } else {
        more =1;
      }
    }
  } while (more);

  return (buf[0] - '0');
}

/* Send a command to the server */
static int 
send_cmd(int s, char * msgbuf, ftp_printf_t ftp_printf) 
{  
  int len;
  int slen = strlen(msgbuf);
  
  if ((len = write(s,msgbuf,slen)) != slen) {
    if (len < 0) {
      ftp_printf(1,"write %s\n",strerror(errno));
      return FTP_BAD;
    } else {
      ftp_printf(1,"write truncated!\n");
      return FTP_BAD;
    }
  }
  return 1;
}

/* Send a complete command to the server and receive the reply. Return the 
   MSB of the reply code. */
static int 
command(char * cmd, 
        char * arg, 
        int s, 
        char *msgbuf, 
        int msgbuflen,
        ftp_printf_t ftp_printf) 
{
  int err;
  
  if (!build_cmd(msgbuf,msgbuflen,cmd,arg)) {
    ftp_printf(1,"FTP: %s command to long\n",cmd);
    return FTP_BAD;
  }

  ftp_printf(0,"FTP: Sending %s command\n",cmd);
  
  if ((err=send_cmd(s,msgbuf,ftp_printf)) < 0) {
    return(err);
  }

  return (get_reply(s,ftp_printf));
}

/* Open a socket and connect it to the server. Also print out the
   address of the server for debug purposes.*/

static int
connect_to_server(char *hostname, 
                  struct sockaddr * local,
                  ftp_printf_t ftp_printf) 
{ 
  int s;
  socklen_t len;
  int error;
  struct addrinfo *res, *nai;
  char name[80];
  char port[8];

  error = getaddrinfo(hostname, "ftp", NULL, &res);
  if (error != EAI_NONE) {
    return FTP_NOSUCHHOST;
  }

  nai=res;
  while (nai) {
    s = socket(nai->ai_family, nai->ai_socktype,nai->ai_protocol);
    if (s < 0) {
      nai = nai->ai_next;
      continue;
    }
    
    if (connect(s, nai->ai_addr, nai->ai_addrlen) < 0) {
      getnameinfo(nai->ai_addr, nai->ai_addrlen, 
                  name, sizeof(name), NULL,0, NI_NUMERICHOST);
      ftp_printf(1,"FTP Connect to %s failed: %s\n",name, strerror(errno));
      close (s);
      nai = nai->ai_next;
      continue;
    }
    
    len = sizeof(struct sockaddr);
    if (getsockname(s, (struct sockaddr *)local, &len) < 0) {
      ftp_printf(1,"getsockname failed %s\n",strerror(errno));
      close(s);
      nai = nai->ai_next;
      continue;
    }
    getnameinfo(nai->ai_addr, nai->ai_addrlen, 
                name, sizeof(name), port, sizeof(port), 
                NI_NUMERICHOST|NI_NUMERICSERV);
    
    ftp_printf(0,"FTP: Connected to %s:%s\n", name, port);
    freeaddrinfo(res);
    return (s);
  }
  freeaddrinfo(res);
  return FTP_NOSUCHHOST;
}

/* Perform a login to the server. Pass the username and password and
   put the connection into binary mode. This assumes a passwd is
   always needed. Is this true? */

static int 
login(char * username, 
      char *passwd, 
      int s, 
      char *msgbuf, 
      unsigned msgbuflen,
      ftp_printf_t ftp_printf) {
  
  int ret;

  ret = command("USER",username,s,msgbuf,msgbuflen,ftp_printf);
  if (ret != 3) {
    ftp_printf(1,"FTP: User %s not accepted\n",username);
    return (FTP_BADUSER);
  }
  
  ret = command("PASS",passwd,s,msgbuf,msgbuflen,ftp_printf);
  if (ret < 0) {
    return (ret);
  }
  if (ret != 2) {
    ftp_printf(1,"FTP: Login failed for User %s\n",username);
    return (FTP_BADUSER);
  }
  
  ftp_printf(0,"FTP: Login sucessfull\n");
  
  ret = command("TYPE","I",s,msgbuf,msgbuflen,ftp_printf);
  if (ret < 0) {
    return (ret);
  }
  if (ret != 2) {
    ftp_printf(1,"FTP: TYPE failed!\n");
    return (FTP_BAD);
  }
  return (ret);
}


/* Open a data socket. This is a client socket, i.e. its listening
waiting for the FTP server to connect to it. Once the socket has been
opened send the port command to the server so the server knows which
port we are listening on.*/
static int 
opendatasock(int ctrl_s,
             struct sockaddr *ctrl, 
             char *msgbuf, 
             unsigned msgbuflen,
             ftp_printf_t ftp_printf) 
{
    struct sockaddr local;
    char name[64];
    char port[10];
    socklen_t len;
    int on = 1;
    char buf[80];
    int ret;
    int s;

    s = socket(ctrl->sa_family, SOCK_STREAM, 0);
    if (s < 0) {
        ftp_printf(1,"socket: %s\n",strerror(errno));
        return FTP_BAD;
    }
  
    if (setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (char *)&on, sizeof (on)) < 0) {
        ftp_printf(1,"setsockopt: %s\n",strerror(errno));
        close(s);
        return FTP_BAD;
    }
  
    memcpy(&local,ctrl,sizeof(struct sockaddr));
    switch (ctrl->sa_family) {
    case AF_INET: {
        struct sockaddr_in * sa4 = (struct sockaddr_in *) &local;
        sa4->sin_port = 0;
        break;
    }
#ifdef CYGPKG_NET_INET6
    case AF_INET6: {
        struct sockaddr_in6 * sa6 = (struct sockaddr_in6 *) &local;
        sa6->sin6_port = 0;
        break;
    }
#endif
    default:
        close (s);
        return FTP_BAD;
    }

    if (bind(s,&local,local.sa_len) < 0) {
        ftp_printf(1,"bind: %s\n",strerror(errno));
        close(s);
        return FTP_BAD;   
    }
  
    len = sizeof(local);
    if (getsockname(s,&local,&len) < 0) {
        ftp_printf(1,"getsockname: %s\n",strerror(errno));
        close(s);
        return FTP_BAD;   
    }
  
    if (listen(s, 1) < 0) {
        ftp_printf(1,"listen: %s\n",strerror(errno));
        close(s);
        return FTP_BAD;   
    }
  
    getnameinfo(&local, sizeof(local), name, sizeof(name), port, sizeof(port),
                NI_NUMERICHOST|NI_NUMERICSERV);
    switch (local.sa_family) {
    case AF_INET: {
        snprintf(buf, sizeof(buf), "|1|%s|%s|", name, port);
        break;
    }
#ifdef CYGPKG_NET_INET6
    case AF_INET6: {
        snprintf(buf, sizeof(buf), "|2|%s|%s|", name, port);
        break;
    }
#endif
    default:
        close (s);
        return (FTP_BAD);
    }

    ret = command("EPRT",buf,ctrl_s,msgbuf,msgbuflen,ftp_printf);
    if (ret < 0) {
        close(s);
        return (ret);
    }

    if (ret != 2) {
        int _port = atoi(port);
        char *str = name;
        while (*str) {
            if (*str == '.') *str = ',';
            str++;
        }
        snprintf(buf, sizeof(buf), "%s,%d,%d", name, _port/256, _port%256);
        ret = command("PORT",buf,ctrl_s,msgbuf,msgbuflen,ftp_printf);
        if (ret < 0) {
            close(s);
            return (ret);
        }
        if (ret != 2) {
            ftp_printf(1,"FTP: PORT failed!\n");
            close(s);
            return (FTP_BAD);
        }
    }
    return (s);
}

/* Receive the file into the buffer and close the data socket
   afterwards */
static int 
receive_file(int data_s, ftp_write_t ftp_write, void *ftp_write_priv, ftp_printf_t ftp_printf)
{
    char *buf;
    int finished = 0;
    int total_size=0;
    int len, wlen;
    int s;

    if ((buf = (char *)malloc(CYGNUM_NET_FTPCLIENT_BUFSIZE)) == (char *)0) {
        return FTP_NOMEMORY;
    }
    s = accept(data_s, NULL, 0);
    if (s < 0) {
        ftp_printf(1, "listen: %s\n",strerror(errno));
        free(buf);
        return FTP_BAD;   
    }
  
    do {
        len = read(s, buf, CYGNUM_NET_FTPCLIENT_BUFSIZE);
        if (len < 0) {
            ftp_printf(1, "read: %s\n",strerror(errno));
            close(s);
            free(buf);
            return FTP_BAD;   
        }

        if (len == 0) {
            finished = 1;
        } else {
            wlen = (*ftp_write)(buf, len, ftp_write_priv);
            if (wlen != len) {
                ftp_printf(1, "FTP: File too big!\n");
                close(s);
                free(buf);
                return FTP_TOOBIG;
            }
            total_size += len;
        }
    } while (!finished);
  
    close(s);
    free(buf);
    return total_size;
}

/* Receive the file into the buffer and close the socket afterwards*/
static int 
send_file(int data_s, ftp_read_t ftp_read, void *ftp_read_priv, ftp_printf_t ftp_printf)
{
    char *buf;
    int len, rlen;
    int s;
  
    if ((buf = (char *)malloc(CYGNUM_NET_FTPCLIENT_BUFSIZE)) == (char *)0) {
        return FTP_NOMEMORY;
    }
    s = accept(data_s,NULL,0);
    if (s<0) {
        ftp_printf(1,"listen: %s\n",strerror(errno));
        free(buf);
        return FTP_BAD;   
    }
  
    do { 
        rlen = (*ftp_read)(buf, CYGNUM_NET_FTPCLIENT_BUFSIZE, ftp_read_priv);
        if (rlen > 0) {
            len = write(s, buf, rlen);
            if (len < 0) {
                ftp_printf(1,"write: %s\n",strerror(errno));
                close(s);
                free(buf);
                return FTP_BAD;   
            }
        }
    } while (rlen > 0);
  
    close(s);
    free(buf);
    return 0;
}

/* All done, say bye, bye */
static int quit(int s, 
                char *msgbuf, 
                unsigned msgbuflen,
                ftp_printf_t ftp_printf) {
  
  int ret;
  
  ret = command("QUIT",NULL,s,msgbuf,msgbuflen,ftp_printf);
  if (ret < 0) {
    return (ret);
  }
  if (ret != 2) {
    ftp_printf(1,"FTP: Quit failed!\n");
    return (FTP_BAD);
  }
  
  ftp_printf(0,"FTP: Connection closed\n");
  return (0);
}

/* Get a file from an FTP server. Hostname is the name/IP address of
   the server. username is the username used to connect to the server
   with. Passwd is the password used to authentificate the
   username. filename is the name of the file to receive. It should be
   the full pathname of the file. buf is a pointer to a buffer the
   contents of the file should be placed in and buf_size is the size
   of the buffer. If the file is bigger than the buffer, buf_size
   bytes will be retrieved and an error code returned. ftp_printf is a
   function to be called to perform printing. On success the number of
   bytes received is returned. On error a negative value is returned
   indicating the type of error. */

struct _ftp_data{
    char *buf;
    int   len;
    int   max_len;
};

static int _ftp_read(char *buf, int len, void *priv)
{
    struct _ftp_data *dp = (struct _ftp_data *)priv;
    int res = 0;

    // FTP data channel desires to write 'len' bytes.  Fetch up
    // to that amount into 'buf'
    if (dp->len > 0) {
        res = dp->len;
        if (res > len) res = len;
        memcpy(buf, dp->buf, res);
        dp->buf += len;
        dp->len -= res;
    }
    return res;
}

static int _ftp_write(char *buf, int len, void *priv)
{
    struct _ftp_data *dp = (struct _ftp_data *)priv;
    int res = 0;

    // FTP data channel has 'len' bytes that have been read.
    // Move into 'buf', respecting the max size of 'buf'
    if (dp->len < dp->max_len) {
        res = dp->max_len - dp->len;
        if (res > len) {
            res = len;
        }
        memcpy(dp->buf, buf, res);
        dp->buf += len;
        dp->len += res;
    }
    return res;
}

int ftp_get(char * hostname, 
            char * username, 
            char * passwd, 
            char * filename, 
            char * buf, 
            unsigned buf_size,
            ftp_printf_t ftp_printf)
{
    struct _ftp_data ftp_data;

    ftp_data.buf = buf;
    ftp_data.len = 0;
    ftp_data.max_len = buf_size;
    return ftp_get_var(hostname, username, passwd, filename, _ftp_write, &ftp_data, ftp_printf);
}

int ftp_get_var(char *hostname,
                char *username,
                char *passwd,
                char *filename,
                ftp_write_t ftp_write,
                void *ftp_write_priv,
                ftp_printf_t ftp_printf)
{

  struct sockaddr local;
  char msgbuf[256];
  int s,data_s;
  int bytes;
  int ret;
  
  s = connect_to_server(hostname,&local,ftp_printf);
  if (s < 0) {
    return (s);
  }
  
  /* Read the welcome message from the server */
  if (get_reply(s,ftp_printf) != 2) {
    ftp_printf(0,"FTP: Server refused connection\n");
    close(s);
    return FTP_BAD;
  }

  ret = login(username,passwd,s,msgbuf,sizeof(msgbuf),ftp_printf);
  if (ret < 0) {
    close(s);
    return (ret);
  }

  /* We are now logged in and ready to transfer the file. Open the
     data socket ready to receive the file. It also build the PORT
     command ready to send */
  data_s = opendatasock(s,&local,msgbuf,sizeof(msgbuf),ftp_printf);
  if (data_s < 0) {
    close (s);
    return (data_s);
  }

  /* Ask for the file */
  ret = command("RETR",filename,s,msgbuf,sizeof(msgbuf),ftp_printf);
  if (ret < 0) {
    close(s);
    close(data_s);
    return (ret);
  }
  
  if (ret != 1) {
    ftp_printf(0,"FTP: RETR failed!\n");
    close (data_s);
    close(s);
    return (FTP_BADFILENAME);
  }
  
  if ((bytes=receive_file(data_s,ftp_write,ftp_write_priv,ftp_printf)) < 0) {
    ftp_printf(0,"FTP: Receiving file failed\n");
    close (data_s);
    close(s);
    return (bytes);
  }
  
  if (get_reply(s,ftp_printf) != 2) {
    ftp_printf(0,"FTP: Transfer failed!\n");
    close (data_s);
    close(s);
    return (FTP_BAD);
  }

  ret = quit(s,msgbuf,sizeof(msgbuf),ftp_printf);
  if (ret < 0) {
    close(s);
    close(data_s);
    return (ret);
  }
            
  close (data_s);
  close(s);
  return bytes;
}
  
/* Put a file on an FTP server. Hostname is the name/IP address of the
   server. username is the username used to connect to the server
   with. Passwd is the password used to authentificate the
   username. filename is the name of the file to receive. It should be
   the full pathname of the file. buf is a pointer to a buffer the
   contents of the file should be placed in and buf_size is the size
   of the buffer. ftp_printf is a function to be called to perform
   printing. On success 0 is returned. On error a negative value is
   returned indicating the type of error. */

int ftp_put(char * hostname, 
            char * username, 
            char * passwd, 
            char * filename, 
            char * buf, 
            unsigned buf_size,
            ftp_printf_t ftp_printf)
{
    struct _ftp_data ftp_data;

    ftp_data.buf = buf;
    ftp_data.len = buf_size;
    return ftp_put_var(hostname, username, passwd, filename, _ftp_read, &ftp_data, ftp_printf);
}

int ftp_put_var(char *hostname,
                char *username,
                char *passwd,
                char *filename,
                ftp_read_t ftp_read,
                void *ftp_read_priv,
                ftp_printf_t ftp_printf)
{

  struct sockaddr local;
  char msgbuf[256];
  int s,data_s;
  int ret;
  
  s = connect_to_server(hostname,&local,ftp_printf);
  if (s < 0) {
    return (s);
  }
  
  /* Read the welcome message from the server */
  if (get_reply(s,ftp_printf) != 2) {
    ftp_printf(1,"FTP: Server refused connection\n");
    close(s);
    return FTP_BAD;
  }

  ret = login(username,passwd,s,msgbuf,sizeof(msgbuf),ftp_printf);
  if (ret < 0) {
    close(s);
    return (ret);
  }

  /* We are now logged in and ready to transfer the file. Open the
     data socket ready to receive the file. It also build the PORT
     command ready to send */
  data_s = opendatasock(s,&local,msgbuf,sizeof(msgbuf),ftp_printf);
  if (data_s < 0) {
    close (s);
    return (data_s);
  }

  /* Ask for the file */
  ret = command("STOR",filename,s,msgbuf,sizeof(msgbuf),ftp_printf);
  if (ret < 0) {
    close(s);
    close(data_s);
    return (ret);
  }
  
  if (ret != 1) {
    ftp_printf(1,"FTP: STOR failed!\n");
    close (data_s);
    close(s);
    return (FTP_BADFILENAME);
  }
  
  if ((ret = send_file(data_s,ftp_read,ftp_read_priv,ftp_printf)) < 0) {
    ftp_printf(1,"FTP: Sending file failed\n");
    close (data_s);
    close(s);
    return (ret);
  }
  
  if (get_reply(s,ftp_printf) != 2) {
    ftp_printf(1,"FTP: Transfer failed!\n");
    close (data_s);
    close(s);
    return (FTP_BAD);
  }

  ret = quit(s,msgbuf,sizeof(msgbuf),ftp_printf);
  if (ret < 0) {
    close(s);
    close(data_s);
    return (ret);
  }
            
  close (data_s);
  close(s);
  return 0;
}

/* An example ftp_printf function. This uses the standard eCos diag
output device for outputting error and diagnostic messages. The
function take one addition parameter to the normal printf function. The
first parameter indicates when the message is an error message when
true. This can be used to filter errors from diagnostic output. In
this example the error parameter is ignored and everything printed. */

void ftpclient_printf(unsigned error, const char *fmt, ...) 
{
  va_list ap;
  
  va_start(ap, fmt);
  diag_vprintf( fmt, ap);
  va_end(ap);
}