lib/util/charset/codepoints.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Character set conversion Extensions
   4    Copyright (C) Igor Vergeichik <iverg@mail.ru> 2001
   5    Copyright (C) Andrew Tridgell 2001
   6    Copyright (C) Simo Sorce 2001
   7    Copyright (C) Jelmer Vernooij 2007
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21
  22 */
  23 #include "includes.h"
  24 #include "lib/util/charset/charset.h"
  25 #include "system/locale.h"
  26 #include "dynconfig.h"
  27
  28 #ifdef strcasecmp
  29 #undef strcasecmp
  30 #endif
  31
  32 /**
  33  * @file
  34  * @brief Unicode string manipulation
  35  */
  36
  37 /* these 2 tables define the unicode case handling.  They are loaded
  38    at startup either via mmap() or read() from the lib directory */
  39 static void *upcase_table;
  40 static void *lowcase_table;
  41
  42
  43 /*******************************************************************
  44 load the case handling tables
  45
  46 This is the function that should be called from library code.
  47 ********************************************************************/
  48 void load_case_tables_library(void)
  49 {
  50         TALLOC_CTX *mem_ctx;
  51
  52         mem_ctx = talloc_init("load_case_tables");
  53         if (!mem_ctx) {
  54                 smb_panic("No memory for case_tables");
  55         }
  56         upcase_table = map_file(talloc_asprintf(mem_ctx, "%s/upcase.dat", get_dyn_CODEPAGEDIR()), 0x20000);
  57         lowcase_table = map_file(talloc_asprintf(mem_ctx, "%s/lowcase.dat", get_dyn_CODEPAGEDIR()), 0x20000);
  58         talloc_free(mem_ctx);
  59         if (upcase_table == NULL) {
  60                 DEBUG(1, ("Failed to load upcase.dat, will use lame ASCII-only case sensitivity rules\n"));
  61                 upcase_table = (void *)-1;
  62         }
  63         if (lowcase_table == NULL) {
  64                 DEBUG(1, ("Failed to load lowcase.dat, will use lame ASCII-only case sensitivity rules\n"));
  65                 lowcase_table = (void *)-1;
  66         }
  67 }
  68
  69 /*******************************************************************
  70 load the case handling tables
  71
  72 This MUST only be called from main() in application code, never from a
  73 library.  We don't know if the calling program has already done
  74 setlocale() to another value, and can't tell if they have.
  75 ********************************************************************/
  76 void load_case_tables(void)
  77 {
  78         /* This is a useful global hook where we can ensure that the
  79          * locale is set from the environment.  This is needed so that
  80          * we can use LOCALE as a codepage */
  81 #ifdef HAVE_SETLOCALE
  82         setlocale(LC_ALL, "");
  83 #endif
  84         load_case_tables_library();
  85 }
  86
  87 /**
  88  Convert a codepoint_t to upper case.
  89 **/
  90 _PUBLIC_ codepoint_t toupper_m(codepoint_t val)
  91 {
  92         if (val < 128) {
  93                 return toupper(val);
  94         }
  95         if (upcase_table == NULL) {
  96                 load_case_tables_library();
  97         }
  98         if (upcase_table == (void *)-1) {
  99                 return val;
 100         }
 101         if (val & 0xFFFF0000) {
 102                 return val;
 103         }
 104         return SVAL(upcase_table, val*2);
 105 }
 106
 107 /**
 108  Convert a codepoint_t to lower case.
 109 **/
 110 _PUBLIC_ codepoint_t tolower_m(codepoint_t val)
 111 {
 112         if (val < 128) {
 113                 return tolower(val);
 114         }
 115         if (lowcase_table == NULL) {
 116                 load_case_tables_library();
 117         }
 118         if (lowcase_table == (void *)-1) {
 119                 return val;
 120         }
 121         if (val & 0xFFFF0000) {
 122                 return val;
 123         }
 124         return SVAL(lowcase_table, val*2);
 125 }
 126
 127 /**
 128  If we upper cased this character, would we get the same character?
 129 **/
 130 _PUBLIC_ bool islower_m(codepoint_t val)
 131 {
 132         return (toupper_m(val) != val);
 133 }
 134
 135 /**
 136  If we lower cased this character, would we get the same character?
 137 **/
 138 _PUBLIC_ bool isupper_m(codepoint_t val)
 139 {
 140         return (tolower_m(val) != val);
 141 }
 142
 143 /**
 144   compare two codepoints case insensitively
 145 */
 146 _PUBLIC_ int codepoint_cmpi(codepoint_t c1, codepoint_t c2)
 147 {
 148         if (c1 == c2 ||
 149             toupper_m(c1) == toupper_m(c2)) {
 150                 return 0;
 151         }
 152         return c1 - c2;
 153 }
 154
 155
 156 struct smb_iconv_handle {
 157         TALLOC_CTX *child_ctx;
 158         const char *unix_charset;
 159         const char *dos_charset;
 160         const char *display_charset;
 161         bool native_iconv;
 162         smb_iconv_t conv_handles[NUM_CHARSETS][NUM_CHARSETS];
 163 };
 164
 165 struct smb_iconv_handle *global_iconv_handle = NULL;
 166
 167 struct smb_iconv_handle *get_iconv_handle(void)
 168 {
 169         if (global_iconv_handle == NULL)
 170                 global_iconv_handle = smb_iconv_handle_reinit(talloc_autofree_context(),
 171                                                                         "ASCII", "UTF-8", "ASCII", true, NULL);
 172         return global_iconv_handle;
 173 }
 174
 175 /**
 176  * Return the name of a charset to give to iconv().
 177  **/
 178 const char *charset_name(struct smb_iconv_handle *ic, charset_t ch)
 179 {
 180         switch (ch) {
 181         case CH_UTF16: return "UTF-16LE";
 182         case CH_UNIX: return ic->unix_charset;
 183         case CH_DOS: return ic->dos_charset;
 184         case CH_DISPLAY: return ic->display_charset;
 185         case CH_UTF8: return "UTF8";
 186         case CH_UTF16BE: return "UTF-16BE";
 187         case CH_UTF16MUNGED: return "UTF16_MUNGED";
 188         default:
 189         return "ASCII";
 190         }
 191 }
 192
 193 /**
 194  re-initialize iconv conversion descriptors
 195 **/
 196 static int close_iconv_handle(struct smb_iconv_handle *data)
 197 {
 198         unsigned c1, c2;
 199         for (c1=0;c1<NUM_CHARSETS;c1++) {
 200                 for (c2=0;c2<NUM_CHARSETS;c2++) {
 201                         if (data->conv_handles[c1][c2] != NULL) {
 202                                 if (data->conv_handles[c1][c2] != (smb_iconv_t)-1) {
 203                                         smb_iconv_close(data->conv_handles[c1][c2]);
 204                                 }
 205                                 data->conv_handles[c1][c2] = NULL;
 206                         }
 207                 }
 208         }
 209
 210         return 0;
 211 }
 212
 213 static const char *map_locale(const char *charset)
 214 {
 215         if (strcmp(charset, "LOCALE") != 0) {
 216                 return charset;
 217         }
 218 #if defined(HAVE_NL_LANGINFO) && defined(CODESET)
 219         {
 220                 const char *ln;
 221                 smb_iconv_t handle;
 222
 223                 ln = nl_langinfo(CODESET);
 224                 if (ln == NULL) {
 225                         DEBUG(1,("Unable to determine charset for LOCALE - using ASCII\n"));
 226                         return "ASCII";
 227                 }
 228                 /* Check whether the charset name is supported
 229                    by iconv */
 230                 handle = smb_iconv_open(ln, "UCS-2LE");
 231                 if (handle == (smb_iconv_t) -1) {
 232                         DEBUG(5,("Locale charset '%s' unsupported, using ASCII instead\n", ln));
 233                         return "ASCII";
 234                 } else {
 235                         DEBUG(5,("Substituting charset '%s' for LOCALE\n", ln));
 236                         smb_iconv_close(handle);
 237                 }
 238                 return ln;
 239         }
 240 #endif
 241         return "ASCII";
 242 }
 243
 244 /*
 245   the old_ic is passed in here as the smb_iconv_handle structure
 246   is used as a global pointer in some places (eg. python modules). We
 247   don't want to invalidate those global pointers, but we do want to
 248   update them with the right charset information when loadparm
 249   runs. To do that we need to re-use the structure pointer, but
 250   re-fill the elements in the structure with the updated values
 251  */
 252 _PUBLIC_ struct smb_iconv_handle *smb_iconv_handle_reinit(TALLOC_CTX *mem_ctx,
 253                                                                     const char *dos_charset,
 254                                                                     const char *unix_charset,
 255                                                                     const char *display_charset,
 256                                                                     bool native_iconv,
 257                                                                     struct smb_iconv_handle *old_ic)
 258 {
 259         struct smb_iconv_handle *ret;
 260
 261         display_charset = map_locale(display_charset);
 262
 263         if (old_ic != NULL) {
 264                 ret = old_ic;
 265                 close_iconv_handle(ret);
 266                 talloc_free(ret->child_ctx);
 267                 ZERO_STRUCTP(ret);
 268         } else {
 269                 ret = talloc_zero(mem_ctx, struct smb_iconv_handle);
 270         }
 271         if (ret == NULL) {
 272                 return NULL;
 273         }
 274
 275         /* we use a child context to allow us to free all ptrs without
 276            freeing the structure itself */
 277         ret->child_ctx = talloc_new(ret);
 278         if (ret->child_ctx == NULL) {
 279                 return NULL;
 280         }
 281
 282         talloc_set_destructor(ret, close_iconv_handle);
 283
 284         ret->dos_charset = talloc_strdup(ret->child_ctx, dos_charset);
 285         ret->unix_charset = talloc_strdup(ret->child_ctx, unix_charset);
 286         ret->display_charset = talloc_strdup(ret->child_ctx, display_charset);
 287         ret->native_iconv = native_iconv;
 288
 289         return ret;
 290 }
 291
 292 /*
 293   on-demand initialisation of conversion handles
 294 */
 295 smb_iconv_t get_conv_handle(struct smb_iconv_handle *ic,
 296                             charset_t from, charset_t to)
 297 {
 298         const char *n1, *n2;
 299
 300         if (ic->conv_handles[from][to]) {
 301                 return ic->conv_handles[from][to];
 302         }
 303
 304         n1 = charset_name(ic, from);
 305         n2 = charset_name(ic, to);
 306
 307         ic->conv_handles[from][to] = smb_iconv_open_ex(ic, n2, n1,
 308                                                        ic->native_iconv);
 309
 310         if (ic->conv_handles[from][to] == (smb_iconv_t)-1) {
 311                 if ((from == CH_DOS || to == CH_DOS) &&
 312                     strcasecmp(charset_name(ic, CH_DOS), "ASCII") != 0) {
 313                         DEBUG(0,("dos charset '%s' unavailable - using ASCII\n",
 314                                  charset_name(ic, CH_DOS)));
 315                         ic->dos_charset = "ASCII";
 316
 317                         n1 = charset_name(ic, from);
 318                         n2 = charset_name(ic, to);
 319
 320                         ic->conv_handles[from][to] =
 321                                 smb_iconv_open_ex(ic, n2, n1, ic->native_iconv);
 322                 }
 323         }
 324
 325         return ic->conv_handles[from][to];
 326 }
 327
 328 /**
 329  * Return the unicode codepoint for the next character in the input
 330  * string in the given src_charset.
 331  * The unicode codepoint (codepoint_t) is an unsinged 32 bit value.
 332  *
 333  * Also return the number of bytes consumed (which tells the caller
 334  * how many bytes to skip to get to the next src_charset-character).
 335  *
 336  * This is implemented (in the non-ascii-case) by first converting the
 337  * next character in the input string to UTF16_LE and then calculating
 338  * the unicode codepoint from that.
 339  *
 340  * Return INVALID_CODEPOINT if the next character cannot be converted.
 341  */
 342 _PUBLIC_ codepoint_t next_codepoint_handle_ext(
 343                         struct smb_iconv_handle *ic,
 344                         const char *str, charset_t src_charset,
 345                         size_t *bytes_consumed)
 346 {
 347         /* it cannot occupy more than 4 bytes in UTF16 format */
 348         uint8_t buf[4];
 349         smb_iconv_t descriptor;
 350         size_t ilen_orig;
 351         size_t ilen;
 352         size_t olen;
 353         char *outbuf;
 354
 355         if ((str[0] & 0x80) == 0) {
 356                 *bytes_consumed = 1;
 357                 return (codepoint_t)str[0];
 358         }
 359
 360         /*
 361          * we assume that no multi-byte character can take more than 5 bytes.
 362          * This is OK as we only support codepoints up to 1M (U+100000)
 363          */
 364         ilen_orig = strnlen(str, 5);
 365         ilen = ilen_orig;
 366
 367         descriptor = get_conv_handle(ic, src_charset, CH_UTF16);
 368         if (descriptor == (smb_iconv_t)-1) {
 369                 *bytes_consumed = 1;
 370                 return INVALID_CODEPOINT;
 371         }
 372
 373         /*
 374          * this looks a little strange, but it is needed to cope with
 375          * codepoints above 64k (U+1000) which are encoded as per RFC2781.
 376          */
 377         olen = 2;
 378         outbuf = (char *)buf;
 379         smb_iconv(descriptor, &str, &ilen, &outbuf, &olen);
 380         if (olen == 2) {
 381                 olen = 4;
 382                 outbuf = (char *)buf;
 383                 smb_iconv(descriptor,  &str, &ilen, &outbuf, &olen);
 384                 if (olen == 4) {
 385                         /* we didn't convert any bytes */
 386                         *bytes_consumed = 1;
 387                         return INVALID_CODEPOINT;
 388                 }
 389                 olen = 4 - olen;
 390         } else {
 391                 olen = 2 - olen;
 392         }
 393
 394         *bytes_consumed = ilen_orig - ilen;
 395
 396         if (olen == 2) {
 397                 return (codepoint_t)SVAL(buf, 0);
 398         }
 399         if (olen == 4) {
 400                 /* decode a 4 byte UTF16 character manually */
 401                 return (codepoint_t)0x10000 +
 402                         (buf[2] | ((buf[3] & 0x3)<<8) |
 403                          (buf[0]<<10) | ((buf[1] & 0x3)<<18));
 404         }
 405
 406         /* no other length is valid */
 407         return INVALID_CODEPOINT;
 408 }
 409
 410 /*
 411   return the unicode codepoint for the next multi-byte CH_UNIX character
 412   in the string
 413
 414   also return the number of bytes consumed (which tells the caller
 415   how many bytes to skip to get to the next CH_UNIX character)
 416
 417   return INVALID_CODEPOINT if the next character cannot be converted
 418 */
 419 _PUBLIC_ codepoint_t next_codepoint_handle(struct smb_iconv_handle *ic,
 420                                     const char *str, size_t *size)
 421 {
 422         return next_codepoint_handle_ext(ic, str, CH_UNIX, size);
 423 }
 424
 425 /*
 426   push a single codepoint into a CH_UNIX string the target string must
 427   be able to hold the full character, which is guaranteed if it is at
 428   least 5 bytes in size. The caller may pass less than 5 bytes if they
 429   are sure the character will fit (for example, you can assume that
 430   uppercase/lowercase of a character will not add more than 1 byte)
 431
 432   return the number of bytes occupied by the CH_UNIX character, or
 433   -1 on failure
 434 */
 435 _PUBLIC_ ssize_t push_codepoint_handle(struct smb_iconv_handle *ic,
 436                                 char *str, codepoint_t c)
 437 {
 438         smb_iconv_t descriptor;
 439         uint8_t buf[4];
 440         size_t ilen, olen;
 441         const char *inbuf;
 442
 443         if (c < 128) {
 444                 *str = c;
 445                 return 1;
 446         }
 447
 448         descriptor = get_conv_handle(ic,
 449                                      CH_UTF16, CH_UNIX);
 450         if (descriptor == (smb_iconv_t)-1) {
 451                 return -1;
 452         }
 453
 454         if (c < 0x10000) {
 455                 ilen = 2;
 456                 olen = 5;
 457                 inbuf = (char *)buf;
 458                 SSVAL(buf, 0, c);
 459                 smb_iconv(descriptor, &inbuf, &ilen, &str, &olen);
 460                 if (ilen != 0) {
 461                         return -1;
 462                 }
 463                 return 5 - olen;
 464         }
 465
 466         c -= 0x10000;
 467
 468         buf[0] = (c>>10) & 0xFF;
 469         buf[1] = (c>>18) | 0xd8;
 470         buf[2] = c & 0xFF;
 471         buf[3] = ((c>>8) & 0x3) | 0xdc;
 472
 473         ilen = 4;
 474         olen = 5;
 475         inbuf = (char *)buf;
 476
 477         smb_iconv(descriptor, &inbuf, &ilen, &str, &olen);
 478         if (ilen != 0) {
 479                 return -1;
 480         }
 481         return 5 - olen;
 482 }
 483
 484 _PUBLIC_ codepoint_t next_codepoint_ext(const char *str, charset_t src_charset,
 485                                         size_t *size)
 486 {
 487         return next_codepoint_handle_ext(get_iconv_handle(), str,
 488                                               src_charset, size);
 489 }
 490
 491 _PUBLIC_ codepoint_t next_codepoint(const char *str, size_t *size)
 492 {
 493         return next_codepoint_handle(get_iconv_handle(), str, size);
 494 }
 495
 496 _PUBLIC_ ssize_t push_codepoint(char *str, codepoint_t c)
 497 {
 498         return push_codepoint_handle(get_iconv_handle(), str, c);
 499 }