ftplib.h File Reference

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

Go to the source code of this file.

Macros
#define	_FTPLIB_NO_COMPAT
#define	FTPLIB_ASCII   'A'
#define	FTPLIB_BINARY   FTPLIB_IMAGE
#define	FTPLIB_CALLBACK   2
#define	FTPLIB_CALLBACK_WRITER   6
#define	FTPLIB_CALLBACK_WRITERARG   7
#define	FTPLIB_CALLBACKARG   4
#define	FTPLIB_CALLBACKBYTES   5
#define	FTPLIB_CONNMODE   1
#define	FTPLIB_DIR   1
#define	FTPLIB_DIR_VERBOSE   2
#define	FTPLIB_FILE_READ   3
#define	FTPLIB_FILE_WRITE   4
#define	FTPLIB_IDLETIME   3
#define	FTPLIB_IMAGE   'I'
#define	FTPLIB_PASSIVE   1
#define	FTPLIB_PORT   2
#define	FTPLIB_TEXT   FTPLIB_ASCII

Typedefs
typedef int(*	FtpCallback )(netbuf *nControl, int xfered, void *arg)
typedef int(*	FtpCallbackWriter )(netbuf *nControl, const void *buffer, size_t size, void *arg)
typedef struct NetBuf	netbuf

Functions
GLOBALREF int	FtpAccess (const char *path, int typ, int mode, netbuf *nControl, netbuf **nData)
GLOBALREF int	FtpCDUp (netbuf *nControl)
GLOBALREF int	FtpChdir (const char *path, netbuf *nControl)
GLOBALREF int	FtpClose (netbuf *nData)
GLOBALREF int	FtpConnect (const char *host, netbuf **nControl)
GLOBALREF int	FtpDelete (const char *fnm, netbuf *nControl)
GLOBALREF int	FtpDir (const char *output, const char *path, netbuf *nControl)
GLOBALREF int	FtpGet (const char *output, const char *path, char mode, netbuf *nControl)
GLOBALREF void	FtpInit (void)
GLOBALREF char *	FtpLastResponse (netbuf *nControl)
GLOBALREF int	FtpLogin (const char *user, const char *pass, netbuf *nControl)
GLOBALREF int	FtpMkdir (const char *path, netbuf *nControl)
GLOBALREF int	FtpModDate (const char *path, char *dt, int max, netbuf *nControl)
GLOBALREF int	FtpNlst (const char *output, const char *path, netbuf *nControl)
GLOBALREF int	FtpOptions (int opt, long val, netbuf *nControl)
GLOBALREF int	FtpPut (const char *input, const char *path, char mode, netbuf *nControl)
GLOBALREF int	FtpPwd (char *path, int max, netbuf *nControl)
GLOBALREF void	FtpQuit (netbuf *nControl)
GLOBALREF int	FtpRead (void *buf, int max, netbuf *nData)
GLOBALREF int	FtpRename (const char *src, const char *dst, netbuf *nControl)
GLOBALREF int	FtpRmdir (const char *path, netbuf *nControl)
GLOBALREF int	FtpSite (const char *cmd, netbuf *nControl)
GLOBALREF int	FtpSize (const char *path, int *size, char mode, netbuf *nControl)
GLOBALREF int	FtpSysType (char *buf, int max, netbuf *nControl)
GLOBALREF int	FtpWrite (void *buf, int len, netbuf *nData)

Variables
GLOBALREF int	ftplib_debug

Macro Definition Documentation

#define _FTPLIB_NO_COMPAT

Definition at line 27 of file ftplib.h.

#define FTPLIB_ASCII   'A'

Definition at line 50 of file ftplib.h.

#define FTPLIB_BINARY   FTPLIB_IMAGE

Definition at line 53 of file ftplib.h.

#define FTPLIB_CALLBACK   2

Definition at line 60 of file ftplib.h.

#define FTPLIB_CALLBACK_WRITER   6

Definition at line 64 of file ftplib.h.

#define FTPLIB_CALLBACK_WRITERARG   7

