pref.h File Reference

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

Go to the source code of this file.

Classes
struct	PrefOpt

Macros
#define	kFirewallPrefFileName   "firewall"
#define	kGlobalFirewallPrefFileName   "/etc/ncftp.firewall"
#define	kGlobalFixedFirewallPrefFileName   "/etc/ncftp.firewall.fixed"
#define	kGlobalPrefFileName   "/etc/ncftp.prefs_v3"
#define	kGlobalFixedPrefFileName   "/etc/ncftp.prefs_v3.fixed"
#define	kPrefFileName   "prefs_v3"
#define	kPrefFileNameV2   "prefs"
#define	kFirstFileName   "init_v3"
#define	kOpenSelectedBookmarkFileName   "bm2open"
#define	kPrefOptObselete   (-1)
#define	kPrefOptInvisible   0
#define	kPrefOptVisible   1
#define	PREFOBSELETE   (PrefProc) 0, kPrefOptObselete,

Typedefs
typedef void(*	PrefProc) (int i, const char *const, FILE *const fp)
typedef struct PrefOpt	PrefOpt

Functions
void	SetAnonPass (int, const char *const, FILE *const)
void	SetAutoAscii (int t, const char *const val, FILE *const fp)
void	SetAutoResume (int, const char *const, FILE *const)
void	SetAutoSaveChangesToExistingBookmarks (int t, const char *const val, FILE *const fp)
void	SetConfirmClose (int, const char *const, FILE *const)
void	SetConnTimeout (int, const char *const, FILE *const)
void	SetCtrlTimeout (int, const char *const, FILE *const)
void	SetLogSize (int t, const char *const val, FILE *const fp)
void	SetNoAds (int t, const char *const val, FILE *const fp)
void	SetOneTimeMessages (int t, const char *const val, FILE *const)
void	SetPager (int, const char *const, FILE *const)
void	SetPassive (int, const char *const, FILE *const)
void	SetProgressMeter (int, const char *const, FILE *const)
void	SetRedialDelay (int t, const char *const val, FILE *const fp)
void	SetSavePasswords (int, const char *const, FILE *const)
void	SetSOBufsize (int t, const char *const val, FILE *const fp)
void	SetXferTimeout (int, const char *const, FILE *const)
void	SetXtTitle (int, const char *const, FILE *const)
void	Set (const char *const, const char *const)
void	ProcessPrefsFile (FILE *const fp)
void	LoadPrefs (void)
void	InitPrefs (void)
void	PostInitPrefs (void)
void	SavePrefs (void)
void	WriteDefaultFirewallPrefs (FILE *)
void	ProcessFirewallPrefFile (FILE *)
void	LoadFirewallPrefs (int)
void	CheckForNewV3User (void)
int	HasSeenOneTimeMessage (const char *const msg)
void	SetSeenOneTimeMessage (const char *const msg)
int	OneTimeMessage (const char *const msg)

Macro Definition Documentation

kFirewallPrefFileName

#define kFirewallPrefFileName   "firewall"

Definition at line 18 of file pref.h.

kFirstFileName

#define kFirstFileName   "init_v3"

Definition at line 25 of file pref.h.

kGlobalFirewallPrefFileName

#define kGlobalFirewallPrefFileName   "/etc/ncftp.firewall"

Definition at line 19 of file pref.h.

kGlobalFixedFirewallPrefFileName

#define kGlobalFixedFirewallPrefFileName   "/etc/ncftp.firewall.fixed"

Definition at line 20 of file pref.h.

kGlobalFixedPrefFileName

#define kGlobalFixedPrefFileName   "/etc/ncftp.prefs_v3.fixed"

Definition at line 22 of file pref.h.

kGlobalPrefFileName

#define kGlobalPrefFileName   "/etc/ncftp.prefs_v3"

Definition at line 21 of file pref.h.

kOpenSelectedBookmarkFileName

#define kOpenSelectedBookmarkFileName   "bm2open"

Definition at line 28 of file pref.h.

kPrefFileName

#define kPrefFileName   "prefs_v3"

Definition at line 23 of file pref.h.

kPrefFileNameV2

#define kPrefFileNameV2   "prefs"

Definition at line 24 of file pref.h.

kPrefOptInvisible

#define kPrefOptInvisible   0

Definition at line 38 of file pref.h.

kPrefOptObselete

#define kPrefOptObselete   (-1)

