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