cmd: Add support for pulling options from files
[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 = malloc(strlen(aname) + 1);
454         assert(td->name);
455         strcpy(td->name, aname);
456     } else {
457         td->name = NULL;
458         noOpcodes = 1;
459     }
460     if (ahelp) {
461         /* Piggy-back the hidden option onto the help string */
462         if (ahelp == (char *)CMD_HIDDEN) {
463             td->flags |= CMD_HIDDEN;
464         } else {
465             td->help = malloc(strlen(ahelp) + 1);
466             assert(td->help);
467             strcpy(td->help, ahelp);
468         }
469     } else
470         td->help = NULL;
471     td->proc = aproc;
472     td->rock = arock;
473
474     SortSyntax(td);
475
476     cmd_Seek(td, CMD_HELPPARM);
477     cmd_AddParm(td, "-help", CMD_FLAG, CMD_OPTIONAL, "get detailed help");
478     cmd_Seek(td, 0);
479
480     return td;
481 }
482
483 int
484 cmd_CreateAlias(struct cmd_syndesc *as, char *aname)
485 {
486     struct cmd_syndesc *td;
487
488     td = malloc(sizeof(struct cmd_syndesc));
489     assert(td);
490     memcpy(td, as, sizeof(struct cmd_syndesc));
491     td->name = malloc(strlen(aname) + 1);
492     assert(td->name);
493     strcpy(td->name, aname);
494     td->flags |= CMD_ALIAS;
495     /* if ever free things, make copy of help string, too */
496
497     /* thread on list */
498     SortSyntax(td);
499
500     /* thread on alias lists */
501     td->nextAlias = as->nextAlias;
502     as->nextAlias = td;
503     td->aliasOf = as;
504
505     return 0;                   /* all done */
506 }
507
508 void
509 cmd_DisablePositionalCommands(void)
510 {
511     enablePositional = 0;
512 }
513
514 void
515 cmd_DisableAbbreviations(void)
516 {
517     enableAbbreviation = 0;
518 }
519
520 int
521 cmd_IsAdministratorCommand(struct cmd_syndesc *as)
522 {
523     as->flags |= CMD_ADMIN;
524     return 0;
525 }
526
527 int
528 cmd_Seek(struct cmd_syndesc *as, int apos)
529 {
530     if (apos >= CMD_MAXPARMS)
531         return CMD_EXCESSPARMS;
532     as->nParms = apos;
533     return 0;
534 }
535
536 int
537 cmd_AddParmAtOffset(struct cmd_syndesc *as, int ref, char *aname, int atype,
538                     afs_int32 aflags, char *ahelp)
539 {
540     struct cmd_parmdesc *tp;
541
542     if (ref >= CMD_MAXPARMS)
543         return CMD_EXCESSPARMS;
544     tp = &as->parms[ref];
545
546     tp->name = malloc(strlen(aname) + 1);
547     assert(tp->name);
548     strcpy(tp->name, aname);
549     tp->type = atype;
550     tp->flags = aflags;
551     tp->items = NULL;
552     if (ahelp) {
553         tp->help = malloc(strlen(ahelp) + 1);
554         assert(tp->help);
555         strcpy(tp->help, ahelp);
556     } else
557         tp->help = NULL;
558
559     tp->aliases = NULL;
560
561     if (as->nParms <= ref)
562         as->nParms = ref+1;
563
564     return 0;
565 }
566
567 int
568 cmd_AddParm(struct cmd_syndesc *as, char *aname, int atype,
569             afs_int32 aflags, char *ahelp)
570 {
571     if (as->nParms >= CMD_MAXPARMS)
572         return CMD_EXCESSPARMS;
573
574     return cmd_AddParmAtOffset(as, as->nParms++, aname, atype, aflags, ahelp);
575 }
576
577 int
578 cmd_AddParmAlias(struct cmd_syndesc *as, int pos, char *alias)
579 {
580     struct cmd_item *item;
581
582     if (pos > as->nParms)
583         return CMD_EXCESSPARMS;
584
585     item = calloc(1, sizeof(struct cmd_item));
586     item->data = strdup(alias);
587     item->next = as->parms[pos].aliases;
588     as->parms[pos].aliases = item;
589
590     return 0;
591 }
592
593 /* add a text item to the end of the parameter list */
594 static int
595 AddItem(struct cmd_parmdesc *aparm, char *aval, char *pname)
596 {
597     struct cmd_item *ti, *ni;
598
599     if (aparm->type == CMD_SINGLE ||
600         aparm->type == CMD_SINGLE_OR_FLAG) {
601         if (aparm->items) {
602             fprintf(stderr, "%sToo many values after switch %s\n",
603                     NName(pname, ": "), aparm->name);
604             return CMD_NOTLIST;
605         }
606     }
607
608     ti = calloc(1, sizeof(struct cmd_item));
609     assert(ti);
610     ti->data = malloc(strlen(aval) + 1);
611     assert(ti->data);
612     strcpy(ti->data, aval);
613     /* now put ti at the *end* of the list */
614     if ((ni = aparm->items)) {
615         for (; ni; ni = ni->next)
616             if (ni->next == 0)
617                 break;          /* skip to last one */
618         ni->next = ti;
619     } else
620         aparm->items = ti;      /* we're first */
621     return 0;
622 }
623
624 /* skip to next non-flag item, if any */
625 static int
626 AdvanceType(struct cmd_syndesc *as, afs_int32 aval)
627 {
628     afs_int32 next;
629     struct cmd_parmdesc *tp;
630
631     /* first see if we should try to grab rest of line for this dude */
632     if (as->parms[aval].flags & CMD_EXPANDS)
633         return aval;
634
635     /* if not, find next non-flag used slot */
636     for (next = aval + 1; next < CMD_MAXPARMS; next++) {
637         tp = &as->parms[next];
638         if (tp->type != 0 && tp->type != CMD_FLAG)
639             return next;
640     }
641     return aval;
642 }
643
644 /* discard parameters filled in by dispatch */
645 static void
646 ResetSyntax(struct cmd_syndesc *as)
647 {
648     int i;
649     struct cmd_parmdesc *tp;
650     struct cmd_item *ti, *ni;
651
652     tp = as->parms;
653     for (i = 0; i < CMD_MAXPARMS; i++, tp++) {
654         switch (tp->type) {
655         case CMD_SINGLE_OR_FLAG:
656             if (tp->items == &dummy)
657                 break;
658             /* Deliberately fall through here */
659         case CMD_SINGLE:
660         case CMD_LIST:
661             /* free whole list in both cases, just for fun */
662             for (ti = tp->items; ti; ti = ni) {
663                 ni = ti->next;
664                 free(ti->data);
665                 free(ti);
666             }
667             break;
668
669         default:
670             break;
671         }
672         tp->items = NULL;
673     }
674 }
675
676 /* move the expands flag to the last one in the list */
677 static int
678 SetupExpandsFlag(struct cmd_syndesc *as)
679 {
680     struct cmd_parmdesc *tp;
681     int last, i;
682
683     last = -1;
684     /* find last CMD_LIST type parameter, optional or not, and make it expandable
685      * if no other dude is expandable */
686     for (i = 0; i < CMD_MAXPARMS; i++) {
687         tp = &as->parms[i];
688         if (tp->type == CMD_LIST) {
689             if (tp->flags & CMD_EXPANDS)
690                 return 0;       /* done if already specified */
691             last = i;
692         }
693     }
694     if (last >= 0)
695         as->parms[last].flags |= CMD_EXPANDS;
696     return 0;
697 }
698
699 /* Take the current argv & argc and alter them so that the initialization
700  * opcode is made to appear.  This is used in cases where the initialization
701  * opcode is implicitly invoked.*/
702 static char **
703 InsertInitOpcode(int *aargc, char **aargv)
704 {
705     char **newargv;             /*Ptr to new, expanded argv space */
706     char *pinitopcode;          /*Ptr to space for name of init opcode */
707     int i;                      /*Loop counter */
708
709     /* Allocate the new argv array, plus one for the new opcode, plus one
710      * more for the trailing null pointer */
711     newargv = malloc(((*aargc) + 2) * sizeof(char *));
712     if (!newargv) {
713         fprintf(stderr, "%s: Can't create new argv array with %d+2 slots\n",
714                 aargv[0], *aargc);
715         return (NULL);
716     }
717
718     /* Create space for the initial opcode & fill it in */
719     pinitopcode = malloc(sizeof(initcmd_opcode));
720     if (!pinitopcode) {
721         fprintf(stderr, "%s: Can't malloc initial opcode space\n", aargv[0]);
722         free(newargv);
723         return (NULL);
724     }
725     strcpy(pinitopcode, initcmd_opcode);
726
727     /* Move all the items in the old argv into the new argv, in their
728      * proper places */
729     for (i = *aargc; i > 1; i--)
730         newargv[i] = aargv[i - 1];
731
732     /* Slip in the opcode and the trailing null pointer, and bump the
733      * argument count up by one for the new opcode */
734     newargv[0] = aargv[0];
735     newargv[1] = pinitopcode;
736     (*aargc)++;
737     newargv[*aargc] = NULL;
738
739     /* Return the happy news */
740     return (newargv);
741
742 }                               /*InsertInitOpcode */
743
744 static int
745 NoParmsOK(struct cmd_syndesc *as)
746 {
747     int i;
748     struct cmd_parmdesc *td;
749
750     for (i = 0; i < CMD_MAXPARMS; i++) {
751         td = &as->parms[i];
752         if (td->type != 0 && !(td->flags & CMD_OPTIONAL)) {
753             /* found a non-optional (e.g. required) parm, so NoParmsOK
754              * is false (some parms are required) */
755             return 0;
756         }
757     }
758     return 1;
759 }
760
761 /* Add help, apropos commands once */
762 static void
763 initSyntax(void)
764 {
765     struct cmd_syndesc *ts;
766
767     if (!noOpcodes) {
768         ts = cmd_CreateSyntax("help", HelpProc, NULL,
769                               "get help on commands");
770         cmd_AddParm(ts, "-topic", CMD_LIST, CMD_OPTIONAL, "help string");
771         cmd_AddParm(ts, "-admin", CMD_FLAG, CMD_OPTIONAL, NULL);
772
773         ts = cmd_CreateSyntax("apropos", AproposProc, NULL,
774                               "search by help text");
775         cmd_AddParm(ts, "-topic", CMD_SINGLE, CMD_REQUIRED, "help string");
776
777         cmd_CreateSyntax("version", VersionProc, NULL,
778                          (char *)CMD_HIDDEN);
779         cmd_CreateSyntax("-version", VersionProc, NULL,
780                          (char *)CMD_HIDDEN);
781         cmd_CreateSyntax("-help", HelpProc, NULL,
782                          (char *)CMD_HIDDEN);
783         cmd_CreateSyntax("--version", VersionProc, NULL,
784                          (char *)CMD_HIDDEN);
785         cmd_CreateSyntax("--help", HelpProc, NULL,
786                          (char *)CMD_HIDDEN);
787     }
788 }
789
790 /* Call the appropriate function, or return syntax error code.  Note: if
791  * no opcode is specified, an initialization routine exists, and it has
792  * NOT been called before, we invoke the special initialization opcode
793  */
794 int
795 cmd_Parse(int argc, char **argv, struct cmd_syndesc **outsyntax)
796 {
797     char *pname;
798     struct cmd_syndesc *ts = NULL;
799     struct cmd_parmdesc *tparm;
800     int i;
801     int curType;
802     int positional;
803     int ambig;
804     int code = 0;
805     char *param = NULL;
806     char *embeddedvalue = NULL;
807     static int initd = 0;       /*Is this the first time this routine has been called? */
808     static int initcmdpossible = 1;     /*Should be consider parsing the initial command? */
809
810     *outsyntax = NULL;
811
812     if (!initd) {
813         initd = 1;
814         initSyntax();
815     }
816
817     /*Remember the program name */
818     pname = argv[0];
819
820     if (noOpcodes) {
821         if (argc == 1) {
822             if (!NoParmsOK(allSyntax)) {
823                 printf("%s: Type '%s -help' for help\n", pname, pname);
824                 code = CMD_USAGE;
825                 goto out;
826             }
827         }
828     } else {
829         if (argc < 2) {
830             /* if there is an initcmd, don't print an error message, just
831              * setup to use the initcmd below. */
832             if (!(initcmdpossible && FindSyntax(initcmd_opcode, NULL))) {
833                 printf("%s: Type '%s help' or '%s help <topic>' for help\n",
834                        pname, pname, pname);
835                 code = CMD_USAGE;
836                 goto out;
837             }
838         }
839     }
840
841     /* Find the syntax descriptor for this command, doing prefix matching properly */
842     if (noOpcodes) {
843         ts = allSyntax;
844     } else {
845         ts = (argc < 2 ? 0 : FindSyntax(argv[1], &ambig));
846         if (!ts) {
847             /*First token doesn't match a syntax descriptor */
848             if (initcmdpossible) {
849                 /*If initial command line handling hasn't been done yet,
850                  * see if there is a descriptor for the initialization opcode.
851                  * Only try this once. */
852                 initcmdpossible = 0;
853                 ts = FindSyntax(initcmd_opcode, NULL);
854                 if (!ts) {
855                     /*There is no initialization opcode available, so we declare
856                      * an error */
857                     if (ambig) {
858                         fprintf(stderr, "%s", NName(pname, ": "));
859                         fprintf(stderr,
860                                 "Ambiguous operation '%s'; type '%shelp' for list\n",
861                                 argv[1], NName(pname, " "));
862                     } else {
863                         fprintf(stderr, "%s", NName(pname, ": "));
864                         fprintf(stderr,
865                                 "Unrecognized operation '%s'; type '%shelp' for list\n",
866                                 argv[1], NName(pname, " "));
867                     }
868                     code = CMD_UNKNOWNCMD;
869                     goto out;
870                 } else {
871                     /*Found syntax structure for an initialization opcode.  Fix
872                      * up argv and argc to relect what the user
873                      * ``should have'' typed */
874                     if (!(argv = InsertInitOpcode(&argc, argv))) {
875                         fprintf(stderr,
876                                 "%sCan't insert implicit init opcode into command line\n",
877                                 NName(pname, ": "));
878                         code = CMD_INTERNALERROR;
879                         goto out;
880                     }
881                 }
882             } /*Initial opcode not yet attempted */
883             else {
884                 /* init cmd already run and no syntax entry found */
885                 if (ambig) {
886                     fprintf(stderr, "%s", NName(pname, ": "));
887                     fprintf(stderr,
888                             "Ambiguous operation '%s'; type '%shelp' for list\n",
889                             argv[1], NName(pname, " "));
890                 } else {
891                     fprintf(stderr, "%s", NName(pname, ": "));
892                     fprintf(stderr,
893                             "Unrecognized operation '%s'; type '%shelp' for list\n",
894                             argv[1], NName(pname, " "));
895                 }
896                 code = CMD_UNKNOWNCMD;
897                 goto out;
898             }
899         }                       /*Argv[1] is not a valid opcode */
900     }                           /*Opcodes are defined */
901
902     /* Found the descriptor; start parsing.  curType is the type we're
903      * trying to parse */
904     curType = 0;
905
906     /* We start off parsing in "positional" mode, where tokens are put in
907      * slots positionally.  If we find a name that takes args, we go
908      * out of positional mode, and from that point on, expect a switch
909      * before any particular token. */
910
911     positional = enablePositional;      /* Accepting positional cmds ? */
912     i = noOpcodes ? 1 : 2;
913     SetupExpandsFlag(ts);
914     for (; i < argc; i++) {
915         if (param) {
916             free(param);
917             param = NULL;
918             embeddedvalue = NULL;
919         }
920
921         /* Only tokens that start with a hyphen and are not followed by a digit
922          * are considered switches.  This allow negative numbers. */
923
924         if ((argv[i][0] == '-') && !isdigit(argv[i][1])) {
925             int j;
926
927             /* Find switch */
928             if (strrchr(argv[i], '=') != NULL) {
929                 param = strdup(argv[i]);
930                 embeddedvalue = strrchr(param, '=');
931                 *embeddedvalue = '\0';
932                 embeddedvalue ++;
933                 j = FindType(ts, param);
934             } else {
935                 j = FindType(ts, argv[i]);
936             }
937
938             if (j < 0) {
939                 fprintf(stderr,
940                         "%sUnrecognized or ambiguous switch '%s'; type ",
941                         NName(pname, ": "), argv[i]);
942                 if (noOpcodes)
943                     fprintf(stderr, "'%s -help' for detailed help\n",
944                             argv[0]);
945                 else
946                     fprintf(stderr, "'%shelp %s' for detailed help\n",
947                             NName(argv[0], " "), ts->name);
948                 code = CMD_UNKNOWNSWITCH;
949                 goto out;
950             }
951             if (j >= CMD_MAXPARMS) {
952                 fprintf(stderr, "%sInternal parsing error\n",
953                         NName(pname, ": "));
954                 code = CMD_INTERNALERROR;
955                 goto out;
956             }
957             if (ts->parms[j].type == CMD_FLAG) {
958                 ts->parms[j].items = &dummy;
959
960                 if (embeddedvalue) {
961                     fprintf(stderr, "%sSwitch '%s' doesn't take an argument\n",
962                             NName(pname, ": "), ts->parms[j].name);
963                     code = CMD_TOOMANY;
964                     goto out;
965                 }
966             } else {
967                 positional = 0;
968                 curType = j;
969                 ts->parms[j].flags |= CMD_PROCESSED;
970
971                 if (embeddedvalue) {
972                     AddItem(&ts->parms[curType], embeddedvalue, pname);
973                 }
974             }
975         } else {
976             /* Try to fit in this descr */
977             if (curType >= CMD_MAXPARMS) {
978                 fprintf(stderr, "%sToo many arguments\n", NName(pname, ": "));
979                 code = CMD_TOOMANY;
980                 goto out;
981             }
982             tparm = &ts->parms[curType];
983
984             if ((tparm->type == 0) ||   /* No option in this slot */
985                 (tparm->type == CMD_FLAG)) {    /* A flag (not an argument */
986                 /* skipped parm slot */
987                 curType++;      /* Skip this slot and reprocess this parm */
988                 i--;
989                 continue;
990             }
991
992             if (!(tparm->flags & CMD_PROCESSED) && (tparm->flags & CMD_HIDE)) {
993                 curType++;      /* Skip this slot and reprocess this parm */
994                 i--;
995                 continue;
996             }
997
998             if (tparm->type == CMD_SINGLE ||
999                 tparm->type == CMD_SINGLE_OR_FLAG) {
1000                 if (tparm->items) {
1001                     fprintf(stderr, "%sToo many values after switch %s\n",
1002                             NName(pname, ": "), tparm->name);
1003                     code = CMD_NOTLIST;
1004                     goto out;
1005                 }
1006                 AddItem(tparm, argv[i], pname);        /* Add to end of list */
1007             } else if (tparm->type == CMD_LIST) {
1008                 AddItem(tparm, argv[i], pname);        /* Add to end of list */
1009             }
1010
1011             /* Now, if we're in positional mode, advance to the next item */
1012             if (positional)
1013                 curType = AdvanceType(ts, curType);
1014         }
1015     }
1016
1017     /* keep track of this for messages */
1018     ts->a0name = argv[0];
1019
1020     /* If we make it here, all the parameters are filled in.  Check to see if
1021      * this is a -help version.  Must do this before checking for all
1022      * required parms, otherwise it is a real nuisance */
1023     if (ts->parms[CMD_HELPPARM].items) {
1024         PrintSyntax(ts);
1025         /* Display full help syntax if we don't have subcommands */
1026         if (noOpcodes)
1027             PrintFlagHelp(ts);
1028         code = CMD_USAGE;
1029         goto out;
1030     }
1031
1032     /* Parsing done, see if we have all of our required parameters */
1033     for (i = 0; i < CMD_MAXPARMS; i++) {
1034         tparm = &ts->parms[i];
1035         if (tparm->type == 0)
1036             continue;           /* Skipped parm slot */
1037         if ((tparm->flags & CMD_PROCESSED) && tparm->items == 0) {
1038             if (tparm->type == CMD_SINGLE_OR_FLAG) {
1039                 tparm->items = &dummy;
1040             } else {
1041                 fprintf(stderr, "%s The field '%s' isn't completed properly\n",
1042                     NName(pname, ": "), tparm->name);
1043                 code = CMD_TOOFEW;
1044                 goto out;
1045             }
1046         }
1047         if (!(tparm->flags & CMD_OPTIONAL) && tparm->items == 0) {
1048             fprintf(stderr, "%sMissing required parameter '%s'\n",
1049                     NName(pname, ": "), tparm->name);
1050             code = CMD_TOOFEW;
1051             goto out;
1052         }
1053         tparm->flags &= ~CMD_PROCESSED;
1054     }
1055     *outsyntax = ts;
1056
1057 out:
1058     if (code && ts != NULL)
1059         ResetSyntax(ts);
1060
1061     return code;
1062 }
1063
1064 int
1065 cmd_Dispatch(int argc, char **argv)
1066 {
1067     struct cmd_syndesc *ts = NULL;
1068     int code;
1069
1070     code = cmd_Parse(argc, argv, &ts);
1071     if (code)
1072         return code;
1073
1074     /*
1075      * Before calling the beforeProc and afterProc and all the implications
1076      * from those calls, check if the help procedure was called and call it
1077      * now.
1078      */
1079     if ((ts->proc == HelpProc) || (ts->proc == AproposProc)) {
1080         code = (*ts->proc) (ts, ts->rock);
1081         goto out;
1082     }
1083
1084     /* Now, we just call the procedure and return */
1085     if (beforeProc)
1086         code = (*beforeProc) (ts, beforeRock);
1087
1088     if (code)
1089         goto out;
1090
1091     code = (*ts->proc) (ts, ts->rock);
1092
1093     if (afterProc)
1094         (*afterProc) (ts, afterRock);
1095 out:
1096     cmd_FreeOptions(&ts);
1097     return code;
1098 }
1099
1100 void
1101 cmd_FreeOptions(struct cmd_syndesc **ts)
1102 {
1103     if (*ts != NULL) {
1104         ResetSyntax(*ts);
1105         *ts = NULL;
1106     }
1107 }
1108
1109 /* free token list returned by parseLine */
1110 static int
1111 FreeTokens(struct cmd_token *alist)
1112 {
1113     struct cmd_token *nlist;
1114     for (; alist; alist = nlist) {
1115         nlist = alist->next;
1116         free(alist->key);
1117         free(alist);
1118     }
1119     return 0;
1120 }
1121
1122 /* free an argv list returned by parseline */
1123 int
1124 cmd_FreeArgv(char **argv)
1125 {
1126     char *tp;
1127     for (tp = *argv; tp; argv++, tp = *argv)
1128         free(tp);
1129     return 0;
1130 }
1131
1132 /* copy back the arg list to the argv array, freeing the cmd_tokens as you go;
1133  * the actual data is still malloc'd, and will be freed when the caller calls
1134  * cmd_FreeArgv later on
1135  */
1136 #define INITSTR ""
1137 static int
1138 CopyBackArgs(struct cmd_token *alist, char **argv,
1139              afs_int32 * an, afs_int32 amaxn)
1140 {
1141     struct cmd_token *next;
1142     afs_int32 count;
1143
1144     count = 0;
1145     if (amaxn <= 1)
1146         return CMD_TOOMANY;
1147     *argv = (char *)malloc(strlen(INITSTR) + 1);
1148     assert(*argv);
1149     strcpy(*argv, INITSTR);
1150     amaxn--;
1151     argv++;
1152     count++;
1153     while (alist) {
1154         if (amaxn <= 1)
1155             return CMD_TOOMANY; /* argv is too small for his many parms. */
1156         *argv = alist->key;
1157         next = alist->next;
1158         free(alist);
1159         alist = next;
1160         amaxn--;
1161         argv++;
1162         count++;
1163     }
1164     *argv = NULL;               /* use last slot for terminating null */
1165     /* don't count terminating null */
1166     *an = count;
1167     return 0;
1168 }
1169
1170 static int
1171 quote(int x)
1172 {
1173     if (x == '"' || x == 39 /* single quote */ )
1174         return 1;
1175     else
1176         return 0;
1177 }
1178
1179 static int
1180 space(int x)
1181 {
1182     if (x == 0 || x == ' ' || x == '\t' || x == '\n')
1183         return 1;
1184     else
1185         return 0;
1186 }
1187
1188 int
1189 cmd_ParseLine(char *aline, char **argv, afs_int32 * an, afs_int32 amaxn)
1190 {
1191     char tbuffer[256];
1192     char *tptr = 0;
1193     int inToken, inQuote;
1194     struct cmd_token *first, *last;
1195     struct cmd_token *ttok;
1196     int tc;
1197
1198     inToken = 0;                /* not copying token chars at start */
1199     first = NULL;
1200     last = NULL;
1201     inQuote = 0;                /* not in a quoted string */
1202     while (1) {
1203         tc = *aline++;
1204         if (tc == 0 || (!inQuote && space(tc))) {       /* terminating null gets us in here, too */
1205             if (inToken) {
1206                 inToken = 0;    /* end of this token */
1207                 if (!tptr)
1208                     return -1;  /* should never get here */
1209                 else
1210                     *tptr++ = 0;
1211                 ttok = malloc(sizeof(struct cmd_token));
1212                 assert(ttok);
1213                 ttok->next = NULL;
1214                 ttok->key = malloc(strlen(tbuffer) + 1);
1215                 assert(ttok->key);
1216                 strcpy(ttok->key, tbuffer);
1217                 if (last) {
1218                     last->next = ttok;
1219                     last = ttok;
1220                 } else
1221                     last = ttok;
1222                 if (!first)
1223                     first = ttok;
1224             }
1225         } else {
1226             /* an alpha character */
1227             if (!inToken) {
1228                 tptr = tbuffer;
1229                 inToken = 1;
1230             }
1231             if (tptr - tbuffer >= sizeof(tbuffer)) {
1232                 FreeTokens(first);
1233                 return CMD_TOOBIG;      /* token too long */
1234             }
1235             if (quote(tc)) {
1236                 /* hit a quote, toggle inQuote flag but don't insert character */
1237                 inQuote = !inQuote;
1238             } else {
1239                 /* insert character */
1240                 *tptr++ = tc;
1241             }
1242         }
1243         if (tc == 0) {
1244             /* last token flushed 'cause space(0) --> true */
1245             if (last)
1246                 last->next = NULL;
1247             return CopyBackArgs(first, argv, an, amaxn);
1248         }
1249     }
1250 }
1251
1252 /* Read a string in from our configuration file. This checks in
1253  * multiple places within this file - firstly in the section
1254  * [command_subcommand], then in [command], then in [subcommand]
1255  *
1256  * Returns CMD_MISSING if there is no configuration file configured,
1257  * or if the file doesn't contain information for the specified option
1258  * in any of these sections.
1259  */
1260
1261 static int
1262 _get_file_string(struct cmd_syndesc *syn, int pos, const char **str)
1263 {
1264     char *section;
1265     char *optionName;
1266
1267     /* Nothing on the command line, try the config file if we have one */
1268     if (globalConfig == NULL)
1269         return CMD_MISSING;
1270
1271     /* March past any leading -'s */
1272     for (optionName = syn->parms[pos].name;
1273          *optionName == '-'; optionName++);
1274
1275     /* First, try the command_subcommand form */
1276     if (syn->name != NULL && commandName != NULL) {
1277         asprintf(&section, "%s_%s", commandName, syn->name);
1278         *str = cmd_RawConfigGetString(globalConfig, NULL, section,
1279                                       optionName, NULL);
1280         free(section);
1281         if (*str)
1282             return 0;
1283     }
1284
1285     /* Then, try the command form */
1286     if (commandName != NULL) {
1287         *str = cmd_RawConfigGetString(globalConfig, NULL, commandName,
1288                                       optionName, NULL);
1289         if (*str)
1290             return 0;
1291     }
1292
1293     /* Then, the defaults section */
1294     *str = cmd_RawConfigGetString(globalConfig, NULL, "defaults",
1295                                   optionName, NULL);
1296     if (*str)
1297         return 0;
1298
1299     /* Nothing there, return MISSING */
1300     return CMD_MISSING;
1301 }
1302
1303 static int
1304 _get_config_string(struct cmd_syndesc *syn, int pos, const char **str)
1305 {
1306     *str = NULL;
1307
1308     if (pos > syn->nParms)
1309         return CMD_EXCESSPARMS;
1310
1311     /* It's a flag, they probably shouldn't be using this interface to access
1312      * it, but don't blow up for now */
1313     if (syn->parms[pos].items == &dummy)
1314         return 0;
1315
1316     /* We have a value on the command line - this overrides anything in the
1317      * configuration file */
1318     if (syn->parms[pos].items != NULL &&
1319         syn->parms[pos].items->data != NULL) {
1320         *str = syn->parms[pos].items->data;
1321         return 0;
1322     }
1323
1324     return _get_file_string(syn, pos, str);
1325 }
1326
1327 int
1328 cmd_OptionAsInt(struct cmd_syndesc *syn, int pos, int *value)
1329 {
1330     const char *str;
1331     int code;
1332
1333     code =_get_config_string(syn, pos, &str);
1334     if (code)
1335         return code;
1336
1337     if (str == NULL)
1338         return CMD_MISSING;
1339
1340     *value = strtol(str, NULL, 10);
1341
1342     return 0;
1343 }
1344
1345 int
1346 cmd_OptionAsUint(struct cmd_syndesc *syn, int pos,
1347                  unsigned int *value)
1348 {
1349     const char *str;
1350     int code;
1351
1352     code = _get_config_string(syn, pos, &str);
1353     if (code)
1354         return code;
1355
1356     if (str == NULL)
1357         return CMD_MISSING;
1358
1359     *value = strtoul(str, NULL, 10);
1360
1361     return 0;
1362 }
1363
1364 int
1365 cmd_OptionAsString(struct cmd_syndesc *syn, int pos, char **value)
1366 {
1367     const char *str;
1368     int code;
1369
1370     if (*value)
1371         free(*value);
1372
1373     code = _get_config_string(syn, pos, &str);
1374     if (code)
1375         return code;
1376
1377     if (str == NULL)
1378         return CMD_MISSING;
1379
1380     *value = strdup(str);
1381
1382     return 0;
1383 }
1384
1385 int
1386 cmd_OptionAsList(struct cmd_syndesc *syn, int pos, struct cmd_item **value)
1387 {
1388     const char *str;
1389     struct cmd_item *item, **last;
1390     const char *start, *end;
1391     int code;
1392
1393     if (pos > syn->nParms)
1394         return CMD_EXCESSPARMS;
1395
1396     /* If we have a list already, just return the existing list */
1397     if (syn->parms[pos].items != NULL) {
1398         *value = syn->parms[pos].items;
1399         return 0;
1400     }
1401
1402     code = _get_file_string(syn, pos, &str);
1403     if (code)
1404         return code;
1405
1406     /* Use strchr to split str into elements, and build a recursive list
1407      * from them. Hang this list off the configuration structure, so that
1408      * it is returned by any future calls to this function, and is freed
1409      * along with everything else when the syntax description is freed
1410      */
1411     last = &syn->parms[pos].items;
1412     start = str;
1413     while ((end = strchr(start, ' '))) {
1414         item = calloc(1, sizeof(struct cmd_item));
1415         item->data = malloc(end - start + 1);
1416         strlcpy(item->data, start, end - start + 1);
1417         *last = item;
1418         last = &item->next;
1419         for (start = end; *start == ' '; start++); /* skip any whitespace */
1420     }
1421
1422     /* Catch the final element */
1423     if (*start != '\0') {
1424         item = calloc(1, sizeof(struct cmd_item));
1425         item->data = malloc(strlen(start) + 1);
1426         strlcpy(item->data, start, strlen(start) + 1);
1427         *last = item;
1428     }
1429
1430     *value = syn->parms[pos].items;
1431
1432     return 0;
1433 }
1434
1435 int
1436 cmd_OptionAsFlag(struct cmd_syndesc *syn, int pos, int *value)
1437 {
1438     const char *str = NULL;
1439     int code;
1440
1441     code = _get_config_string(syn, pos, &str);
1442     if (code)
1443         return code;
1444
1445     if (str == NULL ||
1446         strcasecmp(str, "yes") == 0 ||
1447         strcasecmp(str, "true") == 0 ||
1448         atoi(str))
1449         *value = 1;
1450     else
1451         *value = 0;
1452
1453     return 0;
1454 }
1455
1456 int
1457 cmd_OptionPresent(struct cmd_syndesc *syn, int pos)
1458 {
1459     const char *str;
1460     int code;
1461
1462     code = _get_config_string(syn, pos, &str);
1463     if (code == 0)
1464         return 1;
1465
1466     return 0;
1467 }
1468
1469 int
1470 cmd_OpenConfigFile(const char *file)
1471 {
1472     if (globalConfig) {
1473         cmd_RawConfigFileFree(globalConfig);
1474         globalConfig = NULL;
1475     }
1476
1477     return cmd_RawConfigParseFile(file, &globalConfig);
1478 }
1479
1480 void
1481 cmd_SetCommandName(const char *command)
1482 {
1483     commandName = command;
1484 }
1485
1486 const cmd_config_section *
1487 cmd_RawFile(void)
1488 {
1489     return globalConfig;
1490 }
1491
1492 const cmd_config_section *
1493 cmd_RawSection(void)
1494 {
1495     if (globalConfig == NULL || commandName == NULL)
1496         return NULL;
1497
1498     return cmd_RawConfigGetList(globalConfig, commandName, NULL);
1499 }