Definition at line 37 of file pref.h.

kPrefOptVisible

#define kPrefOptVisible   1

Definition at line 39 of file pref.h.

PREFOBSELETE

#define PREFOBSELETE   (PrefProc) 0, kPrefOptObselete,

Definition at line 41 of file pref.h.

Typedef Documentation

PrefOpt

typedef struct PrefOpt PrefOpt

PrefProc

typedef void(* PrefProc) (int i, const char *const, FILE *const fp)

Definition at line 30 of file pref.h.

Function Documentation

CheckForNewV3User()

void CheckForNewV3User

(

void

)

Definition at line 738 of file pref.c.

{
    FILE *fp;
    struct stat st;
    char pathName[256];
    char line[256];

    gNumProgramRuns = 0;

    /* Don't create in root directory. */
    if (gOurDirectoryPath[0] != '\0') {
        (void) OurDirectoryPath(pathName, sizeof(pathName), kFirstFileName);

        if ((stat(pathName, &st) < 0) && (errno == ENOENT)) {
            gNumProgramRuns = 1;
            gPrefsDirty++;

            /* Create a blank one. */
            fp = fopen(pathName, FOPEN_WRITE_TEXT);
            if (fp == NULL)
                return;
            (void) fprintf(fp, "# NcFTP uses this file to mark that you have run it before, and that you do not\n# need any special first-time instructions or setup.\n#\nruns=%d\n", gNumProgramRuns);
            (void) fclose(fp);
        } else {
            fp = fopen(pathName, FOPEN_READ_TEXT);
            if (fp != NULL) {
                while (fgets(line, sizeof(line) - 1, fp) != NULL) {
                    if (strncmp(line, "runs=", 5) == 0) {
                        (void) sscanf(line + 5, "%d",
                            &gNumProgramRuns);
                        break;
                    }
                }
                (void) fclose(fp);
            }

            /* Increment the count of program runs. */
            gNumProgramRuns++;
            if (gNumProgramRuns == 1)
                gPrefsDirty++;

            /* Race condition between other ncftp processes.
             * This isn't a big deal because this counter isn't
             * critical.
             */

            fp = fopen(pathName, FOPEN_WRITE_TEXT);
            if (fp != NULL) {
                (void) fprintf(fp, "# NcFTP uses this file to mark that you have run it before, and that you do not\n# need any special first-time instructions or setup.\n#\nruns=%d\n", gNumProgramRuns);
                (void) fclose(fp);
            }
        }
    }
}   /* CheckForNewV3User */

Referenced by PreInit().

HasSeenOneTimeMessage()

int HasSeenOneTimeMessage

(

const char *const

msg

)

Definition at line 477 of file pref.c.

{
    char buf[256];
    char *a, *b;

    memcpy(buf, gOneTimeMessagesSeen, sizeof(buf));
    for (a = buf; (b = strtok(a, ",\n")) != NULL; a = NULL) {
        if (strcmp(msg, b) == 0)
            return (1);
    }
    return (0);
}   /* HasSeenOneTimeMessage */

Referenced by OneTimeMessage().

InitPrefs()

void InitPrefs

(

void

)

Definition at line 616 of file pref.c.

{
    char *tok1;

    /* Set default values. */
    gPager[0] = '\0';
    memset(gOneTimeMessagesSeen, 0, sizeof(gOneTimeMessagesSeen));
    gXferTimeout = 3600;
    gConnTimeout = 20;
    gCtrlTimeout = 135;
    gDataPortMode = kFallBackToSendPortMode;
    gConn.dataPortMode = gDataPortMode;
    gAutoResume = 0;
    gSOBufsize = 0;
    gMaxLogSize = 10240;
    gConfirmClose = 1;
    gAutoSaveChangesToExistingBookmarks = 0;
    gRedialDelay = kDefaultRedialDelay;
    STRNCPY(gAutoAscii, "|.txt|.asc|.html|.htm|.css|.xml|.ini|.sh|.pl|.hqx|.cfg|.c|.h|.cpp|.hpp|.bat|.m3u|.pls|");

    /* PLEASE do not change the default from 0, and please
     * don't hack out the portion in main.c which displays
     * a plug every 7th time you run the program.  This is
     * not much to ask for all the work I've put into this
     * since 1991.
     */
    gDoNotDisplayAds = 0;

#if (defined(WIN32) || defined(_WINDOWS)) && defined(_CONSOLE)
    gMaySetXtermTitle = 1;
#else
    gMaySetXtermTitle = 0;
#endif

    gSavePasswords = -1;
#ifdef ncftp
    gProgressMeter = PrStatBar;
#endif

    tok1 = getenv("PAGER");
    if ((tok1 != NULL) && (tok1[0] != '\0')) {
#ifdef HAVE_STRSTR
        /* I prefer "less", but it doesn't work well here
         * because it clears the screen after it finishes,
         * and the default at EOF is to stay in less
         * instead of exiting.
         */
        if (strstr(gPager, "less") != NULL)
            (void) STRNCPY(gPager, "more");
        else
            (void) STRNCPY(gPager, tok1);
#else
        (void) STRNCPY(gPager, tok1);
#endif
    } else {
        (void) STRNCPY(gPager, "more");
    }
}   /* InitPrefs */

