stdlib/fmtmsg.c

   1 /* Copyright (C) 1997, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3    Contributed by Ulrich Drepper <drepper@cygnus.com>, 1997.
   4
   5    The GNU C Library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 2.1 of the License, or (at your option) any later version.
   9
  10    The GNU C Library 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 GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with the GNU C Library; if not, write to the Free
  17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  18    02111-1307 USA.  */
  19
  20 #include <fmtmsg.h>
  21 #include <bits/libc-lock.h>
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <sys/syslog.h>
  26 #ifdef USE_IN_LIBIO
  27 # include <wchar.h>
  28 #endif
  29
  30
  31 /* We have global data, protect the modification.  */
  32 __libc_lock_define_initialized (static, lock)
  33
  34
  35 enum
  36 {
  37   label_mask = 0x01,
  38   severity_mask = 0x02,
  39   text_mask = 0x04,
  40   action_mask = 0x08,
  41   tag_mask = 0x10,
  42   all_mask = label_mask | severity_mask | text_mask | action_mask | tag_mask
  43 };
  44
  45 static const struct
  46 {
  47   size_t len;
  48   /* Adjust the size if new elements are added.  */
  49   const char name[12];
  50 } keywords[] =
  51   {
  52     { 5, "label" },
  53     { 8, "severity" },
  54     { 4, "text" },
  55     { 6, "action"},
  56     { 3, "tag" }
  57   };
  58 #define NKEYWORDS (sizeof( keywords) / sizeof (keywords[0]))
  59
  60
  61 struct severity_info
  62 {
  63   int severity;
  64   const char *string;
  65   struct severity_info *next;
  66 };
  67
  68
  69 /* List of known severities.  */
  70 static const struct severity_info nosev =
  71 {
  72   MM_NOSEV, "", NULL
  73 };
  74 static const struct severity_info haltsev =
  75 {
  76   MM_HALT, "HALT", (struct severity_info *) &nosev
  77 };
  78 static const struct severity_info errorsev =
  79 {
  80   MM_ERROR, "ERROR", (struct severity_info *) &haltsev
  81 };
  82 static const struct severity_info warningsev =
  83 {
  84   MM_WARNING, "WARNING", (struct severity_info *) &errorsev
  85 };
  86 static const struct severity_info infosev =
  87 {
  88   MM_INFO, "INFO", (struct severity_info *) &warningsev
  89 };
  90
  91 /* Start of the list.  */
  92 static struct severity_info *severity_list = (struct severity_info *) &infosev;
  93
  94 /* Mask of values we will print.  */
  95 static int print;
  96
  97 /* Prototypes for local functions.  */
  98 static void init (void);
  99 static int internal_addseverity (int severity, const char *string)
 100      internal_function;
 101
 102
 103 int
 104 fmtmsg (long int classification, const char *label, int severity,
 105         const char *text, const char *action, const char *tag)
 106 {
 107   __libc_once_define (static, once);
 108   int result = MM_OK;
 109   struct severity_info *severity_rec;
 110
 111   /* make sure everything is initialized.  */
 112   __libc_once (once, init);
 113
 114   /* Start the real work.  First check whether the input is ok.  */
 115   if (label != MM_NULLLBL)
 116     {
 117       /* Must be two fields, separated by a colon.  */
 118       const char *cp = strchr (label, ':');
 119       if (cp == NULL)
 120         return MM_NOTOK;
 121
 122       /* The first field must not contain more then 10 bytes.  */
 123       if (cp - label > 10
 124           /* The second field must not have more then 14 bytes.  */
 125           || strlen (cp + 1) > 14)
 126         return MM_NOTOK;
 127     }
 128
 129   for (severity_rec = severity_list; severity_rec != NULL;
 130        severity_rec = severity_rec->next)
 131     if (severity == severity_rec->severity)
 132       /* Bingo.  */
 133       break;
 134
 135   /* If we don't know anything about the severity level return an error.  */
 136   if (severity_rec == NULL)
 137     return MM_NOTOK;
 138
 139
 140   /* Now we can print.  */
 141   if (classification & MM_PRINT)
 142     {
 143       int do_label = (print & label_mask) && label != MM_NULLLBL;
 144       int do_severity = (print & severity_mask) && severity != MM_NULLSEV;
 145       int do_text = (print & text_mask) && text != MM_NULLTXT;
 146       int do_action = (print & action_mask) && action != MM_NULLACT;
 147       int do_tag = (print & tag_mask) && tag != MM_NULLTAG;
 148
 149 #ifdef USE_IN_LIBIO
 150       if (_IO_fwide (stderr, 0) > 0)
 151         {
 152           if (__fwprintf (stderr, L"%s%s%s%s%s%s%s%s%s%s\n",
 153                           do_label ? label : "",
 154                           do_label
 155                           && (do_severity | do_text | do_action | do_tag)
 156                           ? ": " : "",
 157                           do_severity ? severity_rec->string : "",
 158                           do_severity && (do_text | do_action | do_tag)
 159                           ? ": " : "",
 160                           do_text ? text : "",
 161                           do_text && (do_action | do_tag) ? "\n" : "",
 162                           do_action ? "TO FIX: " : "",
 163                           do_action ? action : "",
 164                           do_action && do_tag ? "  " : "",
 165                           do_tag ? tag : "") < 0)
 166             /* Oh, oh.  An error occurred during the output.  */
 167             result = MM_NOMSG;
 168         }
 169       else
 170 #endif
 171         if (fprintf (stderr, "%s%s%s%s%s%s%s%s%s%s\n",
 172                      do_label ? label : "",
 173                      do_label && (do_severity | do_text | do_action | do_tag)
 174                      ? ": " : "",
 175                      do_severity ? severity_rec->string : "",
 176                      do_severity && (do_text | do_action | do_tag) ? ": " : "",
 177                      do_text ? text : "",
 178                      do_text && (do_action | do_tag) ? "\n" : "",
 179                      do_action ? "TO FIX: " : "",
 180                      do_action ? action : "",
 181                      do_action && do_tag ? "  " : "",
 182                      do_tag ? tag : "") < 0)
 183           /* Oh, oh.  An error occurred during the output.  */
 184           result = MM_NOMSG;
 185     }
 186
 187   if (classification & MM_CONSOLE)
 188     {
 189       int do_label = label != MM_NULLLBL;
 190       int do_severity = severity != MM_NULLSEV;
 191       int do_text = text != MM_NULLTXT;
 192       int do_action = action != MM_NULLACT;
 193       int do_tag = tag != MM_NULLTAG;
 194
 195       syslog (LOG_ERR, "%s%s%s%s%s%s%s%s%s%s\n",
 196               do_label ? label : "",
 197               do_label && (do_severity | do_text | do_action | do_tag)
 198               ? ": " : "",
 199               do_severity ? severity_rec->string : "",
 200               do_severity && (do_text | do_action | do_tag) ? ": " : "",
 201               do_text ? text : "",
 202               do_text && (do_action | do_tag) ? "\n" : "",
 203               do_action ? "TO FIX: " : "",
 204               do_action ? action : "",
 205               do_action && do_tag ? "  " : "",
 206               do_tag ? tag : "");
 207     }
 208
 209   return result;
 210 }
 211
 212
 213 /* Initialize from environment variable content.  */
 214 static void
 215 init (void)
 216 {
 217   const char *msgverb_var = getenv ("MSGVERB");
 218   const char *sevlevel_var = getenv ("SEV_LEVEL");
 219
 220   if (msgverb_var != NULL && msgverb_var[0] != '\0')
 221     {
 222       /* Using this extra variable allows us to work without locking.  */
 223       do
 224         {
 225           size_t cnt;
 226
 227           for (cnt = 0; cnt < NKEYWORDS; ++cnt)
 228             if (memcmp (msgverb_var,
 229                         keywords[cnt].name, keywords[cnt].len) == 0
 230                 && (msgverb_var[keywords[cnt].len] == ':'
 231                     || msgverb_var[keywords[cnt].len] == '\0'))
 232               break;
 233
 234           if (cnt < NKEYWORDS)
 235             {
 236               print |= 1 << cnt;
 237
 238               msgverb_var += keywords[cnt].len;
 239               if (msgverb_var[0] == ':')
 240                 ++msgverb_var;
 241             }
 242           else
 243             {
 244               /* We found an illegal keyword in the environment
 245                  variable.  The specifications say that we print all
 246                  fields.  */
 247               print = all_mask;
 248               break;
 249             }
 250         }
 251       while (msgverb_var[0] != '\0');
 252     }
 253   else
 254     print = all_mask;
 255
 256
 257   if (sevlevel_var != NULL)
 258     {
 259       __libc_lock_lock (lock);
 260
 261       while (sevlevel_var[0] != '\0')
 262         {
 263           const char *end = __strchrnul (sevlevel_var, ':');
 264           int level;
 265
 266           /* First field: keyword.  This is not used here but it must be
 267              present.  */
 268           while (sevlevel_var < end)
 269             if (*sevlevel_var++ == ',')
 270               break;
 271
 272           if (sevlevel_var < end)
 273             {
 274               /* Second field: severity level, a number.  */
 275               char *cp;
 276
 277               level = strtol (sevlevel_var, &cp, 0);
 278               if (cp != sevlevel_var && cp < end && *cp++ == ','
 279                   && level > MM_INFO)
 280                 {
 281                   const char *new_string;
 282
 283                   new_string = __strndup (cp, end - cp);
 284
 285                   if (new_string != NULL
 286                       && (internal_addseverity (level, new_string)
 287                           != MM_OK))
 288                     free ((char *) new_string);
 289                 }
 290             }
 291
 292           sevlevel_var = end + (*end == ':' ? 1 : 0);
 293         }
 294     }
 295 }
 296
 297
 298 /* Add the new entry to the list.  */
 299 static int
 300 internal_function
 301 internal_addseverity (int severity, const char *string)
 302 {
 303   struct severity_info *runp, *lastp;
 304   int result = MM_OK;
 305
 306   /* First see if there is already a record for the severity level.  */
 307   for (runp = severity_list, lastp = NULL; runp != NULL; runp = runp-> next)
 308     if (runp->severity == severity)
 309       break;
 310     else
 311       lastp = runp;
 312
 313   if (runp != NULL)
 314     {
 315       /* Release old string.  */
 316       free ((char *) runp->string);
 317
 318       if (string != NULL)
 319         /* Change the string.  */
 320         runp->string = string;
 321       else
 322         {
 323           /* Remove the severity class.  */
 324           if (lastp == NULL)
 325             severity_list = runp->next;
 326           else
 327             lastp->next = runp->next;
 328
 329           free (runp);
 330         }
 331     }
 332   else if (string != NULL)
 333     {
 334       runp = malloc (sizeof (*runp));
 335       if (runp == NULL)
 336         result = MM_NOTOK;
 337       else
 338         {
 339           runp->severity = severity;
 340           runp->next = severity_list;
 341           runp->string = string;
 342           severity_list = runp;
 343         }
 344     }
 345   else
 346     /* We tried to remove a non-existing severity class.  */
 347     result = MM_NOTOK;
 348
 349   return result;
 350 }
 351
 352
 353 /* Add new severity level or remove old one.  */
 354 int
 355 addseverity (int severity, const char *string)
 356 {
 357   int result;
 358   const char *new_string;
 359
 360   /* Prevent illegal SEVERITY values.  */
 361   if (severity <= MM_INFO)
 362     return MM_NOTOK;
 363
 364   if (string == NULL)
 365     /* We want to remove the severity class.  */
 366     new_string = NULL;
 367   else
 368     {
 369       new_string = __strdup (string);
 370
 371       if (new_string == NULL)
 372         /* Allocation failed or illegal value.  */
 373         return MM_NOTOK;
 374     }
 375
 376   /* Protect the global data.  */
 377   __libc_lock_lock (lock);
 378
 379   /* Do the real work.  */
 380   result = internal_addseverity (severity, string);
 381
 382   if (result != MM_OK)
 383     /* Free the allocated string.  */
 384     free ((char *) new_string);
 385
 386   /* Release the lock.  */
 387   __libc_lock_unlock (lock);
 388
 389   return result;
 390 }
 391
 392
 393 libc_freeres_fn (free_mem)
 394 {
 395   struct severity_info *runp = severity_list;
 396
 397   while (runp != NULL)
 398     if (runp->severity > MM_INFO)
 399       {
 400         /* This is data we have to release.  */
 401         struct severity_info *here = runp;
 402         free ((char *) runp->string);
 403         runp = runp->next;
 404         free (here);
 405       }
 406     else
 407       runp = runp->next;
 408 }