Definition at line 65 of file ftplib.h.

#define FTPLIB_CALLBACKARG   4

Definition at line 62 of file ftplib.h.

#define FTPLIB_CALLBACKBYTES   5

Definition at line 63 of file ftplib.h.

#define FTPLIB_CONNMODE   1

Definition at line 59 of file ftplib.h.

#define FTPLIB_DIR   1

Definition at line 44 of file ftplib.h.

#define FTPLIB_DIR_VERBOSE   2

Definition at line 45 of file ftplib.h.

#define FTPLIB_FILE_READ   3

Definition at line 46 of file ftplib.h.

#define FTPLIB_FILE_WRITE   4

Definition at line 47 of file ftplib.h.

#define FTPLIB_IDLETIME   3

Definition at line 61 of file ftplib.h.

#define FTPLIB_IMAGE   'I'

Definition at line 51 of file ftplib.h.

#define FTPLIB_PASSIVE   1

Definition at line 56 of file ftplib.h.

#define FTPLIB_PORT   2

Definition at line 57 of file ftplib.h.

#define FTPLIB_TEXT   FTPLIB_ASCII

Definition at line 52 of file ftplib.h.

Typedef Documentation

typedef int(* FtpCallback)(netbuf *nControl, int xfered, void *arg)

Definition at line 72 of file ftplib.h.

typedef int(* FtpCallbackWriter)(netbuf *nControl, const void *buffer, size_t size, void *arg)

Definition at line 73 of file ftplib.h.

typedef struct NetBuf netbuf

Definition at line 71 of file ftplib.h.

Function Documentation

GLOBALREF int FtpAccess	(	const char *	path,
		int	typ,
		int	mode,
		netbuf *	nControl,
		netbuf **	nData
	)

Definition at line 920 of file ftplib.c.

{
    char buf[256];
    int dir;
    if ((path == NULL) &&
        ((typ == FTPLIB_FILE_WRITE) || (typ == FTPLIB_FILE_READ)))
      {
          sprintf(nControl->response,
                  "Missing path argument for file transfer\n");
          return 0;
      }
    sprintf(buf, "TYPE %c", mode);
    if (!FtpSendCmd(buf, '2', nControl))
        return 0;
    switch (typ)
      {
        case FTPLIB_DIR:
            strcpy(buf,"NLST");
            dir = FTPLIB_READ;
            break;
        case FTPLIB_DIR_VERBOSE:
            strcpy(buf,"LIST");
            dir = FTPLIB_READ;
            break;
        case FTPLIB_FILE_READ:
            strcpy(buf,"RETR");
            dir = FTPLIB_READ;
            break;
        case FTPLIB_FILE_WRITE:
            strcpy(buf,"STOR");
            dir = FTPLIB_WRITE;
            break;
        default:
            sprintf(nControl->response, "Invalid open type %d\n", typ);
            return 0;
      }
    if (path != NULL)
      {
          int i = (int)strlen(buf);
          buf[i++] = ' ';
          if ((strlen(path) + i) >= sizeof(buf))
              return 0;
          strcpy(&buf[i],path);
      }
    if (FtpOpenPort(nControl, nData, mode, dir) == -1)
        return 0;
    if (!FtpSendCmd(buf, '1', nControl))
      {
          FtpClose(*nData);
          *nData = NULL;
          return 0;
      }
    (*nData)->ctrl = nControl;
    nControl->data = *nData;
    if (nControl->cmode == FTPLIB_PORT)
      {
          if (!FtpAcceptConnection(*nData,nControl))
            {
                FtpClose(*nData);
                *nData = NULL;
                nControl->data = NULL;
                return 0;
            }
      }
    return 1;
}

GLOBALREF int FtpCDUp

(

netbuf *

nControl

)

Definition at line 1168 of file ftplib.c.

{
    if (!FtpSendCmd("CDUP",'2',nControl))
        return 0;
    return 1;
}

GLOBALREF int FtpChdir	(	const char *	path,
		netbuf *	nControl
	)

