lib/util/util.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Samba utility functions
   4    Copyright (C) Andrew Tridgell 1992-1998
   5    Copyright (C) Jeremy Allison 2001-2002
   6    Copyright (C) Simo Sorce 2001
   7    Copyright (C) Jim McDonough (jmcd@us.ibm.com)  2003.
   8    Copyright (C) James J Myers 2003
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22 */
  23
  24 #include "includes.h"
  25 #include "system/network.h"
  26 #include "system/filesys.h"
  27 #include "system/locale.h"
  28 #undef malloc
  29 #undef strcasecmp
  30 #undef strncasecmp
  31 #undef strdup
  32 #undef realloc
  33
  34 /**
  35  * @file
  36  * @brief Misc utility functions
  37  */
  38
  39 /**
  40  Find a suitable temporary directory. The result should be copied immediately
  41  as it may be overwritten by a subsequent call.
  42 **/
  43 _PUBLIC_ const char *tmpdir(void)
  44 {
  45         char *p;
  46         if ((p = getenv("TMPDIR")))
  47                 return p;
  48         return "/tmp";
  49 }
  50
  51
  52 /**
  53  Check if a file exists - call vfs_file_exist for samba files.
  54 **/
  55 _PUBLIC_ bool file_exist(const char *fname)
  56 {
  57         struct stat st;
  58
  59         if (stat(fname, &st) != 0) {
  60                 return false;
  61         }
  62
  63         return ((S_ISREG(st.st_mode)) || (S_ISFIFO(st.st_mode)));
  64 }
  65
  66 /**
  67  Check a files mod time.
  68 **/
  69
  70 _PUBLIC_ time_t file_modtime(const char *fname)
  71 {
  72         struct stat st;
  73
  74         if (stat(fname,&st) != 0)
  75                 return(0);
  76
  77         return(st.st_mtime);
  78 }
  79
  80 /**
  81  Check if a directory exists.
  82 **/
  83
  84 _PUBLIC_ bool directory_exist(const char *dname)
  85 {
  86         struct stat st;
  87         bool ret;
  88
  89         if (stat(dname,&st) != 0) {
  90                 return false;
  91         }
  92
  93         ret = S_ISDIR(st.st_mode);
  94         if(!ret)
  95                 errno = ENOTDIR;
  96         return ret;
  97 }
  98
  99 /**
 100  * Try to create the specified directory if it didn't exist.
 101  *
 102  * @retval true if the directory already existed and has the right permissions
 103  * or was successfully created.
 104  */
 105 _PUBLIC_ bool directory_create_or_exist(const char *dname, uid_t uid,
 106                                mode_t dir_perms)
 107 {
 108         mode_t old_umask;
 109         struct stat st;
 110
 111         old_umask = umask(0);
 112         if (lstat(dname, &st) == -1) {
 113                 if (errno == ENOENT) {
 114                         /* Create directory */
 115                         if (mkdir(dname, dir_perms) == -1) {
 116                                 DEBUG(0, ("error creating directory "
 117                                           "%s: %s\n", dname,
 118                                           strerror(errno)));
 119                                 umask(old_umask);
 120                                 return false;
 121                         }
 122                 } else {
 123                         DEBUG(0, ("lstat failed on directory %s: %s\n",
 124                                   dname, strerror(errno)));
 125                         umask(old_umask);
 126                         return false;
 127                 }
 128         } else {
 129                 /* Check ownership and permission on existing directory */
 130                 if (!S_ISDIR(st.st_mode)) {
 131                         DEBUG(0, ("directory %s isn't a directory\n",
 132                                 dname));
 133                         umask(old_umask);
 134                         return false;
 135                 }
 136                 if (st.st_uid != uid && !uwrap_enabled()) {
 137                         DEBUG(0, ("invalid ownership on directory "
 138                                   "%s\n", dname));
 139                         umask(old_umask);
 140                         return false;
 141                 }
 142                 if ((st.st_mode & 0777) != dir_perms) {
 143                         DEBUG(0, ("invalid permissions on directory "
 144                                   "%s\n", dname));
 145                         umask(old_umask);
 146                         return false;
 147                 }
 148         }
 149         return true;
 150 }
 151
 152
 153 /**
 154  Sleep for a specified number of milliseconds.
 155 **/
 156
 157 _PUBLIC_ void msleep(unsigned int t)
 158 {
 159         struct timeval tval;
 160
 161         tval.tv_sec = t/1000;
 162         tval.tv_usec = 1000*(t%1000);
 163         /* this should be the real select - do NOT replace
 164            with sys_select() */
 165         select(0,NULL,NULL,NULL,&tval);
 166 }
 167
 168 /**
 169  Get my own name, return in talloc'ed storage.
 170 **/
 171
 172 _PUBLIC_ char *get_myname(TALLOC_CTX *ctx)
 173 {
 174         char *p;
 175         char hostname[HOST_NAME_MAX];
 176
 177         /* get my host name */
 178         if (gethostname(hostname, sizeof(hostname)) == -1) {
 179                 DEBUG(0,("gethostname failed\n"));
 180                 return NULL;
 181         }
 182
 183         /* Ensure null termination. */
 184         hostname[sizeof(hostname)-1] = '\0';
 185
 186         /* split off any parts after an initial . */
 187         p = strchr_m(hostname, '.');
 188         if (p) {
 189                 *p = 0;
 190         }
 191
 192         return talloc_strdup(ctx, hostname);
 193 }
 194
 195 /**
 196  Check if a process exists. Does this work on all unixes?
 197 **/
 198
 199 _PUBLIC_ bool process_exists_by_pid(pid_t pid)
 200 {
 201         /* Doing kill with a non-positive pid causes messages to be
 202          * sent to places we don't want. */
 203         SMB_ASSERT(pid > 0);
 204         return(kill(pid,0) == 0 || errno != ESRCH);
 205 }
 206
 207 /**
 208  Simple routine to do POSIX file locking. Cruft in NFS and 64->32 bit mapping
 209  is dealt with in posix.c
 210 **/
 211
 212 _PUBLIC_ bool fcntl_lock(int fd, int op, off_t offset, off_t count, int type)
 213 {
 214         struct flock lock;
 215         int ret;
 216
 217         DEBUG(8,("fcntl_lock %d %d %.0f %.0f %d\n",fd,op,(double)offset,(double)count,type));
 218
 219         lock.l_type = type;
 220         lock.l_whence = SEEK_SET;
 221         lock.l_start = offset;
 222         lock.l_len = count;
 223         lock.l_pid = 0;
 224
 225         ret = fcntl(fd,op,&lock);
 226
 227         if (ret == -1 && errno != 0)
 228                 DEBUG(3,("fcntl_lock: fcntl lock gave errno %d (%s)\n",errno,strerror(errno)));
 229
 230         /* a lock query */
 231         if (op == F_GETLK) {
 232                 if ((ret != -1) &&
 233                                 (lock.l_type != F_UNLCK) &&
 234                                 (lock.l_pid != 0) &&
 235                                 (lock.l_pid != getpid())) {
 236                         DEBUG(3,("fcntl_lock: fd %d is locked by pid %d\n",fd,(int)lock.l_pid));
 237                         return true;
 238                 }
 239
 240                 /* it must be not locked or locked by me */
 241                 return false;
 242         }
 243
 244         /* a lock set or unset */
 245         if (ret == -1) {
 246                 DEBUG(3,("fcntl_lock: lock failed at offset %.0f count %.0f op %d type %d (%s)\n",
 247                         (double)offset,(double)count,op,type,strerror(errno)));
 248                 return false;
 249         }
 250
 251         /* everything went OK */
 252         DEBUG(8,("fcntl_lock: Lock call successful\n"));
 253
 254         return true;
 255 }
 256
 257 void print_asc(int level, const uint8_t *buf,int len)
 258 {
 259         int i;
 260         for (i=0;i<len;i++)
 261                 DEBUGADD(level,("%c", isprint(buf[i])?buf[i]:'.'));
 262 }
 263
 264 /**
 265  * Write dump of binary data to the log file.
 266  *
 267  * The data is only written if the log level is at least level.
 268  */
 269 static void _dump_data(int level, const uint8_t *buf, int len,
 270                        bool omit_zero_bytes)
 271 {
 272         int i=0;
 273         static const uint8_t empty[16] = { 0, };
 274         bool skipped = false;
 275
 276         if (len<=0) return;
 277
 278         if (!DEBUGLVL(level)) return;
 279
 280         for (i=0;i<len;) {
 281
 282                 if (i%16 == 0) {
 283                         if ((omit_zero_bytes == true) &&
 284                             (i > 0) &&
 285                             (len > i+16) &&
 286                             (memcmp(&buf[i], &empty, 16) == 0))
 287                         {
 288                                 i +=16;
 289                                 continue;
 290                         }
 291
 292                         if (i<len)  {
 293                                 DEBUGADD(level,("[%04X] ",i));
 294                         }
 295                 }
 296
 297                 DEBUGADD(level,("%02X ",(int)buf[i]));
 298                 i++;
 299                 if (i%8 == 0) DEBUGADD(level,("  "));
 300                 if (i%16 == 0) {
 301
 302                         print_asc(level,&buf[i-16],8); DEBUGADD(level,(" "));
 303                         print_asc(level,&buf[i-8],8); DEBUGADD(level,("\n"));
 304
 305                         if ((omit_zero_bytes == true) &&
 306                             (len > i+16) &&
 307                             (memcmp(&buf[i], &empty, 16) == 0)) {
 308                                 if (!skipped) {
 309                                         DEBUGADD(level,("skipping zero buffer bytes\n"));
 310                                         skipped = true;
 311                                 }
 312                         }
 313                 }
 314         }
 315
 316         if (i%16) {
 317                 int n;
 318                 n = 16 - (i%16);
 319                 DEBUGADD(level,(" "));
 320                 if (n>8) DEBUGADD(level,(" "));
 321                 while (n--) DEBUGADD(level,("   "));
 322                 n = MIN(8,i%16);
 323                 print_asc(level,&buf[i-(i%16)],n); DEBUGADD(level,( " " ));
 324                 n = (i%16) - n;
 325                 if (n>0) print_asc(level,&buf[i-n],n);
 326                 DEBUGADD(level,("\n"));
 327         }
 328
 329 }
 330
 331 /**
 332  * Write dump of binary data to the log file.
 333  *
 334  * The data is only written if the log level is at least level.
 335  */
 336 _PUBLIC_ void dump_data(int level, const uint8_t *buf, int len)
 337 {
 338         _dump_data(level, buf, len, false);
 339 }
 340
 341 /**
 342  * Write dump of binary data to the log file.
 343  *
 344  * The data is only written if the log level is at least level.
 345  * 16 zero bytes in a row are ommited
 346  */
 347 _PUBLIC_ void dump_data_skip_zeros(int level, const uint8_t *buf, int len)
 348 {
 349         _dump_data(level, buf, len, true);
 350 }
 351
 352
 353 /**
 354  malloc that aborts with smb_panic on fail or zero size.
 355 **/
 356
 357 _PUBLIC_ void *smb_xmalloc(size_t size)
 358 {
 359         void *p;
 360         if (size == 0)
 361                 smb_panic("smb_xmalloc: called with zero size.\n");
 362         if ((p = malloc(size)) == NULL)
 363                 smb_panic("smb_xmalloc: malloc fail.\n");
 364         return p;
 365 }
 366
 367 /**
 368  Memdup with smb_panic on fail.
 369 **/
 370
 371 _PUBLIC_ void *smb_xmemdup(const void *p, size_t size)
 372 {
 373         void *p2;
 374         p2 = smb_xmalloc(size);
 375         memcpy(p2, p, size);
 376         return p2;
 377 }
 378
 379 /**
 380  strdup that aborts on malloc fail.
 381 **/
 382
 383 char *smb_xstrdup(const char *s)
 384 {
 385 #if defined(PARANOID_MALLOC_CHECKER)
 386 #ifdef strdup
 387 #undef strdup
 388 #endif
 389 #endif
 390
 391 #ifndef HAVE_STRDUP
 392 #define strdup rep_strdup
 393 #endif
 394
 395         char *s1 = strdup(s);
 396 #if defined(PARANOID_MALLOC_CHECKER)
 397 #ifdef strdup
 398 #undef strdup
 399 #endif
 400 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
 401 #endif
 402         if (!s1) {
 403                 smb_panic("smb_xstrdup: malloc failed");
 404         }
 405         return s1;
 406
 407 }
 408
 409 /**
 410  strndup that aborts on malloc fail.
 411 **/
 412
 413 char *smb_xstrndup(const char *s, size_t n)
 414 {
 415 #if defined(PARANOID_MALLOC_CHECKER)
 416 #ifdef strndup
 417 #undef strndup
 418 #endif
 419 #endif
 420
 421 #if (defined(BROKEN_STRNDUP) || !defined(HAVE_STRNDUP))
 422 #undef HAVE_STRNDUP
 423 #define strndup rep_strndup
 424 #endif
 425
 426         char *s1 = strndup(s, n);
 427 #if defined(PARANOID_MALLOC_CHECKER)
 428 #ifdef strndup
 429 #undef strndup
 430 #endif
 431 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
 432 #endif
 433         if (!s1) {
 434                 smb_panic("smb_xstrndup: malloc failed");
 435         }
 436         return s1;
 437 }
 438
 439
 440
 441 /**
 442  Like strdup but for memory.
 443 **/
 444
 445 _PUBLIC_ void *memdup(const void *p, size_t size)
 446 {
 447         void *p2;
 448         if (size == 0)
 449                 return NULL;
 450         p2 = malloc(size);
 451         if (!p2)
 452                 return NULL;
 453         memcpy(p2, p, size);
 454         return p2;
 455 }
 456
 457 /**
 458  * Write a password to the log file.
 459  *
 460  * @note Only actually does something if DEBUG_PASSWORD was defined during
 461  * compile-time.
 462  */
 463 _PUBLIC_ void dump_data_pw(const char *msg, const uint8_t * data, size_t len)
 464 {
 465 #ifdef DEBUG_PASSWORD
 466         DEBUG(11, ("%s", msg));
 467         if (data != NULL && len > 0)
 468         {
 469                 dump_data(11, data, len);
 470         }
 471 #endif
 472 }
 473
 474
 475 /**
 476  * see if a range of memory is all zero. A NULL pointer is considered
 477  * to be all zero
 478  */
 479 _PUBLIC_ bool all_zero(const uint8_t *ptr, size_t size)
 480 {
 481         int i;
 482         if (!ptr) return true;
 483         for (i=0;i<size;i++) {
 484                 if (ptr[i]) return false;
 485         }
 486         return true;
 487 }
 488
 489 /**
 490   realloc an array, checking for integer overflow in the array size
 491 */
 492 _PUBLIC_ void *realloc_array(void *ptr, size_t el_size, unsigned count, bool free_on_fail)
 493 {
 494 #define MAX_MALLOC_SIZE 0x7fffffff
 495         if (count == 0 ||
 496             count >= MAX_MALLOC_SIZE/el_size) {
 497                 if (free_on_fail)
 498                         SAFE_FREE(ptr);
 499                 return NULL;
 500         }
 501         if (!ptr) {
 502                 return malloc(el_size * count);
 503         }
 504         return realloc(ptr, el_size * count);
 505 }
 506
 507 /****************************************************************************
 508  Type-safe malloc.
 509 ****************************************************************************/
 510
 511 void *malloc_array(size_t el_size, unsigned int count)
 512 {
 513         return realloc_array(NULL, el_size, count, false);
 514 }
 515
 516 /**
 517  Trim the specified elements off the front and back of a string.
 518 **/
 519 _PUBLIC_ bool trim_string(char *s, const char *front, const char *back)
 520 {
 521         bool ret = false;
 522         size_t front_len;
 523         size_t back_len;
 524         size_t len;
 525
 526         /* Ignore null or empty strings. */
 527         if (!s || (s[0] == '\0'))
 528                 return false;
 529
 530         front_len       = front? strlen(front) : 0;
 531         back_len        = back? strlen(back) : 0;
 532
 533         len = strlen(s);
 534
 535         if (front_len) {
 536                 while (len && strncmp(s, front, front_len)==0) {
 537                         /* Must use memmove here as src & dest can
 538                          * easily overlap. Found by valgrind. JRA. */
 539                         memmove(s, s+front_len, (len-front_len)+1);
 540                         len -= front_len;
 541                         ret=true;
 542                 }
 543         }
 544
 545         if (back_len) {
 546                 while ((len >= back_len) && strncmp(s+len-back_len,back,back_len)==0) {
 547                         s[len-back_len]='\0';
 548                         len -= back_len;
 549                         ret=true;
 550                 }
 551         }
 552         return ret;
 553 }
 554
 555 /**
 556  Find the number of 'c' chars in a string
 557 **/
 558 _PUBLIC_ _PURE_ size_t count_chars(const char *s, char c)
 559 {
 560         size_t count = 0;
 561
 562         while (*s) {
 563                 if (*s == c) count++;
 564                 s ++;
 565         }
 566
 567         return count;
 568 }
 569
 570 /**
 571  Routine to get hex characters and turn them into a 16 byte array.
 572  the array can be variable length, and any non-hex-numeric
 573  characters are skipped.  "0xnn" or "0Xnn" is specially catered
 574  for.
 575
 576  valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
 577
 578
 579 **/
 580 _PUBLIC_ size_t strhex_to_str(char *p, size_t p_len, const char *strhex, size_t strhex_len)
 581 {
 582         size_t i;
 583         size_t num_chars = 0;
 584         uint8_t   lonybble, hinybble;
 585         const char     *hexchars = "0123456789ABCDEF";
 586         char           *p1 = NULL, *p2 = NULL;
 587
 588         for (i = 0; i < strhex_len && strhex[i] != 0; i++) {
 589                 if (strncasecmp(hexchars, "0x", 2) == 0) {
 590                         i++; /* skip two chars */
 591                         continue;
 592                 }
 593
 594                 if (!(p1 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
 595                         break;
 596
 597                 i++; /* next hex digit */
 598
 599                 if (!(p2 = strchr(hexchars, toupper((unsigned char)strhex[i]))))
 600                         break;
 601
 602                 /* get the two nybbles */
 603                 hinybble = PTR_DIFF(p1, hexchars);
 604                 lonybble = PTR_DIFF(p2, hexchars);
 605
 606                 if (num_chars >= p_len) {
 607                         break;
 608                 }
 609
 610                 p[num_chars] = (hinybble << 4) | lonybble;
 611                 num_chars++;
 612
 613                 p1 = NULL;
 614                 p2 = NULL;
 615         }
 616         return num_chars;
 617 }
 618
 619 /**
 620  * Parse a hex string and return a data blob.
 621  */
 622 _PUBLIC_ _PURE_ DATA_BLOB strhex_to_data_blob(TALLOC_CTX *mem_ctx, const char *strhex)
 623 {
 624         DATA_BLOB ret_blob = data_blob_talloc(mem_ctx, NULL, strlen(strhex)/2+1);
 625
 626         ret_blob.length = strhex_to_str((char *)ret_blob.data, ret_blob.length,
 627                                         strhex,
 628                                         strlen(strhex));
 629
 630         return ret_blob;
 631 }
 632
 633
 634 /**
 635  * Routine to print a buffer as HEX digits, into an allocated string.
 636  */
 637 _PUBLIC_ void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer)
 638 {
 639         int i;
 640         char *hex_buffer;
 641
 642         *out_hex_buffer = malloc_array_p(char, (len*2)+1);
 643         hex_buffer = *out_hex_buffer;
 644
 645         for (i = 0; i < len; i++)
 646                 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
 647 }
 648
 649 /**
 650  * talloc version of hex_encode()
 651  */
 652 _PUBLIC_ char *hex_encode_talloc(TALLOC_CTX *mem_ctx, const unsigned char *buff_in, size_t len)
 653 {
 654         int i;
 655         char *hex_buffer;
 656
 657         hex_buffer = talloc_array(mem_ctx, char, (len*2)+1);
 658         if (!hex_buffer) {
 659                 return NULL;
 660         }
 661
 662         for (i = 0; i < len; i++)
 663                 slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
 664
 665         talloc_set_name_const(hex_buffer, hex_buffer);
 666         return hex_buffer;
 667 }
 668
 669 /**
 670  Unescape a URL encoded string, in place.
 671 **/
 672
 673 _PUBLIC_ void rfc1738_unescape(char *buf)
 674 {
 675         char *p=buf;
 676
 677         while ((p=strchr(p,'+')))
 678                 *p = ' ';
 679
 680         p = buf;
 681
 682         while (p && *p && (p=strchr(p,'%'))) {
 683                 int c1 = p[1];
 684                 int c2 = p[2];
 685
 686                 if (c1 >= '0' && c1 <= '9')
 687                         c1 = c1 - '0';
 688                 else if (c1 >= 'A' && c1 <= 'F')
 689                         c1 = 10 + c1 - 'A';
 690                 else if (c1 >= 'a' && c1 <= 'f')
 691                         c1 = 10 + c1 - 'a';
 692                 else {p++; continue;}
 693
 694                 if (c2 >= '0' && c2 <= '9')
 695                         c2 = c2 - '0';
 696                 else if (c2 >= 'A' && c2 <= 'F')
 697                         c2 = 10 + c2 - 'A';
 698                 else if (c2 >= 'a' && c2 <= 'f')
 699                         c2 = 10 + c2 - 'a';
 700                 else {p++; continue;}
 701
 702                 *p = (c1<<4) | c2;
 703
 704                 memmove(p+1, p+3, strlen(p+3)+1);
 705                 p++;
 706         }
 707 }
 708
 709 /**
 710   varient of strcmp() that handles NULL ptrs
 711 **/
 712 _PUBLIC_ int strcmp_safe(const char *s1, const char *s2)
 713 {
 714         if (s1 == s2) {
 715                 return 0;
 716         }
 717         if (s1 == NULL || s2 == NULL) {
 718                 return s1?-1:1;
 719         }
 720         return strcmp(s1, s2);
 721 }
 722
 723
 724 /**
 725 return the number of bytes occupied by a buffer in ASCII format
 726 the result includes the null termination
 727 limited by 'n' bytes
 728 **/
 729 _PUBLIC_ size_t ascii_len_n(const char *src, size_t n)
 730 {
 731         size_t len;
 732
 733         len = strnlen(src, n);
 734         if (len+1 <= n) {
 735                 len += 1;
 736         }
 737
 738         return len;
 739 }
 740
 741 /**
 742  Set a boolean variable from the text value stored in the passed string.
 743  Returns true in success, false if the passed string does not correctly
 744  represent a boolean.
 745 **/
 746
 747 _PUBLIC_ bool set_boolean(const char *boolean_string, bool *boolean)
 748 {
 749         if (strwicmp(boolean_string, "yes") == 0 ||
 750             strwicmp(boolean_string, "true") == 0 ||
 751             strwicmp(boolean_string, "on") == 0 ||
 752             strwicmp(boolean_string, "1") == 0) {
 753                 *boolean = true;
 754                 return true;
 755         } else if (strwicmp(boolean_string, "no") == 0 ||
 756                    strwicmp(boolean_string, "false") == 0 ||
 757                    strwicmp(boolean_string, "off") == 0 ||
 758                    strwicmp(boolean_string, "0") == 0) {
 759                 *boolean = false;
 760                 return true;
 761         }
 762         return false;
 763 }
 764
 765 /**
 766 return the number of bytes occupied by a buffer in CH_UTF16 format
 767 the result includes the null termination
 768 **/
 769 _PUBLIC_ size_t utf16_len(const void *buf)
 770 {
 771         size_t len;
 772
 773         for (len = 0; SVAL(buf,len); len += 2) ;
 774
 775         return len + 2;
 776 }
 777
 778 /**
 779 return the number of bytes occupied by a buffer in CH_UTF16 format
 780 the result includes the null termination
 781 limited by 'n' bytes
 782 **/
 783 _PUBLIC_ size_t utf16_len_n(const void *src, size_t n)
 784 {
 785         size_t len;
 786
 787         for (len = 0; (len+2 < n) && SVAL(src, len); len += 2) ;
 788
 789         if (len+2 <= n) {
 790                 len += 2;
 791         }
 792
 793         return len;
 794 }
 795
 796 /**
 797  * @file
 798  * @brief String utilities.
 799  **/
 800
 801 static bool next_token_internal_talloc(TALLOC_CTX *ctx,
 802                                 const char **ptr,
 803                                 char **pp_buff,
 804                                 const char *sep,
 805                                 bool ltrim)
 806 {
 807         char *s;
 808         char *saved_s;
 809         char *pbuf;
 810         bool quoted;
 811         size_t len=1;
 812
 813         *pp_buff = NULL;
 814         if (!ptr) {
 815                 return(false);
 816         }
 817
 818         s = (char *)*ptr;
 819
 820         /* default to simple separators */
 821         if (!sep) {
 822                 sep = " \t\n\r";
 823         }
 824
 825         /* find the first non sep char, if left-trimming is requested */
 826         if (ltrim) {
 827                 while (*s && strchr_m(sep,*s)) {
 828                         s++;
 829                 }
 830         }
 831
 832         /* nothing left? */
 833         if (!*s) {
 834                 return false;
 835         }
 836
 837         /* When restarting we need to go from here. */
 838         saved_s = s;
 839
 840         /* Work out the length needed. */
 841         for (quoted = false; *s &&
 842                         (quoted || !strchr_m(sep,*s)); s++) {
 843                 if (*s == '\"') {
 844                         quoted = !quoted;
 845                 } else {
 846                         len++;
 847                 }
 848         }
 849
 850         /* We started with len = 1 so we have space for the nul. */
 851         *pp_buff = talloc_array(ctx, char, len);
 852         if (!*pp_buff) {
 853                 return false;
 854         }
 855
 856         /* copy over the token */
 857         pbuf = *pp_buff;
 858         s = saved_s;
 859         for (quoted = false; *s &&
 860                         (quoted || !strchr_m(sep,*s)); s++) {
 861                 if ( *s == '\"' ) {
 862                         quoted = !quoted;
 863                 } else {
 864                         *pbuf++ = *s;
 865                 }
 866         }
 867
 868         *ptr = (*s) ? s+1 : s;
 869         *pbuf = 0;
 870
 871         return true;
 872 }
 873
 874 bool next_token_talloc(TALLOC_CTX *ctx,
 875                         const char **ptr,
 876                         char **pp_buff,
 877                         const char *sep)
 878 {
 879         return next_token_internal_talloc(ctx, ptr, pp_buff, sep, true);
 880 }
 881
 882 /*
 883  * Get the next token from a string, return false if none found.  Handles
 884  * double-quotes.  This version does not trim leading separator characters
 885  * before looking for a token.
 886  */
 887
 888 bool next_token_no_ltrim_talloc(TALLOC_CTX *ctx,
 889                         const char **ptr,
 890                         char **pp_buff,
 891                         const char *sep)
 892 {
 893         return next_token_internal_talloc(ctx, ptr, pp_buff, sep, false);
 894 }
 895
 896