shell.c File Reference

#include "syshdrs.h"
#include "shell.h"
#include "util.h"
#include "bookmark.h"
#include "cmds.h"
#include "readln.h"
#include "trace.h"
#include "main.h"

Include dependency graph for shell.c:

Go to the source code of this file.

Functions
static int	CommandSortCmp (const CommandPtr a, const CommandPtr b)
void	InitCommandList (void)
static int	CommandExactSearchCmp (const char *const key, const CommandPtr b)
static int	CommandSubSearchCmp (const char *const key, const CommandPtr a)
CommandPtr	GetCommandByIndex (const int i)
CommandPtr	GetCommandByName (const char *const name, int wantExactMatch)
void	PrintCmdHelp (CommandPtr c)
void	PrintCmdUsage (CommandPtr c)
int	MakeArgv (char *line, int *cargc, const char **cargv, int cargcmax, char *dbuf, size_t dbufsize, int *noglobargv, int readlineHacks)
static int	DoCommand (const ArgvInfoPtr aip)
void	XferCanceller (int sigNum)
void	BackToTop (int sigNum)
void	Cancel (int sigNum)
void	CommandShell (void)

Variables
int	gDoneApplication = 0
int	gNumInterruptions = 0
int	gEventNumber = 0
jmp_buf	gCancelJmp
jmp_buf	gBackToTopJmp
int	gMayCancelJmp = 0
int	gMayBackToTopJmp = 0
int	gGotSig = 0
int	gRunningCommand = 0
int	gCancelCtrl = 0
Command	gCommands []
size_t	gNumCommands
int	gStartupUrlParameterGiven
FTPLibraryInfo	gLib
FTPConnectionInfo	gConn
LineList	gStartupURLCdList
int	gNumProgramRuns
char	gCopyright []

Function Documentation

BackToTop()

void BackToTop

(

int

sigNum

)

Definition at line 452 of file shell.c.

{
    gGotSig = sigNum;
    if (sigNum == SIGPIPE) {
        if (gRunningCommand == 1) {
            (void) fprintf(stderr, "Unexpected broken pipe.\n");
            gRunningCommand = 0;
        } else {
            SetXtermTitle("RESTORE");
            exit(1);
        }
    } else if (sigNum == SIGINT) {
        if (gRunningCommand == 0)
            gDoneApplication = 1;
    }
    if (gMayBackToTopJmp > 0) {
#ifdef HAVE_SIGSETJMP
        siglongjmp(gBackToTopJmp, 1);
#else   /* HAVE_SIGSETJMP */
        longjmp(gBackToTopJmp, 1);
#endif  /* HAVE_SIGSETJMP */
    }
}   /* BackToTop */

Referenced by CommandShell().

Cancel()

void Cancel

(

int

sigNum

)

Definition at line 481 of file shell.c.

{
    if (gMayCancelJmp != 0) {
        gGotSig = sigNum;
        gMayCancelJmp = 0;
#ifdef HAVE_SIGSETJMP
        siglongjmp(gCancelJmp, 1);
#else   /* HAVE_SIGSETJMP */
        longjmp(gCancelJmp, 1);
#endif  /* HAVE_SIGSETJMP */
    }
}   /* Cancel */

Referenced by CreatePartitionPage(), DECLARE_INTERFACE_(), DECLSPEC_ALIGN(), ListCmd(), LocalListCmd(), PageCmd(), and ShowPartitionSizeInputBox().

CommandExactSearchCmp()

static int CommandExactSearchCmp ( const char *const  key, const CommandPtr  b  )

static

Definition at line 102 of file shell.c.

{
    return (strcmp(key, (*b).name));
}   /* CommandExactSearchCmp */

Referenced by GetCommandByName().

CommandShell()

void CommandShell

(

void

)

Definition at line 499 of file shell.c.

