0658f455abacac48000729020ff5b389320fd38d
[kopensolaris-gnu/glibc.git] / iconv / gconv_conf.c
1 /* Handle configuration data.
2    Copyright (C) 1997, 1998 Free Software Foundation, Inc.
3    This file is part of the GNU C Library.
4    Contributed by Ulrich Drepper <drepper@cygnus.com>, 1997.
5
6    The GNU C Library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Library General Public License as
8    published by the Free Software Foundation; either version 2 of the
9    License, or (at your option) any later version.
10
11    The GNU C Library is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Library General Public License for more details.
15
16    You should have received a copy of the GNU Library General Public
17    License along with the GNU C Library; see the file COPYING.LIB.  If not,
18    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19    Boston, MA 02111-1307, USA.  */
20
21 #include <ctype.h>
22 #include <errno.h>
23 #include <limits.h>
24 #include <search.h>
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <unistd.h>
29 #include <sys/param.h>
30
31 #include <gconv_int.h>
32
33
34 /* This is the default path where we look for module lists.  */
35 static const char default_gconv_path[] = GCONV_PATH;
36
37 /* Name of the file containing the module information in the directories
38    along the path.  */
39 static const char gconv_conf_filename[] = "gconv-modules";
40
41 /* Filename extension for the modules.  */
42 #ifndef MODULE_EXT
43 # define MODULE_EXT ".so"
44 #endif
45 static const char gconv_module_ext[] = MODULE_EXT;
46
47 /* We have a few builtin transformations.  */
48 static struct gconv_module builtin_modules[] =
49 {
50 #define BUILTIN_TRANSFORMATION(From, ConstPfx, ConstLen, To, Cost, Name, \
51                                Fct, Init, End, MinF, MaxF, MinT, MaxT) \
52   {                                                                           \
53     from_pattern: From,                                                       \
54     from_constpfx: ConstPfx,                                                  \
55     from_constpfx_len: ConstLen,                                              \
56     from_regex: NULL,                                                         \
57     to_string: To,                                                            \
58     cost_hi: Cost,                                                            \
59     cost_lo: INT_MAX,                                                         \
60     module_name: Name                                                         \
61   },
62 #define BUILTIN_ALIAS(From, To)
63
64 #include "gconv_builtin.h"
65 };
66
67 #undef BUILTIN_TRANSFORMATION
68 #undef BUILTIN_ALIAS
69
70 static const char *
71 builtin_aliases[] =
72 {
73 #define BUILTIN_TRANSFORMATION(From, ConstPfx, ConstLen, To, Cost, Name, \
74                                Fct, Init, End, MinF, MaxF, MinT, MaxT)
75 #define BUILTIN_ALIAS(From, To) From " " To,
76
77 #include "gconv_builtin.h"
78 };
79
80 #ifdef USE_IN_LIBIO
81 # define __getdelim(line, len, c, fp) _IO_getdelim (line, len, c, fp)
82 #endif
83
84
85 /* Function for searching module.  */
86 static int
87 module_compare (const void *p1, const void *p2)
88 {
89   struct gconv_module *s1 = (struct gconv_module *) p1;
90   struct gconv_module *s2 = (struct gconv_module *) p2;
91   int result;
92
93   if (s1->from_pattern == NULL)
94     {
95       if (s2->from_pattern == NULL)
96         result = strcmp (s1->from_constpfx, s2->from_constpfx);
97       else
98         result = -1;
99     }
100   else if (s2->from_pattern == NULL)
101     result = 1;
102   else
103     result = strcmp (s1->from_pattern, s2->from_pattern);
104
105   if (result == 0)
106     result = strcmp (s1->to_string, s2->to_string);
107
108   return result;
109 }
110
111
112 /* Add new alias.  */
113 static inline void
114 add_alias (char *rp)
115 {
116   /* We now expect two more string.  The strings are normalized
117      (converted to UPPER case) and strored in the alias database.  */
118   struct gconv_alias *new_alias;
119   char *from, *to, *wp;
120
121   while (isspace (*rp))
122     ++rp;
123   from = wp = rp;
124   while (*rp != '\0' && !isspace (*rp))
125     ++rp;
126   if (*rp == '\0')
127     /* There is no `to' string on the line.  Ignore it.  */
128     return;
129   *rp++ = '\0';
130   to = wp = rp;
131   while (isspace (*rp))
132     ++rp;
133   while (*rp != '\0' && !isspace (*rp))
134     *wp++ = *rp++;
135   if (to == wp)
136     /* No `to' string, ignore the line.  */
137     return;
138   *wp++ = '\0';
139
140   new_alias = (struct gconv_alias *)
141     malloc (sizeof (struct gconv_alias) + (wp - from));
142   if (new_alias != NULL)
143     {
144       new_alias->fromname = memcpy ((char *) new_alias
145                                     + sizeof (struct gconv_alias),
146                                     from, wp - from);
147       new_alias->toname = new_alias->fromname + (to - from);
148
149       if (__tsearch (new_alias, &__gconv_alias_db, __gconv_alias_compare)
150           == NULL)
151         /* Something went wrong, free this entry.  */
152         free (new_alias);
153     }
154 }
155
156
157 /* Add new module.  */
158 static inline void
159 add_module (char *rp, const char *directory, size_t dir_len, void **modules,
160             size_t *nmodules, int modcounter)
161 {
162   /* We expect now
163      1. `from' name
164      2. `to' name
165      3. filename of the module
166      4. an optional cost value
167   */
168   struct gconv_module *new_module;
169   char *from, *to, *module, *wp;
170   size_t const_len;
171   int from_is_regex;
172   int need_ext;
173   int cost_hi;
174
175   while (isspace (*rp))
176     ++rp;
177   from = rp;
178   from_is_regex = 0;
179   while (*rp != '\0' && !isspace (*rp))
180     {
181       if (!isalnum (*rp) && *rp != '-' && *rp != '/' && *rp != '.'
182           && *rp != '_')
183         from_is_regex = 1;
184       ++rp;
185     }
186   if (*rp == '\0')
187     return;
188   *rp++ = '\0';
189   to = wp = rp;
190   while (isspace (*rp))
191     ++rp;
192   while (*rp != '\0' && !isspace (*rp))
193     *wp++ = *rp++;
194   if (*rp == '\0')
195     return;
196   *wp++ = '\0';
197   do
198     ++rp;
199   while (isspace (*rp));
200   module = wp;
201   while (*rp != '\0' && !isspace (*rp))
202     *wp++ = *rp++;
203   if (*rp == '\0')
204     {
205       /* There is no cost, use one by default.  */
206       *wp++ = '\0';
207       cost_hi = 1;
208     }
209   else
210     {
211       /* There might be a cost value.  */
212       char *endp;
213
214       *wp++ = '\0';
215       cost_hi = strtol (rp, &endp, 10);
216       if (rp == endp)
217         /* No useful information.  */
218         cost_hi = 1;
219     }
220
221   if (module[0] == '\0')
222     /* No module name given.  */
223     return;
224   if (module[0] == '/')
225     dir_len = 0;
226   else
227     /* Increment by one for the slash.  */
228     ++dir_len;
229
230   /* See whether we must add the ending.  */
231   need_ext = 0;
232   if (wp - module < sizeof (gconv_module_ext)
233       || memcmp (wp - sizeof (gconv_module_ext), gconv_module_ext,
234                  sizeof (gconv_module_ext)) != 0)
235     /* We must add the module extension.  */
236     need_ext = sizeof (gconv_module_ext) - 1;
237
238   /* We've collected all the information, now create an entry.  */
239
240   if (from_is_regex)
241     {
242       const_len = 0;
243       while (isalnum (from[const_len]) || from[const_len] == '-'
244              || from[const_len] == '/' || from[const_len] == '.'
245              || from[const_len] == '_')
246         ++const_len;
247     }
248   else
249     const_len = to - from - 1;
250
251   new_module = (struct gconv_module *) malloc (sizeof (struct gconv_module)
252                                                + (wp - from)
253                                                + dir_len + need_ext);
254   if (new_module != NULL)
255     {
256       char *tmp;
257
258       new_module->from_constpfx = memcpy ((char *) new_module
259                                           + sizeof (struct gconv_module),
260                                           from, to - from);
261       if (from_is_regex)
262         new_module->from_pattern = new_module->from_constpfx;
263       else
264         new_module->from_pattern = NULL;
265
266       new_module->from_constpfx_len = const_len;
267
268       new_module->from_regex = NULL;
269
270       new_module->to_string = memcpy ((char *) new_module->from_constpfx
271                                       + (to - from), to, module - to);
272
273       new_module->cost_hi = cost_hi;
274       new_module->cost_lo = modcounter;
275
276       new_module->module_name = (char *) new_module->to_string + (module - to);
277
278       if (dir_len == 0)
279         tmp = (char *) new_module->module_name;
280       else
281         {
282           tmp = __mempcpy ((char *) new_module->module_name,
283                            directory, dir_len - 1);
284           *tmp++ = '/';
285         }
286
287       tmp = __mempcpy (tmp, module, wp - module);
288
289       if (need_ext)
290         memcpy (tmp - 1, gconv_module_ext, sizeof (gconv_module_ext));
291
292       if (__tfind (new_module, modules, module_compare) == NULL)
293         if (__tsearch (new_module, modules, module_compare) == NULL)
294           /* Something went wrong while inserting the new module.  */
295           free (new_module);
296         else
297           ++*nmodules;
298     }
299 }
300
301
302 static void
303 insert_module (const void *nodep, VISIT value, int level)
304 {
305   if (value == preorder || value == leaf)
306     __gconv_modules_db[__gconv_nmodules++] = *(struct gconv_module **) nodep;
307 }
308
309 static void
310 nothing (void *unused __attribute__ ((unused)))
311 {
312 }
313
314
315 /* Read the next configuration file.  */
316 static void
317 internal_function
318 read_conf_file (const char *filename, const char *directory, size_t dir_len,
319                 void **modules, size_t *nmodules)
320 {
321   FILE *fp = fopen (filename, "r");
322   char *line = NULL;
323   size_t line_len = 0;
324   int modcounter = 0;
325
326   /* Don't complain if a file is not present or readable, simply silently
327      ignore it.  */
328   if (fp == NULL)
329     return;
330
331   /* Process the known entries of the file.  Comments start with `#' and
332      end with the end of the line.  Empty lines are ignored.  */
333   while (!feof_unlocked (fp))
334     {
335       char *rp, *endp, *word;
336       ssize_t n = __getdelim (&line, &line_len, '\n', fp);
337       if (n < 0)
338         /* An error occurred.  */
339         break;
340
341       rp = line;
342       /* Terminate the line (excluding comments or newline) by an NUL byte
343          to simplify the following code.  */
344       endp = strchr (rp, '#');
345       if (endp != NULL)
346         *endp = '\0';
347       else
348         if (rp[n - 1] == '\n')
349           rp[n - 1] = '\0';
350
351       while (isspace (*rp))
352         ++rp;
353
354       /* If this is an empty line go on with the next one.  */
355       if (rp == endp)
356         continue;
357
358       word = rp;
359       while (*rp != '\0' && !isspace (*rp))
360         ++rp;
361
362       if (rp - word == sizeof ("alias") - 1
363           && memcmp (word, "alias", sizeof ("alias") - 1) == 0)
364         add_alias (rp);
365       else if (rp - word == sizeof ("module") - 1
366                && memcmp (word, "module", sizeof ("module") - 1) == 0)
367         add_module (rp, directory, dir_len, modules, nmodules, modcounter++);
368       /* else */
369         /* Otherwise ignore the line.  */
370     }
371
372   if (line != NULL)
373     free (line);
374   fclose (fp);
375 }
376
377
378 /* Read all configuration files found in the user-specified and the default
379    path.  */
380 void
381 internal_function
382 __gconv_read_conf (void)
383 {
384   const char *user_path = __secure_getenv ("GCONV_PATH");
385   char *gconv_path, *elem;
386   void *modules = NULL;
387   size_t nmodules = 0;
388   int save_errno = errno;
389   size_t cnt;
390
391   if (user_path == NULL)
392     /* No user-defined path.  Make a modifiable copy of the default path.  */
393     gconv_path = strdupa (default_gconv_path);
394   else
395     {
396       /* Append the default path to the user-defined path.  */
397       size_t user_len = strlen (user_path);
398       char *tmp;
399
400       gconv_path = alloca (user_len + 1 + sizeof (default_gconv_path));
401       tmp = __mempcpy (gconv_path, user_path, user_len);
402       *tmp++ = ':';
403       __mempcpy (tmp, default_gconv_path, sizeof (default_gconv_path));
404     }
405
406   elem = strtok_r (gconv_path, ":", &gconv_path);
407   while (elem != NULL)
408     {
409 #ifndef MAXPATHLEN
410       /* We define a reasonable limit.  */
411 # define MAXPATHLEN 4096
412 #endif
413       char real_elem[MAXPATHLEN];
414
415       if (__realpath (elem, real_elem) != NULL)
416         {
417           size_t elem_len = strlen (real_elem);
418           char *filename, *tmp;
419
420           filename = alloca (elem_len + 1 + sizeof (gconv_conf_filename));
421           tmp = __mempcpy (filename, real_elem, elem_len);
422           *tmp++ = '/';
423           __mempcpy (tmp, gconv_conf_filename, sizeof (gconv_conf_filename));
424
425           /* Read the next configuration file.  */
426           read_conf_file (filename, real_elem, elem_len, &modules, &nmodules);
427         }
428
429       /* Get next element in the path.  */
430       elem = strtok_r (NULL, ":", &gconv_path);
431     }
432
433   /* If the configuration files do not contain any valid module specification
434      remember this by setting the pointer to the module array to NULL.  */
435   nmodules += sizeof (builtin_modules) / sizeof (builtin_modules[0]);
436   if (nmodules == 0)
437     __gconv_modules_db = NULL;
438   else
439     {
440       __gconv_modules_db =
441         (struct gconv_module **) malloc (nmodules
442                                          * sizeof (struct gconv_module));
443       if (__gconv_modules_db != NULL)
444         {
445           size_t cnt;
446
447           /* Insert all module entries into the array.  */
448           __twalk (modules, insert_module);
449
450           /* No remove the tree data structure.  */
451           __tdestroy (modules, nothing);
452
453           /* Finally insert the builtin transformations.  */
454           for (cnt = 0; cnt < (sizeof (builtin_modules)
455                                / sizeof (struct gconv_module)); ++cnt)
456             __gconv_modules_db[__gconv_nmodules++] = &builtin_modules[cnt];
457         }
458     }
459
460   /* Add aliases for builtin conversions.  */
461   cnt = sizeof (builtin_aliases) / sizeof (builtin_aliases[0]);
462   while (cnt > 0)
463     {
464       char *copy = strdupa (builtin_aliases[--cnt]);
465       add_alias (copy);
466     }
467
468   /* Restore the error number.  */
469   __set_errno (save_errno);
470 }