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