locale/programs/localedef.c

   1 /* Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
   2    This file is part of the GNU C Library.
   3    Contributed by Ulrich Drepper <drepper@gnu.ai.mit.edu>, 1995.
   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 #ifdef HAVE_CONFIG_H
  21 # include <config.h>
  22 #endif
  23
  24 #include <errno.h>
  25 #include <fcntl.h>
  26 #include <getopt.h>
  27 #include <libintl.h>
  28 #include <locale.h>
  29 #include <stdio.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32 #include <unistd.h>
  33 #include <sys/mman.h>
  34 #include <sys/stat.h>
  35
  36 #include "error.h"
  37 #include "charset.h"
  38 #include "locfile.h"
  39 #include "../intl/loadinfo.h"
  40
  41 /* Undefine the following line in the production version.  */
  42 /* #define NDEBUG 1 */
  43 #include <assert.h>
  44
  45
  46 /* List of locale definition files which are used in `copy' instructions.  */
  47 struct copy_def_list_t
  48 {
  49   struct copy_def_list_t *next;
  50
  51   const char *name;
  52   int mask;
  53
  54   struct localedef_t *locale;
  55
  56   struct
  57   {
  58     void *data;
  59     size_t len;
  60   } binary[6];
  61 };
  62
  63
  64 /* List of copied locales.  */
  65 struct copy_def_list_t *copy_list;
  66
  67 /* If this is defined be POSIX conform.  */
  68 int posix_conformance;
  69
  70 /* If not zero give a lot more messages.  */
  71 int verbose;
  72
  73
  74
  75 /* Long options.  */
  76 static const struct option long_options[] =
  77 {
  78   { "charmap", required_argument, NULL, 'f' },
  79   { "code-set-name", required_argument, NULL, 'u' },
  80   { "help", no_argument, NULL, 'h' },
  81   { "force", no_argument, NULL, 'c' },
  82   { "inputfile", required_argument, NULL, 'i' },
  83   { "posix", no_argument, &posix_conformance, 1 },
  84   { "verbose", no_argument, &verbose, 1},
  85   { "version", no_argument, NULL, 'V' },
  86   { NULL, 0, NULL, 0 }
  87 };
  88
  89
  90 /* Prototypes for global functions.  */
  91 void *xmalloc (size_t __n);
  92
  93 /* Prototypes for local functions.  */
  94 static void usage (int status) __attribute__ ((noreturn));
  95 static void error_print (void);
  96 static const char *construct_output_path (char *path);
  97
  98
  99 int
 100 main (int argc, char *argv[])
 101 {
 102   int optchar;
 103   int do_help = 0;
 104   int do_version = 0;
 105   int force_output = 0;
 106   const char *charmap_file = NULL;
 107   const char *input_file = NULL;
 108   const char *ucs_csn = NULL;
 109   const char *output_path;
 110   int cannot_write_why;
 111   struct charset_t *charset;
 112   struct localedef_t *localedef;
 113   struct copy_def_list_t *act_add_locdef;
 114
 115   /* Set initial values for global variables.  */
 116   copy_list = NULL;
 117   posix_conformance = getenv ("POSIXLY_CORRECT") != NULL;
 118   error_print_progname = error_print;
 119   verbose = 0;
 120
 121   /* Set locale.  Do not set LC_ALL because the other categories must
 122      not be affected (according to POSIX.2).  */
 123   setlocale (LC_MESSAGES, "");
 124   setlocale (LC_CTYPE, "");
 125
 126   /* Initialize the message catalog.  */
 127   textdomain (_libc_intl_domainname);
 128
 129   while ((optchar = getopt_long (argc, argv, "cf:hi:u:vV", long_options, NULL))
 130          != EOF)
 131     switch (optchar)
 132       {
 133       case '\0':                /* Long option.  */
 134         break;
 135
 136       case 'c':
 137         force_output = 1;
 138         break;
 139
 140       case 'f':
 141         charmap_file = optarg;
 142         break;
 143
 144       case 'h':
 145         do_help = 1;
 146         break;
 147
 148       case 'i':
 149         input_file = optarg;
 150         break;
 151
 152       case 'u':
 153         ucs_csn = optarg;
 154         break;
 155
 156         case 'v':
 157         verbose = 1;
 158         break;
 159
 160       case 'V':
 161         do_version = 1;
 162         break;
 163
 164       default:
 165         usage (4);      /* A value >3 is forced by POSIX.  */
 166         break;
 167       }
 168
 169   /* POSIX.2 requires to be verbose about missing characters in the
 170      character map.  */
 171   verbose |= posix_conformance;
 172
 173   /* Version information is requested.  */
 174   if (do_version)
 175     {
 176       printf ("localedef (GNU %s) %s\n", PACKAGE, VERSION);
 177       printf (_("\
 178 Copyright (C) %s Free Software Foundation, Inc.\n\
 179 This is free software; see the source for copying conditions.  There is NO\n\
 180 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n\
 181 "), "1995, 1996, 1997");
 182       printf (_("Written by %s.\n"), "Ulrich Drepper");
 183
 184       exit (0);
 185     }
 186
 187   /* Help is requested.  */
 188   if (do_help)
 189     /* Possible violation: POSIX.2 4.35.8 defines the return value 0 as
 190        "No errors occurred and the locale(s) were successfully created."
 191        But giving a other value than 0 does not make sense here.  It
 192        is perhaps not that important because POSIX does not specify the
 193        -h option for localedef.  */
 194     usage (0);
 195
 196   if (argc - optind != 1)
 197     /* We need exactly one non-option parameter.  */
 198     usage (4);
 199
 200   /* The parameter describes the output path of the constructed files.
 201      If the described files cannot be written return a NULL pointer.  */
 202   output_path  = construct_output_path (argv[optind]);
 203   cannot_write_why = errno;
 204
 205   /* Now that the parameters are processed we have to reset the local
 206      ctype locale.  (P1003.2 4.35.5.2)  */
 207   setlocale (LC_CTYPE, "POSIX");
 208
 209   /* Look whether the system really allows locale definitions.  POSIX
 210      defines error code 3 for this situation so I think it must be
 211      a fatal error (see P1003.2 4.35.8).  */
 212   if (sysconf (_SC_2_LOCALEDEF) < 0)
 213     error (3, 0, _("FATAL: system does not define `_POSIX2_LOCALEDEF'"));
 214
 215   /* Process charmap file.  */
 216   charset = charmap_read (charmap_file);
 217
 218   /* Now read the locale file.  */
 219   localedef = locfile_read (input_file, charset);
 220   if (localedef->failed != 0)
 221     error (4, errno, _("cannot open locale definition file `%s'"), input_file);
 222
 223   /* Perhaps we saw some `copy' instructions.  Process the given list.
 224      We use a very simple algorithm: we look up the list from the
 225      beginning every time.  */
 226   do
 227     {
 228       int cat;
 229
 230       for (act_add_locdef = copy_list; act_add_locdef != NULL;
 231            act_add_locdef = act_add_locdef->next)
 232         {
 233           for (cat = LC_CTYPE; cat <= LC_MESSAGES; ++cat)
 234             if ((act_add_locdef->mask & (1 << cat)) != 0)
 235               {
 236                 act_add_locdef->mask &= ~(1 << cat);
 237                 break;
 238               }
 239           if (cat <= LC_MESSAGES)
 240             break;
 241         }
 242
 243       if (act_add_locdef != NULL)
 244         {
 245           int avail = 0;
 246
 247           if (act_add_locdef->locale == NULL)
 248             act_add_locdef->locale = locfile_read (act_add_locdef->name,
 249                                                    charset);
 250
 251           if (! act_add_locdef->locale->failed)
 252             {
 253               avail = act_add_locdef->locale->categories[cat].generic != NULL;
 254               if (avail)
 255                 localedef->categories[cat].generic
 256                   = act_add_locdef->locale->categories[cat].generic;
 257             }
 258
 259           if (! avail)
 260             {
 261               const char *locale_names[] = { "LC_COLLATE", "LC_CTYPE",
 262                                              "LC_MONETARY", "LC_NUMERIC",
 263                                              "LC_TIME", "LC_MESSAGES" };
 264               char *fname;
 265               int fd;
 266               struct stat st;
 267
 268               asprintf (&fname, LOCALE_PATH "/%s/%s", act_add_locdef->name,
 269                         locale_names[cat]);
 270               fd = open (fname, O_RDONLY);
 271               if (fd == -1)
 272                 {
 273                   free (fname);
 274
 275                   asprintf (&fname, LOCALE_PATH "/%s/%s/SYS_%s",
 276                             act_add_locdef->name, locale_names[cat],
 277                             locale_names[cat]);
 278
 279                   fd = open (fname, O_RDONLY);
 280                   if (fd == -1)
 281                     error (5, 0, _("\
 282 locale file `%s', used in `copy' statement, not found"),
 283                            act_add_locdef->name);
 284                 }
 285
 286               if (fstat (fd, &st) < 0)
 287                 error (5, errno, _("\
 288 cannot `stat' locale file `%s'"),
 289                        fname);
 290
 291               localedef->len[cat] = st.st_size;
 292               localedef->categories[cat].generic
 293                 = mmap (NULL, st.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
 294
 295               if (localedef->categories[cat].generic == (void *) -1)
 296                 {
 297                   size_t left = st.st_size;
 298                   void *read_ptr;
 299
 300                   localedef->categories[cat].generic
 301                     = xmalloc (st.st_size);
 302                   read_ptr = localedef->categories[cat].generic;
 303
 304                   do
 305                     {
 306                       long int n;
 307                       n = read (fd, read_ptr, left);
 308                       if (n == -1)
 309                         error (5, errno, _("cannot read locale file `%s'"),
 310                                fname);
 311                       read_ptr += n;
 312                       left -= n;
 313                     }
 314                   while (left > 0);
 315                 }
 316
 317               close (fd);
 318               free (fname);
 319
 320               localedef->binary |= 1 << cat;
 321             }
 322         }
 323     }
 324   while (act_add_locdef != NULL);
 325
 326   /* Check the categories we processed in source form.  */
 327   check_all_categories (localedef, charset);
 328
 329   /* We are now able to write the data files.  If warning were given we
 330      do it only if it is explicitly requested (--force).  */
 331   if (error_message_count == 0 || force_output != 0)
 332     {
 333       if (cannot_write_why != 0)
 334         error (4, cannot_write_why, _("cannot write output files to `%s'"),
 335                output_path);
 336       else
 337         write_all_categories (localedef, charset, output_path);
 338     }
 339   else
 340     error (4, 0, _("no output file produced because warning were issued"));
 341
 342   /* This exit status is prescribed by POSIX.2 4.35.7.  */
 343   exit (error_message_count != 0);
 344 }
 345
 346
 347 void
 348 def_to_process (const char *name, int category)
 349 {
 350   struct copy_def_list_t *new, **rp;
 351
 352   for (rp = &copy_list; *rp != NULL; rp = &(*rp)->next)
 353     if (strcmp (name, (*rp)->name) == 0)
 354       break;
 355
 356   if (*rp == NULL)
 357     {
 358       size_t cnt;
 359
 360       *rp = (struct copy_def_list_t *) xmalloc (sizeof (**rp));
 361
 362       (*rp)->next = NULL;
 363       (*rp)->name = name;
 364       (*rp)->mask = 0;
 365       (*rp)->locale = NULL;
 366
 367       for (cnt = 0; cnt < 6; ++cnt)
 368         {
 369           (*rp)->binary[cnt].data = NULL;
 370           (*rp)->binary[cnt].len = 0;
 371         }
 372     }
 373   new = *rp;
 374
 375   if ((new->mask & category) != 0)
 376     /* We already have the information.  This cannot happen.  */
 377     error (5, 0, _("\
 378 category data requested more than once: should not happen"));
 379
 380   new->mask |= category;
 381 }
 382
 383
 384 /* Display usage information and exit.  */
 385 static void
 386 usage (int status)
 387 {
 388   if (status != 0)
 389     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 390              program_invocation_name);
 391   else
 392     {
 393       printf (_("\
 394 Usage: %s [OPTION]... name\n\
 395 Mandatory arguments to long options are mandatory for short options too.\n\
 396   -c, --force               create output even if warning messages were issued\n\
 397   -h, --help                display this help and exit\n\
 398   -f, --charmap=FILE        symbolic character names defined in FILE\n\
 399   -i, --inputfile=FILE      source definitions are found in FILE\n\
 400   -u, --code-set-name=NAME  specify code set for mapping ISO 10646 elements\n\
 401   -v, --verbose             print more messages\n\
 402   -V, --version             output version information and exit\n\
 403       --posix               be strictly POSIX conform\n\
 404 \n\
 405 System's directory for character maps: %s\n\
 406                        locale files  : %s\n"),
 407               program_invocation_name, CHARMAP_PATH, LOCALE_PATH);
 408       fputs (gettext ("\
 409 Report bugs using the `glibcbug' script to <bugs@gnu.ai.mit.edu>.\n"),
 410              stdout);
 411     }
 412
 413   exit (status);
 414 }
 415
 416
 417 /* The address of this function will be assigned to the hook in the error
 418    functions.  */
 419 static void
 420 error_print ()
 421 {
 422   /* We don't want the program name to be printed in messages.  Emacs'
 423      compile.el does not like this.  */
 424 }
 425
 426
 427 /* The parameter to localedef describes the output path.  If it does
 428    contain a '/' character it is a relative path.  Otherwise it names the
 429    locale this definition is for.  */
 430 static const char *
 431 construct_output_path (char *path)
 432 {
 433   const char *normal = NULL;
 434   char *result;
 435
 436   if (strchr (path, '/') == NULL)
 437     {
 438       /* This is a system path.  First examine whether the locale name
 439          contains a reference to the codeset.  This should be
 440          normalized.  */
 441       char *startp, *endp;
 442
 443       startp = path;
 444       /* We must be prepared for finding a CEN name or a location of
 445          the introducing `.' where it is not possible anymore.  */
 446       while (*startp != '\0' && *startp != '@' && *startp != '.'
 447              && *startp != '+' && *startp != ',')
 448         ++startp;
 449       if (*startp == '.')
 450         {
 451           /* We found a codeset specification.  Now find the end.  */
 452           endp = ++startp;
 453           while (*endp != '\0' && *endp != '@')
 454             ++endp;
 455
 456           if (endp > startp)
 457             normal = _nl_normalize_codeset (startp, endp - startp);
 458         }
 459       else
 460         /* This is to keep gcc quiet.  */
 461         endp = NULL;
 462
 463       /* We put an additional '\0' at the end of the string because at
 464          the end of the function we need another byte for the trailing
 465          '/'.  */
 466       if (normal == NULL)
 467         asprintf (&result, "%s/%s%c", LOCALEDIR, path, '\0');
 468       else
 469         asprintf (&result, "%s/%.*s%s%s%c", LOCALEDIR, startp - path, path,
 470                   normal, endp, '\0');
 471     }
 472   else
 473     {
 474       /* This is a user path.  Please note the additional byte in the
 475          memory allocation.  */
 476       result = xmalloc (strlen (path) + 2);
 477       strcpy (result, path);
 478     }
 479
 480   errno = 0;
 481
 482   if (euidaccess (result, W_OK) == -1)
 483     /* Perhaps the directory does not exist now.  Try to create it.  */
 484     if (errno == ENOENT)
 485       {
 486         errno = 0;
 487         mkdir (result, 0777);
 488       }
 489
 490   strcat (result, "/");
 491
 492   return result;
 493 }