source3/lib/charcnv.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) Martin Pool 2003
   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
  25 /* We can parameterize this if someone complains.... JRA. */
  26
  27 char lp_failed_convert_char(void)
  28 {
  29         return '_';
  30 }
  31
  32 /**
  33  * @file
  34  *
  35  * @brief Character-set conversion routines built on our iconv.
  36  *
  37  * @note Samba's internal character set (at least in the 3.0 series)
  38  * is always the same as the one for the Unix filesystem.  It is
  39  * <b>not</b> necessarily UTF-8 and may be different on machines that
  40  * need i18n filenames to be compatible with Unix software.  It does
  41  * have to be a superset of ASCII.  All multibyte sequences must start
  42  * with a byte with the high bit set.
  43  *
  44  * @sa lib/iconv.c
  45  */
  46
  47
  48 static smb_iconv_t conv_handles[NUM_CHARSETS][NUM_CHARSETS];
  49 static BOOL conv_silent; /* Should we do a debug if the conversion fails ? */
  50
  51 /**
  52  * Return the name of a charset to give to iconv().
  53  **/
  54 static const char *charset_name(charset_t ch)
  55 {
  56         const char *ret = NULL;
  57
  58         if (ch == CH_UTF16LE) ret = "UTF-16LE";
  59         else if (ch == CH_UTF16BE) ret = "UTF-16BE";
  60         else if (ch == CH_UNIX) ret = lp_unix_charset();
  61         else if (ch == CH_DOS) ret = lp_dos_charset();
  62         else if (ch == CH_DISPLAY) ret = lp_display_charset();
  63         else if (ch == CH_UTF8) ret = "UTF8";
  64
  65 #if defined(HAVE_NL_LANGINFO) && defined(CODESET)
  66         if (ret && !strcmp(ret, "LOCALE")) {
  67                 const char *ln = NULL;
  68
  69 #ifdef HAVE_SETLOCALE
  70                 setlocale(LC_ALL, "");
  71 #endif
  72                 ln = nl_langinfo(CODESET);
  73                 if (ln) {
  74                         /* Check whether the charset name is supported
  75                            by iconv */
  76                         smb_iconv_t handle = smb_iconv_open(ln,"UCS-2LE");
  77                         if (handle == (smb_iconv_t) -1) {
  78                                 DEBUG(5,("Locale charset '%s' unsupported, using ASCII instead\n", ln));
  79                                 ln = NULL;
  80                         } else {
  81                                 DEBUG(5,("Substituting charset '%s' for LOCALE\n", ln));
  82                                 smb_iconv_close(handle);
  83                         }
  84                 }
  85                 ret = ln;
  86         }
  87 #endif
  88
  89         if (!ret || !*ret) ret = "ASCII";
  90         return ret;
  91 }
  92
  93 void lazy_initialize_conv(void)
  94 {
  95         static int initialized = False;
  96
  97         if (!initialized) {
  98                 initialized = True;
  99                 load_case_tables();
 100                 init_iconv();
 101         }
 102 }
 103
 104 /**
 105  * Destroy global objects allocated by init_iconv()
 106  **/
 107 void gfree_charcnv(void)
 108 {
 109         int c1, c2;
 110
 111         for (c1=0;c1<NUM_CHARSETS;c1++) {
 112                 for (c2=0;c2<NUM_CHARSETS;c2++) {
 113                         if ( conv_handles[c1][c2] ) {
 114                                 smb_iconv_close( conv_handles[c1][c2] );
 115                                 conv_handles[c1][c2] = 0;
 116                         }
 117                 }
 118         }
 119 }
 120
 121 /**
 122  * Initialize iconv conversion descriptors.
 123  *
 124  * This is called the first time it is needed, and also called again
 125  * every time the configuration is reloaded, because the charset or
 126  * codepage might have changed.
 127  **/
 128 void init_iconv(void)
 129 {
 130         int c1, c2;
 131         BOOL did_reload = False;
 132
 133         /* so that charset_name() works we need to get the UNIX<->UCS2 going
 134            first */
 135         if (!conv_handles[CH_UNIX][CH_UTF16LE])
 136                 conv_handles[CH_UNIX][CH_UTF16LE] = smb_iconv_open(charset_name(CH_UTF16LE), "ASCII");
 137
 138         if (!conv_handles[CH_UTF16LE][CH_UNIX])
 139                 conv_handles[CH_UTF16LE][CH_UNIX] = smb_iconv_open("ASCII", charset_name(CH_UTF16LE));
 140
 141         for (c1=0;c1<NUM_CHARSETS;c1++) {
 142                 for (c2=0;c2<NUM_CHARSETS;c2++) {
 143                         const char *n1 = charset_name((charset_t)c1);
 144                         const char *n2 = charset_name((charset_t)c2);
 145                         if (conv_handles[c1][c2] &&
 146                             strcmp(n1, conv_handles[c1][c2]->from_name) == 0 &&
 147                             strcmp(n2, conv_handles[c1][c2]->to_name) == 0)
 148                                 continue;
 149
 150                         did_reload = True;
 151
 152                         if (conv_handles[c1][c2])
 153                                 smb_iconv_close(conv_handles[c1][c2]);
 154
 155                         conv_handles[c1][c2] = smb_iconv_open(n2,n1);
 156                         if (conv_handles[c1][c2] == (smb_iconv_t)-1) {
 157                                 DEBUG(0,("init_iconv: Conversion from %s to %s not supported\n",
 158                                          charset_name((charset_t)c1), charset_name((charset_t)c2)));
 159                                 if (c1 != CH_UTF16LE && c1 != CH_UTF16BE) {
 160                                         n1 = "ASCII";
 161                                 }
 162                                 if (c2 != CH_UTF16LE && c2 != CH_UTF16BE) {
 163                                         n2 = "ASCII";
 164                                 }
 165                                 DEBUG(0,("init_iconv: Attempting to replace with conversion from %s to %s\n",
 166                                         n1, n2 ));
 167                                 conv_handles[c1][c2] = smb_iconv_open(n2,n1);
 168                                 if (!conv_handles[c1][c2]) {
 169                                         DEBUG(0,("init_iconv: Conversion from %s to %s failed", n1, n2));
 170                                         smb_panic("init_iconv: conv_handle initialization failed");
 171                                 }
 172                         }
 173                 }
 174         }
 175
 176         if (did_reload) {
 177                 /* XXX: Does this really get called every time the dos
 178                  * codepage changes? */
 179                 /* XXX: Is the did_reload test too strict? */
 180                 conv_silent = True;
 181                 init_doschar_table();
 182                 init_valid_table();
 183                 conv_silent = False;
 184         }
 185 }
 186
 187 /**
 188  * Convert string from one encoding to another, making error checking etc
 189  * Slow path version - uses (slow) iconv.
 190  *
 191  * @param src pointer to source string (multibyte or singlebyte)
 192  * @param srclen length of the source string in bytes
 193  * @param dest pointer to destination string (multibyte or singlebyte)
 194  * @param destlen maximal length allowed for string
 195  * @param allow_bad_conv determines if a "best effort" conversion is acceptable (never returns errors)
 196  * @returns the number of bytes occupied in the destination
 197  *
 198  * Ensure the srclen contains the terminating zero.
 199  *
 200  **/
 201
 202 static size_t convert_string_internal(charset_t from, charset_t to,
 203                       void const *src, size_t srclen,
 204                       void *dest, size_t destlen, BOOL allow_bad_conv)
 205 {
 206         size_t i_len, o_len;
 207         size_t retval;
 208         const char* inbuf = (const char*)src;
 209         char* outbuf = (char*)dest;
 210         smb_iconv_t descriptor;
 211
 212         lazy_initialize_conv();
 213
 214         descriptor = conv_handles[from][to];
 215
 216         if (srclen == (size_t)-1) {
 217                 if (from == CH_UTF16LE || from == CH_UTF16BE) {
 218                         srclen = (strlen_w((const smb_ucs2_t *)src)+1) * 2;
 219                 } else {
 220                         srclen = strlen((const char *)src)+1;
 221                 }
 222         }
 223
 224
 225         if (descriptor == (smb_iconv_t)-1 || descriptor == (smb_iconv_t)0) {
 226                 if (!conv_silent)
 227                         DEBUG(0,("convert_string_internal: Conversion not supported.\n"));
 228                 return (size_t)-1;
 229         }
 230
 231         i_len=srclen;
 232         o_len=destlen;
 233
 234  again:
 235
 236         retval = smb_iconv(descriptor, &inbuf, &i_len, &outbuf, &o_len);
 237         if(retval==(size_t)-1) {
 238                 const char *reason="unknown error";
 239                 switch(errno) {
 240                         case EINVAL:
 241                                 reason="Incomplete multibyte sequence";
 242                                 if (!conv_silent)
 243                                         DEBUG(3,("convert_string_internal: Conversion error: %s(%s)\n",reason,inbuf));
 244                                 if (allow_bad_conv)
 245                                         goto use_as_is;
 246                                 break;
 247                         case E2BIG:
 248                                 reason="No more room";
 249                                 if (!conv_silent) {
 250                                         if (from == CH_UNIX) {
 251                                                 DEBUG(3,("E2BIG: convert_string(%s,%s): srclen=%u destlen=%u - '%s'\n",
 252                                                         charset_name(from), charset_name(to),
 253                                                         (unsigned int)srclen, (unsigned int)destlen, (const char *)src));
 254                                         } else {
 255                                                 DEBUG(3,("E2BIG: convert_string(%s,%s): srclen=%u destlen=%u\n",
 256                                                         charset_name(from), charset_name(to),
 257                                                         (unsigned int)srclen, (unsigned int)destlen));
 258                                         }
 259                                 }
 260                                 break;
 261                         case EILSEQ:
 262                                 reason="Illegal multibyte sequence";
 263                                 if (!conv_silent)
 264                                         DEBUG(3,("convert_string_internal: Conversion error: %s(%s)\n",reason,inbuf));
 265                                 if (allow_bad_conv)
 266                                         goto use_as_is;
 267                                 break;
 268                         default:
 269                                 if (!conv_silent)
 270                                         DEBUG(0,("convert_string_internal: Conversion error: %s(%s)\n",reason,inbuf));
 271                                 break;
 272                 }
 273                 /* smb_panic(reason); */
 274         }
 275         return destlen-o_len;
 276
 277  use_as_is:
 278
 279         /*
 280          * Conversion not supported. This is actually an error, but there are so
 281          * many misconfigured iconv systems and smb.conf's out there we can't just
 282          * fail. Do a very bad conversion instead.... JRA.
 283          */
 284
 285         {
 286                 if (o_len == 0 || i_len == 0)
 287                         return destlen - o_len;
 288
 289                 if (((from == CH_UTF16LE)||(from == CH_UTF16BE)) &&
 290                                 ((to != CH_UTF16LE)||(to != CH_UTF16BE))) {
 291                         /* Can't convert from utf16 any endian to multibyte.
 292                            Replace with the default fail char.
 293                         */
 294                         if (i_len < 2)
 295                                 return destlen - o_len;
 296                         if (i_len >= 2) {
 297                                 *outbuf = lp_failed_convert_char();
 298
 299                                 outbuf++;
 300                                 o_len--;
 301
 302                                 inbuf += 2;
 303                                 i_len -= 2;
 304                         }
 305
 306                         if (o_len == 0 || i_len == 0)
 307                                 return destlen - o_len;
 308
 309                         /* Keep trying with the next char... */
 310                         goto again;
 311
 312                 } else if (from != CH_UTF16LE && from != CH_UTF16BE && to == CH_UTF16LE) {
 313                         /* Can't convert to UTF16LE - just widen by adding the
 314                            default fail char then zero.
 315                         */
 316                         if (o_len < 2)
 317                                 return destlen - o_len;
 318
 319                         outbuf[0] = lp_failed_convert_char();
 320                         outbuf[1] = '\0';
 321
 322                         inbuf++;
 323                         i_len--;
 324
 325                         outbuf += 2;
 326                         o_len -= 2;
 327
 328                         if (o_len == 0 || i_len == 0)
 329                                 return destlen - o_len;
 330
 331                         /* Keep trying with the next char... */
 332                         goto again;
 333
 334                 } else if (from != CH_UTF16LE && from != CH_UTF16BE &&
 335                                 to != CH_UTF16LE && to != CH_UTF16BE) {
 336                         /* Failed multibyte to multibyte. Just copy the default fail char and
 337                                 try again. */
 338                         outbuf[0] = lp_failed_convert_char();
 339
 340                         inbuf++;
 341                         i_len--;
 342
 343                         outbuf++;
 344                         o_len--;
 345
 346                         if (o_len == 0 || i_len == 0)
 347                                 return destlen - o_len;
 348
 349                         /* Keep trying with the next char... */
 350                         goto again;
 351
 352                 } else {
 353                         /* Keep compiler happy.... */
 354                         return destlen - o_len;
 355                 }
 356         }
 357 }
 358
 359 /**
 360  * Convert string from one encoding to another, making error checking etc
 361  * Fast path version - handles ASCII first.
 362  *
 363  * @param src pointer to source string (multibyte or singlebyte)
 364  * @param srclen length of the source string in bytes, or -1 for nul terminated.
 365  * @param dest pointer to destination string (multibyte or singlebyte)
 366  * @param destlen maximal length allowed for string - *NEVER* -1.
 367  * @param allow_bad_conv determines if a "best effort" conversion is acceptable (never returns errors)
 368  * @returns the number of bytes occupied in the destination
 369  *
 370  * Ensure the srclen contains the terminating zero.
 371  *
 372  * This function has been hand-tuned to provide a fast path.
 373  * Don't change unless you really know what you are doing. JRA.
 374  **/
 375
 376 size_t convert_string(charset_t from, charset_t to,
 377                       void const *src, size_t srclen,
 378                       void *dest, size_t destlen, BOOL allow_bad_conv)
 379 {
 380         /*
 381          * NB. We deliberately don't do a strlen here if srclen == -1.
 382          * This is very expensive over millions of calls and is taken
 383          * care of in the slow path in convert_string_internal. JRA.
 384          */
 385
 386 #ifdef DEVELOPER
 387         SMB_ASSERT(destlen != (size_t)-1);
 388 #endif
 389
 390         if (srclen == 0)
 391                 return 0;
 392
 393         if (from != CH_UTF16LE && from != CH_UTF16BE && to != CH_UTF16LE && to != CH_UTF16BE) {
 394                 const unsigned char *p = (const unsigned char *)src;
 395                 unsigned char *q = (unsigned char *)dest;
 396                 size_t slen = srclen;
 397                 size_t dlen = destlen;
 398                 unsigned char lastp = '\0';
 399                 size_t retval = 0;
 400
 401                 /* If all characters are ascii, fast path here. */
 402                 while (slen && dlen) {
 403                         if ((lastp = *p) <= 0x7f) {
 404                                 *q++ = *p++;
 405                                 if (slen != (size_t)-1) {
 406                                         slen--;
 407                                 }
 408                                 dlen--;
 409                                 retval++;
 410                                 if (!lastp)
 411                                         break;
 412                         } else {
 413 #ifdef BROKEN_UNICODE_COMPOSE_CHARACTERS
 414                                 goto general_case;
 415 #else
 416                                 return retval + convert_string_internal(from, to, p, slen, q, dlen, allow_bad_conv);
 417 #endif
 418                         }
 419                 }
 420                 if (!dlen) {
 421                         /* Even if we fast path we should note if we ran out of room. */
 422                         if (((slen != (size_t)-1) && slen) ||
 423                                         ((slen == (size_t)-1) && lastp)) {
 424                                 errno = E2BIG;
 425                         }
 426                 }
 427                 return retval;
 428         } else if (from == CH_UTF16LE && to != CH_UTF16LE) {
 429                 const unsigned char *p = (const unsigned char *)src;
 430                 unsigned char *q = (unsigned char *)dest;
 431                 size_t retval = 0;
 432                 size_t slen = srclen;
 433                 size_t dlen = destlen;
 434                 unsigned char lastp = '\0';
 435
 436                 /* If all characters are ascii, fast path here. */
 437                 while (((slen == (size_t)-1) || (slen >= 2)) && dlen) {
 438                         if (((lastp = *p) <= 0x7f) && (p[1] == 0)) {
 439                                 *q++ = *p;
 440                                 if (slen != (size_t)-1) {
 441                                         slen -= 2;
 442                                 }
 443                                 p += 2;
 444                                 dlen--;
 445                                 retval++;
 446                                 if (!lastp)
 447                                         break;
 448                         } else {
 449 #ifdef BROKEN_UNICODE_COMPOSE_CHARACTERS
 450                                 goto general_case;
 451 #else
 452                                 return retval + convert_string_internal(from, to, p, slen, q, dlen, allow_bad_conv);
 453 #endif
 454                         }
 455                 }
 456                 if (!dlen) {
 457                         /* Even if we fast path we should note if we ran out of room. */
 458                         if (((slen != (size_t)-1) && slen) ||
 459                                         ((slen == (size_t)-1) && lastp)) {
 460                                 errno = E2BIG;
 461                         }
 462                 }
 463                 return retval;
 464         } else if (from != CH_UTF16LE && from != CH_UTF16BE && to == CH_UTF16LE) {
 465                 const unsigned char *p = (const unsigned char *)src;
 466                 unsigned char *q = (unsigned char *)dest;
 467                 size_t retval = 0;
 468                 size_t slen = srclen;
 469                 size_t dlen = destlen;
 470                 unsigned char lastp = '\0';
 471
 472                 /* If all characters are ascii, fast path here. */
 473                 while (slen && (dlen >= 2)) {
 474                         if ((lastp = *p) <= 0x7F) {
 475                                 *q++ = *p++;
 476                                 *q++ = '\0';
 477                                 if (slen != (size_t)-1) {
 478                                         slen--;
 479                                 }
 480                                 dlen -= 2;
 481                                 retval += 2;
 482                                 if (!lastp)
 483                                         break;
 484                         } else {
 485 #ifdef BROKEN_UNICODE_COMPOSE_CHARACTERS
 486                                 goto general_case;
 487 #else
 488                                 return retval + convert_string_internal(from, to, p, slen, q, dlen, allow_bad_conv);
 489 #endif
 490                         }
 491                 }
 492                 if (!dlen) {
 493                         /* Even if we fast path we should note if we ran out of room. */
 494                         if (((slen != (size_t)-1) && slen) ||
 495                                         ((slen == (size_t)-1) && lastp)) {
 496                                 errno = E2BIG;
 497                         }
 498                 }
 499                 return retval;
 500         }
 501
 502 #ifdef BROKEN_UNICODE_COMPOSE_CHARACTERS
 503   general_case:
 504 #endif
 505         return convert_string_internal(from, to, src, srclen, dest, destlen, allow_bad_conv);
 506 }
 507
 508 /**
 509  * Convert between character sets, allocating a new buffer for the result.
 510  *
 511  * @param ctx TALLOC_CTX to use to allocate with. If NULL use malloc.
 512  * (this is a bad interface and needs fixing. JRA).
 513  * @param srclen length of source buffer.
 514  * @param dest always set at least to NULL
 515  * @note -1 is not accepted for srclen.
 516  *
 517  * @returns Size in bytes of the converted string; or -1 in case of error.
 518  *
 519  * Ensure the srclen contains the terminating zero.
 520  *
 521  * I hate the goto's in this function. It's embarressing.....
 522  * There has to be a cleaner way to do this. JRA.
 523  **/
 524
 525 size_t convert_string_allocate(TALLOC_CTX *ctx, charset_t from, charset_t to,
 526                                void const *src, size_t srclen, void *dst, BOOL allow_bad_conv)
 527 {
 528         size_t i_len, o_len, destlen = MAX(srclen, 512);
 529         size_t retval;
 530         const char *inbuf = (const char *)src;
 531         char *outbuf = NULL, *ob = NULL;
 532         smb_iconv_t descriptor;
 533         void **dest = (void **)dst;
 534
 535         *dest = NULL;
 536
 537         if (src == NULL || srclen == (size_t)-1)
 538                 return (size_t)-1;
 539         if (srclen == 0)
 540                 return 0;
 541
 542         lazy_initialize_conv();
 543
 544         descriptor = conv_handles[from][to];
 545
 546         if (descriptor == (smb_iconv_t)-1 || descriptor == (smb_iconv_t)0) {
 547                 if (!conv_silent)
 548                         DEBUG(0,("convert_string_allocate: Conversion not supported.\n"));
 549                 return (size_t)-1;
 550         }
 551
 552   convert:
 553
 554         if ((destlen*2) < destlen) {
 555                 /* wrapped ! abort. */
 556                 if (!conv_silent)
 557                         DEBUG(0, ("convert_string_allocate: destlen wrapped !\n"));
 558                 if (!ctx)
 559                         SAFE_FREE(outbuf);
 560                 return (size_t)-1;
 561         } else {
 562                 destlen = destlen * 2;
 563         }
 564
 565         if (ctx) {
 566                 ob = (char *)TALLOC_REALLOC(ctx, ob, destlen);
 567         } else {
 568                 ob = (char *)SMB_REALLOC(ob, destlen);
 569         }
 570
 571         if (!ob) {
 572                 DEBUG(0, ("convert_string_allocate: realloc failed!\n"));
 573                 return (size_t)-1;
 574         }
 575         outbuf = ob;
 576         i_len = srclen;
 577         o_len = destlen;
 578
 579  again:
 580
 581         retval = smb_iconv(descriptor,
 582                            &inbuf, &i_len,
 583                            &outbuf, &o_len);
 584         if(retval == (size_t)-1)                {
 585                 const char *reason="unknown error";
 586                 switch(errno) {
 587                         case EINVAL:
 588                                 reason="Incomplete multibyte sequence";
 589                                 if (!conv_silent)
 590                                         DEBUG(3,("convert_string_allocate: Conversion error: %s(%s)\n",reason,inbuf));
 591                                 if (allow_bad_conv)
 592                                         goto use_as_is;
 593                                 break;
 594                         case E2BIG:
 595                                 goto convert;
 596                         case EILSEQ:
 597                                 reason="Illegal multibyte sequence";
 598                                 if (!conv_silent)
 599                                         DEBUG(3,("convert_string_allocate: Conversion error: %s(%s)\n",reason,inbuf));
 600                                 if (allow_bad_conv)
 601                                         goto use_as_is;
 602                                 break;
 603                 }
 604                 if (!conv_silent)
 605                         DEBUG(0,("Conversion error: %s(%s)\n",reason,inbuf));
 606                 /* smb_panic(reason); */
 607                 if (ctx) {
 608                         TALLOC_FREE(ob);
 609                 } else {
 610                         SAFE_FREE(ob);
 611                 }
 612                 return (size_t)-1;
 613         }
 614
 615   out:
 616
 617         destlen = destlen - o_len;
 618         if (ctx) {
 619                 ob = (char *)TALLOC_REALLOC(ctx,ob,destlen);
 620         } else {
 621                 ob = (char *)SMB_REALLOC(ob,destlen);
 622         }
 623
 624         if (destlen && !ob) {
 625                 DEBUG(0, ("convert_string_allocate: out of memory!\n"));
 626                 return (size_t)-1;
 627         }
 628
 629         *dest = ob;
 630         return destlen;
 631
 632  use_as_is:
 633
 634         /*
 635          * Conversion not supported. This is actually an error, but there are so
 636          * many misconfigured iconv systems and smb.conf's out there we can't just
 637          * fail. Do a very bad conversion instead.... JRA.
 638          */
 639
 640         {
 641                 if (o_len == 0 || i_len == 0)
 642                         goto out;
 643
 644                 if (((from == CH_UTF16LE)||(from == CH_UTF16BE)) &&
 645                                 ((to != CH_UTF16LE)||(to != CH_UTF16BE))) {
 646                         /* Can't convert from utf16 any endian to multibyte.
 647                            Replace with the default fail char.
 648                         */
 649
 650                         if (i_len < 2)
 651                                 goto out;
 652
 653                         if (i_len >= 2) {
 654                                 *outbuf = lp_failed_convert_char();
 655
 656                                 outbuf++;
 657                                 o_len--;
 658
 659                                 inbuf += 2;
 660                                 i_len -= 2;
 661                         }
 662
 663                         if (o_len == 0 || i_len == 0)
 664                                 goto out;
 665
 666                         /* Keep trying with the next char... */
 667                         goto again;
 668
 669                 } else if (from != CH_UTF16LE && from != CH_UTF16BE && to == CH_UTF16LE) {
 670                         /* Can't convert to UTF16LE - just widen by adding the
 671                            default fail char then zero.
 672                         */
 673                         if (o_len < 2)
 674                                 goto out;
 675
 676                         outbuf[0] = lp_failed_convert_char();
 677                         outbuf[1] = '\0';
 678
 679                         inbuf++;
 680                         i_len--;
 681
 682                         outbuf += 2;
 683                         o_len -= 2;
 684
 685                         if (o_len == 0 || i_len == 0)
 686                                 goto out;
 687
 688                         /* Keep trying with the next char... */
 689                         goto again;
 690
 691                 } else if (from != CH_UTF16LE && from != CH_UTF16BE &&
 692                                 to != CH_UTF16LE && to != CH_UTF16BE) {
 693                         /* Failed multibyte to multibyte. Just copy the default fail char and
 694                            try again. */
 695                         outbuf[0] = lp_failed_convert_char();
 696
 697                         inbuf++;
 698                         i_len--;
 699
 700                         outbuf++;
 701                         o_len--;
 702
 703                         if (o_len == 0 || i_len == 0)
 704                                 goto out;
 705
 706                         /* Keep trying with the next char... */
 707                         goto again;
 708
 709                 } else {
 710                         /* Keep compiler happy.... */
 711                         goto out;
 712                 }
 713         }
 714 }
 715
 716 /**
 717  * Convert between character sets, allocating a new buffer using talloc for the result.
 718  *
 719  * @param srclen length of source buffer.
 720  * @param dest always set at least to NULL
 721  * @note -1 is not accepted for srclen.
 722  *
 723  * @returns Size in bytes of the converted string; or -1 in case of error.
 724  **/
 725 size_t convert_string_talloc(TALLOC_CTX *ctx, charset_t from, charset_t to,
 726                              void const *src, size_t srclen, void *dst,
 727                              BOOL allow_bad_conv)
 728 {
 729         void **dest = (void **)dst;
 730         size_t dest_len;
 731
 732         *dest = NULL;
 733         dest_len=convert_string_allocate(ctx, from, to, src, srclen, dest, allow_bad_conv);
 734         if (dest_len == (size_t)-1)
 735                 return (size_t)-1;
 736         if (*dest == NULL)
 737                 return (size_t)-1;
 738         return dest_len;
 739 }
 740
 741 size_t unix_strupper(const char *src, size_t srclen, char *dest, size_t destlen)
 742 {
 743         size_t size;
 744         smb_ucs2_t *buffer;
 745
 746         size = push_ucs2_allocate(&buffer, src);
 747         if (size == (size_t)-1) {
 748                 smb_panic("failed to create UCS2 buffer");
 749         }
 750         if (!strupper_w(buffer) && (dest == src)) {
 751                 free(buffer);
 752                 return srclen;
 753         }
 754
 755         size = convert_string(CH_UTF16LE, CH_UNIX, buffer, size, dest, destlen, True);
 756         free(buffer);
 757         return size;
 758 }
 759
 760 /**
 761  strdup() a unix string to upper case.
 762  Max size is pstring.
 763 **/
 764
 765 char *strdup_upper(const char *s)
 766 {
 767         pstring out_buffer;
 768         const unsigned char *p = (const unsigned char *)s;
 769         unsigned char *q = (unsigned char *)out_buffer;
 770
 771         /* this is quite a common operation, so we want it to be
 772            fast. We optimise for the ascii case, knowing that all our
 773            supported multi-byte character sets are ascii-compatible
 774            (ie. they match for the first 128 chars) */
 775
 776         while (1) {
 777                 if (*p & 0x80)
 778                         break;
 779                 *q++ = toupper_ascii(*p);
 780                 if (!*p)
 781                         break;
 782                 p++;
 783                 if (p - ( const unsigned char *)s >= sizeof(pstring))
 784                         break;
 785         }
 786
 787         if (*p) {
 788                 /* MB case. */
 789                 size_t size;
 790                 wpstring buffer;
 791                 size = convert_string(CH_UNIX, CH_UTF16LE, s, -1, buffer, sizeof(buffer), True);
 792                 if (size == (size_t)-1) {
 793                         return NULL;
 794                 }
 795
 796                 strupper_w(buffer);
 797
 798                 size = convert_string(CH_UTF16LE, CH_UNIX, buffer, -1, out_buffer, sizeof(out_buffer), True);
 799                 if (size == (size_t)-1) {
 800                         return NULL;
 801                 }
 802         }
 803
 804         return SMB_STRDUP(out_buffer);
 805 }
 806
 807 size_t unix_strlower(const char *src, size_t srclen, char *dest, size_t destlen)
 808 {
 809         size_t size;
 810         smb_ucs2_t *buffer = NULL;
 811
 812         size = convert_string_allocate(NULL, CH_UNIX, CH_UTF16LE, src, srclen,
 813                                        (void **)(void *)&buffer, True);
 814         if (size == (size_t)-1 || !buffer) {
 815                 smb_panic("failed to create UCS2 buffer");
 816         }
 817         if (!strlower_w(buffer) && (dest == src)) {
 818                 SAFE_FREE(buffer);
 819                 return srclen;
 820         }
 821         size = convert_string(CH_UTF16LE, CH_UNIX, buffer, size, dest, destlen, True);
 822         SAFE_FREE(buffer);
 823         return size;
 824 }
 825
 826 /**
 827  strdup() a unix string to lower case.
 828 **/
 829
 830 char *strdup_lower(const char *s)
 831 {
 832         size_t size;
 833         smb_ucs2_t *buffer = NULL;
 834         char *out_buffer;
 835
 836         size = push_ucs2_allocate(&buffer, s);
 837         if (size == -1 || !buffer) {
 838                 return NULL;
 839         }
 840
 841         strlower_w(buffer);
 842
 843         size = pull_ucs2_allocate(&out_buffer, buffer);
 844         SAFE_FREE(buffer);
 845
 846         if (size == (size_t)-1) {
 847                 return NULL;
 848         }
 849
 850         return out_buffer;
 851 }
 852
 853 static size_t ucs2_align(const void *base_ptr, const void *p, int flags)
 854 {
 855         if (flags & (STR_NOALIGN|STR_ASCII))
 856                 return 0;
 857         return PTR_DIFF(p, base_ptr) & 1;
 858 }
 859
 860
 861 /**
 862  * Copy a string from a char* unix src to a dos codepage string destination.
 863  *
 864  * @return the number of bytes occupied by the string in the destination.
 865  *
 866  * @param flags can include
 867  * <dl>
 868  * <dt>STR_TERMINATE</dt> <dd>means include the null termination</dd>
 869  * <dt>STR_UPPER</dt> <dd>means uppercase in the destination</dd>
 870  * </dl>
 871  *
 872  * @param dest_len the maximum length in bytes allowed in the
 873  * destination.  If @p dest_len is -1 then no maximum is used.
 874  **/
 875 size_t push_ascii(void *dest, const char *src, size_t dest_len, int flags)
 876 {
 877         size_t src_len = strlen(src);
 878         pstring tmpbuf;
 879
 880         /* treat a pstring as "unlimited" length */
 881         if (dest_len == (size_t)-1)
 882                 dest_len = sizeof(pstring);
 883
 884         if (flags & STR_UPPER) {
 885                 pstrcpy(tmpbuf, src);
 886                 strupper_m(tmpbuf);
 887                 src = tmpbuf;
 888         }
 889
 890         if (flags & (STR_TERMINATE | STR_TERMINATE_ASCII))
 891                 src_len++;
 892
 893         return convert_string(CH_UNIX, CH_DOS, src, src_len, dest, dest_len, True);
 894 }
 895
 896 size_t push_ascii_fstring(void *dest, const char *src)
 897 {
 898         return push_ascii(dest, src, sizeof(fstring), STR_TERMINATE);
 899 }
 900
 901 size_t push_ascii_pstring(void *dest, const char *src)
 902 {
 903         return push_ascii(dest, src, sizeof(pstring), STR_TERMINATE);
 904 }
 905
 906 /********************************************************************
 907  Push an nstring - ensure null terminated. Written by
 908  moriyama@miraclelinux.com (MORIYAMA Masayuki).
 909 ********************************************************************/
 910
 911 size_t push_ascii_nstring(void *dest, const char *src)
 912 {
 913         size_t i, buffer_len, dest_len;
 914         smb_ucs2_t *buffer;
 915
 916         conv_silent = True;
 917         buffer_len = push_ucs2_allocate(&buffer, src);
 918         if (buffer_len == (size_t)-1) {
 919                 smb_panic("failed to create UCS2 buffer");
 920         }
 921
 922         /* We're using buffer_len below to count ucs2 characters, not bytes. */
 923         buffer_len /= sizeof(smb_ucs2_t);
 924
 925         dest_len = 0;
 926         for (i = 0; buffer[i] != 0 && (i < buffer_len); i++) {
 927                 unsigned char mb[10];
 928                 /* Convert one smb_ucs2_t character at a time. */
 929                 size_t mb_len = convert_string(CH_UTF16LE, CH_DOS, buffer+i, sizeof(smb_ucs2_t), mb, sizeof(mb), False);
 930                 if ((mb_len != (size_t)-1) && (dest_len + mb_len <= MAX_NETBIOSNAME_LEN - 1)) {
 931                         memcpy((char *)dest + dest_len, mb, mb_len);
 932                         dest_len += mb_len;
 933                 } else {
 934                         errno = E2BIG;
 935                         break;
 936                 }
 937         }
 938         ((char *)dest)[dest_len] = '\0';
 939
 940         SAFE_FREE(buffer);
 941         conv_silent = False;
 942         return dest_len;
 943 }
 944
 945 /**
 946  * Copy a string from a dos codepage source to a unix char* destination.
 947  *
 948  * The resulting string in "dest" is always null terminated.
 949  *
 950  * @param flags can have:
 951  * <dl>
 952  * <dt>STR_TERMINATE</dt>
 953  * <dd>STR_TERMINATE means the string in @p src
 954  * is null terminated, and src_len is ignored.</dd>
 955  * </dl>
 956  *
 957  * @param src_len is the length of the source area in bytes.
 958  * @returns the number of bytes occupied by the string in @p src.
 959  **/
 960 size_t pull_ascii(char *dest, const void *src, size_t dest_len, size_t src_len, int flags)
 961 {
 962         size_t ret;
 963
 964         if (dest_len == (size_t)-1)
 965                 dest_len = sizeof(pstring);
 966
 967         if (flags & STR_TERMINATE) {
 968                 if (src_len == (size_t)-1) {
 969                         src_len = strlen((const char *)src) + 1;
 970                 } else {
 971                         size_t len = strnlen((const char *)src, src_len);
 972                         if (len < src_len)
 973                                 len++;
 974                         src_len = len;
 975                 }
 976         }
 977
 978         ret = convert_string(CH_DOS, CH_UNIX, src, src_len, dest, dest_len, True);
 979         if (ret == (size_t)-1) {
 980                 ret = 0;
 981                 dest_len = 0;
 982         }
 983
 984         if (dest_len && ret) {
 985                 /* Did we already process the terminating zero ? */
 986                 if (dest[MIN(ret-1, dest_len-1)] != 0) {
 987                         dest[MIN(ret, dest_len-1)] = 0;
 988                 }
 989         } else  {
 990                 dest[0] = 0;
 991         }
 992
 993         return src_len;
 994 }
 995
 996 /**
 997  * Copy a string from a dos codepage source to a unix char* destination.
 998  Talloc version.
 999  Uses malloc if TALLOC_CTX is NULL (this is a bad interface and
1000  needs fixing. JRA).
1001  *
1002  * The resulting string in "dest" is always null terminated.
1003  *
1004  * @param flags can have:
1005  * <dl>
1006  * <dt>STR_TERMINATE</dt>
1007  * <dd>STR_TERMINATE means the string in @p src
1008  * is null terminated, and src_len is ignored.</dd>
1009  * </dl>
1010  *
1011  * @param src_len is the length of the source area in bytes.
1012  * @returns the number of bytes occupied by the string in @p src.
1013  **/
1014
1015 static size_t pull_ascii_base_talloc(TALLOC_CTX *ctx,
1016                                         char **ppdest,
1017                                         const void *src,
1018                                         size_t src_len,
1019                                         int flags)
1020 {
1021         char *dest = NULL;
1022         size_t dest_len = 0;
1023
1024 #ifdef DEVELOPER
1025         /* Ensure we never use the braindead "malloc" varient. */
1026         if (ctx == NULL) {
1027                 smb_panic("NULL talloc CTX in pull_ascii_base_talloc\n");
1028         }
1029 #endif
1030
1031         *ppdest = NULL;
1032
1033         if (flags & STR_TERMINATE) {
1034                 if (src_len == (size_t)-1) {
1035                         src_len = strlen((const char *)src) + 1;
1036                 } else {
1037                         size_t len = strnlen((const char *)src, src_len);
1038                         if (len < src_len)
1039                                 len++;
1040                         src_len = len;
1041                 }
1042                 /* Ensure we don't use an insane length from the client. */
1043                 if (src_len >= 1024*1024) {
1044                         smb_panic("Bad src length in pull_ascii_base_talloc\n");
1045                 }
1046         }
1047
1048         dest_len = convert_string_allocate(ctx,
1049                                 CH_DOS,
1050                                 CH_UNIX,
1051                                 src,
1052                                 src_len,
1053                                 &dest,
1054                                 True);
1055
1056         if (dest_len == (size_t)-1) {
1057                 return 0;
1058         }
1059
1060         if (dest_len && dest) {
1061                 /* Did we already process the terminating zero ? */
1062                 if (dest[dest_len-1] != 0) {
1063                         dest[dest_len-1] = 0;
1064                 }
1065         } else if (dest) {
1066                 dest[0] = 0;
1067         }
1068
1069         *ppdest = dest;
1070         return src_len;
1071 }
1072
1073
1074 size_t pull_ascii_pstring(char *dest, const void *src)
1075 {
1076         return pull_ascii(dest, src, sizeof(pstring), -1, STR_TERMINATE);
1077 }
1078
1079 size_t pull_ascii_fstring(char *dest, const void *src)
1080 {
1081         return pull_ascii(dest, src, sizeof(fstring), -1, STR_TERMINATE);
1082 }
1083
1084 /* When pulling an nstring it can expand into a larger size (dos cp -> utf8). Cope with this. */
1085
1086 size_t pull_ascii_nstring(char *dest, size_t dest_len, const void *src)
1087 {
1088         return pull_ascii(dest, src, dest_len, sizeof(nstring)-1, STR_TERMINATE);
1089 }
1090
1091 /**
1092  * Copy a string from a char* src to a unicode destination.
1093  *
1094  * @returns the number of bytes occupied by the string in the destination.
1095  *
1096  * @param flags can have:
1097  *
1098  * <dl>
1099  * <dt>STR_TERMINATE <dd>means include the null termination.
1100  * <dt>STR_UPPER     <dd>means uppercase in the destination.
1101  * <dt>STR_NOALIGN   <dd>means don't do alignment.
1102  * </dl>
1103  *
1104  * @param dest_len is the maximum length allowed in the
1105  * destination. If dest_len is -1 then no maxiumum is used.
1106  **/
1107
1108 size_t push_ucs2(const void *base_ptr, void *dest, const char *src, size_t dest_len, int flags)
1109 {
1110         size_t len=0;
1111         size_t src_len;
1112         size_t ret;
1113
1114         /* treat a pstring as "unlimited" length */
1115         if (dest_len == (size_t)-1)
1116                 dest_len = sizeof(pstring);
1117
1118         if (flags & STR_TERMINATE)
1119                 src_len = (size_t)-1;
1120         else
1121                 src_len = strlen(src);
1122
1123         if (ucs2_align(base_ptr, dest, flags)) {
1124                 *(char *)dest = 0;
1125                 dest = (void *)((char *)dest + 1);
1126                 if (dest_len)
1127                         dest_len--;
1128                 len++;
1129         }
1130
1131         /* ucs2 is always a multiple of 2 bytes */
1132         dest_len &= ~1;
1133
1134         ret =  convert_string(CH_UNIX, CH_UTF16LE, src, src_len, dest, dest_len, True);
1135         if (ret == (size_t)-1) {
1136                 return 0;
1137         }
1138
1139         len += ret;
1140
1141         if (flags & STR_UPPER) {
1142                 smb_ucs2_t *dest_ucs2 = (smb_ucs2_t *)dest;
1143                 size_t i;
1144
1145                 /* We check for i < (ret / 2) below as the dest string isn't null
1146                    terminated if STR_TERMINATE isn't set. */
1147
1148                 for (i = 0; i < (ret / 2) && i < (dest_len / 2) && dest_ucs2[i]; i++) {
1149                         smb_ucs2_t v = toupper_w(dest_ucs2[i]);
1150                         if (v != dest_ucs2[i]) {
1151                                 dest_ucs2[i] = v;
1152                         }
1153                 }
1154         }
1155
1156         return len;
1157 }
1158
1159
1160 /**
1161  * Copy a string from a unix char* src to a UCS2 destination,
1162  * allocating a buffer using talloc().
1163  *
1164  * @param dest always set at least to NULL
1165  *
1166  * @returns The number of bytes occupied by the string in the destination
1167  *         or -1 in case of error.
1168  **/
1169 size_t push_ucs2_talloc(TALLOC_CTX *ctx, smb_ucs2_t **dest, const char *src)
1170 {
1171         size_t src_len = strlen(src)+1;
1172
1173         *dest = NULL;
1174         return convert_string_talloc(ctx, CH_UNIX, CH_UTF16LE, src, src_len, (void **)dest, True);
1175 }
1176
1177
1178 /**
1179  * Copy a string from a unix char* src to a UCS2 destination, allocating a buffer
1180  *
1181  * @param dest always set at least to NULL
1182  *
1183  * @returns The number of bytes occupied by the string in the destination
1184  *         or -1 in case of error.
1185  **/
1186
1187 size_t push_ucs2_allocate(smb_ucs2_t **dest, const char *src)
1188 {
1189         size_t src_len = strlen(src)+1;
1190
1191         *dest = NULL;
1192         return convert_string_allocate(NULL, CH_UNIX, CH_UTF16LE, src, src_len, (void **)dest, True);
1193 }
1194
1195 /**
1196  Copy a string from a char* src to a UTF-8 destination.
1197  Return the number of bytes occupied by the string in the destination
1198  Flags can have:
1199   STR_TERMINATE means include the null termination
1200   STR_UPPER     means uppercase in the destination
1201  dest_len is the maximum length allowed in the destination. If dest_len
1202  is -1 then no maxiumum is used.
1203 **/
1204
1205 static size_t push_utf8(void *dest, const char *src, size_t dest_len, int flags)
1206 {
1207         size_t src_len = strlen(src);
1208         pstring tmpbuf;
1209
1210         /* treat a pstring as "unlimited" length */
1211         if (dest_len == (size_t)-1)
1212                 dest_len = sizeof(pstring);
1213
1214         if (flags & STR_UPPER) {
1215                 pstrcpy(tmpbuf, src);
1216                 strupper_m(tmpbuf);
1217                 src = tmpbuf;
1218         }
1219
1220         if (flags & STR_TERMINATE)
1221                 src_len++;
1222
1223         return convert_string(CH_UNIX, CH_UTF8, src, src_len, dest, dest_len, True);
1224 }
1225
1226 size_t push_utf8_fstring(void *dest, const char *src)
1227 {
1228         return push_utf8(dest, src, sizeof(fstring), STR_TERMINATE);
1229 }
1230
1231 /**
1232  * Copy a string from a unix char* src to a UTF-8 destination, allocating a buffer using talloc
1233  *
1234  * @param dest always set at least to NULL
1235  *
1236  * @returns The number of bytes occupied by the string in the destination
1237  **/
1238
1239 size_t push_utf8_talloc(TALLOC_CTX *ctx, char **dest, const char *src)
1240 {
1241         size_t src_len = strlen(src)+1;
1242
1243         *dest = NULL;
1244         return convert_string_talloc(ctx, CH_UNIX, CH_UTF8, src, src_len, (void**)dest, True);
1245 }
1246
1247 /**
1248  * Copy a string from a unix char* src to a UTF-8 destination, allocating a buffer
1249  *
1250  * @param dest always set at least to NULL
1251  *
1252  * @returns The number of bytes occupied by the string in the destination
1253  **/
1254
1255 size_t push_utf8_allocate(char **dest, const char *src)
1256 {
1257         size_t src_len = strlen(src)+1;
1258
1259         *dest = NULL;
1260         return convert_string_allocate(NULL, CH_UNIX, CH_UTF8, src, src_len, (void **)dest, True);
1261 }
1262
1263 /**
1264  Copy a string from a ucs2 source to a unix char* destination.
1265  Flags can have:
1266   STR_TERMINATE means the string in src is null terminated.
1267   STR_NOALIGN   means don't try to align.
1268  if STR_TERMINATE is set then src_len is ignored if it is -1.
1269  src_len is the length of the source area in bytes
1270  Return the number of bytes occupied by the string in src.
1271  The resulting string in "dest" is always null terminated.
1272 **/
1273
1274 size_t pull_ucs2(const void *base_ptr, char *dest, const void *src, size_t dest_len, size_t src_len, int flags)
1275 {
1276         size_t ret;
1277
1278         if (dest_len == (size_t)-1)
1279                 dest_len = sizeof(pstring);
1280
1281         if (ucs2_align(base_ptr, src, flags)) {
1282                 src = (const void *)((const char *)src + 1);
1283                 if (src_len != (size_t)-1)
1284                         src_len--;
1285         }
1286
1287         if (flags & STR_TERMINATE) {
1288                 /* src_len -1 is the default for null terminated strings. */
1289                 if (src_len != (size_t)-1) {
1290                         size_t len = strnlen_w((const smb_ucs2_t *)src,
1291                                                 src_len/2);
1292                         if (len < src_len/2)
1293                                 len++;
1294                         src_len = len*2;
1295                 }
1296         }
1297
1298         /* ucs2 is always a multiple of 2 bytes */
1299         if (src_len != (size_t)-1)
1300                 src_len &= ~1;
1301
1302         ret = convert_string(CH_UTF16LE, CH_UNIX, src, src_len, dest, dest_len, True);
1303         if (ret == (size_t)-1) {
1304                 return 0;
1305         }
1306
1307         if (src_len == (size_t)-1)
1308                 src_len = ret*2;
1309
1310         if (dest_len && ret) {
1311                 /* Did we already process the terminating zero ? */
1312                 if (dest[MIN(ret-1, dest_len-1)] != 0) {
1313                         dest[MIN(ret, dest_len-1)] = 0;
1314                 }
1315         } else {
1316                 dest[0] = 0;
1317         }
1318
1319         return src_len;
1320 }
1321
1322 /**
1323  Copy a string from a ucs2 source to a unix char* destination.
1324  Talloc version with a base pointer.
1325  Uses malloc if TALLOC_CTX is NULL (this is a bad interface and
1326  needs fixing. JRA).
1327  Flags can have:
1328   STR_TERMINATE means the string in src is null terminated.
1329   STR_NOALIGN   means don't try to align.
1330  if STR_TERMINATE is set then src_len is ignored if it is -1.
1331  src_len is the length of the source area in bytes
1332  Return the number of bytes occupied by the string in src.
1333  The resulting string in "dest" is always null terminated.
1334 **/
1335
1336 static size_t pull_ucs2_base_talloc(TALLOC_CTX *ctx,
1337                         const void *base_ptr,
1338                         char **ppdest,
1339                         const void *src,
1340                         size_t src_len,
1341                         int flags)
1342 {
1343         char *dest;
1344         size_t dest_len;
1345
1346         *ppdest = NULL;
1347
1348 #ifdef DEVELOPER
1349         /* Ensure we never use the braindead "malloc" varient. */
1350         if (ctx == NULL) {
1351                 smb_panic("NULL talloc CTX in pull_ucs2_base_talloc\n");
1352         }
1353 #endif
1354
1355         if (ucs2_align(base_ptr, src, flags)) {
1356                 src = (const void *)((const char *)src + 1);
1357                 if (src_len != (size_t)-1)
1358                         src_len--;
1359         }
1360
1361         if (flags & STR_TERMINATE) {
1362                 /* src_len -1 is the default for null terminated strings. */
1363                 if (src_len != (size_t)-1) {
1364                         size_t len = strnlen_w((const smb_ucs2_t *)src,
1365                                                 src_len/2);
1366                         if (len < src_len/2)
1367                                 len++;
1368                         src_len = len*2;
1369                 }
1370                 /* Ensure we don't use an insane length from the client. */
1371                 if (src_len >= 1024*1024) {
1372                         smb_panic("Bad src length in pull_ucs2_base_talloc\n");
1373                 }
1374         }
1375
1376         /* ucs2 is always a multiple of 2 bytes */
1377         if (src_len != (size_t)-1) {
1378                 src_len &= ~1;
1379         }
1380
1381         dest_len = convert_string_talloc(ctx,
1382                                         CH_UTF16LE,
1383                                         CH_UNIX,
1384                                         src,
1385                                         src_len,
1386                                         (void **)&dest,
1387                                         True);
1388         if (dest_len == (size_t)-1) {
1389                 return 0;
1390         }
1391
1392         if (src_len == (size_t)-1)
1393                 src_len = dest_len*2;
1394
1395         if (dest_len) {
1396                 /* Did we already process the terminating zero ? */
1397                 if (dest[dest_len-1] != 0) {
1398                         dest[dest_len-1] = 0;
1399                 }
1400         } else if (dest) {
1401                 dest[0] = 0;
1402         }
1403
1404         *ppdest = dest;
1405         return src_len;
1406 }
1407
1408 size_t pull_ucs2_pstring(char *dest, const void *src)
1409 {
1410         return pull_ucs2(NULL, dest, src, sizeof(pstring), -1, STR_TERMINATE);
1411 }
1412
1413 size_t pull_ucs2_fstring(char *dest, const void *src)
1414 {
1415         return pull_ucs2(NULL, dest, src, sizeof(fstring), -1, STR_TERMINATE);
1416 }
1417
1418 /**
1419  * Copy a string from a UCS2 src to a unix char * destination, allocating a buffer using talloc
1420  *
1421  * @param dest always set at least to NULL
1422  *
1423  * @returns The number of bytes occupied by the string in the destination
1424  **/
1425
1426 size_t pull_ucs2_talloc(TALLOC_CTX *ctx, char **dest, const smb_ucs2_t *src)
1427 {
1428         size_t src_len = (strlen_w(src)+1) * sizeof(smb_ucs2_t);
1429         *dest = NULL;
1430         return convert_string_talloc(ctx, CH_UTF16LE, CH_UNIX, src, src_len, (void **)dest, True);
1431 }
1432
1433 /**
1434  * Copy a string from a UCS2 src to a unix char * destination, allocating a buffer
1435  *
1436  * @param dest always set at least to NULL
1437  *
1438  * @returns The number of bytes occupied by the string in the destination
1439  **/
1440
1441 size_t pull_ucs2_allocate(char **dest, const smb_ucs2_t *src)
1442 {
1443         size_t src_len = (strlen_w(src)+1) * sizeof(smb_ucs2_t);
1444         *dest = NULL;
1445         return convert_string_allocate(NULL, CH_UTF16LE, CH_UNIX, src, src_len, (void **)dest, True);
1446 }
1447
1448 /**
1449  * Copy a string from a UTF-8 src to a unix char * destination, allocating a buffer using talloc
1450  *
1451  * @param dest always set at least to NULL
1452  *
1453  * @returns The number of bytes occupied by the string in the destination
1454  **/
1455
1456 size_t pull_utf8_talloc(TALLOC_CTX *ctx, char **dest, const char *src)
1457 {
1458         size_t src_len = strlen(src)+1;
1459         *dest = NULL;
1460         return convert_string_talloc(ctx, CH_UTF8, CH_UNIX, src, src_len, (void **)dest, True);
1461 }
1462
1463 /**
1464  * Copy a string from a UTF-8 src to a unix char * destination, allocating a buffer
1465  *
1466  * @param dest always set at least to NULL
1467  *
1468  * @returns The number of bytes occupied by the string in the destination
1469  **/
1470
1471 size_t pull_utf8_allocate(char **dest, const char *src)
1472 {
1473         size_t src_len = strlen(src)+1;
1474         *dest = NULL;
1475         return convert_string_allocate(NULL, CH_UTF8, CH_UNIX, src, src_len, (void **)dest, True);
1476 }
1477
1478 /**
1479  * Copy a string from a DOS src to a unix char * destination, allocating a buffer using talloc
1480  *
1481  * @param dest always set at least to NULL
1482  *
1483  * @returns The number of bytes occupied by the string in the destination
1484  **/
1485
1486 size_t pull_ascii_talloc(TALLOC_CTX *ctx, char **dest, const char *src)
1487 {
1488         size_t src_len = strlen(src)+1;
1489         *dest = NULL;
1490         return convert_string_talloc(ctx, CH_DOS, CH_UNIX, src, src_len, (void **)dest, True);
1491 }
1492
1493 /**
1494  Copy a string from a char* src to a unicode or ascii
1495  dos codepage destination choosing unicode or ascii based on the
1496  flags in the SMB buffer starting at base_ptr.
1497  Return the number of bytes occupied by the string in the destination.
1498  flags can have:
1499   STR_TERMINATE means include the null termination.
1500   STR_UPPER     means uppercase in the destination.
1501   STR_ASCII     use ascii even with unicode packet.
1502   STR_NOALIGN   means don't do alignment.
1503  dest_len is the maximum length allowed in the destination. If dest_len
1504  is -1 then no maxiumum is used.
1505 **/
1506
1507 size_t push_string_fn(const char *function, unsigned int line, const void *base_ptr, void *dest, const char *src, size_t dest_len, int flags)
1508 {
1509 #ifdef DEVELOPER
1510         /* We really need to zero fill here, not clobber
1511          * region, as we want to ensure that valgrind thinks
1512          * all of the outgoing buffer has been written to
1513          * so a send() or write() won't trap an error.
1514          * JRA.
1515          */
1516 #if 0
1517         if (dest_len != (size_t)-1)
1518                 clobber_region(function, line, dest, dest_len);
1519 #else
1520         if (dest_len != (size_t)-1)
1521                 memset(dest, '\0', dest_len);
1522 #endif
1523 #endif
1524
1525         if (!(flags & STR_ASCII) && \
1526             ((flags & STR_UNICODE || \
1527               (SVAL(base_ptr, smb_flg2) & FLAGS2_UNICODE_STRINGS)))) {
1528                 return push_ucs2(base_ptr, dest, src, dest_len, flags);
1529         }
1530         return push_ascii(dest, src, dest_len, flags);
1531 }
1532
1533
1534 /**
1535  Copy a string from a unicode or ascii source (depending on
1536  the packet flags) to a char* destination.
1537  Flags can have:
1538   STR_TERMINATE means the string in src is null terminated.
1539   STR_UNICODE   means to force as unicode.
1540   STR_ASCII     use ascii even with unicode packet.
1541   STR_NOALIGN   means don't do alignment.
1542  if STR_TERMINATE is set then src_len is ignored is it is -1
1543  src_len is the length of the source area in bytes.
1544  Return the number of bytes occupied by the string in src.
1545  The resulting string in "dest" is always null terminated.
1546 **/
1547
1548 size_t pull_string_fn(const char *function, unsigned int line,
1549                       const void *base_ptr, uint16 smb_flags2, char *dest,
1550                       const void *src, size_t dest_len, size_t src_len,
1551                       int flags)
1552 {
1553 #ifdef DEVELOPER
1554         if (dest_len != (size_t)-1)
1555                 clobber_region(function, line, dest, dest_len);
1556 #endif
1557
1558         if ((base_ptr == NULL) && ((flags & (STR_ASCII|STR_UNICODE)) == 0)) {
1559                 smb_panic("No base ptr to get flg2 and neither ASCII nor "
1560                           "UNICODE defined");
1561         }
1562
1563         if (!(flags & STR_ASCII) && \
1564             ((flags & STR_UNICODE || \
1565               (smb_flags2 & FLAGS2_UNICODE_STRINGS)))) {
1566                 return pull_ucs2(base_ptr, dest, src, dest_len, src_len, flags);
1567         }
1568         return pull_ascii(dest, src, dest_len, src_len, flags);
1569 }
1570
1571 /**
1572  Copy a string from a unicode or ascii source (depending on
1573  the packet flags) to a char* destination.
1574  Variant that uses talloc.
1575  Flags can have:
1576   STR_TERMINATE means the string in src is null terminated.
1577   STR_UNICODE   means to force as unicode.
1578   STR_ASCII     use ascii even with unicode packet.
1579   STR_NOALIGN   means don't do alignment.
1580  if STR_TERMINATE is set then src_len is ignored is it is -1
1581  src_len is the length of the source area in bytes.
1582  Return the number of bytes occupied by the string in src.
1583  The resulting string in "dest" is always null terminated.
1584 **/
1585
1586 size_t pull_string_talloc_fn(const char *function,
1587                         unsigned int line,
1588                         TALLOC_CTX *ctx,
1589                         const void *base_ptr,
1590                         uint16 smb_flags2,
1591                         char **ppdest,
1592                         const void *src,
1593                         size_t src_len,
1594                         int flags)
1595 {
1596         if ((base_ptr == NULL) && ((flags & (STR_ASCII|STR_UNICODE)) == 0)) {
1597                 smb_panic("No base ptr to get flg2 and neither ASCII nor "
1598                           "UNICODE defined");
1599         }
1600
1601         if (!(flags & STR_ASCII) && \
1602             ((flags & STR_UNICODE || \
1603               (smb_flags2 & FLAGS2_UNICODE_STRINGS)))) {
1604                 return pull_ucs2_base_talloc(ctx,
1605                                         base_ptr,
1606                                         ppdest,
1607                                         src,
1608                                         src_len,
1609                                         flags);
1610         }
1611         return pull_ascii_base_talloc(ctx,
1612                                         ppdest,
1613                                         src,
1614                                         src_len,
1615                                         flags);
1616 }
1617
1618
1619 size_t align_string(const void *base_ptr, const char *p, int flags)
1620 {
1621         if (!(flags & STR_ASCII) && \
1622             ((flags & STR_UNICODE || \
1623               (SVAL(base_ptr, smb_flg2) & FLAGS2_UNICODE_STRINGS)))) {
1624                 return ucs2_align(base_ptr, p, flags);
1625         }
1626         return 0;
1627 }
1628
1629 /*
1630   Return the unicode codepoint for the next multi-byte CH_UNIX character
1631   in the string. The unicode codepoint (codepoint_t) is an unsinged 32 bit value.
1632
1633   Also return the number of bytes consumed (which tells the caller
1634   how many bytes to skip to get to the next CH_UNIX character).
1635
1636   Return INVALID_CODEPOINT if the next character cannot be converted.
1637 */
1638
1639 codepoint_t next_codepoint(const char *str, size_t *size)
1640 {
1641         /* It cannot occupy more than 4 bytes in UTF16 format */
1642         uint8_t buf[4];
1643         smb_iconv_t descriptor;
1644         size_t ilen_orig;
1645         size_t ilen;
1646         size_t olen;
1647         char *outbuf;
1648
1649         if ((str[0] & 0x80) == 0) {
1650                 *size = 1;
1651                 return (codepoint_t)str[0];
1652         }
1653
1654         /* We assume that no multi-byte character can take
1655            more than 5 bytes. This is OK as we only
1656            support codepoints up to 1M */
1657
1658         ilen_orig = strnlen(str, 5);
1659         ilen = ilen_orig;
1660
1661         lazy_initialize_conv();
1662
1663         descriptor = conv_handles[CH_UNIX][CH_UTF16LE];
1664         if (descriptor == (smb_iconv_t)-1 || descriptor == (smb_iconv_t)0) {
1665                 *size = 1;
1666                 return INVALID_CODEPOINT;
1667         }
1668
1669         /* This looks a little strange, but it is needed to cope
1670            with codepoints above 64k which are encoded as per RFC2781. */
1671         olen = 2;
1672         outbuf = (char *)buf;
1673         smb_iconv(descriptor, &str, &ilen, &outbuf, &olen);
1674         if (olen == 2) {
1675                 /* We failed to convert to a 2 byte character.
1676                    See if we can convert to a 4 UTF16-LE byte char encoding.
1677                 */
1678                 olen = 4;
1679                 outbuf = (char *)buf;
1680                 smb_iconv(descriptor,  &str, &ilen, &outbuf, &olen);
1681                 if (olen == 4) {
1682                         /* We didn't convert any bytes */
1683                         *size = 1;
1684                         return INVALID_CODEPOINT;
1685                 }
1686                 olen = 4 - olen;
1687         } else {
1688                 olen = 2 - olen;
1689         }
1690
1691         *size = ilen_orig - ilen;
1692
1693         if (olen == 2) {
1694                 /* 2 byte, UTF16-LE encoded value. */
1695                 return (codepoint_t)SVAL(buf, 0);
1696         }
1697         if (olen == 4) {
1698                 /* Decode a 4 byte UTF16-LE character manually.
1699                    See RFC2871 for the encoding machanism.
1700                 */
1701                 codepoint_t w1 = SVAL(buf,0) & ~0xD800;
1702                 codepoint_t w2 = SVAL(buf,2) & ~0xDC00;
1703
1704                 return (codepoint_t)0x10000 +
1705                                 (w1 << 10) + w2;
1706         }
1707
1708         /* no other length is valid */
1709         return INVALID_CODEPOINT;
1710 }