Definition at line 1151 of file ftplib.c.

{
    char buf[256];

    if ((strlen(path) + 6) > sizeof(buf))
        return 0;
    sprintf(buf,"CWD %s",path);
    if (!FtpSendCmd(buf,'2',nControl))
        return 0;
    return 1;
}

GLOBALREF int FtpClose

(

netbuf *

nData

)

Definition at line 1054 of file ftplib.c.

{
    netbuf *ctrl;
    switch (nData->dir)
      {
        case FTPLIB_WRITE:
              /* potential problem - if buffer flush fails, how to notify user? */
            if (nData->buf != NULL)
                writeline(NULL, 0, nData);
        case FTPLIB_READ:
            if (nData->buf)
                free(nData->buf);
            shutdown(nData->handle,2);
            net_close(nData->handle);
            ctrl = nData->ctrl;
            free(nData);
            if (ctrl)
              {
                  ctrl->data = NULL;
                  return(readresp('2', ctrl));
              }
            return 1;
        case FTPLIB_CONTROL:
            if (nData->data)
              {
                  nData->ctrl = NULL;
                  FtpClose(nData);
              }
            net_close(nData->handle);
            free(nData);
            return 0;
      }
    return 1;
}

GLOBALREF int FtpConnect	(	const char *	host,
		netbuf **	nControl
	)

Definition at line 444 of file ftplib.c.

{
    int sControl, stat, flags, oldflags;
    struct sockaddr_in sin;
    struct hostent *phe;
    struct servent *pse;
    int on=1;
    netbuf *ctrl;
    char *lhost;
    char *pnum;
    struct timeval tv;
    fd_set wr;

    memset(&sin,0,sizeof(sin));
    sin.sin_family = AF_INET;
    lhost = strdup(host);
    pnum = strchr(lhost,':');
    if (pnum == NULL)
      {
#if defined(VMS) || defined(ANDROID)
          sin.sin_port = htons(21);
#else
          if ((pse = getservbyname("ftp","tcp")) == NULL)
            {
                perror("getservbyname");
                return 0;
            }
          sin.sin_port = pse->s_port;
#endif
      }
    else
      {
          *pnum++ = '\0';
          if (isdigit(*pnum))
              sin.sin_port = htons(atoi(pnum));
          else
            {
                pse = getservbyname(pnum,"tcp");
                sin.sin_port = pse->s_port;
            }
      }
    if ((sin.sin_addr.s_addr = inet_addr(lhost)) == -1)
      {
          if ((phe = gethostbyname(lhost)) == NULL)
            {
                perror("gethostbyname");
                return 0;
            }

          memcpy((char *)&sin.sin_addr, phe->h_addr, phe->h_length);

      }
    free(lhost);

    sControl = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP);
    if (sControl == -1)
      {
          perror("socket");
          return 0;
      }

    if ( setsockopt(sControl,SOL_SOCKET,SO_REUSEADDR,
                   SETSOCKOPT_OPTVAL_TYPE &on, sizeof(on)) == -1)
      {
          perror("setsockopt");
          net_close(sControl);
          return 0;
      }

#if defined(_WIN32)
    if (connect(sControl, (struct sockaddr *)&sin, sizeof(sin)) == -1)
    {
        perror("connect");
        net_close(sControl);
        return 0;
    }
#else
     //set nonblocking for connection timeout
    flags = fcntl( sControl, F_GETFL,0);
    oldflags=flags;
    fcntl( sControl, F_SETFL, O_NONBLOCK|flags);

    stat=connect( sControl, (struct sockaddr *)&sin, sizeof(sin));
    if (stat < 0) 
      { 
          if (errno != EWOULDBLOCK && errno != EINPROGRESS) 
            { 
                perror("connect");
                net_close(sControl);
                return 0;
            } 
      } 

    FD_ZERO(&wr); 
    FD_SET( sControl, &wr); 

    tv.tv_sec = ACCEPT_TIMEOUT;
    tv.tv_usec = 0; 

    stat = select(sControl+1, 0, &wr, 0, &tv);

    if (stat < 1)
      { 
            // time out has expired, 
            // or an error has ocurred
          perror("timeout");
          net_close(sControl);
          return 0;
      } 

    if (ftplib_debug > 1)
        printf("connected\n");

      //set original flags
    fcntl( sControl, F_SETFL, oldflags);
