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