Referenced by PreInit().

LoadFirewallPrefs()

void LoadFirewallPrefs

(

int

)

Definition at line 268 of file preffw.c.

{
    FILE *fp, *fp2;
    char pathName[256];
    char *cp;
    int userFile = 0;
    int sysFile = 0;

    if ((gFirewallPrefsLoaded != 0) && (forceReload == 0))
        return;
    gFirewallPrefsLoaded = 1;

    if (gOurDirectoryPath[0] == '\0')
        return;     /* Don't create in root directory. */
    (void) OurDirectoryPath(pathName, sizeof(pathName), kFirewallPrefFileName);

    /* Set default values. */
    gFirewallType = kFirewallNotInUse;
    gFirewallPort = 0;
    gFirewallHost[0] = '\0';
    gFirewallUser[0] = '\0';
    gFirewallPass[0] = '\0';
    gFirewallExceptionList[0] = '\0';

    fp2 = fopen(kGlobalFirewallPrefFileName, FOPEN_READ_TEXT);
    if (fp2 != NULL) {
        /* Initialize to system-wide defaults. */
        ProcessFirewallPrefFile(fp2);
        (void) fclose(fp2);
        sysFile++;
    }

    fp = fopen(pathName, FOPEN_READ_TEXT);
    if (fp != NULL) {
        /* Do user's firewall file. */
        ProcessFirewallPrefFile(fp);
        (void) fclose(fp);
        userFile = 1;
    }

    fp2 = fopen(kGlobalFixedFirewallPrefFileName, FOPEN_READ_TEXT);
    if (fp2 != NULL) {
        /* Override with system-wide settings. */
        ProcessFirewallPrefFile(fp2);
        (void) fclose(fp2);
        sysFile++;
    }

    if ((userFile == 0) && (sysFile == 0)) {
        /* Create a blank one, if
         * there were no system-wide files.
         */
        fp = fopen(pathName, FOPEN_WRITE_TEXT);
        if (fp != NULL) {
            WriteDefaultFirewallPrefs(fp);
            (void) fclose(fp);
            (void) _chmod(pathName, 00600);
            gNumProgramRuns = 1;
        }
    }

    if (gFirewallExceptionList[0] == '\0') {
        FTPInitializeOurHostName(&gLib);
        cp = strchr(gLib.ourHostName, '.');

        if (cp != NULL) {
            (void) STRNCPY(gFirewallExceptionList, cp);
            (void) STRNCAT(gFirewallExceptionList, ",localdomain");
        }
    }
}   /* LoadFirewallPrefs */

Referenced by main(), and PreInit().

LoadPrefs()

void LoadPrefs

(

void

)

Definition at line 555 of file pref.c.

