util.h File Reference

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

Go to the source code of this file.

Macros
#define	PTRZERO(p, siz)   (void) memset(p, 0, (size_t) (siz))
#define	ZERO(a)   PTRZERO(&(a), sizeof(a))
#define	STREQ(a, b)   (strcmp(a,b) == 0)
#define	STRNEQ(a, b, s)   (strncmp(a,b,(size_t)(s)) == 0)
#define	ISTRCMP   strcmp
#define	ISTRNCMP   strncmp
#define	ISTREQ(a, b)   (ISTRCMP(a,b) == 0)
#define	ISTRNEQ(a, b, s)   (ISTRNCMP(a,b,(size_t)(s)) == 0)
#define	QSORT(base, n, s, cmp)    qsort(base, (size_t)(n), (size_t)(s), (cmp_t)(cmp))
#define	BSEARCH(key, base, n, s, cmp)    bsearch(key, base, (size_t)(n), (size_t)(s), (cmp_t)(cmp))
#define	kDoPerror   1
#define	kDontPerror   0
#define	kClosedFileDescriptor   (-1)
#define	SZ(a)   ((size_t) (a))
#define	F_OK   0
#define	UNLINK   unlink
#define	SEEK_SET   0
#define	SEEK_CUR   1
#define	SEEK_END   2
#define	SETVBUF   setvbuf
#define	NcSignal   signal

Typedefs
typedef char	string[160]
typedef char	str16[16]
typedef char	str32[32]
typedef char	str64[64]
typedef char	longstring[512]
typedef char	pathname[512]
typedef int(*	cmp_t) (const void *, const void *)

Functions
char *	FGets (char *, size_t, FILE *)
struct passwd *	GetPwByName (void)
void	GetHomeDir (char *, size_t)
void	GetUsrName (char *, size_t)
void	CloseFile (FILE **)
void	PrintF (const FTPCIPtr cip, const char *const fmt,...)
void	Error (const FTPCIPtr cip, const int pError, const char *const fmt,...)
int	GetSockBufSize (int sockfd, size_t *rsize, size_t *ssize)
int	SetSockBufSize (int sockfd, size_t rsize, size_t ssize)
time_t	UnMDTMDate (char *)
void	Scramble (unsigned char *dst, size_t dsize, unsigned char *src, char *key)

Macro Definition Documentation

BSEARCH

#define BSEARCH	(		key,
			base,
			n,
			s,
			cmp
	)		bsearch(key, base, (size_t)(n), (size_t)(s), (cmp_t)(cmp))

Definition at line 40 of file util.h.

F_OK

#define F_OK   0

Definition at line 52 of file util.h.

ISTRCMP

#define ISTRCMP   strcmp

Definition at line 28 of file util.h.

ISTREQ

#define ISTREQ	(		a,
			b
	)		(ISTRCMP(a,b) == 0)

Definition at line 33 of file util.h.

ISTRNCMP

#define ISTRNCMP   strncmp

Definition at line 29 of file util.h.

ISTRNEQ

#define ISTRNEQ	(		a,
			b,
			s
	)		(ISTRNCMP(a,b,(size_t)(s)) == 0)

Definition at line 34 of file util.h.

kClosedFileDescriptor

#define kClosedFileDescriptor   (-1)

Definition at line 47 of file util.h.

kDontPerror

#define kDontPerror   0

Definition at line 45 of file util.h.

kDoPerror

#define kDoPerror   1

Definition at line 44 of file util.h.

NcSignal

#define NcSignal   signal

Definition at line 105 of file util.h.

PTRZERO

#define PTRZERO	(		p,
			siz
	)		(void) memset(p, 0, (size_t) (siz))

Definition at line 16 of file util.h.

QSORT

#define QSORT	(		base,
			n,
			s,
			cmp
	)		qsort(base, (size_t)(n), (size_t)(s), (cmp_t)(cmp))

Definition at line 37 of file util.h.

SEEK_CUR

#define SEEK_CUR   1

Definition at line 63 of file util.h.

SEEK_END

#define SEEK_END   2

Definition at line 64 of file util.h.

SEEK_SET

#define SEEK_SET   0

Definition at line 62 of file util.h.

SETVBUF

#define SETVBUF   setvbuf

Definition at line 70 of file util.h.

STREQ

#define STREQ	(		a,
			b
	)		(strcmp(a,b) == 0)

Definition at line 20 of file util.h.

STRNEQ

#define STRNEQ	(		a,
			b,
			s
	)		(strncmp(a,b,(size_t)(s)) == 0)

