ftplib.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	FTP_CON

Macros
#define	EXPRT
#define	FTP_MAX_ANSWERS   10 /* Number of known goodest answers for reqest */
#define	FTP_QUIT   0
#define	FTP_Ctrl(x)   ((x) - '@')
#define	FTP_FREE(x)   memset ( &x , '\0' , sizeof x )
#define	FTP_CUT(x)   ((x)&0xff)
#define	ftp_account(ftp, acc)   ftp_command(ftp,"ACCT %s",acc,230,EOF)
#define	ftp_user(ftp, user)   ftp_command(ftp,"USER %s",user,230,331,332,EOF)
#define	ftp_password(ftp, pas)   ftp_command(ftp,"PASS %s",pas,230,332,EOF)
#define	ftp_type(ftp, type)   ftp_command(ftp,"TYPE %s",type,200,EOF)
#define	ftp_chdir(ftp, dir)   ftp_command(ftp,"CWD %s",dir,200,250,EOF)
#define	ftp_mkdir(ftp, dir)   ftp_command(ftp,"XMKD %s",dir,200,257,EOF)
#define	ftp_rm(ftp, dir)   ftp_command(ftp,"DELE %s",dir,200,250,EOF)
#define	ftp_ascii(ftp)   ftp_type(ftp,"A")
#define	ftp_binary(ftp)   ftp_type(ftp,"I")
#define	ftp_open_read(ftp, file)   ftp_data(ftp,"RETR %s",file)
#define	ftp_open_write(ftp, file)   ftp_data(ftp,"STOR %s",file)
#define	ftp_open_append(ftp, file)   ftp_data(ftp,"APPE %s",file)

Functions
int EXPRT	ftp_bye (FTP_CON *con)
int EXPRT	ftp_close (FTP_CON *con)
int EXPRT	ftp_connect (FTP_CON **con, const char *host_name, unsigned short port)
int EXPRT	ftp_login (FTP_CON **con, const char *host, unsigned short port, const char *user, const char *pass, const char *acct)
int EXPRT	ftp_move (FTP_CON *con, const char *old_name, const char *new_name)
int EXPRT	ftp_data (FTP_CON *con, const char *command, const char *param)
int EXPRT	ftp_port (FTP_CON *con, int, int, int, int, int, int)
int EXPRT	ftp_get (FTP_CON *con, const char *local_name, const char *remote_name)
int EXPRT	ftp_put (FTP_CON *con, const char *local_name, const char *remote_name)
int EXPRT	ftp_send (int sock, const char *buffer, int n_bytes)
int EXPRT	ftp_receive (int sock, char *buffer, int bsize)
int EXPRT	ftp_send_message (FTP_CON *con, const char *message)
int EXPRT	ftp_get_message (FTP_CON *con, char *message)
BOOL EXPRT	ftp_good (int number,...)
int EXPRT	ftp_command (FTP_CON *con, const char *command, const char *param,...)
int EXPRT	ftp_dir (FTP_CON *con, const char *file)
char EXPRT *	ftp_pwd (FTP_CON *con)
void EXPRT	ftp_debug (int(*debug_func)(const char *message), int(*error_func)(const char *message))

Macro Definition Documentation

EXPRT

#define EXPRT

Definition at line 16 of file ftplib.h.

ftp_account

#define ftp_account	(		ftp,
			acc
	)		ftp_command(ftp,"ACCT %s",acc,230,EOF)

Definition at line 31 of file ftplib.h.

ftp_ascii

#define ftp_ascii

(

ftp

)

ftp_type(ftp,"A")

Definition at line 38 of file ftplib.h.

ftp_binary

#define ftp_binary

(

ftp

)

ftp_type(ftp,"I")

Definition at line 39 of file ftplib.h.

ftp_chdir

#define ftp_chdir	(		ftp,
			dir
	)		ftp_command(ftp,"CWD %s",dir,200,250,EOF)

Definition at line 35 of file ftplib.h.

FTP_Ctrl

#define FTP_Ctrl

(

x

)

((x) - '@')