#endif

    ctrl = calloc(1,sizeof(netbuf));
    if (ctrl == NULL)
      {
          perror("calloc");
          net_close(sControl);
          return 0;
      }
    ctrl->buf = malloc(FTPLIB_BUFSIZ);
    if (ctrl->buf == NULL)
      {
          perror("calloc");
          net_close(sControl);
          free(ctrl);
          return 0;
      }
    ctrl->handle = sControl;
    ctrl->dir = FTPLIB_CONTROL;
    ctrl->ctrl = NULL;
    ctrl->cmode = FTPLIB_DEFMODE;
    ctrl->idlecb = NULL;
    ctrl->writercb = NULL;
    ctrl->idletime.tv_sec = ctrl->idletime.tv_usec = 0;
    ctrl->idlearg = NULL;
    ctrl->writerarg = NULL;
    ctrl->xfered = 0;
    ctrl->xfered1 = 0;
    ctrl->cbbytes = 0;
    if (readresp('2', ctrl) == 0)
      {
          net_close(sControl);
          free(ctrl->buf);
          free(ctrl);
          return 0;
      }
    *nControl = ctrl;
    return 1;
}

GLOBALREF int FtpDelete	(	const char *	fnm,
		netbuf *	nControl
	)

Definition at line 1397 of file ftplib.c.

{
    char cmd[256];

    if ((strlen(fnm) + 7) > sizeof(cmd))
        return 0;
    sprintf(cmd,"DELE %s",fnm);
    if (!FtpSendCmd(cmd,'2', nControl))
        return 0;
    return 1;
}

GLOBALREF int FtpDir	(	const char *	output,
		const char *	path,
		netbuf *	nControl
	)

Definition at line 1296 of file ftplib.c.

{
    return FtpXfer(outputfile, path, nControl, FTPLIB_DIR_VERBOSE, FTPLIB_ASCII);
}

GLOBALREF int FtpGet	(	const char *	output,
		const char *	path,
		char	mode,
		netbuf *	nControl
	)

Definition at line 1354 of file ftplib.c.

{
    return FtpXfer(outputfile, path, nControl, FTPLIB_FILE_READ, mode);
}

GLOBALREF void FtpInit

(

void

)

Definition at line 416 of file ftplib.c.

{
#if defined(_WIN32)
    WORD wVersionRequested;
    WSADATA wsadata;
    int err;
    wVersionRequested = MAKEWORD(1,1);
    if ((err = WSAStartup(wVersionRequested,&wsadata)) != 0)
        if (ftplib_debug > 1)
            fprintf(stderr,"Network failed to start: %d\n",err);
#endif
}

GLOBALREF char* FtpLastResponse

(

netbuf *

nControl

)

Definition at line 432 of file ftplib.c.

{
    if ((nControl) && (nControl->dir == FTPLIB_CONTROL))
        return nControl->response;
    return NULL;
}

GLOBALREF int FtpLogin	(	const char *	user,
		const char *	pass,
		netbuf *	nControl
	)

Definition at line 675 of file ftplib.c.

{
    char tempbuf[64];

    if (((strlen(user) + 7) > sizeof(tempbuf)) ||
        ((strlen(pass) + 7) > sizeof(tempbuf)))
        return 0;
    sprintf(tempbuf,"USER %s",user);
    if (!FtpSendCmd(tempbuf,'3',nControl))
      {
          if (nControl->response[0] == '2')
              return 1;
          return 0;
      }
    sprintf(tempbuf,"PASS %s",pass);
    return FtpSendCmd(tempbuf,'2',nControl);
}

GLOBALREF int FtpMkdir	(	const char *	path,
		netbuf *	nControl
	)