Definition at line 21 of file util.h.

SZ

#define SZ

(

a

)

((size_t) (a))

Definition at line 49 of file util.h.

UNLINK

#define UNLINK   unlink

Definition at line 58 of file util.h.

ZERO

#define ZERO

(

a

)

PTRZERO(&(a), sizeof(a))

Definition at line 19 of file util.h.

Typedef Documentation

cmp_t

typedef int(* cmp_t) (const void *, const void *)

Definition at line 36 of file util.h.

longstring

typedef char longstring[512]

Definition at line 12 of file util.h.

pathname

typedef char pathname[512]

Definition at line 13 of file util.h.

str16

typedef char str16[16]

Definition at line 11 of file util.h.

str32

typedef char str32[32]

Definition at line 11 of file util.h.

str64

typedef char str64[64]

Definition at line 11 of file util.h.

string

typedef const GLchar * string

Definition at line 11 of file util.h.

Function Documentation

CloseFile()

void CloseFile

(

FILE **

f

)

Definition at line 327 of file util.c.

{
    if (*f != NULL) {
        if ((*f != stdout) && (*f != stdin) && (*f != stderr))
            (void) fclose(*f);
        *f = NULL;
    }
}   /* CloseFile */

Referenced by CloseControlConnection(), FTPRebuildConnectionInfo(), and OpenControlConnection().

Error()

void Error	(	const FTPCIPtr	cip,
		const int	pError,
		const char *const	fmt,
			...
	)

Definition at line 368 of file util.c.

{
    va_list ap;
    int errnum;
    size_t len;
    char buf[256];
    int endsinperiod;
    int endsinnewline;
#ifndef HAVE_STRERROR
    char errnostr[16];
#endif
 
    errnum = errno;
    va_start(ap, fmt);
#ifdef HAVE_VSNPRINTF
    vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
    buf[sizeof(buf) - 1] = '\0';
#else
    (void) vsprintf(buf, fmt, ap);
#endif
    va_end(ap);
 
    if (pError != 0) {
        len = strlen(buf);
        endsinperiod = 0;
        endsinnewline = 0;
        if (len > 2) {
            if (buf[len - 1] == '\n') {
                endsinnewline = 1;
                buf[len - 1] = '\0';
                if (buf[len - 2] == '.') {
                    endsinperiod = 1;
                    buf[len - 2] = '\0';
                }
            } else if (buf[len - 1] == '.') {
                endsinperiod = 1;
                buf[len - 1] = '\0';
            }
        }
#ifdef HAVE_STRERROR
        (void) STRNCAT(buf, ": ");
        (void) STRNCAT(buf, strerror(errnum));
#else
#   ifdef HAVE_SNPRINTF
        sprintf(errnostr, sizeof(errnostr) - 1, " (errno = %d)", errnum);
        errnostr[sizeof(errnostr) - 1] = '\0';
#   else
        sprintf(errnostr, " (errno = %d)", errnum);
#   endif
        STRNCAT(buf, errnostr);
#endif
        if (endsinperiod != 0)
            (void) STRNCAT(buf, ".");
        if (endsinnewline != 0)
            (void) STRNCAT(buf, "\n");
    }
 
    if (cip->errLog != NULL) {
        (void) fprintf(cip->errLog, "%s", buf);
        (void) fflush(cip->errLog);
    }
    if ((cip->debugLog != NULL) && (cip->debugLog != cip->errLog)) {
        if ((cip->errLog != stderr) || (cip->debugLog != stdout)) {
            (void) fprintf(cip->debugLog, "%s", buf);
            (void) fflush(cip->debugLog);
        }
    }
    if (cip->errLogProc != NULL) {
        (*cip->errLogProc)(cip, buf);
    }
    if ((cip->debugLogProc != NULL) && (cip->debugLogProc != cip->errLogProc)) {
        (*cip->debugLogProc)(cip, buf);
    }
}   /* Error */

FGets()

char * FGets	(	char *	str,
		size_t	size,
		FILE *	fp
	)

Definition at line 111 of file util.c.

{
    char *cp, *nlptr;
 
    cp = fgets(str, ((int) size) - 1, fp);
    if (cp != NULL) {
        cp[((int) size) - 1] = '\0';    /* ensure terminator */
        nlptr = cp + strlen(cp) - 1;
        if (*nlptr == '\n')
            *nlptr = '\0';
    } else {
        memset(str, 0, size);
    }
    return cp;
}   /* FGets */

Referenced by GetPass().

