server/desc.c

   1 /* desc.c - variable/command description handling for upsd
   2
   3    Copyright (C) 2003  Russell Kroll <rkroll@exploits.org>
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2 of the License, or
   8    (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software
  17    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  18 */
  19
  20 #include "config.h"  /* must be the first header */
  21
  22 #include <string.h>
  23
  24 #include "common.h"
  25 #include "parseconf.h"
  26
  27 #include "desc.h"
  28
  29 extern const char *datapath;
  30
  31 typedef struct dlist_s {
  32         char    *name;
  33         char    *desc;
  34         struct dlist_s  *next;
  35 } dlist_t;
  36
  37 static dlist_t  *cmd_list = NULL, *var_list = NULL;
  38
  39 static void list_free(dlist_t *ptr)
  40 {
  41         dlist_t *next;
  42
  43         while (ptr) {
  44                 next = ptr->next;
  45
  46                 free(ptr->name);
  47                 free(ptr->desc);
  48                 free(ptr);
  49
  50                 ptr = next;
  51         }
  52 }
  53
  54 static const char *list_get(const dlist_t *list, const char *name)
  55 {
  56         const dlist_t   *temp;
  57
  58         for (temp = list; temp != NULL; temp = temp->next) {
  59
  60                 if (!strcasecmp(temp->name, name)) {
  61                         return temp->desc;
  62                 }
  63         }
  64
  65         return NULL;
  66 }
  67
  68 static void desc_add(dlist_t **list, const char *name, const char *desc)
  69 {
  70         dlist_t *temp;
  71
  72         for (temp = *list; temp != NULL; temp = temp->next) {
  73                 if (!strcasecmp(temp->name, name)) {
  74                         break;
  75                 }
  76         }
  77
  78         if (temp == NULL) {
  79                 temp = xcalloc(1, sizeof(*temp));
  80                 temp->name = xstrdup(name);
  81                 temp->next = *list;
  82                 *list = temp;
  83         }
  84
  85         free(temp->desc);
  86         temp->desc = xstrdup(desc);
  87 }
  88
  89 static void desc_file_err(const char *errmsg)
  90 {
  91         upslogx(LOG_ERR, "Fatal error in parseconf (cmdvartab): %s", errmsg);
  92 }
  93
  94 /* interface */
  95
  96 void desc_load(void)
  97 {
  98         char    fn[SMALLBUF];
  99         PCONF_CTX_t     ctx;
 100
 101         snprintf(fn, sizeof(fn), "%s/cmdvartab", datapath);
 102
 103         pconf_init(&ctx, desc_file_err);
 104
 105         /* this file is not required */
 106         if (!pconf_file_begin(&ctx, fn)) {
 107                 upslogx(LOG_INFO, "%s not found - disabling descriptions", fn);
 108                 pconf_finish(&ctx);
 109                 return;
 110         }
 111
 112         while (pconf_file_next(&ctx)) {
 113                 if (pconf_parse_error(&ctx)) {
 114                         upslogx(LOG_ERR, "Parse error: %s:%d: %s", fn, ctx.linenum, ctx.errmsg);
 115                         continue;
 116                 }
 117
 118                 if (ctx.numargs < 3) {
 119                         continue;
 120                 }
 121
 122                 if (!strcmp(ctx.arglist[0], "CMDDESC")) {
 123                         desc_add(&cmd_list, ctx.arglist[1], ctx.arglist[2]);
 124                         continue;
 125                 }
 126
 127                 if (!strcmp(ctx.arglist[0], "VARDESC")) {
 128                         desc_add(&var_list, ctx.arglist[1], ctx.arglist[2]);
 129                         continue;
 130                 }
 131
 132                 /* unknown */
 133         }
 134
 135         pconf_finish(&ctx);
 136 }
 137
 138 void desc_free(void)
 139 {
 140         list_free(cmd_list);
 141         list_free(var_list);
 142
 143         cmd_list = var_list = NULL;
 144 }
 145
 146 const char *desc_get_cmd(const char *name)
 147 {
 148         return list_get(cmd_list, name);
 149 }
 150
 151 const char *desc_get_var(const char *name)
 152 {
 153         return list_get(var_list, name);
 154 }