(__gconv_read_conf): Don't call realpath.
[kopensolaris-gnu/glibc.git] / iconv / gconv_conf.c
1 /* Handle configuration data.
2    Copyright (C) 1997, 1998, 1999, 2000 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 <assert.h>
22 #include <ctype.h>
23 #include <errno.h>
24 #include <limits.h>
25 #include <search.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <unistd.h>
30 #include <sys/param.h>
31
32 #include <bits/libc-lock.h>
33 #include <gconv_int.h>
34
35
36 /* This is the default path where we look for module lists.  */
37 static const char default_gconv_path[] = GCONV_PATH;
38
39 /* The path elements, as determined by the __gconv_get_path function.
40    All path elements end in a slash.  */
41 const struct path_elem *__gconv_path_elem;
42 /* Maximum length of a single path element in __gconv_path_elem.  */
43 size_t __gconv_max_path_elem_len;
44
45 /* We use the following struct if we couldn't allocate memory.  */
46 static const struct path_elem empty_path_elem;
47
48 /* Name of the file containing the module information in the directories
49    along the path.  */
50 static const char gconv_conf_filename[] = "gconv-modules";
51
52 /* Filename extension for the modules.  */
53 #ifndef MODULE_EXT
54 # define MODULE_EXT ".so"
55 #endif
56 static const char gconv_module_ext[] = MODULE_EXT;
57
58 /* We have a few builtin transformations.  */
59 static struct gconv_module builtin_modules[] =
60 {
61 #define BUILTIN_TRANSFORMATION(From, To, Cost, Name, Fct, Init, End, MinF, \
62                                MaxF, MinT, MaxT) \
63   {                                                                           \
64     from_string: From,                                                        \
65     to_string: To,                                                            \
66     cost_hi: Cost,                                                            \
67     cost_lo: INT_MAX,                                                         \
68     module_name: Name                                                         \
69   },
70 #define BUILTIN_ALIAS(From, To)
71
72 #include "gconv_builtin.h"
73 };
74
75 #undef BUILTIN_TRANSFORMATION
76 #undef BUILTIN_ALIAS
77
78 static const char *builtin_aliases[] =
79 {
80 #define BUILTIN_TRANSFORMATION(From, To, Cost, Name, Fct, Init, End, MinF, \
81                                MaxF, MinT, MaxT)
82 #define BUILTIN_ALIAS(From, To) From " " To,
83
84 #include "gconv_builtin.h"
85 };
86
87 #ifdef USE_IN_LIBIO
88 # include <libio/libioP.h>
89 # define __getdelim(line, len, c, fp) _IO_getdelim (line, len, c, fp)
90 #endif
91
92
93 /* Test whether there is already a matching module known.  */
94 static int
95 internal_function
96 detect_conflict (const char *alias)
97 {
98   struct gconv_module *node = __gconv_modules_db;
99
100   while (node != NULL)
101     {
102       int cmpres = strcmp (alias, node->from_string);
103
104       if (cmpres == 0)
105         /* We have a conflict.  */
106         return 1;
107       else if (cmpres < 0)
108         node = node->left;
109       else
110         node = node->right;
111     }
112
113   return node != NULL;
114 }
115
116
117 /* Add new alias.  */
118 static inline void
119 add_alias (char *rp, void *modules)
120 {
121   /* We now expect two more string.  The strings are normalized
122      (converted to UPPER case) and strored in the alias database.  */
123   struct gconv_alias *new_alias;
124   char *from, *to, *wp;
125
126   while (isspace (*rp))
127     ++rp;
128   from = wp = rp;
129   while (*rp != '\0' && !isspace (*rp))
130     *wp++ = toupper (*rp++);
131   if (*rp == '\0')
132     /* There is no `to' string on the line.  Ignore it.  */
133     return;
134   *wp++ = '\0';
135   to = ++rp;
136   while (isspace (*rp))
137     ++rp;
138   while (*rp != '\0' && !isspace (*rp))
139     *wp++ = toupper (*rp++);
140   if (to == wp)
141     /* No `to' string, ignore the line.  */
142     return;
143   *wp++ = '\0';
144
145   /* Test whether this alias conflicts with any available module.  */
146   if (detect_conflict (from))
147     /* It does conflict, don't add the alias.  */
148     return;
149
150   new_alias = (struct gconv_alias *)
151     malloc (sizeof (struct gconv_alias) + (wp - from));
152   if (new_alias != NULL)
153     {
154       void **inserted;
155
156       new_alias->fromname = memcpy ((char *) new_alias
157                                     + sizeof (struct gconv_alias),
158                                     from, wp - from);
159       new_alias->toname = new_alias->fromname + (to - from);
160
161       inserted = (void **) __tsearch (new_alias, &__gconv_alias_db,
162                                       __gconv_alias_compare);
163       if (inserted == NULL || *inserted != new_alias)
164         /* Something went wrong, free this entry.  */
165         free (new_alias);
166     }
167 }
168
169
170 /* Insert a data structure for a new module in the search tree.  */
171 static inline void
172 internal_function
173 insert_module (struct gconv_module *newp)
174 {
175   struct gconv_module **rootp = &__gconv_modules_db;
176
177   while (*rootp != NULL)
178     {
179       struct gconv_module *root = *rootp;
180       int cmpres;
181
182       cmpres = strcmp (newp->from_string, root->from_string);
183       if (cmpres == 0)
184         {
185           /* Both strings are identical.  Insert the string at the
186              end of the `same' list if it is not already there.  */
187           while (strcmp (newp->from_string, root->from_string) != 0
188                  || strcmp (newp->to_string, root->to_string) != 0)
189             {
190               rootp = &root->same;
191               root = *rootp;
192               if (root == NULL)
193                 break;
194             }
195
196           if (root != NULL)
197             /* This is a no new conversion.  */
198             return;
199
200           break;
201         }
202       else if (cmpres < 0)
203         rootp = &root->left;
204       else
205         rootp = &root->right;
206     }
207
208   /* Plug in the new node here.  */
209   *rootp = newp;
210 }
211
212
213 /* Add new module.  */
214 static void
215 internal_function
216 add_module (char *rp, const char *directory, size_t dir_len, void **modules,
217             size_t *nmodules, int modcounter)
218 {
219   /* We expect now
220      1. `from' name
221      2. `to' name
222      3. filename of the module
223      4. an optional cost value
224   */
225   struct gconv_alias fake_alias;
226   struct gconv_module *new_module;
227   char *from, *to, *module, *wp;
228   int need_ext;
229   int cost_hi;
230
231   while (isspace (*rp))
232     ++rp;
233   from = rp;
234   while (*rp != '\0' && !isspace (*rp))
235     {
236       *rp = toupper (*rp);
237       ++rp;
238     }
239   if (*rp == '\0')
240     return;
241   *rp++ = '\0';
242   to = wp = rp;
243   while (isspace (*rp))
244     ++rp;
245   while (*rp != '\0' && !isspace (*rp))
246     *wp++ = toupper (*rp++);
247   if (*rp == '\0')
248     return;
249   *wp++ = '\0';
250   do
251     ++rp;
252   while (isspace (*rp));
253   module = wp;
254   while (*rp != '\0' && !isspace (*rp))
255     *wp++ = *rp++;
256   if (*rp == '\0')
257     {
258       /* There is no cost, use one by default.  */
259       *wp++ = '\0';
260       cost_hi = 1;
261     }
262   else
263     {
264       /* There might be a cost value.  */
265       char *endp;
266
267       *wp++ = '\0';
268       cost_hi = strtol (rp, &endp, 10);
269       if (rp == endp || cost_hi < 1)
270         /* No useful information.  */
271         cost_hi = 1;
272     }
273
274   if (module[0] == '\0')
275     /* No module name given.  */
276     return;
277   if (module[0] == '/')
278     dir_len = 0;
279   else
280     /* Increment by one for the slash.  */
281     ++dir_len;
282
283   /* See whether we must add the ending.  */
284   need_ext = 0;
285   if (wp - module < sizeof (gconv_module_ext)
286       || memcmp (wp - sizeof (gconv_module_ext), gconv_module_ext,
287                  sizeof (gconv_module_ext)) != 0)
288     /* We must add the module extension.  */
289     need_ext = sizeof (gconv_module_ext) - 1;
290
291   /* See whether we have already an alias with this name defined.  */
292   fake_alias.fromname = strndupa (from, to - from);
293
294   if (__tfind (&fake_alias, &__gconv_alias_db, __gconv_alias_compare) != NULL)
295     /* This module duplicates an alias.  */
296     return;
297
298   new_module = (struct gconv_module *) calloc (1,
299                                                sizeof (struct gconv_module)
300                                                + (wp - from)
301                                                + dir_len + need_ext);
302   if (new_module != NULL)
303     {
304       char *tmp;
305
306       new_module->from_string = memcpy ((char *) new_module
307                                         + sizeof (struct gconv_module),
308                                         from, to - from);
309
310       new_module->to_string = memcpy ((char *) new_module->from_string
311                                       + (to - from), to, module - to);
312
313       new_module->cost_hi = cost_hi;
314       new_module->cost_lo = modcounter;
315
316       new_module->module_name = (char *) new_module->to_string + (module - to);
317
318       if (dir_len == 0)
319         tmp = (char *) new_module->module_name;
320       else
321         {
322           tmp = __mempcpy ((char *) new_module->module_name,
323                            directory, dir_len - 1);
324           *tmp++ = '/';
325         }
326
327       tmp = __mempcpy (tmp, module, wp - module);
328
329       if (need_ext)
330         memcpy (tmp - 1, gconv_module_ext, sizeof (gconv_module_ext));
331
332       /* Now insert the new module data structure in our search tree.  */
333       insert_module (new_module);
334     }
335 }
336
337
338 /* Read the next configuration file.  */
339 static void
340 internal_function
341 read_conf_file (const char *filename, const char *directory, size_t dir_len,
342                 void **modules, size_t *nmodules)
343 {
344   FILE *fp = fopen (filename, "r");
345   char *line = NULL;
346   size_t line_len = 0;
347   int modcounter = 0;
348
349   /* Don't complain if a file is not present or readable, simply silently
350      ignore it.  */
351   if (fp == NULL)
352     return;
353
354   /* Process the known entries of the file.  Comments start with `#' and
355      end with the end of the line.  Empty lines are ignored.  */
356   while (!feof_unlocked (fp))
357     {
358       char *rp, *endp, *word;
359       ssize_t n = __getdelim (&line, &line_len, '\n', fp);
360       if (n < 0)
361         /* An error occurred.  */
362         break;
363
364       rp = line;
365       /* Terminate the line (excluding comments or newline) by an NUL byte
366          to simplify the following code.  */
367       endp = strchr (rp, '#');
368       if (endp != NULL)
369         *endp = '\0';
370       else
371         if (rp[n - 1] == '\n')
372           rp[n - 1] = '\0';
373
374       while (isspace (*rp))
375         ++rp;
376
377       /* If this is an empty line go on with the next one.  */
378       if (rp == endp)
379         continue;
380
381       word = rp;
382       while (*rp != '\0' && !isspace (*rp))
383         ++rp;
384
385       if (rp - word == sizeof ("alias") - 1
386           && memcmp (word, "alias", sizeof ("alias") - 1) == 0)
387         add_alias (rp, *modules);
388       else if (rp - word == sizeof ("module") - 1
389                && memcmp (word, "module", sizeof ("module") - 1) == 0)
390         add_module (rp, directory, dir_len, modules, nmodules, modcounter++);
391       /* else */
392         /* Otherwise ignore the line.  */
393     }
394
395   free (line);
396
397   fclose (fp);
398 }
399
400
401 /* Determine the directories we are looking for data in.  */
402 void
403 __gconv_get_path (void)
404 {
405   struct path_elem *result;
406   __libc_lock_define_initialized (static, lock);
407
408   __libc_lock_lock (lock);
409
410   /* Make sure there wasn't a second thread doing it already.  */
411   result = (struct path_elem *) __gconv_path_elem;
412   if (result == NULL)
413     {
414       /* Determine the complete path first.  */
415       const char *user_path;
416       char *gconv_path;
417       size_t gconv_path_len;
418       char *elem;
419       char *oldp;
420       char *cp;
421       int nelems;
422
423       user_path = __secure_getenv ("GCONV_PATH");
424       if (user_path == NULL)
425         {
426           /* No user-defined path.  Make a modifiable copy of the
427              default path.  */
428           gconv_path = strdupa (default_gconv_path);
429           gconv_path_len = sizeof (default_gconv_path);
430         }
431       else
432         {
433           /* Append the default path to the user-defined path.  */
434           size_t user_len = strlen (user_path);
435
436           gconv_path_len = user_len + 1 + sizeof (default_gconv_path);
437           gconv_path = alloca (gconv_path_len);
438           __mempcpy (__mempcpy (__mempcpy (gconv_path, user_path, user_len),
439                                 ":", 1),
440                      default_gconv_path, sizeof (default_gconv_path));
441         }
442
443       /* In a first pass we calculate the number of elements.  */
444       oldp = NULL;
445       cp = strchr (gconv_path, ':');
446       nelems = 1;
447       while (cp != NULL)
448         {
449           if (cp != oldp + 1)
450             ++nelems;
451           oldp = cp;
452           cp =  strchr (cp + 1, ':');
453         }
454
455       /* Allocate the memory for the result.  */
456       result = (struct path_elem *) malloc ((nelems + 1)
457                                             * sizeof (struct path_elem)
458                                             + gconv_path_len + nelems);
459       if (result != NULL)
460         {
461           char *strspace = (char *) &result[nelems + 1];
462           int n = 0;
463
464           /* Separate the individual parts.  */
465           __gconv_max_path_elem_len = 0;
466           elem = __strtok_r (gconv_path, ":", &gconv_path);
467           assert (elem != NULL);
468           do
469             {
470               result[n].name = strspace;
471               strspace = __stpcpy (strspace, elem);
472               if (strspace[-1] != '/')
473                 *strspace++ = '/';
474
475               result[n].len = strspace - result[n].name;
476               if (result[n].len > __gconv_max_path_elem_len)
477                 __gconv_max_path_elem_len = result[n].len;
478
479               *strspace++ = '\0';
480               ++n;
481             }
482           while ((elem = __strtok_r (NULL, ":", &gconv_path)) != NULL);
483
484           result[n].name = NULL;
485           result[n].len = 0;
486         }
487
488       __gconv_path_elem = result ?: &empty_path_elem;
489     }
490
491   __libc_lock_unlock (lock);
492 }
493
494
495 /* Read all configuration files found in the user-specified and the default
496    path.  */
497 void
498 __gconv_read_conf (void)
499 {
500   void *modules = NULL;
501   size_t nmodules = 0;
502   int save_errno = errno;
503   size_t cnt;
504
505   /* Find out where we have to look.  */
506   if (__gconv_path_elem == NULL)
507     __gconv_get_path ();
508
509   for (cnt = 0; __gconv_path_elem[cnt].name != NULL; ++cnt)
510     {
511       const char *elem = __gconv_path_elem[cnt].name;
512       size_t elem_len = __gconv_path_elem[cnt].len;
513       char *filename;
514
515       /* No slash needs to be inserted between elem and gconv_conf_filename;
516          elem already ends in a slash.  */
517       filename = alloca (elem_len + sizeof (gconv_conf_filename));
518       __mempcpy (__mempcpy (filename, elem, elem_len),
519                  gconv_conf_filename, sizeof (gconv_conf_filename));
520
521       /* Read the next configuration file.  */
522       read_conf_file (filename, elem, elem_len, &modules, &nmodules);
523     }
524
525   /* Add the internal modules.  */
526   for (cnt = 0; cnt < sizeof (builtin_modules) / sizeof (builtin_modules[0]);
527        ++cnt)
528     {
529       struct gconv_alias fake_alias;
530
531       fake_alias.fromname = builtin_modules[cnt].from_string;
532
533       if (__tfind (&fake_alias, &__gconv_alias_db, __gconv_alias_compare)
534           != NULL)
535         /* It'll conflict so don't add it.  */
536         continue;
537
538       insert_module (&builtin_modules[cnt]);
539     }
540
541   /* Add aliases for builtin conversions.  */
542   cnt = sizeof (builtin_aliases) / sizeof (builtin_aliases[0]);
543   while (cnt > 0)
544     {
545       char *copy = strdupa (builtin_aliases[--cnt]);
546       add_alias (copy, modules);
547     }
548
549   /* Restore the error number.  */
550   __set_errno (save_errno);
551 }
552
553
554
555 /* Free all resources if necessary.  */
556 static void __attribute__ ((unused))
557 free_mem (void)
558 {
559   if (__gconv_path_elem != NULL && __gconv_path_elem != &empty_path_elem)
560     free ((void *) __gconv_path_elem);
561 }
562
563 text_set_element (__libc_subfreeres, free_mem);