GetHomeDir()

void GetHomeDir	(	char *	dst,
		size_t	size
	)

Definition at line 240 of file util.c.

{
#if defined(WIN32) || defined(_WINDOWS)
    const char *homedrive, *homepath;
 
    homedrive = getenv("HOMEDRIVE");
    homepath = getenv("HOMEPATH");
    if ((homedrive != NULL) && (homepath != NULL)) {
        (void) Strncpy(dst, homedrive, size);
        (void) Strncat(dst, homepath, size);
        return;
    }
 
//  GetSpecialDir(dst, size, CSIDL_PERSONAL /* "My Documents" */);
//  if (dst[0] != '\0')
//      return;
//
//  dst[0] = '\0';
//  if (GetWindowsDirectory(dst, size - 1) < 1)
//      (void) Strncpy(dst, ".", size);
//  else if (dst[1] == ':') {
//      dst[2] = '\\';
//      dst[3] = '\0';
//  }
#else
    const char *cp;
    struct passwd *pw;
 
    pw = NULL;
#if defined(USE_GETPWUID)
    /* Try to use getpwuid(), but if we have to, fall back to getpwnam(). */
    if ((pw = getpwuid(getuid())) == NULL)
        pw = GetPwByName(); /* Oh well, try getpwnam() then. */
#else
    /* Try to use getpwnam(), but if we have to, fall back to getpwuid(). */
    if ((pw = GetPwByName()) == NULL)
        pw = getpwuid(getuid());    /* Try getpwnam() then. */
#endif
    if (pw != NULL)
        cp = pw->pw_dir;
    else if ((cp = (const char *) getenv("LOGNAME")) == NULL)
            cp = ".";
    (void) Strncpy(dst, cp, size);
#endif
}   /* GetHomeDir */

GetPwByName()

struct passwd * GetPwByName

(

void

)

Definition at line 165 of file util.c.

{
    char *cp;
    struct passwd *pw;
 
    cp = getlogin();
    if (cp == NULL) {
        cp = (char *) getenv("LOGNAME");
        if (cp == NULL)
            cp = (char *) getenv("USER");
    }
    pw = NULL;
    if (cp != NULL)
        pw = getpwnam(cp);
    return (pw);
}   /* GetPwByName */

Referenced by GetHomeDir(), and GetUsrName().

GetSockBufSize()

int GetSockBufSize	(	int	sockfd,
		size_t *	rsize,
		size_t *	ssize
	)

Definition at line 534 of file util.c.

{
#ifdef SO_SNDBUF
    int rc = -1;
    int opt;
    int optsize;
 
    if (ssize != NULL) {
        opt = 0;
        optsize = sizeof(opt);
        rc = getsockopt(sockfd, SOL_SOCKET, SO_SNDBUF, (char *) &opt, &optsize);
        if (rc == 0)
            *ssize = (size_t) opt;
        else
            *ssize = 0;
    }
    if (rsize != NULL) {
        opt = 0;
        optsize = sizeof(opt);
        rc = getsockopt(sockfd, SOL_SOCKET, SO_RCVBUF, (char *) &opt, &optsize);
        if (rc == 0)
            *rsize = (size_t) opt;
        else
            *rsize = 0;
    }
    return (rc);
#else
    if (ssize != NULL)
        *ssize = 0;
    if (rsize != NULL)
        *rsize = 0;
    return (-1);
#endif
}   /* GetSockBufSize */

GetUsrName()

void GetUsrName	(	char *	dst,
		size_t	size
	)

Definition at line 290 of file util.c.

{
#if defined(WIN32) || defined(_WINDOWS)
    DWORD size1;
 
    size1 = size - 1;
    if (! GetUserName(dst, &size1))
        (void) strncpy(dst, "unknown", size);
    dst[size - 1] = '\0';
#else
    const char *cp;
    struct passwd *pw;
 
    pw = NULL;
#ifdef USE_GETPWUID
    /* Try to use getpwuid(), but if we have to, fall back to getpwnam(). */
    if ((pw = getpwuid(getuid())) == NULL)
        pw = GetPwByName(); /* Oh well, try getpwnam() then. */
#else
    /* Try to use getpwnam(), but if we have to, fall back to getpwuid(). */
    if ((pw = GetPwByName()) == NULL)
        pw = getpwuid(getuid());    /* Try getpwnam() then. */
#endif
    if (pw != NULL)
        cp = pw->pw_name;
    else if ((cp = (const char *) getenv("LOGNAME")) == NULL)
            cp = "UNKNOWN";
    (void) Strncpy(dst, cp, size);
#endif
}   /* GetUserName */

