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