317b0d2eea443ef97cd39b96e4dcbe5e8d953c51
[openafs.git] / src / cmd / cmd.c
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  *
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 #include <afsconfig.h>
11 #include <afs/param.h>
12
13 #include <roken.h>
14
15 #include <ctype.h>
16 #include <assert.h>
17
18 #include "cmd.h"
19
20 /* declaration of private token type */
21 struct cmd_token {
22     struct cmd_token *next;
23     char *key;
24 };
25
26 static struct cmd_item dummy;           /* non-null ptr used for flag existence */
27 static struct cmd_syndesc *allSyntax = 0;
28 static int noOpcodes = 0;
29 static int (*beforeProc) (struct cmd_syndesc * ts, void *beforeRock) = NULL;
30 static int (*afterProc) (struct cmd_syndesc * ts, void *afterRock) = NULL;
31 static int enablePositional = 1;
32 static int enableAbbreviation = 1;
33 static void *beforeRock, *afterRock;
34 static char initcmd_opcode[] = "initcmd";       /*Name of initcmd opcode */
35 static cmd_config_section *globalConfig = NULL;
36 static const char *commandName = NULL;
37
38 /* take name and string, and return null string if name is empty, otherwise return
39    the concatenation of the two strings */
40 static char *
41 NName(char *a1, char *a2)
42 {
43     static char tbuffer[300];
44     if (strlen(a1) == 0) {
45         return "";
46     } else {
47         strlcpy(tbuffer, a1, sizeof(tbuffer));
48         strlcat(tbuffer, a2, sizeof(tbuffer));
49         return tbuffer;
50     }
51 }
52
53 /* return true if asub is a substring of amain */
54 static int
55 SubString(char *amain, char *asub)
56 {
57     int mlen, slen;
58     int i, j;
59     mlen = (int) strlen(amain);
60     slen = (int) strlen(asub);
61     j = mlen - slen;
62     if (j < 0)
63         return 0;               /* not a substring */
64     for (i = 0; i <= j; i++) {
65         if (strncmp(amain, asub, slen) == 0)
66             return 1;
67         amain++;
68     }
69     return 0;                   /* didn't find it */
70 }
71
72 static int
73 FindType(struct cmd_syndesc *as, char *aname)
74 {
75     int i;
76     size_t cmdlen;
77     int ambig;
78     int best;
79     struct cmd_item *alias;
80
81     /* Allow --long-style options. */
82     if (aname[0] == '-' && aname[1] == '-' && aname[2] && aname[3]) {
83         aname++;
84     }
85
86     cmdlen = strlen(aname);
87     ambig = 0;
88     best = -1;
89     for (i = 0; i < CMD_MAXPARMS; i++) {
90         if (as->parms[i].type == 0)
91             continue;           /* this slot not set (seeked over) */
92         if (strcmp(as->parms[i].name, aname) == 0)
93             return i;
94         if (strlen(as->parms[i].name) < cmdlen)
95             continue;
96
97         /* Check for aliases, which must be full matches */
98         alias = as->parms[i].aliases;
99         while (alias != NULL) {
100             if (strcmp(alias->data, aname) == 0)
101                 return i;
102             alias = alias->next;
103         }
104
105         /* A hidden option, or one which cannot be abbreviated,
106          * must be a full match (no best matches) */
107         if (as->parms[i].flags & CMD_HIDE ||
108             as->parms[i].flags & CMD_NOABBRV ||
109             !enableAbbreviation)
110             continue;
111
112         if (strncmp(as->parms[i].name, aname, cmdlen) == 0) {
113             if (best != -1)
114                 ambig = 1;
115             else
116                 best = i;
117         }
118     }
119     return (ambig ? -1 : best);
120 }
121
122 static struct cmd_syndesc *
123 FindSyntax(char *aname, int *aambig)
124 {
125     struct cmd_syndesc *ts;
126     struct cmd_syndesc *best;
127     size_t cmdLen;
128     int ambig;
129
130     cmdLen = strlen(aname);
131     best = (struct cmd_syndesc *)0;
132     ambig = 0;
133     if (aambig)
134         *aambig = 0;            /* initialize to unambiguous */
135     for (ts = allSyntax; ts; ts = ts->next) {
136         if (strcmp(aname, ts->name) == 0)
137             return (ts);
138         if (strlen(ts->name) < cmdLen)
139             continue;           /* we typed more than item has */
140         /* A hidden command must be a full match (no best matches) */
141         if (ts->flags & CMD_HIDDEN)
142             continue;
143
144         /* This is just an alias for *best, or *best is just an alias for us.
145          * If we don't make this check explicitly, then an alias which is just a
146          * short prefix of the real command's name might make things ambiguous
147          * for no apparent reason.
148          */
149         if (best && ts->aliasOf == best->aliasOf)
150             continue;
151         if (strncmp(ts->name, aname, cmdLen) == 0) {
152             if (best)
153                 ambig = 1;      /* ambiguous name */
154             else
155                 best = ts;
156         }
157     }
158     if (ambig) {
159         if (aambig)
160             *aambig = ambig;    /* if ambiguous and they care, tell them */
161         return (struct cmd_syndesc *)0; /* fails */
162     } else
163         return best;            /* otherwise its not ambiguous, and they know */
164 }
165
166 /* print the help for a single parameter */
167 static char *
168 ParmHelpString(struct cmd_parmdesc *aparm)
169 {
170     char *str;
171     if (aparm->type == CMD_FLAG) {
172         return strdup("");
173     } else {
174         asprintf(&str, " %s<%s>%s%s",
175                  aparm->type == CMD_SINGLE_OR_FLAG?"[":"",
176                  aparm->help?aparm->help:"arg",
177                  aparm->type == CMD_LIST?"+":"",
178                  aparm->type == CMD_SINGLE_OR_FLAG?"]":"");
179         return str;
180     }
181 }
182
183 extern char *AFSVersion;
184
185 static int
186 VersionProc(struct cmd_syndesc *as, void *arock)
187 {
188     printf("%s\n", AFSVersion);
189     return 0;
190 }
191
192 void
193 PrintSyntax(struct cmd_syndesc *as)
194 {
195     int i;
196     struct cmd_parmdesc *tp;
197     char *str;
198     char *name;
199     size_t len;
200     size_t xtralen;
201
202     /* now print usage, from syntax table */
203     if (noOpcodes)
204         asprintf(&str, "Usage: %s", as->a0name);
205     else {
206         if (!strcmp(as->name, initcmd_opcode))
207             asprintf(&str, "Usage: %s[%s]", NName(as->a0name, " "), as->name);
208         else
209             asprintf(&str, "Usage: %s%s", NName(as->a0name, " "), as->name);
210     }
211
212     len = strlen(str);
213     printf("%s", str);
214     free(str);
215
216     for (i = 0; i < CMD_MAXPARMS; i++) {
217         tp = &as->parms[i];
218         if (tp->type == 0)
219             continue;           /* seeked over slot */
220         if (tp->flags & CMD_HIDE)
221             continue;           /* skip hidden options */
222
223         /* The parameter name is the real name, plus any aliases */
224         if (!tp->aliases) {
225             name = strdup(tp->name);
226         } else {
227             size_t namelen;
228             struct cmd_item *alias;
229             namelen = strlen(tp->name) + 1;
230             for (alias = tp->aliases; alias != NULL; alias = alias->next)
231                 namelen+=strlen(alias->data) + 3;
232
233             name = malloc(namelen);
234             strlcpy(name, tp->name, namelen);
235
236             for (alias = tp->aliases; alias != NULL; alias = alias->next) {
237                 strlcat(name, " | ", namelen);
238                 strlcat(name, alias->data, namelen);
239             }
240         }
241
242         /* Work out if we can fit what we want to on this line, or if we need to
243          * start a new one */
244         str = ParmHelpString(tp);
245         xtralen = 1 + strlen(name) + strlen(str) +
246                   ((tp->flags & CMD_OPTIONAL)? 2: 0);
247
248         if (len + xtralen > 78) {
249             printf("\n        ");
250             len = 8;
251         }
252
253         printf(" %s%s%s%s",
254                tp->flags & CMD_OPTIONAL?"[":"",
255                name,
256                str,
257                tp->flags & CMD_OPTIONAL?"]":"");
258         free(str);
259         free(name);
260         len+=xtralen;
261     }
262     printf("\n");
263 }
264
265 /* must print newline in any case, to terminate preceding line */
266 static void
267 PrintAliases(struct cmd_syndesc *as)
268 {
269     struct cmd_syndesc *ts;
270
271     if (as->flags & CMD_ALIAS) {
272         ts = as->aliasOf;
273         printf("(alias for %s)\n", ts->name);
274     } else {
275         printf("\n");
276         if (!as->nextAlias)
277             return;             /* none, print nothing */
278         printf("aliases: ");
279         for (as = as->nextAlias; as; as = as->nextAlias) {
280             printf("%s ", as->name);
281         }
282         printf("\n");
283     }
284 }
285
286 void
287 PrintFlagHelp(struct cmd_syndesc *as)
288 {
289     int i;
290     struct cmd_parmdesc *tp;
291     int flag_width;
292     char *flag_prefix;
293
294     /* find flag name length */
295     flag_width = 0;
296     for (i = 0; i < CMD_MAXPARMS; i++) {
297         if (i == CMD_HELPPARM)
298             continue;
299         tp = &as->parms[i];
300         if (tp->type != CMD_FLAG)
301             continue;
302         if (tp->flags & CMD_HIDE)
303             continue;           /* skip hidden options */
304         if (!tp->help)
305             continue;
306
307         if (strlen(tp->name) > flag_width)
308             flag_width = strlen(tp->name);
309     }
310
311     /* print flag help */
312     flag_prefix = "Where:";
313     for (i = 0; i < CMD_MAXPARMS; i++) {
314         if (i == CMD_HELPPARM)
315             continue;
316         tp = &as->parms[i];
317         if (tp->type != CMD_FLAG)
318             continue;
319         if (tp->flags & CMD_HIDE)
320             continue;           /* skip hidden options */
321         if (!tp->help)
322             continue;
323
324         printf("%-7s%-*s  %s\n", flag_prefix, flag_width, tp->name, tp->help);
325         flag_prefix = "";
326     }
327 }
328
329 static int
330 AproposProc(struct cmd_syndesc *as, void *arock)
331 {
332     struct cmd_syndesc *ts;
333     char *tsub;
334     int didAny;
335
336     didAny = 0;
337     tsub = as->parms[0].items->data;
338     for (ts = allSyntax; ts; ts = ts->next) {
339         if ((ts->flags & CMD_ALIAS) || (ts->flags & CMD_HIDDEN))
340             continue;
341         if (SubString(ts->help, tsub)) {
342             printf("%s: %s\n", ts->name, ts->help);
343             didAny = 1;
344         } else if (SubString(ts->name, tsub)) {
345             printf("%s: %s\n", ts->name, ts->help);
346             didAny = 1;
347         }
348     }
349     if (!didAny)
350         printf("Sorry, no commands found\n");
351     return 0;
352 }
353
354 static int
355 HelpProc(struct cmd_syndesc *as, void *arock)
356 {
357     struct cmd_syndesc *ts;
358     struct cmd_item *ti;
359     int ambig;
360     int code = 0;
361
362     if (as->parms[0].items == 0) {
363         printf("%sCommands are:\n", NName(as->a0name, ": "));
364         for (ts = allSyntax; ts; ts = ts->next) {
365             if ((ts->flags & CMD_ALIAS) || (ts->flags & CMD_HIDDEN))
366                 continue;
367             printf("%-15s %s\n", ts->name, (ts->help ? ts->help : ""));
368         }
369     } else {
370         /* print out individual help topics */
371         for (ti = as->parms[0].items; ti; ti = ti->next) {
372             code = 0;
373             ts = FindSyntax(ti->data, &ambig);
374             if (ts && (ts->flags & CMD_HIDDEN))
375                 ts = 0;         /* no hidden commands */
376             if (ts) {
377                 /* print out command name and help */
378                 printf("%s%s: %s ", NName(as->a0name, " "), ts->name,
379                        (ts->help ? ts->help : ""));
380                 ts->a0name = as->a0name;
381                 PrintAliases(ts);
382                 PrintSyntax(ts);
383                 PrintFlagHelp(ts);
384             } else {
385                 if (!ambig)
386                     fprintf(stderr, "%sUnknown topic '%s'\n",
387                             NName(as->a0name, ": "), ti->data);
388                 else {
389                     /* ambiguous, list 'em all */
390                     fprintf(stderr,
391                             "%sAmbiguous topic '%s'; use 'apropos' to list\n",
392                             NName(as->a0name, ": "), ti->data);
393                 }
394                 code = CMD_UNKNOWNCMD;
395             }
396         }
397     }
398     return (code);
399 }
400
401 int
402 cmd_SetBeforeProc(int (*aproc) (struct cmd_syndesc * ts, void *beforeRock),
403                   void *arock)
404 {
405     beforeProc = aproc;
406     beforeRock = arock;
407     return 0;
408 }
409
410 int
411 cmd_SetAfterProc(int (*aproc) (struct cmd_syndesc * ts, void *afterRock),
412                  void *arock)
413 {
414     afterProc = aproc;
415     afterRock = arock;
416     return 0;
417 }
418
419 /* thread on list in alphabetical order */
420 static int
421 SortSyntax(struct cmd_syndesc *as)
422 {
423     struct cmd_syndesc **ld, *ud;
424
425     for (ld = &allSyntax, ud = *ld; ud; ld = &ud->next, ud = *ld) {
426         if (strcmp(ud->name, as->name) > 0) {   /* next guy is bigger than us */
427             break;
428         }
429     }
430     /* thread us on the list now */
431     *ld = as;
432     as->next = ud;
433     return 0;
434 }
435
436 struct cmd_syndesc *
437 cmd_CreateSyntax(char *aname,
438                  int (*aproc) (struct cmd_syndesc * ts, void *arock),
439                  void *arock, char *ahelp)
440 {
441     struct cmd_syndesc *td;
442
443     /* can't have two cmds in no opcode mode */
444     if (noOpcodes)
445         return NULL;
446
447     td = calloc(1, sizeof(struct cmd_syndesc));
448     assert(td);
449     td->aliasOf = td;           /* treat aliasOf as pointer to real command, no matter what */
450
451     /* copy in name, etc */
452     if (aname) {
453         td->name = strdup(aname);
454         assert(td->name);
455     } else {
456         td->name = NULL;
457         noOpcodes = 1;
458     }
459     if (ahelp) {
460         /* Piggy-back the hidden option onto the help string */
461         if (ahelp == (char *)CMD_HIDDEN) {
462             td->flags |= CMD_HIDDEN;
463         } else {
464             td->help = strdup(ahelp);
465             assert(td->help);
466         }
467     } else
468         td->help = NULL;
469     td->proc = aproc;
470     td->rock = arock;
471
472     SortSyntax(td);
473
474     cmd_Seek(td, CMD_HELPPARM);
475     cmd_AddParm(td, "-help", CMD_FLAG, CMD_OPTIONAL, "get detailed help");
476     cmd_Seek(td, 0);
477
478     return td;
479 }
480
481 int
482 cmd_CreateAlias(struct cmd_syndesc *as, char *aname)
483 {
484     struct cmd_syndesc *td;
485
486     td = malloc(sizeof(struct cmd_syndesc));
487     assert(td);
488     memcpy(td, as, sizeof(struct cmd_syndesc));
489     td->name = strdup(aname);
490     assert(td->name);
491     td->flags |= CMD_ALIAS;
492     /* if ever free things, make copy of help string, too */
493
494     /* thread on list */
495     SortSyntax(td);
496
497     /* thread on alias lists */
498     td->nextAlias = as->nextAlias;
499     as->nextAlias = td;
500     td->aliasOf = as;
501
502     return 0;                   /* all done */
503 }
504
505 void
506 cmd_DisablePositionalCommands(void)
507 {
508     enablePositional = 0;
509 }
510
511 void
512 cmd_DisableAbbreviations(void)
513 {
514     enableAbbreviation = 0;
515 }
516
517 int
518 cmd_Seek(struct cmd_syndesc *as, int apos)
519 {
520     if (apos >= CMD_MAXPARMS)
521         return CMD_EXCESSPARMS;
522     as->nParms = apos;
523     return 0;
524 }
525
526 int
527 cmd_AddParmAtOffset(struct cmd_syndesc *as, int ref, char *aname, int atype,
528                     afs_int32 aflags, char *ahelp)
529 {
530     struct cmd_parmdesc *tp;
531
532     if (ref >= CMD_MAXPARMS)
533         return CMD_EXCESSPARMS;
534     tp = &as->parms[ref];
535
536     tp->name = strdup(aname);
537     assert(tp->name);
538     tp->type = atype;
539     tp->flags = aflags;
540     tp->items = NULL;
541     if (ahelp) {
542         tp->help = strdup(ahelp);
543         assert(tp->help);
544     } else
545         tp->help = NULL;
546
547     tp->aliases = NULL;
548
549     if (as->nParms <= ref)
550         as->nParms = ref+1;
551
552     return 0;
553 }
554
555 int
556 cmd_AddParm(struct cmd_syndesc *as, char *aname, int atype,
557             afs_int32 aflags, char *ahelp)
558 {
559     if (as->nParms >= CMD_MAXPARMS)
560         return CMD_EXCESSPARMS;
561
562     return cmd_AddParmAtOffset(as, as->nParms++, aname, atype, aflags, ahelp);
563 }
564
565 int
566 cmd_AddParmAlias(struct cmd_syndesc *as, int pos, char *alias)
567 {
568     struct cmd_item *item;
569
570     if (pos > as->nParms)
571         return CMD_EXCESSPARMS;
572
573     item = calloc(1, sizeof(struct cmd_item));
574     item->data = strdup(alias);
575     item->next = as->parms[pos].aliases;
576     as->parms[pos].aliases = item;
577
578     return 0;
579 }
580
581 /* add a text item to the end of the parameter list */
582 static int
583 AddItem(struct cmd_parmdesc *aparm, char *aval, char *pname)
584 {
585     struct cmd_item *ti, *ni;
586
587     if (aparm->type == CMD_SINGLE ||
588         aparm->type == CMD_SINGLE_OR_FLAG) {
589         if (aparm->items) {
590             fprintf(stderr, "%sToo many values after switch %s\n",
591                     NName(pname, ": "), aparm->name);
592             return CMD_NOTLIST;
593         }
594     }
595
596     ti = calloc(1, sizeof(struct cmd_item));
597     assert(ti);
598     ti->data = strdup(aval);
599     assert(ti->data);
600     /* now put ti at the *end* of the list */
601     if ((ni = aparm->items)) {
602         for (; ni; ni = ni->next)
603             if (ni->next == 0)
604                 break;          /* skip to last one */
605         ni->next = ti;
606     } else
607         aparm->items = ti;      /* we're first */
608     return 0;
609 }
610
611 /* skip to next non-flag item, if any */
612 static int
613 AdvanceType(struct cmd_syndesc *as, afs_int32 aval)
614 {
615     afs_int32 next;
616     struct cmd_parmdesc *tp;
617
618     /* first see if we should try to grab rest of line for this dude */
619     if (as->parms[aval].flags & CMD_EXPANDS)
620         return aval;
621
622     /* if not, find next non-flag used slot */
623     for (next = aval + 1; next < CMD_MAXPARMS; next++) {
624         tp = &as->parms[next];
625         if (tp->type != 0 && tp->type != CMD_FLAG)
626             return next;
627     }
628     return aval;
629 }
630
631 /* discard parameters filled in by dispatch */
632 static void
633 ResetSyntax(struct cmd_syndesc *as)
634 {
635     int i;
636     struct cmd_parmdesc *tp;
637     struct cmd_item *ti, *ni;
638
639     tp = as->parms;
640     for (i = 0; i < CMD_MAXPARMS; i++, tp++) {
641         switch (tp->type) {
642         case CMD_SINGLE_OR_FLAG:
643             if (tp->items == &dummy)
644                 break;
645             /* Deliberately fall through here */
646         case CMD_SINGLE:
647         case CMD_LIST:
648             /* free whole list in both cases, just for fun */
649             for (ti = tp->items; ti; ti = ni) {
650                 ni = ti->next;
651                 free(ti->data);
652                 free(ti);
653             }
654             break;
655
656         default:
657             break;
658         }
659         tp->items = NULL;
660     }
661 }
662
663 /* move the expands flag to the last one in the list */
664 static int
665 SetupExpandsFlag(struct cmd_syndesc *as)
666 {
667     struct cmd_parmdesc *tp;
668     int last, i;
669
670     last = -1;
671     /* find last CMD_LIST type parameter, optional or not, and make it expandable
672      * if no other dude is expandable */
673     for (i = 0; i < CMD_MAXPARMS; i++) {
674         tp = &as->parms[i];
675         if (tp->type == CMD_LIST) {
676             if (tp->flags & CMD_EXPANDS)
677                 return 0;       /* done if already specified */
678             last = i;
679         }
680     }
681     if (last >= 0)
682         as->parms[last].flags |= CMD_EXPANDS;
683     return 0;
684 }
685
686 /* Take the current argv & argc and alter them so that the initialization
687  * opcode is made to appear.  This is used in cases where the initialization
688  * opcode is implicitly invoked.*/
689 static char **
690 InsertInitOpcode(int *aargc, char **aargv)
691 {
692     char **newargv;             /*Ptr to new, expanded argv space */
693     char *pinitopcode;          /*Ptr to space for name of init opcode */
694     int i;                      /*Loop counter */
695
696     /* Allocate the new argv array, plus one for the new opcode, plus one
697      * more for the trailing null pointer */
698     newargv = malloc(((*aargc) + 2) * sizeof(char *));
699     if (!newargv) {
700         fprintf(stderr, "%s: Can't create new argv array with %d+2 slots\n",
701                 aargv[0], *aargc);
702         return (NULL);
703     }
704
705     /* Create space for the initial opcode & fill it in */
706     pinitopcode = strdup(initcmd_opcode);
707     if (!pinitopcode) {
708         fprintf(stderr, "%s: Can't malloc initial opcode space\n", aargv[0]);
709         free(newargv);
710         return (NULL);
711     }
712
713     /* Move all the items in the old argv into the new argv, in their
714      * proper places */
715     for (i = *aargc; i > 1; i--)
716         newargv[i] = aargv[i - 1];
717
718     /* Slip in the opcode and the trailing null pointer, and bump the
719      * argument count up by one for the new opcode */
720     newargv[0] = aargv[0];
721     newargv[1] = pinitopcode;
722     (*aargc)++;
723     newargv[*aargc] = NULL;
724
725     /* Return the happy news */
726     return (newargv);
727
728 }                               /*InsertInitOpcode */
729
730 static int
731 NoParmsOK(struct cmd_syndesc *as)
732 {
733     int i;
734     struct cmd_parmdesc *td;
735
736     for (i = 0; i < CMD_MAXPARMS; i++) {
737         td = &as->parms[i];
738         if (td->type != 0 && !(td->flags & CMD_OPTIONAL)) {
739             /* found a non-optional (e.g. required) parm, so NoParmsOK
740              * is false (some parms are required) */
741             return 0;
742         }
743     }
744     return 1;
745 }
746
747 /* Add help, apropos commands once */
748 static void
749 initSyntax(void)
750 {
751     struct cmd_syndesc *ts;
752
753     if (!noOpcodes) {
754         ts = cmd_CreateSyntax("help", HelpProc, NULL,
755                               "get help on commands");
756         cmd_AddParm(ts, "-topic", CMD_LIST, CMD_OPTIONAL, "help string");
757
758         ts = cmd_CreateSyntax("apropos", AproposProc, NULL,
759                               "search by help text");
760         cmd_AddParm(ts, "-topic", CMD_SINGLE, CMD_REQUIRED, "help string");
761
762         cmd_CreateSyntax("version", VersionProc, NULL,
763                          "show version");
764         cmd_CreateSyntax("-version", VersionProc, NULL,
765                          (char *)CMD_HIDDEN);
766         cmd_CreateSyntax("-help", HelpProc, NULL,
767                          (char *)CMD_HIDDEN);
768         cmd_CreateSyntax("--version", VersionProc, NULL,
769                          (char *)CMD_HIDDEN);
770         cmd_CreateSyntax("--help", HelpProc, NULL,
771                          (char *)CMD_HIDDEN);
772     }
773 }
774
775 /* Call the appropriate function, or return syntax error code.  Note: if
776  * no opcode is specified, an initialization routine exists, and it has
777  * NOT been called before, we invoke the special initialization opcode
778  */
779 int
780 cmd_Parse(int argc, char **argv, struct cmd_syndesc **outsyntax)
781 {
782     char *pname;
783     struct cmd_syndesc *ts = NULL;
784     struct cmd_parmdesc *tparm;
785     int i;
786     int curType;
787     int positional;
788     int ambig;
789     int code = 0;
790     char *param = NULL;
791     char *embeddedvalue = NULL;
792     static int initd = 0;       /*Is this the first time this routine has been called? */
793     static int initcmdpossible = 1;     /*Should be consider parsing the initial command? */
794
795     *outsyntax = NULL;
796
797     if (!initd) {
798         initd = 1;
799         initSyntax();
800     }
801
802     /*Remember the program name */
803     pname = argv[0];
804
805     if (noOpcodes) {
806         if (argc == 1) {
807             if (!NoParmsOK(allSyntax)) {
808                 printf("%s: Type '%s -help' for help\n", pname, pname);
809                 code = CMD_USAGE;
810                 goto out;
811             }
812         }
813     } else {
814         if (argc < 2) {
815             /* if there is an initcmd, don't print an error message, just
816              * setup to use the initcmd below. */
817             if (!(initcmdpossible && FindSyntax(initcmd_opcode, NULL))) {
818                 printf("%s: Type '%s help' or '%s help <topic>' for help\n",
819                        pname, pname, pname);
820                 code = CMD_USAGE;
821                 goto out;
822             }
823         }
824     }
825
826     /* Find the syntax descriptor for this command, doing prefix matching properly */
827     if (noOpcodes) {
828         ts = allSyntax;
829     } else {
830         ts = (argc < 2 ? 0 : FindSyntax(argv[1], &ambig));
831         if (!ts) {
832             /*First token doesn't match a syntax descriptor */
833             if (initcmdpossible) {
834                 /*If initial command line handling hasn't been done yet,
835                  * see if there is a descriptor for the initialization opcode.
836                  * Only try this once. */
837                 initcmdpossible = 0;
838                 ts = FindSyntax(initcmd_opcode, NULL);
839                 if (!ts) {
840                     /*There is no initialization opcode available, so we declare
841                      * an error */
842                     if (ambig) {
843                         fprintf(stderr, "%s", NName(pname, ": "));
844                         fprintf(stderr,
845                                 "Ambiguous operation '%s'; type '%shelp' for list\n",
846                                 argv[1], NName(pname, " "));
847                     } else {
848                         fprintf(stderr, "%s", NName(pname, ": "));
849                         fprintf(stderr,
850                                 "Unrecognized operation '%s'; type '%shelp' for list\n",
851                                 argv[1], NName(pname, " "));
852                     }
853                     code = CMD_UNKNOWNCMD;
854                     goto out;
855                 } else {
856                     /*Found syntax structure for an initialization opcode.  Fix
857                      * up argv and argc to relect what the user
858                      * ``should have'' typed */
859                     if (!(argv = InsertInitOpcode(&argc, argv))) {
860                         fprintf(stderr,
861                                 "%sCan't insert implicit init opcode into command line\n",
862                                 NName(pname, ": "));
863                         code = CMD_INTERNALERROR;
864                         goto out;
865                     }
866                 }
867             } /*Initial opcode not yet attempted */
868             else {
869                 /* init cmd already run and no syntax entry found */
870                 if (ambig) {
871                     fprintf(stderr, "%s", NName(pname, ": "));
872                     fprintf(stderr,
873                             "Ambiguous operation '%s'; type '%shelp' for list\n",
874                             argv[1], NName(pname, " "));
875                 } else {
876                     fprintf(stderr, "%s", NName(pname, ": "));
877                     fprintf(stderr,
878                             "Unrecognized operation '%s'; type '%shelp' for list\n",
879                             argv[1], NName(pname, " "));
880                 }
881                 code = CMD_UNKNOWNCMD;
882                 goto out;
883             }
884         }                       /*Argv[1] is not a valid opcode */
885     }                           /*Opcodes are defined */
886
887     /* Found the descriptor; start parsing.  curType is the type we're
888      * trying to parse */
889     curType = 0;
890
891     /* We start off parsing in "positional" mode, where tokens are put in
892      * slots positionally.  If we find a name that takes args, we go
893      * out of positional mode, and from that point on, expect a switch
894      * before any particular token. */
895
896     positional = enablePositional;      /* Accepting positional cmds ? */
897     i = noOpcodes ? 1 : 2;
898     SetupExpandsFlag(ts);
899     for (; i < argc; i++) {
900         if (param) {
901             free(param);
902             param = NULL;
903             embeddedvalue = NULL;
904         }
905
906         /* Only tokens that start with a hyphen and are not followed by a digit
907          * are considered switches.  This allow negative numbers. */
908
909         if ((argv[i][0] == '-') && !isdigit(argv[i][1])) {
910             int j;
911
912             /* Find switch */
913             if (strrchr(argv[i], '=') != NULL) {
914                 param = strdup(argv[i]);
915                 embeddedvalue = strrchr(param, '=');
916                 *embeddedvalue = '\0';
917                 embeddedvalue ++;
918                 j = FindType(ts, param);
919             } else {
920                 j = FindType(ts, argv[i]);
921             }
922
923             if (j < 0) {
924                 fprintf(stderr,
925                         "%sUnrecognized or ambiguous switch '%s'; type ",
926                         NName(pname, ": "), argv[i]);
927                 if (noOpcodes)
928                     fprintf(stderr, "'%s -help' for detailed help\n",
929                             argv[0]);
930                 else
931                     fprintf(stderr, "'%shelp %s' for detailed help\n",
932                             NName(argv[0], " "), ts->name);
933                 code = CMD_UNKNOWNSWITCH;
934                 goto out;
935             }
936             if (j >= CMD_MAXPARMS) {
937                 fprintf(stderr, "%sInternal parsing error\n",
938                         NName(pname, ": "));
939                 code = CMD_INTERNALERROR;
940                 goto out;
941             }
942             if (ts->parms[j].type == CMD_FLAG) {
943                 ts->parms[j].items = &dummy;
944
945                 if (embeddedvalue) {
946                     fprintf(stderr, "%sSwitch '%s' doesn't take an argument\n",
947                             NName(pname, ": "), ts->parms[j].name);
948                     code = CMD_TOOMANY;
949                     goto out;
950                 }
951             } else {
952                 positional = 0;
953                 curType = j;
954                 ts->parms[j].flags |= CMD_PROCESSED;
955
956                 if (embeddedvalue) {
957                     AddItem(&ts->parms[curType], embeddedvalue, pname);
958                 }
959             }
960         } else {
961             /* Try to fit in this descr */
962             if (curType >= CMD_MAXPARMS) {
963                 fprintf(stderr, "%sToo many arguments\n", NName(pname, ": "));
964                 code = CMD_TOOMANY;
965                 goto out;
966             }
967             tparm = &ts->parms[curType];
968
969             if ((tparm->type == 0) ||   /* No option in this slot */
970                 (tparm->type == CMD_FLAG)) {    /* A flag (not an argument */
971                 /* skipped parm slot */
972                 curType++;      /* Skip this slot and reprocess this parm */
973                 i--;
974                 continue;
975             }
976
977             if (!(tparm->flags & CMD_PROCESSED) && (tparm->flags & CMD_HIDE)) {
978                 curType++;      /* Skip this slot and reprocess this parm */
979                 i--;
980                 continue;
981             }
982
983             if (tparm->type == CMD_SINGLE ||
984                 tparm->type == CMD_SINGLE_OR_FLAG) {
985                 if (tparm->items) {
986                     fprintf(stderr, "%sToo many values after switch %s\n",
987                             NName(pname, ": "), tparm->name);
988                     code = CMD_NOTLIST;
989                     goto out;
990                 }
991                 AddItem(tparm, argv[i], pname);        /* Add to end of list */
992             } else if (tparm->type == CMD_LIST) {
993                 AddItem(tparm, argv[i], pname);        /* Add to end of list */
994             }
995
996             /* Now, if we're in positional mode, advance to the next item */
997             if (positional)
998                 curType = AdvanceType(ts, curType);
999         }
1000     }
1001
1002     /* keep track of this for messages */
1003     ts->a0name = argv[0];
1004
1005     /* If we make it here, all the parameters are filled in.  Check to see if
1006      * this is a -help version.  Must do this before checking for all
1007      * required parms, otherwise it is a real nuisance */
1008     if (ts->parms[CMD_HELPPARM].items) {
1009         PrintSyntax(ts);
1010         /* Display full help syntax if we don't have subcommands */
1011         if (noOpcodes)
1012             PrintFlagHelp(ts);
1013         code = CMD_HELP;
1014         goto out;
1015     }
1016
1017     /* Parsing done, see if we have all of our required parameters */
1018     for (i = 0; i < CMD_MAXPARMS; i++) {
1019         tparm = &ts->parms[i];
1020         if (tparm->type == 0)
1021             continue;           /* Skipped parm slot */
1022         if ((tparm->flags & CMD_PROCESSED) && tparm->items == 0) {
1023             if (tparm->type == CMD_SINGLE_OR_FLAG) {
1024                 tparm->items = &dummy;
1025             } else {
1026                 fprintf(stderr, "%s The field '%s' isn't completed properly\n",
1027                     NName(pname, ": "), tparm->name);
1028                 code = CMD_TOOFEW;
1029                 goto out;
1030             }
1031         }
1032         if (!(tparm->flags & CMD_OPTIONAL) && tparm->items == 0) {
1033             fprintf(stderr, "%sMissing required parameter '%s'\n",
1034                     NName(pname, ": "), tparm->name);
1035             code = CMD_TOOFEW;
1036             goto out;
1037         }
1038         tparm->flags &= ~CMD_PROCESSED;
1039     }
1040     *outsyntax = ts;
1041
1042 out:
1043     if (code && ts != NULL)
1044         ResetSyntax(ts);
1045
1046     return code;
1047 }
1048
1049 int
1050 cmd_Dispatch(int argc, char **argv)
1051 {
1052     struct cmd_syndesc *ts = NULL;
1053     int code;
1054
1055     code = cmd_Parse(argc, argv, &ts);
1056     if (code) {
1057         if (code == CMD_HELP) {
1058             code = 0; /* displaying help is not an error */
1059         }
1060         return code;
1061     }
1062
1063     /*
1064      * Before calling the beforeProc and afterProc and all the implications
1065      * from those calls, check if the help procedure was called and call it
1066      * now.
1067      */
1068     if ((ts->proc == HelpProc) || (ts->proc == AproposProc)) {
1069         code = (*ts->proc) (ts, ts->rock);
1070         goto out;
1071     }
1072
1073     /* Now, we just call the procedure and return */
1074     if (beforeProc)
1075         code = (*beforeProc) (ts, beforeRock);
1076
1077     if (code)
1078         goto out;
1079
1080     code = (*ts->proc) (ts, ts->rock);
1081
1082     if (afterProc)
1083         (*afterProc) (ts, afterRock);
1084 out:
1085     cmd_FreeOptions(&ts);
1086     return code;
1087 }
1088
1089 void
1090 cmd_FreeOptions(struct cmd_syndesc **ts)
1091 {
1092     if (*ts != NULL) {
1093         ResetSyntax(*ts);
1094         *ts = NULL;
1095     }
1096 }
1097
1098 /* free token list returned by parseLine */
1099 static int
1100 FreeTokens(struct cmd_token *alist)
1101 {
1102     struct cmd_token *nlist;
1103     for (; alist; alist = nlist) {
1104         nlist = alist->next;
1105         free(alist->key);
1106         free(alist);
1107     }
1108     return 0;
1109 }
1110
1111 /* free an argv list returned by parseline */
1112 int
1113 cmd_FreeArgv(char **argv)
1114 {
1115     char *tp;
1116     for (tp = *argv; tp; argv++, tp = *argv)
1117         free(tp);
1118     return 0;
1119 }
1120
1121 /* copy back the arg list to the argv array, freeing the cmd_tokens as you go;
1122  * the actual data is still malloc'd, and will be freed when the caller calls
1123  * cmd_FreeArgv later on
1124  */
1125 #define INITSTR ""
1126 static int
1127 CopyBackArgs(struct cmd_token *alist, char **argv,
1128              afs_int32 * an, afs_int32 amaxn)
1129 {
1130     struct cmd_token *next;
1131     afs_int32 count;
1132
1133     count = 0;
1134     if (amaxn <= 1)
1135         return CMD_TOOMANY;
1136     *argv = strdup(INITSTR);
1137     assert(*argv);
1138     amaxn--;
1139     argv++;
1140     count++;
1141     while (alist) {
1142         if (amaxn <= 1)
1143             return CMD_TOOMANY; /* argv is too small for his many parms. */
1144         *argv = alist->key;
1145         next = alist->next;
1146         free(alist);
1147         alist = next;
1148         amaxn--;
1149         argv++;
1150         count++;
1151     }
1152     *argv = NULL;               /* use last slot for terminating null */
1153     /* don't count terminating null */
1154     *an = count;
1155     return 0;
1156 }
1157
1158 static int
1159 quote(int x)
1160 {
1161     if (x == '"' || x == 39 /* single quote */ )
1162         return 1;
1163     else
1164         return 0;
1165 }
1166
1167 static int
1168 space(int x)
1169 {
1170     if (x == 0 || x == ' ' || x == '\t' || x == '\n')
1171         return 1;
1172     else
1173         return 0;
1174 }
1175
1176 int
1177 cmd_ParseLine(char *aline, char **argv, afs_int32 * an, afs_int32 amaxn)
1178 {
1179     char tbuffer[256];
1180     char *tptr = 0;
1181     int inToken, inQuote;
1182     struct cmd_token *first, *last;
1183     struct cmd_token *ttok;
1184     int tc;
1185
1186     inToken = 0;                /* not copying token chars at start */
1187     first = NULL;
1188     last = NULL;
1189     inQuote = 0;                /* not in a quoted string */
1190     while (1) {
1191         tc = *aline++;
1192         if (tc == 0 || (!inQuote && space(tc))) {       /* terminating null gets us in here, too */
1193             if (inToken) {
1194                 inToken = 0;    /* end of this token */
1195                 if (!tptr)
1196                     return -1;  /* should never get here */
1197                 else
1198                     *tptr++ = 0;
1199                 ttok = malloc(sizeof(struct cmd_token));
1200                 assert(ttok);
1201                 ttok->next = NULL;
1202                 ttok->key = strdup(tbuffer);
1203                 assert(ttok->key);
1204                 if (last) {
1205                     last->next = ttok;
1206                     last = ttok;
1207                 } else
1208                     last = ttok;
1209                 if (!first)
1210                     first = ttok;
1211             }
1212         } else {
1213             /* an alpha character */
1214             if (!inToken) {
1215                 tptr = tbuffer;
1216                 inToken = 1;
1217             }
1218             if (tptr - tbuffer >= sizeof(tbuffer)) {
1219                 FreeTokens(first);
1220                 return CMD_TOOBIG;      /* token too long */
1221             }
1222             if (quote(tc)) {
1223                 /* hit a quote, toggle inQuote flag but don't insert character */
1224                 inQuote = !inQuote;
1225             } else {
1226                 /* insert character */
1227                 *tptr++ = tc;
1228             }
1229         }
1230         if (tc == 0) {
1231             /* last token flushed 'cause space(0) --> true */
1232             if (last)
1233                 last->next = NULL;
1234             return CopyBackArgs(first, argv, an, amaxn);
1235         }
1236     }
1237 }
1238
1239 /* Read a string in from our configuration file. This checks in
1240  * multiple places within this file - firstly in the section
1241  * [command_subcommand], then in [command], then in [subcommand]
1242  *
1243  * Returns CMD_MISSING if there is no configuration file configured,
1244  * or if the file doesn't contain information for the specified option
1245  * in any of these sections.
1246  */
1247
1248 static int
1249 _get_file_string(struct cmd_syndesc *syn, int pos, const char **str)
1250 {
1251     char *section;
1252     char *optionName;
1253
1254     /* Nothing on the command line, try the config file if we have one */
1255     if (globalConfig == NULL)
1256         return CMD_MISSING;
1257
1258     /* March past any leading -'s */
1259     for (optionName = syn->parms[pos].name;
1260          *optionName == '-'; optionName++);
1261
1262     /* First, try the command_subcommand form */
1263     if (syn->name != NULL && commandName != NULL) {
1264         asprintf(&section, "%s_%s", commandName, syn->name);
1265         *str = cmd_RawConfigGetString(globalConfig, NULL, section,
1266                                       optionName, NULL);
1267         free(section);
1268         if (*str)
1269             return 0;
1270     }
1271
1272     /* Then, try the command form */
1273     if (commandName != NULL) {
1274         *str = cmd_RawConfigGetString(globalConfig, NULL, commandName,
1275                                       optionName, NULL);
1276         if (*str)
1277             return 0;
1278     }
1279
1280     /* Then, the defaults section */
1281     *str = cmd_RawConfigGetString(globalConfig, NULL, "defaults",
1282                                   optionName, NULL);
1283     if (*str)
1284         return 0;
1285
1286     /* Nothing there, return MISSING */
1287     return CMD_MISSING;
1288 }
1289
1290 static int
1291 _get_config_string(struct cmd_syndesc *syn, int pos, const char **str)
1292 {
1293     *str = NULL;
1294
1295     if (pos > syn->nParms)
1296         return CMD_EXCESSPARMS;
1297
1298     /* It's a flag, they probably shouldn't be using this interface to access
1299      * it, but don't blow up for now */
1300     if (syn->parms[pos].items == &dummy)
1301         return 0;
1302
1303     /* We have a value on the command line - this overrides anything in the
1304      * configuration file */
1305     if (syn->parms[pos].items != NULL &&
1306         syn->parms[pos].items->data != NULL) {
1307         *str = syn->parms[pos].items->data;
1308         return 0;
1309     }
1310
1311     return _get_file_string(syn, pos, str);
1312 }
1313
1314 int
1315 cmd_OptionAsInt(struct cmd_syndesc *syn, int pos, int *value)
1316 {
1317     const char *str;
1318     int code;
1319
1320     code =_get_config_string(syn, pos, &str);
1321     if (code)
1322         return code;
1323
1324     if (str == NULL)
1325         return CMD_MISSING;
1326
1327     *value = strtol(str, NULL, 10);
1328
1329     return 0;
1330 }
1331
1332 int
1333 cmd_OptionAsUint(struct cmd_syndesc *syn, int pos,
1334                  unsigned int *value)
1335 {
1336     const char *str;
1337     int code;
1338
1339     code = _get_config_string(syn, pos, &str);
1340     if (code)
1341         return code;
1342
1343     if (str == NULL)
1344         return CMD_MISSING;
1345
1346     *value = strtoul(str, NULL, 10);
1347
1348     return 0;
1349 }
1350
1351 int
1352 cmd_OptionAsString(struct cmd_syndesc *syn, int pos, char **value)
1353 {
1354     const char *str;
1355     int code;
1356
1357     code = _get_config_string(syn, pos, &str);
1358     if (code)
1359         return code;
1360
1361     if (str == NULL)
1362         return CMD_MISSING;
1363
1364     if (*value)
1365         free(*value);
1366     *value = strdup(str);
1367
1368     return 0;
1369 }
1370
1371 int
1372 cmd_OptionAsList(struct cmd_syndesc *syn, int pos, struct cmd_item **value)
1373 {
1374     const char *str;
1375     struct cmd_item *item, **last;
1376     const char *start, *end;
1377     size_t len;
1378     int code;
1379
1380     if (pos > syn->nParms)
1381         return CMD_EXCESSPARMS;
1382
1383     /* If we have a list already, just return the existing list */
1384     if (syn->parms[pos].items != NULL) {
1385         *value = syn->parms[pos].items;
1386         return 0;
1387     }
1388
1389     code = _get_file_string(syn, pos, &str);
1390     if (code)
1391         return code;
1392
1393     /* Use strchr to split str into elements, and build a recursive list
1394      * from them. Hang this list off the configuration structure, so that
1395      * it is returned by any future calls to this function, and is freed
1396      * along with everything else when the syntax description is freed
1397      */
1398     last = &syn->parms[pos].items;
1399     start = str;
1400     while ((end = strchr(start, ' '))) {
1401         item = calloc(1, sizeof(struct cmd_item));
1402         len = end - start + 1;
1403         item->data = malloc(len);
1404         strlcpy(item->data, start, len);
1405         *last = item;
1406         last = &item->next;
1407         for (start = end; *start == ' '; start++); /* skip any whitespace */
1408     }
1409
1410     /* Catch the final element */
1411     if (*start != '\0') {
1412         item = calloc(1, sizeof(struct cmd_item));
1413         len = strlen(start) + 1;
1414         item->data = malloc(len);
1415         strlcpy(item->data, start, len);
1416         *last = item;
1417     }
1418
1419     *value = syn->parms[pos].items;
1420
1421     return 0;
1422 }
1423
1424 int
1425 cmd_OptionAsFlag(struct cmd_syndesc *syn, int pos, int *value)
1426 {
1427     const char *str = NULL;
1428     int code;
1429
1430     code = _get_config_string(syn, pos, &str);
1431     if (code)
1432         return code;
1433
1434     if (str == NULL ||
1435         strcasecmp(str, "yes") == 0 ||
1436         strcasecmp(str, "true") == 0 ||
1437         atoi(str))
1438         *value = 1;
1439     else
1440         *value = 0;
1441
1442     return 0;
1443 }
1444
1445 int
1446 cmd_OptionPresent(struct cmd_syndesc *syn, int pos)
1447 {
1448     const char *str;
1449     int code;
1450
1451     code = _get_config_string(syn, pos, &str);
1452     if (code == 0)
1453         return 1;
1454
1455     return 0;
1456 }
1457
1458 int
1459 cmd_OpenConfigFile(const char *file)
1460 {
1461     if (globalConfig) {
1462         cmd_RawConfigFileFree(globalConfig);
1463         globalConfig = NULL;
1464     }
1465
1466     return cmd_RawConfigParseFile(file, &globalConfig);
1467 }
1468
1469 void
1470 cmd_SetCommandName(const char *command)
1471 {
1472     commandName = command;
1473 }
1474
1475 const cmd_config_section *
1476 cmd_RawFile(void)
1477 {
1478     return globalConfig;
1479 }
1480
1481 const cmd_config_section *
1482 cmd_RawSection(void)
1483 {
1484     if (globalConfig == NULL || commandName == NULL)
1485         return NULL;
1486
1487     return cmd_RawConfigGetList(globalConfig, commandName, NULL);
1488 }