{
    FILE *fp;
    char pathName[256];

    /* As with the firewall preference file, there can be
     * site-wide preferences and user-specific preferences.
     * The user pref file is of course kept in the user's
     * NcFTP home directory.
     *
     * The way we do this is we first look for a global
     * preferences file.  We then process the user's pref
     * file, which could override the global prefs.  Finally,
     * we open a "global fixed" prefs file which then
     * overrides anything the user may have done.
     */

    fp = fopen(kGlobalPrefFileName, FOPEN_READ_TEXT);
    if (fp != NULL) {
        /* Opened the global (but user-overridable) prefs file. */
        ProcessPrefsFile(fp);
        (void) fclose(fp);
    }

    if (gOurDirectoryPath[0] != '\0') {
        (void) OurDirectoryPath(pathName, sizeof(pathName), kPrefFileName);

        fp = fopen(pathName, FOPEN_READ_TEXT);
        if (fp == NULL) {
            /* Try loading the version 2 prefs.
             * There will be options we no longer recognize, but
             * we'd like to import the prefs when possible.
             */
            gPrefsDirty++;
            (void) OurDirectoryPath(pathName, sizeof(pathName), kPrefFileNameV2);
            fp = fopen(pathName, FOPEN_READ_TEXT);
        }

        if (fp == NULL) {
            /* Write a new one when we're done. */
            gPrefsDirty++;
        } else {
            /* Opened the preferences file. */
            ProcessPrefsFile(fp);
            (void) fclose(fp);
        }
    }

    fp = fopen(kGlobalFixedPrefFileName, FOPEN_READ_TEXT);
    if (fp != NULL) {
        /* Opened the global (and not overridable) prefs file. */
        ProcessPrefsFile(fp);
        (void) fclose(fp);
    }
}   /* LoadPrefs */

Referenced by PreInit().

OneTimeMessage()

int OneTimeMessage

(

const char *const

msg

)

Definition at line 508 of file pref.c.

{
    if (HasSeenOneTimeMessage(msg))
        return (0);
    SetSeenOneTimeMessage(msg);
    return (1);
}   /* OneTimeMessage */

Referenced by NcFTPConfirmResumeDownloadProc(), NcFTPConfirmResumeUploadProc(), and PrSizeAndRateMeter().

PostInitPrefs()

void PostInitPrefs

(

void

)

Definition at line 680 of file pref.c.

{
    if (gLib.defaultAnonPassword[0] == '\0') {
        FTPInitializeAnonPassword(&gLib);
        gPrefsDirty++;
    }
    if (gFwDataPortMode >= 0)
        gConn.dataPortMode = gFwDataPortMode;
}   /* PostInitPrefs */

Referenced by PostInit().

ProcessFirewallPrefFile()

void ProcessFirewallPrefFile

(

FILE *

)

Definition at line 213 of file preffw.c.

{
    char line[256];
    char *tok1, *tok2;
    int n;

    /* Opened the firewall preferences file. */
    line[sizeof(line) - 1] = '\0';
    while (fgets(line, sizeof(line) - 1, fp) != NULL) {
        tok1 = strtok(line, " =\t\r\n");
        if ((tok1 == NULL) || (tok1[0] == '#'))
            continue;
        tok2 = strtok(NULL, "\r\n");
        if (tok2 == NULL)
            continue;
        if (ISTREQ(tok1, "firewall-type")) {
            n = atoi(tok2);
            if ((n > 0) && (n <= kFirewallLastType))
                gFirewallType = n;
        } else if (ISTREQ(tok1, "firewall-host")) {
            (void) STRNCPY(gFirewallHost, tok2);
        } else if (ISTREQ(tok1, "firewall-port")) {
            n = atoi(tok2);
            if (n > 0)
                gFirewallPort = (unsigned int) n;
        } else if (ISTREQ(tok1, "firewall-user")) {
            (void) STRNCPY(gFirewallUser, tok2);
        } else if (ISTREQ(tok1, "firewall-pass")) {
            (void) STRNCPY(gFirewallPass, tok2);
        } else if (ISTREQ(tok1, "firewall-password")) {
            (void) STRNCPY(gFirewallPass, tok2);
        } else if (ISTREQ(tok1, "firewall-exception-list")) {
            (void) STRNCPY(gFirewallExceptionList, tok2);
        } else if (ISTREQ(tok1, "passive")) {
            if (ISTREQ(tok2, "optional")) {
                gDataPortMode = gFwDataPortMode = kFallBackToSendPortMode;
            } else if (ISTREQ(tok2, "on")) {
                gDataPortMode = gFwDataPortMode = kPassiveMode;
            } else if (ISTREQ(tok2, "off")) {
                gDataPortMode = gFwDataPortMode = kSendPortMode;
            } else if ((int) isdigit(tok2[0])) {
                gDataPortMode = gFwDataPortMode = atoi(tok2);
            }
        }
    }
}   /* ProcessFirewallPrefFile */

Referenced by LoadFirewallPrefs().

ProcessPrefsFile()

void ProcessPrefsFile

(

FILE *const

fp

)

Definition at line 520 of file pref.c.