PrintF()

void PrintF	(	const FTPCIPtr	cip,
		const char *const	fmt,
			...
	)

Definition at line 340 of file util.c.

{
    va_list ap;
    char buf[256];
 
    va_start(ap, fmt);
    if (cip->debugLog != NULL) {
        (void) vfprintf(cip->debugLog, fmt, ap);
        (void) fflush(cip->debugLog);
    }
    if (cip->debugLogProc != NULL) {
#ifdef HAVE_VSNPRINTF
        (void) vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
        buf[sizeof(buf) - 1] = '\0';
#else
        (void) vsprintf(buf, fmt, ap);
#endif
        (*cip->debugLogProc)(cip, buf);
    }
    va_end(ap);
}   /* PrintF */

Referenced by FTPAbortDataTransfer(), FTPGetFiles3(), FTPLoginHost(), FTPOpenHost(), FTPOpenHostNoLogin(), FTPPutFiles3(), FTPRemoteGlob(), LazyUnixLocalGlob(), OpenControlConnection(), PrintResponse(), SendCommand(), and TraceResponse().

Scramble()

void Scramble	(	unsigned char *	dst,
		size_t	dsize,
		unsigned char *	src,
		char *	key
	)

Definition at line 607 of file util.c.

{
    int i;
    unsigned int ch;
    unsigned char *k2;
    size_t keyLen;
 
    keyLen = strlen(key);
    k2 = (unsigned char *) key;
    for (i=0; i < (int) dsize - 1; i++) {
        ch = src[i];
        if (ch == 0)
            break;
        dst[i] = (unsigned char) (ch ^ (int) (k2[i % (int) keyLen]));
    }
    dst[i] = '\0';
}   /* Scramble */

SetSockBufSize()

int SetSockBufSize	(	int	sockfd,
		size_t	rsize,
		size_t	ssize
	)

Definition at line 572 of file util.c.

{
#ifdef SO_SNDBUF
    int rc = -1;
    int opt;
    int optsize;
 
#ifdef TCP_RFC1323
    /* This is an AIX-specific socket option to do RFC1323 large windows */
    if (ssize > 0 || rsize > 0) {
        opt = 1;
        optsize = sizeof(opt);
        rc = setsockopt(sockfd, IPPROTO_TCP, TCP_RFC1323, &opt, optsize);
    }
#endif
 
    if (ssize > 0) {
        opt = (int) ssize;
        optsize = sizeof(opt);
        rc = setsockopt(sockfd, SOL_SOCKET, SO_SNDBUF, (char *) &opt, optsize);
    }
    if (rsize > 0) {
        opt = (int) rsize;
        optsize = sizeof(opt);
        rc = setsockopt(sockfd, SOL_SOCKET, SO_RCVBUF, (char *) &opt, optsize);
    }
    return (rc);
#else
    return (-1);
#endif
}   /* SetSockBufSize */

Referenced by OpenControlConnection(), and OpenDataConnection().

UnMDTMDate()

time_t UnMDTMDate

(

char *

dstr

)

Definition at line 486 of file util.c.

{
#ifndef HAVE_MKTIME
    return (kModTimeUnknown);
#else
    struct tm ut, *t;
    time_t mt, now;
    time_t result = kModTimeUnknown;
 
    if (strncmp(dstr, "19100", 5) == 0) {
        /* Server Y2K bug! */
        return (result);
    }
 
    (void) time(&now);
    t = localtime(&now);
 
    /* Copy the whole structure of the 'tm' pointed to by t, so it will
     * also set all fields we don't specify explicitly to be the same as
     * they were in t.  That way we copy non-standard fields such as
     * tm_gmtoff, if it exists or not.
     */
    ut = *t;
 
    /* The time we get back from the server is (should be) in UTC. */
    if (sscanf(dstr, "%04d%02d%02d%02d%02d%02d",
        &ut.tm_year,
        &ut.tm_mon,
        &ut.tm_mday,
        &ut.tm_hour,
        &ut.tm_min,
        &ut.tm_sec) == 6)
    {
        --ut.tm_mon;
        ut.tm_year -= 1900;
        mt = mktime(&ut);
        if (mt != (time_t) -1) {
            mt += GetUTCOffset(ut.tm_mon, ut.tm_mday);
            result = (time_t) mt;
        }
    }
    return result;
#endif  /* HAVE_MKTIME */
}   /* UnMDTMDate */