{
    int tUsed, bUsed;
    ArgvInfo ai;
    char prompt[64];
    char *lineRead;
#if defined(WIN32) || defined(_WINDOWS)
#else
    int sj;
#endif
    time_t cmdStart, cmdStop;
 
    /* Execution may jump back to this point to restart the shell. */
#if defined(WIN32) || defined(_WINDOWS)
 
#elif defined(HAVE_SIGSETJMP)
    sj = sigsetjmp(gBackToTopJmp, 1);
#else   /* HAVE_SIGSETJMP */
    sj = setjmp(gBackToTopJmp);
#endif  /* HAVE_SIGSETJMP */
 
#if defined(WIN32) || defined(_WINDOWS)
#else
    if (sj != 0) {
        Trace(0, "Caught signal %d, back at top.\n", gGotSig);
        if (gGotSig == SIGALRM) {
            (void) printf("\nRemote host was not responding, closing down the session.");
            FTPShutdownHost(&gConn);
        } else{
            (void) printf("\nInterrupted.\n");
            if (gCancelCtrl != 0) {
                gCancelCtrl = 0;
                (void) printf("Closing down the current FTP session: ");
                FTPShutdownHost(&gConn);
                (void) sleep(1);
                (void) printf("done.\n");
            }
        }
    }
 
    gMayBackToTopJmp = 1;
#endif
 
 
    ++gEventNumber;
 
    while (gDoneApplication == 0) {
#if defined(WIN32) || defined(_WINDOWS)
#else
        (void) NcSignal(SIGINT, BackToTop);
        (void) NcSignal(SIGPIPE, BackToTop);
        (void) NcSignal(SIGALRM, BackToTop);
#endif
 
        MakePrompt(prompt, sizeof(prompt));
 
        if (gConn.connected == 0) {
            SetXtermTitle("DEFAULT");
        } else {
            SetXtermTitle("%s - NcFTP", gConn.host);
        }
 
        lineRead = Readline(prompt);
        if (lineRead == NULL) {
            /* EOF, Control-D */
            (void) printf("\n");
            break;
        }
        Trace(0, "> %s\n", lineRead);
        AddHistory(lineRead);
        for (tUsed = 0;;) {
            (void) memset(&ai, 0, sizeof(ai));
            bUsed = MakeArgv(lineRead + tUsed, &ai.cargc, ai.cargv,
                (int) (sizeof(ai.cargv) / sizeof(char *)),
                ai.argbuf, sizeof(ai.argbuf),
                ai.noglobargv, 0);
            if (bUsed <= 0)
                break;
            tUsed += bUsed;
            if (ai.cargc == 0)
                continue;
            gRunningCommand = 1;
            (void) time(&cmdStart);
            if (DoCommand(&ai) < 0) {
                (void) time(&cmdStop);
                gRunningCommand = 0;
                break;
            }
            (void) time(&cmdStop);
            gRunningCommand = 0;
            if ((cmdStop - cmdStart) > kBeepAfterCmdTime) {
                /* Let the user know that a time-consuming
                 * operation has completed.
                 */
#if defined(WIN32) || defined(_WINDOWS)
                MessageBeep(MB_OK);
#else
                (void) fprintf(stderr, "\007");
#endif
            }
            ++gEventNumber;
        }
 
        free(lineRead);
    }
 
    CloseHost();
    gMayBackToTopJmp = 0;
}   /* Shell */

Referenced by main().

CommandSortCmp()

static int CommandSortCmp ( const CommandPtr  a, const CommandPtr  b  )

static

Definition at line 80 of file shell.c.

{
    return (strcmp((*a).name, (*b).name));
}   /* CommandSortCmp */

Referenced by InitCommandList().

CommandSubSearchCmp()

static int CommandSubSearchCmp ( const char *const  key, const CommandPtr  a  )

static

Definition at line 116 of file shell.c.

{
    register const char *kcp, *cp;
    int d;
 
    for (cp = (*a).name, kcp = key; ; ) {
        if (*kcp == 0)
            break;
        d = *kcp++ - *cp++;
        if (d)
            return d;
    }
    return (0);
}   /* CommandSubSearchCmp */

Referenced by GetCommandByName().

DoCommand()

static int DoCommand ( const ArgvInfoPtr  aip )

static

Definition at line 381 of file shell.c.