{
    char line[1024];
    char *tok1, *tok2;
    int t;

    line[sizeof(line) - 1] = '\0';
    while (fgets(line, sizeof(line) - 1, fp) != NULL) {
        tok1 = strtok(line, " =\t\r\n");
        if ((tok1 == NULL) || (tok1[0] == '#'))
            continue;
        tok2 = strtok(NULL, "\r\n");
        if (tok2 == NULL)
            continue;

        for (t=0; t<gNumPrefOpts; t++) {
            if (ISTREQ(tok1, gPrefOpts[t].varname)) {
                if (gPrefOpts[t].visible == kPrefOptObselete) {
                    /* Probably converting an
                     * old 2.4.2 file.
                     */
                    gPrefsDirty++;
                } else if (gPrefOpts[t].proc != (PrefProc) 0) {
                    (*gPrefOpts[t].proc)(t, tok2, NULL);
                }
            }
        }
    }
}   /* ProcessPrefsFile */

Referenced by LoadPrefs().

SavePrefs()

void SavePrefs

(

void

)

Definition at line 695 of file pref.c.

{
    char pathName[256];
    char pathName2[256];
    char tName[32];
    int t;
    FILE *fp;

    if (gPrefsDirty == 0)
        return;     /* Don't need to save -- no changes made. */

    (void) OurDirectoryPath(pathName, sizeof(pathName), kPrefFileName);

    (void) sprintf(tName, "tpref%06u.txt", (unsigned int) getpid());
    (void) OurDirectoryPath(pathName2, sizeof(pathName2), tName);

    fp = fopen(pathName2, FOPEN_WRITE_TEXT);
    if (fp == NULL) {
        perror("could not save preferences file");
    } else {
        (void) fprintf(fp, "%s", "# NcFTP 3 preferences file\n# This file is loaded and overwritten each time NcFTP is run.\n#\n");
        for (t=0; t<gNumPrefOpts; t++) {
            if (gPrefOpts[t].visible != kPrefOptObselete) {
                (void) fprintf(fp, "%s=", gPrefOpts[t].varname);
                (*gPrefOpts[t].proc)(t, NULL, fp);
                (void) fprintf(fp, "\n");
            }
        }
        (void) fclose(fp);
        (void) unlink(pathName);
        if (rename(pathName2, pathName) < 0) {
            perror("could not finish saving preferences file");
            (void) unlink(pathName2);
        };
    }
}   /* SavePrefs */

Referenced by PostShell().

Set()

void Set	(	const char * const	,
		const char * const
	)

Definition at line 430 of file pref.c.

{
    int t;

    if ((tok1 == NULL) || (ISTREQ(tok1, "all"))) {
        /* Show all. */
        for (t=0; t<gNumPrefOpts; t++) {
            if (gPrefOpts[t].visible == kPrefOptVisible)
                Show1(t);
        }
    } else if (tok2 == NULL) {
        /* Show one. */
        for (t=0; t<gNumPrefOpts; t++) {
            if (ISTREQ(tok1, gPrefOpts[t].varname)) {
                if (gPrefOpts[t].visible == kPrefOptObselete) {
                    (void) printf("The \"%s\" option is obselete or not implemented.\n", tok1);
                } else {
                    Show1(t);
                }
                break;
            }
        }
        if (t >= gNumPrefOpts) {
            (void) printf("Unknown option \"%s\" -- try \"show all\" to list available options.\n", tok1);
        }
    } else {
        /* Set one. */
        for (t=0; t<gNumPrefOpts; t++) {
            if (ISTREQ(tok1, gPrefOpts[t].varname)) {
                if (gPrefOpts[t].visible == kPrefOptObselete) {
                    (void) printf("The \"%s\" option is obselete or not implemented.\n", tok1);
                } else if (gPrefOpts[t].proc != (PrefProc) 0) {
                    (*gPrefOpts[t].proc)(t, tok2, NULL);
                    gPrefsDirty++;
                }
                break;
            }
        }
        if (t >= gNumPrefOpts) {
            (void) printf("Unknown option \"%s\" -- try \"show all\" to list available options.\n", tok1);
        }
    }
}   /* Set */

SetAnonPass()

void SetAnonPass	(	int	,
		const char * const	,
		FILE * const
	)

SetAutoAscii()

void SetAutoAscii	(	int	t,
		const char *const	val,
		FILE *const	fp
	)

SetAutoResume()

void SetAutoResume	(	int	,
		const char * const	,
		FILE * const
	)