Definition at line 1134 of file ftplib.c.

{
    char buf[256];

    if ((strlen(path) + 6) > sizeof(buf))
        return 0;
    sprintf(buf,"MKD %s",path);
    if (!FtpSendCmd(buf,'2', nControl))
        return 0;
    return 1;
}

GLOBALREF int FtpModDate	(	const char *	path,
		char *	dt,
		int	max,
		netbuf *	nControl
	)

Definition at line 1334 of file ftplib.c.

{
    char buf[256];
    int rv = 1;

    if ((strlen(path) + 7) > sizeof(buf))
        return 0;
    sprintf(buf,"MDTM %s",path);
    if (!FtpSendCmd(buf,'2',nControl))
        rv = 0;
    else
        strncpy(dt, &nControl->response[4], max);
    return rv;
}

GLOBALREF int FtpNlst	(	const char *	output,
		const char *	path,
		netbuf *	nControl
	)

Definition at line 1285 of file ftplib.c.

{
    return FtpXfer(outputfile, path, nControl, FTPLIB_DIR, FTPLIB_ASCII);
}

GLOBALREF int FtpOptions	(	int	opt,
		long	val,
		netbuf *	nControl
	)

Definition at line 604 of file ftplib.c.

{
    int v,rv=0;
    switch (opt)
      {
        case FTPLIB_CONNMODE:
            v = (int) val;
            if ((v == FTPLIB_PASSIVE) || (v == FTPLIB_PORT))
              {
                  nControl->cmode = v;
                  rv = 1;
              }
            break;
        case FTPLIB_CALLBACK:
            nControl->idlecb = (FtpCallback) val;
            rv = 1;
            break;
        case FTPLIB_CALLBACK_WRITER:
            nControl->writercb = (FtpCallbackWriter) val;
            rv = 1;
            break;
        case FTPLIB_IDLETIME:
            v = (int) val;
            rv = 1;
            nControl->idletime.tv_sec = v / 1000;
            nControl->idletime.tv_usec = (v % 1000) * 1000;
            break;
        case FTPLIB_CALLBACKARG:
            rv = 1;
            nControl->idlearg = (void *) val;
            break;
        case FTPLIB_CALLBACK_WRITERARG:
            rv = 1;
            nControl->writerarg = (void *) val;
            break;
        case FTPLIB_CALLBACKBYTES:
            rv = 1;
            nControl->cbbytes = (int) val;
            break;
      }
    return rv;
}

GLOBALREF int FtpPut	(	const char *	input,
		const char *	path,
		char	mode,
		netbuf *	nControl
	)

Definition at line 1365 of file ftplib.c.

{
    return FtpXfer(inputfile, path, nControl, FTPLIB_FILE_WRITE, mode);
}

GLOBALREF int FtpPwd	(	char *	path,
		int	max,
		netbuf *	nControl
	)

Definition at line 1197 of file ftplib.c.

{
    int l = max;
    char *b = path;
    char *s;
    if (!FtpSendCmd("PWD",'2',nControl))
        return 0;
    s = strchr(nControl->response, '"');
    if (s == NULL)
        return 0;
    s++;
    while ((--l) && (*s) && (*s != '"'))
        *b++ = *s++;
    *b++ = '\0';
    return 1;
}

GLOBALREF void FtpQuit

(

netbuf *

nControl

)

Definition at line 1414 of file ftplib.c.

{
    if (nControl->dir != FTPLIB_CONTROL)
        return;
    FtpSendCmd("QUIT",'2',nControl);
    net_close(nControl->handle);
    free(nControl->buf);
    free(nControl);
}

GLOBALREF int FtpRead	(	void *	buf,
		int	max,
		netbuf *	nData
	)

Definition at line 991 of file ftplib.c.