{
    CommandPtr cmdp;
    int flags;
    int cargc, cargcm1;
 
    cmdp = GetCommandByName(aip->cargv[0], 0);
    if (cmdp == kAmbiguousCommand) {
        (void) printf("%s: ambiguous command name.\n", aip->cargv[0]);
        return (-1);
    } else if (cmdp == kNoCommand) {
        (void) printf("%s: no such command.\n", aip->cargv[0]);
        return (-1);
    }
 
    cargc = aip->cargc;
    cargcm1 = cargc - 1;
    flags = cmdp->flags;
 
    if (((flags & kCmdMustBeConnected) != 0) && (gConn.connected == 0)) {
        (void) printf("%s: must be connected to do that.\n", aip->cargv[0]);
    } else if (((flags & kCmdMustBeDisconnected) != 0) && (gConn.connected != 0)) {
        (void) printf("%s: must be disconnected to do that.\n", aip->cargv[0]);
    } else if ((cmdp->minargs != kNoMin) && (cmdp->minargs > cargcm1)) {
        PrintCmdUsage(cmdp);
    } else if ((cmdp->maxargs != kNoMax) && (cmdp->maxargs < cargcm1)) {
        PrintCmdUsage(cmdp);
    } else {
        (*cmdp->proc)(cargc, aip->cargv, cmdp, aip);
    }
    return (0);
}   /* DoCommand */

Referenced by CommandShell().

GetCommandByIndex()

CommandPtr GetCommandByIndex

(

const int

i

)

Definition at line 140 of file shell.c.

{
    if ((i < 0) || (i >= (int) gNumCommands))
        return (kNoCommand);
    return (&gCommands[i]);
}                                      /* GetCommandByIndex */

Referenced by CommandCompletionFunction().

GetCommandByName()

CommandPtr GetCommandByName	(	const char *const	name,
		int	wantExactMatch
	)

Definition at line 156 of file shell.c.

{
    CommandPtr canp, canp2;
 
    /* First check for an exact match.  Otherwise if you if asked for
     * 'cd', it would match both 'cd' and 'cdup' and return an
     * ambiguous name error, despite having the exact name for 'cd.'
     */
    canp = (CommandPtr) bsearch(name, gCommands, gNumCommands, sizeof(Command), (bsearch_proc_t) CommandExactSearchCmp);
 
    if (canp == kNoCommand && !wantExactMatch) {
        /* Now see if the user typed an abbreviation unique enough
         * to match only one name in the list.
         */
        canp = (CommandPtr) bsearch(name, gCommands, gNumCommands, sizeof(Command), (bsearch_proc_t) CommandSubSearchCmp);
 
        if (canp != kNoCommand) {
            /* Check the entry above us and see if the name we're looking
             * for would match that, too.
             */
            if (canp != &gCommands[0]) {
                canp2 = canp - 1;
                if (CommandSubSearchCmp(name, canp2) == 0)
                    return kAmbiguousCommand;
            }
            /* Check the entry below us and see if the name we're looking
             * for would match that one.
             */
            if (canp != &gCommands[gNumCommands - 1]) {
                canp2 = canp + 1;
                if (CommandSubSearchCmp(name, canp2) == 0)
                    return kAmbiguousCommand;
            }
        }
    }
    return canp;
}                                      /* GetCommandByName */

Referenced by CompletionFunction(), DoCommand(), and HelpCmd().

InitCommandList()

void InitCommandList

(

void

)

Definition at line 90 of file shell.c.

{
    qsort(gCommands, gNumCommands, sizeof(Command), (qsort_proc_t) CommandSortCmp);
}   /* InitCommandList */

Referenced by PreInit().

MakeArgv()

int MakeArgv	(	char *	line,
		int *	cargc,
		const char **	cargv,
		int	cargcmax,
		char *	dbuf,
		size_t	dbufsize,
		int *	noglobargv,
		int	readlineHacks
	)

Definition at line 221 of file shell.c.

