libatalk/unicode/iconv.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    minimal iconv implementation
   4    Copyright (C) Andrew Tridgell 2001
   5    Copyright (C) Jelmer Vernooij 2002,2003
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20
  21    From samba 3.0 beta and GNU libiconv-1.8
  22    It's bad but most of the time we can't use libc iconv service:
  23    - it doesn't round trip for most encoding
  24    - it doesn't know about Apple extension
  25 */
  26
  27 #ifdef HAVE_CONFIG_H
  28 #include "config.h"
  29 #endif /* HAVE_CONFIG_H */
  30
  31 #include <stdio.h>
  32 #include <stdlib.h>
  33 #include <unistd.h>
  34 #include <string.h>
  35 #include <ctype.h>
  36 #include <errno.h>
  37 #include <sys/param.h>
  38 #include <sys/stat.h>
  39 #ifdef HAVE_USABLE_ICONV
  40 #include <iconv.h>
  41 #endif
  42
  43 #include <netatalk/endian.h>
  44 #include <atalk/unicode.h>
  45 #include <atalk/logger.h>
  46 #include "byteorder.h"
  47
  48
  49 /**
  50  * @file
  51  *
  52  * @brief Samba wrapper/stub for iconv character set conversion.
  53  *
  54  * iconv is the XPG2 interface for converting between character
  55  * encodings.  This file provides a Samba wrapper around it, and also
  56  * a simple reimplementation that is used if the system does not
  57  * implement iconv.
  58  *
  59  * Samba only works with encodings that are supersets of ASCII: ascii
  60  * characters like whitespace can be tested for directly, multibyte
  61  * sequences start with a byte with the high bit set, and strings are
  62  * terminated by a nul byte.
  63  *
  64  * Note that the only function provided by iconv is conversion between
  65  * characters.  It doesn't directly support operations like
  66  * uppercasing or comparison.  We have to convert to UCS-2 and compare
  67  * there.
  68  *
  69  * @sa Samba Developers Guide
  70  **/
  71 #define CHARSET_WIDECHAR    32
  72
  73 #ifdef HAVE_USABLE_ICONV
  74 #ifdef HAVE_UCS2INTERNAL
  75 #define UCS2ICONV "UCS-2-INTERNAL"
  76 #else /* !HAVE_UCS2INTERNAL */
  77 #if BYTE_ORDER==LITTLE_ENDIAN
  78 #define UCS2ICONV "UCS-2LE"
  79 #else /* !LITTLE_ENDIAN */
  80 #define UCS2ICONV "UCS-2BE"
  81 #endif /* BYTE_ORDER */
  82 #endif /* HAVE_UCS2INTERNAL */
  83 #else /* !HAVE_USABLE_ICONV */
  84 #define UCS2ICONV "UCS-2"
  85 #endif /* HAVE_USABLE_ICONV */
  86
  87 static size_t ascii_pull(void *,char **, size_t *, char **, size_t *);
  88 static size_t ascii_push(void *,char **, size_t *, char **, size_t *);
  89 static size_t iconv_copy(void *,char **, size_t *, char **, size_t *);
  90
  91 extern  struct charset_functions charset_mac_roman;
  92 extern  struct charset_functions charset_mac_hebrew;
  93 extern  struct charset_functions charset_mac_centraleurope;
  94 extern  struct charset_functions charset_mac_cyrillic;
  95 extern  struct charset_functions charset_mac_greek;
  96 extern  struct charset_functions charset_mac_turkish;
  97 extern  struct charset_functions charset_utf8;
  98 extern  struct charset_functions charset_utf8_mac;
  99 #ifdef HAVE_USABLE_ICONV
 100 extern  struct charset_functions charset_mac_japanese;
 101 extern  struct charset_functions charset_mac_chinese_trad;
 102 extern  struct charset_functions charset_mac_korean;
 103 extern  struct charset_functions charset_mac_chinese_simp;
 104 #endif
 105
 106
 107 static struct charset_functions builtin_functions[] = {
 108         {"UCS-2",   0, iconv_copy, iconv_copy, CHARSET_WIDECHAR | CHARSET_PRECOMPOSED, NULL, NULL, NULL},
 109         {"ASCII",     0, ascii_pull, ascii_push, CHARSET_MULTIBYTE | CHARSET_PRECOMPOSED, NULL, NULL, NULL},
 110         {"SHIFT_JIS", 1568, NULL, NULL, CHARSET_ICONV | CHARSET_PRECOMPOSED | CHARSET_CLIENT, NULL, NULL, NULL},
 111         {NULL, 0, NULL, NULL, 0, NULL, NULL, NULL}
 112 };
 113
 114
 115 #define DLIST_ADD(list, p) \
 116 { \
 117         if (!(list)) { \
 118                 (list) = (p); \
 119                 (p)->next = (p)->prev = NULL; \
 120         } else { \
 121                 (list)->prev = (p); \
 122                 (p)->next = (list); \
 123                 (p)->prev = NULL; \
 124                 (list) = (p); \
 125         }\
 126 }
 127
 128 static struct charset_functions *charsets = NULL;
 129
 130 struct charset_functions *find_charset_functions(const char *name)
 131 {
 132         struct charset_functions *c = charsets;
 133
 134         while(c) {
 135                 if (strcasecmp(name, c->name) == 0) {
 136                         return c;
 137                 }
 138                 c = c->next;
 139         }
 140
 141         return NULL;
 142 }
 143
 144 int atalk_register_charset(struct charset_functions *funcs)
 145 {
 146         if (!funcs) {
 147                 return -1;
 148         }
 149
 150         /* Check whether we already have this charset... */
 151         if (find_charset_functions(funcs->name)) {
 152                 LOG (log_debug, logtype_default, "Duplicate charset %s, not registering", funcs->name);
 153                 return -2;
 154         }
 155
 156         funcs->next = funcs->prev = NULL;
 157         DLIST_ADD(charsets, funcs);
 158         return 0;
 159 }
 160
 161 void lazy_initialize_iconv(void)
 162 {
 163         static int initialized = 0;
 164         int i;
 165
 166         if (!initialized) {
 167                 initialized = 1;
 168                 for(i = 0; builtin_functions[i].name; i++)
 169                         atalk_register_charset(&builtin_functions[i]);
 170
 171                 /* register additional charsets */
 172                 atalk_register_charset(&charset_utf8);
 173                 atalk_register_charset(&charset_utf8_mac);
 174                 atalk_register_charset(&charset_mac_roman);
 175                 atalk_register_charset(&charset_mac_hebrew);
 176                 atalk_register_charset(&charset_mac_greek);
 177                 atalk_register_charset(&charset_mac_turkish);
 178                 atalk_register_charset(&charset_mac_centraleurope);
 179                 atalk_register_charset(&charset_mac_cyrillic);
 180 #ifdef HAVE_USABLE_ICONV
 181                 atalk_register_charset(&charset_mac_japanese);
 182                 atalk_register_charset(&charset_mac_chinese_trad);
 183                 atalk_register_charset(&charset_mac_korean);
 184                 atalk_register_charset(&charset_mac_chinese_simp);
 185 #endif
 186         }
 187 }
 188
 189 /* if there was an error then reset the internal state,
 190    this ensures that we don't have a shift state remaining for
 191    character sets like SJIS */
 192 static size_t sys_iconv(void *cd,
 193                         char **inbuf, size_t *inbytesleft,
 194                         char **outbuf, size_t *outbytesleft)
 195 {
 196 #ifdef HAVE_USABLE_ICONV
 197         size_t ret = iconv((iconv_t)cd,
 198                            (ICONV_CONST char**)inbuf, inbytesleft,
 199                            outbuf, outbytesleft);
 200         if (ret == (size_t)-1) iconv(cd, NULL, NULL, NULL, NULL);
 201         return ret;
 202 #else
 203         errno = EINVAL;
 204         return -1;
 205 #endif
 206 }
 207
 208 /**
 209  * This is a simple portable iconv() implementaion.
 210  *
 211  * It only knows about a very small number of character sets - just
 212  * enough that netatalk works on systems that don't have iconv.
 213  **/
 214 size_t atalk_iconv(atalk_iconv_t cd,
 215                  const char **inbuf, size_t *inbytesleft,
 216                  char **outbuf, size_t *outbytesleft)
 217 {
 218         char cvtbuf[2048];
 219         char *bufp = cvtbuf;
 220         size_t bufsize;
 221
 222         /* in many cases we can go direct */
 223         if (cd->direct) {
 224                 return cd->direct(cd->cd_direct,
 225                                   (char **)inbuf, inbytesleft, outbuf, outbytesleft);
 226         }
 227
 228
 229         /* otherwise we have to do it chunks at a time */
 230         while (*inbytesleft > 0) {
 231                 bufp = cvtbuf;
 232                 bufsize = sizeof(cvtbuf);
 233
 234                 if (cd->pull(cd->cd_pull, (char **)inbuf, inbytesleft, &bufp, &bufsize) == (size_t)-1
 235                        && errno != E2BIG) {
 236                     return -1;
 237                 }
 238
 239                 bufp = cvtbuf;
 240                 bufsize = sizeof(cvtbuf) - bufsize;
 241
 242                 if (cd->push(cd->cd_push, &bufp, &bufsize, outbuf, outbytesleft) == (size_t)-1) {
 243                     return -1;
 244                 }
 245         }
 246
 247         return 0;
 248 }
 249
 250
 251 /*
 252   simple iconv_open() wrapper
 253  */
 254 atalk_iconv_t atalk_iconv_open(const char *tocode, const char *fromcode)
 255 {
 256         atalk_iconv_t ret;
 257         struct charset_functions *from, *to;
 258
 259
 260         lazy_initialize_iconv();
 261         from = charsets;
 262         to = charsets;
 263
 264         ret = (atalk_iconv_t)malloc(sizeof(*ret));
 265         if (!ret) {
 266                 errno = ENOMEM;
 267                 return (atalk_iconv_t)-1;
 268         }
 269         memset(ret, 0, sizeof(*ret));
 270
 271         ret->from_name = strdup(fromcode);
 272         ret->to_name = strdup(tocode);
 273
 274         /* check for the simplest null conversion */
 275         if (strcasecmp(fromcode, tocode) == 0) {
 276                 ret->direct = iconv_copy;
 277                 return ret;
 278         }
 279
 280         /* check if we have a builtin function for this conversion */
 281         from = find_charset_functions(fromcode);
 282         if (from) ret->pull = from->pull;
 283
 284         to = find_charset_functions(tocode);
 285         if (to) ret->push = to->push;
 286
 287         /* check if we can use iconv for this conversion */
 288 #ifdef HAVE_USABLE_ICONV
 289         if (!from || (from->flags & CHARSET_ICONV)) {
 290           ret->cd_pull = iconv_open(UCS2ICONV, from && from->iname ? from->iname : fromcode);
 291           if (ret->cd_pull != (iconv_t)-1) {
 292             if (!ret->pull) ret->pull = sys_iconv;
 293           } else ret->pull = NULL;
 294         }
 295         if (ret->pull) {
 296           if (!to || (to->flags & CHARSET_ICONV)) {
 297             ret->cd_push = iconv_open(to && to->iname ? to->iname : tocode, UCS2ICONV);
 298             if (ret->cd_push != (iconv_t)-1) {
 299               if (!ret->push) ret->push = sys_iconv;
 300             } else ret->push = NULL;
 301           }
 302           if (!ret->push && ret->cd_pull) iconv_close((iconv_t)ret->cd_pull);
 303         }
 304 #endif
 305
 306         if (!ret->push || !ret->pull) {
 307                 SAFE_FREE(ret->from_name);
 308                 SAFE_FREE(ret->to_name);
 309                 SAFE_FREE(ret);
 310                 errno = EINVAL;
 311                 return (atalk_iconv_t)-1;
 312         }
 313
 314         /* check for conversion to/from ucs2 */
 315         if (strcasecmp(fromcode, "UCS-2") == 0) {
 316           ret->direct = ret->push;
 317           ret->cd_direct = ret->cd_push;
 318           ret->cd_push = NULL;
 319         }
 320         if (strcasecmp(tocode, "UCS-2") == 0) {
 321           ret->direct = ret->pull;
 322           ret->cd_direct = ret->cd_pull;
 323           ret->cd_pull = NULL;
 324         }
 325
 326         return ret;
 327 }
 328
 329 /*
 330   simple iconv_close() wrapper
 331 */
 332 int atalk_iconv_close (atalk_iconv_t cd)
 333 {
 334 #ifdef HAVE_USABLE_ICONV
 335         if (cd->cd_direct) iconv_close((iconv_t)cd->cd_direct);
 336         if (cd->cd_pull) iconv_close((iconv_t)cd->cd_pull);
 337         if (cd->cd_push) iconv_close((iconv_t)cd->cd_push);
 338 #endif
 339
 340         SAFE_FREE(cd->from_name);
 341         SAFE_FREE(cd->to_name);
 342
 343         memset(cd, 0, sizeof(*cd));
 344         SAFE_FREE(cd);
 345         return 0;
 346 }
 347
 348
 349 /************************************************************************
 350  the following functions implement the builtin character sets in Netatalk
 351 *************************************************************************/
 352
 353 static size_t ascii_pull(void *cd _U_, char **inbuf, size_t *inbytesleft,
 354                          char **outbuf, size_t *outbytesleft)
 355 {
 356         ucs2_t curchar;
 357
 358         while (*inbytesleft >= 1 && *outbytesleft >= 2) {
 359                 if ((unsigned char)(*inbuf)[0] < 0x80) {
 360                         curchar = (ucs2_t) (*inbuf)[0];
 361                         SSVAL((*outbuf),0,curchar);
 362                 }
 363                 else {
 364                         errno = EILSEQ;
 365                         return -1;
 366                 }
 367                 (*inbytesleft)  -= 1;
 368                 (*outbytesleft) -= 2;
 369                 (*inbuf)  += 1;
 370                 (*outbuf) += 2;
 371         }
 372
 373         if (*inbytesleft > 0) {
 374                 errno = E2BIG;
 375                 return -1;
 376         }
 377
 378         return 0;
 379 }
 380
 381 static size_t ascii_push(void *cd _U_, char **inbuf, size_t *inbytesleft,
 382                          char **outbuf, size_t *outbytesleft)
 383 {
 384         int ir_count=0;
 385         ucs2_t curchar;
 386
 387         while (*inbytesleft >= 2 && *outbytesleft >= 1) {
 388                 curchar = SVAL((*inbuf), 0);
 389                 if (curchar < 0x0080) {
 390                         (*outbuf)[0] = curchar;
 391                 }
 392                 else {
 393                         errno = EILSEQ;
 394                         return -1;
 395                 }
 396                 (*inbytesleft)  -= 2;
 397                 (*outbytesleft) -= 1;
 398                 (*inbuf)  += 2;
 399                 (*outbuf) += 1;
 400         }
 401
 402         if (*inbytesleft == 1) {
 403                 errno = EINVAL;
 404                 return -1;
 405         }
 406
 407         if (*inbytesleft > 1) {
 408                 errno = E2BIG;
 409                 return -1;
 410         }
 411
 412         return ir_count;
 413 }
 414
 415
 416 static size_t iconv_copy(void *cd _U_, char **inbuf, size_t *inbytesleft,
 417                          char **outbuf, size_t *outbytesleft)
 418 {
 419         int n;
 420
 421         n = MIN(*inbytesleft, *outbytesleft);
 422
 423         memmove(*outbuf, *inbuf, n);
 424
 425         (*inbytesleft) -= n;
 426         (*outbytesleft) -= n;
 427         (*inbuf) += n;
 428         (*outbuf) += n;
 429
 430         if (*inbytesleft > 0) {
 431                 errno = E2BIG;
 432                 return -1;
 433         }
 434
 435         return 0;
 436 }
 437
 438 /* ------------------------ */