SetAutoSaveChangesToExistingBookmarks()

void SetAutoSaveChangesToExistingBookmarks	(	int	t,
		const char *const	val,
		FILE *const	fp
	)

SetConfirmClose()

void SetConfirmClose	(	int	,
		const char * const	,
		FILE * const
	)

SetConnTimeout()

void SetConnTimeout	(	int	,
		const char * const	,
		FILE * const
	)

SetCtrlTimeout()

void SetCtrlTimeout	(	int	,
		const char * const	,
		FILE * const
	)

SetLogSize()

void SetLogSize	(	int	t,
		const char *const	val,
		FILE *const	fp
	)

SetNoAds()

void SetNoAds	(	int	t,
		const char *const	val,
		FILE *const	fp
	)

SetOneTimeMessages()

void SetOneTimeMessages	(	int	t,
		const char *const	val,
		FILE * const
	)

SetPager()

void SetPager	(	int	,
		const char * const	,
		FILE * const
	)

SetPassive()

void SetPassive	(	int	,
		const char * const	,
		FILE * const
	)

SetProgressMeter()

void SetProgressMeter	(	int	,
		const char * const	,
		FILE * const
	)

SetRedialDelay()

void SetRedialDelay	(	int	t,
		const char *const	val,
		FILE *const	fp
	)

SetSavePasswords()

void SetSavePasswords	(	int	,
		const char * const	,
		FILE * const
	)

SetSeenOneTimeMessage()

void SetSeenOneTimeMessage

(

const char *const

msg

)

Definition at line 494 of file pref.c.

{
    gPrefsDirty++;
    if (gOneTimeMessagesSeen[0] == '\0')
        STRNCPY(gOneTimeMessagesSeen, msg);
    else {
        STRNCAT(gOneTimeMessagesSeen, ",");
        STRNCAT(gOneTimeMessagesSeen, msg);
    }
}   /* SetSeenOneTimeMessage */

Referenced by OneTimeMessage().

SetSOBufsize()

void SetSOBufsize	(	int	t,
		const char *const	val,
		FILE *const	fp
	)

SetXferTimeout()

void SetXferTimeout	(	int	,
		const char * const	,
		FILE * const
	)

SetXtTitle()

void SetXtTitle	(	int	,
		const char * const	,
		FILE * const
	)

WriteDefaultFirewallPrefs()

void WriteDefaultFirewallPrefs

(

FILE *

)

Definition at line 39 of file preffw.c.