Definition at line 21 of file ftplib.h.

FTP_CUT

#define FTP_CUT

(

x

)

((x)&0xff)

Definition at line 23 of file ftplib.h.

FTP_FREE

#define FTP_FREE

(

x

)

memset ( &x , '\0' , sizeof x )

Definition at line 22 of file ftplib.h.

FTP_MAX_ANSWERS

#define FTP_MAX_ANSWERS   10 /* Number of known goodest answers for reqest */

Definition at line 19 of file ftplib.h.

ftp_mkdir

#define ftp_mkdir	(		ftp,
			dir
	)		ftp_command(ftp,"XMKD %s",dir,200,257,EOF)

Definition at line 36 of file ftplib.h.

ftp_open_append

#define ftp_open_append	(		ftp,
			file
	)		ftp_data(ftp,"APPE %s",file)

Definition at line 42 of file ftplib.h.

ftp_open_read

#define ftp_open_read	(		ftp,
			file
	)		ftp_data(ftp,"RETR %s",file)

Definition at line 40 of file ftplib.h.

ftp_open_write

#define ftp_open_write	(		ftp,
			file
	)		ftp_data(ftp,"STOR %s",file)

Definition at line 41 of file ftplib.h.

ftp_password

#define ftp_password	(		ftp,
			pas
	)		ftp_command(ftp,"PASS %s",pas,230,332,EOF)

Definition at line 33 of file ftplib.h.

FTP_QUIT

#define FTP_QUIT   0

Definition at line 20 of file ftplib.h.

ftp_rm

#define ftp_rm	(		ftp,
			dir
	)		ftp_command(ftp,"DELE %s",dir,200,250,EOF)

Definition at line 37 of file ftplib.h.

ftp_type

#define ftp_type	(		ftp,
			type
	)		ftp_command(ftp,"TYPE %s",type,200,EOF)

Definition at line 34 of file ftplib.h.

ftp_user

#define ftp_user	(		ftp,
			user
	)		ftp_command(ftp,"USER %s",user,230,331,332,EOF)

Definition at line 32 of file ftplib.h.

Function Documentation

ftp_bye()

int EXPRT ftp_bye

(

FTP_CON *

con

)

Definition at line 484 of file ftplib.cxx.