{
    int i;
    if (nData->dir != FTPLIB_READ)
        return 0;
    if (nData->buf)
        i = readline(buf, max, nData);
    else
      {
          i = socket_wait(nData);
          if (i != 1)
              return 0;
          i = (int)net_read(nData->handle, buf, max);
      }
    if (i == -1)
        return 0;
    nData->xfered += i;
    if (nData->idlecb && nData->cbbytes)
      {
          nData->xfered1 += i;
          if (nData->xfered1 > nData->cbbytes)
            {
                if (nData->idlecb(nData, nData->xfered, nData->idlearg) == 0)
                    return 0;
                nData->xfered1 = 0;
            }
      }
    return i;
}

GLOBALREF int FtpRename	(	const char *	src,
		const char *	dst,
		netbuf *	nControl
	)

Definition at line 1376 of file ftplib.c.

{
    char cmd[256];

    if (((strlen(src) + 7) > sizeof(cmd)) ||
        ((strlen(dst) + 7) > sizeof(cmd)))
        return 0;
    sprintf(cmd,"RNFR %s",src);
    if (!FtpSendCmd(cmd,'3',nControl))
        return 0;
    sprintf(cmd,"RNTO %s",dst);
    if (!FtpSendCmd(cmd,'2',nControl))
        return 0;
    return 1;
}

GLOBALREF int FtpRmdir	(	const char *	path,
		netbuf *	nControl
	)

Definition at line 1180 of file ftplib.c.

{
    char buf[256];

    if ((strlen(path) + 6) > sizeof(buf))
        return 0;
    sprintf(buf,"RMD %s",path);
    if (!FtpSendCmd(buf,'2',nControl))
        return 0;
    return 1;
}

GLOBALREF int FtpSite	(	const char *	cmd,
		netbuf *	nControl
	)

Definition at line 1094 of file ftplib.c.

{
    char buf[256];
    
    if ((strlen(cmd) + 7) > sizeof(buf))
        return 0;
    sprintf(buf,"SITE %s",cmd);
    if (!FtpSendCmd(buf,'2',nControl))
        return 0;
    return 1;
}

GLOBALREF int FtpSize	(	const char *	path,
		int *	size,
		char	mode,
		netbuf *	nControl
	)

Definition at line 1306 of file ftplib.c.

{
    char cmd[256];
    int resp,sz,rv=1;

    if ((strlen(path) + 7) > sizeof(cmd))
        return 0;
    sprintf(cmd, "TYPE %c", mode);
    if (!FtpSendCmd(cmd, '2', nControl))
        return 0;
    sprintf(cmd,"SIZE %s",path);
    if (!FtpSendCmd(cmd,'2',nControl))
        rv = 0;
    else
      {
          if (sscanf(nControl->response, "%d %d", &resp, &sz) == 2)
              *size = sz;
          else
              rv = 0;
      }   
    return rv;
}

GLOBALREF int FtpSysType	(	char *	buf,
		int	max,
		netbuf *	nControl
	)

Definition at line 1115 of file ftplib.c.

{
    int l = max;
    char *b = buf;
    char *s;
    if (!FtpSendCmd("SYST",'2',nControl))
        return 0;
    s = &nControl->response[4];
    while ((--l) && (*s != ' '))
        *b++ = *s++;
    *b++ = '\0';
    return 1;
}

GLOBALREF int FtpWrite	(	void *	buf,
		int	len,
		netbuf *	nData
	)

Definition at line 1024 of file ftplib.c.

{
    int i;
    if (nData->dir != FTPLIB_WRITE)
        return 0;
    if (nData->buf)
        i = writeline(buf, len, nData);
    else
      {
          socket_wait(nData);
          i = (int)net_write(nData->handle, buf, len);
      }
    if (i == -1)
        return 0;
    nData->xfered += i;
    if (nData->idlecb && nData->cbbytes)
      {
          nData->xfered1 += i;
          if (nData->xfered1 > nData->cbbytes)
            {
                nData->idlecb(nData, nData->xfered, nData->idlearg);
                nData->xfered1 = 0;
            }
      }
    return i;
}

Variable Documentation

GLOBALREF int ftplib_debug

Definition at line 97 of file ftplib.h.