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