{
    int c;
    int retval;
    char *dlim;
    char *dcp;
    char *scp;
    char *arg;
 
    *cargc = 0;
    scp = line;
    dlim = dbuf + dbufsize - 1;
    dcp = dbuf;
 
    for (*cargc = 0; *cargc < cargcmax; ) {
        /* Eat preceding junk. */
        for ( ; ; scp++) {
            c = *scp;
            if (c == '\0')
                goto done;
            if (isspace(c))
                continue;
            if ((c == ';') || (c == '\n')) {
                scp++;
                goto done;
            }
            break;
        }
 
        arg = dcp;
        cargv[*cargc] = arg;
        noglobargv[*cargc] = 0;
        (*cargc)++;
 
        /* Special hack so that "!cmd" is always split into "!" "cmd" */
        if ((*cargc == 1) && (*scp == '!')) {
            if (scp[1] == '!') {
                scp[1] = '\0';
            } else if ((scp[1] != '\0') && (!isspace((int) scp[1]))) {
                cargv[0] = "!";
                scp++;
                arg = dcp;
                cargv[*cargc] = arg;
                noglobargv[*cargc] = 0;
                (*cargc)++;
            }
        }
 
        /* Add characters to the new argument. */
        for ( ; ; ) {
            c = *scp;
            if (c == '\0')
                break;
            if (isspace(c))
                break;
            if ((c == ';') || (c == '\n')) {
                break;
            }
 
            scp++;
 
            if (c == '\'') {
                for ( ; ; ) {
                    c = *scp++;
                    if (c == '\0') {
                        if (readlineHacks != 0)
                            break;
                        /* Syntax error */
                        (void) fprintf(stderr, "Error: Unbalanced quotes.\n");
                        return (-1);
                    }
                    if (c == '\'')
                        break;
 
                    /* Add char. */
                    if (dcp >= dlim)
                        goto toolong;
                    *dcp++ = c;
 
                    if (strchr(kGlobChars, c) != NULL) {
                        /* User quoted glob characters,
                         * so mark this argument for
                         * noglob.
                         */
                        noglobargv[*cargc - 1] = 1;
                    }
                }
            } else if (c == '"') {
                for ( ; ; ) {
                    c = *scp++;
                    if (c == '\0') {
                        if (readlineHacks != 0)
                            break;
                        /* Syntax error */
                        (void) fprintf(stderr, "Error: Unbalanced quotes.\n");
                        return (-1);
                    }
                    if (c == '"')
                        break;
 
                    /* Add char. */
                    if (dcp >= dlim)
                        goto toolong;
                    *dcp++ = c;
 
                    if (strchr(kGlobChars, c) != NULL) {
                        /* User quoted glob characters,
                         * so mark this argument for
                         * noglob.
                         */
                        noglobargv[*cargc - 1] = 1;
                    }
                }
            } else
#if defined(WIN32) || defined(_WINDOWS)
                if (c == '|') {
#else
                if (c == '\\') {
#endif
                /* Add next character, verbatim. */
                c = *scp++;
                if (c == '\0')
                    break;
 
                /* Add char. */
                if (dcp >= dlim)
                    goto toolong;
                *dcp++ = c;
            } else {
                /* Add char. */
                if (dcp >= dlim)
                    goto toolong;
                *dcp++ = c;
            }
        }
 
        *dcp++ = '\0';
    }
 
    (void) fprintf(stderr, "Error: Argument list too long.\n");
    *cargc = 0;
    cargv[*cargc] = NULL;
    return (-1);
 
done:
    retval = (int) (scp - line);
    cargv[*cargc] = NULL;
    return (retval);
 
toolong:
    (void) fprintf(stderr, "Error: Line too long.\n");
    *cargc = 0;
    cargv[*cargc] = NULL;
    return (-1);
}   /* MakeArgv */

Referenced by CommandShell(), and CompletionFunction().

PrintCmdHelp()

void PrintCmdHelp

(

CommandPtr

c

)

Definition at line 200 of file shell.c.

{
    (void) printf("%s: %s.\n", c->name, c->help);
}                                      /* PrintCmdHelp */

Referenced by HelpCmd().

PrintCmdUsage()

void PrintCmdUsage

(

CommandPtr

c

)

Definition at line 210 of file shell.c.

{
    if (c->usage != NULL)
        (void) printf("Usage: %s %s\n", c->name, c->usage);
}                                      /* PrintCmdUsage */

Referenced by ChdirCmd(), DeleteCmd(), DoCommand(), GetCmd(), HelpCmd(), ListCmd(), LocalListCmd(), LookupCmd(), MkdirCmd(), MlsCmd(), OpenCmd(), PutCmd(), RmdirCmd(), SpoolGetCmd(), and SpoolPutCmd().

XferCanceller()

void XferCanceller

(

int

sigNum

)

Definition at line 419 of file shell.c.

{
    gGotSig = sigNum;
    if (gConn.cancelXfer > 0) {
#if defined(WIN32) || defined(_WINDOWS)
        signal(SIGINT, SIG_DFL);
#else
        /* User already tried it once, they
         * must think it's locked up.
         *
         * Jump back to the top, and
         * close down the current session.
         */
        gCancelCtrl = 1;
        if (gMayBackToTopJmp > 0) {
#ifdef HAVE_SIGSETJMP
            siglongjmp(gBackToTopJmp, 1);
#else   /* HAVE_SIGSETJMP */
            longjmp(gBackToTopJmp, 1);
#endif  /* HAVE_SIGSETJMP */
        }
#endif
    }
    gConn.cancelXfer++;
}   /* XferCanceller */

Referenced by GetCmd(), and PutCmd().

Variable Documentation

gBackToTopJmp

jmp_buf gBackToTopJmp

Definition at line 50 of file shell.c.

Referenced by BackToTop(), CommandShell(), and XferCanceller().

gCancelCtrl

int gCancelCtrl = 0

Definition at line 66 of file shell.c.

Referenced by CommandShell(), and XferCanceller().

gCancelJmp

jmp_buf gCancelJmp

Definition at line 45 of file shell.c.

Referenced by Cancel(), ListCmd(), LocalListCmd(), and PageCmd().

gCommands

Command gCommands[]

extern

Definition at line 16 of file cmdlist.c.

Referenced by GetCommandByIndex(), GetCommandByName(), and InitCommandList().

gConn

FTPConnectionInfo gConn

extern

Definition at line 37 of file main.c.

Referenced by CommandShell(), DoCommand(), and XferCanceller().

gCopyright

char gCopyright[]

extern

Definition at line 17 of file version.c.

gDoneApplication

int gDoneApplication = 0

Definition at line 21 of file shell.c.

Referenced by BackToTop(), and CommandShell().

gEventNumber

int gEventNumber = 0

Definition at line 27 of file shell.c.

Referenced by CommandShell().

gGotSig

int gGotSig = 0

Definition at line 60 of file shell.c.

Referenced by BackToTop(), Cancel(), CommandShell(), and XferCanceller().

gLib

FTPLibraryInfo gLib

extern

Definition at line 36 of file main.c.

gMayBackToTopJmp

int gMayBackToTopJmp = 0

Definition at line 57 of file shell.c.

Referenced by BackToTop(), CommandShell(), and XferCanceller().

gMayCancelJmp

int gMayCancelJmp = 0

Definition at line 54 of file shell.c.

Referenced by Cancel(), ListCmd(), LocalListCmd(), and PageCmd().

gNumCommands

size_t gNumCommands

extern

Definition at line 525 of file cmdlist.c.

Referenced by GetCommandByIndex(), GetCommandByName(), and InitCommandList().

gNumInterruptions

int gNumInterruptions = 0

Definition at line 24 of file shell.c.

gNumProgramRuns

int gNumProgramRuns

extern

Definition at line 14 of file preffw.c.

Referenced by LoadFirewallPrefs().

gRunningCommand

int gRunningCommand = 0

Definition at line 63 of file shell.c.

Referenced by BackToTop(), and CommandShell().

gStartupURLCdList

LineList gStartupURLCdList

extern

Definition at line 38 of file main.c.

Referenced by OpenURL(), PreInit(), and SetStartupURL().

gStartupUrlParameterGiven

int gStartupUrlParameterGiven

extern

Definition at line 32 of file main.c.

Referenced by main().