{
   char str[256];
 
   ftp_send_message(con, "QUIT");
   ftp_get_message(con, str);
 
   closesocket(con->sock);
   free(con);
 
   return FTP_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ftp_close()

int EXPRT ftp_close

(

FTP_CON *

con

)

Definition at line 385 of file ftplib.cxx.

{
   char str[256];
 
   closesocket(con->data);
 
   return ftp_get_message(con, str);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ftp_command()

int EXPRT ftp_command	(	FTP_CON *	con,
		const char *	command,
		const char *	param,
			...
	)

Definition at line 177 of file ftplib.cxx.

{
   va_list args;
   char str[256];
   int status, code;
   BOOL result_ok;
 
   /* compose command string */
   sprintf(str, command, param);
 
   /* send command */
   if (ftp_send_message(con, str) != FTP_SUCCESS)
      return FTP_NET_ERROR;
 
   /* read reply */
   status = ftp_get_message(con, str);
   if (status == FTP_QUIT)
      return FTP_NET_ERROR;
 
   /* check reply code */
   va_start(args, param);
 
   result_ok = FALSE;
   do {
      code = va_arg(args, int);
      if (code == EOF)
         break;
 
      if (code == status)
         result_ok = TRUE;
 
   } while (!result_ok);
 
   va_end(args);
 
   if (!result_ok) {
      if (ftp_error_func != NULL)
         ftp_error_func(str);
 
      return FTP_RESPONSE_ERROR;
   }
 
   return -status;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ftp_connect()

int EXPRT ftp_connect	(	FTP_CON **	con,
		const char *	host_name,
		unsigned short	port
	)

Definition at line 51 of file ftplib.cxx.

{
   ftp_socket_t sock = FTP_INVALID_SOCKET;
   char str[4000];
   int status;
 
   *con = NULL;
 
#ifdef OS_WINNT
   {
      WSADATA WSAData;
 
      /* Start windows sockets */
      if (WSAStartup(MAKEWORD(1, 1), &WSAData) != 0)
         return FTP_NET_ERROR;
   }
#endif
 
   /* connect to remote node */
#ifdef OS_VXWORKS
   {
      struct sockaddr_in bind_addr;
      INT host_addr;
 
      if ((sock = socket(AF_INET, SOCK_STREAM, 0)) == FTP_INVALID_SOCKET) {
         if (ftp_error_func)
            ftp_error_func("cannot create socket");
         return FTP_NET_ERROR;
      }
 
      memset(&bind_addr, 0, sizeof(bind_addr));
      bind_addr.sin_family = AF_INET;
      bind_addr.sin_port = htons(port);
      host_addr = hostGetByName(host_name);
      memcpy((char *) &(bind_addr.sin_addr), &host_addr, 4);
 
      status = connect(sock, (struct sockaddr *) &bind_addr, sizeof(bind_addr));
   }
#else
   struct addrinfo hints;
   struct addrinfo *addresses = NULL;
   char service[16];
 
   memset(&hints, 0, sizeof(hints));
   hints.ai_family = AF_UNSPEC;
   hints.ai_socktype = SOCK_STREAM;
   hints.ai_protocol = IPPROTO_TCP;
   snprintf(service, sizeof(service), "%u", port);
 
   status = getaddrinfo(host_name, service, &hints, &addresses);
   if (status != 0) {
      if (ftp_error_func)
         ftp_error_func("cannot get host name");
      return RPC_NET_ERROR;
   }
 
   status = -1;
   for (struct addrinfo *address = addresses; address != NULL; address = address->ai_next) {
      sock = socket(address->ai_family, address->ai_socktype, address->ai_protocol);
      if (sock == FTP_INVALID_SOCKET)
         continue;
 
#ifdef OS_UNIX
      do {
         status = connect(sock, address->ai_addr, address->ai_addrlen);
      } while (status == -1 && errno == EINTR);
#else
      status = connect(sock, address->ai_addr, address->ai_addrlen);
#endif
 
      if (status == 0)
         break;
 
      closesocket(sock);
      sock = FTP_INVALID_SOCKET;
   }
 
   freeaddrinfo(addresses);
#endif
 
   if (status != 0) {
      sprintf(str, "cannot connect to host %s, port %d", host_name, port);
      if (ftp_error_func)
         ftp_error_func(str);
      return FTP_NET_ERROR;
   }
 
 
   *con = (FTP_CON *) malloc(sizeof(FTP_CON));
   (*con)->sock = (int) sock;
   (*con)->data = 0;
 
   memset(str, 0, sizeof(str));
   status = ftp_get_message(*con, str);
 
   /* check for status */
   if (status == FTP_QUIT || !ftp_good(status, 120, 220, EOF)) {
      closesocket(sock);
      free(*con);
      return FTP_NET_ERROR;
   }
 
   return FTP_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ftp_data()

int EXPRT ftp_data	(	FTP_CON *	con,
		const char *	command,
		const char *	param
	)

Definition at line 281 of file ftplib.cxx.

{
   struct sockaddr_in data, from;
   char host_name[256];
   ftp_socket_t listen_socket, data_socket;
   unsigned int len = sizeof(data), fromlen = sizeof(from);
   int one = 1, status;
   char *a, *b;
 
   memset(&data, 0, sizeof(data));
   memset(&from, 0, sizeof(from));
 
   if (gethostname(host_name, sizeof(host_name)) == -1)
      return FTP_NET_ERROR;
 
#ifdef OS_VXWORKS
   {
      INT host_addr = hostGetByName(host_name);
      memcpy(&data.sin_addr, &host_addr, sizeof(data.sin_addr));
   }
#else
   struct addrinfo hints;
   struct addrinfo *addresses = NULL;
 
   memset(&hints, 0, sizeof(hints));
   hints.ai_family = AF_INET;
   hints.ai_socktype = SOCK_STREAM;
   hints.ai_protocol = IPPROTO_TCP;
 
   status = getaddrinfo(host_name, NULL, &hints, &addresses);
   if (status != 0 || addresses == NULL) {
      if (addresses != NULL)
         freeaddrinfo(addresses);
      return FTP_NET_ERROR;
   }
 
   data.sin_addr = ((const struct sockaddr_in *) addresses->ai_addr)->sin_addr;
   freeaddrinfo(addresses);
#endif
 
   if ((listen_socket = socket(AF_INET, SOCK_STREAM, 0)) == FTP_INVALID_SOCKET)
      return FTP_NET_ERROR;
 
   if (setsockopt(listen_socket, SOL_SOCKET, SO_REUSEADDR,
                  (char *) &one, sizeof(one)) < 0) {
      closesocket(listen_socket);
      return FTP_NET_ERROR;
   }
 
   data.sin_family = AF_INET;
   data.sin_port = htons(0);
 
   if (bind(listen_socket, (struct sockaddr *) &data, sizeof(data)) == -1) {
      closesocket(listen_socket);
      return FTP_NET_ERROR;
   }
 
#ifdef OS_WINNT
   if (getsockname(listen_socket, (struct sockaddr *) &data, (int *)&len) < 0) {
#else
   if (getsockname(listen_socket, (struct sockaddr *) &data, &len) < 0) {
#endif
      closesocket(listen_socket);
      return FTP_NET_ERROR;
   }
 
   if (listen(listen_socket, 1) != 0) {
      closesocket(listen_socket);
      return FTP_NET_ERROR;
   }
 
   a = (char *) &data.sin_addr;
   b = (char *) &data.sin_port;
 
   status = ftp_port(con, FTP_CUT(a[0]), FTP_CUT(a[1]), FTP_CUT(a[2]),
                     FTP_CUT(a[3]), FTP_CUT(b[0]), FTP_CUT(b[1]));
   if (status != FTP_SUCCESS)
      return FTP_NET_ERROR;
 
   status = ftp_command(con, command, file, 200, 120, 150, 125, 250, EOF);
   if (status >= 0)
      return status;
 
#ifdef OS_WINNT
   data_socket = accept(listen_socket, (struct sockaddr *) &from, (int *)&fromlen);
#else
   data_socket = accept(listen_socket, (struct sockaddr *) &from, &fromlen);
#endif
 
   if (data_socket == FTP_INVALID_SOCKET) {
      closesocket(listen_socket);
      return FTP_NET_ERROR;
   }
 
   closesocket(listen_socket);
 
   con->data = (int) data_socket;
 
   return status;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ftp_debug()

void EXPRT ftp_debug	(	int(*)(const char *message)	debug_func,
		int(*)(const char *message)	error_func
	)

Definition at line 42 of file ftplib.cxx.

{
   ftp_debug_func = debug_func;
   ftp_error_func = error_func;
}

Here is the caller graph for this function:

ftp_dir()

int EXPRT ftp_dir	(	FTP_CON *	con,
		const char *	file
	)

Definition at line 649 of file ftplib.cxx.

{
   char command[256], buffer[8192];
 
   if (file == NULL || *file == '\0')
      strcpy(command, "LIST");
   else
      sprintf(command, "LIST %s", file);
 
   if (ftp_data(con, command, "") >= 0)
      return con->err_no;
 
   while (ftp_receive(con->data, buffer, sizeof(buffer)))
      printf("%s", buffer);
 
   return ftp_close(con);
}

Here is the call graph for this function:

ftp_get()

int EXPRT ftp_get	(	FTP_CON *	con,
		const char *	local_name,
		const char *	remote_name
	)

Definition at line 537 of file ftplib.cxx.

{
   int fh;
   int status;
   char buff[8192];
   char str[256];
   int count, i;
   long total = 0;
   DWORD start, stop;
 
   if (ftp_open_read(con, remote_name) >= 0)
      return con->err_no;
 
   if ((fh = open(local_name, O_RDWR | O_CREAT | O_TRUNC | O_BINARY, 0644)) == -1)
      return FTP_FILE_ERROR;
 
   start = ss_millitime();
 
   while ((count = ftp_receive(con->data, buff, sizeof(buff))) > 0) {
      total += write(fh, buff, count);
      i = 0;
      if (ftp_debug_func != NULL) {
         printf("%c\r", bars[(i++) % 4]);
         fflush(stdout);
      }
   }
 
   close(fh);
   stop = ss_millitime();
 
   status = ftp_close(con);
   if (ftp_debug_func != NULL) {
      sprintf(str, "%ld bytes received in %1.2f seconds (%1.2lf kB/sec).",
              total, (stop - start) / 1000.0, total / 1024.0 / ((stop - start) / 1000.0));
      ftp_debug_func(str);
   }
 
   return status;
}

Here is the call graph for this function:

ftp_get_message()

int EXPRT ftp_get_message	(	FTP_CON *	con,
		char *	message
	)

Definition at line 225 of file ftplib.cxx.

{
   int i;
 
   for (i = 0;; i++) {
      if (recv(con->sock, &message[i], 1, 0) != 1)
         return FTP_QUIT;
 
      if (i > 1 && message[i] == 10 && message[i - 1] == 13)
         break;
   }
 
   message[i - 1] = 0;
 
   con->err_no = atoi(message);
 
   if (ftp_debug_func != NULL)
      ftp_debug_func(message);
 
   /* check for continuation message */
   if (message[3] == '-')
      ftp_get_message(con, message + strlen(message));
 
   return con->err_no;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ftp_good()

BOOL EXPRT ftp_good	(	int	number,
			...
	)

Definition at line 254 of file ftplib.cxx.

{
   va_list args;
   BOOL result;
   int code;
 
   va_start(args, number);
   result = FALSE;
 
   do {
      code = va_arg(args, int);
      if (code == EOF)
         break;
 
      if (code == number)
         result = TRUE;
 
   } while (!result);
 
   va_end(args);
 
   return result;
}

Here is the caller graph for this function:

ftp_login()

int EXPRT ftp_login	(	FTP_CON **	con,
		const char *	host,
		unsigned short	port,
		const char *	user,
		const char *	pass,
		const char *	acct
	)

Definition at line 450 of file ftplib.cxx.

{
   int status;
 
   status = ftp_connect(con, host, port);
   if (status != FTP_SUCCESS)
      return status;
 
   status = ftp_user(*con, user);
   if (status >= 0)
      return status;
 
   if (status == -230)
      return status;
 
   if (status == -332) {
      if (account == NULL)
         return FTP_NET_ERROR;
 
      status = ftp_account(*con, account);
      if (status < 1)
         return status;
 
      if (status == -230)
         return status;
   }
 
   return ftp_password(*con, password);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ftp_move()

int EXPRT ftp_move	(	FTP_CON *	con,
		const char *	old_name,
		const char *	new_name
	)

Definition at line 522 of file ftplib.cxx.

{
   int status;
 
   status = ftp_command(con, "RNFR %s", oldname, 200, 350, EOF);
 
   if (status < 0)
      return ftp_command(con, "RNTO %s", newname, 200, 250, EOF);
   else
      return status;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ftp_port()

int EXPRT ftp_port	(	FTP_CON *	con,
		int	a,
		int	b,
		int	c,
		int	d,
		int	e,
		int	f
	)

Definition at line 500 of file ftplib.cxx.

{
   char cmd[256];
   int status;
 
   sprintf(cmd, "PORT %d,%d,%d,%d,%d,%d", a, b, c, d, e, f);
   if (ftp_send_message(con, cmd) != FTP_SUCCESS)
      return FTP_NET_ERROR;
 
   status = ftp_get_message(con, cmd);
   if (status == FTP_QUIT)
      return FTP_QUIT;
 
   if (!ftp_good(status, 200, EOF))
      return FTP_NET_ERROR;
 
   return FTP_SUCCESS;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ftp_put()

int EXPRT ftp_put	(	FTP_CON *	con,
		const char *	local_name,
		const char *	remote_name
	)

Definition at line 580 of file ftplib.cxx.

{
   int fh;
   int status;
   char buff[8193];
   char str[256];
   int count, i = 0;
   long total = 0;
   DWORD start, stop;
 
   if (ftp_open_write(con, remote_name) >= 0)
      return con->err_no;
 
   if ((fh = open(local_name, O_BINARY)) == -1)
      return FTP_FILE_ERROR;
 
   start = ss_millitime();
 
   while ((count = read(fh, buff, 8192)) > 0) {
      total += ftp_send(con->data, buff, count);
      if (ftp_debug_func != NULL) {
         printf("%c\r", bars[(i++) % 4]);
         fflush(stdout);
      }
   }
 
   close(fh);
   stop = ss_millitime();
 
   status = ftp_close(con);
   if (ftp_debug_func != NULL) {
      sprintf(str, "%ld bytes sent in %1.2f seconds (%1.2lf kB/sec).",
              total, (stop - start) / 1000.0, total / 1024.0 / ((stop - start) / 1000.0));
      ftp_debug_func(str);
   }
 
   return status;
}

Here is the call graph for this function:

ftp_pwd()

char EXPRT * ftp_pwd

(

FTP_CON *

con

)

Definition at line 622 of file ftplib.cxx.

{
   static char str[256];
   char tmp[256];
   int status;
 
   str[0] = 0;
   if (ftp_send_message(con, "PWD") != FTP_SUCCESS)
      return str;
 
   status = ftp_get_message(con, tmp);
 
   if (status != 257) {
      if (ftp_error_func != NULL)
         ftp_error_func(tmp);
 
      return str;
   }
 
   sscanf(tmp, "%*[^\"]%*c%[^\"]%*s", str);
 
   return str;
}

Here is the call graph for this function:

ftp_receive()

int EXPRT ftp_receive	(	int	sock,
		char *	buffer,
		int	bsize
	)

Definition at line 418 of file ftplib.cxx.

{
   int count, i;
 
#ifdef OS_WINNT
   DWORD timeout = FTP_RECEIVE_TIMEOUT_MSEC;
#else
   struct timeval timeout;
   timeout.tv_sec = FTP_RECEIVE_TIMEOUT_MSEC / 1000;
   timeout.tv_usec = (FTP_RECEIVE_TIMEOUT_MSEC % 1000) * 1000;
#endif
 
   if (setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, (char *) &timeout, sizeof(timeout)) != 0)
      return 0;
 
   i = 0;
   while (TRUE) {
      count = recv(sock, buffer + i, bsize - 1 - i, 0);
      if (count <= 0)
         return i;
 
      i += count;
      buffer[i] = 0;
 
      if (i >= bsize - 1)
         return i;
   }
}

Here is the caller graph for this function:

ftp_send()

int EXPRT ftp_send	(	int	sock,
		const char *	buffer,
		int	n_bytes
	)

Definition at line 397 of file ftplib.cxx.

{
   int n_bytes_left, n_written;
 
   n_bytes_left = n_bytes_to_write;
 
   while (n_bytes_left > 0) {
      n_written = send(sock, buffer, n_bytes_left > 8192 ? 8192 : n_bytes_left, 0);
      if (n_written <= 0)
         return n_bytes_to_write - n_bytes_left;
 
      n_bytes_left -= n_written;
      buffer += n_written;
   }
 
   return n_bytes_to_write;
}

Here is the caller graph for this function:

ftp_send_message()

int EXPRT ftp_send_message	(	FTP_CON *	con,
		const char *	message
	)

Definition at line 160 of file ftplib.cxx.

{
   if (send(con->sock, message, strlen(message), 0) == -1)
      return FTP_NET_ERROR;
 
   if (send(con->sock, "\r\n", 2, 0) == -1)
      return FTP_NET_ERROR;
 
   if (ftp_debug_func != NULL)
      ftp_debug_func(message);
 
   return FTP_SUCCESS;
}

Here is the caller graph for this function: