source/lib/util_str.c

   1 /*
   2    Unix SMB/Netbios implementation.
   3    Version 1.9.
   4    Samba utility functions
   5    Copyright (C) Andrew Tridgell 1992-1998
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 2 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program; if not, write to the Free Software
  19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 */
  21
  22 #include "includes.h"
  23
  24 extern int DEBUGLEVEL;
  25
  26 static char *last_ptr=NULL;
  27
  28 void set_first_token(char *ptr)
  29 {
  30         last_ptr = ptr;
  31 }
  32
  33 /****************************************************************************
  34   Get the next token from a string, return False if none found
  35   handles double-quotes.
  36 Based on a routine by GJC@VILLAGE.COM.
  37 Extensively modified by Andrew.Tridgell@anu.edu.au
  38 ****************************************************************************/
  39 BOOL next_token(char **ptr,char *buff,char *sep, size_t bufsize)
  40 {
  41   char *s;
  42   BOOL quoted;
  43   size_t len=1;
  44
  45   if (!ptr) ptr = &last_ptr;
  46   if (!ptr) return(False);
  47
  48   s = *ptr;
  49
  50   /* default to simple separators */
  51   if (!sep) sep = " \t\n\r";
  52
  53   /* find the first non sep char */
  54   while(*s && strchr(sep,*s)) s++;
  55
  56   /* nothing left? */
  57   if (! *s) return(False);
  58
  59   /* copy over the token */
  60   for (quoted = False; len < bufsize && *s && (quoted || !strchr(sep,*s)); s++)
  61     {
  62             if (*s == '\"') {
  63                     quoted = !quoted;
  64             } else {
  65                     len++;
  66                     *buff++ = *s;
  67             }
  68     }
  69
  70   *ptr = (*s) ? s+1 : s;
  71   *buff = 0;
  72   last_ptr = *ptr;
  73
  74   return(True);
  75 }
  76
  77 /****************************************************************************
  78 Convert list of tokens to array; dependent on above routine.
  79 Uses last_ptr from above - bit of a hack.
  80 ****************************************************************************/
  81 char **toktocliplist(int *ctok, char *sep)
  82 {
  83   char *s=last_ptr;
  84   int ictok=0;
  85   char **ret, **iret;
  86
  87   if (!sep) sep = " \t\n\r";
  88
  89   while(*s && strchr(sep,*s)) s++;
  90
  91   /* nothing left? */
  92   if (!*s) return(NULL);
  93
  94   do {
  95     ictok++;
  96     while(*s && (!strchr(sep,*s))) s++;
  97     while(*s && strchr(sep,*s)) *s++=0;
  98   } while(*s);
  99
 100   *ctok=ictok;
 101   s=last_ptr;
 102
 103   if (!(ret=iret=malloc(ictok*sizeof(char *)))) return NULL;
 104
 105   while(ictok--) {
 106     *iret++=s;
 107     while(*s++);
 108     while(!*s) s++;
 109   }
 110
 111   return ret;
 112 }
 113
 114
 115 /*******************************************************************
 116   case insensitive string compararison
 117 ********************************************************************/
 118 int StrCaseCmp(const char *s, const char *t)
 119 {
 120   /* compare until we run out of string, either t or s, or find a difference */
 121   /* We *must* use toupper rather than tolower here due to the
 122      asynchronous upper to lower mapping.
 123    */
 124 #if !defined(KANJI_WIN95_COMPATIBILITY)
 125   /*
 126    * For completeness we should put in equivalent code for code pages
 127    * 949 (Korean hangul) and 950 (Big5 Traditional Chinese) here - but
 128    * doubt anyone wants Samba to behave differently from Win95 and WinNT
 129    * here. They both treat full width ascii characters as case senstive
 130    * filenames (ie. they don't do the work we do here).
 131    * JRA.
 132    */
 133
 134   if(lp_client_code_page() == KANJI_CODEPAGE)
 135   {
 136     /* Win95 treats full width ascii characters as case sensitive. */
 137     int diff;
 138     for (;;)
 139     {
 140       if (!*s || !*t)
 141             return toupper (*s) - toupper (*t);
 142       else if (is_sj_alph (*s) && is_sj_alph (*t))
 143       {
 144         diff = sj_toupper2 (*(s+1)) - sj_toupper2 (*(t+1));
 145         if (diff)
 146           return diff;
 147         s += 2;
 148         t += 2;
 149       }
 150       else if (is_shift_jis (*s) && is_shift_jis (*t))
 151       {
 152         diff = ((int) (unsigned char) *s) - ((int) (unsigned char) *t);
 153         if (diff)
 154           return diff;
 155         diff = ((int) (unsigned char) *(s+1)) - ((int) (unsigned char) *(t+1));
 156         if (diff)
 157           return diff;
 158         s += 2;
 159         t += 2;
 160       }
 161       else if (is_shift_jis (*s))
 162         return 1;
 163       else if (is_shift_jis (*t))
 164         return -1;
 165       else
 166       {
 167         diff = toupper (*s) - toupper (*t);
 168         if (diff)
 169           return diff;
 170         s++;
 171         t++;
 172       }
 173     }
 174   }
 175   else
 176 #endif /* KANJI_WIN95_COMPATIBILITY */
 177   {
 178     while (*s && *t && toupper(*s) == toupper(*t))
 179     {
 180       s++;
 181       t++;
 182     }
 183
 184     return(toupper(*s) - toupper(*t));
 185   }
 186 }
 187
 188 /*******************************************************************
 189   case insensitive string compararison, length limited
 190 ********************************************************************/
 191 int StrnCaseCmp(const char *s, const char *t, size_t n)
 192 {
 193   /* compare until we run out of string, either t or s, or chars */
 194   /* We *must* use toupper rather than tolower here due to the
 195      asynchronous upper to lower mapping.
 196    */
 197 #if !defined(KANJI_WIN95_COMPATIBILITY)
 198   /*
 199    * For completeness we should put in equivalent code for code pages
 200    * 949 (Korean hangul) and 950 (Big5 Traditional Chinese) here - but
 201    * doubt anyone wants Samba to behave differently from Win95 and WinNT
 202    * here. They both treat full width ascii characters as case senstive
 203    * filenames (ie. they don't do the work we do here).
 204    * JRA.
 205    */
 206
 207   if(lp_client_code_page() == KANJI_CODEPAGE)
 208   {
 209     /* Win95 treats full width ascii characters as case sensitive. */
 210     int diff;
 211     for (;n > 0;)
 212     {
 213       if (!*s || !*t)
 214         return toupper (*s) - toupper (*t);
 215       else if (is_sj_alph (*s) && is_sj_alph (*t))
 216       {
 217         diff = sj_toupper2 (*(s+1)) - sj_toupper2 (*(t+1));
 218         if (diff)
 219           return diff;
 220         s += 2;
 221         t += 2;
 222         n -= 2;
 223       }
 224       else if (is_shift_jis (*s) && is_shift_jis (*t))
 225       {
 226         diff = ((int) (unsigned char) *s) - ((int) (unsigned char) *t);
 227         if (diff)
 228           return diff;
 229         diff = ((int) (unsigned char) *(s+1)) - ((int) (unsigned char) *(t+1));
 230         if (diff)
 231           return diff;
 232         s += 2;
 233         t += 2;
 234         n -= 2;
 235       }
 236       else if (is_shift_jis (*s))
 237         return 1;
 238       else if (is_shift_jis (*t))
 239         return -1;
 240       else
 241       {
 242         diff = toupper (*s) - toupper (*t);
 243         if (diff)
 244           return diff;
 245         s++;
 246         t++;
 247         n--;
 248       }
 249     }
 250     return 0;
 251   }
 252   else
 253 #endif /* KANJI_WIN95_COMPATIBILITY */
 254   {
 255     while (n && *s && *t && toupper(*s) == toupper(*t))
 256     {
 257       s++;
 258       t++;
 259       n--;
 260     }
 261
 262     /* not run out of chars - strings are different lengths */
 263     if (n)
 264       return(toupper(*s) - toupper(*t));
 265
 266     /* identical up to where we run out of chars,
 267        and strings are same length */
 268     return(0);
 269   }
 270 }
 271
 272 /*******************************************************************
 273   compare 2 strings
 274 ********************************************************************/
 275 BOOL strequal(const char *s1, const char *s2)
 276 {
 277   if (s1 == s2) return(True);
 278   if (!s1 || !s2) return(False);
 279
 280   return(StrCaseCmp(s1,s2)==0);
 281 }
 282
 283 /*******************************************************************
 284   compare 2 strings up to and including the nth char.
 285   ******************************************************************/
 286 BOOL strnequal(const char *s1,const char *s2,size_t n)
 287 {
 288   if (s1 == s2) return(True);
 289   if (!s1 || !s2 || !n) return(False);
 290
 291   return(StrnCaseCmp(s1,s2,n)==0);
 292 }
 293
 294 /*******************************************************************
 295   compare 2 strings (case sensitive)
 296 ********************************************************************/
 297 BOOL strcsequal(const char *s1,const char *s2)
 298 {
 299   if (s1 == s2) return(True);
 300   if (!s1 || !s2) return(False);
 301
 302   return(strcmp(s1,s2)==0);
 303 }
 304
 305
 306 /*******************************************************************
 307   convert a string to lower case
 308 ********************************************************************/
 309 void strlower(char *s)
 310 {
 311   while (*s)
 312   {
 313 #if !defined(KANJI_WIN95_COMPATIBILITY)
 314   /*
 315    * For completeness we should put in equivalent code for code pages
 316    * 949 (Korean hangul) and 950 (Big5 Traditional Chinese) here - but
 317    * doubt anyone wants Samba to behave differently from Win95 and WinNT
 318    * here. They both treat full width ascii characters as case senstive
 319    * filenames (ie. they don't do the work we do here).
 320    * JRA.
 321    */
 322
 323     if(lp_client_code_page() == KANJI_CODEPAGE)
 324     {
 325       /* Win95 treats full width ascii characters as case sensitive. */
 326       if (is_shift_jis (*s))
 327       {
 328         if (is_sj_upper (s[0], s[1]))
 329           s[1] = sj_tolower2 (s[1]);
 330         s += 2;
 331       }
 332       else if (is_kana (*s))
 333       {
 334         s++;
 335       }
 336       else
 337       {
 338         if (isupper(*s))
 339           *s = tolower(*s);
 340         s++;
 341       }
 342     }
 343     else
 344 #endif /* KANJI_WIN95_COMPATIBILITY */
 345     {
 346       size_t skip = get_character_len( *s );
 347       if( skip != 0 )
 348         s += skip;
 349       else
 350       {
 351         if (isupper(*s))
 352           *s = tolower(*s);
 353         s++;
 354       }
 355     }
 356   }
 357 }
 358
 359 /*******************************************************************
 360   convert a string to upper case
 361 ********************************************************************/
 362 void strupper(char *s)
 363 {
 364   while (*s)
 365   {
 366 #if !defined(KANJI_WIN95_COMPATIBILITY)
 367   /*
 368    * For completeness we should put in equivalent code for code pages
 369    * 949 (Korean hangul) and 950 (Big5 Traditional Chinese) here - but
 370    * doubt anyone wants Samba to behave differently from Win95 and WinNT
 371    * here. They both treat full width ascii characters as case senstive
 372    * filenames (ie. they don't do the work we do here).
 373    * JRA.
 374    */
 375
 376     if(lp_client_code_page() == KANJI_CODEPAGE)
 377     {
 378       /* Win95 treats full width ascii characters as case sensitive. */
 379       if (is_shift_jis (*s))
 380       {
 381         if (is_sj_lower (s[0], s[1]))
 382           s[1] = sj_toupper2 (s[1]);
 383         s += 2;
 384       }
 385       else if (is_kana (*s))
 386       {
 387         s++;
 388       }
 389       else
 390       {
 391         if (islower(*s))
 392           *s = toupper(*s);
 393         s++;
 394       }
 395     }
 396     else
 397 #endif /* KANJI_WIN95_COMPATIBILITY */
 398     {
 399       size_t skip = get_character_len( *s );
 400       if( skip != 0 )
 401         s += skip;
 402       else
 403       {
 404         if (islower(*s))
 405           *s = toupper(*s);
 406         s++;
 407       }
 408     }
 409   }
 410 }
 411
 412 /*******************************************************************
 413   convert a string to "normal" form
 414 ********************************************************************/
 415 void strnorm(char *s)
 416 {
 417   extern int case_default;
 418   if (case_default == CASE_UPPER)
 419     strupper(s);
 420   else
 421     strlower(s);
 422 }
 423
 424 /*******************************************************************
 425 check if a string is in "normal" case
 426 ********************************************************************/
 427 BOOL strisnormal(char *s)
 428 {
 429   extern int case_default;
 430   if (case_default == CASE_UPPER)
 431     return(!strhaslower(s));
 432
 433   return(!strhasupper(s));
 434 }
 435
 436
 437 /****************************************************************************
 438   string replace
 439 ****************************************************************************/
 440 void string_replace(char *s,char oldc,char newc)
 441 {
 442   size_t skip;
 443
 444   /*
 445    * sbcs optimization.
 446    */
 447   if(!global_is_multibyte_codepage) {
 448     while (*s) {
 449       if (oldc == *s)
 450         *s = newc;
 451       s++;
 452     }
 453   } else {
 454   while (*s)
 455   {
 456       skip = get_character_len( *s );
 457     if( skip != 0 )
 458       s += skip;
 459     else
 460     {
 461       if (oldc == *s)
 462         *s = newc;
 463       s++;
 464     }
 465   }
 466 }
 467 }
 468
 469
 470 /*******************************************************************
 471 skip past some strings in a buffer
 472 ********************************************************************/
 473 char *skip_string(char *buf,size_t n)
 474 {
 475   while (n--)
 476     buf += strlen(buf) + 1;
 477   return(buf);
 478 }
 479
 480 /*******************************************************************
 481  Count the number of characters in a string. Normally this will
 482  be the same as the number of bytes in a string for single byte strings,
 483  but will be different for multibyte.
 484  16.oct.98, jdblair@cobaltnet.com.
 485 ********************************************************************/
 486
 487 size_t str_charnum(const char *s)
 488 {
 489   size_t len = 0;
 490
 491   /*
 492    * sbcs optimization.
 493    */
 494   if(!global_is_multibyte_codepage) {
 495     return strlen(s);
 496   } else {
 497   while (*s != '\0') {
 498       int skip = get_character_len(*s);
 499     s += (skip ? skip : 1);
 500     len++;
 501   }
 502   }
 503   return len;
 504 }
 505
 506 /*******************************************************************
 507 trim the specified elements off the front and back of a string
 508 ********************************************************************/
 509
 510 BOOL trim_string(char *s,const char *front,const char *back)
 511 {
 512   BOOL ret = False;
 513   size_t front_len = (front && *front) ? strlen(front) : 0;
 514   size_t back_len = (back && *back) ? strlen(back) : 0;
 515   size_t s_len;
 516
 517   while (front_len && strncmp(s, front, front_len) == 0)
 518   {
 519     char *p = s;
 520     ret = True;
 521     while (1)
 522     {
 523       if (!(*p = p[front_len]))
 524         break;
 525       p++;
 526     }
 527   }
 528
 529   /*
 530    * We split out the multibyte code page
 531    * case here for speed purposes. Under a
 532    * multibyte code page we need to walk the
 533    * string forwards only and multiple times.
 534    * Thanks to John Blair for finding this
 535    * one. JRA.
 536    */
 537
 538   if(back_len)
 539   {
 540     if(!global_is_multibyte_codepage)
 541     {
 542       s_len = strlen(s);
 543       while ((s_len >= back_len) &&
 544              (strncmp(s + s_len - back_len, back, back_len)==0))
 545       {
 546         ret = True;
 547         s[s_len - back_len] = '\0';
 548         s_len = strlen(s);
 549       }
 550     }
 551     else
 552     {
 553
 554       /*
 555        * Multibyte code page case.
 556        * Keep going through the string, trying
 557        * to match the 'back' string with the end
 558        * of the string. If we get a match, truncate
 559        * 'back' off the end of the string and
 560        * go through the string again from the
 561        * start. Keep doing this until we have
 562        * gone through the string with no match
 563        * at the string end.
 564        */
 565
 566       size_t mb_back_len = str_charnum(back);
 567       size_t mb_s_len = str_charnum(s);
 568
 569       while(mb_s_len >= mb_back_len)
 570       {
 571         size_t charcount = 0;
 572         char *mbp = s;
 573
 574         /*
 575          * sbcs optimization.
 576          */
 577         if(!global_is_multibyte_codepage) {
 578           while(charcount < (mb_s_len - mb_back_len)) {
 579             mbp += 1;
 580             charcount++;
 581           }
 582         } else {
 583           while(charcount < (mb_s_len - mb_back_len)) {
 584           size_t skip = skip_multibyte_char(*mbp);
 585           mbp += (skip ? skip : 1);
 586           charcount++;
 587         }
 588         }
 589
 590         /*
 591          * mbp now points at mb_back_len multibyte
 592          * characters from the end of s.
 593          */
 594
 595         if(strcmp(mbp, back) == 0)
 596         {
 597           ret = True;
 598           *mbp = '\0';
 599           mb_s_len = str_charnum(s);
 600           mbp = s;
 601         }
 602         else
 603           break;
 604       } /* end while mb_s_len... */
 605     } /* end else .. */
 606   } /* end if back_len .. */
 607
 608   return(ret);
 609 }
 610
 611
 612 /****************************************************************************
 613 does a string have any uppercase chars in it?
 614 ****************************************************************************/
 615 BOOL strhasupper(const char *s)
 616 {
 617   while (*s)
 618   {
 619 #if !defined(KANJI_WIN95_COMPATIBILITY)
 620   /*
 621    * For completeness we should put in equivalent code for code pages
 622    * 949 (Korean hangul) and 950 (Big5 Traditional Chinese) here - but
 623    * doubt anyone wants Samba to behave differently from Win95 and WinNT
 624    * here. They both treat full width ascii characters as case senstive
 625    * filenames (ie. they don't do the work we do here).
 626    * JRA.
 627    */
 628
 629     if(lp_client_code_page() == KANJI_CODEPAGE)
 630     {
 631       /* Win95 treats full width ascii characters as case sensitive. */
 632       if (is_shift_jis (*s))
 633         s += 2;
 634       else if (is_kana (*s))
 635         s++;
 636       else
 637       {
 638         if (isupper(*s))
 639           return(True);
 640         s++;
 641       }
 642     }
 643     else
 644 #endif /* KANJI_WIN95_COMPATIBILITY */
 645     {
 646       size_t skip = get_character_len( *s );
 647       if( skip != 0 )
 648         s += skip;
 649       else {
 650         if (isupper(*s))
 651           return(True);
 652         s++;
 653       }
 654     }
 655   }
 656   return(False);
 657 }
 658
 659 /****************************************************************************
 660 does a string have any lowercase chars in it?
 661 ****************************************************************************/
 662 BOOL strhaslower(const char *s)
 663 {
 664   while (*s)
 665   {
 666 #if !defined(KANJI_WIN95_COMPATIBILITY)
 667   /*
 668    * For completeness we should put in equivalent code for code pages
 669    * 949 (Korean hangul) and 950 (Big5 Traditional Chinese) here - but
 670    * doubt anyone wants Samba to behave differently from Win95 and WinNT
 671    * here. They both treat full width ascii characters as case senstive
 672    * filenames (ie. they don't do the work we do here).
 673    * JRA.
 674    */
 675
 676     if(lp_client_code_page() == KANJI_CODEPAGE)
 677     {
 678       /* Win95 treats full width ascii characters as case sensitive. */
 679       if (is_shift_jis (*s))
 680       {
 681         if (is_sj_upper (s[0], s[1]))
 682           return(True);
 683         if (is_sj_lower (s[0], s[1]))
 684           return (True);
 685         s += 2;
 686       }
 687       else if (is_kana (*s))
 688       {
 689         s++;
 690       }
 691       else
 692       {
 693         if (islower(*s))
 694           return(True);
 695         s++;
 696       }
 697     }
 698     else
 699 #endif /* KANJI_WIN95_COMPATIBILITY */
 700     {
 701       size_t skip = get_character_len( *s );
 702       if( skip != 0 )
 703         s += skip;
 704       else {
 705         if (islower(*s))
 706           return(True);
 707         s++;
 708       }
 709     }
 710   }
 711   return(False);
 712 }
 713
 714 /****************************************************************************
 715 find the number of chars in a string
 716 ****************************************************************************/
 717 size_t count_chars(const char *s,char c)
 718 {
 719   size_t count=0;
 720
 721 #if !defined(KANJI_WIN95_COMPATIBILITY)
 722   /*
 723    * For completeness we should put in equivalent code for code pages
 724    * 949 (Korean hangul) and 950 (Big5 Traditional Chinese) here - but
 725    * doubt anyone wants Samba to behave differently from Win95 and WinNT
 726    * here. They both treat full width ascii characters as case senstive
 727    * filenames (ie. they don't do the work we do here).
 728    * JRA.
 729    */
 730
 731   if(lp_client_code_page() == KANJI_CODEPAGE)
 732   {
 733     /* Win95 treats full width ascii characters as case sensitive. */
 734     while (*s)
 735     {
 736       if (is_shift_jis (*s))
 737         s += 2;
 738       else
 739       {
 740         if (*s == c)
 741           count++;
 742         s++;
 743       }
 744     }
 745   }
 746   else
 747 #endif /* KANJI_WIN95_COMPATIBILITY */
 748   {
 749     while (*s)
 750     {
 751       size_t skip = get_character_len( *s );
 752       if( skip != 0 )
 753         s += skip;
 754       else {
 755         if (*s == c)
 756           count++;
 757         s++;
 758       }
 759     }
 760   }
 761   return(count);
 762 }
 763
 764 /*******************************************************************
 765 Return True if a string consists only of one particular character.
 766 ********************************************************************/
 767
 768 BOOL str_is_all(const char *s,char c)
 769 {
 770   if(s == NULL)
 771     return False;
 772   if(!*s)
 773     return False;
 774
 775 #if !defined(KANJI_WIN95_COMPATIBILITY)
 776   /*
 777    * For completeness we should put in equivalent code for code pages
 778    * 949 (Korean hangul) and 950 (Big5 Traditional Chinese) here - but
 779    * doubt anyone wants Samba to behave differently from Win95 and WinNT
 780    * here. They both treat full width ascii characters as case senstive
 781    * filenames (ie. they don't do the work we do here).
 782    * JRA.
 783    */
 784
 785   if(lp_client_code_page() == KANJI_CODEPAGE)
 786   {
 787     /* Win95 treats full width ascii characters as case sensitive. */
 788     while (*s)
 789     {
 790       if (is_shift_jis (*s))
 791         s += 2;
 792       else
 793       {
 794         if (*s != c)
 795           return False;
 796         s++;
 797       }
 798     }
 799   }
 800   else
 801 #endif /* KANJI_WIN95_COMPATIBILITY */
 802   {
 803     while (*s)
 804     {
 805       size_t skip = get_character_len( *s );
 806       if( skip != 0 )
 807         s += skip;
 808       else {
 809         if (*s != c)
 810           return False;
 811         s++;
 812       }
 813     }
 814   }
 815   return True;
 816 }
 817
 818 /*******************************************************************
 819 safe string copy into a known length string. maxlength does not
 820 include the terminating zero.
 821 ********************************************************************/
 822 char *safe_strcpy(char *dest,const char *src, size_t maxlength)
 823 {
 824     size_t len;
 825
 826     if (!dest) {
 827         DEBUG(0,("ERROR: NULL dest in safe_strcpy\n"));
 828         return NULL;
 829     }
 830
 831     if (!src) {
 832         *dest = 0;
 833         return dest;
 834     }
 835
 836     len = strlen(src);
 837
 838     if (len > maxlength) {
 839             DEBUG(0,("ERROR: string overflow by %d in safe_strcpy [%.50s]\n",
 840                      (int)(len-maxlength), src));
 841             SMB_ASSERT(len <= maxlength);
 842             len = maxlength;
 843     }
 844
 845     memcpy(dest, src, len);
 846     dest[len] = 0;
 847     return dest;
 848 }
 849
 850 /*******************************************************************
 851 safe string cat into a string. maxlength does not
 852 include the terminating zero.
 853 ********************************************************************/
 854 char *safe_strcat(char *dest, const char *src, size_t maxlength)
 855 {
 856     size_t src_len, dest_len;
 857
 858     if (!dest) {
 859         DEBUG(0,("ERROR: NULL dest in safe_strcat\n"));
 860         return NULL;
 861     }
 862
 863     if (!src) {
 864         return dest;
 865     }
 866
 867     src_len = strlen(src);
 868     dest_len = strlen(dest);
 869
 870     if (src_len + dest_len > maxlength) {
 871             DEBUG(0,("ERROR: string overflow by %d in safe_strcat [%.50s]\n",
 872                      (int)(src_len + dest_len - maxlength), src));
 873             SMB_ASSERT(False);
 874             src_len = maxlength - dest_len;
 875     }
 876
 877     memcpy(&dest[dest_len], src, src_len);
 878     dest[dest_len + src_len] = 0;
 879     return dest;
 880 }
 881
 882 /*******************************************************************
 883  Paranoid strcpy into a buffer of given length (includes terminating
 884  zero. Strips out all but 'a-Z0-9' and replaces with '_'. Deliberately
 885  does *NOT* check for multibyte characters. Don't change it !
 886 ********************************************************************/
 887
 888 char *alpha_strcpy(char *dest, const char *src, size_t maxlength)
 889 {
 890         size_t len, i;
 891
 892         if (!dest) {
 893                 DEBUG(0,("ERROR: NULL dest in alpha_strcpy\n"));
 894                 return NULL;
 895         }
 896
 897   if (!src) {
 898     *dest = 0;
 899                 return dest;
 900   }
 901
 902         len = strlen(src);
 903         if (len >= maxlength)
 904                 len = maxlength - 1;
 905
 906         for(i = 0; i < len; i++) {
 907                 int val = (src[i] & 0xff);
 908                 if(isupper(val) ||islower(val) || isdigit(val))
 909                         dest[i] = src[i];
 910                 else
 911                         dest[i] = '_';
 912         }
 913
 914         dest[i] = '\0';
 915
 916         return dest;
 917 }
 918
 919 /****************************************************************************
 920  Like strncpy but always null terminates. Make sure there is room!
 921  The variable n should always be one less than the available size.
 922 ****************************************************************************/
 923 char *StrnCpy(char *dest,const char *src,size_t n)
 924 {
 925   char *d = dest;
 926   if (!dest) return(NULL);
 927   if (!src) {
 928     *dest = 0;
 929     return(dest);
 930   }
 931   while (n-- && (*d++ = *src++)) ;
 932   *d = 0;
 933   return(dest);
 934 }
 935
 936
 937 /****************************************************************************
 938 like strncpy but copies up to the character marker.  always null terminates.
 939 returns a pointer to the character marker in the source string (src).
 940 ****************************************************************************/
 941 char *strncpyn(char *dest, const char *src,size_t n, char c)
 942 {
 943         char *p;
 944         size_t str_len;
 945
 946         p = strchr(src, c);
 947         if (p == NULL)
 948         {
 949                 DEBUG(5, ("strncpyn: separator character (%c) not found\n", c));
 950                 return NULL;
 951         }
 952
 953         str_len = PTR_DIFF(p, src);
 954         strncpy(dest, src, MIN(n, str_len));
 955         dest[str_len] = '\0';
 956
 957         return p;
 958 }
 959
 960
 961 /*************************************************************
 962  Routine to get hex characters and turn them into a 16 byte array.
 963  the array can be variable length, and any non-hex-numeric
 964  characters are skipped.  "0xnn" or "0Xnn" is specially catered
 965  for.
 966
 967  valid examples: "0A5D15"; "0x15, 0x49, 0xa2"; "59\ta9\te3\n"
 968
 969 **************************************************************/
 970 size_t strhex_to_str(char *p, size_t len, const char *strhex)
 971 {
 972         size_t i;
 973         size_t num_chars = 0;
 974         unsigned char   lonybble, hinybble;
 975         char           *hexchars = "0123456789ABCDEF";
 976         char           *p1 = NULL, *p2 = NULL;
 977
 978         for (i = 0; i < len && strhex[i] != 0; i++)
 979         {
 980                 if (strnequal(hexchars, "0x", 2))
 981                 {
 982                         i++; /* skip two chars */
 983                         continue;
 984                 }
 985
 986                 if (!(p1 = strchr(hexchars, toupper(strhex[i]))))
 987                 {
 988                         break;
 989                 }
 990
 991                 i++; /* next hex digit */
 992
 993                 if (!(p2 = strchr(hexchars, toupper(strhex[i]))))
 994                 {
 995                         break;
 996                 }
 997
 998                 /* get the two nybbles */
 999                 hinybble = PTR_DIFF(p1, hexchars);
1000                 lonybble = PTR_DIFF(p2, hexchars);
1001
1002                 p[num_chars] = (hinybble << 4) | lonybble;
1003                 num_chars++;
1004
1005                 p1 = NULL;
1006                 p2 = NULL;
1007         }
1008         return num_chars;
1009 }
1010
1011 /****************************************************************************
1012 check if a string is part of a list
1013 ****************************************************************************/
1014 BOOL in_list(char *s,char *list,BOOL casesensitive)
1015 {
1016   pstring tok;
1017   char *p=list;
1018
1019   if (!list) return(False);
1020
1021   while (next_token(&p,tok,LIST_SEP,sizeof(tok))) {
1022     if (casesensitive) {
1023       if (strcmp(tok,s) == 0)
1024         return(True);
1025     } else {
1026       if (StrCaseCmp(tok,s) == 0)
1027         return(True);
1028     }
1029   }
1030   return(False);
1031 }
1032
1033 /* this is used to prevent lots of mallocs of size 1 */
1034 static char *null_string = NULL;
1035
1036 /****************************************************************************
1037 set a string value, allocing the space for the string
1038 ****************************************************************************/
1039 static BOOL string_init(char **dest,const char *src)
1040 {
1041   size_t l;
1042   if (!src)
1043     src = "";
1044
1045   l = strlen(src);
1046
1047   if (l == 0)
1048     {
1049       if (!null_string) {
1050         if((null_string = (char *)malloc(1)) == NULL) {
1051           DEBUG(0,("string_init: malloc fail for null_string.\n"));
1052           return False;
1053         }
1054         *null_string = 0;
1055       }
1056       *dest = null_string;
1057     }
1058   else
1059     {
1060       (*dest) = (char *)malloc(l+1);
1061       if ((*dest) == NULL) {
1062               DEBUG(0,("Out of memory in string_init\n"));
1063               return False;
1064       }
1065
1066       pstrcpy(*dest,src);
1067     }
1068   return(True);
1069 }
1070
1071 /****************************************************************************
1072 free a string value
1073 ****************************************************************************/
1074 void string_free(char **s)
1075 {
1076   if (!s || !(*s)) return;
1077   if (*s == null_string)
1078     *s = NULL;
1079   if (*s) free(*s);
1080   *s = NULL;
1081 }
1082
1083 /****************************************************************************
1084 set a string value, allocing the space for the string, and deallocating any
1085 existing space
1086 ****************************************************************************/
1087 BOOL string_set(char **dest,const char *src)
1088 {
1089   string_free(dest);
1090
1091   return(string_init(dest,src));
1092 }
1093
1094
1095 /****************************************************************************
1096 substitute a string for a pattern in another string. Make sure there is
1097 enough room!
1098
1099 This routine looks for pattern in s and replaces it with
1100 insert. It may do multiple replacements.
1101
1102 any of " ; ' $ or ` in the insert string are replaced with _
1103 if len==0 then no length check is performed
1104 ****************************************************************************/
1105 void string_sub(char *s,const char *pattern,const char *insert, size_t len)
1106 {
1107         char *p;
1108         ssize_t ls,lp,li, i;
1109
1110         if (!insert || !pattern || !s) return;
1111
1112         ls = (ssize_t)strlen(s);
1113         lp = (ssize_t)strlen(pattern);
1114         li = (ssize_t)strlen(insert);
1115
1116         if (!*pattern) return;
1117
1118         while (lp <= ls && (p = strstr(s,pattern))) {
1119                 if (len && (ls + (li-lp) >= len)) {
1120                         DEBUG(0,("ERROR: string overflow by %d in string_sub(%.50s, %d)\n",
1121                                  (int)(ls + (li-lp) - len),
1122                                  pattern, (int)len));
1123                     SMB_ASSERT(False);
1124                         break;
1125                 }
1126                 if (li != lp) {
1127                         memmove(p+li,p+lp,strlen(p+lp)+1);
1128                 }
1129                 for (i=0;i<li;i++) {
1130                         switch (insert[i]) {
1131                         case '`':
1132                         case '"':
1133                         case '\'':
1134                         case ';':
1135                         case '$':
1136                         case '%':
1137                         case '\r':
1138                         case '\n':
1139                                 p[i] = '_';
1140                                 break;
1141                         default:
1142                                 p[i] = insert[i];
1143                         }
1144                 }
1145                 s = p + li;
1146                 ls += (li-lp);
1147         }
1148 }
1149
1150 void fstring_sub(char *s,const char *pattern,const char *insert)
1151 {
1152         string_sub(s, pattern, insert, sizeof(fstring));
1153 }
1154
1155 void pstring_sub(char *s,const char *pattern,const char *insert)
1156 {
1157         string_sub(s, pattern, insert, sizeof(pstring));
1158 }
1159
1160 /****************************************************************************
1161 similar to string_sub() but allows for any character to be substituted.
1162 Use with caution!
1163 if len==0 then no length check is performed
1164 ****************************************************************************/
1165 void all_string_sub(char *s,const char *pattern,const char *insert, size_t len)
1166 {
1167         char *p;
1168         ssize_t ls,lp,li;
1169
1170         if (!insert || !pattern || !s) return;
1171
1172         ls = (ssize_t)strlen(s);
1173         lp = (ssize_t)strlen(pattern);
1174         li = (ssize_t)strlen(insert);
1175
1176         if (!*pattern) return;
1177
1178         while (lp <= ls && (p = strstr(s,pattern))) {
1179                 if (len && (ls + (li-lp) >= len)) {
1180                         DEBUG(0,("ERROR: string overflow by %d in all_string_sub(%.50s, %d)\n",
1181                                  (int)(ls + (li-lp) - len),
1182                                  pattern, (int)len));
1183                         break;
1184                 }
1185                 if (li != lp) {
1186                         memmove(p+li,p+lp,strlen(p+lp)+1);
1187                 }
1188                 memcpy(p, insert, li);
1189                 s = p + li;
1190                 ls += (li-lp);
1191         }
1192 }
1193
1194 /****************************************************************************
1195  splits out the front and back at a separator.
1196 ****************************************************************************/
1197 void split_at_first_component(char *path, char *front, char sep, char *back)
1198 {
1199         char *p = strchr(path, sep);
1200
1201         if (p != NULL)
1202         {
1203                 *p = 0;
1204         }
1205         if (front != NULL)
1206         {
1207                 pstrcpy(front, path);
1208         }
1209         if (p != NULL)
1210         {
1211                 if (back != NULL)
1212                 {
1213                         pstrcpy(back, p+1);
1214                 }
1215                 *p = sep;
1216         }
1217         else
1218         {
1219                 if (back != NULL)
1220                 {
1221                         back[0] = 0;
1222                 }
1223         }
1224 }
1225
1226 /****************************************************************************
1227  splits out the front and back at a separator.
1228 ****************************************************************************/
1229 void split_at_last_component(char *path, char *front, char sep, char *back)
1230 {
1231         char *p = strrchr(path, sep);
1232
1233         if (p != NULL)
1234         {
1235                 *p = 0;
1236         }
1237         if (front != NULL)
1238         {
1239                 pstrcpy(front, path);
1240         }
1241         else if (back != NULL)
1242         {
1243                 pstrcpy(back, path);
1244         }
1245         if (p != NULL)
1246         {
1247                 if (back != NULL)
1248                 {
1249                         pstrcpy(back, p+1);
1250                 }
1251                 *p = sep;
1252         }
1253         else
1254         {
1255                 if (back != NULL && front != NULL)
1256                 {
1257                         back[0] = 0;
1258                 }
1259         }
1260 }
1261
1262 /****************************************************************************
1263 convert a bit field to a string.  if you want multiple bits to be detected
1264 set them first, e.g SV_TYPE_ALL to be "All" or "Full Control" for ACB_INFOs.
1265
1266 strings are expected to contain their own separators, although the code
1267 below only assumes that separators are spaces.
1268
1269 ****************************************************************************/
1270 char *bit_field_to_str(uint32 type, struct field_info *bs)
1271 {
1272         static fstring typestr;
1273         int i = 0;
1274
1275         typestr[0] = 0;
1276
1277         if (type == 0 || bs == NULL)
1278         {
1279                 return NULL;
1280         }
1281
1282         while (bs[i].str != NULL && type != 0)
1283         {
1284                 if (IS_BITS_SET_ALL(bs[i].bits, type))
1285                 {
1286                         fstrcat(typestr, bs[i].str);
1287                         type &= ~bs[i].bits;
1288                 }
1289                 i++;
1290         }
1291
1292         i = strlen(typestr)-1;
1293         if (i > 0 && typestr[i] == ' ')
1294         {
1295                 typestr[i] = 0;
1296         }
1297
1298         return typestr;
1299 }
1300
1301 /****************************************************************************
1302 convert an enumeration to a string.  first item is the default.
1303 ****************************************************************************/
1304 char *enum_field_to_str(uint32 type, struct field_info *bs, BOOL first_default)
1305 {
1306         int i = 0;
1307
1308         if (bs == NULL)
1309         {
1310                 return NULL;
1311         }
1312
1313         while (bs[i].str != NULL && type != 0)
1314         {
1315                 if (bs[i].bits == type)
1316                 {
1317                         return bs[i].str;
1318                 }
1319                 i++;
1320         }
1321
1322         /* oops - none found */
1323
1324         if (first_default)
1325         {
1326                 return bs[0].str;
1327         }
1328
1329         return NULL;
1330 }
1331
1332 /****************************************************************************
1333 write an octal as a string
1334 ****************************************************************************/
1335 char *octal_string(int i)
1336 {
1337         static char ret[64];
1338         if (i == -1) {
1339                 return "-1";
1340         }
1341         slprintf(ret, sizeof(ret), "0%o", i);
1342         return ret;
1343 }
1344
1345
1346 /****************************************************************************
1347 truncate a string at a specified length
1348 ****************************************************************************/
1349 char *string_truncate(char *s, int length)
1350 {
1351         if (s && strlen(s) > length) {
1352                 s[length] = 0;
1353         }
1354         return s;
1355 }
1356