cmd: exit status zero from -help
[openafs.git] / src / cmd / cmd.c
index 0389188..6887454 100644 (file)
@@ -32,6 +32,8 @@ static int enablePositional = 1;
 static int enableAbbreviation = 1;
 static void *beforeRock, *afterRock;
 static char initcmd_opcode[] = "initcmd";      /*Name of initcmd opcode */
+static cmd_config_section *globalConfig = NULL;
+static const char *commandName = NULL;
 
 /* take name and string, and return null string if name is empty, otherwise return
    the concatenation of the two strings */
@@ -42,9 +44,8 @@ NName(char *a1, char *a2)
     if (strlen(a1) == 0) {
         return "";
     } else {
-        strncpy(tbuffer, a1, sizeof(tbuffer));
-        strncat(tbuffer, a2, sizeof(tbuffer));
-        tbuffer[sizeof(tbuffer)-1]='\0';
+        strlcpy(tbuffer, a1, sizeof(tbuffer));
+        strlcat(tbuffer, a2, sizeof(tbuffer));
         return tbuffer;
     }
 }
@@ -101,8 +102,11 @@ FindType(struct cmd_syndesc *as, char *aname)
            alias = alias->next;
        }
 
-       /* A hidden option must be a full match (no best matches) */
-       if (as->parms[i].flags & CMD_HIDE || !enableAbbreviation)
+       /* A hidden option, or one which cannot be abbreviated,
+        * must be a full match (no best matches) */
+       if (as->parms[i].flags & CMD_HIDE ||
+           as->parms[i].flags & CMD_NOABBRV ||
+           !enableAbbreviation)
            continue;
 
        if (strncmp(as->parms[i].name, aname, cmdlen) == 0) {
@@ -191,6 +195,7 @@ PrintSyntax(struct cmd_syndesc *as)
     int i;
     struct cmd_parmdesc *tp;
     char *str;
+    char *name;
     size_t len;
     size_t xtralen;
 
@@ -214,10 +219,30 @@ PrintSyntax(struct cmd_syndesc *as)
            continue;           /* seeked over slot */
        if (tp->flags & CMD_HIDE)
            continue;           /* skip hidden options */
+
+       /* The parameter name is the real name, plus any aliases */
+       if (!tp->aliases) {
+           name = strdup(tp->name);
+       } else {
+           size_t namelen;
+           struct cmd_item *alias;
+           namelen = strlen(tp->name) + 1;
+           for (alias = tp->aliases; alias != NULL; alias = alias->next)
+               namelen+=strlen(alias->data) + 3;
+
+           name = malloc(namelen);
+           strlcpy(name, tp->name, namelen);
+
+           for (alias = tp->aliases; alias != NULL; alias = alias->next) {
+               strlcat(name, " | ", namelen);
+               strlcat(name, alias->data, namelen);
+           }
+       }
+
        /* Work out if we can fit what we want to on this line, or if we need to
         * start a new one */
        str = ParmHelpString(tp);
-       xtralen = 1 + strlen(tp->name) + strlen(str) +
+       xtralen = 1 + strlen(name) + strlen(str) +
                  ((tp->flags & CMD_OPTIONAL)? 2: 0);
 
        if (len + xtralen > 78) {
@@ -227,10 +252,11 @@ PrintSyntax(struct cmd_syndesc *as)
 
        printf(" %s%s%s%s",
               tp->flags & CMD_OPTIONAL?"[":"",
-              tp->name,
+              name,
               str,
               tp->flags & CMD_OPTIONAL?"]":"");
        free(str);
+       free(name);
        len+=xtralen;
     }
     printf("\n");
@@ -424,9 +450,8 @@ cmd_CreateSyntax(char *aname,
 
     /* copy in name, etc */
     if (aname) {
-       td->name = malloc(strlen(aname) + 1);
+       td->name = strdup(aname);
        assert(td->name);
-       strcpy(td->name, aname);
     } else {
        td->name = NULL;
        noOpcodes = 1;
@@ -436,9 +461,8 @@ cmd_CreateSyntax(char *aname,
        if (ahelp == (char *)CMD_HIDDEN) {
            td->flags |= CMD_HIDDEN;
        } else {
-           td->help = malloc(strlen(ahelp) + 1);
+           td->help = strdup(ahelp);
            assert(td->help);
-           strcpy(td->help, ahelp);
        }
     } else
        td->help = NULL;
@@ -462,9 +486,8 @@ cmd_CreateAlias(struct cmd_syndesc *as, char *aname)
     td = malloc(sizeof(struct cmd_syndesc));
     assert(td);
     memcpy(td, as, sizeof(struct cmd_syndesc));
-    td->name = malloc(strlen(aname) + 1);
+    td->name = strdup(aname);
     assert(td->name);
-    strcpy(td->name, aname);
     td->flags |= CMD_ALIAS;
     /* if ever free things, make copy of help string, too */
 
@@ -508,8 +531,8 @@ cmd_Seek(struct cmd_syndesc *as, int apos)
 }
 
 int
-cmd_AddParmAtOffset(struct cmd_syndesc *as, char *aname, int atype,
-                   afs_int32 aflags, char *ahelp, int ref)
+cmd_AddParmAtOffset(struct cmd_syndesc *as, int ref, char *aname, int atype,
+                   afs_int32 aflags, char *ahelp)
 {
     struct cmd_parmdesc *tp;
 
@@ -517,16 +540,14 @@ cmd_AddParmAtOffset(struct cmd_syndesc *as, char *aname, int atype,
        return CMD_EXCESSPARMS;
     tp = &as->parms[ref];
 
-    tp->name = malloc(strlen(aname) + 1);
+    tp->name = strdup(aname);
     assert(tp->name);
-    strcpy(tp->name, aname);
     tp->type = atype;
     tp->flags = aflags;
     tp->items = NULL;
     if (ahelp) {
-       tp->help = malloc(strlen(ahelp) + 1);
+       tp->help = strdup(ahelp);
        assert(tp->help);
-       strcpy(tp->help, ahelp);
     } else
        tp->help = NULL;
 
@@ -545,7 +566,7 @@ cmd_AddParm(struct cmd_syndesc *as, char *aname, int atype,
     if (as->nParms >= CMD_MAXPARMS)
        return CMD_EXCESSPARMS;
 
-    return cmd_AddParmAtOffset(as, aname, atype, aflags, ahelp, as->nParms++);
+    return cmd_AddParmAtOffset(as, as->nParms++, aname, atype, aflags, ahelp);
 }
 
 int
@@ -581,9 +602,8 @@ AddItem(struct cmd_parmdesc *aparm, char *aval, char *pname)
 
     ti = calloc(1, sizeof(struct cmd_item));
     assert(ti);
-    ti->data = malloc(strlen(aval) + 1);
+    ti->data = strdup(aval);
     assert(ti->data);
-    strcpy(ti->data, aval);
     /* now put ti at the *end* of the list */
     if ((ni = aparm->items)) {
        for (; ni; ni = ni->next)
@@ -690,13 +710,12 @@ InsertInitOpcode(int *aargc, char **aargv)
     }
 
     /* Create space for the initial opcode & fill it in */
-    pinitopcode = malloc(sizeof(initcmd_opcode));
+    pinitopcode = strdup(initcmd_opcode);
     if (!pinitopcode) {
        fprintf(stderr, "%s: Can't malloc initial opcode space\n", aargv[0]);
        free(newargv);
        return (NULL);
     }
-    strcpy(pinitopcode, initcmd_opcode);
 
     /* Move all the items in the old argv into the new argv, in their
      * proper places */
@@ -747,16 +766,17 @@ initSyntax(void)
        ts = cmd_CreateSyntax("apropos", AproposProc, NULL,
                              "search by help text");
        cmd_AddParm(ts, "-topic", CMD_SINGLE, CMD_REQUIRED, "help string");
-       ts = cmd_CreateSyntax("version", VersionProc, NULL,
-                             (char *)CMD_HIDDEN);
-       ts = cmd_CreateSyntax("-version", VersionProc, NULL,
-                             (char *)CMD_HIDDEN);
-       ts = cmd_CreateSyntax("-help", HelpProc, NULL,
-                             (char *)CMD_HIDDEN);
-       ts = cmd_CreateSyntax("--version", VersionProc, NULL,
-                             (char *)CMD_HIDDEN);
-       ts = cmd_CreateSyntax("--help", HelpProc, NULL,
-                             (char *)CMD_HIDDEN);
+
+       cmd_CreateSyntax("version", VersionProc, NULL,
+                        (char *)CMD_HIDDEN);
+       cmd_CreateSyntax("-version", VersionProc, NULL,
+                        (char *)CMD_HIDDEN);
+       cmd_CreateSyntax("-help", HelpProc, NULL,
+                        (char *)CMD_HIDDEN);
+       cmd_CreateSyntax("--version", VersionProc, NULL,
+                        (char *)CMD_HIDDEN);
+       cmd_CreateSyntax("--help", HelpProc, NULL,
+                        (char *)CMD_HIDDEN);
     }
 }
 
@@ -771,7 +791,6 @@ cmd_Parse(int argc, char **argv, struct cmd_syndesc **outsyntax)
     struct cmd_syndesc *ts = NULL;
     struct cmd_parmdesc *tparm;
     int i;
-    int j = 0;
     int curType;
     int positional;
     int ambig;
@@ -896,6 +915,7 @@ cmd_Parse(int argc, char **argv, struct cmd_syndesc **outsyntax)
         * are considered switches.  This allow negative numbers. */
 
        if ((argv[i][0] == '-') && !isdigit(argv[i][1])) {
+           int j;
 
            /* Find switch */
            if (strrchr(argv[i], '=') != NULL) {
@@ -968,10 +988,17 @@ cmd_Parse(int argc, char **argv, struct cmd_syndesc **outsyntax)
                continue;
            }
 
-           if (ts->parms[j].type != CMD_FLAG) {
-               code = AddItem(tparm, argv[i], pname);
-               if (code)
+           if (tparm->type == CMD_SINGLE ||
+               tparm->type == CMD_SINGLE_OR_FLAG) {
+               if (tparm->items) {
+                   fprintf(stderr, "%sToo many values after switch %s\n",
+                           NName(pname, ": "), tparm->name);
+                   code = CMD_NOTLIST;
                    goto out;
+               }
+               AddItem(tparm, argv[i], pname);        /* Add to end of list */
+           } else if (tparm->type == CMD_LIST) {
+               AddItem(tparm, argv[i], pname);        /* Add to end of list */
            }
 
            /* Now, if we're in positional mode, advance to the next item */
@@ -991,7 +1018,7 @@ cmd_Parse(int argc, char **argv, struct cmd_syndesc **outsyntax)
        /* Display full help syntax if we don't have subcommands */
        if (noOpcodes)
            PrintFlagHelp(ts);
-       code = CMD_USAGE;
+       code = CMD_HELP;
        goto out;
     }
 
@@ -1034,8 +1061,12 @@ cmd_Dispatch(int argc, char **argv)
     int code;
 
     code = cmd_Parse(argc, argv, &ts);
-    if (code)
+    if (code) {
+       if (code == CMD_HELP) {
+           code = 0; /* displaying help is not an error */
+       }
        return code;
+    }
 
     /*
      * Before calling the beforeProc and afterProc and all the implications
@@ -1110,9 +1141,8 @@ CopyBackArgs(struct cmd_token *alist, char **argv,
     count = 0;
     if (amaxn <= 1)
        return CMD_TOOMANY;
-    *argv = (char *)malloc(strlen(INITSTR) + 1);
+    *argv = strdup(INITSTR);
     assert(*argv);
-    strcpy(*argv, INITSTR);
     amaxn--;
     argv++;
     count++;
@@ -1127,7 +1157,7 @@ CopyBackArgs(struct cmd_token *alist, char **argv,
        argv++;
        count++;
     }
-    *(argv++) = 0;             /* use last slot for terminating null */
+    *argv = NULL;              /* use last slot for terminating null */
     /* don't count terminating null */
     *an = count;
     return 0;
@@ -1177,9 +1207,8 @@ cmd_ParseLine(char *aline, char **argv, afs_int32 * an, afs_int32 amaxn)
                ttok = malloc(sizeof(struct cmd_token));
                assert(ttok);
                ttok->next = NULL;
-               ttok->key = malloc(strlen(tbuffer) + 1);
+               ttok->key = strdup(tbuffer);
                assert(ttok->key);
-               strcpy(ttok->key, tbuffer);
                if (last) {
                    last->next = ttok;
                    last = ttok;
@@ -1215,18 +1244,114 @@ cmd_ParseLine(char *aline, char **argv, afs_int32 * an, afs_int32 amaxn)
     }
 }
 
-int
-cmd_OptionAsInt(struct cmd_syndesc *syn, int pos, int *value)
+/* Read a string in from our configuration file. This checks in
+ * multiple places within this file - firstly in the section
+ * [command_subcommand], then in [command], then in [subcommand]
+ *
+ * Returns CMD_MISSING if there is no configuration file configured,
+ * or if the file doesn't contain information for the specified option
+ * in any of these sections.
+ */
+
+static int
+_get_file_string(struct cmd_syndesc *syn, int pos, const char **str)
+{
+    char *section;
+    char *optionName;
+
+    /* Nothing on the command line, try the config file if we have one */
+    if (globalConfig == NULL)
+       return CMD_MISSING;
+
+    /* March past any leading -'s */
+    for (optionName = syn->parms[pos].name;
+        *optionName == '-'; optionName++);
+
+    /* First, try the command_subcommand form */
+    if (syn->name != NULL && commandName != NULL) {
+       asprintf(&section, "%s_%s", commandName, syn->name);
+       *str = cmd_RawConfigGetString(globalConfig, NULL, section,
+                                     optionName, NULL);
+       free(section);
+       if (*str)
+           return 0;
+    }
+
+    /* Then, try the command form */
+    if (commandName != NULL) {
+       *str = cmd_RawConfigGetString(globalConfig, NULL, commandName,
+                                     optionName, NULL);
+       if (*str)
+           return 0;
+    }
+
+    /* Then, the defaults section */
+    *str = cmd_RawConfigGetString(globalConfig, NULL, "defaults",
+                                 optionName, NULL);
+    if (*str)
+       return 0;
+
+    /* Nothing there, return MISSING */
+    return CMD_MISSING;
+}
+
+static int
+_get_config_string(struct cmd_syndesc *syn, int pos, const char **str)
 {
+    *str = NULL;
+
     if (pos > syn->nParms)
        return CMD_EXCESSPARMS;
-    if (syn->parms[pos].items == NULL ||
-       syn->parms[pos].items->data == NULL)
-       return CMD_MISSING;
+
+    /* It's a flag, they probably shouldn't be using this interface to access
+     * it, but don't blow up for now */
     if (syn->parms[pos].items == &dummy)
+        return 0;
+
+    /* We have a value on the command line - this overrides anything in the
+     * configuration file */
+    if (syn->parms[pos].items != NULL &&
+       syn->parms[pos].items->data != NULL) {
+       *str = syn->parms[pos].items->data;
        return 0;
+    }
+
+    return _get_file_string(syn, pos, str);
+}
+
+int
+cmd_OptionAsInt(struct cmd_syndesc *syn, int pos, int *value)
+{
+    const char *str;
+    int code;
+
+    code =_get_config_string(syn, pos, &str);
+    if (code)
+       return code;
+
+    if (str == NULL)
+       return CMD_MISSING;
 
-    *value = strtol(syn->parms[pos].items->data, NULL, 10);
+    *value = strtol(str, NULL, 10);
+
+    return 0;
+}
+
+int
+cmd_OptionAsUint(struct cmd_syndesc *syn, int pos,
+                unsigned int *value)
+{
+    const char *str;
+    int code;
+
+    code = _get_config_string(syn, pos, &str);
+    if (code)
+       return code;
+
+    if (str == NULL)
+       return CMD_MISSING;
+
+    *value = strtoul(str, NULL, 10);
 
     return 0;
 }
@@ -1234,17 +1359,19 @@ cmd_OptionAsInt(struct cmd_syndesc *syn, int pos, int *value)
 int
 cmd_OptionAsString(struct cmd_syndesc *syn, int pos, char **value)
 {
-    if (pos > syn->nParms)
-       return CMD_EXCESSPARMS;
-    if (syn->parms[pos].items == NULL || syn->parms[pos].items->data == NULL)
+    const char *str;
+    int code;
+
+    code = _get_config_string(syn, pos, &str);
+    if (code)
+       return code;
+
+    if (str == NULL)
        return CMD_MISSING;
-    if (syn->parms[pos].items == &dummy)
-       return 0;
 
     if (*value)
        free(*value);
-
-    *value = strdup(syn->parms[pos].items->data);
+    *value = strdup(str);
 
     return 0;
 }
@@ -1252,32 +1379,115 @@ cmd_OptionAsString(struct cmd_syndesc *syn, int pos, char **value)
 int
 cmd_OptionAsList(struct cmd_syndesc *syn, int pos, struct cmd_item **value)
 {
+    const char *str;
+    struct cmd_item *item, **last;
+    const char *start, *end;
+    int code;
+
     if (pos > syn->nParms)
        return CMD_EXCESSPARMS;
-    if (syn->parms[pos].items == NULL)
-       return CMD_MISSING;
+
+    /* If we have a list already, just return the existing list */
+    if (syn->parms[pos].items != NULL) {
+       *value = syn->parms[pos].items;
+       return 0;
+    }
+
+    code = _get_file_string(syn, pos, &str);
+    if (code)
+       return code;
+
+    /* Use strchr to split str into elements, and build a recursive list
+     * from them. Hang this list off the configuration structure, so that
+     * it is returned by any future calls to this function, and is freed
+     * along with everything else when the syntax description is freed
+     */
+    last = &syn->parms[pos].items;
+    start = str;
+    while ((end = strchr(start, ' '))) {
+       item = calloc(1, sizeof(struct cmd_item));
+       item->data = malloc(end - start + 1);
+       strlcpy(item->data, start, end - start + 1);
+       *last = item;
+       last = &item->next;
+       for (start = end; *start == ' '; start++); /* skip any whitespace */
+    }
+
+    /* Catch the final element */
+    if (*start != '\0') {
+       item = calloc(1, sizeof(struct cmd_item));
+       item->data = malloc(strlen(start) + 1);
+       strlcpy(item->data, start, strlen(start) + 1);
+       *last = item;
+    }
 
     *value = syn->parms[pos].items;
+
     return 0;
 }
 
 int
 cmd_OptionAsFlag(struct cmd_syndesc *syn, int pos, int *value)
 {
-    if (pos > syn->nParms)
-       return CMD_EXCESSPARMS;
-    if (syn->parms[pos].items == NULL)
-       return CMD_MISSING;
+    const char *str = NULL;
+    int code;
+
+    code = _get_config_string(syn, pos, &str);
+    if (code)
+       return code;
+
+    if (str == NULL ||
+       strcasecmp(str, "yes") == 0 ||
+       strcasecmp(str, "true") == 0 ||
+       atoi(str))
+       *value = 1;
+    else
+       *value = 0;
 
-    *value = 1;
     return 0;
 }
 
 int
 cmd_OptionPresent(struct cmd_syndesc *syn, int pos)
 {
-    if (pos > syn->nParms || syn->parms[pos].items == NULL)
-       return 0;
+    const char *str;
+    int code;
 
-    return 1;
+    code = _get_config_string(syn, pos, &str);
+    if (code == 0)
+       return 1;
+
+    return 0;
+}
+
+int
+cmd_OpenConfigFile(const char *file)
+{
+    if (globalConfig) {
+       cmd_RawConfigFileFree(globalConfig);
+       globalConfig = NULL;
+    }
+
+    return cmd_RawConfigParseFile(file, &globalConfig);
+}
+
+void
+cmd_SetCommandName(const char *command)
+{
+    commandName = command;
+}
+
+const cmd_config_section *
+cmd_RawFile(void)
+{
+    return globalConfig;
+}
+
+const cmd_config_section *
+cmd_RawSection(void)
+{
+    if (globalConfig == NULL || commandName == NULL)
+       return NULL;
+
+    return cmd_RawConfigGetList(globalConfig, commandName, NULL);
 }