{
    char *cp;
    time_t now;

    FTPInitializeOurHostName(&gLib);
    cp = strchr(gLib.ourHostName, '.');

    (void) fprintf(fp, "%s", "\
# NcFTP firewall preferences\n\
# ==========================\n\
#\n\
");

    (void) fprintf(fp, "%s", "\
# If you need to use a proxy for FTP, you can configure it below.\n\
# If you do not need one, leave the ``firewall-type'' variable set\n\
# to 0.  Any line that does not begin with the ``#'' character is\n\
# considered a configuration command line.\n\
");
    (void) fprintf(fp, "%s", "\
#\n\
# NOTE:  NcFTP does NOT support HTTP proxies that do FTP, such as \"squid\"\n\
#        or Netscape Proxy Server.  Why?  Because you have to communicate with\n\
#        them using HTTP, and this is a FTP only program.\n\
");
    (void) fprintf(fp, "%s", "\
#\n\
# Types of firewalls:\n\
# ------------------\n\
#\n\
#    type 1:  Connect to firewall host, but send \"USER user@real.host.name\"\n\
#\n\
");
    (void) fprintf(fp, "%s", "\
#    type 2:  Connect to firewall, login with \"USER fwuser\" and\n\
#             \"PASS fwpassword\", and then \"USER user@real.host.name\"\n\
#\n\
#    type 3:  Connect to and login to firewall, and then use\n\
#             \"SITE real.host.name\", followed by the regular USER and PASS.\n\
#\n\
");
    (void) fprintf(fp, "%s", "\
#    type 4:  Connect to and login to firewall, and then use\n\
#             \"OPEN real.host.name\", followed by the regular USER and PASS.\n\
#\n\
#    type 5:  Connect to firewall host, but send\n\
#             \"USER user@fwuser@real.host.name\" and\n\
#             \"PASS pass@fwpass\" to login.\n\
#\n\
");
    (void) fprintf(fp, "%s", "\
#    type 6:  Connect to firewall host, but send\n\
#             \"USER fwuser@real.host.name\" and\n\
#             \"PASS fwpass\" followed by a regular\n\
#             \"USER user\" and\n\
#             \"PASS pass\" to complete the login.\n\
#\n\
");
    (void) fprintf(fp, "%s", "\
#    type 7:  Connect to firewall host, but send\n\
#             \"USER user@real.host.name fwuser\" and\n\
#             \"PASS pass\" followed by\n\
#             \"ACCT fwpass\" to complete the login.\n\
#\n\
#    type 0:  Do NOT use a firewall (most users will choose this).\n\
#\n\
firewall-type=0\n\
#\n\
#\n\
#\n\
");
    (void) fprintf(fp, "%s", "\
# The ``firewall-host'' variable should be the IP address or hostname of\n\
# your firewall server machine.\n\
#\n\
");

    if (cp == NULL) {
        (void) fprintf(fp, "firewall-host=firewall.domain.com\n");
    } else {
        (void) fprintf(fp, "firewall-host=firewall%s\n", cp);
    }

    (void) fprintf(fp, "%s", "\
#\n\
#\n\
#\n\
# The ``firewall-user'' variable tells NcFTP what to use as the user ID\n\
# when it logs in to the firewall before connecting to the outside world.\n\
#\n\
");
    (void) fprintf(fp, "firewall-user=%s\n", gUser);
    (void) fprintf(fp, "%s", "\
#\n\
#\n\
#\n\
# The ``firewall-password'' variable is the password associated with\n\
# the firewall-user ID.  If you set this here, be sure to change the\n\
# permissions on this file so that no one (except the superuser) can\n\
# see your password.  You may also leave this commented out, and then\n\
# NcFTP will prompt you each time for the password.\n\
");
    (void) fprintf(fp, "%s", "\
#\n\
firewall-password=fwpass\n\
#\n\
#\n\
#\n\
# Your firewall may require you to connect to a non-standard port for\n\
# outside FTP services, instead of the internet standard port number (21).\n\
#\n\
firewall-port=21\n\
");
    (void) fprintf(fp, "%s", "\
#\n\
#\n\
#\n\
# You probably do not want to FTP to the firewall for hosts on your own\n\
# domain.  You can set ``firewall-exception-list'' to a list of domains\n\
# or hosts where the firewall should not be used.  For example, if your\n\
# domain was ``probe.net'' you could set this to ``.probe.net''.\n\
#\n\
");
    (void) fprintf(fp, "%s", "\
# If you leave this commented out, the default behavior is to attempt to\n\
# lookup the current domain, and exclude hosts for it.  Otherwise, set it\n\
# to a list of comma-delimited domains or hostnames.  The special token\n\
# ``localdomain'' is used for unqualified hostnames, so if you want hosts\n\
# without explicit domain names to avoid the firewall, be sure to include\n\
# that in your list.\n\
#\n\
");

    if (cp != NULL) {
        (void) fprintf(fp, "firewall-exception-list=%s,localhost,localdomain\n", cp);
    } else {
        (void) fprintf(fp, "firewall-exception-list=.probe.net,localhost,foo.bar.com,localdomain\n");
    }

    (void) fprintf(fp, "%s", "\
#\n\
#\n\
#\n\
# You may also specify passive mode here.  Normally this is set in the\n\
# regular $HOME/.ncftp/prefs file.  This must be set to one of\n\
# \"on\", \"off\", or \"optional\", which mean always use PASV,\n\
# always use PORT, and try PASV then PORT, respectively.\n\
#\n\
#passive=on\n");

    time(&now);
    (void) fprintf(fp, "\
#\n\
#\n\
#\n\
# NOTE:  This file was created for you on %s\
#        by NcFTP %.5s.  Removing this file will cause the next run of NcFTP\n\
#        to generate a new one, possibly with more configurable options.\n",
    ctime(&now),
    gVersion + 11);
    (void) fprintf(fp, "\
#\n\
# ALSO:  A %s file, if present, is processed before this file,\n\
#        and a %s file, if present, is processed after.\n",
        kGlobalFirewallPrefFileName,
        kGlobalFixedFirewallPrefFileName
    );
}   /* CreateDefaultFirewallPrefs */

Referenced by DumpFirewallPrefsTemplate(), and LoadFirewallPrefs().